From 0b267a676dda9ea53d252e27a4ad68bcf6f40d4a Mon Sep 17 00:00:00 2001 From: Avasam Date: Tue, 14 Dec 2021 22:58:19 -0500 Subject: [PATCH 001/137] hooked new settings window to actual values --- .flake8 | 2 +- README.md | 1 - pyproject.toml | 5 + res/design.ui | 61 ++++++--- res/settings.ui | 135 ++++++------------- scripts/compile_resources.bat | 1 + scripts/designer.bat | 7 +- src/AutoSplit.py | 243 +++++++++++++++------------------- src/AutoSplitImage.py | 6 +- src/capture_windows.py | 25 ++-- src/error_messages.py | 10 +- src/hotkeys.py | 88 +++++++----- src/menu_bar.py | 113 +++++++++++++++- src/screen_region.py | 28 ++-- src/settings_file.py | 86 +++++++----- src/split_parser.py | 8 +- 16 files changed, 452 insertions(+), 367 deletions(-) diff --git a/.flake8 b/.flake8 index 65910611..2715e740 100644 --- a/.flake8 +++ b/.flake8 @@ -12,7 +12,7 @@ per-file-ignores= __init__.pyi:Q000 ; PyQt methods ignore-names=closeEvent,paintEvent,keyPressEvent,mousePressEvent,mouseMoveEvent,mouseReleaseEvent -; McCabe max-complexity is also taken care of by Pylint and doesn't fail teh build there +; McCabe max-complexity is also taken care of by Pylint and doesn't fail the build there ; So this is the hard limit max-complexity=32 inline-quotes=" diff --git a/README.md b/README.md index 2e43e50d..4084e5e5 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,6 @@ This program can be used to automatically start, split, and reset your preferred - {d} dummy split image. When matched, it moves to the next image without hitting your split hotkey. - {b} split when similarity goes below the threshold rather than above. When a split image filename has this flag, the split image similarity will go above the threshold, do nothing, and then split the next time the similarity goes below the threshold. - {p} pause flag. When a split image filename has this flag, it will hit your pause hotkey rather than your split hokey. - - A pause flag and a dummy flag `{pd}` cannot be used together - Filename examples: - `001_SplitName_(0.9)_[10].png` is a split image with a threshold of 0.9 and a pause time of 10 seconds. - `002_SplitName_(0.9)_[10]_{d}.png` is the second split image with a threshold of 0.9, pause time of 10, and is a dummy split. diff --git a/pyproject.toml b/pyproject.toml index 8001ad5f..3f71a85f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -15,6 +15,11 @@ aggressive = 3 [tool.pyright] pythonPlatform = "Windows" typeCheckingMode = "strict" +# Extra strict +reportPropertyTypeMismatch=true +reportUninitializedInstanceVariable=true +reportCallInDefaultInitializer=true +reportImplicitStringConcatenation=true ignore = [ # Auto generated "src/gen/", diff --git a/res/design.ui b/res/design.ui index 80334881..ea0037ef 100644 --- a/res/design.ui +++ b/res/design.ui @@ -1,7 +1,7 @@ - main_window - + MainWindow + 0 @@ -37,7 +37,7 @@ AutoSplit - + :/resources/icon.ico:/resources/icon.ico @@ -93,6 +93,9 @@ + + false + 650 @@ -108,7 +111,10 @@ Reset - + + + false + 650 @@ -124,7 +130,10 @@ Undo - + + + false + 712 @@ -196,6 +205,9 @@ + + Qt::AlignCenter + @@ -212,6 +224,9 @@ + + Qt::AlignCenter + @@ -265,7 +280,7 @@ - 9999 + @@ -332,7 +347,7 @@ - Image Filename + - Qt::AlignCenter @@ -507,7 +522,7 @@ - Window Name + - Qt::AlignCenter @@ -516,8 +531,8 @@ - 450 - 309 + 451 + 313 67 20 @@ -796,8 +811,8 @@ - 450 - 345 + 449 + 344 98 16 @@ -809,8 +824,8 @@ - 551 - 345 + 550 + 344 98 16 @@ -822,17 +837,20 @@ - 519 - 309 + 520 + 313 131 20 - x/x + N/A + + false + 449 @@ -852,6 +870,9 @@ + + false + 744 @@ -874,8 +895,8 @@ select_region_button start_auto_splitter_button reset_button - undo_button - skip_button + undo_split_button + skip_split_button check_fps_button fps_label current_image_label @@ -1027,7 +1048,7 @@ height_spinbox - + diff --git a/res/settings.ui b/res/settings.ui index 22aa4a35..a388d7d6 100644 --- a/res/settings.ui +++ b/res/settings.ui @@ -1,13 +1,13 @@ - dialog_settings - + DialogSettings + 0 0 289 - 570 + 540 @@ -19,13 +19,13 @@ 289 - 570 + 540 289 - 570 + 540 @@ -40,19 +40,6 @@ false - - - - 127 - 538 - 156 - 24 - - - - QDialogButtonBox::Cancel|QDialogButtonBox::Save - - @@ -93,7 +80,7 @@ false - + 138 @@ -102,23 +89,17 @@ 22 - - - - - 0 + + ArrowCursor - 30.000000000000000 + 20 - 5000.000000000000000 - - - 1.000000000000000 + 240 - 60.000000000000000 + 60 @@ -244,7 +225,7 @@ Default Pause Time (sec): - + 167 @@ -288,7 +269,7 @@ Default Similarity Threshold: - + 167 @@ -332,7 +313,7 @@ false - + 6 @@ -351,10 +332,10 @@ teset - <html><head/><body><p>Custom image settings and flags are set in the <br></br> image file name. These will override the default <br></br> values. View the <a href="https://github.com/Toufool/Auto-Split#readme"><span style=" text-decoration: underline; color:#0000ff;">README</span></a> for full details on all <br></br> available custom image settings</p></body></html> + <html><head/><body><p>Custom image settings and flags are set in the <br></br> image file name. These will override the default <br></br> values. View the <a href="https://github.com/Toufool/Auto-Split#readme"><span style=" text-decoration: underline; color:#0000ff;">README</span></a> for full details on all <br></br> available custom image settings.</p></body></html> - + 6 @@ -373,7 +354,7 @@ Default Delay Time (ms): - + 167 @@ -382,26 +363,14 @@ 22 + + ArrowCursor + After an image is matched, this is the amount of time in millseconds that will be delayed before splitting. - - - - - 0 - - - 0.000000000000000 - - 36000000.000000000000000 - - - 1.000000000000000 - - - 0.000000000000000 + 999999999 @@ -430,7 +399,7 @@ 180 - 133 + 130 81 21 @@ -443,10 +412,13 @@ + + true + 76 - 28 + 30 94 20 @@ -481,7 +453,7 @@ 6 - 31 + 32 71 16 @@ -494,7 +466,7 @@ 76 - 53 + 55 94 20 @@ -532,7 +504,7 @@ 6 - 55 + 57 41 16 @@ -545,7 +517,7 @@ 180 - 53 + 55 81 21 @@ -590,7 +562,7 @@ 76 - 133 + 130 94 20 @@ -622,7 +594,7 @@ 180 - 106 + 105 81 21 @@ -638,7 +610,7 @@ 6 - 108 + 107 61 16 @@ -651,7 +623,7 @@ 76 - 106 + 105 94 20 @@ -672,46 +644,13 @@ skip_split_input pause_input default_comparison_method - default_similarity_threshold_double_spinbox - default_pause_time_double_spinbox + default_similarity_threshold_spinbox + default_pause_time_spinbox loop_splits_checkbox fps_limit_spinbox live_capture_region_checkbox force_print_window_checkbox - - - save_cancel_dialog_button_box - accepted() - dialog_settings - accept() - - - 194 - 541 - - - 140 - 282 - - - - - save_cancel_dialog_button_box - rejected() - dialog_settings - reject() - - - 194 - 541 - - - 140 - 282 - - - - + diff --git a/scripts/compile_resources.bat b/scripts/compile_resources.bat index 3c1398ff..d5ef6cf0 100644 --- a/scripts/compile_resources.bat +++ b/scripts/compile_resources.bat @@ -2,5 +2,6 @@ cd "%~dp0.." md .\src\gen pyuic6 ".\res\about.ui" -o ".\src\gen\about.py" pyuic6 ".\res\design.ui" -o ".\src\gen\design.py" +pyuic6 ".\res\settings.ui" -o ".\src\gen\settings.py" pyuic6 ".\res\update_checker.ui" -o ".\src\gen\update_checker.py" pyside6-rcc ".\res\resources.qrc" -o ".\src\gen\resources_rc.py" diff --git a/scripts/designer.bat b/scripts/designer.bat index 3b7af65e..d3b61064 100644 --- a/scripts/designer.bat +++ b/scripts/designer.bat @@ -11,4 +11,9 @@ IF NOT DEFINED PYTHONPATH ( SET PYTHONPATH=!pythonFiles[0]! ) -START "Qt Designer" "%PYTHONPATH:~0,-11%\Lib\site-packages\qt6_applications\Qt\bin\designer.exe" "%~d0%~p0..\res\design.ui" "%~d0%~p0..\res\about.ui" "%~d0%~p0..\res\update_checker.ui" +START "Qt Designer" "%PYTHONPATH:~0,-11%\Lib\site-packages\qt6_applications\Qt\bin\designer.exe"^ + "%~d0%~p0..\res\design.ui"^ + "%~d0%~p0..\res\about.ui"^ + "%~d0%~p0..\res\settings.ui"^ + "%~d0%~p0..\res\update_checker.ui" + diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 97031748..64f73d2b 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -28,18 +28,18 @@ import error_messages import settings_file as settings from AutoControlledWorker import AutoControlledWorker -from capture_windows import capture_region, Rect, set_ui_image -from gen import about, design, update_checker -from hotkeys import send_command, after_setting_hotkey, set_split_hotkey, set_reset_hotkey, set_skip_split_hotkey, \ - set_undo_split_hotkey, set_pause_hotkey -from menu_bar import open_about, VERSION, view_help, check_for_updates, open_update_checker +from capture_windows import capture_region, set_ui_image +from gen import about, design, settings as settings_ui, update_checker +from hotkeys import send_command, after_setting_hotkey +from menu_bar import get_default_settings_from_ui, open_about, VERSION, open_settings, view_help, check_for_updates, \ + open_update_checker from screen_region import select_region, select_window, align_region, validate_before_parsing from settings_file import FROZEN from split_parser import BELOW_FLAG, DUMMY_FLAG, PAUSE_FLAG, parse_and_validate_images -CREATE_NEW_ISSUE_MESSAGE = "Please create a New Issue at " \ - "github.com/Toufool/Auto-Split/issues, describe what happened, and copy & paste the error message below" -START_IMAGE_TEXT = "Start Image" +CREATE_NEW_ISSUE_MESSAGE = ( + "Please create a New Issue at " + + "github.com/Toufool/Auto-Split/issues, describe what happened, and copy & paste the error message below") START_AUTO_SPLITTER_TEXT = "Start Auto Splitter" CHECK_FPS_ITERATIONS = 10 @@ -47,14 +47,14 @@ os.environ["REQUESTS_CA_BUNDLE"] = certifi.where() -def make_excepthook(main_window: AutoSplit): +def make_excepthook(autosplit: AutoSplit): def excepthook(exception_type: type[BaseException], exception: BaseException, _traceback: Optional[TracebackType]): # Catch Keyboard Interrupts for a clean close if exception_type is KeyboardInterrupt or isinstance(exception, KeyboardInterrupt): sys.exit(0) - main_window.show_error_signal.emit(lambda: error_messages.exception_traceback( + autosplit.show_error_signal.emit(lambda: error_messages.exception_traceback( "AutoSplit encountered an unhandled exception and will try to recover, " - f"however, there is no guarantee everything will work properly. {CREATE_NEW_ISSUE_MESSAGE}", + + f"however, there is no guarantee everything will work properly. {CREATE_NEW_ISSUE_MESSAGE}", exception)) return excepthook @@ -82,9 +82,10 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): timer_start_image = QtCore.QTimer() # Widgets - AboutWidget: about.Ui_AboutAutoSplitWidget - UpdateCheckerWidget: update_checker.Ui_UpdateChecker - CheckForUpdatesThread: QtCore.QThread + AboutWidget: Optional[about.Ui_AboutAutoSplitWidget] = None + UpdateCheckerWidget: Optional[update_checker.Ui_UpdateChecker] = None + CheckForUpdatesThread: Optional[QtCore.QThread] = None + SettingsWidget: Optional[settings_ui.Ui_DialogSettings] = None # hotkeys need to be initialized to be passed as thread arguments in hotkeys.py # and for type safety in both hotkeys.py and settings_file.py @@ -95,12 +96,10 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): pause_hotkey: Optional[Callable[[], None]] = None # Initialize a few attributes - split_image_directory = "" hwnd = 0 """Window Handle used for Capture Region""" - window_text = "" - selection = Rect() last_saved_settings: list[Union[str, float, int, bool]] = [] + similarity = 0.0 live_image_function_on_open = True split_image_number = 0 split_images_and_loop_number: list[tuple[AutoSplitImage, int]] = [] @@ -130,34 +129,32 @@ def __init__(self, parent: Optional[QWidget] = None): # Setup global error handling self.show_error_signal.connect(lambda errorMessageBox: errorMessageBox()) - # Whithin LiveSplit excepthook needs to use main_window's signals to show errors + # Whithin LiveSplit excepthook needs to use MainWindow's signals to show errors sys.excepthook = make_excepthook(self) self.setupUi(self) + # Get default values defined in SettingsDialog + self.settings_dict = get_default_settings_from_ui(self) settings.load_check_for_updates_on_open(self) - # close all processes when closing window self.action_view_help.triggered.connect(view_help) self.action_about.triggered.connect(lambda: open_about(self)) self.action_check_for_updates.triggered.connect(lambda: check_for_updates(self)) - self.action_save_settings.triggered.connect(lambda: settings.save_settings(self)) - self.action_save_settings_as.triggered.connect(lambda: settings.save_settings_as(self)) - self.action_load_settings.triggered.connect(lambda: settings.load_settings(self)) + self.action_settings.triggered.connect(lambda: open_settings(self)) + self.action_save_profile.triggered.connect(lambda: settings.save_settings(self)) + self.action_save_profile_as.triggered.connect(lambda: settings.save_settings_as(self)) + self.action_load_profile.triggered.connect(lambda: settings.load_settings(self)) + + if self.SettingsWidget: + self.SettingsWidget.split_input.setEnabled(False) + self.SettingsWidget.reset_input.setEnabled(False) + self.SettingsWidget.skip_split_input.setEnabled(False) + self.SettingsWidget.undo_split_input.setEnabled(False) + self.SettingsWidget.pause_input.setEnabled(False) if self.is_auto_controlled: - self.set_split_hotkey_button.setEnabled(False) - self.set_reset_hotkey_button.setEnabled(False) - self.set_skip_split_hotkey_button.setEnabled(False) - self.set_undo_split_hotkey_button.setEnabled(False) - self.set_pause_hotkey_button.setEnabled(False) self.start_auto_splitter_button.setEnabled(False) - self.split_input.setEnabled(False) - self.reset_input.setEnabled(False) - self.skip_split_input.setEnabled(False) - self.undo_split_input.setEnabled(False) - self.pause_input.setEnabled(False) - self.timer_global_hotkeys_label.setText("Hotkeys Inactive - Use LiveSplit Hotkeys") # Send version and process ID to stdout print(f"{VERSION}\n{os.getpid()}", flush=True) @@ -183,14 +180,9 @@ def __init__(self, parent: Optional[QWidget] = None): self.undo_split_button.clicked.connect(self.__undo_split) self.next_image_button.clicked.connect(lambda: self.__skip_split(True)) self.previous_image_button.clicked.connect(lambda: self.__undo_split(True)) - self.set_split_hotkey_button.clicked.connect(lambda: set_split_hotkey(self)) - self.set_reset_hotkey_button.clicked.connect(lambda: set_reset_hotkey(self)) - self.set_skip_split_hotkey_button.clicked.connect(lambda: set_skip_split_hotkey(self)) - self.set_undo_split_hotkey_button.clicked.connect(lambda: set_undo_split_hotkey(self)) - self.set_pause_hotkey_button.clicked.connect(lambda: set_pause_hotkey(self)) self.align_region_button.clicked.connect(lambda: align_region(self)) self.select_window_button.clicked.connect(lambda: select_window(self)) - self.start_image_reload_button.clicked.connect(lambda: self.load_start_image(True, True)) + self.reload_start_image_button.clicked.connect(lambda: self.load_start_image(True, True)) self.action_check_for_updates_on_open.changed.connect(lambda: settings.set_check_for_updates_on_open( self, self.action_check_for_updates_on_open.isChecked()) @@ -213,7 +205,7 @@ def __init__(self, parent: Optional[QWidget] = None): self.pause_signal.connect(self.pause) # live image checkbox - self.live_image_checkbox.clicked.connect(self.check_live_image) + self.timer_live_image.start(int(1000 / 60)) self.timer_live_image.timeout.connect(self.__live_image_function) # Automatic timer start @@ -236,26 +228,19 @@ def __browse(self): new_split_image_directory = QFileDialog.getExistingDirectory( self, "Select Split Image Directory", - os.path.join(self.split_image_directory or settings.auto_split_directory, "..")) + os.path.join(self.settings_dict["split_image_directory"] or settings.auto_split_directory, "..")) # If the user doesn't select a folder, it defaults to "". if new_split_image_directory: # set the split image folder line to the directory text - self.split_image_directory = new_split_image_directory + self.settings_dict["split_image_directory"] = new_split_image_directory self.split_image_folder_input.setText(f"{new_split_image_directory}/") self.load_start_image() - def check_live_image(self): - if self.live_image_checkbox.isChecked(): - self.timer_live_image.start(int(1000 / 60)) - else: - self.timer_live_image.stop() - self.__live_image_function() - def __live_image_function(self): try: - self.capture_region_window_label.setText(self.window_text) - if not self.window_text: + self.capture_region_window_label.setText(self.settings_dict["captured_window_title"]) + if not self.settings_dict["captured_window_title"]: self.timer_live_image.stop() self.live_image.clear() if self.live_image_function_on_open: @@ -263,7 +248,8 @@ def __live_image_function(self): return # Set live image in UI if self.hwnd: - capture = capture_region(self.hwnd, self.selection, self.force_print_window_checkbox.isChecked()) + capture = capture_region(self.hwnd, self.settings_dict["capture_region"], + self.settings_dict["force_print_window"]) set_ui_image(self.live_image, capture, False) except AttributeError: @@ -271,14 +257,14 @@ def __live_image_function(self): def load_start_image(self, started_by_button: bool = False, wait_for_delay: bool = True): self.timer_start_image.stop() - self.current_split_image_file_label.setText(" ") - self.start_image_label.setText(f"{START_IMAGE_TEXT}: not found") + self.current_image_file_label.setText("-") + self.start_image_status_value_label.setText("not found") QApplication.processEvents() if not self.is_auto_controlled \ - and (not self.split_input.text() - or not self.reset_input.text() - or not self.pause_input.text()): + and (not self.settings_dict["split_hotkey"] + or not self.settings_dict["reset_hotkey"] + or not self.settings_dict["pause_hotkey"]): error_messages.load_start_image() return @@ -295,17 +281,17 @@ def load_start_image(self, started_by_button: bool = False, wait_for_delay: bool start_pause_time = self.start_image.get_pause_time(self) if not wait_for_delay and start_pause_time > 0: self.check_start_image_timestamp = time() + start_pause_time - self.start_image_label.setText(f"{START_IMAGE_TEXT}: paused") - self.highest_similarity_label.setText(" ") - self.current_similarity_threshold_number_label.setText(" ") + self.start_image_status_value_label.setText("paused") + self.table_current_image_highest_label.setText("-") + self.table_current_image_threshold_label.setText("-") else: self.check_start_image_timestamp = 0.0 - self.start_image_label.setText(f"{START_IMAGE_TEXT}: ready") + self.start_image_status_value_label.setText("ready") self.__update_split_image(self.start_image) self.highest_similarity = 0.0 self.start_image_split_below_threshold = False - self.timer_start_image.start(int(1000 / self.fps_limit_spinbox.value())) + self.timer_start_image.start(int(1000 / self.settings_dict["fps_limit"])) QApplication.processEvents() @@ -313,35 +299,31 @@ def __start_image_function(self): if self.start_image is None \ or not self.start_image \ or time() < self.check_start_image_timestamp \ - or (not self.split_input.text() and not self.is_auto_controlled): + or (not self.settings_dict["split_hotkey"] and not self.is_auto_controlled): pause_time_left = f"{self.check_start_image_timestamp - time():.1f}" self.current_split_image.setText( - f"None\n (Paused before loading {START_IMAGE_TEXT}).\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: self.check_start_image_timestamp = 0.0 - self.start_image_label.setText(f"{START_IMAGE_TEXT}: ready") + self.start_image_status_value_label.setText("ready") self.__update_split_image(self.start_image) capture = self.__get_capture_for_comparison() start_image_threshold = self.start_image.get_similarity_threshold(self) start_image_similarity = self.start_image.compare_with_capture(self, capture) - self.current_similarity_threshold_number_label.setText(f"{start_image_threshold:.2f}") + self.table_current_image_threshold_label.setText(f"{start_image_threshold:.2f}") # Show live similarity if the checkbox is checked - self.live_similarity_label.setText(str(start_image_similarity)[:4] - if self.show_live_similarity_checkbox.isChecked() - else " ") + self.table_current_image_live_label.setText(str(start_image_similarity)[:4]) # If the similarity becomes higher than highest similarity, set it as such. if start_image_similarity > self.highest_similarity: self.highest_similarity = start_image_similarity # Show live highest similarity if the checkbox is checked - self.highest_similarity_label.setText(str(self.highest_similarity)[:4] - if self.show_highest_similarity_checkbox.isChecked() - else " ") + self.table_current_image_highest_label.setText(str(self.highest_similarity)[:4]) # 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 @@ -361,7 +343,7 @@ def __start_image_function(self): # delay start image if needed if self.start_image.delay > 0: - self.start_image_label.setText(f"{START_IMAGE_TEXT}: delaying start...") + self.start_image_status_value_label.setText("delaying start...") delay_start_time = time() start_delay = self.start_image.delay / 1000 while time() - delay_start_time < start_delay: @@ -371,36 +353,24 @@ def __start_image_function(self): # Email sent to pyqt@riverbankcomputing.com QtTest.QTest.qWait(1) # type: ignore - self.start_image_label.setText(f"{START_IMAGE_TEXT}: started") + self.start_image_status_value_label.setText("started") send_command(self, "start") # Email sent to pyqt@riverbankcomputing.com - QtTest.QTest.qWait(int(1 / self.fps_limit_spinbox.value())) # type: ignore + QtTest.QTest.qWait(int(1 / self.settings_dict["fps_limit"])) # type: ignore self.start_auto_splitter() # update x, y, width, height when spinbox values are changed def __update_x(self): - try: - self.selection.left = self.x_spinbox.value() - self.selection.right = self.selection.left + self.width_spinbox.value() - self.check_live_image() - except AttributeError: - pass + self.settings_dict["capture_region"].x = self.x_spinbox.value() def __update_y(self): - try: - self.selection.top = self.y_spinbox.value() - self.selection.bottom = self.selection.top + self.height_spinbox.value() - self.check_live_image() - except AttributeError: - pass + self.settings_dict["capture_region"].y = self.y_spinbox.value() def __update_width(self): - self.selection.right = self.selection.left + self.width_spinbox.value() - self.check_live_image() + self.settings_dict["capture_region"].width = self.width_spinbox.value() def __update_height(self): - self.selection.bottom = self.selection.top + self.height_spinbox.value() - self.check_live_image() + self.settings_dict["capture_region"].height = self.height_spinbox.value() def __take_screenshot(self): if not validate_before_parsing(self, check_empty_directory=False): @@ -411,13 +381,17 @@ def __take_screenshot(self): # which is a problem, but I doubt anyone will get to 1000 split images... screenshot_index = 1 while True: - screenshot_path = os.path.join(self.split_image_directory, f"{screenshot_index:03}_SplitImage.png") + screenshot_path = os.path.join( + self.settings_dict["split_image_directory"], + f"{screenshot_index:03}_SplitImage.png") if not os.path.exists(screenshot_path): break screenshot_index += 1 # Grab screenshot of capture region - capture = capture_region(self.hwnd, self.selection, self.force_print_window_checkbox.isChecked()) + capture = capture_region(self.hwnd, + self.settings_dict["capture_region"], + self.settings_dict["force_print_window"]) if capture is None: error_messages.region() return @@ -427,7 +401,7 @@ def __take_screenshot(self): os.startfile(screenshot_path) def __check_fps(self): - self.fps_value_label.setText(" ") + self.fps_value_label.clear() if not (validate_before_parsing(self) and parse_and_validate_images(self)): return @@ -521,15 +495,15 @@ def start_auto_splitter(self): or (not self.start_auto_splitter_button.isEnabled() and not self.is_auto_controlled): return - start_label: str = self.start_image_label.text() + start_label: str = self.start_image_status_value_label.text() if start_label.endswith("ready") or start_label.endswith("paused"): - self.start_image_label.setText(f"{START_IMAGE_TEXT}: not ready") + self.start_image_status_value_label.setText("not ready") self.start_auto_splitter_signal.emit() def __check_for_reset(self): if self.start_auto_splitter_button.text() == START_AUTO_SPLITTER_TEXT: - if self.auto_start_on_reset_checkbox.isChecked(): + if self.settings_dict["loop_splits"]: self.start_auto_splitter_signal.emit() else: self.gui_changes_on_reset() @@ -537,7 +511,7 @@ def __check_for_reset(self): return False def __auto_splitter(self): - if not self.split_input.text() and not self.is_auto_controlled: + if not self.settings_dict["split_hotkey"] and not self.is_auto_controlled: self.gui_changes_on_reset() error_messages.split_hotkey() return @@ -606,20 +580,14 @@ def __auto_splitter(self): self.similarity = self.split_image.compare_with_capture(self, capture) # show live similarity if the checkbox is checked - self.live_similarity_label.setText( - str(self.similarity)[:4] - if self.show_live_similarity_checkbox.isChecked() - else " ") + self.table_current_image_live_label.setText(str(self.similarity)[:4]) # if the similarity becomes higher than highest similarity, set it as such. if self.similarity > self.highest_similarity: self.highest_similarity = self.similarity # show live highest similarity if the checkbox is checked - self.highest_similarity_label.setText( - str(self.highest_similarity)[:4] - if self.show_highest_similarity_checkbox.isChecked() - else " ") + self.table_current_image_highest_label.setText(str(self.highest_similarity)[:4]) # If its the last split image and last loop number, disable the next image button # If its the first split image, disable the undo split and previous image buttons @@ -645,7 +613,7 @@ def __auto_splitter(self): break # limit the number of time the comparison runs to reduce cpu usage - frame_interval: float = 1 / self.fps_limit_spinbox.value() + frame_interval: float = 1 / self.settings_dict["fps_limit"] # Email sent to pyqt@riverbankcomputing.com QtTest.QTest.qWait(int(frame_interval - (time() - start) % frame_interval)) # type: ignore QApplication.processEvents() @@ -663,7 +631,7 @@ def __auto_splitter(self): self.waiting_for_split_delay = True self.undo_split_button.setEnabled(False) self.skip_split_button.setEnabled(False) - self.current_split_image_file_label.setText(" ") + self.current_image_file_label.clear() # check for reset while delayed and display a counter of the remaining split delay time delay_start_time = time() @@ -687,7 +655,7 @@ def __auto_splitter(self): # if loop check box is checked and its the last split, go to first split. # else go to the next split image. - if self.loop_checkbox.isChecked() and self.split_image_number == number_of_split_images - 1: + if self.settings_dict["loop_splits"] and self.split_image_number == number_of_split_images - 1: self.split_image_number = 0 else: self.split_image_number += 1 @@ -742,46 +710,49 @@ def gui_changes_on_start(self): self.timer_start_image.stop() self.start_auto_splitter_button.setText("Running...") self.browse_button.setEnabled(False) - self.start_image_reload_button.setEnabled(False) + self.reload_start_image_button.setEnabled(False) self.previous_image_button.setEnabled(True) self.next_image_button.setEnabled(True) + if self.SettingsWidget: + self.SettingsWidget.set_split_hotkey_button.setEnabled(False) + self.SettingsWidget.set_reset_hotkey_button.setEnabled(False) + self.SettingsWidget.set_skip_split_hotkey_button.setEnabled(False) + self.SettingsWidget.set_undo_split_hotkey_button.setEnabled(False) + self.SettingsWidget.set_pause_hotkey_button.setEnabled(False) + if not self.is_auto_controlled: self.start_auto_splitter_button.setEnabled(False) self.reset_button.setEnabled(True) self.undo_split_button.setEnabled(True) self.skip_split_button.setEnabled(True) - self.set_split_hotkey_button.setEnabled(False) - self.set_reset_hotkey_button.setEnabled(False) - self.set_skip_split_hotkey_button.setEnabled(False) - self.set_undo_split_hotkey_button.setEnabled(False) - self.set_pause_hotkey_button.setEnabled(False) QApplication.processEvents() def gui_changes_on_reset(self): self.start_auto_splitter_button.setText(START_AUTO_SPLITTER_TEXT) - self.image_loop_label.setText("Image Loop: -") - self.current_split_image.setText(" ") - self.current_split_image_file_label.setText(" ") - self.live_similarity_label.setText(" ") - self.highest_similarity_label.setText(" ") - self.current_similarity_threshold_number_label.setText(" ") + self.image_loop_value_label.setText("N/A") + self.current_split_image.clear() + self.current_image_file_label.clear() + self.table_current_image_live_label.setText("-") + self.table_current_image_highest_label.setText("-") + self.table_current_image_threshold_label.setText("-") self.browse_button.setEnabled(True) - self.start_image_reload_button.setEnabled(True) + self.reload_start_image_button.setEnabled(True) self.previous_image_button.setEnabled(False) self.next_image_button.setEnabled(False) + if self.SettingsWidget: + self.SettingsWidget.set_split_hotkey_button.setEnabled(True) + self.SettingsWidget.set_reset_hotkey_button.setEnabled(True) + self.SettingsWidget.set_skip_split_hotkey_button.setEnabled(True) + self.SettingsWidget.set_undo_split_hotkey_button.setEnabled(True) + self.SettingsWidget.set_pause_hotkey_button.setEnabled(True) if not self.is_auto_controlled: self.start_auto_splitter_button.setEnabled(True) self.reset_button.setEnabled(False) self.undo_split_button.setEnabled(False) self.skip_split_button.setEnabled(False) - self.set_split_hotkey_button.setEnabled(True) - self.set_reset_hotkey_button.setEnabled(True) - self.set_skip_split_hotkey_button.setEnabled(True) - self.set_undo_split_hotkey_button.setEnabled(True) - self.set_pause_hotkey_button.setEnabled(True) QApplication.processEvents() self.load_start_image(False, False) @@ -790,18 +761,22 @@ def __get_capture_for_comparison(self): """ Grab capture region and resize for comparison """ - capture = capture_region(self.hwnd, self.selection, self.force_print_window_checkbox.isChecked()) + capture = capture_region(self.hwnd, + self.settings_dict["capture_region"], + self.settings_dict["force_print_window"]) # This most likely means we lost capture (ie the captured window was closed, crashed, etc.) if capture is None: # Try to recover by using the window name self.live_image.setText("Trying to recover window...") # https://github.com/kaluluosi/pywin32-stubs/issues/7 - hwnd = win32gui.FindWindow(None, self.window_text) # type: ignore + hwnd = win32gui.FindWindow(None, self.settings_dict["captured_window_title"]) # type: ignore # Don't fallback to desktop if hwnd: self.hwnd = hwnd - capture = capture_region(self.hwnd, self.selection, self.force_print_window_checkbox.isChecked()) + capture = capture_region(self.hwnd, + self.settings_dict["capture_region"], + self.settings_dict["force_print_window"]) return None if capture is None else cv2.resize(capture, COMPARISON_RESIZE, interpolation=cv2.INTER_NEAREST) def __reset_if_should(self, capture: Optional[cv2.ndarray]): @@ -833,15 +808,15 @@ def __update_split_image(self, specific_image: Optional[AutoSplitImage] = None): if self.split_image.bytes is not None: set_ui_image(self.current_split_image, self.split_image.bytes, True) - self.current_split_image_file_label.setText(self.split_image.filename) - self.current_similarity_threshold_number_label.setText(f"{self.split_image.get_similarity_threshold(self):.2f}") + self.current_image_file_label.setText(self.split_image.filename) + self.table_current_image_threshold_label.setText(f"{self.split_image.get_similarity_threshold(self):.2f}") # Set Image Loop # if specific_image and specific_image.image_type == ImageType.START: - self.image_loop_label.setText("Image Loop: N/A") + self.image_loop_value_label.setText("N/A") else: loop_tuple = self.split_images_and_loop_number[self.split_image_number] - self.image_loop_label.setText(f"Image Loop: {loop_tuple[1]}/{loop_tuple[0].loops}") + self.image_loop_value_label.setText(f"{loop_tuple[1]}/{loop_tuple[0].loops}") self.highest_similarity = 0.0 # need to set split below threshold to false each time an image updates. diff --git a/src/AutoSplitImage.py b/src/AutoSplitImage.py index 126f2abe..9eeaf8a9 100644 --- a/src/AutoSplitImage.py +++ b/src/AutoSplitImage.py @@ -46,7 +46,7 @@ def get_pause_time(self, default: Union[AutoSplit, float]): """ default_value: float = default \ if isinstance(default, float) \ - else default.pause_spinbox.value() + else default.settings_dict["default_pause_time"] return default_value if self.__pause_time is None else self.__pause_time def get_similarity_threshold(self, default: Union[AutoSplit, float]): @@ -55,7 +55,7 @@ def get_similarity_threshold(self, default: Union[AutoSplit, float]): """ default_value: float = default \ if isinstance(default, float) \ - else default.similarity_threshold_spinbox.value() + else default.settings_dict["default_similarity_threshold"] return default_value if self.__similarity_threshold is None else self.__similarity_threshold def __init__(self, path: str): @@ -109,7 +109,7 @@ def compare_with_capture( """ comparison_method: int = comparison \ if isinstance(comparison, int) \ - else comparison.comparison_method_combobox.currentIndex() + else comparison.settings_dict["default_comparison_method"] if self.bytes is None or capture is None: return 0.0 diff --git a/src/capture_windows.py b/src/capture_windows.py index c991cc38..c6401efa 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -20,17 +20,15 @@ @dataclass -class Rect(ctypes.wintypes.RECT): - """ - Overrides `ctypes.wintypes.RECT` to replace c_long with int for math operators - """ - left: int = -1 # type: ignore - top: int = -1 # type: ignore - right: int = -1 # type: ignore - bottom: int = -1 # type: ignore +class Region(): + def __init__(self, x: int, y: int, width: int, height: int): + self.x = x + self.y = y + self.width = width + self.height = height -def capture_region(hwnd: int, selection: Rect, print_window: bool): +def capture_region(hwnd: int, selection: Region, print_window: bool): """ Captures an image of the region for a window matching the given parameters of the bounding box @@ -40,8 +38,6 @@ def capture_region(hwnd: int, selection: Rect, print_window: bool): @return: The image of the region in the window in BGRA format """ - width: int = selection.right - selection.left - height: int = selection.bottom - selection.top # If the window closes while it's being manipulated, it could cause a crash try: window_dc: int = win32gui.GetWindowDC(hwnd) @@ -54,16 +50,17 @@ def capture_region(hwnd: int, selection: Rect, print_window: bool): compatible_dc = cast(PyCDC, dc_object.CreateCompatibleDC()) bitmap: PyCBitmap = win32ui.CreateBitmap() - bitmap.CreateCompatibleBitmap(dc_object, width, height) + bitmap.CreateCompatibleBitmap(dc_object, selection.width, selection.height) compatible_dc.SelectObject(bitmap) - compatible_dc.BitBlt((0, 0), (width, height), dc_object, (selection.left, selection.top), win32con.SRCCOPY) + compatible_dc.BitBlt((0, 0), (selection.width, selection.height), dc_object, + (selection.x, selection.y), win32con.SRCCOPY) # https://github.com/kaluluosi/pywin32-stubs/issues/5 # pylint: disable=no-member except (win32ui.error, pywintypes.error): # type: ignore return None image = np.frombuffer(cast(bytes, bitmap.GetBitmapBits(True)), dtype="uint8") - image.shape = (height, width, 4) + image.shape = (selection.height, selection.width, 4) try: dc_object.DeleteDC() diff --git a/src/error_messages.py b/src/error_messages.py index 5d8bd382..cb437f36 100644 --- a/src/error_messages.py +++ b/src/error_messages.py @@ -31,12 +31,12 @@ def split_image_directory_empty(): def image_type(image: str): set_text_message(f'"{image}" is not a valid image file, does not exist, ' - "or the full image file path contains a special character.") + + "or the full image file path contains a special character.") def region(): set_text_message("No region is selected or the Capture Region window is not open. " - "Select a region or load settings while the Capture Region window is open.") + + "Select a region or load settings while the Capture Region window is open.") def split_hotkey(): @@ -45,7 +45,7 @@ def split_hotkey(): def pause_hotkey(): set_text_message("Your split image folder contains an image filename with a pause flag {p}, " - "but no pause hotkey is set.") + + "but no pause hotkey is set.") def align_region_image_type(): @@ -82,7 +82,7 @@ def no_settings_file_on_open(): def too_many_settings_files_on_open(): set_text_message("Too many settings files found. " - "Only one can be loaded on open if placed in the same folder as AutoSplit.exe") + + "Only one can be loaded on open if placed in the same folder as AutoSplit.exe") def check_for_updates(): @@ -91,7 +91,7 @@ def check_for_updates(): def load_start_image(): set_text_message("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.") + + "Please set these hotkeys, and then click the Reload Start Image button.") def stdin_lost(): diff --git a/src/hotkeys.py b/src/hotkeys.py index 80701127..3a6901e2 100644 --- a/src/hotkeys.py +++ b/src/hotkeys.py @@ -1,6 +1,7 @@ from __future__ import annotations from typing import Literal, Optional, TYPE_CHECKING, Union from collections.abc import Callable + if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -18,27 +19,29 @@ # do all of these after you click "Set Hotkey" but before you type the hotkey. def before_setting_hotkey(autosplit: AutoSplit): autosplit.start_auto_splitter_button.setEnabled(False) - autosplit.set_split_hotkey_button.setEnabled(False) - autosplit.set_reset_hotkey_button.setEnabled(False) - autosplit.set_skip_split_hotkey_button.setEnabled(False) - autosplit.set_undo_split_hotkey_button.setEnabled(False) - autosplit.set_pause_hotkey_button.setEnabled(False) + if autosplit.SettingsWidget: + autosplit.SettingsWidget.set_split_hotkey_button.setEnabled(False) + autosplit.SettingsWidget.set_reset_hotkey_button.setEnabled(False) + autosplit.SettingsWidget.set_skip_split_hotkey_button.setEnabled(False) + autosplit.SettingsWidget.set_undo_split_hotkey_button.setEnabled(False) + autosplit.SettingsWidget.set_pause_hotkey_button.setEnabled(False) # 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 after_setting_hotkey(autosplit: AutoSplit): - autosplit.set_split_hotkey_button.setText(SET_HOTKEY_TEXT) - autosplit.set_reset_hotkey_button.setText(SET_HOTKEY_TEXT) - autosplit.set_skip_split_hotkey_button.setText(SET_HOTKEY_TEXT) - autosplit.set_undo_split_hotkey_button.setText(SET_HOTKEY_TEXT) - autosplit.set_pause_hotkey_button.setText(SET_HOTKEY_TEXT) autosplit.start_auto_splitter_button.setEnabled(True) - autosplit.set_split_hotkey_button.setEnabled(True) - autosplit.set_reset_hotkey_button.setEnabled(True) - autosplit.set_skip_split_hotkey_button.setEnabled(True) - autosplit.set_undo_split_hotkey_button.setEnabled(True) - autosplit.set_pause_hotkey_button.setEnabled(True) + if autosplit.SettingsWidget: + autosplit.SettingsWidget.set_split_hotkey_button.setText(SET_HOTKEY_TEXT) + autosplit.SettingsWidget.set_reset_hotkey_button.setText(SET_HOTKEY_TEXT) + autosplit.SettingsWidget.set_skip_split_hotkey_button.setText(SET_HOTKEY_TEXT) + autosplit.SettingsWidget.set_undo_split_hotkey_button.setText(SET_HOTKEY_TEXT) + autosplit.SettingsWidget.set_pause_hotkey_button.setText(SET_HOTKEY_TEXT) + autosplit.SettingsWidget.set_split_hotkey_button.setEnabled(True) + autosplit.SettingsWidget.set_reset_hotkey_button.setEnabled(True) + autosplit.SettingsWidget.set_skip_split_hotkey_button.setEnabled(True) + autosplit.SettingsWidget.set_undo_split_hotkey_button.setEnabled(True) + autosplit.SettingsWidget.set_pause_hotkey_button.setEnabled(True) def is_digit(key: Optional[str]): @@ -57,15 +60,15 @@ def send_command(autosplit: AutoSplit, command: Commands): if autosplit.is_auto_controlled: print(command, flush=True) elif command in {"split", "start"}: - _send_hotkey(autosplit.split_input.text()) + _send_hotkey(autosplit.settings_dict["split_hotkey"]) elif command == "pause": - _send_hotkey(autosplit.pause_input.text()) + _send_hotkey(autosplit.settings_dict["pause_hotkey"]) elif command == "reset": - _send_hotkey(autosplit.reset_input.text()) + _send_hotkey(autosplit.settings_dict["reset_hotkey"]) elif command == "skip": - _send_hotkey(autosplit.skip_split_input.text()) + _send_hotkey(autosplit.settings_dict["skip_split_hotkey"]) elif command == "undo": - _send_hotkey(autosplit.undo_split_input.text()) + _send_hotkey(autosplit.settings_dict["undo_split_hotkey"]) else: raise KeyError(f"'{command}' is not a valid LiveSplit.AutoSplitIntegration command") @@ -138,18 +141,19 @@ def __get_key_name(keyboard_event: KeyboardEvent): def __is_key_already_set(autosplit: AutoSplit, key_name: str): - return key_name in (autosplit.split_input.text(), - autosplit.reset_input.text(), - autosplit.skip_split_input.text(), - autosplit.undo_split_input.text(), - autosplit.pause_input.text()) + return key_name in (autosplit.settings_dict["split_hotkey"], + autosplit.settings_dict["reset_hotkey"], + autosplit.settings_dict["skip_split_hotkey"], + autosplit.settings_dict["undo_split_hotkey"], + autosplit.settings_dict["pause_hotkey"]) # --------------------HOTKEYS-------------------------- # TODO: Refactor to de-duplicate all this code, including settings_file.py # Going to comment on one func, and others will be similar. def set_split_hotkey(autosplit: AutoSplit, preselected_key: str = ""): - autosplit.set_split_hotkey_button.setText(PRESS_A_KEY_TEXT) + if autosplit.SettingsWidget: + autosplit.SettingsWidget.set_split_hotkey_button.setText(PRESS_A_KEY_TEXT) # disable some buttons before_setting_hotkey(autosplit) @@ -188,7 +192,9 @@ def callback(): autosplit.split_hotkey = keyboard.hook_key( key_name, lambda error: _hotkey_action(error, key_name, autosplit.start_auto_splitter)) - autosplit.split_input.setText(key_name) + if autosplit.SettingsWidget: + autosplit.SettingsWidget.split_input.setText(key_name) + autosplit.settings_dict["split_hotkey"] = key_name autosplit.after_setting_hotkey_signal.emit() # try to remove the previously set hotkey if there is one. @@ -198,7 +204,8 @@ def callback(): def set_reset_hotkey(autosplit: AutoSplit, preselected_key: str = ""): - autosplit.set_reset_hotkey_button.setText(PRESS_A_KEY_TEXT) + if autosplit.SettingsWidget: + autosplit.SettingsWidget.set_reset_hotkey_button.setText(PRESS_A_KEY_TEXT) before_setting_hotkey(autosplit) def callback(): @@ -215,7 +222,9 @@ def callback(): autosplit.reset_hotkey = keyboard.hook_key( key_name, lambda error: _hotkey_action(error, key_name, autosplit.reset_signal.emit)) - autosplit.reset_input.setText(key_name) + if autosplit.SettingsWidget: + autosplit.SettingsWidget.reset_input.setText(key_name) + autosplit.settings_dict["reset_hotkey"] = key_name autosplit.after_setting_hotkey_signal.emit() _unhook(autosplit.reset_hotkey) @@ -224,7 +233,8 @@ def callback(): def set_skip_split_hotkey(autosplit: AutoSplit, preselected_key: str = ""): - autosplit.set_skip_split_hotkey_button.setText(PRESS_A_KEY_TEXT) + if autosplit.SettingsWidget: + autosplit.SettingsWidget.set_skip_split_hotkey_button.setText(PRESS_A_KEY_TEXT) before_setting_hotkey(autosplit) def callback(): @@ -241,7 +251,9 @@ def callback(): autosplit.skip_split_hotkey = keyboard.hook_key( key_name, lambda error: _hotkey_action(error, key_name, autosplit.skip_split_signal.emit)) - autosplit.skip_split_input.setText(key_name) + if autosplit.SettingsWidget: + autosplit.SettingsWidget.skip_split_input.setText(key_name) + autosplit.settings_dict["skip_split_hotkey"] = key_name autosplit.after_setting_hotkey_signal.emit() _unhook(autosplit.skip_split_hotkey) @@ -250,7 +262,8 @@ def callback(): def set_undo_split_hotkey(autosplit: AutoSplit, preselected_key: str = ""): - autosplit.set_undo_split_hotkey_button.setText(PRESS_A_KEY_TEXT) + if autosplit.SettingsWidget: + autosplit.SettingsWidget.set_undo_split_hotkey_button.setText(PRESS_A_KEY_TEXT) before_setting_hotkey(autosplit) def callback(): @@ -267,7 +280,9 @@ def callback(): autosplit.undo_split_hotkey = keyboard.hook_key( key_name, lambda error: _hotkey_action(error, key_name, autosplit.undo_split_signal.emit)) - autosplit.undo_split_input.setText(key_name) + if autosplit.SettingsWidget: + autosplit.SettingsWidget.undo_split_input.setText(key_name) + autosplit.settings_dict["undo_split_hotkey"] = key_name autosplit.after_setting_hotkey_signal.emit() _unhook(autosplit.undo_split_hotkey) @@ -276,7 +291,8 @@ def callback(): def set_pause_hotkey(autosplit: AutoSplit, preselected_key: str = ""): - autosplit.set_pause_hotkey_button.setText(PRESS_A_KEY_TEXT) + if autosplit.SettingsWidget: + autosplit.SettingsWidget.set_pause_hotkey_button.setText(PRESS_A_KEY_TEXT) before_setting_hotkey(autosplit) def callback(): @@ -293,7 +309,9 @@ def callback(): autosplit.pause_hotkey = keyboard.hook_key( key_name, lambda error: _hotkey_action(error, key_name, autosplit.pause_signal.emit)) - autosplit.pause_input.setText(key_name) + if autosplit.SettingsWidget: + autosplit.SettingsWidget.pause_input.setText(key_name) + autosplit.settings_dict["pause_hotkey"] = key_name autosplit.after_setting_hotkey_signal.emit() _unhook(autosplit.pause_hotkey) diff --git a/src/menu_bar.py b/src/menu_bar.py index 66cb9c85..d90c1e8c 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -1,5 +1,6 @@ from __future__ import annotations -from typing import TYPE_CHECKING +from typing import TYPE_CHECKING, Any + if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -14,7 +15,9 @@ import error_messages import settings_file as settings -from gen import about, design, resources_rc, update_checker # noqa: F401 +from capture_windows import Region +from gen import about, design, resources_rc, settings as settings_ui, update_checker # noqa: F401 +from hotkeys import set_split_hotkey, set_reset_hotkey, set_skip_split_hotkey, set_undo_split_hotkey, set_pause_hotkey # AutoSplit Version number VERSION = "1.6.1" @@ -82,7 +85,7 @@ def __init__(self, autosplit: AutoSplit, check_on_open: bool): def run(self): try: response = requests.get("https://api.github.com/repos/Toufool/Auto-Split/releases/latest") - latest_version = response.json()["name"].split("v")[1] + latest_version = str(response.json()["name"]).split("v")[1] self.autosplit.update_checker_widget_signal.emit(latest_version, self.check_on_open) except (RequestException, KeyError, JSONDecodeError): if not self.check_on_open: @@ -92,3 +95,107 @@ def run(self): def check_for_updates(autosplit: AutoSplit, check_on_open: bool = False): autosplit.CheckForUpdatesThread = __CheckForUpdatesThread(autosplit, check_on_open) autosplit.CheckForUpdatesThread.start() + + +class __SettingsWidget(QtWidgets.QDialog, settings_ui.Ui_DialogSettings): + def __init__(self, autosplit: AutoSplit): + super().__init__() + self.setupUi(self) + self.autosplit = autosplit + + def set_value(key: str, value: Any): + autosplit.settings_dict[key] = value + +# region Set initial values + # Hotkeys + self.split_input.setText(autosplit.settings_dict["split_hotkey"]) + self.reset_input.setText(autosplit.settings_dict["reset_hotkey"]) + self.undo_split_input.setText(autosplit.settings_dict["undo_split_hotkey"]) + self.skip_split_input.setText(autosplit.settings_dict["skip_split_hotkey"]) + self.pause_input.setText(autosplit.settings_dict["pause_hotkey"]) + + # Capture Settings + self.fps_limit_spinbox.setValue(autosplit.settings_dict["fps_limit"]) + self.live_capture_region_checkbox.setChecked(autosplit.settings_dict["live_capture_region"]) + self.force_print_window_checkbox.setChecked(autosplit.settings_dict["force_print_window"]) + + # Image Settings + self.default_comparison_method.setCurrentIndex(autosplit.settings_dict["default_comparison_method"]) + self.default_similarity_threshold_spinbox.setValue(autosplit.settings_dict["default_similarity_threshold"]) + self.default_delay_time_spinbox.setValue(autosplit.settings_dict["default_delay_time"]) + self.default_pause_time_spinbox.setValue(autosplit.settings_dict["default_pause_time"]) + self.loop_splits_checkbox.setChecked(autosplit.settings_dict["loop_splits"]) +# endregion +# region Binding + # Hotkeys + self.set_split_hotkey_button.clicked.connect(lambda: set_split_hotkey(self.autosplit)) + self.set_reset_hotkey_button.clicked.connect(lambda: set_reset_hotkey(self.autosplit)) + self.set_skip_split_hotkey_button.clicked.connect(lambda: set_skip_split_hotkey(self.autosplit)) + self.set_undo_split_hotkey_button.clicked.connect(lambda: set_undo_split_hotkey(self.autosplit)) + self.set_pause_hotkey_button.clicked.connect(lambda: set_pause_hotkey(self.autosplit)) + + # Capture Settings + self.fps_limit_spinbox.valueChanged.connect(lambda: set_value( + "fps_limit", + self.fps_limit_spinbox.value())) + self.live_capture_region_checkbox.stateChanged.connect(lambda: set_value( + "live_capture_region", + self.live_capture_region_checkbox.isChecked())) + self.force_print_window_checkbox.stateChanged.connect(lambda: set_value( + "force_print_window", + self.force_print_window_checkbox.isChecked())) + + # Image Settings + self.default_comparison_method.currentIndexChanged.connect(lambda: set_value( + "default_comparison_method", + self.default_comparison_method.currentIndex())) + self.default_similarity_threshold_spinbox.valueChanged.connect(lambda: set_value( + "default_similarity_threshold", + self.default_similarity_threshold_spinbox.value())) + self.default_delay_time_spinbox.valueChanged.connect(lambda: set_value( + "default_delay_time", + self.default_delay_time_spinbox.value())) + self.default_pause_time_spinbox.valueChanged.connect(lambda: set_value( + "default_pause_time", + self.default_pause_time_spinbox.value())) + self.loop_splits_checkbox.stateChanged.connect(lambda: set_value( + "loop_splits", + self.loop_splits_checkbox.isChecked())) +# endregion + + self.show() + + +def open_settings(autosplit: AutoSplit): + autosplit.SettingsWidget = __SettingsWidget(autosplit) + + +def get_default_settings_from_ui(autosplit: AutoSplit): + temp_dialog = QtWidgets.QDialog() + default_settings_dialog = settings_ui.Ui_DialogSettings() + default_settings_dialog.setupUi(temp_dialog) + default_settings: settings.SettingsDict = { + "split_hotkey": default_settings_dialog.split_input.text(), + "reset_hotkey": default_settings_dialog.reset_input.text(), + "undo_split_hotkey": default_settings_dialog.undo_split_input.text(), + "skip_split_hotkey": default_settings_dialog.skip_split_input.text(), + "pause_hotkey": default_settings_dialog.pause_input.text(), + "fps_limit": default_settings_dialog.fps_limit_spinbox.value(), + "live_capture_region": default_settings_dialog.live_capture_region_checkbox.isChecked(), + "force_print_window": default_settings_dialog.force_print_window_checkbox.isChecked(), + "default_comparison_method": default_settings_dialog.default_comparison_method.currentIndex(), + "default_similarity_threshold": default_settings_dialog.default_similarity_threshold_spinbox.value(), + "default_delay_time": default_settings_dialog.default_delay_time_spinbox.value(), + "default_pause_time": default_settings_dialog.default_pause_time_spinbox.value(), + "loop_splits": default_settings_dialog.loop_splits_checkbox.isChecked(), + + "split_image_directory": autosplit.split_image_folder_input.text(), + "captured_window_title": "", + "capture_region": Region( + autosplit.x_spinbox.value(), + autosplit.y_spinbox.value(), + autosplit.width_spinbox.value(), + autosplit.height_spinbox.value()) + } + del temp_dialog + return default_settings diff --git a/src/screen_region.py b/src/screen_region.py index 03bbf85e..2342dd8d 100644 --- a/src/screen_region.py +++ b/src/screen_region.py @@ -45,7 +45,7 @@ def select_region(autosplit: AutoSplit): error_messages.region() return autosplit.hwnd = hwnd - autosplit.window_text = window_text + autosplit.settings_dict["captured_window_title"] = window_text offset_x, offset_y, *_ = win32gui.GetWindowRect(autosplit.hwnd) __set_region_values(autosplit, @@ -76,7 +76,7 @@ def select_window(autosplit: AutoSplit): error_messages.region() return autosplit.hwnd = hwnd - autosplit.window_text = window_text + autosplit.settings_dict["captured_window_title"] = window_text # Getting window bounds # On Windows there is a shadow around the windows that we need to account for @@ -134,8 +134,8 @@ def align_region(autosplit: AutoSplit): # subregion being searched for to align the image. capture = capture_windows.capture_region( autosplit.hwnd, - autosplit.selection, - autosplit.force_print_window_checkbox.isChecked()) + autosplit.settings_dict["capture_region"], + autosplit.settings_dict["force_print_window"]) if capture is None: error_messages.region() @@ -151,25 +151,23 @@ def align_region(autosplit: AutoSplit): # The new region can be defined by using the min_loc point and the best_height and best_width of the template. __set_region_values(autosplit, - left=autosplit.selection.left + best_loc[0], - top=autosplit.selection.top + best_loc[1], + left=autosplit.settings_dict["capture_region"].x + best_loc[0], + top=autosplit.settings_dict["capture_region"].y + best_loc[1], width=best_width, height=best_height) def __set_region_values(autosplit: AutoSplit, left: int, top: int, width: int, height: int): - autosplit.selection.left = left - autosplit.selection.top = top - autosplit.selection.right = left + width - autosplit.selection.bottom = top + height + autosplit.settings_dict["capture_region"].x = left + autosplit.settings_dict["capture_region"].y = top + autosplit.settings_dict["capture_region"].width = width + autosplit.settings_dict["capture_region"].height = height autosplit.x_spinbox.setValue(left) autosplit.y_spinbox.setValue(top) autosplit.width_spinbox.setValue(width) autosplit.height_spinbox.setValue(height) - autosplit.check_live_image() - def __test_alignment(capture: cv2.ndarray, template: cv2.ndarray): # Obtain the best matching point for the template within the @@ -213,11 +211,11 @@ def __test_alignment(capture: cv2.ndarray, template: cv2.ndarray): def validate_before_parsing(autosplit: AutoSplit, show_error: bool = True, check_empty_directory: bool = True): error = None - if not autosplit.split_image_directory: + if not autosplit.settings_dict["split_image_directory"]: error = error_messages.split_image_directory - elif not os.path.isdir(autosplit.split_image_directory): + elif not os.path.isdir(autosplit.settings_dict["split_image_directory"]): error = error_messages.split_image_directory_not_found - elif check_empty_directory and not os.listdir(autosplit.split_image_directory): + elif check_empty_directory and not os.listdir(autosplit.settings_dict["split_image_directory"]): error = error_messages.split_image_directory_empty elif autosplit.hwnd <= 0 or not win32gui.GetWindowText(autosplit.hwnd): error = error_messages.region diff --git a/src/settings_file.py b/src/settings_file.py index c0315c23..cc6fec44 100644 --- a/src/settings_file.py +++ b/src/settings_file.py @@ -1,5 +1,6 @@ from __future__ import annotations -from typing import TYPE_CHECKING, Any +from typing import TYPE_CHECKING, Any, TypedDict + if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -12,6 +13,7 @@ from PyQt6 import QtCore, QtWidgets import error_messages +from capture_windows import Region from gen import design from hotkeys import set_pause_hotkey, set_reset_hotkey, set_skip_split_hotkey, set_split_hotkey, set_undo_split_hotkey @@ -21,6 +23,26 @@ auto_split_directory = os.path.dirname(sys.executable if FROZEN else os.path.abspath(__file__)) +class SettingsDict(TypedDict): + split_hotkey: str + reset_hotkey: str + undo_split_hotkey: str + skip_split_hotkey: str + pause_hotkey: str + fps_limit: int + live_capture_region: bool + force_print_window: bool + default_comparison_method: int + default_similarity_threshold: float + default_delay_time: int + default_pause_time: float + loop_splits: bool + + split_image_directory: str + captured_window_title: str + capture_region: Region + + class RestrictedUnpickler(pickle.Unpickler): def find_class(self, module: str, name: str): @@ -29,27 +51,27 @@ def find_class(self, module: str, name: str): def get_save_settings_values(autosplit: AutoSplit): return [ - autosplit.split_image_directory, - autosplit.similarity_threshold_spinbox.value(), - autosplit.comparison_method_combobox.currentIndex(), - autosplit.pause_spinbox.value(), - int(autosplit.fps_limit_spinbox.value()), - autosplit.split_input.text(), - autosplit.reset_input.text(), - autosplit.skip_split_input.text(), - autosplit.undo_split_input.text(), - autosplit.pause_input.text(), - autosplit.x_spinbox.value(), - autosplit.y_spinbox.value(), - autosplit.width_spinbox.value(), - autosplit.height_spinbox.value(), - autosplit.window_text, + autosplit.settings_dict["split_image_directory"], + autosplit.settings_dict["default_similarity_threshold"], + autosplit.settings_dict["default_comparison_method"], + autosplit.settings_dict["default_pause_time"], + autosplit.settings_dict["fps_limit"], + autosplit.settings_dict["split_hotkey"], + autosplit.settings_dict["reset_hotkey"], + autosplit.settings_dict["skip_split_hotkey"], + autosplit.settings_dict["undo_split_hotkey"], + autosplit.settings_dict["pause_hotkey"], + autosplit.settings_dict["capture_region"].x, + autosplit.settings_dict["capture_region"].y, + autosplit.settings_dict["capture_region"].width, + autosplit.settings_dict["capture_region"].height, + autosplit.settings_dict["captured_window_title"], 0, 0, 1, - int(autosplit.loop_checkbox.isChecked()), - int(autosplit.auto_start_on_reset_checkbox.isChecked()), - autosplit.force_print_window_checkbox.isChecked()] + autosplit.settings_dict["loop_splits"], + 0, + autosplit.settings_dict["force_print_window"]] def have_settings_changed(autosplit: AutoSplit): @@ -123,12 +145,12 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str autosplit.show_error_signal.emit(error_messages.invalid_settings) return False - autosplit.split_image_directory = settings[0] + autosplit.settings_dict["split_image_directory"] = settings[0] autosplit.split_image_folder_input.setText(settings[0]) - autosplit.similarity_threshold_spinbox.setValue(settings[1]) - autosplit.comparison_method_combobox.setCurrentIndex(settings[2]) - autosplit.pause_spinbox.setValue(settings[3]) - autosplit.fps_limit_spinbox.setValue(settings[4]) + autosplit.settings_dict["default_similarity_threshold"] = settings[1] + autosplit.settings_dict["default_comparison_method"] = settings[2] + autosplit.settings_dict["default_pause_time"] = settings[3] + autosplit.settings_dict["fps_limit"] = settings[4] keyboard.unhook_all() if not autosplit.is_auto_controlled: set_split_hotkey(autosplit, settings[5]) @@ -140,20 +162,19 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str autosplit.y_spinbox.setValue(settings[11]) autosplit.width_spinbox.setValue(settings[12]) autosplit.height_spinbox.setValue(settings[13]) - autosplit.window_text = settings[14] - autosplit.loop_checkbox.setChecked(bool(settings[18])) - autosplit.auto_start_on_reset_checkbox.setChecked(bool(settings[19])) - autosplit.force_print_window_checkbox.setChecked(settings[20]) + autosplit.settings_dict["captured_window_title"] = settings[14] + autosplit.settings_dict["loop_splits"] = settings[18] + autosplit.settings_dict["force_print_window"] = settings[20] - if autosplit.window_text: + if autosplit.settings_dict["captured_window_title"]: # https://github.com/kaluluosi/pywin32-stubs/issues/7 - hwnd = win32gui.FindWindow(None, autosplit.window_text) # type: ignore + hwnd = win32gui.FindWindow(None, autosplit.settings_dict["captured_window_title"]) # type: ignore if hwnd: autosplit.hwnd = hwnd else: autosplit.live_image.setText("Reload settings after opening" - f'\n"{autosplit.window_text}"' - "\nto automatically load Live Capture") + + f'\n"{autosplit.settings_dict["captured_window_title"]}"' + + "\nto automatically load Capture Region") return True @@ -170,7 +191,6 @@ def load_settings( return autosplit.last_successfully_loaded_settings_file_path = load_settings_file_path - autosplit.check_live_image() autosplit.load_start_image() diff --git a/src/split_parser.py b/src/split_parser.py index 27862ed9..6e4a584f 100644 --- a/src/split_parser.py +++ b/src/split_parser.py @@ -153,9 +153,9 @@ def __pop_image_type(split_image: list[AutoSplitImage], image_type: ImageType): def parse_and_validate_images(autosplit: AutoSplit): # Get split images all_images = [ - AutoSplitImage(os.path.join(autosplit.split_image_directory, image_name)) + AutoSplitImage(os.path.join(autosplit.settings_dict["split_image_directory"], image_name)) for image_name - in os.listdir(autosplit.split_image_directory)] + in os.listdir(autosplit.settings_dict["split_image_directory"])] # Find non-split images and then remove them from the list autosplit.start_image = __pop_image_type(all_images, ImageType.START) @@ -171,7 +171,7 @@ def parse_and_validate_images(autosplit: AutoSplit): return False # error out if there is a {p} flag but no pause hotkey set and is not auto controlled. - if (not autosplit.pause_input.text() + if (not autosplit.settings_dict["pause_hotkey"] and image.check_flag(PAUSE_FLAG) and not autosplit.is_auto_controlled): autosplit.gui_changes_on_reset() @@ -181,7 +181,7 @@ def parse_and_validate_images(autosplit: AutoSplit): # Check that there's only one reset image if image.image_type == ImageType.RESET: # If there is no reset hotkey set but a reset image is present, and is not auto controlled, throw an error. - if not autosplit.reset_input.text() and not autosplit.is_auto_controlled: + if not autosplit.settings_dict["reset_hotkey"] and not autosplit.is_auto_controlled: autosplit.gui_changes_on_reset() error_messages.reset_hotkey() return False From f0149f5efcd1c346abe0c7c9a1f08bbcbdd415e1 Mon Sep 17 00:00:00 2001 From: Avasam Date: Wed, 15 Dec 2021 18:24:08 -0500 Subject: [PATCH 002/137] Implemented image specific comparison method and default delay time. Closes #26 --- src/AutoSplit.py | 8 ++--- src/AutoSplitImage.py | 41 +++++++++++++++++-------- src/split_parser.py | 71 ++++++++++++++++++++++++++++--------------- 3 files changed, 79 insertions(+), 41 deletions(-) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 64f73d2b..395468da 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -342,10 +342,10 @@ def __start_image_function(self): self.start_image_split_below_threshold = False # delay start image if needed - if self.start_image.delay > 0: + if self.start_image.get_delay_time(self) > 0: self.start_image_status_value_label.setText("delaying start...") delay_start_time = time() - start_delay = self.start_image.delay / 1000 + start_delay = self.start_image.get_delay_time(self) / 1000 while time() - delay_start_time < start_delay: delay_time_left = round(start_delay - (time() - delay_start_time), 1) self.current_split_image.setText( @@ -398,7 +398,7 @@ def __take_screenshot(self): # save and open image cv2.imwrite(screenshot_path, capture) - os.startfile(screenshot_path) + os.startfile(screenshot_path) # nosec def __check_fps(self): self.fps_value_label.clear() @@ -625,7 +625,7 @@ def __auto_splitter(self): if not self.split_image.check_flag(DUMMY_FLAG): # If it's a delayed split, check if the delay has passed # Otherwise calculate the split time for the key press - split_delay = self.split_image.delay / 1000 + split_delay = self.split_image.get_delay_time(self) / 1000 if split_delay > 0 and not self.waiting_for_split_delay: split_time = round(time() + split_delay * 1000) self.waiting_for_split_delay = True diff --git a/src/AutoSplitImage.py b/src/AutoSplitImage.py index 9eeaf8a9..0a99c5b9 100644 --- a/src/AutoSplitImage.py +++ b/src/AutoSplitImage.py @@ -30,21 +30,40 @@ class AutoSplitImage(): filename: str flags: int loops: int - delay: float image_type: ImageType bytes: Optional[cv2.ndarray] = None mask: Optional[cv2.ndarray] = None # This value is internal, check for mask instead _has_transparency: bool # These values should be overriden by Defaults if None. Use getters instead + __delay_time: Optional[float] = None + __comparison_method: Optional[int] = None __pause_time: Optional[float] = None __similarity_threshold: Optional[float] = None + def get_delay_time(self, default: Union[AutoSplit, int]): + """ + Get image's delay time or fallback to the default value from spinbox + """ + default_value = default \ + if isinstance(default, int) \ + else default.settings_dict["default_delay_time"] + return default_value if self.__delay_time is None else self.__delay_time + + def __get_comparison_method(self, default: Union[AutoSplit, int]): + """ + Get image's comparison or fallback to the default value from combobox + """ + default_value = default \ + if isinstance(default, int) \ + else default.settings_dict["default_comparison_method"] + return default_value if self.__comparison_method is None else self.__comparison_method + def get_pause_time(self, default: Union[AutoSplit, float]): """ Get image's pause time or fallback to the default value from spinbox """ - default_value: float = default \ + default_value = default \ if isinstance(default, float) \ else default.settings_dict["default_pause_time"] return default_value if self.__pause_time is None else self.__pause_time @@ -53,7 +72,7 @@ def get_similarity_threshold(self, default: Union[AutoSplit, float]): """ Get image's similarity threashold or fallback to the default value from spinbox """ - default_value: float = default \ + default_value = default \ if isinstance(default, float) \ else default.settings_dict["default_similarity_threshold"] return default_value if self.__similarity_threshold is None else self.__similarity_threshold @@ -63,7 +82,8 @@ def __init__(self, path: str): self.filename = os.path.split(path)[-1].lower() self.flags = flags_from_filename(self.filename) self.loops = loop_from_filename(self.filename) - self.delay = delay_from_filename(self.filename) + self.__delay_time = delay_time_from_filename(self.filename) + self.__comparison_method = comparison_method_from_filename(self.filename) self.__pause_time = pause_from_filename(self.filename) self.__similarity_threshold = threshold_from_filename(self.filename) self.__read_image_bytes(path) @@ -101,18 +121,15 @@ def check_flag(self, flag: int): def compare_with_capture( self, - comparison: Union[AutoSplit, int], + default: Union[AutoSplit, int], capture: Optional[cv2.ndarray] ): """ - Compare image with capture using comparison method from combobox + Compare image with capture using image's comparison method. Falls back to combobox """ - comparison_method: int = comparison \ - if isinstance(comparison, int) \ - else comparison.settings_dict["default_comparison_method"] - if self.bytes is None or capture is None: return 0.0 + comparison_method = self.__get_comparison_method(default) if comparison_method == 0: return compare_l2_norm(self.bytes, capture, self.mask) if comparison_method == 1: @@ -122,5 +139,5 @@ def compare_with_capture( return 0.0 -from split_parser import delay_from_filename, flags_from_filename, loop_from_filename, pause_from_filename, \ - threshold_from_filename +from split_parser import comparison_method_from_filename, delay_time_from_filename, flags_from_filename, \ + loop_from_filename, pause_from_filename, threshold_from_filename diff --git a/src/split_parser.py b/src/split_parser.py index 6e4a584f..73247626 100644 --- a/src/split_parser.py +++ b/src/split_parser.py @@ -1,5 +1,5 @@ from __future__ import annotations -from typing import TYPE_CHECKING +from typing import TYPE_CHECKING, TypeVar if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -14,6 +14,22 @@ PAUSE_FLAG, *_] = [1 << i for i in range(31)] # 32 bits of flags +T = TypeVar("T", str, int, float) + + +def __value_from_filename( + filename: str, + delimiters: str, + default_value: T +) -> T: + if len(delimiters) != 2: + raise ValueError("delimiters parameter must contain exactly 2 characters") + try: + value_type = type(default_value) + return value_type(filename.split(delimiters[0], 1)[1].split(delimiters[1])[0]) + except (IndexError, ValueError): + return default_value + def threshold_from_filename(filename: str): """ @@ -26,13 +42,10 @@ 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 (IndexError, ValueError): - return None + value = __value_from_filename(filename, "()", -1.0) # Check to make sure if it is a valid threshold - return threshold if 0.0 < threshold < 1.0 else None + return value if 0.0 < value < 1.0 else None def pause_from_filename(filename: str): @@ -46,16 +59,13 @@ 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 (IndexError, ValueError): - return None + value = __value_from_filename(filename, "[]", -1.0) # Pause times should always be positive or zero - return pause if pause >= 0.0 else None + return value if value >= 0.0 else None -def delay_from_filename(filename: str): +def delay_time_from_filename(filename: str): """ Retrieve the delay time from the filename, if there is no delay time or the delay time isn't a valid number, then 0 is returned @@ -66,13 +76,10 @@ 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 (IndexError, ValueError): - return 0.0 + value = __value_from_filename(filename, "##", 0) # Delay times should always be positive or zero - return delay if delay >= 0.0 else 0.0 + return value if value >= 0 else None def loop_from_filename(filename: str): @@ -86,13 +93,27 @@ 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 (IndexError, ValueError): - return 1 + value = __value_from_filename(filename, "@@", 1) # Loop should always be positive - return loop if loop >= 1 else 1 + return value if value >= 1 else 1 + + +def comparison_method_from_filename(filename: str): + """ + Retrieve the number of loops from filename, if there is no loop number or the loop number isn't valid, + then 1 is returned. + + @param filename: String containing the file's name + @return: A valid loop number, if not then 1 + """ + + # Check to make sure there is a valid delay time between brackets + # of the filename + value = __value_from_filename(filename, "<>", 0) + + # Comparison method should always be positive or zero + return value if value >= 0 else None def flags_from_filename(filename: str): @@ -110,9 +131,9 @@ def flags_from_filename(filename: str): # Check to make sure there are flags between curly braces # of the filename - try: - flags_str = filename.split("{", 1)[1].split("}")[0] - except (IndexError, ValueError): + flags_str = __value_from_filename(filename, "{}", "") + + if not flags_str: return 0 flags = 0x00 From 4f8900788970c742f1324ab0a63dcc8c3aa97287 Mon Sep 17 00:00:00 2001 From: Avasam Date: Thu, 16 Dec 2021 00:25:03 -0500 Subject: [PATCH 003/137] Better "seconds remaining" text --- res/settings.ui | 5 +-- src/AutoSplit.py | 20 +++++---- src/hotkeys.py | 18 ++++---- typings/keyboard/__init__.pyi | 62 ++++++++++++++++----------- typings/keyboard/_canonical_names.pyi | 11 +++++ 5 files changed, 69 insertions(+), 47 deletions(-) create mode 100644 typings/keyboard/_canonical_names.pyi diff --git a/res/settings.ui b/res/settings.ui index a388d7d6..ee4dfd38 100644 --- a/res/settings.ui +++ b/res/settings.ui @@ -427,7 +427,7 @@ - false + true @@ -477,9 +477,6 @@ - - true - true diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 64f73d2b..2b07c941 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -300,9 +300,9 @@ def __start_image_function(self): or not self.start_image \ or time() < self.check_start_image_timestamp \ or (not self.settings_dict["split_hotkey"] and not self.is_auto_controlled): - pause_time_left = f"{self.check_start_image_timestamp - time():.1f}" + pause_time_left = self.check_start_image_timestamp - time() self.current_split_image.setText( - f"None\n (Paused before loading Start Image).\n {pause_time_left} sec remaining") + f"None\n (Paused before loading Start Image).\n {seconds_remaining_text(pause_time_left)}") return if self.check_start_image_timestamp > 0: @@ -347,9 +347,9 @@ def __start_image_function(self): delay_start_time = time() start_delay = self.start_image.delay / 1000 while time() - delay_start_time < start_delay: - delay_time_left = round(start_delay - (time() - delay_start_time), 1) + delay_time_left = start_delay - (time() - delay_start_time) self.current_split_image.setText( - f"Delayed Before Starting:\n {delay_time_left} sec remaining") + f"Delayed Before Starting:\n {seconds_remaining_text(delay_time_left)}") # Email sent to pyqt@riverbankcomputing.com QtTest.QTest.qWait(1) # type: ignore @@ -636,8 +636,8 @@ def __auto_splitter(self): # check for reset while delayed and display a counter of the remaining split delay time delay_start_time = time() while time() - delay_start_time < split_delay: - delay_time_left = round(split_delay - (time() - delay_start_time), 1) - self.current_split_image.setText(f"Delayed Split: {delay_time_left} sec remaining") + delay_time_left = split_delay - (time() - delay_start_time) + self.current_split_image.setText(f"Delayed Split: {seconds_remaining_text(delay_time_left)}") if self.__check_for_reset(): return @@ -684,8 +684,8 @@ def __auto_splitter(self): if pause_time > 0: pause_start_time = time() while time() - pause_start_time < pause_time: - pause_time_left = round(pause_time - (time() - pause_start_time), 1) - self.current_split_image.setText(f"None (Paused). {pause_time_left} sec remaining") + pause_time_left = pause_time - (time() - pause_start_time) + self.current_split_image.setText(f"None (Paused). {seconds_remaining_text(pause_time_left)}") if self.__check_for_reset(): return @@ -869,6 +869,10 @@ def exit_program(): exit_program() +def seconds_remaining_text(seconds: float): + return f"{seconds:.1f} second{'' if 0 < seconds <= 1 else 's'} remaining" + + def main(): # Call to QApplication outside the try-except so we can show error messages app = QApplication(sys.argv) diff --git a/src/hotkeys.py b/src/hotkeys.py index 3a6901e2..9fcdf23c 100644 --- a/src/hotkeys.py +++ b/src/hotkeys.py @@ -6,10 +6,10 @@ from AutoSplit import AutoSplit import threading -from keyboard._keyboard_event import KeyboardEvent, KEY_DOWN + import keyboard # https://github.com/boppreh/keyboard/issues/505 import pyautogui # https://github.com/asweigart/pyautogui/issues/645 -# While not usually recommended, we don'thread manipulate the mouse, and we don'thread want the extra delay +# While not usually recommended, we don't manipulate the mouse, and we don't want the extra delay pyautogui.FAILSAFE = False SET_HOTKEY_TEXT = "Set Hotkey" @@ -100,11 +100,11 @@ def _send_hotkey(key_or_scan_code: Union[int, str]): pyautogui.hotkey(key_or_scan_code.replace(" ", "")) -def __validate_keypad(expected_key: str, keyboard_event: KeyboardEvent) -> bool: +def __validate_keypad(expected_key: str, keyboard_event: keyboard.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}: - # TODO: "del" won'thread work with "(keypad)delete" if localized in non-english (ie: "suppr" in french) + # 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" if keyboard_event.name and is_digit(keyboard_event.name[-1]): @@ -125,16 +125,16 @@ def __validate_keypad(expected_key: str, keyboard_event: KeyboardEvent) -> bool: # 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'thread. +# while the keypad ones aren't. -# Since we reuse the key string we set to send to LiveSplit, we can'thread use fake names like "num home". +# 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]): - if keyboard_event.event_type == KEY_DOWN and __validate_keypad(key_name, keyboard_event): +def _hotkey_action(keyboard_event: keyboard.KeyboardEvent, key_name: str, action: Callable[[], None]): + if keyboard_event.event_type == keyboard.KEY_DOWN and __validate_keypad(key_name, keyboard_event): action() -def __get_key_name(keyboard_event: KeyboardEvent): +def __get_key_name(keyboard_event: keyboard.KeyboardEvent): return f"num {keyboard_event.name}" \ if keyboard_event.is_keypad and is_digit(keyboard_event.name) \ else str(keyboard_event.name) diff --git a/typings/keyboard/__init__.pyi b/typings/keyboard/__init__.pyi index 18f68af6..86bd06ec 100644 --- a/typings/keyboard/__init__.pyi +++ b/typings/keyboard/__init__.pyi @@ -3,6 +3,7 @@ This type stub file was generated by pyright. """ from __future__ import print_function as _print_function import typing +import collections.abc import re as _re import itertools as _itertools @@ -13,6 +14,7 @@ from threading import Lock as _Lock, Thread as _Thread from ._keyboard_event import KEY_DOWN, KEY_UP, KeyboardEvent from ._generic import GenericListener as _GenericListener from ._canonical_names import all_modifiers, normalize_name, sided_modifiers +__all__ = ["all_modifiers", "normalize_name", "sided_modifiers", "KEY_DOWN", "KEY_UP", "KeyboardEvent"] try: # Python2 @@ -103,12 +105,12 @@ key events. In this case `keyboard` will be unable to report events. - This program makes no attempt to hide itself, so don't use it for keyloggers or online gaming bots. Be responsible. """ -Callback = typing.Callable[[KeyboardEvent], None] +Callback = collections.abc.Callable[[KeyboardEvent], None] version: str -_is_str = typing.Callable[[typing.Any], bool] -_is_number = typing.Callable[[typing.Any], bool] -_is_list: typing.Callable[[typing.Any], bool] +_is_str = collections.abc.Callable[[typing.Any], bool] +_is_number = collections.abc.Callable[[typing.Any], bool] +_is_list: collections.abc.Callable[[typing.Any], bool] class _State: @@ -120,10 +122,6 @@ class _Event(_UninterruptibleEvent): ... -if _platform.system() == 'Windows': - ... -else: - ... _modifier_scan_codes: set @@ -197,14 +195,16 @@ class _KeyboardListener(_GenericListener): _listener: _KeyboardListener -def key_to_scan_codes(key: typing.Union[int, str, typing.List[typing.Union[int, str]]], error_if_missing: bool = ...) -> typing.List[int]: +def key_to_scan_codes(key: typing.Union[int, str, typing.List[typing.Union[int, str]]], + error_if_missing: bool = ...) -> typing.List[int]: """ Returns a list of scan codes associated with this key (name or scan code). """ ... -def parse_hotkey(hotkey) -> tuple[tuple[tuple[Unknown] | Unknown | tuple[()] | tuple[Unknown, ...]]] | tuple[tuple[tuple[Unknown] | Unknown | tuple[()] | tuple[Unknown, ...], ...]] | tuple[Unknown, ...]: +def parse_hotkey(hotkey) -> tuple[tuple[tuple[Unknown] | Unknown | tuple[()] | tuple[Unknown, ...]] + ] | tuple[tuple[tuple[Unknown] | Unknown | tuple[()] | tuple[Unknown, ...], ...]] | tuple[Unknown, ...]: """ Parses a user-provided hotkey into nested tuples representing the parsed structure, with the bottom values being lists of scan codes. @@ -274,10 +274,10 @@ def call_later(fn, args=..., delay=...) -> None: ... -_hooks: dict[typing.Callable, Unknown] +_hooks: dict[collections.abc.Callable, Unknown] -def hook(callback: Callback, suppress=..., on_remove=...) -> typing.Callable[[], None]: +def hook(callback: Callback, suppress=..., on_remove=...) -> collections.abc.Callable[[], None]: """ Installs a global listener on all available keyboards, invoking `callback` each time a key is pressed or released. @@ -296,21 +296,22 @@ def hook(callback: Callback, suppress=..., on_remove=...) -> typing.Callable[[], ... -def on_press(callback: Callback, suppress=...) -> typing.Callable[[], None]: +def on_press(callback: Callback, suppress=...) -> collections.abc.Callable[[], None]: """ Invokes `callback` for every KEY_DOWN event. For details see `hook`. """ ... -def on_release(callback: Callback, suppress=...) -> typing.Callable[[], None]: +def on_release(callback: Callback, suppress=...) -> collections.abc.Callable[[], None]: """ Invokes `callback` for every KEY_UP event. For details see `hook`. """ ... -def hook_key(key: typing.Union[int, str, typing.List[typing.Union[int, str]]], callback: Callback, suppress: bool = ...) -> typing.Callable[[], None]: +def hook_key(key: typing.Union[int, str, typing.List[typing.Union[int, str]]], + callback: Callback, suppress: bool = ...) -> collections.abc.Callable[[], None]: """ Hooks key up and key down events for a single key. Returns the event handler created. To remove a hooked key use `unhook_key(key)` or @@ -322,21 +323,21 @@ def hook_key(key: typing.Union[int, str, typing.List[typing.Union[int, str]]], c ... -def on_press_key(key, callback: Callback, suppress=...) -> typing.Callable[[], None]: +def on_press_key(key, callback: Callback, suppress=...) -> collections.abc.Callable[[], None]: """ Invokes `callback` for KEY_DOWN event related to the given key. For details see `hook`. """ ... -def on_release_key(key, callback: Callback, suppress=...) -> typing.Callable[[], None]: +def on_release_key(key, callback: Callback, suppress=...) -> collections.abc.Callable[[], None]: """ Invokes `callback` for KEY_UP event related to the given key. For details see `hook`. """ ... -def unhook(remove: typing.Callable[[], None]) -> None: +def unhook(remove: collections.abc.Callable[[], None]) -> None: """ Removes a previously added hook, either by callback or by the return value of `hook`. @@ -355,7 +356,7 @@ def unhook_all() -> None: ... -def block_key(key) -> typing.Callable[[], None]: +def block_key(key) -> collections.abc.Callable[[], None]: """ Suppresses all key events of the given key, regardless of modifiers. """ @@ -365,7 +366,7 @@ def block_key(key) -> typing.Callable[[], None]: unblock_key = unhook_key -def remap_key(src, dst) -> typing.Callable[[], None]: +def remap_key(src, dst) -> collections.abc.Callable[[], None]: """ Whenever the key `src` is pressed or released, regardless of modifiers, press or release the hotkey `dst` instead. @@ -388,7 +389,8 @@ def parse_hotkey_combinations(hotkey) -> tuple[tuple[tuple[Unknown, ...], ...], _hotkeys: dict -def add_hotkey(hotkey, callback: Callback, args=..., suppress=..., timeout=..., trigger_on_release=...) -> typing.Callable[[], None]: +def add_hotkey(hotkey, callback: collections.abc.Callable, args=..., suppress=..., timeout=..., + trigger_on_release=...) -> collections.abc.Callable[[], None]: """ Invokes a callback every time a hotkey is pressed. The hotkey must be in the format `ctrl+shift+a, s`. This would trigger when the user holds @@ -453,7 +455,7 @@ def unhook_all_hotkeys() -> None: unregister_all_hotkeys = remove_all_hotkeys = clear_all_hotkeys = unhook_all_hotkeys -def remap_hotkey(src, dst, suppress=..., trigger_on_release=...) -> typing.Callable[[], None]: +def remap_hotkey(src, dst, suppress=..., trigger_on_release=...) -> collections.abc.Callable[[], None]: """ Whenever the hotkey `src` is pressed, suppress it and send `dst` instead. @@ -589,10 +591,11 @@ def get_typed_strings(events, allow_backspace=...): ... -_recording: typing.Optional[tuple[Unknown | _queue.Queue[Unknown], typing.Callable[[], None]]] +_recording: typing.Optional[tuple[Unknown | _queue.Queue[Unknown], collections.abc.Callable[[], None]]] -def start_recording(recorded_events_queue=...) -> tuple[Unknown | _queue.Queue[Unknown], typing.Callable[[], None]]: +def start_recording(recorded_events_queue=...) -> tuple[Unknown + | _queue.Queue[Unknown], collections.abc.Callable[[], None]]: """ Starts recording all keyboard events into a global variable, or the given queue if any. Returns the queue of events and the hooked function. @@ -639,7 +642,13 @@ replay = play _word_listeners: dict -def add_word_listener(word, callback: Callback, triggers=..., match_suffix=..., timeout=...) -> typing.Callable[[], None]: +def add_word_listener( + word, + callback: Callback, + triggers=..., + match_suffix=..., + timeout=...) -> collections.abc.Callable[[], + None]: """ Invokes a callback every time a sequence of characters is typed (e.g. 'pet') and followed by a trigger key (e.g. space). Modifiers (e.g. alt, ctrl, @@ -676,7 +685,8 @@ def remove_word_listener(word_or_handler) -> None: ... -def add_abbreviation(source_text, replacement_text, match_suffix=..., timeout=...) -> typing.Callable[[], None]: +def add_abbreviation(source_text, replacement_text, match_suffix=..., + timeout=...) -> collections.abc.Callable[[], None]: """ Registers a hotkey that replaces one typed text with another. For example diff --git a/typings/keyboard/_canonical_names.pyi b/typings/keyboard/_canonical_names.pyi new file mode 100644 index 00000000..94cb7a64 --- /dev/null +++ b/typings/keyboard/_canonical_names.pyi @@ -0,0 +1,11 @@ +""" +This type stub file was generated by pyright. +""" + +canonical_names = ... +sided_modifiers = ... +all_modifiers = ... + + +def normalize_name(name: str) -> str: + ... From 2eee9ded70dcc208e4aa9c9c94dd811b2ce9e89c Mon Sep 17 00:00:00 2001 From: Avasam Date: Thu, 16 Dec 2021 00:27:30 -0500 Subject: [PATCH 004/137] Support modifiers the same way LiveSplit does. Closes #34 --- src/hotkeys.py | 321 +++++++++++++++++-------------------------- src/menu_bar.py | 12 +- src/settings_file.py | 12 +- 3 files changed, 137 insertions(+), 208 deletions(-) diff --git a/src/hotkeys.py b/src/hotkeys.py index 9fcdf23c..555f1b22 100644 --- a/src/hotkeys.py +++ b/src/hotkeys.py @@ -15,36 +15,37 @@ SET_HOTKEY_TEXT = "Set Hotkey" PRESS_A_KEY_TEXT = "Press a key..." +Commands = Literal["split", "start", "pause", "reset", "skip", "undo"] +Hotkeys = Literal["split", "reset", "skip_split", "undo_split", "pause"] +HOTKEYS: list[Hotkeys] = ["split", "reset", "skip_split", "undo_split", "pause"] + -# do all of these after you click "Set Hotkey" but before you type the hotkey. def before_setting_hotkey(autosplit: AutoSplit): + """ + Do all of these after you click "Set Hotkey" but before you type the hotkey + """ autosplit.start_auto_splitter_button.setEnabled(False) if autosplit.SettingsWidget: - autosplit.SettingsWidget.set_split_hotkey_button.setEnabled(False) - autosplit.SettingsWidget.set_reset_hotkey_button.setEnabled(False) - autosplit.SettingsWidget.set_skip_split_hotkey_button.setEnabled(False) - autosplit.SettingsWidget.set_undo_split_hotkey_button.setEnabled(False) - autosplit.SettingsWidget.set_pause_hotkey_button.setEnabled(False) + for hotkey in HOTKEYS: + getattr(autosplit.SettingsWidget, f"set_{hotkey}_hotkey_button").setEnabled(False) -# 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 after_setting_hotkey(autosplit: AutoSplit): + """ + Do all of these things after you set a hotkey. + A signal connects to this because changing GUI stuff is only possible in the main thread + """ autosplit.start_auto_splitter_button.setEnabled(True) if autosplit.SettingsWidget: - autosplit.SettingsWidget.set_split_hotkey_button.setText(SET_HOTKEY_TEXT) - autosplit.SettingsWidget.set_reset_hotkey_button.setText(SET_HOTKEY_TEXT) - autosplit.SettingsWidget.set_skip_split_hotkey_button.setText(SET_HOTKEY_TEXT) - autosplit.SettingsWidget.set_undo_split_hotkey_button.setText(SET_HOTKEY_TEXT) - autosplit.SettingsWidget.set_pause_hotkey_button.setText(SET_HOTKEY_TEXT) - autosplit.SettingsWidget.set_split_hotkey_button.setEnabled(True) - autosplit.SettingsWidget.set_reset_hotkey_button.setEnabled(True) - autosplit.SettingsWidget.set_skip_split_hotkey_button.setEnabled(True) - autosplit.SettingsWidget.set_undo_split_hotkey_button.setEnabled(True) - autosplit.SettingsWidget.set_pause_hotkey_button.setEnabled(True) + for hotkey in HOTKEYS: + getattr(autosplit.SettingsWidget, f"set_{hotkey}_hotkey_button").setText(SET_HOTKEY_TEXT) + getattr(autosplit.SettingsWidget, f"set_{hotkey}_hotkey_button").setEnabled(True) def is_digit(key: Optional[str]): + """ + Checks if `key` is a single-digit string from 0-9 + """ if key is None: return False try: @@ -53,9 +54,6 @@ def is_digit(key: Optional[str]): return False -Commands = Literal["split", "start", "pause", "reset", "skip", "undo"] - - def send_command(autosplit: AutoSplit, command: Commands): if autosplit.is_auto_controlled: print(command, flush=True) @@ -74,33 +72,48 @@ def send_command(autosplit: AutoSplit, command: Commands): raise KeyError(f"'{command}' is not a valid LiveSplit.AutoSplitIntegration command") -def _unhook(hotkey: Optional[Callable[[], None]]): +def _unhook(hotkey_callback: Optional[Callable[[], None]]): try: - if hotkey: - keyboard.unhook_key(hotkey) + if hotkey_callback: + keyboard.unhook_key(hotkey_callback) except (AttributeError, KeyError, ValueError): pass -def _send_hotkey(key_or_scan_code: Union[int, str]): +def _send_hotkey(hotkey_or_scan_code: Union[int, str, None]): """ Supports sending the appropriate scan code for all the special cases """ - if not key_or_scan_code: + if not hotkey_or_scan_code: return # 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"): - keyboard.send(key_or_scan_code) + # If an int or does not contain the following strings + if isinstance(hotkey_or_scan_code, int) \ + or not ("num " in hotkey_or_scan_code or "decimal" in hotkey_or_scan_code or "+" in hotkey_or_scan_code): + keyboard.send(hotkey_or_scan_code) return + # FIXME: Localized keys won't work here # Deal with problematic keys. Even by sending specific scan code "keyboard" still sends the default (wrong) key + # keyboard also has issues with capitalization modifier (shift+A) # keyboard.send(keyboard.key_to_scan_codes(key_or_scan_code)[1]) - pyautogui.hotkey(key_or_scan_code.replace(" ", "")) + pyautogui.hotkey(*[ + "+" if key == "plus" else key + for key + in hotkey_or_scan_code.replace(" ", "").split("+")]) def __validate_keypad(expected_key: str, keyboard_event: keyboard.KeyboardEvent) -> bool: + """ + NOTE: This is a workaround very specific to numpads. + 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 + + 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. + """ # 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}: @@ -118,202 +131,118 @@ def __validate_keypad(expected_key: str, keyboard_event: keyboard.KeyboardEvent) return not is_digit(expected_key[-1]) -# NOTE: This is a workaround very specific to numpads. -# 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: keyboard.KeyboardEvent, key_name: str, action: Callable[[], None]): + """ + We're doing the check here instead of saving the key code because + the non-keypad shared keys are localized while the keypad ones aren't. + They also share scan codes on Windows + """ if keyboard_event.event_type == keyboard.KEY_DOWN and __validate_keypad(key_name, keyboard_event): action() def __get_key_name(keyboard_event: keyboard.KeyboardEvent): + """ + Ensures proper keypad name + """ + event_name = str(keyboard_event.name) + # Normally this is done by keyboard.get_hotkey_name. But our code won't always get there. + if event_name == "+": + return "plus" return f"num {keyboard_event.name}" \ if keyboard_event.is_keypad and is_digit(keyboard_event.name) \ - else str(keyboard_event.name) - - -def __is_key_already_set(autosplit: AutoSplit, key_name: str): - return key_name in (autosplit.settings_dict["split_hotkey"], - autosplit.settings_dict["reset_hotkey"], - autosplit.settings_dict["skip_split_hotkey"], - autosplit.settings_dict["undo_split_hotkey"], - autosplit.settings_dict["pause_hotkey"]) + else event_name -# --------------------HOTKEYS-------------------------- -# TODO: Refactor to de-duplicate all this code, including settings_file.py -# Going to comment on one func, and others will be similar. -def set_split_hotkey(autosplit: AutoSplit, preselected_key: str = ""): - if autosplit.SettingsWidget: - autosplit.SettingsWidget.set_split_hotkey_button.setText(PRESS_A_KEY_TEXT) - - # disable some buttons - before_setting_hotkey(autosplit) - - # new thread points to callback. this thread is needed or GUI will freeze - # while the program waits for user input on the hotkey - def callback(): - # use the selected key OR - # wait until user presses the hotkey, then keyboard module reads the input - key_name = preselected_key if preselected_key else __get_key_name(keyboard.read_event(True)) - try: - # If the key the user presses is equal to itself or another hotkey already set, - # this causes issues. so here, it catches that, and will make no changes to the hotkey. - - # or - - # keyboard module allows you to hit multiple keys for a hotkey. they are joined - # together by +. If user hits two keys at the same time, make no changes to the - # hotkey. A try and except is needed if a hotkey hasn'thread 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): - autosplit.after_setting_hotkey_signal.emit() - return - except AttributeError: - autosplit.after_setting_hotkey_signal.emit() - return - - # add the key as the hotkey, set the text into the _input, set it as old_xxx_key, - # then emite a signal to re-enable some buttons and change some text in GUI. - - # We need to inspect the event to know if it comes from numpad because of _canonial_names. - # See: https://github.com/boppreh/keyboard/issues/161#issuecomment-386825737 - # The best way to achieve this is make our own hotkey handling on top of hook - # See: https://github.com/boppreh/keyboard/issues/216#issuecomment-431999553 - autosplit.split_hotkey = keyboard.hook_key( - key_name, - lambda error: _hotkey_action(error, key_name, autosplit.start_auto_splitter)) - if autosplit.SettingsWidget: - autosplit.SettingsWidget.split_input.setText(key_name) - autosplit.settings_dict["split_hotkey"] = key_name - autosplit.after_setting_hotkey_signal.emit() +def __get_hotkey_name(names: list[str]): + """ + Uses keyboard.get_hotkey_name but works with non-english modifiers and keypad + See: https://github.com/boppreh/keyboard/issues/516 + """ + def sorting_key(key: str): + return not keyboard.is_modifier(keyboard.key_to_scan_codes(key)[0]) - # try to remove the previously set hotkey if there is one. - _unhook(autosplit.split_hotkey) - thread = threading.Thread(target=callback) - thread.start() + if len(names) == 1: + return names[0] + clean_names = sorted(keyboard.get_hotkey_name(names).split("+"), key=sorting_key) + # Replace the last key in hotkey_name with what we actually got as a last key_name + # This ensures we keep proper keypad names + return "+".join(clean_names[:-1] + names[-1:]) -def set_reset_hotkey(autosplit: AutoSplit, preselected_key: str = ""): - if autosplit.SettingsWidget: - autosplit.SettingsWidget.set_reset_hotkey_button.setText(PRESS_A_KEY_TEXT) - before_setting_hotkey(autosplit) - - def callback(): - key_name = preselected_key if preselected_key else __get_key_name(keyboard.read_event(True)) +def __read_hotkey(): + """ + Blocks until a hotkey combination is read. + Returns the hotkey_name and last KeyboardEvent + """ + names: list[str] = [] + while True: + keyboard_event = keyboard.read_event(True) + # LiveSplit supports modifier keys as the last key, so any keyup means end of hotkey + if keyboard_event.event_type == keyboard.KEY_UP: + break + key_name = __get_key_name(keyboard_event) + print(key_name) + # Ignore long presses + if names and names[-1] == key_name: + continue + names.append(__get_key_name(keyboard_event)) + # Stop at the first non-modifier to prevent registering a hotkey with multiple regular keys + if not keyboard.is_modifier(keyboard_event.scan_code): + break + return __get_hotkey_name(names) - try: - if __is_key_already_set(autosplit, key_name) or (key_name != "+" and "+" in key_name): - autosplit.after_setting_hotkey_signal.emit() - return - except AttributeError: - autosplit.after_setting_hotkey_signal.emit() - return - autosplit.reset_hotkey = keyboard.hook_key( - key_name, - lambda error: _hotkey_action(error, key_name, autosplit.reset_signal.emit)) - if autosplit.SettingsWidget: - autosplit.SettingsWidget.reset_input.setText(key_name) - autosplit.settings_dict["reset_hotkey"] = key_name - autosplit.after_setting_hotkey_signal.emit() +def __is_key_already_set(autosplit: AutoSplit, key_name: str): + return key_name in [autosplit.settings_dict[f"{hotkey}_hotkey"] for hotkey in HOTKEYS] - _unhook(autosplit.reset_hotkey) - thread = threading.Thread(target=callback) - thread.start() +# TODO: using getattr/setattr is NOT a good way to go about this. It was only temporarily done to +# reduce duplicated code. We should use a dictionary of hotkey class or something. -def set_skip_split_hotkey(autosplit: AutoSplit, preselected_key: str = ""): +def set_hotkey(autosplit: AutoSplit, hotkey: Hotkeys, preselected_hotkey_name: str = ""): if autosplit.SettingsWidget: - autosplit.SettingsWidget.set_skip_split_hotkey_button.setText(PRESS_A_KEY_TEXT) - before_setting_hotkey(autosplit) - - def callback(): - key_name = preselected_key if preselected_key else __get_key_name(keyboard.read_event(True)) - - try: - if __is_key_already_set(autosplit, key_name) or (key_name != "+" and "+" in key_name): - autosplit.after_setting_hotkey_signal.emit() - return - except AttributeError: - autosplit.after_setting_hotkey_signal.emit() - return - - autosplit.skip_split_hotkey = keyboard.hook_key( - key_name, - lambda error: _hotkey_action(error, key_name, autosplit.skip_split_signal.emit)) - if autosplit.SettingsWidget: - autosplit.SettingsWidget.skip_split_input.setText(key_name) - autosplit.settings_dict["skip_split_hotkey"] = key_name - autosplit.after_setting_hotkey_signal.emit() - - _unhook(autosplit.skip_split_hotkey) - thread = threading.Thread(target=callback) - thread.start() - + getattr(autosplit.SettingsWidget, f"set_{hotkey}_hotkey_button").setText(PRESS_A_KEY_TEXT) -def set_undo_split_hotkey(autosplit: AutoSplit, preselected_key: str = ""): - if autosplit.SettingsWidget: - autosplit.SettingsWidget.set_undo_split_hotkey_button.setText(PRESS_A_KEY_TEXT) + # Disable some buttons before_setting_hotkey(autosplit) + # New thread points to callback. this thread is needed or GUI will freeze + # while the program waits for user input on the hotkey def callback(): - key_name = preselected_key if preselected_key else __get_key_name(keyboard.read_event(True)) + hotkey_name = preselected_hotkey_name if preselected_hotkey_name else __read_hotkey() - try: - if __is_key_already_set(autosplit, key_name) or (key_name != "+" and "+" in key_name): - autosplit.after_setting_hotkey_signal.emit() - return - except AttributeError: + # If the key the user presses is equal to itself or another hotkey already set, + # this causes issues. so here, it catches that, and will make no changes to the hotkey. + if __is_key_already_set(autosplit, hotkey_name): autosplit.after_setting_hotkey_signal.emit() return - autosplit.undo_split_hotkey = keyboard.hook_key( - key_name, - lambda error: _hotkey_action(error, key_name, autosplit.undo_split_signal.emit)) - if autosplit.SettingsWidget: - autosplit.SettingsWidget.undo_split_input.setText(key_name) - autosplit.settings_dict["undo_split_hotkey"] = key_name - autosplit.after_setting_hotkey_signal.emit() - - _unhook(autosplit.undo_split_hotkey) - thread = threading.Thread(target=callback) - thread.start() - - -def set_pause_hotkey(autosplit: AutoSplit, preselected_key: str = ""): - if autosplit.SettingsWidget: - autosplit.SettingsWidget.set_pause_hotkey_button.setText(PRESS_A_KEY_TEXT) - before_setting_hotkey(autosplit) - - def callback(): - key_name = preselected_key if preselected_key else __get_key_name(keyboard.read_event(True)) - - try: - if __is_key_already_set(autosplit, key_name) or (key_name != "+" and "+" in key_name): - autosplit.after_setting_hotkey_signal.emit() - return - except AttributeError: - autosplit.after_setting_hotkey_signal.emit() - return + # We need to inspect the event to know if it comes from numpad because of _canonial_names. + # See: https://github.com/boppreh/keyboard/issues/161#issuecomment-386825737 + # The best way to achieve this is make our own hotkey handling on top of hook + # See: https://github.com/boppreh/keyboard/issues/216#issuecomment-431999553 + action = autosplit.start_auto_splitter if hotkey == "split" else getattr(autosplit, f"{hotkey}_signal").emit + setattr( + autosplit, + f"{hotkey}_hotkey", + # keyboard.add_hotkey doesn't give the last keyboard event, so we can't __validate_keypad. + # This means "ctrl + num 5" and "ctrl + 5" will both be registered. + # For that reason, we still prefer keyboard.hook_key for single keys. + # keyboard module allows you to hit multiple keys for a hotkey. they are joined together by +. + keyboard.add_hotkey(hotkey_name, action) + if "+" in hotkey_name + else keyboard.hook_key( + hotkey_name, + lambda keyboard_event: _hotkey_action(keyboard_event, hotkey_name, action)) + ) - autosplit.pause_hotkey = keyboard.hook_key( - key_name, - lambda error: _hotkey_action(error, key_name, autosplit.pause_signal.emit)) if autosplit.SettingsWidget: - autosplit.SettingsWidget.pause_input.setText(key_name) - autosplit.settings_dict["pause_hotkey"] = key_name + getattr(autosplit.SettingsWidget, f"{hotkey}_input").setText(hotkey_name) + autosplit.settings_dict[f"{hotkey}_hotkey"] = hotkey_name autosplit.after_setting_hotkey_signal.emit() - _unhook(autosplit.pause_hotkey) + # Try to remove the previously set hotkey if there is one. + _unhook(getattr(autosplit, f"{hotkey}_hotkey")) thread = threading.Thread(target=callback) thread.start() diff --git a/src/menu_bar.py b/src/menu_bar.py index d90c1e8c..9bd98c5a 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -17,7 +17,7 @@ import settings_file as settings from capture_windows import Region from gen import about, design, resources_rc, settings as settings_ui, update_checker # noqa: F401 -from hotkeys import set_split_hotkey, set_reset_hotkey, set_skip_split_hotkey, set_undo_split_hotkey, set_pause_hotkey +from hotkeys import set_hotkey # AutoSplit Version number VERSION = "1.6.1" @@ -128,11 +128,11 @@ def set_value(key: str, value: Any): # endregion # region Binding # Hotkeys - self.set_split_hotkey_button.clicked.connect(lambda: set_split_hotkey(self.autosplit)) - self.set_reset_hotkey_button.clicked.connect(lambda: set_reset_hotkey(self.autosplit)) - self.set_skip_split_hotkey_button.clicked.connect(lambda: set_skip_split_hotkey(self.autosplit)) - self.set_undo_split_hotkey_button.clicked.connect(lambda: set_undo_split_hotkey(self.autosplit)) - self.set_pause_hotkey_button.clicked.connect(lambda: set_pause_hotkey(self.autosplit)) + self.set_split_hotkey_button.clicked.connect(lambda: set_hotkey(self.autosplit, "split")) + self.set_reset_hotkey_button.clicked.connect(lambda: set_hotkey(self.autosplit, "reset")) + self.set_skip_split_hotkey_button.clicked.connect(lambda: set_hotkey(self.autosplit, "skip_split")) + self.set_undo_split_hotkey_button.clicked.connect(lambda: set_hotkey(self.autosplit, "undo_split")) + self.set_pause_hotkey_button.clicked.connect(lambda: set_hotkey(self.autosplit, "pause")) # Capture Settings self.fps_limit_spinbox.valueChanged.connect(lambda: set_value( diff --git a/src/settings_file.py b/src/settings_file.py index cc6fec44..dc4338b9 100644 --- a/src/settings_file.py +++ b/src/settings_file.py @@ -15,7 +15,7 @@ import error_messages from capture_windows import Region from gen import design -from hotkeys import set_pause_hotkey, set_reset_hotkey, set_skip_split_hotkey, set_split_hotkey, set_undo_split_hotkey +from hotkeys import set_hotkey # Keyword "frozen" is for setting basedir while in onefile mode in pyinstaller FROZEN = hasattr(sys, "frozen") @@ -153,11 +153,11 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str autosplit.settings_dict["fps_limit"] = settings[4] keyboard.unhook_all() if not autosplit.is_auto_controlled: - set_split_hotkey(autosplit, settings[5]) - set_reset_hotkey(autosplit, settings[6]) - set_skip_split_hotkey(autosplit, settings[7]) - set_undo_split_hotkey(autosplit, settings[8]) - set_pause_hotkey(autosplit, settings[9]) + set_hotkey(autosplit, "split", settings[5]) + set_hotkey(autosplit, "reset", settings[6]) + set_hotkey(autosplit, "skip_split", settings[7]) + set_hotkey(autosplit, "undo_split", settings[8]) + set_hotkey(autosplit, "pause", settings[9]) autosplit.x_spinbox.setValue(settings[10]) autosplit.y_spinbox.setValue(settings[11]) autosplit.width_spinbox.setValue(settings[12]) From 33a49c6d14a32126161181ef8efb531df7c0e095 Mon Sep 17 00:00:00 2001 From: Avasam Date: Thu, 16 Dec 2021 14:45:03 -0500 Subject: [PATCH 005/137] Linted pyi files --- .flake8 | 14 +- .github/workflows/lint-and-build.yml | 2 +- PyInstaller/hooks/hook-cv2.py | 25 +- README.md | 4 +- pyproject.toml | 8 +- res/settings.ui | 2 +- scripts/lint.ps1 | 2 +- scripts/requirements.txt | 1 + src/AutoSplit.py | 2 +- src/compare.py | 2 +- typings/cv2-stubs/__init__.pyi | 815 +- typings/imagehash/__init__.pyi | 7 +- typings/keyboard/__init__.pyi | 494 +- typings/keyboard/_canonical_names.pyi | 11 + typings/keyboard/_generic.pyi | 38 + typings/keyboard/_keyboard_event.pyi | 10 +- typings/pyautogui/__init__.pyi | 621 +- typings/pythonwin-stubs/win32typing.pyi | 40183 ++++++++--------- typings/win32-stubs/win32gui.pyi | 1346 +- typings/win32con/__init__.pyi | 588 +- typings/win32helper/ntsecuritycon.pyi | 463 +- typings/win32helper/sspicon.pyi | 114 +- typings/win32helper/win32cryptcon.pyi | 256 +- typings/win32helper/win32inetcon.pyi | 130 +- typings/win32helper/win32netcon.pyi | 165 +- typings/win32helper/winioctlcon.pyi | 166 +- typings/win32typing/__init__.pyi | 51704 ---------------------- 27 files changed, 21774 insertions(+), 75399 deletions(-) create mode 100644 typings/keyboard/_canonical_names.pyi create mode 100644 typings/keyboard/_generic.pyi delete mode 100644 typings/win32typing/__init__.pyi diff --git a/.flake8 b/.flake8 index 2715e740..92ef77a0 100644 --- a/.flake8 +++ b/.flake8 @@ -8,8 +8,20 @@ exclude=src/gen/ ; Allow imports at the bottom of file ignore=W503,Y015,E402 per-file-ignores= + ; Uses "pass" for empty body + ; Default arguments + ; Doesn't work when using /** below for some reasons + ; win32typing.pyi: Y010,Y011, + ; win32gui.pyi: Y010,Y011, + ; ; Quotes - __init__.pyi:Q000 + ; undefined name 'Unknown' + ; allow ... on same line as def + ; Naming stuff + ; + ; Q002 quote docstring for cv2-stubs + typings/**: Q000,F821,E704,N8,E501,Y010,Y011,Q002 + ; PyQt methods ignore-names=closeEvent,paintEvent,keyPressEvent,mousePressEvent,mouseMoveEvent,mouseReleaseEvent ; McCabe max-complexity is also taken care of by Pylint and doesn't fail the build there diff --git a/.github/workflows/lint-and-build.yml b/.github/workflows/lint-and-build.yml index 37f7f367..1b13d5da 100644 --- a/.github/workflows/lint-and-build.yml +++ b/.github/workflows/lint-and-build.yml @@ -64,7 +64,7 @@ jobs: 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*') + run: pylint --reports=y --output-format=colorized $(git ls-files '**/*.py') Flake8: runs-on: windows-latest strategy: diff --git a/PyInstaller/hooks/hook-cv2.py b/PyInstaller/hooks/hook-cv2.py index 172c078c..7293494f 100644 --- a/PyInstaller/hooks/hook-cv2.py +++ b/PyInstaller/hooks/hook-cv2.py @@ -1,15 +1,16 @@ -# ------------------------------------------------------------------ -# Copyright (c) 2020 PyInstaller Development Team. -# -# This file is distributed under the terms of the GNU General Public -# License (version 2.0 or later). -# -# The full license is available in LICENSE.GPL.txt, distributed with -# this software. -# -# SPDX-License-Identifier: GPL-2.0-or-later -# ------------------------------------------------------------------ -# https://github.com/pyinstaller/pyinstaller-hooks-contrib/blob/master/src/_pyinstaller_hooks_contrib/hooks/stdhooks/hook-cv2.py +""" +Copyright (c) 2020 PyInstaller Development Team. + +This file is distributed under the terms of the GNU General Public +License (version 2.0 or later). + +The full license is available in LICENSE.GPL.txt, distributed with +this software. + +SPDX-License-Identifier: GPL-2.0-or-later + +https://github.com/pyinstaller/pyinstaller-hooks-contrib/blob/master/src/_pyinstaller_hooks_contrib/hooks/stdhooks/hook-cv2.py +""" from PyInstaller.utils.hooks import collect_dynamic_libs, collect_data_files diff --git a/README.md b/README.md index 4084e5e5..40c8fd97 100644 --- a/README.md +++ b/README.md @@ -67,10 +67,10 @@ This program can be used to automatically start, split, and reset your preferred ### Comparison Method -- There are three comparison methods to choose from: L2 Norm, Histograms, and pHash. +- There are three comparison methods to choose from: L2 Norm, Histograms, and Perceptual Hash (or pHash). - L2 Norm: This method should be fine to use for most cases. it finds the difference between each pixel, squares it, and sums it over the entire image and takes the square root. This is very fast but is a problem if your image is high frequency. Any translational movement or rotation can cause similarity to be very different. - Histograms: An explanation on Histograms comparison can be found [here](https://mpatacchiola.github.io/blog/2016/11/12/the-simplest-classifier-histogram-intersection.html). This is a great method to use if you are using several masked images. - - pHash: An explanation on pHash comparison can be found [here](http://www.hackerfactor.com/blog/index.php?/archives/432-Looks-Like-It.html). It is highly recommended to NOT use pHash if you use masked images. It is very inaccurate. + - Perceptual Hash: An explanation on pHash comparison can be found [here](http://www.hackerfactor.com/blog/index.php?/archives/432-Looks-Like-It.html). It is highly recommended to NOT use pHash if you use masked images. It is very inaccurate. ### Full Content Rendering diff --git a/pyproject.toml b/pyproject.toml index 3f71a85f..e73119bc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -23,7 +23,7 @@ reportImplicitStringConcatenation=true ignore = [ # Auto generated "src/gen/", - # We expect stub files to be incomplete or contain useless statements as they're external + # We expect stub files to be incomplete or contain useless statements "typings/", ] reportMissingTypeStubs = "information" @@ -42,7 +42,7 @@ reportUnknownMemberType = "none" # 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 * 10 + refactor + convention) / statement) * 10)" +evaluation = "10.0 - error - ((float((warning + convention) * 10 + refactor ) / statement) * 10)" [tool.pylint.MASTER] fail-under = 9.0 # https://pylint.pycqa.org/en/latest/technical_reference/extensions.html @@ -73,8 +73,8 @@ load-plugins = [ ignore-paths = [ # Auto generated "^src/gen/.*$", - # We expect stub files to be incomplete or contain useless statements as they're external - "^typings/.*$", + # We expect stub files to be incomplete or contain useless statements + "^.*\\.pyi$", ] # No need to mention the fixmes disable = ["fixme"] diff --git a/res/settings.ui b/res/settings.ui index a388d7d6..d3fb9199 100644 --- a/res/settings.ui +++ b/res/settings.ui @@ -192,7 +192,7 @@ - pHash + Perceptual Hash diff --git a/scripts/lint.ps1 b/scripts/lint.ps1 index b7c100a7..03b3d774 100644 --- a/scripts/lint.ps1 +++ b/scripts/lint.ps1 @@ -13,7 +13,7 @@ if ($LastExitCode -gt 0) { } Write-Host "`nRunning Pylint..." -pylint --score=n --output-format=colorized $(git ls-files '**/*.py*') +pylint --score=n --output-format=colorized $(git ls-files '**/*.py') $exitCodes += $LastExitCode if ($LastExitCode -gt 0) { Write-Host "`Pylint failed ($LastExitCode)" -ForegroundColor Red diff --git a/scripts/requirements.txt b/scripts/requirements.txt index 30eb0766..a9347425 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -25,6 +25,7 @@ requests # Linting and Types bandit flake8 +flake8-pyi flake8-quotes pylint pywin32-stubs diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 64f73d2b..dea88e58 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -398,7 +398,7 @@ def __take_screenshot(self): # save and open image cv2.imwrite(screenshot_path, capture) - os.startfile(screenshot_path) + os.startfile(screenshot_path) # nosec def __check_fps(self): self.fps_value_label.clear() diff --git a/src/compare.py b/src/compare.py index 9a5a9e1c..a5d0ca53 100644 --- a/src/compare.py +++ b/src/compare.py @@ -80,7 +80,7 @@ def compare_template(source: cv2.ndarray, capture: cv2.ndarray, mask: Optional[c def compare_phash(source: cv2.ndarray, capture: cv2.ndarray, mask: Optional[cv2.ndarray] = None): """ - Compares the pHash of the two given images and returns the similarity between the two. + Compares the Perceptual Hash of the two given images and returns the similarity between the two. @param source: Image of any given shape as a numpy array @param capture: Image of any given shape as a numpy array diff --git a/typings/cv2-stubs/__init__.pyi b/typings/cv2-stubs/__init__.pyi index 2d471883..7a9cd1cf 100644 --- a/typings/cv2-stubs/__init__.pyi +++ b/typings/cv2-stubs/__init__.pyi @@ -3,7 +3,6 @@ # Module: cv2.cv2, version: 4.4.0 # https://github.com/microsoft/python-type-stubs/pull/112 import typing -import builtins as _mod_builtins import cv2 as _mod_cv2 import numpy @@ -29,7 +28,15 @@ AKAZE_DESCRIPTOR_MLDB: int AKAZE_DESCRIPTOR_MLDB_UPRIGHT: int -def AKAZE_create(descriptor_type=..., descriptor_size=..., descriptor_channels=..., threshold=..., nOctaves=..., nOctaveLayers=..., diffusivity=...) -> typing.Any: +def AKAZE_create( + descriptor_type=..., + descriptor_size=..., + descriptor_channels=..., + threshold=..., + nOctaves=..., + nOctaveLayers=..., + diffusivity=... + ) -> typing.Any: 'AKAZE_create([, descriptor_type[, descriptor_size[, descriptor_channels[, threshold[, nOctaves[, nOctaveLayers[, diffusivity]]]]]]]) -> retval\n. @brief The AKAZE constructor\n. \n. @param descriptor_type Type of the extracted descriptor: DESCRIPTOR_KAZE,\n. DESCRIPTOR_KAZE_UPRIGHT, DESCRIPTOR_MLDB or DESCRIPTOR_MLDB_UPRIGHT.\n. @param descriptor_size Size of the descriptor in bits. 0 -\\> Full size\n. @param descriptor_channels Number of channels in the descriptor (1, 2, 3)\n. @param threshold Detector response threshold to accept point\n. @param nOctaves Maximum octave evolution of the image\n. @param nOctaveLayers Default number of sublevels per scale level\n. @param diffusivity Diffusivity type. DIFF_PM_G1, DIFF_PM_G2, DIFF_WEICKERT or\n. DIFF_CHARBONNIER' ... @@ -1009,7 +1016,15 @@ FORMATTER_FMT_PYTHON: int FarnebackOpticalFlow = _mod_cv2.FarnebackOpticalFlow -def FarnebackOpticalFlow_create(numLevels=..., pyrScale=..., fastPyramids=..., winSize=..., numIters=..., polyN=..., polySigma=..., flags: int = ...) -> typing.Any: +def FarnebackOpticalFlow_create( + numLevels=..., + pyrScale=..., + fastPyramids=..., + winSize=..., + numIters=..., + polyN=..., + polySigma=..., + flags: int = ...) -> typing.Any: 'FarnebackOpticalFlow_create([, numLevels[, pyrScale[, fastPyramids[, winSize[, numIters[, polyN[, polySigma[, flags]]]]]]]]) -> retval\n.' ... @@ -1087,7 +1102,13 @@ GEMM_3_T: int GFTTDetector = _mod_cv2.GFTTDetector -def GFTTDetector_create(maxCorners=..., qualityLevel=..., minDistance=..., blockSize=..., useHarrisDetector=..., k=...) -> typing.Any: +def GFTTDetector_create( + maxCorners=..., + qualityLevel=..., + minDistance=..., + blockSize=..., + useHarrisDetector=..., + k=...) -> typing.Any: 'GFTTDetector_create([, maxCorners[, qualityLevel[, minDistance[, blockSize[, useHarrisDetector[, k]]]]]]) -> retval\n. \n\n\n\nGFTTDetector_create(maxCorners, qualityLevel, minDistance, blockSize, gradiantSize[, useHarrisDetector[, k]]) -> retval\n.' ... @@ -1135,12 +1156,30 @@ HOUGH_PROBABILISTIC: int HOUGH_STANDARD: int -def HoughCircles(image: ndarray, method: int, dp, minDist, circles=..., param1=..., param2=..., minRadius=..., maxRadius=...) -> typing.Any: +def HoughCircles( + image: ndarray, + method: int, + dp, + minDist, + circles=..., + param1=..., + param2=..., + minRadius=..., + maxRadius=...) -> typing.Any: 'HoughCircles(image, method, dp, minDist[, circles[, param1[, param2[, minRadius[, maxRadius]]]]]) -> circles\n. @brief Finds circles in a grayscale image using the Hough transform.\n. \n. The function finds circles in a grayscale image using a modification of the Hough transform.\n. \n. Example: :\n. @include snippets/imgproc_HoughLinesCircles.cpp\n. \n. @note Usually the function detects the centers of circles well. However, it may fail to find correct\n. radii. You can assist to the function by specifying the radius range ( minRadius and maxRadius ) if\n. you know it. Or, in the case of #HOUGH_GRADIENT method you may set maxRadius to a negative number\n. to return centers only without radius search, and find the correct radius using an additional procedure.\n. \n. It also helps to smooth image a bit unless it\'s already soft. For example,\n. GaussianBlur() with 7x7 kernel and 1.5x1.5 sigma or similar blurring may help.\n. \n. @param image 8-bit, single-channel, grayscale input image.\n. @param circles Output vector of found circles. Each vector is encoded as 3 or 4 element\n. floating-point vector \\f$(x, y, radius)\\f$ or \\f$(x, y, radius, votes)\\f$ .\n. @param method Detection method, see #HoughModes. The available methods are #HOUGH_GRADIENT and #HOUGH_GRADIENT_ALT.\n. @param dp Inverse ratio of the accumulator resolution to the image resolution. For example, if\n. dp=1 , the accumulator has the same resolution as the input image. If dp=2 , the accumulator has\n. half as big width and height. For #HOUGH_GRADIENT_ALT the recommended value is dp=1.5,\n. unless some small very circles need to be detected.\n. @param minDist Minimum distance between the centers of the detected circles. If the parameter is\n. too small, multiple neighbor circles may be falsely detected in addition to a true one. If it is\n. too large, some circles may be missed.\n. @param param1 First method-specific parameter. In case of #HOUGH_GRADIENT and #HOUGH_GRADIENT_ALT,\n. it is the higher threshold of the two passed to the Canny edge detector (the lower one is twice smaller).\n. Note that #HOUGH_GRADIENT_ALT uses #Scharr algorithm to compute image derivatives, so the threshold value\n. shough normally be higher, such as 300 or normally exposed and contrasty images.\n. @param param2 Second method-specific parameter. In case of #HOUGH_GRADIENT, it is the\n. accumulator threshold for the circle centers at the detection stage. The smaller it is, the more\n. false circles may be detected. Circles, corresponding to the larger accumulator values, will be\n. returned first. In the case of #HOUGH_GRADIENT_ALT algorithm, this is the circle "perfectness" measure.\n. The closer it to 1, the better shaped circles algorithm selects. In most cases 0.9 should be fine.\n. If you want get better detection of small circles, you may decrease it to 0.85, 0.8 or even less.\n. But then also try to limit the search range [minRadius, maxRadius] to avoid many false circles.\n. @param minRadius Minimum circle radius.\n. @param maxRadius Maximum circle radius. If <= 0, uses the maximum image dimension. If < 0, #HOUGH_GRADIENT returns\n. centers without finding the radius. #HOUGH_GRADIENT_ALT always computes circle radiuses.\n. \n. @sa fitEllipse, minEnclosingCircle' ... -def HoughLines(image: ndarray, rho, theta, threshold, lines=..., srn=..., stn=..., min_theta=..., max_theta=...) -> typing.Any: +def HoughLines( + image: ndarray, + rho, + theta, + threshold, + lines=..., + srn=..., + stn=..., + min_theta=..., + max_theta=...) -> typing.Any: 'HoughLines(image, rho, theta, threshold[, lines[, srn[, stn[, min_theta[, max_theta]]]]]) -> lines\n. @brief Finds lines in a binary image using the standard Hough transform.\n. \n. The function implements the standard or standard multi-scale Hough transform algorithm for line\n. detection. See for a good explanation of Hough\n. transform.\n. \n. @param image 8-bit, single-channel binary source image. The image may be modified by the function.\n. @param lines Output vector of lines. Each line is represented by a 2 or 3 element vector\n. \\f$(\\rho, \\theta)\\f$ or \\f$(\\rho, \\theta, \\textrm{votes})\\f$ . \\f$\\rho\\f$ is the distance from the coordinate origin \\f$(0,0)\\f$ (top-left corner of\n. the image). \\f$\\theta\\f$ is the line rotation angle in radians (\n. \\f$0 \\sim \\textrm{vertical line}, \\pi/2 \\sim \\textrm{horizontal line}\\f$ ).\n. \\f$\\textrm{votes}\\f$ is the value of accumulator.\n. @param rho Distance resolution of the accumulator in pixels.\n. @param theta Angle resolution of the accumulator in radians.\n. @param threshold Accumulator threshold parameter. Only those lines are returned that get enough\n. votes ( \\f$>\\texttt{threshold}\\f$ ).\n. @param srn For the multi-scale Hough transform, it is a divisor for the distance resolution rho .\n. The coarse accumulator distance resolution is rho and the accurate accumulator resolution is\n. rho/srn . If both srn=0 and stn=0 , the classical Hough transform is used. Otherwise, both these\n. parameters should be positive.\n. @param stn For the multi-scale Hough transform, it is a divisor for the distance resolution theta.\n. @param min_theta For standard and multi-scale Hough transform, minimum angle to check for lines.\n. Must fall between 0 and max_theta.\n. @param max_theta For standard and multi-scale Hough transform, maximum angle to check for lines.\n. Must fall between min_theta and CV_PI.' ... @@ -1150,7 +1189,17 @@ def HoughLinesP(image: ndarray, rho, theta, threshold, lines=..., minLineLength= ... -def HoughLinesPointSet(_point, lines_max, threshold, min_rho, max_rho, rho_step, min_theta, max_theta, theta_step, _lines=...) -> typing.Any: +def HoughLinesPointSet( + _point, + lines_max, + threshold, + min_rho, + max_rho, + rho_step, + min_theta, + max_theta, + theta_step, + _lines=...) -> typing.Any: "HoughLinesPointSet(_point, lines_max, threshold, min_rho, max_rho, rho_step, min_theta, max_theta, theta_step[, _lines]) -> _lines\n. @brief Finds lines in a set of points using the standard Hough transform.\n. \n. The function finds lines in a set of points using a modification of the Hough transform.\n. @include snippets/imgproc_HoughLinesPointSet.cpp\n. @param _point Input vector of points. Each vector must be encoded as a Point vector \\f$(x,y)\\f$. Type must be CV_32FC2 or CV_32SC2.\n. @param _lines Output vector of found lines. Each vector is encoded as a vector \\f$(votes, rho, theta)\\f$.\n. The larger the value of 'votes', the higher the reliability of the Hough line.\n. @param lines_max Max count of hough lines.\n. @param threshold Accumulator threshold parameter. Only those lines are returned that get enough\n. votes ( \\f$>\\texttt{threshold}\\f$ )\n. @param min_rho Minimum Distance value of the accumulator in pixels.\n. @param max_rho Maximum Distance value of the accumulator in pixels.\n. @param rho_step Distance resolution of the accumulator in pixels.\n. @param min_theta Minimum angle value of the accumulator in radians.\n. @param max_theta Maximum angle value of the accumulator in radians.\n. @param theta_step Angle resolution of the accumulator in radians." ... @@ -1227,7 +1276,13 @@ KAZE_DIFF_PM_G2: int KAZE_DIFF_WEICKERT: int -def KAZE_create(extended=..., upright=..., threshold=..., nOctaves=..., nOctaveLayers=..., diffusivity=...) -> typing.Any: +def KAZE_create( + extended=..., + upright=..., + threshold=..., + nOctaves=..., + nOctaveLayers=..., + diffusivity=...) -> typing.Any: 'KAZE_create([, extended[, upright[, threshold[, nOctaves[, nOctaveLayers[, diffusivity]]]]]]) -> retval\n. @brief The KAZE constructor\n. \n. @param extended Set to enable extraction of extended (128-byte) descriptor.\n. @param upright Set to enable use of upright descriptors (non rotation-invariant).\n. @param threshold Detector response threshold to accept point\n. @param nOctaves Maximum octave evolution of the image\n. @param nOctaveLayers Default number of sublevels per scale level\n. @param diffusivity Diffusivity type. DIFF_PM_G1, DIFF_PM_G2, DIFF_WEICKERT or\n. DIFF_CHARBONNIER' ... @@ -1304,7 +1359,16 @@ MOTION_TRANSLATION: int MSER = _mod_cv2.MSER -def MSER_create(_delta=..., _min_area=..., _max_area=..., _max_variation=..., _min_diversity=..., _max_evolution=..., _area_threshold=..., _min_margin=..., _edge_blur_size=...) -> typing.Any: +def MSER_create( + _delta=..., + _min_area=..., + _max_area=..., + _max_variation=..., + _min_diversity=..., + _max_evolution=..., + _area_threshold=..., + _min_margin=..., + _edge_blur_size=...) -> typing.Any: 'MSER_create([, _delta[, _min_area[, _max_area[, _max_variation[, _min_diversity[, _max_evolution[, _area_threshold[, _min_margin[, _edge_blur_size]]]]]]]]]) -> retval\n. @brief Full constructor for %MSER detector\n. \n. @param _delta it compares \\f$(size_{i}-size_{i-delta})/size_{i-delta}\\f$\n. @param _min_area prune the area which smaller than minArea\n. @param _max_area prune the area which bigger than maxArea\n. @param _max_variation prune the area have similar size to its children\n. @param _min_diversity for color image, trace back to cut off mser with diversity less than min_diversity\n. @param _max_evolution for color image, the evolution steps\n. @param _area_threshold for color image, the area threshold to cause re-initialize\n. @param _min_margin for color image, ignore too small margin\n. @param _edge_blur_size for color image, the aperture size for edge blur' ... @@ -1344,7 +1408,16 @@ ORB_FAST_SCORE: int ORB_HARRIS_SCORE: int -def ORB_create(nfeatures=..., scaleFactor=..., nlevels=..., edgeThreshold=..., firstLevel=..., WTA_K=..., scoreType=..., patchSize=..., fastThreshold=...) -> typing.Any: +def ORB_create( + nfeatures=..., + scaleFactor=..., + nlevels=..., + edgeThreshold=..., + firstLevel=..., + WTA_K=..., + scoreType=..., + patchSize=..., + fastThreshold=...) -> typing.Any: 'ORB_create([, nfeatures[, scaleFactor[, nlevels[, edgeThreshold[, firstLevel[, WTA_K[, scoreType[, patchSize[, fastThreshold]]]]]]]]]) -> retval\n. @brief The ORB constructor\n. \n. @param nfeatures The maximum number of features to retain.\n. @param scaleFactor Pyramid decimation ratio, greater than 1. scaleFactor==2 means the classical\n. pyramid, where each next level has 4x less pixels than the previous, but such a big scale factor\n. will degrade feature matching scores dramatically. On the other hand, too close to 1 scale factor\n. will mean that to cover certain scale range you will need more pyramid levels and so the speed\n. will suffer.\n. @param nlevels The number of pyramid levels. The smallest level will have linear size equal to\n. input_image_linear_size/pow(scaleFactor, nlevels - firstLevel).\n. @param edgeThreshold This is size of the border where the features are not detected. It should\n. roughly match the patchSize parameter.\n. @param firstLevel The level of pyramid to put source image to. Previous layers are filled\n. with upscaled source image.\n. @param WTA_K The number of points that produce each element of the oriented BRIEF descriptor. The\n. default value 2 means the BRIEF where we take a random point pair and compare their brightnesses,\n. so we get 0/1 response. Other possible values are 3 and 4. For example, 3 means that we take 3\n. random points (of course, those point coordinates are random, but they are generated from the\n. pre-defined seed, so each element of BRIEF descriptor is computed deterministically from the pixel\n. rectangle), find point of maximum brightness and output index of the winner (0, 1 or 2). Such\n. output will occupy 2 bits, and therefore it will need a special variant of Hamming distance,\n. denoted as NORM_HAMMING2 (2 bits per bin). When WTA_K=4, we take 4 random points to compute each\n. bin (that will also occupy 2 bits with possible values 0, 1, 2 or 3).\n. @param scoreType The default HARRIS_SCORE means that Harris algorithm is used to rank features\n. (the score is written to KeyPoint::score and is used to retain best nfeatures features);\n. FAST_SCORE is alternative value of the parameter that produces slightly less stable keypoints,\n. but it is a little faster to compute.\n. @param patchSize size of the patch used by the oriented BRIEF descriptor. Of course, on smaller\n. pyramid layers the perceived image area covered by a feature will be larger.\n. @param fastThreshold the fast threshold' ... @@ -1537,7 +1610,16 @@ def SimpleBlobDetector_create(parameters=...) -> typing.Any: ... -def Sobel(src: ndarray, ddepth, dx, dy, dts: ndarray = ..., ksize=..., scale=..., delta=..., borderType=...) -> typing.Any: +def Sobel( + src: ndarray, + ddepth, + dx, + dy, + dts: ndarray = ..., + ksize=..., + scale=..., + delta=..., + borderType=...) -> typing.Any: 'Sobel(src, ddepth, dx, dy[, dst[, ksize[, scale[, delta[, borderType]]]]]) -> dst\n. @brief Calculates the first, second, third, or mixed image derivatives using an extended Sobel operator.\n. \n. In all cases except one, the \\f$\\texttt{ksize} \\times \\texttt{ksize}\\f$ separable kernel is used to\n. calculate the derivative. When \\f$\\texttt{ksize = 1}\\f$, the \\f$3 \\times 1\\f$ or \\f$1 \\times 3\\f$\n. kernel is used (that is, no Gaussian smoothing is done). `ksize = 1` can only be used for the first\n. or the second x- or y- derivatives.\n. \n. There is also the special value `ksize = #FILTER_SCHARR (-1)` that corresponds to the \\f$3\\times3\\f$ Scharr\n. filter that may give more accurate results than the \\f$3\\times3\\f$ Sobel. The Scharr aperture is\n. \n. \\f[\\vecthreethree{-3}{0}{3}{-10}{0}{10}{-3}{0}{3}\\f]\n. \n. for the x-derivative, or transposed for the y-derivative.\n. \n. The function calculates an image derivative by convolving the image with the appropriate kernel:\n. \n. \\f[\\texttt{dst} = \\frac{\\partial^{xorder+yorder} \\texttt{src}}{\\partial x^{xorder} \\partial y^{yorder}}\\f]\n. \n. The Sobel operators combine Gaussian smoothing and differentiation, so the result is more or less\n. resistant to the noise. Most often, the function is called with ( xorder = 1, yorder = 0, ksize = 3)\n. or ( xorder = 0, yorder = 1, ksize = 3) to calculate the first x- or y- image derivative. The first\n. case corresponds to a kernel of:\n. \n. \\f[\\vecthreethree{-1}{0}{1}{-2}{0}{2}{-1}{0}{1}\\f]\n. \n. The second case corresponds to a kernel of:\n. \n. \\f[\\vecthreethree{-1}{-2}{-1}{0}{0}{0}{1}{2}{1}\\f]\n. \n. @param src input image.\n. @param dst output image of the same size and the same number of channels as src .\n. @param ddepth output image depth, see @ref filter_depths "combinations"; in the case of\n. 8-bit input images it will result in truncated derivatives.\n. @param dx order of the derivative x.\n. @param dy order of the derivative y.\n. @param ksize size of the extended Sobel kernel; it must be 1, 3, 5, or 7.\n. @param scale optional scale factor for the computed derivative values; by default, no scaling is\n. applied (see #getDerivKernels for details).\n. @param delta optional delta value that is added to the results prior to storing them in dst.\n. @param borderType pixel extrapolation method, see #BorderTypes. #BORDER_WRAP is not supported.\n. @sa Scharr, Laplacian, sepFilter2D, filter2D, GaussianBlur, cartToPolar' ... @@ -1550,7 +1632,12 @@ SparseOpticalFlow = _mod_cv2.SparseOpticalFlow SparsePyrLKOpticalFlow = _mod_cv2.SparsePyrLKOpticalFlow -def SparsePyrLKOpticalFlow_create(winSize=..., maxLevel=..., crit=..., flags: int = ..., minEigThreshold=...) -> typing.Any: +def SparsePyrLKOpticalFlow_create( + winSize=..., + maxLevel=..., + crit=..., + flags: int = ..., + minEigThreshold=...) -> typing.Any: 'SparsePyrLKOpticalFlow_create([, winSize[, maxLevel[, crit[, flags[, minEigThreshold]]]]]) -> retval\n.' ... @@ -1575,7 +1662,18 @@ StereoSGBM_MODE_SGBM: int StereoSGBM_MODE_SGBM_3WAY: int -def StereoSGBM_create(minDisparity=..., numDisparities=..., blockSize=..., P1=..., P2=..., disp12MaxDiff=..., preFilterCap=..., uniquenessRatio=..., speckleWindowSize=..., speckleRange=..., mode=...) -> typing.Any: +def StereoSGBM_create( + minDisparity=..., + numDisparities=..., + blockSize=..., + P1=..., + P2=..., + disp12MaxDiff=..., + preFilterCap=..., + uniquenessRatio=..., + speckleWindowSize=..., + speckleRange=..., + mode=...) -> typing.Any: 'StereoSGBM_create([, minDisparity[, numDisparities[, blockSize[, P1[, P2[, disp12MaxDiff[, preFilterCap[, uniquenessRatio[, speckleWindowSize[, speckleRange[, mode]]]]]]]]]]]) -> retval\n. @brief Creates StereoSGBM object\n. \n. @param minDisparity Minimum possible disparity value. Normally, it is zero but sometimes\n. rectification algorithms can shift images, so this parameter needs to be adjusted accordingly.\n. @param numDisparities Maximum disparity minus minimum disparity. The value is always greater than\n. zero. In the current implementation, this parameter must be divisible by 16.\n. @param blockSize Matched block size. It must be an odd number \\>=1 . Normally, it should be\n. somewhere in the 3..11 range.\n. @param P1 The first parameter controlling the disparity smoothness. See below.\n. @param P2 The second parameter controlling the disparity smoothness. The larger the values are,\n. the smoother the disparity is. P1 is the penalty on the disparity change by plus or minus 1\n. between neighbor pixels. P2 is the penalty on the disparity change by more than 1 between neighbor\n. pixels. The algorithm requires P2 \\> P1 . See stereo_match.cpp sample where some reasonably good\n. P1 and P2 values are shown (like 8\\*number_of_image_channels\\*blockSize\\*blockSize and\n. 32\\*number_of_image_channels\\*blockSize\\*blockSize , respectively).\n. @param disp12MaxDiff Maximum allowed difference (in integer pixel units) in the left-right\n. disparity check. Set it to a non-positive value to disable the check.\n. @param preFilterCap Truncation value for the prefiltered image pixels. The algorithm first\n. computes x-derivative at each pixel and clips its value by [-preFilterCap, preFilterCap] interval.\n. The result values are passed to the Birchfield-Tomasi pixel cost function.\n. @param uniquenessRatio Margin in percentage by which the best (minimum) computed cost function\n. value should "win" the second best value to consider the found match correct. Normally, a value\n. within the 5-15 range is good enough.\n. @param speckleWindowSize Maximum size of smooth disparity regions to consider their noise speckles\n. and invalidate. Set it to 0 to disable speckle filtering. Otherwise, set it somewhere in the\n. 50-200 range.\n. @param speckleRange Maximum disparity variation within each connected component. If you do speckle\n. filtering, set the parameter to a positive value, it will be implicitly multiplied by 16.\n. Normally, 1 or 2 is good enough.\n. @param mode Set it to StereoSGBM::MODE_HH to run the full-scale two-pass dynamic programming\n. algorithm. It will consume O(W\\*H\\*numDisparities) bytes, which is large for 640x480 stereo and\n. huge for HD-size pictures. By default, it is set to false .\n. \n. The first constructor initializes StereoSGBM with all the default parameters. So, you only have to\n. set StereoSGBM::numDisparities at minimum. The second constructor enables you to set each parameter\n. to a custom value.' ... @@ -1817,7 +1915,14 @@ def accumulateWeighted(src: ndarray, dts: ndarray, alpha, mask: ndarray = ...) - ... -def adaptiveThreshold(src: ndarray, maxValue, adaptiveMethod, thresholdType, blockSize, C, dts: ndarray = ...) -> typing.Any: +def adaptiveThreshold( + src: ndarray, + maxValue, + adaptiveMethod, + thresholdType, + blockSize, + C, + dts: ndarray = ...) -> typing.Any: 'adaptiveThreshold(src, maxValue, adaptiveMethod, thresholdType, blockSize, C[, dst]) -> dst\n. @brief Applies an adaptive threshold to an array.\n. \n. The function transforms a grayscale image to a binary image according to the formulae:\n. - **THRESH_BINARY**\n. \\f[dst(x,y) = \\fork{\\texttt{maxValue}}{if \\(src(x,y) > T(x,y)\\)}{0}{otherwise}\\f]\n. - **THRESH_BINARY_INV**\n. \\f[dst(x,y) = \\fork{0}{if \\(src(x,y) > T(x,y)\\)}{\\texttt{maxValue}}{otherwise}\\f]\n. where \\f$T(x,y)\\f$ is a threshold calculated individually for each pixel (see adaptiveMethod parameter).\n. \n. The function can process the image in-place.\n. \n. @param src Source 8-bit single-channel image.\n. @param dst Destination image of the same size and the same type as src.\n. @param maxValue Non-zero value assigned to the pixels for which the condition is satisfied\n. @param adaptiveMethod Adaptive thresholding algorithm to use, see #AdaptiveThresholdTypes.\n. The #BORDER_REPLICATE | #BORDER_ISOLATED is used to process boundaries.\n. @param thresholdType Thresholding type that must be either #THRESH_BINARY or #THRESH_BINARY_INV,\n. see #ThresholdTypes.\n. @param blockSize Size of a pixel neighborhood that is used to calculate a threshold value for the\n. pixel: 3, 5, 7, and so on.\n. @param C Constant subtracted from the mean or weighted mean (see the details below). Normally, it\n. is positive but may be zero or negative as well.\n. \n. @sa threshold, blur, GaussianBlur' ... @@ -1827,7 +1932,16 @@ def add(src1: ndarray, src2: ndarray, dts: ndarray = ..., mask: ndarray = ..., d ... -def addText(img: ndarray, text, org, nameFont, pointSize=..., color=..., weight=..., style=..., spacing=...) -> typing.Any: +def addText( + img: ndarray, + text, + org, + nameFont, + pointSize=..., + color=..., + weight=..., + style=..., + spacing=...) -> typing.Any: 'addText(img, text, org, nameFont[, pointSize[, color[, weight[, style[, spacing]]]]]) -> None\n. @brief Draws a text on the image.\n. \n. @param img 8-bit 3-channel image where the text should be drawn.\n. @param text Text to write on an image.\n. @param org Point(x,y) where the text should start on an image.\n. @param nameFont Name of the font. The name should match the name of a system font (such as\n. *Times*). If the font is not found, a default one is used.\n. @param pointSize Size of the font. If not specified, equal zero or negative, the point size of the\n. font is set to a system-dependent default value. Generally, this is 12 points.\n. @param color Color of the font in BGRA where A = 255 is fully transparent.\n. @param weight Font weight. Available operation flags are : cv::QtFontWeights You can also specify a positive integer for better control.\n. @param style Font style. Available operation flags are : cv::QtFontStyles\n. @param spacing Spacing between characters. It can be negative or positive.' ... @@ -1857,7 +1971,17 @@ def arrowedLine(img: ndarray, pt1, pt2, color, thickness=..., line_type=..., shi ... -def batchDistance(src1: ndarray, src2: ndarray, dtype, dist=..., nidx=..., normType: int = ..., K=..., mask: ndarray = ..., update=..., crosscheck=...) -> typing.Any: +def batchDistance( + src1: ndarray, + src2: ndarray, + dtype, + dist=..., + nidx=..., + normType: int = ..., + K=..., + mask: ndarray = ..., + update=..., + crosscheck=...) -> typing.Any: 'batchDistance(src1, src2, dtype[, dist[, nidx[, normType[, K[, mask[, update[, crosscheck]]]]]]]) -> dist, nidx\n. @brief naive nearest neighbor finder\n. \n. see http://en.wikipedia.org/wiki/Nearest_neighbor_search\n. @todo document' ... @@ -1912,12 +2036,26 @@ def boxPoints(box, points=...) -> typing.Any: ... -def buildOpticalFlowPyramid(img: ndarray, winSize, maxLevel, pyramid=..., withDerivatives=..., pyrBorder=..., derivBorder=..., tryReuseInputImage=...) -> typing.Any: +def buildOpticalFlowPyramid( + img: ndarray, + winSize, + maxLevel, + pyramid=..., + withDerivatives=..., + pyrBorder=..., + derivBorder=..., + tryReuseInputImage=...) -> typing.Any: 'buildOpticalFlowPyramid(img, winSize, maxLevel[, pyramid[, withDerivatives[, pyrBorder[, derivBorder[, tryReuseInputImage]]]]]) -> retval, pyramid\n. @brief Constructs the image pyramid which can be passed to calcOpticalFlowPyrLK.\n. \n. @param img 8-bit input image.\n. @param pyramid output pyramid.\n. @param winSize window size of optical flow algorithm. Must be not less than winSize argument of\n. calcOpticalFlowPyrLK. It is needed to calculate required padding for pyramid levels.\n. @param maxLevel 0-based maximal pyramid level number.\n. @param withDerivatives set to precompute gradients for the every pyramid level. If pyramid is\n. constructed without the gradients then calcOpticalFlowPyrLK will calculate them internally.\n. @param pyrBorder the border mode for pyramid layers.\n. @param derivBorder the border mode for gradients.\n. @param tryReuseInputImage put ROI of input image into the pyramid if possible. You can pass false\n. to force data copying.\n. @return number of levels in constructed pyramid. Can be less than maxLevel.' ... -def calcBackProject(images: typing.List[ndarray], channels: typing.List[int], hist, ranges: typing.List[int], scale, dts: ndarray = ...) -> typing.Any: +def calcBackProject( + images: typing.List[ndarray], + channels: typing.List[int], + hist, + ranges: typing.List[int], + scale, + dts: ndarray = ...) -> typing.Any: 'calcBackProject(images, channels, hist, ranges, scale[, dst]) -> dst\n. @overload' ... @@ -1927,42 +2065,124 @@ def calcCovarMatrix(samples, mean, flags: int, covar=..., ctype=...) -> typing.A ... -def calcHist(images: typing.List[ndarray], channels: typing.List[int], mask: typing.Optional[ndarray], histSize: typing.List[int], ranges: typing.List[int], hist=..., accumulate=...) -> ndarray: +def calcHist( + images: typing.List[ndarray], + channels: typing.List[int], + mask: typing.Optional[ndarray], + histSize: typing.List[int], + ranges: typing.List[int], + hist=..., + accumulate=...) -> ndarray: 'calcHist(images, channels, mask, histSize, ranges[, hist[, accumulate]]) -> hist\n. @overload' ... -def calcOpticalFlowFarneback(prev, next, flow, pyr_scale, levels, winsize, iterations, poly_n, poly_sigma, flags: int) -> typing.Any: +def calcOpticalFlowFarneback( + prev, + next, + flow, + pyr_scale, + levels, + winsize, + iterations, + poly_n, + poly_sigma, + flags: int) -> typing.Any: "calcOpticalFlowFarneback(prev, next, flow, pyr_scale, levels, winsize, iterations, poly_n, poly_sigma, flags) -> flow\n. @brief Computes a dense optical flow using the Gunnar Farneback's algorithm.\n. \n. @param prev first 8-bit single-channel input image.\n. @param next second input image of the same size and the same type as prev.\n. @param flow computed flow image that has the same size as prev and type CV_32FC2.\n. @param pyr_scale parameter, specifying the image scale (\\<1) to build pyramids for each image;\n. pyr_scale=0.5 means a classical pyramid, where each next layer is twice smaller than the previous\n. one.\n. @param levels number of pyramid layers including the initial image; levels=1 means that no extra\n. layers are created and only the original images are used.\n. @param winsize averaging window size; larger values increase the algorithm robustness to image\n. noise and give more chances for fast motion detection, but yield more blurred motion field.\n. @param iterations number of iterations the algorithm does at each pyramid level.\n. @param poly_n size of the pixel neighborhood used to find polynomial expansion in each pixel;\n. larger values mean that the image will be approximated with smoother surfaces, yielding more\n. robust algorithm and more blurred motion field, typically poly_n =5 or 7.\n. @param poly_sigma standard deviation of the Gaussian that is used to smooth derivatives used as a\n. basis for the polynomial expansion; for poly_n=5, you can set poly_sigma=1.1, for poly_n=7, a\n. good value would be poly_sigma=1.5.\n. @param flags operation flags that can be a combination of the following:\n. - **OPTFLOW_USE_INITIAL_FLOW** uses the input flow as an initial flow approximation.\n. - **OPTFLOW_FARNEBACK_GAUSSIAN** uses the Gaussian \\f$\\texttt{winsize}\\times\\texttt{winsize}\\f$\n. filter instead of a box filter of the same size for optical flow estimation; usually, this\n. option gives z more accurate flow than with a box filter, at the cost of lower speed;\n. normally, winsize for a Gaussian window should be set to a larger value to achieve the same\n. level of robustness.\n. \n. The function finds an optical flow for each prev pixel using the @cite Farneback2003 algorithm so that\n. \n. \\f[\\texttt{prev} (y,x) \\sim \\texttt{next} ( y + \\texttt{flow} (y,x)[1], x + \\texttt{flow} (y,x)[0])\\f]\n. \n. @note\n. \n. - An example using the optical flow algorithm described by Gunnar Farneback can be found at\n. opencv_source_code/samples/cpp/fback.cpp\n. - (Python) An example using the optical flow algorithm described by Gunnar Farneback can be\n. found at opencv_source_code/samples/python/opt_flow.py" ... -def calcOpticalFlowPyrLK(prevImg, nextImg, prevPts, nextPts, status=..., err=..., winSize=..., maxLevel=..., criteria=..., flags: int = ..., minEigThreshold=...) -> typing.Any: +def calcOpticalFlowPyrLK( + prevImg, + nextImg, + prevPts, + nextPts, + status=..., + err=..., + winSize=..., + maxLevel=..., + criteria=..., + flags: int = ..., + minEigThreshold=...) -> typing.Any: "calcOpticalFlowPyrLK(prevImg, nextImg, prevPts, nextPts[, status[, err[, winSize[, maxLevel[, criteria[, flags[, minEigThreshold]]]]]]]) -> nextPts, status, err\n. @brief Calculates an optical flow for a sparse feature set using the iterative Lucas-Kanade method with\n. pyramids.\n. \n. @param prevImg first 8-bit input image or pyramid constructed by buildOpticalFlowPyramid.\n. @param nextImg second input image or pyramid of the same size and the same type as prevImg.\n. @param prevPts vector of 2D points for which the flow needs to be found; point coordinates must be\n. single-precision floating-point numbers.\n. @param nextPts output vector of 2D points (with single-precision floating-point coordinates)\n. containing the calculated new positions of input features in the second image; when\n. OPTFLOW_USE_INITIAL_FLOW flag is passed, the vector must have the same size as in the input.\n. @param status output status vector (of unsigned chars); each element of the vector is set to 1 if\n. the flow for the corresponding features has been found, otherwise, it is set to 0.\n. @param err output vector of errors; each element of the vector is set to an error for the\n. corresponding feature, type of the error measure can be set in flags parameter; if the flow wasn't\n. found then the error is not defined (use the status parameter to find such cases).\n. @param winSize size of the search window at each pyramid level.\n. @param maxLevel 0-based maximal pyramid level number; if set to 0, pyramids are not used (single\n. level), if set to 1, two levels are used, and so on; if pyramids are passed to input then\n. algorithm will use as many levels as pyramids have but no more than maxLevel.\n. @param criteria parameter, specifying the termination criteria of the iterative search algorithm\n. (after the specified maximum number of iterations criteria.maxCount or when the search window\n. moves by less than criteria.epsilon.\n. @param flags operation flags:\n. - **OPTFLOW_USE_INITIAL_FLOW** uses initial estimations, stored in nextPts; if the flag is\n. not set, then prevPts is copied to nextPts and is considered the initial estimate.\n. - **OPTFLOW_LK_GET_MIN_EIGENVALS** use minimum eigen values as an error measure (see\n. minEigThreshold description); if the flag is not set, then L1 distance between patches\n. around the original and a moved point, divided by number of pixels in a window, is used as a\n. error measure.\n. @param minEigThreshold the algorithm calculates the minimum eigen value of a 2x2 normal matrix of\n. optical flow equations (this matrix is called a spatial gradient matrix in @cite Bouguet00), divided\n. by number of pixels in a window; if this value is less than minEigThreshold, then a corresponding\n. feature is filtered out and its flow is not processed, so it allows to remove bad points and get a\n. performance boost.\n. \n. The function implements a sparse iterative version of the Lucas-Kanade optical flow in pyramids. See\n. @cite Bouguet00 . The function is parallelized with the TBB library.\n. \n. @note\n. \n. - An example using the Lucas-Kanade optical flow algorithm can be found at\n. opencv_source_code/samples/cpp/lkdemo.cpp\n. - (Python) An example using the Lucas-Kanade optical flow algorithm can be found at\n. opencv_source_code/samples/python/lk_track.py\n. - (Python) An example using the Lucas-Kanade tracker for homography matching can be found at\n. opencv_source_code/samples/python/lk_homography.py" ... -def calibrateCamera(objectPoints, imagePoints, imageSize, cameraMatrix, distCoeffs, rvecs=..., tvecs=..., flags: int = ..., criteria=...) -> typing.Any: +def calibrateCamera( + objectPoints, + imagePoints, + imageSize, + cameraMatrix, + distCoeffs, + rvecs=..., + tvecs=..., + flags: int = ..., + criteria=...) -> typing.Any: 'calibrateCamera(objectPoints, imagePoints, imageSize, cameraMatrix, distCoeffs[, rvecs[, tvecs[, flags[, criteria]]]]) -> retval, cameraMatrix, distCoeffs, rvecs, tvecs\n. @overload' ... -def calibrateCameraExtended(objectPoints, imagePoints, imageSize, cameraMatrix, distCoeffs, rvecs=..., tvecs=..., stdDeviationsIntrinsics=..., stdDeviationsExtrinsics=..., perViewErrors=..., flags: int = ..., criteria=...) -> typing.Any: +def calibrateCameraExtended( + objectPoints, + imagePoints, + imageSize, + cameraMatrix, + distCoeffs, + rvecs=..., + tvecs=..., + stdDeviationsIntrinsics=..., + stdDeviationsExtrinsics=..., + perViewErrors=..., + flags: int = ..., + criteria=...) -> typing.Any: "calibrateCameraExtended(objectPoints, imagePoints, imageSize, cameraMatrix, distCoeffs[, rvecs[, tvecs[, stdDeviationsIntrinsics[, stdDeviationsExtrinsics[, perViewErrors[, flags[, criteria]]]]]]]) -> retval, cameraMatrix, distCoeffs, rvecs, tvecs, stdDeviationsIntrinsics, stdDeviationsExtrinsics, perViewErrors\n. @brief Finds the camera intrinsic and extrinsic parameters from several views of a calibration\n. pattern.\n. \n. @param objectPoints In the new interface it is a vector of vectors of calibration pattern points in\n. the calibration pattern coordinate space (e.g. std::vector>). The outer\n. vector contains as many elements as the number of pattern views. If the same calibration pattern\n. is shown in each view and it is fully visible, all the vectors will be the same. Although, it is\n. possible to use partially occluded patterns or even different patterns in different views. Then,\n. the vectors will be different. Although the points are 3D, they all lie in the calibration pattern's\n. XY coordinate plane (thus 0 in the Z-coordinate), if the used calibration pattern is a planar rig.\n. In the old interface all the vectors of object points from different views are concatenated\n. together.\n. @param imagePoints In the new interface it is a vector of vectors of the projections of calibration\n. pattern points (e.g. std::vector>). imagePoints.size() and\n. objectPoints.size(), and imagePoints[i].size() and objectPoints[i].size() for each i, must be equal,\n. respectively. In the old interface all the vectors of object points from different views are\n. concatenated together.\n. @param imageSize Size of the image used only to initialize the intrinsic camera matrix.\n. @param cameraMatrix Input/output 3x3 floating-point camera matrix\n. \\f$A = \\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\\f$ . If CV\\_CALIB\\_USE\\_INTRINSIC\\_GUESS\n. and/or CALIB_FIX_ASPECT_RATIO are specified, some or all of fx, fy, cx, cy must be\n. initialized before calling the function.\n. @param distCoeffs Input/output vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$ of\n. 4, 5, 8, 12 or 14 elements.\n. @param rvecs Output vector of rotation vectors (@ref Rodrigues ) estimated for each pattern view\n. (e.g. std::vector>). That is, each i-th rotation vector together with the corresponding\n. i-th translation vector (see the next output parameter description) brings the calibration pattern\n. from the object coordinate space (in which object points are specified) to the camera coordinate\n. space. In more technical terms, the tuple of the i-th rotation and translation vector performs\n. a change of basis from object coordinate space to camera coordinate space. Due to its duality, this\n. tuple is equivalent to the position of the calibration pattern with respect to the camera coordinate\n. space.\n. @param tvecs Output vector of translation vectors estimated for each pattern view, see parameter\n. describtion above.\n. @param stdDeviationsIntrinsics Output vector of standard deviations estimated for intrinsic\n. parameters. Order of deviations values:\n. \\f$(f_x, f_y, c_x, c_y, k_1, k_2, p_1, p_2, k_3, k_4, k_5, k_6 , s_1, s_2, s_3,\n. s_4, \\tau_x, \\tau_y)\\f$ If one of parameters is not estimated, it's deviation is equals to zero.\n. @param stdDeviationsExtrinsics Output vector of standard deviations estimated for extrinsic\n. parameters. Order of deviations values: \\f$(R_0, T_0, \\dotsc , R_{M - 1}, T_{M - 1})\\f$ where M is\n. the number of pattern views. \\f$R_i, T_i\\f$ are concatenated 1x3 vectors.\n. @param perViewErrors Output vector of the RMS re-projection error estimated for each pattern view.\n. @param flags Different flags that may be zero or a combination of the following values:\n. - **CALIB_USE_INTRINSIC_GUESS** cameraMatrix contains valid initial values of\n. fx, fy, cx, cy that are optimized further. Otherwise, (cx, cy) is initially set to the image\n. center ( imageSize is used), and focal distances are computed in a least-squares fashion.\n. Note, that if intrinsic parameters are known, there is no need to use this function just to\n. estimate extrinsic parameters. Use solvePnP instead.\n. - **CALIB_FIX_PRINCIPAL_POINT** The principal point is not changed during the global\n. optimization. It stays at the center or at a different location specified when\n. CALIB_USE_INTRINSIC_GUESS is set too.\n. - **CALIB_FIX_ASPECT_RATIO** The functions consider only fy as a free parameter. The\n. ratio fx/fy stays the same as in the input cameraMatrix . When\n. CALIB_USE_INTRINSIC_GUESS is not set, the actual input values of fx and fy are\n. ignored, only their ratio is computed and used further.\n. - **CALIB_ZERO_TANGENT_DIST** Tangential distortion coefficients \\f$(p_1, p_2)\\f$ are set\n. to zeros and stay zero.\n. - **CALIB_FIX_K1,...,CALIB_FIX_K6** The corresponding radial distortion\n. coefficient is not changed during the optimization. If CALIB_USE_INTRINSIC_GUESS is\n. set, the coefficient from the supplied distCoeffs matrix is used. Otherwise, it is set to 0.\n. - **CALIB_RATIONAL_MODEL** Coefficients k4, k5, and k6 are enabled. To provide the\n. backward compatibility, this extra flag should be explicitly specified to make the\n. calibration function use the rational model and return 8 coefficients. If the flag is not\n. set, the function computes and returns only 5 distortion coefficients.\n. - **CALIB_THIN_PRISM_MODEL** Coefficients s1, s2, s3 and s4 are enabled. To provide the\n. backward compatibility, this extra flag should be explicitly specified to make the\n. calibration function use the thin prism model and return 12 coefficients. If the flag is not\n. set, the function computes and returns only 5 distortion coefficients.\n. - **CALIB_FIX_S1_S2_S3_S4** The thin prism distortion coefficients are not changed during\n. the optimization. If CALIB_USE_INTRINSIC_GUESS is set, the coefficient from the\n. supplied distCoeffs matrix is used. Otherwise, it is set to 0.\n. - **CALIB_TILTED_MODEL** Coefficients tauX and tauY are enabled. To provide the\n. backward compatibility, this extra flag should be explicitly specified to make the\n. calibration function use the tilted sensor model and return 14 coefficients. If the flag is not\n. set, the function computes and returns only 5 distortion coefficients.\n. - **CALIB_FIX_TAUX_TAUY** The coefficients of the tilted sensor model are not changed during\n. the optimization. If CALIB_USE_INTRINSIC_GUESS is set, the coefficient from the\n. supplied distCoeffs matrix is used. Otherwise, it is set to 0.\n. @param criteria Termination criteria for the iterative optimization algorithm.\n. \n. @return the overall RMS re-projection error.\n. \n. The function estimates the intrinsic camera parameters and extrinsic parameters for each of the\n. views. The algorithm is based on @cite Zhang2000 and @cite BouguetMCT . The coordinates of 3D object\n. points and their corresponding 2D projections in each view must be specified. That may be achieved\n. by using an object with known geometry and easily detectable feature points. Such an object is\n. called a calibration rig or calibration pattern, and OpenCV has built-in support for a chessboard as\n. a calibration rig (see @ref findChessboardCorners). Currently, initialization of intrinsic\n. parameters (when CALIB_USE_INTRINSIC_GUESS is not set) is only implemented for planar calibration\n. patterns (where Z-coordinates of the object points must be all zeros). 3D calibration rigs can also\n. be used as long as initial cameraMatrix is provided.\n. \n. The algorithm performs the following steps:\n. \n. - Compute the initial intrinsic parameters (the option only available for planar calibration\n. patterns) or read them from the input parameters. The distortion coefficients are all set to\n. zeros initially unless some of CALIB_FIX_K? are specified.\n. \n. - Estimate the initial camera pose as if the intrinsic parameters have been already known. This is\n. done using solvePnP .\n. \n. - Run the global Levenberg-Marquardt optimization algorithm to minimize the reprojection error,\n. that is, the total sum of squared distances between the observed feature points imagePoints and\n. the projected (using the current estimates for camera parameters and the poses) object points\n. objectPoints. See projectPoints for details.\n. \n. @note\n. If you use a non-square (i.e. non-N-by-N) grid and @ref findChessboardCorners for calibration,\n. and @ref calibrateCamera returns bad values (zero distortion coefficients, \\f$c_x\\f$ and\n. \\f$c_y\\f$ very far from the image center, and/or large differences between \\f$f_x\\f$ and\n. \\f$f_y\\f$ (ratios of 10:1 or more)), then you are probably using patternSize=cvSize(rows,cols)\n. instead of using patternSize=cvSize(cols,rows) in @ref findChessboardCorners.\n. \n. @sa\n. calibrateCameraRO, findChessboardCorners, solvePnP, initCameraMatrix2D, stereoCalibrate,\n. undistort" ... -def calibrateCameraRO(objectPoints, imagePoints, imageSize, iFixedPoint, cameraMatrix, distCoeffs, rvecs=..., tvecs=..., newObjPoints=..., flags: int = ..., criteria=...) -> typing.Any: +def calibrateCameraRO( + objectPoints, + imagePoints, + imageSize, + iFixedPoint, + cameraMatrix, + distCoeffs, + rvecs=..., + tvecs=..., + newObjPoints=..., + flags: int = ..., + criteria=...) -> typing.Any: 'calibrateCameraRO(objectPoints, imagePoints, imageSize, iFixedPoint, cameraMatrix, distCoeffs[, rvecs[, tvecs[, newObjPoints[, flags[, criteria]]]]]) -> retval, cameraMatrix, distCoeffs, rvecs, tvecs, newObjPoints\n. @overload' ... -def calibrateCameraROExtended(objectPoints, imagePoints, imageSize, iFixedPoint, cameraMatrix, distCoeffs, rvecs=..., tvecs=..., newObjPoints=..., stdDeviationsIntrinsics=..., stdDeviationsExtrinsics=..., stdDeviationsObjPoints=..., perViewErrors=..., flags: int = ..., criteria=...) -> typing.Any: +def calibrateCameraROExtended( + objectPoints, + imagePoints, + imageSize, + iFixedPoint, + cameraMatrix, + distCoeffs, + rvecs=..., + tvecs=..., + newObjPoints=..., + stdDeviationsIntrinsics=..., + stdDeviationsExtrinsics=..., + stdDeviationsObjPoints=..., + perViewErrors=..., + flags: int = ..., + criteria=...) -> typing.Any: 'calibrateCameraROExtended(objectPoints, imagePoints, imageSize, iFixedPoint, cameraMatrix, distCoeffs[, rvecs[, tvecs[, newObjPoints[, stdDeviationsIntrinsics[, stdDeviationsExtrinsics[, stdDeviationsObjPoints[, perViewErrors[, flags[, criteria]]]]]]]]]) -> retval, cameraMatrix, distCoeffs, rvecs, tvecs, newObjPoints, stdDeviationsIntrinsics, stdDeviationsExtrinsics, stdDeviationsObjPoints, perViewErrors\n. @brief Finds the camera intrinsic and extrinsic parameters from several views of a calibration pattern.\n. \n. This function is an extension of calibrateCamera() with the method of releasing object which was\n. proposed in @cite strobl2011iccv. In many common cases with inaccurate, unmeasured, roughly planar\n. targets (calibration plates), this method can dramatically improve the precision of the estimated\n. camera parameters. Both the object-releasing method and standard method are supported by this\n. function. Use the parameter **iFixedPoint** for method selection. In the internal implementation,\n. calibrateCamera() is a wrapper for this function.\n. \n. @param objectPoints Vector of vectors of calibration pattern points in the calibration pattern\n. coordinate space. See calibrateCamera() for details. If the method of releasing object to be used,\n. the identical calibration board must be used in each view and it must be fully visible, and all\n. objectPoints[i] must be the same and all points should be roughly close to a plane. **The calibration\n. target has to be rigid, or at least static if the camera (rather than the calibration target) is\n. shifted for grabbing images.**\n. @param imagePoints Vector of vectors of the projections of calibration pattern points. See\n. calibrateCamera() for details.\n. @param imageSize Size of the image used only to initialize the intrinsic camera matrix.\n. @param iFixedPoint The index of the 3D object point in objectPoints[0] to be fixed. It also acts as\n. a switch for calibration method selection. If object-releasing method to be used, pass in the\n. parameter in the range of [1, objectPoints[0].size()-2], otherwise a value out of this range will\n. make standard calibration method selected. Usually the top-right corner point of the calibration\n. board grid is recommended to be fixed when object-releasing method being utilized. According to\n. \\cite strobl2011iccv, two other points are also fixed. In this implementation, objectPoints[0].front\n. and objectPoints[0].back.z are used. With object-releasing method, accurate rvecs, tvecs and\n. newObjPoints are only possible if coordinates of these three fixed points are accurate enough.\n. @param cameraMatrix Output 3x3 floating-point camera matrix. See calibrateCamera() for details.\n. @param distCoeffs Output vector of distortion coefficients. See calibrateCamera() for details.\n. @param rvecs Output vector of rotation vectors estimated for each pattern view. See calibrateCamera()\n. for details.\n. @param tvecs Output vector of translation vectors estimated for each pattern view.\n. @param newObjPoints The updated output vector of calibration pattern points. The coordinates might\n. be scaled based on three fixed points. The returned coordinates are accurate only if the above\n. mentioned three fixed points are accurate. If not needed, noArray() can be passed in. This parameter\n. is ignored with standard calibration method.\n. @param stdDeviationsIntrinsics Output vector of standard deviations estimated for intrinsic parameters.\n. See calibrateCamera() for details.\n. @param stdDeviationsExtrinsics Output vector of standard deviations estimated for extrinsic parameters.\n. See calibrateCamera() for details.\n. @param stdDeviationsObjPoints Output vector of standard deviations estimated for refined coordinates\n. of calibration pattern points. It has the same size and order as objectPoints[0] vector. This\n. parameter is ignored with standard calibration method.\n. @param perViewErrors Output vector of the RMS re-projection error estimated for each pattern view.\n. @param flags Different flags that may be zero or a combination of some predefined values. See\n. calibrateCamera() for details. If the method of releasing object is used, the calibration time may\n. be much longer. CALIB_USE_QR or CALIB_USE_LU could be used for faster calibration with potentially\n. less precise and less stable in some rare cases.\n. @param criteria Termination criteria for the iterative optimization algorithm.\n. \n. @return the overall RMS re-projection error.\n. \n. The function estimates the intrinsic camera parameters and extrinsic parameters for each of the\n. views. The algorithm is based on @cite Zhang2000, @cite BouguetMCT and @cite strobl2011iccv. See\n. calibrateCamera() for other detailed explanations.\n. @sa\n. calibrateCamera, findChessboardCorners, solvePnP, initCameraMatrix2D, stereoCalibrate, undistort' ... -def calibrateHandEye(R_gripper2base, t_gripper2base, R_target2cam, t_target2cam, R_cam2gripper=..., t_cam2gripper=..., method: int = ...) -> typing.Any: +def calibrateHandEye( + R_gripper2base, + t_gripper2base, + R_target2cam, + t_target2cam, + R_cam2gripper=..., + t_cam2gripper=..., + method: int = ...) -> typing.Any: 'calibrateHandEye(R_gripper2base, t_gripper2base, R_target2cam, t_target2cam[, R_cam2gripper[, t_cam2gripper[, method]]]) -> R_cam2gripper, t_cam2gripper\n. @brief Computes Hand-Eye calibration: \\f$_{}^{g}\\textrm{T}_c\\f$\n. \n. @param[in] R_gripper2base Rotation part extracted from the homogeneous matrix that transforms a point\n. expressed in the gripper frame to the robot base frame (\\f$_{}^{b}\\textrm{T}_g\\f$).\n. This is a vector (`vector`) that contains the rotation matrices for all the transformations\n. from gripper frame to robot base frame.\n. @param[in] t_gripper2base Translation part extracted from the homogeneous matrix that transforms a point\n. expressed in the gripper frame to the robot base frame (\\f$_{}^{b}\\textrm{T}_g\\f$).\n. This is a vector (`vector`) that contains the translation vectors for all the transformations\n. from gripper frame to robot base frame.\n. @param[in] R_target2cam Rotation part extracted from the homogeneous matrix that transforms a point\n. expressed in the target frame to the camera frame (\\f$_{}^{c}\\textrm{T}_t\\f$).\n. This is a vector (`vector`) that contains the rotation matrices for all the transformations\n. from calibration target frame to camera frame.\n. @param[in] t_target2cam Rotation part extracted from the homogeneous matrix that transforms a point\n. expressed in the target frame to the camera frame (\\f$_{}^{c}\\textrm{T}_t\\f$).\n. This is a vector (`vector`) that contains the translation vectors for all the transformations\n. from calibration target frame to camera frame.\n. @param[out] R_cam2gripper Estimated rotation part extracted from the homogeneous matrix that transforms a point\n. expressed in the camera frame to the gripper frame (\\f$_{}^{g}\\textrm{T}_c\\f$).\n. @param[out] t_cam2gripper Estimated translation part extracted from the homogeneous matrix that transforms a point\n. expressed in the camera frame to the gripper frame (\\f$_{}^{g}\\textrm{T}_c\\f$).\n. @param[in] method One of the implemented Hand-Eye calibration method, see cv::HandEyeCalibrationMethod\n. \n. The function performs the Hand-Eye calibration using various methods. One approach consists in estimating the\n. rotation then the translation (separable solutions) and the following methods are implemented:\n. - R. Tsai, R. Lenz A New Technique for Fully Autonomous and Efficient 3D Robotics Hand/EyeCalibration \\cite Tsai89\n. - F. Park, B. Martin Robot Sensor Calibration: Solving AX = XB on the Euclidean Group \\cite Park94\n. - R. Horaud, F. Dornaika Hand-Eye Calibration \\cite Horaud95\n. \n. Another approach consists in estimating simultaneously the rotation and the translation (simultaneous solutions),\n. with the following implemented method:\n. - N. Andreff, R. Horaud, B. Espiau On-line Hand-Eye Calibration \\cite Andreff99\n. - K. Daniilidis Hand-Eye Calibration Using Dual Quaternions \\cite Daniilidis98\n. \n. The following picture describes the Hand-Eye calibration problem where the transformation between a camera ("eye")\n. mounted on a robot gripper ("hand") has to be estimated.\n. \n. ![](pics/hand-eye_figure.png)\n. \n. The calibration procedure is the following:\n. - a static calibration pattern is used to estimate the transformation between the target frame\n. and the camera frame\n. - the robot gripper is moved in order to acquire several poses\n. - for each pose, the homogeneous transformation between the gripper frame and the robot base frame is recorded using for\n. instance the robot kinematics\n. \\f[\n. \\begin{bmatrix}\n. X_b\\\\\n. Y_b\\\\\n. Z_b\\\\\n. 1\n. \\end{bmatrix}\n. =\n. \\begin{bmatrix}\n. _{}^{b}\\textrm{R}_g & _{}^{b}\\textrm{t}_g \\\\\n. 0_{1 \\times 3} & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X_g\\\\\n. Y_g\\\\\n. Z_g\\\\\n. 1\n. \\end{bmatrix}\n. \\f]\n. - for each pose, the homogeneous transformation between the calibration target frame and the camera frame is recorded using\n. for instance a pose estimation method (PnP) from 2D-3D point correspondences\n. \\f[\n. \\begin{bmatrix}\n. X_c\\\\\n. Y_c\\\\\n. Z_c\\\\\n. 1\n. \\end{bmatrix}\n. =\n. \\begin{bmatrix}\n. _{}^{c}\\textrm{R}_t & _{}^{c}\\textrm{t}_t \\\\\n. 0_{1 \\times 3} & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X_t\\\\\n. Y_t\\\\\n. Z_t\\\\\n. 1\n. \\end{bmatrix}\n. \\f]\n. \n. The Hand-Eye calibration procedure returns the following homogeneous transformation\n. \\f[\n. \\begin{bmatrix}\n. X_g\\\\\n. Y_g\\\\\n. Z_g\\\\\n. 1\n. \\end{bmatrix}\n. =\n. \\begin{bmatrix}\n. _{}^{g}\\textrm{R}_c & _{}^{g}\\textrm{t}_c \\\\\n. 0_{1 \\times 3} & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X_c\\\\\n. Y_c\\\\\n. Z_c\\\\\n. 1\n. \\end{bmatrix}\n. \\f]\n. \n. This problem is also known as solving the \\f$\\mathbf{A}\\mathbf{X}=\\mathbf{X}\\mathbf{B}\\f$ equation:\n. \\f[\n. \\begin{align*}\n. ^{b}{\\textrm{T}_g}^{(1)} \\hspace{0.2em} ^{g}\\textrm{T}_c \\hspace{0.2em} ^{c}{\\textrm{T}_t}^{(1)} &=\n. \\hspace{0.1em} ^{b}{\\textrm{T}_g}^{(2)} \\hspace{0.2em} ^{g}\\textrm{T}_c \\hspace{0.2em} ^{c}{\\textrm{T}_t}^{(2)} \\\\\n. \n. (^{b}{\\textrm{T}_g}^{(2)})^{-1} \\hspace{0.2em} ^{b}{\\textrm{T}_g}^{(1)} \\hspace{0.2em} ^{g}\\textrm{T}_c &=\n. \\hspace{0.1em} ^{g}\\textrm{T}_c \\hspace{0.2em} ^{c}{\\textrm{T}_t}^{(2)} (^{c}{\\textrm{T}_t}^{(1)})^{-1} \\\\\n. \n. \\textrm{A}_i \\textrm{X} &= \\textrm{X} \\textrm{B}_i \\\\\n. \\end{align*}\n. \\f]\n. \n. \\note\n. Additional information can be found on this [website](http://campar.in.tum.de/Chair/HandEyeCalibration).\n. \\note\n. A minimum of 2 motions with non parallel rotation axes are necessary to determine the hand-eye transformation.\n. So at least 3 different poses are required, but it is strongly recommended to use many more poses.' ... @@ -2002,7 +2222,13 @@ def clipLine(imgRect, pt1, pt2) -> typing.Any: ... -def colorChange(src: ndarray, mask: ndarray, dts: ndarray = ..., red_mul=..., green_mul=..., blue_mul=...) -> typing.Any: +def colorChange( + src: ndarray, + mask: ndarray, + dts: ndarray = ..., + red_mul=..., + green_mul=..., + blue_mul=...) -> typing.Any: 'colorChange(src, mask[, dst[, red_mul[, green_mul[, blue_mul]]]]) -> dst\n. @brief Given an original color image, two differently colored versions of this image can be mixed\n. seamlessly.\n. \n. @param src Input 8-bit 3-channel image.\n. @param mask Input 8-bit 1 or 3-channel image.\n. @param dst Output image with the same size and type as src .\n. @param red_mul R-channel multiply factor.\n. @param green_mul G-channel multiply factor.\n. @param blue_mul B-channel multiply factor.\n. \n. Multiplication factor is between .5 to 2.5.' ... @@ -2022,7 +2248,21 @@ def completeSymm(m, lowerToUpper=...) -> typing.Any: ... -def composeRT(rvec1, tvec1, rvec2, tvec2, rvec3=..., tvec3=..., dr3dr1=..., dr3dt1=..., dr3dr2=..., dr3dt2=..., dt3dr1=..., dt3dt1=..., dt3dr2=..., dt3dt2=...) -> typing.Any: +def composeRT( + rvec1, + tvec1, + rvec2, + tvec2, + rvec3=..., + tvec3=..., + dr3dr1=..., + dr3dt1=..., + dr3dr2=..., + dr3dt2=..., + dt3dr1=..., + dt3dt1=..., + dt3dr2=..., + dt3dt2=...) -> typing.Any: 'composeRT(rvec1, tvec1, rvec2, tvec2[, rvec3[, tvec3[, dr3dr1[, dr3dt1[, dr3dr2[, dr3dt2[, dt3dr1[, dt3dt1[, dt3dr2[, dt3dt2]]]]]]]]]]) -> rvec3, tvec3, dr3dr1, dr3dt1, dr3dr2, dr3dt2, dt3dr1, dt3dt1, dt3dr2, dt3dt2\n. @brief Combines two rotation-and-shift transformations.\n. \n. @param rvec1 First rotation vector.\n. @param tvec1 First translation vector.\n. @param rvec2 Second rotation vector.\n. @param tvec2 Second translation vector.\n. @param rvec3 Output rotation vector of the superposition.\n. @param tvec3 Output translation vector of the superposition.\n. @param dr3dr1 Optional output derivative of rvec3 with regard to rvec1\n. @param dr3dt1 Optional output derivative of rvec3 with regard to tvec1\n. @param dr3dr2 Optional output derivative of rvec3 with regard to rvec2\n. @param dr3dt2 Optional output derivative of rvec3 with regard to tvec2\n. @param dt3dr1 Optional output derivative of tvec3 with regard to rvec1\n. @param dt3dt1 Optional output derivative of tvec3 with regard to tvec1\n. @param dt3dr2 Optional output derivative of tvec3 with regard to rvec2\n. @param dt3dt2 Optional output derivative of tvec3 with regard to tvec2\n. \n. The functions compute:\n. \n. \\f[\\begin{array}{l} \\texttt{rvec3} = \\mathrm{rodrigues} ^{-1} \\left ( \\mathrm{rodrigues} ( \\texttt{rvec2} ) \\cdot \\mathrm{rodrigues} ( \\texttt{rvec1} ) \\right ) \\\\ \\texttt{tvec3} = \\mathrm{rodrigues} ( \\texttt{rvec2} ) \\cdot \\texttt{tvec1} + \\texttt{tvec2} \\end{array} ,\\f]\n. \n. where \\f$\\mathrm{rodrigues}\\f$ denotes a rotation vector to a rotation matrix transformation, and\n. \\f$\\mathrm{rodrigues}^{-1}\\f$ denotes the inverse transformation. See Rodrigues for details.\n. \n. Also, the functions can compute the derivatives of the output vectors with regards to the input\n. vectors (see matMulDeriv ). The functions are used inside stereoCalibrate but can also be used in\n. your own code where Levenberg-Marquardt or another gradient-based solver is used to optimize a\n. function that contains a matrix multiplication.' ... @@ -2047,12 +2287,25 @@ def connectedComponentsWithAlgorithm(image: ndarray, connectivity, ltype, ccltyp ... -def connectedComponentsWithStats(image: ndarray, labels=..., stats=..., centroids=..., connectivity=..., ltype=...) -> typing.Any: +def connectedComponentsWithStats( + image: ndarray, + labels=..., + stats=..., + centroids=..., + connectivity=..., + ltype=...) -> typing.Any: 'connectedComponentsWithStats(image[, labels[, stats[, centroids[, connectivity[, ltype]]]]]) -> retval, labels, stats, centroids\n. @overload\n. @param image the 8-bit single-channel image to be labeled\n. @param labels destination labeled image\n. @param stats statistics output for each label, including the background label.\n. Statistics are accessed via stats(label, COLUMN) where COLUMN is one of\n. #ConnectedComponentsTypes, selecting the statistic. The data type is CV_32S.\n. @param centroids centroid output for each label, including the background label. Centroids are\n. accessed via centroids(label, 0) for x and centroids(label, 1) for y. The data type CV_64F.\n. @param connectivity 8 or 4 for 8-way or 4-way connectivity respectively\n. @param ltype output image label type. Currently CV_32S and CV_16U are supported.' ... -def connectedComponentsWithStatsWithAlgorithm(image: ndarray, connectivity, ltype, ccltype, labels=..., stats=..., centroids=...) -> typing.Any: +def connectedComponentsWithStatsWithAlgorithm( + image: ndarray, + connectivity, + ltype, + ccltype, + labels=..., + stats=..., + centroids=...) -> typing.Any: "connectedComponentsWithStatsWithAlgorithm(image, connectivity, ltype, ccltype[, labels[, stats[, centroids]]]) -> retval, labels, stats, centroids\n. @brief computes the connected components labeled image of boolean image and also produces a statistics output for each label\n. \n. image with 4 or 8 way connectivity - returns N, the total number of labels [0, N-1] where 0\n. represents the background label. ltype specifies the output label image type, an important\n. consideration based on the total number of labels or alternatively the total number of pixels in\n. the source image. ccltype specifies the connected components labeling algorithm to use, currently\n. Grana's (BBDT) and Wu's (SAUF) algorithms are supported, see the #ConnectedComponentsAlgorithmsTypes\n. for details. Note that SAUF algorithm forces a row major ordering of labels while BBDT does not.\n. This function uses parallel version of both Grana and Wu's algorithms (statistics included) if at least one allowed\n. parallel framework is enabled and if the rows of the image are at least twice the number returned by #getNumberOfCPUs.\n. \n. @param image the 8-bit single-channel image to be labeled\n. @param labels destination labeled image\n. @param stats statistics output for each label, including the background label.\n. Statistics are accessed via stats(label, COLUMN) where COLUMN is one of\n. #ConnectedComponentsTypes, selecting the statistic. The data type is CV_32S.\n. @param centroids centroid output for each label, including the background label. Centroids are\n. accessed via centroids(label, 0) for x and centroids(label, 1) for y. The data type CV_64F.\n. @param connectivity 8 or 4 for 8-way or 4-way connectivity respectively\n. @param ltype output image label type. Currently CV_32S and CV_16U are supported.\n. @param ccltype connected components algorithm type (see #ConnectedComponentsAlgorithmsTypes)." ... @@ -2187,7 +2440,15 @@ def createHanningWindow(winSize, type, dts: ndarray = ...) -> typing.Any: ... -def createLineSegmentDetector(_refine=..., _scale=..., _sigma_scale=..., _quant=..., _ang_th=..., _log_eps=..., _density_th=..., _n_bins=...) -> typing.Any: +def createLineSegmentDetector( + _refine=..., + _scale=..., + _sigma_scale=..., + _quant=..., + _ang_th=..., + _log_eps=..., + _density_th=..., + _n_bins=...) -> typing.Any: 'createLineSegmentDetector([, _refine[, _scale[, _sigma_scale[, _quant[, _ang_th[, _log_eps[, _density_th[, _n_bins]]]]]]]]) -> retval\n. @brief Creates a smart pointer to a LineSegmentDetector object and initializes it.\n. \n. The LineSegmentDetector algorithm is defined using the standard values. Only advanced users may want\n. to edit those, as to tailor it for their own application.\n. \n. @param _refine The way found lines will be refined, see #LineSegmentDetectorModes\n. @param _scale The scale of the image that will be used to find the lines. Range (0..1].\n. @param _sigma_scale Sigma for Gaussian filter. It is computed as sigma = _sigma_scale/_scale.\n. @param _quant Bound to the quantization error on the gradient norm.\n. @param _ang_th Gradient angle tolerance in degrees.\n. @param _log_eps Detection threshold: -log10(NFA) \\> log_eps. Used only when advance refinement\n. is chosen.\n. @param _density_th Minimal density of aligned region points in the enclosing rectangle.\n. @param _n_bins Number of bins in pseudo-ordering of gradient modulus.\n. \n. @note Implementation has been removed due original code license conflict' ... @@ -2277,7 +2538,15 @@ def decomposeHomographyMat(H, K, rotations=..., translations=..., normals=...) - ... -def decomposeProjectionMatrix(projMatrix, cameraMatrix=..., rotMatrix=..., transVect=..., rotMatrixX=..., rotMatrixY=..., rotMatrixZ=..., eulerAngles=...) -> typing.Any: +def decomposeProjectionMatrix( + projMatrix, + cameraMatrix=..., + rotMatrix=..., + transVect=..., + rotMatrixX=..., + rotMatrixY=..., + rotMatrixZ=..., + eulerAngles=...) -> typing.Any: 'decomposeProjectionMatrix(projMatrix[, cameraMatrix[, rotMatrix[, transVect[, rotMatrixX[, rotMatrixY[, rotMatrixZ[, eulerAngles]]]]]]]) -> cameraMatrix, rotMatrix, transVect, rotMatrixX, rotMatrixY, rotMatrixZ, eulerAngles\n. @brief Decomposes a projection matrix into a rotation matrix and a camera matrix.\n. \n. @param projMatrix 3x4 input projection matrix P.\n. @param cameraMatrix Output 3x3 camera matrix K.\n. @param rotMatrix Output 3x3 external rotation matrix R.\n. @param transVect Output 4x1 translation vector T.\n. @param rotMatrixX Optional 3x3 rotation matrix around x-axis.\n. @param rotMatrixY Optional 3x3 rotation matrix around y-axis.\n. @param rotMatrixZ Optional 3x3 rotation matrix around z-axis.\n. @param eulerAngles Optional three-element vector containing three Euler angles of rotation in\n. degrees.\n. \n. The function computes a decomposition of a projection matrix into a calibration and a rotation\n. matrix and the position of a camera.\n. \n. It optionally returns three rotation matrices, one for each axis, and three Euler angles that could\n. be used in OpenGL. Note, there is always more than one sequence of rotations about the three\n. principal axes that results in the same orientation of an object, e.g. see @cite Slabaugh . Returned\n. tree rotation matrices and corresponding three Euler angles are only one of the possible solutions.\n. \n. The function is based on RQDecomp3x3 .' ... @@ -2355,7 +2624,14 @@ def dft(src: ndarray, dts: ndarray = ..., flags: int = ..., nonzeroRows=...) -> ... -def dilate(src: ndarray, kernel, dts: ndarray = ..., anchor=..., iterations=..., borderType=..., borderValue=...) -> typing.Any: +def dilate( + src: ndarray, + kernel, + dts: ndarray = ..., + anchor=..., + iterations=..., + borderType=..., + borderValue=...) -> typing.Any: "dilate(src, kernel[, dst[, anchor[, iterations[, borderType[, borderValue]]]]]) -> dst\n. @brief Dilates an image by using a specific structuring element.\n. \n. The function dilates the source image using the specified structuring element that determines the\n. shape of a pixel neighborhood over which the maximum is taken:\n. \\f[\\texttt{dst} (x,y) = \\max _{(x',y'): \\, \\texttt{element} (x',y') \\ne0 } \\texttt{src} (x+x',y+y')\\f]\n. \n. The function supports the in-place mode. Dilation can be applied several ( iterations ) times. In\n. case of multi-channel images, each channel is processed independently.\n. \n. @param src input image; the number of channels can be arbitrary, but the depth should be one of\n. CV_8U, CV_16U, CV_16S, CV_32F or CV_64F.\n. @param dst output image of the same size and type as src.\n. @param kernel structuring element used for dilation; if elemenat=Mat(), a 3 x 3 rectangular\n. structuring element is used. Kernel can be created using #getStructuringElement\n. @param anchor position of the anchor within the element; default value (-1, -1) means that the\n. anchor is at the element center.\n. @param iterations number of times dilation is applied.\n. @param borderType pixel extrapolation method, see #BorderTypes. #BORDER_WRAP is not suported.\n. @param borderValue border value in case of a constant border\n. @sa erode, morphologyEx, getStructuringElement" ... @@ -2375,7 +2651,13 @@ def distanceTransform(src: ndarray, distanceType, maskSize, dts: ndarray = ..., ... -def distanceTransformWithLabels(src: ndarray, distanceType, maskSize, dts: ndarray = ..., labels=..., labelType=...) -> typing.Any: +def distanceTransformWithLabels( + src: ndarray, + distanceType, + maskSize, + dts: ndarray = ..., + labels=..., + labelType=...) -> typing.Any: "distanceTransformWithLabels(src, distanceType, maskSize[, dst[, labels[, labelType]]]) -> dst, labels\n. @brief Calculates the distance to the closest zero pixel for each pixel of the source image.\n. \n. The function cv::distanceTransform calculates the approximate or precise distance from every binary\n. image pixel to the nearest zero pixel. For zero image pixels, the distance will obviously be zero.\n. \n. When maskSize == #DIST_MASK_PRECISE and distanceType == #DIST_L2 , the function runs the\n. algorithm described in @cite Felzenszwalb04 . This algorithm is parallelized with the TBB library.\n. \n. In other cases, the algorithm @cite Borgefors86 is used. This means that for a pixel the function\n. finds the shortest path to the nearest zero pixel consisting of basic shifts: horizontal, vertical,\n. diagonal, or knight's move (the latest is available for a \\f$5\\times 5\\f$ mask). The overall\n. distance is calculated as a sum of these basic distances. Since the distance function should be\n. symmetric, all of the horizontal and vertical shifts must have the same cost (denoted as a ), all\n. the diagonal shifts must have the same cost (denoted as `b`), and all knight's moves must have the\n. same cost (denoted as `c`). For the #DIST_C and #DIST_L1 types, the distance is calculated\n. precisely, whereas for #DIST_L2 (Euclidean distance) the distance can be calculated only with a\n. relative error (a \\f$5\\times 5\\f$ mask gives more accurate results). For `a`,`b`, and `c`, OpenCV\n. uses the values suggested in the original paper:\n. - DIST_L1: `a = 1, b = 2`\n. - DIST_L2:\n. - `3 x 3`: `a=0.955, b=1.3693`\n. - `5 x 5`: `a=1, b=1.4, c=2.1969`\n. - DIST_C: `a = 1, b = 1`\n. \n. Typically, for a fast, coarse distance estimation #DIST_L2, a \\f$3\\times 3\\f$ mask is used. For a\n. more accurate distance estimation #DIST_L2, a \\f$5\\times 5\\f$ mask or the precise algorithm is used.\n. Note that both the precise and the approximate algorithms are linear on the number of pixels.\n. \n. This variant of the function does not only compute the minimum distance for each pixel \\f$(x, y)\\f$\n. but also identifies the nearest connected component consisting of zero pixels\n. (labelType==#DIST_LABEL_CCOMP) or the nearest zero pixel (labelType==#DIST_LABEL_PIXEL). Index of the\n. component/pixel is stored in `labels(x, y)`. When labelType==#DIST_LABEL_CCOMP, the function\n. automatically finds connected components of zero pixels in the input image and marks them with\n. distinct labels. When labelType==#DIST_LABEL_CCOMP, the function scans through the input image and\n. marks all the zero pixels with distinct labels.\n. \n. In this mode, the complexity is still linear. That is, the function provides a very fast way to\n. compute the Voronoi diagram for a binary image. Currently, the second variant can use only the\n. approximate distance transform algorithm, i.e. maskSize=#DIST_MASK_PRECISE is not supported\n. yet.\n. \n. @param src 8-bit, single-channel (binary) source image.\n. @param dst Output image with calculated distances. It is a 8-bit or 32-bit floating-point,\n. single-channel image of the same size as src.\n. @param labels Output 2D array of labels (the discrete Voronoi diagram). It has the type\n. CV_32SC1 and the same size as src.\n. @param distanceType Type of distance, see #DistanceTypes\n. @param maskSize Size of the distance transform mask, see #DistanceTransformMasks.\n. #DIST_MASK_PRECISE is not supported by this variant. In case of the #DIST_L1 or #DIST_C distance type,\n. the parameter is forced to 3 because a \\f$3\\times 3\\f$ mask gives the same result as \\f$5\\times\n. 5\\f$ or any larger aperture.\n. @param labelType Type of the label array to build, see #DistanceTransformLabelTypes." ... @@ -2410,7 +2692,16 @@ def drawChessboardCorners(image: ndarray, patternSize, corners, patternWasFound) ... -def drawContours(image: ndarray, contours, contourIdx, color, thickness=..., lineType=..., hierarchy=..., maxLevel=..., offset=...) -> typing.Any: +def drawContours( + image: ndarray, + contours, + contourIdx, + color, + thickness=..., + lineType=..., + hierarchy=..., + maxLevel=..., + offset=...) -> typing.Any: 'drawContours(image, contours, contourIdx, color[, thickness[, lineType[, hierarchy[, maxLevel[, offset]]]]]) -> image\n. @brief Draws contours outlines or filled contours.\n. \n. The function draws contour outlines in the image if \\f$\\texttt{thickness} \\ge 0\\f$ or fills the area\n. bounded by the contours if \\f$\\texttt{thickness}<0\\f$ . The example below shows how to retrieve\n. connected components from the binary image and label them: :\n. @include snippets/imgproc_drawContours.cpp\n. \n. @param image Destination image.\n. @param contours All the input contours. Each contour is stored as a point vector.\n. @param contourIdx Parameter indicating a contour to draw. If it is negative, all the contours are drawn.\n. @param color Color of the contours.\n. @param thickness Thickness of lines the contours are drawn with. If it is negative (for example,\n. thickness=#FILLED ), the contour interiors are drawn.\n. @param lineType Line connectivity. See #LineTypes\n. @param hierarchy Optional information about hierarchy. It is only needed if you want to draw only\n. some of the contours (see maxLevel ).\n. @param maxLevel Maximal level for drawn contours. If it is 0, only the specified contour is drawn.\n. If it is 1, the function draws the contour(s) and all the nested contours. If it is 2, the function\n. draws the contours, all the nested contours, all the nested-to-nested contours, and so on. This\n. parameter is only taken into account when there is hierarchy available.\n. @param offset Optional contour shift parameter. Shift all the drawn contours by the specified\n. \\f$\\texttt{offset}=(dx,dy)\\f$ .\n. @note When thickness=#FILLED, the function is designed to handle connected components with holes correctly\n. even when no hierarchy date is provided. This is done by analyzing all the outlines together\n. using even-odd rule. This may give incorrect results if you have a joint collection of separately retrieved\n. contours. In order to solve this problem, you need to call #drawContours separately for each sub-group\n. of contours, or iterate over the collection using contourIdx parameter.' ... @@ -2425,17 +2716,44 @@ def drawKeypoints(image: ndarray, keypoints, outImage, color=..., flags: int = . ... -def drawMarker(img: ndarray, position, color, markerType=..., markerSize=..., thickness=..., line_type=...) -> typing.Any: +def drawMarker( + img: ndarray, + position, + color, + markerType=..., + markerSize=..., + thickness=..., + line_type=...) -> typing.Any: 'drawMarker(img, position, color[, markerType[, markerSize[, thickness[, line_type]]]]) -> img\n. @brief Draws a marker on a predefined position in an image.\n. \n. The function cv::drawMarker draws a marker on a given position in the image. For the moment several\n. marker types are supported, see #MarkerTypes for more information.\n. \n. @param img Image.\n. @param position The point where the crosshair is positioned.\n. @param color Line color.\n. @param markerType The specific type of marker you want to use, see #MarkerTypes\n. @param thickness Line thickness.\n. @param line_type Type of the line, See #LineTypes\n. @param markerSize The length of the marker axis [default = 20 pixels]' ... -def drawMatches(img1, keypoints1, img2, keypoints2, matches1to2, outImg, matchColor=..., singlePointColor=..., matchesMask=..., flags: int = ...) -> typing.Any: +def drawMatches( + img1, + keypoints1, + img2, + keypoints2, + matches1to2, + outImg, + matchColor=..., + singlePointColor=..., + matchesMask=..., + flags: int = ...) -> typing.Any: 'drawMatches(img1, keypoints1, img2, keypoints2, matches1to2, outImg[, matchColor[, singlePointColor[, matchesMask[, flags]]]]) -> outImg\n. @brief Draws the found matches of keypoints from two images.\n. \n. @param img1 First source image.\n. @param keypoints1 Keypoints from the first source image.\n. @param img2 Second source image.\n. @param keypoints2 Keypoints from the second source image.\n. @param matches1to2 Matches from the first image to the second one, which means that keypoints1[i]\n. has a corresponding point in keypoints2[matches[i]] .\n. @param outImg Output image. Its content depends on the flags value defining what is drawn in the\n. output image. See possible flags bit values below.\n. @param matchColor Color of matches (lines and connected keypoints). If matchColor==Scalar::all(-1)\n. , the color is generated randomly.\n. @param singlePointColor Color of single keypoints (circles), which means that keypoints do not\n. have the matches. If singlePointColor==Scalar::all(-1) , the color is generated randomly.\n. @param matchesMask Mask determining which matches are drawn. If the mask is empty, all matches are\n. drawn.\n. @param flags Flags setting drawing features. Possible flags bit values are defined by\n. DrawMatchesFlags.\n. \n. This function draws matches of keypoints from two images in the output image. Match is a line\n. connecting two keypoints (circles). See cv::DrawMatchesFlags.' ... -def drawMatchesKnn(img1, keypoints1, img2, keypoints2, matches1to2, outImg, matchColor=..., singlePointColor=..., matchesMask=..., flags: int = ...) -> typing.Any: +def drawMatchesKnn( + img1, + keypoints1, + img2, + keypoints2, + matches1to2, + outImg, + matchColor=..., + singlePointColor=..., + matchesMask=..., + flags: int = ...) -> typing.Any: 'drawMatchesKnn(img1, keypoints1, img2, keypoints2, matches1to2, outImg[, matchColor[, singlePointColor[, matchesMask[, flags]]]]) -> outImg\n. @overload' ... @@ -2455,7 +2773,17 @@ def eigenNonSymmetric(src: ndarray, eigenvalues=..., eigenvectors=...) -> typing ... -def ellipse(img: ndarray, center, axes, angle, startAngle, endAngle, color, thickness=..., lineType=..., shift=...) -> typing.Any: +def ellipse( + img: ndarray, + center, + axes, + angle, + startAngle, + endAngle, + color, + thickness=..., + lineType=..., + shift=...) -> typing.Any: 'ellipse(img, center, axes, angle, startAngle, endAngle, color[, thickness[, lineType[, shift]]]) -> img\n. @brief Draws a simple or thick elliptic arc or fills an ellipse sector.\n. \n. The function cv::ellipse with more parameters draws an ellipse outline, a filled ellipse, an elliptic\n. arc, or a filled ellipse sector. The drawing code uses general parametric form.\n. A piecewise-linear curve is used to approximate the elliptic arc\n. boundary. If you need more control of the ellipse rendering, you can retrieve the curve using\n. #ellipse2Poly and then render it with #polylines or fill it with #fillPoly. If you use the first\n. variant of the function and want to draw the whole ellipse, not an arc, pass `startAngle=0` and\n. `endAngle=360`. If `startAngle` is greater than `endAngle`, they are swapped. The figure below explains\n. the meaning of the parameters to draw the blue arc.\n. \n. ![Parameters of Elliptic Arc](pics/ellipse.svg)\n. \n. @param img Image.\n. @param center Center of the ellipse.\n. @param axes Half of the size of the ellipse main axes.\n. @param angle Ellipse rotation angle in degrees.\n. @param startAngle Starting angle of the elliptic arc in degrees.\n. @param endAngle Ending angle of the elliptic arc in degrees.\n. @param color Ellipse color.\n. @param thickness Thickness of the ellipse arc outline, if positive. Otherwise, this indicates that\n. a filled ellipse sector is to be drawn.\n. @param lineType Type of the ellipse boundary. See #LineTypes\n. @param shift Number of fractional bits in the coordinates of the center and values of axes.\n\n\n\nellipse(img, box, color[, thickness[, lineType]]) -> img\n. @overload\n. @param img Image.\n. @param box Alternative ellipse representation via RotatedRect. This means that the function draws\n. an ellipse inscribed in the rotated rectangle.\n. @param color Ellipse color.\n. @param thickness Thickness of the ellipse arc outline, if positive. Otherwise, this indicates that\n. a filled ellipse sector is to be drawn.\n. @param lineType Type of the ellipse boundary. See #LineTypes' ... @@ -2470,7 +2798,14 @@ def equalizeHist(src: ndarray, dts: ndarray = ...) -> typing.Any: ... -def erode(src: ndarray, kernel, dts: ndarray = ..., anchor=..., iterations=..., borderType=..., borderValue=...) -> typing.Any: +def erode( + src: ndarray, + kernel, + dts: ndarray = ..., + anchor=..., + iterations=..., + borderType=..., + borderValue=...) -> typing.Any: "erode(src, kernel[, dst[, anchor[, iterations[, borderType[, borderValue]]]]]) -> dst\n. @brief Erodes an image by using a specific structuring element.\n. \n. The function erodes the source image using the specified structuring element that determines the\n. shape of a pixel neighborhood over which the minimum is taken:\n. \n. \\f[\\texttt{dst} (x,y) = \\min _{(x',y'): \\, \\texttt{element} (x',y') \\ne0 } \\texttt{src} (x+x',y+y')\\f]\n. \n. The function supports the in-place mode. Erosion can be applied several ( iterations ) times. In\n. case of multi-channel images, each channel is processed independently.\n. \n. @param src input image; the number of channels can be arbitrary, but the depth should be one of\n. CV_8U, CV_16U, CV_16S, CV_32F or CV_64F.\n. @param dst output image of the same size and type as src.\n. @param kernel structuring element used for erosion; if `element=Mat()`, a `3 x 3` rectangular\n. structuring element is used. Kernel can be created using #getStructuringElement.\n. @param anchor position of the anchor within the element; default value (-1, -1) means that the\n. anchor is at the element center.\n. @param iterations number of times erosion is applied.\n. @param borderType pixel extrapolation method, see #BorderTypes. #BORDER_WRAP is not supported.\n. @param borderValue border value in case of a constant border\n. @sa dilate, morphologyEx, getStructuringElement" ... @@ -2478,27 +2813,61 @@ def erode(src: ndarray, kernel, dts: ndarray = ..., anchor=..., iterations=..., error = _mod_cv2.error -def estimateAffine2D(from_, to, inliers=..., method: int = ..., ransacReprojThreshold=..., maxIters=..., confidence=..., refineIters=...) -> typing.Any: +def estimateAffine2D( + from_, + to, + inliers=..., + method: int = ..., + ransacReprojThreshold=..., + maxIters=..., + confidence=..., + refineIters=...) -> typing.Any: 'estimateAffine2D(from, to[, inliers[, method[, ransacReprojThreshold[, maxIters[, confidence[, refineIters]]]]]]) -> retval, inliers\n. @brief Computes an optimal affine transformation between two 2D point sets.\n. \n. It computes\n. \\f[\n. \\begin{bmatrix}\n. x\\\\\n. y\\\\\n. \\end{bmatrix}\n. =\n. \\begin{bmatrix}\n. a_{11} & a_{12}\\\\\n. a_{21} & a_{22}\\\\\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X\\\\\n. Y\\\\\n. \\end{bmatrix}\n. +\n. \\begin{bmatrix}\n. b_1\\\\\n. b_2\\\\\n. \\end{bmatrix}\n. \\f]\n. \n. @param from First input 2D point set containing \\f$(X,Y)\\f$.\n. @param to Second input 2D point set containing \\f$(x,y)\\f$.\n. @param inliers Output vector indicating which points are inliers (1-inlier, 0-outlier).\n. @param method Robust method used to compute transformation. The following methods are possible:\n. - cv::RANSAC - RANSAC-based robust method\n. - cv::LMEDS - Least-Median robust method\n. RANSAC is the default method.\n. @param ransacReprojThreshold Maximum reprojection error in the RANSAC algorithm to consider\n. a point as an inlier. Applies only to RANSAC.\n. @param maxIters The maximum number of robust method iterations.\n. @param confidence Confidence level, between 0 and 1, for the estimated transformation. Anything\n. between 0.95 and 0.99 is usually good enough. Values too close to 1 can slow down the estimation\n. significantly. Values lower than 0.8-0.9 can result in an incorrectly estimated transformation.\n. @param refineIters Maximum number of iterations of refining algorithm (Levenberg-Marquardt).\n. Passing 0 will disable refining, so the output matrix will be output of robust method.\n. \n. @return Output 2D affine transformation matrix \\f$2 \\times 3\\f$ or empty matrix if transformation\n. could not be estimated. The returned matrix has the following form:\n. \\f[\n. \\begin{bmatrix}\n. a_{11} & a_{12} & b_1\\\\\n. a_{21} & a_{22} & b_2\\\\\n. \\end{bmatrix}\n. \\f]\n. \n. The function estimates an optimal 2D affine transformation between two 2D point sets using the\n. selected robust algorithm.\n. \n. The computed transformation is then refined further (using only inliers) with the\n. Levenberg-Marquardt method to reduce the re-projection error even more.\n. \n. @note\n. The RANSAC method can handle practically any ratio of outliers but needs a threshold to\n. distinguish inliers from outliers. The method LMeDS does not need any threshold but it works\n. correctly only when there are more than 50% of inliers.\n. \n. @sa estimateAffinePartial2D, getAffineTransform' ... -def estimateAffine3D(src: ndarray, dts: ndarray, out=..., inliers=..., ransacThreshold=..., confidence=...) -> typing.Any: +def estimateAffine3D( + src: ndarray, + dts: ndarray, + out=..., + inliers=..., + ransacThreshold=..., + confidence=...) -> typing.Any: 'estimateAffine3D(src, dst[, out[, inliers[, ransacThreshold[, confidence]]]]) -> retval, out, inliers\n. @brief Computes an optimal affine transformation between two 3D point sets.\n. \n. It computes\n. \\f[\n. \\begin{bmatrix}\n. x\\\\\n. y\\\\\n. z\\\\\n. \\end{bmatrix}\n. =\n. \\begin{bmatrix}\n. a_{11} & a_{12} & a_{13}\\\\\n. a_{21} & a_{22} & a_{23}\\\\\n. a_{31} & a_{32} & a_{33}\\\\\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X\\\\\n. Y\\\\\n. Z\\\\\n. \\end{bmatrix}\n. +\n. \\begin{bmatrix}\n. b_1\\\\\n. b_2\\\\\n. b_3\\\\\n. \\end{bmatrix}\n. \\f]\n. \n. @param src First input 3D point set containing \\f$(X,Y,Z)\\f$.\n. @param dst Second input 3D point set containing \\f$(x,y,z)\\f$.\n. @param out Output 3D affine transformation matrix \\f$3 \\times 4\\f$ of the form\n. \\f[\n. \\begin{bmatrix}\n. a_{11} & a_{12} & a_{13} & b_1\\\\\n. a_{21} & a_{22} & a_{23} & b_2\\\\\n. a_{31} & a_{32} & a_{33} & b_3\\\\\n. \\end{bmatrix}\n. \\f]\n. @param inliers Output vector indicating which points are inliers (1-inlier, 0-outlier).\n. @param ransacThreshold Maximum reprojection error in the RANSAC algorithm to consider a point as\n. an inlier.\n. @param confidence Confidence level, between 0 and 1, for the estimated transformation. Anything\n. between 0.95 and 0.99 is usually good enough. Values too close to 1 can slow down the estimation\n. significantly. Values lower than 0.8-0.9 can result in an incorrectly estimated transformation.\n. \n. The function estimates an optimal 3D affine transformation between two 3D point sets using the\n. RANSAC algorithm.' ... -def estimateAffinePartial2D(from_, to, inliers=..., method: int = ..., ransacReprojThreshold=..., maxIters=..., confidence=..., refineIters=...) -> typing.Any: +def estimateAffinePartial2D( + from_, + to, + inliers=..., + method: int = ..., + ransacReprojThreshold=..., + maxIters=..., + confidence=..., + refineIters=...) -> typing.Any: 'estimateAffinePartial2D(from, to[, inliers[, method[, ransacReprojThreshold[, maxIters[, confidence[, refineIters]]]]]]) -> retval, inliers\n. @brief Computes an optimal limited affine transformation with 4 degrees of freedom between\n. two 2D point sets.\n. \n. @param from First input 2D point set.\n. @param to Second input 2D point set.\n. @param inliers Output vector indicating which points are inliers.\n. @param method Robust method used to compute transformation. The following methods are possible:\n. - cv::RANSAC - RANSAC-based robust method\n. - cv::LMEDS - Least-Median robust method\n. RANSAC is the default method.\n. @param ransacReprojThreshold Maximum reprojection error in the RANSAC algorithm to consider\n. a point as an inlier. Applies only to RANSAC.\n. @param maxIters The maximum number of robust method iterations.\n. @param confidence Confidence level, between 0 and 1, for the estimated transformation. Anything\n. between 0.95 and 0.99 is usually good enough. Values too close to 1 can slow down the estimation\n. significantly. Values lower than 0.8-0.9 can result in an incorrectly estimated transformation.\n. @param refineIters Maximum number of iterations of refining algorithm (Levenberg-Marquardt).\n. Passing 0 will disable refining, so the output matrix will be output of robust method.\n. \n. @return Output 2D affine transformation (4 degrees of freedom) matrix \\f$2 \\times 3\\f$ or\n. empty matrix if transformation could not be estimated.\n. \n. The function estimates an optimal 2D affine transformation with 4 degrees of freedom limited to\n. combinations of translation, rotation, and uniform scaling. Uses the selected algorithm for robust\n. estimation.\n. \n. The computed transformation is then refined further (using only inliers) with the\n. Levenberg-Marquardt method to reduce the re-projection error even more.\n. \n. Estimated transformation matrix is:\n. \\f[ \\begin{bmatrix} \\cos(\\theta) \\cdot s & -\\sin(\\theta) \\cdot s & t_x \\\\\n. \\sin(\\theta) \\cdot s & \\cos(\\theta) \\cdot s & t_y\n. \\end{bmatrix} \\f]\n. Where \\f$ \\theta \\f$ is the rotation angle, \\f$ s \\f$ the scaling factor and \\f$ t_x, t_y \\f$ are\n. translations in \\f$ x, y \\f$ axes respectively.\n. \n. @note\n. The RANSAC method can handle practically any ratio of outliers but need a threshold to\n. distinguish inliers from outliers. The method LMeDS does not need any threshold but it works\n. correctly only when there are more than 50% of inliers.\n. \n. @sa estimateAffine2D, getAffineTransform' ... -def estimateChessboardSharpness(image: ndarray, patternSize, corners, rise_distance=..., vertical=..., sharpness=...) -> typing.Any: +def estimateChessboardSharpness( + image: ndarray, + patternSize, + corners, + rise_distance=..., + vertical=..., + sharpness=...) -> typing.Any: 'estimateChessboardSharpness(image, patternSize, corners[, rise_distance[, vertical[, sharpness]]]) -> retval, sharpness\n. @brief Estimates the sharpness of a detected chessboard.\n. \n. Image sharpness, as well as brightness, are a critical parameter for accuracte\n. camera calibration. For accessing these parameters for filtering out\n. problematic calibraiton images, this method calculates edge profiles by traveling from\n. black to white chessboard cell centers. Based on this, the number of pixels is\n. calculated required to transit from black to white. This width of the\n. transition area is a good indication of how sharp the chessboard is imaged\n. and should be below ~3.0 pixels.\n. \n. @param image Gray image used to find chessboard corners\n. @param patternSize Size of a found chessboard pattern\n. @param corners Corners found by findChessboardCorners(SB)\n. @param rise_distance Rise distance 0.8 means 10% ... 90% of the final signal strength\n. @param vertical By default edge responses for horizontal lines are calculated\n. @param sharpness Optional output array with a sharpness value for calculated edge responses (see description)\n. \n. The optional sharpness array is of type CV_32FC1 and has for each calculated\n. profile one row with the following five entries:\n. * 0 = x coordinate of the underlying edge in the image\n. * 1 = y coordinate of the underlying edge in the image\n. * 2 = width of the transition area (sharpness)\n. * 3 = signal strength in the black cell (min brightness)\n. * 4 = signal strength in the white cell (max brightness)\n. \n. @return Scalar(average sharpness, average min brightness, average max brightness,0)' ... -def estimateTranslation3D(src: ndarray, dts: ndarray, out=..., inliers=..., ransacThreshold=..., confidence=...) -> typing.Any: +def estimateTranslation3D( + src: ndarray, + dts: ndarray, + out=..., + inliers=..., + ransacThreshold=..., + confidence=...) -> typing.Any: 'estimateTranslation3D(src, dst[, out[, inliers[, ransacThreshold[, confidence]]]]) -> retval, out, inliers\n. @brief Computes an optimal translation between two 3D point sets.\n. *\n. * It computes\n. * \\f[\n. * \\begin{bmatrix}\n. * x\\\\\n. * y\\\\\n. * z\\\\\n. * \\end{bmatrix}\n. * =\n. * \\begin{bmatrix}\n. * X\\\\\n. * Y\\\\\n. * Z\\\\\n. * \\end{bmatrix}\n. * +\n. * \\begin{bmatrix}\n. * b_1\\\\\n. * b_2\\\\\n. * b_3\\\\\n. * \\end{bmatrix}\n. * \\f]\n. *\n. * @param src First input 3D point set containing \\f$(X,Y,Z)\\f$.\n. * @param dst Second input 3D point set containing \\f$(x,y,z)\\f$.\n. * @param out Output 3D translation vector \\f$3 \\times 1\\f$ of the form\n. * \\f[\n. * \\begin{bmatrix}\n. * b_1 \\\\\n. * b_2 \\\\\n. * b_3 \\\\\n. * \\end{bmatrix}\n. * \\f]\n. * @param inliers Output vector indicating which points are inliers (1-inlier, 0-outlier).\n. * @param ransacThreshold Maximum reprojection error in the RANSAC algorithm to consider a point as\n. * an inlier.\n. * @param confidence Confidence level, between 0 and 1, for the estimated transformation. Anything\n. * between 0.95 and 0.99 is usually good enough. Values too close to 1 can slow down the estimation\n. * significantly. Values lower than 0.8-0.9 can result in an incorrectly estimated transformation.\n. *\n. * The function estimates an optimal 3D translation between two 3D point sets using the\n. * RANSAC algorithm.\n. *' ... @@ -2518,22 +2887,48 @@ def fastAtan2(y, x) -> typing.Any: ... -def fastNlMeansDenoising(src: ndarray, dts: ndarray = ..., h=..., templateWindowSize=..., searchWindowSize=...) -> typing.Any: +def fastNlMeansDenoising( + src: ndarray, + dts: ndarray = ..., + h=..., + templateWindowSize=..., + searchWindowSize=...) -> typing.Any: 'fastNlMeansDenoising(src[, dst[, h[, templateWindowSize[, searchWindowSize]]]]) -> dst\n. @brief Perform image denoising using Non-local Means Denoising algorithm\n. with several computational\n. optimizations. Noise expected to be a gaussian white noise\n. \n. @param src Input 8-bit 1-channel, 2-channel, 3-channel or 4-channel image.\n. @param dst Output image with the same size and type as src .\n. @param templateWindowSize Size in pixels of the template patch that is used to compute weights.\n. Should be odd. Recommended value 7 pixels\n. @param searchWindowSize Size in pixels of the window that is used to compute weighted average for\n. given pixel. Should be odd. Affect performance linearly: greater searchWindowsSize - greater\n. denoising time. Recommended value 21 pixels\n. @param h Parameter regulating filter strength. Big h value perfectly removes noise but also\n. removes image details, smaller h value preserves details but also preserves some noise\n. \n. This function expected to be applied to grayscale images. For colored images look at\n. fastNlMeansDenoisingColored. Advanced usage of this functions can be manual denoising of colored\n. image in different colorspaces. Such approach is used in fastNlMeansDenoisingColored by converting\n. image to CIELAB colorspace and then separately denoise L and AB components with different h\n. parameter.\n\n\n\nfastNlMeansDenoising(src, h[, dst[, templateWindowSize[, searchWindowSize[, normType]]]]) -> dst\n. @brief Perform image denoising using Non-local Means Denoising algorithm\n. with several computational\n. optimizations. Noise expected to be a gaussian white noise\n. \n. @param src Input 8-bit or 16-bit (only with NORM_L1) 1-channel,\n. 2-channel, 3-channel or 4-channel image.\n. @param dst Output image with the same size and type as src .\n. @param templateWindowSize Size in pixels of the template patch that is used to compute weights.\n. Should be odd. Recommended value 7 pixels\n. @param searchWindowSize Size in pixels of the window that is used to compute weighted average for\n. given pixel. Should be odd. Affect performance linearly: greater searchWindowsSize - greater\n. denoising time. Recommended value 21 pixels\n. @param h Array of parameters regulating filter strength, either one\n. parameter applied to all channels or one per channel in dst. Big h value\n. perfectly removes noise but also removes image details, smaller h\n. value preserves details but also preserves some noise\n. @param normType Type of norm used for weight calculation. Can be either NORM_L2 or NORM_L1\n. \n. This function expected to be applied to grayscale images. For colored images look at\n. fastNlMeansDenoisingColored. Advanced usage of this functions can be manual denoising of colored\n. image in different colorspaces. Such approach is used in fastNlMeansDenoisingColored by converting\n. image to CIELAB colorspace and then separately denoise L and AB components with different h\n. parameter.' ... -def fastNlMeansDenoisingColored(src: ndarray, dts: ndarray = ..., h=..., hColor=..., templateWindowSize=..., searchWindowSize=...) -> typing.Any: +def fastNlMeansDenoisingColored( + src: ndarray, + dts: ndarray = ..., + h=..., + hColor=..., + templateWindowSize=..., + searchWindowSize=...) -> typing.Any: 'fastNlMeansDenoisingColored(src[, dst[, h[, hColor[, templateWindowSize[, searchWindowSize]]]]]) -> dst\n. @brief Modification of fastNlMeansDenoising function for colored images\n. \n. @param src Input 8-bit 3-channel image.\n. @param dst Output image with the same size and type as src .\n. @param templateWindowSize Size in pixels of the template patch that is used to compute weights.\n. Should be odd. Recommended value 7 pixels\n. @param searchWindowSize Size in pixels of the window that is used to compute weighted average for\n. given pixel. Should be odd. Affect performance linearly: greater searchWindowsSize - greater\n. denoising time. Recommended value 21 pixels\n. @param h Parameter regulating filter strength for luminance component. Bigger h value perfectly\n. removes noise but also removes image details, smaller h value preserves details but also preserves\n. some noise\n. @param hColor The same as h but for color components. For most images value equals 10\n. will be enough to remove colored noise and do not distort colors\n. \n. The function converts image to CIELAB colorspace and then separately denoise L and AB components\n. with given h parameters using fastNlMeansDenoising function.' ... -def fastNlMeansDenoisingColoredMulti(srcImgs, imgToDenoiseIndex, temporalWindowSize, dts: ndarray = ..., h=..., hColor=..., templateWindowSize=..., searchWindowSize=...) -> typing.Any: +def fastNlMeansDenoisingColoredMulti( + srcImgs, + imgToDenoiseIndex, + temporalWindowSize, + dts: ndarray = ..., + h=..., + hColor=..., + templateWindowSize=..., + searchWindowSize=...) -> typing.Any: 'fastNlMeansDenoisingColoredMulti(srcImgs, imgToDenoiseIndex, temporalWindowSize[, dst[, h[, hColor[, templateWindowSize[, searchWindowSize]]]]]) -> dst\n. @brief Modification of fastNlMeansDenoisingMulti function for colored images sequences\n. \n. @param srcImgs Input 8-bit 3-channel images sequence. All images should have the same type and\n. size.\n. @param imgToDenoiseIndex Target image to denoise index in srcImgs sequence\n. @param temporalWindowSize Number of surrounding images to use for target image denoising. Should\n. be odd. Images from imgToDenoiseIndex - temporalWindowSize / 2 to\n. imgToDenoiseIndex - temporalWindowSize / 2 from srcImgs will be used to denoise\n. srcImgs[imgToDenoiseIndex] image.\n. @param dst Output image with the same size and type as srcImgs images.\n. @param templateWindowSize Size in pixels of the template patch that is used to compute weights.\n. Should be odd. Recommended value 7 pixels\n. @param searchWindowSize Size in pixels of the window that is used to compute weighted average for\n. given pixel. Should be odd. Affect performance linearly: greater searchWindowsSize - greater\n. denoising time. Recommended value 21 pixels\n. @param h Parameter regulating filter strength for luminance component. Bigger h value perfectly\n. removes noise but also removes image details, smaller h value preserves details but also preserves\n. some noise.\n. @param hColor The same as h but for color components.\n. \n. The function converts images to CIELAB colorspace and then separately denoise L and AB components\n. with given h parameters using fastNlMeansDenoisingMulti function.' ... -def fastNlMeansDenoisingMulti(srcImgs, imgToDenoiseIndex, temporalWindowSize, dts: ndarray = ..., h=..., templateWindowSize=..., searchWindowSize=...) -> typing.Any: +def fastNlMeansDenoisingMulti( + srcImgs, + imgToDenoiseIndex, + temporalWindowSize, + dts: ndarray = ..., + h=..., + templateWindowSize=..., + searchWindowSize=...) -> typing.Any: 'fastNlMeansDenoisingMulti(srcImgs, imgToDenoiseIndex, temporalWindowSize[, dst[, h[, templateWindowSize[, searchWindowSize]]]]) -> dst\n. @brief Modification of fastNlMeansDenoising function for images sequence where consecutive images have been\n. captured in small period of time. For example video. This version of the function is for grayscale\n. images or for manual manipulation with colorspaces. For more details see\n. \n. \n. @param srcImgs Input 8-bit 1-channel, 2-channel, 3-channel or\n. 4-channel images sequence. All images should have the same type and\n. size.\n. @param imgToDenoiseIndex Target image to denoise index in srcImgs sequence\n. @param temporalWindowSize Number of surrounding images to use for target image denoising. Should\n. be odd. Images from imgToDenoiseIndex - temporalWindowSize / 2 to\n. imgToDenoiseIndex - temporalWindowSize / 2 from srcImgs will be used to denoise\n. srcImgs[imgToDenoiseIndex] image.\n. @param dst Output image with the same size and type as srcImgs images.\n. @param templateWindowSize Size in pixels of the template patch that is used to compute weights.\n. Should be odd. Recommended value 7 pixels\n. @param searchWindowSize Size in pixels of the window that is used to compute weighted average for\n. given pixel. Should be odd. Affect performance linearly: greater searchWindowsSize - greater\n. denoising time. Recommended value 21 pixels\n. @param h Parameter regulating filter strength. Bigger h value\n. perfectly removes noise but also removes image details, smaller h\n. value preserves details but also preserves some noise\n\n\n\nfastNlMeansDenoisingMulti(srcImgs, imgToDenoiseIndex, temporalWindowSize, h[, dst[, templateWindowSize[, searchWindowSize[, normType]]]]) -> dst\n. @brief Modification of fastNlMeansDenoising function for images sequence where consecutive images have been\n. captured in small period of time. For example video. This version of the function is for grayscale\n. images or for manual manipulation with colorspaces. For more details see\n. \n. \n. @param srcImgs Input 8-bit or 16-bit (only with NORM_L1) 1-channel,\n. 2-channel, 3-channel or 4-channel images sequence. All images should\n. have the same type and size.\n. @param imgToDenoiseIndex Target image to denoise index in srcImgs sequence\n. @param temporalWindowSize Number of surrounding images to use for target image denoising. Should\n. be odd. Images from imgToDenoiseIndex - temporalWindowSize / 2 to\n. imgToDenoiseIndex - temporalWindowSize / 2 from srcImgs will be used to denoise\n. srcImgs[imgToDenoiseIndex] image.\n. @param dst Output image with the same size and type as srcImgs images.\n. @param templateWindowSize Size in pixels of the template patch that is used to compute weights.\n. Should be odd. Recommended value 7 pixels\n. @param searchWindowSize Size in pixels of the window that is used to compute weighted average for\n. given pixel. Should be odd. Affect performance linearly: greater searchWindowsSize - greater\n. denoising time. Recommended value 21 pixels\n. @param h Array of parameters regulating filter strength, either one\n. parameter applied to all channels or one per channel in dst. Big h value\n. perfectly removes noise but also removes image details, smaller h\n. value preserves details but also preserves some noise\n. @param normType Type of norm used for weight calculation. Can be either NORM_L2 or NORM_L1' ... @@ -2553,7 +2948,13 @@ def filter2D(src: ndarray, ddepth, kernel, dts: ndarray = ..., anchor=..., delta ... -def filterHomographyDecompByVisibleRefpoints(rotations, normals, beforePoints, afterPoints, possibleSolutions=..., pointsMask=...) -> typing.Any: +def filterHomographyDecompByVisibleRefpoints( + rotations, + normals, + beforePoints, + afterPoints, + possibleSolutions=..., + pointsMask=...) -> typing.Any: 'filterHomographyDecompByVisibleRefpoints(rotations, normals, beforePoints, afterPoints[, possibleSolutions[, pointsMask]]) -> possibleSolutions\n. @brief Filters homography decompositions based on additional information.\n. \n. @param rotations Vector of rotation matrices.\n. @param normals Vector of plane normal matrices.\n. @param beforePoints Vector of (rectified) visible reference points before the homography is applied\n. @param afterPoints Vector of (rectified) visible reference points after the homography is applied\n. @param possibleSolutions Vector of int indices representing the viable solution set after filtering\n. @param pointsMask optional Mat/Vector of 8u type representing the mask for the inliers as given by the findHomography function\n. \n. This function is intended to filter the output of the decomposeHomographyMat based on additional\n. information as described in @cite Malis . The summary of the method: the decomposeHomographyMat function\n. returns 2 unique solutions and their "opposites" for a total of 4 solutions. If we have access to the\n. sets of points visible in the camera frame before and after the homography transformation is applied,\n. we can determine which are the true potential solutions and which are the opposites by verifying which\n. homographies are consistent with all visible reference points being in front of the camera. The inputs\n. are left unchanged; the filtered solution set is returned as indices into the existing one.' ... @@ -2593,17 +2994,38 @@ def findContours(image: ndarray, mode, method: int, contours=..., hierarchy=..., ... -def findEssentialMat(points1, points2, cameraMatrix, method: int = ..., prob=..., threshold=..., mask: ndarray = ...) -> typing.Any: +def findEssentialMat( + points1, + points2, + cameraMatrix, + method: int = ..., + prob=..., + threshold=..., + mask: ndarray = ...) -> typing.Any: 'findEssentialMat(points1, points2, cameraMatrix[, method[, prob[, threshold[, mask]]]]) -> retval, mask\n. @brief Calculates an essential matrix from the corresponding points in two images.\n. \n. @param points1 Array of N (N \\>= 5) 2D points from the first image. The point coordinates should\n. be floating-point (single or double precision).\n. @param points2 Array of the second image points of the same size and format as points1 .\n. @param cameraMatrix Camera matrix \\f$K = \\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\\f$ .\n. Note that this function assumes that points1 and points2 are feature points from cameras with the\n. same camera matrix. If this assumption does not hold for your use case, use\n. `undistortPoints()` with `P = cv::NoArray()` for both cameras to transform image points\n. to normalized image coordinates, which are valid for the identity camera matrix. When\n. passing these coordinates, pass the identity matrix for this parameter.\n. @param method Method for computing an essential matrix.\n. - **RANSAC** for the RANSAC algorithm.\n. - **LMEDS** for the LMedS algorithm.\n. @param prob Parameter used for the RANSAC or LMedS methods only. It specifies a desirable level of\n. confidence (probability) that the estimated matrix is correct.\n. @param threshold Parameter used for RANSAC. It is the maximum distance from a point to an epipolar\n. line in pixels, beyond which the point is considered an outlier and is not used for computing the\n. final fundamental matrix. It can be set to something like 1-3, depending on the accuracy of the\n. point localization, image resolution, and the image noise.\n. @param mask Output array of N elements, every element of which is set to 0 for outliers and to 1\n. for the other points. The array is computed only in the RANSAC and LMedS methods.\n. \n. This function estimates essential matrix based on the five-point algorithm solver in @cite Nister03 .\n. @cite SteweniusCFS is also a related. The epipolar geometry is described by the following equation:\n. \n. \\f[[p_2; 1]^T K^{-T} E K^{-1} [p_1; 1] = 0\\f]\n. \n. where \\f$E\\f$ is an essential matrix, \\f$p_1\\f$ and \\f$p_2\\f$ are corresponding points in the first and the\n. second images, respectively. The result of this function may be passed further to\n. decomposeEssentialMat or recoverPose to recover the relative pose between cameras.\n\n\n\nfindEssentialMat(points1, points2[, focal[, pp[, method[, prob[, threshold[, mask]]]]]]) -> retval, mask\n. @overload\n. @param points1 Array of N (N \\>= 5) 2D points from the first image. The point coordinates should\n. be floating-point (single or double precision).\n. @param points2 Array of the second image points of the same size and format as points1 .\n. @param focal focal length of the camera. Note that this function assumes that points1 and points2\n. are feature points from cameras with same focal length and principal point.\n. @param pp principal point of the camera.\n. @param method Method for computing a fundamental matrix.\n. - **RANSAC** for the RANSAC algorithm.\n. - **LMEDS** for the LMedS algorithm.\n. @param threshold Parameter used for RANSAC. It is the maximum distance from a point to an epipolar\n. line in pixels, beyond which the point is considered an outlier and is not used for computing the\n. final fundamental matrix. It can be set to something like 1-3, depending on the accuracy of the\n. point localization, image resolution, and the image noise.\n. @param prob Parameter used for the RANSAC or LMedS methods only. It specifies a desirable level of\n. confidence (probability) that the estimated matrix is correct.\n. @param mask Output array of N elements, every element of which is set to 0 for outliers and to 1\n. for the other points. The array is computed only in the RANSAC and LMedS methods.\n. \n. This function differs from the one above that it computes camera matrix from focal length and\n. principal point:\n. \n. \\f[K =\n. \\begin{bmatrix}\n. f & 0 & x_{pp} \\\\\n. 0 & f & y_{pp} \\\\\n. 0 & 0 & 1\n. \\end{bmatrix}\\f]' ... -def findFundamentalMat(points1, points2, method: int, ransacReprojThreshold, confidence, maxIters, mask: ndarray = ...) -> typing.Any: +def findFundamentalMat( + points1, + points2, + method: int, + ransacReprojThreshold, + confidence, + maxIters, + mask: ndarray = ...) -> typing.Any: 'findFundamentalMat(points1, points2, method, ransacReprojThreshold, confidence, maxIters[, mask]) -> retval, mask\n. @brief Calculates a fundamental matrix from the corresponding points in two images.\n. \n. @param points1 Array of N points from the first image. The point coordinates should be\n. floating-point (single or double precision).\n. @param points2 Array of the second image points of the same size and format as points1 .\n. @param method Method for computing a fundamental matrix.\n. - **CV_FM_7POINT** for a 7-point algorithm. \\f$N = 7\\f$\n. - **CV_FM_8POINT** for an 8-point algorithm. \\f$N \\ge 8\\f$\n. - **CV_FM_RANSAC** for the RANSAC algorithm. \\f$N \\ge 8\\f$\n. - **CV_FM_LMEDS** for the LMedS algorithm. \\f$N \\ge 8\\f$\n. @param ransacReprojThreshold Parameter used only for RANSAC. It is the maximum distance from a point to an epipolar\n. line in pixels, beyond which the point is considered an outlier and is not used for computing the\n. final fundamental matrix. It can be set to something like 1-3, depending on the accuracy of the\n. point localization, image resolution, and the image noise.\n. @param confidence Parameter used for the RANSAC and LMedS methods only. It specifies a desirable level\n. of confidence (probability) that the estimated matrix is correct.\n. @param mask\n. @param maxIters The maximum number of robust method iterations.\n. \n. The epipolar geometry is described by the following equation:\n. \n. \\f[[p_2; 1]^T F [p_1; 1] = 0\\f]\n. \n. where \\f$F\\f$ is a fundamental matrix, \\f$p_1\\f$ and \\f$p_2\\f$ are corresponding points in the first and the\n. second images, respectively.\n. \n. The function calculates the fundamental matrix using one of four methods listed above and returns\n. the found fundamental matrix. Normally just one matrix is found. But in case of the 7-point\n. algorithm, the function may return up to 3 solutions ( \\f$9 \\times 3\\f$ matrix that stores all 3\n. matrices sequentially).\n. \n. The calculated fundamental matrix may be passed further to computeCorrespondEpilines that finds the\n. epipolar lines corresponding to the specified points. It can also be passed to\n. stereoRectifyUncalibrated to compute the rectification transformation. :\n. @code\n. // Example. Estimation of fundamental matrix using the RANSAC algorithm\n. int point_count = 100;\n. vector points1(point_count);\n. vector points2(point_count);\n. \n. // initialize the points here ...\n. for( int i = 0; i < point_count; i++ )\n. {\n. points1[i] = ...;\n. points2[i] = ...;\n. }\n. \n. Mat fundamental_matrix =\n. findFundamentalMat(points1, points2, FM_RANSAC, 3, 0.99);\n. @endcode\n\n\n\nfindFundamentalMat(points1, points2[, method[, ransacReprojThreshold[, confidence[, mask]]]]) -> retval, mask\n. @overload' ... -def findHomography(srcPoints, dstPoints, method: int = ..., ransacReprojThreshold=..., mask: ndarray = ..., maxIters=..., confidence=...) -> typing.Any: +def findHomography( + srcPoints, + dstPoints, + method: int = ..., + ransacReprojThreshold=..., + mask: ndarray = ..., + maxIters=..., + confidence=...) -> typing.Any: "findHomography(srcPoints, dstPoints[, method[, ransacReprojThreshold[, mask[, maxIters[, confidence]]]]]) -> retval, mask\n. @brief Finds a perspective transformation between two planes.\n. \n. @param srcPoints Coordinates of the points in the original plane, a matrix of the type CV_32FC2\n. or vector\\ .\n. @param dstPoints Coordinates of the points in the target plane, a matrix of the type CV_32FC2 or\n. a vector\\ .\n. @param method Method used to compute a homography matrix. The following methods are possible:\n. - **0** - a regular method using all the points, i.e., the least squares method\n. - **RANSAC** - RANSAC-based robust method\n. - **LMEDS** - Least-Median robust method\n. - **RHO** - PROSAC-based robust method\n. @param ransacReprojThreshold Maximum allowed reprojection error to treat a point pair as an inlier\n. (used in the RANSAC and RHO methods only). That is, if\n. \\f[\\| \\texttt{dstPoints} _i - \\texttt{convertPointsHomogeneous} ( \\texttt{H} * \\texttt{srcPoints} _i) \\|_2 > \\texttt{ransacReprojThreshold}\\f]\n. then the point \\f$i\\f$ is considered as an outlier. If srcPoints and dstPoints are measured in pixels,\n. it usually makes sense to set this parameter somewhere in the range of 1 to 10.\n. @param mask Optional output mask set by a robust method ( RANSAC or LMEDS ). Note that the input\n. mask values are ignored.\n. @param maxIters The maximum number of RANSAC iterations.\n. @param confidence Confidence level, between 0 and 1.\n. \n. The function finds and returns the perspective transformation \\f$H\\f$ between the source and the\n. destination planes:\n. \n. \\f[s_i \\vecthree{x'_i}{y'_i}{1} \\sim H \\vecthree{x_i}{y_i}{1}\\f]\n. \n. so that the back-projection error\n. \n. \\f[\\sum _i \\left ( x'_i- \\frac{h_{11} x_i + h_{12} y_i + h_{13}}{h_{31} x_i + h_{32} y_i + h_{33}} \\right )^2+ \\left ( y'_i- \\frac{h_{21} x_i + h_{22} y_i + h_{23}}{h_{31} x_i + h_{32} y_i + h_{33}} \\right )^2\\f]\n. \n. is minimized. If the parameter method is set to the default value 0, the function uses all the point\n. pairs to compute an initial homography estimate with a simple least-squares scheme.\n. \n. However, if not all of the point pairs ( \\f$srcPoints_i\\f$, \\f$dstPoints_i\\f$ ) fit the rigid perspective\n. transformation (that is, there are some outliers), this initial estimate will be poor. In this case,\n. you can use one of the three robust methods. The methods RANSAC, LMeDS and RHO try many different\n. random subsets of the corresponding point pairs (of four pairs each, collinear pairs are discarded), estimate the homography matrix\n. using this subset and a simple least-squares algorithm, and then compute the quality/goodness of the\n. computed homography (which is the number of inliers for RANSAC or the least median re-projection error for\n. LMeDS). The best subset is then used to produce the initial estimate of the homography matrix and\n. the mask of inliers/outliers.\n. \n. Regardless of the method, robust or not, the computed homography matrix is refined further (using\n. inliers only in case of a robust method) with the Levenberg-Marquardt method to reduce the\n. re-projection error even more.\n. \n. The methods RANSAC and RHO can handle practically any ratio of outliers but need a threshold to\n. distinguish inliers from outliers. The method LMeDS does not need any threshold but it works\n. correctly only when there are more than 50% of inliers. Finally, if there are no outliers and the\n. noise is rather small, use the default method (method=0).\n. \n. The function is used to find initial intrinsic and extrinsic matrices. Homography matrix is\n. determined up to a scale. Thus, it is normalized so that \\f$h_{33}=1\\f$. Note that whenever an \\f$H\\f$ matrix\n. cannot be estimated, an empty one will be returned.\n. \n. @sa\n. getAffineTransform, estimateAffine2D, estimateAffinePartial2D, getPerspectiveTransform, warpPerspective,\n. perspectiveTransform" ... @@ -2613,7 +3035,14 @@ def findNonZero(src: ndarray, idx=...) -> typing.Any: ... -def findTransformECC(templateImage, inputImage, warpMatrix, motionType, criteria, inputMask, gaussFiltSize) -> typing.Any: +def findTransformECC( + templateImage, + inputImage, + warpMatrix, + motionType, + criteria, + inputMask, + gaussFiltSize) -> typing.Any: "findTransformECC(templateImage, inputImage, warpMatrix, motionType, criteria, inputMask, gaussFiltSize) -> retval, warpMatrix\n. @brief Finds the geometric transform (warp) between two images in terms of the ECC criterion @cite EP08 .\n. \n. @param templateImage single-channel template image; CV_8U or CV_32F array.\n. @param inputImage single-channel input image which should be warped with the final warpMatrix in\n. order to provide an image similar to templateImage, same type as templateImage.\n. @param warpMatrix floating-point \\f$2\\times 3\\f$ or \\f$3\\times 3\\f$ mapping matrix (warp).\n. @param motionType parameter, specifying the type of motion:\n. - **MOTION_TRANSLATION** sets a translational motion model; warpMatrix is \\f$2\\times 3\\f$ with\n. the first \\f$2\\times 2\\f$ part being the unity matrix and the rest two parameters being\n. estimated.\n. - **MOTION_EUCLIDEAN** sets a Euclidean (rigid) transformation as motion model; three\n. parameters are estimated; warpMatrix is \\f$2\\times 3\\f$.\n. - **MOTION_AFFINE** sets an affine motion model (DEFAULT); six parameters are estimated;\n. warpMatrix is \\f$2\\times 3\\f$.\n. - **MOTION_HOMOGRAPHY** sets a homography as a motion model; eight parameters are\n. estimated;\\`warpMatrix\\` is \\f$3\\times 3\\f$.\n. @param criteria parameter, specifying the termination criteria of the ECC algorithm;\n. criteria.epsilon defines the threshold of the increment in the correlation coefficient between two\n. iterations (a negative criteria.epsilon makes criteria.maxcount the only termination criterion).\n. Default values are shown in the declaration above.\n. @param inputMask An optional mask to indicate valid values of inputImage.\n. @param gaussFiltSize An optional value indicating size of gaussian blur filter; (DEFAULT: 5)\n. \n. The function estimates the optimum transformation (warpMatrix) with respect to ECC criterion\n. (@cite EP08), that is\n. \n. \\f[\\texttt{warpMatrix} = \\arg\\max_{W} \\texttt{ECC}(\\texttt{templateImage}(x,y),\\texttt{inputImage}(x',y'))\\f]\n. \n. where\n. \n. \\f[\\begin{bmatrix} x' \\\\ y' \\end{bmatrix} = W \\cdot \\begin{bmatrix} x \\\\ y \\\\ 1 \\end{bmatrix}\\f]\n. \n. (the equation holds with homogeneous coordinates for homography). It returns the final enhanced\n. correlation coefficient, that is the correlation coefficient between the template image and the\n. final warped input image. When a \\f$3\\times 3\\f$ matrix is given with motionType =0, 1 or 2, the third\n. row is ignored.\n. \n. Unlike findHomography and estimateRigidTransform, the function findTransformECC implements an\n. area-based alignment that builds on intensity similarities. In essence, the function updates the\n. initial transformation that roughly aligns the images. If this information is missing, the identity\n. warp (unity matrix) is used as an initialization. Note that if images undergo strong\n. displacements/rotations, an initial transformation that roughly aligns the images is necessary\n. (e.g., a simple euclidean/similarity transform that allows for the images showing the same image\n. content approximately). Use inverse warping in the second image to take an image close to the first\n. one, i.e. use the flag WARP_INVERSE_MAP with warpAffine or warpPerspective. See also the OpenCV\n. sample image_alignment.cpp that demonstrates the use of the function. Note that the function throws\n. an exception if algorithm does not converges.\n. \n. @sa\n. computeECC, estimateAffine2D, estimateAffinePartial2D, findHomography" ... @@ -2646,7 +3075,14 @@ def flip(src: ndarray, flipCode, dts: ndarray = ...) -> typing.Any: ... -def floodFill(image: ndarray, mask: typing.Optional[ndarray], seedPoint, newVal, loDiff=..., upDiff=..., flags: int = ...) -> typing.Any: +def floodFill( + image: ndarray, + mask: typing.Optional[ndarray], + seedPoint, + newVal, + loDiff=..., + upDiff=..., + flags: int = ...) -> typing.Any: "floodFill(image, mask, seedPoint, newVal[, loDiff[, upDiff[, flags]]]) -> retval, image, mask, rect\n. @brief Fills a connected component with the given color.\n. \n. The function cv::floodFill fills a connected component starting from the seed point with the specified\n. color. The connectivity is determined by the color/brightness closeness of the neighbor pixels. The\n. pixel at \\f$(x,y)\\f$ is considered to belong to the repainted domain if:\n. \n. - in case of a grayscale image and floating range\n. \\f[\\texttt{src} (x',y')- \\texttt{loDiff} \\leq \\texttt{src} (x,y) \\leq \\texttt{src} (x',y')+ \\texttt{upDiff}\\f]\n. \n. \n. - in case of a grayscale image and fixed range\n. \\f[\\texttt{src} ( \\texttt{seedPoint} .x, \\texttt{seedPoint} .y)- \\texttt{loDiff} \\leq \\texttt{src} (x,y) \\leq \\texttt{src} ( \\texttt{seedPoint} .x, \\texttt{seedPoint} .y)+ \\texttt{upDiff}\\f]\n. \n. \n. - in case of a color image and floating range\n. \\f[\\texttt{src} (x',y')_r- \\texttt{loDiff} _r \\leq \\texttt{src} (x,y)_r \\leq \\texttt{src} (x',y')_r+ \\texttt{upDiff} _r,\\f]\n. \\f[\\texttt{src} (x',y')_g- \\texttt{loDiff} _g \\leq \\texttt{src} (x,y)_g \\leq \\texttt{src} (x',y')_g+ \\texttt{upDiff} _g\\f]\n. and\n. \\f[\\texttt{src} (x',y')_b- \\texttt{loDiff} _b \\leq \\texttt{src} (x,y)_b \\leq \\texttt{src} (x',y')_b+ \\texttt{upDiff} _b\\f]\n. \n. \n. - in case of a color image and fixed range\n. \\f[\\texttt{src} ( \\texttt{seedPoint} .x, \\texttt{seedPoint} .y)_r- \\texttt{loDiff} _r \\leq \\texttt{src} (x,y)_r \\leq \\texttt{src} ( \\texttt{seedPoint} .x, \\texttt{seedPoint} .y)_r+ \\texttt{upDiff} _r,\\f]\n. \\f[\\texttt{src} ( \\texttt{seedPoint} .x, \\texttt{seedPoint} .y)_g- \\texttt{loDiff} _g \\leq \\texttt{src} (x,y)_g \\leq \\texttt{src} ( \\texttt{seedPoint} .x, \\texttt{seedPoint} .y)_g+ \\texttt{upDiff} _g\\f]\n. and\n. \\f[\\texttt{src} ( \\texttt{seedPoint} .x, \\texttt{seedPoint} .y)_b- \\texttt{loDiff} _b \\leq \\texttt{src} (x,y)_b \\leq \\texttt{src} ( \\texttt{seedPoint} .x, \\texttt{seedPoint} .y)_b+ \\texttt{upDiff} _b\\f]\n. \n. \n. where \\f$src(x',y')\\f$ is the value of one of pixel neighbors that is already known to belong to the\n. component. That is, to be added to the connected component, a color/brightness of the pixel should\n. be close enough to:\n. - Color/brightness of one of its neighbors that already belong to the connected component in case\n. of a floating range.\n. - Color/brightness of the seed point in case of a fixed range.\n. \n. Use these functions to either mark a connected component with the specified color in-place, or build\n. a mask and then extract the contour, or copy the region to another image, and so on.\n. \n. @param image Input/output 1- or 3-channel, 8-bit, or floating-point image. It is modified by the\n. function unless the #FLOODFILL_MASK_ONLY flag is set in the second variant of the function. See\n. the details below.\n. @param mask Operation mask that should be a single-channel 8-bit image, 2 pixels wider and 2 pixels\n. taller than image. Since this is both an input and output parameter, you must take responsibility\n. of initializing it. Flood-filling cannot go across non-zero pixels in the input mask. For example,\n. an edge detector output can be used as a mask to stop filling at edges. On output, pixels in the\n. mask corresponding to filled pixels in the image are set to 1 or to the a value specified in flags\n. as described below. Additionally, the function fills the border of the mask with ones to simplify\n. internal processing. It is therefore possible to use the same mask in multiple calls to the function\n. to make sure the filled areas do not overlap.\n. @param seedPoint Starting point.\n. @param newVal New value of the repainted domain pixels.\n. @param loDiff Maximal lower brightness/color difference between the currently observed pixel and\n. one of its neighbors belonging to the component, or a seed pixel being added to the component.\n. @param upDiff Maximal upper brightness/color difference between the currently observed pixel and\n. one of its neighbors belonging to the component, or a seed pixel being added to the component.\n. @param rect Optional output parameter set by the function to the minimum bounding rectangle of the\n. repainted domain.\n. @param flags Operation flags. The first 8 bits contain a connectivity value. The default value of\n. 4 means that only the four nearest neighbor pixels (those that share an edge) are considered. A\n. connectivity value of 8 means that the eight nearest neighbor pixels (those that share a corner)\n. will be considered. The next 8 bits (8-16) contain a value between 1 and 255 with which to fill\n. the mask (the default value is 1). For example, 4 | ( 255 \\<\\< 8 ) will consider 4 nearest\n. neighbours and fill the mask with a value of 255. The following additional options occupy higher\n. bits and therefore may be further combined with the connectivity and mask fill values using\n. bit-wise or (|), see #FloodFillFlags.\n. \n. @note Since the mask is larger than the filled image, a pixel \\f$(x, y)\\f$ in image corresponds to the\n. pixel \\f$(x+1, y+1)\\f$ in the mask .\n. \n. @sa findContours" ... @@ -2721,7 +3157,13 @@ def getOptimalDFTSize(vecsize) -> typing.Any: ... -def getOptimalNewCameraMatrix(cameraMatrix, distCoeffs, imageSize, alpha, newImgSize=..., centerPrincipalPoint=...) -> typing.Any: +def getOptimalNewCameraMatrix( + cameraMatrix, + distCoeffs, + imageSize, + alpha, + newImgSize=..., + centerPrincipalPoint=...) -> typing.Any: 'getOptimalNewCameraMatrix(cameraMatrix, distCoeffs, imageSize, alpha[, newImgSize[, centerPrincipalPoint]]) -> retval, validPixROI\n. @brief Returns the new camera matrix based on the free scaling parameter.\n. \n. @param cameraMatrix Input camera matrix.\n. @param distCoeffs Input vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$ of\n. 4, 5, 8, 12 or 14 elements. If the vector is NULL/empty, the zero distortion coefficients are\n. assumed.\n. @param imageSize Original image size.\n. @param alpha Free scaling parameter between 0 (when all the pixels in the undistorted image are\n. valid) and 1 (when all the source image pixels are retained in the undistorted image). See\n. stereoRectify for details.\n. @param newImgSize Image size after rectification. By default, it is set to imageSize .\n. @param validPixROI Optional output rectangle that outlines all-good-pixels region in the\n. undistorted image. See roi1, roi2 description in stereoRectify .\n. @param centerPrincipalPoint Optional flag that indicates whether in the new camera matrix the\n. principal point should be at the image center or not. By default, the principal point is chosen to\n. best fit a subset of the source image (determined by alpha) to the corrected image.\n. @return new_camera_matrix Output new camera matrix.\n. \n. The function computes and returns the optimal new camera matrix based on the free scaling parameter.\n. By varying this parameter, you may retrieve only sensible pixels alpha=0 , keep all the original\n. image pixels if there is valuable information in the corners alpha=1 , or get something in between.\n. When alpha\\>0 , the undistorted result is likely to have some black pixels corresponding to\n. "virtual" pixels outside of the captured distorted image. The original camera matrix, distortion\n. coefficients, the computed new camera matrix, and newImageSize should be passed to\n. initUndistortRectifyMap to produce the maps for remap .' ... @@ -2806,7 +3248,16 @@ def getWindowProperty(winname, prop_id) -> typing.Any: ... -def goodFeaturesToTrack(image: ndarray, maxCorners, qualityLevel, minDistance, corners=..., mask: ndarray = ..., blockSize=..., useHarrisDetector=..., k=...) -> typing.Any: +def goodFeaturesToTrack( + image: ndarray, + maxCorners, + qualityLevel, + minDistance, + corners=..., + mask: ndarray = ..., + blockSize=..., + useHarrisDetector=..., + k=...) -> typing.Any: 'goodFeaturesToTrack(image, maxCorners, qualityLevel, minDistance[, corners[, mask[, blockSize[, useHarrisDetector[, k]]]]]) -> corners\n. @brief Determines strong corners on an image.\n. \n. The function finds the most prominent corners in the image or in the specified image region, as\n. described in @cite Shi94\n. \n. - Function calculates the corner quality measure at every source image pixel using the\n. #cornerMinEigenVal or #cornerHarris .\n. - Function performs a non-maximum suppression (the local maximums in *3 x 3* neighborhood are\n. retained).\n. - The corners with the minimal eigenvalue less than\n. \\f$\\texttt{qualityLevel} \\cdot \\max_{x,y} qualityMeasureMap(x,y)\\f$ are rejected.\n. - The remaining corners are sorted by the quality measure in the descending order.\n. - Function throws away each corner for which there is a stronger corner at a distance less than\n. maxDistance.\n. \n. The function can be used to initialize a point-based tracker of an object.\n. \n. @note If the function is called with different values A and B of the parameter qualityLevel , and\n. A \\> B, the vector of returned corners with qualityLevel=A will be the prefix of the output vector\n. with qualityLevel=B .\n. \n. @param image Input 8-bit or floating-point 32-bit, single-channel image.\n. @param corners Output vector of detected corners.\n. @param maxCorners Maximum number of corners to return. If there are more corners than are found,\n. the strongest of them is returned. `maxCorners <= 0` implies that no limit on the maximum is set\n. and all detected corners are returned.\n. @param qualityLevel Parameter characterizing the minimal accepted quality of image corners. The\n. parameter value is multiplied by the best corner quality measure, which is the minimal eigenvalue\n. (see #cornerMinEigenVal ) or the Harris function response (see #cornerHarris ). The corners with the\n. quality measure less than the product are rejected. For example, if the best corner has the\n. quality measure = 1500, and the qualityLevel=0.01 , then all the corners with the quality measure\n. less than 15 are rejected.\n. @param minDistance Minimum possible Euclidean distance between the returned corners.\n. @param mask Optional region of interest. If the image is not empty (it needs to have the type\n. CV_8UC1 and the same size as image ), it specifies the region in which the corners are detected.\n. @param blockSize Size of an average block for computing a derivative covariation matrix over each\n. pixel neighborhood. See cornerEigenValsAndVecs .\n. @param useHarrisDetector Parameter indicating whether to use a Harris detector (see #cornerHarris)\n. or #cornerMinEigenVal.\n. @param k Free parameter of the Harris detector.\n. \n. @sa cornerMinEigenVal, cornerHarris, calcOpticalFlowPyrLK, estimateRigidTransform,\n\n\n\ngoodFeaturesToTrack(image, maxCorners, qualityLevel, minDistance, mask, blockSize, gradientSize[, corners[, useHarrisDetector[, k]]]) -> corners\n.' ... @@ -2896,7 +3347,15 @@ def initCameraMatrix2D(objectPoints, imagePoints, imageSize, aspectRatio=...) -> ... -def initUndistortRectifyMap(cameraMatrix, distCoeffs, R, newCameraMatrix, size, m1type, map1=..., map2=...) -> typing.Any: +def initUndistortRectifyMap( + cameraMatrix, + distCoeffs, + R, + newCameraMatrix, + size, + m1type, + map1=..., + map2=...) -> typing.Any: "initUndistortRectifyMap(cameraMatrix, distCoeffs, R, newCameraMatrix, size, m1type[, map1[, map2]]) -> map1, map2\n. @brief Computes the undistortion and rectification transformation map.\n. \n. The function computes the joint undistortion and rectification transformation and represents the\n. result in the form of maps for remap. The undistorted image looks like original, as if it is\n. captured with a camera using the camera matrix =newCameraMatrix and zero distortion. In case of a\n. monocular camera, newCameraMatrix is usually equal to cameraMatrix, or it can be computed by\n. #getOptimalNewCameraMatrix for a better control over scaling. In case of a stereo camera,\n. newCameraMatrix is normally set to P1 or P2 computed by #stereoRectify .\n. \n. Also, this new camera is oriented differently in the coordinate space, according to R. That, for\n. example, helps to align two heads of a stereo camera so that the epipolar lines on both images\n. become horizontal and have the same y- coordinate (in case of a horizontally aligned stereo camera).\n. \n. The function actually builds the maps for the inverse mapping algorithm that is used by remap. That\n. is, for each pixel \\f$(u, v)\\f$ in the destination (corrected and rectified) image, the function\n. computes the corresponding coordinates in the source image (that is, in the original image from\n. camera). The following process is applied:\n. \\f[\n. \\begin{array}{l}\n. x \\leftarrow (u - {c'}_x)/{f'}_x \\\\\n. y \\leftarrow (v - {c'}_y)/{f'}_y \\\\\n. {[X\\,Y\\,W]} ^T \\leftarrow R^{-1}*[x \\, y \\, 1]^T \\\\\n. x' \\leftarrow X/W \\\\\n. y' \\leftarrow Y/W \\\\\n. r^2 \\leftarrow x'^2 + y'^2 \\\\\n. x'' \\leftarrow x' \\frac{1 + k_1 r^2 + k_2 r^4 + k_3 r^6}{1 + k_4 r^2 + k_5 r^4 + k_6 r^6}\n. + 2p_1 x' y' + p_2(r^2 + 2 x'^2) + s_1 r^2 + s_2 r^4\\\\\n. y'' \\leftarrow y' \\frac{1 + k_1 r^2 + k_2 r^4 + k_3 r^6}{1 + k_4 r^2 + k_5 r^4 + k_6 r^6}\n. + p_1 (r^2 + 2 y'^2) + 2 p_2 x' y' + s_3 r^2 + s_4 r^4 \\\\\n. s\\vecthree{x'''}{y'''}{1} =\n. \\vecthreethree{R_{33}(\\tau_x, \\tau_y)}{0}{-R_{13}((\\tau_x, \\tau_y)}\n. {0}{R_{33}(\\tau_x, \\tau_y)}{-R_{23}(\\tau_x, \\tau_y)}\n. {0}{0}{1} R(\\tau_x, \\tau_y) \\vecthree{x''}{y''}{1}\\\\\n. map_x(u,v) \\leftarrow x''' f_x + c_x \\\\\n. map_y(u,v) \\leftarrow y''' f_y + c_y\n. \\end{array}\n. \\f]\n. where \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6[, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$\n. are the distortion coefficients.\n. \n. In case of a stereo camera, this function is called twice: once for each camera head, after\n. stereoRectify, which in its turn is called after #stereoCalibrate. But if the stereo camera\n. was not calibrated, it is still possible to compute the rectification transformations directly from\n. the fundamental matrix using #stereoRectifyUncalibrated. For each camera, the function computes\n. homography H as the rectification transformation in a pixel domain, not a rotation matrix R in 3D\n. space. R can be computed from H as\n. \\f[\\texttt{R} = \\texttt{cameraMatrix} ^{-1} \\cdot \\texttt{H} \\cdot \\texttt{cameraMatrix}\\f]\n. where cameraMatrix can be chosen arbitrarily.\n. \n. @param cameraMatrix Input camera matrix \\f$A=\\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\\f$ .\n. @param distCoeffs Input vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6[, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$\n. of 4, 5, 8, 12 or 14 elements. If the vector is NULL/empty, the zero distortion coefficients are assumed.\n. @param R Optional rectification transformation in the object space (3x3 matrix). R1 or R2 ,\n. computed by #stereoRectify can be passed here. If the matrix is empty, the identity transformation\n. is assumed. In cvInitUndistortMap R assumed to be an identity matrix.\n. @param newCameraMatrix New camera matrix \\f$A'=\\vecthreethree{f_x'}{0}{c_x'}{0}{f_y'}{c_y'}{0}{0}{1}\\f$.\n. @param size Undistorted image size.\n. @param m1type Type of the first output map that can be CV_32FC1, CV_32FC2 or CV_16SC2, see #convertMaps\n. @param map1 The first output map.\n. @param map2 The second output map." ... @@ -2986,7 +3445,12 @@ def matchShapes(contour1, contour2, method: int, parameter) -> typing.Any: ... -def matchTemplate(image: ndarray, templ: ndarray, method: int, result: ndarray = ..., mask: typing.Optional[ndarray] = ...) -> ndarray: +def matchTemplate( + image: ndarray, + templ: ndarray, + method: int, + result: ndarray = ..., + mask: typing.Optional[ndarray] = ...) -> ndarray: "matchTemplate(image, templ, method[, result[, mask]]) -> result\n. @brief Compares a template against overlapped image regions.\n. \n. The function slides through image , compares the overlapped patches of size \\f$w \\times h\\f$ against\n. templ using the specified method and stores the comparison results in result . #TemplateMatchModes\n. describes the formulae for the available comparison methods ( \\f$I\\f$ denotes image, \\f$T\\f$\n. template, \\f$R\\f$ result, \\f$M\\f$ the optional mask ). The summation is done over template and/or\n. the image patch: \\f$x' = 0...w-1, y' = 0...h-1\\f$\n. \n. After the function finishes the comparison, the best matches can be found as global minimums (when\n. #TM_SQDIFF was used) or maximums (when #TM_CCORR or #TM_CCOEFF was used) using the\n. #minMaxLoc function. In case of a color image, template summation in the numerator and each sum in\n. the denominator is done over all of the channels and separate mean values are used for each channel.\n. That is, the function can take a color template and a color image. The result will still be a\n. single-channel image, which is easier to analyze.\n. \n. @param image Image where the search is running. It must be 8-bit or 32-bit floating-point.\n. @param templ Searched template. It must be not greater than the source image and have the same\n. data type.\n. @param result Map of comparison results. It must be single-channel 32-bit floating-point. If image\n. is \\f$W \\times H\\f$ and templ is \\f$w \\times h\\f$ , then result is \\f$(W-w+1) \\times (H-h+1)\\f$ .\n. @param method Parameter specifying the comparison method, see #TemplateMatchModes\n. @param mask Optional mask. It must have the same size as templ. It must either have the same number\n. of channels as template or only one channel, which is then used for all template and\n. image channels. If the data type is #CV_8U, the mask is interpreted as a binary mask,\n. meaning only elements where mask is nonzero are used and are kept unchanged independent\n. of the actual mask value (weight equals 1). For data tpye #CV_32F, the mask values are\n. used as weights. The exact formulas are documented in #TemplateMatchModes." ... @@ -3041,7 +3505,8 @@ def minEnclosingTriangle(points, triangle=...) -> typing.Any: ... -def minMaxLoc(src: ndarray, mask: ndarray = ...) -> typing.Tuple[float, float, typing.Tuple[int, int], typing.Tuple[int, int]]: +def minMaxLoc(src: ndarray, mask: ndarray = ...) -> typing.Tuple[float, + float, typing.Tuple[int, int], typing.Tuple[int, int]]: 'minMaxLoc(src[, mask]) -> minVal, maxVal, minLoc, maxLoc\n. @brief Finds the global minimum and maximum in an array.\n. \n. The function cv::minMaxLoc finds the minimum and maximum element values and their positions. The\n. extremums are searched across the whole array or, if mask is not an empty array, in the specified\n. array region.\n. \n. The function do not work with multi-channel arrays. If you need to find minimum or maximum\n. elements across all the channels, use Mat::reshape first to reinterpret the array as\n. single-channel. Or you may extract the particular channel using either extractImageCOI , or\n. mixChannels , or split .\n. @param src input single-channel array.\n. @param minVal pointer to the returned minimum value; NULL is used if not required.\n. @param maxVal pointer to the returned maximum value; NULL is used if not required.\n. @param minLoc pointer to the returned minimum location (in 2D case); NULL is used if not required.\n. @param maxLoc pointer to the returned maximum location (in 2D case); NULL is used if not required.\n. @param mask optional mask used to select a sub-array.\n. @sa max, min, compare, inRange, extractImageCOI, mixChannels, split, Mat::reshape' ... @@ -3071,7 +3536,15 @@ def moments(array, binaryImage=...) -> typing.Any: ... -def morphologyEx(src: ndarray, op, kernel, dts: ndarray = ..., anchor=..., iterations=..., borderType=..., borderValue=...) -> typing.Any: +def morphologyEx( + src: ndarray, + op, + kernel, + dts: ndarray = ..., + anchor=..., + iterations=..., + borderType=..., + borderValue=...) -> typing.Any: 'morphologyEx(src, op, kernel[, dst[, anchor[, iterations[, borderType[, borderValue]]]]]) -> dst\n. @brief Performs advanced morphological transformations.\n. \n. The function cv::morphologyEx can perform advanced morphological transformations using an erosion and dilation as\n. basic operations.\n. \n. Any of the operations can be done in-place. In case of multi-channel images, each channel is\n. processed independently.\n. \n. @param src Source image. The number of channels can be arbitrary. The depth should be one of\n. CV_8U, CV_16U, CV_16S, CV_32F or CV_64F.\n. @param dst Destination image of the same size and type as source image.\n. @param op Type of a morphological operation, see #MorphTypes\n. @param kernel Structuring element. It can be created using #getStructuringElement.\n. @param anchor Anchor position with the kernel. Negative values mean that the anchor is at the\n. kernel center.\n. @param iterations Number of times erosion and dilation are applied.\n. @param borderType Pixel extrapolation method, see #BorderTypes. #BORDER_WRAP is not supported.\n. @param borderValue Border value in case of a constant border. The default value has a special\n. meaning.\n. @sa dilate, erode, getStructuringElement\n. @note The number of iterations is the number of times erosion or dilatation operation will be applied.\n. For instance, an opening operation (#MORPH_OPEN) with two iterations is equivalent to apply\n. successively: erode -> erode -> dilate -> dilate (and not erode -> dilate -> erode -> dilate).' ... @@ -3106,7 +3579,14 @@ def norm(src1: ndarray, src2: ndarray, normType: int = ..., mask: ndarray = ...) ... -def normalize(src: ndarray, dts: ndarray, alpha=..., beta=..., normType: int = ..., dtype=..., mask: ndarray = ...) -> ndarray: +def normalize( + src: ndarray, + dts: ndarray, + alpha=..., + beta=..., + normType: int = ..., + dtype=..., + mask: ndarray = ...) -> ndarray: 'normalize(src, dst[, alpha[, beta[, normType[, dtype[, mask]]]]]) -> dst\n. @brief Normalizes the norm or value range of an array.\n. \n. The function cv::normalize normalizes scale and shift the input array elements so that\n. \\f[\\| \\texttt{dst} \\| _{L_p}= \\texttt{alpha}\\f]\n. (where p=Inf, 1 or 2) when normType=NORM_INF, NORM_L1, or NORM_L2, respectively; or so that\n. \\f[\\min _I \\texttt{dst} (I)= \\texttt{alpha} , \\, \\, \\max _I \\texttt{dst} (I)= \\texttt{beta}\\f]\n. \n. when normType=NORM_MINMAX (for dense arrays only). The optional mask specifies a sub-array to be\n. normalized. This means that the norm or min-n-max are calculated over the sub-array, and then this\n. sub-array is modified to be normalized. If you want to only use the mask to calculate the norm or\n. min-max but modify the whole array, you can use norm and Mat::convertTo.\n. \n. In case of sparse matrices, only the non-zero values are analyzed and transformed. Because of this,\n. the range transformation for sparse matrices is not allowed since it can shift the zero level.\n. \n. Possible usage with some positive example data:\n. @code{.cpp}\n. vector positiveData = { 2.0, 8.0, 10.0 };\n. vector normalizedData_l1, normalizedData_l2, normalizedData_inf, normalizedData_minmax;\n. \n. // Norm to probability (total count)\n. // sum(numbers) = 20.0\n. // 2.0 0.1 (2.0/20.0)\n. // 8.0 0.4 (8.0/20.0)\n. // 10.0 0.5 (10.0/20.0)\n. normalize(positiveData, normalizedData_l1, 1.0, 0.0, NORM_L1);\n. \n. // Norm to unit vector: ||positiveData|| = 1.0\n. // 2.0 0.15\n. // 8.0 0.62\n. // 10.0 0.77\n. normalize(positiveData, normalizedData_l2, 1.0, 0.0, NORM_L2);\n. \n. // Norm to max element\n. // 2.0 0.2 (2.0/10.0)\n. // 8.0 0.8 (8.0/10.0)\n. // 10.0 1.0 (10.0/10.0)\n. normalize(positiveData, normalizedData_inf, 1.0, 0.0, NORM_INF);\n. \n. // Norm to range [0.0;1.0]\n. // 2.0 0.0 (shift to left border)\n. // 8.0 0.75 (6.0/8.0)\n. // 10.0 1.0 (shift to right border)\n. normalize(positiveData, normalizedData_minmax, 1.0, 0.0, NORM_MINMAX);\n. @endcode\n. \n. @param src input array.\n. @param dst output array of the same size as src .\n. @param alpha norm value to normalize to or the lower range boundary in case of the range\n. normalization.\n. @param beta upper range boundary in case of the range normalization; it is not used for the norm\n. normalization.\n. @param normType normalization type (see cv::NormTypes).\n. @param dtype when negative, the output array has the same type as src; otherwise, it has the same\n. number of channels as src and the depth =CV_MAT_DEPTH(dtype).\n. @param mask optional operation mask.\n. @sa norm, Mat::convertTo, SparseMat::convertTo' ... @@ -3119,7 +3599,13 @@ def patchNaNs(a, val=...) -> typing.Any: ... -def pencilSketch(src: ndarray, dts1: ndarray = ..., dts2: ndarray = ..., sigma_s=..., sigma_r=..., shade_factor=...) -> typing.Any: +def pencilSketch( + src: ndarray, + dts1: ndarray = ..., + dts2: ndarray = ..., + sigma_s=..., + sigma_r=..., + shade_factor=...) -> typing.Any: 'pencilSketch(src[, dst1[, dst2[, sigma_s[, sigma_r[, shade_factor]]]]]) -> dst1, dst2\n. @brief Pencil-like non-photorealistic line drawing\n. \n. @param src Input 8-bit 3-channel image.\n. @param dst1 Output 8-bit 1-channel image.\n. @param dst2 Output image with the same size and type as src.\n. @param sigma_s %Range between 0 to 200.\n. @param sigma_r %Range between 0 to 1.\n. @param shade_factor %Range between 0 to 0.1.' ... @@ -3164,12 +3650,29 @@ def preCornerDetect(src: ndarray, ksize, dts: ndarray = ..., borderType=...) -> ... -def projectPoints(objectPoints, rvec, tvec, cameraMatrix, distCoeffs, imagePoints=..., jacobian=..., aspectRatio=...) -> typing.Any: +def projectPoints( + objectPoints, + rvec, + tvec, + cameraMatrix, + distCoeffs, + imagePoints=..., + jacobian=..., + aspectRatio=...) -> typing.Any: 'projectPoints(objectPoints, rvec, tvec, cameraMatrix, distCoeffs[, imagePoints[, jacobian[, aspectRatio]]]) -> imagePoints, jacobian\n. @brief Projects 3D points to an image plane.\n. \n. @param objectPoints Array of object points expressed wrt. the world coordinate frame. A 3xN/Nx3\n. 1-channel or 1xN/Nx1 3-channel (or vector\\ ), where N is the number of points in the view.\n. @param rvec The rotation vector (@ref Rodrigues) that, together with tvec, performs a change of\n. basis from world to camera coordinate system, see @ref calibrateCamera for details.\n. @param tvec The translation vector, see parameter description above.\n. @param cameraMatrix Camera matrix \\f$A = \\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{_1}\\f$ .\n. @param distCoeffs Input vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$ of\n. 4, 5, 8, 12 or 14 elements. If the vector is empty, the zero distortion coefficients are assumed.\n. @param imagePoints Output array of image points, 1xN/Nx1 2-channel, or\n. vector\\ .\n. @param jacobian Optional output 2Nx(10+\\) jacobian matrix of derivatives of image\n. points with respect to components of the rotation vector, translation vector, focal lengths,\n. coordinates of the principal point and the distortion coefficients. In the old interface different\n. components of the jacobian are returned via different output parameters.\n. @param aspectRatio Optional "fixed aspect ratio" parameter. If the parameter is not 0, the\n. function assumes that the aspect ratio (\\f$f_x / f_y\\f$) is fixed and correspondingly adjusts the\n. jacobian matrix.\n. \n. The function computes the 2D projections of 3D points to the image plane, given intrinsic and\n. extrinsic camera parameters. Optionally, the function computes Jacobians -matrices of partial\n. derivatives of image points coordinates (as functions of all the input parameters) with respect to\n. the particular parameters, intrinsic and/or extrinsic. The Jacobians are used during the global\n. optimization in @ref calibrateCamera, @ref solvePnP, and @ref stereoCalibrate. The function itself\n. can also be used to compute a re-projection error, given the current intrinsic and extrinsic\n. parameters.\n. \n. @note By setting rvec = tvec = \\f$[0, 0, 0]\\f$, or by setting cameraMatrix to a 3x3 identity matrix,\n. or by passing zero distortion coefficients, one can get various useful partial cases of the\n. function. This means, one can compute the distorted coordinates for a sparse set of points or apply\n. a perspective transformation (and also compute the derivatives) in the ideal zero-distortion setup.' ... -def putText(img: ndarray, text, org, fontFace, fontScale, color, thickness=..., lineType=..., bottomLeftOrigin=...) -> typing.Any: +def putText( + img: ndarray, + text, + org, + fontFace, + fontScale, + color, + thickness=..., + lineType=..., + bottomLeftOrigin=...) -> typing.Any: 'putText(img, text, org, fontFace, fontScale, color[, thickness[, lineType[, bottomLeftOrigin]]]) -> img\n. @brief Draws a text string.\n. \n. The function cv::putText renders the specified text string in the image. Symbols that cannot be rendered\n. using the specified font are replaced by question marks. See #getTextSize for a text rendering code\n. example.\n. \n. @param img Image.\n. @param text Text string to be drawn.\n. @param org Bottom-left corner of the text string in the image.\n. @param fontFace Font type, see #HersheyFonts.\n. @param fontScale Font scale factor that is multiplied by the font-specific base size.\n. @param color Text color.\n. @param thickness Thickness of the lines used to draw a text.\n. @param lineType Line type. See #LineTypes\n. @param bottomLeftOrigin When true, the image data origin is at the bottom-left corner. Otherwise,\n. it is at the top-left corner.' ... @@ -3219,7 +3722,30 @@ def rectangle(img: ndarray, pt1, pt2, color, thickness=..., lineType=..., shift= ... -def rectify3Collinear(cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, cameraMatrix3, distCoeffs3, imgpt1, imgpt3, imageSize, R12, T12, R13, T13, alpha, newImgSize, flags: int, R1=..., R2=..., R3=..., P1=..., P2=..., P3=..., Q=...) -> typing.Any: +def rectify3Collinear( + cameraMatrix1, + distCoeffs1, + cameraMatrix2, + distCoeffs2, + cameraMatrix3, + distCoeffs3, + imgpt1, + imgpt3, + imageSize, + R12, + T12, + R13, + T13, + alpha, + newImgSize, + flags: int, + R1=..., + R2=..., + R3=..., + P1=..., + P2=..., + P3=..., + Q=...) -> typing.Any: 'rectify3Collinear(cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, cameraMatrix3, distCoeffs3, imgpt1, imgpt3, imageSize, R12, T12, R13, T13, alpha, newImgSize, flags[, R1[, R2[, R3[, P1[, P2[, P3[, Q]]]]]]]) -> retval, R1, R2, R3, P1, P2, P3, Q, roi1, roi2\n.' ... @@ -3234,7 +3760,14 @@ def reduce(src: ndarray, dim, rtype, dts: ndarray = ..., dtype=...) -> typing.An ... -def remap(src: ndarray, map1, map2, interpolation: int, dts: ndarray = ..., borderMode=..., borderValue=...) -> typing.Any: +def remap( + src: ndarray, + map1, + map2, + interpolation: int, + dts: ndarray = ..., + borderMode=..., + borderValue=...) -> typing.Any: 'remap(src, map1, map2, interpolation[, dst[, borderMode[, borderValue]]]) -> dst\n. @brief Applies a generic geometrical transformation to an image.\n. \n. The function remap transforms the source image using the specified map:\n. \n. \\f[\\texttt{dst} (x,y) = \\texttt{src} (map_x(x,y),map_y(x,y))\\f]\n. \n. where values of pixels with non-integer coordinates are computed using one of available\n. interpolation methods. \\f$map_x\\f$ and \\f$map_y\\f$ can be encoded as separate floating-point maps\n. in \\f$map_1\\f$ and \\f$map_2\\f$ respectively, or interleaved floating-point maps of \\f$(x,y)\\f$ in\n. \\f$map_1\\f$, or fixed-point maps created by using convertMaps. The reason you might want to\n. convert from floating to fixed-point representations of a map is that they can yield much faster\n. (\\~2x) remapping operations. In the converted case, \\f$map_1\\f$ contains pairs (cvFloor(x),\n. cvFloor(y)) and \\f$map_2\\f$ contains indices in a table of interpolation coefficients.\n. \n. This function cannot operate in-place.\n. \n. @param src Source image.\n. @param dst Destination image. It has the same size as map1 and the same type as src .\n. @param map1 The first map of either (x,y) points or just x values having the type CV_16SC2 ,\n. CV_32FC1, or CV_32FC2. See convertMaps for details on converting a floating point\n. representation to fixed-point for speed.\n. @param map2 The second map of y values having the type CV_16UC1, CV_32FC1, or none (empty map\n. if map1 is (x,y) points), respectively.\n. @param interpolation Interpolation method (see #InterpolationFlags). The method #INTER_AREA is\n. not supported by this function.\n. @param borderMode Pixel extrapolation method (see #BorderTypes). When\n. borderMode=#BORDER_TRANSPARENT, it means that the pixels in the destination image that\n. corresponds to the "outliers" in the source image are not modified by the function.\n. @param borderValue Value used in case of a constant border. By default, it is 0.\n. @note\n. Due to current implementation limitations the size of an input and output images should be less than 32767x32767.' ... @@ -3249,7 +3782,8 @@ def reprojectImageTo3D(disparity, Q, _3dImage=..., handleMissingValues=..., ddep ... -def resize(src: ndarray, dsize: typing.Tuple[int, int], dts: ndarray = ..., fx: int = ..., fy: int = ..., interpolation: int = ...) -> ndarray: +def resize(src: ndarray, dsize: typing.Tuple[int, int], dts: ndarray = ..., + fx: int = ..., fy: int = ..., interpolation: int = ...) -> ndarray: 'resize(src, dsize[, dst[, fx[, fy[, interpolation]]]]) -> dst\n. @brief Resizes an image.\n. \n. The function resize resizes the image src down to or up to the specified size. Note that the\n. initial dst type or size are not taken into account. Instead, the size and type are derived from\n. the `src`,`dsize`,`fx`, and `fy`. If you want to resize src so that it fits the pre-created dst,\n. you may call the function as follows:\n. @code\n. // explicitly specify dsize=dst.size(); fx and fy will be computed from that.\n. resize(src, dst, dst.size(), 0, 0, interpolation);\n. @endcode\n. If you want to decimate the image by factor of 2 in each direction, you can call the function this\n. way:\n. @code\n. // specify fx and fy and let the function compute the destination image size.\n. resize(src, dst, Size(), 0.5, 0.5, interpolation);\n. @endcode\n. To shrink an image, it will generally look best with #INTER_AREA interpolation, whereas to\n. enlarge an image, it will generally look best with c#INTER_CUBIC (slow) or #INTER_LINEAR\n. (faster but still looks OK).\n. \n. @param src input image.\n. @param dst output image; it has the size dsize (when it is non-zero) or the size computed from\n. src.size(), fx, and fy; the type of dst is the same as of src.\n. @param dsize output image size; if it equals zero, it is computed as:\n. \\f[\\texttt{dsize = Size(round(fx*src.cols), round(fy*src.rows))}\\f]\n. Either dsize or both fx and fy must be non-zero.\n. @param fx scale factor along the horizontal axis; when it equals 0, it is computed as\n. \\f[\\texttt{(double)dsize.width/src.cols}\\f]\n. @param fy scale factor along the vertical axis; when it equals 0, it is computed as\n. \\f[\\texttt{(double)dsize.height/src.rows}\\f]\n. @param interpolation interpolation method, see #InterpolationFlags\n. \n. @sa warpAffine, warpPerspective, remap' ... @@ -3294,7 +3828,15 @@ def selectROIs(windowName, img: ndarray, showCrosshair=..., fromCenter=...) -> t ... -def sepFilter2D(src: ndarray, ddepth, kernelX, kernelY, dts: ndarray = ..., anchor=..., delta=..., borderType=...) -> typing.Any: +def sepFilter2D( + src: ndarray, + ddepth, + kernelX, + kernelY, + dts: ndarray = ..., + anchor=..., + delta=..., + borderType=...) -> typing.Any: 'sepFilter2D(src, ddepth, kernelX, kernelY[, dst[, anchor[, delta[, borderType]]]]) -> dst\n. @brief Applies a separable linear filter to an image.\n. \n. The function applies a separable linear filter to the image. That is, first, every row of src is\n. filtered with the 1D kernel kernelX. Then, every column of the result is filtered with the 1D\n. kernel kernelY. The final result shifted by delta is stored in dst .\n. \n. @param src Source image.\n. @param dst Destination image of the same size and the same number of channels as src .\n. @param ddepth Destination image depth, see @ref filter_depths "combinations"\n. @param kernelX Coefficients for filtering each row.\n. @param kernelY Coefficients for filtering each column.\n. @param anchor Anchor position within the kernel. The default value \\f$(-1,-1)\\f$ means that the anchor\n. is at the kernel center.\n. @param delta Value added to the filtered results before storing them.\n. @param borderType Pixel extrapolation method, see #BorderTypes. #BORDER_WRAP is not supported.\n. @sa filter2D, Sobel, GaussianBlur, boxFilter, blur' ... @@ -3374,17 +3916,48 @@ def solveP3P(objectPoints, imagePoints, cameraMatrix, distCoeffs, flags: int, rv ... -def solvePnP(objectPoints, imagePoints, cameraMatrix, distCoeffs, rvec=..., tvec=..., useExtrinsicGuess=..., flags: int = ...) -> typing.Any: +def solvePnP( + objectPoints, + imagePoints, + cameraMatrix, + distCoeffs, + rvec=..., + tvec=..., + useExtrinsicGuess=..., + flags: int = ...) -> typing.Any: 'solvePnP(objectPoints, imagePoints, cameraMatrix, distCoeffs[, rvec[, tvec[, useExtrinsicGuess[, flags]]]]) -> retval, rvec, tvec\n. @brief Finds an object pose from 3D-2D point correspondences.\n. This function returns the rotation and the translation vectors that transform a 3D point expressed in the object\n. coordinate frame to the camera coordinate frame, using different methods:\n. - P3P methods (@ref SOLVEPNP_P3P, @ref SOLVEPNP_AP3P): need 4 input points to return a unique solution.\n. - @ref SOLVEPNP_IPPE Input points must be >= 4 and object points must be coplanar.\n. - @ref SOLVEPNP_IPPE_SQUARE Special case suitable for marker pose estimation.\n. Number of input points must be 4. Object points must be defined in the following order:\n. - point 0: [-squareLength / 2, squareLength / 2, 0]\n. - point 1: [ squareLength / 2, squareLength / 2, 0]\n. - point 2: [ squareLength / 2, -squareLength / 2, 0]\n. - point 3: [-squareLength / 2, -squareLength / 2, 0]\n. - for all the other flags, number of input points must be >= 4 and object points can be in any configuration.\n. \n. @param objectPoints Array of object points in the object coordinate space, Nx3 1-channel or\n. 1xN/Nx1 3-channel, where N is the number of points. vector\\ can be also passed here.\n. @param imagePoints Array of corresponding image points, Nx2 1-channel or 1xN/Nx1 2-channel,\n. where N is the number of points. vector\\ can be also passed here.\n. @param cameraMatrix Input camera matrix \\f$A = \\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\\f$ .\n. @param distCoeffs Input vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$ of\n. 4, 5, 8, 12 or 14 elements. If the vector is NULL/empty, the zero distortion coefficients are\n. assumed.\n. @param rvec Output rotation vector (see @ref Rodrigues ) that, together with tvec, brings points from\n. the model coordinate system to the camera coordinate system.\n. @param tvec Output translation vector.\n. @param useExtrinsicGuess Parameter used for #SOLVEPNP_ITERATIVE. If true (1), the function uses\n. the provided rvec and tvec values as initial approximations of the rotation and translation\n. vectors, respectively, and further optimizes them.\n. @param flags Method for solving a PnP problem:\n. - **SOLVEPNP_ITERATIVE** Iterative method is based on a Levenberg-Marquardt optimization. In\n. this case the function finds such a pose that minimizes reprojection error, that is the sum\n. of squared distances between the observed projections imagePoints and the projected (using\n. projectPoints ) objectPoints .\n. - **SOLVEPNP_P3P** Method is based on the paper of X.S. Gao, X.-R. Hou, J. Tang, H.-F. Chang\n. "Complete Solution Classification for the Perspective-Three-Point Problem" (@cite gao2003complete).\n. In this case the function requires exactly four object and image points.\n. - **SOLVEPNP_AP3P** Method is based on the paper of T. Ke, S. Roumeliotis\n. "An Efficient Algebraic Solution to the Perspective-Three-Point Problem" (@cite Ke17).\n. In this case the function requires exactly four object and image points.\n. - **SOLVEPNP_EPNP** Method has been introduced by F. Moreno-Noguer, V. Lepetit and P. Fua in the\n. paper "EPnP: Efficient Perspective-n-Point Camera Pose Estimation" (@cite lepetit2009epnp).\n. - **SOLVEPNP_DLS** Method is based on the paper of J. Hesch and S. Roumeliotis.\n. "A Direct Least-Squares (DLS) Method for PnP" (@cite hesch2011direct).\n. - **SOLVEPNP_UPNP** Method is based on the paper of A. Penate-Sanchez, J. Andrade-Cetto,\n. F. Moreno-Noguer. "Exhaustive Linearization for Robust Camera Pose and Focal Length\n. Estimation" (@cite penate2013exhaustive). In this case the function also estimates the parameters \\f$f_x\\f$ and \\f$f_y\\f$\n. assuming that both have the same value. Then the cameraMatrix is updated with the estimated\n. focal length.\n. - **SOLVEPNP_IPPE** Method is based on the paper of T. Collins and A. Bartoli.\n. "Infinitesimal Plane-Based Pose Estimation" (@cite Collins14). This method requires coplanar object points.\n. - **SOLVEPNP_IPPE_SQUARE** Method is based on the paper of Toby Collins and Adrien Bartoli.\n. "Infinitesimal Plane-Based Pose Estimation" (@cite Collins14). This method is suitable for marker pose estimation.\n. It requires 4 coplanar object points defined in the following order:\n. - point 0: [-squareLength / 2, squareLength / 2, 0]\n. - point 1: [ squareLength / 2, squareLength / 2, 0]\n. - point 2: [ squareLength / 2, -squareLength / 2, 0]\n. - point 3: [-squareLength / 2, -squareLength / 2, 0]\n. \n. The function estimates the object pose given a set of object points, their corresponding image\n. projections, as well as the camera matrix and the distortion coefficients, see the figure below\n. (more precisely, the X-axis of the camera frame is pointing to the right, the Y-axis downward\n. and the Z-axis forward).\n. \n. ![](pnp.jpg)\n. \n. Points expressed in the world frame \\f$ \\bf{X}_w \\f$ are projected into the image plane \\f$ \\left[ u, v \\right] \\f$\n. using the perspective projection model \\f$ \\Pi \\f$ and the camera intrinsic parameters matrix \\f$ \\bf{A} \\f$:\n. \n. \\f[\n. \\begin{align*}\n. \\begin{bmatrix}\n. u \\\\\n. v \\\\\n. 1\n. \\end{bmatrix} &=\n. \\bf{A} \\hspace{0.1em} \\Pi \\hspace{0.2em} ^{c}\\bf{T}_w\n. \\begin{bmatrix}\n. X_{w} \\\\\n. Y_{w} \\\\\n. Z_{w} \\\\\n. 1\n. \\end{bmatrix} \\\\\n. \\begin{bmatrix}\n. u \\\\\n. v \\\\\n. 1\n. \\end{bmatrix} &=\n. \\begin{bmatrix}\n. f_x & 0 & c_x \\\\\n. 0 & f_y & c_y \\\\\n. 0 & 0 & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. 1 & 0 & 0 & 0 \\\\\n. 0 & 1 & 0 & 0 \\\\\n. 0 & 0 & 1 & 0\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. r_{11} & r_{12} & r_{13} & t_x \\\\\n. r_{21} & r_{22} & r_{23} & t_y \\\\\n. r_{31} & r_{32} & r_{33} & t_z \\\\\n. 0 & 0 & 0 & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X_{w} \\\\\n. Y_{w} \\\\\n. Z_{w} \\\\\n. 1\n. \\end{bmatrix}\n. \\end{align*}\n. \\f]\n. \n. The estimated pose is thus the rotation (`rvec`) and the translation (`tvec`) vectors that allow transforming\n. a 3D point expressed in the world frame into the camera frame:\n. \n. \\f[\n. \\begin{align*}\n. \\begin{bmatrix}\n. X_c \\\\\n. Y_c \\\\\n. Z_c \\\\\n. 1\n. \\end{bmatrix} &=\n. \\hspace{0.2em} ^{c}\\bf{T}_w\n. \\begin{bmatrix}\n. X_{w} \\\\\n. Y_{w} \\\\\n. Z_{w} \\\\\n. 1\n. \\end{bmatrix} \\\\\n. \\begin{bmatrix}\n. X_c \\\\\n. Y_c \\\\\n. Z_c \\\\\n. 1\n. \\end{bmatrix} &=\n. \\begin{bmatrix}\n. r_{11} & r_{12} & r_{13} & t_x \\\\\n. r_{21} & r_{22} & r_{23} & t_y \\\\\n. r_{31} & r_{32} & r_{33} & t_z \\\\\n. 0 & 0 & 0 & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X_{w} \\\\\n. Y_{w} \\\\\n. Z_{w} \\\\\n. 1\n. \\end{bmatrix}\n. \\end{align*}\n. \\f]\n. \n. @note\n. - An example of how to use solvePnP for planar augmented reality can be found at\n. opencv_source_code/samples/python/plane_ar.py\n. - If you are using Python:\n. - Numpy array slices won\'t work as input because solvePnP requires contiguous\n. arrays (enforced by the assertion using cv::Mat::checkVector() around line 55 of\n. modules/calib3d/src/solvepnp.cpp version 2.4.9)\n. - The P3P algorithm requires image points to be in an array of shape (N,1,2) due\n. to its calling of cv::undistortPoints (around line 75 of modules/calib3d/src/solvepnp.cpp version 2.4.9)\n. which requires 2-channel information.\n. - Thus, given some data D = np.array(...) where D.shape = (N,M), in order to use a subset of\n. it as, e.g., imagePoints, one must effectively copy it into a new array: imagePoints =\n. np.ascontiguousarray(D[:,:2]).reshape((N,1,2))\n. - The methods **SOLVEPNP_DLS** and **SOLVEPNP_UPNP** cannot be used as the current implementations are\n. unstable and sometimes give completely wrong results. If you pass one of these two\n. flags, **SOLVEPNP_EPNP** method will be used instead.\n. - The minimum number of points is 4 in the general case. In the case of **SOLVEPNP_P3P** and **SOLVEPNP_AP3P**\n. methods, it is required to use exactly 4 points (the first 3 points are used to estimate all the solutions\n. of the P3P problem, the last one is used to retain the best solution that minimizes the reprojection error).\n. - With **SOLVEPNP_ITERATIVE** method and `useExtrinsicGuess=true`, the minimum number of points is 3 (3 points\n. are sufficient to compute a pose but there are up to 4 solutions). The initial solution should be close to the\n. global solution to converge.\n. - With **SOLVEPNP_IPPE** input points must be >= 4 and object points must be coplanar.\n. - With **SOLVEPNP_IPPE_SQUARE** this is a special case suitable for marker pose estimation.\n. Number of input points must be 4. Object points must be defined in the following order:\n. - point 0: [-squareLength / 2, squareLength / 2, 0]\n. - point 1: [ squareLength / 2, squareLength / 2, 0]\n. - point 2: [ squareLength / 2, -squareLength / 2, 0]\n. - point 3: [-squareLength / 2, -squareLength / 2, 0]' ... -def solvePnPGeneric(objectPoints, imagePoints, cameraMatrix, distCoeffs, rvecs=..., tvecs=..., useExtrinsicGuess=..., flags: int = ..., rvec=..., tvec=..., reprojectionError=...) -> typing.Any: +def solvePnPGeneric( + objectPoints, + imagePoints, + cameraMatrix, + distCoeffs, + rvecs=..., + tvecs=..., + useExtrinsicGuess=..., + flags: int = ..., + rvec=..., + tvec=..., + reprojectionError=...) -> typing.Any: 'solvePnPGeneric(objectPoints, imagePoints, cameraMatrix, distCoeffs[, rvecs[, tvecs[, useExtrinsicGuess[, flags[, rvec[, tvec[, reprojectionError]]]]]]]) -> retval, rvecs, tvecs, reprojectionError\n. @brief Finds an object pose from 3D-2D point correspondences.\n. This function returns a list of all the possible solutions (a solution is a \n. couple), depending on the number of input points and the chosen method:\n. - P3P methods (@ref SOLVEPNP_P3P, @ref SOLVEPNP_AP3P): 3 or 4 input points. Number of returned solutions can be between 0 and 4 with 3 input points.\n. - @ref SOLVEPNP_IPPE Input points must be >= 4 and object points must be coplanar. Returns 2 solutions.\n. - @ref SOLVEPNP_IPPE_SQUARE Special case suitable for marker pose estimation.\n. Number of input points must be 4 and 2 solutions are returned. Object points must be defined in the following order:\n. - point 0: [-squareLength / 2, squareLength / 2, 0]\n. - point 1: [ squareLength / 2, squareLength / 2, 0]\n. - point 2: [ squareLength / 2, -squareLength / 2, 0]\n. - point 3: [-squareLength / 2, -squareLength / 2, 0]\n. - for all the other flags, number of input points must be >= 4 and object points can be in any configuration.\n. Only 1 solution is returned.\n. \n. @param objectPoints Array of object points in the object coordinate space, Nx3 1-channel or\n. 1xN/Nx1 3-channel, where N is the number of points. vector\\ can be also passed here.\n. @param imagePoints Array of corresponding image points, Nx2 1-channel or 1xN/Nx1 2-channel,\n. where N is the number of points. vector\\ can be also passed here.\n. @param cameraMatrix Input camera matrix \\f$A = \\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\\f$ .\n. @param distCoeffs Input vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$ of\n. 4, 5, 8, 12 or 14 elements. If the vector is NULL/empty, the zero distortion coefficients are\n. assumed.\n. @param rvecs Vector of output rotation vectors (see @ref Rodrigues ) that, together with tvecs, brings points from\n. the model coordinate system to the camera coordinate system.\n. @param tvecs Vector of output translation vectors.\n. @param useExtrinsicGuess Parameter used for #SOLVEPNP_ITERATIVE. If true (1), the function uses\n. the provided rvec and tvec values as initial approximations of the rotation and translation\n. vectors, respectively, and further optimizes them.\n. @param flags Method for solving a PnP problem:\n. - **SOLVEPNP_ITERATIVE** Iterative method is based on a Levenberg-Marquardt optimization. In\n. this case the function finds such a pose that minimizes reprojection error, that is the sum\n. of squared distances between the observed projections imagePoints and the projected (using\n. projectPoints ) objectPoints .\n. - **SOLVEPNP_P3P** Method is based on the paper of X.S. Gao, X.-R. Hou, J. Tang, H.-F. Chang\n. "Complete Solution Classification for the Perspective-Three-Point Problem" (@cite gao2003complete).\n. In this case the function requires exactly four object and image points.\n. - **SOLVEPNP_AP3P** Method is based on the paper of T. Ke, S. Roumeliotis\n. "An Efficient Algebraic Solution to the Perspective-Three-Point Problem" (@cite Ke17).\n. In this case the function requires exactly four object and image points.\n. - **SOLVEPNP_EPNP** Method has been introduced by F.Moreno-Noguer, V.Lepetit and P.Fua in the\n. paper "EPnP: Efficient Perspective-n-Point Camera Pose Estimation" (@cite lepetit2009epnp).\n. - **SOLVEPNP_DLS** Method is based on the paper of Joel A. Hesch and Stergios I. Roumeliotis.\n. "A Direct Least-Squares (DLS) Method for PnP" (@cite hesch2011direct).\n. - **SOLVEPNP_UPNP** Method is based on the paper of A.Penate-Sanchez, J.Andrade-Cetto,\n. F.Moreno-Noguer. "Exhaustive Linearization for Robust Camera Pose and Focal Length\n. Estimation" (@cite penate2013exhaustive). In this case the function also estimates the parameters \\f$f_x\\f$ and \\f$f_y\\f$\n. assuming that both have the same value. Then the cameraMatrix is updated with the estimated\n. focal length.\n. - **SOLVEPNP_IPPE** Method is based on the paper of T. Collins and A. Bartoli.\n. "Infinitesimal Plane-Based Pose Estimation" (@cite Collins14). This method requires coplanar object points.\n. - **SOLVEPNP_IPPE_SQUARE** Method is based on the paper of Toby Collins and Adrien Bartoli.\n. "Infinitesimal Plane-Based Pose Estimation" (@cite Collins14). This method is suitable for marker pose estimation.\n. It requires 4 coplanar object points defined in the following order:\n. - point 0: [-squareLength / 2, squareLength / 2, 0]\n. - point 1: [ squareLength / 2, squareLength / 2, 0]\n. - point 2: [ squareLength / 2, -squareLength / 2, 0]\n. - point 3: [-squareLength / 2, -squareLength / 2, 0]\n. @param rvec Rotation vector used to initialize an iterative PnP refinement algorithm, when flag is SOLVEPNP_ITERATIVE\n. and useExtrinsicGuess is set to true.\n. @param tvec Translation vector used to initialize an iterative PnP refinement algorithm, when flag is SOLVEPNP_ITERATIVE\n. and useExtrinsicGuess is set to true.\n. @param reprojectionError Optional vector of reprojection error, that is the RMS error\n. (\\f$ \\text{RMSE} = \\sqrt{\\frac{\\sum_{i}^{N} \\left ( \\hat{y_i} - y_i \\right )^2}{N}} \\f$) between the input image points\n. and the 3D object points projected with the estimated pose.\n. \n. The function estimates the object pose given a set of object points, their corresponding image\n. projections, as well as the camera matrix and the distortion coefficients, see the figure below\n. (more precisely, the X-axis of the camera frame is pointing to the right, the Y-axis downward\n. and the Z-axis forward).\n. \n. ![](pnp.jpg)\n. \n. Points expressed in the world frame \\f$ \\bf{X}_w \\f$ are projected into the image plane \\f$ \\left[ u, v \\right] \\f$\n. using the perspective projection model \\f$ \\Pi \\f$ and the camera intrinsic parameters matrix \\f$ \\bf{A} \\f$:\n. \n. \\f[\n. \\begin{align*}\n. \\begin{bmatrix}\n. u \\\\\n. v \\\\\n. 1\n. \\end{bmatrix} &=\n. \\bf{A} \\hspace{0.1em} \\Pi \\hspace{0.2em} ^{c}\\bf{T}_w\n. \\begin{bmatrix}\n. X_{w} \\\\\n. Y_{w} \\\\\n. Z_{w} \\\\\n. 1\n. \\end{bmatrix} \\\\\n. \\begin{bmatrix}\n. u \\\\\n. v \\\\\n. 1\n. \\end{bmatrix} &=\n. \\begin{bmatrix}\n. f_x & 0 & c_x \\\\\n. 0 & f_y & c_y \\\\\n. 0 & 0 & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. 1 & 0 & 0 & 0 \\\\\n. 0 & 1 & 0 & 0 \\\\\n. 0 & 0 & 1 & 0\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. r_{11} & r_{12} & r_{13} & t_x \\\\\n. r_{21} & r_{22} & r_{23} & t_y \\\\\n. r_{31} & r_{32} & r_{33} & t_z \\\\\n. 0 & 0 & 0 & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X_{w} \\\\\n. Y_{w} \\\\\n. Z_{w} \\\\\n. 1\n. \\end{bmatrix}\n. \\end{align*}\n. \\f]\n. \n. The estimated pose is thus the rotation (`rvec`) and the translation (`tvec`) vectors that allow transforming\n. a 3D point expressed in the world frame into the camera frame:\n. \n. \\f[\n. \\begin{align*}\n. \\begin{bmatrix}\n. X_c \\\\\n. Y_c \\\\\n. Z_c \\\\\n. 1\n. \\end{bmatrix} &=\n. \\hspace{0.2em} ^{c}\\bf{T}_w\n. \\begin{bmatrix}\n. X_{w} \\\\\n. Y_{w} \\\\\n. Z_{w} \\\\\n. 1\n. \\end{bmatrix} \\\\\n. \\begin{bmatrix}\n. X_c \\\\\n. Y_c \\\\\n. Z_c \\\\\n. 1\n. \\end{bmatrix} &=\n. \\begin{bmatrix}\n. r_{11} & r_{12} & r_{13} & t_x \\\\\n. r_{21} & r_{22} & r_{23} & t_y \\\\\n. r_{31} & r_{32} & r_{33} & t_z \\\\\n. 0 & 0 & 0 & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X_{w} \\\\\n. Y_{w} \\\\\n. Z_{w} \\\\\n. 1\n. \\end{bmatrix}\n. \\end{align*}\n. \\f]\n. \n. @note\n. - An example of how to use solvePnP for planar augmented reality can be found at\n. opencv_source_code/samples/python/plane_ar.py\n. - If you are using Python:\n. - Numpy array slices won\'t work as input because solvePnP requires contiguous\n. arrays (enforced by the assertion using cv::Mat::checkVector() around line 55 of\n. modules/calib3d/src/solvepnp.cpp version 2.4.9)\n. - The P3P algorithm requires image points to be in an array of shape (N,1,2) due\n. to its calling of cv::undistortPoints (around line 75 of modules/calib3d/src/solvepnp.cpp version 2.4.9)\n. which requires 2-channel information.\n. - Thus, given some data D = np.array(...) where D.shape = (N,M), in order to use a subset of\n. it as, e.g., imagePoints, one must effectively copy it into a new array: imagePoints =\n. np.ascontiguousarray(D[:,:2]).reshape((N,1,2))\n. - The methods **SOLVEPNP_DLS** and **SOLVEPNP_UPNP** cannot be used as the current implementations are\n. unstable and sometimes give completely wrong results. If you pass one of these two\n. flags, **SOLVEPNP_EPNP** method will be used instead.\n. - The minimum number of points is 4 in the general case. In the case of **SOLVEPNP_P3P** and **SOLVEPNP_AP3P**\n. methods, it is required to use exactly 4 points (the first 3 points are used to estimate all the solutions\n. of the P3P problem, the last one is used to retain the best solution that minimizes the reprojection error).\n. - With **SOLVEPNP_ITERATIVE** method and `useExtrinsicGuess=true`, the minimum number of points is 3 (3 points\n. are sufficient to compute a pose but there are up to 4 solutions). The initial solution should be close to the\n. global solution to converge.\n. - With **SOLVEPNP_IPPE** input points must be >= 4 and object points must be coplanar.\n. - With **SOLVEPNP_IPPE_SQUARE** this is a special case suitable for marker pose estimation.\n. Number of input points must be 4. Object points must be defined in the following order:\n. - point 0: [-squareLength / 2, squareLength / 2, 0]\n. - point 1: [ squareLength / 2, squareLength / 2, 0]\n. - point 2: [ squareLength / 2, -squareLength / 2, 0]\n. - point 3: [-squareLength / 2, -squareLength / 2, 0]' ... -def solvePnPRansac(objectPoints, imagePoints, cameraMatrix, distCoeffs, rvec=..., tvec=..., useExtrinsicGuess=..., iterationsCount=..., reprojectionError=..., confidence=..., inliers=..., flags: int = ...) -> typing.Any: +def solvePnPRansac( + objectPoints, + imagePoints, + cameraMatrix, + distCoeffs, + rvec=..., + tvec=..., + useExtrinsicGuess=..., + iterationsCount=..., + reprojectionError=..., + confidence=..., + inliers=..., + flags: int = ...) -> typing.Any: 'solvePnPRansac(objectPoints, imagePoints, cameraMatrix, distCoeffs[, rvec[, tvec[, useExtrinsicGuess[, iterationsCount[, reprojectionError[, confidence[, inliers[, flags]]]]]]]]) -> retval, rvec, tvec, inliers\n. @brief Finds an object pose from 3D-2D point correspondences using the RANSAC scheme.\n. \n. @param objectPoints Array of object points in the object coordinate space, Nx3 1-channel or\n. 1xN/Nx1 3-channel, where N is the number of points. vector\\ can be also passed here.\n. @param imagePoints Array of corresponding image points, Nx2 1-channel or 1xN/Nx1 2-channel,\n. where N is the number of points. vector\\ can be also passed here.\n. @param cameraMatrix Input camera matrix \\f$A = \\vecthreethree{fx}{0}{cx}{0}{fy}{cy}{0}{0}{1}\\f$ .\n. @param distCoeffs Input vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$ of\n. 4, 5, 8, 12 or 14 elements. If the vector is NULL/empty, the zero distortion coefficients are\n. assumed.\n. @param rvec Output rotation vector (see @ref Rodrigues ) that, together with tvec, brings points from\n. the model coordinate system to the camera coordinate system.\n. @param tvec Output translation vector.\n. @param useExtrinsicGuess Parameter used for @ref SOLVEPNP_ITERATIVE. If true (1), the function uses\n. the provided rvec and tvec values as initial approximations of the rotation and translation\n. vectors, respectively, and further optimizes them.\n. @param iterationsCount Number of iterations.\n. @param reprojectionError Inlier threshold value used by the RANSAC procedure. The parameter value\n. is the maximum allowed distance between the observed and computed point projections to consider it\n. an inlier.\n. @param confidence The probability that the algorithm produces a useful result.\n. @param inliers Output vector that contains indices of inliers in objectPoints and imagePoints .\n. @param flags Method for solving a PnP problem (see @ref solvePnP ).\n. \n. The function estimates an object pose given a set of object points, their corresponding image\n. projections, as well as the camera matrix and the distortion coefficients. This function finds such\n. a pose that minimizes reprojection error, that is, the sum of squared distances between the observed\n. projections imagePoints and the projected (using @ref projectPoints ) objectPoints. The use of RANSAC\n. makes the function resistant to outliers.\n. \n. @note\n. - An example of how to use solvePNPRansac for object detection can be found at\n. opencv_source_code/samples/cpp/tutorial_code/calib3d/real_time_pose_estimation/\n. - The default method used to estimate the camera pose for the Minimal Sample Sets step\n. is #SOLVEPNP_EPNP. Exceptions are:\n. - if you choose #SOLVEPNP_P3P or #SOLVEPNP_AP3P, these methods will be used.\n. - if the number of input points is equal to 4, #SOLVEPNP_P3P is used.\n. - The method used to estimate the camera pose using all the inliers is defined by the\n. flags parameters unless it is equal to #SOLVEPNP_P3P or #SOLVEPNP_AP3P. In this case,\n. the method #SOLVEPNP_EPNP will be used instead.' ... @@ -3394,7 +3967,15 @@ def solvePnPRefineLM(objectPoints, imagePoints, cameraMatrix, distCoeffs, rvec, ... -def solvePnPRefineVVS(objectPoints, imagePoints, cameraMatrix, distCoeffs, rvec, tvec, criteria=..., VVSlambda=...) -> typing.Any: +def solvePnPRefineVVS( + objectPoints, + imagePoints, + cameraMatrix, + distCoeffs, + rvec, + tvec, + criteria=..., + VVSlambda=...) -> typing.Any: 'solvePnPRefineVVS(objectPoints, imagePoints, cameraMatrix, distCoeffs, rvec, tvec[, criteria[, VVSlambda]]) -> rvec, tvec\n. @brief Refine a pose (the translation and the rotation that transform a 3D point expressed in the object coordinate frame\n. to the camera coordinate frame) from a 3D-2D point correspondences and starting from an initial solution.\n. \n. @param objectPoints Array of object points in the object coordinate space, Nx3 1-channel or 1xN/Nx1 3-channel,\n. where N is the number of points. vector\\ can also be passed here.\n. @param imagePoints Array of corresponding image points, Nx2 1-channel or 1xN/Nx1 2-channel,\n. where N is the number of points. vector\\ can also be passed here.\n. @param cameraMatrix Input camera matrix \\f$A = \\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\\f$ .\n. @param distCoeffs Input vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$ of\n. 4, 5, 8, 12 or 14 elements. If the vector is NULL/empty, the zero distortion coefficients are\n. assumed.\n. @param rvec Input/Output rotation vector (see @ref Rodrigues ) that, together with tvec, brings points from\n. the model coordinate system to the camera coordinate system. Input values are used as an initial solution.\n. @param tvec Input/Output translation vector. Input values are used as an initial solution.\n. @param criteria Criteria when to stop the Levenberg-Marquard iterative algorithm.\n. @param VVSlambda Gain for the virtual visual servoing control law, equivalent to the \\f$\\alpha\\f$\n. gain in the Damped Gauss-Newton formulation.\n. \n. The function refines the object pose given at least 3 object points, their corresponding image\n. projections, an initial solution for the rotation and translation vector,\n. as well as the camera matrix and the distortion coefficients.\n. The function minimizes the projection error with respect to the rotation and the translation vectors, using a\n. virtual visual servoing (VVS) @cite Chaumette06 @cite Marchand16 scheme.' ... @@ -3424,7 +4005,14 @@ def split(m, mv=...) -> typing.Any: ... -def sqrBoxFilter(src: ndarray, ddepth, ksize, dts: ndarray = ..., anchor=..., normalize=..., borderType=...) -> typing.Any: +def sqrBoxFilter( + src: ndarray, + ddepth, + ksize, + dts: ndarray = ..., + anchor=..., + normalize=..., + borderType=...) -> typing.Any: "sqrBoxFilter(src, ddepth, ksize[, dst[, anchor[, normalize[, borderType]]]]) -> dst\n. @brief Calculates the normalized sum of squares of the pixel values overlapping the filter.\n. \n. For every pixel \\f$ (x, y) \\f$ in the source image, the function calculates the sum of squares of those neighboring\n. pixel values which overlap the filter placed over the pixel \\f$ (x, y) \\f$.\n. \n. The unnormalized square box filter can be useful in computing local image statistics such as the the local\n. variance and standard deviation around the neighborhood of a pixel.\n. \n. @param src input image\n. @param dst output image of the same size and type as _src\n. @param ddepth the output image depth (-1 to use src.depth())\n. @param ksize kernel size\n. @param anchor kernel anchor point. The default value of Point(-1, -1) denotes that the anchor is at the kernel\n. center.\n. @param normalize flag, specifying whether the kernel is to be normalized by it's area or not.\n. @param borderType border mode used to extrapolate pixels outside of the image, see #BorderTypes. #BORDER_WRAP is not supported.\n. @sa boxFilter" ... @@ -3439,17 +4027,61 @@ def startWindowThread() -> typing.Any: ... -def stereoCalibrate(objectPoints, imagePoints1, imagePoints2, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, imageSize, R=..., T=..., E=..., F=..., flags: int = ..., criteria=...) -> typing.Any: +def stereoCalibrate( + objectPoints, + imagePoints1, + imagePoints2, + cameraMatrix1, + distCoeffs1, + cameraMatrix2, + distCoeffs2, + imageSize, + R=..., + T=..., + E=..., + F=..., + flags: int = ..., + criteria=...) -> typing.Any: 'stereoCalibrate(objectPoints, imagePoints1, imagePoints2, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, imageSize[, R[, T[, E[, F[, flags[, criteria]]]]]]) -> retval, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, R, T, E, F\n.' ... -def stereoCalibrateExtended(objectPoints, imagePoints1, imagePoints2, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, imageSize, R, T, E=..., F=..., perViewErrors=..., flags: int = ..., criteria=...) -> typing.Any: +def stereoCalibrateExtended( + objectPoints, + imagePoints1, + imagePoints2, + cameraMatrix1, + distCoeffs1, + cameraMatrix2, + distCoeffs2, + imageSize, + R, + T, + E=..., + F=..., + perViewErrors=..., + flags: int = ..., + criteria=...) -> typing.Any: "stereoCalibrateExtended(objectPoints, imagePoints1, imagePoints2, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, imageSize, R, T[, E[, F[, perViewErrors[, flags[, criteria]]]]]) -> retval, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, R, T, E, F, perViewErrors\n. @brief Calibrates a stereo camera set up. This function finds the intrinsic parameters\n. for each of the two cameras and the extrinsic parameters between the two cameras.\n. \n. @param objectPoints Vector of vectors of the calibration pattern points. The same structure as\n. in @ref calibrateCamera. For each pattern view, both cameras need to see the same object\n. points. Therefore, objectPoints.size(), imagePoints1.size(), and imagePoints2.size() need to be\n. equal as well as objectPoints[i].size(), imagePoints1[i].size(), and imagePoints2[i].size() need to\n. be equal for each i.\n. @param imagePoints1 Vector of vectors of the projections of the calibration pattern points,\n. observed by the first camera. The same structure as in @ref calibrateCamera.\n. @param imagePoints2 Vector of vectors of the projections of the calibration pattern points,\n. observed by the second camera. The same structure as in @ref calibrateCamera.\n. @param cameraMatrix1 Input/output camera matrix for the first camera, the same as in\n. @ref calibrateCamera. Furthermore, for the stereo case, additional flags may be used, see below.\n. @param distCoeffs1 Input/output vector of distortion coefficients, the same as in\n. @ref calibrateCamera.\n. @param cameraMatrix2 Input/output second camera matrix for the second camera. See description for\n. cameraMatrix1.\n. @param distCoeffs2 Input/output lens distortion coefficients for the second camera. See\n. description for distCoeffs1.\n. @param imageSize Size of the image used only to initialize the intrinsic camera matrices.\n. @param R Output rotation matrix. Together with the translation vector T, this matrix brings\n. points given in the first camera's coordinate system to points in the second camera's\n. coordinate system. In more technical terms, the tuple of R and T performs a change of basis\n. from the first camera's coordinate system to the second camera's coordinate system. Due to its\n. duality, this tuple is equivalent to the position of the first camera with respect to the\n. second camera coordinate system.\n. @param T Output translation vector, see description above.\n. @param E Output essential matrix.\n. @param F Output fundamental matrix.\n. @param perViewErrors Output vector of the RMS re-projection error estimated for each pattern view.\n. @param flags Different flags that may be zero or a combination of the following values:\n. - **CALIB_FIX_INTRINSIC** Fix cameraMatrix? and distCoeffs? so that only R, T, E, and F\n. matrices are estimated.\n. - **CALIB_USE_INTRINSIC_GUESS** Optimize some or all of the intrinsic parameters\n. according to the specified flags. Initial values are provided by the user.\n. - **CALIB_USE_EXTRINSIC_GUESS** R and T contain valid initial values that are optimized further.\n. Otherwise R and T are initialized to the median value of the pattern views (each dimension separately).\n. - **CALIB_FIX_PRINCIPAL_POINT** Fix the principal points during the optimization.\n. - **CALIB_FIX_FOCAL_LENGTH** Fix \\f$f^{(j)}_x\\f$ and \\f$f^{(j)}_y\\f$ .\n. - **CALIB_FIX_ASPECT_RATIO** Optimize \\f$f^{(j)}_y\\f$ . Fix the ratio \\f$f^{(j)}_x/f^{(j)}_y\\f$\n. .\n. - **CALIB_SAME_FOCAL_LENGTH** Enforce \\f$f^{(0)}_x=f^{(1)}_x\\f$ and \\f$f^{(0)}_y=f^{(1)}_y\\f$ .\n. - **CALIB_ZERO_TANGENT_DIST** Set tangential distortion coefficients for each camera to\n. zeros and fix there.\n. - **CALIB_FIX_K1,...,CALIB_FIX_K6** Do not change the corresponding radial\n. distortion coefficient during the optimization. If CALIB_USE_INTRINSIC_GUESS is set,\n. the coefficient from the supplied distCoeffs matrix is used. Otherwise, it is set to 0.\n. - **CALIB_RATIONAL_MODEL** Enable coefficients k4, k5, and k6. To provide the backward\n. compatibility, this extra flag should be explicitly specified to make the calibration\n. function use the rational model and return 8 coefficients. If the flag is not set, the\n. function computes and returns only 5 distortion coefficients.\n. - **CALIB_THIN_PRISM_MODEL** Coefficients s1, s2, s3 and s4 are enabled. To provide the\n. backward compatibility, this extra flag should be explicitly specified to make the\n. calibration function use the thin prism model and return 12 coefficients. If the flag is not\n. set, the function computes and returns only 5 distortion coefficients.\n. - **CALIB_FIX_S1_S2_S3_S4** The thin prism distortion coefficients are not changed during\n. the optimization. If CALIB_USE_INTRINSIC_GUESS is set, the coefficient from the\n. supplied distCoeffs matrix is used. Otherwise, it is set to 0.\n. - **CALIB_TILTED_MODEL** Coefficients tauX and tauY are enabled. To provide the\n. backward compatibility, this extra flag should be explicitly specified to make the\n. calibration function use the tilted sensor model and return 14 coefficients. If the flag is not\n. set, the function computes and returns only 5 distortion coefficients.\n. - **CALIB_FIX_TAUX_TAUY** The coefficients of the tilted sensor model are not changed during\n. the optimization. If CALIB_USE_INTRINSIC_GUESS is set, the coefficient from the\n. supplied distCoeffs matrix is used. Otherwise, it is set to 0.\n. @param criteria Termination criteria for the iterative optimization algorithm.\n. \n. The function estimates the transformation between two cameras making a stereo pair. If one computes\n. the poses of an object relative to the first camera and to the second camera,\n. ( \\f$R_1\\f$,\\f$T_1\\f$ ) and (\\f$R_2\\f$,\\f$T_2\\f$), respectively, for a stereo camera where the\n. relative position and orientation between the two cameras are fixed, then those poses definitely\n. relate to each other. This means, if the relative position and orientation (\\f$R\\f$,\\f$T\\f$) of the\n. two cameras is known, it is possible to compute (\\f$R_2\\f$,\\f$T_2\\f$) when (\\f$R_1\\f$,\\f$T_1\\f$) is\n. given. This is what the described function does. It computes (\\f$R\\f$,\\f$T\\f$) such that:\n. \n. \\f[R_2=R R_1\\f]\n. \\f[T_2=R T_1 + T.\\f]\n. \n. Therefore, one can compute the coordinate representation of a 3D point for the second camera's\n. coordinate system when given the point's coordinate representation in the first camera's coordinate\n. system:\n. \n. \\f[\\begin{bmatrix}\n. X_2 \\\\\n. Y_2 \\\\\n. Z_2 \\\\\n. 1\n. \\end{bmatrix} = \\begin{bmatrix}\n. R & T \\\\\n. 0 & 1\n. \\end{bmatrix} \\begin{bmatrix}\n. X_1 \\\\\n. Y_1 \\\\\n. Z_1 \\\\\n. 1\n. \\end{bmatrix}.\\f]\n. \n. \n. Optionally, it computes the essential matrix E:\n. \n. \\f[E= \\vecthreethree{0}{-T_2}{T_1}{T_2}{0}{-T_0}{-T_1}{T_0}{0} R\\f]\n. \n. where \\f$T_i\\f$ are components of the translation vector \\f$T\\f$ : \\f$T=[T_0, T_1, T_2]^T\\f$ .\n. And the function can also compute the fundamental matrix F:\n. \n. \\f[F = cameraMatrix2^{-T}\\cdot E \\cdot cameraMatrix1^{-1}\\f]\n. \n. Besides the stereo-related information, the function can also perform a full calibration of each of\n. the two cameras. However, due to the high dimensionality of the parameter space and noise in the\n. input data, the function can diverge from the correct solution. If the intrinsic parameters can be\n. estimated with high accuracy for each of the cameras individually (for example, using\n. calibrateCamera ), you are recommended to do so and then pass CALIB_FIX_INTRINSIC flag to the\n. function along with the computed intrinsic parameters. Otherwise, if all the parameters are\n. estimated at once, it makes sense to restrict some parameters, for example, pass\n. CALIB_SAME_FOCAL_LENGTH and CALIB_ZERO_TANGENT_DIST flags, which is usually a\n. reasonable assumption.\n. \n. Similarly to calibrateCamera, the function minimizes the total re-projection error for all the\n. points in all the available views from both cameras. The function returns the final value of the\n. re-projection error." ... -def stereoRectify(cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, imageSize, R, T, R1=..., R2=..., P1=..., P2=..., Q=..., flags: int = ..., alpha=..., newImageSize=...) -> typing.Any: +def stereoRectify( + cameraMatrix1, + distCoeffs1, + cameraMatrix2, + distCoeffs2, + imageSize, + R, + T, + R1=..., + R2=..., + P1=..., + P2=..., + Q=..., + flags: int = ..., + alpha=..., + newImageSize=...) -> typing.Any: 'stereoRectify(cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, imageSize, R, T[, R1[, R2[, P1[, P2[, Q[, flags[, alpha[, newImageSize]]]]]]]]) -> R1, R2, P1, P2, Q, validPixROI1, validPixROI2\n. @brief Computes rectification transforms for each head of a calibrated stereo camera.\n. \n. @param cameraMatrix1 First camera matrix.\n. @param distCoeffs1 First camera distortion parameters.\n. @param cameraMatrix2 Second camera matrix.\n. @param distCoeffs2 Second camera distortion parameters.\n. @param imageSize Size of the image used for stereo calibration.\n. @param R Rotation matrix from the coordinate system of the first camera to the second camera,\n. see @ref stereoCalibrate.\n. @param T Translation vector from the coordinate system of the first camera to the second camera,\n. see @ref stereoCalibrate.\n. @param R1 Output 3x3 rectification transform (rotation matrix) for the first camera. This matrix\n. brings points given in the unrectified first camera\'s coordinate system to points in the rectified\n. first camera\'s coordinate system. In more technical terms, it performs a change of basis from the\n. unrectified first camera\'s coordinate system to the rectified first camera\'s coordinate system.\n. @param R2 Output 3x3 rectification transform (rotation matrix) for the second camera. This matrix\n. brings points given in the unrectified second camera\'s coordinate system to points in the rectified\n. second camera\'s coordinate system. In more technical terms, it performs a change of basis from the\n. unrectified second camera\'s coordinate system to the rectified second camera\'s coordinate system.\n. @param P1 Output 3x4 projection matrix in the new (rectified) coordinate systems for the first\n. camera, i.e. it projects points given in the rectified first camera coordinate system into the\n. rectified first camera\'s image.\n. @param P2 Output 3x4 projection matrix in the new (rectified) coordinate systems for the second\n. camera, i.e. it projects points given in the rectified first camera coordinate system into the\n. rectified second camera\'s image.\n. @param Q Output \\f$4 \\times 4\\f$ disparity-to-depth mapping matrix (see @ref reprojectImageTo3D).\n. @param flags Operation flags that may be zero or CALIB_ZERO_DISPARITY . If the flag is set,\n. the function makes the principal points of each camera have the same pixel coordinates in the\n. rectified views. And if the flag is not set, the function may still shift the images in the\n. horizontal or vertical direction (depending on the orientation of epipolar lines) to maximize the\n. useful image area.\n. @param alpha Free scaling parameter. If it is -1 or absent, the function performs the default\n. scaling. Otherwise, the parameter should be between 0 and 1. alpha=0 means that the rectified\n. images are zoomed and shifted so that only valid pixels are visible (no black areas after\n. rectification). alpha=1 means that the rectified image is decimated and shifted so that all the\n. pixels from the original images from the cameras are retained in the rectified images (no source\n. image pixels are lost). Any intermediate value yields an intermediate result between\n. those two extreme cases.\n. @param newImageSize New image resolution after rectification. The same size should be passed to\n. initUndistortRectifyMap (see the stereo_calib.cpp sample in OpenCV samples directory). When (0,0)\n. is passed (default), it is set to the original imageSize . Setting it to a larger value can help you\n. preserve details in the original image, especially when there is a big radial distortion.\n. @param validPixROI1 Optional output rectangles inside the rectified images where all the pixels\n. are valid. If alpha=0 , the ROIs cover the whole images. Otherwise, they are likely to be smaller\n. (see the picture below).\n. @param validPixROI2 Optional output rectangles inside the rectified images where all the pixels\n. are valid. If alpha=0 , the ROIs cover the whole images. Otherwise, they are likely to be smaller\n. (see the picture below).\n. \n. The function computes the rotation matrices for each camera that (virtually) make both camera image\n. planes the same plane. Consequently, this makes all the epipolar lines parallel and thus simplifies\n. the dense stereo correspondence problem. The function takes the matrices computed by stereoCalibrate\n. as input. As output, it provides two rotation matrices and also two projection matrices in the new\n. coordinates. The function distinguishes the following two cases:\n. \n. - **Horizontal stereo**: the first and the second camera views are shifted relative to each other\n. mainly along the x-axis (with possible small vertical shift). In the rectified images, the\n. corresponding epipolar lines in the left and right cameras are horizontal and have the same\n. y-coordinate. P1 and P2 look like:\n. \n. \\f[\\texttt{P1} = \\begin{bmatrix}\n. f & 0 & cx_1 & 0 \\\\\n. 0 & f & cy & 0 \\\\\n. 0 & 0 & 1 & 0\n. \\end{bmatrix}\\f]\n. \n. \\f[\\texttt{P2} = \\begin{bmatrix}\n. f & 0 & cx_2 & T_x*f \\\\\n. 0 & f & cy & 0 \\\\\n. 0 & 0 & 1 & 0\n. \\end{bmatrix} ,\\f]\n. \n. where \\f$T_x\\f$ is a horizontal shift between the cameras and \\f$cx_1=cx_2\\f$ if\n. CALIB_ZERO_DISPARITY is set.\n. \n. - **Vertical stereo**: the first and the second camera views are shifted relative to each other\n. mainly in the vertical direction (and probably a bit in the horizontal direction too). The epipolar\n. lines in the rectified images are vertical and have the same x-coordinate. P1 and P2 look like:\n. \n. \\f[\\texttt{P1} = \\begin{bmatrix}\n. f & 0 & cx & 0 \\\\\n. 0 & f & cy_1 & 0 \\\\\n. 0 & 0 & 1 & 0\n. \\end{bmatrix}\\f]\n. \n. \\f[\\texttt{P2} = \\begin{bmatrix}\n. f & 0 & cx & 0 \\\\\n. 0 & f & cy_2 & T_y*f \\\\\n. 0 & 0 & 1 & 0\n. \\end{bmatrix},\\f]\n. \n. where \\f$T_y\\f$ is a vertical shift between the cameras and \\f$cy_1=cy_2\\f$ if\n. CALIB_ZERO_DISPARITY is set.\n. \n. As you can see, the first three columns of P1 and P2 will effectively be the new "rectified" camera\n. matrices. The matrices, together with R1 and R2 , can then be passed to initUndistortRectifyMap to\n. initialize the rectification map for each camera.\n. \n. See below the screenshot from the stereo_calib.cpp sample. Some red horizontal lines pass through\n. the corresponding image regions. This means that the images are well rectified, which is what most\n. stereo correspondence algorithms rely on. The green rectangles are roi1 and roi2 . You see that\n. their interiors are all valid pixels.\n. \n. ![image](pics/stereo_undistort.jpg)' ... @@ -3474,7 +4106,13 @@ def sumElems(src) -> typing.Any: ... -def textureFlattening(src: ndarray, mask: ndarray, dts: ndarray = ..., low_threshold=..., high_threshold=..., kernel_size=...) -> typing.Any: +def textureFlattening( + src: ndarray, + mask: ndarray, + dts: ndarray = ..., + low_threshold=..., + high_threshold=..., + kernel_size=...) -> typing.Any: "textureFlattening(src, mask[, dst[, low_threshold[, high_threshold[, kernel_size]]]]) -> dst\n. @brief By retaining only the gradients at edge locations, before integrating with the Poisson solver, one\n. washes out the texture of the selected region, giving its contents a flat aspect. Here Canny Edge %Detector is used.\n. \n. @param src Input 8-bit 3-channel image.\n. @param mask Input 8-bit 1 or 3-channel image.\n. @param dst Output image with the same size and type as src.\n. @param low_threshold %Range from 0 to 100.\n. @param high_threshold Value \\> 100.\n. @param kernel_size The size of the Sobel kernel to be used.\n. \n. @note\n. The algorithm assumes that the color of the source image is close to that of the destination. This\n. assumption means that when the colors don't match, the source image color gets tinted toward the\n. color of the destination image." ... @@ -3549,17 +4187,32 @@ def waitKeyEx(delay=...) -> typing.Any: ... -def warpAffine(src: ndarray, M, dsize: typing.Tuple[int, int], dts: ndarray = ..., flags: int = ..., borderMode=..., borderValue=...) -> typing.Any: +def warpAffine(src: ndarray, + M, + dsize: typing.Tuple[int, + int], + dts: ndarray = ..., + flags: int = ..., + borderMode=..., + borderValue=...) -> typing.Any: 'warpAffine(src, M, dsize[, dst[, flags[, borderMode[, borderValue]]]]) -> dst\n. @brief Applies an affine transformation to an image.\n. \n. The function warpAffine transforms the source image using the specified matrix:\n. \n. \\f[\\texttt{dst} (x,y) = \\texttt{src} ( \\texttt{M} _{11} x + \\texttt{M} _{12} y + \\texttt{M} _{13}, \\texttt{M} _{21} x + \\texttt{M} _{22} y + \\texttt{M} _{23})\\f]\n. \n. when the flag #WARP_INVERSE_MAP is set. Otherwise, the transformation is first inverted\n. with #invertAffineTransform and then put in the formula above instead of M. The function cannot\n. operate in-place.\n. \n. @param src input image.\n. @param dst output image that has the size dsize and the same type as src .\n. @param M \\f$2\\times 3\\f$ transformation matrix.\n. @param dsize size of the output image.\n. @param flags combination of interpolation methods (see #InterpolationFlags) and the optional\n. flag #WARP_INVERSE_MAP that means that M is the inverse transformation (\n. \\f$\\texttt{dst}\\rightarrow\\texttt{src}\\f$ ).\n. @param borderMode pixel extrapolation method (see #BorderTypes); when\n. borderMode=#BORDER_TRANSPARENT, it means that the pixels in the destination image corresponding to\n. the "outliers" in the source image are not modified by the function.\n. @param borderValue value used in case of a constant border; by default, it is 0.\n. \n. @sa warpPerspective, resize, remap, getRectSubPix, transform' ... -def warpPerspective(src: ndarray, M, dsize: typing.Tuple[int, int], dts: ndarray = ..., flags: int = ..., borderMode=..., borderValue=...) -> typing.Any: +def warpPerspective(src: ndarray, + M, + dsize: typing.Tuple[int, + int], + dts: ndarray = ..., + flags: int = ..., + borderMode=..., + borderValue=...) -> typing.Any: 'warpPerspective(src, M, dsize[, dst[, flags[, borderMode[, borderValue]]]]) -> dst\n. @brief Applies a perspective transformation to an image.\n. \n. The function warpPerspective transforms the source image using the specified matrix:\n. \n. \\f[\\texttt{dst} (x,y) = \\texttt{src} \\left ( \\frac{M_{11} x + M_{12} y + M_{13}}{M_{31} x + M_{32} y + M_{33}} ,\n. \\frac{M_{21} x + M_{22} y + M_{23}}{M_{31} x + M_{32} y + M_{33}} \\right )\\f]\n. \n. when the flag #WARP_INVERSE_MAP is set. Otherwise, the transformation is first inverted with invert\n. and then put in the formula above instead of M. The function cannot operate in-place.\n. \n. @param src input image.\n. @param dst output image that has the size dsize and the same type as src .\n. @param M \\f$3\\times 3\\f$ transformation matrix.\n. @param dsize size of the output image.\n. @param flags combination of interpolation methods (#INTER_LINEAR or #INTER_NEAREST) and the\n. optional flag #WARP_INVERSE_MAP, that sets M as the inverse transformation (\n. \\f$\\texttt{dst}\\rightarrow\\texttt{src}\\f$ ).\n. @param borderMode pixel extrapolation method (#BORDER_CONSTANT or #BORDER_REPLICATE).\n. @param borderValue value used in case of a constant border; by default, it equals 0.\n. \n. @sa warpAffine, resize, remap, getRectSubPix, perspectiveTransform' ... -def warpPolar(src: ndarray, dsize: typing.Tuple[int, int], center, maxRadius, flags: int, dts: ndarray = ...) -> typing.Any: +def warpPolar(src: ndarray, dsize: typing.Tuple[int, int], center, + maxRadius, flags: int, dts: ndarray = ...) -> typing.Any: 'warpPolar(src, dsize: typing.Tuple[int, int], center, maxRadius, flags[, dst]) -> dst\n. \\brief Remaps an image to polar or semilog-polar coordinates space\n. \n. @anchor polar_remaps_reference_image\n. ![Polar remaps reference](pics/polar_remap_doc.png)\n. \n. Transform the source image using the following transformation:\n. \\f[\n. dst(\\rho , \\phi ) = src(x,y)\n. \\f]\n. \n. where\n. \\f[\n. \\begin{array}{l}\n. \\vec{I} = (x - center.x, \\;y - center.y) \\\\\n. \\phi = Kangle \\cdot \\texttt{angle} (\\vec{I}) \\\\\n. \\rho = \\left\\{\\begin{matrix}\n. Klin \\cdot \\texttt{magnitude} (\\vec{I}) & default \\\\\n. Klog \\cdot log_e(\\texttt{magnitude} (\\vec{I})) & if \\; semilog \\\\\n. \\end{matrix}\\right.\n. \\end{array}\n. \\f]\n. \n. and\n. \\f[\n. \\begin{array}{l}\n. Kangle = dsize.height / 2\\Pi \\\\\n. Klin = dsize.width / maxRadius \\\\\n. Klog = dsize.width / log_e(maxRadius) \\\\\n. \\end{array}\n. \\f]\n. \n. \n. \\par Linear vs semilog mapping\n. \n. Polar mapping can be linear or semi-log. Add one of #WarpPolarMode to `flags` to specify the polar mapping mode.\n. \n. Linear is the default mode.\n. \n. The semilog mapping emulates the human "foveal" vision that permit very high acuity on the line of sight (central vision)\n. in contrast to peripheral vision where acuity is minor.\n. \n. \\par Option on `dsize`:\n. \n. - if both values in `dsize <=0 ` (default),\n. the destination image will have (almost) same area of source bounding circle:\n. \\f[\\begin{array}{l}\n. dsize.area \\leftarrow (maxRadius^2 \\cdot \\Pi) \\\\\n. dsize.width = \\texttt{cvRound}(maxRadius) \\\\\n. dsize.height = \\texttt{cvRound}(maxRadius \\cdot \\Pi) \\\\\n. \\end{array}\\f]\n. \n. \n. - if only `dsize.height <= 0`,\n. the destination image area will be proportional to the bounding circle area but scaled by `Kx * Kx`:\n. \\f[\\begin{array}{l}\n. dsize.height = \\texttt{cvRound}(dsize.width \\cdot \\Pi) \\\\\n. \\end{array}\n. \\f]\n. \n. - if both values in `dsize > 0 `,\n. the destination image will have the given size therefore the area of the bounding circle will be scaled to `dsize`.\n. \n. \n. \\par Reverse mapping\n. \n. You can get reverse mapping adding #WARP_INVERSE_MAP to `flags`\n. \\snippet polar_transforms.cpp InverseMap\n. \n. In addiction, to calculate the original coordinate from a polar mapped coordinate \\f$(rho, phi)->(x, y)\\f$:\n. \\snippet polar_transforms.cpp InverseCoordinate\n. \n. @param src Source image.\n. @param dst Destination image. It will have same type as src.\n. @param dsize The destination image size (see description for valid options).\n. @param center The transformation center.\n. @param maxRadius The radius of the bounding circle to transform. It determines the inverse magnitude scale parameter too.\n. @param flags A combination of interpolation methods, #InterpolationFlags + #WarpPolarMode.\n. - Add #WARP_POLAR_LINEAR to select linear polar mapping (default)\n. - Add #WARP_POLAR_LOG to select semilog polar mapping\n. - Add #WARP_INVERSE_MAP for reverse mapping.\n. @note\n. - The function can not operate in-place.\n. - To calculate magnitude and angle in degrees #cartToPolar is used internally thus angles are measured from 0 to 360 with accuracy about 0.3 degrees.\n. - This function uses #remap. Due to current implementation limitations the size of an input and output images should be less than 32767x32767.\n. \n. @sa cv::remap' ... diff --git a/typings/imagehash/__init__.pyi b/typings/imagehash/__init__.pyi index 4f60001d..7abf58bc 100644 --- a/typings/imagehash/__init__.pyi +++ b/typings/imagehash/__init__.pyi @@ -1,11 +1,10 @@ """ This type stub file was generated by pyright. """ -from __future__ import absolute_import, division, print_function, annotations -from PIL import Image, ImageFilter -import numpy +from __future__ import absolute_import, division, print_function +from PIL import Image -__version__ = ... +__version__: str = ... class ImageHash: diff --git a/typings/keyboard/__init__.pyi b/typings/keyboard/__init__.pyi index 18f68af6..03fe7ac5 100644 --- a/typings/keyboard/__init__.pyi +++ b/typings/keyboard/__init__.pyi @@ -2,18 +2,23 @@ This type stub file was generated by pyright. """ from __future__ import print_function as _print_function -import typing - -import re as _re -import itertools as _itertools -import collections as _collections -import time as _time -import platform as _platform -from threading import Lock as _Lock, Thread as _Thread +from typing import Any, Optional, Union +from collections.abc import Callable + +from threading import Lock as _Lock from ._keyboard_event import KEY_DOWN, KEY_UP, KeyboardEvent from ._generic import GenericListener as _GenericListener from ._canonical_names import all_modifiers, normalize_name, sided_modifiers +__all__ = [ + "KEY_DOWN", + "KEY_UP", + "KeyboardEvent", + "_GenericListener", + "all_modifiers", + "normalize_name", + "sided_modifiers"] + try: # Python2 # threading.Event is a function in Python2 wrappin _Event (?!). @@ -24,91 +29,12 @@ except NameError: from threading import Event as _UninterruptibleEvent -""" -keyboard -======== - -Take full control of your keyboard with this small Python library. Hook global events, register hotkeys, simulate key presses and much more. - -## Features - -- **Global event hook** on all keyboards (captures keys regardless of focus). -- **Listen** and **send** keyboard events. -- Works with **Windows** and **Linux** (requires sudo), with experimental **OS X** support (thanks @glitchassassin!). -- **Pure Python**, no C modules to be compiled. -- **Zero dependencies**. Trivial to install and deploy, just copy the files. -- **Python 2 and 3**. -- Complex hotkey support (e.g. `ctrl+shift+m, ctrl+space`) with controllable timeout. -- Includes **high level API** (e.g. [record](#keyboard.record) and [play](#keyboard.play), [add_abbreviation](#keyboard.add_abbreviation)). -- Maps keys as they actually are in your layout, with **full internationalization support** (e.g. `Ctrl+ç`). -- Events automatically captured in separate thread, doesn't block main program. -- Tested and documented. -- Doesn't break accented dead keys (I'm looking at you, pyHook). -- Mouse support available via project [mouse](https://github.com/boppreh/mouse) (`pip install mouse`). - -## Usage - -Install the [PyPI package](https://pypi.python.org/pypi/keyboard/): - - pip install keyboard - -or clone the repository (no installation required, source files are sufficient): - - git clone https://github.com/boppreh/keyboard - -or [download and extract the zip](https://github.com/boppreh/keyboard/archive/master.zip) into your project folder. - -Then check the [API docs below](https://github.com/boppreh/keyboard#api) to see what features are available. - - -## Example - - -```py -import keyboard - -keyboard.press_and_release('shift+s, space') - -keyboard.write('The quick brown fox jumps over the lazy dog.') - -keyboard.add_hotkey('ctrl+shift+a', print, args=('triggered', 'hotkey')) - -# Press PAGE UP then PAGE DOWN to type "foobar". -keyboard.add_hotkey('page up, page down', lambda: keyboard.write('foobar')) - -# Blocks until you press esc. -keyboard.wait('esc') - -# Record events until 'esc' is pressed. -recorded = keyboard.record(until='esc') -# Then replay back at three times the speed. -keyboard.play(recorded, speed_factor=3) - -# Type @@ then press space to replace with abbreviation. -keyboard.add_abbreviation('@@', 'my.long.email@example.com') - -# Block forever, like `while True`. -keyboard.wait() -``` - -## Known limitations: - -- Events generated under Windows don't report device id (`event.device == None`). [#21](https://github.com/boppreh/keyboard/issues/21) -- Media keys on Linux may appear nameless (scan-code only) or not at all. [#20](https://github.com/boppreh/keyboard/issues/20) -- Key suppression/blocking only available on Windows. [#22](https://github.com/boppreh/keyboard/issues/22) -- To avoid depending on X, the Linux parts reads raw device files (`/dev/input/input*`) -but this requires root. -- Other applications, such as some games, may register hooks that swallow all -key events. In this case `keyboard` will be unable to report events. -- This program makes no attempt to hide itself, so don't use it for keyloggers or online gaming bots. Be responsible. -""" - -Callback = typing.Callable[[KeyboardEvent], None] +Callback = Callable[[KeyboardEvent], None] version: str -_is_str = typing.Callable[[typing.Any], bool] -_is_number = typing.Callable[[typing.Any], bool] -_is_list: typing.Callable[[typing.Any], bool] +_is_str = Callable[[Any], bool] +_is_number = Callable[[Any], bool] +_is_list: Callable[[Any], bool] class _State: @@ -120,17 +46,10 @@ class _Event(_UninterruptibleEvent): ... -if _platform.system() == 'Windows': - ... -else: - ... _modifier_scan_codes: set def is_modifier(key) -> bool: - """ - Returns True if `key` is a scan code or name of a modifier key. - """ ... @@ -179,15 +98,6 @@ class _KeyboardListener(_GenericListener): ... def direct_callback(self, event): - """ - This function is called for every OS keyboard event and decides if the - event should be blocked or not, and passes a copy of the event to - other, non-blocking, listeners. - - There are two ways to block events: remapped keys, which translate - events by suppressing and re-emitting; and blocked hotkeys, which - suppress specific hotkeys. - """ ... def listen(self) -> None: @@ -197,47 +107,18 @@ class _KeyboardListener(_GenericListener): _listener: _KeyboardListener -def key_to_scan_codes(key: typing.Union[int, str, typing.List[typing.Union[int, str]]], error_if_missing: bool = ...) -> typing.List[int]: - """ - Returns a list of scan codes associated with this key (name or scan code). - """ +def key_to_scan_codes(key: Union[int, str, list[Union[int, str]]], error_if_missing: bool = ...) -> list[int]: ... -def parse_hotkey(hotkey) -> tuple[tuple[tuple[Unknown] | Unknown | tuple[()] | tuple[Unknown, ...]]] | tuple[tuple[tuple[Unknown] | Unknown | tuple[()] | tuple[Unknown, ...], ...]] | tuple[Unknown, ...]: - """ - Parses a user-provided hotkey into nested tuples representing the - parsed structure, with the bottom values being lists of scan codes. - Also accepts raw scan codes, which are then wrapped in the required - number of nestings. - - Example: - - parse_hotkey("alt+shift+a, alt+b, c") - # Keys: ^~^ ^~~~^ ^ ^~^ ^ ^ - # Steps: ^~~~~~~~~~^ ^~~~^ ^ - - # ((alt_codes, shift_codes, a_codes), (alt_codes, b_codes), (c_codes,)) - """ +def parse_hotkey(hotkey) -> tuple[ + tuple[tuple[int] | int | tuple[()] | tuple[int, ...]] + | tuple[tuple[tuple[int] | int | tuple[()] | tuple[int, ...], ...]] + | tuple[int, ...]]: ... -def send(hotkey: typing.Union[str, int], do_press: bool = ..., do_release: bool = ...) -> None: - """ - Sends OS events that perform the given *hotkey* hotkey. - - - `hotkey` can be either a scan code (e.g. 57 for space), single key - (e.g. 'space') or multi-key, multi-step hotkey (e.g. 'alt+F4, enter'). - - `do_press` if true then press events are sent. Defaults to True. - - `do_release` if true then release events are sent. Defaults to True. - - send(57) - send('ctrl+alt+del') - send('alt+F4, enter') - send('shift+s') - - Note: keys are released in the opposite order they were pressed. - """ +def send(hotkey: Union[str, int], do_press: bool = ..., do_release: bool = ...) -> None: ... @@ -245,102 +126,52 @@ press_and_release = send def press(hotkey) -> None: - """ Presses and holds down a hotkey (see `send`). """ ... def release(hotkey) -> None: - """ Releases a hotkey (see `send`). """ ... def is_pressed(hotkey) -> bool: - """ - Returns True if the key is pressed. - - is_pressed(57) #-> True - is_pressed('space') #-> True - is_pressed('ctrl+space') #-> True - """ ... def call_later(fn, args=..., delay=...) -> None: - """ - Calls the provided function in a new thread after waiting some time. - Useful for giving the system some time to process an event, without blocking - the current execution flow. - """ ... -_hooks: dict[typing.Callable, Unknown] - - -def hook(callback: Callback, suppress=..., on_remove=...) -> typing.Callable[[], None]: - """ - Installs a global listener on all available keyboards, invoking `callback` - each time a key is pressed or released. +_hooks: dict[Callable, Unknown] - The event passed to the callback is of type `keyboard.KeyboardEvent`, - with the following attributes: - - `name`: an Unicode representation of the character (e.g. "&") or - description (e.g. "space"). The name is always lower-case. - - `scan_code`: number representing the physical key, e.g. 55. - - `time`: timestamp of the time the event occurred, with as much precision - as given by the OS. - - Returns the given callback for easier development. - """ +def hook(callback: Callback, suppress=..., on_remove=...) -> Callable[[], None]: ... -def on_press(callback: Callback, suppress=...) -> typing.Callable[[], None]: - """ - Invokes `callback` for every KEY_DOWN event. For details see `hook`. - """ +def on_press(callback: Callback, suppress=...) -> Callable[[], None]: ... -def on_release(callback: Callback, suppress=...) -> typing.Callable[[], None]: - """ - Invokes `callback` for every KEY_UP event. For details see `hook`. - """ +def on_release(callback: Callback, suppress=...) -> Callable[[], None]: ... -def hook_key(key: typing.Union[int, str, typing.List[typing.Union[int, str]]], callback: Callback, suppress: bool = ...) -> typing.Callable[[], None]: - """ - Hooks key up and key down events for a single key. Returns the event handler - created. To remove a hooked key use `unhook_key(key)` or - `unhook_key(handler)`. - - Note: this function shares state with hotkeys, so `clear_all_hotkeys` - affects it as well. - """ +def hook_key(key: Union[int, str, list[Union[int, str]]], + callback: Callback, + suppress: bool = ... + ) -> Callable[[], None]: ... -def on_press_key(key, callback: Callback, suppress=...) -> typing.Callable[[], None]: - """ - Invokes `callback` for KEY_DOWN event related to the given key. For details see `hook`. - """ +def on_press_key(key, callback: Callback, suppress=...) -> Callable[[], None]: ... -def on_release_key(key, callback: Callback, suppress=...) -> typing.Callable[[], None]: - """ - Invokes `callback` for KEY_UP event related to the given key. For details see `hook`. - """ +def on_release_key(key, callback: Callback, suppress=...) -> Callable[[], None]: ... -def unhook(remove: typing.Callable[[], None]) -> None: - """ - Removes a previously added hook, either by callback or by the return value - of `hook`. - """ +def unhook(remove: Callable[[], None]) -> None: ... @@ -348,28 +179,17 @@ unhook_key = unhook def unhook_all() -> None: - """ - Removes all keyboard hooks in use, including hotkeys, abbreviations, word - listeners, `record`ers and `wait`s. - """ ... -def block_key(key) -> typing.Callable[[], None]: - """ - Suppresses all key events of the given key, regardless of modifiers. - """ +def block_key(key) -> Callable[[], None]: ... unblock_key = unhook_key -def remap_key(src, dst) -> typing.Callable[[], None]: - """ - Whenever the key `src` is pressed or released, regardless of modifiers, - press or release the hotkey `dst` instead. - """ +def remap_key(src, dst) -> Callable[[], None]: ... @@ -377,54 +197,19 @@ unremap_key = unhook_key def parse_hotkey_combinations(hotkey) -> tuple[tuple[tuple[Unknown, ...], ...], ...]: - """ - Parses a user-provided hotkey. Differently from `parse_hotkey`, - instead of each step being a list of the different scan codes for each key, - each step is a list of all possible combinations of those scan codes. - """ ... _hotkeys: dict -def add_hotkey(hotkey, callback: Callback, args=..., suppress=..., timeout=..., trigger_on_release=...) -> typing.Callable[[], None]: - """ - Invokes a callback every time a hotkey is pressed. The hotkey must - be in the format `ctrl+shift+a, s`. This would trigger when the user holds - ctrl, shift and "a" at once, releases, and then presses "s". To represent - literal commas, pluses, and spaces, use their names ('comma', 'plus', - 'space'). - - - `args` is an optional list of arguments to passed to the callback during - each invocation. - - `suppress` defines if successful triggers should block the keys from being - sent to other programs. - - `timeout` is the amount of seconds allowed to pass between key presses. - - `trigger_on_release` if true, the callback is invoked on key release instead - of key press. - - The event handler function is returned. To remove a hotkey call - `remove_hotkey(hotkey)` or `remove_hotkey(handler)`. - before the hotkey state is reset. - - Note: hotkeys are activated when the last key is *pressed*, not released. - Note: the callback is executed in a separate thread, asynchronously. For an - example of how to use a callback synchronously, see `wait`. - - Examples: - - # Different but equivalent ways to listen for a spacebar key press. - add_hotkey(' ', print, args=['space was pressed']) - add_hotkey('space', print, args=['space was pressed']) - add_hotkey('Space', print, args=['space was pressed']) - # Here 57 represents the keyboard code for spacebar; so you will be - # pressing 'spacebar', not '57' to activate the print function. - add_hotkey(57, print, args=['space was pressed']) - - add_hotkey('ctrl+q', quit) - add_hotkey('ctrl+alt+enter, space', some_callback) - """ +def add_hotkey(hotkey, + callback: Callable, + args=..., + suppress=..., + timeout=..., + trigger_on_release=... + ) -> Callable[[], None]: ... @@ -432,10 +217,6 @@ register_hotkey = add_hotkey def remove_hotkey(hotkey_or_callback) -> None: - """ - Removes a previously hooked hotkey. Must be called with the value returned - by `add_hotkey`. - """ ... @@ -443,25 +224,13 @@ unregister_hotkey = clear_hotkey = remove_hotkey def unhook_all_hotkeys() -> None: - """ - Removes all keyboard hotkeys in use, including abbreviations, word listeners, - `record`ers and `wait`s. - """ ... unregister_all_hotkeys = remove_all_hotkeys = clear_all_hotkeys = unhook_all_hotkeys -def remap_hotkey(src, dst, suppress=..., trigger_on_release=...) -> typing.Callable[[], None]: - """ - Whenever the hotkey `src` is pressed, suppress it and send - `dst` instead. - - Example: - - remap('alt+w', 'ctrl+up') - """ +def remap_hotkey(src, dst, suppress=..., trigger_on_release=...) -> Callable[[], None]: ... @@ -469,169 +238,61 @@ unremap_hotkey = remove_hotkey def stash_state() -> list[Unknown]: - """ - Builds a list of all currently pressed scan codes, releases them and returns - the list. Pairs well with `restore_state` and `restore_modifiers`. - """ ... def restore_state(scan_codes) -> None: - """ - Given a list of scan_codes ensures these keys, and only these keys, are - pressed. Pairs well with `stash_state`, alternative to `restore_modifiers`. - """ ... def restore_modifiers(scan_codes) -> None: - """ - Like `restore_state`, but only restores modifier keys. - """ ... def write(text, delay=..., restore_state_after=..., exact=...): - """ - Sends artificial keyboard events to the OS, simulating the typing of a given - text. Characters not available on the keyboard are typed as explicit unicode - characters using OS-specific functionality, such as alt+codepoint. - - To ensure text integrity, all currently pressed keys are released before - the text is typed, and modifiers are restored afterwards. - - - `delay` is the number of seconds to wait between keypresses, defaults to - no delay. - - `restore_state_after` can be used to restore the state of pressed keys - after the text is typed, i.e. presses the keys that were released at the - beginning. Defaults to True. - - `exact` forces typing all characters as explicit unicode (e.g. - alt+codepoint or special events). If None, uses platform-specific suggested - value. - """ ... def wait(hotkey=..., suppress=..., trigger_on_release=...) -> None: - """ - Blocks the program execution until the given hotkey is pressed or, - if given no parameters, blocks forever. - """ ... def get_hotkey_name(names=...) -> str: - """ - Returns a string representation of hotkey from the given key names, or - the currently pressed keys if not given. This function: - - - normalizes names; - - removes "left" and "right" prefixes; - - replaces the "+" key name with "plus" to avoid ambiguity; - - puts modifier keys first, in a standardized order; - - sort remaining keys; - - finally, joins everything with "+". - - Example: - - get_hotkey_name(['+', 'left ctrl', 'shift']) - # "ctrl+shift+plus" - """ ... def read_event(suppress: bool = ...) -> KeyboardEvent: - """ - Blocks until a keyboard event happens, then returns that event. - """ ... def read_key(suppress=...): - """ - Blocks until a keyboard event happens, then returns that event's name or, - if missing, its scan code. - """ ... def read_hotkey(suppress=...) -> str: - """ - Similar to `read_key()`, but blocks until the user presses and releases a - hotkey (or single key), then returns a string representing the hotkey - pressed. - - Example: - - read_hotkey() - # "ctrl+shift+p" - """ ... def get_typed_strings(events, allow_backspace=...): - """ - Given a sequence of events, tries to deduce what strings were typed. - Strings are separated when a non-textual key is pressed (such as tab or - enter). Characters are converted to uppercase according to shift and - capslock status. If `allow_backspace` is True, backspaces remove the last - character typed. - - This function is a generator, so you can pass an infinite stream of events - and convert them to strings in real time. - - Note this functions is merely an heuristic. Windows for example keeps per- - process keyboard state such as keyboard layout, and this information is not - available for our hooks. - - get_type_strings(record()) #-> ['This is what', 'I recorded', ''] - """ ... -_recording: typing.Optional[tuple[Unknown | _queue.Queue[Unknown], typing.Callable[[], None]]] +_recording: Optional[tuple[Unknown | _queue.Queue[Unknown], Callable[[], None]]] -def start_recording(recorded_events_queue=...) -> tuple[Unknown | _queue.Queue[Unknown], typing.Callable[[], None]]: - """ - Starts recording all keyboard events into a global variable, or the given - queue if any. Returns the queue of events and the hooked function. - - Use `stop_recording()` or `unhook(hooked_function)` to stop. - """ +def start_recording(recorded_events_queue=...) -> tuple[Unknown | _queue.Queue[Unknown], Callable[[], None]]: ... -def stop_recording() -> list[Unknown | typing.Any]: - """ - Stops the global recording of events and returns a list of the events - captured. - """ +def stop_recording() -> list[Unknown | Any]: ... -def record(until=..., suppress=..., trigger_on_release=...) -> list[Unknown | typing.Any]: - """ - Records all keyboard events from all keyboards until the user presses the - given hotkey. Then returns the list of events recorded, of type - `keyboard.KeyboardEvent`. Pairs well with - `play(events)`. - - Note: this is a blocking function. - Note: for more details on the keyboard hook and events see `hook`. - """ +def record(until=..., suppress=..., trigger_on_release=...) -> list[Unknown | Any]: ... def play(events, speed_factor=...): - """ - Plays a sequence of recorded events, maintaining the relative time - intervals. If speed_factor is <= 0 then the actions are replayed as fast - as the OS allows. Pairs well with `record()`. - - Note: the current keyboard state is cleared at the beginning and restored at - the end of the function. - """ ... @@ -639,60 +300,25 @@ replay = play _word_listeners: dict -def add_word_listener(word, callback: Callback, triggers=..., match_suffix=..., timeout=...) -> typing.Callable[[], None]: - """ - Invokes a callback every time a sequence of characters is typed (e.g. 'pet') - and followed by a trigger key (e.g. space). Modifiers (e.g. alt, ctrl, - shift) are ignored. - - - `word` the typed text to be matched. E.g. 'pet'. - - `callback` is an argument-less function to be invoked each time the word - is typed. - - `triggers` is the list of keys that will cause a match to be checked. If - the user presses some key that is not a character (len>1) and not in - triggers, the characters so far will be discarded. By default the trigger - is only `space`. - - `match_suffix` defines if endings of words should also be checked instead - of only whole words. E.g. if true, typing 'carpet'+space will trigger the - listener for 'pet'. Defaults to false, only whole words are checked. - - `timeout` is the maximum number of seconds between typed characters before - the current word is discarded. Defaults to 2 seconds. - - Returns the event handler created. To remove a word listener use - `remove_word_listener(word)` or `remove_word_listener(handler)`. - - Note: all actions are performed on key down. Key up events are ignored. - Note: word matches are **case sensitive**. - """ +def add_word_listener( + word, + callback: Callback, + triggers=..., + match_suffix=..., + timeout=... +) -> Callable[[], None]: ... def remove_word_listener(word_or_handler) -> None: - """ - Removes a previously registered word listener. Accepts either the word used - during registration (exact string) or the event handler returned by the - `add_word_listener` or `add_abbreviation` functions. - """ ... -def add_abbreviation(source_text, replacement_text, match_suffix=..., timeout=...) -> typing.Callable[[], None]: - """ - Registers a hotkey that replaces one typed text with another. For example - - add_abbreviation('tm', u'â„ĸ') - - Replaces every "tm" followed by a space with a â„ĸ symbol (and no space). The - replacement is done by sending backspace events. - - - `match_suffix` defines if endings of words should also be checked instead - of only whole words. E.g. if true, typing 'carpet'+space will trigger the - listener for 'pet'. Defaults to false, only whole words are checked. - - `timeout` is the maximum number of seconds between typed characters before - the current word is discarded. Defaults to 2 seconds. - - For more details see `add_word_listener`. - """ +def add_abbreviation(source_text, + replacement_text, + match_suffix=..., + timeout=... + ) -> Callable[[], None]: ... diff --git a/typings/keyboard/_canonical_names.pyi b/typings/keyboard/_canonical_names.pyi new file mode 100644 index 00000000..0f933132 --- /dev/null +++ b/typings/keyboard/_canonical_names.pyi @@ -0,0 +1,11 @@ +""" +This type stub file was generated by pyright. +""" + +canonical_names: dict[str, str] +sided_modifiers: set[str] +all_modifiers: set[str] + + +def normalize_name(name: str) -> str: + ... diff --git a/typings/keyboard/_generic.pyi b/typings/keyboard/_generic.pyi new file mode 100644 index 00000000..9411e0f7 --- /dev/null +++ b/typings/keyboard/_generic.pyi @@ -0,0 +1,38 @@ +""" +This type stub file was generated by pyright. +""" + +from typing import NoReturn +from threading import Lock +try: + from queue import Queue +except ImportError: + from Queue import Queue + + +class GenericListener: + lock: Lock + handlers: list + listening: bool + queue: Queue + + def __init__(self) -> None: + ... + + def invoke_handlers(self, event): + ... + + def start_if_necessary(self) -> None: + ... + + def pre_process_event(self, event): + ... + + def process(self) -> NoReturn: + ... + + def add_handler(self, handler) -> None: + ... + + def remove_handler(self, handler) -> None: + ... diff --git a/typings/keyboard/_keyboard_event.pyi b/typings/keyboard/_keyboard_event.pyi index 72c73f02..65bb2214 100644 --- a/typings/keyboard/_keyboard_event.pyi +++ b/typings/keyboard/_keyboard_event.pyi @@ -18,7 +18,15 @@ class KeyboardEvent: modifiers: Optional[Unknown] = ... is_keypad: Optional[bool] = ... - def __init__(self, event_type: event_type, scan_code, name: name = ..., time: time = ..., device: device = ..., modifiers: modifiers = ..., is_keypad: is_keypad = ...) -> None: + def __init__(self, + event_type: event_type, + scan_code, + name: name = ..., + time: time = ..., + device: device = ..., + modifiers: modifiers = ..., + is_keypad: is_keypad = ... + ) -> None: ... def to_json(self, ensure_ascii: bool = ...) -> str: diff --git a/typings/pyautogui/__init__.pyi b/typings/pyautogui/__init__.pyi index 1cccf90e..aad11582 100644 --- a/typings/pyautogui/__init__.pyi +++ b/typings/pyautogui/__init__.pyi @@ -1,79 +1,48 @@ """ This type stub file was generated by pyright. """ -from typing import * +from __future__ import absolute_import, division, print_function import sys -import time import datetime -import os -import platform -import re -import functools -import collections -import collections.abc -from __future__ import absolute_import, division, print_function +from collections.abc import Callable from contextlib import contextmanager -__version__ = ... +__version__: str = ... class PyAutoGUIException(Exception): - """ - PyAutoGUI code will raise this exception class for any invalid actions. If PyAutoGUI raises some other exception, - you should assume that this is caused by a bug in PyAutoGUI itself. (Including a failure to catch potential - exceptions raised by PyAutoGUI.) - """ ... class FailSafeException(PyAutoGUIException): - """ - This exception is raised by PyAutoGUI functions when the user puts the mouse cursor into one of the "failsafe - points" (by default, one of the four corners of the primary monitor). This exception shouldn't be caught; it's - meant to provide a way to terminate a misbehaving script. - """ ... class ImageNotFoundException(PyAutoGUIException): - """ - This exception is the PyAutoGUI version of PyScreeze's `ImageNotFoundException`, which is raised when a locate*() - function call is unable to find an image. - - Ideally, `pyscreeze.ImageNotFoundException` should never be raised by PyAutoGUI. - """ ... -if sys.version_info[0] == 2 or sys.version_info[0: 2] in ((3, 1), (3, 2)): - collectionsSequence = ... +if sys.version_info[0] == 2 or sys.version_info[0:2] in ((3, 1), (3, 2)): + # Python 2 and 3.1 and 3.2 uses collections.Sequence + import collections + + collectionsSequence = collections.Sequence else: - collectionsSequence = ... + # Python 3.3+ uses collections.abc.Sequence + import collections.abc + + collectionsSequence = collections.abc.Sequence # type: ignore def raisePyAutoGUIImageNotFoundException(wrappedFunction) -> Callable: - """ - A decorator that wraps PyScreeze locate*() functions so that the PyAutoGUI user sees them raise PyAutoGUI's - ImageNotFoundException rather than PyScreeze's ImageNotFoundException. This is because PyScreeze should be - invisible to PyAutoGUI users. - """ ... def useImageNotFoundException(value=...) -> None: - """ - When called with no arguments, PyAutoGUI will raise ImageNotFoundException when the PyScreeze locate*() functions - can't find the image it was told to locate. The default behavior is to return None. Call this function with no - arguments (or with True as the argument) to have exceptions raised, which is a better practice. - - You can also disable raising exceptions by passing False for the argument. - """ ... -if sys.platform == "win32": - ... KEY_NAMES = ... KEYBOARD_KEYS = ... LEFT = ... @@ -86,17 +55,9 @@ QWERTZ = ... def isShiftCharacter(character) -> bool: - """ - Returns True if the ``character`` is a keyboard key that would require the shift key to be held down, such as - uppercase letters or the symbols on the keyboard's number row. - """ ... -if sys.platform.startswith("java"): - ... -else: - ... MINIMUM_DURATION = ... MINIMUM_SLEEP = ... PAUSE = ... @@ -111,430 +72,96 @@ Size = ... def getPointOnLine(x1, y1, x2, y2, n) -> tuple[Unknown, Unknown]: - """ - Returns an (x, y) tuple of the point that has progressed a proportion ``n`` along the line defined by the two - ``x1``, ``y1`` and ``x2``, ``y2`` coordinates. - - This function was copied from pytweening module, so that it can be called even if PyTweening is not installed. - """ ... def linear(n): - """ - Returns ``n``, where ``n`` is the float argument between ``0.0`` and ``1.0``. This function is for the default - linear tween for mouse moving functions. - - This function was copied from PyTweening module, so that it can be called even if PyTweening is not installed. - """ ... def position(x=..., y=...) -> Point: - """ - Returns the current xy coordinates of the mouse cursor as a two-integer tuple. - - Args: - x (int, None, optional) - If not None, this argument overrides the x in - the return value. - y (int, None, optional) - If not None, this argument overrides the y in - the return value. - - Returns: - (x, y) tuple of the current xy coordinates of the mouse cursor. - - NOTE: The position() function doesn't check for failsafe. - """ ... def size() -> Size: - """Returns the width and height of the screen as a two-integer tuple. - - Returns: - (width, height) tuple of the screen size, in pixels. - """ ... def onScreen(x, y=...) -> bool: - """Returns whether the given xy coordinates are on the primary screen or not. - - Note that this function doesn't work for secondary screens. - - Args: - Either the arguments are two separate values, first arg for x and second - for y, or there is a single argument of a sequence with two values, the - first x and the second y. - Example: onScreen(x, y) or onScreen([x, y]) - - Returns: - bool: True if the xy coordinates are on the screen at its current - resolution, otherwise False. - """ ... @_genericPyAutoGUIChecks def mouseDown(x=..., y=..., button=..., duration=..., tween=..., logScreenshot=..., _pause=...) -> None: - """Performs pressing a mouse button down (but not up). - - The x and y parameters detail where the mouse event happens. If None, the - current mouse position is used. If a float value, it is rounded down. If - outside the boundaries of the screen, the event happens at edge of the - screen. - - Args: - x (int, float, None, tuple, optional): The x position on the screen where the - mouse down happens. None by default. If tuple, this is used for x and y. - If x is a str, it's considered a filename of an image to find on - the screen with locateOnScreen() and click the center of. - y (int, float, None, optional): The y position on the screen where the - mouse down happens. None by default. - button (str, int, optional): The mouse button pressed down. TODO - - Returns: - None - - Raises: - PyAutoGUIException: If button is not one of 'left', 'middle', 'right', 1, 2, or 3 - """ ... @_genericPyAutoGUIChecks def mouseUp(x=..., y=..., button=..., duration=..., tween=..., logScreenshot=..., _pause=...) -> None: - """Performs releasing a mouse button up (but not down beforehand). - - The x and y parameters detail where the mouse event happens. If None, the - current mouse position is used. If a float value, it is rounded down. If - outside the boundaries of the screen, the event happens at edge of the - screen. - - Args: - x (int, float, None, tuple, optional): The x position on the screen where the - mouse up happens. None by default. If tuple, this is used for x and y. - If x is a str, it's considered a filename of an image to find on - the screen with locateOnScreen() and click the center of. - y (int, float, None, optional): The y position on the screen where the - mouse up happens. None by default. - button (str, int, optional): The mouse button released. TODO - - Returns: - None - - Raises: - PyAutoGUIException: If button is not one of 'left', 'middle', 'right', 1, 2, or 3 - """ ... @_genericPyAutoGUIChecks -def click(x=..., y=..., clicks=..., interval=..., button=..., duration=..., tween=..., logScreenshot=..., _pause=...) -> None: - """ - Performs pressing a mouse button down and then immediately releasing it. Returns ``None``. - - When no arguments are passed, the primary mouse button is clicked at the mouse cursor's current location. - - If integers for ``x`` and ``y`` are passed, the click will happen at that XY coordinate. If ``x`` is a string, the - string is an image filename that PyAutoGUI will attempt to locate on the screen and click the center of. If ``x`` - is a sequence of two coordinates, those coordinates will be used for the XY coordinate to click on. - - The ``clicks`` argument is an int of how many clicks to make, and defaults to ``1``. - - The ``interval`` argument is an int or float of how many seconds to wait in between each click, if ``clicks`` is - greater than ``1``. It defaults to ``0.0`` for no pause in between clicks. - - The ``button`` argument is one of the constants ``LEFT``, ``MIDDLE``, ``RIGHT``, ``PRIMARY``, or ``SECONDARY``. - It defaults to ``PRIMARY`` (which is the left mouse button, unless the operating system has been set for - left-handed users.) - - If ``x`` and ``y`` are specified, and the click is not happening at the mouse cursor's current location, then - the ``duration`` argument is an int or float of how many seconds it should take to move the mouse to the XY - coordinates. It defaults to ``0`` for an instant move. - - If ``x`` and ``y`` are specified and ``duration`` is not ``0``, the ``tween`` argument is a tweening function - that specifies the movement pattern of the mouse cursor as it moves to the XY coordinates. The default is a - simple linear tween. See the PyTweening module documentation for more details. - - The ``pause`` parameter is deprecated. Call the ``pyautogui.sleep()`` function to implement a pause. - - Raises: - PyAutoGUIException: If button is not one of 'left', 'middle', 'right', 1, 2, 3 - """ +def click( + x=..., + y=..., + clicks=..., + interval=..., + button=..., + duration=..., + tween=..., + logScreenshot=..., + _pause=...) -> None: ... @_genericPyAutoGUIChecks def leftClick(x=..., y=..., interval=..., duration=..., tween=..., logScreenshot=..., _pause=...) -> None: - """Performs a left mouse button click. - - This is a wrapper function for click('left', x, y). - - The x and y parameters detail where the mouse event happens. If None, the - current mouse position is used. If a float value, it is rounded down. If - outside the boundaries of the screen, the event happens at edge of the - screen. - - Args: - x (int, float, None, tuple, optional): The x position on the screen where the - click happens. None by default. If tuple, this is used for x and y. - If x is a str, it's considered a filename of an image to find on - the screen with locateOnScreen() and click the center of. - y (int, float, None, optional): The y position on the screen where the - click happens. None by default. - interval (float, optional): The number of seconds in between each click, - if the number of clicks is greater than 1. 0.0 by default, for no - pause in between clicks. - - Returns: - None - """ ... @_genericPyAutoGUIChecks def rightClick(x=..., y=..., interval=..., duration=..., tween=..., logScreenshot=..., _pause=...) -> None: - """Performs a right mouse button click. - - This is a wrapper function for click('right', x, y). - - The x and y parameters detail where the mouse event happens. If None, the - current mouse position is used. If a float value, it is rounded down. If - outside the boundaries of the screen, the event happens at edge of the - screen. - - Args: - x (int, float, None, tuple, optional): The x position on the screen where the - click happens. None by default. If tuple, this is used for x and y. - If x is a str, it's considered a filename of an image to find on - the screen with locateOnScreen() and click the center of. - y (int, float, None, optional): The y position on the screen where the - click happens. None by default. - interval (float, optional): The number of seconds in between each click, - if the number of clicks is greater than 1. 0.0 by default, for no - pause in between clicks. - - Returns: - None - """ ... @_genericPyAutoGUIChecks def middleClick(x=..., y=..., interval=..., duration=..., tween=..., logScreenshot=..., _pause=...) -> None: - """Performs a middle mouse button click. - - This is a wrapper function for click('middle', x, y). - - The x and y parameters detail where the mouse event happens. If None, the - current mouse position is used. If a float value, it is rounded down. If - outside the boundaries of the screen, the event happens at edge of the - screen. - - Args: - x (int, float, None, tuple, optional): The x position on the screen where the - click happens. None by default. If tuple, this is used for x and y. - If x is a str, it's considered a filename of an image to find on - the screen with locateOnScreen() and click the center of. - y (int, float, None, optional): The y position on the screen where the - click happens. None by default. - - Returns: - None - """ ... @_genericPyAutoGUIChecks def doubleClick(x=..., y=..., interval=..., button=..., duration=..., tween=..., logScreenshot=..., _pause=...) -> None: - """Performs a double click. - - This is a wrapper function for click('left', x, y, 2, interval). - - The x and y parameters detail where the mouse event happens. If None, the - current mouse position is used. If a float value, it is rounded down. If - outside the boundaries of the screen, the event happens at edge of the - screen. - - Args: - x (int, float, None, tuple, optional): The x position on the screen where the - click happens. None by default. If tuple, this is used for x and y. - If x is a str, it's considered a filename of an image to find on - the screen with locateOnScreen() and click the center of. - y (int, float, None, optional): The y position on the screen where the - click happens. None by default. - interval (float, optional): The number of seconds in between each click, - if the number of clicks is greater than 1. 0.0 by default, for no - pause in between clicks. - button (str, int, optional): The mouse button released. TODO - - Returns: - None - - Raises: - PyAutoGUIException: If button is not one of 'left', 'middle', 'right', 1, 2, 3, 4, - 5, 6, or 7 - """ ... @_genericPyAutoGUIChecks def tripleClick(x=..., y=..., interval=..., button=..., duration=..., tween=..., logScreenshot=..., _pause=...) -> None: - """Performs a triple click. - - This is a wrapper function for click('left', x, y, 3, interval). - - The x and y parameters detail where the mouse event happens. If None, the - current mouse position is used. If a float value, it is rounded down. If - outside the boundaries of the screen, the event happens at edge of the - screen. - - Args: - x (int, float, None, tuple, optional): The x position on the screen where the - click happens. None by default. If tuple, this is used for x and y. - If x is a str, it's considered a filename of an image to find on - the screen with locateOnScreen() and click the center of. - y (int, float, None, optional): The y position on the screen where the - click happens. None by default. - interval (float, optional): The number of seconds in between each click, - if the number of clicks is greater than 1. 0.0 by default, for no - pause in between clicks. - button (str, int, optional): The mouse button released. TODO - - Returns: - None - - Raises: - PyAutoGUIException: If button is not one of 'left', 'middle', 'right', 1, 2, 3, 4, - 5, 6, or 7 - """ ... @_genericPyAutoGUIChecks def scroll(clicks, x=..., y=..., logScreenshot=..., _pause=...) -> None: - """Performs a scroll of the mouse scroll wheel. - - Whether this is a vertical or horizontal scroll depends on the underlying - operating system. - - The x and y parameters detail where the mouse event happens. If None, the - current mouse position is used. If a float value, it is rounded down. If - outside the boundaries of the screen, the event happens at edge of the - screen. - - Args: - clicks (int, float): The amount of scrolling to perform. - x (int, float, None, tuple, optional): The x position on the screen where the - click happens. None by default. If tuple, this is used for x and y. - y (int, float, None, optional): The y position on the screen where the - click happens. None by default. - - Returns: - None - """ ... @_genericPyAutoGUIChecks def hscroll(clicks, x=..., y=..., logScreenshot=..., _pause=...) -> None: - """Performs an explicitly horizontal scroll of the mouse scroll wheel, - if this is supported by the operating system. (Currently just Linux.) - - The x and y parameters detail where the mouse event happens. If None, the - current mouse position is used. If a float value, it is rounded down. If - outside the boundaries of the screen, the event happens at edge of the - screen. - - Args: - clicks (int, float): The amount of scrolling to perform. - x (int, float, None, tuple, optional): The x position on the screen where the - click happens. None by default. If tuple, this is used for x and y. - y (int, float, None, optional): The y position on the screen where the - click happens. None by default. - - Returns: - None - """ ... @_genericPyAutoGUIChecks def vscroll(clicks, x=..., y=..., logScreenshot=..., _pause=...) -> None: - """Performs an explicitly vertical scroll of the mouse scroll wheel, - if this is supported by the operating system. (Currently just Linux.) - - The x and y parameters detail where the mouse event happens. If None, the - current mouse position is used. If a float value, it is rounded down. If - outside the boundaries of the screen, the event happens at edge of the - screen. - - Args: - clicks (int, float): The amount of scrolling to perform. - x (int, float, None, tuple, optional): The x position on the screen where the - click happens. None by default. If tuple, this is used for x and y. - y (int, float, None, optional): The y position on the screen where the - click happens. None by default. - - Returns: - None - """ ... @_genericPyAutoGUIChecks def moveTo(x=..., y=..., duration=..., tween=..., logScreenshot=..., _pause=...) -> None: - """Moves the mouse cursor to a point on the screen. - - The x and y parameters detail where the mouse event happens. If None, the - current mouse position is used. If a float value, it is rounded down. If - outside the boundaries of the screen, the event happens at edge of the - screen. - - Args: - x (int, float, None, tuple, optional): The x position on the screen where the - click happens. None by default. If tuple, this is used for x and y. - If x is a str, it's considered a filename of an image to find on - the screen with locateOnScreen() and click the center of. - y (int, float, None, optional): The y position on the screen where the - click happens. None by default. - duration (float, optional): The amount of time it takes to move the mouse - cursor to the xy coordinates. If 0, then the mouse cursor is moved - instantaneously. 0.0 by default. - tween (func, optional): The tweening function used if the duration is not - 0. A linear tween is used by default. - - Returns: - None - """ ... @_genericPyAutoGUIChecks def moveRel(xOffset=..., yOffset=..., duration=..., tween=..., logScreenshot=..., _pause=...) -> None: - """Moves the mouse cursor to a point on the screen, relative to its current - position. - - The x and y parameters detail where the mouse event happens. If None, the - current mouse position is used. If a float value, it is rounded down. If - outside the boundaries of the screen, the event happens at edge of the - screen. - - Args: - x (int, float, None, tuple, optional): How far left (for negative values) or - right (for positive values) to move the cursor. 0 by default. If tuple, this is used for x and y. - y (int, float, None, optional): How far up (for negative values) or - down (for positive values) to move the cursor. 0 by default. - duration (float, optional): The amount of time it takes to move the mouse - cursor to the new xy coordinates. If 0, then the mouse cursor is moved - instantaneously. 0.0 by default. - tween (func, optional): The tweening function used if the duration is not - 0. A linear tween is used by default. - - Returns: - None - """ ... @@ -543,63 +170,19 @@ move = ... @_genericPyAutoGUIChecks def dragTo(x=..., y=..., duration=..., tween=..., button=..., logScreenshot=..., _pause=..., mouseDownUp=...) -> None: - """Performs a mouse drag (mouse movement while a button is held down) to a - point on the screen. - - The x and y parameters detail where the mouse event happens. If None, the - current mouse position is used. If a float value, it is rounded down. If - outside the boundaries of the screen, the event happens at edge of the - screen. - - Args: - x (int, float, None, tuple, optional): How far left (for negative values) or - right (for positive values) to move the cursor. 0 by default. If tuple, this is used for x and y. - If x is a str, it's considered a filename of an image to find on - the screen with locateOnScreen() and click the center of. - y (int, float, None, optional): How far up (for negative values) or - down (for positive values) to move the cursor. 0 by default. - duration (float, optional): The amount of time it takes to move the mouse - cursor to the new xy coordinates. If 0, then the mouse cursor is moved - instantaneously. 0.0 by default. - tween (func, optional): The tweening function used if the duration is not - 0. A linear tween is used by default. - button (str, int, optional): The mouse button released. TODO - mouseDownUp (True, False): When true, the mouseUp/Down actions are not performed. - Which allows dragging over multiple (small) actions. 'True' by default. - - Returns: - None - """ ... @_genericPyAutoGUIChecks -def dragRel(xOffset=..., yOffset=..., duration=..., tween=..., button=..., logScreenshot=..., _pause=..., mouseDownUp=...): - """Performs a mouse drag (mouse movement while a button is held down) to a - point on the screen, relative to its current position. - - The x and y parameters detail where the mouse event happens. If None, the - current mouse position is used. If a float value, it is rounded down. If - outside the boundaries of the screen, the event happens at edge of the - screen. - - Args: - x (int, float, None, tuple, optional): How far left (for negative values) or - right (for positive values) to move the cursor. 0 by default. If tuple, this is used for xOffset and yOffset. - y (int, float, None, optional): How far up (for negative values) or - down (for positive values) to move the cursor. 0 by default. - duration (float, optional): The amount of time it takes to move the mouse - cursor to the new xy coordinates. If 0, then the mouse cursor is moved - instantaneously. 0.0 by default. - tween (func, optional): The tweening function used if the duration is not - 0. A linear tween is used by default. - button (str, int, optional): The mouse button released. TODO - mouseDownUp (True, False): When true, the mouseUp/Down actions are not performed. - Which allows dragging over multiple (small) actions. 'True' by default. - - Returns: - None - """ +def dragRel( + xOffset=..., + yOffset=..., + duration=..., + tween=..., + button=..., + logScreenshot=..., + _pause=..., + mouseDownUp=...): ... @@ -607,115 +190,32 @@ drag = ... def isValidKey(key) -> bool: - """Returns a Boolean value if the given key is a valid value to pass to - PyAutoGUI's keyboard-related functions for the current platform. - - This function is here because passing an invalid value to the PyAutoGUI - keyboard functions currently is a no-op that does not raise an exception. - - Some keys are only valid on some platforms. For example, while 'esc' is - valid for the Escape key on all platforms, 'browserback' is only used on - Windows operating systems. - - Args: - key (str): The key value. - - Returns: - bool: True if key is a valid value, False if not. - """ ... @_genericPyAutoGUIChecks def keyDown(key, logScreenshot=..., _pause=...) -> None: - """Performs a keyboard key press without the release. This will put that - key in a held down state. - - NOTE: For some reason, this does not seem to cause key repeats like would - happen if a keyboard key was held down on a text field. - - Args: - key (str): The key to be pressed down. The valid names are listed in - KEYBOARD_KEYS. - - Returns: - None - """ ... @_genericPyAutoGUIChecks def keyUp(key, logScreenshot=..., _pause=...) -> None: - """Performs a keyboard key release (without the press down beforehand). - - Args: - key (str): The key to be released up. The valid names are listed in - KEYBOARD_KEYS. - - Returns: - None - """ ... @_genericPyAutoGUIChecks def press(keys, presses=..., interval=..., logScreenshot=..., _pause=...): - """Performs a keyboard key press down, followed by a release. - - Args: - key (str, list): The key to be pressed. The valid names are listed in - KEYBOARD_KEYS. Can also be a list of such strings. - presses (integer, optional): The number of press repetitions. - 1 by default, for just one press. - interval (float, optional): How many seconds between each press. - 0.0 by default, for no pause between presses. - pause (float, optional): How many seconds in the end of function process. - None by default, for no pause in the end of function process. - Returns: - None - """ ... @contextmanager @_genericPyAutoGUIChecks def hold(keys, logScreenshot=..., _pause=...): - """Context manager that performs a keyboard key press down upon entry, - followed by a release upon exit. - - Args: - key (str, list): The key to be pressed. The valid names are listed in - KEYBOARD_KEYS. Can also be a list of such strings. - pause (float, optional): How many seconds in the end of function process. - None by default, for no pause in the end of function process. - Returns: - None - """ ... @_genericPyAutoGUIChecks def typewrite(message, interval=..., logScreenshot=..., _pause=...) -> None: - """Performs a keyboard key press down, followed by a release, for each of - the characters in message. - - The message argument can also be list of strings, in which case any valid - keyboard name can be used. - - Since this performs a sequence of keyboard presses and does not hold down - keys, it cannot be used to perform keyboard shortcuts. Use the hotkey() - function for that. - - Args: - message (str, list): If a string, then the characters to be pressed. If a - list, then the key names of the keys to press in order. The valid names - are listed in KEYBOARD_KEYS. - interval (float, optional): The number of seconds in between each press. - 0.0 by default, for no pause in between presses. - - Returns: - None - """ ... @@ -724,21 +224,6 @@ write = ... @_genericPyAutoGUIChecks def hotkey(*args: str, **kwargs: Union[int, bool, None]) -> None: - """Performs key down presses on the arguments passed in order, then performs - key releases in reverse order. - - The effect is that calling hotkey('ctrl', 'shift', 'c') would perform a - "Ctrl-Shift-C" hotkey/keyboard shortcut press. - - Args: - key(s) (str): The series of keys to press, in order. This can also be a - list of key strings to press. - interval (float, optional): The number of seconds in between each press. - 0.0 by default, for no pause in between presses. - - Returns: - None - """ ... @@ -747,8 +232,6 @@ def failSafeCheck() -> None: def displayMousePosition(xOffset=..., yOffset=...): - """This function is meant to be run from the command line. It will - automatically display the location and RGB of the mouse cursor.""" ... @@ -761,48 +244,6 @@ def countdown(seconds) -> None: def run(commandStr, _ssCount=...) -> None: - """Run a series of PyAutoGUI function calls according to a mini-language - made for this function. The `commandStr` is composed of character - commands that represent PyAutoGUI function calls. - - For example, `run('ccg-20,+0c')` clicks the mouse twice, then makes - the mouse cursor go 20 pixels to the left, then click again. - - Whitespace between commands and arguments is ignored. Command characters - must be lowercase. Quotes must be single quotes. - - For example, the previous call could also be written as `run('c c g -20, +0 c')`. - - The character commands and their equivalents are here: - - `c` => `click(button=PRIMARY)` - `l` => `click(button=LEFT)` - `m` => `click(button=MIDDLE)` - `r` => `click(button=RIGHT)` - `su` => `scroll(1) # scroll up` - `sd` => `scroll(-1) # scroll down` - `ss` => `screenshot('screenshot1.png') # filename number increases on its own` - - `gX,Y` => `moveTo(X, Y)` - `g+X,-Y` => `move(X, Y) # The + or - prefix is the difference between move() and moveTo()` - `dX,Y` => `dragTo(X, Y)` - `d+X,-Y` => `drag(X, Y) # The + or - prefix is the difference between drag() and dragTo()` - - `k'key'` => `press('key')` - `w'text'` => `write('text')` - `h'key,key,key'` => `hotkey(*'key,key,key'.replace(' ', '').split(','))` - `a'hello'` => `alert('hello')` - - `sN` => `sleep(N) # N can be an int or float` - `pN` => `PAUSE = N # N can be an int or float` - - `fN(commands)` => for i in range(N): run(commands) - - Note that any changes to `PAUSE` with the `p` command will be undone when - this function returns. The original `PAUSE` setting will be reset. - - TODO - This function is under development. - """ ... diff --git a/typings/pythonwin-stubs/win32typing.pyi b/typings/pythonwin-stubs/win32typing.pyi index 270cb353..e5b83b65 100644 --- a/typings/pythonwin-stubs/win32typing.pyi +++ b/typings/pythonwin-stubs/win32typing.pyi @@ -1,222 +1,787 @@ -__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'] -from typing import * +__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'] +from typing import Any, Union + class COMMTIMEOUTS(object): - """A tuple representing a COMMTIMEOUTS structure.""" + """A tuple representing a COMMTIMEOUTS structure.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class CopyProgressRoutine(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class DOCINFO(object): - """A tuple of information representing a DOCINFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def DocName(self)->'Union[str]': - """Name of document""" - pass + """A tuple of information representing a DOCINFO struct""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def Output(self)->'Union[str]': - """Name of output file when printing to file. Use None for normal printing.""" - pass + @property + def DocName(self) -> 'Union[str]': + """Name of document""" + pass + @property + def Output(self) -> 'Union[str]': + """Name of output file when printing to file. Use None for normal printing.""" + pass - @property - def DataType(self)->'Union[str]': - """Type of data to be sent to printer, eg RAW, EMF, TEXT. Use None for printer default.""" - pass + @property + def DataType(self) -> 'Union[str]': + """Type of data to be sent to printer, eg RAW, EMF, TEXT. Use None for printer default.""" + pass - - @property - def Type(self)->'Any': - """Flag specifying mode of operation. Can be DI_APPBANDING, DI_ROPS_READ_DESTINATION, or 0""" - pass + @property + def Type(self) -> 'Any': + """Flag specifying mode of operation. Can be DI_APPBANDING, DI_ROPS_READ_DESTINATION, or 0""" + pass class ExportCallback(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class FORM_INFO_1(object): - """A dictionary containing FORM_INFO_1W data""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Flags(self)->'Any': - """FORM_USER, FORM_BUILTIN, or FORM_PRINTER""" - pass + """A dictionary containing FORM_INFO_1W data""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def Name(self)->'str': - """Name of form""" - pass + @property + def Flags(self) -> 'Any': + """FORM_USER, FORM_BUILTIN, or FORM_PRINTER""" + pass + @property + def Name(self) -> 'str': + """Name of form""" + pass - @property - def Size(self)->'Any': - """A dictionary representing a SIZEL structure {'cx':int,'cy':int}""" - pass + @property + def Size(self) -> 'Any': + """A dictionary representing a SIZEL structure {'cx':int,'cy':int}""" + pass - - @property - def ImageableArea(self)->'Any': - """A dictionary representing a RECTL structure {'left':int, 'top':int, 'right':int, 'bottom':int}""" - pass + @property + def ImageableArea(self) -> 'Any': + """A dictionary representing a RECTL structure {'left':int, 'top':int, 'right':int, 'bottom':int}""" + pass class ImportCallback(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class LARGE_INTEGER(object): - """A Python object used wherever a COM LARGE_INTEGER is used.""" + """A Python object used wherever a COM LARGE_INTEGER is used.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class NCB(object): - """A Python object that encapsulates a Win32 NCB structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Command(self)->'Any': - """""" - pass - - - @property - def Retcode(self)->'Any': - """""" - pass - - - @property - def Lsn(self)->'Any': - """""" - pass - - - @property - def Num(self)->'Any': - """""" - pass - - - @property - def Bufflen(self)->'Any': - """read-only""" - pass - - - @property - def Callname(self)->'str': - """- The strings need to be space padded to 16 chars exactly""" - pass - - - @property - def Name(self)->'str': - """- The strings need to be space padded to 16 chars exactly""" - pass - - - @property - def Rto(self)->'str': - """- The strings need to be space padded to 16 chars exactly""" - pass - - - @property - def Sto(self)->'str': - """- The strings need to be space padded to 16 chars exactly""" - pass - - - @property - def Lana_num(self)->'Any': - """""" - pass - - - @property - def Cmd_cplt(self)->'Any': - """""" - pass - - - @property - def Event(self)->'Any': - """""" - pass - - - @property - def Post(self)->'Any': - """""" - pass + """A Python object that encapsulates a Win32 NCB structure.""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def Command(self) -> 'Any': + """""" + pass + + @property + def Retcode(self) -> 'Any': + """""" + pass + + @property + def Lsn(self) -> 'Any': + """""" + pass + + @property + def Num(self) -> 'Any': + """""" + pass + + @property + def Bufflen(self) -> 'Any': + """read-only""" + pass + + @property + def Callname(self) -> 'str': + """- The strings need to be space padded to 16 chars exactly""" + pass + + @property + def Name(self) -> 'str': + """- The strings need to be space padded to 16 chars exactly""" + pass + + @property + def Rto(self) -> 'str': + """- The strings need to be space padded to 16 chars exactly""" + pass + + @property + def Sto(self) -> 'str': + """- The strings need to be space padded to 16 chars exactly""" + pass + + @property + def Lana_num(self) -> 'Any': + """""" + pass + + @property + def Cmd_cplt(self) -> 'Any': + """""" + pass + + @property + def Event(self) -> 'Any': + """""" + pass + + @property + def Post(self) -> 'Any': + """""" + pass class PRINTER_DEFAULTS(object): - """A dictionary representing a PRINTER_DEFAULTS structure""" + """A dictionary representing a PRINTER_DEFAULTS structure""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def pDatatype(self) -> 'str': + """Data type to be used for print jobs, see win32print::EnumPrintProcessorDatatypes, optional, can be None""" + pass - @property - def pDatatype(self)->'str': - """Data type to be used for print jobs, see win32print::EnumPrintProcessorDatatypes, optional, can be None""" - pass + @property + def pDevMode(self) -> 'PyDEVMODE': + """A PyDEVMODE that specifies default printer parameters, optional, can be None""" + pass - - @property - def pDevMode(self)->'PyDEVMODE': - """A PyDEVMODE that specifies default printer parameters, optional, can be None""" - pass - - - @property - def DesiredAccess(self)->'Any': - """An ACCESS_MASK specifying what level of access is needed, eg PRINTER_ACCESS_ADMINISTER, PRINTER_ACCESS_USE""" - pass + @property + def DesiredAccess(self) -> 'Any': + """An ACCESS_MASK specifying what level of access is needed, eg PRINTER_ACCESS_ADMINISTER, PRINTER_ACCESS_USE""" + pass class PyACL(object): - """A Python object, representing a ACL structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """A Python object, representing a ACL structure""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Initialize(self,) -> 'None': - """ + def Initialize(self,) -> 'None': + """ Initialize the ACL. Args: @@ -226,13 +791,12 @@ Args: Returns: None - - """ - pass + """ + pass - def IsValid(self,) -> 'None': - """ + def IsValid(self,) -> 'None': + """ Determines if the ACL is valid (IsValidAcl) Args: @@ -242,14 +806,13 @@ Args: Returns: None - - """ - pass + """ + pass - def AddAccessAllowedAce(self,revision:'Any',access:'Any',sid:'PySID',access1:'Any',sid1:'Any') -> 'None': - """ - Adds an access-allowed ACE to an DACL object. The access is granted to a + def AddAccessAllowedAce(self, revision: 'Any', access: 'Any', sid: 'PySID', access1: 'Any', sid1: 'Any') -> 'None': + """ + Adds an access-allowed ACE to an DACL object. The access is granted to a specified SID. @@ -264,13 +827,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AddAccessAllowedAceEx(self,revision:'Any',aceflags:'Any',access:'Any',sid:'PySID') -> 'None': - """ + def AddAccessAllowedAceEx(self, revision: 'Any', aceflags: 'Any', access: 'Any', sid: 'PySID') -> 'None': + """ Add access allowed ACE to an ACL with ACE flags (Requires Win2k or higher) Args: @@ -283,13 +845,19 @@ Args: Returns: None - - """ - pass + """ + pass - def AddAccessAllowedObjectAce(self,AceRevision:'Any',AceFlags:'Any',AccessMask:'Any',ObjectTypeGuid:'PyIID',InheritedObjectTypeGuid:'PyIID',sid:'PySID') -> 'None': - """ + def AddAccessAllowedObjectAce( + self, + AceRevision: 'Any', + AceFlags: 'Any', + AccessMask: 'Any', + ObjectTypeGuid: 'PyIID', + InheritedObjectTypeGuid: 'PyIID', + sid: 'PySID') -> 'None': + """ Adds an ACCESS_ALLOWED_OBJECT_ACE to the ACL Args: @@ -304,14 +872,13 @@ Args: Returns: None - - """ - pass + """ + pass - def AddAccessDeniedAce(self,revision:'Any',access:'Any',sid:'PySID',access1:'Any',sid1:'Any') -> 'None': - """ - Adds an access-denied ACE to an ACL object. The access is denied to a specified + def AddAccessDeniedAce(self, revision: 'Any', access: 'Any', sid: 'PySID', access1: 'Any', sid1: 'Any') -> 'None': + """ + Adds an access-denied ACE to an ACL object. The access is denied to a specified SID. @@ -326,13 +893,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AddAccessDeniedAceEx(self,revision:'Any',aceflags:'Any',access:'Any',sid:'PySID') -> 'None': - """ + def AddAccessDeniedAceEx(self, revision: 'Any', aceflags: 'Any', access: 'Any', sid: 'PySID') -> 'None': + """ Add access denied ACE to an ACL with ACE flags (Requires Win2k or higher) Args: @@ -345,13 +911,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AddMandatoryAce(self,AceRevision:'Any',AceFlags:'Any',MandatoryPolicy:'Any',LabelSid:'PySID') -> 'None': - """ + def AddMandatoryAce(self, AceRevision: 'Any', AceFlags: 'Any', MandatoryPolicy: 'Any', LabelSid: 'PySID') -> 'None': + """ Adds a mandatory integrity level ACE to a SACL Args: @@ -364,13 +929,18 @@ Args: Returns: None - - """ - pass + """ + pass - def AddAuditAccessAce(self,dwAceRevision:'Any',dwAccessMask:'Any',sid:'PySID',bAuditSuccess:'Any',bAuditFailure:'Any') -> 'None': - """ + def AddAuditAccessAce( + self, + dwAceRevision: 'Any', + dwAccessMask: 'Any', + sid: 'PySID', + bAuditSuccess: 'Any', + bAuditFailure: 'Any') -> 'None': + """ Adds an audit ACE to a Sacl Args: @@ -384,13 +954,19 @@ Args: Returns: None - - """ - pass + """ + pass - def AddAuditAccessAceEx(self,dwAceRevision:'Any',AceFlags:'Any',dwAccessMask:'Any',sid:'PySID',bAuditSuccess:'Any',bAuditFailure:'Any') -> 'None': - """ + def AddAuditAccessAceEx( + self, + dwAceRevision: 'Any', + AceFlags: 'Any', + dwAccessMask: 'Any', + sid: 'PySID', + bAuditSuccess: 'Any', + bAuditFailure: 'Any') -> 'None': + """ Adds an audit ACE to an Sacl, includes ace flags Args: @@ -405,13 +981,21 @@ Args: Returns: None - - """ - pass + """ + pass - def AddAuditAccessObjectAce(self,dwAceRevision:'Any',AceFlags:'Any',dwAccessMask:'Any',ObjectTypeGuid:'PyIID',InheritedObjectTypeGuid:'PyIID',sid:'PySID',bAuditSuccess:'Any',bAuditFailure:'Any') -> 'None': - """ + def AddAuditAccessObjectAce( + self, + dwAceRevision: 'Any', + AceFlags: 'Any', + dwAccessMask: 'Any', + ObjectTypeGuid: 'PyIID', + InheritedObjectTypeGuid: 'PyIID', + sid: 'PySID', + bAuditSuccess: 'Any', + bAuditFailure: 'Any') -> 'None': + """ Adds an audit ACE for an object type identified by GUID Args: @@ -428,13 +1012,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetAclSize(self,) -> 'Any': - """ + def GetAclSize(self,) -> 'Any': + """ Returns the storage size of the ACL. Args: @@ -444,13 +1027,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetAclRevision(self,) -> 'Any': - """ + def GetAclRevision(self,) -> 'Any': + """ Returns revision of the ACL. Args: @@ -460,13 +1042,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetAceCount(self,) -> 'Any': - """ + def GetAceCount(self,) -> 'Any': + """ Returns the number of ACEs in the ACL. Args: @@ -476,13 +1057,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetAce(self,index:'Any') -> 'Any': - """ + def GetAce(self, index: 'Any') -> 'Any': + """ Gets an Ace from the ACL Args: @@ -491,7 +1071,7 @@ Args: Returns: - 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 + 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 +1079,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,13 +1093,12 @@ are returned as a tuple: [4] PySID : sid For details see the API documentation. - - """ - pass + """ + pass - def DeleteAce(self,index:'Any') -> 'None': - """ + def DeleteAce(self, index: 'Any') -> 'None': + """ Deletes specified Ace from an ACL. Args: @@ -529,14 +1108,13 @@ Args: Returns: None - - """ - pass + """ + pass - def GetEffectiveRightsFromAcl(self,trustee:'PyTRUSTEE') -> 'Any': - """ - Return access rights (ACCESS_MASK) that the ACL grants to + def GetEffectiveRightsFromAcl(self, trustee: 'PyTRUSTEE') -> 'Any': + """ + Return access rights (ACCESS_MASK) that the ACL grants to specified trustee @@ -547,14 +1125,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetAuditedPermissionsFromAcl(self,trustee:'PyTRUSTEE') -> 'Tuple[Any, Any]': - """ - Return types of access for + def GetAuditedPermissionsFromAcl(self, trustee: 'PyTRUSTEE') -> 'Tuple[Any, Any]': + """ + Return types of access for which ACL will generate an audit event for specified trustee @@ -565,79 +1142,72 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass -class PyBITMAP(object): - """A Python object, representing an PyBITMAP structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def bmType(self)->'int': - """""" - pass +class PyBITMAP(object): + """A Python object, representing an PyBITMAP structure""" - @property - def bmWidth(self)->'int': - """""" - pass - + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def bmHeight(self)->'int': - """""" - pass + @property + def bmType(self) -> 'int': + """""" + pass + @property + def bmWidth(self) -> 'int': + """""" + pass - @property - def bmWidthBytes(self)->'int': - """""" - pass + @property + def bmHeight(self) -> 'int': + """""" + pass + @property + def bmWidthBytes(self) -> 'int': + """""" + pass - @property - def bmPlanes(self)->'int': - """""" - pass + @property + def bmPlanes(self) -> 'int': + """""" + pass 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).""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyCEHANDLE(object): - """A Python object, representing a remote Windows CE handle""" + """A Python object, representing a remote Windows CE handle""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyCERTSTORE(object): - """Handle to a certificate store""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - + """Handle to a certificate store""" - @property - def HCERTSTORE(self)->'Any': - """Integer handle""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def HCERTSTORE(self) -> 'Any': + """Integer handle""" + pass - def CertCloseStore(self,Flags:'Any'=0) -> 'None': - """ + def CertCloseStore(self, Flags: 'Any' = 0) -> 'None': + """ Closes the certificate store Args: @@ -647,13 +1217,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CertControlStore(self,Flags:'Any',CtrlType:'Any',CtrlPara:'int') -> 'None': - """ + def CertControlStore(self, Flags: 'Any', CtrlType: 'Any', CtrlPara: 'int') -> 'None': + """ Controls sychronization of the certificate store Args: @@ -665,13 +1234,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CertEnumCertificatesInStore(self,) -> 'List[PyCERT_CONTEXT]': - """ + def CertEnumCertificatesInStore(self,) -> 'List[PyCERT_CONTEXT]': + """ Lists all certificates in the store Args: @@ -681,13 +1249,12 @@ Args: Returns: List[PyCERT_CONTEXT] - - """ - pass + """ + pass - def CertEnumCTLsInStore(self,) -> 'List[PyCTL_CONTEXT]': - """ + def CertEnumCTLsInStore(self,) -> 'List[PyCTL_CONTEXT]': + """ Finds all Certificate Trust Lists in store Args: @@ -697,13 +1264,18 @@ Args: Returns: List[PyCTL_CONTEXT] - - """ - pass - - def CertSaveStore(self,MsgAndCertEncodingType:'Any',SaveAs:'Any',SaveTo:'Any',SaveToPara:'Union[str, int]',Flags:'Any'=0) -> 'None': - """ + """ + pass + + def CertSaveStore( + self, + MsgAndCertEncodingType: 'Any', + SaveAs: 'Any', + SaveTo: 'Any', + SaveToPara: 'Union[str, int]', + Flags: 'Any' = 0) -> 'None': + """ Serializes the store to memory or a file Args: @@ -717,14 +1289,17 @@ Args: Returns: None - - """ - pass + """ + pass - def CertAddEncodedCertificateToStore(self,CertEncodingType:'Any',CertEncoded:'Any',AddDisposition:'Any') -> 'PyCERT_CONTEXT': - """ - Imports an encoded certificate into the + def CertAddEncodedCertificateToStore( + self, + CertEncodingType: 'Any', + CertEncoded: 'Any', + AddDisposition: 'Any') -> 'PyCERT_CONTEXT': + """ + Imports an encoded certificate into the store @@ -737,13 +1312,13 @@ Args: Returns: PyCERT_CONTEXT - - """ - pass + """ + pass - def CertAddCertificateContextToStore(self,CertContext:'PyCERT_CONTEXT',AddDisposition:'Any') -> 'PyCERT_CONTEXT': - """ + def CertAddCertificateContextToStore(self, CertContext: 'PyCERT_CONTEXT', + AddDisposition: 'Any') -> 'PyCERT_CONTEXT': + """ Adds a certificate context to the store Args: @@ -754,13 +1329,12 @@ Args: Returns: PyCERT_CONTEXT - - """ - pass + """ + pass - def CertAddCertificateLinkToStore(self,CertContext:'PyCERT_CONTEXT',AddDisposition:'Any') -> 'PyCERT_CONTEXT': - """ + def CertAddCertificateLinkToStore(self, CertContext: 'PyCERT_CONTEXT', AddDisposition: 'Any') -> 'PyCERT_CONTEXT': + """ Adds a link to a cert in another store Args: @@ -771,13 +1345,12 @@ Args: Returns: PyCERT_CONTEXT - - """ - pass + """ + pass - def CertAddCTLContextToStore(self,CtlContext:'PyCTL_CONTEXT',AddDisposition:'Any') -> 'PyCTL_CONTEXT': - """ + def CertAddCTLContextToStore(self, CtlContext: 'PyCTL_CONTEXT', AddDisposition: 'Any') -> 'PyCTL_CONTEXT': + """ Adds a certificate trust list to the store Args: @@ -788,13 +1361,12 @@ Args: Returns: PyCTL_CONTEXT - - """ - pass + """ + pass - def CertAddCTLLinkToStore(self,CtlContext:'PyCTL_CONTEXT',AddDisposition:'Any') -> 'PyCTL_CONTEXT': - """ + def CertAddCTLLinkToStore(self, CtlContext: 'PyCTL_CONTEXT', AddDisposition: 'Any') -> 'PyCTL_CONTEXT': + """ Adds a link to a CTL in another store Args: @@ -805,13 +1377,16 @@ Args: Returns: PyCTL_CONTEXT - - """ - pass + """ + pass - def CertAddStoreToCollection(self,SiblingStore:'PyCERTSTORE',UpdateFlag:'Any'=0,Priority:'Any'=0) -> 'None': - """ + def CertAddStoreToCollection( + self, + SiblingStore: 'PyCERTSTORE', + UpdateFlag: 'Any' = 0, + Priority: 'Any' = 0) -> 'None': + """ Adds a sibling store to a store collection Args: @@ -823,13 +1398,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CertRemoveStoreFromCollection(self,SiblingStore:'PyCERTSTORE') -> 'None': - """ + def CertRemoveStoreFromCollection(self, SiblingStore: 'PyCERTSTORE') -> 'None': + """ Removes a sibling store from a collection Args: @@ -839,13 +1413,12 @@ Args: Returns: None - - """ - pass + """ + pass - def PFXExportCertStoreEx(self,Flags:'Any',Password:'Any'=None) -> 'Any': - """ + def PFXExportCertStoreEx(self, Flags: 'Any', Password: 'Any' = None) -> 'Any': + """ Exports certificates and associated private keys in PKCS#12 format Args: @@ -856,193 +1429,169 @@ Args: Returns: Any - - """ - pass + + """ + pass class PyCERT_ALT_NAME_ENTRY(object): - """Represented as a 2-tuple""" + """Represented as a 2-tuple""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyCERT_ALT_NAME_INFO(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyCERT_AUTHORITY_KEY_ID_INFO(object): - """Dict containing the identity of a CA""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - + """Dict containing the identity of a CA""" - @property - def KeyId(self)->'Any': - """Unique identifier of private key, usually a hash""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def KeyId(self) -> 'Any': + """Unique identifier of private key, usually a hash""" + pass - @property - def CertIssuer(self)->'Any': - """Encoded DN of the Certificate Authority. Decode using X509_UNICODE_NAME""" - pass + @property + def CertIssuer(self) -> 'Any': + """Encoded DN of the Certificate Authority. Decode using X509_UNICODE_NAME""" + pass - - @property - def CertSerialNumber(self)->'Any': - """Serial nbr of the CA's signing certificate""" - pass + @property + def CertSerialNumber(self) -> 'Any': + """Serial nbr of the CA's signing certificate""" + pass class PyCERT_BASIC_CONSTRAINTS2_INFO(object): - """Dict representing a CERT_BASIC_CONSTRAINTS2_INFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def fCA(self)->'Any': - """Indicates if cert represents a certificate authority""" - pass + """Dict representing a CERT_BASIC_CONSTRAINTS2_INFO struct""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def fPathLenConstraint(self)->'Any': - """Indicates if PathLenConstraint member is used""" - pass + @property + def fCA(self) -> 'Any': + """Indicates if cert represents a certificate authority""" + pass + @property + def fPathLenConstraint(self) -> 'Any': + """Indicates if PathLenConstraint member is used""" + pass - @property - def PathLenConstraint(self)->'Any': - """Limits number of intermediate CA's between root CA and end user""" - pass + @property + def PathLenConstraint(self) -> 'Any': + """Limits number of intermediate CA's between root CA and end user""" + pass class PyCERT_BASIC_CONSTRAINTS_INFO(object): - """Dict representing a CERT_BASIC_CONSTRAINTS_INFO struct""" + """Dict representing a CERT_BASIC_CONSTRAINTS_INFO struct""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def SubjectType(self) -> 'PyCRYPT_BIT_BLOB': + """Contains a combination of CERT_CA_SUBJECT_FLAG,CERT_END_ENTITY_SUBJECT_FLAG""" + pass - @property - def SubjectType(self)->'PyCRYPT_BIT_BLOB': - """Contains a combination of CERT_CA_SUBJECT_FLAG,CERT_END_ENTITY_SUBJECT_FLAG""" - pass + @property + def fPathLenConstraint(self) -> 'Any': + """Indicates if PathLenConstraint member is used""" + pass + @property + def PathLenConstraint(self) -> 'Any': + """Limits number of intermediate CA's between root CA and end user""" + pass - @property - def fPathLenConstraint(self)->'Any': - """Indicates if PathLenConstraint member is used""" - pass - - - @property - def PathLenConstraint(self)->'Any': - """Limits number of intermediate CA's between root CA and end user""" - pass - - - @property - def SubtreesConstraint(self)->'Any': - """Sequence of encoded name blobs""" - pass + @property + def SubtreesConstraint(self) -> 'Any': + """Sequence of encoded name blobs""" + pass class PyCERT_CONTEXT(object): - """Handle to a certificate context""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def HANDLE(self)->'Any': - """Pointer to CERT_CONTEXT struct""" - pass - - - @property - def CertStore(self)->'PyCERTSTORE': - """Handle to the certificate store that contains this certificate""" - pass - - - @property - def CertEncoded(self)->'Any': - """Content of the certificate as encoded bytes""" - pass - - - @property - def CertEncodingType(self)->'Any': - """Method used to encode the certifcate, usually X509_ASN_ENCODING or PKCS_7_ASN_ENCODING""" - pass - - - @property - def Version(self)->'Any': - """One of the CERT_V* values""" - pass - - - @property - def Subject(self)->'str': - """Encoded CERT_NAME_INFO struct containing the subject name. Can be decoded using cryptoapi::CryptDecodeObjectEx with X509_UNICODE_NAME, or formatted using cryptoapi::CertNameToStr""" - pass - - - @property - def Issuer(self)->'str': - """Certificate Authority that issued certificate as encoded CERT_NAME_INFO. Use cryptoapi::CryptDecodeObjectEx to decode into individual components, or cryptoapi::CertNameToStr to return a single formatted string""" - pass - - - @property - def NotBefore(self)->'PyTime': - """Beginning of certificate's period of validity""" - pass - - - @property - def NotAfter(self)->'PyTime': - """End of certificate's period of validity""" - pass - - - @property - def SignatureAlgorithm(self)->'Any': - """Object id of the certifcate's signature algorithm""" - pass - - - @property - def Extension(self)->'Tuple[PyCERT_EXTENSION, ...]': - """Sequence of CERT_EXTENSION dicts containing certificate's extensions""" - pass - - - @property - def SubjectPublicKeyInfo(self)->'PyCERT_PUBLIC_KEY_INFO': - """Encoded public key of certificate""" - pass - - - @property - def SerialNumber(self)->'Any': - """Serial number assigned by the issuer""" - pass - - - def CertFreeCertificateContext(self,) -> 'None': - """ + """Handle to a certificate context""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def HANDLE(self) -> 'Any': + """Pointer to CERT_CONTEXT struct""" + pass + + @property + def CertStore(self) -> 'PyCERTSTORE': + """Handle to the certificate store that contains this certificate""" + pass + + @property + def CertEncoded(self) -> 'Any': + """Content of the certificate as encoded bytes""" + pass + + @property + def CertEncodingType(self) -> 'Any': + """Method used to encode the certifcate, usually X509_ASN_ENCODING or PKCS_7_ASN_ENCODING""" + pass + + @property + def Version(self) -> 'Any': + """One of the CERT_V* values""" + pass + + @property + def Subject(self) -> 'str': + """Encoded CERT_NAME_INFO struct containing the subject name. Can be decoded using cryptoapi::CryptDecodeObjectEx with X509_UNICODE_NAME, or formatted using cryptoapi::CertNameToStr""" + pass + + @property + def Issuer(self) -> 'str': + """Certificate Authority that issued certificate as encoded CERT_NAME_INFO. Use cryptoapi::CryptDecodeObjectEx to decode into individual components, or cryptoapi::CertNameToStr to return a single formatted string""" + pass + + @property + def NotBefore(self) -> 'PyTime': + """Beginning of certificate's period of validity""" + pass + + @property + def NotAfter(self) -> 'PyTime': + """End of certificate's period of validity""" + pass + + @property + def SignatureAlgorithm(self) -> 'Any': + """Object id of the certifcate's signature algorithm""" + pass + + @property + def Extension(self) -> 'Tuple[PyCERT_EXTENSION, ...]': + """Sequence of CERT_EXTENSION dicts containing certificate's extensions""" + pass + + @property + def SubjectPublicKeyInfo(self) -> 'PyCERT_PUBLIC_KEY_INFO': + """Encoded public key of certificate""" + pass + + @property + def SerialNumber(self) -> 'Any': + """Serial number assigned by the issuer""" + pass + + def CertFreeCertificateContext(self,) -> 'None': + """ Frees the certificate context Args: @@ -1052,13 +1601,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CertEnumCertificateContextProperties(self,) -> 'List[Any]': - """ + def CertEnumCertificateContextProperties(self,) -> 'List[Any]': + """ Lists property ids for the certificate Args: @@ -1068,14 +1616,13 @@ Args: Returns: List[Any] - - """ - pass + """ + pass - def CryptAcquireCertificatePrivateKey(self,Flags:'Any'=0) -> 'Tuple[Any, PyCRYPTPROV]': - """ - Retrieves the private key associated + def CryptAcquireCertificatePrivateKey(self, Flags: 'Any' = 0) -> 'Tuple[Any, PyCRYPTPROV]': + """ + Retrieves the private key associated with the certificate @@ -1091,14 +1638,13 @@ 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 + """ + pass - def CertGetIntendedKeyUsage(self,) -> 'Any': - """ - Returns the intended key usage from the certificate extensions + def CertGetIntendedKeyUsage(self,) -> 'Any': + """ + Returns the intended key usage from the certificate extensions (szOID_KEY_USAGE or szOID_KEY_ATTRIBUTES) @@ -1110,19 +1656,18 @@ Returns: 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 + """ + pass - def CertGetEnhancedKeyUsage(self,Flags:'Any'=0) -> 'Any': - """ - Finds the enhanced key usage property and/or extension for the + def CertGetEnhancedKeyUsage(self, Flags: 'Any' = 0) -> 'Any': + """ + Finds the enhanced key usage property and/or extension for the certificate @@ -1132,18 +1677,17 @@ Args: Returns: - Any:CERT_FIND_EXT_ONLY_ENHKEY_USAGE_FLAG, + 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 + """ + pass - def CertSerializeCertificateStoreElement(self,Flags:'Any'=0) -> 'str': - """ + def CertSerializeCertificateStoreElement(self, Flags: 'Any' = 0) -> 'str': + """ Serializes the certificate and its properties Args: @@ -1153,13 +1697,12 @@ Args: Returns: str - - """ - pass + """ + pass - def CertVerifySubjectCertificateContext(self,Issuer:'PyCERT_CONTEXT',Flags:'Any') -> 'Any': - """ + def CertVerifySubjectCertificateContext(self, Issuer: 'PyCERT_CONTEXT', Flags: 'Any') -> 'Any': + """ Checks the validity of the certificate Args: @@ -1169,17 +1712,16 @@ Args: Returns: - Any:Combination of CERT_STORE_REVOCATION_FLAG,CERT_STORE_SIGNATURE_FLAG and + 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 + """ + pass - def CertDeleteCertificateFromStore(self,) -> 'None': - """ + def CertDeleteCertificateFromStore(self,) -> 'None': + """ Removes the certificate from its store Args: @@ -1189,14 +1731,13 @@ Args: Returns: None - - """ - pass + """ + pass - def CertGetCertificateContextProperty(self,PropId:'Any') -> 'Any': - """ - Retrieves the specified property from the + def CertGetCertificateContextProperty(self, PropId: 'Any') -> 'Any': + """ + Retrieves the specified property from the certificate @@ -1231,20 +1772,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,13 +1797,12 @@ 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 + """ + pass - def CertSetCertificateContextProperty(self,PropId:'Any',Data:'Any',Flags:'Any'=0) -> 'None': - """ + def CertSetCertificateContextProperty(self, PropId: 'Any', Data: 'Any', Flags: 'Any' = 0) -> 'None': + """ Sets a property for a certificate Args: @@ -1274,405 +1814,356 @@ Args: Returns: None - - """ - pass - - -class PyCERT_EXTENSION(object): - """Dict containing a certificate extension""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """ + pass - @property - def ObjId(self)->'Any': - """The OID identifying the type of extension""" - pass +class PyCERT_EXTENSION(object): + """Dict containing a certificate extension""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def Critical(self)->'Any': - """If true, any contraints or limits contained in the extension should be considered absolute""" - pass + @property + def ObjId(self) -> 'Any': + """The OID identifying the type of extension""" + pass + @property + def Critical(self) -> 'Any': + """If true, any contraints or limits contained in the extension should be considered absolute""" + pass - @property - def Value(self)->'Any': - """Binary string containing ASN encoded data. To interpret or display extension data, see cryptoapi::CryptDecodeObjectEx and cryptoapi::CryptFormatObject.""" - pass + @property + def Value(self) -> 'Any': + """Binary string containing ASN encoded data. To interpret or display extension data, see cryptoapi::CryptDecodeObjectEx and cryptoapi::CryptFormatObject.""" + pass class PyCERT_KEY_ATTRIBUTES_INFO(object): - """Dict representing a CERT_KEY_ATTRIBUTES_INFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - + """Dict representing a CERT_KEY_ATTRIBUTES_INFO struct""" - @property - def KeyId(self)->'Any': - """Usually a hash that uniquely identifies the key""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def KeyId(self) -> 'Any': + """Usually a hash that uniquely identifies the key""" + pass - @property - def IntendedKeyUsage(self)->'PyCRYPT_BIT_BLOB': - """Contains a byte with CERT_*_KEY_USAGE flags""" - pass + @property + def IntendedKeyUsage(self) -> 'PyCRYPT_BIT_BLOB': + """Contains a byte with CERT_*_KEY_USAGE flags""" + pass - - @property - def PrivateKeyUsagePeriod(self)->'Any': - """Private key's begin and end effective dates, may be None""" - pass + @property + def PrivateKeyUsagePeriod(self) -> 'Any': + """Private key's begin and end effective dates, may be None""" + pass class PyCERT_NAME_INFO(object): - """Sequence of CERT_RDN's""" + """Sequence of CERT_RDN's""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyCERT_NAME_VALUE(object): - """Dict containing type (CERT_RDN_*) and a unicode string""" + """Dict containing type (CERT_RDN_*) and a unicode string""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') 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""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyCERT_POLICY_INFO(object): - """Dict containing a certificate policy""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """Dict containing a certificate policy""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def PolicyIdentifier(self)->'Any': - """OID identifying the policy""" - pass + @property + def PolicyIdentifier(self) -> 'Any': + """OID identifying the policy""" + pass - - @property - def PolicyQualifier(self)->'Any': - """Sequence of CERT_POLICY_QUALIFIER dicts""" - pass + @property + def PolicyQualifier(self) -> 'Any': + """Sequence of CERT_POLICY_QUALIFIER dicts""" + pass class PyCERT_PUBLIC_KEY_INFO(object): - """Dict containing an exported public key""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """Dict containing an exported public key""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def Algorithm(self)->'PyCRYPT_ALGORITHM_IDENTIFIER': - """Dict containing OID of the public key algorithm""" - pass + @property + def Algorithm(self) -> 'PyCRYPT_ALGORITHM_IDENTIFIER': + """Dict containing OID of the public key algorithm""" + pass - - @property - def PublicKey(self)->'PyCRYPT_BIT_BLOB': - """Dict containing the encoded public key""" - pass + @property + def PublicKey(self) -> 'PyCRYPT_BIT_BLOB': + """Dict containing the encoded public key""" + pass class PyCOMSTAT(object): - """A Python object, representing an COMSTAT structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def cbInQue(self)->'int': - """Specifies the number of bytes received by the serial provider but not yet read by a win32file::ReadFile operation""" - pass - - - @property - def cbOutQue(self)->'int': - """Specifies the number of bytes of user data remaining to be transmitted for all write operations. This value will be zero for a nonoverlapped write.""" - pass - - - @property - def fCtsHold(self)->'int': - """Specifies whether transmission is waiting for the CTS (clear-to-send) signal to be sent. If this member is TRUE, transmission is waiting.""" - pass - - - @property - def fDsrHold(self)->'int': - """Specifies whether transmission is waiting for the DSR (data-set-ready) signal to be sent. If this member is TRUE, transmission is waiting.""" - pass - - - @property - def fRlsdHold(self)->'int': - """Specifies whether transmission is waiting for the RLSD (receive-line-signal-detect) signal to be sent. If this member is TRUE, transmission is waiting.""" - pass - - - @property - def fXoffHold(self)->'int': - """Specifies whether transmission is waiting because the XOFF character was received. If this member is TRUE, transmission is waiting.""" - pass - - - @property - def fXoffSent(self)->'int': - """Specifies whether transmission is waiting because the XOFF character was transmitted. If this member is TRUE, transmission is waiting. Transmission halts when the XOFF character is transmitted to a system that takes the next character as XON, regardless of the actual character.""" - pass - - - @property - def fEof(self)->'int': - """Specifies whether the end-of-file (EOF) character has been received. If this member is TRUE, the EOF character has been received.""" - pass - - - @property - def fTxim(self)->'int': - """If this member is TRUE, there is a character queued for transmission that has come to the communications device by way of the TransmitCommChar function. The communications device transmits such a character ahead of other characters in the device's output buffer.""" - pass - - - @property - def fReserved(self)->'int': - """Reserved; do not use.""" - pass + """A Python object, representing an COMSTAT structure""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def cbInQue(self) -> 'int': + """Specifies the number of bytes received by the serial provider but not yet read by a win32file::ReadFile operation""" + pass + + @property + def cbOutQue(self) -> 'int': + """Specifies the number of bytes of user data remaining to be transmitted for all write operations. This value will be zero for a nonoverlapped write.""" + pass + + @property + def fCtsHold(self) -> 'int': + """Specifies whether transmission is waiting for the CTS (clear-to-send) signal to be sent. If this member is TRUE, transmission is waiting.""" + pass + + @property + def fDsrHold(self) -> 'int': + """Specifies whether transmission is waiting for the DSR (data-set-ready) signal to be sent. If this member is TRUE, transmission is waiting.""" + pass + + @property + def fRlsdHold(self) -> 'int': + """Specifies whether transmission is waiting for the RLSD (receive-line-signal-detect) signal to be sent. If this member is TRUE, transmission is waiting.""" + pass + + @property + def fXoffHold(self) -> 'int': + """Specifies whether transmission is waiting because the XOFF character was received. If this member is TRUE, transmission is waiting.""" + pass + + @property + def fXoffSent(self) -> 'int': + """Specifies whether transmission is waiting because the XOFF character was transmitted. If this member is TRUE, transmission is waiting. Transmission halts when the XOFF character is transmitted to a system that takes the next character as XON, regardless of the actual character.""" + pass + + @property + def fEof(self) -> 'int': + """Specifies whether the end-of-file (EOF) character has been received. If this member is TRUE, the EOF character has been received.""" + pass + + @property + def fTxim(self) -> 'int': + """If this member is TRUE, there is a character queued for transmission that has come to the communications device by way of the TransmitCommChar function. The communications device transmits such a character ahead of other characters in the device's output buffer.""" + pass + + @property + def fReserved(self) -> 'int': + """Reserved; do not use.""" + pass class PyCOORD(object): - """Wrapper for a COORD struct. Create using PyCOORDType(X,Y)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - + """Wrapper for a COORD struct. Create using PyCOORDType(X,Y)""" - @property - def X(self)->'Any': - """Horizontal coordinate""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def X(self) -> 'Any': + """Horizontal coordinate""" + pass - @property - def Y(self)->'Any': - """Vertical coordinate""" - pass + @property + def Y(self) -> 'Any': + """Vertical coordinate""" + pass class PyCREDENTIAL(object): - """A dictionary containing information for a CREDENTIAL struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Flags(self)->'Any': - """Combination of CRED_FLAGS_PROMPT_NOW, CRED_FLAGS_USERNAME_TARGET""" - pass - - - @property - def Type(self)->'Any': - """Type of credential, one of CRED_TYPE_* values""" - pass - - - @property - def TargetName(self)->'str': - """Target of credential, can end with * for wildcard matching""" - pass - - - @property - def Comment(self)->'str': - """Descriptive text""" - pass - - - @property - def LastWritten(self)->'PyTime': - """Modification time, ignored on input""" - pass - - - @property - def CredentialBlob(self)->'str': - """Contains password for username credential, or PIN for certificate credential. This member is write-only.""" - pass - - - @property - def Persist(self)->'Any': - """Specifies scope of persistence, one of CRED_PERSIST_* values""" - pass - - - @property - def Attributes(self)->'Any': - """Tuple of PyCREDENTIAL_ATTRIBUTE dicts containing application-specific data, can be None""" - pass - - - @property - def TargetAlias(self)->'str': - """Alias for TargetName, only valid with CRED_TYPE_GENERIC""" - pass - - - @property - def UserName(self)->'str': - """User to be authenticated by target. Can be of the form username@domain or domain\\username. For CRED_TYPE_DOMAIN_CERTIFICATE, use win32cred::CredMarshalCredential to marshal the SHA1 hash of user's certficate""" - pass + """A dictionary containing information for a CREDENTIAL struct""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def Flags(self) -> 'Any': + """Combination of CRED_FLAGS_PROMPT_NOW, CRED_FLAGS_USERNAME_TARGET""" + pass + + @property + def Type(self) -> 'Any': + """Type of credential, one of CRED_TYPE_* values""" + pass + + @property + def TargetName(self) -> 'str': + """Target of credential, can end with * for wildcard matching""" + pass + + @property + def Comment(self) -> 'str': + """Descriptive text""" + pass + + @property + def LastWritten(self) -> 'PyTime': + """Modification time, ignored on input""" + pass + + @property + def CredentialBlob(self) -> 'str': + """Contains password for username credential, or PIN for certificate credential. This member is write-only.""" + pass + + @property + def Persist(self) -> 'Any': + """Specifies scope of persistence, one of CRED_PERSIST_* values""" + pass + + @property + def Attributes(self) -> 'Any': + """Tuple of PyCREDENTIAL_ATTRIBUTE dicts containing application-specific data, can be None""" + pass + + @property + def TargetAlias(self) -> 'str': + """Alias for TargetName, only valid with CRED_TYPE_GENERIC""" + pass + + @property + def UserName(self) -> 'str': + """User to be authenticated by target. Can be of the form username@domain or domain\\username. For CRED_TYPE_DOMAIN_CERTIFICATE, use win32cred::CredMarshalCredential to marshal the SHA1 hash of user's certficate""" + pass class PyCREDENTIAL_ATTRIBUTE(object): - """A dictionary containing information for a CREDENTIAL_ATTRIBUTE struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Keyword(self)->'str': - """Attribute name, at most CRED_MAX_STRING_LENGTH chars""" - pass + """A dictionary containing information for a CREDENTIAL_ATTRIBUTE struct""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def Flags(self)->'Any': - """Reserved, use only 0""" - pass + @property + def Keyword(self) -> 'str': + """Attribute name, at most CRED_MAX_STRING_LENGTH chars""" + pass + @property + def Flags(self) -> 'Any': + """Reserved, use only 0""" + pass - @property - def Value(self)->'Any': - """Attribute value, at most CRED_MAX_VALUE_SIZE bytes. Unicode objects are treated as raw bytes.""" - pass + @property + def Value(self) -> 'Any': + """Attribute value, at most CRED_MAX_VALUE_SIZE bytes. Unicode objects are treated as raw bytes.""" + pass class PyCREDENTIAL_TARGET_INFORMATION(object): - """A dictionary representing a CREDENTIAL_TARGET_INFORMATION struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def TargetName(self)->'str': - """Target of credentials""" - pass - + """A dictionary representing a CREDENTIAL_TARGET_INFORMATION struct""" - @property - def NetbiosServerName(self)->'str': - """""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def TargetName(self) -> 'str': + """Target of credentials""" + pass - @property - def DnsServerName(self)->'str': - """""" - pass + @property + def NetbiosServerName(self) -> 'str': + """""" + pass + @property + def DnsServerName(self) -> 'str': + """""" + pass - @property - def NetbiosDomainName(self)->'str': - """""" - pass + @property + def NetbiosDomainName(self) -> 'str': + """""" + pass + @property + def DnsDomainName(self) -> 'str': + """""" + pass - @property - def DnsDomainName(self)->'str': - """""" - pass + @property + def DnsTreeName(self) -> 'str': + """""" + pass + @property + def PackageName(self) -> 'str': + """Name of security package which mapped TargetName""" + pass - @property - def DnsTreeName(self)->'str': - """""" - pass + @property + def Flags(self) -> 'Any': + """CRED_TI_* flags""" + pass - - @property - def PackageName(self)->'str': - """Name of security package which mapped TargetName""" - pass - - - @property - def Flags(self)->'Any': - """CRED_TI_* flags""" - pass - - - @property - def CredTypes(self)->'Tuple[Any, ...]': - """Tuple of CRED_TYPE_* values indicating which types of credentials are acceptable to target""" - pass + @property + def CredTypes(self) -> 'Tuple[Any, ...]': + """Tuple of CRED_TYPE_* values indicating which types of credentials are acceptable to target""" + pass class PyCREDUI_INFO(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Parent(self)->'int': - """Handle to parent window, can be None""" - pass + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def MessageText(self)->'str': - """Message to appear in dialog""" - pass + @property + def Parent(self) -> 'int': + """Handle to parent window, can be None""" + pass + @property + def MessageText(self) -> 'str': + """Message to appear in dialog""" + pass - @property - def CaptionText(self)->'str': - """Title of the dialog window""" - pass + @property + def CaptionText(self) -> 'str': + """Title of the dialog window""" + pass - - @property - def Banner(self)->'int': - """Handle to a bitmap to be displayed""" - pass + @property + def Banner(self) -> 'int': + """Handle to a bitmap to be displayed""" + pass class PyCRYPTHASH(object): - """Handle to a cryptographic hash""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """Handle to a cryptographic hash""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def CryptDestroyHash(self,) -> 'None': - """ + def CryptDestroyHash(self,) -> 'None': + """ Frees the hash object Args: @@ -1682,13 +2173,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CryptDuplicateHash(self,Flags:'Any'=0) -> 'PyCRYPTHASH': - """ + def CryptDuplicateHash(self, Flags: 'Any' = 0) -> 'PyCRYPTHASH': + """ Clones the hash object Args: @@ -1698,13 +2188,12 @@ Args: Returns: PyCRYPTHASH - - """ - pass + """ + pass - def CryptHashData(self,Data:'str',Flags:'Any'=0) -> 'None': - """ + def CryptHashData(self, Data: 'str', Flags: 'Any' = 0) -> 'None': + """ Adds data to the hash Args: @@ -1715,13 +2204,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CryptHashSessionKey(self,Key:'PyCRYPTKEY',Flags:'Any'=0) -> 'None': - """ + def CryptHashSessionKey(self, Key: 'PyCRYPTKEY', Flags: 'Any' = 0) -> 'None': + """ Hashes a session key Args: @@ -1732,13 +2220,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CryptSignHash(self,KeySpec:'Any',Flags:'Any'=0) -> 'str': - """ + def CryptSignHash(self, KeySpec: 'Any', Flags: 'Any' = 0) -> 'str': + """ Signs the hash Args: @@ -1749,13 +2236,12 @@ Args: Returns: str - - """ - pass + """ + pass - def CryptVerifySignature(self,Signature:'str',PubKey:'PyCRYPTKEY',Flags:'Any'=0) -> 'None': - """ + def CryptVerifySignature(self, Signature: 'str', PubKey: 'PyCRYPTKEY', Flags: 'Any' = 0) -> 'None': + """ Verifies that a signature matches hashed data Args: @@ -1767,13 +2253,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CryptGetHashParam(self,Param:'Any',Flags:'Any'=0) -> 'Union[Any]': - """ + def CryptGetHashParam(self, Param: 'Any', Flags: 'Any' = 0) -> 'Union[Any]': + """ Retrieves the specified attribute of the hash Args: @@ -1789,32 +2274,29 @@ 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 - - -class PyCRYPTKEY(object): - """Handle to a cryptographic key""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """ + pass - @property - def HCRYPTPROV(self)->'Any': - """CSP used by the key""" - pass +class PyCRYPTKEY(object): + """Handle to a cryptographic key""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def HCRYPTKEY(self)->'Any': - """Plain integer handle to the key""" - pass + @property + def HCRYPTPROV(self) -> 'Any': + """CSP used by the key""" + pass + @property + def HCRYPTKEY(self) -> 'Any': + """Plain integer handle to the key""" + pass - def CryptDestroyKey(self,) -> 'None': - """ + def CryptDestroyKey(self,) -> 'None': + """ Releases the handle to the key (does not delete permanent keys) Args: @@ -1824,13 +2306,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CryptExportKey(self,ExpKey:'PyCRYPTKEY',BlobType:'Any',Flags:'Any'=0) -> 'Any': - """ + def CryptExportKey(self, ExpKey: 'PyCRYPTKEY', BlobType: 'Any', Flags: 'Any' = 0) -> 'Any': + """ Exports key or key pair as an encrypted blob Args: @@ -1844,13 +2325,12 @@ Returns: 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 + """ + pass - def CryptGetKeyParam(self,Param:'Any',Flags:'Any'=0) -> 'Any': - """ + def CryptGetKeyParam(self, Param: 'Any', Flags: 'Any' = 0) -> 'Any': + """ Retrieves key parameters Args: @@ -1863,13 +2343,12 @@ Returns: Any:Reserved, use only 0 Return ValueType of returned object is dependent on the requested attribute - - """ - pass + """ + pass - def CryptDuplicateKey(self,Reserved:'Any'=0,Flags:'Any'=0) -> 'PyCRYPTKEY': - """ + def CryptDuplicateKey(self, Reserved: 'Any' = 0, Flags: 'Any' = 0) -> 'PyCRYPTKEY': + """ Creates an independent copy of the key Args: @@ -1880,13 +2359,12 @@ Args: Returns: PyCRYPTKEY - - """ - pass + """ + pass - def CryptEncrypt(self,Final:'Any',Data:'Any',Hash:'PyCRYPTHASH'=None,Flags:'Any'=0) -> 'Any': - """ + def CryptEncrypt(self, Final: 'Any', Data: 'Any', Hash: 'PyCRYPTHASH' = None, Flags: 'Any' = 0) -> 'Any': + """ Encrypts and optionally hashes data Args: @@ -1899,13 +2377,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def CryptDecrypt(self,Final:'Any',Data:'Any',Hash:'PyCRYPTHASH'=None,Flags:'Any'=0) -> 'Any': - """ + def CryptDecrypt(self, Final: 'Any', Data: 'Any', Hash: 'PyCRYPTHASH' = None, Flags: 'Any' = 0) -> 'Any': + """ Decrypts data Args: @@ -1918,26 +2395,24 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyCRYPTMSG(object): - """Wrapper for a cryptographic message handle""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCRYPTMSG(object): + """Wrapper for a cryptographic message handle""" - @property - def HCRYPTMSG(self)->'Any': - """Raw message handle""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def HCRYPTMSG(self) -> 'Any': + """Raw message handle""" + pass - def CryptMsgClose(self,) -> 'None': - """ + def CryptMsgClose(self,) -> 'None': + """ Closes the message handle Args: @@ -1947,27 +2422,26 @@ Args: Returns: None - - """ - pass + + """ + pass class PyCRYPTPROTECT_PROMPTSTRUCT(object): - """A tuple representing a CRYPTPROTECT_PROMPTSTRUCT structure""" + """A tuple representing a CRYPTPROTECT_PROMPTSTRUCT structure""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyCRYPTPROV(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - - def CryptReleaseContext(self,Flags:'Any'=0) -> 'None': - """ + def CryptReleaseContext(self, Flags: 'Any' = 0) -> 'None': + """ Releases the CSP handle Args: @@ -1977,13 +2451,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CryptGenKey(self,Algid:'Any',Flags:'Any',KeyLen:'Any'=0) -> 'PyCRYPTKEY': - """ + def CryptGenKey(self, Algid: 'Any', Flags: 'Any', KeyLen: 'Any' = 0) -> 'PyCRYPTKEY': + """ Generates a key pair or a session key Args: @@ -1995,13 +2468,12 @@ Args: Returns: PyCRYPTKEY - - """ - pass + """ + pass - def CryptGetProvParam(self,Param:'Any',Flags:'Any'=0) -> 'None': - """ + def CryptGetProvParam(self, Param: 'Any', Flags: 'Any' = 0) -> 'None': + """ Retrieves specified attribute of provider Args: @@ -2011,18 +2483,17 @@ 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 + """ + pass - def CryptGetUserKey(self,KeySpec:'Any') -> 'PyCRYPTKEY': - """ + def CryptGetUserKey(self, KeySpec: 'Any') -> 'PyCRYPTKEY': + """ Returns a handle to one of user's key pairs Args: @@ -2032,13 +2503,12 @@ Args: Returns: PyCRYPTKEY - - """ - pass + """ + pass - def CryptGenRandom(self,Len:'Any',SeedData:'str'=None) -> 'str': - """ + def CryptGenRandom(self, Len: 'Any', SeedData: 'str' = None) -> 'str': + """ Generates random data of specified length Args: @@ -2049,13 +2519,12 @@ Args: Returns: str - - """ - pass + """ + pass - def CryptCreateHash(self,Algid:'Any',Key:'PyCRYPTKEY'=None,Flags:'Any'=0) -> 'PyCRYPTHASH': - """ + def CryptCreateHash(self, Algid: 'Any', Key: 'PyCRYPTKEY' = None, Flags: 'Any' = 0) -> 'PyCRYPTHASH': + """ Creates a hash object for hashing large amounts of data Args: @@ -2067,13 +2536,12 @@ Args: Returns: PyCRYPTHASH - - """ - pass + """ + pass - def CryptImportKey(self,Data:'Any',PubKey:'PyCRYPTKEY'=None,Flags:'Any'=0) -> 'PyCRYPTKEY': - """ + def CryptImportKey(self, Data: 'Any', PubKey: 'PyCRYPTKEY' = None, Flags: 'Any' = 0) -> 'PyCRYPTKEY': + """ None Args: @@ -2085,14 +2553,13 @@ Args: Returns: PyCRYPTKEY - - """ - pass + """ + pass - def CryptExportPublicKeyInfo(self,KeySpec:'Any',CertEncodingType:'Any') -> 'PyCERT_PUBLIC_KEY_INFO': - """ - Exports a public key to send to other users + def CryptExportPublicKeyInfo(self, KeySpec: 'Any', CertEncodingType: 'Any') -> 'PyCERT_PUBLIC_KEY_INFO': + """ + Exports a public key to send to other users Returned dict can be serialized for sending to another python application using pickle.dump @@ -2104,13 +2571,12 @@ Args: Returns: PyCERT_PUBLIC_KEY_INFO - - """ - pass + """ + pass - def CryptImportPublicKeyInfo(self,Info:'Any',CertEncodingType:'Any') -> 'PyCRYPTKEY': - """ + def CryptImportPublicKeyInfo(self, Info: 'Any', CertEncodingType: 'Any') -> 'PyCRYPTKEY': + """ Imports another user's public key Args: @@ -2121,251 +2587,220 @@ Args: Returns: PyCRYPTKEY - - """ - pass + + """ + 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""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def ObjId(self) -> 'Any': + """An szOID_* string identifying the algorithm""" + pass - @property - def ObjId(self)->'Any': - """An szOID_* string identifying the algorithm""" - pass - - - @property - def Parameters(self)->'Any': - """Blob of binary data containing encoded parameters""" - pass + @property + def Parameters(self) -> 'Any': + """Blob of binary data containing encoded parameters""" + pass class PyCRYPT_ATTRIBUTE(object): - """Dict representing a CRYPT_ATTRIBUTE struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - + """Dict representing a CRYPT_ATTRIBUTE struct""" - @property - def ObjId(self)->'Any': - """An szOID_* string identifying the attribute""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def ObjId(self) -> 'Any': + """An szOID_* string identifying the attribute""" + pass - @property - def Value(self)->'Tuple[Any, ...]': - """A sequence of buffers containing the attribute values""" - pass + @property + def Value(self) -> 'Tuple[Any, ...]': + """A sequence of buffers containing the attribute values""" + pass class PyCRYPT_BIT_BLOB(object): - """Dict containing raw data of a certain bit length""" + """Dict containing raw data of a certain bit length""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def Data(self) -> 'Any': + """Binary data""" + pass - @property - def Data(self)->'Any': - """Binary data""" - pass - - - @property - def UnusedBits(self)->'Any': - """Nbr of bits of last byte that are unused""" - pass + @property + def UnusedBits(self) -> 'Any': + """Nbr of bits of last byte that are unused""" + pass class PyCRYPT_DECRYPT_MESSAGE_PARA(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - + """""" - @property - def CertStores(self)->'Tuple[Any, ...]': - """Sequence of certificate stores to be searched for a certificate with a private key that can be used to decrypt the message""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def CertStores(self) -> 'Tuple[Any, ...]': + """Sequence of certificate stores to be searched for a certificate with a private key that can be used to decrypt the message""" + pass - @property - def MsgAndCertEncodingType(self)->'Any': - """Encoding types, optional. Defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" - pass + @property + def MsgAndCertEncodingType(self) -> 'Any': + """Encoding types, optional. Defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" + pass - - @property - def Flags(self)->'Any': - """Optional. CRYPT_MESSAGE_SILENT_KEYSET_FLAG can be used to suppress any dialogs that might be triggered by accessing a key container, such as a request for a PIN.""" - pass + @property + def Flags(self) -> 'Any': + """Optional. CRYPT_MESSAGE_SILENT_KEYSET_FLAG can be used to suppress any dialogs that might be triggered by accessing a key container, such as a request for a PIN.""" + pass class PyCRYPT_ENCRYPT_MESSAGE_PARA(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ContentEncryptionAlgorithm(self)->'PyCRYPT_ALGORITHM_IDENTIFIER': - """Identifies the algorithm to be used""" - pass + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def CryptProv(self)->'PyCRYPTPROV': - """Optional. Handle to provider that will perform encryption, can be None for default provider""" - pass + @property + def ContentEncryptionAlgorithm(self) -> 'PyCRYPT_ALGORITHM_IDENTIFIER': + """Identifies the algorithm to be used""" + pass + @property + def CryptProv(self) -> 'PyCRYPTPROV': + """Optional. Handle to provider that will perform encryption, can be None for default provider""" + pass - @property - def EncryptionAuxInfo(self)->'Any': - """Optional. Extra info required by some CSP's. Not supported yet, use only None""" - pass + @property + def EncryptionAuxInfo(self) -> 'Any': + """Optional. Extra info required by some CSP's. Not supported yet, use only None""" + pass + @property + def Flags(self) -> 'Any': + """Optional. Combination of CRYPT_MESSAGE_*_FLAG constants""" + pass - @property - def Flags(self)->'Any': - """Optional. Combination of CRYPT_MESSAGE_*_FLAG constants""" - pass + @property + def InnerContentType(self) -> 'Any': + """Optional. Only used if message to be encrypted is already encoded""" + pass - - @property - def InnerContentType(self)->'Any': - """Optional. Only used if message to be encrypted is already encoded""" - pass - - - @property - def MsgEncodingType(self)->'Any': - """Optional. Defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" - pass + @property + def MsgEncodingType(self) -> 'Any': + """Optional. Defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" + pass class PyCRYPT_SIGN_MESSAGE_PARA(object): - """Dict of parms defining how a message will be signed""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def SigningCert(self)->'PyCERT_CONTEXT': - """Certficate to be used to sign message""" - pass - - - @property - def HashAlgorithm(self)->'PyCRYPT_ALGORITHM_IDENTIFIER': - """Algorithm to be used for signed hash""" - pass - - - @property - def HashAuxInfo(self)->'Any': - """Optional. Param is reserved, use only None.""" - pass - - - @property - def MsgCert(self)->'Tuple[PyCERT_CONTEXT, ...]': - """Optional sequence of certificate to be included in the message.""" - pass - - - @property - def MsgCrl(self)->'Tuple[Any, ...]': - """Optional. Sequence of certificate revocation lists. Not yet supported, use only None.""" - pass - - - @property - def AuthAttr(self)->'Tuple[PyCRYPT_ATTRIBUTE, ...]': - """Sequence of canonical attributes to be added to the message""" - pass - - - @property - def UnauthAttr(self)->'Tuple[PyCRYPT_ATTRIBUTE, ...]': - """Sequence of arbitrary attributes""" - pass - - - @property - def Flags(self)->'Any': - """Optional CRYPT_MESSAGE_*_FLAG that indicates content type if output is to be further encoded.""" - pass - - - @property - def InnerContentType(self)->'Any': - """Optional, one of the CMSG_* content types if message is already encoded, .""" - pass - - - @property - def MsgEncodingType(self)->'Any': - """Encoding types, optional. Defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" - pass + """Dict of parms defining how a message will be signed""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def SigningCert(self) -> 'PyCERT_CONTEXT': + """Certficate to be used to sign message""" + pass + + @property + def HashAlgorithm(self) -> 'PyCRYPT_ALGORITHM_IDENTIFIER': + """Algorithm to be used for signed hash""" + pass + + @property + def HashAuxInfo(self) -> 'Any': + """Optional. Param is reserved, use only None.""" + pass + + @property + def MsgCert(self) -> 'Tuple[PyCERT_CONTEXT, ...]': + """Optional sequence of certificate to be included in the message.""" + pass + + @property + def MsgCrl(self) -> 'Tuple[Any, ...]': + """Optional. Sequence of certificate revocation lists. Not yet supported, use only None.""" + pass + + @property + def AuthAttr(self) -> 'Tuple[PyCRYPT_ATTRIBUTE, ...]': + """Sequence of canonical attributes to be added to the message""" + pass + + @property + def UnauthAttr(self) -> 'Tuple[PyCRYPT_ATTRIBUTE, ...]': + """Sequence of arbitrary attributes""" + pass + + @property + def Flags(self) -> 'Any': + """Optional CRYPT_MESSAGE_*_FLAG that indicates content type if output is to be further encoded.""" + pass + + @property + def InnerContentType(self) -> 'Any': + """Optional, one of the CMSG_* content types if message is already encoded, .""" + pass + + @property + def MsgEncodingType(self) -> 'Any': + """Encoding types, optional. Defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" + pass class PyCRYPT_VERIFY_MESSAGE_PARA(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def MsgAndCertEncodingType(self) -> 'Any': + """Encoding types, defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" + pass - @property - def MsgAndCertEncodingType(self)->'Any': - """Encoding types, defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" - pass + @property + def CryptProv(self) -> 'PyCRYPTPROV': + """CSP to be used to verify signature. Use None for default provider.""" + pass + @property + def PyGetSignerCertificate(self) -> 'Any': + """Callback function that locates signer's certificate.""" + pass - @property - def CryptProv(self)->'PyCRYPTPROV': - """CSP to be used to verify signature. Use None for default provider.""" - pass - - - @property - def PyGetSignerCertificate(self)->'Any': - """Callback function that locates signer's certificate.""" - pass - - - @property - def GetArg(self)->'Any': - """Argument to be passed to above function, can be any object.""" - pass + @property + def GetArg(self) -> 'Any': + """Argument to be passed to above function, can be any object.""" + pass class PyCTL_CONTEXT(object): - """Object containing a Certificate Trust List""" + """Object containing a Certificate Trust List""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def HCTL_CONTEXT(self) -> 'Any': + """Raw message handle""" + pass - @property - def HCTL_CONTEXT(self)->'Any': - """Raw message handle""" - pass - - - def CertFreeCTLContext(self,) -> 'None': - """ + def CertFreeCTLContext(self,) -> 'None': + """ Closes the CTL handle Args: @@ -2375,13 +2810,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CertEnumCTLContextProperties(self,) -> 'Tuple[Any, ...]': - """ + def CertEnumCTLContextProperties(self,) -> 'Tuple[Any, ...]': + """ Lists property id's for the context Args: @@ -2391,13 +2825,12 @@ Args: Returns: Tuple[Any, ...] - - """ - pass + """ + pass - def CertEnumSubjectInSortedCTL(self,) -> 'Tuple[Tuple[Any, Any], ...]': - """ + def CertEnumSubjectInSortedCTL(self,) -> 'Tuple[Tuple[Any, Any], ...]': + """ Retrieves trusted subjects contained in CRL Args: @@ -2411,13 +2844,12 @@ Returns: ((str,str),...) = CertEnumSubjectInSortedCTL()Retrieves trusted subjects contained in CRL Return ValueReturns a sequence of tuples containing two strings (SubjectIdentifier, EncodedAttributes) - - """ - pass + """ + pass - def CertDeleteCTLFromStore(self,) -> 'None': - """ + def CertDeleteCTLFromStore(self,) -> 'None': + """ Removes the CTL from the store that it is contained in Args: @@ -2427,13 +2859,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CertSerializeCTLStoreElement(self,Flags:'Any'=0) -> 'str': - """ + def CertSerializeCTLStoreElement(self, Flags: 'Any' = 0) -> 'str': + """ Serializes the CTL and its properties Args: @@ -2443,28 +2874,27 @@ Args: Returns: str - - """ - pass + + """ + pass class PyCTL_USAGE(object): - """Sequence of string OIDs (szOID_*). This struct is identical to CERT_ENHKEY_USAGE.""" + """Sequence of string OIDs (szOID_*). This struct is identical to CERT_ENHKEY_USAGE.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyConsoleScreenBuffer(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def SetConsoleActiveScreenBuffer(self,) -> 'None': - """ - Sets this handle as the currently displayed screen + def SetConsoleActiveScreenBuffer(self,) -> 'None': + """ + Sets this handle as the currently displayed screen buffer @@ -2475,14 +2905,13 @@ Args: Returns: None - - """ - pass + """ + pass - def GetConsoleCursorInfo(self,) -> 'Tuple[Any, Any]': - """ - Retrieves size and visibility of console's + def GetConsoleCursorInfo(self,) -> 'Tuple[Any, Any]': + """ + Retrieves size and visibility of console's cursor @@ -2494,20 +2923,19 @@ Returns: Tuple[Any, 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 + """ + pass - def SetConsoleCursorInfo(self,Size:'Any',Visible:'Any') -> 'None': - """ + def SetConsoleCursorInfo(self, Size: 'Any', Visible: 'Any') -> 'None': + """ Sets the size and visibility of console's cursor Args: @@ -2518,13 +2946,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetConsoleMode(self,) -> 'Any': - """ + def GetConsoleMode(self,) -> 'Any': + """ Returns the input or output mode of the console buffer Args: @@ -2538,13 +2965,12 @@ 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 + """ + pass - def SetConsoleMode(self,Mode:'Any') -> 'None': - """ + def SetConsoleMode(self, Mode: 'Any') -> 'None': + """ Sets the input or output mode of the console buffer Args: @@ -2554,13 +2980,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ReadConsole(self,NumberOfCharsToRead:'Any') -> 'Any': - """ + def ReadConsole(self, NumberOfCharsToRead: 'Any') -> 'Any': + """ Reads characters from the console input buffer Args: @@ -2570,13 +2995,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def WriteConsole(self,Buffer:'Any') -> 'Any': - """ + def WriteConsole(self, Buffer: 'Any') -> 'Any': + """ Writes characters at current cursor position Args: @@ -2587,13 +3011,12 @@ Returns: Any:String or Unicode to be written to consoleReturn ValueReturns the number of characters written - - """ - pass + """ + pass - def FlushConsoleInputBuffer(self,) -> 'None': - """ + def FlushConsoleInputBuffer(self,) -> 'None': + """ Flush input buffer Args: @@ -2603,13 +3026,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetConsoleTextAttribute(self,Attributes:'Any') -> 'None': - """ + def SetConsoleTextAttribute(self, Attributes: 'Any') -> 'None': + """ Sets character attributes for subsequent write operations Args: @@ -2619,13 +3041,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetConsoleCursorPosition(self,CursorPosition:'PyCOORD') -> 'None': - """ + def SetConsoleCursorPosition(self, CursorPosition: 'PyCOORD') -> 'None': + """ Sets the console screen buffer's cursor position Args: @@ -2635,13 +3056,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetConsoleScreenBufferSize(self,Size:'PyCOORD') -> 'None': - """ + def SetConsoleScreenBufferSize(self, Size: 'PyCOORD') -> 'None': + """ Sets the size of the console screen buffer Args: @@ -2651,13 +3071,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetConsoleWindowInfo(self,Absolute:'Any',ConsoleWindow:'PySMALL_RECT') -> 'None': - """ + def SetConsoleWindowInfo(self, Absolute: 'Any', ConsoleWindow: 'PySMALL_RECT') -> 'None': + """ Changes size and position of a console's window Args: @@ -2668,13 +3087,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetConsoleScreenBufferInfo(self,) -> 'Any': - """ + def GetConsoleScreenBufferInfo(self,) -> 'Any': + """ Returns the state of the screen buffer Args: @@ -2684,14 +3102,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetLargestConsoleWindowSize(self,) -> 'PyCOORD': - """ - Returns the largest possible size for the + def GetLargestConsoleWindowSize(self,) -> 'PyCOORD': + """ + Returns the largest possible size for the console's window @@ -2702,14 +3119,13 @@ Args: Returns: PyCOORD - - """ - pass + """ + pass - def FillConsoleOutputAttribute(self,Attribute:'Any',Length:'Any',WriteCoord:'PyCOORD') -> 'Any': - """ - Set text attributes for a consecutive series of + def FillConsoleOutputAttribute(self, Attribute: 'Any', Length: 'Any', WriteCoord: 'PyCOORD') -> 'Any': + """ + Set text attributes for a consecutive series of characters @@ -2723,14 +3139,13 @@ Returns: Any:The screen position to begin atReturn ValueReturns the number of character cells whose attributes were set - - """ - pass + """ + pass - def FillConsoleOutputCharacter(self,Character:'Any',Length:'Any',WriteCoord:'PyCOORD') -> 'Any': - """ - Sets consecutive character positions to a specified + def FillConsoleOutputCharacter(self, Character: 'Any', Length: 'Any', WriteCoord: 'PyCOORD') -> 'Any': + """ + Sets consecutive character positions to a specified character @@ -2744,14 +3159,13 @@ Returns: Any:The screen position to begin atReturn ValueReturns the number of characters actually written - - """ - pass + """ + pass - def ReadConsoleOutputCharacter(self,Length:'Any',ReadCoord:'PyCOORD') -> 'str': - """ - Reads consecutive characters from a starting + def ReadConsoleOutputCharacter(self, Length: 'Any', ReadCoord: 'PyCOORD') -> 'str': + """ + Reads consecutive characters from a starting position @@ -2763,14 +3177,13 @@ Args: Returns: str - - """ - pass + """ + pass - def ReadConsoleOutputAttribute(self,Length:'Any',ReadCoord:'PyCOORD') -> 'Tuple[Any, ...]': - """ - Retrieves attributes from consecutive character + def ReadConsoleOutputAttribute(self, Length: 'Any', ReadCoord: 'PyCOORD') -> 'Tuple[Any, ...]': + """ + Retrieves attributes from consecutive character cells @@ -2783,13 +3196,12 @@ Returns: Tuple[Any, ...]:The screen position from which to start readingReturn ValueReturns a sequence of ints containing the attributes of a range of characters - - """ - pass + """ + pass - def WriteConsoleOutputCharacter(self,Characters:'Any',WriteCoord:'PyCOORD') -> 'Any': - """ + def WriteConsoleOutputCharacter(self, Characters: 'Any', WriteCoord: 'PyCOORD') -> 'Any': + """ Writes a string of characters at a specified position Args: @@ -2801,13 +3213,12 @@ Returns: Any:The screen position at which to start writingReturn ValueReturns the number of characters actually written - - """ - pass + """ + pass - def WriteConsoleOutputAttribute(self,Attributes:'Tuple[Any, ...]',WriteCoord:'PyCOORD') -> 'Any': - """ + def WriteConsoleOutputAttribute(self, Attributes: 'Tuple[Any, ...]', WriteCoord: 'PyCOORD') -> 'Any': + """ Sets the attributes of a range of character cells Args: @@ -2819,13 +3230,18 @@ Returns: Any:The screen position at which to start writingReturn ValueReturns the number of attributes set - - """ - pass + """ + pass - def ScrollConsoleScreenBuffer(self,ScrollRectangle:'PySMALL_RECT',ClipRectangle:'PySMALL_RECT',DestinationOrigin:'PyCOORD',FillCharacter:'Any',FillAttribute:'Any') -> 'None': - """ + def ScrollConsoleScreenBuffer( + self, + ScrollRectangle: 'PySMALL_RECT', + ClipRectangle: 'PySMALL_RECT', + DestinationOrigin: 'PyCOORD', + FillCharacter: 'Any', + FillAttribute: 'Any') -> 'None': + """ Scrolls a region of the display Args: @@ -2839,13 +3255,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetCurrentConsoleFont(self,MaximumWindow:'Any'=False) -> 'Tuple[Any, PyCOORD]': - """ + def GetCurrentConsoleFont(self, MaximumWindow: 'Any' = False) -> 'Tuple[Any, PyCOORD]': + """ Returns currently displayed font Args: @@ -2857,20 +3272,19 @@ Returns: Tuple[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 + """ + pass - def GetConsoleFontSize(self,Font:'Any') -> 'PyCOORD': - """ + def GetConsoleFontSize(self, Font: 'Any') -> 'PyCOORD': + """ Returns size of specified font for the console Args: @@ -2880,13 +3294,12 @@ Args: Returns: PyCOORD - - """ - pass + """ + pass - def SetConsoleFont(self,Font:'Any') -> 'None': - """ + def SetConsoleFont(self, Font: 'Any') -> 'None': + """ Changes the font used by the screen buffer Args: @@ -2896,13 +3309,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetStdHandle(self,StdHandle:'Any') -> 'None': - """ + def SetStdHandle(self, StdHandle: 'Any') -> 'None': + """ Replaces one of calling process's standard handles with this handle Args: @@ -2912,13 +3324,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetConsoleDisplayMode(self,Flags:'Any',NewScreenBufferDimensions:'PyCOORD') -> 'None': - """ + def SetConsoleDisplayMode(self, Flags: 'Any', NewScreenBufferDimensions: 'PyCOORD') -> 'None': + """ Sets the display mode of the console buffer Args: @@ -2929,13 +3340,12 @@ Args: Returns: None - - """ - pass + """ + pass - def WriteConsoleInput(self,Buffer:'Tuple[PyINPUT_RECORD, ...]') -> 'Any': - """ + def WriteConsoleInput(self, Buffer: 'Tuple[PyINPUT_RECORD, ...]') -> 'Any': + """ Places input records in the console's input queue Args: @@ -2946,14 +3356,13 @@ Returns: Any:A sequence of PyINPUT_RECORD objectsReturn ValueReturns the number of records written - - """ - pass + """ + pass - def ReadConsoleInput(self,Length:'Any') -> 'Tuple[PyINPUT_RECORD, ...]': - """ - Reads input records and removes them from + def ReadConsoleInput(self, Length: 'Any') -> 'Tuple[PyINPUT_RECORD, ...]': + """ + Reads input records and removes them from the input queue @@ -2965,19 +3374,18 @@ Returns: 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 + """ + pass - def PeekConsoleInput(self,Length:'Any') -> 'Tuple[PyINPUT_RECORD, ...]': - """ - Returns pending input records without + def PeekConsoleInput(self, Length: 'Any') -> 'Tuple[PyINPUT_RECORD, ...]': + """ + Returns pending input records without removing them from the input queue @@ -2989,19 +3397,18 @@ Returns: 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 + """ + pass - def GetNumberOfConsoleInputEvents(self,) -> 'Any': - """ - Returns the number of unread records in the input + def GetNumberOfConsoleInputEvents(self,) -> 'Any': + """ + Returns the number of unread records in the input queue @@ -3012,20 +3419,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyCredHandle(object): - """Handle to a set of logon credentials, used with sspi authentication functions""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCredHandle(object): + """Handle to a set of logon credentials, used with sspi authentication functions""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Detach(self,) -> 'Any': - """ + def Detach(self,) -> 'Any': + """ Disassociates object from handle and returns integer value of handle, Args: @@ -3035,13 +3441,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def FreeCredentialsHandle(self,) -> 'None': - """ + def FreeCredentialsHandle(self,) -> 'None': + """ Releases the credentials handle and makes object unusable Args: @@ -3051,13 +3456,12 @@ Args: Returns: None - - """ - pass + """ + pass - def QueryCredentialsAttributes(self,Attribute:'Any') -> 'None': - """ + def QueryCredentialsAttributes(self, Attribute: 'Any') -> 'None': + """ Returns information about the credentials Args: @@ -3080,31 +3484,30 @@ 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 + """ + pass -class PyCtxtHandle(object): - """Security context handle, as used with sspi functions""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCtxtHandle(object): + """Security context handle, as used with sspi functions""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Detach(self,) -> 'Any': - """ + def Detach(self,) -> 'Any': + """ Disassociates object from handle and returns integer value of handle Args: @@ -3114,13 +3517,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def CompleteAuthToken(self,Token:'PySecBufferDesc') -> 'None': - """ + def CompleteAuthToken(self, Token: 'PySecBufferDesc') -> 'None': + """ Completes the authentication token Args: @@ -3130,13 +3532,12 @@ Args: Returns: None - - """ - pass + """ + pass - def QueryContextAttributes(self,Attribute:'Any') -> 'None': - """ + def QueryContextAttributes(self, Attribute: 'Any') -> 'None': + """ Retrieves info about a security context Args: @@ -3146,13 +3547,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DeleteSecurityContext(self,) -> 'None': - """ + def DeleteSecurityContext(self,) -> 'None': + """ Frees the security context and invalidates the handle Args: @@ -3162,13 +3562,12 @@ Args: Returns: None - - """ - pass + """ + pass - def QuerySecurityContextToken(self,) -> 'Any': - """ + def QuerySecurityContextToken(self,) -> 'Any': + """ Returns the access token for a security context Args: @@ -3178,14 +3577,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def MakeSignature(self,fqop:'Any',Message:'PySecBufferDesc',MessageSeqNo:'Any') -> 'None': - """ - Creates a crytographic hash of a message using session key of the security + def MakeSignature(self, fqop: 'Any', Message: 'PySecBufferDesc', MessageSeqNo: 'Any') -> 'None': + """ + Creates a crytographic hash of a message using session key of the security context @@ -3197,22 +3595,21 @@ 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 + """ + pass - def VerifySignature(self,Message:'PySecBufferDesc',MessageSeqNo:'Any') -> 'None': - """ + def VerifySignature(self, Message: 'PySecBufferDesc', MessageSeqNo: 'Any') -> 'None': + """ None Args: @@ -3222,24 +3619,23 @@ 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 + """ + pass - def EncryptMessage(self,fqop:'Any',Message:'PySecBufferDesc',MessageSeqNo:'Any') -> 'None': - """ + def EncryptMessage(self, fqop: 'Any', Message: 'PySecBufferDesc', MessageSeqNo: 'Any') -> 'None': + """ Encrypts data with session key of security context Args: @@ -3250,24 +3646,23 @@ 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 + """ + pass - def DecryptMessage(self,Message:'PySecBufferDesc',MessageSeqNo:'Any') -> 'None': - """ + def DecryptMessage(self, Message: 'PySecBufferDesc', MessageSeqNo: 'Any') -> 'None': + """ None Args: @@ -3277,26 +3672,25 @@ 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 + """ + pass - def ImpersonateSecurityContext(self,) -> 'None': - """ + def ImpersonateSecurityContext(self,) -> 'None': + """ Impersonates a client security context Args: @@ -3306,13 +3700,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RevertSecurityContext(self,) -> 'None': - """ + def RevertSecurityContext(self,) -> 'None': + """ None Args: @@ -3322,430 +3715,997 @@ Args: Returns: None - - """ - pass + + """ + pass class PyDCB(object): - """A Python object, representing an DCB structure""" + """A Python object, representing an DCB structure""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def BaudRate(self) -> 'int': + """current baud rate""" + pass + + @property + def wReserved(self) -> 'int': + """not currently used""" + pass + + @property + def XonLim(self) -> 'int': + """transmit XON threshold""" + pass + + @property + def XoffLim(self) -> 'int': + """transmit XOFF threshold""" + pass + + @property + def ByteSize(self) -> 'int': + """number of bits/byte, 4-8""" + pass + + @property + def Parity(self) -> 'int': + """0-4=no,odd,even,mark,space""" + pass + + @property + def StopBits(self) -> 'int': + """0,1,2 = 1, 1.5, 2""" + pass + + @property + def XonChar(self) -> 'str': + """Tx and Rx XON character""" + pass + + @property + def XoffChar(self) -> 'str': + """Tx and Rx XOFF character""" + pass + + @property + def ErrorChar(self) -> 'str': + """error replacement character""" + pass + + @property + def EofChar(self) -> 'str': + """end of input character""" + pass + + @property + def EvtChar(self) -> 'str': + """received event character""" + pass + + @property + def wReserved1(self) -> 'int': + """reserved; do not use""" + pass + + @property + def fBinary(self) -> 'int': + """binary mode, no EOF check""" + pass + + @property + def fParity(self) -> 'int': + """enable parity checking""" + pass + + @property + def fOutxCtsFlow(self) -> 'int': + """CTS output flow control""" + pass + + @property + def fOutxDsrFlow(self) -> 'int': + """DSR output flow control""" + pass + + @property + def fDtrControl(self) -> 'int': + """DTR flow control type""" + pass + + @property + def fDsrSensitivity(self) -> 'int': + """DSR sensitivity""" + pass + + @property + def fTXContinueOnXoff(self) -> 'int': + """XOFF continues Tx""" + pass + + @property + def fOutX(self) -> 'int': + """XON/XOFF out flow control""" + pass + + @property + def fInX(self) -> 'int': + """XON/XOFF in flow control""" + pass + + @property + def fErrorChar(self) -> 'int': + """enable error replacement""" + pass + + @property + def fNull(self) -> 'int': + """enable null stripping""" + pass + + @property + def fRtsControl(self) -> 'int': + """RTS flow control""" + pass + + @property + def fAbortOnError(self) -> 'int': + """abort on error""" + pass + + @property + def fDummy2(self) -> 'int': + """reserved""" + pass - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyDEVMODE(object): + """Python object wrapping a DEVMODE structure""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def SpecVersion(self) -> 'Any': + """Should always be set to DM_SPECVERSION""" + pass + + @property + def DriverVersion(self) -> 'Any': + """Version nbr assigned to printer driver by vendor""" + pass + + @property + def Size(self) -> 'Any': + """Size of structure""" + pass + + @property + def DriverExtra(self) -> 'Any': + """Number of extra bytes allocated for driver data, can only be set when new object is created""" + pass + + @property + def Fields(self) -> 'Any': + """Bitmask of win32con.DM_* constants indicating which members are set""" + pass + + @property + def Orientation(self) -> 'Any': + """Only applies to printers, DMORIENT_PORTRAIT or DMORIENT_LANDSCAPE""" + pass + + @property + def PaperSize(self) -> 'Any': + """Use 0 if PaperWidth and PaperLength are set, otherwise win32con.DMPAPER_* constant""" + pass + + @property + def PaperLength(self) -> 'Any': + """Specified in 1/10 millimeters""" + pass + + @property + def PaperWidth(self) -> 'Any': + """Specified in 1/10 millimeters""" + pass + + @property + def Position_x(self) -> 'Any': + """Position of display relative to desktop""" + pass + + @property + def Position_y(self) -> 'Any': + """Position of display relative to desktop""" + pass + + @property + def DisplayOrientation(self) -> 'Any': + """Display rotation: DMDO_DEFAULT,DMDO_90, DMDO_180, DMDO_270""" + pass + + @property + def DisplayFixedOutput(self) -> 'Any': + """DMDFO_DEFAULT, DMDFO_CENTER, DMDFO_STRETCH""" + pass + + @property + def Scale(self) -> 'Any': + """Specified as percentage, eg 50 means half size of original""" + pass + + @property + def Copies(self) -> 'Any': + """Nbr of copies to print""" + pass + + @property + def DefaultSource(self) -> 'Any': + """DMBIN_* constant, or can be a printer-specific value""" + pass + + @property + def PrintQuality(self) -> 'Any': + """DMRES_* constant, interpreted as DPI if positive""" + pass + + @property + def Color(self) -> 'Any': + """DMCOLOR_COLOR or DMCOLOR_MONOCHROME""" + pass + + @property + def Duplex(self) -> 'Any': + """For printers that do two-sided printing: DMDUP_SIMPLEX, DMDUP_HORIZONTAL, DMDUP_VERTICAL""" + pass + + @property + def YResolution(self) -> 'Any': + """Vertical printer resolution in DPI - if this is set, PrintQuality indicates horizontal DPI""" + pass + + @property + def TTOption(self) -> 'Any': + """TrueType options: DMTT_BITMAP, DMTT_DOWNLOAD, DMTT_DOWNLOAD_OUTLINE, DMTT_SUBDEV""" + pass + + @property + def Collate(self) -> 'Any': + """DMCOLLATE_TRUE or DMCOLLATE_FALSE""" + pass + + @property + def LogPixels(self) -> 'Any': + """Pixels per inch (only for display devices""" + pass + + @property + def BitsPerPel(self) -> 'Any': + """Color resolution in bits per pixel""" + pass + + @property + def PelsWidth(self) -> 'Any': + """Pixel width of display""" + pass + + @property + def PelsHeight(self) -> 'Any': + """Pixel height of display""" + pass + + @property + def DisplayFlags(self) -> 'Any': + """Combination of DM_GRAYSCALE and DM_INTERLACED""" + pass + + @property + def DisplayFrequency(self) -> 'Any': + """Refresh rate""" + pass + + @property + def ICMMethod(self) -> 'Any': + """Indicates where ICM is performed, one of win32con.DMICMMETHOD_* values""" + pass + + @property + def ICMIntent(self) -> 'Any': + """Intent of ICM, one of win32con.DMICM_* values""" + pass + + @property + def MediaType(self) -> 'Any': + """win32con.DMMEDIA_*, can also be a printer-specific value greater then DMMEDIA_USER""" + pass + + @property + def DitherType(self) -> 'Any': + """Dithering option, win32con.DMDITHER_*""" + pass + + @property + def Reserved1(self) -> 'Any': + """Reserved, use only 0""" + pass + + @property + def Reserved2(self) -> 'Any': + """Reserved, use only 0""" + pass + + @property + def Nup(self) -> 'Any': + """Controls printing of multiple logical pages per physical page, DMNUP_SYSTEM or DMNUP_ONEUP""" + pass + + @property + def PanningWidth(self) -> 'Any': + """Not used, leave as 0""" + pass + + @property + def PanningHeight(self) -> 'Any': + """Not used, leave as 0""" + pass + + @property + def DeviceName(self) -> 'Any': + """String of at most 32 chars""" + pass + + @property + def FormName(self) -> 'Any': + """Name of form as returned by win32print::EnumForms, at most 32 chars""" + pass + + @property + def DriverData(self) -> 'Any': + """Driver data appended to end of structure""" + pass + + def Clear(self,) -> 'None': + """ + Resets all members of the structure - @property - def BaudRate(self)->'int': - """current baud rate""" - pass +Args: - @property - def wReserved(self)->'int': - """not currently used""" - pass +Returns: - @property - def XonLim(self)->'int': - """transmit XON threshold""" - pass + None + """ + pass - @property - def XoffLim(self)->'int': - """transmit XOFF threshold""" - pass +class PyDEVMODEW(object): + """""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def SpecVersion(self) -> 'Any': + """Should always be set to DM_SPECVERSION""" + pass + + @property + def DriverVersion(self) -> 'Any': + """Version nbr assigned to printer driver by vendor""" + pass + + @property + def Size(self) -> 'Any': + """Size of structure""" + pass + + @property + def DriverExtra(self) -> 'Any': + """Number of extra bytes allocated for driver data, can only be set when new object is created""" + pass + + @property + def Fields(self) -> 'Any': + """Bitmask of win32con.DM_* constants indicating which members are set""" + pass + + @property + def Orientation(self) -> 'Any': + """Only applies to printers, DMORIENT_PORTRAIT or DMORIENT_LANDSCAPE""" + pass + + @property + def PaperSize(self) -> 'Any': + """Use 0 if PaperWidth and PaperLength are set, otherwise win32con.DMPAPER_* constant""" + pass + + @property + def PaperLength(self) -> 'Any': + """Specified in 1/10 millimeters""" + pass + + @property + def PaperWidth(self) -> 'Any': + """Specified in 1/10 millimeters""" + pass + + @property + def Position_x(self) -> 'Any': + """Position of display relative to desktop""" + pass + + @property + def Position_y(self) -> 'Any': + """Position of display relative to desktop""" + pass + + @property + def DisplayOrientation(self) -> 'Any': + """Display rotation: DMDO_DEFAULT,DMDO_90, DMDO_180, DMDO_270""" + pass + + @property + def DisplayFixedOutput(self) -> 'Any': + """DMDFO_DEFAULT, DMDFO_CENTER, DMDFO_STRETCH""" + pass + + @property + def Scale(self) -> 'Any': + """Specified as percentage, eg 50 means half size of original""" + pass + + @property + def Copies(self) -> 'Any': + """Nbr of copies to print""" + pass + + @property + def DefaultSource(self) -> 'Any': + """DMBIN_* constant, or can be a printer-specific value""" + pass + + @property + def PrintQuality(self) -> 'Any': + """DMRES_* constant, interpreted as DPI if positive""" + pass + + @property + def Color(self) -> 'Any': + """DMCOLOR_COLOR or DMCOLOR_MONOCHROME""" + pass + + @property + def Duplex(self) -> 'Any': + """For printers that do two-sided printing: DMDUP_SIMPLEX, DMDUP_HORIZONTAL, DMDUP_VERTICAL""" + pass + + @property + def YResolution(self) -> 'Any': + """Vertical printer resolution in DPI - if this is set, PrintQuality indicates horizontal DPI""" + pass + + @property + def TTOption(self) -> 'Any': + """TrueType options: DMTT_BITMAP, DMTT_DOWNLOAD, DMTT_DOWNLOAD_OUTLINE, DMTT_SUBDEV""" + pass + + @property + def Collate(self) -> 'Any': + """DMCOLLATE_TRUE or DMCOLLATE_FALSE""" + pass + + @property + def LogPixels(self) -> 'Any': + """Pixels per inch (only for display devices""" + pass + + @property + def BitsPerPel(self) -> 'Any': + """Color resolution in bits per pixel""" + pass + + @property + def PelsWidth(self) -> 'Any': + """Pixel width of display""" + pass + + @property + def PelsHeight(self) -> 'Any': + """Pixel height of display""" + pass + + @property + def DisplayFlags(self) -> 'Any': + """Combination of DM_GRAYSCALE and DM_INTERLACED""" + pass + + @property + def DisplayFrequency(self) -> 'Any': + """Refresh rate""" + pass + + @property + def ICMMethod(self) -> 'Any': + """Indicates where ICM is performed, one of win32con.DMICMMETHOD_* values""" + pass + + @property + def ICMIntent(self) -> 'Any': + """Intent of ICM, one of win32con.DMICM_* values""" + pass + + @property + def MediaType(self) -> 'Any': + """win32con.DMMEDIA_*, can also be a printer-specific value greater then DMMEDIA_USER""" + pass + + @property + def DitherType(self) -> 'Any': + """Dithering option, win32con.DMDITHER_*""" + pass + + @property + def Reserved1(self) -> 'Any': + """Reserved, use only 0""" + pass + + @property + def Reserved2(self) -> 'Any': + """Reserved, use only 0""" + pass + + @property + def Nup(self) -> 'Any': + """Controls printing of multiple logical pages per physical page, DMNUP_SYSTEM or DMNUP_ONEUP""" + pass + + @property + def PanningWidth(self) -> 'Any': + """Not used, leave as 0""" + pass + + @property + def PanningHeight(self) -> 'Any': + """Not used, leave as 0""" + pass + + @property + def DeviceName(self) -> 'str': + """String of at most 32 chars""" + pass + + @property + def FormName(self) -> 'Any': + """Name of form as returned by win32print::EnumForms, at most 32 chars""" + pass + + @property + def DriverData(self) -> 'Any': + """Driver data appended to end of structure""" + pass - @property - def ByteSize(self)->'int': - """number of bits/byte, 4-8""" - pass +class PyDISPLAY_DEVICE(object): + """Python object wrapping a DISPLAY_DEVICE structure""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def Size(self) -> 'Any': + """Size of structure""" + pass + + @property + def DeviceName(self) -> 'Any': + """String of at most 32 chars""" + pass + + @property + def DeviceString(self) -> 'Any': + """String of at most 128 chars""" + pass + + @property + def StateFlags(self) -> 'Any': + """Bitmask of win32con.DISPLAY_DEVICE_* constants indicating current device status""" + pass + + @property + def DeviceID(self) -> 'Any': + """String of at most 128 chars""" + pass + + @property + def DeviceKey(self) -> 'Any': + """String of at most 128 chars""" + pass + + def Clear(self,) -> 'None': + """ + Resets all members of the structure - @property - def Parity(self)->'int': - """0-4=no,odd,even,mark,space""" - pass +Args: - @property - def StopBits(self)->'int': - """0,1,2 = 1, 1.5, 2""" - pass +Returns: - @property - def XonChar(self)->'str': - """Tx and Rx XON character""" - pass + None + """ + pass - @property - def XoffChar(self)->'str': - """Tx and Rx XOFF character""" - pass +class PyDLGITEMTEMPLATE(object): + """A tuple describing a control in a dialog box.""" - @property - def ErrorChar(self)->'str': - """error replacement character""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def EofChar(self)->'str': - """end of input character""" - pass +class PyDLGTEMPLATE(object): + """A tuple of items describing a dialog box, that can be used to create the dialog.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def EvtChar(self)->'str': - """received event character""" - pass +class PyDS_HANDLE(object): + """""" - @property - def wReserved1(self)->'int': - """reserved; do not use""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def fBinary(self)->'int': - """binary mode, no EOF check""" - pass +class PyDS_NAME_RESULT_ITEM(object): + """A tuple representing a DS_NAME_RESULT_ITEM""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def fParity(self)->'int': - """enable parity checking""" - pass +class PyDateTime(object): + """A Python object, representing an instant in time.""" - @property - def fOutxCtsFlow(self)->'int': - """CTS output flow control""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + def Format(self,) -> 'Any': + """ + None - @property - def fOutxDsrFlow(self)->'int': - """DSR output flow control""" - pass +Args: - @property - def fDtrControl(self)->'int': - """DTR flow control type""" - pass +Returns: - @property - def fDsrSensitivity(self)->'int': - """DSR sensitivity""" - pass + Any + """ + pass - @property - def fTXContinueOnXoff(self)->'int': - """XOFF continues Tx""" - pass +class PyDialogTemplate(object): + """""" - @property - def fOutX(self)->'int': - """XON/XOFF out flow control""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def fInX(self)->'int': - """XON/XOFF in flow control""" - pass +class PyEVTLOG_HANDLE(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def fErrorChar(self)->'int': - """enable error replacement""" - pass +class PyEVT_HANDLE(object): + """Handle to an event log, session, query, or any other object used with - @property - def fNull(self)->'int': - """enable null stripping""" - pass +the Evt* event log functions on Vista and later. +When the object is destroyed, EvtClose is called.""" - @property - def fRtsControl(self)->'int': - """RTS flow control""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def fAbortOnError(self)->'int': - """abort on error""" - pass +class PyEVT_RPC_LOGIN(object): + """Tuple containing login credentials for a remote Event Log connection""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def fDummy2(self)->'int': - """reserved""" - pass +class PyEventLogRecord(object): + """An object containing the data in an EVENTLOGRECORD.""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def Reserved(self) -> 'int': + """""" + pass + + @property + def RecordNumber(self) -> 'int': + """""" + pass + + @property + def TimeGenerated(self) -> 'PyTime': + """""" + pass + + @property + def TimeWritten(self) -> 'PyTime': + """""" + pass + + @property + def EventID(self) -> 'int': + """""" + pass + + @property + def EventType(self) -> 'int': + """""" + pass + + @property + def EventCategory(self) -> 'int': + """""" + pass + + @property + def ReservedFlags(self) -> 'int': + """""" + pass + + @property + def ClosingRecordNumber(self) -> 'int': + """""" + pass + + @property + def SourceName(self) -> 'str': + """""" + pass + + @property + def StringInserts(self) -> 'Tuple[str, ...]': + """""" + pass + + @property + def Sid(self) -> 'PySID': + """""" + pass + + @property + def Data(self) -> 'str': + """""" + pass + + @property + def ComputerName(self) -> 'str': + """""" + pass -class PyDEVMODE(object): - """Python object wrapping a DEVMODE structure""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyGROUP_INFO_0(object): + """A dictionary holding the information in a Win32 GROUP_INFO_0 structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def SpecVersion(self)->'Any': - """Should always be set to DM_SPECVERSION""" - pass + @property + def name(self) -> 'Union[str]': + """Name of the group""" + pass - @property - def DriverVersion(self)->'Any': - """Version nbr assigned to printer driver by vendor""" - pass +class PyGROUP_INFO_1(object): + """A dictionary holding the information in a Win32 GROUP_INFO_1 structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def Size(self)->'Any': - """Size of structure""" - pass + @property + def name(self) -> 'Union[str]': + """Name of the group""" + pass + @property + def comment(self) -> 'Union[str]': + """The group's comment.""" + pass - @property - def DriverExtra(self)->'Any': - """Number of extra bytes allocated for driver data, can only be set when new object is created""" - pass +class PyGROUP_INFO_1002(object): + """A dictionary holding the information in a Win32 GROUP_INFO_1002 structure.""" - @property - def Fields(self)->'Any': - """Bitmask of win32con.DM_* constants indicating which members are set""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def comment(self) -> 'Union[str]': + """""" + pass - @property - def Orientation(self)->'Any': - """Only applies to printers, DMORIENT_PORTRAIT or DMORIENT_LANDSCAPE""" - pass +class PyGROUP_INFO_1005(object): + """A dictionary holding the information in a Win32 GROUP_INFO_1005 structure.""" - @property - def PaperSize(self)->'Any': - """Use 0 if PaperWidth and PaperLength are set, otherwise win32con.DMPAPER_* constant""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def attributes(self) -> 'Any': + """""" + pass - @property - def PaperLength(self)->'Any': - """Specified in 1/10 millimeters""" - pass +class PyGROUP_INFO_2(object): + """A dictionary holding the information in a Win32 GROUP_INFO_2 structure.""" - @property - def PaperWidth(self)->'Any': - """Specified in 1/10 millimeters""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def name(self) -> 'Union[str]': + """Name of the group""" + pass - @property - def Position_x(self)->'Any': - """Position of display relative to desktop""" - pass + @property + def comment(self) -> 'Union[str]': + """The group's comment.""" + pass + @property + def group_id(self) -> 'Any': + """""" + pass - @property - def Position_y(self)->'Any': - """Position of display relative to desktop""" - pass + @property + def attributes(self) -> 'Any': + """""" + pass - @property - def DisplayOrientation(self)->'Any': - """Display rotation: DMDO_DEFAULT,DMDO_90, DMDO_180, DMDO_270""" - pass +class PyGROUP_USERS_INFO_0(object): + """A dictionary holding the information in a Win32 GROUP_USERS_INFO_0 structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def DisplayFixedOutput(self)->'Any': - """DMDFO_DEFAULT, DMDFO_CENTER, DMDFO_STRETCH""" - pass + @property + def name(self) -> 'Union[str]': + """Name of the group or user""" + pass - @property - def Scale(self)->'Any': - """Specified as percentage, eg 50 means half size of original""" - pass +class PyGROUP_USERS_INFO_1(object): + """A dictionary holding the information in a Win32 GROUP_USERS_INFO_1 structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def Copies(self)->'Any': - """Nbr of copies to print""" - pass + @property + def name(self) -> 'Union[str]': + """Name of the group or user""" + pass + @property + def attributes(self) -> 'Any': + """""" + pass - @property - def DefaultSource(self)->'Any': - """DMBIN_* constant, or can be a printer-specific value""" - pass +class PyGdiHANDLE(object): + """""" - @property - def PrintQuality(self)->'Any': - """DMRES_* constant, interpreted as DPI if positive""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def Color(self)->'Any': - """DMCOLOR_COLOR or DMCOLOR_MONOCHROME""" - pass - - - @property - def Duplex(self)->'Any': - """For printers that do two-sided printing: DMDUP_SIMPLEX, DMDUP_HORIZONTAL, DMDUP_VERTICAL""" - pass - - - @property - def YResolution(self)->'Any': - """Vertical printer resolution in DPI - if this is set, PrintQuality indicates horizontal DPI""" - pass - - - @property - def TTOption(self)->'Any': - """TrueType options: DMTT_BITMAP, DMTT_DOWNLOAD, DMTT_DOWNLOAD_OUTLINE, DMTT_SUBDEV""" - pass - - - @property - def Collate(self)->'Any': - """DMCOLLATE_TRUE or DMCOLLATE_FALSE""" - pass - +class PyGetSignerCertificate(object): + """""" - @property - def LogPixels(self)->'Any': - """Pixels per inch (only for display devices""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def BitsPerPel(self)->'Any': - """Color resolution in bits per pixel""" - pass +class PyHANDLE(object): + """A Python object, representing a win32 HANDLE.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def PelsWidth(self)->'Any': - """Pixel width of display""" - pass + @property + def handle(self) -> 'Any': + """Integer value of the handleMethodsCloseCloses the handle closeSynonym for PyHANDLE::Close DetachDetaches the Win32 handle from the handle object. __nonzero__Used for detecting true/false. is nb_bool in Python 3.0 __int__Used when an integer representation of the handle object is required. __print__Used when the object is printed. tp_print __hash__Used when the hash value of an object is required tp_hash __str__Used when a string representation is required tp_str """ + pass + def Close(self,) -> 'None': + """ + Closes the underlying Win32 handle. - @property - def PelsHeight(self)->'Any': - """Pixel height of display""" - pass +Args: - @property - def DisplayFlags(self)->'Any': - """Combination of DM_GRAYSCALE and DM_INTERLACED""" - pass +Returns: - @property - def DisplayFrequency(self)->'Any': - """Refresh rate""" - pass + None + """ + pass - @property - def ICMMethod(self)->'Any': - """Indicates where ICM is performed, one of win32con.DMICMMETHOD_* values""" - pass + def close(self,) -> 'None': + """ + Closes the underlying Win32 handle. +Args: - @property - def ICMIntent(self)->'Any': - """Intent of ICM, one of win32con.DMICM_* values""" - pass - @property - def MediaType(self)->'Any': - """win32con.DMMEDIA_*, can also be a printer-specific value greater then DMMEDIA_USER""" - pass +Returns: + None - @property - def DitherType(self)->'Any': - """Dithering option, win32con.DMDITHER_*""" - pass + """ + pass + def Detach(self,) -> 'Any': + """ + Detaches the Win32 handle from the handle object. - @property - def Reserved1(self)->'Any': - """Reserved, use only 0""" - pass +Args: - @property - def Reserved2(self)->'Any': - """Reserved, use only 0""" - pass +Returns: - @property - def Nup(self)->'Any': - """Controls printing of multiple logical pages per physical page, DMNUP_SYSTEM or DMNUP_ONEUP""" - pass + Any:PyHANDLE.Detach +int = Detach()Detaches the Win32 handle from the handle object. +Comments - @property - def PanningWidth(self)->'Any': - """Not used, leave as 0""" - pass +After calling this function, the handle is effectively invalidated, +but the handle is not closed. You would call this function when you - @property - def PanningHeight(self)->'Any': - """Not used, leave as 0""" - pass +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 - @property - def DeviceName(self)->'Any': - """String of at most 32 chars""" - pass +handle is already detached, this will return zero. - @property - def FormName(self)->'Any': - """Name of form as returned by win32print::EnumForms, at most 32 chars""" - pass + """ + pass - @property - def DriverData(self)->'Any': - """Driver data appended to end of structure""" - pass +class PyHDESK(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Clear(self,) -> 'None': - """ - Resets all members of the structure + def SetThreadDesktop(self,) -> 'None': + """ + Assigns this desktop to the calling thread Args: @@ -3754,304 +4714,441 @@ Args: Returns: None - - """ - pass - - -class PyDEVMODEW(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """ + pass + def EnumDesktopWindows(self,) -> 'Tuple[int, ...]': + """ + Returns a list of handles to all top-level windows on desktop - @property - def SpecVersion(self)->'Any': - """Should always be set to DM_SPECVERSION""" - pass +Args: - @property - def DriverVersion(self)->'Any': - """Version nbr assigned to printer driver by vendor""" - pass +Returns: - @property - def Size(self)->'Any': - """Size of structure""" - pass + Tuple[int, ...] + """ + pass - @property - def DriverExtra(self)->'Any': - """Number of extra bytes allocated for driver data, can only be set when new object is created""" - pass + def SwitchDesktop(self,) -> 'None': + """ + Activates the desktop +Args: - @property - def Fields(self)->'Any': - """Bitmask of win32con.DM_* constants indicating which members are set""" - pass - @property - def Orientation(self)->'Any': - """Only applies to printers, DMORIENT_PORTRAIT or DMORIENT_LANDSCAPE""" - pass +Returns: + None - @property - def PaperSize(self)->'Any': - """Use 0 if PaperWidth and PaperLength are set, otherwise win32con.DMPAPER_* constant""" - pass + """ + pass + def CloseDesktop(self,) -> 'None': + """ + Closes the desktop handle - @property - def PaperLength(self)->'Any': - """Specified in 1/10 millimeters""" - pass +Args: - @property - def PaperWidth(self)->'Any': - """Specified in 1/10 millimeters""" - pass +Returns: - @property - def Position_x(self)->'Any': - """Position of display relative to desktop""" - pass + None + """ + pass - @property - def Position_y(self)->'Any': - """Position of display relative to desktop""" - pass +class PyHDEVNOTIFY(object): + """""" - @property - def DisplayOrientation(self)->'Any': - """Display rotation: DMDO_DEFAULT,DMDO_90, DMDO_180, DMDO_270""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def DisplayFixedOutput(self)->'Any': - """DMDFO_DEFAULT, DMDFO_CENTER, DMDFO_STRETCH""" - pass +class PyHHNTRACK(object): + """A Python object, representing an HHNTRACK +structure""" - @property - def Scale(self)->'Any': - """Specified as percentage, eg 50 means half size of original""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def action(self) -> 'Any': + """Specifies the action the user is about to take. This is an HHACT_ constant.""" + pass - @property - def Copies(self)->'Any': - """Nbr of copies to print""" - pass + @property + def hdr(self) -> 'Any': + """Standard WM_NOTIFY header(win32help::NMHDR).""" + pass + @property + def curUrl(self) -> 'str': + """A multi-byte, zero-terminated string that specifies the topic navigated to, or the name of the help window being created.""" + pass - @property - def DefaultSource(self)->'Any': - """DMBIN_* constant, or can be a printer-specific value""" - pass + @property + def winType(self) -> 'Any': + """A pointer to the current HH_WINTYPE structure (win32help::HH_WINTYPE).""" + pass - @property - def PrintQuality(self)->'Any': - """DMRES_* constant, interpreted as DPI if positive""" - pass +class PyHHN_NOTIFY(object): + """A Python object, representing an HHN_NOTIFY +structure""" - @property - def Color(self)->'Any': - """DMCOLOR_COLOR or DMCOLOR_MONOCHROME""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def hdr(self) -> 'Any': + """Standard WM_NOTIFY header.(win32help::NMHDR)""" + pass - @property - def Duplex(self)->'Any': - """For printers that do two-sided printing: DMDUP_SIMPLEX, DMDUP_HORIZONTAL, DMDUP_VERTICAL""" - pass + @property + def url(self) -> 'str': + """A multi-byte, zero-terminated string that specifies the topic navigated to, or the name of the help window being created.""" + pass - @property - def YResolution(self)->'Any': - """Vertical printer resolution in DPI - if this is set, PrintQuality indicates horizontal DPI""" - pass +class PyHH_AKLINK(object): + """A Python object, representing an HH_AKLINK structure""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def TTOption(self)->'Any': - """TrueType options: DMTT_BITMAP, DMTT_DOWNLOAD, DMTT_DOWNLOAD_OUTLINE, DMTT_SUBDEV""" - pass + @property + def indexOnFail(self) -> 'Any': + """Specifies whether to display the keyword in the Index tab of the HTML Help Viewer if the lookup fails. The value of window specifies the Help Viewer.""" + pass + @property + def keywords(self) -> 'str': + """Specifies one or more ALink names or KLink keywords to look up. Multiple entries are delimited by a semicolon.""" + pass - @property - def Collate(self)->'Any': - """DMCOLLATE_TRUE or DMCOLLATE_FALSE""" - pass + @property + def url(self) -> 'str': + """Specifies the topic file to navigate to if the lookup fails. url refers to a valid topic within the specified compiled help (.chm) file and does not support Internet protocols that point to an HTML file.""" + pass + @property + def msgText(self) -> 'str': + """Specifies the text to display in a message box if the lookup fails and indexOnFail is FALSE and url is NULL.""" + pass - @property - def LogPixels(self)->'Any': - """Pixels per inch (only for display devices""" - pass + @property + def msgTitle(self) -> 'str': + """Specifies the caption of the message box in which the msgText parameter appears.""" + pass + @property + def window(self) -> 'str': + """Specifies the name of the window type in which to display one of the following: The selected topic, if the lookup yields one or more matching topics. The topic specified in url, if the lookup fails and a topic is specified in url. The Index tab, if the lookup fails and indexOnFail is specified as TRUE.""" + pass - @property - def BitsPerPel(self)->'Any': - """Color resolution in bits per pixel""" - pass +class PyHH_FTS_QUERY(object): + """A Python object, representing an HH_FTS_QUERY - @property - def PelsWidth(self)->'Any': - """Pixel width of display""" - pass +structure""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def PelsHeight(self)->'Any': - """Pixel height of display""" - pass + @property + def uniCodeStrings(self) -> 'Any': + """TRUE if all strings are Unicode.""" + pass + @property + def proximity(self) -> 'Any': + """Word proximity.""" + pass - @property - def DisplayFlags(self)->'Any': - """Combination of DM_GRAYSCALE and DM_INTERLACED""" - pass + @property + def stemmedSearch(self) -> 'Any': + """TRUE for StemmedSearch only.""" + pass + @property + def titleOnly(self) -> 'Any': + """TRUE for Title search only.""" + pass - @property - def DisplayFrequency(self)->'Any': - """Refresh rate""" - pass + @property + def execute(self) -> 'Any': + """TRUE to initiate the search.""" + pass + @property + def searchQuery(self) -> 'str': + """String containing the search query.""" + pass - @property - def ICMMethod(self)->'Any': - """Indicates where ICM is performed, one of win32con.DMICMMETHOD_* values""" - pass +class PyHH_POPUP(object): + """A Python object, representing an HH_POPUP structure""" - @property - def ICMIntent(self)->'Any': - """Intent of ICM, one of win32con.DMICM_* values""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def hinst(self) -> 'Any': + """Instance handle of the program or DLL to retrieve the string resource from. Ignored if idString is zero.""" + pass - @property - def MediaType(self)->'Any': - """win32con.DMMEDIA_*, can also be a printer-specific value greater then DMMEDIA_USER""" - pass + @property + def idString(self) -> 'Any': + """Specifies zero, or a resource ID in the program or DLL specified in hinst.""" + pass + @property + def clrForeground(self) -> 'Any': + """Specifies the RGB value to use for the foreground color of the pop-up window. To use the system color for the window text, specify -1.""" + pass - @property - def DitherType(self)->'Any': - """Dithering option, win32con.DMDITHER_*""" - pass + @property + def clrBackground(self) -> 'Any': + """Specifies the RGB value to use for the background color of the pop-up window. To use the system color for the window background, specify -1.""" + pass + @property + def text(self) -> 'str': + """Specifies the text to display if idString is zero.""" + pass - @property - def Reserved1(self)->'Any': - """Reserved, use only 0""" - pass + @property + def font(self) -> 'str': + """Specifies the font attributes to use for the text in the pop-up window. Use the following format to specify font family, point size, character set, and font format: facename[, point size[, charset[ BOLD ITALIC UNDERLINE]]] To omit an attribute, enter a comma. For example, to specify bold, 10-pt, MS Sans Serif font, font would be: MS Sans Serif, 10, , BOLD""" + pass + @property + def pt(self) -> 'Any': + """(x,y). Specifies (in pixels) where the top center of the pop-up window should be located.""" + pass - @property - def Reserved2(self)->'Any': - """Reserved, use only 0""" - pass + @property + def margins(self) -> 'Any': + """(left,top,right,bottom). Specifies (in pixels) the margins to use on the left, top, right, and bottom sides of the pop-up window. The default for all rectangle members is -1.""" + pass - @property - def Nup(self)->'Any': - """Controls printing of multiple logical pages per physical page, DMNUP_SYSTEM or DMNUP_ONEUP""" - pass +class PyHH_WINTYPE(object): + """A Python object, representing an HH_WINTYPE structure""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def uniCodeStrings(self) -> 'Any': + """Specifies whether the strings used in this structure are UNICODE.""" + pass + + @property + def validMembers(self) -> 'Any': + """Specifies which members in the structure are valid.""" + pass + + @property + def winProperties(self) -> 'Any': + """Specifies the properties of the window, such as whether it is the standard HTML Help Viewer or whether it includes a Search tab.""" + pass + + @property + def styles(self) -> 'Any': + """Specifies the styles used to create the window. These styles can be ignored, combined with extended styles, or used exclusively depending on the value of the validMembers and winProperties parameters.""" + pass + + @property + def exStyles(self) -> 'Any': + """Specifies the extended styles used to create the window. These styles can be ignored, combined with default styles, or used exclusively depending on the value of the validMembers and winProperties parameters.""" + pass + + @property + def showState(self) -> 'Any': + """Specifies the initial display state of the window. Valid values are the same as those for the Win32 API ShowWindow function.""" + pass + + @property + def hwndHelp(self) -> 'Any': + """Specifies the handle of the window if the window has been created.""" + pass + + @property + def hwndCaller(self) -> 'Any': + """Specifies the window that will receive HTML Help notification messages. Notification messages are sent via Windows WM_NOTIFY messages.""" + pass + + @property + def hwndToolBar(self) -> 'Any': + """Specifies the handle of the toolbar.""" + pass + + @property + def hwndNavigation(self) -> 'Any': + """Specifies the handle of the Navigation pane.""" + pass + + @property + def hwndHTML(self) -> 'Any': + """Specifies the handle of the Topic pane, which hosts Shdocvw.dll.""" + pass + + @property + def navWidth(self) -> 'Any': + """Specifies the width of the Navigation pane when the Help Viewer is expanded.""" + pass + + @property + def toolBarFlags(self) -> 'Any': + """Specifies which buttons to include on the toolbar.""" + pass + + @property + def notExpanded(self) -> 'Any': + """Specifies that the Help Viewer open with the Navigation pane closed.""" + pass + + @property + def curNavType(self) -> 'Any': + """Specifies the default tab to display on the Navigation pane.""" + pass + + @property + def idNotify(self) -> 'Any': + """Specifies a non-zero ID for enabling HTML Help notification messages. This ID is passed as the wParam value of Windows WM_NOTIFY messages.""" + pass + + @property + def typeName(self) -> 'str': + """A null-terminated string that specifies the name of the window type.""" + pass + + @property + def caption(self) -> 'str': + """A null-terminated string that specifies the caption to display in the title bar of the window.""" + pass + + @property + def windowPos(self) -> 'Any': + """(left,top,right,bottom). Specifies the coordinates of the window in pixels.""" + pass + + @property + def HTMLPos(self) -> 'Any': + """(left,top,right,bottom). Specifies the coordinates of the Topic pane.""" + pass + + @property + def toc(self) -> 'str': + """Specifies the contents (.hhc) file to display in the Navigation pane.""" + pass + + @property + def index(self) -> 'str': + """Specifies the index (.hhk) file to display in the Navigation pane.""" + pass + + @property + def file(self) -> 'str': + """Specifies the default HTML file to display in the Topic pane.""" + pass + + @property + def home(self) -> 'str': + """Specifies the file or URL to display in the Topic pane when the Home button is clicked.""" + pass + + @property + def jump1(self) -> 'str': + """Specifies the text to display underneath the Jump1 button.""" + pass + + @property + def jump2(self) -> 'str': + """Specifies the text to display underneath the Jump2 button.""" + pass + + @property + def urlJump1(self) -> 'str': + """Specifies the URL to jump to when the Jump1 button is clicked.""" + pass + + @property + def urlJump2(self) -> 'str': + """Specifies the URL to jump to when the Jump2 button is clicked.""" + pass - @property - def PanningWidth(self)->'Any': - """Not used, leave as 0""" - pass +class PyHINTERNET(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def PanningHeight(self)->'Any': - """Not used, leave as 0""" - pass +class PyHKEY(object): + """""" - @property - def DeviceName(self)->'str': - """String of at most 32 chars""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def FormName(self)->'Any': - """Name of form as returned by win32print::EnumForms, at most 32 chars""" - pass +class PyHTHEME(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def DriverData(self)->'Any': - """Driver data appended to end of structure""" - pass +class PyHWINSTA(object): + """Wrapper for a handle to a window station - returned by CreateWindowStation, OpenWindowStation, or GetProcessWindowStation""" -class PyDISPLAY_DEVICE(object): - """Python object wrapping a DISPLAY_DEVICE structure""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def EnumDesktops(self,) -> 'Tuple[Any, ...]': + """ + Lists names of desktops in the window station +Args: - @property - def Size(self)->'Any': - """Size of structure""" - pass - @property - def DeviceName(self)->'Any': - """String of at most 32 chars""" - pass +Returns: + Tuple[Any, ...] - @property - def DeviceString(self)->'Any': - """String of at most 128 chars""" - pass + """ + pass + def SetProcessWindowStation(self,) -> 'None': + """ + Associates the calling process with the window station - @property - def StateFlags(self)->'Any': - """Bitmask of win32con.DISPLAY_DEVICE_* constants indicating current device status""" - pass +Args: - @property - def DeviceID(self)->'Any': - """String of at most 128 chars""" - pass +Returns: - @property - def DeviceKey(self)->'Any': - """String of at most 128 chars""" - pass + None + """ + pass - def Clear(self,) -> 'None': - """ - Resets all members of the structure + def CloseWindowStation(self,) -> 'None': + """ + Closes the window station handle Args: @@ -4060,336 +5157,527 @@ Args: Returns: None - - """ - pass - - -class PyDLGITEMTEMPLATE(object): - """A tuple describing a control in a dialog box.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """ + pass -class PyDLGTEMPLATE(object): - """A tuple of items describing a dialog box, that can be used to create the dialog.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyICONINFO(object): + """Tuple describing an icon or cursor""" -class PyDS_HANDLE(object): - """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIID(object): + """""" -class PyDS_NAME_RESULT_ITEM(object): - """A tuple representing a DS_NAME_RESULT_ITEM""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyINPUT_RECORD(object): + """Interface to the INPUT_RECORD struct used with console IO functions. Create using -class PyDateTime(object): - """A Python object, representing an instant in time.""" +PyINPUT_RECORDType(EventType)""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def EventType(self) -> 'Any': + """One of KEY_EVENT, MOUSE_EVENT, WINDOW_BUFFER_SIZE_EVENT, MENU_EVENT, FOCUS_EVENT. Cannot be changed after object is created""" + pass + + @property + def KeyDown(self) -> 'Any': + """True for a key press, False for key release""" + pass + + @property + def RepeatCount(self) -> 'Any': + """Nbr of repeats generated (key was held down if >1)""" + pass + + @property + def VirtualKeyCode(self) -> 'Any': + """Device-independent key code, win32con.VK_*""" + pass + + @property + def VirtualScanCode(self) -> 'Any': + """Device-dependent scan code generated by keyboard""" + pass + + @property + def Char(self) -> 'str': + """Single unicode character generated by the keypress""" + pass + + @property + def ControlKeyState(self) -> 'Any': + """State of modifier keys, combination of CAPSLOCK_ON, ENHANCED_KEY, LEFT_ALT_PRESSED, LEFT_CTRL_PRESSED, NUMLOCK_ON, RIGHT_ALT_PRESSED, RIGHT_CTRL_PRESSED, SCROLLLOCK_ON, SHIFT_PRESSED""" + pass + + @property + def ButtonState(self) -> 'Any': + """Bitmask representing which mouse buttons were pressed.""" + pass + + @property + def EventFlags(self) -> 'Any': + """DOUBLE_CLICK, MOUSE_MOVED or MOUSE_WHEELED, or 0. If 0, indicates a mouse button press""" + pass + + @property + def MousePosition(self) -> 'PyCOORD': + """Position in character coordinates""" + pass + + @property + def Size(self) -> 'PyCOORD': + """New size of screen buffer in character rows/columns""" + pass + + @property + def SetFocus(self) -> 'Any': + """Reserved - Used only with type FOCUS_EVENT. This event is Reserved, and should be ignored.""" + pass + + @property + def CommandId(self) -> 'Any': + """Used only with event type MENU_EVENT, which is reserved and should not be used""" + pass - def Format(self,) -> 'Any': - """ - None +class PyLOCALGROUP_INFO_0(object): + """A dictionary holding the information in a Win32 LOCALGROUP_INFO_0 structure.""" -Args: + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def name(self) -> 'Union[str]': + """Name of the group""" + pass -Returns: +class PyLOCALGROUP_INFO_1(object): + """A dictionary holding the information in a Win32 LOCALGROUP_INFO_1 structure.""" - Any - - """ - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def name(self) -> 'Union[str]': + """Name of the group""" + pass -class PyDialogTemplate(object): - """""" + @property + def comment(self) -> 'Union[str]': + """The group's comment.""" + pass - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyLOCALGROUP_INFO_1002(object): + """A dictionary holding the information in a Win32 LOCALGROUP_INFO_1002 structure.""" -class PyEVTLOG_HANDLE(object): - """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + @property + def comment(self) -> 'Union[str]': + """""" + pass -class PyEVT_HANDLE(object): - """Handle to an event log, session, query, or any other object used with +class PyLOCALGROUP_MEMBERS_INFO_0(object): + """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_0 -the Evt* event log functions on Vista and later. +structure.""" -When the object is destroyed, EvtClose is called.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + @property + def sid(self) -> 'PySID': + """""" + pass -class PyEVT_RPC_LOGIN(object): - """Tuple containing login credentials for a remote Event Log connection""" +class PyLOCALGROUP_MEMBERS_INFO_1(object): + """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_1 - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') -class PyEventLogRecord(object): - """An object containing the data in an EVENTLOGRECORD.""" + @property + def sid(self) -> 'PySID': + """""" + pass - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + @property + def sidusage(self) -> 'Any': + """""" + pass + @property + def name(self) -> 'Union[str]': + """""" + pass - @property - def Reserved(self)->'int': - """""" - pass +class PyLOCALGROUP_MEMBERS_INFO_2(object): + """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_2 - @property - def RecordNumber(self)->'int': - """""" - pass +structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def TimeGenerated(self)->'PyTime': - """""" - pass + @property + def sid(self) -> 'PySID': + """""" + pass + @property + def sidusage(self) -> 'Any': + """""" + pass - @property - def TimeWritten(self)->'PyTime': - """""" - pass + @property + def domainandname(self) -> 'Union[str]': + """string containing the name of the member prefixed by the domain name and the "\\" separator character""" + pass - @property - def EventID(self)->'int': - """""" - pass +class PyLOCALGROUP_MEMBERS_INFO_3(object): + """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_3 +structure.""" - @property - def EventType(self)->'int': - """""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def domainandname(self) -> 'Union[str]': + """string containing the name of the member prefixed by the domain name and the "\\" separator character""" + pass - @property - def EventCategory(self)->'int': - """""" - pass +class PyLOGBRUSH(object): + """""" - @property - def ReservedFlags(self)->'int': - """""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def Style(self) -> 'Any': + """Brush style, one of win32con.BS_* values""" + pass - @property - def ClosingRecordNumber(self)->'int': - """""" - pass + @property + def Color(self) -> 'Any': + """RGB color value. Can also be DIB_PAL_COLORS or DIB_RGB_COLORS if Style is BS_DIBPATTERN or BS_DIBPATTERNPT=""" + pass + @property + def Hatch(self) -> 'Union[Any, int]': + """For BS_HATCH style, one of win32con.HS_*. Not used For BS_SOLID or BS_HOLLOW. For a pattern brush, this should be a handle to a bitmap""" + pass - @property - def SourceName(self)->'str': - """""" - pass +class PyLOGFONT(object): + """A Python object, representing an PyLOGFONT structure""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def lfHeight(self) -> 'int': + """""" + pass + + @property + def lfWidth(self) -> 'int': + """""" + pass + + @property + def lfEscapement(self) -> 'int': + """""" + pass + + @property + def lfOrientation(self) -> 'int': + """""" + pass + + @property + def lfWeight(self) -> 'int': + """""" + pass + + @property + def lfItalic(self) -> 'int': + """""" + pass + + @property + def lfUnderline(self) -> 'int': + """""" + pass + + @property + def lfStrikeOut(self) -> 'int': + """""" + pass + + @property + def lfCharSet(self) -> 'int': + """""" + pass + + @property + def lfOutPrecision(self) -> 'int': + """""" + pass + + @property + def lfClipPrecision(self) -> 'int': + """""" + pass + + @property + def lfQuality(self) -> 'int': + """""" + pass + + @property + def lfPitchAndFamily(self) -> 'int': + """""" + pass + + @property + def lfFaceName(self) -> 'str': + """Name of the typeface, at most 31 characters""" + pass - @property - def StringInserts(self)->'Tuple[str, ...]': - """""" - pass +class PyLSA_HANDLE(object): + """""" - @property - def Sid(self)->'PySID': - """""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def Data(self)->'str': - """""" - pass +class PyLUID_AND_ATTRIBUTES(object): + """A sequence containing (LUID,Attributes) representing an LUID_AND_ATTRIBUTES structure""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def ComputerName(self)->'str': - """""" - pass +class PyLsaLogon_HANDLE(object): + """""" -class PyGROUP_INFO_0(object): - """A dictionary holding the information in a Win32 GROUP_INFO_0 structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyMSG(object): + """A tuple representing a win32 MSG structure.""" - @property - def name(self)->'Union[str]': - """Name of the group""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') -class PyGROUP_INFO_1(object): - """A dictionary holding the information in a Win32 GROUP_INFO_1 structure.""" +class PyNETRESOURCE(object): + """A Python object that encapsulates a Win32 NETRESOURCE structure.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def dwScope(self) -> 'int': + """""" + pass - @property - def name(self)->'Union[str]': - """Name of the group""" - pass + @property + def dwType(self) -> 'int': + """""" + pass + @property + def dwDisplayType(self) -> 'int': + """""" + pass - @property - def comment(self)->'Union[str]': - """The group's comment.""" - pass + @property + def dwUsage(self) -> 'int': + """""" + pass + @property + def localName(self) -> 'str': + """""" + pass -class PyGROUP_INFO_1002(object): - """A dictionary holding the information in a Win32 GROUP_INFO_1002 structure.""" + @property + def remoteName(self) -> 'str': + """""" + pass - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + @property + def comment(self) -> 'str': + """""" + pass + @property + def provider(self) -> 'str': + """""" + pass - @property - def comment(self)->'Union[str]': - """""" - pass +class PyNET_VALIDATE_AUTHENTICATION_INPUT_ARG(object): + """""" -class PyGROUP_INFO_1005(object): - """A dictionary holding the information in a Win32 GROUP_INFO_1005 structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyNET_VALIDATE_PASSWORD_CHANGE_INPUT_ARG(object): + """""" - @property - def attributes(self)->'Any': - """""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') -class PyGROUP_INFO_2(object): - """A dictionary holding the information in a Win32 GROUP_INFO_2 structure.""" +class PyNET_VALIDATE_PERSISTED_FIELDS(object): + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def name(self)->'Union[str]': - """Name of the group""" - pass +class PyNMHDR(object): + """A Python object, representing an NMHDR +structure""" - @property - def comment(self)->'Union[str]': - """The group's comment.""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def hwndFrom(self) -> 'Any': + """Window handle to the control sending a message. ??? 64-bit problem here ???""" + pass - @property - def group_id(self)->'Any': - """""" - pass + @property + def idFrom(self) -> 'Any': + """Identifier of the control sending a message.""" + pass + @property + def code(self) -> 'Any': + """Notification code. This member can be a control-specific notification code or it can be one of the common notification codes.""" + pass - @property - def attributes(self)->'Any': - """""" - pass +class PyNOTIFYICONDATA(object): + """""" -class PyGROUP_USERS_INFO_0(object): - """A dictionary holding the information in a Win32 GROUP_USERS_INFO_0 structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyOVERLAPPED(object): + """A Python object, representing an overlapped structure""" - @property - def name(self)->'Union[str]': - """Name of the group or user""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def Offset(self) -> 'int': + """Specifies a file position at which to start the transfer. The file position is a byte offset from the start of the file. The calling process sets this member before calling the ReadFile or WriteFile function. This member is ignored when reading from or writing to named pipes and communications devices.""" + pass -class PyGROUP_USERS_INFO_1(object): - """A dictionary holding the information in a Win32 GROUP_USERS_INFO_1 structure.""" + @property + def OffsetHigh(self) -> 'int': + """Specifies the high word of the byte offset at which to start the transfer.""" + pass - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + @property + def object(self) -> 'Any': + """Any python object that you want to attach to your overlapped I/O request.""" + pass + @property + def dword(self) -> 'Any': + """An integer buffer that may be used by overlapped functions (eg, win32file::WaitCommEvent)""" + pass - @property - def name(self)->'Union[str]': - """Name of the group or user""" - pass + @property + def hEvent(self) -> 'int': + """Identifies an event set to the signaled state when the transfer has been completed. The calling process sets this member before calling the win32file::ReadFile, win32file::WriteFile, win32pipe::ConnectNamedPipe, or win32pipe::TransactNamedPipe function.""" + pass + @property + def Internal(self) -> 'int': + """Reserved for operating system use. (pointer-sized value)""" + pass - @property - def attributes(self)->'Any': - """""" - pass + @property + def InternalHigh(self) -> 'int': + """Reserved for operating system use. (pointer-sized value)""" + pass -class PyGdiHANDLE(object): - """""" +class PyOVERLAPPEDReadBuffer(object): + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') -class PyGetSignerCertificate(object): - """""" +class PyPERF_COUNTER_DEFINITION(object): + """An object encapsulating a Windows NT Performance Monitor counter definition - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +(PERF_COUNTER_DEFINITION).""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') -class PyHANDLE(object): - """A Python object, representing a win32 HANDLE.""" + @property + def DefaultScale(self) -> 'int': + """The default scale of the counter.""" + pass - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + @property + def DetailLevel(self) -> 'int': + """The detail level of the counter.""" + pass + @property + def CounterType(self) -> 'int': + """The counter type.""" + pass - @property - def handle(self)->'Any': - """Integer value of the handleMethodsCloseCloses the handle closeSynonym for PyHANDLE::Close DetachDetaches the Win32 handle from the handle object. __nonzero__Used for detecting true/false. is nb_bool in Python 3.0 __int__Used when an integer representation of the handle object is required. __print__Used when the object is printed. tp_print __hash__Used when the hash value of an object is required tp_hash __str__Used when a string representation is required tp_str """ - pass + @property + def CounterNameTitleIndex(self) -> 'int': + """""" + pass + @property + def CounterHelpTitleIndex(self) -> 'int': + """Sentinel""" + pass - def Close(self,) -> 'None': - """ - Closes the underlying Win32 handle. + def Increment(self,) -> 'None': + """ + Increments the value of the performance counter Args: @@ -4398,14 +5686,13 @@ Args: Returns: None - - """ - pass + """ + pass - def close(self,) -> 'None': - """ - Closes the underlying Win32 handle. + def Decrement(self,) -> 'None': + """ + Decrements the value of the performance counter Args: @@ -4414,14 +5701,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Detach(self,) -> 'Any': - """ - Detaches the Win32 handle from the handle object. + def Set(self,) -> 'None': + """ + Sets the counter to a specific value Args: @@ -4429,37 +5715,51 @@ Args: Returns: - Any:PyHANDLE.Detach + None -int = Detach()Detaches the Win32 handle from the handle object. -Comments + """ + pass -After calling this function, the handle is effectively invalidated, + def Get(self,) -> 'None': + """ + Gets the current value of the counter -but the handle is not closed. You would call this function when you +Args: -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 -handle is already detached, this will return zero. +Returns: - - """ - pass + None + """ + pass -class PyHDESK(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyPERF_OBJECT_TYPE(object): + """A Python object, representing a PERF_OBJECT_TYPE structure""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def SetThreadDesktop(self,) -> 'None': - """ - Assigns this desktop to the calling thread + @property + def ObjectNameTitleIndex(self) -> 'int': + """""" + pass + + @property + def ObjectHelpTitleIndex(self) -> 'int': + """""" + pass + + @property + def DefaultCounterIndex(self) -> 'int': + """""" + pass + + def Close(self,) -> 'None': + """ + Closes the object. Args: @@ -4468,46 +5768,69 @@ Args: Returns: None - - """ - pass + """ + pass - def EnumDesktopWindows(self,) -> 'Tuple[int, ...]': - """ - Returns a list of handles to all top-level windows on desktop -Args: +class PyPOINT(object): + """Tuple of two ints (x,y) representing a POINT struct""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') -Returns: +class PyPROFILEINFO(object): + """""" - Tuple[int, ...] - - """ - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def UserName(self) -> 'str': + """Name of user for which to load profile""" + pass - def SwitchDesktop(self,) -> 'None': - """ - Activates the desktop + @property + def Flags(self) -> 'Any': + """Combination of PI_* flags""" + pass -Args: + @property + def ProfilePath(self) -> 'str': + """Path to roaming profile, can be None. Use win32net::NetUserGetInfo to retrieve user's profile path""" + pass + @property + def DefaultPath(self) -> 'str': + """Path to Default user profile, can be None""" + pass + @property + def ServerName(self) -> 'str': + """Domain controller, can be None""" + pass -Returns: + @property + def PolicyPath(self) -> 'str': + """Location of policy file, can be None""" + pass - None - - """ - pass + @property + def Profile(self) -> 'PyHKEY': + """Handle to root of user's registry key. This member is output.""" + pass - def CloseDesktop(self,) -> 'None': - """ - Closes the desktop handle +class PyPerfMonManager(object): + """A Python object""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + def Close(self,) -> 'None': + """ + Closes the performance monitor manager. Args: @@ -4516,5608 +5839,3291 @@ Args: Returns: None - - """ - pass + """ + pass -class PyHDEVNOTIFY(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyPrinterHANDLE(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') -class PyHHNTRACK(object): - """A Python object, representing an HHNTRACK -structure""" +class PyRECT(object): + """Tuple of 4 ints defining a rectangle: (left, top, right, bottom)""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def action(self)->'Any': - """Specifies the action the user is about to take. This is an HHACT_ constant.""" - pass +class PyResourceId(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def hdr(self)->'Any': - """Standard WM_NOTIFY header(win32help::NMHDR).""" - pass +class PySCROLLINFO(object): + """A tuple representing a SCROLLINFO structure""" - @property - def curUrl(self)->'str': - """A multi-byte, zero-terminated string that specifies the topic navigated to, or the name of the help window being created.""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def winType(self)->'Any': - """A pointer to the current HH_WINTYPE structure (win32help::HH_WINTYPE).""" - pass +class PySC_HANDLE(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') -class PyHHN_NOTIFY(object): - """A Python object, representing an HHN_NOTIFY -structure""" +class PySECURITY_ATTRIBUTES(object): + """A Python object, representing a SECURITY_ATTRIBUTES structure""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def bInheritHandle(self) -> 'Any': + """Specifies whether the returned handle is inherited when a new process is created. If this member is TRUE, the new process inherits the handle.""" + pass - @property - def hdr(self)->'Any': - """Standard WM_NOTIFY header.(win32help::NMHDR)""" - pass + @property + def SECURITY_DESCRIPTOR(self) -> 'PySECURITY_DESCRIPTOR': + """A PySECURITY_DESCRIPTOR, or None""" + pass - @property - def url(self)->'str': - """A multi-byte, zero-terminated string that specifies the topic navigated to, or the name of the help window being created.""" - pass +class PySECURITY_DESCRIPTOR(object): + """A Python object, representing a SECURITY_DESCRIPTOR structure""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') -class PyHH_AKLINK(object): - """A Python object, representing an HH_AKLINK structure""" + def Initialize(self,) -> 'None': + """ + Initialize the SD. - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +Args: - @property - def indexOnFail(self)->'Any': - """Specifies whether to display the keyword in the Index tab of the HTML Help Viewer if the lookup fails. The value of window specifies the Help Viewer.""" - pass +Returns: - @property - def keywords(self)->'str': - """Specifies one or more ALink names or KLink keywords to look up. Multiple entries are delimited by a semicolon.""" - pass + None + """ + pass - @property - def url(self)->'str': - """Specifies the topic file to navigate to if the lookup fails. url refers to a valid topic within the specified compiled help (.chm) file and does not support Internet protocols that point to an HTML file.""" - pass + def GetSecurityDescriptorOwner(self,) -> 'PySID': + """ + Return the owner of the security descriptor. +Args: - @property - def msgText(self)->'str': - """Specifies the text to display in a message box if the lookup fails and indexOnFail is FALSE and url is NULL.""" - pass - @property - def msgTitle(self)->'str': - """Specifies the caption of the message box in which the msgText parameter appears.""" - pass +Returns: + PySID - @property - def window(self)->'str': - """Specifies the name of the window type in which to display one of the following: The selected topic, if the lookup yields one or more matching topics. The topic specified in url, if the lookup fails and a topic is specified in url. The Index tab, if the lookup fails and indexOnFail is specified as TRUE.""" - pass + """ + pass + def GetSecurityDescriptorDacl(self,) -> 'PyACL': + """ + Return the discretionary ACL of the security -class PyHH_FTS_QUERY(object): - """A Python object, representing an HH_FTS_QUERY +descriptor. -structure""" +Args: - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - @property - def uniCodeStrings(self)->'Any': - """TRUE if all strings are Unicode.""" - pass +Returns: + PyACL - @property - def proximity(self)->'Any': - """Word proximity.""" - pass + """ + pass + def GetSecurityDescriptorSacl(self,) -> 'PyACL': + """ + Return system access control list (SACL) of SD - @property - def stemmedSearch(self)->'Any': - """TRUE for StemmedSearch only.""" - pass +Args: - @property - def titleOnly(self)->'Any': - """TRUE for Title search only.""" - pass +Returns: - @property - def execute(self)->'Any': - """TRUE to initiate the search.""" - pass + PyACL + """ + pass - @property - def searchQuery(self)->'str': - """String containing the search query.""" - pass + def GetSecurityDescriptorControl(self,) -> 'Tuple[Any, Any]': + """ + Returns tuple of Control bit flags and +revision of SD. -class PyHH_POPUP(object): - """A Python object, representing an HH_POPUP structure""" +Args: - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - @property - def hinst(self)->'Any': - """Instance handle of the program or DLL to retrieve the string resource from. Ignored if idString is zero.""" - pass +Returns: + Tuple[Any, Any] - @property - def idString(self)->'Any': - """Specifies zero, or a resource ID in the program or DLL specified in hinst.""" - pass + """ + pass + def SetSecurityDescriptorOwner(self, sid: 'PySID', bOwnerDefaulted: 'Any') -> 'None': + """ + Set owner SID. - @property - def clrForeground(self)->'Any': - """Specifies the RGB value to use for the foreground color of the pop-up window. To use the system color for the window text, specify -1.""" - pass +Args: + sid(PySID):The sid to be set as owner in the security descriptor. + bOwnerDefaulted(Any):Normally set to false since this explicitely set the owner. - @property - def clrBackground(self)->'Any': - """Specifies the RGB value to use for the background color of the pop-up window. To use the system color for the window background, specify -1.""" - pass +Returns: + None - @property - def text(self)->'str': - """Specifies the text to display if idString is zero.""" - pass + """ + pass + def SetSecurityDescriptorGroup(self, sid: 'PySID', bOwnerDefaulted: 'Any') -> 'Any': + """ + Set group SID. - @property - def font(self)->'str': - """Specifies the font attributes to use for the text in the pop-up window. Use the following format to specify font family, point size, character set, and font format: facename[, point size[, charset[ BOLD ITALIC UNDERLINE]]] To omit an attribute, enter a comma. For example, to specify bold, 10-pt, MS Sans Serif font, font would be: MS Sans Serif, 10, , BOLD""" - pass +Args: + sid(PySID):The group sid to be set in the security descriptor. + bOwnerDefaulted(Any):Normally set to false since this explicitely set the owner. - @property - def pt(self)->'Any': - """(x,y). Specifies (in pixels) where the top center of the pop-up window should be located.""" - pass +Returns: + Any - @property - def margins(self)->'Any': - """(left,top,right,bottom). Specifies (in pixels) the margins to use on the left, top, right, and bottom sides of the pop-up window. The default for all rectangle members is -1.""" - pass + """ + pass + def SetSecurityDescriptorSacl(self, bSaclPresent: 'Any', SACL: 'PyACL', bSaclDefaulted: 'Any') -> 'None': + """ + Replaces system access control list (SACL) in the security -class PyHH_WINTYPE(object): - """A Python object, representing an HH_WINTYPE structure""" +descriptor. - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +Args: + bSaclPresent(Any):A flag indicating if SACL is to be used. If false, last 2 parms are ignored. + SACL(PyACL):The SACL to set in the security descriptor + bSaclDefaulted(Any):Flag, set to false if user has specifically set the SACL. - @property - def uniCodeStrings(self)->'Any': - """Specifies whether the strings used in this structure are UNICODE.""" - pass +Returns: + None - @property - def validMembers(self)->'Any': - """Specifies which members in the structure are valid.""" - pass + """ + pass + def IsValid(self,) -> 'None': + """ + Determines if the security descriptor is valid. - @property - def winProperties(self)->'Any': - """Specifies the properties of the window, such as whether it is the standard HTML Help Viewer or whether it includes a Search tab.""" - pass +Args: - @property - def styles(self)->'Any': - """Specifies the styles used to create the window. These styles can be ignored, combined with extended styles, or used exclusively depending on the value of the validMembers and winProperties parameters.""" - pass +Returns: - @property - def exStyles(self)->'Any': - """Specifies the extended styles used to create the window. These styles can be ignored, combined with default styles, or used exclusively depending on the value of the validMembers and winProperties parameters.""" - pass + None + """ + pass - @property - def showState(self)->'Any': - """Specifies the initial display state of the window. Valid values are the same as those for the Win32 API ShowWindow function.""" - pass + def GetLength(self,) -> 'None': + """ + return length of security descriptor (GetSecurityDescriptorLenght). +Args: - @property - def hwndHelp(self)->'Any': - """Specifies the handle of the window if the window has been created.""" - pass - @property - def hwndCaller(self)->'Any': - """Specifies the window that will receive HTML Help notification messages. Notification messages are sent via Windows WM_NOTIFY messages.""" - pass +Returns: + None - @property - def hwndToolBar(self)->'Any': - """Specifies the handle of the toolbar.""" - pass + """ + pass + def IsSelfRelative(self,) -> 'None': + """ + Returns 1 if security descriptor is self relative, 0 if absolute - @property - def hwndNavigation(self)->'Any': - """Specifies the handle of the Navigation pane.""" - pass +Args: - @property - def hwndHTML(self)->'Any': - """Specifies the handle of the Topic pane, which hosts Shdocvw.dll.""" - pass +Returns: - @property - def navWidth(self)->'Any': - """Specifies the width of the Navigation pane when the Help Viewer is expanded.""" - pass + None + """ + pass - @property - def toolBarFlags(self)->'Any': - """Specifies which buttons to include on the toolbar.""" - pass + def SetSecurityDescriptorControl(self, ControlBitsOfInterest: 'Any', ControlBitsToSet: 'Any') -> 'None': + """ + Sets the control bit flags related to inheritance for a +security descriptor - @property - def notExpanded(self)->'Any': - """Specifies that the Help Viewer open with the Navigation pane closed.""" - pass +Args: + ControlBitsOfInterest(Any):Bitmask of flags to be modified + ControlBitsToSet(Any):Bitmask containing flag values to setCommentsOnly exists on Windows 2000 or later - @property - def curNavType(self)->'Any': - """Specifies the default tab to display on the Navigation pane.""" - pass +Returns: + None - @property - def idNotify(self)->'Any': - """Specifies a non-zero ID for enabling HTML Help notification messages. This ID is passed as the wParam value of Windows WM_NOTIFY messages.""" - pass + """ + pass - @property - def typeName(self)->'str': - """A null-terminated string that specifies the name of the window type.""" - pass +class PySERVER_INFO_100(object): + """A dictionary holding the information in a Win32 SERVER_INFO_100 structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def caption(self)->'str': - """A null-terminated string that specifies the caption to display in the title bar of the window.""" - pass + @property + def platform_id(self) -> 'Any': + """""" + pass + @property + def name(self) -> 'Union[str]': + """""" + pass - @property - def windowPos(self)->'Any': - """(left,top,right,bottom). Specifies the coordinates of the window in pixels.""" - pass +class PySERVER_INFO_101(object): + """A dictionary holding the information in a Win32 SERVER_INFO_101 structure.""" - @property - def HTMLPos(self)->'Any': - """(left,top,right,bottom). Specifies the coordinates of the Topic pane.""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def platform_id(self) -> 'Any': + """""" + pass - @property - def toc(self)->'str': - """Specifies the contents (.hhc) file to display in the Navigation pane.""" - pass + @property + def name(self) -> 'Union[str]': + """""" + pass + @property + def version_major(self) -> 'Any': + """""" + pass - @property - def index(self)->'str': - """Specifies the index (.hhk) file to display in the Navigation pane.""" - pass + @property + def version_minor(self) -> 'Any': + """""" + pass + @property + def type(self) -> 'Any': + """one of the SV_TYPE_* constants""" + pass - @property - def file(self)->'str': - """Specifies the default HTML file to display in the Topic pane.""" - pass + @property + def comment(self) -> 'Union[str]': + """""" + pass - @property - def home(self)->'str': - """Specifies the file or URL to display in the Topic pane when the Home button is clicked.""" - pass +class PySERVER_INFO_102(object): + """A dictionary holding the information in a Win32 SERVER_INFO_102 structure.""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def platform_id(self) -> 'Any': + """""" + pass + + @property + def name(self) -> 'Union[str]': + """""" + pass + + @property + def version_major(self) -> 'Any': + """""" + pass + + @property + def version_minor(self) -> 'Any': + """""" + pass + + @property + def type(self) -> 'Any': + """one of the SV_TYPE_* constants""" + pass + + @property + def comment(self) -> 'Union[str]': + """""" + pass + + @property + def users(self) -> 'Any': + """""" + pass + + @property + def disc(self) -> 'Any': + """""" + pass + + @property + def hidden(self) -> 'Any': + """""" + pass + + @property + def announce(self) -> 'Any': + """""" + pass + + @property + def anndelta(self) -> 'Any': + """""" + pass + + @property + def userpath(self) -> 'Union[str]': + """""" + pass - @property - def jump1(self)->'str': - """Specifies the text to display underneath the Jump1 button.""" - pass +class PySERVER_INFO_402(object): + """A dictionary holding the information in a Win32 SERVER_INFO_402 structure.""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def ulist_mtime(self) -> 'Any': + """""" + pass + + @property + def glist_mtime(self) -> 'Any': + """""" + pass + + @property + def alist_mtime(self) -> 'Any': + """""" + pass + + @property + def security(self) -> 'Any': + """""" + pass + + @property + def numadmin(self) -> 'Any': + """""" + pass + + @property + def lanmask(self) -> 'Any': + """""" + pass + + @property + def guestacct(self) -> 'Union[str]': + """""" + pass + + @property + def chdevs(self) -> 'Any': + """""" + pass + + @property + def chdevq(self) -> 'Any': + """""" + pass + + @property + def chdevjobs(self) -> 'Any': + """""" + pass + + @property + def connections(self) -> 'Any': + """""" + pass + + @property + def shares(self) -> 'Any': + """""" + pass + + @property + def openfiles(self) -> 'Any': + """""" + pass + + @property + def sessopens(self) -> 'Any': + """""" + pass + + @property + def sessvcs(self) -> 'Any': + """""" + pass + + @property + def sessreqs(self) -> 'Any': + """""" + pass + + @property + def opensearch(self) -> 'Any': + """""" + pass + + @property + def activelocks(self) -> 'Any': + """""" + pass + + @property + def numreqbuf(self) -> 'Any': + """""" + pass + + @property + def sizreqbuf(self) -> 'Any': + """""" + pass + + @property + def numbigbuf(self) -> 'Any': + """""" + pass + + @property + def numfiletasks(self) -> 'Any': + """""" + pass + + @property + def alertsched(self) -> 'Any': + """""" + pass + + @property + def erroralert(self) -> 'Any': + """""" + pass + + @property + def logonalert(self) -> 'Any': + """""" + pass + + @property + def accessalert(self) -> 'Any': + """""" + pass + + @property + def diskalert(self) -> 'Any': + """""" + pass + + @property + def netioalert(self) -> 'Any': + """""" + pass + + @property + def maxauditsz(self) -> 'Any': + """""" + pass + + @property + def srvheuristics(self) -> 'Union[str]': + """""" + pass - @property - def jump2(self)->'str': - """Specifies the text to display underneath the Jump2 button.""" - pass +class PySERVER_INFO_403(object): + """A dictionary holding the information in a Win32 SERVER_INFO_403 structure.""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def ulist_mtime(self) -> 'Any': + """""" + pass + + @property + def glist_mtime(self) -> 'Any': + """""" + pass + + @property + def alist_mtime(self) -> 'Any': + """""" + pass + + @property + def security(self) -> 'Any': + """""" + pass + + @property + def numadmin(self) -> 'Any': + """""" + pass + + @property + def lanmask(self) -> 'Any': + """""" + pass + + @property + def guestacct(self) -> 'Union[str]': + """""" + pass + + @property + def chdevs(self) -> 'Any': + """""" + pass + + @property + def chdevq(self) -> 'Any': + """""" + pass + + @property + def chdevjobs(self) -> 'Any': + """""" + pass + + @property + def connections(self) -> 'Any': + """""" + pass + + @property + def shares(self) -> 'Any': + """""" + pass + + @property + def openfiles(self) -> 'Any': + """""" + pass + + @property + def sessopens(self) -> 'Any': + """""" + pass + + @property + def sessvcs(self) -> 'Any': + """""" + pass + + @property + def sessreqs(self) -> 'Any': + """""" + pass + + @property + def opensearch(self) -> 'Any': + """""" + pass + + @property + def activelocks(self) -> 'Any': + """""" + pass + + @property + def numreqbuf(self) -> 'Any': + """""" + pass + + @property + def sizreqbuf(self) -> 'Any': + """""" + pass + + @property + def numbigbuf(self) -> 'Any': + """""" + pass + + @property + def numfiletasks(self) -> 'Any': + """""" + pass + + @property + def alertsched(self) -> 'Any': + """""" + pass + + @property + def erroralert(self) -> 'Any': + """""" + pass + + @property + def logonalert(self) -> 'Any': + """""" + pass + + @property + def accessalert(self) -> 'Any': + """""" + pass + + @property + def diskalert(self) -> 'Any': + """""" + pass + + @property + def netioalert(self) -> 'Any': + """""" + pass + + @property + def maxauditsz(self) -> 'Any': + """""" + pass + + @property + def srvheuristics(self) -> 'Union[str]': + """""" + pass + + @property + def auditedevents(self) -> 'Any': + """""" + pass + + @property + def autoprofile(self) -> 'Any': + """""" + pass + + @property + def autopath(self) -> 'Union[str]': + """""" + pass - @property - def urlJump1(self)->'str': - """Specifies the URL to jump to when the Jump1 button is clicked.""" - pass +class PySERVER_INFO_502(object): + """A dictionary holding the information in a Win32 SERVER_INFO_502 structure.""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def sessopens(self) -> 'Any': + """""" + pass + + @property + def sessvcs(self) -> 'Any': + """""" + pass + + @property + def opensearch(self) -> 'Any': + """""" + pass + + @property + def sizreqbuf(self) -> 'Any': + """""" + pass + + @property + def initworkitems(self) -> 'Any': + """""" + pass + + @property + def maxworkitems(self) -> 'Any': + """""" + pass + + @property + def rawworkitems(self) -> 'Any': + """""" + pass + + @property + def irpstacksize(self) -> 'Any': + """""" + pass + + @property + def maxrawbuflen(self) -> 'Any': + """""" + pass + + @property + def sessusers(self) -> 'Any': + """""" + pass + + @property + def sessconns(self) -> 'Any': + """""" + pass + + @property + def maxpagedmemoryusage(self) -> 'Any': + """""" + pass + + @property + def maxnonpagedmemoryusage(self) -> 'Any': + """""" + pass + + @property + def enableforcedlogoff(self) -> 'Any': + """""" + pass + + @property + def timesource(self) -> 'Any': + """""" + pass + + @property + def acceptdownlevelapis(self) -> 'Any': + """""" + pass + + @property + def lmannounce(self) -> 'Any': + """""" + pass - @property - def urlJump2(self)->'str': - """Specifies the URL to jump to when the Jump2 button is clicked.""" - pass +class PySERVER_INFO_503(object): + """A dictionary holding the information in a Win32 SERVER_INFO_503 structure.""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def sessopens(self) -> 'Any': + """""" + pass + + @property + def sessvcs(self) -> 'Any': + """""" + pass + + @property + def opensearch(self) -> 'Any': + """""" + pass + + @property + def sizreqbuf(self) -> 'Any': + """""" + pass + + @property + def initworkitems(self) -> 'Any': + """""" + pass + + @property + def maxworkitems(self) -> 'Any': + """""" + pass + + @property + def rawworkitems(self) -> 'Any': + """""" + pass + + @property + def irpstacksize(self) -> 'Any': + """""" + pass + + @property + def maxrawbuflen(self) -> 'Any': + """""" + pass + + @property + def sessusers(self) -> 'Any': + """""" + pass + + @property + def sessconns(self) -> 'Any': + """""" + pass + + @property + def maxpagedmemoryusage(self) -> 'Any': + """""" + pass + + @property + def maxnonpagedmemoryusage(self) -> 'Any': + """""" + pass + + @property + def enableforcedlogoff(self) -> 'Any': + """""" + pass + + @property + def timesource(self) -> 'Any': + """""" + pass + + @property + def acceptdownlevelapis(self) -> 'Any': + """""" + pass + + @property + def lmannounce(self) -> 'Any': + """""" + pass + + @property + def domain(self) -> 'Union[str]': + """""" + pass + + @property + def maxkeepsearch(self) -> 'Any': + """""" + pass + + @property + def scavtimeout(self) -> 'Any': + """""" + pass + + @property + def minrcvqueue(self) -> 'Any': + """""" + pass + + @property + def minfreeworkitems(self) -> 'Any': + """""" + pass + + @property + def xactmemsize(self) -> 'Any': + """""" + pass + + @property + def threadpriority(self) -> 'Any': + """""" + pass + + @property + def maxmpxct(self) -> 'Any': + """""" + pass + + @property + def oplockbreakwait(self) -> 'Any': + """""" + pass + + @property + def oplockbreakresponsewait(self) -> 'Any': + """""" + pass + + @property + def enableoplocks(self) -> 'Any': + """""" + pass + + @property + def enablefcbopens(self) -> 'Any': + """""" + pass + + @property + def enableraw(self) -> 'Any': + """""" + pass + + @property + def enablesharednetdrives(self) -> 'Any': + """""" + pass + + @property + def minfreeconnections(self) -> 'Any': + """""" + pass + + @property + def maxfreeconnections(self) -> 'Any': + """""" + pass -class PyHINTERNET(object): - """""" +class PySHARE_INFO_0(object): + """A dictionary holding the infomation in a Win32 SHARE_INFO_0 structure.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def netname(self) -> 'Union[str]': + """""" + pass -class PyHKEY(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PySHARE_INFO_1(object): + """A dictionary holding the infomation in a Win32 SHARE_INFO_1 structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') -class PyHTHEME(object): - """""" + @property + def netname(self) -> 'Union[str]': + """""" + pass - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + @property + def type(self) -> 'Any': + """""" + pass + @property + def remark(self) -> 'Union[str]': + """""" + pass -class PyHWINSTA(object): - """Wrapper for a handle to a window station - returned by CreateWindowStation, OpenWindowStation, or GetProcessWindowStation""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def EnumDesktops(self,) -> 'Tuple[Any, ...]': - """ - Lists names of desktops in the window station - -Args: - - - -Returns: - - Tuple[Any, ...] - - """ - pass - - - def SetProcessWindowStation(self,) -> 'None': - """ - Associates the calling process with the window station - -Args: - - - -Returns: - - None - - """ - pass - - - def CloseWindowStation(self,) -> 'None': - """ - Closes the window station handle - -Args: - - - -Returns: - - None - - """ - pass - - -class PyICONINFO(object): - """Tuple describing an icon or cursor""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIID(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyINPUT_RECORD(object): - """Interface to the INPUT_RECORD struct used with console IO functions. Create using - -PyINPUT_RECORDType(EventType)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def EventType(self)->'Any': - """One of KEY_EVENT, MOUSE_EVENT, WINDOW_BUFFER_SIZE_EVENT, MENU_EVENT, FOCUS_EVENT. Cannot be changed after object is created""" - pass - - - @property - def KeyDown(self)->'Any': - """True for a key press, False for key release""" - pass - - - @property - def RepeatCount(self)->'Any': - """Nbr of repeats generated (key was held down if >1)""" - pass - - - @property - def VirtualKeyCode(self)->'Any': - """Device-independent key code, win32con.VK_*""" - pass - - - @property - def VirtualScanCode(self)->'Any': - """Device-dependent scan code generated by keyboard""" - pass - - - @property - def Char(self)->'str': - """Single unicode character generated by the keypress""" - pass - - - @property - def ControlKeyState(self)->'Any': - """State of modifier keys, combination of CAPSLOCK_ON, ENHANCED_KEY, LEFT_ALT_PRESSED, LEFT_CTRL_PRESSED, NUMLOCK_ON, RIGHT_ALT_PRESSED, RIGHT_CTRL_PRESSED, SCROLLLOCK_ON, SHIFT_PRESSED""" - pass - - - @property - def ButtonState(self)->'Any': - """Bitmask representing which mouse buttons were pressed.""" - pass - - - @property - def EventFlags(self)->'Any': - """DOUBLE_CLICK, MOUSE_MOVED or MOUSE_WHEELED, or 0. If 0, indicates a mouse button press""" - pass - - - @property - def MousePosition(self)->'PyCOORD': - """Position in character coordinates""" - pass - - - @property - def Size(self)->'PyCOORD': - """New size of screen buffer in character rows/columns""" - pass - - - @property - def SetFocus(self)->'Any': - """Reserved - Used only with type FOCUS_EVENT. This event is Reserved, and should be ignored.""" - pass - - - @property - def CommandId(self)->'Any': - """Used only with event type MENU_EVENT, which is reserved and should not be used""" - pass - - -class PyLOCALGROUP_INFO_0(object): - """A dictionary holding the information in a Win32 LOCALGROUP_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'Union[str]': - """Name of the group""" - pass - - -class PyLOCALGROUP_INFO_1(object): - """A dictionary holding the information in a Win32 LOCALGROUP_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'Union[str]': - """Name of the group""" - pass - - - @property - def comment(self)->'Union[str]': - """The group's comment.""" - pass - - -class PyLOCALGROUP_INFO_1002(object): - """A dictionary holding the information in a Win32 LOCALGROUP_INFO_1002 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def comment(self)->'Union[str]': - """""" - pass - - -class PyLOCALGROUP_MEMBERS_INFO_0(object): - """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_0 - -structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def sid(self)->'PySID': - """""" - pass - - -class PyLOCALGROUP_MEMBERS_INFO_1(object): - """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_1 - -structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def sid(self)->'PySID': - """""" - pass - - - @property - def sidusage(self)->'Any': - """""" - pass - - - @property - def name(self)->'Union[str]': - """""" - pass - - -class PyLOCALGROUP_MEMBERS_INFO_2(object): - """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_2 - -structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def sid(self)->'PySID': - """""" - pass - - - @property - def sidusage(self)->'Any': - """""" - pass - - - @property - def domainandname(self)->'Union[str]': - """string containing the name of the member prefixed by the domain name and the "\\" separator character""" - pass - - -class PyLOCALGROUP_MEMBERS_INFO_3(object): - """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_3 - -structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def domainandname(self)->'Union[str]': - """string containing the name of the member prefixed by the domain name and the "\\" separator character""" - pass - - -class PyLOGBRUSH(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Style(self)->'Any': - """Brush style, one of win32con.BS_* values""" - pass - - - @property - def Color(self)->'Any': - """RGB color value. Can also be DIB_PAL_COLORS or DIB_RGB_COLORS if Style is BS_DIBPATTERN or BS_DIBPATTERNPT=""" - pass - - - @property - def Hatch(self)->'Union[Any, int]': - """For BS_HATCH style, one of win32con.HS_*. Not used For BS_SOLID or BS_HOLLOW. For a pattern brush, this should be a handle to a bitmap""" - pass - - -class PyLOGFONT(object): - """A Python object, representing an PyLOGFONT structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def lfHeight(self)->'int': - """""" - pass - - - @property - def lfWidth(self)->'int': - """""" - pass - - - @property - def lfEscapement(self)->'int': - """""" - pass - - - @property - def lfOrientation(self)->'int': - """""" - pass - - - @property - def lfWeight(self)->'int': - """""" - pass - - - @property - def lfItalic(self)->'int': - """""" - pass - - - @property - def lfUnderline(self)->'int': - """""" - pass - - - @property - def lfStrikeOut(self)->'int': - """""" - pass - - - @property - def lfCharSet(self)->'int': - """""" - pass - - - @property - def lfOutPrecision(self)->'int': - """""" - pass - - - @property - def lfClipPrecision(self)->'int': - """""" - pass - - - @property - def lfQuality(self)->'int': - """""" - pass - - - @property - def lfPitchAndFamily(self)->'int': - """""" - pass - - - @property - def lfFaceName(self)->'str': - """Name of the typeface, at most 31 characters""" - pass - - -class PyLSA_HANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyLUID_AND_ATTRIBUTES(object): - """A sequence containing (LUID,Attributes) representing an LUID_AND_ATTRIBUTES structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyLsaLogon_HANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyMSG(object): - """A tuple representing a win32 MSG structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyNETRESOURCE(object): - """A Python object that encapsulates a Win32 NETRESOURCE structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwScope(self)->'int': - """""" - pass - - - @property - def dwType(self)->'int': - """""" - pass - - - @property - def dwDisplayType(self)->'int': - """""" - pass - - - @property - def dwUsage(self)->'int': - """""" - pass - - - @property - def localName(self)->'str': - """""" - pass - - - @property - def remoteName(self)->'str': - """""" - pass - - - @property - def comment(self)->'str': - """""" - pass - - - @property - def provider(self)->'str': - """""" - pass - - -class PyNET_VALIDATE_AUTHENTICATION_INPUT_ARG(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyNET_VALIDATE_PASSWORD_CHANGE_INPUT_ARG(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyNET_VALIDATE_PERSISTED_FIELDS(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyNMHDR(object): - """A Python object, representing an NMHDR - -structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def hwndFrom(self)->'Any': - """Window handle to the control sending a message. ??? 64-bit problem here ???""" - pass - - - @property - def idFrom(self)->'Any': - """Identifier of the control sending a message.""" - pass - - - @property - def code(self)->'Any': - """Notification code. This member can be a control-specific notification code or it can be one of the common notification codes.""" - pass - - -class PyNOTIFYICONDATA(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyOVERLAPPED(object): - """A Python object, representing an overlapped structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Offset(self)->'int': - """Specifies a file position at which to start the transfer. The file position is a byte offset from the start of the file. The calling process sets this member before calling the ReadFile or WriteFile function. This member is ignored when reading from or writing to named pipes and communications devices.""" - pass - - - @property - def OffsetHigh(self)->'int': - """Specifies the high word of the byte offset at which to start the transfer.""" - pass - - - @property - def object(self)->'Any': - """Any python object that you want to attach to your overlapped I/O request.""" - pass - - - @property - def dword(self)->'Any': - """An integer buffer that may be used by overlapped functions (eg, win32file::WaitCommEvent)""" - pass - - - @property - def hEvent(self)->'int': - """Identifies an event set to the signaled state when the transfer has been completed. The calling process sets this member before calling the win32file::ReadFile, win32file::WriteFile, win32pipe::ConnectNamedPipe, or win32pipe::TransactNamedPipe function.""" - pass - - - @property - def Internal(self)->'int': - """Reserved for operating system use. (pointer-sized value)""" - pass - - - @property - def InternalHigh(self)->'int': - """Reserved for operating system use. (pointer-sized value)""" - pass - - -class PyOVERLAPPEDReadBuffer(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyPERF_COUNTER_DEFINITION(object): - """An object encapsulating a Windows NT Performance Monitor counter definition - -(PERF_COUNTER_DEFINITION).""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def DefaultScale(self)->'int': - """The default scale of the counter.""" - pass - - - @property - def DetailLevel(self)->'int': - """The detail level of the counter.""" - pass - - - @property - def CounterType(self)->'int': - """The counter type.""" - pass - - - @property - def CounterNameTitleIndex(self)->'int': - """""" - pass - - - @property - def CounterHelpTitleIndex(self)->'int': - """Sentinel""" - pass - - - def Increment(self,) -> 'None': - """ - Increments the value of the performance counter - -Args: - - - -Returns: - - None - - """ - pass - - - def Decrement(self,) -> 'None': - """ - Decrements the value of the performance counter - -Args: - - - -Returns: - - None - - """ - pass - - - def Set(self,) -> 'None': - """ - Sets the counter to a specific value - -Args: - - - -Returns: - - None - - """ - pass - - - def Get(self,) -> 'None': - """ - Gets the current value of the counter - -Args: - - - -Returns: - - None - - """ - pass - - -class PyPERF_OBJECT_TYPE(object): - """A Python object, representing a PERF_OBJECT_TYPE structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ObjectNameTitleIndex(self)->'int': - """""" - pass - - - @property - def ObjectHelpTitleIndex(self)->'int': - """""" - pass - - - @property - def DefaultCounterIndex(self)->'int': - """""" - pass - - - def Close(self,) -> 'None': - """ - Closes the object. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyPOINT(object): - """Tuple of two ints (x,y) representing a POINT struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyPROFILEINFO(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def UserName(self)->'str': - """Name of user for which to load profile""" - pass - - - @property - def Flags(self)->'Any': - """Combination of PI_* flags""" - pass - - - @property - def ProfilePath(self)->'str': - """Path to roaming profile, can be None. Use win32net::NetUserGetInfo to retrieve user's profile path""" - pass - - - @property - def DefaultPath(self)->'str': - """Path to Default user profile, can be None""" - pass - - - @property - def ServerName(self)->'str': - """Domain controller, can be None""" - pass - - - @property - def PolicyPath(self)->'str': - """Location of policy file, can be None""" - pass - - - @property - def Profile(self)->'PyHKEY': - """Handle to root of user's registry key. This member is output.""" - pass - - -class PyPerfMonManager(object): - """A Python object""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Close(self,) -> 'None': - """ - Closes the performance monitor manager. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyPrinterHANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyRECT(object): - """Tuple of 4 ints defining a rectangle: (left, top, right, bottom)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyResourceId(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySCROLLINFO(object): - """A tuple representing a SCROLLINFO structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySC_HANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySECURITY_ATTRIBUTES(object): - """A Python object, representing a SECURITY_ATTRIBUTES structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def bInheritHandle(self)->'Any': - """Specifies whether the returned handle is inherited when a new process is created. If this member is TRUE, the new process inherits the handle.""" - pass - - - @property - def SECURITY_DESCRIPTOR(self)->'PySECURITY_DESCRIPTOR': - """A PySECURITY_DESCRIPTOR, or None""" - pass - - -class PySECURITY_DESCRIPTOR(object): - """A Python object, representing a SECURITY_DESCRIPTOR structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,) -> 'None': - """ - Initialize the SD. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetSecurityDescriptorOwner(self,) -> 'PySID': - """ - Return the owner of the security descriptor. - -Args: - - - -Returns: - - PySID - - """ - pass - - - def GetSecurityDescriptorDacl(self,) -> 'PyACL': - """ - Return the discretionary ACL of the security - -descriptor. - -Args: - - - -Returns: - - PyACL - - """ - pass - - - def GetSecurityDescriptorSacl(self,) -> 'PyACL': - """ - Return system access control list (SACL) of SD - -Args: - - - -Returns: - - PyACL - - """ - pass - - - def GetSecurityDescriptorControl(self,) -> 'Tuple[Any, Any]': - """ - Returns tuple of Control bit flags and - -revision of SD. - -Args: - - - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def SetSecurityDescriptorOwner(self,sid:'PySID',bOwnerDefaulted:'Any') -> 'None': - """ - Set owner SID. - -Args: - - sid(PySID):The sid to be set as owner in the security descriptor. - bOwnerDefaulted(Any):Normally set to false since this explicitely set the owner. - -Returns: - - None - - """ - pass - - - def SetSecurityDescriptorGroup(self,sid:'PySID',bOwnerDefaulted:'Any') -> 'Any': - """ - Set group SID. - -Args: - - sid(PySID):The group sid to be set in the security descriptor. - bOwnerDefaulted(Any):Normally set to false since this explicitely set the owner. - -Returns: - - Any - - """ - pass - - - def SetSecurityDescriptorSacl(self,bSaclPresent:'Any',SACL:'PyACL',bSaclDefaulted:'Any') -> 'None': - """ - Replaces system access control list (SACL) in the security - -descriptor. - -Args: - - bSaclPresent(Any):A flag indicating if SACL is to be used. If false, last 2 parms are ignored. - SACL(PyACL):The SACL to set in the security descriptor - bSaclDefaulted(Any):Flag, set to false if user has specifically set the SACL. - -Returns: - - None - - """ - pass - - - def IsValid(self,) -> 'None': - """ - Determines if the security descriptor is valid. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetLength(self,) -> 'None': - """ - return length of security descriptor (GetSecurityDescriptorLenght). - -Args: - - - -Returns: - - None - - """ - pass - - - def IsSelfRelative(self,) -> 'None': - """ - Returns 1 if security descriptor is self relative, 0 if absolute - -Args: - - - -Returns: - - None - - """ - pass - - - def SetSecurityDescriptorControl(self,ControlBitsOfInterest:'Any',ControlBitsToSet:'Any') -> 'None': - """ - Sets the control bit flags related to inheritance for a - -security descriptor - -Args: - - ControlBitsOfInterest(Any):Bitmask of flags to be modified - ControlBitsToSet(Any):Bitmask containing flag values to setCommentsOnly exists on Windows 2000 or later - -Returns: - - None - - """ - pass - - -class PySERVER_INFO_100(object): - """A dictionary holding the information in a Win32 SERVER_INFO_100 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def platform_id(self)->'Any': - """""" - pass - - - @property - def name(self)->'Union[str]': - """""" - pass - - -class PySERVER_INFO_101(object): - """A dictionary holding the information in a Win32 SERVER_INFO_101 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def platform_id(self)->'Any': - """""" - pass - - - @property - def name(self)->'Union[str]': - """""" - pass - - - @property - def version_major(self)->'Any': - """""" - pass - - - @property - def version_minor(self)->'Any': - """""" - pass - - - @property - def type(self)->'Any': - """one of the SV_TYPE_* constants""" - pass - - - @property - def comment(self)->'Union[str]': - """""" - pass - - -class PySERVER_INFO_102(object): - """A dictionary holding the information in a Win32 SERVER_INFO_102 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def platform_id(self)->'Any': - """""" - pass - - - @property - def name(self)->'Union[str]': - """""" - pass - - - @property - def version_major(self)->'Any': - """""" - pass - - - @property - def version_minor(self)->'Any': - """""" - pass - - - @property - def type(self)->'Any': - """one of the SV_TYPE_* constants""" - pass - - - @property - def comment(self)->'Union[str]': - """""" - pass - - - @property - def users(self)->'Any': - """""" - pass - - - @property - def disc(self)->'Any': - """""" - pass - - - @property - def hidden(self)->'Any': - """""" - pass - - - @property - def announce(self)->'Any': - """""" - pass - - - @property - def anndelta(self)->'Any': - """""" - pass - - - @property - def userpath(self)->'Union[str]': - """""" - pass - - -class PySERVER_INFO_402(object): - """A dictionary holding the information in a Win32 SERVER_INFO_402 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ulist_mtime(self)->'Any': - """""" - pass - - - @property - def glist_mtime(self)->'Any': - """""" - pass - - - @property - def alist_mtime(self)->'Any': - """""" - pass - - - @property - def security(self)->'Any': - """""" - pass - - - @property - def numadmin(self)->'Any': - """""" - pass - - - @property - def lanmask(self)->'Any': - """""" - pass - - - @property - def guestacct(self)->'Union[str]': - """""" - pass - - - @property - def chdevs(self)->'Any': - """""" - pass - - - @property - def chdevq(self)->'Any': - """""" - pass - - - @property - def chdevjobs(self)->'Any': - """""" - pass - - - @property - def connections(self)->'Any': - """""" - pass - - - @property - def shares(self)->'Any': - """""" - pass - - - @property - def openfiles(self)->'Any': - """""" - pass - - - @property - def sessopens(self)->'Any': - """""" - pass - - - @property - def sessvcs(self)->'Any': - """""" - pass - - - @property - def sessreqs(self)->'Any': - """""" - pass - - - @property - def opensearch(self)->'Any': - """""" - pass - - - @property - def activelocks(self)->'Any': - """""" - pass - - - @property - def numreqbuf(self)->'Any': - """""" - pass - - - @property - def sizreqbuf(self)->'Any': - """""" - pass - - - @property - def numbigbuf(self)->'Any': - """""" - pass - - - @property - def numfiletasks(self)->'Any': - """""" - pass - - - @property - def alertsched(self)->'Any': - """""" - pass - - - @property - def erroralert(self)->'Any': - """""" - pass - - - @property - def logonalert(self)->'Any': - """""" - pass - - - @property - def accessalert(self)->'Any': - """""" - pass - - - @property - def diskalert(self)->'Any': - """""" - pass - - - @property - def netioalert(self)->'Any': - """""" - pass - - - @property - def maxauditsz(self)->'Any': - """""" - pass - - - @property - def srvheuristics(self)->'Union[str]': - """""" - pass - - -class PySERVER_INFO_403(object): - """A dictionary holding the information in a Win32 SERVER_INFO_403 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ulist_mtime(self)->'Any': - """""" - pass - - - @property - def glist_mtime(self)->'Any': - """""" - pass - - - @property - def alist_mtime(self)->'Any': - """""" - pass - - - @property - def security(self)->'Any': - """""" - pass - - - @property - def numadmin(self)->'Any': - """""" - pass - - - @property - def lanmask(self)->'Any': - """""" - pass - - - @property - def guestacct(self)->'Union[str]': - """""" - pass - - - @property - def chdevs(self)->'Any': - """""" - pass - - - @property - def chdevq(self)->'Any': - """""" - pass - - - @property - def chdevjobs(self)->'Any': - """""" - pass - - - @property - def connections(self)->'Any': - """""" - pass - - - @property - def shares(self)->'Any': - """""" - pass - - - @property - def openfiles(self)->'Any': - """""" - pass - - - @property - def sessopens(self)->'Any': - """""" - pass - - - @property - def sessvcs(self)->'Any': - """""" - pass - - - @property - def sessreqs(self)->'Any': - """""" - pass - - - @property - def opensearch(self)->'Any': - """""" - pass - - - @property - def activelocks(self)->'Any': - """""" - pass - - - @property - def numreqbuf(self)->'Any': - """""" - pass - - - @property - def sizreqbuf(self)->'Any': - """""" - pass - - - @property - def numbigbuf(self)->'Any': - """""" - pass - - - @property - def numfiletasks(self)->'Any': - """""" - pass - - - @property - def alertsched(self)->'Any': - """""" - pass - - - @property - def erroralert(self)->'Any': - """""" - pass - - - @property - def logonalert(self)->'Any': - """""" - pass - - - @property - def accessalert(self)->'Any': - """""" - pass - - - @property - def diskalert(self)->'Any': - """""" - pass - - - @property - def netioalert(self)->'Any': - """""" - pass - - - @property - def maxauditsz(self)->'Any': - """""" - pass - - - @property - def srvheuristics(self)->'Union[str]': - """""" - pass - - - @property - def auditedevents(self)->'Any': - """""" - pass - - - @property - def autoprofile(self)->'Any': - """""" - pass - - - @property - def autopath(self)->'Union[str]': - """""" - pass - - -class PySERVER_INFO_502(object): - """A dictionary holding the information in a Win32 SERVER_INFO_502 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def sessopens(self)->'Any': - """""" - pass - - - @property - def sessvcs(self)->'Any': - """""" - pass - - - @property - def opensearch(self)->'Any': - """""" - pass - - - @property - def sizreqbuf(self)->'Any': - """""" - pass - - - @property - def initworkitems(self)->'Any': - """""" - pass - - - @property - def maxworkitems(self)->'Any': - """""" - pass - - - @property - def rawworkitems(self)->'Any': - """""" - pass - - - @property - def irpstacksize(self)->'Any': - """""" - pass - - - @property - def maxrawbuflen(self)->'Any': - """""" - pass - - - @property - def sessusers(self)->'Any': - """""" - pass - - - @property - def sessconns(self)->'Any': - """""" - pass - - - @property - def maxpagedmemoryusage(self)->'Any': - """""" - pass - - - @property - def maxnonpagedmemoryusage(self)->'Any': - """""" - pass - - - @property - def enableforcedlogoff(self)->'Any': - """""" - pass - - - @property - def timesource(self)->'Any': - """""" - pass - - - @property - def acceptdownlevelapis(self)->'Any': - """""" - pass - - - @property - def lmannounce(self)->'Any': - """""" - pass - - -class PySERVER_INFO_503(object): - """A dictionary holding the information in a Win32 SERVER_INFO_503 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def sessopens(self)->'Any': - """""" - pass - - - @property - def sessvcs(self)->'Any': - """""" - pass - - - @property - def opensearch(self)->'Any': - """""" - pass - - - @property - def sizreqbuf(self)->'Any': - """""" - pass - - - @property - def initworkitems(self)->'Any': - """""" - pass - - - @property - def maxworkitems(self)->'Any': - """""" - pass - - - @property - def rawworkitems(self)->'Any': - """""" - pass - - - @property - def irpstacksize(self)->'Any': - """""" - pass - - - @property - def maxrawbuflen(self)->'Any': - """""" - pass - - - @property - def sessusers(self)->'Any': - """""" - pass - - - @property - def sessconns(self)->'Any': - """""" - pass - - - @property - def maxpagedmemoryusage(self)->'Any': - """""" - pass - - - @property - def maxnonpagedmemoryusage(self)->'Any': - """""" - pass - - - @property - def enableforcedlogoff(self)->'Any': - """""" - pass - - - @property - def timesource(self)->'Any': - """""" - pass - - - @property - def acceptdownlevelapis(self)->'Any': - """""" - pass - - - @property - def lmannounce(self)->'Any': - """""" - pass - - - @property - def domain(self)->'Union[str]': - """""" - pass - - - @property - def maxkeepsearch(self)->'Any': - """""" - pass - - - @property - def scavtimeout(self)->'Any': - """""" - pass - - - @property - def minrcvqueue(self)->'Any': - """""" - pass - - - @property - def minfreeworkitems(self)->'Any': - """""" - pass - - - @property - def xactmemsize(self)->'Any': - """""" - pass - - - @property - def threadpriority(self)->'Any': - """""" - pass - - - @property - def maxmpxct(self)->'Any': - """""" - pass - - - @property - def oplockbreakwait(self)->'Any': - """""" - pass - - - @property - def oplockbreakresponsewait(self)->'Any': - """""" - pass - - - @property - def enableoplocks(self)->'Any': - """""" - pass - - - @property - def enablefcbopens(self)->'Any': - """""" - pass - - - @property - def enableraw(self)->'Any': - """""" - pass - - - @property - def enablesharednetdrives(self)->'Any': - """""" - pass - - - @property - def minfreeconnections(self)->'Any': - """""" - pass - - - @property - def maxfreeconnections(self)->'Any': - """""" - pass - - -class PySHARE_INFO_0(object): - """A dictionary holding the infomation in a Win32 SHARE_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def netname(self)->'Union[str]': - """""" - pass - - -class PySHARE_INFO_1(object): - """A dictionary holding the infomation in a Win32 SHARE_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def netname(self)->'Union[str]': - """""" - pass - - - @property - def type(self)->'Any': - """""" - pass - - - @property - def remark(self)->'Union[str]': - """""" - pass - - -class PySHARE_INFO_2(object): - """A dictionary holding the infomation in a Win32 SHARE_INFO_2 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def netname(self)->'Union[str]': - """""" - pass - - - @property - def type(self)->'Any': - """""" - pass - - - @property - def remark(self)->'Union[str]': - """""" - pass - - - @property - def permissions(self)->'Any': - """""" - pass - - - @property - def max_uses(self)->'Any': - """""" - pass - - - @property - def current_uses(self)->'Any': - """""" - pass - - - @property - def path(self)->'Union[str]': - """""" - pass - - - @property - def passwd(self)->'Union[str]': - """""" - pass - - -class PySHARE_INFO_501(object): - """A dictionary holding the infomation in a Win32 SHARE_INFO_501 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def netname(self)->'Union[str]': - """""" - pass - - - @property - def type(self)->'Any': - """""" - pass - - - @property - def remark(self)->'Union[str]': - """""" - pass - - - @property - def flags(self)->'Any': - """""" - pass - - -class PySHARE_INFO_502(object): - """A dictionary holding the infomation in a Win32 SHARE_INFO_502 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def netname(self)->'Union[str]': - """""" - pass - - - @property - def type(self)->'Any': - """""" - pass - - - @property - def remark(self)->'Union[str]': - """""" - pass - - - @property - def permissions(self)->'Any': - """""" - pass - - - @property - def max_uses(self)->'Any': - """""" - pass - - - @property - def current_uses(self)->'Any': - """""" - pass - - - @property - def path(self)->'Union[str]': - """""" - pass - - - @property - def passwd(self)->'Union[str]': - """""" - pass - - - @property - def reserved(self)->'Any': - """""" - pass - - - @property - def security_descriptor(self)->'PySECURITY_DESCRIPTOR': - """""" - pass - - -class PySID(object): - """A Python object, representing a SID structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,idAuthority:'Any',numSubauthorities:'Any') -> 'None': - """ - Initialize the SID. - -Args: - - idAuthority(Any):The identifier authority. - numSubauthorities(Any):The number of sub authorities to allocate. - -Returns: - - None - - """ - pass - - - def IsValid(self,) -> 'None': - """ - Determines if the SID is valid. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetSubAuthority(self,index:'Any',val:'Any') -> 'None': - """ - Sets a SID SubAuthority - -Args: - - index(Any):The index of the sub authority to set - val(Any):The value for the sub authorityCommentsSee the function SetSidSubAuthority - -Returns: - - None - - """ - pass - - - def GetLength(self,) -> 'Any': - """ - return length of SID (GetLengthSid). - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetSubAuthorityCount(self,) -> 'Any': - """ - return nbr of subauthorities from SID - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetSubAuthority(self,) -> 'Any': - """ - Returns specified subauthority from SID - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetSidIdentifierAuthority(self,) -> 'Tuple[Any, Any, Any, Any, Any, Any]': - """ - Returns a tuple of 6 SID_IDENTIFIER_AUTHORITY - -constants - -Args: - - - -Returns: - - Tuple[Any, Any, Any, Any, Any, Any] - - """ - pass - - -class PySID_AND_ATTRIBUTES(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySIZE(object): - """Tuple of two ints (cx,cy) representing a SIZE struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySMALL_RECT(object): - """Wrapper for a SMALL_RECT struct - -Create using PySMALL_RECTType(Left, Top, Right, Bottom). All params optional, defaulting to 0""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Left(self)->'Any': - """Left side of rectangle""" - pass - - - @property - def Top(self)->'Any': - """Top edge of rectangle""" - pass - - - @property - def Right(self)->'Any': - """Right edge of rectangle""" - pass - - - @property - def Bottom(self)->'Any': - """Bottome edge of rectangle""" - pass - - -class PySTARTUPINFO(object): - """A Python object, representing an STARTUPINFO structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwX(self)->'int': - """Specifies the x offset, in pixels, of the upper left corner of a window if a new window is created. The offset is from the upper left corner of the screen.""" - pass - - - @property - def dwY(self)->'int': - """Specifies the y offset, in pixels, of the upper left corner of a window if a new window is created. The offset is from the upper left corner of the screen.""" - pass - - - @property - def dwXSize(self)->'int': - """Specifies the width, in pixels, of the window if a new window is created.""" - pass - - - @property - def dwYSize(self)->'int': - """Specifies the height, in pixels, of the window if a new window is created.""" - pass - - - @property - def dwXCountChars(self)->'int': - """For console processes, if a new console window is created, specifies the screen buffer width in character columns. This value is ignored in a GUI process.""" - pass - - - @property - def dwYCountChars(self)->'int': - """For console processes, if a new console window is created, specifies the screen buffer height in character rows.""" - pass - - - @property - def dwFillAttribute(self)->'int': - """Specifies the initial text and background colors if a new console window is created in a console application. These values are ignored in GUI applications""" - pass - - - @property - def dwFlags(self)->'int': - """This is a bit field that determines whether certain STARTUPINFO attributes are used when the process creates a window. To use many of the additional attributes, you typically must set the appropriate mask in this attribute, and also set the attributes themselves. Any combination of the win32con.STARTF_* flags can be specified.""" - pass - - - @property - def wShowWindow(self)->'int': - """Can be any of the SW_ constants defined in win32con. For GUI processes, this specifies the default value the first time ShowWindow is called.""" - pass - - - @property - def hStdInput(self)->'Union[int]': - """""" - pass - - - @property - def hStdOutput(self)->'Union[int]': - """""" - pass - - - @property - def hStdError(self)->'Union[int]': - """""" - pass - - - @property - def lpDesktop(self)->'Union[Any, str]': - """""" - pass - - - @property - def lpTitle(self)->'Union[Any, str]': - """""" - pass - - -class PySecBuffer(object): - """Python object wrapping a SecBuffer structure - -Created using win32security.PySecBufferType(type,size) where type is a SECBUFFER_* constant""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def BufferType(self)->'Any': - """""" - pass - - - @property - def Buffer(self)->'str': - """""" - pass - - - @property - def BufferSize(self)->'Any': - """""" - pass - - - @property - def MaxBufferSize(self)->'Any': - """""" - pass - - - def Clear(self,) -> 'None': - """ - Resets the buffer to all NULL's, and set the current size to maximum - -Args: - - - -Returns: - - None - - """ - pass - - -class PySecBufferDesc(object): - """Sequence-like object that contains a group of buffers to be used with SSPI functions.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def append(self,buffer:'Any') -> 'None': - """ - None - -Args: - - buffer(Any):PySecBuffer object to be attached to the group of buffers - -Returns: - - None - - """ - pass - - -class PyTOKEN_GROUPS(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyTOKEN_PRIVILEGES(object): - """An object representing Win32 token privileges.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyTRIVERTEX(object): - """Dict representing a TRIVERTEX struct containing color information at a point""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def x(self)->'Any': - """X coord in logical units""" - pass - - - @property - def y(self)->'Any': - """Y coord in logical units""" - pass - - - @property - def Red(self)->'Any': - """Red component""" - pass - - - @property - def Green(self)->'Any': - """Green component""" - pass - - - @property - def Blue(self)->'Any': - """Blue component""" - pass - - - @property - def Alpha(self)->'Any': - """Transparency value""" - pass - - -class PyTRUSTEE(object): - """A dictionary representing a TRUSTEE structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def TrusteeForm(self)->'Any': - """""" - pass - - - @property - def TrusteeType(self)->'Any': - """""" - pass - - - @property - def Identifier(self)->'Any': - """Depends on the value of TrusteeForm (string or sid)""" - pass - - - @property - def MultipleTrustee(self)->'Any': - """default is None""" - pass - - - @property - def MultipleTrusteeOperation(self)->'Any': - """default is None""" - pass - - -class PyTS_HANDLE(object): - """Handle to a Terminal Server""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyTime(object): - """A Python object, representing an instant in time.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def year(self)->'Any': - """""" - pass - - - @property - def month(self)->'Any': - """""" - pass - - - @property - def weekday(self)->'Any': - """""" - pass - - - @property - def day(self)->'Any': - """""" - pass - - - @property - def hour(self)->'Any': - """""" - pass - - - @property - def minute(self)->'Any': - """""" - pass - - - @property - def second(self)->'Any': - """""" - pass - - - @property - def msec(self)->'Any': - """""" - pass - - - def Format(self,_format:'str') -> 'str': - """ - Formats the time value. - -Args: - - _format(str):The format. See the comments section for a description of the supported flags.CommentsThe following format characters are supported.CharacterDescription%aAbbreviated weekday name%AFull weekday name%bAbbreviated month name%BFull month name%cDate and time representation appropriate for locale%dDay of month as decimal number (01 - 31)%HHour in 24-hour format (00 - 23)%IHour in 12-hour format (01 - 12)%jDay of year as decimal number (001 - 366)%mMonth as decimal number (01 - 12)%MMinute as decimal number (00 - 59)%pCurrent locale's A.M./P.M. indicator for 12-hour clock%SSecond as decimal number (00 - 59)%UWeek of year as decimal number, with Sunday as first day of week (00 - 51)%wWeekday as decimal number (0 - 6; Sunday is 0)%WWeek of year as decimal number, with Monday as first day of week (00 - 51)%xDate representation for current locale%XTime representation for current locale%yYear without century, as decimal number (00 - 99)%YYear with century, as decimal number%z, %ZTime-zone name or abbreviation; no characters if time zone is unknown%%Percent signAs in the printf function, the # flag may prefix any formatting code. In that case, the meaning of the format code is changed as follows.Format CodeMeaning%#a, %#A, %#b, %#B, %#p, %#X, %#z, %#Z, %#%# flag is ignored.%#cLong date and time representation, appropriate for current locale. For example: "Tuesday, March 14, 1995, 12:41:29".%#xLong date representation, appropriate to current locale. For example: "Tuesday, March 14, 1995".%#d, %#H, %#I, %#j, %#m, %#M, %#S, %#U, %#w, %#W, %#y, %#YRemove leading zeros (if any). - -Returns: - - str - - """ - pass - - -class PyUSER_INFO_0(object): - """A dictionary holding the information in a Win32 USER_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'Union[str]': - """""" - pass - - -class PyUSER_INFO_1(object): - """A dictionary holding the information in a Win32 USER_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'Union[str]': - """""" - pass - - - @property - def password(self)->'Union[str]': - """""" - pass - - - @property - def password_age(self)->'Any': - """""" - pass - - - @property - def priv(self)->'Any': - """""" - pass - - - @property - def home_dir(self)->'Union[str]': - """""" - pass - - - @property - def comment(self)->'Union[str]': - """""" - pass - - - @property - def flags(self)->'Any': - """""" - pass - - - @property - def script_path(self)->'Union[str]': - """""" - pass - - -class PyUSER_INFO_10(object): - """A dictionary holding the information in a Win32 USER_INFO_10 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'Union[str]': - """""" - pass - - - @property - def comment(self)->'Union[str]': - """""" - pass - - - @property - def usr_comment(self)->'Union[str]': - """""" - pass - - - @property - def full_name(self)->'Union[str]': - """""" - pass - - -class PyUSER_INFO_1003(object): - """A dictionary holding the information in a Win32 USER_INFO_1003 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def password(self)->'Union[str]': - """""" - pass - - -class PyUSER_INFO_1005(object): - """A dictionary holding the information in a Win32 USER_INFO_1005 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def priv(self)->'Any': - """""" - pass - - -class PyUSER_INFO_1006(object): - """A dictionary holding the information in a Win32 USER_INFO_1006 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def home_dir(self)->'Union[str]': - """""" - pass - - -class PyUSER_INFO_1007(object): - """A dictionary holding the information in a Win32 USER_INFO_1007 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def comment(self)->'Union[str]': - """""" - pass - - -class PyUSER_INFO_1008(object): - """A dictionary holding the information in a Win32 USER_INFO_1008 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def flags(self)->'Any': - """""" - pass - - -class PyUSER_INFO_1009(object): - """A dictionary holding the information in a Win32 USER_INFO_1009 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def script_path(self)->'Union[str]': - """""" - pass - - -class PyUSER_INFO_1010(object): - """A dictionary holding the information in a Win32 USER_INFO_1010 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def auth_flags(self)->'Any': - """""" - pass - - -class PyUSER_INFO_1011(object): - """A dictionary holding the information in a Win32 USER_INFO_1011 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def full_name(self)->'Union[str]': - """""" - pass - - -class PyUSER_INFO_11(object): - """A dictionary holding the information in a Win32 USER_INFO_11 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'Union[str]': - """""" - pass - - - @property - def comment(self)->'Union[str]': - """""" - pass - - - @property - def usr_comment(self)->'Union[str]': - """""" - pass - - - @property - def full_name(self)->'Union[str]': - """""" - pass - - - @property - def priv(self)->'Any': - """""" - pass - - - @property - def auth_flags(self)->'Any': - """""" - pass - - - @property - def password_age(self)->'Any': - """""" - pass - - - @property - def home_dir(self)->'Union[str]': - """""" - pass - - - @property - def parms(self)->'Union[str]': - """""" - pass - - - @property - def last_logon(self)->'Any': - """""" - pass - - - @property - def last_logoff(self)->'Any': - """""" - pass - - - @property - def bad_pw_count(self)->'Any': - """""" - pass - - - @property - def num_logons(self)->'Any': - """""" - pass - - - @property - def logon_server(self)->'Union[str]': - """""" - pass - - - @property - def country_code(self)->'Any': - """""" - pass - - - @property - def workstations(self)->'Union[str]': - """""" - pass - - - @property - def max_storage(self)->'Any': - """""" - pass - - - @property - def units_per_week(self)->'Any': - """""" - pass - - - @property - def logon_hours(self)->'str': - """""" - pass - - - @property - def code_page(self)->'Any': - """""" - pass - - -class PyUSER_INFO_2(object): - """A dictionary holding the information in a Win32 USER_INFO_2 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'Union[str]': - """""" - pass - - - @property - def password(self)->'Union[str]': - """""" - pass - - - @property - def password_age(self)->'Any': - """""" - pass - - - @property - def priv(self)->'Any': - """""" - pass - - - @property - def home_dir(self)->'Union[str]': - """""" - pass - - - @property - def comment(self)->'Union[str]': - """""" - pass - - - @property - def flags(self)->'Any': - """""" - pass - - - @property - def script_path(self)->'Union[str]': - """""" - pass - - - @property - def auth_flags(self)->'Any': - """""" - pass - - - @property - def full_name(self)->'Union[str]': - """""" - pass - - - @property - def usr_comment(self)->'Union[str]': - """""" - pass - - - @property - def parms(self)->'Union[str]': - """""" - pass - - - @property - def workstations(self)->'Union[str]': - """""" - pass - - - @property - def last_logon(self)->'Any': - """""" - pass - - - @property - def last_logoff(self)->'Any': - """""" - pass - - - @property - def acct_expires(self)->'Any': - """""" - pass - - - @property - def max_storage(self)->'Any': - """""" - pass - - - @property - def units_per_week(self)->'Any': - """""" - pass - - - @property - def logon_hours(self)->'str': - """""" - pass - - - @property - def bad_pw_count(self)->'Any': - """""" - pass - - - @property - def num_logons(self)->'Any': - """""" - pass - - - @property - def logon_server(self)->'Union[str]': - """""" - pass - - - @property - def country_code(self)->'Any': - """""" - pass - - - @property - def code_page(self)->'Any': - """""" - pass - - -class PyUSER_INFO_20(object): - """A dictionary holding the information in a Win32 USER_INFO_20 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'Union[str]': - """""" - pass - - - @property - def full_name(self)->'Union[str]': - """""" - pass - - - @property - def comment(self)->'Union[str]': - """""" - pass - - - @property - def flags(self)->'Any': - """""" - pass - - - @property - def user_id(self)->'Any': - """""" - pass - - -class PyUSER_INFO_3(object): - """A dictionary holding the information in a Win32 USER_INFO_3 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'Union[str]': - """""" - pass - - - @property - def password(self)->'Union[str]': - """""" - pass - - - @property - def password_age(self)->'Any': - """""" - pass - - - @property - def priv(self)->'Any': - """""" - pass - - - @property - def home_dir(self)->'Union[str]': - """""" - pass - - - @property - def comment(self)->'Union[str]': - """""" - pass - - - @property - def flags(self)->'Any': - """""" - pass - - - @property - def script_path(self)->'Union[str]': - """""" - pass - - - @property - def auth_flags(self)->'Any': - """""" - pass - - - @property - def full_name(self)->'Union[str]': - """""" - pass - - - @property - def usr_comment(self)->'Union[str]': - """""" - pass - - - @property - def parms(self)->'Union[str]': - """""" - pass - - - @property - def workstations(self)->'Union[str]': - """""" - pass - - - @property - def last_logon(self)->'Any': - """""" - pass - - - @property - def last_logoff(self)->'Any': - """""" - pass - - - @property - def acct_expires(self)->'Any': - """""" - pass - - - @property - def max_storage(self)->'Any': - """""" - pass - - - @property - def units_per_week(self)->'Any': - """""" - pass - - - @property - def logon_hours(self)->'str': - """""" - pass - - - @property - def bad_pw_count(self)->'Any': - """""" - pass - - - @property - def num_logons(self)->'Any': - """""" - pass - - - @property - def logon_server(self)->'Union[str]': - """""" - pass - - - @property - def country_code(self)->'Any': - """""" - pass - - - @property - def code_page(self)->'Any': - """""" - pass - - - @property - def user_id(self)->'Any': - """""" - pass - - - @property - def primary_group_id(self)->'Any': - """""" - pass - - - @property - def profile(self)->'Union[str]': - """""" - pass - - - @property - def home_dir_drive(self)->'Union[str]': - """""" - pass - - - @property - def password_expired(self)->'Any': - """""" - pass - - -class PyUSER_INFO_4(object): - """A dictionary holding the information in a Win32 USER_INFO_4 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'Union[str]': - """""" - pass - - - @property - def password(self)->'Union[str]': - """""" - pass - - - @property - def password_age(self)->'Any': - """""" - pass - - - @property - def priv(self)->'Any': - """""" - pass - - - @property - def home_dir(self)->'Union[str]': - """""" - pass - - - @property - def comment(self)->'Union[str]': - """""" - pass - - - @property - def flags(self)->'Any': - """""" - pass - - - @property - def script_path(self)->'Union[str]': - """""" - pass - - - @property - def auth_flags(self)->'Any': - """""" - pass - - - @property - def full_name(self)->'Union[str]': - """""" - pass - - - @property - def usr_comment(self)->'Union[str]': - """""" - pass - - - @property - def parms(self)->'Union[str]': - """""" - pass - - - @property - def workstations(self)->'Union[str]': - """""" - pass - - - @property - def last_logon(self)->'Any': - """""" - pass - - - @property - def last_logoff(self)->'Any': - """""" - pass - - - @property - def acct_expires(self)->'Any': - """""" - pass - - - @property - def max_storage(self)->'Any': - """""" - pass - - - @property - def units_per_week(self)->'Any': - """""" - pass - - - @property - def logon_hours(self)->'str': - """""" - pass - - - @property - def bad_pw_count(self)->'Any': - """""" - pass - - - @property - def num_logons(self)->'Any': - """""" - pass - - - @property - def logon_server(self)->'Union[str]': - """""" - pass - - - @property - def country_code(self)->'Any': - """""" - pass - - - @property - def code_page(self)->'Any': - """""" - pass - - - @property - def user_sid(self)->'PySID': - """""" - pass - - - @property - def primary_group_id(self)->'Any': - """""" - pass - - - @property - def profile(self)->'Union[str]': - """""" - pass - - - @property - def home_dir_drive(self)->'Union[str]': - """""" - pass - - - @property - def password_expired(self)->'Any': - """""" - pass - - -class PyUSER_MODALS_INFO_0(object): - """A dictionary holding the information in a Win32 USER_MODALS_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def min_passwd_len(self)->'Any': - """""" - pass - - - @property - def max_passwd_age(self)->'Any': - """""" - pass - - - @property - def min_passwd_age(self)->'Any': - """""" - pass - - - @property - def force_logoff(self)->'Any': - """""" - pass - - - @property - def password_hist_len(self)->'Any': - """""" - pass - - -class PyUSER_MODALS_INFO_1(object): - """A dictionary holding the information in a Win32 USER_MODALS_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def role(self)->'Any': - """""" - pass - - - @property - def primary(self)->'Union[str]': - """""" - pass - - -class PyUSER_MODALS_INFO_2(object): - """A dictionary holding the information in a Win32 USER_MODALS_INFO_2 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def domain_name(self)->'Union[str]': - """""" - pass - - - @property - def domain_id(self)->'PySID': - """""" - pass - - -class PyUSER_MODALS_INFO_3(object): - """A dictionary holding the information in a Win32 USER_MODALS_INFO_3 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def lockout_duration(self)->'Any': - """""" - pass - - - @property - def lockout_observation_window(self)->'Any': - """""" - pass - - - @property - def usrmod3_lockout_threshold(self)->'Any': - """""" - pass - - -class PyUSE_INFO_0(object): - """A dictionary holding the infomation in a Win32 USE_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def local(self)->'Union[str]': - """""" - pass - - - @property - def remote(self)->'Union[str]': - """""" - pass - - -class PyUSE_INFO_1(object): - """A dictionary holding the infomation in a Win32 USE_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def local(self)->'Union[str]': - """""" - pass - - - @property - def remote(self)->'Union[str]': - """""" - pass - - - @property - def password(self)->'Union[Any, str]': - """""" - pass - - - @property - def status(self)->'Any': - """""" - pass - - - @property - def asg_type(self)->'Any': - """""" - pass - - - @property - def refcount(self)->'Any': - """""" - pass - - - @property - def usecount(self)->'Any': - """""" - pass - - -class PyUSE_INFO_2(object): - """A dictionary holding the infomation in a Win32 USE_INFO_2 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def local(self)->'Union[str]': - """""" - pass - - - @property - def remote(self)->'Union[str]': - """""" - pass - - - @property - def password(self)->'Union[Any, str]': - """""" - pass - - - @property - def status(self)->'Any': - """""" - pass - - - @property - def asg_type(self)->'Any': - """""" - pass - - - @property - def refcount(self)->'Any': - """""" - pass - - - @property - def usecount(self)->'Any': - """""" - pass - - - @property - def username(self)->'Union[str]': - """""" - pass - - - @property - def domainname(self)->'Union[str]': - """""" - pass - - -class PyUSE_INFO_3(object): - """A dictionary holding the infomation in a Win32 USE_INFO_3 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def local(self)->'Union[str]': - """""" - pass - - - @property - def remote(self)->'Union[str]': - """""" - pass - - - @property - def password(self)->'Union[Any, str]': - """""" - pass - - - @property - def status(self)->'Any': - """""" - pass - - - @property - def asg_type(self)->'Any': - """""" - pass - - - @property - def refcount(self)->'Any': - """""" - pass - - - @property - def usecount(self)->'Any': - """""" - pass - - - @property - def username(self)->'Union[str]': - """""" - pass - - - @property - def domainname(self)->'Union[str]': - """""" - pass - - - @property - def flags(self)->'Any': - """""" - pass - - -class PyUnicode(object): - """A Python object, representing a Unicode string.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyUrlCacheHANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyWAVEFORMATEX(object): - """A Python object, representing a WAVEFORMATEX structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def wFormatTag(self)->'int': - """Waveform-audio format type. pywintypes only defines WAVE_FORMAT_PCM as a constant. Other values must be looked up in the mmsystem.h header file.""" - pass - - - @property - def nChannels(self)->'int': - """Number of channels. 1 for Mono, 2 for Stereo, anything, but never 5.1.""" - pass - - - @property - def nSamplesPerSec(self)->'int': - """Sample rate, in samples per second (hertz), that each channel should be played or recorded. If wFormatTag is WAVE_FORMAT_PCM, then common values for nSamplesPerSec are 8000, 11025, 22050, and 44100 Hz""" - pass - - - @property - def nAvgBytesPerSec(self)->'int': - """Required average data-transfer rate, in bytes per second, for the format tag. If wFormatTag is WAVE_FORMAT_PCM, nAvgBytesPerSec should be equal to the product of nSamplesPerSec and nBlockAlign.""" - pass - - - @property - def nBlockAlign(self)->'int': - """Block alignment, in bytes. The block alignment is the minimum atomic unit of data for the wFormatTag format type. If wFormatTag is WAVE_FORMAT_PCM, nBlockAlign should be equal to the product of nChannels and wBitsPerSample divided by 8 (bits per byte). For non-PCM formats, this member must be computed according to the manufacturer’s specification of the format tag.""" - pass - - - @property - def wBitsPerSample(self)->'int': - """Bits per sample for the wFormatTag format type. If wFormatTag is WAVE_FORMAT_PCM, then wBitsPerSample should be equal to 8 or 16. Sentinel""" - pass - - -class PyWINHTTP_AUTOPROXY_OPTIONS(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyWINHTTP_PROXY_INFO(object): - """A tuple representing a WINHTTP_PROXY_INFO structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyWKSTA_INFO_100(object): - """A dictionary holding the infomation in a Win32 WKSTA_INFO_100 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def platform_id(self)->'Any': - """Indicates platform level to use to retrieve platform specific information""" - pass - - - @property - def computername(self)->'Union[str]': - """Name of the local computer""" - pass - - - @property - def langroup(self)->'Union[str]': - """Name of the domain to which computer belongs""" - pass - - - @property - def ver_major(self)->'Any': - """Major version number of operating system running on the computer""" - pass - - - @property - def ver_minor(self)->'Any': - """Minor version number of operating system running on the computer""" - pass - - -class PyWKSTA_INFO_101(object): - """A dictionary holding the infomation in a Win32 WKSTA_INFO_101 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def platform_id(self)->'Any': - """Indicates platform level to use to retrieve platform specific information""" - pass - - - @property - def computername(self)->'Union[str]': - """Name of the local computer""" - pass - - - @property - def langroup(self)->'Union[str]': - """Name of the domain to which computer belongs""" - pass - - - @property - def ver_major(self)->'Any': - """Major version number of operating system running on the computer""" - pass - - - @property - def ver_minor(self)->'Any': - """Minor version number of operating system running on the computer""" - pass - - - @property - def lanroot(self)->'Union[str]': - """Path to the LANMAN directory""" - pass - - -class PyWKSTA_INFO_102(object): - """A dictionary holding the infomation in a Win32 WKSTA_INFO_102 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def platform_id(self)->'Any': - """Indicate platform level to use to retrieve platform specific information""" - pass - - - @property - def computername(self)->'Union[str]': - """Name of the local computer""" - pass - - - @property - def langroup(self)->'Union[str]': - """Name of the domain to which computer belongs""" - pass - - - @property - def ver_major(self)->'Any': - """Major version number of operating system running on the computer""" - pass - - - @property - def ver_minor(self)->'Any': - """Minor version number of operating system running on the computer""" - pass - - - @property - def lanroot(self)->'Union[str]': - """Path to the LANMAN directory""" - pass - - - @property - def logged_on_users(self)->'Any': - """Number of users who are logged on to the local computer""" - pass - - -class PyWKSTA_INFO_302(object): - """A dictionary holding the infomation in a Win32 WKSTA_INFO_302 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def char_wait(self)->'Any': - """number of seconds the computer will wait for a remote resource to become available""" - pass - - - @property - def collection_time(self)->'Any': - """number of milliseconds the computer will collect data before sending the data to a character device resource. The workstation waits the specified time or collects the number of characters specified by wki302_maximum_collection_count, whichever comes first.""" - pass - - - @property - def maximum_collection_count(self)->'Any': - """Specifies the number of bytes of information the computer will collect before sending the data to a character device resource. The workstation collects the specified number of bytes or waits the time specified by wki302_collection_time, whichever comes first.""" - pass - - - @property - def keep_conn(self)->'Any': - """Specifies the number of seconds the server will maintain an inactive connection to a resource.""" - pass - - - @property - def keep_search(self)->'Any': - """Defines the number of seconds an inactive search will continue.""" - pass - - - @property - def max_cmds(self)->'Any': - """Specifies the number of simultaneous network device driver commands that can be sent to the network.""" - pass - - - @property - def num_work_buf(self)->'Any': - """Specifies the number of internal buffers the computer has.""" - pass - - - @property - def siz_work_buf(self)->'Any': - """Specifies the size, in bytes, of each internal buffer.""" - pass - - - @property - def max_wrk_cache(self)->'Any': - """Specifies the maximum size, in bytes, of an internal cache buffer.""" - pass - - - @property - def siz_error(self)->'Any': - """Specifies the size, in bytes, of an internal error buffer.""" - pass - - - @property - def num_alerts(self)->'Any': - """Specifies the maximum number of clients that can receive alert messages. (This member is not supported under MS-DOS.) The Alerter service registers at least three clients when it begins to run.""" - pass - - - @property - def num_services(self)->'Any': - """Specifies the number of services that can be installed on the computer at any time.""" - pass - - - @property - def errlog_sz(self)->'Any': - """Specifies the maximum size, in kilobytes, of the client's error log file.""" - pass - - - @property - def print_buf_time(self)->'Any': - """Specifies the number of seconds the server waits before closing inactive compatibility-mode print jobs.""" - pass - - - @property - def num_char_buf(self)->'Any': - """Specifies the number of character pipe buffers and device buffers the client can have.""" - pass - - - @property - def siz_char_buf(self)->'Any': - """Specifies the maximum size, in bytes, of a character pipe buffer and device buffer.""" - pass - - - @property - def wrk_heuristics(self)->'Union[str]': - """Pointer to a Unicode string of flags used to control a client's operation.""" - pass - - - @property - def mailslots(self)->'Any': - """Specifies the maximum number of mailslots allowed.""" - pass - - - @property - def num_dgram_buf(self)->'Any': - """Specifies the number of buffers to allocate for receiving datagrams.""" - pass - - -class PyWKSTA_INFO_402(object): - """A dictionary holding the infomation in a Win32 WKSTA_INFO_402 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def char_wait(self)->'Any': - """number of seconds the computer will wait for a remote resource to become available""" - pass - - - @property - def collection_time(self)->'Any': - """number of milliseconds the computer will collect data before sending the data to a character device resource. The workstation waits the specified time or collects the number of characters specified by wki402_maximum_collection_count, whichever comes first.""" - pass - - - @property - def maximum_collection_count(self)->'Union[str]': - """Name of the domain to which computer belongs""" - pass - - - @property - def keep_conn(self)->'Any': - """Major version number of operating system running on the computer""" - pass - - - @property - def keep_search(self)->'Any': - """Minor version number of operating system running on the computer""" - pass - - - @property - def max_cmds(self)->'Any': - """..""" - pass - - - @property - def num_work_buf(self)->'Any': - """Number of users who are logged on to the local computer""" - pass - - - @property - def siz_work_buf(self)->'Any': - """Number of users who are logged on to the local computer""" - pass - - - @property - def max_wrk_cache(self)->'Any': - """..""" - pass - - - @property - def sess_timeout(self)->'Any': - """..""" - pass - - - @property - def siz_error(self)->'Any': - """..""" - pass - - - @property - def num_alerts(self)->'Any': - """..""" - pass - - - @property - def num_services(self)->'Any': - """..""" - pass - - - @property - def errlog_sz(self)->'Any': - """..""" - pass - - - @property - def print_buf_time(self)->'Any': - """..""" - pass - - - @property - def num_char_buf(self)->'Any': - """..""" - pass - - - @property - def siz_char_buf(self)->'Any': - """Specifies the maximum size, in bytes, of a character pipe buffer and device buffer.""" - pass - - - @property - def mailslots(self)->'Any': - """..""" - pass - - - @property - def num_dgram_buf(self)->'Any': - """..""" - pass - - - @property - def max_threads(self)->'Any': - """Number of threads the computer can dedicate to the network""" - pass - - -class PyWKSTA_INFO_502(object): - """A dictionary holding the infomation in a Win32 WKSTA_INFO_502 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def char_wait(self)->'Any': - """number of seconds the computer will wait for a remote resource to become available""" - pass - - - @property - def collection_time(self)->'Any': - """number of milliseconds the computer will collect data before sending the data to a character device resource. The workstation waits the specified time or collects the number of characters specified by wki502_maximum_collection_count, whichever comes first.""" - pass - - - @property - def maximum_collection_count(self)->'Any': - """Specifies the number of bytes of information the computer will collect before sending the data to a character device resource. The workstation collects the specified number of bytes or waits the time specified by wki302_collection_time, whichever comes first.""" - pass - - - @property - def keep_conn(self)->'Any': - """Specifies the number of seconds the server will maintain an inactive connection to a resource.""" - pass - - - @property - def max_cmds(self)->'Any': - """Specifies the number of simultaneous network device driver commands that can be sent to the network.""" - pass - - - @property - def max_wrk_cache(self)->'Any': - """Indicates the number of seconds the server waits before disconnecting an inactive session.""" - pass - - - @property - def siz_char_buf(self)->'Any': - """Specifies the maximum size, in bytes, of a character pipe buffer and device buffer.""" - pass - - - @property - def lock_quota(self)->'Any': - """TODO""" - pass +class PySHARE_INFO_2(object): + """A dictionary holding the infomation in a Win32 SHARE_INFO_2 structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def lock_increment(self)->'Any': - """TODO""" - pass + @property + def netname(self) -> 'Union[str]': + """""" + pass + @property + def type(self) -> 'Any': + """""" + pass - @property - def lock_maximum(self)->'Any': - """TODO""" - pass + @property + def remark(self) -> 'Union[str]': + """""" + pass + @property + def permissions(self) -> 'Any': + """""" + pass - @property - def pipe_increment(self)->'Any': - """TODO""" - pass + @property + def max_uses(self) -> 'Any': + """""" + pass + @property + def current_uses(self) -> 'Any': + """""" + pass - @property - def pipe_maximum(self)->'Any': - """TODO""" - pass + @property + def path(self) -> 'Union[str]': + """""" + pass + @property + def passwd(self) -> 'Union[str]': + """""" + pass - @property - def cache_file_timeout(self)->'Any': - """TODO""" - pass +class PySHARE_INFO_501(object): + """A dictionary holding the infomation in a Win32 SHARE_INFO_501 structure.""" - @property - def dormant_file_limit(self)->'Any': - """TODO""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def netname(self) -> 'Union[str]': + """""" + pass - @property - def read_ahead_throughput(self)->'Any': - """TODO""" - pass + @property + def type(self) -> 'Any': + """""" + pass + @property + def remark(self) -> 'Union[str]': + """""" + pass - @property - def num_mailslot_buffers(self)->'Any': - """TODO""" - pass + @property + def flags(self) -> 'Any': + """""" + pass - @property - def num_srv_announce_buffers(self)->'Any': - """TODO""" - pass +class PySHARE_INFO_502(object): + """A dictionary holding the infomation in a Win32 SHARE_INFO_502 structure.""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def netname(self) -> 'Union[str]': + """""" + pass + + @property + def type(self) -> 'Any': + """""" + pass + + @property + def remark(self) -> 'Union[str]': + """""" + pass + + @property + def permissions(self) -> 'Any': + """""" + pass + + @property + def max_uses(self) -> 'Any': + """""" + pass + + @property + def current_uses(self) -> 'Any': + """""" + pass + + @property + def path(self) -> 'Union[str]': + """""" + pass + + @property + def passwd(self) -> 'Union[str]': + """""" + pass + + @property + def reserved(self) -> 'Any': + """""" + pass + + @property + def security_descriptor(self) -> 'PySECURITY_DESCRIPTOR': + """""" + pass - @property - def max_illegal_datagram_events(self)->'Any': - """TODO""" - pass +class PySID(object): + """A Python object, representing a SID structure""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def illegal_datagram_event_reset_frequency(self)->'Any': - """TODO""" - pass + def Initialize(self, idAuthority: 'Any', numSubauthorities: 'Any') -> 'None': + """ + Initialize the SID. +Args: - @property - def log_election_packets(self)->'Any': - """TODO""" - pass + idAuthority(Any):The identifier authority. + numSubauthorities(Any):The number of sub authorities to allocate. +Returns: - @property - def use_opportunistic_locking(self)->'Any': - """TODO""" - pass + None + """ + pass - @property - def use_unlock_behind(self)->'Any': - """TODO""" - pass + def IsValid(self,) -> 'None': + """ + Determines if the SID is valid. +Args: - @property - def use_close_behind(self)->'Any': - """TODO""" - pass - @property - def buf_named_pipes(self)->'Any': - """TODO""" - pass +Returns: + None - @property - def use_lock_read_unlock(self)->'Any': - """TODO""" - pass + """ + pass + def SetSubAuthority(self, index: 'Any', val: 'Any') -> 'None': + """ + Sets a SID SubAuthority - @property - def utilize_nt_caching(self)->'Any': - """TODO""" - pass +Args: + index(Any):The index of the sub authority to set + val(Any):The value for the sub authorityCommentsSee the function SetSidSubAuthority - @property - def use_raw_read(self)->'Any': - """TODO""" - pass +Returns: + None - @property - def use_raw_write(self)->'Any': - """TODO""" - pass + """ + pass + def GetLength(self,) -> 'Any': + """ + return length of SID (GetLengthSid). - @property - def use_write_raw_data(self)->'Any': - """TODO""" - pass +Args: - @property - def use_encryption(self)->'Any': - """TODO""" - pass +Returns: - @property - def buf_files_deny_write(self)->'Any': - """TODO""" - pass + Any + """ + pass - @property - def buf_read_only_files(self)->'Any': - """TODO""" - pass + def GetSubAuthorityCount(self,) -> 'Any': + """ + return nbr of subauthorities from SID +Args: - @property - def force_core_create_mode(self)->'Any': - """TODO""" - pass - @property - def use_512_byte_max_transfer(self)->'Any': - """TODO""" - pass +Returns: + Any -class PyWKSTA_TRANSPORT_INFO_0(object): - """A dictionary holding the infomation in a Win32 WKSTA_TRANSPORT_INFO_0 structure.""" + """ + pass - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def GetSubAuthority(self,) -> 'Any': + """ + Returns specified subauthority from SID +Args: - @property - def quality_of_service(self)->'Any': - """Supplies a value that specifies the search order of the transport protocol with respect to other transport protocols. The highest value is searched first.""" - pass - @property - def number_of_vcs(self)->'Any': - """Specifies the number of clients communicating with the server using this transport protocol.""" - pass +Returns: + Any - @property - def transport_name(self)->'Union[str]': - """Specifies the device name of the transport protocol.""" - pass + """ + pass + def GetSidIdentifierAuthority(self,) -> 'Tuple[Any, Any, Any, Any, Any, Any]': + """ + Returns a tuple of 6 SID_IDENTIFIER_AUTHORITY - @property - def transport_address(self)->'Union[str]': - """Specifies the address of the server on this transport protocol.""" - pass +constants +Args: - @property - def wan_ish(self)->'Any': - """This member is ignored by the NetWkstaTransportAdd function. For the NetWkstaTransportEnum function, this member indicates that this transport protocol is a WAN transport protocol. This member is set TRUE for NetBIOS/TCIP; it is set FALSE for NetBEUI and NetBIOS/IPX.""" - pass -class PyWKSTA_USER_INFO_0(object): - """A dictionary holding the infomation in a Win32 WKSTA_USER_INFO_0 structure.""" +Returns: - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + Tuple[Any, Any, Any, Any, Any, Any] + """ + pass - @property - def username(self)->'Union[str]': - """Name of user currently logged on to the workstation""" - pass +class PySID_AND_ATTRIBUTES(object): + """""" -class PyWKSTA_USER_INFO_1(object): - """A dictionary holding the infomation in a Win32 WKSTA_USER_INFO_1 structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PySIZE(object): + """Tuple of two ints (cx,cy) representing a SIZE struct""" - @property - def username(self)->'Union[str]': - """Name of user currently logged on to the workstation""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def logon_domain(self)->'Union[str]': - """Returns the domain name of the user account of the user currently logged on to the workstation.""" - pass +class PySMALL_RECT(object): + """Wrapper for a SMALL_RECT struct +Create using PySMALL_RECTType(Left, Top, Right, Bottom). All params optional, defaulting to 0""" - @property - def oth_domains(self)->'Union[str]': - """Returns the list of other operating system domains browsed by the workstation. The domain names are separated by blanks.""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def Left(self) -> 'Any': + """Left side of rectangle""" + pass - @property - def logon_server(self)->'Union[str]': - """Returns the name of the computer that authenticated the server.""" - pass + @property + def Top(self) -> 'Any': + """Top edge of rectangle""" + pass + @property + def Right(self) -> 'Any': + """Right edge of rectangle""" + pass -class PyWNDCLASS(object): - """A Python object, representing an WNDCLASS structure""" + @property + def Bottom(self) -> 'Any': + """Bottome edge of rectangle""" + pass - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PySTARTUPINFO(object): + """A Python object, representing an STARTUPINFO structure""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def dwX(self) -> 'int': + """Specifies the x offset, in pixels, of the upper left corner of a window if a new window is created. The offset is from the upper left corner of the screen.""" + pass + + @property + def dwY(self) -> 'int': + """Specifies the y offset, in pixels, of the upper left corner of a window if a new window is created. The offset is from the upper left corner of the screen.""" + pass + + @property + def dwXSize(self) -> 'int': + """Specifies the width, in pixels, of the window if a new window is created.""" + pass + + @property + def dwYSize(self) -> 'int': + """Specifies the height, in pixels, of the window if a new window is created.""" + pass + + @property + def dwXCountChars(self) -> 'int': + """For console processes, if a new console window is created, specifies the screen buffer width in character columns. This value is ignored in a GUI process.""" + pass + + @property + def dwYCountChars(self) -> 'int': + """For console processes, if a new console window is created, specifies the screen buffer height in character rows.""" + pass + + @property + def dwFillAttribute(self) -> 'int': + """Specifies the initial text and background colors if a new console window is created in a console application. These values are ignored in GUI applications""" + pass + + @property + def dwFlags(self) -> 'int': + """This is a bit field that determines whether certain STARTUPINFO attributes are used when the process creates a window. To use many of the additional attributes, you typically must set the appropriate mask in this attribute, and also set the attributes themselves. Any combination of the win32con.STARTF_* flags can be specified.""" + pass + + @property + def wShowWindow(self) -> 'int': + """Can be any of the SW_ constants defined in win32con. For GUI processes, this specifies the default value the first time ShowWindow is called.""" + pass + + @property + def hStdInput(self) -> 'Union[int]': + """""" + pass + + @property + def hStdOutput(self) -> 'Union[int]': + """""" + pass + + @property + def hStdError(self) -> 'Union[int]': + """""" + pass + + @property + def lpDesktop(self) -> 'Union[Any, str]': + """""" + pass + + @property + def lpTitle(self) -> 'Union[Any, str]': + """""" + pass - @property - def style(self)->'int': - """""" - pass +class PySecBuffer(object): + """Python object wrapping a SecBuffer structure - @property - def cbWndExtra(self)->'int': - """""" - pass +Created using win32security.PySecBufferType(type,size) where type is a SECBUFFER_* constant""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def hInstance(self)->'int': - """""" - pass + @property + def BufferType(self) -> 'Any': + """""" + pass + @property + def Buffer(self) -> 'str': + """""" + pass - @property - def hIcon(self)->'int': - """""" - pass + @property + def BufferSize(self) -> 'Any': + """""" + pass + @property + def MaxBufferSize(self) -> 'Any': + """""" + pass - @property - def hCursor(self)->'int': - """""" - pass + def Clear(self,) -> 'None': + """ + Resets the buffer to all NULL's, and set the current size to maximum +Args: - @property - def hbrBackground(self)->'int': - """These 3 handled manually in PyWNDCLASS::getattro/setattro. The pymeth below is used as an end tag, so these props will be lost if below it""" - pass - @property - def lpszMenuName(self)->'Union[str]': - """""" - pass +Returns: + None - @property - def lpszClassName(self)->'Union[str]': - """""" - pass + """ + pass - @property - def lpfnWndProc(self)->'Any': - """MethodsSetDialogProcSets the WNDCLASS to be for a dialog box. """ - pass +class PySecBufferDesc(object): + """Sequence-like object that contains a group of buffers to be used with SSPI functions.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def SetDialogProc(self,) -> 'None': - """ - Sets the WNDCLASS to be for a dialog box + def append(self, buffer: 'Any') -> 'None': + """ + None Args: - + buffer(Any):PySecBuffer object to be attached to the group of buffers Returns: None - - """ - pass + """ + pass -class PyXFORM(object): - """Dict representing an XFORM struct used as a world transformation matrix -All members are optional, defaulting to 0.0.""" +class PyTOKEN_GROUPS(object): + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def M11(self)->'float': - """Usage is dependent on operation performed, see MSDN docs""" - pass +class PyTOKEN_PRIVILEGES(object): + """An object representing Win32 token privileges.""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def M12(self)->'float': - """Usage is dependent on operation performed, see MSDN docs""" - pass +class PyTRIVERTEX(object): + """Dict representing a TRIVERTEX struct containing color information at a point""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def M21(self)->'float': - """Usage is dependent on operation performed, see MSDN docs""" - pass + @property + def x(self) -> 'Any': + """X coord in logical units""" + pass + @property + def y(self) -> 'Any': + """Y coord in logical units""" + pass - @property - def M22(self)->'float': - """Usage is dependent on operation performed, see MSDN docs""" - pass + @property + def Red(self) -> 'Any': + """Red component""" + pass + @property + def Green(self) -> 'Any': + """Green component""" + pass - @property - def Dx(self)->'float': - """Horizontal offset in logical units""" - pass + @property + def Blue(self) -> 'Any': + """Blue component""" + pass + @property + def Alpha(self) -> 'Any': + """Transparency value""" + pass - @property - def Dy(self)->'float': - """Vertical offset in logical units""" - pass +class PyTRUSTEE(object): + """A dictionary representing a TRUSTEE structure.""" -class Pymmapfile(object): - """Object that provides access to memory-mapped file operations.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + @property + def TrusteeForm(self) -> 'Any': + """""" + pass + @property + def TrusteeType(self) -> 'Any': + """""" + pass - def close(self,) -> 'None': - """ - Closes the file mapping handle and releases mapped view + @property + def Identifier(self) -> 'Any': + """Depends on the value of TrusteeForm (string or sid)""" + pass -Args: + @property + def MultipleTrustee(self) -> 'Any': + """default is None""" + pass + @property + def MultipleTrusteeOperation(self) -> 'Any': + """default is None""" + pass -Returns: +class PyTS_HANDLE(object): + """Handle to a Terminal Server""" - None - - """ - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def find(self,needle:'Any',start:'Any') -> 'Any': - """ - Finds a string in the buffer. +class PyTime(object): + """A Python object, representing an instant in time.""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def year(self) -> 'Any': + """""" + pass + + @property + def month(self) -> 'Any': + """""" + pass + + @property + def weekday(self) -> 'Any': + """""" + pass + + @property + def day(self) -> 'Any': + """""" + pass + + @property + def hour(self) -> 'Any': + """""" + pass + + @property + def minute(self) -> 'Any': + """""" + pass + + @property + def second(self) -> 'Any': + """""" + pass + + @property + def msec(self) -> 'Any': + """""" + pass + + def Format(self, _format: 'str') -> 'str': + """ + Formats the time value. Args: - needle(Any):String to be located - start(Any):Pos at which to start search, current pos assumed if not specifiedReturn ValueReturns pos of string, or -1 if not found + _format(str):The format. See the comments section for a description of the supported flags.CommentsThe following format characters are supported.CharacterDescription%aAbbreviated weekday name%AFull weekday name%bAbbreviated month name%BFull month name%cDate and time representation appropriate for locale%dDay of month as decimal number (01 - 31)%HHour in 24-hour format (00 - 23)%IHour in 12-hour format (01 - 12)%jDay of year as decimal number (001 - 366)%mMonth as decimal number (01 - 12)%MMinute as decimal number (00 - 59)%pCurrent locale's A.M./P.M. indicator for 12-hour clock%SSecond as decimal number (00 - 59)%UWeek of year as decimal number, with Sunday as first day of week (00 - 51)%wWeekday as decimal number (0 - 6; Sunday is 0)%WWeek of year as decimal number, with Monday as first day of week (00 - 51)%xDate representation for current locale%XTime representation for current locale%yYear without century, as decimal number (00 - 99)%YYear with century, as decimal number%z, %ZTime-zone name or abbreviation; no characters if time zone is unknown%%Percent signAs in the printf function, the # flag may prefix any formatting code. In that case, the meaning of the format code is changed as follows.Format CodeMeaning%#a, %#A, %#b, %#B, %#p, %#X, %#z, %#Z, %#%# flag is ignored.%#cLong date and time representation, appropriate for current locale. For example: "Tuesday, March 14, 1995, 12:41:29".%#xLong date representation, appropriate to current locale. For example: "Tuesday, March 14, 1995".%#d, %#H, %#I, %#j, %#m, %#M, %#S, %#U, %#w, %#W, %#y, %#YRemove leading zeros (if any). Returns: - Any:Pos at which to start search, current pos assumed if not specifiedReturn ValueReturns pos of string, or -1 if not found + str - - """ - pass + """ + pass - def flush(self,offset:'Any'=0,size:'Any'=0) -> 'None': - """ - Flushes memory buffer to disk +class PyUSER_INFO_0(object): + """A dictionary holding the information in a Win32 USER_INFO_0 structure.""" -Args: + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - offset(Any):Position in buffer at which to flush - size(Any):Number of bytes to flush, 0 to flush remainder of buffer past the offset + @property + def name(self) -> 'Union[str]': + """""" + pass -Returns: - None - - """ - pass +class PyUSER_INFO_1(object): + """A dictionary holding the information in a Win32 USER_INFO_1 structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def move(self,dest:'Any',src:'Any',count:'Any') -> 'None': - """ - Moves data from one place in buffer to another + @property + def name(self) -> 'Union[str]': + """""" + pass -Args: + @property + def password(self) -> 'Union[str]': + """""" + pass - dest(Any):Destination position in buffer - src(Any):Source position in buffer - count(Any):Number of bytes to move + @property + def password_age(self) -> 'Any': + """""" + pass -Returns: + @property + def priv(self) -> 'Any': + """""" + pass - None - - """ - pass + @property + def home_dir(self) -> 'Union[str]': + """""" + pass + @property + def comment(self) -> 'Union[str]': + """""" + pass - def read(self,num_bytes:'Any') -> 'Any': - """ - Returns specified number of bytes from buffer, and advances current position + @property + def flags(self) -> 'Any': + """""" + pass -Args: + @property + def script_path(self) -> 'Union[str]': + """""" + pass - num_bytes(Any):Number of bytes to read -Returns: +class PyUSER_INFO_10(object): + """A dictionary holding the information in a Win32 USER_INFO_10 structure.""" - Any - - """ - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def name(self) -> 'Union[str]': + """""" + pass - def read_byte(self,) -> 'Any': - """ - Reads a single character from current pos + @property + def comment(self) -> 'Union[str]': + """""" + pass -Args: + @property + def usr_comment(self) -> 'Union[str]': + """""" + pass + @property + def full_name(self) -> 'Union[str]': + """""" + pass -Returns: +class PyUSER_INFO_1003(object): + """A dictionary holding the information in a Win32 USER_INFO_1003 structure.""" - Any - - """ - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def password(self) -> 'Union[str]': + """""" + pass - def read_line(self,) -> 'Any': - """ - Reads data from current pos up to next EOL. -Args: +class PyUSER_INFO_1005(object): + """A dictionary holding the information in a Win32 USER_INFO_1005 structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def priv(self) -> 'Any': + """""" + pass -Returns: - Any - - """ - pass +class PyUSER_INFO_1006(object): + """A dictionary holding the information in a Win32 USER_INFO_1006 structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def resize(self,MaximumSize:'Any',FileOffset:'Any'=0,NumberOfBytesToMap:'Any'=0) -> 'None': - """ - Resizes the file mapping and view. + @property + def home_dir(self) -> 'Union[str]': + """""" + pass -Args: - MaximumSize(Any):New size for file mapping. Use a multiple of system page size (see win32api::GetSystemInfo) - FileOffset(Any):Offset into file mapping. Must be multiple of allocation granularity. - NumberOfBytesToMap(Any):New view size. Specify a multiple of system page size.CommentsIf MaximumSize is 0, only the mapped view will be affected.Accepts keyword args. +class PyUSER_INFO_1007(object): + """A dictionary holding the information in a Win32 USER_INFO_1007 structure.""" -Returns: + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - None - - """ - pass + @property + def comment(self) -> 'Union[str]': + """""" + pass - def seek(self,dist:'Any',how:'Any'=0) -> 'None': - """ - Changes current position +class PyUSER_INFO_1008(object): + """A dictionary holding the information in a Win32 USER_INFO_1008 structure.""" -Args: + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - dist(Any):Distance to seek - how(Any):Pos from which to seekhowmeaning0Seek from start of buffer1Seek from current position2Seek backwards from end of buffer + @property + def flags(self) -> 'Any': + """""" + pass -Returns: - None - - """ - pass +class PyUSER_INFO_1009(object): + """A dictionary holding the information in a Win32 USER_INFO_1009 structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def size(self,) -> 'Any': - """ - Returns size of current view + @property + def script_path(self) -> 'Union[str]': + """""" + pass -Args: +class PyUSER_INFO_1010(object): + """A dictionary holding the information in a Win32 USER_INFO_1010 structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') -Returns: + @property + def auth_flags(self) -> 'Any': + """""" + pass - Any - - """ - pass +class PyUSER_INFO_1011(object): + """A dictionary holding the information in a Win32 USER_INFO_1011 structure.""" - def tell(self,) -> 'Any': - """ - Returns current position in buffer + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') -Args: + @property + def full_name(self) -> 'Union[str]': + """""" + pass +class PyUSER_INFO_11(object): + """A dictionary holding the information in a Win32 USER_INFO_11 structure.""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def name(self) -> 'Union[str]': + """""" + pass + + @property + def comment(self) -> 'Union[str]': + """""" + pass + + @property + def usr_comment(self) -> 'Union[str]': + """""" + pass + + @property + def full_name(self) -> 'Union[str]': + """""" + pass + + @property + def priv(self) -> 'Any': + """""" + pass + + @property + def auth_flags(self) -> 'Any': + """""" + pass + + @property + def password_age(self) -> 'Any': + """""" + pass + + @property + def home_dir(self) -> 'Union[str]': + """""" + pass + + @property + def parms(self) -> 'Union[str]': + """""" + pass + + @property + def last_logon(self) -> 'Any': + """""" + pass + + @property + def last_logoff(self) -> 'Any': + """""" + pass + + @property + def bad_pw_count(self) -> 'Any': + """""" + pass + + @property + def num_logons(self) -> 'Any': + """""" + pass + + @property + def logon_server(self) -> 'Union[str]': + """""" + pass + + @property + def country_code(self) -> 'Any': + """""" + pass + + @property + def workstations(self) -> 'Union[str]': + """""" + pass + + @property + def max_storage(self) -> 'Any': + """""" + pass + + @property + def units_per_week(self) -> 'Any': + """""" + pass + + @property + def logon_hours(self) -> 'str': + """""" + pass + + @property + def code_page(self) -> 'Any': + """""" + pass -Returns: - Any - - """ - pass +class PyUSER_INFO_2(object): + """A dictionary holding the information in a Win32 USER_INFO_2 structure.""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def name(self) -> 'Union[str]': + """""" + pass + + @property + def password(self) -> 'Union[str]': + """""" + pass + + @property + def password_age(self) -> 'Any': + """""" + pass + + @property + def priv(self) -> 'Any': + """""" + pass + + @property + def home_dir(self) -> 'Union[str]': + """""" + pass + + @property + def comment(self) -> 'Union[str]': + """""" + pass + + @property + def flags(self) -> 'Any': + """""" + pass + + @property + def script_path(self) -> 'Union[str]': + """""" + pass + + @property + def auth_flags(self) -> 'Any': + """""" + pass + + @property + def full_name(self) -> 'Union[str]': + """""" + pass + + @property + def usr_comment(self) -> 'Union[str]': + """""" + pass + + @property + def parms(self) -> 'Union[str]': + """""" + pass + + @property + def workstations(self) -> 'Union[str]': + """""" + pass + + @property + def last_logon(self) -> 'Any': + """""" + pass + + @property + def last_logoff(self) -> 'Any': + """""" + pass + + @property + def acct_expires(self) -> 'Any': + """""" + pass + + @property + def max_storage(self) -> 'Any': + """""" + pass + + @property + def units_per_week(self) -> 'Any': + """""" + pass + + @property + def logon_hours(self) -> 'str': + """""" + pass + + @property + def bad_pw_count(self) -> 'Any': + """""" + pass + + @property + def num_logons(self) -> 'Any': + """""" + pass + + @property + def logon_server(self) -> 'Union[str]': + """""" + pass + + @property + def country_code(self) -> 'Any': + """""" + pass + + @property + def code_page(self) -> 'Any': + """""" + pass - def write(self,data:'Any') -> 'None': - """ - Places data at current pos in buffer. +class PyUSER_INFO_20(object): + """A dictionary holding the information in a Win32 USER_INFO_20 structure.""" -Args: + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - data(Any):Data to be written + @property + def name(self) -> 'Union[str]': + """""" + pass -Returns: + @property + def full_name(self) -> 'Union[str]': + """""" + pass - None - - """ - pass + @property + def comment(self) -> 'Union[str]': + """""" + pass + @property + def flags(self) -> 'Any': + """""" + pass - def write_byte(self,char:'Any') -> 'None': - """ - Writes a single character of data + @property + def user_id(self) -> 'Any': + """""" + pass -Args: - char(Any):Single byte to be placed in buffer +class PyUSER_INFO_3(object): + """A dictionary holding the information in a Win32 USER_INFO_3 structure.""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def name(self) -> 'Union[str]': + """""" + pass + + @property + def password(self) -> 'Union[str]': + """""" + pass + + @property + def password_age(self) -> 'Any': + """""" + pass + + @property + def priv(self) -> 'Any': + """""" + pass + + @property + def home_dir(self) -> 'Union[str]': + """""" + pass + + @property + def comment(self) -> 'Union[str]': + """""" + pass + + @property + def flags(self) -> 'Any': + """""" + pass + + @property + def script_path(self) -> 'Union[str]': + """""" + pass + + @property + def auth_flags(self) -> 'Any': + """""" + pass + + @property + def full_name(self) -> 'Union[str]': + """""" + pass + + @property + def usr_comment(self) -> 'Union[str]': + """""" + pass + + @property + def parms(self) -> 'Union[str]': + """""" + pass + + @property + def workstations(self) -> 'Union[str]': + """""" + pass + + @property + def last_logon(self) -> 'Any': + """""" + pass + + @property + def last_logoff(self) -> 'Any': + """""" + pass + + @property + def acct_expires(self) -> 'Any': + """""" + pass + + @property + def max_storage(self) -> 'Any': + """""" + pass + + @property + def units_per_week(self) -> 'Any': + """""" + pass + + @property + def logon_hours(self) -> 'str': + """""" + pass + + @property + def bad_pw_count(self) -> 'Any': + """""" + pass + + @property + def num_logons(self) -> 'Any': + """""" + pass + + @property + def logon_server(self) -> 'Union[str]': + """""" + pass + + @property + def country_code(self) -> 'Any': + """""" + pass + + @property + def code_page(self) -> 'Any': + """""" + pass + + @property + def user_id(self) -> 'Any': + """""" + pass + + @property + def primary_group_id(self) -> 'Any': + """""" + pass + + @property + def profile(self) -> 'Union[str]': + """""" + pass + + @property + def home_dir_drive(self) -> 'Union[str]': + """""" + pass + + @property + def password_expired(self) -> 'Any': + """""" + pass -Returns: - None - - """ - pass +class PyUSER_INFO_4(object): + """A dictionary holding the information in a Win32 USER_INFO_4 structure.""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def name(self) -> 'Union[str]': + """""" + pass + + @property + def password(self) -> 'Union[str]': + """""" + pass + + @property + def password_age(self) -> 'Any': + """""" + pass + + @property + def priv(self) -> 'Any': + """""" + pass + + @property + def home_dir(self) -> 'Union[str]': + """""" + pass + + @property + def comment(self) -> 'Union[str]': + """""" + pass + + @property + def flags(self) -> 'Any': + """""" + pass + + @property + def script_path(self) -> 'Union[str]': + """""" + pass + + @property + def auth_flags(self) -> 'Any': + """""" + pass + + @property + def full_name(self) -> 'Union[str]': + """""" + pass + + @property + def usr_comment(self) -> 'Union[str]': + """""" + pass + + @property + def parms(self) -> 'Union[str]': + """""" + pass + + @property + def workstations(self) -> 'Union[str]': + """""" + pass + + @property + def last_logon(self) -> 'Any': + """""" + pass + + @property + def last_logoff(self) -> 'Any': + """""" + pass + + @property + def acct_expires(self) -> 'Any': + """""" + pass + + @property + def max_storage(self) -> 'Any': + """""" + pass + + @property + def units_per_week(self) -> 'Any': + """""" + pass + + @property + def logon_hours(self) -> 'str': + """""" + pass + + @property + def bad_pw_count(self) -> 'Any': + """""" + pass + + @property + def num_logons(self) -> 'Any': + """""" + pass + + @property + def logon_server(self) -> 'Union[str]': + """""" + pass + + @property + def country_code(self) -> 'Any': + """""" + pass + + @property + def code_page(self) -> 'Any': + """""" + pass + + @property + def user_sid(self) -> 'PySID': + """""" + pass + + @property + def primary_group_id(self) -> 'Any': + """""" + pass + + @property + def profile(self) -> 'Union[str]': + """""" + pass + + @property + def home_dir_drive(self) -> 'Union[str]': + """""" + pass + + @property + def password_expired(self) -> 'Any': + """""" + pass -class RASDIALEXTENSIONS(object): - """An object that describes a Win32 RASDIALEXTENSIONS structure +class PyUSER_MODALS_INFO_0(object): + """A dictionary holding the information in a Win32 USER_MODALS_INFO_0 structure.""" -TRUE*/)""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + @property + def min_passwd_len(self) -> 'Any': + """""" + pass + @property + def max_passwd_age(self) -> 'Any': + """""" + pass - @property - def dwfOptions(self)->'int': - """(fOptions may also be used)""" - pass + @property + def min_passwd_age(self) -> 'Any': + """""" + pass + @property + def force_logoff(self) -> 'Any': + """""" + pass - @property - def hwndParent(self)->'int': - """""" - pass + @property + def password_hist_len(self) -> 'Any': + """""" + pass - @property - def reserved(self)->'int': - """""" - pass +class PyUSER_MODALS_INFO_1(object): + """A dictionary holding the information in a Win32 USER_MODALS_INFO_1 structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def reserved1(self)->'int': - """""" - pass + @property + def role(self) -> 'Any': + """""" + pass + @property + def primary(self) -> 'Union[str]': + """""" + pass - @property - def RasEapInfo(self)->'Any': - """""" - pass +class PyUSER_MODALS_INFO_2(object): + """A dictionary holding the information in a Win32 USER_MODALS_INFO_2 structure.""" -class RASDIALPARAMS(object): - """A tuple that describes a Win32 RASDIALPARAMS structure""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + @property + def domain_name(self) -> 'Union[str]': + """""" + pass + @property + def domain_id(self) -> 'PySID': + """""" + pass -class SC_ACTION(object): - """Tuple of 2 ints (Type,Delay) used to represent an SC_ACTION structure""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyUSER_MODALS_INFO_3(object): + """A dictionary holding the information in a Win32 USER_MODALS_INFO_3 structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def Type(self)->'Any': - """One of SC_ACTION_NONE, SC_ACTION_REBOOT, SC_ACTION_RESTART, SC_ACTION_RUN_COMMAND""" - pass + @property + def lockout_duration(self) -> 'Any': + """""" + pass + @property + def lockout_observation_window(self) -> 'Any': + """""" + pass - @property - def Delay(self)->'Any': - """Time delay before specified action is taken (in milliseconds)""" - pass + @property + def usrmod3_lockout_threshold(self) -> 'Any': + """""" + pass -class SERVICE_FAILURE_ACTIONS(object): - """A dictionary representing a SERVICE_FAILURE_ACTIONS structure""" +class PyUSE_INFO_0(object): + """A dictionary holding the infomation in a Win32 USE_INFO_0 structure.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def local(self) -> 'Union[str]': + """""" + pass - @property - def ResetPeriod(self)->'Any': - """Indicates how many seconds to wait to reset the failure count, can be INFINITE""" - pass + @property + def remote(self) -> 'Union[str]': + """""" + pass - @property - def RebootMsg(self)->'Union[Any, str]': - """Message displayed when reboot action is taken""" - pass +class PyUSE_INFO_1(object): + """A dictionary holding the infomation in a Win32 USE_INFO_1 structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def Command(self)->'Union[Any, str]': - """Command line to execute for SC_ACTION_RUN_COMMAND""" - pass + @property + def local(self) -> 'Union[str]': + """""" + pass + @property + def remote(self) -> 'Union[str]': + """""" + pass - @property - def Actions(self)->'Any': - """A tuple of SC_ACTION tuples""" - pass + @property + def password(self) -> 'Union[Any, str]': + """""" + pass + @property + def status(self) -> 'Any': + """""" + pass -class SERVICE_STATUS(object): - """A Win32 service status object is represented by a tuple:""" + @property + def asg_type(self) -> 'Any': + """""" + pass - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + @property + def refcount(self) -> 'Any': + """""" + pass + @property + def usecount(self) -> 'Any': + """""" + pass -class TRACKMOUSEEVENT(object): - """A tuple of (dwFlags, hwndTrack, dwHoverTime)""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyUSE_INFO_2(object): + """A dictionary holding the infomation in a Win32 USE_INFO_2 structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') -class ULARGE_INTEGER(object): - """A Python object used wherever a COM ULARGE_INTEGER is used.""" + @property + def local(self) -> 'Union[str]': + """""" + pass - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + @property + def remote(self) -> 'Union[str]': + """""" + pass + @property + def password(self) -> 'Union[Any, str]': + """""" + pass -class WIN32_FIND_DATA(object): - """A tuple representing a WIN32_FIND_DATA structure.""" + @property + def status(self) -> 'Any': + """""" + pass - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + @property + def asg_type(self) -> 'Any': + """""" + pass + @property + def refcount(self) -> 'Any': + """""" + pass -class com_error(object): - """An exception raised when a COM exception occurs.""" + @property + def usecount(self) -> 'Any': + """""" + pass - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + @property + def username(self) -> 'Union[str]': + """""" + pass + @property + def domainname(self) -> 'Union[str]': + """""" + pass -class connection(object): - """An object representing an ODBC connection""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyUSE_INFO_3(object): + """A dictionary holding the infomation in a Win32 USE_INFO_3 structure.""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def local(self) -> 'Union[str]': + """""" + pass + + @property + def remote(self) -> 'Union[str]': + """""" + pass + + @property + def password(self) -> 'Union[Any, str]': + """""" + pass + + @property + def status(self) -> 'Any': + """""" + pass + + @property + def asg_type(self) -> 'Any': + """""" + pass + + @property + def refcount(self) -> 'Any': + """""" + pass + + @property + def usecount(self) -> 'Any': + """""" + pass + + @property + def username(self) -> 'Union[str]': + """""" + pass + + @property + def domainname(self) -> 'Union[str]': + """""" + pass + + @property + def flags(self) -> 'Any': + """""" + pass - def setautocommit(self,c:'Any') -> 'None': - """ - Sets the autocommit mode. +class PyUnicode(object): + """A Python object, representing a Unicode string.""" -Args: + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - c(Any):The boolean autocommit mode. -Returns: +class PyUrlCacheHANDLE(object): + """""" - None - - """ - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def commit(self,) -> 'None': - """ - Commits a transaction. +class PyWAVEFORMATEX(object): + """A Python object, representing a WAVEFORMATEX structure""" -Args: + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def wFormatTag(self) -> 'int': + """Waveform-audio format type. pywintypes only defines WAVE_FORMAT_PCM as a constant. Other values must be looked up in the mmsystem.h header file.""" + pass + @property + def nChannels(self) -> 'int': + """Number of channels. 1 for Mono, 2 for Stereo, anything, but never 5.1.""" + pass -Returns: + @property + def nSamplesPerSec(self) -> 'int': + """Sample rate, in samples per second (hertz), that each channel should be played or recorded. If wFormatTag is WAVE_FORMAT_PCM, then common values for nSamplesPerSec are 8000, 11025, 22050, and 44100 Hz""" + pass - None - - """ - pass + @property + def nAvgBytesPerSec(self) -> 'int': + """Required average data-transfer rate, in bytes per second, for the format tag. If wFormatTag is WAVE_FORMAT_PCM, nAvgBytesPerSec should be equal to the product of nSamplesPerSec and nBlockAlign.""" + pass + @property + def nBlockAlign(self) -> 'int': + """Block alignment, in bytes. The block alignment is the minimum atomic unit of data for the wFormatTag format type. If wFormatTag is WAVE_FORMAT_PCM, nBlockAlign should be equal to the product of nChannels and wBitsPerSample divided by 8 (bits per byte). For non-PCM formats, this member must be computed according to the manufacturer’s specification of the format tag.""" + pass - def rollback(self,) -> 'None': - """ - Rollsback a transaction. + @property + def wBitsPerSample(self) -> 'int': + """Bits per sample for the wFormatTag format type. If wFormatTag is WAVE_FORMAT_PCM, then wBitsPerSample should be equal to 8 or 16. Sentinel""" + pass -Args: +class PyWINHTTP_AUTOPROXY_OPTIONS(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') -Returns: - None - - """ - pass +class PyWINHTTP_PROXY_INFO(object): + """A tuple representing a WINHTTP_PROXY_INFO structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def cursor(self,) -> 'None': - """ - None -Args: +class PyWKSTA_INFO_100(object): + """A dictionary holding the infomation in a Win32 WKSTA_INFO_100 structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def platform_id(self) -> 'Any': + """Indicates platform level to use to retrieve platform specific information""" + pass -Returns: + @property + def computername(self) -> 'Union[str]': + """Name of the local computer""" + pass - None - - """ - pass + @property + def langroup(self) -> 'Union[str]': + """Name of the domain to which computer belongs""" + pass + @property + def ver_major(self) -> 'Any': + """Major version number of operating system running on the computer""" + pass - def close(self,) -> 'None': - """ - Closes the connection. + @property + def ver_minor(self) -> 'Any': + """Minor version number of operating system running on the computer""" + pass -Args: +class PyWKSTA_INFO_101(object): + """A dictionary holding the infomation in a Win32 WKSTA_INFO_101 structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') -Returns: + @property + def platform_id(self) -> 'Any': + """Indicates platform level to use to retrieve platform specific information""" + pass - None - - """ - pass + @property + def computername(self) -> 'Union[str]': + """Name of the local computer""" + pass + @property + def langroup(self) -> 'Union[str]': + """Name of the domain to which computer belongs""" + pass -class cursor(object): - """An object representing an ODBC cursor.""" + @property + def ver_major(self) -> 'Any': + """Major version number of operating system running on the computer""" + pass - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + @property + def ver_minor(self) -> 'Any': + """Minor version number of operating system running on the computer""" + pass + @property + def lanroot(self) -> 'Union[str]': + """Path to the LANMAN directory""" + pass - def close(self,) -> 'None': - """ - Closes the cursor -Args: +class PyWKSTA_INFO_102(object): + """A dictionary holding the infomation in a Win32 WKSTA_INFO_102 structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def platform_id(self) -> 'Any': + """Indicate platform level to use to retrieve platform specific information""" + pass -Returns: + @property + def computername(self) -> 'Union[str]': + """Name of the local computer""" + pass - None - - """ - pass + @property + def langroup(self) -> 'Union[str]': + """Name of the domain to which computer belongs""" + pass + + @property + def ver_major(self) -> 'Any': + """Major version number of operating system running on the computer""" + pass + + @property + def ver_minor(self) -> 'Any': + """Minor version number of operating system running on the computer""" + pass + @property + def lanroot(self) -> 'Union[str]': + """Path to the LANMAN directory""" + pass - def execute(self,sql:'str',arg:'Any') -> 'Any': - """ - Execute some SQL + @property + def logged_on_users(self) -> 'Any': + """Number of users who are logged on to the local computer""" + pass -Args: - sql(str):The SQL to execute - arg(Any):Input variables. +class PyWKSTA_INFO_302(object): + """A dictionary holding the infomation in a Win32 WKSTA_INFO_302 structure.""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def char_wait(self) -> 'Any': + """number of seconds the computer will wait for a remote resource to become available""" + pass + + @property + def collection_time(self) -> 'Any': + """number of milliseconds the computer will collect data before sending the data to a character device resource. The workstation waits the specified time or collects the number of characters specified by wki302_maximum_collection_count, whichever comes first.""" + pass + + @property + def maximum_collection_count(self) -> 'Any': + """Specifies the number of bytes of information the computer will collect before sending the data to a character device resource. The workstation collects the specified number of bytes or waits the time specified by wki302_collection_time, whichever comes first.""" + pass + + @property + def keep_conn(self) -> 'Any': + """Specifies the number of seconds the server will maintain an inactive connection to a resource.""" + pass + + @property + def keep_search(self) -> 'Any': + """Defines the number of seconds an inactive search will continue.""" + pass + + @property + def max_cmds(self) -> 'Any': + """Specifies the number of simultaneous network device driver commands that can be sent to the network.""" + pass + + @property + def num_work_buf(self) -> 'Any': + """Specifies the number of internal buffers the computer has.""" + pass + + @property + def siz_work_buf(self) -> 'Any': + """Specifies the size, in bytes, of each internal buffer.""" + pass + + @property + def max_wrk_cache(self) -> 'Any': + """Specifies the maximum size, in bytes, of an internal cache buffer.""" + pass + + @property + def siz_error(self) -> 'Any': + """Specifies the size, in bytes, of an internal error buffer.""" + pass + + @property + def num_alerts(self) -> 'Any': + """Specifies the maximum number of clients that can receive alert messages. (This member is not supported under MS-DOS.) The Alerter service registers at least three clients when it begins to run.""" + pass + + @property + def num_services(self) -> 'Any': + """Specifies the number of services that can be installed on the computer at any time.""" + pass + + @property + def errlog_sz(self) -> 'Any': + """Specifies the maximum size, in kilobytes, of the client's error log file.""" + pass + + @property + def print_buf_time(self) -> 'Any': + """Specifies the number of seconds the server waits before closing inactive compatibility-mode print jobs.""" + pass + + @property + def num_char_buf(self) -> 'Any': + """Specifies the number of character pipe buffers and device buffers the client can have.""" + pass + + @property + def siz_char_buf(self) -> 'Any': + """Specifies the maximum size, in bytes, of a character pipe buffer and device buffer.""" + pass + + @property + def wrk_heuristics(self) -> 'Union[str]': + """Pointer to a Unicode string of flags used to control a client's operation.""" + pass + + @property + def mailslots(self) -> 'Any': + """Specifies the maximum number of mailslots allowed.""" + pass + + @property + def num_dgram_buf(self) -> 'Any': + """Specifies the number of buffers to allocate for receiving datagrams.""" + pass -Returns: - Any - - """ - pass +class PyWKSTA_INFO_402(object): + """A dictionary holding the infomation in a Win32 WKSTA_INFO_402 structure.""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def char_wait(self) -> 'Any': + """number of seconds the computer will wait for a remote resource to become available""" + pass + + @property + def collection_time(self) -> 'Any': + """number of milliseconds the computer will collect data before sending the data to a character device resource. The workstation waits the specified time or collects the number of characters specified by wki402_maximum_collection_count, whichever comes first.""" + pass + + @property + def maximum_collection_count(self) -> 'Union[str]': + """Name of the domain to which computer belongs""" + pass + + @property + def keep_conn(self) -> 'Any': + """Major version number of operating system running on the computer""" + pass + + @property + def keep_search(self) -> 'Any': + """Minor version number of operating system running on the computer""" + pass + + @property + def max_cmds(self) -> 'Any': + """..""" + pass + + @property + def num_work_buf(self) -> 'Any': + """Number of users who are logged on to the local computer""" + pass + + @property + def siz_work_buf(self) -> 'Any': + """Number of users who are logged on to the local computer""" + pass + + @property + def max_wrk_cache(self) -> 'Any': + """..""" + pass + + @property + def sess_timeout(self) -> 'Any': + """..""" + pass + + @property + def siz_error(self) -> 'Any': + """..""" + pass + + @property + def num_alerts(self) -> 'Any': + """..""" + pass + + @property + def num_services(self) -> 'Any': + """..""" + pass + + @property + def errlog_sz(self) -> 'Any': + """..""" + pass + + @property + def print_buf_time(self) -> 'Any': + """..""" + pass + + @property + def num_char_buf(self) -> 'Any': + """..""" + pass + + @property + def siz_char_buf(self) -> 'Any': + """Specifies the maximum size, in bytes, of a character pipe buffer and device buffer.""" + pass + + @property + def mailslots(self) -> 'Any': + """..""" + pass + + @property + def num_dgram_buf(self) -> 'Any': + """..""" + pass + + @property + def max_threads(self) -> 'Any': + """Number of threads the computer can dedicate to the network""" + pass - def fetchone(self,) -> 'Any': - """ - Fetch one row of data +class PyWKSTA_INFO_502(object): + """A dictionary holding the infomation in a Win32 WKSTA_INFO_502 structure.""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def char_wait(self) -> 'Any': + """number of seconds the computer will wait for a remote resource to become available""" + pass + + @property + def collection_time(self) -> 'Any': + """number of milliseconds the computer will collect data before sending the data to a character device resource. The workstation waits the specified time or collects the number of characters specified by wki502_maximum_collection_count, whichever comes first.""" + pass + + @property + def maximum_collection_count(self) -> 'Any': + """Specifies the number of bytes of information the computer will collect before sending the data to a character device resource. The workstation collects the specified number of bytes or waits the time specified by wki302_collection_time, whichever comes first.""" + pass + + @property + def keep_conn(self) -> 'Any': + """Specifies the number of seconds the server will maintain an inactive connection to a resource.""" + pass + + @property + def max_cmds(self) -> 'Any': + """Specifies the number of simultaneous network device driver commands that can be sent to the network.""" + pass + + @property + def max_wrk_cache(self) -> 'Any': + """Indicates the number of seconds the server waits before disconnecting an inactive session.""" + pass + + @property + def siz_char_buf(self) -> 'Any': + """Specifies the maximum size, in bytes, of a character pipe buffer and device buffer.""" + pass + + @property + def lock_quota(self) -> 'Any': + """TODO""" + pass + + @property + def lock_increment(self) -> 'Any': + """TODO""" + pass + + @property + def lock_maximum(self) -> 'Any': + """TODO""" + pass + + @property + def pipe_increment(self) -> 'Any': + """TODO""" + pass + + @property + def pipe_maximum(self) -> 'Any': + """TODO""" + pass + + @property + def cache_file_timeout(self) -> 'Any': + """TODO""" + pass + + @property + def dormant_file_limit(self) -> 'Any': + """TODO""" + pass + + @property + def read_ahead_throughput(self) -> 'Any': + """TODO""" + pass + + @property + def num_mailslot_buffers(self) -> 'Any': + """TODO""" + pass + + @property + def num_srv_announce_buffers(self) -> 'Any': + """TODO""" + pass + + @property + def max_illegal_datagram_events(self) -> 'Any': + """TODO""" + pass + + @property + def illegal_datagram_event_reset_frequency(self) -> 'Any': + """TODO""" + pass + + @property + def log_election_packets(self) -> 'Any': + """TODO""" + pass + + @property + def use_opportunistic_locking(self) -> 'Any': + """TODO""" + pass + + @property + def use_unlock_behind(self) -> 'Any': + """TODO""" + pass + + @property + def use_close_behind(self) -> 'Any': + """TODO""" + pass + + @property + def buf_named_pipes(self) -> 'Any': + """TODO""" + pass + + @property + def use_lock_read_unlock(self) -> 'Any': + """TODO""" + pass + + @property + def utilize_nt_caching(self) -> 'Any': + """TODO""" + pass + + @property + def use_raw_read(self) -> 'Any': + """TODO""" + pass + + @property + def use_raw_write(self) -> 'Any': + """TODO""" + pass + + @property + def use_write_raw_data(self) -> 'Any': + """TODO""" + pass + + @property + def use_encryption(self) -> 'Any': + """TODO""" + pass + + @property + def buf_files_deny_write(self) -> 'Any': + """TODO""" + pass + + @property + def buf_read_only_files(self) -> 'Any': + """TODO""" + pass + + @property + def force_core_create_mode(self) -> 'Any': + """TODO""" + pass + + @property + def use_512_byte_max_transfer(self) -> 'Any': + """TODO""" + pass -Args: +class PyWKSTA_TRANSPORT_INFO_0(object): + """A dictionary holding the infomation in a Win32 WKSTA_TRANSPORT_INFO_0 structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') -Returns: + @property + def quality_of_service(self) -> 'Any': + """Supplies a value that specifies the search order of the transport protocol with respect to other transport protocols. The highest value is searched first.""" + pass - Any - - """ - pass + @property + def number_of_vcs(self) -> 'Any': + """Specifies the number of clients communicating with the server using this transport protocol.""" + pass + @property + def transport_name(self) -> 'Union[str]': + """Specifies the device name of the transport protocol.""" + pass - def fetchmany(self,) -> 'List[Any]': - """ - Fetch many rows of data + @property + def transport_address(self) -> 'Union[str]': + """Specifies the address of the server on this transport protocol.""" + pass -Args: + @property + def wan_ish(self) -> 'Any': + """This member is ignored by the NetWkstaTransportAdd function. For the NetWkstaTransportEnum function, this member indicates that this transport protocol is a WAN transport protocol. This member is set TRUE for NetBIOS/TCIP; it is set FALSE for NetBEUI and NetBIOS/IPX.""" + pass +class PyWKSTA_USER_INFO_0(object): + """A dictionary holding the infomation in a Win32 WKSTA_USER_INFO_0 structure.""" -Returns: + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - List[Any] - - """ - pass + @property + def username(self) -> 'Union[str]': + """Name of user currently logged on to the workstation""" + pass - def fetchall(self,) -> 'List[Any]': - """ - Fetch all rows of data +class PyWKSTA_USER_INFO_1(object): + """A dictionary holding the infomation in a Win32 WKSTA_USER_INFO_1 structure.""" -Args: + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def username(self) -> 'Union[str]': + """Name of user currently logged on to the workstation""" + pass + @property + def logon_domain(self) -> 'Union[str]': + """Returns the domain name of the user account of the user currently logged on to the workstation.""" + pass -Returns: + @property + def oth_domains(self) -> 'Union[str]': + """Returns the list of other operating system domains browsed by the workstation. The domain names are separated by blanks.""" + pass - List[Any] - - """ - pass + @property + def logon_server(self) -> 'Union[str]': + """Returns the name of the computer that authenticated the server.""" + pass - def setinputsizes(self,) -> 'None': - """ - None +class PyWNDCLASS(object): + """A Python object, representing an WNDCLASS structure""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def style(self) -> 'int': + """""" + pass + + @property + def cbWndExtra(self) -> 'int': + """""" + pass + + @property + def hInstance(self) -> 'int': + """""" + pass + + @property + def hIcon(self) -> 'int': + """""" + pass + + @property + def hCursor(self) -> 'int': + """""" + pass + + @property + def hbrBackground(self) -> 'int': + """These 3 handled manually in PyWNDCLASS::getattro/setattro. The pymeth below is used as an end tag, so these props will be lost if below it""" + pass + + @property + def lpszMenuName(self) -> 'Union[str]': + """""" + pass + + @property + def lpszClassName(self) -> 'Union[str]': + """""" + pass + + @property + def lpfnWndProc(self) -> 'Any': + """MethodsSetDialogProcSets the WNDCLASS to be for a dialog box. """ + pass + + def SetDialogProc(self,) -> 'None': + """ + Sets the WNDCLASS to be for a dialog box Args: @@ -10126,1097 +9132,1506 @@ Args: Returns: None - - """ - pass + """ + pass - def setoutputsize(self,) -> 'None': - """ - None -Args: +class PyXFORM(object): + """Dict representing an XFORM struct used as a world transformation matrix +All members are optional, defaulting to 0.0.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') -Returns: + @property + def M11(self) -> 'float': + """Usage is dependent on operation performed, see MSDN docs""" + pass - None - - """ - pass + @property + def M12(self) -> 'float': + """Usage is dependent on operation performed, see MSDN docs""" + pass + @property + def M21(self) -> 'float': + """Usage is dependent on operation performed, see MSDN docs""" + pass -class error(object): - """An exception raised when a win32 error occurs""" + @property + def M22(self) -> 'float': + """Usage is dependent on operation performed, see MSDN docs""" + pass - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + @property + def Dx(self) -> 'float': + """Horizontal offset in logical units""" + pass + @property + def Dy(self) -> 'float': + """Vertical offset in logical units""" + pass -class COMPONENT(object): - """A dictionary containing data to fill a COMPPOS struct""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class Pymmapfile(object): + """Object that provides access to memory-mapped file operations.""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + def close(self,) -> 'None': + """ + Closes the file mapping handle and releases mapped view - @property - def ID(self)->'Any': - """Id of component, ignored when adding a new component""" - pass +Args: - @property - def ComponentType(self)->'Any': - """One of shellcon.COMP_TYPE_* values""" - pass +Returns: - @property - def Checked(self)->'Any': - """True indicates item is currently displayed""" - pass + None + """ + pass - @property - def fDirty(self)->'Any': - """Indicates if unsaved changes exist""" - pass + def find(self, needle: 'Any', start: 'Any') -> 'Any': + """ + Finds a string in the buffer. +Args: - @property - def NoScroll(self)->'Any': - """True disables scrolling""" - pass + needle(Any):String to be located + start(Any):Pos at which to start search, current pos assumed if not specifiedReturn ValueReturns pos of string, or -1 if not found +Returns: - @property - def Pos(self)->'Any': - """COMPPOS dictionary determining window size and placement""" - pass + Any:Pos at which to start search, current pos assumed if not specifiedReturn ValueReturns pos of string, or -1 if not found - @property - def FriendlyName(self)->'Any': - """String of at most MAX_PATH-1 characters, truncated if longer""" - pass + """ + pass + def flush(self, offset: 'Any' = 0, size: 'Any' = 0) -> 'None': + """ + Flushes memory buffer to disk - @property - def Source(self)->'Any': - """String of at most INTERNET_MAX_URL_LENGTH-1 characters""" - pass +Args: + offset(Any):Position in buffer at which to flush + size(Any):Number of bytes to flush, 0 to flush remainder of buffer past the offset - @property - def SubscribedURL(self)->'Any': - """String of at most INTERNET_MAX_URL_LENGTH-1 characters""" - pass +Returns: + None - @property - def CurItemState(self)->'Any': - """One of shellcon.IS_* flags""" - pass + """ + pass + def move(self, dest: 'Any', src: 'Any', count: 'Any') -> 'None': + """ + Moves data from one place in buffer to another - @property - def Original(self)->'Any': - """COMPSTATEINFO dictionary""" - pass +Args: + dest(Any):Destination position in buffer + src(Any):Source position in buffer + count(Any):Number of bytes to move - @property - def Restored(self)->'Any': - """COMPSTATEINFO dictionary""" - pass +Returns: + None - @property - def Size(self)->'Any': - """Size of structure, ignored on input""" - pass + """ + pass + def read(self, num_bytes: 'Any') -> 'Any': + """ + Returns specified number of bytes from buffer, and advances current position -class COMPONENTSOPT(object): - """A dictionary containing data to fill a COMPONENTSOPT struct""" +Args: - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + num_bytes(Any):Number of bytes to read +Returns: - @property - def EnableComponents(self)->'Any': - """True if components are enabled""" - pass + Any + """ + pass - @property - def ActiveDesktop(self)->'Any': - """True if Active Desktop is enabled""" - pass + def read_byte(self,) -> 'Any': + """ + Reads a single character from current pos +Args: - @property - def Size(self)->'Any': - """Size of structure, ignored on input""" - pass -class COMPPOS(object): - """A dictionary containing data to fill a COMPPOS struct""" +Returns: - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + Any + """ + pass - @property - def Left(self)->'Any': - """""" - pass + def read_line(self,) -> 'Any': + """ + Reads data from current pos up to next EOL. +Args: - @property - def Top(self)->'Any': - """""" - pass - @property - def Width(self)->'Any': - """""" - pass +Returns: + Any - @property - def Height(self)->'Any': - """""" - pass + """ + pass + def resize(self, MaximumSize: 'Any', FileOffset: 'Any' = 0, NumberOfBytesToMap: 'Any' = 0) -> 'None': + """ + Resizes the file mapping and view. - @property - def Index(self)->'Any': - """""" - pass +Args: + MaximumSize(Any):New size for file mapping. Use a multiple of system page size (see win32api::GetSystemInfo) + FileOffset(Any):Offset into file mapping. Must be multiple of allocation granularity. + NumberOfBytesToMap(Any):New view size. Specify a multiple of system page size.CommentsIf MaximumSize is 0, only the mapped view will be affected.Accepts keyword args. - @property - def CanResize(self)->'Any': - """""" - pass +Returns: + None - @property - def CanResizeX(self)->'Any': - """""" - pass + """ + pass + def seek(self, dist: 'Any', how: 'Any' = 0) -> 'None': + """ + Changes current position - @property - def CanResizeY(self)->'Any': - """""" - pass +Args: + dist(Any):Distance to seek + how(Any):Pos from which to seekhowmeaning0Seek from start of buffer1Seek from current position2Seek backwards from end of buffer - @property - def PreferredLeftPercent(self)->'Any': - """""" - pass +Returns: + None - @property - def PreferredTopPercent(self)->'Any': - """""" - pass + """ + pass + def size(self,) -> 'Any': + """ + Returns size of current view - @property - def Size(self)->'Any': - """Size of structure, ignored on input""" - pass +Args: -class COMPSTATEINFO(object): - """A dictionary containing data to fill a COMPSTATEINFO struct""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +Returns: + Any - @property - def Left(self)->'Any': - """Specified as screen coordinates""" - pass + """ + pass + def tell(self,) -> 'Any': + """ + Returns current position in buffer - @property - def Top(self)->'Any': - """Specified as screen coordinates""" - pass +Args: - @property - def Width(self)->'Any': - """Measured in pixels""" - pass +Returns: - @property - def Height(self)->'Any': - """Measured in pixels""" - pass + Any + """ + pass - @property - def dwItemState(self)->'Any': - """One of IS_NORMAL, IS_FULLSCREEN IS_SPLIT""" - pass + def write(self, data: 'Any') -> 'None': + """ + Places data at current pos in buffer. +Args: - @property - def Size(self)->'Any': - """Size of structure, ignored on input""" - pass + data(Any):Data to be written +Returns: -class DEFCONTENTMENU(object): - """A tuple representing a DEFCONTEXTMENU structure.""" + None - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """ + pass + def write_byte(self, char: 'Any') -> 'None': + """ + Writes a single character of data -class ELEMDESC(object): - """An ELEMDESC is respresented as a tuple of""" +Args: - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + char(Any):Single byte to be placed in buffer +Returns: -class EXP_DARWIN_LINK(object): - """Dictionary containing information for a EXP_DARWIN_LINK struct""" + None - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """ + pass - @property - def Signature(self)->'Any': - """The type of data block, one of shellcon.*_SIG values""" - pass +class RASDIALEXTENSIONS(object): + """An object that describes a Win32 RASDIALEXTENSIONS structure +TRUE*/)""" - @property - def DarwinID(self)->'Any': - """The Windows Installer id for the link""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def dwfOptions(self) -> 'int': + """(fOptions may also be used)""" + pass - @property - def wDarwinID(self)->'Any': - """The installer id as Unicode""" - pass + @property + def hwndParent(self) -> 'int': + """""" + pass + @property + def reserved(self) -> 'int': + """""" + pass - @property - def Size(self)->'Any': - """Size of structure, ignored on input""" - pass + @property + def reserved1(self) -> 'int': + """""" + pass + @property + def RasEapInfo(self) -> 'Any': + """""" + pass -class EXP_SPECIAL_FOLDER(object): - """Dictionary containing information for a EXP_SPECIAL_FOLDER struct""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class RASDIALPARAMS(object): + """A tuple that describes a Win32 RASDIALPARAMS structure""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def Signature(self)->'Any': - """The type of data block, one of shellcon.*_SIG values""" - pass +class SC_ACTION(object): + """Tuple of 2 ints (Type,Delay) used to represent an SC_ACTION structure""" - @property - def idSpecialFolder(self)->'Any': - """The special folder id of the target (shellcon.CSIDL_*)""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def Type(self) -> 'Any': + """One of SC_ACTION_NONE, SC_ACTION_REBOOT, SC_ACTION_RESTART, SC_ACTION_RUN_COMMAND""" + pass - @property - def Offset(self)->'Any': - """Offset into the link's PIDL""" - pass + @property + def Delay(self) -> 'Any': + """Time delay before specified action is taken (in milliseconds)""" + pass - @property - def Size(self)->'Any': - """Size of structure, ignored on input""" - pass +class SERVICE_FAILURE_ACTIONS(object): + """A dictionary representing a SERVICE_FAILURE_ACTIONS structure""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') -class EXP_SZ_LINK(object): - """Dictionary containing information for an EXP_SZ_LINK or EXP_SZ_ICON struct""" + @property + def ResetPeriod(self) -> 'Any': + """Indicates how many seconds to wait to reset the failure count, can be INFINITE""" + pass - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + @property + def RebootMsg(self) -> 'Union[Any, str]': + """Message displayed when reboot action is taken""" + pass + @property + def Command(self) -> 'Union[Any, str]': + """Command line to execute for SC_ACTION_RUN_COMMAND""" + pass - @property - def Signature(self)->'Any': - """The type of data block, one of shellcon.*_SIG values""" - pass + @property + def Actions(self) -> 'Any': + """A tuple of SC_ACTION tuples""" + pass - @property - def Target(self)->'Any': - """The link's target or icon location""" - pass +class SERVICE_STATUS(object): + """A Win32 service status object is represented by a tuple:""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def wTarget(self)->'Any': - """The target in Unicode form""" - pass +class TRACKMOUSEEVENT(object): + """A tuple of (dwFlags, hwndTrack, dwHoverTime)""" - @property - def Size(self)->'Any': - """Size of structure, ignored on input""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') -class FUNCDESC(object): - """A FUNCDESC object represents a COM TYPEATTR structure.""" +class ULARGE_INTEGER(object): + """A Python object used wherever a COM ULARGE_INTEGER is used.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def memid(self)->'int': - """""" - pass +class WIN32_FIND_DATA(object): + """A tuple representing a WIN32_FIND_DATA structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def scodeArray(self)->'Tuple[Any, ...]': - """""" - pass +class com_error(object): + """An exception raised when a COM exception occurs.""" - @property - def args(self)->'Tuple[Any, ...]': - """""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def funckind(self)->'Any': - """""" - pass +class connection(object): + """An object representing an ODBC connection""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def invkind(self)->'Any': - """""" - pass + def setautocommit(self, c: 'Any') -> 'None': + """ + Sets the autocommit mode. +Args: - @property - def callconv(self)->'Any': - """""" - pass + c(Any):The boolean autocommit mode. +Returns: - @property - def cParamsOpt(self)->'Any': - """""" - pass + None + """ + pass - @property - def oVft(self)->'Any': - """""" - pass + def commit(self,) -> 'None': + """ + Commits a transaction. +Args: - @property - def rettype(self)->'Any': - """""" - pass - @property - def wFuncFlags(self)->'Any': - """""" - pass +Returns: + None -class IDLDESC(object): - """An IDLDESC is respresented as""" + """ + pass - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def rollback(self,) -> 'None': + """ + Rollsback a transaction. +Args: -class MAPIINIT_0(object): - """A MAPIINIT_0 is represented as a tuple of:""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +Returns: -class NT_CONSOLE_PROPS(object): - """Dictionary containing information for a NT_CONSOLE_PROPS struct""" + None - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """ + pass + def cursor(self,) -> 'None': + """ + None - @property - def Signature(self)->'Any': - """The type of data block, one of shellcon.*_SIG values""" - pass +Args: - @property - def FillAttribute(self)->'Any': - """Character attributes for fill operations""" - pass +Returns: - @property - def PopupFillAttribute(self)->'Any': - """Fill attributes for popups""" - pass + None + """ + pass - @property - def ScreenBufferSize(self)->'Tuple[Any, Any]': - """Size of console screen buffer, in character cells""" - pass + def close(self,) -> 'None': + """ + Closes the connection. +Args: - @property - def WindowSize(self)->'Tuple[Any, Any]': - """Size of console window in character cells""" - pass - @property - def WindowOrigin(self)->'Tuple[Any, Any]': - """Window position, in screen coordinates""" - pass +Returns: + None - @property - def nFont(self)->'Any': - """Number of font to be displayed. See win32console::GetNumberOfConsoleFonts""" - pass + """ + pass - @property - def InputBufferSize(self)->'Any': - """Size of console's input buffer""" - pass +class cursor(object): + """An object representing an ODBC cursor.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def FontSize(self)->'Tuple[Any, Any]': - """Size of font""" - pass + def close(self,) -> 'None': + """ + Closes the cursor +Args: - @property - def FontFamily(self)->'Any': - """Font family""" - pass - @property - def FontWeight(self)->'Any': - """Controls thickness of displayed font""" - pass +Returns: + None - @property - def FaceName(self)->'Any': - """Name of font face, 31 characters at most""" - pass + """ + pass + def execute(self, sql: 'str', arg: 'Any') -> 'Any': + """ + Execute some SQL - @property - def CursorSize(self)->'Any': - """Relative size of cursor, expressed as percent of character size""" - pass +Args: + sql(str):The SQL to execute + arg(Any):Input variables. - @property - def FullScreen(self)->'Any': - """Causes console to run in full screen mode""" - pass +Returns: + Any - @property - def QuickEdit(self)->'Any': - """""" - pass + """ + pass + def fetchone(self,) -> 'Any': + """ + Fetch one row of data - @property - def InsertMode(self)->'Any': - """""" - pass +Args: - @property - def AutoPosition(self)->'Any': - """Lets system determine window placement""" - pass +Returns: - @property - def HistoryBufferSize(self)->'Any': - """Size of command line history buffer""" - pass + Any + """ + pass - @property - def NumberOfHistoryBuffers(self)->'Any': - """""" - pass + def fetchmany(self,) -> 'List[Any]': + """ + Fetch many rows of data +Args: - @property - def HistoryNoDup(self)->'Any': - """""" - pass - @property - def ColorTable(self)->'Any': - """Tuple of 16 ints containing console's color attributes""" - pass +Returns: + List[Any] - @property - def Size(self)->'Any': - """Size of structure, ignored on input""" - pass + """ + pass + def fetchall(self,) -> 'List[Any]': + """ + Fetch all rows of data -class NT_FE_CONSOLE_PROPS(object): - """Dictionary containing information for a NT_FE_CONSOLE_PROPS struct""" +Args: - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - @property - def Signature(self)->'Any': - """The type of data block, one of shellcon.*_SIG values""" - pass +Returns: + List[Any] - @property - def CodePage(self)->'Any': - """The codepage to be used for console text""" - pass + """ + pass + def setinputsizes(self,) -> 'None': + """ + None - @property - def Size(self)->'Any': - """Size of structure, ignored on input""" - pass +Args: -class PROPSPEC(object): - """Identifies a property. Can be either an int property id, or a str/unicode property name.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +Returns: + None -class PyADSVALUE(object): - """A tuple:""" + """ + pass - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def setoutputsize(self,) -> 'None': + """ + None +Args: -class PyADS_ATTR_INFO(object): - """Represents a ADS_ATTR_INFO structure.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +Returns: - @property - def AttrName(self)->'Any': - """The name""" - pass + None + """ + pass - @property - def ControlCode(self)->'int': - """""" - pass +class error(object): + """An exception raised when a win32 error occurs""" - @property - def ADsType(self)->'int': - """""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def Values(self)->'List[Any]': - """""" - pass +class COMPONENT(object): + """A dictionary containing data to fill a COMPPOS struct""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def ID(self) -> 'Any': + """Id of component, ignored when adding a new component""" + pass + + @property + def ComponentType(self) -> 'Any': + """One of shellcon.COMP_TYPE_* values""" + pass + + @property + def Checked(self) -> 'Any': + """True indicates item is currently displayed""" + pass + + @property + def fDirty(self) -> 'Any': + """Indicates if unsaved changes exist""" + pass + + @property + def NoScroll(self) -> 'Any': + """True disables scrolling""" + pass + + @property + def Pos(self) -> 'Any': + """COMPPOS dictionary determining window size and placement""" + pass + + @property + def FriendlyName(self) -> 'Any': + """String of at most MAX_PATH-1 characters, truncated if longer""" + pass + + @property + def Source(self) -> 'Any': + """String of at most INTERNET_MAX_URL_LENGTH-1 characters""" + pass + + @property + def SubscribedURL(self) -> 'Any': + """String of at most INTERNET_MAX_URL_LENGTH-1 characters""" + pass + + @property + def CurItemState(self) -> 'Any': + """One of shellcon.IS_* flags""" + pass + + @property + def Original(self) -> 'Any': + """COMPSTATEINFO dictionary""" + pass + + @property + def Restored(self) -> 'Any': + """COMPSTATEINFO dictionary""" + pass + + @property + def Size(self) -> 'Any': + """Size of structure, ignored on input""" + pass -class PyADS_OBJECT_INFO(object): - """Represents a ADS_OBJECT_INFO structure.""" +class COMPONENTSOPT(object): + """A dictionary containing data to fill a COMPONENTSOPT struct""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def EnableComponents(self) -> 'Any': + """True if components are enabled""" + pass - @property - def RDN(self)->'Any': - """The name""" - pass + @property + def ActiveDesktop(self) -> 'Any': + """True if Active Desktop is enabled""" + pass + @property + def Size(self) -> 'Any': + """Size of structure, ignored on input""" + pass - @property - def ObjectDN(self)->'Any': - """""" - pass +class COMPPOS(object): + """A dictionary containing data to fill a COMPPOS struct""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def Left(self) -> 'Any': + """""" + pass + + @property + def Top(self) -> 'Any': + """""" + pass + + @property + def Width(self) -> 'Any': + """""" + pass + + @property + def Height(self) -> 'Any': + """""" + pass + + @property + def Index(self) -> 'Any': + """""" + pass + + @property + def CanResize(self) -> 'Any': + """""" + pass + + @property + def CanResizeX(self) -> 'Any': + """""" + pass + + @property + def CanResizeY(self) -> 'Any': + """""" + pass + + @property + def PreferredLeftPercent(self) -> 'Any': + """""" + pass + + @property + def PreferredTopPercent(self) -> 'Any': + """""" + pass + + @property + def Size(self) -> 'Any': + """Size of structure, ignored on input""" + pass - @property - def ParentDN(self)->'Any': - """""" - pass +class COMPSTATEINFO(object): + """A dictionary containing data to fill a COMPSTATEINFO struct""" - @property - def ClassName(self)->'Any': - """""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def Left(self) -> 'Any': + """Specified as screen coordinates""" + pass -class PyADS_SEARCHPREF_INFO(object): - """A tuple of:""" + @property + def Top(self) -> 'Any': + """Specified as screen coordinates""" + pass - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + @property + def Width(self) -> 'Any': + """Measured in pixels""" + pass + @property + def Height(self) -> 'Any': + """Measured in pixels""" + pass -class PyBIND_OPTS(object): - """Dictionary representation of a BIND_OPTS struct + @property + def dwItemState(self) -> 'Any': + """One of IS_NORMAL, IS_FULLSCREEN IS_SPLIT""" + pass -May eventually be extended to include BIND_OPTS2 members""" + @property + def Size(self) -> 'Any': + """Size of structure, ignored on input""" + pass - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class DEFCONTENTMENU(object): + """A tuple representing a DEFCONTEXTMENU structure.""" - @property - def Flags(self)->'Any': - """Value from BIND_FLAGS enum: BIND_MAYBOTHERUSER, BIND_JUSTTESTEXISTENCE or 0""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def Mode(self)->'Any': - """Combination of storagecon.STGM_* values""" - pass +class ELEMDESC(object): + """An ELEMDESC is respresented as a tuple of""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def TickCountDeadline(self)->'Any': - """Operation timeout in milliseconds""" - pass +class EXP_DARWIN_LINK(object): + """Dictionary containing information for a EXP_DARWIN_LINK struct""" - @property - def cbStruct(self)->'Any': - """Size of struct, ignored on input""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def Signature(self) -> 'Any': + """The type of data block, one of shellcon.*_SIG values""" + pass -class PyCMINVOKECOMMANDINFO(object): - """A tuple of parameters to be converted to a CMINVOKECOMMANDINFO struct""" + @property + def DarwinID(self) -> 'Any': + """The Windows Installer id for the link""" + pass - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + @property + def wDarwinID(self) -> 'Any': + """The installer id as Unicode""" + pass + @property + def Size(self) -> 'Any': + """Size of structure, ignored on input""" + pass -class PyDSBCAPS(object): - """A Python object, representing a DSBCAPS structure""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class EXP_SPECIAL_FOLDER(object): + """Dictionary containing information for a EXP_SPECIAL_FOLDER struct""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def dwFlags(self)->'int': - """Flags that specify buffer-object capabilities.FlagDescriptionDSBCAPS_PRIMARYBUFFERIndicates that the buffer is a primary sound buffer. If this value is not specified, a secondary sound buffer will be created.DSBCAPS_STATICIndicates that the buffer will be used for static sound data. Typically, these buffers are loaded once and played many times. These buffers are candidates for hardware memory.DSBCAPS_LOCHARDWAREThe buffer is in hardware memory and uses hardware mixing.DSBCAPS_LOCSOFTWAREThe buffer is in software memory and uses software mixing.DSBCAPS_CTRL3DThe buffer is either a primary buffer or a secondary buffer that uses 3-D control. To create a primary buffer, the dwFlags member of the DSBUFFERDESC structure should include the DSBCAPS_PRIMARYBUFFER flag.DSBCAPS_CTRLFREQUENCYThe buffer must have frequency control capability.DSBCAPS_CTRLPANThe buffer must have pan control capability.DSBCAPS_CTRLVOLUMEThe buffer must have volume control capability.DSBCAPS_CTRLPOSITIONNOTIFYThe buffer must have control position notify capability.DSBCAPS_STICKYFOCUSChanges the focus behavior of the sound buffer. This flag can be specified in an IDirectSound::CreateSoundBuffer call. With this flag set, an application using DirectSound can continue to play its sticky focus buffers if the user switches to another application not using DirectSound. In this situation, the application's normal buffers are muted, but the sticky focus buffers are still audible. This is useful for nongame applications, such as movie playback (DirectShow™), when the user wants to hear the soundtrack while typing in Microsoft Word or MicrosoftÂŽ Excel, for example. However, if the user switches to another DirectSound application, all sound buffers, both normal and sticky focus, in the previous application are muted.DSBCAPS_GLOBALFOCUSThe buffer is a global sound buffer. With this flag set, an application using DirectSound can continue to play its buffers if the user switches focus to another application, even if the new application uses DirectSound. The one exception is if you switch focus to a DirectSound application that uses the DSSCL_EXCLUSIVE or DSSCL_WRITEPRIMARY flag for its cooperative level. In this case, the global sounds from other applications will not be audible.DSBCAPS_GETCURRENTPOSITION2Indicates that IDirectSoundBuffer::GetCurrentPosition should use the new behavior of the play cursor. In DirectSound in DirectX 1, the play cursor was significantly ahead of the actual playing sound on emulated sound cards; it was directly behind the write cursor. Now, if the DSBCAPS_GETCURRENTPOSITION2 flag is specified, the application can get a more accurate play position. If this flag is not specified, the old behavior is preserved for compatibility. Note that this flag affects only emulated sound cards; if a DirectSound driver is present, the play cursor is accurate for DirectSound in all versions of DirectX.DSBCAPS_MUTE3DATMAXDISTANCEThe sound is reduced to silence at the maximum distance. The buffer will stop playing when the maximum distance is exceeded, so that processor time is not wasted.""" - pass + @property + def Signature(self) -> 'Any': + """The type of data block, one of shellcon.*_SIG values""" + pass + @property + def idSpecialFolder(self) -> 'Any': + """The special folder id of the target (shellcon.CSIDL_*)""" + pass - @property - def nChannels(self)->'int': - """Size of the buffer, in bytes.""" - pass + @property + def Offset(self) -> 'Any': + """Offset into the link's PIDL""" + pass + @property + def Size(self) -> 'Any': + """Size of structure, ignored on input""" + pass - @property - def dwUnlockTransferRate(self)->'int': - """Specifies the rate, in kilobytes per second, at which data is transferred to the buffer memory when IDirectSoundBuffer::Unlock is called. High-performance applications can use this value to determine the time required for IDirectSoundBuffer::Unlock to execute. For software buffers located in system memory, the rate will be very high because no processing is required. For hardware buffers, the rate might be slower because the buffer might have to be downloaded to the sound card, which might have a limited transfer rate.""" - pass +class EXP_SZ_LINK(object): + """Dictionary containing information for an EXP_SZ_LINK or EXP_SZ_ICON struct""" - @property - def nAvgBytesPerSec(self)->'int': - """Specifies whether the returned handle is inherited when a new process is created. If this member is TRUE, the new process inherits the handle. Sentinel""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def Signature(self) -> 'Any': + """The type of data block, one of shellcon.*_SIG values""" + pass -class PyDSBUFFERDESC(object): - """A Python object, representing a DSBUFFERDESC structure""" + @property + def Target(self) -> 'Any': + """The link's target or icon location""" + pass - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + @property + def wTarget(self) -> 'Any': + """The target in Unicode form""" + pass + @property + def Size(self) -> 'Any': + """Size of structure, ignored on input""" + pass - @property - def dwFlags(self)->'int': - """Identifies the capabilities to include when creating a new DirectSoundBuffer object. Specify one or more of the following:FlagDescriptionDSBCAPS_PRIMARYBUFFERIndicates that the buffer is a primary sound buffer. If this value is not specified, a secondary sound buffer will be created.DSBCAPS_STATICIndicates that the buffer will be used for static sound data. Typically, these buffers are loaded once and played many times. These buffers are candidates for hardware memory.DSBCAPS_LOCHARDWAREThe buffer is in hardware memory and uses hardware mixing.DSBCAPS_LOCSOFTWAREThe buffer is in software memory and uses software mixing.DSBCAPS_CTRL3DThe buffer is either a primary buffer or a secondary buffer that uses 3-D control. To create a primary buffer, the dwFlags member of the DSBUFFERDESC structure should include the DSBCAPS_PRIMARYBUFFER flag.DSBCAPS_CTRLFREQUENCYThe buffer must have frequency control capability.DSBCAPS_CTRLPANThe buffer must have pan control capability.DSBCAPS_CTRLVOLUMEThe buffer must have volume control capability.DSBCAPS_CTRLPOSITIONNOTIFYThe buffer must have control position notify capability.DSBCAPS_STICKYFOCUSChanges the focus behavior of the sound buffer. This flag can be specified in an IDirectSound::CreateSoundBuffer call. With this flag set, an application using DirectSound can continue to play its sticky focus buffers if the user switches to another application not using DirectSound. In this situation, the application's normal buffers are muted, but the sticky focus buffers are still audible. This is useful for nongame applications, such as movie playback (DirectShow™), when the user wants to hear the soundtrack while typing in Microsoft Word or MicrosoftÂŽ Excel, for example. However, if the user switches to another DirectSound application, all sound buffers, both normal and sticky focus, in the previous application are muted.DSBCAPS_GLOBALFOCUSThe buffer is a global sound buffer. With this flag set, an application using DirectSound can continue to play its buffers if the user switches focus to another application, even if the new application uses DirectSound. The one exception is if you switch focus to a DirectSound application that uses the DSSCL_EXCLUSIVE or DSSCL_WRITEPRIMARY flag for its cooperative level. In this case, the global sounds from other applications will not be audible.DSBCAPS_GETCURRENTPOSITION2Indicates that IDirectSoundBuffer::GetCurrentPosition should use the new behavior of the play cursor. In DirectSound in DirectX 1, the play cursor was significantly ahead of the actual playing sound on emulated sound cards; it was directly behind the write cursor. Now, if the DSBCAPS_GETCURRENTPOSITION2 flag is specified, the application can get a more accurate play position. If this flag is not specified, the old behavior is preserved for compatibility. Note that this flag affects only emulated sound cards; if a DirectSound driver is present, the play cursor is accurate for DirectSound in all versions of DirectX.DSBCAPS_MUTE3DATMAXDISTANCEThe sound is reduced to silence at the maximum distance. The buffer will stop playing when the maximum distance is exceeded, so that processor time is not wasted.""" - pass +class FUNCDESC(object): + """A FUNCDESC object represents a COM TYPEATTR structure.""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def memid(self) -> 'int': + """""" + pass + + @property + def scodeArray(self) -> 'Tuple[Any, ...]': + """""" + pass + + @property + def args(self) -> 'Tuple[Any, ...]': + """""" + pass + + @property + def funckind(self) -> 'Any': + """""" + pass + + @property + def invkind(self) -> 'Any': + """""" + pass + + @property + def callconv(self) -> 'Any': + """""" + pass + + @property + def cParamsOpt(self) -> 'Any': + """""" + pass + + @property + def oVft(self) -> 'Any': + """""" + pass + + @property + def rettype(self) -> 'Any': + """""" + pass + + @property + def wFuncFlags(self) -> 'Any': + """""" + pass - @property - def dwBufferBytes(self)->'int': - """Size of the new buffer, in bytes. This value must be 0 when creating primary buffers. For secondary buffers, the minimum and maximum sizes allowed are specified by DSBSIZE_MIN and DSBSIZE_MAX.""" - pass +class IDLDESC(object): + """An IDLDESC is respresented as""" - @property - def lpwfxFormat(self)->'Any': - """Structure specifying the waveform format for the buffer. This value must be None for primary buffers. The application can use IDirectSoundBuffer::SetFormat to set the format of the primary buffer. Sentinel""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') -class PyDSCAPS(object): - """A Python object, representing a DSCAPS structure""" +class MAPIINIT_0(object): + """A MAPIINIT_0 is represented as a tuple of:""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def dwFlags(self)->'int': - """Specifies device capabilities. Can be one or more of the following:FlagDescriptionDSCAPS_PRIMARYMONOThe device supports monophonic primary buffers.DSCAPS_PRIMARYSTEREOThe device supports stereo primary buffers.DSCAPS_PRIMARY8BITThe device supports hardware-mixed secondary buffers with 8-bit samples.DSCAPS_PRIMARY16BITThe device supports primary sound buffers with 16-bit samples.DSCAPS_CONTINUOUSRATEThe device supports all sample rates between the dwMinSecondarySampleRate and dwMaxSecondarySampleRate member values. Typically, this means that the actual output rate will be within +/- 10 hertz (Hz) of the requested frequency.DSCAPS_EMULDRIVERThe device does not have a DirectSound driver installed, so it is being emulated through the waveform-audio functions. Performance degradation should be expected.DSCAPS_CERTIFIEDThis driver has been tested and certified by Microsoft.DSCAPS_SECONDARYMONOThe device supports hardware-mixed monophonic secondary buffers.DSCAPS_SECONDARYSTEREOThe device supports hardware-mixed stereo secondary buffers.DSCAPS_SECONDARY8BITThe device supports hardware-mixed secondary buffers with 8-bit samples.DSCAPS_SECONDARY16BITThe device supports hardware-mixed secondary sound buffers with 16-bit samples.""" - pass +class NT_CONSOLE_PROPS(object): + """Dictionary containing information for a NT_CONSOLE_PROPS struct""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def Signature(self) -> 'Any': + """The type of data block, one of shellcon.*_SIG values""" + pass + + @property + def FillAttribute(self) -> 'Any': + """Character attributes for fill operations""" + pass + + @property + def PopupFillAttribute(self) -> 'Any': + """Fill attributes for popups""" + pass + + @property + def ScreenBufferSize(self) -> 'Tuple[Any, Any]': + """Size of console screen buffer, in character cells""" + pass + + @property + def WindowSize(self) -> 'Tuple[Any, Any]': + """Size of console window in character cells""" + pass + + @property + def WindowOrigin(self) -> 'Tuple[Any, Any]': + """Window position, in screen coordinates""" + pass + + @property + def nFont(self) -> 'Any': + """Number of font to be displayed. See win32console::GetNumberOfConsoleFonts""" + pass + + @property + def InputBufferSize(self) -> 'Any': + """Size of console's input buffer""" + pass + + @property + def FontSize(self) -> 'Tuple[Any, Any]': + """Size of font""" + pass + + @property + def FontFamily(self) -> 'Any': + """Font family""" + pass + + @property + def FontWeight(self) -> 'Any': + """Controls thickness of displayed font""" + pass + + @property + def FaceName(self) -> 'Any': + """Name of font face, 31 characters at most""" + pass + + @property + def CursorSize(self) -> 'Any': + """Relative size of cursor, expressed as percent of character size""" + pass + + @property + def FullScreen(self) -> 'Any': + """Causes console to run in full screen mode""" + pass + + @property + def QuickEdit(self) -> 'Any': + """""" + pass + + @property + def InsertMode(self) -> 'Any': + """""" + pass + + @property + def AutoPosition(self) -> 'Any': + """Lets system determine window placement""" + pass + + @property + def HistoryBufferSize(self) -> 'Any': + """Size of command line history buffer""" + pass + + @property + def NumberOfHistoryBuffers(self) -> 'Any': + """""" + pass + + @property + def HistoryNoDup(self) -> 'Any': + """""" + pass + + @property + def ColorTable(self) -> 'Any': + """Tuple of 16 ints containing console's color attributes""" + pass + + @property + def Size(self) -> 'Any': + """Size of structure, ignored on input""" + pass - @property - def dwMinSecondarySampleRate(self)->'int': - """Minimum sample rate supported by this device's hardware secondary sound buffers.""" - pass +class NT_FE_CONSOLE_PROPS(object): + """Dictionary containing information for a NT_FE_CONSOLE_PROPS struct""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def dwMaxSecondarySampleRate(self)->'int': - """Maximum sample rate supported by this device's hardware secondary sound buffers.""" - pass + @property + def Signature(self) -> 'Any': + """The type of data block, one of shellcon.*_SIG values""" + pass + @property + def CodePage(self) -> 'Any': + """The codepage to be used for console text""" + pass - @property - def dwPrimaryBuffers(self)->'int': - """Number of primary buffers supported. This value will always be 1.""" - pass + @property + def Size(self) -> 'Any': + """Size of structure, ignored on input""" + pass - @property - def dwMaxHwMixingAllBuffers(self)->'int': - """Specifies the total number of buffers that can be mixed in hardware. This member can be less than the sum of dwMaxHwMixingStaticBuffers and dwMaxHwMixingStreamingBuffers. Resource tradeoffs frequently occur.""" - pass +class PROPSPEC(object): + """Identifies a property. Can be either an int property id, or a str/unicode property name.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def dwMaxHwMixingStaticBuffers(self)->'int': - """Specifies the maximum number of static sound buffers.""" - pass +class PyADSVALUE(object): + """A tuple:""" - @property - def dwMaxHwMixingStreamingBuffers(self)->'int': - """Specifies the maximum number of streaming sound buffers.""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def dwFreeHwMixingAllBuffers(self)->'int': - """Description of the free hardware mixing capabilities of the device. An application can use this value to determine whether hardware resources are available for allocation to a secondary sound buffer. Also, by comparing these values to the members that specify maximum mixing capabilities, the resources that are already allocated can be determined.""" - pass +class PyADS_ATTR_INFO(object): + """Represents a ADS_ATTR_INFO structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def dwFreeHwMixingStaticBuffers(self)->'int': - """Description of the free hardware mixing capabilities of the device. An application can use this value to determine whether hardware resources are available for allocation to a secondary sound buffer. Also, by comparing these values to the members that specify maximum mixing capabilities, the resources that are already allocated can be determined.""" - pass + @property + def AttrName(self) -> 'Any': + """The name""" + pass + @property + def ControlCode(self) -> 'int': + """""" + pass - @property - def dwFreeHwMixingStreamingBuffers(self)->'int': - """Description of the free hardware mixing capabilities of the device. An application can use this value to determine whether hardware resources are available for allocation to a secondary sound buffer. Also, by comparing these values to the members that specify maximum mixing capabilities, the resources that are already allocated can be determined.""" - pass + @property + def ADsType(self) -> 'int': + """""" + pass + @property + def Values(self) -> 'List[Any]': + """""" + pass - @property - def dwMaxHw3DAllBuffers(self)->'int': - """Description of the hardware 3-D positional capabilities of the device.""" - pass +class PyADS_OBJECT_INFO(object): + """Represents a ADS_OBJECT_INFO structure.""" - @property - def dwMaxHw3DStaticBuffers(self)->'int': - """Description of the hardware 3-D positional capabilities of the device.""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def RDN(self) -> 'Any': + """The name""" + pass - @property - def dwMaxHw3DStreamingBuffers(self)->'int': - """Description of the hardware 3-D positional capabilities of the device.""" - pass + @property + def ObjectDN(self) -> 'Any': + """""" + pass + @property + def ParentDN(self) -> 'Any': + """""" + pass - @property - def dwFreeHw3DAllBuffers(self)->'int': - """Description of the free, or unallocated, hardware 3-D positional capabilities of the device.""" - pass + @property + def ClassName(self) -> 'Any': + """""" + pass - @property - def dwFreeHw3DStaticBuffers(self)->'int': - """Description of the free, or unallocated, hardware 3-D positional capabilities of the device.""" - pass +class PyADS_SEARCHPREF_INFO(object): + """A tuple of:""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def dwFreeHw3DStreamingBuffers(self)->'int': - """Description of the free, or unallocated, hardware 3-D positional capabilities of the device.""" - pass +class PyBIND_OPTS(object): + """Dictionary representation of a BIND_OPTS struct - @property - def dwTotalHwMemBytes(self)->'int': - """Size, in bytes, of the amount of memory on the sound card that stores static sound buffers.""" - pass +May eventually be extended to include BIND_OPTS2 members""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def dwFreeHwMemBytes(self)->'int': - """Size, in bytes, of the free memory on the sound card.""" - pass + @property + def Flags(self) -> 'Any': + """Value from BIND_FLAGS enum: BIND_MAYBOTHERUSER, BIND_JUSTTESTEXISTENCE or 0""" + pass + @property + def Mode(self) -> 'Any': + """Combination of storagecon.STGM_* values""" + pass - @property - def dwMaxContigFreeHwMemBytes(self)->'int': - """Size, in bytes, of the largest contiguous block of free memory on the sound card.""" - pass + @property + def TickCountDeadline(self) -> 'Any': + """Operation timeout in milliseconds""" + pass + @property + def cbStruct(self) -> 'Any': + """Size of struct, ignored on input""" + pass - @property - def dwUnlockTransferRateHwBuffers(self)->'int': - """Description of the rate, in kilobytes per second, at which data can be transferred to hardware static sound buffers. This and the number of bytes transferred determines the duration of a call to the IDirectSoundBuffer::Update method.""" - pass +class PyCMINVOKECOMMANDINFO(object): + """A tuple of parameters to be converted to a CMINVOKECOMMANDINFO struct""" - @property - def dwPlayCpuOverheadSwBuffers(self)->'int': - """Description of the processing overhead, as a percentage of the central processing unit, needed to mix software buffers (those located in main system memory). This varies according to the bus type, the processor type, and the clock speed. The unlock transfer rate for software buffers is 0 because the data need not be transferred anywhere. Similarly, the play processing overhead for hardware buffers is 0 because the mixing is done by the sound device.""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') -class PyDSCBCAPS(object): - """A Python object, representing a DSCBCAPS structure""" +class PyDSBCAPS(object): + """A Python object, representing a DSBCAPS structure""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def dwFlags(self) -> 'int': + """Flags that specify buffer-object capabilities.FlagDescriptionDSBCAPS_PRIMARYBUFFERIndicates that the buffer is a primary sound buffer. If this value is not specified, a secondary sound buffer will be created.DSBCAPS_STATICIndicates that the buffer will be used for static sound data. Typically, these buffers are loaded once and played many times. These buffers are candidates for hardware memory.DSBCAPS_LOCHARDWAREThe buffer is in hardware memory and uses hardware mixing.DSBCAPS_LOCSOFTWAREThe buffer is in software memory and uses software mixing.DSBCAPS_CTRL3DThe buffer is either a primary buffer or a secondary buffer that uses 3-D control. To create a primary buffer, the dwFlags member of the DSBUFFERDESC structure should include the DSBCAPS_PRIMARYBUFFER flag.DSBCAPS_CTRLFREQUENCYThe buffer must have frequency control capability.DSBCAPS_CTRLPANThe buffer must have pan control capability.DSBCAPS_CTRLVOLUMEThe buffer must have volume control capability.DSBCAPS_CTRLPOSITIONNOTIFYThe buffer must have control position notify capability.DSBCAPS_STICKYFOCUSChanges the focus behavior of the sound buffer. This flag can be specified in an IDirectSound::CreateSoundBuffer call. With this flag set, an application using DirectSound can continue to play its sticky focus buffers if the user switches to another application not using DirectSound. In this situation, the application's normal buffers are muted, but the sticky focus buffers are still audible. This is useful for nongame applications, such as movie playback (DirectShow™), when the user wants to hear the soundtrack while typing in Microsoft Word or MicrosoftÂŽ Excel, for example. However, if the user switches to another DirectSound application, all sound buffers, both normal and sticky focus, in the previous application are muted.DSBCAPS_GLOBALFOCUSThe buffer is a global sound buffer. With this flag set, an application using DirectSound can continue to play its buffers if the user switches focus to another application, even if the new application uses DirectSound. The one exception is if you switch focus to a DirectSound application that uses the DSSCL_EXCLUSIVE or DSSCL_WRITEPRIMARY flag for its cooperative level. In this case, the global sounds from other applications will not be audible.DSBCAPS_GETCURRENTPOSITION2Indicates that IDirectSoundBuffer::GetCurrentPosition should use the new behavior of the play cursor. In DirectSound in DirectX 1, the play cursor was significantly ahead of the actual playing sound on emulated sound cards; it was directly behind the write cursor. Now, if the DSBCAPS_GETCURRENTPOSITION2 flag is specified, the application can get a more accurate play position. If this flag is not specified, the old behavior is preserved for compatibility. Note that this flag affects only emulated sound cards; if a DirectSound driver is present, the play cursor is accurate for DirectSound in all versions of DirectX.DSBCAPS_MUTE3DATMAXDISTANCEThe sound is reduced to silence at the maximum distance. The buffer will stop playing when the maximum distance is exceeded, so that processor time is not wasted.""" + pass - @property - def dwFlags(self)->'int': - """Specifies device capabilities. Can be 0 or DSCBCAPS_EMULDRIVER (indicates that no DirectSound Device is available and standard wave audio functions are being used).""" - pass + @property + def nChannels(self) -> 'int': + """Size of the buffer, in bytes.""" + pass + @property + def dwUnlockTransferRate(self) -> 'int': + """Specifies the rate, in kilobytes per second, at which data is transferred to the buffer memory when IDirectSoundBuffer::Unlock is called. High-performance applications can use this value to determine the time required for IDirectSoundBuffer::Unlock to execute. For software buffers located in system memory, the rate will be very high because no processing is required. For hardware buffers, the rate might be slower because the buffer might have to be downloaded to the sound card, which might have a limited transfer rate.""" + pass - @property - def dwBufferBytes(self)->'int': - """The size, in bytes, of the capture buffer.""" - pass + @property + def nAvgBytesPerSec(self) -> 'int': + """Specifies whether the returned handle is inherited when a new process is created. If this member is TRUE, the new process inherits the handle. Sentinel""" + pass -class PyDSCBUFFERDESC(object): - """A Python object, representing a DSCBUFFERDESC structure""" +class PyDSBUFFERDESC(object): + """A Python object, representing a DSBUFFERDESC structure""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def dwFlags(self) -> 'int': + """Identifies the capabilities to include when creating a new DirectSoundBuffer object. Specify one or more of the following:FlagDescriptionDSBCAPS_PRIMARYBUFFERIndicates that the buffer is a primary sound buffer. If this value is not specified, a secondary sound buffer will be created.DSBCAPS_STATICIndicates that the buffer will be used for static sound data. Typically, these buffers are loaded once and played many times. These buffers are candidates for hardware memory.DSBCAPS_LOCHARDWAREThe buffer is in hardware memory and uses hardware mixing.DSBCAPS_LOCSOFTWAREThe buffer is in software memory and uses software mixing.DSBCAPS_CTRL3DThe buffer is either a primary buffer or a secondary buffer that uses 3-D control. To create a primary buffer, the dwFlags member of the DSBUFFERDESC structure should include the DSBCAPS_PRIMARYBUFFER flag.DSBCAPS_CTRLFREQUENCYThe buffer must have frequency control capability.DSBCAPS_CTRLPANThe buffer must have pan control capability.DSBCAPS_CTRLVOLUMEThe buffer must have volume control capability.DSBCAPS_CTRLPOSITIONNOTIFYThe buffer must have control position notify capability.DSBCAPS_STICKYFOCUSChanges the focus behavior of the sound buffer. This flag can be specified in an IDirectSound::CreateSoundBuffer call. With this flag set, an application using DirectSound can continue to play its sticky focus buffers if the user switches to another application not using DirectSound. In this situation, the application's normal buffers are muted, but the sticky focus buffers are still audible. This is useful for nongame applications, such as movie playback (DirectShow™), when the user wants to hear the soundtrack while typing in Microsoft Word or MicrosoftÂŽ Excel, for example. However, if the user switches to another DirectSound application, all sound buffers, both normal and sticky focus, in the previous application are muted.DSBCAPS_GLOBALFOCUSThe buffer is a global sound buffer. With this flag set, an application using DirectSound can continue to play its buffers if the user switches focus to another application, even if the new application uses DirectSound. The one exception is if you switch focus to a DirectSound application that uses the DSSCL_EXCLUSIVE or DSSCL_WRITEPRIMARY flag for its cooperative level. In this case, the global sounds from other applications will not be audible.DSBCAPS_GETCURRENTPOSITION2Indicates that IDirectSoundBuffer::GetCurrentPosition should use the new behavior of the play cursor. In DirectSound in DirectX 1, the play cursor was significantly ahead of the actual playing sound on emulated sound cards; it was directly behind the write cursor. Now, if the DSBCAPS_GETCURRENTPOSITION2 flag is specified, the application can get a more accurate play position. If this flag is not specified, the old behavior is preserved for compatibility. Note that this flag affects only emulated sound cards; if a DirectSound driver is present, the play cursor is accurate for DirectSound in all versions of DirectX.DSBCAPS_MUTE3DATMAXDISTANCEThe sound is reduced to silence at the maximum distance. The buffer will stop playing when the maximum distance is exceeded, so that processor time is not wasted.""" + pass - @property - def dwFlags(self)->'int': - """Identifies the capabilities to include when creating a new DirectSoundBuffer object. Can be zero or the following flag:FlagDescriptionDSCBCAPS_WAVEMAPPEDThe Win32 wave mapper will be used for formats not supported by the device.""" - pass + @property + def dwBufferBytes(self) -> 'int': + """Size of the new buffer, in bytes. This value must be 0 when creating primary buffers. For secondary buffers, the minimum and maximum sizes allowed are specified by DSBSIZE_MIN and DSBSIZE_MAX.""" + pass + @property + def lpwfxFormat(self) -> 'Any': + """Structure specifying the waveform format for the buffer. This value must be None for primary buffers. The application can use IDirectSoundBuffer::SetFormat to set the format of the primary buffer. Sentinel""" + pass - @property - def dwBufferBytes(self)->'int': - """Size of the new buffer, in bytes. This value must be 0 when creating primary buffers. For secondary buffers, the minimum and maximum sizes allowed are specified by DSBSIZE_MIN and DSBSIZE_MAX.""" - pass +class PyDSCAPS(object): + """A Python object, representing a DSCAPS structure""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def dwFlags(self) -> 'int': + """Specifies device capabilities. Can be one or more of the following:FlagDescriptionDSCAPS_PRIMARYMONOThe device supports monophonic primary buffers.DSCAPS_PRIMARYSTEREOThe device supports stereo primary buffers.DSCAPS_PRIMARY8BITThe device supports hardware-mixed secondary buffers with 8-bit samples.DSCAPS_PRIMARY16BITThe device supports primary sound buffers with 16-bit samples.DSCAPS_CONTINUOUSRATEThe device supports all sample rates between the dwMinSecondarySampleRate and dwMaxSecondarySampleRate member values. Typically, this means that the actual output rate will be within +/- 10 hertz (Hz) of the requested frequency.DSCAPS_EMULDRIVERThe device does not have a DirectSound driver installed, so it is being emulated through the waveform-audio functions. Performance degradation should be expected.DSCAPS_CERTIFIEDThis driver has been tested and certified by Microsoft.DSCAPS_SECONDARYMONOThe device supports hardware-mixed monophonic secondary buffers.DSCAPS_SECONDARYSTEREOThe device supports hardware-mixed stereo secondary buffers.DSCAPS_SECONDARY8BITThe device supports hardware-mixed secondary buffers with 8-bit samples.DSCAPS_SECONDARY16BITThe device supports hardware-mixed secondary sound buffers with 16-bit samples.""" + pass + + @property + def dwMinSecondarySampleRate(self) -> 'int': + """Minimum sample rate supported by this device's hardware secondary sound buffers.""" + pass + + @property + def dwMaxSecondarySampleRate(self) -> 'int': + """Maximum sample rate supported by this device's hardware secondary sound buffers.""" + pass + + @property + def dwPrimaryBuffers(self) -> 'int': + """Number of primary buffers supported. This value will always be 1.""" + pass + + @property + def dwMaxHwMixingAllBuffers(self) -> 'int': + """Specifies the total number of buffers that can be mixed in hardware. This member can be less than the sum of dwMaxHwMixingStaticBuffers and dwMaxHwMixingStreamingBuffers. Resource tradeoffs frequently occur.""" + pass + + @property + def dwMaxHwMixingStaticBuffers(self) -> 'int': + """Specifies the maximum number of static sound buffers.""" + pass + + @property + def dwMaxHwMixingStreamingBuffers(self) -> 'int': + """Specifies the maximum number of streaming sound buffers.""" + pass + + @property + def dwFreeHwMixingAllBuffers(self) -> 'int': + """Description of the free hardware mixing capabilities of the device. An application can use this value to determine whether hardware resources are available for allocation to a secondary sound buffer. Also, by comparing these values to the members that specify maximum mixing capabilities, the resources that are already allocated can be determined.""" + pass + + @property + def dwFreeHwMixingStaticBuffers(self) -> 'int': + """Description of the free hardware mixing capabilities of the device. An application can use this value to determine whether hardware resources are available for allocation to a secondary sound buffer. Also, by comparing these values to the members that specify maximum mixing capabilities, the resources that are already allocated can be determined.""" + pass + + @property + def dwFreeHwMixingStreamingBuffers(self) -> 'int': + """Description of the free hardware mixing capabilities of the device. An application can use this value to determine whether hardware resources are available for allocation to a secondary sound buffer. Also, by comparing these values to the members that specify maximum mixing capabilities, the resources that are already allocated can be determined.""" + pass + + @property + def dwMaxHw3DAllBuffers(self) -> 'int': + """Description of the hardware 3-D positional capabilities of the device.""" + pass + + @property + def dwMaxHw3DStaticBuffers(self) -> 'int': + """Description of the hardware 3-D positional capabilities of the device.""" + pass + + @property + def dwMaxHw3DStreamingBuffers(self) -> 'int': + """Description of the hardware 3-D positional capabilities of the device.""" + pass + + @property + def dwFreeHw3DAllBuffers(self) -> 'int': + """Description of the free, or unallocated, hardware 3-D positional capabilities of the device.""" + pass + + @property + def dwFreeHw3DStaticBuffers(self) -> 'int': + """Description of the free, or unallocated, hardware 3-D positional capabilities of the device.""" + pass + + @property + def dwFreeHw3DStreamingBuffers(self) -> 'int': + """Description of the free, or unallocated, hardware 3-D positional capabilities of the device.""" + pass + + @property + def dwTotalHwMemBytes(self) -> 'int': + """Size, in bytes, of the amount of memory on the sound card that stores static sound buffers.""" + pass + + @property + def dwFreeHwMemBytes(self) -> 'int': + """Size, in bytes, of the free memory on the sound card.""" + pass + + @property + def dwMaxContigFreeHwMemBytes(self) -> 'int': + """Size, in bytes, of the largest contiguous block of free memory on the sound card.""" + pass + + @property + def dwUnlockTransferRateHwBuffers(self) -> 'int': + """Description of the rate, in kilobytes per second, at which data can be transferred to hardware static sound buffers. This and the number of bytes transferred determines the duration of a call to the IDirectSoundBuffer::Update method.""" + pass + + @property + def dwPlayCpuOverheadSwBuffers(self) -> 'int': + """Description of the processing overhead, as a percentage of the central processing unit, needed to mix software buffers (those located in main system memory). This varies according to the bus type, the processor type, and the clock speed. The unlock transfer rate for software buffers is 0 because the data need not be transferred anywhere. Similarly, the play processing overhead for hardware buffers is 0 because the mixing is done by the sound device.""" + pass - @property - def lpwfxFormat(self)->'Any': - """Structure specifying the waveform format for the buffer. This value must be None for primary buffers. The application can use IDirectSoundBuffer::SetFormat to set the format of the primary buffer. Sentinel""" - pass +class PyDSCBCAPS(object): + """A Python object, representing a DSCBCAPS structure""" -class PyDSCCAPS(object): - """A Python object, representing a DSCCAPS structure""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + @property + def dwFlags(self) -> 'int': + """Specifies device capabilities. Can be 0 or DSCBCAPS_EMULDRIVER (indicates that no DirectSound Device is available and standard wave audio functions are being used).""" + pass + @property + def dwBufferBytes(self) -> 'int': + """The size, in bytes, of the capture buffer.""" + pass - @property - def dwFlags(self)->'int': - """Specifies device capabilities. Can be zero or the following flag:FlagDescriptionDSCCAPS_EMULDRIVERIndicates that no DirectSound Device is available and standard wave audio functions are being used.""" - pass +class PyDSCBUFFERDESC(object): + """A Python object, representing a DSCBUFFERDESC structure""" - @property - def dwFormats(self)->'int': - """Bitset of supported WAVE_FORMAT formats.""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def dwFlags(self) -> 'int': + """Identifies the capabilities to include when creating a new DirectSoundBuffer object. Can be zero or the following flag:FlagDescriptionDSCBCAPS_WAVEMAPPEDThe Win32 wave mapper will be used for formats not supported by the device.""" + pass - @property - def dwChannels(self)->'int': - """Number of channels supported by the device.""" - pass + @property + def dwBufferBytes(self) -> 'int': + """Size of the new buffer, in bytes. This value must be 0 when creating primary buffers. For secondary buffers, the minimum and maximum sizes allowed are specified by DSBSIZE_MIN and DSBSIZE_MAX.""" + pass + @property + def lpwfxFormat(self) -> 'Any': + """Structure specifying the waveform format for the buffer. This value must be None for primary buffers. The application can use IDirectSoundBuffer::SetFormat to set the format of the primary buffer. Sentinel""" + pass -class PyDSOP_FILTER_FLAGS(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyDSCCAPS(object): + """A Python object, representing a DSCCAPS structure""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def uplevel(self)->'Any': - """""" - pass + @property + def dwFlags(self) -> 'int': + """Specifies device capabilities. Can be zero or the following flag:FlagDescriptionDSCCAPS_EMULDRIVERIndicates that no DirectSound Device is available and standard wave audio functions are being used.""" + pass + @property + def dwFormats(self) -> 'int': + """Bitset of supported WAVE_FORMAT formats.""" + pass - @property - def downlevel(self)->'Any': - """""" - pass + @property + def dwChannels(self) -> 'int': + """Number of channels supported by the device.""" + pass -class PyDSOP_SCOPE_INIT_INFO(object): - """""" +class PyDSOP_FILTER_FLAGS(object): + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def uplevel(self) -> 'Any': + """""" + pass - @property - def type(self)->'Any': - """""" - pass + @property + def downlevel(self) -> 'Any': + """""" + pass - @property - def scope(self)->'Any': - """""" - pass +class PyDSOP_SCOPE_INIT_INFO(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def hr(self)->'Any': - """""" - pass + @property + def type(self) -> 'Any': + """""" + pass + @property + def scope(self) -> 'Any': + """""" + pass - @property - def dcName(self)->'str': - """""" - pass + @property + def hr(self) -> 'Any': + """""" + pass + @property + def dcName(self) -> 'str': + """""" + pass - @property - def filterFlags(self)->'Any': - """""" - pass + @property + def filterFlags(self) -> 'Any': + """""" + pass class PyDSOP_SCOPE_INIT_INFOs(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyDSOP_UPLEVEL_FILTER_FLAGS(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def bothModes(self)->'Any': - """""" - pass + @property + def bothModes(self) -> 'Any': + """""" + pass + @property + def mixedModeOnly(self) -> 'Any': + """""" + pass - @property - def mixedModeOnly(self)->'Any': - """""" - pass - - - @property - def nativeModeOnly(self)->'Any': - """""" - pass + @property + def nativeModeOnly(self) -> 'Any': + """""" + pass class PyFORMATETC(object): - """Tuple representing a FORMATETC struct describing an OLE data format""" + """Tuple representing a FORMATETC struct describing an OLE data format""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyGFileOperationProgressSink(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - - def StartOperations(self,) -> 'None': - """ + def StartOperations(self,) -> 'None': + """ Called as operation begins, before any modifications are done Args: @@ -11226,13 +10641,12 @@ Args: Returns: None - - """ - pass + """ + pass - def FinishOperations(self,Result:'Any') -> 'None': - """ + def FinishOperations(self, Result: 'Any') -> 'None': + """ Called after all actions have been performed Args: @@ -11242,13 +10656,12 @@ Args: Returns: None - - """ - pass + """ + pass - def PreRenameItem(self,Flags:'Any',Item:'Any',NewName:'Any') -> 'None': - """ + def PreRenameItem(self, Flags: 'Any', Item: 'Any', NewName: 'Any') -> 'None': + """ Called before each file rename Args: @@ -11260,13 +10673,12 @@ Args: Returns: None - - """ - pass + """ + pass - def PostRenameItem(self,Flags:'Any',Item:'Any',NewName:'Any',hrRename:'Any',NewlyCreated:'Any') -> 'None': - """ + def PostRenameItem(self, Flags: 'Any', Item: 'Any', NewName: 'Any', hrRename: 'Any', NewlyCreated: 'Any') -> 'None': + """ Called after each file rename Args: @@ -11280,13 +10692,12 @@ Args: Returns: None - - """ - pass + """ + pass - def PreMoveItem(self,Flags:'Any',Item:'Any',DestinationFolder:'Any',NewName:'Any') -> 'None': - """ + def PreMoveItem(self, Flags: 'Any', Item: 'Any', DestinationFolder: 'Any', NewName: 'Any') -> 'None': + """ Called before each move operation Args: @@ -11299,13 +10710,19 @@ Args: Returns: None - - """ - pass + """ + pass - def PostMoveItem(self,Flags:'Any',Item:'Any',DestinationFolder:'Any',NewName:'Any',hrMove:'Any',NewlyCreated:'Any') -> 'None': - """ + def PostMoveItem( + self, + Flags: 'Any', + Item: 'Any', + DestinationFolder: 'Any', + NewName: 'Any', + hrMove: 'Any', + NewlyCreated: 'Any') -> 'None': + """ Called after each move operation Args: @@ -11320,13 +10737,12 @@ Args: Returns: None - - """ - pass + """ + pass - def PreCopyItem(self,Flags:'Any',Item:'Any',DestinationFolder:'Any',NewName:'Any') -> 'None': - """ + def PreCopyItem(self, Flags: 'Any', Item: 'Any', DestinationFolder: 'Any', NewName: 'Any') -> 'None': + """ Called before each copy operation Args: @@ -11339,13 +10755,19 @@ Args: Returns: None - - """ - pass + """ + pass - def PostCopyItem(self,Flags:'Any',Item:'Any',DestinationFolder:'Any',NewName:'Any',hrCopy:'Any',NewlyCreated:'Any') -> 'None': - """ + def PostCopyItem( + self, + Flags: 'Any', + Item: 'Any', + DestinationFolder: 'Any', + NewName: 'Any', + hrCopy: 'Any', + NewlyCreated: 'Any') -> 'None': + """ Called after each copy operation Args: @@ -11360,13 +10782,12 @@ Args: Returns: None - - """ - pass + """ + pass - def PreDeleteItem(self,Flags:'Any',Item:'Any') -> 'None': - """ + def PreDeleteItem(self, Flags: 'Any', Item: 'Any') -> 'None': + """ Called before each delete operation Args: @@ -11377,13 +10798,12 @@ Args: Returns: None - - """ - pass + """ + pass - def PostDeleteItem(self,Flags:'Any',Item:'Any',hrDelete:'Any',NewlyCreated:'Any') -> 'None': - """ + def PostDeleteItem(self, Flags: 'Any', Item: 'Any', hrDelete: 'Any', NewlyCreated: 'Any') -> 'None': + """ Called after each delete operation Args: @@ -11396,13 +10816,12 @@ Args: Returns: None - - """ - pass + """ + pass - def PreNewItem(self,Flags:'Any',DestinationFolder:'Any',NewName:'Any') -> 'None': - """ + def PreNewItem(self, Flags: 'Any', DestinationFolder: 'Any', NewName: 'Any') -> 'None': + """ Called before each new file is created Args: @@ -11414,13 +10833,20 @@ Args: Returns: None - - """ - pass + """ + pass - def PostNewItem(self,Flags:'Any',DestinationFolder:'Any',NewName:'Any',TemplateName:'Any',FileAttributes:'Any',hrNew:'Any',NewItem:'Any') -> 'None': - """ + def PostNewItem( + self, + Flags: 'Any', + DestinationFolder: 'Any', + NewName: 'Any', + TemplateName: 'Any', + FileAttributes: 'Any', + hrNew: 'Any', + NewItem: 'Any') -> 'None': + """ Called after each new file is created Args: @@ -11436,13 +10862,12 @@ Args: Returns: None - - """ - pass + """ + pass - def UpdateProgress(self,WorkTotal:'Any',WorkSoFar:'Any') -> 'None': - """ + def UpdateProgress(self, WorkTotal: 'Any', WorkSoFar: 'Any') -> 'None': + """ Gives an estimate of total work completed Args: @@ -11453,13 +10878,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ResetTimer(self,) -> 'None': - """ + def ResetTimer(self,) -> 'None': + """ Not implemented, according to MSDN Args: @@ -11469,13 +10893,12 @@ Args: Returns: None - - """ - pass + """ + pass - def PauseTimer(self,) -> 'None': - """ + def PauseTimer(self,) -> 'None': + """ Not implemented, according to MSDN Args: @@ -11485,13 +10908,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ResumeTimer(self,) -> 'None': - """ + def ResumeTimer(self,) -> 'None': + """ Not implemented, according to MSDN Args: @@ -11501,21 +10923,20 @@ Args: Returns: None - - """ - pass + """ + pass -class PyGSecurityInformation(object): - """Gateway wrapper for the implement-only ISecurityInformation interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyGSecurityInformation(object): + """Gateway wrapper for the implement-only ISecurityInformation interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetObjectInformation(self,) -> 'Any': - """ - Returns information identifying the object + def GetObjectInformation(self,) -> 'Any': + """ + Returns information identifying the object whose security is to be editted, and which pages are to appear in the property sheet @@ -11526,44 +10947,42 @@ Args: Returns: Any: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 + """ + pass - def GetSecurity(self,RequestedInformation:'Any',Default:'Any') -> 'PySECURITY_DESCRIPTOR': - """ - Retrieves the object's current security + def GetSecurity(self, RequestedInformation: 'Any', Default: 'Any') -> 'PySECURITY_DESCRIPTOR': + """ + Retrieves the object's current security settings Args: RequestedInformation(Any):Combination of SECURITY_INFORMATION flags indicating which components of the object's security descriptor you should return - Default(Any):If true, return a default security descriptor rather than current security. (invoked when 'Reset' button is clicked) + default(Any):If true, return a default security descriptor rather than current security. (invoked when 'Reset' button is clicked) Returns: PySECURITY_DESCRIPTOR - - """ - pass + """ + pass - def SetSecurity(self,SecurityInformation:'Any',SecurityDescriptor:'PySECURITY_DESCRIPTOR') -> 'None': - """ + def SetSecurity(self, SecurityInformation: 'Any', SecurityDescriptor: 'PySECURITY_DESCRIPTOR') -> 'None': + """ Applies the modified security to the object Args: @@ -11575,13 +10994,12 @@ Returns: None:The security information to be applied to the objectReturn ValueAny returned value is ignored - - """ - pass + """ + pass - def GetAccessRights(self,ObjectType:'PyIID',Flags:'Any') -> 'Tuple[Any, Any]': - """ + def GetAccessRights(self, ObjectType: 'PyIID', Flags: 'Any') -> 'Tuple[Any, Any]': + """ Retrieves permission that can be set Args: @@ -11591,19 +11009,18 @@ Args: Returns: - Tuple[Any, Any]:Indicates which page is requesting the access rights (SI_ADVANCED, SI_EDIT_AUDITS, + Tuple[Any, 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 + """ + pass - def MapGeneric(self,ObjectType:'PyIID',AceFlags:'Any',Mask:'Any') -> 'Any': - """ + def MapGeneric(self, ObjectType: 'PyIID', AceFlags: 'Any', Mask: 'Any') -> 'Any': + """ Translates generic access rights to specific equivalents Args: @@ -11619,14 +11036,13 @@ Returns: See win32security::MapGenericMask Return ValueThis method should return the input bitmask will all generic rights mapped to specific rights - - """ - pass + """ + pass - def GetInheritTypes(self,) -> 'Tuple[Any, ...]': - """ - Requests types of inheritance that your + def GetInheritTypes(self,) -> 'Tuple[Any, ...]': + """ + Requests types of inheritance that your implementation supports @@ -11638,18 +11054,17 @@ Returns: Tuple[Any, ...]: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 + """ + pass - def PropertySheetPageCallback(self,hwnd:'Any',Msg:'Any',Page:'Any') -> 'None': - """ + def PropertySheetPageCallback(self, hwnd: 'Any', Msg: 'Any', Page: 'Any') -> 'None': + """ Called by each page as it is created and destroyed Args: @@ -11662,20 +11077,19 @@ Returns: None:SI_PAGE_TYPE value indicating which page is making the call (ntsecuritycon.SI_PAGE_*)Return ValueAny returned value will be ignored - - """ - pass + """ + pass -class PyIADesktopP2(object): - """An interface to the ActiveDesktop""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIADesktopP2(object): + """An interface to the ActiveDesktop""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def UpdateAllDesktopSubscriptions(self,) -> 'None': - """ + def UpdateAllDesktopSubscriptions(self,) -> 'None': + """ Updates webpage subscriptions on the desktop Args: @@ -11685,68 +11099,60 @@ Args: Returns: None - - """ - pass + + """ + 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.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ADsPath(self)->'str': - """""" - pass - - - @property - def AdsPath(self)->'str': - """Synonym for ADsPath""" - pass - - - @property - def Class(self)->'str': - """""" - pass - - - @property - def GUID(self)->'str': - """Like the IADs method, this returns a string rather than a GUID object.""" - pass - - - @property - def Name(self)->'str': - """""" - pass - - - @property - def Parent(self)->'str': - """""" - pass - - - @property - def Schema(self)->'str': - """""" - pass - - - def GetInfo(self,) -> 'None': - """ + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def ADsPath(self) -> 'str': + """""" + pass + + @property + def AdsPath(self) -> 'str': + """Synonym for ADsPath""" + pass + + @property + def Class(self) -> 'str': + """""" + pass + + @property + def GUID(self) -> 'str': + """Like the IADs method, this returns a string rather than a GUID object.""" + pass + + @property + def Name(self) -> 'str': + """""" + pass + + @property + def Parent(self) -> 'str': + """""" + pass + + @property + def Schema(self) -> 'str': + """""" + pass + + def GetInfo(self,) -> 'None': + """ Description of GetInfo. Args: @@ -11756,13 +11162,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetInfo(self,) -> 'None': - """ + def SetInfo(self,) -> 'None': + """ Description of SetInfo. Args: @@ -11772,13 +11177,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Get(self,prop:'str') -> 'Any': - """ + def Get(self, prop: 'str') -> 'Any': + """ Description of Get. Args: @@ -11787,17 +11191,16 @@ Args: Returns: - Any:The name of the property to fetchReturn ValueThe result is a Python object converted from a COM variant. It + 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 + """ + pass - def Put(self,_property:'str',val:'Any') -> 'None': - """ + def Put(self, _property: 'str', val: 'Any') -> 'None': + """ Description of Put. Args: @@ -11808,13 +11211,12 @@ Args: Returns: None - - """ - pass + """ + pass - def get(self,prop:'str') -> 'Any': - """ + def get(self, prop: 'str') -> 'Any': + """ Description of Get. Args: @@ -11823,17 +11225,16 @@ Args: Returns: - Any:The name of the property to fetchReturn ValueThe result is a Python object converted from a COM variant. It + 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 + """ + pass - def put(self,_property:'str',val:'Any') -> 'None': - """ + def put(self, _property: 'str', val: 'Any') -> 'None': + """ Description of Put. Args: @@ -11844,20 +11245,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIADsContainer(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIADsContainer(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetObject(self,_class:'str',relativeName:'str') -> 'Any': - """ + def GetObject(self, _class: 'str', relativeName: 'str') -> 'Any': + """ None Args: @@ -11868,13 +11268,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def get_Count(self,) -> 'Any': - """ + def get_Count(self,) -> 'Any': + """ None Args: @@ -11884,13 +11283,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def get_Filter(self,) -> 'Any': - """ + def get_Filter(self,) -> 'Any': + """ None Args: @@ -11900,13 +11298,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def put_Filter(self,val:'Any') -> 'None': - """ + def put_Filter(self, val: 'Any') -> 'None': + """ None Args: @@ -11916,13 +11313,12 @@ Args: Returns: None - - """ - pass + """ + pass - def get_Hints(self,) -> 'Any': - """ + def get_Hints(self,) -> 'Any': + """ None Args: @@ -11932,13 +11328,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def put_Hints(self,val:'Any') -> 'None': - """ + def put_Hints(self, val: 'Any') -> 'None': + """ None Args: @@ -11948,20 +11343,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIADsUser(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIADsUser(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def get_AccountDisabled(self,) -> 'Any': - """ + def get_AccountDisabled(self,) -> 'Any': + """ None Args: @@ -11971,13 +11365,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def put_AccountDisabled(self,val:'Any') -> 'None': - """ + def put_AccountDisabled(self, val: 'Any') -> 'None': + """ None Args: @@ -11987,13 +11380,12 @@ Args: Returns: None - - """ - pass + """ + pass - def get_AccountExpirationDate(self,) -> 'Any': - """ + def get_AccountExpirationDate(self,) -> 'Any': + """ None Args: @@ -12003,13 +11395,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def put_AccountExpirationDate(self,val:'PyTime') -> 'None': - """ + def put_AccountExpirationDate(self, val: 'PyTime') -> 'None': + """ None Args: @@ -12019,13 +11410,12 @@ Args: Returns: None - - """ - pass + """ + pass - def get_BadLoginAddress(self,) -> 'Any': - """ + def get_BadLoginAddress(self,) -> 'Any': + """ None Args: @@ -12035,13 +11425,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def get_BadLoginCount(self,) -> 'Any': - """ + def get_BadLoginCount(self,) -> 'Any': + """ None Args: @@ -12051,13 +11440,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def get_Department(self,) -> 'Any': - """ + def get_Department(self,) -> 'Any': + """ None Args: @@ -12067,13 +11455,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def put_Department(self,val:'Any') -> 'None': - """ + def put_Department(self, val: 'Any') -> 'None': + """ None Args: @@ -12083,13 +11470,12 @@ Args: Returns: None - - """ - pass + """ + pass - def get_Description(self,) -> 'Any': - """ + def get_Description(self,) -> 'Any': + """ None Args: @@ -12099,13 +11485,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def put_Description(self,val:'Any') -> 'None': - """ + def put_Description(self, val: 'Any') -> 'None': + """ None Args: @@ -12115,13 +11500,12 @@ Args: Returns: None - - """ - pass + """ + pass - def get_Division(self,) -> 'Any': - """ + def get_Division(self,) -> 'Any': + """ None Args: @@ -12131,13 +11515,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def put_Division(self,val:'Any') -> 'None': - """ + def put_Division(self, val: 'Any') -> 'None': + """ None Args: @@ -12147,13 +11530,12 @@ Args: Returns: None - - """ - pass + """ + pass - def get_EmailAddress(self,) -> 'Any': - """ + def get_EmailAddress(self,) -> 'Any': + """ None Args: @@ -12163,13 +11545,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def put_EmailAddress(self,val:'Any') -> 'None': - """ + def put_EmailAddress(self, val: 'Any') -> 'None': + """ None Args: @@ -12179,13 +11560,12 @@ Args: Returns: None - - """ - pass + """ + pass - def get_EmployeeID(self,) -> 'Any': - """ + def get_EmployeeID(self,) -> 'Any': + """ None Args: @@ -12195,13 +11575,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def put_EmployeeID(self,val:'Any') -> 'None': - """ + def put_EmployeeID(self, val: 'Any') -> 'None': + """ None Args: @@ -12211,13 +11590,12 @@ Args: Returns: None - - """ - pass + """ + pass - def get_FirstName(self,) -> 'Any': - """ + def get_FirstName(self,) -> 'Any': + """ None Args: @@ -12227,13 +11605,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def put_FirstName(self,val:'Any') -> 'None': - """ + def put_FirstName(self, val: 'Any') -> 'None': + """ None Args: @@ -12243,13 +11620,12 @@ Args: Returns: None - - """ - pass + """ + pass - def get_FullName(self,) -> 'Any': - """ + def get_FullName(self,) -> 'Any': + """ None Args: @@ -12259,13 +11635,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def put_FullName(self,val:'Any') -> 'None': - """ + def put_FullName(self, val: 'Any') -> 'None': + """ None Args: @@ -12275,13 +11650,12 @@ Args: Returns: None - - """ - pass + """ + pass - def get_HomeDirectory(self,) -> 'Any': - """ + def get_HomeDirectory(self,) -> 'Any': + """ None Args: @@ -12291,13 +11665,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def put_HomeDirectory(self,val:'Any') -> 'None': - """ + def put_HomeDirectory(self, val: 'Any') -> 'None': + """ None Args: @@ -12307,13 +11680,12 @@ Args: Returns: None - - """ - pass + """ + pass - def get_HomePage(self,) -> 'Any': - """ + def get_HomePage(self,) -> 'Any': + """ None Args: @@ -12323,13 +11695,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def put_HomePage(self,val:'Any') -> 'None': - """ + def put_HomePage(self, val: 'Any') -> 'None': + """ None Args: @@ -12339,13 +11710,12 @@ Args: Returns: None - - """ - pass + """ + pass - def get_LoginScript(self,) -> 'Any': - """ + def get_LoginScript(self,) -> 'Any': + """ None Args: @@ -12355,13 +11725,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def put_LoginScript(self,val:'Any') -> 'None': - """ + def put_LoginScript(self, val: 'Any') -> 'None': + """ None Args: @@ -12371,13 +11740,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetPassword(self,val:'Any') -> 'None': - """ + def SetPassword(self, val: 'Any') -> 'None': + """ None Args: @@ -12387,13 +11755,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ChangePassword(self,oldval:'Any',newval:'Any') -> 'None': - """ + def ChangePassword(self, oldval: 'Any', newval: 'Any') -> 'None': + """ None Args: @@ -12404,20 +11771,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIActiveDesktop(object): - """An interface to the ActiveDesktop""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIActiveDesktop(object): + """An interface to the ActiveDesktop""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def ApplyChanges(self,Flags:'Any') -> 'None': - """ + def ApplyChanges(self, Flags: 'Any') -> 'None': + """ Applies changes to ActiveDesktop settings and persists them to the registry. Args: @@ -12427,13 +11793,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetWallpaper(self,cchWallpaper:'Any',Reserved:'Any'=0) -> 'Any': - """ + def GetWallpaper(self, cchWallpaper: 'Any', Reserved: 'Any' = 0) -> 'Any': + """ Returns the current wallpaper Args: @@ -12444,13 +11809,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetWallpaper(self,Wallpaper:'Any',Reserved:'Any'=0) -> 'None': - """ + def SetWallpaper(self, Wallpaper: 'Any', Reserved: 'Any' = 0) -> 'None': + """ Sets the desktop wallpaper Args: @@ -12461,13 +11825,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetWallpaperOptions(self,Reserved:'Any'=0) -> 'Any': - """ + def GetWallpaperOptions(self, Reserved: 'Any' = 0) -> 'Any': + """ Returns wallpaper style Args: @@ -12479,13 +11842,12 @@ Returns: Any:Use 0 if passed in Return ValueReturns one of the WPSTYLE_* values - - """ - pass + """ + pass - def SetWallpaperOptions(self,Style:'Any',Reserved:'Any'=0) -> 'None': - """ + def SetWallpaperOptions(self, Style: 'Any', Reserved: 'Any' = 0) -> 'None': + """ Sets wallpaper style Args: @@ -12496,13 +11858,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetPattern(self,cchPattern:'Any'=1024,Reserved:'Any'=0) -> 'None': - """ + def GetPattern(self, cchPattern: 'Any' = 1024, Reserved: 'Any' = 0) -> 'None': + """ Returns the wallpaper pattern Args: @@ -12515,13 +11876,12 @@ Returns: None:Use 0 if passed in Return ValueReturns a unicode string containing decimal values representing the pattern - - """ - pass + """ + pass - def SetPattern(self,Pattern:'Any',Reserved:'Any'=0) -> 'None': - """ + def SetPattern(self, Pattern: 'Any', Reserved: 'Any' = 0) -> 'None': + """ Sets the wallpaper pattern Args: @@ -12532,13 +11892,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetDesktopItemOptions(self,) -> 'Any': - """ + def GetDesktopItemOptions(self,) -> 'Any': + """ Returns options for Active Desktop. Args: @@ -12552,13 +11911,12 @@ Returns: dict = GetDesktopItemOptions()Returns options for Active Desktop. Return ValueReturns a COMPONENTSOPT dictionary - - """ - pass + """ + pass - def SetDesktopItemOptions(self,comp:'Any',Reserved:'Any'=0) -> 'None': - """ + def SetDesktopItemOptions(self, comp: 'Any', Reserved: 'Any' = 0) -> 'None': + """ Sets Active Desktop options Args: @@ -12569,13 +11927,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AddDesktopItem(self,comp:'Any',Reserved:'Any'=0) -> 'None': - """ + def AddDesktopItem(self, comp: 'Any', Reserved: 'Any' = 0) -> 'None': + """ Creates a new item to display on the desktop Args: @@ -12586,13 +11943,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AddDesktopItemWithUI(self,hwnd:'int',comp:'Any',Flags:'Any') -> 'None': - """ + def AddDesktopItemWithUI(self, hwnd: 'int', comp: 'Any', Flags: 'Any') -> 'None': + """ Adds a desktop item, allowing user interaction Args: @@ -12604,13 +11960,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ModifyDesktopItem(self,comp:'Any',Flags:'Any') -> 'None': - """ + def ModifyDesktopItem(self, comp: 'Any', Flags: 'Any') -> 'None': + """ Changes parameters for a desktop item Args: @@ -12621,13 +11976,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RemoveDesktopItem(self,comp:'Any',Reserved:'Any'=0) -> 'None': - """ + def RemoveDesktopItem(self, comp: 'Any', Reserved: 'Any' = 0) -> 'None': + """ Removes an item from the Active Desktop Args: @@ -12638,13 +11992,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetDesktopItemCount(self,) -> 'None': - """ + def GetDesktopItemCount(self,) -> 'None': + """ Returns number of defined desktop items. Args: @@ -12654,13 +12007,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetDesktopItem(self,Component:'Any',Reserved:'Any'=0) -> 'Any': - """ + def GetDesktopItem(self, Component: 'Any', Reserved: 'Any' = 0) -> 'Any': + """ Returns desktop item parameters by index Args: @@ -12673,13 +12025,12 @@ Returns: Any:Use 0 if passed in Return ValueReturns a COMPONENT dictionary describing the item - - """ - pass + """ + pass - def GetDesktopItemByID(self,ID:'Any',reserved:'Any'=0) -> 'Any': - """ + def GetDesktopItemByID(self, ID: 'Any', reserved: 'Any' = 0) -> 'Any': + """ Returns desktop item parameters by Id Args: @@ -12692,13 +12043,12 @@ Returns: Any:Use 0 if passed in Return ValueReturns a COMPONENT dictionary - - """ - pass + """ + pass - def GenerateDesktopItemHtml(self,FileName:'Any',comp:'Any',Reserved:'Any'=0) -> 'None': - """ + def GenerateDesktopItemHtml(self, FileName: 'Any', comp: 'Any', Reserved: 'Any' = 0) -> 'None': + """ Creates an HTML page for the desktop item Args: @@ -12710,13 +12060,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AddUrl(self,hwnd:'int',Source:'Any',comp:'Any',Flags:'Any') -> 'None': - """ + def AddUrl(self, hwnd: 'int', Source: 'Any', comp: 'Any', Flags: 'Any') -> 'None': + """ Adds a web page to desktop, allowing user interaction Args: @@ -12729,13 +12078,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetDesktopItemBySource(self,Source:'Any',Reserved:'Any'=0) -> 'Any': - """ + def GetDesktopItemBySource(self, Source: 'Any', Reserved: 'Any' = 0) -> 'Any': + """ Returns desktop item parameters by URL Args: @@ -12748,20 +12096,19 @@ Returns: Any:Use 0 if passed in Return ValueReturns a COMPONENT dictionary - - """ - pass + """ + pass -class PyIActiveDesktopP(object): - """An interface to the ActiveDesktop""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIActiveDesktopP(object): + """An interface to the ActiveDesktop""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def SetSafeMode(self,Flags:'Any') -> 'None': - """ + def SetSafeMode(self, Flags: 'Any') -> 'None': + """ Changes Active Desktop to safe mode Args: @@ -12771,21 +12118,20 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIActiveScriptDebug(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIActiveScriptDebug(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetScriptTextAttributes(self,pstrCode:'str',pstrDelimiter:'str',dwFlags:'Any') -> 'Tuple[Any, ...]': - """ - Returns the text attributes for an arbitrary block + def GetScriptTextAttributes(self, pstrCode: 'str', pstrDelimiter: 'str', dwFlags: 'Any') -> 'Tuple[Any, ...]': + """ + Returns the text attributes for an arbitrary block of script text. @@ -12798,13 +12144,12 @@ Args: Returns: Tuple[Any, ...] - - """ - pass + """ + pass - def GetScriptletTextAttributes(self,pstrCode:'str',pstrDelimiter:'str',dwFlags:'Any') -> 'None': - """ + def GetScriptletTextAttributes(self, pstrCode: 'str', pstrDelimiter: 'str', dwFlags: 'Any') -> 'None': + """ Description of GetScriptletTextAttributes. Args: @@ -12816,13 +12161,12 @@ Args: Returns: None - - """ - pass + """ + pass - def EnumCodeContextsOfPosition(self,dwSourceContext:'Any',uCharacterOffset:'Any',uNumChars:'Any') -> 'None': - """ + def EnumCodeContextsOfPosition(self, dwSourceContext: 'Any', uCharacterOffset: 'Any', uNumChars: 'Any') -> 'None': + """ Description of EnumCodeContextsOfPosition. Args: @@ -12834,20 +12178,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIActiveScriptError(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIActiveScriptError(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetExceptionInfo(self,) -> 'None': - """ + def GetExceptionInfo(self,) -> 'None': + """ Description of GetExceptionInfo. Args: @@ -12857,13 +12200,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetSourcePosition(self,) -> 'None': - """ + def GetSourcePosition(self,) -> 'None': + """ Description of GetSourcePosition. Args: @@ -12873,13 +12215,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetSourceLineText(self,) -> 'None': - """ + def GetSourceLineText(self,) -> 'None': + """ Description of GetSourceLineText. Args: @@ -12889,20 +12230,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIActiveScriptErrorDebug(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIActiveScriptErrorDebug(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetDocumentContext(self,) -> 'None': - """ + def GetDocumentContext(self,) -> 'None': + """ Description of GetDocumentContext. Args: @@ -12912,13 +12252,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetStackFrame(self,) -> 'None': - """ + def GetStackFrame(self,) -> 'None': + """ Description of GetStackFrame. Args: @@ -12928,20 +12267,29 @@ Args: Returns: None - - """ - pass - - -class PyIActiveScriptParseProcedure(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """ + pass - def ParseProcedureText(self,pstrCode:'Any',pstrFormalParams:'Any',pstrProcedureName:'Any',pstrItemName:'Any',punkContext:'Any',pstrDelimiter:'Any',dwSourceContextCookie:'Any',ulStartingLineNumber:'Any',dwFlags:'Any') -> 'None': - """ +class PyIActiveScriptParseProcedure(object): + """Description of the interface""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + def ParseProcedureText( + self, + pstrCode: 'Any', + pstrFormalParams: 'Any', + pstrProcedureName: 'Any', + pstrItemName: 'Any', + punkContext: 'Any', + pstrDelimiter: 'Any', + dwSourceContextCookie: 'Any', + ulStartingLineNumber: 'Any', + dwFlags: 'Any') -> 'None': + """ Description of ParseProcedureText. Args: @@ -12959,20 +12307,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIActiveScriptSite(object): - """An object providing the IActiveScriptSite interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIActiveScriptSite(object): + """An object providing the IActiveScriptSite interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetLCID(self,) -> 'Any': - """ + def GetLCID(self,) -> 'Any': + """ None Args: @@ -12982,13 +12329,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetItemInfo(self,) -> 'Any': - """ + def GetItemInfo(self,) -> 'Any': + """ None Args: @@ -12998,13 +12344,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetDocVersionString(self,) -> 'Any': - """ + def GetDocVersionString(self,) -> 'Any': + """ None Args: @@ -13014,13 +12359,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OnStateChange(self,) -> 'Any': - """ + def OnStateChange(self,) -> 'Any': + """ None Args: @@ -13030,13 +12374,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OnEnterScript(self,) -> 'Any': - """ + def OnEnterScript(self,) -> 'Any': + """ None Args: @@ -13046,13 +12389,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OnLeaveScript(self,) -> 'Any': - """ + def OnLeaveScript(self,) -> 'Any': + """ None Args: @@ -13062,13 +12404,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OnScriptError(self,) -> 'Any': - """ + def OnScriptError(self,) -> 'Any': + """ None Args: @@ -13078,13 +12419,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OnScriptTerminate(self,) -> 'Any': - """ + def OnScriptTerminate(self,) -> 'Any': + """ None Args: @@ -13094,20 +12434,23 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIActiveScriptSiteDebug(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIActiveScriptSiteDebug(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetDocumentContextFromPosition(self,dwSourceContext:'Any',uCharacterOffset:'Any',uNumChars:'Any') -> 'None': - """ + def GetDocumentContextFromPosition( + self, + dwSourceContext: 'Any', + uCharacterOffset: 'Any', + uNumChars: 'Any') -> 'None': + """ Description of GetDocumentContextFromPosition. Args: @@ -13119,13 +12462,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetApplication(self,) -> 'None': - """ + def GetApplication(self,) -> 'None': + """ Description of GetApplication. Args: @@ -13135,13 +12477,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetRootApplicationNode(self,) -> 'None': - """ + def GetRootApplicationNode(self,) -> 'None': + """ Description of GetRootApplicationNode. Args: @@ -13151,14 +12492,13 @@ Args: Returns: None - - """ - pass + """ + pass - def OnScriptErrorDebug(self,) -> 'Tuple[Any, Any]': - """ - Allows a smart host to control the handling of runtime + def OnScriptErrorDebug(self,) -> 'Tuple[Any, Any]': + """ + Allows a smart host to control the handling of runtime errors @@ -13170,25 +12510,24 @@ Returns: Tuple[Any, 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 + """ + pass -class PyIAddrBook(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIAddrBook(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def ResolveName(self,uiParm:'Any',flags:'Any',entryTitle:'str',ADRLIST:'Any') -> 'None': - """ + def ResolveName(self, uiParm: 'Any', flags: 'Any', entryTitle: 'str', ADRLIST: 'Any') -> 'None': + """ Performs name resolution, assigning entry identifiers to recipients in a recipient list. Args: @@ -13201,13 +12540,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OpenEntry(self,entryId:'str',iid:'PyIID',flags:'Any') -> 'Any': - """ + def OpenEntry(self, entryId: 'str', iid: 'PyIID', flags: 'Any') -> 'Any': + """ Opens a folder or message and returns an interface object for further access. Args: @@ -13219,13 +12557,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def CompareEntryIDs(self,entryId:'str',entryId1:'str',flags:'Any'=0) -> 'Any': - """ + def CompareEntryIDs(self, entryId: 'str', entryId1: 'str', flags: 'Any' = 0) -> 'Any': + """ Compares two entry identifiers belonging to a particular address book provider to determine if they refer to the same address book object Args: @@ -13239,20 +12576,19 @@ Returns: 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 + """ + pass -class PyIApplicationDebugger(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIApplicationDebugger(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def QueryAlive(self,) -> 'None': - """ + def QueryAlive(self,) -> 'None': + """ Returns true if alive, else false. Args: @@ -13262,13 +12598,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CreateInstanceAtDebugger(self,rclsid:'PyIID',pUnkOuter:'Any',dwClsContext:'Any',riid:'PyIID') -> 'None': - """ + def CreateInstanceAtDebugger(self, rclsid: 'PyIID', pUnkOuter: 'Any', dwClsContext: 'Any', riid: 'PyIID') -> 'None': + """ Create objects in the application process address space. Args: @@ -13281,13 +12616,12 @@ Args: Returns: None - - """ - pass + """ + pass - def onDebugOutput(self,pstr:'Any') -> 'None': - """ + def onDebugOutput(self, pstr: 'Any') -> 'None': + """ None Args: @@ -13297,13 +12631,12 @@ Args: Returns: None - - """ - pass + """ + pass - def onHandleBreakPoint(self,prpt:'Any',br:'Any',pError:'Any') -> 'None': - """ + def onHandleBreakPoint(self, prpt: 'Any', br: 'Any', pError: 'Any') -> 'None': + """ Called when a breakpoint is hit. Args: @@ -13315,13 +12648,12 @@ Args: Returns: None - - """ - pass + """ + pass - def onClose(self,) -> 'None': - """ + def onClose(self,) -> 'None': + """ None Args: @@ -13331,13 +12663,12 @@ Args: Returns: None - - """ - pass + """ + pass - def onDebuggerEvent(self,guid:'PyIID',uUnknown:'Any') -> 'None': - """ + def onDebuggerEvent(self, guid: 'PyIID', uUnknown: 'Any') -> 'None': + """ Description of onDebuggerEvent. Args: @@ -13348,20 +12679,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIApplicationDestinations(object): - """Allows an application to removed items from its jump lists""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIApplicationDestinations(object): + """Allows an application to removed items from its jump lists""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def SetAppID(self,AppID:'Any') -> 'None': - """ + def SetAppID(self, AppID: 'Any') -> 'None': + """ Specifies the application whose jump list is to be accessed Args: @@ -13371,13 +12701,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RemoveDestination(self,punk:'Any') -> 'None': - """ + def RemoveDestination(self, punk: 'Any') -> 'None': + """ Removes a single entry from the jump lists Args: @@ -13387,13 +12716,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RemoveAllDestinations(self,) -> 'None': - """ + def RemoveAllDestinations(self,) -> 'None': + """ Removes all Recent and Frequent jump list entries Args: @@ -13403,20 +12731,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIApplicationDocumentLists(object): - """Interface used to retrieve the jump lists for an application""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIApplicationDocumentLists(object): + """Interface used to retrieve the jump lists for an application""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def SetAppID(self,AppID:'Any') -> 'None': - """ + def SetAppID(self, AppID: 'Any') -> 'None': + """ Specifies the application whose jump list is to be accessed Args: @@ -13426,13 +12753,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetList(self,ListType:'Any',riid:'PyIID',ItemsDesired:'Any'=0) -> 'Any': - """ + def GetList(self, ListType: 'Any', riid: 'PyIID', ItemsDesired: 'Any' = 0) -> 'Any': + """ Retrieves a list of items in a jump list Args: @@ -13444,20 +12770,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIAsyncOperation(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIAsyncOperation(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def SetAsyncMode(self,fDoOpAsync:'Any') -> 'None': - """ + def SetAsyncMode(self, fDoOpAsync: 'Any') -> 'None': + """ Description of SetAsyncMode. Args: @@ -13467,13 +12792,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetAsyncMode(self,) -> 'Any': - """ + def GetAsyncMode(self,) -> 'Any': + """ Description of GetAsyncMode. Args: @@ -13483,13 +12807,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def StartOperation(self,pbcReserved:'Any') -> 'None': - """ + def StartOperation(self, pbcReserved: 'Any') -> 'None': + """ Description of StartOperation. Args: @@ -13499,13 +12822,12 @@ Args: Returns: None - - """ - pass + """ + pass - def InOperation(self,) -> 'None': - """ + def InOperation(self,) -> 'None': + """ Description of InOperation. Args: @@ -13515,13 +12837,12 @@ Args: Returns: None - - """ - pass + """ + pass - def EndOperation(self,hResult:'Any',pbcReserved:'Any',dwEffects:'Any') -> 'None': - """ + def EndOperation(self, hResult: 'Any', pbcReserved: 'Any', dwEffects: 'Any') -> 'None': + """ Description of EndOperation. Args: @@ -13533,20 +12854,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIAttach(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIAttach(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetLastError(self,hr:'Any',flags:'Any') -> 'Any': - """ + def GetLastError(self, hr: 'Any', flags: 'Any') -> 'Any': + """ Returns the last error code for the object. Args: @@ -13557,21 +12877,20 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIBindCtx(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIBindCtx(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetRunningObjectTable(self,) -> 'Any': - """ - Retrieves an object interfacing to the Running + def GetRunningObjectTable(self,) -> 'Any': + """ + Retrieves an object interfacing to the Running Object Table. @@ -13582,13 +12901,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetBindOptions(self,) -> 'Any': - """ + def GetBindOptions(self,) -> 'Any': + """ Retrieves the bind options for the bind context Args: @@ -13598,13 +12916,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetBindOptions(self,bindopts:'Any') -> 'None': - """ + def SetBindOptions(self, bindopts: 'Any') -> 'None': + """ Sets the bind options for the context Args: @@ -13614,13 +12931,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RegisterObjectParam(self,Key:'str',punk:'Any') -> 'None': - """ + def RegisterObjectParam(self, Key: 'str', punk: 'Any') -> 'None': + """ Adds an object to the context's keyed table of associated objects Args: @@ -13631,13 +12947,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RevokeObjectParam(self,Key:'str') -> 'None': - """ + def RevokeObjectParam(self, Key: 'str') -> 'None': + """ Removes one of the bind context's registered objects Args: @@ -13647,13 +12962,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetObjectParam(self,Key:'str') -> 'Any': - """ + def GetObjectParam(self, Key: 'str') -> 'Any': + """ Returns one of the bind context's associated objects Args: @@ -13663,13 +12977,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def EnumObjectParam(self,) -> 'Any': - """ + def EnumObjectParam(self,) -> 'Any': + """ Creates an enumerator to list context's string keys Args: @@ -13679,20 +12992,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIBrowserFrameOptions(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIBrowserFrameOptions(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetFrameOptions(self,dwMask:'Any') -> 'None': - """ + def GetFrameOptions(self, dwMask: 'Any') -> 'None': + """ Description of GetFrameOptions. Args: @@ -13702,20 +13014,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyICancelMethodCalls(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyICancelMethodCalls(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Cancel(self,Seconds:'Any') -> 'None': - """ + def Cancel(self, Seconds: 'Any') -> 'None': + """ Cancels a pending call Args: @@ -13725,13 +13036,12 @@ Args: Returns: None - - """ - pass + """ + pass - def TestCancel(self,) -> 'Any': - """ + def TestCancel(self,) -> 'Any': + """ Checks if a request has been made to cancel a call Args: @@ -13745,21 +13055,20 @@ 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 + """ + pass -class PyICatInformation(object): - """A Python interface to ICatInformation""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyICatInformation(object): + """A Python interface to ICatInformation""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def EnumCategories(self,lcid:'Any'=0) -> 'Any': - """ - Returns an enumerator for the component categories + def EnumCategories(self, lcid: 'Any' = 0) -> 'Any': + """ + Returns an enumerator for the component categories registered on the system. @@ -13770,14 +13079,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetCategoryDesc(self,lcid:'Any'=0) -> 'str': - """ - Retrieves the localized description string for a specific category + def GetCategoryDesc(self, lcid: 'Any' = 0) -> 'str': + """ + Retrieves the localized description string for a specific category ID. @@ -13788,14 +13096,13 @@ Args: Returns: str - - """ - pass + """ + pass - def EnumClassesOfCategories(self,listIIdImplemented:'List[PyIID]'=None,listIIdRequired:'Any'=None) -> 'Any': - """ - Returns an enumerator over the classes that + def EnumClassesOfCategories(self, listIIdImplemented: 'List[PyIID]' = None, listIIdRequired: 'Any' = None) -> 'Any': + """ + Returns an enumerator over the classes that implement one or more interfaces. @@ -13807,21 +13114,20 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyICatRegister(object): - """An interface to a COM ICatRegister interface.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyICatRegister(object): + """An interface to a COM ICatRegister interface.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def RegisterCategories(self,arg:'List[Any]') -> 'None': - """ - Registers one or more component categories. Each component category + def RegisterCategories(self, arg: 'List[Any]') -> 'None': + """ + Registers one or more component categories. Each component category consists of a CATID and a list of locale-dependent description strings. @@ -13832,13 +13138,12 @@ Args: Returns: None - - """ - pass + """ + pass - def UnRegisterCategories(self,arg:'List[PyIID]') -> 'None': - """ + def UnRegisterCategories(self, arg: 'List[PyIID]') -> 'None': + """ Unregister one or more previously registered categories. Args: @@ -13848,14 +13153,13 @@ Args: Returns: None - - """ - pass + """ + pass - def RegisterClassImplCategories(self,clsid:'PyIID',arg:'List[PyIID]') -> 'None': - """ - Registers the class as implementing one or more component + def RegisterClassImplCategories(self, clsid: 'PyIID', arg: 'List[PyIID]') -> 'None': + """ + Registers the class as implementing one or more component categories. @@ -13867,14 +13171,13 @@ Args: Returns: None - - """ - pass + """ + pass - def UnRegisterClassImplCategories(self,clsid:'PyIID',arg:'List[PyIID]') -> 'None': - """ - Unregisters the class as implementing one or more component + def UnRegisterClassImplCategories(self, clsid: 'PyIID', arg: 'List[PyIID]') -> 'None': + """ + Unregisters the class as implementing one or more component categories. @@ -13886,14 +13189,13 @@ Args: Returns: None - - """ - pass + """ + pass - def RegisterClassReqCategories(self,clsid:'PyIID',arg:'List[PyIID]') -> 'None': - """ - Registers the class as requiring one or more component + def RegisterClassReqCategories(self, clsid: 'PyIID', arg: 'List[PyIID]') -> 'None': + """ + Registers the class as requiring one or more component categories. @@ -13905,14 +13207,13 @@ Args: Returns: None - - """ - pass + """ + pass - def UnRegisterClassReqCategories(self,clsid:'PyIID',arg:'List[PyIID]') -> 'None': - """ - Unregisters the class as requiring one or more component + def UnRegisterClassReqCategories(self, clsid: 'PyIID', arg: 'List[PyIID]') -> 'None': + """ + Unregisters the class as requiring one or more component categories. @@ -13924,20 +13225,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyICategoryProvider(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyICategoryProvider(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def CanCategorizeOnSCID(self,pscid:'Any') -> 'None': - """ + def CanCategorizeOnSCID(self, pscid: 'Any') -> 'None': + """ Description of CanCategorizeOnSCID. Args: @@ -13947,13 +13247,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetDefaultCategory(self,) -> 'None': - """ + def GetDefaultCategory(self,) -> 'None': + """ Description of GetDefaultCategory. Args: @@ -13963,13 +13262,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetCategoryForSCID(self,pscid:'Any') -> 'None': - """ + def GetCategoryForSCID(self, pscid: 'Any') -> 'None': + """ Description of GetCategoryForSCID. Args: @@ -13979,13 +13277,12 @@ Args: Returns: None - - """ - pass + """ + pass - def EnumCategories(self,) -> 'None': - """ + def EnumCategories(self,) -> 'None': + """ Description of EnumCategories. Args: @@ -13995,13 +13292,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetCategoryName(self,guid:'PyIID') -> 'None': - """ + def GetCategoryName(self, guid: 'PyIID') -> 'None': + """ Description of GetCategoryName. Args: @@ -14011,13 +13307,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CreateCategory(self,guid:'PyIID',riid:'PyIID') -> 'None': - """ + def CreateCategory(self, guid: 'PyIID', riid: 'PyIID') -> 'None': + """ Description of CreateCategory. Args: @@ -14028,20 +13323,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIClassFactory(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIClassFactory(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def CreateInstance(self,outerUnknown:'Any',iid:'PyIID') -> 'Any': - """ + def CreateInstance(self, outerUnknown: 'Any', iid: 'PyIID') -> 'Any': + """ Creates an uninitialized object. Args: @@ -14051,18 +13345,17 @@ Args: Returns: - Any:The IID of the resultant object.Return ValueThe result object will always be derived from PyIUnknown, but will be of the + Any: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 + """ + pass - def LockServer(self,bInc:'Any') -> 'None': - """ - Called by the client of a class object to keep a server open in memory, + def LockServer(self, bInc: 'Any') -> 'None': + """ + Called by the client of a class object to keep a server open in memory, allowing instances to be created more quickly. @@ -14073,20 +13366,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIClientSecurity(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIClientSecurity(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def QueryBlanket(self,Proxy:'Any') -> 'Any': - """ + def QueryBlanket(self, Proxy: 'Any') -> 'Any': + """ Retrieves the authentication settings for an interface Args: @@ -14096,13 +13388,21 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetBlanket(self,Proxy:'Any',AuthnSvc:'Any',AuthzSvc:'Any',ServerPrincipalName:'str',AuthnLevel:'Any',ImpLevel:'Any',AuthInfo:'Any',Capabilities:'Any') -> 'None': - """ + def SetBlanket( + self, + Proxy: 'Any', + AuthnSvc: 'Any', + AuthzSvc: 'Any', + ServerPrincipalName: 'str', + AuthnLevel: 'Any', + ImpLevel: 'Any', + AuthInfo: 'Any', + Capabilities: 'Any') -> 'None': + """ Changes the authentication options used with an interface Args: @@ -14119,13 +13419,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CopyProxy(self,Proxy:'Any') -> 'Any': - """ + def CopyProxy(self, Proxy: 'Any') -> 'Any': + """ Makes a private copy of a proxy interface Args: @@ -14135,20 +13434,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIColumnProvider(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIColumnProvider(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Initialize(self,psci:'Any') -> 'None': - """ + def Initialize(self, psci: 'Any') -> 'None': + """ Description of Initialize. Args: @@ -14158,13 +13456,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetColumnInfo(self,dwIndex:'Any') -> 'None': - """ + def GetColumnInfo(self, dwIndex: 'Any') -> 'None': + """ Description of GetColumnInfo. Args: @@ -14174,13 +13471,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetItemData(self,pscid:'Any',pscd:'Any') -> 'None': - """ + def GetItemData(self, pscid: 'Any', pscd: 'Any') -> 'None': + """ Description of GetItemData. Args: @@ -14191,21 +13487,20 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIConnectionPoint(object): - """A Python wrapper of a COM IConnectionPoint interface.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIConnectionPoint(object): + """A Python wrapper of a COM IConnectionPoint interface.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetConnectionInterface(self,) -> 'PyIID': - """ - Retrieves the IID of the interface represented by the + def GetConnectionInterface(self,) -> 'PyIID': + """ + Retrieves the IID of the interface represented by the connection point. @@ -14216,14 +13511,13 @@ Args: Returns: PyIID - - """ - pass + """ + pass - def GetConnectionPointContainer(self,) -> 'Any': - """ - Gets the connection point + def GetConnectionPointContainer(self,) -> 'Any': + """ + Gets the connection point container for the object. @@ -14234,14 +13528,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def Advise(self,unk:'Any') -> 'Any': - """ - Establishes a connection between the connection point object and the client's + def Advise(self, unk: 'Any') -> 'Any': + """ + Establishes a connection between the connection point object and the client's sink. @@ -14253,14 +13546,13 @@ Returns: Any:The client's advise sinkReturn ValueThe result is the connection point identifier used by PyIConnectionPoint::Unadvise - - """ - pass + """ + pass - def Unadvise(self,cookie:'Any') -> 'None': - """ - Terminates an advisory connection previously established through + def Unadvise(self, cookie: 'Any') -> 'None': + """ + Terminates an advisory connection previously established through IConnectionPoint::Advise. The dwCookie parameter identifies the connection to terminate. @@ -14271,14 +13563,13 @@ Args: Returns: None - - """ - pass + """ + pass - def EnumConnections(self,) -> 'Any': - """ - Creates an enumerator to iterate through the + def EnumConnections(self,) -> 'Any': + """ + Creates an enumerator to iterate through the connections for the connection point @@ -14289,23 +13580,22 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIConnectionPointContainer(object): - """A Python wrapper of a COM IConnectionPointContainer interface.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIConnectionPointContainer(object): + """A Python wrapper of a COM IConnectionPointContainer interface.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def EnumConnectionPoints(self,) -> 'Any': - """ - Creates an enumerator object + def EnumConnectionPoints(self,) -> 'Any': + """ + 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 +13606,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def FindConnectionPoint(self,iid:'PyIID') -> 'Any': - """ - Finds a connection point for the + def FindConnectionPoint(self, iid: 'PyIID') -> 'Any': + """ + Finds a connection point for the given IID @@ -14334,20 +13623,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIContext(object): - """Allows access to properties defined for the current context (Requires win2k or later)""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIContext(object): + """Allows access to properties defined for the current context (Requires win2k or later)""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def SetProperty(self,rpolicyId:'PyIID',flags:'Any',pUnk:'Any') -> 'None': - """ + def SetProperty(self, rpolicyId: 'PyIID', flags: 'Any', pUnk: 'Any') -> 'None': + """ Sets a property on the context Args: @@ -14359,13 +13647,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RemoveProperty(self,rPolicyId:'PyIID') -> 'None': - """ + def RemoveProperty(self, rPolicyId: 'PyIID') -> 'None': + """ Removes a property from the context Args: @@ -14375,13 +13662,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetProperty(self,rGuid:'PyIID') -> 'Tuple[Any, Any]': - """ + def GetProperty(self, rGuid: 'PyIID') -> 'Tuple[Any, Any]': + """ Retrieves a context property Args: @@ -14392,13 +13678,12 @@ Returns: Tuple[Any, Any]:GUID that identifies a context propertyReturn ValueReturns flags (CPFLAGS is reserved, no defined values) and the IUnknown interface set for the property - - """ - pass + """ + pass - def EnumContextProps(self,) -> 'Any': - """ + def EnumContextProps(self,) -> 'Any': + """ Returns an enumerator for the context properties Args: @@ -14408,20 +13693,25 @@ Args: Returns: Any - - """ - pass - - -class PyIContextMenu(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """ + pass - def QueryContextMenu(self,hmenu:'int',indexMenu:'Any',idCmdFirst:'Any',idCmdLast:'Any',uFlags:'Any') -> 'Any': - """ +class PyIContextMenu(object): + """Description of the interface""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + def QueryContextMenu( + self, + hmenu: 'int', + indexMenu: 'Any', + idCmdFirst: 'Any', + idCmdLast: 'Any', + uFlags: 'Any') -> 'Any': + """ Adds options to a context menu Args: @@ -14435,13 +13725,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def InvokeCommand(self,pici:'Any') -> 'None': - """ + def InvokeCommand(self, pici: 'Any') -> 'None': + """ Executes a context menu option Args: @@ -14451,13 +13740,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetCommandString(self,idCmd:'Any',uType:'Any',cchMax:'Any'=2048) -> 'Any': - """ + def GetCommandString(self, idCmd: 'Any', uType: 'Any', cchMax: 'Any' = 2048) -> 'Any': + """ Retrieves verb or help text for a context menu option Args: @@ -14469,20 +13757,27 @@ Args: Returns: Any - - """ - pass - - -class PyICopyHookA(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """ + pass - def CopyCallback(self,hwnd:'Any',wFunc:'Any',wFlags:'Any',srcFile:'Union[Any, str]',srcAttribs:'Any',destFile:'Union[Any, str]',destAttribs:'Any') -> 'None': - """ +class PyICopyHookA(object): + """Description of the interface""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + def CopyCallback( + self, + hwnd: 'Any', + wFunc: 'Any', + wFlags: 'Any', + srcFile: 'Union[Any, str]', + srcAttribs: 'Any', + destFile: 'Union[Any, str]', + destAttribs: 'Any') -> 'None': + """ Description of CopyCallback. Args: @@ -14498,20 +13793,27 @@ Args: Returns: None - - """ - pass - - -class PyICopyHookW(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """ + pass - def CopyCallback(self,hwnd:'Any',wFunc:'Any',wFlags:'Any',srcFile:'Union[Any, str]',srcAttribs:'Any',destFile:'Union[Any, str]',destAttribs:'Any') -> 'None': - """ +class PyICopyHookW(object): + """Description of the interface""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + def CopyCallback( + self, + hwnd: 'Any', + wFunc: 'Any', + wFlags: 'Any', + srcFile: 'Union[Any, str]', + srcAttribs: 'Any', + destFile: 'Union[Any, str]', + destAttribs: 'Any') -> 'None': + """ Description of CopyCallback. Args: @@ -14527,20 +13829,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyICreateTypeInfo(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyICreateTypeInfo(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def SetGuid(self,guid:'PyIID') -> 'None': - """ + def SetGuid(self, guid: 'PyIID') -> 'None': + """ Description of SetGuid. Args: @@ -14550,13 +13851,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetTypeFlags(self,uTypeFlags:'Any') -> 'None': - """ + def SetTypeFlags(self, uTypeFlags: 'Any') -> 'None': + """ Description of SetTypeFlags. Args: @@ -14566,13 +13866,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetDocString(self,pStrDoc:'Any') -> 'None': - """ + def SetDocString(self, pStrDoc: 'Any') -> 'None': + """ Description of SetDocString. Args: @@ -14582,13 +13881,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetHelpContext(self,dwHelpContext:'Any') -> 'None': - """ + def SetHelpContext(self, dwHelpContext: 'Any') -> 'None': + """ Description of SetHelpContext. Args: @@ -14598,13 +13896,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetVersion(self,wMajorVerNum:'Any',wMinorVerNum:'Any') -> 'None': - """ + def SetVersion(self, wMajorVerNum: 'Any', wMinorVerNum: 'Any') -> 'None': + """ Description of SetVersion. Args: @@ -14615,13 +13912,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AddRefTypeInfo(self,pTInfo:'Any') -> 'None': - """ + def AddRefTypeInfo(self, pTInfo: 'Any') -> 'None': + """ Description of AddRefTypeInfo. Args: @@ -14631,13 +13927,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AddFuncDesc(self,index:'Any') -> 'None': - """ + def AddFuncDesc(self, index: 'Any') -> 'None': + """ Description of AddFuncDesc. Args: @@ -14647,13 +13942,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AddImplType(self,index:'Any',hRefType:'Any') -> 'None': - """ + def AddImplType(self, index: 'Any', hRefType: 'Any') -> 'None': + """ Description of AddImplType. Args: @@ -14664,13 +13958,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetImplTypeFlags(self,index:'Any',implTypeFlags:'Any') -> 'None': - """ + def SetImplTypeFlags(self, index: 'Any', implTypeFlags: 'Any') -> 'None': + """ Description of SetImplTypeFlags. Args: @@ -14681,13 +13974,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetAlignment(self,cbAlignment:'Any') -> 'None': - """ + def SetAlignment(self, cbAlignment: 'Any') -> 'None': + """ Description of SetAlignment. Args: @@ -14697,13 +13989,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetSchema(self,pStrSchema:'Any') -> 'None': - """ + def SetSchema(self, pStrSchema: 'Any') -> 'None': + """ Description of SetSchema. Args: @@ -14713,13 +14004,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AddVarDesc(self,index:'Any') -> 'None': - """ + def AddVarDesc(self, index: 'Any') -> 'None': + """ Description of AddVarDesc. Args: @@ -14729,13 +14019,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetFuncAndParamNames(self,index:'Any',rgszNames:'Tuple[Any, ...]') -> 'None': - """ + def SetFuncAndParamNames(self, index: 'Any', rgszNames: 'Tuple[Any, ...]') -> 'None': + """ Description of SetFuncAndParamNames. Args: @@ -14746,13 +14035,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetVarName(self,index:'Any',szName:'Any') -> 'None': - """ + def SetVarName(self, index: 'Any', szName: 'Any') -> 'None': + """ Description of SetVarName. Args: @@ -14763,13 +14051,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetTypeDescAlias(self,) -> 'None': - """ + def SetTypeDescAlias(self,) -> 'None': + """ Description of SetTypeDescAlias. Args: @@ -14779,13 +14066,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DefineFuncAsDllEntry(self,index:'Any',szDllName:'Any',szProcName:'Any') -> 'None': - """ + def DefineFuncAsDllEntry(self, index: 'Any', szDllName: 'Any', szProcName: 'Any') -> 'None': + """ Description of DefineFuncAsDllEntry. Args: @@ -14797,13 +14083,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetFuncDocString(self,index:'Any',szDocString:'Any') -> 'None': - """ + def SetFuncDocString(self, index: 'Any', szDocString: 'Any') -> 'None': + """ Description of SetFuncDocString. Args: @@ -14814,13 +14099,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetVarDocString(self,index:'Any',szDocString:'Any') -> 'None': - """ + def SetVarDocString(self, index: 'Any', szDocString: 'Any') -> 'None': + """ Description of SetVarDocString. Args: @@ -14831,13 +14115,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetFuncHelpContext(self,index:'Any',dwHelpContext:'Any') -> 'None': - """ + def SetFuncHelpContext(self, index: 'Any', dwHelpContext: 'Any') -> 'None': + """ Description of SetFuncHelpContext. Args: @@ -14848,13 +14131,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetVarHelpContext(self,index:'Any',dwHelpContext:'Any') -> 'None': - """ + def SetVarHelpContext(self, index: 'Any', dwHelpContext: 'Any') -> 'None': + """ Description of SetVarHelpContext. Args: @@ -14865,13 +14147,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetMops(self,index:'Any',bstrMops:'Any') -> 'None': - """ + def SetMops(self, index: 'Any', bstrMops: 'Any') -> 'None': + """ Description of SetMops. Args: @@ -14882,13 +14163,12 @@ Args: Returns: None - - """ - pass + """ + pass - def LayOut(self,) -> 'None': - """ + def LayOut(self,) -> 'None': + """ Description of LayOut. Args: @@ -14898,20 +14178,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyICreateTypeLib(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyICreateTypeLib(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def CreateTypeInfo(self,szName:'Any') -> 'None': - """ + def CreateTypeInfo(self, szName: 'Any') -> 'None': + """ Description of CreateTypeInfo. Args: @@ -14921,13 +14200,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetName(self,szName:'Any') -> 'None': - """ + def SetName(self, szName: 'Any') -> 'None': + """ Description of SetName. Args: @@ -14937,13 +14215,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetVersion(self,wMajorVerNum:'Any',wMinorVerNum:'Any') -> 'None': - """ + def SetVersion(self, wMajorVerNum: 'Any', wMinorVerNum: 'Any') -> 'None': + """ Description of SetVersion. Args: @@ -14954,13 +14231,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetGuid(self,guid:'PyIID') -> 'None': - """ + def SetGuid(self, guid: 'PyIID') -> 'None': + """ Description of SetGuid. Args: @@ -14970,13 +14246,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetDocString(self,szDoc:'Any') -> 'None': - """ + def SetDocString(self, szDoc: 'Any') -> 'None': + """ Description of SetDocString. Args: @@ -14986,13 +14261,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetHelpFileName(self,szHelpFileName:'Any') -> 'None': - """ + def SetHelpFileName(self, szHelpFileName: 'Any') -> 'None': + """ Description of SetHelpFileName. Args: @@ -15002,13 +14276,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetHelpContext(self,dwHelpContext:'Any') -> 'None': - """ + def SetHelpContext(self, dwHelpContext: 'Any') -> 'None': + """ Description of SetHelpContext. Args: @@ -15018,13 +14291,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetLcid(self,) -> 'None': - """ + def SetLcid(self,) -> 'None': + """ Description of SetLcid. Args: @@ -15034,13 +14306,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetLibFlags(self,uLibFlags:'Any') -> 'None': - """ + def SetLibFlags(self, uLibFlags: 'Any') -> 'None': + """ Description of SetLibFlags. Args: @@ -15050,13 +14321,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SaveAllChanges(self,) -> 'None': - """ + def SaveAllChanges(self,) -> 'None': + """ Description of SaveAllChanges. Args: @@ -15066,20 +14336,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyICreateTypeLib2(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyICreateTypeLib2(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def CreateTypeInfo(self,szName:'Any') -> 'None': - """ + def CreateTypeInfo(self, szName: 'Any') -> 'None': + """ Description of CreateTypeInfo. Args: @@ -15089,13 +14358,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetName(self,szName:'Any') -> 'None': - """ + def SetName(self, szName: 'Any') -> 'None': + """ Description of SetName. Args: @@ -15105,13 +14373,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetVersion(self,wMajorVerNum:'Any',wMinorVerNum:'Any') -> 'None': - """ + def SetVersion(self, wMajorVerNum: 'Any', wMinorVerNum: 'Any') -> 'None': + """ Description of SetVersion. Args: @@ -15122,13 +14389,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetGuid(self,guid:'PyIID') -> 'None': - """ + def SetGuid(self, guid: 'PyIID') -> 'None': + """ Description of SetGuid. Args: @@ -15138,13 +14404,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetDocString(self,szDoc:'Any') -> 'None': - """ + def SetDocString(self, szDoc: 'Any') -> 'None': + """ Description of SetDocString. Args: @@ -15154,13 +14419,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetHelpFileName(self,szHelpFileName:'Any') -> 'None': - """ + def SetHelpFileName(self, szHelpFileName: 'Any') -> 'None': + """ Description of SetHelpFileName. Args: @@ -15170,13 +14434,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetHelpContext(self,dwHelpContext:'Any') -> 'None': - """ + def SetHelpContext(self, dwHelpContext: 'Any') -> 'None': + """ Description of SetHelpContext. Args: @@ -15186,13 +14449,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetLcid(self,) -> 'None': - """ + def SetLcid(self,) -> 'None': + """ Description of SetLcid. Args: @@ -15202,13 +14464,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetLibFlags(self,uLibFlags:'Any') -> 'None': - """ + def SetLibFlags(self, uLibFlags: 'Any') -> 'None': + """ Description of SetLibFlags. Args: @@ -15218,13 +14479,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SaveAllChanges(self,) -> 'None': - """ + def SaveAllChanges(self,) -> 'None': + """ Description of SaveAllChanges. Args: @@ -15234,27 +14494,26 @@ Args: Returns: None - - """ - pass + + """ + pass class PyICurrentItem(object): - """Description of the interface""" + """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyICustomDestinationList(object): - """Interface used to customize an application's jump list""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """Interface used to customize an application's jump list""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def SetAppID(self,AppID:'Any') -> 'None': - """ + def SetAppID(self, AppID: 'Any') -> 'None': + """ Specifies the taskbar identifier for the jump list Args: @@ -15264,14 +14523,13 @@ Args: Returns: None - - """ - pass + """ + pass - def BeginList(self,riid:'PyIID') -> 'Tuple[Any, Any]': - """ - Clears the jump list and prepares it to be + def BeginList(self, riid: 'PyIID') -> 'Tuple[Any, Any]': + """ + Clears the jump list and prepares it to be repopulated @@ -15284,13 +14542,12 @@ Returns: Tuple[Any, Any]:The interface to return Return ValueReturns the number of slots and a collection of all destinations removed from the jump list - - """ - pass + """ + pass - def AppendCategory(self,Category:'Any',Items:'Any') -> 'None': - """ + def AppendCategory(self, Category: 'Any', Items: 'Any') -> 'None': + """ Adds a custom category to the jump list Args: @@ -15301,13 +14558,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AppendKnownCategory(self,Category:'Any') -> 'None': - """ + def AppendKnownCategory(self, Category: 'Any') -> 'None': + """ Adds one of the predefined categories to the custom list Args: @@ -15317,13 +14573,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AddUserTasks(self,Items:'Any') -> 'None': - """ + def AddUserTasks(self, Items: 'Any') -> 'None': + """ Sets the entries shown in the Tasks category Args: @@ -15333,13 +14588,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CommitList(self,) -> 'None': - """ + def CommitList(self,) -> 'None': + """ Finalizes changes. Args: @@ -15349,14 +14603,13 @@ Args: Returns: None - - """ - pass + """ + pass - def GetRemovedDestinations(self,riid:'PyIID') -> 'Any': - """ - Returns all the items removed from the + def GetRemovedDestinations(self, riid: 'PyIID') -> 'Any': + """ + Returns all the items removed from the jump list @@ -15367,14 +14620,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def DeleteList(self,AppID:'Any'=None) -> 'None': - """ - Removes any customization, leaving only the system-maintained Recent + def DeleteList(self, AppID: 'Any' = None) -> 'None': + """ + Removes any customization, leaving only the system-maintained Recent and Frequent lists @@ -15385,13 +14637,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AbortList(self,) -> 'None': - """ + def AbortList(self,) -> 'None': + """ Discards all changes Args: @@ -15401,29 +14652,28 @@ Args: Returns: None - - """ - pass + + """ + 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 */)""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyIDataObject(object): - """Used to transfer data in various formats throughout the shell""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """Used to transfer data in various formats throughout the shell""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetData(self,pformatetcIn:'Any') -> 'Any': - """ + def GetData(self, pformatetcIn: 'Any') -> 'Any': + """ Retrieves data from the object in specified format Args: @@ -15433,13 +14683,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetDataHere(self,pformatetcIn:'Any') -> 'Any': - """ + def GetDataHere(self, pformatetcIn: 'Any') -> 'Any': + """ Retunrs a copy of the object's data in specified format Args: @@ -15449,13 +14698,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def QueryGetData(self,pformatetc:'Any') -> 'None': - """ + def QueryGetData(self, pformatetc: 'Any') -> 'None': + """ Checks if the objects supports returning data in a particular format. Args: @@ -15464,18 +14712,17 @@ 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 + """ + pass - def GetCanonicalFormatEtc(self,pformatectIn:'Any') -> 'Any': - """ - Transforms a FORMATECT data description into a general + def GetCanonicalFormatEtc(self, pformatectIn: 'Any') -> 'Any': + """ + Transforms a FORMATECT data description into a general format that the object supports @@ -15486,13 +14733,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetData(self,pformatetc:'Any',pmedium:'Any',fRelease:'Any') -> 'None': - """ + def SetData(self, pformatetc: 'Any', pmedium: 'Any', fRelease: 'Any') -> 'None': + """ Sets the data that the object will return. Args: @@ -15504,14 +14750,13 @@ Args: Returns: None - - """ - pass + """ + pass - def EnumFormatEtc(self,dwDirection:'Any') -> 'Any': - """ - Returns an enumerator to list the data formats that the + def EnumFormatEtc(self, dwDirection: 'Any') -> 'Any': + """ + Returns an enumerator to list the data formats that the object supports. @@ -15522,14 +14767,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def DAdvise(self,pformatetc:'Any',advf:'Any',pAdvSink:'Any') -> 'Any': - """ - Connects the object to an interface that will receive notifications when its data + def DAdvise(self, pformatetc: 'Any', advf: 'Any', pAdvSink: 'Any') -> 'Any': + """ + Connects the object to an interface that will receive notifications when its data changes @@ -15543,13 +14787,12 @@ Returns: Any:Currently this interface is not wrapped.Return ValueReturns a unique number that is used to identify the connection - - """ - pass + """ + pass - def DUnadvise(self,dwConnection:'Any') -> 'None': - """ + def DUnadvise(self, dwConnection: 'Any') -> 'None': + """ Disconnects a notification sink. Args: @@ -15559,13 +14802,12 @@ Args: Returns: None - - """ - pass + """ + pass - def EnumDAdvise(self,) -> 'Any': - """ + def EnumDAdvise(self,) -> 'Any': + """ Creates an enumerator to list connected notification sinks. Args: @@ -15575,20 +14817,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIDebugApplication(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDebugApplication(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def SetName(self,pstrName:'Any') -> 'None': - """ + def SetName(self, pstrName: 'Any') -> 'None': + """ Sets the name of the application. Args: @@ -15598,14 +14839,13 @@ Args: Returns: None - - """ - pass + """ + pass - def StepOutComplete(self,) -> 'None': - """ - Called by language engines, in single step mode, just before they + def StepOutComplete(self,) -> 'None': + """ + Called by language engines, in single step mode, just before they return to their caller. @@ -15616,14 +14856,13 @@ Args: Returns: None - - """ - pass + """ + pass - def DebugOutput(self,pstr:'Any') -> 'None': - """ - Causes the given string to be displayed by the debugger IDE, normally in + def DebugOutput(self, pstr: 'Any') -> 'None': + """ + Causes the given string to be displayed by the debugger IDE, normally in an output window. @@ -15634,14 +14873,13 @@ Args: Returns: None - - """ - pass + """ + pass - def StartDebugSession(self,) -> 'None': - """ - Causes a default debugger IDE to be started and a debug session to + def StartDebugSession(self,) -> 'None': + """ + 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 +14890,13 @@ Args: Returns: None - - """ - pass + """ + pass - def HandleBreakPoint(self,br:'Any') -> 'Any': - """ - Called by the language engine in the context of a thread that has + def HandleBreakPoint(self, br: 'Any') -> 'Any': + """ + Called by the language engine in the context of a thread that has hit a breakpoint. @@ -15671,24 +14908,23 @@ Returns: 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 + """ + pass - def Close(self,) -> 'None': - """ + def Close(self,) -> 'None': + """ Causes this application to release all references and enter a zombie state. Args: @@ -15698,13 +14934,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetBreakFlags(self,) -> 'Any': - """ + def GetBreakFlags(self,) -> 'Any': + """ Returns the current break flags for the application. Args: @@ -15714,14 +14949,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetCurrentThread(self,) -> 'Any': - """ - Returns the application thread object + def GetCurrentThread(self,) -> 'Any': + """ + Returns the application thread object associated with the currently running thread. @@ -15732,13 +14966,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def CreateAsyncDebugOperation(self,psdo:'Any') -> 'None': - """ + def CreateAsyncDebugOperation(self, psdo: 'Any') -> 'None': + """ None Args: @@ -15748,13 +14981,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AddStackFrameSniffer(self,pdsfs:'Any') -> 'Any': - """ + def AddStackFrameSniffer(self, pdsfs: 'Any') -> 'Any': + """ Adds a stack frame sniffer to this application. Args: @@ -15765,20 +14997,19 @@ Returns: 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 + """ + pass - def RemoveStackFrameSniffer(self,dwCookie:'Any') -> 'None': - """ + def RemoveStackFrameSniffer(self, dwCookie: 'Any') -> 'None': + """ Removes a stack frame sniffer from this application. Args: @@ -15788,14 +15019,13 @@ Args: Returns: None - - """ - pass + """ + pass - def QueryCurrentThreadIsDebuggerThread(self,) -> 'None': - """ - Determines if the current running thread is the + def QueryCurrentThreadIsDebuggerThread(self,) -> 'None': + """ + Determines if the current running thread is the debugger thread. @@ -15806,21 +15036,20 @@ 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 + """ + pass - def SynchronousCallInDebuggerThread(self,pptc:'Any',dwParam1:'Any',dwParam2:'Any',dwParam3:'Any') -> 'None': - """ - Provides a mechanism for the caller to run code in the + def SynchronousCallInDebuggerThread(self, pptc: 'Any', dwParam1: 'Any', dwParam2: 'Any', dwParam3: 'Any') -> 'None': + """ + Provides a mechanism for the caller to run code in the debugger thread. @@ -15834,14 +15063,13 @@ Args: Returns: None - - """ - pass + """ + pass - def CreateApplicationNode(self,) -> 'Any': - """ - Creates a new application node which + def CreateApplicationNode(self,) -> 'Any': + """ + Creates a new application node which is associated with a specific document provider. @@ -15852,13 +15080,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def FireDebuggerEvent(self,guid:'Any',unknown:'Any') -> 'None': - """ + def FireDebuggerEvent(self, guid: 'Any', unknown: 'Any') -> 'None': + """ Fire a generic event to the IApplicationDebugger (if any) Args: @@ -15869,13 +15096,12 @@ Args: Returns: None - - """ - pass + """ + pass - def HandleRuntimeError(self,pErrorDebug:'Any',pScriptSite:'Any') -> 'None': - """ + def HandleRuntimeError(self, pErrorDebug: 'Any', pScriptSite: 'Any') -> 'None': + """ Description of HandleRuntimeError. Args: @@ -15886,13 +15112,12 @@ Args: Returns: None - - """ - pass + """ + pass - def FCanJitDebug(self,) -> 'None': - """ + def FCanJitDebug(self,) -> 'None': + """ Description of FCanJitDebug. Args: @@ -15902,13 +15127,12 @@ Args: Returns: None - - """ - pass + """ + pass - def FIsAutoJitDebugEnabled(self,) -> 'None': - """ + def FIsAutoJitDebugEnabled(self,) -> 'None': + """ Description of FIsAutoJitDebugEnabled. Args: @@ -15918,13 +15142,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AddGlobalExpressionContextProvider(self,pdsfs:'Any') -> 'None': - """ + def AddGlobalExpressionContextProvider(self, pdsfs: 'Any') -> 'None': + """ Description of AddGlobalExpressionContextProvider. Args: @@ -15934,14 +15157,13 @@ Args: Returns: None - - """ - pass + """ + pass - def RemoveGlobalExpressionContextProvider(self,dwCookie:'Any') -> 'None': - """ - Description of + def RemoveGlobalExpressionContextProvider(self, dwCookie: 'Any') -> 'None': + """ + Description of RemoveGlobalExpressionContextProvider. @@ -15952,20 +15174,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIDebugApplicationNode(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDebugApplicationNode(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def EnumChildren(self,) -> 'None': - """ + def EnumChildren(self,) -> 'None': + """ Description of EnumChildren. Args: @@ -15975,13 +15196,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetParent(self,) -> 'Any': - """ + def GetParent(self,) -> 'Any': + """ Returns the parent node. Args: @@ -15991,13 +15211,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetDocumentProvider(self,pddp:'Any') -> 'None': - """ + def SetDocumentProvider(self, pddp: 'Any') -> 'None': + """ Description of SetDocumentProvider. Args: @@ -16007,13 +15226,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Close(self,) -> 'None': - """ + def Close(self,) -> 'None': + """ Description of Close. Args: @@ -16023,13 +15241,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Attach(self,pdanParent:'Any') -> 'None': - """ + def Attach(self, pdanParent: 'Any') -> 'None': + """ Attach a node to its parent. Args: @@ -16039,13 +15256,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Detach(self,) -> 'None': - """ + def Detach(self,) -> 'None': + """ Detach a node from its parent. Args: @@ -16055,20 +15271,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIDebugApplicationNodeEvents(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDebugApplicationNodeEvents(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def onAddChild(self,prddpChild:'Any') -> 'None': - """ + def onAddChild(self, prddpChild: 'Any') -> 'None': + """ Description of onAddChild. Args: @@ -16078,13 +15293,12 @@ Args: Returns: None - - """ - pass + """ + pass - def onRemoveChild(self,prddpChild:'Any') -> 'None': - """ + def onRemoveChild(self, prddpChild: 'Any') -> 'None': + """ Description of onRemoveChild. Args: @@ -16094,13 +15308,12 @@ Args: Returns: None - - """ - pass + """ + pass - def onDetach(self,) -> 'None': - """ + def onDetach(self,) -> 'None': + """ Description of onDetach. Args: @@ -16110,13 +15323,12 @@ Args: Returns: None - - """ - pass + """ + pass - def onAttach(self,prddpParent:'Any') -> 'None': - """ + def onAttach(self, prddpParent: 'Any') -> 'None': + """ Description of onAttach. Args: @@ -16126,20 +15338,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIDebugApplicationThread(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDebugApplicationThread(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def SynchronousCallIntoThread(self,pstcb:'Any',dwParam1:'Any',dwParam2:'Any',dwParam3:'Any') -> 'None': - """ + def SynchronousCallIntoThread(self, pstcb: 'Any', dwParam1: 'Any', dwParam2: 'Any', dwParam3: 'Any') -> 'None': + """ Description of SynchronousCallIntoThread. Args: @@ -16152,13 +15363,12 @@ Args: Returns: None - - """ - pass + """ + pass - def QueryIsCurrentThread(self,) -> 'None': - """ + def QueryIsCurrentThread(self,) -> 'None': + """ Description of QueryIsCurrentThread. Args: @@ -16168,13 +15378,12 @@ Args: Returns: None - - """ - pass + """ + pass - def QueryIsDebuggerThread(self,) -> 'None': - """ + def QueryIsDebuggerThread(self,) -> 'None': + """ Description of QueryIsDebuggerThread. Args: @@ -16184,20 +15393,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIDebugCodeContext(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDebugCodeContext(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetDocumentContext(self,) -> 'None': - """ + def GetDocumentContext(self,) -> 'None': + """ Description of GetDocumentContext. Args: @@ -16207,13 +15415,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetBreakPoint(self,bps:'Any') -> 'None': - """ + def SetBreakPoint(self, bps: 'Any') -> 'None': + """ Description of SetBreakPoint. Args: @@ -16223,27 +15430,26 @@ Args: Returns: None - - """ - pass + + """ + pass class PyIDebugDocument(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyIDebugDocumentContext(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetDocument(self,) -> 'None': - """ + def GetDocument(self,) -> 'None': + """ Description of GetDocument. Args: @@ -16253,13 +15459,12 @@ Args: Returns: None - - """ - pass + """ + pass - def EnumCodeContexts(self,) -> 'None': - """ + def EnumCodeContexts(self,) -> 'None': + """ Description of EnumCodeContexts. Args: @@ -16269,20 +15474,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIDebugDocumentHelper(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDebugDocumentHelper(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Init(self,pda:'Any',pszShortName:'Any',pszLongName:'Any',docAttr:'Any') -> 'None': - """ + def Init(self, pda: 'Any', pszShortName: 'Any', pszLongName: 'Any', docAttr: 'Any') -> 'None': + """ Description of Init. Args: @@ -16295,13 +15499,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Attach(self,pddhParent:'Any') -> 'None': - """ + def Attach(self, pddhParent: 'Any') -> 'None': + """ Add the document to the doc tree Args: @@ -16311,13 +15514,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Detach(self,) -> 'None': - """ + def Detach(self,) -> 'None': + """ Description of Detach. Args: @@ -16327,13 +15529,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AddUnicodeText(self,pszText:'Any') -> 'None': - """ + def AddUnicodeText(self, pszText: 'Any') -> 'None': + """ Description of AddUnicodeText. Args: @@ -16343,13 +15544,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AddDBCSText(self,) -> 'None': - """ + def AddDBCSText(self,) -> 'None': + """ Description of AddDBCSText. Args: @@ -16359,13 +15559,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetDebugDocumentHost(self,pddh:'Any') -> 'None': - """ + def SetDebugDocumentHost(self, pddh: 'Any') -> 'None': + """ Description of SetDebugDocumentHost. Args: @@ -16375,13 +15574,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AddDeferredText(self,cChars:'Any',dwTextStartCookie:'Any') -> 'None': - """ + def AddDeferredText(self, cChars: 'Any', dwTextStartCookie: 'Any') -> 'None': + """ Description of AddDeferredText. Args: @@ -16392,13 +15590,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DefineScriptBlock(self,ulCharOffset:'Any',cChars:'Any',pas:'Any',fScriptlet:'Any') -> 'None': - """ + def DefineScriptBlock(self, ulCharOffset: 'Any', cChars: 'Any', pas: 'Any', fScriptlet: 'Any') -> 'None': + """ Description of DefineScriptBlock. Args: @@ -16411,13 +15608,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetDefaultTextAttr(self,staTextAttr:'Any') -> 'None': - """ + def SetDefaultTextAttr(self, staTextAttr: 'Any') -> 'None': + """ Description of SetDefaultTextAttr. Args: @@ -16427,13 +15623,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetTextAttributes(self,ulCharOffset:'Any',obAttr:'Any') -> 'None': - """ + def SetTextAttributes(self, ulCharOffset: 'Any', obAttr: 'Any') -> 'None': + """ Description of SetTextAttributes. Args: @@ -16444,13 +15639,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetLongName(self,pszLongName:'Any') -> 'None': - """ + def SetLongName(self, pszLongName: 'Any') -> 'None': + """ Description of SetLongName. Args: @@ -16460,13 +15654,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetShortName(self,pszShortName:'Any') -> 'None': - """ + def SetShortName(self, pszShortName: 'Any') -> 'None': + """ Description of SetShortName. Args: @@ -16476,13 +15669,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetDocumentAttr(self,pszAttributes:'Any') -> 'None': - """ + def SetDocumentAttr(self, pszAttributes: 'Any') -> 'None': + """ Description of SetDocumentAttr. Args: @@ -16492,13 +15684,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetDebugApplicationNode(self,) -> 'None': - """ + def GetDebugApplicationNode(self,) -> 'None': + """ Description of GetDebugApplicationNode. Args: @@ -16508,13 +15699,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetScriptBlockInfo(self,dwSourceContext:'Any') -> 'None': - """ + def GetScriptBlockInfo(self, dwSourceContext: 'Any') -> 'None': + """ Description of GetScriptBlockInfo. Args: @@ -16524,13 +15714,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CreateDebugDocumentContext(self,iCharPos:'Any',cChars:'Any') -> 'None': - """ + def CreateDebugDocumentContext(self, iCharPos: 'Any', cChars: 'Any') -> 'None': + """ Description of CreateDebugDocumentContext. Args: @@ -16541,13 +15730,12 @@ Args: Returns: None - - """ - pass + """ + pass - def BringDocumentToTop(self,) -> 'None': - """ + def BringDocumentToTop(self,) -> 'None': + """ Description of BringDocumentToTop. Args: @@ -16557,13 +15745,12 @@ Args: Returns: None - - """ - pass + """ + pass - def BringDocumentContextToTop(self,pddc:'Any') -> 'None': - """ + def BringDocumentContextToTop(self, pddc: 'Any') -> 'None': + """ Description of BringDocumentContextToTop. Args: @@ -16573,20 +15760,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIDebugDocumentHost(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDebugDocumentHost(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetDeferredText(self,dwTextStartCookie:'Any',cMaxChars:'Any') -> 'None': - """ + def GetDeferredText(self, dwTextStartCookie: 'Any', cMaxChars: 'Any') -> 'None': + """ Description of GetDeferredText. Args: @@ -16597,13 +15783,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetScriptTextAttributes(self,pstrCode:'Any',pstrDelimiter:'Any',dwFlags:'Any') -> 'None': - """ + def GetScriptTextAttributes(self, pstrCode: 'Any', pstrDelimiter: 'Any', dwFlags: 'Any') -> 'None': + """ Description of GetScriptTextAttributes. Args: @@ -16615,13 +15800,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnCreateDocumentContext(self,) -> 'None': - """ + def OnCreateDocumentContext(self,) -> 'None': + """ Description of OnCreateDocumentContext. Args: @@ -16631,13 +15815,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetPathName(self,) -> 'None': - """ + def GetPathName(self,) -> 'None': + """ Description of GetPathName. Args: @@ -16647,13 +15830,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetFileName(self,) -> 'None': - """ + def GetFileName(self,) -> 'None': + """ Description of GetFileName. Args: @@ -16663,13 +15845,12 @@ Args: Returns: None - - """ - pass + """ + pass - def NotifyChanged(self,) -> 'None': - """ + def NotifyChanged(self,) -> 'None': + """ Description of NotifyChanged. Args: @@ -16679,20 +15860,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIDebugDocumentInfo(object): - """Provides information on a document, which may or may not be instantiated.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDebugDocumentInfo(object): + """Provides information on a document, which may or may not be instantiated.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetName(self,) -> 'None': - """ + def GetName(self,) -> 'None': + """ Returns the specified name for the document. Args: @@ -16702,13 +15882,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetDocumentClassId(self,) -> 'PyIID': - """ + def GetDocumentClassId(self,) -> 'PyIID': + """ Returns a CLSID describing the document type. Args: @@ -16718,21 +15897,20 @@ Args: Returns: PyIID - - """ - pass + """ + pass -class PyIDebugDocumentProvider(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDebugDocumentProvider(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetDocument(self,) -> 'Any': - """ - Causes the document to be instantiated if it does + def GetDocument(self,) -> 'Any': + """ + Causes the document to be instantiated if it does not already exist. @@ -16743,20 +15921,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIDebugDocumentText(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDebugDocumentText(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetDocumentAttributes(self,) -> 'None': - """ + def GetDocumentAttributes(self,) -> 'None': + """ Description of GetDocumentAttributes. Args: @@ -16766,13 +15943,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetSize(self,) -> 'None': - """ + def GetSize(self,) -> 'None': + """ Description of GetSize. Args: @@ -16782,13 +15958,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetPositionOfLine(self,cLineNumber:'Any') -> 'None': - """ + def GetPositionOfLine(self, cLineNumber: 'Any') -> 'None': + """ Description of GetPositionOfLine. Args: @@ -16798,13 +15973,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetLineOfPosition(self,cCharacterPosition:'Any') -> 'None': - """ + def GetLineOfPosition(self, cCharacterPosition: 'Any') -> 'None': + """ Description of GetLineOfPosition. Args: @@ -16814,13 +15988,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetText(self,cCharacterPosition:'Any',cMaxChars:'Any',bWantAttr:'Any'=1) -> 'None': - """ + def GetText(self, cCharacterPosition: 'Any', cMaxChars: 'Any', bWantAttr: 'Any' = 1) -> 'None': + """ Description of GetText. Args: @@ -16832,13 +16005,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetPositionOfContext(self,psc:'Any') -> 'None': - """ + def GetPositionOfContext(self, psc: 'Any') -> 'None': + """ Description of GetPositionOfContext. Args: @@ -16848,13 +16020,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetContextOfPosition(self,cCharacterPosition:'Any',cNumChars:'Any') -> 'None': - """ + def GetContextOfPosition(self, cCharacterPosition: 'Any', cNumChars: 'Any') -> 'None': + """ Description of GetContextOfPosition. Args: @@ -16865,20 +16036,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIDebugDocumentTextAuthor(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDebugDocumentTextAuthor(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def InsertText(self,cCharacterPosition:'Any',cNumToInsert:'Any',pcharText:'Any') -> 'None': - """ + def InsertText(self, cCharacterPosition: 'Any', cNumToInsert: 'Any', pcharText: 'Any') -> 'None': + """ Description of InsertText. Args: @@ -16890,13 +16060,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RemoveText(self,cCharacterPosition:'Any',cNumToRemove:'Any') -> 'None': - """ + def RemoveText(self, cCharacterPosition: 'Any', cNumToRemove: 'Any') -> 'None': + """ Description of RemoveText. Args: @@ -16907,13 +16076,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ReplaceText(self,cCharacterPosition:'Any',cNumToReplace:'Any',pcharText:'Any') -> 'None': - """ + def ReplaceText(self, cCharacterPosition: 'Any', cNumToReplace: 'Any', pcharText: 'Any') -> 'None': + """ Description of ReplaceText. Args: @@ -16925,20 +16093,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIDebugDocumentTextEvents(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDebugDocumentTextEvents(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def onDestroy(self,) -> 'None': - """ + def onDestroy(self,) -> 'None': + """ Description of onDestroy. Args: @@ -16948,13 +16115,12 @@ Args: Returns: None - - """ - pass + """ + pass - def onInsertText(self,cCharacterPosition:'Any',cNumToInsert:'Any') -> 'None': - """ + def onInsertText(self, cCharacterPosition: 'Any', cNumToInsert: 'Any') -> 'None': + """ Description of onInsertText. Args: @@ -16965,13 +16131,12 @@ Args: Returns: None - - """ - pass + """ + pass - def onRemoveText(self,cCharacterPosition:'Any',cNumToRemove:'Any') -> 'None': - """ + def onRemoveText(self, cCharacterPosition: 'Any', cNumToRemove: 'Any') -> 'None': + """ Description of onRemoveText. Args: @@ -16982,13 +16147,12 @@ Args: Returns: None - - """ - pass + """ + pass - def onReplaceText(self,cCharacterPosition:'Any',cNumToReplace:'Any') -> 'None': - """ + def onReplaceText(self, cCharacterPosition: 'Any', cNumToReplace: 'Any') -> 'None': + """ Description of onReplaceText. Args: @@ -16999,13 +16163,12 @@ Args: Returns: None - - """ - pass + """ + pass - def onUpdateTextAttributes(self,cCharacterPosition:'Any',cNumToUpdate:'Any') -> 'None': - """ + def onUpdateTextAttributes(self, cCharacterPosition: 'Any', cNumToUpdate: 'Any') -> 'None': + """ Description of onUpdateTextAttributes. Args: @@ -17016,13 +16179,12 @@ Args: Returns: None - - """ - pass + """ + pass - def onUpdateDocumentAttributes(self,textdocattr:'Any') -> 'None': - """ + def onUpdateDocumentAttributes(self, textdocattr: 'Any') -> 'None': + """ Description of onUpdateDocumentAttributes. Args: @@ -17032,20 +16194,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIDebugDocumentTextExternalAuthor(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDebugDocumentTextExternalAuthor(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetPathName(self,) -> 'None': - """ + def GetPathName(self,) -> 'None': + """ Description of GetPathName. Args: @@ -17055,13 +16216,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetFileName(self,) -> 'None': - """ + def GetFileName(self,) -> 'None': + """ Description of GetFileName. Args: @@ -17071,13 +16231,12 @@ Args: Returns: None - - """ - pass + """ + pass - def NotifyChanged(self,) -> 'None': - """ + def NotifyChanged(self,) -> 'None': + """ Description of NotifyChanged. Args: @@ -17087,20 +16246,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIDebugExpression(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDebugExpression(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Start(self,pdecb:'Any') -> 'None': - """ + def Start(self, pdecb: 'Any') -> 'None': + """ Description of Start. Args: @@ -17110,13 +16268,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Abort(self,) -> 'None': - """ + def Abort(self,) -> 'None': + """ Description of Abort. Args: @@ -17126,13 +16283,12 @@ Args: Returns: None - - """ - pass + """ + pass - def QueryIsComplete(self,) -> 'None': - """ + def QueryIsComplete(self,) -> 'None': + """ Description of QueryIsComplete. Args: @@ -17142,13 +16298,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetResultAsString(self,) -> 'None': - """ + def GetResultAsString(self,) -> 'None': + """ Description of GetResultAsString. Args: @@ -17158,13 +16313,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetResultAsDebugProperties(self,) -> 'None': - """ + def GetResultAsDebugProperties(self,) -> 'None': + """ Description of GetResultAsDebugProperty. Args: @@ -17174,20 +16328,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIDebugExpressionCallBack(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDebugExpressionCallBack(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def onComplete(self,) -> 'None': - """ + def onComplete(self,) -> 'None': + """ Description of onComplete. Args: @@ -17197,20 +16350,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIDebugExpressionContext(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDebugExpressionContext(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def ParseLanguageText(self,pstrCode:'Any',nRadix:'Any',pstrDelimiter:'Any',dwFlags:'Any') -> 'None': - """ + def ParseLanguageText(self, pstrCode: 'Any', nRadix: 'Any', pstrDelimiter: 'Any', dwFlags: 'Any') -> 'None': + """ Description of ParseLanguageText. Args: @@ -17223,13 +16375,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetLanguageInfo(self,) -> 'None': - """ + def GetLanguageInfo(self,) -> 'None': + """ Description of GetLanguageInfo. Args: @@ -17239,20 +16390,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIDebugProperty(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDebugProperty(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetPropertyInfo(self,dwFieldSpec:'Any',nRadix:'Any') -> 'None': - """ + def GetPropertyInfo(self, dwFieldSpec: 'Any', nRadix: 'Any') -> 'None': + """ Description of GetPropertyInfo. Args: @@ -17263,13 +16413,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetExtendedInfo(self,) -> 'None': - """ + def GetExtendedInfo(self,) -> 'None': + """ Description of GetExtendedInfo. Args: @@ -17279,13 +16428,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetValueAsString(self,pszValue:'Any',nRadix:'Any') -> 'None': - """ + def SetValueAsString(self, pszValue: 'Any', nRadix: 'Any') -> 'None': + """ Description of SetValueAsString. Args: @@ -17296,13 +16444,12 @@ Args: Returns: None - - """ - pass + """ + pass - def EnumMembers(self,dwFieldSpec:'Any',nRadix:'Any',refiid:'PyIID') -> 'None': - """ + def EnumMembers(self, dwFieldSpec: 'Any', nRadix: 'Any', refiid: 'PyIID') -> 'None': + """ Description of EnumMembers. Args: @@ -17314,13 +16461,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetParent(self,) -> 'None': - """ + def GetParent(self,) -> 'None': + """ Description of GetParent. Args: @@ -17330,20 +16476,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIDebugSessionProvider(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDebugSessionProvider(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def StartDebugSession(self,pda:'Any') -> 'None': - """ + def StartDebugSession(self, pda: 'Any') -> 'None': + """ Description of StartDebugSession. Args: @@ -17353,20 +16498,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIDebugStackFrame(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDebugStackFrame(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetCodeContext(self,) -> 'None': - """ + def GetCodeContext(self,) -> 'None': + """ Returns the current code context associated with the stack frame. Args: @@ -17376,14 +16520,13 @@ Args: Returns: None - - """ - pass + """ + pass - def GetDescriptionString(self,fLong:'Any') -> 'Any': - """ - Returns a short or long textual description of the + def GetDescriptionString(self, fLong: 'Any') -> 'Any': + """ + Returns a short or long textual description of the stack frame. @@ -17394,14 +16537,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetLanguageString(self,fLong:'Any') -> 'Any': - """ - Returns a short or long textual description of the + def GetLanguageString(self, fLong: 'Any') -> 'Any': + """ + Returns a short or long textual description of the language. @@ -17412,14 +16554,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetThread(self,) -> 'Any': - """ - Returns the thread associated with this stack + def GetThread(self,) -> 'Any': + """ + Returns the thread associated with this stack frame. @@ -17430,20 +16571,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIDebugStackFrameSniffer(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDebugStackFrameSniffer(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def EnumStackFrames(self,) -> 'None': - """ + def EnumStackFrames(self,) -> 'None': + """ Description of EnumStackFrames. Args: @@ -17453,20 +16593,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIDebugStackFrameSnifferEx(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDebugStackFrameSnifferEx(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def EnumStackFramesEx(self,) -> 'None': - """ + def EnumStackFramesEx(self,) -> 'None': + """ Description of EnumStackFrames. Args: @@ -17476,20 +16615,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIDebugSyncOperation(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDebugSyncOperation(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetTargetThread(self,) -> 'None': - """ + def GetTargetThread(self,) -> 'None': + """ Description of GetTargetThread. Args: @@ -17499,13 +16637,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Execute(self,) -> 'None': - """ + def Execute(self,) -> 'None': + """ Description of Execute. Args: @@ -17515,13 +16652,12 @@ Args: Returns: None - - """ - pass + """ + pass - def InProgressAbort(self,) -> 'None': - """ + def InProgressAbort(self,) -> 'None': + """ Description of InProgressAbort. Args: @@ -17531,20 +16667,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIDefaultExtractIconInit(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDefaultExtractIconInit(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def SetFlags(self,uFlags:'Any') -> 'None': - """ + def SetFlags(self, uFlags: 'Any') -> 'None': + """ Description of SetFlags. Args: @@ -17554,13 +16689,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetKey(self,hkey:'PyHKEY') -> 'None': - """ + def SetKey(self, hkey: 'PyHKEY') -> 'None': + """ Description of SetKey. Args: @@ -17570,13 +16704,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetNormalIcon(self,pszFile:'Any',iIcon:'Any') -> 'None': - """ + def SetNormalIcon(self, pszFile: 'Any', iIcon: 'Any') -> 'None': + """ Description of SetNormalIcon. Args: @@ -17587,13 +16720,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetOpenIcon(self,pszFile:'Any',iIcon:'Any') -> 'None': - """ + def SetOpenIcon(self, pszFile: 'Any', iIcon: 'Any') -> 'None': + """ Description of SetOpenIcon. Args: @@ -17604,13 +16736,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetShortcutIcon(self,pszFile:'Any',iIcon:'Any') -> 'None': - """ + def SetShortcutIcon(self, pszFile: 'Any', iIcon: 'Any') -> 'None': + """ Description of SetShortcutIcon. Args: @@ -17621,13 +16752,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetDefaultIcon(self,pszFile:'Any',iIcon:'Any') -> 'None': - """ + def SetDefaultIcon(self, pszFile: 'Any', iIcon: 'Any') -> 'None': + """ Description of SetDefaultIcon. Args: @@ -17638,20 +16768,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIDirectSound(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDirectSound(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Initialize(self,guid:'PyIID') -> 'None': - """ + def Initialize(self, guid: 'PyIID') -> 'None': + """ Description of Initialize. Args: @@ -17661,14 +16790,13 @@ Args: Returns: None - - """ - pass + """ + pass - def SetCooperativeLevel(self,hwnd:'Any',level:'Any') -> 'None': - """ - The IDirectSound::SetCooperativeLevel method sets the cooperative level + def SetCooperativeLevel(self, hwnd: 'Any', level: 'Any') -> 'None': + """ + The IDirectSound::SetCooperativeLevel method sets the cooperative level of the application for this sound device. @@ -17680,14 +16808,13 @@ Args: Returns: None - - """ - pass + """ + pass - def CreateSoundBuffer(self,lpDSCBufferDesc:'Any',unk:'Any'=None) -> 'None': - """ - The IDirectSound::CreateSoundBuffer method creates a DirectSoundBuffer + def CreateSoundBuffer(self, lpDSCBufferDesc: 'Any', unk: 'Any' = None) -> 'None': + """ + The IDirectSound::CreateSoundBuffer method creates a DirectSoundBuffer object to hold a sequence of audio samples. @@ -17699,13 +16826,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetCaps(self,) -> 'None': - """ + def GetCaps(self,) -> 'None': + """ None Args: @@ -17715,14 +16841,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Compact(self,) -> 'None': - """ - The Compact method moves the unused portions of on-board sound memory, if any, to a + def Compact(self,) -> 'None': + """ + 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,20 +16858,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIDirectSoundBuffer(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDirectSoundBuffer(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Initialize(self,) -> 'None': - """ + def Initialize(self,) -> 'None': + """ Description of Initialize. Args: @@ -17756,13 +16880,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetStatus(self,) -> 'None': - """ + def GetStatus(self,) -> 'None': + """ Retrieves the current status of the sound buffer. Args: @@ -17772,14 +16895,13 @@ Args: Returns: None - - """ - pass + """ + pass - def GetCaps(self,) -> 'None': - """ - Retrieves the capabilities of the DirectSoundBuffer object as a DSBCAPS + def GetCaps(self,) -> 'None': + """ + Retrieves the capabilities of the DirectSoundBuffer object as a DSBCAPS object. @@ -17790,14 +16912,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Restore(self,) -> 'None': - """ - Restores the memory allocation for a lost sound buffer for the specified + def Restore(self,) -> 'None': + """ + Restores the memory allocation for a lost sound buffer for the specified DirectSoundBuffer object. @@ -17808,13 +16929,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetCurrentPosition(self,) -> 'None': - """ + def GetCurrentPosition(self,) -> 'None': + """ Description of GetCurrentPosition. Args: @@ -17824,13 +16944,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Play(self,) -> 'None': - """ + def Play(self,) -> 'None': + """ Description of Play. Args: @@ -17840,13 +16959,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetCurrentPosition(self,) -> 'None': - """ + def SetCurrentPosition(self,) -> 'None': + """ Description of SetCurrentPosition. Args: @@ -17856,13 +16974,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Stop(self,) -> 'None': - """ + def Stop(self,) -> 'None': + """ Description of Stop. Args: @@ -17872,13 +16989,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetFrequency(self,) -> 'None': - """ + def GetFrequency(self,) -> 'None': + """ Description of GetFrequency. Args: @@ -17888,13 +17004,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetPan(self,) -> 'None': - """ + def GetPan(self,) -> 'None': + """ Description of GetPan. Args: @@ -17904,13 +17019,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetVolume(self,) -> 'None': - """ + def GetVolume(self,) -> 'None': + """ Description of GetVolume. Args: @@ -17920,13 +17034,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetFrequency(self,) -> 'None': - """ + def SetFrequency(self,) -> 'None': + """ Description of SetFrequency. Args: @@ -17936,13 +17049,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetPan(self,) -> 'None': - """ + def SetPan(self,) -> 'None': + """ Description of SetPan. Args: @@ -17952,13 +17064,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetVolume(self,) -> 'None': - """ + def SetVolume(self,) -> 'None': + """ Description of SetVolume. Args: @@ -17968,22 +17079,21 @@ Args: Returns: None - - """ - pass + + """ + 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.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Initialize(self,) -> 'None': - """ + def Initialize(self,) -> 'None': + """ Not normally called directly. Use DirectSoundCaptureCreate instead. Args: @@ -17993,13 +17103,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetCaps(self,) -> 'None': - """ + def GetCaps(self,) -> 'None': + """ None Args: @@ -18009,23 +17118,22 @@ Args: Returns: None - - """ - pass + + """ + 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.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Initialize(self,) -> 'None': - """ - Not normally used. Used IDirectSoundCapture.CreateCaptureBuffer + def Initialize(self,) -> 'None': + """ + Not normally used. Used IDirectSoundCapture.CreateCaptureBuffer instead. @@ -18036,13 +17144,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetStatus(self,) -> 'None': - """ + def GetStatus(self,) -> 'None': + """ Retrieves the current status of the sound capture buffer. Args: @@ -18052,18 +17159,17 @@ Args: Returns: None - - """ - pass + """ + pass - def GetCurrentPosition(self,) -> 'None': - """ - Returns a tuple of the current capture and read position in + def GetCurrentPosition(self,) -> 'None': + """ + 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 +17180,15 @@ Args: Returns: None - - """ - pass + """ + pass - def Stop(self,) -> 'None': - """ - The IDirectSoundCaptureBuffer::Stop method puts the capture buffer into + def Stop(self,) -> 'None': + """ + 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,27 +17199,26 @@ Args: Returns: None - - """ - pass + + """ + pass class PyIDirectSoundNotify(object): - """Description of the interface""" + """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyIDirectoryObject(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetObjectInformation(self,) -> 'Any': - """ + def GetObjectInformation(self,) -> 'Any': + """ None Args: @@ -18124,13 +17228,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetObjectAttributes(self,names:'Tuple[str, ...]') -> 'Tuple[Any, ...]': - """ + def GetObjectAttributes(self, names: 'Tuple[str, ...]') -> 'Tuple[Any, ...]': + """ None Args: @@ -18140,13 +17243,12 @@ Args: Returns: Tuple[Any, ...] - - """ - pass + """ + pass - def SetObjectAttributes(self,attrs:'Tuple[Any, ...]') -> 'Any': - """ + def SetObjectAttributes(self, attrs: 'Tuple[Any, ...]') -> 'Any': + """ None Args: @@ -18156,13 +17258,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def CreateDSObject(self,rdn:'str',attrs:'Tuple[Any, ...]') -> 'Any': - """ + def CreateDSObject(self, rdn: 'str', attrs: 'Tuple[Any, ...]') -> 'Any': + """ None Args: @@ -18173,13 +17274,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def DeleteDSObject(self,rdn:'str') -> 'None': - """ + def DeleteDSObject(self, rdn: 'str') -> 'None': + """ Deletes a leaf object in a directory tree Args: @@ -18189,20 +17289,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIDirectorySearch(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDirectorySearch(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def SetSearchPreference(self,prefs:'Any') -> 'Tuple[Any, Any, Any]': - """ + def SetSearchPreference(self, prefs: 'Any') -> 'Tuple[Any, Any, Any]': + """ None Args: @@ -18211,17 +17310,16 @@ Args: Returns: - Tuple[Any, Any, Any]:Return ValueThe result is the hresult of the call, and a list of integer status + Tuple[Any, Any, Any]:Return ValueThe result is the hresult of the call, and a list of integer status codes for each of the preferences set. - - """ - pass + """ + pass - def ExecuteSearch(self,_filter:'str',attrNames:'List[str]') -> 'Any': - """ + def ExecuteSearch(self, _filter: 'str', attrNames: 'List[str]') -> 'Any': + """ None Args: @@ -18231,17 +17329,16 @@ Args: Returns: - Any:Return ValueThe result is an integer search handle. PyIDirectorySearch::CloseSearchHandle + Any:Return ValueThe result is an integer search handle. PyIDirectorySearch::CloseSearchHandle should be called to close the handle. - - """ - pass + """ + pass - def GetNextRow(self,handle:'Any') -> 'Any': - """ + def GetNextRow(self, handle: 'Any') -> 'Any': + """ None Args: @@ -18252,13 +17349,12 @@ Returns: Any:Return ValueThe result is the HRESULT from the call - no exceptions are thrown - - """ - pass + """ + pass - def GetFirstRow(self,handle:'Any') -> 'Any': - """ + def GetFirstRow(self, handle: 'Any') -> 'Any': + """ None Args: @@ -18269,13 +17365,12 @@ Returns: Any:Return ValueThe result is the HRESULT from the call - no exceptions are thrown - - """ - pass + """ + pass - def GetPreviousRow(self,handle:'Any') -> 'Any': - """ + def GetPreviousRow(self, handle: 'Any') -> 'Any': + """ None Args: @@ -18286,13 +17381,12 @@ Returns: Any:Return ValueThe result is the HRESULT from the call - no exceptions are thrown - - """ - pass + """ + pass - def CloseSearchHandle(self,handle:'Any') -> 'None': - """ + def CloseSearchHandle(self, handle: 'Any') -> 'None': + """ Closes a previously opened search handle. Args: @@ -18302,13 +17396,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AdandonSearch(self,handle:'Any') -> 'None': - """ + def AdandonSearch(self, handle: 'Any') -> 'None': + """ None Args: @@ -18318,13 +17411,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetColumn(self,handle:'Any',name:'str') -> 'Tuple[Any, Any, Any]': - """ + def GetColumn(self, handle: 'Any', name: 'str') -> 'Tuple[Any, Any, Any]': + """ None Args: @@ -18335,13 +17427,12 @@ Args: Returns: Tuple[Any, Any, Any] - - """ - pass + """ + pass - def GetNextColumnName(self,) -> 'None': - """ + def GetNextColumnName(self,) -> 'None': + """ None Args: @@ -18354,20 +17445,19 @@ Returns: GetNextColumnName() Return ValueReturns None when the underlying ADSI function return S_ADS_NOMORE_COLUMNS. - - """ - pass + """ + pass -class PyIDispatch(object): - """A OLE automation client object.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDispatch(object): + """A OLE automation client object.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Invoke(self,dispid:'Any',lcid:'Any',flags:'Any',bResultWanted:'Any',arg:'Tuple[Any, ...]') -> 'Any': - """ + def Invoke(self, dispid: 'Any', lcid: 'Any', flags: 'Any', bResultWanted: 'Any', arg: 'Tuple[Any, ...]') -> 'Any': + """ Invokes a DISPID, using the passed arguments. Args: @@ -18380,17 +17470,23 @@ Args: Returns: - Any:The parameters to pass.Return ValueIf the bResultWanted parameter is False, then the result will be None. + 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 + """ + pass - def InvokeTypes(self,dispid:'Any',lcid:'Any',wFlags:'Any',resultTypeDesc:'Any',typeDescs:'Tuple[Any, ...]',args:'Tuple[Any, ...]') -> 'Any': - """ + def InvokeTypes( + self, + dispid: 'Any', + lcid: 'Any', + wFlags: 'Any', + resultTypeDesc: 'Any', + typeDescs: 'Tuple[Any, ...]', + args: 'Tuple[Any, ...]') -> 'Any': + """ Invokes a DISPID, using the passed arguments and type descriptions. Args: @@ -18405,13 +17501,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetIDsOfNames(self,name:'str',arg:'Any') -> 'Tuple[Any, Union[Any]]': - """ + def GetIDsOfNames(self, name: 'str', arg: 'Any') -> 'Tuple[Any, Union[Any]]': + """ Get the DISPID for the passed names. Args: @@ -18425,19 +17520,18 @@ 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 + """ + pass - def GetTypeInfo(self,locale:'Any',index:'Any'=0) -> 'Any': - """ + def GetTypeInfo(self, locale: 'Any', index: 'Any' = 0) -> 'Any': + """ Get type information for the object. Args: @@ -18448,13 +17542,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetTypeInfoCount(self,) -> 'Any': - """ + def GetTypeInfoCount(self,) -> 'Any': + """ None Args: @@ -18464,20 +17557,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIDispatchEx(object): - """A OLE automation client object that uses the IDispatchEx scripting interface..""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDispatchEx(object): + """A OLE automation client object that uses the IDispatchEx scripting interface..""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetDispID(self,name:'str',fdex:'Any') -> 'Any': - """ + def GetDispID(self, name: 'str', fdex: 'Any') -> 'Any': + """ Returns the member id for a name Args: @@ -18488,13 +17580,20 @@ Args: Returns: Any - - """ - pass + """ + pass - def InvokeEx(self,dispid:'Any',lcid:'Any',flags:'Any',args:'List[Any]',types:'List[Any]'=None,returnDesc:'Any'=1,serviceProvider:'Any'=None) -> 'Any': - """ + def InvokeEx( + self, + dispid: 'Any', + lcid: 'Any', + flags: 'Any', + args: 'List[Any]', + types: 'List[Any]' = None, + returnDesc: 'Any' = 1, + serviceProvider: 'Any' = None) -> 'Any': + """ None Args: @@ -18510,13 +17609,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def DeleteMemberByName(self,name:'str',fdex:'Any') -> 'None': - """ + def DeleteMemberByName(self, name: 'str', fdex: 'Any') -> 'None': + """ None Args: @@ -18527,13 +17625,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DeleteMemberByDispID(self,dispid:'Any') -> 'None': - """ + def DeleteMemberByDispID(self, dispid: 'Any') -> 'None': + """ None Args: @@ -18543,13 +17640,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetMemberProperties(self,dispid:'Any',fdex:'Any') -> 'Any': - """ + def GetMemberProperties(self, dispid: 'Any', fdex: 'Any') -> 'Any': + """ Returns mask of fdex* flags describing a member Args: @@ -18560,13 +17656,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetMemberName(self,dispid:'Any') -> 'Any': - """ + def GetMemberName(self, dispid: 'Any') -> 'Any': + """ Returns the name associated with a member id Args: @@ -18576,13 +17671,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetNextDispID(self,fdex:'Any',dispid:'Any') -> 'Any': - """ + def GetNextDispID(self, fdex: 'Any', dispid: 'Any') -> 'Any': + """ Enumerates member ids. Args: @@ -18593,27 +17687,26 @@ Args: Returns: Any - - """ - pass + + """ + pass class PyIDisplayItem(object): - """Description of the interface""" + """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyIDocHostUIHandler(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def ShowContextMenu(self,dwID:'Any',pt:'Tuple[Any, Any]',pcmdtReserved:'Any',pdispReserved:'Any') -> 'None': - """ + def ShowContextMenu(self, dwID: 'Any', pt: 'Tuple[Any, Any]', pcmdtReserved: 'Any', pdispReserved: 'Any') -> 'None': + """ Description of ShowContextMenu. Args: @@ -18626,13 +17719,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetHostInfo(self,) -> 'None': - """ + def GetHostInfo(self,) -> 'None': + """ Description of GetHostInfo. Args: @@ -18642,13 +17734,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ShowUI(self,dwID:'Any',pActiveObject:'Any',pCommandTarget:'Any',pFrame:'Any',pDoc:'Any') -> 'None': - """ + def ShowUI(self, dwID: 'Any', pActiveObject: 'Any', pCommandTarget: 'Any', pFrame: 'Any', pDoc: 'Any') -> 'None': + """ Description of ShowUI. Args: @@ -18662,13 +17753,12 @@ Args: Returns: None - - """ - pass + """ + pass - def HideUI(self,) -> 'None': - """ + def HideUI(self,) -> 'None': + """ Description of HideUI. Args: @@ -18678,13 +17768,12 @@ Args: Returns: None - - """ - pass + """ + pass - def UpdateUI(self,) -> 'None': - """ + def UpdateUI(self,) -> 'None': + """ Description of UpdateUI. Args: @@ -18694,13 +17783,12 @@ Args: Returns: None - - """ - pass + """ + pass - def EnableModeless(self,fEnable:'Any') -> 'None': - """ + def EnableModeless(self, fEnable: 'Any') -> 'None': + """ Description of EnableModeless. Args: @@ -18710,13 +17798,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnDocWindowActivate(self,fActivate:'Any') -> 'None': - """ + def OnDocWindowActivate(self, fActivate: 'Any') -> 'None': + """ Description of OnDocWindowActivate. Args: @@ -18726,13 +17813,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnFrameWindowActivate(self,fActivate:'Any') -> 'None': - """ + def OnFrameWindowActivate(self, fActivate: 'Any') -> 'None': + """ Description of OnFrameWindowActivate. Args: @@ -18742,13 +17828,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ResizeBorder(self,prcBorder:'Tuple[Any, Any, Any, Any]',pUIWindow:'Any',fRameWindow:'Any') -> 'None': - """ + def ResizeBorder(self, prcBorder: 'Tuple[Any, Any, Any, Any]', pUIWindow: 'Any', fRameWindow: 'Any') -> 'None': + """ Description of ResizeBorder. Args: @@ -18760,13 +17845,12 @@ Args: Returns: None - - """ - pass + """ + pass - def TranslateAccelerator(self,lpMsg:'Any',pguidCmdGroup:'PyIID',nCmdID:'Any') -> 'None': - """ + def TranslateAccelerator(self, lpMsg: 'Any', pguidCmdGroup: 'PyIID', nCmdID: 'Any') -> 'None': + """ Description of TranslateAccelerator. Args: @@ -18778,13 +17862,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetOptionKeyPath(self,dw:'Any') -> 'None': - """ + def GetOptionKeyPath(self, dw: 'Any') -> 'None': + """ Description of GetOptionKeyPath. Args: @@ -18794,13 +17877,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetDropTarget(self,pDropTarget:'Any') -> 'None': - """ + def GetDropTarget(self, pDropTarget: 'Any') -> 'None': + """ Description of GetDropTarget. Args: @@ -18810,13 +17892,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetExternal(self,) -> 'None': - """ + def GetExternal(self,) -> 'None': + """ Description of GetExternal. Args: @@ -18826,13 +17907,12 @@ Args: Returns: None - - """ - pass + """ + pass - def TranslateUrl(self,dwTranslate:'Any',pchURLIn:'Any') -> 'None': - """ + def TranslateUrl(self, dwTranslate: 'Any', pchURLIn: 'Any') -> 'None': + """ Description of TranslateUrl. Args: @@ -18843,13 +17923,12 @@ Args: Returns: None - - """ - pass + """ + pass - def FilterDataObject(self,pDO:'Any') -> 'None': - """ + def FilterDataObject(self, pDO: 'Any') -> 'None': + """ Description of FilterDataObject. Args: @@ -18859,20 +17938,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIDropSource(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDropSource(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def QueryContinueDrag(self,fEscapePressed:'Any',grfKeyState:'Any') -> 'None': - """ + def QueryContinueDrag(self, fEscapePressed: 'Any', grfKeyState: 'Any') -> 'None': + """ Description of QueryContinueDrag. Args: @@ -18883,13 +17961,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GiveFeedback(self,dwEffect:'Any') -> 'None': - """ + def GiveFeedback(self, dwEffect: 'Any') -> 'None': + """ Description of GiveFeedback. Args: @@ -18899,20 +17976,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIDropTarget(object): - """Interface that acts as a target of OLE drag and drop operations""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDropTarget(object): + """Interface that acts as a target of OLE drag and drop operations""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def DragEnter(self,pDataObj:'Any',grfKeyState:'Any',pt:'Tuple[Any, Any]',pdwEffect:'Any') -> 'Any': - """ + def DragEnter(self, pDataObj: 'Any', grfKeyState: 'Any', pt: 'Tuple[Any, Any]', pdwEffect: 'Any') -> 'Any': + """ Called when an object is initially dragged into a window Args: @@ -18924,17 +18000,16 @@ Args: Returns: - Any:shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return a shellcon.DROPEFFECT_* value indicating if the object can + Any:shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return a shellcon.DROPEFFECT_* value indicating if the object can be accepted - - """ - pass + """ + pass - def DragOver(self,grfKeyState:'Any',pt:'Tuple[Any, Any]',pdwEffect:'Any') -> 'Any': - """ + def DragOver(self, grfKeyState: 'Any', pt: 'Tuple[Any, Any]', pdwEffect: 'Any') -> 'Any': + """ Called as the dragged object moves over the window Args: @@ -18945,17 +18020,16 @@ Args: Returns: - Any:shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return a shellcon.DROPEFFECT_* value indicating if the + 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 + """ + pass - def DragLeave(self,) -> 'None': - """ + def DragLeave(self,) -> 'None': + """ Called as the object is dragged back out of the window Args: @@ -18965,13 +18039,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Drop(self,pDataObj:'Any',grfKeyState:'Any',pt:'Tuple[Any, Any]',dwEffect:'Any') -> 'Any': - """ + def Drop(self, pDataObj: 'Any', grfKeyState: 'Any', pt: 'Tuple[Any, Any]', dwEffect: 'Any') -> 'Any': + """ Called when the object is dropped onto the window Args: @@ -18985,20 +18058,19 @@ Returns: Any:shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return one of the shellcon.DROPEFFECT_* values - - """ - pass + """ + pass -class PyIDropTargetHelper(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIDropTargetHelper(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def DragEnter(self,hwnd:'int',pDataObj:'Any',pt:'Tuple[Any, Any]',dwEffect:'Any') -> 'None': - """ + def DragEnter(self, hwnd: 'int', pDataObj: 'Any', pt: 'Tuple[Any, Any]', dwEffect: 'Any') -> 'None': + """ Description of DragEnter. Args: @@ -19011,13 +18083,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DragOver(self,hwnd:'Any',pt:'Tuple[Any, Any]',pdwEffect:'Any') -> 'None': - """ + def DragOver(self, hwnd: 'Any', pt: 'Tuple[Any, Any]', pdwEffect: 'Any') -> 'None': + """ Description of DragOver. Args: @@ -19029,13 +18100,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DragLeave(self,) -> 'None': - """ + def DragLeave(self,) -> 'None': + """ Description of DragLeave. Args: @@ -19045,13 +18115,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Drop(self,pDataObj:'Any',pt:'Tuple[Any, Any]',dwEffect:'Any') -> 'None': - """ + def Drop(self, pDataObj: 'Any', pt: 'Tuple[Any, Any]', dwEffect: 'Any') -> 'None': + """ Description of Drop. Args: @@ -19063,20 +18132,24 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIDsObjectPicker(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Initialize(self,targetComputer:'str',scopeInfos:'Any',options:'Any'=0,attrNames:'List[str]'=None) -> 'None': - """ +class PyIDsObjectPicker(object): + """""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + def Initialize( + self, + targetComputer: 'str', + scopeInfos: 'Any', + options: 'Any' = 0, + attrNames: 'List[str]' = None) -> 'None': + """ Initializes the IDsObjectPicker interface with information about the scopes, filters, and options used by the object picker dialog box. Args: @@ -19089,13 +18162,12 @@ Args: Returns: None - - """ - pass + """ + pass - def InvokeDialog(self,hwnd:'Any') -> 'Any': - """ + def InvokeDialog(self, hwnd: 'Any') -> 'Any': + """ Displays a modal object picker dialog box and returns the user's selections. Args: @@ -19105,34 +18177,33 @@ Args: Returns: Any - - """ - pass + + """ + pass class PyIEmptyVolumeCache(object): - """Used for cleaning up temporary file ("disk cleanup")""" + """Used for cleaning up temporary file ("disk cleanup")""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyIEmptyVolumeCache2(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyIEmptyVolumeCacheCallBack(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def ScanProgress(self,dwlSpaceUsed:'Any',dwFlags:'Any',pcwszStatus:'Any') -> 'None': - """ + def ScanProgress(self, dwlSpaceUsed: 'Any', dwFlags: 'Any', pcwszStatus: 'Any') -> 'None': + """ Description of ScanProgress. Args: @@ -19144,13 +18215,18 @@ Args: Returns: None - - """ - pass + """ + pass - def PurgeProgress(self,dwlSpaceFreed:'Any',spaceFreed:'Any',spaceToFree:'Any',flags:'Any',status:'Any') -> 'None': - """ + def PurgeProgress( + self, + dwlSpaceFreed: 'Any', + spaceFreed: 'Any', + spaceToFree: 'Any', + flags: 'Any', + status: 'Any') -> 'None': + """ Description of PurgeProgress. Args: @@ -19164,21 +18240,20 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIEnumCATEGORYINFO(object): - """A Python interface to IEnumCATEGORYINFO""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIEnumCATEGORYINFO(object): + """A Python interface to IEnumCATEGORYINFO""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Next(self,num:'Any'=1) -> 'Tuple[Tuple[PyIID, Any, str], ...]': - """ - Retrieves a specified number of items in the + def Next(self, num: 'Any' = 1) -> 'Tuple[Tuple[PyIID, Any, str], ...]': + """ + Retrieves a specified number of items in the enumeration sequence. @@ -19189,17 +18264,16 @@ Args: Returns: Tuple[Tuple[PyIID, 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 + """ + pass - def Skip(self,num:'Any') -> 'None': - """ + def Skip(self, num: 'Any') -> 'None': + """ Skips over the next specified elementes. Args: @@ -19209,13 +18283,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Reset(self,) -> 'None': - """ + def Reset(self,) -> 'None': + """ Resets the enumeration sequence to the beginning. Args: @@ -19225,14 +18298,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same + def Clone(self,) -> 'Any': + """ + Creates another enumerator that contains the same enumeration state as the current one @@ -19243,21 +18315,20 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIEnumConnectionPoints(object): - """A Python interface to IEnumConnectionPoints""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIEnumConnectionPoints(object): + """A Python interface to IEnumConnectionPoints""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Next(self,num:'Any'=1) -> 'Tuple[Any, ...]': - """ - Retrieves a specified number of items in the + def Next(self, num: 'Any' = 1) -> 'Tuple[Any, ...]': + """ + Retrieves a specified number of items in the enumeration sequence. @@ -19268,13 +18339,12 @@ Args: Returns: Tuple[Any, ...] - - """ - pass + """ + pass - def Skip(self,) -> 'None': - """ + def Skip(self,) -> 'None': + """ Skips over the next specified elementes. Args: @@ -19284,13 +18354,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Reset(self,) -> 'None': - """ + def Reset(self,) -> 'None': + """ Resets the enumeration sequence to the beginning. Args: @@ -19300,14 +18369,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same + def Clone(self,) -> 'Any': + """ + Creates another enumerator that contains the same enumeration state as the current one @@ -19318,20 +18386,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIEnumConnections(object): - """A Python interface to IEnumConnections""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIEnumConnections(object): + """A Python interface to IEnumConnections""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Next(self,num:'Any'=1) -> 'Any': - """ + def Next(self, num: 'Any' = 1) -> 'Any': + """ Retrieves a specified number of items in the enumeration sequence. Args: @@ -19341,13 +18408,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Skip(self,) -> 'None': - """ + def Skip(self,) -> 'None': + """ Skips over the next specified elementes. Args: @@ -19357,13 +18423,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Reset(self,) -> 'None': - """ + def Reset(self,) -> 'None': + """ Resets the enumeration sequence to the beginning. Args: @@ -19373,14 +18438,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same + def Clone(self,) -> 'Any': + """ + Creates another enumerator that contains the same enumeration state as the current one @@ -19391,21 +18455,20 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIEnumContextProps(object): - """A Python interface to IEnumContextProps""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIEnumContextProps(object): + """A Python interface to IEnumContextProps""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Next(self,num:'Any'=1) -> 'Tuple[Tuple[PyIID, Any, Any], ...]': - """ - Retrieves a specified number of items in + def Next(self, num: 'Any' = 1) -> 'Tuple[Tuple[PyIID, Any, Any], ...]': + """ + Retrieves a specified number of items in the enumeration sequence. @@ -19416,19 +18479,18 @@ Args: Returns: Tuple[Tuple[PyIID, Any, Any], ...]: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 + """ + pass - def Skip(self,) -> 'None': - """ + def Skip(self,) -> 'None': + """ Skips over the next specified elementes. Args: @@ -19438,13 +18500,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Reset(self,) -> 'None': - """ + def Reset(self,) -> 'None': + """ Resets the enumeration sequence to the beginning. Args: @@ -19454,14 +18515,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same + def Clone(self,) -> 'Any': + """ + Creates another enumerator that contains the same enumeration state as the current one @@ -19472,20 +18532,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIEnumDebugApplicationNodes(object): - """A Python interface to IEnumDebugApplicationNodes""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIEnumDebugApplicationNodes(object): + """A Python interface to IEnumDebugApplicationNodes""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Next(self,num:'Any'=1) -> 'Any': - """ + def Next(self, num: 'Any' = 1) -> 'Any': + """ Retrieves a specified number of items in the enumeration sequence. Args: @@ -19495,13 +18554,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Skip(self,) -> 'None': - """ + def Skip(self,) -> 'None': + """ Skips over the next specified elementes. Args: @@ -19511,13 +18569,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Reset(self,) -> 'None': - """ + def Reset(self,) -> 'None': + """ Resets the enumeration sequence to the beginning. Args: @@ -19527,14 +18584,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Clone(self,) -> 'Any': - """ - Creates another enumerator that + def Clone(self,) -> 'Any': + """ + Creates another enumerator that contains the same enumeration state as the current one @@ -19545,20 +18601,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIEnumDebugCodeContexts(object): - """A Python interface to IEnumDebugCodeContexts""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIEnumDebugCodeContexts(object): + """A Python interface to IEnumDebugCodeContexts""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Next(self,num:'Any'=1) -> 'Any': - """ + def Next(self, num: 'Any' = 1) -> 'Any': + """ Retrieves a specified number of items in the enumeration sequence. Args: @@ -19568,13 +18623,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Skip(self,) -> 'None': - """ + def Skip(self,) -> 'None': + """ Skips over the next specified elementes. Args: @@ -19584,13 +18638,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Reset(self,) -> 'None': - """ + def Reset(self,) -> 'None': + """ Resets the enumeration sequence to the beginning. Args: @@ -19600,14 +18653,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the + def Clone(self,) -> 'Any': + """ + Creates another enumerator that contains the same enumeration state as the current one @@ -19618,21 +18670,20 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIEnumDebugExpressionContexts(object): - """A Python interface to IEnumDebugExpressionContexts""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIEnumDebugExpressionContexts(object): + """A Python interface to IEnumDebugExpressionContexts""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Next(self,num:'Any'=1) -> 'Any': - """ - Retrieves a specified number of items in the enumeration + def Next(self, num: 'Any' = 1) -> 'Any': + """ + Retrieves a specified number of items in the enumeration sequence. @@ -19643,13 +18694,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Skip(self,) -> 'None': - """ + def Skip(self,) -> 'None': + """ Skips over the next specified elementes. Args: @@ -19659,13 +18709,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Reset(self,) -> 'None': - """ + def Reset(self,) -> 'None': + """ Resets the enumeration sequence to the beginning. Args: @@ -19675,14 +18724,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Clone(self,) -> 'Any': - """ - Creates another enumerator that + def Clone(self,) -> 'Any': + """ + Creates another enumerator that contains the same enumeration state as the current one @@ -19693,20 +18741,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIEnumDebugPropertyInfo(object): - """A Python interface to IEnumDebugPropertyInfo""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIEnumDebugPropertyInfo(object): + """A Python interface to IEnumDebugPropertyInfo""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Next(self,num:'Any'=1) -> 'Any': - """ + def Next(self, num: 'Any' = 1) -> 'Any': + """ Retrieves a specified number of items in the enumeration sequence. Args: @@ -19716,13 +18763,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Skip(self,) -> 'None': - """ + def Skip(self,) -> 'None': + """ Skips over the next specified elementes. Args: @@ -19732,13 +18778,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Reset(self,) -> 'None': - """ + def Reset(self,) -> 'None': + """ Resets the enumeration sequence to the beginning. Args: @@ -19748,14 +18793,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the + def Clone(self,) -> 'Any': + """ + Creates another enumerator that contains the same enumeration state as the current one @@ -19766,13 +18810,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetCount(self,) -> 'Any': - """ + def GetCount(self,) -> 'Any': + """ Obtains the number of items Args: @@ -19782,20 +18825,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIEnumDebugStackFrames(object): - """A Python interface to IEnumDebugStackFrames""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIEnumDebugStackFrames(object): + """A Python interface to IEnumDebugStackFrames""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Next(self,num:'Any'=1) -> 'Any': - """ + def Next(self, num: 'Any' = 1) -> 'Any': + """ Retrieves a specified number of items in the enumeration sequence. Args: @@ -19805,13 +18847,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Skip(self,) -> 'None': - """ + def Skip(self,) -> 'None': + """ Skips over the next specified elementes. Args: @@ -19821,13 +18862,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Reset(self,) -> 'None': - """ + def Reset(self,) -> 'None': + """ Resets the enumeration sequence to the beginning. Args: @@ -19837,14 +18877,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same + def Clone(self,) -> 'Any': + """ + Creates another enumerator that contains the same enumeration state as the current one @@ -19855,20 +18894,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIEnumExplorerCommand(object): - """A Python interface to IEnumExplorerCommand""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIEnumExplorerCommand(object): + """A Python interface to IEnumExplorerCommand""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Next(self,num:'Any'=1) -> 'Any': - """ + def Next(self, num: 'Any' = 1) -> 'Any': + """ Retrieves a specified number of items in the enumeration sequence. Args: @@ -19878,13 +18916,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Skip(self,) -> 'None': - """ + def Skip(self,) -> 'None': + """ Skips over the next specified elementes. Args: @@ -19894,13 +18931,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Reset(self,) -> 'None': - """ + def Reset(self,) -> 'None': + """ Resets the enumeration sequence to the beginning. Args: @@ -19910,14 +18946,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same + def Clone(self,) -> 'Any': + """ + Creates another enumerator that contains the same enumeration state as the current one @@ -19928,20 +18963,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIEnumFORMATETC(object): - """A Python interface to IEnumFORMATETC""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIEnumFORMATETC(object): + """A Python interface to IEnumFORMATETC""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Next(self,num:'Any'=1) -> 'Any': - """ + def Next(self, num: 'Any' = 1) -> 'Any': + """ Retrieves a specified number of items in the enumeration sequence. Args: @@ -19951,13 +18985,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Skip(self,) -> 'None': - """ + def Skip(self,) -> 'None': + """ Skips over the next specified elementes. Args: @@ -19967,13 +19000,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Reset(self,) -> 'None': - """ + def Reset(self,) -> 'None': + """ Resets the enumeration sequence to the beginning. Args: @@ -19983,14 +19015,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same enumeration + def Clone(self,) -> 'Any': + """ + Creates another enumerator that contains the same enumeration state as the current one @@ -20001,20 +19032,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIEnumGUID(object): - """A Python interface to IEnumGUID""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIEnumGUID(object): + """A Python interface to IEnumGUID""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Next(self,num:'Any'=1) -> 'Tuple[PyIID, ...]': - """ + def Next(self, num: 'Any' = 1) -> 'Tuple[PyIID, ...]': + """ Retrieves a specified number of items in the enumeration sequence. Args: @@ -20024,19 +19054,18 @@ Args: Returns: 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 + """ + pass - def Skip(self,num:'Any') -> 'None': - """ + def Skip(self, num: 'Any') -> 'None': + """ Skips over the next specified elementes. Args: @@ -20046,13 +19075,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Reset(self,) -> 'None': - """ + def Reset(self,) -> 'None': + """ Resets the enumeration sequence to the beginning. Args: @@ -20062,14 +19090,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same enumeration state as + def Clone(self,) -> 'Any': + """ + Creates another enumerator that contains the same enumeration state as the current one @@ -20080,20 +19107,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIEnumIDList(object): - """A Python interface to IEnumIDList""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIEnumIDList(object): + """A Python interface to IEnumIDList""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Next(self,num:'Any'=1) -> 'Any': - """ + def Next(self, num: 'Any' = 1) -> 'Any': + """ Retrieves a specified number of items in the enumeration sequence. Args: @@ -20103,13 +19129,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Skip(self,) -> 'None': - """ + def Skip(self,) -> 'None': + """ Skips over the next specified elementes. Args: @@ -20119,13 +19144,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Reset(self,) -> 'None': - """ + def Reset(self,) -> 'None': + """ Resets the enumeration sequence to the beginning. Args: @@ -20135,14 +19159,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same enumeration state + def Clone(self,) -> 'Any': + """ + Creates another enumerator that contains the same enumeration state as the current one @@ -20153,20 +19176,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIEnumMoniker(object): - """A Python interface to IEnumMoniker""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIEnumMoniker(object): + """A Python interface to IEnumMoniker""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Next(self,num:'Any'=1) -> 'Any': - """ + def Next(self, num: 'Any' = 1) -> 'Any': + """ Retrieves a specified number of items in the enumeration sequence. Args: @@ -20176,19 +19198,18 @@ Args: Returns: Any: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 + """ + pass - def Skip(self,num:'Any') -> 'None': - """ + def Skip(self, num: 'Any') -> 'None': + """ Skips over the next specified elementes. Args: @@ -20198,13 +19219,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Reset(self,) -> 'None': - """ + def Reset(self,) -> 'None': + """ Resets the enumeration sequence to the beginning. Args: @@ -20214,14 +19234,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same enumeration state + def Clone(self,) -> 'Any': + """ + Creates another enumerator that contains the same enumeration state as the current one @@ -20232,20 +19251,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIEnumObjects(object): - """Iterates through a number of arbitrary interfaces""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIEnumObjects(object): + """Iterates through a number of arbitrary interfaces""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Next(self,riid:'PyIID',num:'Any'=1) -> 'Tuple[Any, ...]': - """ + def Next(self, riid: 'PyIID', num: 'Any' = 1) -> 'Tuple[Any, ...]': + """ Retrieves a specified number of items in the enumeration sequence. Args: @@ -20256,13 +19274,12 @@ Args: Returns: Tuple[Any, ...] - - """ - pass + """ + pass - def Skip(self,) -> 'None': - """ + def Skip(self,) -> 'None': + """ Skips over the next specified elementes. Args: @@ -20272,13 +19289,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Reset(self,) -> 'None': - """ + def Reset(self,) -> 'None': + """ Resets the enumeration sequence to the beginning. Args: @@ -20288,14 +19304,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same enumeration state + def Clone(self,) -> 'Any': + """ + Creates another enumerator that contains the same enumeration state as the current one @@ -20306,21 +19321,20 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIEnumRemoteDebugApplicationThreads(object): - """A Python interface to IEnumRemoteDebugApplicationThreads""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIEnumRemoteDebugApplicationThreads(object): + """A Python interface to IEnumRemoteDebugApplicationThreads""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Next(self,num:'Any'=1) -> 'Any': - """ - Retrieves a specified number of items in the enumeration + def Next(self, num: 'Any' = 1) -> 'Any': + """ + Retrieves a specified number of items in the enumeration sequence. @@ -20331,13 +19345,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Skip(self,) -> 'None': - """ + def Skip(self,) -> 'None': + """ Skips over the next specified elementes. Args: @@ -20347,13 +19360,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Reset(self,) -> 'None': - """ + def Reset(self,) -> 'None': + """ Resets the enumeration sequence to the beginning. Args: @@ -20363,14 +19375,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Clone(self,) -> 'Any': - """ - Creates another + def Clone(self,) -> 'Any': + """ + Creates another enumerator that contains the same enumeration state as the current one @@ -20381,21 +19392,20 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIEnumRemoteDebugApplications(object): - """A Python interface to IEnumRemoteDebugApplications""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIEnumRemoteDebugApplications(object): + """A Python interface to IEnumRemoteDebugApplications""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Next(self,num:'Any'=1) -> 'Any': - """ - Retrieves a specified number of items in the enumeration + def Next(self, num: 'Any' = 1) -> 'Any': + """ + Retrieves a specified number of items in the enumeration sequence. @@ -20406,13 +19416,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Skip(self,) -> 'None': - """ + def Skip(self,) -> 'None': + """ Skips over the next specified elementes. Args: @@ -20422,13 +19431,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Reset(self,) -> 'None': - """ + def Reset(self,) -> 'None': + """ Resets the enumeration sequence to the beginning. Args: @@ -20438,14 +19446,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Clone(self,) -> 'Any': - """ - Creates another enumerator that + def Clone(self,) -> 'Any': + """ + Creates another enumerator that contains the same enumeration state as the current one @@ -20456,20 +19463,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIEnumResources(object): - """A Python interface to IEnumResources""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIEnumResources(object): + """A Python interface to IEnumResources""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Next(self,num:'Any'=1) -> 'Any': - """ + def Next(self, num: 'Any' = 1) -> 'Any': + """ Retrieves a specified number of items in the enumeration sequence. Args: @@ -20479,13 +19485,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Skip(self,) -> 'None': - """ + def Skip(self,) -> 'None': + """ Skips over the next specified elementes. Args: @@ -20495,13 +19500,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Reset(self,) -> 'None': - """ + def Reset(self,) -> 'None': + """ Resets the enumeration sequence to the beginning. Args: @@ -20511,14 +19515,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same enumeration + def Clone(self,) -> 'Any': + """ + Creates another enumerator that contains the same enumeration state as the current one @@ -20529,20 +19532,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIEnumSTATPROPSETSTG(object): - """A Python interface to IEnumSTATPROPSETSTG""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIEnumSTATPROPSETSTG(object): + """A Python interface to IEnumSTATPROPSETSTG""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Next(self,num:'Any'=1) -> 'Any': - """ + def Next(self, num: 'Any' = 1) -> 'Any': + """ Retrieves a specified number of items in the enumeration sequence. Args: @@ -20552,13 +19554,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Skip(self,) -> 'None': - """ + def Skip(self,) -> 'None': + """ Skips over the next specified elementes. Args: @@ -20568,13 +19569,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Reset(self,) -> 'None': - """ + def Reset(self,) -> 'None': + """ Resets the enumeration sequence to the beginning. Args: @@ -20584,14 +19584,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same + def Clone(self,) -> 'Any': + """ + Creates another enumerator that contains the same enumeration state as the current one @@ -20602,20 +19601,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIEnumSTATPROPSTG(object): - """A Python interface to IEnumSTATPROPSTG""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIEnumSTATPROPSTG(object): + """A Python interface to IEnumSTATPROPSTG""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Next(self,num:'Any'=1) -> 'Any': - """ + def Next(self, num: 'Any' = 1) -> 'Any': + """ Retrieves a specified number of items in the enumeration sequence. Args: @@ -20625,13 +19623,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Skip(self,) -> 'None': - """ + def Skip(self,) -> 'None': + """ Skips over the next specified elementes. Args: @@ -20641,13 +19638,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Reset(self,) -> 'None': - """ + def Reset(self,) -> 'None': + """ Resets the enumeration sequence to the beginning. Args: @@ -20657,14 +19653,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same + def Clone(self,) -> 'Any': + """ + Creates another enumerator that contains the same enumeration state as the current one @@ -20675,20 +19670,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIEnumSTATSTG(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIEnumSTATSTG(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Next(self,num:'Any'=1) -> 'Tuple[Any, ...]': - """ + def Next(self, num: 'Any' = 1) -> 'Tuple[Any, ...]': + """ Retrieves a specified number of items in the enumeration sequence. Args: @@ -20698,13 +19692,12 @@ Args: Returns: Tuple[Any, ...] - - """ - pass + """ + pass - def Skip(self,) -> 'None': - """ + def Skip(self,) -> 'None': + """ Skips over the next specified elementes. Args: @@ -20714,13 +19707,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Reset(self,) -> 'None': - """ + def Reset(self,) -> 'None': + """ Resets the enumeration sequence to the beginning. Args: @@ -20730,14 +19722,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same enumeration state + def Clone(self,) -> 'Any': + """ + Creates another enumerator that contains the same enumeration state as the current one @@ -20748,21 +19739,20 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIEnumShellItems(object): - """A Python interface to IEnumShellItems""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIEnumShellItems(object): + """A Python interface to IEnumShellItems""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Next(self,num:'Any'=1) -> 'Tuple[Any, ...]': - """ - Retrieves a specified number of items in the enumeration + def Next(self, num: 'Any' = 1) -> 'Tuple[Any, ...]': + """ + Retrieves a specified number of items in the enumeration sequence. @@ -20773,13 +19763,12 @@ Args: Returns: Tuple[Any, ...] - - """ - pass + """ + pass - def Skip(self,) -> 'None': - """ + def Skip(self,) -> 'None': + """ Skips over the next specified elementes. Args: @@ -20789,13 +19778,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Reset(self,) -> 'None': - """ + def Reset(self,) -> 'None': + """ Resets the enumeration sequence to the beginning. Args: @@ -20805,14 +19793,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same enumeration + def Clone(self,) -> 'Any': + """ + Creates another enumerator that contains the same enumeration state as the current one @@ -20823,20 +19810,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIEnumString(object): - """An enumerator interface to list strings""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIEnumString(object): + """An enumerator interface to list strings""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Next(self,num:'Any'=1) -> 'Tuple[str, ...]': - """ + def Next(self, num: 'Any' = 1) -> 'Tuple[str, ...]': + """ Retrieves a specified number of items in the enumeration sequence. Args: @@ -20846,13 +19832,12 @@ Args: Returns: Tuple[str, ...] - - """ - pass + """ + pass - def Skip(self,) -> 'None': - """ + def Skip(self,) -> 'None': + """ Skips over the next specified elementes. Args: @@ -20862,13 +19847,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Reset(self,) -> 'None': - """ + def Reset(self,) -> 'None': + """ Resets the enumeration sequence to the beginning. Args: @@ -20878,14 +19862,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same enumeration state + def Clone(self,) -> 'Any': + """ + Creates another enumerator that contains the same enumeration state as the current one @@ -20896,20 +19879,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIErrorLog(object): - """A Python wrapper for a COM IErrorLog interface.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIErrorLog(object): + """A Python wrapper for a COM IErrorLog interface.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def AddError(self,propName:'str',excepInfo:'Any'=None) -> 'None': - """ + def AddError(self, propName: 'str', excepInfo: 'Any' = None) -> 'None': + """ Adds an error to the error log. Args: @@ -20920,20 +19902,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIExplorerBrowser(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIExplorerBrowser(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Initialize(self,hwndParent:'Any',prc:'PyRECT',pfs:'Any') -> 'None': - """ + def Initialize(self, hwndParent: 'Any', prc: 'PyRECT', pfs: 'Any') -> 'None': + """ Description of Initialize. Args: @@ -20945,13 +19926,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Destroy(self,) -> 'None': - """ + def Destroy(self,) -> 'None': + """ Description of Destroy. Args: @@ -20961,13 +19941,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetRect(self,hdwp:'Any',rcBrowser:'PyRECT') -> 'int': - """ + def SetRect(self, hdwp: 'Any', rcBrowser: 'PyRECT') -> 'int': + """ Description of SetRect. Args: @@ -20978,13 +19957,12 @@ Args: Returns: int - - """ - pass + """ + pass - def SetPropertyBag(self,PropertyBag:'Any') -> 'None': - """ + def SetPropertyBag(self, PropertyBag: 'Any') -> 'None': + """ Description of SetPropertyBag. Args: @@ -20994,13 +19972,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetEmptyText(self,EmptyText:'Any') -> 'None': - """ + def SetEmptyText(self, EmptyText: 'Any') -> 'None': + """ Description of SetEmptyText. Args: @@ -21010,13 +19987,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetFolderSettings(self,pfs:'Any') -> 'None': - """ + def SetFolderSettings(self, pfs: 'Any') -> 'None': + """ Description of SetFolderSettings. Args: @@ -21026,13 +20002,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Advise(self,psbe:'Any') -> 'Any': - """ + def Advise(self, psbe: 'Any') -> 'Any': + """ Description of Advise. Args: @@ -21042,13 +20017,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Unadvise(self,dwCookie:'Any') -> 'None': - """ + def Unadvise(self, dwCookie: 'Any') -> 'None': + """ Description of Unadvise. Args: @@ -21058,13 +20032,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetOptions(self,dwFlag:'Any') -> 'None': - """ + def SetOptions(self, dwFlag: 'Any') -> 'None': + """ Description of SetOptions. Args: @@ -21074,13 +20047,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetOptions(self,) -> 'Any': - """ + def GetOptions(self,) -> 'Any': + """ Description of GetOptions. Args: @@ -21090,13 +20062,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def BrowseToIDList(self,pidl:'Any',uFlags:'Any') -> 'None': - """ + def BrowseToIDList(self, pidl: 'Any', uFlags: 'Any') -> 'None': + """ Description of BrowseToIDList. Args: @@ -21107,13 +20078,12 @@ Args: Returns: None - - """ - pass + """ + pass - def BrowseToObject(self,punk:'Any',uFlags:'Any') -> 'None': - """ + def BrowseToObject(self, punk: 'Any', uFlags: 'Any') -> 'None': + """ Description of BrowseToObject. Args: @@ -21124,13 +20094,12 @@ Args: Returns: None - - """ - pass + """ + pass - def FillFromObject(self,punk:'Any',dwFlags:'Any') -> 'None': - """ + def FillFromObject(self, punk: 'Any', dwFlags: 'Any') -> 'None': + """ Description of FillFromObject. Args: @@ -21141,13 +20110,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RemoveAll(self,) -> 'None': - """ + def RemoveAll(self,) -> 'None': + """ Description of RemoveAll. Args: @@ -21157,13 +20125,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetCurrentView(self,riid:'PyIID') -> 'Any': - """ + def GetCurrentView(self, riid: 'PyIID') -> 'Any': + """ Description of GetCurrentView. Args: @@ -21173,20 +20140,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIExplorerBrowserEvents(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIExplorerBrowserEvents(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def OnNavigationPending(self,pidlFolder:'Any') -> 'None': - """ + def OnNavigationPending(self, pidlFolder: 'Any') -> 'None': + """ Description of OnNavigationPending. Args: @@ -21196,13 +20162,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnViewCreated(self,psv:'Any') -> 'None': - """ + def OnViewCreated(self, psv: 'Any') -> 'None': + """ Description of OnViewCreated. Args: @@ -21212,13 +20177,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnNavigationComplete(self,pidlFolder:'Any') -> 'None': - """ + def OnNavigationComplete(self, pidlFolder: 'Any') -> 'None': + """ Description of OnNavigationComplete. Args: @@ -21228,13 +20192,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnNavigationFailed(self,pidlFolder:'Any') -> 'None': - """ + def OnNavigationFailed(self, pidlFolder: 'Any') -> 'None': + """ Description of OnNavigationFailed. Args: @@ -21244,20 +20207,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIExplorerCommand(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIExplorerCommand(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetTitle(self,psiItemArray:'Any') -> 'Any': - """ + def GetTitle(self, psiItemArray: 'Any') -> 'Any': + """ Description of GetTitle. Args: @@ -21267,13 +20229,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetIcon(self,psiItemArray:'Any') -> 'Any': - """ + def GetIcon(self, psiItemArray: 'Any') -> 'Any': + """ Description of GetIcon. Args: @@ -21283,13 +20244,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetToolTip(self,psiItemArray:'Any') -> 'Any': - """ + def GetToolTip(self, psiItemArray: 'Any') -> 'Any': + """ Description of GetToolTip. Args: @@ -21299,13 +20259,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetCanonicalName(self,) -> 'PyIID': - """ + def GetCanonicalName(self,) -> 'PyIID': + """ Description of GetCanonicalName. Args: @@ -21315,13 +20274,12 @@ Args: Returns: PyIID - - """ - pass + """ + pass - def GetState(self,psiItemArray:'Any',fOkToBeSlow:'Any') -> 'Any': - """ + def GetState(self, psiItemArray: 'Any', fOkToBeSlow: 'Any') -> 'Any': + """ Description of GetState. Args: @@ -21332,13 +20290,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Invoke(self,psiItemArray:'Any',pbc:'Any') -> 'None': - """ + def Invoke(self, psiItemArray: 'Any', pbc: 'Any') -> 'None': + """ Description of Invoke. Args: @@ -21349,13 +20306,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetFlags(self,) -> 'Any': - """ + def GetFlags(self,) -> 'Any': + """ Description of GetFlags. Args: @@ -21365,13 +20321,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def EnumSubCommands(self,) -> 'Any': - """ + def EnumSubCommands(self,) -> 'Any': + """ Description of EnumSubCommands. Args: @@ -21381,35 +20336,34 @@ Args: Returns: Any - - """ - pass + + """ + pass class PyIExplorerCommandProvider(object): - """This is a gateway only interface.""" + """This is a gateway only interface.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyIExplorerPaneVisibility(object): - """Description of the interface""" + """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyIExternalConnection(object): - """A Python wrapper for a COM IExternalConnection interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """A Python wrapper for a COM IExternalConnection interface.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def AddConnection(self,extconn:'Any',reserved:'Any'=0) -> 'Any': - """ - Increments an object's count of its strong external connections + def AddConnection(self, extconn: 'Any', reserved: 'Any' = 0) -> 'Any': + """ + Increments an object's count of its strong external connections (links). @@ -21423,14 +20377,13 @@ Returns: Any:A reserved parameter Return ValueThe result is the number of reference counts on the object; used for debugging purposes only. - - """ - pass + """ + pass - def ReleaseConnection(self,extconn:'Any',reserved:'Any',fLastReleaseCloses:'Any') -> 'Any': - """ - Decrements an object's count of its strong external connections + def ReleaseConnection(self, extconn: 'Any', reserved: 'Any', fLastReleaseCloses: 'Any') -> 'Any': + """ + Decrements an object's count of its strong external connections (references). @@ -21442,26 +20395,25 @@ Args: Returns: - Any:TRUE specifies that if the connection being released is the last external lock on + 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 + """ + pass -class PyIExtractIcon(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIExtractIcon(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Extract(self,pszFile:'Any',nIconIndex:'Any',nIconSize:'Any') -> 'None': - """ + def Extract(self, pszFile: 'Any', nIconIndex: 'Any', nIconSize: 'Any') -> 'None': + """ Description of Extract. Args: @@ -21472,19 +20424,18 @@ 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 + """ + pass - def GetIconLocation(self,uFlags:'Any',cchMax:'Any') -> 'None': - """ + def GetIconLocation(self, uFlags: 'Any', cchMax: 'Any') -> 'None': + """ Description of GetIconLocation. Args: @@ -21495,20 +20446,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIExtractIconW(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIExtractIconW(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Extract(self,pszFile:'Any',nIconIndex:'Any',nIconSize:'Any') -> 'None': - """ + def Extract(self, pszFile: 'Any', nIconIndex: 'Any', nIconSize: 'Any') -> 'None': + """ Description of Extract. Args: @@ -21519,19 +20469,18 @@ 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 + """ + pass - def GetIconLocation(self,uFlags:'Any',cchMax:'Any') -> 'None': - """ + def GetIconLocation(self, uFlags: 'Any', cchMax: 'Any') -> 'None': + """ Description of GetIconLocation. Args: @@ -21542,20 +20491,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIExtractImage(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIExtractImage(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetLocation(self,dwPriority:'Any',size:'Tuple[Any, Any]',dwRecClrDepth:'Any',pdwFlags:'Any') -> 'None': - """ + def GetLocation(self, dwPriority: 'Any', size: 'Tuple[Any, Any]', dwRecClrDepth: 'Any', pdwFlags: 'Any') -> 'None': + """ Description of GetLocation. Args: @@ -21568,13 +20516,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Extract(self,) -> 'None': - """ + def Extract(self,) -> 'None': + """ Description of Extract. Args: @@ -21584,20 +20531,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIFileOperation(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIFileOperation(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Advise(self,Sink:'Any') -> 'Any': - """ + def Advise(self, Sink: 'Any') -> 'Any': + """ Connects an event sink to receive updates Args: @@ -21608,13 +20554,12 @@ Returns: Any:Interface that receives progress updatesReturn ValueReturns a cookie to be passed to PyIFileOperation::Unadvise to disconnect - - """ - pass + """ + pass - def Unadvise(self,Cookie:'Any') -> 'None': - """ + def Unadvise(self, Cookie: 'Any') -> 'None': + """ Disconnects a progress sink Args: @@ -21624,13 +20569,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetOperationFlags(self,OperationFlags:'Any') -> 'None': - """ + def SetOperationFlags(self, OperationFlags: 'Any') -> 'None': + """ Sets option flags for the operation Args: @@ -21640,13 +20584,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetProgressMessage(self,Message:'Any') -> 'None': - """ + def SetProgressMessage(self, Message: 'Any') -> 'None': + """ Not implemented. Args: @@ -21656,13 +20599,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetProgressDialog(self,popd:'Any') -> 'None': - """ + def SetProgressDialog(self, popd: 'Any') -> 'None': + """ Provides an interface used to display a progress dialog Args: @@ -21672,13 +20614,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetProperties(self,proparray:'Any') -> 'None': - """ + def SetProperties(self, proparray: 'Any') -> 'None': + """ Specifies a set of properties to be changed. Args: @@ -21688,13 +20629,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetOwnerWindow(self,Owner:'int') -> 'None': - """ + def SetOwnerWindow(self, Owner: 'int') -> 'None': + """ Sets the parent window for any UI displayed. Args: @@ -21704,13 +20644,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ApplyPropertiesToItem(self,Item:'Any') -> 'None': - """ + def ApplyPropertiesToItem(self, Item: 'Any') -> 'None': + """ Specifies the item that will receive property changes Args: @@ -21720,13 +20659,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ApplyPropertiesToItems(self,Items:'Any') -> 'None': - """ + def ApplyPropertiesToItems(self, Items: 'Any') -> 'None': + """ Specifies multiple items that will receive property changes Args: @@ -21736,13 +20674,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RenameItem(self,Item:'Any',NewName:'Any',Sink:'Any'=None) -> 'None': - """ + def RenameItem(self, Item: 'Any', NewName: 'Any', Sink: 'Any' = None) -> 'None': + """ Adds a rename to the operation sequence Args: @@ -21754,13 +20691,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RenameItems(self,pUnkItems:'Any',NewName:'Any') -> 'None': - """ + def RenameItems(self, pUnkItems: 'Any', NewName: 'Any') -> 'None': + """ Adds multiple renames to the operation sequence Args: @@ -21771,13 +20707,12 @@ Args: Returns: None - - """ - pass + """ + pass - def MoveItem(self,Item:'Any',DestinationFolder:'Any',pszNewName:'Any'=None,Sink:'Any'=None) -> 'None': - """ + def MoveItem(self, Item: 'Any', DestinationFolder: 'Any', pszNewName: 'Any' = None, Sink: 'Any' = None) -> 'None': + """ Adds a move operation to the configuration Args: @@ -21790,13 +20725,12 @@ Args: Returns: None - - """ - pass + """ + pass - def MoveItems(self,Items:'Any',DestinationFolder:'Any') -> 'None': - """ + def MoveItems(self, Items: 'Any', DestinationFolder: 'Any') -> 'None': + """ Adds multiple move operations to the configuration Args: @@ -21807,13 +20741,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CopyItem(self,Item:'Any',DestinationFolder:'Any',CopyName:'Any'=None,Sink:'Any'=None) -> 'None': - """ + def CopyItem(self, Item: 'Any', DestinationFolder: 'Any', CopyName: 'Any' = None, Sink: 'Any' = None) -> 'None': + """ Adds a copy operation to the configuration Args: @@ -21826,13 +20759,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CopyItems(self,Items:'Any',DestinationFolder:'Any') -> 'None': - """ + def CopyItems(self, Items: 'Any', DestinationFolder: 'Any') -> 'None': + """ Adds multiple copy operations to the configuration Args: @@ -21843,13 +20775,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DeleteItem(self,Item:'Any',Sink:'Any'=None) -> 'None': - """ + def DeleteItem(self, Item: 'Any', Sink: 'Any' = None) -> 'None': + """ Adds a delete operation to the configuration Args: @@ -21860,13 +20791,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DeleteItems(self,Items:'Any') -> 'None': - """ + def DeleteItems(self, Items: 'Any') -> 'None': + """ Adds multiple delete operations to the configuration Args: @@ -21876,13 +20806,18 @@ Args: Returns: None - - """ - pass + """ + pass - def NewItem(self,DestinationFolder:'Any',FileAttributes:'Any',Name:'Any',TemplateName:'Any'=None,Sink:'Any'=None) -> 'None': - """ + def NewItem( + self, + DestinationFolder: 'Any', + FileAttributes: 'Any', + Name: 'Any', + TemplateName: 'Any' = None, + Sink: 'Any' = None) -> 'None': + """ Creates a new file as part of the operation Args: @@ -21896,13 +20831,12 @@ Args: Returns: None - - """ - pass + """ + pass - def PerformOperations(self,) -> 'None': - """ + def PerformOperations(self,) -> 'None': + """ Effects all configured file system modifications Args: @@ -21912,13 +20846,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetAnyOperationsAborted(self,) -> 'Any': - """ + def GetAnyOperationsAborted(self,) -> 'Any': + """ Determines if any operations were terminated Args: @@ -21928,28 +20861,27 @@ Args: Returns: Any - - """ - pass + + """ + pass class PyIIdentityName(object): - """Description of the interface""" + """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyIInitializeWithFile(object): - """Initializes a property handler that requires a file path instead of a stream""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """Initializes a property handler that requires a file path instead of a stream""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Initialize(self,FilePath:'Any',Mode:'Any') -> 'None': - """ - Passes a file path to a property handler on startup + def Initialize(self, FilePath: 'Any', Mode: 'Any') -> 'None': + """ + passes a file path to a property handler on startup Args: @@ -21959,20 +20891,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIInitializeWithStream(object): - """Interface that initializes a handler capable of reading properties from a stream""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIInitializeWithStream(object): + """Interface that initializes a handler capable of reading properties from a stream""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Initialize(self,Stream:'Any',Mode:'Any') -> 'None': - """ + def Initialize(self, Stream: 'Any', Mode: 'Any') -> 'None': + """ Initializes a property handler with a stream Args: @@ -21983,20 +20914,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIInputObject(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIInputObject(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def TranslateAccelerator(self,pmsg:'Any') -> 'None': - """ + def TranslateAccelerator(self, pmsg: 'Any') -> 'None': + """ Description of TranslateAccelerator. Args: @@ -22006,13 +20936,12 @@ Args: Returns: None - - """ - pass + """ + pass - def UIActivate(self,uState:'Any') -> 'None': - """ + def UIActivate(self, uState: 'Any') -> 'None': + """ Description of UIActivate. Args: @@ -22022,13 +20951,12 @@ Args: Returns: None - - """ - pass + """ + pass - def HasFocusIO(self,) -> 'None': - """ + def HasFocusIO(self,) -> 'None': + """ Description of Refresh. Args: @@ -22038,20 +20966,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIInternetBindInfo(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIInternetBindInfo(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetBindInfo(self,) -> 'None': - """ + def GetBindInfo(self,) -> 'None': + """ Description of GetBindInfo. Args: @@ -22061,13 +20988,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetBindString(self,) -> 'None': - """ + def GetBindString(self,) -> 'None': + """ Description of GetBindString. Args: @@ -22077,20 +21003,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIInternetPriority(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIInternetPriority(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def SetPriority(self,nPriority:'Any') -> 'None': - """ + def SetPriority(self, nPriority: 'Any') -> 'None': + """ Description of SetPriority. Args: @@ -22100,13 +21025,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetPriority(self,) -> 'None': - """ + def GetPriority(self,) -> 'None': + """ Description of GetPriority. Args: @@ -22116,20 +21040,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIInternetProtocol(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIInternetProtocol(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Read(self,cb:'Any') -> 'None': - """ + def Read(self, cb: 'Any') -> 'None': + """ Description of Read. Args: @@ -22139,13 +21062,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Seek(self,dlibMove:'LARGE_INTEGER',dwOrigin:'Any') -> 'None': - """ + def Seek(self, dlibMove: 'LARGE_INTEGER', dwOrigin: 'Any') -> 'None': + """ Description of Seek. Args: @@ -22156,13 +21078,12 @@ Args: Returns: None - - """ - pass + """ + pass - def LockRequest(self,dwOptions:'Any') -> 'None': - """ + def LockRequest(self, dwOptions: 'Any') -> 'None': + """ Description of LockRequest. Args: @@ -22172,13 +21093,12 @@ Args: Returns: None - - """ - pass + """ + pass - def UnlockRequest(self,) -> 'None': - """ + def UnlockRequest(self,) -> 'None': + """ Description of UnlockRequest. Args: @@ -22188,20 +21108,25 @@ Args: Returns: None - - """ - pass - - -class PyIInternetProtocolInfo(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """ + pass - def ParseUrl(self,pwzUrl:'Any',ParseAction:'Any',dwParseFlags:'Any',cchResult:'Any',dwReserved:'Any') -> 'None': - """ +class PyIInternetProtocolInfo(object): + """Description of the interface""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + def ParseUrl( + self, + pwzUrl: 'Any', + ParseAction: 'Any', + dwParseFlags: 'Any', + cchResult: 'Any', + dwReserved: 'Any') -> 'None': + """ Description of ParseUrl. Args: @@ -22215,13 +21140,18 @@ Args: Returns: None - - """ - pass + """ + pass - def CombineUrl(self,pwzBaseUrl:'Any',pwzRelativeUrl:'Any',dwCombineFlags:'Any',cchResult:'Any',dwReserved:'Any') -> 'None': - """ + def CombineUrl( + self, + pwzBaseUrl: 'Any', + pwzRelativeUrl: 'Any', + dwCombineFlags: 'Any', + cchResult: 'Any', + dwReserved: 'Any') -> 'None': + """ Description of CombineUrl. Args: @@ -22235,13 +21165,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CompareUrl(self,pwzUrl1:'Any',pwzUrl2:'Any',dwCompareFlags:'Any') -> 'None': - """ + def CompareUrl(self, pwzUrl1: 'Any', pwzUrl2: 'Any', dwCompareFlags: 'Any') -> 'None': + """ Description of CompareUrl. Args: @@ -22253,13 +21182,18 @@ Args: Returns: None - - """ - pass + """ + pass - def QueryInfo(self,pwzUrl:'Any',OueryOption:'Any',dwQueryFlags:'Any',cbBuffer:'Any',dwReserved:'Any') -> 'Any': - """ + def QueryInfo( + self, + pwzUrl: 'Any', + OueryOption: 'Any', + dwQueryFlags: 'Any', + cbBuffer: 'Any', + dwReserved: 'Any') -> 'Any': + """ Description of QueryInfo. Args: @@ -22273,20 +21207,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIInternetProtocolRoot(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIInternetProtocolRoot(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Start(self,szUrl:'Any',pOIProtSink:'Any',pOIBindInfo:'Any',grfPI:'Any',dwReserved:'Any') -> 'None': - """ + def Start(self, szUrl: 'Any', pOIProtSink: 'Any', pOIBindInfo: 'Any', grfPI: 'Any', dwReserved: 'Any') -> 'None': + """ Description of Start. Args: @@ -22300,13 +21233,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Continue(self,) -> 'None': - """ + def Continue(self,) -> 'None': + """ Description of Continue. Args: @@ -22316,13 +21248,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Abort(self,hrReason:'Any',dwOptions:'Any') -> 'None': - """ + def Abort(self, hrReason: 'Any', dwOptions: 'Any') -> 'None': + """ Description of Abort. Args: @@ -22333,13 +21264,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Terminate(self,dwOptions:'Any') -> 'None': - """ + def Terminate(self, dwOptions: 'Any') -> 'None': + """ Description of Terminate. Args: @@ -22349,13 +21279,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Suspend(self,) -> 'None': - """ + def Suspend(self,) -> 'None': + """ Description of Suspend. Args: @@ -22365,13 +21294,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Resume(self,) -> 'None': - """ + def Resume(self,) -> 'None': + """ Description of Resume. Args: @@ -22381,20 +21309,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIInternetProtocolSink(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIInternetProtocolSink(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Switch(self,) -> 'None': - """ + def Switch(self,) -> 'None': + """ Description of Switch. Args: @@ -22404,13 +21331,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ReportProgress(self,ulStatusCode:'Any',szStatusText:'Any') -> 'None': - """ + def ReportProgress(self, ulStatusCode: 'Any', szStatusText: 'Any') -> 'None': + """ Description of ReportProgress. Args: @@ -22421,13 +21347,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ReportData(self,grfBSCF:'Any',ulProgress:'Any',ulProgressMax:'Any') -> 'None': - """ + def ReportData(self, grfBSCF: 'Any', ulProgress: 'Any', ulProgressMax: 'Any') -> 'None': + """ Description of ReportData. Args: @@ -22439,13 +21364,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ReportResult(self,hrResult:'Any',dwError:'Any',szResult:'Any') -> 'None': - """ + def ReportResult(self, hrResult: 'Any', dwError: 'Any', szResult: 'Any') -> 'None': + """ Description of ReportResult. Args: @@ -22457,20 +21381,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIInternetSecurityManager(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIInternetSecurityManager(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def SetSecuritySite(self,pSite:'Any') -> 'None': - """ + def SetSecuritySite(self, pSite: 'Any') -> 'None': + """ Description of SetSecuritySite. Args: @@ -22480,13 +21403,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetSecuritySite(self,) -> 'None': - """ + def GetSecuritySite(self,) -> 'None': + """ Description of GetSecuritySite. Args: @@ -22496,13 +21418,12 @@ Args: Returns: None - - """ - pass + """ + pass - def MapUrlToZone(self,pwszUrl:'Any',dwFlags:'Any') -> 'None': - """ + def MapUrlToZone(self, pwszUrl: 'Any', dwFlags: 'Any') -> 'None': + """ Description of MapUrlToZone. Args: @@ -22513,13 +21434,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetSecurityId(self,pwszUrl:'Any',pcbSecurityId:'Any') -> 'None': - """ + def GetSecurityId(self, pwszUrl: 'Any', pcbSecurityId: 'Any') -> 'None': + """ Description of GetSecurityId. Args: @@ -22530,13 +21450,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ProcessUrlAction(self,pwszUrl:'Any',dwAction:'Any',context:'Any',dwFlags:'Any') -> 'None': - """ + def ProcessUrlAction(self, pwszUrl: 'Any', dwAction: 'Any', context: 'Any', dwFlags: 'Any') -> 'None': + """ Description of ProcessUrlAction. Args: @@ -22549,13 +21468,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetZoneMapping(self,dwZone:'Any',lpszPattern:'Any',dwFlags:'Any') -> 'None': - """ + def SetZoneMapping(self, dwZone: 'Any', lpszPattern: 'Any', dwFlags: 'Any') -> 'None': + """ Description of SetZoneMapping. Args: @@ -22567,13 +21485,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetZoneMappings(self,dwZone:'Any',dwFlags:'Any') -> 'None': - """ + def GetZoneMappings(self, dwZone: 'Any', dwFlags: 'Any') -> 'None': + """ Description of GetZoneMappings. Args: @@ -22584,24 +21501,23 @@ Args: Returns: None - - """ - pass + + """ + 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.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetId(self,) -> 'PyIID': - """ + def GetId(self,) -> 'PyIID': + """ Returns the id of the folder Args: @@ -22611,13 +21527,12 @@ Args: Returns: PyIID - - """ - pass + """ + pass - def GetCategory(self,) -> 'Any': - """ + def GetCategory(self,) -> 'Any': + """ Returns the category for a folder (shellcon.KF_CATEGORY_*) Args: @@ -22627,13 +21542,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetShellItem(self,riid:'PyIID',Flags:'Any'=0) -> 'Any': - """ + def GetShellItem(self, riid: 'PyIID', Flags: 'Any' = 0) -> 'Any': + """ Returns a shell interface for the folder Args: @@ -22644,13 +21558,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetPath(self,Flags:'Any'=0) -> 'Any': - """ + def GetPath(self, Flags: 'Any' = 0) -> 'Any': + """ Returns the path to the folder Args: @@ -22660,13 +21573,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetPath(self,Flags:'Any',Path:'Any') -> 'None': - """ + def SetPath(self, Flags: 'Any', Path: 'Any') -> 'None': + """ Changes the location of the folder Args: @@ -22677,13 +21589,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetIDList(self,Flags:'Any') -> 'Any': - """ + def GetIDList(self, Flags: 'Any') -> 'Any': + """ Returns the folder's location as an item id list. Args: @@ -22693,13 +21604,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetFolderType(self,) -> 'PyIID': - """ + def GetFolderType(self,) -> 'PyIID': + """ Returns the type of the folder Args: @@ -22712,13 +21622,12 @@ Returns: PyIID = GetFolderType()Returns the type of the folder Return ValueReturns a folder type guid (shell.FOLDERTYPEID_*) - - """ - pass + """ + pass - def GetRedirectionCapabilities(self,) -> 'Any': - """ + def GetRedirectionCapabilities(self,) -> 'Any': + """ Returns flags indicating how the folder can be redirected Args: @@ -22732,13 +21641,12 @@ Returns: int = GetRedirectionCapabilities()Returns flags indicating how the folder can be redirected Return ValueCombination of shellcon.KF_REDIRECTION_CAPABILITIES_* flags - - """ - pass + """ + pass - def GetFolderDefinition(self,) -> 'Any': - """ + def GetFolderDefinition(self,) -> 'Any': + """ Retrieves detailed information about a known folder Args: @@ -22752,20 +21660,19 @@ Returns: dict = GetFolderDefinition()Retrieves detailed information about a known folder Return ValueReturns a dict containing info from a KNOWNFOLDER_DEFINITION struct - - """ - pass + """ + pass -class PyIKnownFolderManager(object): - """Interface used to manage known folder definitions.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIKnownFolderManager(object): + """Interface used to manage known folder definitions.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def FolderIdFromCsidl(self,Csidl:'Any') -> 'PyIID': - """ + def FolderIdFromCsidl(self, Csidl: 'Any') -> 'PyIID': + """ Returns the folder id that corresponds to a CSIDL Args: @@ -22775,13 +21682,12 @@ Args: Returns: PyIID - - """ - pass + """ + pass - def FolderIdToCsidl(self,_id:'PyIID') -> 'Any': - """ + def FolderIdToCsidl(self, _id: 'PyIID') -> 'Any': + """ Returns the CSIDL equivalent of a known folder Args: @@ -22791,13 +21697,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetFolderIds(self,) -> 'Tuple[PyIID, ...]': - """ + def GetFolderIds(self,) -> 'Tuple[PyIID, ...]': + """ Retrieves all known folder ids. Args: @@ -22807,13 +21712,12 @@ Args: Returns: Tuple[PyIID, ...] - - """ - pass + """ + pass - def GetFolder(self,_id:'PyIID') -> 'Any': - """ + def GetFolder(self, _id: 'PyIID') -> 'Any': + """ Returns a folder by its id. Args: @@ -22823,13 +21727,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetFolderByName(self,Name:'Any') -> 'Any': - """ + def GetFolderByName(self, Name: 'Any') -> 'Any': + """ Returns a folder by canonical name Args: @@ -22839,30 +21742,28 @@ Args: Returns: Any - - """ - pass + """ + pass - def RegisterFolder(self,_id:'PyIID',Definition:'Any') -> 'None': - """ - Defines a new known folder + def RegisterFolder(self, _id: 'PyIID', Definition: 'Any') -> 'None': + """ + defines a new known folder Args: _id(PyIID):GUID used to identify the new known folder - Definition(Any):Dictionary containing info to be placed in a KNOWNFOLDER_DEFINITION structCommentsPyIKnownFolder::GetFolderDefinition can be used to get a template dictionary + definition(Any):Dictionary containing info to be placed in a KNOWNFOLDER_DEFINITION structCommentsPyIKnownFolder::GetFolderDefinition can be used to get a template dictionary Returns: None - - """ - pass + """ + pass - def UnregisterFolder(self,_id:'PyIID') -> 'None': - """ + def UnregisterFolder(self, _id: 'PyIID') -> 'None': + """ Removes the definition of a known folder Args: @@ -22872,13 +21773,12 @@ Args: Returns: None - - """ - pass + """ + pass - def FindFolderFromPath(self,Path:'Any',Mode:'Any') -> 'Any': - """ + def FindFolderFromPath(self, Path: 'Any', Mode: 'Any') -> 'Any': + """ Retrieves a known folder by path Args: @@ -22889,14 +21789,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def FindFolderFromIDList(self,pidl:'Any') -> 'Any': - """ - Retrieves a known folder using its item id + def FindFolderFromIDList(self, pidl: 'Any') -> 'Any': + """ + Retrieves a known folder using its item id list. @@ -22907,13 +21806,18 @@ Args: Returns: Any - - """ - pass + """ + pass - def Redirect(self,_id:'PyIID',hwnd:'int',flags:'Any',TargetPath:'Any',Exclusion:'Tuple[PyIID, ...]') -> 'None': - """ + def Redirect( + self, + _id: 'PyIID', + hwnd: 'int', + flags: 'Any', + TargetPath: 'Any', + Exclusion: 'Tuple[PyIID, ...]') -> 'None': + """ Redirects a known folder to an alternate location Args: @@ -22927,21 +21831,20 @@ Args: Returns: None - - """ - pass + """ + pass -class PyILockBytes(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyILockBytes(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def ReadAt(self,ulOffset:'ULARGE_INTEGER',cb:'Any') -> 'str': - """ - Reads a specified number of bytes starting at a specified offset from the + def ReadAt(self, ulOffset: 'ULARGE_INTEGER', cb: 'Any') -> 'str': + """ + Reads a specified number of bytes starting at a specified offset from the beginning of the byte array object. @@ -22953,14 +21856,13 @@ Args: Returns: str - - """ - pass + """ + pass - def WriteAt(self,ulOffset:'ULARGE_INTEGER',data:'str') -> 'Any': - """ - Writes the specified number of bytes starting at a specified offset from the + def WriteAt(self, ulOffset: 'ULARGE_INTEGER', data: 'str') -> 'Any': + """ + Writes the specified number of bytes starting at a specified offset from the beginning of the byte array. @@ -22973,14 +21875,13 @@ Returns: Any:Data to writeReturn ValueThe result is the number of bytes actually written. - - """ - pass + """ + pass - def Flush(self,) -> 'None': - """ - Ensures that any internal buffers maintained by the byte array object are written out + def Flush(self,) -> 'None': + """ + Ensures that any internal buffers maintained by the byte array object are written out to the backing storage. @@ -22991,13 +21892,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetSize(self,cb:'ULARGE_INTEGER') -> 'None': - """ + def SetSize(self, cb: 'ULARGE_INTEGER') -> 'None': + """ Changes the size of the byte array. Args: @@ -23007,13 +21907,12 @@ Args: Returns: None - - """ - pass + """ + pass - def LockRegion(self,libOffset:'ULARGE_INTEGER',cb:'ULARGE_INTEGER',dwLockType:'Any') -> 'None': - """ + def LockRegion(self, libOffset: 'ULARGE_INTEGER', cb: 'ULARGE_INTEGER', dwLockType: 'Any') -> 'None': + """ Restricts access to a specified range of bytes in the byte array. Args: @@ -23025,13 +21924,12 @@ Args: Returns: None - - """ - pass + """ + pass - def UnlockRegion(self,libOffset:'ULARGE_INTEGER',cb:'ULARGE_INTEGER',dwLockType:'Any') -> 'None': - """ + def UnlockRegion(self, libOffset: 'ULARGE_INTEGER', cb: 'ULARGE_INTEGER', dwLockType: 'Any') -> 'None': + """ None Args: @@ -23043,13 +21941,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Stat(self,grfStatFlag:'Any') -> 'Any': - """ + def Stat(self, grfStatFlag: 'Any') -> 'Any': + """ None Args: @@ -23059,20 +21956,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIMAPIContainer(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIMAPIContainer(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def OpenEntry(self,entryId:'str',iid:'PyIID',flags:'Any') -> 'Any': - """ + def OpenEntry(self, entryId: 'str', iid: 'PyIID', flags: 'Any') -> 'Any': + """ Opens an object and returns an interface object for further access. Args: @@ -23084,13 +21980,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetContentsTable(self,flags:'Any') -> 'Any': - """ + def GetContentsTable(self, flags: 'Any') -> 'Any': + """ Returns an object representing the container's contents table. Args: @@ -23100,13 +21995,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetHierarchyTable(self,flags:'Any') -> 'Any': - """ + def GetHierarchyTable(self, flags: 'Any') -> 'Any': + """ Returns an object representing the container's hierarchy table. Args: @@ -23116,20 +22010,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIMAPIFolder(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIMAPIFolder(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetLastError(self,hr:'Any',flags:'Any') -> 'Any': - """ + def GetLastError(self, hr: 'Any', flags: 'Any') -> 'Any': + """ Returns the last error code for the object. Args: @@ -23140,13 +22033,18 @@ Args: Returns: Any - - """ - pass + """ + pass - def CreateFolder(self,folderType:'Any',folderName:'str',folderComment:'str'=None,iid:'PyIID'=None,flags:'Any'=0) -> 'Any': - """ + def CreateFolder( + self, + folderType: 'Any', + folderName: 'str', + folderComment: 'str' = None, + iid: 'PyIID' = None, + flags: 'Any' = 0) -> 'Any': + """ Creates a folder object. Args: @@ -23160,13 +22058,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def CreateMessage(self,iid:'PyIID',flags:'Any') -> 'Any': - """ + def CreateMessage(self, iid: 'PyIID', flags: 'Any') -> 'Any': + """ Creates a message in a folder Args: @@ -23177,13 +22074,19 @@ Args: Returns: Any - - """ - pass + """ + pass - def CopyMessages(self,msgs:'Any',iid:'PyIID',folder:'Any',ulUIParam:'Any',progress:'Any',flags:'Any') -> 'Any': - """ + def CopyMessages( + self, + msgs: 'Any', + iid: 'PyIID', + folder: 'Any', + ulUIParam: 'Any', + progress: 'Any', + flags: 'Any') -> 'Any': + """ Copies the specified messages Args: @@ -23198,13 +22101,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def DeleteFolder(self,entryId:'str',uiParam:'Any',progress:'Any') -> 'None': - """ + def DeleteFolder(self, entryId: 'str', uiParam: 'Any', progress: 'Any') -> 'None': + """ Deletes a subfolder. Args: @@ -23216,13 +22118,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DeleteMessages(self,msgs:'Any',uiParam:'Any',progress:'Any',flags:'Any') -> 'Any': - """ + def DeleteMessages(self, msgs: 'Any', uiParam: 'Any', progress: 'Any', flags: 'Any') -> 'Any': + """ Deletes the specified messages. Args: @@ -23235,13 +22136,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def EmptyFolder(self,uiParam:'Any',progress:'Any',flags:'Any') -> 'Any': - """ + def EmptyFolder(self, uiParam: 'Any', progress: 'Any', flags: 'Any') -> 'Any': + """ deletes all messages and subfolders from a folder without deleting the folder itself. Args: @@ -23253,13 +22153,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetReadFlags(self,msgs:'Any',uiParam:'Any',progress:'Any',flag:'Any') -> 'None': - """ + def SetReadFlags(self, msgs: 'Any', uiParam: 'Any', progress: 'Any', flag: 'Any') -> 'None': + """ Sets or clears the MSGFLAG_READ flag in the PR_MESSAGE_FLAGS (PidTagMessageFlags) property of one or more of the folder's messages, and manages the sending of read reports. Args: @@ -23272,20 +22171,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIMAPIProp(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIMAPIProp(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetProps(self,propList:'Any',flags:'Any'=0) -> 'Tuple[Any, Any, Any]': - """ + def GetProps(self, propList: 'Any', flags: 'Any' = 0) -> 'Tuple[Any, Any, Any]': + """ Returns a list of property values. Args: @@ -23296,13 +22194,12 @@ Args: Returns: Tuple[Any, Any, Any] - - """ - pass + """ + pass - def DeleteProps(self,propList:'Any',wantProblems:'Any'=False) -> 'Tuple[Any, Any, Any]': - """ + def DeleteProps(self, propList: 'Any', wantProblems: 'Any' = False) -> 'Tuple[Any, Any, Any]': + """ Deletes a set of properties. Args: @@ -23313,13 +22210,12 @@ Args: Returns: Tuple[Any, Any, Any] - - """ - pass + """ + pass - def SetProps(self,propList:'Tuple[Any, Any]',wantProblems:'Any'=False) -> 'Tuple[Any, Any, Any]': - """ + def SetProps(self, propList: 'Tuple[Any, Any]', wantProblems: 'Any' = False) -> 'Tuple[Any, Any, Any]': + """ Sets a set of properties. Args: @@ -23330,13 +22226,21 @@ Args: Returns: Tuple[Any, Any, Any] - - """ - pass - - def CopyTo(self,IIDExcludeList:'Tuple[Any, Any]',propTags:'Any',uiParam:'Any',progress:'Any',resultIID:'PyIID',dest:'Any',flags:'Any',wantProblems:'Any'=False) -> 'Tuple[Any, Any, Any]': - """ + """ + pass + + def CopyTo( + self, + IIDExcludeList: 'Tuple[Any, Any]', + propTags: 'Any', + uiParam: 'Any', + progress: 'Any', + resultIID: 'PyIID', + dest: 'Any', + flags: 'Any', + wantProblems: 'Any' = False) -> 'Tuple[Any, Any, Any]': + """ Copies an object to another Args: @@ -23353,13 +22257,13 @@ Args: Returns: Tuple[Any, Any, Any] - - """ - pass + """ + pass - def CopyProps(self,propTags:'Any',uiParam:'Any',progress:'Any',resultIID:'PyIID',dest:'Any',flags:'Any',wantProblems:'Any'=False) -> 'Tuple[Any, Any, Any]': - """ + def CopyProps(self, propTags: 'Any', uiParam: 'Any', progress: 'Any', resultIID: 'PyIID', + dest: 'Any', flags: 'Any', wantProblems: 'Any' = False) -> 'Tuple[Any, Any, Any]': + """ Copies a set of properties to another object Args: @@ -23375,13 +22279,12 @@ Args: Returns: Tuple[Any, Any, Any] - - """ - pass + """ + pass - def OpenProperty(self,propTag:'Any',iid:'PyIID',interfaceOptions:'Any',flags:'Any') -> 'Any': - """ + def OpenProperty(self, propTag: 'Any', iid: 'PyIID', interfaceOptions: 'Any', flags: 'Any') -> 'Any': + """ Returns an interface object to be used to access a property. Args: @@ -23394,13 +22297,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetIDsFromNames(self,nameIds:'Any',flags:'Any'=0) -> 'Any': - """ + def GetIDsFromNames(self, nameIds: 'Any', flags: 'Any' = 0) -> 'Any': + """ Determines property IDs Args: @@ -23411,13 +22313,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetNamesFromIDs(self,propTags:'Any',propSetGuid:'PyIID'=None,flags:'Any'=0) -> 'Tuple[Any, Any, Any]': - """ + def GetNamesFromIDs(self, propTags: 'Any', propSetGuid: 'PyIID' = None, flags: 'Any' = 0) -> 'Tuple[Any, Any, Any]': + """ Determines property names Args: @@ -23429,13 +22330,12 @@ Args: Returns: Tuple[Any, Any, Any] - - """ - pass + """ + pass - def GetLastError(self,hr:'Any',flags:'Any') -> 'Any': - """ + def GetLastError(self, hr: 'Any', flags: 'Any') -> 'Any': + """ Returns the last error code for the object. Args: @@ -23446,13 +22346,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SaveChanges(self,flags:'Any') -> 'None': - """ + def SaveChanges(self, flags: 'Any') -> 'None': + """ Saves pending changes to the object Args: @@ -23462,13 +22361,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetPropList(self,flags:'Any') -> 'Any': - """ + def GetPropList(self, flags: 'Any') -> 'Any': + """ Gets a list of properties Args: @@ -23478,20 +22376,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIMAPISession(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIMAPISession(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def OpenEntry(self,entryId:'str',iid:'PyIID',flags:'Any') -> 'Any': - """ + def OpenEntry(self, entryId: 'str', iid: 'PyIID', flags: 'Any') -> 'Any': + """ Opens an object and returns an interface object for further access. Args: @@ -23503,13 +22400,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OpenMsgStore(self,uiParam:'Any',entryId:'str',iid:'PyIID',flags:'Any') -> 'Any': - """ + def OpenMsgStore(self, uiParam: 'Any', entryId: 'str', iid: 'PyIID', flags: 'Any') -> 'Any': + """ Opens a message store. Args: @@ -23522,13 +22418,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def QueryIdentity(self,) -> 'str': - """ + def QueryIdentity(self,) -> 'str': + """ Returns the entry identifier of the object that provides the primary identity for the session. Args: @@ -23538,13 +22433,12 @@ Args: Returns: str - - """ - pass + """ + pass - def Advise(self,entryId:'str',mask:'Any',sink:'Any') -> 'Any': - """ + def Advise(self, entryId: 'str', mask: 'Any', sink: 'Any') -> 'Any': + """ None Args: @@ -23555,17 +22449,16 @@ Args: Returns: - Any:Return ValueThe result is an integer which should be passed to + Any:Return ValueThe result is an integer which should be passed to PyIMAPISession::Unadvise - - """ - pass + """ + pass - def Unadvise(self,connection:'Any') -> 'None': - """ + def Unadvise(self, connection: 'Any') -> 'None': + """ None Args: @@ -23575,13 +22468,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CompareEntryIDs(self,entryId:'str',entryId1:'str',flags:'Any'=0) -> 'Any': - """ + def CompareEntryIDs(self, entryId: 'str', entryId1: 'str', flags: 'Any' = 0) -> 'Any': + """ Compares two entry identifiers belonging to a particular address book provider to determine if they refer to the same address book object Args: @@ -23595,13 +22487,12 @@ Returns: 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 + """ + pass - def GetLastError(self,hr:'Any',flags:'Any') -> 'Any': - """ + def GetLastError(self, hr: 'Any', flags: 'Any') -> 'Any': + """ Returns the last error code for the object. Args: @@ -23612,13 +22503,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetMsgStoresTable(self,flags:'Any') -> 'Any': - """ + def GetMsgStoresTable(self, flags: 'Any') -> 'Any': + """ Provides access to the message store table - a table with information about all of the message stores in the session profile. Args: @@ -23628,13 +22518,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetStatusTable(self,flags:'Any') -> 'Any': - """ + def GetStatusTable(self, flags: 'Any') -> 'Any': + """ Provides access to the status table - a table with information about all of the MAPI resources in the session. Args: @@ -23644,13 +22533,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Logoff(self,uiParm:'Any',flags:'Any',reserved:'Any') -> 'None': - """ + def Logoff(self, uiParm: 'Any', flags: 'Any', reserved: 'Any') -> 'None': + """ Ends a MAPI session. Args: @@ -23662,13 +22550,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OpenAddressBook(self,uiParm:'Any',iid:'PyIID',flags:'Any') -> 'Any': - """ + def OpenAddressBook(self, uiParm: 'Any', iid: 'PyIID', flags: 'Any') -> 'Any': + """ Opens the integrated address book. Args: @@ -23680,13 +22567,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OpenProfileSection(self,iidSection:'PyIID',iid:'PyIID',flags:'Any') -> 'Any': - """ + def OpenProfileSection(self, iidSection: 'PyIID', iid: 'PyIID', flags: 'Any') -> 'Any': + """ Opens a section of the current profile and returns an object for futher access Args: @@ -23698,13 +22584,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def AdminServices(self,flags:'Any'=0) -> 'Any': - """ + def AdminServices(self, flags: 'Any' = 0) -> 'Any': + """ Provides access to a message service administration object for making changes to the message services. Args: @@ -23714,20 +22599,19 @@ Args: Returns: Any - - """ - pass + + """ + pass class PyIMAPIStatus(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - - def ChangePassword(self,oldPassword:'Any',newPassword:'Any',ulFlags:'Any') -> 'None': - """ + def ChangePassword(self, oldPassword: 'Any', newPassword: 'Any', ulFlags: 'Any') -> 'None': + """ None Args: @@ -23739,13 +22623,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SettingsDialog(self,ulUIParam:'Any',ulFlags:'Any') -> 'None': - """ + def SettingsDialog(self, ulUIParam: 'Any', ulFlags: 'Any') -> 'None': + """ None Args: @@ -23756,13 +22639,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ValidateState(self,ulUIParam:'Any',ulFlags:'Any') -> 'None': - """ + def ValidateState(self, ulUIParam: 'Any', ulFlags: 'Any') -> 'None': + """ None Args: @@ -23773,13 +22655,12 @@ Args: Returns: None - - """ - pass + """ + pass - def FlushQueues(self,ulUIParam:'Any',transport:'str',ulFlags:'Any') -> 'None': - """ + def FlushQueues(self, ulUIParam: 'Any', transport: 'str', ulFlags: 'Any') -> 'None': + """ None Args: @@ -23791,20 +22672,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIMAPITable(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIMAPITable(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetLastError(self,hr:'Any',flags:'Any') -> 'Any': - """ + def GetLastError(self, hr: 'Any', flags: 'Any') -> 'Any': + """ Returns the last error code for the object. Args: @@ -23815,13 +22695,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Advise(self,eventMask:'Any',adviseSink:'Any') -> 'Any': - """ + def Advise(self, eventMask: 'Any', adviseSink: 'Any') -> 'Any': + """ Registers to receive notification of specified events affecting the table. Args: @@ -23832,13 +22711,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SeekRow(self,bookmark:'Any',rowCount:'Any') -> 'Any': - """ + def SeekRow(self, bookmark: 'Any', rowCount: 'Any') -> 'Any': + """ Moves the cursor to a specific position in the table. Args: @@ -23850,13 +22728,12 @@ Returns: Any:Return ValueThe result is the number of rows processed. - - """ - pass + """ + pass - def SeekRowApprox(self,numerator:'Any',denominator:'Any') -> 'None': - """ + def SeekRowApprox(self, numerator: 'Any', denominator: 'Any') -> 'None': + """ Moves the cursor to an approximate fractional position in the table. Args: @@ -23867,13 +22744,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetRowCount(self,flags:'Any') -> 'Any': - """ + def GetRowCount(self, flags: 'Any') -> 'Any': + """ Returns the total number of rows in the table. Args: @@ -23883,13 +22759,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def QueryRows(self,rowCount:'Any',flags:'Any') -> 'Any': - """ + def QueryRows(self, rowCount: 'Any', flags: 'Any') -> 'Any': + """ Returns one or more rows from a table, beginning at the current cursor position. Args: @@ -23900,14 +22775,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetColumns(self,propTags:'Any',flags:'Any') -> 'None': - """ - Defines the particular properties and order of properties to appear as columns in the table. + def SetColumns(self, propTags: 'Any', flags: 'Any') -> 'None': + """ + defines the particular properties and order of properties to appear as columns in the table. Args: @@ -23917,13 +22791,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetStatus(self,) -> 'None': - """ + def GetStatus(self,) -> 'None': + """ Returns the table's status and type. Args: @@ -23936,13 +22809,12 @@ Returns: GetStatus()Returns the table's status and type. Return ValueResult is a tuple of (tableStatus, tableType) - - """ - pass + """ + pass - def QueryPosition(self,) -> 'None': - """ + def QueryPosition(self,) -> 'None': + """ Retrieves the current table row position of the cursor, based on a fractional value. Args: @@ -23955,13 +22827,12 @@ 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 + """ + pass - def QueryColumns(self,flags:'Any') -> 'Any': - """ + def QueryColumns(self, flags: 'Any') -> 'Any': + """ Returns a list of columns for the table. Args: @@ -23971,13 +22842,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Abort(self,) -> 'None': - """ + def Abort(self,) -> 'None': + """ Stops any asynchronous operations currently in progress for the table. Args: @@ -23987,13 +22857,12 @@ Args: Returns: None - - """ - pass + """ + pass - def FreeBookmark(self,bookmark:'Any') -> 'None': - """ + def FreeBookmark(self, bookmark: 'Any') -> 'None': + """ Releases the memory associated with a bookmark. Args: @@ -24003,13 +22872,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CreateBookmark(self,) -> 'Any': - """ + def CreateBookmark(self,) -> 'Any': + """ Marks the table's current position. Args: @@ -24019,13 +22887,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Restrict(self,restriction:'Any',flags:'Any') -> 'None': - """ + def Restrict(self, restriction: 'Any', flags: 'Any') -> 'None': + """ Applies a filter to a table, reducing the row set to only those rows matching the specified criteria. Args: @@ -24036,13 +22903,12 @@ Args: Returns: None - - """ - pass + """ + pass - def FindRow(self,restriction:'Any',bookmarkOrigin:'Any',flags:'Any') -> 'None': - """ + def FindRow(self, restriction: 'Any', bookmarkOrigin: 'Any', flags: 'Any') -> 'None': + """ Finds the next row in a table that matches specific search criteria. Args: @@ -24054,13 +22920,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SortTable(self,sortOrderSet:'Any',flags:'Any') -> 'None': - """ + def SortTable(self, sortOrderSet: 'Any', flags: 'Any') -> 'None': + """ Orders the rows of the table based on sort criteria. Args: @@ -24071,13 +22936,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Unadvise(self,handle:'Any') -> 'None': - """ + def Unadvise(self, handle: 'Any') -> 'None': + """ Cancels the sending of notifications previously set up with a call to the IMAPITable::Advise method. Args: @@ -24087,20 +22951,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIMachineDebugManager(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIMachineDebugManager(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def AddApplication(self,pda:'Any') -> 'None': - """ + def AddApplication(self, pda: 'Any') -> 'None': + """ Description of AddApplication. Args: @@ -24110,13 +22973,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RemoveApplication(self,dwAppCookie:'Any') -> 'None': - """ + def RemoveApplication(self, dwAppCookie: 'Any') -> 'None': + """ Description of RemoveApplication. Args: @@ -24126,13 +22988,12 @@ Args: Returns: None - - """ - pass + """ + pass - def EnumApplications(self,) -> 'None': - """ + def EnumApplications(self,) -> 'None': + """ Description of EnumApplications. Args: @@ -24142,20 +23003,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIMachineDebugManagerEvents(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIMachineDebugManagerEvents(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def onAddApplication(self,pda:'Any',dwAppCookie:'Any') -> 'None': - """ + def onAddApplication(self, pda: 'Any', dwAppCookie: 'Any') -> 'None': + """ Description of onAddApplication. Args: @@ -24166,13 +23026,12 @@ Args: Returns: None - - """ - pass + """ + pass - def onRemoveApplication(self,pda:'Any',dwAppCookie:'Any') -> 'None': - """ + def onRemoveApplication(self, pda: 'Any', dwAppCookie: 'Any') -> 'None': + """ Description of onRemoveApplication. Args: @@ -24183,20 +23042,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIMessage(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIMessage(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def SetReadFlag(self,flag:'Any') -> 'None': - """ + def SetReadFlag(self, flag: 'Any') -> 'None': + """ Sets the read flags for a message Args: @@ -24206,13 +23064,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetAttachmentTable(self,flags:'Any') -> 'Any': - """ + def GetAttachmentTable(self, flags: 'Any') -> 'Any': + """ Returns the message's attachment table. Args: @@ -24222,13 +23079,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OpenAttach(self,attachmentNum:'Any',interface:'PyIID',flags:'Any') -> 'Any': - """ + def OpenAttach(self, attachmentNum: 'Any', interface: 'PyIID', flags: 'Any') -> 'Any': + """ Opens an attachment Args: @@ -24240,13 +23096,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def CreateAttach(self,interface:'PyIID',flags:'Any') -> 'Tuple[Any, Any]': - """ + def CreateAttach(self, interface: 'PyIID', flags: 'Any') -> 'Tuple[Any, Any]': + """ Creates an attachment Args: @@ -24258,13 +23113,12 @@ Returns: Tuple[Any, Any]:Bitmask of flags that controls how the attachment is created.Return ValueThe result is a tuple of (attachmentNum, attachmentObject) - - """ - pass + """ + pass - def DeleteAttach(self,attachmentNum:'Any',ulUIParam:'Any',interface:'Any',flags:'Any') -> 'None': - """ + def DeleteAttach(self, attachmentNum: 'Any', ulUIParam: 'Any', interface: 'Any', flags: 'Any') -> 'None': + """ Deletes an attachment Args: @@ -24277,13 +23131,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ModifyRecipients(self,flags:'Any',mods:'Any') -> 'None': - """ + def ModifyRecipients(self, flags: 'Any', mods: 'Any') -> 'None': + """ adds, deletes, or modifies message recipients. Args: @@ -24294,13 +23147,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetRecipientTable(self,flags:'Any') -> 'Any': - """ + def GetRecipientTable(self, flags: 'Any') -> 'Any': + """ Returns the message's recipient table. Args: @@ -24310,13 +23162,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SubmitMessage(self,flags:'Any') -> 'None': - """ + def SubmitMessage(self, flags: 'Any') -> 'None': + """ Saves all of the message's properties and marks the message as ready to be sent. Args: @@ -24326,20 +23177,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIMoniker(object): - """A Python interface to IMoniker""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIMoniker(object): + """A Python interface to IMoniker""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def BindToObject(self,bindCtx:'Any',moniker:'Any',iidResult:'Any') -> 'Any': - """ + def BindToObject(self, bindCtx: 'Any', moniker: 'Any', iidResult: 'Any') -> 'Any': + """ Uses the moniker to bind to the object it identifies. Args: @@ -24351,14 +23201,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def BindToStorage(self,bindCtx:'Any',moniker:'Any',iidResult:'Any') -> 'Any': - """ - Retrieves an interface object to the storage that contains the + def BindToStorage(self, bindCtx: 'Any', moniker: 'Any', iidResult: 'Any') -> 'Any': + """ + Retrieves an interface object to the storage that contains the object identified by the moniker. @@ -24371,14 +23220,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetDisplayName(self,bindCtx:'Any',moniker:'Any') -> 'str': - """ - Gets the display name , which is a user-readable representation of this + def GetDisplayName(self, bindCtx: 'Any', moniker: 'Any') -> 'str': + """ + Gets the display name , which is a user-readable representation of this moniker. @@ -24390,14 +23238,13 @@ Args: Returns: str - - """ - pass + """ + pass - def ComposeWith(self,mkRight:'Any',fOnlyIfNotGeneric:'Any') -> 'Any': - """ - Combines the current moniker with another moniker, creating a new + def ComposeWith(self, mkRight: 'Any', fOnlyIfNotGeneric: 'Any') -> 'Any': + """ + Combines the current moniker with another moniker, creating a new composite moniker. @@ -24409,14 +23256,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def Enum(self,fForward:'Any'=True) -> 'Any': - """ - Supplies an enumerator that can enumerate the components of a composite + def Enum(self, fForward: 'Any' = True) -> 'Any': + """ + Supplies an enumerator that can enumerate the components of a composite moniker. @@ -24427,14 +23273,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def IsEqual(self,other:'Any') -> 'Any': - """ - Compares this moniker with a specified moniker and indicates whether they are + def IsEqual(self, other: 'Any') -> 'Any': + """ + Compares this moniker with a specified moniker and indicates whether they are identical. @@ -24445,14 +23290,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def IsSystemMoniker(self,) -> 'Any': - """ - Indicates whether this moniker is of one of the system-supplied moniker + def IsSystemMoniker(self,) -> 'Any': + """ + Indicates whether this moniker is of one of the system-supplied moniker classes. @@ -24463,13 +23307,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Hash(self,) -> 'Any': - """ + def Hash(self,) -> 'Any': + """ Calculates a 32-bit integer using the internal state of the moniker. Args: @@ -24479,20 +23322,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIMsgServiceAdmin(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIMsgServiceAdmin(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetLastError(self,hr:'Any',flags:'Any') -> 'Any': - """ + def GetLastError(self, hr: 'Any', flags: 'Any') -> 'Any': + """ Returns the last error code for the object. Args: @@ -24503,13 +23345,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def CreateMsgService(self,serviceName:'str',displayName:'str',flags:'Any',uiParam:'Any'=0) -> 'None': - """ + def CreateMsgService(self, serviceName: 'str', displayName: 'str', flags: 'Any', uiParam: 'Any' = 0) -> 'None': + """ Creates a message service. Args: @@ -24522,13 +23363,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ConfigureMsgService(self,iid:'PyIID',ulUIParam:'Any',ulFlags:'Any',arg:'List[Any]') -> 'None': - """ + def ConfigureMsgService(self, iid: 'PyIID', ulUIParam: 'Any', ulFlags: 'Any', arg: 'List[Any]') -> 'None': + """ Reconfigures a message service. Args: @@ -24541,13 +23381,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetMsgServiceTable(self,flags:'Any') -> 'Any': - """ + def GetMsgServiceTable(self, flags: 'Any') -> 'Any': + """ Retrieves a table of services. Args: @@ -24557,13 +23396,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetProviderTable(self,flags:'Any') -> 'Any': - """ + def GetProviderTable(self, flags: 'Any') -> 'Any': + """ Retrieves a table of service providers. Args: @@ -24573,13 +23411,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def DeleteMsgService(self,uuid:'PyIID') -> 'None': - """ + def DeleteMsgService(self, uuid: 'PyIID') -> 'None': + """ Deletes the specified service Args: @@ -24589,13 +23426,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RenameMsgService(self,uuid:'PyIID',flags:'Any',newName:'str') -> 'None': - """ + def RenameMsgService(self, uuid: 'PyIID', flags: 'Any', newName: 'str') -> 'None': + """ Renames the specified service Args: @@ -24607,13 +23443,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OpenProfileSection(self,uuid:'PyIID',iid:'PyIID',flags:'Any') -> 'Any': - """ + def OpenProfileSection(self, uuid: 'PyIID', iid: 'PyIID', flags: 'Any') -> 'Any': + """ Opens a profile section Args: @@ -24625,14 +23460,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def AdminProviders(self,uuid:'PyIID',flags:'Any') -> 'Any': - """ - Returns an object providing access + def AdminProviders(self, uuid: 'PyIID', flags: 'Any') -> 'Any': + """ + Returns an object providing access to a provider administration object. @@ -24644,20 +23478,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIMsgStore(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIMsgStore(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def OpenEntry(self,entryId:'str',iid:'PyIID',flags:'Any') -> 'Any': - """ + def OpenEntry(self, entryId: 'str', iid: 'PyIID', flags: 'Any') -> 'Any': + """ Opens a folder or message and returns an interface object for further access. Args: @@ -24669,13 +23502,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetReceiveFolder(self,messageClass:'str'=None,flags:'Any'=0) -> 'Tuple[PyIID, str]': - """ + def GetReceiveFolder(self, messageClass: 'str' = None, flags: 'Any' = 0) -> 'Tuple[PyIID, str]': + """ Obtains the folder that was established as the destination for incoming messages of a specified message class or the default receive folder for the message store. Args: @@ -24686,13 +23518,12 @@ Args: Returns: Tuple[PyIID, str] - - """ - pass + """ + pass - def GetReceiveFolderTable(self,flags:'Any') -> 'Any': - """ + def GetReceiveFolderTable(self, flags: 'Any') -> 'Any': + """ provides access to the receive folder table, a table that includes information about all of the receive folders for the message store. Args: @@ -24702,13 +23533,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def CompareEntryIDs(self,entryId:'str',entryId1:'str',flags:'Any'=0) -> 'Any': - """ + def CompareEntryIDs(self, entryId: 'str', entryId1: 'str', flags: 'Any' = 0) -> 'Any': + """ Compares two entry identifiers belonging to a particular address book provider to determine if they refer to the same address book object Args: @@ -24722,13 +23552,12 @@ Returns: 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 + """ + pass - def GetLastError(self,hr:'Any',flags:'Any') -> 'Any': - """ + def GetLastError(self, hr: 'Any', flags: 'Any') -> 'Any': + """ Returns the last error code for the object. Args: @@ -24739,13 +23568,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def AbortSubmit(self,entryId:'str',flags:'Any'=0) -> 'Any': - """ + def AbortSubmit(self, entryId: 'str', flags: 'Any' = 0) -> 'Any': + """ Attempts to remove a message from the outgoing queue. Args: @@ -24756,13 +23584,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Advise(self,entryId:'str',eventMask:'Any',adviseSink:'Any') -> 'None': - """ + def Advise(self, entryId: 'str', eventMask: 'Any', adviseSink: 'Any') -> 'None': + """ Registers to receive notification of specified events that affect the message store. Args: @@ -24774,13 +23601,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Unadvise(self,connection:'Any') -> 'None': - """ + def Unadvise(self, connection: 'Any') -> 'None': + """ Cancels the sending of notifications previously set up with a call to the IMsgStore::Advise method. Args: @@ -24790,20 +23616,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyINameSpaceTreeControl(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyINameSpaceTreeControl(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Initialize(self,hwndParent:'Union[Any]',prc:'Tuple[Any, Any, Any, Any]',nsctsFlags:'Any') -> 'None': - """ + def Initialize(self, hwndParent: 'Union[Any]', prc: 'Tuple[Any, Any, Any, Any]', nsctsFlags: 'Any') -> 'None': + """ Description of Initialize. Args: @@ -24815,13 +23640,12 @@ Args: Returns: None - - """ - pass + """ + pass - def TreeAdvise(self,punk:'Any') -> 'None': - """ + def TreeAdvise(self, punk: 'Any') -> 'None': + """ Description of TreeAdvise. Args: @@ -24831,13 +23655,12 @@ Args: Returns: None - - """ - pass + """ + pass - def TreeUnadvise(self,dwCookie:'Any') -> 'None': - """ + def TreeUnadvise(self, dwCookie: 'Any') -> 'None': + """ Description of TreeUnadvise. Args: @@ -24847,13 +23670,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AppendRoot(self,psiRoot:'Any',grfEnumFlags:'Any',grfRootStyle:'Any',pif:'Any') -> 'None': - """ + def AppendRoot(self, psiRoot: 'Any', grfEnumFlags: 'Any', grfRootStyle: 'Any', pif: 'Any') -> 'None': + """ Description of AppendRoot. Args: @@ -24866,13 +23688,12 @@ Args: Returns: None - - """ - pass + """ + pass - def InsertRoot(self,iIndex:'Any',psiRoot:'Any',grfEnumFlags:'Any',grfRootStyle:'Any',pif:'Any') -> 'None': - """ + def InsertRoot(self, iIndex: 'Any', psiRoot: 'Any', grfEnumFlags: 'Any', grfRootStyle: 'Any', pif: 'Any') -> 'None': + """ Description of InsertRoot. Args: @@ -24886,13 +23707,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RemoveRoot(self,psiRoot:'Any') -> 'None': - """ + def RemoveRoot(self, psiRoot: 'Any') -> 'None': + """ Description of RemoveRoot. Args: @@ -24902,13 +23722,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RemoveAllRoots(self,) -> 'None': - """ + def RemoveAllRoots(self,) -> 'None': + """ Description of RemoveAllRoots. Args: @@ -24918,13 +23737,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetRootItems(self,) -> 'None': - """ + def GetRootItems(self,) -> 'None': + """ Description of GetRootItems. Args: @@ -24934,13 +23752,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetItemState(self,psi:'Any',nstcisMask:'Any',nstcisFlags:'Any') -> 'None': - """ + def SetItemState(self, psi: 'Any', nstcisMask: 'Any', nstcisFlags: 'Any') -> 'None': + """ Description of SetItemState. Args: @@ -24952,13 +23769,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetItemState(self,psi:'Any',nstcisMask:'Any') -> 'None': - """ + def GetItemState(self, psi: 'Any', nstcisMask: 'Any') -> 'None': + """ Description of GetItemState. Args: @@ -24969,13 +23785,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetSelectedItems(self,) -> 'None': - """ + def GetSelectedItems(self,) -> 'None': + """ Description of GetSelectedItems. Args: @@ -24985,13 +23800,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetItemCustomState(self,psi:'Any') -> 'None': - """ + def GetItemCustomState(self, psi: 'Any') -> 'None': + """ Description of GetItemCustomState. Args: @@ -25001,13 +23815,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetItemCustomState(self,psi:'Any',iStateNumber:'Any') -> 'None': - """ + def SetItemCustomState(self, psi: 'Any', iStateNumber: 'Any') -> 'None': + """ Description of SetItemCustomState. Args: @@ -25018,13 +23831,12 @@ Args: Returns: None - - """ - pass + """ + pass - def EnsureItemVisible(self,psi:'Any') -> 'None': - """ + def EnsureItemVisible(self, psi: 'Any') -> 'None': + """ Description of EnsureItemVisible. Args: @@ -25034,13 +23846,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetTheme(self,pszTheme:'Any') -> 'None': - """ + def SetTheme(self, pszTheme: 'Any') -> 'None': + """ Description of SetTheme. Args: @@ -25050,13 +23861,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetNextItem(self,psi:'Any',nstcgi:'Any') -> 'None': - """ + def GetNextItem(self, psi: 'Any', nstcgi: 'Any') -> 'None': + """ Description of GetNextItem. Args: @@ -25067,13 +23877,12 @@ Args: Returns: None - - """ - pass + """ + pass - def HitTest(self,pt:'Tuple[Any, Any]') -> 'None': - """ + def HitTest(self, pt: 'Tuple[Any, Any]') -> 'None': + """ Description of HitTest. Args: @@ -25083,13 +23892,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetItemRect(self,) -> 'None': - """ + def GetItemRect(self,) -> 'None': + """ Description of GetItemRect. Args: @@ -25099,13 +23907,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CollapseAll(self,) -> 'None': - """ + def CollapseAll(self,) -> 'None': + """ Description of CollapseAll. Args: @@ -25115,20 +23922,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyINamedPropertyStore(object): - """Contains a collection of properties indentified by name""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyINamedPropertyStore(object): + """Contains a collection of properties indentified by name""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetNamedValue(self,Name:'Any') -> 'Any': - """ + def GetNamedValue(self, Name: 'Any') -> 'Any': + """ Retrieves a property value by name Args: @@ -25138,13 +23944,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetNamedValue(self,propvar:'Any') -> 'None': - """ + def SetNamedValue(self, propvar: 'Any') -> 'None': + """ Sets the value of a property Args: @@ -25154,13 +23959,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetNameCount(self,) -> 'Any': - """ + def GetNameCount(self,) -> 'Any': + """ Retrieves the number of named properties in the store Args: @@ -25170,13 +23974,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetNameAt(self,Index:'Any') -> 'Any': - """ + def GetNameAt(self, Index: 'Any') -> 'Any': + """ Retrieves a property name by zero-based index Args: @@ -25186,20 +23989,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIObjectArray(object): - """Holds a collection of interface objects""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIObjectArray(object): + """Holds a collection of interface objects""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetCount(self,) -> 'Any': - """ + def GetCount(self,) -> 'Any': + """ Returns number of objects in collection Args: @@ -25209,13 +24011,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetAt(self,Index:'Any',riid:'PyIID') -> 'Any': - """ + def GetAt(self, Index: 'Any', riid: 'PyIID') -> 'Any': + """ Retrieves an item by zero-based index Args: @@ -25226,20 +24027,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIObjectCollection(object): - """Modifiable container for a number of IUnknown objects""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIObjectCollection(object): + """Modifiable container for a number of IUnknown objects""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def AddObject(self,punk:'Any') -> 'None': - """ + def AddObject(self, punk: 'Any') -> 'None': + """ Adds a single object to the collection Args: @@ -25249,13 +24049,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AddFromArray(self,Source:'Any') -> 'None': - """ + def AddFromArray(self, Source: 'Any') -> 'None': + """ None Args: @@ -25265,13 +24064,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RemoveObjectAt(self,Index:'Any') -> 'None': - """ + def RemoveObjectAt(self, Index: 'Any') -> 'None': + """ Removes a single object from the collection Args: @@ -25281,13 +24079,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Clear(self,) -> 'None': - """ + def Clear(self,) -> 'None': + """ Empties the container. Args: @@ -25297,20 +24094,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIObjectWithPropertyKey(object): - """Interface implemented by objects that have an associated property id""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIObjectWithPropertyKey(object): + """Interface implemented by objects that have an associated property id""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def SetPropertyKey(self,key:'Any') -> 'None': - """ + def SetPropertyKey(self, key: 'Any') -> 'None': + """ Sets the property id Args: @@ -25320,13 +24116,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetPropertyKey(self,) -> 'Any': - """ + def GetPropertyKey(self,) -> 'Any': + """ Returns the property id Args: @@ -25336,20 +24131,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIObjectWithSite(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIObjectWithSite(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def SetSite(self,pUnkSite:'Any') -> 'None': - """ + def SetSite(self, pUnkSite: 'Any') -> 'None': + """ Description of SetSite. Args: @@ -25359,13 +24153,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetSite(self,riid:'PyIID') -> 'None': - """ + def GetSite(self, riid: 'PyIID') -> 'None': + """ Description of GetSite. Args: @@ -25375,20 +24168,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIOleClientSite(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIOleClientSite(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def SaveObject(self,) -> 'None': - """ + def SaveObject(self,) -> 'None': + """ Description of SaveObject. Args: @@ -25398,13 +24190,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetMoniker(self,dwAssign:'Any',dwWhichMoniker:'Any') -> 'None': - """ + def GetMoniker(self, dwAssign: 'Any', dwWhichMoniker: 'Any') -> 'None': + """ Description of GetMoniker. Args: @@ -25415,13 +24206,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetContainer(self,) -> 'None': - """ + def GetContainer(self,) -> 'None': + """ Description of GetContainer. Args: @@ -25431,13 +24221,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ShowObject(self,) -> 'None': - """ + def ShowObject(self,) -> 'None': + """ Description of ShowObject. Args: @@ -25447,13 +24236,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnShowWindow(self,fShow:'Any') -> 'None': - """ + def OnShowWindow(self, fShow: 'Any') -> 'None': + """ Description of OnShowWindow. Args: @@ -25463,13 +24251,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RequestNewObjectLayout(self,) -> 'None': - """ + def RequestNewObjectLayout(self,) -> 'None': + """ Description of RequestNewObjectLayout. Args: @@ -25479,20 +24266,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIOleCommandTarget(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIOleCommandTarget(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def QueryStatus(self,) -> 'None': - """ + def QueryStatus(self,) -> 'None': + """ Description of QueryStatus. Args: @@ -25502,13 +24288,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Exec(self,) -> 'None': - """ + def Exec(self,) -> 'None': + """ Description of Exec. Args: @@ -25518,20 +24303,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIOleControl(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIOleControl(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetControlInfo(self,) -> 'None': - """ + def GetControlInfo(self,) -> 'None': + """ Description of GetControlInfo. Args: @@ -25541,13 +24325,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnMnemonic(self,msg:'Any') -> 'None': - """ + def OnMnemonic(self, msg: 'Any') -> 'None': + """ Description of OnMnemonic. Args: @@ -25557,13 +24340,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnAmbientPropertyChange(self,dispID:'Any') -> 'None': - """ + def OnAmbientPropertyChange(self, dispID: 'Any') -> 'None': + """ Description of OnAmbientPropertyChange. Args: @@ -25573,13 +24355,12 @@ Args: Returns: None - - """ - pass + """ + pass - def FreezeEvents(self,bFreeze:'Any') -> 'None': - """ + def FreezeEvents(self, bFreeze: 'Any') -> 'None': + """ Description of FreezeEvents. Args: @@ -25589,20 +24370,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIOleControlSite(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIOleControlSite(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def OnControlInfoChanged(self,) -> 'None': - """ + def OnControlInfoChanged(self,) -> 'None': + """ Description of OnControlInfoChanged. Args: @@ -25612,13 +24392,12 @@ Args: Returns: None - - """ - pass + """ + pass - def LockInPlaceActive(self,fLock:'Any') -> 'None': - """ + def LockInPlaceActive(self, fLock: 'Any') -> 'None': + """ Description of LockInPlaceActive. Args: @@ -25628,13 +24407,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetExtendedControl(self,) -> 'None': - """ + def GetExtendedControl(self,) -> 'None': + """ Description of GetExtendedControl. Args: @@ -25644,13 +24422,16 @@ Args: Returns: None - - """ - pass + """ + pass - def TransformCoords(self,PtlHimetric:'Tuple[Any, Any]',pPtfContainer:'Tuple[float, float]',dwFlags:'Any') -> 'None': - """ + def TransformCoords( + self, + PtlHimetric: 'Tuple[Any, Any]', + pPtfContainer: 'Tuple[float, float]', + dwFlags: 'Any') -> 'None': + """ Description of TransformCoords. Args: @@ -25661,17 +24442,16 @@ 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 + """ + pass - def TranslateAccelerator(self,pMsg:'PyMSG',grfModifiers:'Any') -> 'None': - """ + def TranslateAccelerator(self, pMsg: 'PyMSG', grfModifiers: 'Any') -> 'None': + """ Description of TranslateAccelerator. Args: @@ -25682,13 +24462,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnFocus(self,fGotFocus:'Any') -> 'None': - """ + def OnFocus(self, fGotFocus: 'Any') -> 'None': + """ Description of OnFocus. Args: @@ -25698,13 +24477,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ShowPropertyFrame(self,) -> 'None': - """ + def ShowPropertyFrame(self,) -> 'None': + """ Description of ShowPropertyFrame. Args: @@ -25714,20 +24492,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIOleInPlaceActiveObject(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIOleInPlaceActiveObject(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def TranslateAccelerator(self,lpmsg:'PyMSG') -> 'None': - """ + def TranslateAccelerator(self, lpmsg: 'PyMSG') -> 'None': + """ Description of TranslateAccelerator. Args: @@ -25737,13 +24514,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnFrameWindowActivate(self,fActivate:'Any') -> 'None': - """ + def OnFrameWindowActivate(self, fActivate: 'Any') -> 'None': + """ Description of OnFrameWindowActivate. Args: @@ -25753,13 +24529,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnDocWindowActivate(self,fActivate:'Any') -> 'None': - """ + def OnDocWindowActivate(self, fActivate: 'Any') -> 'None': + """ Description of OnDocWindowActivate. Args: @@ -25769,13 +24544,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ResizeBorder(self,rcBorder:'Tuple[Any, Any, Any, Any]',pUIWindow:'Any',fFrameWindow:'Any') -> 'None': - """ + def ResizeBorder(self, rcBorder: 'Tuple[Any, Any, Any, Any]', pUIWindow: 'Any', fFrameWindow: 'Any') -> 'None': + """ Description of ResizeBorder. Args: @@ -25787,13 +24561,12 @@ Args: Returns: None - - """ - pass + """ + pass - def EnableModeless(self,fEnable:'Any') -> 'None': - """ + def EnableModeless(self, fEnable: 'Any') -> 'None': + """ Description of EnableModeless. Args: @@ -25803,20 +24576,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIOleInPlaceFrame(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIOleInPlaceFrame(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def InsertMenus(self,hmenuShared:'Union[Any]',menuWidths:'Any') -> 'None': - """ + def InsertMenus(self, hmenuShared: 'Union[Any]', menuWidths: 'Any') -> 'None': + """ Description of InsertMenus. Args: @@ -25827,13 +24599,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetMenu(self,hmenuShared:'Union[Any]',holemenu:'Union[Any]',hwndActiveObject:'Union[Any]') -> 'None': - """ + def SetMenu(self, hmenuShared: 'Union[Any]', holemenu: 'Union[Any]', hwndActiveObject: 'Union[Any]') -> 'None': + """ Description of SetMenu. Args: @@ -25845,13 +24616,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RemoveMenus(self,hmenuShared:'Union[Any]') -> 'None': - """ + def RemoveMenus(self, hmenuShared: 'Union[Any]') -> 'None': + """ Description of RemoveMenus. Args: @@ -25861,13 +24631,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetStatusText(self,pszStatusText:'Any') -> 'None': - """ + def SetStatusText(self, pszStatusText: 'Any') -> 'None': + """ Description of SetStatusText. Args: @@ -25877,13 +24646,12 @@ Args: Returns: None - - """ - pass + """ + pass - def EnableModeless(self,fEnable:'Any') -> 'None': - """ + def EnableModeless(self, fEnable: 'Any') -> 'None': + """ Description of EnableModeless. Args: @@ -25893,13 +24661,12 @@ Args: Returns: None - - """ - pass + """ + pass - def TranslateAccelerator(self,lpmsg:'PyMSG',wID:'Any') -> 'None': - """ + def TranslateAccelerator(self, lpmsg: 'PyMSG', wID: 'Any') -> 'None': + """ Description of TranslateAccelerator. Args: @@ -25910,20 +24677,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIOleInPlaceObject(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIOleInPlaceObject(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def InPlaceDeactivate(self,) -> 'None': - """ + def InPlaceDeactivate(self,) -> 'None': + """ Description of InPlaceDeactivate. Args: @@ -25933,13 +24699,12 @@ Args: Returns: None - - """ - pass + """ + pass - def UIDeactivate(self,) -> 'None': - """ + def UIDeactivate(self,) -> 'None': + """ Description of UIDeactivate. Args: @@ -25949,13 +24714,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetObjectRects(self,) -> 'None': - """ + def SetObjectRects(self,) -> 'None': + """ Description of SetObjectRects. Args: @@ -25965,13 +24729,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ReactivateAndUndo(self,) -> 'None': - """ + def ReactivateAndUndo(self,) -> 'None': + """ Description of ReactivateAndUndo. Args: @@ -25981,20 +24744,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIOleInPlaceSite(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIOleInPlaceSite(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def CanInPlaceActivate(self,) -> 'None': - """ + def CanInPlaceActivate(self,) -> 'None': + """ Description of CanInPlaceActivate. Args: @@ -26004,13 +24766,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnInPlaceActivate(self,) -> 'None': - """ + def OnInPlaceActivate(self,) -> 'None': + """ Description of OnInPlaceActivate. Args: @@ -26020,13 +24781,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnUIActivate(self,) -> 'None': - """ + def OnUIActivate(self,) -> 'None': + """ Description of OnUIActivate. Args: @@ -26036,13 +24796,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetWindowContext(self,) -> 'None': - """ + def GetWindowContext(self,) -> 'None': + """ Description of GetWindowContext. Args: @@ -26052,13 +24811,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Scroll(self,) -> 'None': - """ + def Scroll(self,) -> 'None': + """ Description of Scroll. Args: @@ -26068,13 +24826,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnUIDeactivate(self,fUndoable:'Any') -> 'None': - """ + def OnUIDeactivate(self, fUndoable: 'Any') -> 'None': + """ Description of OnUIDeactivate. Args: @@ -26084,13 +24841,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnInPlaceDeactivate(self,) -> 'None': - """ + def OnInPlaceDeactivate(self,) -> 'None': + """ Description of OnInPlaceDeactivate. Args: @@ -26100,13 +24856,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DiscardUndoState(self,) -> 'None': - """ + def DiscardUndoState(self,) -> 'None': + """ Description of DiscardUndoState. Args: @@ -26116,13 +24871,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DeactivateAndUndo(self,) -> 'None': - """ + def DeactivateAndUndo(self,) -> 'None': + """ Description of DeactivateAndUndo. Args: @@ -26132,13 +24886,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnPosRectChange(self,) -> 'None': - """ + def OnPosRectChange(self,) -> 'None': + """ Description of OnPosRectChange. Args: @@ -26148,20 +24901,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIOleInPlaceSiteEx(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIOleInPlaceSiteEx(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def OnInPlaceActivateEx(self,dwFlags:'Any') -> 'None': - """ + def OnInPlaceActivateEx(self, dwFlags: 'Any') -> 'None': + """ Description of OnInPlaceActivateEx. Args: @@ -26171,13 +24923,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnInPlaceDeactivateEx(self,fNoRedraw:'Any') -> 'None': - """ + def OnInPlaceDeactivateEx(self, fNoRedraw: 'Any') -> 'None': + """ Description of OnInPlaceDeactivateEx. Args: @@ -26187,13 +24938,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RequestUIActivate(self,) -> 'None': - """ + def RequestUIActivate(self,) -> 'None': + """ Description of RequestUIActivate. Args: @@ -26203,20 +24953,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIOleInPlaceSiteWindowless(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIOleInPlaceSiteWindowless(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def CanWindowlessActivate(self,) -> 'None': - """ + def CanWindowlessActivate(self,) -> 'None': + """ Description of CanWindowlessActivate. Args: @@ -26226,13 +24975,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetCapture(self,) -> 'None': - """ + def GetCapture(self,) -> 'None': + """ Description of GetCapture. Args: @@ -26242,13 +24990,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetCapture(self,fCapture:'Any') -> 'None': - """ + def SetCapture(self, fCapture: 'Any') -> 'None': + """ Description of SetCapture. Args: @@ -26258,13 +25005,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetFocus(self,) -> 'None': - """ + def GetFocus(self,) -> 'None': + """ Description of GetFocus. Args: @@ -26274,13 +25020,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetFocus(self,fFocus:'Any') -> 'None': - """ + def SetFocus(self, fFocus: 'Any') -> 'None': + """ Description of SetFocus. Args: @@ -26290,13 +25035,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetDC(self,grfFlags:'Any',rect:'Tuple[Any, Any, Any, Any]') -> 'None': - """ + def GetDC(self, grfFlags: 'Any', rect: 'Tuple[Any, Any, Any, Any]') -> 'None': + """ Description of GetDC. Args: @@ -26307,13 +25051,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ReleaseDC(self,hDC:'Any') -> 'None': - """ + def ReleaseDC(self, hDC: 'Any') -> 'None': + """ Description of ReleaseDC. Args: @@ -26323,13 +25066,12 @@ Args: Returns: None - - """ - pass + """ + pass - def InvalidateRect(self,rect:'Tuple[Any, Any, Any, Any]',fErase:'Any') -> 'None': - """ + def InvalidateRect(self, rect: 'Tuple[Any, Any, Any, Any]', fErase: 'Any') -> 'None': + """ Description of InvalidateRect. Args: @@ -26340,13 +25082,12 @@ Args: Returns: None - - """ - pass + """ + pass - def InvalidateRgn(self,hRgn:'Any',fErase:'Any') -> 'None': - """ + def InvalidateRgn(self, hRgn: 'Any', fErase: 'Any') -> 'None': + """ Description of InvalidateRgn. Args: @@ -26357,13 +25098,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ScrollRect(self,dx:'Any',dy:'Any') -> 'None': - """ + def ScrollRect(self, dx: 'Any', dy: 'Any') -> 'None': + """ Description of ScrollRect. Args: @@ -26374,13 +25114,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AdjustRect(self,) -> 'None': - """ + def AdjustRect(self,) -> 'None': + """ Description of AdjustRect. Args: @@ -26390,13 +25129,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnDefWindowMessage(self,msg:'Any',wParam:'Any',lParam:'Any') -> 'None': - """ + def OnDefWindowMessage(self, msg: 'Any', wParam: 'Any', lParam: 'Any') -> 'None': + """ Description of OnDefWindowMessage. Args: @@ -26408,20 +25146,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIOleInPlaceUIWindow(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIOleInPlaceUIWindow(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetBorder(self,) -> 'None': - """ + def GetBorder(self,) -> 'None': + """ Description of GetBorder. Args: @@ -26431,13 +25168,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RequestBorderSpace(self,borderwidths:'Tuple[Any, Any, Any, Any]') -> 'None': - """ + def RequestBorderSpace(self, borderwidths: 'Tuple[Any, Any, Any, Any]') -> 'None': + """ Description of RequestBorderSpace. Args: @@ -26447,13 +25183,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetBorderSpace(self,borderwidths:'Tuple[Any, Any, Any, Any]') -> 'None': - """ + def SetBorderSpace(self, borderwidths: 'Tuple[Any, Any, Any, Any]') -> 'None': + """ Description of SetBorderSpace. Args: @@ -26463,13 +25198,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetActiveObject(self,pActiveObject:'Any',pszObjName:'Any') -> 'None': - """ + def SetActiveObject(self, pActiveObject: 'Any', pszObjName: 'Any') -> 'None': + """ Description of SetActiveObject. Args: @@ -26480,20 +25214,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIOleObject(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIOleObject(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def SetClientSite(self,pClientSite:'Any') -> 'None': - """ + def SetClientSite(self, pClientSite: 'Any') -> 'None': + """ Description of SetClientSite. Args: @@ -26503,13 +25236,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetClientSite(self,) -> 'None': - """ + def GetClientSite(self,) -> 'None': + """ Description of GetClientSite. Args: @@ -26519,13 +25251,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetHostNames(self,szContainerApp:'Any',szContainerObj:'Any') -> 'None': - """ + def SetHostNames(self, szContainerApp: 'Any', szContainerObj: 'Any') -> 'None': + """ Description of SetHostNames. Args: @@ -26536,13 +25267,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Close(self,dwSaveOption:'Any') -> 'None': - """ + def Close(self, dwSaveOption: 'Any') -> 'None': + """ Description of Close. Args: @@ -26552,13 +25282,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetMoniker(self,dwWhichMoniker:'Any',pmk:'Any') -> 'None': - """ + def SetMoniker(self, dwWhichMoniker: 'Any', pmk: 'Any') -> 'None': + """ Description of SetMoniker. Args: @@ -26569,13 +25298,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetMoniker(self,dwAssign:'Any',dwWhichMoniker:'Any') -> 'None': - """ + def GetMoniker(self, dwAssign: 'Any', dwWhichMoniker: 'Any') -> 'None': + """ Description of GetMoniker. Args: @@ -26586,13 +25314,12 @@ Args: Returns: None - - """ - pass + """ + pass - def InitFromData(self,pDataObject:'Any',fCreation:'Any',dwReserved:'Any') -> 'None': - """ + def InitFromData(self, pDataObject: 'Any', fCreation: 'Any', dwReserved: 'Any') -> 'None': + """ Description of InitFromData. Args: @@ -26604,13 +25331,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetClipboardData(self,dwReserved:'Any') -> 'None': - """ + def GetClipboardData(self, dwReserved: 'Any') -> 'None': + """ Description of GetClipboardData. Args: @@ -26620,13 +25346,13 @@ Args: Returns: None - - """ - pass + """ + pass - def DoVerb(self,iVerb:'Any',msg:'PyMSG',pActiveSite:'Any',lindex:'Any',hwndParent:'Any',rect:'Tuple[Any, Any, Any, Any]') -> 'None': - """ + def DoVerb(self, iVerb: 'Any', msg: 'PyMSG', pActiveSite: 'Any', lindex: 'Any', + hwndParent: 'Any', rect: 'Tuple[Any, Any, Any, Any]') -> 'None': + """ Description of DoVerb. Args: @@ -26641,13 +25367,12 @@ Args: Returns: None - - """ - pass + """ + pass - def EnumVerbs(self,) -> 'None': - """ + def EnumVerbs(self,) -> 'None': + """ Description of EnumVerbs. Args: @@ -26657,13 +25382,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Update(self,) -> 'None': - """ + def Update(self,) -> 'None': + """ Description of Update. Args: @@ -26673,13 +25397,12 @@ Args: Returns: None - - """ - pass + """ + pass - def IsUpToDate(self,) -> 'None': - """ + def IsUpToDate(self,) -> 'None': + """ Description of IsUpToDate. Args: @@ -26689,13 +25412,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetUserClassID(self,) -> 'None': - """ + def GetUserClassID(self,) -> 'None': + """ Description of GetUserClassID. Args: @@ -26705,13 +25427,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetUserType(self,dwFormOfType:'Any') -> 'None': - """ + def GetUserType(self, dwFormOfType: 'Any') -> 'None': + """ Description of GetUserType. Args: @@ -26721,13 +25442,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetExtent(self,dwDrawAspect:'Any',size:'Tuple[Any, Any]') -> 'None': - """ + def SetExtent(self, dwDrawAspect: 'Any', size: 'Tuple[Any, Any]') -> 'None': + """ Description of SetExtent. Args: @@ -26738,13 +25458,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetExtent(self,dwDrawAspect:'Any',size:'Tuple[Any, Any]') -> 'None': - """ + def GetExtent(self, dwDrawAspect: 'Any', size: 'Tuple[Any, Any]') -> 'None': + """ Description of GetExtent. Args: @@ -26755,13 +25474,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Advise(self,pAdvSink:'Any') -> 'None': - """ + def Advise(self, pAdvSink: 'Any') -> 'None': + """ Description of Advise. Args: @@ -26771,13 +25489,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Unadvise(self,dwConnection:'Any') -> 'None': - """ + def Unadvise(self, dwConnection: 'Any') -> 'None': + """ Description of Unadvise. Args: @@ -26787,13 +25504,12 @@ Args: Returns: None - - """ - pass + """ + pass - def EnumAdvise(self,) -> 'None': - """ + def EnumAdvise(self,) -> 'None': + """ Description of EnumAdvise. Args: @@ -26803,13 +25519,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetMiscStatus(self,dwAspect:'Any') -> 'None': - """ + def GetMiscStatus(self, dwAspect: 'Any') -> 'None': + """ Description of GetMiscStatus. Args: @@ -26819,13 +25534,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetColorScheme(self,) -> 'None': - """ + def SetColorScheme(self,) -> 'None': + """ Description of SetColorScheme. Args: @@ -26835,20 +25549,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIOleWindow(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIOleWindow(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetWindow(self,) -> 'None': - """ + def GetWindow(self,) -> 'None': + """ Description of GetWindow. Args: @@ -26858,13 +25571,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ContextSensitiveHelp(self,fEnterMode:'Any') -> 'None': - """ + def ContextSensitiveHelp(self, fEnterMode: 'Any') -> 'None': + """ Description of ContextSensitiveHelp. Args: @@ -26874,20 +25586,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIPersist(object): - """A Python interface to IPersist""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIPersist(object): + """A Python interface to IPersist""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetClassID(self,) -> 'PyIID': - """ + def GetClassID(self,) -> 'PyIID': + """ Returns the class identifier (CLSID) for the component object. Args: @@ -26897,20 +25608,19 @@ Args: Returns: PyIID - - """ - pass + """ + pass -class PyIPersistFile(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIPersistFile(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def IsDirty(self,) -> 'None': - """ + def IsDirty(self,) -> 'None': + """ Checks an object for changes since it was last saved to its current file. Args: @@ -26921,19 +25631,18 @@ 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 + """ + pass - def Load(self,FileName:'Any',Mode:'Any') -> 'None': - """ + def Load(self, FileName: 'Any', Mode: 'Any') -> 'None': + """ Opens the specified file and initializes an object from the file contents. Args: @@ -26944,13 +25653,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Save(self,FileName:'Any',fRemember:'Any') -> 'None': - """ + def Save(self, FileName: 'Any', fRemember: 'Any') -> 'None': + """ Saves the object into the specified file. Args: @@ -26961,13 +25669,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SaveCompleted(self,FileName:'Any') -> 'None': - """ + def SaveCompleted(self, FileName: 'Any') -> 'None': + """ Notifies the object that it can revert from NoScribble mode to Normal mode. Args: @@ -26977,13 +25684,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetCurFile(self,) -> 'Any': - """ + def GetCurFile(self,) -> 'Any': + """ Gets the current name of the file associated with the object. Args: @@ -26993,20 +25699,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIPersistFolder(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIPersistFolder(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Initialize(self,pidl:'Any') -> 'None': - """ + def Initialize(self, pidl: 'Any') -> 'None': + """ Description of Initialize. Args: @@ -27016,20 +25721,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIPersistFolder2(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIPersistFolder2(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetCurFolder(self,) -> 'None': - """ + def GetCurFolder(self,) -> 'None': + """ Description of GetCurFolder. Args: @@ -27039,21 +25743,20 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIPersistPropertyBag(object): - """A Python wrapper for a COM IPersistPropertyBag interface.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIPersistPropertyBag(object): + """A Python wrapper for a COM IPersistPropertyBag interface.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def InitNew(self,) -> 'None': - """ - Called by the container when the control is initialized to initialize the + def InitNew(self,) -> 'None': + """ + Called by the container when the control is initialized to initialize the property bag. @@ -27064,13 +25767,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Load(self,bag:'Any',log:'Any'=None) -> 'None': - """ + def Load(self, bag: 'Any', log: 'Any' = None) -> 'None': + """ Called by the container to load the control's properties. Args: @@ -27081,13 +25783,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Save(self,bag:'Any',clearDirty:'Any',saveProperties:'Any') -> 'None': - """ + def Save(self, bag: 'Any', clearDirty: 'Any', saveProperties: 'Any') -> 'None': + """ Called by the container to save the object's properties. Args: @@ -27099,20 +25800,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIPersistSerializedPropStorage(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIPersistSerializedPropStorage(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def SetFlags(self,flags:'Any') -> 'None': - """ + def SetFlags(self, flags: 'Any') -> 'None': + """ Sets flags for the store Args: @@ -27122,13 +25822,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetPropertyStorage(self,ps:'Any') -> 'None': - """ + def SetPropertyStorage(self, ps: 'Any') -> 'None': + """ Initializes the store with a serialized buffer Args: @@ -27138,14 +25837,13 @@ Args: Returns: None - - """ - pass + """ + pass - def GetPropertyStorage(self,) -> 'Any': - """ - Retrieves the current contents of the property + def GetPropertyStorage(self,) -> 'Any': + """ + Retrieves the current contents of the property store @@ -27156,20 +25854,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIPersistStorage(object): - """A Python wrapper of a COM IPersistStorage interface.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIPersistStorage(object): + """A Python wrapper of a COM IPersistStorage interface.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def IsDirty(self,) -> 'Any': - """ + def IsDirty(self,) -> 'Any': + """ Checks the object for changes since it was last saved. Args: @@ -27179,13 +25876,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def InitNew(self,PyIStorage:'Any') -> 'None': - """ + def InitNew(self, PyIStorage: 'Any') -> 'None': + """ Initializes a new object, providing a storage object to be used for the object. Args: @@ -27195,13 +25891,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Load(self,storage:'Any') -> 'None': - """ + def Load(self, storage: 'Any') -> 'None': + """ Loads an object from its existing storage. Args: @@ -27211,13 +25906,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Save(self,PyIStorage:'Any',_int:'Any') -> 'None': - """ + def Save(self, PyIStorage: 'Any', _int: 'Any') -> 'None': + """ None Args: @@ -27228,13 +25922,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SaveCompleted(self,PyIStorage:'Any') -> 'None': - """ + def SaveCompleted(self, PyIStorage: 'Any') -> 'None': + """ None Args: @@ -27244,16 +25937,15 @@ Args: Returns: None - - """ - pass + """ + pass - def HandsOffStorage(self,) -> 'None': - """ - Instructs the object to release all storage objects that have been + def HandsOffStorage(self,) -> 'None': + """ + 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,20 +25956,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIPersistStream(object): - """A Python interface to IPersistStream""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIPersistStream(object): + """A Python interface to IPersistStream""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def IsDirty(self,) -> 'Any': - """ + def IsDirty(self,) -> 'Any': + """ Checks the object for changes since it was last saved. Args: @@ -27287,13 +25978,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Load(self,stream:'Any') -> 'None': - """ + def Load(self, stream: 'Any') -> 'None': + """ Initializes an object from the stream where it was previously saved. Args: @@ -27303,13 +25993,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Save(self,stream:'Any',bClearDirty:'Any') -> 'None': - """ + def Save(self, stream: 'Any', bClearDirty: 'Any') -> 'None': + """ Saves an object to the specified stream. Args: @@ -27320,14 +26009,13 @@ Args: Returns: None - - """ - pass + """ + pass - def GetSizeMax(self,) -> 'ULARGE_INTEGER': - """ - Returns the size in bytes of the stream needed to save the + def GetSizeMax(self,) -> 'ULARGE_INTEGER': + """ + Returns the size in bytes of the stream needed to save the object. @@ -27338,20 +26026,19 @@ Args: Returns: ULARGE_INTEGER - - """ - pass + """ + pass -class PyIPersistStreamInit(object): - """A Python interface to IPersistStreamInit""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIPersistStreamInit(object): + """A Python interface to IPersistStreamInit""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def InitNew(self,) -> 'None': - """ + def InitNew(self,) -> 'None': + """ Initializes the object to a default state. Args: @@ -27361,20 +26048,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIProcessDebugManager(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIProcessDebugManager(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def CreateApplication(self,) -> 'None': - """ + def CreateApplication(self,) -> 'None': + """ Description of CreateApplication. Args: @@ -27384,13 +26070,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetDefaultApplication(self,) -> 'None': - """ + def GetDefaultApplication(self,) -> 'None': + """ Description of GetDefaultApplication. Args: @@ -27400,13 +26085,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AddApplication(self,pda:'Any') -> 'None': - """ + def AddApplication(self, pda: 'Any') -> 'None': + """ Description of AddApplication. Args: @@ -27416,13 +26100,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RemoveApplication(self,dwAppCookie:'Any') -> 'None': - """ + def RemoveApplication(self, dwAppCookie: 'Any') -> 'None': + """ Description of RemoveApplication. Args: @@ -27432,13 +26115,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CreateDebugDocumentHelper(self,unkOuter:'Any') -> 'None': - """ + def CreateDebugDocumentHelper(self, unkOuter: 'Any') -> 'None': + """ Description of CreateDebugDocumentHelper. Args: @@ -27448,20 +26130,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIProfAdmin(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIProfAdmin(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetLastError(self,hr:'Any',flags:'Any') -> 'Any': - """ + def GetLastError(self, hr: 'Any', flags: 'Any') -> 'Any': + """ Returns the last error code for the object. Args: @@ -27472,13 +26153,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def CreateProfile(self,oldProfileName:'str',Password:'str',uiParam:'Any'=0,flags:'Any'=0) -> 'None': - """ + def CreateProfile(self, oldProfileName: 'str', Password: 'str', uiParam: 'Any' = 0, flags: 'Any' = 0) -> 'None': + """ Creates a new profile. Args: @@ -27491,13 +26171,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DeleteProfile(self,oldProfileName:'str',flags:'Any'=0) -> 'None': - """ + def DeleteProfile(self, oldProfileName: 'str', flags: 'Any' = 0) -> 'None': + """ Deletes a profile. Args: @@ -27508,13 +26187,18 @@ Args: Returns: None - - """ - pass + """ + pass - def CopyProfile(self,oldProfileName:'str',Password:'str',newProfileName:'str',uiParam:'Any'=0,flags:'Any'=0) -> 'None': - """ + def CopyProfile( + self, + oldProfileName: 'str', + Password: 'str', + newProfileName: 'str', + uiParam: 'Any' = 0, + flags: 'Any' = 0) -> 'None': + """ Copies a profile. Args: @@ -27528,13 +26212,18 @@ Args: Returns: None - - """ - pass + """ + pass - def RenameProfile(self,oldProfileName:'str',Password:'str',newProfileName:'str',uiParam:'Any'=0,flags:'Any'=0) -> 'None': - """ + def RenameProfile( + self, + oldProfileName: 'str', + Password: 'str', + newProfileName: 'str', + uiParam: 'Any' = 0, + flags: 'Any' = 0) -> 'None': + """ Assigns a new name to a profile. Args: @@ -27548,13 +26237,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetDefaultProfile(self,profileName:'str',flags:'Any'=0) -> 'None': - """ + def SetDefaultProfile(self, profileName: 'str', flags: 'Any' = 0) -> 'None': + """ Sets or clears a client's default profile. Args: @@ -27565,13 +26253,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AdminServices(self,profileName:'str',Password:'str'=None,uiParam:'Any'=0,flags:'Any'=0) -> 'Any': - """ + def AdminServices(self, profileName: 'str', Password: 'str' = None, uiParam: 'Any' = 0, flags: 'Any' = 0) -> 'Any': + """ Provides access to a message service administration object for making changes to the message services in a profile. Args: @@ -27584,21 +26271,20 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIPropertyBag(object): - """A Python wrapper for a COM IPropertyBag interface.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIPropertyBag(object): + """A Python wrapper for a COM IPropertyBag interface.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Read(self,propName:'Any',propType:'Any',errorLog:'Any'=None) -> 'Any': - """ - Called by the control to read a property from the storage provided by the + def Read(self, propName: 'Any', propType: 'Any', errorLog: 'Any' = None) -> 'Any': + """ + Called by the control to read a property from the storage provided by the container. @@ -27611,14 +26297,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def Write(self,propName:'Any',value:'Any') -> 'None': - """ - Called by the control to write each property in turn to the storage provided by the + def Write(self, propName: 'Any', value: 'Any') -> 'None': + """ + Called by the control to write each property in turn to the storage provided by the container. @@ -27630,20 +26315,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIPropertyChange(object): - """Interface used to specify a change to a property""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIPropertyChange(object): + """Interface used to specify a change to a property""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def ApplyToPropVariant(self,OrigVal:'Any') -> 'Any': - """ + def ApplyToPropVariant(self, OrigVal: 'Any') -> 'Any': + """ Applies the change to a variant value Args: @@ -27653,20 +26337,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIPropertyChangeArray(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIPropertyChangeArray(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetCount(self,) -> 'Any': - """ + def GetCount(self,) -> 'Any': + """ Returns the number of changes in the array Args: @@ -27676,13 +26359,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetAt(self,Index:'Any',riid:'PyIID') -> 'Any': - """ + def GetAt(self, Index: 'Any', riid: 'PyIID') -> 'Any': + """ Retrieves a change by zero-based index Args: @@ -27693,13 +26375,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def InsertAt(self,Index:'Any',PropChange:'Any') -> 'None': - """ + def InsertAt(self, Index: 'Any', PropChange: 'Any') -> 'None': + """ Inserts a change at a specific position Args: @@ -27710,13 +26391,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Append(self,PropChange:'Any') -> 'None': - """ + def Append(self, PropChange: 'Any') -> 'None': + """ Adds a change to the end of the array Args: @@ -27726,14 +26406,13 @@ Args: Returns: None - - """ - pass + """ + pass - def AppendOrReplace(self,PropChange:'Any') -> 'None': - """ - Adds a change, or replaces if an identical property key is already + def AppendOrReplace(self, PropChange: 'Any') -> 'None': + """ + Adds a change, or replaces if an identical property key is already in container @@ -27744,13 +26423,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RemoveAt(self,Index:'Any') -> 'None': - """ + def RemoveAt(self, Index: 'Any') -> 'None': + """ Removes a change from the array Args: @@ -27760,13 +26438,12 @@ Args: Returns: None - - """ - pass + """ + pass - def IsKeyInArray(self,key:'Any') -> 'Any': - """ + def IsKeyInArray(self, key: 'Any') -> 'Any': + """ Checks if array contains a change to a property Args: @@ -27776,20 +26453,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIPropertyDescription(object): - """Gives access to the details of a property definition""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIPropertyDescription(object): + """Gives access to the details of a property definition""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetPropertyKey(self,) -> 'Any': - """ + def GetPropertyKey(self,) -> 'Any': + """ Returns the unique identifier for a property Args: @@ -27799,13 +26475,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetCanonicalName(self,) -> 'Any': - """ + def GetCanonicalName(self,) -> 'Any': + """ Returns the name of the property Args: @@ -27815,13 +26490,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetPropertyType(self,) -> 'Any': - """ + def GetPropertyType(self,) -> 'Any': + """ Returns the variant type of the property (VT_*) Args: @@ -27831,13 +26505,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetDisplayName(self,) -> 'Any': - """ + def GetDisplayName(self,) -> 'Any': + """ Returns the property name as shown in the UI Args: @@ -27847,13 +26520,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetEditInvitation(self,) -> 'Any': - """ + def GetEditInvitation(self,) -> 'Any': + """ Returns the input prompt used in edit controls Args: @@ -27863,13 +26535,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetTypeFlags(self,mask:'Any') -> 'Any': - """ + def GetTypeFlags(self, mask: 'Any') -> 'Any': + """ Returns type flags for the property Args: @@ -27879,14 +26550,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetViewFlags(self,) -> 'Any': - """ - Returns the view flags that control how the property is displayed + def GetViewFlags(self,) -> 'Any': + """ + Returns the view flags that control how the property is displayed (PDVF_*) @@ -27897,13 +26567,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetDefaultColumnWidth(self,) -> 'Any': - """ + def GetDefaultColumnWidth(self,) -> 'Any': + """ Returns the default width in characters Args: @@ -27913,13 +26582,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetDisplayType(self,) -> 'Any': - """ + def GetDisplayType(self,) -> 'Any': + """ Returns the display type (PDDT_*) Args: @@ -27929,14 +26597,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetColumnState(self,) -> 'Any': - """ - Returns flags that control how property is displayed in column + def GetColumnState(self,) -> 'Any': + """ + Returns flags that control how property is displayed in column (SHCOLSTATE_*) @@ -27947,13 +26614,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetGroupingRange(self,) -> 'Any': - """ + def GetGroupingRange(self,) -> 'Any': + """ Returns property's grouping attributes (PDGR_*) Args: @@ -27963,13 +26629,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetRelativeDescriptionType(self,) -> 'Any': - """ + def GetRelativeDescriptionType(self,) -> 'Any': + """ Returns the relative description type (PDRDT_*) Args: @@ -27979,13 +26644,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetRelativeDescription(self,var1:'Any',var2:'Any') -> 'Tuple[Any, Any]': - """ + def GetRelativeDescription(self, var1: 'Any', var2: 'Any') -> 'Tuple[Any, Any]': + """ Compares two values Args: @@ -27996,14 +26660,13 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def GetSortDescription(self,) -> 'Any': - """ - Returns value that determines how sorting options are + def GetSortDescription(self,) -> 'Any': + """ + Returns value that determines how sorting options are displayed (PDSD_*) @@ -28014,13 +26677,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetSortDescriptionLabel(self,Descending:'Any') -> 'Any': - """ + def GetSortDescriptionLabel(self, Descending: 'Any') -> 'Any': + """ Returns description of current sort order Args: @@ -28030,14 +26692,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetAggregationType(self,) -> 'Any': - """ - Describes how properties for multiple items are displayed + def GetAggregationType(self,) -> 'Any': + """ + Describes how properties for multiple items are displayed (PDAT_*) @@ -28048,14 +26709,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetConditionType(self,) -> 'Tuple[Any, Any]': - """ - Returns options that determine how the property is used + def GetConditionType(self,) -> 'Tuple[Any, Any]': + """ + Returns options that determine how the property is used to build a search query @@ -28067,19 +26727,18 @@ Returns: Tuple[Any, 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 + """ + pass - def GetEnumTypeList(self,riid:'PyIID') -> 'Any': - """ - Returns an interface used for querying + def GetEnumTypeList(self, riid: 'PyIID') -> 'Any': + """ + Returns an interface used for querying valid property range @@ -28090,14 +26749,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def CoerceToCanonicalValue(self,Value:'Any') -> 'Any': - """ - Converts a variant value to the exact type expected by + def CoerceToCanonicalValue(self, Value: 'Any') -> 'Any': + """ + Converts a variant value to the exact type expected by the property @@ -28112,13 +26770,12 @@ Returns: This method mutates the PyPROPVARIANT in place. It may be cleared on failure. Return ValueReturns the HRESULT from the operation on success. - - """ - pass + """ + pass - def FormatForDisplay(self,Value:'Any',Flags:'Any') -> 'Any': - """ + def FormatForDisplay(self, Value: 'Any', Flags: 'Any') -> 'Any': + """ Converts a value to its string representation Args: @@ -28129,14 +26786,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def IsValueCanonical(self,Value:'Any') -> 'Any': - """ - Determines if a value exactly matches the specification for + def IsValueCanonical(self, Value: 'Any') -> 'Any': + """ + Determines if a value exactly matches the specification for the property @@ -28147,21 +26803,20 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIPropertyDescriptionAliasInfo(object): - """Interface that gives access to the sorting columns for a property""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIPropertyDescriptionAliasInfo(object): + """Interface that gives access to the sorting columns for a property""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetSortByAlias(self,riid:'PyIID') -> 'Any': - """ - Returns the primary column used + def GetSortByAlias(self, riid: 'PyIID') -> 'Any': + """ + Returns the primary column used for sorting @@ -28172,14 +26827,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetAdditionalSortByAliases(self,riid:'PyIID') -> 'Any': - """ - Returns secondary + def GetAdditionalSortByAliases(self, riid: 'PyIID') -> 'Any': + """ + Returns secondary sorting columns @@ -28190,20 +26844,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIPropertyDescriptionList(object): - """Container for a number of property descriptions""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIPropertyDescriptionList(object): + """Container for a number of property descriptions""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetCount(self,) -> 'Any': - """ + def GetCount(self,) -> 'Any': + """ Gets the number of properties in the list Args: @@ -28213,13 +26866,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetAt(self,Elem:'Any',riid:'PyIID') -> 'Any': - """ + def GetAt(self, Elem: 'Any', riid: 'PyIID') -> 'Any': + """ Retrieves a description from the list Args: @@ -28230,20 +26882,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIPropertyDescriptionSearchInfo(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIPropertyDescriptionSearchInfo(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetSearchInfoFlags(self,) -> 'Any': - """ + def GetSearchInfoFlags(self,) -> 'Any': + """ Returns flags controlling how property is indexed Args: @@ -28257,13 +26908,12 @@ Returns: int = GetSearchInfoFlags()Returns flags controlling how property is indexed Return ValueReturns a combination of PROPDESC_SEARCHINFO_FLAGS values - - """ - pass + """ + pass - def GetColumnIndexType(self,) -> 'Any': - """ + def GetColumnIndexType(self,) -> 'Any': + """ Returns flags indicating type of property Args: @@ -28277,13 +26927,12 @@ Returns: int = GetColumnIndexType()Returns flags indicating type of property Return ValueReturns a value from the PROPDESC_COLUMNINDEX_TYPE enum - - """ - pass + """ + pass - def GetProjectionString(self,) -> 'Any': - """ + def GetProjectionString(self,) -> 'Any': + """ Returns the canonical name of the property Args: @@ -28293,13 +26942,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetMaxSize(self,) -> 'Any': - """ + def GetMaxSize(self,) -> 'Any': + """ Returns the maximum size specified in search options Args: @@ -28309,20 +26957,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIPropertyEnumType(object): - """Contains information about an allowable value or range for a property""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIPropertyEnumType(object): + """Contains information about an allowable value or range for a property""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetEnumType(self,) -> 'Any': - """ + def GetEnumType(self,) -> 'Any': + """ Retrieves the type (PROPENUMTYPE) Args: @@ -28336,13 +26983,12 @@ Returns: int = GetEnumType()Retrieves the type (PROPENUMTYPE) Return Valuepscon.PET_* - - """ - pass + """ + pass - def GetValue(self,) -> 'Any': - """ + def GetValue(self,) -> 'Any': + """ Retrieves the defined value Args: @@ -28352,13 +26998,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetRangeMinValue(self,) -> 'Any': - """ + def GetRangeMinValue(self,) -> 'Any': + """ Returns the minimum allowed value for the property Args: @@ -28368,13 +27013,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetRangeSetValue(self,) -> 'Any': - """ + def GetRangeSetValue(self,) -> 'Any': + """ Returns a fixed value defined for the property Args: @@ -28384,13 +27028,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetDisplayText(self,) -> 'None': - """ + def GetDisplayText(self,) -> 'None': + """ Returns the display text for the enumerated type Args: @@ -28400,20 +27043,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIPropertyEnumTypeList(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIPropertyEnumTypeList(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetCount(self,) -> 'Any': - """ + def GetCount(self,) -> 'Any': + """ Returns the number of objects in the list Args: @@ -28423,13 +27065,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetAt(self,itype:'Any',riid:'PyIID') -> 'Any': - """ + def GetAt(self, itype: 'Any', riid: 'PyIID') -> 'Any': + """ Retrieves an item by index Args: @@ -28440,14 +27081,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def FindMatchingIndex(self,Cmp:'Any') -> 'Any': - """ - Attempts to match the specified value to one of the allowable + def FindMatchingIndex(self, Cmp: 'Any') -> 'Any': + """ + Attempts to match the specified value to one of the allowable values for the property @@ -28458,22 +27098,21 @@ Args: Returns: Any - - """ - pass + + """ + 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.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - - def Create(self,fmtid:'PyIID',clsid:'PyIID',Flags:'Any',Mode:'Any') -> 'Any': - """ + def Create(self, fmtid: 'PyIID', clsid: 'PyIID', Flags: 'Any', Mode: 'Any') -> 'Any': + """ Creates a new property set in the storage object Args: @@ -28486,13 +27125,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Open(self,fmtid:'PyIID',Mode:'Any') -> 'Any': - """ + def Open(self, fmtid: 'PyIID', Mode: 'Any') -> 'Any': + """ Opens an existing property set Args: @@ -28503,13 +27141,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Delete(self,fmtid:'PyIID') -> 'None': - """ + def Delete(self, fmtid: 'PyIID') -> 'None': + """ Removes a property set from this storage object Args: @@ -28519,14 +27156,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Enum(self,) -> 'Any': - """ - Creates an iterator to enumerate contained property + def Enum(self,) -> 'Any': + """ + Creates an iterator to enumerate contained property sets @@ -28537,22 +27173,21 @@ Args: Returns: Any - - """ - pass + + """ + 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.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - - def ReadMultiple(self,props:'Tuple[Any, ...]') -> 'Tuple[Any, ...]': - """ + def ReadMultiple(self, props: 'Tuple[Any, ...]') -> 'Tuple[Any, ...]': + """ Reads specified properties from the current property set. Args: @@ -28563,13 +27198,12 @@ Returns: Tuple[Any, ...]:Sequence of property IDs or names.Return ValueReturned values are automatically converted to an appropriate python type - - """ - pass + """ + pass - def WriteMultiple(self,props:'Tuple[Any, ...]',values:'Tuple[Any, ...]',propidNameFirst:'Any'=2) -> 'None': - """ + def WriteMultiple(self, props: 'Tuple[Any, ...]', values: 'Tuple[Any, ...]', propidNameFirst: 'Any' = 2) -> 'None': + """ Creates or modifies properties in the property set Args: @@ -28581,13 +27215,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DeleteMultiple(self,props:'Tuple[Any, ...]') -> 'None': - """ + def DeleteMultiple(self, props: 'Tuple[Any, ...]') -> 'None': + """ Deletes properties from the property set Args: @@ -28597,14 +27230,13 @@ Args: Returns: None - - """ - pass + """ + pass - def ReadPropertyNames(self,props:'Tuple[Any, ...]') -> 'Tuple[Any, ...]': - """ - Retrieves any existing string names for the specified + def ReadPropertyNames(self, props: 'Tuple[Any, ...]') -> 'Tuple[Any, ...]': + """ + Retrieves any existing string names for the specified property identifiers. @@ -28615,14 +27247,13 @@ Args: Returns: Tuple[Any, ...] - - """ - pass + """ + pass - def WritePropertyNames(self,props:'Tuple[Any, ...]',names:'Tuple[str, ...]') -> 'None': - """ - Assigns string names to a specified array of property IDs in the + def WritePropertyNames(self, props: 'Tuple[Any, ...]', names: 'Tuple[str, ...]') -> 'None': + """ + Assigns string names to a specified array of property IDs in the current property set. @@ -28634,13 +27265,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DeletePropertyNames(self,props:'Tuple[Any, ...]') -> 'None': - """ + def DeletePropertyNames(self, props: 'Tuple[Any, ...]') -> 'None': + """ Removes property names from specified properties. Args: @@ -28650,13 +27280,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Commit(self,CommitFlags:'Any') -> 'None': - """ + def Commit(self, CommitFlags: 'Any') -> 'None': + """ Persists the property set to its base storage Args: @@ -28666,13 +27295,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Revert(self,) -> 'None': - """ + def Revert(self,) -> 'None': + """ Discards any changes that have been made Args: @@ -28682,13 +27310,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Enum(self,) -> 'Any': - """ + def Enum(self,) -> 'Any': + """ Creates an enumerator for properties in the property set Args: @@ -28698,13 +27325,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetTimes(self,ctime:'PyTime',atime:'PyTime',mtime:'PyTime') -> 'None': - """ + def SetTimes(self, ctime: 'PyTime', atime: 'PyTime', mtime: 'PyTime') -> 'None': + """ Sets the creation, last access, and modification time Args: @@ -28716,13 +27342,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetClass(self,clsid:'PyIID') -> 'None': - """ + def SetClass(self, clsid: 'PyIID') -> 'None': + """ Sets the GUID for the property set Args: @@ -28732,13 +27357,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Stat(self,) -> 'Any': - """ + def Stat(self,) -> 'Any': + """ Returns various infomation about the property set Args: @@ -28752,20 +27376,19 @@ Returns: tuple = Stat()Returns various infomation about the property set Return ValueReturns a tuple representing a STATPROPSETSTG struct. - - """ - pass + """ + pass -class PyIPropertyStore(object): - """Contains a collection of properties""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIPropertyStore(object): + """Contains a collection of properties""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetCount(self,) -> 'Any': - """ + def GetCount(self,) -> 'Any': + """ Returns the number of properties in the store Args: @@ -28775,13 +27398,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetAt(self,iProp:'Any') -> 'Any': - """ + def GetAt(self, iProp: 'Any') -> 'Any': + """ Returns the property key for the specified property Args: @@ -28791,13 +27413,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetValue(self,Key:'Any') -> 'Any': - """ + def GetValue(self, Key: 'Any') -> 'Any': + """ Retrieves the value of a property Args: @@ -28807,13 +27428,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetValue(self,Key:'Any',Value:'Any') -> 'None': - """ + def SetValue(self, Key: 'Any', Value: 'Any') -> 'None': + """ Sets the value of a property Args: @@ -28824,13 +27444,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Commit(self,) -> 'None': - """ + def Commit(self,) -> 'None': + """ Commits property changes Args: @@ -28840,20 +27459,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIPropertyStoreCache(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIPropertyStoreCache(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetState(self,key:'Any') -> 'Any': - """ + def GetState(self, key: 'Any') -> 'Any': + """ Retrieves the current state of a property Args: @@ -28864,14 +27482,13 @@ Returns: Any:Property identifierReturn ValueA value from the PSC_STATE enum (PSC_NORMAL, PSC_NOTINSOURCE. PSC_DIRTY) - - """ - pass + """ + pass - def GetValueAndState(self,key:'Any') -> 'Tuple[Any, Any]': - """ - Retrieves the current value and state of a + def GetValueAndState(self, key: 'Any') -> 'Tuple[Any, Any]': + """ + Retrieves the current value and state of a property @@ -28882,13 +27499,12 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def SetState(self,key:'Any',state:'Any') -> 'None': - """ + def SetState(self, key: 'Any', state: 'Any') -> 'None': + """ Sets the state of a property Args: @@ -28899,13 +27515,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetValueAndState(self,key:'Any',value:'Any',state:'Any') -> 'None': - """ + def SetValueAndState(self, key: 'Any', value: 'Any', state: 'Any') -> 'None': + """ Sets the value and state of a property Args: @@ -28917,22 +27532,21 @@ Args: Returns: None - - """ - pass + + """ + 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.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - - def IsPropertyWritable(self,key:'Any') -> 'Any': - """ + def IsPropertyWritable(self, key: 'Any') -> 'Any': + """ Asks provider if a property can be editted. Args: @@ -28942,21 +27556,20 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIPropertySystem(object): - """Wraps the IPropertySystem interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIPropertySystem(object): + """Wraps the IPropertySystem interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetPropertyDescription(self,Key:'Any',riid:'PyIID') -> 'Any': - """ - Returns an interface used to describe a + def GetPropertyDescription(self, Key: 'Any', riid: 'PyIID') -> 'Any': + """ + Returns an interface used to describe a property @@ -28968,14 +27581,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetPropertyDescriptionByName(self,CanonicalName:'Any',riid:'PyIID') -> 'Any': - """ - Returns an interface used to + def GetPropertyDescriptionByName(self, CanonicalName: 'Any', riid: 'PyIID') -> 'Any': + """ + Returns an interface used to describe a property @@ -28987,14 +27599,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetPropertyDescriptionListFromString(self,PropList:'Any',riid:'PyIID') -> 'Any': - """ - Retrieves property + def GetPropertyDescriptionListFromString(self, PropList: 'Any', riid: 'PyIID') -> 'Any': + """ + Retrieves property descriptions from a string of property names @@ -29006,14 +27617,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def EnumeratePropertyDescriptions(self,Filter:'Any',riid:'PyIID') -> 'Any': - """ - Returns an interface used to + def EnumeratePropertyDescriptions(self, Filter: 'Any', riid: 'PyIID') -> 'Any': + """ + Returns an interface used to list defined properties @@ -29025,13 +27635,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def FormatForDisplay(self,Key:'Any',Value:'Any',Flags:'Any') -> 'Any': - """ + def FormatForDisplay(self, Key: 'Any', Value: 'Any', Flags: 'Any') -> 'Any': + """ Formats a property into a string Args: @@ -29043,13 +27652,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def RegisterPropertySchema(self,Path:'Any') -> 'None': - """ + def RegisterPropertySchema(self, Path: 'Any') -> 'None': + """ Registers a set of properties defined in a .propdesc file Args: @@ -29059,13 +27667,12 @@ Args: Returns: None - - """ - pass + """ + pass - def UnregisterPropertySchema(self,Path:'Any') -> 'None': - """ + def UnregisterPropertySchema(self, Path: 'Any') -> 'None': + """ Removes a set of registered properties Args: @@ -29075,13 +27682,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RefreshPropertySchema(self,) -> 'None': - """ + def RefreshPropertySchema(self,) -> 'None': + """ Not currently implemented by the OS Args: @@ -29091,20 +27697,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIProvideClassInfo(object): - """A Python interface to IProvideClassInfo""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIProvideClassInfo(object): + """A Python interface to IProvideClassInfo""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetClassInfo(self,) -> 'Any': - """ + def GetClassInfo(self,) -> 'Any': + """ Gets information about the CO_CLASS. Args: @@ -29114,20 +27719,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIProvideClassInfo2(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIProvideClassInfo2(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetGUID(self,flags:'Any') -> 'PyIID': - """ + def GetGUID(self, flags: 'Any') -> 'PyIID': + """ Gets the GUID for the object. Args: @@ -29137,20 +27741,19 @@ Args: Returns: PyIID - - """ - pass + """ + pass -class PyIProvideExpressionContexts(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIProvideExpressionContexts(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def EnumExpressionContexts(self,) -> 'None': - """ + def EnumExpressionContexts(self,) -> 'None': + """ Description of EnumStackFrames. Args: @@ -29160,21 +27763,20 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIProvideTaskPage(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIProvideTaskPage(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetPage(self,tpType:'Any',PersistChanges:'Any') -> 'None': - """ - Return a property sheet page handle for the spedified type + def GetPage(self, tpType: 'Any', PersistChanges: 'Any') -> 'None': + """ + Return a property sheet page handle for the spedified type (TASKPAGE_TASK,TASKPAGE_SCHEDULE,TASKPAGE_SETTINGS) @@ -29186,21 +27788,20 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIQueryAssociations(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIQueryAssociations(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Init(self,flags:'Any',assoc:'str',hkeyProgId:'PyHKEY'=None,hwnd:'int'=None) -> 'None': - """ - Initializes the IQueryAssociations interface and sets the root key to the + def Init(self, flags: 'Any', assoc: 'str', hkeyProgId: 'PyHKEY' = None, hwnd: 'int' = None) -> 'None': + """ + Initializes the IQueryAssociations interface and sets the root key to the appropriate ProgID. @@ -29214,14 +27815,13 @@ Args: Returns: None - - """ - pass + """ + pass - def GetKey(self,flags:'Any',assocKey:'Any',arg:'str') -> 'Any': - """ - Searches for and retrieves a file association-related key from the + def GetKey(self, flags: 'Any', assocKey: 'Any', arg: 'str') -> 'Any': + """ + Searches for and retrieves a file association-related key from the registry. @@ -29234,14 +27834,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetString(self,flags:'Any',assocStr:'Any',arg:'str') -> 'Any': - """ - Searches for and retrieves a file association-related string from the + def GetString(self, flags: 'Any', assocStr: 'Any', arg: 'str') -> 'Any': + """ + Searches for and retrieves a file association-related string from the registry. @@ -29254,22 +27853,21 @@ Args: Returns: Any - - """ - pass + + """ + 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.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - - def GetItemIDList(self,) -> 'Any': - """ + def GetItemIDList(self,) -> 'Any': + """ Returns the ID list of the related item Args: @@ -29279,13 +27877,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetItem(self,) -> 'Any': - """ + def GetItem(self,) -> 'Any': + """ Returns the related item Args: @@ -29295,20 +27892,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIRemoteDebugApplication(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIRemoteDebugApplication(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def ResumeFromBreakPoint(self,prptFocus:'Any',bra:'Any',era:'Any') -> 'None': - """ + def ResumeFromBreakPoint(self, prptFocus: 'Any', bra: 'Any', era: 'Any') -> 'None': + """ Continue an application which is currently in a breakpoint. Args: @@ -29320,14 +27916,13 @@ Args: Returns: None - - """ - pass + """ + pass - def CauseBreak(self,) -> 'None': - """ - Causes the application to break into the debugger at the earliest + def CauseBreak(self,) -> 'None': + """ + Causes the application to break into the debugger at the earliest opportunity. @@ -29338,13 +27933,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ConnectDebugger(self,pad:'Any') -> 'None': - """ + def ConnectDebugger(self, pad: 'Any') -> 'None': + """ Connects a debugger to the application. Args: @@ -29354,13 +27948,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DisconnectDebugger(self,) -> 'None': - """ + def DisconnectDebugger(self,) -> 'None': + """ Disconnects the current debugger from the application. Args: @@ -29370,14 +27963,13 @@ Args: Returns: None - - """ - pass + """ + pass - def GetDebugger(self,) -> 'Any': - """ - Returns the current debugger connected to + def GetDebugger(self,) -> 'Any': + """ + Returns the current debugger connected to the application. @@ -29388,14 +27980,18 @@ Args: Returns: Any - - """ - pass + """ + pass - def CreateInstanceAtApplication(self,rclsid:'PyIID',pUnkOuter:'Any',dwClsContext:'Any',riid:'PyIID') -> 'Any': - """ - Create objects in the application + def CreateInstanceAtApplication( + self, + rclsid: 'PyIID', + pUnkOuter: 'Any', + dwClsContext: 'Any', + riid: 'PyIID') -> 'Any': + """ + Create objects in the application process address space. @@ -29409,13 +28005,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def QueryAlive(self,) -> 'None': - """ + def QueryAlive(self,) -> 'None': + """ Returns True if alive, else False. Args: @@ -29425,14 +28020,13 @@ Args: Returns: None - - """ - pass + """ + pass - def EnumThreads(self,) -> 'Any': - """ - Enumerates all threads known + def EnumThreads(self,) -> 'Any': + """ + Enumerates all threads known to be associated with the application. @@ -29443,13 +28037,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetName(self,) -> 'None': - """ + def GetName(self,) -> 'None': + """ Description of GetName. Args: @@ -29459,14 +28052,13 @@ Args: Returns: None - - """ - pass + """ + pass - def GetRootNode(self,) -> 'Any': - """ - Returns the application node under which + def GetRootNode(self,) -> 'Any': + """ + Returns the application node under which all nodes associated with the application are added. @@ -29477,14 +28069,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def EnumGlobalExpressionContexts(self,) -> 'Any': - """ - Enumerates all + def EnumGlobalExpressionContexts(self,) -> 'Any': + """ + Enumerates all global expression contexts @@ -29495,20 +28086,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIRemoteDebugApplicationEvents(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIRemoteDebugApplicationEvents(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def OnConnectDebugger(self,pad:'Any') -> 'None': - """ + def OnConnectDebugger(self, pad: 'Any') -> 'None': + """ Description of OnConnectDebugger. Args: @@ -29518,13 +28108,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnDisconnectDebugger(self,) -> 'None': - """ + def OnDisconnectDebugger(self,) -> 'None': + """ Description of OnDisconnectDebugger. Args: @@ -29534,13 +28123,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnSetName(self,pstrName:'Any') -> 'None': - """ + def OnSetName(self, pstrName: 'Any') -> 'None': + """ Description of OnSetName. Args: @@ -29550,13 +28138,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnDebugOutput(self,pstr:'Any') -> 'None': - """ + def OnDebugOutput(self, pstr: 'Any') -> 'None': + """ Description of OnDebugOutput. Args: @@ -29566,13 +28153,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnClose(self,) -> 'None': - """ + def OnClose(self,) -> 'None': + """ Description of OnClose. Args: @@ -29582,13 +28168,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnEnterBreakPoint(self,prdat:'Any') -> 'None': - """ + def OnEnterBreakPoint(self, prdat: 'Any') -> 'None': + """ Description of OnEnterBreakPoint. Args: @@ -29598,13 +28183,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnLeaveBreakPoint(self,prdat:'Any') -> 'None': - """ + def OnLeaveBreakPoint(self, prdat: 'Any') -> 'None': + """ Description of OnLeaveBreakPoint. Args: @@ -29614,13 +28198,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnCreateThread(self,prdat:'Any') -> 'None': - """ + def OnCreateThread(self, prdat: 'Any') -> 'None': + """ Description of OnCreateThread. Args: @@ -29630,13 +28213,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnDestroyThread(self,prdat:'Any') -> 'None': - """ + def OnDestroyThread(self, prdat: 'Any') -> 'None': + """ Description of OnDestroyThread. Args: @@ -29646,13 +28228,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnBreakFlagChange(self,abf:'Any',prdatSteppingThread:'Any') -> 'None': - """ + def OnBreakFlagChange(self, abf: 'Any', prdatSteppingThread: 'Any') -> 'None': + """ Description of OnBreakFlagChange. Args: @@ -29663,20 +28244,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIRemoteDebugApplicationThread(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIRemoteDebugApplicationThread(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetSystemThreadId(self,) -> 'None': - """ + def GetSystemThreadId(self,) -> 'None': + """ Description of GetSystemThreadId. Args: @@ -29686,13 +28266,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetApplication(self,) -> 'None': - """ + def GetApplication(self,) -> 'None': + """ Description of GetApplication. Args: @@ -29702,13 +28281,12 @@ Args: Returns: None - - """ - pass + """ + pass - def EnumStackFrames(self,) -> 'None': - """ + def EnumStackFrames(self,) -> 'None': + """ Description of EnumStackFrames. Args: @@ -29718,13 +28296,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetDescription(self,) -> 'None': - """ + def GetDescription(self,) -> 'None': + """ Description of GetDescription. Args: @@ -29734,13 +28311,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetNextStatement(self,pStackFrame:'Any',pCodeContext:'Any') -> 'None': - """ + def SetNextStatement(self, pStackFrame: 'Any', pCodeContext: 'Any') -> 'None': + """ Description of SetNextStatement. Args: @@ -29751,13 +28327,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetState(self,) -> 'None': - """ + def GetState(self,) -> 'None': + """ Description of GetState. Args: @@ -29767,13 +28342,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Suspend(self,) -> 'None': - """ + def Suspend(self,) -> 'None': + """ Description of Suspend. Args: @@ -29783,13 +28357,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Resume(self,) -> 'None': - """ + def Resume(self,) -> 'None': + """ Description of Resume. Args: @@ -29799,13 +28372,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetSuspendCount(self,) -> 'None': - """ + def GetSuspendCount(self,) -> 'None': + """ Description of GetSuspendCount. Args: @@ -29815,21 +28387,20 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIRunningObjectTable(object): - """A Python interface to IRunningObjectTable""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIRunningObjectTable(object): + """A Python interface to IRunningObjectTable""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Register(self,) -> 'Any': - """ - Registers an object and its identifying moniker in the Running Object + def Register(self,) -> 'Any': + """ + Registers an object and its identifying moniker in the Running Object Table (ROT). @@ -29840,13 +28411,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Revoke(self,) -> 'Any': - """ + def Revoke(self,) -> 'Any': + """ None Args: @@ -29856,13 +28426,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def IsRunning(self,objectName:'Any') -> 'Any': - """ + def IsRunning(self, objectName: 'Any') -> 'Any': + """ Checks whether an object is running. Args: @@ -29872,13 +28441,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetObject(self,objectName:'Any') -> 'Any': - """ + def GetObject(self, objectName: 'Any') -> 'Any': + """ Checks whether an object is running. Args: @@ -29888,14 +28456,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def EnumRunning(self,) -> 'Any': - """ - Creates an enumerator that can list the monikers of + def EnumRunning(self,) -> 'Any': + """ + Creates an enumerator that can list the monikers of all the objects currently registered in the Running Object Table (ROT). @@ -29906,21 +28473,20 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIScheduledWorkItem(object): - """Python object that encapsulates the IScheduledWorkItem interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIScheduledWorkItem(object): + """Python object that encapsulates the IScheduledWorkItem interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def CreateTrigger(self,) -> 'Tuple[Any, Any]': - """ - Creates a new trigger for a task, returns index and + def CreateTrigger(self,) -> 'Tuple[Any, Any]': + """ + Creates a new trigger for a task, returns index and new ITaskTrigger interface @@ -29931,13 +28497,12 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def DeleteTrigger(self,Trigger:'Any') -> 'None': - """ + def DeleteTrigger(self, Trigger: 'Any') -> 'None': + """ Deletes specified trigger Args: @@ -29947,13 +28512,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetTriggerCount(self,) -> 'Any': - """ + def GetTriggerCount(self,) -> 'Any': + """ Returns number of triggers defined for the task Args: @@ -29963,14 +28527,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetTrigger(self,iTrigger:'Any') -> 'Any': - """ - Retrieves ITaskTrigger interface for specified trigger + def GetTrigger(self, iTrigger: 'Any') -> 'Any': + """ + Retrieves ITaskTrigger interface for specified trigger index @@ -29981,13 +28544,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetTriggerString(self,) -> 'Any': - """ + def GetTriggerString(self,) -> 'Any': + """ Creates a human-readable summary of specified trigger Args: @@ -29997,14 +28559,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetRunTimes(self,Count:'Any',Begin:'PyTime',End:'PyTime') -> 'Tuple[PyTime, Any, Any, Any]': - """ - Return specified number of run times within given time + def GetRunTimes(self, Count: 'Any', Begin: 'PyTime', End: 'PyTime') -> 'Tuple[PyTime, Any, Any, Any]': + """ + Return specified number of run times within given time frame @@ -30017,13 +28578,12 @@ Args: Returns: Tuple[PyTime, Any, Any, Any] - - """ - pass + """ + pass - def GetNextRunTime(self,) -> 'PyTime': - """ + def GetNextRunTime(self,) -> 'PyTime': + """ Returns next time that task is scheduled to run Args: @@ -30033,13 +28593,12 @@ Args: Returns: PyTime - - """ - pass + """ + pass - def SetIdleWait(self,wIdleMinutes:'Any',wDeadlineMinutes:'Any') -> 'None': - """ + def SetIdleWait(self, wIdleMinutes: 'Any', wDeadlineMinutes: 'Any') -> 'None': + """ Sets idle parms for task with trigger of type TASK_EVENT_TRIGGER_ON_IDLE Args: @@ -30050,14 +28609,13 @@ Args: Returns: None - - """ - pass + """ + pass - def GetIdleWait(self,) -> 'Tuple[Any, Any]': - """ - Gets IdleMinutes and DeadlineMinutes parms for task with trigger + def GetIdleWait(self,) -> 'Tuple[Any, Any]': + """ + Gets IdleMinutes and DeadlineMinutes parms for task with trigger of type TASK_EVENT_TRIGGER_ON_IDLE @@ -30068,13 +28626,12 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def Run(self,) -> 'None': - """ + def Run(self,) -> 'None': + """ Starts task Args: @@ -30084,13 +28641,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Terminate(self,) -> 'None': - """ + def Terminate(self,) -> 'None': + """ Terminate process if task is running Args: @@ -30100,13 +28656,12 @@ Args: Returns: None - - """ - pass + """ + pass - def EditWorkItem(self,hParent:'int',dwReserved:'Any') -> 'None': - """ + def EditWorkItem(self, hParent: 'int', dwReserved: 'Any') -> 'None': + """ Brings up standard Scheduled Task dialog Args: @@ -30117,13 +28672,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetMostRecentRunTime(self,) -> 'PyTime': - """ + def GetMostRecentRunTime(self,) -> 'PyTime': + """ Returns last time task ran Args: @@ -30133,13 +28687,12 @@ Args: Returns: PyTime - - """ - pass + """ + pass - def GetStatus(self,) -> 'Any': - """ + def GetStatus(self,) -> 'Any': + """ Returns status (SCHED_S_TASK... constants) Args: @@ -30149,14 +28702,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetExitCode(self,) -> 'Tuple[Any, Any]': - """ - Returns tuple of task's exit code and error returned to Task + def GetExitCode(self,) -> 'Tuple[Any, Any]': + """ + Returns tuple of task's exit code and error returned to Task Scheduler if process could not start @@ -30167,13 +28719,12 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def SetComment(self,Comment:'Any') -> 'None': - """ + def SetComment(self, Comment: 'Any') -> 'None': + """ Set comment string for task Args: @@ -30183,13 +28734,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetComment(self,) -> 'str': - """ + def GetComment(self,) -> 'str': + """ Return comment string associated with task. Args: @@ -30199,13 +28749,12 @@ Args: Returns: str - - """ - pass + """ + pass - def SetCreator(self,Creator:'Any') -> 'None': - """ + def SetCreator(self, Creator: 'Any') -> 'None': + """ Specify who (or what) created task, can be any string Args: @@ -30215,13 +28764,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetCreator(self,) -> 'None': - """ + def GetCreator(self,) -> 'None': + """ Returns creator info, can be any string data Args: @@ -30231,13 +28779,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetWorkItemData(self,Data:'str') -> 'None': - """ + def SetWorkItemData(self, Data: 'str') -> 'None': + """ Set data associated with task (treated as uninterpreted bytes) Args: @@ -30247,13 +28794,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetWorkItemData(self,) -> 'str': - """ + def GetWorkItemData(self,) -> 'str': + """ Retrieve data associated with task Args: @@ -30263,14 +28809,13 @@ Args: Returns: str - - """ - pass + """ + pass - def SetErrorRetryCount(self,wRetryCount:'Any') -> 'None': - """ - Specify nbr of times to attempt to run task if it can't start (not + def SetErrorRetryCount(self, wRetryCount: 'Any') -> 'None': + """ + Specify nbr of times to attempt to run task if it can't start (not currently implemented) @@ -30281,14 +28826,13 @@ Args: Returns: None - - """ - pass + """ + pass - def GetErrorRetryCount(self,) -> 'None': - """ - Return nbr of times Task scheduler should try to run task (not + def GetErrorRetryCount(self,) -> 'None': + """ + Return nbr of times Task scheduler should try to run task (not currently implemented) @@ -30299,14 +28843,13 @@ Args: Returns: None - - """ - pass + """ + pass - def SetErrorRetryInterval(self,RetryInterval:'Any') -> 'None': - """ - Interval in minutes between attempts to run task. Not + def SetErrorRetryInterval(self, RetryInterval: 'Any') -> 'None': + """ + Interval in minutes between attempts to run task. Not implemented according to SDK @@ -30317,14 +28860,13 @@ Args: Returns: None - - """ - pass + """ + pass - def GetErrorRetryInterval(self,) -> 'None': - """ - Returns nbr of minutes between attempts to run task. Not + def GetErrorRetryInterval(self,) -> 'None': + """ + Returns nbr of minutes between attempts to run task. Not implemented according to SDK @@ -30335,13 +28877,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetFlags(self,dwFlags:'Any') -> 'None': - """ + def SetFlags(self, dwFlags: 'Any') -> 'None': + """ Set flags for task Args: @@ -30351,13 +28892,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetFlags(self,) -> 'Any': - """ + def GetFlags(self,) -> 'Any': + """ Returns flags for task (TASK_FLAG_* constants) Args: @@ -30367,13 +28907,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetAccountInformation(self,AccountName:'Any',Password:'Any') -> 'None': - """ + def SetAccountInformation(self, AccountName: 'Any', Password: 'Any') -> 'None': + """ Set username and password under which task will run Args: @@ -30384,13 +28923,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetAccountInformation(self,) -> 'Any': - """ + def GetAccountInformation(self,) -> 'Any': + """ Returns username that task will run under Args: @@ -30400,20 +28938,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIServerSecurity(object): - """Interface used to access client security settings and perform impersonation""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIServerSecurity(object): + """Interface used to access client security settings and perform impersonation""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def QueryBlanket(self,Capabilities:'Any'=0) -> 'Any': - """ + def QueryBlanket(self, Capabilities: 'Any' = 0) -> 'Any': + """ Retrieves security settings specified by the client Args: @@ -30423,13 +28960,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def ImpersonateClient(self,) -> 'None': - """ + def ImpersonateClient(self,) -> 'None': + """ Initiates impersonation of client Args: @@ -30439,13 +28975,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RevertToSelf(self,) -> 'None': - """ + def RevertToSelf(self,) -> 'None': + """ Ends impersonation of client Args: @@ -30455,13 +28990,12 @@ Args: Returns: None - - """ - pass + """ + pass - def IsImpersonating(self,) -> 'Any': - """ + def IsImpersonating(self,) -> 'Any': + """ Determines if server is currently impersonating a client Args: @@ -30471,21 +29005,20 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIServiceProvider(object): - """A Python interface to IServiceProvider""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIServiceProvider(object): + """A Python interface to IServiceProvider""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def QueryService(self,clsid:'PyIID',iid:'PyIID') -> 'Any': - """ - Creates or accesses the specified service and returns an + def QueryService(self, clsid: 'PyIID', iid: 'PyIID') -> 'Any': + """ + Creates or accesses the specified service and returns an interface object to the specified interface for the service. @@ -30497,22 +29030,21 @@ Args: Returns: Any - - """ - pass + + """ + 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.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - - def InsertMenusSB(self,hmenuShared:'int',lpMenuWidths:'Any') -> 'Any': - """ + def InsertMenusSB(self, hmenuShared: 'int', lpMenuWidths: 'Any') -> 'Any': + """ Updates a composite menu with container's options Args: @@ -30523,13 +29055,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetMenuSB(self,hmenuShared:'int',holemenuRes:'int',hwndActiveObject:'int') -> 'None': - """ + def SetMenuSB(self, hmenuShared: 'int', holemenuRes: 'int', hwndActiveObject: 'int') -> 'None': + """ Attaches a shared menu to a shell view window Args: @@ -30541,13 +29072,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RemoveMenusSB(self,hmenuShared:'int') -> 'None': - """ + def RemoveMenusSB(self, hmenuShared: 'int') -> 'None': + """ Asks container to remove any items it added to a composite menu Args: @@ -30557,13 +29087,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetStatusTextSB(self,pszStatusText:'Any') -> 'None': - """ + def SetStatusTextSB(self, pszStatusText: 'Any') -> 'None': + """ Sets the status text in view's status bar Args: @@ -30573,13 +29102,12 @@ Args: Returns: None - - """ - pass + """ + pass - def EnableModelessSB(self,fEnable:'Any') -> 'None': - """ + def EnableModelessSB(self, fEnable: 'Any') -> 'None': + """ Enables or disables modeless dialogs Args: @@ -30589,13 +29117,12 @@ Args: Returns: None - - """ - pass + """ + pass - def TranslateAcceleratorSB(self,pmsg:'PyMSG',wID:'Any') -> 'None': - """ + def TranslateAcceleratorSB(self, pmsg: 'PyMSG', wID: 'Any') -> 'None': + """ Translates keystrokes used as menu item activators Args: @@ -30606,13 +29133,12 @@ Args: Returns: None - - """ - pass + """ + pass - def BrowseObject(self,pidl:'Any',wFlags:'Any') -> 'None': - """ + def BrowseObject(self, pidl: 'Any', wFlags: 'Any') -> 'None': + """ Navigates to a different location Args: @@ -30623,14 +29149,13 @@ Args: Returns: None - - """ - pass + """ + pass - def GetViewStateStream(self,grfMode:'Any') -> 'Any': - """ - Returns a stream that can be used to access view state + def GetViewStateStream(self, grfMode: 'Any') -> 'Any': + """ + Returns a stream that can be used to access view state information @@ -30641,13 +29166,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetControlWindow(self,_id:'Any') -> 'None': - """ + def GetControlWindow(self, _id: 'Any') -> 'None': + """ Returns a handle to one of the browser's control elements Args: @@ -30657,13 +29181,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SendControlMsg(self,_id:'Any',uMsg:'Any',wParam:'Any',lParam:'Any') -> 'Any': - """ + def SendControlMsg(self, _id: 'Any', uMsg: 'Any', wParam: 'Any', lParam: 'Any') -> 'Any': + """ Sends a control msg to browser's toolbar or status bar Args: @@ -30676,13 +29199,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def QueryActiveShellView(self,) -> 'Any': - """ + def QueryActiveShellView(self,) -> 'Any': + """ Returns the currently displayed view Args: @@ -30692,13 +29214,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OnViewWindowActive(self,pshv:'Any') -> 'None': - """ + def OnViewWindowActive(self, pshv: 'Any') -> 'None': + """ Callback triggered when a view window is activated Args: @@ -30708,13 +29229,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetToolbarItems(self,lpButtons:'Any',uFlags:'Any') -> 'None': - """ + def SetToolbarItems(self, lpButtons: 'Any', uFlags: 'Any') -> 'None': + """ Adds toolbar buttons to the browser's toolbar Args: @@ -30725,20 +29245,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIShellExtInit(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIShellExtInit(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Initialize(self,pFolder:'Any',pDataObject:'Any',hkey:'int') -> 'None': - """ + def Initialize(self, pFolder: 'Any', pDataObject: 'Any', hkey: 'int') -> 'None': + """ Description of Initialize. Args: @@ -30750,20 +29269,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIShellFolder(object): - """Interface that represents an Explorer folder""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIShellFolder(object): + """Interface that represents an Explorer folder""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def ParseDisplayName(self,hwndOwner:'int',pbc:'Any',DisplayName:'Any',Attributes:'Any'=0) -> 'Any': - """ + def ParseDisplayName(self, hwndOwner: 'int', pbc: 'Any', DisplayName: 'Any', Attributes: 'Any' = 0) -> 'Any': + """ Returns the PIDL of an item in a shell folder Args: @@ -30784,13 +29302,12 @@ specifies the relative path from the parsing folder to the object [2] int : Attributes returns any requested attributes - - """ - pass + """ + pass - def EnumObjects(self,grfFlags:'Any',hwndOwner:'int'=None) -> 'Any': - """ + def EnumObjects(self, grfFlags: 'Any', hwndOwner: 'int' = None) -> 'Any': + """ Creates an enumerator to list the contents of the shell folder Args: @@ -30801,13 +29318,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def BindToObject(self,pidl:'Any',pbc:'Any',riid:'PyIID') -> 'Any': - """ + def BindToObject(self, pidl: 'Any', pbc: 'Any', riid: 'PyIID') -> 'Any': + """ Returns an IShellFolder interface for a subfolder Args: @@ -30819,13 +29335,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def BindToStorage(self,pidl:'Any',pbc:'Any',riid:'PyIID') -> 'Any': - """ + def BindToStorage(self, pidl: 'Any', pbc: 'Any', riid: 'PyIID') -> 'Any': + """ Returns an interface to a storage object in a shell folder Args: @@ -30838,13 +29353,12 @@ Returns: 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 + """ + pass - def CompareIDs(self,lparam:'Any',pidl1:'Any',pidl2:'Any') -> 'Any': - """ + def CompareIDs(self, lparam: 'Any', pidl1: 'Any', pidl2: 'Any') -> 'Any': + """ Determines the sorting order of 2 items in shell folder Args: @@ -30857,13 +29371,12 @@ Returns: 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 + """ + pass - def CreateViewObject(self,hwndOwner:'Any',riid:'PyIID') -> 'Any': - """ + def CreateViewObject(self, hwndOwner: 'Any', riid: 'PyIID') -> 'Any': + """ Creates a view object for a shell folder. Args: @@ -30874,13 +29387,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetAttributesOf(self,pidl:'Tuple[Any, ...]',rgfInOut:'Any') -> 'Any': - """ + def GetAttributesOf(self, pidl: 'Tuple[Any, ...]', rgfInOut: 'Any') -> 'Any': + """ Queries attributes of items within the shell folder Args: @@ -30892,14 +29404,19 @@ Returns: Any:Combination of shellcon.SFGAO_* constantsReturn ValueThe requested attributes are only returned if they are common to all of the specified items - - """ - pass + """ + pass - def GetUIObjectOf(self,hwndOwner:'int',pidl:'Tuple[Any, ...]',riid:'PyIID',iidout:'PyIID',Reserved:'Any'=0) -> 'Tuple[Any, Any]': - """ - Creates an interface to one or more items in a shell + def GetUIObjectOf( + self, + hwndOwner: 'int', + pidl: 'Tuple[Any, ...]', + riid: 'PyIID', + iidout: 'PyIID', + Reserved: 'Any' = 0) -> 'Tuple[Any, Any]': + """ + Creates an interface to one or more items in a shell folder @@ -30913,22 +29430,21 @@ Args: Returns: - Tuple[Any, Any]:The interface to return. Can be used in the case where there is not a + Tuple[Any, Any]: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 + """ + pass - def GetDisplayNameOf(self,pidl:'Any',uFlags:'Any') -> 'Any': - """ + def GetDisplayNameOf(self, pidl: 'Any', uFlags: 'Any') -> 'Any': + """ Returns the display name of an item within this shell folder Args: @@ -30939,13 +29455,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetNameOf(self,hwndOwner:'Any',pidl:'Any',Name:'Any',Flags:'Any') -> 'Any': - """ + def SetNameOf(self, hwndOwner: 'Any', pidl: 'Any', Name: 'Any', Flags: 'Any') -> 'Any': + """ Sets the display name of an item and changes its PIDL Args: @@ -30959,20 +29474,19 @@ Returns: Any:Combination of shellcon.SHGDM_* valuesReturn ValueReturns the new PIDL for item - - """ - pass + """ + pass -class PyIShellFolder2(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIShellFolder2(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetDefaultSearchGUID(self,pguid:'PyIID') -> 'PyIID': - """ + def GetDefaultSearchGUID(self, pguid: 'PyIID') -> 'PyIID': + """ Retrieves the default search for the folder Args: @@ -30982,14 +29496,13 @@ Args: Returns: PyIID - - """ - pass + """ + pass - def EnumSearches(self,) -> 'Any': - """ - Returns an interface that lists searches defined for + def EnumSearches(self,) -> 'Any': + """ + Returns an interface that lists searches defined for the folder @@ -31000,13 +29513,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetDefaultColumn(self,) -> 'Tuple[Any, Any]': - """ + def GetDefaultColumn(self,) -> 'Tuple[Any, Any]': + """ Returns the columns used for sorting and display Args: @@ -31016,13 +29528,12 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def GetDefaultColumnState(self,iColumn:'Any') -> 'Any': - """ + def GetDefaultColumnState(self, iColumn: 'Any') -> 'Any': + """ Returns flags indicating the default behaviour of the column Args: @@ -31033,13 +29544,12 @@ Returns: Any:Zero-based index of the columnReturn ValueReturns a combination of shellcon.SHCOLSTATE_* flags - - """ - pass + """ + pass - def GetDetailsEx(self,pidl:'Any',pscid:'Any') -> 'Any': - """ + def GetDetailsEx(self, pidl: 'Any', pscid: 'Any') -> 'Any': + """ Returns the details of an item by Column ID Args: @@ -31051,14 +29561,13 @@ Returns: 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 + """ + pass - def GetDetailsOf(self,pidl:'Any',iColumn:'Any') -> 'Tuple[Any, Any, Any]': - """ - Returns the value or title of a column in the folder's Details + def GetDetailsOf(self, pidl: 'Any', iColumn: 'Any') -> 'Tuple[Any, Any, Any]': + """ + Returns the value or title of a column in the folder's Details view. @@ -31069,19 +29578,18 @@ Args: Returns: - Tuple[Any, Any, Any]:Zero based index of columnReturn ValueReturns a tuple representing a SHELLDETAILS struct, containing the formst (LVCFMT_*), column width in + Tuple[Any, Any, 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 + """ + pass - def MapColumnToSCID(self,Column:'Any') -> 'Any': - """ + def MapColumnToSCID(self, Column: 'Any') -> 'Any': + """ Returns the unique identifier (FMTID, pid) of a column Args: @@ -31090,24 +29598,23 @@ Args: Returns: - 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. + 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 + """ + pass -class PyIShellIcon(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIShellIcon(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetIconOf(self,pidl:'Any') -> 'None': - """ + def GetIconOf(self, pidl: 'Any') -> 'None': + """ Description of GetIconOf. Args: @@ -31117,20 +29624,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIShellIconOverlay(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIShellIconOverlay(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetOverlayIndex(self,pidl:'Any') -> 'None': - """ + def GetOverlayIndex(self, pidl: 'Any') -> 'None': + """ Description of GetOverlayIndex. Args: @@ -31140,13 +29646,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetOverlayIconIndex(self,pidl:'Any') -> 'None': - """ + def GetOverlayIconIndex(self, pidl: 'Any') -> 'None': + """ Description of GetOverlayIconIndex. Args: @@ -31156,20 +29661,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIShellIconOverlayIdentifier(object): - """Interface that supplies icon overlay information to the shell""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIShellIconOverlayIdentifier(object): + """Interface that supplies icon overlay information to the shell""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def IsMemberOf(self,path:'str',attrib:'Any') -> 'Any': - """ + def IsMemberOf(self, path: 'str', attrib: 'Any') -> 'Any': + """ Determines if a shell object should have an icon overlay Args: @@ -31179,22 +29683,21 @@ Args: Returns: - Any:Shell attributes, combination of shellcon.SFGAO_* flagsReturn ValueThe gateway implementation of this function should return winerror.S_OK to + 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 + """ + pass - def GetOverlayInfo(self,) -> 'Tuple[str, Any, Any]': - """ - Retrieves the path to the overlay + def GetOverlayInfo(self,) -> 'Tuple[str, Any, Any]': + """ + Retrieves the path to the overlay icon @@ -31206,20 +29709,19 @@ Returns: Tuple[str, Any, 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 + """ + pass - def GetPriority(self,) -> 'Any': - """ + def GetPriority(self,) -> 'Any': + """ Retrieves the relative priority of the overlay Args: @@ -31233,21 +29735,20 @@ 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 + """ + pass -class PyIShellIconOverlayManager(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIShellIconOverlayManager(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetFileOverlayInfo(self,path:'Any',attrib:'Any',flags:'Any') -> 'Any': - """ - Returns an index into the system image list for the icon + def GetFileOverlayInfo(self, path: 'Any', attrib: 'Any', flags: 'Any') -> 'Any': + """ + Returns an index into the system image list for the icon image or overlay image @@ -31260,13 +29761,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetReservedOverlayInfo(self,path:'Any',attrib:'Any',flags:'Any',ireservedID:'Any') -> 'None': - """ + def GetReservedOverlayInfo(self, path: 'Any', attrib: 'Any', flags: 'Any', ireservedID: 'Any') -> 'None': + """ Description of GetReservedOverlayInfo. Args: @@ -31279,13 +29779,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RefreshOverlayImages(self,flags:'Any') -> 'None': - """ + def RefreshOverlayImages(self, flags: 'Any') -> 'None': + """ Description of RefreshOverlayImages. Args: @@ -31295,13 +29794,12 @@ Args: Returns: None - - """ - pass + """ + pass - def LoadNonloadedOverlayIdentifiers(self,) -> 'None': - """ + def LoadNonloadedOverlayIdentifiers(self,) -> 'None': + """ Description of LoadNonloadedOverlayIdentifiers. Args: @@ -31311,13 +29809,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OverlayIndexFromImageIndex(self,iImage:'Any',fAdd:'Any') -> 'None': - """ + def OverlayIndexFromImageIndex(self, iImage: 'Any', fAdd: 'Any') -> 'None': + """ Description of OverlayIndexFromImageIndex. Args: @@ -31328,20 +29825,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIShellItem(object): - """Interface that represents an item in the Explorer shell""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIShellItem(object): + """Interface that represents an item in the Explorer shell""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def BindToHandler(self,pbc:'Any',bhid:'PyIID',riid:'PyIID') -> 'Any': - """ + def BindToHandler(self, pbc: 'Any', bhid: 'PyIID', riid: 'PyIID') -> 'Any': + """ Creates an instance of one of the item's handlers Args: @@ -31353,13 +29849,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetParent(self,) -> 'Any': - """ + def GetParent(self,) -> 'Any': + """ Retrieves the parent of this item Args: @@ -31369,13 +29864,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetDisplayName(self,sigdnName:'Any') -> 'Any': - """ + def GetDisplayName(self, sigdnName: 'Any') -> 'Any': + """ Returns the display name of the item in the specified format Args: @@ -31385,13 +29879,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetAttributes(self,Mask:'Any') -> 'Any': - """ + def GetAttributes(self, Mask: 'Any') -> 'Any': + """ Returns shell attributes of the item Args: @@ -31402,13 +29895,12 @@ Returns: Any:Combination of shellcon.SFGAO_* values indicating the flags to returnReturn ValueReturns a combination of shellcon.SFGAO_* values - - """ - pass + """ + pass - def Compare(self,psi:'Any',hint:'Any') -> 'Any': - """ + def Compare(self, psi: 'Any', hint: 'Any') -> 'Any': + """ Compares another shell item with this item Args: @@ -31420,20 +29912,19 @@ Returns: Any:shellcon.SICHINT_* value indicating how the comparison is to be performedReturn ValueReturns 0 if items compare as equal, nonzero otherwise - - """ - pass + """ + pass -class PyIShellItem2(object): - """Extends the IShellItem interface, giving access to an item's properties""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIShellItem2(object): + """Extends the IShellItem interface, giving access to an item's properties""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetPropertyStore(self,Flags:'Any',riid:'PyIID') -> 'Any': - """ + def GetPropertyStore(self, Flags: 'Any', riid: 'PyIID') -> 'Any': + """ Returns a collection of the item's properties Args: @@ -31444,14 +29935,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetPropertyStoreForKeys(self,Keys:'Tuple[Any, ...]',Flags:'Any',riid:'PyIID') -> 'Any': - """ - Creates a property store containing just the + def GetPropertyStoreForKeys(self, Keys: 'Tuple[Any, ...]', Flags: 'Any', riid: 'PyIID') -> 'Any': + """ + Creates a property store containing just the specified properties of the item @@ -31464,14 +29954,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetPropertyStoreWithCreateObject(self,Flags:'Any',CreateObject:'Any',riid:'PyIID') -> 'Any': - """ - Returns the property store for the + def GetPropertyStoreWithCreateObject(self, Flags: 'Any', CreateObject: 'Any', riid: 'PyIID') -> 'Any': + """ + Returns the property store for the item, with alternate handler instantiation @@ -31484,14 +29973,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetPropertyDescriptionList(self,Type:'Any',riid:'PyIID') -> 'Any': - """ - Retrieves descriptions of + def GetPropertyDescriptionList(self, Type: 'Any', riid: 'PyIID') -> 'Any': + """ + Retrieves descriptions of properties in a particular group @@ -31503,13 +29991,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Update(self,BindCtx:'Any'=None) -> 'None': - """ + def Update(self, BindCtx: 'Any' = None) -> 'None': + """ Refreshes properties that have been modified since interface was created Args: @@ -31519,13 +30006,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetProperty(self,key:'Any') -> 'Any': - """ + def GetProperty(self, key: 'Any') -> 'Any': + """ Retrieves the value of a property, converted to an appropriate python type Args: @@ -31536,13 +30022,12 @@ Returns: Any:The id of the property to retrieveReturn ValueType of returned object is determined by the variant type of the property - - """ - pass + """ + pass - def GetCLSID(self,key:'Any') -> 'PyIID': - """ + def GetCLSID(self, key: 'Any') -> 'PyIID': + """ Retrieves the value of a property as a CLSID (VT_CLSID) Args: @@ -31552,13 +30037,12 @@ Args: Returns: PyIID - - """ - pass + """ + pass - def GetFileTime(self,key:'Any') -> 'PyTime': - """ + def GetFileTime(self, key: 'Any') -> 'PyTime': + """ Retrieves the value of a property as a FILETIME Args: @@ -31568,13 +30052,12 @@ Args: Returns: PyTime - - """ - pass + """ + pass - def GetInt32(self,key:'Any') -> 'Any': - """ + def GetInt32(self, key: 'Any') -> 'Any': + """ Retrieves the value of a property as a 32 bit int. Args: @@ -31584,13 +30067,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetString(self,key:'Any') -> 'Any': - """ + def GetString(self, key: 'Any') -> 'Any': + """ Retrieves the value of a property as a string Args: @@ -31600,13 +30082,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetUInt32(self,key:'Any') -> 'Any': - """ + def GetUInt32(self, key: 'Any') -> 'Any': + """ Returns the value of a property as a 32 bit unsigned int Args: @@ -31616,13 +30097,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetUInt64(self,key:'Any') -> 'Any': - """ + def GetUInt64(self, key: 'Any') -> 'Any': + """ Returns the value of a property as an unsigned 64-bit int Args: @@ -31632,13 +30112,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetBool(self,key:'Any') -> 'Any': - """ + def GetBool(self, key: 'Any') -> 'Any': + """ Returns the value of a property as a boolean Args: @@ -31648,20 +30127,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIShellItemArray(object): - """Container for a number of shell items""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIShellItemArray(object): + """Container for a number of shell items""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def BindToHandler(self,pbc:'Any',rbhid:'PyIID',riid:'PyIID') -> 'Any': - """ + def BindToHandler(self, pbc: 'Any', rbhid: 'PyIID', riid: 'PyIID') -> 'Any': + """ Creates an instance of a handler for the items in the container Args: @@ -31673,14 +30151,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetPropertyStore(self,flags:'Any',riid:'PyIID') -> 'Any': - """ - Retrieves a store containing consolidated + def GetPropertyStore(self, flags: 'Any', riid: 'PyIID') -> 'Any': + """ + Retrieves a store containing consolidated properties of items in container @@ -31692,14 +30169,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetPropertyDescriptionList(self,Type:'Any',riid:'PyIID') -> 'Any': - """ - Retrieves descriptions for a + def GetPropertyDescriptionList(self, Type: 'Any', riid: 'PyIID') -> 'Any': + """ + Retrieves descriptions for a defined group of properties @@ -31711,13 +30187,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetAttributes(self,AttribFlags:'Any',Mask:'Any') -> 'Any': - """ + def GetAttributes(self, AttribFlags: 'Any', Mask: 'Any') -> 'Any': + """ Retrieves shell attributes of contained items Args: @@ -31728,13 +30203,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetCount(self,) -> 'Any': - """ + def GetCount(self,) -> 'Any': + """ Returns the number of items in the container Args: @@ -31744,13 +30218,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetItemAt(self,dwIndex:'Any') -> 'Any': - """ + def GetItemAt(self, dwIndex: 'Any') -> 'Any': + """ Retrieves an item by index Args: @@ -31760,13 +30233,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def EnumItems(self,) -> 'Any': - """ + def EnumItems(self,) -> 'Any': + """ Returns an enumeration interface to list contained items Args: @@ -31776,20 +30248,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIShellItemResources(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIShellItemResources(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetAttributes(self,) -> 'None': - """ + def GetAttributes(self,) -> 'None': + """ Description of GetAttributes. Args: @@ -31799,13 +30270,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetSize(self,) -> 'Any': - """ + def GetSize(self,) -> 'Any': + """ Description of GetSize. Args: @@ -31815,13 +30285,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetTimes(self,) -> 'None': - """ + def GetTimes(self,) -> 'None': + """ Description of GetTimes. Args: @@ -31831,13 +30300,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetTimes(self,pftCreation:'PyTime',pftWrite:'PyTime',pftAccess:'PyTime') -> 'None': - """ + def SetTimes(self, pftCreation: 'PyTime', pftWrite: 'PyTime', pftAccess: 'PyTime') -> 'None': + """ Description of SetTimes. Args: @@ -31849,13 +30317,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetResourceDescription(self,pcsir:'Any') -> 'None': - """ + def GetResourceDescription(self, pcsir: 'Any') -> 'None': + """ Description of GetResourceDescription. Args: @@ -31865,13 +30332,12 @@ Args: Returns: None - - """ - pass + """ + pass - def EnumResources(self,) -> 'Any': - """ + def EnumResources(self,) -> 'Any': + """ Description of EnumResources. Args: @@ -31881,13 +30347,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SupportsResource(self,pcsir:'Any') -> 'Any': - """ + def SupportsResource(self, pcsir: 'Any') -> 'Any': + """ Description of SupportsResource. Args: @@ -31897,13 +30362,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OpenResource(self,pcsir:'Any',riid:'PyIID') -> 'Any': - """ + def OpenResource(self, pcsir: 'Any', riid: 'PyIID') -> 'Any': + """ Description of OpenResource. Args: @@ -31914,13 +30378,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def CreateResource(self,sir:'Any',riid:'PyIID') -> 'Any': - """ + def CreateResource(self, sir: 'Any', riid: 'PyIID') -> 'Any': + """ Description of CreateResource. Args: @@ -31931,13 +30394,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def MarkForDelete(self,) -> 'None': - """ + def MarkForDelete(self,) -> 'None': + """ Description of MarkForDelete. Args: @@ -31947,20 +30409,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIShellLibrary(object): - """Interface used to access Libraries""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIShellLibrary(object): + """Interface used to access Libraries""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def LoadLibraryFromItem(self,Library:'Any',Mode:'Any') -> 'None': - """ + def LoadLibraryFromItem(self, Library: 'Any', Mode: 'Any') -> 'None': + """ Loads an existing library file Args: @@ -31971,13 +30432,12 @@ Args: Returns: None - - """ - pass + """ + pass - def LoadLibraryFromKnownFolder(self,Library:'PyIID',Mode:'Any') -> 'None': - """ + def LoadLibraryFromKnownFolder(self, Library: 'PyIID', Mode: 'Any') -> 'None': + """ Initializes library from a known folder Args: @@ -31988,13 +30448,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AddFolder(self,Location:'Any') -> 'None': - """ + def AddFolder(self, Location: 'Any') -> 'None': + """ Includes a folder Args: @@ -32004,13 +30463,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RemoveFolder(self,Location:'Any') -> 'None': - """ + def RemoveFolder(self, Location: 'Any') -> 'None': + """ Removes a folder Args: @@ -32020,13 +30478,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetFolders(self,Filter:'Any',riid:'PyIID') -> 'Any': - """ + def GetFolders(self, Filter: 'Any', riid: 'PyIID') -> 'Any': + """ Retrieves a collection of folders in the library Args: @@ -32037,13 +30494,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def ResolveFolder(self,FolderToResolve:'Any',Timeout:'Any',riid:'PyIID') -> 'Any': - """ + def ResolveFolder(self, FolderToResolve: 'Any', Timeout: 'Any', riid: 'PyIID') -> 'Any': + """ Attempts to locate a folder that has been moved or renamed Args: @@ -32055,14 +30511,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetDefaultSaveFolder(self,Type:'Any',riid:'PyIID') -> 'Any': - """ - Returns the default folder in which new items are + def GetDefaultSaveFolder(self, Type: 'Any', riid: 'PyIID') -> 'Any': + """ + Returns the default folder in which new items are saved @@ -32074,13 +30529,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetDefaultSaveFolder(self,Type:'Any',SaveFolder:'Any') -> 'None': - """ + def SetDefaultSaveFolder(self, Type: 'Any', SaveFolder: 'Any') -> 'None': + """ Sets the default save location Args: @@ -32091,13 +30545,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetOptions(self,) -> 'Any': - """ + def GetOptions(self,) -> 'Any': + """ Retrieves library option flags Args: @@ -32111,13 +30564,12 @@ Returns: int = GetOptions()Retrieves library option flags Return ValueReturns a combination of shellcon.LOF_* flags - - """ - pass + """ + pass - def SetOptions(self,Mask:'Any',Options:'Any') -> 'None': - """ + def SetOptions(self, Mask: 'Any', Options: 'Any') -> 'None': + """ Sets library option flags Args: @@ -32128,13 +30580,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetFolderType(self,) -> 'PyIID': - """ + def GetFolderType(self,) -> 'PyIID': + """ Returns the library type, shell.FOLDERTYPEID_* Args: @@ -32144,13 +30595,12 @@ Args: Returns: PyIID - - """ - pass + """ + pass - def SetFolderType(self,Type:'PyIID') -> 'None': - """ + def SetFolderType(self, Type: 'PyIID') -> 'None': + """ Sets the folder type for the library Args: @@ -32160,13 +30610,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetIcon(self,) -> 'Any': - """ + def GetIcon(self,) -> 'Any': + """ Returns the location of the library's icon Args: @@ -32180,13 +30629,12 @@ Returns: str = GetIcon()Returns the location of the library's icon Return ValueUses "module,resource" format - - """ - pass + """ + pass - def SetIcon(self,Icon:'Any') -> 'None': - """ + def SetIcon(self, Icon: 'Any') -> 'None': + """ Sets the library icon Args: @@ -32196,13 +30644,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Commit(self,) -> 'None': - """ + def Commit(self,) -> 'None': + """ Saves changes (only if loaded from an existing library) Args: @@ -32212,13 +30659,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Save(self,FolderToSaveIn:'Any',LibraryName:'Any',Flags:'Any') -> 'Any': - """ + def Save(self, FolderToSaveIn: 'Any', LibraryName: 'Any', Flags: 'Any') -> 'Any': + """ Saves the library to a specific location Args: @@ -32231,13 +30677,12 @@ Returns: Any:Determines behaviour if file already exists, shellcon.LSF_*Return ValueReturns a shell item for the saved file. - - """ - pass + """ + pass - def SaveInKnownFolder(self,FolderToSaveIn:'PyIID',LibraryName:'Any',Flags:'Any') -> 'Any': - """ + def SaveInKnownFolder(self, FolderToSaveIn: 'PyIID', LibraryName: 'Any', Flags: 'Any') -> 'Any': + """ Saves the library in a known folder Args: @@ -32249,21 +30694,20 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIShellLink(object): - """Interface used to access the properties of a shell link file (*.lnk)""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIShellLink(object): + """Interface used to access the properties of a shell link file (*.lnk)""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetPath(self,fFlags:'Any',cchMaxPath:'Any') -> 'Tuple[Any, WIN32_FIND_DATA]': - """ - Retrieves the target path and file name of a shell link + def GetPath(self, fFlags: 'Any', cchMaxPath: 'Any') -> 'Tuple[Any, WIN32_FIND_DATA]': + """ + Retrieves the target path and file name of a shell link object @@ -32275,13 +30719,12 @@ Args: Returns: Tuple[Any, WIN32_FIND_DATA] - - """ - pass + """ + pass - def GetIDList(self,) -> 'Any': - """ + def GetIDList(self,) -> 'Any': + """ Retrieves the item id list that identifies the target of the shell link. Args: @@ -32291,13 +30734,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetIDList(self,pidl:'Any') -> 'None': - """ + def SetIDList(self, pidl: 'Any') -> 'None': + """ Sets the target of the link using an item id list Args: @@ -32307,13 +30749,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetDescription(self,cchMaxName:'Any'=1024) -> 'Any': - """ + def GetDescription(self, cchMaxName: 'Any' = 1024) -> 'Any': + """ Retrieves the description of the link (displays as Comment in the UI) Args: @@ -32323,13 +30764,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetDescription(self,Name:'Any') -> 'None': - """ + def SetDescription(self, Name: 'Any') -> 'None': + """ Sets the description of the link (displays as Comment in the UI) Args: @@ -32339,13 +30779,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetWorkingDirectory(self,cchMaxName:'Any'=1024) -> 'Any': - """ + def GetWorkingDirectory(self, cchMaxName: 'Any' = 1024) -> 'Any': + """ Retrieves the working directory for the link Args: @@ -32355,13 +30794,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetWorkingDirectory(self,Dir:'Any') -> 'None': - """ + def SetWorkingDirectory(self, Dir: 'Any') -> 'None': + """ Sets the working directory for the link. Args: @@ -32371,13 +30809,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetArguments(self,cchMaxName:'Any'=1024) -> 'Any': - """ + def GetArguments(self, cchMaxName: 'Any' = 1024) -> 'Any': + """ Retrieves the command-line arguments associated with a shell link object. Args: @@ -32387,13 +30824,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetArguments(self,args:'Any') -> 'None': - """ + def SetArguments(self, args: 'Any') -> 'None': + """ Sets the command-line arguments associated with a shell link object. Args: @@ -32403,13 +30839,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetHotkey(self,) -> 'Any': - """ + def GetHotkey(self,) -> 'Any': + """ Retrieves the hot key for a shell link object. Args: @@ -32419,13 +30854,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetHotkey(self,wHotkey:'Any') -> 'None': - """ + def SetHotkey(self, wHotkey: 'Any') -> 'None': + """ Sets the hot key for a shell link object. Args: @@ -32435,13 +30869,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetShowCmd(self,) -> 'Any': - """ + def GetShowCmd(self,) -> 'Any': + """ Retrieves the show (SW_) command for a shell link object. Args: @@ -32451,13 +30884,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetShowCmd(self,iShowCmd:'Any') -> 'None': - """ + def SetShowCmd(self, iShowCmd: 'Any') -> 'None': + """ Sets the show (SW_) command for a shell link object. Args: @@ -32467,14 +30899,13 @@ Args: Returns: None - - """ - pass + """ + pass - def GetIconLocation(self,cchMaxPath:'Any') -> 'Any': - """ - Retrieves the location (path and index) of the icon for a shell link + def GetIconLocation(self, cchMaxPath: 'Any') -> 'Any': + """ + Retrieves the location (path and index) of the icon for a shell link object. @@ -32485,13 +30916,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetIconLocation(self,iconPath:'str',iIcon:'Any') -> 'None': - """ + def SetIconLocation(self, iconPath: 'str', iIcon: 'Any') -> 'None': + """ Sets the location (path and index) of the icon for a shell link object. Args: @@ -32502,13 +30932,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetRelativePath(self,relPath:'str',reserved:'Any'=0) -> 'None': - """ + def SetRelativePath(self, relPath: 'str', reserved: 'Any' = 0) -> 'None': + """ Sets the relative path for a shell link object. Args: @@ -32519,14 +30948,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Resolve(self,hwnd:'Any',fFlags:'Any') -> 'None': - """ - Resolves a shell link by searching for the shell link object and updating the + def Resolve(self, hwnd: 'Any', fFlags: 'Any') -> 'None': + """ + 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,13 +30966,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetPath(self,path:'str') -> 'None': - """ + def SetPath(self, path: 'str') -> 'None': + """ Sets the path and file name of a shell link object. Args: @@ -32554,20 +30981,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIShellLinkDataList(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIShellLinkDataList(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def AddDataBlock(self,DataBlock:'Any') -> 'None': - """ + def AddDataBlock(self, DataBlock: 'Any') -> 'None': + """ Inserts a data block into the link Args: @@ -32577,13 +31003,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CopyDataBlock(self,Sig:'Any') -> 'Any': - """ + def CopyDataBlock(self, Sig: 'Any') -> 'Any': + """ Retrieves the specified data block from the link Args: @@ -32594,13 +31019,12 @@ Returns: 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 + """ + pass - def GetFlags(self,) -> 'Any': - """ + def GetFlags(self,) -> 'Any': + """ Retrieves the link's flags Args: @@ -32614,13 +31038,12 @@ Returns: int = GetFlags()Retrieves the link's flags Return ValueReturns combination of shellcon.SLDF_* flags - - """ - pass + """ + pass - def RemoveDataBlock(self,Sig:'Any') -> 'None': - """ + def RemoveDataBlock(self, Sig: 'Any') -> 'None': + """ Deletes one of the link's data blocks Args: @@ -32630,13 +31053,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetFlags(self,Flags:'Any') -> 'None': - """ + def SetFlags(self, Flags: 'Any') -> 'None': + """ Sets the flags indicating which data blocks are present Args: @@ -32646,20 +31068,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIShellView(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIShellView(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def TranslateAccelerator(self,pmsg:'Any') -> 'Any': - """ + def TranslateAccelerator(self, pmsg: 'Any') -> 'Any': + """ Description of TranslateAccelerator. Args: @@ -32670,13 +31091,12 @@ Returns: Any:Description for pmsgReturn ValueThe result is the HRESULT from the underlying TranslateAccelerator call - - """ - pass + """ + pass - def EnableModeless(self,fEnable:'Any') -> 'None': - """ + def EnableModeless(self, fEnable: 'Any') -> 'None': + """ Description of EnableModeless. Args: @@ -32686,13 +31106,12 @@ Args: Returns: None - - """ - pass + """ + pass - def UIActivate(self,uState:'Any') -> 'None': - """ + def UIActivate(self, uState: 'Any') -> 'None': + """ Description of UIActivate. Args: @@ -32702,13 +31121,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Refresh(self,) -> 'None': - """ + def Refresh(self,) -> 'None': + """ Description of Refresh. Args: @@ -32718,13 +31136,17 @@ Args: Returns: None - - """ - pass + """ + pass - def CreateViewWindow(self,psvPrevious:'Any',pfs:'Tuple[Any, Any]',psb:'Any',prcView:'Tuple[Any, Any, Any, Any]') -> 'Any': - """ + def CreateViewWindow( + self, + psvPrevious: 'Any', + pfs: 'Tuple[Any, Any]', + psb: 'Any', + prcView: 'Tuple[Any, Any, Any, Any]') -> 'Any': + """ Description of CreateViewWindow. Args: @@ -32738,13 +31160,12 @@ Returns: Any:Description for prcViewReturn ValueThe result is an integer handle to the new window. - - """ - pass + """ + pass - def DestroyViewWindow(self,) -> 'None': - """ + def DestroyViewWindow(self,) -> 'None': + """ Description of DestroyViewWindow. Args: @@ -32754,13 +31175,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetCurrentInfo(self,) -> 'Any': - """ + def GetCurrentInfo(self,) -> 'Any': + """ Description of GetCurrentInfo. Args: @@ -32770,13 +31190,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SaveViewState(self,) -> 'None': - """ + def SaveViewState(self,) -> 'None': + """ Description of SaveViewState. Args: @@ -32786,13 +31205,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SelectItem(self,pidlItem:'Any',uFlags:'Any') -> 'None': - """ + def SelectItem(self, pidlItem: 'Any', uFlags: 'Any') -> 'None': + """ Description of SelectItem. Args: @@ -32803,13 +31221,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetItemObject(self,uItem:'Any',riid:'PyIID') -> 'Any': - """ + def GetItemObject(self, uItem: 'Any', riid: 'PyIID') -> 'Any': + """ Description of GetItemObject. Args: @@ -32820,20 +31237,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyISpecifyPropertyPages(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyISpecifyPropertyPages(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetPages(self,) -> 'None': - """ + def GetPages(self,) -> 'None': + """ Description of GetPages. Args: @@ -32843,23 +31259,22 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIStorage(object): - """Structured storage compound storage object""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIStorage(object): + """Structured storage compound storage object""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def CreateStream(self,Name:'Any',Mode:'Any',reserved1:'Any'=0,reserved2:'Any'=0) -> 'Any': - """ - Creates and opens a stream object with the specified name contained + def CreateStream(self, Name: 'Any', Mode: 'Any', reserved1: 'Any' = 0, reserved2: 'Any' = 0) -> 'Any': + """ + 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 +31288,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def OpenStream(self,Name:'Any',reserved1:'Any',Mode:'Any',reserved2:'Any'=0) -> 'Any': - """ - Opens an existing stream object within this storage object in the + def OpenStream(self, Name: 'Any', reserved1: 'Any', Mode: 'Any', reserved2: 'Any' = 0) -> 'Any': + """ + Opens an existing stream object within this storage object in the specified access mode. @@ -32894,14 +31308,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def CreateStorage(self,Name:'Any',Mode:'Any',StgFmt:'Any',reserved2:'Any'=0) -> 'Any': - """ - Creates and opens a new storage object nested within this storage + def CreateStorage(self, Name: 'Any', Mode: 'Any', StgFmt: 'Any', reserved2: 'Any' = 0) -> 'Any': + """ + Creates and opens a new storage object nested within this storage object. @@ -32915,14 +31328,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def OpenStorage(self,Name:'Any',Priority:'Any',Mode:'Any',snbExclude:'Any',reserved:'Any'=0) -> 'Any': - """ - Opens an existing storage object with the specified name in the + def OpenStorage(self, Name: 'Any', Priority: 'Any', Mode: 'Any', snbExclude: 'Any', reserved: 'Any' = 0) -> 'Any': + """ + Opens an existing storage object with the specified name in the specified access mode. @@ -32937,13 +31349,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def CopyTo(self,rgiidExclude:'Tuple[Any, Any]',snbExclude:'Any',stgDest:'Any') -> 'None': - """ + def CopyTo(self, rgiidExclude: 'Tuple[Any, Any]', snbExclude: 'Any', stgDest: 'Any') -> 'None': + """ Copies the entire contents of an open storage object to another storage object. Args: @@ -32955,14 +31366,13 @@ Args: Returns: None - - """ - pass + """ + pass - def MoveElementTo(self,Name:'Any',stgDest:'Any',NewName:'Any',Flags:'Any') -> 'None': - """ - Copies or moves a substorage or stream from this storage object to another + def MoveElementTo(self, Name: 'Any', stgDest: 'Any', NewName: 'Any', Flags: 'Any') -> 'None': + """ + Copies or moves a substorage or stream from this storage object to another storage object. @@ -32976,18 +31386,17 @@ Args: Returns: None - - """ - pass + """ + pass - def Commit(self,grfCommitFlags:'Any') -> 'None': - """ - Ensures that any changes made to a storage object open in transacted mode are reflected + def Commit(self, grfCommitFlags: 'Any') -> 'None': + """ + 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,13 +31407,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Revert(self,) -> 'None': - """ + def Revert(self,) -> 'None': + """ Discards all changes that have been made to the storage object since the last commit. Args: @@ -33014,14 +31422,13 @@ Args: Returns: None - - """ - pass + """ + pass - def EnumElements(self,reserved1:'Any'=0,reserved2:'Any'=None,reserved3:'Any'=0) -> 'Any': - """ - Retrieves an enumerator object that can be used to enumerate the + def EnumElements(self, reserved1: 'Any' = 0, reserved2: 'Any' = None, reserved3: 'Any' = 0) -> 'Any': + """ + Retrieves an enumerator object that can be used to enumerate the storage and stream objects contained within this storage object. @@ -33034,13 +31441,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def DestroyElement(self,name:'str') -> 'None': - """ + def DestroyElement(self, name: 'str') -> 'None': + """ Removes the specified storage or stream from this storage object. Args: @@ -33050,13 +31456,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RenameElement(self,OldName:'Any',NewName:'Any') -> 'None': - """ + def RenameElement(self, OldName: 'Any', NewName: 'Any') -> 'None': + """ Renames the specified substorage or stream in this storage object. Args: @@ -33067,14 +31472,13 @@ Args: Returns: None - - """ - pass + """ + pass - def SetElementTimes(self,name:'Any',ctime:'PyTime',atime:'PyTime',mtime:'PyTime') -> 'None': - """ - Sets the modification, access, and creation times of the specified storage + def SetElementTimes(self, name: 'Any', ctime: 'PyTime', atime: 'PyTime', mtime: 'PyTime') -> 'None': + """ + Sets the modification, access, and creation times of the specified storage element, if supported by the underlying file system. @@ -33088,13 +31492,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetClass(self,clsid:'PyIID') -> 'None': - """ + def SetClass(self, clsid: 'PyIID') -> 'None': + """ Assigns the specified CLSID to this storage object. Args: @@ -33104,13 +31507,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetStateBits(self,grfStateBits:'Any',grfMask:'Any') -> 'None': - """ + def SetStateBits(self, grfStateBits: 'Any', grfMask: 'Any') -> 'None': + """ Stores up to 32 bits of state information in this storage object. Args: @@ -33121,13 +31523,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Stat(self,grfStatFlag:'Any') -> 'Any': - """ + def Stat(self, grfStatFlag: 'Any') -> 'Any': + """ Retrieves the STATSTG structure for this open storage object. Args: @@ -33137,20 +31538,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIStream(object): - """A Python interface to IStream""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIStream(object): + """A Python interface to IStream""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Read(self,numBytes:'Any') -> 'str': - """ + def Read(self, numBytes: 'Any') -> 'str': + """ Read the specified number of bytes from the string. Args: @@ -33161,13 +31561,12 @@ 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 + """ + pass - def read(self,numBytes:'Any') -> 'str': - """ + def read(self, numBytes: 'Any') -> 'str': + """ Read the specified number of bytes from the string. Args: @@ -33178,13 +31577,12 @@ 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 + """ + pass - def Write(self,data:'str') -> 'None': - """ + def Write(self, data: 'str') -> 'None': + """ Write data to a stream Args: @@ -33194,13 +31592,12 @@ Args: Returns: None - - """ - pass + """ + pass - def write(self,data:'str') -> 'None': - """ + def write(self, data: 'str') -> 'None': + """ Write data to a stream Args: @@ -33210,13 +31607,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Seek(self,offset:'Any',origin:'Any') -> 'ULARGE_INTEGER': - """ + def Seek(self, offset: 'Any', origin: 'Any') -> 'ULARGE_INTEGER': + """ Changes the seek pointer to a new location. Args: @@ -33227,13 +31623,12 @@ Args: Returns: ULARGE_INTEGER - - """ - pass + """ + pass - def SetSize(self,newSize:'ULARGE_INTEGER') -> 'None': - """ + def SetSize(self, newSize: 'ULARGE_INTEGER') -> 'None': + """ Changes the size of the stream object. Args: @@ -33243,14 +31638,13 @@ Args: Returns: None - - """ - pass + """ + pass - def CopyTo(self,stream:'Any',cb:'ULARGE_INTEGER') -> 'ULARGE_INTEGER': - """ - Copies a specified number of bytes from the current seek pointer in the + def CopyTo(self, stream: 'Any', cb: 'ULARGE_INTEGER') -> 'ULARGE_INTEGER': + """ + Copies a specified number of bytes from the current seek pointer in the stream to the current seek pointer in another stream. @@ -33263,14 +31657,13 @@ Returns: ULARGE_INTEGER:The number of bytes to write.Return ValueThe return value is the number of bytes actually written. - - """ - pass + """ + pass - def Commit(self,flags:'Any') -> 'None': - """ - Ensures that any changes made to a stream object open in transacted mode are reflected in + def Commit(self, flags: 'Any') -> 'None': + """ + Ensures that any changes made to a stream object open in transacted mode are reflected in the parent storage. @@ -33281,13 +31674,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Revert(self,) -> 'None': - """ + def Revert(self,) -> 'None': + """ None Args: @@ -33297,13 +31689,12 @@ Args: Returns: None - - """ - pass + """ + pass - def LockRegion(self,offset:'ULARGE_INTEGER',cb:'ULARGE_INTEGER',lockType:'Any') -> 'None': - """ + def LockRegion(self, offset: 'ULARGE_INTEGER', cb: 'ULARGE_INTEGER', lockType: 'Any') -> 'None': + """ Restricts access to a specified range of bytes in the stream. Args: @@ -33315,13 +31706,12 @@ Args: Returns: None - - """ - pass + """ + pass - def UnLockRegion(self,offset:'ULARGE_INTEGER',cb:'ULARGE_INTEGER',lockType:'Any') -> 'None': - """ + def UnLockRegion(self, offset: 'ULARGE_INTEGER', cb: 'ULARGE_INTEGER', lockType: 'Any') -> 'None': + """ None Args: @@ -33333,14 +31723,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Clone(self,) -> 'Any': - """ - Creates a new stream object with its own seek pointer that references the + def Clone(self,) -> 'Any': + """ + Creates a new stream object with its own seek pointer that references the same bytes as the original stream. @@ -33351,13 +31740,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Stat(self,grfStatFlag:'Any'=0) -> 'Any': - """ + def Stat(self, grfStatFlag: 'Any' = 0) -> 'Any': + """ Returns information about the stream Args: @@ -33367,20 +31755,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyITask(object): - """Python object that encapsulates the ITask interface, inherits all the methods of PyIScheduledWorkItem""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyITask(object): + """Python object that encapsulates the ITask interface, inherits all the methods of PyIScheduledWorkItem""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def SetApplicationName(self,ApplicationName:'Any') -> 'None': - """ + def SetApplicationName(self, ApplicationName: 'Any') -> 'None': + """ Specify which program the task will run Args: @@ -33390,13 +31777,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetApplicationName(self,) -> 'Any': - """ + def GetApplicationName(self,) -> 'Any': + """ Retrieve name of program that task will run Args: @@ -33406,13 +31792,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetParameters(self,Parameters:'Any') -> 'None': - """ + def SetParameters(self, Parameters: 'Any') -> 'None': + """ Sets command line parameters Args: @@ -33422,13 +31807,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetParameters(self,) -> 'Any': - """ + def GetParameters(self,) -> 'Any': + """ Returns command line parameters for task Args: @@ -33438,13 +31822,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetWorkingDirectory(self,WorkingDirectory:'Any') -> 'None': - """ + def SetWorkingDirectory(self, WorkingDirectory: 'Any') -> 'None': + """ Sets initial working directory for task Args: @@ -33454,13 +31837,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetWorkingDirectory(self,) -> 'Any': - """ + def GetWorkingDirectory(self,) -> 'Any': + """ Return working directory that the task will start out in Args: @@ -33470,13 +31852,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetPriority(self,Priority:'Any') -> 'None': - """ + def SetPriority(self, Priority: 'Any') -> 'None': + """ Sets priority for task Args: @@ -33486,13 +31867,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetPriority(self,) -> 'Any': - """ + def GetPriority(self,) -> 'Any': + """ Gets priority that will be assigned to process when task starts Args: @@ -33502,13 +31882,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetTaskFlags(self,dwFlags:'Any') -> 'None': - """ + def SetTaskFlags(self, dwFlags: 'Any') -> 'None': + """ Sets flag for task. Args: @@ -33518,13 +31897,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetTaskFlags(self,) -> 'Any': - """ + def GetTaskFlags(self,) -> 'Any': + """ Retrieve task flags (None currently defined) Args: @@ -33534,13 +31912,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetMaxRunTime(self,MaxRunTimeMS:'Any') -> 'None': - """ + def SetMaxRunTime(self, MaxRunTimeMS: 'Any') -> 'None': + """ Sets maximun run time for task, use -1 to disable Args: @@ -33550,13 +31927,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetMaxRunTime(self,) -> 'Any': - """ + def GetMaxRunTime(self,) -> 'Any': + """ Returns maximun run time for task Args: @@ -33566,20 +31942,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyITaskScheduler(object): - """Interface to the Windows Task Scheduler""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyITaskScheduler(object): + """Interface to the Windows Task Scheduler""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def SetTargetComputer(self,Computer:'Any') -> 'None': - """ + def SetTargetComputer(self, Computer: 'Any') -> 'None': + """ Connect to another machine to manage its tasks Args: @@ -33589,14 +31964,13 @@ Args: Returns: None - - """ - pass + """ + pass - def GetTargetComputer(self,) -> 'Any': - """ - Returns name of computer that the Task Scheduler is + def GetTargetComputer(self,) -> 'Any': + """ + Returns name of computer that the Task Scheduler is connected to @@ -33607,13 +31981,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Enum(self,) -> 'Tuple[str, ...]': - """ + def Enum(self,) -> 'Tuple[str, ...]': + """ Retrieve list of task names Args: @@ -33623,13 +31996,12 @@ Args: Returns: Tuple[str, ...] - - """ - pass + """ + pass - def Activate(self,Name:'Any',riid:'PyIID') -> 'Any': - """ + def Activate(self, Name: 'Any', riid: 'PyIID') -> 'Any': + """ Opens the specified task and returns an ITask interface for it Args: @@ -33640,13 +32012,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Delete(self,TaskName:'Any') -> 'None': - """ + def Delete(self, TaskName: 'Any') -> 'None': + """ Delete task by name Args: @@ -33656,13 +32027,12 @@ Args: Returns: None - - """ - pass + """ + pass - def NewWorkItem(self,TaskName:'Any',rclsid:'PyIID',riid:'PyIID') -> 'Any': - """ + def NewWorkItem(self, TaskName: 'Any', rclsid: 'PyIID', riid: 'PyIID') -> 'Any': + """ Creates a new task Args: @@ -33674,13 +32044,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def AddWorkItem(self,TaskName:'Any',WorkItem:'Any') -> 'None': - """ + def AddWorkItem(self, TaskName: 'Any', WorkItem: 'Any') -> 'None': + """ Create a new scheduled task from PyITask object Args: @@ -33691,13 +32060,12 @@ Args: Returns: None - - """ - pass + """ + pass - def IsOfType(self,Name:'Any',riid:'PyIID') -> 'None': - """ + def IsOfType(self, Name: 'Any', riid: 'PyIID') -> 'None': + """ Check if named object supports specified interface Args: @@ -33708,20 +32076,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyITaskTrigger(object): - """Python object that encapsulates the ITaskTrigger interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyITaskTrigger(object): + """Python object that encapsulates the ITaskTrigger interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def SetTrigger(self,Trigger:'Any') -> 'None': - """ + def SetTrigger(self, Trigger: 'Any') -> 'None': + """ Set trigger parameters from a PyTASK_TRIGGER object Args: @@ -33731,13 +32098,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetTrigger(self,) -> 'Any': - """ + def GetTrigger(self,) -> 'Any': + """ Retrieves trigger parms as a PyTASK_TRIGGER object Args: @@ -33747,13 +32113,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetTriggerString(self,) -> 'str': - """ + def GetTriggerString(self,) -> 'str': + """ Build text summary of trigger Args: @@ -33763,20 +32128,19 @@ Args: Returns: str - - """ - pass + """ + pass -class PyITaskbarList(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyITaskbarList(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def HrInit(self,) -> 'None': - """ + def HrInit(self,) -> 'None': + """ Intializes the interface before use Args: @@ -33786,13 +32150,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AddTab(self,hwnd:'int') -> 'None': - """ + def AddTab(self, hwnd: 'int') -> 'None': + """ Places a window on the taskbar Args: @@ -33802,13 +32165,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DeleteTab(self,hwnd:'int') -> 'None': - """ + def DeleteTab(self, hwnd: 'int') -> 'None': + """ Removes a window from the taskbar Args: @@ -33818,13 +32180,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ActivateTab(self,hwnd:'int') -> 'None': - """ + def ActivateTab(self, hwnd: 'int') -> 'None': + """ Marks a window as the active tab on the taskbar Args: @@ -33834,14 +32195,13 @@ Args: Returns: None - - """ - pass + """ + pass - def SetActiveAlt(self,hwnd:'int') -> 'None': - """ - Sets the window as the active tab, without displaying it as pressed on the + def SetActiveAlt(self, hwnd: 'int') -> 'None': + """ + Sets the window as the active tab, without displaying it as pressed on the taskbar @@ -33852,20 +32212,26 @@ Args: Returns: None - - """ - pass - - -class PyITransferAdviseSink(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """ + pass - def UpdateProgress(self,SizeCurrent:'Any',SizeTotal:'Any',FilesCurrent:'Any',FilesTotal:'Any',FoldersCurrent:'Any',FoldersTotal:'Any') -> 'None': - """ +class PyITransferAdviseSink(object): + """""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + def UpdateProgress( + self, + SizeCurrent: 'Any', + SizeTotal: 'Any', + FilesCurrent: 'Any', + FilesTotal: 'Any', + FoldersCurrent: 'Any', + FoldersTotal: 'Any') -> 'None': + """ Gives an estimate of amount of work completed Args: @@ -33880,13 +32246,12 @@ Args: Returns: None - - """ - pass + """ + pass - def UpdateTransferState(self,State:'Any') -> 'None': - """ + def UpdateTransferState(self, State: 'Any') -> 'None': + """ Notifies client of current operation state Args: @@ -33896,13 +32261,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ConfirmOverwrite(self,Source:'Any',DestParent:'Any',Name:'Any') -> 'Any': - """ + def ConfirmOverwrite(self, Source: 'Any', DestParent: 'Any', Name: 'Any') -> 'Any': + """ Asks user for permission to overwrite an existing item Args: @@ -33914,14 +32278,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def ConfirmEncryptionLoss(self,Source:'Any') -> 'Any': - """ - Notifies user when an item can't be encrypted at + def ConfirmEncryptionLoss(self, Source: 'Any') -> 'Any': + """ + Notifies user when an item can't be encrypted at destination @@ -33932,13 +32295,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def FileFailure(self,Item:'Any',ItemName:'Any',Error:'Any') -> 'Tuple[Any, Any]': - """ + def FileFailure(self, Item: 'Any', ItemName: 'Any', Error: 'Any') -> 'Tuple[Any, Any]': + """ Notifies user of failure, and queries how to proceed Args: @@ -33951,14 +32313,13 @@ Returns: Tuple[Any, Any]:HRESULT error code from operationReturn ValueReturns the HRESULT and new file name if renaming resolved the failure - - """ - pass + """ + pass - def SubStreamFailure(self,Item:'Any',StreamName:'Any',Error:'Any') -> 'Any': - """ - Notifies user of failure on a substream, and queries how to + def SubStreamFailure(self, Item: 'Any', StreamName: 'Any', Error: 'Any') -> 'Any': + """ + Notifies user of failure on a substream, and queries how to proceed @@ -33972,13 +32333,12 @@ Returns: Any:HRESULT failure code from operationReturn ValueReturns COPYENGINE_S_* if operation is to continue, or COPYENGINE_E_* HRESULT if cancelled - - """ - pass + """ + pass - def PropertyFailure(self,Item:'Any',key:'Any',Error:'Any') -> 'Any': - """ + def PropertyFailure(self, Item: 'Any', key: 'Any', Error: 'Any') -> 'Any': + """ Notifies user of failure to set an item's properties Args: @@ -33989,24 +32349,23 @@ Args: Returns: - Any:HRESULT error code returned by the operationReturn ValueReturns COPYENGINE_S_* to indicate that the failure was handled, or + 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 + """ + pass -class PyITransferDestination(object): - """Implemented by shell extensions that act as targets for item copy or move operations""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyITransferDestination(object): + """Implemented by shell extensions that act as targets for item copy or move operations""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Advise(self,Sink:'Any') -> 'Any': - """ + def Advise(self, Sink: 'Any') -> 'Any': + """ Connects an advise sink Args: @@ -34017,13 +32376,12 @@ Returns: Any:Event sink to receive notificationsReturn ValueReturns an id for the connection, to be passed to PyITransferDestination::Unadvise - - """ - pass + """ + pass - def Unadvise(self,Cookie:'Any') -> 'None': - """ + def Unadvise(self, Cookie: 'Any') -> 'None': + """ Disconnects an advise sink Args: @@ -34033,13 +32391,13 @@ Args: Returns: None - - """ - pass + """ + pass - def CreateItem(self,Name:'Any',Attributes:'Any',Size:'Any',Flags:'Any',riidItem:'PyIID',riidResources:'PyIID') -> 'Tuple[Any, Any, Any]': - """ + def CreateItem(self, Name: 'Any', Attributes: 'Any', Size: 'Any', Flags: 'Any', + riidItem: 'PyIID', riidResources: 'PyIID') -> 'Tuple[Any, Any, Any]': + """ Requests that a new item be created Args: @@ -34054,31 +32412,30 @@ Args: Returns: Tuple[Any, Any, 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 + + """ + pass class PyITransferMediumItem(object): - """Description of the interface""" + """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyITransferSource(object): - """Implemented by shell folders that can act as the source of shell item operations""" + """Implemented by shell folders that can act as the source of shell item operations""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - - def Advise(self,Sink:'Any') -> 'Any': - """ + def Advise(self, Sink: 'Any') -> 'Any': + """ Connects an advise sink to receive notifications Args: @@ -34088,13 +32445,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Unadvise(self,Cookie:'Any') -> 'None': - """ + def Unadvise(self, Cookie: 'Any') -> 'None': + """ Disconnects an event sink Args: @@ -34104,13 +32460,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetProperties(self,proparray:'Any') -> 'None': - """ + def SetProperties(self, proparray: 'Any') -> 'None': + """ Specifies changes to be applied to items' properties Args: @@ -34120,13 +32475,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OpenItem(self,Item:'Any',flags:'Any',riid:'PyIID') -> 'Tuple[Any, Any]': - """ + def OpenItem(self, Item: 'Any', flags: 'Any', riid: 'PyIID') -> 'Tuple[Any, Any]': + """ Initiates the copying of an item Args: @@ -34138,13 +32492,12 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def MoveItem(self,Item:'Any',ParentDst:'Any',NameDst:'Any',flags:'Any') -> 'Tuple[Any, Any]': - """ + def MoveItem(self, Item: 'Any', ParentDst: 'Any', NameDst: 'Any', flags: 'Any') -> 'Tuple[Any, Any]': + """ Moves a shell item into another folder Args: @@ -34156,19 +32509,18 @@ Args: Returns: - Tuple[Any, Any]:Combination of shellcon.TSF_* flagsReturn ValueReturns the HRESULT from the operation and the new shell item, which may be None + Tuple[Any, Any]: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 + """ + pass - def RecycleItem(self,Source:'Any',ParentDest:'Any',flags:'Any') -> 'Tuple[Any, Any]': - """ + def RecycleItem(self, Source: 'Any', ParentDest: 'Any', flags: 'Any') -> 'Tuple[Any, Any]': + """ Moves an item to the recycle bin Args: @@ -34180,13 +32532,12 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def RemoveItem(self,Source:'Any',flags:'Any') -> 'Any': - """ + def RemoveItem(self, Source: 'Any', flags: 'Any') -> 'Any': + """ Deletes an item without recycling Args: @@ -34198,13 +32549,12 @@ Returns: Any:Combination of shellcon.TSF_* flagsReturn ValueReturns the HRESULT of the operation - - """ - pass + """ + pass - def RenameItem(self,Source:'Any',NewName:'Any',flags:'Any') -> 'Tuple[Any, Any]': - """ + def RenameItem(self, Source: 'Any', NewName: 'Any', flags: 'Any') -> 'Tuple[Any, Any]': + """ Renames a shell item Args: @@ -34216,13 +32566,12 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def LinkItem(self,Source:'Any',ParentDest:'Any',NewName:'Any',flags:'Any') -> 'Tuple[Any, Any]': - """ + def LinkItem(self, Source: 'Any', ParentDest: 'Any', NewName: 'Any', flags: 'Any') -> 'Tuple[Any, Any]': + """ Not implemented, according to MSDN Args: @@ -34235,13 +32584,12 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def ApplyPropertiesToItem(self,Source:'Any') -> 'Any': - """ + def ApplyPropertiesToItem(self, Source: 'Any') -> 'Any': + """ None Args: @@ -34251,14 +32599,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetDefaultDestinationName(self,Source:'Any',ParentDest:'Any') -> 'Any': - """ - Determines the name of an item as it would appear in a + def GetDefaultDestinationName(self, Source: 'Any', ParentDest: 'Any') -> 'Any': + """ + Determines the name of an item as it would appear in a given folder @@ -34270,14 +32617,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def EnterFolder(self,ChildFolderDest:'Any') -> 'Any': - """ - Informs the copy engine that a folder will be the target of a file + def EnterFolder(self, ChildFolderDest: 'Any') -> 'Any': + """ + Informs the copy engine that a folder will be the target of a file operation @@ -34288,14 +32634,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def LeaveFolder(self,ChildFolderDest:'Any') -> 'Any': - """ - Informs the copy engine that the operation on a destination folder is + def LeaveFolder(self, ChildFolderDest: 'Any') -> 'Any': + """ + Informs the copy engine that the operation on a destination folder is finished @@ -34306,20 +32651,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyITypeComp(object): - """An object that implements the ITypeComp interface.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyITypeComp(object): + """An object that implements the ITypeComp interface.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Bind(self,szName:'str',wflags:'Any'=0) -> 'Any': - """ + def Bind(self, szName: 'str', wflags: 'Any' = 0) -> 'Any': + """ binds to a variable/type Args: @@ -34330,13 +32674,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def BindType(self,szName:'str') -> 'Any': - """ + def BindType(self, szName: 'str') -> 'Any': + """ binds to a type Args: @@ -34346,21 +32689,20 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyITypeInfo(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyITypeInfo(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetContainingTypeLib(self,) -> 'Tuple[Any, Any]': - """ - Retrieves the containing type library and the index of + def GetContainingTypeLib(self,) -> 'Tuple[Any, Any]': + """ + Retrieves the containing type library and the index of the type description within that type library. @@ -34371,14 +32713,13 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def GetDocumentation(self,memberId:'Any') -> 'Tuple[Any, Any, Any, Any]': - """ - Retrieves the documentation string, + def GetDocumentation(self, memberId: 'Any') -> 'Tuple[Any, Any, Any, Any]': + """ + 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,13 +32730,12 @@ Args: Returns: Tuple[Any, Any, Any, Any] - - """ - pass + """ + pass - def GetFuncDesc(self,memberId:'Any') -> 'Any': - """ + def GetFuncDesc(self, memberId: 'Any') -> 'Any': + """ None Args: @@ -34405,14 +32745,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetImplTypeFlags(self,index:'Any') -> 'Any': - """ - Retrieves the IMPLTYPEFLAGS enumeration for one implemented interface or + def GetImplTypeFlags(self, index: 'Any') -> 'Any': + """ + Retrieves the IMPLTYPEFLAGS enumeration for one implemented interface or base interface in a type description. @@ -34423,14 +32762,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetIDsOfNames(self,) -> 'Any': - """ - Maps between member names and member IDs, and parameter names and parameter + def GetIDsOfNames(self,) -> 'Any': + """ + Maps between member names and member IDs, and parameter names and parameter IDs. @@ -34441,14 +32779,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetNames(self,memberId:'Any') -> 'Any': - """ - Retrieves the variable with the specified member ID (or the name of + def GetNames(self, memberId: 'Any') -> 'Any': + """ + 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,13 +32796,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetTypeAttr(self,) -> 'Any': - """ + def GetTypeAttr(self,) -> 'Any': + """ None Args: @@ -34475,14 +32811,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetRefTypeInfo(self,hRefType:'Any') -> 'Any': - """ - If a type description references other type descriptions, it + def GetRefTypeInfo(self, hRefType: 'Any') -> 'Any': + """ + If a type description references other type descriptions, it retrieves the referenced type descriptions. @@ -34493,13 +32828,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetRefTypeOfImplType(self,hRefType:'Any') -> 'Any': - """ + def GetRefTypeOfImplType(self, hRefType: 'Any') -> 'Any': + """ Retrieves the type description of the implemented interface types. Args: @@ -34509,13 +32843,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetVarDesc(self,memberId:'Any') -> 'Any': - """ + def GetVarDesc(self, memberId: 'Any') -> 'Any': + """ None Args: @@ -34525,13 +32858,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetTypeComp(self,) -> 'Any': - """ + def GetTypeComp(self,) -> 'Any': + """ None Args: @@ -34541,20 +32873,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyITypeLib(object): - """An object that implements the ITypeLib interface.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyITypeLib(object): + """An object that implements the ITypeLib interface.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetDocumentation(self,index:'Any') -> 'Any': - """ + def GetDocumentation(self, index: 'Any') -> 'Any': + """ Retrieves documentation information about the library. Args: @@ -34565,13 +32896,12 @@ Returns: 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 + """ + pass - def GetLibAttr(self,) -> 'Any': - """ + def GetLibAttr(self,) -> 'Any': + """ Retrieves the libraries attributes Args: @@ -34581,13 +32911,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetTypeComp(self,) -> 'Any': - """ + def GetTypeComp(self,) -> 'Any': + """ None Args: @@ -34597,13 +32926,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetTypeInfo(self,index:'Any') -> 'Any': - """ + def GetTypeInfo(self, index: 'Any') -> 'Any': + """ Retrieves the specified type description in the library. Args: @@ -34613,13 +32941,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetTypeInfoCount(self,) -> 'Any': - """ + def GetTypeInfoCount(self,) -> 'Any': + """ None Args: @@ -34629,13 +32956,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetTypeInfoOfGuid(self,iid:'PyIID') -> 'Any': - """ + def GetTypeInfoOfGuid(self, iid: 'PyIID') -> 'Any': + """ Retrieves the type info of the specified GUID. Args: @@ -34645,13 +32971,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetTypeInfoType(self,index:'Any') -> 'Any': - """ + def GetTypeInfoType(self, index: 'Any') -> 'Any': + """ Retrieves the type of a type description. Args: @@ -34661,20 +32986,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIUniformResourceLocator(object): - """Interface to an internet shortcut""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIUniformResourceLocator(object): + """Interface to an internet shortcut""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetURL(self,) -> 'Any': - """ + def GetURL(self,) -> 'Any': + """ Returns the URL for the shortcut Args: @@ -34684,13 +33008,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetURL(self,URL:'Any',InFlags:'Any'=0) -> 'None': - """ + def SetURL(self, URL: 'Any', InFlags: 'Any' = 0) -> 'None': + """ Sets the URL for the shortcut Args: @@ -34701,13 +33024,12 @@ Args: Returns: None - - """ - pass + """ + pass - def InvokeCommand(self,Verb:'Any',Flags:'Any'=0,hwndParent:'int'=0) -> 'Any': - """ + def InvokeCommand(self, Verb: 'Any', Flags: 'Any' = 0, hwndParent: 'int' = 0) -> 'Any': + """ Performs one of the object's predefined actions Args: @@ -34719,20 +33041,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyIUnknown(object): - """The base object for all PythonCOM objects. Wraps a COM IUnknown object.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIUnknown(object): + """The base object for all PythonCOM objects. Wraps a COM IUnknown object.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def QueryInterface(self,iid:'Any',useIID:'Any'=None) -> 'Any': - """ + def QueryInterface(self, iid: 'Any', useIID: 'Any' = None) -> 'Any': + """ Queries an object for a specific interface. Args: @@ -34742,54 +33063,63 @@ Args: Returns: - Any:If provided and not None, will return an + Any: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 - -class PyIViewObject(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """ + pass - def Draw(self,dwDrawAspect:'Any',lindex:'Any',aspectFlags:'Any',hdcTargetDev:'Any',hdcDraw:'Any',arg:'Tuple[Any, Any, Any, Any]',arg1:'Tuple[Any, Any, Any, Any]',funcContinue:'Any',obContinue:'Any') -> 'None': - """ +class PyIViewObject(object): + """Description of the interface""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + def Draw( + self, + dwDrawAspect: 'Any', + lindex: 'Any', + aspectFlags: 'Any', + hdcTargetDev: 'Any', + hdcDraw: 'Any', + arg: 'Tuple[Any, Any, Any, Any]', + arg1: 'Tuple[Any, Any, Any, Any]', + funcContinue: 'Any', + obContinue: 'Any') -> 'None': + """ Description of Draw. Args: @@ -34807,13 +33137,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetColorSet(self,dwDrawAspect:'Any',lindex:'Any',aspectFlags:'Any',hicTargetDev:'Any') -> 'None': - """ + def GetColorSet(self, dwDrawAspect: 'Any', lindex: 'Any', aspectFlags: 'Any', hicTargetDev: 'Any') -> 'None': + """ Description of GetColorSet. Args: @@ -34826,13 +33155,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Freeze(self,dwDrawAspect:'Any',lindex:'Any',aspectFlags:'Any') -> 'None': - """ + def Freeze(self, dwDrawAspect: 'Any', lindex: 'Any', aspectFlags: 'Any') -> 'None': + """ Description of Freeze. Args: @@ -34844,13 +33172,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Unfreeze(self,dwFreeze:'Any') -> 'None': - """ + def Unfreeze(self, dwFreeze: 'Any') -> 'None': + """ Description of Unfreeze. Args: @@ -34860,13 +33187,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetAdvise(self,aspects:'Any',advf:'Any',pAdvSink:'Any') -> 'None': - """ + def SetAdvise(self, aspects: 'Any', advf: 'Any', pAdvSink: 'Any') -> 'None': + """ Description of SetAdvise. Args: @@ -34878,13 +33204,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetAdvise(self,) -> 'None': - """ + def GetAdvise(self,) -> 'None': + """ Description of GetAdvise. Args: @@ -34894,20 +33219,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyIViewObject2(object): - """Description of the interface""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyIViewObject2(object): + """Description of the interface""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetExtent(self,dwDrawAspect:'Any',lindex:'Any',targetDevice:'Any') -> 'None': - """ + def GetExtent(self, dwDrawAspect: 'Any', lindex: 'Any', targetDevice: 'Any') -> 'None': + """ Description of GetExtent. Args: @@ -34919,47 +33243,45 @@ Args: Returns: None - - """ - pass + + """ + pass class PyMAPINAMEIDArray(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyOLEMENUGROUPWIDTHS(object): - """Tuple containing 6 ints indicating nbr of options in each menu group""" + """Tuple containing 6 ints indicating nbr of options in each menu group""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyPROPERTYKEY(object): - """A tuple of a fmtid and property id (IID, int) that uniquely identifies a property""" + """A tuple of a fmtid and property id (IID, int) that uniquely identifies a property""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyPROPVARIANT(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - + """""" - @property - def vt(self)->'Any': - """The variant type, a combination of VARENUM values including flags. (read only)MethodsGetValueReturns an object representing the variant value ToStringReturns the value as a string ChangeTypeCoerce to a different variant type """ - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def vt(self) -> 'Any': + """The variant type, a combination of VARENUM values including flags. (read only)MethodsGetValueReturns an object representing the variant value ToStringReturns the value as a string ChangeTypeCoerce to a different variant type """ + pass - def GetValue(self,) -> 'Any': - """ + def GetValue(self,) -> 'Any': + """ Returns an object representing the variant value Args: @@ -34969,13 +33291,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def ToString(self,) -> 'Any': - """ + def ToString(self,) -> 'Any': + """ Returns the value as a string Args: @@ -34985,13 +33306,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def ChangeType(self,Type:'Any',Flags:'Any'=0) -> 'Any': - """ + def ChangeType(self, Type: 'Any', Flags: 'Any' = 0) -> 'Any': + """ Coerce to a different variant type Args: @@ -35002,441 +33322,415 @@ Args: Returns: Any - - """ - pass + + """ + pass class PySAndRestriction(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PySBinaryArray(object): - """A sequence of strings containing binary data.""" + """A sequence of strings containing binary data.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PySBitMaskRestriction(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PySContentRestriction(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PySExistRestriction(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PySHELL_ITEM_RESOURCE(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PySNotRestriction(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PySOrRestriction(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PySPropTagArray(object): - """A sequence of integers""" + """A sequence of integers""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') 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.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PySPropValueArray(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PySPropertyRestriction(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PySRestriction(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PySRow(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PySRowSet(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PySSortOrderItem(object): - """An item in a SortOrderSet.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySSortOrderSet(object): - """An object describing a SortOrderSet.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySTGMEDIUM(object): - """A STGMEDIUM object represents a COM STGMEDIUM structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def tymed(self)->'Any': - """An integer indicating the type of data in the stgmedium""" - pass - - - @property - def data(self)->'Any': - """The data in the stgmedium. The result depends on the value of the 'tymed' property of the PySTGMEDIUM object.tymedResult TypeTYMED_GDIAn integer GDI handleTYMED_MFPICTAn integer METAFILE handleTYMED_ENHMFAn integer ENHMETAFILE handleTYMED_HGLOBALA string with the bytes of the global memory object.TYMED_FILEA string/unicode filenameTYMED_ISTREAMA PyIStream objectTYMED_ISTORAGEA PyIStorage object""" - pass - - - @property - def data_handle(self)->'Any': - """The raw 'integer' representation of the data. For TYMED_HGLOBAL, this is the handle rather than the string data. For the string and interface types, this is an integer holding the pointer.""" - pass - - - def set(self,tymed:'Any',data:'Any') -> 'None': - """ - Sets the type and data of the object. - -Args: - - tymed(Any):The type of the data - data(Any): - -Returns: - - None - - """ - pass - - -class PyTASK_TRIGGER(object): - """Python object representing a TASK_TRIGGER structure via the structmember Api""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class RTF_WCSINFO(object): - """A tuple representing a RTF_WCSINFO structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """An item in a SortOrderSet.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') -class SHFILEINFO(object): - """A tuple representing a SHFILEINFO structure - -Represented as a tuple of (hIcon, iIcon, dwAttributes, displayName, typeName)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SHFILEOPSTRUCT(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SI_ACCESS(object): - """Tuple of 4 items representing SI_ACCESS struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SI_INHERIT_TYPE(object): - """Tuple of 3 items describing a method of inheritance""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PySSortOrderSet(object): + """An object describing a SortOrderSet.""" -class SI_OBJECT_INFO(object): - """Six-tuple representing SI_OBJECT_INFO struct""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PySTGMEDIUM(object): + """A STGMEDIUM object represents a COM STGMEDIUM structure.""" -class STATSTG(object): - """A tuple representing a STATSTG structure""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + @property + def tymed(self) -> 'Any': + """An integer indicating the type of data in the stgmedium""" + pass + @property + def data(self) -> 'Any': + """The data in the stgmedium. The result depends on the value of the 'tymed' property of the PySTGMEDIUM object.tymedResult TypeTYMED_GDIAn integer GDI handleTYMED_MFPICTAn integer METAFILE handleTYMED_ENHMFAn integer ENHMETAFILE handleTYMED_HGLOBALA string with the bytes of the global memory object.TYMED_FILEA string/unicode filenameTYMED_ISTREAMA PyIStream objectTYMED_ISTORAGEA PyIStorage object""" + pass -class TLIBATTR(object): - """Type library attributes are represented as a tuple of:""" + @property + def data_handle(self) -> 'Any': + """The raw 'integer' representation of the data. For TYMED_HGLOBAL, this is the handle rather than the string data. For the string and interface types, this is an integer holding the pointer.""" + pass - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def set(self, tymed: 'Any', data: 'Any') -> 'None': + """ + Sets the type and data of the object. +Args: -class TYPEATTR(object): - """A TYPEATTR object represents a COM TYPEATTR structure.""" + tymed(Any):The type of the data + data(Any): - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +Returns: + None - @property - def iid(self)->'PyIID': - """The IID""" - pass + """ + pass - @property - def lcid(self)->'Any': - """The lcid""" - pass +class PyTASK_TRIGGER(object): + """Python object representing a TASK_TRIGGER structure via the structmember Api""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def memidConstructor(self)->'Any': - """ID of constructor""" - pass +class RTF_WCSINFO(object): + """A tuple representing a RTF_WCSINFO structure""" - @property - def memidDestructor(self)->'Any': - """ID of destructor""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def cbSizeInstance(self)->'Any': - """The size of an instance of this type""" - pass +class SHFILEINFO(object): + """A tuple representing a SHFILEINFO structure +Represented as a tuple of (hIcon, iIcon, dwAttributes, displayName, typeName)""" - @property - def typekind(self)->'Any': - """The kind of type this information describes. One of the win32con.TKIND_* constants.""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def cFuncs(self)->'Any': - """Number of functions.""" - pass +class SHFILEOPSTRUCT(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def cVars(self)->'Any': - """Number of variables/data members.""" - pass +class SI_ACCESS(object): + """Tuple of 4 items representing SI_ACCESS struct""" - @property - def cImplTypes(self)->'Any': - """Number of implemented interfaces.""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def cbSizeVft(self)->'Any': - """The size of this type's VTBL""" - pass +class SI_INHERIT_TYPE(object): + """Tuple of 3 items describing a method of inheritance""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def cbAlignment(self)->'Any': - """Byte alignment for an instance of this type.""" - pass +class SI_OBJECT_INFO(object): + """Six-tuple representing SI_OBJECT_INFO struct""" - @property - def wTypeFlags(self)->'Any': - """One of the pythoncom TYPEFLAG_""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def wMajorVerNum(self)->'Any': - """Major version number.""" - pass +class STATSTG(object): + """A tuple representing a STATSTG structure""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def wMinorVerNum(self)->'Any': - """Minor version number.""" - pass +class TLIBATTR(object): + """Type library attributes are represented as a tuple of:""" - @property - def tdescAlias(self)->'Any': - """If TypeKind == pythoncom.TKIND_ALIAS, specifies the type for which this type is an alias.""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def idldeskType(self)->'Any': - """IDL attributes of the described type.""" - pass +class TYPEATTR(object): + """A TYPEATTR object represents a COM TYPEATTR structure.""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def iid(self) -> 'PyIID': + """The IID""" + pass + + @property + def lcid(self) -> 'Any': + """The lcid""" + pass + + @property + def memidConstructor(self) -> 'Any': + """ID of constructor""" + pass + + @property + def memidDestructor(self) -> 'Any': + """ID of destructor""" + pass + + @property + def cbSizeInstance(self) -> 'Any': + """The size of an instance of this type""" + pass + + @property + def typekind(self) -> 'Any': + """The kind of type this information describes. One of the win32con.TKIND_* constants.""" + pass + + @property + def cFuncs(self) -> 'Any': + """Number of functions.""" + pass + + @property + def cVars(self) -> 'Any': + """Number of variables/data members.""" + pass + + @property + def cImplTypes(self) -> 'Any': + """Number of implemented interfaces.""" + pass + + @property + def cbSizeVft(self) -> 'Any': + """The size of this type's VTBL""" + pass + + @property + def cbAlignment(self) -> 'Any': + """Byte alignment for an instance of this type.""" + pass + + @property + def wTypeFlags(self) -> 'Any': + """One of the pythoncom TYPEFLAG_""" + pass + + @property + def wMajorVerNum(self) -> 'Any': + """Major version number.""" + pass + + @property + def wMinorVerNum(self) -> 'Any': + """Minor version number.""" + pass + + @property + def tdescAlias(self) -> 'Any': + """If TypeKind == pythoncom.TKIND_ALIAS, specifies the type for which this type is an alias.""" + pass + + @property + def idldeskType(self) -> 'Any': + """IDL attributes of the described type.""" + pass 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 ...""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class VARDESC(object): - """A VARDESC object represents a COM VARDESC structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """A VARDESC object represents a COM VARDESC structure.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def memid(self)->'Any': - """The dispid of the member""" - pass + @property + def memid(self) -> 'Any': + """The dispid of the member""" + pass + @property + def value(self) -> 'Union[Any]': + """A value for the variant. If PERINSTANCE then an offset into the instance, otherwise a variant converted to a Python object.""" + pass - @property - def value(self)->'Union[Any]': - """A value for the variant. If PERINSTANCE then an offset into the instance, otherwise a variant converted to a Python object.""" - pass + @property + def elemdescVar(self) -> 'Any': + """Object describing the member.""" + pass + @property + def varFlags(self) -> 'Any': + """Variable flags""" + pass - @property - def elemdescVar(self)->'Any': - """Object describing the member.""" - pass - - - @property - def varFlags(self)->'Any': - """Variable flags""" - pass - - - @property - def varkind(self)->'Any': - """Kind flags.""" - pass + @property + def varkind(self) -> 'Any': + """Kind flags.""" + pass class CHARFORMAT(object): - """Describes a CHARFORMAT tuple""" + """Describes a CHARFORMAT tuple""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class CREATESTRUCT(object): - """A representation of a Windows CREATESTRUCT structure.""" + """A representation of a Windows CREATESTRUCT structure.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class LV_COLUMN(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class LV_ITEM(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PARAFORMAT(object): - """Describes a PARAFORMAT tuple""" + """Describes a PARAFORMAT tuple""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyAssocCObject(object): - """An internal class.""" + """An internal class.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyAssocObject(object): - """An internal class.""" + """An internal class.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - - def AttachObject(self,) -> 'None': - """ + def AttachObject(self,) -> 'None': + """ Attaches a Python object for lookup of "virtual" functions. Args: @@ -35446,13 +33740,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetAttachedObject(self,) -> 'Any': - """ + def GetAttachedObject(self,) -> 'Any': + """ Returned the attached Python object, or None. Args: @@ -35462,20 +33755,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyCBitmap(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCBitmap(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def CreateCompatibleBitmap(self,dc:'Any',width:'Any',height:'Any') -> 'None': - """ + def CreateCompatibleBitmap(self, dc: 'Any', width: 'Any', height: 'Any') -> 'None': + """ Creates a bitmap compatible with the specified device context. Args: @@ -35487,13 +33779,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetSize(self,) -> 'Tuple[Any, Any]': - """ + def GetSize(self,) -> 'Tuple[Any, Any]': + """ Returns the size of the bitmap object. Args: @@ -35503,13 +33794,12 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def GetHandle(self,) -> 'Any': - """ + def GetHandle(self,) -> 'Any': + """ Returns the HBITMAP for a bitmap object Args: @@ -35519,13 +33809,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def LoadBitmap(self,idRes:'Any',obDLL:'Any'=None) -> 'None': - """ + def LoadBitmap(self, idRes: 'Any', obDLL: 'Any' = None) -> 'None': + """ Loads a bitmap from a DLL object. Args: @@ -35536,14 +33825,13 @@ Args: Returns: None - - """ - pass + """ + pass - def LoadBitmapFile(self,fileObject:'Any') -> 'None': - """ - Loads a bitmap (.BMP) format + def LoadBitmapFile(self, fileObject: 'Any') -> 'None': + """ + Loads a bitmap (.BMP) format from a file object. @@ -35554,14 +33842,13 @@ Args: Returns: None - - """ - pass + """ + pass - def LoadPPMFile(self,fileObject:'Any',cols:'Any',rows:'Any') -> 'None': - """ - Loads a bitmap in Portable Pix Map (PPM) format + def LoadPPMFile(self, fileObject: 'Any', cols: 'Any', rows: 'Any') -> 'None': + """ + Loads a bitmap in Portable Pix Map (PPM) format from a file object. @@ -35574,13 +33861,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Paint(self,dcObject:'Any',arg:'Tuple[Any, Any, Any, Any]',arg1:'Tuple[Any, Any, Any, Any]') -> 'None': - """ + def Paint(self, dcObject: 'Any', arg: 'Tuple[Any, Any, Any, Any]', arg1: 'Tuple[Any, Any, Any, Any]') -> 'None': + """ Paint a bitmap. Args: @@ -35592,13 +33878,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetInfo(self,) -> 'Any': - """ + def GetInfo(self,) -> 'Any': + """ Returns the BITMAP structure info Args: @@ -35610,27 +33895,26 @@ Returns: 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 + """ + pass - def GetBitmapBits(self,asString:'Any'=0) -> 'Union[Any, str]': - """ + def GetBitmapBits(self, asString: 'Any' = 0) -> 'Union[Any, str]': + """ Returns the bitmap bits. Args: @@ -35640,13 +33924,12 @@ Args: Returns: Union[Any, str] - - """ - pass + """ + pass - def SaveBitmapFile(self,dcObject:'Any',Filename:'str') -> 'Any': - """ + def SaveBitmapFile(self, dcObject: 'Any', Filename: 'str') -> 'Any': + """ Saves a bitmap to a file. Args: @@ -35657,20 +33940,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyCBrush(object): - """An object encapsulating an MFC PyCBrush class.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCBrush(object): + """An object encapsulating an MFC PyCBrush class.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def CreateSolidBrush(self,) -> 'None': - """ + def CreateSolidBrush(self,) -> 'None': + """ Initializes a brush with a specified solid color. Args: @@ -35680,13 +33962,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetSafeHandle(self,) -> 'Any': - """ + def GetSafeHandle(self,) -> 'Any': + """ Retrieves the HBRUSH for the brush as an integer Args: @@ -35696,20 +33977,25 @@ Args: Returns: Any - - """ - pass - - -class PyCButton(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """ + pass - def CreateWindow(self,caption:'str',style:'Any',rect:'Tuple[Any, Any, Any, Any]',parent:'Any',_id:'Any') -> 'None': - """ +class PyCButton(object): + """""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + def CreateWindow( + self, + caption: 'str', + style: 'Any', + rect: 'Tuple[Any, Any, Any, Any]', + parent: 'Any', + _id: 'Any') -> 'None': + """ Creates the window for a new button object. Args: @@ -35723,13 +34009,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetBitmap(self,) -> 'Any': - """ + def GetBitmap(self,) -> 'Any': + """ Get the button's bitmap Args: @@ -35739,13 +34024,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetBitmap(self,hBitmap:'Any'=1) -> 'Any': - """ + def SetBitmap(self, hBitmap: 'Any' = 1) -> 'Any': + """ Set the button's bitmap Args: @@ -35755,13 +34039,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetCheck(self,) -> 'Any': - """ + def GetCheck(self,) -> 'Any': + """ Retrieves the check state of a radio button or check box. Args: @@ -35771,13 +34054,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetCheck(self,idCheck:'Any') -> 'None': - """ + def SetCheck(self, idCheck: 'Any') -> 'None': + """ Sets or resets the state of a radio button or check box. Args: @@ -35787,13 +34069,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetState(self,) -> 'Any': - """ + def GetState(self,) -> 'Any': + """ Returns the state of the button. Args: @@ -35803,13 +34084,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetState(self,bHighlight:'Any') -> 'Any': - """ + def SetState(self, bHighlight: 'Any') -> 'Any': + """ Sets the state of the button. Args: @@ -35819,13 +34099,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetButtonStyle(self,) -> 'Any': - """ + def GetButtonStyle(self,) -> 'Any': + """ Gets the style of the button. Args: @@ -35835,13 +34114,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetButtonStyle(self,style:'Any',bRedraw:'Any'=1) -> 'Any': - """ + def SetButtonStyle(self, style: 'Any', bRedraw: 'Any' = 1) -> 'Any': + """ Sets the style of the button. Args: @@ -35852,20 +34130,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyCCmdTarget(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCCmdTarget(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def BeginWaitCursor(self,) -> 'None': - """ + def BeginWaitCursor(self,) -> 'None': + """ None Args: @@ -35875,13 +34152,12 @@ Args: Returns: None - - """ - pass + """ + pass - def EndWaitCursor(self,) -> 'None': - """ + def EndWaitCursor(self,) -> 'None': + """ None Args: @@ -35891,13 +34167,12 @@ Args: Returns: None - - """ - pass + """ + pass - def HookCommand(self,obHandler:'Any',_id:'Any') -> 'Any': - """ + def HookCommand(self, obHandler: 'Any', _id: 'Any') -> 'Any': + """ Hook a windows command handler. Args: @@ -35909,42 +34184,41 @@ Returns: 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 + """ + pass - def HookCommandUpdate(self,obHandler:'Any',_id:'Any') -> 'Any': - """ + def HookCommandUpdate(self, obHandler: 'Any', _id: 'Any') -> 'Any': + """ Hook a windows command update handler. Args: @@ -35956,24 +34230,23 @@ Returns: 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 + """ + pass - def HookOleEvent(self,) -> 'Any': - """ + def HookOleEvent(self,) -> 'Any': + """ Hook an OLE Event. Args: @@ -35987,13 +34260,12 @@ Returns: object = HookOleEvent()Hook an OLE Event. Return ValueThe return value is the previous handler, or None. - - """ - pass + """ + pass - def HookNotify(self,obHandler:'Any',_id:'Any') -> 'Any': - """ + def HookNotify(self, obHandler: 'Any', _id: 'Any') -> 'Any': + """ Hook a windows command handler. Args: @@ -36005,41 +34277,40 @@ Returns: 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 + """ + pass - def RestoreWaitCursor(self,) -> 'None': - """ - Restores the appropriate hourglass cursor after the system cursor has + def RestoreWaitCursor(self,) -> 'None': + """ + Restores the appropriate hourglass cursor after the system cursor has changed. @@ -36050,44 +34321,39 @@ Args: Returns: None - - """ - pass - -class PyCCmdUI(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def m_nIndex(self)->'Any': - """""" - pass + """ + pass - @property - def m_nID(self)->'Any': - """""" - pass +class PyCCmdUI(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def m_pMenu(self)->'Any': - """""" - pass + @property + def m_nIndex(self) -> 'Any': + """""" + pass + @property + def m_nID(self) -> 'Any': + """""" + pass - @property - def m_pSubMenu(self)->'Any': - """""" - pass + @property + def m_pMenu(self) -> 'Any': + """""" + pass + @property + def m_pSubMenu(self) -> 'Any': + """""" + pass - def Enable(self,bEnable:'Any'=1) -> 'None': - """ + def Enable(self, bEnable: 'Any' = 1) -> 'None': + """ Enables or disables the user-interface item for this command. Args: @@ -36097,13 +34363,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetCheck(self,state:'Any'=1) -> 'None': - """ + def SetCheck(self, state: 'Any' = 1) -> 'None': + """ Sets the check state of the user-interface item for this command. Args: @@ -36113,13 +34378,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetRadio(self,bOn:'Any'=1) -> 'None': - """ + def SetRadio(self, bOn: 'Any' = 1) -> 'None': + """ Like the SetCheck member function, but operates on radio groups. Args: @@ -36129,13 +34393,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetText(self,text:'str') -> 'None': - """ + def SetText(self, text: 'str') -> 'None': + """ Sets the text for the user-interface item for this command. Args: @@ -36145,14 +34408,13 @@ Args: Returns: None - - """ - pass + """ + pass - def ContinueRouting(self,) -> 'None': - """ - Tells the command-routing mechanism to continue routing the current message down + def ContinueRouting(self,) -> 'None': + """ + Tells the command-routing mechanism to continue routing the current message down the chain of handlers. @@ -36163,20 +34425,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyCColorDialog(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCColorDialog(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetColor(self,) -> 'Any': - """ + def GetColor(self,) -> 'Any': + """ Determines the selected color. Args: @@ -36186,13 +34447,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def DoModal(self,) -> 'Any': - """ + def DoModal(self,) -> 'Any': + """ Displays a dialog and allows the user to make a selection. Args: @@ -36202,13 +34462,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetSavedCustomColors(self,) -> 'Any': - """ + def GetSavedCustomColors(self,) -> 'Any': + """ Returns the saved custom colors. Args: @@ -36218,13 +34477,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetCurrentColor(self,color:'Any') -> 'None': - """ + def SetCurrentColor(self, color: 'Any') -> 'None': + """ Sets the currently selected color. Args: @@ -36234,13 +34492,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetCustomColors(self,) -> 'None': - """ + def SetCustomColors(self,) -> 'None': + """ Sets one or more custom colors Args: @@ -36250,13 +34507,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetCustomColors(self,) -> 'Tuple[Any, ...]': - """ + def GetCustomColors(self,) -> 'Tuple[Any, ...]': + """ Gets the 16 currently defined custom colors Args: @@ -36266,20 +34522,19 @@ Args: Returns: Tuple[Any, ...] - - """ - pass + """ + pass -class PyCComboBox(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCComboBox(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def AddString(self,_object:'Any') -> 'Any': - """ + def AddString(self, _object: 'Any') -> 'Any': + """ Adds a string to a combobox. Args: @@ -36291,13 +34546,12 @@ Returns: Any:CComboBox::AddString Return ValueThe zero based index of the new string. - - """ - pass + """ + pass - def DeleteString(self,pos:'Any') -> 'Any': - """ + def DeleteString(self, pos: 'Any') -> 'Any': + """ Deletes an item from a combobox. Args: @@ -36309,13 +34563,12 @@ Returns: Any:CComboBox::DeleteString Return ValueThe count of the items remaining in the list. - - """ - pass + """ + pass - def Dir(self,attr:'Any',wild:'str') -> 'Any': - """ + def Dir(self, attr: 'Any', wild: 'str') -> 'Any': + """ Fills the list portion of a combobox with a directory listing. Args: @@ -36328,13 +34581,12 @@ Returns: Any:CComboBox::Dir Return ValueThe index of the last file name added to the list. - - """ - pass + """ + pass - def GetCount(self,) -> 'Any': - """ + def GetCount(self,) -> 'Any': + """ Returns the count of items in the combobox. Args: @@ -36346,13 +34598,12 @@ Returns: Any:CListBox::GetCount Return ValueReturns the number of items currently in the combobox. - - """ - pass + """ + pass - def GetCurSel(self,) -> 'Any': - """ + def GetCurSel(self,) -> 'Any': + """ Returns the index of the currently selected item. Args: @@ -36362,13 +34613,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetEditSel(self,) -> 'Any': - """ + def GetEditSel(self,) -> 'Any': + """ Returns the selection of the edit control portion of a combo box. Args: @@ -36378,21 +34628,20 @@ Args: Returns: 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 + """ + pass - def GetExtendedUI(self,) -> 'Any': - """ + def GetExtendedUI(self,) -> 'Any': + """ Indicates if the combo has the extended interface. Args: @@ -36404,13 +34653,12 @@ Returns: Any:CComboBox::GetExtendedUI Return ValueNonzero if the combo box has the extended user interface; otherwise 0. - - """ - pass + """ + pass - def GetItemData(self,item:'Any') -> 'Any': - """ + def GetItemData(self, item: 'Any') -> 'Any': + """ Retrieves the application-specific object associated with an item. Args: @@ -36420,13 +34668,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetItemValue(self,item:'Any') -> 'Any': - """ + def GetItemValue(self, item: 'Any') -> 'Any': + """ Retrieves the application-specific value associated with an item. Args: @@ -36436,13 +34683,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetLBText(self,index:'Any') -> 'str': - """ + def GetLBText(self, index: 'Any') -> 'str': + """ Gets the string from the list of a combo box. Args: @@ -36451,17 +34697,16 @@ 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 + """ + pass - def GetLBTextLen(self,index:'Any') -> 'Any': - """ + def GetLBTextLen(self, index: 'Any') -> 'Any': + """ Returns the length of a string in the list of a combobox. Args: @@ -36471,13 +34716,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def InsertString(self,pos:'Any',_object:'Any') -> 'Any': - """ + def InsertString(self, pos: 'Any', _object: 'Any') -> 'Any': + """ Insert a string into a combobox. Args: @@ -36490,13 +34734,12 @@ Returns: Any:CComboBox::InsertString Return ValueThe zero based index of the new string added. - - """ - pass + """ + pass - def LimitText(self,_max:'Any') -> 'Any': - """ + def LimitText(self, _max: 'Any') -> 'Any': + """ Limits the amount of text the edit portion of a combo box can hold. Args: @@ -36506,13 +34749,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def ResetContent(self,) -> 'None': - """ + def ResetContent(self,) -> 'None': + """ Clear all the items from a combobox. Args: @@ -36522,13 +34764,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SelectString(self,after:'Any',string:'str') -> 'None': - """ + def SelectString(self, after: 'Any', string: 'str') -> 'None': + """ Searches for a combobox item that matches the specified string, and selects it. Args: @@ -36541,13 +34782,12 @@ Returns: None:CComboBoxBox::SelectString Return ValueThe return value is always None - an exception is raised if the string can not be located. - - """ - pass + """ + pass - def SetCurSel(self,index:'Any') -> 'None': - """ + def SetCurSel(self, index: 'Any') -> 'None': + """ Selects an item in a combobox. Args: @@ -36557,13 +34797,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetEditSel(self,start:'Any',end:'Any') -> 'None': - """ + def SetEditSel(self, start: 'Any', end: 'Any') -> 'None': + """ Sets the selection in the edit control portion of a combo box. Args: @@ -36574,17 +34813,16 @@ 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 + """ + pass - def SetExtendedUI(self,bExtended:'Any'=1) -> 'None': - """ + def SetExtendedUI(self, bExtended: 'Any' = 1) -> 'None': + """ Selects the Extended UI mode for a combo box. Args: @@ -36594,13 +34832,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetItemData(self,item:'Any',Data:'Any') -> 'Any': - """ + def SetItemData(self, item: 'Any', Data: 'Any') -> 'Any': + """ Sets the item's application-specific object value. Args: @@ -36611,13 +34848,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetItemValue(self,item:'Any',data:'Any') -> 'Any': - """ + def SetItemValue(self, item: 'Any', data: 'Any') -> 'Any': + """ Sets the item's application-specific value. Args: @@ -36628,13 +34864,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def ShowDropDown(self,bShowIt:'Any'=1) -> 'None': - """ + def ShowDropDown(self, bShowIt: 'Any' = 1) -> 'None': + """ Shows or hides the listbox portion of a combo box. Args: @@ -36644,65 +34879,59 @@ Args: Returns: None - - """ - pass + + """ + pass class PyCCommonDialog(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyCControl(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyCControlBar(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dockSite(self)->'Any': - """Current dock site, if dockable""" - pass - - - @property - def dockBar(self)->'Any': - """Current dock bar, if dockable""" - pass - + """""" - @property - def dockContext(self)->'Any': - """Used during dragging""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def dockSite(self) -> 'Any': + """Current dock site, if dockable""" + pass - @property - def dwStyle(self)->'Any': - """creation style (used for layout)""" - pass + @property + def dockBar(self) -> 'Any': + """Current dock bar, if dockable""" + pass + @property + def dockContext(self) -> 'Any': + """Used during dragging""" + pass - @property - def dwDockStyle(self)->'Any': - """indicates how bar can be docked""" - pass + @property + def dwStyle(self) -> 'Any': + """creation style (used for layout)""" + pass + @property + def dwDockStyle(self) -> 'Any': + """indicates how bar can be docked""" + pass - def CalcDynamicLayout(self,length:'Any',dwMode:'Any') -> 'Any': - """ - The framework calls this member function to calculate the dimensions of + def CalcDynamicLayout(self, length: 'Any', dwMode: 'Any') -> 'Any': + """ + The framework calls this member function to calculate the dimensions of a dynamic toolbar. @@ -36714,13 +34943,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def CalcFixedLayout(self,bStretch:'Any',bHorz:'Any') -> 'Any': - """ + def CalcFixedLayout(self, bStretch: 'Any', bHorz: 'Any') -> 'Any': + """ Calculates the horizontal size of a control bar Args: @@ -36731,14 +34959,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def EnableDocking(self,style:'Any') -> 'None': - """ - pecifies whether the control bar supports docking and the sides of its parent + def EnableDocking(self, style: 'Any') -> 'None': + """ + pecifies whether the control bar supports docking and the sides of its parent window. @@ -36749,13 +34976,12 @@ Args: Returns: None - - """ - pass + """ + pass - def EraseNonClient(self,) -> 'None': - """ + def EraseNonClient(self,) -> 'None': + """ None Args: @@ -36765,13 +34991,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetBarStyle(self,) -> 'Any': - """ + def GetBarStyle(self,) -> 'Any': + """ Retrieves the control bar style settings. Args: @@ -36781,13 +35006,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetCount(self,) -> 'Any': - """ + def GetCount(self,) -> 'Any': + """ Returns the number of non-HWND elements in the control bar. Args: @@ -36797,13 +35021,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetDockingFrame(self,) -> 'Any': - """ + def GetDockingFrame(self,) -> 'Any': + """ Returns the frame window to which a control bar is docked. Args: @@ -36813,14 +35036,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def IsFloating(self,) -> 'Any': - """ - Returns a nonzero value if the control bar in question is a floating control + def IsFloating(self,) -> 'Any': + """ + Returns a nonzero value if the control bar in question is a floating control bar. @@ -36831,13 +35053,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetBarStyle(self,style:'Any') -> 'None': - """ + def SetBarStyle(self, style: 'Any') -> 'None': + """ Modifies the control bar style settings. Args: @@ -36847,13 +35068,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ShowWindow(self,) -> 'Any': - """ + def ShowWindow(self,) -> 'Any': + """ Shows the toolbar, and recalculates the button layout. Args: @@ -36867,25 +35087,24 @@ 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 + """ + pass -class PyCCtrlView(object): - """A class which implementes a CCtrlView (ie, a view based on a dialog resource.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCCtrlView(object): + """A class which implementes a CCtrlView (ie, a view based on a dialog resource.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def OnCommand(self,wparam:'Any',lparam:'Any') -> 'None': - """ + def OnCommand(self, wparam: 'Any', lparam: 'Any') -> 'None': + """ Calls the standard Python framework OnCommand handler Args: @@ -36896,20 +35115,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyCDC(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCDC(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def AbortDoc(self,) -> 'None': - """ + def AbortDoc(self,) -> 'None': + """ Aborts a print job Args: @@ -36919,13 +35137,16 @@ Args: Returns: None - - """ - pass + """ + pass - def Arc(self,rect:'Tuple[Any, Any, Any, Any]',pointStart:'Tuple[Any, Any]',pointEnd:'Tuple[Any, Any]') -> 'None': - """ + def Arc( + self, + rect: 'Tuple[Any, Any, Any, Any]', + pointStart: 'Tuple[Any, Any]', + pointEnd: 'Tuple[Any, Any]') -> 'None': + """ Draws an eliptical arc. Args: @@ -36939,13 +35160,12 @@ Returns: None:CDC::Arc Return ValueAlways none. If the function fails, an exception is raised. - - """ - pass + """ + pass - def BeginPath(self,) -> 'None': - """ + def BeginPath(self,) -> 'None': + """ Opens a path bracket in the device context Args: @@ -36955,13 +35175,18 @@ Args: Returns: None - - """ - pass + """ + pass - def BitBlt(self,destPos:'Tuple[Any, Any]',size:'Tuple[Any, Any]',dc:'Any',srcPos:'Tuple[Any, Any]',rop:'Any') -> 'None': - """ + def BitBlt( + self, + destPos: 'Tuple[Any, Any]', + size: 'Tuple[Any, Any]', + dc: 'Any', + srcPos: 'Tuple[Any, Any]', + rop: 'Any') -> 'None': + """ Copies a bitmap from the source device context to this device context. Args: @@ -36975,13 +35200,16 @@ Args: Returns: None - - """ - pass + """ + pass - def Chord(self,rect:'Tuple[Any, Any, Any, Any]',pointStart:'Tuple[Any, Any]',pointEnd:'Tuple[Any, Any]') -> 'None': - """ + def Chord( + self, + rect: 'Tuple[Any, Any, Any, Any]', + pointStart: 'Tuple[Any, Any]', + pointEnd: 'Tuple[Any, Any]') -> 'None': + """ Draws a chord. Args: @@ -36995,13 +35223,12 @@ Returns: None:CDC::Chord Return ValueAlways none. If the function fails, an exception is raised. - - """ - pass + """ + pass - def CreateCompatibleDC(self,dcFrom:'Any'=None) -> PyCDC: - """ + def CreateCompatibleDC(self, dcFrom: 'Any' = None) -> PyCDC: + """ Creates a memory device context that is compatible with this DC. Args: @@ -37011,13 +35238,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CreatePrinterDC(self,printerName:'str'=None) -> 'None': - """ + def CreatePrinterDC(self, printerName: 'str' = None) -> 'None': + """ Creates a device context for a specific printer Args: @@ -37027,13 +35253,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DeleteDC(self,) -> 'None': - """ + def DeleteDC(self,) -> 'None': + """ Deletes all resources associated with a device context. Args: @@ -37043,13 +35268,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DPtoLP(self,point:'Tuple[Any, Any]',x:'Any',y:'Any') -> 'Tuple[Any, Any]': - """ + def DPtoLP(self, point: 'Tuple[Any, Any]', x: 'Any', y: 'Any') -> 'Tuple[Any, Any]': + """ Converts device units into logical units. Args: @@ -37064,13 +35288,12 @@ Returns: To Do Should really handle list of (x,y) points Return ValueThe converted coordinates. - - """ - pass + """ + pass - def Draw3dRect(self,rect:'Tuple[Any, Any, Any, Any]',colorTopLeft:'Any',colorBotRight:'Any') -> 'None': - """ + def Draw3dRect(self, rect: 'Tuple[Any, Any, Any, Any]', colorTopLeft: 'Any', colorBotRight: 'Any') -> 'None': + """ Draws a three-dimensional rectangle. Args: @@ -37082,14 +35305,13 @@ Args: Returns: None - - """ - pass + """ + pass - def DrawFocusRect(self,rect:'Tuple[Any, Any, Any, Any]') -> 'None': - """ - Draws a rectangle in the style used to + def DrawFocusRect(self, rect: 'Tuple[Any, Any, Any, Any]') -> 'None': + """ + Draws a rectangle in the style used to indicate the rectangle has focus @@ -37100,13 +35322,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DrawFrameControl(self,rect:'Tuple[Any, Any, Any, Any]',typ:'Any',state:'Any') -> 'None': - """ + def DrawFrameControl(self, rect: 'Tuple[Any, Any, Any, Any]', typ: 'Any', state: 'Any') -> 'None': + """ Draws a frame control of the specified type and style. Args: @@ -37118,13 +35339,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DrawIcon(self,point:'Tuple[Any, Any]',hIcon:'int') -> 'None': - """ + def DrawIcon(self, point: 'Tuple[Any, Any]', hIcon: 'int') -> 'None': + """ Draws an icon on the DC. Args: @@ -37135,13 +35355,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DrawText(self,s:'str',_tuple:'Tuple[Any, Any, Any, Any]',_format:'Any') -> 'Tuple[Any, Any, Any]': - """ + def DrawText(self, s: 'str', _tuple: 'Tuple[Any, Any, Any, Any]', _format: 'Any') -> 'Tuple[Any, Any, Any]': + """ Formats text in the given rectangle Args: @@ -37152,9 +35371,9 @@ Args: Returns: - Tuple[Any, Any, Any]:Specifies one or more bit-or'd format values, such as + Tuple[Any, Any, 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,21 +35417,20 @@ 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 + """ + pass - def Ellipse(self,rect:'Tuple[Any, Any, Any, Any]') -> 'None': - """ + def Ellipse(self, rect: 'Tuple[Any, Any, Any, Any]') -> 'None': + """ Draws an Ellipse. Args: @@ -37224,13 +35442,12 @@ Returns: None:CDC::Ellipse Return ValueAlways none. If the function fails, an exception is raised. - - """ - pass + """ + pass - def EndDoc(self,) -> 'None': - """ + def EndDoc(self,) -> 'None': + """ Finishes spooling the document and starts printing it Args: @@ -37240,13 +35457,12 @@ Args: Returns: None - - """ - pass + """ + pass - def EndPage(self,) -> 'None': - """ + def EndPage(self,) -> 'None': + """ Finishes a page on a printer DC Args: @@ -37256,14 +35472,13 @@ Args: Returns: None - - """ - pass + """ + pass - def EndPath(self,) -> 'None': - """ - Closes a path bracket and selects the path defined by the bracket into the specified device + def EndPath(self,) -> 'None': + """ + Closes a path bracket and selects the path defined by the bracket into the specified device context @@ -37274,13 +35489,19 @@ Args: Returns: None - - """ - pass + """ + pass - def ExtTextOut(self,_int:'Any',_int1:'Any',_int2:'Any',rect:'Tuple[Any, Any, Any, Any]',string:'Any',_tuple:'Tuple[Tuple[Any, Any], ...]') -> 'None': - """ + def ExtTextOut( + self, + _int: 'Any', + _int1: 'Any', + _int2: 'Any', + rect: 'Tuple[Any, Any, Any, Any]', + string: 'Any', + _tuple: 'Tuple[Tuple[Any, Any], ...]') -> 'None': + """ Writes text to the DC. Args: @@ -37297,14 +35518,13 @@ Returns: None:CDC::ExtTextOut Return ValueAlways none. If the function fails, an exception is raised. - - """ - pass + """ + pass - def FillPath(self,) -> 'None': - """ - Closes any open figures in the current path and fills the path's interior by using the + def FillPath(self,) -> 'None': + """ + 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,13 +35535,12 @@ Args: Returns: None - - """ - pass + """ + pass - def FillRect(self,rect:'Tuple[Any, Any, Any, Any]',brush:'Any') -> 'None': - """ + def FillRect(self, rect: 'Tuple[Any, Any, Any, Any]', brush: 'Any') -> 'None': + """ Fills a given rectangle with the specified brush Args: @@ -37332,13 +35551,12 @@ Args: Returns: None - - """ - pass + """ + pass - def FillSolidRect(self,rect:'Tuple[Any, Any, Any, Any]',color:'Any') -> 'None': - """ + def FillSolidRect(self, rect: 'Tuple[Any, Any, Any, Any]', color: 'Any') -> 'None': + """ Fills the given rectangle with the specified solid color. Args: @@ -37349,13 +35567,12 @@ Args: Returns: None - - """ - pass + """ + pass - def FrameRect(self,rect:'Tuple[Any, Any, Any, Any]',brush:'Any') -> 'None': - """ + def FrameRect(self, rect: 'Tuple[Any, Any, Any, Any]', brush: 'Any') -> 'None': + """ Draws a border around the rectangle specified by rect Args: @@ -37366,14 +35583,13 @@ Args: Returns: None - - """ - pass + """ + pass - def GetBrushOrg(self,) -> 'Tuple[Any, Any]': - """ - Retrieves the origin (in device units) of the brush currently selected for the + def GetBrushOrg(self,) -> 'Tuple[Any, Any]': + """ + Retrieves the origin (in device units) of the brush currently selected for the device context. @@ -37384,14 +35600,13 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def GetClipBox(self,) -> 'Tuple[Any, Any, Any, Any]': - """ - Retrieves the dimensions of the smallest bounding rectangle + def GetClipBox(self,) -> 'Tuple[Any, Any, Any, Any]': + """ + Retrieves the dimensions of the smallest bounding rectangle around the current clipping boundary. @@ -37404,13 +35619,12 @@ Returns: Tuple[Any, Any, Any, Any]:CDC::GetClipBox Return ValueA tuple of integers specifying the rectangle. - - """ - pass + """ + pass - def GetCurrentPosition(self,) -> 'Tuple[Any, Any]': - """ + def GetCurrentPosition(self,) -> 'Tuple[Any, Any]': + """ Retrieves the current position (in logical coordinates). Args: @@ -37420,13 +35634,12 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def GetDeviceCaps(self,index:'Any') -> 'Any': - """ + def GetDeviceCaps(self, index: 'Any') -> 'Any': + """ Retrieves a capability of the device context. Args: @@ -37438,13 +35651,12 @@ Returns: Any:CDC::GetDeviceCaps Return ValueThe value of the requested capability - - """ - pass + """ + pass - def GetHandleAttrib(self,) -> 'Any': - """ + def GetHandleAttrib(self,) -> 'Any': + """ Retrieves the handle of the attribute device context. Args: @@ -37454,13 +35666,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetHandleOutput(self,) -> 'Any': - """ + def GetHandleOutput(self,) -> 'Any': + """ Retrieves the handle of the output device context. Args: @@ -37470,13 +35681,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetMapMode(self,) -> 'Any': - """ + def GetMapMode(self,) -> 'Any': + """ Gets the mapping mode for the device context. Args: @@ -37486,13 +35696,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetNearestColor(self,color:'Any') -> 'Any': - """ + def GetNearestColor(self, color: 'Any') -> 'Any': + """ Returns the closest color a device can map. Args: @@ -37502,13 +35711,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetPixel(self,x:'Any',y:'Any') -> 'None': - """ + def GetPixel(self, x: 'Any', y: 'Any') -> 'None': + """ Gets a pixel at a local in a device context Args: @@ -37519,13 +35727,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetSafeHdc(self,) -> 'Any': - """ + def GetSafeHdc(self,) -> 'Any': + """ Returns the HDC of this DC object. Args: @@ -37535,14 +35742,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetTextExtent(self,text:'str') -> 'Tuple[Any, Any]': - """ - Calculates the width and height of a line of text using the current font to + def GetTextExtent(self, text: 'str') -> 'Tuple[Any, Any]': + """ + Calculates the width and height of a line of text using the current font to determine the dimensions. @@ -37555,13 +35761,12 @@ Returns: Tuple[Any, Any]:CFC::GetTextExtent Return ValueA tuple of integers with the size of the string, in logical units. - - """ - pass + """ + pass - def GetTextExtentPoint(self,text:'str') -> 'Tuple[Any, Any]': - """ + def GetTextExtentPoint(self, text: 'str') -> 'Tuple[Any, Any]': + """ None Args: @@ -37572,13 +35777,12 @@ Returns: Tuple[Any, Any]:The text to calculate for.Return ValueA tuple of integers with the size of the string, in logical units. - - """ - pass + """ + pass - def GetTextFace(self,) -> 'str': - """ + def GetTextFace(self,) -> 'str': + """ Returns typeface name of the current font. Args: @@ -37588,13 +35792,12 @@ Args: Returns: str - - """ - pass + """ + pass - def GetTextMetrics(self,) -> 'Any': - """ + def GetTextMetrics(self,) -> 'Any': + """ Retrieves the metrics for the current font in this device context. Args: @@ -37604,55 +35807,54 @@ Args: Returns: 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 + """ + pass - def GetViewportExt(self,) -> 'Tuple[Any, Any]': - """ + def GetViewportExt(self,) -> 'Tuple[Any, Any]': + """ Gets the viewport extent of the device context Args: @@ -37662,13 +35864,12 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def GetViewportOrg(self,) -> 'Tuple[Any, Any]': - """ + def GetViewportOrg(self,) -> 'Tuple[Any, Any]': + """ Gets the viewport origin of the device context Args: @@ -37678,13 +35879,12 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def GetWindowExt(self,) -> 'Tuple[Any, Any]': - """ + def GetWindowExt(self,) -> 'Tuple[Any, Any]': + """ Gets the window extent of the device context Args: @@ -37694,14 +35894,13 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def GetWindowOrg(self,) -> 'Tuple[Any, Any]': - """ - Retrieves the x- and y-coordinates of the origin of the window associated with the + def GetWindowOrg(self,) -> 'Tuple[Any, Any]': + """ + Retrieves the x- and y-coordinates of the origin of the window associated with the device context. @@ -37712,14 +35911,13 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def IntersectClipRect(self,rect:'Tuple[Any, Any, Any, Any]') -> 'None': - """ - Creates a new clipping region by forming the intersection of the current region + def IntersectClipRect(self, rect: 'Tuple[Any, Any, Any, Any]') -> 'None': + """ + Creates a new clipping region by forming the intersection of the current region and the rectangle specified @@ -37732,13 +35930,12 @@ Returns: None:CDC::IntersectClipRect Return Valueregion type as integer - - """ - pass + """ + pass - def IsPrinting(self,) -> 'Any': - """ + def IsPrinting(self,) -> 'Any': + """ Returns 1 if the DC is currently printing, else 0 Args: @@ -37748,13 +35945,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def LineTo(self,point:'Tuple[Any, Any]',x:'Any',y:'Any') -> 'None': - """ + def LineTo(self, point: 'Tuple[Any, Any]', x: 'Any', y: 'Any') -> 'None': + """ Draws a line to a specified point, using the currently selected pen. Args: @@ -37766,13 +35962,12 @@ Args: Returns: None - - """ - pass + """ + pass - def LPtoDP(self,point:'Tuple[Any, Any]',x:'Any',y:'Any') -> 'Tuple[Any, Any]': - """ + def LPtoDP(self, point: 'Tuple[Any, Any]', x: 'Any', y: 'Any') -> 'Tuple[Any, Any]': + """ Converts logical units into device units. Args: @@ -37786,13 +35981,12 @@ Returns: Tuple[Any, Any]:CDC::LPtoDP Return ValueThe converted coordinates. - - """ - pass + """ + pass - def MoveTo(self,point:'Tuple[Any, Any]',x:'Any',y:'Any') -> 'Tuple[Any, Any]': - """ + def MoveTo(self, point: 'Tuple[Any, Any]', x: 'Any', y: 'Any') -> 'Tuple[Any, Any]': + """ Moves the current position to a specified point. Args: @@ -37806,14 +36000,13 @@ Returns: Tuple[Any, Any]:CDC::MoveTo Return ValueThe previous position. - - """ - pass + """ + pass - def OffsetWindowOrg(self,arg:'Tuple[Any, Any]') -> 'Tuple[Any, Any]': - """ - Modifies the coordinates of the window origin relative to the coordinates of the + def OffsetWindowOrg(self, arg: 'Tuple[Any, Any]') -> 'Tuple[Any, Any]': + """ + Modifies the coordinates of the window origin relative to the coordinates of the current window origin. @@ -37825,14 +36018,13 @@ Returns: Tuple[Any, Any]:The new origin offset.Return ValueThe previous origin as a tuple (x,y) - - """ - pass + """ + pass - def OffsetViewportOrg(self,arg:'Tuple[Any, Any]') -> 'Tuple[Any, Any]': - """ - Modifies the coordinates of the viewport origin relative to the coordinates of + def OffsetViewportOrg(self, arg: 'Tuple[Any, Any]') -> 'Tuple[Any, Any]': + """ + Modifies the coordinates of the viewport origin relative to the coordinates of the current viewport origin @@ -37844,13 +36036,12 @@ Returns: Tuple[Any, Any]:The new origin offset.Return ValueThe previous viewport origin as a tuple (x,y) - - """ - pass + """ + pass - def PatBlt(self,destPos:'Tuple[Any, Any]',size:'Tuple[Any, Any]',rop:'Any') -> 'None': - """ + def PatBlt(self, destPos: 'Tuple[Any, Any]', size: 'Tuple[Any, Any]', rop: 'Any') -> 'None': + """ Creates a bit pattern on the device. Args: @@ -37862,13 +36053,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Pie(self,x1:'Any',y1:'Any',x2:'Any',y2:'Any',x3:'Any',y3:'Any',x4:'Any',y4:'Any') -> 'None': - """ + def Pie(self, x1: 'Any', y1: 'Any', x2: 'Any', y2: 'Any', x3: 'Any', y3: 'Any', x4: 'Any', y4: 'Any') -> 'None': + """ Draws a pie slice in a device context Args: @@ -37885,13 +36075,12 @@ Args: Returns: None - - """ - pass + """ + pass - def PolyBezier(self,) -> 'None': - """ + def PolyBezier(self,) -> 'None': + """ Draws one or more Bezier splines. Args: @@ -37901,13 +36090,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Polygon(self,) -> 'None': - """ + def Polygon(self,) -> 'None': + """ Draws an Polygon. Args: @@ -37917,13 +36105,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Polyline(self,points:'List[Any]') -> 'None': - """ + def Polyline(self, points: 'List[Any]') -> 'None': + """ Draws a Polyline. Args: @@ -37933,13 +36120,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RealizePalette(self,) -> 'Any': - """ + def RealizePalette(self,) -> 'Any': + """ Maps palette entries in the current logical palette to the system palette. Args: @@ -37951,22 +36137,21 @@ Returns: 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 + """ + pass - def Rectangle(self,) -> 'Any': - """ - Draws a rectangle using the current pen. The interior of the rectangle is filled using + def Rectangle(self,) -> 'Any': + """ + Draws a rectangle using the current pen. The interior of the rectangle is filled using the current brush. @@ -37977,14 +36162,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def RectVisible(self,rect:'Tuple[Any, Any, Any, Any]') -> 'Any': - """ - Determines whether any part of the given rectangle lies within the clipping region of + def RectVisible(self, rect: 'Tuple[Any, Any, Any, Any]') -> 'Any': + """ + Determines whether any part of the given rectangle lies within the clipping region of the display context. @@ -37997,13 +36181,12 @@ Returns: Any:CDC::RectVisible Return ValueNon zero if any part of the rectangle lies within the clipping region, else zero. - - """ - pass + """ + pass - def RestoreDC(self,saved:'Any') -> 'None': - """ + def RestoreDC(self, saved: 'Any') -> 'None': + """ Restores the state of the device context. Args: @@ -38013,13 +36196,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SaveDC(self,) -> 'Any': - """ + def SaveDC(self,) -> 'Any': + """ None Args: @@ -38029,17 +36211,16 @@ Args: Returns: 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 + """ + pass - def ScaleWindowExt(self,) -> 'Tuple[Any, Any]': - """ + def ScaleWindowExt(self,) -> 'Tuple[Any, Any]': + """ Modifies the window extents relative to the current values. Args: @@ -38049,13 +36230,12 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def ScaleViewportExt(self,) -> 'Tuple[Any, Any]': - """ + def ScaleViewportExt(self,) -> 'Tuple[Any, Any]': + """ Modifies the viewport extents relative to the current values. Args: @@ -38065,13 +36245,12 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def SelectClipRgn(self,) -> 'Any': - """ + def SelectClipRgn(self,) -> 'Any': + """ Selects the given region as the current clipping region for the device context Args: @@ -38085,13 +36264,12 @@ 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 + """ + pass - def SelectObject(self,ob:'Any') -> 'Any': - """ + def SelectObject(self, ob: 'Any') -> 'Any': + """ None Args: @@ -38103,13 +36281,12 @@ Returns: Any:CDC::SelectObject Return ValueThe previously selected object. This will be the same type as the object parameter. - - """ - pass + """ + pass - def SetBkColor(self,color:'Any') -> 'Any': - """ + def SetBkColor(self, color: 'Any') -> 'Any': + """ Sets the current background color to the specified color. Args: @@ -38121,13 +36298,12 @@ Returns: Any:CDC::SetBkColor Return ValueThe return value is the previous background color. - - """ - pass + """ + pass - def SetBkMode(self,mode:'Any') -> 'Any': - """ + def SetBkMode(self, mode: 'Any') -> 'Any': + """ Sets the current background mode to the specified mode. Args: @@ -38139,14 +36315,13 @@ Returns: Any:CDC::SetBkMode Return ValueThe return value is the previous background mode. - - """ - pass + """ + pass - def SetBrushOrg(self,point:'Tuple[Any, Any]') -> 'Tuple[Any, Any]': - """ - Specifies the origin that GDI will assign to the next brush that the + def SetBrushOrg(self, point: 'Tuple[Any, Any]') -> 'Tuple[Any, Any]': + """ + Specifies the origin that GDI will assign to the next brush that the application selects into the device context. @@ -38159,13 +36334,12 @@ Returns: Tuple[Any, Any]:CDC::SetBrushOrg Return ValueThe previous origin in device units. - - """ - pass + """ + pass - def SetGraphicsMode(self,mode:'Any') -> 'Any': - """ + def SetGraphicsMode(self, mode: 'Any') -> 'Any': + """ Sets the graphics mode for the specified device context Args: @@ -38175,13 +36349,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetMapMode(self,newMode:'Any') -> 'Any': - """ + def SetMapMode(self, newMode: 'Any') -> 'Any': + """ Sets the mapping mode for the device context. Args: @@ -38193,13 +36366,12 @@ Returns: Any:CDC::SetMapMode Return ValueThe previous mapping mode. - - """ - pass + """ + pass - def SetPixel(self,x:'Any',y:'Any',color:'Any') -> 'None': - """ + def SetPixel(self, x: 'Any', y: 'Any', color: 'Any') -> 'None': + """ Sets a pixel in a device context Args: @@ -38211,13 +36383,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetPolyFillMode(self,point:'Tuple[Any, Any]') -> 'Any': - """ + def SetPolyFillMode(self, point: 'Tuple[Any, Any]') -> 'Any': + """ Sets the polygon-filling mode. Args: @@ -38233,13 +36404,12 @@ Return ValueThe previous PolyFillMode as integer The previous PolyFillMode. - - """ - pass + """ + pass - def SetROP2(self,mode:'Any') -> 'Any': - """ + def SetROP2(self, mode: 'Any') -> 'Any': + """ Sets the current drawing mode. Args: @@ -38249,13 +36419,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetTextAlign(self,newFlags:'Any') -> 'Any': - """ + def SetTextAlign(self, newFlags: 'Any') -> 'Any': + """ Sets the text-alignment flags. Args: @@ -38267,13 +36436,12 @@ Returns: Any:CDC::SetTextAlign Return ValueThe old alignment flags. - - """ - pass + """ + pass - def SetTextColor(self,color:'Any') -> 'Any': - """ + def SetTextColor(self, color: 'Any') -> 'Any': + """ Sets the text color to the specified color. Args: @@ -38285,13 +36453,12 @@ Returns: Any:CDC::SetTextColor Return ValueThe return value is the previous text color. - - """ - pass + """ + pass - def SetWindowExt(self,size:'Tuple[Any, Any]') -> 'Tuple[Any, Any]': - """ + def SetWindowExt(self, size: 'Tuple[Any, Any]') -> 'Tuple[Any, Any]': + """ Sets the x,y extents of the window associated with the device context. Args: @@ -38303,13 +36470,12 @@ Returns: Tuple[Any, Any]:CDC::SetWindowExt Return ValueThe previous extents of the window (in logical units). - - """ - pass + """ + pass - def SetWindowOrg(self,arg:'Tuple[Any, Any]') -> 'Tuple[Any, Any]': - """ + def SetWindowOrg(self, arg: 'Tuple[Any, Any]') -> 'Tuple[Any, Any]': + """ Sets the window origin of the device context Args: @@ -38319,13 +36485,12 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def SetViewportExt(self,size:'Tuple[Any, Any]') -> 'Tuple[Any, Any]': - """ + def SetViewportExt(self, size: 'Tuple[Any, Any]') -> 'Tuple[Any, Any]': + """ Sets the x,y extents of the viewport of the device context. Args: @@ -38337,13 +36502,12 @@ Returns: Tuple[Any, Any]:CDC::SetViewportExt Return ValueThe previous extents of the viewport (in logical units). - - """ - pass + """ + pass - def SetViewportOrg(self,arg:'Tuple[Any, Any]') -> 'Tuple[Any, Any]': - """ + def SetViewportOrg(self, arg: 'Tuple[Any, Any]') -> 'Tuple[Any, Any]': + """ Sets the viewport origin of the device context Args: @@ -38353,16 +36517,15 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def SetWorldTransform(self,) -> 'Any': - """ - sets a two-dimensional linear transformation between world space and page space + def SetWorldTransform(self,) -> 'Any': + """ + 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,13 +36536,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def StartDoc(self,docName:'str',outputFile:'str') -> 'None': - """ + def StartDoc(self, docName: 'str', outputFile: 'str') -> 'None': + """ Starts spooling a document to a printer DC Args: @@ -38390,13 +36552,12 @@ Args: Returns: None - - """ - pass + """ + pass - def StartPage(self,) -> 'None': - """ + def StartPage(self,) -> 'None': + """ Starts a new page on a printer DC Args: @@ -38406,13 +36567,19 @@ Args: Returns: None - - """ - pass + """ + pass - def StretchBlt(self,destPos:'Tuple[Any, Any]',size:'Tuple[Any, Any]',dc:'Any',srcPos:'Tuple[Any, Any]',size1:'Tuple[Any, Any]',rop:'Any') -> 'None': - """ + def StretchBlt( + self, + destPos: 'Tuple[Any, Any]', + size: 'Tuple[Any, Any]', + dc: 'Any', + srcPos: 'Tuple[Any, Any]', + size1: 'Tuple[Any, Any]', + rop: 'Any') -> 'None': + """ Copies a bitmap from the source device context to this device context. Args: @@ -38427,14 +36594,13 @@ Args: Returns: None - - """ - pass + """ + pass - def StrokeAndFillPath(self,) -> 'None': - """ - Closes any open figures in a path, strokes the outline of the path by using the + def StrokeAndFillPath(self,) -> 'None': + """ + 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,13 +36611,12 @@ Args: Returns: None - - """ - pass + """ + pass - def StrokePath(self,) -> 'None': - """ + def StrokePath(self,) -> 'None': + """ Renders the specified path by using the current pen. Args: @@ -38461,13 +36626,12 @@ Args: Returns: None - - """ - pass + """ + pass - def TextOut(self,_int:'Any',_int1:'Any',string:'Any') -> 'None': - """ + def TextOut(self, _int: 'Any', _int1: 'Any', string: 'Any') -> 'None': + """ Outputs text to the display context, using the currently selected font. Args: @@ -38481,20 +36645,19 @@ Returns: None:CDC::TextOut Return ValueAlways none. If the function fails, an exception is raised. - - """ - pass + """ + pass -class PyCDialog(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCDialog(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def CreateWindow(self,obParent:'Any'=None) -> 'None': - """ + def CreateWindow(self, obParent: 'Any' = None) -> 'None': + """ Create a modeless window for the dialog box. Args: @@ -38504,13 +36667,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DoModal(self,) -> 'Any': - """ + def DoModal(self,) -> 'Any': + """ Create a modal window for the dialog box. Args: @@ -38522,13 +36684,12 @@ Returns: Any:CDialog::DoModal Return ValueThe return value from the dialog. This is the value passed to PyCDialog::EndDialog. - - """ - pass + """ + pass - def EndDialog(self,result:'Any') -> 'None': - """ + def EndDialog(self, result: 'Any') -> 'None': + """ Ends a modal dialog box. Args: @@ -38538,13 +36699,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GotoDlgCtrl(self,control:'Any') -> 'None': - """ + def GotoDlgCtrl(self, control: 'Any') -> 'None': + """ Moves the focus to the specified control in the dialog box. Args: @@ -38554,14 +36714,13 @@ Args: Returns: None - - """ - pass + """ + pass - def MapDialogRect(self,rect:'Tuple[Any, Any, Any, Any]') -> 'Tuple[Any, Any, Any, Any]': - """ - Converts the dialog-box units of a rectangle to screen + def MapDialogRect(self, rect: 'Tuple[Any, Any, Any, Any]') -> 'Tuple[Any, Any, Any, Any]': + """ + Converts the dialog-box units of a rectangle to screen units. @@ -38572,13 +36731,12 @@ Args: Returns: Tuple[Any, Any, Any, Any] - - """ - pass + """ + pass - def OnCancel(self,) -> 'None': - """ + def OnCancel(self,) -> 'None': + """ Calls the default MFC OnCancel handler. Args: @@ -38588,13 +36746,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnOK(self,) -> 'None': - """ + def OnOK(self,) -> 'None': + """ Calls the default MFC OnOK handler. Args: @@ -38604,13 +36761,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnInitDialog(self,) -> 'Any': - """ + def OnInitDialog(self,) -> 'Any': + """ Calls the default MFC OnInitDialog handler. Args: @@ -38620,20 +36776,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyCDialogBar(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCDialogBar(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def CreateWindow(self,parent:'Any',template:'PyResourceId',style:'Any',_id:'Any') -> 'None': - """ + def CreateWindow(self, parent: 'Any', template: 'PyResourceId', style: 'Any', _id: 'Any') -> 'None': + """ None Args: @@ -38646,20 +36801,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyCDocTemplate(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCDocTemplate(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def DoCreateDoc(self,fileName:'str'=None) -> 'Any': - """ + def DoCreateDoc(self, fileName: 'str' = None) -> 'Any': + """ Creates an underlying document object. Args: @@ -38669,13 +36823,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def FindOpenDocument(self,fileName:'str') -> 'Any': - """ + def FindOpenDocument(self, fileName: 'str') -> 'Any': + """ Returns an existing document with the specified file name. Args: @@ -38685,13 +36838,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetDocString(self,docIndex:'Any') -> 'str': - """ + def GetDocString(self, docIndex: 'Any') -> 'str': + """ Retrieves a specific substring describing the document type. Args: @@ -38701,13 +36853,12 @@ Args: Returns: str - - """ - pass + """ + pass - def GetDocumentList(self,) -> 'Any': - """ + def GetDocumentList(self,) -> 'Any': + """ Return a list of all open documents. Args: @@ -38717,13 +36868,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetResourceID(self,) -> 'None': - """ + def GetResourceID(self,) -> 'None': + """ Returns the resource ID in use. Args: @@ -38733,13 +36883,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetSharedMenu(self,) -> 'Any': - """ + def GetSharedMenu(self,) -> 'Any': + """ Returns the shared menu object for all frames using this template. Args: @@ -38749,13 +36898,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def InitialUpdateFrame(self,frame:'Any'=None,doc:'Any'=None,bMakeVisible:'Any'=1) -> 'None': - """ + def InitialUpdateFrame(self, frame: 'Any' = None, doc: 'Any' = None, bMakeVisible: 'Any' = 1) -> 'None': + """ Calls the default OnInitialFrame handler. Args: @@ -38767,13 +36915,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetContainerInfo(self,_id:'Any') -> 'None': - """ + def SetContainerInfo(self, _id: 'Any') -> 'None': + """ Sets the resources to be used when an OLE 2 object is in-place activated. Args: @@ -38783,13 +36930,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetDocStrings(self,docStrings:'str') -> 'None': - """ + def SetDocStrings(self, docStrings: 'str') -> 'None': + """ Assigns the document strings for the template. Args: @@ -38799,13 +36945,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OpenDocumentFile(self,filename:'str',bMakeVisible:'Any'=1) -> 'None': - """ + def OpenDocumentFile(self, filename: 'str', bMakeVisible: 'Any' = 1) -> 'None': + """ Opens a document file, creating a view and frame. Args: @@ -38816,134 +36961,114 @@ Args: Returns: None - - """ - pass - - -class PyCDockContext(object): - """A class which encapsulates an MFC CDockContext object""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ptLast(self)->'Tuple[Any, Any]': - """""" - pass - - - @property - def rectLast(self)->'Tuple[Any, Any, Any, Any]': - """""" - pass - - - @property - def sizeLast(self)->'Tuple[Any, Any]': - """""" - pass - - - @property - def bDitherLast(self)->'Any': - """""" - pass - - - @property - def rectDragHorz(self)->'Tuple[Any, Any, Any, Any]': - """""" - pass - - - @property - def rectDragVert(self)->'Tuple[Any, Any, Any, Any]': - """""" - pass - - - @property - def rectFrameDragHorz(self)->'Tuple[Any, Any, Any, Any]': - """""" - pass - - - @property - def rectFrameDragVert(self)->'Tuple[Any, Any, Any, Any]': - """""" - pass - - - @property - def dwDockStyle(self)->'Any': - """allowable dock styles for bar""" - pass - - - @property - def dwOverDockStyle(self)->'Any': - """style of dock that rect is over""" - pass - - - @property - def dwStyle(self)->'Any': - """style of control bar""" - pass - - - @property - def bFlip(self)->'Any': - """if shift key is down""" - pass - - - @property - def bForceFrame(self)->'Any': - """if ctrl key is down CDC* m_pDC; // where to draw during drag""" - pass + """ + pass - @property - def bDragging(self)->'Any': - """""" - pass - - @property - def nHitTest(self)->'Any': - """""" - pass - - - @property - def uMRUDockID(self)->'Any': - """""" - pass - - - @property - def rectMRUDockPos(self)->'Tuple[Any, Any, Any, Any]': - """""" - pass - - - @property - def dwMRUFloatStyle(self)->'Any': - """""" - pass - - - @property - def ptMRUFloatPos(self)->'Tuple[Any, Any]': - """Sentinel""" - pass - - - def EndDrag(self,) -> 'Any': - """ +class PyCDockContext(object): + """A class which encapsulates an MFC CDockContext object""" + + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def ptLast(self) -> 'Tuple[Any, Any]': + """""" + pass + + @property + def rectLast(self) -> 'Tuple[Any, Any, Any, Any]': + """""" + pass + + @property + def sizeLast(self) -> 'Tuple[Any, Any]': + """""" + pass + + @property + def bDitherLast(self) -> 'Any': + """""" + pass + + @property + def rectDragHorz(self) -> 'Tuple[Any, Any, Any, Any]': + """""" + pass + + @property + def rectDragVert(self) -> 'Tuple[Any, Any, Any, Any]': + """""" + pass + + @property + def rectFrameDragHorz(self) -> 'Tuple[Any, Any, Any, Any]': + """""" + pass + + @property + def rectFrameDragVert(self) -> 'Tuple[Any, Any, Any, Any]': + """""" + pass + + @property + def dwDockStyle(self) -> 'Any': + """allowable dock styles for bar""" + pass + + @property + def dwOverDockStyle(self) -> 'Any': + """style of dock that rect is over""" + pass + + @property + def dwStyle(self) -> 'Any': + """style of control bar""" + pass + + @property + def bFlip(self) -> 'Any': + """if shift key is down""" + pass + + @property + def bForceFrame(self) -> 'Any': + """if ctrl key is down CDC* m_pDC; // where to draw during drag""" + pass + + @property + def bDragging(self) -> 'Any': + """""" + pass + + @property + def nHitTest(self) -> 'Any': + """""" + pass + + @property + def uMRUDockID(self) -> 'Any': + """""" + pass + + @property + def rectMRUDockPos(self) -> 'Tuple[Any, Any, Any, Any]': + """""" + pass + + @property + def dwMRUFloatStyle(self) -> 'Any': + """""" + pass + + @property + def ptMRUFloatPos(self) -> 'Tuple[Any, Any]': + """Sentinel""" + pass + + def EndDrag(self,) -> 'Any': + """ None Args: @@ -38953,13 +37078,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def StartDrag(self,pt:'Tuple[Any, Any]') -> 'Any': - """ + def StartDrag(self, pt: 'Tuple[Any, Any]') -> 'Any': + """ None Args: @@ -38969,13 +37093,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def EndResize(self,) -> 'Any': - """ + def EndResize(self,) -> 'Any': + """ None Args: @@ -38985,13 +37108,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def StartResize(self,hittest:'Any',pt:'Tuple[Any, Any]') -> 'Any': - """ + def StartResize(self, hittest: 'Any', pt: 'Tuple[Any, Any]') -> 'Any': + """ None Args: @@ -39002,13 +37124,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def ToggleDocking(self,) -> 'Any': - """ + def ToggleDocking(self,) -> 'Any': + """ None Args: @@ -39018,23 +37139,22 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyCDocument(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCDocument(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def DeleteContents(self,) -> 'None': - """ - Call the MFC DeleteContents method. + def DeleteContents(self,) -> 'None': + """ + 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,13 +37165,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DoSave(self,fileName:'str',bReplace:'Any'=1) -> 'None': - """ + def DoSave(self, fileName: 'str', bReplace: 'Any' = 1) -> 'None': + """ Calls the underlying MFC DoSave method. Args: @@ -39062,16 +37181,15 @@ Args: Returns: None - - """ - pass + """ + pass - def DoFileSave(self,) -> 'None': - """ - Checks the file attributes. + def DoFileSave(self,) -> 'None': + """ + 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,13 +37200,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetDocTemplate(self,) -> 'Any': - """ + def GetDocTemplate(self,) -> 'Any': + """ Returns the template for the document. Args: @@ -39098,13 +37215,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetAllViews(self,) -> 'List[Any]': - """ + def GetAllViews(self,) -> 'List[Any]': + """ Returns a list of all views for the current document. Args: @@ -39114,13 +37230,12 @@ Args: Returns: List[Any] - - """ - pass + """ + pass - def GetFirstView(self,) -> 'Any': - """ + def GetFirstView(self,) -> 'Any': + """ Returns the first view object attached to this document. Args: @@ -39130,14 +37245,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetPathName(self,) -> 'str': - """ - Returns the full path name of the current document. + def GetPathName(self,) -> 'str': + """ + Returns the full path name of the current document. The string will be empty if no path name has been set. @@ -39148,14 +37262,13 @@ Args: Returns: str - - """ - pass + """ + pass - def GetTitle(self,) -> 'str': - """ - Returns the title of the current document. + def GetTitle(self,) -> 'str': + """ + Returns the title of the current document. This will often be the file name portion of the path name. @@ -39166,13 +37279,12 @@ Args: Returns: str - - """ - pass + """ + pass - def IsModified(self,) -> 'Any': - """ + def IsModified(self,) -> 'Any': + """ Return a flag indicating if the document has been modified. Args: @@ -39182,13 +37294,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OnChangedViewList(self,) -> 'None': - """ + def OnChangedViewList(self,) -> 'None': + """ Informs the document when a view is added or removed. Args: @@ -39198,16 +37309,15 @@ Args: Returns: None - - """ - pass + """ + pass - def OnCloseDocument(self,) -> 'None': - """ - Call the MFC OnCloseDocument handler. + def OnCloseDocument(self,) -> 'None': + """ + 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 +37328,15 @@ Args: Returns: None - - """ - pass + """ + pass - def OnNewDocument(self,) -> 'None': - """ - Call the MFC OnNewDocument handler. + def OnNewDocument(self,) -> 'None': + """ + 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 +37347,15 @@ Args: Returns: None - - """ - pass + """ + pass - def OnOpenDocument(self,pathName:'str') -> 'None': - """ - Call the MFC OnOpenDocument handler. + def OnOpenDocument(self, pathName: 'str') -> 'None': + """ + 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 +37366,15 @@ Args: Returns: None - - """ - pass + """ + pass - def OnSaveDocument(self,pathName:'str') -> 'None': - """ - Call the MFC OnSaveDocument handler. + def OnSaveDocument(self, pathName: 'str') -> 'None': + """ + 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,13 +37385,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetModifiedFlag(self,bModified:'Any'=1) -> 'None': - """ + def SetModifiedFlag(self, bModified: 'Any' = 1) -> 'None': + """ Set the "dirty" flag for the document. Args: @@ -39294,13 +37400,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SaveModified(self,) -> 'Any': - """ + def SaveModified(self,) -> 'Any': + """ Call the underlying MFC method. Args: @@ -39312,13 +37417,12 @@ Returns: Any:CDocument::SaveModified Return ValueNonzero if it is safe to continue and close the document; 0 if the document should not be closed. - - """ - pass + """ + pass - def SetPathName(self,path:'str') -> 'None': - """ + def SetPathName(self, path: 'str') -> 'None': + """ Set the full path name for the document. Args: @@ -39328,14 +37432,13 @@ Args: Returns: None - - """ - pass + """ + pass - def SetTitle(self,title:'str') -> 'None': - """ - Set the title of the document (ie, the name + def SetTitle(self, title: 'str') -> 'None': + """ + Set the title of the document (ie, the name to appear in the window caption for the document. @@ -39346,13 +37449,12 @@ Args: Returns: None - - """ - pass + """ + pass - def UpdateAllViews(self,sender:'Any',hint:'Any'=None) -> 'None': - """ + def UpdateAllViews(self, sender: 'Any', hint: 'Any' = None) -> 'None': + """ Informs each view when a document changes. Args: @@ -39363,20 +37465,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyCEdit(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCEdit(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def CreateWindow(self,style:'Any',rect:'Tuple[Any, Any, Any, Any]',parent:'Any',_id:'Any') -> 'None': - """ + def CreateWindow(self, style: 'Any', rect: 'Tuple[Any, Any, Any, Any]', parent: 'Any', _id: 'Any') -> 'None': + """ Creates the window for a new Edit object. Args: @@ -39389,13 +37490,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Clear(self,) -> 'Any': - """ + def Clear(self,) -> 'Any': + """ Clears all text in an edit control. Args: @@ -39405,13 +37505,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Copy(self,) -> 'None': - """ + def Copy(self,) -> 'None': + """ Copys the current selection to the clipboard. Args: @@ -39421,13 +37520,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Cut(self,) -> 'None': - """ + def Cut(self,) -> 'None': + """ Cuts the current selection to the clipboard. Args: @@ -39437,13 +37535,12 @@ Args: Returns: None - - """ - pass + """ + pass - def FmtLines(self,bAddEOL:'Any') -> 'Any': - """ + def FmtLines(self, bAddEOL: 'Any') -> 'Any': + """ Sets the formatting options for the control. Args: @@ -39455,13 +37552,12 @@ Returns: Any:CEdit::FmtLines Return ValueNonzero if any formatting occurs; otherwise 0. - - """ - pass + """ + pass - def GetFirstVisibleLine(self,) -> 'Any': - """ + def GetFirstVisibleLine(self,) -> 'Any': + """ Returns zero-based index of the topmost visible line. Args: @@ -39473,13 +37569,12 @@ Returns: Any:CEdit::GetFirstVisibleLine Return ValueThe zero-based index of the topmost visible line. For single-line edit controls, the return value is 0. - - """ - pass + """ + pass - def GetSel(self,) -> 'Tuple[Any, Any]': - """ + def GetSel(self,) -> 'Tuple[Any, Any]': + """ Returns the start and end of the current selection. Args: @@ -39489,17 +37584,16 @@ Args: Returns: Tuple[Any, 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 + """ + pass - def GetLine(self,lineNo:'Any') -> 'Any': - """ + def GetLine(self, lineNo: 'Any') -> 'Any': + """ Returns the text in a specified line. Args: @@ -39509,13 +37603,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetLineCount(self,) -> 'Any': - """ + def GetLineCount(self,) -> 'Any': + """ Gets the number of lines in an edit control. Args: @@ -39527,13 +37620,12 @@ Returns: Any:CEdit::GetLineCount Return ValueThe number of lines in the buffer. If the control is empty, the return value is 1. - - """ - pass + """ + pass - def LimitText(self,nChars:'Any'=0) -> 'None': - """ + def LimitText(self, nChars: 'Any' = 0) -> 'None': + """ Sets max length of text that user can enter Args: @@ -39543,13 +37635,12 @@ Args: Returns: None - - """ - pass + """ + pass - def LineFromChar(self,charNo:'Any'=-1) -> 'Any': - """ + def LineFromChar(self, charNo: 'Any' = -1) -> 'Any': + """ Returns the line number of the specified character. Args: @@ -39559,19 +37650,18 @@ Args: Returns: 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 + """ + pass - def LineIndex(self,lineNo:'Any'=-1) -> 'Any': - """ + def LineIndex(self, lineNo: 'Any' = -1) -> 'Any': + """ Retrieves the character index of a line within a multiple-line edit control. Args: @@ -39581,19 +37671,18 @@ Args: Returns: 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 + """ + pass - def LineScroll(self,nLines:'Any',nChars:'Any'=0) -> 'Any': - """ + def LineScroll(self, nLines: 'Any', nChars: 'Any' = 0) -> 'Any': + """ Scroll the control vertically and horizontally Args: @@ -39604,13 +37693,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Paste(self,) -> 'None': - """ + def Paste(self,) -> 'None': + """ Pastes the contents of the clipboard into the control. Args: @@ -39620,13 +37708,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ReplaceSel(self,text:'str') -> 'None': - """ + def ReplaceSel(self, text: 'str') -> 'None': + """ Replaces the selection with the specified text. Args: @@ -39636,13 +37723,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetReadOnly(self,bReadOnly:'Any'=1) -> 'None': - """ + def SetReadOnly(self, bReadOnly: 'Any' = 1) -> 'None': + """ Sets or clears the read-only status of the listbox. Args: @@ -39652,13 +37738,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetSel(self,start:'Any',end:'Any',arg:'Any',bNoScroll1:'Any',bNoScroll:'Any'=0) -> 'None': - """ + def SetSel(self, start: 'Any', end: 'Any', arg: 'Any', bNoScroll1: 'Any', bNoScroll: 'Any' = 0) -> 'None': + """ Sets the selection in the edit control. Args: @@ -39672,20 +37757,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyCEditView(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCEditView(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def IsModified(self,) -> 'Any': - """ + def IsModified(self,) -> 'Any': + """ Indicates if the view's document has the modified flag set. Args: @@ -39695,13 +37779,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def LoadFile(self,fileName:'str') -> 'None': - """ + def LoadFile(self, fileName: 'str') -> 'None': + """ Loads a file into the view. Args: @@ -39711,13 +37794,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetModifiedFlag(self,bModified:'Any'=1) -> 'None': - """ + def SetModifiedFlag(self, bModified: 'Any' = 1) -> 'None': + """ Sets the modified flag for the view's document. Args: @@ -39727,13 +37809,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetEditCtrl(self,) -> 'Any': - """ + def GetEditCtrl(self,) -> 'Any': + """ returns the underlying edit control object. Args: @@ -39743,13 +37824,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def PreCreateWindow(self,createStruct:'Any') -> 'Any': - """ + def PreCreateWindow(self, createStruct: 'Any') -> 'Any': + """ Calls the underlying MFC PreCreateWindow method. Args: @@ -39759,13 +37839,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SaveFile(self,fileName:'str') -> 'None': - """ + def SaveFile(self, fileName: 'str') -> 'None': + """ Saves the view to a file. Args: @@ -39775,13 +37854,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnCommand(self,wparam:'Any',lparam:'Any') -> 'None': - """ + def OnCommand(self, wparam: 'Any', lparam: 'Any') -> 'None': + """ Calls the standard Python framework OnCommand handler Args: @@ -39792,20 +37870,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyCFileDialog(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCFileDialog(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetPathName(self,) -> 'str': - """ + def GetPathName(self,) -> 'str': + """ Retrives the path name from the file dialog. Args: @@ -39815,13 +37892,12 @@ Args: Returns: str - - """ - pass + """ + pass - def GetFileName(self,) -> 'str': - """ + def GetFileName(self,) -> 'str': + """ Retrives the file name from the file dialog. Args: @@ -39831,13 +37907,12 @@ Args: Returns: str - - """ - pass + """ + pass - def GetFileExt(self,) -> 'str': - """ + def GetFileExt(self,) -> 'str': + """ Retrives the file extension from the file dialog. Args: @@ -39847,13 +37922,12 @@ Args: Returns: str - - """ - pass + """ + pass - def GetFileTitle(self,) -> 'str': - """ + def GetFileTitle(self,) -> 'str': + """ Retrives the file title from the file dialog. Args: @@ -39863,13 +37937,12 @@ Args: Returns: str - - """ - pass + """ + pass - def GetPathNames(self,) -> 'str': - """ + def GetPathNames(self,) -> 'str': + """ Retrieves the list of path names from the file dialog. Args: @@ -39879,13 +37952,12 @@ Args: Returns: str - - """ - pass + """ + pass - def GetReadOnlyPref(self,) -> 'Any': - """ + def GetReadOnlyPref(self,) -> 'Any': + """ Retrives the value of the "Read Only" checkbox on the file dialog. Args: @@ -39895,13 +37967,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetOFNTitle(self,title:'str') -> 'None': - """ + def SetOFNTitle(self, title: 'str') -> 'None': + """ Sets the Title for the dialog. Args: @@ -39911,13 +37982,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetOFNInitialDir(self,title:'str') -> 'None': - """ + def SetOFNInitialDir(self, title: 'str') -> 'None': + """ Sets the initial directory for the dialog. Args: @@ -39927,20 +37997,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyCFont(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCFont(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetSafeHandle(self,) -> 'Any': - """ + def GetSafeHandle(self,) -> 'Any': + """ Retrieves the HFONT for the font as an integer Args: @@ -39950,20 +38019,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyCFontDialog(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCFontDialog(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def DoModal(self,) -> 'Any': - """ + def DoModal(self,) -> 'Any': + """ Displays a dialog and allows the user to make a selection. Args: @@ -39973,13 +38041,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetCurrentFont(self,) -> 'Any': - """ + def GetCurrentFont(self,) -> 'Any': + """ Returns a dictionary describing the current font. Args: @@ -39989,13 +38056,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetCharFormat(self,) -> 'Any': - """ + def GetCharFormat(self,) -> 'Any': + """ Returns the font selection in a CHARFORMAT tuple. Args: @@ -40005,13 +38071,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetColor(self,) -> 'Any': - """ + def GetColor(self,) -> 'Any': + """ Determines the color of the selected font. Args: @@ -40021,13 +38086,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetFaceName(self,) -> 'str': - """ + def GetFaceName(self,) -> 'str': + """ Returns the face name of the selected font. Args: @@ -40037,13 +38101,12 @@ Args: Returns: str - - """ - pass + """ + pass - def GetStyleName(self,) -> 'str': - """ + def GetStyleName(self,) -> 'str': + """ Returns the style name of the selected font. Args: @@ -40053,13 +38116,12 @@ Args: Returns: str - - """ - pass + """ + pass - def GetSize(self,) -> 'Any': - """ + def GetSize(self,) -> 'Any': + """ Returns he font's size, in tenths of a point. Args: @@ -40069,13 +38131,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetWeight(self,) -> 'Any': - """ + def GetWeight(self,) -> 'Any': + """ Returns the font's weight. Args: @@ -40085,13 +38146,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def IsStrikeOut(self,) -> 'Any': - """ + def IsStrikeOut(self,) -> 'Any': + """ Determines whether the font is displayed with strikeout. Args: @@ -40101,13 +38161,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def IsUnderline(self,) -> 'Any': - """ + def IsUnderline(self,) -> 'Any': + """ Determines whether the font is displayed with underline. Args: @@ -40117,13 +38176,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def IsBold(self,) -> 'Any': - """ + def IsBold(self,) -> 'Any': + """ Determines whether the font is displayed bold. Args: @@ -40133,13 +38191,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def IsItalic(self,) -> 'Any': - """ + def IsItalic(self,) -> 'Any': + """ Determines whether the font is displayed with italic. Args: @@ -40149,20 +38206,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyCFormView(object): - """A class which implementes a CFormView (ie, a view based on a dialog resource.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCFormView(object): + """A class which implementes a CFormView (ie, a view based on a dialog resource.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def OnCommand(self,wparam:'Any',lparam:'Any') -> 'None': - """ + def OnCommand(self, wparam: 'Any', lparam: 'Any') -> 'None': + """ Calls the standard Python framework OnCommand handler Args: @@ -40173,20 +38229,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyCFrameWnd(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCFrameWnd(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def BeginModalState(self,) -> 'None': - """ + def BeginModalState(self,) -> 'None': + """ Sets the frame window to modal. Args: @@ -40196,13 +38251,21 @@ Args: Returns: None - - """ - pass + """ + pass - def CreateWindow(self,wndClass:'str',title:'str',style:'Any',PyCWnd:'Any',menuId:'Any',styleEx:'Any',rect:'Tuple[Any, Any, Any, Any]'=None,createContext:'Any'=None) -> 'Any': - """ + def CreateWindow( + self, + wndClass: 'str', + title: 'str', + style: 'Any', + PyCWnd: 'Any', + menuId: 'Any', + styleEx: 'Any', + rect: 'Tuple[Any, Any, Any, Any]' = None, + createContext: 'Any' = None) -> 'Any': + """ Creates the actual window for the PyCFrameWnd object. Args: @@ -40219,13 +38282,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def EndModalState(self,) -> 'None': - """ + def EndModalState(self,) -> 'None': + """ None Args: @@ -40235,13 +38297,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DockControlBar(self,controlBar:'Any',arg:'Tuple[Any, Any, Any, Any]',dockBarId:'Any'=0) -> 'None': - """ + def DockControlBar(self, controlBar: 'Any', arg: 'Tuple[Any, Any, Any, Any]', dockBarId: 'Any' = 0) -> 'None': + """ Docks a control bar. Args: @@ -40253,13 +38314,12 @@ Args: Returns: None - - """ - pass + """ + pass - def EnableDocking(self,style:'Any') -> 'None': - """ + def EnableDocking(self, style: 'Any') -> 'None': + """ Enable dockable control bars in a frame window Args: @@ -40269,13 +38329,12 @@ Args: Returns: None - - """ - pass + """ + pass - def FloatControlBar(self,controlBar:'Any',arg:'Tuple[Any, Any]',style:'Any') -> 'None': - """ + def FloatControlBar(self, controlBar: 'Any', arg: 'Tuple[Any, Any]', style: 'Any') -> 'None': + """ Floats a control bar. Args: @@ -40287,13 +38346,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetActiveDocument(self,) -> 'Any': - """ + def GetActiveDocument(self,) -> 'Any': + """ Gets the currently active document, else None Args: @@ -40303,13 +38361,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetControlBar(self,_id:'Any') -> 'Any': - """ + def GetControlBar(self, _id: 'Any') -> 'Any': + """ Retrieves the specified control bar. Args: @@ -40319,13 +38376,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetMessageString(self,_id:'Any') -> 'str': - """ + def GetMessageString(self, _id: 'Any') -> 'str': + """ Retrieves message corresponding to a command ID. Args: @@ -40335,13 +38391,12 @@ Args: Returns: str - - """ - pass + """ + pass - def GetMessageBar(self,) -> 'Any': - """ + def GetMessageBar(self,) -> 'Any': + """ Retrieves the message bar for the frame. Args: @@ -40351,13 +38406,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def IsTracking(self,) -> 'Any': - """ + def IsTracking(self,) -> 'Any': + """ Determines if splitter bar is currently being moved. Args: @@ -40367,13 +38421,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def InModalState(self,) -> 'Any': - """ + def InModalState(self,) -> 'Any': + """ Returns a value indicating whether or not a frame window is in a modal state. Args: @@ -40383,13 +38436,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def LoadAccelTable(self,_id:'PyResourceId') -> 'None': - """ + def LoadAccelTable(self, _id: 'PyResourceId') -> 'None': + """ Loads an accelerator table. Args: @@ -40399,13 +38451,12 @@ Args: Returns: None - - """ - pass + """ + pass - def LoadFrame(self,idResource:'Any',style:'Any'=-1,wndParent:'Any'=None,context:'Any'=None) -> 'None': - """ + def LoadFrame(self, idResource: 'Any', style: 'Any' = -1, wndParent: 'Any' = None, context: 'Any' = None) -> 'None': + """ Loads a Windows frame window and associated resources Args: @@ -40418,13 +38469,12 @@ Args: Returns: None - - """ - pass + """ + pass - def LoadBarState(self,profileName:'str') -> 'None': - """ + def LoadBarState(self, profileName: 'str') -> 'None': + """ Loads a control bars settings Args: @@ -40434,13 +38484,12 @@ Args: Returns: None - - """ - pass + """ + pass - def PreCreateWindow(self,createStruct:'Any') -> 'Any': - """ + def PreCreateWindow(self, createStruct: 'Any') -> 'Any': + """ Calls the underlying MFC PreCreateWindow method. Args: @@ -40450,13 +38499,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SaveBarState(self,profileName:'str') -> 'None': - """ + def SaveBarState(self, profileName: 'str') -> 'None': + """ Saves a control bars settings Args: @@ -40466,13 +38514,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ShowControlBar(self,controlBar:'Any',bShow:'Any',bDelay:'Any') -> 'None': - """ + def ShowControlBar(self, controlBar: 'Any', bShow: 'Any', bDelay: 'Any') -> 'None': + """ Shows a control bar. Args: @@ -40484,14 +38531,13 @@ Args: Returns: None - - """ - pass + """ + pass - def RecalcLayout(self,bNotify:'Any'=1) -> 'None': - """ - Called by the framework when the standard control bars are toggled on or off or + def RecalcLayout(self, bNotify: 'Any' = 1) -> 'None': + """ + Called by the framework when the standard control bars are toggled on or off or when the frame window is resized. @@ -40502,13 +38548,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetActiveView(self,) -> 'Any': - """ + def GetActiveView(self,) -> 'Any': + """ Retrieves the active view. Args: @@ -40518,13 +38563,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OnBarCheck(self,_id:'Any') -> 'Any': - """ + def OnBarCheck(self, _id: 'Any') -> 'Any': + """ Changes the state of the specified controlbar. Args: @@ -40534,13 +38578,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OnUpdateControlBarMenu(self,cmdUI:'Any') -> 'Any': - """ + def OnUpdateControlBarMenu(self, cmdUI: 'Any') -> 'Any': + """ Checks the state of a menu item Args: @@ -40550,13 +38593,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetActiveView(self,view:'Any',bNotify:'Any'=1) -> 'None': - """ + def SetActiveView(self, view: 'Any', bNotify: 'Any' = 1) -> 'None': + """ Sets the active view for a frame. Args: @@ -40567,27 +38609,26 @@ Args: Returns: None - - """ - pass + + """ + pass class PyCGdiObject(object): - """A class which encapsulates an MFC CGdiObject.""" + """A class which encapsulates an MFC CGdiObject.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyCImageList(object): - """A Python type encapsulating an MFC CImageList class.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """A Python type encapsulating an MFC CImageList class.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Add(self,arg:'Tuple[Any, Any]',bitmap:'Any',color:'Any',hIcon:'Any') -> 'Any': - """ + def Add(self, arg: 'Tuple[Any, Any]', bitmap: 'Any', color: 'Any', hIcon: 'Any') -> 'Any': + """ Adds an image to the list. Args: @@ -40602,13 +38643,12 @@ Returns: Any:Handle of an icon to add. Return ValueZero-based index of the first new image. - - """ - pass + """ + pass - def Destroy(self,) -> 'None': - """ + def Destroy(self,) -> 'None': + """ Destroys the underlying CImageList Args: @@ -40618,13 +38658,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DeleteImageList(self,) -> 'None': - """ + def DeleteImageList(self,) -> 'None': + """ Deletes an image list. Args: @@ -40634,13 +38673,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetBkColor(self,) -> 'Any': - """ + def GetBkColor(self,) -> 'Any': + """ Retrieves the background color of an Image List. Args: @@ -40650,13 +38688,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetSafeHandle(self,) -> 'Any': - """ + def GetSafeHandle(self,) -> 'Any': + """ Retrieves the HIMAGELIST for the object Args: @@ -40666,13 +38703,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetImageCount(self,) -> 'Any': - """ + def GetImageCount(self,) -> 'Any': + """ Retrieves the number of images in an image list. Args: @@ -40682,13 +38718,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetImageInfo(self,index:'Any') -> 'Any': - """ + def GetImageInfo(self, index: 'Any') -> 'Any': + """ Retrieves information about an image. Args: @@ -40699,13 +38734,12 @@ Returns: Any:Index of image.Return ValueThe return info is a tuple describing an IMAGELIST structure. - - """ - pass + """ + pass - def SetBkColor(self,color:'Any') -> 'None': - """ + def SetBkColor(self, color: 'Any') -> 'None': + """ Sets the background color for an Image List. Args: @@ -40715,20 +38749,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyCListBox(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCListBox(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def AddString(self,_object:'Any') -> 'Any': - """ + def AddString(self, _object: 'Any') -> 'Any': + """ Adds a string to a listbox. Args: @@ -40740,13 +38773,12 @@ Returns: Any:CListBox::AddString Return ValueThe zero based index of the new string. - - """ - pass + """ + pass - def DeleteString(self,pos:'Any') -> 'Any': - """ + def DeleteString(self, pos: 'Any') -> 'Any': + """ Deletes an item from a listbox. Args: @@ -40758,13 +38790,12 @@ Returns: Any:CListBox::DeleteString Return ValueThe count of the items remaining in the list. - - """ - pass + """ + pass - def Dir(self,attr:'Any',wild:'str') -> 'Any': - """ + def Dir(self, attr: 'Any', wild: 'str') -> 'Any': + """ Fills a listbox with a directory listing. Args: @@ -40777,13 +38808,12 @@ Returns: Any:CListBox::Dir Return ValueThe index of the last file name added to the list. - - """ - pass + """ + pass - def GetCaretIndex(self,) -> 'Any': - """ + def GetCaretIndex(self,) -> 'Any': + """ Returns the index of the item which has focus. Args: @@ -40795,19 +38825,18 @@ Returns: 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 + """ + pass - def GetCount(self,) -> 'Any': - """ + def GetCount(self,) -> 'Any': + """ Returns the count of items in the listbox. Args: @@ -40819,13 +38848,12 @@ Returns: Any:CListBox::GetCount Return ValueReturns the number of items currently in the listbox. - - """ - pass + """ + pass - def GetCurSel(self,) -> 'Any': - """ + def GetCurSel(self,) -> 'Any': + """ Returns the index of the currently selected item. Args: @@ -40835,13 +38863,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetItemData(self,item:'Any') -> 'Any': - """ + def GetItemData(self, item: 'Any') -> 'Any': + """ Retrieves the application-specific object associated with an item. Args: @@ -40851,13 +38878,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetItemValue(self,item:'Any') -> 'Any': - """ + def GetItemValue(self, item: 'Any') -> 'Any': + """ Retrieves the application-specific value associated with an item. Args: @@ -40867,13 +38893,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetSel(self,index:'Any') -> 'Any': - """ + def GetSel(self, index: 'Any') -> 'Any': + """ Returns the selection state of a specified item. Args: @@ -40885,13 +38910,12 @@ Returns: Any:CListBox::GetSel Return ValueA +ve number if the item is selected, else zero. - - """ - pass + """ + pass - def GetSelCount(self,) -> 'Any': - """ + def GetSelCount(self,) -> 'Any': + """ Returns the number of selected items in a multiple selection listbox. Args: @@ -40901,14 +38925,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetSelItems(self,) -> 'Any': - """ - Returns a list of the indexes of the currently selected items in a multiple + def GetSelItems(self,) -> 'Any': + """ + Returns a list of the indexes of the currently selected items in a multiple selection listbox. @@ -40919,14 +38942,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetSelTextItems(self,) -> 'Any': - """ - Returns a list of the strings of the currently selected items in a multiple + def GetSelTextItems(self,) -> 'Any': + """ + Returns a list of the strings of the currently selected items in a multiple selection listbox. @@ -40937,13 +38959,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetTopIndex(self,) -> 'Any': - """ + def GetTopIndex(self,) -> 'Any': + """ Returns the index of the top most visible item. Args: @@ -40955,13 +38976,12 @@ Returns: Any:CListBox::GetTopIndex Return ValueThe zero based index of the top most visible item. - - """ - pass + """ + pass - def GetText(self,index:'Any') -> 'str': - """ + def GetText(self, index: 'Any') -> 'str': + """ Returns the string for a specified item. Args: @@ -40971,13 +38991,12 @@ Args: Returns: str - - """ - pass + """ + pass - def GetTextLen(self,index:'Any') -> 'Any': - """ + def GetTextLen(self, index: 'Any') -> 'Any': + """ Returns the length of the string for a specified item. Args: @@ -40987,13 +39006,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def InsertString(self,pos:'Any',_object:'Any') -> 'Any': - """ + def InsertString(self, pos: 'Any', _object: 'Any') -> 'Any': + """ Insert a string into a listbox. Args: @@ -41006,13 +39024,12 @@ Returns: Any:CListBox::InsertString Return ValueThe zero based index of the new string added. - - """ - pass + """ + pass - def ResetContent(self,) -> 'None': - """ + def ResetContent(self,) -> 'None': + """ Clear all the items from a listbox. Args: @@ -41022,13 +39039,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetCaretIndex(self,index:'Any',bScroll:'Any'=1) -> 'None': - """ + def SetCaretIndex(self, index: 'Any', bScroll: 'Any' = 1) -> 'None': + """ Sets the focus rectange to a specified item. Args: @@ -41039,13 +39055,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SelectString(self,after:'Any',string:'str') -> 'None': - """ + def SelectString(self, after: 'Any', string: 'str') -> 'None': + """ Searches for a list-box item that matches the specified string, and selects it. Args: @@ -41058,13 +39073,12 @@ Returns: None:CListBox::SelectString Return ValueThe return value is always None - an exception is raised if the string can not be located. - - """ - pass + """ + pass - def SelItemRange(self,bSel:'Any',start:'Any',end:'Any') -> 'None': - """ + def SelItemRange(self, bSel: 'Any', start: 'Any', end: 'Any') -> 'None': + """ Selects an item range. Args: @@ -41076,13 +39090,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetCurSel(self,index:'Any') -> 'None': - """ + def SetCurSel(self, index: 'Any') -> 'None': + """ Selects an item in a single selection listbox. Args: @@ -41092,13 +39105,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetItemData(self,item:'Any',Data:'Any') -> 'Any': - """ + def SetItemData(self, item: 'Any', Data: 'Any') -> 'Any': + """ Sets the item's application-specific object value. Args: @@ -41109,13 +39121,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetItemValue(self,item:'Any',data:'Any') -> 'Any': - """ + def SetItemValue(self, item: 'Any', data: 'Any') -> 'Any': + """ Sets the item's application-specific value. Args: @@ -41126,13 +39137,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetSel(self,index:'Any',bSel:'Any'=1) -> 'None': - """ + def SetSel(self, index: 'Any', bSel: 'Any' = 1) -> 'None': + """ Selects an item in a multiple selection listbox. Args: @@ -41143,13 +39153,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetTabStops(self,eachTabStop:'Any',tabStops:'Any') -> 'None': - """ + def SetTabStops(self, eachTabStop: 'Any', tabStops: 'Any') -> 'None': + """ Sets the tab stops for a listbox. Args: @@ -41160,13 +39169,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetTopIndex(self,index:'Any') -> 'None': - """ + def SetTopIndex(self, index: 'Any') -> 'None': + """ Sets the top index (top most visible item) of the listbox. Args: @@ -41176,20 +39184,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyCListCtrl(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCListCtrl(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Arrange(self,code:'Any') -> 'None': - """ + def Arrange(self, code: 'Any') -> 'None': + """ Aligns items on a grid. Args: @@ -41199,13 +39206,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CreateWindow(self,style:'Any',rect:'Tuple[Any, Any, Any, Any]',PyCWnd:'Any',_id:'Any') -> 'None': - """ + def CreateWindow(self, style: 'Any', rect: 'Tuple[Any, Any, Any, Any]', PyCWnd: 'Any', _id: 'Any') -> 'None': + """ Creates the actual window for the object. Args: @@ -41218,13 +39224,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DeleteAllItems(self,) -> 'None': - """ + def DeleteAllItems(self,) -> 'None': + """ Deletes all items from the list. Args: @@ -41234,13 +39239,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DeleteItem(self,item:'Any') -> 'None': - """ + def DeleteItem(self, item: 'Any') -> 'None': + """ Deletes the specified item. Args: @@ -41250,13 +39254,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetTextColor(self,) -> 'Any': - """ + def GetTextColor(self,) -> 'Any': + """ Retrieves the text color of a list view control. Args: @@ -41266,13 +39269,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetTextColor(self,color:'Any') -> 'None': - """ + def SetTextColor(self, color: 'Any') -> 'None': + """ Sets the text color of a list view control. Args: @@ -41282,13 +39284,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetBkColor(self,) -> 'Any': - """ + def GetBkColor(self,) -> 'Any': + """ Retrieves the background color of the control. Args: @@ -41298,13 +39299,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetBkColor(self,color:'Any') -> 'None': - """ + def SetBkColor(self, color: 'Any') -> 'None': + """ Sets the background color of the control. Args: @@ -41314,13 +39314,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetItem(self,item:'Any',sub:'Any') -> 'Any': - """ + def GetItem(self, item: 'Any', sub: 'Any') -> 'Any': + """ Retrieves the details of an items attributes. Args: @@ -41331,13 +39330,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetItemCount(self,) -> 'Any': - """ + def GetItemCount(self,) -> 'Any': + """ Retrieves the number of items in a list view control. Args: @@ -41347,13 +39345,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetItemRect(self,item:'Any',bTextOnly:'Any') -> 'Tuple[Any, Any, Any, Any]': - """ + def GetItemRect(self, item: 'Any', bTextOnly: 'Any') -> 'Tuple[Any, Any, Any, Any]': + """ Retrieves the bounding rectangle of a list view item. Args: @@ -41364,14 +39361,13 @@ Args: Returns: Tuple[Any, Any, Any, Any] - - """ - pass + """ + pass - def GetEditControl(self,) -> 'Any': - """ - Retrieves the handle of the edit control used to edit the specified + def GetEditControl(self,) -> 'Any': + """ + Retrieves the handle of the edit control used to edit the specified list view item. @@ -41382,13 +39378,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def EditLabel(self,item:'Any') -> 'Any': - """ + def EditLabel(self, item: 'Any') -> 'Any': + """ Edits a specified list view item in-place. Args: @@ -41398,13 +39393,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def EnsureVisible(self,item:'Any',bPartialOK:'Any') -> 'Any': - """ + def EnsureVisible(self, item: 'Any', bPartialOK: 'Any') -> 'Any': + """ Ensures that a list view item is visible in its list view control. Args: @@ -41415,14 +39409,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def CreateDragImage(self,item:'Any') -> 'Tuple[Any, Any, Any]': - """ - Creates a dragging bitmap for the specified list view + def CreateDragImage(self, item: 'Any') -> 'Tuple[Any, Any, Any]': + """ + Creates a dragging bitmap for the specified list view item. @@ -41433,13 +39426,12 @@ Args: Returns: Tuple[Any, Any, Any] - - """ - pass + """ + pass - def GetImageList(self,nImageList:'Any') -> 'Any': - """ + def GetImageList(self, nImageList: 'Any') -> 'Any': + """ Retrieves the current image list. Args: @@ -41449,14 +39441,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetNextItem(self,item:'Any',flags:'Any') -> 'Any': - """ - Searches for a list view item with specified properties and with specified + def GetNextItem(self, item: 'Any', flags: 'Any') -> 'Any': + """ + Searches for a list view item with specified properties and with specified relationship to a given item. @@ -41467,27 +39458,26 @@ Args: Returns: - Any:Geometric relation of the requested item to the specified item, + 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 + """ + pass - def InsertColumn(self,colNo:'Any',item:'Any') -> 'Any': - """ + def InsertColumn(self, colNo: 'Any', item: 'Any') -> 'Any': + """ Inserts a column into a list control when in report view. Args: @@ -41498,13 +39488,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def InsertItem(self,item:'Any',item1:'Any',text:'Any',image:'Any',item2:'Any',text1:'Any') -> 'Any': - """ + def InsertItem(self, item: 'Any', item1: 'Any', text: 'Any', image: 'Any', item2: 'Any', text1: 'Any') -> 'Any': + """ Inserts an item into the list. Args: @@ -41519,13 +39508,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetImageList(self,imageList:'Any',imageType:'Any') -> 'Any': - """ + def SetImageList(self, imageList: 'Any', imageType: 'Any') -> 'Any': + """ Assigns an image list to a list view control. Args: @@ -41536,13 +39524,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetColumn(self,column:'Any') -> 'Any': - """ + def GetColumn(self, column: 'Any') -> 'Any': + """ Retrieves the details of a column in the control. Args: @@ -41552,13 +39539,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetTextBkColor(self,) -> 'Any': - """ + def GetTextBkColor(self,) -> 'Any': + """ Retrieves the text background color of a list view control. Args: @@ -41568,13 +39554,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetTextBkColor(self,color:'Any') -> 'None': - """ + def SetTextBkColor(self, color: 'Any') -> 'None': + """ Sets the text background color of a list view control. Args: @@ -41584,13 +39569,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetTopIndex(self,) -> 'Any': - """ + def GetTopIndex(self,) -> 'Any': + """ Retrieves the index of the topmost visible item. Args: @@ -41600,14 +39584,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetCountPerPage(self,) -> 'Any': - """ - Calculates the number of items that can fit vertically in a list view + def GetCountPerPage(self,) -> 'Any': + """ + Calculates the number of items that can fit vertically in a list view control. @@ -41618,13 +39601,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetSelectedCount(self,) -> 'Any': - """ + def GetSelectedCount(self,) -> 'Any': + """ Retrieves the number of selected items in the list view control. Args: @@ -41634,13 +39616,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetItem(self,item:'Any') -> 'Any': - """ + def SetItem(self, item: 'Any') -> 'Any': + """ Sets some of all of an items attributes. Args: @@ -41650,13 +39631,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetItemState(self,item:'Any',state:'Any',mask:'Any') -> 'Any': - """ + def SetItemState(self, item: 'Any', state: 'Any', mask: 'Any') -> 'Any': + """ Changes the state of an item in a list view control. Args: @@ -41668,13 +39648,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetItemState(self,item:'Any',mask:'Any') -> 'Any': - """ + def GetItemState(self, item: 'Any', mask: 'Any') -> 'Any': + """ Retrieves the state of a list view item. Args: @@ -41685,13 +39664,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetItemData(self,item:'Any',Data:'Any') -> 'Any': - """ + def SetItemData(self, item: 'Any', Data: 'Any') -> 'Any': + """ Sets the item's application-specific value. Args: @@ -41702,13 +39680,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetItemData(self,item:'Any') -> 'Any': - """ + def GetItemData(self, item: 'Any') -> 'Any': + """ Retrieves the application-specific value associated with an item. Args: @@ -41718,13 +39695,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetItemCount(self,count:'Any') -> 'None': - """ + def SetItemCount(self, count: 'Any') -> 'None': + """ Prepares a list view control for adding a large number of items. Args: @@ -41734,13 +39710,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetItemText(self,item:'Any',sub:'Any',text:'str') -> 'Any': - """ + def SetItemText(self, item: 'Any', sub: 'Any', text: 'str') -> 'Any': + """ Changes the text of a list view item or subitem. Args: @@ -41752,13 +39727,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetItemText(self,item:'Any',sub:'Any') -> 'Any': - """ + def GetItemText(self, item: 'Any', sub: 'Any') -> 'Any': + """ Retrieves the text of a list view item or subitem. Args: @@ -41769,13 +39743,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def RedrawItems(self,first:'Any',first1:'Any') -> 'Any': - """ + def RedrawItems(self, first: 'Any', first1: 'Any') -> 'Any': + """ Forces a listview to repaint a range of items. Args: @@ -41786,13 +39759,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Update(self,item:'Any') -> 'None': - """ + def Update(self, item: 'Any') -> 'None': + """ Forces the control to repaint a specified item. Args: @@ -41802,13 +39774,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetColumn(self,colNo:'Any',item:'Any') -> 'Any': - """ + def SetColumn(self, colNo: 'Any', item: 'Any') -> 'Any': + """ Changes column state in a list control when in report view. Args: @@ -41819,13 +39790,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def DeleteColumn(self,first:'Any') -> 'Any': - """ + def DeleteColumn(self, first: 'Any') -> 'Any': + """ Deletes the specified column from the list control. Args: @@ -41835,13 +39805,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetColumnWidth(self,first:'Any') -> 'Any': - """ + def GetColumnWidth(self, first: 'Any') -> 'Any': + """ Gets the width of the specified column in the list control. Args: @@ -41851,13 +39820,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetColumnWidth(self,first:'Any',first1:'Any') -> 'Any': - """ + def SetColumnWidth(self, first: 'Any', first1: 'Any') -> 'Any': + """ Sets the width of the specified column in the list control. Args: @@ -41868,13 +39836,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetStringWidth(self,first:'Any') -> 'Any': - """ + def GetStringWidth(self, first: 'Any') -> 'Any': + """ Gets the necessary column width to fully display this text in a column. Args: @@ -41884,13 +39851,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def HitTest(self,arg:'Any') -> 'Tuple[Any, Any, Any]': - """ + def HitTest(self, arg: 'Any') -> 'Tuple[Any, Any, Any]': + """ Determines which list view item, if any, is at a specified position. Args: @@ -41899,7 +39865,7 @@ Args: Returns: - Tuple[Any, Any, Any]:The point to test.Return ValueThe result is a tuple of (flags, item, subItem). + Tuple[Any, Any, 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 +39880,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,13 +39889,12 @@ 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 + """ + pass - def GetItemPosition(self,item:'Any') -> 'Tuple[Any, Any]': - """ + def GetItemPosition(self, item: 'Any') -> 'Tuple[Any, Any]': + """ Determines the position of the specified item. Args: @@ -41939,20 +39904,19 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass -class PyCListView(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCListView(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def PreCreateWindow(self,createStruct:'Any') -> 'Any': - """ + def PreCreateWindow(self, createStruct: 'Any') -> 'Any': + """ Calls the underlying MFC PreCreateWindow method. Args: @@ -41962,13 +39926,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetListCtrl(self,) -> 'Any': - """ + def GetListCtrl(self,) -> 'Any': + """ Returns the underlying list control object. Args: @@ -41978,13 +39941,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OnCommand(self,wparam:'Any',lparam:'Any') -> 'None': - """ + def OnCommand(self, wparam: 'Any', lparam: 'Any') -> 'None': + """ Calls the standard Python framework OnCommand handler Args: @@ -41995,20 +39957,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyCMDIChildWnd(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCMDIChildWnd(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def ActivateFrame(self,cmdShow:'Any'=-1) -> 'None': - """ + def ActivateFrame(self, cmdShow: 'Any' = -1) -> 'None': + """ Calls the underlying MFC ActivateFrame method. Args: @@ -42018,13 +39979,19 @@ Args: Returns: None - - """ - pass + """ + pass - def CreateWindow(self,wndClass:'str',title:'str',style:'Any',PyCWnd:'Any',rect:'Tuple[Any, Any, Any, Any]'=None,createContext:'Any'=None) -> 'Any': - """ + def CreateWindow( + self, + wndClass: 'str', + title: 'str', + style: 'Any', + PyCWnd: 'Any', + rect: 'Tuple[Any, Any, Any, Any]' = None, + createContext: 'Any' = None) -> 'Any': + """ Creates the actual window for the PyCWnd object. Args: @@ -42039,13 +40006,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetMDIFrame(self,) -> 'None': - """ + def GetMDIFrame(self,) -> 'None': + """ Returns the MDI parent frame Args: @@ -42055,13 +40021,12 @@ Args: Returns: None - - """ - pass + """ + pass - def MDIActivate(self,cmdShow:'Any'=-1) -> 'None': - """ + def MDIActivate(self, cmdShow: 'Any' = -1) -> 'None': + """ Activates the MDI frame independent of the main frame. Args: @@ -42071,13 +40036,12 @@ Args: Returns: None - - """ - pass + """ + pass - def PreCreateWindow(self,createStruct:'Any') -> 'Any': - """ + def PreCreateWindow(self, createStruct: 'Any') -> 'Any': + """ Calls the underlying MFC PreCreateWindow method. Args: @@ -42087,13 +40051,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def PreTranslateMessage(self,) -> 'None': - """ + def PreTranslateMessage(self,) -> 'None': + """ Calls the base PreTranslateMessage handler Args: @@ -42103,13 +40066,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnCommand(self,wparam:'Any',lparam:'Any') -> 'None': - """ + def OnCommand(self, wparam: 'Any', lparam: 'Any') -> 'None': + """ Calls the standard Python framework OnCommand handler Args: @@ -42120,13 +40082,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnClose(self,) -> 'None': - """ + def OnClose(self,) -> 'None': + """ Calls the standard Python framework OnClose handler Args: @@ -42136,20 +40097,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyCMDIFrameWnd(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCMDIFrameWnd(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetMDIClient(self,) -> 'Any': - """ + def GetMDIClient(self,) -> 'Any': + """ Returns the MDI client window Args: @@ -42159,14 +40119,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def MDIGetActive(self,) -> 'Tuple[Any, Any]': - """ - Retrieves the current active MDI child window, along + def MDIGetActive(self,) -> 'Tuple[Any, Any]': + """ + Retrieves the current active MDI child window, along with a flag indicating whether the child window is maximized. @@ -42177,13 +40136,12 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def MDIActivate(self,window:'Any') -> 'Any': - """ + def MDIActivate(self, window: 'Any') -> 'Any': + """ Activate an MDI child window Args: @@ -42193,13 +40151,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def MDINext(self,fNext:'Any'=0) -> 'None': - """ + def MDINext(self, fNext: 'Any' = 0) -> 'None': + """ Activates the next MDI window Args: @@ -42209,13 +40166,12 @@ Args: Returns: None - - """ - pass + """ + pass - def PreCreateWindow(self,createStruct:'Any') -> 'Any': - """ + def PreCreateWindow(self, createStruct: 'Any') -> 'Any': + """ Calls the underlying MFC PreCreateWindow method. Args: @@ -42225,13 +40181,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def PreTranslateMessage(self,) -> 'None': - """ + def PreTranslateMessage(self,) -> 'None': + """ Calls the base PreTranslateMessage handler Args: @@ -42241,13 +40196,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnCommand(self,wparam:'Any',lparam:'Any') -> 'None': - """ + def OnCommand(self, wparam: 'Any', lparam: 'Any') -> 'None': + """ Calls the standard Python framework OnCommand handler Args: @@ -42258,13 +40212,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnContextHelp(self,) -> 'Any': - """ + def OnContextHelp(self,) -> 'Any': + """ Calls the underlying MFC OnContextHelp method. Args: @@ -42274,13 +40227,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OnClose(self,) -> 'None': - """ + def OnClose(self,) -> 'None': + """ Calls the standard Python framework OnClose handler Args: @@ -42290,21 +40242,20 @@ Args: Returns: None - - """ - pass + """ + pass -class PyCMenu(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCMenu(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def AppendMenu(self,flags:'Any',_id:'Any'=0,value:'Union[Any, str]'=None) -> 'None': - """ - Appends a new item to the end of a menu. Python can specify the state of the menu item + def AppendMenu(self, flags: 'Any', _id: 'Any' = 0, value: 'Union[Any, str]' = None) -> 'None': + """ + 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,13 +40268,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DeleteMenu(self,_id:'Any',flags:'Any') -> 'str': - """ + def DeleteMenu(self, _id: 'Any', flags: 'Any') -> 'str': + """ Deletes the specified menu item. Args: @@ -42334,13 +40284,12 @@ Args: Returns: str - - """ - pass + """ + pass - def EnableMenuItem(self,_id:'Any',flags:'Any') -> 'Any': - """ + def EnableMenuItem(self, _id: 'Any', flags: 'Any') -> 'Any': + """ Enables, disables, or dims a menu item. Args: @@ -42351,13 +40300,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetHandle(self,) -> 'Any': - """ + def GetHandle(self,) -> 'Any': + """ Returns the menu object's underlying hMenu. Args: @@ -42367,13 +40315,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetMenuItemCount(self,) -> 'Any': - """ + def GetMenuItemCount(self,) -> 'Any': + """ Determines the number of items in a menu. Args: @@ -42387,13 +40334,12 @@ 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 + """ + pass - def GetMenuItemID(self,pos:'Any') -> 'Any': - """ + def GetMenuItemID(self, pos: 'Any') -> 'Any': + """ Returns the item ID for the specified item in a pop-up menu. Args: @@ -42403,13 +40349,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetMenuString(self,_id:'Any',arg:'Any') -> 'str': - """ + def GetMenuString(self, _id: 'Any', arg: 'Any') -> 'str': + """ Returns the string for a specified menu item. Args: @@ -42420,13 +40365,12 @@ Args: Returns: str - - """ - pass + """ + pass - def GetSubMenu(self,pos:'Any') -> 'Any': - """ + def GetSubMenu(self, pos: 'Any') -> 'Any': + """ Returns a submenu. Args: @@ -42436,13 +40380,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def InsertMenu(self,pos:'Any',flags:'Any',_id:'Union[Any]'=0,value:'Union[Any, str]'=None) -> 'None': - """ + def InsertMenu(self, pos: 'Any', flags: 'Any', _id: 'Union[Any]' = 0, value: 'Union[Any, str]' = None) -> 'None': + """ Inserts an item into a menu. Args: @@ -42455,13 +40398,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ModifyMenu(self,pos:'Any',flags:'Any',_id:'Any'=0,value:'Union[Any, str]'=None) -> 'None': - """ + def ModifyMenu(self, pos: 'Any', flags: 'Any', _id: 'Any' = 0, value: 'Union[Any, str]' = None) -> 'None': + """ Modify an item in a menu. Args: @@ -42474,13 +40416,12 @@ Args: Returns: None - - """ - pass + """ + pass - def TrackPopupMenu(self,arg:'Tuple[Any, Any]',arg1:'Any',arg2:'Any') -> 'None': - """ + def TrackPopupMenu(self, arg: 'Tuple[Any, Any]', arg1: 'Any', arg2: 'Any') -> 'None': + """ Creates a popup menu anywhere on the screen. Args: @@ -42494,29 +40435,28 @@ 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 + """ + pass -class PyCOleClientItem(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCOleClientItem(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def CreateNewItem(self,) -> 'None': - """ + def CreateNewItem(self,) -> 'None': + """ Creates an embedded item. Args: @@ -42526,13 +40466,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Close(self,) -> 'None': - """ + def Close(self,) -> 'None': + """ Closes the item Args: @@ -42542,13 +40481,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DoVerb(self,) -> 'None': - """ + def DoVerb(self,) -> 'None': + """ Executes the specified verb. Args: @@ -42558,14 +40496,13 @@ Args: Returns: None - - """ - pass + """ + pass - def Draw(self,) -> 'None': - """ - Draws the OLE item into the specified bounding rectangle using the specified device + def Draw(self,) -> 'None': + """ + Draws the OLE item into the specified bounding rectangle using the specified device context. @@ -42576,13 +40513,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetActiveView(self,) -> 'Any': - """ + def GetActiveView(self,) -> 'Any': + """ Obtains the active view for the item Args: @@ -42592,13 +40528,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetDocument(self,) -> 'Any': - """ + def GetDocument(self,) -> 'Any': + """ Obtains the current document for the item Args: @@ -42608,14 +40543,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetInPlaceWindow(self,) -> 'Any': - """ - Obtains the window in which the item has been opened for + def GetInPlaceWindow(self,) -> 'Any': + """ + Obtains the window in which the item has been opened for in-place editing. @@ -42626,13 +40560,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetItemState(self,) -> 'None': - """ + def GetItemState(self,) -> 'None': + """ Obtains the OLE item's current state Args: @@ -42642,14 +40575,13 @@ Args: Returns: None - - """ - pass + """ + pass - def GetObject(self,) -> 'Any': - """ - Returns the COM object to the item. This is the m_lpObject + def GetObject(self,) -> 'Any': + """ + Returns the COM object to the item. This is the m_lpObject variable in MFC. @@ -42660,13 +40592,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetStorage(self,) -> 'None': - """ + def GetStorage(self,) -> 'None': + """ Returns the COM object used for storage Args: @@ -42676,13 +40607,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnActivate(self,) -> 'None': - """ + def OnActivate(self,) -> 'None': + """ Calls the underlying MFC method. Args: @@ -42692,13 +40622,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnChange(self,) -> 'None': - """ + def OnChange(self,) -> 'None': + """ Calls the underlying MFC method. Args: @@ -42708,13 +40637,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnChangeItemPosition(self,) -> 'Any': - """ + def OnChangeItemPosition(self,) -> 'Any': + """ Calls the underlying MFC method. Args: @@ -42728,13 +40656,12 @@ Returns: int = OnChangeItemPosition()Calls the underlying MFC method. Return ValueThe result is a BOOL indicating if the function succeeded. No exception is thrown. - - """ - pass + """ + pass - def OnDeactivateUI(self,) -> 'Any': - """ + def OnDeactivateUI(self,) -> 'Any': + """ Calls the underlying MFC method. Args: @@ -42744,13 +40671,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Run(self,) -> 'None': - """ + def Run(self,) -> 'None': + """ Runs the application associated with this item. Args: @@ -42760,13 +40686,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetItemRects(self,) -> 'None': - """ + def SetItemRects(self,) -> 'None': + """ Sets the bounding rectangle or the visible rectangle of the OLE item. Args: @@ -42776,28 +40701,27 @@ Args: Returns: None - - """ - pass + + """ + pass class PyCOleDialog(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyCOleDocument(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def EnableCompoundFile(self,bEnable:'Any'=1) -> 'None': - """ - Call this function if you want to store the document using the + def EnableCompoundFile(self, bEnable: 'Any' = 1) -> 'None': + """ + Call this function if you want to store the document using the compound-file format. @@ -42808,13 +40732,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetStartPosition(self,) -> 'Any': - """ + def GetStartPosition(self,) -> 'Any': + """ Obtains the position of the first item in the document. Args: @@ -42824,14 +40747,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetNextItem(self,pos:'Any') -> 'Tuple[Any, Any]': - """ - Call this function repeatedly to access each of + def GetNextItem(self, pos: 'Any') -> 'Tuple[Any, Any]': + """ + Call this function repeatedly to access each of the items in your document. @@ -42842,14 +40764,13 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def GetInPlaceActiveItem(self,wnd:'Any') -> 'Any': - """ - Obtains the OLE item that is currently activated + def GetInPlaceActiveItem(self, wnd: 'Any') -> 'Any': + """ + Obtains the OLE item that is currently activated in place in the frame window containing the view identified by obWnd. @@ -42860,20 +40781,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyCOleInsertDialog(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCOleInsertDialog(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetClassID(self,) -> 'Any': - """ + def GetClassID(self,) -> 'Any': + """ Returns the CLSID associated with the selected item Args: @@ -42883,13 +40803,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetSelectionType(self,) -> 'Any': - """ + def GetSelectionType(self,) -> 'Any': + """ Returns the type of selection made Args: @@ -42899,13 +40818,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetPathName(self,) -> 'Any': - """ + def GetPathName(self,) -> 'Any': + """ Returns the full path to the file selected in the dialog box Args: @@ -42915,27 +40833,26 @@ Args: Returns: Any - - """ - pass + + """ + pass class PyCPrintDialog(object): - """An object which encapsulates an MFC CPrintDialog object.""" + """An object which encapsulates an MFC CPrintDialog object.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyCPrintInfo(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def DocObject(self,) -> 'None': - """ + def DocObject(self,) -> 'None': + """ Return true if the document being printed is a DocObject. Args: @@ -42945,14 +40862,13 @@ Args: Returns: None - - """ - pass + """ + pass - def GetDwFlags(self,) -> 'None': - """ - A flags specifying DocObject printing operations. Valid only if data member + def GetDwFlags(self,) -> 'None': + """ + A flags specifying DocObject printing operations. Valid only if data member m_bDocObject is TRUE. @@ -42963,14 +40879,13 @@ Args: Returns: None - - """ - pass + """ + pass - def SetDwFlags(self,) -> 'None': - """ - Set a flag specifying DocObject printing operations. Valid only if data member + def SetDwFlags(self,) -> 'None': + """ + Set a flag specifying DocObject printing operations. Valid only if data member m_bDocObject is TRUE. @@ -42981,14 +40896,13 @@ Args: Returns: None - - """ - pass + """ + pass - def GetDocOffsetPage(self,) -> 'None': - """ - Get the number of pages preceding the first page of a particular DocObject + def GetDocOffsetPage(self,) -> 'None': + """ + Get the number of pages preceding the first page of a particular DocObject in a combined DocObject print job. @@ -42999,14 +40913,13 @@ Args: Returns: None - - """ - pass + """ + pass - def SetDocOffsetPage(self,) -> 'None': - """ - Set the number of pages preceding the first page of a particular DocObject + def SetDocOffsetPage(self,) -> 'None': + """ + Set the number of pages preceding the first page of a particular DocObject in a combined DocObject print job. @@ -43017,14 +40930,13 @@ Args: Returns: None - - """ - pass + """ + pass - def SetPrintDialog(self,) -> 'None': - """ - Set a pointer to the CPrintDialog object used to display the Print dialog box + def SetPrintDialog(self,) -> 'None': + """ + Set a pointer to the CPrintDialog object used to display the Print dialog box for the print job. @@ -43035,13 +40947,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetDirect(self,) -> 'None': - """ + def GetDirect(self,) -> 'None': + """ TRUE if the Print dialog box will be bypassed for direct printing; FALSE otherwise. Args: @@ -43051,14 +40962,13 @@ Args: Returns: None - - """ - pass + """ + pass - def SetDirect(self,) -> 'None': - """ - Sets to TRUE if the Print dialog box will be bypassed for direct printing; FALSE + def SetDirect(self,) -> 'None': + """ + Sets to TRUE if the Print dialog box will be bypassed for direct printing; FALSE otherwise. @@ -43069,13 +40979,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetPreview(self,) -> 'None': - """ + def GetPreview(self,) -> 'None': + """ A flag indicating whether the document is being previewed. Args: @@ -43085,13 +40994,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetPreview(self,) -> 'None': - """ + def SetPreview(self,) -> 'None': + """ Set whether the document is being previewed. Args: @@ -43101,13 +41009,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetContinuePrinting(self,) -> 'None': - """ + def GetContinuePrinting(self,) -> 'None': + """ A flag indicating whether the framework should continue the print loop. Args: @@ -43117,13 +41024,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetContinuePrinting(self,) -> 'None': - """ + def SetContinuePrinting(self,) -> 'None': + """ Set whether the framework should continue the print loop. Args: @@ -43133,13 +41039,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetCurPage(self,) -> 'None': - """ + def GetCurPage(self,) -> 'None': + """ Get the number of the current page. Args: @@ -43149,13 +41054,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetCurPage(self,) -> 'None': - """ + def SetCurPage(self,) -> 'None': + """ Set the number of the current page. Args: @@ -43165,13 +41069,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetNumPreviewPages(self,) -> 'None': - """ + def GetNumPreviewPages(self,) -> 'None': + """ Get the number of pages displayed in preview mode. Args: @@ -43181,13 +41084,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetNumPreviewPages(self,) -> 'None': - """ + def SetNumPreviewPages(self,) -> 'None': + """ Set the number of pages displayed in preview mode. Args: @@ -43197,13 +41099,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetUserData(self,) -> 'None': - """ + def GetUserData(self,) -> 'None': + """ Get a user-created structure. Args: @@ -43213,13 +41114,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetUserData(self,) -> 'None': - """ + def SetUserData(self,) -> 'None': + """ Set a user-created structure. Args: @@ -43229,13 +41129,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetDraw(self,) -> 'None': - """ + def GetDraw(self,) -> 'None': + """ Get the usable drawing area of the page in logical coordinates. Args: @@ -43245,13 +41144,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetDraw(self,) -> 'None': - """ + def SetDraw(self,) -> 'None': + """ Set the usable drawing area of the page in logical coordinates. Args: @@ -43261,13 +41159,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetPageDesc(self,) -> 'None': - """ + def GetPageDesc(self,) -> 'None': + """ Get the format string used to display the page numbers during print preview Args: @@ -43277,13 +41174,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetPageDesc(self,) -> 'None': - """ + def SetPageDesc(self,) -> 'None': + """ Set the format string used to display the page numbers during print preview Args: @@ -43293,13 +41189,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetMinPage(self,) -> 'None': - """ + def GetMinPage(self,) -> 'None': + """ Get the number of the first page of the document. Args: @@ -43309,13 +41204,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetMinPage(self,) -> 'None': - """ + def SetMinPage(self,) -> 'None': + """ Set the number of the first page of the document. Args: @@ -43325,13 +41219,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetMaxPage(self,) -> 'None': - """ + def GetMaxPage(self,) -> 'None': + """ Get the number of the last page of the document. Args: @@ -43341,13 +41234,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetMaxPage(self,) -> 'None': - """ + def SetMaxPage(self,) -> 'None': + """ Set the number of the last page of the document. Args: @@ -43357,16 +41249,15 @@ Args: Returns: None - - """ - pass + """ + pass - def GetOffsetPage(self,) -> 'None': - """ - Get the number of pages preceding the first page of a DocObject item being + def GetOffsetPage(self,) -> 'None': + """ + 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,13 +41268,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetFromPage(self,) -> 'None': - """ + def GetFromPage(self,) -> 'None': + """ The number of the first page to be printed. Args: @@ -43393,13 +41283,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetToPage(self,) -> 'None': - """ + def GetToPage(self,) -> 'None': + """ The number of the last page to be printed. Args: @@ -43409,14 +41298,13 @@ Args: Returns: None - - """ - pass + """ + pass - def SetHDC(self,hdc:'Any') -> 'None': - """ - Sets the printer DC compatible with the users choices, call after the print dialog + def SetHDC(self, hdc: 'Any') -> 'None': + """ + Sets the printer DC compatible with the users choices, call after the print dialog DoModal finishes. @@ -43427,14 +41315,13 @@ Args: Returns: None - - """ - pass + """ + pass - def CreatePrinterDC(self,) -> 'None': - """ - Handle to the newly created printer device context, call only after DoModal + def CreatePrinterDC(self,) -> 'None': + """ + Handle to the newly created printer device context, call only after DoModal finishes. @@ -43445,13 +41332,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DoModal(self,) -> 'None': - """ + def DoModal(self,) -> 'None': + """ Call DoModal on the dialog. Args: @@ -43461,13 +41347,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetCopies(self,) -> 'None': - """ + def GetCopies(self,) -> 'None': + """ The number of copies requested, call only after DoModal finishes. Args: @@ -43477,26 +41362,25 @@ Args: Returns: None - - """ - pass + """ + pass - def GetDefaults(self,) -> 'None': - """ - Nonzero if the function was successful; otherwise 0. Call this function to + def GetDefaults(self,) -> 'None': + """ + 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 +41391,13 @@ Args: Returns: None - - """ - pass + """ + pass - def FreeDefaults(self,) -> 'None': - """ - After a call to GetDefaults, and you are through with the CPrintDialog object, + def FreeDefaults(self,) -> 'None': + """ + 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,13 +41408,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetDeviceName(self,) -> 'None': - """ + def GetDeviceName(self,) -> 'None': + """ The name of the currently selected printer, call only after DoModal finishes. Args: @@ -43541,14 +41423,13 @@ Args: Returns: None - - """ - pass + """ + pass - def GetDriverName(self,) -> 'None': - """ - The name of the currently selected printer device driver, call only after + def GetDriverName(self,) -> 'None': + """ + The name of the currently selected printer device driver, call only after DoModal finishes. @@ -43559,13 +41440,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetDlgFromPage(self,) -> 'None': - """ + def GetDlgFromPage(self,) -> 'None': + """ Retrieves the starting page of the print range. Args: @@ -43575,13 +41455,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetDlgToPage(self,) -> 'None': - """ + def GetDlgToPage(self,) -> 'None': + """ Retrieves the ending page of the print range. Args: @@ -43591,14 +41470,13 @@ Args: Returns: None - - """ - pass + """ + pass - def GetPortName(self,) -> 'None': - """ - The name of the currently selected printer port, call only after DoModal + def GetPortName(self,) -> 'None': + """ + The name of the currently selected printer port, call only after DoModal finishes. @@ -43609,18 +41487,17 @@ Args: Returns: None - - """ - pass + """ + pass - def GetPrinterDC(self,) -> 'None': - """ - A handle to the printer device context if successful; otherwise NULL. If the + def GetPrinterDC(self,) -> 'None': + """ + 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 +41508,13 @@ Args: Returns: None - - """ - pass + """ + pass - def PrintAll(self,) -> 'None': - """ - Nonzero if all pages in the document are to be printed; otherwise 0, call only after + def PrintAll(self,) -> 'None': + """ + Nonzero if all pages in the document are to be printed; otherwise 0, call only after DoModal finishes. @@ -43649,14 +41525,13 @@ Args: Returns: None - - """ - pass + """ + pass - def PrintCollate(self,) -> 'None': - """ - Nonzero if the user selects the collate check box in the dialog box; otherwise + def PrintCollate(self,) -> 'None': + """ + Nonzero if the user selects the collate check box in the dialog box; otherwise 0, call only after DoModal finishes. @@ -43667,14 +41542,13 @@ Args: Returns: None - - """ - pass + """ + pass - def PrintRange(self,) -> 'None': - """ - Nonzero if only a range of pages in the document are to be printed; otherwise 0, + def PrintRange(self,) -> 'None': + """ + Nonzero if only a range of pages in the document are to be printed; otherwise 0, call only after DoModal finishes. @@ -43685,14 +41559,13 @@ Args: Returns: None - - """ - pass + """ + pass - def PrintSelection(self,) -> 'None': - """ - Nonzero if only the selected items are to be printed; otherwise 0., call only + def PrintSelection(self,) -> 'None': + """ + Nonzero if only the selected items are to be printed; otherwise 0., call only after DoModal finishes @@ -43703,16 +41576,15 @@ Args: Returns: None - - """ - pass + """ + pass - def GetHDC(self,) -> 'None': - """ - Identifies a device context or an information context, depending on whether the Flags + def GetHDC(self,) -> 'None': + """ + 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 +41595,23 @@ Args: Returns: None - - """ - pass + """ + pass - def GetFlags(self,) -> 'None': - """ - A set of bit flags that you can use to initialize the Print common dialog box. When + def GetFlags(self,) -> 'None': + """ + 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 +41622,23 @@ Args: Returns: None - - """ - pass + """ + pass - def SetFlags(self,) -> 'None': - """ - A set of bit flags that you can use to initialize the Print common dialog box. When + def SetFlags(self,) -> 'None': + """ + 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,13 +41649,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetFromPage(self,) -> 'None': - """ + def SetFromPage(self,) -> 'None': + """ The number of the first page to be printed. Args: @@ -43795,13 +41664,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetToPage(self,) -> 'None': - """ + def SetToPage(self,) -> 'None': + """ The number of the last page to be printed. Args: @@ -43811,16 +41679,15 @@ Args: Returns: None - - """ - pass + """ + pass - def GetPRINTDLGMinPage(self,) -> 'None': - """ - Get the minimum value for the page range specified in the From and To page + def GetPRINTDLGMinPage(self,) -> 'None': + """ + 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 +41698,15 @@ Args: Returns: None - - """ - pass + """ + pass - def SetPRINTDLGMinPage(self,) -> 'None': - """ - Set the minimum value for the page range specified in the From and To page + def SetPRINTDLGMinPage(self,) -> 'None': + """ + 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 +41717,23 @@ Args: Returns: None - - """ - pass + """ + pass - def GetPRINTDLGCopies(self,) -> 'None': - """ - Get the initial number of copies for the Copies edit control if hDevMode is + def GetPRINTDLGCopies(self,) -> 'None': + """ + 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 +41744,23 @@ Args: Returns: None - - """ - pass + """ + pass - def SetPRINTDLGCopies(self,) -> 'None': - """ - Set the initial number of copies for the Copies edit control if hDevMode is + def SetPRINTDLGCopies(self,) -> 'None': + """ + 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,20 +41771,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyCProgressCtrl(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCProgressCtrl(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def CreateWindow(self,style:'Any',rect:'Tuple[Any, Any, Any, Any]',parent:'Any',_id:'Any') -> 'None': - """ + def CreateWindow(self, style: 'Any', rect: 'Tuple[Any, Any, Any, Any]', parent: 'Any', _id: 'Any') -> 'None': + """ Creates the actual control. Args: @@ -43933,13 +41796,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetRange(self,nLower:'Any'=1,nUpper:'Any'=1) -> 'None': - """ + def SetRange(self, nLower: 'Any' = 1, nUpper: 'Any' = 1) -> 'None': + """ Set the control's bounds Args: @@ -43950,13 +41812,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetPos(self,nPos:'Any'=1) -> 'Any': - """ + def SetPos(self, nPos: 'Any' = 1) -> 'Any': + """ Set the control's position Args: @@ -43966,14 +41827,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def OffsetPos(self,nPos:'Any'=1) -> 'Any': - """ - Advances the progress bar control's current position by the increment + def OffsetPos(self, nPos: 'Any' = 1) -> 'Any': + """ + Advances the progress bar control's current position by the increment specified @@ -43984,13 +41844,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetStep(self,nStep:'Any'=1) -> 'Any': - """ + def SetStep(self, nStep: 'Any' = 1) -> 'Any': + """ Specifies the step increment for a progress bar control. Args: @@ -44000,14 +41859,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def StepIt(self,) -> 'Any': - """ - Advances the current position for a progress bar control by the step increment. + def StepIt(self,) -> 'Any': + """ + Advances the current position for a progress bar control by the step increment. Returns previous position. @@ -44018,20 +41876,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyCPropertyPage(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCPropertyPage(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def CancelToClose(self,) -> 'None': - """ + def CancelToClose(self,) -> 'None': + """ Changes the Cancel button to Close. Args: @@ -44041,13 +41898,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnCancel(self,) -> 'None': - """ + def OnCancel(self,) -> 'None': + """ Calls the default MFC OnCancel handler. Args: @@ -44057,13 +41913,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnOK(self,) -> 'None': - """ + def OnOK(self,) -> 'None': + """ Calls the default MFC OnOK handler. Args: @@ -44073,13 +41928,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnApply(self,) -> 'None': - """ + def OnApply(self,) -> 'None': + """ Calls the default MFC OnApply handler. Args: @@ -44089,13 +41943,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnReset(self,) -> 'None': - """ + def OnReset(self,) -> 'None': + """ Calls the default MFC OnReset handler. Args: @@ -44105,13 +41958,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnQueryCancel(self,) -> 'None': - """ + def OnQueryCancel(self,) -> 'None': + """ Calls the default MFC OnQueryCancel handler. Args: @@ -44121,13 +41973,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnWizardBack(self,) -> 'None': - """ + def OnWizardBack(self,) -> 'None': + """ Calls the default MFC OnWizardBack handler. Args: @@ -44137,13 +41988,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnWizardNext(self,) -> 'None': - """ + def OnWizardNext(self,) -> 'None': + """ Calls the default MFC OnWizardNext handler. Args: @@ -44153,13 +42003,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnWizardFinish(self,) -> 'None': - """ + def OnWizardFinish(self,) -> 'None': + """ Calls the default MFC OnWizardFinish handler. Args: @@ -44169,13 +42018,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnSetActive(self,) -> 'Any': - """ + def OnSetActive(self,) -> 'Any': + """ Calls the default MFC OnSetActive handler. Args: @@ -44185,17 +42033,16 @@ Args: Returns: 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 + """ + pass - def OnKillActive(self,) -> 'Any': - """ + def OnKillActive(self,) -> 'Any': + """ Calls the default MFC OnKillActive handler. Args: @@ -44205,17 +42052,16 @@ Args: Returns: 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 + """ + pass - def SetModified(self,bChanged:'Any'=1) -> 'None': - """ + def SetModified(self, bChanged: 'Any' = 1) -> 'None': + """ Sets the modified flag. Args: @@ -44225,13 +42071,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetPSPBit(self,bitMask:'Any',bitValue:'Any') -> 'None': - """ + def SetPSPBit(self, bitMask: 'Any', bitValue: 'Any') -> 'None': + """ Sets or clears a bit in m_psp.dwFlags Args: @@ -44242,20 +42087,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyCPropertySheet(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCPropertySheet(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def AddPage(self,page:'Any') -> 'None': - """ + def AddPage(self, page: 'Any') -> 'None': + """ Adds the supplied page with the rightmost tab in the property sheet. Args: @@ -44265,13 +42109,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CreateWindow(self,style:'Any',exStyle:'Any',parent:'Any'=None) -> 'None': - """ + def CreateWindow(self, style: 'Any', exStyle: 'Any', parent: 'Any' = None) -> 'None': + """ Displays the property sheet as a modeless dialog. Args: @@ -44283,13 +42126,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DoModal(self,) -> 'Any': - """ + def DoModal(self,) -> 'Any': + """ Displays the property sheet as a modal dialog. Args: @@ -44299,13 +42141,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def EnableStackedTabs(self,stacked:'Any') -> 'Any': - """ + def EnableStackedTabs(self, stacked: 'Any') -> 'Any': + """ Enables or disables stacked tabs. Args: @@ -44315,13 +42156,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def EndDialog(self,result:'Any') -> 'None': - """ + def EndDialog(self, result: 'Any') -> 'None': + """ Closes the dialog, with the specified result. Args: @@ -44331,13 +42171,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetActiveIndex(self,) -> 'Any': - """ + def GetActiveIndex(self,) -> 'Any': + """ Retrieves the index of the active page of the property sheet. Args: @@ -44347,13 +42186,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetActivePage(self,) -> 'Any': - """ + def GetActivePage(self,) -> 'Any': + """ Returns the currently active property page. Args: @@ -44363,13 +42201,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetPage(self,pageNo:'Any') -> 'Any': - """ + def GetPage(self, pageNo: 'Any') -> 'Any': + """ Returns the specified property page. Args: @@ -44379,13 +42216,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetPageIndex(self,page:'Any') -> 'Any': - """ + def GetPageIndex(self, page: 'Any') -> 'Any': + """ Retrieves the index of the specified page of the property sheet. Args: @@ -44395,13 +42231,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetPageCount(self,) -> 'Any': - """ + def GetPageCount(self,) -> 'Any': + """ Returns the number of pages. Args: @@ -44411,13 +42246,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetTabCtrl(self,) -> 'Any': - """ + def GetTabCtrl(self,) -> 'Any': + """ Returns the tab control used by the sheet. Args: @@ -44427,13 +42261,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OnInitDialog(self,) -> 'Any': - """ + def OnInitDialog(self,) -> 'Any': + """ Calls the default MFC OnInitDialog handler. Args: @@ -44443,13 +42276,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def PressButton(self,button:'Any') -> 'None': - """ + def PressButton(self, button: 'Any') -> 'None': + """ Simulates the choice of the specified button in a property sheet. Args: @@ -44459,13 +42291,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RemovePage(self,offset:'Any',page:'Any') -> 'None': - """ + def RemovePage(self, offset: 'Any', page: 'Any') -> 'None': + """ Removes the specified page from the sheet. Args: @@ -44476,13 +42307,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetActivePage(self,page:'Any') -> 'None': - """ + def SetActivePage(self, page: 'Any') -> 'None': + """ Programmatically sets the active page object. Args: @@ -44492,13 +42322,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetTitle(self,title:'str') -> 'None': - """ + def SetTitle(self, title: 'str') -> 'None': + """ Sets the caption for the property sheet. Args: @@ -44508,13 +42337,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetFinishText(self,text:'str') -> 'None': - """ + def SetFinishText(self, text: 'str') -> 'None': + """ Sets the text for the Finish button Args: @@ -44524,13 +42352,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetWizardMode(self,) -> 'None': - """ + def SetWizardMode(self,) -> 'None': + """ Enables the wizard mode Args: @@ -44540,13 +42367,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetWizardButtons(self,flags:'Any') -> 'None': - """ + def SetWizardButtons(self, flags: 'Any') -> 'None': + """ Enables the wizard buttons Args: @@ -44556,13 +42382,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetPSHBit(self,bitMask:'Any',bitValue:'Any') -> 'None': - """ + def SetPSHBit(self, bitMask: 'Any', bitValue: 'Any') -> 'None': + """ Sets or clears a bit in m_psh.dwFlags Args: @@ -44573,34 +42398,33 @@ Args: Returns: None - - """ - pass + + """ + pass class PyCRect(object): - """A Python interface the the MFC CRect class.""" + """A Python interface the the MFC CRect class.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyCRgn(object): - """An object encapsulating an MFC PyCRgn class.""" + """An object encapsulating an MFC PyCRgn class.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class PyCRichEditCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def Clear(self,) -> 'Any': - """ + def Clear(self,) -> 'Any': + """ Clears all text in an edit control. Args: @@ -44610,13 +42434,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Copy(self,) -> 'None': - """ + def Copy(self,) -> 'None': + """ Copys the current selection to the clipboard. Args: @@ -44626,13 +42449,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CreateWindow(self,style:'Any',rect:'Tuple[Any, Any, Any, Any]',parent:'Any',_id:'Any') -> 'None': - """ + def CreateWindow(self, style: 'Any', rect: 'Tuple[Any, Any, Any, Any]', parent: 'Any', _id: 'Any') -> 'None': + """ Creates a rich edit control window. Args: @@ -44645,13 +42467,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Cut(self,) -> 'None': - """ + def Cut(self,) -> 'None': + """ Cuts the current selection to the clipboard. Args: @@ -44661,13 +42482,12 @@ Args: Returns: None - - """ - pass + """ + pass - def FindText(self,charPos:'Any') -> 'Tuple[Any, Any, Any]': - """ + def FindText(self, charPos: 'Any') -> 'Tuple[Any, Any, Any]': + """ Finds text in the control Args: @@ -44677,14 +42497,13 @@ Args: Returns: Tuple[Any, Any, Any] - - """ - pass + """ + pass - def GetCharPos(self,charPos:'Any') -> 'Any': - """ - Returns the location of the top-left corner of the character specified + def GetCharPos(self, charPos: 'Any') -> 'Any': + """ + Returns the location of the top-left corner of the character specified by charPos. @@ -44697,13 +42516,12 @@ Returns: Any:The character positionReturn ValueThe return value is a win32ui::CHARFORMAT tuple - - """ - pass + """ + pass - def GetDefaultCharFormat(self,) -> 'Any': - """ + def GetDefaultCharFormat(self,) -> 'Any': + """ None Args: @@ -44716,13 +42534,12 @@ Returns: Return ValueThe return value is a win32ui::CHARFORMAT tuple - - """ - pass + """ + pass - def GetEventMask(self,) -> 'Any': - """ + def GetEventMask(self,) -> 'Any': + """ Returns the current event mask. Args: @@ -44732,13 +42549,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetSelectionCharFormat(self,) -> 'Any': - """ + def GetSelectionCharFormat(self,) -> 'Any': + """ Returns the character formatting of the selection. Args: @@ -44748,13 +42564,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetFirstVisibleLine(self,) -> 'Any': - """ + def GetFirstVisibleLine(self,) -> 'Any': + """ Returns zero-based index of the topmost visible line. Args: @@ -44766,13 +42581,12 @@ Returns: Any:CRichEditCtrl::GetFirstVisibleLine Return ValueThe zero-based index of the topmost visible line. For single-line edit controls, the return value is 0. - - """ - pass + """ + pass - def GetParaFormat(self,) -> 'Any': - """ + def GetParaFormat(self,) -> 'Any': + """ Returns the current paragraph formatting attributes. Args: @@ -44785,13 +42599,12 @@ Returns: Return ValueThe return value is a win32ui::PARAFORMAT tuple - - """ - pass + """ + pass - def GetSel(self,) -> 'Tuple[Any, Any]': - """ + def GetSel(self,) -> 'Tuple[Any, Any]': + """ Returns the start and end of the current selection. Args: @@ -44801,17 +42614,16 @@ Args: Returns: Tuple[Any, 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 + """ + pass - def GetSelText(self,) -> 'str': - """ + def GetSelText(self,) -> 'str': + """ Returns the currently selected text Args: @@ -44821,13 +42633,12 @@ Args: Returns: str - - """ - pass + """ + pass - def GetTextLength(self,) -> 'Any': - """ + def GetTextLength(self,) -> 'Any': + """ Returns the length of the text in the control. Args: @@ -44837,13 +42648,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetLine(self,lineNo:'Any') -> 'Any': - """ + def GetLine(self, lineNo: 'Any') -> 'Any': + """ Returns the text in a specified line. Args: @@ -44853,13 +42663,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetModify(self,) -> 'Any': - """ + def GetModify(self,) -> 'Any': + """ Nonzero if the text in this control has been modified; otherwise 0. Args: @@ -44869,13 +42678,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetLineCount(self,) -> 'Any': - """ + def GetLineCount(self,) -> 'Any': + """ Gets the number of lines in an edit control. Args: @@ -44887,13 +42695,12 @@ Returns: Any:CRichEditCtrl::GetLineCount Return ValueThe number of lines in the buffer. If the control is empty, the return value is 1. - - """ - pass + """ + pass - def LimitText(self,nChars:'Any'=0) -> 'None': - """ + def LimitText(self, nChars: 'Any' = 0) -> 'None': + """ Sets max length of text that user can enter Args: @@ -44903,13 +42710,12 @@ Args: Returns: None - - """ - pass + """ + pass - def LineFromChar(self,charNo:'Any'=-1) -> 'Any': - """ + def LineFromChar(self, charNo: 'Any' = -1) -> 'Any': + """ Returns the line number of the specified character. Args: @@ -44919,19 +42725,18 @@ Args: Returns: 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 + """ + pass - def LineIndex(self,lineNo:'Any'=-1) -> 'Any': - """ + def LineIndex(self, lineNo: 'Any' = -1) -> 'Any': + """ Retrieves the character index of a line within a multiple-line edit control. Args: @@ -44941,19 +42746,18 @@ Args: Returns: 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 + """ + pass - def LineScroll(self,nLines:'Any',nChars:'Any'=0) -> 'Any': - """ + def LineScroll(self, nLines: 'Any', nChars: 'Any' = 0) -> 'Any': + """ Scroll the control vertically and horizontally Args: @@ -44964,13 +42768,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Paste(self,) -> 'None': - """ + def Paste(self,) -> 'None': + """ Pastes the contents of the clipboard into the control. Args: @@ -44980,13 +42783,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ReplaceSel(self,text:'str') -> 'None': - """ + def ReplaceSel(self, text: 'str') -> 'None': + """ Replaces the selection with the specified text. Args: @@ -44996,13 +42798,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetBackgroundColor(self,bSysColor:'Any',cr:'Any'=0) -> 'Any': - """ + def SetBackgroundColor(self, bSysColor: 'Any', cr: 'Any' = 0) -> 'Any': + """ Sets the background color for the control. Args: @@ -45015,13 +42816,12 @@ Returns: Any:CRichEditCtrl::SetEventMask Return ValueThe return value is the previous background color. - - """ - pass + """ + pass - def SetDefaultCharFormat(self,charFormat:'Any') -> 'None': - """ + def SetDefaultCharFormat(self, charFormat: 'Any') -> 'None': + """ None Args: @@ -45031,13 +42831,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetEventMask(self,eventMask:'Any') -> 'Any': - """ + def SetEventMask(self, eventMask: 'Any') -> 'Any': + """ Sets the event motification mask. Args: @@ -45049,13 +42848,12 @@ Returns: Any:CRichEditCtrl::SetEventMask Return ValueThe return value is the previous event mask. - - """ - pass + """ + pass - def SetSelectionCharFormat(self,charFormat:'Any') -> 'None': - """ + def SetSelectionCharFormat(self, charFormat: 'Any') -> 'None': + """ Sets the current selections character formatting attributes. Args: @@ -45065,13 +42863,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetModify(self,modified:'Any'=1) -> 'None': - """ + def SetModify(self, modified: 'Any' = 1) -> 'None': + """ Sets the modified flag for this control Args: @@ -45081,13 +42878,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetOptions(self,op:'Any',flags:'Any') -> 'None': - """ + def SetOptions(self, op: 'Any', flags: 'Any') -> 'None': + """ Sets options for the control. Args: @@ -45098,13 +42894,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetParaFormat(self,paraFormat:'Any') -> 'Any': - """ + def SetParaFormat(self, paraFormat: 'Any') -> 'Any': + """ Sets the paragraph formatting Args: @@ -45114,19 +42909,18 @@ Args: Returns: 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 + """ + pass - def SetReadOnly(self,bReadOnly:'Any'=1) -> 'None': - """ + def SetReadOnly(self, bReadOnly: 'Any' = 1) -> 'None': + """ Sets or clears the read-only status of the listbox. Args: @@ -45136,13 +42930,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetSel(self,start:'Any',end:'Any',arg:'Any') -> 'None': - """ + def SetSel(self, start: 'Any', end: 'Any', arg: 'Any') -> 'None': + """ Sets the selection in the edit control. Args: @@ -45154,13 +42947,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetSelAndCharFormat(self,charFormat:'Any') -> 'None': - """ + def SetSelAndCharFormat(self, charFormat: 'Any') -> 'None': + """ Sets the selection and char format. Args: @@ -45170,13 +42962,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetTargetDevice(self,dc:'Any',lineWidth:'Any') -> 'None': - """ + def SetTargetDevice(self, dc: 'Any', lineWidth: 'Any') -> 'None': + """ Sets the target device for the control Args: @@ -45187,13 +42978,12 @@ Args: Returns: None - - """ - pass + """ + pass - def StreamIn(self,_format:'Any',method:'Any') -> 'Tuple[Any, Any]': - """ + def StreamIn(self, _format: 'Any', method: 'Any') -> 'Tuple[Any, Any]': + """ Invokes a callback to stream data into the control. Args: @@ -45206,13 +42996,12 @@ Returns: Tuple[Any, Any]:CRichEditCtrl::StreamIn Return ValueThe return value is a tuple of (no bytes written, error code) - - """ - pass + """ + pass - def StreamOut(self,_format:'Any',method:'Any') -> 'Tuple[Any, Any]': - """ + def StreamOut(self, _format: 'Any', method: 'Any') -> 'Tuple[Any, Any]': + """ Invokes a callback to stream data into the control. Args: @@ -45225,23 +43014,22 @@ Returns: Tuple[Any, Any]:CRichEditCtrl::StreamOut Return ValueThe return value is a tuple of (no bytes written, error code) - - """ - pass + """ + pass -class PyCRichEditDoc(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCRichEditDoc(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def OnCloseDocument(self,) -> 'None': - """ - Call the MFC OnCloseDocument handler. + def OnCloseDocument(self,) -> 'None': + """ + 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,20 +43040,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyCRichEditDocTemplate(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCRichEditDocTemplate(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def DoCreateRichEditDoc(self,fileName:'str'=None) -> 'Any': - """ + def DoCreateRichEditDoc(self, fileName: 'str' = None) -> 'Any': + """ Creates an underlying document object. Args: @@ -45275,20 +43062,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyCRichEditView(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCRichEditView(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetRichEditCtrl(self,) -> 'Any': - """ + def GetRichEditCtrl(self,) -> 'Any': + """ Returns the underlying rich edit control object. Args: @@ -45298,13 +43084,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetWordWrap(self,wordWrap:'Any') -> 'Any': - """ + def SetWordWrap(self, wordWrap: 'Any') -> 'Any': + """ Sets the wordwrap state for the control. Args: @@ -45314,13 +43099,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def WrapChanged(self,) -> 'Any': - """ + def WrapChanged(self,) -> 'Any': + """ Calls the underlying WrapChanged method. Args: @@ -45330,13 +43114,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SaveTextFile(self,FileName:'Any') -> 'Any': - """ + def SaveTextFile(self, FileName: 'Any') -> 'Any': + """ Saves the contents of the control as a test file Args: @@ -45346,20 +43129,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyCScrollView(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCScrollView(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetDeviceScrollPosition(self,) -> 'Tuple[Any, Any]': - """ + def GetDeviceScrollPosition(self,) -> 'Tuple[Any, Any]': + """ Returns the positon of the scroll bars in device units. Args: @@ -45369,13 +43151,12 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def GetDC(self,) -> 'Any': - """ + def GetDC(self,) -> 'Any': + """ Gets the view's current DC. Args: @@ -45385,13 +43166,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetScrollPosition(self,) -> 'Tuple[Any, Any]': - """ + def GetScrollPosition(self,) -> 'Tuple[Any, Any]': + """ Returns the current position of the scroll bars (in logical units). Args: @@ -45401,13 +43181,12 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def GetTotalSize(self,) -> 'Tuple[Any, Any]': - """ + def GetTotalSize(self,) -> 'Tuple[Any, Any]': + """ Returns the total size of the view in logical units. Args: @@ -45417,13 +43196,12 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def OnCommand(self,wparam:'Any',lparam:'Any') -> 'None': - """ + def OnCommand(self, wparam: 'Any', lparam: 'Any') -> 'None': + """ Calls the standard Python framework OnCommand handler Args: @@ -45434,13 +43212,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ResizeParentToFit(self,bShrinkOnly:'Any'=1) -> 'Any': - """ + def ResizeParentToFit(self, bShrinkOnly: 'Any' = 1) -> 'Any': + """ Lets the size of a view dictate the size of its frame window. Args: @@ -45450,13 +43227,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetScaleToFitSize(self,size:'Tuple[Any, Any]') -> 'None': - """ + def SetScaleToFitSize(self, size: 'Tuple[Any, Any]') -> 'None': + """ Scales the viewport size to the current window size automatically. Args: @@ -45466,13 +43242,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ScrollToPosition(self,position:'Tuple[Any, Any]') -> 'None': - """ + def ScrollToPosition(self, position: 'Tuple[Any, Any]') -> 'None': + """ Scrolls to a given point in the view. Args: @@ -45482,13 +43257,17 @@ Args: Returns: None - - """ - pass + """ + pass - def SetScrollSizes(self,mapMode:'Any',sizeTotal:'Tuple[Any, Any]',arg:'Tuple[Any, Any]',arg1:'Tuple[Any, Any]') -> 'None': - """ + def SetScrollSizes( + self, + mapMode: 'Any', + sizeTotal: 'Tuple[Any, Any]', + arg: 'Tuple[Any, Any]', + arg1: 'Tuple[Any, Any]') -> 'None': + """ Sets the sizes of the scroll bars Args: @@ -45501,13 +43280,12 @@ Args: Returns: None - - """ - pass + """ + pass - def UpdateBars(self,) -> 'None': - """ + def UpdateBars(self,) -> 'None': + """ Update the scroll bars state Args: @@ -45517,20 +43295,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyCSliderCtrl(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCSliderCtrl(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def CreateWindow(self,style:'Any',rect:'Tuple[Any, Any, Any, Any]',parent:'Any',_id:'Any') -> 'None': - """ + def CreateWindow(self, style: 'Any', rect: 'Tuple[Any, Any, Any, Any]', parent: 'Any', _id: 'Any') -> 'None': + """ Creates the actual control. Args: @@ -45543,13 +43320,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetLineSize(self,) -> 'Any': - """ + def GetLineSize(self,) -> 'Any': + """ Get the control's position Args: @@ -45559,13 +43335,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetLineSize(self,nLineSize:'Any'=1) -> 'Any': - """ + def SetLineSize(self, nLineSize: 'Any' = 1) -> 'Any': + """ Set the control's line size. Returns the previous line size. Args: @@ -45575,13 +43350,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetPageSize(self,) -> 'Any': - """ + def GetPageSize(self,) -> 'Any': + """ Get the control's position Args: @@ -45591,13 +43365,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetPageSize(self,nPageSize:'Any'=1) -> 'Any': - """ + def SetPageSize(self, nPageSize: 'Any' = 1) -> 'Any': + """ Set the control's page size Returns the previous page size. Args: @@ -45607,13 +43380,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetRangeMax(self,) -> 'Any': - """ + def GetRangeMax(self,) -> 'Any': + """ Get the control's Maximum Args: @@ -45623,13 +43395,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetRangeMin(self,) -> 'Any': - """ + def GetRangeMin(self,) -> 'Any': + """ Get the control's Minimum Args: @@ -45639,13 +43410,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetRange(self,) -> 'Any': - """ + def GetRange(self,) -> 'Any': + """ Get the control's min and max Args: @@ -45655,13 +43425,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetRange(self,nRangeMin:'Any'=1,nRangeMax:'Any'=1,bRedraw:'Any'=1) -> 'Any': - """ + def SetRange(self, nRangeMin: 'Any' = 1, nRangeMax: 'Any' = 1, bRedraw: 'Any' = 1) -> 'Any': + """ Set the control's min and max Args: @@ -45673,13 +43442,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetSelection(self,) -> 'Any': - """ + def GetSelection(self,) -> 'Any': + """ Get the control's selection start and end positions Args: @@ -45689,13 +43457,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetSelection(self,nRangeMin:'Any'=1,nRangeMax:'Any'=1) -> 'Any': - """ + def SetSelection(self, nRangeMin: 'Any' = 1, nRangeMax: 'Any' = 1) -> 'Any': + """ Set the control's selection start and end positions Args: @@ -45706,13 +43473,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetChannelRect(self,) -> 'Any': - """ + def GetChannelRect(self,) -> 'Any': + """ Get the control's channel rectangle Args: @@ -45722,13 +43488,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetThumbRect(self,) -> 'Any': - """ + def GetThumbRect(self,) -> 'Any': + """ Get the control's thumb rectangle Args: @@ -45738,13 +43503,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetPos(self,) -> 'Any': - """ + def GetPos(self,) -> 'Any': + """ Get the control's position Args: @@ -45754,13 +43518,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetPos(self,nPos:'Any'=1) -> 'Any': - """ + def SetPos(self, nPos: 'Any' = 1) -> 'Any': + """ Set the control's position Args: @@ -45770,13 +43533,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetNumTics(self,) -> 'Any': - """ + def GetNumTics(self,) -> 'Any': + """ Get number of tics in the slider Args: @@ -45786,13 +43548,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetTicArray(self,) -> 'Any': - """ + def GetTicArray(self,) -> 'Any': + """ Get a tuple of slider tic positions Args: @@ -45802,13 +43563,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetTic(self,nTic:'Any'=1) -> 'Any': - """ + def GetTic(self, nTic: 'Any' = 1) -> 'Any': + """ Get the position of the specified tic number Args: @@ -45818,13 +43578,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetTicPos(self,nTic:'Any'=1) -> 'Any': - """ + def GetTicPos(self, nTic: 'Any' = 1) -> 'Any': + """ Get the position of the specified tic number in client coordinates Args: @@ -45834,13 +43593,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetTic(self,nTic:'Any'=1) -> 'Any': - """ + def SetTic(self, nTic: 'Any' = 1) -> 'Any': + """ Set a tic at the specified position Args: @@ -45850,13 +43608,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetTicFreq(self,nFreq:'Any'=1) -> 'Any': - """ + def SetTicFreq(self, nFreq: 'Any' = 1) -> 'Any': + """ Set the tic frequency Args: @@ -45866,13 +43623,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def ClearSel(self,bRedraw:'Any'=1) -> 'Any': - """ + def ClearSel(self, bRedraw: 'Any' = 1) -> 'Any': + """ Clear the selection Args: @@ -45882,13 +43638,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def VerifyPos(self,) -> 'Any': - """ + def VerifyPos(self,) -> 'Any': + """ Verify the position is between configured min and max Args: @@ -45898,13 +43653,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def ClearTics(self,bRedraw:'Any'=1) -> 'Any': - """ + def ClearTics(self, bRedraw: 'Any' = 1) -> 'Any': + """ Clear the control's tic marks Args: @@ -45914,20 +43668,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyCSpinButtonCtrl(object): - """A windows spin button control. Encapsulates an MFC CSpinButtonCtrl object.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCSpinButtonCtrl(object): + """A windows spin button control. Encapsulates an MFC CSpinButtonCtrl object.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetPos(self,) -> 'Any': - """ + def GetPos(self,) -> 'Any': + """ Obtains the current position for a spin button control. Args: @@ -45937,13 +43690,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetPos(self,pos:'Any') -> 'Any': - """ + def SetPos(self, pos: 'Any') -> 'Any': + """ Sets the current position for a spin button control. Args: @@ -45954,13 +43706,12 @@ Returns: Any:The new position.Return ValueThe result is the previous position. - - """ - pass + """ + pass - def SetRange(self,) -> 'Any': - """ + def SetRange(self,) -> 'Any': + """ Sets the upper and lower limits (range) for a spin button control. Args: @@ -45970,13 +43721,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetRange32(self,) -> 'Any': - """ + def SetRange32(self,) -> 'Any': + """ Sets the 32 bit upper and lower limits (range) for a spin button control. Args: @@ -45986,20 +43736,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyCSplitterWnd(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCSplitterWnd(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetPane(self,row:'Any',col:'Any') -> 'Any': - """ + def GetPane(self, row: 'Any', col: 'Any') -> 'Any': + """ None Args: @@ -46010,13 +43759,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def CreateView(self,view:'Any',row:'Any',col:'Any',arg:'Tuple[Any, Any]') -> 'None': - """ + def CreateView(self, view: 'Any', row: 'Any', col: 'Any', arg: 'Tuple[Any, Any]') -> 'None': + """ Creates a view in a splitter window Args: @@ -46029,13 +43777,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CreateStatic(self,parent:'Any',rows:'Any',cols:'Any',style:'Any',_id:'Any') -> 'None': - """ + def CreateStatic(self, parent: 'Any', rows: 'Any', cols: 'Any', style: 'Any', _id: 'Any') -> 'None': + """ Creates a static splitter window. Args: @@ -46049,13 +43796,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetColumnInfo(self,column:'Any',ideal:'Any',_min:'Any') -> 'None': - """ + def SetColumnInfo(self, column: 'Any', ideal: 'Any', _min: 'Any') -> 'None': + """ Sets a new minimum height and ideal height for a column Args: @@ -46067,13 +43813,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetRowInfo(self,row:'Any',ideal:'Any',_min:'Any') -> 'None': - """ + def SetRowInfo(self, row: 'Any', ideal: 'Any', _min: 'Any') -> 'None': + """ Sets a new minimum height and ideal height for a row. Args: @@ -46085,13 +43830,12 @@ Args: Returns: None - - """ - pass + """ + pass - def IdFromRowCol(self,row:'Any',col:'Any') -> 'None': - """ + def IdFromRowCol(self, row: 'Any', col: 'Any') -> 'None': + """ Gets the child window ID for the specified child. Args: @@ -46102,13 +43846,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DoKeyboardSplit(self,) -> 'Any': - """ + def DoKeyboardSplit(self,) -> 'Any': + """ None Args: @@ -46118,21 +43861,20 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyCStatusBar(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCStatusBar(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetPaneInfo(self,index:'Any') -> 'Tuple[Any, Any, Any]': - """ - Returns the id, style, and width of the indicator pane at the + def GetPaneInfo(self, index: 'Any') -> 'Tuple[Any, Any, Any]': + """ + Returns the id, style, and width of the indicator pane at the location specified by index. @@ -46143,13 +43885,12 @@ Args: Returns: Tuple[Any, Any, Any] - - """ - pass + """ + pass - def GetStatusBarCtrl(self,) -> 'Any': - """ + def GetStatusBarCtrl(self,) -> 'Any': + """ Gets the statusbar control object for the statusbar. Args: @@ -46159,13 +43900,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetIndicators(self,indicators:'Any') -> 'None': - """ + def SetIndicators(self, indicators: 'Any') -> 'None': + """ Sets each indicator's ID. Args: @@ -46175,13 +43915,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetPaneInfo(self,index:'Any',_id:'Any',style:'Any',width:'Any') -> 'None': - """ + def SetPaneInfo(self, index: 'Any', _id: 'Any', style: 'Any', width: 'Any') -> 'None': + """ Sets the specified indicator pane to a new ID, style, and width. Args: @@ -46194,20 +43933,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyCStatusBarCtrl(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCStatusBarCtrl(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def CreateWindow(self,style:'Any',rect:'Tuple[Any, Any, Any, Any]',parent:'Any',_id:'Any') -> 'None': - """ + def CreateWindow(self, style: 'Any', rect: 'Tuple[Any, Any, Any, Any]', parent: 'Any', _id: 'Any') -> 'None': + """ Creates the actual control. Args: @@ -46220,14 +43958,13 @@ Args: Returns: None - - """ - pass + """ + pass - def GetBorders(self,) -> 'Tuple[Any, Any, Any]': - """ - Retrieve the status bar control's current widths of + def GetBorders(self,) -> 'Tuple[Any, Any, Any]': + """ + Retrieve the status bar control's current widths of the horizontal and vertical borders and of the space between rectangles. @@ -46238,13 +43975,12 @@ Args: Returns: Tuple[Any, Any, Any] - - """ - pass + """ + pass - def GetParts(self,nParts:'Any') -> 'Any': - """ + def GetParts(self, nParts: 'Any') -> 'Any': + """ Retrieve coordinates of the parts in a status bar control. Args: @@ -46254,14 +43990,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetRect(self,nPane:'Any') -> 'Tuple[Any, Any, Any, Any]': - """ - Retrieves the bounding rectangle of a part in a status + def GetRect(self, nPane: 'Any') -> 'Tuple[Any, Any, Any, Any]': + """ + Retrieves the bounding rectangle of a part in a status bar control. @@ -46272,13 +44007,12 @@ Args: Returns: Tuple[Any, Any, Any, Any] - - """ - pass + """ + pass - def GetText(self,nPane:'Any') -> 'Any': - """ + def GetText(self, nPane: 'Any') -> 'Any': + """ Retrieve the text from the given part of a status bar control. Args: @@ -46288,14 +44022,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetTextAttr(self,nPane:'Any') -> 'Any': - """ - Retrieve the attributes of the text in the given part of a status bar + def GetTextAttr(self, nPane: 'Any') -> 'Any': + """ + Retrieve the attributes of the text in the given part of a status bar control. @@ -46306,13 +44039,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetTextLength(self,nPane:'Any') -> 'Any': - """ + def GetTextLength(self, nPane: 'Any') -> 'Any': + """ Retrieve the length the text in the given part of a status bar control. Args: @@ -46322,13 +44054,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetMinHeight(self,nHeight:'Any') -> 'None': - """ + def SetMinHeight(self, nHeight: 'Any') -> 'None': + """ Set the minimum height of a status bar control's drawing area. Args: @@ -46338,14 +44069,13 @@ Args: Returns: None - - """ - pass + """ + pass - def SetParts(self,coord:'Any') -> 'None': - """ - Sets the number of parts in a status bar control and the coordinate of the right + def SetParts(self, coord: 'Any') -> 'None': + """ + Sets the number of parts in a status bar control and the coordinate of the right edge of each part. @@ -46356,13 +44086,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetText(self,text:'str',nPane:'Any',nType:'Any') -> 'None': - """ + def SetText(self, text: 'str', nPane: 'Any', nType: 'Any') -> 'None': + """ Set the text in the given part of a status bar control. Args: @@ -46374,14 +44103,13 @@ Args: Returns: None - - """ - pass + """ + pass - def SetTipText(self,nPane:'Any',text:'str') -> 'None': - """ - Sets the tooltip text for a pane in a status bar. The status bar must have + def SetTipText(self, nPane: 'Any', text: 'str') -> 'None': + """ + 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,20 +44121,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyCTabCtrl(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCTabCtrl(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetCurSel(self,) -> 'Any': - """ + def GetCurSel(self,) -> 'Any': + """ Gets the current selection of a tab control. Args: @@ -46420,13 +44147,12 @@ 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 + """ + pass - def GetItemCountl(self,) -> 'Any': - """ + def GetItemCountl(self,) -> 'Any': + """ Returns the number of tabs in the control. Args: @@ -46436,13 +44162,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetCurSel(self,index:'Any') -> 'Any': - """ + def SetCurSel(self, index: 'Any') -> 'Any': + """ Sets the current selection of a tab control. Args: @@ -46453,20 +44178,19 @@ Returns: Any:The index of the tab to set current.Return ValueThe zero-based index of the previously selected item. - - """ - pass + """ + pass -class PyCToolBar(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCToolBar(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetButtonStyle(self,index:'Any') -> 'None': - """ + def GetButtonStyle(self, index: 'Any') -> 'None': + """ Retrieves the style for a button. Args: @@ -46476,13 +44200,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetButtonText(self,index:'Any') -> 'str': - """ + def GetButtonText(self, index: 'Any') -> 'str': + """ Gets the text for a button. Args: @@ -46492,13 +44215,12 @@ Args: Returns: str - - """ - pass + """ + pass - def GetItemID(self,index:'Any') -> 'None': - """ + def GetItemID(self, index: 'Any') -> 'None': + """ Returns the command ID of a button or separator at the given index. Args: @@ -46508,13 +44230,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetButtonInfo(self,index:'Any',ID:'Any',style:'Any',imageIx:'Any') -> 'None': - """ + def SetButtonInfo(self, index: 'Any', ID: 'Any', style: 'Any', imageIx: 'Any') -> 'None': + """ Sets the button's command ID, style, and image number. Args: @@ -46527,13 +44248,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetToolBarCtrl(self,) -> 'Any': - """ + def GetToolBarCtrl(self,) -> 'Any': + """ Gets the toolbar control object for the toolbar Args: @@ -46543,13 +44263,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def LoadBitmap(self,_id:'PyResourceId') -> 'None': - """ + def LoadBitmap(self, _id: 'PyResourceId') -> 'None': + """ Loads the bitmap containing bitmap-button images. Args: @@ -46559,13 +44278,12 @@ Args: Returns: None - - """ - pass + """ + pass - def LoadToolBar(self,_id:'PyResourceId') -> 'None': - """ + def LoadToolBar(self, _id: 'PyResourceId') -> 'None': + """ Loads a toolbar from a toolbar resource. Args: @@ -46575,13 +44293,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetBarStyle(self,style:'Any') -> 'None': - """ + def SetBarStyle(self, style: 'Any') -> 'None': + """ Sets the toolbar part of style Args: @@ -46591,13 +44308,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetBitmap(self,hBitmap:'Any') -> 'None': - """ + def SetBitmap(self, hBitmap: 'Any') -> 'None': + """ Sets a bitmapped image. Args: @@ -46607,13 +44323,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetButtons(self,buttons:'Any',numButtons:'Any') -> 'None': - """ + def SetButtons(self, buttons: 'Any', numButtons: 'Any') -> 'None': + """ Sets button styles and an index of button images within the bitmap. Args: @@ -46624,13 +44339,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetButtonStyle(self,index:'Any',style:'Any') -> 'None': - """ + def SetButtonStyle(self, index: 'Any', style: 'Any') -> 'None': + """ Sets the style for a button. Args: @@ -46641,13 +44355,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetHeight(self,height:'Any') -> 'None': - """ + def SetHeight(self, height: 'Any') -> 'None': + """ Sets the height of the toolbar. Args: @@ -46657,13 +44370,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetSizes(self,sizeButton:'Tuple[Any, Any]',sizeButton1:'Tuple[Any, Any]') -> 'None': - """ + def SetSizes(self, sizeButton: 'Tuple[Any, Any]', sizeButton1: 'Tuple[Any, Any]') -> 'None': + """ Sets the size of each button. Args: @@ -46674,20 +44386,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyCToolBarCtrl(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCToolBarCtrl(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def AddBitmap(self,numButtons:'Any',bitmap:'Any') -> 'Any': - """ + def AddBitmap(self, numButtons: 'Any', bitmap: 'Any') -> 'Any': + """ Add one or more button images to the list of button images Args: @@ -46698,13 +44409,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def AddButtons(self,) -> 'Any': - """ + def AddButtons(self,) -> 'Any': + """ Add one or more buttons to the toolbar Args: @@ -46714,13 +44424,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def AddStrings(self,strings:'Any') -> 'Any': - """ + def AddStrings(self, strings: 'Any') -> 'Any': + """ Add one or more strings to the toolbar Args: @@ -46730,13 +44439,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def AutoSize(self,) -> 'None': - """ + def AutoSize(self,) -> 'None': + """ Resize the entire toolbar control Args: @@ -46746,13 +44454,12 @@ Args: Returns: None - - """ - pass + """ + pass - def CheckButton(self,nID:'Any',bCheck:'Any'=1) -> 'Any': - """ + def CheckButton(self, nID: 'Any', bCheck: 'Any' = 1) -> 'Any': + """ Check or clear a given button in a toolbar control Args: @@ -46763,14 +44470,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def CommandToIndex(self,nID:'Any') -> 'Any': - """ - Retrieve the zero-based index for the button associated with the + def CommandToIndex(self, nID: 'Any') -> 'Any': + """ + Retrieve the zero-based index for the button associated with the specified command identifier. @@ -46781,13 +44487,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def CreateWindow(self,style:'Any',rect:'Tuple[Any, Any, Any, Any]',parent:'Any',_id:'Any') -> 'None': - """ + def CreateWindow(self, style: 'Any', rect: 'Tuple[Any, Any, Any, Any]', parent: 'Any', _id: 'Any') -> 'None': + """ Creates the window for a new toolbar object Args: @@ -46800,13 +44505,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Customize(self,) -> 'None': - """ + def Customize(self,) -> 'None': + """ Display the Customize Toolbar dialog box. Args: @@ -46816,13 +44520,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DeleteButton(self,nID:'Any') -> 'None': - """ + def DeleteButton(self, nID: 'Any') -> 'None': + """ Delete a button from the toolbar control. Args: @@ -46832,13 +44535,12 @@ Args: Returns: None - - """ - pass + """ + pass - def EnableButton(self,nID:'Any',bEnable:'Any'=1) -> 'None': - """ + def EnableButton(self, nID: 'Any', bEnable: 'Any' = 1) -> 'None': + """ Enable or disable a toolbar control button. Args: @@ -46849,13 +44551,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetBitmapFlags(self,) -> 'Any': - """ + def GetBitmapFlags(self,) -> 'Any': + """ retrieve the bitmap flags from the toolbar. Args: @@ -46865,14 +44566,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetButton(self,nID:'Any') -> 'Any': - """ - Retrieve information about the specified button in a + def GetButton(self, nID: 'Any') -> 'Any': + """ + Retrieve information about the specified button in a toolbar control. @@ -46883,13 +44583,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetButtonCount(self,) -> 'Any': - """ + def GetButtonCount(self,) -> 'Any': + """ Retrieve a count of the buttons currently in the toolbar control. Args: @@ -46899,14 +44598,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetItemRect(self,nID:'Any') -> 'Tuple[Any, Any, Any, Any]': - """ - Retrieve the bounding rectangle of a button in a + def GetItemRect(self, nID: 'Any') -> 'Tuple[Any, Any, Any, Any]': + """ + Retrieve the bounding rectangle of a button in a toolbar control. @@ -46917,13 +44615,12 @@ Args: Returns: Tuple[Any, Any, Any, Any] - - """ - pass + """ + pass - def GetRows(self,) -> 'Tuple[Any, Any, Any, Any]': - """ + def GetRows(self,) -> 'Tuple[Any, Any, Any, Any]': + """ Retrieve the number of rows of buttons currently displayed Args: @@ -46933,13 +44630,12 @@ Args: Returns: Tuple[Any, Any, Any, Any] - - """ - pass + """ + pass - def HideButton(self,nID:'Any',bEnable:'Any'=1) -> 'None': - """ + def HideButton(self, nID: 'Any', bEnable: 'Any' = 1) -> 'None': + """ Hide or show the specified button in a toolbar control. Args: @@ -46950,13 +44646,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Indeterminate(self,nID:'Any',bEnable:'Any'=1) -> 'None': - """ + def Indeterminate(self, nID: 'Any', bEnable: 'Any' = 1) -> 'None': + """ Mark or unmark the specified button as indeterminate Args: @@ -46967,13 +44662,12 @@ Args: Returns: None - - """ - pass + """ + pass - def InsertButton(self,nID:'Any',button:'Any') -> 'Any': - """ + def InsertButton(self, nID: 'Any', button: 'Any') -> 'Any': + """ Insert a button in a toolbar control. Args: @@ -46984,13 +44678,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def IsButtonChecked(self,nID:'Any') -> 'Any': - """ + def IsButtonChecked(self, nID: 'Any') -> 'Any': + """ Determine whether the specified button in a toolbar control is checked. Args: @@ -47000,13 +44693,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def IsButtonEnabled(self,nID:'Any') -> 'Any': - """ + def IsButtonEnabled(self, nID: 'Any') -> 'Any': + """ Determine whether the specified button in a toolbar control is enabled. Args: @@ -47016,13 +44708,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def IsButtonHidden(self,nID:'Any') -> 'Any': - """ + def IsButtonHidden(self, nID: 'Any') -> 'Any': + """ Determine whether the specified button in a toolbar control is hidden. Args: @@ -47032,14 +44723,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def IsButtonIndeterminate(self,nID:'Any') -> 'Any': - """ - Determine whether the specified button in a toolbar control is + def IsButtonIndeterminate(self, nID: 'Any') -> 'Any': + """ + Determine whether the specified button in a toolbar control is indeterminate. @@ -47050,13 +44740,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def IsButtonPressed(self,nID:'Any') -> 'Any': - """ + def IsButtonPressed(self, nID: 'Any') -> 'Any': + """ Determine whether the specified button in a toolbar control is pressed. Args: @@ -47066,13 +44755,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def PressButton(self,nID:'Any',bEnable:'Any'=1) -> 'None': - """ + def PressButton(self, nID: 'Any', bEnable: 'Any' = 1) -> 'None': + """ Mark or unmark the specified button as pressed. Args: @@ -47083,13 +44771,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetBitmapSize(self,width1:'Any',height1:'Any',width:'Any'=16,height:'Any'=15) -> 'None': - """ + def SetBitmapSize(self, width1: 'Any', height1: 'Any', width: 'Any' = 16, height: 'Any' = 15) -> 'None': + """ Set the size of the actual bitmapped images to be added to a toolbar control. Args: @@ -47102,13 +44789,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetButtonSize(self,width1:'Any',height1:'Any',width:'Any'=16,height:'Any'=15) -> 'None': - """ + def SetButtonSize(self, width1: 'Any', height1: 'Any', width: 'Any' = 16, height: 'Any' = 15) -> 'None': + """ Set the size of the buttons to be added to a toolbar control. Args: @@ -47121,14 +44807,13 @@ Args: Returns: None - - """ - pass + """ + pass - def SetCmdID(self,nIndex:'Any',nID:'Any') -> 'None': - """ - Set the command identifier which will be sent to the owner window when the + def SetCmdID(self, nIndex: 'Any', nID: 'Any') -> 'None': + """ + Set the command identifier which will be sent to the owner window when the specified button is pressed. @@ -47140,14 +44825,13 @@ Args: Returns: None - - """ - pass + """ + pass - def SetRows(self,nRows:'Any',bLarger:'Any') -> 'Tuple[Any, Any, Any, Any]': - """ - Ask the toolbar control to resize itself to the requested + def SetRows(self, nRows: 'Any', bLarger: 'Any') -> 'Tuple[Any, Any, Any, Any]': + """ + Ask the toolbar control to resize itself to the requested number of rows. @@ -47159,20 +44843,19 @@ Args: Returns: Tuple[Any, Any, Any, Any] - - """ - pass + """ + pass -class PyCToolTipCtrl(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCToolTipCtrl(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def CreateWindow(self,parent:'Any',style:'Any') -> 'None': - """ + def CreateWindow(self, parent: 'Any', style: 'Any') -> 'None': + """ Creates the actual control. Args: @@ -47183,13 +44866,12 @@ Args: Returns: None - - """ - pass + """ + pass - def UpdateTipText(self,text:'str',wnd:'Any',_id:'Any') -> 'None': - """ + def UpdateTipText(self, text: 'str', wnd: 'Any', _id: 'Any') -> 'None': + """ Update the tool tip text for a control's tools Args: @@ -47201,13 +44883,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AddTool(self,wnd:'Any',text:'str',_id:'Any',rect:'Tuple[Any, Any, Any, Any]'=None) -> 'None': - """ + def AddTool(self, wnd: 'Any', text: 'str', _id: 'Any', rect: 'Tuple[Any, Any, Any, Any]' = None) -> 'None': + """ Adds a tool to tooltip control. Args: @@ -47220,13 +44901,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetMaxTipWidth(self,width:'Any') -> 'Any': - """ + def SetMaxTipWidth(self, width: 'Any') -> 'Any': + """ None Args: @@ -47236,20 +44916,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyCTreeCtrl(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCTreeCtrl(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def CreateWindow(self,style:'Any',rect:'Tuple[Any, Any, Any, Any]',PyCWnd:'Any',_id:'Any') -> 'None': - """ + def CreateWindow(self, style: 'Any', rect: 'Tuple[Any, Any, Any, Any]', PyCWnd: 'Any', _id: 'Any') -> 'None': + """ Creates the actual window for the object. Args: @@ -47262,13 +44941,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetCount(self,) -> 'Any': - """ + def GetCount(self,) -> 'Any': + """ Retrieves the number of tree items associated with a tree view control. Args: @@ -47278,13 +44956,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetIndent(self,) -> 'Any': - """ + def GetIndent(self,) -> 'Any': + """ Retrieves the offset (in pixels) of a tree view item from its parent. Args: @@ -47294,13 +44971,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetIndent(self,indent:'Any') -> 'None': - """ + def SetIndent(self, indent: 'Any') -> 'None': + """ Sets the offset (in pixels) of a tree view item from its parent. Args: @@ -47310,13 +44986,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetImageList(self,nImageList:'Any') -> 'Any': - """ + def GetImageList(self, nImageList: 'Any') -> 'Any': + """ Retrieves the current image list. Args: @@ -47326,13 +45001,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetImageList(self,imageList:'Any',imageType:'Any') -> 'Any': - """ + def SetImageList(self, imageList: 'Any', imageType: 'Any') -> 'Any': + """ Assigns an image list to a list view control. Args: @@ -47343,13 +45017,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetNextItem(self,item:'Any',code:'Any') -> 'Any': - """ + def GetNextItem(self, item: 'Any', code: 'Any') -> 'Any': + """ Retrieves the next item. Args: @@ -47360,13 +45033,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def ItemHasChildren(self,item:'Any') -> 'Any': - """ + def ItemHasChildren(self, item: 'Any') -> 'Any': + """ Returns nonzero if the specified item has child items. Args: @@ -47376,13 +45048,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetChildItem(self,item:'Any') -> 'Any': - """ + def GetChildItem(self, item: 'Any') -> 'Any': + """ Retrieves the first child item. Args: @@ -47392,13 +45063,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetNextSiblingItem(self,item:'Any') -> 'Any': - """ + def GetNextSiblingItem(self, item: 'Any') -> 'Any': + """ Retrieves the next sibling of the specified tree view item. Args: @@ -47408,13 +45078,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetPrevSiblingItem(self,item:'Any') -> 'Any': - """ + def GetPrevSiblingItem(self, item: 'Any') -> 'Any': + """ Retrieves the previous sibling of the specified tree view item. Args: @@ -47424,13 +45093,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetParentItem(self,item:'Any') -> 'Any': - """ + def GetParentItem(self, item: 'Any') -> 'Any': + """ Retrieves the parent item of the specified tree view item. Args: @@ -47440,13 +45108,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetFirstVisibleItem(self,) -> 'Any': - """ + def GetFirstVisibleItem(self,) -> 'Any': + """ Retrieves the first visible item of the tree view control. Args: @@ -47456,13 +45123,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetNextVisibleItem(self,item:'Any') -> 'Any': - """ + def GetNextVisibleItem(self, item: 'Any') -> 'Any': + """ Retrieves the next visible item of the specified tree view item. Args: @@ -47472,13 +45138,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetSelectedItem(self,) -> 'Any': - """ + def GetSelectedItem(self,) -> 'Any': + """ Retrieves the currently selected tree view item. Args: @@ -47488,13 +45153,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetDropHilightItem(self,) -> 'Any': - """ + def GetDropHilightItem(self,) -> 'Any': + """ Retrieves the target of a drag-and-drop operation. Args: @@ -47504,13 +45168,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetRootItem(self,) -> 'Any': - """ + def GetRootItem(self,) -> 'Any': + """ Retrieves the root of the specified tree view item. Args: @@ -47520,13 +45183,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetToolTips(self,) -> 'Any': - """ + def GetToolTips(self,) -> 'Any': + """ Returns the tooltip control Args: @@ -47536,13 +45198,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetItem(self,item:'Any',arg:'Any') -> 'Any': - """ + def GetItem(self, item: 'Any', arg: 'Any') -> 'Any': + """ Retrieves the details of an items attributes. Args: @@ -47553,13 +45214,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetItem(self,item:'Any') -> 'Any': - """ + def SetItem(self, item: 'Any') -> 'Any': + """ Sets some of all of an items attributes. Args: @@ -47569,13 +45229,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetItemState(self,item:'Any',stateMask:'Any') -> 'Tuple[Any, Any]': - """ + def GetItemState(self, item: 'Any', stateMask: 'Any') -> 'Tuple[Any, Any]': + """ Retrieves the state and mask of an item. Args: @@ -47586,13 +45245,12 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def SetItemState(self,item:'Any',state:'Any',stateMask:'Any') -> 'None': - """ + def SetItemState(self, item: 'Any', state: 'Any', stateMask: 'Any') -> 'None': + """ Sets the state of item. Args: @@ -47604,13 +45262,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetItemImage(self,item:'Any') -> 'Tuple[Any, Any]': - """ + def GetItemImage(self, item: 'Any') -> 'Tuple[Any, Any]': + """ Retrieves the index of an items images. Args: @@ -47620,13 +45277,12 @@ Args: Returns: Tuple[Any, Any] - - """ - pass + """ + pass - def SetItemImage(self,item:'Any',iImage:'Any',iSelectedImage:'Any') -> 'None': - """ + def SetItemImage(self, item: 'Any', iImage: 'Any', iSelectedImage: 'Any') -> 'None': + """ Sets the index of an items images. Args: @@ -47638,13 +45294,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetItemText(self,item:'Any',text:'str') -> 'Any': - """ + def SetItemText(self, item: 'Any', text: 'str') -> 'Any': + """ Changes the text of a list view item or subitem. Args: @@ -47655,13 +45310,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetItemText(self,item:'Any') -> 'Any': - """ + def GetItemText(self, item: 'Any') -> 'Any': + """ Retrieves the text of a list view item or subitem. Args: @@ -47671,13 +45325,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetItemData(self,item:'Any') -> 'Any': - """ + def GetItemData(self, item: 'Any') -> 'Any': + """ Retrieves the application-specific value associated with an item. Args: @@ -47687,13 +45340,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetItemData(self,item:'Any',Data:'Any') -> 'Any': - """ + def SetItemData(self, item: 'Any', Data: 'Any') -> 'Any': + """ Sets the item's application-specific value. Args: @@ -47704,13 +45356,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetItemRect(self,item:'Any',bTextOnly:'Any') -> 'Tuple[Any, Any, Any, Any]': - """ + def GetItemRect(self, item: 'Any', bTextOnly: 'Any') -> 'Tuple[Any, Any, Any, Any]': + """ Retrieves the bounding rectangle of a tree view item. Args: @@ -47721,14 +45372,13 @@ Args: Returns: Tuple[Any, Any, Any, Any] - - """ - pass + """ + pass - def GetEditControl(self,) -> 'Any': - """ - Retrieves the handle of the edit control used to edit the specified + def GetEditControl(self,) -> 'Any': + """ + Retrieves the handle of the edit control used to edit the specified tree view item. @@ -47739,14 +45389,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetVisibleCount(self,) -> 'Any': - """ - Retrieves the number of visible tree items associated with a tree view + def GetVisibleCount(self,) -> 'Any': + """ + Retrieves the number of visible tree items associated with a tree view control. @@ -47757,13 +45406,33 @@ Args: Returns: Any - - """ - pass + """ + pass - def InsertItem(self,hParent:'Any',hInsertAfter:'Any',item:'Any',mask:'Any',text:'Any',image:'Any',selectedImage:'Any',state:'Any',stateMask:'Any',lParam:'Any',parent:'Any',parent1:'Any',text1:'Any',image1:'Any',selectedImage1:'Any',parent2:'Any',insertAfter:'Any',text2:'Any',parent3:'Any',parent4:'Any') -> 'Any': - """ + def InsertItem( + self, + hParent: 'Any', + hInsertAfter: 'Any', + item: 'Any', + mask: 'Any', + text: 'Any', + image: 'Any', + selectedImage: 'Any', + state: 'Any', + stateMask: 'Any', + lParam: 'Any', + parent: 'Any', + parent1: 'Any', + text1: 'Any', + image1: 'Any', + selectedImage1: 'Any', + parent2: 'Any', + insertAfter: 'Any', + text2: 'Any', + parent3: 'Any', + parent4: 'Any') -> 'Any': + """ Inserts an item into the list. Args: @@ -47792,13 +45461,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def DeleteItem(self,item:'Any') -> 'None': - """ + def DeleteItem(self, item: 'Any') -> 'None': + """ Deletes the specified item. Args: @@ -47808,13 +45476,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DeleteAllItems(self,) -> 'Any': - """ + def DeleteAllItems(self,) -> 'Any': + """ Deletes all items in the control Args: @@ -47824,13 +45491,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Expand(self,item:'Any',code:'Any') -> 'None': - """ + def Expand(self, item: 'Any', code: 'Any') -> 'None': + """ Expands, or collapses, the child items of the specified tree view item. Args: @@ -47841,13 +45507,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Select(self,item:'Any',code:'Any') -> 'None': - """ + def Select(self, item: 'Any', code: 'Any') -> 'None': + """ Selects, scrolls into view, or redraws a specified tree view item. Args: @@ -47858,13 +45523,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SelectItem(self,item:'Any') -> 'None': - """ + def SelectItem(self, item: 'Any') -> 'None': + """ Selects a specified tree view item. Args: @@ -47874,13 +45538,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SelectDropTarget(self,item:'Any') -> 'None': - """ + def SelectDropTarget(self, item: 'Any') -> 'None': + """ Redraws the tree item as the target of a drag-and-drop operation. Args: @@ -47890,13 +45553,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SelectSetFirstVisible(self,item:'Any') -> 'None': - """ + def SelectSetFirstVisible(self, item: 'Any') -> 'None': + """ Selects a specified tree view item as the first visible item. Args: @@ -47906,13 +45568,12 @@ Args: Returns: None - - """ - pass + """ + pass - def EditLabel(self,item:'Any') -> 'Any': - """ + def EditLabel(self, item: 'Any') -> 'Any': + """ Edits a specified tree view item in-place. Args: @@ -47922,13 +45583,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def CreateDragImage(self,item:'Any') -> 'Any': - """ + def CreateDragImage(self, item: 'Any') -> 'Any': + """ Creates a dragging bitmap for the specified tree view item. Args: @@ -47938,13 +45598,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SortChildren(self,item:'Any') -> 'None': - """ + def SortChildren(self, item: 'Any') -> 'None': + """ Sorts the children of a given parent item. Args: @@ -47954,13 +45613,12 @@ Args: Returns: None - - """ - pass + """ + pass - def EnsureVisible(self,item:'Any') -> 'Any': - """ + def EnsureVisible(self, item: 'Any') -> 'Any': + """ Ensures that a tree view item is visible in its tree view control. Args: @@ -47970,13 +45628,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def HitTest(self,arg:'Any') -> 'Tuple[Any, Any]': - """ + def HitTest(self, arg: 'Any') -> 'Tuple[Any, Any]': + """ Determines which tree view item, if any, is at a specified position. Args: @@ -47985,7 +45642,7 @@ Args: Returns: - Tuple[Any, Any]:The point to test.Return ValueThe result is a tuple of (flags, hItem). + Tuple[Any, Any]:The point to test.Return ValueThe result is a tuple of (flags, hItem). flags may be a combination of the following values: @@ -48011,20 +45668,19 @@ 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 + """ + pass -class PyCTreeView(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCTreeView(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def PreCreateWindow(self,createStruct:'Any') -> 'Any': - """ + def PreCreateWindow(self, createStruct: 'Any') -> 'Any': + """ Calls the underlying MFC PreCreateWindow method. Args: @@ -48034,13 +45690,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetTreeCtrl(self,) -> 'Any': - """ + def GetTreeCtrl(self,) -> 'Any': + """ Returns the underlying tree control object. Args: @@ -48050,13 +45705,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OnCommand(self,wparam:'Any',lparam:'Any') -> 'None': - """ + def OnCommand(self, wparam: 'Any', lparam: 'Any') -> 'None': + """ Calls the standard Python framework OnCommand handler Args: @@ -48067,20 +45721,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyCView(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCView(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def CreateWindow(self,parent:'Any',arg:'Any',arg1:'Any',arg2:'Tuple[Any, Any, Any, Any]') -> 'None': - """ + def CreateWindow(self, parent: 'Any', arg: 'Any', arg1: 'Any', arg2: 'Tuple[Any, Any, Any, Any]') -> 'None': + """ Creates the window for a view. Args: @@ -48093,13 +45746,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetDocument(self,) -> 'Any': - """ + def GetDocument(self,) -> 'Any': + """ Returns the document for a view. Args: @@ -48109,13 +45761,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OnActivateView(self,activate:'Any',activateView:'Any',DeactivateView:'Any') -> 'Any': - """ + def OnActivateView(self, activate: 'Any', activateView: 'Any', DeactivateView: 'Any') -> 'Any': + """ Calls the underlying MFC OnActivateView method. Args: @@ -48127,13 +45778,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OnInitialUpdate(self,) -> 'None': - """ + def OnInitialUpdate(self,) -> 'None': + """ Calls the underlying MFC OnInitialUpdate method. Args: @@ -48143,13 +45793,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnMouseActivate(self,wnd:'Any',hittest:'Any',message:'Any') -> 'Any': - """ + def OnMouseActivate(self, wnd: 'Any', hittest: 'Any', message: 'Any') -> 'Any': + """ Calls the base MFC OnMouseActivate function. Args: @@ -48161,13 +45810,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def PreCreateWindow(self,createStruct:'Any') -> 'Any': - """ + def PreCreateWindow(self, createStruct: 'Any') -> 'Any': + """ Calls the underlying MFC PreCreateWindow method. Args: @@ -48177,13 +45825,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OnFilePrint(self,) -> 'None': - """ + def OnFilePrint(self,) -> 'None': + """ Calls the underlying MFC OnFilePrint method. Args: @@ -48193,13 +45840,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DoPreparePrinting(self,) -> 'Any': - """ + def DoPreparePrinting(self,) -> 'Any': + """ Invoke the Print dialog box and create a printer device context. Args: @@ -48209,13 +45855,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OnBeginPrinting(self,) -> 'None': - """ + def OnBeginPrinting(self,) -> 'None': + """ Calls the underlying MFC OnBeginPrinting method. Args: @@ -48225,13 +45870,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnEndPrinting(self,) -> 'None': - """ + def OnEndPrinting(self,) -> 'None': + """ Calls the underlying MFC OnEndPrinting method. Args: @@ -48241,20 +45885,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyCWinApp(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCWinApp(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def AddDocTemplate(self,template:'Any') -> 'None': - """ + def AddDocTemplate(self, template: 'Any') -> 'None': + """ Adds a template to the application list. Args: @@ -48264,13 +45907,12 @@ Args: Returns: None - - """ - pass + """ + pass - def FindOpenDocument(self,fileName:'str') -> 'Any': - """ + def FindOpenDocument(self, fileName: 'str') -> 'Any': + """ Returns an existing document with the specified file name. Args: @@ -48280,13 +45922,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetDocTemplateList(self,) -> 'List[Any]': - """ + def GetDocTemplateList(self,) -> 'List[Any]': + """ Returns a list of all document templates. Args: @@ -48296,13 +45937,12 @@ Args: Returns: List[Any] - - """ - pass + """ + pass - def InitDlgInstance(self,dialog:'Any') -> 'None': - """ + def InitDlgInstance(self, dialog: 'Any') -> 'None': + """ Calls critical InitInstance processing for a dialog based application. Args: @@ -48312,13 +45952,12 @@ Args: Returns: None - - """ - pass + """ + pass - def LoadCursor(self,cursorId:'PyResourceId') -> 'Any': - """ + def LoadCursor(self, cursorId: 'PyResourceId') -> 'Any': + """ Loads a cursor. Args: @@ -48328,13 +45967,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def LoadStandardCursor(self,cursorId:'PyResourceId') -> 'Any': - """ + def LoadStandardCursor(self, cursorId: 'PyResourceId') -> 'Any': + """ Loads a standard cursor. Args: @@ -48344,13 +45982,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def LoadOEMCursor(self,cursorId:'Any') -> 'Any': - """ + def LoadOEMCursor(self, cursorId: 'Any') -> 'Any': + """ Loads an OEM cursor. Args: @@ -48360,13 +45997,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def LoadIcon(self,idResource:'Any') -> 'Any': - """ + def LoadIcon(self, idResource: 'Any') -> 'Any': + """ Loads an icon resource. Args: @@ -48376,13 +46012,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def LoadStandardIcon(self,resourceName:'PyResourceId') -> 'Any': - """ + def LoadStandardIcon(self, resourceName: 'PyResourceId') -> 'Any': + """ Loads an icon resource. Args: @@ -48392,13 +46027,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OpenDocumentFile(self,fileName:'str') -> 'None': - """ + def OpenDocumentFile(self, fileName: 'str') -> 'None': + """ Opens a document file by name. Args: @@ -48408,13 +46042,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnFileNew(self,) -> 'None': - """ + def OnFileNew(self,) -> 'None': + """ Calls the underlying OnFileNew MFC method. Args: @@ -48424,13 +46057,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnFileOpen(self,) -> 'None': - """ + def OnFileOpen(self,) -> 'None': + """ Calls the underlying OnFileOpen MFC method. Args: @@ -48440,13 +46072,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RemoveDocTemplate(self,template:'Any') -> 'None': - """ + def RemoveDocTemplate(self, template: 'Any') -> 'None': + """ Removes a template to the application list. Args: @@ -48456,13 +46087,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Run(self,) -> 'Any': - """ + def Run(self,) -> 'Any': + """ Starts the message pump. Advanced users only Args: @@ -48472,14 +46102,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def IsInproc(self,) -> 'Any': - """ - Returns a flag to indicate if the created CWinApp was in the DLL, or an external + def IsInproc(self,) -> 'Any': + """ + Returns a flag to indicate if the created CWinApp was in the DLL, or an external EXE. @@ -48490,20 +46119,19 @@ Args: Returns: Any - - """ - pass + """ + pass -class PyCWinThread(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCWinThread(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def CreateThread(self,) -> 'None': - """ + def CreateThread(self,) -> 'None': + """ Creates the actual thread behind the thread object. Args: @@ -48513,13 +46141,12 @@ Args: Returns: None - - """ - pass + """ + pass - def PumpIdle(self,) -> 'None': - """ + def PumpIdle(self,) -> 'None': + """ Pumps all idle messages. Args: @@ -48529,13 +46156,12 @@ Args: Returns: None - - """ - pass + """ + pass - def PumpMessages(self,) -> 'None': - """ + def PumpMessages(self,) -> 'None': + """ Pumps all messages to the application until a WM_QUIT message is received. Args: @@ -48545,13 +46171,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Run(self,) -> 'Any': - """ + def Run(self,) -> 'Any': + """ Starts the message pump. Advanced users only Args: @@ -48561,13 +46186,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetMainFrame(self,mainFrame:'Any') -> 'None': - """ + def SetMainFrame(self, mainFrame: 'Any') -> 'None': + """ Sets the threads main frame Args: @@ -48577,13 +46201,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetThreadPriority(self,priority:'Any') -> 'None': - """ + def SetThreadPriority(self, priority: 'Any') -> 'None': + """ Sets the threads priority. Returns TRUE if successful. Args: @@ -48593,21 +46216,20 @@ Args: Returns: None - - """ - pass + """ + pass -class PyCWnd(object): - """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyCWnd(object): + """""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def ActivateFrame(self,cmdShow:'Any') -> 'None': - """ - Searches upwards for a parent window which has + def ActivateFrame(self, cmdShow: 'Any') -> 'None': + """ + Searches upwards for a parent window which has a frame, and activates it. @@ -48618,13 +46240,12 @@ Args: Returns: None - - """ - pass + """ + pass - def BringWindowToTop(self,) -> 'None': - """ + def BringWindowToTop(self,) -> 'None': + """ Brings the window to the top of a stack of overlapping windows. Args: @@ -48634,13 +46255,12 @@ Args: Returns: None - - """ - pass + """ + pass - def BeginPaint(self,) -> 'Tuple[Any, Any]': - """ + def BeginPaint(self,) -> 'Tuple[Any, Any]': + """ Prepares a window for painting Args: @@ -48655,16 +46275,15 @@ PyCDC, PAINTSTRUCT = BeginPaint()Prepares a window for painting Return ValueYou must pass the PAINTSTRUCT param to the PyCWnd::EndPaint method. - - """ - pass + """ + pass - def CalcWindowRect(self,rect:'Tuple[Any, Any, Any, Any]',nAdjustType:'Any') -> 'Tuple[Any, Any, Any, Any]': - """ - Computes the size of the window rectangle based on the desired client + def CalcWindowRect(self, rect: 'Tuple[Any, Any, Any, Any]', nAdjustType: 'Any') -> 'Tuple[Any, Any, Any, Any]': + """ + 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,13 +46295,12 @@ Args: Returns: Tuple[Any, Any, Any, Any] - - """ - pass + """ + pass - def CenterWindow(self,altwin:'Any'=None) -> 'None': - """ + def CenterWindow(self, altwin: 'Any' = None) -> 'None': + """ Centers a window relative to its parent. Args: @@ -48692,14 +46310,13 @@ Args: Returns: None - - """ - pass + """ + pass - def CheckRadioButton(self,idFirst:'Any',idLast:'Any',idCheck:'Any') -> 'None': - """ - Selects the specified radio button, and clears + def CheckRadioButton(self, idFirst: 'Any', idLast: 'Any', idCheck: 'Any') -> 'None': + """ + Selects the specified radio button, and clears all others in the group. @@ -48712,13 +46329,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ChildWindowFromPoint(self,x:'Any',y:'Any',flag:'Any'=0) -> 'Any': - """ + def ChildWindowFromPoint(self, x: 'Any', y: 'Any', flag: 'Any' = 0) -> 'Any': + """ Returns the child window that contains the point Args: @@ -48730,14 +46346,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def ClientToScreen(self,point:'Tuple[Any, Any]',rect:'Any') -> 'Tuple[Any, Any, Any, Any, Any]': - """ - Converts the client coordinates of a given point on the display + def ClientToScreen(self, point: 'Tuple[Any, Any]', rect: 'Any') -> 'Tuple[Any, Any, Any, Any, Any]': + """ + Converts the client coordinates of a given point on the display to screen coordinates. @@ -48749,13 +46364,20 @@ Args: Returns: Tuple[Any, Any, Any, Any, Any] - - """ - pass - - def CreateWindow(self,classId:'str',windowName:'str',style:'Any',rect:'Tuple[Any, Any, Any, Any]',parent:'Any',_id:'Any',context:'Any'=None) -> 'None': - """ + """ + pass + + def CreateWindow( + self, + classId: 'str', + windowName: 'str', + style: 'Any', + rect: 'Tuple[Any, Any, Any, Any]', + parent: 'Any', + _id: 'Any', + context: 'Any' = None) -> 'None': + """ Creates the actual window Args: @@ -48771,13 +46393,22 @@ Args: Returns: None - - """ - pass + """ + pass - def CreateWindowEx(self,styleEx:'Any',classId:'str',windowName:'str',style:'Any',rect:'Tuple[Any, Any, Any, Any]',parent:'Any',_id:'Any',createStruct1:'Any',createStruct:'Any'=None) -> 'None': - """ + def CreateWindowEx( + self, + styleEx: 'Any', + classId: 'str', + windowName: 'str', + style: 'Any', + rect: 'Tuple[Any, Any, Any, Any]', + parent: 'Any', + _id: 'Any', + createStruct1: 'Any', + createStruct: 'Any' = None) -> 'None': + """ Creates the actual window using extended capabilities. Args: @@ -48795,13 +46426,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DefWindowProc(self,message:'Any',idLast:'Any',idCheck:'Any') -> 'Any': - """ + def DefWindowProc(self, message: 'Any', idLast: 'Any', idCheck: 'Any') -> 'Any': + """ Calls the default message handler. Args: @@ -48813,13 +46443,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def DestroyWindow(self,) -> 'None': - """ + def DestroyWindow(self,) -> 'None': + """ Destroy the window attached to the object. Args: @@ -48829,18 +46458,17 @@ Args: Returns: None - - """ - pass + """ + pass - def DlgDirList(self,defPath:'str',idListbox:'Any',idStaticPath:'Any',fileType:'Any') -> 'None': - """ + def DlgDirList(self, defPath: 'str', idListbox: 'Any', idStaticPath: 'Any', fileType: 'Any') -> 'None': + """ Fill a list box with a file or directory listing. Args: - defPath(str):The file spec to fill the list box with + defPath(str):The file spec to fill the list box with idListbox(Any):The Id of the listbox control to fill. idStaticPath(Any):The Id of the static control used to display the current drive and directory. If idStaticPath is 0, it is assumed that no such control exists. fileType(Any):Specifies the attributes of the files to be displayed. It can be any combination of DDL_READWRITE, DDL_READONLY, DDL_HIDDEN, DDL_SYSTEM, DDL_DIRECTORY, DDL_ARCHIVE, DDL_POSTMSGS, DDL_DRIVES or DDL_EXCLUSIVEMFC References @@ -48848,13 +46476,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DlgDirListComboBox(self,) -> 'None': - """ + def DlgDirListComboBox(self,) -> 'None': + """ None Args: @@ -48864,13 +46491,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DlgDirSelect(self,idListbox:'Any') -> 'str': - """ + def DlgDirSelect(self, idListbox: 'Any') -> 'str': + """ None Args: @@ -48880,13 +46506,12 @@ Args: Returns: str - - """ - pass + """ + pass - def DlgDirSelectComboBox(self,idListbox:'Any') -> 'str': - """ + def DlgDirSelectComboBox(self, idListbox: 'Any') -> 'str': + """ None Args: @@ -48896,13 +46521,12 @@ Args: Returns: str - - """ - pass + """ + pass - def DragAcceptFiles(self,bAccept:'Any'=1) -> 'None': - """ + def DragAcceptFiles(self, bAccept: 'Any' = 1) -> 'None': + """ Indicates that the window and children supports files dropped from file manager Args: @@ -48912,13 +46536,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DrawMenuBar(self,) -> 'None': - """ + def DrawMenuBar(self,) -> 'None': + """ Redraws the menu bar. Can be called if the menu changes. Args: @@ -48928,13 +46551,12 @@ Args: Returns: None - - """ - pass + """ + pass - def EnableWindow(self,bEnable:'Any'=1) -> 'Any': - """ + def EnableWindow(self, bEnable: 'Any' = 1) -> 'Any': + """ Enables or disables the window. Typically used for dialog controls. Args: @@ -48946,13 +46568,12 @@ Returns: Any:CWnd::EnableWindow Return ValueReturns the state before the EnableWindow member function was called - - """ - pass + """ + pass - def EndModalLoop(self,result:'Any') -> 'None': - """ + def EndModalLoop(self, result: 'Any') -> 'None': + """ Ends a modal loop. Args: @@ -48962,13 +46583,12 @@ Args: Returns: None - - """ - pass + """ + pass - def EndPaint(self,paintStruct:'Any') -> 'None': - """ + def EndPaint(self, paintStruct: 'Any') -> 'None': + """ Ends painting Args: @@ -48978,13 +46598,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetCheckedRadioButton(self,idFirst:'Any',idLast:'Any') -> 'Any': - """ + def GetCheckedRadioButton(self, idFirst: 'Any', idLast: 'Any') -> 'Any': + """ Returns the ID of the checked radio button, or 0 if none is selected. Args: @@ -48995,14 +46614,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetClientRect(self,) -> 'Tuple[Any, Any, Any, Any]': - """ - Returns the client coordinates of the window. left and top + def GetClientRect(self,) -> 'Tuple[Any, Any, Any, Any]': + """ + Returns the client coordinates of the window. left and top will be zero. @@ -49013,13 +46631,12 @@ Args: Returns: Tuple[Any, Any, Any, Any] - - """ - pass + """ + pass - def GetDC(self,) -> 'Any': - """ + def GetDC(self,) -> 'Any': + """ Gets the windows current DC object. Args: @@ -49032,13 +46649,12 @@ Returns: PyCDC = GetDC()Gets the windows current DC object. Return ValueThe result is a PyCDC, or a win32ui.error exception is raised. - - """ - pass + """ + pass - def GetDCEx(self,) -> 'Any': - """ + def GetDCEx(self,) -> 'Any': + """ Gets the windows current DC object with extended caps. Args: @@ -49048,13 +46664,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetDlgCtrlID(self,) -> 'Any': - """ + def GetDlgCtrlID(self,) -> 'Any': + """ Returns the ID of this child window. Args: @@ -49064,13 +46679,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetDlgItem(self,idControl:'Any') -> 'Any': - """ + def GetDlgItem(self, idControl: 'Any') -> 'Any': + """ None Args: @@ -49082,13 +46696,12 @@ Returns: Any:CWnd::GetDlgItem Return ValueThe result is a PyCWnd (or derived) object, or a win32ui.error exception is raised. - - """ - pass + """ + pass - def GetDlgItemInt(self,idControl:'Any',bUnsigned:'Any'=1) -> 'Any': - """ + def GetDlgItemInt(self, idControl: 'Any', bUnsigned: 'Any' = 1) -> 'Any': + """ Returns the integer value of a child window or control with the specified ID. Args: @@ -49101,13 +46714,12 @@ Returns: Any:CWnd::GetDlgItemInt Return ValueIf the value can not be converted, a ValueError is raised. - - """ - pass + """ + pass - def GetDlgItemText(self,idControl:'Any') -> 'str': - """ + def GetDlgItemText(self, idControl: 'Any') -> 'str': + """ Returns the text of child window or control with the specified ID. Args: @@ -49117,13 +46729,12 @@ Args: Returns: str - - """ - pass + """ + pass - def GetLastActivePopup(self,) -> 'Any': - """ + def GetLastActivePopup(self,) -> 'Any': + """ Returns the last active popup Window, or the Window itself. Args: @@ -49135,13 +46746,12 @@ Returns: Any:CWnd::GetLastActivePopup Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - """ - pass + """ + pass - def GetMenu(self,) -> 'Any': - """ + def GetMenu(self,) -> 'Any': + """ Returns the menu object for the window's menu. Args: @@ -49155,13 +46765,12 @@ Return ValueThe result is a PyMenu object, or an exception is thrown. - - """ - pass + """ + pass - def GetParent(self,) -> 'Any': - """ + def GetParent(self,) -> 'Any': + """ Returns the window's parent. Args: @@ -49173,13 +46782,12 @@ Returns: Any:CWnd::GetParent Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - """ - pass + """ + pass - def GetParentFrame(self,) -> 'Any': - """ + def GetParentFrame(self,) -> 'Any': + """ Returns the window's frame. Args: @@ -49191,13 +46799,12 @@ Returns: Any:CWnd::GetParentFrame Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - """ - pass + """ + pass - def GetSafeHwnd(self,) -> 'Any': - """ + def GetSafeHwnd(self,) -> 'Any': + """ Returns the HWnd of this window. Args: @@ -49207,13 +46814,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetScrollInfo(self,nBar:'Any',mask:'Any') -> 'Any': - """ + def GetScrollInfo(self, nBar: 'Any', mask: 'Any') -> 'Any': + """ Returns information about a scroll bar Args: @@ -49224,13 +46830,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetScrollPos(self,nBar:'Any') -> 'Any': - """ + def GetScrollPos(self, nBar: 'Any') -> 'Any': + """ Retrieves the current position of the scroll box of a scroll bar. Args: @@ -49240,13 +46845,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetStyle(self,) -> 'Any': - """ + def GetStyle(self,) -> 'Any': + """ Retrieves the window style Args: @@ -49256,13 +46860,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetExStyle(self,) -> 'Any': - """ + def GetExStyle(self,) -> 'Any': + """ Retrieves the window's extended style Args: @@ -49272,13 +46875,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetSystemMenu(self,) -> 'Any': - """ + def GetSystemMenu(self,) -> 'Any': + """ Returns the menu object for the window's system menu. Args: @@ -49288,13 +46890,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetTopLevelFrame(self,) -> 'Any': - """ + def GetTopLevelFrame(self,) -> 'Any': + """ Returns the top-level frame of the window. Args: @@ -49306,13 +46907,12 @@ Returns: Any:CWnd::GetTopLevelFrame Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - """ - pass + """ + pass - def GetTopLevelOwner(self,) -> 'Any': - """ + def GetTopLevelOwner(self,) -> 'Any': + """ Returns the top-level owner of the window. Args: @@ -49324,13 +46924,12 @@ Returns: Any:CWnd::GetTopLevelOwner Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - """ - pass + """ + pass - def GetTopLevelParent(self,) -> 'Any': - """ + def GetTopLevelParent(self,) -> 'Any': + """ Returns the top-level parent of the window. Args: @@ -49342,13 +46941,12 @@ Returns: Any:CWnd::GetTopLevelParent Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - """ - pass + """ + pass - def GetTopWindow(self,) -> 'Any': - """ + def GetTopWindow(self,) -> 'Any': + """ Identifies the top-level child window in a linked list of child windows. Args: @@ -49360,13 +46958,12 @@ Returns: Any:CWnd::GetTopWindow Return ValueIf no child windows exist, the value is None. - - """ - pass + """ + pass - def GetWindow(self,_type:'Any') -> 'Any': - """ + def GetWindow(self, _type: 'Any') -> 'Any': + """ Returns a window, with the specified relationship to this window. Args: @@ -49378,13 +46975,12 @@ Returns: Any:CWnd::GetWindow Return ValueThe result is a PyCWnd or None if no Window can be found. - - """ - pass + """ + pass - def GetWindowDC(self,) -> 'Any': - """ + def GetWindowDC(self,) -> 'Any': + """ Gets the windows current DC object. Args: @@ -49394,13 +46990,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetWindowPlacement(self,) -> 'Any': - """ + def GetWindowPlacement(self,) -> 'Any': + """ Returns placement information about the current window. Args: @@ -49410,7 +47005,7 @@ Args: Returns: 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 +47024,13 @@ 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 + """ + pass - def GetWindowRect(self,) -> 'Tuple[Any, Any, Any, Any]': - """ - Returns the screen coordinates of the windows upper left + def GetWindowRect(self,) -> 'Tuple[Any, Any, Any, Any]': + """ + Returns the screen coordinates of the windows upper left corner @@ -49447,13 +47041,12 @@ Args: Returns: Tuple[Any, Any, Any, Any] - - """ - pass + """ + pass - def GetWindowText(self,) -> 'str': - """ + def GetWindowText(self,) -> 'str': + """ Returns the windows text. Args: @@ -49463,13 +47056,12 @@ Args: Returns: str - - """ - pass + """ + pass - def HideCaret(self,) -> 'None': - """ + def HideCaret(self,) -> 'None': + """ Hides the caret Args: @@ -49479,13 +47071,12 @@ Args: Returns: None - - """ - pass + """ + pass - def HookAllKeyStrokes(self,obHandler:'Any') -> 'None': - """ + def HookAllKeyStrokes(self, obHandler: 'Any') -> 'None': + """ Hook a key stroke handler for all key strokes. Args: @@ -49495,13 +47086,12 @@ Args: Returns: None - - """ - pass + """ + pass - def HookKeyStroke(self,obHandler:'Any',ch:'Any') -> 'Any': - """ + def HookKeyStroke(self, obHandler: 'Any', ch: 'Any') -> 'Any': + """ Hook a key stroke handler Args: @@ -49511,32 +47101,31 @@ Args: Returns: - Any:The ID for the keystroke to be handled. + 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 + """ + pass - def HookMessage(self,obHandler:'Any',message:'Any') -> 'Any': - """ + def HookMessage(self, obHandler: 'Any', message: 'Any') -> 'Any': + """ Hook a message notification handler Args: @@ -49548,15 +47137,15 @@ Returns: 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,13 +47162,12 @@ 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 + """ + pass - def InvalidateRect(self,arg:'Tuple[Any, Any, Any, Any]',bErase:'Any'=1) -> 'None': - """ + def InvalidateRect(self, arg: 'Tuple[Any, Any, Any, Any]', bErase: 'Any' = 1) -> 'None': + """ Invalidates an area of a window. Args: @@ -49590,13 +47178,12 @@ Args: Returns: None - - """ - pass + """ + pass - def InvalidateRgn(self,region:'Any',bErase:'Any'=1) -> 'None': - """ + def InvalidateRgn(self, region: 'Any', bErase: 'Any' = 1) -> 'None': + """ Invalidates a region of the window Args: @@ -49607,13 +47194,12 @@ Args: Returns: None - - """ - pass + """ + pass - def IsChild(self,obWnd:'Any') -> 'Any': - """ + def IsChild(self, obWnd: 'Any') -> 'Any': + """ Determines if a given window is a child of this window. Args: @@ -49623,13 +47209,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def IsDlgButtonChecked(self,idCtl:'Any') -> 'Any': - """ + def IsDlgButtonChecked(self, idCtl: 'Any') -> 'Any': + """ Determines if a dialog button is checked. Args: @@ -49639,13 +47224,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def IsIconic(self,) -> 'Any': - """ + def IsIconic(self,) -> 'Any': + """ Determines if the window is currently displayed as an icon. Args: @@ -49655,13 +47239,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def IsZoomed(self,) -> 'Any': - """ + def IsZoomed(self,) -> 'Any': + """ Determines if the window is currently maximised. Args: @@ -49671,13 +47254,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def IsWindow(self,) -> 'Any': - """ + def IsWindow(self,) -> 'Any': + """ determines whether the specified window handle identifies an existing window Args: @@ -49687,13 +47269,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def IsWindowVisible(self,) -> 'Any': - """ + def IsWindowVisible(self,) -> 'Any': + """ Determines if the window is currently visible. Args: @@ -49703,13 +47284,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def KillTimer(self,) -> 'Any': - """ + def KillTimer(self,) -> 'Any': + """ Kills a system timer Args: @@ -49719,13 +47299,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def LockWindowUpdate(self,) -> 'None': - """ + def LockWindowUpdate(self,) -> 'None': + """ Disables drawing in the given window Args: @@ -49735,14 +47314,13 @@ Args: Returns: None - - """ - pass + """ + pass - def MapWindowPoints(self,wnd:'Any',points:'List[Any]') -> 'None': - """ - Converts (maps) a set of points from the coordinate space of a window to the + def MapWindowPoints(self, wnd: 'Any', points: 'List[Any]') -> 'None': + """ + Converts (maps) a set of points from the coordinate space of a window to the coordinate space of another window. @@ -49753,17 +47331,16 @@ 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 + """ + pass - def MouseCaptured(self,) -> 'Any': - """ + def MouseCaptured(self,) -> 'Any': + """ Returns 1 if the window has the mouse capture, else 0 Args: @@ -49773,13 +47350,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def MessageBox(self,message:'str',arg:'Any',title:'Union[Any, str]'=None) -> 'None': - """ + def MessageBox(self, message: 'str', arg: 'Any', title: 'Union[Any, str]' = None) -> 'None': + """ Display a message box. Args: @@ -49793,13 +47369,12 @@ Returns: None:CWnd::MessageBox Return ValueAn integer identifying the button pressed to dismiss the dialog. - - """ - pass + """ + pass - def ModifyStyle(self,remove:'Any',add:'Any',flags:'Any'=0) -> 'Any': - """ + def ModifyStyle(self, remove: 'Any', add: 'Any', flags: 'Any' = 0) -> 'Any': + """ Modifies the style of a window. Args: @@ -49811,17 +47386,16 @@ Args: Returns: 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 + """ + pass - def ModifyStyleEx(self,remove:'Any',add:'Any',flags:'Any'=0) -> 'Any': - """ + def ModifyStyleEx(self, remove: 'Any', add: 'Any', flags: 'Any' = 0) -> 'Any': + """ Modifies the extended style of a window. Args: @@ -49833,17 +47407,16 @@ Args: Returns: 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 + """ + pass - def MoveWindow(self,rect:'Tuple[Any, Any, Any, Any]',bRepaint:'Any'=1) -> 'None': - """ + def MoveWindow(self, rect: 'Tuple[Any, Any, Any, Any]', bRepaint: 'Any' = 1) -> 'None': + """ Move a window to a new location. Args: @@ -49854,13 +47427,12 @@ Args: Returns: None - - """ - pass + """ + pass - def OnClose(self,) -> 'Any': - """ + def OnClose(self,) -> 'Any': + """ Calls the default MFC OnClose handler. Args: @@ -49870,13 +47442,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OnCtlColor(self,dc:'Any',control:'Any',_type:'Any') -> 'Any': - """ + def OnCtlColor(self, dc: 'Any', control: 'Any', _type: 'Any') -> 'Any': + """ Calls the default MFC OnCtlColor handler. Args: @@ -49888,13 +47459,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OnEraseBkgnd(self,dc:'Any') -> 'Any': - """ + def OnEraseBkgnd(self, dc: 'Any') -> 'Any': + """ Calls the default MFC OnEraseBkgnd handler. Args: @@ -49904,13 +47474,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OnNcHitTest(self,arg:'Tuple[Any, Any]') -> 'Any': - """ + def OnNcHitTest(self, arg: 'Tuple[Any, Any]') -> 'Any': + """ Calls the base MFC OnNcHitTest function. Args: @@ -49920,13 +47489,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OnPaint(self,) -> 'Any': - """ + def OnPaint(self,) -> 'Any': + """ Calls the default MFC OnPaint handler. Args: @@ -49936,13 +47504,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OnQueryDragIcon(self,) -> 'Any': - """ + def OnQueryDragIcon(self,) -> 'Any': + """ Calls the default MFC OnQueryDragIcon handler. Args: @@ -49952,13 +47519,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OnQueryNewPalette(self,) -> 'Any': - """ + def OnQueryNewPalette(self,) -> 'Any': + """ Calls the underlying MFC OnQueryNewPalette method. Args: @@ -49968,13 +47534,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OnSetCursor(self,wnd:'Any',hittest:'Any',message:'Any') -> 'Any': - """ + def OnSetCursor(self, wnd: 'Any', hittest: 'Any', message: 'Any') -> 'Any': + """ Calls the base MFC OnSetCursor function. Args: @@ -49986,13 +47551,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OnMouseActivate(self,wnd:'Any',hittest:'Any',message:'Any') -> 'Any': - """ + def OnMouseActivate(self, wnd: 'Any', hittest: 'Any', message: 'Any') -> 'Any': + """ Calls the base MFC OnMouseActivate function. Args: @@ -50004,13 +47568,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def OnWndMsg(self,msg:'Any',wParam:'Any',lParam:'Any') -> 'Tuple[Any, Any]': - """ + def OnWndMsg(self, msg: 'Any', wParam: 'Any', lParam: 'Any') -> 'Tuple[Any, Any]': + """ Calls the default MFC Window Message handler. Args: @@ -50022,19 +47585,18 @@ Args: Returns: Tuple[Any, 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 + """ + pass - def PreCreateWindow(self,createStruct:'Any') -> 'Any': - """ + def PreCreateWindow(self, createStruct: 'Any') -> 'Any': + """ Calls the underlying MFC PreCreateWindow method. Args: @@ -50044,13 +47606,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def PumpWaitingMessages(self,firstMsg:'Any',lastMsg:'Any') -> 'None': - """ + def PumpWaitingMessages(self, firstMsg: 'Any', lastMsg: 'Any') -> 'None': + """ Pump messages associate with a window. Args: @@ -50061,13 +47622,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RedrawWindow(self,_object:'Any',flags:'Any',rect:'Tuple[Any, Any, Any, Any]'=None) -> 'None': - """ + def RedrawWindow(self, _object: 'Any', flags: 'Any', rect: 'Tuple[Any, Any, Any, Any]' = None) -> 'None': + """ Updates the specified rectangle or region in the given window's client area. Args: @@ -50079,13 +47639,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ReleaseCapture(self,) -> 'None': - """ + def ReleaseCapture(self,) -> 'None': + """ None Args: @@ -50095,13 +47654,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ReleaseDC(self,dc:'Any') -> 'None': - """ + def ReleaseDC(self, dc: 'Any') -> 'None': + """ Releases a device context, freeing it for use by other applications. Args: @@ -50111,16 +47669,15 @@ Args: Returns: None - - """ - pass + """ + pass - def RepositionBars(self,idFirst:'Any',idLast:'Any',idLeftOver:'Any') -> 'None': - """ - Repositions the windows control bars.( UINT nIDFirst, UINT nIDLast, UINT + def RepositionBars(self, idFirst: 'Any', idLast: 'Any', idLeftOver: 'Any') -> 'None': + """ + 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,13 +47690,12 @@ Args: Returns: None - - """ - pass + """ + pass - def RunModalLoop(self,flags:'Any') -> 'Any': - """ + def RunModalLoop(self, flags: 'Any') -> 'Any': + """ Begins a modal loop for the window. Args: @@ -50149,13 +47705,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def PostMessage(self,idMessage:'Any',wParam:'Any'=0,lParam:'Any'=0) -> 'None': - """ + def PostMessage(self, idMessage: 'Any', wParam: 'Any' = 0, lParam: 'Any' = 0) -> 'None': + """ Post a message to the window. Args: @@ -50167,13 +47722,17 @@ Args: Returns: None - - """ - pass + """ + pass - def SendMessageToDescendants(self,idMessage:'Any',wParam:'Any'=0,lParam:'Any'=0,bDeep:'Any'=1) -> 'None': - """ + def SendMessageToDescendants( + self, + idMessage: 'Any', + wParam: 'Any' = 0, + lParam: 'Any' = 0, + bDeep: 'Any' = 1) -> 'None': + """ Send a message to all descendant windows. Args: @@ -50186,13 +47745,18 @@ Args: Returns: None - - """ - pass + """ + pass - def SendMessage(self,idMessage:'Any',idMessage1:'Any',ob:'Any',wParam:'Any'=0,lParam:'Any'=0) -> 'None': - """ + def SendMessage( + self, + idMessage: 'Any', + idMessage1: 'Any', + ob: 'Any', + wParam: 'Any' = 0, + lParam: 'Any' = 0) -> 'None': + """ Send a message to the window. Args: @@ -50206,13 +47770,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetActiveWindow(self,) -> 'Any': - """ + def SetActiveWindow(self,) -> 'Any': + """ Sets the window active. Returns the previously active window, or None. Args: @@ -50225,13 +47788,12 @@ 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 + """ + pass - def SetForegroundWindow(self,) -> 'None': - """ + def SetForegroundWindow(self,) -> 'None': + """ Puts the window into the foreground and activates the window. Args: @@ -50241,13 +47803,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetWindowPos(self,hWndInsertAfter:'Any',position:'Tuple[Any, Any, Any, Any]',flags:'Any') -> 'None': - """ + def SetWindowPos(self, hWndInsertAfter: 'Any', position: 'Tuple[Any, Any, Any, Any]', flags: 'Any') -> 'None': + """ Sets the windows position information Args: @@ -50259,14 +47820,13 @@ Args: Returns: None - - """ - pass + """ + pass - def ScreenToClient(self,rect:'Tuple[Any, Any, Any, Any, Any]',pnt:'Any') -> 'Tuple[Any, Any, Any, Any, Any]': - """ - Converts the screen coordinates of a given point + def ScreenToClient(self, rect: 'Tuple[Any, Any, Any, Any, Any]', pnt: 'Any') -> 'Tuple[Any, Any, Any, Any, Any]': + """ + Converts the screen coordinates of a given point or rectangle on the display to client coordinates. @@ -50280,14 +47840,13 @@ Returns: Tuple[Any, Any, Any, Any, Any]:CWnd::ScreenToClient Return ValueThe result is the same size as the input argument. - - """ - pass + """ + pass - def SetCapture(self,) -> 'None': - """ - Causes all subsequent mouse input to be sent to the window object regardless of the + def SetCapture(self,) -> 'None': + """ + Causes all subsequent mouse input to be sent to the window object regardless of the position of the cursor. @@ -50298,13 +47857,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetDlgItemText(self,idControl:'Any',text:'str') -> 'None': - """ + def SetDlgItemText(self, idControl: 'Any', text: 'str') -> 'None': + """ Sets the text for the child window or control with the specified ID. Args: @@ -50315,13 +47873,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetFocus(self,) -> 'None': - """ + def SetFocus(self,) -> 'None': + """ Claims the input focus. The object that previously had the focus loses it. Args: @@ -50331,13 +47888,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetFont(self,font:'Any',bRedraw:'Any'=1) -> 'None': - """ + def SetFont(self, font: 'Any', bRedraw: 'Any' = 1) -> 'None': + """ Sets the window's current font to the specified font. Args: @@ -50348,13 +47904,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetIcon(self,) -> 'Any': - """ + def SetIcon(self,) -> 'Any': + """ Calls the underlying MFC SetIcon method. Args: @@ -50364,13 +47919,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetMenu(self,menuObj:'Any') -> 'None': - """ + def SetMenu(self, menuObj: 'Any') -> 'None': + """ Sets the menu for a window. Args: @@ -50380,13 +47934,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetRedraw(self,bState:'Any'=1) -> 'None': - """ + def SetRedraw(self, bState: 'Any' = 1) -> 'None': + """ Allows changes to be redrawn or to prevent changes from being redrawn. Args: @@ -50396,13 +47949,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetScrollPos(self,nBar:'Any',nPos:'Any',redraw:'Any'=1) -> 'Any': - """ + def SetScrollPos(self, nBar: 'Any', nPos: 'Any', redraw: 'Any' = 1) -> 'Any': + """ Sets the current position of the scroll box of a scroll bar. Args: @@ -50414,13 +47966,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetScrollInfo(self,nBar:'Any',ScrollInfo:'Any',redraw:'Any'=1) -> 'Any': - """ + def SetScrollInfo(self, nBar: 'Any', ScrollInfo: 'Any', redraw: 'Any' = 1) -> 'Any': + """ Set information about a scroll bar Args: @@ -50432,13 +47983,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetTimer(self,idEvent:'Any',elapse:'Any') -> 'Any': - """ + def SetTimer(self, idEvent: 'Any', elapse: 'Any') -> 'Any': + """ Installs a system timer Args: @@ -50449,13 +47999,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def SetWindowPlacement(self,placement:'Any') -> 'None': - """ + def SetWindowPlacement(self, placement: 'Any') -> 'None': + """ Sets the windows placement Args: @@ -50465,13 +48014,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetWindowText(self,text:'str') -> 'None': - """ + def SetWindowText(self, text: 'str') -> 'None': + """ Sets the window's text. Args: @@ -50481,13 +48029,12 @@ Args: Returns: None - - """ - pass + """ + pass - def ShowCaret(self,) -> 'None': - """ + def ShowCaret(self,) -> 'None': + """ Shows the caret Args: @@ -50497,14 +48044,13 @@ Args: Returns: None - - """ - pass + """ + pass - def ShowScrollBar(self,nBar:'Any',bShow:'Any'=1) -> 'None': - """ - Shows or hides a scroll bar. + def ShowScrollBar(self, nBar: 'Any', bShow: 'Any' = 1) -> 'None': + """ + 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,31 +48062,29 @@ Args: Returns: None - - """ - pass + """ + pass - def ShowWindow(self,arg:'Any') -> 'Any': - """ + def ShowWindow(self, arg: 'Any') -> 'Any': + """ Sets the visibility state of the window. Args: - arg(Any):Specifies how the window is to be shown. It must be one of win32con.SW_HIDE, win32con.SW_MINIMIZE, win32con.SW_RESTORE, win32con.SW_SHOW, win32con.SW_SHOWMAXIMIZED win32con.SW_SHOWMINIMIZED, win32con.SW_SHOWMINNOACTIVE, win32con.SW_SHOWNA, win32con.SW_SHOWNOACTIVATE, or win32con.SW_SHOWNORMALMFC References + arg(Any):Specifies how the window is to be shown. It must be one of win32con.SW_HIDE, win32con.SW_MINIMIZE, win32con.SW_RESTORE, win32con.SW_SHOW, win32con.SW_SHOWMAXIMIZED win32con.SW_SHOWMINIMIZED, win32con.SW_SHOWMINNOACTIVE, win32con.SW_SHOWNA, win32con.SW_SHOWNOACTIVATE, or win32con.SW_SHOWNORMALMFC References Returns: Any:CWnd::ShowWindow Return ValueReturns TRUE is the window was previously visible. - - """ - pass + """ + pass - def UnLockWindowUpdate(self,) -> 'None': - """ + def UnLockWindowUpdate(self,) -> 'None': + """ Unlocks a window that was locked with LockWindowUpdate Args: @@ -50550,16 +48094,15 @@ Args: Returns: None - - """ - pass + """ + pass - def UpdateData(self,bSaveAndValidate:'Any'=1) -> 'Any': - """ - Initialises data in a dialog box, or to retrieves and validates dialog data. + def UpdateData(self, bSaveAndValidate: 'Any' = 1) -> 'Any': + """ + 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,13 +48113,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def UpdateDialogControls(self,pTarget:'Any',disableIfNoHandler:'Any') -> 'Any': - """ + def UpdateDialogControls(self, pTarget: 'Any', disableIfNoHandler: 'Any') -> 'Any': + """ None Args: @@ -50587,14 +48129,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def UpdateWindow(self,) -> 'None': - """ - Updates a window. This forces a paint message to be sent to the window, if any part + def UpdateWindow(self,) -> 'None': + """ + 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,20 +48146,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyDDEConv(object): - """A DDE topic.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyDDEConv(object): + """A DDE topic.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def ConnectTo(self,service:'str',topic:'str') -> 'None': - """ + def ConnectTo(self, service: 'str', topic: 'str') -> 'None': + """ Connects to a server Args: @@ -50629,13 +48169,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Connected(self,) -> 'None': - """ + def Connected(self,) -> 'None': + """ Determines if the conversation is connected. Args: @@ -50645,13 +48184,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Exec(self,Cmd:'str') -> 'None': - """ + def Exec(self, Cmd: 'str') -> 'None': + """ Executes a command. Args: @@ -50661,13 +48199,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Request(self,) -> 'None': - """ + def Request(self,) -> 'None': + """ Sends a request. Args: @@ -50677,13 +48214,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Poke(self,) -> 'None': - """ + def Poke(self,) -> 'None': + """ Sends a poke. Args: @@ -50693,20 +48229,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyDDEServer(object): - """A DDE server.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyDDEServer(object): + """A DDE server.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def AddTopic(self,topic:'Any') -> 'None': - """ + def AddTopic(self, topic: 'Any') -> 'None': + """ None Args: @@ -50716,13 +48251,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Create(self,name:'str',filterFlags:'Any'=0) -> 'None': - """ + def Create(self, name: 'str', filterFlags: 'Any' = 0) -> 'None': + """ Create a server Args: @@ -50733,13 +48267,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Destroy(self,) -> 'None': - """ + def Destroy(self,) -> 'None': + """ None Args: @@ -50749,13 +48282,12 @@ Args: Returns: None - - """ - pass + """ + pass - def GetLastError(self,) -> 'Any': - """ + def GetLastError(self,) -> 'Any': + """ None Args: @@ -50765,13 +48297,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def Shutdown(self,) -> 'None': - """ + def Shutdown(self,) -> 'None': + """ None Args: @@ -50781,20 +48312,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyDDEStringItem(object): - """A DDE string item.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyDDEStringItem(object): + """A DDE string item.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def SetData(self,data:'str') -> 'None': - """ + def SetData(self, data: 'str') -> 'None': + """ Sets an items data, and causes any underlying notification. Args: @@ -50804,20 +48334,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyDDETopic(object): - """A DDE topic.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyDDETopic(object): + """A DDE topic.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def AddItem(self,item:'Any') -> 'None': - """ + def AddItem(self, item: 'Any') -> 'None': + """ Add an item to the topic. Args: @@ -50827,13 +48356,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Destroy(self,) -> 'None': - """ + def Destroy(self,) -> 'None': + """ Destroys an item Args: @@ -50843,20 +48371,19 @@ Args: Returns: None - - """ - pass + """ + pass -class PyDLL(object): - """A DLL object. A general utility object, and not associated with an MFC object.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class PyDLL(object): + """A DLL object. A general utility object, and not associated with an MFC object.""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetFileName(self,) -> 'str': - """ + def GetFileName(self,) -> 'str': + """ Returns the name of the module associated with the DLL. Args: @@ -50866,13 +48393,12 @@ Args: Returns: str - - """ - pass + """ + pass - def AttachToMFC(self,) -> 'None': - """ + def AttachToMFC(self,) -> 'None': + """ Attaches the DLL object to the MFC list of DLL's. Args: @@ -50882,108 +48408,95 @@ Args: Returns: None - - """ - pass + + """ + pass class SCROLLINFO(object): - """Tuple representing a SCROLLINFO struct""" + """Tuple representing a SCROLLINFO struct""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class TV_ITEM(object): - """""" + """""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') class EXTENSION_CONTROL_BLOCK(object): - """A python representation of an ISAPI + """A python representation of an ISAPI EXTENSION_CONTROL_BLOCK.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Version(self)->'int': - """Version info of this spec (read-only)""" - pass - - - @property - def TotalBytes(self)->'Any': - """Total bytes indicated from client""" - pass - - - @property - def AvailableBytes(self)->'Any': - """Available number of bytes""" - pass - - - @property - def HttpStatusCode(self)->'Any': - """The status of the current transaction when the request is completed.""" - pass - - - @property - def Method(self)->'Any': - """REQUEST_METHOD""" - pass - - - @property - def ConnID(self)->'Any': - """Context number (read-only)""" - pass - - - @property - def QueryString(self)->'Any': - """QUERY_STRING""" - pass - - - @property - def PathInfo(self)->'Any': - """PATH_INFO""" - pass - - - @property - def PathTranslated(self)->'Any': - """PATH_TRANSLATED""" - pass - - - @property - def AvailableData(self)->'Any': - """Pointer to cbAvailable bytes""" - pass - - - @property - def ContentType(self)->'Any': - """Content type of client data""" - pass - - - @property - def LogData(self)->'Any': - """log data string""" - pass - - - def WriteClient(self,data:'Union[Any, str]',reserved:'Any'=0) -> 'Any': - """ + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + + @property + def Version(self) -> 'int': + """Version info of this spec (read-only)""" + pass + + @property + def TotalBytes(self) -> 'Any': + """Total bytes indicated from client""" + pass + + @property + def AvailableBytes(self) -> 'Any': + """Available number of bytes""" + pass + + @property + def HttpStatusCode(self) -> 'Any': + """The status of the current transaction when the request is completed.""" + pass + + @property + def Method(self) -> 'Any': + """REQUEST_METHOD""" + pass + + @property + def ConnID(self) -> 'Any': + """Context number (read-only)""" + pass + + @property + def QueryString(self) -> 'Any': + """QUERY_STRING""" + pass + + @property + def PathInfo(self) -> 'Any': + """PATH_INFO""" + pass + + @property + def PathTranslated(self) -> 'Any': + """PATH_TRANSLATED""" + pass + + @property + def AvailableData(self) -> 'Any': + """Pointer to cbAvailable bytes""" + pass + + @property + def ContentType(self) -> 'Any': + """Content type of client data""" + pass + + @property + def LogData(self) -> 'Any': + """log data string""" + pass + + def WriteClient(self, data: 'Union[Any, str]', reserved: 'Any' = 0) -> 'Any': + """ None Args: @@ -50996,37 +48509,35 @@ Returns: Any: Return Valuethe result is the number of bytes written. - - """ - pass + """ + pass - def GetServerVariable(self,variable:'str',default:'Any') -> 'str': - """ + def GetServerVariable(self, variable: 'str', default: 'Any') -> 'str': + """ None Args: variable(str): - default(Any):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 begins with 'UNICODE_', in which case it is a unicode object - see the ISAPI docs for more details. + default(Any):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 begins with 'UNICODE_', in which case it is a unicode object - see the ISAPI docs for more details. 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 + """ + pass - def ReadClient(self,nbytes:'Any') -> 'str': - """ + def ReadClient(self, nbytes: 'Any') -> 'str': + """ None Args: @@ -51036,14 +48547,13 @@ Args: Returns: str - - """ - pass + """ + pass - def SendResponseHeaders(self,reply:'str',headers:'str',keepAlive:'Any'=False) -> 'None': - """ - Calls ServerSupportFunction with + def SendResponseHeaders(self, reply: 'str', headers: 'str', keepAlive: 'Any' = False) -> 'None': + """ + Calls ServerSupportFunction with HSE_REQ_SEND_RESPONSE_HEADER_EX @@ -51056,13 +48566,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SetFlushFlag(self,flag:'Any') -> 'None': - """ + def SetFlushFlag(self, flag: 'Any') -> 'None': + """ Calls ServerSupportFunction with HSE_REQ_SET_FLUSH_FLAG. Args: @@ -51072,13 +48581,22 @@ Args: Returns: None - - """ - pass + """ + pass - def TransmitFile(self,callback:'Any',param:'Any',hFile:'Any',statusCode:'str',BytesToWrite:'Any',Offset:'Any',head:'str',tail:'str',flags:'Any') -> 'Any': - """ + def TransmitFile( + self, + callback: 'Any', + param: 'Any', + hFile: 'Any', + statusCode: 'str', + BytesToWrite: 'Any', + Offset: 'Any', + head: 'str', + tail: 'str', + flags: 'Any') -> 'Any': + """ Calls ServerSupportFunction with HSE_REQ_TRANSMIT_FILE Args: @@ -51096,13 +48614,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def MapURLToPath(self,) -> 'None': - """ + def MapURLToPath(self,) -> 'None': + """ Calls ServerSupportFunction with HSE_REQ_MAP_URL_TO_PATH Args: @@ -51112,13 +48629,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DoneWithSession(self,status:'Any') -> 'None': - """ + def DoneWithSession(self, status: 'Any') -> 'None': + """ Calls ServerSupportFunction with HSE_REQ_DONE_WITH_SESSION Args: @@ -51128,13 +48644,12 @@ Args: Returns: None - - """ - pass + """ + pass - def Redirect(self,url:'str') -> 'None': - """ + def Redirect(self, url: 'str') -> 'None': + """ Calls ServerSupportFunction with HSE_REQ_SEND_URL_REDIRECT_RESP Args: @@ -51144,13 +48659,12 @@ Args: Returns: None - - """ - pass + """ + pass - def IsKeepAlive(self,) -> 'None': - """ + def IsKeepAlive(self,) -> 'None': + """ None Args: @@ -51160,14 +48674,13 @@ Args: Returns: None - - """ - pass + """ + pass - def GetAnonymousToken(self,metabase_path:'Union[Any, str]') -> 'Any': - """ - Calls ServerSupportFunction with HSE_REQ_GET_ANONYMOUS_TOKEN + def GetAnonymousToken(self, metabase_path: 'Union[Any, str]') -> 'Any': + """ + Calls ServerSupportFunction with HSE_REQ_GET_ANONYMOUS_TOKEN or HSE_REQ_GET_UNICODE_ANONYMOUS_TOKEN @@ -51178,14 +48691,13 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetImpersonationToken(self,) -> 'Any': - """ - Calls ServerSupportFunction with + def GetImpersonationToken(self,) -> 'Any': + """ + Calls ServerSupportFunction with HSE_REQ_GET_IMPERSONATION_TOKEN @@ -51196,13 +48708,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def IsKeepConn(self,) -> 'Any': - """ + def IsKeepConn(self,) -> 'Any': + """ Calls ServerSupportFunction with HSE_REQ_IS_KEEP_CONN Args: @@ -51212,13 +48723,19 @@ Args: Returns: Any - - """ - pass + """ + pass - def ExecURL(self,url:'str',method:'str',clientHeaders:'str',info:'Any',entity:'Any',flags:'Any') -> 'Any': - """ + def ExecURL( + self, + url: 'str', + method: 'str', + clientHeaders: 'str', + info: 'Any', + entity: 'Any', + flags: 'Any') -> 'Any': + """ Calls ServerSupportFunction with HSE_REQ_EXEC_URL Args: @@ -51233,13 +48750,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def GetExecURLStatus(self,) -> 'Any': - """ + def GetExecURLStatus(self,) -> 'Any': + """ Calls ServerSupportFunction with HSE_REQ_GET_EXEC_URL_STATUS Args: @@ -51251,14 +48767,13 @@ Returns: 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 + """ + pass - def IOCompletion(self,func:'Any',arg:'Any'=None) -> 'Any': - """ - Set a callback that will be used for handling asynchronous I/O + def IOCompletion(self, func: 'Any', arg: 'Any' = None) -> 'Any': + """ + Set a callback that will be used for handling asynchronous I/O operations. @@ -51270,13 +48785,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def ReportUnhealthy(self,reason:'str'=None) -> 'Any': - """ + def ReportUnhealthy(self, reason: 'str' = None) -> 'Any': + """ Calls ServerSupportFunction with HSE_REQ_REPORT_UNHEALTHY Args: @@ -51286,13 +48800,12 @@ Args: Returns: Any - - """ - pass + """ + pass - def IOCallback(self,ecb:'Any',arg:'Any',cbIO:'Any',dwError:'Any') -> 'Any': - """ + def IOCallback(self, ecb: 'Any', arg: 'Any', cbIO: 'Any', dwError: 'Any') -> 'Any': + """ A placeholder for a user-supplied callback function. Args: @@ -51306,90 +48819,82 @@ Returns: 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 + """ + pass -class HSE_VERSION_INFO(object): - """An object used by ISAPI GetExtensionVersion""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') +class HSE_VERSION_INFO(object): + """An object used by ISAPI GetExtensionVersion""" + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def ExtensionDesc(self)->'str': - """The description of the extension.""" - pass + @property + def ExtensionDesc(self) -> 'str': + """The description of the extension.""" + pass class HTTP_FILTER_AUTHENT(object): - """A Python representation of an ISAPI + """A Python representation of an ISAPI HTTP_FILTER_AUTHENT structure.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def User(self) -> 'str': + """""" + pass - @property - def User(self)->'str': - """""" - pass - - - @property - def Password(self)->'str': - """""" - pass + @property + def Password(self) -> 'str': + """""" + pass class HTTP_FILTER_CONTEXT(object): - """A Python representation of an ISAPI + """A Python representation of an ISAPI HTTP_FILTER_CONTEXT structure.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Revision(self)->'Any': - """(read-only)""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def Revision(self) -> 'Any': + """(read-only)""" + pass - @property - def fIsSecurePort(self)->'Any': - """(read-only)""" - pass + @property + def fIsSecurePort(self) -> 'Any': + """(read-only)""" + pass + @property + def NotificationType(self) -> 'Any': + """(read-only)""" + pass - @property - def NotificationType(self)->'Any': - """(read-only)""" - pass + @property + def FilterContext(self) -> 'Any': + """Any object you wish to associate with the request.""" + pass + def GetData(self,) -> 'Any': + """ + Obtains the data passed to - @property - def FilterContext(self)->'Any': - """Any object you wish to associate with the request.""" - pass - - - def GetData(self,) -> 'Any': - """ - 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 +48906,9 @@ Returns: 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,37 +48930,35 @@ SF_NOTIFY_SEND_RAW_DATAHTTP_FILTER_RAW_DATA SF_NOTIFY_READ_RAW_DATAHTTP_FILTER_RAW_DATA SF_NOTIFY_AUTHENTICATIONHTTP_FILTER_AUTHENT - - """ - pass + """ + pass - def GetServerVariable(self,variable:'str',default:'Any') -> 'str': - """ + def GetServerVariable(self, variable: 'str', default: 'Any') -> 'str': + """ None Args: variable(str): - default(Any):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 begins with 'UNICODE_', in which case it is a unicode object - see the ISAPI docs for more details. + default(Any):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 begins with 'UNICODE_', in which case it is a unicode object - see the ISAPI docs for more details. 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 + """ + pass - def WriteClient(self,data:'str',reserverd:'Any'=0) -> 'None': - """ + def WriteClient(self, data: 'str', reserverd: 'Any' = 0) -> 'None': + """ None Args: @@ -51466,13 +48969,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AddResponseHeaders(self,data:'str',reserverd:'Any'=0) -> 'None': - """ + def AddResponseHeaders(self, data: 'str', reserverd: 'Any' = 0) -> 'None': + """ None Args: @@ -51483,13 +48985,12 @@ Args: Returns: None - - """ - pass + """ + pass - def SendResponseHeader(self,status:'str',header:'str') -> 'None': - """ + def SendResponseHeader(self, status: 'str', header: 'str') -> 'None': + """ None Args: @@ -51500,13 +49001,12 @@ Args: Returns: None - - """ - pass + """ + pass - def DisableNotifications(self,flags:'Any') -> 'None': - """ + def DisableNotifications(self, flags: 'Any') -> 'None': + """ None Args: @@ -51516,90 +49016,81 @@ Args: Returns: None - - """ - pass + + """ + pass class HTTP_FILTER_LOG(object): - """A Python representation of an ISAPI + """A Python representation of an ISAPI HTTP_FILTER_LOG structure.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def ClientHostName(self) -> 'str': + """""" + pass - @property - def ClientHostName(self)->'str': - """""" - pass + @property + def ClientUserName(self) -> 'str': + """""" + pass + @property + def ServerName(self) -> 'str': + """""" + pass - @property - def ClientUserName(self)->'str': - """""" - pass + @property + def Operation(self) -> 'str': + """""" + pass + @property + def Target(self) -> 'str': + """""" + pass - @property - def ServerName(self)->'str': - """""" - pass + @property + def Parameters(self) -> 'str': + """""" + pass - - @property - def Operation(self)->'str': - """""" - pass - - - @property - def Target(self)->'str': - """""" - pass - - - @property - def Parameters(self)->'str': - """""" - pass - - - @property - def HttpStatus(self)->'Any': - """""" - pass + @property + def HttpStatus(self) -> 'Any': + """""" + pass class HTTP_FILTER_PREPROC_HEADERS(object): - """A Python representation of an ISAPI + """A Python representation of an ISAPI HTTP_FILTER_PREPROC_HEADERS structure.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - def GetHeader(self,header:'str',default:'Any') -> 'str': - """ + def GetHeader(self, header: 'str', default: 'Any') -> 'str': + """ None Args: header(str): - default(Any):If specified, this will be returned on error. + default(Any):If specified, this will be returned on error. Returns: str - - """ - pass + """ + pass - def SetHeader(self,name:'str',val:'str') -> 'None': - """ + def SetHeader(self, name: 'str', val: 'str') -> 'None': + """ None Args: @@ -51610,13 +49101,12 @@ Args: Returns: None - - """ - pass + """ + pass - def AddHeader(self,) -> 'None': - """ + def AddHeader(self,) -> 'None': + """ None Args: @@ -51626,75 +49116,68 @@ Args: Returns: None - - """ - pass + + """ + pass class HTTP_FILTER_RAW_DATA(object): - """A Python representation of an ISAPI + """A Python representation of an ISAPI HTTP_FILTER_RAW_DATA structure.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') - @property - def InData(self)->'str': - """""" - pass + @property + def InData(self) -> 'str': + """""" + pass class HTTP_FILTER_URL_MAP(object): - """A Python representation of an ISAPI + """A Python representation of an ISAPI HTTP_FILTER_URL_MAP structure.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def URL(self)->'str': - """""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def URL(self) -> 'str': + """""" + pass - @property - def PhysicalPath(self)->'str': - """""" - pass + @property + def PhysicalPath(self) -> 'str': + """""" + pass class HTTP_FILTER_VERSION(object): - """A Python interface to the ISAPI HTTP_FILTER_VERSION + """A Python interface to the ISAPI HTTP_FILTER_VERSION structure.""" - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ServerFilterVersion(self)->'Any': - """(read-only)""" - pass - - - @property - def FilterVersion(self)->'Any': - """""" - pass + def __new__(cls): + raise Exception('This class just for typing, can not be instanced!') + @property + def ServerFilterVersion(self) -> 'Any': + """(read-only)""" + pass - @property - def Flags(self)->'Any': - """""" - pass + @property + def FilterVersion(self) -> 'Any': + """""" + pass + @property + def Flags(self) -> 'Any': + """""" + pass - @property - def FilterDesc(self)->'str': - """""" - pass + @property + def FilterDesc(self) -> 'str': + """""" + pass diff --git a/typings/win32-stubs/win32gui.pyi b/typings/win32-stubs/win32gui.pyi index 46d7019c..f3a81231 100644 --- a/typings/win32-stubs/win32gui.pyi +++ b/typings/win32-stubs/win32gui.pyi @@ -1,10 +1,400 @@ -__all__=['', 'EnumFontFamilies', 'set_logger', 'LOGFONT', 'CreateFontIndirect', 'GetObject', 'GetObjectType', 'PyGetMemory', 'PyGetString', 'PySetString', 'PySetMemory', 'PyGetArraySignedLong', 'PyGetBufferAddressAndLen', 'FlashWindow', 'FlashWindowEx', 'GetWindowLong', 'GetClassLong', 'SetWindowLong', 'CallWindowProc', 'SendMessage', 'SendMessageTimeout', 'PostMessage', 'PostThreadMessage', 'ReplyMessage', 'RegisterWindowMessage', 'DefWindowProc', 'EnumWindows', 'EnumThreadWindows', 'EnumChildWindows', 'DialogBox', 'DialogBoxParam', 'DialogBoxIndirect', 'DialogBoxIndirectParam', 'CreateDialogIndirect', 'DialogBoxIndirectParam', 'EndDialog', 'GetDlgItem', 'GetDlgItemInt', 'SetDlgItemInt', 'GetDlgCtrlID', 'GetDlgItemText', 'SetDlgItemText', 'GetNextDlgTabItem', 'GetNextDlgGroupItem', 'SetWindowText', 'GetWindowText', 'InitCommonControls', 'InitCommonControlsEx', 'LoadCursor', 'SetCursor', 'GetCursor', 'GetCursorInfo', 'CreateAcceleratorTable', 'DestroyAccleratorTable', 'LoadMenu', 'DestroyMenu', 'SetMenu', 'GetMenu', 'LoadIcon', 'CopyIcon', 'DrawIcon', 'DrawIconEx', 'CreateIconIndirect', 'CreateIconFromResource', 'LoadImage', 'DeleteObject', 'BitBlt', 'StretchBlt', 'PatBlt', 'SetStretchBltMode', 'GetStretchBltMode', 'TransparentBlt', 'MaskBlt', 'AlphaBlend', 'ImageList_Add', 'ImageList_Create', 'ImageList_Destroy', 'ImageList_Draw', 'ImageList_DrawEx', 'ImageList_GetIcon', 'ImageList_GetImageCount', 'ImageList_LoadImage', 'ImageList_LoadBitmap', 'ImageList_Remove', 'ImageList_Replace', 'ImageList_ReplaceIcon', 'ImageList_SetBkColor', 'ImageList_SetOverlayImage', 'MessageBox', 'MessageBeep', 'CreateWindow', 'DestroyWindow', 'EnableWindow', 'FindWindow', 'FindWindowEx', 'DragAcceptFiles', 'DragDetect', 'SetDoubleClickTime', 'GetDoubleClickTime', 'HideCaret', 'SetCaretPos', 'GetCaretPos', 'ShowCaret', 'ShowWindow', 'IsWindowVisible', 'IsWindowEnabled', 'SetFocus', 'GetFocus', 'UpdateWindow', 'BringWindowToTop', 'SetActiveWindow', 'GetActiveWindow', 'SetForegroundWindow', 'GetForegroundWindow', 'GetClientRect', 'GetDC', 'SaveDC', 'RestoreDC', 'DeleteDC', 'CreateCompatibleDC', 'CreateCompatibleBitmap', 'CreateBitmap', 'SelectObject', 'GetCurrentObject', 'GetWindowRect', 'GetStockObject', 'PostQuitMessage', 'WaitMessage', 'SetWindowPos', 'GetWindowPlacement', 'SetWindowPlacement', 'RegisterClass', 'UnregisterClass', 'PumpMessages', 'PumpWaitingMessages', 'GetMessage', 'TranslateMessage', 'DispatchMessage', 'TranslateAccelerator', 'PeekMessage', 'Shell_NotifyIcon', 'GetSystemMenu', 'DrawMenuBar', 'MoveWindow', 'CloseWindow', 'DeleteMenu', 'RemoveMenu', 'CreateMenu', 'CreatePopupMenu', 'TrackPopupMenu', 'CommDlgExtendedError', 'ExtractIcon', 'ExtractIconEx', 'DestroyIcon', 'GetIconInfo', 'ScreenToClient', 'ClientToScreen', 'PaintDesktop', 'RedrawWindow', 'GetTextExtentPoint32', 'GetTextMetrics', 'GetTextCharacterExtra', 'SetTextCharacterExtra', 'GetTextAlign', 'SetTextAlign', 'GetTextFace', 'GetMapMode', 'SetMapMode', 'GetGraphicsMode', 'SetGraphicsMode', 'GetLayout', 'SetLayout', 'GetPolyFillMode', 'SetPolyFillMode', 'GetWorldTransform', 'SetWorldTransform', 'ModifyWorldTransform', 'CombineTransform', 'GetWindowOrgEx', 'SetWindowOrgEx', 'GetViewportOrgEx', 'SetViewportOrgEx', 'GetWindowExtEx', 'SetWindowExtEx', 'GetViewportExtEx', 'SetViewportExtEx', 'GradientFill', 'GetOpenFileName', 'InsertMenuItem', 'SetMenuItemInfo', 'GetMenuItemInfo', 'GetMenuItemCount', 'GetMenuItemRect', 'GetMenuState', 'SetMenuDefaultItem', 'GetMenuDefaultItem', 'AppendMenu', 'InsertMenu', 'EnableMenuItem', 'CheckMenuItem', 'GetSubMenu', 'ModifyMenu', 'GetMenuItemID', 'SetMenuItemBitmaps', 'CheckMenuRadioItem', 'SetMenuInfo', 'GetMenuInfo', 'DrawFocusRect', 'DrawText', 'LineTo', 'Ellipse', 'Pie', 'Arc', 'ArcTo', 'AngleArc', 'Chord', 'ExtFloodFill', 'SetPixel', 'GetPixel', 'GetROP2', 'SetROP2', 'SetPixelV', 'MoveToEx', 'GetCurrentPositionEx', 'GetArcDirection', 'SetArcDirection', 'Polygon', 'Polyline', 'PolylineTo', 'PolyBezier', 'PolyBezierTo', 'PlgBlt', 'CreatePolygonRgn', 'ExtTextOut', 'GetTextColor', 'SetTextColor', 'GetBkMode', 'SetBkMode', 'GetBkColor', 'SetBkColor', 'DrawEdge', 'FillRect', 'FillRgn', 'PaintRgn', 'FrameRgn', 'InvertRgn', 'EqualRgn', 'PtInRegion', 'PtInRect', 'RectInRegion', 'SetRectRgn', 'CombineRgn', 'DrawAnimatedRects', 'CreateSolidBrush', 'CreatePatternBrush', 'CreateHatchBrush', 'CreatePen', 'GetSysColor', 'GetSysColorBrush', 'InvalidateRect', 'FrameRect', 'InvertRect', 'WindowFromDC', 'GetUpdateRgn', 'GetWindowRgn', 'SetWindowRgn', 'GetWindowRgnBox', 'ValidateRgn', 'InvalidateRgn', 'GetRgnBox', 'OffsetRgn', 'Rectangle', 'RoundRect', 'BeginPaint', 'EndPaint', 'BeginPath', 'EndPath', 'AbortPath', 'CloseFigure', 'FlattenPath', 'FillPath', 'WidenPath', 'StrokePath', 'StrokeAndFillPath', 'GetMiterLimit', 'SetMiterLimit', 'PathToRegion', 'GetPath', 'CreateRoundRectRgn', 'CreateRectRgnIndirect', 'CreateEllipticRgnIndirect', 'CreateWindowEx', 'GetParent', 'SetParent', 'GetCursorPos', 'GetDesktopWindow', 'GetWindow', 'GetWindowDC', 'IsIconic', 'IsWindow', 'IsChild', 'ReleaseCapture', 'GetCapture', 'SetCapture', '_TrackMouseEvent', 'ReleaseDC', 'CreateCaret', 'DestroyCaret', 'ScrollWindowEx', 'SetScrollInfo', 'GetScrollInfo', 'GetClassName', 'WindowFromPoint', 'ChildWindowFromPoint', 'ChildWindowFromPoint', 'ListView_SortItems', 'ListView_SortItemsEx', 'CreateDC', 'GetSaveFileNameW', 'GetOpenFileNameW', 'SystemParametersInfo', 'SetLayeredWindowAttributes', 'GetLayeredWindowAttributes', 'UpdateLayeredWindow', 'AnimateWindow', 'CreateBrushIndirect', 'ExtCreatePen', 'DrawTextW', 'EnumPropsEx', 'RegisterDeviceNotification', 'UnregisterDeviceNotification', 'RegisterHotKey', 'CLR_NONE', 'ILC_COLOR', 'ILC_COLOR16', 'ILC_COLOR24', 'ILC_COLOR32', 'ILC_COLOR4', 'ILC_COLOR8', 'ILC_COLORDDB', 'ILC_MASK', 'ILD_BLEND', 'ILD_BLEND25', 'ILD_BLEND50', 'ILD_FOCUS', 'ILD_MASK', 'ILD_NORMAL', 'ILD_SELECTED', 'ILD_TRANSPARENT', 'IMAGE_BITMAP', 'IMAGE_CURSOR', 'IMAGE_ICON', 'LR_CREATEDIBSECTION', 'LR_DEFAULTCOLOR', 'LR_DEFAULTSIZE', 'LR_LOADFROMFILE', 'LR_LOADMAP3DCOLORS', 'LR_LOADTRANSPARENT', 'LR_MONOCHROME', 'LR_SHARED', 'LR_VGACOLOR', 'NIF_ICON', 'NIF_INFO', 'NIF_MESSAGE', 'NIF_STATE', 'NIF_TIP', 'NIIF_ERROR', 'NIIF_ICON_MASK', 'NIIF_INFO', 'NIIF_NONE', 'NIIF_NOSOUND', 'NIIF_WARNING', 'NIM_ADD', 'NIM_DELETE', 'NIM_MODIFY', 'NIM_SETFOCUS', 'NIM_SETVERSION', 'TPM_BOTTOMALIGN', 'TPM_CENTERALIGN', 'TPM_LEFTALIGN', 'TPM_LEFTBUTTON', 'TPM_NONOTIFY', 'TPM_RETURNCMD', 'TPM_RIGHTALIGN', 'TPM_RIGHTBUTTON', 'TPM_TOPALIGN', 'TPM_VCENTERALIGN'] +__all__ = [ + 'EnumFontFamilies', + 'set_logger', + 'LOGFONT', + 'CreateFontIndirect', + 'GetObject', + 'GetObjectType', + 'PyGetMemory', + 'PyGetString', + 'PySetString', + 'PySetMemory', + 'PyGetArraySignedLong', + 'PyGetBufferAddressAndLen', + 'FlashWindow', + 'FlashWindowEx', + 'GetWindowLong', + 'GetClassLong', + 'SetWindowLong', + 'CallWindowProc', + 'SendMessage', + 'SendMessageTimeout', + 'PostMessage', + 'PostThreadMessage', + 'ReplyMessage', + 'RegisterWindowMessage', + 'DefWindowProc', + 'EnumWindows', + 'EnumThreadWindows', + 'EnumChildWindows', + 'DialogBox', + 'DialogBoxParam', + 'DialogBoxIndirect', + 'DialogBoxIndirectParam', + 'CreateDialogIndirect', + 'DialogBoxIndirectParam', + 'EndDialog', + 'GetDlgItem', + 'GetDlgItemInt', + 'SetDlgItemInt', + 'GetDlgCtrlID', + 'GetDlgItemText', + 'SetDlgItemText', + 'GetNextDlgTabItem', + 'GetNextDlgGroupItem', + 'SetWindowText', + 'GetWindowText', + 'InitCommonControls', + 'InitCommonControlsEx', + 'LoadCursor', + 'SetCursor', + 'GetCursor', + 'GetCursorInfo', + 'CreateAcceleratorTable', + 'DestroyAccleratorTable', + 'LoadMenu', + 'DestroyMenu', + 'SetMenu', + 'GetMenu', + 'LoadIcon', + 'CopyIcon', + 'DrawIcon', + 'DrawIconEx', + 'CreateIconIndirect', + 'CreateIconFromResource', + 'LoadImage', + 'DeleteObject', + 'BitBlt', + 'StretchBlt', + 'PatBlt', + 'SetStretchBltMode', + 'GetStretchBltMode', + 'TransparentBlt', + 'MaskBlt', + 'AlphaBlend', + 'ImageList_Add', + 'ImageList_Create', + 'ImageList_Destroy', + 'ImageList_Draw', + 'ImageList_DrawEx', + 'ImageList_GetIcon', + 'ImageList_GetImageCount', + 'ImageList_LoadImage', + 'ImageList_LoadBitmap', + 'ImageList_Remove', + 'ImageList_Replace', + 'ImageList_ReplaceIcon', + 'ImageList_SetBkColor', + 'ImageList_SetOverlayImage', + 'MessageBox', + 'MessageBeep', + 'CreateWindow', + 'DestroyWindow', + 'EnableWindow', + 'FindWindow', + 'FindWindowEx', + 'DragAcceptFiles', + 'DragDetect', + 'SetDoubleClickTime', + 'GetDoubleClickTime', + 'HideCaret', + 'SetCaretPos', + 'GetCaretPos', + 'ShowCaret', + 'ShowWindow', + 'IsWindowVisible', + 'IsWindowEnabled', + 'SetFocus', + 'GetFocus', + 'UpdateWindow', + 'BringWindowToTop', + 'SetActiveWindow', + 'GetActiveWindow', + 'SetForegroundWindow', + 'GetForegroundWindow', + 'GetClientRect', + 'GetDC', + 'SaveDC', + 'RestoreDC', + 'DeleteDC', + 'CreateCompatibleDC', + 'CreateCompatibleBitmap', + 'CreateBitmap', + 'SelectObject', + 'GetCurrentObject', + 'GetWindowRect', + 'GetStockObject', + 'PostQuitMessage', + 'WaitMessage', + 'SetWindowPos', + 'GetWindowPlacement', + 'SetWindowPlacement', + 'RegisterClass', + 'UnregisterClass', + 'PumpMessages', + 'PumpWaitingMessages', + 'GetMessage', + 'TranslateMessage', + 'DispatchMessage', + 'TranslateAccelerator', + 'PeekMessage', + 'Shell_NotifyIcon', + 'GetSystemMenu', + 'DrawMenuBar', + 'MoveWindow', + 'CloseWindow', + 'DeleteMenu', + 'RemoveMenu', + 'CreateMenu', + 'CreatePopupMenu', + 'TrackPopupMenu', + 'CommDlgExtendedError', + 'ExtractIcon', + 'ExtractIconEx', + 'DestroyIcon', + 'GetIconInfo', + 'ScreenToClient', + 'ClientToScreen', + 'PaintDesktop', + 'RedrawWindow', + 'GetTextExtentPoint32', + 'GetTextMetrics', + 'GetTextCharacterExtra', + 'SetTextCharacterExtra', + 'GetTextAlign', + 'SetTextAlign', + 'GetTextFace', + 'GetMapMode', + 'SetMapMode', + 'GetGraphicsMode', + 'SetGraphicsMode', + 'GetLayout', + 'SetLayout', + 'GetPolyFillMode', + 'SetPolyFillMode', + 'GetWorldTransform', + 'SetWorldTransform', + 'ModifyWorldTransform', + 'CombineTransform', + 'GetWindowOrgEx', + 'SetWindowOrgEx', + 'GetViewportOrgEx', + 'SetViewportOrgEx', + 'GetWindowExtEx', + 'SetWindowExtEx', + 'GetViewportExtEx', + 'SetViewportExtEx', + 'GradientFill', + 'GetOpenFileName', + 'InsertMenuItem', + 'SetMenuItemInfo', + 'GetMenuItemInfo', + 'GetMenuItemCount', + 'GetMenuItemRect', + 'GetMenuState', + 'SetMenuDefaultItem', + 'GetMenuDefaultItem', + 'AppendMenu', + 'InsertMenu', + 'EnableMenuItem', + 'CheckMenuItem', + 'GetSubMenu', + 'ModifyMenu', + 'GetMenuItemID', + 'SetMenuItemBitmaps', + 'CheckMenuRadioItem', + 'SetMenuInfo', + 'GetMenuInfo', + 'DrawFocusRect', + 'DrawText', + 'LineTo', + 'Ellipse', + 'Pie', + 'Arc', + 'ArcTo', + 'AngleArc', + 'Chord', + 'ExtFloodFill', + 'SetPixel', + 'GetPixel', + 'GetROP2', + 'SetROP2', + 'SetPixelV', + 'MoveToEx', + 'GetCurrentPositionEx', + 'GetArcDirection', + 'SetArcDirection', + 'Polygon', + 'Polyline', + 'PolylineTo', + 'PolyBezier', + 'PolyBezierTo', + 'PlgBlt', + 'CreatePolygonRgn', + 'ExtTextOut', + 'GetTextColor', + 'SetTextColor', + 'GetBkMode', + 'SetBkMode', + 'GetBkColor', + 'SetBkColor', + 'DrawEdge', + 'FillRect', + 'FillRgn', + 'PaintRgn', + 'FrameRgn', + 'InvertRgn', + 'EqualRgn', + 'PtInRegion', + 'PtInRect', + 'RectInRegion', + 'SetRectRgn', + 'CombineRgn', + 'DrawAnimatedRects', + 'CreateSolidBrush', + 'CreatePatternBrush', + 'CreateHatchBrush', + 'CreatePen', + 'GetSysColor', + 'GetSysColorBrush', + 'InvalidateRect', + 'FrameRect', + 'InvertRect', + 'WindowFromDC', + 'GetUpdateRgn', + 'GetWindowRgn', + 'SetWindowRgn', + 'GetWindowRgnBox', + 'ValidateRgn', + 'InvalidateRgn', + 'GetRgnBox', + 'OffsetRgn', + 'Rectangle', + 'RoundRect', + 'BeginPaint', + 'EndPaint', + 'BeginPath', + 'EndPath', + 'AbortPath', + 'CloseFigure', + 'FlattenPath', + 'FillPath', + 'WidenPath', + 'StrokePath', + 'StrokeAndFillPath', + 'GetMiterLimit', + 'SetMiterLimit', + 'PathToRegion', + 'GetPath', + 'CreateRoundRectRgn', + 'CreateRectRgnIndirect', + 'CreateEllipticRgnIndirect', + 'CreateWindowEx', + 'GetParent', + 'SetParent', + 'GetCursorPos', + 'GetDesktopWindow', + 'GetWindow', + 'GetWindowDC', + 'IsIconic', + 'IsWindow', + 'IsChild', + 'ReleaseCapture', + 'GetCapture', + 'SetCapture', + '_TrackMouseEvent', + 'ReleaseDC', + 'CreateCaret', + 'DestroyCaret', + 'ScrollWindowEx', + 'SetScrollInfo', + 'GetScrollInfo', + 'GetClassName', + 'WindowFromPoint', + 'ChildWindowFromPoint', + 'ChildWindowFromPoint', + 'ListView_SortItems', + 'ListView_SortItemsEx', + 'CreateDC', + 'GetSaveFileNameW', + 'GetOpenFileNameW', + 'SystemParametersInfo', + 'SetLayeredWindowAttributes', + 'GetLayeredWindowAttributes', + 'UpdateLayeredWindow', + 'AnimateWindow', + 'CreateBrushIndirect', + 'ExtCreatePen', + 'DrawTextW', + 'EnumPropsEx', + 'RegisterDeviceNotification', + 'UnregisterDeviceNotification', + 'RegisterHotKey', + 'CLR_NONE', + 'ILC_COLOR', + 'ILC_COLOR16', + 'ILC_COLOR24', + 'ILC_COLOR32', + 'ILC_COLOR4', + 'ILC_COLOR8', + 'ILC_COLORDDB', + 'ILC_MASK', + 'ILD_BLEND', + 'ILD_BLEND25', + 'ILD_BLEND50', + 'ILD_FOCUS', + 'ILD_MASK', + 'ILD_NORMAL', + 'ILD_SELECTED', + 'ILD_TRANSPARENT', + 'IMAGE_BITMAP', + 'IMAGE_CURSOR', + 'IMAGE_ICON', + 'LR_CREATEDIBSECTION', + 'LR_DEFAULTCOLOR', + 'LR_DEFAULTSIZE', + 'LR_LOADFROMFILE', + 'LR_LOADMAP3DCOLORS', + 'LR_LOADTRANSPARENT', + 'LR_MONOCHROME', + 'LR_SHARED', + 'LR_VGACOLOR', + 'NIF_ICON', + 'NIF_INFO', + 'NIF_MESSAGE', + 'NIF_STATE', + 'NIF_TIP', + 'NIIF_ERROR', + 'NIIF_ICON_MASK', + 'NIIF_INFO', + 'NIIF_NONE', + 'NIIF_NOSOUND', + 'NIIF_WARNING', + 'NIM_ADD', + 'NIM_DELETE', + 'NIM_MODIFY', + 'NIM_SETFOCUS', + 'NIM_SETVERSION', + 'TPM_BOTTOMALIGN', + 'TPM_CENTERALIGN', + 'TPM_LEFTALIGN', + 'TPM_LEFTBUTTON', + 'TPM_NONOTIFY', + 'TPM_RETURNCMD', + 'TPM_RIGHTALIGN', + 'TPM_RIGHTBUTTON', + 'TPM_TOPALIGN', + 'TPM_VCENTERALIGN'] import typing import win32typing """""" -def EnumFontFamilies(hdc:'int',Family:'typing.Union[str]',EnumFontFamProc:'typing.Any',Param:'typing.Any') -> 'typing.Any': +def EnumFontFamilies( + hdc: 'int', + Family: 'typing.Union[str]', + EnumFontFamProc: 'typing.Any', + Param: 'typing.Any') -> 'typing.Any': """ Enumerates the available font families. @@ -23,7 +413,7 @@ Returns: pass -def set_logger(logger:'typing.Any') -> 'None': +def set_logger(logger: 'typing.Any') -> 'None': """ Sets a logger object for exceptions and error information @@ -55,7 +445,7 @@ Returns: pass -def CreateFontIndirect(lplf:'win32typing.PyLOGFONT') -> 'typing.Any': +def CreateFontIndirect(lplf: 'win32typing.PyLOGFONT') -> 'typing.Any': """ function creates a logical font that has the specified characteristics. @@ -73,7 +463,7 @@ Returns: pass -def GetObject(handle:'int') -> 'typing.Any': +def GetObject(handle: 'int') -> 'typing.Any': """ Returns a struct containing the parameters used to create a GDI object @@ -89,7 +479,7 @@ Returns: pass -def GetObjectType(h:'int') -> 'typing.Any': +def GetObjectType(h: 'int') -> 'typing.Any': """ Returns the type (OBJ_* constant) of a GDI handle @@ -105,7 +495,7 @@ Returns: pass -def PyGetMemory(addr:'typing.Any',_len:'typing.Any') -> 'typing.Any': +def PyGetMemory(addr: 'typing.Any', _len: 'typing.Any') -> 'typing.Any': """ Returns a buffer object from and address and length @@ -122,7 +512,7 @@ Returns: pass -def PyGetString(addr:'typing.Any',_len:'typing.Any') -> 'str': +def PyGetString(addr: 'typing.Any', _len: 'typing.Any') -> 'str': """ Returns a string from an address. @@ -142,7 +532,7 @@ string must be NULL terminated.Return ValueIf win32gui.UNICODE is True, this wil pass -def PySetString(addr:'typing.Any',String:'typing.Any',maxLen:'typing.Any') -> 'typing.Any': +def PySetString(addr: 'typing.Any', String: 'typing.Any', maxLen: 'typing.Any') -> 'typing.Any': """ None @@ -160,7 +550,7 @@ Returns: pass -def PySetMemory(addr:'typing.Any',String:'typing.Any') -> 'typing.Any': +def PySetMemory(addr: 'typing.Any', String: 'typing.Any') -> 'typing.Any': """ Copies bytes to an address. @@ -177,7 +567,7 @@ Returns: pass -def PyGetArraySignedLong(array:'typing.Any',index:'typing.Any') -> 'typing.Any': +def PyGetArraySignedLong(array: 'typing.Any', index: 'typing.Any') -> 'typing.Any': """ Returns a signed long from an array object at specified index @@ -194,7 +584,7 @@ Returns: pass -def PyGetBufferAddressAndLen(obj:'typing.Any') -> 'typing.Any': +def PyGetBufferAddressAndLen(obj: 'typing.Any') -> 'typing.Any': """ Returns a buffer object address and len @@ -210,7 +600,7 @@ Returns: pass -def FlashWindow(hwnd:'int',bInvert:'typing.Any') -> 'typing.Any': +def FlashWindow(hwnd: 'int', bInvert: 'typing.Any') -> 'typing.Any': """ The FlashWindow function flashes the specified window one time. It does not change the active state of the window. @@ -227,7 +617,7 @@ Returns: pass -def FlashWindowEx(hwnd:'int',dwFlags:'typing.Any',uCount:'typing.Any',dwTimeout:'typing.Any') -> 'typing.Any': +def FlashWindowEx(hwnd: 'int', dwFlags: 'typing.Any', uCount: 'typing.Any', dwTimeout: 'typing.Any') -> 'typing.Any': """ The FlashWindowEx function flashes the specified window a specified number of times. @@ -246,7 +636,7 @@ Returns: pass -def GetWindowLong(hwnd:'int',index:'typing.Any') -> 'typing.Any': +def GetWindowLong(hwnd: 'int', index: 'typing.Any') -> 'typing.Any': """ None @@ -263,7 +653,7 @@ Returns: pass -def GetClassLong(hwnd:'int',index:'typing.Any') -> 'typing.Any': +def GetClassLong(hwnd: 'int', index: 'typing.Any') -> 'typing.Any': """ None @@ -280,7 +670,7 @@ Returns: pass -def SetWindowLong(hwnd:'int',index:'typing.Any',value:'typing.Any') -> 'typing.Any': +def SetWindowLong(hwnd: 'int', index: 'typing.Any', value: 'typing.Any') -> 'typing.Any': """ Places a long value at the specified offset into the extra window memory of the given window. @@ -298,7 +688,12 @@ Returns: pass -def CallWindowProc(wndproc:'typing.Any',hwnd:'int',msg:'typing.Any',wparam:'typing.Union[typing.Any]',lparam:'typing.Union[typing.Any]') -> 'typing.Any': +def CallWindowProc( + wndproc: 'typing.Any', + hwnd: 'int', + msg: 'typing.Any', + wparam: 'typing.Union[typing.Any]', + lparam: 'typing.Union[typing.Any]') -> 'typing.Any': """ None @@ -318,7 +713,11 @@ Returns: pass -def SendMessage(hwnd:'int',message:'typing.Any',wparam:'typing.Union[typing.Any]'=None,lparam:'typing.Union[typing.Any]'=None) -> 'typing.Any': +def SendMessage( + hwnd: 'int', + message: 'typing.Any', + wparam: 'typing.Union[typing.Any]' = None, + lparam: 'typing.Union[typing.Any]' = None) -> 'typing.Any': """ Sends a message to the window. @@ -337,7 +736,13 @@ Returns: pass -def SendMessageTimeout(hwnd:'int',message:'typing.Any',wparam:'typing.Any',lparam:'typing.Any',flags:'typing.Any',timeout:'typing.Any') -> 'tuple[typing.Any, typing.Any]': +def SendMessageTimeout( + hwnd: 'int', + message: 'typing.Any', + wparam: 'typing.Any', + lparam: 'typing.Any', + flags: 'typing.Any', + timeout: 'typing.Any') -> 'tuple[typing.Any, typing.Any]': """ Sends a message to the window. @@ -363,7 +768,7 @@ with zero as the error code. See the Microsoft documentation for more informati pass -def PostMessage(hwnd:'int',message:'typing.Any',wparam:'typing.Any'=0,lparam:'typing.Any'=0) -> 'None': +def PostMessage(hwnd: 'int', message: 'typing.Any', wparam: 'typing.Any' = 0, lparam: 'typing.Any' = 0) -> 'None': """ None @@ -382,7 +787,11 @@ Returns: pass -def PostThreadMessage(threadId:'typing.Any',message:'typing.Any',wparam:'typing.Any',lparam:'typing.Any') -> 'None': +def PostThreadMessage( + threadId: 'typing.Any', + message: 'typing.Any', + wparam: 'typing.Any', + lparam: 'typing.Any') -> 'None': """ None @@ -401,7 +810,7 @@ Returns: pass -def ReplyMessage(result:'typing.Any') -> 'typing.Any': +def ReplyMessage(result: 'typing.Any') -> 'typing.Any': """ Used to reply to a message sent through the SendMessage function without returning control to the function that called SendMessage. @@ -417,7 +826,7 @@ Returns: pass -def RegisterWindowMessage(name:'typing.Union[str, typing.Any]') -> 'typing.Any': +def RegisterWindowMessage(name: 'typing.Union[str, typing.Any]') -> 'typing.Any': """ Defines a new window message that is guaranteed to be unique throughout the system. The message value can be used when sending or posting messages. @@ -433,7 +842,7 @@ Returns: pass -def DefWindowProc(hwnd:'int',message:'typing.Any',wparam:'typing.Any',lparam:'typing.Any') -> 'typing.Any': +def DefWindowProc(hwnd: 'int', message: 'typing.Any', wparam: 'typing.Any', lparam: 'typing.Any') -> 'typing.Any': """ None @@ -452,7 +861,7 @@ Returns: pass -def EnumWindows(callback:'typing.Any',extra:'typing.Any') -> 'None': +def EnumWindows(callback: 'typing.Any', extra: 'typing.Any') -> 'None': """ Enumerates all top-level windows on the screen by passing the handle to each window, in turn, to an application-defined callback function. @@ -469,7 +878,7 @@ Returns: pass -def EnumThreadWindows(dwThreadId:'typing.Any',callback:'typing.Any',extra:'typing.Any') -> 'None': +def EnumThreadWindows(dwThreadId: 'typing.Any', callback: 'typing.Any', extra: 'typing.Any') -> 'None': """ Enumerates all top-level windows associated with a thread on the screen by passing the handle to each window, in turn, to an application-defined callback function. EnumThreadWindows continues until the last top-level window associated with the thread is enumerated or the callback function returns FALSE @@ -487,7 +896,7 @@ Returns: pass -def EnumChildWindows(hwnd:'int',callback:'typing.Any',extra:'typing.Any') -> 'None': +def EnumChildWindows(hwnd: 'int', callback: 'typing.Any', extra: 'typing.Any') -> 'None': """ Enumerates the child windows that belong to the specified parent window by passing the handle to each child window, in turn, to an application-defined callback function. EnumChildWindows continues until the last child window is enumerated or the callback function returns FALSE. @@ -505,7 +914,12 @@ Returns: pass -def DialogBox(hInstance:'int',TemplateName:'win32typing.PyResourceId',hWndParent:'int',DialogFunc:'typing.Any',InitParam:'typing.Any'=0) -> 'typing.Any': +def DialogBox( + hInstance: 'int', + TemplateName: 'win32typing.PyResourceId', + hWndParent: 'int', + DialogFunc: 'typing.Any', + InitParam: 'typing.Any' = 0) -> 'typing.Any': """ Creates a modal dialog box. @@ -541,7 +955,12 @@ Returns: pass -def DialogBoxIndirect(hInstance:'int',controlList:'win32typing.PyDialogTemplate',hWndParent:'int',DialogFunc:'typing.Any',InitParam:'typing.Any'=0) -> 'typing.Any': +def DialogBoxIndirect( + hInstance: 'int', + controlList: 'win32typing.PyDialogTemplate', + hWndParent: 'int', + DialogFunc: 'typing.Any', + InitParam: 'typing.Any' = 0) -> 'typing.Any': """ None @@ -577,7 +996,12 @@ Returns: pass -def CreateDialogIndirect(hInstance:'int',controlList:'win32typing.PyDialogTemplate',hWndParent:'int',DialogFunc:'typing.Any',InitParam:'typing.Any'=0) -> 'typing.Any': +def CreateDialogIndirect( + hInstance: 'int', + controlList: 'win32typing.PyDialogTemplate', + hWndParent: 'int', + DialogFunc: 'typing.Any', + InitParam: 'typing.Any' = 0) -> 'typing.Any': """ None @@ -597,23 +1021,7 @@ Returns: pass -def DialogBoxIndirectParam() -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -def EndDialog(hwnd:'int',result:'typing.Any') -> 'None': +def EndDialog(hwnd: 'int', result: 'typing.Any') -> 'None': """ Ends a dialog box. @@ -630,7 +1038,7 @@ Returns: pass -def GetDlgItem(hDlg:'int',IDDlgItem:'typing.Any') -> 'typing.Any': +def GetDlgItem(hDlg: 'int', IDDlgItem: 'typing.Any') -> 'typing.Any': """ Retrieves the handle to a control in the specified dialog box. @@ -647,7 +1055,7 @@ Returns: pass -def GetDlgItemInt(hDlg:'int',IDDlgItem:'typing.Any',Signed:'typing.Any') -> 'None': +def GetDlgItemInt(hDlg: 'int', IDDlgItem: 'typing.Any', Signed: 'typing.Any') -> 'None': """ Returns the integer value of a dialog control @@ -665,7 +1073,7 @@ Returns: pass -def SetDlgItemInt(hDlg:'int',IDDlgItem:'typing.Any',Value:'typing.Any',Signed:'typing.Any') -> 'None': +def SetDlgItemInt(hDlg: 'int', IDDlgItem: 'typing.Any', Value: 'typing.Any', Signed: 'typing.Any') -> 'None': """ Places an integer value in a dialog control @@ -684,7 +1092,7 @@ Returns: pass -def GetDlgCtrlID(hwnd:'int') -> 'typing.Any': +def GetDlgCtrlID(hwnd: 'int') -> 'typing.Any': """ Retrieves the identifier of the specified control. @@ -700,7 +1108,7 @@ Returns: pass -def GetDlgItemText(hDlg:'int',IDDlgItem:'typing.Any') -> 'str': +def GetDlgItemText(hDlg: 'int', IDDlgItem: 'typing.Any') -> 'str': """ Returns the text of a dialog control @@ -717,7 +1125,7 @@ Returns: pass -def SetDlgItemText(hDlg:'int',IDDlgItem:'typing.Any',String:'typing.Union[typing.Any]') -> 'None': +def SetDlgItemText(hDlg: 'int', IDDlgItem: 'typing.Any', String: 'typing.Union[typing.Any]') -> 'None': """ Sets the text for a window or control @@ -735,7 +1143,7 @@ Returns: pass -def GetNextDlgTabItem(hDlg:'typing.Any',hCtl:'typing.Any',bPrevious:'typing.Any') -> 'typing.Any': +def GetNextDlgTabItem(hDlg: 'typing.Any', hCtl: 'typing.Any', bPrevious: 'typing.Any') -> 'typing.Any': """ Retrieves a handle to the first control that has the WS_TABSTOP style that precedes (or follows) the specified control. @@ -753,7 +1161,7 @@ Returns: pass -def GetNextDlgGroupItem(hDlg:'typing.Any',hCtl:'typing.Any',bPrevious:'typing.Any') -> 'typing.Any': +def GetNextDlgGroupItem(hDlg: 'typing.Any', hCtl: 'typing.Any', bPrevious: 'typing.Any') -> 'typing.Any': """ Retrieves a handle to the first control in a group of controls that precedes (or follows) the specified control in a dialog box. @@ -787,7 +1195,7 @@ Returns: pass -def GetWindowText(hwnd:'int') -> 'str': +def GetWindowText(hwnd: 'int') -> 'str': """ Get the window text. @@ -819,7 +1227,7 @@ Returns: pass -def InitCommonControlsEx(flag:'typing.Any') -> 'None': +def InitCommonControlsEx(flag: 'typing.Any') -> 'None': """ Initializes specific common controls. @@ -835,7 +1243,7 @@ Returns: pass -def LoadCursor(hinstance:'typing.Any',resid:'typing.Any') -> 'typing.Any': +def LoadCursor(hinstance: 'typing.Any', resid: 'typing.Any') -> 'typing.Any': """ Loads a cursor. @@ -852,7 +1260,7 @@ Returns: pass -def SetCursor(hcursor:'typing.Any') -> 'typing.Any': +def SetCursor(hcursor: 'typing.Any') -> 'typing.Any': """ None @@ -900,7 +1308,7 @@ Returns: pass -def CreateAcceleratorTable(accels:'tuple[tuple[typing.Any, typing.Any, typing.Any], ...]') -> 'typing.Any': +def CreateAcceleratorTable(accels: 'tuple[tuple[typing.Any, typing.Any, typing.Any], ...]') -> 'typing.Any': """ Creates an accelerator table @@ -916,7 +1324,7 @@ Returns: pass -def DestroyAccleratorTable(haccel:'typing.Any') -> 'None': +def DestroyAccleratorTable(haccel: 'typing.Any') -> 'None': """ Destroys an accelerator table @@ -932,7 +1340,7 @@ Returns: pass -def LoadMenu(hinstance:'typing.Any',resource_id:'typing.Union[str, typing.Any]') -> 'typing.Any': +def LoadMenu(hinstance: 'typing.Any', resource_id: 'typing.Union[str, typing.Any]') -> 'typing.Any': """ Loads a menu @@ -965,7 +1373,7 @@ Returns: pass -def SetMenu(hwnd:'int',hmenu:'typing.Any') -> 'None': +def SetMenu(hwnd: 'int', hmenu: 'typing.Any') -> 'None': """ Sets the menu for the specified window. @@ -998,7 +1406,7 @@ Returns: pass -def LoadIcon(hinstance:'typing.Any',resource_id:'typing.Union[str, typing.Any]') -> 'typing.Any': +def LoadIcon(hinstance: 'typing.Any', resource_id: 'typing.Union[str, typing.Any]') -> 'typing.Any': """ Loads an icon @@ -1015,7 +1423,7 @@ Returns: pass -def CopyIcon(hicon:'typing.Any') -> 'typing.Any': +def CopyIcon(hicon: 'typing.Any') -> 'typing.Any': """ Copies an icon @@ -1031,7 +1439,7 @@ Returns: pass -def DrawIcon(hDC:'typing.Any',X:'typing.Any',Y:'typing.Any',hicon:'typing.Any') -> 'None': +def DrawIcon(hDC: 'typing.Any', X: 'typing.Any', Y: 'typing.Any', hicon: 'typing.Any') -> 'None': """ None @@ -1050,7 +1458,16 @@ Returns: pass -def DrawIconEx(hDC:'typing.Any',xLeft:'typing.Any',yTop:'typing.Any',hIcon:'typing.Any',cxWidth:'typing.Any',cyWidth:'typing.Any',istepIfAniCur:'typing.Any',hbrFlickerFreeDraw:'win32typing.PyGdiHANDLE',diFlags:'typing.Any') -> 'None': +def DrawIconEx( + hDC: 'typing.Any', + xLeft: 'typing.Any', + yTop: 'typing.Any', + hIcon: 'typing.Any', + cxWidth: 'typing.Any', + cyWidth: 'typing.Any', + istepIfAniCur: 'typing.Any', + hbrFlickerFreeDraw: 'win32typing.PyGdiHANDLE', + diFlags: 'typing.Any') -> 'None': """ Draws an icon or cursor into the specified device context, @@ -1078,7 +1495,7 @@ Returns: pass -def CreateIconIndirect(iconinfo:'win32typing.PyICONINFO') -> 'typing.Any': +def CreateIconIndirect(iconinfo: 'win32typing.PyICONINFO') -> 'typing.Any': """ Creates an icon or cursor from an ICONINFO structure. @@ -1094,7 +1511,7 @@ Returns: pass -def CreateIconFromResource(bits:'str',fIcon:'typing.Any',ver:'typing.Any'=0x00030000) -> 'int': +def CreateIconFromResource(bits: 'str', fIcon: 'typing.Any', ver: 'typing.Any' = 0x00030000) -> 'int': """ Creates an icon or cursor from resource bits describing the icon. @@ -1112,7 +1529,13 @@ Returns: pass -def LoadImage(hinst:'typing.Any',name:'typing.Union[str, typing.Any]',_type:'typing.Any',cxDesired:'typing.Any',cyDesired:'typing.Any',fuLoad:'typing.Any') -> 'typing.Any': +def LoadImage( + hinst: 'typing.Any', + name: 'typing.Union[str, typing.Any]', + _type: 'typing.Any', + cxDesired: 'typing.Any', + cyDesired: 'typing.Any', + fuLoad: 'typing.Any') -> 'typing.Any': """ Loads a bitmap, cursor or icon @@ -1133,7 +1556,7 @@ Returns: pass -def DeleteObject(handle:'win32typing.PyGdiHANDLE') -> 'None': +def DeleteObject(handle: 'win32typing.PyGdiHANDLE') -> 'None': """ Deletes a logical pen, brush, font, bitmap, region, or palette, freeing all system resources associated with the object. After the object is deleted, the specified handle is no longer valid. @@ -1149,7 +1572,16 @@ Returns: pass -def BitBlt(hdcDest:'typing.Any',x:'typing.Any',y:'typing.Any',width:'typing.Any',height:'typing.Any',hdcSrc:'typing.Any',nXSrc:'typing.Any',nYSrc:'typing.Any',dwRop:'typing.Any') -> 'None': +def BitBlt( + hdcDest: 'typing.Any', + x: 'typing.Any', + y: 'typing.Any', + width: 'typing.Any', + height: 'typing.Any', + hdcSrc: 'typing.Any', + nXSrc: 'typing.Any', + nYSrc: 'typing.Any', + dwRop: 'typing.Any') -> 'None': """ Performs a bit-block transfer of the color data corresponding @@ -1177,7 +1609,18 @@ Returns: pass -def StretchBlt(hdcDest:'typing.Any',x:'typing.Any',y:'typing.Any',width:'typing.Any',height:'typing.Any',hdcSrc:'typing.Any',nXSrc:'typing.Any',nYSrc:'typing.Any',nWidthSrc:'typing.Any',nHeightSrc:'typing.Any',dwRop:'typing.Any') -> 'None': +def StretchBlt( + hdcDest: 'typing.Any', + x: 'typing.Any', + y: 'typing.Any', + width: 'typing.Any', + height: 'typing.Any', + hdcSrc: 'typing.Any', + nXSrc: 'typing.Any', + nYSrc: 'typing.Any', + nWidthSrc: 'typing.Any', + nHeightSrc: 'typing.Any', + dwRop: 'typing.Any') -> 'None': """ Copies a bitmap from a source rectangle into a destination @@ -1207,7 +1650,13 @@ Returns: pass -def PatBlt(hdc:'int',XLeft:'typing.Any',YLeft:'typing.Any',Width:'typing.Any',Height:'typing.Any',Rop:'typing.Any') -> 'None': +def PatBlt( + hdc: 'int', + XLeft: 'typing.Any', + YLeft: 'typing.Any', + Width: 'typing.Any', + Height: 'typing.Any', + Rop: 'typing.Any') -> 'None': """ Paints a rectangle by combining the current brush with existing colors @@ -1228,7 +1677,7 @@ Returns: pass -def SetStretchBltMode(hdc:'int',StretchMode:'typing.Any') -> 'typing.Any': +def SetStretchBltMode(hdc: 'int', StretchMode: 'typing.Any') -> 'typing.Any': """ None @@ -1248,7 +1697,7 @@ If the function fails, the return value is zero. pass -def GetStretchBltMode(hdc:'int') -> 'typing.Any': +def GetStretchBltMode(hdc: 'int') -> 'typing.Any': """ None @@ -1265,7 +1714,18 @@ Returns: pass -def TransparentBlt(Dest:'int',XOriginDest:'typing.Any',YOriginDest:'typing.Any',WidthDest:'typing.Any',HeightDest:'typing.Any',Src:'int',XOriginSrc:'typing.Any',YOriginSrc:'typing.Any',WidthSrc:'typing.Any',HeightSrc:'typing.Any',Transparent:'typing.Any') -> 'None': +def TransparentBlt( + Dest: 'int', + XOriginDest: 'typing.Any', + YOriginDest: 'typing.Any', + WidthDest: 'typing.Any', + HeightDest: 'typing.Any', + Src: 'int', + XOriginSrc: 'typing.Any', + YOriginSrc: 'typing.Any', + WidthSrc: 'typing.Any', + HeightSrc: 'typing.Any', + Transparent: 'typing.Any') -> 'None': """ Transfers color from one DC to another, with one color treated as transparent @@ -1291,7 +1751,19 @@ Returns: pass -def MaskBlt(Dest:'int',XDest:'typing.Any',YDest:'typing.Any',Width:'typing.Any',Height:'typing.Any',Src:'int',XSrc:'typing.Any',YSrc:'typing.Any',Mask:'win32typing.PyGdiHANDLE',xMask:'typing.Any',yMask:'typing.Any',Rop:'typing.Any') -> 'None': +def MaskBlt( + Dest: 'int', + XDest: 'typing.Any', + YDest: 'typing.Any', + Width: 'typing.Any', + Height: 'typing.Any', + Src: 'int', + XSrc: 'typing.Any', + YSrc: 'typing.Any', + Mask: 'win32typing.PyGdiHANDLE', + xMask: 'typing.Any', + yMask: 'typing.Any', + Rop: 'typing.Any') -> 'None': """ Combines the color data for the source and destination @@ -1320,7 +1792,18 @@ Returns: pass -def AlphaBlend(Dest:'int',XOriginDest:'typing.Any',YOriginDest:'typing.Any',WidthDest:'typing.Any',HeightDest:'typing.Any',Src:'int',XOriginSrc:'typing.Any',YOriginSrc:'typing.Any',WidthSrc:'typing.Any',HeightSrc:'typing.Any',blendFunction:'win32typing.PyBLENDFUNCTION') -> 'None': +def AlphaBlend( + Dest: 'int', + XOriginDest: 'typing.Any', + YOriginDest: 'typing.Any', + WidthDest: 'typing.Any', + HeightDest: 'typing.Any', + Src: 'int', + XOriginSrc: 'typing.Any', + YOriginSrc: 'typing.Any', + WidthSrc: 'typing.Any', + HeightSrc: 'typing.Any', + blendFunction: 'win32typing.PyBLENDFUNCTION') -> 'None': """ Transfers color information using alpha blending @@ -1346,7 +1829,8 @@ Returns: pass -def ImageList_Add(himl:'typing.Any',hbmImage:'win32typing.PyGdiHANDLE',hbmMask:'win32typing.PyGdiHANDLE') -> 'typing.Any': +def ImageList_Add(himl: 'typing.Any', hbmImage: 'win32typing.PyGdiHANDLE', + hbmMask: 'win32typing.PyGdiHANDLE') -> 'typing.Any': """ Adds an image or images to an image list. @@ -1557,7 +2041,7 @@ Returns: pass -def ImageList_SetOverlayImage(hImageList:'typing.Any',iImage:'typing.Any',iOverlay:'typing.Any') -> 'None': +def ImageList_SetOverlayImage(hImageList: 'typing.Any', iImage: 'typing.Any', iOverlay: 'typing.Any') -> 'None': """ Adds a specified image to the list of images to be used as overlay masks. An image list can have up to four overlay masks in version 4.70 and earlier and up to 15 in version 4.71. The function assigns an overlay mask index to the specified image. @@ -1575,7 +2059,11 @@ Returns: pass -def MessageBox(parent:'typing.Any',text:'typing.Union[str]',caption:'typing.Union[str]',flags:'typing.Any') -> 'typing.Any': +def MessageBox( + parent: 'typing.Any', + text: 'typing.Union[str]', + caption: 'typing.Union[str]', + flags: 'typing.Any') -> 'typing.Any': """ Displays a message box @@ -1594,7 +2082,7 @@ Returns: pass -def MessageBeep(_type:'typing.Any') -> 'None': +def MessageBeep(_type: 'typing.Any') -> 'None': """ Plays a waveform sound. @@ -1610,7 +2098,18 @@ Returns: pass -def CreateWindow(className:'typing.Union[str, typing.Any]',windowTitle:'str',style:'typing.Any',x:'typing.Any',y:'typing.Any',width:'typing.Any',height:'typing.Any',parent:'typing.Any',menu:'typing.Any',hinstance:'typing.Any',reserved:'typing.Any') -> 'typing.Any': +def CreateWindow( + className: 'typing.Union[str, typing.Any]', + windowTitle: 'str', + style: 'typing.Any', + x: 'typing.Any', + y: 'typing.Any', + width: 'typing.Any', + height: 'typing.Any', + parent: 'typing.Any', + menu: 'typing.Any', + hinstance: 'typing.Any', + reserved: 'typing.Any') -> 'typing.Any': """ Creates a new window. @@ -1636,7 +2135,7 @@ Returns: pass -def DestroyWindow(hwnd:'int') -> 'None': +def DestroyWindow(hwnd: 'int') -> 'None': """ None @@ -1652,7 +2151,7 @@ Returns: pass -def EnableWindow(hWnd:'int',bEnable:'typing.Any') -> 'typing.Any': +def EnableWindow(hWnd: 'int', bEnable: 'typing.Any') -> 'typing.Any': """ Enables and disables keyboard and mouse input to a window @@ -1670,7 +2169,7 @@ Returns: pass -def FindWindow(ClassName:'win32typing.PyResourceId',WindowName:'str') -> 'int': +def FindWindow(ClassName: 'win32typing.PyResourceId', WindowName: 'str') -> 'int': """ Retrieves a handle to the top-level window whose class name and window name match the specified strings. @@ -1687,7 +2186,7 @@ Returns: pass -def FindWindowEx(Parent:'int',ChildAfter:'int',ClassName:'win32typing.PyResourceId',WindowName:'str') -> 'int': +def FindWindowEx(Parent: 'int', ChildAfter: 'int', ClassName: 'win32typing.PyResourceId', WindowName: 'str') -> 'int': """ Retrieves a handle to the top-level window whose class name and window name match the specified strings. @@ -1706,7 +2205,7 @@ Returns: pass -def DragAcceptFiles(hwnd:'int',fAccept:'typing.Any') -> 'None': +def DragAcceptFiles(hwnd: 'int', fAccept: 'typing.Any') -> 'None': """ Registers whether a window accepts dropped files. @@ -1723,7 +2222,7 @@ Returns: pass -def DragDetect(hwnd:'int',point:'tuple[typing.Any, typing.Any]') -> 'None': +def DragDetect(hwnd: 'int', point: 'tuple[typing.Any, typing.Any]') -> 'None': """ captures the mouse and tracks its movement until the user releases the left button, presses the ESC key, or moves the mouse outside the drag rectangle around the specified point. @@ -1743,7 +2242,7 @@ If the user did not move the mouse outside of the drag rectangle while holding d pass -def SetDoubleClickTime(newVal:'typing.Any') -> 'None': +def SetDoubleClickTime(newVal: 'typing.Any') -> 'None': """ None @@ -1775,7 +2274,7 @@ Returns: pass -def HideCaret(hWnd:'int') -> 'None': +def HideCaret(hWnd: 'int') -> 'None': """ Hides the caret @@ -1791,7 +2290,7 @@ Returns: pass -def SetCaretPos(x:'typing.Any',y:'typing.Any') -> 'None': +def SetCaretPos(x: 'typing.Any', y: 'typing.Any') -> 'None': """ Changes the position of the caret @@ -1824,7 +2323,7 @@ Returns: pass -def ShowCaret(hWnd:'int') -> 'None': +def ShowCaret(hWnd: 'int') -> 'None': """ Shows the caret at its current position @@ -1840,7 +2339,7 @@ Returns: pass -def ShowWindow(hWnd:'typing.Any',cmdShow:'typing.Any') -> 'typing.Any': +def ShowWindow(hWnd: 'typing.Any', cmdShow: 'typing.Any') -> 'typing.Any': """ Shows or hides a window and changes its state @@ -1857,7 +2356,7 @@ Returns: pass -def IsWindowVisible(hwnd:'int') -> 'typing.Any': +def IsWindowVisible(hwnd: 'int') -> 'typing.Any': """ Indicates if the window has the WS_VISIBLE style. @@ -1873,7 +2372,7 @@ Returns: pass -def IsWindowEnabled(hwnd:'int') -> 'typing.Any': +def IsWindowEnabled(hwnd: 'int') -> 'typing.Any': """ Indicates if the window is enabled. @@ -1889,7 +2388,7 @@ Returns: pass -def SetFocus(hwnd:'int') -> 'None': +def SetFocus(hwnd: 'int') -> 'None': """ Sets focus to the specified window. @@ -1921,7 +2420,7 @@ Returns: pass -def UpdateWindow(hwnd:'int') -> 'None': +def UpdateWindow(hwnd: 'int') -> 'None': """ None @@ -1937,7 +2436,7 @@ Returns: pass -def BringWindowToTop(hwnd:'int') -> 'None': +def BringWindowToTop(hwnd: 'int') -> 'None': """ None @@ -1953,7 +2452,7 @@ Returns: pass -def SetActiveWindow(hwnd:'int') -> 'typing.Any': +def SetActiveWindow(hwnd: 'int') -> 'typing.Any': """ None @@ -1985,7 +2484,7 @@ Returns: pass -def SetForegroundWindow(hwnd:'int') -> 'typing.Any': +def SetForegroundWindow(hwnd: 'int') -> 'typing.Any': """ None @@ -2017,7 +2516,7 @@ Returns: pass -def GetClientRect(hwnd:'int') -> 'tuple[int, int, int, int]': +def GetClientRect(hwnd: 'int') -> 'tuple[int, int, int, int]': """ Returns the rectangle of the client area of a window, in client coordinates @@ -2033,7 +2532,7 @@ Returns: pass -def GetDC(hwnd:'int') -> 'typing.Any': +def GetDC(hwnd: 'int') -> 'typing.Any': """ Gets the device context for the window. @@ -2049,7 +2548,7 @@ Returns: pass -def SaveDC(hdc:'int') -> 'typing.Any': +def SaveDC(hdc: 'int') -> 'typing.Any': """ Save the state of a device context @@ -2066,7 +2565,7 @@ Returns: pass -def RestoreDC(hdc:'int',SavedDC:'typing.Any') -> 'None': +def RestoreDC(hdc: 'int', SavedDC: 'typing.Any') -> 'None': """ Restores a device context state @@ -2083,7 +2582,7 @@ Returns: pass -def DeleteDC(hdc:'typing.Any') -> 'None': +def DeleteDC(hdc: 'typing.Any') -> 'None': """ Deletes a DC @@ -2099,7 +2598,7 @@ Returns: pass -def CreateCompatibleDC(dc:'typing.Any') -> 'typing.Any': +def CreateCompatibleDC(dc: 'typing.Any') -> 'typing.Any': """ Creates a memory device context (DC) compatible with the specified device. @@ -2115,7 +2614,7 @@ Returns: pass -def CreateCompatibleBitmap(hdc:'typing.Any',width:'typing.Any',height:'typing.Any') -> 'win32typing.PyGdiHANDLE': +def CreateCompatibleBitmap(hdc: 'typing.Any', width: 'typing.Any', height: 'typing.Any') -> 'win32typing.PyGdiHANDLE': """ Creates a bitmap compatible with the device that is associated with the specified device context. @@ -2133,7 +2632,12 @@ Returns: pass -def CreateBitmap(width:'typing.Any',height:'typing.Any',cPlanes:'typing.Any',cBitsPerPixel:'typing.Any',bitmap_bits:'typing.Any') -> 'win32typing.PyGdiHANDLE': +def CreateBitmap( + width: 'typing.Any', + height: 'typing.Any', + cPlanes: 'typing.Any', + cBitsPerPixel: 'typing.Any', + bitmap_bits: 'typing.Any') -> 'win32typing.PyGdiHANDLE': """ Creates a bitmap @@ -2153,7 +2657,7 @@ Returns: pass -def SelectObject(hdc:'typing.Any',_object:'typing.Any') -> 'typing.Any': +def SelectObject(hdc: 'typing.Any', _object: 'typing.Any') -> 'typing.Any': """ Selects an object into the specified device context (DC). The new object replaces the previous object of the same type. @@ -2170,7 +2674,7 @@ Returns: pass -def GetCurrentObject(hdc:'int',ObjectType:'typing.Any') -> 'int': +def GetCurrentObject(hdc: 'int', ObjectType: 'typing.Any') -> 'int': """ Retrieves currently selected object from a DC @@ -2187,7 +2691,7 @@ Returns: pass -def GetWindowRect(hwnd:'int') -> 'tuple[int, int, int, int]': +def GetWindowRect(hwnd: 'int') -> 'tuple[int, int, int, int]': """ Returns the rectangle for a window in screen coordinates @@ -2203,7 +2707,7 @@ Returns: pass -def GetStockObject(Object:'typing.Any') -> 'int': +def GetStockObject(Object: 'typing.Any') -> 'int': """ Creates a handle to one of the standard system Gdi objects @@ -2219,7 +2723,7 @@ Returns: pass -def PostQuitMessage(rc:'typing.Any') -> 'None': +def PostQuitMessage(rc: 'typing.Any') -> 'None': """ None @@ -2251,7 +2755,14 @@ Returns: pass -def SetWindowPos(hWnd:'int',InsertAfter:'int',X:'typing.Any',Y:'typing.Any',cx:'typing.Any',cy:'typing.Any',Flags:'typing.Any') -> 'None': +def SetWindowPos( + hWnd: 'int', + InsertAfter: 'int', + X: 'typing.Any', + Y: 'typing.Any', + cx: 'typing.Any', + cy: 'typing.Any', + Flags: 'typing.Any') -> 'None': """ Sets the position and size of a window @@ -2310,7 +2821,7 @@ normalposSpecifies the window's coordinates when the window is in the restored p pass -def SetWindowPlacement(hWnd:'int',placement:'typing.Any') -> 'None': +def SetWindowPlacement(hWnd: 'int', placement: 'typing.Any') -> 'None': """ Sets the windows placement @@ -2327,7 +2838,7 @@ Returns: pass -def RegisterClass(wndClass:'win32typing.PyWNDCLASS') -> 'typing.Any': +def RegisterClass(wndClass: 'win32typing.PyWNDCLASS') -> 'typing.Any': """ Registers a window class. @@ -2343,7 +2854,7 @@ Returns: pass -def UnregisterClass(atom:'win32typing.PyResourceId',hinst:'int') -> 'None': +def UnregisterClass(atom: 'win32typing.PyResourceId', hinst: 'int') -> 'None': """ None @@ -2396,7 +2907,7 @@ Return ValueReturns non-zero (exit code from PostQuitMessage) if a WM_QUIT messa pass -def GetMessage(hwnd:'int',_min:'typing.Any',_max:'typing.Any') -> 'typing.Any': +def GetMessage(hwnd: 'int', _min: 'typing.Any', _max: 'typing.Any') -> 'typing.Any': """ None @@ -2414,7 +2925,7 @@ Returns: pass -def TranslateMessage(msg:'typing.Any') -> 'typing.Any': +def TranslateMessage(msg: 'typing.Any') -> 'typing.Any': """ None @@ -2430,7 +2941,7 @@ Returns: pass -def DispatchMessage(msg:'typing.Any') -> 'typing.Any': +def DispatchMessage(msg: 'typing.Any') -> 'typing.Any': """ None @@ -2446,7 +2957,7 @@ Returns: pass -def TranslateAccelerator(hwnd:'int',haccel:'typing.Any',msg:'typing.Any') -> 'typing.Any': +def TranslateAccelerator(hwnd: 'int', haccel: 'typing.Any', msg: 'typing.Any') -> 'typing.Any': """ None @@ -2464,7 +2975,11 @@ Returns: pass -def PeekMessage(hwnd:'int',filterMin:'typing.Any',filterMax:'typing.Any',removalOptions:'typing.Any') -> 'typing.Any': +def PeekMessage( + hwnd: 'int', + filterMin: 'typing.Any', + filterMax: 'typing.Any', + removalOptions: 'typing.Any') -> 'typing.Any': """ None @@ -2483,7 +2998,7 @@ Returns: pass -def Shell_NotifyIcon(Message:'typing.Any',nid:'win32typing.PyNOTIFYICONDATA') -> 'None': +def Shell_NotifyIcon(Message: 'typing.Any', nid: 'win32typing.PyNOTIFYICONDATA') -> 'None': """ Adds, removes or modifies a taskbar icon. @@ -2500,7 +3015,7 @@ Returns: pass -def GetSystemMenu(hwnd:'int',bRevert:'typing.Any') -> 'typing.Any': +def GetSystemMenu(hwnd: 'int', bRevert: 'typing.Any') -> 'typing.Any': """ None @@ -2518,7 +3033,7 @@ Returns: pass -def DrawMenuBar(hwnd:'int') -> 'None': +def DrawMenuBar(hwnd: 'int') -> 'None': """ None @@ -2534,7 +3049,13 @@ Returns: pass -def MoveWindow(hwnd:'int',x:'typing.Any',y:'typing.Any',width:'typing.Any',height:'typing.Any',bRepaint:'typing.Any') -> 'None': +def MoveWindow( + hwnd: 'int', + x: 'typing.Any', + y: 'typing.Any', + width: 'typing.Any', + height: 'typing.Any', + bRepaint: 'typing.Any') -> 'None': """ None @@ -2571,7 +3092,7 @@ Returns: pass -def DeleteMenu(hmenu:'typing.Any',position:'typing.Any',flags:'typing.Any') -> 'None': +def DeleteMenu(hmenu: 'typing.Any', position: 'typing.Any', flags: 'typing.Any') -> 'None': """ None @@ -2589,7 +3110,7 @@ Returns: pass -def RemoveMenu(hmenu:'typing.Any',position:'typing.Any',flags:'typing.Any') -> 'None': +def RemoveMenu(hmenu: 'typing.Any', position: 'typing.Any', flags: 'typing.Any') -> 'None': """ None @@ -2647,7 +3168,14 @@ Return ValueThe result is a HMENU to the new menu. pass -def TrackPopupMenu(hmenu:'typing.Any',flags:'typing.Any',x:'typing.Any',y:'typing.Any',reserved:'typing.Any',hwnd:'int',prcRect:'win32typing.PyRECT') -> 'typing.Any': +def TrackPopupMenu( + hmenu: 'typing.Any', + flags: 'typing.Any', + x: 'typing.Any', + y: 'typing.Any', + reserved: 'typing.Any', + hwnd: 'int', + prcRect: 'win32typing.PyRECT') -> 'typing.Any': """ Display popup shortcut menu @@ -2685,7 +3213,7 @@ Returns: pass -def ExtractIcon(hinstance:'typing.Any',moduleName:'typing.Union[str]',index:'typing.Any') -> 'typing.Any': +def ExtractIcon(hinstance: 'typing.Any', moduleName: 'typing.Union[str]', index: 'typing.Any') -> 'typing.Any': """ None @@ -2707,7 +3235,7 @@ Return ValueThe result is a HICON. pass -def ExtractIconEx(moduleName:'str',index:'typing.Any',numIcons:'typing.Any'=1) -> 'typing.Any': +def ExtractIconEx(moduleName: 'str', index: 'typing.Any', numIcons: 'typing.Any' = 1) -> 'typing.Any': """ None @@ -2732,7 +3260,7 @@ the file, otherwise it is 2 arrays of icon handles. pass -def DestroyIcon(hicon:'typing.Any') -> 'None': +def DestroyIcon(hicon: 'typing.Any') -> 'None': """ None @@ -2748,7 +3276,7 @@ Returns: pass -def GetIconInfo(hicon:'int') -> 'win32typing.PyICONINFO': +def GetIconInfo(hicon: 'int') -> 'win32typing.PyICONINFO': """ Returns parameters for an icon or cursor @@ -2767,7 +3295,7 @@ The hbmMask and hbmColor items are bitmaps created for the caller, so must be fr pass -def ScreenToClient(hWnd:'int',Point:'tuple[typing.Any, typing.Any]') -> 'tuple[typing.Any, typing.Any]': +def ScreenToClient(hWnd: 'int', Point: 'tuple[typing.Any, typing.Any]') -> 'tuple[typing.Any, typing.Any]': """ Convert screen coordinates to client coords @@ -2784,7 +3312,7 @@ Returns: pass -def ClientToScreen(hWnd:'int',Point:'tuple[typing.Any, typing.Any]') -> 'tuple[typing.Any, typing.Any]': +def ClientToScreen(hWnd: 'int', Point: 'tuple[typing.Any, typing.Any]') -> 'tuple[typing.Any, typing.Any]': """ Convert client coordinates to screen coords @@ -2801,7 +3329,7 @@ Returns: pass -def PaintDesktop(hdc:'int') -> 'None': +def PaintDesktop(hdc: 'int') -> 'None': """ Fills a DC with the destop background @@ -2817,7 +3345,11 @@ Returns: pass -def RedrawWindow(hWnd:'int',rcUpdate:'tuple[int, int, int, int]',hrgnUpdate:'win32typing.PyGdiHANDLE',flags:'typing.Any') -> 'None': +def RedrawWindow( + hWnd: 'int', + rcUpdate: 'tuple[int, int, int, int]', + hrgnUpdate: 'win32typing.PyGdiHANDLE', + flags: 'typing.Any') -> 'None': """ Causes a portion of a window to be redrawn @@ -2836,7 +3368,7 @@ Returns: pass -def GetTextExtentPoint32(hdc:'int',_str:'str') -> 'tuple[typing.Any, typing.Any]': +def GetTextExtentPoint32(hdc: 'int', _str: 'str') -> 'tuple[typing.Any, typing.Any]': """ Computes the width and height of the specified string of text. @@ -2869,7 +3401,7 @@ Returns: pass -def GetTextCharacterExtra(hdc:'int') -> 'typing.Any': +def GetTextCharacterExtra(hdc: 'int') -> 'typing.Any': """ Returns the space between characters @@ -2885,7 +3417,7 @@ Returns: pass -def SetTextCharacterExtra(hdc:'int',CharExtra:'typing.Any') -> 'typing.Any': +def SetTextCharacterExtra(hdc: 'int', CharExtra: 'typing.Any') -> 'typing.Any': """ Sets the spacing between characters @@ -2903,7 +3435,7 @@ Returns: pass -def GetTextAlign(hdc:'int') -> 'typing.Any': +def GetTextAlign(hdc: 'int') -> 'typing.Any': """ Returns horizontal and vertical alignment for text in a device context @@ -2920,7 +3452,7 @@ Returns: pass -def SetTextAlign(hdc:'int',Mode:'typing.Any') -> 'typing.Any': +def SetTextAlign(hdc: 'int', Mode: 'typing.Any') -> 'typing.Any': """ Sets horizontal and vertical alignment for text in a device context @@ -2938,7 +3470,7 @@ Returns: pass -def GetTextFace(hdc:'int') -> 'str': +def GetTextFace(hdc: 'int') -> 'str': """ Retrieves the name of the font currently selected in a DC @@ -2954,7 +3486,7 @@ Returns: pass -def GetMapMode(hdc:'int') -> 'typing.Any': +def GetMapMode(hdc: 'int') -> 'typing.Any': """ Returns the method a device context uses to translate logical units to physical units @@ -2971,7 +3503,7 @@ Returns: pass -def SetMapMode(hdc:'int',MapMode:'typing.Any') -> 'typing.Any': +def SetMapMode(hdc: 'int', MapMode: 'typing.Any') -> 'typing.Any': """ Sets the method used for translating logical units to device units @@ -2989,7 +3521,7 @@ Returns: pass -def GetGraphicsMode(hdc:'int') -> 'typing.Any': +def GetGraphicsMode(hdc: 'int') -> 'typing.Any': """ Determines if advanced GDI features are enabled for a device context @@ -3006,7 +3538,7 @@ Returns: pass -def SetGraphicsMode(hdc:'int',Mode:'typing.Any') -> 'typing.Any': +def SetGraphicsMode(hdc: 'int', Mode: 'typing.Any') -> 'typing.Any': """ Enables or disables advanced graphics features for a DC @@ -3024,7 +3556,7 @@ Returns: pass -def GetLayout(hdc:'int') -> 'typing.Any': +def GetLayout(hdc: 'int') -> 'typing.Any': """ Retrieves the layout mode of a device context @@ -3041,7 +3573,7 @@ Returns: pass -def SetLayout(hdc:'int',Layout:'typing.Any') -> 'typing.Any': +def SetLayout(hdc: 'int', Layout: 'typing.Any') -> 'typing.Any': """ Sets the layout for a device context @@ -3059,7 +3591,7 @@ Returns: pass -def GetPolyFillMode(hdc:'int') -> 'typing.Any': +def GetPolyFillMode(hdc: 'int') -> 'typing.Any': """ Returns the polygon filling mode for a device context @@ -3076,7 +3608,7 @@ Returns: pass -def SetPolyFillMode(hdc:'int',PolyFillMode:'typing.Any') -> 'typing.Any': +def SetPolyFillMode(hdc: 'int', PolyFillMode: 'typing.Any') -> 'typing.Any': """ Sets the polygon filling mode for a device context @@ -3094,7 +3626,7 @@ Returns: pass -def GetWorldTransform(hdc:'int') -> 'win32typing.PyXFORM': +def GetWorldTransform(hdc: 'int') -> 'win32typing.PyXFORM': """ Retrieves a device context's coordinate space translation matrix @@ -3110,7 +3642,7 @@ Returns: pass -def SetWorldTransform(hdc:'int',Xform:'win32typing.PyXFORM') -> 'None': +def SetWorldTransform(hdc: 'int', Xform: 'win32typing.PyXFORM') -> 'None': """ Transforms a device context's coordinate space @@ -3127,7 +3659,7 @@ Returns: pass -def ModifyWorldTransform(hdc:'int',Xform:'win32typing.PyXFORM',Mode:'typing.Any') -> 'None': +def ModifyWorldTransform(hdc: 'int', Xform: 'win32typing.PyXFORM', Mode: 'typing.Any') -> 'None': """ Combines a coordinate tranformation with device context's current transformation @@ -3145,7 +3677,7 @@ Returns: pass -def CombineTransform(xform1:'win32typing.PyXFORM',xform2:'win32typing.PyXFORM') -> 'win32typing.PyXFORM': +def CombineTransform(xform1: 'win32typing.PyXFORM', xform2: 'win32typing.PyXFORM') -> 'win32typing.PyXFORM': """ Combines two coordinate space transformations @@ -3162,7 +3694,7 @@ Returns: pass -def GetWindowOrgEx(hdc:'int') -> 'tuple[typing.Any, typing.Any]': +def GetWindowOrgEx(hdc: 'int') -> 'tuple[typing.Any, typing.Any]': """ Retrievs the window origin for a DC @@ -3178,7 +3710,7 @@ Returns: pass -def SetWindowOrgEx(hdc:'int',X:'typing.Any',Y:'typing.Any') -> 'tuple[typing.Any, typing.Any]': +def SetWindowOrgEx(hdc: 'int', X: 'typing.Any', Y: 'typing.Any') -> 'tuple[typing.Any, typing.Any]': """ Changes the window origin for a DC @@ -3197,7 +3729,7 @@ Returns: pass -def GetViewportOrgEx(hdc:'int') -> 'tuple[typing.Any, typing.Any]': +def GetViewportOrgEx(hdc: 'int') -> 'tuple[typing.Any, typing.Any]': """ Retrievs the origin for a DC's viewport @@ -3213,7 +3745,7 @@ Returns: pass -def SetViewportOrgEx(hdc:'int',X:'typing.Any',Y:'typing.Any') -> 'tuple[typing.Any, typing.Any]': +def SetViewportOrgEx(hdc: 'int', X: 'typing.Any', Y: 'typing.Any') -> 'tuple[typing.Any, typing.Any]': """ Changes the viewport origin for a DC @@ -3232,7 +3764,7 @@ Returns: pass -def GetWindowExtEx(hdc:'int') -> 'tuple[typing.Any, typing.Any]': +def GetWindowExtEx(hdc: 'int') -> 'tuple[typing.Any, typing.Any]': """ Retrieves the window extents for a DC @@ -3249,7 +3781,7 @@ Returns: pass -def SetWindowExtEx(hdc:'int',XExtent:'typing.Any',YExtent:'typing.Any') -> 'tuple[typing.Any, typing.Any]': +def SetWindowExtEx(hdc: 'int', XExtent: 'typing.Any', YExtent: 'typing.Any') -> 'tuple[typing.Any, typing.Any]': """ Changes the window extents for a DC @@ -3268,7 +3800,7 @@ Returns: pass -def GetViewportExtEx(hdc:'int') -> 'tuple[typing.Any, typing.Any]': +def GetViewportExtEx(hdc: 'int') -> 'tuple[typing.Any, typing.Any]': """ Retrieves the viewport extents for a DC @@ -3285,7 +3817,7 @@ Returns: pass -def SetViewportExtEx(hdc:'int',XExtent:'typing.Any',YExtent:'typing.Any') -> 'tuple[typing.Any, typing.Any]': +def SetViewportExtEx(hdc: 'int', XExtent: 'typing.Any', YExtent: 'typing.Any') -> 'tuple[typing.Any, typing.Any]': """ Changes the viewport extents for a DC @@ -3304,7 +3836,11 @@ Returns: pass -def GradientFill(hdc:'typing.Any',Vertex:'tuple[win32typing.PyTRIVERTEX, ...]',Mesh:'typing.Any',Mode:'typing.Any') -> 'None': +def GradientFill( + hdc: 'typing.Any', + Vertex: 'tuple[win32typing.PyTRIVERTEX, ...]', + Mesh: 'typing.Any', + Mode: 'typing.Any') -> 'None': """ Shades triangles or rectangles by interpolating between vertex colors @@ -3323,7 +3859,7 @@ Returns: pass -def GetOpenFileName(OPENFILENAME:'typing.Union[str, typing.Any]') -> 'typing.Any': +def GetOpenFileName(OPENFILENAME: 'typing.Union[str, typing.Any]') -> 'typing.Any': """ Creates an Open dialog box that lets the user specify the drive, directory, and the name of a file or set of files to open. @@ -3345,7 +3881,11 @@ Return ValueIf the user presses OK, the function returns TRUE. Otherwise, use C pass -def InsertMenuItem(hMenu:'typing.Any',uItem:'typing.Any',fByPosition:'typing.Any',menuItem:'typing.Any') -> 'None': +def InsertMenuItem( + hMenu: 'typing.Any', + uItem: 'typing.Any', + fByPosition: 'typing.Any', + menuItem: 'typing.Any') -> 'None': """ Inserts a menu item @@ -3364,7 +3904,11 @@ Returns: pass -def SetMenuItemInfo(hMenu:'typing.Any',uItem:'typing.Any',fByPosition:'typing.Any',menuItem:'typing.Any') -> 'None': +def SetMenuItemInfo( + hMenu: 'typing.Any', + uItem: 'typing.Any', + fByPosition: 'typing.Any', + menuItem: 'typing.Any') -> 'None': """ Sets menu information @@ -3383,7 +3927,11 @@ Returns: pass -def GetMenuItemInfo(hMenu:'typing.Any',uItem:'typing.Any',fByPosition:'typing.Any',menuItem:'typing.Any') -> 'None': +def GetMenuItemInfo( + hMenu: 'typing.Any', + uItem: 'typing.Any', + fByPosition: 'typing.Any', + menuItem: 'typing.Any') -> 'None': """ Gets menu information @@ -3402,7 +3950,7 @@ Returns: pass -def GetMenuItemCount(hMenu:'typing.Any') -> 'typing.Any': +def GetMenuItemCount(hMenu: 'typing.Any') -> 'typing.Any': """ None @@ -3418,7 +3966,7 @@ Returns: pass -def GetMenuItemRect(hWnd:'typing.Any',hMenu:'typing.Any',uItem:'typing.Any') -> 'tuple[int, int, int, int]': +def GetMenuItemRect(hWnd: 'typing.Any', hMenu: 'typing.Any', uItem: 'typing.Any') -> 'tuple[int, int, int, int]': """ None @@ -3436,7 +3984,7 @@ Returns: pass -def GetMenuState(hMenu:'typing.Any',uID:'typing.Any',flags:'typing.Any') -> 'typing.Any': +def GetMenuState(hMenu: 'typing.Any', uID: 'typing.Any', flags: 'typing.Any') -> 'typing.Any': """ None @@ -3454,7 +4002,7 @@ Returns: pass -def SetMenuDefaultItem(hMenu:'typing.Any',uItem:'typing.Any',fByPos:'typing.Any') -> 'None': +def SetMenuDefaultItem(hMenu: 'typing.Any', uItem: 'typing.Any', fByPos: 'typing.Any') -> 'None': """ None @@ -3472,7 +4020,7 @@ Returns: pass -def GetMenuDefaultItem(hMenu:'typing.Any',fByPos:'typing.Any',flags:'typing.Any') -> 'typing.Any': +def GetMenuDefaultItem(hMenu: 'typing.Any', fByPos: 'typing.Any', flags: 'typing.Any') -> 'typing.Any': """ None @@ -3554,7 +4102,7 @@ Returns: pass -def GetSubMenu(hMenu:'typing.Any',nPos:'typing.Any') -> 'typing.Any': +def GetSubMenu(hMenu: 'typing.Any', nPos: 'typing.Any') -> 'typing.Any': """ None @@ -3571,7 +4119,12 @@ Returns: pass -def ModifyMenu(hMnu:'typing.Any',uPosition:'typing.Any',uFlags:'typing.Any',uIDNewItem:'typing.Any',newItem:'str') -> 'None': +def ModifyMenu( + hMnu: 'typing.Any', + uPosition: 'typing.Any', + uFlags: 'typing.Any', + uIDNewItem: 'typing.Any', + newItem: 'str') -> 'None': """ Changes an existing menu item. This function is used to specify the content, appearance, and behavior of the menu item. @@ -3591,7 +4144,7 @@ Returns: pass -def GetMenuItemID(hMenu:'typing.Any',nPos:'typing.Any') -> 'typing.Any': +def GetMenuItemID(hMenu: 'typing.Any', nPos: 'typing.Any') -> 'typing.Any': """ Retrieves the menu item identifier of a menu item located at the specified position in a menu. @@ -3608,7 +4161,12 @@ Returns: pass -def SetMenuItemBitmaps(hMenu:'typing.Any',uPosition:'typing.Any',uFlags:'typing.Any',hBitmapUnchecked:'win32typing.PyGdiHANDLE',hBitmapChecked:'win32typing.PyGdiHANDLE') -> 'None': +def SetMenuItemBitmaps( + hMenu: 'typing.Any', + uPosition: 'typing.Any', + uFlags: 'typing.Any', + hBitmapUnchecked: 'win32typing.PyGdiHANDLE', + hBitmapChecked: 'win32typing.PyGdiHANDLE') -> 'None': """ Associates the specified bitmap with a menu item. Whether the menu item is selected or clear, the system displays the appropriate bitmap next to the menu item. @@ -3628,7 +4186,12 @@ Returns: pass -def CheckMenuRadioItem(hMenu:'typing.Any',idFirst:'typing.Any',idLast:'typing.Any',idCheck:'typing.Any',uFlags:'typing.Any') -> 'None': +def CheckMenuRadioItem( + hMenu: 'typing.Any', + idFirst: 'typing.Any', + idLast: 'typing.Any', + idCheck: 'typing.Any', + uFlags: 'typing.Any') -> 'None': """ Checks a specified menu item and makes it a @@ -3652,7 +4215,7 @@ Returns: pass -def SetMenuInfo(hmenu:'typing.Any',info:'typing.Any') -> 'None': +def SetMenuInfo(hmenu: 'typing.Any', info: 'typing.Any') -> 'None': """ Sets information for a specified menu. @@ -3669,7 +4232,7 @@ Returns: pass -def GetMenuInfo(hmenu:'typing.Any',info:'typing.Any') -> 'None': +def GetMenuInfo(hmenu: 'typing.Any', info: 'typing.Any') -> 'None': """ Gets information about a specified menu. @@ -3686,7 +4249,7 @@ Returns: pass -def DrawFocusRect(hDC:'int',rc:'tuple[int, int, int, int]') -> 'None': +def DrawFocusRect(hDC: 'int', rc: 'tuple[int, int, int, int]') -> 'None': """ Draws a standard focus outline around a rectangle @@ -3703,7 +4266,12 @@ Returns: pass -def DrawText(hDC:'typing.Union[typing.Any, int]',String:'typing.Any',nCount:'typing.Any',Rect:'win32typing.PyRECT',Format:'typing.Any') -> 'tuple[typing.Any, win32typing.PyRECT]': +def DrawText( + hDC: 'typing.Union[typing.Any, int]', + String: 'typing.Any', + nCount: 'typing.Any', + Rect: 'win32typing.PyRECT', + Format: 'typing.Any') -> 'tuple[typing.Any, win32typing.PyRECT]': """ Draws formatted text on a device context @@ -3724,7 +4292,7 @@ Returns: pass -def LineTo(hdc:'int',XEnd:'typing.Any',YEnd:'typing.Any') -> 'None': +def LineTo(hdc: 'int', XEnd: 'typing.Any', YEnd: 'typing.Any') -> 'None': """ Draw a line from current position to specified point @@ -3742,7 +4310,12 @@ Returns: pass -def Ellipse(hdc:'int',LeftRect:'typing.Any',TopRect:'typing.Any',RightRect:'typing.Any',BottomRect:'typing.Any') -> 'None': +def Ellipse( + hdc: 'int', + LeftRect: 'typing.Any', + TopRect: 'typing.Any', + RightRect: 'typing.Any', + BottomRect: 'typing.Any') -> 'None': """ Draws a filled ellipse on a device context @@ -3762,7 +4335,16 @@ Returns: pass -def Pie(hdc:'int',LeftRect:'typing.Any',TopRect:'typing.Any',RightRect:'typing.Any',BottomRect:'typing.Any',XRadial1:'typing.Any',YRadial1:'typing.Any',XRadial2:'typing.Any',YRadial2:'typing.Any') -> 'None': +def Pie( + hdc: 'int', + LeftRect: 'typing.Any', + TopRect: 'typing.Any', + RightRect: 'typing.Any', + BottomRect: 'typing.Any', + XRadial1: 'typing.Any', + YRadial1: 'typing.Any', + XRadial2: 'typing.Any', + YRadial2: 'typing.Any') -> 'None': """ Draws a section of an ellipse cut by 2 radials @@ -3786,7 +4368,16 @@ Returns: pass -def Arc(hdc:'int',LeftRect:'typing.Any',TopRect:'typing.Any',RightRect:'typing.Any',BottomRect:'typing.Any',XRadial1:'typing.Any',YRadial1:'typing.Any',XRadial2:'typing.Any',YRadial2:'typing.Any') -> 'None': +def Arc( + hdc: 'int', + LeftRect: 'typing.Any', + TopRect: 'typing.Any', + RightRect: 'typing.Any', + BottomRect: 'typing.Any', + XRadial1: 'typing.Any', + YRadial1: 'typing.Any', + XRadial2: 'typing.Any', + YRadial2: 'typing.Any') -> 'None': """ Draws an arc defined by an ellipse and 2 radials @@ -3810,7 +4401,16 @@ Returns: pass -def ArcTo(hdc:'int',LeftRect:'typing.Any',TopRect:'typing.Any',RightRect:'typing.Any',BottomRect:'typing.Any',XRadial1:'typing.Any',YRadial1:'typing.Any',XRadial2:'typing.Any',YRadial2:'typing.Any') -> 'None': +def ArcTo( + hdc: 'int', + LeftRect: 'typing.Any', + TopRect: 'typing.Any', + RightRect: 'typing.Any', + BottomRect: 'typing.Any', + XRadial1: 'typing.Any', + YRadial1: 'typing.Any', + XRadial2: 'typing.Any', + YRadial2: 'typing.Any') -> 'None': """ Draws an arc defined by an ellipse and 2 radials @@ -3834,7 +4434,13 @@ Returns: pass -def AngleArc(hdc:'int',Y:'typing.Any',Y1:'typing.Any',Radius:'typing.Any',StartAngle:'float',SweepAngle:'float') -> 'None': +def AngleArc( + hdc: 'int', + Y: 'typing.Any', + Y1: 'typing.Any', + Radius: 'typing.Any', + StartAngle: 'float', + SweepAngle: 'float') -> 'None': """ Draws a line from current pos and a section of a circle's arc @@ -3855,7 +4461,16 @@ Returns: pass -def Chord(hdc:'int',LeftRect:'typing.Any',TopRect:'typing.Any',RightRect:'typing.Any',BottomRect:'typing.Any',XRadial1:'typing.Any',YRadial1:'typing.Any',XRadial2:'typing.Any',YRadial2:'typing.Any') -> 'None': +def Chord( + hdc: 'int', + LeftRect: 'typing.Any', + TopRect: 'typing.Any', + RightRect: 'typing.Any', + BottomRect: 'typing.Any', + XRadial1: 'typing.Any', + YRadial1: 'typing.Any', + XRadial2: 'typing.Any', + YRadial2: 'typing.Any') -> 'None': """ Draws a chord defined by an ellipse and 2 radials @@ -3879,7 +4494,12 @@ Returns: pass -def ExtFloodFill(arg:'int',XStart:'typing.Any',YStart:'typing.Any',Color:'typing.Any',FillType:'typing.Any') -> 'None': +def ExtFloodFill( + arg: 'int', + XStart: 'typing.Any', + YStart: 'typing.Any', + Color: 'typing.Any', + FillType: 'typing.Any') -> 'None': """ Fills an area with current brush @@ -3899,7 +4519,7 @@ Returns: pass -def SetPixel(hdc:'int',X:'typing.Any',Y:'typing.Any',Color:'typing.Any') -> 'typing.Any': +def SetPixel(hdc: 'int', X: 'typing.Any', Y: 'typing.Any', Color: 'typing.Any') -> 'typing.Any': """ Set the color of a single pixel @@ -3919,7 +4539,7 @@ Returns: pass -def GetPixel(hdc:'int',XPos:'typing.Any',YPos:'typing.Any') -> 'typing.Any': +def GetPixel(hdc: 'int', XPos: 'typing.Any', YPos: 'typing.Any') -> 'typing.Any': """ Returns the RGB color of a single pixel @@ -3937,7 +4557,7 @@ Returns: pass -def GetROP2(hdc:'int') -> 'typing.Any': +def GetROP2(hdc: 'int') -> 'typing.Any': """ Returns the foreground mixing mode of a DC @@ -3954,7 +4574,7 @@ Returns: pass -def SetROP2(hdc:'int',DrawMode:'typing.Any') -> 'typing.Any': +def SetROP2(hdc: 'int', DrawMode: 'typing.Any') -> 'typing.Any': """ Sets the foreground mixing mode of a DC @@ -3972,7 +4592,7 @@ Returns: pass -def SetPixelV(hdc:'int',X:'typing.Any',Y:'typing.Any',Color:'typing.Any') -> 'None': +def SetPixelV(hdc: 'int', X: 'typing.Any', Y: 'typing.Any', Color: 'typing.Any') -> 'None': """ Sets the color of a single pixel to an approximation of specified color @@ -3991,7 +4611,7 @@ Returns: pass -def MoveToEx(hdc:'int',X:'typing.Any',Y:'typing.Any') -> 'tuple[typing.Any, typing.Any]': +def MoveToEx(hdc: 'int', X: 'typing.Any', Y: 'typing.Any') -> 'tuple[typing.Any, typing.Any]': """ Changes the current drawing position @@ -4010,7 +4630,7 @@ Returns: pass -def GetCurrentPositionEx(hdc:'int') -> 'tuple[typing.Any, typing.Any]': +def GetCurrentPositionEx(hdc: 'int') -> 'tuple[typing.Any, typing.Any]': """ Returns a device context's current drawing position @@ -4026,7 +4646,7 @@ Returns: pass -def GetArcDirection(hdc:'int') -> 'typing.Any': +def GetArcDirection(hdc: 'int') -> 'typing.Any': """ Returns the direction in which rectangles and arcs are drawn @@ -4043,7 +4663,7 @@ Returns: pass -def SetArcDirection(hdc:'int',ArcDirection:'typing.Any') -> 'typing.Any': +def SetArcDirection(hdc: 'int', ArcDirection: 'typing.Any') -> 'typing.Any': """ Sets the drawing direction for arcs and rectangles @@ -4061,7 +4681,7 @@ Returns: pass -def Polygon(hdc:'int',Points:'typing.List[tuple[typing.Any, typing.Any]]') -> 'None': +def Polygon(hdc: 'int', Points: 'typing.List[tuple[typing.Any, typing.Any]]') -> 'None': """ Draws a closed filled polygon defined by a sequence of points @@ -4078,7 +4698,7 @@ Returns: pass -def Polyline(hdc:'int',Points:'typing.List[tuple[typing.Any, typing.Any]]') -> 'None': +def Polyline(hdc: 'int', Points: 'typing.List[tuple[typing.Any, typing.Any]]') -> 'None': """ Connects a sequence of points using currently selected pen @@ -4095,7 +4715,7 @@ Returns: pass -def PolylineTo(hdc:'int',Points:'typing.List[tuple[typing.Any, typing.Any]]') -> 'None': +def PolylineTo(hdc: 'int', Points: 'typing.List[tuple[typing.Any, typing.Any]]') -> 'None': """ Draws a series of lines starting from current position. Updates current position with end point. @@ -4112,7 +4732,7 @@ Returns: pass -def PolyBezier(hdc:'int',Points:'typing.List[tuple[typing.Any, typing.Any]]') -> 'None': +def PolyBezier(hdc: 'int', Points: 'typing.List[tuple[typing.Any, typing.Any]]') -> 'None': """ Draws a series of Bezier curves starting from first point specified. @@ -4129,7 +4749,7 @@ Returns: pass -def PolyBezierTo(hdc:'int',Points:'typing.List[tuple[typing.Any, typing.Any]]') -> 'None': +def PolyBezierTo(hdc: 'int', Points: 'typing.List[tuple[typing.Any, typing.Any]]') -> 'None': """ Draws a series of Bezier curves starting from current drawing position. @@ -4146,7 +4766,17 @@ Returns: pass -def PlgBlt(Dest:'int',Point:'typing.Any',Src:'int',XSrc:'typing.Any',YSrc:'typing.Any',Width:'typing.Any',Height:'typing.Any',Mask:'win32typing.PyGdiHANDLE'=None,xMask:'typing.Any'=0,yMask:'typing.Any'=0) -> 'None': +def PlgBlt( + Dest: 'int', + Point: 'typing.Any', + Src: 'int', + XSrc: 'typing.Any', + YSrc: 'typing.Any', + Width: 'typing.Any', + Height: 'typing.Any', + Mask: 'win32typing.PyGdiHANDLE' = None, + xMask: 'typing.Any' = 0, + yMask: 'typing.Any' = 0) -> 'None': """ Copies color from a rectangle into a parallelogram @@ -4171,7 +4801,8 @@ Returns: pass -def CreatePolygonRgn(Points:'typing.List[tuple[typing.Any, typing.Any]]',PolyFillMode:'typing.Any') -> 'win32typing.PyGdiHANDLE': +def CreatePolygonRgn(Points: 'typing.List[tuple[typing.Any, typing.Any]]', + PolyFillMode: 'typing.Any') -> 'win32typing.PyGdiHANDLE': """ Creates a region from a sequence of vertices @@ -4188,7 +4819,14 @@ Returns: pass -def ExtTextOut(hdc:'int',_int:'typing.Any',_int1:'typing.Any',_int2:'typing.Any',rect:'win32typing.PyRECT',string:'typing.Any',_tuple:'tuple[tuple[typing.Any, typing.Any], ...]') -> 'typing.Any': +def ExtTextOut( + hdc: 'int', + _int: 'typing.Any', + _int1: 'typing.Any', + _int2: 'typing.Any', + rect: 'win32typing.PyRECT', + string: 'typing.Any', + _tuple: 'tuple[tuple[typing.Any, typing.Any], ...]') -> 'typing.Any': """ Writes text to a DC. @@ -4212,7 +4850,7 @@ Return ValueAlways none. If the function fails, an exception is raised. pass -def GetTextColor(hdc:'typing.Any') -> 'typing.Any': +def GetTextColor(hdc: 'typing.Any') -> 'typing.Any': """ Returns the text color for a DC @@ -4229,7 +4867,7 @@ Returns: pass -def SetTextColor(hdc:'typing.Any',color:'typing.Any') -> 'typing.Any': +def SetTextColor(hdc: 'typing.Any', color: 'typing.Any') -> 'typing.Any': """ Changes the text color for a device context @@ -4247,7 +4885,7 @@ Returns: pass -def GetBkMode(hdc:'int') -> 'typing.Any': +def GetBkMode(hdc: 'int') -> 'typing.Any': """ Returns the background mode for a device context @@ -4264,7 +4902,7 @@ Returns: pass -def SetBkMode(hdc:'typing.Union[typing.Any, int]',BkMode:'typing.Any') -> 'typing.Any': +def SetBkMode(hdc: 'typing.Union[typing.Any, int]', BkMode: 'typing.Any') -> 'typing.Any': """ Sets the background mode for a device context @@ -4282,7 +4920,7 @@ Returns: pass -def GetBkColor(hdc:'int') -> 'typing.Any': +def GetBkColor(hdc: 'int') -> 'typing.Any': """ Returns the background color for a device context @@ -4299,7 +4937,7 @@ Returns: pass -def SetBkColor(hdc:'typing.Union[typing.Any, int]',color:'typing.Any') -> 'typing.Any': +def SetBkColor(hdc: 'typing.Union[typing.Any, int]', color: 'typing.Any') -> 'typing.Any': """ Sets the background color for a device context @@ -4317,7 +4955,7 @@ Returns: pass -def DrawEdge(hdc:'int',rc:'win32typing.PyRECT',edge:'typing.Any',Flags:'typing.Any') -> 'win32typing.PyRECT': +def DrawEdge(hdc: 'int', rc: 'win32typing.PyRECT', edge: 'typing.Any', Flags: 'typing.Any') -> 'win32typing.PyRECT': """ Draws edge(s) of a rectangle @@ -4337,7 +4975,7 @@ Returns: pass -def FillRect(hDC:'int',rc:'win32typing.PyRECT',hbr:'win32typing.PyGdiHANDLE') -> 'None': +def FillRect(hDC: 'int', rc: 'win32typing.PyRECT', hbr: 'win32typing.PyGdiHANDLE') -> 'None': """ Fills a rectangular area with specified brush @@ -4355,7 +4993,7 @@ Returns: pass -def FillRgn(hdc:'int',hrgn:'win32typing.PyGdiHANDLE',hbr:'win32typing.PyGdiHANDLE') -> 'None': +def FillRgn(hdc: 'int', hrgn: 'win32typing.PyGdiHANDLE', hbr: 'win32typing.PyGdiHANDLE') -> 'None': """ Fills a region with specified brush @@ -4373,7 +5011,7 @@ Returns: pass -def PaintRgn(hdc:'int',hrgn:'win32typing.PyGdiHANDLE') -> 'None': +def PaintRgn(hdc: 'int', hrgn: 'win32typing.PyGdiHANDLE') -> 'None': """ Paints a region with current brush @@ -4390,7 +5028,7 @@ Returns: pass -def FrameRgn(hdc:'int',hrgn:'typing.Any',hbr:'typing.Any',Width:'typing.Any',Height:'typing.Any') -> 'None': +def FrameRgn(hdc: 'int', hrgn: 'typing.Any', hbr: 'typing.Any', Width: 'typing.Any', Height: 'typing.Any') -> 'None': """ Draws a frame around a region @@ -4410,7 +5048,7 @@ Returns: pass -def InvertRgn(hdc:'int',hrgn:'typing.Any') -> 'None': +def InvertRgn(hdc: 'int', hrgn: 'typing.Any') -> 'None': """ Inverts the colors in a region @@ -4427,7 +5065,7 @@ Returns: pass -def EqualRgn(SrcRgn1:'typing.Any',SrcRgn2:'typing.Any') -> 'typing.Any': +def EqualRgn(SrcRgn1: 'typing.Any', SrcRgn2: 'typing.Any') -> 'typing.Any': """ Determines if 2 regions are equal @@ -4444,7 +5082,7 @@ Returns: pass -def PtInRegion(hrgn:'typing.Any',X:'typing.Any',Y:'typing.Any') -> 'typing.Any': +def PtInRegion(hrgn: 'typing.Any', X: 'typing.Any', Y: 'typing.Any') -> 'typing.Any': """ Determines if a region contains a point @@ -4462,7 +5100,7 @@ Returns: pass -def PtInRect(rect:'tuple[int, int, int, int]',point:'tuple[typing.Any, typing.Any]') -> 'typing.Any': +def PtInRect(rect: 'tuple[int, int, int, int]', point: 'tuple[typing.Any, typing.Any]') -> 'typing.Any': """ Determines if a rectangle contains a point @@ -4479,7 +5117,7 @@ Returns: pass -def RectInRegion(hrgn:'typing.Any',rc:'win32typing.PyRECT') -> 'typing.Any': +def RectInRegion(hrgn: 'typing.Any', rc: 'win32typing.PyRECT') -> 'typing.Any': """ Determines if a region and rectangle overlap at any point @@ -4496,7 +5134,12 @@ Returns: pass -def SetRectRgn(hrgn:'typing.Any',LeftRect:'typing.Any',TopRect:'typing.Any',RightRect:'typing.Any',BottomRect:'typing.Any') -> 'None': +def SetRectRgn( + hrgn: 'typing.Any', + LeftRect: 'typing.Any', + TopRect: 'typing.Any', + RightRect: 'typing.Any', + BottomRect: 'typing.Any') -> 'None': """ Makes an existing region rectangular @@ -4516,7 +5159,7 @@ Returns: pass -def CombineRgn(Dest:'typing.Any',Src1:'typing.Any',Src2:'typing.Any',CombineMode:'typing.Any') -> 'typing.Any': +def CombineRgn(Dest: 'typing.Any', Src1: 'typing.Any', Src2: 'typing.Any', CombineMode: 'typing.Any') -> 'typing.Any': """ Combines two regions @@ -4536,7 +5179,11 @@ Returns: pass -def DrawAnimatedRects(hwnd:'int',idAni:'typing.Any',minCoords:'win32typing.PyRECT',restCoords:'win32typing.PyRECT') -> 'None': +def DrawAnimatedRects( + hwnd: 'int', + idAni: 'typing.Any', + minCoords: 'win32typing.PyRECT', + restCoords: 'win32typing.PyRECT') -> 'None': """ Animates a rectangle in the manner of minimizing, mazimizing, or opening @@ -4555,7 +5202,7 @@ Returns: pass -def CreateSolidBrush(Color:'typing.Any') -> 'win32typing.PyGdiHANDLE': +def CreateSolidBrush(Color: 'typing.Any') -> 'win32typing.PyGdiHANDLE': """ Creates a solid brush of specified color @@ -4571,7 +5218,7 @@ Returns: pass -def CreatePatternBrush(hbmp:'win32typing.PyGdiHANDLE') -> 'win32typing.PyGdiHANDLE': +def CreatePatternBrush(hbmp: 'win32typing.PyGdiHANDLE') -> 'win32typing.PyGdiHANDLE': """ Creates a brush using a bitmap as a pattern @@ -4587,7 +5234,7 @@ Returns: pass -def CreateHatchBrush(Style:'typing.Any',clrref:'typing.Any') -> 'win32typing.PyGdiHANDLE': +def CreateHatchBrush(Style: 'typing.Any', clrref: 'typing.Any') -> 'win32typing.PyGdiHANDLE': """ Creates a hatch brush with specified style and color @@ -4604,7 +5251,7 @@ Returns: pass -def CreatePen(PenStyle:'typing.Any',Width:'typing.Any',Color:'typing.Any') -> 'win32typing.PyGdiHANDLE': +def CreatePen(PenStyle: 'typing.Any', Width: 'typing.Any', Color: 'typing.Any') -> 'win32typing.PyGdiHANDLE': """ Create a GDI pen @@ -4622,7 +5269,7 @@ Returns: pass -def GetSysColor(Index:'typing.Any') -> 'typing.Any': +def GetSysColor(Index: 'typing.Any') -> 'typing.Any': """ Returns the color of a window element @@ -4638,7 +5285,7 @@ Returns: pass -def GetSysColorBrush(Index:'typing.Any') -> 'win32typing.PyGdiHANDLE': +def GetSysColorBrush(Index: 'typing.Any') -> 'win32typing.PyGdiHANDLE': """ Creates a handle to a system color brush @@ -4654,7 +5301,7 @@ Returns: pass -def InvalidateRect(hWnd:'int',Rect:'win32typing.PyRECT',Erase:'typing.Any') -> 'None': +def InvalidateRect(hWnd: 'int', Rect: 'win32typing.PyRECT', Erase: 'typing.Any') -> 'None': """ Invalidates a rectangular area of a window and adds it to the window's update region @@ -4672,7 +5319,7 @@ Returns: pass -def FrameRect(hDC:'int',rc:'win32typing.PyRECT',hbr:'win32typing.PyGdiHANDLE') -> 'None': +def FrameRect(hDC: 'int', rc: 'win32typing.PyRECT', hbr: 'win32typing.PyGdiHANDLE') -> 'None': """ Draws an outline around a rectangle @@ -4690,7 +5337,7 @@ Returns: pass -def InvertRect(hDC:'int',rc:'win32typing.PyRECT') -> 'None': +def InvertRect(hDC: 'int', rc: 'win32typing.PyRECT') -> 'None': """ Inverts the colors in a regtangular region @@ -4707,7 +5354,7 @@ Returns: pass -def WindowFromDC(hDC:'int') -> 'int': +def WindowFromDC(hDC: 'int') -> 'int': """ Finds the window associated with a device context @@ -4724,7 +5371,7 @@ Returns: pass -def GetUpdateRgn(hWnd:'int',hRgn:'win32typing.PyGdiHANDLE',Erase:'typing.Any') -> 'typing.Any': +def GetUpdateRgn(hWnd: 'int', hRgn: 'win32typing.PyGdiHANDLE', Erase: 'typing.Any') -> 'typing.Any': """ Copies the update region of a window into an existing region @@ -4743,7 +5390,7 @@ Returns: pass -def GetWindowRgn(hWnd:'int',hRgn:'win32typing.PyGdiHANDLE') -> 'typing.Any': +def GetWindowRgn(hWnd: 'int', hRgn: 'win32typing.PyGdiHANDLE') -> 'typing.Any': """ Copies the window region of a window into an existing region @@ -4761,7 +5408,7 @@ Returns: pass -def SetWindowRgn(hWnd:'int',hRgn:'win32typing.PyGdiHANDLE',Redraw:'typing.Any') -> 'None': +def SetWindowRgn(hWnd: 'int', hRgn: 'win32typing.PyGdiHANDLE', Redraw: 'typing.Any') -> 'None': """ Sets the visible region of a window @@ -4779,7 +5426,7 @@ Returns: pass -def GetWindowRgnBox(hWnd:'int') -> 'tuple[typing.Any, win32typing.PyRECT]': +def GetWindowRgnBox(hWnd: 'int') -> 'tuple[typing.Any, win32typing.PyRECT]': """ Returns the bounding box for a window's region @@ -4799,7 +5446,7 @@ Return ValueReturns type of region and rectangle coordinates in device units pass -def ValidateRgn(hWnd:'int',hRgn:'win32typing.PyGdiHANDLE') -> 'None': +def ValidateRgn(hWnd: 'int', hRgn: 'win32typing.PyGdiHANDLE') -> 'None': """ Removes a region from a window's update region @@ -4816,7 +5463,7 @@ Returns: pass -def InvalidateRgn(hWnd:'int',hRgn:'win32typing.PyGdiHANDLE',Erase:'typing.Any') -> 'None': +def InvalidateRgn(hWnd: 'int', hRgn: 'win32typing.PyGdiHANDLE', Erase: 'typing.Any') -> 'None': """ Adds a region to a window's update region @@ -4834,7 +5481,7 @@ Returns: pass -def GetRgnBox(hrgn:'win32typing.PyGdiHANDLE') -> 'tuple[typing.Any, win32typing.PyRECT]': +def GetRgnBox(hrgn: 'win32typing.PyGdiHANDLE') -> 'tuple[typing.Any, win32typing.PyRECT]': """ Calculates the bounding box of a region @@ -4851,7 +5498,7 @@ Returns: pass -def OffsetRgn(hrgn:'win32typing.PyGdiHANDLE',XOffset:'typing.Any',YOffset:'typing.Any') -> 'typing.Any': +def OffsetRgn(hrgn: 'win32typing.PyGdiHANDLE', XOffset: 'typing.Any', YOffset: 'typing.Any') -> 'typing.Any': """ Relocates a region @@ -4870,7 +5517,12 @@ Returns: pass -def Rectangle(hdc:'int',LeftRect:'typing.Any',TopRect:'typing.Any',RightRect:'typing.Any',BottomRect:'typing.Any') -> 'None': +def Rectangle( + hdc: 'int', + LeftRect: 'typing.Any', + TopRect: 'typing.Any', + RightRect: 'typing.Any', + BottomRect: 'typing.Any') -> 'None': """ Creates a solid rectangle using currently selected pen and brush @@ -4890,7 +5542,14 @@ Returns: pass -def RoundRect(hdc:'int',LeftRect:'typing.Any',TopRect:'typing.Any',RightRect:'typing.Any',BottomRect:'typing.Any',Width:'typing.Any',Height:'typing.Any') -> 'None': +def RoundRect( + hdc: 'int', + LeftRect: 'typing.Any', + TopRect: 'typing.Any', + RightRect: 'typing.Any', + BottomRect: 'typing.Any', + Width: 'typing.Any', + Height: 'typing.Any') -> 'None': """ Draws a rectangle with elliptically rounded corners, filled using using current brush @@ -4928,7 +5587,7 @@ Returns: pass -def EndPaint(hwnd:'int',ps:'typing.Any') -> 'None': +def EndPaint(hwnd: 'int', ps: 'typing.Any') -> 'None': """ None @@ -4945,7 +5604,7 @@ Returns: pass -def BeginPath(hdc:'int') -> 'None': +def BeginPath(hdc: 'int') -> 'None': """ Initializes a path in a DC @@ -4961,7 +5620,7 @@ Returns: pass -def EndPath(hdc:'int') -> 'None': +def EndPath(hdc: 'int') -> 'None': """ None @@ -4977,7 +5636,7 @@ Returns: pass -def AbortPath(hdc:'int') -> 'None': +def AbortPath(hdc: 'int') -> 'None': """ None @@ -4993,7 +5652,7 @@ Returns: pass -def CloseFigure(hdc:'int') -> 'None': +def CloseFigure(hdc: 'int') -> 'None': """ Closes a section of a path by connecting the beginning pos with the current pos @@ -5009,7 +5668,7 @@ Returns: pass -def FlattenPath(hdc:'int') -> 'None': +def FlattenPath(hdc: 'int') -> 'None': """ Flattens any curves in current path into a series of lines @@ -5025,7 +5684,7 @@ Returns: pass -def FillPath(hdc:'int') -> 'None': +def FillPath(hdc: 'int') -> 'None': """ Fills a path with currently selected brush @@ -5041,7 +5700,7 @@ Returns: pass -def WidenPath(hdc:'int') -> 'None': +def WidenPath(hdc: 'int') -> 'None': """ Widens current path by amount it would increase by if drawn with currently selected pen @@ -5057,7 +5716,7 @@ Returns: pass -def StrokePath(hdc:'int') -> 'None': +def StrokePath(hdc: 'int') -> 'None': """ Draws current path with currently selected pen @@ -5073,7 +5732,7 @@ Returns: pass -def StrokeAndFillPath(hdc:'int') -> 'None': +def StrokeAndFillPath(hdc: 'int') -> 'None': """ Combines operations of StrokePath and FillPath with no overlap @@ -5089,7 +5748,7 @@ Returns: pass -def GetMiterLimit(hdc:'int') -> 'float': +def GetMiterLimit(hdc: 'int') -> 'float': """ Retrieves the limit of miter joins for a DC @@ -5105,7 +5764,7 @@ Returns: pass -def SetMiterLimit(hdc:'int',NewLimit:'float') -> 'float': +def SetMiterLimit(hdc: 'int', NewLimit: 'float') -> 'float': """ Set the limit of miter joins for a DC @@ -5123,7 +5782,7 @@ Returns: pass -def PathToRegion(hdc:'int') -> 'win32typing.PyGdiHANDLE': +def PathToRegion(hdc: 'int') -> 'win32typing.PyGdiHANDLE': """ Converts a closed path in a DC to a region @@ -5139,7 +5798,7 @@ Returns: pass -def GetPath(hdc:'int') -> 'tuple[typing.Any, typing.Any]': +def GetPath(hdc: 'int') -> 'tuple[typing.Any, typing.Any]': """ Returns a sequence of points that describe the current path @@ -5156,7 +5815,13 @@ Returns: pass -def CreateRoundRectRgn(LeftRect:'typing.Any',TopRect:'typing.Any',RightRect:'typing.Any',BottomRect:'typing.Any',WidthEllipse:'typing.Any',HeightEllipse:'typing.Any') -> 'typing.Any': +def CreateRoundRectRgn( + LeftRect: 'typing.Any', + TopRect: 'typing.Any', + RightRect: 'typing.Any', + BottomRect: 'typing.Any', + WidthEllipse: 'typing.Any', + HeightEllipse: 'typing.Any') -> 'typing.Any': """ Create a rectangular region with elliptically rounded corners, @@ -5177,7 +5842,7 @@ Returns: pass -def CreateRectRgnIndirect(rc:'win32typing.PyRECT') -> 'typing.Any': +def CreateRectRgnIndirect(rc: 'win32typing.PyRECT') -> 'typing.Any': """ Creates a rectangular region, @@ -5193,7 +5858,7 @@ Returns: pass -def CreateEllipticRgnIndirect(rc:'win32typing.PyRECT') -> 'typing.Any': +def CreateEllipticRgnIndirect(rc: 'win32typing.PyRECT') -> 'typing.Any': """ Creates an ellipse region, @@ -5209,7 +5874,19 @@ Returns: pass -def CreateWindowEx(dwExStyle:'typing.Any',className:'typing.Union[str, typing.Any]',windowTitle:'str',style:'typing.Any',x:'typing.Any',y:'typing.Any',width:'typing.Any',height:'typing.Any',parent:'typing.Any',menu:'typing.Any',hinstance:'typing.Any',reserved:'typing.Any') -> 'typing.Any': +def CreateWindowEx( + dwExStyle: 'typing.Any', + className: 'typing.Union[str, typing.Any]', + windowTitle: 'str', + style: 'typing.Any', + x: 'typing.Any', + y: 'typing.Any', + width: 'typing.Any', + height: 'typing.Any', + parent: 'typing.Any', + menu: 'typing.Any', + hinstance: 'typing.Any', + reserved: 'typing.Any') -> 'typing.Any': """ Creates a new window with Extended Style. @@ -5236,7 +5913,7 @@ Returns: pass -def GetParent(child:'typing.Any') -> 'typing.Any': +def GetParent(child: 'typing.Any') -> 'typing.Any': """ Retrieves a handle to the specified child window's parent window. @@ -5252,7 +5929,7 @@ Returns: pass -def SetParent(child:'typing.Any',child1:'typing.Any') -> 'typing.Any': +def SetParent(child: 'typing.Any', child1: 'typing.Any') -> 'typing.Any': """ changes the parent window of the specified child window. @@ -5301,7 +5978,7 @@ Returns: pass -def GetWindow(hWnd:'typing.Any',uCmd:'typing.Any') -> 'typing.Any': +def GetWindow(hWnd: 'typing.Any', uCmd: 'typing.Any') -> 'typing.Any': """ returns a window that has the specified relationship (Z order or owner) to the specified window. @@ -5318,7 +5995,7 @@ Returns: pass -def GetWindowDC(hWnd:'typing.Any') -> 'typing.Any': +def GetWindowDC(hWnd: 'typing.Any') -> 'typing.Any': """ returns the device context (DC) for the entire window, including title bar, menus, and scroll bars. @@ -5334,7 +6011,7 @@ Returns: pass -def IsIconic(hWnd:'typing.Any') -> 'None': +def IsIconic(hWnd: 'typing.Any') -> 'None': """ determines whether the specified window is minimized (iconic). @@ -5350,7 +6027,7 @@ Returns: pass -def IsWindow(hWnd:'typing.Any') -> 'None': +def IsWindow(hWnd: 'typing.Any') -> 'None': """ determines whether the specified window handle identifies an existing window. @@ -5366,7 +6043,7 @@ Returns: pass -def IsChild(hWndParent:'typing.Any',hWnd:'typing.Any') -> 'None': +def IsChild(hWndParent: 'typing.Any', hWnd: 'typing.Any') -> 'None': """ Tests whether a window is a child window or descendant window of a specified parent window @@ -5431,7 +6108,7 @@ Returns: pass -def _TrackMouseEvent(tme:'win32typing.TRACKMOUSEEVENT') -> 'None': +def _TrackMouseEvent(tme: 'win32typing.TRACKMOUSEEVENT') -> 'None': """ Posts messages when the mouse pointer leaves a window or hovers over a window for a specified amount of time. @@ -5447,7 +6124,7 @@ Returns: pass -def ReleaseDC(hWnd:'typing.Any',hDC:'typing.Any') -> 'typing.Any': +def ReleaseDC(hWnd: 'typing.Any', hDC: 'typing.Any') -> 'typing.Any': """ Releases a device context. @@ -5464,7 +6141,11 @@ Returns: pass -def CreateCaret(hWnd:'typing.Any',hBitmap:'win32typing.PyGdiHANDLE',nWidth:'typing.Any',nHeight:'typing.Any') -> 'None': +def CreateCaret( + hWnd: 'typing.Any', + hBitmap: 'win32typing.PyGdiHANDLE', + nWidth: 'typing.Any', + nHeight: 'typing.Any') -> 'None': """ Creates a new caret for a window @@ -5499,7 +6180,14 @@ Returns: pass -def ScrollWindowEx(hWnd:'typing.Any',dx:'typing.Any',dy:'typing.Any',rcScroll:'win32typing.PyRECT',rcClip:'win32typing.PyRECT',hrgnUpdate:'typing.Any',flags:'typing.Any') -> 'tuple[typing.Any, win32typing.PyRECT]': +def ScrollWindowEx( + hWnd: 'typing.Any', + dx: 'typing.Any', + dy: 'typing.Any', + rcScroll: 'win32typing.PyRECT', + rcClip: 'win32typing.PyRECT', + hrgnUpdate: 'typing.Any', + flags: 'typing.Any') -> 'tuple[typing.Any, win32typing.PyRECT]': """ scrolls the content of the specified window's client area. @@ -5524,7 +6212,11 @@ If SW_SMOOTHSCROLL is specified, use upper 16 bits to specify time in millisecon pass -def SetScrollInfo(hwnd:'int',nBar:'typing.Any',scollInfo:'win32typing.PySCROLLINFO',bRedraw:'typing.Any'=1) -> 'None': +def SetScrollInfo( + hwnd: 'int', + nBar: 'typing.Any', + scollInfo: 'win32typing.PySCROLLINFO', + bRedraw: 'typing.Any' = 1) -> 'None': """ Sets information about a scroll-bar @@ -5545,7 +6237,7 @@ Return ValueReturns an int with the current position of the scroll box. pass -def GetScrollInfo(hwnd:'int',nBar:'typing.Any',mask:'typing.Any') -> 'win32typing.PySCROLLINFO': +def GetScrollInfo(hwnd: 'int', nBar: 'typing.Any', mask: 'typing.Any') -> 'win32typing.PySCROLLINFO': """ Returns information about a scroll bar @@ -5563,7 +6255,7 @@ Returns: pass -def GetClassName(hwnd:'int') -> 'str': +def GetClassName(hwnd: 'int') -> 'str': """ Retrieves the name of the class to which the specified window belongs. @@ -5579,7 +6271,7 @@ Returns: pass -def WindowFromPoint(point:'tuple[typing.Any, typing.Any]') -> 'typing.Any': +def WindowFromPoint(point: 'tuple[typing.Any, typing.Any]') -> 'typing.Any': """ Retrieves a handle to the window that contains the specified point. @@ -5595,7 +6287,7 @@ Returns: pass -def ChildWindowFromPoint(hwndParent:'typing.Any',point:'tuple[typing.Any, typing.Any]') -> 'typing.Any': +def ChildWindowFromPoint(hwndParent: 'typing.Any', point: 'tuple[typing.Any, typing.Any]') -> 'typing.Any': """ Determines which, if any, of the child windows belonging to a parent window contains the specified point. @@ -5612,24 +6304,7 @@ Returns: pass -def ChildWindowFromPoint(hwndParent:'typing.Any',point:'tuple[typing.Any, typing.Any]') -> 'typing.Any': - """ - Determines which, if any, of the child windows belonging to a parent window contains the specified point. - -Args: - - hwndParent(typing.Any):The parent. - point(tuple[typing.Any, typing.Any]):The point. - -Returns: - - typing.Any - - """ - pass - - -def ListView_SortItems(hwnd:'int',callback:'typing.Any',param:'typing.Any'=None) -> 'None': +def ListView_SortItems(hwnd: 'int', callback: 'typing.Any', param: 'typing.Any' = None) -> 'None': """ Uses an application-defined comparison function to sort the items of a list view control. @@ -5647,7 +6322,7 @@ Returns: pass -def ListView_SortItemsEx(hwnd:'int',callback:'typing.Any',param:'typing.Any'=None) -> 'None': +def ListView_SortItemsEx(hwnd: 'int', callback: 'typing.Any', param: 'typing.Any' = None) -> 'None': """ Uses an application-defined comparison function to sort the items of a list view control. @@ -5665,7 +6340,7 @@ Returns: pass -def CreateDC(Driver:'str',Device:'str',InitData:'win32typing.PyDEVMODE') -> 'typing.Any': +def CreateDC(Driver: 'str', Device: 'str', InitData: 'win32typing.PyDEVMODE') -> 'typing.Any': """ Creates a device context for a printer or display device @@ -5683,7 +6358,19 @@ Returns: pass -def GetSaveFileNameW(hwndOwner:'int'=None,hInstance:'int'=None,Filter:'typing.Any'=None,CustomFilter:'typing.Any'=None,FilterIndex:'typing.Any'=0,File:'typing.Any'=None,MaxFile:'typing.Any'=1024,InitialDir:'typing.Any'=None,Title:'typing.Any'=None,Flags:'typing.Any'=0,DefExt:'typing.Any'=None,TemplateName:'win32typing.PyResourceId'=None) -> 'tuple[typing.Any, typing.Any, typing.Any]': +def GetSaveFileNameW( + hwndOwner: 'int' = None, + hInstance: 'int' = None, + Filter: 'typing.Any' = None, + CustomFilter: 'typing.Any' = None, + FilterIndex: 'typing.Any' = 0, + File: 'typing.Any' = None, + MaxFile: 'typing.Any' = 1024, + InitialDir: 'typing.Any' = None, + Title: 'typing.Any' = None, + Flags: 'typing.Any' = 0, + DefExt: 'typing.Any' = None, + TemplateName: 'win32typing.PyResourceId' = None) -> 'tuple[typing.Any, typing.Any, typing.Any]': """ Creates a dialog for user to specify location to save a file or files @@ -5733,7 +6420,19 @@ win32gui.error is raised. If the user pressed cancel, the error number (ie, the pass -def GetOpenFileNameW(hwndOwner:'int'=None,hInstance:'int'=None,Filter:'typing.Any'=None,CustomFilter:'typing.Any'=None,FilterIndex:'typing.Any'=0,File:'typing.Any'=None,MaxFile:'typing.Any'=1024,InitialDir:'typing.Any'=None,Title:'typing.Any'=None,Flags:'typing.Any'=0,DefExt:'typing.Any'=None,TemplateName:'win32typing.PyResourceId'=None) -> 'tuple[typing.Any, typing.Any, typing.Any]': +def GetOpenFileNameW( + hwndOwner: 'int' = None, + hInstance: 'int' = None, + Filter: 'typing.Any' = None, + CustomFilter: 'typing.Any' = None, + FilterIndex: 'typing.Any' = 0, + File: 'typing.Any' = None, + MaxFile: 'typing.Any' = 1024, + InitialDir: 'typing.Any' = None, + Title: 'typing.Any' = None, + Flags: 'typing.Any' = 0, + DefExt: 'typing.Any' = None, + TemplateName: 'win32typing.PyResourceId' = None) -> 'tuple[typing.Any, typing.Any, typing.Any]': """ Creates a dialog to allow user to select file(s) to open @@ -5760,7 +6459,7 @@ Returns: pass -def SystemParametersInfo(Action:'typing.Any',Param:'typing.Any'=None,WinIni:'typing.Any'=0) -> 'None': +def SystemParametersInfo(Action: 'typing.Any', Param: 'typing.Any' = None, WinIni: 'typing.Any' = 0) -> 'None': """ Queries or sets system-wide parameters. This function can also update the user profile while setting a parameter. @@ -5965,7 +6664,7 @@ Return ValueSPI_SET functions all return None on success. Types returned by SPI pass -def SetLayeredWindowAttributes(hwnd:'int',Key:'typing.Any',Alpha:'typing.Any',Flags:'typing.Any') -> 'None': +def SetLayeredWindowAttributes(hwnd: 'int', Key: 'typing.Any', Alpha: 'typing.Any', Flags: 'typing.Any') -> 'None': """ Sets the opacity and transparency color key of a layered window. @@ -5984,7 +6683,7 @@ Returns: pass -def GetLayeredWindowAttributes(hwnd:'int') -> 'tuple[typing.Any, typing.Any, typing.Any]': +def GetLayeredWindowAttributes(hwnd: 'int') -> 'tuple[typing.Any, typing.Any, typing.Any]': """ Retrieves the layering parameters of a window with the WS_EX_LAYERED extended style @@ -6006,7 +6705,16 @@ Return ValueReturns a tuple of (color key, alpha, flags) pass -def UpdateLayeredWindow(hwnd:'int',arg:'tuple[int, int, int, int]',hdcDst:'int'=None,ptDst:'tuple[typing.Any, typing.Any]'=None,size:'tuple[typing.Any, typing.Any]'=None,hdcSrc:'typing.Any'=None,ptSrc:'tuple[typing.Any, typing.Any]'=None,Key:'typing.Any'=0,Flags:'typing.Any'=0) -> 'None': +def UpdateLayeredWindow( + hwnd: 'int', + arg: 'tuple[int, int, int, int]', + hdcDst: 'int' = None, + ptDst: 'tuple[typing.Any, typing.Any]' = None, + size: 'tuple[typing.Any, typing.Any]' = None, + hdcSrc: 'typing.Any' = None, + ptSrc: 'tuple[typing.Any, typing.Any]' = None, + Key: 'typing.Any' = 0, + Flags: 'typing.Any' = 0) -> 'None': """ Updates the position, size, shape, content, and translucency of a layered window. @@ -6030,7 +6738,7 @@ Returns: pass -def AnimateWindow(hwnd:'int',Time:'typing.Any',Flags:'typing.Any') -> 'None': +def AnimateWindow(hwnd: 'int', Time: 'typing.Any', Flags: 'typing.Any') -> 'None': """ Enables you to produce special effects when showing or hiding windows. There are three types of animation: roll, slide, and alpha-blended fade. @@ -6048,7 +6756,7 @@ Returns: pass -def CreateBrushIndirect(lb:'win32typing.PyLOGBRUSH') -> 'win32typing.PyGdiHANDLE': +def CreateBrushIndirect(lb: 'win32typing.PyLOGBRUSH') -> 'win32typing.PyGdiHANDLE': """ Creates a GDI brush from a LOGBRUSH struct @@ -6064,7 +6772,11 @@ Returns: pass -def ExtCreatePen(PenStyle:'typing.Any',Width:'typing.Any',lb:'win32typing.PyLOGBRUSH',Style:'tuple[typing.Any, ...]'=None) -> 'int': +def ExtCreatePen( + PenStyle: 'typing.Any', + Width: 'typing.Any', + lb: 'win32typing.PyLOGBRUSH', + Style: 'tuple[typing.Any, ...]' = None) -> 'int': """ Creates a GDI pen object @@ -6083,7 +6795,8 @@ Returns: pass -def DrawTextW(hDC:'int',String:'str',Count:'typing.Any',Rect:'win32typing.PyRECT',Format:'typing.Any') -> 'tuple[typing.Any, win32typing.PyRECT]': +def DrawTextW(hDC: 'int', String: 'str', Count: 'typing.Any', Rect: 'win32typing.PyRECT', + Format: 'typing.Any') -> 'tuple[typing.Any, win32typing.PyRECT]': """ Draws Unicode text on a device context. @@ -6107,7 +6820,7 @@ Return ValueReturns the height of the drawn text, and the rectangle coordinates pass -def EnumPropsEx(hWnd:'int',EnumFunc:'typing.Any',Param:'typing.Any') -> 'None': +def EnumPropsEx(hWnd: 'int', EnumFunc: 'typing.Any', Param: 'typing.Any') -> 'None': """ None @@ -6125,7 +6838,7 @@ Returns: pass -def RegisterDeviceNotification(handle:'int',_filter:'typing.Any',flags:'typing.Any') -> 'win32typing.PyHDEVNOTIFY': +def RegisterDeviceNotification(handle: 'int', _filter: 'typing.Any', flags: 'typing.Any') -> 'win32typing.PyHDEVNOTIFY': """ Registers the device or type of device for which a window will receive notifications. @@ -6163,7 +6876,7 @@ Returns: pass -def RegisterHotKey(hWnd:'int',_id:'typing.Any',Modifiers:'typing.Any',vk:'typing.Any') -> 'None': +def RegisterHotKey(hWnd: 'int', _id: 'typing.Any', Modifiers: 'typing.Any', vk: 'typing.Any') -> 'None': """ Registers a hotkey for a window @@ -6181,6 +6894,7 @@ Returns: """ pass + CLR_NONE = ... ILC_COLOR = ... ILC_COLOR16 = ... diff --git a/typings/win32con/__init__.pyi b/typings/win32con/__init__.pyi index 92e62fdc..ae8f3556 100644 --- a/typings/win32con/__init__.pyi +++ b/typings/win32con/__init__.pyi @@ -28,16 +28,16 @@ OFN_NOLONGNAMES = 262144 OFN_EXPLORER = 524288 # new look commdlg OFN_NODEREFERENCELINKS = 1048576 OFN_LONGNAMES = 2097152 # force long names for 3.x modules -OFN_ENABLEINCLUDENOTIFY = 4194304 # send include message to callback +OFN_ENABLEINCLUDENOTIFY = 4194304 # send include message to callback OFN_ENABLESIZING = 8388608 OFN_DONTADDTORECENT = 33554432 -OFN_FORCESHOWHIDDEN = 268435456 # Show All files including System and hidden files +OFN_FORCESHOWHIDDEN = 268435456 # Show All files including System and hidden files OFN_EX_NOPLACESBAR = 1 OFN_SHAREFALLTHROUGH = 2 OFN_SHARENOWARN = 1 OFN_SHAREWARN = 0 -CDN_FIRST = (PY_0U-601) -CDN_LAST = (PY_0U-699) +CDN_FIRST = (PY_0U - 601) +CDN_LAST = (PY_0U - 699) CDN_INITDONE = (CDN_FIRST - 0) CDN_SELCHANGE = (CDN_FIRST - 1) CDN_FOLDERCHANGE = (CDN_FIRST - 2) @@ -99,7 +99,7 @@ CF_NOOEMFONTS = CF_NOVECTORFONTS CF_NOSIMULATIONS = 4096 CF_LIMITSIZE = 8192 CF_FIXEDPITCHONLY = 16384 -CF_WYSIWYG = 32768 # must also have CF_SCREENFONTS & CF_PRINTERFONTS +CF_WYSIWYG = 32768 # must also have CF_SCREENFONTS & CF_PRINTERFONTS CF_FORCEFONTEXIST = 65536 CF_SCALABLEONLY = 131072 CF_TTONLY = 262144 @@ -163,32 +163,32 @@ PD_DISABLEPRINTTOFILE = 524288 PD_HIDEPRINTTOFILE = 1048576 PD_NONETWORKBUTTON = 2097152 DN_DEFAULTPRN = 1 -WM_PSD_PAGESETUPDLG = (WM_USER ) -WM_PSD_FULLPAGERECT = (WM_USER+1) -WM_PSD_MINMARGINRECT = (WM_USER+2) -WM_PSD_MARGINRECT = (WM_USER+3) -WM_PSD_GREEKTEXTRECT = (WM_USER+4) -WM_PSD_ENVSTAMPRECT = (WM_USER+5) -WM_PSD_YAFULLPAGERECT = (WM_USER+6) -PSD_DEFAULTMINMARGINS = 0 # default (printer's) -PSD_INWININIINTLMEASURE = 0 # 1st of 4 possible -PSD_MINMARGINS = 1 # use caller's -PSD_MARGINS = 2 # use caller's -PSD_INTHOUSANDTHSOFINCHES = 4 # 2nd of 4 possible -PSD_INHUNDREDTHSOFMILLIMETERS = 8 # 3rd of 4 possible +WM_PSD_PAGESETUPDLG = (WM_USER) +WM_PSD_FULLPAGERECT = (WM_USER + 1) +WM_PSD_MINMARGINRECT = (WM_USER + 2) +WM_PSD_MARGINRECT = (WM_USER + 3) +WM_PSD_GREEKTEXTRECT = (WM_USER + 4) +WM_PSD_ENVSTAMPRECT = (WM_USER + 5) +WM_PSD_YAFULLPAGERECT = (WM_USER + 6) +PSD_DEFAULTMINMARGINS = 0 # default (printer's) +PSD_INWININIINTLMEASURE = 0 # 1st of 4 possible +PSD_MINMARGINS = 1 # use caller's +PSD_MARGINS = 2 # use caller's +PSD_INTHOUSANDTHSOFINCHES = 4 # 2nd of 4 possible +PSD_INHUNDREDTHSOFMILLIMETERS = 8 # 3rd of 4 possible PSD_DISABLEMARGINS = 16 PSD_DISABLEPRINTER = 32 -PSD_NOWARNING = 128 # must be same as PD_* +PSD_NOWARNING = 128 # must be same as PD_* PSD_DISABLEORIENTATION = 256 -PSD_RETURNDEFAULT = 1024 # must be same as PD_* +PSD_RETURNDEFAULT = 1024 # must be same as PD_* PSD_DISABLEPAPER = 512 -PSD_SHOWHELP = 2048 # must be same as PD_* -PSD_ENABLEPAGESETUPHOOK = 8192 # must be same as PD_* -PSD_ENABLEPAGESETUPTEMPLATE = 32768 # must be same as PD_* -PSD_ENABLEPAGESETUPTEMPLATEHANDLE = 131072 # must be same as PD_* +PSD_SHOWHELP = 2048 # must be same as PD_* +PSD_ENABLEPAGESETUPHOOK = 8192 # must be same as PD_* +PSD_ENABLEPAGESETUPTEMPLATE = 32768 # must be same as PD_* +PSD_ENABLEPAGESETUPTEMPLATEHANDLE = 131072 # must be same as PD_* PSD_ENABLEPAGEPAINTHOOK = 262144 PSD_DISABLEPAGEPAINTING = 524288 -PSD_NONETWORKBUTTON = 2097152 # must be same as PD_* +PSD_NONETWORKBUTTON = 2097152 # must be same as PD_* # Generated by h2py from winreg.h HKEY_CLASSES_ROOT = -2147483648 @@ -889,7 +889,7 @@ DDL_POSTMSGS = 8192 DDL_DRIVES = 16384 DDL_EXCLUSIVE = 32768 -#from winuser.h line 153 +# from winuser.h line 153 RT_CURSOR = 1 RT_BITMAP = 2 RT_ICON = 3 @@ -1126,11 +1126,11 @@ HCBT_SETFOCUS = 9 MSGF_DIALOGBOX = 0 MSGF_MESSAGEBOX = 1 MSGF_MENU = 2 -#MSGF_MOVE = 3 -#MSGF_SIZE = 4 +# MSGF_MOVE = 3 +# MSGF_SIZE = 4 MSGF_SCROLLBAR = 5 MSGF_NEXTWINDOW = 6 -#MSGF_MAINLOOP = 8 +# MSGF_MAINLOOP = 8 MSGF_MAX = 8 MSGF_USER = 4096 HSHELL_WINDOWCREATED = 1 @@ -1358,7 +1358,7 @@ WM_MBUTTONDBLCLK = 521 WM_MOUSEWHEEL = 522 WM_MOUSELAST = 522 WHEEL_DELTA = 120 # Value for rolling one detent -WHEEL_PAGESCROLL = -1 # Scroll one page +WHEEL_PAGESCROLL = -1 # Scroll one page WM_PARENTNOTIFY = 528 MENULOOP_WINDOW = 0 MENULOOP_POPUP = 1 @@ -1446,8 +1446,8 @@ WMSZ_TOPRIGHT = 5 WMSZ_BOTTOM = 6 WMSZ_BOTTOMLEFT = 7 WMSZ_BOTTOMRIGHT = 8 -#ST_BEGINSWP = 0 -#ST_ENDSWP = 1 +# ST_BEGINSWP = 0 +# ST_ENDSWP = 1 HTERROR = (-2) HTTRANSPARENT = (-1) HTNOWHERE = 0 @@ -1538,15 +1538,15 @@ WS_MAXIMIZEBOX = 65536 WS_TILED = WS_OVERLAPPED WS_ICONIC = WS_MINIMIZE WS_SIZEBOX = WS_THICKFRAME -WS_OVERLAPPEDWINDOW = (WS_OVERLAPPED | \ - WS_CAPTION | \ - WS_SYSMENU | \ - WS_THICKFRAME | \ - WS_MINIMIZEBOX | \ - WS_MAXIMIZEBOX) -WS_POPUPWINDOW = (WS_POPUP | \ - WS_BORDER | \ - WS_SYSMENU) +WS_OVERLAPPEDWINDOW = (WS_OVERLAPPED + | WS_CAPTION + | WS_SYSMENU + | WS_THICKFRAME + | WS_MINIMIZEBOX + | WS_MAXIMIZEBOX) +WS_POPUPWINDOW = (WS_POPUP + | WS_BORDER + | WS_SYSMENU) WS_CHILDWINDOW = (WS_CHILD) WS_TILEDWINDOW = WS_OVERLAPPEDWINDOW WS_EX_DLGMODALFRAME = 1 @@ -1578,12 +1578,12 @@ WS_EX_NOACTIVATE = 0x08000000 CS_VREDRAW = 1 CS_HREDRAW = 2 -#CS_KEYCVTWINDOW = 0x0004 +# CS_KEYCVTWINDOW = 0x0004 CS_DBLCLKS = 8 CS_OWNDC = 32 CS_CLASSDC = 64 CS_PARENTDC = 128 -#CS_NOKEYCVT = 0x0100 +# CS_NOKEYCVT = 0x0100 CS_NOCLOSE = 512 CS_SAVEBITS = 2048 CS_BYTEALIGNCLIENT = 4096 @@ -1602,8 +1602,8 @@ BDR_RAISEDINNER = 4 BDR_SUNKENINNER = 8 BDR_OUTER = 3 BDR_INNER = 12 -#BDR_RAISED = 0x0005 -#BDR_SUNKEN = 0x000a +# BDR_RAISED = 0x0005 +# BDR_SUNKEN = 0x000a EDGE_RAISED = (BDR_RAISEDOUTER | BDR_RAISEDINNER) EDGE_SUNKEN = (BDR_SUNKENOUTER | BDR_SUNKENINNER) EDGE_ETCHED = (BDR_SUNKENOUTER | BDR_RAISEDINNER) @@ -1638,21 +1638,21 @@ DS_CONTROL = 1024 DS_CENTER = 2048 DS_CENTERMOUSE = 4096 DS_CONTEXTHELP = 8192 -DM_GETDEFID = (WM_USER+0) -DM_SETDEFID = (WM_USER+1) -DM_REPOSITION = (WM_USER+2) -#PSM_PAGEINFO = (WM_USER+100) -#PSM_SHEETINFO = (WM_USER+101) -#PSI_SETACTIVE = 0x0001 -#PSI_KILLACTIVE = 0x0002 -#PSI_APPLY = 0x0003 -#PSI_RESET = 0x0004 -#PSI_HASHELP = 0x0005 -#PSI_HELP = 0x0006 -#PSI_CHANGED = 0x0001 -#PSI_GUISTART = 0x0002 -#PSI_REBOOT = 0x0003 -#PSI_GETSIBLINGS = 0x0004 +DM_GETDEFID = (WM_USER + 0) +DM_SETDEFID = (WM_USER + 1) +DM_REPOSITION = (WM_USER + 2) +# PSM_PAGEINFO = (WM_USER+100) +# PSM_SHEETINFO = (WM_USER+101) +# PSI_SETACTIVE = 0x0001 +# PSI_KILLACTIVE = 0x0002 +# PSI_APPLY = 0x0003 +# PSI_RESET = 0x0004 +# PSI_HASHELP = 0x0005 +# PSI_HELP = 0x0006 +# PSI_CHANGED = 0x0001 +# PSI_GUISTART = 0x0002 +# PSI_REBOOT = 0x0003 +# PSI_GETSIBLINGS = 0x0004 DC_HASDEFID = 21323 DLGC_WANTARROWS = 1 DLGC_WANTTAB = 2 @@ -1857,18 +1857,18 @@ SERVICE_KERNEL_DRIVER = 1 SERVICE_FILE_SYSTEM_DRIVER = 2 SERVICE_ADAPTER = 4 SERVICE_RECOGNIZER_DRIVER = 8 -SERVICE_DRIVER = (SERVICE_KERNEL_DRIVER | \ - SERVICE_FILE_SYSTEM_DRIVER | \ - SERVICE_RECOGNIZER_DRIVER) +SERVICE_DRIVER = (SERVICE_KERNEL_DRIVER + | SERVICE_FILE_SYSTEM_DRIVER + | SERVICE_RECOGNIZER_DRIVER) SERVICE_WIN32_OWN_PROCESS = 16 SERVICE_WIN32_SHARE_PROCESS = 32 -SERVICE_WIN32 = (SERVICE_WIN32_OWN_PROCESS | \ - SERVICE_WIN32_SHARE_PROCESS) +SERVICE_WIN32 = (SERVICE_WIN32_OWN_PROCESS + | SERVICE_WIN32_SHARE_PROCESS) SERVICE_INTERACTIVE_PROCESS = 256 -SERVICE_TYPE_ALL = (SERVICE_WIN32 | \ - SERVICE_ADAPTER | \ - SERVICE_DRIVER | \ - SERVICE_INTERACTIVE_PROCESS) +SERVICE_TYPE_ALL = (SERVICE_WIN32 + | SERVICE_ADAPTER + | SERVICE_DRIVER + | SERVICE_INTERACTIVE_PROCESS) SERVICE_BOOT_START = 0 SERVICE_SYSTEM_START = 1 SERVICE_AUTO_START = 2 @@ -2039,9 +2039,15 @@ SORT_CHINESE_BIG5 = 0 SORT_CHINESE_UNICODE = 1 SORT_KOREAN_KSC = 0 SORT_KOREAN_UNICODE = 1 -def PRIMARYLANGID(lgid): return ((lgid) & 1023) -def SUBLANGID(lgid): return ((lgid) >> 10) + +def PRIMARYLANGID(lgid) -> int: + ... + + +def SUBLANGID(lgid) -> int: + ... + NLS_VALID_LOCALE_MASK = 1048575 CONTEXT_PORTABLE_32BIT = 1048576 @@ -2268,21 +2274,21 @@ TOKEN_QUERY_SOURCE = (16) TOKEN_ADJUST_PRIVILEGES = (32) TOKEN_ADJUST_GROUPS = (64) TOKEN_ADJUST_DEFAULT = (128) -TOKEN_ALL_ACCESS = (STANDARD_RIGHTS_REQUIRED |\ - TOKEN_ASSIGN_PRIMARY |\ - TOKEN_DUPLICATE |\ - TOKEN_IMPERSONATE |\ - TOKEN_QUERY |\ - TOKEN_QUERY_SOURCE |\ - TOKEN_ADJUST_PRIVILEGES |\ - TOKEN_ADJUST_GROUPS |\ - TOKEN_ADJUST_DEFAULT) -TOKEN_READ = (STANDARD_RIGHTS_READ |\ - TOKEN_QUERY) -TOKEN_WRITE = (STANDARD_RIGHTS_WRITE |\ - TOKEN_ADJUST_PRIVILEGES |\ - TOKEN_ADJUST_GROUPS |\ - TOKEN_ADJUST_DEFAULT) +TOKEN_ALL_ACCESS = (STANDARD_RIGHTS_REQUIRED + | TOKEN_ASSIGN_PRIMARY + | TOKEN_DUPLICATE + | TOKEN_IMPERSONATE + | TOKEN_QUERY + | TOKEN_QUERY_SOURCE + | TOKEN_ADJUST_PRIVILEGES + | TOKEN_ADJUST_GROUPS + | TOKEN_ADJUST_DEFAULT) +TOKEN_READ = (STANDARD_RIGHTS_READ + | TOKEN_QUERY) +TOKEN_WRITE = (STANDARD_RIGHTS_WRITE + | TOKEN_ADJUST_PRIVILEGES + | TOKEN_ADJUST_GROUPS + | TOKEN_ADJUST_DEFAULT) TOKEN_EXECUTE = (STANDARD_RIGHTS_EXECUTE) TOKEN_SOURCE_LENGTH = 8 @@ -2295,47 +2301,47 @@ KEY_CREATE_LINK = (32) KEY_WOW64_32KEY = 512 KEY_WOW64_64KEY = 256 KEY_WOW64_RES = 768 -KEY_READ = ((STANDARD_RIGHTS_READ |\ - KEY_QUERY_VALUE |\ - KEY_ENUMERATE_SUB_KEYS |\ - KEY_NOTIFY) \ - & \ - (~SYNCHRONIZE)) -KEY_WRITE = ((STANDARD_RIGHTS_WRITE |\ - KEY_SET_VALUE |\ - KEY_CREATE_SUB_KEY) \ - & \ - (~SYNCHRONIZE)) -KEY_EXECUTE = ((KEY_READ) \ - & \ - (~SYNCHRONIZE)) -KEY_ALL_ACCESS = ((STANDARD_RIGHTS_ALL |\ - KEY_QUERY_VALUE |\ - KEY_SET_VALUE |\ - KEY_CREATE_SUB_KEY |\ - KEY_ENUMERATE_SUB_KEYS |\ - KEY_NOTIFY |\ - KEY_CREATE_LINK) \ - & \ - (~SYNCHRONIZE)) +KEY_READ = ((STANDARD_RIGHTS_READ + | KEY_QUERY_VALUE + | KEY_ENUMERATE_SUB_KEYS + | KEY_NOTIFY) + + & (~SYNCHRONIZE)) +KEY_WRITE = ((STANDARD_RIGHTS_WRITE + | KEY_SET_VALUE + | KEY_CREATE_SUB_KEY) + + & (~SYNCHRONIZE)) +KEY_EXECUTE = ((KEY_READ) + + & (~SYNCHRONIZE)) +KEY_ALL_ACCESS = ((STANDARD_RIGHTS_ALL + | KEY_QUERY_VALUE + | KEY_SET_VALUE + | KEY_CREATE_SUB_KEY + | KEY_ENUMERATE_SUB_KEYS + | KEY_NOTIFY + | KEY_CREATE_LINK) + + & (~SYNCHRONIZE)) REG_NOTIFY_CHANGE_ATTRIBUTES = (2) REG_NOTIFY_CHANGE_SECURITY = (8) -REG_RESOURCE_REQUIREMENTS_LIST = ( 10 ) -REG_NONE = ( 0 ) # No value type -REG_SZ = ( 1 ) # Unicode nul terminated string -REG_EXPAND_SZ = ( 2 ) # Unicode nul terminated string - # (with environment variable references) -REG_BINARY = ( 3 ) # Free form binary -REG_DWORD = ( 4 ) # 32-bit number -REG_DWORD_LITTLE_ENDIAN = ( 4 ) # 32-bit number (same as REG_DWORD) -REG_DWORD_BIG_ENDIAN = ( 5 ) # 32-bit number -REG_LINK = ( 6 ) # Symbolic Link (unicode) -REG_MULTI_SZ = ( 7 ) # Multiple Unicode strings -REG_RESOURCE_LIST = ( 8 ) # Resource list in the resource map -REG_FULL_RESOURCE_DESCRIPTOR =( 9 ) # Resource list in the hardware description -REG_RESOURCE_REQUIREMENTS_LIST = ( 10 ) -REG_QWORD = ( 11 ) # 64-bit number -REG_QWORD_LITTLE_ENDIAN = ( 11 ) # 64-bit number (same as REG_QWORD) +REG_RESOURCE_REQUIREMENTS_LIST = (10) +REG_NONE = (0) # No value type +REG_SZ = (1) # Unicode nul terminated string +REG_EXPAND_SZ = (2) # Unicode nul terminated string +# (with environment variable references) +REG_BINARY = (3) # Free form binary +REG_DWORD = (4) # 32-bit number +REG_DWORD_LITTLE_ENDIAN = (4) # 32-bit number (same as REG_DWORD) +REG_DWORD_BIG_ENDIAN = (5) # 32-bit number +REG_LINK = (6) # Symbolic Link (unicode) +REG_MULTI_SZ = (7) # Multiple Unicode strings +REG_RESOURCE_LIST = (8) # Resource list in the resource map +REG_FULL_RESOURCE_DESCRIPTOR = (9) # Resource list in the hardware description +REG_RESOURCE_REQUIREMENTS_LIST = (10) +REG_QWORD = (11) # 64-bit number +REG_QWORD_LITTLE_ENDIAN = (11) # 64-bit number (same as REG_QWORD) # Generated by h2py from \msvc20\include\winnt.h @@ -2498,9 +2504,15 @@ IMAGE_ARCHIVE_LINKER_MEMBER = "/ " IMAGE_ARCHIVE_LONGNAMES_MEMBER = "// " IMAGE_SIZEOF_ARCHIVE_MEMBER_HDR = 60 IMAGE_ORDINAL_FLAG = -2147483648 -def IMAGE_SNAP_BY_ORDINAL(Ordinal): return ((Ordinal & IMAGE_ORDINAL_FLAG) != 0) -def IMAGE_ORDINAL(Ordinal): return (Ordinal & 65535) + +def IMAGE_SNAP_BY_ORDINAL(Ordinal) -> bool: + ... + + +def IMAGE_ORDINAL(Ordinal) -> int: + ... + IMAGE_RESOURCE_NAME_IS_STRING = -2147483648 IMAGE_RESOURCE_DATA_IS_DIRECTORY = -2147483648 @@ -2604,7 +2616,7 @@ SP_OUTOFDISK = (-4) SP_OUTOFMEMORY = (-5) PR_JOBSTATUS = 0 -## GDI object types +# GDI object types OBJ_PEN = 1 OBJ_BRUSH = 2 OBJ_DC = 3 @@ -2651,9 +2663,9 @@ CLIP_DEFAULT_PRECIS = 0 CLIP_CHARACTER_PRECIS = 1 CLIP_STROKE_PRECIS = 2 CLIP_MASK = 15 -CLIP_LH_ANGLES = (1<<4) -CLIP_TT_ALWAYS = (2<<4) -CLIP_EMBEDDED = (8<<4) +CLIP_LH_ANGLES = (1 << 4) +CLIP_TT_ALWAYS = (2 << 4) +CLIP_EMBEDDED = (8 << 4) DEFAULT_QUALITY = 0 DRAFT_QUALITY = 1 PROOF_QUALITY = 2 @@ -2682,12 +2694,12 @@ EASTEUROPE_CHARSET = 238 RUSSIAN_CHARSET = 204 MAC_CHARSET = 77 BALTIC_CHARSET = 186 -FF_DONTCARE = (0<<4) -FF_ROMAN = (1<<4) -FF_SWISS = (2<<4) -FF_MODERN = (3<<4) -FF_SCRIPT = (4<<4) -FF_DECORATIVE = (5<<4) +FF_DONTCARE = (0 << 4) +FF_ROMAN = (1 << 4) +FF_SWISS = (2 << 4) +FF_MODERN = (3 << 4) +FF_SCRIPT = (4 << 4) +FF_DECORATIVE = (5 << 4) FW_DONTCARE = 0 FW_THIN = 100 FW_EXTRALIGHT = 200 @@ -3480,16 +3492,28 @@ ELF_CULTURE_LATIN = 0 RASTER_FONTTYPE = 1 DEVICE_FONTTYPE = 2 TRUETYPE_FONTTYPE = 4 -def PALETTEINDEX(i): return ((16777216 | (i))) + + +def PALETTEINDEX(i) -> int: + ... + PC_RESERVED = 1 PC_EXPLICIT = 2 PC_NOCOLLAPSE = 4 -def GetRValue(rgb): return rgb & 0xff -def GetGValue(rgb): return (rgb >> 8) & 0xff -def GetBValue(rgb): return (rgb >> 16) & 0xff +def GetRValue(rgb) -> int: + ... + + +def GetGValue(rgb) -> int: + ... + + +def GetBValue(rgb) -> int: + ... + TRANSPARENT = 1 OPAQUE = 2 @@ -3538,70 +3562,70 @@ DC_BRUSH = 18 DC_PEN = 19 # Exception/Status codes from winuser.h and winnt.h -STATUS_WAIT_0 = 0 -STATUS_ABANDONED_WAIT_0 = 128 -STATUS_USER_APC = 192 -STATUS_TIMEOUT = 258 -STATUS_PENDING = 259 -STATUS_SEGMENT_NOTIFICATION = 1073741829 -STATUS_GUARD_PAGE_VIOLATION = -2147483647 -STATUS_DATATYPE_MISALIGNMENT = -2147483646 -STATUS_BREAKPOINT = -2147483645 -STATUS_SINGLE_STEP = -2147483644 -STATUS_ACCESS_VIOLATION = -1073741819 -STATUS_IN_PAGE_ERROR = -1073741818 -STATUS_INVALID_HANDLE = -1073741816 -STATUS_NO_MEMORY = -1073741801 -STATUS_ILLEGAL_INSTRUCTION = -1073741795 -STATUS_NONCONTINUABLE_EXCEPTION = -1073741787 -STATUS_INVALID_DISPOSITION = -1073741786 -STATUS_ARRAY_BOUNDS_EXCEEDED = -1073741684 -STATUS_FLOAT_DENORMAL_OPERAND = -1073741683 -STATUS_FLOAT_DIVIDE_BY_ZERO = -1073741682 -STATUS_FLOAT_INEXACT_RESULT = -1073741681 -STATUS_FLOAT_INVALID_OPERATION = -1073741680 -STATUS_FLOAT_OVERFLOW = -1073741679 -STATUS_FLOAT_STACK_CHECK = -1073741678 -STATUS_FLOAT_UNDERFLOW = -1073741677 -STATUS_INTEGER_DIVIDE_BY_ZERO = -1073741676 -STATUS_INTEGER_OVERFLOW = -1073741675 -STATUS_PRIVILEGED_INSTRUCTION = -1073741674 -STATUS_STACK_OVERFLOW = -1073741571 -STATUS_CONTROL_C_EXIT = -1073741510 +STATUS_WAIT_0 = 0 +STATUS_ABANDONED_WAIT_0 = 128 +STATUS_USER_APC = 192 +STATUS_TIMEOUT = 258 +STATUS_PENDING = 259 +STATUS_SEGMENT_NOTIFICATION = 1073741829 +STATUS_GUARD_PAGE_VIOLATION = -2147483647 +STATUS_DATATYPE_MISALIGNMENT = -2147483646 +STATUS_BREAKPOINT = -2147483645 +STATUS_SINGLE_STEP = -2147483644 +STATUS_ACCESS_VIOLATION = -1073741819 +STATUS_IN_PAGE_ERROR = -1073741818 +STATUS_INVALID_HANDLE = -1073741816 +STATUS_NO_MEMORY = -1073741801 +STATUS_ILLEGAL_INSTRUCTION = -1073741795 +STATUS_NONCONTINUABLE_EXCEPTION = -1073741787 +STATUS_INVALID_DISPOSITION = -1073741786 +STATUS_ARRAY_BOUNDS_EXCEEDED = -1073741684 +STATUS_FLOAT_DENORMAL_OPERAND = -1073741683 +STATUS_FLOAT_DIVIDE_BY_ZERO = -1073741682 +STATUS_FLOAT_INEXACT_RESULT = -1073741681 +STATUS_FLOAT_INVALID_OPERATION = -1073741680 +STATUS_FLOAT_OVERFLOW = -1073741679 +STATUS_FLOAT_STACK_CHECK = -1073741678 +STATUS_FLOAT_UNDERFLOW = -1073741677 +STATUS_INTEGER_DIVIDE_BY_ZERO = -1073741676 +STATUS_INTEGER_OVERFLOW = -1073741675 +STATUS_PRIVILEGED_INSTRUCTION = -1073741674 +STATUS_STACK_OVERFLOW = -1073741571 +STATUS_CONTROL_C_EXIT = -1073741510 -WAIT_FAILED = -1 -WAIT_OBJECT_0 = STATUS_WAIT_0 + 0 +WAIT_FAILED = -1 +WAIT_OBJECT_0 = STATUS_WAIT_0 + 0 -WAIT_ABANDONED = STATUS_ABANDONED_WAIT_0 + 0 -WAIT_ABANDONED_0 = STATUS_ABANDONED_WAIT_0 + 0 +WAIT_ABANDONED = STATUS_ABANDONED_WAIT_0 + 0 +WAIT_ABANDONED_0 = STATUS_ABANDONED_WAIT_0 + 0 -WAIT_TIMEOUT = STATUS_TIMEOUT -WAIT_IO_COMPLETION = STATUS_USER_APC -STILL_ACTIVE = STATUS_PENDING -EXCEPTION_ACCESS_VIOLATION = STATUS_ACCESS_VIOLATION -EXCEPTION_DATATYPE_MISALIGNMENT = STATUS_DATATYPE_MISALIGNMENT -EXCEPTION_BREAKPOINT = STATUS_BREAKPOINT -EXCEPTION_SINGLE_STEP = STATUS_SINGLE_STEP -EXCEPTION_ARRAY_BOUNDS_EXCEEDED = STATUS_ARRAY_BOUNDS_EXCEEDED -EXCEPTION_FLT_DENORMAL_OPERAND = STATUS_FLOAT_DENORMAL_OPERAND -EXCEPTION_FLT_DIVIDE_BY_ZERO = STATUS_FLOAT_DIVIDE_BY_ZERO -EXCEPTION_FLT_INEXACT_RESULT = STATUS_FLOAT_INEXACT_RESULT -EXCEPTION_FLT_INVALID_OPERATION = STATUS_FLOAT_INVALID_OPERATION -EXCEPTION_FLT_OVERFLOW = STATUS_FLOAT_OVERFLOW -EXCEPTION_FLT_STACK_CHECK = STATUS_FLOAT_STACK_CHECK -EXCEPTION_FLT_UNDERFLOW = STATUS_FLOAT_UNDERFLOW -EXCEPTION_INT_DIVIDE_BY_ZERO = STATUS_INTEGER_DIVIDE_BY_ZERO -EXCEPTION_INT_OVERFLOW = STATUS_INTEGER_OVERFLOW -EXCEPTION_PRIV_INSTRUCTION = STATUS_PRIVILEGED_INSTRUCTION -EXCEPTION_IN_PAGE_ERROR = STATUS_IN_PAGE_ERROR -EXCEPTION_ILLEGAL_INSTRUCTION = STATUS_ILLEGAL_INSTRUCTION -EXCEPTION_NONCONTINUABLE_EXCEPTION = STATUS_NONCONTINUABLE_EXCEPTION -EXCEPTION_STACK_OVERFLOW = STATUS_STACK_OVERFLOW -EXCEPTION_INVALID_DISPOSITION = STATUS_INVALID_DISPOSITION -EXCEPTION_GUARD_PAGE = STATUS_GUARD_PAGE_VIOLATION -EXCEPTION_INVALID_HANDLE = STATUS_INVALID_HANDLE -CONTROL_C_EXIT = STATUS_CONTROL_C_EXIT +WAIT_TIMEOUT = STATUS_TIMEOUT +WAIT_IO_COMPLETION = STATUS_USER_APC +STILL_ACTIVE = STATUS_PENDING +EXCEPTION_ACCESS_VIOLATION = STATUS_ACCESS_VIOLATION +EXCEPTION_DATATYPE_MISALIGNMENT = STATUS_DATATYPE_MISALIGNMENT +EXCEPTION_BREAKPOINT = STATUS_BREAKPOINT +EXCEPTION_SINGLE_STEP = STATUS_SINGLE_STEP +EXCEPTION_ARRAY_BOUNDS_EXCEEDED = STATUS_ARRAY_BOUNDS_EXCEEDED +EXCEPTION_FLT_DENORMAL_OPERAND = STATUS_FLOAT_DENORMAL_OPERAND +EXCEPTION_FLT_DIVIDE_BY_ZERO = STATUS_FLOAT_DIVIDE_BY_ZERO +EXCEPTION_FLT_INEXACT_RESULT = STATUS_FLOAT_INEXACT_RESULT +EXCEPTION_FLT_INVALID_OPERATION = STATUS_FLOAT_INVALID_OPERATION +EXCEPTION_FLT_OVERFLOW = STATUS_FLOAT_OVERFLOW +EXCEPTION_FLT_STACK_CHECK = STATUS_FLOAT_STACK_CHECK +EXCEPTION_FLT_UNDERFLOW = STATUS_FLOAT_UNDERFLOW +EXCEPTION_INT_DIVIDE_BY_ZERO = STATUS_INTEGER_DIVIDE_BY_ZERO +EXCEPTION_INT_OVERFLOW = STATUS_INTEGER_OVERFLOW +EXCEPTION_PRIV_INSTRUCTION = STATUS_PRIVILEGED_INSTRUCTION +EXCEPTION_IN_PAGE_ERROR = STATUS_IN_PAGE_ERROR +EXCEPTION_ILLEGAL_INSTRUCTION = STATUS_ILLEGAL_INSTRUCTION +EXCEPTION_NONCONTINUABLE_EXCEPTION = STATUS_NONCONTINUABLE_EXCEPTION +EXCEPTION_STACK_OVERFLOW = STATUS_STACK_OVERFLOW +EXCEPTION_INVALID_DISPOSITION = STATUS_INVALID_DISPOSITION +EXCEPTION_GUARD_PAGE = STATUS_GUARD_PAGE_VIOLATION +EXCEPTION_INVALID_HANDLE = STATUS_INVALID_HANDLE +CONTROL_C_EXIT = STATUS_CONTROL_C_EXIT # winuser.h line 8594 # constants used with SystemParametersInfo @@ -3804,7 +3828,7 @@ ARW_RIGHT = 0 ARW_UP = 4 ARW_DOWN = 4 ARW_HIDE = 8 -#ARW_VALID = 0x000F +# ARW_VALID = 0x000F SERKF_SERIALKEYSON = 1 SERKF_AVAILABLE = 2 SERKF_INDICATOR = 4 @@ -4133,7 +4157,7 @@ CF_PRIVATEFIRST = 512 CF_PRIVATELAST = 767 CF_GDIOBJFIRST = 768 CF_GDIOBJLAST = 1023 -FVIRTKEY =1 +FVIRTKEY = 1 FNOINVERT = 2 FSHIFT = 4 FCONTROL = 8 @@ -4166,9 +4190,9 @@ MOD_SHIFT = 4 MOD_WIN = 8 IDHOT_SNAPWINDOW = (-1) IDHOT_SNAPDESKTOP = (-2) -#EW_RESTARTWINDOWS = 0x0042 -#EW_REBOOTSYSTEM = 0x0043 -#EW_EXITANDEXECAPP = 0x0044 +# EW_RESTARTWINDOWS = 0x0042 +# EW_REBOOTSYSTEM = 0x0043 +# EW_EXITANDEXECAPP = 0x0044 ENDSESSION_LOGOFF = -2147483648 EWX_LOGOFF = 0 EWX_SHUTDOWN = 1 @@ -4236,21 +4260,21 @@ QS_TIMER = 16 QS_PAINT = 32 QS_SENDMESSAGE = 64 QS_HOTKEY = 128 -QS_MOUSE = (QS_MOUSEMOVE | \ - QS_MOUSEBUTTON) -QS_INPUT = (QS_MOUSE | \ - QS_KEY) -QS_ALLEVENTS = (QS_INPUT | \ - QS_POSTMESSAGE | \ - QS_TIMER | \ - QS_PAINT | \ - QS_HOTKEY) -QS_ALLINPUT = (QS_INPUT | \ - QS_POSTMESSAGE | \ - QS_TIMER | \ - QS_PAINT | \ - QS_HOTKEY | \ - QS_SENDMESSAGE) +QS_MOUSE = (QS_MOUSEMOVE + | QS_MOUSEBUTTON) +QS_INPUT = (QS_MOUSE + | QS_KEY) +QS_ALLEVENTS = (QS_INPUT + | QS_POSTMESSAGE + | QS_TIMER + | QS_PAINT + | QS_HOTKEY) +QS_ALLINPUT = (QS_INPUT + | QS_POSTMESSAGE + | QS_TIMER + | QS_PAINT + | QS_HOTKEY + | QS_SENDMESSAGE) IMN_CLOSESTATUSWINDOW = 1 @@ -4291,8 +4315,8 @@ HELP_TCARD = 32768 HELP_TCARD_DATA = 16 HELP_TCARD_OTHER_CALLER = 17 IDH_NO_HELP = 28440 -IDH_MISSING_CONTEXT = 28441 # Control doesn't have matching help context -IDH_GENERIC_HELP_BUTTON = 28442 # Property sheet help button +IDH_MISSING_CONTEXT = 28441 # Control doesn't have matching help context +IDH_GENERIC_HELP_BUTTON = 28442 # Property sheet help button IDH_OK = 28443 IDH_CANCEL = 28444 IDH_HELP = 28445 @@ -4300,21 +4324,21 @@ GR_GDIOBJECTS = 0 # Count of GDI objects GR_USEROBJECTS = 1 # Count of USER objects # Generated by h2py from \msvcnt\include\wingdi.h # manually added (missed by generation some how! -SRCCOPY = 13369376 # dest = source -SRCPAINT = 15597702 # dest = source OR dest -SRCAND = 8913094 # dest = source AND dest -SRCINVERT = 6684742 # dest = source XOR dest -SRCERASE = 4457256 # dest = source AND (NOT dest ) -NOTSRCCOPY = 3342344 # dest = (NOT source) -NOTSRCERASE = 1114278 # dest = (NOT src) AND (NOT dest) -MERGECOPY = 12583114 # dest = (source AND pattern) -MERGEPAINT = 12255782 # dest = (NOT source) OR dest -PATCOPY = 15728673 # dest = pattern -PATPAINT = 16452105 # dest = DPSnoo -PATINVERT = 5898313 # dest = pattern XOR dest -DSTINVERT = 5570569 # dest = (NOT dest) -BLACKNESS = 66 # dest = BLACK -WHITENESS = 16711778 # dest = WHITE +SRCCOPY = 13369376 # dest = source +SRCPAINT = 15597702 # dest = source OR dest +SRCAND = 8913094 # dest = source AND dest +SRCINVERT = 6684742 # dest = source XOR dest +SRCERASE = 4457256 # dest = source AND (NOT dest ) +NOTSRCCOPY = 3342344 # dest = (NOT source) +NOTSRCERASE = 1114278 # dest = (NOT src) AND (NOT dest) +MERGECOPY = 12583114 # dest = (source AND pattern) +MERGEPAINT = 12255782 # dest = (NOT source) OR dest +PATCOPY = 15728673 # dest = pattern +PATPAINT = 16452105 # dest = DPSnoo +PATINVERT = 5898313 # dest = pattern XOR dest +DSTINVERT = 5570569 # dest = (NOT dest) +BLACKNESS = 66 # dest = BLACK +WHITENESS = 16711778 # dest = WHITE # hacked and split manually by mhammond. R2_BLACK = 1 @@ -4348,7 +4372,7 @@ RGN_COPY = 5 RGN_MIN = RGN_AND RGN_MAX = RGN_COPY -## Stretching modes used with Get/SetStretchBltMode +# Stretching modes used with Get/SetStretchBltMode BLACKONWHITE = 1 WHITEONBLACK = 2 COLORONCOLOR = 3 @@ -4363,11 +4387,11 @@ ALTERNATE = 1 WINDING = 2 POLYFILL_LAST = 2 -## flags used with SetLayout +# flags used with SetLayout LAYOUT_RTL = 1 LAYOUT_BTT = 2 LAYOUT_VBH = 4 -LAYOUT_ORIENTATIONMASK = LAYOUT_RTL|LAYOUT_BTT|LAYOUT_VBH +LAYOUT_ORIENTATIONMASK = LAYOUT_RTL | LAYOUT_BTT | LAYOUT_VBH LAYOUT_BITMAPORIENTATIONPRESERVED = 8 TA_NOUPDATECP = 0 @@ -4378,7 +4402,7 @@ TA_CENTER = 6 TA_TOP = 0 TA_BOTTOM = 8 TA_BASELINE = 24 -TA_MASK = (TA_BASELINE+TA_CENTER+TA_UPDATECP) +TA_MASK = (TA_BASELINE + TA_CENTER + TA_UPDATECP) VTA_BASELINE = TA_BASELINE VTA_LEFT = TA_BOTTOM VTA_RIGHT = TA_TOP @@ -4553,17 +4577,17 @@ CREATE_NO_WINDOW = 134217728 PROFILE_USER = 268435456 PROFILE_KERNEL = 536870912 PROFILE_SERVER = 1073741824 -THREAD_BASE_PRIORITY_LOWRT = 15 -THREAD_BASE_PRIORITY_MAX = 2 -THREAD_BASE_PRIORITY_MIN = -2 +THREAD_BASE_PRIORITY_LOWRT = 15 +THREAD_BASE_PRIORITY_MAX = 2 +THREAD_BASE_PRIORITY_MIN = -2 THREAD_BASE_PRIORITY_IDLE = -15 THREAD_PRIORITY_LOWEST = THREAD_BASE_PRIORITY_MIN -THREAD_PRIORITY_BELOW_NORMAL = THREAD_PRIORITY_LOWEST+1 -THREAD_PRIORITY_HIGHEST = THREAD_BASE_PRIORITY_MAX -THREAD_PRIORITY_ABOVE_NORMAL = THREAD_PRIORITY_HIGHEST-1 -THREAD_PRIORITY_ERROR_RETURN = MAXLONG -THREAD_PRIORITY_TIME_CRITICAL = THREAD_BASE_PRIORITY_LOWRT -THREAD_PRIORITY_IDLE = THREAD_BASE_PRIORITY_IDLE +THREAD_PRIORITY_BELOW_NORMAL = THREAD_PRIORITY_LOWEST + 1 +THREAD_PRIORITY_HIGHEST = THREAD_BASE_PRIORITY_MAX +THREAD_PRIORITY_ABOVE_NORMAL = THREAD_PRIORITY_HIGHEST - 1 +THREAD_PRIORITY_ERROR_RETURN = MAXLONG +THREAD_PRIORITY_TIME_CRITICAL = THREAD_BASE_PRIORITY_LOWRT +THREAD_PRIORITY_IDLE = THREAD_BASE_PRIORITY_IDLE THREAD_PRIORITY_NORMAL = 0 THREAD_MODE_BACKGROUND_BEGIN = 0x00010000 THREAD_MODE_BACKGROUND_END = 0x00020000 @@ -4854,40 +4878,40 @@ CF_RTFNOOBJS = "Rich Text Format Without Objects" CF_RETEXTOBJ = "RichEdit Text and Objects" # From wincon.h -RIGHT_ALT_PRESSED = 1 # the right alt key is pressed. -LEFT_ALT_PRESSED = 2 # the left alt key is pressed. -RIGHT_CTRL_PRESSED = 4 # the right ctrl key is pressed. -LEFT_CTRL_PRESSED = 8 # the left ctrl key is pressed. -SHIFT_PRESSED = 16 # the shift key is pressed. -NUMLOCK_ON = 32 # the numlock light is on. -SCROLLLOCK_ON = 64 # the scrolllock light is on. -CAPSLOCK_ON = 128 # the capslock light is on. -ENHANCED_KEY = 256 # the key is enhanced. -NLS_DBCSCHAR = 65536 # DBCS for JPN: SBCS/DBCS mode. -NLS_ALPHANUMERIC = 0 # DBCS for JPN: Alphanumeric mode. -NLS_KATAKANA = 131072 # DBCS for JPN: Katakana mode. -NLS_HIRAGANA = 262144 # DBCS for JPN: Hiragana mode. -NLS_ROMAN = 4194304 # DBCS for JPN: Roman/Noroman mode. -NLS_IME_CONVERSION = 8388608 # DBCS for JPN: IME conversion. -NLS_IME_DISABLE = 536870912 # DBCS for JPN: IME enable/disable. +RIGHT_ALT_PRESSED = 1 # the right alt key is pressed. +LEFT_ALT_PRESSED = 2 # the left alt key is pressed. +RIGHT_CTRL_PRESSED = 4 # the right ctrl key is pressed. +LEFT_CTRL_PRESSED = 8 # the left ctrl key is pressed. +SHIFT_PRESSED = 16 # the shift key is pressed. +NUMLOCK_ON = 32 # the numlock light is on. +SCROLLLOCK_ON = 64 # the scrolllock light is on. +CAPSLOCK_ON = 128 # the capslock light is on. +ENHANCED_KEY = 256 # the key is enhanced. +NLS_DBCSCHAR = 65536 # DBCS for JPN: SBCS/DBCS mode. +NLS_ALPHANUMERIC = 0 # DBCS for JPN: Alphanumeric mode. +NLS_KATAKANA = 131072 # DBCS for JPN: Katakana mode. +NLS_HIRAGANA = 262144 # DBCS for JPN: Hiragana mode. +NLS_ROMAN = 4194304 # DBCS for JPN: Roman/Noroman mode. +NLS_IME_CONVERSION = 8388608 # DBCS for JPN: IME conversion. +NLS_IME_DISABLE = 536870912 # DBCS for JPN: IME enable/disable. -FROM_LEFT_1ST_BUTTON_PRESSED = 1 -RIGHTMOST_BUTTON_PRESSED = 2 -FROM_LEFT_2ND_BUTTON_PRESSED = 4 -FROM_LEFT_3RD_BUTTON_PRESSED = 8 -FROM_LEFT_4TH_BUTTON_PRESSED = 16 +FROM_LEFT_1ST_BUTTON_PRESSED = 1 +RIGHTMOST_BUTTON_PRESSED = 2 +FROM_LEFT_2ND_BUTTON_PRESSED = 4 +FROM_LEFT_3RD_BUTTON_PRESSED = 8 +FROM_LEFT_4TH_BUTTON_PRESSED = 16 -CTRL_C_EVENT = 0 -CTRL_BREAK_EVENT = 1 -CTRL_CLOSE_EVENT = 2 -CTRL_LOGOFF_EVENT = 5 +CTRL_C_EVENT = 0 +CTRL_BREAK_EVENT = 1 +CTRL_CLOSE_EVENT = 2 +CTRL_LOGOFF_EVENT = 5 CTRL_SHUTDOWN_EVENT = 6 -MOUSE_MOVED = 1 -DOUBLE_CLICK = 2 +MOUSE_MOVED = 1 +DOUBLE_CLICK = 2 MOUSE_WHEELED = 4 -#property sheet window messages from prsht.h +# property sheet window messages from prsht.h PSM_SETCURSEL = (WM_USER + 101) PSM_REMOVEPAGE = (WM_USER + 102) PSM_ADDPAGE = (WM_USER + 103) @@ -4961,13 +4985,13 @@ GRADIENT_FILL_RECT_V = 1 GRADIENT_FILL_TRIANGLE = 2 GRADIENT_FILL_OP_FLAG = 255 -## flags used with Get/SetSystemFileCacheSize +# flags used with Get/SetSystemFileCacheSize MM_WORKING_SET_MAX_HARD_ENABLE = 1 MM_WORKING_SET_MAX_HARD_DISABLE = 2 MM_WORKING_SET_MIN_HARD_ENABLE = 4 -MM_WORKING_SET_MIN_HARD_DISABLE = 8 +MM_WORKING_SET_MIN_HARD_DISABLE = 8 -## Flags for GetFinalPathNameByHandle +# Flags for GetFinalPathNameByHandle VOLUME_NAME_DOS = 0 VOLUME_NAME_GUID = 1 VOLUME_NAME_NT = 2 diff --git a/typings/win32helper/ntsecuritycon.pyi b/typings/win32helper/ntsecuritycon.pyi index 716d811d..8d6eeb2b 100644 --- a/typings/win32helper/ntsecuritycon.pyi +++ b/typings/win32helper/ntsecuritycon.pyi @@ -19,93 +19,94 @@ GENERIC_EXECUTE = (536870912) GENERIC_ALL = (268435456) # file security permissions -FILE_READ_DATA= ( 1 ) -FILE_LIST_DIRECTORY= ( 1 ) -FILE_WRITE_DATA= ( 2 ) -FILE_ADD_FILE= ( 2 ) -FILE_APPEND_DATA= ( 4 ) -FILE_ADD_SUBDIRECTORY= ( 4 ) -FILE_CREATE_PIPE_INSTANCE= ( 4 ) -FILE_READ_EA= ( 8 ) -FILE_WRITE_EA= ( 16 ) -FILE_EXECUTE= ( 32 ) -FILE_TRAVERSE= ( 32 ) -FILE_DELETE_CHILD= ( 64 ) -FILE_READ_ATTRIBUTES= ( 128 ) -FILE_WRITE_ATTRIBUTES= ( 256 ) -FILE_ALL_ACCESS= (STANDARD_RIGHTS_REQUIRED | SYNCHRONIZE | 511) -FILE_GENERIC_READ= (STANDARD_RIGHTS_READ | FILE_READ_DATA | FILE_READ_ATTRIBUTES | FILE_READ_EA | SYNCHRONIZE) -FILE_GENERIC_WRITE= (STANDARD_RIGHTS_WRITE | FILE_WRITE_DATA | FILE_WRITE_ATTRIBUTES | FILE_WRITE_EA | FILE_APPEND_DATA | SYNCHRONIZE) -FILE_GENERIC_EXECUTE= (STANDARD_RIGHTS_EXECUTE | FILE_READ_ATTRIBUTES | FILE_EXECUTE | SYNCHRONIZE) - - -SECURITY_NULL_SID_AUTHORITY = (0,0,0,0,0,0) -SECURITY_WORLD_SID_AUTHORITY = (0,0,0,0,0,1) -SECURITY_LOCAL_SID_AUTHORITY = (0,0,0,0,0,2) -SECURITY_CREATOR_SID_AUTHORITY = (0,0,0,0,0,3) -SECURITY_NON_UNIQUE_AUTHORITY = (0,0,0,0,0,4) -SECURITY_RESOURCE_MANAGER_AUTHORITY = (0,0,0,0,0,9) - -SECURITY_NULL_RID = 0 -SECURITY_WORLD_RID = 0 -SECURITY_LOCAL_RID = 0X00000000 - -SECURITY_CREATOR_OWNER_RID = 0 -SECURITY_CREATOR_GROUP_RID = 1 +FILE_READ_DATA = (1) +FILE_LIST_DIRECTORY = (1) +FILE_WRITE_DATA = (2) +FILE_ADD_FILE = (2) +FILE_APPEND_DATA = (4) +FILE_ADD_SUBDIRECTORY = (4) +FILE_CREATE_PIPE_INSTANCE = (4) +FILE_READ_EA = (8) +FILE_WRITE_EA = (16) +FILE_EXECUTE = (32) +FILE_TRAVERSE = (32) +FILE_DELETE_CHILD = (64) +FILE_READ_ATTRIBUTES = (128) +FILE_WRITE_ATTRIBUTES = (256) +FILE_ALL_ACCESS = (STANDARD_RIGHTS_REQUIRED | SYNCHRONIZE | 511) +FILE_GENERIC_READ = (STANDARD_RIGHTS_READ | FILE_READ_DATA | FILE_READ_ATTRIBUTES | FILE_READ_EA | SYNCHRONIZE) +FILE_GENERIC_WRITE = (STANDARD_RIGHTS_WRITE | FILE_WRITE_DATA | FILE_WRITE_ATTRIBUTES + | FILE_WRITE_EA | FILE_APPEND_DATA | SYNCHRONIZE) +FILE_GENERIC_EXECUTE = (STANDARD_RIGHTS_EXECUTE | FILE_READ_ATTRIBUTES | FILE_EXECUTE | SYNCHRONIZE) + + +SECURITY_NULL_SID_AUTHORITY = (0, 0, 0, 0, 0, 0) +SECURITY_WORLD_SID_AUTHORITY = (0, 0, 0, 0, 0, 1) +SECURITY_LOCAL_SID_AUTHORITY = (0, 0, 0, 0, 0, 2) +SECURITY_CREATOR_SID_AUTHORITY = (0, 0, 0, 0, 0, 3) +SECURITY_NON_UNIQUE_AUTHORITY = (0, 0, 0, 0, 0, 4) +SECURITY_RESOURCE_MANAGER_AUTHORITY = (0, 0, 0, 0, 0, 9) + +SECURITY_NULL_RID = 0 +SECURITY_WORLD_RID = 0 +SECURITY_LOCAL_RID = 0X00000000 + +SECURITY_CREATOR_OWNER_RID = 0 +SECURITY_CREATOR_GROUP_RID = 1 SECURITY_CREATOR_OWNER_SERVER_RID = 2 SECURITY_CREATOR_GROUP_SERVER_RID = 3 SECURITY_CREATOR_OWNER_RIGHTS_RID = 4 # NT well-known SIDs -SECURITY_NT_AUTHORITY = (0,0,0,0,0,5) +SECURITY_NT_AUTHORITY = (0, 0, 0, 0, 0, 5) -SECURITY_DIALUP_RID = 1 -SECURITY_NETWORK_RID = 2 -SECURITY_BATCH_RID = 3 -SECURITY_INTERACTIVE_RID = 4 -SECURITY_SERVICE_RID = 6 -SECURITY_ANONYMOUS_LOGON_RID = 7 -SECURITY_PROXY_RID = 8 -SECURITY_SERVER_LOGON_RID = 9 +SECURITY_DIALUP_RID = 1 +SECURITY_NETWORK_RID = 2 +SECURITY_BATCH_RID = 3 +SECURITY_INTERACTIVE_RID = 4 +SECURITY_SERVICE_RID = 6 +SECURITY_ANONYMOUS_LOGON_RID = 7 +SECURITY_PROXY_RID = 8 +SECURITY_SERVER_LOGON_RID = 9 -SECURITY_LOGON_IDS_RID = 5 -SECURITY_LOGON_IDS_RID_COUNT = 3 +SECURITY_LOGON_IDS_RID = 5 +SECURITY_LOGON_IDS_RID_COUNT = 3 -SECURITY_LOCAL_SYSTEM_RID = 18 +SECURITY_LOCAL_SYSTEM_RID = 18 -SECURITY_NT_NON_UNIQUE = 21 +SECURITY_NT_NON_UNIQUE = 21 -SECURITY_BUILTIN_DOMAIN_RID = 32 +SECURITY_BUILTIN_DOMAIN_RID = 32 # well-known domain relative sub-authority values (RIDs)... -DOMAIN_USER_RID_ADMIN = 500 -DOMAIN_USER_RID_GUEST = 501 -DOMAIN_USER_RID_KRBTGT = 502 -DOMAIN_USER_RID_MAX = 999 +DOMAIN_USER_RID_ADMIN = 500 +DOMAIN_USER_RID_GUEST = 501 +DOMAIN_USER_RID_KRBTGT = 502 +DOMAIN_USER_RID_MAX = 999 # well-known groups ... -DOMAIN_GROUP_RID_ADMINS = 512 -DOMAIN_GROUP_RID_USERS = 513 -DOMAIN_GROUP_RID_GUESTS = 514 -DOMAIN_GROUP_RID_COMPUTERS = 515 -DOMAIN_GROUP_RID_CONTROLLERS = 516 -DOMAIN_GROUP_RID_CERT_ADMINS = 517 +DOMAIN_GROUP_RID_ADMINS = 512 +DOMAIN_GROUP_RID_USERS = 513 +DOMAIN_GROUP_RID_GUESTS = 514 +DOMAIN_GROUP_RID_COMPUTERS = 515 +DOMAIN_GROUP_RID_CONTROLLERS = 516 +DOMAIN_GROUP_RID_CERT_ADMINS = 517 DOMAIN_GROUP_RID_SCHEMA_ADMINS = 518 DOMAIN_GROUP_RID_ENTERPRISE_ADMINS = 519 DOMAIN_GROUP_RID_POLICY_ADMINS = 520 DOMAIN_GROUP_RID_READONLY_CONTROLLERS = 521 # well-known aliases ... -DOMAIN_ALIAS_RID_ADMINS = 544 -DOMAIN_ALIAS_RID_USERS = 545 -DOMAIN_ALIAS_RID_GUESTS = 546 -DOMAIN_ALIAS_RID_POWER_USERS = 547 -DOMAIN_ALIAS_RID_ACCOUNT_OPS = 548 -DOMAIN_ALIAS_RID_SYSTEM_OPS = 549 -DOMAIN_ALIAS_RID_PRINT_OPS = 550 -DOMAIN_ALIAS_RID_BACKUP_OPS = 551 -DOMAIN_ALIAS_RID_REPLICATOR = 552 +DOMAIN_ALIAS_RID_ADMINS = 544 +DOMAIN_ALIAS_RID_USERS = 545 +DOMAIN_ALIAS_RID_GUESTS = 546 +DOMAIN_ALIAS_RID_POWER_USERS = 547 +DOMAIN_ALIAS_RID_ACCOUNT_OPS = 548 +DOMAIN_ALIAS_RID_SYSTEM_OPS = 549 +DOMAIN_ALIAS_RID_PRINT_OPS = 550 +DOMAIN_ALIAS_RID_BACKUP_OPS = 551 +DOMAIN_ALIAS_RID_REPLICATOR = 552 DOMAIN_ALIAS_RID_RAS_SERVERS = 553 DOMAIN_ALIAS_RID_PREW2KCOMPACCESS = 554 DOMAIN_ALIAS_RID_REMOTE_DESKTOP_USERS = 555 @@ -122,32 +123,32 @@ DOMAIN_ALIAS_RID_CACHEABLE_PRINCIPALS_GROUP = 571 DOMAIN_ALIAS_RID_NON_CACHEABLE_PRINCIPALS_GROUP = 572 DOMAIN_ALIAS_RID_EVENT_LOG_READERS_GROUP = 573 -SECURITY_MANDATORY_LABEL_AUTHORITY = (0,0,0,0,0,16) -SECURITY_MANDATORY_UNTRUSTED_RID = 0x00000000 -SECURITY_MANDATORY_LOW_RID = 0x00001000 -SECURITY_MANDATORY_MEDIUM_RID = 0x00002000 -SECURITY_MANDATORY_HIGH_RID = 0x00003000 -SECURITY_MANDATORY_SYSTEM_RID = 0x00004000 -SECURITY_MANDATORY_PROTECTED_PROCESS_RID = 0x00005000 +SECURITY_MANDATORY_LABEL_AUTHORITY = (0, 0, 0, 0, 0, 16) +SECURITY_MANDATORY_UNTRUSTED_RID = 0x00000000 +SECURITY_MANDATORY_LOW_RID = 0x00001000 +SECURITY_MANDATORY_MEDIUM_RID = 0x00002000 +SECURITY_MANDATORY_HIGH_RID = 0x00003000 +SECURITY_MANDATORY_SYSTEM_RID = 0x00004000 +SECURITY_MANDATORY_PROTECTED_PROCESS_RID = 0x00005000 SECURITY_MANDATORY_MAXIMUM_USER_RID = SECURITY_MANDATORY_SYSTEM_RID -SYSTEM_LUID = (999, 0) -ANONYMOUS_LOGON_LUID = (998, 0) -LOCALSERVICE_LUID = (997, 0) -NETWORKSERVICE_LUID = (996, 0) -IUSER_LUID = (995, 0) +SYSTEM_LUID = (999, 0) +ANONYMOUS_LOGON_LUID = (998, 0) +LOCALSERVICE_LUID = (997, 0) +NETWORKSERVICE_LUID = (996, 0) +IUSER_LUID = (995, 0) # Group attributes -SE_GROUP_MANDATORY = 1 -SE_GROUP_ENABLED_BY_DEFAULT = 2 -SE_GROUP_ENABLED = 4 -SE_GROUP_OWNER = 8 -SE_GROUP_USE_FOR_DENY_ONLY = 16 -SE_GROUP_INTEGRITY = 32 -SE_GROUP_INTEGRITY_ENABLED = 64 -SE_GROUP_RESOURCE = 536870912 -SE_GROUP_LOGON_ID = -1073741824 +SE_GROUP_MANDATORY = 1 +SE_GROUP_ENABLED_BY_DEFAULT = 2 +SE_GROUP_ENABLED = 4 +SE_GROUP_OWNER = 8 +SE_GROUP_USE_FOR_DENY_ONLY = 16 +SE_GROUP_INTEGRITY = 32 +SE_GROUP_INTEGRITY_ENABLED = 64 +SE_GROUP_RESOURCE = 536870912 +SE_GROUP_LOGON_ID = -1073741824 # User attributes @@ -184,57 +185,57 @@ ACCESS_MAX_MS_V5_ACE_TYPE = 17 # The following are the inherit flags that go into the AceFlags field # of an Ace header. -OBJECT_INHERIT_ACE = 1 -CONTAINER_INHERIT_ACE = 2 -NO_PROPAGATE_INHERIT_ACE = 4 -INHERIT_ONLY_ACE = 8 -VALID_INHERIT_FLAGS = 15 +OBJECT_INHERIT_ACE = 1 +CONTAINER_INHERIT_ACE = 2 +NO_PROPAGATE_INHERIT_ACE = 4 +INHERIT_ONLY_ACE = 8 +VALID_INHERIT_FLAGS = 15 -SUCCESSFUL_ACCESS_ACE_FLAG = 64 -FAILED_ACCESS_ACE_FLAG = 128 +SUCCESSFUL_ACCESS_ACE_FLAG = 64 +FAILED_ACCESS_ACE_FLAG = 128 -SE_OWNER_DEFAULTED = 1 -SE_GROUP_DEFAULTED = 2 -SE_DACL_PRESENT = 4 -SE_DACL_DEFAULTED = 8 -SE_SACL_PRESENT = 16 -SE_SACL_DEFAULTED = 32 -SE_SELF_RELATIVE = 32768 +SE_OWNER_DEFAULTED = 1 +SE_GROUP_DEFAULTED = 2 +SE_DACL_PRESENT = 4 +SE_DACL_DEFAULTED = 8 +SE_SACL_PRESENT = 16 +SE_SACL_DEFAULTED = 32 +SE_SELF_RELATIVE = 32768 SE_PRIVILEGE_ENABLED_BY_DEFAULT = 1 -SE_PRIVILEGE_ENABLED = 2 -SE_PRIVILEGE_USED_FOR_ACCESS = -2147483648 +SE_PRIVILEGE_ENABLED = 2 +SE_PRIVILEGE_USED_FOR_ACCESS = -2147483648 -PRIVILEGE_SET_ALL_NECESSARY = 1 +PRIVILEGE_SET_ALL_NECESSARY = 1 # NT Defined Privileges -SE_CREATE_TOKEN_NAME = "SeCreateTokenPrivilege" -SE_ASSIGNPRIMARYTOKEN_NAME = "SeAssignPrimaryTokenPrivilege" -SE_LOCK_MEMORY_NAME = "SeLockMemoryPrivilege" -SE_INCREASE_QUOTA_NAME = "SeIncreaseQuotaPrivilege" -SE_UNSOLICITED_INPUT_NAME = "SeUnsolicitedInputPrivilege" -SE_MACHINE_ACCOUNT_NAME = "SeMachineAccountPrivilege" -SE_TCB_NAME = "SeTcbPrivilege" -SE_SECURITY_NAME = "SeSecurityPrivilege" -SE_TAKE_OWNERSHIP_NAME = "SeTakeOwnershipPrivilege" -SE_LOAD_DRIVER_NAME = "SeLoadDriverPrivilege" -SE_SYSTEM_PROFILE_NAME = "SeSystemProfilePrivilege" -SE_SYSTEMTIME_NAME = "SeSystemtimePrivilege" -SE_PROF_SINGLE_PROCESS_NAME = "SeProfileSingleProcessPrivilege" -SE_INC_BASE_PRIORITY_NAME = "SeIncreaseBasePriorityPrivilege" -SE_CREATE_PAGEFILE_NAME = "SeCreatePagefilePrivilege" -SE_CREATE_PERMANENT_NAME = "SeCreatePermanentPrivilege" -SE_BACKUP_NAME = "SeBackupPrivilege" -SE_RESTORE_NAME = "SeRestorePrivilege" -SE_SHUTDOWN_NAME = "SeShutdownPrivilege" -SE_DEBUG_NAME = "SeDebugPrivilege" -SE_AUDIT_NAME = "SeAuditPrivilege" -SE_SYSTEM_ENVIRONMENT_NAME = "SeSystemEnvironmentPrivilege" -SE_CHANGE_NOTIFY_NAME = "SeChangeNotifyPrivilege" -SE_REMOTE_SHUTDOWN_NAME = "SeRemoteShutdownPrivilege" +SE_CREATE_TOKEN_NAME = "SeCreateTokenPrivilege" +SE_ASSIGNPRIMARYTOKEN_NAME = "SeAssignPrimaryTokenPrivilege" +SE_LOCK_MEMORY_NAME = "SeLockMemoryPrivilege" +SE_INCREASE_QUOTA_NAME = "SeIncreaseQuotaPrivilege" +SE_UNSOLICITED_INPUT_NAME = "SeUnsolicitedInputPrivilege" +SE_MACHINE_ACCOUNT_NAME = "SeMachineAccountPrivilege" +SE_TCB_NAME = "SeTcbPrivilege" +SE_SECURITY_NAME = "SeSecurityPrivilege" +SE_TAKE_OWNERSHIP_NAME = "SeTakeOwnershipPrivilege" +SE_LOAD_DRIVER_NAME = "SeLoadDriverPrivilege" +SE_SYSTEM_PROFILE_NAME = "SeSystemProfilePrivilege" +SE_SYSTEMTIME_NAME = "SeSystemtimePrivilege" +SE_PROF_SINGLE_PROCESS_NAME = "SeProfileSingleProcessPrivilege" +SE_INC_BASE_PRIORITY_NAME = "SeIncreaseBasePriorityPrivilege" +SE_CREATE_PAGEFILE_NAME = "SeCreatePagefilePrivilege" +SE_CREATE_PERMANENT_NAME = "SeCreatePermanentPrivilege" +SE_BACKUP_NAME = "SeBackupPrivilege" +SE_RESTORE_NAME = "SeRestorePrivilege" +SE_SHUTDOWN_NAME = "SeShutdownPrivilege" +SE_DEBUG_NAME = "SeDebugPrivilege" +SE_AUDIT_NAME = "SeAuditPrivilege" +SE_SYSTEM_ENVIRONMENT_NAME = "SeSystemEnvironmentPrivilege" +SE_CHANGE_NOTIFY_NAME = "SeChangeNotifyPrivilege" +SE_REMOTE_SHUTDOWN_NAME = "SeRemoteShutdownPrivilege" # Enum SECURITY_IMPERSONATION_LEVEL: @@ -247,40 +248,40 @@ SECURITY_MAX_IMPERSONATION_LEVEL = SecurityDelegation DEFAULT_IMPERSONATION_LEVEL = SecurityImpersonation -TOKEN_ASSIGN_PRIMARY = 1 -TOKEN_DUPLICATE = 2 -TOKEN_IMPERSONATE = 4 -TOKEN_QUERY = 8 -TOKEN_QUERY_SOURCE = 16 +TOKEN_ASSIGN_PRIMARY = 1 +TOKEN_DUPLICATE = 2 +TOKEN_IMPERSONATE = 4 +TOKEN_QUERY = 8 +TOKEN_QUERY_SOURCE = 16 TOKEN_ADJUST_PRIVILEGES = 32 -TOKEN_ADJUST_GROUPS = 64 -TOKEN_ADJUST_DEFAULT = 128 +TOKEN_ADJUST_GROUPS = 64 +TOKEN_ADJUST_DEFAULT = 128 -TOKEN_ALL_ACCESS = (STANDARD_RIGHTS_REQUIRED |\ - TOKEN_ASSIGN_PRIMARY |\ - TOKEN_DUPLICATE |\ - TOKEN_IMPERSONATE |\ - TOKEN_QUERY |\ - TOKEN_QUERY_SOURCE |\ - TOKEN_ADJUST_PRIVILEGES |\ - TOKEN_ADJUST_GROUPS |\ - TOKEN_ADJUST_DEFAULT) +TOKEN_ALL_ACCESS = (STANDARD_RIGHTS_REQUIRED + | TOKEN_ASSIGN_PRIMARY + | TOKEN_DUPLICATE + | TOKEN_IMPERSONATE + | TOKEN_QUERY + | TOKEN_QUERY_SOURCE + | TOKEN_ADJUST_PRIVILEGES + | TOKEN_ADJUST_GROUPS + | TOKEN_ADJUST_DEFAULT) -TOKEN_READ = (STANDARD_RIGHTS_READ |\ - TOKEN_QUERY) +TOKEN_READ = (STANDARD_RIGHTS_READ + | TOKEN_QUERY) -TOKEN_WRITE = (STANDARD_RIGHTS_WRITE |\ - TOKEN_ADJUST_PRIVILEGES |\ - TOKEN_ADJUST_GROUPS |\ - TOKEN_ADJUST_DEFAULT) +TOKEN_WRITE = (STANDARD_RIGHTS_WRITE + | TOKEN_ADJUST_PRIVILEGES + | TOKEN_ADJUST_GROUPS + | TOKEN_ADJUST_DEFAULT) -TOKEN_EXECUTE = (STANDARD_RIGHTS_EXECUTE) +TOKEN_EXECUTE = (STANDARD_RIGHTS_EXECUTE) SidTypeUser = 1 SidTypeGroup = 2 -SidTypeDomain =3 +SidTypeDomain = 3 SidTypeAlias = 4 SidTypeWellKnownGroup = 5 SidTypeDeletedAccount = 6 @@ -398,22 +399,22 @@ DS_INSTANCETYPE_IS_NC_HEAD = 0x00000001 DS_INSTANCETYPE_NC_IS_WRITEABLE = 0x00000004 DS_INSTANCETYPE_NC_COMING = 0x00000010 DS_INSTANCETYPE_NC_GOING = 0x00000020 -NTDSDSA_OPT_IS_GC = ( 1 << 0 ) -NTDSDSA_OPT_DISABLE_INBOUND_REPL = ( 1 << 1 ) -NTDSDSA_OPT_DISABLE_OUTBOUND_REPL = ( 1 << 2 ) -NTDSDSA_OPT_DISABLE_NTDSCONN_XLATE = ( 1 << 3 ) -NTDSCONN_OPT_IS_GENERATED = ( 1 << 0 ) -NTDSCONN_OPT_TWOWAY_SYNC = ( 1 << 1 ) -NTDSCONN_OPT_OVERRIDE_NOTIFY_DEFAULT = (1 << 2 ) +NTDSDSA_OPT_IS_GC = (1 << 0) +NTDSDSA_OPT_DISABLE_INBOUND_REPL = (1 << 1) +NTDSDSA_OPT_DISABLE_OUTBOUND_REPL = (1 << 2) +NTDSDSA_OPT_DISABLE_NTDSCONN_XLATE = (1 << 3) +NTDSCONN_OPT_IS_GENERATED = (1 << 0) +NTDSCONN_OPT_TWOWAY_SYNC = (1 << 1) +NTDSCONN_OPT_OVERRIDE_NOTIFY_DEFAULT = (1 << 2) NTDSCONN_OPT_USE_NOTIFY = (1 << 3) NTDSCONN_OPT_DISABLE_INTERSITE_COMPRESSION = (1 << 4) NTDSCONN_OPT_USER_OWNED_SCHEDULE = (1 << 5) -NTDSCONN_KCC_NO_REASON = ( 0 ) -NTDSCONN_KCC_GC_TOPOLOGY = ( 1 << 0 ) -NTDSCONN_KCC_RING_TOPOLOGY = ( 1 << 1 ) -NTDSCONN_KCC_MINIMIZE_HOPS_TOPOLOGY = ( 1 << 2 ) -NTDSCONN_KCC_STALE_SERVERS_TOPOLOGY = ( 1 << 3 ) -NTDSCONN_KCC_OSCILLATING_CONNECTION_TOPOLOGY = ( 1 << 4 ) +NTDSCONN_KCC_NO_REASON = (0) +NTDSCONN_KCC_GC_TOPOLOGY = (1 << 0) +NTDSCONN_KCC_RING_TOPOLOGY = (1 << 1) +NTDSCONN_KCC_MINIMIZE_HOPS_TOPOLOGY = (1 << 2) +NTDSCONN_KCC_STALE_SERVERS_TOPOLOGY = (1 << 3) +NTDSCONN_KCC_OSCILLATING_CONNECTION_TOPOLOGY = (1 << 4) NTDSCONN_KCC_INTERSITE_GC_TOPOLOGY = (1 << 5) NTDSCONN_KCC_INTERSITE_TOPOLOGY = (1 << 6) NTDSCONN_KCC_SERVER_FAILOVER_TOPOLOGY = (1 << 7) @@ -423,26 +424,26 @@ FRSCONN_PRIORITY_MASK = 0x70000000 FRSCONN_MAX_PRIORITY = 0x8 NTDSCONN_OPT_IGNORE_SCHEDULE_MASK = (-2147483648) -NTDSSETTINGS_OPT_IS_AUTO_TOPOLOGY_DISABLED = ( 1 << 0 ) -NTDSSETTINGS_OPT_IS_TOPL_CLEANUP_DISABLED = ( 1 << 1 ) -NTDSSETTINGS_OPT_IS_TOPL_MIN_HOPS_DISABLED = ( 1 << 2 ) -NTDSSETTINGS_OPT_IS_TOPL_DETECT_STALE_DISABLED = ( 1 << 3 ) -NTDSSETTINGS_OPT_IS_INTER_SITE_AUTO_TOPOLOGY_DISABLED = ( 1 << 4 ) -NTDSSETTINGS_OPT_IS_GROUP_CACHING_ENABLED = ( 1 << 5 ) -NTDSSETTINGS_OPT_FORCE_KCC_WHISTLER_BEHAVIOR = ( 1 << 6 ) -NTDSSETTINGS_OPT_FORCE_KCC_W2K_ELECTION = ( 1 << 7 ) -NTDSSETTINGS_OPT_IS_RAND_BH_SELECTION_DISABLED = ( 1 << 8 ) -NTDSSETTINGS_OPT_IS_SCHEDULE_HASHING_ENABLED = ( 1 << 9 ) -NTDSSETTINGS_OPT_IS_REDUNDANT_SERVER_TOPOLOGY_ENABLED = ( 1 << 10 ) +NTDSSETTINGS_OPT_IS_AUTO_TOPOLOGY_DISABLED = (1 << 0) +NTDSSETTINGS_OPT_IS_TOPL_CLEANUP_DISABLED = (1 << 1) +NTDSSETTINGS_OPT_IS_TOPL_MIN_HOPS_DISABLED = (1 << 2) +NTDSSETTINGS_OPT_IS_TOPL_DETECT_STALE_DISABLED = (1 << 3) +NTDSSETTINGS_OPT_IS_INTER_SITE_AUTO_TOPOLOGY_DISABLED = (1 << 4) +NTDSSETTINGS_OPT_IS_GROUP_CACHING_ENABLED = (1 << 5) +NTDSSETTINGS_OPT_FORCE_KCC_WHISTLER_BEHAVIOR = (1 << 6) +NTDSSETTINGS_OPT_FORCE_KCC_W2K_ELECTION = (1 << 7) +NTDSSETTINGS_OPT_IS_RAND_BH_SELECTION_DISABLED = (1 << 8) +NTDSSETTINGS_OPT_IS_SCHEDULE_HASHING_ENABLED = (1 << 9) +NTDSSETTINGS_OPT_IS_REDUNDANT_SERVER_TOPOLOGY_ENABLED = (1 << 10) NTDSSETTINGS_DEFAULT_SERVER_REDUNDANCY = 2 -NTDSTRANSPORT_OPT_IGNORE_SCHEDULES = ( 1 << 0 ) -NTDSTRANSPORT_OPT_BRIDGES_REQUIRED = (1 << 1 ) -NTDSSITECONN_OPT_USE_NOTIFY = ( 1 << 0 ) -NTDSSITECONN_OPT_TWOWAY_SYNC = ( 1 << 1 ) -NTDSSITECONN_OPT_DISABLE_COMPRESSION = ( 1 << 2 ) -NTDSSITELINK_OPT_USE_NOTIFY = ( 1 << 0 ) -NTDSSITELINK_OPT_TWOWAY_SYNC = ( 1 << 1 ) -NTDSSITELINK_OPT_DISABLE_COMPRESSION = ( 1 << 2 ) +NTDSTRANSPORT_OPT_IGNORE_SCHEDULES = (1 << 0) +NTDSTRANSPORT_OPT_BRIDGES_REQUIRED = (1 << 1) +NTDSSITECONN_OPT_USE_NOTIFY = (1 << 0) +NTDSSITECONN_OPT_TWOWAY_SYNC = (1 << 1) +NTDSSITECONN_OPT_DISABLE_COMPRESSION = (1 << 2) +NTDSSITELINK_OPT_USE_NOTIFY = (1 << 0) +NTDSSITELINK_OPT_TWOWAY_SYNC = (1 << 1) +NTDSSITELINK_OPT_DISABLE_COMPRESSION = (1 << 2) GUID_USERS_CONTAINER_A = "a9d1ca15768811d1aded00c04fd8d5cd" GUID_COMPUTRS_CONTAINER_A = "aa312825768811d1aded00c04fd8d5cd" GUID_SYSTEMS_CONTAINER_A = "ab1d30f3768811d1aded00c04fd8d5cd" @@ -506,15 +507,15 @@ DS_REPL_NBR_COMPRESS_CHANGES = (0x10000000) DS_REPL_NBR_NO_CHANGE_NOTIFICATIONS = (0x20000000) DS_REPL_NBR_PARTIAL_ATTRIBUTE_SET = (0x40000000) DS_REPL_NBR_MODIFIABLE_MASK = \ - ( \ - DS_REPL_NBR_SYNC_ON_STARTUP | \ - DS_REPL_NBR_DO_SCHEDULED_SYNCS | \ - DS_REPL_NBR_TWO_WAY_SYNC | \ - DS_REPL_NBR_IGNORE_CHANGE_NOTIFICATIONS | \ - DS_REPL_NBR_DISABLE_SCHEDULED_SYNC | \ - DS_REPL_NBR_COMPRESS_CHANGES | \ - DS_REPL_NBR_NO_CHANGE_NOTIFICATIONS \ - ) + ( + DS_REPL_NBR_SYNC_ON_STARTUP + | DS_REPL_NBR_DO_SCHEDULED_SYNCS + | DS_REPL_NBR_TWO_WAY_SYNC + | DS_REPL_NBR_IGNORE_CHANGE_NOTIFICATIONS + | DS_REPL_NBR_DISABLE_SCHEDULED_SYNC + | DS_REPL_NBR_COMPRESS_CHANGES + | DS_REPL_NBR_NO_CHANGE_NOTIFICATIONS + ) # from enum DS_NAME_FORMAT DS_UNKNOWN_NAME = 0 @@ -561,7 +562,7 @@ DS_SPN_SERVICE = 5 # from enum DS_SPN_WRITE_OP DS_SPN_ADD_SPN_OP = 0 DS_SPN_REPLACE_SPN_OP = 1 -DS_SPN_DELETE_SPN_OP = 2 +DS_SPN_DELETE_SPN_OP = 2 # Generated by h2py from DsGetDC.h DS_FORCE_REDISCOVERY = 0x00000001 @@ -581,24 +582,24 @@ DS_IS_FLAT_NAME = 0x00010000 DS_IS_DNS_NAME = 0x00020000 DS_RETURN_DNS_NAME = 0x40000000 DS_RETURN_FLAT_NAME = (-2147483648) -DSGETDC_VALID_FLAGS = ( \ - DS_FORCE_REDISCOVERY | \ - DS_DIRECTORY_SERVICE_REQUIRED | \ - DS_DIRECTORY_SERVICE_PREFERRED | \ - DS_GC_SERVER_REQUIRED | \ - DS_PDC_REQUIRED | \ - DS_BACKGROUND_ONLY | \ - DS_IP_REQUIRED | \ - DS_KDC_REQUIRED | \ - DS_TIMESERV_REQUIRED | \ - DS_WRITABLE_REQUIRED | \ - DS_GOOD_TIMESERV_PREFERRED | \ - DS_AVOID_SELF | \ - DS_ONLY_LDAP_NEEDED | \ - DS_IS_FLAT_NAME | \ - DS_IS_DNS_NAME | \ - DS_RETURN_FLAT_NAME | \ - DS_RETURN_DNS_NAME ) +DSGETDC_VALID_FLAGS = ( + DS_FORCE_REDISCOVERY + | DS_DIRECTORY_SERVICE_REQUIRED + | DS_DIRECTORY_SERVICE_PREFERRED + | DS_GC_SERVER_REQUIRED + | DS_PDC_REQUIRED + | DS_BACKGROUND_ONLY + | DS_IP_REQUIRED + | DS_KDC_REQUIRED + | DS_TIMESERV_REQUIRED + | DS_WRITABLE_REQUIRED + | DS_GOOD_TIMESERV_PREFERRED + | DS_AVOID_SELF + | DS_ONLY_LDAP_NEEDED + | DS_IS_FLAT_NAME + | DS_IS_DNS_NAME + | DS_RETURN_FLAT_NAME + | DS_RETURN_DNS_NAME) DS_INET_ADDRESS = 1 DS_NETBIOS_ADDRESS = 2 DS_PDC_FLAG = 0x00000001 @@ -621,27 +622,27 @@ DS_DOMAIN_TREE_ROOT = 0x0004 DS_DOMAIN_PRIMARY = 0x0008 DS_DOMAIN_NATIVE_MODE = 0x0010 DS_DOMAIN_DIRECT_INBOUND = 0x0020 -DS_DOMAIN_VALID_FLAGS = ( \ - DS_DOMAIN_IN_FOREST | \ - DS_DOMAIN_DIRECT_OUTBOUND | \ - DS_DOMAIN_TREE_ROOT | \ - DS_DOMAIN_PRIMARY | \ - DS_DOMAIN_NATIVE_MODE | \ - DS_DOMAIN_DIRECT_INBOUND ) +DS_DOMAIN_VALID_FLAGS = ( + DS_DOMAIN_IN_FOREST + | DS_DOMAIN_DIRECT_OUTBOUND + | DS_DOMAIN_TREE_ROOT + | DS_DOMAIN_PRIMARY + | DS_DOMAIN_NATIVE_MODE + | DS_DOMAIN_DIRECT_INBOUND) DS_GFTI_UPDATE_TDO = 0x1 DS_GFTI_VALID_FLAGS = 0x1 DS_ONLY_DO_SITE_NAME = 0x01 DS_NOTIFY_AFTER_SITE_RECORDS = 0x02 -DS_OPEN_VALID_OPTION_FLAGS = ( DS_ONLY_DO_SITE_NAME | DS_NOTIFY_AFTER_SITE_RECORDS ) -DS_OPEN_VALID_FLAGS = ( \ - DS_FORCE_REDISCOVERY | \ - DS_ONLY_LDAP_NEEDED | \ - DS_KDC_REQUIRED | \ - DS_PDC_REQUIRED | \ - DS_GC_SERVER_REQUIRED | \ - DS_WRITABLE_REQUIRED ) - -## from aclui.h +DS_OPEN_VALID_OPTION_FLAGS = (DS_ONLY_DO_SITE_NAME | DS_NOTIFY_AFTER_SITE_RECORDS) +DS_OPEN_VALID_FLAGS = ( + DS_FORCE_REDISCOVERY + | DS_ONLY_LDAP_NEEDED + | DS_KDC_REQUIRED + | DS_PDC_REQUIRED + | DS_GC_SERVER_REQUIRED + | DS_WRITABLE_REQUIRED) + +# from aclui.h # SI_OBJECT_INFO.dwFlags SI_EDIT_PERMS = 0x00000000 SI_EDIT_OWNER = 0x00000001 @@ -683,7 +684,7 @@ SI_PAGE_PERM = 0 SI_PAGE_ADVPERM = 1 SI_PAGE_AUDIT = 2 SI_PAGE_OWNER = 3 -SI_PAGE_EFFECTIVE =4 +SI_PAGE_EFFECTIVE = 4 CFSTR_ACLUI_SID_INFO_LIST = "CFSTR_ACLUI_SID_INFO_LIST" -PSPCB_SI_INITDIALOG = 1025 ## WM_USER+1 +PSPCB_SI_INITDIALOG = 1025 # WM_USER+1 diff --git a/typings/win32helper/sspicon.pyi b/typings/win32helper/sspicon.pyi index 1e61d498..cb1a9bd1 100644 --- a/typings/win32helper/sspicon.pyi +++ b/typings/win32helper/sspicon.pyi @@ -5,7 +5,11 @@ ISSP_LEVEL = 32 ISSP_MODE = 0 ISSP_LEVEL = 32 ISSP_MODE = 1 -def SEC_SUCCESS(Status): return ((Status) >= 0) + + +def SEC_SUCCESS(Status) -> bool: + ... + SECPKG_FLAG_INTEGRITY = 1 SECPKG_FLAG_PRIVACY = 2 @@ -171,7 +175,7 @@ SECPKG_ATTR_ACCESS_TOKEN = 18 SECPKG_ATTR_TARGET = 19 SECPKG_ATTR_AUTHENTICATION_ID = 20 -## attributes from schannel.h +# attributes from schannel.h SECPKG_ATTR_REMOTE_CERT_CONTEXT = 83 SECPKG_ATTR_LOCAL_CERT_CONTEXT = 84 SECPKG_ATTR_ROOT_STORE = 85 @@ -387,60 +391,60 @@ ERROR_IPSEC_IKE_INVALID_CERT_KEYLEN = 13881 ERROR_IPSEC_IKE_MM_LIMIT = 13882 ERROR_IPSEC_IKE_NEGOTIATION_DISABLED = 13883 ERROR_IPSEC_IKE_NEG_STATUS_END = 13884 -CRYPT_E_MSG_ERROR = ((-2146889727)) -CRYPT_E_UNKNOWN_ALGO = ((-2146889726)) -CRYPT_E_OID_FORMAT = ((-2146889725)) -CRYPT_E_INVALID_MSG_TYPE = ((-2146889724)) -CRYPT_E_UNEXPECTED_ENCODING = ((-2146889723)) -CRYPT_E_AUTH_ATTR_MISSING = ((-2146889722)) -CRYPT_E_HASH_VALUE = ((-2146889721)) -CRYPT_E_INVALID_INDEX = ((-2146889720)) -CRYPT_E_ALREADY_DECRYPTED = ((-2146889719)) -CRYPT_E_NOT_DECRYPTED = ((-2146889718)) -CRYPT_E_RECIPIENT_NOT_FOUND = ((-2146889717)) -CRYPT_E_CONTROL_TYPE = ((-2146889716)) -CRYPT_E_ISSUER_SERIALNUMBER = ((-2146889715)) -CRYPT_E_SIGNER_NOT_FOUND = ((-2146889714)) -CRYPT_E_ATTRIBUTES_MISSING = ((-2146889713)) -CRYPT_E_STREAM_MSG_NOT_READY = ((-2146889712)) -CRYPT_E_STREAM_INSUFFICIENT_DATA = ((-2146889711)) +CRYPT_E_MSG_ERROR = -2146889727 +CRYPT_E_UNKNOWN_ALGO = -2146889726 +CRYPT_E_OID_FORMAT = -2146889725 +CRYPT_E_INVALID_MSG_TYPE = -2146889724 +CRYPT_E_UNEXPECTED_ENCODING = -2146889723 +CRYPT_E_AUTH_ATTR_MISSING = -2146889722 +CRYPT_E_HASH_VALUE = -2146889721 +CRYPT_E_INVALID_INDEX = -2146889720 +CRYPT_E_ALREADY_DECRYPTED = -2146889719 +CRYPT_E_NOT_DECRYPTED = -2146889718 +CRYPT_E_RECIPIENT_NOT_FOUND = -2146889717 +CRYPT_E_CONTROL_TYPE = -2146889716 +CRYPT_E_ISSUER_SERIALNUMBER = -2146889715 +CRYPT_E_SIGNER_NOT_FOUND = -2146889714 +CRYPT_E_ATTRIBUTES_MISSING = -2146889713 +CRYPT_E_STREAM_MSG_NOT_READY = -2146889712 +CRYPT_E_STREAM_INSUFFICIENT_DATA = -2146889711 CRYPT_I_NEW_PROTECTION_REQUIRED = (593938) -CRYPT_E_BAD_LEN = ((-2146885631)) -CRYPT_E_BAD_ENCODE = ((-2146885630)) -CRYPT_E_FILE_ERROR = ((-2146885629)) -CRYPT_E_NOT_FOUND = ((-2146885628)) -CRYPT_E_EXISTS = ((-2146885627)) -CRYPT_E_NO_PROVIDER = ((-2146885626)) -CRYPT_E_SELF_SIGNED = ((-2146885625)) -CRYPT_E_DELETED_PREV = ((-2146885624)) -CRYPT_E_NO_MATCH = ((-2146885623)) -CRYPT_E_UNEXPECTED_MSG_TYPE = ((-2146885622)) -CRYPT_E_NO_KEY_PROPERTY = ((-2146885621)) -CRYPT_E_NO_DECRYPT_CERT = ((-2146885620)) -CRYPT_E_BAD_MSG = ((-2146885619)) -CRYPT_E_NO_SIGNER = ((-2146885618)) -CRYPT_E_PENDING_CLOSE = ((-2146885617)) -CRYPT_E_REVOKED = ((-2146885616)) -CRYPT_E_NO_REVOCATION_DLL = ((-2146885615)) -CRYPT_E_NO_REVOCATION_CHECK = ((-2146885614)) -CRYPT_E_REVOCATION_OFFLINE = ((-2146885613)) -CRYPT_E_NOT_IN_REVOCATION_DATABASE = ((-2146885612)) -CRYPT_E_INVALID_NUMERIC_STRING = ((-2146885600)) -CRYPT_E_INVALID_PRINTABLE_STRING = ((-2146885599)) -CRYPT_E_INVALID_IA5_STRING = ((-2146885598)) -CRYPT_E_INVALID_X500_STRING = ((-2146885597)) -CRYPT_E_NOT_CHAR_STRING = ((-2146885596)) -CRYPT_E_FILERESIZED = ((-2146885595)) -CRYPT_E_SECURITY_SETTINGS = ((-2146885594)) -CRYPT_E_NO_VERIFY_USAGE_DLL = ((-2146885593)) -CRYPT_E_NO_VERIFY_USAGE_CHECK = ((-2146885592)) -CRYPT_E_VERIFY_USAGE_OFFLINE = ((-2146885591)) -CRYPT_E_NOT_IN_CTL = ((-2146885590)) -CRYPT_E_NO_TRUSTED_SIGNER = ((-2146885589)) -CRYPT_E_MISSING_PUBKEY_PARA = ((-2146885588)) -CRYPT_E_OSS_ERROR = ((-2146881536)) +CRYPT_E_BAD_LEN = -2146885631 +CRYPT_E_BAD_ENCODE = -2146885630 +CRYPT_E_FILE_ERROR = -2146885629 +CRYPT_E_NOT_FOUND = -2146885628 +CRYPT_E_EXISTS = -2146885627 +CRYPT_E_NO_PROVIDER = -2146885626 +CRYPT_E_SELF_SIGNED = -2146885625 +CRYPT_E_DELETED_PREV = -2146885624 +CRYPT_E_NO_MATCH = -2146885623 +CRYPT_E_UNEXPECTED_MSG_TYPE = -2146885622 +CRYPT_E_NO_KEY_PROPERTY = -2146885621 +CRYPT_E_NO_DECRYPT_CERT = -2146885620 +CRYPT_E_BAD_MSG = -2146885619 +CRYPT_E_NO_SIGNER = -2146885618 +CRYPT_E_PENDING_CLOSE = -2146885617 +CRYPT_E_REVOKED = -2146885616 +CRYPT_E_NO_REVOCATION_DLL = -2146885615 +CRYPT_E_NO_REVOCATION_CHECK = -2146885614 +CRYPT_E_REVOCATION_OFFLINE = -2146885613 +CRYPT_E_NOT_IN_REVOCATION_DATABASE = -2146885612 +CRYPT_E_INVALID_NUMERIC_STRING = -2146885600 +CRYPT_E_INVALID_PRINTABLE_STRING = -2146885599 +CRYPT_E_INVALID_IA5_STRING = -2146885598 +CRYPT_E_INVALID_X500_STRING = -2146885597 +CRYPT_E_NOT_CHAR_STRING = -2146885596 +CRYPT_E_FILERESIZED = -2146885595 +CRYPT_E_SECURITY_SETTINGS = -2146885594 +CRYPT_E_NO_VERIFY_USAGE_DLL = -2146885593 +CRYPT_E_NO_VERIFY_USAGE_CHECK = -2146885592 +CRYPT_E_VERIFY_USAGE_OFFLINE = -2146885591 +CRYPT_E_NOT_IN_CTL = -2146885590 +CRYPT_E_NO_TRUSTED_SIGNER = -2146885589 +CRYPT_E_MISSING_PUBKEY_PARA = -2146885588 +CRYPT_E_OSS_ERROR = -2146881536 -## Kerberos message types for LsaCallAuthenticationPackage (from ntsecapi.h) +# Kerberos message types for LsaCallAuthenticationPackage (from ntsecapi.h) KerbDebugRequestMessage = 0 KerbQueryTicketCacheMessage = 1 KerbChangeMachinePasswordMessage = 2 @@ -461,7 +465,7 @@ KerbRefreshSmartcardCredentialsMessage = 16 KerbAddExtraCredentialsMessage = 17 KerbQuerySupplementalCredentialsMessage = 18 -## messages used with msv1_0 from ntsecapi.h +# messages used with msv1_0 from ntsecapi.h MsV1_0Lm20ChallengeRequest = 0 MsV1_0Lm20GetChallengeResponse = 1 MsV1_0EnumerateUsers = 2 diff --git a/typings/win32helper/win32cryptcon.pyi b/typings/win32helper/win32cryptcon.pyi index 7ad7ed81..a6fe178b 100644 --- a/typings/win32helper/win32cryptcon.pyi +++ b/typings/win32helper/win32cryptcon.pyi @@ -1,9 +1,12 @@ # Generated by h2py from WinCrypt.h -def GET_ALG_CLASS(x): return (x & (7 << 13)) +def GET_ALG_CLASS(x) -> int: ... -def GET_ALG_TYPE(x): return (x & (15 << 9)) -def GET_ALG_SID(x): return (x & (511)) +def GET_ALG_TYPE(x) -> int: ... + + +def GET_ALG_SID(x) -> int: ... + ALG_CLASS_ANY = (0) ALG_CLASS_SIGNATURE = (1 << 13) @@ -88,38 +91,38 @@ CALG_MAC = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_MAC) CALG_RSA_SIGN = (ALG_CLASS_SIGNATURE | ALG_TYPE_RSA | ALG_SID_RSA_ANY) CALG_DSS_SIGN = (ALG_CLASS_SIGNATURE | ALG_TYPE_DSS | ALG_SID_DSS_ANY) CALG_NO_SIGN = (ALG_CLASS_SIGNATURE | ALG_TYPE_ANY | ALG_SID_ANY) -CALG_RSA_KEYX = (ALG_CLASS_KEY_EXCHANGE|ALG_TYPE_RSA|ALG_SID_RSA_ANY) -CALG_DES = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_DES) -CALG_3DES_112 = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_3DES_112) -CALG_3DES = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_3DES) -CALG_DESX = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_DESX) -CALG_RC2 = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_RC2) -CALG_RC4 = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_STREAM|ALG_SID_RC4) -CALG_SEAL = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_STREAM|ALG_SID_SEAL) -CALG_DH_SF = (ALG_CLASS_KEY_EXCHANGE|ALG_TYPE_DH|ALG_SID_DH_SANDF) -CALG_DH_EPHEM = (ALG_CLASS_KEY_EXCHANGE|ALG_TYPE_DH|ALG_SID_DH_EPHEM) -CALG_AGREEDKEY_ANY = (ALG_CLASS_KEY_EXCHANGE|ALG_TYPE_DH|ALG_SID_AGREED_KEY_ANY) -CALG_KEA_KEYX = (ALG_CLASS_KEY_EXCHANGE|ALG_TYPE_DH|ALG_SID_KEA) -CALG_HUGHES_MD5 = (ALG_CLASS_KEY_EXCHANGE|ALG_TYPE_ANY|ALG_SID_MD5) -CALG_SKIPJACK = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_SKIPJACK) -CALG_TEK = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_TEK) -CALG_CYLINK_MEK = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_CYLINK_MEK) +CALG_RSA_KEYX = (ALG_CLASS_KEY_EXCHANGE | ALG_TYPE_RSA | ALG_SID_RSA_ANY) +CALG_DES = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_BLOCK | ALG_SID_DES) +CALG_3DES_112 = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_BLOCK | ALG_SID_3DES_112) +CALG_3DES = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_BLOCK | ALG_SID_3DES) +CALG_DESX = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_BLOCK | ALG_SID_DESX) +CALG_RC2 = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_BLOCK | ALG_SID_RC2) +CALG_RC4 = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_STREAM | ALG_SID_RC4) +CALG_SEAL = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_STREAM | ALG_SID_SEAL) +CALG_DH_SF = (ALG_CLASS_KEY_EXCHANGE | ALG_TYPE_DH | ALG_SID_DH_SANDF) +CALG_DH_EPHEM = (ALG_CLASS_KEY_EXCHANGE | ALG_TYPE_DH | ALG_SID_DH_EPHEM) +CALG_AGREEDKEY_ANY = (ALG_CLASS_KEY_EXCHANGE | ALG_TYPE_DH | ALG_SID_AGREED_KEY_ANY) +CALG_KEA_KEYX = (ALG_CLASS_KEY_EXCHANGE | ALG_TYPE_DH | ALG_SID_KEA) +CALG_HUGHES_MD5 = (ALG_CLASS_KEY_EXCHANGE | ALG_TYPE_ANY | ALG_SID_MD5) +CALG_SKIPJACK = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_BLOCK | ALG_SID_SKIPJACK) +CALG_TEK = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_BLOCK | ALG_SID_TEK) +CALG_CYLINK_MEK = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_BLOCK | ALG_SID_CYLINK_MEK) CALG_SSL3_SHAMD5 = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_SSL3SHAMD5) -CALG_SSL3_MASTER = (ALG_CLASS_MSG_ENCRYPT|ALG_TYPE_SECURECHANNEL|ALG_SID_SSL3_MASTER) -CALG_SCHANNEL_MASTER_HASH = (ALG_CLASS_MSG_ENCRYPT|ALG_TYPE_SECURECHANNEL|ALG_SID_SCHANNEL_MASTER_HASH) -CALG_SCHANNEL_MAC_KEY = (ALG_CLASS_MSG_ENCRYPT|ALG_TYPE_SECURECHANNEL|ALG_SID_SCHANNEL_MAC_KEY) -CALG_SCHANNEL_ENC_KEY = (ALG_CLASS_MSG_ENCRYPT|ALG_TYPE_SECURECHANNEL|ALG_SID_SCHANNEL_ENC_KEY) -CALG_PCT1_MASTER = (ALG_CLASS_MSG_ENCRYPT|ALG_TYPE_SECURECHANNEL|ALG_SID_PCT1_MASTER) -CALG_SSL2_MASTER = (ALG_CLASS_MSG_ENCRYPT|ALG_TYPE_SECURECHANNEL|ALG_SID_SSL2_MASTER) -CALG_TLS1_MASTER = (ALG_CLASS_MSG_ENCRYPT|ALG_TYPE_SECURECHANNEL|ALG_SID_TLS1_MASTER) -CALG_RC5 = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_RC5) +CALG_SSL3_MASTER = (ALG_CLASS_MSG_ENCRYPT | ALG_TYPE_SECURECHANNEL | ALG_SID_SSL3_MASTER) +CALG_SCHANNEL_MASTER_HASH = (ALG_CLASS_MSG_ENCRYPT | ALG_TYPE_SECURECHANNEL | ALG_SID_SCHANNEL_MASTER_HASH) +CALG_SCHANNEL_MAC_KEY = (ALG_CLASS_MSG_ENCRYPT | ALG_TYPE_SECURECHANNEL | ALG_SID_SCHANNEL_MAC_KEY) +CALG_SCHANNEL_ENC_KEY = (ALG_CLASS_MSG_ENCRYPT | ALG_TYPE_SECURECHANNEL | ALG_SID_SCHANNEL_ENC_KEY) +CALG_PCT1_MASTER = (ALG_CLASS_MSG_ENCRYPT | ALG_TYPE_SECURECHANNEL | ALG_SID_PCT1_MASTER) +CALG_SSL2_MASTER = (ALG_CLASS_MSG_ENCRYPT | ALG_TYPE_SECURECHANNEL | ALG_SID_SSL2_MASTER) +CALG_TLS1_MASTER = (ALG_CLASS_MSG_ENCRYPT | ALG_TYPE_SECURECHANNEL | ALG_SID_TLS1_MASTER) +CALG_RC5 = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_BLOCK | ALG_SID_RC5) CALG_HMAC = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_HMAC) CALG_TLS1PRF = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_TLS1PRF) CALG_HASH_REPLACE_OWF = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_HASH_REPLACE_OWF) -CALG_AES_128 = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_AES_128) -CALG_AES_192 = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_AES_192) -CALG_AES_256 = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_AES_256) -CALG_AES = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_AES) +CALG_AES_128 = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_BLOCK | ALG_SID_AES_128) +CALG_AES_192 = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_BLOCK | ALG_SID_AES_192) +CALG_AES_256 = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_BLOCK | ALG_SID_AES_256) +CALG_AES = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_BLOCK | ALG_SID_AES) CALG_SHA_256 = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_SHA_256) CALG_SHA_384 = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_SHA_384) CALG_SHA_512 = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_SHA_512) @@ -241,8 +244,15 @@ HP_TLS1PRF_SEED = 0x0007 CRYPT_FAILED = 0 CRYPT_SUCCEED = 1 -def RCRYPT_SUCCEEDED(rt): return ((rt) == CRYPT_SUCCEED) -def RCRYPT_FAILED(rt): return ((rt) == CRYPT_FAILED) + + +def RCRYPT_SUCCEEDED(rt) -> bool: + ... + + +def RCRYPT_FAILED(rt) -> bool: + ... + PP_ENUMALGS = 1 PP_ENUMCONTAINERS = 2 @@ -571,9 +581,15 @@ CERT_KEYGEN_REQUEST_V1 = 0 CTL_V1 = 0 CERT_ENCODING_TYPE_MASK = 0x0000FFFF CMSG_ENCODING_TYPE_MASK = (-65536) -def GET_CERT_ENCODING_TYPE(X): return (X & CERT_ENCODING_TYPE_MASK) -def GET_CMSG_ENCODING_TYPE(X): return (X & CMSG_ENCODING_TYPE_MASK) + +def GET_CERT_ENCODING_TYPE(X) -> int: + ... + + +def GET_CMSG_ENCODING_TYPE(X) -> int: + ... + CRYPT_ASN_ENCODING = 0x00000001 CRYPT_NDR_ENCODING = 0x00000002 @@ -596,11 +612,11 @@ CRYPT_FORMAT_CRLF = CRYPT_FORMAT_RDN_CRLF CRYPT_ENCODE_NO_SIGNATURE_BYTE_REVERSAL_FLAG = 0x8 CRYPT_ENCODE_ALLOC_FLAG = 0x8000 CRYPT_UNICODE_NAME_ENCODE_ENABLE_T61_UNICODE_FLAG = \ - CERT_RDN_ENABLE_T61_UNICODE_FLAG + CERT_RDN_ENABLE_T61_UNICODE_FLAG CRYPT_UNICODE_NAME_ENCODE_ENABLE_UTF8_UNICODE_FLAG = \ - CERT_RDN_ENABLE_UTF8_UNICODE_FLAG + CERT_RDN_ENABLE_UTF8_UNICODE_FLAG CRYPT_UNICODE_NAME_ENCODE_DISABLE_CHECK_TYPE_FLAG = \ - CERT_RDN_DISABLE_CHECK_TYPE_FLAG + CERT_RDN_DISABLE_CHECK_TYPE_FLAG CRYPT_SORTED_CTL_ENCODE_HASHED_SUBJECT_IDENTIFIER_FLAG = 0x10000 CRYPT_DECODE_NOCOPY_FLAG = 0x1 CRYPT_DECODE_TO_BE_SIGNED_FLAG = 0x2 @@ -608,7 +624,7 @@ CRYPT_DECODE_SHARE_OID_STRING_FLAG = 0x4 CRYPT_DECODE_NO_SIGNATURE_BYTE_REVERSAL_FLAG = 0x8 CRYPT_DECODE_ALLOC_FLAG = 0x8000 CRYPT_UNICODE_NAME_DECODE_DISABLE_IE4_UTF8_FLAG = \ - CERT_RDN_DISABLE_IE4_UTF8_FLAG + CERT_RDN_DISABLE_IE4_UTF8_FLAG CRYPT_ENCODE_DECODE_NONE = 0 X509_CERT = 1 @@ -872,18 +888,18 @@ CROSS_CERT_DIST_POINT_ERR_INDEX_SHIFT = 24 CERT_EXCLUDED_SUBTREE_BIT = (-2147483648) -SORTED_CTL_EXT_FLAGS_OFFSET = (0*4) -SORTED_CTL_EXT_COUNT_OFFSET = (1*4) -SORTED_CTL_EXT_MAX_COLLISION_OFFSET = (2*4) -SORTED_CTL_EXT_HASH_BUCKET_OFFSET = (3*4) +SORTED_CTL_EXT_FLAGS_OFFSET = (0 * 4) +SORTED_CTL_EXT_COUNT_OFFSET = (1 * 4) +SORTED_CTL_EXT_MAX_COLLISION_OFFSET = (2 * 4) +SORTED_CTL_EXT_HASH_BUCKET_OFFSET = (3 * 4) SORTED_CTL_EXT_HASHED_SUBJECT_IDENTIFIER_FLAG = 0x1 CERT_DSS_R_LEN = 20 CERT_DSS_S_LEN = 20 CERT_DSS_SIGNATURE_LEN = (CERT_DSS_R_LEN + CERT_DSS_S_LEN) -CERT_MAX_ASN_ENCODED_DSS_SIGNATURE_LEN = (2 + 2*(2 + 20 +1)) +CERT_MAX_ASN_ENCODED_DSS_SIGNATURE_LEN = (2 + 2 * (2 + 20 + 1)) CRYPT_X942_COUNTER_BYTE_LENGTH = 4 CRYPT_X942_KEY_LENGTH_BYTE_LENGTH = 4 -CRYPT_X942_PUB_INFO_BYTE_LENGTH = (512/8) +CRYPT_X942_PUB_INFO_BYTE_LENGTH = (512 / 8) CRYPT_RC2_40BIT_VERSION = 160 CRYPT_RC2_56BIT_VERSION = 52 CRYPT_RC2_64BIT_VERSION = 120 @@ -1218,9 +1234,9 @@ CERT_LAST_USER_PROP_ID = 0x0000FFFF szOID_CERT_PROP_ID_PREFIX = "1.3.6.1.4.1.311.10.11." szOID_CERT_KEY_IDENTIFIER_PROP_ID = "1.3.6.1.4.1.311.10.11.20" szOID_CERT_ISSUER_SERIAL_NUMBER_MD5_HASH_PROP_ID = \ - "1.3.6.1.4.1.311.10.11.28" + "1.3.6.1.4.1.311.10.11.28" szOID_CERT_SUBJECT_NAME_MD5_HASH_PROP_ID = \ - "1.3.6.1.4.1.311.10.11.29" + "1.3.6.1.4.1.311.10.11.29" CERT_ACCESS_STATE_WRITE_PERSIST_FLAG = 0x1 CERT_ACCESS_STATE_SYSTEM_STORE_FLAG = 0x2 CERT_ACCESS_STATE_LM_SYSTEM_STORE_FLAG = 0x4 @@ -1288,14 +1304,14 @@ CERT_SYSTEM_STORE_SERVICES = \ CERT_SYSTEM_STORE_USERS = \ (CERT_SYSTEM_STORE_USERS_ID << CERT_SYSTEM_STORE_LOCATION_SHIFT) CERT_SYSTEM_STORE_CURRENT_USER_GROUP_POLICY = \ - (CERT_SYSTEM_STORE_CURRENT_USER_GROUP_POLICY_ID << \ - CERT_SYSTEM_STORE_LOCATION_SHIFT) + (CERT_SYSTEM_STORE_CURRENT_USER_GROUP_POLICY_ID + << CERT_SYSTEM_STORE_LOCATION_SHIFT) CERT_SYSTEM_STORE_LOCAL_MACHINE_GROUP_POLICY = \ - (CERT_SYSTEM_STORE_LOCAL_MACHINE_GROUP_POLICY_ID << \ - CERT_SYSTEM_STORE_LOCATION_SHIFT) + (CERT_SYSTEM_STORE_LOCAL_MACHINE_GROUP_POLICY_ID + << CERT_SYSTEM_STORE_LOCATION_SHIFT) CERT_SYSTEM_STORE_LOCAL_MACHINE_ENTERPRISE = \ - (CERT_SYSTEM_STORE_LOCAL_MACHINE_ENTERPRISE_ID << \ - CERT_SYSTEM_STORE_LOCATION_SHIFT) + (CERT_SYSTEM_STORE_LOCAL_MACHINE_ENTERPRISE_ID + << CERT_SYSTEM_STORE_LOCATION_SHIFT) CERT_PROT_ROOT_DISABLE_CURRENT_USER_FLAG = 0x1 CERT_PROT_ROOT_INHIBIT_ADD_AT_INIT_FLAG = 0x2 CERT_PROT_ROOT_INHIBIT_PURGE_LM_FLAG = 0x4 @@ -1325,7 +1341,7 @@ CERT_AUTH_ROOT_CERT_EXT = ".crt" CERT_GROUP_POLICY_SYSTEM_STORE_REGPATH = r"Software\Policies\Microsoft\SystemCertificates" CERT_EFSBLOB_REGPATH = CERT_GROUP_POLICY_SYSTEM_STORE_REGPATH + r"\EFS" CERT_EFSBLOB_VALUE_NAME = "EFSBlob" -CERT_PROT_ROOT_FLAGS_REGPATH = CERT_GROUP_POLICY_SYSTEM_STORE_REGPATH +r"\Root\ProtectedRoots" +CERT_PROT_ROOT_FLAGS_REGPATH = CERT_GROUP_POLICY_SYSTEM_STORE_REGPATH + r"\Root\ProtectedRoots" CERT_PROT_ROOT_FLAGS_VALUE_NAME = "Flags" CERT_TRUST_PUB_SAFER_GROUP_POLICY_REGPATH = CERT_GROUP_POLICY_SYSTEM_STORE_REGPATH + r"\TrustedPublisher\Safer" CERT_LOCAL_MACHINE_SYSTEM_STORE_REGPATH = r"Software\Microsoft\SystemCertificates" @@ -1421,23 +1437,23 @@ CERT_FIND_KEY_IDENTIFIER = (CERT_COMPARE_KEY_IDENTIFIER << CERT_COMPARE_SHIFT) CERT_FIND_HASH = CERT_FIND_SHA1_HASH CERT_FIND_PROPERTY = (CERT_COMPARE_PROPERTY << CERT_COMPARE_SHIFT) CERT_FIND_PUBLIC_KEY = (CERT_COMPARE_PUBLIC_KEY << CERT_COMPARE_SHIFT) -CERT_FIND_SUBJECT_NAME = (CERT_COMPARE_NAME << CERT_COMPARE_SHIFT | \ - CERT_INFO_SUBJECT_FLAG) -CERT_FIND_SUBJECT_ATTR = (CERT_COMPARE_ATTR << CERT_COMPARE_SHIFT | \ - CERT_INFO_SUBJECT_FLAG) -CERT_FIND_ISSUER_NAME = (CERT_COMPARE_NAME << CERT_COMPARE_SHIFT | \ - CERT_INFO_ISSUER_FLAG) -CERT_FIND_ISSUER_ATTR = (CERT_COMPARE_ATTR << CERT_COMPARE_SHIFT | \ - CERT_INFO_ISSUER_FLAG) -CERT_FIND_SUBJECT_STR_A = (CERT_COMPARE_NAME_STR_A << CERT_COMPARE_SHIFT | \ - CERT_INFO_SUBJECT_FLAG) -CERT_FIND_SUBJECT_STR_W = (CERT_COMPARE_NAME_STR_W << CERT_COMPARE_SHIFT | \ - CERT_INFO_SUBJECT_FLAG) +CERT_FIND_SUBJECT_NAME = (CERT_COMPARE_NAME << CERT_COMPARE_SHIFT + | CERT_INFO_SUBJECT_FLAG) +CERT_FIND_SUBJECT_ATTR = (CERT_COMPARE_ATTR << CERT_COMPARE_SHIFT + | CERT_INFO_SUBJECT_FLAG) +CERT_FIND_ISSUER_NAME = (CERT_COMPARE_NAME << CERT_COMPARE_SHIFT + | CERT_INFO_ISSUER_FLAG) +CERT_FIND_ISSUER_ATTR = (CERT_COMPARE_ATTR << CERT_COMPARE_SHIFT + | CERT_INFO_ISSUER_FLAG) +CERT_FIND_SUBJECT_STR_A = (CERT_COMPARE_NAME_STR_A << CERT_COMPARE_SHIFT + | CERT_INFO_SUBJECT_FLAG) +CERT_FIND_SUBJECT_STR_W = (CERT_COMPARE_NAME_STR_W << CERT_COMPARE_SHIFT + | CERT_INFO_SUBJECT_FLAG) CERT_FIND_SUBJECT_STR = CERT_FIND_SUBJECT_STR_W -CERT_FIND_ISSUER_STR_A = (CERT_COMPARE_NAME_STR_A << CERT_COMPARE_SHIFT | \ - CERT_INFO_ISSUER_FLAG) -CERT_FIND_ISSUER_STR_W = (CERT_COMPARE_NAME_STR_W << CERT_COMPARE_SHIFT | \ - CERT_INFO_ISSUER_FLAG) +CERT_FIND_ISSUER_STR_A = (CERT_COMPARE_NAME_STR_A << CERT_COMPARE_SHIFT + | CERT_INFO_ISSUER_FLAG) +CERT_FIND_ISSUER_STR_W = (CERT_COMPARE_NAME_STR_W << CERT_COMPARE_SHIFT + | CERT_INFO_ISSUER_FLAG) CERT_FIND_ISSUER_STR = CERT_FIND_ISSUER_STR_W CERT_FIND_KEY_SPEC = (CERT_COMPARE_KEY_SPEC << CERT_COMPARE_SHIFT) CERT_FIND_ENHKEY_USAGE = (CERT_COMPARE_ENHKEY_USAGE << CERT_COMPARE_SHIFT) @@ -1447,9 +1463,9 @@ CERT_FIND_ISSUER_OF = (CERT_COMPARE_ISSUER_OF << CERT_COMPARE_SHIFT) CERT_FIND_EXISTING = (CERT_COMPARE_EXISTING << CERT_COMPARE_SHIFT) CERT_FIND_CERT_ID = (CERT_COMPARE_CERT_ID << CERT_COMPARE_SHIFT) CERT_FIND_CROSS_CERT_DIST_POINTS = \ - (CERT_COMPARE_CROSS_CERT_DIST_POINTS << CERT_COMPARE_SHIFT) + (CERT_COMPARE_CROSS_CERT_DIST_POINTS << CERT_COMPARE_SHIFT) CERT_FIND_PUBKEY_MD5_HASH = \ - (CERT_COMPARE_PUBKEY_MD5_HASH << CERT_COMPARE_SHIFT) + (CERT_COMPARE_PUBKEY_MD5_HASH << CERT_COMPARE_SHIFT) CERT_FIND_OPTIONAL_ENHKEY_USAGE_FLAG = 0x1 CERT_FIND_EXT_ONLY_ENHKEY_USAGE_FLAG = 0x2 CERT_FIND_PROP_ONLY_ENHKEY_USAGE_FLAG = 0x4 @@ -1458,9 +1474,9 @@ CERT_FIND_OR_ENHKEY_USAGE_FLAG = 0x10 CERT_FIND_VALID_ENHKEY_USAGE_FLAG = 0x20 CERT_FIND_OPTIONAL_CTL_USAGE_FLAG = CERT_FIND_OPTIONAL_ENHKEY_USAGE_FLAG CERT_FIND_EXT_ONLY_CTL_USAGE_FLAG = \ - CERT_FIND_EXT_ONLY_ENHKEY_USAGE_FLAG + CERT_FIND_EXT_ONLY_ENHKEY_USAGE_FLAG CERT_FIND_PROP_ONLY_CTL_USAGE_FLAG = \ - CERT_FIND_PROP_ONLY_ENHKEY_USAGE_FLAG + CERT_FIND_PROP_ONLY_ENHKEY_USAGE_FLAG CERT_FIND_NO_CTL_USAGE_FLAG = CERT_FIND_NO_ENHKEY_USAGE_FLAG CERT_FIND_OR_CTL_USAGE_FLAG = CERT_FIND_OR_ENHKEY_USAGE_FLAG CERT_FIND_VALID_CTL_USAGE_FLAG = CERT_FIND_VALID_ENHKEY_USAGE_FLAG @@ -1488,11 +1504,11 @@ CERT_STORE_CTL_CONTEXT = 3 CERT_STORE_ALL_CONTEXT_FLAG = -1 CERT_STORE_CERTIFICATE_CONTEXT_FLAG = \ - (1 << CERT_STORE_CERTIFICATE_CONTEXT) + (1 << CERT_STORE_CERTIFICATE_CONTEXT) CERT_STORE_CRL_CONTEXT_FLAG = \ - (1 << CERT_STORE_CRL_CONTEXT) + (1 << CERT_STORE_CRL_CONTEXT) CERT_STORE_CTL_CONTEXT_FLAG = \ - (1 << CERT_STORE_CTL_CONTEXT) + (1 << CERT_STORE_CTL_CONTEXT) CTL_ANY_SUBJECT_TYPE = 1 CTL_CERT_SUBJECT_TYPE = 2 CTL_FIND_ANY = 0 @@ -1625,58 +1641,58 @@ CERT_QUERY_CONTENT_PKCS10 = 11 CERT_QUERY_CONTENT_PFX = 12 CERT_QUERY_CONTENT_CERT_PAIR = 13 CERT_QUERY_CONTENT_FLAG_CERT = \ - ( 1 << CERT_QUERY_CONTENT_CERT) + (1 << CERT_QUERY_CONTENT_CERT) CERT_QUERY_CONTENT_FLAG_CTL = \ - ( 1 << CERT_QUERY_CONTENT_CTL) + (1 << CERT_QUERY_CONTENT_CTL) CERT_QUERY_CONTENT_FLAG_CRL = \ - ( 1 << CERT_QUERY_CONTENT_CRL) + (1 << CERT_QUERY_CONTENT_CRL) CERT_QUERY_CONTENT_FLAG_SERIALIZED_STORE = \ - ( 1 << CERT_QUERY_CONTENT_SERIALIZED_STORE) + (1 << CERT_QUERY_CONTENT_SERIALIZED_STORE) CERT_QUERY_CONTENT_FLAG_SERIALIZED_CERT = \ - ( 1 << CERT_QUERY_CONTENT_SERIALIZED_CERT) + (1 << CERT_QUERY_CONTENT_SERIALIZED_CERT) CERT_QUERY_CONTENT_FLAG_SERIALIZED_CTL = \ - ( 1 << CERT_QUERY_CONTENT_SERIALIZED_CTL) + (1 << CERT_QUERY_CONTENT_SERIALIZED_CTL) CERT_QUERY_CONTENT_FLAG_SERIALIZED_CRL = \ - ( 1 << CERT_QUERY_CONTENT_SERIALIZED_CRL) + (1 << CERT_QUERY_CONTENT_SERIALIZED_CRL) CERT_QUERY_CONTENT_FLAG_PKCS7_SIGNED = \ - ( 1 << CERT_QUERY_CONTENT_PKCS7_SIGNED) + (1 << CERT_QUERY_CONTENT_PKCS7_SIGNED) CERT_QUERY_CONTENT_FLAG_PKCS7_UNSIGNED = \ - ( 1 << CERT_QUERY_CONTENT_PKCS7_UNSIGNED) + (1 << CERT_QUERY_CONTENT_PKCS7_UNSIGNED) CERT_QUERY_CONTENT_FLAG_PKCS7_SIGNED_EMBED = \ - ( 1 << CERT_QUERY_CONTENT_PKCS7_SIGNED_EMBED) + (1 << CERT_QUERY_CONTENT_PKCS7_SIGNED_EMBED) CERT_QUERY_CONTENT_FLAG_PKCS10 = \ - ( 1 << CERT_QUERY_CONTENT_PKCS10) + (1 << CERT_QUERY_CONTENT_PKCS10) CERT_QUERY_CONTENT_FLAG_PFX = \ - ( 1 << CERT_QUERY_CONTENT_PFX) + (1 << CERT_QUERY_CONTENT_PFX) CERT_QUERY_CONTENT_FLAG_CERT_PAIR = \ - ( 1 << CERT_QUERY_CONTENT_CERT_PAIR) + (1 << CERT_QUERY_CONTENT_CERT_PAIR) CERT_QUERY_CONTENT_FLAG_ALL = \ - CERT_QUERY_CONTENT_FLAG_CERT | \ - CERT_QUERY_CONTENT_FLAG_CTL | \ - CERT_QUERY_CONTENT_FLAG_CRL | \ - CERT_QUERY_CONTENT_FLAG_SERIALIZED_STORE | \ - CERT_QUERY_CONTENT_FLAG_SERIALIZED_CERT | \ - CERT_QUERY_CONTENT_FLAG_SERIALIZED_CTL | \ - CERT_QUERY_CONTENT_FLAG_SERIALIZED_CRL | \ - CERT_QUERY_CONTENT_FLAG_PKCS7_SIGNED | \ - CERT_QUERY_CONTENT_FLAG_PKCS7_UNSIGNED | \ - CERT_QUERY_CONTENT_FLAG_PKCS7_SIGNED_EMBED | \ - CERT_QUERY_CONTENT_FLAG_PKCS10 | \ - CERT_QUERY_CONTENT_FLAG_PFX | \ - CERT_QUERY_CONTENT_FLAG_CERT_PAIR + CERT_QUERY_CONTENT_FLAG_CERT | \ + CERT_QUERY_CONTENT_FLAG_CTL | \ + CERT_QUERY_CONTENT_FLAG_CRL | \ + CERT_QUERY_CONTENT_FLAG_SERIALIZED_STORE | \ + CERT_QUERY_CONTENT_FLAG_SERIALIZED_CERT | \ + CERT_QUERY_CONTENT_FLAG_SERIALIZED_CTL | \ + CERT_QUERY_CONTENT_FLAG_SERIALIZED_CRL | \ + CERT_QUERY_CONTENT_FLAG_PKCS7_SIGNED | \ + CERT_QUERY_CONTENT_FLAG_PKCS7_UNSIGNED | \ + CERT_QUERY_CONTENT_FLAG_PKCS7_SIGNED_EMBED | \ + CERT_QUERY_CONTENT_FLAG_PKCS10 | \ + CERT_QUERY_CONTENT_FLAG_PFX | \ + CERT_QUERY_CONTENT_FLAG_CERT_PAIR CERT_QUERY_FORMAT_BINARY = 1 CERT_QUERY_FORMAT_BASE64_ENCODED = 2 CERT_QUERY_FORMAT_ASN_ASCII_HEX_ENCODED = 3 CERT_QUERY_FORMAT_FLAG_BINARY = \ - ( 1 << CERT_QUERY_FORMAT_BINARY) + (1 << CERT_QUERY_FORMAT_BINARY) CERT_QUERY_FORMAT_FLAG_BASE64_ENCODED = \ - ( 1 << CERT_QUERY_FORMAT_BASE64_ENCODED) + (1 << CERT_QUERY_FORMAT_BASE64_ENCODED) CERT_QUERY_FORMAT_FLAG_ASN_ASCII_HEX_ENCODED = \ - ( 1 << CERT_QUERY_FORMAT_ASN_ASCII_HEX_ENCODED) + (1 << CERT_QUERY_FORMAT_ASN_ASCII_HEX_ENCODED) CERT_QUERY_FORMAT_FLAG_ALL = \ - CERT_QUERY_FORMAT_FLAG_BINARY | \ - CERT_QUERY_FORMAT_FLAG_BASE64_ENCODED | \ - CERT_QUERY_FORMAT_FLAG_ASN_ASCII_HEX_ENCODED + CERT_QUERY_FORMAT_FLAG_BINARY | \ + CERT_QUERY_FORMAT_FLAG_BASE64_ENCODED | \ + CERT_QUERY_FORMAT_FLAG_ASN_ASCII_HEX_ENCODED CREDENTIAL_OID_PASSWORD_CREDENTIALS_A = 1 CREDENTIAL_OID_PASSWORD_CREDENTIALS_W = 2 @@ -1822,11 +1838,11 @@ CERT_CHAIN_POLICY_IGNORE_NOT_TIME_VALID_FLAG = 0x00000001 CERT_CHAIN_POLICY_IGNORE_CTL_NOT_TIME_VALID_FLAG = 0x00000002 CERT_CHAIN_POLICY_IGNORE_NOT_TIME_NESTED_FLAG = 0x00000004 CERT_CHAIN_POLICY_IGNORE_INVALID_BASIC_CONSTRAINTS_FLAG = 0x00000008 -CERT_CHAIN_POLICY_IGNORE_ALL_NOT_TIME_VALID_FLAGS = ( \ - CERT_CHAIN_POLICY_IGNORE_NOT_TIME_VALID_FLAG | \ - CERT_CHAIN_POLICY_IGNORE_CTL_NOT_TIME_VALID_FLAG | \ - CERT_CHAIN_POLICY_IGNORE_NOT_TIME_NESTED_FLAG \ - ) +CERT_CHAIN_POLICY_IGNORE_ALL_NOT_TIME_VALID_FLAGS = ( + CERT_CHAIN_POLICY_IGNORE_NOT_TIME_VALID_FLAG + | CERT_CHAIN_POLICY_IGNORE_CTL_NOT_TIME_VALID_FLAG + | CERT_CHAIN_POLICY_IGNORE_NOT_TIME_NESTED_FLAG +) CERT_CHAIN_POLICY_ALLOW_UNKNOWN_CA_FLAG = 0x00000010 CERT_CHAIN_POLICY_IGNORE_WRONG_USAGE_FLAG = 0x00000020 CERT_CHAIN_POLICY_IGNORE_INVALID_NAME_FLAG = 0x00000040 @@ -1835,12 +1851,12 @@ CERT_CHAIN_POLICY_IGNORE_END_REV_UNKNOWN_FLAG = 0x00000100 CERT_CHAIN_POLICY_IGNORE_CTL_SIGNER_REV_UNKNOWN_FLAG = 0x00000200 CERT_CHAIN_POLICY_IGNORE_CA_REV_UNKNOWN_FLAG = 0x00000400 CERT_CHAIN_POLICY_IGNORE_ROOT_REV_UNKNOWN_FLAG = 0x00000800 -CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS = ( \ - CERT_CHAIN_POLICY_IGNORE_END_REV_UNKNOWN_FLAG | \ - CERT_CHAIN_POLICY_IGNORE_CTL_SIGNER_REV_UNKNOWN_FLAG | \ - CERT_CHAIN_POLICY_IGNORE_CA_REV_UNKNOWN_FLAG | \ - CERT_CHAIN_POLICY_IGNORE_ROOT_REV_UNKNOWN_FLAG \ - ) +CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS = ( + CERT_CHAIN_POLICY_IGNORE_END_REV_UNKNOWN_FLAG + | CERT_CHAIN_POLICY_IGNORE_CTL_SIGNER_REV_UNKNOWN_FLAG + | CERT_CHAIN_POLICY_IGNORE_CA_REV_UNKNOWN_FLAG + | CERT_CHAIN_POLICY_IGNORE_ROOT_REV_UNKNOWN_FLAG +) CERT_CHAIN_POLICY_ALLOW_TESTROOT_FLAG = 0x00008000 CERT_CHAIN_POLICY_TRUST_TESTROOT_FLAG = 0x00004000 CRYPT_OID_VERIFY_CERTIFICATE_CHAIN_POLICY_FUNC = \ diff --git a/typings/win32helper/win32inetcon.pyi b/typings/win32helper/win32inetcon.pyi index 3338fe25..1f505c22 100644 --- a/typings/win32helper/win32inetcon.pyi +++ b/typings/win32helper/win32inetcon.pyi @@ -53,10 +53,10 @@ INTERNET_FLAG_FORMS_SUBMIT = 0x00000040 INTERNET_FLAG_FWD_BACK = 0x00000020 INTERNET_FLAG_NEED_FILE = 0x00000010 INTERNET_FLAG_MUST_CACHE_REQUEST = INTERNET_FLAG_NEED_FILE -SECURITY_INTERNET_MASK = (INTERNET_FLAG_IGNORE_CERT_CN_INVALID | \ - INTERNET_FLAG_IGNORE_CERT_DATE_INVALID | \ - INTERNET_FLAG_IGNORE_REDIRECT_TO_HTTPS | \ - INTERNET_FLAG_IGNORE_REDIRECT_TO_HTTP ) +SECURITY_INTERNET_MASK = (INTERNET_FLAG_IGNORE_CERT_CN_INVALID + | INTERNET_FLAG_IGNORE_CERT_DATE_INVALID + | INTERNET_FLAG_IGNORE_REDIRECT_TO_HTTPS + | INTERNET_FLAG_IGNORE_REDIRECT_TO_HTTP) INTERNET_ERROR_MASK_INSERT_CDROM = 0x1 INTERNET_ERROR_MASK_COMBINED_SEC_CERT = 0x2 INTERNET_ERROR_MASK_NEED_MSN_SSPI_PKG = 0X4 @@ -243,11 +243,11 @@ SECURITY_FLAG_IGNORE_CERT_CN_INVALID = INTERNET_FLAG_IGNORE_CERT_CN_INVALID SECURITY_FLAG_IGNORE_CERT_DATE_INVALID = INTERNET_FLAG_IGNORE_CERT_DATE_INVALID SECURITY_FLAG_IGNORE_REDIRECT_TO_HTTPS = INTERNET_FLAG_IGNORE_REDIRECT_TO_HTTPS SECURITY_FLAG_IGNORE_REDIRECT_TO_HTTP = INTERNET_FLAG_IGNORE_REDIRECT_TO_HTTP -SECURITY_SET_MASK = (SECURITY_FLAG_IGNORE_REVOCATION |\ - SECURITY_FLAG_IGNORE_UNKNOWN_CA |\ - SECURITY_FLAG_IGNORE_CERT_CN_INVALID |\ - SECURITY_FLAG_IGNORE_CERT_DATE_INVALID |\ - SECURITY_FLAG_IGNORE_WRONG_USAGE) +SECURITY_SET_MASK = (SECURITY_FLAG_IGNORE_REVOCATION + | SECURITY_FLAG_IGNORE_UNKNOWN_CA + | SECURITY_FLAG_IGNORE_CERT_CN_INVALID + | SECURITY_FLAG_IGNORE_CERT_DATE_INVALID + | SECURITY_FLAG_IGNORE_WRONG_USAGE) AUTODIAL_MODE_NEVER = 1 AUTODIAL_MODE_ALWAYS = 2 AUTODIAL_MODE_NO_NETWORK_PRESENT = 4 @@ -289,18 +289,18 @@ FTP_TRANSFER_TYPE_MASK = (FTP_TRANSFER_TYPE_ASCII | FTP_TRANSFER_TYPE_BINARY) MAX_GOPHER_DISPLAY_TEXT = 128 MAX_GOPHER_SELECTOR_TEXT = 256 MAX_GOPHER_HOST_NAME = INTERNET_MAX_HOST_NAME_LENGTH -MAX_GOPHER_LOCATOR_LENGTH = (1 \ - + MAX_GOPHER_DISPLAY_TEXT \ - + 1 \ - + MAX_GOPHER_SELECTOR_TEXT \ - + 1 \ - + MAX_GOPHER_HOST_NAME \ - + 1 \ - + INTERNET_MAX_PORT_NUMBER_LENGTH \ - + 1 \ - + 1 \ - + 2 \ - ) +MAX_GOPHER_LOCATOR_LENGTH = (1 + + MAX_GOPHER_DISPLAY_TEXT + + 1 + + MAX_GOPHER_SELECTOR_TEXT + + 1 + + MAX_GOPHER_HOST_NAME + + 1 + + INTERNET_MAX_PORT_NUMBER_LENGTH + + 1 + + 1 + + 2 + ) GOPHER_TYPE_TEXT_FILE = 0x00000001 GOPHER_TYPE_DIRECTORY = 0x00000002 GOPHER_TYPE_CSO = 0x00000004 @@ -325,21 +325,21 @@ GOPHER_TYPE_INLINE = 0x00100000 GOPHER_TYPE_UNKNOWN = 0x20000000 GOPHER_TYPE_ASK = 0x40000000 GOPHER_TYPE_GOPHER_PLUS = (-2147483648) -GOPHER_TYPE_FILE_MASK = (GOPHER_TYPE_TEXT_FILE \ - | GOPHER_TYPE_MAC_BINHEX \ - | GOPHER_TYPE_DOS_ARCHIVE \ - | GOPHER_TYPE_UNIX_UUENCODED \ - | GOPHER_TYPE_BINARY \ - | GOPHER_TYPE_GIF \ - | GOPHER_TYPE_IMAGE \ - | GOPHER_TYPE_BITMAP \ - | GOPHER_TYPE_MOVIE \ - | GOPHER_TYPE_SOUND \ - | GOPHER_TYPE_HTML \ - | GOPHER_TYPE_PDF \ - | GOPHER_TYPE_CALENDAR \ - | GOPHER_TYPE_INLINE \ - ) +GOPHER_TYPE_FILE_MASK = (GOPHER_TYPE_TEXT_FILE + | GOPHER_TYPE_MAC_BINHEX + | GOPHER_TYPE_DOS_ARCHIVE + | GOPHER_TYPE_UNIX_UUENCODED + | GOPHER_TYPE_BINARY + | GOPHER_TYPE_GIF + | GOPHER_TYPE_IMAGE + | GOPHER_TYPE_BITMAP + | GOPHER_TYPE_MOVIE + | GOPHER_TYPE_SOUND + | GOPHER_TYPE_HTML + | GOPHER_TYPE_PDF + | GOPHER_TYPE_CALENDAR + | GOPHER_TYPE_INLINE + ) MAX_GOPHER_CATEGORY_NAME = 128 MAX_GOPHER_ATTRIBUTE_NAME = 128 MIN_GOPHER_ATTRIBUTE_LENGTH = 256 @@ -458,11 +458,11 @@ HTTP_QUERY_FLAG_REQUEST_HEADERS = (-2147483648) HTTP_QUERY_FLAG_SYSTEMTIME = 0x40000000 HTTP_QUERY_FLAG_NUMBER = 0x20000000 HTTP_QUERY_FLAG_COALESCE = 0x10000000 -HTTP_QUERY_MODIFIER_FLAGS_MASK = (HTTP_QUERY_FLAG_REQUEST_HEADERS \ - | HTTP_QUERY_FLAG_SYSTEMTIME \ - | HTTP_QUERY_FLAG_NUMBER \ - | HTTP_QUERY_FLAG_COALESCE \ - ) +HTTP_QUERY_MODIFIER_FLAGS_MASK = (HTTP_QUERY_FLAG_REQUEST_HEADERS + | HTTP_QUERY_FLAG_SYSTEMTIME + | HTTP_QUERY_FLAG_NUMBER + | HTTP_QUERY_FLAG_COALESCE + ) HTTP_QUERY_HEADER_MASK = (~HTTP_QUERY_MODIFIER_FLAGS_MASK) HTTP_STATUS_CONTINUE = 100 HTTP_STATUS_SWITCH_PROTOCOLS = 101 @@ -638,11 +638,11 @@ SPARSE_CACHE_ENTRY = 0x00010000 COOKIE_CACHE_ENTRY = 0x00100000 URLHISTORY_CACHE_ENTRY = 0x00200000 URLCACHE_FIND_DEFAULT_FILTER = NORMAL_CACHE_ENTRY \ - | COOKIE_CACHE_ENTRY \ - | URLHISTORY_CACHE_ENTRY \ - | TRACK_OFFLINE_CACHE_ENTRY \ - | TRACK_ONLINE_CACHE_ENTRY \ - | STICKY_CACHE_ENTRY + | COOKIE_CACHE_ENTRY \ + | URLHISTORY_CACHE_ENTRY \ + | TRACK_OFFLINE_CACHE_ENTRY \ + | TRACK_ONLINE_CACHE_ENTRY \ + | STICKY_CACHE_ENTRY CACHEGROUP_ATTRIBUTE_GET_ALL = (-1) CACHEGROUP_ATTRIBUTE_BASIC = 0x00000001 CACHEGROUP_ATTRIBUTE_FLAG = 0x00000002 @@ -657,10 +657,10 @@ CACHEGROUP_SEARCH_ALL = 0x00000000 CACHEGROUP_SEARCH_BYURL = 0x00000001 CACHEGROUP_TYPE_INVALID = 0x00000001 CACHEGROUP_READWRITE_MASK = \ - CACHEGROUP_ATTRIBUTE_TYPE \ - | CACHEGROUP_ATTRIBUTE_QUOTA \ - | CACHEGROUP_ATTRIBUTE_GROUPNAME \ - | CACHEGROUP_ATTRIBUTE_STORAGE + CACHEGROUP_ATTRIBUTE_TYPE \ + | CACHEGROUP_ATTRIBUTE_QUOTA \ + | CACHEGROUP_ATTRIBUTE_GROUPNAME \ + | CACHEGROUP_ATTRIBUTE_STORAGE GROUPNAME_MAX_LENGTH = 120 GROUP_OWNER_STORAGE_SIZE = 4 CACHE_ENTRY_ATTRIBUTE_FC = 0x00000004 @@ -682,7 +682,8 @@ INTERNET_AUTODIAL_FORCE_ONLINE = 1 INTERNET_AUTODIAL_FORCE_UNATTENDED = 2 INTERNET_AUTODIAL_FAILIFSECURITYCHECK = 4 INTERNET_AUTODIAL_OVERRIDE_NET_PRESENT = 8 -INTERNET_AUTODIAL_FLAGS_MASK = (INTERNET_AUTODIAL_FORCE_ONLINE | INTERNET_AUTODIAL_FORCE_UNATTENDED | INTERNET_AUTODIAL_FAILIFSECURITYCHECK | INTERNET_AUTODIAL_OVERRIDE_NET_PRESENT) +INTERNET_AUTODIAL_FLAGS_MASK = (INTERNET_AUTODIAL_FORCE_ONLINE | INTERNET_AUTODIAL_FORCE_UNATTENDED + | INTERNET_AUTODIAL_FAILIFSECURITYCHECK | INTERNET_AUTODIAL_OVERRIDE_NET_PRESENT) PROXY_AUTO_DETECT_TYPE_DHCP = 1 PROXY_AUTO_DETECT_TYPE_DNS_A = 2 INTERNET_CONNECTION_MODEM = 0x01 @@ -861,9 +862,9 @@ WINHTTP_CALLBACK_STATUS_FLAG_SECURITY_CHANNEL_ERROR = (-2147483648) WINHTTP_FLAG_SECURE_PROTOCOL_SSL2 = 0x00000008 WINHTTP_FLAG_SECURE_PROTOCOL_SSL3 = 0x00000020 WINHTTP_FLAG_SECURE_PROTOCOL_TLS1 = 0x00000080 -WINHTTP_FLAG_SECURE_PROTOCOL_ALL = (WINHTTP_FLAG_SECURE_PROTOCOL_SSL2 | \ - WINHTTP_FLAG_SECURE_PROTOCOL_SSL3 | \ - WINHTTP_FLAG_SECURE_PROTOCOL_TLS1) +WINHTTP_FLAG_SECURE_PROTOCOL_ALL = (WINHTTP_FLAG_SECURE_PROTOCOL_SSL2 + | WINHTTP_FLAG_SECURE_PROTOCOL_SSL3 + | WINHTTP_FLAG_SECURE_PROTOCOL_TLS1) WINHTTP_CALLBACK_STATUS_RESOLVING_NAME = 0x00000001 WINHTTP_CALLBACK_STATUS_NAME_RESOLVED = 0x00000002 WINHTTP_CALLBACK_STATUS_CONNECTING_TO_SERVER = 0x00000004 @@ -892,10 +893,13 @@ API_READ_DATA = (3) API_WRITE_DATA = (4) API_SEND_REQUEST = (5) WINHTTP_CALLBACK_FLAG_RESOLVE_NAME = (WINHTTP_CALLBACK_STATUS_RESOLVING_NAME | WINHTTP_CALLBACK_STATUS_NAME_RESOLVED) -WINHTTP_CALLBACK_FLAG_CONNECT_TO_SERVER = (WINHTTP_CALLBACK_STATUS_CONNECTING_TO_SERVER | WINHTTP_CALLBACK_STATUS_CONNECTED_TO_SERVER) +WINHTTP_CALLBACK_FLAG_CONNECT_TO_SERVER = ( + WINHTTP_CALLBACK_STATUS_CONNECTING_TO_SERVER | WINHTTP_CALLBACK_STATUS_CONNECTED_TO_SERVER) WINHTTP_CALLBACK_FLAG_SEND_REQUEST = (WINHTTP_CALLBACK_STATUS_SENDING_REQUEST | WINHTTP_CALLBACK_STATUS_REQUEST_SENT) -WINHTTP_CALLBACK_FLAG_RECEIVE_RESPONSE = (WINHTTP_CALLBACK_STATUS_RECEIVING_RESPONSE | WINHTTP_CALLBACK_STATUS_RESPONSE_RECEIVED) -WINHTTP_CALLBACK_FLAG_CLOSE_CONNECTION = (WINHTTP_CALLBACK_STATUS_CLOSING_CONNECTION | WINHTTP_CALLBACK_STATUS_CONNECTION_CLOSED) +WINHTTP_CALLBACK_FLAG_RECEIVE_RESPONSE = ( + WINHTTP_CALLBACK_STATUS_RECEIVING_RESPONSE | WINHTTP_CALLBACK_STATUS_RESPONSE_RECEIVED) +WINHTTP_CALLBACK_FLAG_CLOSE_CONNECTION = ( + WINHTTP_CALLBACK_STATUS_CLOSING_CONNECTION | WINHTTP_CALLBACK_STATUS_CONNECTION_CLOSED) WINHTTP_CALLBACK_FLAG_HANDLES = (WINHTTP_CALLBACK_STATUS_HANDLE_CREATED | WINHTTP_CALLBACK_STATUS_HANDLE_CLOSING) WINHTTP_CALLBACK_FLAG_DETECTING_PROXY = WINHTTP_CALLBACK_STATUS_DETECTING_PROXY WINHTTP_CALLBACK_FLAG_REDIRECT = WINHTTP_CALLBACK_STATUS_REDIRECT @@ -907,12 +911,12 @@ WINHTTP_CALLBACK_FLAG_DATA_AVAILABLE = WINHTTP_CALLBACK_STATUS_DATA_AVAILABLE WINHTTP_CALLBACK_FLAG_READ_COMPLETE = WINHTTP_CALLBACK_STATUS_READ_COMPLETE WINHTTP_CALLBACK_FLAG_WRITE_COMPLETE = WINHTTP_CALLBACK_STATUS_WRITE_COMPLETE WINHTTP_CALLBACK_FLAG_REQUEST_ERROR = WINHTTP_CALLBACK_STATUS_REQUEST_ERROR -WINHTTP_CALLBACK_FLAG_ALL_COMPLETIONS = (WINHTTP_CALLBACK_STATUS_SENDREQUEST_COMPLETE \ - | WINHTTP_CALLBACK_STATUS_HEADERS_AVAILABLE \ - | WINHTTP_CALLBACK_STATUS_DATA_AVAILABLE \ - | WINHTTP_CALLBACK_STATUS_READ_COMPLETE \ - | WINHTTP_CALLBACK_STATUS_WRITE_COMPLETE \ - | WINHTTP_CALLBACK_STATUS_REQUEST_ERROR) +WINHTTP_CALLBACK_FLAG_ALL_COMPLETIONS = (WINHTTP_CALLBACK_STATUS_SENDREQUEST_COMPLETE + | WINHTTP_CALLBACK_STATUS_HEADERS_AVAILABLE + | WINHTTP_CALLBACK_STATUS_DATA_AVAILABLE + | WINHTTP_CALLBACK_STATUS_READ_COMPLETE + | WINHTTP_CALLBACK_STATUS_WRITE_COMPLETE + | WINHTTP_CALLBACK_STATUS_REQUEST_ERROR) WINHTTP_CALLBACK_FLAG_ALL_NOTIFICATIONS = (-1) WINHTTP_QUERY_MIME_VERSION = 0 WINHTTP_QUERY_CONTENT_TYPE = 1 diff --git a/typings/win32helper/win32netcon.pyi b/typings/win32helper/win32netcon.pyi index 73795969..c3fe218e 100644 --- a/typings/win32helper/win32netcon.pyi +++ b/typings/win32helper/win32netcon.pyi @@ -5,12 +5,12 @@ CNLEN = 15 LM20_CNLEN = 15 DNLEN = CNLEN LM20_DNLEN = LM20_CNLEN -UNCLEN = (CNLEN+2) -LM20_UNCLEN = (LM20_CNLEN+2) +UNCLEN = (CNLEN + 2) +LM20_UNCLEN = (LM20_CNLEN + 2) NNLEN = 80 LM20_NNLEN = 12 -RMLEN = (UNCLEN+1+NNLEN) -LM20_RMLEN = (LM20_UNCLEN+1+LM20_NNLEN) +RMLEN = (UNCLEN + 1 + NNLEN) +LM20_RMLEN = (LM20_UNCLEN + 1 + LM20_NNLEN) SNLEN = 80 LM20_SNLEN = 15 STXTLEN = 256 @@ -60,29 +60,29 @@ UF_NORMAL_ACCOUNT = 512 UF_INTERDOMAIN_TRUST_ACCOUNT = 2048 UF_WORKSTATION_TRUST_ACCOUNT = 4096 UF_SERVER_TRUST_ACCOUNT = 8192 -UF_MACHINE_ACCOUNT_MASK = ( UF_INTERDOMAIN_TRUST_ACCOUNT | \ - UF_WORKSTATION_TRUST_ACCOUNT | \ - UF_SERVER_TRUST_ACCOUNT ) -UF_ACCOUNT_TYPE_MASK = ( \ - UF_TEMP_DUPLICATE_ACCOUNT | \ - UF_NORMAL_ACCOUNT | \ - UF_INTERDOMAIN_TRUST_ACCOUNT | \ - UF_WORKSTATION_TRUST_ACCOUNT | \ - UF_SERVER_TRUST_ACCOUNT \ - ) +UF_MACHINE_ACCOUNT_MASK = (UF_INTERDOMAIN_TRUST_ACCOUNT + | UF_WORKSTATION_TRUST_ACCOUNT + | UF_SERVER_TRUST_ACCOUNT) +UF_ACCOUNT_TYPE_MASK = ( + UF_TEMP_DUPLICATE_ACCOUNT + | UF_NORMAL_ACCOUNT + | UF_INTERDOMAIN_TRUST_ACCOUNT + | UF_WORKSTATION_TRUST_ACCOUNT + | UF_SERVER_TRUST_ACCOUNT +) UF_DONT_EXPIRE_PASSWD = 65536 UF_MNS_LOGON_ACCOUNT = 131072 -UF_SETTABLE_BITS = ( \ - UF_SCRIPT | \ - UF_ACCOUNTDISABLE | \ - UF_LOCKOUT | \ - UF_HOMEDIR_REQUIRED | \ - UF_PASSWD_NOTREQD | \ - UF_PASSWD_CANT_CHANGE | \ - UF_ACCOUNT_TYPE_MASK | \ - UF_DONT_EXPIRE_PASSWD | \ - UF_MNS_LOGON_ACCOUNT \ - ) +UF_SETTABLE_BITS = ( + UF_SCRIPT + | UF_ACCOUNTDISABLE + | UF_LOCKOUT + | UF_HOMEDIR_REQUIRED + | UF_PASSWD_NOTREQD + | UF_PASSWD_CANT_CHANGE + | UF_ACCOUNT_TYPE_MASK + | UF_DONT_EXPIRE_PASSWD + | UF_MNS_LOGON_ACCOUNT +) FILTER_TEMP_DUPLICATE_ACCOUNT = (1) FILTER_NORMAL_ACCOUNT = (2) FILTER_INTERDOMAIN_TRUST_ACCOUNT = (8) @@ -93,8 +93,8 @@ AF_OP_PRINT = 1 AF_OP_COMM = 2 AF_OP_SERVER = 4 AF_OP_ACCOUNTS = 8 -AF_SETTABLE_BITS = (AF_OP_PRINT | AF_OP_COMM | \ - AF_OP_SERVER | AF_OP_ACCOUNTS) +AF_SETTABLE_BITS = (AF_OP_PRINT | AF_OP_COMM + | AF_OP_SERVER | AF_OP_ACCOUNTS) UAS_ROLE_STANDALONE = 0 UAS_ROLE_MEMBER = 1 UAS_ROLE_BACKUP = 2 @@ -128,57 +128,57 @@ USER_PROFILE = 52 USER_PROFILE_PARMNUM = 52 USER_HOME_DIR_DRIVE_PARMNUM = 53 USER_NAME_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_NAME_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + USER_NAME_PARMNUM) USER_PASSWORD_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_PASSWORD_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + USER_PASSWORD_PARMNUM) USER_PASSWORD_AGE_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_PASSWORD_AGE_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + USER_PASSWORD_AGE_PARMNUM) USER_PRIV_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_PRIV_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + USER_PRIV_PARMNUM) USER_HOME_DIR_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_HOME_DIR_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + USER_HOME_DIR_PARMNUM) USER_COMMENT_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_COMMENT_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + USER_COMMENT_PARMNUM) USER_FLAGS_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_FLAGS_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + USER_FLAGS_PARMNUM) USER_SCRIPT_PATH_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_SCRIPT_PATH_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + USER_SCRIPT_PATH_PARMNUM) USER_AUTH_FLAGS_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_AUTH_FLAGS_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + USER_AUTH_FLAGS_PARMNUM) USER_FULL_NAME_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_FULL_NAME_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + USER_FULL_NAME_PARMNUM) USER_USR_COMMENT_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_USR_COMMENT_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + USER_USR_COMMENT_PARMNUM) USER_PARMS_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_PARMS_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + USER_PARMS_PARMNUM) USER_WORKSTATIONS_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_WORKSTATIONS_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + USER_WORKSTATIONS_PARMNUM) USER_LAST_LOGON_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_LAST_LOGON_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + USER_LAST_LOGON_PARMNUM) USER_LAST_LOGOFF_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_LAST_LOGOFF_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + USER_LAST_LOGOFF_PARMNUM) USER_ACCT_EXPIRES_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_ACCT_EXPIRES_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + USER_ACCT_EXPIRES_PARMNUM) USER_MAX_STORAGE_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_MAX_STORAGE_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + USER_MAX_STORAGE_PARMNUM) USER_UNITS_PER_WEEK_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_UNITS_PER_WEEK_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + USER_UNITS_PER_WEEK_PARMNUM) USER_LOGON_HOURS_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_LOGON_HOURS_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + USER_LOGON_HOURS_PARMNUM) USER_PAD_PW_COUNT_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_PAD_PW_COUNT_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + USER_PAD_PW_COUNT_PARMNUM) USER_NUM_LOGONS_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_NUM_LOGONS_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + USER_NUM_LOGONS_PARMNUM) USER_LOGON_SERVER_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_LOGON_SERVER_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + USER_LOGON_SERVER_PARMNUM) USER_COUNTRY_CODE_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_COUNTRY_CODE_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + USER_COUNTRY_CODE_PARMNUM) USER_CODE_PAGE_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_CODE_PAGE_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + USER_CODE_PAGE_PARMNUM) USER_PRIMARY_GROUP_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_PRIMARY_GROUP_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + USER_PRIMARY_GROUP_PARMNUM) USER_HOME_DIR_DRIVE_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_HOME_DIR_DRIVE_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + USER_HOME_DIR_DRIVE_PARMNUM) NULL_USERSETINFO_PASSWD = " " UNITS_PER_DAY = 24 UNITS_PER_WEEK = UNITS_PER_DAY * 7 @@ -208,36 +208,36 @@ MODALS_LOCKOUT_DURATION_PARMNUM = 10 MODALS_LOCKOUT_OBSERVATION_WINDOW_PARMNUM = 11 MODALS_LOCKOUT_THRESHOLD_PARMNUM = 12 MODALS_MIN_PASSWD_LEN_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_MIN_PASSWD_LEN_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + MODALS_MIN_PASSWD_LEN_PARMNUM) MODALS_MAX_PASSWD_AGE_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_MAX_PASSWD_AGE_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + MODALS_MAX_PASSWD_AGE_PARMNUM) MODALS_MIN_PASSWD_AGE_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_MIN_PASSWD_AGE_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + MODALS_MIN_PASSWD_AGE_PARMNUM) MODALS_FORCE_LOGOFF_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_FORCE_LOGOFF_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + MODALS_FORCE_LOGOFF_PARMNUM) MODALS_PASSWD_HIST_LEN_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_PASSWD_HIST_LEN_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + MODALS_PASSWD_HIST_LEN_PARMNUM) MODALS_ROLE_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_ROLE_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + MODALS_ROLE_PARMNUM) MODALS_PRIMARY_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_PRIMARY_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + MODALS_PRIMARY_PARMNUM) MODALS_DOMAIN_NAME_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_DOMAIN_NAME_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + MODALS_DOMAIN_NAME_PARMNUM) MODALS_DOMAIN_ID_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_DOMAIN_ID_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + MODALS_DOMAIN_ID_PARMNUM) GROUPIDMASK = 32768 GROUP_ALL_PARMNUM = 0 GROUP_NAME_PARMNUM = 1 GROUP_COMMENT_PARMNUM = 2 GROUP_ATTRIBUTES_PARMNUM = 3 GROUP_ALL_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + GROUP_ALL_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + GROUP_ALL_PARMNUM) GROUP_NAME_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + GROUP_NAME_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + GROUP_NAME_PARMNUM) GROUP_COMMENT_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + GROUP_COMMENT_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + GROUP_COMMENT_PARMNUM) GROUP_ATTRIBUTES_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + GROUP_ATTRIBUTES_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + GROUP_ATTRIBUTES_PARMNUM) LOCALGROUP_NAME_PARMNUM = 1 LOCALGROUP_COMMENT_PARMNUM = 2 MAXPERMENTRIES = 64 @@ -267,13 +267,13 @@ ACCESS_ATTR_PARMNUM = 2 ACCESS_COUNT_PARMNUM = 3 ACCESS_ACCESS_LIST_PARMNUM = 4 ACCESS_RESOURCE_NAME_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + ACCESS_RESOURCE_NAME_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + ACCESS_RESOURCE_NAME_PARMNUM) ACCESS_ATTR_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + ACCESS_ATTR_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + ACCESS_ATTR_PARMNUM) ACCESS_COUNT_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + ACCESS_COUNT_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + ACCESS_COUNT_PARMNUM) ACCESS_ACCESS_LIST_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + ACCESS_ACCESS_LIST_PARMNUM) + (PARMNUM_BASE_INFOLEVEL + ACCESS_ACCESS_LIST_PARMNUM) ACCESS_LETTERS = "RWCXDAP " NETLOGON_CONTROL_QUERY = 1 NETLOGON_CONTROL_REPLICATE = 2 @@ -296,7 +296,10 @@ NETLOGON_REDO_NEEDED = 8 ###################### # Manual stuff -TEXT=lambda x:x + +def TEXT(x): + ... + MAX_PREFERRED_LENGTH = -1 PARM_ERROR_UNKNOWN = -1 @@ -310,12 +313,12 @@ USER_NO_LOGOFF = -1 DEF_MAX_PWAGE = TIMEQ_FOREVER DEF_MIN_PWAGE = 0 DEF_FORCE_LOGOFF = -1 -ONE_DAY = 1*24*3600 +ONE_DAY = 1 * 24 * 3600 GROUP_SPECIALGRP_USERS = "USERS" GROUP_SPECIALGRP_ADMINS = "ADMINS" GROUP_SPECIALGRP_GUESTS = "GUESTS" GROUP_SPECIALGRP_LOCAL = "LOCAL" -ACCESS_ALL = ( ACCESS_READ | ACCESS_WRITE | ACCESS_CREATE | ACCESS_EXEC | ACCESS_DELETE | ACCESS_ATRIB | ACCESS_PERM ) +ACCESS_ALL = (ACCESS_READ | ACCESS_WRITE | ACCESS_CREATE | ACCESS_EXEC | ACCESS_DELETE | ACCESS_ATRIB | ACCESS_PERM) # From lmserver.h SV_PLATFORM_ID_OS2 = 400 @@ -522,12 +525,12 @@ CSC_CACHEABLE = 16 CSC_NOFLOWOPS = 32 CSC_AUTO_INWARD = 64 CSC_AUTO_OUTWARD = 128 -SHI1005_VALID_FLAGS_SET = ( CSC_CACHEABLE | \ - CSC_NOFLOWOPS | \ - CSC_AUTO_INWARD | \ - CSC_AUTO_OUTWARD| \ - COW_PERMACHINE | \ - COW_PERUSER ) +SHI1005_VALID_FLAGS_SET = (CSC_CACHEABLE + | CSC_NOFLOWOPS + | CSC_AUTO_INWARD + | CSC_AUTO_OUTWARD + | COW_PERMACHINE + | COW_PERUSER) SHI1007_VALID_FLAGS_SET = SHI1005_VALID_FLAGS_SET SESS_GUEST = 1 SESS_NOENCRYPTION = 2 @@ -636,7 +639,7 @@ WNCON_NOTROUTED = 2 WNCON_SLOWLINK = 4 WNCON_DYNAMIC = 8 -## NETSETUP_NAME_TYPE, used with NetValidateName +# NETSETUP_NAME_TYPE, used with NetValidateName NetSetupUnknown = 0 NetSetupMachine = 1 NetSetupWorkgroup = 2 @@ -644,7 +647,7 @@ NetSetupDomain = 3 NetSetupNonExistentDomain = 4 NetSetupDnsMachine = 5 -## NETSETUP_JOIN_STATUS, use with NetGetJoinInformation +# NETSETUP_JOIN_STATUS, use with NetGetJoinInformation NetSetupUnknownStatus = 0 NetSetupUnjoined = 1 NetSetupWorkgroupName = 2 diff --git a/typings/win32helper/winioctlcon.pyi b/typings/win32helper/winioctlcon.pyi index 673ea4e5..0caf7167 100644 --- a/typings/win32helper/winioctlcon.pyi +++ b/typings/win32helper/winioctlcon.pyi @@ -1,12 +1,16 @@ -## flags, enums, guids used with DeviceIoControl from WinIoCtl.h +# flags, enums, guids used with DeviceIoControl from WinIoCtl.h import pywintypes -from ntsecuritycon import FILE_READ_DATA,FILE_WRITE_DATA +from ntsecuritycon import FILE_READ_DATA, FILE_WRITE_DATA + + def CTL_CODE(DeviceType, Function, Method, Access): - return (DeviceType << 16) | (Access << 14) | (Function << 2) | Method + ... + + +def DEVICE_TYPE_FROM_CTL_CODE(ctrlCode) -> int: + ... -def DEVICE_TYPE_FROM_CTL_CODE(ctrlCode): - return (ctrlCode & 0xffff0000) >> 16 FILE_DEVICE_BEEP = 0x00000001 FILE_DEVICE_CD_ROM = 0x00000002 @@ -360,7 +364,11 @@ IOCTL_STORAGE_GET_MEDIA_TYPES = CTL_CODE(IOCTL_STORAGE_BASE, 0x0300, METHOD_BUFF IOCTL_STORAGE_GET_MEDIA_TYPES_EX = CTL_CODE(IOCTL_STORAGE_BASE, 0x0301, METHOD_BUFFERED, FILE_ANY_ACCESS) IOCTL_STORAGE_GET_MEDIA_SERIAL_NUMBER = CTL_CODE(IOCTL_STORAGE_BASE, 0x0304, METHOD_BUFFERED, FILE_ANY_ACCESS) IOCTL_STORAGE_GET_HOTPLUG_INFO = CTL_CODE(IOCTL_STORAGE_BASE, 0x0305, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_STORAGE_SET_HOTPLUG_INFO = CTL_CODE(IOCTL_STORAGE_BASE, 0x0306, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +IOCTL_STORAGE_SET_HOTPLUG_INFO = CTL_CODE( + IOCTL_STORAGE_BASE, + 0x0306, + METHOD_BUFFERED, + FILE_READ_ACCESS | FILE_WRITE_ACCESS) IOCTL_STORAGE_RESET_BUS = CTL_CODE(IOCTL_STORAGE_BASE, 0x0400, METHOD_BUFFERED, FILE_READ_ACCESS) IOCTL_STORAGE_RESET_DEVICE = CTL_CODE(IOCTL_STORAGE_BASE, 0x0401, METHOD_BUFFERED, FILE_READ_ACCESS) IOCTL_STORAGE_BREAK_RESERVATION = CTL_CODE(IOCTL_STORAGE_BASE, 0x0405, METHOD_BUFFERED, FILE_READ_ACCESS) @@ -389,9 +397,17 @@ SMART_GET_VERSION = CTL_CODE(IOCTL_DISK_BASE, 0x0020, METHOD_BUFFERED, FILE_READ SMART_SEND_DRIVE_COMMAND = CTL_CODE(IOCTL_DISK_BASE, 0x0021, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) SMART_RCV_DRIVE_DATA = CTL_CODE(IOCTL_DISK_BASE, 0x0022, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) IOCTL_DISK_GET_PARTITION_INFO_EX = CTL_CODE(IOCTL_DISK_BASE, 0x0012, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_SET_PARTITION_INFO_EX = CTL_CODE(IOCTL_DISK_BASE, 0x0013, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +IOCTL_DISK_SET_PARTITION_INFO_EX = CTL_CODE( + IOCTL_DISK_BASE, + 0x0013, + METHOD_BUFFERED, + FILE_READ_ACCESS | FILE_WRITE_ACCESS) IOCTL_DISK_GET_DRIVE_LAYOUT_EX = CTL_CODE(IOCTL_DISK_BASE, 0x0014, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_SET_DRIVE_LAYOUT_EX = CTL_CODE(IOCTL_DISK_BASE, 0x0015, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +IOCTL_DISK_SET_DRIVE_LAYOUT_EX = CTL_CODE( + IOCTL_DISK_BASE, + 0x0015, + METHOD_BUFFERED, + FILE_READ_ACCESS | FILE_WRITE_ACCESS) IOCTL_DISK_CREATE_DISK = CTL_CODE(IOCTL_DISK_BASE, 0x0016, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) IOCTL_DISK_GET_LENGTH_INFO = CTL_CODE(IOCTL_DISK_BASE, 0x0017, METHOD_BUFFERED, FILE_READ_ACCESS) IOCTL_DISK_GET_DRIVE_GEOMETRY_EX = CTL_CODE(IOCTL_DISK_BASE, 0x0028, METHOD_BUFFERED, FILE_ANY_ACCESS) @@ -400,16 +416,32 @@ IOCTL_DISK_REASSIGN_BLOCKS_EX = CTL_CODE(IOCTL_DISK_BASE, 0x0029, METHOD_BUFFERE IOCTL_DISK_UPDATE_DRIVE_SIZE = CTL_CODE(IOCTL_DISK_BASE, 0x0032, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) IOCTL_DISK_GROW_PARTITION = CTL_CODE(IOCTL_DISK_BASE, 0x0034, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) IOCTL_DISK_GET_CACHE_INFORMATION = CTL_CODE(IOCTL_DISK_BASE, 0x0035, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_DISK_SET_CACHE_INFORMATION = CTL_CODE(IOCTL_DISK_BASE, 0x0036, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) - -OBSOLETE_IOCTL_STORAGE_RESET_BUS = CTL_CODE(IOCTL_STORAGE_BASE, 0x0400, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -OBSOLETE_IOCTL_STORAGE_RESET_DEVICE = CTL_CODE(IOCTL_STORAGE_BASE, 0x0401, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -## the original define no longer exists in winioctl.h +IOCTL_DISK_SET_CACHE_INFORMATION = CTL_CODE( + IOCTL_DISK_BASE, + 0x0036, + METHOD_BUFFERED, + FILE_READ_ACCESS | FILE_WRITE_ACCESS) + +OBSOLETE_IOCTL_STORAGE_RESET_BUS = CTL_CODE( + IOCTL_STORAGE_BASE, + 0x0400, + METHOD_BUFFERED, + FILE_READ_ACCESS | FILE_WRITE_ACCESS) +OBSOLETE_IOCTL_STORAGE_RESET_DEVICE = CTL_CODE( + IOCTL_STORAGE_BASE, + 0x0401, + METHOD_BUFFERED, + FILE_READ_ACCESS | FILE_WRITE_ACCESS) +# the original define no longer exists in winioctl.h OBSOLETE_DISK_GET_WRITE_CACHE_STATE = CTL_CODE(IOCTL_DISK_BASE, 0x0037, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_DISK_GET_WRITE_CACHE_STATE=OBSOLETE_DISK_GET_WRITE_CACHE_STATE +IOCTL_DISK_GET_WRITE_CACHE_STATE = OBSOLETE_DISK_GET_WRITE_CACHE_STATE -IOCTL_DISK_DELETE_DRIVE_LAYOUT = CTL_CODE(IOCTL_DISK_BASE, 0x0040, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +IOCTL_DISK_DELETE_DRIVE_LAYOUT = CTL_CODE( + IOCTL_DISK_BASE, + 0x0040, + METHOD_BUFFERED, + FILE_READ_ACCESS | FILE_WRITE_ACCESS) IOCTL_DISK_UPDATE_PROPERTIES = CTL_CODE(IOCTL_DISK_BASE, 0x0050, METHOD_BUFFERED, FILE_ANY_ACCESS) IOCTL_DISK_FORMAT_DRIVE = CTL_CODE(IOCTL_DISK_BASE, 0x00f3, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) IOCTL_DISK_SENSE_DEVICE = CTL_CODE(IOCTL_DISK_BASE, 0x00f8, METHOD_BUFFERED, FILE_ANY_ACCESS) @@ -429,23 +461,31 @@ IOCTL_CHANGER_GET_PARAMETERS = CTL_CODE(IOCTL_CHANGER_BASE, 0x0000, METHOD_BUFFE IOCTL_CHANGER_GET_STATUS = CTL_CODE(IOCTL_CHANGER_BASE, 0x0001, METHOD_BUFFERED, FILE_READ_ACCESS) IOCTL_CHANGER_GET_PRODUCT_DATA = CTL_CODE(IOCTL_CHANGER_BASE, 0x0002, METHOD_BUFFERED, FILE_READ_ACCESS) IOCTL_CHANGER_SET_ACCESS = CTL_CODE(IOCTL_CHANGER_BASE, 0x0004, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_CHANGER_GET_ELEMENT_STATUS = CTL_CODE(IOCTL_CHANGER_BASE, 0x0005, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) +IOCTL_CHANGER_GET_ELEMENT_STATUS = CTL_CODE( + IOCTL_CHANGER_BASE, + 0x0005, + METHOD_BUFFERED, + FILE_READ_ACCESS | FILE_WRITE_ACCESS) IOCTL_CHANGER_INITIALIZE_ELEMENT_STATUS = CTL_CODE(IOCTL_CHANGER_BASE, 0x0006, METHOD_BUFFERED, FILE_READ_ACCESS) IOCTL_CHANGER_SET_POSITION = CTL_CODE(IOCTL_CHANGER_BASE, 0x0007, METHOD_BUFFERED, FILE_READ_ACCESS) IOCTL_CHANGER_EXCHANGE_MEDIUM = CTL_CODE(IOCTL_CHANGER_BASE, 0x0008, METHOD_BUFFERED, FILE_READ_ACCESS) IOCTL_CHANGER_MOVE_MEDIUM = CTL_CODE(IOCTL_CHANGER_BASE, 0x0009, METHOD_BUFFERED, FILE_READ_ACCESS) IOCTL_CHANGER_REINITIALIZE_TRANSPORT = CTL_CODE(IOCTL_CHANGER_BASE, 0x000A, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_CHANGER_QUERY_VOLUME_TAGS = CTL_CODE(IOCTL_CHANGER_BASE, 0x000B, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_SERIAL_LSRMST_INSERT = CTL_CODE(FILE_DEVICE_SERIAL_PORT,31,METHOD_BUFFERED,FILE_ANY_ACCESS) -IOCTL_SERENUM_EXPOSE_HARDWARE = CTL_CODE(FILE_DEVICE_SERENUM,128,METHOD_BUFFERED,FILE_ANY_ACCESS) -IOCTL_SERENUM_REMOVE_HARDWARE = CTL_CODE(FILE_DEVICE_SERENUM,129,METHOD_BUFFERED,FILE_ANY_ACCESS) -IOCTL_SERENUM_PORT_DESC = CTL_CODE(FILE_DEVICE_SERENUM,130,METHOD_BUFFERED,FILE_ANY_ACCESS) -IOCTL_SERENUM_GET_PORT_NAME = CTL_CODE(FILE_DEVICE_SERENUM,131,METHOD_BUFFERED,FILE_ANY_ACCESS) - -## ??? can't find where FILE_DEVICE_AVIO is defined ??? -## IOCTL_AVIO_ALLOCATE_STREAM = CTL_CODE(FILE_DEVICE_AVIO, 1, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -## IOCTL_AVIO_FREE_STREAM = CTL_CODE(FILE_DEVICE_AVIO, 2, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -## IOCTL_AVIO_MODIFY_STREAM = CTL_CODE(FILE_DEVICE_AVIO, 3, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) +IOCTL_CHANGER_QUERY_VOLUME_TAGS = CTL_CODE( + IOCTL_CHANGER_BASE, + 0x000B, + METHOD_BUFFERED, + FILE_READ_ACCESS | FILE_WRITE_ACCESS) +IOCTL_SERIAL_LSRMST_INSERT = CTL_CODE(FILE_DEVICE_SERIAL_PORT, 31, METHOD_BUFFERED, FILE_ANY_ACCESS) +IOCTL_SERENUM_EXPOSE_HARDWARE = CTL_CODE(FILE_DEVICE_SERENUM, 128, METHOD_BUFFERED, FILE_ANY_ACCESS) +IOCTL_SERENUM_REMOVE_HARDWARE = CTL_CODE(FILE_DEVICE_SERENUM, 129, METHOD_BUFFERED, FILE_ANY_ACCESS) +IOCTL_SERENUM_PORT_DESC = CTL_CODE(FILE_DEVICE_SERENUM, 130, METHOD_BUFFERED, FILE_ANY_ACCESS) +IOCTL_SERENUM_GET_PORT_NAME = CTL_CODE(FILE_DEVICE_SERENUM, 131, METHOD_BUFFERED, FILE_ANY_ACCESS) + +# ??? can't find where FILE_DEVICE_AVIO is defined ??? +# IOCTL_AVIO_ALLOCATE_STREAM = CTL_CODE(FILE_DEVICE_AVIO, 1, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) +# IOCTL_AVIO_FREE_STREAM = CTL_CODE(FILE_DEVICE_AVIO, 2, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) +# IOCTL_AVIO_MODIFY_STREAM = CTL_CODE(FILE_DEVICE_AVIO, 3, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) SERIAL_LSRMST_ESCAPE = 0x00 SERIAL_LSRMST_LSR_DATA = 0x01 @@ -464,22 +504,22 @@ SERIAL_IOC_MCR_RTS = 0x00000002 SERIAL_IOC_MCR_OUT1 = 0x00000004 SERIAL_IOC_MCR_OUT2 = 0x00000008 SERIAL_IOC_MCR_LOOP = 0x00000010 -FSCTL_REQUEST_OPLOCK_LEVEL_1 = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 0, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_REQUEST_OPLOCK_LEVEL_2 = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 1, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_REQUEST_BATCH_OPLOCK = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 2, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_OPLOCK_BREAK_ACKNOWLEDGE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 3, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_OPBATCH_ACK_CLOSE_PENDING = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 4, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_OPLOCK_BREAK_NOTIFY = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 5, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_LOCK_VOLUME = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 6, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_UNLOCK_VOLUME = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 7, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_DISMOUNT_VOLUME = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 8, METHOD_BUFFERED, FILE_ANY_ACCESS) +FSCTL_REQUEST_OPLOCK_LEVEL_1 = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 0, METHOD_BUFFERED, FILE_ANY_ACCESS) +FSCTL_REQUEST_OPLOCK_LEVEL_2 = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 1, METHOD_BUFFERED, FILE_ANY_ACCESS) +FSCTL_REQUEST_BATCH_OPLOCK = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 2, METHOD_BUFFERED, FILE_ANY_ACCESS) +FSCTL_OPLOCK_BREAK_ACKNOWLEDGE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 3, METHOD_BUFFERED, FILE_ANY_ACCESS) +FSCTL_OPBATCH_ACK_CLOSE_PENDING = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 4, METHOD_BUFFERED, FILE_ANY_ACCESS) +FSCTL_OPLOCK_BREAK_NOTIFY = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 5, METHOD_BUFFERED, FILE_ANY_ACCESS) +FSCTL_LOCK_VOLUME = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 6, METHOD_BUFFERED, FILE_ANY_ACCESS) +FSCTL_UNLOCK_VOLUME = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 7, METHOD_BUFFERED, FILE_ANY_ACCESS) +FSCTL_DISMOUNT_VOLUME = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 8, METHOD_BUFFERED, FILE_ANY_ACCESS) FSCTL_IS_VOLUME_MOUNTED = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 10, METHOD_BUFFERED, FILE_ANY_ACCESS) FSCTL_IS_PATHNAME_VALID = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 11, METHOD_BUFFERED, FILE_ANY_ACCESS) FSCTL_MARK_VOLUME_DIRTY = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 12, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_QUERY_RETRIEVAL_POINTERS = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 14, METHOD_NEITHER, FILE_ANY_ACCESS) +FSCTL_QUERY_RETRIEVAL_POINTERS = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 14, METHOD_NEITHER, FILE_ANY_ACCESS) FSCTL_GET_COMPRESSION = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 15, METHOD_BUFFERED, FILE_ANY_ACCESS) FSCTL_SET_COMPRESSION = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 16, METHOD_BUFFERED, FILE_READ_DATA | FILE_WRITE_DATA) -FSCTL_MARK_AS_SYSTEM_HIVE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 19, METHOD_NEITHER, FILE_ANY_ACCESS) +FSCTL_MARK_AS_SYSTEM_HIVE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 19, METHOD_NEITHER, FILE_ANY_ACCESS) FSCTL_OPLOCK_BREAK_ACK_NO_2 = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 20, METHOD_BUFFERED, FILE_ANY_ACCESS) FSCTL_INVALIDATE_VOLUMES = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 21, METHOD_BUFFERED, FILE_ANY_ACCESS) FSCTL_QUERY_FAT_BPB = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 22, METHOD_BUFFERED, FILE_ANY_ACCESS) @@ -487,11 +527,11 @@ FSCTL_REQUEST_FILTER_OPLOCK = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 23, METHOD_BUFFE FSCTL_FILESYSTEM_GET_STATISTICS = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 24, METHOD_BUFFERED, FILE_ANY_ACCESS) FSCTL_GET_NTFS_VOLUME_DATA = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 25, METHOD_BUFFERED, FILE_ANY_ACCESS) FSCTL_GET_NTFS_FILE_RECORD = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 26, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_GET_VOLUME_BITMAP = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 27, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_GET_RETRIEVAL_POINTERS = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 28, METHOD_NEITHER, FILE_ANY_ACCESS) +FSCTL_GET_VOLUME_BITMAP = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 27, METHOD_NEITHER, FILE_ANY_ACCESS) +FSCTL_GET_RETRIEVAL_POINTERS = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 28, METHOD_NEITHER, FILE_ANY_ACCESS) FSCTL_MOVE_FILE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 29, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) FSCTL_IS_VOLUME_DIRTY = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 30, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_ALLOW_EXTENDED_DASD_IO = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 32, METHOD_NEITHER, FILE_ANY_ACCESS) +FSCTL_ALLOW_EXTENDED_DASD_IO = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 32, METHOD_NEITHER, FILE_ANY_ACCESS) FSCTL_FIND_FILES_BY_SID = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 35, METHOD_NEITHER, FILE_ANY_ACCESS) FSCTL_SET_OBJECT_ID = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 38, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) FSCTL_GET_OBJECT_ID = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 39, METHOD_BUFFERED, FILE_ANY_ACCESS) @@ -499,21 +539,21 @@ FSCTL_DELETE_OBJECT_ID = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 40, METHOD_BUFFERED, FSCTL_SET_REPARSE_POINT = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 41, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) FSCTL_GET_REPARSE_POINT = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 42, METHOD_BUFFERED, FILE_ANY_ACCESS) FSCTL_DELETE_REPARSE_POINT = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 43, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -FSCTL_ENUM_USN_DATA = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 44, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_SECURITY_ID_CHECK = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 45, METHOD_NEITHER, FILE_READ_DATA) -FSCTL_READ_USN_JOURNAL = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 46, METHOD_NEITHER, FILE_ANY_ACCESS) +FSCTL_ENUM_USN_DATA = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 44, METHOD_NEITHER, FILE_ANY_ACCESS) +FSCTL_SECURITY_ID_CHECK = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 45, METHOD_NEITHER, FILE_READ_DATA) +FSCTL_READ_USN_JOURNAL = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 46, METHOD_NEITHER, FILE_ANY_ACCESS) FSCTL_SET_OBJECT_ID_EXTENDED = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 47, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) FSCTL_CREATE_OR_GET_OBJECT_ID = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 48, METHOD_BUFFERED, FILE_ANY_ACCESS) FSCTL_SET_SPARSE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 49, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) FSCTL_SET_ZERO_DATA = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 50, METHOD_BUFFERED, FILE_WRITE_DATA) -FSCTL_QUERY_ALLOCATED_RANGES = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 51, METHOD_NEITHER, FILE_READ_DATA) -FSCTL_SET_ENCRYPTION = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 53, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_ENCRYPTION_FSCTL_IO = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 54, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_WRITE_RAW_ENCRYPTED = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 55, METHOD_NEITHER, FILE_SPECIAL_ACCESS) -FSCTL_READ_RAW_ENCRYPTED = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 56, METHOD_NEITHER, FILE_SPECIAL_ACCESS) -FSCTL_CREATE_USN_JOURNAL = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 57, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_READ_FILE_USN_DATA = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 58, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_WRITE_USN_CLOSE_RECORD = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 59, METHOD_NEITHER, FILE_ANY_ACCESS) +FSCTL_QUERY_ALLOCATED_RANGES = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 51, METHOD_NEITHER, FILE_READ_DATA) +FSCTL_SET_ENCRYPTION = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 53, METHOD_NEITHER, FILE_ANY_ACCESS) +FSCTL_ENCRYPTION_FSCTL_IO = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 54, METHOD_NEITHER, FILE_ANY_ACCESS) +FSCTL_WRITE_RAW_ENCRYPTED = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 55, METHOD_NEITHER, FILE_SPECIAL_ACCESS) +FSCTL_READ_RAW_ENCRYPTED = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 56, METHOD_NEITHER, FILE_SPECIAL_ACCESS) +FSCTL_CREATE_USN_JOURNAL = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 57, METHOD_NEITHER, FILE_ANY_ACCESS) +FSCTL_READ_FILE_USN_DATA = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 58, METHOD_NEITHER, FILE_ANY_ACCESS) +FSCTL_WRITE_USN_CLOSE_RECORD = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 59, METHOD_NEITHER, FILE_ANY_ACCESS) FSCTL_EXTEND_VOLUME = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 60, METHOD_BUFFERED, FILE_ANY_ACCESS) FSCTL_QUERY_USN_JOURNAL = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 61, METHOD_BUFFERED, FILE_ANY_ACCESS) FSCTL_DELETE_USN_JOURNAL = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 62, METHOD_BUFFERED, FILE_ANY_ACCESS) @@ -556,15 +596,15 @@ FSCTL_TXFS_LIST_TRANSACTION_LOCKED_FILES = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 120 FSCTL_TXFS_LIST_TRANSACTIONS = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 121, METHOD_BUFFERED, FILE_READ_DATA) FSCTL_QUERY_PAGEFILE_ENCRYPTION = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 122, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_VOLUME_BASE = ord('V') +IOCTL_VOLUME_BASE = ord('V') IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS = CTL_CODE(IOCTL_VOLUME_BASE, 0, METHOD_BUFFERED, FILE_ANY_ACCESS) IOCTL_VOLUME_ONLINE = CTL_CODE(IOCTL_VOLUME_BASE, 2, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) IOCTL_VOLUME_OFFLINE = CTL_CODE(IOCTL_VOLUME_BASE, 3, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) IOCTL_VOLUME_IS_CLUSTERED = CTL_CODE(IOCTL_VOLUME_BASE, 12, METHOD_BUFFERED, FILE_ANY_ACCESS) IOCTL_VOLUME_GET_GPT_ATTRIBUTES = CTL_CODE(IOCTL_VOLUME_BASE, 14, METHOD_BUFFERED, FILE_ANY_ACCESS) -## enums -## STORAGE_MEDIA_TYPE +# enums +# STORAGE_MEDIA_TYPE DDS_4mm = 32 MiniQic = 33 Travan = 34 @@ -627,7 +667,7 @@ ADR_1 = 90 ADR_2 = 91 STK_9940 = 92 -## STORAGE_BUS_TYPE +# STORAGE_BUS_TYPE BusTypeUnknown = 0 BusTypeScsi = 1 BusTypeAtapi = 2 @@ -642,7 +682,7 @@ BusTypeSas = 10 BusTypeSata = 11 BusTypeMaxReserved = 127 -## MEDIA_TYPE +# MEDIA_TYPE Unknown = 0 F5_1Pt2_512 = 1 F3_1Pt44_512 = 2 @@ -670,31 +710,31 @@ F3_200Mb_512 = 23 F3_240M_512 = 24 F3_32M_512 = 25 -## PARTITION_STYLE +# PARTITION_STYLE PARTITION_STYLE_MBR = 0 PARTITION_STYLE_GPT = 1 PARTITION_STYLE_RAW = 2 -## DETECTION_TYPE +# DETECTION_TYPE DetectNone = 0 DetectInt13 = 1 DetectExInt13 = 2 -## DISK_CACHE_RETENTION_PRIORITY +# DISK_CACHE_RETENTION_PRIORITY EqualPriority = 0 KeepPrefetchedData = 1 KeepReadData = 2 -## DISK_WRITE_CACHE_STATE - ?????? this enum has disappeared from winioctl.h in windows 2003 SP1 sdk ?????? +# DISK_WRITE_CACHE_STATE - ?????? this enum has disappeared from winioctl.h in windows 2003 SP1 sdk ?????? DiskWriteCacheNormal = 0 DiskWriteCacheForceDisable = 1 DiskWriteCacheDisableNotSupported = 2 -## BIN_TYPES +# BIN_TYPES RequestSize = 0 RequestLocation = 1 -## CHANGER_DEVICE_PROBLEM_TYPE +# CHANGER_DEVICE_PROBLEM_TYPE DeviceProblemNone = 0 DeviceProblemHardware = 1 DeviceProblemCHMError = 2 diff --git a/typings/win32typing/__init__.pyi b/typings/win32typing/__init__.pyi deleted file mode 100644 index f11a35e4..00000000 --- a/typings/win32typing/__init__.pyi +++ /dev/null @@ -1,51704 +0,0 @@ -""" -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 - -class COMMTIMEOUTS(object): - """A tuple representing a COMMTIMEOUTS structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class CopyProgressRoutine(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class DOCINFO(object): - """A tuple of information representing a DOCINFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def DocName(self)->'typing.Union[str]': - """Name of document""" - pass - - - @property - def Output(self)->'typing.Union[str]': - """Name of output file when printing to file. Use None for normal printing.""" - pass - - - @property - def DataType(self)->'typing.Union[str]': - """Type of data to be sent to printer, eg RAW, EMF, TEXT. Use None for printer default.""" - pass - - - @property - def Type(self)->'typing.Any': - """Flag specifying mode of operation. Can be DI_APPBANDING, DI_ROPS_READ_DESTINATION, or 0""" - pass - - -class ExportCallback(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class FORM_INFO_1(object): - """A dictionary containing FORM_INFO_1W data""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Flags(self)->'typing.Any': - """FORM_USER, FORM_BUILTIN, or FORM_PRINTER""" - pass - - - @property - def Name(self)->'str': - """Name of form""" - pass - - - @property - def Size(self)->'typing.Any': - """A dictionary representing a SIZEL structure {'cx':int,'cy':int}""" - pass - - - @property - def ImageableArea(self)->'typing.Any': - """A dictionary representing a RECTL structure {'left':int, 'top':int, 'right':int, 'bottom':int}""" - pass - - -class ImportCallback(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class LARGE_INTEGER(object): - """A Python object used wherever a COM LARGE_INTEGER is used.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class NCB(object): - """A Python object that encapsulates a Win32 NCB structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Command(self)->'typing.Any': - """""" - pass - - - @property - def Retcode(self)->'typing.Any': - """""" - pass - - - @property - def Lsn(self)->'typing.Any': - """""" - pass - - - @property - def Num(self)->'typing.Any': - """""" - pass - - - @property - def Bufflen(self)->'typing.Any': - """read-only""" - pass - - - @property - def Callname(self)->'str': - """- The strings need to be space padded to 16 chars exactly""" - pass - - - @property - def Name(self)->'str': - """- The strings need to be space padded to 16 chars exactly""" - pass - - - @property - def Rto(self)->'str': - """- The strings need to be space padded to 16 chars exactly""" - pass - - - @property - def Sto(self)->'str': - """- The strings need to be space padded to 16 chars exactly""" - pass - - - @property - def Lana_num(self)->'typing.Any': - """""" - pass - - - @property - def Cmd_cplt(self)->'typing.Any': - """""" - pass - - - @property - def Event(self)->'typing.Any': - """""" - pass - - - @property - def Post(self)->'typing.Any': - """""" - pass - - -class PRINTER_DEFAULTS(object): - """A dictionary representing a PRINTER_DEFAULTS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def pDatatype(self)->'str': - """Data type to be used for print jobs, see win32print::EnumPrintProcessorDatatypes, optional, can be None""" - pass - - - @property - def pDevMode(self)->'PyDEVMODE': - """A PyDEVMODE that specifies default printer parameters, optional, can be None""" - pass - - - @property - def DesiredAccess(self)->'typing.Any': - """An ACCESS_MASK specifying what level of access is needed, eg PRINTER_ACCESS_ADMINISTER, PRINTER_ACCESS_USE""" - pass - - -class PyACL(object): - """A Python object, representing a ACL structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,) -> 'None': - """ - Initialize the ACL. - -Args: - - - -Returns: - - None - - """ - pass - - - def IsValid(self,) -> 'None': - """ - Determines if the ACL is valid (IsValidAcl) - -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 - -specified SID. - -Args: - - revision(typing.Any):Pre-win2k, must be ACL_REVISION, otherwise also may be ACL_REVISION_DS. - access(typing.Any):Specifies the mask of access rights to be denied to the specified SID. - sid(PySID):A SID object representing a user, group, or logon account being denied access.Alternative Parameters - access1(typing.Any):Specifies the mask of access rights to be denied to the specified SID. - sid1(typing.Any):A SID object representing a user, group, or logon account being denied access.CommentsNote that early versions of this function supported only two arguments. This has been deprecated in preference of the three argument version, which reflects the win32 API and the new functions in this module. - -Returns: - - None - - """ - pass - - - def AddAccessAllowedAceEx(self,revision:'typing.Any',aceflags:'typing.Any',access:'typing.Any',sid:'PySID') -> 'None': - """ - Add access allowed ACE to an ACL with ACE flags (Requires Win2k or higher) - -Args: - - revision(typing.Any):Must be at least ACL_REVISION_DS - aceflags(typing.Any):Combination of ACE inheritance flags (CONTAINER_INHERIT_ACE,INHERIT_ONLY_ACE,INHERITED_ACE,NO_PROPAGATE_INHERIT_ACE, and OBJECT_INHERIT_ACE) - access(typing.Any):Specifies the mask of access rights to be granted to the specified SID. - sid(PySID):A SID object representing a user, group, or logon account being granted access. - -Returns: - - None - - """ - pass - - - def AddAccessAllowedObjectAce(self,AceRevision:'typing.Any',AceFlags:'typing.Any',AccessMask:'typing.Any',ObjectTypeGuid:'PyIID',InheritedObjectTypeGuid:'PyIID',sid:'PySID') -> 'None': - """ - Adds an ACCESS_ALLOWED_OBJECT_ACE to the ACL - -Args: - - AceRevision(typing.Any):Must be at least ACL_REVISION_DS - AceFlags(typing.Any):Combination of ACE inheritance flags (CONTAINER_INHERIT_ACE,INHERIT_ONLY_ACE,INHERITED_ACE,NO_PROPAGATE_INHERIT_ACE, and OBJECT_INHERIT_ACE) - AccessMask(typing.Any):Specifies the mask of access rights to be granted to the specified SID - ObjectTypeGuid(PyIID):GUID of object type or property set to which ace applies, can be None - InheritedObjectTypeGuid(PyIID):GUID of object type or property that will inherit ACE, can be None - sid(PySID):A SID object representing a user, group, or logon account being granted access. - -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 - -SID. - -Args: - - revision(typing.Any):Pre-win2k, must be ACL_REVISION, otherwise also may be ACL_REVISION_DS. - access(typing.Any):Specifies the mask of access rights to be denied to the specified SID. - sid(PySID):A SID object representing a user, group, or logon account being denied access.Alternative Parameters - access1(typing.Any):Specifies the mask of access rights to be denied to the specified SID. - sid1(typing.Any):A SID object representing a user, group, or logon account being denied access.CommentsNote that early versions of this function supported only two arguments. This has been deprecated in preference of the three argument version, which reflects the win32 API and the new functions in this module. - -Returns: - - None - - """ - pass - - - def AddAccessDeniedAceEx(self,revision:'typing.Any',aceflags:'typing.Any',access:'typing.Any',sid:'PySID') -> 'None': - """ - Add access denied ACE to an ACL with ACE flags (Requires Win2k or higher) - -Args: - - revision(typing.Any):Must be at least ACL_REVISION_DS - aceflags(typing.Any):Combination of ACE inheritance flags (CONTAINER_INHERIT_ACE,INHERIT_ONLY_ACE,INHERITED_ACE,NO_PROPAGATE_INHERIT_ACE, and OBJECT_INHERIT_ACE) - access(typing.Any):Specifies the mask of access rights to be denied to the specified SID. - sid(PySID):A SID object representing a user, group, or logon account being denied access. - -Returns: - - None - - """ - pass - - - def AddMandatoryAce(self,AceRevision:'typing.Any',AceFlags:'typing.Any',MandatoryPolicy:'typing.Any',LabelSid:'PySID') -> 'None': - """ - Adds a mandatory integrity level ACE to a SACL - -Args: - - AceRevision(typing.Any):ACL_REVISION or ACL_REVISION_DS - AceFlags(typing.Any):Combination of ACE inheritance flags (CONTAINER_INHERIT_ACE,INHERIT_ONLY_ACE,INHERITED_ACE,NO_PROPAGATE_INHERIT_ACE, and OBJECT_INHERIT_ACE) - MandatoryPolicy(typing.Any):Access policy for processes with lower integrity level, combination of SYSTEM_MANDATORY_LABEL_* flags - LabelSid(PySID):Integrity level SID. This can be created using CreateWellKnownSid with Win*LabelSid. Also can be constructed manually using SECURITY_MANDATORY_LABEL_AUTHORITY and a SECURITY_MANDATORY_*_RID - -Returns: - - None - - """ - pass - - - def AddAuditAccessAce(self,dwAceRevision:'typing.Any',dwAccessMask:'typing.Any',sid:'PySID',bAuditSuccess:'typing.Any',bAuditFailure:'typing.Any') -> 'None': - """ - Adds an audit ACE to a Sacl - -Args: - - dwAceRevision(typing.Any):Revision of ACL: Pre-Win2k, must be ACL_REVISION. Win2K on up, can also be ACL_REVISION_DS - dwAccessMask(typing.Any):Bitmask of access types to be audited - sid(PySID):SID for whom system audit messages will be generated - bAuditSuccess(typing.Any):Set to 1 if access success should be audited, else 0 - bAuditFailure(typing.Any):Set to 1 if access failure should be audited, else 0 - -Returns: - - None - - """ - pass - - - def AddAuditAccessAceEx(self,dwAceRevision:'typing.Any',AceFlags:'typing.Any',dwAccessMask:'typing.Any',sid:'PySID',bAuditSuccess:'typing.Any',bAuditFailure:'typing.Any') -> 'None': - """ - Adds an audit ACE to an Sacl, includes ace flags - -Args: - - dwAceRevision(typing.Any):Revision of ACL: Must be at least ACL_REVISION_DS - AceFlags(typing.Any):Combination of FAILED_ACCESS_ACE_FLAG,SUCCESSFUL_ACCESS_ACE_FLAG,CONTAINER_INHERIT_ACE,INHERIT_ONLY_ACE,INHERITED_ACE,NO_PROPAGATE_INHERIT_ACE and OBJECT_INHERIT_ACE - dwAccessMask(typing.Any):Bitmask of access types to be audited - sid(PySID):SID for whom system audit messages will be generated - bAuditSuccess(typing.Any):Set to 1 if access success should be audited, else 0 - bAuditFailure(typing.Any):Set to 1 if access failure should be audited, else 0 - -Returns: - - None - - """ - pass - - - def AddAuditAccessObjectAce(self,dwAceRevision:'typing.Any',AceFlags:'typing.Any',dwAccessMask:'typing.Any',ObjectTypeGuid:'PyIID',InheritedObjectTypeGuid:'PyIID',sid:'PySID',bAuditSuccess:'typing.Any',bAuditFailure:'typing.Any') -> 'None': - """ - Adds an audit ACE for an object type identified by GUID - -Args: - - dwAceRevision(typing.Any):Revision of ACL: Must be at least ACL_REVISION_DS - AceFlags(typing.Any):Combination of FAILED_ACCESS_ACE_FLAG,SUCCESSFUL_ACCESS_ACE_FLAG,CONTAINER_INHERIT_ACE,INHERIT_ONLY_ACE,INHERITED_ACE,NO_PROPAGATE_INHERIT_ACE and OBJECT_INHERIT_ACE - dwAccessMask(typing.Any):Bitmask of access types to be audited - ObjectTypeGuid(PyIID):GUID of object type or property set to which ace applies, can be None - InheritedObjectTypeGuid(PyIID):GUID of object type or property that will inherit ACE, can be None - sid(PySID):SID for whom system audit messages will be generated - bAuditSuccess(typing.Any):Set to 1 if access success should be audited, else 0 - bAuditFailure(typing.Any):Set to 1 if access failure should be audited, else 0 - -Returns: - - None - - """ - pass - - - def GetAclSize(self,) -> 'typing.Any': - """ - Returns the storage size of the ACL. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetAclRevision(self,) -> 'typing.Any': - """ - Returns revision of the ACL. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetAceCount(self,) -> 'typing.Any': - """ - Returns the number of ACEs in the ACL. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetAce(self,index:'typing.Any') -> 'typing.Any': - """ - Gets an Ace from the ACL - -Args: - - index(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[1] int : Mask[2] PySID : sidObject 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[1] int : mask[2] PyIID : ObjectType[3] PyIID : InheritedObjectType[4] PySID : sidFor details see the API documentation. - -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 - -as a tuple of: -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) - -are returned as a tuple: -[0] (int, int) : aceType, AceFlags - -[1] int : mask - -[2] PyIID : ObjectType - -[3] PyIID : InheritedObjectType - -[4] PySID : sid -For details see the API documentation. - - - """ - pass - - - def DeleteAce(self,index:'typing.Any') -> 'None': - """ - Deletes specified Ace from an ACL. - -Args: - - index(typing.Any):Zero-based index of the ACE to delete. - -Returns: - - None - - """ - pass - - - def GetEffectiveRightsFromAcl(self,trustee:'PyTRUSTEE') -> 'typing.Any': - """ - Return access rights (ACCESS_MASK) that the ACL grants to - -specified trustee - -Args: - - trustee(PyTRUSTEE):Dictionary representing a TRUSTEE structure - -Returns: - - typing.Any - - """ - pass - - - def GetAuditedPermissionsFromAcl(self,trustee:'PyTRUSTEE') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Return types of access for - -which ACL will generate an audit event for specified trustee - -Args: - - trustee(PyTRUSTEE):Dictionary representing a TRUSTEE structureCommentsThis function is known to return the success and failure access masks in the the wrong order on Windows 2000 service pack 4. Problem has been reported to Microsoft. - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - -class PyBITMAP(object): - """A Python object, representing an PyBITMAP structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def bmType(self)->'int': - """""" - pass - - - @property - def bmWidth(self)->'int': - """""" - pass - - - @property - def bmHeight(self)->'int': - """""" - pass - - - @property - def bmWidthBytes(self)->'int': - """""" - pass - - - @property - def bmPlanes(self)->'int': - """""" - pass - - -class PyBLENDFUNCTION(object): - """Tuple of four small ints used to fill a BLENDFUNCTION struct - -Each int must fit in a byte (0-255).""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCEHANDLE(object): - """A Python object, representing a remote Windows CE handle""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCERTSTORE(object): - """Handle to a certificate store""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def HCERTSTORE(self)->'typing.Any': - """Integer handle""" - pass - - - def CertCloseStore(self,Flags:'typing.Any'=0) -> 'None': - """ - Closes the certificate store - -Args: - - Flags(typing.Any):Combination of CERT_CLOSE_*_FLAG flags - -Returns: - - None - - """ - pass - - - def CertControlStore(self,Flags:'typing.Any',CtrlType:'typing.Any',CtrlPara:'int') -> 'None': - """ - Controls sychronization of the certificate store - -Args: - - Flags(typing.Any):One of the CERT_STORE_CTRL_*_FLAG flags - CtrlType(typing.Any):One of the CERT_STORE_CTRL_* flags - CtrlPara(int):Event handle, can be None (not used with CERT_STORE_CTRL_COMMIT) - -Returns: - - None - - """ - pass - - - def CertEnumCertificatesInStore(self,) -> 'typing.List[typing.Any]': - """ - Lists all certificates in the store - -Args: - - - -Returns: - - typing.List[typing.Any] - - """ - pass - - - def CertEnumCTLsInStore(self,) -> 'typing.List[typing.Any]': - """ - Finds all Certificate Trust Lists in store - -Args: - - - -Returns: - - typing.List[typing.Any] - - """ - pass - - - def CertSaveStore(self,MsgAndCertEncodingType:'typing.Any',SaveAs:'typing.Any',SaveTo:'typing.Any',SaveToPara:'typing.Union[str, int]',Flags:'typing.Any'=0) -> 'None': - """ - Serializes the store to memory or a file - -Args: - - MsgAndCertEncodingType(typing.Any):Only used when saveas is CERT_STORE_SAVE_AS_PKCS7 - usually X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING - SaveAs(typing.Any):One of the CERT_STORE_SAVE_AS_* constants - SaveTo(typing.Any):One of the CERT_STORE_SAVE_TO_* constants (CERT_STORE_SAVE_TO_MEMORY not supported yet) - SaveToPara(typing.Union[str, int]):File name or open file handle depending on SaveTo parm - Flags(typing.Any):Reserved, use 0 - -Returns: - - None - - """ - pass - - - def CertAddEncodedCertificateToStore(self,CertEncodingType:'typing.Any',CertEncoded:'typing.Any',AddDisposition:'typing.Any') -> 'PyCERT_CONTEXT': - """ - Imports an encoded certificate into the - -store - -Args: - - CertEncodingType(typing.Any):Usually X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING - CertEncoded(typing.Any):Data containing a serialized certificate - AddDisposition(typing.Any):Combination of CERT_STORE_ADD_* flags - -Returns: - - PyCERT_CONTEXT - - """ - pass - - - def CertAddCertificateContextToStore(self,CertContext:'PyCERT_CONTEXT',AddDisposition:'typing.Any') -> 'PyCERT_CONTEXT': - """ - Adds a certificate context to the store - -Args: - - CertContext(PyCERT_CONTEXT):Certificate context to be added - AddDisposition(typing.Any):CERT_STORE_ADD_* constant - -Returns: - - PyCERT_CONTEXT - - """ - pass - - - def CertAddCertificateLinkToStore(self,CertContext:'PyCERT_CONTEXT',AddDisposition:'typing.Any') -> 'PyCERT_CONTEXT': - """ - Adds a link to a cert in another store - -Args: - - CertContext(PyCERT_CONTEXT):Certificate context to be linked - AddDisposition(typing.Any):One of the CERT_STORE_ADD_* values - -Returns: - - PyCERT_CONTEXT - - """ - pass - - - def CertAddCTLContextToStore(self,CtlContext:'PyCTL_CONTEXT',AddDisposition:'typing.Any') -> 'PyCTL_CONTEXT': - """ - Adds a certificate trust list to the store - -Args: - - CtlContext(PyCTL_CONTEXT):CTL to be added - AddDisposition(typing.Any):CERT_STORE_ADD_* constant - -Returns: - - PyCTL_CONTEXT - - """ - pass - - - def CertAddCTLLinkToStore(self,CtlContext:'PyCTL_CONTEXT',AddDisposition:'typing.Any') -> 'PyCTL_CONTEXT': - """ - Adds a link to a CTL in another store - -Args: - - CtlContext(PyCTL_CONTEXT):CTL to be linked - AddDisposition(typing.Any):One of the CERT_STORE_ADD_* values - -Returns: - - PyCTL_CONTEXT - - """ - pass - - - def CertAddStoreToCollection(self,SiblingStore:'PyCERTSTORE',UpdateFlag:'typing.Any'=0,Priority:'typing.Any'=0) -> 'None': - """ - Adds a sibling store to a store collection - -Args: - - SiblingStore(PyCERTSTORE):Store to be added to the collection - UpdateFlag(typing.Any):Can be CERT_PHYSICAL_STORE_ADD_ENABLE_FLAG to enable changes to persist - Priority(typing.Any):Determines order in which store are searched and updatedCommentsA collection store is created by using cryptoapi::CertOpenStore with CERT_STORE_PROV_COLLECTION - -Returns: - - None - - """ - pass - - - def CertRemoveStoreFromCollection(self,SiblingStore:'PyCERTSTORE') -> 'None': - """ - Removes a sibling store from a collection - -Args: - - SiblingStore(PyCERTSTORE):Store to be removed from the collection - -Returns: - - None - - """ - pass - - - def PFXExportCertStoreEx(self,Flags:'typing.Any',Password:'typing.Any'=None) -> 'typing.Any': - """ - Exports certificates and associated private keys in PKCS#12 format - -Args: - - Flags(typing.Any):Options to be used while exporting - Password(typing.Any):Passphrase to be used to encrypt the output - -Returns: - - typing.Any - - """ - pass - - -class PyCERT_ALT_NAME_ENTRY(object): - """Represented as a 2-tuple""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCERT_ALT_NAME_INFO(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCERT_AUTHORITY_KEY_ID_INFO(object): - """Dict containing the identity of a CA""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def KeyId(self)->'typing.Any': - """Unique identifier of private key, usually a hash""" - pass - - - @property - def CertIssuer(self)->'typing.Any': - """Encoded DN of the Certificate Authority. Decode using X509_UNICODE_NAME""" - pass - - - @property - def CertSerialNumber(self)->'typing.Any': - """Serial nbr of the CA's signing certificate""" - pass - - -class PyCERT_BASIC_CONSTRAINTS2_INFO(object): - """Dict representing a CERT_BASIC_CONSTRAINTS2_INFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def fCA(self)->'typing.Any': - """Indicates if cert represents a certificate authority""" - pass - - - @property - def fPathLenConstraint(self)->'typing.Any': - """Indicates if PathLenConstraint member is used""" - pass - - - @property - def PathLenConstraint(self)->'typing.Any': - """Limits number of intermediate CA's between root CA and end user""" - pass - - -class PyCERT_BASIC_CONSTRAINTS_INFO(object): - """Dict representing a CERT_BASIC_CONSTRAINTS_INFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def SubjectType(self)->'PyCRYPT_BIT_BLOB': - """Contains a combination of CERT_CA_SUBJECT_FLAG,CERT_END_ENTITY_SUBJECT_FLAG""" - pass - - - @property - def fPathLenConstraint(self)->'typing.Any': - """Indicates if PathLenConstraint member is used""" - pass - - - @property - def PathLenConstraint(self)->'typing.Any': - """Limits number of intermediate CA's between root CA and end user""" - pass - - - @property - def SubtreesConstraint(self)->'typing.Any': - """Sequence of encoded name blobs""" - pass - - -class PyCERT_CONTEXT(object): - """Handle to a certificate context""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def HANDLE(self)->'typing.Any': - """Pointer to CERT_CONTEXT struct""" - pass - - - @property - def CertStore(self)->'PyCERTSTORE': - """Handle to the certificate store that contains this certificate""" - pass - - - @property - def CertEncoded(self)->'typing.Any': - """Content of the certificate as encoded bytes""" - pass - - - @property - def CertEncodingType(self)->'typing.Any': - """Method used to encode the certifcate, usually X509_ASN_ENCODING or PKCS_7_ASN_ENCODING""" - pass - - - @property - def Version(self)->'typing.Any': - """One of the CERT_V* values""" - pass - - - @property - def Subject(self)->'str': - """Encoded CERT_NAME_INFO struct containing the subject name. Can be decoded using cryptoapi::CryptDecodeObjectEx with X509_UNICODE_NAME, or formatted using cryptoapi::CertNameToStr""" - pass - - - @property - def Issuer(self)->'str': - """Certificate Authority that issued certificate as encoded CERT_NAME_INFO. Use cryptoapi::CryptDecodeObjectEx to decode into individual components, or cryptoapi::CertNameToStr to return a single formatted string""" - pass - - - @property - def NotBefore(self)->'PyTime': - """Beginning of certificate's period of validity""" - pass - - - @property - def NotAfter(self)->'PyTime': - """End of certificate's period of validity""" - pass - - - @property - def SignatureAlgorithm(self)->'typing.Any': - """Object id of the certifcate's signature algorithm""" - pass - - - @property - def Extension(self)->'typing.Tuple[PyCERT_EXTENSION, ...]': - """Sequence of CERT_EXTENSION dicts containing certificate's extensions""" - pass - - - @property - def SubjectPublicKeyInfo(self)->'PyCERT_PUBLIC_KEY_INFO': - """Encoded public key of certificate""" - pass - - - @property - def SerialNumber(self)->'typing.Any': - """Serial number assigned by the issuer""" - pass - - - def CertFreeCertificateContext(self,) -> 'None': - """ - Frees the certificate context - -Args: - - - -Returns: - - None - - """ - pass - - - def CertEnumCertificateContextProperties(self,) -> 'typing.List[typing.Any]': - """ - Lists property ids for the certificate - -Args: - - - -Returns: - - typing.List[typing.Any] - - """ - pass - - - def CryptAcquireCertificatePrivateKey(self,Flags:'typing.Any'=0) -> 'typing.Tuple[typing.Any, PyCRYPTPROV]': - """ - Retrieves the private key associated - -with the certificate - -Args: - - Flags(typing.Any):Combination of CRYPT_ACQUIRE_*_FLAG constantsCommentsOnly the owner of the certificate can use this methodReturn ValueReturns the KeySpec (AT_KEYEXCHANGE or AT_SIGNATURE) and a CSP handle to the key - -Returns: - - typing.Tuple[typing.Any, PyCRYPTPROV]:Combination of CRYPT_ACQUIRE_*_FLAG constants -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 - -(szOID_KEY_USAGE or szOID_KEY_ATTRIBUTES) - -Args: - - - -Returns: - - typing.Any:PyCERT_CONTEXT.CertGetIntendedKeyUsage - -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 - -certificate - -Args: - - Flags(typing.Any):CERT_FIND_EXT_ONLY_ENHKEY_USAGE_FLAG, CERT_FIND_PROP_ONLY_ENHKEY_USAGE_FLAG, or 0Return ValueReturns a sequence of usage OIDs - -Returns: - - 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 - - - def CertSerializeCertificateStoreElement(self,Flags:'typing.Any'=0) -> 'str': - """ - Serializes the certificate and its properties - -Args: - - Flags(typing.Any):Reserved, use only 0 if passed in - -Returns: - - str - - """ - pass - - - def CertVerifySubjectCertificateContext(self,Issuer:'PyCERT_CONTEXT',Flags:'typing.Any') -> 'typing.Any': - """ - Checks the validity of the certificate - -Args: - - Issuer(PyCERT_CONTEXT):Certificate of authority that issued the certificate - Flags(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. - -Returns: - - 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 - - - def CertDeleteCertificateFromStore(self,) -> 'None': - """ - Removes the certificate from its store - -Args: - - - -Returns: - - None - - """ - pass - - - def CertGetCertificateContextProperty(self,PropId:'typing.Any') -> 'typing.Any': - """ - Retrieves the specified property from the - -certificate - -Args: - - PropId(typing.Any):One of the CERT_*_PROP_ID constantsPropIdReturned valueCERT_ARCHIVED_PROP_IDBooleanCERT_DATE_STAMP_PROP_IDPyTimeCERT_ACCESS_STATE_PROP_IDintCERT_KEY_SPEC_PROP_IDintCERT_DESCRIPTION_PROP_IDUnicodeCERT_FRIENDLY_NAME_PROP_IDUnicodeCERT_PVK_FILE_PROP_IDUnicodeCERT_AUTO_ENROLL_PROP_IDUnicodeCERT_HASH_PROP_IDString containing a hashCERT_SHA1_HASH_PROP_IDString containing a hashCERT_MD5_HASH_PROP_IDString containing a hashCERT_SIGNATURE_HASH_PROP_IDString containing a hashCERT_KEY_IDENTIFIER_PROP_IDString containing a hashCERT_SUBJECT_NAME_MD5_HASH_PROP_IDString containing a hashCERT_KEY_PROV_HANDLE_PROP_IDPyCRYPTPROVCERT_SUBJECT_PUBLIC_KEY_MD5_HASH_PROP_IDString containing a hashCERT_ISSUER_PUBLIC_KEY_MD5_HASH_PROP_IDString containing a hashCERT_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_USAGECERT_KEY_PROV_INFO_PROP_IDCRYPT_KEY_PROV_INFO dictCERT_KEY_CONTEXT_PROP_IDDict representing CERT_KEY_CONTEXT structCERT_NEXT_UPDATE_LOCATION_PROP_IDEncoded CERT_ALT_NAME_INFO, decode using cryptoapi::CryptDecodeObjectEx with szOID_NEXT_UPDATE_LOCATIONReturn ValueType of object returned is dependent on the property id requested. - -Returns: - - typing.Any:One of the CERT_*_PROP_ID constants - - -PropId - - -Returned value - - - -CERT_ARCHIVED_PROP_IDBoolean -CERT_DATE_STAMP_PROP_IDPyTime -CERT_ACCESS_STATE_PROP_IDint -CERT_KEY_SPEC_PROP_IDint -CERT_DESCRIPTION_PROP_IDUnicode -CERT_FRIENDLY_NAME_PROP_IDUnicode -CERT_PVK_FILE_PROP_IDUnicode -CERT_AUTO_ENROLL_PROP_IDUnicode -CERT_HASH_PROP_IDString containing a hash -CERT_SHA1_HASH_PROP_IDString containing a hash -CERT_MD5_HASH_PROP_IDString containing a hash -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 - -containing a hash -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_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 -CERT_KEY_CONTEXT_PROP_IDDict representing CERT_KEY_CONTEXT struct -CERT_NEXT_UPDATE_LOCATION_PROP_IDEncoded CERT_ALT_NAME_INFO, decode using cryptoapi::CryptDecodeObjectEx - - - - with szOID_NEXT_UPDATE_LOCATION -Return ValueType of object returned is dependent on the property id requested. - - - """ - pass - - - def CertSetCertificateContextProperty(self,PropId:'typing.Any',Data:'typing.Any',Flags:'typing.Any'=0) -> 'None': - """ - Sets a property for a certificate - -Args: - - PropId(typing.Any):Id of property to be set, CERT_*_PROP_ID - Data(typing.Any):The value to be set for the property. Type is dependent on PropId. Use None to delete a property. - Flags(typing.Any):Combination of CERT_SET_* flagsPropIdType of inputCERT_ARCHIVED_PROP_IDNone causes Archived flag to be cleared, any other causes it to be set no actual data, non-NULL pvData indicates presence of flagCERT_DATE_STAMP_PROP_IDPyTime specifying when cert was added to storeCERT_DESCRIPTION_PROP_IDUnicode stringCERT_FRIENDLY_NAME_PROP_IDUnicode stringCERT_PVK_FILE_PROP_IDUnicode stringCERT_AUTO_ENROLL_PROP_IDUnicode stringCERT_KEY_SPEC_PROP_IDInt, usually AT_KEYEXCHANGE or AT_SIGNATURECERT_HASH_PROP_IDString containing the hashCERT_SHA1_HASH_PROP_IDString containing the hashCERT_MD5_HASH_PROP_IDString containingg the hashCERT_SIGNATURE_HASH_PROP_IDString containing the hashCERT_KEY_IDENTIFIER_PROP_IDString containing the key idCERT_SUBJECT_PUBLIC_KEY_MD5_HASH_PROP_IDString containing the hashCERT_ISSUER_PUBLIC_KEY_MD5_HASH_PROP_IDString containing the hashCERT_SUBJECT_NAME_MD5_HASH_PROP_IDString containing the hashCERT_RENEWAL_PROP_IDString containing the hashCERT_ENHKEY_USAGE_PROP_IDString containing an encoded PyCTL_USAGE. Use cryptoapi::CryptEncodeObjectEx with X509_ENHANCED_KEY_USAGE.CERT_CTL_USAGE_PROP_IDSame as CERT_ENHKEY_USAGE_PROP_ID - -Returns: - - None - - """ - pass - - -class PyCERT_EXTENSION(object): - """Dict containing a certificate extension""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ObjId(self)->'typing.Any': - """The OID identifying the type of extension""" - pass - - - @property - def Critical(self)->'typing.Any': - """If true, any contraints or limits contained in the extension should be considered absolute""" - pass - - - @property - def Value(self)->'typing.Any': - """Binary string containing ASN encoded data. To interpret or display extension data, see cryptoapi::CryptDecodeObjectEx and cryptoapi::CryptFormatObject.""" - pass - - -class PyCERT_KEY_ATTRIBUTES_INFO(object): - """Dict representing a CERT_KEY_ATTRIBUTES_INFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def KeyId(self)->'typing.Any': - """Usually a hash that uniquely identifies the key""" - pass - - - @property - def IntendedKeyUsage(self)->'PyCRYPT_BIT_BLOB': - """Contains a byte with CERT_*_KEY_USAGE flags""" - pass - - - @property - def PrivateKeyUsagePeriod(self)->'typing.Any': - """Private key's begin and end effective dates, may be None""" - pass - - -class PyCERT_NAME_INFO(object): - """Sequence of CERT_RDN's""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCERT_NAME_VALUE(object): - """Dict containing type (CERT_RDN_*) and a unicode string""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCERT_OTHER_NAME(object): - """Dict containing {ObjId, Value}. - -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 - -using X509_UNICODE_NAME_VALUE to return the actual unicode string""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCERT_POLICY_INFO(object): - """Dict containing a certificate policy""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def PolicyIdentifier(self)->'typing.Any': - """OID identifying the policy""" - pass - - - @property - def PolicyQualifier(self)->'typing.Any': - """Sequence of CERT_POLICY_QUALIFIER dicts""" - pass - - -class PyCERT_PUBLIC_KEY_INFO(object): - """Dict containing an exported public key""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Algorithm(self)->'PyCRYPT_ALGORITHM_IDENTIFIER': - """Dict containing OID of the public key algorithm""" - pass - - - @property - def PublicKey(self)->'PyCRYPT_BIT_BLOB': - """Dict containing the encoded public key""" - pass - - -class PyCOMSTAT(object): - """A Python object, representing an COMSTAT structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def cbInQue(self)->'int': - """Specifies the number of bytes received by the serial provider but not yet read by a win32file::ReadFile operation""" - pass - - - @property - def cbOutQue(self)->'int': - """Specifies the number of bytes of user data remaining to be transmitted for all write operations. This value will be zero for a nonoverlapped write.""" - pass - - - @property - def fCtsHold(self)->'int': - """Specifies whether transmission is waiting for the CTS (clear-to-send) signal to be sent. If this member is TRUE, transmission is waiting.""" - pass - - - @property - def fDsrHold(self)->'int': - """Specifies whether transmission is waiting for the DSR (data-set-ready) signal to be sent. If this member is TRUE, transmission is waiting.""" - pass - - - @property - def fRlsdHold(self)->'int': - """Specifies whether transmission is waiting for the RLSD (receive-line-signal-detect) signal to be sent. If this member is TRUE, transmission is waiting.""" - pass - - - @property - def fXoffHold(self)->'int': - """Specifies whether transmission is waiting because the XOFF character was received. If this member is TRUE, transmission is waiting.""" - pass - - - @property - def fXoffSent(self)->'int': - """Specifies whether transmission is waiting because the XOFF character was transmitted. If this member is TRUE, transmission is waiting. Transmission halts when the XOFF character is transmitted to a system that takes the next character as XON, regardless of the actual character.""" - pass - - - @property - def fEof(self)->'int': - """Specifies whether the end-of-file (EOF) character has been received. If this member is TRUE, the EOF character has been received.""" - pass - - - @property - def fTxim(self)->'int': - """If this member is TRUE, there is a character queued for transmission that has come to the communications device by way of the TransmitCommChar function. The communications device transmits such a character ahead of other characters in the device's output buffer.""" - pass - - - @property - def fReserved(self)->'int': - """Reserved; do not use.""" - pass - - -class PyCOORD(object): - """Wrapper for a COORD struct. Create using PyCOORDType(X,Y)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def X(self)->'typing.Any': - """Horizontal coordinate""" - pass - - - @property - def Y(self)->'typing.Any': - """Vertical coordinate""" - pass - - -class PyCREDENTIAL(object): - """A dictionary containing information for a CREDENTIAL struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Flags(self)->'typing.Any': - """Combination of CRED_FLAGS_PROMPT_NOW, CRED_FLAGS_USERNAME_TARGET""" - pass - - - @property - def Type(self)->'typing.Any': - """Type of credential, one of CRED_TYPE_* values""" - pass - - - @property - def TargetName(self)->'str': - """Target of credential, can end with * for wildcard matching""" - pass - - - @property - def Comment(self)->'str': - """Descriptive text""" - pass - - - @property - def LastWritten(self)->'PyTime': - """Modification time, ignored on input""" - pass - - - @property - def CredentialBlob(self)->'str': - """Contains password for username credential, or PIN for certificate credential. This member is write-only.""" - pass - - - @property - def Persist(self)->'typing.Any': - """Specifies scope of persistence, one of CRED_PERSIST_* values""" - pass - - - @property - def Attributes(self)->'typing.Any': - """Tuple of PyCREDENTIAL_ATTRIBUTE dicts containing application-specific data, can be None""" - pass - - - @property - def TargetAlias(self)->'str': - """Alias for TargetName, only valid with CRED_TYPE_GENERIC""" - pass - - - @property - def UserName(self)->'str': - """User to be authenticated by target. Can be of the form username@domain or domain\\username. For CRED_TYPE_DOMAIN_CERTIFICATE, use win32cred::CredMarshalCredential to marshal the SHA1 hash of user's certficate""" - pass - - -class PyCREDENTIAL_ATTRIBUTE(object): - """A dictionary containing information for a CREDENTIAL_ATTRIBUTE struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Keyword(self)->'str': - """Attribute name, at most CRED_MAX_STRING_LENGTH chars""" - pass - - - @property - def Flags(self)->'typing.Any': - """Reserved, use only 0""" - pass - - - @property - def Value(self)->'typing.Any': - """Attribute value, at most CRED_MAX_VALUE_SIZE bytes. Unicode objects are treated as raw bytes.""" - pass - - -class PyCREDENTIAL_TARGET_INFORMATION(object): - """A dictionary representing a CREDENTIAL_TARGET_INFORMATION struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def TargetName(self)->'str': - """Target of credentials""" - pass - - - @property - def NetbiosServerName(self)->'str': - """""" - pass - - - @property - def DnsServerName(self)->'str': - """""" - pass - - - @property - def NetbiosDomainName(self)->'str': - """""" - pass - - - @property - def DnsDomainName(self)->'str': - """""" - pass - - - @property - def DnsTreeName(self)->'str': - """""" - pass - - - @property - def PackageName(self)->'str': - """Name of security package which mapped TargetName""" - pass - - - @property - def Flags(self)->'typing.Any': - """CRED_TI_* flags""" - pass - - - @property - def CredTypes(self)->'typing.Tuple[typing.Any, ...]': - """Tuple of CRED_TYPE_* values indicating which types of credentials are acceptable to target""" - pass - - -class PyCREDUI_INFO(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Parent(self)->'int': - """Handle to parent window, can be None""" - pass - - - @property - def MessageText(self)->'str': - """Message to appear in dialog""" - pass - - - @property - def CaptionText(self)->'str': - """Title of the dialog window""" - pass - - - @property - def Banner(self)->'int': - """Handle to a bitmap to be displayed""" - pass - - -class PyCRYPTHASH(object): - """Handle to a cryptographic hash""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CryptDestroyHash(self,) -> 'None': - """ - Frees the hash object - -Args: - - - -Returns: - - None - - """ - pass - - - def CryptDuplicateHash(self,Flags:'typing.Any'=0) -> 'PyCRYPTHASH': - """ - Clones the hash object - -Args: - - Flags(typing.Any):Reserved, use 0 if passed - -Returns: - - PyCRYPTHASH - - """ - pass - - - def CryptHashData(self,Data:'str',Flags:'typing.Any'=0) -> 'None': - """ - Adds data to the hash - -Args: - - Data(str):Data to be hashed - Flags(typing.Any):CRYPT_USERDATA or 0CommentsIf Flags is CRYPT_USERDATA, provider is expected to prompt user to enter data. MSDN says that MS CSPs ignore this flag - -Returns: - - None - - """ - pass - - - def CryptHashSessionKey(self,Key:'PyCRYPTKEY',Flags:'typing.Any'=0) -> 'None': - """ - Hashes a session key - -Args: - - Key(PyCRYPTKEY):The session key to be hashed - Flags(typing.Any):CRYPT_LITTLE_ENDIAN or 0 - -Returns: - - None - - """ - pass - - - def CryptSignHash(self,KeySpec:'typing.Any',Flags:'typing.Any'=0) -> 'str': - """ - Signs the hash - -Args: - - KeySpec(typing.Any):The key to be used to sign the hash, AT_KEYEXCHANGE,AT_SIGNATURE - Flags(typing.Any):CRYPT_NOHASHOID,CRYPT_X931_FORMAT or 0CommentsThis methods signs only the hash, not the data that the hash represents - -Returns: - - str - - """ - pass - - - def CryptVerifySignature(self,Signature:'str',PubKey:'PyCRYPTKEY',Flags:'typing.Any'=0) -> 'None': - """ - Verifies that a signature matches hashed data - -Args: - - Signature(str):Signature data to verify - PubKey(PyCRYPTKEY):Public key of signer - Flags(typing.Any):CRYPT_NOHASHOID,CRYPT_X931_FORMAT or 0 - -Returns: - - None - - """ - pass - - - def CryptGetHashParam(self,Param:'typing.Any',Flags:'typing.Any'=0) -> 'typing.Union[typing.Any]': - """ - Retrieves the specified attribute of the hash - -Args: - - Param(typing.Any):The parameter to retrieve: HP_ALGID, HP_HASHSIZE, or HP_HASHVAL - Flags(typing.Any):Reserved, use 0 if passed inCommentsAfter this method has been called, no more data can be hashedReturn ValueType of returned object is dependent on the Param passed in - -Returns: - - typing.Union[typing.Any]:Reserved, use 0 if passed in -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 - - -class PyCRYPTKEY(object): - """Handle to a cryptographic key""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def HCRYPTPROV(self)->'typing.Any': - """CSP used by the key""" - pass - - - @property - def HCRYPTKEY(self)->'typing.Any': - """Plain integer handle to the key""" - pass - - - def CryptDestroyKey(self,) -> 'None': - """ - Releases the handle to the key (does not delete permanent keys) - -Args: - - - -Returns: - - None - - """ - pass - - - def CryptExportKey(self,ExpKey:'PyCRYPTKEY',BlobType:'typing.Any',Flags:'typing.Any'=0) -> 'typing.Any': - """ - Exports key or key pair as an encrypted blob - -Args: - - ExpKey(PyCRYPTKEY):Public key or session key of destination user. Use None if exporting a PUBLICKEYBLOB - BlobType(typing.Any):One of OPAQUEKEYBLOB,PRIVATEKEYBLOB,PUBLICKEYBLOB,SIMPLEBLOB,PLAINTEXTKEYBLOB,SYMMETRICWRAPKEYBLOB - Flags(typing.Any):Combination of CRYPT_DESTROYKEY,CRYPT_SSL2_FALLBACK,CRYPT_OAEP or 0Return ValueReturns a binary blob that can be imported via PyCRYPTPROV::CryptImportKey - -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 - - - def CryptGetKeyParam(self,Param:'typing.Any',Flags:'typing.Any'=0) -> 'typing.Any': - """ - Retrieves key parameters - -Args: - - Param(typing.Any):One of the KP_* constants - Flags(typing.Any):Reserved, use only 0Return ValueType of returned object is dependent on the requested attribute - -Returns: - - typing.Any:Reserved, use only 0 -Return ValueType of returned object is dependent on the requested attribute - - - """ - pass - - - def CryptDuplicateKey(self,Reserved:'typing.Any'=0,Flags:'typing.Any'=0) -> 'PyCRYPTKEY': - """ - Creates an independent copy of the key - -Args: - - Reserved(typing.Any):Use 0 if passed in - Flags(typing.Any):Also reserved, use 0 - -Returns: - - PyCRYPTKEY - - """ - pass - - - def CryptEncrypt(self,Final:'typing.Any',Data:'typing.Any',Hash:'PyCRYPTHASH'=None,Flags:'typing.Any'=0) -> 'typing.Any': - """ - Encrypts and optionally hashes data - -Args: - - Final(typing.Any):Boolean, use True if this is final encryption operation - Data(typing.Any):Data to be encrypted - Hash(PyCRYPTHASH):Hash to be updated with data passed in, can be None - Flags(typing.Any):Reserved, use 0 if passed in - -Returns: - - typing.Any - - """ - pass - - - def CryptDecrypt(self,Final:'typing.Any',Data:'typing.Any',Hash:'PyCRYPTHASH'=None,Flags:'typing.Any'=0) -> 'typing.Any': - """ - Decrypts data - -Args: - - Final(typing.Any):Boolean, use True is this is last (or only) operation - Data(typing.Any):Data to be decrypted - Hash(PyCRYPTHASH):Hash to be used in signature verification, can be None - Flags(typing.Any):Reserved, use only 0 - -Returns: - - typing.Any - - """ - pass - - -class PyCRYPTMSG(object): - """Wrapper for a cryptographic message handle""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def HCRYPTMSG(self)->'typing.Any': - """Raw message handle""" - pass - - - def CryptMsgClose(self,) -> 'None': - """ - Closes the message handle - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCRYPTPROTECT_PROMPTSTRUCT(object): - """A tuple representing a CRYPTPROTECT_PROMPTSTRUCT structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCRYPTPROV(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CryptReleaseContext(self,Flags:'typing.Any'=0) -> 'None': - """ - Releases the CSP handle - -Args: - - Flags(typing.Any):Reserved, use 0 if passed in - -Returns: - - None - - """ - pass - - - def CryptGenKey(self,Algid:'typing.Any',Flags:'typing.Any',KeyLen:'typing.Any'=0) -> 'PyCRYPTKEY': - """ - Generates a key pair or a session key - -Args: - - Algid(typing.Any):Algorithm identifier, one of the CALG_* values, or AT_KEYEXCHANGE/AT_SIGNATURE - Flags(typing.Any):Combination of CRYPT_CREATE_SALT,CRYPT_EXPORTABLE,CRYPT_NO_SALT,CRYPT_PREGEN,CRYPT_USER_PROTECTED,CRYPT_ARCHIVABLE - KeyLen(typing.Any):Length of key to generate, can be 0 to use provider's default key lengthCommentsDiffers from Api call in that the length is passed in separately - -Returns: - - PyCRYPTKEY - - """ - pass - - - def CryptGetProvParam(self,Param:'typing.Any',Flags:'typing.Any'=0) -> 'None': - """ - Retrieves specified attribute of provider - -Args: - - Param(typing.Any):One of the PP_* values - Flags(typing.Any):If param if PP_KEYSET_SEC_DESCR, can be a combination of OWNER_SECURITY_INFORMATION,GROUP_SECURITY_INFORMATION,DACL_SECURITY_INFORMATION,SACL_SECURITY_INFORMATIONReturn ValueType of returned object is dependent on the attribute requested - -Returns: - - 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 - - - def CryptGetUserKey(self,KeySpec:'typing.Any') -> 'PyCRYPTKEY': - """ - Returns a handle to one of user's key pairs - -Args: - - KeySpec(typing.Any):AT_KEYEXCHANGE or AT_SIGNATURE (some providers may implement extra key specs) - -Returns: - - PyCRYPTKEY - - """ - pass - - - def CryptGenRandom(self,Len:'typing.Any',SeedData:'str'=None) -> 'str': - """ - Generates random data of specified length - -Args: - - Len(typing.Any):Number of bytes to generate - SeedData(str):Random seed data - -Returns: - - str - - """ - pass - - - def CryptCreateHash(self,Algid:'typing.Any',Key:'PyCRYPTKEY'=None,Flags:'typing.Any'=0) -> 'PyCRYPTHASH': - """ - Creates a hash object for hashing large amounts of data - -Args: - - Algid(typing.Any):An algorithm identifier, CALG_*. - Key(PyCRYPTKEY):Used only for keyed hashes (MAC or HMAC), use None otherwise - Flags(typing.Any):Reserved, use 0 if passed in - -Returns: - - PyCRYPTHASH - - """ - pass - - - def CryptImportKey(self,Data:'typing.Any',PubKey:'PyCRYPTKEY'=None,Flags:'typing.Any'=0) -> 'PyCRYPTKEY': - """ - None - -Args: - - Data(typing.Any):The key blob to be imported - PubKey(PyCRYPTKEY):Key to be used to decrypt the blob, not used for importing public keys - Flags(typing.Any):Combination of CRYPT_EXPORTABLE, CRYPT_OAEP, CRYPT_NO_SALT, CRYPT_USER_PROTECTED - -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 - -Returned dict can be serialized for sending to another python application using pickle.dump - -Args: - - KeySpec(typing.Any):AT_KEYEXCHANGE or AT_SIGNATURE - CertEncodingType(typing.Any):Specifies encoding for exported key info - -Returns: - - PyCERT_PUBLIC_KEY_INFO - - """ - pass - - - def CryptImportPublicKeyInfo(self,Info:'typing.Any',CertEncodingType:'typing.Any') -> 'PyCRYPTKEY': - """ - Imports another user's public key - -Args: - - Info(typing.Any):PyCERT_PUBLIC_KEY_INFO dictionary as returned by PyCRYPTPROV::CryptExportPublicKeyInfo - CertEncodingType(typing.Any):Specifies encoding for exported key info - -Returns: - - PyCRYPTKEY - - """ - pass - - -class PyCRYPT_ALGORITHM_IDENTIFIER(object): - """Dictionary containing information that identifies an encryption - -algorithm and any extra parameters it requires""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ObjId(self)->'typing.Any': - """An szOID_* string identifying the algorithm""" - pass - - - @property - def Parameters(self)->'typing.Any': - """Blob of binary data containing encoded parameters""" - pass - - -class PyCRYPT_ATTRIBUTE(object): - """Dict representing a CRYPT_ATTRIBUTE struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ObjId(self)->'typing.Any': - """An szOID_* string identifying the attribute""" - pass - - - @property - def Value(self)->'typing.Tuple[typing.Any, ...]': - """A sequence of buffers containing the attribute values""" - pass - - -class PyCRYPT_BIT_BLOB(object): - """Dict containing raw data of a certain bit length""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Data(self)->'typing.Any': - """Binary data""" - pass - - - @property - def UnusedBits(self)->'typing.Any': - """Nbr of bits of last byte that are unused""" - pass - - -class PyCRYPT_DECRYPT_MESSAGE_PARA(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def CertStores(self)->'typing.Tuple[typing.Any, ...]': - """Sequence of certificate stores to be searched for a certificate with a private key that can be used to decrypt the message""" - pass - - - @property - def MsgAndCertEncodingType(self)->'typing.Any': - """Encoding types, optional. Defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" - pass - - - @property - def Flags(self)->'typing.Any': - """Optional. CRYPT_MESSAGE_SILENT_KEYSET_FLAG can be used to suppress any dialogs that might be triggered by accessing a key container, such as a request for a PIN.""" - pass - - -class PyCRYPT_ENCRYPT_MESSAGE_PARA(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ContentEncryptionAlgorithm(self)->'PyCRYPT_ALGORITHM_IDENTIFIER': - """Identifies the algorithm to be used""" - pass - - - @property - def CryptProv(self)->'PyCRYPTPROV': - """Optional. Handle to provider that will perform encryption, can be None for default provider""" - pass - - - @property - def EncryptionAuxInfo(self)->'typing.Any': - """Optional. Extra info required by some CSP's. Not supported yet, use only None""" - pass - - - @property - def Flags(self)->'typing.Any': - """Optional. Combination of CRYPT_MESSAGE_*_FLAG constants""" - pass - - - @property - def InnerContentType(self)->'typing.Any': - """Optional. Only used if message to be encrypted is already encoded""" - pass - - - @property - def MsgEncodingType(self)->'typing.Any': - """Optional. Defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" - pass - - -class PyCRYPT_SIGN_MESSAGE_PARA(object): - """Dict of parms defining how a message will be signed""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def SigningCert(self)->'PyCERT_CONTEXT': - """Certficate to be used to sign message""" - pass - - - @property - def HashAlgorithm(self)->'PyCRYPT_ALGORITHM_IDENTIFIER': - """Algorithm to be used for signed hash""" - pass - - - @property - def HashAuxInfo(self)->'typing.Any': - """Optional. Param is reserved, use only None.""" - pass - - - @property - def MsgCert(self)->'typing.Tuple[PyCERT_CONTEXT, ...]': - """Optional sequence of certificate to be included in the message.""" - pass - - - @property - def MsgCrl(self)->'typing.Tuple[typing.Any, ...]': - """Optional. Sequence of certificate revocation lists. Not yet supported, use only None.""" - pass - - - @property - def AuthAttr(self)->'typing.Tuple[PyCRYPT_ATTRIBUTE, ...]': - """Sequence of canonical attributes to be added to the message""" - pass - - - @property - def UnauthAttr(self)->'typing.Tuple[PyCRYPT_ATTRIBUTE, ...]': - """Sequence of arbitrary attributes""" - pass - - - @property - def Flags(self)->'typing.Any': - """Optional CRYPT_MESSAGE_*_FLAG that indicates content type if output is to be further encoded.""" - pass - - - @property - def InnerContentType(self)->'typing.Any': - """Optional, one of the CMSG_* content types if message is already encoded, .""" - pass - - - @property - def MsgEncodingType(self)->'typing.Any': - """Encoding types, optional. Defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" - pass - - -class PyCRYPT_VERIFY_MESSAGE_PARA(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def MsgAndCertEncodingType(self)->'typing.Any': - """Encoding types, defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" - pass - - - @property - def CryptProv(self)->'PyCRYPTPROV': - """CSP to be used to verify signature. Use None for default provider.""" - pass - - - @property - def PyGetSignerCertificate(self)->'typing.Any': - """Callback function that locates signer's certificate.""" - pass - - - @property - def GetArg(self)->'typing.Any': - """Argument to be passed to above function, can be any object.""" - pass - - -class PyCTL_CONTEXT(object): - """Object containing a Certificate Trust List""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def HCTL_CONTEXT(self)->'typing.Any': - """Raw message handle""" - pass - - - def CertFreeCTLContext(self,) -> 'None': - """ - Closes the CTL handle - -Args: - - - -Returns: - - None - - """ - pass - - - def CertEnumCTLContextProperties(self,) -> 'typing.Tuple[typing.Any, ...]': - """ - Lists property id's for the context - -Args: - - - -Returns: - - typing.Tuple[typing.Any, ...] - - """ - pass - - - def CertEnumSubjectInSortedCTL(self,) -> 'typing.Tuple[typing.Tuple[typing.Any, typing.Any], ...]': - """ - Retrieves trusted subjects contained in CRL - -Args: - - - -Returns: - - typing.Tuple[typing.Tuple[typing.Any, typing.Any], ...]:PyCTL_CONTEXT.CertEnumSubjectInSortedCTL - -((str,str),...) = CertEnumSubjectInSortedCTL()Retrieves trusted subjects contained in CRL -Return ValueReturns a sequence of tuples containing two strings (SubjectIdentifier, EncodedAttributes) - - - """ - pass - - - def CertDeleteCTLFromStore(self,) -> 'None': - """ - Removes the CTL from the store that it is contained in - -Args: - - - -Returns: - - None - - """ - pass - - - def CertSerializeCTLStoreElement(self,Flags:'typing.Any'=0) -> 'str': - """ - Serializes the CTL and its properties - -Args: - - Flags(typing.Any):Reserved, use only 0 if passed in - -Returns: - - str - - """ - pass - - -class PyCTL_USAGE(object): - """Sequence of string OIDs (szOID_*). This struct is identical to CERT_ENHKEY_USAGE.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyConsoleScreenBuffer(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetConsoleActiveScreenBuffer(self,) -> 'None': - """ - Sets this handle as the currently displayed screen - -buffer - -Args: - - - -Returns: - - None - - """ - pass - - - def GetConsoleCursorInfo(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Retrieves size and visibility of console's - -cursor - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any]:PyConsoleScreenBuffer.GetConsoleCursorInfo - -(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 - -if cursor is visible - - - """ - pass - - - def SetConsoleCursorInfo(self,Size:'typing.Any',Visible:'typing.Any') -> 'None': - """ - Sets the size and visibility of console's cursor - -Args: - - Size(typing.Any):Percentage of character size that cursor will occupy - Visible(typing.Any):Determines if cursor is visible - -Returns: - - None - - """ - pass - - - def GetConsoleMode(self,) -> 'typing.Any': - """ - Returns the input or output mode of the console buffer - -Args: - - - -Returns: - - typing.Any:PyConsoleScreenBuffer.GetConsoleMode - -int = GetConsoleMode()Returns the input or output mode of the console buffer -Return ValueReturns a combination of ENABLE_*_INPUT or ENABLE_*_OUTPUT constants - - - """ - pass - - - def SetConsoleMode(self,Mode:'typing.Any') -> 'None': - """ - Sets the input or output mode of the console buffer - -Args: - - Mode(typing.Any):Combination of ENABLE_*_INPUT or ENABLE_*_OUTPUT constants - -Returns: - - None - - """ - pass - - - def ReadConsole(self,NumberOfCharsToRead:'typing.Any') -> 'typing.Any': - """ - Reads characters from the console input buffer - -Args: - - NumberOfCharsToRead(typing.Any):Characters to read - -Returns: - - typing.Any - - """ - pass - - - def WriteConsole(self,Buffer:'typing.Any') -> 'typing.Any': - """ - Writes characters at current cursor position - -Args: - - Buffer(typing.Any):String or Unicode to be written to consoleReturn ValueReturns the number of characters written - -Returns: - - typing.Any:String or Unicode to be written to consoleReturn ValueReturns the number of characters written - - - """ - pass - - - def FlushConsoleInputBuffer(self,) -> 'None': - """ - Flush input buffer - -Args: - - - -Returns: - - None - - """ - pass - - - def SetConsoleTextAttribute(self,Attributes:'typing.Any') -> 'None': - """ - Sets character attributes for subsequent write operations - -Args: - - Attributes(typing.Any):Attributes to be set, combination of FOREGROUND_*, BACKGROUND_*, and COMMON_LVB_* constants - -Returns: - - None - - """ - pass - - - def SetConsoleCursorPosition(self,CursorPosition:'PyCOORD') -> 'None': - """ - Sets the console screen buffer's cursor position - -Args: - - CursorPosition(PyCOORD):A PyCOORD containing the new cursor position - -Returns: - - None - - """ - pass - - - def SetConsoleScreenBufferSize(self,Size:'PyCOORD') -> 'None': - """ - Sets the size of the console screen buffer - -Args: - - Size(PyCOORD):COORD object containing the new dimensions - -Returns: - - None - - """ - pass - - - def SetConsoleWindowInfo(self,Absolute:'typing.Any',ConsoleWindow:'PySMALL_RECT') -> 'None': - """ - Changes size and position of a console's window - -Args: - - Absolute(typing.Any):If False, coordinates are relative to current position - ConsoleWindow(PySMALL_RECT):A SMALL_RECT containing the new window coordinates - -Returns: - - None - - """ - pass - - - def GetConsoleScreenBufferInfo(self,) -> 'typing.Any': - """ - Returns the state of the screen buffer - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetLargestConsoleWindowSize(self,) -> 'PyCOORD': - """ - Returns the largest possible size for the - -console's window - -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 - -characters - -Args: - - Attribute(typing.Any):Text attributes to be set, combination of FOREGROUND_*, BACKGROUND_*, and COMMON_LVB_* constants - Length(typing.Any):The number of characters to set - WriteCoord(PyCOORD):The screen position to begin atReturn ValueReturns the number of character cells whose attributes were set - -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 - -character - -Args: - - Character(typing.Any):A single character to be used to fill the specified range - Length(typing.Any):The number of characters positions to fill - WriteCoord(PyCOORD):The screen position to begin atReturn ValueReturns the number of characters actually written - -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 - -position - -Args: - - Length(typing.Any):The number of characters positions to read - ReadCoord(PyCOORD):The screen position start reading from - -Returns: - - str - - """ - pass - - - def ReadConsoleOutputAttribute(self,Length:'typing.Any',ReadCoord:'PyCOORD') -> 'typing.Tuple[typing.Any, ...]': - """ - Retrieves attributes from consecutive character - -cells - -Args: - - Length(typing.Any):The number of attributes to read - ReadCoord(PyCOORD):The screen position from which to start readingReturn ValueReturns a sequence of ints containing the attributes of a range of characters - -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 - - - def WriteConsoleOutputCharacter(self,Characters:'typing.Any',WriteCoord:'PyCOORD') -> 'typing.Any': - """ - Writes a string of characters at a specified position - -Args: - - Characters(typing.Any):Characters to be written - WriteCoord(PyCOORD):The screen position at which to start writingReturn ValueReturns the number of characters actually written - -Returns: - - typing.Any:The screen position at which to start writingReturn ValueReturns the number of characters actually written - - - """ - pass - - - def WriteConsoleOutputAttribute(self,Attributes:'typing.Tuple[typing.Any, ...]',WriteCoord:'PyCOORD') -> 'typing.Any': - """ - Sets the attributes of a range of character cells - -Args: - - Attributes(typing.Tuple[typing.Any, ...]):A sequence of ints containing the attributes to be set - WriteCoord(PyCOORD):The screen position at which to start writingReturn ValueReturns the number of attributes set - -Returns: - - typing.Any:The screen position at which to start writingReturn ValueReturns the number of attributes set - - - """ - pass - - - def ScrollConsoleScreenBuffer(self,ScrollRectangle:'PySMALL_RECT',ClipRectangle:'PySMALL_RECT',DestinationOrigin:'PyCOORD',FillCharacter:'typing.Any',FillAttribute:'typing.Any') -> 'None': - """ - Scrolls a region of the display - -Args: - - ScrollRectangle(PySMALL_RECT):The region to be scrolled - ClipRectangle(PySMALL_RECT):Rectangle that limits display area affected, can be None - DestinationOrigin(PyCOORD):The position to which ScrollRectangle will be moved - FillCharacter(typing.Any):Character to fill in the area left blank by scrolling operation - FillAttribute(typing.Any):Text attributes to apply to FillCharacter - -Returns: - - None - - """ - pass - - - def GetCurrentConsoleFont(self,MaximumWindow:'typing.Any'=False) -> 'typing.Tuple[typing.Any, PyCOORD]': - """ - Returns currently displayed font - -Args: - - MaximumWindow(typing.Any):If True, retrieves font size for maximum window sizeCommentsOnly exists on XP or later. 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 - -Returns: - - typing.Tuple[typing.Any, PyCOORD]:If True, retrieves font size for maximum window size -Comments - -Only exists on XP or later. - -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 - - - def GetConsoleFontSize(self,Font:'typing.Any') -> 'PyCOORD': - """ - Returns size of specified font for the console - -Args: - - Font(typing.Any):Index of font as returned by GetCurrentConsoleFontCommentsOnly exists on XP or later. - -Returns: - - PyCOORD - - """ - pass - - - def SetConsoleFont(self,Font:'typing.Any') -> 'None': - """ - Changes the font used by the screen buffer - -Args: - - Font(typing.Any):The number of the font to be setCommentsFunction is not documented on MSDN - -Returns: - - None - - """ - pass - - - def SetStdHandle(self,StdHandle:'typing.Any') -> 'None': - """ - Replaces one of calling process's standard handles with this handle - -Args: - - StdHandle(typing.Any):Specifies handle to be replaced - STD_INPUT_HANDLE, STD_OUTPUT_HANDLE, or STD_ERROR_HANDLE - -Returns: - - None - - """ - pass - - - def SetConsoleDisplayMode(self,Flags:'typing.Any',NewScreenBufferDimensions:'PyCOORD') -> 'None': - """ - Sets the display mode of the console buffer - -Args: - - Flags(typing.Any):CONSOLE_FULLSCREEN_MODE or CONSOLE_WINDOWED_MODE - NewScreenBufferDimensions(PyCOORD):New size of the screen buffer in characters - -Returns: - - None - - """ - pass - - - def WriteConsoleInput(self,Buffer:'typing.Tuple[PyINPUT_RECORD, ...]') -> 'typing.Any': - """ - Places input records in the console's input queue - -Args: - - Buffer(typing.Tuple[PyINPUT_RECORD, ...]):A sequence of PyINPUT_RECORD objectsReturn ValueReturns the number of records written - -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 - -the input queue - -Args: - - Length(typing.Any):The number of input records to readCommentsThis functions blocks until at least one record is read. The number of records returned may be less than the nbr requestedReturn ValueReturns a sequence of PyINPUT_RECORD objects - -Returns: - - typing.Tuple[PyINPUT_RECORD, ...]:The number of input records to readComments - -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 - -removing them from the input queue - -Args: - - Length(typing.Any):The number of input records to readCommentsThis function does not block as ReadConsoleInput does. The number of records returned may be less than the nbr requestedReturn ValueReturns a sequence of PyINPUT_RECORD objects - -Returns: - - typing.Tuple[PyINPUT_RECORD, ...]:The number of input records to readComments - -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 - -queue - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyCredHandle(object): - """Handle to a set of logon credentials, used with sspi authentication functions""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Detach(self,) -> 'typing.Any': - """ - Disassociates object from handle and returns integer value of handle, - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def FreeCredentialsHandle(self,) -> 'None': - """ - Releases the credentials handle and makes object unusable - -Args: - - - -Returns: - - None - - """ - pass - - - def QueryCredentialsAttributes(self,Attribute:'typing.Any') -> 'None': - """ - Returns information about the credentials - -Args: - - Attribute(typing.Any):SECPKG_* constant specifying which type of information to returnCommentsOnly SECPKG_CRED_ATTR_NAMES currently supportedAttributeReturn typeSECPKG_CRED_ATTR_NAMESPyUnicode - returns username that credentials representSECPKG_ATTR_SUPPORTED_ALGSNot supported yet SecPkgCred_SupportedAlgs:SECPKG_ATTR_CIPHER_STRENGTHSNot supported yet SecPkgCred_CipherStrengths:SECPKG_ATTR_SUPPORTED_PROTOCOLSNot supported yet SecPkgCred_SupportedProtocols:Return ValueType of returned values is dependent on Attribute - -Returns: - - None:SECPKG_* constant specifying which type of information to returnComments - -Only SECPKG_CRED_ATTR_NAMES currently supported - - - -Attribute - - -Return type - - - -SECPKG_CRED_ATTR_NAMESPyUnicode - returns username that credentials represent -SECPKG_ATTR_SUPPORTED_ALGSNot supported yet - -SecPkgCred_SupportedAlgs: -SECPKG_ATTR_CIPHER_STRENGTHSNot supported yet - -SecPkgCred_CipherStrengths: -SECPKG_ATTR_SUPPORTED_PROTOCOLSNot supported yet - -SecPkgCred_SupportedProtocols: -Return ValueType of returned values is dependent on Attribute - - - """ - pass - - -class PyCtxtHandle(object): - """Security context handle, as used with sspi functions""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Detach(self,) -> 'typing.Any': - """ - Disassociates object from handle and returns integer value of handle - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def CompleteAuthToken(self,Token:'PySecBufferDesc') -> 'None': - """ - Completes the authentication token - -Args: - - Token(PySecBufferDesc):The buffer that contains the token buffer used when the context was initializedCommentsThis method should be invoked on a context handle if the InitializeSecurityContext call that created it returned SEC_I_COMPLETE_NEEDED or SEC_I_COMPLETE_AND_CONTINUE - -Returns: - - None - - """ - pass - - - def QueryContextAttributes(self,Attribute:'typing.Any') -> 'None': - """ - Retrieves info about a security context - -Args: - - Attribute(typing.Any):SECPKG_ATTR_* constantCommentsNot all attributes are available for every security packageAttributeReturn typeSECPKG_ATTR_ACCESS_TOKENPyHANDLE - returns a handle to the context's access tokenSECPKG_ATTR_AUTHORITYPyUnicode - returns the name of the authenticating entitySECPKG_ATTR_CIPHER_STRENGTHS(int,int) - returns the mininum and maximum cipher strengths allowedSECPKG_ATTR_CONNECTION_INFOReturns a dictionary of connection info representing a SecPkgContext_ConnectionInfo structSECPKG_ATTR_SESSION_KEYstring - returns the session key for the contextSECPKG_ATTR_ISSUER_LIST_EX(int, string) - Returns names of trusted certificate issuersSECPKG_ATTR_FLAGSint - returns flags negotiated when context was establishedSECPKG_ATTR_PACKAGE_INFOdict - returns dictionary containing info for context's security packageSECPKG_ATTR_NEGOTIATION_INFO(int, dict) - returns state of negotiation (SECPKG_NEGOTIATION_COMPLETE, SECPKG_NEGOTIATION_OPTIMISTIC,SECPKG_NEGOTIATION_IN_PROGRESS) and info for negotiated packageSECPKG_ATTR_NAMESPyUnicode - returns the user name for the contextSECPKG_ATTR_SIZESdict containing buffer sizes to be used with the contextSECPKG_ATTR_PASSWORD_EXPIRYPyTime - returns time password expiresSECPKG_ATTR_LIFESPAN(PyTime,PyTime) - returns time period during which context is validSECPKG_ATTR_NATIVE_NAMES(PyUnicode,PyUnicode) - returns client and server namesSECPKG_ATTR_TARGET_INFORMATIONstring - returns the target for the contextSECPKG_ATTR_STREAM_SIZESdict (see SecPkgContext_StreamSizes) containing message buffer sizesSECPKG_ATTR_KEY_INFOdict (see SecPkgContext_KeyInfo) containing encryption key parametersSECPKG_ATTR_DCE_INFOnot supported yet SecPkgContext_DceInfoSECPKG_ATTR_LOCAL_CERT_CONTEXTnot supported yet PCCERT_CONTEXTSECPKG_ATTR_REMOTE_CERT_CONTEXTnot supported yet PCCERT_CONTEXTSECPKG_ATTR_ROOT_STOREnot supported yet HCERTCONTEXTSECPKG_ATTR_SUPPORTED_ALGSnot supported yet SecPkgCred_SupportedAlgsSECPKG_ATTR_SUPPORTED_PROTOCOLSnot supported yet SecPkgCred_SupportedProtocols - -Returns: - - None - - """ - pass - - - def DeleteSecurityContext(self,) -> 'None': - """ - Frees the security context and invalidates the handle - -Args: - - - -Returns: - - None - - """ - pass - - - def QuerySecurityContextToken(self,) -> 'typing.Any': - """ - Returns the access token for a security context - -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 - -context - -Args: - - fqop(typing.Any):Flags that indicate quality of protection desired, specific to each security package - Message(PySecBufferDesc):Buffer set that includes buffers for input data and output signature - MessageSeqNo(typing.Any):A sequential number used by some packages to verify that no extraneous messages have been receivedCommentsThe 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_TOKENReturn ValueReturns None on success, and output buffer in Message will contain the signature - -Returns: - - 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 - -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 - - - def VerifySignature(self,Message:'PySecBufferDesc',MessageSeqNo:'typing.Any') -> 'None': - """ - None - -Args: - - Message(PySecBufferDesc):SecBufferDesc that contains data buffer and signature buffer - MessageSeqNo(typing.Any):A sequential number used by some packages to verify that no extraneous messages have been receivedCommentsThe buffer configuration is dependent on the security package. Usually there is a data buffer of type SECBUFFER_DATA and a signature buffer of type SECBUFFER_TOKENReturn ValueReturns quality of protection flags used to create signature - -Returns: - - 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 - -SECBUFFER_DATA - -and a signature buffer of type SECBUFFER_TOKEN -Return ValueReturns quality of protection flags used to create signature - - - """ - pass - - - def EncryptMessage(self,fqop:'typing.Any',Message:'PySecBufferDesc',MessageSeqNo:'typing.Any') -> 'None': - """ - Encrypts data with session key of security context - -Args: - - fqop(typing.Any):Flags that indicate quality of protection desired, specific to each security package - Message(PySecBufferDesc):PySecBufferDesc that contains data buffer(s) to be encrypted - MessageSeqNo(typing.Any):A sequential number used by some packages to verify that no extraneous messages have been receivedCommentsThe 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 SECBUFFER_TOKEN to receive signature or padding dataReturn ValueReturns None on success, and buffer(s) will contain encrypted data - -Returns: - - 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 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 - - - def DecryptMessage(self,Message:'PySecBufferDesc',MessageSeqNo:'typing.Any') -> 'None': - """ - None - -Args: - - Message(PySecBufferDesc):PySecBufferDesc containing data buffers to be decrypted - MessageSeqNo(typing.Any):A sequential number used by some packages to verify that no extraneous messages have been receivedCommentsThe 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 SECBUFFER_PADDING containing signature, padding, or other extra data from encryption process that doesn't fit in first bufferReturn ValueReturns flags specfic to security package indicating quality of protection - -Returns: - - 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 - -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 - -in first buffer -Return ValueReturns flags specfic to security package indicating quality of protection - - - """ - pass - - - def ImpersonateSecurityContext(self,) -> 'None': - """ - Impersonates a client security context - -Args: - - - -Returns: - - None - - """ - pass - - - def RevertSecurityContext(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - -class PyDCB(object): - """A Python object, representing an DCB structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def BaudRate(self)->'int': - """current baud rate""" - pass - - - @property - def wReserved(self)->'int': - """not currently used""" - pass - - - @property - def XonLim(self)->'int': - """transmit XON threshold""" - pass - - - @property - def XoffLim(self)->'int': - """transmit XOFF threshold""" - pass - - - @property - def ByteSize(self)->'int': - """number of bits/byte, 4-8""" - pass - - - @property - def Parity(self)->'int': - """0-4=no,odd,even,mark,space""" - pass - - - @property - def StopBits(self)->'int': - """0,1,2 = 1, 1.5, 2""" - pass - - - @property - def XonChar(self)->'str': - """Tx and Rx XON character""" - pass - - - @property - def XoffChar(self)->'str': - """Tx and Rx XOFF character""" - pass - - - @property - def ErrorChar(self)->'str': - """error replacement character""" - pass - - - @property - def EofChar(self)->'str': - """end of input character""" - pass - - - @property - def EvtChar(self)->'str': - """received event character""" - pass - - - @property - def wReserved1(self)->'int': - """reserved; do not use""" - pass - - - @property - def fBinary(self)->'int': - """binary mode, no EOF check""" - pass - - - @property - def fParity(self)->'int': - """enable parity checking""" - pass - - - @property - def fOutxCtsFlow(self)->'int': - """CTS output flow control""" - pass - - - @property - def fOutxDsrFlow(self)->'int': - """DSR output flow control""" - pass - - - @property - def fDtrControl(self)->'int': - """DTR flow control type""" - pass - - - @property - def fDsrSensitivity(self)->'int': - """DSR sensitivity""" - pass - - - @property - def fTXContinueOnXoff(self)->'int': - """XOFF continues Tx""" - pass - - - @property - def fOutX(self)->'int': - """XON/XOFF out flow control""" - pass - - - @property - def fInX(self)->'int': - """XON/XOFF in flow control""" - pass - - - @property - def fErrorChar(self)->'int': - """enable error replacement""" - pass - - - @property - def fNull(self)->'int': - """enable null stripping""" - pass - - - @property - def fRtsControl(self)->'int': - """RTS flow control""" - pass - - - @property - def fAbortOnError(self)->'int': - """abort on error""" - pass - - - @property - def fDummy2(self)->'int': - """reserved""" - pass - - -class PyDEVMODE(object): - """Python object wrapping a DEVMODE structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def SpecVersion(self)->'typing.Any': - """Should always be set to DM_SPECVERSION""" - pass - - - @property - def DriverVersion(self)->'typing.Any': - """Version nbr assigned to printer driver by vendor""" - pass - - - @property - def Size(self)->'typing.Any': - """Size of structure""" - pass - - - @property - def DriverExtra(self)->'typing.Any': - """Number of extra bytes allocated for driver data, can only be set when new object is created""" - pass - - - @property - def Fields(self)->'typing.Any': - """Bitmask of win32con.DM_* constants indicating which members are set""" - pass - - - @property - def Orientation(self)->'typing.Any': - """Only applies to printers, DMORIENT_PORTRAIT or DMORIENT_LANDSCAPE""" - pass - - - @property - def PaperSize(self)->'typing.Any': - """Use 0 if PaperWidth and PaperLength are set, otherwise win32con.DMPAPER_* constant""" - pass - - - @property - def PaperLength(self)->'typing.Any': - """Specified in 1/10 millimeters""" - pass - - - @property - def PaperWidth(self)->'typing.Any': - """Specified in 1/10 millimeters""" - pass - - - @property - def Position_x(self)->'typing.Any': - """Position of display relative to desktop""" - pass - - - @property - def Position_y(self)->'typing.Any': - """Position of display relative to desktop""" - pass - - - @property - def DisplayOrientation(self)->'typing.Any': - """Display rotation: DMDO_DEFAULT,DMDO_90, DMDO_180, DMDO_270""" - pass - - - @property - def DisplayFixedOutput(self)->'typing.Any': - """DMDFO_DEFAULT, DMDFO_CENTER, DMDFO_STRETCH""" - pass - - - @property - def Scale(self)->'typing.Any': - """Specified as percentage, eg 50 means half size of original""" - pass - - - @property - def Copies(self)->'typing.Any': - """Nbr of copies to print""" - pass - - - @property - def DefaultSource(self)->'typing.Any': - """DMBIN_* constant, or can be a printer-specific value""" - pass - - - @property - def PrintQuality(self)->'typing.Any': - """DMRES_* constant, interpreted as DPI if positive""" - pass - - - @property - def Color(self)->'typing.Any': - """DMCOLOR_COLOR or DMCOLOR_MONOCHROME""" - pass - - - @property - def Duplex(self)->'typing.Any': - """For printers that do two-sided printing: DMDUP_SIMPLEX, DMDUP_HORIZONTAL, DMDUP_VERTICAL""" - pass - - - @property - def YResolution(self)->'typing.Any': - """Vertical printer resolution in DPI - if this is set, PrintQuality indicates horizontal DPI""" - pass - - - @property - def TTOption(self)->'typing.Any': - """TrueType options: DMTT_BITMAP, DMTT_DOWNLOAD, DMTT_DOWNLOAD_OUTLINE, DMTT_SUBDEV""" - pass - - - @property - def Collate(self)->'typing.Any': - """DMCOLLATE_TRUE or DMCOLLATE_FALSE""" - pass - - - @property - def LogPixels(self)->'typing.Any': - """Pixels per inch (only for display devices""" - pass - - - @property - def BitsPerPel(self)->'typing.Any': - """Color resolution in bits per pixel""" - pass - - - @property - def PelsWidth(self)->'typing.Any': - """Pixel width of display""" - pass - - - @property - def PelsHeight(self)->'typing.Any': - """Pixel height of display""" - pass - - - @property - def DisplayFlags(self)->'typing.Any': - """Combination of DM_GRAYSCALE and DM_INTERLACED""" - pass - - - @property - def DisplayFrequency(self)->'typing.Any': - """Refresh rate""" - pass - - - @property - def ICMMethod(self)->'typing.Any': - """Indicates where ICM is performed, one of win32con.DMICMMETHOD_* values""" - pass - - - @property - def ICMIntent(self)->'typing.Any': - """Intent of ICM, one of win32con.DMICM_* values""" - pass - - - @property - def MediaType(self)->'typing.Any': - """win32con.DMMEDIA_*, can also be a printer-specific value greater then DMMEDIA_USER""" - pass - - - @property - def DitherType(self)->'typing.Any': - """Dithering option, win32con.DMDITHER_*""" - pass - - - @property - def Reserved1(self)->'typing.Any': - """Reserved, use only 0""" - pass - - - @property - def Reserved2(self)->'typing.Any': - """Reserved, use only 0""" - pass - - - @property - def Nup(self)->'typing.Any': - """Controls printing of multiple logical pages per physical page, DMNUP_SYSTEM or DMNUP_ONEUP""" - pass - - - @property - def PanningWidth(self)->'typing.Any': - """Not used, leave as 0""" - pass - - - @property - def PanningHeight(self)->'typing.Any': - """Not used, leave as 0""" - pass - - - @property - def DeviceName(self)->'typing.Any': - """String of at most 32 chars""" - pass - - - @property - def FormName(self)->'typing.Any': - """Name of form as returned by win32print::EnumForms, at most 32 chars""" - pass - - - @property - def DriverData(self)->'typing.Any': - """Driver data appended to end of structure""" - pass - - - def Clear(self,) -> 'None': - """ - Resets all members of the structure - -Args: - - - -Returns: - - None - - """ - pass - - -class PyDEVMODEW(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def SpecVersion(self)->'typing.Any': - """Should always be set to DM_SPECVERSION""" - pass - - - @property - def DriverVersion(self)->'typing.Any': - """Version nbr assigned to printer driver by vendor""" - pass - - - @property - def Size(self)->'typing.Any': - """Size of structure""" - pass - - - @property - def DriverExtra(self)->'typing.Any': - """Number of extra bytes allocated for driver data, can only be set when new object is created""" - pass - - - @property - def Fields(self)->'typing.Any': - """Bitmask of win32con.DM_* constants indicating which members are set""" - pass - - - @property - def Orientation(self)->'typing.Any': - """Only applies to printers, DMORIENT_PORTRAIT or DMORIENT_LANDSCAPE""" - pass - - - @property - def PaperSize(self)->'typing.Any': - """Use 0 if PaperWidth and PaperLength are set, otherwise win32con.DMPAPER_* constant""" - pass - - - @property - def PaperLength(self)->'typing.Any': - """Specified in 1/10 millimeters""" - pass - - - @property - def PaperWidth(self)->'typing.Any': - """Specified in 1/10 millimeters""" - pass - - - @property - def Position_x(self)->'typing.Any': - """Position of display relative to desktop""" - pass - - - @property - def Position_y(self)->'typing.Any': - """Position of display relative to desktop""" - pass - - - @property - def DisplayOrientation(self)->'typing.Any': - """Display rotation: DMDO_DEFAULT,DMDO_90, DMDO_180, DMDO_270""" - pass - - - @property - def DisplayFixedOutput(self)->'typing.Any': - """DMDFO_DEFAULT, DMDFO_CENTER, DMDFO_STRETCH""" - pass - - - @property - def Scale(self)->'typing.Any': - """Specified as percentage, eg 50 means half size of original""" - pass - - - @property - def Copies(self)->'typing.Any': - """Nbr of copies to print""" - pass - - - @property - def DefaultSource(self)->'typing.Any': - """DMBIN_* constant, or can be a printer-specific value""" - pass - - - @property - def PrintQuality(self)->'typing.Any': - """DMRES_* constant, interpreted as DPI if positive""" - pass - - - @property - def Color(self)->'typing.Any': - """DMCOLOR_COLOR or DMCOLOR_MONOCHROME""" - pass - - - @property - def Duplex(self)->'typing.Any': - """For printers that do two-sided printing: DMDUP_SIMPLEX, DMDUP_HORIZONTAL, DMDUP_VERTICAL""" - pass - - - @property - def YResolution(self)->'typing.Any': - """Vertical printer resolution in DPI - if this is set, PrintQuality indicates horizontal DPI""" - pass - - - @property - def TTOption(self)->'typing.Any': - """TrueType options: DMTT_BITMAP, DMTT_DOWNLOAD, DMTT_DOWNLOAD_OUTLINE, DMTT_SUBDEV""" - pass - - - @property - def Collate(self)->'typing.Any': - """DMCOLLATE_TRUE or DMCOLLATE_FALSE""" - pass - - - @property - def LogPixels(self)->'typing.Any': - """Pixels per inch (only for display devices""" - pass - - - @property - def BitsPerPel(self)->'typing.Any': - """Color resolution in bits per pixel""" - pass - - - @property - def PelsWidth(self)->'typing.Any': - """Pixel width of display""" - pass - - - @property - def PelsHeight(self)->'typing.Any': - """Pixel height of display""" - pass - - - @property - def DisplayFlags(self)->'typing.Any': - """Combination of DM_GRAYSCALE and DM_INTERLACED""" - pass - - - @property - def DisplayFrequency(self)->'typing.Any': - """Refresh rate""" - pass - - - @property - def ICMMethod(self)->'typing.Any': - """Indicates where ICM is performed, one of win32con.DMICMMETHOD_* values""" - pass - - - @property - def ICMIntent(self)->'typing.Any': - """Intent of ICM, one of win32con.DMICM_* values""" - pass - - - @property - def MediaType(self)->'typing.Any': - """win32con.DMMEDIA_*, can also be a printer-specific value greater then DMMEDIA_USER""" - pass - - - @property - def DitherType(self)->'typing.Any': - """Dithering option, win32con.DMDITHER_*""" - pass - - - @property - def Reserved1(self)->'typing.Any': - """Reserved, use only 0""" - pass - - - @property - def Reserved2(self)->'typing.Any': - """Reserved, use only 0""" - pass - - - @property - def Nup(self)->'typing.Any': - """Controls printing of multiple logical pages per physical page, DMNUP_SYSTEM or DMNUP_ONEUP""" - pass - - - @property - def PanningWidth(self)->'typing.Any': - """Not used, leave as 0""" - pass - - - @property - def PanningHeight(self)->'typing.Any': - """Not used, leave as 0""" - pass - - - @property - def DeviceName(self)->'str': - """String of at most 32 chars""" - pass - - - @property - def FormName(self)->'typing.Any': - """Name of form as returned by win32print::EnumForms, at most 32 chars""" - pass - - - @property - def DriverData(self)->'typing.Any': - """Driver data appended to end of structure""" - pass - - -class PyDISPLAY_DEVICE(object): - """Python object wrapping a DISPLAY_DEVICE structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Size(self)->'typing.Any': - """Size of structure""" - pass - - - @property - def DeviceName(self)->'typing.Any': - """String of at most 32 chars""" - pass - - - @property - def DeviceString(self)->'typing.Any': - """String of at most 128 chars""" - pass - - - @property - def StateFlags(self)->'typing.Any': - """Bitmask of win32con.DISPLAY_DEVICE_* constants indicating current device status""" - pass - - - @property - def DeviceID(self)->'typing.Any': - """String of at most 128 chars""" - pass - - - @property - def DeviceKey(self)->'typing.Any': - """String of at most 128 chars""" - pass - - - def Clear(self,) -> 'None': - """ - Resets all members of the structure - -Args: - - - -Returns: - - None - - """ - pass - - -class PyDLGITEMTEMPLATE(object): - """A tuple describing a control in a dialog box.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyDLGTEMPLATE(object): - """A tuple of items describing a dialog box, that can be used to create the dialog.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyDS_HANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyDS_NAME_RESULT_ITEM(object): - """A tuple representing a DS_NAME_RESULT_ITEM""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyDateTime(object): - """A Python object, representing an instant in time.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Format(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyDialogTemplate(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyEVTLOG_HANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyEVT_HANDLE(object): - """Handle to an event log, session, query, or any other object used with - -the Evt* event log functions on Vista and later. - -When the object is destroyed, EvtClose is called.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyEVT_RPC_LOGIN(object): - """Tuple containing login credentials for a remote Event Log connection""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyEventLogRecord(object): - """An object containing the data in an EVENTLOGRECORD.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Reserved(self)->'int': - """""" - pass - - - @property - def RecordNumber(self)->'int': - """""" - pass - - - @property - def TimeGenerated(self)->'PyTime': - """""" - pass - - - @property - def TimeWritten(self)->'PyTime': - """""" - pass - - - @property - def EventID(self)->'int': - """""" - pass - - - @property - def EventType(self)->'int': - """""" - pass - - - @property - def EventCategory(self)->'int': - """""" - pass - - - @property - def ReservedFlags(self)->'int': - """""" - pass - - - @property - def ClosingRecordNumber(self)->'int': - """""" - pass - - - @property - def SourceName(self)->'str': - """""" - pass - - - @property - def StringInserts(self)->'typing.Tuple[str, ...]': - """""" - pass - - - @property - def Sid(self)->'PySID': - """""" - pass - - - @property - def Data(self)->'str': - """""" - pass - - - @property - def ComputerName(self)->'str': - """""" - pass - - -class PyGROUP_INFO_0(object): - """A dictionary holding the information in a Win32 GROUP_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """Name of the group""" - pass - - -class PyGROUP_INFO_1(object): - """A dictionary holding the information in a Win32 GROUP_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """Name of the group""" - pass - - - @property - def comment(self)->'typing.Union[str]': - """The group's comment.""" - pass - - -class PyGROUP_INFO_1002(object): - """A dictionary holding the information in a Win32 GROUP_INFO_1002 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def comment(self)->'typing.Union[str]': - """""" - pass - - -class PyGROUP_INFO_1005(object): - """A dictionary holding the information in a Win32 GROUP_INFO_1005 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def attributes(self)->'typing.Any': - """""" - pass - - -class PyGROUP_INFO_2(object): - """A dictionary holding the information in a Win32 GROUP_INFO_2 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """Name of the group""" - pass - - - @property - def comment(self)->'typing.Union[str]': - """The group's comment.""" - pass - - - @property - def group_id(self)->'typing.Any': - """""" - pass - - - @property - def attributes(self)->'typing.Any': - """""" - pass - - -class PyGROUP_USERS_INFO_0(object): - """A dictionary holding the information in a Win32 GROUP_USERS_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """Name of the group or user""" - pass - - -class PyGROUP_USERS_INFO_1(object): - """A dictionary holding the information in a Win32 GROUP_USERS_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """Name of the group or user""" - pass - - - @property - def attributes(self)->'typing.Any': - """""" - pass - - -class PyGdiHANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyGetSignerCertificate(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyHANDLE(object): - """A Python object, representing a win32 HANDLE.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def handle(self)->'typing.Any': - """Integer value of the handleMethodsCloseCloses the handle closeSynonym for PyHANDLE::Close DetachDetaches the Win32 handle from the handle object. __nonzero__Used for detecting true/false. is nb_bool in Python 3.0 __int__Used when an integer representation of the handle object is required. __print__Used when the object is printed. tp_print __hash__Used when the hash value of an object is required tp_hash __str__Used when a string representation is required tp_str """ - pass - - - def Close(self,) -> 'None': - """ - Closes the underlying Win32 handle. - -Args: - - - -Returns: - - None - - """ - pass - - - def close(self,) -> 'None': - """ - Closes the underlying Win32 handle. - -Args: - - - -Returns: - - None - - """ - pass - - - def Detach(self,) -> 'typing.Any': - """ - Detaches the Win32 handle from the handle object. - -Args: - - - -Returns: - - typing.Any:PyHANDLE.Detach - -int = Detach()Detaches the Win32 handle from the handle object. -Comments - -After calling this function, the handle is effectively invalidated, - -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 - -handle object. -Return ValueThe result is the value of the handle before it is detached. If the - -handle is already detached, this will return zero. - - - """ - pass - - -class PyHDESK(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetThreadDesktop(self,) -> 'None': - """ - Assigns this desktop to the calling thread - -Args: - - - -Returns: - - None - - """ - pass - - - def EnumDesktopWindows(self,) -> 'typing.Tuple[int, ...]': - """ - Returns a list of handles to all top-level windows on desktop - -Args: - - - -Returns: - - typing.Tuple[int, ...] - - """ - pass - - - def SwitchDesktop(self,) -> 'None': - """ - Activates the desktop - -Args: - - - -Returns: - - None - - """ - pass - - - def CloseDesktop(self,) -> 'None': - """ - Closes the desktop handle - -Args: - - - -Returns: - - None - - """ - pass - - -class PyHDEVNOTIFY(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyHHNTRACK(object): - """A Python object, representing an HHNTRACK - -structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def action(self)->'typing.Any': - """Specifies the action the user is about to take. This is an HHACT_ constant.""" - pass - - - @property - def hdr(self)->'typing.Any': - """Standard WM_NOTIFY header(win32help::NMHDR).""" - pass - - - @property - def curUrl(self)->'str': - """A multi-byte, zero-terminated string that specifies the topic navigated to, or the name of the help window being created.""" - pass - - - @property - def winType(self)->'typing.Any': - """A pointer to the current HH_WINTYPE structure (win32help::HH_WINTYPE).""" - pass - - -class PyHHN_NOTIFY(object): - """A Python object, representing an HHN_NOTIFY - -structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def hdr(self)->'typing.Any': - """Standard WM_NOTIFY header.(win32help::NMHDR)""" - pass - - - @property - def url(self)->'str': - """A multi-byte, zero-terminated string that specifies the topic navigated to, or the name of the help window being created.""" - pass - - -class PyHH_AKLINK(object): - """A Python object, representing an HH_AKLINK structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def indexOnFail(self)->'typing.Any': - """Specifies whether to display the keyword in the Index tab of the HTML Help Viewer if the lookup fails. The value of window specifies the Help Viewer.""" - pass - - - @property - def keywords(self)->'str': - """Specifies one or more ALink names or KLink keywords to look up. Multiple entries are delimited by a semicolon.""" - pass - - - @property - def url(self)->'str': - """Specifies the topic file to navigate to if the lookup fails. url refers to a valid topic within the specified compiled help (.chm) file and does not support Internet protocols that point to an HTML file.""" - pass - - - @property - def msgText(self)->'str': - """Specifies the text to display in a message box if the lookup fails and indexOnFail is FALSE and url is NULL.""" - pass - - - @property - def msgTitle(self)->'str': - """Specifies the caption of the message box in which the msgText parameter appears.""" - pass - - - @property - def window(self)->'str': - """Specifies the name of the window type in which to display one of the following: The selected topic, if the lookup yields one or more matching topics. The topic specified in url, if the lookup fails and a topic is specified in url. The Index tab, if the lookup fails and indexOnFail is specified as TRUE.""" - pass - - -class PyHH_FTS_QUERY(object): - """A Python object, representing an HH_FTS_QUERY - -structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def uniCodeStrings(self)->'typing.Any': - """TRUE if all strings are Unicode.""" - pass - - - @property - def proximity(self)->'typing.Any': - """Word proximity.""" - pass - - - @property - def stemmedSearch(self)->'typing.Any': - """TRUE for StemmedSearch only.""" - pass - - - @property - def titleOnly(self)->'typing.Any': - """TRUE for Title search only.""" - pass - - - @property - def execute(self)->'typing.Any': - """TRUE to initiate the search.""" - pass - - - @property - def searchQuery(self)->'str': - """String containing the search query.""" - pass - - -class PyHH_POPUP(object): - """A Python object, representing an HH_POPUP structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def hinst(self)->'typing.Any': - """Instance handle of the program or DLL to retrieve the string resource from. Ignored if idString is zero.""" - pass - - - @property - def idString(self)->'typing.Any': - """Specifies zero, or a resource ID in the program or DLL specified in hinst.""" - pass - - - @property - def clrForeground(self)->'typing.Any': - """Specifies the RGB value to use for the foreground color of the pop-up window. To use the system color for the window text, specify -1.""" - pass - - - @property - def clrBackground(self)->'typing.Any': - """Specifies the RGB value to use for the background color of the pop-up window. To use the system color for the window background, specify -1.""" - pass - - - @property - def text(self)->'str': - """Specifies the text to display if idString is zero.""" - pass - - - @property - def font(self)->'str': - """Specifies the font attributes to use for the text in the pop-up window. Use the following format to specify font family, point size, character set, and font format: facename[, point size[, charset[ BOLD ITALIC UNDERLINE]]] To omit an attribute, enter a comma. For example, to specify bold, 10-pt, MS Sans Serif font, font would be: MS Sans Serif, 10, , BOLD""" - pass - - - @property - def pt(self)->'typing.Any': - """(x,y). Specifies (in pixels) where the top center of the pop-up window should be located.""" - pass - - - @property - def margins(self)->'typing.Any': - """(left,top,right,bottom). Specifies (in pixels) the margins to use on the left, top, right, and bottom sides of the pop-up window. The default for all rectangle members is -1.""" - pass - - -class PyHH_WINTYPE(object): - """A Python object, representing an HH_WINTYPE structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def uniCodeStrings(self)->'typing.Any': - """Specifies whether the strings used in this structure are UNICODE.""" - pass - - - @property - def validMembers(self)->'typing.Any': - """Specifies which members in the structure are valid.""" - pass - - - @property - def winProperties(self)->'typing.Any': - """Specifies the properties of the window, such as whether it is the standard HTML Help Viewer or whether it includes a Search tab.""" - pass - - - @property - def styles(self)->'typing.Any': - """Specifies the styles used to create the window. These styles can be ignored, combined with extended styles, or used exclusively depending on the value of the validMembers and winProperties parameters.""" - pass - - - @property - def exStyles(self)->'typing.Any': - """Specifies the extended styles used to create the window. These styles can be ignored, combined with default styles, or used exclusively depending on the value of the validMembers and winProperties parameters.""" - pass - - - @property - def showState(self)->'typing.Any': - """Specifies the initial display state of the window. Valid values are the same as those for the Win32 API ShowWindow function.""" - pass - - - @property - def hwndHelp(self)->'typing.Any': - """Specifies the handle of the window if the window has been created.""" - pass - - - @property - def hwndCaller(self)->'typing.Any': - """Specifies the window that will receive HTML Help notification messages. Notification messages are sent via Windows WM_NOTIFY messages.""" - pass - - - @property - def hwndToolBar(self)->'typing.Any': - """Specifies the handle of the toolbar.""" - pass - - - @property - def hwndNavigation(self)->'typing.Any': - """Specifies the handle of the Navigation pane.""" - pass - - - @property - def hwndHTML(self)->'typing.Any': - """Specifies the handle of the Topic pane, which hosts Shdocvw.dll.""" - pass - - - @property - def navWidth(self)->'typing.Any': - """Specifies the width of the Navigation pane when the Help Viewer is expanded.""" - pass - - - @property - def toolBarFlags(self)->'typing.Any': - """Specifies which buttons to include on the toolbar.""" - pass - - - @property - def notExpanded(self)->'typing.Any': - """Specifies that the Help Viewer open with the Navigation pane closed.""" - pass - - - @property - def curNavType(self)->'typing.Any': - """Specifies the default tab to display on the Navigation pane.""" - pass - - - @property - def idNotify(self)->'typing.Any': - """Specifies a non-zero ID for enabling HTML Help notification messages. This ID is passed as the wParam value of Windows WM_NOTIFY messages.""" - pass - - - @property - def typeName(self)->'str': - """A null-terminated string that specifies the name of the window type.""" - pass - - - @property - def caption(self)->'str': - """A null-terminated string that specifies the caption to display in the title bar of the window.""" - pass - - - @property - def windowPos(self)->'typing.Any': - """(left,top,right,bottom). Specifies the coordinates of the window in pixels.""" - pass - - - @property - def HTMLPos(self)->'typing.Any': - """(left,top,right,bottom). Specifies the coordinates of the Topic pane.""" - pass - - - @property - def toc(self)->'str': - """Specifies the contents (.hhc) file to display in the Navigation pane.""" - pass - - - @property - def index(self)->'str': - """Specifies the index (.hhk) file to display in the Navigation pane.""" - pass - - - @property - def file(self)->'str': - """Specifies the default HTML file to display in the Topic pane.""" - pass - - - @property - def home(self)->'str': - """Specifies the file or URL to display in the Topic pane when the Home button is clicked.""" - pass - - - @property - def jump1(self)->'str': - """Specifies the text to display underneath the Jump1 button.""" - pass - - - @property - def jump2(self)->'str': - """Specifies the text to display underneath the Jump2 button.""" - pass - - - @property - def urlJump1(self)->'str': - """Specifies the URL to jump to when the Jump1 button is clicked.""" - pass - - - @property - def urlJump2(self)->'str': - """Specifies the URL to jump to when the Jump2 button is clicked.""" - pass - - -class PyHINTERNET(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyHKEY(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyHTHEME(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyHWINSTA(object): - """Wrapper for a handle to a window station - returned by CreateWindowStation, OpenWindowStation, or GetProcessWindowStation""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def EnumDesktops(self,) -> 'typing.Tuple[typing.Any, ...]': - """ - Lists names of desktops in the window station - -Args: - - - -Returns: - - typing.Tuple[typing.Any, ...] - - """ - pass - - - def SetProcessWindowStation(self,) -> 'None': - """ - Associates the calling process with the window station - -Args: - - - -Returns: - - None - - """ - pass - - - def CloseWindowStation(self,) -> 'None': - """ - Closes the window station handle - -Args: - - - -Returns: - - None - - """ - pass - - -class PyICONINFO(object): - """Tuple describing an icon or cursor""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIID(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyINPUT_RECORD(object): - """Interface to the INPUT_RECORD struct used with console IO functions. Create using - -PyINPUT_RECORDType(EventType)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def EventType(self)->'typing.Any': - """One of KEY_EVENT, MOUSE_EVENT, WINDOW_BUFFER_SIZE_EVENT, MENU_EVENT, FOCUS_EVENT. Cannot be changed after object is created""" - pass - - - @property - def KeyDown(self)->'typing.Any': - """True for a key press, False for key release""" - pass - - - @property - def RepeatCount(self)->'typing.Any': - """Nbr of repeats generated (key was held down if >1)""" - pass - - - @property - def VirtualKeyCode(self)->'typing.Any': - """Device-independent key code, win32con.VK_*""" - pass - - - @property - def VirtualScanCode(self)->'typing.Any': - """Device-dependent scan code generated by keyboard""" - pass - - - @property - def Char(self)->'str': - """Single unicode character generated by the keypress""" - pass - - - @property - def ControlKeyState(self)->'typing.Any': - """State of modifier keys, combination of CAPSLOCK_ON, ENHANCED_KEY, LEFT_ALT_PRESSED, LEFT_CTRL_PRESSED, NUMLOCK_ON, RIGHT_ALT_PRESSED, RIGHT_CTRL_PRESSED, SCROLLLOCK_ON, SHIFT_PRESSED""" - pass - - - @property - def ButtonState(self)->'typing.Any': - """Bitmask representing which mouse buttons were pressed.""" - pass - - - @property - def EventFlags(self)->'typing.Any': - """DOUBLE_CLICK, MOUSE_MOVED or MOUSE_WHEELED, or 0. If 0, indicates a mouse button press""" - pass - - - @property - def MousePosition(self)->'PyCOORD': - """Position in character coordinates""" - pass - - - @property - def Size(self)->'PyCOORD': - """New size of screen buffer in character rows/columns""" - pass - - - @property - def SetFocus(self)->'typing.Any': - """Reserved - Used only with type FOCUS_EVENT. This event is Reserved, and should be ignored.""" - pass - - - @property - def CommandId(self)->'typing.Any': - """Used only with event type MENU_EVENT, which is reserved and should not be used""" - pass - - -class PyLOCALGROUP_INFO_0(object): - """A dictionary holding the information in a Win32 LOCALGROUP_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """Name of the group""" - pass - - -class PyLOCALGROUP_INFO_1(object): - """A dictionary holding the information in a Win32 LOCALGROUP_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """Name of the group""" - pass - - - @property - def comment(self)->'typing.Union[str]': - """The group's comment.""" - pass - - -class PyLOCALGROUP_INFO_1002(object): - """A dictionary holding the information in a Win32 LOCALGROUP_INFO_1002 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def comment(self)->'typing.Union[str]': - """""" - pass - - -class PyLOCALGROUP_MEMBERS_INFO_0(object): - """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_0 - -structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def sid(self)->'PySID': - """""" - pass - - -class PyLOCALGROUP_MEMBERS_INFO_1(object): - """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_1 - -structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def sid(self)->'PySID': - """""" - pass - - - @property - def sidusage(self)->'typing.Any': - """""" - pass - - - @property - def name(self)->'typing.Union[str]': - """""" - pass - - -class PyLOCALGROUP_MEMBERS_INFO_2(object): - """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_2 - -structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def sid(self)->'PySID': - """""" - pass - - - @property - def sidusage(self)->'typing.Any': - """""" - pass - - - @property - def domainandname(self)->'typing.Union[str]': - """string containing the name of the member prefixed by the domain name and the "\\" separator character""" - pass - - -class PyLOCALGROUP_MEMBERS_INFO_3(object): - """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_3 - -structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def domainandname(self)->'typing.Union[str]': - """string containing the name of the member prefixed by the domain name and the "\\" separator character""" - pass - - -class PyLOGBRUSH(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Style(self)->'typing.Any': - """Brush style, one of win32con.BS_* values""" - pass - - - @property - def Color(self)->'typing.Any': - """RGB color value. Can also be DIB_PAL_COLORS or DIB_RGB_COLORS if Style is BS_DIBPATTERN or BS_DIBPATTERNPT=""" - pass - - - @property - def Hatch(self)->'typing.Union[int, typing.Any]': - """For BS_HATCH style, one of win32con.HS_*. Not used For BS_SOLID or BS_HOLLOW. For a pattern brush, this should be a handle to a bitmap""" - pass - - -class PyLOGFONT(object): - """A Python object, representing an PyLOGFONT structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def lfHeight(self)->'int': - """""" - pass - - - @property - def lfWidth(self)->'int': - """""" - pass - - - @property - def lfEscapement(self)->'int': - """""" - pass - - - @property - def lfOrientation(self)->'int': - """""" - pass - - - @property - def lfWeight(self)->'int': - """""" - pass - - - @property - def lfItalic(self)->'int': - """""" - pass - - - @property - def lfUnderline(self)->'int': - """""" - pass - - - @property - def lfStrikeOut(self)->'int': - """""" - pass - - - @property - def lfCharSet(self)->'int': - """""" - pass - - - @property - def lfOutPrecision(self)->'int': - """""" - pass - - - @property - def lfClipPrecision(self)->'int': - """""" - pass - - - @property - def lfQuality(self)->'int': - """""" - pass - - - @property - def lfPitchAndFamily(self)->'int': - """""" - pass - - - @property - def lfFaceName(self)->'str': - """Name of the typeface, at most 31 characters""" - pass - - -class PyLSA_HANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyLUID_AND_ATTRIBUTES(object): - """A sequence containing (LUID,Attributes) representing an LUID_AND_ATTRIBUTES structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyLsaLogon_HANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyMSG(object): - """A tuple representing a win32 MSG structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyNETRESOURCE(object): - """A Python object that encapsulates a Win32 NETRESOURCE structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwScope(self)->'int': - """""" - pass - - - @property - def dwType(self)->'int': - """""" - pass - - - @property - def dwDisplayType(self)->'int': - """""" - pass - - - @property - def dwUsage(self)->'int': - """""" - pass - - - @property - def localName(self)->'str': - """""" - pass - - - @property - def remoteName(self)->'str': - """""" - pass - - - @property - def comment(self)->'str': - """""" - pass - - - @property - def provider(self)->'str': - """""" - pass - - -class PyNET_VALIDATE_AUTHENTICATION_INPUT_ARG(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyNET_VALIDATE_PASSWORD_CHANGE_INPUT_ARG(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyNET_VALIDATE_PERSISTED_FIELDS(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyNMHDR(object): - """A Python object, representing an NMHDR - -structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def hwndFrom(self)->'typing.Any': - """Window handle to the control sending a message. ??? 64-bit problem here ???""" - pass - - - @property - def idFrom(self)->'typing.Any': - """Identifier of the control sending a message.""" - pass - - - @property - def code(self)->'typing.Any': - """Notification code. This member can be a control-specific notification code or it can be one of the common notification codes.""" - pass - - -class PyNOTIFYICONDATA(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyOVERLAPPED(object): - """A Python object, representing an overlapped structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Offset(self)->'int': - """Specifies a file position at which to start the transfer. The file position is a byte offset from the start of the file. The calling process sets this member before calling the ReadFile or WriteFile function. This member is ignored when reading from or writing to named pipes and communications devices.""" - pass - - - @property - def OffsetHigh(self)->'int': - """Specifies the high word of the byte offset at which to start the transfer.""" - pass - - - @property - def object(self)->'typing.Any': - """Any python object that you want to attach to your overlapped I/O request.""" - pass - - - @property - def dword(self)->'typing.Any': - """An integer buffer that may be used by overlapped functions (eg, win32file::WaitCommEvent)""" - pass - - - @property - def hEvent(self)->'int': - """Identifies an event set to the signaled state when the transfer has been completed. The calling process sets this member before calling the win32file::ReadFile, win32file::WriteFile, win32pipe::ConnectNamedPipe, or win32pipe::TransactNamedPipe function.""" - pass - - - @property - def Internal(self)->'int': - """Reserved for operating system use. (pointer-sized value)""" - pass - - - @property - def InternalHigh(self)->'int': - """Reserved for operating system use. (pointer-sized value)""" - pass - - -class PyOVERLAPPEDReadBuffer(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyPERF_COUNTER_DEFINITION(object): - """An object encapsulating a Windows NT Performance Monitor counter definition - -(PERF_COUNTER_DEFINITION).""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def DefaultScale(self)->'int': - """The default scale of the counter.""" - pass - - - @property - def DetailLevel(self)->'int': - """The detail level of the counter.""" - pass - - - @property - def CounterType(self)->'int': - """The counter type.""" - pass - - - @property - def CounterNameTitleIndex(self)->'int': - """""" - pass - - - @property - def CounterHelpTitleIndex(self)->'int': - """Sentinel""" - pass - - - def Increment(self,) -> 'None': - """ - Increments the value of the performance counter - -Args: - - - -Returns: - - None - - """ - pass - - - def Decrement(self,) -> 'None': - """ - Decrements the value of the performance counter - -Args: - - - -Returns: - - None - - """ - pass - - - def Set(self,) -> 'None': - """ - Sets the counter to a specific value - -Args: - - - -Returns: - - None - - """ - pass - - - def Get(self,) -> 'None': - """ - Gets the current value of the counter - -Args: - - - -Returns: - - None - - """ - pass - - -class PyPERF_OBJECT_TYPE(object): - """A Python object, representing a PERF_OBJECT_TYPE structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ObjectNameTitleIndex(self)->'int': - """""" - pass - - - @property - def ObjectHelpTitleIndex(self)->'int': - """""" - pass - - - @property - def DefaultCounterIndex(self)->'int': - """""" - pass - - - def Close(self,) -> 'None': - """ - Closes the object. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyPOINT(object): - """Tuple of two ints (x,y) representing a POINT struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyPROFILEINFO(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def UserName(self)->'str': - """Name of user for which to load profile""" - pass - - - @property - def Flags(self)->'typing.Any': - """Combination of PI_* flags""" - pass - - - @property - def ProfilePath(self)->'str': - """Path to roaming profile, can be None. Use win32net::NetUserGetInfo to retrieve user's profile path""" - pass - - - @property - def DefaultPath(self)->'str': - """Path to Default user profile, can be None""" - pass - - - @property - def ServerName(self)->'str': - """Domain controller, can be None""" - pass - - - @property - def PolicyPath(self)->'str': - """Location of policy file, can be None""" - pass - - - @property - def Profile(self)->'PyHKEY': - """Handle to root of user's registry key. This member is output.""" - pass - - -class PyPerfMonManager(object): - """A Python object""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Close(self,) -> 'None': - """ - Closes the performance monitor manager. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyPrinterHANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyRECT(object): - """Tuple of 4 ints defining a rectangle: (left, top, right, bottom)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyResourceId(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySCROLLINFO(object): - """A tuple representing a SCROLLINFO structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySC_HANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySECURITY_ATTRIBUTES(object): - """A Python object, representing a SECURITY_ATTRIBUTES structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def bInheritHandle(self)->'typing.Any': - """Specifies whether the returned handle is inherited when a new process is created. If this member is TRUE, the new process inherits the handle.""" - pass - - - @property - def SECURITY_DESCRIPTOR(self)->'PySECURITY_DESCRIPTOR': - """A PySECURITY_DESCRIPTOR, or None""" - pass - - -class PySECURITY_DESCRIPTOR(object): - """A Python object, representing a SECURITY_DESCRIPTOR structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,) -> 'None': - """ - Initialize the SD. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetSecurityDescriptorOwner(self,) -> 'PySID': - """ - Return the owner of the security descriptor. - -Args: - - - -Returns: - - PySID - - """ - pass - - - def GetSecurityDescriptorDacl(self,) -> 'PyACL': - """ - Return the discretionary ACL of the security - -descriptor. - -Args: - - - -Returns: - - PyACL - - """ - pass - - - def GetSecurityDescriptorSacl(self,) -> 'PyACL': - """ - Return system access control list (SACL) of SD - -Args: - - - -Returns: - - PyACL - - """ - pass - - - def GetSecurityDescriptorControl(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Returns tuple of Control bit flags and - -revision of SD. - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def SetSecurityDescriptorOwner(self,sid:'PySID',bOwnerDefaulted:'typing.Any') -> 'None': - """ - Set owner SID. - -Args: - - sid(PySID):The sid to be set as owner in the security descriptor. - bOwnerDefaulted(typing.Any):Normally set to false since this explicitely set the owner. - -Returns: - - None - - """ - pass - - - def SetSecurityDescriptorGroup(self,sid:'PySID',bOwnerDefaulted:'typing.Any') -> 'typing.Any': - """ - Set group SID. - -Args: - - sid(PySID):The group sid to be set in the security descriptor. - bOwnerDefaulted(typing.Any):Normally set to false since this explicitely set the owner. - -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 - -descriptor. - -Args: - - bSaclPresent(typing.Any):A flag indicating if SACL is to be used. If false, last 2 parms are ignored. - SACL(PyACL):The SACL to set in the security descriptor - bSaclDefaulted(typing.Any):Flag, set to false if user has specifically set the SACL. - -Returns: - - None - - """ - pass - - - def IsValid(self,) -> 'None': - """ - Determines if the security descriptor is valid. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetLength(self,) -> 'None': - """ - return length of security descriptor (GetSecurityDescriptorLenght). - -Args: - - - -Returns: - - None - - """ - pass - - - def IsSelfRelative(self,) -> 'None': - """ - Returns 1 if security descriptor is self relative, 0 if absolute - -Args: - - - -Returns: - - None - - """ - pass - - - def SetSecurityDescriptorControl(self,ControlBitsOfInterest:'typing.Any',ControlBitsToSet:'typing.Any') -> 'None': - """ - Sets the control bit flags related to inheritance for a - -security descriptor - -Args: - - ControlBitsOfInterest(typing.Any):Bitmask of flags to be modified - ControlBitsToSet(typing.Any):Bitmask containing flag values to setCommentsOnly exists on Windows 2000 or later - -Returns: - - None - - """ - pass - - -class PySERVER_INFO_100(object): - """A dictionary holding the information in a Win32 SERVER_INFO_100 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def platform_id(self)->'typing.Any': - """""" - pass - - - @property - def name(self)->'typing.Union[str]': - """""" - pass - - -class PySERVER_INFO_101(object): - """A dictionary holding the information in a Win32 SERVER_INFO_101 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def platform_id(self)->'typing.Any': - """""" - pass - - - @property - def name(self)->'typing.Union[str]': - """""" - pass - - - @property - def version_major(self)->'typing.Any': - """""" - pass - - - @property - def version_minor(self)->'typing.Any': - """""" - pass - - - @property - def type(self)->'typing.Any': - """one of the SV_TYPE_* constants""" - pass - - - @property - def comment(self)->'typing.Union[str]': - """""" - pass - - -class PySERVER_INFO_102(object): - """A dictionary holding the information in a Win32 SERVER_INFO_102 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def platform_id(self)->'typing.Any': - """""" - pass - - - @property - def name(self)->'typing.Union[str]': - """""" - pass - - - @property - def version_major(self)->'typing.Any': - """""" - pass - - - @property - def version_minor(self)->'typing.Any': - """""" - pass - - - @property - def type(self)->'typing.Any': - """one of the SV_TYPE_* constants""" - pass - - - @property - def comment(self)->'typing.Union[str]': - """""" - pass - - - @property - def users(self)->'typing.Any': - """""" - pass - - - @property - def disc(self)->'typing.Any': - """""" - pass - - - @property - def hidden(self)->'typing.Any': - """""" - pass - - - @property - def announce(self)->'typing.Any': - """""" - pass - - - @property - def anndelta(self)->'typing.Any': - """""" - pass - - - @property - def userpath(self)->'typing.Union[str]': - """""" - pass - - -class PySERVER_INFO_402(object): - """A dictionary holding the information in a Win32 SERVER_INFO_402 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ulist_mtime(self)->'typing.Any': - """""" - pass - - - @property - def glist_mtime(self)->'typing.Any': - """""" - pass - - - @property - def alist_mtime(self)->'typing.Any': - """""" - pass - - - @property - def security(self)->'typing.Any': - """""" - pass - - - @property - def numadmin(self)->'typing.Any': - """""" - pass - - - @property - def lanmask(self)->'typing.Any': - """""" - pass - - - @property - def guestacct(self)->'typing.Union[str]': - """""" - pass - - - @property - def chdevs(self)->'typing.Any': - """""" - pass - - - @property - def chdevq(self)->'typing.Any': - """""" - pass - - - @property - def chdevjobs(self)->'typing.Any': - """""" - pass - - - @property - def connections(self)->'typing.Any': - """""" - pass - - - @property - def shares(self)->'typing.Any': - """""" - pass - - - @property - def openfiles(self)->'typing.Any': - """""" - pass - - - @property - def sessopens(self)->'typing.Any': - """""" - pass - - - @property - def sessvcs(self)->'typing.Any': - """""" - pass - - - @property - def sessreqs(self)->'typing.Any': - """""" - pass - - - @property - def opensearch(self)->'typing.Any': - """""" - pass - - - @property - def activelocks(self)->'typing.Any': - """""" - pass - - - @property - def numreqbuf(self)->'typing.Any': - """""" - pass - - - @property - def sizreqbuf(self)->'typing.Any': - """""" - pass - - - @property - def numbigbuf(self)->'typing.Any': - """""" - pass - - - @property - def numfiletasks(self)->'typing.Any': - """""" - pass - - - @property - def alertsched(self)->'typing.Any': - """""" - pass - - - @property - def erroralert(self)->'typing.Any': - """""" - pass - - - @property - def logonalert(self)->'typing.Any': - """""" - pass - - - @property - def accessalert(self)->'typing.Any': - """""" - pass - - - @property - def diskalert(self)->'typing.Any': - """""" - pass - - - @property - def netioalert(self)->'typing.Any': - """""" - pass - - - @property - def maxauditsz(self)->'typing.Any': - """""" - pass - - - @property - def srvheuristics(self)->'typing.Union[str]': - """""" - pass - - -class PySERVER_INFO_403(object): - """A dictionary holding the information in a Win32 SERVER_INFO_403 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ulist_mtime(self)->'typing.Any': - """""" - pass - - - @property - def glist_mtime(self)->'typing.Any': - """""" - pass - - - @property - def alist_mtime(self)->'typing.Any': - """""" - pass - - - @property - def security(self)->'typing.Any': - """""" - pass - - - @property - def numadmin(self)->'typing.Any': - """""" - pass - - - @property - def lanmask(self)->'typing.Any': - """""" - pass - - - @property - def guestacct(self)->'typing.Union[str]': - """""" - pass - - - @property - def chdevs(self)->'typing.Any': - """""" - pass - - - @property - def chdevq(self)->'typing.Any': - """""" - pass - - - @property - def chdevjobs(self)->'typing.Any': - """""" - pass - - - @property - def connections(self)->'typing.Any': - """""" - pass - - - @property - def shares(self)->'typing.Any': - """""" - pass - - - @property - def openfiles(self)->'typing.Any': - """""" - pass - - - @property - def sessopens(self)->'typing.Any': - """""" - pass - - - @property - def sessvcs(self)->'typing.Any': - """""" - pass - - - @property - def sessreqs(self)->'typing.Any': - """""" - pass - - - @property - def opensearch(self)->'typing.Any': - """""" - pass - - - @property - def activelocks(self)->'typing.Any': - """""" - pass - - - @property - def numreqbuf(self)->'typing.Any': - """""" - pass - - - @property - def sizreqbuf(self)->'typing.Any': - """""" - pass - - - @property - def numbigbuf(self)->'typing.Any': - """""" - pass - - - @property - def numfiletasks(self)->'typing.Any': - """""" - pass - - - @property - def alertsched(self)->'typing.Any': - """""" - pass - - - @property - def erroralert(self)->'typing.Any': - """""" - pass - - - @property - def logonalert(self)->'typing.Any': - """""" - pass - - - @property - def accessalert(self)->'typing.Any': - """""" - pass - - - @property - def diskalert(self)->'typing.Any': - """""" - pass - - - @property - def netioalert(self)->'typing.Any': - """""" - pass - - - @property - def maxauditsz(self)->'typing.Any': - """""" - pass - - - @property - def srvheuristics(self)->'typing.Union[str]': - """""" - pass - - - @property - def auditedevents(self)->'typing.Any': - """""" - pass - - - @property - def autoprofile(self)->'typing.Any': - """""" - pass - - - @property - def autopath(self)->'typing.Union[str]': - """""" - pass - - -class PySERVER_INFO_502(object): - """A dictionary holding the information in a Win32 SERVER_INFO_502 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def sessopens(self)->'typing.Any': - """""" - pass - - - @property - def sessvcs(self)->'typing.Any': - """""" - pass - - - @property - def opensearch(self)->'typing.Any': - """""" - pass - - - @property - def sizreqbuf(self)->'typing.Any': - """""" - pass - - - @property - def initworkitems(self)->'typing.Any': - """""" - pass - - - @property - def maxworkitems(self)->'typing.Any': - """""" - pass - - - @property - def rawworkitems(self)->'typing.Any': - """""" - pass - - - @property - def irpstacksize(self)->'typing.Any': - """""" - pass - - - @property - def maxrawbuflen(self)->'typing.Any': - """""" - pass - - - @property - def sessusers(self)->'typing.Any': - """""" - pass - - - @property - def sessconns(self)->'typing.Any': - """""" - pass - - - @property - def maxpagedmemoryusage(self)->'typing.Any': - """""" - pass - - - @property - def maxnonpagedmemoryusage(self)->'typing.Any': - """""" - pass - - - @property - def enableforcedlogoff(self)->'typing.Any': - """""" - pass - - - @property - def timesource(self)->'typing.Any': - """""" - pass - - - @property - def acceptdownlevelapis(self)->'typing.Any': - """""" - pass - - - @property - def lmannounce(self)->'typing.Any': - """""" - pass - - -class PySERVER_INFO_503(object): - """A dictionary holding the information in a Win32 SERVER_INFO_503 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def sessopens(self)->'typing.Any': - """""" - pass - - - @property - def sessvcs(self)->'typing.Any': - """""" - pass - - - @property - def opensearch(self)->'typing.Any': - """""" - pass - - - @property - def sizreqbuf(self)->'typing.Any': - """""" - pass - - - @property - def initworkitems(self)->'typing.Any': - """""" - pass - - - @property - def maxworkitems(self)->'typing.Any': - """""" - pass - - - @property - def rawworkitems(self)->'typing.Any': - """""" - pass - - - @property - def irpstacksize(self)->'typing.Any': - """""" - pass - - - @property - def maxrawbuflen(self)->'typing.Any': - """""" - pass - - - @property - def sessusers(self)->'typing.Any': - """""" - pass - - - @property - def sessconns(self)->'typing.Any': - """""" - pass - - - @property - def maxpagedmemoryusage(self)->'typing.Any': - """""" - pass - - - @property - def maxnonpagedmemoryusage(self)->'typing.Any': - """""" - pass - - - @property - def enableforcedlogoff(self)->'typing.Any': - """""" - pass - - - @property - def timesource(self)->'typing.Any': - """""" - pass - - - @property - def acceptdownlevelapis(self)->'typing.Any': - """""" - pass - - - @property - def lmannounce(self)->'typing.Any': - """""" - pass - - - @property - def domain(self)->'typing.Union[str]': - """""" - pass - - - @property - def maxkeepsearch(self)->'typing.Any': - """""" - pass - - - @property - def scavtimeout(self)->'typing.Any': - """""" - pass - - - @property - def minrcvqueue(self)->'typing.Any': - """""" - pass - - - @property - def minfreeworkitems(self)->'typing.Any': - """""" - pass - - - @property - def xactmemsize(self)->'typing.Any': - """""" - pass - - - @property - def threadpriority(self)->'typing.Any': - """""" - pass - - - @property - def maxmpxct(self)->'typing.Any': - """""" - pass - - - @property - def oplockbreakwait(self)->'typing.Any': - """""" - pass - - - @property - def oplockbreakresponsewait(self)->'typing.Any': - """""" - pass - - - @property - def enableoplocks(self)->'typing.Any': - """""" - pass - - - @property - def enablefcbopens(self)->'typing.Any': - """""" - pass - - - @property - def enableraw(self)->'typing.Any': - """""" - pass - - - @property - def enablesharednetdrives(self)->'typing.Any': - """""" - pass - - - @property - def minfreeconnections(self)->'typing.Any': - """""" - pass - - - @property - def maxfreeconnections(self)->'typing.Any': - """""" - pass - - -class PySHARE_INFO_0(object): - """A dictionary holding the infomation in a Win32 SHARE_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def netname(self)->'typing.Union[str]': - """""" - pass - - -class PySHARE_INFO_1(object): - """A dictionary holding the infomation in a Win32 SHARE_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def netname(self)->'typing.Union[str]': - """""" - pass - - - @property - def type(self)->'typing.Any': - """""" - pass - - - @property - def remark(self)->'typing.Union[str]': - """""" - pass - - -class PySHARE_INFO_2(object): - """A dictionary holding the infomation in a Win32 SHARE_INFO_2 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def netname(self)->'typing.Union[str]': - """""" - pass - - - @property - def type(self)->'typing.Any': - """""" - pass - - - @property - def remark(self)->'typing.Union[str]': - """""" - pass - - - @property - def permissions(self)->'typing.Any': - """""" - pass - - - @property - def max_uses(self)->'typing.Any': - """""" - pass - - - @property - def current_uses(self)->'typing.Any': - """""" - pass - - - @property - def path(self)->'typing.Union[str]': - """""" - pass - - - @property - def passwd(self)->'typing.Union[str]': - """""" - pass - - -class PySHARE_INFO_501(object): - """A dictionary holding the infomation in a Win32 SHARE_INFO_501 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def netname(self)->'typing.Union[str]': - """""" - pass - - - @property - def type(self)->'typing.Any': - """""" - pass - - - @property - def remark(self)->'typing.Union[str]': - """""" - pass - - - @property - def flags(self)->'typing.Any': - """""" - pass - - -class PySHARE_INFO_502(object): - """A dictionary holding the infomation in a Win32 SHARE_INFO_502 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def netname(self)->'typing.Union[str]': - """""" - pass - - - @property - def type(self)->'typing.Any': - """""" - pass - - - @property - def remark(self)->'typing.Union[str]': - """""" - pass - - - @property - def permissions(self)->'typing.Any': - """""" - pass - - - @property - def max_uses(self)->'typing.Any': - """""" - pass - - - @property - def current_uses(self)->'typing.Any': - """""" - pass - - - @property - def path(self)->'typing.Union[str]': - """""" - pass - - - @property - def passwd(self)->'typing.Union[str]': - """""" - pass - - - @property - def reserved(self)->'typing.Any': - """""" - pass - - - @property - def security_descriptor(self)->'PySECURITY_DESCRIPTOR': - """""" - pass - - -class PySID(object): - """A Python object, representing a SID structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,idAuthority:'typing.Any',numSubauthorities:'typing.Any') -> 'None': - """ - Initialize the SID. - -Args: - - idAuthority(typing.Any):The identifier authority. - numSubauthorities(typing.Any):The number of sub authorities to allocate. - -Returns: - - None - - """ - pass - - - def IsValid(self,) -> 'None': - """ - Determines if the SID is valid. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetSubAuthority(self,index:'typing.Any',val:'typing.Any') -> 'None': - """ - Sets a SID SubAuthority - -Args: - - index(typing.Any):The index of the sub authority to set - val(typing.Any):The value for the sub authorityCommentsSee the function SetSidSubAuthority - -Returns: - - None - - """ - pass - - - def GetLength(self,) -> 'typing.Any': - """ - return length of SID (GetLengthSid). - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetSubAuthorityCount(self,) -> 'typing.Any': - """ - return nbr of subauthorities from SID - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetSubAuthority(self,) -> 'typing.Any': - """ - Returns specified subauthority from SID - -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 - -constants - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any, typing.Any, typing.Any] - - """ - pass - - -class PySID_AND_ATTRIBUTES(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySIZE(object): - """Tuple of two ints (cx,cy) representing a SIZE struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySMALL_RECT(object): - """Wrapper for a SMALL_RECT struct - -Create using PySMALL_RECTType(Left, Top, Right, Bottom). All params optional, defaulting to 0""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Left(self)->'typing.Any': - """Left side of rectangle""" - pass - - - @property - def Top(self)->'typing.Any': - """Top edge of rectangle""" - pass - - - @property - def Right(self)->'typing.Any': - """Right edge of rectangle""" - pass - - - @property - def Bottom(self)->'typing.Any': - """Bottome edge of rectangle""" - pass - - -class PySTARTUPINFO(object): - """A Python object, representing an STARTUPINFO structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwX(self)->'int': - """Specifies the x offset, in pixels, of the upper left corner of a window if a new window is created. The offset is from the upper left corner of the screen.""" - pass - - - @property - def dwY(self)->'int': - """Specifies the y offset, in pixels, of the upper left corner of a window if a new window is created. The offset is from the upper left corner of the screen.""" - pass - - - @property - def dwXSize(self)->'int': - """Specifies the width, in pixels, of the window if a new window is created.""" - pass - - - @property - def dwYSize(self)->'int': - """Specifies the height, in pixels, of the window if a new window is created.""" - pass - - - @property - def dwXCountChars(self)->'int': - """For console processes, if a new console window is created, specifies the screen buffer width in character columns. This value is ignored in a GUI process.""" - pass - - - @property - def dwYCountChars(self)->'int': - """For console processes, if a new console window is created, specifies the screen buffer height in character rows.""" - pass - - - @property - def dwFillAttribute(self)->'int': - """Specifies the initial text and background colors if a new console window is created in a console application. These values are ignored in GUI applications""" - pass - - - @property - def dwFlags(self)->'int': - """This is a bit field that determines whether certain STARTUPINFO attributes are used when the process creates a window. To use many of the additional attributes, you typically must set the appropriate mask in this attribute, and also set the attributes themselves. Any combination of the win32con.STARTF_* flags can be specified.""" - pass - - - @property - def wShowWindow(self)->'int': - """Can be any of the SW_ constants defined in win32con. For GUI processes, this specifies the default value the first time ShowWindow is called.""" - pass - - - @property - def hStdInput(self)->'typing.Union[int]': - """""" - pass - - - @property - def hStdOutput(self)->'typing.Union[int]': - """""" - pass - - - @property - def hStdError(self)->'typing.Union[int]': - """""" - pass - - - @property - def lpDesktop(self)->'typing.Union[str, typing.Any]': - """""" - pass - - - @property - def lpTitle(self)->'typing.Union[str, typing.Any]': - """""" - pass - - -class PySecBuffer(object): - """Python object wrapping a SecBuffer structure - -Created using win32security.PySecBufferType(type,size) where type is a SECBUFFER_* constant""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def BufferType(self)->'typing.Any': - """""" - pass - - - @property - def Buffer(self)->'str': - """""" - pass - - - @property - def BufferSize(self)->'typing.Any': - """""" - pass - - - @property - def MaxBufferSize(self)->'typing.Any': - """""" - pass - - - def Clear(self,) -> 'None': - """ - Resets the buffer to all NULL's, and set the current size to maximum - -Args: - - - -Returns: - - None - - """ - pass - - -class PySecBufferDesc(object): - """Sequence-like object that contains a group of buffers to be used with SSPI functions.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def append(self,buffer:'typing.Any') -> 'None': - """ - None - -Args: - - buffer(typing.Any):PySecBuffer object to be attached to the group of buffers - -Returns: - - None - - """ - pass - - -class PyTOKEN_GROUPS(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyTOKEN_PRIVILEGES(object): - """An object representing Win32 token privileges.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyTRIVERTEX(object): - """Dict representing a TRIVERTEX struct containing color information at a point""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def x(self)->'typing.Any': - """X coord in logical units""" - pass - - - @property - def y(self)->'typing.Any': - """Y coord in logical units""" - pass - - - @property - def Red(self)->'typing.Any': - """Red component""" - pass - - - @property - def Green(self)->'typing.Any': - """Green component""" - pass - - - @property - def Blue(self)->'typing.Any': - """Blue component""" - pass - - - @property - def Alpha(self)->'typing.Any': - """Transparency value""" - pass - - -class PyTRUSTEE(object): - """A dictionary representing a TRUSTEE structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def TrusteeForm(self)->'typing.Any': - """""" - pass - - - @property - def TrusteeType(self)->'typing.Any': - """""" - pass - - - @property - def Identifier(self)->'typing.Any': - """Depends on the value of TrusteeForm (string or sid)""" - pass - - - @property - def MultipleTrustee(self)->'typing.Any': - """default is None""" - pass - - - @property - def MultipleTrusteeOperation(self)->'typing.Any': - """default is None""" - pass - - -class PyTS_HANDLE(object): - """Handle to a Terminal Server""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyTime(object): - """A Python object, representing an instant in time.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def year(self)->'typing.Any': - """""" - pass - - - @property - def month(self)->'typing.Any': - """""" - pass - - - @property - def weekday(self)->'typing.Any': - """""" - pass - - - @property - def day(self)->'typing.Any': - """""" - pass - - - @property - def hour(self)->'typing.Any': - """""" - pass - - - @property - def minute(self)->'typing.Any': - """""" - pass - - - @property - def second(self)->'typing.Any': - """""" - pass - - - @property - def msec(self)->'typing.Any': - """""" - pass - - - def Format(self,_format:'str') -> 'str': - """ - Formats the time value. - -Args: - - _format(str):The format. See the comments section for a description of the supported flags.CommentsThe following format characters are supported.CharacterDescription%aAbbreviated weekday name%AFull weekday name%bAbbreviated month name%BFull month name%cDate and time representation appropriate for locale%dDay of month as decimal number (01 - 31)%HHour in 24-hour format (00 - 23)%IHour in 12-hour format (01 - 12)%jDay of year as decimal number (001 - 366)%mMonth as decimal number (01 - 12)%MMinute as decimal number (00 - 59)%pCurrent locale's A.M./P.M. indicator for 12-hour clock%SSecond as decimal number (00 - 59)%UWeek of year as decimal number, with Sunday as first day of week (00 - 51)%wWeekday as decimal number (0 - 6; Sunday is 0)%WWeek of year as decimal number, with Monday as first day of week (00 - 51)%xDate representation for current locale%XTime representation for current locale%yYear without century, as decimal number (00 - 99)%YYear with century, as decimal number%z, %ZTime-zone name or abbreviation; no characters if time zone is unknown%%Percent signAs in the printf function, the # flag may prefix any formatting code. In that case, the meaning of the format code is changed as follows.Format CodeMeaning%#a, %#A, %#b, %#B, %#p, %#X, %#z, %#Z, %#%# flag is ignored.%#cLong date and time representation, appropriate for current locale. For example: "Tuesday, March 14, 1995, 12:41:29".%#xLong date representation, appropriate to current locale. For example: "Tuesday, March 14, 1995".%#d, %#H, %#I, %#j, %#m, %#M, %#S, %#U, %#w, %#W, %#y, %#YRemove leading zeros (if any). - -Returns: - - str - - """ - pass - - -class PyUSER_INFO_0(object): - """A dictionary holding the information in a Win32 USER_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """""" - pass - - -class PyUSER_INFO_1(object): - """A dictionary holding the information in a Win32 USER_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """""" - pass - - - @property - def password(self)->'typing.Union[str]': - """""" - pass - - - @property - def password_age(self)->'typing.Any': - """""" - pass - - - @property - def priv(self)->'typing.Any': - """""" - pass - - - @property - def home_dir(self)->'typing.Union[str]': - """""" - pass - - - @property - def comment(self)->'typing.Union[str]': - """""" - pass - - - @property - def flags(self)->'typing.Any': - """""" - pass - - - @property - def script_path(self)->'typing.Union[str]': - """""" - pass - - -class PyUSER_INFO_10(object): - """A dictionary holding the information in a Win32 USER_INFO_10 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """""" - pass - - - @property - def comment(self)->'typing.Union[str]': - """""" - pass - - - @property - def usr_comment(self)->'typing.Union[str]': - """""" - pass - - - @property - def full_name(self)->'typing.Union[str]': - """""" - pass - - -class PyUSER_INFO_1003(object): - """A dictionary holding the information in a Win32 USER_INFO_1003 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def password(self)->'typing.Union[str]': - """""" - pass - - -class PyUSER_INFO_1005(object): - """A dictionary holding the information in a Win32 USER_INFO_1005 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def priv(self)->'typing.Any': - """""" - pass - - -class PyUSER_INFO_1006(object): - """A dictionary holding the information in a Win32 USER_INFO_1006 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def home_dir(self)->'typing.Union[str]': - """""" - pass - - -class PyUSER_INFO_1007(object): - """A dictionary holding the information in a Win32 USER_INFO_1007 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def comment(self)->'typing.Union[str]': - """""" - pass - - -class PyUSER_INFO_1008(object): - """A dictionary holding the information in a Win32 USER_INFO_1008 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def flags(self)->'typing.Any': - """""" - pass - - -class PyUSER_INFO_1009(object): - """A dictionary holding the information in a Win32 USER_INFO_1009 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def script_path(self)->'typing.Union[str]': - """""" - pass - - -class PyUSER_INFO_1010(object): - """A dictionary holding the information in a Win32 USER_INFO_1010 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def auth_flags(self)->'typing.Any': - """""" - pass - - -class PyUSER_INFO_1011(object): - """A dictionary holding the information in a Win32 USER_INFO_1011 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def full_name(self)->'typing.Union[str]': - """""" - pass - - -class PyUSER_INFO_11(object): - """A dictionary holding the information in a Win32 USER_INFO_11 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """""" - pass - - - @property - def comment(self)->'typing.Union[str]': - """""" - pass - - - @property - def usr_comment(self)->'typing.Union[str]': - """""" - pass - - - @property - def full_name(self)->'typing.Union[str]': - """""" - pass - - - @property - def priv(self)->'typing.Any': - """""" - pass - - - @property - def auth_flags(self)->'typing.Any': - """""" - pass - - - @property - def password_age(self)->'typing.Any': - """""" - pass - - - @property - def home_dir(self)->'typing.Union[str]': - """""" - pass - - - @property - def parms(self)->'typing.Union[str]': - """""" - pass - - - @property - def last_logon(self)->'typing.Any': - """""" - pass - - - @property - def last_logoff(self)->'typing.Any': - """""" - pass - - - @property - def bad_pw_count(self)->'typing.Any': - """""" - pass - - - @property - def num_logons(self)->'typing.Any': - """""" - pass - - - @property - def logon_server(self)->'typing.Union[str]': - """""" - pass - - - @property - def country_code(self)->'typing.Any': - """""" - pass - - - @property - def workstations(self)->'typing.Union[str]': - """""" - pass - - - @property - def max_storage(self)->'typing.Any': - """""" - pass - - - @property - def units_per_week(self)->'typing.Any': - """""" - pass - - - @property - def logon_hours(self)->'str': - """""" - pass - - - @property - def code_page(self)->'typing.Any': - """""" - pass - - -class PyUSER_INFO_2(object): - """A dictionary holding the information in a Win32 USER_INFO_2 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """""" - pass - - - @property - def password(self)->'typing.Union[str]': - """""" - pass - - - @property - def password_age(self)->'typing.Any': - """""" - pass - - - @property - def priv(self)->'typing.Any': - """""" - pass - - - @property - def home_dir(self)->'typing.Union[str]': - """""" - pass - - - @property - def comment(self)->'typing.Union[str]': - """""" - pass - - - @property - def flags(self)->'typing.Any': - """""" - pass - - - @property - def script_path(self)->'typing.Union[str]': - """""" - pass - - - @property - def auth_flags(self)->'typing.Any': - """""" - pass - - - @property - def full_name(self)->'typing.Union[str]': - """""" - pass - - - @property - def usr_comment(self)->'typing.Union[str]': - """""" - pass - - - @property - def parms(self)->'typing.Union[str]': - """""" - pass - - - @property - def workstations(self)->'typing.Union[str]': - """""" - pass - - - @property - def last_logon(self)->'typing.Any': - """""" - pass - - - @property - def last_logoff(self)->'typing.Any': - """""" - pass - - - @property - def acct_expires(self)->'typing.Any': - """""" - pass - - - @property - def max_storage(self)->'typing.Any': - """""" - pass - - - @property - def units_per_week(self)->'typing.Any': - """""" - pass - - - @property - def logon_hours(self)->'str': - """""" - pass - - - @property - def bad_pw_count(self)->'typing.Any': - """""" - pass - - - @property - def num_logons(self)->'typing.Any': - """""" - pass - - - @property - def logon_server(self)->'typing.Union[str]': - """""" - pass - - - @property - def country_code(self)->'typing.Any': - """""" - pass - - - @property - def code_page(self)->'typing.Any': - """""" - pass - - -class PyUSER_INFO_20(object): - """A dictionary holding the information in a Win32 USER_INFO_20 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """""" - pass - - - @property - def full_name(self)->'typing.Union[str]': - """""" - pass - - - @property - def comment(self)->'typing.Union[str]': - """""" - pass - - - @property - def flags(self)->'typing.Any': - """""" - pass - - - @property - def user_id(self)->'typing.Any': - """""" - pass - - -class PyUSER_INFO_3(object): - """A dictionary holding the information in a Win32 USER_INFO_3 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """""" - pass - - - @property - def password(self)->'typing.Union[str]': - """""" - pass - - - @property - def password_age(self)->'typing.Any': - """""" - pass - - - @property - def priv(self)->'typing.Any': - """""" - pass - - - @property - def home_dir(self)->'typing.Union[str]': - """""" - pass - - - @property - def comment(self)->'typing.Union[str]': - """""" - pass - - - @property - def flags(self)->'typing.Any': - """""" - pass - - - @property - def script_path(self)->'typing.Union[str]': - """""" - pass - - - @property - def auth_flags(self)->'typing.Any': - """""" - pass - - - @property - def full_name(self)->'typing.Union[str]': - """""" - pass - - - @property - def usr_comment(self)->'typing.Union[str]': - """""" - pass - - - @property - def parms(self)->'typing.Union[str]': - """""" - pass - - - @property - def workstations(self)->'typing.Union[str]': - """""" - pass - - - @property - def last_logon(self)->'typing.Any': - """""" - pass - - - @property - def last_logoff(self)->'typing.Any': - """""" - pass - - - @property - def acct_expires(self)->'typing.Any': - """""" - pass - - - @property - def max_storage(self)->'typing.Any': - """""" - pass - - - @property - def units_per_week(self)->'typing.Any': - """""" - pass - - - @property - def logon_hours(self)->'str': - """""" - pass - - - @property - def bad_pw_count(self)->'typing.Any': - """""" - pass - - - @property - def num_logons(self)->'typing.Any': - """""" - pass - - - @property - def logon_server(self)->'typing.Union[str]': - """""" - pass - - - @property - def country_code(self)->'typing.Any': - """""" - pass - - - @property - def code_page(self)->'typing.Any': - """""" - pass - - - @property - def user_id(self)->'typing.Any': - """""" - pass - - - @property - def primary_group_id(self)->'typing.Any': - """""" - pass - - - @property - def profile(self)->'typing.Union[str]': - """""" - pass - - - @property - def home_dir_drive(self)->'typing.Union[str]': - """""" - pass - - - @property - def password_expired(self)->'typing.Any': - """""" - pass - - -class PyUSER_INFO_4(object): - """A dictionary holding the information in a Win32 USER_INFO_4 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """""" - pass - - - @property - def password(self)->'typing.Union[str]': - """""" - pass - - - @property - def password_age(self)->'typing.Any': - """""" - pass - - - @property - def priv(self)->'typing.Any': - """""" - pass - - - @property - def home_dir(self)->'typing.Union[str]': - """""" - pass - - - @property - def comment(self)->'typing.Union[str]': - """""" - pass - - - @property - def flags(self)->'typing.Any': - """""" - pass - - - @property - def script_path(self)->'typing.Union[str]': - """""" - pass - - - @property - def auth_flags(self)->'typing.Any': - """""" - pass - - - @property - def full_name(self)->'typing.Union[str]': - """""" - pass - - - @property - def usr_comment(self)->'typing.Union[str]': - """""" - pass - - - @property - def parms(self)->'typing.Union[str]': - """""" - pass - - - @property - def workstations(self)->'typing.Union[str]': - """""" - pass - - - @property - def last_logon(self)->'typing.Any': - """""" - pass - - - @property - def last_logoff(self)->'typing.Any': - """""" - pass - - - @property - def acct_expires(self)->'typing.Any': - """""" - pass - - - @property - def max_storage(self)->'typing.Any': - """""" - pass - - - @property - def units_per_week(self)->'typing.Any': - """""" - pass - - - @property - def logon_hours(self)->'str': - """""" - pass - - - @property - def bad_pw_count(self)->'typing.Any': - """""" - pass - - - @property - def num_logons(self)->'typing.Any': - """""" - pass - - - @property - def logon_server(self)->'typing.Union[str]': - """""" - pass - - - @property - def country_code(self)->'typing.Any': - """""" - pass - - - @property - def code_page(self)->'typing.Any': - """""" - pass - - - @property - def user_sid(self)->'PySID': - """""" - pass - - - @property - def primary_group_id(self)->'typing.Any': - """""" - pass - - - @property - def profile(self)->'typing.Union[str]': - """""" - pass - - - @property - def home_dir_drive(self)->'typing.Union[str]': - """""" - pass - - - @property - def password_expired(self)->'typing.Any': - """""" - pass - - -class PyUSER_MODALS_INFO_0(object): - """A dictionary holding the information in a Win32 USER_MODALS_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def min_passwd_len(self)->'typing.Any': - """""" - pass - - - @property - def max_passwd_age(self)->'typing.Any': - """""" - pass - - - @property - def min_passwd_age(self)->'typing.Any': - """""" - pass - - - @property - def force_logoff(self)->'typing.Any': - """""" - pass - - - @property - def password_hist_len(self)->'typing.Any': - """""" - pass - - -class PyUSER_MODALS_INFO_1(object): - """A dictionary holding the information in a Win32 USER_MODALS_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def role(self)->'typing.Any': - """""" - pass - - - @property - def primary(self)->'typing.Union[str]': - """""" - pass - - -class PyUSER_MODALS_INFO_2(object): - """A dictionary holding the information in a Win32 USER_MODALS_INFO_2 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def domain_name(self)->'typing.Union[str]': - """""" - pass - - - @property - def domain_id(self)->'PySID': - """""" - pass - - -class PyUSER_MODALS_INFO_3(object): - """A dictionary holding the information in a Win32 USER_MODALS_INFO_3 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def lockout_duration(self)->'typing.Any': - """""" - pass - - - @property - def lockout_observation_window(self)->'typing.Any': - """""" - pass - - - @property - def usrmod3_lockout_threshold(self)->'typing.Any': - """""" - pass - - -class PyUSE_INFO_0(object): - """A dictionary holding the infomation in a Win32 USE_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def local(self)->'typing.Union[str]': - """""" - pass - - - @property - def remote(self)->'typing.Union[str]': - """""" - pass - - -class PyUSE_INFO_1(object): - """A dictionary holding the infomation in a Win32 USE_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def local(self)->'typing.Union[str]': - """""" - pass - - - @property - def remote(self)->'typing.Union[str]': - """""" - pass - - - @property - def password(self)->'typing.Union[str, typing.Any]': - """""" - pass - - - @property - def status(self)->'typing.Any': - """""" - pass - - - @property - def asg_type(self)->'typing.Any': - """""" - pass - - - @property - def refcount(self)->'typing.Any': - """""" - pass - - - @property - def usecount(self)->'typing.Any': - """""" - pass - - -class PyUSE_INFO_2(object): - """A dictionary holding the infomation in a Win32 USE_INFO_2 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def local(self)->'typing.Union[str]': - """""" - pass - - - @property - def remote(self)->'typing.Union[str]': - """""" - pass - - - @property - def password(self)->'typing.Union[str, typing.Any]': - """""" - pass - - - @property - def status(self)->'typing.Any': - """""" - pass - - - @property - def asg_type(self)->'typing.Any': - """""" - pass - - - @property - def refcount(self)->'typing.Any': - """""" - pass - - - @property - def usecount(self)->'typing.Any': - """""" - pass - - - @property - def username(self)->'typing.Union[str]': - """""" - pass - - - @property - def domainname(self)->'typing.Union[str]': - """""" - pass - - -class PyUSE_INFO_3(object): - """A dictionary holding the infomation in a Win32 USE_INFO_3 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def local(self)->'typing.Union[str]': - """""" - pass - - - @property - def remote(self)->'typing.Union[str]': - """""" - pass - - - @property - def password(self)->'typing.Union[str, typing.Any]': - """""" - pass - - - @property - def status(self)->'typing.Any': - """""" - pass - - - @property - def asg_type(self)->'typing.Any': - """""" - pass - - - @property - def refcount(self)->'typing.Any': - """""" - pass - - - @property - def usecount(self)->'typing.Any': - """""" - pass - - - @property - def username(self)->'typing.Union[str]': - """""" - pass - - - @property - def domainname(self)->'typing.Union[str]': - """""" - pass - - - @property - def flags(self)->'typing.Any': - """""" - pass - - -class PyUnicode(object): - """A Python object, representing a Unicode string.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyUrlCacheHANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyWAVEFORMATEX(object): - """A Python object, representing a WAVEFORMATEX structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def wFormatTag(self)->'int': - """Waveform-audio format type. pywintypes only defines WAVE_FORMAT_PCM as a constant. Other values must be looked up in the mmsystem.h header file.""" - pass - - - @property - def nChannels(self)->'int': - """Number of channels. 1 for Mono, 2 for Stereo, anything, but never 5.1.""" - pass - - - @property - def nSamplesPerSec(self)->'int': - """Sample rate, in samples per second (hertz), that each channel should be played or recorded. If wFormatTag is WAVE_FORMAT_PCM, then common values for nSamplesPerSec are 8000, 11025, 22050, and 44100 Hz""" - pass - - - @property - def nAvgBytesPerSec(self)->'int': - """Required average data-transfer rate, in bytes per second, for the format tag. If wFormatTag is WAVE_FORMAT_PCM, nAvgBytesPerSec should be equal to the product of nSamplesPerSec and nBlockAlign.""" - pass - - - @property - def nBlockAlign(self)->'int': - """Block alignment, in bytes. The block alignment is the minimum atomic unit of data for the wFormatTag format type. If wFormatTag is WAVE_FORMAT_PCM, nBlockAlign should be equal to the product of nChannels and wBitsPerSample divided by 8 (bits per byte). For non-PCM formats, this member must be computed according to the manufacturer’s specification of the format tag.""" - pass - - - @property - def wBitsPerSample(self)->'int': - """Bits per sample for the wFormatTag format type. If wFormatTag is WAVE_FORMAT_PCM, then wBitsPerSample should be equal to 8 or 16. Sentinel""" - pass - - -class PyWINHTTP_AUTOPROXY_OPTIONS(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyWINHTTP_PROXY_INFO(object): - """A tuple representing a WINHTTP_PROXY_INFO structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyWKSTA_INFO_100(object): - """A dictionary holding the infomation in a Win32 WKSTA_INFO_100 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def platform_id(self)->'typing.Any': - """Indicates platform level to use to retrieve platform specific information""" - pass - - - @property - def computername(self)->'typing.Union[str]': - """Name of the local computer""" - pass - - - @property - def langroup(self)->'typing.Union[str]': - """Name of the domain to which computer belongs""" - pass - - - @property - def ver_major(self)->'typing.Any': - """Major version number of operating system running on the computer""" - pass - - - @property - def ver_minor(self)->'typing.Any': - """Minor version number of operating system running on the computer""" - pass - - -class PyWKSTA_INFO_101(object): - """A dictionary holding the infomation in a Win32 WKSTA_INFO_101 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def platform_id(self)->'typing.Any': - """Indicates platform level to use to retrieve platform specific information""" - pass - - - @property - def computername(self)->'typing.Union[str]': - """Name of the local computer""" - pass - - - @property - def langroup(self)->'typing.Union[str]': - """Name of the domain to which computer belongs""" - pass - - - @property - def ver_major(self)->'typing.Any': - """Major version number of operating system running on the computer""" - pass - - - @property - def ver_minor(self)->'typing.Any': - """Minor version number of operating system running on the computer""" - pass - - - @property - def lanroot(self)->'typing.Union[str]': - """Path to the LANMAN directory""" - pass - - -class PyWKSTA_INFO_102(object): - """A dictionary holding the infomation in a Win32 WKSTA_INFO_102 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def platform_id(self)->'typing.Any': - """Indicate platform level to use to retrieve platform specific information""" - pass - - - @property - def computername(self)->'typing.Union[str]': - """Name of the local computer""" - pass - - - @property - def langroup(self)->'typing.Union[str]': - """Name of the domain to which computer belongs""" - pass - - - @property - def ver_major(self)->'typing.Any': - """Major version number of operating system running on the computer""" - pass - - - @property - def ver_minor(self)->'typing.Any': - """Minor version number of operating system running on the computer""" - pass - - - @property - def lanroot(self)->'typing.Union[str]': - """Path to the LANMAN directory""" - pass - - - @property - def logged_on_users(self)->'typing.Any': - """Number of users who are logged on to the local computer""" - pass - - -class PyWKSTA_INFO_302(object): - """A dictionary holding the infomation in a Win32 WKSTA_INFO_302 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def char_wait(self)->'typing.Any': - """number of seconds the computer will wait for a remote resource to become available""" - pass - - - @property - def collection_time(self)->'typing.Any': - """number of milliseconds the computer will collect data before sending the data to a character device resource. The workstation waits the specified time or collects the number of characters specified by wki302_maximum_collection_count, whichever comes first.""" - pass - - - @property - def maximum_collection_count(self)->'typing.Any': - """Specifies the number of bytes of information the computer will collect before sending the data to a character device resource. The workstation collects the specified number of bytes or waits the time specified by wki302_collection_time, whichever comes first.""" - pass - - - @property - def keep_conn(self)->'typing.Any': - """Specifies the number of seconds the server will maintain an inactive connection to a resource.""" - pass - - - @property - def keep_search(self)->'typing.Any': - """Defines the number of seconds an inactive search will continue.""" - pass - - - @property - def max_cmds(self)->'typing.Any': - """Specifies the number of simultaneous network device driver commands that can be sent to the network.""" - pass - - - @property - def num_work_buf(self)->'typing.Any': - """Specifies the number of internal buffers the computer has.""" - pass - - - @property - def siz_work_buf(self)->'typing.Any': - """Specifies the size, in bytes, of each internal buffer.""" - pass - - - @property - def max_wrk_cache(self)->'typing.Any': - """Specifies the maximum size, in bytes, of an internal cache buffer.""" - pass - - - @property - def siz_error(self)->'typing.Any': - """Specifies the size, in bytes, of an internal error buffer.""" - pass - - - @property - def num_alerts(self)->'typing.Any': - """Specifies the maximum number of clients that can receive alert messages. (This member is not supported under MS-DOS.) The Alerter service registers at least three clients when it begins to run.""" - pass - - - @property - def num_services(self)->'typing.Any': - """Specifies the number of services that can be installed on the computer at any time.""" - pass - - - @property - def errlog_sz(self)->'typing.Any': - """Specifies the maximum size, in kilobytes, of the client's error log file.""" - pass - - - @property - def print_buf_time(self)->'typing.Any': - """Specifies the number of seconds the server waits before closing inactive compatibility-mode print jobs.""" - pass - - - @property - def num_char_buf(self)->'typing.Any': - """Specifies the number of character pipe buffers and device buffers the client can have.""" - pass - - - @property - def siz_char_buf(self)->'typing.Any': - """Specifies the maximum size, in bytes, of a character pipe buffer and device buffer.""" - pass - - - @property - def wrk_heuristics(self)->'typing.Union[str]': - """Pointer to a Unicode string of flags used to control a client's operation.""" - pass - - - @property - def mailslots(self)->'typing.Any': - """Specifies the maximum number of mailslots allowed.""" - pass - - - @property - def num_dgram_buf(self)->'typing.Any': - """Specifies the number of buffers to allocate for receiving datagrams.""" - pass - - -class PyWKSTA_INFO_402(object): - """A dictionary holding the infomation in a Win32 WKSTA_INFO_402 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def char_wait(self)->'typing.Any': - """number of seconds the computer will wait for a remote resource to become available""" - pass - - - @property - def collection_time(self)->'typing.Any': - """number of milliseconds the computer will collect data before sending the data to a character device resource. The workstation waits the specified time or collects the number of characters specified by wki402_maximum_collection_count, whichever comes first.""" - pass - - - @property - def maximum_collection_count(self)->'typing.Union[str]': - """Name of the domain to which computer belongs""" - pass - - - @property - def keep_conn(self)->'typing.Any': - """Major version number of operating system running on the computer""" - pass - - - @property - def keep_search(self)->'typing.Any': - """Minor version number of operating system running on the computer""" - pass - - - @property - def max_cmds(self)->'typing.Any': - """..""" - pass - - - @property - def num_work_buf(self)->'typing.Any': - """Number of users who are logged on to the local computer""" - pass - - - @property - def siz_work_buf(self)->'typing.Any': - """Number of users who are logged on to the local computer""" - pass - - - @property - def max_wrk_cache(self)->'typing.Any': - """..""" - pass - - - @property - def sess_timeout(self)->'typing.Any': - """..""" - pass - - - @property - def siz_error(self)->'typing.Any': - """..""" - pass - - - @property - def num_alerts(self)->'typing.Any': - """..""" - pass - - - @property - def num_services(self)->'typing.Any': - """..""" - pass - - - @property - def errlog_sz(self)->'typing.Any': - """..""" - pass - - - @property - def print_buf_time(self)->'typing.Any': - """..""" - pass - - - @property - def num_char_buf(self)->'typing.Any': - """..""" - pass - - - @property - def siz_char_buf(self)->'typing.Any': - """Specifies the maximum size, in bytes, of a character pipe buffer and device buffer.""" - pass - - - @property - def mailslots(self)->'typing.Any': - """..""" - pass - - - @property - def num_dgram_buf(self)->'typing.Any': - """..""" - pass - - - @property - def max_threads(self)->'typing.Any': - """Number of threads the computer can dedicate to the network""" - pass - - -class PyWKSTA_INFO_502(object): - """A dictionary holding the infomation in a Win32 WKSTA_INFO_502 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def char_wait(self)->'typing.Any': - """number of seconds the computer will wait for a remote resource to become available""" - pass - - - @property - def collection_time(self)->'typing.Any': - """number of milliseconds the computer will collect data before sending the data to a character device resource. The workstation waits the specified time or collects the number of characters specified by wki502_maximum_collection_count, whichever comes first.""" - pass - - - @property - def maximum_collection_count(self)->'typing.Any': - """Specifies the number of bytes of information the computer will collect before sending the data to a character device resource. The workstation collects the specified number of bytes or waits the time specified by wki302_collection_time, whichever comes first.""" - pass - - - @property - def keep_conn(self)->'typing.Any': - """Specifies the number of seconds the server will maintain an inactive connection to a resource.""" - pass - - - @property - def max_cmds(self)->'typing.Any': - """Specifies the number of simultaneous network device driver commands that can be sent to the network.""" - pass - - - @property - def max_wrk_cache(self)->'typing.Any': - """Indicates the number of seconds the server waits before disconnecting an inactive session.""" - pass - - - @property - def siz_char_buf(self)->'typing.Any': - """Specifies the maximum size, in bytes, of a character pipe buffer and device buffer.""" - pass - - - @property - def lock_quota(self)->'typing.Any': - """TODO""" - pass - - - @property - def lock_increment(self)->'typing.Any': - """TODO""" - pass - - - @property - def lock_maximum(self)->'typing.Any': - """TODO""" - pass - - - @property - def pipe_increment(self)->'typing.Any': - """TODO""" - pass - - - @property - def pipe_maximum(self)->'typing.Any': - """TODO""" - pass - - - @property - def cache_file_timeout(self)->'typing.Any': - """TODO""" - pass - - - @property - def dormant_file_limit(self)->'typing.Any': - """TODO""" - pass - - - @property - def read_ahead_throughput(self)->'typing.Any': - """TODO""" - pass - - - @property - def num_mailslot_buffers(self)->'typing.Any': - """TODO""" - pass - - - @property - def num_srv_announce_buffers(self)->'typing.Any': - """TODO""" - pass - - - @property - def max_illegal_datagram_events(self)->'typing.Any': - """TODO""" - pass - - - @property - def illegal_datagram_event_reset_frequency(self)->'typing.Any': - """TODO""" - pass - - - @property - def log_election_packets(self)->'typing.Any': - """TODO""" - pass - - - @property - def use_opportunistic_locking(self)->'typing.Any': - """TODO""" - pass - - - @property - def use_unlock_behind(self)->'typing.Any': - """TODO""" - pass - - - @property - def use_close_behind(self)->'typing.Any': - """TODO""" - pass - - - @property - def buf_named_pipes(self)->'typing.Any': - """TODO""" - pass - - - @property - def use_lock_read_unlock(self)->'typing.Any': - """TODO""" - pass - - - @property - def utilize_nt_caching(self)->'typing.Any': - """TODO""" - pass - - - @property - def use_raw_read(self)->'typing.Any': - """TODO""" - pass - - - @property - def use_raw_write(self)->'typing.Any': - """TODO""" - pass - - - @property - def use_write_raw_data(self)->'typing.Any': - """TODO""" - pass - - - @property - def use_encryption(self)->'typing.Any': - """TODO""" - pass - - - @property - def buf_files_deny_write(self)->'typing.Any': - """TODO""" - pass - - - @property - def buf_read_only_files(self)->'typing.Any': - """TODO""" - pass - - - @property - def force_core_create_mode(self)->'typing.Any': - """TODO""" - pass - - - @property - def use_512_byte_max_transfer(self)->'typing.Any': - """TODO""" - pass - - -class PyWKSTA_TRANSPORT_INFO_0(object): - """A dictionary holding the infomation in a Win32 WKSTA_TRANSPORT_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def quality_of_service(self)->'typing.Any': - """Supplies a value that specifies the search order of the transport protocol with respect to other transport protocols. The highest value is searched first.""" - pass - - - @property - def number_of_vcs(self)->'typing.Any': - """Specifies the number of clients communicating with the server using this transport protocol.""" - pass - - - @property - def transport_name(self)->'typing.Union[str]': - """Specifies the device name of the transport protocol.""" - pass - - - @property - def transport_address(self)->'typing.Union[str]': - """Specifies the address of the server on this transport protocol.""" - pass - - - @property - def wan_ish(self)->'typing.Any': - """This member is ignored by the NetWkstaTransportAdd function. For the NetWkstaTransportEnum function, this member indicates that this transport protocol is a WAN transport protocol. This member is set TRUE for NetBIOS/TCIP; it is set FALSE for NetBEUI and NetBIOS/IPX.""" - pass - - -class PyWKSTA_USER_INFO_0(object): - """A dictionary holding the infomation in a Win32 WKSTA_USER_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def username(self)->'typing.Union[str]': - """Name of user currently logged on to the workstation""" - pass - - -class PyWKSTA_USER_INFO_1(object): - """A dictionary holding the infomation in a Win32 WKSTA_USER_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def username(self)->'typing.Union[str]': - """Name of user currently logged on to the workstation""" - pass - - - @property - def logon_domain(self)->'typing.Union[str]': - """Returns the domain name of the user account of the user currently logged on to the workstation.""" - pass - - - @property - def oth_domains(self)->'typing.Union[str]': - """Returns the list of other operating system domains browsed by the workstation. The domain names are separated by blanks.""" - pass - - - @property - def logon_server(self)->'typing.Union[str]': - """Returns the name of the computer that authenticated the server.""" - pass - - -class PyWNDCLASS(object): - """A Python object, representing an WNDCLASS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def style(self)->'int': - """""" - pass - - - @property - def cbWndExtra(self)->'int': - """""" - pass - - - @property - def hInstance(self)->'int': - """""" - pass - - - @property - def hIcon(self)->'int': - """""" - pass - - - @property - def hCursor(self)->'int': - """""" - pass - - - @property - def hbrBackground(self)->'int': - """These 3 handled manually in PyWNDCLASS::getattro/setattro. The pymeth below is used as an end tag, so these props will be lost if below it""" - pass - - - @property - def lpszMenuName(self)->'typing.Union[str]': - """""" - pass - - - @property - def lpszClassName(self)->'typing.Union[str]': - """""" - pass - - - @property - def lpfnWndProc(self)->'typing.Any': - """MethodsSetDialogProcSets the WNDCLASS to be for a dialog box. """ - pass - - - def SetDialogProc(self,) -> 'None': - """ - Sets the WNDCLASS to be for a dialog box - -Args: - - - -Returns: - - None - - """ - pass - - -class PyXFORM(object): - """Dict representing an XFORM struct used as a world transformation matrix - -All members are optional, defaulting to 0.0.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def M11(self)->'float': - """Usage is dependent on operation performed, see MSDN docs""" - pass - - - @property - def M12(self)->'float': - """Usage is dependent on operation performed, see MSDN docs""" - pass - - - @property - def M21(self)->'float': - """Usage is dependent on operation performed, see MSDN docs""" - pass - - - @property - def M22(self)->'float': - """Usage is dependent on operation performed, see MSDN docs""" - pass - - - @property - def Dx(self)->'float': - """Horizontal offset in logical units""" - pass - - - @property - def Dy(self)->'float': - """Vertical offset in logical units""" - pass - - -class Pymmapfile(object): - """Object that provides access to memory-mapped file operations.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def close(self,) -> 'None': - """ - Closes the file mapping handle and releases mapped view - -Args: - - - -Returns: - - None - - """ - pass - - - def find(self,needle:'typing.Any',start:'typing.Any') -> 'typing.Any': - """ - Finds a string in the buffer. - -Args: - - needle(typing.Any):String to be located - start(typing.Any):Pos at which to start search, current pos assumed if not specifiedReturn ValueReturns pos of string, or -1 if not found - -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 - - - def flush(self,offset:'typing.Any'=0,size:'typing.Any'=0) -> 'None': - """ - Flushes memory buffer to disk - -Args: - - offset(typing.Any):Position in buffer at which to flush - size(typing.Any):Number of bytes to flush, 0 to flush remainder of buffer past the offset - -Returns: - - None - - """ - pass - - - def move(self,dest:'typing.Any',src:'typing.Any',count:'typing.Any') -> 'None': - """ - Moves data from one place in buffer to another - -Args: - - dest(typing.Any):Destination position in buffer - src(typing.Any):Source position in buffer - count(typing.Any):Number of bytes to move - -Returns: - - None - - """ - pass - - - def read(self,num_bytes:'typing.Any') -> 'typing.Any': - """ - Returns specified number of bytes from buffer, and advances current position - -Args: - - num_bytes(typing.Any):Number of bytes to read - -Returns: - - typing.Any - - """ - pass - - - def read_byte(self,) -> 'typing.Any': - """ - Reads a single character from current pos - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def read_line(self,) -> 'typing.Any': - """ - Reads data from current pos up to next EOL. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def resize(self,MaximumSize:'typing.Any',FileOffset:'typing.Any'=0,NumberOfBytesToMap:'typing.Any'=0) -> 'None': - """ - Resizes the file mapping and view. - -Args: - - MaximumSize(typing.Any):New size for file mapping. Use a multiple of system page size (see win32api::GetSystemInfo) - FileOffset(typing.Any):Offset into file mapping. Must be multiple of allocation granularity. - NumberOfBytesToMap(typing.Any):New view size. Specify a multiple of system page size.CommentsIf MaximumSize is 0, only the mapped view will be affected.Accepts keyword args. - -Returns: - - None - - """ - pass - - - def seek(self,dist:'typing.Any',how:'typing.Any'=0) -> 'None': - """ - Changes current position - -Args: - - dist(typing.Any):Distance to seek - how(typing.Any):Pos from which to seekhowmeaning0Seek from start of buffer1Seek from current position2Seek backwards from end of buffer - -Returns: - - None - - """ - pass - - - def size(self,) -> 'typing.Any': - """ - Returns size of current view - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def tell(self,) -> 'typing.Any': - """ - Returns current position in buffer - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def write(self,data:'typing.Any') -> 'None': - """ - Places data at current pos in buffer. - -Args: - - data(typing.Any):Data to be written - -Returns: - - None - - """ - pass - - - def write_byte(self,char:'typing.Any') -> 'None': - """ - Writes a single character of data - -Args: - - char(typing.Any):Single byte to be placed in buffer - -Returns: - - None - - """ - pass - - -class RASDIALEXTENSIONS(object): - """An object that describes a Win32 RASDIALEXTENSIONS structure - -TRUE*/)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwfOptions(self)->'int': - """(fOptions may also be used)""" - pass - - - @property - def hwndParent(self)->'int': - """""" - pass - - - @property - def reserved(self)->'int': - """""" - pass - - - @property - def reserved1(self)->'int': - """""" - pass - - - @property - def RasEapInfo(self)->'typing.Any': - """""" - pass - - -class RASDIALPARAMS(object): - """A tuple that describes a Win32 RASDIALPARAMS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SC_ACTION(object): - """Tuple of 2 ints (Type,Delay) used to represent an SC_ACTION structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Type(self)->'typing.Any': - """One of SC_ACTION_NONE, SC_ACTION_REBOOT, SC_ACTION_RESTART, SC_ACTION_RUN_COMMAND""" - pass - - - @property - def Delay(self)->'typing.Any': - """Time delay before specified action is taken (in milliseconds)""" - pass - - -class SERVICE_FAILURE_ACTIONS(object): - """A dictionary representing a SERVICE_FAILURE_ACTIONS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ResetPeriod(self)->'typing.Any': - """Indicates how many seconds to wait to reset the failure count, can be INFINITE""" - pass - - - @property - def RebootMsg(self)->'typing.Union[str, typing.Any]': - """Message displayed when reboot action is taken""" - pass - - - @property - def Command(self)->'typing.Union[str, typing.Any]': - """Command line to execute for SC_ACTION_RUN_COMMAND""" - pass - - - @property - def Actions(self)->'typing.Any': - """A tuple of SC_ACTION tuples""" - pass - - -class SERVICE_STATUS(object): - """A Win32 service status object is represented by a tuple:""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class TRACKMOUSEEVENT(object): - """A tuple of (dwFlags, hwndTrack, dwHoverTime)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class ULARGE_INTEGER(object): - """A Python object used wherever a COM ULARGE_INTEGER is used.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class WIN32_FIND_DATA(object): - """A tuple representing a WIN32_FIND_DATA structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class com_error(object): - """An exception raised when a COM exception occurs.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class connection(object): - """An object representing an ODBC connection""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def setautocommit(self,c:'typing.Any') -> 'None': - """ - Sets the autocommit mode. - -Args: - - c(typing.Any):The boolean autocommit mode. - -Returns: - - None - - """ - pass - - - def commit(self,) -> 'None': - """ - Commits a transaction. - -Args: - - - -Returns: - - None - - """ - pass - - - def rollback(self,) -> 'None': - """ - Rollsback a transaction. - -Args: - - - -Returns: - - None - - """ - pass - - - def cursor(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def close(self,) -> 'None': - """ - Closes the connection. - -Args: - - - -Returns: - - None - - """ - pass - - -class cursor(object): - """An object representing an ODBC cursor.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def close(self,) -> 'None': - """ - Closes the cursor - -Args: - - - -Returns: - - None - - """ - pass - - - def execute(self,sql:'str',arg:'typing.Any') -> 'typing.Any': - """ - Execute some SQL - -Args: - - sql(str):The SQL to execute - arg(typing.Any):Input variables. - -Returns: - - typing.Any - - """ - pass - - - def fetchone(self,) -> 'typing.Any': - """ - Fetch one row of data - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def fetchmany(self,) -> 'typing.List[typing.Any]': - """ - Fetch many rows of data - -Args: - - - -Returns: - - typing.List[typing.Any] - - """ - pass - - - def fetchall(self,) -> 'typing.List[typing.Any]': - """ - Fetch all rows of data - -Args: - - - -Returns: - - typing.List[typing.Any] - - """ - pass - - - def setinputsizes(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def setoutputsize(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - -class error(object): - """An exception raised when a win32 error occurs""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class COMPONENT(object): - """A dictionary containing data to fill a COMPPOS struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ID(self)->'typing.Any': - """Id of component, ignored when adding a new component""" - pass - - - @property - def ComponentType(self)->'typing.Any': - """One of shellcon.COMP_TYPE_* values""" - pass - - - @property - def Checked(self)->'typing.Any': - """True indicates item is currently displayed""" - pass - - - @property - def fDirty(self)->'typing.Any': - """Indicates if unsaved changes exist""" - pass - - - @property - def NoScroll(self)->'typing.Any': - """True disables scrolling""" - pass - - - @property - def Pos(self)->'typing.Any': - """COMPPOS dictionary determining window size and placement""" - pass - - - @property - def FriendlyName(self)->'typing.Any': - """String of at most MAX_PATH-1 characters, truncated if longer""" - pass - - - @property - def Source(self)->'typing.Any': - """String of at most INTERNET_MAX_URL_LENGTH-1 characters""" - pass - - - @property - def SubscribedURL(self)->'typing.Any': - """String of at most INTERNET_MAX_URL_LENGTH-1 characters""" - pass - - - @property - def CurItemState(self)->'typing.Any': - """One of shellcon.IS_* flags""" - pass - - - @property - def Original(self)->'typing.Any': - """COMPSTATEINFO dictionary""" - pass - - - @property - def Restored(self)->'typing.Any': - """COMPSTATEINFO dictionary""" - pass - - - @property - def Size(self)->'typing.Any': - """Size of structure, ignored on input""" - pass - - -class COMPONENTSOPT(object): - """A dictionary containing data to fill a COMPONENTSOPT struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def EnableComponents(self)->'typing.Any': - """True if components are enabled""" - pass - - - @property - def ActiveDesktop(self)->'typing.Any': - """True if Active Desktop is enabled""" - pass - - - @property - def Size(self)->'typing.Any': - """Size of structure, ignored on input""" - pass - - -class COMPPOS(object): - """A dictionary containing data to fill a COMPPOS struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Left(self)->'typing.Any': - """""" - pass - - - @property - def Top(self)->'typing.Any': - """""" - pass - - - @property - def Width(self)->'typing.Any': - """""" - pass - - - @property - def Height(self)->'typing.Any': - """""" - pass - - - @property - def Index(self)->'typing.Any': - """""" - pass - - - @property - def CanResize(self)->'typing.Any': - """""" - pass - - - @property - def CanResizeX(self)->'typing.Any': - """""" - pass - - - @property - def CanResizeY(self)->'typing.Any': - """""" - pass - - - @property - def PreferredLeftPercent(self)->'typing.Any': - """""" - pass - - - @property - def PreferredTopPercent(self)->'typing.Any': - """""" - pass - - - @property - def Size(self)->'typing.Any': - """Size of structure, ignored on input""" - pass - - -class COMPSTATEINFO(object): - """A dictionary containing data to fill a COMPSTATEINFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Left(self)->'typing.Any': - """Specified as screen coordinates""" - pass - - - @property - def Top(self)->'typing.Any': - """Specified as screen coordinates""" - pass - - - @property - def Width(self)->'typing.Any': - """Measured in pixels""" - pass - - - @property - def Height(self)->'typing.Any': - """Measured in pixels""" - pass - - - @property - def dwItemState(self)->'typing.Any': - """One of IS_NORMAL, IS_FULLSCREEN IS_SPLIT""" - pass - - - @property - def Size(self)->'typing.Any': - """Size of structure, ignored on input""" - pass - - -class DEFCONTENTMENU(object): - """A tuple representing a DEFCONTEXTMENU structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class ELEMDESC(object): - """An ELEMDESC is respresented as a tuple of""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class EXP_DARWIN_LINK(object): - """Dictionary containing information for a EXP_DARWIN_LINK struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Signature(self)->'typing.Any': - """The type of data block, one of shellcon.*_SIG values""" - pass - - - @property - def DarwinID(self)->'typing.Any': - """The Windows Installer id for the link""" - pass - - - @property - def wDarwinID(self)->'typing.Any': - """The installer id as Unicode""" - pass - - - @property - def Size(self)->'typing.Any': - """Size of structure, ignored on input""" - pass - - -class EXP_SPECIAL_FOLDER(object): - """Dictionary containing information for a EXP_SPECIAL_FOLDER struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Signature(self)->'typing.Any': - """The type of data block, one of shellcon.*_SIG values""" - pass - - - @property - def idSpecialFolder(self)->'typing.Any': - """The special folder id of the target (shellcon.CSIDL_*)""" - pass - - - @property - def Offset(self)->'typing.Any': - """Offset into the link's PIDL""" - pass - - - @property - def Size(self)->'typing.Any': - """Size of structure, ignored on input""" - pass - - -class EXP_SZ_LINK(object): - """Dictionary containing information for an EXP_SZ_LINK or EXP_SZ_ICON struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Signature(self)->'typing.Any': - """The type of data block, one of shellcon.*_SIG values""" - pass - - - @property - def Target(self)->'typing.Any': - """The link's target or icon location""" - pass - - - @property - def wTarget(self)->'typing.Any': - """The target in Unicode form""" - pass - - - @property - def Size(self)->'typing.Any': - """Size of structure, ignored on input""" - pass - - -class FUNCDESC(object): - """A FUNCDESC object represents a COM TYPEATTR structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def memid(self)->'int': - """""" - pass - - - @property - def scodeArray(self)->'typing.Tuple[typing.Any, ...]': - """""" - pass - - - @property - def args(self)->'typing.Tuple[ELEMDESC, ...]': - """""" - pass - - - @property - def funckind(self)->'typing.Any': - """""" - pass - - - @property - def invkind(self)->'typing.Any': - """""" - pass - - - @property - def callconv(self)->'typing.Any': - """""" - pass - - - @property - def cParamsOpt(self)->'typing.Any': - """""" - pass - - - @property - def oVft(self)->'typing.Any': - """""" - pass - - - @property - def rettype(self)->'ELEMDESC': - """""" - pass - - - @property - def wFuncFlags(self)->'typing.Any': - """""" - pass - - -class IDLDESC(object): - """An IDLDESC is respresented as""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class MAPIINIT_0(object): - """A MAPIINIT_0 is represented as a tuple of:""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class NT_CONSOLE_PROPS(object): - """Dictionary containing information for a NT_CONSOLE_PROPS struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Signature(self)->'typing.Any': - """The type of data block, one of shellcon.*_SIG values""" - pass - - - @property - def FillAttribute(self)->'typing.Any': - """Character attributes for fill operations""" - pass - - - @property - def PopupFillAttribute(self)->'typing.Any': - """Fill attributes for popups""" - pass - - - @property - def ScreenBufferSize(self)->'typing.Tuple[typing.Any, typing.Any]': - """Size of console screen buffer, in character cells""" - pass - - - @property - def WindowSize(self)->'typing.Tuple[typing.Any, typing.Any]': - """Size of console window in character cells""" - pass - - - @property - def WindowOrigin(self)->'typing.Tuple[typing.Any, typing.Any]': - """Window position, in screen coordinates""" - pass - - - @property - def nFont(self)->'typing.Any': - """Number of font to be displayed. See win32console::GetNumberOfConsoleFonts""" - pass - - - @property - def InputBufferSize(self)->'typing.Any': - """Size of console's input buffer""" - pass - - - @property - def FontSize(self)->'typing.Tuple[typing.Any, typing.Any]': - """Size of font""" - pass - - - @property - def FontFamily(self)->'typing.Any': - """Font family""" - pass - - - @property - def FontWeight(self)->'typing.Any': - """Controls thickness of displayed font""" - pass - - - @property - def FaceName(self)->'typing.Any': - """Name of font face, 31 characters at most""" - pass - - - @property - def CursorSize(self)->'typing.Any': - """Relative size of cursor, expressed as percent of character size""" - pass - - - @property - def FullScreen(self)->'typing.Any': - """Causes console to run in full screen mode""" - pass - - - @property - def QuickEdit(self)->'typing.Any': - """""" - pass - - - @property - def InsertMode(self)->'typing.Any': - """""" - pass - - - @property - def AutoPosition(self)->'typing.Any': - """Lets system determine window placement""" - pass - - - @property - def HistoryBufferSize(self)->'typing.Any': - """Size of command line history buffer""" - pass - - - @property - def NumberOfHistoryBuffers(self)->'typing.Any': - """""" - pass - - - @property - def HistoryNoDup(self)->'typing.Any': - """""" - pass - - - @property - def ColorTable(self)->'typing.Any': - """Tuple of 16 ints containing console's color attributes""" - pass - - - @property - def Size(self)->'typing.Any': - """Size of structure, ignored on input""" - pass - - -class NT_FE_CONSOLE_PROPS(object): - """Dictionary containing information for a NT_FE_CONSOLE_PROPS struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Signature(self)->'typing.Any': - """The type of data block, one of shellcon.*_SIG values""" - pass - - - @property - def CodePage(self)->'typing.Any': - """The codepage to be used for console text""" - pass - - - @property - def Size(self)->'typing.Any': - """Size of structure, ignored on input""" - pass - - -class PROPSPEC(object): - """Identifies a property. Can be either an int property id, or a str/unicode property name.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyADSVALUE(object): - """A tuple:""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyADS_ATTR_INFO(object): - """Represents a ADS_ATTR_INFO structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def AttrName(self)->'typing.Any': - """The name""" - pass - - - @property - def ControlCode(self)->'int': - """""" - pass - - - @property - def ADsType(self)->'int': - """""" - pass - - - @property - def Values(self)->'typing.List[typing.Any]': - """""" - pass - - -class PyADS_OBJECT_INFO(object): - """Represents a ADS_OBJECT_INFO structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def RDN(self)->'typing.Any': - """The name""" - pass - - - @property - def ObjectDN(self)->'typing.Any': - """""" - pass - - - @property - def ParentDN(self)->'typing.Any': - """""" - pass - - - @property - def ClassName(self)->'typing.Any': - """""" - pass - - -class PyADS_SEARCHPREF_INFO(object): - """A tuple of:""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyBIND_OPTS(object): - """Dictionary representation of a BIND_OPTS struct - -May eventually be extended to include BIND_OPTS2 members""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Flags(self)->'typing.Any': - """Value from BIND_FLAGS enum: BIND_MAYBOTHERUSER, BIND_JUSTTESTEXISTENCE or 0""" - pass - - - @property - def Mode(self)->'typing.Any': - """Combination of storagecon.STGM_* values""" - pass - - - @property - def TickCountDeadline(self)->'typing.Any': - """Operation timeout in milliseconds""" - pass - - - @property - def cbStruct(self)->'typing.Any': - """Size of struct, ignored on input""" - pass - - -class PyCMINVOKECOMMANDINFO(object): - """A tuple of parameters to be converted to a CMINVOKECOMMANDINFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyDSBCAPS(object): - """A Python object, representing a DSBCAPS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwFlags(self)->'int': - """Flags that specify buffer-object capabilities.FlagDescriptionDSBCAPS_PRIMARYBUFFERIndicates that the buffer is a primary sound buffer. If this value is not specified, a secondary sound buffer will be created.DSBCAPS_STATICIndicates that the buffer will be used for static sound data. Typically, these buffers are loaded once and played many times. These buffers are candidates for hardware memory.DSBCAPS_LOCHARDWAREThe buffer is in hardware memory and uses hardware mixing.DSBCAPS_LOCSOFTWAREThe buffer is in software memory and uses software mixing.DSBCAPS_CTRL3DThe buffer is either a primary buffer or a secondary buffer that uses 3-D control. To create a primary buffer, the dwFlags member of the DSBUFFERDESC structure should include the DSBCAPS_PRIMARYBUFFER flag.DSBCAPS_CTRLFREQUENCYThe buffer must have frequency control capability.DSBCAPS_CTRLPANThe buffer must have pan control capability.DSBCAPS_CTRLVOLUMEThe buffer must have volume control capability.DSBCAPS_CTRLPOSITIONNOTIFYThe buffer must have control position notify capability.DSBCAPS_STICKYFOCUSChanges the focus behavior of the sound buffer. This flag can be specified in an IDirectSound::CreateSoundBuffer call. With this flag set, an application using DirectSound can continue to play its sticky focus buffers if the user switches to another application not using DirectSound. In this situation, the application's normal buffers are muted, but the sticky focus buffers are still audible. This is useful for nongame applications, such as movie playback (DirectShow™), when the user wants to hear the soundtrack while typing in Microsoft Word or Microsoft® Excel, for example. However, if the user switches to another DirectSound application, all sound buffers, both normal and sticky focus, in the previous application are muted.DSBCAPS_GLOBALFOCUSThe buffer is a global sound buffer. With this flag set, an application using DirectSound can continue to play its buffers if the user switches focus to another application, even if the new application uses DirectSound. The one exception is if you switch focus to a DirectSound application that uses the DSSCL_EXCLUSIVE or DSSCL_WRITEPRIMARY flag for its cooperative level. In this case, the global sounds from other applications will not be audible.DSBCAPS_GETCURRENTPOSITION2Indicates that IDirectSoundBuffer::GetCurrentPosition should use the new behavior of the play cursor. In DirectSound in DirectX 1, the play cursor was significantly ahead of the actual playing sound on emulated sound cards; it was directly behind the write cursor. Now, if the DSBCAPS_GETCURRENTPOSITION2 flag is specified, the application can get a more accurate play position. If this flag is not specified, the old behavior is preserved for compatibility. Note that this flag affects only emulated sound cards; if a DirectSound driver is present, the play cursor is accurate for DirectSound in all versions of DirectX.DSBCAPS_MUTE3DATMAXDISTANCEThe sound is reduced to silence at the maximum distance. The buffer will stop playing when the maximum distance is exceeded, so that processor time is not wasted.""" - pass - - - @property - def nChannels(self)->'int': - """Size of the buffer, in bytes.""" - pass - - - @property - def dwUnlockTransferRate(self)->'int': - """Specifies the rate, in kilobytes per second, at which data is transferred to the buffer memory when IDirectSoundBuffer::Unlock is called. High-performance applications can use this value to determine the time required for IDirectSoundBuffer::Unlock to execute. For software buffers located in system memory, the rate will be very high because no processing is required. For hardware buffers, the rate might be slower because the buffer might have to be downloaded to the sound card, which might have a limited transfer rate.""" - pass - - - @property - def nAvgBytesPerSec(self)->'int': - """Specifies whether the returned handle is inherited when a new process is created. If this member is TRUE, the new process inherits the handle. Sentinel""" - pass - - -class PyDSBUFFERDESC(object): - """A Python object, representing a DSBUFFERDESC structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwFlags(self)->'int': - """Identifies the capabilities to include when creating a new DirectSoundBuffer object. Specify one or more of the following:FlagDescriptionDSBCAPS_PRIMARYBUFFERIndicates that the buffer is a primary sound buffer. If this value is not specified, a secondary sound buffer will be created.DSBCAPS_STATICIndicates that the buffer will be used for static sound data. Typically, these buffers are loaded once and played many times. These buffers are candidates for hardware memory.DSBCAPS_LOCHARDWAREThe buffer is in hardware memory and uses hardware mixing.DSBCAPS_LOCSOFTWAREThe buffer is in software memory and uses software mixing.DSBCAPS_CTRL3DThe buffer is either a primary buffer or a secondary buffer that uses 3-D control. To create a primary buffer, the dwFlags member of the DSBUFFERDESC structure should include the DSBCAPS_PRIMARYBUFFER flag.DSBCAPS_CTRLFREQUENCYThe buffer must have frequency control capability.DSBCAPS_CTRLPANThe buffer must have pan control capability.DSBCAPS_CTRLVOLUMEThe buffer must have volume control capability.DSBCAPS_CTRLPOSITIONNOTIFYThe buffer must have control position notify capability.DSBCAPS_STICKYFOCUSChanges the focus behavior of the sound buffer. This flag can be specified in an IDirectSound::CreateSoundBuffer call. With this flag set, an application using DirectSound can continue to play its sticky focus buffers if the user switches to another application not using DirectSound. In this situation, the application's normal buffers are muted, but the sticky focus buffers are still audible. This is useful for nongame applications, such as movie playback (DirectShow™), when the user wants to hear the soundtrack while typing in Microsoft Word or Microsoft® Excel, for example. However, if the user switches to another DirectSound application, all sound buffers, both normal and sticky focus, in the previous application are muted.DSBCAPS_GLOBALFOCUSThe buffer is a global sound buffer. With this flag set, an application using DirectSound can continue to play its buffers if the user switches focus to another application, even if the new application uses DirectSound. The one exception is if you switch focus to a DirectSound application that uses the DSSCL_EXCLUSIVE or DSSCL_WRITEPRIMARY flag for its cooperative level. In this case, the global sounds from other applications will not be audible.DSBCAPS_GETCURRENTPOSITION2Indicates that IDirectSoundBuffer::GetCurrentPosition should use the new behavior of the play cursor. In DirectSound in DirectX 1, the play cursor was significantly ahead of the actual playing sound on emulated sound cards; it was directly behind the write cursor. Now, if the DSBCAPS_GETCURRENTPOSITION2 flag is specified, the application can get a more accurate play position. If this flag is not specified, the old behavior is preserved for compatibility. Note that this flag affects only emulated sound cards; if a DirectSound driver is present, the play cursor is accurate for DirectSound in all versions of DirectX.DSBCAPS_MUTE3DATMAXDISTANCEThe sound is reduced to silence at the maximum distance. The buffer will stop playing when the maximum distance is exceeded, so that processor time is not wasted.""" - pass - - - @property - def dwBufferBytes(self)->'int': - """Size of the new buffer, in bytes. This value must be 0 when creating primary buffers. For secondary buffers, the minimum and maximum sizes allowed are specified by DSBSIZE_MIN and DSBSIZE_MAX.""" - pass - - - @property - def lpwfxFormat(self)->'typing.Any': - """Structure specifying the waveform format for the buffer. This value must be None for primary buffers. The application can use IDirectSoundBuffer::SetFormat to set the format of the primary buffer. Sentinel""" - pass - - -class PyDSCAPS(object): - """A Python object, representing a DSCAPS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwFlags(self)->'int': - """Specifies device capabilities. Can be one or more of the following:FlagDescriptionDSCAPS_PRIMARYMONOThe device supports monophonic primary buffers.DSCAPS_PRIMARYSTEREOThe device supports stereo primary buffers.DSCAPS_PRIMARY8BITThe device supports hardware-mixed secondary buffers with 8-bit samples.DSCAPS_PRIMARY16BITThe device supports primary sound buffers with 16-bit samples.DSCAPS_CONTINUOUSRATEThe device supports all sample rates between the dwMinSecondarySampleRate and dwMaxSecondarySampleRate member values. Typically, this means that the actual output rate will be within +/- 10 hertz (Hz) of the requested frequency.DSCAPS_EMULDRIVERThe device does not have a DirectSound driver installed, so it is being emulated through the waveform-audio functions. Performance degradation should be expected.DSCAPS_CERTIFIEDThis driver has been tested and certified by Microsoft.DSCAPS_SECONDARYMONOThe device supports hardware-mixed monophonic secondary buffers.DSCAPS_SECONDARYSTEREOThe device supports hardware-mixed stereo secondary buffers.DSCAPS_SECONDARY8BITThe device supports hardware-mixed secondary buffers with 8-bit samples.DSCAPS_SECONDARY16BITThe device supports hardware-mixed secondary sound buffers with 16-bit samples.""" - pass - - - @property - def dwMinSecondarySampleRate(self)->'int': - """Minimum sample rate supported by this device's hardware secondary sound buffers.""" - pass - - - @property - def dwMaxSecondarySampleRate(self)->'int': - """Maximum sample rate supported by this device's hardware secondary sound buffers.""" - pass - - - @property - def dwPrimaryBuffers(self)->'int': - """Number of primary buffers supported. This value will always be 1.""" - pass - - - @property - def dwMaxHwMixingAllBuffers(self)->'int': - """Specifies the total number of buffers that can be mixed in hardware. This member can be less than the sum of dwMaxHwMixingStaticBuffers and dwMaxHwMixingStreamingBuffers. Resource tradeoffs frequently occur.""" - pass - - - @property - def dwMaxHwMixingStaticBuffers(self)->'int': - """Specifies the maximum number of static sound buffers.""" - pass - - - @property - def dwMaxHwMixingStreamingBuffers(self)->'int': - """Specifies the maximum number of streaming sound buffers.""" - pass - - - @property - def dwFreeHwMixingAllBuffers(self)->'int': - """Description of the free hardware mixing capabilities of the device. An application can use this value to determine whether hardware resources are available for allocation to a secondary sound buffer. Also, by comparing these values to the members that specify maximum mixing capabilities, the resources that are already allocated can be determined.""" - pass - - - @property - def dwFreeHwMixingStaticBuffers(self)->'int': - """Description of the free hardware mixing capabilities of the device. An application can use this value to determine whether hardware resources are available for allocation to a secondary sound buffer. Also, by comparing these values to the members that specify maximum mixing capabilities, the resources that are already allocated can be determined.""" - pass - - - @property - def dwFreeHwMixingStreamingBuffers(self)->'int': - """Description of the free hardware mixing capabilities of the device. An application can use this value to determine whether hardware resources are available for allocation to a secondary sound buffer. Also, by comparing these values to the members that specify maximum mixing capabilities, the resources that are already allocated can be determined.""" - pass - - - @property - def dwMaxHw3DAllBuffers(self)->'int': - """Description of the hardware 3-D positional capabilities of the device.""" - pass - - - @property - def dwMaxHw3DStaticBuffers(self)->'int': - """Description of the hardware 3-D positional capabilities of the device.""" - pass - - - @property - def dwMaxHw3DStreamingBuffers(self)->'int': - """Description of the hardware 3-D positional capabilities of the device.""" - pass - - - @property - def dwFreeHw3DAllBuffers(self)->'int': - """Description of the free, or unallocated, hardware 3-D positional capabilities of the device.""" - pass - - - @property - def dwFreeHw3DStaticBuffers(self)->'int': - """Description of the free, or unallocated, hardware 3-D positional capabilities of the device.""" - pass - - - @property - def dwFreeHw3DStreamingBuffers(self)->'int': - """Description of the free, or unallocated, hardware 3-D positional capabilities of the device.""" - pass - - - @property - def dwTotalHwMemBytes(self)->'int': - """Size, in bytes, of the amount of memory on the sound card that stores static sound buffers.""" - pass - - - @property - def dwFreeHwMemBytes(self)->'int': - """Size, in bytes, of the free memory on the sound card.""" - pass - - - @property - def dwMaxContigFreeHwMemBytes(self)->'int': - """Size, in bytes, of the largest contiguous block of free memory on the sound card.""" - pass - - - @property - def dwUnlockTransferRateHwBuffers(self)->'int': - """Description of the rate, in kilobytes per second, at which data can be transferred to hardware static sound buffers. This and the number of bytes transferred determines the duration of a call to the IDirectSoundBuffer::Update method.""" - pass - - - @property - def dwPlayCpuOverheadSwBuffers(self)->'int': - """Description of the processing overhead, as a percentage of the central processing unit, needed to mix software buffers (those located in main system memory). This varies according to the bus type, the processor type, and the clock speed. The unlock transfer rate for software buffers is 0 because the data need not be transferred anywhere. Similarly, the play processing overhead for hardware buffers is 0 because the mixing is done by the sound device.""" - pass - - -class PyDSCBCAPS(object): - """A Python object, representing a DSCBCAPS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwFlags(self)->'int': - """Specifies device capabilities. Can be 0 or DSCBCAPS_EMULDRIVER (indicates that no DirectSound Device is available and standard wave audio functions are being used).""" - pass - - - @property - def dwBufferBytes(self)->'int': - """The size, in bytes, of the capture buffer.""" - pass - - -class PyDSCBUFFERDESC(object): - """A Python object, representing a DSCBUFFERDESC structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwFlags(self)->'int': - """Identifies the capabilities to include when creating a new DirectSoundBuffer object. Can be zero or the following flag:FlagDescriptionDSCBCAPS_WAVEMAPPEDThe Win32 wave mapper will be used for formats not supported by the device.""" - pass - - - @property - def dwBufferBytes(self)->'int': - """Size of the new buffer, in bytes. This value must be 0 when creating primary buffers. For secondary buffers, the minimum and maximum sizes allowed are specified by DSBSIZE_MIN and DSBSIZE_MAX.""" - pass - - - @property - def lpwfxFormat(self)->'typing.Any': - """Structure specifying the waveform format for the buffer. This value must be None for primary buffers. The application can use IDirectSoundBuffer::SetFormat to set the format of the primary buffer. Sentinel""" - pass - - -class PyDSCCAPS(object): - """A Python object, representing a DSCCAPS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwFlags(self)->'int': - """Specifies device capabilities. Can be zero or the following flag:FlagDescriptionDSCCAPS_EMULDRIVERIndicates that no DirectSound Device is available and standard wave audio functions are being used.""" - pass - - - @property - def dwFormats(self)->'int': - """Bitset of supported WAVE_FORMAT formats.""" - pass - - - @property - def dwChannels(self)->'int': - """Number of channels supported by the device.""" - pass - - -class PyDSOP_FILTER_FLAGS(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def uplevel(self)->'PyDSOP_UPLEVEL_FILTER_FLAGS': - """""" - pass - - - @property - def downlevel(self)->'typing.Any': - """""" - pass - - -class PyDSOP_SCOPE_INIT_INFO(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def type(self)->'typing.Any': - """""" - pass - - - @property - def scope(self)->'typing.Any': - """""" - pass - - - @property - def hr(self)->'typing.Any': - """""" - pass - - - @property - def dcName(self)->'str': - """""" - pass - - - @property - def filterFlags(self)->'PyDSOP_FILTER_FLAGS': - """""" - pass - - -class PyDSOP_SCOPE_INIT_INFOs(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyDSOP_UPLEVEL_FILTER_FLAGS(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def bothModes(self)->'typing.Any': - """""" - pass - - - @property - def mixedModeOnly(self)->'typing.Any': - """""" - pass - - - @property - def nativeModeOnly(self)->'typing.Any': - """""" - pass - - -class PyFORMATETC(object): - """Tuple representing a FORMATETC struct describing an OLE data format""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyGFileOperationProgressSink(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def StartOperations(self,) -> 'None': - """ - Called as operation begins, before any modifications are done - -Args: - - - -Returns: - - None - - """ - pass - - - def FinishOperations(self,Result:'typing.Any') -> 'None': - """ - Called after all actions have been performed - -Args: - - Result(typing.Any):HRESULT of last operation performed - -Returns: - - None - - """ - pass - - - def PreRenameItem(self,Flags:'typing.Any',Item:'PyIShellItem',NewName:'typing.Any') -> 'None': - """ - Called before each file rename - -Args: - - Flags(typing.Any):Flags specifying copy behaviour, combination of shellcon.TSF_* flags - Item(PyIShellItem):Shell interface of the copied item - NewName(typing.Any):New display name of the item - -Returns: - - None - - """ - pass - - - def PostRenameItem(self,Flags:'typing.Any',Item:'PyIShellItem',NewName:'typing.Any',hrRename:'typing.Any',NewlyCreated:'PyIShellItem') -> 'None': - """ - Called after each file rename - -Args: - - Flags(typing.Any):Flags specifying rename behaviour, combination of shellcon.TSF_* flags - Item(PyIShellItem):Shell interface of item before rename - NewName(typing.Any):The new name of the item, may be mangled to resolve filename conflicts - hrRename(typing.Any):HRESULT of the rename operation - NewlyCreated(PyIShellItem):Shell interface of the item after rename - -Returns: - - None - - """ - pass - - - def PreMoveItem(self,Flags:'typing.Any',Item:'PyIShellItem',DestinationFolder:'PyIShellItem',NewName:'typing.Any') -> 'None': - """ - Called before each move operation - -Args: - - Flags(typing.Any):Flags specifying move behaviour, combination of shellcon.TSF_* flags - Item(PyIShellItem):The item to be moved - DestinationFolder(PyIShellItem):The folder into which it will be moved - NewName(typing.Any):Name of moved item, may be None if not to be changed - -Returns: - - None - - """ - pass - - - def PostMoveItem(self,Flags:'typing.Any',Item:'PyIShellItem',DestinationFolder:'PyIShellItem',NewName:'typing.Any',hrMove:'typing.Any',NewlyCreated:'PyIShellItem') -> 'None': - """ - Called after each move operation - -Args: - - Flags(typing.Any):Flags specifying move behaviour, combination of shellcon.TSF_* flags - Item(PyIShellItem):Interface of the item before it was moved - DestinationFolder(PyIShellItem):The folder into which it was moved - NewName(typing.Any):Name of item in its new location, may be mangled in case of conflict - hrMove(typing.Any):HRESULT of the move operation - NewlyCreated(PyIShellItem):Shell interface of the item in its new location - -Returns: - - None - - """ - pass - - - def PreCopyItem(self,Flags:'typing.Any',Item:'PyIShellItem',DestinationFolder:'PyIShellItem',NewName:'typing.Any') -> 'None': - """ - Called before each copy operation - -Args: - - Flags(typing.Any):Flags specifying copy behaviour, combination of shellcon.TSF_* flags - Item(PyIShellItem):The item to be copied - DestinationFolder(PyIShellItem):Folder into which it will be copied - NewName(typing.Any):Name to be given to the copy, will be None if keeping original name - -Returns: - - None - - """ - pass - - - def PostCopyItem(self,Flags:'typing.Any',Item:'PyIShellItem',DestinationFolder:'PyIShellItem',NewName:'typing.Any',hrCopy:'typing.Any',NewlyCreated:'PyIShellItem') -> 'None': - """ - Called after each copy operation - -Args: - - Flags(typing.Any):Flags specifying copy behaviour, combination of shellcon.TSF_* flags - Item(PyIShellItem):The original item - DestinationFolder(PyIShellItem):Folder into which it was copied - NewName(typing.Any):Name of item after copy, may be mangled in case of name conflict - hrCopy(typing.Any):HRESULT of the copy operation - NewlyCreated(PyIShellItem):Shell interface of the copy - -Returns: - - None - - """ - pass - - - def PreDeleteItem(self,Flags:'typing.Any',Item:'PyIShellItem') -> 'None': - """ - Called before each delete operation - -Args: - - Flags(typing.Any):Flags specifying delete behaviour, combination of shellcon.TSF_* flags - Item(PyIShellItem):Item to be deleted - -Returns: - - None - - """ - pass - - - def PostDeleteItem(self,Flags:'typing.Any',Item:'PyIShellItem',hrDelete:'typing.Any',NewlyCreated:'PyIShellItem') -> 'None': - """ - Called after each delete operation - -Args: - - Flags(typing.Any):Flags specifying delete behaviour, combination of shellcon.TSF_* flags - Item(PyIShellItem):Item that was deleted - hrDelete(typing.Any):HRESULT of the delete operation - NewlyCreated(PyIShellItem):Item in the recycle bin, or None if deleted without recycling - -Returns: - - None - - """ - pass - - - def PreNewItem(self,Flags:'typing.Any',DestinationFolder:'PyIShellItem',NewName:'typing.Any') -> 'None': - """ - Called before each new file is created - -Args: - - Flags(typing.Any):Flags specifying creation behaviour, combination of shellcon.TSF_* flags - DestinationFolder(PyIShellItem):Folder where item will be created - NewName(typing.Any):Name of item to be created - -Returns: - - None - - """ - pass - - - def PostNewItem(self,Flags:'typing.Any',DestinationFolder:'PyIShellItem',NewName:'typing.Any',TemplateName:'typing.Any',FileAttributes:'typing.Any',hrNew:'typing.Any',NewItem:'PyIShellItem') -> 'None': - """ - Called after each new file is created - -Args: - - Flags(typing.Any):Flags specifying creation behaviour, combination of shellcon.TSF_* flags - DestinationFolder(PyIShellItem):Folder in which item was created - NewName(typing.Any):Name of created item, may be mangled if file name conflicts occurred - TemplateName(typing.Any):Template file used to initialize new item - FileAttributes(typing.Any):File attributes of new item - hrNew(typing.Any):HRESULT of the create operation - NewItem(PyIShellItem):Shell interface of created item - -Returns: - - None - - """ - pass - - - def UpdateProgress(self,WorkTotal:'typing.Any',WorkSoFar:'typing.Any') -> 'None': - """ - Gives an estimate of total work completed - -Args: - - WorkTotal(typing.Any):Undimensioned number representing total amount of work - WorkSoFar(typing.Any):Undimensioned number representing amount already completed - -Returns: - - None - - """ - pass - - - def ResetTimer(self,) -> 'None': - """ - Not implemented, according to MSDN - -Args: - - - -Returns: - - None - - """ - pass - - - def PauseTimer(self,) -> 'None': - """ - Not implemented, according to MSDN - -Args: - - - -Returns: - - None - - """ - pass - - - def ResumeTimer(self,) -> 'None': - """ - Not implemented, according to MSDN - -Args: - - - -Returns: - - None - - """ - pass - - -class PyGSecurityInformation(object): - """Gateway wrapper for the implement-only ISecurityInformation interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetObjectInformation(self,) -> 'SI_OBJECT_INFO': - """ - Returns information identifying the object - -whose security is to be editted, and which pages are to appear in the property sheet - -Args: - - - -Returns: - - SI_OBJECT_INFO:PyGSecurityInformation.GetObjectInformation -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, - -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 - -settings - -Args: - - RequestedInformation(typing.Any):Combination of SECURITY_INFORMATION flags indicating which components of the object's security descriptor you should return - Default(typing.Any):If true, return a default security descriptor rather than current security. (invoked when 'Reset' button is clicked) - -Returns: - - PySECURITY_DESCRIPTOR - - """ - pass - - - def SetSecurity(self,SecurityInformation:'typing.Any',SecurityDescriptor:'PySECURITY_DESCRIPTOR') -> 'None': - """ - Applies the modified security to the object - -Args: - - SecurityInformation(typing.Any):SECURITY_INFORMATION flags specifying which types of security information are to be applied - SecurityDescriptor(PySECURITY_DESCRIPTOR):The security information to be applied to the objectReturn ValueAny returned value is ignored - -Returns: - - None:The security information to be applied to the objectReturn ValueAny returned value is ignored - - - """ - pass - - - def GetAccessRights(self,ObjectType:'PyIID',Flags:'typing.Any') -> 'typing.Tuple[SI_ACCESS, typing.Any]': - """ - Retrieves permission that can be set - -Args: - - ObjectType(PyIID):GUID representing type of object, may be None - Flags(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, and a zero-based index indicating which of them is the default - -Returns: - - 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, - -and a zero-based index indicating which of them is the default - - - """ - pass - - - def MapGeneric(self,ObjectType:'PyIID',AceFlags:'typing.Any',Mask:'typing.Any') -> 'typing.Any': - """ - Translates generic access rights to specific equivalents - -Args: - - ObjectType(PyIID):Type of object that permissions apply to, None or GUID_NULL indicates object itself - AceFlags(typing.Any):Flags from the ACE that contains the permissions - Mask(typing.Any):Bitmask containing access rightsCommentsSee win32security::MapGenericMaskReturn ValueThis method should return the input bitmask will all generic rights mapped to specific rights - -Returns: - - typing.Any:Bitmask containing access rightsComments - -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 - -implementation supports - -Args: - - - -Returns: - - typing.Tuple[SI_INHERIT_TYPE, ...]:PyGSecurityInformation.GetInheritTypes - -(SI_INHERIT_TYPE,...) = GetInheritTypes()Requests types of inheritance that your - -implementation supports -Return ValueReturns a sequence of SI_INHERIT_TYPE tuples - - - """ - pass - - - def PropertySheetPageCallback(self,hwnd:'typing.Any',Msg:'typing.Any',Page:'typing.Any') -> 'None': - """ - Called by each page as it is created and destroyed - -Args: - - hwnd(typing.Any):Handle to the window for the page - Msg(typing.Any):Flag indicating type of event, one of PSPCB_CREATE,PSPCB_RELEASE,PSPCB_SI_INITDIALOG - Page(typing.Any):SI_PAGE_TYPE value indicating which page is making the call (ntsecuritycon.SI_PAGE_*)Return ValueAny returned value will be ignored - -Returns: - - None:SI_PAGE_TYPE value indicating which page is making the call (ntsecuritycon.SI_PAGE_*)Return ValueAny returned value will be ignored - - - """ - pass - - -class PyIADesktopP2(object): - """An interface to the ActiveDesktop""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def UpdateAllDesktopSubscriptions(self,) -> 'None': - """ - Updates webpage subscriptions on the desktop - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIADs(object): - """An object representing the IADs interface. - -In most cases you can achieve the same result via IDispatch - however, this - -interface allows you get get and set properties without the IDispatch - -overhead.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ADsPath(self)->'str': - """""" - pass - - - @property - def AdsPath(self)->'str': - """Synonym for ADsPath""" - pass - - - @property - def Class(self)->'str': - """""" - pass - - - @property - def GUID(self)->'str': - """Like the IADs method, this returns a string rather than a GUID object.""" - pass - - - @property - def Name(self)->'str': - """""" - pass - - - @property - def Parent(self)->'str': - """""" - pass - - - @property - def Schema(self)->'str': - """""" - pass - - - def GetInfo(self,) -> 'None': - """ - Description of GetInfo. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetInfo(self,) -> 'None': - """ - Description of SetInfo. - -Args: - - - -Returns: - - None - - """ - pass - - - def Get(self,prop:'str') -> 'typing.Any': - """ - Description of Get. - -Args: - - prop(str):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. - -Returns: - - 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 - - - def Put(self,_property:'str',val:'typing.Any') -> 'None': - """ - Description of Put. - -Args: - - _property(str):The property name to set - val(typing.Any):The value to set. - -Returns: - - None - - """ - pass - - - def get(self,prop:'str') -> 'typing.Any': - """ - Description of Get. - -Args: - - prop(str):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. - -Returns: - - 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 - - - def put(self,_property:'str',val:'typing.Any') -> 'None': - """ - Description of Put. - -Args: - - _property(str):The property name to set - val(typing.Any):The value to set. - -Returns: - - None - - """ - pass - - -class PyIADsContainer(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetObject(self,_class:'str',relativeName:'str') -> 'PyIDispatch': - """ - None - -Args: - - _class(str):Specifies the name of the object class as known in the underlying directory and identical to the one retrieved through the get_Class property method. If the class name is None, the provider returns the first item found in the container. - relativeName(str):Specifies the name of the object as known in the underlying directory and identical to the one retrieved through the get_Name property method. - -Returns: - - PyIDispatch - - """ - pass - - - def get_Count(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def get_Filter(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_Filter(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - - def get_Hints(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_Hints(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - -class PyIADsUser(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def get_AccountDisabled(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_AccountDisabled(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - - def get_AccountExpirationDate(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_AccountExpirationDate(self,val:'PyTime') -> 'None': - """ - None - -Args: - - val(PyTime): - -Returns: - - None - - """ - pass - - - def get_BadLoginAddress(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def get_BadLoginCount(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def get_Department(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_Department(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - - def get_Description(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_Description(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - - def get_Division(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_Division(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - - def get_EmailAddress(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_EmailAddress(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - - def get_EmployeeID(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_EmployeeID(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - - def get_FirstName(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_FirstName(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - - def get_FullName(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_FullName(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - - def get_HomeDirectory(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_HomeDirectory(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - - def get_HomePage(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_HomePage(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - - def get_LoginScript(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_LoginScript(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - - def SetPassword(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - - def ChangePassword(self,oldval:'typing.Any',newval:'typing.Any') -> 'None': - """ - None - -Args: - - oldval(typing.Any): - newval(typing.Any): - -Returns: - - None - - """ - pass - - -class PyIActiveDesktop(object): - """An interface to the ActiveDesktop""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ApplyChanges(self,Flags:'typing.Any') -> 'None': - """ - Applies changes to ActiveDesktop settings and persists them to the registry. - -Args: - - Flags(typing.Any):Combination of shellcon.AD_APPLY_* flags - -Returns: - - None - - """ - pass - - - def GetWallpaper(self,cchWallpaper:'typing.Any',Reserved:'typing.Any'=0) -> 'typing.Any': - """ - Returns the current wallpaper - -Args: - - cchWallpaper(typing.Any):Number of characters to allocate for buffer - Reserved(typing.Any):Use 0 if passed in - -Returns: - - typing.Any - - """ - pass - - - def SetWallpaper(self,Wallpaper:'typing.Any',Reserved:'typing.Any'=0) -> 'None': - """ - Sets the desktop wallpaper - -Args: - - Wallpaper(typing.Any):File to be used as new wallpaper - Reserved(typing.Any):Reserved, use 0 if passed in - -Returns: - - None - - """ - pass - - - def GetWallpaperOptions(self,Reserved:'typing.Any'=0) -> 'typing.Any': - """ - Returns wallpaper style - -Args: - - Reserved(typing.Any):Use 0 if passed inReturn ValueReturns one of the WPSTYLE_* values - -Returns: - - typing.Any:Use 0 if passed in -Return ValueReturns one of the WPSTYLE_* values - - - """ - pass - - - def SetWallpaperOptions(self,Style:'typing.Any',Reserved:'typing.Any'=0) -> 'None': - """ - Sets wallpaper style - -Args: - - Style(typing.Any):The wallpaper style, one of the WPSTYLE_* constants - Reserved(typing.Any):Reserved, use 0 if passed in - -Returns: - - None - - """ - pass - - - def GetPattern(self,cchPattern:'typing.Any'=1024,Reserved:'typing.Any'=0) -> 'None': - """ - Returns the wallpaper pattern - -Args: - - cchPattern(typing.Any):Number of characters to allocate for buffer - Reserved(typing.Any):Use 0 if passed inReturn ValueReturns a unicode string containing decimal values representing the pattern - -Returns: - - None:Use 0 if passed in -Return ValueReturns a unicode string containing decimal values representing the pattern - - - """ - pass - - - def SetPattern(self,Pattern:'typing.Any',Reserved:'typing.Any'=0) -> 'None': - """ - Sets the wallpaper pattern - -Args: - - Pattern(typing.Any):String of decimal numbers representing a picture - Reserved(typing.Any):Use 0 if passed in - -Returns: - - None - - """ - pass - - - def GetDesktopItemOptions(self,) -> 'typing.Any': - """ - Returns options for Active Desktop. - -Args: - - - -Returns: - - typing.Any:PyIActiveDesktop.GetDesktopItemOptions - -dict = GetDesktopItemOptions()Returns options for Active Desktop. -Return ValueReturns a COMPONENTSOPT dictionary - - - """ - pass - - - def SetDesktopItemOptions(self,comp:'typing.Any',Reserved:'typing.Any'=0) -> 'None': - """ - Sets Active Desktop options - -Args: - - comp(typing.Any):COMPONENTSOPT dictionary - Reserved(typing.Any):Use 0 if passed in - -Returns: - - None - - """ - pass - - - def AddDesktopItem(self,comp:'typing.Any',Reserved:'typing.Any'=0) -> 'None': - """ - Creates a new item to display on the desktop - -Args: - - comp(typing.Any):COMPONENT dictionary - Reserved(typing.Any):Use 0 if passed in - -Returns: - - None - - """ - pass - - - def AddDesktopItemWithUI(self,hwnd:'int',comp:'typing.Any',Flags:'typing.Any') -> 'None': - """ - Adds a desktop item, allowing user interaction - -Args: - - hwnd(int):Handle to parent window - comp(typing.Any):COMPONENT dictionary - Flags(typing.Any):One of shellcon.DTI_ADDUI_* flags - -Returns: - - None - - """ - pass - - - def ModifyDesktopItem(self,comp:'typing.Any',Flags:'typing.Any') -> 'None': - """ - Changes parameters for a desktop item - -Args: - - comp(typing.Any):COMPONENT dictionary - Flags(typing.Any):Combination of shellcon.COMP_ELEM_* flags - -Returns: - - None - - """ - pass - - - def RemoveDesktopItem(self,comp:'typing.Any',Reserved:'typing.Any'=0) -> 'None': - """ - Removes an item from the Active Desktop - -Args: - - comp(typing.Any):COMPONENT dictionary specifying which component to remove - Reserved(typing.Any):Use 0 if passed in - -Returns: - - None - - """ - pass - - - def GetDesktopItemCount(self,) -> 'None': - """ - Returns number of defined desktop items. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDesktopItem(self,Component:'typing.Any',Reserved:'typing.Any'=0) -> 'typing.Any': - """ - Returns desktop item parameters by index - -Args: - - Component(typing.Any):The zero-based index of the component to get - Reserved(typing.Any):Use 0 if passed inReturn ValueReturns a COMPONENT dictionary describing the item - -Returns: - - typing.Any:Use 0 if passed in -Return ValueReturns a COMPONENT dictionary describing the item - - - """ - pass - - - def GetDesktopItemByID(self,ID:'typing.Any',reserved:'typing.Any'=0) -> 'typing.Any': - """ - Returns desktop item parameters by Id - -Args: - - ID(typing.Any):The Id of the desktop item - reserved(typing.Any):Use 0 if passed inReturn ValueReturns a COMPONENT dictionary - -Returns: - - typing.Any:Use 0 if passed in -Return ValueReturns a COMPONENT dictionary - - - """ - pass - - - def GenerateDesktopItemHtml(self,FileName:'typing.Any',comp:'typing.Any',Reserved:'typing.Any'=0) -> 'None': - """ - Creates an HTML page for the desktop item - -Args: - - FileName(typing.Any):Name of file to be created - comp(typing.Any):COMPONENT dictionary specifying the desktop item - Reserved(typing.Any):Use 0 if passed in - -Returns: - - None - - """ - pass - - - def AddUrl(self,hwnd:'int',Source:'typing.Any',comp:'typing.Any',Flags:'typing.Any') -> 'None': - """ - Adds a web page to desktop, allowing user interaction - -Args: - - hwnd(int):Parent windows for any user interactive - Source(typing.Any):Source URL - comp(typing.Any):COMPONENT dictionary - Flags(typing.Any):ADDURL_SILENT, or 0 - -Returns: - - None - - """ - pass - - - def GetDesktopItemBySource(self,Source:'typing.Any',Reserved:'typing.Any'=0) -> 'typing.Any': - """ - Returns desktop item parameters by URL - -Args: - - Source(typing.Any):The URL address of the item to retrieve - Reserved(typing.Any):Use 0 if passed inReturn ValueReturns a COMPONENT dictionary - -Returns: - - typing.Any:Use 0 if passed in -Return ValueReturns a COMPONENT dictionary - - - """ - pass - - -class PyIActiveDesktopP(object): - """An interface to the ActiveDesktop""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetSafeMode(self,Flags:'typing.Any') -> 'None': - """ - Changes Active Desktop to safe mode - -Args: - - Flags(typing.Any):One of shellcon.SSM_* flags - -Returns: - - None - - """ - pass - - -class PyIActiveScriptDebug(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetScriptTextAttributes(self,pstrCode:'str',pstrDelimiter:'str',dwFlags:'typing.Any') -> 'typing.Tuple[typing.Any, ...]': - """ - Returns the text attributes for an arbitrary block - -of script text. - -Args: - - pstrCode(str):The script block text. - pstrDelimiter(str):See PyIActiveScriptParse::ParseScriptText for a description of this argument. - dwFlags(typing.Any):See PyIActiveScriptParse::ParseScriptText for a description of this argument.CommentsSmart hosts use this call to delegate GetText calls made on their axscript::PyIDebugDocumentText - -Returns: - - typing.Tuple[typing.Any, ...] - - """ - pass - - - def GetScriptletTextAttributes(self,pstrCode:'str',pstrDelimiter:'str',dwFlags:'typing.Any') -> 'None': - """ - Description of GetScriptletTextAttributes. - -Args: - - pstrCode(str):The script block text. - pstrDelimiter(str):See PyIActiveScriptParse::ParseScriptText for a description of this argument. - dwFlags(typing.Any):See PyIActiveScriptParse::ParseScriptText for a description of this argument. - -Returns: - - None - - """ - pass - - - def EnumCodeContextsOfPosition(self,dwSourceContext:'typing.Any',uCharacterOffset:'typing.Any',uNumChars:'typing.Any') -> 'None': - """ - Description of EnumCodeContextsOfPosition. - -Args: - - dwSourceContext(typing.Any):Description for dwSourceContext - uCharacterOffset(typing.Any):Description for uCharacterOffset - uNumChars(typing.Any):Description for uNumChars - -Returns: - - None - - """ - pass - - -class PyIActiveScriptError(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetExceptionInfo(self,) -> 'None': - """ - Description of GetExceptionInfo. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetSourcePosition(self,) -> 'None': - """ - Description of GetSourcePosition. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetSourceLineText(self,) -> 'None': - """ - Description of GetSourceLineText. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIActiveScriptErrorDebug(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDocumentContext(self,) -> 'None': - """ - Description of GetDocumentContext. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetStackFrame(self,) -> 'None': - """ - Description of GetStackFrame. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIActiveScriptParseProcedure(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ParseProcedureText(self,pstrCode:'typing.Any',pstrFormalParams:'typing.Any',pstrProcedureName:'typing.Any',pstrItemName:'typing.Any',punkContext:'PyIUnknown',pstrDelimiter:'typing.Any',dwSourceContextCookie:'typing.Any',ulStartingLineNumber:'typing.Any',dwFlags:'typing.Any') -> 'None': - """ - Description of ParseProcedureText. - -Args: - - pstrCode(typing.Any):Description for pstrCode - pstrFormalParams(typing.Any):Description for pstrFormalParams - pstrProcedureName(typing.Any):Description for pstrProcedureName - pstrItemName(typing.Any):Description for pstrItemName - punkContext(PyIUnknown):Description for punkContext - pstrDelimiter(typing.Any):Description for pstrDelimiter - dwSourceContextCookie(typing.Any):Description for dwSourceContextCookie - ulStartingLineNumber(typing.Any):Description for ulStartingLineNumber - dwFlags(typing.Any):Description for dwFlags - -Returns: - - None - - """ - pass - - -class PyIActiveScriptSite(object): - """An object providing the IActiveScriptSite interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetLCID(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetItemInfo(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetDocVersionString(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def OnStateChange(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def OnEnterScript(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def OnLeaveScript(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def OnScriptError(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def OnScriptTerminate(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyIActiveScriptSiteDebug(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDocumentContextFromPosition(self,dwSourceContext:'typing.Any',uCharacterOffset:'typing.Any',uNumChars:'typing.Any') -> 'None': - """ - Description of GetDocumentContextFromPosition. - -Args: - - dwSourceContext(typing.Any):Description for dwSourceContext - uCharacterOffset(typing.Any):Description for uCharacterOffset - uNumChars(typing.Any):Description for uNumChars - -Returns: - - None - - """ - pass - - - def GetApplication(self,) -> 'None': - """ - Description of GetApplication. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetRootApplicationNode(self,) -> 'None': - """ - Description of GetRootApplicationNode. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnScriptErrorDebug(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Allows a smart host to control the handling of runtime - -errors - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any]:PyIActiveScriptSiteDebug.OnScriptErrorDebug - -int, int = OnScriptErrorDebug()Allows a smart host to control the handling of runtime - -errors -Return ValueThe result is a tuple of (bCallDebugger, bCallOnScriptErrorWhenContinuing) - - - """ - pass - - -class PyIAddrBook(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ResolveName(self,uiParm:'typing.Any',flags:'typing.Any',entryTitle:'str',ADRLIST:'typing.Any') -> 'None': - """ - Performs name resolution, assigning entry identifiers to recipients in a recipient list. - -Args: - - uiParm(typing.Any):hwnd of a dialogs parent. - flags(typing.Any):Bitmask of flags that controls whether a dialog box can be displayed. - entryTitle(str): - ADRLIST(typing.Any):Partial addresses to resolve. - -Returns: - - None - - """ - pass - - - def OpenEntry(self,entryId:'str',iid:'PyIID',flags:'typing.Any') -> 'typing.Any': - """ - Opens a folder or message and returns an interface object for further access. - -Args: - - entryId(str):The entryID of the object - iid(PyIID):The IID of the object to return, or None for the default IID - flags(typing.Any):Bitmask of flags that controls how the object is opened. - -Returns: - - typing.Any - - """ - pass - - - def CompareEntryIDs(self,entryId:'str',entryId1:'str',flags:'typing.Any'=0) -> 'typing.Any': - """ - Compares two entry identifiers belonging to a particular address book provider to determine if they refer to the same address book object - -Args: - - entryId(str):The first entry ID to be compared - entryId1(str):The second entry ID to be compared - flags(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. - -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 - - -class PyIApplicationDebugger(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def QueryAlive(self,) -> 'None': - """ - Returns true if alive, else false. - -Args: - - - -Returns: - - None - - """ - pass - - - def CreateInstanceAtDebugger(self,rclsid:'PyIID',pUnkOuter:'PyIUnknown',dwClsContext:'typing.Any',riid:'PyIID') -> 'None': - """ - Create objects in the application process address space. - -Args: - - rclsid(PyIID):Description for rclsid - pUnkOuter(PyIUnknown):Description for pUnkOuter - dwClsContext(typing.Any):Description for dwClsContext - riid(PyIID):Description for riidCommentsProvides a mechanism for the debugger IDE, running out-of-process to the application, to create objects in the application process. This method simply delegates to CoCreateInstance. - -Returns: - - None - - """ - pass - - - def onDebugOutput(self,pstr:'typing.Any') -> 'None': - """ - None - -Args: - - pstr(typing.Any):Description for pstrCommentsThe debugger can use this to display the string in an output window. - -Returns: - - None - - """ - pass - - - def onHandleBreakPoint(self,prpt:'PyIRemoteDebugApplicationThread',br:'typing.Any',pError:'typing.Any') -> 'None': - """ - Called when a breakpoint is hit. - -Args: - - prpt(PyIRemoteDebugApplicationThread):Description for prpt - br(typing.Any):Description for br - pError(typing.Any):Description for pErrorCommentsThe application will remain suspended until the debugger IDE calls PyIDebugApplication::ResumeFromBreakPoint. - -Returns: - - None - - """ - pass - - - def onClose(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def onDebuggerEvent(self,guid:'PyIID',uUnknown:'PyIUnknown') -> 'None': - """ - Description of onDebuggerEvent. - -Args: - - guid(PyIID): - uUnknown(PyIUnknown):CommentsThe semantics of guid and unknown are entirely application/debugger defined This method may return E_NOTIMPL. - -Returns: - - None - - """ - pass - - -class PyIApplicationDestinations(object): - """Allows an application to removed items from its jump lists""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetAppID(self,AppID:'typing.Any') -> 'None': - """ - Specifies the application whose jump list is to be accessed - -Args: - - AppID(typing.Any):Taskbar identifier for the applicationCommentsThis method is only needed if the application sets its own taskbar identifier - -Returns: - - None - - """ - pass - - - def RemoveDestination(self,punk:'PyIUnknown') -> 'None': - """ - Removes a single entry from the jump lists - -Args: - - punk(PyIUnknown):IShellItem or IShellLink representing an item in the application's jump listCommentsDoes not remove pinned items - -Returns: - - None - - """ - pass - - - def RemoveAllDestinations(self,) -> 'None': - """ - Removes all Recent and Frequent jump list entries - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIApplicationDocumentLists(object): - """Interface used to retrieve the jump lists for an application""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetAppID(self,AppID:'typing.Any') -> 'None': - """ - Specifies the application whose jump list is to be accessed - -Args: - - AppID(typing.Any):Taskbar identifier for the applicationCommentsThis method is only needed if the application sets its own taskbar identifier - -Returns: - - None - - """ - pass - - - def GetList(self,ListType:'typing.Any',riid:'PyIID',ItemsDesired:'typing.Any'=0) -> 'PyIEnumObjects': - """ - Retrieves a list of items in a jump list - -Args: - - ListType(typing.Any):Type of document list to return, shellcon.ADLT_RECENT or ADLT_FREQUENT - riid(PyIID):The interface to return, IID_IEnumObjects or IID_IObjectArray - ItemsDesired(typing.Any):Number of items to return, use 0 for all available - -Returns: - - PyIEnumObjects - - """ - pass - - -class PyIAsyncOperation(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetAsyncMode(self,fDoOpAsync:'typing.Any') -> 'None': - """ - Description of SetAsyncMode. - -Args: - - fDoOpAsync(typing.Any):Description for fDoOpAsync - -Returns: - - None - - """ - pass - - - def GetAsyncMode(self,) -> 'typing.Any': - """ - Description of GetAsyncMode. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def StartOperation(self,pbcReserved:'PyIBindCtx') -> 'None': - """ - Description of StartOperation. - -Args: - - pbcReserved(PyIBindCtx):Description for pbcReserved - -Returns: - - None - - """ - pass - - - def InOperation(self,) -> 'None': - """ - Description of InOperation. - -Args: - - - -Returns: - - None - - """ - pass - - - def EndOperation(self,hResult:'typing.Any',pbcReserved:'PyIBindCtx',dwEffects:'typing.Any') -> 'None': - """ - Description of EndOperation. - -Args: - - hResult(typing.Any):Description for hResult - pbcReserved(PyIBindCtx):Description for pbcReserved - dwEffects(typing.Any):Description for dwEffects - -Returns: - - None - - """ - pass - - -class PyIAttach(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetLastError(self,hr:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - Returns the last error code for the object. - -Args: - - hr(typing.Any):Contains the error code generated in the previous method call. - flags(typing.Any):Indicates for format for the output. - -Returns: - - typing.Any - - """ - pass - - -class PyIBindCtx(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetRunningObjectTable(self,) -> 'PyIRunningObjectTable': - """ - Retrieves an object interfacing to the Running - -Object Table. - -Args: - - - -Returns: - - PyIRunningObjectTable - - """ - pass - - - def GetBindOptions(self,) -> 'PyBIND_OPTS': - """ - Retrieves the bind options for the bind context - -Args: - - - -Returns: - - PyBIND_OPTS - - """ - pass - - - def SetBindOptions(self,bindopts:'typing.Any') -> 'None': - """ - Sets the bind options for the context - -Args: - - bindopts(typing.Any):PyBIND_OPTS dictionary containing the binding options - -Returns: - - None - - """ - pass - - - def RegisterObjectParam(self,Key:'str',punk:'PyIUnknown') -> 'None': - """ - Adds an object to the context's keyed table of associated objects - -Args: - - Key(str):The string key for the object to be registered - punk(PyIUnknown):COM object to be registered with the bind context - -Returns: - - None - - """ - pass - - - def RevokeObjectParam(self,Key:'str') -> 'None': - """ - Removes one of the bind context's registered objects - -Args: - - Key(str):The string key for the object to be removed - -Returns: - - None - - """ - pass - - - def GetObjectParam(self,Key:'str') -> 'PyIUnknown': - """ - Returns one of the bind context's associated objects - -Args: - - Key(str):The string key for the object to be returned - -Returns: - - PyIUnknown - - """ - pass - - - def EnumObjectParam(self,) -> 'PyIEnumString': - """ - Creates an enumerator to list context's string keys - -Args: - - - -Returns: - - PyIEnumString - - """ - pass - - -class PyIBrowserFrameOptions(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetFrameOptions(self,dwMask:'typing.Any') -> 'None': - """ - Description of GetFrameOptions. - -Args: - - dwMask(typing.Any):Description for dwMask - -Returns: - - None - - """ - pass - - -class PyICancelMethodCalls(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Cancel(self,Seconds:'typing.Any') -> 'None': - """ - Cancels a pending call - -Args: - - Seconds(typing.Any):Wait timeout in seconds - -Returns: - - None - - """ - pass - - - def TestCancel(self,) -> 'typing.Any': - """ - Checks if a request has been made to cancel a call - -Args: - - - -Returns: - - typing.Any:PyICancelMethodCalls.TestCancel - -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 - - -class PyICatInformation(object): - """A Python interface to ICatInformation""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def EnumCategories(self,lcid:'typing.Any'=0) -> 'PyIEnumCATEGORYINFO': - """ - Returns an enumerator for the component categories - -registered on the system. - -Args: - - lcid(typing.Any):lcid - -Returns: - - PyIEnumCATEGORYINFO - - """ - pass - - - def GetCategoryDesc(self,lcid:'typing.Any'=0) -> 'str': - """ - Retrieves the localized description string for a specific category - -ID. - -Args: - - lcid(typing.Any):lcidCommentsThe return type is a unicode object. - -Returns: - - str - - """ - pass - - - def EnumClassesOfCategories(self,listIIdImplemented:'typing.List[PyIID]'=None,listIIdRequired:'typing.Any'=None) -> 'PyIEnumGUID': - """ - Returns an enumerator over the classes that - -implement one or more interfaces. - -Args: - - listIIdImplemented(typing.List[PyIID]):A sequence of PyIID objects, or None. - listIIdRequired(typing.Any):A sequence of PyIID objects, or None. - -Returns: - - PyIEnumGUID - - """ - pass - - -class PyICatRegister(object): - """An interface to a COM ICatRegister interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def RegisterCategories(self,arg:'typing.List[typing.Tuple[PyIID, typing.Any, str]]') -> 'None': - """ - Registers one or more component categories. Each component category - -consists of a CATID and a list of locale-dependent description strings. - -Args: - - arg(typing.List[typing.Tuple[PyIID, typing.Any, str]]):A sequence of category descriptions. - -Returns: - - None - - """ - pass - - - def UnRegisterCategories(self,arg:'typing.List[PyIID]') -> 'None': - """ - Unregister one or more previously registered categories. - -Args: - - arg(typing.List[PyIID]):The list of category IDs to be unregistered. - -Returns: - - None - - """ - pass - - - def RegisterClassImplCategories(self,clsid:'PyIID',arg:'typing.List[PyIID]') -> 'None': - """ - Registers the class as implementing one or more component - -categories. - -Args: - - clsid(PyIID):Class ID of the relevent class - arg(typing.List[PyIID]):A sequence of category IDs to be associated with the class. - -Returns: - - None - - """ - pass - - - def UnRegisterClassImplCategories(self,clsid:'PyIID',arg:'typing.List[PyIID]') -> 'None': - """ - Unregisters the class as implementing one or more component - -categories. - -Args: - - clsid(PyIID):Class ID of the relevent class - arg(typing.List[PyIID]):A sequence of category IDs to be unregistered from the class. - -Returns: - - None - - """ - pass - - - def RegisterClassReqCategories(self,clsid:'PyIID',arg:'typing.List[PyIID]') -> 'None': - """ - Registers the class as requiring one or more component - -categories. - -Args: - - clsid(PyIID):Class ID of the relevent class - arg(typing.List[PyIID]):A sequence of category IDs to be associated with the class. - -Returns: - - None - - """ - pass - - - def UnRegisterClassReqCategories(self,clsid:'PyIID',arg:'typing.List[PyIID]') -> 'None': - """ - Unregisters the class as requiring one or more component - -categories. - -Args: - - clsid(PyIID):Class ID of the relevent class - arg(typing.List[PyIID]):A sequence of category IDs to be unregistered for the class. - -Returns: - - None - - """ - pass - - -class PyICategoryProvider(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CanCategorizeOnSCID(self,pscid:'typing.Any') -> 'None': - """ - Description of CanCategorizeOnSCID. - -Args: - - pscid(typing.Any):Description for pscid - -Returns: - - None - - """ - pass - - - def GetDefaultCategory(self,) -> 'None': - """ - Description of GetDefaultCategory. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCategoryForSCID(self,pscid:'typing.Any') -> 'None': - """ - Description of GetCategoryForSCID. - -Args: - - pscid(typing.Any):Description for pscid - -Returns: - - None - - """ - pass - - - def EnumCategories(self,) -> 'None': - """ - Description of EnumCategories. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCategoryName(self,guid:'PyIID') -> 'None': - """ - Description of GetCategoryName. - -Args: - - guid(PyIID):Description for pguidCommentsThe buffer is always 1024 chars long - -Returns: - - None - - """ - pass - - - def CreateCategory(self,guid:'PyIID',riid:'PyIID') -> 'None': - """ - Description of CreateCategory. - -Args: - - guid(PyIID):Description for pguid - riid(PyIID):Description for riid - -Returns: - - None - - """ - pass - - -class PyIClassFactory(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateInstance(self,outerUnknown:'PyIUnknown',iid:'PyIID') -> 'PyIUnknown': - """ - Creates an uninitialized object. - -Args: - - outerUnknown(PyIUnknown):Usually None, otherwise the outer unknown if the object is being created as part of an aggregate. - iid(PyIID):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. - -Returns: - - 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, - -allowing instances to be created more quickly. - -Args: - - bInc(typing.Any):1 of the server should be locked, 0 if the server should be unlocked. - -Returns: - - None - - """ - pass - - -class PyIClientSecurity(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def QueryBlanket(self,Proxy:'PyIUnknown') -> 'typing.Any': - """ - Retrieves the authentication settings for an interface - -Args: - - Proxy(PyIUnknown):An interface created through a proxy - -Returns: - - typing.Any - - """ - pass - - - def SetBlanket(self,Proxy:'PyIUnknown',AuthnSvc:'typing.Any',AuthzSvc:'typing.Any',ServerPrincipalName:'str',AuthnLevel:'typing.Any',ImpLevel:'typing.Any',AuthInfo:'typing.Any',Capabilities:'typing.Any') -> 'None': - """ - Changes the authentication options used with an interface - -Args: - - Proxy(PyIUnknown):The proxy interface for which to set security options - AuthnSvc(typing.Any):Authentication service identifier, pythoncom.RPC_C_AUTHN_* (but not RPC_C_AUTHN_LEVEL_*) - AuthzSvc(typing.Any):Authorization service identifier, pythoncom.RPC_C_AUTHZ_* - ServerPrincipalName(str):SPN that identifies the server, can be None - AuthnLevel(typing.Any):Authentication level, pythoncom.RPC_C_AUTHN_LEVEL_* - ImpLevel(typing.Any):Impersonation level, pythoncom.RPC_C_IMP_LEVEL_* - AuthInfo(typing.Any):Not supported yet, use only None - Capabilities(typing.Any):Combination of pythoncom.EOAC_* flags. Must be a subset of the capabilities of the specified authentication service. - -Returns: - - None - - """ - pass - - - def CopyProxy(self,Proxy:'PyIUnknown') -> 'PyIUnknown': - """ - Makes a private copy of a proxy interface - -Args: - - Proxy(PyIUnknown):The remote interface to be copied - -Returns: - - PyIUnknown - - """ - pass - - -class PyIColumnProvider(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,psci:'typing.Any') -> 'None': - """ - Description of Initialize. - -Args: - - psci(typing.Any):Description for psci - -Returns: - - None - - """ - pass - - - def GetColumnInfo(self,dwIndex:'typing.Any') -> 'None': - """ - Description of GetColumnInfo. - -Args: - - dwIndex(typing.Any):Description for dwIndex - -Returns: - - None - - """ - pass - - - def GetItemData(self,pscid:'typing.Any',pscd:'typing.Any') -> 'None': - """ - Description of GetItemData. - -Args: - - pscid(typing.Any):Description for pscid - pscd(typing.Any):Description for pscd - -Returns: - - None - - """ - pass - - -class PyIConnectionPoint(object): - """A Python wrapper of a COM IConnectionPoint interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetConnectionInterface(self,) -> 'PyIID': - """ - Retrieves the IID of the interface represented by the - -connection point. - -Args: - - - -Returns: - - PyIID - - """ - pass - - - def GetConnectionPointContainer(self,) -> 'PyIConnectionPointContainer': - """ - Gets the connection point - -container for the object. - -Args: - - - -Returns: - - PyIConnectionPointContainer - - """ - pass - - - def Advise(self,unk:'PyIUnknown') -> 'typing.Any': - """ - Establishes a connection between the connection point object and the client's - -sink. - -Args: - - unk(PyIUnknown):The client's advise sinkReturn ValueThe result is the connection point identifier used by PyIConnectionPoint::Unadvise - -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 - -IConnectionPoint::Advise. The dwCookie parameter identifies the connection to terminate. - -Args: - - cookie(typing.Any):The connection token - -Returns: - - None - - """ - pass - - - def EnumConnections(self,) -> 'PyIEnumConnections': - """ - Creates an enumerator to iterate through the - -connections for the connection point - -Args: - - - -Returns: - - PyIEnumConnections - - """ - pass - - -class PyIConnectionPointContainer(object): - """A Python wrapper of a COM IConnectionPointContainer interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def EnumConnectionPoints(self,) -> 'PyIEnumConnectionPoints': - """ - Creates an enumerator object - -to iterate through all the connection points supported in the connectable object, one connection point per outgoing - -IID. - -Args: - - - -Returns: - - PyIEnumConnectionPoints - - """ - pass - - - def FindConnectionPoint(self,iid:'PyIID') -> 'PyIConnectionPoint': - """ - Finds a connection point for the - -given IID - -Args: - - iid(PyIID):The IID of the requested connection. - -Returns: - - PyIConnectionPoint - - """ - pass - - -class PyIContext(object): - """Allows access to properties defined for the current context (Requires win2k or later)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetProperty(self,rpolicyId:'PyIID',flags:'typing.Any',pUnk:'PyIUnknown') -> 'None': - """ - Sets a property on the context - -Args: - - rpolicyId(PyIID):GUID identifying the property to be set - flags(typing.Any):Reserved, use only 0 - pUnk(PyIUnknown):The property value - -Returns: - - None - - """ - pass - - - def RemoveProperty(self,rPolicyId:'PyIID') -> 'None': - """ - Removes a property from the context - -Args: - - rPolicyId(PyIID):GUID that identifies a context property - -Returns: - - None - - """ - pass - - - def GetProperty(self,rGuid:'PyIID') -> 'typing.Tuple[typing.Any, PyIUnknown]': - """ - Retrieves a context property - -Args: - - rGuid(PyIID):GUID that identifies a context propertyReturn ValueReturns flags (CPFLAGS is reserved, no defined values) and the IUnknown interface set for the property - -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 - - - def EnumContextProps(self,) -> 'PyIEnumContextProps': - """ - Returns an enumerator for the context properties - -Args: - - - -Returns: - - PyIEnumContextProps - - """ - pass - - -class PyIContextMenu(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def QueryContextMenu(self,hmenu:'int',indexMenu:'typing.Any',idCmdFirst:'typing.Any',idCmdLast:'typing.Any',uFlags:'typing.Any') -> 'typing.Any': - """ - Adds options to a context menu - -Args: - - hmenu(int):Handle to menu to which items should be added - indexMenu(typing.Any):Zero-based index at which to add first item - idCmdFirst(typing.Any):Minimum menu item Id - idCmdLast(typing.Any):Max menu item Id - uFlags(typing.Any):Combination of shellcon.CMF_* flags, can be 0 - -Returns: - - typing.Any - - """ - pass - - - def InvokeCommand(self,pici:'PyCMINVOKECOMMANDINFO') -> 'None': - """ - Executes a context menu option - -Args: - - pici(PyCMINVOKECOMMANDINFO):Tuple of parameters representing a CMINVOKECOMMANDINFO struct - -Returns: - - None - - """ - pass - - - def GetCommandString(self,idCmd:'typing.Any',uType:'typing.Any',cchMax:'typing.Any'=2048) -> 'typing.Any': - """ - Retrieves verb or help text for a context menu option - -Args: - - idCmd(typing.Any):Id of the command - uType(typing.Any):One of the shellcon.GCS_* constants - cchMax(typing.Any):Size of buffer to create for returned string - -Returns: - - typing.Any - - """ - pass - - -class PyICopyHookA(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CopyCallback(self,hwnd:'typing.Any',wFunc:'typing.Any',wFlags:'typing.Any',srcFile:'typing.Union[str, typing.Any]',srcAttribs:'typing.Any',destFile:'typing.Union[str, typing.Any]',destAttribs:'typing.Any') -> 'None': - """ - Description of CopyCallback. - -Args: - - hwnd(typing.Any):Description for hwnd - wFunc(typing.Any):Description for wFunc - wFlags(typing.Any):Description for wFlags - srcFile(typing.Union[str, typing.Any]):Description for srcFile - srcAttribs(typing.Any):Description for srcAttribs - destFile(typing.Union[str, typing.Any]):Description for destFile - destAttribs(typing.Any):Description for destAttribs - -Returns: - - None - - """ - pass - - -class PyICopyHookW(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CopyCallback(self,hwnd:'typing.Any',wFunc:'typing.Any',wFlags:'typing.Any',srcFile:'typing.Union[str, typing.Any]',srcAttribs:'typing.Any',destFile:'typing.Union[str, typing.Any]',destAttribs:'typing.Any') -> 'None': - """ - Description of CopyCallback. - -Args: - - hwnd(typing.Any):Description for hwnd - wFunc(typing.Any):Description for wFunc - wFlags(typing.Any):Description for wFlags - srcFile(typing.Union[str, typing.Any]):Description for srcFile - srcAttribs(typing.Any):Description for srcAttribs - destFile(typing.Union[str, typing.Any]):Description for destFile - destAttribs(typing.Any):Description for destAttribs - -Returns: - - None - - """ - pass - - -class PyICreateTypeInfo(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetGuid(self,guid:'PyIID') -> 'None': - """ - Description of SetGuid. - -Args: - - guid(PyIID):Description for guid - -Returns: - - None - - """ - pass - - - def SetTypeFlags(self,uTypeFlags:'typing.Any') -> 'None': - """ - Description of SetTypeFlags. - -Args: - - uTypeFlags(typing.Any):Description for uTypeFlags - -Returns: - - None - - """ - pass - - - def SetDocString(self,pStrDoc:'typing.Any') -> 'None': - """ - Description of SetDocString. - -Args: - - pStrDoc(typing.Any):Description for pStrDoc - -Returns: - - None - - """ - pass - - - def SetHelpContext(self,dwHelpContext:'typing.Any') -> 'None': - """ - Description of SetHelpContext. - -Args: - - dwHelpContext(typing.Any):Description for dwHelpContext - -Returns: - - None - - """ - pass - - - def SetVersion(self,wMajorVerNum:'typing.Any',wMinorVerNum:'typing.Any') -> 'None': - """ - Description of SetVersion. - -Args: - - wMajorVerNum(typing.Any):Description for wMajorVerNum - wMinorVerNum(typing.Any):Description for wMinorVerNum - -Returns: - - None - - """ - pass - - - def AddRefTypeInfo(self,pTInfo:'PyITypeInfo') -> 'None': - """ - Description of AddRefTypeInfo. - -Args: - - pTInfo(PyITypeInfo):Description for pTInfo - -Returns: - - None - - """ - pass - - - def AddFuncDesc(self,index:'typing.Any') -> 'None': - """ - Description of AddFuncDesc. - -Args: - - index(typing.Any):Description for index - -Returns: - - None - - """ - pass - - - def AddImplType(self,index:'typing.Any',hRefType:'typing.Any') -> 'None': - """ - Description of AddImplType. - -Args: - - index(typing.Any):Description for index - hRefType(typing.Any):A hRefType - -Returns: - - None - - """ - pass - - - def SetImplTypeFlags(self,index:'typing.Any',implTypeFlags:'typing.Any') -> 'None': - """ - Description of SetImplTypeFlags. - -Args: - - index(typing.Any):Description for index - implTypeFlags(typing.Any):Description for implTypeFlags - -Returns: - - None - - """ - pass - - - def SetAlignment(self,cbAlignment:'typing.Any') -> 'None': - """ - Description of SetAlignment. - -Args: - - cbAlignment(typing.Any):Description for cbAlignment - -Returns: - - None - - """ - pass - - - def SetSchema(self,pStrSchema:'typing.Any') -> 'None': - """ - Description of SetSchema. - -Args: - - pStrSchema(typing.Any):Description for pStrSchema - -Returns: - - None - - """ - pass - - - def AddVarDesc(self,index:'typing.Any') -> 'None': - """ - Description of AddVarDesc. - -Args: - - index(typing.Any):Description for index - -Returns: - - None - - """ - pass - - - def SetFuncAndParamNames(self,index:'typing.Any',rgszNames:'typing.Tuple[typing.Any, ...]') -> 'None': - """ - Description of SetFuncAndParamNames. - -Args: - - index(typing.Any):Index of the item to set. - rgszNames(typing.Tuple[typing.Any, ...]):A sequence of unicode or String objects. - -Returns: - - None - - """ - pass - - - def SetVarName(self,index:'typing.Any',szName:'typing.Any') -> 'None': - """ - Description of SetVarName. - -Args: - - index(typing.Any):Description for index - szName(typing.Any):Description for szName - -Returns: - - None - - """ - pass - - - def SetTypeDescAlias(self,) -> 'None': - """ - Description of SetTypeDescAlias. - -Args: - - - -Returns: - - None - - """ - pass - - - def DefineFuncAsDllEntry(self,index:'typing.Any',szDllName:'typing.Any',szProcName:'typing.Any') -> 'None': - """ - Description of DefineFuncAsDllEntry. - -Args: - - index(typing.Any):Description for index - szDllName(typing.Any):Description for szDllName - szProcName(typing.Any):Description for szProcName - -Returns: - - None - - """ - pass - - - def SetFuncDocString(self,index:'typing.Any',szDocString:'typing.Any') -> 'None': - """ - Description of SetFuncDocString. - -Args: - - index(typing.Any):Description for index - szDocString(typing.Any):Description for szDocString - -Returns: - - None - - """ - pass - - - def SetVarDocString(self,index:'typing.Any',szDocString:'typing.Any') -> 'None': - """ - Description of SetVarDocString. - -Args: - - index(typing.Any):Description for index - szDocString(typing.Any):Description for szDocString - -Returns: - - None - - """ - pass - - - def SetFuncHelpContext(self,index:'typing.Any',dwHelpContext:'typing.Any') -> 'None': - """ - Description of SetFuncHelpContext. - -Args: - - index(typing.Any):Description for index - dwHelpContext(typing.Any):Description for dwHelpContext - -Returns: - - None - - """ - pass - - - def SetVarHelpContext(self,index:'typing.Any',dwHelpContext:'typing.Any') -> 'None': - """ - Description of SetVarHelpContext. - -Args: - - index(typing.Any):Description for index - dwHelpContext(typing.Any):Description for dwHelpContext - -Returns: - - None - - """ - pass - - - def SetMops(self,index:'typing.Any',bstrMops:'typing.Any') -> 'None': - """ - Description of SetMops. - -Args: - - index(typing.Any):Description for index - bstrMops(typing.Any):Description for bstrMops - -Returns: - - None - - """ - pass - - - def LayOut(self,) -> 'None': - """ - Description of LayOut. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyICreateTypeLib(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateTypeInfo(self,szName:'typing.Any') -> 'None': - """ - Description of CreateTypeInfo. - -Args: - - szName(typing.Any):Description for szName - -Returns: - - None - - """ - pass - - - def SetName(self,szName:'typing.Any') -> 'None': - """ - Description of SetName. - -Args: - - szName(typing.Any):Description for szName - -Returns: - - None - - """ - pass - - - def SetVersion(self,wMajorVerNum:'typing.Any',wMinorVerNum:'typing.Any') -> 'None': - """ - Description of SetVersion. - -Args: - - wMajorVerNum(typing.Any):Description for wMajorVerNum - wMinorVerNum(typing.Any):Description for wMinorVerNum - -Returns: - - None - - """ - pass - - - def SetGuid(self,guid:'PyIID') -> 'None': - """ - Description of SetGuid. - -Args: - - guid(PyIID):Description for guid - -Returns: - - None - - """ - pass - - - def SetDocString(self,szDoc:'typing.Any') -> 'None': - """ - Description of SetDocString. - -Args: - - szDoc(typing.Any):Description for szDoc - -Returns: - - None - - """ - pass - - - def SetHelpFileName(self,szHelpFileName:'typing.Any') -> 'None': - """ - Description of SetHelpFileName. - -Args: - - szHelpFileName(typing.Any):Description for szHelpFileName - -Returns: - - None - - """ - pass - - - def SetHelpContext(self,dwHelpContext:'typing.Any') -> 'None': - """ - Description of SetHelpContext. - -Args: - - dwHelpContext(typing.Any):Description for dwHelpContext - -Returns: - - None - - """ - pass - - - def SetLcid(self,) -> 'None': - """ - Description of SetLcid. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetLibFlags(self,uLibFlags:'typing.Any') -> 'None': - """ - Description of SetLibFlags. - -Args: - - uLibFlags(typing.Any):Description for uLibFlags - -Returns: - - None - - """ - pass - - - def SaveAllChanges(self,) -> 'None': - """ - Description of SaveAllChanges. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyICreateTypeLib2(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateTypeInfo(self,szName:'typing.Any') -> 'None': - """ - Description of CreateTypeInfo. - -Args: - - szName(typing.Any):Description for szName - -Returns: - - None - - """ - pass - - - def SetName(self,szName:'typing.Any') -> 'None': - """ - Description of SetName. - -Args: - - szName(typing.Any):Description for szName - -Returns: - - None - - """ - pass - - - def SetVersion(self,wMajorVerNum:'typing.Any',wMinorVerNum:'typing.Any') -> 'None': - """ - Description of SetVersion. - -Args: - - wMajorVerNum(typing.Any):Description for wMajorVerNum - wMinorVerNum(typing.Any):Description for wMinorVerNum - -Returns: - - None - - """ - pass - - - def SetGuid(self,guid:'PyIID') -> 'None': - """ - Description of SetGuid. - -Args: - - guid(PyIID):Description for guid - -Returns: - - None - - """ - pass - - - def SetDocString(self,szDoc:'typing.Any') -> 'None': - """ - Description of SetDocString. - -Args: - - szDoc(typing.Any):Description for szDoc - -Returns: - - None - - """ - pass - - - def SetHelpFileName(self,szHelpFileName:'typing.Any') -> 'None': - """ - Description of SetHelpFileName. - -Args: - - szHelpFileName(typing.Any):Description for szHelpFileName - -Returns: - - None - - """ - pass - - - def SetHelpContext(self,dwHelpContext:'typing.Any') -> 'None': - """ - Description of SetHelpContext. - -Args: - - dwHelpContext(typing.Any):Description for dwHelpContext - -Returns: - - None - - """ - pass - - - def SetLcid(self,) -> 'None': - """ - Description of SetLcid. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetLibFlags(self,uLibFlags:'typing.Any') -> 'None': - """ - Description of SetLibFlags. - -Args: - - uLibFlags(typing.Any):Description for uLibFlags - -Returns: - - None - - """ - pass - - - def SaveAllChanges(self,) -> 'None': - """ - Description of SaveAllChanges. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyICurrentItem(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyICustomDestinationList(object): - """Interface used to customize an application's jump list""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetAppID(self,AppID:'typing.Any') -> 'None': - """ - Specifies the taskbar identifier for the jump list - -Args: - - AppID(typing.Any):The taskbar identifier of the applicationCommentsOnly needed if the calling app doesn't use the system-assigned default - -Returns: - - None - - """ - pass - - - def BeginList(self,riid:'PyIID') -> 'typing.Tuple[typing.Any, PyIObjectArray]': - """ - Clears the jump list and prepares it to be - -repopulated - -Args: - - riid(PyIID):The interface to returnReturn ValueReturns the number of slots and a collection of all destinations removed from the jump list - -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 - - - def AppendCategory(self,Category:'typing.Any',Items:'PyIObjectArray') -> 'None': - """ - Adds a custom category to the jump list - -Args: - - Category(typing.Any):Display name of the category, can also be a dll and resource id for localization - Items(PyIObjectArray):Collection of IShellItem and/or IShellLink interfaces - -Returns: - - None - - """ - pass - - - def AppendKnownCategory(self,Category:'typing.Any') -> 'None': - """ - Adds one of the predefined categories to the custom list - -Args: - - Category(typing.Any):shellcon.KDC_RECENT or KDC_FREQUENT - -Returns: - - None - - """ - pass - - - def AddUserTasks(self,Items:'PyIObjectArray') -> 'None': - """ - Sets the entries shown in the Tasks category - -Args: - - Items(PyIObjectArray):Collection of PyIShellItem and/or PyIShellLink interfaces - -Returns: - - None - - """ - pass - - - def CommitList(self,) -> 'None': - """ - Finalizes changes. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetRemovedDestinations(self,riid:'PyIID') -> 'PyIObjectArray': - """ - Returns all the items removed from the - -jump list - -Args: - - riid(PyIID):The interface to return - -Returns: - - PyIObjectArray - - """ - pass - - - def DeleteList(self,AppID:'typing.Any'=None) -> 'None': - """ - Removes any customization, leaving only the system-maintained Recent - -and Frequent lists - -Args: - - AppID(typing.Any):The taskbar identifier of the application - -Returns: - - None - - """ - pass - - - def AbortList(self,) -> 'None': - """ - Discards all changes - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDL(object): - """A Python representation of an IDL. Implemented as a sequence of Python strings. - -FALSE*/, UINT *pcb /* = NULL */)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIDataObject(object): - """Used to transfer data in various formats throughout the shell""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetData(self,pformatetcIn:'PyFORMATETC') -> 'PySTGMEDIUM': - """ - Retrieves data from the object in specified format - -Args: - - pformatetcIn(PyFORMATETC):Tuple representing a FORMATETC struct describing how the data should be returned - -Returns: - - PySTGMEDIUM - - """ - pass - - - def GetDataHere(self,pformatetcIn:'PyFORMATETC') -> 'PySTGMEDIUM': - """ - Retunrs a copy of the object's data in specified format - -Args: - - pformatetcIn(PyFORMATETC):Tuple representing a FORMATETC struct describing how the data should be returned - -Returns: - - PySTGMEDIUM - - """ - pass - - - def QueryGetData(self,pformatetc:'PyFORMATETC') -> 'None': - """ - Checks if the objects supports returning data in a particular format. - -Args: - - pformatetc(PyFORMATETC):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. - -Returns: - - 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 - -format that the object supports - -Args: - - pformatectIn(PyFORMATETC):Tuple representing a FORMATETC struct describing how the data should be returned - -Returns: - - PyFORMATETC - - """ - pass - - - def SetData(self,pformatetc:'PyFORMATETC',pmedium:'PySTGMEDIUM',fRelease:'typing.Any') -> 'None': - """ - Sets the data that the object will return. - -Args: - - pformatetc(PyFORMATETC):Tuple representing a FORMATETC struct describing the type of data to be set - pmedium(PySTGMEDIUM):The data to be placed in the object - fRelease(typing.Any):If True, transfers ownership of the data to the object. If False, caller is responsible for releasing the STGMEDIUM. - -Returns: - - None - - """ - pass - - - def EnumFormatEtc(self,dwDirection:'typing.Any') -> 'PyIEnumFORMATETC': - """ - Returns an enumerator to list the data formats that the - -object supports. - -Args: - - dwDirection(typing.Any):Indicates whether to return formats that can be queried or set (pythoncom.DATADIR_GET or DATADIR_SET) - -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 - -changes - -Args: - - pformatetc(PyFORMATETC):Defines the type of data for which the sink will receive notifications. - advf(typing.Any):Combination of values from ADVF enum. (which currently do not appear in any of the constants modules!) - pAdvSink(typing.Any):Currently this interface is not wrapped.Return ValueReturns a unique number that is used to identify the connection - -Returns: - - typing.Any:Currently this interface is not wrapped.Return ValueReturns a unique number that is used to identify the connection - - - """ - pass - - - def DUnadvise(self,dwConnection:'typing.Any') -> 'None': - """ - Disconnects a notification sink. - -Args: - - dwConnection(typing.Any):Identifier of the connection as returned by DAdvise. - -Returns: - - None - - """ - pass - - - def EnumDAdvise(self,) -> 'typing.Any': - """ - Creates an enumerator to list connected notification sinks. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyIDebugApplication(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetName(self,pstrName:'typing.Any') -> 'None': - """ - Sets the name of the application. - -Args: - - pstrName(typing.Any):The name of the application.CommentsThe provided name will be returned in subsequent calls to >om PyIRemoteDebugApplication.GetName>. - -Returns: - - None - - """ - pass - - - def StepOutComplete(self,) -> 'None': - """ - Called by language engines, in single step mode, just before they - -return to their caller. - -Args: - - - -Returns: - - None - - """ - pass - - - def DebugOutput(self,pstr:'typing.Any') -> 'None': - """ - Causes the given string to be displayed by the debugger IDE, normally in - -an output window. - -Args: - - pstr(typing.Any):Description for pstrCommentsThis mechanism provides the means for a language engine to implement language specific debugging output support. Example: Debug.writeln("Help") in JavaScript. - -Returns: - - None - - """ - pass - - - def StartDebugSession(self,) -> 'None': - """ - Causes a default debugger IDE to be started and a debug session to - -be attached to this application if one does not already exist. - -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 - -hit a breakpoint. - -Args: - - br(typing.Any):Break reason - one of the BREAKREASON_* constants.CommentsThis 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 method returns with the action to be taken.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. - -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 - -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 - -various things such as enumerating stack frames or evaluating expressions. -Return ValueThe result is the break resume action - one of the BREAKRESUMEACTION contsants. - - - """ - pass - - - def Close(self,) -> 'None': - """ - Causes this application to release all references and enter a zombie state. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetBreakFlags(self,) -> 'typing.Any': - """ - Returns the current break flags for the application. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetCurrentThread(self,) -> 'PyIDebugApplicationThread': - """ - Returns the application thread object - -associated with the currently running thread. - -Args: - - - -Returns: - - PyIDebugApplicationThread - - """ - pass - - - def CreateAsyncDebugOperation(self,psdo:'PyIDebugSyncOperation') -> 'None': - """ - None - -Args: - - psdo(PyIDebugSyncOperation):Description for psdoCommentsThis provides a mechanism for language engines to implement asynchronous expression and evaluation, etc. without having to know the details of synchronization with the debugger thread. See the descriptions for PyIDebugSyncOperation and PyIDebugAsyncOperation for more details. - -Returns: - - None - - """ - pass - - - def AddStackFrameSniffer(self,pdsfs:'PyIDebugStackFrameSniffer') -> 'typing.Any': - """ - Adds a stack frame sniffer to this application. - -Args: - - pdsfs(PyIDebugStackFrameSniffer):Description for pdsfsCommentsGenerally called by a language engine 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 - -Returns: - - typing.Any:Description for pdsfsComments - -Generally called by a language engine - -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 - - - def RemoveStackFrameSniffer(self,dwCookie:'typing.Any') -> 'None': - """ - Removes a stack frame sniffer from this application. - -Args: - - dwCookie(typing.Any):A cookie obtained from PyIDebugApplication::AddStackFrameSniffer - -Returns: - - None - - """ - pass - - - def QueryCurrentThreadIsDebuggerThread(self,) -> 'None': - """ - Determines if the current running thread is the - -debugger thread. - -Args: - - - -Returns: - - None:PyIDebugApplication.QueryCurrentThreadIsDebuggerThread -QueryCurrentThreadIsDebuggerThread()Determines 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 - -debugger thread. - -Args: - - pptc(typing.Any):Description for pptc - dwParam1(typing.Any):Description for dwParam1 - dwParam2(typing.Any):Description for dwParam2 - dwParam3(typing.Any):Description for dwParam3CommentsThis is generally used so that language engines and hosts can implement free threaded objects on top of their single threaded implementations. - -Returns: - - None - - """ - pass - - - def CreateApplicationNode(self,) -> 'PyIDebugApplicationNode': - """ - Creates a new application node which - -is associated with a specific document provider. - -Args: - - - -Returns: - - PyIDebugApplicationNode - - """ - pass - - - def FireDebuggerEvent(self,guid:'typing.Any',unknown:'PyIUnknown') -> 'None': - """ - Fire a generic event to the IApplicationDebugger (if any) - -Args: - - guid(typing.Any):A GUID. - unknown(PyIUnknown):An unknown object. - -Returns: - - None - - """ - pass - - - def HandleRuntimeError(self,pErrorDebug:'PyIActiveScriptErrorDebug',pScriptSite:'PyIActiveScriptSite') -> 'None': - """ - Description of HandleRuntimeError. - -Args: - - pErrorDebug(PyIActiveScriptErrorDebug):Description for pErrorDebug - pScriptSite(PyIActiveScriptSite):Description for pScriptSite - -Returns: - - None - - """ - pass - - - def FCanJitDebug(self,) -> 'None': - """ - Description of FCanJitDebug. - -Args: - - - -Returns: - - None - - """ - pass - - - def FIsAutoJitDebugEnabled(self,) -> 'None': - """ - Description of FIsAutoJitDebugEnabled. - -Args: - - - -Returns: - - None - - """ - pass - - - def AddGlobalExpressionContextProvider(self,pdsfs:'PyIProvideExpressionContexts') -> 'None': - """ - Description of AddGlobalExpressionContextProvider. - -Args: - - pdsfs(PyIProvideExpressionContexts):Description for pdsfs - -Returns: - - None - - """ - pass - - - def RemoveGlobalExpressionContextProvider(self,dwCookie:'typing.Any') -> 'None': - """ - Description of - -RemoveGlobalExpressionContextProvider. - -Args: - - dwCookie(typing.Any):Description for dwCookie - -Returns: - - None - - """ - pass - - -class PyIDebugApplicationNode(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def EnumChildren(self,) -> 'None': - """ - Description of EnumChildren. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetParent(self,) -> 'PyIDebugApplicationNode': - """ - Returns the parent node. - -Args: - - - -Returns: - - PyIDebugApplicationNode - - """ - pass - - - def SetDocumentProvider(self,pddp:'PyIDebugDocumentProvider') -> 'None': - """ - Description of SetDocumentProvider. - -Args: - - pddp(PyIDebugDocumentProvider):Description for pddp - -Returns: - - None - - """ - pass - - - def Close(self,) -> 'None': - """ - Description of Close. - -Args: - - - -Returns: - - None - - """ - pass - - - def Attach(self,pdanParent:'PyIDebugApplicationNode') -> 'None': - """ - Attach a node to its parent. - -Args: - - pdanParent(PyIDebugApplicationNode):The parent node. None is not acceptable. - -Returns: - - None - - """ - pass - - - def Detach(self,) -> 'None': - """ - Detach a node from its parent. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugApplicationNodeEvents(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def onAddChild(self,prddpChild:'PyIDebugApplicationNode') -> 'None': - """ - Description of onAddChild. - -Args: - - prddpChild(PyIDebugApplicationNode):Description for prddpChild - -Returns: - - None - - """ - pass - - - def onRemoveChild(self,prddpChild:'PyIDebugApplicationNode') -> 'None': - """ - Description of onRemoveChild. - -Args: - - prddpChild(PyIDebugApplicationNode):Description for prddpChild - -Returns: - - None - - """ - pass - - - def onDetach(self,) -> 'None': - """ - Description of onDetach. - -Args: - - - -Returns: - - None - - """ - pass - - - def onAttach(self,prddpParent:'PyIDebugApplicationNode') -> 'None': - """ - Description of onAttach. - -Args: - - prddpParent(PyIDebugApplicationNode):Description for prddpParent - -Returns: - - None - - """ - pass - - -class PyIDebugApplicationThread(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SynchronousCallIntoThread(self,pstcb:'typing.Any',dwParam1:'typing.Any',dwParam2:'typing.Any',dwParam3:'typing.Any') -> 'None': - """ - Description of SynchronousCallIntoThread. - -Args: - - pstcb(typing.Any):Description for pstcb - dwParam1(typing.Any):Description for dwParam1 - dwParam2(typing.Any):Description for dwParam2 - dwParam3(typing.Any):Description for dwParam3 - -Returns: - - None - - """ - pass - - - def QueryIsCurrentThread(self,) -> 'None': - """ - Description of QueryIsCurrentThread. - -Args: - - - -Returns: - - None - - """ - pass - - - def QueryIsDebuggerThread(self,) -> 'None': - """ - Description of QueryIsDebuggerThread. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugCodeContext(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDocumentContext(self,) -> 'None': - """ - Description of GetDocumentContext. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetBreakPoint(self,bps:'typing.Any') -> 'None': - """ - Description of SetBreakPoint. - -Args: - - bps(typing.Any):Description for bps - -Returns: - - None - - """ - pass - - -class PyIDebugDocument(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIDebugDocumentContext(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDocument(self,) -> 'None': - """ - Description of GetDocument. - -Args: - - - -Returns: - - None - - """ - pass - - - def EnumCodeContexts(self,) -> 'None': - """ - Description of EnumCodeContexts. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugDocumentHelper(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Init(self,pda:'PyIDebugApplication',pszShortName:'typing.Any',pszLongName:'typing.Any',docAttr:'typing.Any') -> 'None': - """ - Description of Init. - -Args: - - pda(PyIDebugApplication):Description for pda - pszShortName(typing.Any):Description for pszShortName - pszLongName(typing.Any):Description for pszLongName - docAttr(typing.Any):Description for docAttr - -Returns: - - None - - """ - pass - - - def Attach(self,pddhParent:'PyIDebugDocumentHelper') -> 'None': - """ - Add the document to the doc tree - -Args: - - pddhParent(PyIDebugDocumentHelper):Parent item. If none, this item is top level. - -Returns: - - None - - """ - pass - - - def Detach(self,) -> 'None': - """ - Description of Detach. - -Args: - - - -Returns: - - None - - """ - pass - - - def AddUnicodeText(self,pszText:'typing.Any') -> 'None': - """ - Description of AddUnicodeText. - -Args: - - pszText(typing.Any):Description for pszText - -Returns: - - None - - """ - pass - - - def AddDBCSText(self,) -> 'None': - """ - Description of AddDBCSText. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetDebugDocumentHost(self,pddh:'PyIDebugDocumentHost') -> 'None': - """ - Description of SetDebugDocumentHost. - -Args: - - pddh(PyIDebugDocumentHost):Description for pddh - -Returns: - - None - - """ - pass - - - def AddDeferredText(self,cChars:'typing.Any',dwTextStartCookie:'typing.Any') -> 'None': - """ - Description of AddDeferredText. - -Args: - - cChars(typing.Any):Description for cChars - dwTextStartCookie(typing.Any):Description for dwTextStartCookie - -Returns: - - None - - """ - pass - - - def DefineScriptBlock(self,ulCharOffset:'typing.Any',cChars:'typing.Any',pas:'typing.Any',fScriptlet:'typing.Any') -> 'None': - """ - Description of DefineScriptBlock. - -Args: - - ulCharOffset(typing.Any):Description for ulCharOffset - cChars(typing.Any):Description for cChars - pas(typing.Any):Description for pas - fScriptlet(typing.Any):Description for fScriptlet - -Returns: - - None - - """ - pass - - - def SetDefaultTextAttr(self,staTextAttr:'typing.Any') -> 'None': - """ - Description of SetDefaultTextAttr. - -Args: - - staTextAttr(typing.Any):Description for staTextAttr - -Returns: - - None - - """ - pass - - - def SetTextAttributes(self,ulCharOffset:'typing.Any',obAttr:'typing.Any') -> 'None': - """ - Description of SetTextAttributes. - -Args: - - ulCharOffset(typing.Any):Description for ulCharOffset - obAttr(typing.Any):A sequence of attributes. - -Returns: - - None - - """ - pass - - - def SetLongName(self,pszLongName:'typing.Any') -> 'None': - """ - Description of SetLongName. - -Args: - - pszLongName(typing.Any):Description for pszLongName - -Returns: - - None - - """ - pass - - - def SetShortName(self,pszShortName:'typing.Any') -> 'None': - """ - Description of SetShortName. - -Args: - - pszShortName(typing.Any):Description for pszShortName - -Returns: - - None - - """ - pass - - - def SetDocumentAttr(self,pszAttributes:'typing.Any') -> 'None': - """ - Description of SetDocumentAttr. - -Args: - - pszAttributes(typing.Any):Description for pszAttributes - -Returns: - - None - - """ - pass - - - def GetDebugApplicationNode(self,) -> 'None': - """ - Description of GetDebugApplicationNode. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetScriptBlockInfo(self,dwSourceContext:'typing.Any') -> 'None': - """ - Description of GetScriptBlockInfo. - -Args: - - dwSourceContext(typing.Any):Description for dwSourceContext - -Returns: - - None - - """ - pass - - - def CreateDebugDocumentContext(self,iCharPos:'typing.Any',cChars:'typing.Any') -> 'None': - """ - Description of CreateDebugDocumentContext. - -Args: - - iCharPos(typing.Any):Description for iCharPos - cChars(typing.Any):Description for cChars - -Returns: - - None - - """ - pass - - - def BringDocumentToTop(self,) -> 'None': - """ - Description of BringDocumentToTop. - -Args: - - - -Returns: - - None - - """ - pass - - - def BringDocumentContextToTop(self,pddc:'PyIDebugDocumentContext') -> 'None': - """ - Description of BringDocumentContextToTop. - -Args: - - pddc(PyIDebugDocumentContext):Description for pddc - -Returns: - - None - - """ - pass - - -class PyIDebugDocumentHost(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDeferredText(self,dwTextStartCookie:'typing.Any',cMaxChars:'typing.Any') -> 'None': - """ - Description of GetDeferredText. - -Args: - - dwTextStartCookie(typing.Any):Description for dwTextStartCookie - cMaxChars(typing.Any):Description for cMaxChars - -Returns: - - None - - """ - pass - - - def GetScriptTextAttributes(self,pstrCode:'typing.Any',pstrDelimiter:'typing.Any',dwFlags:'typing.Any') -> 'None': - """ - Description of GetScriptTextAttributes. - -Args: - - pstrCode(typing.Any):Description for pstrCode - pstrDelimiter(typing.Any):Description for pstrDelimiter - dwFlags(typing.Any):Description for dwFlags - -Returns: - - None - - """ - pass - - - def OnCreateDocumentContext(self,) -> 'None': - """ - Description of OnCreateDocumentContext. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPathName(self,) -> 'None': - """ - Description of GetPathName. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetFileName(self,) -> 'None': - """ - Description of GetFileName. - -Args: - - - -Returns: - - None - - """ - pass - - - def NotifyChanged(self,) -> 'None': - """ - Description of NotifyChanged. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugDocumentInfo(object): - """Provides information on a document, which may or may not be instantiated.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetName(self,) -> 'None': - """ - Returns the specified name for the document. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDocumentClassId(self,) -> 'PyIID': - """ - Returns a CLSID describing the document type. - -Args: - - - -Returns: - - PyIID - - """ - pass - - -class PyIDebugDocumentProvider(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDocument(self,) -> 'PyIDebugDocument': - """ - Causes the document to be instantiated if it does - -not already exist. - -Args: - - - -Returns: - - PyIDebugDocument - - """ - pass - - -class PyIDebugDocumentText(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDocumentAttributes(self,) -> 'None': - """ - Description of GetDocumentAttributes. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetSize(self,) -> 'None': - """ - Description of GetSize. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPositionOfLine(self,cLineNumber:'typing.Any') -> 'None': - """ - Description of GetPositionOfLine. - -Args: - - cLineNumber(typing.Any):Description for cLineNumber - -Returns: - - None - - """ - pass - - - def GetLineOfPosition(self,cCharacterPosition:'typing.Any') -> 'None': - """ - Description of GetLineOfPosition. - -Args: - - cCharacterPosition(typing.Any):Description for cCharacterPosition - -Returns: - - None - - """ - pass - - - def GetText(self,cCharacterPosition:'typing.Any',cMaxChars:'typing.Any',bWantAttr:'typing.Any'=1) -> 'None': - """ - Description of GetText. - -Args: - - cCharacterPosition(typing.Any): - cMaxChars(typing.Any):Max chars to return - bWantAttr(typing.Any):Should the attributes be returned? - -Returns: - - None - - """ - pass - - - def GetPositionOfContext(self,psc:'PyIDebugDocumentContext') -> 'None': - """ - Description of GetPositionOfContext. - -Args: - - psc(PyIDebugDocumentContext):Description for psc - -Returns: - - None - - """ - pass - - - def GetContextOfPosition(self,cCharacterPosition:'typing.Any',cNumChars:'typing.Any') -> 'None': - """ - Description of GetContextOfPosition. - -Args: - - cCharacterPosition(typing.Any):Description for cCharacterPosition - cNumChars(typing.Any):Description for cNumChars - -Returns: - - None - - """ - pass - - -class PyIDebugDocumentTextAuthor(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def InsertText(self,cCharacterPosition:'typing.Any',cNumToInsert:'typing.Any',pcharText:'typing.Any') -> 'None': - """ - Description of InsertText. - -Args: - - cCharacterPosition(typing.Any):Description for cCharacterPosition - cNumToInsert(typing.Any):Description for cNumToInsert - pcharText(typing.Any):Description for pcharText - -Returns: - - None - - """ - pass - - - def RemoveText(self,cCharacterPosition:'typing.Any',cNumToRemove:'typing.Any') -> 'None': - """ - Description of RemoveText. - -Args: - - cCharacterPosition(typing.Any):Description for cCharacterPosition - cNumToRemove(typing.Any):Description for cNumToRemove - -Returns: - - None - - """ - pass - - - def ReplaceText(self,cCharacterPosition:'typing.Any',cNumToReplace:'typing.Any',pcharText:'typing.Any') -> 'None': - """ - Description of ReplaceText. - -Args: - - cCharacterPosition(typing.Any):Description for cCharacterPosition - cNumToReplace(typing.Any):Description for cNumToReplace - pcharText(typing.Any):Description for pcharText - -Returns: - - None - - """ - pass - - -class PyIDebugDocumentTextEvents(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def onDestroy(self,) -> 'None': - """ - Description of onDestroy. - -Args: - - - -Returns: - - None - - """ - pass - - - def onInsertText(self,cCharacterPosition:'typing.Any',cNumToInsert:'typing.Any') -> 'None': - """ - Description of onInsertText. - -Args: - - cCharacterPosition(typing.Any):Description for cCharacterPosition - cNumToInsert(typing.Any):Description for cNumToInsert - -Returns: - - None - - """ - pass - - - def onRemoveText(self,cCharacterPosition:'typing.Any',cNumToRemove:'typing.Any') -> 'None': - """ - Description of onRemoveText. - -Args: - - cCharacterPosition(typing.Any):Description for cCharacterPosition - cNumToRemove(typing.Any):Description for cNumToRemove - -Returns: - - None - - """ - pass - - - def onReplaceText(self,cCharacterPosition:'typing.Any',cNumToReplace:'typing.Any') -> 'None': - """ - Description of onReplaceText. - -Args: - - cCharacterPosition(typing.Any):Description for cCharacterPosition - cNumToReplace(typing.Any):Description for cNumToReplace - -Returns: - - None - - """ - pass - - - def onUpdateTextAttributes(self,cCharacterPosition:'typing.Any',cNumToUpdate:'typing.Any') -> 'None': - """ - Description of onUpdateTextAttributes. - -Args: - - cCharacterPosition(typing.Any):Description for cCharacterPosition - cNumToUpdate(typing.Any):Description for cNumToUpdate - -Returns: - - None - - """ - pass - - - def onUpdateDocumentAttributes(self,textdocattr:'typing.Any') -> 'None': - """ - Description of onUpdateDocumentAttributes. - -Args: - - textdocattr(typing.Any):Description for textdocattr - -Returns: - - None - - """ - pass - - -class PyIDebugDocumentTextExternalAuthor(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPathName(self,) -> 'None': - """ - Description of GetPathName. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetFileName(self,) -> 'None': - """ - Description of GetFileName. - -Args: - - - -Returns: - - None - - """ - pass - - - def NotifyChanged(self,) -> 'None': - """ - Description of NotifyChanged. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugExpression(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Start(self,pdecb:'PyIDebugExpressionCallBack') -> 'None': - """ - Description of Start. - -Args: - - pdecb(PyIDebugExpressionCallBack):Description for pdecb - -Returns: - - None - - """ - pass - - - def Abort(self,) -> 'None': - """ - Description of Abort. - -Args: - - - -Returns: - - None - - """ - pass - - - def QueryIsComplete(self,) -> 'None': - """ - Description of QueryIsComplete. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetResultAsString(self,) -> 'None': - """ - Description of GetResultAsString. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetResultAsDebugProperties(self,) -> 'None': - """ - Description of GetResultAsDebugProperty. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugExpressionCallBack(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def onComplete(self,) -> 'None': - """ - Description of onComplete. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugExpressionContext(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ParseLanguageText(self,pstrCode:'typing.Any',nRadix:'typing.Any',pstrDelimiter:'typing.Any',dwFlags:'typing.Any') -> 'None': - """ - Description of ParseLanguageText. - -Args: - - pstrCode(typing.Any):Description for pstrCode - nRadix(typing.Any):Description for nRadix - pstrDelimiter(typing.Any):Description for pstrDelimiter - dwFlags(typing.Any):Description for dwFlags - -Returns: - - None - - """ - pass - - - def GetLanguageInfo(self,) -> 'None': - """ - Description of GetLanguageInfo. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugProperty(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPropertyInfo(self,dwFieldSpec:'typing.Any',nRadix:'typing.Any') -> 'None': - """ - Description of GetPropertyInfo. - -Args: - - dwFieldSpec(typing.Any):Description for dwFieldSpec - nRadix(typing.Any):Description for nRadix - -Returns: - - None - - """ - pass - - - def GetExtendedInfo(self,) -> 'None': - """ - Description of GetExtendedInfo. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetValueAsString(self,pszValue:'typing.Any',nRadix:'typing.Any') -> 'None': - """ - Description of SetValueAsString. - -Args: - - pszValue(typing.Any):Description for pszValue - nRadix(typing.Any):Description for nRadix - -Returns: - - None - - """ - pass - - - def EnumMembers(self,dwFieldSpec:'typing.Any',nRadix:'typing.Any',refiid:'PyIID') -> 'None': - """ - Description of EnumMembers. - -Args: - - dwFieldSpec(typing.Any):Description for dwFieldSpec - nRadix(typing.Any):Description for nRadix - refiid(PyIID):Description for refiid - -Returns: - - None - - """ - pass - - - def GetParent(self,) -> 'None': - """ - Description of GetParent. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugSessionProvider(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def StartDebugSession(self,pda:'PyIRemoteDebugApplication') -> 'None': - """ - Description of StartDebugSession. - -Args: - - pda(PyIRemoteDebugApplication):Description for pda - -Returns: - - None - - """ - pass - - -class PyIDebugStackFrame(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetCodeContext(self,) -> 'None': - """ - Returns the current code context associated with the stack frame. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDescriptionString(self,fLong:'typing.Any') -> 'typing.Any': - """ - Returns a short or long textual description of the - -stack frame. - -Args: - - fLong(typing.Any):If false, provide only the name of the function associated with the stack frame. When true it may also provide the parameter(s) to the function or whatever else is relevant. - -Returns: - - typing.Any - - """ - pass - - - def GetLanguageString(self,fLong:'typing.Any') -> 'typing.Any': - """ - Returns a short or long textual description of the - -language. - -Args: - - fLong(typing.Any):If False, just the language name should be provided, eg, "Python". If True a full product description may be provided (eg, "Python 1.4 ActiveX Debugging Host") - -Returns: - - typing.Any - - """ - pass - - - def GetThread(self,) -> 'PyIDebugApplicationThread': - """ - Returns the thread associated with this stack - -frame. - -Args: - - - -Returns: - - PyIDebugApplicationThread - - """ - pass - - -class PyIDebugStackFrameSniffer(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def EnumStackFrames(self,) -> 'None': - """ - Description of EnumStackFrames. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugStackFrameSnifferEx(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def EnumStackFramesEx(self,) -> 'None': - """ - Description of EnumStackFrames. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugSyncOperation(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetTargetThread(self,) -> 'None': - """ - Description of GetTargetThread. - -Args: - - - -Returns: - - None - - """ - pass - - - def Execute(self,) -> 'None': - """ - Description of Execute. - -Args: - - - -Returns: - - None - - """ - pass - - - def InProgressAbort(self,) -> 'None': - """ - Description of InProgressAbort. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDefaultExtractIconInit(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetFlags(self,uFlags:'typing.Any') -> 'None': - """ - Description of SetFlags. - -Args: - - uFlags(typing.Any):Description for uFlags - -Returns: - - None - - """ - pass - - - def SetKey(self,hkey:'PyHKEY') -> 'None': - """ - Description of SetKey. - -Args: - - hkey(PyHKEY):Description for hkey - -Returns: - - None - - """ - pass - - - def SetNormalIcon(self,pszFile:'typing.Any',iIcon:'typing.Any') -> 'None': - """ - Description of SetNormalIcon. - -Args: - - pszFile(typing.Any):Description for pszFile - iIcon(typing.Any):Description for iIcon - -Returns: - - None - - """ - pass - - - def SetOpenIcon(self,pszFile:'typing.Any',iIcon:'typing.Any') -> 'None': - """ - Description of SetOpenIcon. - -Args: - - pszFile(typing.Any):Description for pszFile - iIcon(typing.Any):Description for iIcon - -Returns: - - None - - """ - pass - - - def SetShortcutIcon(self,pszFile:'typing.Any',iIcon:'typing.Any') -> 'None': - """ - Description of SetShortcutIcon. - -Args: - - pszFile(typing.Any):Description for pszFile - iIcon(typing.Any):Description for iIcon - -Returns: - - None - - """ - pass - - - def SetDefaultIcon(self,pszFile:'typing.Any',iIcon:'typing.Any') -> 'None': - """ - Description of SetDefaultIcon. - -Args: - - pszFile(typing.Any):Description for pszFile - iIcon(typing.Any):Description for iIcon - -Returns: - - None - - """ - pass - - -class PyIDirectSound(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,guid:'PyIID') -> 'None': - """ - Description of Initialize. - -Args: - - guid(PyIID):Globally unique identifier (GUID) specifying the sound driver to which this DirectSound object binds. Pass None to select the primary sound driver. - -Returns: - - None - - """ - pass - - - def SetCooperativeLevel(self,hwnd:'typing.Any',level:'typing.Any') -> 'None': - """ - The IDirectSound::SetCooperativeLevel method sets the cooperative level - -of the application for this sound device. - -Args: - - hwnd(typing.Any):Window handle to the application or None. - level(typing.Any):Requested priority level. Specify one of the following values:LevelDescriptionDSSCL_NORMALSets the application to a fully cooperative status. Most applications should use this level, because it has the smoothest multitasking and resource-sharing behavior.DSSCL_PRIORITYSets the application to the priority level. Applications with this cooperative level can call the DirectSoundBuffer.setFormat and DirectSound.compact methods.DSSCL_EXCLUSIVESets the application to the exclusive level. When it has the input focus, the application will be the only one audible (sounds from applications with the DSBCAPS_GLOBALFOCUS flag set will be muted). With this level, it also has all the privileges of the DSSCL_PRIORITY level. DirectSound will restore the hardware format, as specified by the most recent call to the DirectSoundBuffer.setFormat method, once the application gains the input focus. (Note that DirectSound will always restore the wave format, no matter what priority level is set.)DSSCL_WRITEPRIMARYThis is the highest priority level. The application has write access to the primary sound buffers. No secondary sound buffers in any application can be played. - -Returns: - - None - - """ - pass - - - def CreateSoundBuffer(self,lpDSCBufferDesc:'PyDSCBUFFERDESC',unk:'typing.Any'=None) -> 'None': - """ - The IDirectSound::CreateSoundBuffer method creates a DirectSoundBuffer - -object to hold a sequence of audio samples. - -Args: - - lpDSCBufferDesc(PyDSCBUFFERDESC):a DSBUFFERDESC structure containing values for the sound buffer being created. - unk(typing.Any):The IUnknown for COM aggregation. - -Returns: - - None - - """ - pass - - - def GetCaps(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def Compact(self,) -> 'None': - """ - 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. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDirectSoundBuffer(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,) -> 'None': - """ - Description of Initialize. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetStatus(self,) -> 'None': - """ - Retrieves the current status of the sound buffer. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCaps(self,) -> 'None': - """ - Retrieves the capabilities of the DirectSoundBuffer object as a DSBCAPS - -object. - -Args: - - - -Returns: - - None - - """ - pass - - - def Restore(self,) -> 'None': - """ - Restores the memory allocation for a lost sound buffer for the specified - -DirectSoundBuffer object. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCurrentPosition(self,) -> 'None': - """ - Description of GetCurrentPosition. - -Args: - - - -Returns: - - None - - """ - pass - - - def Play(self,) -> 'None': - """ - Description of Play. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetCurrentPosition(self,) -> 'None': - """ - Description of SetCurrentPosition. - -Args: - - - -Returns: - - None - - """ - pass - - - def Stop(self,) -> 'None': - """ - Description of Stop. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetFrequency(self,) -> 'None': - """ - Description of GetFrequency. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPan(self,) -> 'None': - """ - Description of GetPan. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetVolume(self,) -> 'None': - """ - Description of GetVolume. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetFrequency(self,) -> 'None': - """ - Description of SetFrequency. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetPan(self,) -> 'None': - """ - Description of SetPan. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetVolume(self,) -> 'None': - """ - Description of SetVolume. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDirectSoundCapture(object): - """The methods of the IDirectSoundCapture interface are used to create sound capture - -buffers.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,) -> 'None': - """ - Not normally called directly. Use DirectSoundCaptureCreate instead. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCaps(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDirectSoundCaptureBuffer(object): - """The methods of the IDirectSoundCaptureBuffer interface are used to manipulate - -sound capture buffers.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,) -> 'None': - """ - Not normally used. Used IDirectSoundCapture.CreateCaptureBuffer - -instead. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetStatus(self,) -> 'None': - """ - Retrieves the current status of the sound capture buffer. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCurrentPosition(self,) -> 'None': - """ - 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 - -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. - -Args: - - - -Returns: - - None - - """ - pass - - - def Stop(self,) -> 'None': - """ - 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 - -effect. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDirectSoundNotify(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIDirectoryObject(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetObjectInformation(self,) -> 'PyADS_OBJECT_INFO': - """ - None - -Args: - - - -Returns: - - PyADS_OBJECT_INFO - - """ - pass - - - def GetObjectAttributes(self,names:'typing.Tuple[str, ...]') -> 'typing.Tuple[PyADS_ATTR_INFO, ...]': - """ - None - -Args: - - names(typing.Tuple[str, ...]): - -Returns: - - typing.Tuple[PyADS_ATTR_INFO, ...] - - """ - pass - - - def SetObjectAttributes(self,attrs:'typing.Tuple[PyADS_ATTR_INFO, ...]') -> 'typing.Any': - """ - None - -Args: - - attrs(typing.Tuple[PyADS_ATTR_INFO, ...]):The attributes to set - -Returns: - - typing.Any - - """ - pass - - - def CreateDSObject(self,rdn:'str',attrs:'typing.Tuple[PyADS_ATTR_INFO, ...]') -> 'PyIDispatch': - """ - None - -Args: - - rdn(str):The relative distinguished name (relative path) of the object to be created. - attrs(typing.Tuple[PyADS_ATTR_INFO, ...]):The attributes to set. - -Returns: - - PyIDispatch - - """ - pass - - - def DeleteDSObject(self,rdn:'str') -> 'None': - """ - Deletes a leaf object in a directory tree - -Args: - - rdn(str):The relative distinguished name (relative path) of the object to be deleted. - -Returns: - - None - - """ - pass - - -class PyIDirectorySearch(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetSearchPreference(self,prefs:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': - """ - None - -Args: - - prefs(typing.Any):Return ValueThe result is the hresult of the call, and a list of integer status codes for each of the preferences set. - -Returns: - - 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 - - - def ExecuteSearch(self,_filter:'str',attrNames:'typing.List[str]') -> 'typing.Any': - """ - None - -Args: - - _filter(str): - attrNames(typing.List[str]):Return ValueThe result is an integer search handle. PyIDirectorySearch::CloseSearchHandle should be called to close the handle. - -Returns: - - typing.Any:Return ValueThe result is an integer search handle. PyIDirectorySearch::CloseSearchHandle - -should be called to close the handle. - - - """ - pass - - - def GetNextRow(self,handle:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - handle(typing.Any):Return ValueThe result is the HRESULT from the call - no exceptions are thrown - -Returns: - - typing.Any:Return ValueThe result is the HRESULT from the call - no exceptions are thrown - - - """ - pass - - - def GetFirstRow(self,handle:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - handle(typing.Any):Return ValueThe result is the HRESULT from the call - no exceptions are thrown - -Returns: - - typing.Any:Return ValueThe result is the HRESULT from the call - no exceptions are thrown - - - """ - pass - - - def GetPreviousRow(self,handle:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - handle(typing.Any):Return ValueThe result is the HRESULT from the call - no exceptions are thrown - -Returns: - - typing.Any:Return ValueThe result is the HRESULT from the call - no exceptions are thrown - - - """ - pass - - - def CloseSearchHandle(self,handle:'typing.Any') -> 'None': - """ - Closes a previously opened search handle. - -Args: - - handle(typing.Any): - -Returns: - - None - - """ - pass - - - def AdandonSearch(self,handle:'typing.Any') -> 'None': - """ - None - -Args: - - handle(typing.Any): - -Returns: - - None - - """ - pass - - - def GetColumn(self,handle:'typing.Any',name:'str') -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': - """ - None - -Args: - - handle(typing.Any):Handle to a search - name(str):The column name to fetch - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any] - - """ - pass - - - def GetNextColumnName(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None:PyIDirectorySearch.GetNextColumnName -GetNextColumnName() -Return ValueReturns None when the underlying ADSI function return S_ADS_NOMORE_COLUMNS. - - - """ - pass - - -class PyIDispatch(object): - """A OLE automation client object.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Invoke(self,dispid:'typing.Any',lcid:'typing.Any',flags:'typing.Any',bResultWanted:'typing.Any',arg:'typing.Tuple[typing.Any, ...]') -> 'typing.Any': - """ - Invokes a DISPID, using the passed arguments. - -Args: - - dispid(typing.Any):The dispid to use. Typically this value will come from PyIDispatch::GetIDsOfNames or from a type library. - lcid(typing.Any):The locale id to use. - flags(typing.Any):The flags for the call. The following flags can be used.FlagDescriptionDISPATCH_METHODThe member is invoked as a method. If a property has the same name, both this and the DISPATCH_PROPERTYGET flag may be set.DISPATCH_PROPERTYGETThe member is retrieved as a property or data member.DISPATCH_PROPERTYPUTThe member is changed as a property or data member.DISPATCH_PROPERTYPUTREFThe member is changed by a reference assignment, rather than a value assignment. This flag is valid only when the property accepts a reference to an object. - bResultWanted(typing.Any):Indicates if the result of the call should be requested. - arg(typing.Tuple[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) - -Returns: - - 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 - - - def InvokeTypes(self,dispid:'typing.Any',lcid:'typing.Any',wFlags:'typing.Any',resultTypeDesc:'typing.Any',typeDescs:'typing.Tuple[typing.Any, ...]',args:'typing.Tuple[typing.Any, ...]') -> 'typing.Any': - """ - Invokes a DISPID, using the passed arguments and type descriptions. - -Args: - - dispid(typing.Any):The dispid to use. Please see PyIDispatch::Invoke. - lcid(typing.Any):The locale ID. Please see PyIDispatch::Invoke. - wFlags(typing.Any):Flags for the call. Please see PyIDispatch::Invoke. - resultTypeDesc(typing.Any):A tuple describing the type of the result. See the comments for more information. - typeDescs(typing.Tuple[typing.Any, ...]):A sequence of tuples describing the types of the parameters for the function. See the comments for more information. - args(typing.Tuple[typing.Any, ...]):The args to the function.CommentsThe Microsoft documentation for IDispatch should be used for all params except 'resultTypeDesc' and 'typeDescs'. 'resultTypeDesc' describes the return value of the function, and is a tuple of (type_id, flags). 'typeDescs' describes the type of each parameters, and is a list of the same (type_id, flags) tuple.itemDescriptiontype_idA valid "variant type" constant (eg, VT_I4 | VT_ARRAY, VT_DATE, etc - see VARIANT at MSDN).flagsOne of the PARAMFLAG constants (eg, PARAMFLAG_FIN, PARAMFLAG_FOUT etc - see PARAMFLAG at MSDN).ExampleAn example from the makepy generated file for Wordclass Cells(DispatchBaseClass):... def SetWidth(self, ColumnWidth=..., RulerStyle=...): return self._oleobj_.InvokeTypes(202, LCID, 1, (24, 0), ((4, 1), (3, 1)),...)The interesting bits areresultTypeDesc: (24, 0) - (VT_VOID, <no flags>)typeDescs: ((4, 1), (3, 1)) - ((VT_R4, PARAMFLAG_FIN), (VT_I4, PARAMFLAG_FIN))So, in this example, the function returns no value and takes 2 "in" params - ColumnWidth is a float, and RulerStule is an int. - -Returns: - - typing.Any - - """ - pass - - - def GetIDsOfNames(self,name:'str',arg:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Union[typing.Any]]': - """ - Get the DISPID for the passed names. - -Args: - - name(str):A name to query forAlternative Parameters - arg(typing.Any):A sequence of string names to queryCommentsCurrently 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 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. - -Returns: - - typing.Tuple[typing.Any, typing.Union[typing.Any]]:A sequence of string names to query -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 - -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 - - - def GetTypeInfo(self,locale:'typing.Any',index:'typing.Any'=0) -> 'PyITypeInfo': - """ - Get type information for the object. - -Args: - - locale(typing.Any):The locale to use. - index(typing.Any):The index of the typelibrary to fetch. Note that these params are reversed from the win32 call. - -Returns: - - PyITypeInfo - - """ - pass - - - def GetTypeInfoCount(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyIDispatchEx(object): - """A OLE automation client object that uses the IDispatchEx scripting interface..""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDispID(self,name:'str',fdex:'typing.Any') -> 'typing.Any': - """ - Returns the member id for a name - -Args: - - name(str):Passed in name to be mapped - fdex(typing.Any):Determines the options for obtaining the member identifier. This can be a combination of the fdex* constants: - -Returns: - - typing.Any - - """ - pass - - - def InvokeEx(self,dispid:'typing.Any',lcid:'typing.Any',flags:'typing.Any',args:'typing.List[typing.Any]',types:'typing.List[typing.Any]'=None,returnDesc:'typing.Any'=1,serviceProvider:'PyIServiceProvider'=None) -> 'typing.Any': - """ - None - -Args: - - dispid(typing.Any): - lcid(typing.Any): - flags(typing.Any): - args(typing.List[typing.Any]):The arguments. - types(typing.List[typing.Any]):A tuple of type description object, or None if type descriptions are not available. - returnDesc(typing.Any):If types==None, should be a BOOL indicating if the result is needed. If types is a tuple, then should a be type description. - serviceProvider(PyIServiceProvider):A service provider object supplied by the caller which allows the object to obtain services from the caller. Can be None. - -Returns: - - typing.Any - - """ - pass - - - def DeleteMemberByName(self,name:'str',fdex:'typing.Any') -> 'None': - """ - None - -Args: - - name(str):Passed in name to be mapped - fdex(typing.Any):Determines the options - -Returns: - - None - - """ - pass - - - def DeleteMemberByDispID(self,dispid:'typing.Any') -> 'None': - """ - None - -Args: - - dispid(typing.Any): - -Returns: - - None - - """ - pass - - - def GetMemberProperties(self,dispid:'typing.Any',fdex:'typing.Any') -> 'typing.Any': - """ - Returns mask of fdex* flags describing a member - -Args: - - dispid(typing.Any):The member id - fdex(typing.Any):fdex* flags specifying which properties to return - -Returns: - - typing.Any - - """ - pass - - - def GetMemberName(self,dispid:'typing.Any') -> 'typing.Any': - """ - Returns the name associated with a member id - -Args: - - dispid(typing.Any):The member id - -Returns: - - typing.Any - - """ - pass - - - def GetNextDispID(self,fdex:'typing.Any',dispid:'typing.Any') -> 'typing.Any': - """ - Enumerates member ids. - -Args: - - fdex(typing.Any):Determines the options - dispid(typing.Any):Current member, or DISPID_STARTENUM to begin enumeration. GetNextDispID will retrieve the item in the enumeration after this one. - -Returns: - - typing.Any - - """ - pass - - -class PyIDisplayItem(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIDocHostUIHandler(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ShowContextMenu(self,dwID:'typing.Any',pt:'typing.Tuple[typing.Any, typing.Any]',pcmdtReserved:'PyIUnknown',pdispReserved:'PyIDispatch') -> 'None': - """ - Description of ShowContextMenu. - -Args: - - dwID(typing.Any):Description for dwID - pt(typing.Tuple[typing.Any, typing.Any]):Description for ppt - pcmdtReserved(PyIUnknown):Description for pcmdtReserved - pdispReserved(PyIDispatch):Description for pdispReserved - -Returns: - - None - - """ - pass - - - def GetHostInfo(self,) -> 'None': - """ - Description of GetHostInfo. - -Args: - - - -Returns: - - None - - """ - pass - - - def ShowUI(self,dwID:'typing.Any',pActiveObject:'PyIOleInPlaceActiveObject',pCommandTarget:'PyIOleCommandTarget',pFrame:'PyIOleInPlaceFrame',pDoc:'PyIOleInPlaceUIWindow') -> 'None': - """ - Description of ShowUI. - -Args: - - dwID(typing.Any):Description for dwID - pActiveObject(PyIOleInPlaceActiveObject):Description for pActiveObject - pCommandTarget(PyIOleCommandTarget):Description for pCommandTarget - pFrame(PyIOleInPlaceFrame):Description for pFrame - pDoc(PyIOleInPlaceUIWindow):Description for pDoc - -Returns: - - None - - """ - pass - - - def HideUI(self,) -> 'None': - """ - Description of HideUI. - -Args: - - - -Returns: - - None - - """ - pass - - - def UpdateUI(self,) -> 'None': - """ - Description of UpdateUI. - -Args: - - - -Returns: - - None - - """ - pass - - - def EnableModeless(self,fEnable:'typing.Any') -> 'None': - """ - Description of EnableModeless. - -Args: - - fEnable(typing.Any):Description for fEnable - -Returns: - - None - - """ - pass - - - def OnDocWindowActivate(self,fActivate:'typing.Any') -> 'None': - """ - Description of OnDocWindowActivate. - -Args: - - fActivate(typing.Any):Description for fActivate - -Returns: - - None - - """ - pass - - - def OnFrameWindowActivate(self,fActivate:'typing.Any') -> 'None': - """ - Description of OnFrameWindowActivate. - -Args: - - fActivate(typing.Any):Description for fActivate - -Returns: - - None - - """ - pass - - - def ResizeBorder(self,prcBorder:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',pUIWindow:'PyIOleInPlaceUIWindow',fRameWindow:'typing.Any') -> 'None': - """ - Description of ResizeBorder. - -Args: - - prcBorder(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Description for prcBorder - pUIWindow(PyIOleInPlaceUIWindow):Description for pUIWindow - fRameWindow(typing.Any):Description for fRameWindow - -Returns: - - None - - """ - pass - - - def TranslateAccelerator(self,lpMsg:'typing.Any',pguidCmdGroup:'PyIID',nCmdID:'typing.Any') -> 'None': - """ - Description of TranslateAccelerator. - -Args: - - lpMsg(typing.Any):Description for lpMsg - pguidCmdGroup(PyIID):Description for pguidCmdGroup - nCmdID(typing.Any):Description for nCmdID - -Returns: - - None - - """ - pass - - - def GetOptionKeyPath(self,dw:'typing.Any') -> 'None': - """ - Description of GetOptionKeyPath. - -Args: - - dw(typing.Any):Description for dw - -Returns: - - None - - """ - pass - - - def GetDropTarget(self,pDropTarget:'PyIDropTarget') -> 'None': - """ - Description of GetDropTarget. - -Args: - - pDropTarget(PyIDropTarget):Description for pDropTarget - -Returns: - - None - - """ - pass - - - def GetExternal(self,) -> 'None': - """ - Description of GetExternal. - -Args: - - - -Returns: - - None - - """ - pass - - - def TranslateUrl(self,dwTranslate:'typing.Any',pchURLIn:'typing.Any') -> 'None': - """ - Description of TranslateUrl. - -Args: - - dwTranslate(typing.Any):Description for dwTranslate - pchURLIn(typing.Any):Description for pchURLIn - -Returns: - - None - - """ - pass - - - def FilterDataObject(self,pDO:'PyIDataObject') -> 'None': - """ - Description of FilterDataObject. - -Args: - - pDO(PyIDataObject):Description for pDO - -Returns: - - None - - """ - pass - - -class PyIDropSource(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def QueryContinueDrag(self,fEscapePressed:'typing.Any',grfKeyState:'typing.Any') -> 'None': - """ - Description of QueryContinueDrag. - -Args: - - fEscapePressed(typing.Any):Description for fEscapePressed - grfKeyState(typing.Any):Description for grfKeyState - -Returns: - - None - - """ - pass - - - def GiveFeedback(self,dwEffect:'typing.Any') -> 'None': - """ - Description of GiveFeedback. - -Args: - - dwEffect(typing.Any):Description for dwEffect - -Returns: - - None - - """ - pass - - -class PyIDropTarget(object): - """Interface that acts as a target of OLE drag and drop operations""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def DragEnter(self,pDataObj:'PyIDataObject',grfKeyState:'typing.Any',pt:'typing.Tuple[typing.Any, typing.Any]',pdwEffect:'typing.Any') -> 'typing.Any': - """ - Called when an object is initially dragged into a window - -Args: - - pDataObj(PyIDataObject):IDataObject interface that contains the object being dragged - grfKeyState(typing.Any):Combination of win32con.MK_* flags containing keyboard modifier state - pt(typing.Tuple[typing.Any, typing.Any]):(x,y) Screen coordinates of cursor - pdwEffect(typing.Any):shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return a shellcon.DROPEFFECT_* value indicating if the object can be accepted - -Returns: - - typing.Any:shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return a shellcon.DROPEFFECT_* value indicating if the object can - -be accepted - - - """ - pass - - - def DragOver(self,grfKeyState:'typing.Any',pt:'typing.Tuple[typing.Any, typing.Any]',pdwEffect:'typing.Any') -> 'typing.Any': - """ - Called as the dragged object moves over the window - -Args: - - grfKeyState(typing.Any):Combination of win32con.MK_* flags containing keyboard modifier state - pt(typing.Tuple[typing.Any, typing.Any]):(x,y) Screen coordinates of cursor - pdwEffect(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 - -Returns: - - 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 - - - def DragLeave(self,) -> 'None': - """ - Called as the object is dragged back out of the window - -Args: - - - -Returns: - - None - - """ - pass - - - def Drop(self,pDataObj:'PyIDataObject',grfKeyState:'typing.Any',pt:'typing.Tuple[typing.Any, typing.Any]',dwEffect:'typing.Any') -> 'typing.Any': - """ - Called when the object is dropped onto the window - -Args: - - pDataObj(PyIDataObject):IDataObject interface containing the dropped object - grfKeyState(typing.Any):Combination of win32con.MK_* flags containing keyboard modifier state - pt(typing.Tuple[typing.Any, typing.Any]):(x,y) Screen coordinates of cursor - dwEffect(typing.Any):shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return one of the shellcon.DROPEFFECT_* values - -Returns: - - typing.Any:shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return one of the shellcon.DROPEFFECT_* values - - - """ - pass - - -class PyIDropTargetHelper(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def DragEnter(self,hwnd:'int',pDataObj:'PyIDataObject',pt:'typing.Tuple[typing.Any, typing.Any]',dwEffect:'typing.Any') -> 'None': - """ - Description of DragEnter. - -Args: - - hwnd(int):Handle to target window - pDataObj(PyIDataObject):Object that is dragged onto the window - pt(typing.Tuple[typing.Any, typing.Any]):Coordinates where drag operation entered the window - dwEffect(typing.Any):One of shellcon.DROPEFFECT_* values - -Returns: - - None - - """ - pass - - - def DragOver(self,hwnd:'typing.Any',pt:'typing.Tuple[typing.Any, typing.Any]',pdwEffect:'typing.Any') -> 'None': - """ - Description of DragOver. - -Args: - - hwnd(typing.Any): - pt(typing.Tuple[typing.Any, typing.Any]):Description for pt - pdwEffect(typing.Any):Description for pdwEffect - -Returns: - - None - - """ - pass - - - def DragLeave(self,) -> 'None': - """ - Description of DragLeave. - -Args: - - - -Returns: - - None - - """ - pass - - - def Drop(self,pDataObj:'PyIDataObject',pt:'typing.Tuple[typing.Any, typing.Any]',dwEffect:'typing.Any') -> 'None': - """ - Description of Drop. - -Args: - - pDataObj(PyIDataObject):Description for pDataObj - pt(typing.Tuple[typing.Any, typing.Any]):Description for pt - dwEffect(typing.Any):Description for dwEffect - -Returns: - - None - - """ - pass - - -class PyIDsObjectPicker(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,targetComputer:'str',scopeInfos:'PyDSOP_SCOPE_INIT_INFOs',options:'typing.Any'=0,attrNames:'typing.List[str]'=None) -> 'None': - """ - Initializes the IDsObjectPicker interface with information about the scopes, filters, and options used by the object picker dialog box. - -Args: - - targetComputer(str): - scopeInfos(PyDSOP_SCOPE_INIT_INFOs): - options(typing.Any): - attrNames(typing.List[str]): - -Returns: - - None - - """ - pass - - - def InvokeDialog(self,hwnd:'typing.Any') -> 'PyIDataObject': - """ - Displays a modal object picker dialog box and returns the user's selections. - -Args: - - hwnd(typing.Any): - -Returns: - - PyIDataObject - - """ - pass - - -class PyIEmptyVolumeCache(object): - """Used for cleaning up temporary file ("disk cleanup")""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIEmptyVolumeCache2(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIEmptyVolumeCacheCallBack(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ScanProgress(self,dwlSpaceUsed:'typing.Any',dwFlags:'typing.Any',pcwszStatus:'typing.Any') -> 'None': - """ - Description of ScanProgress. - -Args: - - dwlSpaceUsed(typing.Any):Description for dwlSpaceUsed - dwFlags(typing.Any):Description for dwFlags - pcwszStatus(typing.Any):Description for pcwszStatus - -Returns: - - None - - """ - pass - - - def PurgeProgress(self,dwlSpaceFreed:'typing.Any',spaceFreed:'typing.Any',spaceToFree:'typing.Any',flags:'typing.Any',status:'typing.Any') -> 'None': - """ - Description of PurgeProgress. - -Args: - - dwlSpaceFreed(typing.Any):Description for dwlSpaceFreed - spaceFreed(typing.Any): - spaceToFree(typing.Any): - flags(typing.Any): - status(typing.Any): - -Returns: - - None - - """ - pass - - -class PyIEnumCATEGORYINFO(object): - """A Python interface to IEnumCATEGORYINFO""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Tuple[typing.Tuple[PyIID, typing.Any, str], ...]': - """ - Retrieves a specified number of items in the - -enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve.Return ValueThe result is a tuple of (IID object, LCID, string description) tuples, one for each element returned. - -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, - -one for each element returned. - - - """ - pass - - - def Skip(self,num:'typing.Any') -> 'None': - """ - Skips over the next specified elementes. - -Args: - - num(typing.Any):The number of elements being requested. - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumCATEGORYINFO': - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumCATEGORYINFO - - """ - pass - - -class PyIEnumConnectionPoints(object): - """A Python interface to IEnumConnectionPoints""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Tuple[PyIConnectionPoint, ...]': - """ - Retrieves a specified number of items in the - -enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Tuple[PyIConnectionPoint, ...] - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumConnectionPoints': - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumConnectionPoints - - """ - pass - - -class PyIEnumConnections(object): - """A Python interface to IEnumConnections""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumConnections': - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumConnections - - """ - pass - - -class PyIEnumContextProps(object): - """A Python interface to IEnumContextProps""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Tuple[typing.Tuple[PyIID, typing.Any, PyIUnknown], ...]': - """ - Retrieves a specified number of items in - -the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve.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 property value - -Returns: - - typing.Tuple[typing.Tuple[PyIID, typing.Any, PyIUnknown], ...]:Number of items to retrieve. -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 - -property value - - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumContextProps': - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumContextProps - - """ - pass - - -class PyIEnumDebugApplicationNodes(object): - """A Python interface to IEnumDebugApplicationNodes""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumDebugApplicationNodes': - """ - Creates another enumerator that - -contains the same enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumDebugApplicationNodes - - """ - pass - - -class PyIEnumDebugCodeContexts(object): - """A Python interface to IEnumDebugCodeContexts""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumDebugCodeContexts': - """ - Creates another enumerator that contains the - -same enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumDebugCodeContexts - - """ - pass - - -class PyIEnumDebugExpressionContexts(object): - """A Python interface to IEnumDebugExpressionContexts""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration - -sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumDebugExpressionContexts': - """ - Creates another enumerator that - -contains the same enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumDebugExpressionContexts - - """ - pass - - -class PyIEnumDebugPropertyInfo(object): - """A Python interface to IEnumDebugPropertyInfo""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumDebugPropertyInfo': - """ - Creates another enumerator that contains the - -same enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumDebugPropertyInfo - - """ - pass - - - def GetCount(self,) -> 'typing.Any': - """ - Obtains the number of items - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyIEnumDebugStackFrames(object): - """A Python interface to IEnumDebugStackFrames""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumDebugStackFrames': - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumDebugStackFrames - - """ - pass - - -class PyIEnumExplorerCommand(object): - """A Python interface to IEnumExplorerCommand""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumExplorerCommand': - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumExplorerCommand - - """ - pass - - -class PyIEnumFORMATETC(object): - """A Python interface to IEnumFORMATETC""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumFORMATETC': - """ - Creates another enumerator that contains the same enumeration - -state as the current one - -Args: - - - -Returns: - - PyIEnumFORMATETC - - """ - pass - - -class PyIEnumGUID(object): - """A Python interface to IEnumGUID""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Tuple[PyIID, ...]': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve.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 an error condition - an empty tuple is simply returned. - -Returns: - - typing.Tuple[PyIID, ...]:Number of items to retrieve. -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 - -an error condition - an empty tuple is simply returned. - - - """ - pass - - - def Skip(self,num:'typing.Any') -> 'None': - """ - Skips over the next specified elementes. - -Args: - - num(typing.Any):The number of elements being requested. - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumGUID': - """ - Creates another enumerator that contains the same enumeration state as - -the current one - -Args: - - - -Returns: - - PyIEnumGUID - - """ - pass - - -class PyIEnumIDList(object): - """A Python interface to IEnumIDList""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumIDList': - """ - Creates another enumerator that contains the same enumeration state - -as the current one - -Args: - - - -Returns: - - PyIEnumIDList - - """ - pass - - -class PyIEnumMoniker(object): - """A Python interface to IEnumMoniker""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'PyIMoniker': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve.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 an error condition - an empty tuple is simply returned. - -Returns: - - PyIMoniker:Number of items to retrieve. -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 - -an error condition - an empty tuple is simply returned. - - - """ - pass - - - def Skip(self,num:'typing.Any') -> 'None': - """ - Skips over the next specified elementes. - -Args: - - num(typing.Any):The number of elements being requested. - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumMoniker': - """ - Creates another enumerator that contains the same enumeration state - -as the current one - -Args: - - - -Returns: - - PyIEnumMoniker - - """ - pass - - -class PyIEnumObjects(object): - """Iterates through a number of arbitrary interfaces""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,riid:'PyIID',num:'typing.Any'=1) -> 'typing.Tuple[PyIUnknown, ...]': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - riid(PyIID):The interfaces to return - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Tuple[PyIUnknown, ...] - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumObjects': - """ - Creates another enumerator that contains the same enumeration state - -as the current one - -Args: - - - -Returns: - - PyIEnumObjects - - """ - pass - - -class PyIEnumRemoteDebugApplicationThreads(object): - """A Python interface to IEnumRemoteDebugApplicationThreads""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration - -sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumRemoteDebugApplicationThreads': - """ - Creates another - -enumerator that contains the same enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumRemoteDebugApplicationThreads - - """ - pass - - -class PyIEnumRemoteDebugApplications(object): - """A Python interface to IEnumRemoteDebugApplications""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration - -sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumRemoteDebugApplications': - """ - Creates another enumerator that - -contains the same enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumRemoteDebugApplications - - """ - pass - - -class PyIEnumResources(object): - """A Python interface to IEnumResources""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumResources': - """ - Creates another enumerator that contains the same enumeration - -state as the current one - -Args: - - - -Returns: - - PyIEnumResources - - """ - pass - - -class PyIEnumSTATPROPSETSTG(object): - """A Python interface to IEnumSTATPROPSETSTG""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumSTATPROPSETSTG': - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumSTATPROPSETSTG - - """ - pass - - -class PyIEnumSTATPROPSTG(object): - """A Python interface to IEnumSTATPROPSTG""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumSTATPROPSTG': - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumSTATPROPSTG - - """ - pass - - -class PyIEnumSTATSTG(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Tuple[STATSTG, ...]': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Tuple[STATSTG, ...] - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumSTATSTG': - """ - Creates another enumerator that contains the same enumeration state - -as the current one - -Args: - - - -Returns: - - PyIEnumSTATSTG - - """ - pass - - -class PyIEnumShellItems(object): - """A Python interface to IEnumShellItems""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Tuple[PyIShellItem, ...]': - """ - Retrieves a specified number of items in the enumeration - -sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Tuple[PyIShellItem, ...] - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumShellItems': - """ - Creates another enumerator that contains the same enumeration - -state as the current one - -Args: - - - -Returns: - - PyIEnumShellItems - - """ - pass - - -class PyIEnumString(object): - """An enumerator interface to list strings""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Tuple[str, ...]': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Tuple[str, ...] - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumString': - """ - Creates another enumerator that contains the same enumeration state - -as the current one - -Args: - - - -Returns: - - PyIEnumString - - """ - pass - - -class PyIErrorLog(object): - """A Python wrapper for a COM IErrorLog interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddError(self,propName:'str',excepInfo:'typing.Any'=None) -> 'None': - """ - Adds an error to the error log. - -Args: - - propName(str):The name of the error - excepInfo(typing.Any):A COM exception. Must be a complete COM exception (ie, pythoncom.com_error, or win32com.server.exceptions.COMException()) - -Returns: - - None - - """ - pass - - -class PyIExplorerBrowser(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,hwndParent:'typing.Any',prc:'PyRECT',pfs:'typing.Any') -> 'None': - """ - Description of Initialize. - -Args: - - hwndParent(typing.Any):Description for hwndParent - prc(PyRECT):Description for prc - pfs(typing.Any):Description for pfs - -Returns: - - None - - """ - pass - - - def Destroy(self,) -> 'None': - """ - Description of Destroy. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetRect(self,hdwp:'typing.Any',rcBrowser:'PyRECT') -> 'int': - """ - Description of SetRect. - -Args: - - hdwp(typing.Any):Description for phdwp - rcBrowser(PyRECT):Description for rcBrowser - -Returns: - - int - - """ - pass - - - def SetPropertyBag(self,PropertyBag:'typing.Any') -> 'None': - """ - Description of SetPropertyBag. - -Args: - - PropertyBag(typing.Any):Description for pszPropertyBag - -Returns: - - None - - """ - pass - - - def SetEmptyText(self,EmptyText:'typing.Any') -> 'None': - """ - Description of SetEmptyText. - -Args: - - EmptyText(typing.Any):Description for pszEmptyText - -Returns: - - None - - """ - pass - - - def SetFolderSettings(self,pfs:'typing.Any') -> 'None': - """ - Description of SetFolderSettings. - -Args: - - pfs(typing.Any):Description for pfs - -Returns: - - None - - """ - pass - - - def Advise(self,psbe:'PyIExplorerBrowserEvents') -> 'typing.Any': - """ - Description of Advise. - -Args: - - psbe(PyIExplorerBrowserEvents):Description for psbe - -Returns: - - typing.Any - - """ - pass - - - def Unadvise(self,dwCookie:'typing.Any') -> 'None': - """ - Description of Unadvise. - -Args: - - dwCookie(typing.Any):Description for dwCookie - -Returns: - - None - - """ - pass - - - def SetOptions(self,dwFlag:'typing.Any') -> 'None': - """ - Description of SetOptions. - -Args: - - dwFlag(typing.Any):Description for dwFlag - -Returns: - - None - - """ - pass - - - def GetOptions(self,) -> 'typing.Any': - """ - Description of GetOptions. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def BrowseToIDList(self,pidl:'typing.Any',uFlags:'typing.Any') -> 'None': - """ - Description of BrowseToIDList. - -Args: - - pidl(typing.Any):Description for pidl - uFlags(typing.Any):Description for uFlags - -Returns: - - None - - """ - pass - - - def BrowseToObject(self,punk:'PyIUnknown',uFlags:'typing.Any') -> 'None': - """ - Description of BrowseToObject. - -Args: - - punk(PyIUnknown):Description for punk - uFlags(typing.Any):Description for uFlags - -Returns: - - None - - """ - pass - - - def FillFromObject(self,punk:'PyIUnknown',dwFlags:'typing.Any') -> 'None': - """ - Description of FillFromObject. - -Args: - - punk(PyIUnknown):Description for punk - dwFlags(typing.Any):Description for dwFlags - -Returns: - - None - - """ - pass - - - def RemoveAll(self,) -> 'None': - """ - Description of RemoveAll. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCurrentView(self,riid:'PyIID') -> 'PyIUnknown': - """ - Description of GetCurrentView. - -Args: - - riid(PyIID):Description for riid - -Returns: - - PyIUnknown - - """ - pass - - -class PyIExplorerBrowserEvents(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OnNavigationPending(self,pidlFolder:'typing.Any') -> 'None': - """ - Description of OnNavigationPending. - -Args: - - pidlFolder(typing.Any):Description for pidlFolder - -Returns: - - None - - """ - pass - - - def OnViewCreated(self,psv:'PyIShellView') -> 'None': - """ - Description of OnViewCreated. - -Args: - - psv(PyIShellView):Description for psv - -Returns: - - None - - """ - pass - - - def OnNavigationComplete(self,pidlFolder:'typing.Any') -> 'None': - """ - Description of OnNavigationComplete. - -Args: - - pidlFolder(typing.Any):Description for pidlFolder - -Returns: - - None - - """ - pass - - - def OnNavigationFailed(self,pidlFolder:'typing.Any') -> 'None': - """ - Description of OnNavigationFailed. - -Args: - - pidlFolder(typing.Any):Description for pidlFolder - -Returns: - - None - - """ - pass - - -class PyIExplorerCommand(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetTitle(self,psiItemArray:'PyIShellItemArray') -> 'typing.Any': - """ - Description of GetTitle. - -Args: - - psiItemArray(PyIShellItemArray):Description for psiItemArray - -Returns: - - typing.Any - - """ - pass - - - def GetIcon(self,psiItemArray:'PyIShellItemArray') -> 'typing.Any': - """ - Description of GetIcon. - -Args: - - psiItemArray(PyIShellItemArray):Description for psiItemArray - -Returns: - - typing.Any - - """ - pass - - - def GetToolTip(self,psiItemArray:'PyIShellItemArray') -> 'typing.Any': - """ - Description of GetToolTip. - -Args: - - psiItemArray(PyIShellItemArray):Description for psiItemArray - -Returns: - - typing.Any - - """ - pass - - - def GetCanonicalName(self,) -> 'PyIID': - """ - Description of GetCanonicalName. - -Args: - - - -Returns: - - PyIID - - """ - pass - - - def GetState(self,psiItemArray:'PyIShellItemArray',fOkToBeSlow:'typing.Any') -> 'typing.Any': - """ - Description of GetState. - -Args: - - psiItemArray(PyIShellItemArray):Description for psiItemArray - fOkToBeSlow(typing.Any):Description for fOkToBeSlow - -Returns: - - typing.Any - - """ - pass - - - def Invoke(self,psiItemArray:'PyIShellItemArray',pbc:'PyIBindCtx') -> 'None': - """ - Description of Invoke. - -Args: - - psiItemArray(PyIShellItemArray):Description for psiItemArray - pbc(PyIBindCtx):Description for pbc - -Returns: - - None - - """ - pass - - - def GetFlags(self,) -> 'typing.Any': - """ - Description of GetFlags. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def EnumSubCommands(self,) -> 'PyIEnumExplorerCommand': - """ - Description of EnumSubCommands. - -Args: - - - -Returns: - - PyIEnumExplorerCommand - - """ - pass - - -class PyIExplorerCommandProvider(object): - """This is a gateway only interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIExplorerPaneVisibility(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIExternalConnection(object): - """A Python wrapper for a COM IExternalConnection interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddConnection(self,extconn:'typing.Any',reserved:'typing.Any'=0) -> 'typing.Any': - """ - Increments an object's count of its strong external connections - -(links). - -Args: - - extconn(typing.Any):Type of external connection to the object. The only type of external connection currently supported by this interface is strong, which means that the object must remain alive as long as this external connection exists. Strong external connections are represented by the value EXTCONN_STRONG = 0x0001, which is defined in the enumeration EXTCON - reserved(typing.Any):A reserved parameterReturn ValueThe result is the number of reference counts on the object; used for debugging purposes only. - -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 - -(references). - -Args: - - extconn(typing.Any):Type of external connection - reserved(typing.Any):A reserved parameter. - fLastReleaseCloses(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 or another process.Return ValueThe result is the number of reference counts on the object; used for debugging purposes only. - -Returns: - - 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 - -or another process.Return ValueThe result is the number of reference counts on the object; used for debugging purposes only. - - - """ - pass - - -class PyIExtractIcon(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Extract(self,pszFile:'typing.Any',nIconIndex:'typing.Any',nIconSize:'typing.Any') -> 'None': - """ - Description of Extract. - -Args: - - pszFile(typing.Any):Description for pszFile - nIconIndex(typing.Any):Description for nIconIndex - nIconSize(typing.Any):Description for nIconIndexReturn ValueThe result is (hicon_large, hicon_small), or (None,None) if the underlying function returns S_FALSE, indicating the calling application should extract it. - -Returns: - - None:Description for nIconIndexReturn ValueThe result is (hicon_large, hicon_small), or - -(None,None) if the underlying function returns S_FALSE, indicating - -the calling application should extract it. - - - """ - pass - - - def GetIconLocation(self,uFlags:'typing.Any',cchMax:'typing.Any') -> 'None': - """ - Description of GetIconLocation. - -Args: - - uFlags(typing.Any):Description for uFlags - cchMax(typing.Any):Buffer size to allocate for file name - -Returns: - - None - - """ - pass - - -class PyIExtractIconW(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Extract(self,pszFile:'typing.Any',nIconIndex:'typing.Any',nIconSize:'typing.Any') -> 'None': - """ - Description of Extract. - -Args: - - pszFile(typing.Any):Description for pszFile - nIconIndex(typing.Any):Description for nIconIndex - nIconSize(typing.Any):Description for nIconIndexReturn ValueThe result is (hicon_large, hicon_small), or (None,None) if the underlying function returns S_FALSE, indicating the calling application should extract it. - -Returns: - - None:Description for nIconIndexReturn ValueThe result is (hicon_large, hicon_small), or - -(None,None) if the underlying function returns S_FALSE, indicating - -the calling application should extract it. - - - """ - pass - - - def GetIconLocation(self,uFlags:'typing.Any',cchMax:'typing.Any') -> 'None': - """ - Description of GetIconLocation. - -Args: - - uFlags(typing.Any):Description for uFlags - cchMax(typing.Any):Buffer size to allocate for file name - -Returns: - - None - - """ - pass - - -class PyIExtractImage(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetLocation(self,dwPriority:'typing.Any',size:'typing.Tuple[typing.Any, typing.Any]',dwRecClrDepth:'typing.Any',pdwFlags:'typing.Any') -> 'None': - """ - Description of GetLocation. - -Args: - - dwPriority(typing.Any):Description for dwPriority - size(typing.Tuple[typing.Any, typing.Any]):Description for prgSize - dwRecClrDepth(typing.Any):Description for dwRecClrDepth - pdwFlags(typing.Any):Description for pdwFlags - -Returns: - - None - - """ - pass - - - def Extract(self,) -> 'None': - """ - Description of Extract. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIFileOperation(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Advise(self,Sink:'PyGFileOperationProgressSink') -> 'typing.Any': - """ - Connects an event sink to receive updates - -Args: - - Sink(PyGFileOperationProgressSink):Interface that receives progress updatesReturn ValueReturns a cookie to be passed to PyIFileOperation::Unadvise to disconnect - -Returns: - - typing.Any:Interface that receives progress updatesReturn ValueReturns a cookie to be passed to PyIFileOperation::Unadvise to disconnect - - - """ - pass - - - def Unadvise(self,Cookie:'typing.Any') -> 'None': - """ - Disconnects a progress sink - -Args: - - Cookie(typing.Any):Identifies the sink to disconnect, as returned by PyIFileOperation::Advise - -Returns: - - None - - """ - pass - - - def SetOperationFlags(self,OperationFlags:'typing.Any') -> 'None': - """ - Sets option flags for the operation - -Args: - - OperationFlags(typing.Any):Combination of shellcon.FOF_* and FOFX_* flags - -Returns: - - None - - """ - pass - - - def SetProgressMessage(self,Message:'typing.Any') -> 'None': - """ - Not implemented. - -Args: - - Message(typing.Any):Description for Message - -Returns: - - None - - """ - pass - - - def SetProgressDialog(self,popd:'typing.Any') -> 'None': - """ - Provides an interface used to display a progress dialog - -Args: - - popd(typing.Any):Progress dialog interfaceCommentsIOperationsProgressDialog is not yet supported - -Returns: - - None - - """ - pass - - - def SetProperties(self,proparray:'PyIPropertyChangeArray') -> 'None': - """ - Specifies a set of properties to be changed. - -Args: - - proparray(PyIPropertyChangeArray):Sequence of property changes to be performed (see propsys::PSCreatePropertyChangeArray)CommentsNote that these properties will be set for *any* files created by the operation, not just items passed to ApplyPropertiesToItem(s). New items created as the result of a rename, copy, or move must have a property handler, or the operation fails with the vague com_error: (-2147467259, 'Unspecified error', None, None) (E_FAIL, or 0x80004005 in hex) even though the given file operation was actually performed. - -Returns: - - None - - """ - pass - - - def SetOwnerWindow(self,Owner:'int') -> 'None': - """ - Sets the parent window for any UI displayed. - -Args: - - Owner(int):Handle to parent window - -Returns: - - None - - """ - pass - - - def ApplyPropertiesToItem(self,Item:'PyIShellItem') -> 'None': - """ - Specifies the item that will receive property changes - -Args: - - Item(PyIShellItem):The item to which property changes will be applied - -Returns: - - None - - """ - pass - - - def ApplyPropertiesToItems(self,Items:'PyIUnknown') -> 'None': - """ - Specifies multiple items that will receive property changes - -Args: - - Items(PyIUnknown):PyIShellItemArray, PyIDataObject, or PyIEnumShellItems containing the target items - -Returns: - - None - - """ - pass - - - def RenameItem(self,Item:'PyIShellItem',NewName:'typing.Any',Sink:'PyGFileOperationProgressSink'=None) -> 'None': - """ - Adds a rename to the operation sequence - -Args: - - Item(PyIShellItem):The item to be renamed - NewName(typing.Any):The new name - Sink(PyGFileOperationProgressSink):Progress sink for this operation only. - -Returns: - - None - - """ - pass - - - def RenameItems(self,pUnkItems:'PyIUnknown',NewName:'typing.Any') -> 'None': - """ - Adds multiple renames to the operation sequence - -Args: - - pUnkItems(PyIUnknown):PyIShellItemArray, PyIDataObject, or PyIEnumShellItems containing items to be renamed - NewName(typing.Any):New name for all items. Collisions handled automatically. - -Returns: - - None - - """ - pass - - - def MoveItem(self,Item:'PyIShellItem',DestinationFolder:'PyIShellItem',pszNewName:'typing.Any'=None,Sink:'PyGFileOperationProgressSink'=None) -> 'None': - """ - Adds a move operation to the configuration - -Args: - - Item(PyIShellItem):The item to be moved - DestinationFolder(PyIShellItem):The folder into which it will be moved - pszNewName(typing.Any):Name to be given to moved item, use None to keep original name - Sink(PyGFileOperationProgressSink):Progress sink to receive notification for just this operation - -Returns: - - None - - """ - pass - - - def MoveItems(self,Items:'PyIUnknown',DestinationFolder:'PyIShellItem') -> 'None': - """ - Adds multiple move operations to the configuration - -Args: - - Items(PyIUnknown):PyIShellItemArray, PyIDataObject, or PyIEnumShellItems containing the items to be moved - DestinationFolder(PyIShellItem):Folder into which all items will be moved - -Returns: - - None - - """ - pass - - - def CopyItem(self,Item:'PyIShellItem',DestinationFolder:'PyIShellItem',CopyName:'typing.Any'=None,Sink:'PyGFileOperationProgressSink'=None) -> 'None': - """ - Adds a copy operation to the configuration - -Args: - - Item(PyIShellItem):Item to be copied - DestinationFolder(PyIShellItem):Folder into which it will be copied - CopyName(typing.Any):New name for the copied file, use None to keep original name - Sink(PyGFileOperationProgressSink):Progress sink for just this operation - -Returns: - - None - - """ - pass - - - def CopyItems(self,Items:'PyIUnknown',DestinationFolder:'PyIShellItem') -> 'None': - """ - Adds multiple copy operations to the configuration - -Args: - - Items(PyIUnknown):PyIShellItemArray, PyIDataObject, or PyIEnumShellItems containing items to be copied - DestinationFolder(PyIShellItem):Folder into which they will be copied - -Returns: - - None - - """ - pass - - - def DeleteItem(self,Item:'PyIShellItem',Sink:'PyGFileOperationProgressSink'=None) -> 'None': - """ - Adds a delete operation to the configuration - -Args: - - Item(PyIShellItem):Description for psiItem - Sink(PyGFileOperationProgressSink):Progress sink for just this operation - -Returns: - - None - - """ - pass - - - def DeleteItems(self,Items:'PyIUnknown') -> 'None': - """ - Adds multiple delete operations to the configuration - -Args: - - Items(PyIUnknown):PyIShellItemArray, PyIDataObject, or PyIEnumShellItems containing the items to be deleted - -Returns: - - None - - """ - pass - - - def NewItem(self,DestinationFolder:'PyIShellItem',FileAttributes:'typing.Any',Name:'typing.Any',TemplateName:'typing.Any'=None,Sink:'PyGFileOperationProgressSink'=None) -> 'None': - """ - Creates a new file as part of the operation - -Args: - - DestinationFolder(PyIShellItem):Folder in which to create the file - FileAttributes(typing.Any):Combination of win32con.FILE_ATTRIBUTE_* flags - Name(typing.Any):Name of the new file - TemplateName(typing.Any):Template file used to initialize the new file - Sink(PyGFileOperationProgressSink):Progress sink for just this operation - -Returns: - - None - - """ - pass - - - def PerformOperations(self,) -> 'None': - """ - Effects all configured file system modifications - -Args: - - - -Returns: - - None - - """ - pass - - - def GetAnyOperationsAborted(self,) -> 'typing.Any': - """ - Determines if any operations were terminated - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyIIdentityName(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIInitializeWithFile(object): - """Initializes a property handler that requires a file path instead of a stream""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,FilePath:'typing.Any',Mode:'typing.Any') -> 'None': - """ - Passes a file path to a property handler on startup - -Args: - - FilePath(typing.Any):Full path to the file whose properties are to be accessed - Mode(typing.Any):Indicates if properties can be written, STGM_READ or STGM_READWRITE - -Returns: - - None - - """ - pass - - -class PyIInitializeWithStream(object): - """Interface that initializes a handler capable of reading properties from a stream""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,Stream:'PyIStream',Mode:'typing.Any') -> 'None': - """ - Initializes a property handler with a stream - -Args: - - Stream(PyIStream):Stream containing the contents from which to extract properties - Mode(typing.Any):Indicates if stream is writable, STGM_READ or STGM_READWRITE - -Returns: - - None - - """ - pass - - -class PyIInputObject(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def TranslateAccelerator(self,pmsg:'typing.Any') -> 'None': - """ - Description of TranslateAccelerator. - -Args: - - pmsg(typing.Any):Description for pmsg - -Returns: - - None - - """ - pass - - - def UIActivate(self,uState:'typing.Any') -> 'None': - """ - Description of UIActivate. - -Args: - - uState(typing.Any):Description for uState - -Returns: - - None - - """ - pass - - - def HasFocusIO(self,) -> 'None': - """ - Description of Refresh. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIInternetBindInfo(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetBindInfo(self,) -> 'None': - """ - Description of GetBindInfo. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetBindString(self,) -> 'None': - """ - Description of GetBindString. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIInternetPriority(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetPriority(self,nPriority:'typing.Any') -> 'None': - """ - Description of SetPriority. - -Args: - - nPriority(typing.Any):Description for nPriority - -Returns: - - None - - """ - pass - - - def GetPriority(self,) -> 'None': - """ - Description of GetPriority. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIInternetProtocol(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Read(self,cb:'typing.Any') -> 'None': - """ - Description of Read. - -Args: - - cb(typing.Any):Description for cb - -Returns: - - None - - """ - pass - - - def Seek(self,dlibMove:'LARGE_INTEGER',dwOrigin:'typing.Any') -> 'None': - """ - Description of Seek. - -Args: - - dlibMove(LARGE_INTEGER):Description for dlibMove - dwOrigin(typing.Any):Description for dwOrigin - -Returns: - - None - - """ - pass - - - def LockRequest(self,dwOptions:'typing.Any') -> 'None': - """ - Description of LockRequest. - -Args: - - dwOptions(typing.Any):Description for dwOptions - -Returns: - - None - - """ - pass - - - def UnlockRequest(self,) -> 'None': - """ - Description of UnlockRequest. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIInternetProtocolInfo(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ParseUrl(self,pwzUrl:'typing.Any',ParseAction:'typing.Any',dwParseFlags:'typing.Any',cchResult:'typing.Any',dwReserved:'typing.Any') -> 'None': - """ - Description of ParseUrl. - -Args: - - pwzUrl(typing.Any):Description for pwzUrl - ParseAction(typing.Any):Description for ParseAction - dwParseFlags(typing.Any):Description for dwParseFlags - cchResult(typing.Any):Description for cchResult - dwReserved(typing.Any):Description for dwReserved - -Returns: - - None - - """ - pass - - - def CombineUrl(self,pwzBaseUrl:'typing.Any',pwzRelativeUrl:'typing.Any',dwCombineFlags:'typing.Any',cchResult:'typing.Any',dwReserved:'typing.Any') -> 'None': - """ - Description of CombineUrl. - -Args: - - pwzBaseUrl(typing.Any):Description for pwzBaseUrl - pwzRelativeUrl(typing.Any):Description for pwzRelativeUrl - dwCombineFlags(typing.Any):Description for dwCombineFlags - cchResult(typing.Any):Description for cchResult - dwReserved(typing.Any):Description for dwReserved - -Returns: - - None - - """ - pass - - - def CompareUrl(self,pwzUrl1:'typing.Any',pwzUrl2:'typing.Any',dwCompareFlags:'typing.Any') -> 'None': - """ - Description of CompareUrl. - -Args: - - pwzUrl1(typing.Any):Description for pwzUrl1 - pwzUrl2(typing.Any):Description for pwzUrl2 - dwCompareFlags(typing.Any):Description for dwCompareFlags - -Returns: - - None - - """ - pass - - - def QueryInfo(self,pwzUrl:'typing.Any',OueryOption:'typing.Any',dwQueryFlags:'typing.Any',cbBuffer:'typing.Any',dwReserved:'typing.Any') -> 'typing.Any': - """ - Description of QueryInfo. - -Args: - - pwzUrl(typing.Any):Description for pwzUrl - OueryOption(typing.Any):Description for OueryOption - dwQueryFlags(typing.Any):Description for dwQueryFlags - cbBuffer(typing.Any):Description for cbBuffer - dwReserved(typing.Any):Description for dwReservedCommentsIf the buffer size is the size of an integer, an integer will be returned, otherwise a string. - -Returns: - - typing.Any - - """ - pass - - -class PyIInternetProtocolRoot(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Start(self,szUrl:'typing.Any',pOIProtSink:'PyIInternetProtocolSink',pOIBindInfo:'PyIInternetBindInfo',grfPI:'typing.Any',dwReserved:'typing.Any') -> 'None': - """ - Description of Start. - -Args: - - szUrl(typing.Any):Description for szUrl - pOIProtSink(PyIInternetProtocolSink):Description for pOIProtSink - pOIBindInfo(PyIInternetBindInfo):Description for pOIBindInfo - grfPI(typing.Any):Description for grfPI - dwReserved(typing.Any):Description for dwReserved - -Returns: - - None - - """ - pass - - - def Continue(self,) -> 'None': - """ - Description of Continue. - -Args: - - - -Returns: - - None - - """ - pass - - - def Abort(self,hrReason:'typing.Any',dwOptions:'typing.Any') -> 'None': - """ - Description of Abort. - -Args: - - hrReason(typing.Any):Description for hrReason - dwOptions(typing.Any):Description for dwOptions - -Returns: - - None - - """ - pass - - - def Terminate(self,dwOptions:'typing.Any') -> 'None': - """ - Description of Terminate. - -Args: - - dwOptions(typing.Any):Description for dwOptions - -Returns: - - None - - """ - pass - - - def Suspend(self,) -> 'None': - """ - Description of Suspend. - -Args: - - - -Returns: - - None - - """ - pass - - - def Resume(self,) -> 'None': - """ - Description of Resume. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIInternetProtocolSink(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Switch(self,) -> 'None': - """ - Description of Switch. - -Args: - - - -Returns: - - None - - """ - pass - - - def ReportProgress(self,ulStatusCode:'typing.Any',szStatusText:'typing.Any') -> 'None': - """ - Description of ReportProgress. - -Args: - - ulStatusCode(typing.Any):Description for ulStatusCode - szStatusText(typing.Any):Description for szStatusText - -Returns: - - None - - """ - pass - - - def ReportData(self,grfBSCF:'typing.Any',ulProgress:'typing.Any',ulProgressMax:'typing.Any') -> 'None': - """ - Description of ReportData. - -Args: - - grfBSCF(typing.Any):Description for grfBSCF - ulProgress(typing.Any):Description for ulProgress - ulProgressMax(typing.Any):Description for ulProgressMax - -Returns: - - None - - """ - pass - - - def ReportResult(self,hrResult:'typing.Any',dwError:'typing.Any',szResult:'typing.Any') -> 'None': - """ - Description of ReportResult. - -Args: - - hrResult(typing.Any):Description for hrResult - dwError(typing.Any):Description for dwError - szResult(typing.Any):Description for szResult - -Returns: - - None - - """ - pass - - -class PyIInternetSecurityManager(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetSecuritySite(self,pSite:'typing.Any') -> 'None': - """ - Description of SetSecuritySite. - -Args: - - pSite(typing.Any):Description for pSite - -Returns: - - None - - """ - pass - - - def GetSecuritySite(self,) -> 'None': - """ - Description of GetSecuritySite. - -Args: - - - -Returns: - - None - - """ - pass - - - def MapUrlToZone(self,pwszUrl:'typing.Any',dwFlags:'typing.Any') -> 'None': - """ - Description of MapUrlToZone. - -Args: - - pwszUrl(typing.Any):Description for pwszUrl - dwFlags(typing.Any):Description for dwFlags - -Returns: - - None - - """ - pass - - - def GetSecurityId(self,pwszUrl:'typing.Any',pcbSecurityId:'typing.Any') -> 'None': - """ - Description of GetSecurityId. - -Args: - - pwszUrl(typing.Any):Description for pwszUrl - pcbSecurityId(typing.Any):Description for pcbSecurityId - -Returns: - - None - - """ - pass - - - def ProcessUrlAction(self,pwszUrl:'typing.Any',dwAction:'typing.Any',context:'typing.Any',dwFlags:'typing.Any') -> 'None': - """ - Description of ProcessUrlAction. - -Args: - - pwszUrl(typing.Any):Description for pwszUrl - dwAction(typing.Any):Description for dwAction - context(typing.Any): - dwFlags(typing.Any):Description for dwFlags - -Returns: - - None - - """ - pass - - - def SetZoneMapping(self,dwZone:'typing.Any',lpszPattern:'typing.Any',dwFlags:'typing.Any') -> 'None': - """ - Description of SetZoneMapping. - -Args: - - dwZone(typing.Any):Description for dwZone - lpszPattern(typing.Any):Description for lpszPattern - dwFlags(typing.Any):Description for dwFlags - -Returns: - - None - - """ - pass - - - def GetZoneMappings(self,dwZone:'typing.Any',dwFlags:'typing.Any') -> 'None': - """ - Description of GetZoneMappings. - -Args: - - dwZone(typing.Any):Description for dwZone - dwFlags(typing.Any):Description for dwFlags - -Returns: - - None - - """ - pass - - -class PyIKnownFolder(object): - """Interface representing a known folder that serves - -as a replacement for the numeric CSIDL definitions and API functions. - -Requires Vista or later.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetId(self,) -> 'PyIID': - """ - Returns the id of the folder - -Args: - - - -Returns: - - PyIID - - """ - pass - - - def GetCategory(self,) -> 'typing.Any': - """ - Returns the category for a folder (shellcon.KF_CATEGORY_*) - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetShellItem(self,riid:'PyIID',Flags:'typing.Any'=0) -> 'PyIShellItem': - """ - Returns a shell interface for the folder - -Args: - - riid(PyIID):The interface to return (IShellItem or IShellItem2) - Flags(typing.Any):Combination of shellcon.KF_FLAG_* values - -Returns: - - PyIShellItem - - """ - pass - - - def GetPath(self,Flags:'typing.Any'=0) -> 'typing.Any': - """ - Returns the path to the folder - -Args: - - Flags(typing.Any):Combination of shellcon.KF_FLAG_* flags controlling how the path is returned - -Returns: - - typing.Any - - """ - pass - - - def SetPath(self,Flags:'typing.Any',Path:'typing.Any') -> 'None': - """ - Changes the location of the folder - -Args: - - Flags(typing.Any):KF_FLAG_DONT_UNEXPAND, or 0 - Path(typing.Any):New path for known folder - -Returns: - - None - - """ - pass - - - def GetIDList(self,Flags:'typing.Any') -> 'PyIDL': - """ - Returns the folder's location as an item id list. - -Args: - - Flags(typing.Any):Combination of shellcon.KF_FLAG_* values that affect how the operation is performed - -Returns: - - PyIDL - - """ - pass - - - def GetFolderType(self,) -> 'PyIID': - """ - Returns the type of the folder - -Args: - - - -Returns: - - PyIID:PyIKnownFolder.GetFolderType -PyIID = GetFolderType()Returns the type of the folder -Return ValueReturns a folder type guid (shell.FOLDERTYPEID_*) - - - """ - pass - - - def GetRedirectionCapabilities(self,) -> 'typing.Any': - """ - Returns flags indicating how the folder can be redirected - -Args: - - - -Returns: - - typing.Any:PyIKnownFolder.GetRedirectionCapabilities - -int = GetRedirectionCapabilities()Returns flags indicating how the folder can be redirected -Return ValueCombination of shellcon.KF_REDIRECTION_CAPABILITIES_* flags - - - """ - pass - - - def GetFolderDefinition(self,) -> 'typing.Any': - """ - Retrieves detailed information about a known folder - -Args: - - - -Returns: - - typing.Any:PyIKnownFolder.GetFolderDefinition - -dict = GetFolderDefinition()Retrieves detailed information about a known folder -Return ValueReturns a dict containing info from a KNOWNFOLDER_DEFINITION struct - - - """ - pass - - -class PyIKnownFolderManager(object): - """Interface used to manage known folder definitions.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def FolderIdFromCsidl(self,Csidl:'typing.Any') -> 'PyIID': - """ - Returns the folder id that corresponds to a CSIDL - -Args: - - Csidl(typing.Any):The legacy CSIDL identifying a folder - -Returns: - - PyIID - - """ - pass - - - def FolderIdToCsidl(self,_id:'PyIID') -> 'typing.Any': - """ - Returns the CSIDL equivalent of a known folder - -Args: - - _id(PyIID):A known folder id (shell.FOLDERID_*) - -Returns: - - typing.Any - - """ - pass - - - def GetFolderIds(self,) -> 'typing.Tuple[PyIID, ...]': - """ - Retrieves all known folder ids. - -Args: - - - -Returns: - - typing.Tuple[PyIID, ...] - - """ - pass - - - def GetFolder(self,_id:'PyIID') -> 'PyIKnownFolder': - """ - Returns a folder by its id. - -Args: - - _id(PyIID):A known folder id (shell.FOLDERID_*) - -Returns: - - PyIKnownFolder - - """ - pass - - - def GetFolderByName(self,Name:'typing.Any') -> 'PyIKnownFolder': - """ - Returns a folder by canonical name - -Args: - - Name(typing.Any):The nonlocalized name of a known folder - -Returns: - - PyIKnownFolder - - """ - pass - - - def RegisterFolder(self,_id:'PyIID',Definition:'typing.Any') -> 'None': - """ - Defines a new known folder - -Args: - - _id(PyIID):GUID used to identify the new known folder - Definition(typing.Any):Dictionary containing info to be placed in a KNOWNFOLDER_DEFINITION structCommentsPyIKnownFolder::GetFolderDefinition can be used to get a template dictionary - -Returns: - - None - - """ - pass - - - def UnregisterFolder(self,_id:'PyIID') -> 'None': - """ - Removes the definition of a known folder - -Args: - - _id(PyIID):GUID of a known folder to be unregistered - -Returns: - - None - - """ - pass - - - def FindFolderFromPath(self,Path:'typing.Any',Mode:'typing.Any') -> 'PyIKnownFolder': - """ - Retrieves a known folder by path - -Args: - - Path(typing.Any):Path of a folder - Mode(typing.Any):FFFP_EXACTMATCH or FFFP_NEARESTPARENTMATCH - -Returns: - - PyIKnownFolder - - """ - pass - - - def FindFolderFromIDList(self,pidl:'PyIDL') -> 'PyIKnownFolder': - """ - Retrieves a known folder using its item id - -list. - -Args: - - pidl(PyIDL):Item id list of the folder - -Returns: - - PyIKnownFolder - - """ - pass - - - def Redirect(self,_id:'PyIID',hwnd:'int',flags:'typing.Any',TargetPath:'typing.Any',Exclusion:'typing.Tuple[PyIID, ...]') -> 'None': - """ - Redirects a known folder to an alternate location - -Args: - - _id(PyIID):Id of the known folder to be redirected - hwnd(int):Handle of window to be used for user interaction - flags(typing.Any):Combination of KF_REDIRECT_* flags - TargetPath(typing.Any):Path to which the known folder will be redirected - Exclusion(typing.Tuple[PyIID, ...]):Sequence of known folder ids of subfolders to be excluded from redirection - -Returns: - - None - - """ - pass - - -class PyILockBytes(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ReadAt(self,ulOffset:'ULARGE_INTEGER',cb:'typing.Any') -> 'str': - """ - Reads a specified number of bytes starting at a specified offset from the - -beginning of the byte array object. - -Args: - - ulOffset(ULARGE_INTEGER):Offset to start reading - cb(typing.Any):Number of bytes to readCommentsThe result is a binary buffer returned in a string. - -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 - -beginning of the byte array. - -Args: - - ulOffset(ULARGE_INTEGER):Offset to write at. - data(str):Data to writeReturn ValueThe result is the number of bytes actually written. - -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 - -to the backing storage. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetSize(self,cb:'ULARGE_INTEGER') -> 'None': - """ - Changes the size of the byte array. - -Args: - - cb(ULARGE_INTEGER):The new size. - -Returns: - - None - - """ - pass - - - def LockRegion(self,libOffset:'ULARGE_INTEGER',cb:'ULARGE_INTEGER',dwLockType:'typing.Any') -> 'None': - """ - Restricts access to a specified range of bytes in the byte array. - -Args: - - libOffset(ULARGE_INTEGER):The beginning of the region to lock. - cb(ULARGE_INTEGER):The number of bytes to lock. - dwLockType(typing.Any):Specifies the restrictions being requested on accessing the range. - -Returns: - - None - - """ - pass - - - def UnlockRegion(self,libOffset:'ULARGE_INTEGER',cb:'ULARGE_INTEGER',dwLockType:'typing.Any') -> 'None': - """ - None - -Args: - - libOffset(ULARGE_INTEGER):The beginning of the region to unlock. - cb(ULARGE_INTEGER):The number of bytes to lock. - dwLockType(typing.Any):Specifies the restrictions being requested on accessing the range. - -Returns: - - None - - """ - pass - - - def Stat(self,grfStatFlag:'typing.Any') -> 'STATSTG': - """ - None - -Args: - - grfStatFlag(typing.Any):Specifies that this method does not return some of the fields in the STATSTG structure, thus saving a memory allocation operation. Values are taken from the STATFLAG enumerationg - -Returns: - - STATSTG - - """ - pass - - -class PyIMAPIContainer(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OpenEntry(self,entryId:'str',iid:'PyIID',flags:'typing.Any') -> 'typing.Any': - """ - Opens an object and returns an interface object for further access. - -Args: - - entryId(str):The EntryID to open. - iid(PyIID):The IID of the returned interface, or None for the default interface. - flags(typing.Any):Flags for the call. May include MAPI_BEST_ACCESS, MAPI_DEFERRED_ERRORS, MAPI_MODIFY and possibly others (see the MAPI documentation) - -Returns: - - typing.Any - - """ - pass - - - def GetContentsTable(self,flags:'typing.Any') -> 'PyIMAPITable': - """ - Returns an object representing the container's contents table. - -Args: - - flags(typing.Any):The flags to use. - -Returns: - - PyIMAPITable - - """ - pass - - - def GetHierarchyTable(self,flags:'typing.Any') -> 'PyIMAPITable': - """ - Returns an object representing the container's hierarchy table. - -Args: - - flags(typing.Any):The flags to use. - -Returns: - - PyIMAPITable - - """ - pass - - -class PyIMAPIFolder(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetLastError(self,hr:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - Returns the last error code for the object. - -Args: - - hr(typing.Any):Contains the error code generated in the previous method call. - flags(typing.Any):Indicates for format for the output. - -Returns: - - typing.Any - - """ - pass - - - def CreateFolder(self,folderType:'typing.Any',folderName:'str',folderComment:'str'=None,iid:'PyIID'=None,flags:'typing.Any'=0) -> 'PyIMAPIFolder': - """ - Creates a folder object. - -Args: - - folderType(typing.Any):The type of folder to create - folderName(str):The name of the folder. - folderComment(str):A comment for the folder or None - iid(PyIID):The IID of the object to return. Should usually be None. - flags(typing.Any): - -Returns: - - PyIMAPIFolder - - """ - pass - - - def CreateMessage(self,iid:'PyIID',flags:'typing.Any') -> 'PyIMessage': - """ - Creates a message in a folder - -Args: - - iid(PyIID):The IID of the object to return. Should usually be None. - flags(typing.Any): - -Returns: - - PyIMessage - - """ - pass - - - def CopyMessages(self,msgs:'PySBinaryArray',iid:'PyIID',folder:'PyIMAPIFolder',ulUIParam:'typing.Any',progress:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - Copies the specified messages - -Args: - - msgs(PySBinaryArray): - iid(PyIID):IID representing the interface to be used to access the destination folder. Should usually be None. - folder(PyIMAPIFolder):The destination folder - ulUIParam(typing.Any):Handle of the parent window for any dialog boxes or windows this method displays. - progress(typing.Any):A progress object, or None - flags(typing.Any):A bitmask ofMaskDescriptionMAPI_DECLINE_OKInforms the message store provider to immediately return MAPI_E_DECLINE_COPY if it implements CopyMessage by calling the support object's IMAPISupport::DoCopyTo or IMAPISupport::DoCopyProps method.MESSAGE_DIALOGDisplays a progress indicator as the operation proceeds.MESSAGE_MOVEThe message or messages are to be moved rather than copied. If MESSAGE_MOVE is not set, the messages are copied. - -Returns: - - typing.Any - - """ - pass - - - def DeleteFolder(self,entryId:'str',uiParam:'typing.Any',progress:'typing.Any') -> 'None': - """ - Deletes a subfolder. - -Args: - - entryId(str):The EntryID of the subfolder to delete. - uiParam(typing.Any):Handle of the parent window of the progress indicator. - progress(typing.Any):A progress object, or None - -Returns: - - None - - """ - pass - - - def DeleteMessages(self,msgs:'PySBinaryArray',uiParam:'typing.Any',progress:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - Deletes the specified messages. - -Args: - - msgs(PySBinaryArray): - uiParam(typing.Any):A HWND for the progress - progress(typing.Any):A progress object, or None - flags(typing.Any): - -Returns: - - typing.Any - - """ - pass - - - def EmptyFolder(self,uiParam:'typing.Any',progress:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - deletes all messages and subfolders from a folder without deleting the folder itself. - -Args: - - uiParam(typing.Any):A HWND for the progress - progress(typing.Any):A progress object, or None - flags(typing.Any): - -Returns: - - typing.Any - - """ - pass - - - def SetReadFlags(self,msgs:'PySBinaryArray',uiParam:'typing.Any',progress:'typing.Any',flag:'typing.Any') -> 'None': - """ - Sets or clears the MSGFLAG_READ flag in the PR_MESSAGE_FLAGS (PidTagMessageFlags) property of one or more of the folder's messages, and manages the sending of read reports. - -Args: - - msgs(PySBinaryArray): - uiParam(typing.Any):A HWND for the progress - progress(typing.Any):A progress object, or None - flag(typing.Any):Bitmask of flags that controls the setting of a message's read flag - that is, the message's MSGFLAG_READ flag in its PR_MESSAGE_FLAGS property and the processing of read reports. - -Returns: - - None - - """ - pass - - -class PyIMAPIProp(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetProps(self,propList:'PySPropTagArray',flags:'typing.Any'=0) -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': - """ - Returns a list of property values. - -Args: - - propList(PySPropTagArray):The list of properties - flags(typing.Any): - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any] - - """ - pass - - - def DeleteProps(self,propList:'PySPropTagArray',wantProblems:'typing.Any'=False) -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': - """ - Deletes a set of properties. - -Args: - - propList(PySPropTagArray):The list of properties - wantProblems(typing.Any):Return detailed error information - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any] - - """ - pass - - - def SetProps(self,propList:'typing.Tuple[typing.Any, typing.Any]',wantProblems:'typing.Any'=False) -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': - """ - Sets a set of properties. - -Args: - - propList(typing.Tuple[typing.Any, typing.Any]):The list of properties - wantProblems(typing.Any):Return detailed error information - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any] - - """ - pass - - - def CopyTo(self,IIDExcludeList:'typing.Tuple[typing.Any, typing.Any]',propTags:'PySPropTagArray',uiParam:'typing.Any',progress:'typing.Any',resultIID:'PyIID',dest:'PyIMAPIProp',flags:'typing.Any',wantProblems:'typing.Any'=False) -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': - """ - Copies an object to another - -Args: - - IIDExcludeList(typing.Tuple[typing.Any, typing.Any]):A sequence of IIDs to exclude. - propTags(PySPropTagArray):The property tags to exclude. - uiParam(typing.Any):Handle to the parent window of the progress object - progress(typing.Any):Reserved - must pass None - resultIID(PyIID):IID of the destination object - dest(PyIMAPIProp):The destination object - flags(typing.Any):flags - wantProblems(typing.Any):Return detailed error information - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any] - - """ - pass - - - def CopyProps(self,propTags:'PySPropTagArray',uiParam:'typing.Any',progress:'typing.Any',resultIID:'PyIID',dest:'PyIMAPIProp',flags:'typing.Any',wantProblems:'typing.Any'=False) -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': - """ - Copies a set of properties to another object - -Args: - - propTags(PySPropTagArray):The property tags to copy - uiParam(typing.Any):Handle to the parent window of the progress object - progress(typing.Any):Reserved - must pass None - resultIID(PyIID):IID of the destination object - dest(PyIMAPIProp):The destination object - flags(typing.Any):flags - wantProblems(typing.Any):Return detailed error information - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any] - - """ - pass - - - def OpenProperty(self,propTag:'typing.Any',iid:'PyIID',interfaceOptions:'typing.Any',flags:'typing.Any') -> 'PyIUnknown': - """ - Returns an interface object to be used to access a property. - -Args: - - propTag(typing.Any):The property tag to open - iid(PyIID):The IID of the resulting interface. - interfaceOptions(typing.Any):Data that relates to the interface identified by the lpiid parameter. - flags(typing.Any):flags - -Returns: - - PyIUnknown - - """ - pass - - - def GetIDsFromNames(self,nameIds:'PyMAPINAMEIDArray',flags:'typing.Any'=0) -> 'PySPropTagArray': - """ - Determines property IDs - -Args: - - nameIds(PyMAPINAMEIDArray):Sequence of name ids - flags(typing.Any): - -Returns: - - PySPropTagArray - - """ - pass - - - def GetNamesFromIDs(self,propTags:'PySPropTagArray',propSetGuid:'PyIID'=None,flags:'typing.Any'=0) -> 'typing.Tuple[typing.Any, PySPropTagArray, PyMAPINAMEIDArray]': - """ - Determines property names - -Args: - - propTags(PySPropTagArray):Sequence of property tags, or None - propSetGuid(PyIID):a globally unique identifier, identifying a property set, or None - flags(typing.Any): - -Returns: - - typing.Tuple[typing.Any, PySPropTagArray, PyMAPINAMEIDArray] - - """ - pass - - - def GetLastError(self,hr:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - Returns the last error code for the object. - -Args: - - hr(typing.Any):Contains the error code generated in the previous method call. - flags(typing.Any):Indicates for format for the output. - -Returns: - - typing.Any - - """ - pass - - - def SaveChanges(self,flags:'typing.Any') -> 'None': - """ - Saves pending changes to the object - -Args: - - flags(typing.Any):flags - -Returns: - - None - - """ - pass - - - def GetPropList(self,flags:'typing.Any') -> 'PySPropTagArray': - """ - Gets a list of properties - -Args: - - flags(typing.Any):flags - -Returns: - - PySPropTagArray - - """ - pass - - -class PyIMAPISession(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OpenEntry(self,entryId:'str',iid:'PyIID',flags:'typing.Any') -> 'typing.Any': - """ - Opens an object and returns an interface object for further access. - -Args: - - entryId(str):The EntryID to open. - iid(PyIID):The IID of the returned interface, or None for the default interface. - flags(typing.Any):Flags for the call. May include MAPI_BEST_ACCESS, MAPI_DEFERRED_ERRORS, MAPI_MODIFY and possibly others (see the MAPI documentation) - -Returns: - - typing.Any - - """ - pass - - - def OpenMsgStore(self,uiParam:'typing.Any',entryId:'str',iid:'PyIID',flags:'typing.Any') -> 'PyIUnknown': - """ - Opens a message store. - -Args: - - uiParam(typing.Any):Handle to the parent window for dialogs. - entryId(str):The entry ID of the message store to open. - iid(PyIID):The IID of the interface returned, or None - flags(typing.Any):Options for the call.CommentsThe result is the interface specified by the IID, or IID_IMsgStore if None is used. - -Returns: - - PyIUnknown - - """ - pass - - - def QueryIdentity(self,) -> 'str': - """ - Returns the entry identifier of the object that provides the primary identity for the session. - -Args: - - - -Returns: - - str - - """ - pass - - - def Advise(self,entryId:'str',mask:'typing.Any',sink:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - entryId(str):The entryID of the object - mask(typing.Any): - sink(typing.Any):Return ValueThe result is an integer which should be passed to PyIMAPISession::Unadvise - -Returns: - - typing.Any:Return ValueThe result is an integer which should be passed to - -PyIMAPISession::Unadvise - - - """ - pass - - - def Unadvise(self,connection:'typing.Any') -> 'None': - """ - None - -Args: - - connection(typing.Any):Value returned from PyIMAPISession::Advise - -Returns: - - None - - """ - pass - - - def CompareEntryIDs(self,entryId:'str',entryId1:'str',flags:'typing.Any'=0) -> 'typing.Any': - """ - Compares two entry identifiers belonging to a particular address book provider to determine if they refer to the same address book object - -Args: - - entryId(str):The first entry ID to be compared - entryId1(str):The second entry ID to be compared - flags(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. - -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 - - - def GetLastError(self,hr:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - Returns the last error code for the object. - -Args: - - hr(typing.Any):Contains the error code generated in the previous method call. - flags(typing.Any):Indicates for format for the output. - -Returns: - - typing.Any - - """ - pass - - - def GetMsgStoresTable(self,flags:'typing.Any') -> 'PyIMAPITable': - """ - Provides access to the message store table - a table with information about all of the message stores in the session profile. - -Args: - - flags(typing.Any):Flags that control the opening. - -Returns: - - PyIMAPITable - - """ - pass - - - def GetStatusTable(self,flags:'typing.Any') -> 'PyIMAPITable': - """ - Provides access to the status table - a table with information about all of the MAPI resources in the session. - -Args: - - flags(typing.Any):Flags that control the opening. - -Returns: - - PyIMAPITable - - """ - pass - - - def Logoff(self,uiParm:'typing.Any',flags:'typing.Any',reserved:'typing.Any') -> 'None': - """ - Ends a MAPI session. - -Args: - - uiParm(typing.Any):hwnd of a dialog is to be displayed. - flags(typing.Any):Bitmask of flags that control the logoff operation. - reserved(typing.Any):Reserved; must be zero. - -Returns: - - None - - """ - pass - - - def OpenAddressBook(self,uiParm:'typing.Any',iid:'PyIID',flags:'typing.Any') -> 'PyIAddrBook': - """ - Opens the integrated address book. - -Args: - - uiParm(typing.Any):hwnd of a dialog is to be displayed. - iid(PyIID):The IID of the interface, or None. - flags(typing.Any):Flags that control the opening - AB_NO_DIALOG. - -Returns: - - PyIAddrBook - - """ - pass - - - def OpenProfileSection(self,iidSection:'PyIID',iid:'PyIID',flags:'typing.Any') -> 'typing.Any': - """ - Opens a section of the current profile and returns an object for futher access - -Args: - - iidSection(PyIID):The MAPIIID of the profile section - iid(PyIID):The IID of the interface, or None. - flags(typing.Any):Flags that control the opening. - -Returns: - - typing.Any - - """ - pass - - - def AdminServices(self,flags:'typing.Any'=0) -> 'PyIMsgServiceAdmin': - """ - Provides access to a message service administration object for making changes to the message services. - -Args: - - flags(typing.Any):reserved; must be zero. - -Returns: - - PyIMsgServiceAdmin - - """ - pass - - -class PyIMAPIStatus(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ChangePassword(self,oldPassword:'typing.Any',newPassword:'typing.Any',ulFlags:'typing.Any') -> 'None': - """ - None - -Args: - - oldPassword(typing.Any): - newPassword(typing.Any): - ulFlags(typing.Any): - -Returns: - - None - - """ - pass - - - def SettingsDialog(self,ulUIParam:'typing.Any',ulFlags:'typing.Any') -> 'None': - """ - None - -Args: - - ulUIParam(typing.Any): - ulFlags(typing.Any): - -Returns: - - None - - """ - pass - - - def ValidateState(self,ulUIParam:'typing.Any',ulFlags:'typing.Any') -> 'None': - """ - None - -Args: - - ulUIParam(typing.Any): - ulFlags(typing.Any): - -Returns: - - None - - """ - pass - - - def FlushQueues(self,ulUIParam:'typing.Any',transport:'str',ulFlags:'typing.Any') -> 'None': - """ - None - -Args: - - ulUIParam(typing.Any): - transport(str):Blob of data - ulFlags(typing.Any): - -Returns: - - None - - """ - pass - - -class PyIMAPITable(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetLastError(self,hr:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - Returns the last error code for the object. - -Args: - - hr(typing.Any):Contains the error code generated in the previous method call. - flags(typing.Any):Indicates for format for the output. - -Returns: - - typing.Any - - """ - pass - - - def Advise(self,eventMask:'typing.Any',adviseSink:'typing.Any') -> 'typing.Any': - """ - Registers to receive notification of specified events affecting the table. - -Args: - - eventMask(typing.Any): - adviseSink(typing.Any): - -Returns: - - typing.Any - - """ - pass - - - def SeekRow(self,bookmark:'typing.Any',rowCount:'typing.Any') -> 'typing.Any': - """ - Moves the cursor to a specific position in the table. - -Args: - - bookmark(typing.Any):The bookmark. - rowCount(typing.Any):Return ValueThe result is the number of rows processed. - -Returns: - - typing.Any:Return ValueThe result is the number of rows processed. - - - """ - pass - - - def SeekRowApprox(self,numerator:'typing.Any',denominator:'typing.Any') -> 'None': - """ - Moves the cursor to an approximate fractional position in the table. - -Args: - - numerator(typing.Any):The numerator of the fraction representing the table position - denominator(typing.Any):The denominator of the fraction representing the table position. This must not be zero. - -Returns: - - None - - """ - pass - - - def GetRowCount(self,flags:'typing.Any') -> 'typing.Any': - """ - Returns the total number of rows in the table. - -Args: - - flags(typing.Any):Reserved - must be zero - -Returns: - - typing.Any - - """ - pass - - - def QueryRows(self,rowCount:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - Returns one or more rows from a table, beginning at the current cursor position. - -Args: - - rowCount(typing.Any):Number of rows to retrieve - flags(typing.Any):Flags. - -Returns: - - typing.Any - - """ - pass - - - def SetColumns(self,propTags:'typing.Any',flags:'typing.Any') -> 'None': - """ - Defines the particular properties and order of properties to appear as columns in the table. - -Args: - - propTags(typing.Any):Sequence of property tags identifying properties to be included as columns in the table. - flags(typing.Any): - -Returns: - - None - - """ - pass - - - def GetStatus(self,) -> 'None': - """ - Returns the table's status and type. - -Args: - - - -Returns: - - None:PyIMAPITable.GetStatus -GetStatus()Returns the table's status and type. -Return ValueResult is a tuple of (tableStatus, tableType) - - - """ - pass - - - def QueryPosition(self,) -> 'None': - """ - Retrieves the current table row position of the cursor, based on a fractional value. - -Args: - - - -Returns: - - None:PyIMAPITable.QueryPosition -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 - - - def QueryColumns(self,flags:'typing.Any') -> 'typing.Any': - """ - Returns a list of columns for the table. - -Args: - - flags(typing.Any): - -Returns: - - typing.Any - - """ - pass - - - def Abort(self,) -> 'None': - """ - Stops any asynchronous operations currently in progress for the table. - -Args: - - - -Returns: - - None - - """ - pass - - - def FreeBookmark(self,bookmark:'typing.Any') -> 'None': - """ - Releases the memory associated with a bookmark. - -Args: - - bookmark(typing.Any): - -Returns: - - None - - """ - pass - - - def CreateBookmark(self,) -> 'typing.Any': - """ - Marks the table's current position. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def Restrict(self,restriction:'PySRestriction',flags:'typing.Any') -> 'None': - """ - Applies a filter to a table, reducing the row set to only those rows matching the specified criteria. - -Args: - - restriction(PySRestriction): - flags(typing.Any): - -Returns: - - None - - """ - pass - - - def FindRow(self,restriction:'PySRestriction',bookmarkOrigin:'typing.Any',flags:'typing.Any') -> 'None': - """ - Finds the next row in a table that matches specific search criteria. - -Args: - - restriction(PySRestriction): - bookmarkOrigin(typing.Any): - flags(typing.Any): - -Returns: - - None - - """ - pass - - - def SortTable(self,sortOrderSet:'PySSortOrderSet',flags:'typing.Any') -> 'None': - """ - Orders the rows of the table based on sort criteria. - -Args: - - sortOrderSet(PySSortOrderSet): - flags(typing.Any): - -Returns: - - None - - """ - pass - - - def Unadvise(self,handle:'typing.Any') -> 'None': - """ - Cancels the sending of notifications previously set up with a call to the IMAPITable::Advise method. - -Args: - - handle(typing.Any):Handle returned from PyIMAPITable::Advise - -Returns: - - None - - """ - pass - - -class PyIMachineDebugManager(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddApplication(self,pda:'PyIRemoteDebugApplication') -> 'None': - """ - Description of AddApplication. - -Args: - - pda(PyIRemoteDebugApplication):Description for pda - -Returns: - - None - - """ - pass - - - def RemoveApplication(self,dwAppCookie:'typing.Any') -> 'None': - """ - Description of RemoveApplication. - -Args: - - dwAppCookie(typing.Any):Description for dwAppCookie - -Returns: - - None - - """ - pass - - - def EnumApplications(self,) -> 'None': - """ - Description of EnumApplications. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIMachineDebugManagerEvents(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def onAddApplication(self,pda:'PyIRemoteDebugApplication',dwAppCookie:'typing.Any') -> 'None': - """ - Description of onAddApplication. - -Args: - - pda(PyIRemoteDebugApplication):Description for pda - dwAppCookie(typing.Any):Description for dwAppCookie - -Returns: - - None - - """ - pass - - - def onRemoveApplication(self,pda:'PyIRemoteDebugApplication',dwAppCookie:'typing.Any') -> 'None': - """ - Description of onRemoveApplication. - -Args: - - pda(PyIRemoteDebugApplication):Description for pda - dwAppCookie(typing.Any):Description for dwAppCookie - -Returns: - - None - - """ - pass - - -class PyIMessage(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetReadFlag(self,flag:'typing.Any') -> 'None': - """ - Sets the read flags for a message - -Args: - - flag(typing.Any):Bitmask of flags that controls the setting of a message's read flag - that is, the message's MSGFLAG_READ flag in its PR_MESSAGE_FLAGS property and the processing of read reports. - -Returns: - - None - - """ - pass - - - def GetAttachmentTable(self,flags:'typing.Any') -> 'PyIMAPITable': - """ - Returns the message's attachment table. - -Args: - - flags(typing.Any):Bitmask of flags that relate to the creation of the table. - -Returns: - - PyIMAPITable - - """ - pass - - - def OpenAttach(self,attachmentNum:'typing.Any',interface:'PyIID',flags:'typing.Any') -> 'PyIAttach': - """ - Opens an attachment - -Args: - - attachmentNum(typing.Any): - interface(PyIID):The interface to use, or None - flags(typing.Any):Bitmask of flags that controls how the attachment is opened. - -Returns: - - PyIAttach - - """ - pass - - - def CreateAttach(self,interface:'PyIID',flags:'typing.Any') -> 'typing.Tuple[typing.Any, PyIAttach]': - """ - Creates an attachment - -Args: - - interface(PyIID):The interface to use, or None - flags(typing.Any):Bitmask of flags that controls how the attachment is created.Return ValueThe result is a tuple of (attachmentNum, attachmentObject) - -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 - - - def DeleteAttach(self,attachmentNum:'typing.Any',ulUIParam:'typing.Any',interface:'typing.Any',flags:'typing.Any') -> 'None': - """ - Deletes an attachment - -Args: - - attachmentNum(typing.Any): - ulUIParam(typing.Any): - interface(typing.Any):The interface to use, or None - flags(typing.Any):Bitmask of flags that controls the display of a user interface. - -Returns: - - None - - """ - pass - - - def ModifyRecipients(self,flags:'typing.Any',mods:'typing.Any') -> 'None': - """ - adds, deletes, or modifies message recipients. - -Args: - - flags(typing.Any):Bitmask of flags that controls the recipient changes. If zero is passed for the ulFlags parameter, ModifyRecipients replaces all existing recipients with the recipient list in the mods parameter. - mods(typing.Any):The list of recipients. - -Returns: - - None - - """ - pass - - - def GetRecipientTable(self,flags:'typing.Any') -> 'PyIMAPITable': - """ - Returns the message's recipient table. - -Args: - - flags(typing.Any):Bitmask of flags that relate to the creation of the table. - -Returns: - - PyIMAPITable - - """ - pass - - - def SubmitMessage(self,flags:'typing.Any') -> 'None': - """ - Saves all of the message's properties and marks the message as ready to be sent. - -Args: - - flags(typing.Any):Flags which specify how the message is submitted. - -Returns: - - None - - """ - pass - - -class PyIMoniker(object): - """A Python interface to IMoniker""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def BindToObject(self,bindCtx:'PyIBindCtx',moniker:'PyIMoniker',iidResult:'typing.Any') -> 'PyIUnknown': - """ - Uses the moniker to bind to the object it identifies. - -Args: - - bindCtx(PyIBindCtx):bind context object to be used. - moniker(PyIMoniker):If the moniker is part of a composite moniker, otherwise None - iidResult(typing.Any):IID of the result object. - -Returns: - - PyIUnknown - - """ - pass - - - def BindToStorage(self,bindCtx:'PyIBindCtx',moniker:'PyIMoniker',iidResult:'typing.Any') -> 'PyIUnknown': - """ - Retrieves an interface object to the storage that contains the - -object identified by the moniker. - -Args: - - bindCtx(PyIBindCtx):bind context object to be used. - moniker(PyIMoniker):If the moniker is part of a composite moniker, otherwise None - iidResult(typing.Any):IID of the result object. - -Returns: - - PyIUnknown - - """ - pass - - - def GetDisplayName(self,bindCtx:'PyIBindCtx',moniker:'PyIMoniker') -> 'str': - """ - Gets the display name , which is a user-readable representation of this - -moniker. - -Args: - - bindCtx(PyIBindCtx):bind context object to be used. - moniker(PyIMoniker):If the moniker is part of a composite moniker, otherwise None - -Returns: - - str - - """ - pass - - - def ComposeWith(self,mkRight:'PyIMoniker',fOnlyIfNotGeneric:'typing.Any') -> 'PyIMoniker': - """ - Combines the current moniker with another moniker, creating a new - -composite moniker. - -Args: - - mkRight(PyIMoniker):The IMoniker interface on the moniker to compose onto the end of this moniker. - fOnlyIfNotGeneric(typing.Any):If TRUE, the caller requires a non-generic composition, so the operation should proceed only if pmkRight is a moniker class that this moniker can compose with in some way other than forming a generic composite. If FALSE, the method can create a generic composite if necessary. - -Returns: - - PyIMoniker - - """ - pass - - - def Enum(self,fForward:'typing.Any'=True) -> 'PyIEnumMoniker': - """ - Supplies an enumerator that can enumerate the components of a composite - -moniker. - -Args: - - fForward(typing.Any):If TRUE, enumerates the monikers from left to right. If FALSE, enumerates from right to left. - -Returns: - - PyIEnumMoniker - - """ - pass - - - def IsEqual(self,other:'PyIMoniker') -> 'typing.Any': - """ - Compares this moniker with a specified moniker and indicates whether they are - -identical. - -Args: - - other(PyIMoniker):The moniker to compare - -Returns: - - typing.Any - - """ - pass - - - def IsSystemMoniker(self,) -> 'typing.Any': - """ - Indicates whether this moniker is of one of the system-supplied moniker - -classes. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def Hash(self,) -> 'typing.Any': - """ - Calculates a 32-bit integer using the internal state of the moniker. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyIMsgServiceAdmin(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetLastError(self,hr:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - Returns the last error code for the object. - -Args: - - hr(typing.Any):Contains the error code generated in the previous method call. - flags(typing.Any):Indicates for format for the output. - -Returns: - - typing.Any - - """ - pass - - - def CreateMsgService(self,serviceName:'str',displayName:'str',flags:'typing.Any',uiParam:'typing.Any'=0) -> 'None': - """ - Creates a message service. - -Args: - - serviceName(str):The name of the service. - displayName(str):Display name of the service, or None - flags(typing.Any):A bitmask of flags that controls how the message service is installed. - uiParam(typing.Any):A handle of the parent window for any dialog boxes or windows that this method displays. - -Returns: - - None - - """ - pass - - - def ConfigureMsgService(self,iid:'PyIID',ulUIParam:'typing.Any',ulFlags:'typing.Any',arg:'typing.List[typing.Any]') -> 'None': - """ - Reconfigures a message service. - -Args: - - iid(PyIID):The unique identifier for the message service to configure. - ulUIParam(typing.Any):Handle of the parent window for the configuration property sheet. - ulFlags(typing.Any):Bitmask of flags that controls the display of the property sheet. - arg(typing.List[typing.Any]):Property values describing the properties to display in the property sheet. Should not be None if the service is to be configured without a message service. - -Returns: - - None - - """ - pass - - - def GetMsgServiceTable(self,flags:'typing.Any') -> 'PyIMAPITable': - """ - Retrieves a table of services. - -Args: - - flags(typing.Any): - -Returns: - - PyIMAPITable - - """ - pass - - - def GetProviderTable(self,flags:'typing.Any') -> 'PyIMAPITable': - """ - Retrieves a table of service providers. - -Args: - - flags(typing.Any): - -Returns: - - PyIMAPITable - - """ - pass - - - def DeleteMsgService(self,uuid:'PyIID') -> 'None': - """ - Deletes the specified service - -Args: - - uuid(PyIID):The ID of the service - -Returns: - - None - - """ - pass - - - def RenameMsgService(self,uuid:'PyIID',flags:'typing.Any',newName:'str') -> 'None': - """ - Renames the specified service - -Args: - - uuid(PyIID):The ID of the service - flags(typing.Any): - newName(str):The new name for the service.CommentsThis is deprecated, and there is no replacement referenced to use instead. - -Returns: - - None - - """ - pass - - - def OpenProfileSection(self,uuid:'PyIID',iid:'PyIID',flags:'typing.Any') -> 'typing.Any': - """ - Opens a profile section - -Args: - - uuid(PyIID):The ID of the service - iid(PyIID):The IID of the resulting object, or None for the default - flags(typing.Any): - -Returns: - - typing.Any - - """ - pass - - - def AdminProviders(self,uuid:'PyIID',flags:'typing.Any') -> 'typing.Any': - """ - Returns an object providing access - -to a provider administration object. - -Args: - - uuid(PyIID):The ID of the service - flags(typing.Any): - -Returns: - - typing.Any - - """ - pass - - -class PyIMsgStore(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OpenEntry(self,entryId:'str',iid:'PyIID',flags:'typing.Any') -> 'typing.Any': - """ - Opens a folder or message and returns an interface object for further access. - -Args: - - entryId(str):The entryID of the object - iid(PyIID):The IID of the object to return, or None for the default IID - flags(typing.Any):Bitmask of flags that controls how the object is opened. - -Returns: - - typing.Any - - """ - pass - - - def GetReceiveFolder(self,messageClass:'str'=None,flags:'typing.Any'=0) -> 'typing.Tuple[PyIID, str]': - """ - Obtains the folder that was established as the destination for incoming messages of a specified message class or the default receive folder for the message store. - -Args: - - messageClass(str):Message class that is associated with a receive folder. If this parameter is set to None or an empty string, GetReceiveFolder returns the default receive folder for the message store. - flags(typing.Any): - -Returns: - - typing.Tuple[PyIID, str] - - """ - pass - - - def GetReceiveFolderTable(self,flags:'typing.Any') -> 'PyIMAPITable': - """ - provides access to the receive folder table, a table that includes information about all of the receive folders for the message store. - -Args: - - flags(typing.Any):Bitmask of flags that controls table access - -Returns: - - PyIMAPITable - - """ - pass - - - def CompareEntryIDs(self,entryId:'str',entryId1:'str',flags:'typing.Any'=0) -> 'typing.Any': - """ - Compares two entry identifiers belonging to a particular address book provider to determine if they refer to the same address book object - -Args: - - entryId(str):The first entry ID to be compared - entryId1(str):The second entry ID to be compared - flags(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. - -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 - - - def GetLastError(self,hr:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - Returns the last error code for the object. - -Args: - - hr(typing.Any):Contains the error code generated in the previous method call. - flags(typing.Any):Indicates for format for the output. - -Returns: - - typing.Any - - """ - pass - - - def AbortSubmit(self,entryId:'str',flags:'typing.Any'=0) -> 'typing.Any': - """ - Attempts to remove a message from the outgoing queue. - -Args: - - entryId(str):The entry ID of the item to be aborted. - flags(typing.Any):Reserved - must be zero. - -Returns: - - typing.Any - - """ - pass - - - def Advise(self,entryId:'str',eventMask:'typing.Any',adviseSink:'typing.Any') -> 'None': - """ - Registers to receive notification of specified events that affect the message store. - -Args: - - entryId(str):entry identifier of the folder or message about which notifications should be generated, or None - eventMask(typing.Any):A mask of values that indicate the types of notification events. - adviseSink(typing.Any):An advise sink. - -Returns: - - None - - """ - pass - - - def Unadvise(self,connection:'typing.Any') -> 'None': - """ - Cancels the sending of notifications previously set up with a call to the IMsgStore::Advise method. - -Args: - - connection(typing.Any):Connection number returned from PyIMsgStore::Advise - -Returns: - - None - - """ - pass - - -class PyINameSpaceTreeControl(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,hwndParent:'typing.Union[typing.Any]',prc:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',nsctsFlags:'typing.Any') -> 'None': - """ - Description of Initialize. - -Args: - - hwndParent(typing.Union[typing.Any]):Description for hwndParent - prc(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Description for prc - nsctsFlags(typing.Any):Description for nsctsFlags - -Returns: - - None - - """ - pass - - - def TreeAdvise(self,punk:'PyIUnknown') -> 'None': - """ - Description of TreeAdvise. - -Args: - - punk(PyIUnknown):Description for punk - -Returns: - - None - - """ - pass - - - def TreeUnadvise(self,dwCookie:'typing.Any') -> 'None': - """ - Description of TreeUnadvise. - -Args: - - dwCookie(typing.Any):Description for dwCookie - -Returns: - - None - - """ - pass - - - def AppendRoot(self,psiRoot:'PyIShellItem',grfEnumFlags:'typing.Any',grfRootStyle:'typing.Any',pif:'typing.Any') -> 'None': - """ - Description of AppendRoot. - -Args: - - psiRoot(PyIShellItem):Description for psiRoot - grfEnumFlags(typing.Any):Description for grfEnumFlags - grfRootStyle(typing.Any):Description for grfRootStyle - pif(typing.Any):Description for pif - -Returns: - - None - - """ - pass - - - def InsertRoot(self,iIndex:'typing.Any',psiRoot:'PyIShellItem',grfEnumFlags:'typing.Any',grfRootStyle:'typing.Any',pif:'typing.Any') -> 'None': - """ - Description of InsertRoot. - -Args: - - iIndex(typing.Any):Description for iIndex - psiRoot(PyIShellItem):Description for psiRoot - grfEnumFlags(typing.Any):Description for grfEnumFlags - grfRootStyle(typing.Any):Description for grfRootStyle - pif(typing.Any):Description for pif - -Returns: - - None - - """ - pass - - - def RemoveRoot(self,psiRoot:'PyIShellItem') -> 'None': - """ - Description of RemoveRoot. - -Args: - - psiRoot(PyIShellItem):Description for psiRoot - -Returns: - - None - - """ - pass - - - def RemoveAllRoots(self,) -> 'None': - """ - Description of RemoveAllRoots. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetRootItems(self,) -> 'None': - """ - Description of GetRootItems. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetItemState(self,psi:'PyIShellItem',nstcisMask:'typing.Any',nstcisFlags:'typing.Any') -> 'None': - """ - Description of SetItemState. - -Args: - - psi(PyIShellItem):Description for psi - nstcisMask(typing.Any):Description for nstcisMask - nstcisFlags(typing.Any):Description for nstcisFlags - -Returns: - - None - - """ - pass - - - def GetItemState(self,psi:'PyIShellItem',nstcisMask:'typing.Any') -> 'None': - """ - Description of GetItemState. - -Args: - - psi(PyIShellItem):Description for psi - nstcisMask(typing.Any):Description for nstcisMask - -Returns: - - None - - """ - pass - - - def GetSelectedItems(self,) -> 'None': - """ - Description of GetSelectedItems. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetItemCustomState(self,psi:'PyIShellItem') -> 'None': - """ - Description of GetItemCustomState. - -Args: - - psi(PyIShellItem):Description for psi - -Returns: - - None - - """ - pass - - - def SetItemCustomState(self,psi:'PyIShellItem',iStateNumber:'typing.Any') -> 'None': - """ - Description of SetItemCustomState. - -Args: - - psi(PyIShellItem):Description for psi - iStateNumber(typing.Any):Description for iStateNumber - -Returns: - - None - - """ - pass - - - def EnsureItemVisible(self,psi:'PyIShellItem') -> 'None': - """ - Description of EnsureItemVisible. - -Args: - - psi(PyIShellItem):Description for psi - -Returns: - - None - - """ - pass - - - def SetTheme(self,pszTheme:'typing.Any') -> 'None': - """ - Description of SetTheme. - -Args: - - pszTheme(typing.Any):Description for pszTheme - -Returns: - - None - - """ - pass - - - def GetNextItem(self,psi:'PyIShellItem',nstcgi:'typing.Any') -> 'None': - """ - Description of GetNextItem. - -Args: - - psi(PyIShellItem):Description for psi - nstcgi(typing.Any):Description for nstcgi - -Returns: - - None - - """ - pass - - - def HitTest(self,pt:'typing.Tuple[typing.Any, typing.Any]') -> 'None': - """ - Description of HitTest. - -Args: - - pt(typing.Tuple[typing.Any, typing.Any]):Description for ppt - -Returns: - - None - - """ - pass - - - def GetItemRect(self,) -> 'None': - """ - Description of GetItemRect. - -Args: - - - -Returns: - - None - - """ - pass - - - def CollapseAll(self,) -> 'None': - """ - Description of CollapseAll. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyINamedPropertyStore(object): - """Contains a collection of properties indentified by name""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetNamedValue(self,Name:'typing.Any') -> 'PyPROPVARIANT': - """ - Retrieves a property value by name - -Args: - - Name(typing.Any):Name of the property - -Returns: - - PyPROPVARIANT - - """ - pass - - - def SetNamedValue(self,propvar:'typing.Any') -> 'None': - """ - Sets the value of a property - -Args: - - propvar(typing.Any):Description for propvar - -Returns: - - None - - """ - pass - - - def GetNameCount(self,) -> 'typing.Any': - """ - Retrieves the number of named properties in the store - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetNameAt(self,Index:'typing.Any') -> 'typing.Any': - """ - Retrieves a property name by zero-based index - -Args: - - Index(typing.Any):Index of the property name - -Returns: - - typing.Any - - """ - pass - - -class PyIObjectArray(object): - """Holds a collection of interface objects""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetCount(self,) -> 'typing.Any': - """ - Returns number of objects in collection - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetAt(self,Index:'typing.Any',riid:'PyIID') -> 'PyIUnknown': - """ - Retrieves an item by zero-based index - -Args: - - Index(typing.Any):Index of item to retrieve - riid(PyIID):The interface to return - -Returns: - - PyIUnknown - - """ - pass - - -class PyIObjectCollection(object): - """Modifiable container for a number of IUnknown objects""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddObject(self,punk:'PyIUnknown') -> 'None': - """ - Adds a single object to the collection - -Args: - - punk(PyIUnknown):Object to be added - -Returns: - - None - - """ - pass - - - def AddFromArray(self,Source:'PyIObjectArray') -> 'None': - """ - None - -Args: - - Source(PyIObjectArray):Objects to be added to the collection - -Returns: - - None - - """ - pass - - - def RemoveObjectAt(self,Index:'typing.Any') -> 'None': - """ - Removes a single object from the collection - -Args: - - Index(typing.Any):Zero-based index of item to remove - -Returns: - - None - - """ - pass - - - def Clear(self,) -> 'None': - """ - Empties the container. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIObjectWithPropertyKey(object): - """Interface implemented by objects that have an associated property id""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetPropertyKey(self,key:'PyPROPERTYKEY') -> 'None': - """ - Sets the property id - -Args: - - key(PyPROPERTYKEY):The identifier of the property - -Returns: - - None - - """ - pass - - - def GetPropertyKey(self,) -> 'PyPROPERTYKEY': - """ - Returns the property id - -Args: - - - -Returns: - - PyPROPERTYKEY - - """ - pass - - -class PyIObjectWithSite(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetSite(self,pUnkSite:'typing.Any') -> 'None': - """ - Description of SetSite. - -Args: - - pUnkSite(typing.Any):Description for pUnkSite - -Returns: - - None - - """ - pass - - - def GetSite(self,riid:'PyIID') -> 'None': - """ - Description of GetSite. - -Args: - - riid(PyIID):Description for riid - -Returns: - - None - - """ - pass - - -class PyIOleClientSite(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SaveObject(self,) -> 'None': - """ - Description of SaveObject. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetMoniker(self,dwAssign:'typing.Any',dwWhichMoniker:'typing.Any') -> 'None': - """ - Description of GetMoniker. - -Args: - - dwAssign(typing.Any):Description for dwAssign - dwWhichMoniker(typing.Any):Description for dwWhichMoniker - -Returns: - - None - - """ - pass - - - def GetContainer(self,) -> 'None': - """ - Description of GetContainer. - -Args: - - - -Returns: - - None - - """ - pass - - - def ShowObject(self,) -> 'None': - """ - Description of ShowObject. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnShowWindow(self,fShow:'typing.Any') -> 'None': - """ - Description of OnShowWindow. - -Args: - - fShow(typing.Any):Description for fShow - -Returns: - - None - - """ - pass - - - def RequestNewObjectLayout(self,) -> 'None': - """ - Description of RequestNewObjectLayout. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIOleCommandTarget(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def QueryStatus(self,) -> 'None': - """ - Description of QueryStatus. - -Args: - - - -Returns: - - None - - """ - pass - - - def Exec(self,) -> 'None': - """ - Description of Exec. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIOleControl(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetControlInfo(self,) -> 'None': - """ - Description of GetControlInfo. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnMnemonic(self,msg:'typing.Any') -> 'None': - """ - Description of OnMnemonic. - -Args: - - msg(typing.Any):A tuple representing a MSG structure. - -Returns: - - None - - """ - pass - - - def OnAmbientPropertyChange(self,dispID:'typing.Any') -> 'None': - """ - Description of OnAmbientPropertyChange. - -Args: - - dispID(typing.Any):Description for dispID - -Returns: - - None - - """ - pass - - - def FreezeEvents(self,bFreeze:'typing.Any') -> 'None': - """ - Description of FreezeEvents. - -Args: - - bFreeze(typing.Any):Description for bFreeze - -Returns: - - None - - """ - pass - - -class PyIOleControlSite(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OnControlInfoChanged(self,) -> 'None': - """ - Description of OnControlInfoChanged. - -Args: - - - -Returns: - - None - - """ - pass - - - def LockInPlaceActive(self,fLock:'typing.Any') -> 'None': - """ - Description of LockInPlaceActive. - -Args: - - fLock(typing.Any):Description for fLock - -Returns: - - None - - """ - pass - - - def GetExtendedControl(self,) -> 'None': - """ - Description of GetExtendedControl. - -Args: - - - -Returns: - - None - - """ - pass - - - def TransformCoords(self,PtlHimetric:'typing.Tuple[typing.Any, typing.Any]',pPtfContainer:'typing.Tuple[float, float]',dwFlags:'typing.Any') -> 'None': - """ - Description of TransformCoords. - -Args: - - PtlHimetric(typing.Tuple[typing.Any, typing.Any]):Description for pPtlHimetric - pPtfContainer(typing.Tuple[float, float]):Description for pPtfContainer - dwFlags(typing.Any):Description for dwFlagsReturn ValueThe result is a tuple of the transformed input points - ie, a tuple of ((int, int), (float, float)) - -Returns: - - None:Description for dwFlagsReturn ValueThe result is a tuple of the transformed input points - ie, - -a tuple of ((int, int), (float, float)) - - - """ - pass - - - def TranslateAccelerator(self,pMsg:'PyMSG',grfModifiers:'typing.Any') -> 'None': - """ - Description of TranslateAccelerator. - -Args: - - pMsg(PyMSG):Description for pMsg - grfModifiers(typing.Any):Description for grfModifiers - -Returns: - - None - - """ - pass - - - def OnFocus(self,fGotFocus:'typing.Any') -> 'None': - """ - Description of OnFocus. - -Args: - - fGotFocus(typing.Any):Description for fGotFocus - -Returns: - - None - - """ - pass - - - def ShowPropertyFrame(self,) -> 'None': - """ - Description of ShowPropertyFrame. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIOleInPlaceActiveObject(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def TranslateAccelerator(self,lpmsg:'PyMSG') -> 'None': - """ - Description of TranslateAccelerator. - -Args: - - lpmsg(PyMSG):Description for lpmsg - -Returns: - - None - - """ - pass - - - def OnFrameWindowActivate(self,fActivate:'typing.Any') -> 'None': - """ - Description of OnFrameWindowActivate. - -Args: - - fActivate(typing.Any):Description for fActivate - -Returns: - - None - - """ - pass - - - def OnDocWindowActivate(self,fActivate:'typing.Any') -> 'None': - """ - Description of OnDocWindowActivate. - -Args: - - fActivate(typing.Any):Description for fActivate - -Returns: - - None - - """ - pass - - - def ResizeBorder(self,rcBorder:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',pUIWindow:'PyIOleInPlaceUIWindow',fFrameWindow:'typing.Any') -> 'None': - """ - Description of ResizeBorder. - -Args: - - rcBorder(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Description for prcBorder - pUIWindow(PyIOleInPlaceUIWindow):Description for pUIWindow - fFrameWindow(typing.Any):Description for fFrameWindow - -Returns: - - None - - """ - pass - - - def EnableModeless(self,fEnable:'typing.Any') -> 'None': - """ - Description of EnableModeless. - -Args: - - fEnable(typing.Any):Description for fEnable - -Returns: - - None - - """ - pass - - -class PyIOleInPlaceFrame(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def InsertMenus(self,hmenuShared:'typing.Union[typing.Any]',menuWidths:'PyOLEMENUGROUPWIDTHS') -> 'None': - """ - Description of InsertMenus. - -Args: - - hmenuShared(typing.Union[typing.Any]):Description for hmenuShared - menuWidths(PyOLEMENUGROUPWIDTHS): - -Returns: - - None - - """ - pass - - - def SetMenu(self,hmenuShared:'typing.Union[typing.Any]',holemenu:'typing.Union[typing.Any]',hwndActiveObject:'typing.Union[typing.Any]') -> 'None': - """ - Description of SetMenu. - -Args: - - hmenuShared(typing.Union[typing.Any]):Description for hmenuShared - holemenu(typing.Union[typing.Any]):Description for holemenu - hwndActiveObject(typing.Union[typing.Any]):Description for hwndActiveObject - -Returns: - - None - - """ - pass - - - def RemoveMenus(self,hmenuShared:'typing.Union[typing.Any]') -> 'None': - """ - Description of RemoveMenus. - -Args: - - hmenuShared(typing.Union[typing.Any]):Description for hmenuShared - -Returns: - - None - - """ - pass - - - def SetStatusText(self,pszStatusText:'typing.Any') -> 'None': - """ - Description of SetStatusText. - -Args: - - pszStatusText(typing.Any):Description for pszStatusText - -Returns: - - None - - """ - pass - - - def EnableModeless(self,fEnable:'typing.Any') -> 'None': - """ - Description of EnableModeless. - -Args: - - fEnable(typing.Any):Description for fEnable - -Returns: - - None - - """ - pass - - - def TranslateAccelerator(self,lpmsg:'PyMSG',wID:'typing.Any') -> 'None': - """ - Description of TranslateAccelerator. - -Args: - - lpmsg(PyMSG):Description for lpmsg - wID(typing.Any):Description for wID - -Returns: - - None - - """ - pass - - -class PyIOleInPlaceObject(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def InPlaceDeactivate(self,) -> 'None': - """ - Description of InPlaceDeactivate. - -Args: - - - -Returns: - - None - - """ - pass - - - def UIDeactivate(self,) -> 'None': - """ - Description of UIDeactivate. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetObjectRects(self,) -> 'None': - """ - Description of SetObjectRects. - -Args: - - - -Returns: - - None - - """ - pass - - - def ReactivateAndUndo(self,) -> 'None': - """ - Description of ReactivateAndUndo. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIOleInPlaceSite(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CanInPlaceActivate(self,) -> 'None': - """ - Description of CanInPlaceActivate. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnInPlaceActivate(self,) -> 'None': - """ - Description of OnInPlaceActivate. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnUIActivate(self,) -> 'None': - """ - Description of OnUIActivate. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetWindowContext(self,) -> 'None': - """ - Description of GetWindowContext. - -Args: - - - -Returns: - - None - - """ - pass - - - def Scroll(self,) -> 'None': - """ - Description of Scroll. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnUIDeactivate(self,fUndoable:'typing.Any') -> 'None': - """ - Description of OnUIDeactivate. - -Args: - - fUndoable(typing.Any):Description for fUndoable - -Returns: - - None - - """ - pass - - - def OnInPlaceDeactivate(self,) -> 'None': - """ - Description of OnInPlaceDeactivate. - -Args: - - - -Returns: - - None - - """ - pass - - - def DiscardUndoState(self,) -> 'None': - """ - Description of DiscardUndoState. - -Args: - - - -Returns: - - None - - """ - pass - - - def DeactivateAndUndo(self,) -> 'None': - """ - Description of DeactivateAndUndo. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnPosRectChange(self,) -> 'None': - """ - Description of OnPosRectChange. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIOleInPlaceSiteEx(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OnInPlaceActivateEx(self,dwFlags:'typing.Any') -> 'None': - """ - Description of OnInPlaceActivateEx. - -Args: - - dwFlags(typing.Any):Description for dwFlags - -Returns: - - None - - """ - pass - - - def OnInPlaceDeactivateEx(self,fNoRedraw:'typing.Any') -> 'None': - """ - Description of OnInPlaceDeactivateEx. - -Args: - - fNoRedraw(typing.Any):Description for fNoRedraw - -Returns: - - None - - """ - pass - - - def RequestUIActivate(self,) -> 'None': - """ - Description of RequestUIActivate. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIOleInPlaceSiteWindowless(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CanWindowlessActivate(self,) -> 'None': - """ - Description of CanWindowlessActivate. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCapture(self,) -> 'None': - """ - Description of GetCapture. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetCapture(self,fCapture:'typing.Any') -> 'None': - """ - Description of SetCapture. - -Args: - - fCapture(typing.Any):Description for fCapture - -Returns: - - None - - """ - pass - - - def GetFocus(self,) -> 'None': - """ - Description of GetFocus. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetFocus(self,fFocus:'typing.Any') -> 'None': - """ - Description of SetFocus. - -Args: - - fFocus(typing.Any):Description for fFocus - -Returns: - - None - - """ - pass - - - def GetDC(self,grfFlags:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]') -> 'None': - """ - Description of GetDC. - -Args: - - grfFlags(typing.Any):Description for grfFlags - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]): - -Returns: - - None - - """ - pass - - - def ReleaseDC(self,hDC:'typing.Any') -> 'None': - """ - Description of ReleaseDC. - -Args: - - hDC(typing.Any):Description for hDC - -Returns: - - None - - """ - pass - - - def InvalidateRect(self,rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',fErase:'typing.Any') -> 'None': - """ - Description of InvalidateRect. - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]): - fErase(typing.Any):Description for fErase - -Returns: - - None - - """ - pass - - - def InvalidateRgn(self,hRgn:'typing.Any',fErase:'typing.Any') -> 'None': - """ - Description of InvalidateRgn. - -Args: - - hRgn(typing.Any):Handle to a region - fErase(typing.Any):Description for fErase - -Returns: - - None - - """ - pass - - - def ScrollRect(self,dx:'typing.Any',dy:'typing.Any') -> 'None': - """ - Description of ScrollRect. - -Args: - - dx(typing.Any):Description for dx - dy(typing.Any):Description for dy - -Returns: - - None - - """ - pass - - - def AdjustRect(self,) -> 'None': - """ - Description of AdjustRect. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnDefWindowMessage(self,msg:'typing.Any',wParam:'typing.Any',lParam:'typing.Any') -> 'None': - """ - Description of OnDefWindowMessage. - -Args: - - msg(typing.Any):Description for msg - wParam(typing.Any):Description for wParam - lParam(typing.Any):Description for lParam - -Returns: - - None - - """ - pass - - -class PyIOleInPlaceUIWindow(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetBorder(self,) -> 'None': - """ - Description of GetBorder. - -Args: - - - -Returns: - - None - - """ - pass - - - def RequestBorderSpace(self,borderwidths:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]') -> 'None': - """ - Description of RequestBorderSpace. - -Args: - - borderwidths(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Description for pborderwidths - -Returns: - - None - - """ - pass - - - def SetBorderSpace(self,borderwidths:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]') -> 'None': - """ - Description of SetBorderSpace. - -Args: - - borderwidths(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Description for pborderwidths - -Returns: - - None - - """ - pass - - - def SetActiveObject(self,pActiveObject:'PyIOleInPlaceActiveObject',pszObjName:'typing.Any') -> 'None': - """ - Description of SetActiveObject. - -Args: - - pActiveObject(PyIOleInPlaceActiveObject):Description for pActiveObject - pszObjName(typing.Any):Description for pszObjName - -Returns: - - None - - """ - pass - - -class PyIOleObject(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetClientSite(self,pClientSite:'PyIOleClientSite') -> 'None': - """ - Description of SetClientSite. - -Args: - - pClientSite(PyIOleClientSite):Description for pClientSite - -Returns: - - None - - """ - pass - - - def GetClientSite(self,) -> 'None': - """ - Description of GetClientSite. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetHostNames(self,szContainerApp:'typing.Any',szContainerObj:'typing.Any') -> 'None': - """ - Description of SetHostNames. - -Args: - - szContainerApp(typing.Any):Description for szContainerApp - szContainerObj(typing.Any):Description for szContainerObj - -Returns: - - None - - """ - pass - - - def Close(self,dwSaveOption:'typing.Any') -> 'None': - """ - Description of Close. - -Args: - - dwSaveOption(typing.Any):Description for dwSaveOption - -Returns: - - None - - """ - pass - - - def SetMoniker(self,dwWhichMoniker:'typing.Any',pmk:'PyIMoniker') -> 'None': - """ - Description of SetMoniker. - -Args: - - dwWhichMoniker(typing.Any):Description for dwWhichMoniker - pmk(PyIMoniker):Description for pmk - -Returns: - - None - - """ - pass - - - def GetMoniker(self,dwAssign:'typing.Any',dwWhichMoniker:'typing.Any') -> 'None': - """ - Description of GetMoniker. - -Args: - - dwAssign(typing.Any):Description for dwAssign - dwWhichMoniker(typing.Any):Description for dwWhichMoniker - -Returns: - - None - - """ - pass - - - def InitFromData(self,pDataObject:'PyIDataObject',fCreation:'typing.Any',dwReserved:'typing.Any') -> 'None': - """ - Description of InitFromData. - -Args: - - pDataObject(PyIDataObject):Description for pDataObject - fCreation(typing.Any):Description for fCreation - dwReserved(typing.Any):Description for dwReserved - -Returns: - - None - - """ - pass - - - def GetClipboardData(self,dwReserved:'typing.Any') -> 'None': - """ - Description of GetClipboardData. - -Args: - - dwReserved(typing.Any):Description for dwReserved - -Returns: - - None - - """ - pass - - - def DoVerb(self,iVerb:'typing.Any',msg:'PyMSG',pActiveSite:'PyIOleClientSite',lindex:'typing.Any',hwndParent:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]') -> 'None': - """ - Description of DoVerb. - -Args: - - iVerb(typing.Any):Description for iVerb - msg(PyMSG):MSG tuple, a-la win32gui etc. - pActiveSite(PyIOleClientSite):Description for pActiveSite - lindex(typing.Any):Description for lindex - hwndParent(typing.Any):Description for hwndParent - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]): - -Returns: - - None - - """ - pass - - - def EnumVerbs(self,) -> 'None': - """ - Description of EnumVerbs. - -Args: - - - -Returns: - - None - - """ - pass - - - def Update(self,) -> 'None': - """ - Description of Update. - -Args: - - - -Returns: - - None - - """ - pass - - - def IsUpToDate(self,) -> 'None': - """ - Description of IsUpToDate. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetUserClassID(self,) -> 'None': - """ - Description of GetUserClassID. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetUserType(self,dwFormOfType:'typing.Any') -> 'None': - """ - Description of GetUserType. - -Args: - - dwFormOfType(typing.Any):Description for dwFormOfType - -Returns: - - None - - """ - pass - - - def SetExtent(self,dwDrawAspect:'typing.Any',size:'typing.Tuple[typing.Any, typing.Any]') -> 'None': - """ - Description of SetExtent. - -Args: - - dwDrawAspect(typing.Any):Description for dwDrawAspect - size(typing.Tuple[typing.Any, typing.Any]):Size limit for the object. - -Returns: - - None - - """ - pass - - - def GetExtent(self,dwDrawAspect:'typing.Any',size:'typing.Tuple[typing.Any, typing.Any]') -> 'None': - """ - Description of GetExtent. - -Args: - - dwDrawAspect(typing.Any):Description for dwDrawAspect - size(typing.Tuple[typing.Any, typing.Any]):Size limit for the object. - -Returns: - - None - - """ - pass - - - def Advise(self,pAdvSink:'typing.Any') -> 'None': - """ - Description of Advise. - -Args: - - pAdvSink(typing.Any):Description for pAdvSink - -Returns: - - None - - """ - pass - - - def Unadvise(self,dwConnection:'typing.Any') -> 'None': - """ - Description of Unadvise. - -Args: - - dwConnection(typing.Any):Description for dwConnection - -Returns: - - None - - """ - pass - - - def EnumAdvise(self,) -> 'None': - """ - Description of EnumAdvise. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetMiscStatus(self,dwAspect:'typing.Any') -> 'None': - """ - Description of GetMiscStatus. - -Args: - - dwAspect(typing.Any):Description for dwAspect - -Returns: - - None - - """ - pass - - - def SetColorScheme(self,) -> 'None': - """ - Description of SetColorScheme. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIOleWindow(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetWindow(self,) -> 'None': - """ - Description of GetWindow. - -Args: - - - -Returns: - - None - - """ - pass - - - def ContextSensitiveHelp(self,fEnterMode:'typing.Any') -> 'None': - """ - Description of ContextSensitiveHelp. - -Args: - - fEnterMode(typing.Any):Description for fEnterMode - -Returns: - - None - - """ - pass - - -class PyIPersist(object): - """A Python interface to IPersist""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetClassID(self,) -> 'PyIID': - """ - Returns the class identifier (CLSID) for the component object. - -Args: - - - -Returns: - - PyIID - - """ - pass - - -class PyIPersistFile(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def IsDirty(self,) -> 'None': - """ - Checks an object for changes since it was last saved to its current file. - -Args: - - - -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. - -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 - - - def Load(self,FileName:'typing.Any',Mode:'typing.Any') -> 'None': - """ - Opens the specified file and initializes an object from the file contents. - -Args: - - FileName(typing.Any):Absolute path of the file to open - Mode(typing.Any):Specifies the access mode from the STGM enumeration. - -Returns: - - None - - """ - pass - - - def Save(self,FileName:'typing.Any',fRemember:'typing.Any') -> 'None': - """ - Saves the object into the specified file. - -Args: - - FileName(typing.Any):absolute path of the file where the object is saved. - fRemember(typing.Any):Specifies whether the file is to be the current working file or not. - -Returns: - - None - - """ - pass - - - def SaveCompleted(self,FileName:'typing.Any') -> 'None': - """ - Notifies the object that it can revert from NoScribble mode to Normal mode. - -Args: - - FileName(typing.Any):Absolute path of the file where the object was saved. - -Returns: - - None - - """ - pass - - - def GetCurFile(self,) -> 'typing.Any': - """ - Gets the current name of the file associated with the object. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyIPersistFolder(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,pidl:'PyIDL') -> 'None': - """ - Description of Initialize. - -Args: - - pidl(PyIDL):Description for pidl - -Returns: - - None - - """ - pass - - -class PyIPersistFolder2(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetCurFolder(self,) -> 'None': - """ - Description of GetCurFolder. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIPersistPropertyBag(object): - """A Python wrapper for a COM IPersistPropertyBag interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def InitNew(self,) -> 'None': - """ - Called by the container when the control is initialized to initialize the - -property bag. - -Args: - - - -Returns: - - None - - """ - pass - - - def Load(self,bag:'PyIPropertyBag',log:'PyIErrorLog'=None) -> 'None': - """ - Called by the container to load the control's properties. - -Args: - - bag(PyIPropertyBag):the caller's property bag. - log(PyIErrorLog):the caller's error log, or None - -Returns: - - None - - """ - pass - - - def Save(self,bag:'PyIPropertyBag',clearDirty:'typing.Any',saveProperties:'typing.Any') -> 'None': - """ - Called by the container to save the object's properties. - -Args: - - bag(PyIPropertyBag):the caller's property bag. - clearDirty(typing.Any):Specifies whether to clear the dirty flag. - saveProperties(typing.Any):Specifies whether to save all properties or just those that have changed - -Returns: - - None - - """ - pass - - -class PyIPersistSerializedPropStorage(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetFlags(self,flags:'typing.Any') -> 'None': - """ - Sets flags for the store - -Args: - - flags(typing.Any):Combination of pscon.FPSPS_* values - -Returns: - - None - - """ - pass - - - def SetPropertyStorage(self,ps:'typing.Any') -> 'None': - """ - Initializes the store with a serialized buffer - -Args: - - ps(typing.Any):Bytes or buffer object containing a serialized property store - -Returns: - - None - - """ - pass - - - def GetPropertyStorage(self,) -> 'typing.Any': - """ - Retrieves the current contents of the property - -store - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyIPersistStorage(object): - """A Python wrapper of a COM IPersistStorage interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def IsDirty(self,) -> 'typing.Any': - """ - Checks the object for changes since it was last saved. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def InitNew(self,PyIStorage:'PyIStorage') -> 'None': - """ - Initializes a new object, providing a storage object to be used for the object. - -Args: - - PyIStorage(PyIStorage):PyIStorage for the new storage object to be initialized. The container creates a nested storage object in its storage object (see PyIStorage::CreateStorage). Then, the container calls the PyIPersistStorage::WriteClassStg function to initialize the new storage object with the object class identifier (CLSID). - -Returns: - - None - - """ - pass - - - def Load(self,storage:'PyIStorage') -> 'None': - """ - Loads an object from its existing storage. - -Args: - - storage(PyIStorage):Existing storage for the object. - -Returns: - - None - - """ - pass - - - def Save(self,PyIStorage:'PyIStorage',_int:'typing.Any') -> 'None': - """ - None - -Args: - - PyIStorage(PyIStorage):Storage for the object - _int(typing.Any):Indicates whether the specified storage object is the current one. This parameter is set to FALSE when performing a Save As or Save A Copy To operation or when performing a full save. In the latter case, this method saves to a temporary file, deletes the original file, and renames the temporary file. This parameter is set to TRUE to perform a full save in a low-memory situation or to perform a fast incremental save in which only the dirty components are saved. - -Returns: - - None - - """ - pass - - - def SaveCompleted(self,PyIStorage:'PyIStorage') -> 'None': - """ - None - -Args: - - PyIStorage(PyIStorage):The current storage object - -Returns: - - None - - """ - pass - - - def HandsOffStorage(self,) -> 'None': - """ - 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 - -operation that works is a close operation. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIPersistStream(object): - """A Python interface to IPersistStream""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def IsDirty(self,) -> 'typing.Any': - """ - Checks the object for changes since it was last saved. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def Load(self,stream:'PyIStream') -> 'None': - """ - Initializes an object from the stream where it was previously saved. - -Args: - - stream(PyIStream):Stream object to load from.CommentsThis method loads an object from its associated stream. The seek pointer is set as it was in the most recent PyIPersistStream::Save method. This method can seek and read from the stream, but cannot write to it.On exit, the seek pointer must be in the same position it was in on entry, immediately past the end of the data. - -Returns: - - None - - """ - pass - - - def Save(self,stream:'PyIStream',bClearDirty:'typing.Any') -> 'None': - """ - Saves an object to the specified stream. - -Args: - - stream(PyIStream):The stream to save to. - bClearDirty(typing.Any):Indicates whether to clear the dirty flag after the save is complete - -Returns: - - None - - """ - pass - - - def GetSizeMax(self,) -> 'ULARGE_INTEGER': - """ - Returns the size in bytes of the stream needed to save the - -object. - -Args: - - - -Returns: - - ULARGE_INTEGER - - """ - pass - - -class PyIPersistStreamInit(object): - """A Python interface to IPersistStreamInit""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def InitNew(self,) -> 'None': - """ - Initializes the object to a default state. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIProcessDebugManager(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateApplication(self,) -> 'None': - """ - Description of CreateApplication. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDefaultApplication(self,) -> 'None': - """ - Description of GetDefaultApplication. - -Args: - - - -Returns: - - None - - """ - pass - - - def AddApplication(self,pda:'PyIDebugApplication') -> 'None': - """ - Description of AddApplication. - -Args: - - pda(PyIDebugApplication):Description for pda - -Returns: - - None - - """ - pass - - - def RemoveApplication(self,dwAppCookie:'typing.Any') -> 'None': - """ - Description of RemoveApplication. - -Args: - - dwAppCookie(typing.Any):Description for dwAppCookie - -Returns: - - None - - """ - pass - - - def CreateDebugDocumentHelper(self,unkOuter:'typing.Any') -> 'None': - """ - Description of CreateDebugDocumentHelper. - -Args: - - unkOuter(typing.Any):The outer object for aggregation, or (usually!) None - -Returns: - - None - - """ - pass - - -class PyIProfAdmin(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetLastError(self,hr:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - Returns the last error code for the object. - -Args: - - hr(typing.Any):Contains the error code generated in the previous method call. - flags(typing.Any):Indicates for format for the output. - -Returns: - - typing.Any - - """ - pass - - - def CreateProfile(self,oldProfileName:'str',Password:'str',uiParam:'typing.Any'=0,flags:'typing.Any'=0) -> 'None': - """ - Creates a new profile. - -Args: - - oldProfileName(str):The name of the new profile. - Password(str):Must be None - uiParam(typing.Any):A handle of the parent window for any dialog boxes or windows that this method displays. - flags(typing.Any): - -Returns: - - None - - """ - pass - - - def DeleteProfile(self,oldProfileName:'str',flags:'typing.Any'=0) -> 'None': - """ - Deletes a profile. - -Args: - - oldProfileName(str):The name of the profile to be deleted. - flags(typing.Any): - -Returns: - - None - - """ - pass - - - def CopyProfile(self,oldProfileName:'str',Password:'str',newProfileName:'str',uiParam:'typing.Any'=0,flags:'typing.Any'=0) -> 'None': - """ - Copies a profile. - -Args: - - oldProfileName(str):The name of the profile to copy. - Password(str):Must be None - newProfileName(str):The new name of the copied profile. - uiParam(typing.Any):A handle of the parent window for any dialog boxes or windows that this method displays. - flags(typing.Any): - -Returns: - - None - - """ - pass - - - def RenameProfile(self,oldProfileName:'str',Password:'str',newProfileName:'str',uiParam:'typing.Any'=0,flags:'typing.Any'=0) -> 'None': - """ - Assigns a new name to a profile. - -Args: - - oldProfileName(str):The current name of the profile to rename. - Password(str):Must be None - newProfileName(str):The new name of the profile to rename. - uiParam(typing.Any):A handle of the parent window for any dialog boxes or windows that this method displays. - flags(typing.Any): - -Returns: - - None - - """ - pass - - - def SetDefaultProfile(self,profileName:'str',flags:'typing.Any'=0) -> 'None': - """ - Sets or clears a client's default profile. - -Args: - - profileName(str):The name of the profile that will become the default, or None. Setting profileName to None indicates that SetDefaultProfile should remove the existing default profile, leaving the client without a default. - flags(typing.Any): - -Returns: - - None - - """ - pass - - - def AdminServices(self,profileName:'str',Password:'str'=None,uiParam:'typing.Any'=0,flags:'typing.Any'=0) -> 'PyIProfAdmin': - """ - Provides access to a message service administration object for making changes to the message services in a profile. - -Args: - - profileName(str):The name of the profile to be modified. - Password(str): - uiParam(typing.Any):A handle of the parent window for any dialog boxes or windows that this method displays. - flags(typing.Any): - -Returns: - - PyIProfAdmin - - """ - pass - - -class PyIPropertyBag(object): - """A Python wrapper for a COM IPropertyBag interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - 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 - -container. - -Args: - - propName(typing.Any):Name of the property to read. - propType(typing.Any):The type of the object to read. Must be a VT_* Variant Type constant. - errorLog(PyIErrorLog):The caller's PyIErrorLog object in which the property bag stores any errors that occur during reads. Can be None in which case the caller is not interested in errors.CommentsThe result is a Python object, mapped from a COM VARIANT of type as specified in the propType parameter. - -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 - -container. - -Args: - - propName(typing.Any):Name of the property to read. - value(typing.Any):The value for the property. The value must be able to be converted to a COM VARIANT. - -Returns: - - None - - """ - pass - - -class PyIPropertyChange(object): - """Interface used to specify a change to a property""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ApplyToPropVariant(self,OrigVal:'PyPROPVARIANT') -> 'PyPROPVARIANT': - """ - Applies the change to a variant value - -Args: - - OrigVal(PyPROPVARIANT):The value to be modified - -Returns: - - PyPROPVARIANT - - """ - pass - - -class PyIPropertyChangeArray(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetCount(self,) -> 'typing.Any': - """ - Returns the number of changes in the array - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetAt(self,Index:'typing.Any',riid:'PyIID') -> 'PyIPropertyChange': - """ - Retrieves a change by zero-based index - -Args: - - Index(typing.Any):Index of the change to retrieve - riid(PyIID):The interface to return - -Returns: - - PyIPropertyChange - - """ - pass - - - def InsertAt(self,Index:'typing.Any',PropChange:'PyIPropertyChange') -> 'None': - """ - Inserts a change at a specific position - -Args: - - Index(typing.Any):Position at which to place the change - PropChange(PyIPropertyChange):The change to be added - -Returns: - - None - - """ - pass - - - def Append(self,PropChange:'PyIPropertyChange') -> 'None': - """ - Adds a change to the end of the array - -Args: - - PropChange(PyIPropertyChange):The change to be added - -Returns: - - None - - """ - pass - - - def AppendOrReplace(self,PropChange:'PyIPropertyChange') -> 'None': - """ - Adds a change, or replaces if an identical property key is already - -in container - -Args: - - PropChange(PyIPropertyChange):The change to be added or replaced - -Returns: - - None - - """ - pass - - - def RemoveAt(self,Index:'typing.Any') -> 'None': - """ - Removes a change from the array - -Args: - - Index(typing.Any):Index of change to be removed - -Returns: - - None - - """ - pass - - - def IsKeyInArray(self,key:'PyPROPERTYKEY') -> 'typing.Any': - """ - Checks if array contains a change to a property - -Args: - - key(PyPROPERTYKEY):Property key to look for - -Returns: - - typing.Any - - """ - pass - - -class PyIPropertyDescription(object): - """Gives access to the details of a property definition""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPropertyKey(self,) -> 'PyPROPERTYKEY': - """ - Returns the unique identifier for a property - -Args: - - - -Returns: - - PyPROPERTYKEY - - """ - pass - - - def GetCanonicalName(self,) -> 'typing.Any': - """ - Returns the name of the property - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetPropertyType(self,) -> 'typing.Any': - """ - Returns the variant type of the property (VT_*) - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetDisplayName(self,) -> 'typing.Any': - """ - Returns the property name as shown in the UI - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetEditInvitation(self,) -> 'typing.Any': - """ - Returns the input prompt used in edit controls - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetTypeFlags(self,mask:'typing.Any') -> 'typing.Any': - """ - Returns type flags for the property - -Args: - - mask(typing.Any):Specifies which flags to retrieve (PDTF_*) - -Returns: - - typing.Any - - """ - pass - - - def GetViewFlags(self,) -> 'typing.Any': - """ - Returns the view flags that control how the property is displayed - -(PDVF_*) - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetDefaultColumnWidth(self,) -> 'typing.Any': - """ - Returns the default width in characters - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetDisplayType(self,) -> 'typing.Any': - """ - Returns the display type (PDDT_*) - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetColumnState(self,) -> 'typing.Any': - """ - Returns flags that control how property is displayed in column - -(SHCOLSTATE_*) - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetGroupingRange(self,) -> 'typing.Any': - """ - Returns property's grouping attributes (PDGR_*) - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetRelativeDescriptionType(self,) -> 'typing.Any': - """ - Returns the relative description type (PDRDT_*) - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetRelativeDescription(self,var1:'PyPROPVARIANT',var2:'PyPROPVARIANT') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Compares two values - -Args: - - var1(PyPROPVARIANT):The first value - var2(PyPROPVARIANT):The second value - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def GetSortDescription(self,) -> 'typing.Any': - """ - Returns value that determines how sorting options are - -displayed (PDSD_*) - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetSortDescriptionLabel(self,Descending:'typing.Any') -> 'typing.Any': - """ - Returns description of current sort order - -Args: - - Descending(typing.Any):Indicates if order is reversed - -Returns: - - typing.Any - - """ - pass - - - def GetAggregationType(self,) -> 'typing.Any': - """ - Describes how properties for multiple items are displayed - -(PDAT_*) - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetConditionType(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Returns options that determine how the property is used - -to build a search query - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any]:PyIPropertyDescription.GetConditionType - -(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 - -valid property range - -Args: - - riid(PyIID):IID of the requested interface - -Returns: - - PyIPropertyEnumTypeList - - """ - pass - - - def CoerceToCanonicalValue(self,Value:'PyPROPVARIANT') -> 'typing.Any': - """ - Converts a variant value to the exact type expected by - -the property - -Args: - - Value(PyPROPVARIANT):The property value to be convertedCommentsThis method mutates the PyPROPVARIANT in place. It may be cleared on failure.Return ValueReturns the HRESULT from the operation on success. - -Returns: - - typing.Any:The property value to be convertedComments - -This method mutates the PyPROPVARIANT in place. It may be cleared on failure. -Return ValueReturns the HRESULT from the operation on success. - - - """ - pass - - - def FormatForDisplay(self,Value:'PyPROPVARIANT',Flags:'typing.Any') -> 'typing.Any': - """ - Converts a value to its string representation - -Args: - - Value(PyPROPVARIANT):The value to be formatted - Flags(typing.Any):Combination of PROPDESC_FORMAT_FLAGS (PDFF_*) - -Returns: - - typing.Any - - """ - pass - - - def IsValueCanonical(self,Value:'typing.Any') -> 'typing.Any': - """ - Determines if a value exactly matches the specification for - -the property - -Args: - - Value(typing.Any):The value to check - -Returns: - - typing.Any - - """ - pass - - -class PyIPropertyDescriptionAliasInfo(object): - """Interface that gives access to the sorting columns for a property""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetSortByAlias(self,riid:'PyIID') -> 'PyIPropertyDescription': - """ - Returns the primary column used - -for sorting - -Args: - - riid(PyIID):The interface to return - -Returns: - - PyIPropertyDescription - - """ - pass - - - def GetAdditionalSortByAliases(self,riid:'PyIID') -> 'PyIPropertyDescriptionList': - """ - Returns secondary - -sorting columns - -Args: - - riid(PyIID):The interface to return - -Returns: - - PyIPropertyDescriptionList - - """ - pass - - -class PyIPropertyDescriptionList(object): - """Container for a number of property descriptions""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetCount(self,) -> 'typing.Any': - """ - Gets the number of properties in the list - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetAt(self,Elem:'typing.Any',riid:'PyIID') -> 'PyIPropertyDescription': - """ - Retrieves a description from the list - -Args: - - Elem(typing.Any):Index of the element to return - riid(PyIID):The interface to return - -Returns: - - PyIPropertyDescription - - """ - pass - - -class PyIPropertyDescriptionSearchInfo(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetSearchInfoFlags(self,) -> 'typing.Any': - """ - Returns flags controlling how property is indexed - -Args: - - - -Returns: - - typing.Any:PyIPropertyDescriptionSearchInfo.GetSearchInfoFlags - -int = GetSearchInfoFlags()Returns flags controlling how property is indexed -Return ValueReturns a combination of PROPDESC_SEARCHINFO_FLAGS values - - - """ - pass - - - def GetColumnIndexType(self,) -> 'typing.Any': - """ - Returns flags indicating type of property - -Args: - - - -Returns: - - typing.Any:PyIPropertyDescriptionSearchInfo.GetColumnIndexType - -int = GetColumnIndexType()Returns flags indicating type of property -Return ValueReturns a value from the PROPDESC_COLUMNINDEX_TYPE enum - - - """ - pass - - - def GetProjectionString(self,) -> 'typing.Any': - """ - Returns the canonical name of the property - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetMaxSize(self,) -> 'typing.Any': - """ - Returns the maximum size specified in search options - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyIPropertyEnumType(object): - """Contains information about an allowable value or range for a property""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetEnumType(self,) -> 'typing.Any': - """ - Retrieves the type (PROPENUMTYPE) - -Args: - - - -Returns: - - typing.Any:PyIPropertyEnumType.GetEnumType - -int = GetEnumType()Retrieves the type (PROPENUMTYPE) -Return Valuepscon.PET_* - - - """ - pass - - - def GetValue(self,) -> 'PyPROPVARIANT': - """ - Retrieves the defined value - -Args: - - - -Returns: - - PyPROPVARIANT - - """ - pass - - - def GetRangeMinValue(self,) -> 'PyPROPVARIANT': - """ - Returns the minimum allowed value for the property - -Args: - - - -Returns: - - PyPROPVARIANT - - """ - pass - - - def GetRangeSetValue(self,) -> 'PyPROPVARIANT': - """ - Returns a fixed value defined for the property - -Args: - - - -Returns: - - PyPROPVARIANT - - """ - pass - - - def GetDisplayText(self,) -> 'None': - """ - Returns the display text for the enumerated type - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIPropertyEnumTypeList(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetCount(self,) -> 'typing.Any': - """ - Returns the number of objects in the list - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetAt(self,itype:'typing.Any',riid:'PyIID') -> 'PyIPropertyEnumType': - """ - Retrieves an item by index - -Args: - - itype(typing.Any):Zero based index of type to return - riid(PyIID):The interface to return - -Returns: - - PyIPropertyEnumType - - """ - pass - - - def FindMatchingIndex(self,Cmp:'PyPROPVARIANT') -> 'typing.Any': - """ - Attempts to match the specified value to one of the allowable - -values for the property - -Args: - - Cmp(PyPROPVARIANT):A value to match against the defined values of the property - -Returns: - - typing.Any - - """ - pass - - -class PyIPropertySetStorage(object): - """Container for a collection of property sets. - -Can be iterated over to enumerate property sets.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Create(self,fmtid:'PyIID',clsid:'PyIID',Flags:'typing.Any',Mode:'typing.Any') -> 'PyIPropertyStorage': - """ - Creates a new property set in the storage object - -Args: - - fmtid(PyIID):GUID identifying a property set, pythoncom.FMTID_* - clsid(PyIID):CLSID of property set handler, usually same as fmtid - Flags(typing.Any):Specifies behaviour of property set, storagecon.PROPSETFLAG_* - Mode(typing.Any):Access mode, combination of storagecon.STGM_* flags - -Returns: - - PyIPropertyStorage - - """ - pass - - - def Open(self,fmtid:'PyIID',Mode:'typing.Any') -> 'PyIPropertyStorage': - """ - Opens an existing property set - -Args: - - fmtid(PyIID):GUID of a property set, pythoncom.FMTID_* - Mode(typing.Any):Access mode, combination of storagecon.STGM_* flags - -Returns: - - PyIPropertyStorage - - """ - pass - - - def Delete(self,fmtid:'PyIID') -> 'None': - """ - Removes a property set from this storage object - -Args: - - fmtid(PyIID):GUID of a property set, pythoncom.FMTID_* - -Returns: - - None - - """ - pass - - - def Enum(self,) -> 'PyIEnumSTATPROPSETSTG': - """ - Creates an iterator to enumerate contained property - -sets - -Args: - - - -Returns: - - PyIEnumSTATPROPSETSTG - - """ - pass - - -class PyIPropertyStorage(object): - """Structured storage object that contains a set of properties. - -Supports iteration to list properties.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ReadMultiple(self,props:'typing.Tuple[PROPSPEC, ...]') -> 'typing.Tuple[typing.Any, ...]': - """ - Reads specified properties from the current property set. - -Args: - - props(typing.Tuple[PROPSPEC, ...]):Sequence of property IDs or names.Return ValueReturned values are automatically converted to an appropriate python type - -Returns: - - typing.Tuple[typing.Any, ...]:Sequence of property IDs or names.Return ValueReturned values are automatically converted to an appropriate python type - - - """ - pass - - - def WriteMultiple(self,props:'typing.Tuple[PROPSPEC, ...]',values:'typing.Tuple[typing.Any, ...]',propidNameFirst:'typing.Any'=2) -> 'None': - """ - Creates or modifies properties in the property set - -Args: - - props(typing.Tuple[PROPSPEC, ...]):Sequence containing names or integer ids of properties to write - values(typing.Tuple[typing.Any, ...]):The values for the properties. - propidNameFirst(typing.Any):Minimum property id to be assigned to new properties specified by name - -Returns: - - None - - """ - pass - - - def DeleteMultiple(self,props:'typing.Tuple[PROPSPEC, ...]') -> 'None': - """ - Deletes properties from the property set - -Args: - - props(typing.Tuple[PROPSPEC, ...]):Sequence containing names or IDs of properties to be deleted - -Returns: - - None - - """ - pass - - - def ReadPropertyNames(self,props:'typing.Tuple[typing.Any, ...]') -> 'typing.Tuple[typing.Any, ...]': - """ - Retrieves any existing string names for the specified - -property identifiers. - -Args: - - props(typing.Tuple[typing.Any, ...]):Sequence of ints containing property IDs. - -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 - -current property set. - -Args: - - props(typing.Tuple[typing.Any, ...]):Sequence containing the property IDs. - names(typing.Tuple[str, ...]):Equal length sequence of property names. - -Returns: - - None - - """ - pass - - - def DeletePropertyNames(self,props:'typing.Tuple[typing.Any, ...]') -> 'None': - """ - Removes property names from specified properties. - -Args: - - props(typing.Tuple[typing.Any, ...]):Sequence of ints containing property IDs. - -Returns: - - None - - """ - pass - - - def Commit(self,CommitFlags:'typing.Any') -> 'None': - """ - Persists the property set to its base storage - -Args: - - CommitFlags(typing.Any):Combination of storagecon.STGC_* flags - -Returns: - - None - - """ - pass - - - def Revert(self,) -> 'None': - """ - Discards any changes that have been made - -Args: - - - -Returns: - - None - - """ - pass - - - def Enum(self,) -> 'PyIEnumSTATPROPSTG': - """ - Creates an enumerator for properties in the property set - -Args: - - - -Returns: - - PyIEnumSTATPROPSTG - - """ - pass - - - def SetTimes(self,ctime:'PyTime',atime:'PyTime',mtime:'PyTime') -> 'None': - """ - Sets the creation, last access, and modification time - -Args: - - ctime(PyTime):Creation time, or None for no change - atime(PyTime):Last access time, or None for no change - mtime(PyTime):Modification time, or None for no changeCommentsSome property sets do not support these times. - -Returns: - - None - - """ - pass - - - def SetClass(self,clsid:'PyIID') -> 'None': - """ - Sets the GUID for the property set - -Args: - - clsid(PyIID):Description for clsid - -Returns: - - None - - """ - pass - - - def Stat(self,) -> 'typing.Any': - """ - Returns various infomation about the property set - -Args: - - - -Returns: - - typing.Any:PyIPropertyStorage.Stat - -tuple = Stat()Returns various infomation about the property set -Return ValueReturns a tuple representing a STATPROPSETSTG struct. - - - """ - pass - - -class PyIPropertyStore(object): - """Contains a collection of properties""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetCount(self,) -> 'typing.Any': - """ - Returns the number of properties in the store - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetAt(self,iProp:'typing.Any') -> 'PyPROPERTYKEY': - """ - Returns the property key for the specified property - -Args: - - iProp(typing.Any):Zero-based index of property - -Returns: - - PyPROPERTYKEY - - """ - pass - - - def GetValue(self,Key:'PyPROPERTYKEY') -> 'PyPROPVARIANT': - """ - Retrieves the value of a property - -Args: - - Key(PyPROPERTYKEY):Property key as returned by PyIPropertyStore::GetAt - -Returns: - - PyPROPVARIANT - - """ - pass - - - def SetValue(self,Key:'PyPROPERTYKEY',Value:'PyPROPVARIANT') -> 'None': - """ - Sets the value of a property - -Args: - - Key(PyPROPERTYKEY):Property key (see PyIPropertyStore::GetAt) - Value(PyPROPVARIANT):Variant value which can be converted to the appropriate variant type for the property Pass a VT_EMPTY variant to indicate that the property should be removed. - -Returns: - - None - - """ - pass - - - def Commit(self,) -> 'None': - """ - Commits property changes - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIPropertyStoreCache(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetState(self,key:'PyPROPERTYKEY') -> 'typing.Any': - """ - Retrieves the current state of a property - -Args: - - key(PyPROPERTYKEY):Property identifierReturn ValueA value from the PSC_STATE enum (PSC_NORMAL, PSC_NOTINSOURCE. PSC_DIRTY) - -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 - -property - -Args: - - key(PyPROPERTYKEY):Property identifier - -Returns: - - typing.Tuple[PyPROPVARIANT, typing.Any] - - """ - pass - - - def SetState(self,key:'PyPROPERTYKEY',state:'typing.Any') -> 'None': - """ - Sets the state of a property - -Args: - - key(PyPROPERTYKEY):Property identifier - state(typing.Any):Value from the PSC_STATE enum (pscon.PSC_*) - -Returns: - - None - - """ - pass - - - def SetValueAndState(self,key:'PyPROPERTYKEY',value:'PyPROPVARIANT',state:'typing.Any') -> 'None': - """ - Sets the value and state of a property - -Args: - - key(PyPROPERTYKEY):Property identifier - value(PyPROPVARIANT):The new value - state(typing.Any):The new state (pscon.PSC_*) - -Returns: - - None - - """ - pass - - -class PyIPropertyStoreCapabilities(object): - """Property providers use this interface to indicate whether properties are - -writeable.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def IsPropertyWritable(self,key:'PyPROPERTYKEY') -> 'typing.Any': - """ - Asks provider if a property can be editted. - -Args: - - key(PyPROPERTYKEY):Property identifier - -Returns: - - typing.Any - - """ - pass - - -class PyIPropertySystem(object): - """Wraps the IPropertySystem interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPropertyDescription(self,Key:'PyPROPERTYKEY',riid:'PyIID') -> 'PyIPropertyDescription': - """ - Returns an interface used to describe a - -property - -Args: - - Key(PyPROPERTYKEY):Fmtid and propertyid that uniquely identifies a property - riid(PyIID):The interface to return - -Returns: - - PyIPropertyDescription - - """ - pass - - - def GetPropertyDescriptionByName(self,CanonicalName:'typing.Any',riid:'PyIID') -> 'PyIPropertyDescription': - """ - Returns an interface used to - -describe a property - -Args: - - CanonicalName(typing.Any):Registered name of the property - riid(PyIID):The interface to return - -Returns: - - PyIPropertyDescription - - """ - pass - - - def GetPropertyDescriptionListFromString(self,PropList:'typing.Any',riid:'PyIID') -> 'PyIPropertyDescriptionList': - """ - Retrieves property - -descriptions from a string of property names - -Args: - - PropList(typing.Any):String containing a list of properties and flags - riid(PyIID):The interface to return - -Returns: - - PyIPropertyDescriptionList - - """ - pass - - - def EnumeratePropertyDescriptions(self,Filter:'typing.Any',riid:'PyIID') -> 'PyIPropertyDescriptionList': - """ - Returns an interface used to - -list defined properties - -Args: - - Filter(typing.Any):Value from PROPDESC_ENUMFILTER (pscon.PDEF_*) that limits what types of properties are listed - riid(PyIID):The interface to return - -Returns: - - PyIPropertyDescriptionList - - """ - pass - - - def FormatForDisplay(self,Key:'PyPROPERTYKEY',Value:'PyPROPVARIANT',Flags:'typing.Any') -> 'typing.Any': - """ - Formats a property into a string - -Args: - - Key(PyPROPERTYKEY):Fmtid and property id that identifies the property - Value(PyPROPVARIANT):The value to format - Flags(typing.Any):Combination of PROPDESC_FORMAT_FLAGS (pscon.PDFF_*) indicating formatting options - -Returns: - - typing.Any - - """ - pass - - - def RegisterPropertySchema(self,Path:'typing.Any') -> 'None': - """ - Registers a set of properties defined in a .propdesc file - -Args: - - Path(typing.Any):Path to a property schema XML file (.propdesc) - -Returns: - - None - - """ - pass - - - def UnregisterPropertySchema(self,Path:'typing.Any') -> 'None': - """ - Removes a set of registered properties - -Args: - - Path(typing.Any):Path to a property schema XML file (.propdesc) - -Returns: - - None - - """ - pass - - - def RefreshPropertySchema(self,) -> 'None': - """ - Not currently implemented by the OS - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIProvideClassInfo(object): - """A Python interface to IProvideClassInfo""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetClassInfo(self,) -> 'PyITypeInfo': - """ - Gets information about the CO_CLASS. - -Args: - - - -Returns: - - PyITypeInfo - - """ - pass - - -class PyIProvideClassInfo2(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetGUID(self,flags:'typing.Any') -> 'PyIID': - """ - Gets the GUID for the object. - -Args: - - flags(typing.Any):The flags for the GUID. - -Returns: - - PyIID - - """ - pass - - -class PyIProvideExpressionContexts(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def EnumExpressionContexts(self,) -> 'None': - """ - Description of EnumStackFrames. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIProvideTaskPage(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPage(self,tpType:'typing.Any',PersistChanges:'typing.Any') -> 'None': - """ - Return a property sheet page handle for the spedified type - -(TASKPAGE_TASK,TASKPAGE_SCHEDULE,TASKPAGE_SETTINGS) - -Args: - - tpType(typing.Any):Type of page to retreive (TASKPAGE_TASK,TASKPAGE_SCHEDULE,TASKPAGE_SETTINGS) - PersistChanges(typing.Any):Indicates if changes should be saved automaticallyCommentsThere's not yet anything useful that can be done with this handle - return type subject to change - -Returns: - - None - - """ - pass - - -class PyIQueryAssociations(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - 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 - -appropriate ProgID. - -Args: - - flags(typing.Any):One of shellcon.ASSOCF_* flags - assoc(str):The string data (ie, extension, prog-id, etc) - hkeyProgId(PyHKEY):Root registry key, can be None - hwnd(int):Reserved, must be 0 or None - -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 - -registry. - -Args: - - flags(typing.Any):Used to control the search. - assocKey(typing.Any):Specifies the type of key that is to be returned. - arg(str):Optional string with information about the location of the key. It is normally set to a shell verb such as 'open'. Set this parameter to None if it is not used. - -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 - -registry. - -Args: - - flags(typing.Any):Used to control the search. - assocStr(typing.Any):Specifies the type of string that is to be returned. - arg(str):Optional string with information about the location of the key. It is normally set to a shell verb such as 'open'. Set this parameter to None if it is not used.CommentsNote that ASSOCF_NOTRUNCATE semantics are currently not supported - the buffer passed is 2048 bytes long, and will be truncated by the shell if too small. - -Returns: - - typing.Any - - """ - pass - - -class PyIRelatedItem(object): - """Interface used as the base for objects that have a related shell item - -(eg ITransferMediumItem, IDisplayItem, etc). Should not be used directly.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetItemIDList(self,) -> 'PyIDL': - """ - Returns the ID list of the related item - -Args: - - - -Returns: - - PyIDL - - """ - pass - - - def GetItem(self,) -> 'PyIShellItem': - """ - Returns the related item - -Args: - - - -Returns: - - PyIShellItem - - """ - pass - - -class PyIRemoteDebugApplication(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ResumeFromBreakPoint(self,prptFocus:'PyIRemoteDebugApplicationThread',bra:'typing.Any',era:'typing.Any') -> 'None': - """ - Continue an application which is currently in a breakpoint. - -Args: - - prptFocus(PyIRemoteDebugApplicationThread):Description for prptFocus - bra(typing.Any):Break resume action - era(typing.Any):Error resume action - -Returns: - - None - - """ - pass - - - def CauseBreak(self,) -> 'None': - """ - Causes the application to break into the debugger at the earliest - -opportunity. - -Args: - - - -Returns: - - None - - """ - pass - - - def ConnectDebugger(self,pad:'PyIApplicationDebugger') -> 'None': - """ - Connects a debugger to the application. - -Args: - - pad(PyIApplicationDebugger):Description for padCommentsOnly one debugger may be connected at a time; this method fails if there is already a debugger connected. - -Returns: - - None - - """ - pass - - - def DisconnectDebugger(self,) -> 'None': - """ - Disconnects the current debugger from the application. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDebugger(self,) -> 'PyIApplicationDebugger': - """ - Returns the current debugger connected to - -the application. - -Args: - - - -Returns: - - PyIApplicationDebugger - - """ - pass - - - def CreateInstanceAtApplication(self,rclsid:'PyIID',pUnkOuter:'PyIUnknown',dwClsContext:'typing.Any',riid:'PyIID') -> 'PyIUnknown': - """ - Create objects in the application - -process address space. - -Args: - - rclsid(PyIID):Description for rclsid - pUnkOuter(PyIUnknown):Description for pUnkOuter - dwClsContext(typing.Any):Description for dwClsContext - riid(PyIID):Description for riidCommentsProvides a mechanism for the debugger IDE, running out-of-process to the application, to create objects in the application process. This method simply delegates to CoCreateInstance. - -Returns: - - PyIUnknown - - """ - pass - - - def QueryAlive(self,) -> 'None': - """ - Returns True if alive, else False. - -Args: - - - -Returns: - - None - - """ - pass - - - def EnumThreads(self,) -> 'PyIEnumRemoteDebugApplicationThreads': - """ - Enumerates all threads known - -to be associated with the application. - -Args: - - - -Returns: - - PyIEnumRemoteDebugApplicationThreads - - """ - pass - - - def GetName(self,) -> 'None': - """ - Description of GetName. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetRootNode(self,) -> 'PyIDebugApplicationNode': - """ - Returns the application node under which - -all nodes associated with the application are added. - -Args: - - - -Returns: - - PyIDebugApplicationNode - - """ - pass - - - def EnumGlobalExpressionContexts(self,) -> 'typing.Any': - """ - Enumerates all - -global expression contexts - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyIRemoteDebugApplicationEvents(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OnConnectDebugger(self,pad:'PyIApplicationDebugger') -> 'None': - """ - Description of OnConnectDebugger. - -Args: - - pad(PyIApplicationDebugger):Description for pad - -Returns: - - None - - """ - pass - - - def OnDisconnectDebugger(self,) -> 'None': - """ - Description of OnDisconnectDebugger. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnSetName(self,pstrName:'typing.Any') -> 'None': - """ - Description of OnSetName. - -Args: - - pstrName(typing.Any):Description for pstrName - -Returns: - - None - - """ - pass - - - def OnDebugOutput(self,pstr:'typing.Any') -> 'None': - """ - Description of OnDebugOutput. - -Args: - - pstr(typing.Any):Description for pstr - -Returns: - - None - - """ - pass - - - def OnClose(self,) -> 'None': - """ - Description of OnClose. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnEnterBreakPoint(self,prdat:'PyIRemoteDebugApplicationThread') -> 'None': - """ - Description of OnEnterBreakPoint. - -Args: - - prdat(PyIRemoteDebugApplicationThread):Description for prdat - -Returns: - - None - - """ - pass - - - def OnLeaveBreakPoint(self,prdat:'PyIRemoteDebugApplicationThread') -> 'None': - """ - Description of OnLeaveBreakPoint. - -Args: - - prdat(PyIRemoteDebugApplicationThread):Description for prdat - -Returns: - - None - - """ - pass - - - def OnCreateThread(self,prdat:'PyIRemoteDebugApplicationThread') -> 'None': - """ - Description of OnCreateThread. - -Args: - - prdat(PyIRemoteDebugApplicationThread):Description for prdat - -Returns: - - None - - """ - pass - - - def OnDestroyThread(self,prdat:'PyIRemoteDebugApplicationThread') -> 'None': - """ - Description of OnDestroyThread. - -Args: - - prdat(PyIRemoteDebugApplicationThread):Description for prdat - -Returns: - - None - - """ - pass - - - def OnBreakFlagChange(self,abf:'typing.Any',prdatSteppingThread:'PyIRemoteDebugApplicationThread') -> 'None': - """ - Description of OnBreakFlagChange. - -Args: - - abf(typing.Any):Description for abf - prdatSteppingThread(PyIRemoteDebugApplicationThread):Description for prdatSteppingThread - -Returns: - - None - - """ - pass - - -class PyIRemoteDebugApplicationThread(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetSystemThreadId(self,) -> 'None': - """ - Description of GetSystemThreadId. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetApplication(self,) -> 'None': - """ - Description of GetApplication. - -Args: - - - -Returns: - - None - - """ - pass - - - def EnumStackFrames(self,) -> 'None': - """ - Description of EnumStackFrames. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDescription(self,) -> 'None': - """ - Description of GetDescription. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetNextStatement(self,pStackFrame:'PyIDebugStackFrame',pCodeContext:'PyIDebugCodeContext') -> 'None': - """ - Description of SetNextStatement. - -Args: - - pStackFrame(PyIDebugStackFrame):Description for pStackFrame - pCodeContext(PyIDebugCodeContext):Description for pCodeContext - -Returns: - - None - - """ - pass - - - def GetState(self,) -> 'None': - """ - Description of GetState. - -Args: - - - -Returns: - - None - - """ - pass - - - def Suspend(self,) -> 'None': - """ - Description of Suspend. - -Args: - - - -Returns: - - None - - """ - pass - - - def Resume(self,) -> 'None': - """ - Description of Resume. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetSuspendCount(self,) -> 'None': - """ - Description of GetSuspendCount. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIRunningObjectTable(object): - """A Python interface to IRunningObjectTable""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Register(self,) -> 'typing.Any': - """ - Registers an object and its identifying moniker in the Running Object - -Table (ROT). - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def Revoke(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def IsRunning(self,objectName:'PyIMoniker') -> 'typing.Any': - """ - Checks whether an object is running. - -Args: - - objectName(PyIMoniker):The PyIMoniker interface on the moniker to search for in the Running Object Table.Return ValueDescriptionS_OK (ie, 0)The object identified by objectName is running.S_FALSE (ie, 1)There is no entry for objectName in the ROT, or that the object it identifies is no longer running (in which case, the entry is revoked). - -Returns: - - typing.Any - - """ - pass - - - def GetObject(self,objectName:'PyIMoniker') -> 'PyIUnknown': - """ - Checks whether an object is running. - -Args: - - objectName(PyIMoniker):The PyIMoniker interface on the moniker to search for in the Running Object Table. - -Returns: - - PyIUnknown - - """ - pass - - - def EnumRunning(self,) -> 'PyIEnumMoniker': - """ - Creates an enumerator that can list the monikers of - -all the objects currently registered in the Running Object Table (ROT). - -Args: - - - -Returns: - - PyIEnumMoniker - - """ - pass - - -class PyIScheduledWorkItem(object): - """Python object that encapsulates the IScheduledWorkItem interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateTrigger(self,) -> 'typing.Tuple[typing.Any, PyITaskTrigger]': - """ - Creates a new trigger for a task, returns index and - -new ITaskTrigger interface - -Args: - - - -Returns: - - typing.Tuple[typing.Any, PyITaskTrigger] - - """ - pass - - - def DeleteTrigger(self,Trigger:'typing.Any') -> 'None': - """ - Deletes specified trigger - -Args: - - Trigger(typing.Any):Index of trigger to delete - -Returns: - - None - - """ - pass - - - def GetTriggerCount(self,) -> 'typing.Any': - """ - Returns number of triggers defined for the task - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetTrigger(self,iTrigger:'typing.Any') -> 'PyITaskTrigger': - """ - Retrieves ITaskTrigger interface for specified trigger - -index - -Args: - - iTrigger(typing.Any):Index of trigger to retrieve - -Returns: - - PyITaskTrigger - - """ - pass - - - def GetTriggerString(self,) -> 'typing.Any': - """ - Creates a human-readable summary of specified trigger - -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 - -frame - -Args: - - Count(typing.Any):Number of run times to retrieve - Begin(PyTime):Start time, defaults to current time if not passed or None - End(PyTime):End time, defaults to unlimited if not passed or None - -Returns: - - typing.Tuple[PyTime, typing.Any, typing.Any, typing.Any] - - """ - pass - - - def GetNextRunTime(self,) -> 'PyTime': - """ - Returns next time that task is scheduled to run - -Args: - - - -Returns: - - PyTime - - """ - pass - - - def SetIdleWait(self,wIdleMinutes:'typing.Any',wDeadlineMinutes:'typing.Any') -> 'None': - """ - Sets idle parms for task with trigger of type TASK_EVENT_TRIGGER_ON_IDLE - -Args: - - wIdleMinutes(typing.Any):Nbr of minutes computer must be idle before task fires - wDeadlineMinutes(typing.Any):Maximum nbr of minutes task will wait for computer to become idle - -Returns: - - None - - """ - pass - - - def GetIdleWait(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Gets IdleMinutes and DeadlineMinutes parms for task with trigger - -of type TASK_EVENT_TRIGGER_ON_IDLE - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def Run(self,) -> 'None': - """ - Starts task - -Args: - - - -Returns: - - None - - """ - pass - - - def Terminate(self,) -> 'None': - """ - Terminate process if task is running - -Args: - - - -Returns: - - None - - """ - pass - - - def EditWorkItem(self,hParent:'int',dwReserved:'typing.Any') -> 'None': - """ - Brings up standard Scheduled Task dialog - -Args: - - hParent(int):Reserved, use 0 or None if passed - dwReserved(typing.Any):Reserved, use 0 if passed - -Returns: - - None - - """ - pass - - - def GetMostRecentRunTime(self,) -> 'PyTime': - """ - Returns last time task ran - -Args: - - - -Returns: - - PyTime - - """ - pass - - - def GetStatus(self,) -> 'typing.Any': - """ - Returns status (SCHED_S_TASK... constants) - -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 - -Scheduler if process could not start - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def SetComment(self,Comment:'typing.Any') -> 'None': - """ - Set comment string for task - -Args: - - Comment(typing.Any):Freeform comment string - -Returns: - - None - - """ - pass - - - def GetComment(self,) -> 'str': - """ - Return comment string associated with task. - -Args: - - - -Returns: - - str - - """ - pass - - - def SetCreator(self,Creator:'typing.Any') -> 'None': - """ - Specify who (or what) created task, can be any string - -Args: - - Creator(typing.Any):Originator of task, does not have to be valid username - -Returns: - - None - - """ - pass - - - def GetCreator(self,) -> 'None': - """ - Returns creator info, can be any string data - -Args: - - - -Returns: - - None - - """ - pass - - - def SetWorkItemData(self,Data:'str') -> 'None': - """ - Set data associated with task (treated as uninterpreted bytes) - -Args: - - Data(str):Character data, treated as uninterpreted bytes - -Returns: - - None - - """ - pass - - - def GetWorkItemData(self,) -> 'str': - """ - Retrieve data associated with task - -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 - -currently implemented) - -Args: - - wRetryCount(typing.Any):Nbr of attemps to start task - -Returns: - - None - - """ - pass - - - def GetErrorRetryCount(self,) -> 'None': - """ - Return nbr of times Task scheduler should try to run task (not - -currently implemented) - -Args: - - - -Returns: - - None - - """ - pass - - - def SetErrorRetryInterval(self,RetryInterval:'typing.Any') -> 'None': - """ - Interval in minutes between attempts to run task. Not - -implemented according to SDK - -Args: - - RetryInterval(typing.Any):Interval in minutes - -Returns: - - None - - """ - pass - - - def GetErrorRetryInterval(self,) -> 'None': - """ - Returns nbr of minutes between attempts to run task. Not - -implemented according to SDK - -Args: - - - -Returns: - - None - - """ - pass - - - def SetFlags(self,dwFlags:'typing.Any') -> 'None': - """ - Set flags for task - -Args: - - dwFlags(typing.Any):Combination of TASK_FLAG_* constants - -Returns: - - None - - """ - pass - - - def GetFlags(self,) -> 'typing.Any': - """ - Returns flags for task (TASK_FLAG_* constants) - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetAccountInformation(self,AccountName:'typing.Any',Password:'typing.Any') -> 'None': - """ - Set username and password under which task will run - -Args: - - AccountName(typing.Any):AccountName, use "" for local system account (can only be used by Administrators) - Password(typing.Any):Password - Can be None for local System account, or if TASK_FLAG_RUN_ONLY_IF_LOGGED_ON is setCommentsOn some systems, username and password are verified at the time the task is saved, on others when the task tries to run - -Returns: - - None - - """ - pass - - - def GetAccountInformation(self,) -> 'typing.Any': - """ - Returns username that task will run under - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyIServerSecurity(object): - """Interface used to access client security settings and perform impersonation""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def QueryBlanket(self,Capabilities:'typing.Any'=0) -> 'typing.Any': - """ - Retrieves security settings specified by the client - -Args: - - Capabilities(typing.Any):Can be EOAC_MAKE_FULLSIC for SChannel provider - -Returns: - - typing.Any - - """ - pass - - - def ImpersonateClient(self,) -> 'None': - """ - Initiates impersonation of client - -Args: - - - -Returns: - - None - - """ - pass - - - def RevertToSelf(self,) -> 'None': - """ - Ends impersonation of client - -Args: - - - -Returns: - - None - - """ - pass - - - def IsImpersonating(self,) -> 'typing.Any': - """ - Determines if server is currently impersonating a client - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyIServiceProvider(object): - """A Python interface to IServiceProvider""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def QueryService(self,clsid:'PyIID',iid:'PyIID') -> 'PyIUnknown': - """ - Creates or accesses the specified service and returns an - -interface object to the specified interface for the service. - -Args: - - clsid(PyIID):Unique identifier for the requested service. - iid(PyIID):Unique identifier for the requested interface on the service. - -Returns: - - PyIUnknown - - """ - pass - - -class PyIShellBrowser(object): - """Exposed by Windows Explorer and the Open File common dialog box to provide services for - -namespace extensions.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def InsertMenusSB(self,hmenuShared:'int',lpMenuWidths:'PyOLEMENUGROUPWIDTHS') -> 'PyOLEMENUGROUPWIDTHS': - """ - Updates a composite menu with container's options - -Args: - - hmenuShared(int):Newly created menu that contains no items - lpMenuWidths(PyOLEMENUGROUPWIDTHS):Tuple of 6 ints. Items 0,2,and 4 are updated when the tuple is returned. - -Returns: - - PyOLEMENUGROUPWIDTHS - - """ - pass - - - def SetMenuSB(self,hmenuShared:'int',holemenuRes:'int',hwndActiveObject:'int') -> 'None': - """ - Attaches a shared menu to a shell view window - -Args: - - hmenuShared(int):Handle to the shared menu - holemenuRes(int):Reserved, use only None (or 0) - hwndActiveObject(int):Handle to the shell window - -Returns: - - None - - """ - pass - - - def RemoveMenusSB(self,hmenuShared:'int') -> 'None': - """ - Asks container to remove any items it added to a composite menu - -Args: - - hmenuShared(int):Handle to the composite menu - -Returns: - - None - - """ - pass - - - def SetStatusTextSB(self,pszStatusText:'typing.Any') -> 'None': - """ - Sets the status text in view's status bar - -Args: - - pszStatusText(typing.Any):New status to be displayed - -Returns: - - None - - """ - pass - - - def EnableModelessSB(self,fEnable:'typing.Any') -> 'None': - """ - Enables or disables modeless dialogs - -Args: - - fEnable(typing.Any):Use True to enable or False to disable modeless dialog boxes - -Returns: - - None - - """ - pass - - - def TranslateAcceleratorSB(self,pmsg:'PyMSG',wID:'typing.Any') -> 'None': - """ - Translates keystrokes used as menu item activators - -Args: - - pmsg(PyMSG):Keystroke message to be translated - wID(typing.Any):Menu command id for the keystroke - -Returns: - - None - - """ - pass - - - def BrowseObject(self,pidl:'PyIDL',wFlags:'typing.Any') -> 'None': - """ - Navigates to a different location - -Args: - - pidl(PyIDL):Item id list that specifies the new browse location, can be None - wFlags(typing.Any):Combination of shellcon.SBSP_* flags - -Returns: - - None - - """ - pass - - - def GetViewStateStream(self,grfMode:'typing.Any') -> 'PyIStream': - """ - Returns a stream that can be used to access view state - -information - -Args: - - grfMode(typing.Any):Read/write mode, one of STGM_READ,STGM_WRITE,STGM_READWRITE - -Returns: - - PyIStream - - """ - pass - - - def GetControlWindow(self,_id:'typing.Any') -> 'None': - """ - Returns a handle to one of the browser's control elements - -Args: - - _id(typing.Any):One of shellcon.FCW_* values - -Returns: - - None - - """ - pass - - - def SendControlMsg(self,_id:'typing.Any',uMsg:'typing.Any',wParam:'typing.Any',lParam:'typing.Any') -> 'typing.Any': - """ - Sends a control msg to browser's toolbar or status bar - -Args: - - _id(typing.Any):shellcon.FCW_TOOLBAR or FCW_STATUS - uMsg(typing.Any):The message to send - wParam(typing.Any):Value is dependent on the message - lParam(typing.Any):Value is dependent on the message - -Returns: - - typing.Any - - """ - pass - - - def QueryActiveShellView(self,) -> 'PyIShellView': - """ - Returns the currently displayed view - -Args: - - - -Returns: - - PyIShellView - - """ - pass - - - def OnViewWindowActive(self,pshv:'PyIShellView') -> 'None': - """ - Callback triggered when a view window is activated - -Args: - - pshv(PyIShellView):The activated view object - -Returns: - - None - - """ - pass - - - def SetToolbarItems(self,lpButtons:'typing.Any',uFlags:'typing.Any') -> 'None': - """ - Adds toolbar buttons to the browser's toolbar - -Args: - - lpButtons(typing.Any):Sequence of tuples describing the buttons to be added - uFlags(typing.Any):Indicates button positions, combination of shellcon.FCT_* - -Returns: - - None - - """ - pass - - -class PyIShellExtInit(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,pFolder:'PyIDL',pDataObject:'PyIDataObject',hkey:'int') -> 'None': - """ - Description of Initialize. - -Args: - - pFolder(PyIDL):Description for pFolder - pDataObject(PyIDataObject):Description for pDataObject - hkey(int):Description for hkey - -Returns: - - None - - """ - pass - - -class PyIShellFolder(object): - """Interface that represents an Explorer folder""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ParseDisplayName(self,hwndOwner:'int',pbc:'PyIBindCtx',DisplayName:'typing.Any',Attributes:'typing.Any'=0) -> 'typing.Any': - """ - Returns the PIDL of an item in a shell folder - -Args: - - hwndOwner(int):Window in which to display any dialogs or message boxes, can be 0 - pbc(PyIBindCtx):Bind context that affects how parsing is performed, can be None - DisplayName(typing.Any):Display name to parse, format is dependent on the shell folder. Desktop folder will accept a file path, as well as guids of the form ::{guid} Example: '::%s\\::%s' %(shell.CLSID_MyComputer,shell.CLSID_ControlPanel) - Attributes(typing.Any):Combination of shellcon.SFGAO_* constants specifying which attributes should be returnedReturn ValueThe result is a tuple of cchEaten, pidl, attrItems[0] int : cchEatenthe number of characters of the input name that were parsed[1] PyIDL : pidlspecifies the relative path from the parsing folder to the object[2] int : Attributesreturns any requested attributes - -Returns: - - typing.Any:Combination of shellcon.SFGAO_* constants specifying which attributes should be returned -Return ValueThe result is a tuple of cchEaten, pidl, attr -Items[0] int : cchEaten -the number of characters of the input name that were parsed -[1] PyIDL : pidl -specifies the relative path from the parsing folder to the object -[2] int : Attributes -returns any requested attributes - - - """ - pass - - - def EnumObjects(self,grfFlags:'typing.Any',hwndOwner:'int'=None) -> 'PyIEnumIDList': - """ - Creates an enumerator to list the contents of the shell folder - -Args: - - grfFlags(typing.Any):Combination of shellcon.SHCONTF_* constants - hwndOwner(int):Window to use if any user interaction is required - -Returns: - - PyIEnumIDList - - """ - pass - - - def BindToObject(self,pidl:'PyIDL',pbc:'PyIBindCtx',riid:'PyIID') -> 'PyIShellFolder': - """ - Returns an IShellFolder interface for a subfolder - -Args: - - pidl(PyIDL):Relative item id list that identifies the subfolder, can be multi-level - pbc(PyIBindCtx):Bind context to be used, can be None - riid(PyIID):IID of the desired interface, usually IID_IShellFolder - -Returns: - - PyIShellFolder - - """ - pass - - - def BindToStorage(self,pidl:'PyIDL',pbc:'PyIBindCtx',riid:'PyIID') -> 'typing.Any': - """ - Returns an interface to a storage object in a shell folder - -Args: - - pidl(PyIDL):Relative pidl for the folder item, must be a single item id - pbc(PyIBindCtx):Bind context that affects how binding is performed, can be None - riid(PyIID):IID of the desired interface, one of IID_IStream, IID_IStorage, IID_IPropertySetStorageReturn ValueReturns PyIStream, PyIStorage or PyIPropertySetStorage depending on the riid passed in - -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 - - - def CompareIDs(self,lparam:'typing.Any',pidl1:'PyIDL',pidl2:'PyIDL') -> 'typing.Any': - """ - Determines the sorting order of 2 items in shell folder - -Args: - - lparam(typing.Any):Lower 16 bits specify folder-dependent sorting rules, 0 means to sort by display name. System folder view uses these as a column number. Upper sixteen bits is used for flags SHCIDS_ALLFIELDS or SHCIDS_CANONICALONLY - pidl1(PyIDL):Item id list that idenfies an object relative to the folder - pidl2(PyIDL):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 - -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 - - - def CreateViewObject(self,hwndOwner:'typing.Any',riid:'PyIID') -> 'PyIShellView': - """ - Creates a view object for a shell folder. - -Args: - - hwndOwner(typing.Any):Parent window for a custom folder view, or 0 - riid(PyIID):IID of the desired interface, usually IID_IShellView - -Returns: - - PyIShellView - - """ - pass - - - def GetAttributesOf(self,pidl:'typing.Tuple[PyIDL, ...]',rgfInOut:'typing.Any') -> 'typing.Any': - """ - Queries attributes of items within the shell folder - -Args: - - pidl(typing.Tuple[PyIDL, ...]):A sequence of single-level pidls identifying items directly contained by the folder - rgfInOut(typing.Any):Combination of shellcon.SFGAO_* constantsReturn ValueThe requested attributes are only returned if they are common to all of the specified items - -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 - -folder - -Args: - - hwndOwner(int):Specifies a window in which to display any required dialogs or errors, can be 0 - pidl(typing.Tuple[PyIDL, ...]):A sequence of single-level pidls identifying items in the folder - riid(PyIID):The interface to create, one of IID_IContextMenu, IID_IContextMenu2, IID_IDataObject, IID_IDropTarget, IID_IExtractIcon, IID_IQueryInfo - iidout(PyIID):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 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 - Reserved(typing.Any):Reserved, use 0 if passed in - -Returns: - - 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 - -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 - - - def GetDisplayNameOf(self,pidl:'PyIDL',uFlags:'typing.Any') -> 'typing.Any': - """ - Returns the display name of an item within this shell folder - -Args: - - pidl(PyIDL):PIDL that identifies the item relative to the parent folder - uFlags(typing.Any):Combination of shellcon.SHGDN_* flags - -Returns: - - typing.Any - - """ - pass - - - def SetNameOf(self,hwndOwner:'typing.Any',pidl:'PyIDL',Name:'typing.Any',Flags:'typing.Any') -> 'PyIDL': - """ - Sets the display name of an item and changes its PIDL - -Args: - - hwndOwner(typing.Any):Window in which to display any message boxes or dialogs, can be 0 - pidl(PyIDL):PIDL that identifies the item relative to the parent folder - Name(typing.Any):New name for the item - Flags(typing.Any):Combination of shellcon.SHGDM_* valuesReturn ValueReturns the new PIDL for item - -Returns: - - PyIDL:Combination of shellcon.SHGDM_* valuesReturn ValueReturns the new PIDL for item - - - """ - pass - - -class PyIShellFolder2(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDefaultSearchGUID(self,pguid:'PyIID') -> 'PyIID': - """ - Retrieves the default search for the folder - -Args: - - pguid(PyIID):Description for pguid - -Returns: - - PyIID - - """ - pass - - - def EnumSearches(self,) -> 'typing.Any': - """ - Returns an interface that lists searches defined for - -the folder - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetDefaultColumn(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Returns the columns used for sorting and display - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def GetDefaultColumnState(self,iColumn:'typing.Any') -> 'typing.Any': - """ - Returns flags indicating the default behaviour of the column - -Args: - - iColumn(typing.Any):Zero-based index of the columnReturn ValueReturns a combination of shellcon.SHCOLSTATE_* flags - -Returns: - - typing.Any:Zero-based index of the columnReturn ValueReturns a combination of shellcon.SHCOLSTATE_* flags - - - """ - pass - - - def GetDetailsEx(self,pidl:'PyIDL',pscid:'typing.Any') -> 'typing.Any': - """ - Returns the details of an item by Column ID - -Args: - - pidl(PyIDL):Relative id list of an item in the folder - pscid(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 - -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 - -view. - -Args: - - pidl(PyIDL):The relative idl of an item in the folder. Use None to retrieve column title. - iColumn(typing.Any):Zero based index of columnReturn ValueReturns a tuple representing a SHELLDETAILS struct, containing the formst (LVCFMT_*), column width in characters, and string representation of the requested value - -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 - -characters, - -and string representation of the requested value - - - """ - pass - - - def MapColumnToSCID(self,Column:'typing.Any') -> 'typing.Any': - """ - Returns the unique identifier (FMTID, pid) of a column - -Args: - - Column(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. - -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. - -For Vista and later, this is the Property Key used with the property system interfaces. - - - """ - pass - - -class PyIShellIcon(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetIconOf(self,pidl:'PyIDL') -> 'None': - """ - Description of GetIconOf. - -Args: - - pidl(PyIDL):Description for pidl - -Returns: - - None - - """ - pass - - -class PyIShellIconOverlay(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetOverlayIndex(self,pidl:'PyIDL') -> 'None': - """ - Description of GetOverlayIndex. - -Args: - - pidl(PyIDL):Description for pidl - -Returns: - - None - - """ - pass - - - def GetOverlayIconIndex(self,pidl:'PyIDL') -> 'None': - """ - Description of GetOverlayIconIndex. - -Args: - - pidl(PyIDL):Description for pidl - -Returns: - - None - - """ - pass - - -class PyIShellIconOverlayIdentifier(object): - """Interface that supplies icon overlay information to the shell""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def IsMemberOf(self,path:'str',attrib:'typing.Any') -> 'typing.Any': - """ - Determines if a shell object should have an icon overlay - -Args: - - path(str):Fully qualified path of the shell object - attrib(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. 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. - -Returns: - - 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. - -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 - -icon - -Args: - - - -Returns: - - typing.Tuple[str, typing.Any, typing.Any]:PyIShellIconOverlayIdentifier.GetOverlayInfo - -(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 - -combination of shellcon.ISIOI_ICON* flags - - - """ - pass - - - def GetPriority(self,) -> 'typing.Any': - """ - Retrieves the relative priority of the overlay - -Args: - - - -Returns: - - typing.Any:PyIShellIconOverlayIdentifier.GetPriority - -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 - - -class PyIShellIconOverlayManager(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - 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 - -image or overlay image - -Args: - - path(typing.Any):Full path to the file - attrib(typing.Any):File attributes (win32com.FILE_ATTRIBUTE_*) - flags(typing.Any):SIOM_OVERLAYINDEX (1) or SIOM_ICONINDEX (2) - -Returns: - - typing.Any - - """ - pass - - - def GetReservedOverlayInfo(self,path:'typing.Any',attrib:'typing.Any',flags:'typing.Any',ireservedID:'typing.Any') -> 'None': - """ - Description of GetReservedOverlayInfo. - -Args: - - path(typing.Any):Description for path - attrib(typing.Any):Description for attrib - flags(typing.Any):Description for flags - ireservedID(typing.Any):Description for ireservedID - -Returns: - - None - - """ - pass - - - def RefreshOverlayImages(self,flags:'typing.Any') -> 'None': - """ - Description of RefreshOverlayImages. - -Args: - - flags(typing.Any):Description for flags - -Returns: - - None - - """ - pass - - - def LoadNonloadedOverlayIdentifiers(self,) -> 'None': - """ - Description of LoadNonloadedOverlayIdentifiers. - -Args: - - - -Returns: - - None - - """ - pass - - - def OverlayIndexFromImageIndex(self,iImage:'typing.Any',fAdd:'typing.Any') -> 'None': - """ - Description of OverlayIndexFromImageIndex. - -Args: - - iImage(typing.Any):Description for iImage - fAdd(typing.Any):Description for fAdd - -Returns: - - None - - """ - pass - - -class PyIShellItem(object): - """Interface that represents an item in the Explorer shell""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def BindToHandler(self,pbc:'PyIBindCtx',bhid:'PyIID',riid:'PyIID') -> 'typing.Any': - """ - Creates an instance of one of the item's handlers - -Args: - - pbc(PyIBindCtx):Used to pass parameters that influence the binding operation, can be None - bhid(PyIID):GUID that identifies a handler (shell.BHID_*) - riid(PyIID):The interface to return - -Returns: - - typing.Any - - """ - pass - - - def GetParent(self,) -> 'PyIShellItem': - """ - Retrieves the parent of this item - -Args: - - - -Returns: - - PyIShellItem - - """ - pass - - - def GetDisplayName(self,sigdnName:'typing.Any') -> 'typing.Any': - """ - Returns the display name of the item in the specified format - -Args: - - sigdnName(typing.Any):Format of name to return, shellcon.SIGDN_* - -Returns: - - typing.Any - - """ - pass - - - def GetAttributes(self,Mask:'typing.Any') -> 'typing.Any': - """ - Returns shell attributes of the item - -Args: - - Mask(typing.Any):Combination of shellcon.SFGAO_* values indicating the flags to returnReturn ValueReturns a combination of shellcon.SFGAO_* values - -Returns: - - typing.Any:Combination of shellcon.SFGAO_* values indicating the flags to returnReturn ValueReturns a combination of shellcon.SFGAO_* values - - - """ - pass - - - def Compare(self,psi:'PyIShellItem',hint:'typing.Any') -> 'typing.Any': - """ - Compares another shell item with this item - -Args: - - psi(PyIShellItem):A shell item to be compared with this item - hint(typing.Any):shellcon.SICHINT_* value indicating how the comparison is to be performedReturn ValueReturns 0 if items compare as equal, nonzero otherwise - -Returns: - - typing.Any:shellcon.SICHINT_* value indicating how the comparison is to be performedReturn ValueReturns 0 if items compare as equal, nonzero otherwise - - - """ - pass - - -class PyIShellItem2(object): - """Extends the IShellItem interface, giving access to an item's properties""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPropertyStore(self,Flags:'typing.Any',riid:'PyIID') -> 'PyIPropertyStore': - """ - Returns a collection of the item's properties - -Args: - - Flags(typing.Any):Combination of GETPROPERTYSTOREFLAGS values (shellcon.GPS_*) - riid(PyIID):The interface to return - -Returns: - - PyIPropertyStore - - """ - pass - - - def GetPropertyStoreForKeys(self,Keys:'typing.Tuple[typing.Any, ...]',Flags:'typing.Any',riid:'PyIID') -> 'PyIPropertyStore': - """ - Creates a property store containing just the - -specified properties of the item - -Args: - - Keys(typing.Tuple[typing.Any, ...]):A sequence of property identifiers - Flags(typing.Any):Combination of GETPROPERTYSTOREFLAGS values (shellcon.GPS_*) - riid(PyIID):The interface to return - -Returns: - - PyIPropertyStore - - """ - pass - - - def GetPropertyStoreWithCreateObject(self,Flags:'typing.Any',CreateObject:'PyIUnknown',riid:'PyIID') -> 'PyIPropertyStore': - """ - Returns the property store for the - -item, with alternate handler instantiation - -Args: - - Flags(typing.Any):Combination of GETPROPERTYSTOREFLAGS values (shellcon.GPS_*) - CreateObject(PyIUnknown):An interface that implements ICreateObject, used to create the property handler - riid(PyIID):The interface to be createdCommentsPrimarily used to create a handler in a separate process with reduced privileges - -Returns: - - PyIPropertyStore - - """ - pass - - - def GetPropertyDescriptionList(self,Type:'PyPROPERTYKEY',riid:'PyIID') -> 'PyIPropertyDescriptionList': - """ - Retrieves descriptions of - -properties in a particular group - -Args: - - Type(PyPROPERTYKEY):Property list identifier (pscon.PKEY_PropList_*) - riid(PyIID):The interface to return - -Returns: - - PyIPropertyDescriptionList - - """ - pass - - - def Update(self,BindCtx:'typing.Any'=None) -> 'None': - """ - Refreshes properties that have been modified since interface was created - -Args: - - BindCtx(typing.Any):Bind context used when requesting the interface, or None - -Returns: - - None - - """ - pass - - - def GetProperty(self,key:'PyPROPERTYKEY') -> 'typing.Any': - """ - Retrieves the value of a property, converted to an appropriate python type - -Args: - - key(PyPROPERTYKEY):The id of the property to retrieveReturn ValueType of returned object is determined by the variant type of the property - -Returns: - - typing.Any:The id of the property to retrieveReturn ValueType of returned object is determined by the variant type of the property - - - """ - pass - - - def GetCLSID(self,key:'PyPROPERTYKEY') -> 'PyIID': - """ - Retrieves the value of a property as a CLSID (VT_CLSID) - -Args: - - key(PyPROPERTYKEY):The id of the property to retrieve - -Returns: - - PyIID - - """ - pass - - - def GetFileTime(self,key:'PyPROPERTYKEY') -> 'PyTime': - """ - Retrieves the value of a property as a FILETIME - -Args: - - key(PyPROPERTYKEY):The id of the property to retrieve - -Returns: - - PyTime - - """ - pass - - - def GetInt32(self,key:'PyPROPERTYKEY') -> 'typing.Any': - """ - Retrieves the value of a property as a 32 bit int. - -Args: - - key(PyPROPERTYKEY):The id of the property to retrieve - -Returns: - - typing.Any - - """ - pass - - - def GetString(self,key:'PyPROPERTYKEY') -> 'typing.Any': - """ - Retrieves the value of a property as a string - -Args: - - key(PyPROPERTYKEY):The id of the property to retrieve - -Returns: - - typing.Any - - """ - pass - - - def GetUInt32(self,key:'PyPROPERTYKEY') -> 'typing.Any': - """ - Returns the value of a property as a 32 bit unsigned int - -Args: - - key(PyPROPERTYKEY):The id of the property to retrieve - -Returns: - - typing.Any - - """ - pass - - - def GetUInt64(self,key:'PyPROPERTYKEY') -> 'typing.Any': - """ - Returns the value of a property as an unsigned 64-bit int - -Args: - - key(PyPROPERTYKEY):The id of the property to retrieve - -Returns: - - typing.Any - - """ - pass - - - def GetBool(self,key:'PyPROPERTYKEY') -> 'typing.Any': - """ - Returns the value of a property as a boolean - -Args: - - key(PyPROPERTYKEY):The id of the property to retrieve - -Returns: - - typing.Any - - """ - pass - - -class PyIShellItemArray(object): - """Container for a number of shell items""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def BindToHandler(self,pbc:'PyIBindCtx',rbhid:'PyIID',riid:'PyIID') -> 'typing.Any': - """ - Creates an instance of a handler for the items in the container - -Args: - - pbc(PyIBindCtx):Bind context, can be None - rbhid(PyIID):Bind handler GUID (shell.BHID_*) - riid(PyIID):The interface to return - -Returns: - - typing.Any - - """ - pass - - - def GetPropertyStore(self,flags:'typing.Any',riid:'PyIID') -> 'PyIPropertyStore': - """ - Retrieves a store containing consolidated - -properties of items in container - -Args: - - flags(typing.Any):Flags indicating how the properties are retrieved (shellcon.GPS_*) - riid(PyIID):The interface to return, IID_IPropertyStore or related interface - -Returns: - - PyIPropertyStore - - """ - pass - - - def GetPropertyDescriptionList(self,Type:'PyPROPERTYKEY',riid:'PyIID') -> 'PyIPropertyDescriptionList': - """ - Retrieves descriptions for a - -defined group of properties - -Args: - - Type(PyPROPERTYKEY):Property list identifier (pscon.PKEY_PropList_*) - riid(PyIID):The interface to return - -Returns: - - PyIPropertyDescriptionList - - """ - pass - - - def GetAttributes(self,AttribFlags:'typing.Any',Mask:'typing.Any') -> 'typing.Any': - """ - Retrieves shell attributes of contained items - -Args: - - AttribFlags(typing.Any):SIATTRIBFLAGS value (shellcon.SIATTRIBFLAGS_*) specifying how to combine attributes of multiple items - Mask(typing.Any):Combination of SFGAOF flags (shellcon.SFGAO_*) specifying which attributes to return - -Returns: - - typing.Any - - """ - pass - - - def GetCount(self,) -> 'typing.Any': - """ - Returns the number of items in the container - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetItemAt(self,dwIndex:'typing.Any') -> 'PyIShellItem': - """ - Retrieves an item by index - -Args: - - dwIndex(typing.Any):Zero-based index of item to retrieve - -Returns: - - PyIShellItem - - """ - pass - - - def EnumItems(self,) -> 'PyIEnumShellItems': - """ - Returns an enumeration interface to list contained items - -Args: - - - -Returns: - - PyIEnumShellItems - - """ - pass - - -class PyIShellItemResources(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetAttributes(self,) -> 'None': - """ - Description of GetAttributes. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetSize(self,) -> 'typing.Any': - """ - Description of GetSize. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetTimes(self,) -> 'None': - """ - Description of GetTimes. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetTimes(self,pftCreation:'PyTime',pftWrite:'PyTime',pftAccess:'PyTime') -> 'None': - """ - Description of SetTimes. - -Args: - - pftCreation(PyTime):Description for pftCreation - pftWrite(PyTime):Description for pftWrite - pftAccess(PyTime):Description for pftAccess - -Returns: - - None - - """ - pass - - - def GetResourceDescription(self,pcsir:'PySHELL_ITEM_RESOURCE') -> 'None': - """ - Description of GetResourceDescription. - -Args: - - pcsir(PySHELL_ITEM_RESOURCE):Description for pcsir - -Returns: - - None - - """ - pass - - - def EnumResources(self,) -> 'PyIEnumResources': - """ - Description of EnumResources. - -Args: - - - -Returns: - - PyIEnumResources - - """ - pass - - - def SupportsResource(self,pcsir:'PySHELL_ITEM_RESOURCE') -> 'typing.Any': - """ - Description of SupportsResource. - -Args: - - pcsir(PySHELL_ITEM_RESOURCE):Description for pcsir - -Returns: - - typing.Any - - """ - pass - - - def OpenResource(self,pcsir:'PySHELL_ITEM_RESOURCE',riid:'PyIID') -> 'PyIUnknown': - """ - Description of OpenResource. - -Args: - - pcsir(PySHELL_ITEM_RESOURCE):Description for pcsir - riid(PyIID):The interface to return - -Returns: - - PyIUnknown - - """ - pass - - - def CreateResource(self,sir:'PySHELL_ITEM_RESOURCE',riid:'PyIID') -> 'typing.Any': - """ - Description of CreateResource. - -Args: - - sir(PySHELL_ITEM_RESOURCE):Resource identifier - riid(PyIID):The interface to return - -Returns: - - typing.Any - - """ - pass - - - def MarkForDelete(self,) -> 'None': - """ - Description of MarkForDelete. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIShellLibrary(object): - """Interface used to access Libraries""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def LoadLibraryFromItem(self,Library:'PyIShellItem',Mode:'typing.Any') -> 'None': - """ - Loads an existing library file - -Args: - - Library(PyIShellItem):Shell item interface representing the library file - Mode(typing.Any):Access mode, combination of storagecon.STGM_* flags - -Returns: - - None - - """ - pass - - - def LoadLibraryFromKnownFolder(self,Library:'PyIID',Mode:'typing.Any') -> 'None': - """ - Initializes library from a known folder - -Args: - - Library(PyIID):Known folder id, shell.FOLDERID_* - Mode(typing.Any):Access mode, combination of storagecon.STGM_* flags - -Returns: - - None - - """ - pass - - - def AddFolder(self,Location:'PyIShellItem') -> 'None': - """ - Includes a folder - -Args: - - Location(PyIShellItem):Shell item interface representing the folder - -Returns: - - None - - """ - pass - - - def RemoveFolder(self,Location:'PyIShellItem') -> 'None': - """ - Removes a folder - -Args: - - Location(PyIShellItem):Shell item interface representing the folder - -Returns: - - None - - """ - pass - - - def GetFolders(self,Filter:'typing.Any',riid:'PyIID') -> 'PyIShellItemArray': - """ - Retrieves a collection of folders in the library - -Args: - - Filter(typing.Any):Specifies what types of folder to return (shellcon.LFF_*) - riid(PyIID):The interface to return, IObjectCollection and IObjectArray also accepted. - -Returns: - - PyIShellItemArray - - """ - pass - - - def ResolveFolder(self,FolderToResolve:'PyIShellItem',Timeout:'typing.Any',riid:'PyIID') -> 'PyIShellItem': - """ - Attempts to locate a folder that has been moved or renamed - -Args: - - FolderToResolve(PyIShellItem):Library item whose location has changed - Timeout(typing.Any):Max search time, specified in milliseconds - riid(PyIID):The interface to return - -Returns: - - PyIShellItem - - """ - pass - - - def GetDefaultSaveFolder(self,Type:'typing.Any',riid:'PyIID') -> 'PyIShellItem': - """ - Returns the default folder in which new items are - -saved - -Args: - - Type(typing.Any):Specifies whether to return public or private save location, shellcon.DSFT_* - riid(PyIID):The interface to return - -Returns: - - PyIShellItem - - """ - pass - - - def SetDefaultSaveFolder(self,Type:'typing.Any',SaveFolder:'PyIShellItem') -> 'None': - """ - Sets the default save location - -Args: - - Type(typing.Any):Specifies public or private save location, shellcon.DSFT_* - SaveFolder(PyIShellItem):New default location, must be in the library - -Returns: - - None - - """ - pass - - - def GetOptions(self,) -> 'typing.Any': - """ - Retrieves library option flags - -Args: - - - -Returns: - - typing.Any:PyIShellLibrary.GetOptions - -int = GetOptions()Retrieves library option flags -Return ValueReturns a combination of shellcon.LOF_* flags - - - """ - pass - - - def SetOptions(self,Mask:'typing.Any',Options:'typing.Any') -> 'None': - """ - Sets library option flags - -Args: - - Mask(typing.Any):Bitmask of flags to be changed, combination of shellcon.LOF_* values - Options(typing.Any):New options, combination of shellcon.LOF_* values - -Returns: - - None - - """ - pass - - - def GetFolderType(self,) -> 'PyIID': - """ - Returns the library type, shell.FOLDERTYPEID_* - -Args: - - - -Returns: - - PyIID - - """ - pass - - - def SetFolderType(self,Type:'PyIID') -> 'None': - """ - Sets the folder type for the library - -Args: - - Type(PyIID):New type, shell.FOLDERTYPEID_* - -Returns: - - None - - """ - pass - - - def GetIcon(self,) -> 'typing.Any': - """ - Returns the location of the library's icon - -Args: - - - -Returns: - - typing.Any:PyIShellLibrary.GetIcon - -str = GetIcon()Returns the location of the library's icon -Return ValueUses "module,resource" format - - - """ - pass - - - def SetIcon(self,Icon:'typing.Any') -> 'None': - """ - Sets the library icon - -Args: - - Icon(typing.Any):Icon location in "module,resource" syntax - -Returns: - - None - - """ - pass - - - def Commit(self,) -> 'None': - """ - Saves changes (only if loaded from an existing library) - -Args: - - - -Returns: - - None - - """ - pass - - - def Save(self,FolderToSaveIn:'PyIShellItem',LibraryName:'typing.Any',Flags:'typing.Any') -> 'PyIShellItem': - """ - Saves the library to a specific location - -Args: - - FolderToSaveIn(PyIShellItem):The destination folder, use None to save in current user's Libraries folder - LibraryName(typing.Any):Filename for the new library, without file extension - Flags(typing.Any):Determines behaviour if file already exists, shellcon.LSF_*Return ValueReturns a shell item for the saved file. - -Returns: - - PyIShellItem:Determines behaviour if file already exists, shellcon.LSF_*Return ValueReturns a shell item for the saved file. - - - """ - pass - - - def SaveInKnownFolder(self,FolderToSaveIn:'PyIID',LibraryName:'typing.Any',Flags:'typing.Any') -> 'PyIShellItem': - """ - Saves the library in a known folder - -Args: - - FolderToSaveIn(PyIID):The destination folder, shell.FOLDERID_* - LibraryName(typing.Any):Filename for the new library, without file extension - Flags(typing.Any):Determines behaviour if file already exists, shellcon.LSF_* - -Returns: - - PyIShellItem - - """ - pass - - -class PyIShellLink(object): - """Interface used to access the properties of a shell link file (*.lnk)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - 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 - -object - -Args: - - fFlags(typing.Any):One of the following values:ValueDescriptionSLGP_SHORTPATHRetrieves the standard short (8.3 format) file name.SLGP_UNCPRIORITYRetrieves the Universal Naming Convention (UNC) path name of the file.SLGP_RAWPATHRetrieves the raw path name. A raw path is something that might not exist and may include environment variables that need to be expanded. - cchMaxPath(typing.Any):Number of characters to allocate for returned filenameCommentsThe AlternateFileName (8.3) member of WIN32_FIND_DATA does not return information - -Returns: - - typing.Tuple[typing.Any, WIN32_FIND_DATA] - - """ - pass - - - def GetIDList(self,) -> 'PyIDL': - """ - Retrieves the item id list that identifies the target of the shell link. - -Args: - - - -Returns: - - PyIDL - - """ - pass - - - def SetIDList(self,pidl:'PyIDL') -> 'None': - """ - Sets the target of the link using an item id list - -Args: - - pidl(PyIDL):Absolute item id list that identifies the target - -Returns: - - None - - """ - pass - - - def GetDescription(self,cchMaxName:'typing.Any'=1024) -> 'typing.Any': - """ - Retrieves the description of the link (displays as Comment in the UI) - -Args: - - cchMaxName(typing.Any):Number of character to allocate for the retrieved text - -Returns: - - typing.Any - - """ - pass - - - def SetDescription(self,Name:'typing.Any') -> 'None': - """ - Sets the description of the link (displays as Comment in the UI) - -Args: - - Name(typing.Any):The description for the link - -Returns: - - None - - """ - pass - - - def GetWorkingDirectory(self,cchMaxName:'typing.Any'=1024) -> 'typing.Any': - """ - Retrieves the working directory for the link - -Args: - - cchMaxName(typing.Any):Number of characters to allocate for returned text - -Returns: - - typing.Any - - """ - pass - - - def SetWorkingDirectory(self,Dir:'typing.Any') -> 'None': - """ - Sets the working directory for the link. - -Args: - - Dir(typing.Any):The working directory for the link - -Returns: - - None - - """ - pass - - - def GetArguments(self,cchMaxName:'typing.Any'=1024) -> 'typing.Any': - """ - Retrieves the command-line arguments associated with a shell link object. - -Args: - - cchMaxName(typing.Any):Number of characters to fetch. - -Returns: - - typing.Any - - """ - pass - - - def SetArguments(self,args:'typing.Any') -> 'None': - """ - Sets the command-line arguments associated with a shell link object. - -Args: - - args(typing.Any):The new arguments. - -Returns: - - None - - """ - pass - - - def GetHotkey(self,) -> 'typing.Any': - """ - Retrieves the hot key for a shell link object. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetHotkey(self,wHotkey:'typing.Any') -> 'None': - """ - Sets the hot key for a shell link object. - -Args: - - wHotkey(typing.Any):The virtual key code is in the low-order byte, and the modifier flags are in the high-order byte. The modifier flags can be a combination of the values specified in the description of the PyIShellLink::GetHotkey method. - -Returns: - - None - - """ - pass - - - def GetShowCmd(self,) -> 'typing.Any': - """ - Retrieves the show (SW_) command for a shell link object. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetShowCmd(self,iShowCmd:'typing.Any') -> 'None': - """ - Sets the show (SW_) command for a shell link object. - -Args: - - iShowCmd(typing.Any):The new show command value. - -Returns: - - None - - """ - pass - - - def GetIconLocation(self,cchMaxPath:'typing.Any') -> 'typing.Any': - """ - Retrieves the location (path and index) of the icon for a shell link - -object. - -Args: - - cchMaxPath(typing.Any):Number of characters to allocate for the result string. - -Returns: - - typing.Any - - """ - pass - - - def SetIconLocation(self,iconPath:'str',iIcon:'typing.Any') -> 'None': - """ - Sets the location (path and index) of the icon for a shell link object. - -Args: - - iconPath(str):Path to the file with the icon. - iIcon(typing.Any):Index of the icon. - -Returns: - - None - - """ - pass - - - def SetRelativePath(self,relPath:'str',reserved:'typing.Any'=0) -> 'None': - """ - Sets the relative path for a shell link object. - -Args: - - relPath(str):The relative path. - reserved(typing.Any):Reserved - must be zero.CommentsThis mechanism allows for moved link files to reestablish connection with relative files through similar-prefix comparisons - -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 - -shell link path and its list of identifiers (if necessary) - -Args: - - hwnd(typing.Any):The parent window of a dialog which will pop up if resolution fails. - fFlags(typing.Any):One of the following constants:ValueDescriptionSLR_INVOKE_MSICall the Microsoft Windows Installer.SLR_NOLINKINFODisable distributed link tracking. By default, distributed link tracking tracks removable media across multiple devices based on the volume name. It also uses the UNC path to track remote file systems whose drive letter has changed. Setting SLR_NOLINKINFO disables both types of tracking.SLR_NO_UIDo not display a dialog box if the link cannot be resolved. When SLR_NO_UI is set, the high-order word of fFlags can be set to a time-out value that specifies the maximum amount of time to be spent resolving the link. The function returns if the link cannot be resolved within the time-out duration. If the high-order word is set to zero, the time-out duration will be set to the default value of 3,000 milliseconds (3 seconds). To specify a value, set the high word of fFlags to the desired time-out duration, in milliseconds.SLR_NOUPDATEDo not update the link information.SLR_NOSEARCHDo not execute the search heuristics.SLR_NOTRACKDo not use distributed link tracking.SLR_UPDATEIf the link object has changed, update its path and list of identifiers. If SLR_UPDATE is set, you do not need to call IPersistFile::IsDirty to determine whether or not the link object has changed. - -Returns: - - None - - """ - pass - - - def SetPath(self,path:'str') -> 'None': - """ - Sets the path and file name of a shell link object. - -Args: - - path(str):The path and filename of the link. - -Returns: - - None - - """ - pass - - -class PyIShellLinkDataList(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddDataBlock(self,DataBlock:'typing.Any') -> 'None': - """ - Inserts a data block into the link - -Args: - - DataBlock(typing.Any):Contents are dependent on type of data block being addedCommentsInput should be one of NT_CONSOLE_PROPS, NT_FE_CONSOLE_PROPS, EXP_SPECIAL_FOLDER, EXP_DARWIN_LINK, or EXP_SZ_LINK. Expected form is indicated by the Signature member. - -Returns: - - None - - """ - pass - - - def CopyDataBlock(self,Sig:'typing.Any') -> 'typing.Any': - """ - Retrieves the specified data block from the link - -Args: - - Sig(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 - -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 - - - def GetFlags(self,) -> 'typing.Any': - """ - Retrieves the link's flags - -Args: - - - -Returns: - - typing.Any:PyIShellLinkDataList.GetFlags - -int = GetFlags()Retrieves the link's flags -Return ValueReturns combination of shellcon.SLDF_* flags - - - """ - pass - - - def RemoveDataBlock(self,Sig:'typing.Any') -> 'None': - """ - Deletes one of the link's data blocks - -Args: - - Sig(typing.Any):Identifies which block is to be removed, one of shellcon.*_SIG constants - -Returns: - - None - - """ - pass - - - def SetFlags(self,Flags:'typing.Any') -> 'None': - """ - Sets the flags indicating which data blocks are present - -Args: - - Flags(typing.Any):Combination of shellcon.SLDF_* flags - -Returns: - - None - - """ - pass - - -class PyIShellView(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def TranslateAccelerator(self,pmsg:'typing.Any') -> 'typing.Any': - """ - Description of TranslateAccelerator. - -Args: - - pmsg(typing.Any):Description for pmsgReturn ValueThe result is the HRESULT from the underlying TranslateAccelerator call - -Returns: - - typing.Any:Description for pmsgReturn ValueThe result is the HRESULT from the underlying TranslateAccelerator call - - - """ - pass - - - def EnableModeless(self,fEnable:'typing.Any') -> 'None': - """ - Description of EnableModeless. - -Args: - - fEnable(typing.Any):Description for fEnable - -Returns: - - None - - """ - pass - - - def UIActivate(self,uState:'typing.Any') -> 'None': - """ - Description of UIActivate. - -Args: - - uState(typing.Any):Description for uState - -Returns: - - None - - """ - pass - - - def Refresh(self,) -> 'None': - """ - Description of Refresh. - -Args: - - - -Returns: - - None - - """ - pass - - - def CreateViewWindow(self,psvPrevious:'PyIShellView',pfs:'typing.Tuple[typing.Any, typing.Any]',psb:'PyIShellBrowser',prcView:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]') -> 'typing.Any': - """ - Description of CreateViewWindow. - -Args: - - psvPrevious(PyIShellView):Description for psvPrevious - pfs(typing.Tuple[typing.Any, typing.Any]):Description for pfs - psb(PyIShellBrowser):Description for psb - prcView(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Description for prcViewReturn ValueThe result is an integer handle to the new window. - -Returns: - - typing.Any:Description for prcViewReturn ValueThe result is an integer handle to the new window. - - - """ - pass - - - def DestroyViewWindow(self,) -> 'None': - """ - Description of DestroyViewWindow. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCurrentInfo(self,) -> 'typing.Any': - """ - Description of GetCurrentInfo. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SaveViewState(self,) -> 'None': - """ - Description of SaveViewState. - -Args: - - - -Returns: - - None - - """ - pass - - - def SelectItem(self,pidlItem:'PyIDL',uFlags:'typing.Any') -> 'None': - """ - Description of SelectItem. - -Args: - - pidlItem(PyIDL):Description for pidlItem - uFlags(typing.Any):Description for uFlags - -Returns: - - None - - """ - pass - - - def GetItemObject(self,uItem:'typing.Any',riid:'PyIID') -> 'PyIUnknown': - """ - Description of GetItemObject. - -Args: - - uItem(typing.Any):Description for uItem - riid(PyIID):Description for riid - -Returns: - - PyIUnknown - - """ - pass - - -class PyISpecifyPropertyPages(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPages(self,) -> 'None': - """ - Description of GetPages. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIStorage(object): - """Structured storage compound storage object""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - 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 - -in this storage object. All elements within a storage object — both streams and other storage objects — are kept in - -the same name space. - -Args: - - Name(typing.Any):Name of the new stream - Mode(typing.Any):Access mode, storagecon.STGM_* - reserved1(typing.Any):Reserved - must be zero. - reserved2(typing.Any):Reserved - must be zero. - -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 - -specified access mode. - -Args: - - Name(typing.Any):Name of stream to be opened - reserved1(typing.Any):A reserved param. Always pass None. NULL is always passed to the COM function - Mode(typing.Any):Access mode, storagecon.STGM_* - reserved2(typing.Any):Reserved - must be zero. - -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 - -object. - -Args: - - Name(typing.Any):The name of the newly created stream. - Mode(typing.Any):Access mode - combination of storagecon.STGM_* flags - StgFmt(typing.Any):Documented as "reserved"! - reserved2(typing.Any):Description for reserved2 - -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 - -specified access mode. - -Args: - - Name(typing.Any):Name of the storage, or None. - Priority(PyIStorage):If the pstgPriority parameter is not None, it is a PyIStorage object to a previous opening of an element of the storage object, usually one that was opened in priority mode. The storage object should be closed and re-opened according to grfMode. When the PyIStorage::OpenStorage method returns, pstgPriority is no longer valid - use the result value. If the pstgPriority parameter is None, it is ignored. - Mode(typing.Any):Access mode - combination of storagecon.STGM_* flags (must include STGM_SHARE_EXCLUSIVE) - snbExclude(typing.Any):Reserved for later - Must be None - reserved(typing.Any):Reserved integer param. - -Returns: - - PyIStorage - - """ - pass - - - def CopyTo(self,rgiidExclude:'typing.Tuple[typing.Any, typing.Any]',snbExclude:'typing.Any',stgDest:'PyIStorage') -> 'None': - """ - Copies the entire contents of an open storage object to another storage object. - -Args: - - rgiidExclude(typing.Tuple[typing.Any, typing.Any]):List of IID's to be excluded. Use empty seq to exclude all objects, or None to indicate no excludes. - snbExclude(typing.Any):Reserved for later - Must be None - stgDest(PyIStorage):The open storage object into which this storage object is to be copied. The destination storage object can be a different implementation of the PyIStorage interface from the source storage object. Thus, IStorage::CopyTo can only use publicly available methods of the destination storage object. If stgDest is open in transacted mode, it can be reverted by calling its PyIStorage::Revert method. - -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 - -storage object. - -Args: - - Name(typing.Any):A string that contains the name of the element in this storage object to be moved or copied. - stgDest(PyIStorage):PyIStorage for the destination storage object. - NewName(typing.Any):A string that contains the new name for the element in its new storage object. - Flags(typing.Any):Specifies whether to move or copy (storagecon.STGMOVE_MOVE or STGMOVE_COPY) - -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 - -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 - -disk. For non-root storage objects in direct mode, this method has no effect. - -Args: - - grfCommitFlags(typing.Any):Controls how the changes are committed to the storage object. See the STGC enumeration for a definition of these values. - -Returns: - - None - - """ - pass - - - def Revert(self,) -> 'None': - """ - Discards all changes that have been made to the storage object since the last commit. - -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 - -storage and stream objects contained within this storage object. - -Args: - - reserved1(typing.Any):Reserved - must be zero. - reserved2(typing.Any):A reserved param. Always pass None. NULL is always passed to the COM function - reserved3(typing.Any):Reserved - must be zero. - -Returns: - - PyIEnumSTATSTG - - """ - pass - - - def DestroyElement(self,name:'str') -> 'None': - """ - Removes the specified storage or stream from this storage object. - -Args: - - name(str):The name of the element to be removed. - -Returns: - - None - - """ - pass - - - def RenameElement(self,OldName:'typing.Any',NewName:'typing.Any') -> 'None': - """ - Renames the specified substorage or stream in this storage object. - -Args: - - OldName(typing.Any):The name of the substorage or stream to be changed. - NewName(typing.Any):The new name for the specified sustorage or stream. - -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 - -element, if supported by the underlying file system. - -Args: - - name(typing.Any):The name of the storage object element whose times are to be modified. If NULL, the time is set on the root storage rather than one of its elements. - ctime(PyTime):Either the new creation time for the element or None if the creation time is not to be modified. - atime(PyTime):Either the new access time for the element or None if the access time is not to be modified. - mtime(PyTime):Either the new modification time for the element or None if the modification time is not to be modified. - -Returns: - - None - - """ - pass - - - def SetClass(self,clsid:'PyIID') -> 'None': - """ - Assigns the specified CLSID to this storage object. - -Args: - - clsid(PyIID):The class identifier (CLSID) that is to be associated with the storage object. - -Returns: - - None - - """ - pass - - - def SetStateBits(self,grfStateBits:'typing.Any',grfMask:'typing.Any') -> 'None': - """ - Stores up to 32 bits of state information in this storage object. - -Args: - - grfStateBits(typing.Any):Specifies the new values of the bits to set. No legal values are defined for these bits; they are all reserved for future use and must not be used by applications. - grfMask(typing.Any):A binary mask indicating which bits in grfStateBits are significant in this call. - -Returns: - - None - - """ - pass - - - def Stat(self,grfStatFlag:'typing.Any') -> 'STATSTG': - """ - Retrieves the STATSTG structure for this open storage object. - -Args: - - grfStatFlag(typing.Any):Specifies that some of the fields in the STATSTG structure are not returned, thus saving a memory allocation operation. Values are taken from the STATFLAG enumeration. - -Returns: - - STATSTG - - """ - pass - - -class PyIStream(object): - """A Python interface to IStream""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Read(self,numBytes:'typing.Any') -> 'str': - """ - Read the specified number of bytes from the string. - -Args: - - numBytes(typing.Any):The number of bytes to read from the stream. Must not be zero.Return ValueThe result is a string containing binary data. - -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 - - - def read(self,numBytes:'typing.Any') -> 'str': - """ - Read the specified number of bytes from the string. - -Args: - - numBytes(typing.Any):The number of bytes to read from the stream. Must not be zero.Return ValueThe result is a string containing binary data. - -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 - - - def Write(self,data:'str') -> 'None': - """ - Write data to a stream - -Args: - - data(str):The binary data to write. - -Returns: - - None - - """ - pass - - - def write(self,data:'str') -> 'None': - """ - Write data to a stream - -Args: - - data(str):The binary data to write. - -Returns: - - None - - """ - pass - - - def Seek(self,offset:'typing.Any',origin:'typing.Any') -> 'ULARGE_INTEGER': - """ - Changes the seek pointer to a new location. - -Args: - - offset(typing.Any):The new location - origin(typing.Any):Relative to where? - -Returns: - - ULARGE_INTEGER - - """ - pass - - - def SetSize(self,newSize:'ULARGE_INTEGER') -> 'None': - """ - Changes the size of the stream object. - -Args: - - newSize(ULARGE_INTEGER):The new size - -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 - -stream to the current seek pointer in another stream. - -Args: - - stream(PyIStream):The stream to write to. - cb(ULARGE_INTEGER):The number of bytes to write.Return ValueThe return value is the number of bytes actually written. - -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 - -the parent storage. - -Args: - - flags(typing.Any):Controls how changes are performed. - -Returns: - - None - - """ - pass - - - def Revert(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def LockRegion(self,offset:'ULARGE_INTEGER',cb:'ULARGE_INTEGER',lockType:'typing.Any') -> 'None': - """ - Restricts access to a specified range of bytes in the stream. - -Args: - - offset(ULARGE_INTEGER):Integer that specifies the byte offset for the beginning of the range. - cb(ULARGE_INTEGER):The number of bytes to restrict. - lockType(typing.Any):Restrictions requested. - -Returns: - - None - - """ - pass - - - def UnLockRegion(self,offset:'ULARGE_INTEGER',cb:'ULARGE_INTEGER',lockType:'typing.Any') -> 'None': - """ - None - -Args: - - offset(ULARGE_INTEGER):Integer that specifies the byte offset for the beginning of the range. - cb(ULARGE_INTEGER):The number of bytes to restrict. - lockType(typing.Any):Restrictions requested. - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIStream': - """ - Creates a new stream object with its own seek pointer that references the - -same bytes as the original stream. - -Args: - - - -Returns: - - PyIStream - - """ - pass - - - def Stat(self,grfStatFlag:'typing.Any'=0) -> 'STATSTG': - """ - Returns information about the stream - -Args: - - grfStatFlag(typing.Any):Flags. - -Returns: - - STATSTG - - """ - pass - - -class PyITask(object): - """Python object that encapsulates the ITask interface, inherits all the methods of PyIScheduledWorkItem""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetApplicationName(self,ApplicationName:'typing.Any') -> 'None': - """ - Specify which program the task will run - -Args: - - ApplicationName(typing.Any):Program to execute - -Returns: - - None - - """ - pass - - - def GetApplicationName(self,) -> 'typing.Any': - """ - Retrieve name of program that task will run - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetParameters(self,Parameters:'typing.Any') -> 'None': - """ - Sets command line parameters - -Args: - - Parameters(typing.Any):String containing command line parameters - -Returns: - - None - - """ - pass - - - def GetParameters(self,) -> 'typing.Any': - """ - Returns command line parameters for task - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetWorkingDirectory(self,WorkingDirectory:'typing.Any') -> 'None': - """ - Sets initial working directory for task - -Args: - - WorkingDirectory(typing.Any):Initial working directory - -Returns: - - None - - """ - pass - - - def GetWorkingDirectory(self,) -> 'typing.Any': - """ - Return working directory that the task will start out in - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetPriority(self,Priority:'typing.Any') -> 'None': - """ - Sets priority for task - -Args: - - Priority(typing.Any):One of REALTIME_PRIORITY_CLASS, HIGH_PRIORITY_CLASS, NORMAL_PRIORITY_CLASS, IDLE_PRIORITY_CLASS - -Returns: - - None - - """ - pass - - - def GetPriority(self,) -> 'typing.Any': - """ - Gets priority that will be assigned to process when task starts - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetTaskFlags(self,dwFlags:'typing.Any') -> 'None': - """ - Sets flag for task. - -Args: - - dwFlags(typing.Any):None currently defined - -Returns: - - None - - """ - pass - - - def GetTaskFlags(self,) -> 'typing.Any': - """ - Retrieve task flags (None currently defined) - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetMaxRunTime(self,MaxRunTimeMS:'typing.Any') -> 'None': - """ - Sets maximun run time for task, use -1 to disable - -Args: - - MaxRunTimeMS(typing.Any):Specified in milliseconds (use -1 to disable, not 0) - -Returns: - - None - - """ - pass - - - def GetMaxRunTime(self,) -> 'typing.Any': - """ - Returns maximun run time for task - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyITaskScheduler(object): - """Interface to the Windows Task Scheduler""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetTargetComputer(self,Computer:'typing.Any') -> 'None': - """ - Connect to another machine to manage its tasks - -Args: - - Computer(typing.Any):Name of system to connect toCommentsLeading backslashes are required. Call will succeed without them, but no other methods will work. - -Returns: - - None - - """ - pass - - - def GetTargetComputer(self,) -> 'typing.Any': - """ - Returns name of computer that the Task Scheduler is - -connected to - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def Enum(self,) -> 'typing.Tuple[str, ...]': - """ - Retrieve list of task names - -Args: - - - -Returns: - - typing.Tuple[str, ...] - - """ - pass - - - def Activate(self,Name:'typing.Any',riid:'PyIID') -> 'PyITask': - """ - Opens the specified task and returns an ITask interface for it - -Args: - - Name(typing.Any):Name of task to retreive - riid(PyIID):IID to return, currently only IID_ITask accepted - -Returns: - - PyITask - - """ - pass - - - def Delete(self,TaskName:'typing.Any') -> 'None': - """ - Delete task by name - -Args: - - TaskName(typing.Any):Name of task to delete - -Returns: - - None - - """ - pass - - - def NewWorkItem(self,TaskName:'typing.Any',rclsid:'PyIID',riid:'PyIID') -> 'PyITask': - """ - Creates a new task - -Args: - - TaskName(typing.Any):Name of new task - rclsid(PyIID):Class id of work item, currently only CLSID_CTask (defaults if not passed in) - riid(PyIID):Interface IID to return, currently only IID_ITask (defaults if not passed in) - -Returns: - - PyITask - - """ - pass - - - def AddWorkItem(self,TaskName:'typing.Any',WorkItem:'PyITask') -> 'None': - """ - Create a new scheduled task from PyITask object - -Args: - - TaskName(typing.Any):Name of task to be created - WorkItem(PyITask):Existing PyITask objectCommentsThe PyItask passed in is modified in place and on success is associated with the new task, not the old one - -Returns: - - None - - """ - pass - - - def IsOfType(self,Name:'typing.Any',riid:'PyIID') -> 'None': - """ - Check if named object supports specified interface - -Args: - - Name(typing.Any):Name of object - riid(PyIID):Named object is checked that it supports the interface of this IID - -Returns: - - None - - """ - pass - - -class PyITaskTrigger(object): - """Python object that encapsulates the ITaskTrigger interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetTrigger(self,Trigger:'PyTASK_TRIGGER') -> 'None': - """ - Set trigger parameters from a PyTASK_TRIGGER object - -Args: - - Trigger(PyTASK_TRIGGER):Python object representing a TASK_TRIGGER struct - -Returns: - - None - - """ - pass - - - def GetTrigger(self,) -> 'PyTASK_TRIGGER': - """ - Retrieves trigger parms as a PyTASK_TRIGGER object - -Args: - - - -Returns: - - PyTASK_TRIGGER - - """ - pass - - - def GetTriggerString(self,) -> 'str': - """ - Build text summary of trigger - -Args: - - - -Returns: - - str - - """ - pass - - -class PyITaskbarList(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def HrInit(self,) -> 'None': - """ - Intializes the interface before use - -Args: - - - -Returns: - - None - - """ - pass - - - def AddTab(self,hwnd:'int') -> 'None': - """ - Places a window on the taskbar - -Args: - - hwnd(int):Handle to window, should have WS_CAPTION style - -Returns: - - None - - """ - pass - - - def DeleteTab(self,hwnd:'int') -> 'None': - """ - Removes a window from the taskbar - -Args: - - hwnd(int):Handle to window, should have WS_CAPTION style - -Returns: - - None - - """ - pass - - - def ActivateTab(self,hwnd:'int') -> 'None': - """ - Marks a window as the active tab on the taskbar - -Args: - - hwnd(int):Handle to window, should have WS_CAPTION style - -Returns: - - None - - """ - pass - - - def SetActiveAlt(self,hwnd:'int') -> 'None': - """ - Sets the window as the active tab, without displaying it as pressed on the - -taskbar - -Args: - - hwnd(int):Handle to window, should have WS_CAPTION style - -Returns: - - None - - """ - pass - - -class PyITransferAdviseSink(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def UpdateProgress(self,SizeCurrent:'typing.Any',SizeTotal:'typing.Any',FilesCurrent:'typing.Any',FilesTotal:'typing.Any',FoldersCurrent:'typing.Any',FoldersTotal:'typing.Any') -> 'None': - """ - Gives an estimate of amount of work completed - -Args: - - SizeCurrent(typing.Any):Bytes transferred so far - SizeTotal(typing.Any):Total number of bytes - FilesCurrent(typing.Any):Number of files processed already - FilesTotal(typing.Any):Total number of files - FoldersCurrent(typing.Any):Number of folders processed already - FoldersTotal(typing.Any):Total number of folder - -Returns: - - None - - """ - pass - - - def UpdateTransferState(self,State:'typing.Any') -> 'None': - """ - Notifies client of current operation state - -Args: - - State(typing.Any):A TRANSFER_ADVISE_STATE value (shellcon.TS_*) - -Returns: - - None - - """ - pass - - - def ConfirmOverwrite(self,Source:'PyIShellItem',DestParent:'PyIShellItem',Name:'typing.Any') -> 'typing.Any': - """ - Asks user for permission to overwrite an existing item - -Args: - - Source(PyIShellItem):The item that will replace existing item - DestParent(PyIShellItem):Folder into which item will be placed - Name(typing.Any):New name for item, or None if item is to keep original name - -Returns: - - typing.Any - - """ - pass - - - def ConfirmEncryptionLoss(self,Source:'PyIShellItem') -> 'typing.Any': - """ - Notifies user when an item can't be encrypted at - -destination - -Args: - - Source(PyIShellItem):Item that failed to be encrypted - -Returns: - - typing.Any - - """ - pass - - - def FileFailure(self,Item:'PyIShellItem',ItemName:'typing.Any',Error:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Notifies user of failure, and queries how to proceed - -Args: - - Item(PyIShellItem):The shell item that caused the failure - ItemName(typing.Any):Name of item if different than above, can be None - Error(typing.Any):HRESULT error code from operationReturn ValueReturns the HRESULT and new file name if renaming resolved the failure - -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 - -proceed - -Args: - - Item(PyIShellItem):The item whose stream couldn't be created - StreamName(typing.Any):Name of the failed stream - Error(typing.Any):HRESULT failure code from operationReturn ValueReturns COPYENGINE_S_* if operation is to continue, or COPYENGINE_E_* HRESULT if cancelled - -Returns: - - typing.Any:HRESULT failure code from operationReturn ValueReturns COPYENGINE_S_* if operation is to continue, or COPYENGINE_E_* HRESULT if cancelled - - - """ - pass - - - def PropertyFailure(self,Item:'PyIShellItem',key:'PyPROPERTYKEY',Error:'typing.Any') -> 'typing.Any': - """ - Notifies user of failure to set an item's properties - -Args: - - Item(PyIShellItem):The item whose property could not be set - key(PyPROPERTYKEY):Identifies the property that caused the error, or None if all properties failed - Error(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 - -Returns: - - 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 - - -class PyITransferDestination(object): - """Implemented by shell extensions that act as targets for item copy or move operations""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Advise(self,Sink:'PyITransferAdviseSink') -> 'typing.Any': - """ - Connects an advise sink - -Args: - - Sink(PyITransferAdviseSink):Event sink to receive notificationsReturn ValueReturns an id for the connection, to be passed to PyITransferDestination::Unadvise - -Returns: - - typing.Any:Event sink to receive notificationsReturn ValueReturns an id for the connection, to be passed to PyITransferDestination::Unadvise - - - """ - pass - - - def Unadvise(self,Cookie:'typing.Any') -> 'None': - """ - Disconnects an advise sink - -Args: - - Cookie(typing.Any):Connection identifier as returned by PyITransferDestination::Advise - -Returns: - - None - - """ - pass - - - def CreateItem(self,Name:'typing.Any',Attributes:'typing.Any',Size:'typing.Any',Flags:'typing.Any',riidItem:'PyIID',riidResources:'PyIID') -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': - """ - Requests that a new item be created - -Args: - - Name(typing.Any):Filename to be created - Attributes(typing.Any):File attributes - Size(typing.Any):Size of file - Flags(typing.Any):Combination of shellcon.TSF_* flags - riidItem(PyIID):Item interface to return - riidResources(PyIID):Resource interface to returnReturn ValueReturns the HRESULT and requested interfaces. Interfaces may be None if function returns one of the informational codes (shellcon.COPYENGINE_S_*) - -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 - -function returns one of the informational codes (shellcon.COPYENGINE_S_*) - - - """ - pass - - -class PyITransferMediumItem(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyITransferSource(object): - """Implemented by shell folders that can act as the source of shell item operations""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Advise(self,Sink:'PyITransferAdviseSink') -> 'typing.Any': - """ - Connects an advise sink to receive notifications - -Args: - - Sink(PyITransferAdviseSink):Event sink to respond to notifications - -Returns: - - typing.Any - - """ - pass - - - def Unadvise(self,Cookie:'typing.Any') -> 'None': - """ - Disconnects an event sink - -Args: - - Cookie(typing.Any):Connection id as returned by PyITransferSource::Advise - -Returns: - - None - - """ - pass - - - def SetProperties(self,proparray:'PyIPropertyChangeArray') -> 'None': - """ - Specifies changes to be applied to items' properties - -Args: - - proparray(PyIPropertyChangeArray):Property changes to be applied by PyITransferSource::ApplyPropertiesToItem - -Returns: - - None - - """ - pass - - - def OpenItem(self,Item:'PyIShellItem',flags:'typing.Any',riid:'PyIID') -> 'typing.Tuple[typing.Any, PyIShellItemResources]': - """ - Initiates the copying of an item - -Args: - - Item(PyIShellItem):The item to be copied. - flags(typing.Any):Combination of shellcon.TSF_* flags - riid(PyIID):The interface to return - -Returns: - - typing.Tuple[typing.Any, PyIShellItemResources] - - """ - pass - - - def MoveItem(self,Item:'PyIShellItem',ParentDst:'PyIShellItem',NameDst:'typing.Any',flags:'typing.Any') -> 'typing.Tuple[typing.Any, PyIShellItem]': - """ - Moves a shell item into another folder - -Args: - - Item(PyIShellItem):Item to be moved - ParentDst(PyIShellItem):The folder into which it will be moved - NameDst(typing.Any):New name for item after move, None to keep same name - flags(typing.Any):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 of expected actions for specific error codes. - -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 - -when the code in one of the informational COPYENGINE_S_* values. See MSDN for descriptions - -of expected actions for specific error codes. - - - """ - pass - - - def RecycleItem(self,Source:'PyIShellItem',ParentDest:'PyIShellItem',flags:'typing.Any') -> 'typing.Tuple[typing.Any, PyIShellItem]': - """ - Moves an item to the recycle bin - -Args: - - Source(PyIShellItem):The item to be recycled - ParentDest(PyIShellItem):Shell item representing the recycle bin - flags(typing.Any):Combination of shellcon.TSF_* flags - -Returns: - - typing.Tuple[typing.Any, PyIShellItem] - - """ - pass - - - def RemoveItem(self,Source:'PyIShellItem',flags:'typing.Any') -> 'typing.Any': - """ - Deletes an item without recycling - -Args: - - Source(PyIShellItem):The item to be deleted - flags(typing.Any):Combination of shellcon.TSF_* flagsReturn ValueReturns the HRESULT of the operation - -Returns: - - typing.Any:Combination of shellcon.TSF_* flagsReturn ValueReturns the HRESULT of the operation - - - """ - pass - - - def RenameItem(self,Source:'PyIShellItem',NewName:'typing.Any',flags:'typing.Any') -> 'typing.Tuple[typing.Any, PyIShellItem]': - """ - Renames a shell item - -Args: - - Source(PyIShellItem):Item to be renamed - NewName(typing.Any):The name to be given to the item - flags(typing.Any):Combination of shellcon.TSF_* flags - -Returns: - - typing.Tuple[typing.Any, PyIShellItem] - - """ - pass - - - def LinkItem(self,Source:'PyIShellItem',ParentDest:'PyIShellItem',NewName:'typing.Any',flags:'typing.Any') -> 'typing.Tuple[typing.Any, PyIShellItem]': - """ - Not implemented, according to MSDN - -Args: - - Source(PyIShellItem):Description for psiSource - ParentDest(PyIShellItem):Description for psiParentDest - NewName(typing.Any):Description for NewName - flags(typing.Any):Combination of shellcon.TSF_* flags - -Returns: - - typing.Tuple[typing.Any, PyIShellItem] - - """ - pass - - - def ApplyPropertiesToItem(self,Source:'PyIShellItem') -> 'PyIShellItem': - """ - None - -Args: - - Source(PyIShellItem):Item whose properties are to be changed - -Returns: - - PyIShellItem - - """ - pass - - - def GetDefaultDestinationName(self,Source:'PyIShellItem',ParentDest:'PyIShellItem') -> 'typing.Any': - """ - Determines the name of an item as it would appear in a - -given folder - -Args: - - Source(PyIShellItem):The item whose name is wanted - ParentDest(PyIShellItem):The destination folder - -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 - -operation - -Args: - - ChildFolderDest(PyIShellItem):The destination folder for the operation - -Returns: - - typing.Any - - """ - pass - - - def LeaveFolder(self,ChildFolderDest:'PyIShellItem') -> 'typing.Any': - """ - Informs the copy engine that the operation on a destination folder is - -finished - -Args: - - ChildFolderDest(PyIShellItem):Destination folder - -Returns: - - typing.Any - - """ - pass - - -class PyITypeComp(object): - """An object that implements the ITypeComp interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Bind(self,szName:'str',wflags:'typing.Any'=0) -> 'typing.Any': - """ - binds to a variable/type - -Args: - - szName(str):The name to bind to - wflags(typing.Any):the bind flags - -Returns: - - typing.Any - - """ - pass - - - def BindType(self,szName:'str') -> 'typing.Any': - """ - binds to a type - -Args: - - szName(str):The name to bind to - -Returns: - - typing.Any - - """ - pass - - -class PyITypeInfo(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetContainingTypeLib(self,) -> 'typing.Tuple[PyITypeLib, typing.Any]': - """ - Retrieves the containing type library and the index of - -the type description within that type library. - -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, - -the complete Help file name and path, and the context ID for the Help topic for a specified type description. - -Args: - - memberId(typing.Any): - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - - """ - pass - - - def GetFuncDesc(self,memberId:'typing.Any') -> 'FUNCDESC': - """ - None - -Args: - - memberId(typing.Any): - -Returns: - - FUNCDESC - - """ - pass - - - def GetImplTypeFlags(self,index:'typing.Any') -> 'typing.Any': - """ - Retrieves the IMPLTYPEFLAGS enumeration for one implemented interface or - -base interface in a type description. - -Args: - - index(typing.Any): - -Returns: - - typing.Any - - """ - pass - - - def GetIDsOfNames(self,) -> 'typing.Any': - """ - Maps between member names and member IDs, and parameter names and parameter - -IDs. - -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 - -the property or method and its parameters) that correspond to the specified function ID. - -Args: - - memberId(typing.Any): - -Returns: - - typing.Any - - """ - pass - - - def GetTypeAttr(self,) -> 'TYPEATTR': - """ - None - -Args: - - - -Returns: - - TYPEATTR - - """ - pass - - - def GetRefTypeInfo(self,hRefType:'typing.Any') -> 'PyITypeInfo': - """ - If a type description references other type descriptions, it - -retrieves the referenced type descriptions. - -Args: - - hRefType(typing.Any): - -Returns: - - PyITypeInfo - - """ - pass - - - def GetRefTypeOfImplType(self,hRefType:'typing.Any') -> 'typing.Any': - """ - Retrieves the type description of the implemented interface types. - -Args: - - hRefType(typing.Any):CommentsIf a type description describes a COM class, it retrieves the type description of the implemented interface types. For an interface, GetRefTypeOfImplType returns the type information for inherited interfaces, if any exist. - -Returns: - - typing.Any - - """ - pass - - - def GetVarDesc(self,memberId:'typing.Any') -> 'VARDESC': - """ - None - -Args: - - memberId(typing.Any): - -Returns: - - VARDESC - - """ - pass - - - def GetTypeComp(self,) -> 'PyITypeComp': - """ - None - -Args: - - - -Returns: - - PyITypeComp - - """ - pass - - -class PyITypeLib(object): - """An object that implements the ITypeLib interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDocumentation(self,index:'typing.Any') -> 'typing.Any': - """ - Retrieves documentation information about the library. - -Args: - - index(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) - -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 - - - def GetLibAttr(self,) -> 'TLIBATTR': - """ - Retrieves the libraries attributes - -Args: - - - -Returns: - - TLIBATTR - - """ - pass - - - def GetTypeComp(self,) -> 'PyITypeComp': - """ - None - -Args: - - - -Returns: - - PyITypeComp - - """ - pass - - - def GetTypeInfo(self,index:'typing.Any') -> 'PyITypeInfo': - """ - Retrieves the specified type description in the library. - -Args: - - index(typing.Any):The index of the type description within the library - -Returns: - - PyITypeInfo - - """ - pass - - - def GetTypeInfoCount(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetTypeInfoOfGuid(self,iid:'PyIID') -> 'PyITypeInfo': - """ - Retrieves the type info of the specified GUID. - -Args: - - iid(PyIID):GUID of the type description. - -Returns: - - PyITypeInfo - - """ - pass - - - def GetTypeInfoType(self,index:'typing.Any') -> 'typing.Any': - """ - Retrieves the type of a type description. - -Args: - - index(typing.Any):The index of the type description within the library - -Returns: - - typing.Any - - """ - pass - - -class PyIUniformResourceLocator(object): - """Interface to an internet shortcut""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetURL(self,) -> 'typing.Any': - """ - Returns the URL for the shortcut - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetURL(self,URL:'typing.Any',InFlags:'typing.Any'=0) -> 'None': - """ - Sets the URL for the shortcut - -Args: - - URL(typing.Any):The url to be set - InFlags(typing.Any):One of the shellcon.IURL_SETURL* flags - -Returns: - - None - - """ - pass - - - def InvokeCommand(self,Verb:'typing.Any',Flags:'typing.Any'=0,hwndParent:'int'=0) -> 'typing.Any': - """ - Performs one of the object's predefined actions - -Args: - - Verb(typing.Any):The verb to be invoked - Flags(typing.Any):Combination of shellcon.IURL_INVOKECOMMAND_* flags - hwndParent(int):Handle to parent window - -Returns: - - typing.Any - - """ - pass - - -class PyIUnknown(object): - """The base object for all PythonCOM objects. Wraps a COM IUnknown object.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def QueryInterface(self,iid:'typing.Any',useIID:'typing.Any'=None) -> 'PyIUnknown': - """ - Queries an object for a specific interface. - -Args: - - iid(typing.Any):The IID requested. - useIID(typing.Any):If provided and not None, will return an 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.CommentsThe useIID parameter is a very dangerous option, and should only be used when you are sure you need it! 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 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. For example, this option can be used to obtain a PyIUnknown object if pythoncom does not natively support the interface. Another example might be to return an unsupported persistence interface as a PyIPersist instance. 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. Any error (including E_NOINTERFACE) will generate a com_error exception. - -Returns: - - 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. - -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 - -be used when you are sure you need it! - -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 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. - -For example, this option can be used to obtain a PyIUnknown object if - -pythoncom does not natively support the interface. - -Another example might be to return an unsupported persistence interface as a - -PyIPersist instance. - -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. - -Any error (including E_NOINTERFACE) will generate a com_error exception. - - - """ - pass - - -class PyIViewObject(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Draw(self,dwDrawAspect:'typing.Any',lindex:'typing.Any',aspectFlags:'typing.Any',hdcTargetDev:'typing.Any',hdcDraw:'typing.Any',arg:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',arg1:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',funcContinue:'typing.Any',obContinue:'typing.Any') -> 'None': - """ - Description of Draw. - -Args: - - dwDrawAspect(typing.Any):Description for dwDrawAspect - lindex(typing.Any):Description for lindex - aspectFlags(typing.Any):Integer value for the dwFlags item of the DVASPECTINFO structure. - hdcTargetDev(typing.Any):Description for hdcTargetDev - hdcDraw(typing.Any):Description for hdcDraw - arg(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Bounds rectangle. - arg1(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):WBounds rectangle. - funcContinue(typing.Any):A continue function. - obContinue(typing.Any):Value passed to the function. - -Returns: - - None - - """ - pass - - - def GetColorSet(self,dwDrawAspect:'typing.Any',lindex:'typing.Any',aspectFlags:'typing.Any',hicTargetDev:'typing.Any') -> 'None': - """ - Description of GetColorSet. - -Args: - - dwDrawAspect(typing.Any):Description for dwDrawAspect - lindex(typing.Any):Description for lindex - aspectFlags(typing.Any):Integer value for the dwFlags item of the DVASPECTINFO structure. - hicTargetDev(typing.Any):Description for hicTargetDev - -Returns: - - None - - """ - pass - - - def Freeze(self,dwDrawAspect:'typing.Any',lindex:'typing.Any',aspectFlags:'typing.Any') -> 'None': - """ - Description of Freeze. - -Args: - - dwDrawAspect(typing.Any):Description for dwDrawAspect - lindex(typing.Any):Description for lindex - aspectFlags(typing.Any):Integer value for the dwFlags item of the DVASPECTINFO structure. - -Returns: - - None - - """ - pass - - - def Unfreeze(self,dwFreeze:'typing.Any') -> 'None': - """ - Description of Unfreeze. - -Args: - - dwFreeze(typing.Any):Description for dwFreeze - -Returns: - - None - - """ - pass - - - def SetAdvise(self,aspects:'typing.Any',advf:'typing.Any',pAdvSink:'typing.Any') -> 'None': - """ - Description of SetAdvise. - -Args: - - aspects(typing.Any):Description for aspects - advf(typing.Any):Description for advf - pAdvSink(typing.Any):Description for pAdvSink - -Returns: - - None - - """ - pass - - - def GetAdvise(self,) -> 'None': - """ - Description of GetAdvise. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIViewObject2(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetExtent(self,dwDrawAspect:'typing.Any',lindex:'typing.Any',targetDevice:'typing.Any') -> 'None': - """ - Description of GetExtent. - -Args: - - dwDrawAspect(typing.Any):Description for dwDrawAspect - lindex(typing.Any):Description for lindex - targetDevice(typing.Any):Description for lindex - -Returns: - - None - - """ - pass - - -class PyMAPINAMEIDArray(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyOLEMENUGROUPWIDTHS(object): - """Tuple containing 6 ints indicating nbr of options in each menu group""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyPROPERTYKEY(object): - """A tuple of a fmtid and property id (IID, int) that uniquely identifies a property""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyPROPVARIANT(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def vt(self)->'typing.Any': - """The variant type, a combination of VARENUM values including flags. (read only)MethodsGetValueReturns an object representing the variant value ToStringReturns the value as a string ChangeTypeCoerce to a different variant type """ - pass - - - def GetValue(self,) -> 'typing.Any': - """ - Returns an object representing the variant value - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def ToString(self,) -> 'typing.Any': - """ - Returns the value as a string - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def ChangeType(self,Type:'typing.Any',Flags:'typing.Any'=0) -> 'PyPROPVARIANT': - """ - Coerce to a different variant type - -Args: - - Type(typing.Any):New variant type, combination of pythoncom.VT_* values - Flags(typing.Any):Reserved (PROPVAR_CHANGE_FLAGS)Win32 API References - -Returns: - - PyPROPVARIANT - - """ - pass - - -class PySAndRestriction(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySBinaryArray(object): - """A sequence of strings containing binary data.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySBitMaskRestriction(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySContentRestriction(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySExistRestriction(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySHELL_ITEM_RESOURCE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySNotRestriction(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySOrRestriction(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySPropTagArray(object): - """A sequence of integers""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySPropValue(object): - """A MAPI property value. Property values can either be passed from - -python into MAPI functions, or returned from MAPI functions to Python.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySPropValueArray(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySPropertyRestriction(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySRestriction(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySRow(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySRowSet(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySSortOrderItem(object): - """An item in a SortOrderSet.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySSortOrderSet(object): - """An object describing a SortOrderSet.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySTGMEDIUM(object): - """A STGMEDIUM object represents a COM STGMEDIUM structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def tymed(self)->'typing.Any': - """An integer indicating the type of data in the stgmedium""" - pass - - - @property - def data(self)->'typing.Any': - """The data in the stgmedium. The result depends on the value of the 'tymed' property of the PySTGMEDIUM object.tymedResult TypeTYMED_GDIAn integer GDI handleTYMED_MFPICTAn integer METAFILE handleTYMED_ENHMFAn integer ENHMETAFILE handleTYMED_HGLOBALA string with the bytes of the global memory object.TYMED_FILEA string/unicode filenameTYMED_ISTREAMA PyIStream objectTYMED_ISTORAGEA PyIStorage object""" - pass - - - @property - def data_handle(self)->'typing.Any': - """The raw 'integer' representation of the data. For TYMED_HGLOBAL, this is the handle rather than the string data. For the string and interface types, this is an integer holding the pointer.""" - pass - - - def set(self,tymed:'typing.Any',data:'typing.Any') -> 'None': - """ - Sets the type and data of the object. - -Args: - - tymed(typing.Any):The type of the data - data(typing.Any): - -Returns: - - None - - """ - pass - - -class PyTASK_TRIGGER(object): - """Python object representing a TASK_TRIGGER structure via the structmember Api""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class RTF_WCSINFO(object): - """A tuple representing a RTF_WCSINFO structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SHFILEINFO(object): - """A tuple representing a SHFILEINFO structure - -Represented as a tuple of (hIcon, iIcon, dwAttributes, displayName, typeName)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SHFILEOPSTRUCT(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SI_ACCESS(object): - """Tuple of 4 items representing SI_ACCESS struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SI_INHERIT_TYPE(object): - """Tuple of 3 items describing a method of inheritance""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SI_OBJECT_INFO(object): - """Six-tuple representing SI_OBJECT_INFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class STATSTG(object): - """A tuple representing a STATSTG structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class TLIBATTR(object): - """Type library attributes are represented as a tuple of:""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class TYPEATTR(object): - """A TYPEATTR object represents a COM TYPEATTR structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def iid(self)->'PyIID': - """The IID""" - pass - - - @property - def lcid(self)->'typing.Any': - """The lcid""" - pass - - - @property - def memidConstructor(self)->'typing.Any': - """ID of constructor""" - pass - - - @property - def memidDestructor(self)->'typing.Any': - """ID of destructor""" - pass - - - @property - def cbSizeInstance(self)->'typing.Any': - """The size of an instance of this type""" - pass - - - @property - def typekind(self)->'typing.Any': - """The kind of type this information describes. One of the win32con.TKIND_* constants.""" - pass - - - @property - def cFuncs(self)->'typing.Any': - """Number of functions.""" - pass - - - @property - def cVars(self)->'typing.Any': - """Number of variables/data members.""" - pass - - - @property - def cImplTypes(self)->'typing.Any': - """Number of implemented interfaces.""" - pass - - - @property - def cbSizeVft(self)->'typing.Any': - """The size of this type's VTBL""" - pass - - - @property - def cbAlignment(self)->'typing.Any': - """Byte alignment for an instance of this type.""" - pass - - - @property - def wTypeFlags(self)->'typing.Any': - """One of the pythoncom TYPEFLAG_""" - pass - - - @property - def wMajorVerNum(self)->'typing.Any': - """Major version number.""" - pass - - - @property - def wMinorVerNum(self)->'typing.Any': - """Minor version number.""" - pass - - - @property - def tdescAlias(self)->'TYPEDESC': - """If TypeKind == pythoncom.TKIND_ALIAS, specifies the type for which this type is an alias.""" - pass - - - @property - def idldeskType(self)->'IDLDESC': - """IDL attributes of the described type.""" - pass - - -class TYPEDESC(object): - """A typedesc is a complicated, recursive 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 ...""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class VARDESC(object): - """A VARDESC object represents a COM VARDESC structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def memid(self)->'typing.Any': - """The dispid of the member""" - pass - - - @property - def value(self)->'typing.Union[typing.Any]': - """A value for the variant. If PERINSTANCE then an offset into the instance, otherwise a variant converted to a Python object.""" - pass - - - @property - def elemdescVar(self)->'ELEMDESC': - """Object describing the member.""" - pass - - - @property - def varFlags(self)->'typing.Any': - """Variable flags""" - pass - - - @property - def varkind(self)->'typing.Any': - """Kind flags.""" - pass - - -class CHARFORMAT(object): - """Describes a CHARFORMAT tuple""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class CREATESTRUCT(object): - """A representation of a Windows CREATESTRUCT structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class LV_COLUMN(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class LV_ITEM(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PARAFORMAT(object): - """Describes a PARAFORMAT tuple""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyAssocCObject(object): - """An internal class.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyAssocObject(object): - """An internal class.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AttachObject(self,) -> 'None': - """ - Attaches a Python object for lookup of "virtual" functions. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetAttachedObject(self,) -> 'typing.Any': - """ - Returned the attached Python object, or None. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyCBitmap(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateCompatibleBitmap(self,dc:'PyCDC',width:'typing.Any',height:'typing.Any') -> 'None': - """ - Creates a bitmap compatible with the specified device context. - -Args: - - dc(PyCDC):Specifies the device context. - width(typing.Any):The width (in bits) of the bitmap - height(typing.Any):The height (in bits) of the bitmap. - -Returns: - - None - - """ - pass - - - def GetSize(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Returns the size of the bitmap object. - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def GetHandle(self,) -> 'typing.Any': - """ - Returns the HBITMAP for a bitmap object - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def LoadBitmap(self,idRes:'typing.Any',obDLL:'PyDLL'=None) -> 'None': - """ - Loads a bitmap from a DLL object. - -Args: - - idRes(typing.Any):The resource ID of the bitmap - obDLL(PyDLL):The DLL object to load from. - -Returns: - - None - - """ - pass - - - def LoadBitmapFile(self,fileObject:'typing.Any') -> 'None': - """ - Loads a bitmap (.BMP) format - -from a file object. - -Args: - - fileObject(typing.Any):The file object to load the .BMP format file from. - -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 - -from a file object. - -Args: - - fileObject(typing.Any):The file object to load the PPM format file from. - cols(typing.Any):The number of columns in the bitmap. - rows(typing.Any):The number of rows in the bitmap. - -Returns: - - None - - """ - pass - - - def Paint(self,dcObject:'PyCDC',arg:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',arg1:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]') -> 'None': - """ - Paint a bitmap. - -Args: - - dcObject(PyCDC):The DC object to paint the bitmap to. - arg(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The destination rectangle to paint to. - arg1(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The source rectangle to paint from. - -Returns: - - None - - """ - pass - - - def GetInfo(self,) -> 'typing.Any': - """ - Returns the BITMAP structure info - -Args: - - - -Returns: - - typing.Any:PyCBitmap.GetInfo - -dict = GetInfo()Returns the BITMAP structure info -Return ValueA dictionary of integers, keyed by the following strings: - -bmType - -bmWidth - -bmHeight - -bmWidthBytes - -bmPlanes - -bmBitsPixel - - - """ - pass - - - def GetBitmapBits(self,asString:'typing.Any'=0) -> 'typing.Union[str, typing.Any]': - """ - Returns the bitmap bits. - -Args: - - asString(typing.Any):If False, the result is a tuple of integers, if True, the result is a Python string - -Returns: - - typing.Union[str, typing.Any] - - """ - pass - - - def SaveBitmapFile(self,dcObject:'PyCDC',Filename:'str') -> 'typing.Any': - """ - Saves a bitmap to a file. - -Args: - - dcObject(PyCDC):The DC object that has rendered the bitmap. - Filename(str):The file to save the bitmap to - -Returns: - - typing.Any - - """ - pass - - -class PyCBrush(object): - """An object encapsulating an MFC PyCBrush class.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateSolidBrush(self,) -> 'None': - """ - Initializes a brush with a specified solid color. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetSafeHandle(self,) -> 'typing.Any': - """ - Retrieves the HBRUSH for the brush as an integer - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyCButton(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,caption:'str',style:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',parent:'PyCWnd',_id:'typing.Any') -> 'None': - """ - Creates the window for a new button object. - -Args: - - caption(str):The caption (text) for the button. - style(typing.Any):The style for the button. Use any of the win32con.BS_* constants. - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The size and position of the button. - parent(PyCWnd):The parent window of the button. Usually a PyCDialog. - _id(typing.Any):The buttons control ID. - -Returns: - - None - - """ - pass - - - def GetBitmap(self,) -> 'typing.Any': - """ - Get the button's bitmap - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetBitmap(self,hBitmap:'typing.Any'=1) -> 'typing.Any': - """ - Set the button's bitmap - -Args: - - hBitmap(typing.Any):Handle of the new bitmap - -Returns: - - typing.Any - - """ - pass - - - def GetCheck(self,) -> 'typing.Any': - """ - Retrieves the check state of a radio button or check box. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetCheck(self,idCheck:'typing.Any') -> 'None': - """ - Sets or resets the state of a radio button or check box. - -Args: - - idCheck(typing.Any):The ID of the button. - -Returns: - - None - - """ - pass - - - def GetState(self,) -> 'typing.Any': - """ - Returns the state of the button. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetState(self,bHighlight:'typing.Any') -> 'typing.Any': - """ - Sets the state of the button. - -Args: - - bHighlight(typing.Any):The new state for the button.CommentsHighlighting affects the exterior of a button control. It has no effect on the check state of a radio button or check box. - -Returns: - - typing.Any - - """ - pass - - - def GetButtonStyle(self,) -> 'typing.Any': - """ - Gets the style of the button. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetButtonStyle(self,style:'typing.Any',bRedraw:'typing.Any'=1) -> 'typing.Any': - """ - Sets the style of the button. - -Args: - - style(typing.Any):The new style for the button. - bRedraw(typing.Any):Should the button be redrawn? - -Returns: - - typing.Any - - """ - pass - - -class PyCCmdTarget(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def BeginWaitCursor(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def EndWaitCursor(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def HookCommand(self,obHandler:'typing.Any',_id:'typing.Any') -> 'typing.Any': - """ - Hook a windows command handler. - -Args: - - obHandler(typing.Any):The handler for the command message. This must be a callable object. - _id(typing.Any):The ID of the command to be handled, or zero to handle all command messages.CommentsobHandler 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. When updating a user interface element, Pythonwin will first check if a handler has been installed via PyCCmdTarget::HookCommandUpdate. If so, this alone 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 The handler will be called with 2 arguments * The command id being handled. * The command notification code. If the handler returns TRUE, then the command will be passed on to the default handler, otherwise the message will be consumed. This method is best suited to handling messages from user interface elements, such as menus, toolbars, etc. To handle notification messages from a control, you should use PyCCmdTarget::HookNotifyReturn ValueThe return value is the previous handler, or None. - -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. - -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 - -handler has been installed via PyCCmdTarget::HookCommandUpdate. If so, this alone - -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 - -The handler will be called with 2 arguments - -* The command id being handled. - -* The command notification code. - -If the handler returns TRUE, then the command will be passed on to the - -default handler, otherwise the message will be consumed. - -This method is best suited to handling messages from user interface - -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 - - - def HookCommandUpdate(self,obHandler:'typing.Any',_id:'typing.Any') -> 'typing.Any': - """ - Hook a windows command update handler. - -Args: - - obHandler(typing.Any):The handler for the command message. This must be a callable object. - _id(typing.Any):The ID of the command to be handled.CommentsThe handler object passed will be called as the application updates user interface elements with the specified ID. 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. - -Returns: - - typing.Any:The ID of the command to be handled.Comments - -The handler object passed will be called as - -the application updates user interface elements - -with the specified ID. - -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 - - - def HookOleEvent(self,) -> 'typing.Any': - """ - Hook an OLE Event. - -Args: - - - -Returns: - - typing.Any:PyCCmdTarget.HookOleEvent - -object = HookOleEvent()Hook an OLE Event. -Return ValueThe return value is the previous handler, or None. - - - """ - pass - - - def HookNotify(self,obHandler:'typing.Any',_id:'typing.Any') -> 'typing.Any': - """ - Hook a windows command handler. - -Args: - - obHandler(typing.Any):The handler for the command message. This must be a callable object. - _id(typing.Any):The ID of the command to be handled, or zero to handle all command messages.CommentsobHandler will be called as the application receives control notification messages. 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 A tuple describing standard notification information. 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, otherwise the message will be consumed.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 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 can install certain knowledge about handlers, but this has not been implemented.)Return ValueThe return value is the previous handler, or None. - -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. - -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 - -A tuple describing standard notification information. - -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, - -otherwise the message will be consumed. - -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 - -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 - -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 - -changed. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCCmdUI(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def m_nIndex(self)->'typing.Any': - """""" - pass - - - @property - def m_nID(self)->'typing.Any': - """""" - pass - - - @property - def m_pMenu(self)->'PyCMenu': - """""" - pass - - - @property - def m_pSubMenu(self)->'PyCMenu': - """""" - pass - - - def Enable(self,bEnable:'typing.Any'=1) -> 'None': - """ - Enables or disables the user-interface item for this command. - -Args: - - bEnable(typing.Any):TRUE if the item should be enabled, false otherwise. - -Returns: - - None - - """ - pass - - - def SetCheck(self,state:'typing.Any'=1) -> 'None': - """ - Sets the check state of the user-interface item for this command. - -Args: - - state(typing.Any):0 for unchecked, 1 for checked, or 2 for indeterminate. - -Returns: - - None - - """ - pass - - - def SetRadio(self,bOn:'typing.Any'=1) -> 'None': - """ - Like the SetCheck member function, but operates on radio groups. - -Args: - - bOn(typing.Any):TRUE if the item should be enabled, false otherwise. - -Returns: - - None - - """ - pass - - - def SetText(self,text:'str') -> 'None': - """ - Sets the text for the user-interface item for this command. - -Args: - - text(str):The text for the interface element. - -Returns: - - None - - """ - pass - - - def ContinueRouting(self,) -> 'None': - """ - Tells the command-routing mechanism to continue routing the current message down - -the chain of handlers. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCColorDialog(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetColor(self,) -> 'typing.Any': - """ - Determines the selected color. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def DoModal(self,) -> 'typing.Any': - """ - Displays a dialog and allows the user to make a selection. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetSavedCustomColors(self,) -> 'typing.Any': - """ - Returns the saved custom colors. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetCurrentColor(self,color:'typing.Any') -> 'None': - """ - Sets the currently selected color. - -Args: - - color(typing.Any):The color to set.MFC References - -Returns: - - None - - """ - pass - - - def SetCustomColors(self,) -> 'None': - """ - Sets one or more custom colors - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCustomColors(self,) -> 'typing.Tuple[typing.Any, ...]': - """ - Gets the 16 currently defined custom colors - -Args: - - - -Returns: - - typing.Tuple[typing.Any, ...] - - """ - pass - - -class PyCComboBox(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddString(self,_object:'typing.Any') -> 'typing.Any': - """ - Adds a string to a combobox. - -Args: - - _object(typing.Any):Any object. If not a string, __str__, __repr__ or a default repr() will be usedMFC References - -Returns: - - typing.Any:CComboBox::AddString -Return ValueThe zero based index of the new string. - - - """ - pass - - - def DeleteString(self,pos:'typing.Any') -> 'typing.Any': - """ - Deletes an item from a combobox. - -Args: - - pos(typing.Any):The zero based index of the item to delete.MFC References - -Returns: - - typing.Any:CComboBox::DeleteString -Return ValueThe count of the items remaining in the list. - - - """ - pass - - - def Dir(self,attr:'typing.Any',wild:'str') -> 'typing.Any': - """ - Fills the list portion of a combobox with a directory listing. - -Args: - - attr(typing.Any):The attributes of the files to locate - wild(str):A file specification string - eg, *.*MFC References - -Returns: - - typing.Any:CComboBox::Dir -Return ValueThe index of the last file name added to the list. - - - """ - pass - - - def GetCount(self,) -> 'typing.Any': - """ - Returns the count of items in the combobox. - -Args: - - - -Returns: - - typing.Any:CListBox::GetCount -Return ValueReturns the number of items currently in the combobox. - - - """ - pass - - - def GetCurSel(self,) -> 'typing.Any': - """ - Returns the index of the currently selected item. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetEditSel(self,) -> 'typing.Any': - """ - Returns the selection of the edit control portion of a combo box. - -Args: - - - -Returns: - - typing.Any:CComboBox::GetEditSel -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 selection in the high-order word. If this function is used on a combo box - -without an edit control, an exception is raised. - - - """ - pass - - - def GetExtendedUI(self,) -> 'typing.Any': - """ - Indicates if the combo has the extended interface. - -Args: - - - -Returns: - - typing.Any:CComboBox::GetExtendedUI -Return ValueNonzero if the combo box has the extended user interface; otherwise 0. - - - """ - pass - - - def GetItemData(self,item:'typing.Any') -> 'typing.Any': - """ - Retrieves the application-specific object associated with an item. - -Args: - - item(typing.Any):The index of the item whose data is to be retrieved. - -Returns: - - typing.Any - - """ - pass - - - def GetItemValue(self,item:'typing.Any') -> 'typing.Any': - """ - Retrieves the application-specific value associated with an item. - -Args: - - item(typing.Any):The index of the item whose data is to be retrieved. - -Returns: - - typing.Any - - """ - pass - - - def GetLBText(self,index:'typing.Any') -> 'str': - """ - Gets the string from the list of a combo box. - -Args: - - index(typing.Any):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. - -Returns: - - 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 - - - def GetLBTextLen(self,index:'typing.Any') -> 'typing.Any': - """ - Returns the length of a string in the list of a combobox. - -Args: - - index(typing.Any):The index of the item to return the length of.MFC References - -Returns: - - typing.Any - - """ - pass - - - def InsertString(self,pos:'typing.Any',_object:'typing.Any') -> 'typing.Any': - """ - Insert a string into a combobox. - -Args: - - pos(typing.Any):The zero based index in the combobox to insert the new string - _object(typing.Any):The object to be added to the comboboxMFC References - -Returns: - - typing.Any:CComboBox::InsertString -Return ValueThe zero based index of the new string added. - - - """ - pass - - - def LimitText(self,_max:'typing.Any') -> 'typing.Any': - """ - Limits the amount of text the edit portion of a combo box can hold. - -Args: - - _max(typing.Any):The maximum number of characters the user can enter. If zero, the size is set to (virtually) unlimited.MFC References - -Returns: - - typing.Any - - """ - pass - - - def ResetContent(self,) -> 'None': - """ - Clear all the items from a combobox. - -Args: - - - -Returns: - - None - - """ - pass - - - def SelectString(self,after:'typing.Any',string:'str') -> 'None': - """ - Searches for a combobox item that matches the specified string, and selects it. - -Args: - - after(typing.Any):Contains the zero-based index of the item before the first item to be searched, or -1 for the entire combobox. - string(str):The string to search for.MFC References - -Returns: - - None:CComboBoxBox::SelectString -Return ValueThe return value is always None - an exception is raised if the string can not be located. - - - """ - pass - - - def SetCurSel(self,index:'typing.Any') -> 'None': - """ - Selects an item in a combobox. - -Args: - - index(typing.Any):The zero based index of the item to select.MFC References - -Returns: - - None - - """ - pass - - - def SetEditSel(self,start:'typing.Any',end:'typing.Any') -> 'None': - """ - Sets the selection in the edit control portion of a combo box. - -Args: - - start(typing.Any):Specifies the starting position. If the starting position is set to -1, then any existing selection is removed. - end(typing.Any):Specifies the ending position. If the ending position is set to -1, then all text from the starting position to the last character in the edit control is selected.MFC References - -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 - -have an edit control. - - - """ - pass - - - def SetExtendedUI(self,bExtended:'typing.Any'=1) -> 'None': - """ - Selects the Extended UI mode for a combo box. - -Args: - - bExtended(typing.Any):Indicates if the combo should have the extended user interface.CommentsA combo box with the Extended UI flag set can be identified in the following ways:~ Clicking the static control displays the list box only for combo boxes with the CBS_DROPDOWNLIST style.~ Pressing the DOWN ARROW key displays the list box (F4 is disabled).~ Scrolling in the static control is disabled when the item list is not visible (the arrow keys are disabled).MFC References - -Returns: - - None - - """ - pass - - - def SetItemData(self,item:'typing.Any',Data:'typing.Any') -> 'typing.Any': - """ - Sets the item's application-specific object value. - -Args: - - item(typing.Any):Index of the item whose Data is to be set. - Data(typing.Any):New value for the data.CommentsNote that a reference count is not added to the object. This it is your responsibility to make sure the object remains alive while in the list. - -Returns: - - typing.Any - - """ - pass - - - def SetItemValue(self,item:'typing.Any',data:'typing.Any') -> 'typing.Any': - """ - Sets the item's application-specific value. - -Args: - - item(typing.Any):Index of the item whose Data is to be set. - data(typing.Any):New value for the data. - -Returns: - - typing.Any - - """ - pass - - - def ShowDropDown(self,bShowIt:'typing.Any'=1) -> 'None': - """ - Shows or hides the listbox portion of a combo box. - -Args: - - bShowIt(typing.Any):Indicates if the listbox should be shown or hidden. - -Returns: - - None - - """ - pass - - -class PyCCommonDialog(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCControl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCControlBar(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dockSite(self)->'PyCFrameWnd': - """Current dock site, if dockable""" - pass - - - @property - def dockBar(self)->'PyCWnd': - """Current dock bar, if dockable""" - pass - - - @property - def dockContext(self)->'PyCDockContext': - """Used during dragging""" - pass - - - @property - def dwStyle(self)->'typing.Any': - """creation style (used for layout)""" - pass - - - @property - def dwDockStyle(self)->'typing.Any': - """indicates how bar can be docked""" - pass - - - def CalcDynamicLayout(self,length:'typing.Any',dwMode:'typing.Any') -> 'typing.Any': - """ - The framework calls this member function to calculate the dimensions of - -a dynamic toolbar. - -Args: - - length(typing.Any):The requested dimension of the control bar, either horizontal or vertical, depending on dwMode. - dwMode(typing.Any):A combination of flags. - -Returns: - - typing.Any - - """ - pass - - - def CalcFixedLayout(self,bStretch:'typing.Any',bHorz:'typing.Any') -> 'typing.Any': - """ - Calculates the horizontal size of a control bar - -Args: - - bStretch(typing.Any):Indicates whether the bar should be stretched to the size of the frame. The bStretch parameter is nonzero when the bar is not a docking bar (not available for docking) and is 0 when it is docked or floating (available for docking). - bHorz(typing.Any):Indicates that the bar is horizontally or vertically oriented. - -Returns: - - typing.Any - - """ - pass - - - def EnableDocking(self,style:'typing.Any') -> 'None': - """ - pecifies whether the control bar supports docking and the sides of its parent - -window. - -Args: - - style(typing.Any):Enables a control bar to be docked. - -Returns: - - None - - """ - pass - - - def EraseNonClient(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def GetBarStyle(self,) -> 'typing.Any': - """ - Retrieves the control bar style settings. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetCount(self,) -> 'typing.Any': - """ - Returns the number of non-HWND elements in the control bar. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetDockingFrame(self,) -> 'PyCFrameWnd': - """ - Returns the frame window to which a control bar is docked. - -Args: - - - -Returns: - - PyCFrameWnd - - """ - pass - - - def IsFloating(self,) -> 'typing.Any': - """ - Returns a nonzero value if the control bar in question is a floating control - -bar. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetBarStyle(self,style:'typing.Any') -> 'None': - """ - Modifies the control bar style settings. - -Args: - - style(typing.Any):The new style - -Returns: - - None - - """ - pass - - - def ShowWindow(self,) -> 'typing.Any': - """ - Shows the toolbar, and recalculates the button layout. - -Args: - - - -Returns: - - typing.Any:PyCControlBar.ShowWindow - -int = ShowWindow()Shows the toolbar, and recalculates the button layout. -Comments - -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 - - -class PyCCtrlView(object): - """A class which implementes a CCtrlView (ie, a view based on a dialog resource.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OnCommand(self,wparam:'typing.Any',lparam:'typing.Any') -> 'None': - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(typing.Any): - lparam(typing.Any):See Also - -Returns: - - None - - """ - pass - - -class PyCDC(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AbortDoc(self,) -> 'None': - """ - Aborts a print job - -Args: - - - -Returns: - - None - - """ - pass - - - def Arc(self,rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',pointStart:'typing.Tuple[typing.Any, typing.Any]',pointEnd:'typing.Tuple[typing.Any, typing.Any]') -> 'None': - """ - Draws an eliptical arc. - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Specifies the ellipse's bounding rectangle - pointStart(typing.Tuple[typing.Any, typing.Any]):Specifies the x- and y-coordinates of the point that defines the arc's starting point (in logical units). This point does not have to lie exactly on the arc. - pointEnd(typing.Tuple[typing.Any, typing.Any]):Specifies the x- and y-coordinates of the point that defines the arc's ending point (in logical units). This point does not have to lie exactly on the arc.CommentsThe arc drawn by using the function is a segment of the ellipse defined by the specified bounding rectangle. The actual starting point of the arc is the point at which a ray drawn from the center of the bounding rectangle through the specified starting point intersects the ellipse. The actual ending point of the arc is the point at which a ray drawn from the center of the bounding rectangle through the specified ending point intersects the ellipse. The arc is drawn in a counterclockwise direction. Since an arc is not a closed figure, it is not filled. Both the width and height of the rectangle must be greater than 2 units and less than 32,767 units.MFC References - -Returns: - - None:CDC::Arc -Return ValueAlways none. If the function fails, an exception is raised. - - - """ - pass - - - def BeginPath(self,) -> 'None': - """ - Opens a path bracket in the device context - -Args: - - - -Returns: - - None - - """ - pass - - - def BitBlt(self,destPos:'typing.Tuple[typing.Any, typing.Any]',size:'typing.Tuple[typing.Any, typing.Any]',dc:'PyCDC',srcPos:'typing.Tuple[typing.Any, typing.Any]',rop:'typing.Any') -> 'None': - """ - Copies a bitmap from the source device context to this device context. - -Args: - - destPos(typing.Tuple[typing.Any, typing.Any]):The logical x,y coordinates of the upper-left corner of the destination rectangle. - size(typing.Tuple[typing.Any, typing.Any]):Specifies the width and height (in logical units) of the destination rectangle and source bitmap. - dc(PyCDC):Specifies the PyCDC object from which the bitmap will be copied. It must be None if rop specifies a raster operation that does not include a source. - srcPos(typing.Tuple[typing.Any, typing.Any]):Specifies the logical x,y coordinates of the upper-left corner of the source bitmap. - rop(typing.Any):Specifies the raster operation to be performed. See the win32 api documentation for details.MFC References - -Returns: - - None - - """ - pass - - - def Chord(self,rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',pointStart:'typing.Tuple[typing.Any, typing.Any]',pointEnd:'typing.Tuple[typing.Any, typing.Any]') -> 'None': - """ - Draws a chord. - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Specifies the ellipse's bounding rectangle - pointStart(typing.Tuple[typing.Any, typing.Any]):Specifies the x- and y-coordinates of the point that defines the arc's starting point (in logical units). This point does not have to lie exactly on the arc. - pointEnd(typing.Tuple[typing.Any, typing.Any]):Specifies the x- and y-coordinates of the point that defines the arc's ending point (in logical units). This point does not have to lie exactly on the arc.CommentsDraws a chord (a closed figure bounded by the intersection of an ellipse and a line segment). The rect parameter specify the upper-left and lower-right corners, respectively, of a rectangle bounding the ellipse that is part of the chord. The pointStart and pointEnd parameters specify the endpoints of a line that intersects the ellipse. The chord is drawn by using the selected pen and filled by using the selected brush.MFC References - -Returns: - - None:CDC::Chord -Return ValueAlways none. If the function fails, an exception is raised. - - - """ - pass - - - def CreateCompatibleDC(self,dcFrom:'PyCDC'=None) -> 'None': - """ - Creates a memory device context that is compatible with this DC. - -Args: - - dcFrom(PyCDC):The source DC, or None to make a screen compatible DC.CommentsNote that unlike the MFC version, this function calls the global CreateCompatibleDC function and returns a new PyCDC object.MFC References - -Returns: - - None - - """ - pass - - - def CreatePrinterDC(self,printerName:'str'=None) -> 'None': - """ - Creates a device context for a specific printer - -Args: - - printerName(str):The printer name, or None for the default printerMFC References - -Returns: - - None - - """ - pass - - - def DeleteDC(self,) -> 'None': - """ - Deletes all resources associated with a device context. - -Args: - - - -Returns: - - None - - """ - pass - - - def DPtoLP(self,point:'typing.Tuple[typing.Any, typing.Any]',x:'typing.Any',y:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Converts device units into logical units. - -Args: - - point(typing.Tuple[typing.Any, typing.Any]):The point to convertAlternative Parameters - x(typing.Any):The x coordinate to convert. - y(typing.Any):The y coordinate to convert.MFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any]:CDC::DPtoLP - To Do Should really handle list of (x,y) points -Return ValueThe converted coordinates. - - - """ - pass - - - def Draw3dRect(self,rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',colorTopLeft:'typing.Any',colorBotRight:'typing.Any') -> 'None': - """ - Draws a three-dimensional rectangle. - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Specifies the bounding rectangle, in logical units. - colorTopLeft(typing.Any):Specifies the color of the top and left sides of the three-dimensional rectangle. - colorBotRight(typing.Any):Specifies the color of the bottom and right sides of the three-dimensional rectangle.MFC References - -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 - -indicate the rectangle has focus - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The coordinates of the rectangleMFC References - -Returns: - - None - - """ - pass - - - def DrawFrameControl(self,rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',typ:'typing.Any',state:'typing.Any') -> 'None': - """ - Draws a frame control of the specified type and style. - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Specifies the bounding rectangle, in logical units. - typ(typing.Any): - state(typing.Any):MFC References - -Returns: - - None - - """ - pass - - - def DrawIcon(self,point:'typing.Tuple[typing.Any, typing.Any]',hIcon:'int') -> 'None': - """ - Draws an icon on the DC. - -Args: - - point(typing.Tuple[typing.Any, typing.Any]):The point coordinate to draw to. - hIcon(int):The handle of the icon to draw.MFC References - -Returns: - - None - - """ - pass - - - def DrawText(self,s:'str',_tuple:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',_format:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': - """ - Formats text in the given rectangle - -Args: - - s(str):The desired output string - _tuple(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The bounding rectangle in the form: (left, top, right, bottom) expressed in logical units (depending on selected coordinate system - see PyCDC::SetMapMode) - _format(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 the Microsoft Win32 API documentation.ExampleExampleimport win32ui<nl> import win32con<nl> INCH = 1440 # twips - 1440 per inch allows fine res<nl> def drawtext_test():<nl> dc = win32ui.CreateDC()<nl> dc.CreatePrinterDC() # ties to default printer<nl> dc.StartDoc('My Python Document')<nl> dc.StartPage()<nl> <nl> # note: upper left is 0,0 with x increasing to the right,<nl> # and y decreasing (negative) moving down<nl> dc.SetMapMode(win32con.MM_TWIPS)<nl> <nl> # Centers "TEST" about an inch down on page<nl> dc.DrawText('TEST', (0,INCH*-1,INCH*8,INCH*-2), win32con.DT_CENTER )<nl> dc.EndPage()<nl> dc.EndDoc()<nl> del dc<nl>Return ValueHeight of text in pixelsThe return value is the height of the text, in logical units. If DT_VCENTER or DT_BOTTOM is specified, the return value is the 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) - -Returns: - - 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 - -the Microsoft Win32 API documentation.ExampleExample -import win32ui<nl> - - import win32con<nl> - - INCH = 1440 # twips - 1440 per inch allows fine res<nl> - - def drawtext_test():<nl> - - dc = win32ui.CreateDC()<nl> - - dc.CreatePrinterDC() # ties to default printer<nl> - - dc.StartDoc('My Python Document')<nl> - - dc.StartPage()<nl> - - <nl> - - # note: upper left is 0,0 with x increasing to the right,<nl> - - # and y decreasing (negative) moving down<nl> - - dc.SetMapMode(win32con.MM_TWIPS)<nl> - - <nl> - - # Centers "TEST" about an inch down on page<nl> - - dc.DrawText('TEST', (0,INCH*-1,INCH*8,INCH*-2), win32con.DT_CENTER )<nl> - - dc.EndPage()<nl> - - dc.EndDoc()<nl> - - del dc<nl> - - -Return ValueHeight of text in pixels - - - -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 - -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 - - - def Ellipse(self,rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]') -> 'None': - """ - Draws an Ellipse. - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Specifies the ellipse's bounding rectangleCommentsThe center of the ellipse is the center of the bounding rectangle specified by rect. The ellipse is drawn with the current pen, and its interior is filled with the current brush.MFC References - -Returns: - - None:CDC::Ellipse -Return ValueAlways none. If the function fails, an exception is raised. - - - """ - pass - - - def EndDoc(self,) -> 'None': - """ - Finishes spooling the document and starts printing it - -Args: - - - -Returns: - - None - - """ - pass - - - def EndPage(self,) -> 'None': - """ - Finishes a page on a printer DC - -Args: - - - -Returns: - - None - - """ - pass - - - def EndPath(self,) -> 'None': - """ - Closes a path bracket and selects the path defined by the bracket into the specified device - -context - -Args: - - - -Returns: - - None - - """ - pass - - - def ExtTextOut(self,_int:'typing.Any',_int1:'typing.Any',_int2:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',string:'typing.Any',_tuple:'typing.Tuple[typing.Tuple[typing.Any, typing.Any], ...]') -> 'None': - """ - Writes text to the DC. - -Args: - - _int(typing.Any):The x coordinate to write the text to. - _int1(typing.Any):The y coordinate to write the text to. - _int2(typing.Any):Specifies the rectangle type. This parameter can be one, both, or neither of ETO_CLIPPED and ETO_OPAQUE - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Specifies the text's bounding rectangle. (Can be None.) - string(typing.Any):The text to write. - _tuple(typing.Tuple[typing.Tuple[typing.Any, typing.Any], ...]):Optional array of values that indicate distance between origins of character cells.MFC References - -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 - -current brush and polygon-filling mode. After its interior is filled, the path is discarded from the device context. - -Args: - - - -Returns: - - None - - """ - pass - - - def FillRect(self,rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',brush:'PyCBrush') -> 'None': - """ - Fills a given rectangle with the specified brush - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Specifies the bounding rectangle, in logical units. - brush(PyCBrush):Specifies the brush to use.MFC References - -Returns: - - None - - """ - pass - - - def FillSolidRect(self,rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',color:'typing.Any') -> 'None': - """ - Fills the given rectangle with the specified solid color. - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Specifies the bounding rectangle, in logical units. - color(typing.Any):Specifies the color to use.MFC References - -Returns: - - None - - """ - pass - - - def FrameRect(self,rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',brush:'PyCBrush') -> 'None': - """ - Draws a border around the rectangle specified by rect - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Specifies the bounding rectangle, in logical units. - brush(PyCBrush):Specifies the brush to use.MFC References - -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 - -device context. - -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 - -around the current clipping boundary. - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]:CDC::GetClipBox -Return ValueA tuple of integers specifying the rectangle. - - - """ - pass - - - def GetCurrentPosition(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Retrieves the current position (in logical coordinates). - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def GetDeviceCaps(self,index:'typing.Any') -> 'typing.Any': - """ - Retrieves a capability of the device context. - -Args: - - index(typing.Any):The information requested. See the win32api documentation for details.MFC References - -Returns: - - typing.Any:CDC::GetDeviceCaps -Return ValueThe value of the requested capability - - - """ - pass - - - def GetHandleAttrib(self,) -> 'typing.Any': - """ - Retrieves the handle of the attribute device context. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetHandleOutput(self,) -> 'typing.Any': - """ - Retrieves the handle of the output device context. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetMapMode(self,) -> 'typing.Any': - """ - Gets the mapping mode for the device context. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetNearestColor(self,color:'typing.Any') -> 'typing.Any': - """ - Returns the closest color a device can map. - -Args: - - color(typing.Any):Specifies the color to be matched. - -Returns: - - typing.Any - - """ - pass - - - def GetPixel(self,x:'typing.Any',y:'typing.Any') -> 'None': - """ - Gets a pixel at a local in a device context - -Args: - - x(typing.Any):Horizontal coordinate. - y(typing.Any):Vertical coordinate. - -Returns: - - None - - """ - pass - - - def GetSafeHdc(self,) -> 'typing.Any': - """ - Returns the HDC of this DC object. - -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 - -determine the dimensions. - -Args: - - text(str):The text to calculate for.MFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any]:CFC::GetTextExtent -Return ValueA tuple of integers with the size of the string, in logical units. - - - """ - pass - - - def GetTextExtentPoint(self,text:'str') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - None - -Args: - - text(str):The text to calculate for.Return ValueA tuple of integers with the size of the string, in logical units. - -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 - - - def GetTextFace(self,) -> 'str': - """ - Returns typeface name of the current font. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetTextMetrics(self,) -> 'typing.Any': - """ - Retrieves the metrics for the current font in this device context. - -Args: - - - -Returns: - - typing.Any:CDC::GetTextMetrics -Return ValueA dictionary of integers, keyed by the following strings: - -tmHeight - -tmAscent - -tmDescent - -tmInternalLeading - -tmExternalLeading - -tmAveCharWidth - -tmMaxCharWidth - -tmWeight - -tmItalic - -tmUnderlined - -tmStruckOut - -tmFirstChar - -tmLastChar - -tmDefaultChar - -tmBreakChar - -tmPitchAndFamily - -tmCharSet - -tmOverhang - -tmDigitizedAspectX - -tmDigitizedAspectY - - - """ - pass - - - def GetViewportExt(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Gets the viewport extent of the device context - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def GetViewportOrg(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Gets the viewport origin of the device context - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def GetWindowExt(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Gets the window extent of the device context - -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 - -device context. - -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 - -and the rectangle specified - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Specifies the bounding rectangle, in logical units.MFC References - -Returns: - - None:CDC::IntersectClipRect -Return Valueregion type as integer - - - """ - pass - - - def IsPrinting(self,) -> 'typing.Any': - """ - Returns 1 if the DC is currently printing, else 0 - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def LineTo(self,point:'typing.Tuple[typing.Any, typing.Any]',x:'typing.Any',y:'typing.Any') -> 'None': - """ - Draws a line to a specified point, using the currently selected pen. - -Args: - - point(typing.Tuple[typing.Any, typing.Any]):The point coordinate to draw to.Alternative Parameters - x(typing.Any):The x coordinate to draw to. - y(typing.Any):The y coordinate to draw to.MFC References - -Returns: - - None - - """ - pass - - - def LPtoDP(self,point:'typing.Tuple[typing.Any, typing.Any]',x:'typing.Any',y:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Converts logical units into device units. - -Args: - - point(typing.Tuple[typing.Any, typing.Any]):The point coordinate to convert.Alternative Parameters - x(typing.Any):The x coordinate to convert. - y(typing.Any):The y coordinate to convert.MFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any]:CDC::LPtoDP -Return ValueThe converted coordinates. - - - """ - pass - - - def MoveTo(self,point:'typing.Tuple[typing.Any, typing.Any]',x:'typing.Any',y:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Moves the current position to a specified point. - -Args: - - point(typing.Tuple[typing.Any, typing.Any]):The point coordinate to move to.Alternative Parameters - x(typing.Any):The x coordinate to move to. - y(typing.Any):The y coordinate to move to.MFC References - -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 - -current window origin. - -Args: - - arg(typing.Tuple[typing.Any, typing.Any]):The new origin offset.Return ValueThe previous origin as a tuple (x,y) - -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 - -the current viewport origin - -Args: - - arg(typing.Tuple[typing.Any, typing.Any]):The new origin offset.Return ValueThe previous viewport origin as a tuple (x,y) - -Returns: - - typing.Tuple[typing.Any, typing.Any]:The new origin offset.Return ValueThe previous viewport origin as a tuple (x,y) - - - """ - pass - - - def PatBlt(self,destPos:'typing.Tuple[typing.Any, typing.Any]',size:'typing.Tuple[typing.Any, typing.Any]',rop:'typing.Any') -> 'None': - """ - Creates a bit pattern on the device. - -Args: - - destPos(typing.Tuple[typing.Any, typing.Any]):The logical x,y coordinates of the upper-left corner of the destination rectangle. - size(typing.Tuple[typing.Any, typing.Any]):Specifies the width and height (in logical units) of the destination rectangle and source bitmap. - rop(typing.Any):Specifies the raster operation to be performed. See the win32 api documentation for details.MFC References - -Returns: - - None - - """ - pass - - - def Pie(self,x1:'typing.Any',y1:'typing.Any',x2:'typing.Any',y2:'typing.Any',x3:'typing.Any',y3:'typing.Any',x4:'typing.Any',y4:'typing.Any') -> 'None': - """ - Draws a pie slice in a device context - -Args: - - x1(typing.Any):X coordinate of upper left corner - y1(typing.Any):Y coordinate of upper left corner - x2(typing.Any):X coordinate of lower right corner - y2(typing.Any):Y coordinate of lower right corner - x3(typing.Any):X coordinate of starting point of arc - y3(typing.Any):Y coordinate of starting point of arc - x4(typing.Any):X coordinate of ending point of arc - y4(typing.Any):Y coordinate of ending point of arc - -Returns: - - None - - """ - pass - - - def PolyBezier(self,) -> 'None': - """ - Draws one or more Bezier splines. - -Args: - - - -Returns: - - None - - """ - pass - - - def Polygon(self,) -> 'None': - """ - Draws an Polygon. - -Args: - - - -Returns: - - None - - """ - pass - - - def Polyline(self,points:'typing.List[typing.Tuple[typing.Any, typing.Any]]') -> 'None': - """ - Draws a Polyline. - -Args: - - points(typing.List[typing.Tuple[typing.Any, typing.Any]]):A sequence of points - -Returns: - - None - - """ - pass - - - def RealizePalette(self,) -> 'typing.Any': - """ - Maps palette entries in the current logical palette to the system palette. - -Args: - - - -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 - -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 - -was last realized. - - - """ - pass - - - def Rectangle(self,) -> 'typing.Any': - """ - Draws a rectangle using the current pen. The interior of the rectangle is filled using - -the current brush. - -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 - -the display context. - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The coordinates of the reactangle to be checked.MFC References - -Returns: - - typing.Any:CDC::RectVisible -Return ValueNon zero if any part of the rectangle lies within the clipping region, else zero. - - - """ - pass - - - def RestoreDC(self,saved:'typing.Any') -> 'None': - """ - Restores the state of the device context. - -Args: - - saved(typing.Any):The id of a previously saved device context. See PyCDC::SaveDCMFC References - -Returns: - - None - - """ - pass - - - def SaveDC(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any:CDC::SaveDC -Return ValueAn integer identifying the context, which can be used by PyCDC::RestoreDC. - -An exception is raised if this function fails. - - - """ - pass - - - def ScaleWindowExt(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Modifies the window extents relative to the current values. - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def ScaleViewportExt(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Modifies the viewport extents relative to the current values. - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def SelectClipRgn(self,) -> 'typing.Any': - """ - Selects the given region as the current clipping region for the device context - -Args: - - - -Returns: - - typing.Any:PyCDC.SelectClipRgn - -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 - - - def SelectObject(self,ob:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - ob(typing.Any):The object to select.MFC References - -Returns: - - typing.Any:CDC::SelectObject -Return ValueThe previously selected object. This will be the same type as the object parameter. - - - """ - pass - - - def SetBkColor(self,color:'typing.Any') -> 'typing.Any': - """ - Sets the current background color to the specified color. - -Args: - - color(typing.Any):A windows color specification. See the win32api documentation for details.CommentsIf the background mode is OPAQUE, the system uses the background color to fill the gaps in styled lines, the gaps between hatched lines in brushes, and the background in character cells. The system also uses the background color when converting bitmaps between color and monochrome device contexts.MFC References - -Returns: - - typing.Any:CDC::SetBkColor -Return ValueThe return value is the previous background color. - - - """ - pass - - - def SetBkMode(self,mode:'typing.Any') -> 'typing.Any': - """ - Sets the current background mode to the specified mode. - -Args: - - mode(typing.Any):A background mode. May be either TRANSPARENT or OPAQUE.CommentsSpecifies the mode to be set. This parameter can be either OPAQUE or TRANSPARENTMFC References - -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 - -application selects into the device context. - -Args: - - point(typing.Tuple[typing.Any, typing.Any]):The new origin in device units.MFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any]:CDC::SetBrushOrg -Return ValueThe previous origin in device units. - - - """ - pass - - - def SetGraphicsMode(self,mode:'typing.Any') -> 'typing.Any': - """ - Sets the graphics mode for the specified device context - -Args: - - mode(typing.Any):The new mode. - -Returns: - - typing.Any - - """ - pass - - - def SetMapMode(self,newMode:'typing.Any') -> 'typing.Any': - """ - Sets the mapping mode for the device context. - -Args: - - newMode(typing.Any):The new mode. Can be one of MM_ANISOTROPIC, MM_HIENGLISH, MM_HIMETRIC, MM_ISOTROPIC, MM_LOENGLISH, MM_LOMETRIC, MM_TEXT, MM_TWIPSMFC References - -Returns: - - typing.Any:CDC::SetMapMode -Return ValueThe previous mapping mode. - - - """ - pass - - - def SetPixel(self,x:'typing.Any',y:'typing.Any',color:'typing.Any') -> 'None': - """ - Sets a pixel in a device context - -Args: - - x(typing.Any):Horizontal coordinate. - y(typing.Any):Vertical coordinate. - color(typing.Any):The brush color. - -Returns: - - None - - """ - pass - - - def SetPolyFillMode(self,point:'typing.Tuple[typing.Any, typing.Any]') -> 'typing.Any': - """ - Sets the polygon-filling mode. - -Args: - - point(typing.Tuple[typing.Any, typing.Any]):The new origin in device units.MFC References - -Returns: - - typing.Any:CDC::SetPolyFillMode -Return ValueThe previous PolyFillMode as integer - - - -The previous PolyFillMode. - - - """ - pass - - - def SetROP2(self,mode:'typing.Any') -> 'typing.Any': - """ - Sets the current drawing mode. - -Args: - - mode(typing.Any):The new drawing mode.MFC References - -Returns: - - typing.Any - - """ - pass - - - def SetTextAlign(self,newFlags:'typing.Any') -> 'typing.Any': - """ - Sets the text-alignment flags. - -Args: - - newFlags(typing.Any):The new alignment flags. Can be a combination of (TA_CENTER, TA_LEFT, TA_RIGHT), (TA_BASELINE, TA_BOTTOM, TA_TOP) and (TA_NOUPDATECP, TA_UPDATECP) The default is TA_LEFT|TA_TOP|TA_NOUPDATECPMFC References - -Returns: - - typing.Any:CDC::SetTextAlign -Return ValueThe old alignment flags. - - - """ - pass - - - def SetTextColor(self,color:'typing.Any') -> 'typing.Any': - """ - Sets the text color to the specified color. - -Args: - - color(typing.Any):A windows color specification. See the win32api documentation for details.CommentsThis text color is used when writing text to this device context and also when converting bitmaps between color and monochrome device contexts. If the device cannot represent the specified color, the system sets the text color to the nearest physical color. The background color for a character is specified by the SetBkColor and SetBkMode member functions.MFC References - -Returns: - - typing.Any:CDC::SetTextColor -Return ValueThe return value is the previous text color. - - - """ - pass - - - def SetWindowExt(self,size:'typing.Tuple[typing.Any, typing.Any]') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Sets the x,y extents of the window associated with the device context. - -Args: - - size(typing.Tuple[typing.Any, typing.Any]):The new size.MFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any]:CDC::SetWindowExt -Return ValueThe previous extents of the window (in logical units). - - - """ - pass - - - def SetWindowOrg(self,arg:'typing.Tuple[typing.Any, typing.Any]') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Sets the window origin of the device context - -Args: - - arg(typing.Tuple[typing.Any, typing.Any]):The new origin. - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def SetViewportExt(self,size:'typing.Tuple[typing.Any, typing.Any]') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Sets the x,y extents of the viewport of the device context. - -Args: - - size(typing.Tuple[typing.Any, typing.Any]):The new size.MFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any]:CDC::SetViewportExt -Return ValueThe previous extents of the viewport (in logical units). - - - """ - pass - - - def SetViewportOrg(self,arg:'typing.Tuple[typing.Any, typing.Any]') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Sets the viewport origin of the device context - -Args: - - arg(typing.Tuple[typing.Any, typing.Any]):The new origin. - -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 - -for the specified device context. This transformation can be used to scale, rotate, shear, or translate graphics - -output. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def StartDoc(self,docName:'str',outputFile:'str') -> 'None': - """ - Starts spooling a document to a printer DC - -Args: - - docName(str):The document name - outputFile(str):The output file name. Use this to spool to a file. Omit to send to the printer. - -Returns: - - None - - """ - pass - - - def StartPage(self,) -> 'None': - """ - Starts a new page on a printer DC - -Args: - - - -Returns: - - None - - """ - pass - - - def StretchBlt(self,destPos:'typing.Tuple[typing.Any, typing.Any]',size:'typing.Tuple[typing.Any, typing.Any]',dc:'PyCDC',srcPos:'typing.Tuple[typing.Any, typing.Any]',size1:'typing.Tuple[typing.Any, typing.Any]',rop:'typing.Any') -> 'None': - """ - Copies a bitmap from the source device context to this device context. - -Args: - - destPos(typing.Tuple[typing.Any, typing.Any]):The logical x,y coordinates of the upper-left corner of the destination rectangle. - size(typing.Tuple[typing.Any, typing.Any]):Specifies the width and height (in logical units) of the destination rectangle and source bitmap. - dc(PyCDC):Specifies the PyCDC object from which the bitmap will be copied. It must be None if rop specifies a raster operation that does not include a source. - srcPos(typing.Tuple[typing.Any, typing.Any]):Specifies the logical x,y coordinates of the upper-left corner of the source bitmap. - size1(typing.Tuple[typing.Any, typing.Any]):Specifies the width and height (in logical units) of the destination rectangle and source bitmap. - rop(typing.Any):Specifies the raster operation to be performed. See the win32 api documentation for details.MFC References - -Returns: - - None - - """ - pass - - - def StrokeAndFillPath(self,) -> 'None': - """ - 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. - -Args: - - - -Returns: - - None - - """ - pass - - - def StrokePath(self,) -> 'None': - """ - Renders the specified path by using the current pen. - -Args: - - - -Returns: - - None - - """ - pass - - - def TextOut(self,_int:'typing.Any',_int1:'typing.Any',string:'typing.Any') -> 'None': - """ - Outputs text to the display context, using the currently selected font. - -Args: - - _int(typing.Any):The x coordinate to write the text to. - _int1(typing.Any):The y coordinate to write the text to. - string(typing.Any):The text to write.MFC References - -Returns: - - None:CDC::TextOut -Return ValueAlways none. If the function fails, an exception is raised. - - - """ - pass - - -class PyCDialog(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,obParent:'PyCWnd'=None) -> 'None': - """ - Create a modeless window for the dialog box. - -Args: - - obParent(PyCWnd):The parent window for the new windowMFC References - -Returns: - - None - - """ - pass - - - def DoModal(self,) -> 'typing.Any': - """ - Create a modal window for the dialog box. - -Args: - - - -Returns: - - typing.Any:CDialog::DoModal -Return ValueThe return value from the dialog. This is the value passed to PyCDialog::EndDialog. - - - """ - pass - - - def EndDialog(self,result:'typing.Any') -> 'None': - """ - Ends a modal dialog box. - -Args: - - result(typing.Any):The value to be returned by the PyCDialog::DoModal method.MFC References - -Returns: - - None - - """ - pass - - - def GotoDlgCtrl(self,control:'PyCWnd') -> 'None': - """ - Moves the focus to the specified control in the dialog box. - -Args: - - control(PyCWnd):The control to get the focus. - -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 - -units. - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The rect to be converted - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - - """ - pass - - - def OnCancel(self,) -> 'None': - """ - Calls the default MFC OnCancel handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnOK(self,) -> 'None': - """ - Calls the default MFC OnOK handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnInitDialog(self,) -> 'typing.Any': - """ - Calls the default MFC OnInitDialog handler. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyCDialogBar(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,parent:'PyCWnd',template:'PyResourceId',style:'typing.Any',_id:'typing.Any') -> 'None': - """ - None - -Args: - - parent(PyCWnd):The parent window - template(PyResourceId):Template name or integer resource id - style(typing.Any):The style for the window - _id(typing.Any):The ID of the window - -Returns: - - None - - """ - pass - - -class PyCDocTemplate(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def DoCreateDoc(self,fileName:'str'=None) -> 'PyCDocument': - """ - Creates an underlying document object. - -Args: - - fileName(str):The name of the file to load. - -Returns: - - PyCDocument - - """ - pass - - - def FindOpenDocument(self,fileName:'str') -> 'PyCDocument': - """ - Returns an existing document with the specified file name. - -Args: - - fileName(str):The fully qualified filename to search for. - -Returns: - - PyCDocument - - """ - pass - - - def GetDocString(self,docIndex:'typing.Any') -> 'str': - """ - Retrieves a specific substring describing the document type. - -Args: - - docIndex(typing.Any):The document index. Must be one of the win32ui.CDocTemplate_* constants.CommentsFor more information on the doc strings, please see PyCDocTemplate::SetDocStrings - -Returns: - - str - - """ - pass - - - def GetDocumentList(self,) -> 'typing.Any': - """ - Return a list of all open documents. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetResourceID(self,) -> 'None': - """ - Returns the resource ID in use. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetSharedMenu(self,) -> 'PyCMenu': - """ - Returns the shared menu object for all frames using this template. - -Args: - - - -Returns: - - PyCMenu - - """ - pass - - - def InitialUpdateFrame(self,frame:'PyCFrameWnd'=None,doc:'PyCDocument'=None,bMakeVisible:'typing.Any'=1) -> 'None': - """ - Calls the default OnInitialFrame handler. - -Args: - - frame(PyCFrameWnd):The frame window. - doc(PyCDocument):A document for the frame. - bMakeVisible(typing.Any):Indicates of the frame should be shown.See Also - -Returns: - - None - - """ - pass - - - def SetContainerInfo(self,_id:'typing.Any') -> 'None': - """ - Sets the resources to be used when an OLE 2 object is in-place activated. - -Args: - - _id(typing.Any):The resource ID. - -Returns: - - None - - """ - pass - - - def SetDocStrings(self,docStrings:'str') -> 'None': - """ - Assigns the document strings for the template. - -Args: - - docStrings(str):The document strings.CommentsThe string must be a \\n seperated list of docstrings. The elements are:elementNameDescriptionwindowTitleTitle used for the window (only for SDI applications)docNameRoot for the default document name.fileNewNameName of the document type, as displayed in the "File/New" dialogfilterNameDescription of the document type and a wildcard spec for the file open dialog.filterExtExtension for documents of this file type.regFileTypeIdInternal Id of the document as registered in the registry. Used to associate the extension with the file type.regFileTypeNameName of the document, as stored in the reigstry. This is the name presented to the user. - -Returns: - - None - - """ - pass - - - def OpenDocumentFile(self,filename:'str',bMakeVisible:'typing.Any'=1) -> 'None': - """ - Opens a document file, creating a view and frame. - -Args: - - filename(str):Name of file to open, or None - bMakeVisible(typing.Any):Indicates if the document should be created visible. - -Returns: - - None - - """ - pass - - -class PyCDockContext(object): - """A class which encapsulates an MFC CDockContext object""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ptLast(self)->'typing.Tuple[typing.Any, typing.Any]': - """""" - pass - - - @property - def rectLast(self)->'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': - """""" - pass - - - @property - def sizeLast(self)->'typing.Tuple[typing.Any, typing.Any]': - """""" - pass - - - @property - def bDitherLast(self)->'typing.Any': - """""" - pass - - - @property - def rectDragHorz(self)->'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': - """""" - pass - - - @property - def rectDragVert(self)->'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': - """""" - pass - - - @property - def rectFrameDragHorz(self)->'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': - """""" - pass - - - @property - def rectFrameDragVert(self)->'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': - """""" - pass - - - @property - def dwDockStyle(self)->'typing.Any': - """allowable dock styles for bar""" - pass - - - @property - def dwOverDockStyle(self)->'typing.Any': - """style of dock that rect is over""" - pass - - - @property - def dwStyle(self)->'typing.Any': - """style of control bar""" - pass - - - @property - def bFlip(self)->'typing.Any': - """if shift key is down""" - pass - - - @property - def bForceFrame(self)->'typing.Any': - """if ctrl key is down CDC* m_pDC; // where to draw during drag""" - pass - - - @property - def bDragging(self)->'typing.Any': - """""" - pass - - - @property - def nHitTest(self)->'typing.Any': - """""" - pass - - - @property - def uMRUDockID(self)->'typing.Any': - """""" - pass - - - @property - def rectMRUDockPos(self)->'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': - """""" - pass - - - @property - def dwMRUFloatStyle(self)->'typing.Any': - """""" - pass - - - @property - def ptMRUFloatPos(self)->'typing.Tuple[typing.Any, typing.Any]': - """Sentinel""" - pass - - - def EndDrag(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def StartDrag(self,pt:'typing.Tuple[typing.Any, typing.Any]') -> 'typing.Any': - """ - None - -Args: - - pt(typing.Tuple[typing.Any, typing.Any]): - -Returns: - - typing.Any - - """ - pass - - - def EndResize(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def StartResize(self,hittest:'typing.Any',pt:'typing.Tuple[typing.Any, typing.Any]') -> 'typing.Any': - """ - None - -Args: - - hittest(typing.Any): - pt(typing.Tuple[typing.Any, typing.Any]): - -Returns: - - typing.Any - - """ - pass - - - def ToggleDocking(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyCDocument(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def DeleteContents(self,) -> 'None': - """ - Call the MFC DeleteContents method. - -This routine is provided so a document object which overrides this method - -can call the original MFC version if required. - -Args: - - - -Returns: - - None - - """ - pass - - - def DoSave(self,fileName:'str',bReplace:'typing.Any'=1) -> 'None': - """ - Calls the underlying MFC DoSave method. - -Args: - - fileName(str):The name of the file to save to. - bReplace(typing.Any):Should an existing file be silently replaced?.CommentsIf invalid or no filename, will prompt for a name, else will perform the actual saving of the document.See Also - -Returns: - - None - - """ - pass - - - def DoFileSave(self,) -> 'None': - """ - Checks the file attributes. - -If the file is read only, a new name is prompted, else the - -file is saved (by calling DoSave) - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDocTemplate(self,) -> 'PyCDocTemplate': - """ - Returns the template for the document. - -Args: - - - -Returns: - - PyCDocTemplate - - """ - pass - - - def GetAllViews(self,) -> 'typing.List[typing.Any]': - """ - Returns a list of all views for the current document. - -Args: - - - -Returns: - - typing.List[typing.Any] - - """ - pass - - - def GetFirstView(self,) -> 'PyCView': - """ - Returns the first view object attached to this document. - -Args: - - - -Returns: - - PyCView - - """ - pass - - - def GetPathName(self,) -> 'str': - """ - Returns the full path name of the current document. - -The string will be empty if no path name has been set. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetTitle(self,) -> 'str': - """ - Returns the title of the current document. - -This will often be the file name portion of the path name. - -Args: - - - -Returns: - - str - - """ - pass - - - def IsModified(self,) -> 'typing.Any': - """ - Return a flag indicating if the document has been modified. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def OnChangedViewList(self,) -> 'None': - """ - Informs the document when a view is added or removed. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnCloseDocument(self,) -> 'None': - """ - Call the MFC OnCloseDocument handler. - -This routine is provided so a document object which overrides this method - -can call the original MFC version if required. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnNewDocument(self,) -> 'None': - """ - Call the MFC OnNewDocument handler. - -This routine is provided so a document object which overrides this method - -can call the original MFC version if required. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnOpenDocument(self,pathName:'str') -> 'None': - """ - Call the MFC OnOpenDocument handler. - -This routine is provided so a document object which overrides this method - -can call the original MFC version if required. - -Args: - - pathName(str):The full path of the file to open.MFC References - -Returns: - - None - - """ - pass - - - def OnSaveDocument(self,pathName:'str') -> 'None': - """ - Call the MFC OnSaveDocument handler. - -This routine is provided so a document object which overrides this method - -can call the original MFC version if required. - -Args: - - pathName(str):The full path of the file to save.MFC References - -Returns: - - None - - """ - pass - - - def SetModifiedFlag(self,bModified:'typing.Any'=1) -> 'None': - """ - Set the "dirty" flag for the document. - -Args: - - bModified(typing.Any):Set dirty flagMFC References - -Returns: - - None - - """ - pass - - - def SaveModified(self,) -> 'typing.Any': - """ - Call the underlying MFC method. - -Args: - - - -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 - - - def SetPathName(self,path:'str') -> 'None': - """ - Set the full path name for the document. - -Args: - - path(str):The full path of the file.MFC References - -Returns: - - None - - """ - pass - - - def SetTitle(self,title:'str') -> 'None': - """ - Set the title of the document (ie, the name - -to appear in the window caption for the document. - -Args: - - title(str):The new title.MFC References - -Returns: - - None - - """ - pass - - - def UpdateAllViews(self,sender:'PyCView',hint:'typing.Any'=None) -> 'None': - """ - Informs each view when a document changes. - -Args: - - sender(PyCView):The view who initiated the update - hint(typing.Any):A hint for the update.MFC References - -Returns: - - None - - """ - pass - - -class PyCEdit(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,style:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',parent:'PyCWnd',_id:'typing.Any') -> 'None': - """ - Creates the window for a new Edit object. - -Args: - - style(typing.Any):The style for the Edit. Use any of the win32con.BS_* constants. - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The size and position of the Edit. - parent(PyCWnd):The parent window of the Edit. Usually a PyCDialog. - _id(typing.Any):The Edits control ID. - -Returns: - - None - - """ - pass - - - def Clear(self,) -> 'typing.Any': - """ - Clears all text in an edit control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def Copy(self,) -> 'None': - """ - Copys the current selection to the clipboard. - -Args: - - - -Returns: - - None - - """ - pass - - - def Cut(self,) -> 'None': - """ - Cuts the current selection to the clipboard. - -Args: - - - -Returns: - - None - - """ - pass - - - def FmtLines(self,bAddEOL:'typing.Any') -> 'typing.Any': - """ - Sets the formatting options for the control. - -Args: - - bAddEOL(typing.Any):Specifies whether soft line-break characters are to be inserted. A value of TRUE inserts the characters; a value of FALSE removes them.MFC References - -Returns: - - typing.Any:CEdit::FmtLines -Return ValueNonzero if any formatting occurs; otherwise 0. - - - """ - pass - - - def GetFirstVisibleLine(self,) -> 'typing.Any': - """ - Returns zero-based index of the topmost visible line. - -Args: - - - -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 - - - def GetSel(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Returns the start and end of the current selection. - -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 - -end of the current selection) - - - """ - pass - - - def GetLine(self,lineNo:'typing.Any') -> 'typing.Any': - """ - Returns the text in a specified line. - -Args: - - lineNo(typing.Any):Contains the zero-based index value for the desired line.CommentsThis function is not an MFC wrapper. - -Returns: - - typing.Any - - """ - pass - - - def GetLineCount(self,) -> 'typing.Any': - """ - Gets the number of lines in an edit control. - -Args: - - - -Returns: - - typing.Any:CEdit::GetLineCount -Return ValueThe number of lines in the buffer. If the control is empty, the return value is 1. - - - """ - pass - - - def LimitText(self,nChars:'typing.Any'=0) -> 'None': - """ - Sets max length of text that user can enter - -Args: - - nChars(typing.Any):Specifies the length (in bytes) of the text that the user can enter. If this parameter is 0, the text length is set to UINT_MAX bytes. This is the default behavior.MFC References - -Returns: - - None - - """ - pass - - - def LineFromChar(self,charNo:'typing.Any'=-1) -> 'typing.Any': - """ - Returns the line number of the specified character. - -Args: - - charNo(typing.Any):Contains the zero-based index value for the desired character in the text of the edit control, or -1. If -1, then it specifies the current line.MFC References - -Returns: - - typing.Any:CEdit::LineFromChar -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 there is no selection, the current line number is returned. - - - """ - pass - - - def LineIndex(self,lineNo:'typing.Any'=-1) -> 'typing.Any': - """ - Retrieves the character index of a line within a multiple-line edit control. - -Args: - - lineNo(typing.Any):Contains the index value for the desired line in the text of the edit control, or contains -1. If -1, then it specifies the current line.CommentsThis method only works on multi-linr edit controls.MFC References - -Returns: - - typing.Any:CEdit::LineIndex -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 edit control. - - - """ - pass - - - def LineScroll(self,nLines:'typing.Any',nChars:'typing.Any'=0) -> 'typing.Any': - """ - Scroll the control vertically and horizontally - -Args: - - nLines(typing.Any):Specifies the number of lines to scroll vertically. - nChars(typing.Any):Specifies the number of character positions to scroll horizontally. This value is ignored if the edit control has either the ES_RIGHT or ES_CENTER style.CommentsThis method only works on multi-linr edit controls.MFC References - -Returns: - - typing.Any - - """ - pass - - - def Paste(self,) -> 'None': - """ - Pastes the contents of the clipboard into the control. - -Args: - - - -Returns: - - None - - """ - pass - - - def ReplaceSel(self,text:'str') -> 'None': - """ - Replaces the selection with the specified text. - -Args: - - text(str):The text to replace the selection with.MFC References - -Returns: - - None - - """ - pass - - - def SetReadOnly(self,bReadOnly:'typing.Any'=1) -> 'None': - """ - Sets or clears the read-only status of the listbox. - -Args: - - bReadOnly(typing.Any):The read-only state to set.MFC References - -Returns: - - None - - """ - pass - - - def SetSel(self,start:'typing.Any',end:'typing.Any',arg:'typing.Any',bNoScroll1:'typing.Any',bNoScroll:'typing.Any'=0) -> 'None': - """ - Sets the selection in the edit control. - -Args: - - start(typing.Any):Specifies the starting position. If start is 0 and end is -1, all the text in the edit control is selected. If start is -1, any current selection is removed. - end(typing.Any):Specifies the ending position. - arg(typing.Any):As for normal start, end args. - bNoScroll1(typing.Any):Indicates whether the caret should be scrolled into view. If 0, the caret is scrolled into view. If 1, the caret is not scrolled into view.MFC References - bNoScroll(typing.Any):Indicates whether the caret should be scrolled into view. If 0, the caret is scrolled into view. If 1, the caret is not scrolled into view.Alternative Parameters - -Returns: - - None - - """ - pass - - -class PyCEditView(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def IsModified(self,) -> 'typing.Any': - """ - Indicates if the view's document has the modified flag set. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def LoadFile(self,fileName:'str') -> 'None': - """ - Loads a file into the view. - -Args: - - fileName(str):The name of the file to be loaded. - -Returns: - - None - - """ - pass - - - def SetModifiedFlag(self,bModified:'typing.Any'=1) -> 'None': - """ - Sets the modified flag for the view's document. - -Args: - - bModified(typing.Any):The modified state to set. - -Returns: - - None - - """ - pass - - - def GetEditCtrl(self,) -> 'typing.Any': - """ - returns the underlying edit control object. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def PreCreateWindow(self,createStruct:'typing.Any') -> 'typing.Any': - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(typing.Any):A tuple representing a CREATESTRUCT structure. - -Returns: - - typing.Any - - """ - pass - - - def SaveFile(self,fileName:'str') -> 'None': - """ - Saves the view to a file. - -Args: - - fileName(str):The name of the file to be written. - -Returns: - - None - - """ - pass - - - def OnCommand(self,wparam:'typing.Any',lparam:'typing.Any') -> 'None': - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(typing.Any): - lparam(typing.Any):See Also - -Returns: - - None - - """ - pass - - -class PyCFileDialog(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPathName(self,) -> 'str': - """ - Retrives the path name from the file dialog. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetFileName(self,) -> 'str': - """ - Retrives the file name from the file dialog. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetFileExt(self,) -> 'str': - """ - Retrives the file extension from the file dialog. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetFileTitle(self,) -> 'str': - """ - Retrives the file title from the file dialog. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetPathNames(self,) -> 'str': - """ - Retrieves the list of path names from the file dialog. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetReadOnlyPref(self,) -> 'typing.Any': - """ - Retrives the value of the "Read Only" checkbox on the file dialog. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetOFNTitle(self,title:'str') -> 'None': - """ - Sets the Title for the dialog. - -Args: - - title(str):The title for the dialog box. May be None. - -Returns: - - None - - """ - pass - - - def SetOFNInitialDir(self,title:'str') -> 'None': - """ - Sets the initial directory for the dialog. - -Args: - - title(str):The initial directory for the dialog box. May be None. - -Returns: - - None - - """ - pass - - -class PyCFont(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetSafeHandle(self,) -> 'typing.Any': - """ - Retrieves the HFONT for the font as an integer - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyCFontDialog(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def DoModal(self,) -> 'typing.Any': - """ - Displays a dialog and allows the user to make a selection. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetCurrentFont(self,) -> 'typing.Any': - """ - Returns a dictionary describing the current font. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetCharFormat(self,) -> 'typing.Any': - """ - Returns the font selection in a CHARFORMAT tuple. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetColor(self,) -> 'typing.Any': - """ - Determines the color of the selected font. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetFaceName(self,) -> 'str': - """ - Returns the face name of the selected font. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetStyleName(self,) -> 'str': - """ - Returns the style name of the selected font. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetSize(self,) -> 'typing.Any': - """ - Returns he font's size, in tenths of a point. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetWeight(self,) -> 'typing.Any': - """ - Returns the font's weight. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def IsStrikeOut(self,) -> 'typing.Any': - """ - Determines whether the font is displayed with strikeout. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def IsUnderline(self,) -> 'typing.Any': - """ - Determines whether the font is displayed with underline. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def IsBold(self,) -> 'typing.Any': - """ - Determines whether the font is displayed bold. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def IsItalic(self,) -> 'typing.Any': - """ - Determines whether the font is displayed with italic. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyCFormView(object): - """A class which implementes a CFormView (ie, a view based on a dialog resource.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OnCommand(self,wparam:'typing.Any',lparam:'typing.Any') -> 'None': - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(typing.Any): - lparam(typing.Any):See Also - -Returns: - - None - - """ - pass - - -class PyCFrameWnd(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def BeginModalState(self,) -> 'None': - """ - Sets the frame window to modal. - -Args: - - - -Returns: - - None - - """ - pass - - - def CreateWindow(self,wndClass:'str',title:'str',style:'typing.Any',PyCWnd:'typing.Any',menuId:'typing.Any',styleEx:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]'=None,createContext:'typing.Any'=None) -> 'typing.Any': - """ - Creates the actual window for the PyCFrameWnd object. - -Args: - - wndClass(str):The window class name, or None - title(str):The window title - style(typing.Any):The window style - PyCWnd(typing.Any):The parent window - menuId(typing.Any):The string or integer id for the menu. - styleEx(typing.Any):The extended style of the window being created.MFC References - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The default rectangle - createContext(typing.Any):A tuple representing a CREATECONTEXT structure. - -Returns: - - typing.Any - - """ - pass - - - def EndModalState(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def DockControlBar(self,controlBar:'PyCControlBar',arg:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',dockBarId:'typing.Any'=0) -> 'None': - """ - Docks a control bar. - -Args: - - controlBar(PyCControlBar):The control bar to dock. - arg(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Determines, in screen coordinates, where the control bar will be docked in the nonclient area of the destination frame window.MFC References - dockBarId(typing.Any):Determines which sides of the frame window to consider for docking. - -Returns: - - None - - """ - pass - - - def EnableDocking(self,style:'typing.Any') -> 'None': - """ - Enable dockable control bars in a frame window - -Args: - - style(typing.Any):Specifies which sides of the frame window can serve as docking sites for control bars.CommentsBy default, control bars will be docked to a side of the frame window in the following order: top, bottom, left, right. - -Returns: - - None - - """ - pass - - - def FloatControlBar(self,controlBar:'PyCControlBar',arg:'typing.Tuple[typing.Any, typing.Any]',style:'typing.Any') -> 'None': - """ - Floats a control bar. - -Args: - - controlBar(PyCControlBar):The control bar to dock. - arg(typing.Tuple[typing.Any, typing.Any]):The location, in screen coordinates, where the top left corner of the control bar will be placed. - style(typing.Any):Determines which sides of the frame window to consider for docking.MFC References - -Returns: - - None - - """ - pass - - - def GetActiveDocument(self,) -> 'PyCDocument': - """ - Gets the currently active document, else None - -Args: - - - -Returns: - - PyCDocument - - """ - pass - - - def GetControlBar(self,_id:'typing.Any') -> 'PyCControlBar': - """ - Retrieves the specified control bar. - -Args: - - _id(typing.Any):The ID of the toolbar to be retrieved - -Returns: - - PyCControlBar - - """ - pass - - - def GetMessageString(self,_id:'typing.Any') -> 'str': - """ - Retrieves message corresponding to a command ID. - -Args: - - _id(typing.Any):The ID to be retrievedSee Also - -Returns: - - str - - """ - pass - - - def GetMessageBar(self,) -> 'PyCWnd': - """ - Retrieves the message bar for the frame. - -Args: - - - -Returns: - - PyCWnd - - """ - pass - - - def IsTracking(self,) -> 'typing.Any': - """ - Determines if splitter bar is currently being moved. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def InModalState(self,) -> 'typing.Any': - """ - Returns a value indicating whether or not a frame window is in a modal state. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def LoadAccelTable(self,_id:'PyResourceId') -> 'None': - """ - Loads an accelerator table. - -Args: - - _id(PyResourceId):Name or id of the resource that contains the table - -Returns: - - None - - """ - pass - - - def LoadFrame(self,idResource:'typing.Any',style:'typing.Any'=-1,wndParent:'PyCWnd'=None,context:'typing.Any'=None) -> 'None': - """ - Loads a Windows frame window and associated resources - -Args: - - idResource(typing.Any):The Id of the resources (menu, icon, etc) for this window - style(typing.Any):The window style. Note -1 implies win32con.WS_OVERLAPPEDWINDOW|win32con.FWS_ADDTOTITLE - wndParent(PyCWnd):The parent of the window, or None. - context(typing.Any):An object passed to the OnCreateClient for the frame,MFC References - -Returns: - - None - - """ - pass - - - def LoadBarState(self,profileName:'str') -> 'None': - """ - Loads a control bars settings - -Args: - - profileName(str):Name of a section in the initialization file or a key in the Windows registry where state information is stored.MFC References - -Returns: - - None - - """ - pass - - - def PreCreateWindow(self,createStruct:'typing.Any') -> 'typing.Any': - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(typing.Any):A tuple representing a CREATESTRUCT structure.See Also - -Returns: - - typing.Any - - """ - pass - - - def SaveBarState(self,profileName:'str') -> 'None': - """ - Saves a control bars settings - -Args: - - profileName(str):Name of a section in the initialization file or a key in the Windows registry where state information is stored.MFC References - -Returns: - - None - - """ - pass - - - def ShowControlBar(self,controlBar:'PyCControlBar',bShow:'typing.Any',bDelay:'typing.Any') -> 'None': - """ - Shows a control bar. - -Args: - - controlBar(PyCControlBar):The control bar to dock. - bShow(typing.Any):Show or hide flag. - bDelay(typing.Any):If TRUE, delay showing the control bar. If FALSE, show the control bar immediately.MFC References - -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 - -when the frame window is resized. - -Args: - - bNotify(typing.Any):Notify flagMFC References - -Returns: - - None - - """ - pass - - - def GetActiveView(self,) -> 'PyCView': - """ - Retrieves the active view. - -Args: - - - -Returns: - - PyCView - - """ - pass - - - def OnBarCheck(self,_id:'typing.Any') -> 'typing.Any': - """ - Changes the state of the specified controlbar. - -Args: - - _id(typing.Any):The control ID of the control bar. - -Returns: - - typing.Any - - """ - pass - - - def OnUpdateControlBarMenu(self,cmdUI:'PyCCmdUI') -> 'typing.Any': - """ - Checks the state of a menu item - -Args: - - cmdUI(PyCCmdUI):A cmdui object - -Returns: - - typing.Any - - """ - pass - - - def SetActiveView(self,view:'PyCView',bNotify:'typing.Any'=1) -> 'None': - """ - Sets the active view for a frame. - -Args: - - view(PyCView):The view to set active. - bNotify(typing.Any):Specifies whether the view is to be notified of activation. If TRUE, OnActivateView is called for the new view; if FALSE, it is not. - -Returns: - - None - - """ - pass - - -class PyCGdiObject(object): - """A class which encapsulates an MFC CGdiObject.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCImageList(object): - """A Python type encapsulating an MFC CImageList class.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Add(self,arg:'typing.Tuple[typing.Any, typing.Any]',bitmap:'typing.Any',color:'typing.Any',hIcon:'typing.Any') -> 'typing.Any': - """ - Adds an image to the list. - -Args: - - arg(typing.Tuple[typing.Any, typing.Any]):2 Bitmaps to use (primary and mask)Alternative Parameters - bitmap(typing.Any):Bitmap to use - color(typing.Any):Color to use for the mask.Alternative Parameters - hIcon(typing.Any):Handle of an icon to add.Return ValueZero-based index of the first new image. - -Returns: - - typing.Any:Handle of an icon to add. -Return ValueZero-based index of the first new image. - - - """ - pass - - - def Destroy(self,) -> 'None': - """ - Destroys the underlying CImageList - -Args: - - - -Returns: - - None - - """ - pass - - - def DeleteImageList(self,) -> 'None': - """ - Deletes an image list. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetBkColor(self,) -> 'typing.Any': - """ - Retrieves the background color of an Image List. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetSafeHandle(self,) -> 'typing.Any': - """ - Retrieves the HIMAGELIST for the object - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetImageCount(self,) -> 'typing.Any': - """ - Retrieves the number of images in an image list. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetImageInfo(self,index:'typing.Any') -> 'typing.Any': - """ - Retrieves information about an image. - -Args: - - index(typing.Any):Index of image.Return ValueThe return info is a tuple describing an IMAGELIST structure. - -Returns: - - typing.Any:Index of image.Return ValueThe return info is a tuple describing an IMAGELIST structure. - - - """ - pass - - - def SetBkColor(self,color:'typing.Any') -> 'None': - """ - Sets the background color for an Image List. - -Args: - - color(typing.Any):The new background color. - -Returns: - - None - - """ - pass - - -class PyCListBox(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddString(self,_object:'typing.Any') -> 'typing.Any': - """ - Adds a string to a listbox. - -Args: - - _object(typing.Any):Any object. If not a string, __str__, __repr__ or a default repr() will be usedMFC References - -Returns: - - typing.Any:CListBox::AddString -Return ValueThe zero based index of the new string. - - - """ - pass - - - def DeleteString(self,pos:'typing.Any') -> 'typing.Any': - """ - Deletes an item from a listbox. - -Args: - - pos(typing.Any):The zero based index of the item to delete.MFC References - -Returns: - - typing.Any:CListBox::DeleteString -Return ValueThe count of the items remaining in the list. - - - """ - pass - - - def Dir(self,attr:'typing.Any',wild:'str') -> 'typing.Any': - """ - Fills a listbox with a directory listing. - -Args: - - attr(typing.Any):The attributes of the files to locate - wild(str):A file specification string - eg, *.*MFC References - -Returns: - - typing.Any:CListBox::Dir -Return ValueThe index of the last file name added to the list. - - - """ - pass - - - def GetCaretIndex(self,) -> 'typing.Any': - """ - Returns the index of the item which has focus. - -Args: - - - -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. - -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 - - - def GetCount(self,) -> 'typing.Any': - """ - Returns the count of items in the listbox. - -Args: - - - -Returns: - - typing.Any:CListBox::GetCount -Return ValueReturns the number of items currently in the listbox. - - - """ - pass - - - def GetCurSel(self,) -> 'typing.Any': - """ - Returns the index of the currently selected item. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetItemData(self,item:'typing.Any') -> 'typing.Any': - """ - Retrieves the application-specific object associated with an item. - -Args: - - item(typing.Any):The index of the item whose data is to be retrieved. - -Returns: - - typing.Any - - """ - pass - - - def GetItemValue(self,item:'typing.Any') -> 'typing.Any': - """ - Retrieves the application-specific value associated with an item. - -Args: - - item(typing.Any):The index of the item whose data is to be retrieved. - -Returns: - - typing.Any - - """ - pass - - - def GetSel(self,index:'typing.Any') -> 'typing.Any': - """ - Returns the selection state of a specified item. - -Args: - - index(typing.Any):The index of the item to return the state for.MFC References - -Returns: - - typing.Any:CListBox::GetSel -Return ValueA +ve number if the item is selected, else zero. - - - """ - pass - - - def GetSelCount(self,) -> 'typing.Any': - """ - Returns the number of selected items in a multiple selection listbox. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetSelItems(self,) -> 'typing.Any': - """ - Returns a list of the indexes of the currently selected items in a multiple - -selection listbox. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetSelTextItems(self,) -> 'typing.Any': - """ - Returns a list of the strings of the currently selected items in a multiple - -selection listbox. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetTopIndex(self,) -> 'typing.Any': - """ - Returns the index of the top most visible item. - -Args: - - - -Returns: - - typing.Any:CListBox::GetTopIndex -Return ValueThe zero based index of the top most visible item. - - - """ - pass - - - def GetText(self,index:'typing.Any') -> 'str': - """ - Returns the string for a specified item. - -Args: - - index(typing.Any):The index of the item to retrieve the text of - -Returns: - - str - - """ - pass - - - def GetTextLen(self,index:'typing.Any') -> 'typing.Any': - """ - Returns the length of the string for a specified item. - -Args: - - index(typing.Any):The index of the item to retrieve the length of the text.MFC References - -Returns: - - typing.Any - - """ - pass - - - def InsertString(self,pos:'typing.Any',_object:'typing.Any') -> 'typing.Any': - """ - Insert a string into a listbox. - -Args: - - pos(typing.Any):The zero based index in the listbox to insert the new string - _object(typing.Any):The object to be added to the listboxMFC References - -Returns: - - typing.Any:CListBox::InsertString -Return ValueThe zero based index of the new string added. - - - """ - pass - - - def ResetContent(self,) -> 'None': - """ - Clear all the items from a listbox. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetCaretIndex(self,index:'typing.Any',bScroll:'typing.Any'=1) -> 'None': - """ - Sets the focus rectange to a specified item. - -Args: - - index(typing.Any):The zero based index of the item. - bScroll(typing.Any):Should the listbox scroll to the item?MFC References - -Returns: - - None - - """ - pass - - - def SelectString(self,after:'typing.Any',string:'str') -> 'None': - """ - Searches for a list-box item that matches the specified string, and selects it. - -Args: - - after(typing.Any):Contains the zero-based index of the item before the first item to be searched, or -1 for the entire listbox. - string(str):The string to search for.MFC References - -Returns: - - None:CListBox::SelectString -Return ValueThe return value is always None - an exception is raised if the string can not be located. - - - """ - pass - - - def SelItemRange(self,bSel:'typing.Any',start:'typing.Any',end:'typing.Any') -> 'None': - """ - Selects an item range. - -Args: - - bSel(typing.Any):Should the selection specified be set or cleared? - start(typing.Any):The zero based index of the first item to select. - end(typing.Any):The zero based index of the last item to select. - -Returns: - - None - - """ - pass - - - def SetCurSel(self,index:'typing.Any') -> 'None': - """ - Selects an item in a single selection listbox. - -Args: - - index(typing.Any):The zero based index of the item to select.MFC References - -Returns: - - None - - """ - pass - - - def SetItemData(self,item:'typing.Any',Data:'typing.Any') -> 'typing.Any': - """ - Sets the item's application-specific object value. - -Args: - - item(typing.Any):Index of the item whose Data is to be set. - Data(typing.Any):New value for the data.CommentsNote that a reference count is not added to the object. This it is your responsibility to make sure the object remains alive while in the list. - -Returns: - - typing.Any - - """ - pass - - - def SetItemValue(self,item:'typing.Any',data:'typing.Any') -> 'typing.Any': - """ - Sets the item's application-specific value. - -Args: - - item(typing.Any):Index of the item whose Data is to be set. - data(typing.Any):New value for the data. - -Returns: - - typing.Any - - """ - pass - - - def SetSel(self,index:'typing.Any',bSel:'typing.Any'=1) -> 'None': - """ - Selects an item in a multiple selection listbox. - -Args: - - index(typing.Any):The zero based index of the item to select. - bSel(typing.Any):Should the item be selected or deselected?MFC References - -Returns: - - None - - """ - pass - - - def SetTabStops(self,eachTabStop:'typing.Any',tabStops:'typing.Any') -> 'None': - """ - Sets the tab stops for a listbox. - -Args: - - eachTabStop(typing.Any):The position for each tab stop.Alternative Parameters - tabStops(typing.Any):Each individual tab stop. - -Returns: - - None - - """ - pass - - - def SetTopIndex(self,index:'typing.Any') -> 'None': - """ - Sets the top index (top most visible item) of the listbox. - -Args: - - index(typing.Any):The zero based index of the item to place at the top of the list.MFC References - -Returns: - - None - - """ - pass - - -class PyCListCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Arrange(self,code:'typing.Any') -> 'None': - """ - Aligns items on a grid. - -Args: - - code(typing.Any):Specifies the alignment style for the items - -Returns: - - None - - """ - pass - - - def CreateWindow(self,style:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',PyCWnd:'typing.Any',_id:'typing.Any') -> 'None': - """ - Creates the actual window for the object. - -Args: - - style(typing.Any):The window style - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The default rectangle - PyCWnd(typing.Any):The parent window - _id(typing.Any):The control IDMFC References - -Returns: - - None - - """ - pass - - - def DeleteAllItems(self,) -> 'None': - """ - Deletes all items from the list. - -Args: - - - -Returns: - - None - - """ - pass - - - def DeleteItem(self,item:'typing.Any') -> 'None': - """ - Deletes the specified item. - -Args: - - item(typing.Any):The item to delete. - -Returns: - - None - - """ - pass - - - def GetTextColor(self,) -> 'typing.Any': - """ - Retrieves the text color of a list view control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetTextColor(self,color:'typing.Any') -> 'None': - """ - Sets the text color of a list view control. - -Args: - - color(typing.Any):The new color. - -Returns: - - None - - """ - pass - - - def GetBkColor(self,) -> 'typing.Any': - """ - Retrieves the background color of the control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetBkColor(self,color:'typing.Any') -> 'None': - """ - Sets the background color of the control. - -Args: - - color(typing.Any):The new background color. - -Returns: - - None - - """ - pass - - - def GetItem(self,item:'typing.Any',sub:'typing.Any') -> 'LV_ITEM': - """ - Retrieves the details of an items attributes. - -Args: - - item(typing.Any):The index of the item whose attributes are to be retrieved. - sub(typing.Any):Specifies the subitem whose text is to be retrieved. - -Returns: - - LV_ITEM - - """ - pass - - - def GetItemCount(self,) -> 'typing.Any': - """ - Retrieves the number of items in a list view control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetItemRect(self,item:'typing.Any',bTextOnly:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': - """ - Retrieves the bounding rectangle of a list view item. - -Args: - - item(typing.Any):Index of the item whose Data is to be set. - bTextOnly(typing.Any):f this parameter is nonzero, the bounding rectangle includes only the text of the item. Otherwise it includes the entire line that the item occupies in the list view control. - -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 - -list view item. - -Args: - - - -Returns: - - PyCEdit - - """ - pass - - - def EditLabel(self,item:'typing.Any') -> 'PyCEdit': - """ - Edits a specified list view item in-place. - -Args: - - item(typing.Any):The index of item to edit. - -Returns: - - PyCEdit - - """ - pass - - - def EnsureVisible(self,item:'typing.Any',bPartialOK:'typing.Any') -> 'typing.Any': - """ - Ensures that a list view item is visible in its list view control. - -Args: - - item(typing.Any):The index of item to edit. - bPartialOK(typing.Any):Specifies whether partial visibility is acceptable. - -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 - -item. - -Args: - - item(typing.Any):The index of the item to edit. - -Returns: - - typing.Tuple[PyCImageList, typing.Any, typing.Any] - - """ - pass - - - def GetImageList(self,nImageList:'typing.Any') -> 'PyCImageList': - """ - Retrieves the current image list. - -Args: - - nImageList(typing.Any):Value specifying which image list to retrieve. It can be one of: - commctrl.LVSIL_NORMAL Image list with large icons. - commctrl.LVSIL_SMALL Image list with small icons. - commctrl.LVSIL_STATE Image list with state images. - -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 - -relationship to a given item. - -Args: - - item(typing.Any):Index of the item to begin the searching with, or -1 to find the first item that matches the specified flags. The specified item itself is excluded from the search. - flags(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: LVNI_ABOVELVNI_ALLLVNI_BELOWLVNI_TOLEFTLVNI_TORIGHT The state can be zero, or it can be one or more of these values: LVNI_DROPHILITEDLVNI_FOCUSEDLVNI_HIDDENLVNI_MARKEDLVNI_SELECTED 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. - -Returns: - - 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: - -LVNI_ABOVELVNI_ALLLVNI_BELOWLVNI_TOLEFTLVNI_TORIGHT - -The state can be zero, or it can be one or more of these values: - -LVNI_DROPHILITEDLVNI_FOCUSEDLVNI_HIDDENLVNI_MARKEDLVNI_SELECTED - -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 - - - def InsertColumn(self,colNo:'typing.Any',item:'LV_COLUMN') -> 'typing.Any': - """ - Inserts a column into a list control when in report view. - -Args: - - colNo(typing.Any):The new column number - item(LV_COLUMN):A tuple describing the new column. - -Returns: - - typing.Any - - """ - pass - - - def InsertItem(self,item:'LV_ITEM',item1:'typing.Any',text:'typing.Any',image:'typing.Any',item2:'typing.Any',text1:'typing.Any') -> 'typing.Any': - """ - Inserts an item into the list. - -Args: - - item(LV_ITEM):A tuple describing the new item.Alternative Parameters - item1(typing.Any):The index of the item. - text(typing.Any):The text of the item. - image(typing.Any):The index of the image to use.Alternative Parameters - item2(typing.Any):The index of the item. - text1(typing.Any):The text of the item. - -Returns: - - typing.Any - - """ - pass - - - def SetImageList(self,imageList:'PyCImageList',imageType:'typing.Any') -> 'typing.Any': - """ - Assigns an image list to a list view control. - -Args: - - imageList(PyCImageList):The Image List to use. - imageType(typing.Any):Type of image list. It can be one of (COMMCTRL.) LVSIL_NORMAL, LVSIL_SMALL or LVSIL_STATE - -Returns: - - typing.Any - - """ - pass - - - def GetColumn(self,column:'typing.Any') -> 'LV_COLUMN': - """ - Retrieves the details of a column in the control. - -Args: - - column(typing.Any):The index of the column whose attributes are to be retrieved. - -Returns: - - LV_COLUMN - - """ - pass - - - def GetTextBkColor(self,) -> 'typing.Any': - """ - Retrieves the text background color of a list view control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetTextBkColor(self,color:'typing.Any') -> 'None': - """ - Sets the text background color of a list view control. - -Args: - - color(typing.Any):The new background color. - -Returns: - - None - - """ - pass - - - def GetTopIndex(self,) -> 'typing.Any': - """ - Retrieves the index of the topmost visible item. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetCountPerPage(self,) -> 'typing.Any': - """ - Calculates the number of items that can fit vertically in a list view - -control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetSelectedCount(self,) -> 'typing.Any': - """ - Retrieves the number of selected items in the list view control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetItem(self,item:'LV_ITEM') -> 'typing.Any': - """ - Sets some of all of an items attributes. - -Args: - - item(LV_ITEM):A tuple describing the new item. - -Returns: - - typing.Any - - """ - pass - - - def SetItemState(self,item:'typing.Any',state:'typing.Any',mask:'typing.Any') -> 'typing.Any': - """ - Changes the state of an item in a list view control. - -Args: - - item(typing.Any):Index of the item whose state is to be set. - state(typing.Any):New values for the state bits. - mask(typing.Any):Mask specifying which state bits to change. - -Returns: - - typing.Any - - """ - pass - - - def GetItemState(self,item:'typing.Any',mask:'typing.Any') -> 'typing.Any': - """ - Retrieves the state of a list view item. - -Args: - - item(typing.Any):The index of the item whose position is to be retrieved. - mask(typing.Any):Mask specifying which of the item's state flags to return. - -Returns: - - typing.Any - - """ - pass - - - def SetItemData(self,item:'typing.Any',Data:'typing.Any') -> 'typing.Any': - """ - Sets the item's application-specific value. - -Args: - - item(typing.Any):Index of the item whose Data is to be set. - Data(typing.Any):New value for the data.CommentsNote that a reference count is not added to the object. This it is your responsibility to make sure the object remains alive while in the list. - -Returns: - - typing.Any - - """ - pass - - - def GetItemData(self,item:'typing.Any') -> 'typing.Any': - """ - Retrieves the application-specific value associated with an item. - -Args: - - item(typing.Any):The index of the item whose data is to be retrieved. - -Returns: - - typing.Any - - """ - pass - - - def SetItemCount(self,count:'typing.Any') -> 'None': - """ - Prepares a list view control for adding a large number of items. - -Args: - - count(typing.Any):Number of items that the control will ultimately contain.CommentsBy calling this function before adding a large number of items, you enable a list view control to reallocate its internal data structures only once rather than every time you add an item. - -Returns: - - None - - """ - pass - - - def SetItemText(self,item:'typing.Any',sub:'typing.Any',text:'str') -> 'typing.Any': - """ - Changes the text of a list view item or subitem. - -Args: - - item(typing.Any):Index of the item whose text is to be set. - sub(typing.Any):Index of the subitem, or zero to set the item label. - text(str):String that contains the new item text. - -Returns: - - typing.Any - - """ - pass - - - def GetItemText(self,item:'typing.Any',sub:'typing.Any') -> 'typing.Any': - """ - Retrieves the text of a list view item or subitem. - -Args: - - item(typing.Any):The index of the item whose text is to be retrieved. - sub(typing.Any):Specifies the subitem whose text is to be retrieved. - -Returns: - - typing.Any - - """ - pass - - - def RedrawItems(self,first:'typing.Any',first1:'typing.Any') -> 'typing.Any': - """ - Forces a listview to repaint a range of items. - -Args: - - first(typing.Any):Index of the first item to be repainted. - first1(typing.Any):Index of the last item to be repainted.CommentsThe specified items are not actually repainted until the list view window receives a WM_PAINT message. To repaint immediately, call the Windows UpdateWindow function after using this function. - -Returns: - - typing.Any - - """ - pass - - - def Update(self,item:'typing.Any') -> 'None': - """ - Forces the control to repaint a specified item. - -Args: - - item(typing.Any):The new color. - -Returns: - - None - - """ - pass - - - def SetColumn(self,colNo:'typing.Any',item:'LV_COLUMN') -> 'typing.Any': - """ - Changes column state in a list control when in report view. - -Args: - - colNo(typing.Any):The to be modified column number - item(LV_COLUMN):A tuple describing the modified column. - -Returns: - - typing.Any - - """ - pass - - - def DeleteColumn(self,first:'typing.Any') -> 'typing.Any': - """ - Deletes the specified column from the list control. - -Args: - - first(typing.Any):Index of the column to be removed. - -Returns: - - typing.Any - - """ - pass - - - def GetColumnWidth(self,first:'typing.Any') -> 'typing.Any': - """ - Gets the width of the specified column in the list control. - -Args: - - first(typing.Any):Index of the column whose width is to be retrieved. - -Returns: - - typing.Any - - """ - pass - - - def SetColumnWidth(self,first:'typing.Any',first1:'typing.Any') -> 'typing.Any': - """ - Sets the width of the specified column in the list control. - -Args: - - first(typing.Any):Index of the column to be changed. - first1(typing.Any):New width of the column. - -Returns: - - typing.Any - - """ - pass - - - def GetStringWidth(self,first:'typing.Any') -> 'typing.Any': - """ - Gets the necessary column width to fully display this text in a column. - -Args: - - first(typing.Any):String that contains the text whose width is to be determined.CommentsDoesn't take the size of an included Image in account, only the size of the text is determined. - -Returns: - - typing.Any - - """ - pass - - - def HitTest(self,arg:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': - """ - Determines which list view item, if any, is at a specified position. - -Args: - - arg(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:ValueDescriptioncommctrl.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 list item.commctrl.LVHT_ONITEMICONThe position is over a list view item's icon.commctrl.LVHT_ONITEMLABELThe position is over a list view item's text.commctrl.LVHT_ONITEMSTATEICONThe position is over the state image of a list view item.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. - -Returns: - - 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: - - - -Value - - -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 - -list item. -commctrl.LVHT_ONITEMICONThe position is over a list view item's icon. -commctrl.LVHT_ONITEMLABELThe position is over a list view item's text. -commctrl.LVHT_ONITEMSTATEICONThe position is over the state image of a list view item. -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 - - - def GetItemPosition(self,item:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Determines the position of the specified item. - -Args: - - item(typing.Any):The item to determine the position for. - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - -class PyCListView(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def PreCreateWindow(self,createStruct:'typing.Any') -> 'typing.Any': - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(typing.Any):A tuple representing a CREATESTRUCT structure. - -Returns: - - typing.Any - - """ - pass - - - def GetListCtrl(self,) -> 'PyCListCtrl': - """ - Returns the underlying list control object. - -Args: - - - -Returns: - - PyCListCtrl - - """ - pass - - - def OnCommand(self,wparam:'typing.Any',lparam:'typing.Any') -> 'None': - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(typing.Any): - lparam(typing.Any):See Also - -Returns: - - None - - """ - pass - - -class PyCMDIChildWnd(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ActivateFrame(self,cmdShow:'typing.Any'=-1) -> 'None': - """ - Calls the underlying MFC ActivateFrame method. - -Args: - - cmdShow(typing.Any):The status of the window.See Also - -Returns: - - None - - """ - pass - - - def CreateWindow(self,wndClass:'str',title:'str',style:'typing.Any',PyCWnd:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]'=None,createContext:'typing.Any'=None) -> 'typing.Any': - """ - Creates the actual window for the PyCWnd object. - -Args: - - wndClass(str):The window class name, or None - title(str):The window title - style(typing.Any):The window style - PyCWnd(typing.Any):The parent window - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The default rectangle - createContext(typing.Any):A tuple representing a CREATECONTEXT structure.CommentsYou do not need to call this method if you use the MFC Document/View framework. - -Returns: - - typing.Any - - """ - pass - - - def GetMDIFrame(self,) -> 'None': - """ - Returns the MDI parent frame - -Args: - - - -Returns: - - None - - """ - pass - - - def MDIActivate(self,cmdShow:'typing.Any'=-1) -> 'None': - """ - Activates the MDI frame independent of the main frame. - -Args: - - cmdShow(typing.Any):The status of the window.See Also - -Returns: - - None - - """ - pass - - - def PreCreateWindow(self,createStruct:'typing.Any') -> 'typing.Any': - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(typing.Any):A tuple representing a CREATESTRUCT structure.See Also - -Returns: - - typing.Any - - """ - pass - - - def PreTranslateMessage(self,) -> 'None': - """ - Calls the base PreTranslateMessage handler - -Args: - - - -Returns: - - None - - """ - pass - - - def OnCommand(self,wparam:'typing.Any',lparam:'typing.Any') -> 'None': - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(typing.Any): - lparam(typing.Any):See Also - -Returns: - - None - - """ - pass - - - def OnClose(self,) -> 'None': - """ - Calls the standard Python framework OnClose handler - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCMDIFrameWnd(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetMDIClient(self,) -> 'PyCMDIFrameWnd': - """ - Returns the MDI client window - -Args: - - - -Returns: - - PyCMDIFrameWnd - - """ - pass - - - def MDIGetActive(self,) -> 'typing.Tuple[PyCMDIChildWnd, typing.Any]': - """ - Retrieves the current active MDI child window, along - -with a flag indicating whether the child window is maximized. - -Args: - - - -Returns: - - typing.Tuple[PyCMDIChildWnd, typing.Any] - - """ - pass - - - def MDIActivate(self,window:'PyCWnd') -> 'PyCMDIFrameWnd': - """ - Activate an MDI child window - -Args: - - window(PyCWnd):The window to activate. - -Returns: - - PyCMDIFrameWnd - - """ - pass - - - def MDINext(self,fNext:'typing.Any'=0) -> 'None': - """ - Activates the next MDI window - -Args: - - fNext(typing.Any):Indicates if the next (0) or previous (non-zero) window is requested.CommentsUnlike MFC, this version supports the fNext param in the WM_MDINEXT message. - -Returns: - - None - - """ - pass - - - def PreCreateWindow(self,createStruct:'typing.Any') -> 'typing.Any': - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(typing.Any):A tuple representing a CREATESTRUCT structure.See Also - -Returns: - - typing.Any - - """ - pass - - - def PreTranslateMessage(self,) -> 'None': - """ - Calls the base PreTranslateMessage handler - -Args: - - - -Returns: - - None - - """ - pass - - - def OnCommand(self,wparam:'typing.Any',lparam:'typing.Any') -> 'None': - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(typing.Any): - lparam(typing.Any):See Also - -Returns: - - None - - """ - pass - - - def OnContextHelp(self,) -> 'typing.Any': - """ - Calls the underlying MFC OnContextHelp method. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def OnClose(self,) -> 'None': - """ - Calls the standard Python framework OnClose handler - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCMenu(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - 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 - -by setting values in nFlags. - -Args: - - flags(typing.Any):Specifies information about the state of the new menu item when it is added to the menu. May be a combination of the win32con.MF_* values. - _id(typing.Any):Specifies either the command ID of the new menu item. - value(typing.Union[str, typing.Any]):Specifies the content of the new menu item. If used, flags must contain win32con.MF_STRING. - -Returns: - - None - - """ - pass - - - def DeleteMenu(self,_id:'typing.Any',flags:'typing.Any') -> 'str': - """ - Deletes the specified menu item. - -Args: - - _id(typing.Any):The id of the item being deleted. - flags(typing.Any):Specifies how the id parameter is interpreted. It must be one of win32con.MF_BYCOMMAND or win32con.MF_BYPOSITION. - -Returns: - - str - - """ - pass - - - def EnableMenuItem(self,_id:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - Enables, disables, or dims a menu item. - -Args: - - _id(typing.Any):Specifies the command ID of the menu item. This parameter can specify pop-up menu items as well as standard menu items. - flags(typing.Any):Specifies the action to take. It can be a combination of MF_DISABLED, MF_ENABLED, or MF_GRAYED, with MF_BYCOMMAND or MF_BYPOSITIONCommentsThe PyCMenu::CreateMenu, PyCMenu::InsertMenu, PyCMenu::ModifyMenu, and PyCMenu::LoadMenuIndirect member functions can also set the state (enabled, disabled, or dimmed) of a menu item. - -Returns: - - typing.Any - - """ - pass - - - def GetHandle(self,) -> 'typing.Any': - """ - Returns the menu object's underlying hMenu. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetMenuItemCount(self,) -> 'typing.Any': - """ - Determines the number of items in a menu. - -Args: - - - -Returns: - - typing.Any:PyCMenu.GetMenuItemCount - -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 - - - def GetMenuItemID(self,pos:'typing.Any') -> 'typing.Any': - """ - Returns the item ID for the specified item in a pop-up menu. - -Args: - - pos(typing.Any):The position (zero-based) of the menu item whose ID is being retrieved.CommentsIf the specified item is a pop-up menu (as opposed to an item within the pop-up menu), the return value is -1. If nPos corresponds to a SEPARATOR menu item, the return value is 0. - -Returns: - - typing.Any - - """ - pass - - - def GetMenuString(self,_id:'typing.Any',arg:'typing.Any') -> 'str': - """ - Returns the string for a specified menu item. - -Args: - - _id(typing.Any):The id of the item being requested. - arg(typing.Any):Specifies how the id parameter is interpreted. It must be one of win32con.MF_BYCOMMAND or win32con.MF_BYPOSITION. - -Returns: - - str - - """ - pass - - - def GetSubMenu(self,pos:'typing.Any') -> 'PyCMenu': - """ - Returns a submenu. - -Args: - - pos(typing.Any):The position (zero-based) of the menu item being retrieved. - -Returns: - - PyCMenu - - """ - pass - - - def InsertMenu(self,pos:'typing.Any',flags:'typing.Any',_id:'typing.Union[PyCMenu, typing.Any]'=0,value:'typing.Union[str, typing.Any]'=None) -> 'None': - """ - Inserts an item into a menu. - -Args: - - pos(typing.Any):The position (zero-based) the item should be inserted. - flags(typing.Any):Flags for the new item. - _id(typing.Union[PyCMenu, typing.Any]):The ID for a new menu item, or handle to a submenu - value(typing.Union[str, typing.Any]):A string for the menu item. - -Returns: - - None - - """ - pass - - - def ModifyMenu(self,pos:'typing.Any',flags:'typing.Any',_id:'typing.Any'=0,value:'typing.Union[str, typing.Any]'=None) -> 'None': - """ - Modify an item in a menu. - -Args: - - pos(typing.Any):The position (zero-based) the item to be changed. - flags(typing.Any):Flags for the item. - _id(typing.Any):The ID for the item. - value(typing.Union[str, typing.Any]):A string for the menu item. - -Returns: - - None - - """ - pass - - - def TrackPopupMenu(self,arg:'typing.Tuple[typing.Any, typing.Any]',arg1:'typing.Any',arg2:'PyCWnd') -> 'None': - """ - Creates a popup menu anywhere on the screen. - -Args: - - arg(typing.Tuple[typing.Any, typing.Any]):The position for the menu.. - arg1(typing.Any):Flags for the menu. - arg2(PyCWnd):The owner of the menu.CommentsThe TrackPopupMenu function displays a floating pop-up menu at the 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 returned instead of the normal exception. - -Returns: - - None:The owner of the menu. -Comments - -The TrackPopupMenu function displays a floating pop-up menu at the - -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 - -returned instead of the normal exception. - - - """ - pass - - -class PyCOleClientItem(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateNewItem(self,) -> 'None': - """ - Creates an embedded item. - -Args: - - - -Returns: - - None - - """ - pass - - - def Close(self,) -> 'None': - """ - Closes the item - -Args: - - - -Returns: - - None - - """ - pass - - - def DoVerb(self,) -> 'None': - """ - Executes the specified verb. - -Args: - - - -Returns: - - None - - """ - pass - - - def Draw(self,) -> 'None': - """ - Draws the OLE item into the specified bounding rectangle using the specified device - -context. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetActiveView(self,) -> 'PyCView': - """ - Obtains the active view for the item - -Args: - - - -Returns: - - PyCView - - """ - pass - - - def GetDocument(self,) -> 'PyCDocument': - """ - Obtains the current document for the item - -Args: - - - -Returns: - - PyCDocument - - """ - pass - - - def GetInPlaceWindow(self,) -> 'PyCWnd': - """ - Obtains the window in which the item has been opened for - -in-place editing. - -Args: - - - -Returns: - - PyCWnd - - """ - pass - - - def GetItemState(self,) -> 'None': - """ - Obtains the OLE item's current state - -Args: - - - -Returns: - - None - - """ - pass - - - def GetObject(self,) -> 'PyIUnknown': - """ - Returns the COM object to the item. This is the m_lpObject - -variable in MFC. - -Args: - - - -Returns: - - PyIUnknown - - """ - pass - - - def GetStorage(self,) -> 'None': - """ - Returns the COM object used for storage - -Args: - - - -Returns: - - None - - """ - pass - - - def OnActivate(self,) -> 'None': - """ - Calls the underlying MFC method. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnChange(self,) -> 'None': - """ - Calls the underlying MFC method. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnChangeItemPosition(self,) -> 'typing.Any': - """ - Calls the underlying MFC method. - -Args: - - - -Returns: - - typing.Any:PyCOleClientItem.OnChangeItemPosition - -int = OnChangeItemPosition()Calls the underlying MFC method. -Return ValueThe result is a BOOL indicating if the function succeeded. No exception is thrown. - - - """ - pass - - - def OnDeactivateUI(self,) -> 'typing.Any': - """ - Calls the underlying MFC method. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def Run(self,) -> 'None': - """ - Runs the application associated with this item. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetItemRects(self,) -> 'None': - """ - Sets the bounding rectangle or the visible rectangle of the OLE item. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCOleDialog(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCOleDocument(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def EnableCompoundFile(self,bEnable:'typing.Any'=1) -> 'None': - """ - Call this function if you want to store the document using the - -compound-file format. - -Args: - - bEnable(typing.Any):Specifies whether compound file support is enabled or disabled. - -Returns: - - None - - """ - pass - - - def GetStartPosition(self,) -> 'typing.Any': - """ - Obtains the position of the first item in the document. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetNextItem(self,pos:'typing.Any') -> 'typing.Tuple[typing.Any, PyCOleClientItem]': - """ - Call this function repeatedly to access each of - -the items in your document. - -Args: - - pos(typing.Any):The position to iterate from. - -Returns: - - typing.Tuple[typing.Any, PyCOleClientItem] - - """ - pass - - - def GetInPlaceActiveItem(self,wnd:'PyCWnd') -> 'PyCOleClientItem': - """ - Obtains the OLE item that is currently activated - -in place in the frame window containing the view identified by obWnd. - -Args: - - wnd(PyCWnd):The window. - -Returns: - - PyCOleClientItem - - """ - pass - - -class PyCOleInsertDialog(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetClassID(self,) -> 'typing.Any': - """ - Returns the CLSID associated with the selected item - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetSelectionType(self,) -> 'typing.Any': - """ - Returns the type of selection made - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetPathName(self,) -> 'typing.Any': - """ - Returns the full path to the file selected in the dialog box - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyCPrintDialog(object): - """An object which encapsulates an MFC CPrintDialog object.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCPrintInfo(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def DocObject(self,) -> 'None': - """ - Return true if the document being printed is a DocObject. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDwFlags(self,) -> 'None': - """ - A flags specifying DocObject printing operations. Valid only if data member - -m_bDocObject is TRUE. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetDwFlags(self,) -> 'None': - """ - Set a flag specifying DocObject printing operations. Valid only if data member - -m_bDocObject is TRUE. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDocOffsetPage(self,) -> 'None': - """ - Get the number of pages preceding the first page of a particular DocObject - -in a combined DocObject print job. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetDocOffsetPage(self,) -> 'None': - """ - Set the number of pages preceding the first page of a particular DocObject - -in a combined DocObject print job. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetPrintDialog(self,) -> 'None': - """ - Set a pointer to the CPrintDialog object used to display the Print dialog box - -for the print job. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDirect(self,) -> 'None': - """ - TRUE if the Print dialog box will be bypassed for direct printing; FALSE otherwise. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetDirect(self,) -> 'None': - """ - Sets to TRUE if the Print dialog box will be bypassed for direct printing; FALSE - -otherwise. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPreview(self,) -> 'None': - """ - A flag indicating whether the document is being previewed. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetPreview(self,) -> 'None': - """ - Set whether the document is being previewed. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetContinuePrinting(self,) -> 'None': - """ - A flag indicating whether the framework should continue the print loop. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetContinuePrinting(self,) -> 'None': - """ - Set whether the framework should continue the print loop. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCurPage(self,) -> 'None': - """ - Get the number of the current page. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetCurPage(self,) -> 'None': - """ - Set the number of the current page. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetNumPreviewPages(self,) -> 'None': - """ - Get the number of pages displayed in preview mode. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetNumPreviewPages(self,) -> 'None': - """ - Set the number of pages displayed in preview mode. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetUserData(self,) -> 'None': - """ - Get a user-created structure. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetUserData(self,) -> 'None': - """ - Set a user-created structure. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDraw(self,) -> 'None': - """ - Get the usable drawing area of the page in logical coordinates. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetDraw(self,) -> 'None': - """ - Set the usable drawing area of the page in logical coordinates. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPageDesc(self,) -> 'None': - """ - Get the format string used to display the page numbers during print preview - -Args: - - - -Returns: - - None - - """ - pass - - - def SetPageDesc(self,) -> 'None': - """ - Set the format string used to display the page numbers during print preview - -Args: - - - -Returns: - - None - - """ - pass - - - def GetMinPage(self,) -> 'None': - """ - Get the number of the first page of the document. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetMinPage(self,) -> 'None': - """ - Set the number of the first page of the document. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetMaxPage(self,) -> 'None': - """ - Get the number of the last page of the document. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetMaxPage(self,) -> 'None': - """ - Set the number of the last page of the document. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetOffsetPage(self,) -> 'None': - """ - 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 - -pInfo->GetOffsetPage(), the link fails to find its definition. Allways returns 0. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetFromPage(self,) -> 'None': - """ - The number of the first page to be printed. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetToPage(self,) -> 'None': - """ - The number of the last page to be printed. - -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 - -DoModal finishes. - -Args: - - hdc(typing.Any):The DC.MFC References - -Returns: - - None - - """ - pass - - - def CreatePrinterDC(self,) -> 'None': - """ - Handle to the newly created printer device context, call only after DoModal - -finishes. - -Args: - - - -Returns: - - None - - """ - pass - - - def DoModal(self,) -> 'None': - """ - Call DoModal on the dialog. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCopies(self,) -> 'None': - """ - The number of copies requested, call only after DoModal finishes. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDefaults(self,) -> 'None': - """ - 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 - -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 - -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) - -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. - -Args: - - - -Returns: - - None - - """ - pass - - - def FreeDefaults(self,) -> 'None': - """ - 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. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDeviceName(self,) -> 'None': - """ - The name of the currently selected printer, call only after DoModal finishes. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDriverName(self,) -> 'None': - """ - The name of the currently selected printer device driver, call only after - -DoModal finishes. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDlgFromPage(self,) -> 'None': - """ - Retrieves the starting page of the print range. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDlgToPage(self,) -> 'None': - """ - Retrieves the ending page of the print range. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPortName(self,) -> 'None': - """ - The name of the currently selected printer port, call only after DoModal - -finishes. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPrinterDC(self,) -> 'None': - """ - 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 - -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. - -Args: - - - -Returns: - - None - - """ - pass - - - def PrintAll(self,) -> 'None': - """ - Nonzero if all pages in the document are to be printed; otherwise 0, call only after - -DoModal finishes. - -Args: - - - -Returns: - - None - - """ - pass - - - def PrintCollate(self,) -> 'None': - """ - Nonzero if the user selects the collate check box in the dialog box; otherwise - -0, call only after DoModal finishes. - -Args: - - - -Returns: - - None - - """ - pass - - - def PrintRange(self,) -> 'None': - """ - Nonzero if only a range of pages in the document are to be printed; otherwise 0, - -call only after DoModal finishes. - -Args: - - - -Returns: - - None - - """ - pass - - - def PrintSelection(self,) -> 'None': - """ - Nonzero if only the selected items are to be printed; otherwise 0., call only - -after DoModal finishes - -Args: - - - -Returns: - - None - - """ - pass - - - def GetHDC(self,) -> 'None': - """ - 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 - -undefined. If both flags are specified, PD_RETURNDC has priority. - -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 - -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, - -PD_ENABLEPRINTTEMPLATEHANDLE, PD_ENABLESETUPHOOK, PD_ENABLESETUPTEMPLATE, PD_ENABLESETUPTEMPLATEHANDLE, - -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_USEDEVMODECOPIESANDCOLLATE. - -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 - -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, - -PD_ENABLEPRINTTEMPLATEHANDLE, PD_ENABLESETUPHOOK, PD_ENABLESETUPTEMPLATE, PD_ENABLESETUPTEMPLATEHANDLE, - -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_USEDEVMODECOPIESANDCOLLATE. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetFromPage(self,) -> 'None': - """ - The number of the first page to be printed. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetToPage(self,) -> 'None': - """ - The number of the last page to be printed. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPRINTDLGMinPage(self,) -> 'None': - """ - 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 - -disabled. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetPRINTDLGMinPage(self,) -> 'None': - """ - 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 - -disabled. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPRINTDLGCopies(self,) -> 'None': - """ - 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, - -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 - -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 - -information, see the description of the PD_USEDEVMODECOPIESANDCOLLATE flag. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetPRINTDLGCopies(self,) -> 'None': - """ - 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, - -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 - -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 - -information, see the description of the PD_USEDEVMODECOPIESANDCOLLATE flag. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCProgressCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,style:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',parent:'PyCWnd',_id:'typing.Any') -> 'None': - """ - Creates the actual control. - -Args: - - style(typing.Any):The style for the control. - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The size and position of the control. - parent(PyCWnd):The parent window of the control. Usually a PyCDialog. - _id(typing.Any):The control's ID. - -Returns: - - None - - """ - pass - - - def SetRange(self,nLower:'typing.Any'=1,nUpper:'typing.Any'=1) -> 'None': - """ - Set the control's bounds - -Args: - - nLower(typing.Any):Specifies the lower limit of the range (default is zero). - nUpper(typing.Any):Specifies the upper limit of the range (default is 100). - -Returns: - - None - - """ - pass - - - def SetPos(self,nPos:'typing.Any'=1) -> 'typing.Any': - """ - Set the control's position - -Args: - - nPos(typing.Any):New position of the progress bar control. - -Returns: - - typing.Any - - """ - pass - - - def OffsetPos(self,nPos:'typing.Any'=1) -> 'typing.Any': - """ - Advances the progress bar control's current position by the increment - -specified - -Args: - - nPos(typing.Any):Amount to advance the position. - -Returns: - - typing.Any - - """ - pass - - - def SetStep(self,nStep:'typing.Any'=1) -> 'typing.Any': - """ - Specifies the step increment for a progress bar control. - -Args: - - nStep(typing.Any):New step increment. - -Returns: - - typing.Any - - """ - pass - - - def StepIt(self,) -> 'typing.Any': - """ - Advances the current position for a progress bar control by the step increment. - -Returns previous position. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyCPropertyPage(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CancelToClose(self,) -> 'None': - """ - Changes the Cancel button to Close. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnCancel(self,) -> 'None': - """ - Calls the default MFC OnCancel handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnOK(self,) -> 'None': - """ - Calls the default MFC OnOK handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnApply(self,) -> 'None': - """ - Calls the default MFC OnApply handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnReset(self,) -> 'None': - """ - Calls the default MFC OnReset handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnQueryCancel(self,) -> 'None': - """ - Calls the default MFC OnQueryCancel handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnWizardBack(self,) -> 'None': - """ - Calls the default MFC OnWizardBack handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnWizardNext(self,) -> 'None': - """ - Calls the default MFC OnWizardNext handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnWizardFinish(self,) -> 'None': - """ - Calls the default MFC OnWizardFinish handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnSetActive(self,) -> 'typing.Any': - """ - Calls the default MFC OnSetActive handler. - -Args: - - - -Returns: - - typing.Any:PyCPropertyPage.OnSetActive virtual method -Return ValueThe result is true if the page should be made active. - -Typically this result should be passed to the original OnSetActive handler. - - - """ - pass - - - def OnKillActive(self,) -> 'typing.Any': - """ - Calls the default MFC OnKillActive handler. - -Args: - - - -Returns: - - typing.Any:PyCPropertyPage.OnKillActive virtual method -Return ValueThe result is true if the page should be deselected. - -Typically this result should be passed to the original OnSetActive handler. - - - """ - pass - - - def SetModified(self,bChanged:'typing.Any'=1) -> 'None': - """ - Sets the modified flag. - -Args: - - bChanged(typing.Any):A flag to indicate the new modified state. - -Returns: - - None - - """ - pass - - - def SetPSPBit(self,bitMask:'typing.Any',bitValue:'typing.Any') -> 'None': - """ - Sets or clears a bit in m_psp.dwFlags - -Args: - - bitMask(typing.Any):The PSP_* bit mask constant - bitValue(typing.Any):1 to set, 0 to clear - -Returns: - - None - - """ - pass - - -class PyCPropertySheet(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddPage(self,page:'PyCPropertyPage') -> 'None': - """ - Adds the supplied page with the rightmost tab in the property sheet. - -Args: - - page(PyCPropertyPage):The page to be added.CommentsAdd pages to the property sheet in the left-to-right order you want them to appear.MFC References - -Returns: - - None - - """ - pass - - - def CreateWindow(self,style:'typing.Any',exStyle:'typing.Any',parent:'PyCWnd'=None) -> 'None': - """ - Displays the property sheet as a modeless dialog. - -Args: - - style(typing.Any):The style for the window. - exStyle(typing.Any):The extended style for the window. - parent(PyCWnd):The parent of the dialog. - -Returns: - - None - - """ - pass - - - def DoModal(self,) -> 'typing.Any': - """ - Displays the property sheet as a modal dialog. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def EnableStackedTabs(self,stacked:'typing.Any') -> 'PyCPropertyPage': - """ - Enables or disables stacked tabs. - -Args: - - stacked(typing.Any):A boolean flag - -Returns: - - PyCPropertyPage - - """ - pass - - - def EndDialog(self,result:'typing.Any') -> 'None': - """ - Closes the dialog, with the specified result. - -Args: - - result(typing.Any):The result to be returned by DoModal. - -Returns: - - None - - """ - pass - - - def GetActiveIndex(self,) -> 'typing.Any': - """ - Retrieves the index of the active page of the property sheet. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetActivePage(self,) -> 'PyCPropertyPage': - """ - Returns the currently active property page. - -Args: - - - -Returns: - - PyCPropertyPage - - """ - pass - - - def GetPage(self,pageNo:'typing.Any') -> 'PyCPropertyPage': - """ - Returns the specified property page. - -Args: - - pageNo(typing.Any):The index of the page toretrieve.MFC References - -Returns: - - PyCPropertyPage - - """ - pass - - - def GetPageIndex(self,page:'PyCPropertyPage') -> 'typing.Any': - """ - Retrieves the index of the specified page of the property sheet. - -Args: - - page(PyCPropertyPage):The page. - -Returns: - - typing.Any - - """ - pass - - - def GetPageCount(self,) -> 'typing.Any': - """ - Returns the number of pages. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetTabCtrl(self,) -> 'PyCTabCtrl': - """ - Returns the tab control used by the sheet. - -Args: - - - -Returns: - - PyCTabCtrl - - """ - pass - - - def OnInitDialog(self,) -> 'typing.Any': - """ - Calls the default MFC OnInitDialog handler. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def PressButton(self,button:'typing.Any') -> 'None': - """ - Simulates the choice of the specified button in a property sheet. - -Args: - - button(typing.Any):The button to press - -Returns: - - None - - """ - pass - - - def RemovePage(self,offset:'typing.Any',page:'typing.Any') -> 'None': - """ - Removes the specified page from the sheet. - -Args: - - offset(typing.Any):The page number to removeAlternative Parameters - page(typing.Any):The page to remove - -Returns: - - None - - """ - pass - - - def SetActivePage(self,page:'PyCPropertyPage') -> 'None': - """ - Programmatically sets the active page object. - -Args: - - page(PyCPropertyPage):The page. - -Returns: - - None - - """ - pass - - - def SetTitle(self,title:'str') -> 'None': - """ - Sets the caption for the property sheet. - -Args: - - title(str):The new caption - -Returns: - - None - - """ - pass - - - def SetFinishText(self,text:'str') -> 'None': - """ - Sets the text for the Finish button - -Args: - - text(str):The next for the button - -Returns: - - None - - """ - pass - - - def SetWizardMode(self,) -> 'None': - """ - Enables the wizard mode - -Args: - - - -Returns: - - None - - """ - pass - - - def SetWizardButtons(self,flags:'typing.Any') -> 'None': - """ - Enables the wizard buttons - -Args: - - flags(typing.Any):The wizard flags - -Returns: - - None - - """ - pass - - - def SetPSHBit(self,bitMask:'typing.Any',bitValue:'typing.Any') -> 'None': - """ - Sets or clears a bit in m_psh.dwFlags - -Args: - - bitMask(typing.Any):The PSH_* bit mask constant - bitValue(typing.Any):1 to set, 0 to clear - -Returns: - - None - - """ - pass - - -class PyCRect(object): - """A Python interface the the MFC CRect class.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCRgn(object): - """An object encapsulating an MFC PyCRgn class.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCRichEditCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Clear(self,) -> 'typing.Any': - """ - Clears all text in an edit control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def Copy(self,) -> 'None': - """ - Copys the current selection to the clipboard. - -Args: - - - -Returns: - - None - - """ - pass - - - def CreateWindow(self,style:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',parent:'PyCWnd',_id:'typing.Any') -> 'None': - """ - Creates a rich edit control window. - -Args: - - style(typing.Any):The control style - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The position of the control - parent(PyCWnd):The parent window. Must not be None - _id(typing.Any):The control ID - -Returns: - - None - - """ - pass - - - def Cut(self,) -> 'None': - """ - Cuts the current selection to the clipboard. - -Args: - - - -Returns: - - None - - """ - pass - - - def FindText(self,charPos:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': - """ - Finds text in the control - -Args: - - charPos(typing.Any):The character position - -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 - -by charPos. - -Args: - - charPos(typing.Any):The character positionReturn ValueThe return value is a win32ui::CHARFORMAT tuple - -Returns: - - typing.Any:The character positionReturn ValueThe return value is a win32ui::CHARFORMAT tuple - - - - """ - pass - - - def GetDefaultCharFormat(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any:CRichEditCtrl::GetDefaultCharFormat -Return ValueThe return value is a win32ui::CHARFORMAT tuple - - - - """ - pass - - - def GetEventMask(self,) -> 'typing.Any': - """ - Returns the current event mask. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetSelectionCharFormat(self,) -> 'typing.Any': - """ - Returns the character formatting of the selection. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetFirstVisibleLine(self,) -> 'typing.Any': - """ - Returns zero-based index of the topmost visible line. - -Args: - - - -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 - - - def GetParaFormat(self,) -> 'typing.Any': - """ - Returns the current paragraph formatting attributes. - -Args: - - - -Returns: - - typing.Any:CRichEditCtrl::GetParaFormat -Return ValueThe return value is a win32ui::PARAFORMAT tuple - - - - """ - pass - - - def GetSel(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Returns the start and end of the current selection. - -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 - -end of the current selection) - - - """ - pass - - - def GetSelText(self,) -> 'str': - """ - Returns the currently selected text - -Args: - - - -Returns: - - str - - """ - pass - - - def GetTextLength(self,) -> 'typing.Any': - """ - Returns the length of the text in the control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetLine(self,lineNo:'typing.Any') -> 'typing.Any': - """ - Returns the text in a specified line. - -Args: - - lineNo(typing.Any):Contains the zero-based index value for the desired line.CommentsThis function is not an MFC wrapper. - -Returns: - - typing.Any - - """ - pass - - - def GetModify(self,) -> 'typing.Any': - """ - Nonzero if the text in this control has been modified; otherwise 0. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetLineCount(self,) -> 'typing.Any': - """ - Gets the number of lines in an edit control. - -Args: - - - -Returns: - - typing.Any:CRichEditCtrl::GetLineCount -Return ValueThe number of lines in the buffer. If the control is empty, the return value is 1. - - - """ - pass - - - def LimitText(self,nChars:'typing.Any'=0) -> 'None': - """ - Sets max length of text that user can enter - -Args: - - nChars(typing.Any):Specifies the length (in bytes) of the text that the user can enter. If this parameter is 0, the text length is set to UINT_MAX bytes. This is the default behavior.MFC References - -Returns: - - None - - """ - pass - - - def LineFromChar(self,charNo:'typing.Any'=-1) -> 'typing.Any': - """ - Returns the line number of the specified character. - -Args: - - charNo(typing.Any):Contains the zero-based index value for the desired character in the text of the edit control, or -1. If -1, then it specifies the current line.MFC References - -Returns: - - typing.Any:CRichEditCtrl::LineFromChar -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 there is no selection, the current line number is returned. - - - """ - pass - - - def LineIndex(self,lineNo:'typing.Any'=-1) -> 'typing.Any': - """ - Retrieves the character index of a line within a multiple-line edit control. - -Args: - - lineNo(typing.Any):Contains the index value for the desired line in the text of the edit control, or contains -1. If -1, then it specifies the current line.CommentsThis method only works on multi-linr edit controls.MFC References - -Returns: - - typing.Any:CRichEditCtrl::LineIndex -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 edit control. - - - """ - pass - - - def LineScroll(self,nLines:'typing.Any',nChars:'typing.Any'=0) -> 'typing.Any': - """ - Scroll the control vertically and horizontally - -Args: - - nLines(typing.Any):Specifies the number of lines to scroll vertically. - nChars(typing.Any):Specifies the number of character positions to scroll horizontally. This value is ignored if the edit control has either the ES_RIGHT or ES_CENTER style.CommentsThis method only works on multi-linr edit controls.MFC References - -Returns: - - typing.Any - - """ - pass - - - def Paste(self,) -> 'None': - """ - Pastes the contents of the clipboard into the control. - -Args: - - - -Returns: - - None - - """ - pass - - - def ReplaceSel(self,text:'str') -> 'None': - """ - Replaces the selection with the specified text. - -Args: - - text(str):The text to replace the selection with.MFC References - -Returns: - - None - - """ - pass - - - def SetBackgroundColor(self,bSysColor:'typing.Any',cr:'typing.Any'=0) -> 'typing.Any': - """ - Sets the background color for the control. - -Args: - - bSysColor(typing.Any):Indicates if the background color should be set to the system value. If this value is TRUE, cr is ignored. - cr(typing.Any):The requested background color. Used only if bSysColor is FALSE.MFC References - -Returns: - - typing.Any:CRichEditCtrl::SetEventMask -Return ValueThe return value is the previous background color. - - - """ - pass - - - def SetDefaultCharFormat(self,charFormat:'typing.Any') -> 'None': - """ - None - -Args: - - charFormat(typing.Any):A charformat tuple. See win32ui::CHARFORMAT tuple for details.MFC References - -Returns: - - None - - """ - pass - - - def SetEventMask(self,eventMask:'typing.Any') -> 'typing.Any': - """ - Sets the event motification mask. - -Args: - - eventMask(typing.Any):The new event mask. Must be one of the win32con.ENM_* flags.MFC References - -Returns: - - typing.Any:CRichEditCtrl::SetEventMask -Return ValueThe return value is the previous event mask. - - - """ - pass - - - def SetSelectionCharFormat(self,charFormat:'typing.Any') -> 'None': - """ - Sets the current selections character formatting attributes. - -Args: - - charFormat(typing.Any):A charformat tuple. See win32ui::CHARFORMAT tuple for details.MFC References - -Returns: - - None - - """ - pass - - - def SetModify(self,modified:'typing.Any'=1) -> 'None': - """ - Sets the modified flag for this control - -Args: - - modified(typing.Any):Indicates the new value for the modified flag.MFC References - -Returns: - - None - - """ - pass - - - def SetOptions(self,op:'typing.Any',flags:'typing.Any') -> 'None': - """ - Sets options for the control. - -Args: - - op(typing.Any):Indicates the operation. Must be one of the win32con.ECOOP_* flags. - flags(typing.Any):Indicates the options. Must be one a combination of win32con.ECO_* flags.MFC References - -Returns: - - None - - """ - pass - - - def SetParaFormat(self,paraFormat:'typing.Any') -> 'typing.Any': - """ - Sets the paragraph formatting - -Args: - - paraFormat(typing.Any):A charformat tuple. See win32ui::PARAFORMAT tuple for details.MFC References - -Returns: - - typing.Any:CRichEditCtrl::SetParaFormat -Return ValueThis function seems to return occasionally return failure, but - -the formatting is applied. Therefore an exception is not raised on failure, - -but the BOOL return code is passed back. - - - """ - pass - - - def SetReadOnly(self,bReadOnly:'typing.Any'=1) -> 'None': - """ - Sets or clears the read-only status of the listbox. - -Args: - - bReadOnly(typing.Any):The read-only state to set.MFC References - -Returns: - - None - - """ - pass - - - def SetSel(self,start:'typing.Any',end:'typing.Any',arg:'typing.Any') -> 'None': - """ - Sets the selection in the edit control. - -Args: - - start(typing.Any):Specifies the starting position. If start is 0 and end is -1, all the text in the edit control is selected. If start is -1, any current selection is removed. - end(typing.Any):Specifies the ending position.Alternative Parameters - arg(typing.Any):As for normal start, end args.MFC References - -Returns: - - None - - """ - pass - - - def SetSelAndCharFormat(self,charFormat:'typing.Any') -> 'None': - """ - Sets the selection and char format. - -Args: - - charFormat(typing.Any):A charformat tuple. See win32ui::CHARFORMAT tuple for details.CommentsHighly optimised for speed for color editors.MFC References - -Returns: - - None - - """ - pass - - - def SetTargetDevice(self,dc:'PyCDC',lineWidth:'typing.Any') -> 'None': - """ - Sets the target device for the control - -Args: - - dc(PyCDC):The new DC - may be None - lineWidth(typing.Any):Line width to use for formatting.MFC References - -Returns: - - None - - """ - pass - - - def StreamIn(self,_format:'typing.Any',method:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Invokes a callback to stream data into the control. - -Args: - - _format(typing.Any):The format. One of the win32con.SF_* flags (SF_TEXT,SF_RTF) - method(typing.Any):A callable object (eg, a method or function) This method is called with a single integer param, which is the maximum number of bytes to fetch. The method should return a zero length string, or None to finish the operation, and a string otherwise.MFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any]:CRichEditCtrl::StreamIn -Return ValueThe return value is a tuple of (no bytes written, error code) - - - """ - pass - - - def StreamOut(self,_format:'typing.Any',method:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Invokes a callback to stream data into the control. - -Args: - - _format(typing.Any):The format. One of the win32con.SF_* flags (SF_TEXT,SF_RTF) and may also combine SFF_SELECTION. - method(typing.Any):A callable object (eg, a method or function) This method is called with a string parameter. It should return an integer, zero to abort, non zero otherwise.MFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any]:CRichEditCtrl::StreamOut -Return ValueThe return value is a tuple of (no bytes written, error code) - - - """ - pass - - -class PyCRichEditDoc(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OnCloseDocument(self,) -> 'None': - """ - Call the MFC OnCloseDocument handler. - -This routine is provided so a document object which overrides this method - -can call the original MFC version if required. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCRichEditDocTemplate(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def DoCreateRichEditDoc(self,fileName:'str'=None) -> 'PyCRichEditDoc': - """ - Creates an underlying document object. - -Args: - - fileName(str):The name of the file to load. - -Returns: - - PyCRichEditDoc - - """ - pass - - -class PyCRichEditView(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetRichEditCtrl(self,) -> 'PyCRichEditCtrl': - """ - Returns the underlying rich edit control object. - -Args: - - - -Returns: - - PyCRichEditCtrl - - """ - pass - - - def SetWordWrap(self,wordWrap:'typing.Any') -> 'typing.Any': - """ - Sets the wordwrap state for the control. - -Args: - - wordWrap(typing.Any):The new word-wrap state.MFC References - -Returns: - - typing.Any - - """ - pass - - - def WrapChanged(self,) -> 'typing.Any': - """ - Calls the underlying WrapChanged method. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SaveTextFile(self,FileName:'typing.Any') -> 'typing.Any': - """ - Saves the contents of the control as a test file - -Args: - - FileName(typing.Any):Name of file to saveCommentsTheere is no equivilent MFC method. This is implemented in this module for performance reasons. - -Returns: - - typing.Any - - """ - pass - - -class PyCScrollView(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDeviceScrollPosition(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Returns the positon of the scroll bars in device units. - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def GetDC(self,) -> 'PyCDC': - """ - Gets the view's current DC. - -Args: - - - -Returns: - - PyCDC - - """ - pass - - - def GetScrollPosition(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Returns the current position of the scroll bars (in logical units). - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def GetTotalSize(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Returns the total size of the view in logical units. - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def OnCommand(self,wparam:'typing.Any',lparam:'typing.Any') -> 'None': - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(typing.Any): - lparam(typing.Any):See Also - -Returns: - - None - - """ - pass - - - def ResizeParentToFit(self,bShrinkOnly:'typing.Any'=1) -> 'typing.Any': - """ - Lets the size of a view dictate the size of its frame window. - -Args: - - bShrinkOnly(typing.Any):The kind of resizing to perform. The default value, TRUE, shrinks the frame window if appropriate.CommentsThis is recommended only for views in MDI child frame windows. Use ResizeParentToFit in the OnInitialUpdate handler function of your View class. You must ensure the parent's PyCFrameWnd::RecalcLayout is called before using this method. - -Returns: - - typing.Any - - """ - pass - - - def SetScaleToFitSize(self,size:'typing.Tuple[typing.Any, typing.Any]') -> 'None': - """ - Scales the viewport size to the current window size automatically. - -Args: - - size(typing.Tuple[typing.Any, typing.Any]):The horizontal and vertical sizes to which the view is to be scaled. The scroll view's size is measured in logical units. - -Returns: - - None - - """ - pass - - - def ScrollToPosition(self,position:'typing.Tuple[typing.Any, typing.Any]') -> 'None': - """ - Scrolls to a given point in the view. - -Args: - - position(typing.Tuple[typing.Any, typing.Any]):The position to scroll to. - -Returns: - - None - - """ - pass - - - def SetScrollSizes(self,mapMode:'typing.Any',sizeTotal:'typing.Tuple[typing.Any, typing.Any]',arg:'typing.Tuple[typing.Any, typing.Any]',arg1:'typing.Tuple[typing.Any, typing.Any]') -> 'None': - """ - Sets the sizes of the scroll bars - -Args: - - mapMode(typing.Any):The mapping mode for this view. - sizeTotal(typing.Tuple[typing.Any, typing.Any]):The total size of the view. Sizes are in logical units. Both x and y must be greater than zero. - arg(typing.Tuple[typing.Any, typing.Any]):The number of untils to scroll in response to a page-down command. - arg1(typing.Tuple[typing.Any, typing.Any]):The number of untils to scroll in response to a line-down command. - -Returns: - - None - - """ - pass - - - def UpdateBars(self,) -> 'None': - """ - Update the scroll bars state - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCSliderCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,style:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',parent:'PyCWnd',_id:'typing.Any') -> 'None': - """ - Creates the actual control. - -Args: - - style(typing.Any):The style for the control. - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The size and position of the control. - parent(PyCWnd):The parent window of the control. Usually a PyCDialog. - _id(typing.Any):The control's ID. - -Returns: - - None - - """ - pass - - - def GetLineSize(self,) -> 'typing.Any': - """ - Get the control's position - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetLineSize(self,nLineSize:'typing.Any'=1) -> 'typing.Any': - """ - Set the control's line size. Returns the previous line size. - -Args: - - nLineSize(typing.Any):New line size of the Slider bar control - -Returns: - - typing.Any - - """ - pass - - - def GetPageSize(self,) -> 'typing.Any': - """ - Get the control's position - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetPageSize(self,nPageSize:'typing.Any'=1) -> 'typing.Any': - """ - Set the control's page size Returns the previous page size. - -Args: - - nPageSize(typing.Any):New page size of the Slider bar control. - -Returns: - - typing.Any - - """ - pass - - - def GetRangeMax(self,) -> 'typing.Any': - """ - Get the control's Maximum - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetRangeMin(self,) -> 'typing.Any': - """ - Get the control's Minimum - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetRange(self,) -> 'typing.Any': - """ - Get the control's min and max - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetRange(self,nRangeMin:'typing.Any'=1,nRangeMax:'typing.Any'=1,bRedraw:'typing.Any'=1) -> 'typing.Any': - """ - Set the control's min and max - -Args: - - nRangeMin(typing.Any):New minimum of the Slider bar control. - nRangeMax(typing.Any):New maximum of the Slider bar control. - bRedraw(typing.Any):Should slider be redrawn? - -Returns: - - typing.Any - - """ - pass - - - def GetSelection(self,) -> 'typing.Any': - """ - Get the control's selection start and end positions - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetSelection(self,nRangeMin:'typing.Any'=1,nRangeMax:'typing.Any'=1) -> 'typing.Any': - """ - Set the control's selection start and end positions - -Args: - - nRangeMin(typing.Any):New start of the Slider's selection. - nRangeMax(typing.Any):New end of the Slider's selection. - -Returns: - - typing.Any - - """ - pass - - - def GetChannelRect(self,) -> 'typing.Any': - """ - Get the control's channel rectangle - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetThumbRect(self,) -> 'typing.Any': - """ - Get the control's thumb rectangle - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetPos(self,) -> 'typing.Any': - """ - Get the control's position - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetPos(self,nPos:'typing.Any'=1) -> 'typing.Any': - """ - Set the control's position - -Args: - - nPos(typing.Any):New position of the Slider bar control. - -Returns: - - typing.Any - - """ - pass - - - def GetNumTics(self,) -> 'typing.Any': - """ - Get number of tics in the slider - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetTicArray(self,) -> 'typing.Any': - """ - Get a tuple of slider tic positions - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetTic(self,nTic:'typing.Any'=1) -> 'typing.Any': - """ - Get the position of the specified tic number - -Args: - - nTic(typing.Any):Zero based index of the tic mark - -Returns: - - typing.Any - - """ - pass - - - def GetTicPos(self,nTic:'typing.Any'=1) -> 'typing.Any': - """ - Get the position of the specified tic number in client coordinates - -Args: - - nTic(typing.Any):Zero based index of the tic mark - -Returns: - - typing.Any - - """ - pass - - - def SetTic(self,nTic:'typing.Any'=1) -> 'typing.Any': - """ - Set a tic at the specified position - -Args: - - nTic(typing.Any):Position of the desired tic mark - -Returns: - - typing.Any - - """ - pass - - - def SetTicFreq(self,nFreq:'typing.Any'=1) -> 'typing.Any': - """ - Set the tic frequency - -Args: - - nFreq(typing.Any):Frequency of tic marks - -Returns: - - typing.Any - - """ - pass - - - def ClearSel(self,bRedraw:'typing.Any'=1) -> 'typing.Any': - """ - Clear the selection - -Args: - - bRedraw(typing.Any):Redraw the control? - -Returns: - - typing.Any - - """ - pass - - - def VerifyPos(self,) -> 'typing.Any': - """ - Verify the position is between configured min and max - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def ClearTics(self,bRedraw:'typing.Any'=1) -> 'typing.Any': - """ - Clear the control's tic marks - -Args: - - bRedraw(typing.Any):Redraw the control? - -Returns: - - typing.Any - - """ - pass - - -class PyCSpinButtonCtrl(object): - """A windows spin button control. Encapsulates an MFC CSpinButtonCtrl object.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPos(self,) -> 'typing.Any': - """ - Obtains the current position for a spin button control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetPos(self,pos:'typing.Any') -> 'typing.Any': - """ - Sets the current position for a spin button control. - -Args: - - pos(typing.Any):The new position.Return ValueThe result is the previous position. - -Returns: - - typing.Any:The new position.Return ValueThe result is the previous position. - - - """ - pass - - - def SetRange(self,) -> 'typing.Any': - """ - Sets the upper and lower limits (range) for a spin button control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetRange32(self,) -> 'typing.Any': - """ - Sets the 32 bit upper and lower limits (range) for a spin button control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyCSplitterWnd(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPane(self,row:'typing.Any',col:'typing.Any') -> 'PyCWnd': - """ - None - -Args: - - row(typing.Any):The row in the splitter. - col(typing.Any):The column in the splitter.CommentsTheoretically the return value can be a PyCWnd object, but currently it will always be a PyCView or derived object. - -Returns: - - PyCWnd - - """ - pass - - - def CreateView(self,view:'PyCView',row:'typing.Any',col:'typing.Any',arg:'typing.Tuple[typing.Any, typing.Any]') -> 'None': - """ - Creates a view in a splitter window - -Args: - - view(PyCView):The view to place in the splitter pane. - row(typing.Any):The row in the splitter to place the view. - col(typing.Any):The column in the splitter to place the view. - arg(typing.Tuple[typing.Any, typing.Any]):The initial size of the new view.MFC References - -Returns: - - None - - """ - pass - - - def CreateStatic(self,parent:'typing.Any',rows:'typing.Any',cols:'typing.Any',style:'typing.Any',_id:'typing.Any') -> 'None': - """ - Creates a static splitter window. - -Args: - - parent(typing.Any):The parent window. - rows(typing.Any):The number of rows in the splitter. - cols(typing.Any):The number of columns in the splitter. - style(typing.Any):Specifies the window style - _id(typing.Any):The child window ID of the window. The ID can be AFX_IDW_PANE_FIRST unless the splitter window is nested inside another splitter window.CommentsA static splitter window is a splitter where the number of panes are fixed at window creation time. Currently this is the only splitter window supported by win32ui.MFC References - -Returns: - - None - - """ - pass - - - def SetColumnInfo(self,column:'typing.Any',ideal:'typing.Any',_min:'typing.Any') -> 'None': - """ - Sets a new minimum height and ideal height for a column - -Args: - - column(typing.Any):The column in the splitter. - ideal(typing.Any):Specifies an ideal height for the splitter window column in pixels. - _min(typing.Any):Specifies a minimum height for the splitter window column in pixels. - -Returns: - - None - - """ - pass - - - def SetRowInfo(self,row:'typing.Any',ideal:'typing.Any',_min:'typing.Any') -> 'None': - """ - Sets a new minimum height and ideal height for a row. - -Args: - - row(typing.Any):The row in the splitter. - ideal(typing.Any):Specifies an ideal height for the splitter window row in pixels. - _min(typing.Any):Specifies a minimum height for the splitter window row in pixels. - -Returns: - - None - - """ - pass - - - def IdFromRowCol(self,row:'typing.Any',col:'typing.Any') -> 'None': - """ - Gets the child window ID for the specified child. - -Args: - - row(typing.Any):The row in the splitter. - col(typing.Any):The col in the splitter - -Returns: - - None - - """ - pass - - - def DoKeyboardSplit(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyCStatusBar(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - 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 - -location specified by index. - -Args: - - index(typing.Any):Index of the pane whose information is to be retrieved.MFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any] - - """ - pass - - - def GetStatusBarCtrl(self,) -> 'PyCStatusBarCtrl': - """ - Gets the statusbar control object for the statusbar. - -Args: - - - -Returns: - - PyCStatusBarCtrl - - """ - pass - - - def SetIndicators(self,indicators:'typing.Any') -> 'None': - """ - Sets each indicator's ID. - -Args: - - indicators(typing.Any):A tuple containing the ID's of the indicators. - -Returns: - - None - - """ - pass - - - def SetPaneInfo(self,index:'typing.Any',_id:'typing.Any',style:'typing.Any',width:'typing.Any') -> 'None': - """ - Sets the specified indicator pane to a new ID, style, and width. - -Args: - - index(typing.Any):Index of the indicator pane whose style is to be set. - _id(typing.Any):New ID for the indicator pane. - style(typing.Any):New style for the indicator pane.The following indicator styles are supported:afxres.SBPS_NOBORDERS - No 3-D border around the pane.afxres.SBPS_POPOUT - Reverse border so that text "pops out."afxres.SBPS_DISABLED - Do not draw text.afxres.SBPS_STRETCH - Stretch pane to fill unused space. Only one pane per status bar can have this style.afxres.SBPS_NORMAL - No stretch, borders, or pop-out. - width(typing.Any):New width for the indicator pane.MFC References - -Returns: - - None - - """ - pass - - -class PyCStatusBarCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,style:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',parent:'PyCWnd',_id:'typing.Any') -> 'None': - """ - Creates the actual control. - -Args: - - style(typing.Any):The style for the control. - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The size and position of the control. - parent(PyCWnd):The parent window of the control. Usually a PyCDialog. - _id(typing.Any):The control's ID. - -Returns: - - None - - """ - pass - - - def GetBorders(self,) -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': - """ - Retrieve the status bar control's current widths of - -the horizontal and vertical borders and of the space between rectangles. - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any] - - """ - pass - - - def GetParts(self,nParts:'typing.Any') -> 'typing.Any': - """ - Retrieve coordinates of the parts in a status bar control. - -Args: - - nParts(typing.Any):The number of coordinates to retrieveCommentsThis function, as designed in MFC, returns both the *number* of parts, and, through an OUT parameter, an array of ints giving the coordinates of the parts. There is also an IN parameter saying how many coordinates to give back. Here, we're explicitly changing the semantics a bit.GetParts() -> Tuple of all coordinates GetParts(n) -> Tuple of the first n coordinates (or all coordinates, if fewer than n)So, in Python, you can't simultaneously find out how many coordinates there are, and retrieve a subset of them. In a reasonable universe, there would have been GetParts() -> int, and GetCoords() -> List. This means that I need to call the MFC method twice; once to find out how many there are, and another time to get them. - -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 - -bar control. - -Args: - - nPane(typing.Any):Zero-based index of the part whose bounding rectangle is to be retrieved. - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - - """ - pass - - - def GetText(self,nPane:'typing.Any') -> 'typing.Any': - """ - Retrieve the text from the given part of a status bar control. - -Args: - - nPane(typing.Any):Zero-based index of the part whose text is to be retrieved. - -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 - -control. - -Args: - - nPane(typing.Any):Zero-based index of the part whose text is to be retrieved. - -Returns: - - typing.Any - - """ - pass - - - def GetTextLength(self,nPane:'typing.Any') -> 'typing.Any': - """ - Retrieve the length the text in the given part of a status bar control. - -Args: - - nPane(typing.Any):Zero-based index of the part whose text is to be retrieved. - -Returns: - - typing.Any - - """ - pass - - - def SetMinHeight(self,nHeight:'typing.Any') -> 'None': - """ - Set the minimum height of a status bar control's drawing area. - -Args: - - nHeight(typing.Any):Minimum height - -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 - -edge of each part. - -Args: - - coord(typing.Any):Coordinates of each part - -Returns: - - None - - """ - pass - - - def SetText(self,text:'str',nPane:'typing.Any',nType:'typing.Any') -> 'None': - """ - Set the text in the given part of a status bar control. - -Args: - - text(str):The text to display - nPane(typing.Any):Zero-based index of the part to set. - nType(typing.Any):Type of drawing operation.CommentsThe drawing type can be set to one of:~ 0 - The text is drawn with a border to appear lower than the plane of the status bar.~ win32con.SBT_NOBORDERS - The text is drawn without borders.~ win32con.SBT_OWNERDRAW - The text is drawn by the parent window.~ win32con.SBT_POPOUT - The text is drawn with a border to appear higher than the plane of the status bar. - -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 - -been created with the afxres.SBT_TOOLTIPS control style to enable ToolTips. - -Args: - - nPane(typing.Any):The zero-based index of status bar pane to receive the tooltip text. - text(str):The string containing the tooltip text.CommentsPay attention, this tooltip text is ONLY displayed in two situations: 1. When the corresponding pane in the status bar contains only an icon. 2. When the corresponding pane in the status bar contains text that is truncated due to the size of the pane. To make the tooltip appear even if the text is not truncated, you could add additional spaces to the end of the pane text.MFC References - -Returns: - - None - - """ - pass - - -class PyCTabCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetCurSel(self,) -> 'typing.Any': - """ - Gets the current selection of a tab control. - -Args: - - - -Returns: - - typing.Any:PyCTabCtrl.GetCurSel - -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 - - - def GetItemCountl(self,) -> 'typing.Any': - """ - Returns the number of tabs in the control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetCurSel(self,index:'typing.Any') -> 'typing.Any': - """ - Sets the current selection of a tab control. - -Args: - - index(typing.Any):The index of the tab to set current.Return ValueThe zero-based index of the previously selected item. - -Returns: - - typing.Any:The index of the tab to set current.Return ValueThe zero-based index of the previously selected item. - - - """ - pass - - -class PyCToolBar(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetButtonStyle(self,index:'typing.Any') -> 'None': - """ - Retrieves the style for a button. - -Args: - - index(typing.Any):Index of the item whose style is to be retrieved. - -Returns: - - None - - """ - pass - - - def GetButtonText(self,index:'typing.Any') -> 'str': - """ - Gets the text for a button. - -Args: - - index(typing.Any):Index of the item whose text is to be retrieved. - -Returns: - - str - - """ - pass - - - def GetItemID(self,index:'typing.Any') -> 'None': - """ - Returns the command ID of a button or separator at the given index. - -Args: - - index(typing.Any):Index of the item whose ID is to be retrieved. - -Returns: - - None - - """ - pass - - - def SetButtonInfo(self,index:'typing.Any',ID:'typing.Any',style:'typing.Any',imageIx:'typing.Any') -> 'None': - """ - Sets the button's command ID, style, and image number. - -Args: - - index(typing.Any):Index of the button or separator whose information is to be set. - ID(typing.Any):The value to which the button's command ID is set. - style(typing.Any):The new button style - imageIx(typing.Any):New index for the button's image within the bitmap - -Returns: - - None - - """ - pass - - - def GetToolBarCtrl(self,) -> 'PyCToolBarCtrl': - """ - Gets the toolbar control object for the toolbar - -Args: - - - -Returns: - - PyCToolBarCtrl - - """ - pass - - - def LoadBitmap(self,_id:'PyResourceId') -> 'None': - """ - Loads the bitmap containing bitmap-button images. - -Args: - - _id(PyResourceId):Name or id of the resource that contains the bitmap.CommentsThe bitmap should contain one image for each toolbar button. If the images are not of the standard size (16 pixels wide and 15 pixels high), call PyCToolBar::SetSizes to set the button sizes and their images. - -Returns: - - None - - """ - pass - - - def LoadToolBar(self,_id:'PyResourceId') -> 'None': - """ - Loads a toolbar from a toolbar resource. - -Args: - - _id(PyResourceId):Name or resource id of the resourceCommentsThe bitmap should contain one image for each toolbar button. If the images are not of the standard size (16 pixels wide and 15 pixels high), call PyCToolBar::SetSizes to set the button sizes and their images. - -Returns: - - None - - """ - pass - - - def SetBarStyle(self,style:'typing.Any') -> 'None': - """ - Sets the toolbar part of style - -Args: - - style(typing.Any):The toolbar style to set. - -Returns: - - None - - """ - pass - - - def SetBitmap(self,hBitmap:'typing.Any') -> 'None': - """ - Sets a bitmapped image. - -Args: - - hBitmap(typing.Any):The handle to a bitmap resource.CommentsCall this method to set the bitmap image for the toolbar. For example, call SetBitmap to change the bitmapped image after the user takes an action on a document that changes the action of a button. - -Returns: - - None - - """ - pass - - - def SetButtons(self,buttons:'typing.Any',numButtons:'typing.Any') -> 'None': - """ - Sets button styles and an index of button images within the bitmap. - -Args: - - buttons(typing.Any):A tuple containing the ID's of the buttons.Alternative Parameters - numButtons(typing.Any):The number of buttons to pre-allocate. If this option is used, then PyCToolBar::PySetButtonInfo must be used. - -Returns: - - None - - """ - pass - - - def SetButtonStyle(self,index:'typing.Any',style:'typing.Any') -> 'None': - """ - Sets the style for a button. - -Args: - - index(typing.Any):Index of the item whose style is to be set - style(typing.Any):The new style - -Returns: - - None - - """ - pass - - - def SetHeight(self,height:'typing.Any') -> 'None': - """ - Sets the height of the toolbar. - -Args: - - height(typing.Any):The height in pixels of the toolbar. - -Returns: - - None - - """ - pass - - - def SetSizes(self,sizeButton:'typing.Tuple[typing.Any, typing.Any]',sizeButton1:'typing.Tuple[typing.Any, typing.Any]') -> 'None': - """ - Sets the size of each button. - -Args: - - sizeButton(typing.Tuple[typing.Any, typing.Any]):The size of each button. - sizeButton1(typing.Tuple[typing.Any, typing.Any]):The size of each bitmap. - -Returns: - - None - - """ - pass - - -class PyCToolBarCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddBitmap(self,numButtons:'typing.Any',bitmap:'typing.Any') -> 'typing.Any': - """ - Add one or more button images to the list of button images - -Args: - - numButtons(typing.Any):Number of button images in the bitmap. - bitmap(typing.Any):Bitmap containing button or buttons to be addedMFC References - -Returns: - - typing.Any - - """ - pass - - - def AddButtons(self,) -> 'typing.Any': - """ - Add one or more buttons to the toolbar - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def AddStrings(self,strings:'typing.Any') -> 'typing.Any': - """ - Add one or more strings to the toolbar - -Args: - - strings(typing.Any):Strings to add. Can give more than one string. - -Returns: - - typing.Any - - """ - pass - - - def AutoSize(self,) -> 'None': - """ - Resize the entire toolbar control - -Args: - - - -Returns: - - None - - """ - pass - - - def CheckButton(self,nID:'typing.Any',bCheck:'typing.Any'=1) -> 'typing.Any': - """ - Check or clear a given button in a toolbar control - -Args: - - nID(typing.Any):Command identifier of the button to check or clear. - bCheck(typing.Any):1 to check, 0 to clear the buttonMFC References - -Returns: - - typing.Any - - """ - pass - - - def CommandToIndex(self,nID:'typing.Any') -> 'typing.Any': - """ - Retrieve the zero-based index for the button associated with the - -specified command identifier. - -Args: - - nID(typing.Any):Command identifier of the button you want to find.MFC References - -Returns: - - typing.Any - - """ - pass - - - def CreateWindow(self,style:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',parent:'PyCWnd',_id:'typing.Any') -> 'None': - """ - Creates the window for a new toolbar object - -Args: - - style(typing.Any):The style for the button. Use any of the win32con.BS_* constants. - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The size and position of the button. - parent(PyCWnd):The parent window of the button. Usually a PyCDialog. - _id(typing.Any):The buttons control ID.MFC References - -Returns: - - None - - """ - pass - - - def Customize(self,) -> 'None': - """ - Display the Customize Toolbar dialog box. - -Args: - - - -Returns: - - None - - """ - pass - - - def DeleteButton(self,nID:'typing.Any') -> 'None': - """ - Delete a button from the toolbar control. - -Args: - - nID(typing.Any):ID of the button to delete.MFC References - -Returns: - - None - - """ - pass - - - def EnableButton(self,nID:'typing.Any',bEnable:'typing.Any'=1) -> 'None': - """ - Enable or disable a toolbar control button. - -Args: - - nID(typing.Any):ID of the button to enable or disable. - bEnable(typing.Any):1 to enable, 0 to disableMFC References - -Returns: - - None - - """ - pass - - - def GetBitmapFlags(self,) -> 'typing.Any': - """ - retrieve the bitmap flags from the toolbar. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetButton(self,nID:'typing.Any') -> 'typing.Any': - """ - Retrieve information about the specified button in a - -toolbar control. - -Args: - - nID(typing.Any):ID of the button to retrieve.MFC References - -Returns: - - typing.Any - - """ - pass - - - def GetButtonCount(self,) -> 'typing.Any': - """ - Retrieve a count of the buttons currently in the toolbar control. - -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 - -toolbar control. - -Args: - - nID(typing.Any):ID of the button.MFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - - """ - pass - - - def GetRows(self,) -> 'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': - """ - Retrieve the number of rows of buttons currently displayed - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - - """ - pass - - - def HideButton(self,nID:'typing.Any',bEnable:'typing.Any'=1) -> 'None': - """ - Hide or show the specified button in a toolbar control. - -Args: - - nID(typing.Any):ID of the button to hide. - bEnable(typing.Any):1 to hide, 0 to show.MFC References - -Returns: - - None - - """ - pass - - - def Indeterminate(self,nID:'typing.Any',bEnable:'typing.Any'=1) -> 'None': - """ - Mark or unmark the specified button as indeterminate - -Args: - - nID(typing.Any):ID of the button to mark. - bEnable(typing.Any):1 to hide, 0 to show.MFC References - -Returns: - - None - - """ - pass - - - def InsertButton(self,nID:'typing.Any',button:'PyCToolBarCtrl') -> 'typing.Any': - """ - Insert a button in a toolbar control. - -Args: - - nID(typing.Any):Zero-based index of a button. This function inserts the new button to the left of this button. - button(PyCToolBarCtrl):Bitmap containing button to be insertedCommentsThe image and/or string whose index you provide must have previously been added to the toolbar control's list using PyCToolBarCtrl::AddBitmap, PyCToolBarCtrl::AddString, and/or PyCToolBarCtrl::AddStrings.MFC References - -Returns: - - typing.Any - - """ - pass - - - def IsButtonChecked(self,nID:'typing.Any') -> 'typing.Any': - """ - Determine whether the specified button in a toolbar control is checked. - -Args: - - nID(typing.Any):ID of the button to check.MFC References - -Returns: - - typing.Any - - """ - pass - - - def IsButtonEnabled(self,nID:'typing.Any') -> 'typing.Any': - """ - Determine whether the specified button in a toolbar control is enabled. - -Args: - - nID(typing.Any):ID of the button to check.MFC References - -Returns: - - typing.Any - - """ - pass - - - def IsButtonHidden(self,nID:'typing.Any') -> 'typing.Any': - """ - Determine whether the specified button in a toolbar control is hidden. - -Args: - - nID(typing.Any):ID of the button to check.MFC References - -Returns: - - typing.Any - - """ - pass - - - def IsButtonIndeterminate(self,nID:'typing.Any') -> 'typing.Any': - """ - Determine whether the specified button in a toolbar control is - -indeterminate. - -Args: - - nID(typing.Any):ID of the button to check.MFC References - -Returns: - - typing.Any - - """ - pass - - - def IsButtonPressed(self,nID:'typing.Any') -> 'typing.Any': - """ - Determine whether the specified button in a toolbar control is pressed. - -Args: - - nID(typing.Any):ID of the button to check.MFC References - -Returns: - - typing.Any - - """ - pass - - - def PressButton(self,nID:'typing.Any',bEnable:'typing.Any'=1) -> 'None': - """ - Mark or unmark the specified button as pressed. - -Args: - - nID(typing.Any):ID of the button to mark. - bEnable(typing.Any):1 to mark, 0 to unmark.MFC References - -Returns: - - None - - """ - pass - - - def SetBitmapSize(self,width1:'typing.Any',height1:'typing.Any',width:'typing.Any'=16,height:'typing.Any'=15) -> 'None': - """ - Set the size of the actual bitmapped images to be added to a toolbar control. - -Args: - - width1(typing.Any):Width of bitmap images. - height1(typing.Any):Height of bitmap images.MFC References - width(typing.Any):Width of bitmap images. - height(typing.Any):Height of bitmap images.Alternative Parameters - -Returns: - - None - - """ - pass - - - def SetButtonSize(self,width1:'typing.Any',height1:'typing.Any',width:'typing.Any'=16,height:'typing.Any'=15) -> 'None': - """ - Set the size of the buttons to be added to a toolbar control. - -Args: - - width1(typing.Any):Width of bitmap images. - height1(typing.Any):Height of bitmap images.MFC References - width(typing.Any):Width of buttons - height(typing.Any):Height of buttonsAlternative Parameters - -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 - -specified button is pressed. - -Args: - - nIndex(typing.Any):The zero-based index of the button whose command ID is to be set. - nID(typing.Any):The command ID to set the selected button to.MFC References - -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 - -number of rows. - -Args: - - nRows(typing.Any):Requested number of rows. - bLarger(typing.Any):Tells whether to use more rows or fewer rows if the toolbar cannot be resized to the requested number of rows.MFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - - """ - pass - - -class PyCToolTipCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,parent:'PyCWnd',style:'typing.Any') -> 'None': - """ - Creates the actual control. - -Args: - - parent(PyCWnd):The parent window of the control. - style(typing.Any):The style for the control. - -Returns: - - None - - """ - pass - - - def UpdateTipText(self,text:'str',wnd:'PyCWnd',_id:'typing.Any') -> 'None': - """ - Update the tool tip text for a control's tools - -Args: - - text(str):The text for the tool. - wnd(PyCWnd):The window of the tool. - _id(typing.Any):The id of the tool - -Returns: - - None - - """ - pass - - - def AddTool(self,wnd:'PyCWnd',text:'str',_id:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]'=None) -> 'None': - """ - Adds a tool to tooltip control. - -Args: - - wnd(PyCWnd):The window of the tool. - text(str):The text for the tool. - _id(typing.Any):The id of the tool - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The default rectangle - -Returns: - - None - - """ - pass - - - def SetMaxTipWidth(self,width:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - width(typing.Any):The new width - -Returns: - - typing.Any - - """ - pass - - -class PyCTreeCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,style:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',PyCWnd:'typing.Any',_id:'typing.Any') -> 'None': - """ - Creates the actual window for the object. - -Args: - - style(typing.Any):The window style - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The default rectangle - PyCWnd(typing.Any):The parent window - _id(typing.Any):The control IDMFC References - -Returns: - - None - - """ - pass - - - def GetCount(self,) -> 'typing.Any': - """ - Retrieves the number of tree items associated with a tree view control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetIndent(self,) -> 'typing.Any': - """ - Retrieves the offset (in pixels) of a tree view item from its parent. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetIndent(self,indent:'typing.Any') -> 'None': - """ - Sets the offset (in pixels) of a tree view item from its parent. - -Args: - - indent(typing.Any):The new indent. - -Returns: - - None - - """ - pass - - - def GetImageList(self,nImageList:'typing.Any') -> 'PyCImageList': - """ - Retrieves the current image list. - -Args: - - nImageList(typing.Any):Value specifying which image list to retrieve. It can be one of: - commctrl.LVSIL_NORMAL Image list with large icons. - commctrl.LVSIL_SMALL Image list with small icons. - commctrl.LVSIL_STATE Image list with state images. - -Returns: - - PyCImageList - - """ - pass - - - def SetImageList(self,imageList:'PyCImageList',imageType:'typing.Any') -> 'typing.Any': - """ - Assigns an image list to a list view control. - -Args: - - imageList(PyCImageList):The Image List to use. - imageType(typing.Any):Type of image list. It can be one of (COMMCTRL.) LVSIL_NORMAL, LVSIL_SMALL or LVSIL_STATE - -Returns: - - typing.Any - - """ - pass - - - def GetNextItem(self,item:'typing.Any',code:'typing.Any') -> 'typing.Any': - """ - Retrieves the next item. - -Args: - - item(typing.Any):The specified item - code(typing.Any):Specifies the relationship of the item to fetch. - -Returns: - - typing.Any - - """ - pass - - - def ItemHasChildren(self,item:'typing.Any') -> 'typing.Any': - """ - Returns nonzero if the specified item has child items. - -Args: - - item(typing.Any):The specified item - -Returns: - - typing.Any - - """ - pass - - - def GetChildItem(self,item:'typing.Any') -> 'typing.Any': - """ - Retrieves the first child item. - -Args: - - item(typing.Any):The specified item - -Returns: - - typing.Any - - """ - pass - - - def GetNextSiblingItem(self,item:'typing.Any') -> 'typing.Any': - """ - Retrieves the next sibling of the specified tree view item. - -Args: - - item(typing.Any):The specified item - -Returns: - - typing.Any - - """ - pass - - - def GetPrevSiblingItem(self,item:'typing.Any') -> 'typing.Any': - """ - Retrieves the previous sibling of the specified tree view item. - -Args: - - item(typing.Any):The specified item - -Returns: - - typing.Any - - """ - pass - - - def GetParentItem(self,item:'typing.Any') -> 'typing.Any': - """ - Retrieves the parent item of the specified tree view item. - -Args: - - item(typing.Any):The specified item - -Returns: - - typing.Any - - """ - pass - - - def GetFirstVisibleItem(self,) -> 'typing.Any': - """ - Retrieves the first visible item of the tree view control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetNextVisibleItem(self,item:'typing.Any') -> 'typing.Any': - """ - Retrieves the next visible item of the specified tree view item. - -Args: - - item(typing.Any):The specified item - -Returns: - - typing.Any - - """ - pass - - - def GetSelectedItem(self,) -> 'typing.Any': - """ - Retrieves the currently selected tree view item. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetDropHilightItem(self,) -> 'typing.Any': - """ - Retrieves the target of a drag-and-drop operation. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetRootItem(self,) -> 'typing.Any': - """ - Retrieves the root of the specified tree view item. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetToolTips(self,) -> 'typing.Any': - """ - Returns the tooltip control - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetItem(self,item:'typing.Any',arg:'typing.Any') -> 'TV_ITEM': - """ - Retrieves the details of an items attributes. - -Args: - - item(typing.Any):The item whose attributes are to be retrieved. - arg(typing.Any):The requested attributes. - -Returns: - - TV_ITEM - - """ - pass - - - def SetItem(self,item:'TV_ITEM') -> 'typing.Any': - """ - Sets some of all of an items attributes. - -Args: - - item(TV_ITEM):A tuple describing the new item. - -Returns: - - typing.Any - - """ - pass - - - def GetItemState(self,item:'typing.Any',stateMask:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Retrieves the state and mask of an item. - -Args: - - item(typing.Any):The specified item - stateMask(typing.Any):The mask for the result. - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def SetItemState(self,item:'typing.Any',state:'typing.Any',stateMask:'typing.Any') -> 'None': - """ - Sets the state of item. - -Args: - - item(typing.Any):The specified item - state(typing.Any):The new state - stateMask(typing.Any):The mask for the new state - -Returns: - - None - - """ - pass - - - def GetItemImage(self,item:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Retrieves the index of an items images. - -Args: - - item(typing.Any):The specified item - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def SetItemImage(self,item:'typing.Any',iImage:'typing.Any',iSelectedImage:'typing.Any') -> 'None': - """ - Sets the index of an items images. - -Args: - - item(typing.Any):The specified item - iImage(typing.Any):The offset of the image. - iSelectedImage(typing.Any):The offset of the selected image. - -Returns: - - None - - """ - pass - - - def SetItemText(self,item:'typing.Any',text:'str') -> 'typing.Any': - """ - Changes the text of a list view item or subitem. - -Args: - - item(typing.Any):The item whose text is to be retrieved. - text(str):String that contains the new item text. - -Returns: - - typing.Any - - """ - pass - - - def GetItemText(self,item:'typing.Any') -> 'typing.Any': - """ - Retrieves the text of a list view item or subitem. - -Args: - - item(typing.Any):The item whose text is to be retrieved. - -Returns: - - typing.Any - - """ - pass - - - def GetItemData(self,item:'typing.Any') -> 'typing.Any': - """ - Retrieves the application-specific value associated with an item. - -Args: - - item(typing.Any):The index of the item whose data is to be retrieved. - -Returns: - - typing.Any - - """ - pass - - - def SetItemData(self,item:'typing.Any',Data:'typing.Any') -> 'typing.Any': - """ - Sets the item's application-specific value. - -Args: - - item(typing.Any):The item whose Data is to be set. - Data(typing.Any):New value for the data.CommentsNote that a reference count is not added to the object. This it is your responsibility to make sure the object remains alive while in the list. - -Returns: - - typing.Any - - """ - pass - - - def GetItemRect(self,item:'typing.Any',bTextOnly:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': - """ - Retrieves the bounding rectangle of a tree view item. - -Args: - - item(typing.Any):The item whose Data is to be set. - bTextOnly(typing.Any):f this parameter is nonzero, the bounding rectangle includes only the text of the item. Otherwise it includes the entire line that the item occupies in the tree view control. - -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 - -tree view item. - -Args: - - - -Returns: - - PyCEdit - - """ - pass - - - def GetVisibleCount(self,) -> 'typing.Any': - """ - Retrieves the number of visible tree items associated with a tree view - -control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def InsertItem(self,hParent:'typing.Any',hInsertAfter:'typing.Any',item:'TV_ITEM',mask:'typing.Any',text:'typing.Any',image:'typing.Any',selectedImage:'typing.Any',state:'typing.Any',stateMask:'typing.Any',lParam:'typing.Any',parent:'typing.Any',parent1:'typing.Any',text1:'typing.Any',image1:'typing.Any',selectedImage1:'typing.Any',parent2:'typing.Any',insertAfter:'typing.Any',text2:'typing.Any',parent3:'typing.Any',parent4:'typing.Any') -> 'typing.Any': - """ - Inserts an item into the list. - -Args: - - hParent(typing.Any):The parent item. If commctrl.TVI_ROOT or 0, it is added to the root. - hInsertAfter(typing.Any):The item to insert after. Can be an item or TVI_FIRST, TVI_LAST or TVI_SORT - item(TV_ITEM):A tuple describing the new item.Alternative Parameters - mask(typing.Any):Integer specifying which attributes to set - text(typing.Any):The text of the item. - image(typing.Any):The index of the image to use. - selectedImage(typing.Any):The index of the items selected image. - state(typing.Any):The initial state of the item. - stateMask(typing.Any):Specifies which bits of the state are valid. - lParam(typing.Any):A user defined object for the item. - parent(typing.Any):The parent of the item. - parent1(typing.Any):The parent of the item.Alternative Parameters - text1(typing.Any):The text for the item. - image1(typing.Any):The index of the image to use. - selectedImage1(typing.Any):The index of the items selected image. - parent2(typing.Any):The parent of the item. - insertAfter(typing.Any):The item to insert the new item after, or TVI_FIRST, TVI_LAST or TVI_SORTAlternative Parameters - text2(typing.Any):The text for the item. - parent3(typing.Any):The parent of the item. - parent4(typing.Any):The parent of the item. - -Returns: - - typing.Any - - """ - pass - - - def DeleteItem(self,item:'typing.Any') -> 'None': - """ - Deletes the specified item. - -Args: - - item(typing.Any):The specified item - -Returns: - - None - - """ - pass - - - def DeleteAllItems(self,) -> 'typing.Any': - """ - Deletes all items in the control - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def Expand(self,item:'typing.Any',code:'typing.Any') -> 'None': - """ - Expands, or collapses, the child items of the specified tree view item. - -Args: - - item(typing.Any):The specified item - code(typing.Any):The action to take - -Returns: - - None - - """ - pass - - - def Select(self,item:'typing.Any',code:'typing.Any') -> 'None': - """ - Selects, scrolls into view, or redraws a specified tree view item. - -Args: - - item(typing.Any):The specified item - code(typing.Any):The action to take - -Returns: - - None - - """ - pass - - - def SelectItem(self,item:'typing.Any') -> 'None': - """ - Selects a specified tree view item. - -Args: - - item(typing.Any):The specified item - -Returns: - - None - - """ - pass - - - def SelectDropTarget(self,item:'typing.Any') -> 'None': - """ - Redraws the tree item as the target of a drag-and-drop operation. - -Args: - - item(typing.Any):The specified item - -Returns: - - None - - """ - pass - - - def SelectSetFirstVisible(self,item:'typing.Any') -> 'None': - """ - Selects a specified tree view item as the first visible item. - -Args: - - item(typing.Any):The specified item - -Returns: - - None - - """ - pass - - - def EditLabel(self,item:'typing.Any') -> 'PyCEdit': - """ - Edits a specified tree view item in-place. - -Args: - - item(typing.Any):The item to edit. - -Returns: - - PyCEdit - - """ - pass - - - def CreateDragImage(self,item:'typing.Any') -> 'PyCImageList': - """ - Creates a dragging bitmap for the specified tree view item. - -Args: - - item(typing.Any):The item to edit. - -Returns: - - PyCImageList - - """ - pass - - - def SortChildren(self,item:'typing.Any') -> 'None': - """ - Sorts the children of a given parent item. - -Args: - - item(typing.Any):The specified parent item - -Returns: - - None - - """ - pass - - - def EnsureVisible(self,item:'typing.Any') -> 'typing.Any': - """ - Ensures that a tree view item is visible in its tree view control. - -Args: - - item(typing.Any):The item to edit. - -Returns: - - typing.Any - - """ - pass - - - def HitTest(self,arg:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Determines which tree view item, if any, is at a specified position. - -Args: - - arg(typing.Any):The point to test.Return ValueThe result is a tuple of (flags, hItem). flags may be a combination of the following values:ValueDescriptioncommctrl.TVHT_ABOVEAbove the client area.commctrl.TVHT_BELOWBelow the client area.commctrl.TVHT_NOWHEREIn the client area, but below the last item.commctrl.TVHT_ONITEMOn the bitmap or label associated with an item.commctrl.TVHT_ONITEMBUTTONOn the button associated with an item.commctrl.TVHT_ONITEMICONOn the bitmap associated with an item.commctrl.TVHT_ONITEMINDENTIn the indentation associated with an item.commctrl.TVHT_ONITEMLABELOn the label (string) associated with an item.commctrl.TVHT_ONITEMRIGHTIn the area to the right of an item.commctrl.TVHT_ONITEMSTATEICONOn the state icon for a tree view item that is in a user-defined state.commctrl.TVHT_TOLEFTTo the left of the client area.commctrl.TVHT_TORIGHTTo the right of the client area. - -Returns: - - 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: - - - -Value - - -Description - - - -commctrl.TVHT_ABOVEAbove the client area. -commctrl.TVHT_BELOWBelow the client area. -commctrl.TVHT_NOWHEREIn the client area, but below the last item. -commctrl.TVHT_ONITEMOn the bitmap or label associated with an item. -commctrl.TVHT_ONITEMBUTTONOn the button associated with an item. -commctrl.TVHT_ONITEMICONOn the bitmap associated with an item. -commctrl.TVHT_ONITEMINDENTIn the indentation associated with an item. -commctrl.TVHT_ONITEMLABELOn the label (string) associated with an item. -commctrl.TVHT_ONITEMRIGHTIn the area to the right of an item. -commctrl.TVHT_ONITEMSTATEICONOn the state icon for a tree view item that is in a user-defined state. -commctrl.TVHT_TOLEFTTo the left of the client area. -commctrl.TVHT_TORIGHTTo the right of the client area. - - - """ - pass - - -class PyCTreeView(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def PreCreateWindow(self,createStruct:'typing.Any') -> 'typing.Any': - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(typing.Any):A tuple representing a CREATESTRUCT structure. - -Returns: - - typing.Any - - """ - pass - - - def GetTreeCtrl(self,) -> 'PyCTreeCtrl': - """ - Returns the underlying tree control object. - -Args: - - - -Returns: - - PyCTreeCtrl - - """ - pass - - - def OnCommand(self,wparam:'typing.Any',lparam:'typing.Any') -> 'None': - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(typing.Any): - lparam(typing.Any):See Also - -Returns: - - None - - """ - pass - - -class PyCView(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,parent:'PyCWnd',arg:'typing.Any',arg1:'typing.Any',arg2:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]') -> 'None': - """ - Creates the window for a view. - -Args: - - parent(PyCWnd):The parent window (usually a frame) - arg(typing.Any):The child ID for the view - arg1(typing.Any):The style for the view - arg2(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The default position of the window. - -Returns: - - None - - """ - pass - - - def GetDocument(self,) -> 'PyCDocument': - """ - Returns the document for a view. - -Args: - - - -Returns: - - PyCDocument - - """ - pass - - - def OnActivateView(self,activate:'typing.Any',activateView:'PyCView',DeactivateView:'PyCView') -> 'typing.Any': - """ - Calls the underlying MFC OnActivateView method. - -Args: - - activate(typing.Any):Indicates whether the view is being activated or deactivated. - activateView(PyCView):The view object that is being activated. - DeactivateView(PyCView):The view object that is being deactivated.See Also - -Returns: - - typing.Any - - """ - pass - - - def OnInitialUpdate(self,) -> 'None': - """ - Calls the underlying MFC OnInitialUpdate method. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnMouseActivate(self,wnd:'PyCWnd',hittest:'typing.Any',message:'typing.Any') -> 'typing.Any': - """ - Calls the base MFC OnMouseActivate function. - -Args: - - wnd(PyCWnd): - hittest(typing.Any): - message(typing.Any):See Also - -Returns: - - typing.Any - - """ - pass - - - def PreCreateWindow(self,createStruct:'typing.Any') -> 'typing.Any': - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(typing.Any):A tuple representing a CREATESTRUCT structure.See Also - -Returns: - - typing.Any - - """ - pass - - - def OnFilePrint(self,) -> 'None': - """ - Calls the underlying MFC OnFilePrint method. - -Args: - - - -Returns: - - None - - """ - pass - - - def DoPreparePrinting(self,) -> 'typing.Any': - """ - Invoke the Print dialog box and create a printer device context. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def OnBeginPrinting(self,) -> 'None': - """ - Calls the underlying MFC OnBeginPrinting method. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnEndPrinting(self,) -> 'None': - """ - Calls the underlying MFC OnEndPrinting method. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCWinApp(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddDocTemplate(self,template:'PyCDocTemplate') -> 'None': - """ - Adds a template to the application list. - -Args: - - template(PyCDocTemplate):The template to be added. - -Returns: - - None - - """ - pass - - - def FindOpenDocument(self,fileName:'str') -> 'PyCDocument': - """ - Returns an existing document with the specified file name. - -Args: - - fileName(str):The fully qualified filename to search for. - -Returns: - - PyCDocument - - """ - pass - - - def GetDocTemplateList(self,) -> 'typing.List[typing.Any]': - """ - Returns a list of all document templates. - -Args: - - - -Returns: - - typing.List[typing.Any] - - """ - pass - - - def InitDlgInstance(self,dialog:'PyCDialog') -> 'None': - """ - Calls critical InitInstance processing for a dialog based application. - -Args: - - dialog(PyCDialog):The dialog object to be used as the main window for the application. - -Returns: - - None - - """ - pass - - - def LoadCursor(self,cursorId:'PyResourceId') -> 'typing.Any': - """ - Loads a cursor. - -Args: - - cursorId(PyResourceId):The resource id or name of the cursor to load. - -Returns: - - typing.Any - - """ - pass - - - def LoadStandardCursor(self,cursorId:'PyResourceId') -> 'typing.Any': - """ - Loads a standard cursor. - -Args: - - cursorId(PyResourceId):The resource ID or name of the cursor to load. - -Returns: - - typing.Any - - """ - pass - - - def LoadOEMCursor(self,cursorId:'typing.Any') -> 'typing.Any': - """ - Loads an OEM cursor. - -Args: - - cursorId(typing.Any):The ID of the cursor to load. - -Returns: - - typing.Any - - """ - pass - - - def LoadIcon(self,idResource:'typing.Any') -> 'typing.Any': - """ - Loads an icon resource. - -Args: - - idResource(typing.Any):The ID of the icon to load. - -Returns: - - typing.Any - - """ - pass - - - def LoadStandardIcon(self,resourceName:'PyResourceId') -> 'typing.Any': - """ - Loads an icon resource. - -Args: - - resourceName(PyResourceId):The resource name or id of the standard icon to load. - -Returns: - - typing.Any - - """ - pass - - - def OpenDocumentFile(self,fileName:'str') -> 'None': - """ - Opens a document file by name. - -Args: - - fileName(str):The name of the document to open. - -Returns: - - None - - """ - pass - - - def OnFileNew(self,) -> 'None': - """ - Calls the underlying OnFileNew MFC method. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnFileOpen(self,) -> 'None': - """ - Calls the underlying OnFileOpen MFC method. - -Args: - - - -Returns: - - None - - """ - pass - - - def RemoveDocTemplate(self,template:'PyCDocTemplate') -> 'None': - """ - Removes a template to the application list. - -Args: - - template(PyCDocTemplate):The template to be removed. Must have previously been added by PyCWinApp::AddDocTemplate.CommentsNote that MFC does not provide an equivilent function. - -Returns: - - None - - """ - pass - - - def Run(self,) -> 'typing.Any': - """ - Starts the message pump. Advanced users only - -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 - -EXE. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyCWinThread(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateThread(self,) -> 'None': - """ - Creates the actual thread behind the thread object. - -Args: - - - -Returns: - - None - - """ - pass - - - def PumpIdle(self,) -> 'None': - """ - Pumps all idle messages. - -Args: - - - -Returns: - - None - - """ - pass - - - def PumpMessages(self,) -> 'None': - """ - Pumps all messages to the application until a WM_QUIT message is received. - -Args: - - - -Returns: - - None - - """ - pass - - - def Run(self,) -> 'typing.Any': - """ - Starts the message pump. Advanced users only - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetMainFrame(self,mainFrame:'PyCWnd') -> 'None': - """ - Sets the threads main frame - -Args: - - mainFrame(PyCWnd):The applications main frame.CommentsYou can pass None to this function to reset the main frame. Should I free this? I dont think so! - -Returns: - - None - - """ - pass - - - def SetThreadPriority(self,priority:'PyCWnd') -> 'None': - """ - Sets the threads priority. Returns TRUE if successful. - -Args: - - priority(PyCWnd):The threads priority. - -Returns: - - None - - """ - pass - - -class PyCWnd(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ActivateFrame(self,cmdShow:'typing.Any') -> 'None': - """ - Searches upwards for a parent window which has - -a frame, and activates it. - -Args: - - cmdShow(typing.Any):The param passed to CFrameWnd::ShowWindow. See also PyCWnd::ShowWindow.MFC References - -Returns: - - None - - """ - pass - - - def BringWindowToTop(self,) -> 'None': - """ - Brings the window to the top of a stack of overlapping windows. - -Args: - - - -Returns: - - None - - """ - pass - - - def BeginPaint(self,) -> 'typing.Tuple[PyCDC, typing.Any]': - """ - Prepares a window for painting - -Args: - - - -Returns: - - typing.Tuple[PyCDC, typing.Any]:PyCWnd.BeginPaint -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 - -rectangle size. The resulting size can then be used as the initial - -size for the window object. - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The size to calculate from - nAdjustType(typing.Any):An enumerated type used for in-place editing. It can have the following values: CWnd::adjustBorder = 0, which means that scrollbar sizes are ignored in calculation; and CWnd::adjustOutside = 1, which means that they are added into the final measurements of the rectangle.MFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - - """ - pass - - - def CenterWindow(self,altwin:'PyCWnd'=None) -> 'None': - """ - Centers a window relative to its parent. - -Args: - - altwin(PyCWnd):alternate window relative to which it will be centered (other than the parent window).MFC References - -Returns: - - None - - """ - pass - - - def CheckRadioButton(self,idFirst:'typing.Any',idLast:'typing.Any',idCheck:'typing.Any') -> 'None': - """ - Selects the specified radio button, and clears - -all others in the group. - -Args: - - idFirst(typing.Any):The identifier of the first radio button in the group. - idLast(typing.Any):The identifier of the last radio button in the group. - idCheck(typing.Any):The identifier of the radio button to be checked.MFC References - -Returns: - - None - - """ - pass - - - def ChildWindowFromPoint(self,x:'typing.Any',y:'typing.Any',flag:'typing.Any'=0) -> 'PyCWnd': - """ - Returns the child window that contains the point - -Args: - - x(typing.Any):x coordinate of point - y(typing.Any):y coordinate of point - flag(typing.Any):Specifies which child windows to skipMFC References - -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 - -to screen coordinates. - -Args: - - point(typing.Tuple[typing.Any, typing.Any]):The client coordinates.Alternative Parameters - rect(typing.Any):The client coordinates.CommentsThe new screen coordinates are relative to the upper-left corner of the system display. This function assumes that the given pointis in client coordinates.MFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any, typing.Any] - - """ - pass - - - def CreateWindow(self,classId:'str',windowName:'str',style:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',parent:'PyCWnd',_id:'typing.Any',context:'typing.Any'=None) -> 'None': - """ - Creates the actual window - -Args: - - classId(str):The class ID for the window, or None - windowName(str):The title for the window, or None - style(typing.Any):The style for the window. - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The size and position of the window. - parent(PyCWnd):The parent window of the new window.. - _id(typing.Any):The control's ID. - context(typing.Any):A CreateContext object.MFC References - -Returns: - - None - - """ - pass - - - def CreateWindowEx(self,styleEx:'typing.Any',classId:'str',windowName:'str',style:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',parent:'PyCWnd',_id:'typing.Any',createStruct1:'typing.Any',createStruct:'CREATESTRUCT'=None) -> 'None': - """ - Creates the actual window using extended capabilities. - -Args: - - styleEx(typing.Any):The extended style of the window being created. - classId(str):The class ID for the window. May not be None. - windowName(str):The title for the window, or None - style(typing.Any):The style for the window. - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The size and position of the window. - parent(PyCWnd):The parent window of the new window.. - _id(typing.Any):The control's ID. - createStruct1(typing.Any):A tuple representing a CREATESTRUCT structure.MFC References - createStruct(CREATESTRUCT):A CreateStruct object (ie, a tuple) - -Returns: - - None - - """ - pass - - - def DefWindowProc(self,message:'typing.Any',idLast:'typing.Any',idCheck:'typing.Any') -> 'typing.Any': - """ - Calls the default message handler. - -Args: - - message(typing.Any):The Windows message. - idLast(typing.Any):The lParam for the message. - idCheck(typing.Any):The wParam for the message.MFC References - -Returns: - - typing.Any - - """ - pass - - - def DestroyWindow(self,) -> 'None': - """ - Destroy the window attached to the object. - -Args: - - - -Returns: - - None - - """ - pass - - - def DlgDirList(self,defPath:'str',idListbox:'typing.Any',idStaticPath:'typing.Any',fileType:'typing.Any') -> 'None': - """ - Fill a list box with a file or directory listing. - -Args: - - defPath(str):The file spec to fill the list box with - idListbox(typing.Any):The Id of the listbox control to fill. - idStaticPath(typing.Any):The Id of the static control used to display the current drive and directory. If idStaticPath is 0, it is assumed that no such control exists. - fileType(typing.Any):Specifies the attributes of the files to be displayed. It can be any combination of DDL_READWRITE, DDL_READONLY, DDL_HIDDEN, DDL_SYSTEM, DDL_DIRECTORY, DDL_ARCHIVE, DDL_POSTMSGS, DDL_DRIVES or DDL_EXCLUSIVEMFC References - -Returns: - - None - - """ - pass - - - def DlgDirListComboBox(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def DlgDirSelect(self,idListbox:'typing.Any') -> 'str': - """ - None - -Args: - - idListbox(typing.Any):The Id of the listbox.MFC References - -Returns: - - str - - """ - pass - - - def DlgDirSelectComboBox(self,idListbox:'typing.Any') -> 'str': - """ - None - -Args: - - idListbox(typing.Any):The Id of the combobox.MFC References - -Returns: - - str - - """ - pass - - - def DragAcceptFiles(self,bAccept:'typing.Any'=1) -> 'None': - """ - Indicates that the window and children supports files dropped from file manager - -Args: - - bAccept(typing.Any):A flag indicating if files are accepted.MFC References - -Returns: - - None - - """ - pass - - - def DrawMenuBar(self,) -> 'None': - """ - Redraws the menu bar. Can be called if the menu changes. - -Args: - - - -Returns: - - None - - """ - pass - - - def EnableWindow(self,bEnable:'typing.Any'=1) -> 'typing.Any': - """ - Enables or disables the window. Typically used for dialog controls. - -Args: - - bEnable(typing.Any):A flag indicating if the window is to be enabled or disabled.MFC References - -Returns: - - typing.Any:CWnd::EnableWindow -Return ValueReturns the state before the EnableWindow member function was called - - - """ - pass - - - def EndModalLoop(self,result:'typing.Any') -> 'None': - """ - Ends a modal loop. - -Args: - - result(typing.Any):The result as returned to RunModalLoop - -Returns: - - None - - """ - pass - - - def EndPaint(self,paintStruct:'typing.Any') -> 'None': - """ - Ends painting - -Args: - - paintStruct(typing.Any):The object returned from PyCWnd::BeginPaint - -Returns: - - None - - """ - pass - - - def GetCheckedRadioButton(self,idFirst:'typing.Any',idLast:'typing.Any') -> 'typing.Any': - """ - Returns the ID of the checked radio button, or 0 if none is selected. - -Args: - - idFirst(typing.Any):The Id of the first radio button in the group. - idLast(typing.Any):The Id of the last radio button in the group.MFC References - -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 - -will be zero. - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - - """ - pass - - - def GetDC(self,) -> 'PyCDC': - """ - Gets the windows current DC object. - -Args: - - - -Returns: - - PyCDC:PyCWnd.GetDC -PyCDC = GetDC()Gets the windows current DC object. -Return ValueThe result is a PyCDC, or a win32ui.error exception is raised. - - - """ - pass - - - def GetDCEx(self,) -> 'PyCDC': - """ - Gets the windows current DC object with extended caps. - -Args: - - - -Returns: - - PyCDC - - """ - pass - - - def GetDlgCtrlID(self,) -> 'typing.Any': - """ - Returns the ID of this child window. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetDlgItem(self,idControl:'typing.Any') -> 'PyCWnd': - """ - None - -Args: - - idControl(typing.Any):The Id of the control to be retrieved.MFC References - -Returns: - - PyCWnd:CWnd::GetDlgItem -Return ValueThe result is a PyCWnd (or derived) object, or a win32ui.error exception is raised. - - - """ - pass - - - def GetDlgItemInt(self,idControl:'typing.Any',bUnsigned:'typing.Any'=1) -> 'typing.Any': - """ - Returns the integer value of a child window or control with the specified ID. - -Args: - - idControl(typing.Any):The Id of the control to be retrieved. - bUnsigned(typing.Any):Should the function check for a minus signMFC References - -Returns: - - typing.Any:CWnd::GetDlgItemInt -Return ValueIf the value can not be converted, a ValueError is raised. - - - """ - pass - - - def GetDlgItemText(self,idControl:'typing.Any') -> 'str': - """ - Returns the text of child window or control with the specified ID. - -Args: - - idControl(typing.Any):The Id of the control to be retrieved.MFC References - -Returns: - - str - - """ - pass - - - def GetLastActivePopup(self,) -> 'PyCWnd': - """ - Returns the last active popup Window, or the Window itself. - -Args: - - - -Returns: - - PyCWnd:CWnd::GetLastActivePopup -Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - - """ - pass - - - def GetMenu(self,) -> 'PyCMenu': - """ - Returns the menu object for the window's menu. - -Args: - - - -Returns: - - PyCMenu:CWnd::GetMenu -Return ValueThe result is a PyMenu - - object, or an exception is thrown. - - - """ - pass - - - def GetParent(self,) -> 'PyCWnd': - """ - Returns the window's parent. - -Args: - - - -Returns: - - PyCWnd:CWnd::GetParent -Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - - """ - pass - - - def GetParentFrame(self,) -> 'PyCWnd': - """ - Returns the window's frame. - -Args: - - - -Returns: - - PyCWnd:CWnd::GetParentFrame -Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - - """ - pass - - - def GetSafeHwnd(self,) -> 'typing.Any': - """ - Returns the HWnd of this window. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetScrollInfo(self,nBar:'typing.Any',mask:'typing.Any') -> 'typing.Any': - """ - Returns information about a scroll bar - -Args: - - nBar(typing.Any):The scroll bar to examine. Can be one of win32con.SB_BOTH, win32con.SB_VERT or win32con.SB_HORZ - mask(typing.Any):The mask for attributes to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def GetScrollPos(self,nBar:'typing.Any') -> 'typing.Any': - """ - Retrieves the current position of the scroll box of a scroll bar. - -Args: - - nBar(typing.Any):The scroll bar to examine. Can be one of win32con.SB_VERT or win32con.SB_HORZ - -Returns: - - typing.Any - - """ - pass - - - def GetStyle(self,) -> 'typing.Any': - """ - Retrieves the window style - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetExStyle(self,) -> 'typing.Any': - """ - Retrieves the window's extended style - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetSystemMenu(self,) -> 'PyCMenu': - """ - Returns the menu object for the window's system menu. - -Args: - - - -Returns: - - PyCMenu - - """ - pass - - - def GetTopLevelFrame(self,) -> 'PyCWnd': - """ - Returns the top-level frame of the window. - -Args: - - - -Returns: - - PyCWnd:CWnd::GetTopLevelFrame -Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - - """ - pass - - - def GetTopLevelOwner(self,) -> 'PyCWnd': - """ - Returns the top-level owner of the window. - -Args: - - - -Returns: - - PyCWnd:CWnd::GetTopLevelOwner -Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - - """ - pass - - - def GetTopLevelParent(self,) -> 'PyCWnd': - """ - Returns the top-level parent of the window. - -Args: - - - -Returns: - - PyCWnd:CWnd::GetTopLevelParent -Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - - """ - pass - - - def GetTopWindow(self,) -> 'PyCWnd': - """ - Identifies the top-level child window in a linked list of child windows. - -Args: - - - -Returns: - - PyCWnd:CWnd::GetTopWindow -Return ValueIf no child windows exist, the value is None. - - - """ - pass - - - def GetWindow(self,_type:'typing.Any') -> 'PyCWnd': - """ - Returns a window, with the specified relationship to this window. - -Args: - - _type(typing.Any):Specifies the relationship between the current and the returned window. It can take one of the following values: GW_CHILD, GW_HWNDFIRST, GW_HWNDLAST, GW_HWNDNEXT, GW_HWNDPREV or GW_OWNERMFC References - -Returns: - - PyCWnd:CWnd::GetWindow -Return ValueThe result is a PyCWnd or None if no Window can be found. - - - """ - pass - - - def GetWindowDC(self,) -> 'PyCDC': - """ - Gets the windows current DC object. - -Args: - - - -Returns: - - PyCDC - - """ - pass - - - def GetWindowPlacement(self,) -> 'typing.Any': - """ - Returns placement information about the current window. - -Args: - - - -Returns: - - typing.Any:CWnd::GetWindowPlacement -Return ValueThe result is a tuple of - -(flags, showCmd, (minposX, minposY), (maxposX, maxposY), (normalposX, normalposY)) - - - -Item - - -Description - - - -flagsOne of the WPF_* constants -showCmdCurrent state - one of the SW_* constants. -minposSpecifies the coordinates of the window's upper-left corner when the window is minimized. -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 - -corner - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - - """ - pass - - - def GetWindowText(self,) -> 'str': - """ - Returns the windows text. - -Args: - - - -Returns: - - str - - """ - pass - - - def HideCaret(self,) -> 'None': - """ - Hides the caret - -Args: - - - -Returns: - - None - - """ - pass - - - def HookAllKeyStrokes(self,obHandler:'typing.Any') -> 'None': - """ - Hook a key stroke handler for all key strokes. - -Args: - - obHandler(typing.Any):The handler for the keystrokes. This must be a callable object.CommentsThe handler object passed will be called as the application receives WM_CHAR messages. The handler will be called with 2 arguments The handler object (as per all hook functions). The keystroke being handled. If the handler returns TRUE, then the keystroke will be passed on to the default handler, otherwise it will be consumed. Note: This handler will prevent any PyCWnd::HookKeyStroke hooks from being called. - -Returns: - - None - - """ - pass - - - def HookKeyStroke(self,obHandler:'typing.Any',ch:'typing.Any') -> 'typing.Any': - """ - Hook a key stroke handler - -Args: - - obHandler(typing.Any):The handler of the keystroke. This must be a callable object. - ch(typing.Any):The ID for the keystroke to be handled. This may be an ascii code, or a virtual key code.CommentsThe 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 The handler object (as per all hook functions) The keystroke being handled. If the handler returns TRUE, then the keystroke will be passed on to the 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. - -Returns: - - 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 - -character code. The handler will be called with 2 arguments - -The handler object (as per all hook functions) - -The keystroke being handled. - -If the handler returns TRUE, then the keystroke will be passed on to the - -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 - - - def HookMessage(self,obHandler:'typing.Any',message:'typing.Any') -> 'typing.Any': - """ - Hook a message notification handler - -Args: - - obHandler(typing.Any):The handler for the message notification. This must be a callable object. - message(typing.Any):The ID of the message to be handled.CommentsThe 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. The handler will be called with 2 arguments The handler object (as per all hook functions). A tuple representing the message. The message tuple is in the following format:Items[0] int : hwndThe hwnd of the window.[1] int : messageThe message.[2] int : wParamThe wParam sent with the message.[3] int : lParamThe lParam sent with the message.[4] int : timeThe time the message was posted.[5] int, int : pointThe point where the mouse was when the message was posted.Return ValueThe return value is the previous handler, or None. - -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. - -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 object (as per all hook functions). - -A tuple representing the message. - -The message tuple is in the following format: -Items[0] int : hwnd -The hwnd of the window. -[1] int : message -The message. -[2] int : wParam -The wParam sent with the message. -[3] int : lParam -The lParam sent with the message. -[4] int : time -The time the message was posted. -[5] int, int : point -The point where the mouse was when the message was posted. -Return ValueThe return value is the previous handler, or None. - - - """ - pass - - - def InvalidateRect(self,arg:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',bErase:'typing.Any'=1) -> 'None': - """ - Invalidates an area of a window. - -Args: - - arg(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Rectangle to be updated. If default param is used, the entire window is invalidated. - bErase(typing.Any):Specifies whether the background within the update region is to be erased.MFC References - -Returns: - - None - - """ - pass - - - def InvalidateRgn(self,region:'PyCRgn',bErase:'typing.Any'=1) -> 'None': - """ - Invalidates a region of the window - -Args: - - region(PyCRgn):The region to erase. - bErase(typing.Any):Indicates if the region should be erased. - -Returns: - - None - - """ - pass - - - def IsChild(self,obWnd:'PyCWnd') -> 'typing.Any': - """ - Determines if a given window is a child of this window. - -Args: - - obWnd(PyCWnd):The window to be checkedMFC References - -Returns: - - typing.Any - - """ - pass - - - def IsDlgButtonChecked(self,idCtl:'typing.Any') -> 'typing.Any': - """ - Determines if a dialog button is checked. - -Args: - - idCtl(typing.Any):The ID of the button to check.MFC References - -Returns: - - typing.Any - - """ - pass - - - def IsIconic(self,) -> 'typing.Any': - """ - Determines if the window is currently displayed as an icon. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def IsZoomed(self,) -> 'typing.Any': - """ - Determines if the window is currently maximised. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def IsWindow(self,) -> 'typing.Any': - """ - determines whether the specified window handle identifies an existing window - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def IsWindowVisible(self,) -> 'typing.Any': - """ - Determines if the window is currently visible. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def KillTimer(self,) -> 'typing.Any': - """ - Kills a system timer - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def LockWindowUpdate(self,) -> 'None': - """ - Disables drawing in the given window - -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 - -coordinate space of another window. - -Args: - - wnd(PyCWnd): - points(typing.List[typing.Tuple[typing.Any, typing.Any]]):The points to mapReturn ValueA list of the mapped points from the coordinate space of the CWnd to the coordinate space of another window. - -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 - -window. - - - """ - pass - - - def MouseCaptured(self,) -> 'typing.Any': - """ - Returns 1 if the window has the mouse capture, else 0 - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def MessageBox(self,message:'str',arg:'typing.Any',title:'typing.Union[str, typing.Any]'=None) -> 'None': - """ - Display a message box. - -Args: - - message(str):The message to be displayed in the message box. - arg(typing.Any):The style of the message box.MFC References - title(typing.Union[str, typing.Any]):The title for the message box. If None, the applications title will be used. - -Returns: - - None:CWnd::MessageBox -Return ValueAn integer identifying the button pressed to dismiss the dialog. - - - """ - pass - - - def ModifyStyle(self,remove:'typing.Any',add:'typing.Any',flags:'typing.Any'=0) -> 'typing.Any': - """ - Modifies the style of a window. - -Args: - - remove(typing.Any):Specifies window styles to be removed during style modification. - add(typing.Any):Specifies window styles to be added during style modification. - flags(typing.Any):Flags to be passed to SetWindowPos, or zero if SetWindowPos should not be called. The default is zero.CommentsIf nFlags is nonzero, ModifyStyle calls the Windows API function ::SetWindowPos and redraws the window by combining nFlags with the following four preset flags: * SWP_NOSIZE Retains the current size. * SWP_NOMOVE Retains the current position. * SWP_NOZORDER Retains the current Z order. * SWP_NOACTIVATE Does not activate the window. See also PyCWnd::ModifyStyleExMFC References - -Returns: - - typing.Any:CWnd::ModifyStyle -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 - - - def ModifyStyleEx(self,remove:'typing.Any',add:'typing.Any',flags:'typing.Any'=0) -> 'typing.Any': - """ - Modifies the extended style of a window. - -Args: - - remove(typing.Any):Specifies extended window styles to be removed during style modification. - add(typing.Any):Specifies extended extended window styles to be added during style modification. - flags(typing.Any):Flags to be passed to SetWindowPos, or zero if SetWindowPos should not be called. The default is zero.CommentsIf nFlags is nonzero, ModifyStyleEx calls the Windows API function ::SetWindowPos and redraws the window by combining nFlags with the following four preset flags: * SWP_NOSIZE Retains the current size. * SWP_NOMOVE Retains the current position. * SWP_NOZORDER Retains the current Z order. * SWP_NOACTIVATE Does not activate the window. See also PyCWnd::ModifyStyleMFC References - -Returns: - - typing.Any:CWnd::ModifyStyleEx -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 - - - def MoveWindow(self,rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',bRepaint:'typing.Any'=1) -> 'None': - """ - Move a window to a new location. - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The new location of the window, relative to the parent. - bRepaint(typing.Any):Indicates if the window should be repainted after the move.MFC References - -Returns: - - None - - """ - pass - - - def OnClose(self,) -> 'typing.Any': - """ - Calls the default MFC OnClose handler. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def OnCtlColor(self,dc:'PyCDC',control:'typing.Any',_type:'typing.Any') -> 'typing.Any': - """ - Calls the default MFC OnCtlColor handler. - -Args: - - dc(PyCDC):The dc - control(typing.Any):The control that want's it's color changed - _type(typing.Any):Type of controlSee Also - -Returns: - - typing.Any - - """ - pass - - - def OnEraseBkgnd(self,dc:'PyCDC') -> 'typing.Any': - """ - Calls the default MFC OnEraseBkgnd handler. - -Args: - - dc(PyCDC):The dcSee Also - -Returns: - - typing.Any - - """ - pass - - - def OnNcHitTest(self,arg:'typing.Tuple[typing.Any, typing.Any]') -> 'typing.Any': - """ - Calls the base MFC OnNcHitTest function. - -Args: - - arg(typing.Tuple[typing.Any, typing.Any]):The pointSee Also - -Returns: - - typing.Any - - """ - pass - - - def OnPaint(self,) -> 'typing.Any': - """ - Calls the default MFC OnPaint handler. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def OnQueryDragIcon(self,) -> 'typing.Any': - """ - Calls the default MFC OnQueryDragIcon handler. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def OnQueryNewPalette(self,) -> 'typing.Any': - """ - Calls the underlying MFC OnQueryNewPalette method. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def OnSetCursor(self,wnd:'PyCWnd',hittest:'typing.Any',message:'typing.Any') -> 'typing.Any': - """ - Calls the base MFC OnSetCursor function. - -Args: - - wnd(PyCWnd): - hittest(typing.Any): - message(typing.Any):See Also - -Returns: - - typing.Any - - """ - pass - - - def OnMouseActivate(self,wnd:'PyCWnd',hittest:'typing.Any',message:'typing.Any') -> 'typing.Any': - """ - Calls the base MFC OnMouseActivate function. - -Args: - - wnd(PyCWnd): - hittest(typing.Any): - message(typing.Any):See Also - -Returns: - - typing.Any - - """ - pass - - - def OnWndMsg(self,msg:'typing.Any',wParam:'typing.Any',lParam:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Calls the default MFC Window Message handler. - -Args: - - msg(typing.Any):The message - wParam(typing.Any):The wParam for the message - lParam(typing.Any):The lParam for the messageMFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any]:CWnd::OnWndMsg -Return ValueThe return value is a tuple of (int, int), being the - -return value from the MFC function call, and the value of the - -lResult param. Please see the MFC documentation for more details. - - - """ - pass - - - def PreCreateWindow(self,createStruct:'typing.Any') -> 'typing.Any': - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(typing.Any):A tuple representing a CREATESTRUCT structure.See Also - -Returns: - - typing.Any - - """ - pass - - - def PumpWaitingMessages(self,firstMsg:'typing.Any',lastMsg:'typing.Any') -> 'None': - """ - Pump messages associate with a window. - -Args: - - firstMsg(typing.Any):First message ID to process - lastMsg(typing.Any):First message ID to processMFC References - -Returns: - - None - - """ - pass - - - def RedrawWindow(self,_object:'PyCRgn',flags:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]'=None) -> 'None': - """ - Updates the specified rectangle or region in the given window's client area. - -Args: - - _object(PyCRgn):A region - flags(typing.Any):MFC References - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):A rect, or None - -Returns: - - None - - """ - pass - - - def ReleaseCapture(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def ReleaseDC(self,dc:'PyCDC') -> 'None': - """ - Releases a device context, freeing it for use by other applications. - -Args: - - dc(PyCDC):The DC to be released. - -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 - -nIDLeftOver, UINT nFlag = CWnd::reposDefault, LPRECT lpRectParam = NULL, LPCRECT lpRectClient = NULL, BOOL bStretch = - -TRUE ); - -Args: - - idFirst(typing.Any):The ID of the first control to reposition. - idLast(typing.Any):The ID of the last control to reposition. - idLeftOver(typing.Any): - -Returns: - - None - - """ - pass - - - def RunModalLoop(self,flags:'typing.Any') -> 'typing.Any': - """ - Begins a modal loop for the window. - -Args: - - flags(typing.Any): - -Returns: - - typing.Any - - """ - pass - - - def PostMessage(self,idMessage:'typing.Any',wParam:'typing.Any'=0,lParam:'typing.Any'=0) -> 'None': - """ - Post a message to the window. - -Args: - - idMessage(typing.Any):The ID of the message to post. - wParam(typing.Any):The wParam for the message - lParam(typing.Any):The lParam for the messageMFC References - -Returns: - - None - - """ - pass - - - def SendMessageToDescendants(self,idMessage:'typing.Any',wParam:'typing.Any'=0,lParam:'typing.Any'=0,bDeep:'typing.Any'=1) -> 'None': - """ - Send a message to all descendant windows. - -Args: - - idMessage(typing.Any):The ID of the message to send. - wParam(typing.Any):The wParam for the message - lParam(typing.Any):The lParam for the message - bDeep(typing.Any):Indicates if the message should be recursively sent to all childrenMFC References - -Returns: - - None - - """ - pass - - - def SendMessage(self,idMessage:'typing.Any',idMessage1:'typing.Any',ob:'typing.Any',wParam:'typing.Any'=0,lParam:'typing.Any'=0) -> 'None': - """ - Send a message to the window. - -Args: - - idMessage(typing.Any):The ID of the message to send. - idMessage1(typing.Any):The ID of the message to send. - ob(typing.Any):A buffer whose size is passed in wParam, and address is passed in lParamMFC References - wParam(typing.Any):The wParam for the message - lParam(typing.Any):The lParam for the messageAlternative Parameters - -Returns: - - None - - """ - pass - - - def SetActiveWindow(self,) -> 'PyCWnd': - """ - Sets the window active. Returns the previously active window, or None. - -Args: - - - -Returns: - - PyCWnd:PyCWnd.SetActiveWindow -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 - - - def SetForegroundWindow(self,) -> 'None': - """ - Puts the window into the foreground and activates the window. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetWindowPos(self,hWndInsertAfter:'typing.Any',position:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',flags:'typing.Any') -> 'None': - """ - Sets the windows position information - -Args: - - hWndInsertAfter(typing.Any):A hwnd, else one of the win32con.HWND_* constants. - position(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The new position of the window. - flags(typing.Any):Window positioning flags.MFC References - -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 - -or rectangle on the display to client coordinates. - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any, typing.Any]):The coordinates to convert.Alternative Parameters - pnt(typing.Any):The coordinates to convert.MFC References - -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 - -position of the cursor. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetDlgItemText(self,idControl:'typing.Any',text:'str') -> 'None': - """ - Sets the text for the child window or control with the specified ID. - -Args: - - idControl(typing.Any):The Id of the control - text(str):The new textMFC References - -Returns: - - None - - """ - pass - - - def SetFocus(self,) -> 'None': - """ - Claims the input focus. The object that previously had the focus loses it. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetFont(self,font:'PyCFont',bRedraw:'typing.Any'=1) -> 'None': - """ - Sets the window's current font to the specified font. - -Args: - - font(PyCFont):The new font to use. - bRedraw(typing.Any):If TRUE, redraw the window. - -Returns: - - None - - """ - pass - - - def SetIcon(self,) -> 'typing.Any': - """ - Calls the underlying MFC SetIcon method. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetMenu(self,menuObj:'PyCMenu') -> 'None': - """ - Sets the menu for a window. - -Args: - - menuObj(PyCMenu):The menu object to set, or None to remove the window. - -Returns: - - None - - """ - pass - - - def SetRedraw(self,bState:'typing.Any'=1) -> 'None': - """ - Allows changes to be redrawn or to prevent changes from being redrawn. - -Args: - - bState(typing.Any):Specifies the state of the redraw flag.MFC References - -Returns: - - None - - """ - pass - - - def SetScrollPos(self,nBar:'typing.Any',nPos:'typing.Any',redraw:'typing.Any'=1) -> 'typing.Any': - """ - Sets the current position of the scroll box of a scroll bar. - -Args: - - nBar(typing.Any):The scroll bar to set. Can be one of win32con.SB_VERT or win32con.SB_HORZ - nPos(typing.Any):The new position - redraw(typing.Any):A flag indicating if the scrollbar should be redrawn. - -Returns: - - typing.Any - - """ - pass - - - def SetScrollInfo(self,nBar:'typing.Any',ScrollInfo:'typing.Any',redraw:'typing.Any'=1) -> 'typing.Any': - """ - Set information about a scroll bar - -Args: - - nBar(typing.Any):The scroll bar to examine. Can be one of win32con.SB_BOTH, win32con.SB_VERT or win32con.SB_HORZ - ScrollInfo(typing.Any):The information to set - redraw(typing.Any):A flag indicating if the scrollbar should be re-drawn. - -Returns: - - typing.Any - - """ - pass - - - def SetTimer(self,idEvent:'typing.Any',elapse:'typing.Any') -> 'typing.Any': - """ - Installs a system timer - -Args: - - idEvent(typing.Any):The ID of the event - elapse(typing.Any):How often the timer should fire.MFC References - -Returns: - - typing.Any - - """ - pass - - - def SetWindowPlacement(self,placement:'typing.Any') -> 'None': - """ - Sets the windows placement - -Args: - - placement(typing.Any):A tuple representing the WINDOWPLACEMENT structure.MFC References - -Returns: - - None - - """ - pass - - - def SetWindowText(self,text:'str') -> 'None': - """ - Sets the window's text. - -Args: - - text(str):The windows text.MFC References - -Returns: - - None - - """ - pass - - - def ShowCaret(self,) -> 'None': - """ - Shows the caret - -Args: - - - -Returns: - - None - - """ - pass - - - def ShowScrollBar(self,nBar:'typing.Any',bShow:'typing.Any'=1) -> 'None': - """ - Shows or hides a scroll bar. - -An application should not call ShowScrollBar to hide a scroll bar while processing a scroll-bar notification message. - -Args: - - nBar(typing.Any):Specifies whether the scroll bar is a control or part of a window's nonclient area. If it is part of the nonclient area, nBar also indicates whether the scroll bar is positioned horizontally, vertically, or both. It must be one of win32con.SB_BOTH, win32con.SB_HORZ or win32con.SB_VERT. - bShow(typing.Any):Indicates if the scroll bar should be shown or hidden.MFC References - -Returns: - - None - - """ - pass - - - def ShowWindow(self,arg:'typing.Any') -> 'typing.Any': - """ - Sets the visibility state of the window. - -Args: - - arg(typing.Any):Specifies how the window is to be shown. It must be one of win32con.SW_HIDE, win32con.SW_MINIMIZE, win32con.SW_RESTORE, win32con.SW_SHOW, win32con.SW_SHOWMAXIMIZED win32con.SW_SHOWMINIMIZED, win32con.SW_SHOWMINNOACTIVE, win32con.SW_SHOWNA, win32con.SW_SHOWNOACTIVATE, or win32con.SW_SHOWNORMALMFC References - -Returns: - - typing.Any:CWnd::ShowWindow -Return ValueReturns TRUE is the window was previously visible. - - - """ - pass - - - def UnLockWindowUpdate(self,) -> 'None': - """ - Unlocks a window that was locked with LockWindowUpdate - -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. - -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. - -Args: - - bSaveAndValidate(typing.Any):Flag that indicates whether dialog box is being initialized (FALSE) or data is being retrieved (TRUE).MFC References - -Returns: - - typing.Any - - """ - pass - - - def UpdateDialogControls(self,pTarget:'PyCCmdTarget',disableIfNoHandler:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - pTarget(PyCCmdTarget):The main frame window of the application, and is used for routing update messages. - disableIfNoHandler(typing.Any):Flag that indicates whether a control that has no update handler should be automatically displayed as disabled. - -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 - -of the window is marked as invalid. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyDDEConv(object): - """A DDE topic.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ConnectTo(self,service:'str',topic:'str') -> 'None': - """ - Connects to a server - -Args: - - service(str):The service to connect to - topic(str):The topic to connect to - -Returns: - - None - - """ - pass - - - def Connected(self,) -> 'None': - """ - Determines if the conversation is connected. - -Args: - - - -Returns: - - None - - """ - pass - - - def Exec(self,Cmd:'str') -> 'None': - """ - Executes a command. - -Args: - - Cmd(str):The Python statement to execute - -Returns: - - None - - """ - pass - - - def Request(self,) -> 'None': - """ - Sends a request. - -Args: - - - -Returns: - - None - - """ - pass - - - def Poke(self,) -> 'None': - """ - Sends a poke. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyDDEServer(object): - """A DDE server.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddTopic(self,topic:'PyDDETopic') -> 'None': - """ - None - -Args: - - topic(PyDDETopic):The topic to add. - -Returns: - - None - - """ - pass - - - def Create(self,name:'str',filterFlags:'typing.Any'=0) -> 'None': - """ - Create a server - -Args: - - name(str):Name of the server to start. - filterFlags(typing.Any):Filter flags.CommentsNote there can only be one server per application. - -Returns: - - None - - """ - pass - - - def Destroy(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def GetLastError(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def Shutdown(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - -class PyDDEStringItem(object): - """A DDE string item.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetData(self,data:'str') -> 'None': - """ - Sets an items data, and causes any underlying notification. - -Args: - - data(str):The data to set. - -Returns: - - None - - """ - pass - - -class PyDDETopic(object): - """A DDE topic.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddItem(self,item:'typing.Any') -> 'None': - """ - Add an item to the topic. - -Args: - - item(typing.Any):The item to add - -Returns: - - None - - """ - pass - - - def Destroy(self,) -> 'None': - """ - Destroys an item - -Args: - - - -Returns: - - None - - """ - pass - - -class PyDLL(object): - """A DLL object. A general utility object, and not associated with an MFC object.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetFileName(self,) -> 'str': - """ - Returns the name of the module associated with the DLL. - -Args: - - - -Returns: - - str - - """ - pass - - - def AttachToMFC(self,) -> 'None': - """ - Attaches the DLL object to the MFC list of DLL's. - -Args: - - - -Returns: - - None - - """ - pass - - -class SCROLLINFO(object): - """Tuple representing a SCROLLINFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class TV_ITEM(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class EXTENSION_CONTROL_BLOCK(object): - """A python representation of an ISAPI - -EXTENSION_CONTROL_BLOCK.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Version(self)->'int': - """Version info of this spec (read-only)""" - pass - - - @property - def TotalBytes(self)->'typing.Any': - """Total bytes indicated from client""" - pass - - - @property - def AvailableBytes(self)->'typing.Any': - """Available number of bytes""" - pass - - - @property - def HttpStatusCode(self)->'typing.Any': - """The status of the current transaction when the request is completed.""" - pass - - - @property - def Method(self)->'typing.Any': - """REQUEST_METHOD""" - pass - - - @property - def ConnID(self)->'typing.Any': - """Context number (read-only)""" - pass - - - @property - def QueryString(self)->'typing.Any': - """QUERY_STRING""" - pass - - - @property - def PathInfo(self)->'typing.Any': - """PATH_INFO""" - pass - - - @property - def PathTranslated(self)->'typing.Any': - """PATH_TRANSLATED""" - pass - - - @property - def AvailableData(self)->'typing.Any': - """Pointer to cbAvailable bytes""" - pass - - - @property - def ContentType(self)->'typing.Any': - """Content type of client data""" - pass - - - @property - def LogData(self)->'typing.Any': - """log data string""" - pass - - - def WriteClient(self,data:'typing.Union[str, typing.Any]',reserved:'typing.Any'=0) -> 'typing.Any': - """ - None - -Args: - - data(typing.Union[str, typing.Any]):The data to write - reserved(typing.Any):Return Valuethe result is the number of bytes written. - -Returns: - - typing.Any: -Return Valuethe result is the number of bytes written. - - - """ - pass - - - def GetServerVariable(self,variable:'str',default:'typing.Any') -> 'str': - """ - None - -Args: - - variable(str): - default(typing.Any):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 begins with 'UNICODE_', in which case it is a unicode object - see the ISAPI docs for more details. - -Returns: - - 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 - -begins with 'UNICODE_', in which case it is a unicode object - see the - -ISAPI docs for more details. - - - """ - pass - - - def ReadClient(self,nbytes:'typing.Any') -> 'str': - """ - None - -Args: - - nbytes(typing.Any):Default is to read all available data. - -Returns: - - str - - """ - pass - - - def SendResponseHeaders(self,reply:'str',headers:'str',keepAlive:'typing.Any'=False) -> 'None': - """ - Calls ServerSupportFunction with - -HSE_REQ_SEND_RESPONSE_HEADER_EX - -Args: - - reply(str): - headers(str): - keepAlive(typing.Any): - -Returns: - - None - - """ - pass - - - def SetFlushFlag(self,flag:'typing.Any') -> 'None': - """ - Calls ServerSupportFunction with HSE_REQ_SET_FLUSH_FLAG. - -Args: - - flag(typing.Any): - -Returns: - - None - - """ - pass - - - def TransmitFile(self,callback:'typing.Any',param:'typing.Any',hFile:'typing.Any',statusCode:'str',BytesToWrite:'typing.Any',Offset:'typing.Any',head:'str',tail:'str',flags:'typing.Any') -> 'typing.Any': - """ - Calls ServerSupportFunction with HSE_REQ_TRANSMIT_FILE - -Args: - - callback(typing.Any): - param(typing.Any):Any object - passed as 2nd arg to callback. - hFile(typing.Any): - statusCode(str): - BytesToWrite(typing.Any): - Offset(typing.Any): - head(str): - tail(str): - flags(typing.Any):CommentsThe callback is called with 4 args - (PyECB, param, cbIO, dwErrCode) - -Returns: - - typing.Any - - """ - pass - - - def MapURLToPath(self,) -> 'None': - """ - Calls ServerSupportFunction with HSE_REQ_MAP_URL_TO_PATH - -Args: - - - -Returns: - - None - - """ - pass - - - def DoneWithSession(self,status:'typing.Any') -> 'None': - """ - Calls ServerSupportFunction with HSE_REQ_DONE_WITH_SESSION - -Args: - - status(typing.Any):An optional status. HSE_STATUS_SUCCESS_AND_KEEP_CONN is supported by IIS to keep the connection alive. - -Returns: - - None - - """ - pass - - - def Redirect(self,url:'str') -> 'None': - """ - Calls ServerSupportFunction with HSE_REQ_SEND_URL_REDIRECT_RESP - -Args: - - url(str):The URL to redirect to - -Returns: - - None - - """ - pass - - - def IsKeepAlive(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def GetAnonymousToken(self,metabase_path:'typing.Union[str, typing.Any]') -> 'typing.Any': - """ - Calls ServerSupportFunction with HSE_REQ_GET_ANONYMOUS_TOKEN - -or HSE_REQ_GET_UNICODE_ANONYMOUS_TOKEN - -Args: - - metabase_path(typing.Union[str, typing.Any]): - -Returns: - - typing.Any - - """ - pass - - - def GetImpersonationToken(self,) -> 'typing.Any': - """ - Calls ServerSupportFunction with - -HSE_REQ_GET_IMPERSONATION_TOKEN - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def IsKeepConn(self,) -> 'typing.Any': - """ - Calls ServerSupportFunction with HSE_REQ_IS_KEEP_CONN - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def ExecURL(self,url:'str',method:'str',clientHeaders:'str',info:'typing.Any',entity:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - Calls ServerSupportFunction with HSE_REQ_EXEC_URL - -Args: - - url(str): - method(str): - clientHeaders(str): - info(typing.Any):Must be None - entity(typing.Any):Must be None - flags(typing.Any):CommentsThis function is only available in IIS6 and later. - -Returns: - - typing.Any - - """ - pass - - - def GetExecURLStatus(self,) -> 'typing.Any': - """ - Calls ServerSupportFunction with HSE_REQ_GET_EXEC_URL_STATUS - -Args: - - - -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 - -operations. - -Args: - - func(typing.Any):The function to call, as described by the EXTENSION_CONTROL_BLOCK::IOCallback method. - arg(typing.Any):Any object which will be supplied as an argument to the callback function.CommentsIf you call this multiple times, the previous callback will be discarded.A reference to the callback and args are held until EXTENSION_CONTROL_BLOCK::DoneWithSession is called. If the callback function fails, DoneWithSession(HSE_STATUS_ERROR) will automatically be called and no further callbacks for the ECB will be made. - -Returns: - - typing.Any - - """ - pass - - - def ReportUnhealthy(self,reason:'str'=None) -> 'typing.Any': - """ - Calls ServerSupportFunction with HSE_REQ_REPORT_UNHEALTHY - -Args: - - reason(str):An optional reason to be written to the log. - -Returns: - - typing.Any - - """ - pass - - - def IOCallback(self,ecb:'EXTENSION_CONTROL_BLOCK',arg:'typing.Any',cbIO:'typing.Any',dwError:'typing.Any') -> 'typing.Any': - """ - A placeholder for a user-supplied callback function. - -Args: - - ecb(EXTENSION_CONTROL_BLOCK):The extension control block that is associated with the current, active request. - arg(typing.Any):The user-supplied argument supplied to the EXTENSION_CONTROL_BLOCK::IOCompletion function. - cbIO(typing.Any):An integer that contains the number of bytes of I/O in the last call. - dwError(typing.Any):The error code returned.CommentsThis is not a function you can call, it describes the signature of the callback function supplied to the EXTENSION_CONTROL_BLOCK::IOCompletion function.Return ValueThe result of this function is ignored. - -Returns: - - typing.Any:The error code returned.Comments - -This is not a function you can call, it describes the signature of - -the callback function supplied to the EXTENSION_CONTROL_BLOCK::IOCompletion - -function. -Return ValueThe result of this function is ignored. - - - """ - pass - - -class HSE_VERSION_INFO(object): - """An object used by ISAPI GetExtensionVersion""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ExtensionDesc(self)->'str': - """The description of the extension.""" - pass - - -class HTTP_FILTER_AUTHENT(object): - """A Python representation of an ISAPI - -HTTP_FILTER_AUTHENT structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def User(self)->'str': - """""" - pass - - - @property - def Password(self)->'str': - """""" - pass - - -class HTTP_FILTER_CONTEXT(object): - """A Python representation of an ISAPI - -HTTP_FILTER_CONTEXT structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Revision(self)->'typing.Any': - """(read-only)""" - pass - - - @property - def fIsSecurePort(self)->'typing.Any': - """(read-only)""" - pass - - - @property - def NotificationType(self)->'typing.Any': - """(read-only)""" - pass - - - @property - def FilterContext(self)->'typing.Any': - """Any object you wish to associate with the request.""" - pass - - - def GetData(self,) -> 'typing.Any': - """ - Obtains the data passed to - -The HttpFilterProc function. This is not techinally part of the - -HTTP_FILTER_CONTEXT structure, but packaged here for convenience. - -Args: - - - -Returns: - - typing.Any:HTTP_FILTER_CONTEXT.GetData - -object = GetData()Obtains the data passed to - -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 - - - - -NotificationType - - -Result type - - - -SF_NOTIFY_URL_MAPHTTP_FILTER_URL_MAP -SF_NOTIFY_PREPROC_HEADERSHTTP_FILTER_PREPROC_HEADERS -SF_NOTIFY_LOGHTTP_FILTER_LOG -SF_NOTIFY_SEND_RAW_DATAHTTP_FILTER_RAW_DATA -SF_NOTIFY_READ_RAW_DATAHTTP_FILTER_RAW_DATA -SF_NOTIFY_AUTHENTICATIONHTTP_FILTER_AUTHENT - - - """ - pass - - - def GetServerVariable(self,variable:'str',default:'typing.Any') -> 'str': - """ - None - -Args: - - variable(str): - default(typing.Any):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 begins with 'UNICODE_', in which case it is a unicode object - see the ISAPI docs for more details. - -Returns: - - 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 - -begins with 'UNICODE_', in which case it is a unicode object - see the - -ISAPI docs for more details. - - - """ - pass - - - def WriteClient(self,data:'str',reserverd:'typing.Any'=0) -> 'None': - """ - None - -Args: - - data(str): - reserverd(typing.Any): - -Returns: - - None - - """ - pass - - - def AddResponseHeaders(self,data:'str',reserverd:'typing.Any'=0) -> 'None': - """ - None - -Args: - - data(str): - reserverd(typing.Any): - -Returns: - - None - - """ - pass - - - def SendResponseHeader(self,status:'str',header:'str') -> 'None': - """ - None - -Args: - - status(str): - header(str): - -Returns: - - None - - """ - pass - - - def DisableNotifications(self,flags:'typing.Any') -> 'None': - """ - None - -Args: - - flags(typing.Any): - -Returns: - - None - - """ - pass - - -class HTTP_FILTER_LOG(object): - """A Python representation of an ISAPI - -HTTP_FILTER_LOG structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ClientHostName(self)->'str': - """""" - pass - - - @property - def ClientUserName(self)->'str': - """""" - pass - - - @property - def ServerName(self)->'str': - """""" - pass - - - @property - def Operation(self)->'str': - """""" - pass - - - @property - def Target(self)->'str': - """""" - pass - - - @property - def Parameters(self)->'str': - """""" - pass - - - @property - def HttpStatus(self)->'typing.Any': - """""" - pass - - -class HTTP_FILTER_PREPROC_HEADERS(object): - """A Python representation of an ISAPI - -HTTP_FILTER_PREPROC_HEADERS structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetHeader(self,header:'str',default:'typing.Any') -> 'str': - """ - None - -Args: - - header(str): - default(typing.Any):If specified, this will be returned on error. - -Returns: - - str - - """ - pass - - - def SetHeader(self,name:'str',val:'str') -> 'None': - """ - None - -Args: - - name(str): - val(str): - -Returns: - - None - - """ - pass - - - def AddHeader(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - -class HTTP_FILTER_RAW_DATA(object): - """A Python representation of an ISAPI - -HTTP_FILTER_RAW_DATA structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def InData(self)->'str': - """""" - pass - - -class HTTP_FILTER_URL_MAP(object): - """A Python representation of an ISAPI - -HTTP_FILTER_URL_MAP structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def URL(self)->'str': - """""" - pass - - - @property - def PhysicalPath(self)->'str': - """""" - pass - - -class HTTP_FILTER_VERSION(object): - """A Python interface to the ISAPI HTTP_FILTER_VERSION - -structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ServerFilterVersion(self)->'typing.Any': - """(read-only)""" - pass - - - @property - def FilterVersion(self)->'typing.Any': - """""" - pass - - - @property - def Flags(self)->'typing.Any': - """""" - pass - - - @property - def FilterDesc(self)->'str': - """""" - pass From 9be8afc3bb7dc3938ee8d567b9f07340991c592b Mon Sep 17 00:00:00 2001 From: Austin <37423484+Toufool@users.noreply.github.com> Date: Mon, 13 Dec 2021 19:44:50 -0500 Subject: [PATCH 006/137] Initial UI update for 2.0.0. Add settings window. --- res/design.ui | 1261 ++++++++++++++++++----------------------------- res/settings.ui | 717 +++++++++++++++++++++++++++ 2 files changed, 1192 insertions(+), 786 deletions(-) create mode 100644 res/settings.ui diff --git a/res/design.ui b/res/design.ui index fea8611c..80334881 100644 --- a/res/design.ui +++ b/res/design.ui @@ -1,13 +1,13 @@ - MainWindow - + main_window + 0 0 - 632 - 490 + 777 + 424 @@ -18,14 +18,14 @@ - 632 - 490 + 777 + 424 - 632 - 490 + 777 + 424 @@ -37,7 +37,7 @@ AutoSplit - + :/resources/icon.ico:/resources/icon.ico @@ -47,53 +47,11 @@ Qt::LeftToRight - - - - 20 - 12 - 98 - 16 - - - - Split Image Folder: - - - - - - 130 - 10 - 412 - 22 - - - - true - - - - - - 540 - 9 - 75 - 24 - - - - Qt::NoFocus - - - Browse... - - - 25 - 145 + 30 + 143 7 16 @@ -102,33 +60,11 @@ X - - - true - - - - 120 - 252 - 129 - 20 - - - - Live Capture Region - - - true - - - false - - - 5 - 70 + 10 + 67 101 23 @@ -140,45 +76,13 @@ Select Region - - - - 7 - 410 - 151 - 16 - - - - Default similarity threshold: - - - - - - 155 - 408 - 61 - 22 - - - - 1.000000000000000 - - - 0.010000000000000 - - - 0.900000000000000 - - - 500 - 425 + 650 + 369 121 - 31 + 27 @@ -189,15 +93,12 @@ - - false - - 500 - 390 + 650 + 339 121 - 31 + 27 @@ -207,78 +108,62 @@ Reset - - - false - + - 340 - 440 - 64 - 21 + 650 + 310 + 59 + 27 Qt::NoFocus - Undo Split + Undo - - - false - + - 410 - 440 - 61 - 21 + 712 + 310 + 59 + 27 Qt::NoFocus - Skip Split - - - - - - 7 - 439 - 131 - 16 - - - - Default pause time (sec): + Skip - 5 - 225 - 54 + 10 + 253 + 53 23 Qt::NoFocus + + calculate the average max FPS of the set capture region + - Avg. FPS + Max FPS - 87 - 225 + 92 + 255 20 20 @@ -287,290 +172,17 @@ FPS - - - true - - - - 7 - 323 - 124 - 20 - - - - Show live similarity - - - true - - - false - - - - - true - - - - 7 - 350 - 145 - 20 - - - - Show highest similarity - - - true - - - false - - - - - - 171 - 326 - 46 - 16 - - - - - - - - - - 171 - 352 - 46 - 16 - - - - - - - - - - 230 - 317 - 58 - 16 - - - - Start / Split - - - - - - 230 - 341 - 28 - 16 - - - - Reset - - - - - - 230 - 367 - 48 - 16 - - - - Skip Split - - - - - - 230 - 393 - 55 - 16 - - - - Undo Split - - - - - - 300 - 314 - 81 - 20 - - - - true - - - - - - 300 - 391 - 81 - 20 - - - - Qt::StrongFocus - - - true - - - - - - 300 - 365 - 81 - 20 - - - - true - - - - - - 300 - 339 - 81 - 20 - - - - true - - - - - - 390 - 314 - 81 - 21 - - - - Qt::NoFocus - - - Set Hotkey - - - - - - 390 - 339 - 81 - 21 - - - - Qt::NoFocus - - - Set Hotkey - - - - - - 390 - 365 - 81 - 21 - - - - Qt::NoFocus - - - Set Hotkey - - - - - - 390 - 391 - 81 - 21 - - - - Qt::NoFocus - - - Set Hotkey - - - - - - 220 - 296 - 2 - 163 - - - - QFrame::Plain - - - 1 - - - Qt::Vertical - - - + - 230 - 291 - 251 - 20 + 119 + 68 + 320 + 240 - - Timer Global Hotkeys - - - Qt::AlignCenter - - - - - - 490 - 296 - 2 - 163 - + + QFrame::Box QFrame::Plain @@ -578,36 +190,20 @@ 1 - - Qt::Vertical - - - - - - 120 - 70 - 240 - 180 - - - - QFrame::Box + + 0 - - Qt::AlignCenter - - 380 - 70 - 240 - 180 + 450 + 68 + 320 + 240 @@ -616,28 +212,28 @@ - - Qt::AlignCenter - - + - 450 - 38 - 102 - 16 + 451 + 31 + 318 + 20 - Current Split Image + Current Image + + + Qt::AlignCenter - 12 - 185 + 17 + 183 33 16 @@ -649,8 +245,8 @@ - 66 - 185 + 70 + 183 41 16 @@ -662,20 +258,20 @@ - 60 - 225 + 65 + 255 26 20 - + 9999 - 6 + 11 200 44 22 @@ -694,7 +290,7 @@ - 62 + 66 200 44 22 @@ -713,68 +309,30 @@ - 200 - 38 - 82 - 16 + 119 + 31 + 319 + 20 Capture Region - - - - - 8 - 252 - 51 - 16 - - - - FPS Limit: - - - - - - 62 - 250 - 44 - 22 - - - - - - - 30 - - - 5000 - - - 1 - - - 60 - - - 0 + + Qt::AlignCenter - + - 380 - 50 - 241 + 478 + 49 + 264 20 - + Image Filename Qt::AlignCenter @@ -783,8 +341,8 @@ - 260 - 250 + 10 + 227 101 23 @@ -799,7 +357,7 @@ - 6 + 11 160 44 22 @@ -827,7 +385,7 @@ - 62 + 66 160 44 22 @@ -852,8 +410,8 @@ - 81 - 145 + 85 + 143 7 16 @@ -862,68 +420,11 @@ Y - - - - 125 - 295 - 91 - 23 - - - - - L2 Norm - - - - - Histograms - - - - - pHash - - - - - - - 155 - 437 - 61 - 22 - - - - 999999999.000000000000000 - - - 1.000000000000000 - - - 10.000000000000000 - - - - - - 7 - 298 - 110 - 16 - - - - Comparison Method - - - 5 - 95 + 10 + 119 101 23 @@ -931,6 +432,9 @@ Qt::NoFocus + + Align the capture region using a reference image + Align Region @@ -938,8 +442,8 @@ - 5 - 120 + 10 + 93 101 23 @@ -951,112 +455,335 @@ Select Window - + - 379 - 252 - 113 - 20 + 696 + 5 + 75 + 24 + + Qt::NoFocus + - Image Loop: + Browse... - + - 230 - 418 - 31 + 10 + 9 + 98 16 - Pause + Split Image Folder: - + - 300 - 416 - 81 - 20 + 119 + 6 + 574 + 22 - - Qt::StrongFocus - true - + - 390 - 416 - 81 - 21 + 120 + 49 + 318 + 20 - - Qt::NoFocus - - Set Hotkey + Window Name - - - - true + + Qt::AlignCenter + + - 500 - 340 - 117 + 450 + 309 + 67 20 - Loop Split Images - - - false - - - false + Image Loop: - + - 500 - 360 - 126 - 20 + 120 + 312 + 321 + 84 - - Auto Start On Reset - - - false + + Similarity Viewer - - false + + Qt::AlignCenter + + + + 133 + 22 + 57 + 16 + + + + Live + + + Qt::AlignCenter + + + + + + 197 + 22 + 57 + 16 + + + + Highest + + + Qt::AlignCenter + + + + + + 261 + 22 + 56 + 16 + + + + Threshold + + + Qt::AlignCenter + + + + + + 0 + 39 + 322 + 3 + + + + Qt::Horizontal + + + + + + 10 + 42 + 111 + 16 + + + + Current Image + + + + + + 10 + 64 + 111 + 16 + + + + Reset Image + + + + + + 0 + 61 + 322 + 3 + + + + Qt::Horizontal + + + + + + 129 + 20 + 3 + 62 + + + + Qt::Vertical + + + + + + 193 + 20 + 3 + 95 + + + + Qt::Vertical + + + + + + 257 + 20 + 3 + 95 + + + + Qt::Vertical + + + + + + 133 + 43 + 57 + 16 + + + + - + + + Qt::AlignCenter + + + + + + 197 + 43 + 57 + 16 + + + + - + + + Qt::AlignCenter + + + + + + 260 + 43 + 57 + 16 + + + + - + + + Qt::AlignCenter + + + + + + 133 + 64 + 57 + 16 + + + + - + + + Qt::AlignCenter + + + + + + 197 + 64 + 57 + 16 + + + + - + + + Qt::AlignCenter + + + + + + 260 + 64 + 57 + 16 + + + + - + + + Qt::AlignCenter + + - + - 500 - 302 + 450 + 369 121 - 31 + 27 @@ -1066,150 +793,92 @@ Reload Start Image - - - - 440 - 270 - 181 - 20 - - - - Start image: - - - + - 7 - 380 - 151 + 450 + 345 + 98 16 - Current similarity threshold: + Start Image Status: - + - 171 - 380 - 46 + 551 + 345 + 98 16 - - - - - - - 120 - 50 - 241 - 20 - - - - - - - Qt::AlignLeading|Qt::AlignLeft|Qt::AlignVCenter + status - - - true - + - 120 - 270 - 221 + 519 + 309 + 131 20 - Force Full Content Rendering (slower) + x/x - - - false - + - 560 - 250 - 61 - 23 + 449 + 49 + 27 + 18 Qt::NoFocus + + Previous image + - Next Img. + < - - - false - + - 494 - 250 - 64 - 23 + 744 + 49 + 27 + 18 Qt::NoFocus + + Next image + - Prev. Img. + > - split_image_folder_label - split_image_folder_input - browse_button x_label - live_image_checkbox select_region_button - similarity_threshold_label - similarity_threshold_spinbox start_auto_splitter_button reset_button - undo_split_button - skip_split_button - pause_label + undo_button + skip_button check_fps_button fps_label - show_live_similarity_checkbox - show_highest_similarity_checkbox - live_similarity_label - highest_similarity_label - split_label - reset_label - skip_split_label - undo_split_label - split_input - undo_split_input - skip_split_input - reset_input - set_split_hotkey_button - set_reset_hotkey_button - set_skip_split_hotkey_button - set_undo_split_hotkey_button - left_line - timer_global_hotkeys_label - right_line - current_split_image_label + current_image_label live_image current_split_image width_label @@ -1218,39 +887,32 @@ width_spinbox height_spinbox capture_region_label - fps_limit_label - fps_limit_spinbox - current_split_image_file_label + current_image_file_label take_screenshot_button x_spinbox y_spinbox y_label - comparison_method_combobox - pause_spinbox - comparison_method_label align_region_button select_window_button - image_loop_label - pause_hotkey_label - pause_input - set_pause_hotkey_button - loop_checkbox - auto_start_on_reset_checkbox - start_image_reload_button - start_image_label - current_similarity_threshold_label - current_similarity_threshold_number_label + browse_button + split_image_folder_label + split_image_folder_input capture_region_window_label - force_print_window_checkbox - next_image_button + image_loop_label + similarity_viewer_groupbox + reload_start_image_button + start_image_status_label + start_image_status_value_label + image_loop_value_label previous_image_button + next_image_button 0 0 - 632 + 777 22 @@ -1259,17 +921,19 @@ Help - + File - - - + + + + + @@ -1284,27 +948,32 @@ About - + + + Split Image Settings + + + - Save Settings + Save Profile - + - Load Settings + Load Profile - + - Save Settings As... + Save Profile As... - Check for Updates... + Check For Updates - + true @@ -1318,6 +987,37 @@ Check for Updates on Open + + + Force Full Render + + + + + Check For Updates On Open + + + + + Dummy Splits When Undoing/Skipping + + + + + Settings + + + + + true + + + true + + + Check For Updates On Open + + split_image_folder_input @@ -1325,20 +1025,9 @@ y_spinbox width_spinbox height_spinbox - fps_limit_spinbox - live_image_checkbox - comparison_method_combobox - show_live_similarity_checkbox - show_highest_similarity_checkbox - similarity_threshold_spinbox - pause_spinbox - split_input - reset_input - skip_split_input - undo_split_input - + diff --git a/res/settings.ui b/res/settings.ui new file mode 100644 index 00000000..22aa4a35 --- /dev/null +++ b/res/settings.ui @@ -0,0 +1,717 @@ + + + dialog_settings + + + + 0 + 0 + 289 + 570 + + + + + 0 + 0 + + + + + 289 + 570 + + + + + 289 + 570 + + + + ArrowCursor + + + Settings + + + false + + + false + + + + + 127 + 538 + 156 + 24 + + + + QDialogButtonBox::Cancel|QDialogButtonBox::Save + + + + + + 10 + 180 + 271 + 101 + + + + Capture Settings + + + + true + + + + 6 + 73 + 204 + 20 + + + + Force a full render of the capture window, which is required for some applications to be captured + + + + + + Force Full Render (slower Max FPS) + + + false + + + false + + + + + + 138 + 25 + 51 + 22 + + + + + + + 0 + + + 30.000000000000000 + + + 5000.000000000000000 + + + 1.000000000000000 + + + 60.000000000000000 + + + + + + 6 + 27 + 121 + 16 + + + + This value will limit the amount of frames per second that AutoSplit will run comparisons + + + + + + Comparison FPS Limit: + + + + + true + + + + 6 + 49 + 129 + 20 + + + + Live Capture Region + + + true + + + false + + + + + + + 10 + 290 + 271 + 241 + + + + Image Settings + + + Qt::AlignLeading|Qt::AlignLeft|Qt::AlignVCenter + + + false + + + false + + + + + 167 + 26 + 88 + 22 + + + + + + + + + + + L2 Norm + + + + + Histograms + + + + + pHash + + + + + + + 6 + 29 + 161 + 16 + + + + Default Comparison Method: + + + + + + 6 + 117 + 161 + 16 + + + + + + + Default Pause Time (sec): + + + + + + 167 + 114 + 87 + 22 + + + + The amount of time in seconds that comparison will be paused before moving to the next image. + + + 2 + + + 999999999.000000000000000 + + + 1.000000000000000 + + + 10.000000000000000 + + + + + + 6 + 58 + 151 + 16 + + + + + + + + + + Default Similarity Threshold: + + + + + + 167 + 56 + 52 + 22 + + + + Threshold that the live similarity will need to go above to consider the image a match. + + + 1.000000000000000 + + + 0.010000000000000 + + + 0.900000000000000 + + + + + true + + + + 6 + 144 + 235 + 20 + + + + Loop Last Split Image to First Split Image + + + false + + + false + + + + + + 6 + 173 + 261 + 61 + + + + + 8 + true + + + + teset + + + <html><head/><body><p>Custom image settings and flags are set in the <br></br> image file name. These will override the default <br></br> values. View the <a href="https://github.com/Toufool/Auto-Split#readme"><span style=" text-decoration: underline; color:#0000ff;">README</span></a> for full details on all <br></br> available custom image settings</p></body></html> + + + + + + 6 + 88 + 161 + 16 + + + + + + + + + + Default Delay Time (ms): + + + + + + 167 + 85 + 87 + 22 + + + + After an image is matched, this is the amount of time in millseconds that will be delayed before splitting. + + + + + + 0 + + + 0.000000000000000 + + + 36000000.000000000000000 + + + 1.000000000000000 + + + 0.000000000000000 + + + + + + + 10 + 10 + 271 + 161 + + + + Hotkeys + + + Qt::AlignLeading|Qt::AlignLeft|Qt::AlignVCenter + + + false + + + false + + + + + 180 + 133 + 81 + 21 + + + + Qt::NoFocus + + + Set Hotkey + + + + + + 76 + 28 + 94 + 20 + + + + + + + false + + + + + + 76 + 80 + 94 + 20 + + + + Qt::StrongFocus + + + + + + true + + + + + + 6 + 31 + 71 + 16 + + + + Start / Split: + + + + + + 76 + 53 + 94 + 20 + + + + IBeamCursor + + + + + + true + + + true + + + + + + 180 + 80 + 81 + 21 + + + + Qt::NoFocus + + + Set Hotkey + + + + + + 6 + 55 + 41 + 16 + + + + Reset: + + + + + + 180 + 53 + 81 + 21 + + + + Qt::NoFocus + + + Set Hotkey + + + + + + 180 + 28 + 81 + 21 + + + + Qt::NoFocus + + + Set Hotkey + + + + + + 6 + 132 + 41 + 16 + + + + Pause: + + + + + + 76 + 133 + 94 + 20 + + + + Qt::StrongFocus + + + + + + true + + + + + + 6 + 82 + 71 + 16 + + + + Undo Split: + + + + + + 180 + 106 + 81 + 21 + + + + Qt::NoFocus + + + Set Hotkey + + + + + + 6 + 108 + 61 + 16 + + + + Skip Split: + + + + + + 76 + 106 + 94 + 20 + + + + + + + true + + + + + + split_input + reset_input + undo_split_input + skip_split_input + pause_input + default_comparison_method + default_similarity_threshold_double_spinbox + default_pause_time_double_spinbox + loop_splits_checkbox + fps_limit_spinbox + live_capture_region_checkbox + force_print_window_checkbox + + + + + save_cancel_dialog_button_box + accepted() + dialog_settings + accept() + + + 194 + 541 + + + 140 + 282 + + + + + save_cancel_dialog_button_box + rejected() + dialog_settings + reject() + + + 194 + 541 + + + 140 + 282 + + + + + From 2d8cb6b4ce0e48d11b84f5d7b79f7d6b68e3cb13 Mon Sep 17 00:00:00 2001 From: Avasam Date: Tue, 14 Dec 2021 22:58:19 -0500 Subject: [PATCH 007/137] hooked new settings window to actual values --- .flake8 | 2 +- README.md | 1 - pyproject.toml | 5 + res/design.ui | 61 +++++--- res/settings.ui | 135 +++++------------- scripts/compile_resources.bat | 1 + scripts/designer.bat | 7 +- src/AutoSplit.py | 262 +++++++++++++++------------------- src/AutoSplitImage.py | 6 +- src/capture_windows.py | 25 ++-- src/error_messages.py | 10 +- src/hotkeys.py | 88 +++++++----- src/menu_bar.py | 113 ++++++++++++++- src/screen_region.py | 28 ++-- src/settings_file.py | 86 ++++++----- src/split_parser.py | 8 +- 16 files changed, 458 insertions(+), 380 deletions(-) diff --git a/.flake8 b/.flake8 index 65910611..2715e740 100644 --- a/.flake8 +++ b/.flake8 @@ -12,7 +12,7 @@ per-file-ignores= __init__.pyi:Q000 ; PyQt methods ignore-names=closeEvent,paintEvent,keyPressEvent,mousePressEvent,mouseMoveEvent,mouseReleaseEvent -; McCabe max-complexity is also taken care of by Pylint and doesn't fail teh build there +; McCabe max-complexity is also taken care of by Pylint and doesn't fail the build there ; So this is the hard limit max-complexity=32 inline-quotes=" diff --git a/README.md b/README.md index 2e43e50d..4084e5e5 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,6 @@ This program can be used to automatically start, split, and reset your preferred - {d} dummy split image. When matched, it moves to the next image without hitting your split hotkey. - {b} split when similarity goes below the threshold rather than above. When a split image filename has this flag, the split image similarity will go above the threshold, do nothing, and then split the next time the similarity goes below the threshold. - {p} pause flag. When a split image filename has this flag, it will hit your pause hotkey rather than your split hokey. - - A pause flag and a dummy flag `{pd}` cannot be used together - Filename examples: - `001_SplitName_(0.9)_[10].png` is a split image with a threshold of 0.9 and a pause time of 10 seconds. - `002_SplitName_(0.9)_[10]_{d}.png` is the second split image with a threshold of 0.9, pause time of 10, and is a dummy split. diff --git a/pyproject.toml b/pyproject.toml index 8001ad5f..3f71a85f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -15,6 +15,11 @@ aggressive = 3 [tool.pyright] pythonPlatform = "Windows" typeCheckingMode = "strict" +# Extra strict +reportPropertyTypeMismatch=true +reportUninitializedInstanceVariable=true +reportCallInDefaultInitializer=true +reportImplicitStringConcatenation=true ignore = [ # Auto generated "src/gen/", diff --git a/res/design.ui b/res/design.ui index 80334881..ea0037ef 100644 --- a/res/design.ui +++ b/res/design.ui @@ -1,7 +1,7 @@ - main_window - + MainWindow + 0 @@ -37,7 +37,7 @@ AutoSplit - + :/resources/icon.ico:/resources/icon.ico @@ -93,6 +93,9 @@ + + false + 650 @@ -108,7 +111,10 @@ Reset - + + + false + 650 @@ -124,7 +130,10 @@ Undo - + + + false + 712 @@ -196,6 +205,9 @@ + + Qt::AlignCenter + @@ -212,6 +224,9 @@ + + Qt::AlignCenter + @@ -265,7 +280,7 @@ - 9999 + @@ -332,7 +347,7 @@ - Image Filename + - Qt::AlignCenter @@ -507,7 +522,7 @@ - Window Name + - Qt::AlignCenter @@ -516,8 +531,8 @@ - 450 - 309 + 451 + 313 67 20 @@ -796,8 +811,8 @@ - 450 - 345 + 449 + 344 98 16 @@ -809,8 +824,8 @@ - 551 - 345 + 550 + 344 98 16 @@ -822,17 +837,20 @@ - 519 - 309 + 520 + 313 131 20 - x/x + N/A + + false + 449 @@ -852,6 +870,9 @@ + + false + 744 @@ -874,8 +895,8 @@ select_region_button start_auto_splitter_button reset_button - undo_button - skip_button + undo_split_button + skip_split_button check_fps_button fps_label current_image_label @@ -1027,7 +1048,7 @@ height_spinbox - + diff --git a/res/settings.ui b/res/settings.ui index 22aa4a35..a388d7d6 100644 --- a/res/settings.ui +++ b/res/settings.ui @@ -1,13 +1,13 @@ - dialog_settings - + DialogSettings + 0 0 289 - 570 + 540 @@ -19,13 +19,13 @@ 289 - 570 + 540 289 - 570 + 540 @@ -40,19 +40,6 @@ false - - - - 127 - 538 - 156 - 24 - - - - QDialogButtonBox::Cancel|QDialogButtonBox::Save - - @@ -93,7 +80,7 @@ false - + 138 @@ -102,23 +89,17 @@ 22 - - - - - 0 + + ArrowCursor - 30.000000000000000 + 20 - 5000.000000000000000 - - - 1.000000000000000 + 240 - 60.000000000000000 + 60 @@ -244,7 +225,7 @@ Default Pause Time (sec): - + 167 @@ -288,7 +269,7 @@ Default Similarity Threshold: - + 167 @@ -332,7 +313,7 @@ false - + 6 @@ -351,10 +332,10 @@ teset - <html><head/><body><p>Custom image settings and flags are set in the <br></br> image file name. These will override the default <br></br> values. View the <a href="https://github.com/Toufool/Auto-Split#readme"><span style=" text-decoration: underline; color:#0000ff;">README</span></a> for full details on all <br></br> available custom image settings</p></body></html> + <html><head/><body><p>Custom image settings and flags are set in the <br></br> image file name. These will override the default <br></br> values. View the <a href="https://github.com/Toufool/Auto-Split#readme"><span style=" text-decoration: underline; color:#0000ff;">README</span></a> for full details on all <br></br> available custom image settings.</p></body></html> - + 6 @@ -373,7 +354,7 @@ Default Delay Time (ms): - + 167 @@ -382,26 +363,14 @@ 22 + + ArrowCursor + After an image is matched, this is the amount of time in millseconds that will be delayed before splitting. - - - - - 0 - - - 0.000000000000000 - - 36000000.000000000000000 - - - 1.000000000000000 - - - 0.000000000000000 + 999999999 @@ -430,7 +399,7 @@ 180 - 133 + 130 81 21 @@ -443,10 +412,13 @@ + + true + 76 - 28 + 30 94 20 @@ -481,7 +453,7 @@ 6 - 31 + 32 71 16 @@ -494,7 +466,7 @@ 76 - 53 + 55 94 20 @@ -532,7 +504,7 @@ 6 - 55 + 57 41 16 @@ -545,7 +517,7 @@ 180 - 53 + 55 81 21 @@ -590,7 +562,7 @@ 76 - 133 + 130 94 20 @@ -622,7 +594,7 @@ 180 - 106 + 105 81 21 @@ -638,7 +610,7 @@ 6 - 108 + 107 61 16 @@ -651,7 +623,7 @@ 76 - 106 + 105 94 20 @@ -672,46 +644,13 @@ skip_split_input pause_input default_comparison_method - default_similarity_threshold_double_spinbox - default_pause_time_double_spinbox + default_similarity_threshold_spinbox + default_pause_time_spinbox loop_splits_checkbox fps_limit_spinbox live_capture_region_checkbox force_print_window_checkbox - - - save_cancel_dialog_button_box - accepted() - dialog_settings - accept() - - - 194 - 541 - - - 140 - 282 - - - - - save_cancel_dialog_button_box - rejected() - dialog_settings - reject() - - - 194 - 541 - - - 140 - 282 - - - - + diff --git a/scripts/compile_resources.bat b/scripts/compile_resources.bat index 3c1398ff..d5ef6cf0 100644 --- a/scripts/compile_resources.bat +++ b/scripts/compile_resources.bat @@ -2,5 +2,6 @@ cd "%~dp0.." md .\src\gen pyuic6 ".\res\about.ui" -o ".\src\gen\about.py" pyuic6 ".\res\design.ui" -o ".\src\gen\design.py" +pyuic6 ".\res\settings.ui" -o ".\src\gen\settings.py" pyuic6 ".\res\update_checker.ui" -o ".\src\gen\update_checker.py" pyside6-rcc ".\res\resources.qrc" -o ".\src\gen\resources_rc.py" diff --git a/scripts/designer.bat b/scripts/designer.bat index 3b7af65e..d3b61064 100644 --- a/scripts/designer.bat +++ b/scripts/designer.bat @@ -11,4 +11,9 @@ IF NOT DEFINED PYTHONPATH ( SET PYTHONPATH=!pythonFiles[0]! ) -START "Qt Designer" "%PYTHONPATH:~0,-11%\Lib\site-packages\qt6_applications\Qt\bin\designer.exe" "%~d0%~p0..\res\design.ui" "%~d0%~p0..\res\about.ui" "%~d0%~p0..\res\update_checker.ui" +START "Qt Designer" "%PYTHONPATH:~0,-11%\Lib\site-packages\qt6_applications\Qt\bin\designer.exe"^ + "%~d0%~p0..\res\design.ui"^ + "%~d0%~p0..\res\about.ui"^ + "%~d0%~p0..\res\settings.ui"^ + "%~d0%~p0..\res\update_checker.ui" + diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 97031748..6fd87522 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -28,18 +28,18 @@ import error_messages import settings_file as settings from AutoControlledWorker import AutoControlledWorker -from capture_windows import capture_region, Rect, set_ui_image -from gen import about, design, update_checker -from hotkeys import send_command, after_setting_hotkey, set_split_hotkey, set_reset_hotkey, set_skip_split_hotkey, \ - set_undo_split_hotkey, set_pause_hotkey -from menu_bar import open_about, VERSION, view_help, check_for_updates, open_update_checker +from capture_windows import capture_region, set_ui_image +from gen import about, design, settings as settings_ui, update_checker +from hotkeys import send_command, after_setting_hotkey +from menu_bar import get_default_settings_from_ui, open_about, VERSION, open_settings, view_help, check_for_updates, \ + open_update_checker from screen_region import select_region, select_window, align_region, validate_before_parsing from settings_file import FROZEN from split_parser import BELOW_FLAG, DUMMY_FLAG, PAUSE_FLAG, parse_and_validate_images -CREATE_NEW_ISSUE_MESSAGE = "Please create a New Issue at " \ - "github.com/Toufool/Auto-Split/issues, describe what happened, and copy & paste the error message below" -START_IMAGE_TEXT = "Start Image" +CREATE_NEW_ISSUE_MESSAGE = ( + "Please create a New Issue at " + + "github.com/Toufool/Auto-Split/issues, describe what happened, and copy & paste the error message below") START_AUTO_SPLITTER_TEXT = "Start Auto Splitter" CHECK_FPS_ITERATIONS = 10 @@ -47,14 +47,14 @@ os.environ["REQUESTS_CA_BUNDLE"] = certifi.where() -def make_excepthook(main_window: AutoSplit): +def make_excepthook(autosplit: AutoSplit): def excepthook(exception_type: type[BaseException], exception: BaseException, _traceback: Optional[TracebackType]): # Catch Keyboard Interrupts for a clean close if exception_type is KeyboardInterrupt or isinstance(exception, KeyboardInterrupt): sys.exit(0) - main_window.show_error_signal.emit(lambda: error_messages.exception_traceback( + autosplit.show_error_signal.emit(lambda: error_messages.exception_traceback( "AutoSplit encountered an unhandled exception and will try to recover, " - f"however, there is no guarantee everything will work properly. {CREATE_NEW_ISSUE_MESSAGE}", + + f"however, there is no guarantee everything will work properly. {CREATE_NEW_ISSUE_MESSAGE}", exception)) return excepthook @@ -82,9 +82,10 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): timer_start_image = QtCore.QTimer() # Widgets - AboutWidget: about.Ui_AboutAutoSplitWidget - UpdateCheckerWidget: update_checker.Ui_UpdateChecker - CheckForUpdatesThread: QtCore.QThread + AboutWidget: Optional[about.Ui_AboutAutoSplitWidget] = None + UpdateCheckerWidget: Optional[update_checker.Ui_UpdateChecker] = None + CheckForUpdatesThread: Optional[QtCore.QThread] = None + SettingsWidget: Optional[settings_ui.Ui_DialogSettings] = None # hotkeys need to be initialized to be passed as thread arguments in hotkeys.py # and for type safety in both hotkeys.py and settings_file.py @@ -95,13 +96,10 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): pause_hotkey: Optional[Callable[[], None]] = None # Initialize a few attributes - split_image_directory = "" hwnd = 0 """Window Handle used for Capture Region""" - window_text = "" - selection = Rect() last_saved_settings: list[Union[str, float, int, bool]] = [] - live_image_function_on_open = True + similarity = 0.0 split_image_number = 0 split_images_and_loop_number: list[tuple[AutoSplitImage, int]] = [] split_groups: list[list[int]] = [] @@ -130,34 +128,32 @@ def __init__(self, parent: Optional[QWidget] = None): # Setup global error handling self.show_error_signal.connect(lambda errorMessageBox: errorMessageBox()) - # Whithin LiveSplit excepthook needs to use main_window's signals to show errors + # Whithin LiveSplit excepthook needs to use MainWindow's signals to show errors sys.excepthook = make_excepthook(self) self.setupUi(self) + # Get default values defined in SettingsDialog + self.settings_dict = get_default_settings_from_ui(self) settings.load_check_for_updates_on_open(self) - # close all processes when closing window self.action_view_help.triggered.connect(view_help) self.action_about.triggered.connect(lambda: open_about(self)) self.action_check_for_updates.triggered.connect(lambda: check_for_updates(self)) - self.action_save_settings.triggered.connect(lambda: settings.save_settings(self)) - self.action_save_settings_as.triggered.connect(lambda: settings.save_settings_as(self)) - self.action_load_settings.triggered.connect(lambda: settings.load_settings(self)) + self.action_settings.triggered.connect(lambda: open_settings(self)) + self.action_save_profile.triggered.connect(lambda: settings.save_settings(self)) + self.action_save_profile_as.triggered.connect(lambda: settings.save_settings_as(self)) + self.action_load_profile.triggered.connect(lambda: settings.load_settings(self)) + + if self.SettingsWidget: + self.SettingsWidget.split_input.setEnabled(False) + self.SettingsWidget.reset_input.setEnabled(False) + self.SettingsWidget.skip_split_input.setEnabled(False) + self.SettingsWidget.undo_split_input.setEnabled(False) + self.SettingsWidget.pause_input.setEnabled(False) if self.is_auto_controlled: - self.set_split_hotkey_button.setEnabled(False) - self.set_reset_hotkey_button.setEnabled(False) - self.set_skip_split_hotkey_button.setEnabled(False) - self.set_undo_split_hotkey_button.setEnabled(False) - self.set_pause_hotkey_button.setEnabled(False) self.start_auto_splitter_button.setEnabled(False) - self.split_input.setEnabled(False) - self.reset_input.setEnabled(False) - self.skip_split_input.setEnabled(False) - self.undo_split_input.setEnabled(False) - self.pause_input.setEnabled(False) - self.timer_global_hotkeys_label.setText("Hotkeys Inactive - Use LiveSplit Hotkeys") # Send version and process ID to stdout print(f"{VERSION}\n{os.getpid()}", flush=True) @@ -183,14 +179,9 @@ def __init__(self, parent: Optional[QWidget] = None): self.undo_split_button.clicked.connect(self.__undo_split) self.next_image_button.clicked.connect(lambda: self.__skip_split(True)) self.previous_image_button.clicked.connect(lambda: self.__undo_split(True)) - self.set_split_hotkey_button.clicked.connect(lambda: set_split_hotkey(self)) - self.set_reset_hotkey_button.clicked.connect(lambda: set_reset_hotkey(self)) - self.set_skip_split_hotkey_button.clicked.connect(lambda: set_skip_split_hotkey(self)) - self.set_undo_split_hotkey_button.clicked.connect(lambda: set_undo_split_hotkey(self)) - self.set_pause_hotkey_button.clicked.connect(lambda: set_pause_hotkey(self)) self.align_region_button.clicked.connect(lambda: align_region(self)) self.select_window_button.clicked.connect(lambda: select_window(self)) - self.start_image_reload_button.clicked.connect(lambda: self.load_start_image(True, True)) + self.reload_start_image_button.clicked.connect(lambda: self.load_start_image(True, True)) self.action_check_for_updates_on_open.changed.connect(lambda: settings.set_check_for_updates_on_open( self, self.action_check_for_updates_on_open.isChecked()) @@ -213,7 +204,7 @@ def __init__(self, parent: Optional[QWidget] = None): self.pause_signal.connect(self.pause) # live image checkbox - self.live_image_checkbox.clicked.connect(self.check_live_image) + self.timer_live_image.start(int(1000 / 60)) self.timer_live_image.timeout.connect(self.__live_image_function) # Automatic timer start @@ -236,49 +227,37 @@ def __browse(self): new_split_image_directory = QFileDialog.getExistingDirectory( self, "Select Split Image Directory", - os.path.join(self.split_image_directory or settings.auto_split_directory, "..")) + os.path.join(self.settings_dict["split_image_directory"] or settings.auto_split_directory, "..")) # If the user doesn't select a folder, it defaults to "". if new_split_image_directory: # set the split image folder line to the directory text - self.split_image_directory = new_split_image_directory + self.settings_dict["split_image_directory"] = new_split_image_directory self.split_image_folder_input.setText(f"{new_split_image_directory}/") self.load_start_image() - def check_live_image(self): - if self.live_image_checkbox.isChecked(): - self.timer_live_image.start(int(1000 / 60)) - else: - self.timer_live_image.stop() - self.__live_image_function() - def __live_image_function(self): - try: - self.capture_region_window_label.setText(self.window_text) - if not self.window_text: - self.timer_live_image.stop() - self.live_image.clear() - if self.live_image_function_on_open: - self.live_image_function_on_open = False - return - # Set live image in UI - if self.hwnd: - capture = capture_region(self.hwnd, self.selection, self.force_print_window_checkbox.isChecked()) - set_ui_image(self.live_image, capture, False) - - except AttributeError: - pass + self.capture_region_window_label.setText(self.settings_dict["captured_window_title"]) + if not (self.settings_dict["live_capture_region"] and self.settings_dict["captured_window_title"]): + self.live_image.clear() + return + # Set live image in UI + if self.hwnd: + capture = capture_region(self.hwnd, + self.settings_dict["capture_region"], + self.settings_dict["force_print_window"]) + set_ui_image(self.live_image, capture, False) def load_start_image(self, started_by_button: bool = False, wait_for_delay: bool = True): self.timer_start_image.stop() - self.current_split_image_file_label.setText(" ") - self.start_image_label.setText(f"{START_IMAGE_TEXT}: not found") + self.current_image_file_label.setText("-") + self.start_image_status_value_label.setText("not found") QApplication.processEvents() if not self.is_auto_controlled \ - and (not self.split_input.text() - or not self.reset_input.text() - or not self.pause_input.text()): + and (not self.settings_dict["split_hotkey"] + or not self.settings_dict["reset_hotkey"] + or not self.settings_dict["pause_hotkey"]): error_messages.load_start_image() return @@ -295,17 +274,17 @@ def load_start_image(self, started_by_button: bool = False, wait_for_delay: bool start_pause_time = self.start_image.get_pause_time(self) if not wait_for_delay and start_pause_time > 0: self.check_start_image_timestamp = time() + start_pause_time - self.start_image_label.setText(f"{START_IMAGE_TEXT}: paused") - self.highest_similarity_label.setText(" ") - self.current_similarity_threshold_number_label.setText(" ") + self.start_image_status_value_label.setText("paused") + self.table_current_image_highest_label.setText("-") + self.table_current_image_threshold_label.setText("-") else: self.check_start_image_timestamp = 0.0 - self.start_image_label.setText(f"{START_IMAGE_TEXT}: ready") + self.start_image_status_value_label.setText("ready") self.__update_split_image(self.start_image) self.highest_similarity = 0.0 self.start_image_split_below_threshold = False - self.timer_start_image.start(int(1000 / self.fps_limit_spinbox.value())) + self.timer_start_image.start(int(1000 / self.settings_dict["fps_limit"])) QApplication.processEvents() @@ -313,35 +292,31 @@ def __start_image_function(self): if self.start_image is None \ or not self.start_image \ or time() < self.check_start_image_timestamp \ - or (not self.split_input.text() and not self.is_auto_controlled): + or (not self.settings_dict["split_hotkey"] and not self.is_auto_controlled): pause_time_left = f"{self.check_start_image_timestamp - time():.1f}" self.current_split_image.setText( - f"None\n (Paused before loading {START_IMAGE_TEXT}).\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: self.check_start_image_timestamp = 0.0 - self.start_image_label.setText(f"{START_IMAGE_TEXT}: ready") + self.start_image_status_value_label.setText("ready") self.__update_split_image(self.start_image) capture = self.__get_capture_for_comparison() start_image_threshold = self.start_image.get_similarity_threshold(self) start_image_similarity = self.start_image.compare_with_capture(self, capture) - self.current_similarity_threshold_number_label.setText(f"{start_image_threshold:.2f}") + self.table_current_image_threshold_label.setText(f"{start_image_threshold:.2f}") # Show live similarity if the checkbox is checked - self.live_similarity_label.setText(str(start_image_similarity)[:4] - if self.show_live_similarity_checkbox.isChecked() - else " ") + self.table_current_image_live_label.setText(str(start_image_similarity)[:4]) # If the similarity becomes higher than highest similarity, set it as such. if start_image_similarity > self.highest_similarity: self.highest_similarity = start_image_similarity # Show live highest similarity if the checkbox is checked - self.highest_similarity_label.setText(str(self.highest_similarity)[:4] - if self.show_highest_similarity_checkbox.isChecked() - else " ") + self.table_current_image_highest_label.setText(str(self.highest_similarity)[:4]) # 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 @@ -361,7 +336,7 @@ def __start_image_function(self): # delay start image if needed if self.start_image.delay > 0: - self.start_image_label.setText(f"{START_IMAGE_TEXT}: delaying start...") + self.start_image_status_value_label.setText("delaying start...") delay_start_time = time() start_delay = self.start_image.delay / 1000 while time() - delay_start_time < start_delay: @@ -371,36 +346,24 @@ def __start_image_function(self): # Email sent to pyqt@riverbankcomputing.com QtTest.QTest.qWait(1) # type: ignore - self.start_image_label.setText(f"{START_IMAGE_TEXT}: started") + self.start_image_status_value_label.setText("started") send_command(self, "start") # Email sent to pyqt@riverbankcomputing.com - QtTest.QTest.qWait(int(1 / self.fps_limit_spinbox.value())) # type: ignore + QtTest.QTest.qWait(int(1 / self.settings_dict["fps_limit"])) # type: ignore self.start_auto_splitter() # update x, y, width, height when spinbox values are changed def __update_x(self): - try: - self.selection.left = self.x_spinbox.value() - self.selection.right = self.selection.left + self.width_spinbox.value() - self.check_live_image() - except AttributeError: - pass + self.settings_dict["capture_region"].x = self.x_spinbox.value() def __update_y(self): - try: - self.selection.top = self.y_spinbox.value() - self.selection.bottom = self.selection.top + self.height_spinbox.value() - self.check_live_image() - except AttributeError: - pass + self.settings_dict["capture_region"].y = self.y_spinbox.value() def __update_width(self): - self.selection.right = self.selection.left + self.width_spinbox.value() - self.check_live_image() + self.settings_dict["capture_region"].width = self.width_spinbox.value() def __update_height(self): - self.selection.bottom = self.selection.top + self.height_spinbox.value() - self.check_live_image() + self.settings_dict["capture_region"].height = self.height_spinbox.value() def __take_screenshot(self): if not validate_before_parsing(self, check_empty_directory=False): @@ -411,13 +374,17 @@ def __take_screenshot(self): # which is a problem, but I doubt anyone will get to 1000 split images... screenshot_index = 1 while True: - screenshot_path = os.path.join(self.split_image_directory, f"{screenshot_index:03}_SplitImage.png") + screenshot_path = os.path.join( + self.settings_dict["split_image_directory"], + f"{screenshot_index:03}_SplitImage.png") if not os.path.exists(screenshot_path): break screenshot_index += 1 # Grab screenshot of capture region - capture = capture_region(self.hwnd, self.selection, self.force_print_window_checkbox.isChecked()) + capture = capture_region(self.hwnd, + self.settings_dict["capture_region"], + self.settings_dict["force_print_window"]) if capture is None: error_messages.region() return @@ -427,7 +394,7 @@ def __take_screenshot(self): os.startfile(screenshot_path) def __check_fps(self): - self.fps_value_label.setText(" ") + self.fps_value_label.clear() if not (validate_before_parsing(self) and parse_and_validate_images(self)): return @@ -521,15 +488,15 @@ def start_auto_splitter(self): or (not self.start_auto_splitter_button.isEnabled() and not self.is_auto_controlled): return - start_label: str = self.start_image_label.text() + start_label: str = self.start_image_status_value_label.text() if start_label.endswith("ready") or start_label.endswith("paused"): - self.start_image_label.setText(f"{START_IMAGE_TEXT}: not ready") + self.start_image_status_value_label.setText("not ready") self.start_auto_splitter_signal.emit() def __check_for_reset(self): if self.start_auto_splitter_button.text() == START_AUTO_SPLITTER_TEXT: - if self.auto_start_on_reset_checkbox.isChecked(): + if self.settings_dict["loop_splits"]: self.start_auto_splitter_signal.emit() else: self.gui_changes_on_reset() @@ -537,7 +504,7 @@ def __check_for_reset(self): return False def __auto_splitter(self): - if not self.split_input.text() and not self.is_auto_controlled: + if not self.settings_dict["split_hotkey"] and not self.is_auto_controlled: self.gui_changes_on_reset() error_messages.split_hotkey() return @@ -606,20 +573,14 @@ def __auto_splitter(self): self.similarity = self.split_image.compare_with_capture(self, capture) # show live similarity if the checkbox is checked - self.live_similarity_label.setText( - str(self.similarity)[:4] - if self.show_live_similarity_checkbox.isChecked() - else " ") + self.table_current_image_live_label.setText(str(self.similarity)[:4]) # if the similarity becomes higher than highest similarity, set it as such. if self.similarity > self.highest_similarity: self.highest_similarity = self.similarity # show live highest similarity if the checkbox is checked - self.highest_similarity_label.setText( - str(self.highest_similarity)[:4] - if self.show_highest_similarity_checkbox.isChecked() - else " ") + self.table_current_image_highest_label.setText(str(self.highest_similarity)[:4]) # If its the last split image and last loop number, disable the next image button # If its the first split image, disable the undo split and previous image buttons @@ -645,7 +606,7 @@ def __auto_splitter(self): break # limit the number of time the comparison runs to reduce cpu usage - frame_interval: float = 1 / self.fps_limit_spinbox.value() + frame_interval: float = 1 / self.settings_dict["fps_limit"] # Email sent to pyqt@riverbankcomputing.com QtTest.QTest.qWait(int(frame_interval - (time() - start) % frame_interval)) # type: ignore QApplication.processEvents() @@ -663,7 +624,7 @@ def __auto_splitter(self): self.waiting_for_split_delay = True self.undo_split_button.setEnabled(False) self.skip_split_button.setEnabled(False) - self.current_split_image_file_label.setText(" ") + self.current_image_file_label.clear() # check for reset while delayed and display a counter of the remaining split delay time delay_start_time = time() @@ -687,7 +648,7 @@ def __auto_splitter(self): # if loop check box is checked and its the last split, go to first split. # else go to the next split image. - if self.loop_checkbox.isChecked() and self.split_image_number == number_of_split_images - 1: + if self.settings_dict["loop_splits"] and self.split_image_number == number_of_split_images - 1: self.split_image_number = 0 else: self.split_image_number += 1 @@ -742,46 +703,49 @@ def gui_changes_on_start(self): self.timer_start_image.stop() self.start_auto_splitter_button.setText("Running...") self.browse_button.setEnabled(False) - self.start_image_reload_button.setEnabled(False) + self.reload_start_image_button.setEnabled(False) self.previous_image_button.setEnabled(True) self.next_image_button.setEnabled(True) + if self.SettingsWidget: + self.SettingsWidget.set_split_hotkey_button.setEnabled(False) + self.SettingsWidget.set_reset_hotkey_button.setEnabled(False) + self.SettingsWidget.set_skip_split_hotkey_button.setEnabled(False) + self.SettingsWidget.set_undo_split_hotkey_button.setEnabled(False) + self.SettingsWidget.set_pause_hotkey_button.setEnabled(False) + if not self.is_auto_controlled: self.start_auto_splitter_button.setEnabled(False) self.reset_button.setEnabled(True) self.undo_split_button.setEnabled(True) self.skip_split_button.setEnabled(True) - self.set_split_hotkey_button.setEnabled(False) - self.set_reset_hotkey_button.setEnabled(False) - self.set_skip_split_hotkey_button.setEnabled(False) - self.set_undo_split_hotkey_button.setEnabled(False) - self.set_pause_hotkey_button.setEnabled(False) QApplication.processEvents() def gui_changes_on_reset(self): self.start_auto_splitter_button.setText(START_AUTO_SPLITTER_TEXT) - self.image_loop_label.setText("Image Loop: -") - self.current_split_image.setText(" ") - self.current_split_image_file_label.setText(" ") - self.live_similarity_label.setText(" ") - self.highest_similarity_label.setText(" ") - self.current_similarity_threshold_number_label.setText(" ") + self.image_loop_value_label.setText("N/A") + self.current_split_image.clear() + self.current_image_file_label.clear() + self.table_current_image_live_label.setText("-") + self.table_current_image_highest_label.setText("-") + self.table_current_image_threshold_label.setText("-") self.browse_button.setEnabled(True) - self.start_image_reload_button.setEnabled(True) + self.reload_start_image_button.setEnabled(True) self.previous_image_button.setEnabled(False) self.next_image_button.setEnabled(False) + if self.SettingsWidget: + self.SettingsWidget.set_split_hotkey_button.setEnabled(True) + self.SettingsWidget.set_reset_hotkey_button.setEnabled(True) + self.SettingsWidget.set_skip_split_hotkey_button.setEnabled(True) + self.SettingsWidget.set_undo_split_hotkey_button.setEnabled(True) + self.SettingsWidget.set_pause_hotkey_button.setEnabled(True) if not self.is_auto_controlled: self.start_auto_splitter_button.setEnabled(True) self.reset_button.setEnabled(False) self.undo_split_button.setEnabled(False) self.skip_split_button.setEnabled(False) - self.set_split_hotkey_button.setEnabled(True) - self.set_reset_hotkey_button.setEnabled(True) - self.set_skip_split_hotkey_button.setEnabled(True) - self.set_undo_split_hotkey_button.setEnabled(True) - self.set_pause_hotkey_button.setEnabled(True) QApplication.processEvents() self.load_start_image(False, False) @@ -790,18 +754,22 @@ def __get_capture_for_comparison(self): """ Grab capture region and resize for comparison """ - capture = capture_region(self.hwnd, self.selection, self.force_print_window_checkbox.isChecked()) + capture = capture_region(self.hwnd, + self.settings_dict["capture_region"], + self.settings_dict["force_print_window"]) # This most likely means we lost capture (ie the captured window was closed, crashed, etc.) if capture is None: # Try to recover by using the window name self.live_image.setText("Trying to recover window...") # https://github.com/kaluluosi/pywin32-stubs/issues/7 - hwnd = win32gui.FindWindow(None, self.window_text) # type: ignore + hwnd = win32gui.FindWindow(None, self.settings_dict["captured_window_title"]) # type: ignore # Don't fallback to desktop if hwnd: self.hwnd = hwnd - capture = capture_region(self.hwnd, self.selection, self.force_print_window_checkbox.isChecked()) + capture = capture_region(self.hwnd, + self.settings_dict["capture_region"], + self.settings_dict["force_print_window"]) return None if capture is None else cv2.resize(capture, COMPARISON_RESIZE, interpolation=cv2.INTER_NEAREST) def __reset_if_should(self, capture: Optional[cv2.ndarray]): @@ -833,15 +801,15 @@ def __update_split_image(self, specific_image: Optional[AutoSplitImage] = None): if self.split_image.bytes is not None: set_ui_image(self.current_split_image, self.split_image.bytes, True) - self.current_split_image_file_label.setText(self.split_image.filename) - self.current_similarity_threshold_number_label.setText(f"{self.split_image.get_similarity_threshold(self):.2f}") + self.current_image_file_label.setText(self.split_image.filename) + self.table_current_image_threshold_label.setText(f"{self.split_image.get_similarity_threshold(self):.2f}") # Set Image Loop # if specific_image and specific_image.image_type == ImageType.START: - self.image_loop_label.setText("Image Loop: N/A") + self.image_loop_value_label.setText("N/A") else: loop_tuple = self.split_images_and_loop_number[self.split_image_number] - self.image_loop_label.setText(f"Image Loop: {loop_tuple[1]}/{loop_tuple[0].loops}") + self.image_loop_value_label.setText(f"{loop_tuple[1]}/{loop_tuple[0].loops}") self.highest_similarity = 0.0 # need to set split below threshold to false each time an image updates. diff --git a/src/AutoSplitImage.py b/src/AutoSplitImage.py index 126f2abe..9eeaf8a9 100644 --- a/src/AutoSplitImage.py +++ b/src/AutoSplitImage.py @@ -46,7 +46,7 @@ def get_pause_time(self, default: Union[AutoSplit, float]): """ default_value: float = default \ if isinstance(default, float) \ - else default.pause_spinbox.value() + else default.settings_dict["default_pause_time"] return default_value if self.__pause_time is None else self.__pause_time def get_similarity_threshold(self, default: Union[AutoSplit, float]): @@ -55,7 +55,7 @@ def get_similarity_threshold(self, default: Union[AutoSplit, float]): """ default_value: float = default \ if isinstance(default, float) \ - else default.similarity_threshold_spinbox.value() + else default.settings_dict["default_similarity_threshold"] return default_value if self.__similarity_threshold is None else self.__similarity_threshold def __init__(self, path: str): @@ -109,7 +109,7 @@ def compare_with_capture( """ comparison_method: int = comparison \ if isinstance(comparison, int) \ - else comparison.comparison_method_combobox.currentIndex() + else comparison.settings_dict["default_comparison_method"] if self.bytes is None or capture is None: return 0.0 diff --git a/src/capture_windows.py b/src/capture_windows.py index c991cc38..c6401efa 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -20,17 +20,15 @@ @dataclass -class Rect(ctypes.wintypes.RECT): - """ - Overrides `ctypes.wintypes.RECT` to replace c_long with int for math operators - """ - left: int = -1 # type: ignore - top: int = -1 # type: ignore - right: int = -1 # type: ignore - bottom: int = -1 # type: ignore +class Region(): + def __init__(self, x: int, y: int, width: int, height: int): + self.x = x + self.y = y + self.width = width + self.height = height -def capture_region(hwnd: int, selection: Rect, print_window: bool): +def capture_region(hwnd: int, selection: Region, print_window: bool): """ Captures an image of the region for a window matching the given parameters of the bounding box @@ -40,8 +38,6 @@ def capture_region(hwnd: int, selection: Rect, print_window: bool): @return: The image of the region in the window in BGRA format """ - width: int = selection.right - selection.left - height: int = selection.bottom - selection.top # If the window closes while it's being manipulated, it could cause a crash try: window_dc: int = win32gui.GetWindowDC(hwnd) @@ -54,16 +50,17 @@ def capture_region(hwnd: int, selection: Rect, print_window: bool): compatible_dc = cast(PyCDC, dc_object.CreateCompatibleDC()) bitmap: PyCBitmap = win32ui.CreateBitmap() - bitmap.CreateCompatibleBitmap(dc_object, width, height) + bitmap.CreateCompatibleBitmap(dc_object, selection.width, selection.height) compatible_dc.SelectObject(bitmap) - compatible_dc.BitBlt((0, 0), (width, height), dc_object, (selection.left, selection.top), win32con.SRCCOPY) + compatible_dc.BitBlt((0, 0), (selection.width, selection.height), dc_object, + (selection.x, selection.y), win32con.SRCCOPY) # https://github.com/kaluluosi/pywin32-stubs/issues/5 # pylint: disable=no-member except (win32ui.error, pywintypes.error): # type: ignore return None image = np.frombuffer(cast(bytes, bitmap.GetBitmapBits(True)), dtype="uint8") - image.shape = (height, width, 4) + image.shape = (selection.height, selection.width, 4) try: dc_object.DeleteDC() diff --git a/src/error_messages.py b/src/error_messages.py index 5d8bd382..cb437f36 100644 --- a/src/error_messages.py +++ b/src/error_messages.py @@ -31,12 +31,12 @@ def split_image_directory_empty(): def image_type(image: str): set_text_message(f'"{image}" is not a valid image file, does not exist, ' - "or the full image file path contains a special character.") + + "or the full image file path contains a special character.") def region(): set_text_message("No region is selected or the Capture Region window is not open. " - "Select a region or load settings while the Capture Region window is open.") + + "Select a region or load settings while the Capture Region window is open.") def split_hotkey(): @@ -45,7 +45,7 @@ def split_hotkey(): def pause_hotkey(): set_text_message("Your split image folder contains an image filename with a pause flag {p}, " - "but no pause hotkey is set.") + + "but no pause hotkey is set.") def align_region_image_type(): @@ -82,7 +82,7 @@ def no_settings_file_on_open(): def too_many_settings_files_on_open(): set_text_message("Too many settings files found. " - "Only one can be loaded on open if placed in the same folder as AutoSplit.exe") + + "Only one can be loaded on open if placed in the same folder as AutoSplit.exe") def check_for_updates(): @@ -91,7 +91,7 @@ def check_for_updates(): def load_start_image(): set_text_message("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.") + + "Please set these hotkeys, and then click the Reload Start Image button.") def stdin_lost(): diff --git a/src/hotkeys.py b/src/hotkeys.py index 80701127..3a6901e2 100644 --- a/src/hotkeys.py +++ b/src/hotkeys.py @@ -1,6 +1,7 @@ from __future__ import annotations from typing import Literal, Optional, TYPE_CHECKING, Union from collections.abc import Callable + if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -18,27 +19,29 @@ # do all of these after you click "Set Hotkey" but before you type the hotkey. def before_setting_hotkey(autosplit: AutoSplit): autosplit.start_auto_splitter_button.setEnabled(False) - autosplit.set_split_hotkey_button.setEnabled(False) - autosplit.set_reset_hotkey_button.setEnabled(False) - autosplit.set_skip_split_hotkey_button.setEnabled(False) - autosplit.set_undo_split_hotkey_button.setEnabled(False) - autosplit.set_pause_hotkey_button.setEnabled(False) + if autosplit.SettingsWidget: + autosplit.SettingsWidget.set_split_hotkey_button.setEnabled(False) + autosplit.SettingsWidget.set_reset_hotkey_button.setEnabled(False) + autosplit.SettingsWidget.set_skip_split_hotkey_button.setEnabled(False) + autosplit.SettingsWidget.set_undo_split_hotkey_button.setEnabled(False) + autosplit.SettingsWidget.set_pause_hotkey_button.setEnabled(False) # 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 after_setting_hotkey(autosplit: AutoSplit): - autosplit.set_split_hotkey_button.setText(SET_HOTKEY_TEXT) - autosplit.set_reset_hotkey_button.setText(SET_HOTKEY_TEXT) - autosplit.set_skip_split_hotkey_button.setText(SET_HOTKEY_TEXT) - autosplit.set_undo_split_hotkey_button.setText(SET_HOTKEY_TEXT) - autosplit.set_pause_hotkey_button.setText(SET_HOTKEY_TEXT) autosplit.start_auto_splitter_button.setEnabled(True) - autosplit.set_split_hotkey_button.setEnabled(True) - autosplit.set_reset_hotkey_button.setEnabled(True) - autosplit.set_skip_split_hotkey_button.setEnabled(True) - autosplit.set_undo_split_hotkey_button.setEnabled(True) - autosplit.set_pause_hotkey_button.setEnabled(True) + if autosplit.SettingsWidget: + autosplit.SettingsWidget.set_split_hotkey_button.setText(SET_HOTKEY_TEXT) + autosplit.SettingsWidget.set_reset_hotkey_button.setText(SET_HOTKEY_TEXT) + autosplit.SettingsWidget.set_skip_split_hotkey_button.setText(SET_HOTKEY_TEXT) + autosplit.SettingsWidget.set_undo_split_hotkey_button.setText(SET_HOTKEY_TEXT) + autosplit.SettingsWidget.set_pause_hotkey_button.setText(SET_HOTKEY_TEXT) + autosplit.SettingsWidget.set_split_hotkey_button.setEnabled(True) + autosplit.SettingsWidget.set_reset_hotkey_button.setEnabled(True) + autosplit.SettingsWidget.set_skip_split_hotkey_button.setEnabled(True) + autosplit.SettingsWidget.set_undo_split_hotkey_button.setEnabled(True) + autosplit.SettingsWidget.set_pause_hotkey_button.setEnabled(True) def is_digit(key: Optional[str]): @@ -57,15 +60,15 @@ def send_command(autosplit: AutoSplit, command: Commands): if autosplit.is_auto_controlled: print(command, flush=True) elif command in {"split", "start"}: - _send_hotkey(autosplit.split_input.text()) + _send_hotkey(autosplit.settings_dict["split_hotkey"]) elif command == "pause": - _send_hotkey(autosplit.pause_input.text()) + _send_hotkey(autosplit.settings_dict["pause_hotkey"]) elif command == "reset": - _send_hotkey(autosplit.reset_input.text()) + _send_hotkey(autosplit.settings_dict["reset_hotkey"]) elif command == "skip": - _send_hotkey(autosplit.skip_split_input.text()) + _send_hotkey(autosplit.settings_dict["skip_split_hotkey"]) elif command == "undo": - _send_hotkey(autosplit.undo_split_input.text()) + _send_hotkey(autosplit.settings_dict["undo_split_hotkey"]) else: raise KeyError(f"'{command}' is not a valid LiveSplit.AutoSplitIntegration command") @@ -138,18 +141,19 @@ def __get_key_name(keyboard_event: KeyboardEvent): def __is_key_already_set(autosplit: AutoSplit, key_name: str): - return key_name in (autosplit.split_input.text(), - autosplit.reset_input.text(), - autosplit.skip_split_input.text(), - autosplit.undo_split_input.text(), - autosplit.pause_input.text()) + return key_name in (autosplit.settings_dict["split_hotkey"], + autosplit.settings_dict["reset_hotkey"], + autosplit.settings_dict["skip_split_hotkey"], + autosplit.settings_dict["undo_split_hotkey"], + autosplit.settings_dict["pause_hotkey"]) # --------------------HOTKEYS-------------------------- # TODO: Refactor to de-duplicate all this code, including settings_file.py # Going to comment on one func, and others will be similar. def set_split_hotkey(autosplit: AutoSplit, preselected_key: str = ""): - autosplit.set_split_hotkey_button.setText(PRESS_A_KEY_TEXT) + if autosplit.SettingsWidget: + autosplit.SettingsWidget.set_split_hotkey_button.setText(PRESS_A_KEY_TEXT) # disable some buttons before_setting_hotkey(autosplit) @@ -188,7 +192,9 @@ def callback(): autosplit.split_hotkey = keyboard.hook_key( key_name, lambda error: _hotkey_action(error, key_name, autosplit.start_auto_splitter)) - autosplit.split_input.setText(key_name) + if autosplit.SettingsWidget: + autosplit.SettingsWidget.split_input.setText(key_name) + autosplit.settings_dict["split_hotkey"] = key_name autosplit.after_setting_hotkey_signal.emit() # try to remove the previously set hotkey if there is one. @@ -198,7 +204,8 @@ def callback(): def set_reset_hotkey(autosplit: AutoSplit, preselected_key: str = ""): - autosplit.set_reset_hotkey_button.setText(PRESS_A_KEY_TEXT) + if autosplit.SettingsWidget: + autosplit.SettingsWidget.set_reset_hotkey_button.setText(PRESS_A_KEY_TEXT) before_setting_hotkey(autosplit) def callback(): @@ -215,7 +222,9 @@ def callback(): autosplit.reset_hotkey = keyboard.hook_key( key_name, lambda error: _hotkey_action(error, key_name, autosplit.reset_signal.emit)) - autosplit.reset_input.setText(key_name) + if autosplit.SettingsWidget: + autosplit.SettingsWidget.reset_input.setText(key_name) + autosplit.settings_dict["reset_hotkey"] = key_name autosplit.after_setting_hotkey_signal.emit() _unhook(autosplit.reset_hotkey) @@ -224,7 +233,8 @@ def callback(): def set_skip_split_hotkey(autosplit: AutoSplit, preselected_key: str = ""): - autosplit.set_skip_split_hotkey_button.setText(PRESS_A_KEY_TEXT) + if autosplit.SettingsWidget: + autosplit.SettingsWidget.set_skip_split_hotkey_button.setText(PRESS_A_KEY_TEXT) before_setting_hotkey(autosplit) def callback(): @@ -241,7 +251,9 @@ def callback(): autosplit.skip_split_hotkey = keyboard.hook_key( key_name, lambda error: _hotkey_action(error, key_name, autosplit.skip_split_signal.emit)) - autosplit.skip_split_input.setText(key_name) + if autosplit.SettingsWidget: + autosplit.SettingsWidget.skip_split_input.setText(key_name) + autosplit.settings_dict["skip_split_hotkey"] = key_name autosplit.after_setting_hotkey_signal.emit() _unhook(autosplit.skip_split_hotkey) @@ -250,7 +262,8 @@ def callback(): def set_undo_split_hotkey(autosplit: AutoSplit, preselected_key: str = ""): - autosplit.set_undo_split_hotkey_button.setText(PRESS_A_KEY_TEXT) + if autosplit.SettingsWidget: + autosplit.SettingsWidget.set_undo_split_hotkey_button.setText(PRESS_A_KEY_TEXT) before_setting_hotkey(autosplit) def callback(): @@ -267,7 +280,9 @@ def callback(): autosplit.undo_split_hotkey = keyboard.hook_key( key_name, lambda error: _hotkey_action(error, key_name, autosplit.undo_split_signal.emit)) - autosplit.undo_split_input.setText(key_name) + if autosplit.SettingsWidget: + autosplit.SettingsWidget.undo_split_input.setText(key_name) + autosplit.settings_dict["undo_split_hotkey"] = key_name autosplit.after_setting_hotkey_signal.emit() _unhook(autosplit.undo_split_hotkey) @@ -276,7 +291,8 @@ def callback(): def set_pause_hotkey(autosplit: AutoSplit, preselected_key: str = ""): - autosplit.set_pause_hotkey_button.setText(PRESS_A_KEY_TEXT) + if autosplit.SettingsWidget: + autosplit.SettingsWidget.set_pause_hotkey_button.setText(PRESS_A_KEY_TEXT) before_setting_hotkey(autosplit) def callback(): @@ -293,7 +309,9 @@ def callback(): autosplit.pause_hotkey = keyboard.hook_key( key_name, lambda error: _hotkey_action(error, key_name, autosplit.pause_signal.emit)) - autosplit.pause_input.setText(key_name) + if autosplit.SettingsWidget: + autosplit.SettingsWidget.pause_input.setText(key_name) + autosplit.settings_dict["pause_hotkey"] = key_name autosplit.after_setting_hotkey_signal.emit() _unhook(autosplit.pause_hotkey) diff --git a/src/menu_bar.py b/src/menu_bar.py index 66cb9c85..d90c1e8c 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -1,5 +1,6 @@ from __future__ import annotations -from typing import TYPE_CHECKING +from typing import TYPE_CHECKING, Any + if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -14,7 +15,9 @@ import error_messages import settings_file as settings -from gen import about, design, resources_rc, update_checker # noqa: F401 +from capture_windows import Region +from gen import about, design, resources_rc, settings as settings_ui, update_checker # noqa: F401 +from hotkeys import set_split_hotkey, set_reset_hotkey, set_skip_split_hotkey, set_undo_split_hotkey, set_pause_hotkey # AutoSplit Version number VERSION = "1.6.1" @@ -82,7 +85,7 @@ def __init__(self, autosplit: AutoSplit, check_on_open: bool): def run(self): try: response = requests.get("https://api.github.com/repos/Toufool/Auto-Split/releases/latest") - latest_version = response.json()["name"].split("v")[1] + latest_version = str(response.json()["name"]).split("v")[1] self.autosplit.update_checker_widget_signal.emit(latest_version, self.check_on_open) except (RequestException, KeyError, JSONDecodeError): if not self.check_on_open: @@ -92,3 +95,107 @@ def run(self): def check_for_updates(autosplit: AutoSplit, check_on_open: bool = False): autosplit.CheckForUpdatesThread = __CheckForUpdatesThread(autosplit, check_on_open) autosplit.CheckForUpdatesThread.start() + + +class __SettingsWidget(QtWidgets.QDialog, settings_ui.Ui_DialogSettings): + def __init__(self, autosplit: AutoSplit): + super().__init__() + self.setupUi(self) + self.autosplit = autosplit + + def set_value(key: str, value: Any): + autosplit.settings_dict[key] = value + +# region Set initial values + # Hotkeys + self.split_input.setText(autosplit.settings_dict["split_hotkey"]) + self.reset_input.setText(autosplit.settings_dict["reset_hotkey"]) + self.undo_split_input.setText(autosplit.settings_dict["undo_split_hotkey"]) + self.skip_split_input.setText(autosplit.settings_dict["skip_split_hotkey"]) + self.pause_input.setText(autosplit.settings_dict["pause_hotkey"]) + + # Capture Settings + self.fps_limit_spinbox.setValue(autosplit.settings_dict["fps_limit"]) + self.live_capture_region_checkbox.setChecked(autosplit.settings_dict["live_capture_region"]) + self.force_print_window_checkbox.setChecked(autosplit.settings_dict["force_print_window"]) + + # Image Settings + self.default_comparison_method.setCurrentIndex(autosplit.settings_dict["default_comparison_method"]) + self.default_similarity_threshold_spinbox.setValue(autosplit.settings_dict["default_similarity_threshold"]) + self.default_delay_time_spinbox.setValue(autosplit.settings_dict["default_delay_time"]) + self.default_pause_time_spinbox.setValue(autosplit.settings_dict["default_pause_time"]) + self.loop_splits_checkbox.setChecked(autosplit.settings_dict["loop_splits"]) +# endregion +# region Binding + # Hotkeys + self.set_split_hotkey_button.clicked.connect(lambda: set_split_hotkey(self.autosplit)) + self.set_reset_hotkey_button.clicked.connect(lambda: set_reset_hotkey(self.autosplit)) + self.set_skip_split_hotkey_button.clicked.connect(lambda: set_skip_split_hotkey(self.autosplit)) + self.set_undo_split_hotkey_button.clicked.connect(lambda: set_undo_split_hotkey(self.autosplit)) + self.set_pause_hotkey_button.clicked.connect(lambda: set_pause_hotkey(self.autosplit)) + + # Capture Settings + self.fps_limit_spinbox.valueChanged.connect(lambda: set_value( + "fps_limit", + self.fps_limit_spinbox.value())) + self.live_capture_region_checkbox.stateChanged.connect(lambda: set_value( + "live_capture_region", + self.live_capture_region_checkbox.isChecked())) + self.force_print_window_checkbox.stateChanged.connect(lambda: set_value( + "force_print_window", + self.force_print_window_checkbox.isChecked())) + + # Image Settings + self.default_comparison_method.currentIndexChanged.connect(lambda: set_value( + "default_comparison_method", + self.default_comparison_method.currentIndex())) + self.default_similarity_threshold_spinbox.valueChanged.connect(lambda: set_value( + "default_similarity_threshold", + self.default_similarity_threshold_spinbox.value())) + self.default_delay_time_spinbox.valueChanged.connect(lambda: set_value( + "default_delay_time", + self.default_delay_time_spinbox.value())) + self.default_pause_time_spinbox.valueChanged.connect(lambda: set_value( + "default_pause_time", + self.default_pause_time_spinbox.value())) + self.loop_splits_checkbox.stateChanged.connect(lambda: set_value( + "loop_splits", + self.loop_splits_checkbox.isChecked())) +# endregion + + self.show() + + +def open_settings(autosplit: AutoSplit): + autosplit.SettingsWidget = __SettingsWidget(autosplit) + + +def get_default_settings_from_ui(autosplit: AutoSplit): + temp_dialog = QtWidgets.QDialog() + default_settings_dialog = settings_ui.Ui_DialogSettings() + default_settings_dialog.setupUi(temp_dialog) + default_settings: settings.SettingsDict = { + "split_hotkey": default_settings_dialog.split_input.text(), + "reset_hotkey": default_settings_dialog.reset_input.text(), + "undo_split_hotkey": default_settings_dialog.undo_split_input.text(), + "skip_split_hotkey": default_settings_dialog.skip_split_input.text(), + "pause_hotkey": default_settings_dialog.pause_input.text(), + "fps_limit": default_settings_dialog.fps_limit_spinbox.value(), + "live_capture_region": default_settings_dialog.live_capture_region_checkbox.isChecked(), + "force_print_window": default_settings_dialog.force_print_window_checkbox.isChecked(), + "default_comparison_method": default_settings_dialog.default_comparison_method.currentIndex(), + "default_similarity_threshold": default_settings_dialog.default_similarity_threshold_spinbox.value(), + "default_delay_time": default_settings_dialog.default_delay_time_spinbox.value(), + "default_pause_time": default_settings_dialog.default_pause_time_spinbox.value(), + "loop_splits": default_settings_dialog.loop_splits_checkbox.isChecked(), + + "split_image_directory": autosplit.split_image_folder_input.text(), + "captured_window_title": "", + "capture_region": Region( + autosplit.x_spinbox.value(), + autosplit.y_spinbox.value(), + autosplit.width_spinbox.value(), + autosplit.height_spinbox.value()) + } + del temp_dialog + return default_settings diff --git a/src/screen_region.py b/src/screen_region.py index 03bbf85e..2342dd8d 100644 --- a/src/screen_region.py +++ b/src/screen_region.py @@ -45,7 +45,7 @@ def select_region(autosplit: AutoSplit): error_messages.region() return autosplit.hwnd = hwnd - autosplit.window_text = window_text + autosplit.settings_dict["captured_window_title"] = window_text offset_x, offset_y, *_ = win32gui.GetWindowRect(autosplit.hwnd) __set_region_values(autosplit, @@ -76,7 +76,7 @@ def select_window(autosplit: AutoSplit): error_messages.region() return autosplit.hwnd = hwnd - autosplit.window_text = window_text + autosplit.settings_dict["captured_window_title"] = window_text # Getting window bounds # On Windows there is a shadow around the windows that we need to account for @@ -134,8 +134,8 @@ def align_region(autosplit: AutoSplit): # subregion being searched for to align the image. capture = capture_windows.capture_region( autosplit.hwnd, - autosplit.selection, - autosplit.force_print_window_checkbox.isChecked()) + autosplit.settings_dict["capture_region"], + autosplit.settings_dict["force_print_window"]) if capture is None: error_messages.region() @@ -151,25 +151,23 @@ def align_region(autosplit: AutoSplit): # The new region can be defined by using the min_loc point and the best_height and best_width of the template. __set_region_values(autosplit, - left=autosplit.selection.left + best_loc[0], - top=autosplit.selection.top + best_loc[1], + left=autosplit.settings_dict["capture_region"].x + best_loc[0], + top=autosplit.settings_dict["capture_region"].y + best_loc[1], width=best_width, height=best_height) def __set_region_values(autosplit: AutoSplit, left: int, top: int, width: int, height: int): - autosplit.selection.left = left - autosplit.selection.top = top - autosplit.selection.right = left + width - autosplit.selection.bottom = top + height + autosplit.settings_dict["capture_region"].x = left + autosplit.settings_dict["capture_region"].y = top + autosplit.settings_dict["capture_region"].width = width + autosplit.settings_dict["capture_region"].height = height autosplit.x_spinbox.setValue(left) autosplit.y_spinbox.setValue(top) autosplit.width_spinbox.setValue(width) autosplit.height_spinbox.setValue(height) - autosplit.check_live_image() - def __test_alignment(capture: cv2.ndarray, template: cv2.ndarray): # Obtain the best matching point for the template within the @@ -213,11 +211,11 @@ def __test_alignment(capture: cv2.ndarray, template: cv2.ndarray): def validate_before_parsing(autosplit: AutoSplit, show_error: bool = True, check_empty_directory: bool = True): error = None - if not autosplit.split_image_directory: + if not autosplit.settings_dict["split_image_directory"]: error = error_messages.split_image_directory - elif not os.path.isdir(autosplit.split_image_directory): + elif not os.path.isdir(autosplit.settings_dict["split_image_directory"]): error = error_messages.split_image_directory_not_found - elif check_empty_directory and not os.listdir(autosplit.split_image_directory): + elif check_empty_directory and not os.listdir(autosplit.settings_dict["split_image_directory"]): error = error_messages.split_image_directory_empty elif autosplit.hwnd <= 0 or not win32gui.GetWindowText(autosplit.hwnd): error = error_messages.region diff --git a/src/settings_file.py b/src/settings_file.py index c0315c23..cc6fec44 100644 --- a/src/settings_file.py +++ b/src/settings_file.py @@ -1,5 +1,6 @@ from __future__ import annotations -from typing import TYPE_CHECKING, Any +from typing import TYPE_CHECKING, Any, TypedDict + if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -12,6 +13,7 @@ from PyQt6 import QtCore, QtWidgets import error_messages +from capture_windows import Region from gen import design from hotkeys import set_pause_hotkey, set_reset_hotkey, set_skip_split_hotkey, set_split_hotkey, set_undo_split_hotkey @@ -21,6 +23,26 @@ auto_split_directory = os.path.dirname(sys.executable if FROZEN else os.path.abspath(__file__)) +class SettingsDict(TypedDict): + split_hotkey: str + reset_hotkey: str + undo_split_hotkey: str + skip_split_hotkey: str + pause_hotkey: str + fps_limit: int + live_capture_region: bool + force_print_window: bool + default_comparison_method: int + default_similarity_threshold: float + default_delay_time: int + default_pause_time: float + loop_splits: bool + + split_image_directory: str + captured_window_title: str + capture_region: Region + + class RestrictedUnpickler(pickle.Unpickler): def find_class(self, module: str, name: str): @@ -29,27 +51,27 @@ def find_class(self, module: str, name: str): def get_save_settings_values(autosplit: AutoSplit): return [ - autosplit.split_image_directory, - autosplit.similarity_threshold_spinbox.value(), - autosplit.comparison_method_combobox.currentIndex(), - autosplit.pause_spinbox.value(), - int(autosplit.fps_limit_spinbox.value()), - autosplit.split_input.text(), - autosplit.reset_input.text(), - autosplit.skip_split_input.text(), - autosplit.undo_split_input.text(), - autosplit.pause_input.text(), - autosplit.x_spinbox.value(), - autosplit.y_spinbox.value(), - autosplit.width_spinbox.value(), - autosplit.height_spinbox.value(), - autosplit.window_text, + autosplit.settings_dict["split_image_directory"], + autosplit.settings_dict["default_similarity_threshold"], + autosplit.settings_dict["default_comparison_method"], + autosplit.settings_dict["default_pause_time"], + autosplit.settings_dict["fps_limit"], + autosplit.settings_dict["split_hotkey"], + autosplit.settings_dict["reset_hotkey"], + autosplit.settings_dict["skip_split_hotkey"], + autosplit.settings_dict["undo_split_hotkey"], + autosplit.settings_dict["pause_hotkey"], + autosplit.settings_dict["capture_region"].x, + autosplit.settings_dict["capture_region"].y, + autosplit.settings_dict["capture_region"].width, + autosplit.settings_dict["capture_region"].height, + autosplit.settings_dict["captured_window_title"], 0, 0, 1, - int(autosplit.loop_checkbox.isChecked()), - int(autosplit.auto_start_on_reset_checkbox.isChecked()), - autosplit.force_print_window_checkbox.isChecked()] + autosplit.settings_dict["loop_splits"], + 0, + autosplit.settings_dict["force_print_window"]] def have_settings_changed(autosplit: AutoSplit): @@ -123,12 +145,12 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str autosplit.show_error_signal.emit(error_messages.invalid_settings) return False - autosplit.split_image_directory = settings[0] + autosplit.settings_dict["split_image_directory"] = settings[0] autosplit.split_image_folder_input.setText(settings[0]) - autosplit.similarity_threshold_spinbox.setValue(settings[1]) - autosplit.comparison_method_combobox.setCurrentIndex(settings[2]) - autosplit.pause_spinbox.setValue(settings[3]) - autosplit.fps_limit_spinbox.setValue(settings[4]) + autosplit.settings_dict["default_similarity_threshold"] = settings[1] + autosplit.settings_dict["default_comparison_method"] = settings[2] + autosplit.settings_dict["default_pause_time"] = settings[3] + autosplit.settings_dict["fps_limit"] = settings[4] keyboard.unhook_all() if not autosplit.is_auto_controlled: set_split_hotkey(autosplit, settings[5]) @@ -140,20 +162,19 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str autosplit.y_spinbox.setValue(settings[11]) autosplit.width_spinbox.setValue(settings[12]) autosplit.height_spinbox.setValue(settings[13]) - autosplit.window_text = settings[14] - autosplit.loop_checkbox.setChecked(bool(settings[18])) - autosplit.auto_start_on_reset_checkbox.setChecked(bool(settings[19])) - autosplit.force_print_window_checkbox.setChecked(settings[20]) + autosplit.settings_dict["captured_window_title"] = settings[14] + autosplit.settings_dict["loop_splits"] = settings[18] + autosplit.settings_dict["force_print_window"] = settings[20] - if autosplit.window_text: + if autosplit.settings_dict["captured_window_title"]: # https://github.com/kaluluosi/pywin32-stubs/issues/7 - hwnd = win32gui.FindWindow(None, autosplit.window_text) # type: ignore + hwnd = win32gui.FindWindow(None, autosplit.settings_dict["captured_window_title"]) # type: ignore if hwnd: autosplit.hwnd = hwnd else: autosplit.live_image.setText("Reload settings after opening" - f'\n"{autosplit.window_text}"' - "\nto automatically load Live Capture") + + f'\n"{autosplit.settings_dict["captured_window_title"]}"' + + "\nto automatically load Capture Region") return True @@ -170,7 +191,6 @@ def load_settings( return autosplit.last_successfully_loaded_settings_file_path = load_settings_file_path - autosplit.check_live_image() autosplit.load_start_image() diff --git a/src/split_parser.py b/src/split_parser.py index 27862ed9..6e4a584f 100644 --- a/src/split_parser.py +++ b/src/split_parser.py @@ -153,9 +153,9 @@ def __pop_image_type(split_image: list[AutoSplitImage], image_type: ImageType): def parse_and_validate_images(autosplit: AutoSplit): # Get split images all_images = [ - AutoSplitImage(os.path.join(autosplit.split_image_directory, image_name)) + AutoSplitImage(os.path.join(autosplit.settings_dict["split_image_directory"], image_name)) for image_name - in os.listdir(autosplit.split_image_directory)] + in os.listdir(autosplit.settings_dict["split_image_directory"])] # Find non-split images and then remove them from the list autosplit.start_image = __pop_image_type(all_images, ImageType.START) @@ -171,7 +171,7 @@ def parse_and_validate_images(autosplit: AutoSplit): return False # error out if there is a {p} flag but no pause hotkey set and is not auto controlled. - if (not autosplit.pause_input.text() + if (not autosplit.settings_dict["pause_hotkey"] and image.check_flag(PAUSE_FLAG) and not autosplit.is_auto_controlled): autosplit.gui_changes_on_reset() @@ -181,7 +181,7 @@ def parse_and_validate_images(autosplit: AutoSplit): # Check that there's only one reset image if image.image_type == ImageType.RESET: # If there is no reset hotkey set but a reset image is present, and is not auto controlled, throw an error. - if not autosplit.reset_input.text() and not autosplit.is_auto_controlled: + if not autosplit.settings_dict["reset_hotkey"] and not autosplit.is_auto_controlled: autosplit.gui_changes_on_reset() error_messages.reset_hotkey() return False From 58389317425a740a8493c2a2a0f1986447be477a Mon Sep 17 00:00:00 2001 From: Avasam Date: Thu, 16 Dec 2021 00:25:03 -0500 Subject: [PATCH 008/137] Better "seconds remaining" text --- res/settings.ui | 5 +-- src/AutoSplit.py | 20 +++++---- src/hotkeys.py | 18 ++++---- typings/keyboard/__init__.pyi | 62 ++++++++++++++++----------- typings/keyboard/_canonical_names.pyi | 11 +++++ 5 files changed, 69 insertions(+), 47 deletions(-) create mode 100644 typings/keyboard/_canonical_names.pyi diff --git a/res/settings.ui b/res/settings.ui index a388d7d6..ee4dfd38 100644 --- a/res/settings.ui +++ b/res/settings.ui @@ -427,7 +427,7 @@ - false + true @@ -477,9 +477,6 @@ - - true - true diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 6fd87522..ac5c8830 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -293,9 +293,9 @@ def __start_image_function(self): or not self.start_image \ or time() < self.check_start_image_timestamp \ or (not self.settings_dict["split_hotkey"] and not self.is_auto_controlled): - pause_time_left = f"{self.check_start_image_timestamp - time():.1f}" + pause_time_left = self.check_start_image_timestamp - time() self.current_split_image.setText( - f"None\n (Paused before loading Start Image).\n {pause_time_left} sec remaining") + f"None\n (Paused before loading Start Image).\n {seconds_remaining_text(pause_time_left)}") return if self.check_start_image_timestamp > 0: @@ -340,9 +340,9 @@ def __start_image_function(self): delay_start_time = time() start_delay = self.start_image.delay / 1000 while time() - delay_start_time < start_delay: - delay_time_left = round(start_delay - (time() - delay_start_time), 1) + delay_time_left = start_delay - (time() - delay_start_time) self.current_split_image.setText( - f"Delayed Before Starting:\n {delay_time_left} sec remaining") + f"Delayed Before Starting:\n {seconds_remaining_text(delay_time_left)}") # Email sent to pyqt@riverbankcomputing.com QtTest.QTest.qWait(1) # type: ignore @@ -629,8 +629,8 @@ def __auto_splitter(self): # check for reset while delayed and display a counter of the remaining split delay time delay_start_time = time() while time() - delay_start_time < split_delay: - delay_time_left = round(split_delay - (time() - delay_start_time), 1) - self.current_split_image.setText(f"Delayed Split: {delay_time_left} sec remaining") + delay_time_left = split_delay - (time() - delay_start_time) + self.current_split_image.setText(f"Delayed Split: {seconds_remaining_text(delay_time_left)}") if self.__check_for_reset(): return @@ -677,8 +677,8 @@ def __auto_splitter(self): if pause_time > 0: pause_start_time = time() while time() - pause_start_time < pause_time: - pause_time_left = round(pause_time - (time() - pause_start_time), 1) - self.current_split_image.setText(f"None (Paused). {pause_time_left} sec remaining") + pause_time_left = pause_time - (time() - pause_start_time) + self.current_split_image.setText(f"None (Paused). {seconds_remaining_text(pause_time_left)}") if self.__check_for_reset(): return @@ -862,6 +862,10 @@ def exit_program(): exit_program() +def seconds_remaining_text(seconds: float): + return f"{seconds:.1f} second{'' if 0 < seconds <= 1 else 's'} remaining" + + def main(): # Call to QApplication outside the try-except so we can show error messages app = QApplication(sys.argv) diff --git a/src/hotkeys.py b/src/hotkeys.py index 3a6901e2..9fcdf23c 100644 --- a/src/hotkeys.py +++ b/src/hotkeys.py @@ -6,10 +6,10 @@ from AutoSplit import AutoSplit import threading -from keyboard._keyboard_event import KeyboardEvent, KEY_DOWN + import keyboard # https://github.com/boppreh/keyboard/issues/505 import pyautogui # https://github.com/asweigart/pyautogui/issues/645 -# While not usually recommended, we don'thread manipulate the mouse, and we don'thread want the extra delay +# While not usually recommended, we don't manipulate the mouse, and we don't want the extra delay pyautogui.FAILSAFE = False SET_HOTKEY_TEXT = "Set Hotkey" @@ -100,11 +100,11 @@ def _send_hotkey(key_or_scan_code: Union[int, str]): pyautogui.hotkey(key_or_scan_code.replace(" ", "")) -def __validate_keypad(expected_key: str, keyboard_event: KeyboardEvent) -> bool: +def __validate_keypad(expected_key: str, keyboard_event: keyboard.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}: - # TODO: "del" won'thread work with "(keypad)delete" if localized in non-english (ie: "suppr" in french) + # 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" if keyboard_event.name and is_digit(keyboard_event.name[-1]): @@ -125,16 +125,16 @@ def __validate_keypad(expected_key: str, keyboard_event: KeyboardEvent) -> bool: # 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'thread. +# while the keypad ones aren't. -# Since we reuse the key string we set to send to LiveSplit, we can'thread use fake names like "num home". +# 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]): - if keyboard_event.event_type == KEY_DOWN and __validate_keypad(key_name, keyboard_event): +def _hotkey_action(keyboard_event: keyboard.KeyboardEvent, key_name: str, action: Callable[[], None]): + if keyboard_event.event_type == keyboard.KEY_DOWN and __validate_keypad(key_name, keyboard_event): action() -def __get_key_name(keyboard_event: KeyboardEvent): +def __get_key_name(keyboard_event: keyboard.KeyboardEvent): return f"num {keyboard_event.name}" \ if keyboard_event.is_keypad and is_digit(keyboard_event.name) \ else str(keyboard_event.name) diff --git a/typings/keyboard/__init__.pyi b/typings/keyboard/__init__.pyi index 18f68af6..86bd06ec 100644 --- a/typings/keyboard/__init__.pyi +++ b/typings/keyboard/__init__.pyi @@ -3,6 +3,7 @@ This type stub file was generated by pyright. """ from __future__ import print_function as _print_function import typing +import collections.abc import re as _re import itertools as _itertools @@ -13,6 +14,7 @@ from threading import Lock as _Lock, Thread as _Thread from ._keyboard_event import KEY_DOWN, KEY_UP, KeyboardEvent from ._generic import GenericListener as _GenericListener from ._canonical_names import all_modifiers, normalize_name, sided_modifiers +__all__ = ["all_modifiers", "normalize_name", "sided_modifiers", "KEY_DOWN", "KEY_UP", "KeyboardEvent"] try: # Python2 @@ -103,12 +105,12 @@ key events. In this case `keyboard` will be unable to report events. - This program makes no attempt to hide itself, so don't use it for keyloggers or online gaming bots. Be responsible. """ -Callback = typing.Callable[[KeyboardEvent], None] +Callback = collections.abc.Callable[[KeyboardEvent], None] version: str -_is_str = typing.Callable[[typing.Any], bool] -_is_number = typing.Callable[[typing.Any], bool] -_is_list: typing.Callable[[typing.Any], bool] +_is_str = collections.abc.Callable[[typing.Any], bool] +_is_number = collections.abc.Callable[[typing.Any], bool] +_is_list: collections.abc.Callable[[typing.Any], bool] class _State: @@ -120,10 +122,6 @@ class _Event(_UninterruptibleEvent): ... -if _platform.system() == 'Windows': - ... -else: - ... _modifier_scan_codes: set @@ -197,14 +195,16 @@ class _KeyboardListener(_GenericListener): _listener: _KeyboardListener -def key_to_scan_codes(key: typing.Union[int, str, typing.List[typing.Union[int, str]]], error_if_missing: bool = ...) -> typing.List[int]: +def key_to_scan_codes(key: typing.Union[int, str, typing.List[typing.Union[int, str]]], + error_if_missing: bool = ...) -> typing.List[int]: """ Returns a list of scan codes associated with this key (name or scan code). """ ... -def parse_hotkey(hotkey) -> tuple[tuple[tuple[Unknown] | Unknown | tuple[()] | tuple[Unknown, ...]]] | tuple[tuple[tuple[Unknown] | Unknown | tuple[()] | tuple[Unknown, ...], ...]] | tuple[Unknown, ...]: +def parse_hotkey(hotkey) -> tuple[tuple[tuple[Unknown] | Unknown | tuple[()] | tuple[Unknown, ...]] + ] | tuple[tuple[tuple[Unknown] | Unknown | tuple[()] | tuple[Unknown, ...], ...]] | tuple[Unknown, ...]: """ Parses a user-provided hotkey into nested tuples representing the parsed structure, with the bottom values being lists of scan codes. @@ -274,10 +274,10 @@ def call_later(fn, args=..., delay=...) -> None: ... -_hooks: dict[typing.Callable, Unknown] +_hooks: dict[collections.abc.Callable, Unknown] -def hook(callback: Callback, suppress=..., on_remove=...) -> typing.Callable[[], None]: +def hook(callback: Callback, suppress=..., on_remove=...) -> collections.abc.Callable[[], None]: """ Installs a global listener on all available keyboards, invoking `callback` each time a key is pressed or released. @@ -296,21 +296,22 @@ def hook(callback: Callback, suppress=..., on_remove=...) -> typing.Callable[[], ... -def on_press(callback: Callback, suppress=...) -> typing.Callable[[], None]: +def on_press(callback: Callback, suppress=...) -> collections.abc.Callable[[], None]: """ Invokes `callback` for every KEY_DOWN event. For details see `hook`. """ ... -def on_release(callback: Callback, suppress=...) -> typing.Callable[[], None]: +def on_release(callback: Callback, suppress=...) -> collections.abc.Callable[[], None]: """ Invokes `callback` for every KEY_UP event. For details see `hook`. """ ... -def hook_key(key: typing.Union[int, str, typing.List[typing.Union[int, str]]], callback: Callback, suppress: bool = ...) -> typing.Callable[[], None]: +def hook_key(key: typing.Union[int, str, typing.List[typing.Union[int, str]]], + callback: Callback, suppress: bool = ...) -> collections.abc.Callable[[], None]: """ Hooks key up and key down events for a single key. Returns the event handler created. To remove a hooked key use `unhook_key(key)` or @@ -322,21 +323,21 @@ def hook_key(key: typing.Union[int, str, typing.List[typing.Union[int, str]]], c ... -def on_press_key(key, callback: Callback, suppress=...) -> typing.Callable[[], None]: +def on_press_key(key, callback: Callback, suppress=...) -> collections.abc.Callable[[], None]: """ Invokes `callback` for KEY_DOWN event related to the given key. For details see `hook`. """ ... -def on_release_key(key, callback: Callback, suppress=...) -> typing.Callable[[], None]: +def on_release_key(key, callback: Callback, suppress=...) -> collections.abc.Callable[[], None]: """ Invokes `callback` for KEY_UP event related to the given key. For details see `hook`. """ ... -def unhook(remove: typing.Callable[[], None]) -> None: +def unhook(remove: collections.abc.Callable[[], None]) -> None: """ Removes a previously added hook, either by callback or by the return value of `hook`. @@ -355,7 +356,7 @@ def unhook_all() -> None: ... -def block_key(key) -> typing.Callable[[], None]: +def block_key(key) -> collections.abc.Callable[[], None]: """ Suppresses all key events of the given key, regardless of modifiers. """ @@ -365,7 +366,7 @@ def block_key(key) -> typing.Callable[[], None]: unblock_key = unhook_key -def remap_key(src, dst) -> typing.Callable[[], None]: +def remap_key(src, dst) -> collections.abc.Callable[[], None]: """ Whenever the key `src` is pressed or released, regardless of modifiers, press or release the hotkey `dst` instead. @@ -388,7 +389,8 @@ def parse_hotkey_combinations(hotkey) -> tuple[tuple[tuple[Unknown, ...], ...], _hotkeys: dict -def add_hotkey(hotkey, callback: Callback, args=..., suppress=..., timeout=..., trigger_on_release=...) -> typing.Callable[[], None]: +def add_hotkey(hotkey, callback: collections.abc.Callable, args=..., suppress=..., timeout=..., + trigger_on_release=...) -> collections.abc.Callable[[], None]: """ Invokes a callback every time a hotkey is pressed. The hotkey must be in the format `ctrl+shift+a, s`. This would trigger when the user holds @@ -453,7 +455,7 @@ def unhook_all_hotkeys() -> None: unregister_all_hotkeys = remove_all_hotkeys = clear_all_hotkeys = unhook_all_hotkeys -def remap_hotkey(src, dst, suppress=..., trigger_on_release=...) -> typing.Callable[[], None]: +def remap_hotkey(src, dst, suppress=..., trigger_on_release=...) -> collections.abc.Callable[[], None]: """ Whenever the hotkey `src` is pressed, suppress it and send `dst` instead. @@ -589,10 +591,11 @@ def get_typed_strings(events, allow_backspace=...): ... -_recording: typing.Optional[tuple[Unknown | _queue.Queue[Unknown], typing.Callable[[], None]]] +_recording: typing.Optional[tuple[Unknown | _queue.Queue[Unknown], collections.abc.Callable[[], None]]] -def start_recording(recorded_events_queue=...) -> tuple[Unknown | _queue.Queue[Unknown], typing.Callable[[], None]]: +def start_recording(recorded_events_queue=...) -> tuple[Unknown + | _queue.Queue[Unknown], collections.abc.Callable[[], None]]: """ Starts recording all keyboard events into a global variable, or the given queue if any. Returns the queue of events and the hooked function. @@ -639,7 +642,13 @@ replay = play _word_listeners: dict -def add_word_listener(word, callback: Callback, triggers=..., match_suffix=..., timeout=...) -> typing.Callable[[], None]: +def add_word_listener( + word, + callback: Callback, + triggers=..., + match_suffix=..., + timeout=...) -> collections.abc.Callable[[], + None]: """ Invokes a callback every time a sequence of characters is typed (e.g. 'pet') and followed by a trigger key (e.g. space). Modifiers (e.g. alt, ctrl, @@ -676,7 +685,8 @@ def remove_word_listener(word_or_handler) -> None: ... -def add_abbreviation(source_text, replacement_text, match_suffix=..., timeout=...) -> typing.Callable[[], None]: +def add_abbreviation(source_text, replacement_text, match_suffix=..., + timeout=...) -> collections.abc.Callable[[], None]: """ Registers a hotkey that replaces one typed text with another. For example diff --git a/typings/keyboard/_canonical_names.pyi b/typings/keyboard/_canonical_names.pyi new file mode 100644 index 00000000..94cb7a64 --- /dev/null +++ b/typings/keyboard/_canonical_names.pyi @@ -0,0 +1,11 @@ +""" +This type stub file was generated by pyright. +""" + +canonical_names = ... +sided_modifiers = ... +all_modifiers = ... + + +def normalize_name(name: str) -> str: + ... From 21947d09708dad9d9f8ccf796e73f84d49d6959b Mon Sep 17 00:00:00 2001 From: Avasam Date: Wed, 22 Dec 2021 12:33:36 -0500 Subject: [PATCH 009/137] Undo split goes to the end of the group --- README.md | 4 ++-- src/AutoControlledWorker.py | 2 ++ src/AutoSplit.py | 8 +++----- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4084e5e5..4c9e24c4 100644 --- a/README.md +++ b/README.md @@ -155,9 +155,9 @@ Given these splits: 1 dummy, 2 normal, 3 dummy, 4 dummy, 5 normal, 6 normal. In this situation you would have only 3 splits in LiveSplit/wsplit (even though there are 6 split images, only 3 are "real" splits). This basically results in 3 groups of splits: 1st split is images 1 and 2. 2nd split is images 3, 4 and 5. 3rd split is image 6. - If you are in the 1st or 2nd image and press the skip key, it will end up on the 3rd image -- If you are in the 3rd, 4th or 5th image and press the undo key, it will end up on the 1st image +- If you are in the 3rd, 4th or 5th image and press the undo key, it will end up on the 2nd image - If you are in the 3rd, 4th or 5th image and press the skip key, it will end up on the 6th image -- If you are in the 6th image and press the undo key, it will end up on the 3rd image +- If you are in the 6th image and press the undo key, it will end up on the 5th image ### Loop Split Images diff --git a/src/AutoControlledWorker.py b/src/AutoControlledWorker.py index 0c252d44..36b231d9 100644 --- a/src/AutoControlledWorker.py +++ b/src/AutoControlledWorker.py @@ -20,6 +20,8 @@ def run(self): except RuntimeError: self.autosplit.show_error_signal.emit(error_messages.stdin_lost) break + except EOFError: + continue # TODO: "AutoSplit Integration" needs to call this and wait instead of outright killing the app. # For now this can only used in a Development environment if line == "kill": diff --git a/src/AutoSplit.py b/src/AutoSplit.py index ac5c8830..91d8b88f 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -54,7 +54,7 @@ def excepthook(exception_type: type[BaseException], exception: BaseException, _t sys.exit(0) autosplit.show_error_signal.emit(lambda: error_messages.exception_traceback( "AutoSplit encountered an unhandled exception and will try to recover, " - + f"however, there is no guarantee everything will work properly. {CREATE_NEW_ISSUE_MESSAGE}", + + f"however, there is no guarantee it will keep working properly. {CREATE_NEW_ISSUE_MESSAGE}", exception)) return excepthook @@ -411,9 +411,7 @@ def __check_fps(self): while count < CHECK_FPS_ITERATIONS: capture = self.__get_capture_for_comparison() _ = image.compare_with_capture(self, capture) - set_ui_image(self.current_split_image, image.bytes, True) count += 1 - self.current_split_image.clear() # calculate FPS t1 = time() @@ -437,9 +435,9 @@ def __undo_split(self, navigate_image_only: bool = False): return if not navigate_image_only: - for i, group in enumerate(self.split_groups): + for i, group in enumerate(self.split_groups,): if i > 0 and self.split_image_number in group: - self.split_image_number = self.split_groups[i - 1][0] + self.split_image_number = self.split_groups[i - 1][-1] break else: self.split_image_number -= 1 From b8c1bbeb828764cf68b5b812d6d2f0e723a85586 Mon Sep 17 00:00:00 2001 From: Avasam Date: Wed, 29 Dec 2021 18:17:15 -0500 Subject: [PATCH 010/137] Turn off pyright(reportFunctionMemberAccess) in favor of pylint(no-member) --- pyproject.toml | 4 ++-- typings/cv2-stubs/__init__.pyi | 2 +- typings/pyautogui/__init__.pyi | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index e73119bc..dc3fbe1a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -29,8 +29,8 @@ ignore = [ reportMissingTypeStubs = "information" # False positives with TYPE_CHECKING reportImportCycles = "information" -# PyQt .connect -reportFunctionMemberAccess = "information" +# False positives with PyQt .connect. pylint(no-member) works instead +reportFunctionMemberAccess = "none" # Extra runtime safety reportUnnecessaryComparison = "warning" # Flake8 does a better job diff --git a/typings/cv2-stubs/__init__.pyi b/typings/cv2-stubs/__init__.pyi index 7a9cd1cf..ce47a96c 100644 --- a/typings/cv2-stubs/__init__.pyi +++ b/typings/cv2-stubs/__init__.pyi @@ -36,7 +36,7 @@ def AKAZE_create( nOctaves=..., nOctaveLayers=..., diffusivity=... - ) -> typing.Any: +) -> typing.Any: 'AKAZE_create([, descriptor_type[, descriptor_size[, descriptor_channels[, threshold[, nOctaves[, nOctaveLayers[, diffusivity]]]]]]]) -> retval\n. @brief The AKAZE constructor\n. \n. @param descriptor_type Type of the extracted descriptor: DESCRIPTOR_KAZE,\n. DESCRIPTOR_KAZE_UPRIGHT, DESCRIPTOR_MLDB or DESCRIPTOR_MLDB_UPRIGHT.\n. @param descriptor_size Size of the descriptor in bits. 0 -\\> Full size\n. @param descriptor_channels Number of channels in the descriptor (1, 2, 3)\n. @param threshold Detector response threshold to accept point\n. @param nOctaves Maximum octave evolution of the image\n. @param nOctaveLayers Default number of sublevels per scale level\n. @param diffusivity Diffusivity type. DIFF_PM_G1, DIFF_PM_G2, DIFF_WEICKERT or\n. DIFF_CHARBONNIER' ... diff --git a/typings/pyautogui/__init__.pyi b/typings/pyautogui/__init__.pyi index aad11582..a4252aad 100644 --- a/typings/pyautogui/__init__.pyi +++ b/typings/pyautogui/__init__.pyi @@ -23,7 +23,7 @@ class ImageNotFoundException(PyAutoGUIException): ... -if sys.version_info[0] == 2 or sys.version_info[0:2] in ((3, 1), (3, 2)): +if sys.version_info[0] == 2 or sys.version_info[0:2] in ((3, 1), (3, 2)): # noqa: Y003,Y006 # Python 2 and 3.1 and 3.2 uses collections.Sequence import collections From 83039c60997fc80db703e507522b5d7819534139 Mon Sep 17 00:00:00 2001 From: Avasam Date: Wed, 29 Dec 2021 18:57:22 -0500 Subject: [PATCH 011/137] Fixed images comparison method defaulting to 0 rather than none --- src/split_parser.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/split_parser.py b/src/split_parser.py index 73247626..ee96f1e9 100644 --- a/src/split_parser.py +++ b/src/split_parser.py @@ -110,7 +110,7 @@ def comparison_method_from_filename(filename: str): # Check to make sure there is a valid delay time between brackets # of the filename - value = __value_from_filename(filename, "<>", 0) + value = __value_from_filename(filename, "<>", -1) # Comparison method should always be positive or zero return value if value >= 0 else None From 7e5004de9372583b62571369bb3d8b0659712527 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sun, 2 Jan 2022 23:49:05 -0500 Subject: [PATCH 012/137] Fixed start image comparison not starting when loading settings from LiveSplit --- src/AutoSplit.py | 20 ++++++++++++++------ src/hotkeys.py | 4 +--- src/settings_file.py | 2 +- 3 files changed, 16 insertions(+), 10 deletions(-) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 09c99697..e48b229b 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -74,6 +74,7 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): pause_signal = QtCore.pyqtSignal() after_setting_hotkey_signal = QtCore.pyqtSignal() update_checker_widget_signal = QtCore.pyqtSignal(str, bool) + load_start_image_signal = QtCore.pyqtSignal([], [bool], [bool, bool]) # Use this signal when trying to show an error from outside the main thread show_error_signal = QtCore.pyqtSignal(FunctionType) @@ -156,6 +157,7 @@ def __init__(self, parent: Optional[QWidget] = None): self.start_auto_splitter_button.setEnabled(False) # Send version and process ID to stdout + # THIS HAS TO BE THE FIRST TWO LINES SENT print(f"{VERSION}\n{os.getpid()}", flush=True) # Use and Start the thread that checks for updates from LiveSplit @@ -181,7 +183,7 @@ def __init__(self, parent: Optional[QWidget] = None): self.previous_image_button.clicked.connect(lambda: self.__undo_split(True)) self.align_region_button.clicked.connect(lambda: align_region(self)) self.select_window_button.clicked.connect(lambda: select_window(self)) - self.reload_start_image_button.clicked.connect(lambda: self.load_start_image(True, True)) + self.reload_start_image_button.clicked.connect(lambda: self.__load_start_image(True, True)) self.action_check_for_updates_on_open.changed.connect(lambda: settings.set_check_for_updates_on_open( self, self.action_check_for_updates_on_open.isChecked()) @@ -198,14 +200,17 @@ def __init__(self, parent: Optional[QWidget] = None): self.start_auto_splitter_signal.connect(self.__auto_splitter) self.update_checker_widget_signal.connect(lambda latest_version, check_on_open: open_update_checker(self, latest_version, check_on_open)) + self.load_start_image_signal.connect(self.__load_start_image) + self.load_start_image_signal[bool].connect(self.__load_start_image) + self.load_start_image_signal[bool, bool].connect(self.__load_start_image) self.reset_signal.connect(self.reset) self.skip_split_signal.connect(self.__skip_split) self.undo_split_signal.connect(self.__undo_split) self.pause_signal.connect(self.pause) # live image checkbox - self.timer_live_image.start(int(1000 / 60)) self.timer_live_image.timeout.connect(self.__live_image_function) + self.timer_live_image.start(int(1000 / 60)) # Automatic timer start self.timer_start_image.timeout.connect(self.__start_image_function) @@ -221,7 +226,6 @@ def __init__(self, parent: Optional[QWidget] = None): # FUNCTIONS - # 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( @@ -234,7 +238,7 @@ def __browse(self): # set the split image folder line to the directory text self.settings_dict["split_image_directory"] = new_split_image_directory self.split_image_folder_input.setText(f"{new_split_image_directory}/") - self.load_start_image() + self.load_start_image_signal.emit() def __live_image_function(self): self.capture_region_window_label.setText(self.settings_dict["captured_window_title"]) @@ -248,7 +252,11 @@ def __live_image_function(self): self.settings_dict["force_print_window"]) set_ui_image(self.live_image, capture, False) - def load_start_image(self, started_by_button: bool = False, wait_for_delay: bool = True): + def __load_start_image(self, started_by_button: bool = False, wait_for_delay: bool = True): + print(started_by_button, wait_for_delay) + """ + Not thread safe (if triggered by LiveSplit for example). Use `load_start_image_signal.emit` instead. + """ self.timer_start_image.stop() self.current_image_file_label.setText("-") self.start_image_status_value_label.setText("not found") @@ -746,7 +754,7 @@ def gui_changes_on_reset(self): self.skip_split_button.setEnabled(False) QApplication.processEvents() - self.load_start_image(False, False) + self.load_start_image_signal[bool, bool].emit(False, False) def __get_capture_for_comparison(self): """ diff --git a/src/hotkeys.py b/src/hotkeys.py index 555f1b22..9d7c5731 100644 --- a/src/hotkeys.py +++ b/src/hotkeys.py @@ -182,7 +182,6 @@ def __read_hotkey(): if keyboard_event.event_type == keyboard.KEY_UP: break key_name = __get_key_name(keyboard_event) - print(key_name) # Ignore long presses if names and names[-1] == key_name: continue @@ -244,5 +243,4 @@ def callback(): # Try to remove the previously set hotkey if there is one. _unhook(getattr(autosplit, f"{hotkey}_hotkey")) - thread = threading.Thread(target=callback) - thread.start() + threading.Thread(target=callback).start() diff --git a/src/settings_file.py b/src/settings_file.py index dc4338b9..de00ca7a 100644 --- a/src/settings_file.py +++ b/src/settings_file.py @@ -191,7 +191,7 @@ def load_settings( return autosplit.last_successfully_loaded_settings_file_path = load_settings_file_path - autosplit.load_start_image() + autosplit.load_start_image_signal.emit() def load_settings_on_open(autosplit: AutoSplit): From c7af588585dc75b9701724d9168278f96ddaae0a Mon Sep 17 00:00:00 2001 From: Avasam Date: Wed, 26 Jan 2022 14:20:52 -0500 Subject: [PATCH 013/137] Fixed threshold_from_filename to support 0.0 and 1.0 Updated a few inaccurate docs --- .github/workflows/lint-and-build.yml | 1 - .vscode/extensions.json | 2 -- .vscode/settings.json | 3 +++ pyproject.toml | 2 +- src/AutoSplitImage.py | 2 +- src/split_parser.py | 18 +++++++++--------- 6 files changed, 14 insertions(+), 14 deletions(-) diff --git a/.github/workflows/lint-and-build.yml b/.github/workflows/lint-and-build.yml index 1b13d5da..28eaf124 100644 --- a/.github/workflows/lint-and-build.yml +++ b/.github/workflows/lint-and-build.yml @@ -5,7 +5,6 @@ on: branches: - main - master - - 2.0.0 paths: - '**.py' - '**.pyi' diff --git a/.vscode/extensions.json b/.vscode/extensions.json index 49ec5de6..67a73c4c 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -21,7 +21,5 @@ "ms-vscode.vscode-typescript-tslint-plugin", // Obsoleted by Pylance "ms-pyright.pyright", - // The ESLint plugin is sufficient in JS-only projects - "sonarsource.sonarlint-vscode", ] } diff --git a/.vscode/settings.json b/.vscode/settings.json index 6252fc0e..efda99a1 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -22,6 +22,9 @@ "markdown" ], "files.associations": { + "*.json": "json", + "extensions.json": "jsonc", + "settings.json": "jsonc", "*.qrc": "xml", "*.ui": "xml" }, diff --git a/pyproject.toml b/pyproject.toml index dc3fbe1a..fcd43d26 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -41,7 +41,7 @@ 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 +# Just like default but any error will make drop to 9 or less. warning and conventions are worth more evaluation = "10.0 - error - ((float((warning + convention) * 10 + refactor ) / statement) * 10)" [tool.pylint.MASTER] fail-under = 9.0 diff --git a/src/AutoSplitImage.py b/src/AutoSplitImage.py index ec9c2b69..d441e2f1 100644 --- a/src/AutoSplitImage.py +++ b/src/AutoSplitImage.py @@ -70,7 +70,7 @@ def get_pause_time(self, default: Union[AutoSplit, float]): def get_similarity_threshold(self, default: Union[AutoSplit, float]): """ - Get image's similarity threashold or fallback to the default value from spinbox + Get image's similarity threshold or fallback to the default value from spinbox """ default_value = default \ if isinstance(default, float) \ diff --git a/src/split_parser.py b/src/split_parser.py index ee96f1e9..afe44fcf 100644 --- a/src/split_parser.py +++ b/src/split_parser.py @@ -34,7 +34,7 @@ def __value_from_filename( def threshold_from_filename(filename: str): """ Retrieve the threshold from the filename, if there is no threshold or the threshold - doesn't meet the requirements of being between 0.0 and 1.0, then None is returned. + doesn't meet the requirements of being [0, 1], then None is returned. @param filename: String containing the file's name @return: A valid threshold, if not then None @@ -45,13 +45,13 @@ def threshold_from_filename(filename: str): value = __value_from_filename(filename, "()", -1.0) # Check to make sure if it is a valid threshold - return value if 0.0 < value < 1.0 else None + return value if 0.0 <= value <= 1.0 else None def pause_from_filename(filename: str): """ Retrieve the pause time from the filename, if there is no pause time or the pause time - isn't a valid number, then None is returned + isn't a valid positive number or 0, then None is returned. @param filename: String containing the file's name @return: A valid pause time, if not then None @@ -68,15 +68,15 @@ def pause_from_filename(filename: str): def delay_time_from_filename(filename: str): """ Retrieve the delay time from the filename, if there is no delay time or the delay time - isn't a valid number, then 0 is returned + isn't a valid positive number or 0 number, then None is returned. @param filename: String containing the file's name - @return: A valid delay time, if not then 0 + @return: A valid delay time, if not then none """ # Check to make sure there is a valid delay time between brackets # of the filename - value = __value_from_filename(filename, "##", 0) + value = __value_from_filename(filename, "##", -1) # Delay times should always be positive or zero return value if value >= 0 else None @@ -101,11 +101,11 @@ def loop_from_filename(filename: str): def comparison_method_from_filename(filename: str): """ - Retrieve the number of loops from filename, if there is no loop number or the loop number isn't valid, - then 1 is returned. + Retrieve the comparison method index from filename, if there is no comparison method or the index isn't valid, + then None is returned. @param filename: String containing the file's name - @return: A valid loop number, if not then 1 + @return: A valid comparison method index, if not then none """ # Check to make sure there is a valid delay time between brackets From 660276df7ae326e9f7016bab86ca7a37f9aa588a Mon Sep 17 00:00:00 2001 From: Avasam Date: Thu, 27 Jan 2022 01:03:15 -0500 Subject: [PATCH 014/137] Reset similarity labels --- src/AutoSplit.py | 34 +++++++++++++++++++++++----------- 1 file changed, 23 insertions(+), 11 deletions(-) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index e48b229b..c2a3b198 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -112,6 +112,7 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): # Automatic timer start highest_similarity = 0.0 + reset_highest_similarity = 0.0 check_start_image_timestamp = 0.0 # Define all other attributes @@ -253,7 +254,6 @@ def __live_image_function(self): set_ui_image(self.live_image, capture, False) def __load_start_image(self, started_by_button: bool = False, wait_for_delay: bool = True): - print(started_by_button, wait_for_delay) """ Not thread safe (if triggered by LiveSplit for example). Use `load_start_image_signal.emit` instead. """ @@ -291,6 +291,7 @@ def __load_start_image(self, started_by_button: bool = False, wait_for_delay: bo self.__update_split_image(self.start_image) self.highest_similarity = 0.0 + self.reset_highest_similarity = 0.0 self.start_image_split_below_threshold = False self.timer_start_image.start(int(1000 / self.settings_dict["fps_limit"])) @@ -317,14 +318,14 @@ def __start_image_function(self): self.table_current_image_threshold_label.setText(f"{start_image_threshold:.2f}") # Show live similarity if the checkbox is checked - self.table_current_image_live_label.setText(str(start_image_similarity)[:4]) + self.table_current_image_live_label.setText(f"{start_image_similarity:.2f}") # If the similarity becomes higher than highest similarity, set it as such. if start_image_similarity > self.highest_similarity: self.highest_similarity = start_image_similarity # Show live highest similarity if the checkbox is checked - self.table_current_image_highest_label.setText(str(self.highest_similarity)[:4]) + self.table_current_image_highest_label.setText(f"{self.highest_similarity:.2f}") # 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 @@ -576,17 +577,17 @@ def __auto_splitter(self): return # calculate similarity for split image - self.similarity = self.split_image.compare_with_capture(self, capture) + similarity = self.split_image.compare_with_capture(self, capture) # show live similarity if the checkbox is checked - self.table_current_image_live_label.setText(str(self.similarity)[:4]) + self.table_current_image_live_label.setText(f"{similarity:.2f}") # if the similarity becomes higher than highest similarity, set it as such. - if self.similarity > self.highest_similarity: - self.highest_similarity = self.similarity + if similarity > self.highest_similarity: + self.highest_similarity = similarity # show live highest similarity if the checkbox is checked - self.table_current_image_highest_label.setText(str(self.highest_similarity)[:4]) + self.table_current_image_highest_label.setText(f"{self.highest_similarity:.2f}") # If its the last split image and last loop number, disable the next image button # If its the first split image, disable the undo split and previous image buttons @@ -601,7 +602,7 @@ def __auto_splitter(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.similarity >= self.split_image.get_similarity_threshold(self): + if similarity >= self.split_image.get_similarity_threshold(self): if not self.split_image.check_flag(BELOW_FLAG): break if not self.split_below_threshold: @@ -736,6 +737,9 @@ def gui_changes_on_reset(self): self.table_current_image_live_label.setText("-") self.table_current_image_highest_label.setText("-") self.table_current_image_threshold_label.setText("-") + self.table_reset_image_live_label.setText("-") + self.table_reset_image_highest_label.setText("-") + self.table_reset_image_threshold_label.setText("-") self.browse_button.setEnabled(True) self.reload_start_image_button.setEnabled(True) self.previous_image_button.setEnabled(False) @@ -785,10 +789,18 @@ def __reset_if_should(self, capture: Optional[cv2.ndarray]): if not self.reset_image: return False - reset_similarity = self.reset_image.compare_with_capture(self, capture) - should_reset = reset_similarity >= self.reset_image.get_similarity_threshold(self) \ + similarity = self.reset_image.compare_with_capture(self, capture) + threshold = self.reset_image.get_similarity_threshold(self) + should_reset = similarity >= threshold \ and time() - self.run_start_time > self.reset_image.get_pause_time(self) + if similarity > self.reset_highest_similarity: + self.reset_highest_similarity = similarity + + self.table_reset_image_live_label.setText(f"{similarity:.2f}") + self.table_reset_image_highest_label.setText(f"{self.reset_highest_similarity:.2f}") + self.table_reset_image_threshold_label.setText(f"{threshold:.2f}") + if should_reset: send_command(self, "reset") self.reset() From a7b07f79b54101dbc86d68f6d4687419f185c77d Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 12 Mar 2022 12:40:10 -0500 Subject: [PATCH 015/137] Visually update threshold labels when changed from settings --- .vscode/settings.json | 5 +++++ scripts/designer.bat | 1 - scripts/requirements.txt | 1 + src/menu_bar.py | 34 ++++++++++++++++++++++------------ 4 files changed, 28 insertions(+), 13 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index efda99a1..e205e2ea 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -60,7 +60,12 @@ "python.linting.pylintCategorySeverity.convention": "Warning", "python.linting.pylintCategorySeverity.refactor": "Warning", "python.linting.flake8Enabled": true, + // Errors "python.linting.flake8CategorySeverity.E": "Warning", + // Pyflakes + "python.linting.flake8CategorySeverity.F": "Warning", + // PEP8 Naming convention + "python.linting.flake8CategorySeverity.N": "Warning", // PyRight obsoletes mypy "python.linting.mypyEnabled": false, // Is already wrapped by Flake8, prospector and pylama diff --git a/scripts/designer.bat b/scripts/designer.bat index d3b61064..8e11aafd 100644 --- a/scripts/designer.bat +++ b/scripts/designer.bat @@ -16,4 +16,3 @@ START "Qt Designer" "%PYTHONPATH:~0,-11%\Lib\site-packages\qt6_applications\Qt\b "%~d0%~p0..\res\about.ui"^ "%~d0%~p0..\res\settings.ui"^ "%~d0%~p0..\res\update_checker.ui" - diff --git a/scripts/requirements.txt b/scripts/requirements.txt index a9347425..953062af 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -22,6 +22,7 @@ PySide6 pyautogui pywin32 requests +certifi # Linting and Types bandit flake8 diff --git a/src/menu_bar.py b/src/menu_bar.py index 9bd98c5a..1956ee36 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -98,14 +98,25 @@ def check_for_updates(autosplit: AutoSplit, check_on_open: bool = False): class __SettingsWidget(QtWidgets.QDialog, settings_ui.Ui_DialogSettings): + def __update_default_threshold(self, value: Any): + self.__set_value("default_similarity_threshold", value) + self.autosplit.table_current_image_threshold_label.setText( + f"{self.autosplit.split_image.get_similarity_threshold(self.autosplit):.2f}" + if self.autosplit.split_image + else "-") + self.autosplit.table_reset_image_threshold_label.setText( + f"{self.autosplit.reset_image.get_similarity_threshold(self.autosplit):.2f}" + if self.autosplit.reset_image + else "-") + + def __set_value(self, key: str, value: Any): + self.autosplit.settings_dict[key] = value + def __init__(self, autosplit: AutoSplit): super().__init__() self.setupUi(self) self.autosplit = autosplit - def set_value(key: str, value: Any): - autosplit.settings_dict[key] = value - # region Set initial values # Hotkeys self.split_input.setText(autosplit.settings_dict["split_hotkey"]) @@ -135,30 +146,29 @@ def set_value(key: str, value: Any): self.set_pause_hotkey_button.clicked.connect(lambda: set_hotkey(self.autosplit, "pause")) # Capture Settings - self.fps_limit_spinbox.valueChanged.connect(lambda: set_value( + self.fps_limit_spinbox.valueChanged.connect(lambda: self.__set_value( "fps_limit", self.fps_limit_spinbox.value())) - self.live_capture_region_checkbox.stateChanged.connect(lambda: set_value( + self.live_capture_region_checkbox.stateChanged.connect(lambda: self.__set_value( "live_capture_region", self.live_capture_region_checkbox.isChecked())) - self.force_print_window_checkbox.stateChanged.connect(lambda: set_value( + self.force_print_window_checkbox.stateChanged.connect(lambda: self.__set_value( "force_print_window", self.force_print_window_checkbox.isChecked())) # Image Settings - self.default_comparison_method.currentIndexChanged.connect(lambda: set_value( + self.default_comparison_method.currentIndexChanged.connect(lambda: self.__set_value( "default_comparison_method", self.default_comparison_method.currentIndex())) - self.default_similarity_threshold_spinbox.valueChanged.connect(lambda: set_value( - "default_similarity_threshold", + self.default_similarity_threshold_spinbox.valueChanged.connect(lambda: self.__update_default_threshold( self.default_similarity_threshold_spinbox.value())) - self.default_delay_time_spinbox.valueChanged.connect(lambda: set_value( + self.default_delay_time_spinbox.valueChanged.connect(lambda: self.__set_value( "default_delay_time", self.default_delay_time_spinbox.value())) - self.default_pause_time_spinbox.valueChanged.connect(lambda: set_value( + self.default_pause_time_spinbox.valueChanged.connect(lambda: self.__set_value( "default_pause_time", self.default_pause_time_spinbox.value())) - self.loop_splits_checkbox.stateChanged.connect(lambda: set_value( + self.loop_splits_checkbox.stateChanged.connect(lambda: self.__set_value( "loop_splits", self.loop_splits_checkbox.isChecked())) # endregion From c8318385781a544648adf1a281c6b024d91bb6d2 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 12 Mar 2022 15:38:12 -0500 Subject: [PATCH 016/137] Keep pause timer running when undoing split Also untangled __auto_splitter function --- src/AutoSplit.py | 217 +++++++++++++++++++++++------------------------ 1 file changed, 105 insertions(+), 112 deletions(-) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index c2a3b198..430ea715 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -125,7 +125,7 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): split_images: list[AutoSplitImage] = [] split_image: AutoSplitImage - def __init__(self, parent: Optional[QWidget] = None): + def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-many-statements super().__init__(parent) # Setup global error handling @@ -501,7 +501,10 @@ def start_auto_splitter(self): self.start_auto_splitter_signal.emit() - def __check_for_reset(self): + def __check_for_reset_state_update_ui(self): + """ + Check if AutoSplit is started, if not either restart (loop splits) or update the GUI + """ if self.start_auto_splitter_button.text() == START_AUTO_SPLITTER_TEXT: if self.settings_dict["loop_splits"]: self.start_auto_splitter_signal.emit() @@ -561,67 +564,11 @@ def __auto_splitter(self): self.__update_split_image() - # second while loop: stays in this loop until similarity threshold is met - # skip loop if we just finished waiting for the split delay and need to press the split key! - start = time() - while True: - if self.__check_for_reset(): - return - - # calculate similarity for reset image - capture = self.__get_capture_for_comparison() - - _ = self.__reset_if_should(capture) - - if self.__check_for_reset(): - return - - # calculate similarity for split image - similarity = self.split_image.compare_with_capture(self, capture) - - # show live similarity if the checkbox is checked - self.table_current_image_live_label.setText(f"{similarity:.2f}") - - # if the similarity becomes higher than highest similarity, set it as such. - if similarity > self.highest_similarity: - self.highest_similarity = similarity - - # show live highest similarity if the checkbox is checked - self.table_current_image_highest_label.setText(f"{self.highest_similarity:.2f}") - - # If its the last split image and last loop number, disable the next image button - # If its the first split image, disable the undo split and previous image buttons - self.next_image_button.setEnabled(self.split_image_number != number_of_split_images - 1) - self.previous_image_button.setEnabled(self.split_image_number != 0) - if not self.is_auto_controlled: - # If its the last non-dummy split image and last loop number, disable the skip split button - self.skip_split_button.setEnabled(dummy_splits_array[self.split_image_number:].count(False) > 1) - self.undo_split_button.setEnabled(self.split_image_number != 0) - - # if the b flag is set, let similarity go above threshold first, - # 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 similarity >= self.split_image.get_similarity_threshold(self): - if not self.split_image.check_flag(BELOW_FLAG): - break - if not self.split_below_threshold: - self.split_below_threshold = True - continue - elif self.split_image.check_flag(BELOW_FLAG) and self.split_below_threshold: - self.split_below_threshold = False - break - - # limit the number of time the comparison runs to reduce cpu usage - frame_interval: float = 1 / self.settings_dict["fps_limit"] - # Email sent to pyqt@riverbankcomputing.com - QtTest.QTest.qWait(int(frame_interval - (time() - start) % frame_interval)) # type: ignore - QApplication.processEvents() - - # comes here when threshold gets met + # Second while loop: stays in this loop until similarity threshold is met + if self.__similarity_threshold_loop(number_of_split_images, dummy_splits_array): + return - # We need to make sure that this isn't a dummy split before sending - # the key press. + # We need to make sure that this isn't a dummy split before sending the key press. if not self.split_image.check_flag(DUMMY_FLAG): # If it's a delayed split, check if the delay has passed # Otherwise calculate the split time for the key press @@ -634,19 +581,8 @@ def __auto_splitter(self): self.current_image_file_label.clear() # check for reset while delayed and display a counter of the remaining split delay time - delay_start_time = time() - while time() - delay_start_time < split_delay: - delay_time_left = split_delay - (time() - delay_start_time) - self.current_split_image.setText(f"Delayed Split: {seconds_remaining_text(delay_time_left)}") - if self.__check_for_reset(): - return - - # calculate similarity for reset image - capture = self.__get_capture_for_comparison() - if self.__reset_if_should(capture): - continue - # Email sent to pyqt@riverbankcomputing.com - QtTest.QTest.qWait(1) # type: ignore + if self.__pause_loop(split_delay, "Delayed Split:"): + return self.waiting_for_split_delay = False @@ -660,51 +596,107 @@ def __auto_splitter(self): else: self.split_image_number += 1 - # Set a "pause" split image number. - # This is done so that it can detect if user hit split/undo split while paused. - pause_split_image_number = self.split_image_number - - # if its not the last split image, pause for the amount set by the user - if number_of_split_images != self.split_image_number: - - # If its the last split image and last loop number, disable the next image button - # If its the first split image, disable the undo split and previous image buttons - self.next_image_button.setEnabled(self.split_image_number != number_of_split_images - 1) - self.previous_image_button.setEnabled(self.split_image_number != 0) - if not self.is_auto_controlled: - # If its the last non-dummy split image and last loop number, disable the skip split button - self.skip_split_button.setEnabled(dummy_splits_array[self.split_image_number:].count(False) > 1) - self.undo_split_button.setEnabled(self.split_image_number != 0) - - QApplication.processEvents() - + # If its not the last split image, pause for the amount set by the user # 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 pause_time = self.split_image.get_pause_time(self) - if pause_time > 0: - pause_start_time = time() - while time() - pause_start_time < pause_time: - pause_time_left = pause_time - (time() - pause_start_time) - self.current_split_image.setText(f"None (Paused). {seconds_remaining_text(pause_time_left)}") + if self.__pause_loop(pause_time, "None (Paused)."): + return - if self.__check_for_reset(): - return + # loop breaks to here when the last image splits + self.gui_changes_on_reset() - # check for skip/undo split: - if self.split_image_number != pause_split_image_number: - break + def __similarity_threshold_loop(self, number_of_split_images: int, dummy_splits_array: list[bool]): + """ + Wait until the similarity threshold is met. - # calculate similarity for reset image - capture = self.__get_capture_for_comparison() - if self.__reset_if_should(capture): - send_command(self, "reset") - self.reset() + Returns True if the loop was interrupted by a reset. + """ + start = time() + while True: + capture = self.__get_capture_for_comparison() + + if self.__reset_if_should(capture): + return True + + similarity = self.split_image.compare_with_capture(self, capture) + + # Show live similarity + self.table_current_image_live_label.setText(f"{similarity:.2f}") + + # if the similarity becomes higher than highest similarity, set it as such. + if similarity > self.highest_similarity: + self.highest_similarity = similarity + + # show live highest similarity if the checkbox is checked + self.table_current_image_highest_label.setText(f"{self.highest_similarity:.2f}") + + # If its the last split image and last loop number, disable the next image button + # If its the first split image, disable the undo split and previous image buttons + self.next_image_button.setEnabled(self.split_image_number != number_of_split_images - 1) + self.previous_image_button.setEnabled(self.split_image_number != 0) + if not self.is_auto_controlled: + # If its the last non-dummy split image and last loop number, disable the skip split button + self.skip_split_button.setEnabled(dummy_splits_array[self.split_image_number:].count(False) > 1) + self.undo_split_button.setEnabled(self.split_image_number != 0) + QApplication.processEvents() + + # Limit the number of time the comparison runs to reduce cpu usage + # Use a time delta to have a consistant check interval + frame_interval: float = 1 / self.settings_dict["fps_limit"] + wait_delta = int(frame_interval - (time() - start) % frame_interval) + + # if the b flag is set, let similarity go above threshold first, + # 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 similarity >= self.split_image.get_similarity_threshold(self): + if not self.split_image.check_flag(BELOW_FLAG): + break + if not self.split_below_threshold: + self.split_below_threshold = True + # Email sent to pyqt@riverbankcomputing.com + QtTest.QTest.qWait(wait_delta) # type: ignore continue - # Email sent to pyqt@riverbankcomputing.com - QtTest.QTest.qWait(1) # type: ignore + elif self.split_image.check_flag(BELOW_FLAG) and self.split_below_threshold: + self.split_below_threshold = False + break - # loop breaks to here when the last image splits - self.gui_changes_on_reset() + # Email sent to pyqt@riverbankcomputing.com + QtTest.QTest.qWait(wait_delta) # type: ignore + + def __pause_loop(self, stop_time: float, message: str): + """ + Wait for a certain time and show the timer to the user. + Can be stopped early if the current split goes past the one when the loop started. + + Returns True if the loop was interrupted by a reset. + """ + if stop_time <= 0: + return False + start_time = time() + # Set a "pause" split image number. + # This is done so that it can detect if user hit split/undo split while paused. + pause_split_image_number = self.split_image_number + while True: + # Calculate similarity for reset image + if self.__reset_if_should(self.__get_capture_for_comparison()): + return True + + time_delta = time() - start_time + if ( + # Check for end of the pause/delay + time_delta >= stop_time + # Check for skip split / next image: + or self.split_image_number > pause_split_image_number + ): + break + + self.current_split_image.setText(f"{message} {seconds_remaining_text(stop_time - time_delta)}") + + # Email sent to pyqt@riverbankcomputing.com + QtTest.QTest.qWait(1) # type: ignore + return False def gui_changes_on_start(self): self.timer_start_image.stop() @@ -804,6 +796,7 @@ def __reset_if_should(self, capture: Optional[cv2.ndarray]): if should_reset: send_command(self, "reset") self.reset() + self.__check_for_reset_state_update_ui() return should_reset def __update_split_image(self, specific_image: Optional[AutoSplitImage] = None): From 714c8ccb38a376c6c9205b1de987095dc938a389 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 12 Mar 2022 16:46:15 -0500 Subject: [PATCH 017/137] Prevent text flash when reloading start image Fixed reset while in pause loop --- src/AutoSplit.py | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 430ea715..5dd07c22 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -267,14 +267,17 @@ def __load_start_image(self, started_by_button: bool = False, wait_for_delay: bo or not self.settings_dict["reset_hotkey"] or not self.settings_dict["pause_hotkey"]): error_messages.load_start_image() + QApplication.processEvents() return if not (validate_before_parsing(self, started_by_button) and parse_and_validate_images(self)): + QApplication.processEvents() return if self.start_image is None: if started_by_button: error_messages.no_keyword_image("start_auto_splitter") + QApplication.processEvents() return self.split_image_number = 0 @@ -778,13 +781,9 @@ def __reset_if_should(self, capture: Optional[cv2.ndarray]): """ Check if we should reset, resets if it's the case, and returns the result """ - if not self.reset_image: - return False - + if self.reset_image: similarity = self.reset_image.compare_with_capture(self, capture) threshold = self.reset_image.get_similarity_threshold(self) - should_reset = similarity >= threshold \ - and time() - self.run_start_time > self.reset_image.get_pause_time(self) if similarity > self.reset_highest_similarity: self.reset_highest_similarity = similarity @@ -793,11 +792,14 @@ def __reset_if_should(self, capture: Optional[cv2.ndarray]): self.table_reset_image_highest_label.setText(f"{self.reset_highest_similarity:.2f}") self.table_reset_image_threshold_label.setText(f"{threshold:.2f}") + should_reset = similarity >= threshold \ + and time() - self.run_start_time > self.reset_image.get_pause_time(self) + if should_reset: send_command(self, "reset") self.reset() - self.__check_for_reset_state_update_ui() - return should_reset + + return self.__check_for_reset_state_update_ui() def __update_split_image(self, specific_image: Optional[AutoSplitImage] = None): # Splitting/skipping when there are no images left or Undoing past the first image From 23b0206a09f67fe0191a3a4cf759e97b48b051d3 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 12 Mar 2022 16:48:07 -0500 Subject: [PATCH 018/137] Reverted pause before start image --- src/AutoSplit.py | 49 +++++++++++++++++++----------------------------- 1 file changed, 19 insertions(+), 30 deletions(-) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 5dd07c22..edf6b21e 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -113,7 +113,6 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): # Automatic timer start highest_similarity = 0.0 reset_highest_similarity = 0.0 - check_start_image_timestamp = 0.0 # Define all other attributes start_image_split_below_threshold: bool @@ -260,7 +259,6 @@ def __load_start_image(self, started_by_button: bool = False, wait_for_delay: bo self.timer_start_image.stop() self.current_image_file_label.setText("-") self.start_image_status_value_label.setText("not found") - QApplication.processEvents() if not self.is_auto_controlled \ and (not self.settings_dict["split_hotkey"] @@ -284,12 +282,10 @@ def __load_start_image(self, started_by_button: bool = False, wait_for_delay: bo start_pause_time = self.start_image.get_pause_time(self) if not wait_for_delay and start_pause_time > 0: - self.check_start_image_timestamp = time() + start_pause_time self.start_image_status_value_label.setText("paused") self.table_current_image_highest_label.setText("-") self.table_current_image_threshold_label.setText("-") else: - self.check_start_image_timestamp = 0.0 self.start_image_status_value_label.setText("ready") self.__update_split_image(self.start_image) @@ -301,19 +297,11 @@ def __load_start_image(self, started_by_button: bool = False, wait_for_delay: bo QApplication.processEvents() def __start_image_function(self): - if self.start_image is None \ - or not self.start_image \ - or time() < self.check_start_image_timestamp \ - or (not self.settings_dict["split_hotkey"] and not self.is_auto_controlled): - pause_time_left = self.check_start_image_timestamp - time() - self.current_split_image.setText( - f"None\n (Paused before loading Start Image).\n {seconds_remaining_text(pause_time_left)}") + if not self.start_image: return - if self.check_start_image_timestamp > 0: - self.check_start_image_timestamp = 0.0 - self.start_image_status_value_label.setText("ready") - self.__update_split_image(self.start_image) + self.start_image_status_value_label.setText("ready") + self.__update_split_image(self.start_image) capture = self.__get_capture_for_comparison() start_image_threshold = self.start_image.get_similarity_threshold(self) @@ -333,15 +321,16 @@ def __start_image_function(self): # 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 below_flag = self.start_image.check_flag(BELOW_FLAG) + + # Negative means belove threshold, positive means above + similarity_diff = start_image_threshold - start_image_similarity if below_flag \ and not self.start_image_split_below_threshold \ - and start_image_similarity >= start_image_threshold: + and similarity_diff >= 0: self.start_image_split_below_threshold = True return - if (below_flag - and self.start_image_split_below_threshold - and start_image_similarity < start_image_threshold) \ - or (start_image_similarity >= start_image_threshold and not below_flag): + if (below_flag and self.start_image_split_below_threshold and similarity_diff < 0) \ + or (not below_flag and similarity_diff >= 0): self.timer_start_image.stop() self.start_image_split_below_threshold = False @@ -782,22 +771,22 @@ def __reset_if_should(self, capture: Optional[cv2.ndarray]): Check if we should reset, resets if it's the case, and returns the result """ if self.reset_image: - similarity = self.reset_image.compare_with_capture(self, capture) - threshold = self.reset_image.get_similarity_threshold(self) + similarity = self.reset_image.compare_with_capture(self, capture) + threshold = self.reset_image.get_similarity_threshold(self) - if similarity > self.reset_highest_similarity: - self.reset_highest_similarity = similarity + if similarity > self.reset_highest_similarity: + self.reset_highest_similarity = similarity - self.table_reset_image_live_label.setText(f"{similarity:.2f}") - self.table_reset_image_highest_label.setText(f"{self.reset_highest_similarity:.2f}") - self.table_reset_image_threshold_label.setText(f"{threshold:.2f}") + self.table_reset_image_live_label.setText(f"{similarity:.2f}") + self.table_reset_image_highest_label.setText(f"{self.reset_highest_similarity:.2f}") + self.table_reset_image_threshold_label.setText(f"{threshold:.2f}") should_reset = similarity >= threshold \ and time() - self.run_start_time > self.reset_image.get_pause_time(self) - if should_reset: - send_command(self, "reset") - self.reset() + if should_reset: + send_command(self, "reset") + self.reset() return self.__check_for_reset_state_update_ui() From c2deb112e60317261c814b81805a272fcb042daa Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 12 Mar 2022 19:51:12 -0500 Subject: [PATCH 019/137] TOML Settings --- .gitignore | 1 + README.md | 18 +-- src/AutoControlledWorker.py | 4 +- src/AutoSplit.py | 40 +++--- src/capture_windows.py | 36 ++++-- src/menu_bar.py | 18 +-- src/screen_region.py | 12 +- src/settings_file.py | 234 ------------------------------------ src/user_profile.py | 210 ++++++++++++++++++++++++++++++++ 9 files changed, 281 insertions(+), 292 deletions(-) delete mode 100644 src/settings_file.py create mode 100644 src/user_profile.py diff --git a/.gitignore b/.gitignore index 76ff082c..0aff38f5 100644 --- a/.gitignore +++ b/.gitignore @@ -19,3 +19,4 @@ dist/ # Dev settings *.pkl +settings.toml diff --git a/README.md b/README.md index ea90d068..b2983070 100644 --- a/README.md +++ b/README.md @@ -170,19 +170,19 @@ This option does not loop single, specific images. See the Custom Split Image Se If this option is enabled, when the reset hotkey is hit, the reset button is pressed, or the reset split image meets its threshold, AutoSplit will reset and automatically start again back at the first split image. If this option is disabled, when the reset hotkey is hit, the reset button is pressed, or the reset split image meets its threshold, AutoSplit will stop running comparisons. -### Settings +### Profiles -- Settings files use the extension `.pkl`. Settings files can be saved and opened by using File -> Save Settings As... and File -> Load Settings. A settings file can be loaded upon opening AutoSplit if placed in the same directory as AutoSplit.exe. -- The settings in the settings file include split image directory, capture region, capture region dimensions, fps limit, threshold and pause time settings, all hotkeys, "Group dummy splits when undoing/skipping" check box, "Loop Split Images" check box, and "Auto Start On Reset" check box. -- You can save multiple settings files, which is useful if you speedrun multiple games. -- If you are upgrading to Windows 11, it's possible that save files may not transfer perfectly. You may need to readjust or reselect your Capture Region, for example. +- Profiles are saved under `%appdata%\AutoSplit\profiles` and use the extension `.toml`. Profiles can be saved and loaded by using File -> Save Profile As... and File -> Load Profile. +- The profile contains all of your settings, including information about the capture region. +- You can save multiple profiles, which is useful if you speedrun multiple games. +- If you change your display setup (like using a new monitor, or upgrading to Windows 11), you may need to readjust or reselect your Capture Region. ## LiveSplit Integration The AutoSplit LiveSplit Component will directly connect AutoSplit with LiveSplit. LiveSplit integration is only supported in AutoSplit v1.6.0 or higher. This integration will allow you to: - Use hotkeys directly from LiveSplit to control AutoSplit and LiveSplit together -- Load AutoSplit and any AutoSplit settings automatically when opening a LiveSplit layout. +- Load AutoSplit and any AutoSplit profile automatically when opening a LiveSplit layout. ### LiveSplit Integration Tutorial @@ -190,9 +190,9 @@ The AutoSplit LiveSplit Component will directly connect AutoSplit with LiveSplit - Place the .dll file into your `[...]\LiveSplit\Components` folder. - Open LiveSplit -> Right Click -> Edit Layout -> Plus Button -> Control -> AutoSplit Integration. - Click Layout Settings -> AutoSplit Integration -- Click the Browse buttons to locate your AutoSplit Path (path to AutoSplit.exe) and Settings Path (path to your AutoSplit `.pkl` settings file) respectively. - - If you have not yet set saved a settings file, you can do so using AutoSplit, and then go back and set your Settings Path. -- Once set, click OK, and then OK again to close the Layout Editor. Right click LiveSplit -> Save Layout to save your layout. AutoSplit and its settings will now open automatically when opening that LiveSplit Layout `.lsl` file. +- Click the Browse buttons to locate your AutoSplit Path (path to AutoSplit.exe) and Profile Path (path to your AutoSplit `.toml` profile file) respectively. + - If you have not yet set saved a profile, you can do so using AutoSplit, and then go back and set your Settings Path. +- Once set, click OK, and then OK again to close the Layout Editor. Right click LiveSplit -> Save Layout to save your layout. AutoSplit and your selected profile will now open automatically when opening that LiveSplit Layout `.lsl` file. ## Known Limitations diff --git a/src/AutoControlledWorker.py b/src/AutoControlledWorker.py index 36b231d9..db8ee07e 100644 --- a/src/AutoControlledWorker.py +++ b/src/AutoControlledWorker.py @@ -5,7 +5,7 @@ from PyQt6 import QtCore import error_messages -import settings_file as settings +import user_profile class AutoControlledWorker(QtCore.QObject): @@ -37,7 +37,7 @@ def run(self): self.autosplit.reset_signal.emit() elif line.startswith("settings"): # Allow for any split character between "settings" and the path - settings.load_settings(self.autosplit, line[9:]) + user_profile.load_settings(self.autosplit, line[9:]) # TODO: Not yet implemented in AutoSplit Integration # elif line == 'pause': # self.pause_signal.emit() diff --git a/src/AutoSplit.py b/src/AutoSplit.py index edf6b21e..b220dfc9 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -9,7 +9,7 @@ from __future__ import annotations from collections.abc import Callable from types import FunctionType, TracebackType -from typing import Optional, Union +from typing import Optional import sys import os @@ -26,15 +26,15 @@ from AutoSplitImage import COMPARISON_RESIZE, AutoSplitImage, ImageType import error_messages -import settings_file as settings +import user_profile from AutoControlledWorker import AutoControlledWorker from capture_windows import capture_region, set_ui_image -from gen import about, design, settings as settings_ui, update_checker +from gen import about, design, settings, update_checker from hotkeys import send_command, after_setting_hotkey from menu_bar import get_default_settings_from_ui, open_about, VERSION, open_settings, view_help, check_for_updates, \ open_update_checker from screen_region import select_region, select_window, align_region, validate_before_parsing -from settings_file import FROZEN +from user_profile import DEFAULT_PROFILE, FROZEN from split_parser import BELOW_FLAG, DUMMY_FLAG, PAUSE_FLAG, parse_and_validate_images CREATE_NEW_ISSUE_MESSAGE = ( @@ -86,7 +86,7 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): AboutWidget: Optional[about.Ui_AboutAutoSplitWidget] = None UpdateCheckerWidget: Optional[update_checker.Ui_UpdateChecker] = None CheckForUpdatesThread: Optional[QtCore.QThread] = None - SettingsWidget: Optional[settings_ui.Ui_DialogSettings] = None + SettingsWidget: Optional[settings.Ui_DialogSettings] = None # hotkeys need to be initialized to be passed as thread arguments in hotkeys.py # and for type safety in both hotkeys.py and settings_file.py @@ -99,14 +99,14 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): # Initialize a few attributes hwnd = 0 """Window Handle used for Capture Region""" - last_saved_settings: list[Union[str, float, int, bool]] = [] + last_saved_settings = DEFAULT_PROFILE similarity = 0.0 split_image_number = 0 split_images_and_loop_number: list[tuple[AutoSplitImage, int]] = [] split_groups: list[list[int]] = [] # Last loaded settings empty and last successful loaded settings file path to None until we try to load them - last_loaded_settings: list[Union[str, float, int]] = [] + last_loaded_settings = DEFAULT_PROFILE last_successfully_loaded_settings_file_path: Optional[str] = None """For when a file has never loaded, but you successfully "Save File As".""" @@ -136,15 +136,15 @@ def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-man # Get default values defined in SettingsDialog self.settings_dict = get_default_settings_from_ui(self) - settings.load_check_for_updates_on_open(self) + user_profile.load_check_for_updates_on_open(self) self.action_view_help.triggered.connect(view_help) self.action_about.triggered.connect(lambda: open_about(self)) self.action_check_for_updates.triggered.connect(lambda: check_for_updates(self)) self.action_settings.triggered.connect(lambda: open_settings(self)) - self.action_save_profile.triggered.connect(lambda: settings.save_settings(self)) - self.action_save_profile_as.triggered.connect(lambda: settings.save_settings_as(self)) - self.action_load_profile.triggered.connect(lambda: settings.load_settings(self)) + self.action_save_profile.triggered.connect(lambda: user_profile.save_settings(self)) + self.action_save_profile_as.triggered.connect(lambda: user_profile.save_settings_as(self)) + self.action_load_profile.triggered.connect(lambda: user_profile.load_settings(self)) if self.SettingsWidget: self.SettingsWidget.split_input.setEnabled(False) @@ -184,7 +184,7 @@ def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-man self.align_region_button.clicked.connect(lambda: align_region(self)) self.select_window_button.clicked.connect(lambda: select_window(self)) self.reload_start_image_button.clicked.connect(lambda: self.__load_start_image(True, True)) - self.action_check_for_updates_on_open.changed.connect(lambda: settings.set_check_for_updates_on_open( + self.action_check_for_updates_on_open.changed.connect(lambda: user_profile.set_check_for_updates_on_open( self, self.action_check_for_updates_on_open.isChecked()) ) @@ -216,7 +216,7 @@ def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-man self.timer_start_image.timeout.connect(self.__start_image_function) if not self.is_auto_controlled: - settings.load_settings_on_open(self) + user_profile.load_settings_on_open(self) self.show() @@ -231,7 +231,7 @@ def __browse(self): new_split_image_directory = QFileDialog.getExistingDirectory( self, "Select Split Image Directory", - os.path.join(self.settings_dict["split_image_directory"] or settings.auto_split_directory, "..")) + os.path.join(self.settings_dict["split_image_directory"] or user_profile.auto_split_directory, "..")) # If the user doesn't select a folder, it defaults to "". if new_split_image_directory: @@ -355,16 +355,16 @@ def __start_image_function(self): # update x, y, width, height when spinbox values are changed def __update_x(self): - self.settings_dict["capture_region"].x = self.x_spinbox.value() + self.settings_dict["capture_region"]["x"] = self.x_spinbox.value() def __update_y(self): - self.settings_dict["capture_region"].y = self.y_spinbox.value() + self.settings_dict["capture_region"]["y"] = self.y_spinbox.value() def __update_width(self): - self.settings_dict["capture_region"].width = self.width_spinbox.value() + self.settings_dict["capture_region"]["width"] = self.width_spinbox.value() def __update_height(self): - self.settings_dict["capture_region"].height = self.height_spinbox.value() + self.settings_dict["capture_region"]["height"] = self.height_spinbox.value() def __take_screenshot(self): if not validate_before_parsing(self, check_empty_directory=False): @@ -838,7 +838,7 @@ def exit_program(): if a0 is None: exit_program() - if settings.have_settings_changed(self): + if user_profile.have_settings_changed(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" \ @@ -852,7 +852,7 @@ def exit_program(): QMessageBox.StandardButton.Yes | QMessageBox.StandardButton.No | QMessageBox.StandardButton.Cancel) if warning is QMessageBox.StandardButton.Yes: - if settings.save_settings(self): + if user_profile.save_settings(self): exit_program() else: a0.ignore() diff --git a/src/capture_windows.py b/src/capture_windows.py index c6401efa..9d64c059 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -3,7 +3,6 @@ import ctypes import ctypes.wintypes -from dataclasses import dataclass from PyQt6 import QtCore, QtGui from PyQt6.QtWidgets import QLabel @@ -19,13 +18,22 @@ PW_RENDERFULLCONTENT = 0x00000002 -@dataclass -class Region(): - def __init__(self, x: int, y: int, width: int, height: int): - self.x = x - self.y = y - self.width = width - self.height = height +# @dataclass +# class Region(): +# def __init__(self, x: int, y: int, width: int, height: int): +# self.x = x +# self.y = y +# self.width = width +# self.height = height +# class Region(TypedDict): +# x: int +# y: int +# width: int +# height: int + +# toml.dump does not support TypedDicts or dataclasses +# TODO: Check if we can just "cast" or "map" it before parsing it as TOML +Region = dict[str, int] def capture_region(hwnd: int, selection: Region, print_window: bool): @@ -50,17 +58,21 @@ def capture_region(hwnd: int, selection: Region, print_window: bool): compatible_dc = cast(PyCDC, dc_object.CreateCompatibleDC()) bitmap: PyCBitmap = win32ui.CreateBitmap() - bitmap.CreateCompatibleBitmap(dc_object, selection.width, selection.height) + bitmap.CreateCompatibleBitmap(dc_object, selection["width"], selection["height"]) compatible_dc.SelectObject(bitmap) - compatible_dc.BitBlt((0, 0), (selection.width, selection.height), dc_object, - (selection.x, selection.y), win32con.SRCCOPY) + compatible_dc.BitBlt( + (0, 0), + (selection["width"], selection["height"]), + dc_object, + (selection["x"], selection["y"]), + win32con.SRCCOPY) # https://github.com/kaluluosi/pywin32-stubs/issues/5 # pylint: disable=no-member except (win32ui.error, pywintypes.error): # type: ignore return None image = np.frombuffer(cast(bytes, bitmap.GetBitmapBits(True)), dtype="uint8") - image.shape = (selection.height, selection.width, 4) + image.shape = (selection["height"], selection["width"], 4) try: dc_object.DeleteDC() diff --git a/src/menu_bar.py b/src/menu_bar.py index 1956ee36..22c16caf 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -14,8 +14,7 @@ from requests.exceptions import RequestException import error_messages -import settings_file as settings -from capture_windows import Region +import user_profile from gen import about, design, resources_rc, settings as settings_ui, update_checker # noqa: F401 from hotkeys import set_hotkey @@ -63,7 +62,7 @@ def open_update(self): self.close() def do_not_ask_me_again_state_changed(self): - settings.set_check_for_updates_on_open( + user_profile.set_check_for_updates_on_open( self.design_window, self.do_not_ask_again_checkbox.isChecked()) @@ -184,7 +183,7 @@ def get_default_settings_from_ui(autosplit: AutoSplit): temp_dialog = QtWidgets.QDialog() default_settings_dialog = settings_ui.Ui_DialogSettings() default_settings_dialog.setupUi(temp_dialog) - default_settings: settings.SettingsDict = { + default_settings: user_profile.UserProfileDict = { "split_hotkey": default_settings_dialog.split_input.text(), "reset_hotkey": default_settings_dialog.reset_input.text(), "undo_split_hotkey": default_settings_dialog.undo_split_input.text(), @@ -201,11 +200,12 @@ def get_default_settings_from_ui(autosplit: AutoSplit): "split_image_directory": autosplit.split_image_folder_input.text(), "captured_window_title": "", - "capture_region": Region( - autosplit.x_spinbox.value(), - autosplit.y_spinbox.value(), - autosplit.width_spinbox.value(), - autosplit.height_spinbox.value()) + "capture_region": { + "x": autosplit.x_spinbox.value(), + "y": autosplit.y_spinbox.value(), + "width": autosplit.width_spinbox.value(), + "height": autosplit.height_spinbox.value(), + } } del temp_dialog return default_settings diff --git a/src/screen_region.py b/src/screen_region.py index 2342dd8d..a3c348a3 100644 --- a/src/screen_region.py +++ b/src/screen_region.py @@ -151,17 +151,17 @@ def align_region(autosplit: AutoSplit): # The new region can be defined by using the min_loc point and the best_height and best_width of the template. __set_region_values(autosplit, - left=autosplit.settings_dict["capture_region"].x + best_loc[0], - top=autosplit.settings_dict["capture_region"].y + best_loc[1], + left=autosplit.settings_dict["capture_region"]["x"] + best_loc[0], + top=autosplit.settings_dict["capture_region"]["y"] + best_loc[1], width=best_width, height=best_height) def __set_region_values(autosplit: AutoSplit, left: int, top: int, width: int, height: int): - autosplit.settings_dict["capture_region"].x = left - autosplit.settings_dict["capture_region"].y = top - autosplit.settings_dict["capture_region"].width = width - autosplit.settings_dict["capture_region"].height = height + autosplit.settings_dict["capture_region"]["x"] = left + autosplit.settings_dict["capture_region"]["y"] = top + autosplit.settings_dict["capture_region"]["width"] = width + autosplit.settings_dict["capture_region"]["height"] = height autosplit.x_spinbox.setValue(left) autosplit.y_spinbox.setValue(top) diff --git a/src/settings_file.py b/src/settings_file.py deleted file mode 100644 index de00ca7a..00000000 --- a/src/settings_file.py +++ /dev/null @@ -1,234 +0,0 @@ -from __future__ import annotations -from typing import TYPE_CHECKING, Any, TypedDict - -if TYPE_CHECKING: - from AutoSplit import AutoSplit - -import os -import sys -import pickle - -import keyboard # https://github.com/boppreh/keyboard/issues/505 -from win32 import win32gui -from PyQt6 import QtCore, QtWidgets - -import error_messages -from capture_windows import Region -from gen import design -from hotkeys import set_hotkey - -# Keyword "frozen" is for setting basedir while in onefile mode in pyinstaller -FROZEN = hasattr(sys, "frozen") -# Get the directory of either AutoSplit.exe or AutoSplit.py -auto_split_directory = os.path.dirname(sys.executable if FROZEN else os.path.abspath(__file__)) - - -class SettingsDict(TypedDict): - split_hotkey: str - reset_hotkey: str - undo_split_hotkey: str - skip_split_hotkey: str - pause_hotkey: str - fps_limit: int - live_capture_region: bool - force_print_window: bool - default_comparison_method: int - default_similarity_threshold: float - default_delay_time: int - default_pause_time: float - loop_splits: bool - - split_image_directory: str - captured_window_title: str - capture_region: Region - - -class RestrictedUnpickler(pickle.Unpickler): - - def find_class(self, module: str, name: str): - raise pickle.UnpicklingError(f"'{module}.{name}' is forbidden") - - -def get_save_settings_values(autosplit: AutoSplit): - return [ - autosplit.settings_dict["split_image_directory"], - autosplit.settings_dict["default_similarity_threshold"], - autosplit.settings_dict["default_comparison_method"], - autosplit.settings_dict["default_pause_time"], - autosplit.settings_dict["fps_limit"], - autosplit.settings_dict["split_hotkey"], - autosplit.settings_dict["reset_hotkey"], - autosplit.settings_dict["skip_split_hotkey"], - autosplit.settings_dict["undo_split_hotkey"], - autosplit.settings_dict["pause_hotkey"], - autosplit.settings_dict["capture_region"].x, - autosplit.settings_dict["capture_region"].y, - autosplit.settings_dict["capture_region"].width, - autosplit.settings_dict["capture_region"].height, - autosplit.settings_dict["captured_window_title"], - 0, - 0, - 1, - autosplit.settings_dict["loop_splits"], - 0, - autosplit.settings_dict["force_print_window"]] - - -def have_settings_changed(autosplit: AutoSplit): - # 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 - # the user to save changes upon closing even though there were none - return get_save_settings_values(autosplit) not in (autosplit.last_loaded_settings, autosplit.last_saved_settings) - - -def save_settings(autosplit: AutoSplit): - """ - @return: The save settings filepath. Or None if "Save Settings As" is cancelled - """ - if not autosplit.last_successfully_loaded_settings_file_path: - return save_settings_as(autosplit) - - autosplit.last_saved_settings = get_save_settings_values(autosplit) - # Save settings to a .pkl file - with open(autosplit.last_successfully_loaded_settings_file_path, "wb") as file: - pickle.dump(autosplit.last_saved_settings, file) - return autosplit.last_successfully_loaded_settings_file_path - - -def save_settings_as(autosplit: AutoSplit): - """ - @return: The save settings filepath selected. Empty if cancelled - """ - # User picks save destination - save_settings_file_path = QtWidgets.QFileDialog.getSaveFileName( - autosplit, - "Save Settings As", - autosplit.last_successfully_loaded_settings_file_path - or os.path.join(auto_split_directory, "settings.pkl"), - "PKL (*.pkl)")[0] - - # If user cancels save destination window, don't save settings - if not save_settings_file_path: - return "" - - autosplit.last_saved_settings = get_save_settings_values(autosplit) - - # Save settings to a .pkl file - with open(save_settings_file_path, "wb") as file: - pickle.dump(autosplit.last_saved_settings, file) - - autosplit.last_successfully_loaded_settings_file_path = save_settings_file_path - return save_settings_file_path - - -def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str): - try: - with open(load_settings_file_path, "rb") as file: - settings: list[Any] = RestrictedUnpickler(file).load() - settings_count = len(settings) - if settings_count < 18: - autosplit.show_error_signal.emit(error_messages.old_version_settings_file) - return False - # v1.3-1.4 settings. Add default pause_key and auto_start_on_reset_setting - if settings_count == 18: - settings.insert(9, "") - settings.insert(20, 0) - # v1.5 settings - if settings_count == 20: - settings.insert(21, False) - # v1.6.X settings - elif settings_count != 21: - autosplit.show_error_signal.emit(error_messages.invalid_settings) - return False - autosplit.last_loaded_settings = settings - except (FileNotFoundError, MemoryError, pickle.UnpicklingError): - autosplit.show_error_signal.emit(error_messages.invalid_settings) - return False - - autosplit.settings_dict["split_image_directory"] = settings[0] - autosplit.split_image_folder_input.setText(settings[0]) - autosplit.settings_dict["default_similarity_threshold"] = settings[1] - autosplit.settings_dict["default_comparison_method"] = settings[2] - autosplit.settings_dict["default_pause_time"] = settings[3] - autosplit.settings_dict["fps_limit"] = settings[4] - keyboard.unhook_all() - if not autosplit.is_auto_controlled: - set_hotkey(autosplit, "split", settings[5]) - set_hotkey(autosplit, "reset", settings[6]) - set_hotkey(autosplit, "skip_split", settings[7]) - set_hotkey(autosplit, "undo_split", settings[8]) - set_hotkey(autosplit, "pause", settings[9]) - autosplit.x_spinbox.setValue(settings[10]) - autosplit.y_spinbox.setValue(settings[11]) - autosplit.width_spinbox.setValue(settings[12]) - autosplit.height_spinbox.setValue(settings[13]) - autosplit.settings_dict["captured_window_title"] = settings[14] - autosplit.settings_dict["loop_splits"] = settings[18] - autosplit.settings_dict["force_print_window"] = settings[20] - - if autosplit.settings_dict["captured_window_title"]: - # https://github.com/kaluluosi/pywin32-stubs/issues/7 - hwnd = win32gui.FindWindow(None, autosplit.settings_dict["captured_window_title"]) # type: ignore - if hwnd: - autosplit.hwnd = hwnd - else: - autosplit.live_image.setText("Reload settings after opening" - + f'\n"{autosplit.settings_dict["captured_window_title"]}"' - + "\nto automatically load Capture Region") - return True - - -def load_settings( - autosplit: AutoSplit, - from_path: str = "" -): - load_settings_file_path = from_path or QtWidgets.QFileDialog.getOpenFileName( - autosplit, - "Load Settings", - os.path.join(auto_split_directory, "settings.pkl"), - "PKL (*.pkl)")[0] - if not (load_settings_file_path and __load_settings_from_file(autosplit, load_settings_file_path)): - return - - autosplit.last_successfully_loaded_settings_file_path = load_settings_file_path - autosplit.load_start_image_signal.emit() - - -def load_settings_on_open(autosplit: AutoSplit): - settings_files = [ - file for file - in os.listdir(auto_split_directory) - if file.endswith(".pkl")] - - # find all .pkls in AutoSplit folder, error if there is none or more than 1 - if len(settings_files) < 1: - error_messages.no_settings_file_on_open() - autosplit.last_loaded_settings = [] - return - if len(settings_files) > 1: - error_messages.too_many_settings_files_on_open() - autosplit.last_loaded_settings = [] - return - load_settings(autosplit, os.path.join(auto_split_directory, settings_files[0])) - - -def load_check_for_updates_on_open(autosplit: AutoSplit): - """ - Retrieve the "Check For Updates On Open" QSettings and set the checkbox state - These are only global settings values. They are not *pkl settings values. - """ - value = QtCore \ - .QSettings("AutoSplit", "Check For Updates On Open") \ - .value("check_for_updates_on_open", True, type=bool) - autosplit.action_check_for_updates_on_open.setChecked(value) - - -def set_check_for_updates_on_open(design_window: design.Ui_MainWindow, value: bool): - """ - Sets the "Check For Updates On Open" QSettings value and the checkbox state - """ - - design_window.action_check_for_updates_on_open.setChecked(value) - QtCore \ - .QSettings("AutoSplit", "Check For Updates On Open") \ - .setValue("check_for_updates_on_open", value) diff --git a/src/user_profile.py b/src/user_profile.py new file mode 100644 index 00000000..6dd43116 --- /dev/null +++ b/src/user_profile.py @@ -0,0 +1,210 @@ +from __future__ import annotations +from typing import TYPE_CHECKING, TypedDict, cast +if TYPE_CHECKING: + from AutoSplit import AutoSplit + +import os +import sys + +import keyboard # https://github.com/boppreh/keyboard/issues/505 +import toml +from win32 import win32gui +from PyQt6 import QtCore, QtWidgets + +import error_messages +from capture_windows import Region +from gen import design +from hotkeys import set_hotkey + +# Keyword "frozen" is for setting basedir while in onefile mode in pyinstaller +FROZEN = hasattr(sys, "frozen") +# Get the directory of either AutoSplit.exe or AutoSplit.py +auto_split_directory = os.path.dirname(sys.executable if FROZEN else os.path.abspath(__file__)) + + +class UserProfileDict(TypedDict): + split_hotkey: str + reset_hotkey: str + undo_split_hotkey: str + skip_split_hotkey: str + pause_hotkey: str + fps_limit: int + live_capture_region: bool + force_print_window: bool + default_comparison_method: int + default_similarity_threshold: float + default_delay_time: int + default_pause_time: float + loop_splits: bool + + split_image_directory: str + captured_window_title: str + capture_region: Region + + +DEFAULT_PROFILE = UserProfileDict( + split_hotkey="", + reset_hotkey="", + undo_split_hotkey="", + skip_split_hotkey="", + pause_hotkey="", + fps_limit=60, + live_capture_region=True, + force_print_window=False, + default_comparison_method=0, + default_similarity_threshold=0.95, + default_delay_time=0, + default_pause_time=10, + loop_splits=False, + split_image_directory="", + captured_window_title="", + capture_region={"x": 0, "y": 0, "width": 0, "height": 0}, +) + + +def have_settings_changed(autosplit: AutoSplit): + return autosplit.settings_dict not in (autosplit.last_loaded_settings, autosplit.last_saved_settings) + + +def save_settings(autosplit: AutoSplit): + """ + @return: The save settings filepath. Or None if "Save Settings As" is cancelled + """ + if not autosplit.last_successfully_loaded_settings_file_path: + return save_settings_as(autosplit) + + autosplit.last_saved_settings = autosplit.settings_dict + # Save settings to a .toml file + with open(autosplit.last_successfully_loaded_settings_file_path, "w") as file: + toml.dump(autosplit.last_saved_settings, file, encoder=toml.TomlNumpyEncoder()) + return autosplit.last_successfully_loaded_settings_file_path + + +def save_settings_as(autosplit: AutoSplit): + """ + @return: The save settings filepath selected. Empty if cancelled + """ + # User picks save destination + save_settings_file_path = QtWidgets.QFileDialog.getSaveFileName( + autosplit, + "Save Settings As", + autosplit.last_successfully_loaded_settings_file_path + or os.path.join(auto_split_directory, "settings.toml"), + "TOML (*.toml)")[0] + + # If user cancels save destination window, don't save settings + if not save_settings_file_path: + return "" + + autosplit.last_saved_settings = autosplit.settings_dict + + # Save settings to a .toml file + with open(save_settings_file_path, "w") as file: + toml.dump(autosplit.last_saved_settings, file, encoder=toml.TomlNumpyEncoder()) + + autosplit.last_successfully_loaded_settings_file_path = save_settings_file_path + return save_settings_file_path + + +def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str): + if load_settings_file_path.endswith(".pkl"): + autosplit.show_error_signal.emit(error_messages.old_version_settings_file) + return False + try: + with open(load_settings_file_path, "r") as file: + # Casting here just so we can build an actual UserProfileDict once we're done validating + # Fallback to default settings if some are missing from the file. This happens when new settings are added. + loaded_settings = cast(UserProfileDict, { + **DEFAULT_PROFILE, + **toml.load(file), + }) + # TODO: Data Validation / fallbacks ? + autosplit.settings_dict = UserProfileDict(**loaded_settings) + autosplit.last_loaded_settings = autosplit.settings_dict + + autosplit.x_spinbox.setValue(autosplit.settings_dict["capture_region"]["x"]) + autosplit.y_spinbox.setValue(autosplit.settings_dict["capture_region"]["y"]) + autosplit.width_spinbox.setValue(autosplit.settings_dict["capture_region"]["width"]) + autosplit.height_spinbox.setValue(autosplit.settings_dict["capture_region"]["height"]) + except (FileNotFoundError, MemoryError, TypeError, toml.TomlDecodeError): + autosplit.show_error_signal.emit(error_messages.invalid_settings) + return False + + autosplit.split_image_folder_input.setText(autosplit.settings_dict["split_image_directory"]) + keyboard.unhook_all() + if not autosplit.is_auto_controlled: + if autosplit.settings_dict["split_hotkey"]: + set_hotkey(autosplit, "split", autosplit.settings_dict["split_hotkey"]) + if autosplit.settings_dict["reset_hotkey"]: + set_hotkey(autosplit, "reset", autosplit.settings_dict["reset_hotkey"]) + if autosplit.settings_dict["skip_split_hotkey"]: + set_hotkey(autosplit, "skip_split", autosplit.settings_dict["skip_split_hotkey"]) + if autosplit.settings_dict["undo_split_hotkey"]: + set_hotkey(autosplit, "undo_split", autosplit.settings_dict["undo_split_hotkey"]) + if autosplit.settings_dict["pause_hotkey"]: + set_hotkey(autosplit, "pause", autosplit.settings_dict["pause_hotkey"]) + + if autosplit.settings_dict["captured_window_title"]: + # https://github.com/kaluluosi/pywin32-stubs/issues/7 + hwnd = win32gui.FindWindow(None, autosplit.settings_dict["captured_window_title"]) # type: ignore + if hwnd: + autosplit.hwnd = hwnd + else: + autosplit.live_image.setText("Reload settings after opening" + + f'\n"{autosplit.settings_dict["captured_window_title"]}"' + + "\nto automatically load Capture Region") + return True + + +def load_settings( + autosplit: AutoSplit, + from_path: str = "" +): + load_settings_file_path = from_path or QtWidgets.QFileDialog.getOpenFileName( + autosplit, + "Load Profile", + os.path.join(auto_split_directory, "settings.toml"), + "TOML (*.toml)")[0] + if not (load_settings_file_path and __load_settings_from_file(autosplit, load_settings_file_path)): + return + + autosplit.last_successfully_loaded_settings_file_path = load_settings_file_path + autosplit.load_start_image_signal.emit() + + +def load_settings_on_open(autosplit: AutoSplit): + settings_files = [ + file for file + in os.listdir(auto_split_directory) + if file.endswith(".toml")] + + # find all .tomls in AutoSplit folder, error if there is none or more than 1 + if len(settings_files) < 1: + error_messages.no_settings_file_on_open() + return + if len(settings_files) > 1: + error_messages.too_many_settings_files_on_open() + return + load_settings(autosplit, os.path.join(auto_split_directory, settings_files[0])) + + +def load_check_for_updates_on_open(autosplit: AutoSplit): + """ + Retrieve the "Check For Updates On Open" QSettings and set the checkbox state + These are only global settings values. They are not *toml settings values. + """ + value = QtCore \ + .QSettings("AutoSplit", "Check For Updates On Open") \ + .value("check_for_updates_on_open", True, type=bool) + autosplit.action_check_for_updates_on_open.setChecked(value) + + +def set_check_for_updates_on_open(design_window: design.Ui_MainWindow, value: bool): + """ + Sets the "Check For Updates On Open" QSettings value and the checkbox state + """ + + design_window.action_check_for_updates_on_open.setChecked(value) + QtCore \ + .QSettings("AutoSplit", "Check For Updates On Open") \ + .setValue("check_for_updates_on_open", value) From 048b94857a2cd838443dec4ed3be175b7e220d9b Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 12 Mar 2022 20:50:46 -0500 Subject: [PATCH 020/137] Trying out Python 3.10 build Missing library and type stub Let all job matrix complete --- .github/workflows/lint-and-build.yml | 15 +- scripts/requirements.txt | 13 +- src/capture_windows.py | 2 +- .../__init__.pyi} | 16342 ++++++++-------- 4 files changed, 7861 insertions(+), 8511 deletions(-) rename typings/{pythonwin-stubs/win32typing.pyi => win32typing/__init__.pyi} (73%) diff --git a/.github/workflows/lint-and-build.yml b/.github/workflows/lint-and-build.yml index 28eaf124..9b285cbb 100644 --- a/.github/workflows/lint-and-build.yml +++ b/.github/workflows/lint-and-build.yml @@ -24,8 +24,9 @@ jobs: Pyright: runs-on: windows-latest strategy: + fail-fast: false matrix: - python-version: ["3.8", "3.9"] + python-version: ["3.8", "3.9", "3.10"] steps: - name: Checkout ${{ github.repository }}/${{ github.ref }} uses: actions/checkout@v2 @@ -47,8 +48,9 @@ jobs: Pylint: runs-on: windows-latest strategy: + fail-fast: false matrix: - python-version: ["3.8", "3.9"] + python-version: ["3.8", "3.9", "3.10"] steps: - name: Checkout ${{ github.repository }}/${{ github.ref }} uses: actions/checkout@v2 @@ -67,8 +69,9 @@ jobs: Flake8: runs-on: windows-latest strategy: + fail-fast: false matrix: - python-version: ["3.8", "3.9"] + python-version: ["3.8", "3.9", "3.10"] steps: - name: Checkout ${{ github.repository }}/${{ github.ref }} uses: actions/checkout@v2 @@ -87,8 +90,9 @@ jobs: Bandit: runs-on: windows-latest strategy: + fail-fast: false matrix: - python-version: ["3.8", "3.9"] + python-version: ["3.8", "3.9", "3.10"] steps: - name: Checkout ${{ github.repository }}/${{ github.ref }} uses: actions/checkout@v2 @@ -107,8 +111,9 @@ jobs: Build: runs-on: windows-latest strategy: + fail-fast: false matrix: - python-version: ["3.8", "3.9"] + python-version: ["3.8", "3.9", "3.10"] steps: - name: Checkout ${{ github.repository }}/${{ github.ref }} uses: actions/checkout@v2 diff --git a/scripts/requirements.txt b/scripts/requirements.txt index 953062af..50cbb87f 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -10,19 +10,21 @@ # Creating AutoSplit.exe with PyInstaller: .\scripts\build.bat # # Dependencies: +numpy>=1.22.0rc1 +opencv-python>=4.5.4 +PyQt6>=6.2.1 +PySide6 ImageHash keyboard -numpy>=1.22.0rc1 -opencv-python packaging Pillow -PyQt6 -PyQt6-tools -PySide6 pyautogui pywin32 requests certifi +toml +# Not compatible with python 3.10 yet +# PyQt6-tools # Linting and Types bandit flake8 @@ -33,6 +35,5 @@ pywin32-stubs simplejson types-simplejson>=3.17.2 types-requests -# # Comment this out if you don't want to build AutoSplit.exe: PyInstaller diff --git a/src/capture_windows.py b/src/capture_windows.py index 9d64c059..94653a81 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -56,7 +56,7 @@ def capture_region(hwnd: int, selection: Region, print_window: bool): if print_window: ctypes.windll.user32.PrintWindow(hwnd, dc_object.GetSafeHdc(), PW_RENDERFULLCONTENT) - compatible_dc = cast(PyCDC, dc_object.CreateCompatibleDC()) + compatible_dc = dc_object.CreateCompatibleDC() bitmap: PyCBitmap = win32ui.CreateBitmap() bitmap.CreateCompatibleBitmap(dc_object, selection["width"], selection["height"]) compatible_dc.SelectObject(bitmap) diff --git a/typings/pythonwin-stubs/win32typing.pyi b/typings/win32typing/__init__.pyi similarity index 73% rename from typings/pythonwin-stubs/win32typing.pyi rename to typings/win32typing/__init__.pyi index e5b83b65..4dd08321 100644 --- a/typings/pythonwin-stubs/win32typing.pyi +++ b/typings/win32typing/__init__.pyi @@ -591,196 +591,185 @@ __all__ = [ from typing import Any, Union -class COMMTIMEOUTS(object): +class COMMTIMEOUTS: """A tuple representing a COMMTIMEOUTS structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class CopyProgressRoutine(object): - """""" +class CopyProgressRoutine: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class DOCINFO(object): +class DOCINFO: """A tuple of information representing a DOCINFO struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def DocName(self) -> 'Union[str]': + def DocName(self) -> str: """Name of document""" - pass + ... @property - def Output(self) -> 'Union[str]': + def Output(self) -> str: """Name of output file when printing to file. Use None for normal printing.""" - pass + ... @property - def DataType(self) -> 'Union[str]': + def DataType(self) -> str: """Type of data to be sent to printer, eg RAW, EMF, TEXT. Use None for printer default.""" - pass + ... @property - def Type(self) -> 'Any': + def Type(self) -> Any: """Flag specifying mode of operation. Can be DI_APPBANDING, DI_ROPS_READ_DESTINATION, or 0""" - pass + ... -class ExportCallback(object): - """""" +class ExportCallback: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class FORM_INFO_1(object): +class FORM_INFO_1: """A dictionary containing FORM_INFO_1W data""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def Flags(self) -> 'Any': + def Flags(self) -> Any: """FORM_USER, FORM_BUILTIN, or FORM_PRINTER""" - pass + ... @property - def Name(self) -> 'str': + def Name(self) -> str: """Name of form""" - pass + ... @property - def Size(self) -> 'Any': + def Size(self) -> Any: """A dictionary representing a SIZEL structure {'cx':int,'cy':int}""" - pass + ... @property - def ImageableArea(self) -> 'Any': + def ImageableArea(self) -> Any: """A dictionary representing a RECTL structure {'left':int, 'top':int, 'right':int, 'bottom':int}""" - pass + ... -class ImportCallback(object): - """""" +class ImportCallback: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class LARGE_INTEGER(object): +class LARGE_INTEGER: """A Python object used wherever a COM LARGE_INTEGER is used.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class NCB(object): +class NCB: """A Python object that encapsulates a Win32 NCB structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def Command(self) -> 'Any': - """""" - pass + def Command(self) -> Any: + ... @property - def Retcode(self) -> 'Any': - """""" - pass + def Retcode(self) -> Any: + ... @property - def Lsn(self) -> 'Any': - """""" - pass + def Lsn(self) -> Any: + ... @property - def Num(self) -> 'Any': - """""" - pass + def Num(self) -> Any: + ... @property - def Bufflen(self) -> 'Any': + def Bufflen(self) -> Any: """read-only""" - pass + ... @property - def Callname(self) -> 'str': + def Callname(self) -> str: """- The strings need to be space padded to 16 chars exactly""" - pass + ... @property - def Name(self) -> 'str': + def Name(self) -> str: """- The strings need to be space padded to 16 chars exactly""" - pass + ... @property - def Rto(self) -> 'str': + def Rto(self) -> str: """- The strings need to be space padded to 16 chars exactly""" - pass + ... @property - def Sto(self) -> 'str': + def Sto(self) -> str: """- The strings need to be space padded to 16 chars exactly""" - pass + ... @property - def Lana_num(self) -> 'Any': - """""" - pass + def Lana_num(self) -> Any: + ... @property - def Cmd_cplt(self) -> 'Any': - """""" - pass + def Cmd_cplt(self) -> Any: + ... @property - def Event(self) -> 'Any': - """""" - pass + def Event(self) -> Any: + ... @property - def Post(self) -> 'Any': - """""" - pass + def Post(self) -> Any: + ... -class PRINTER_DEFAULTS(object): +class PRINTER_DEFAULTS: """A dictionary representing a PRINTER_DEFAULTS structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def pDatatype(self) -> 'str': + def pDatatype(self) -> str: """Data type to be used for print jobs, see win32print::EnumPrintProcessorDatatypes, optional, can be None""" - pass + ... @property - def pDevMode(self) -> 'PyDEVMODE': + def pDevMode(self) -> PyDEVMODE: """A PyDEVMODE that specifies default printer parameters, optional, can be None""" - pass + ... @property - def DesiredAccess(self) -> 'Any': + def DesiredAccess(self) -> Any: """An ACCESS_MASK specifying what level of access is needed, eg PRINTER_ACCESS_ADMINISTER, PRINTER_ACCESS_USE""" - pass + ... -class PyACL(object): +class PyACL: """A Python object, representing a ACL structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Initialize(self,) -> 'None': + def Initialize(self) -> None: """ Initialize the ACL. @@ -793,9 +782,9 @@ Returns: None """ - pass + ... - def IsValid(self,) -> 'None': + def IsValid(self) -> None: """ Determines if the ACL is valid (IsValidAcl) @@ -808,9 +797,9 @@ Returns: None """ - pass + ... - def AddAccessAllowedAce(self, revision: 'Any', access: 'Any', sid: 'PySID', access1: 'Any', sid1: 'Any') -> 'None': + def AddAccessAllowedAce(self, revision: Any, access: Any, sid: PySID, access1: Any, sid1: Any) -> None: """ Adds an access-allowed ACE to an DACL object. The access is granted to a @@ -829,9 +818,9 @@ Returns: None """ - pass + ... - def AddAccessAllowedAceEx(self, revision: 'Any', aceflags: 'Any', access: 'Any', sid: 'PySID') -> 'None': + def AddAccessAllowedAceEx(self, revision: Any, aceflags: Any, access: Any, sid: PySID) -> None: """ Add access allowed ACE to an ACL with ACE flags (Requires Win2k or higher) @@ -847,16 +836,16 @@ Returns: None """ - pass + ... def AddAccessAllowedObjectAce( self, - AceRevision: 'Any', - AceFlags: 'Any', - AccessMask: 'Any', - ObjectTypeGuid: 'PyIID', - InheritedObjectTypeGuid: 'PyIID', - sid: 'PySID') -> 'None': + AceRevision: Any, + AceFlags: Any, + AccessMask: Any, + ObjectTypeGuid: PyIID, + InheritedObjectTypeGuid: PyIID, + sid: PySID) -> None: """ Adds an ACCESS_ALLOWED_OBJECT_ACE to the ACL @@ -874,9 +863,9 @@ Returns: None """ - pass + ... - def AddAccessDeniedAce(self, revision: 'Any', access: 'Any', sid: 'PySID', access1: 'Any', sid1: 'Any') -> 'None': + def AddAccessDeniedAce(self, revision: Any, access: Any, sid: PySID, access1: Any, sid1: Any) -> None: """ Adds an access-denied ACE to an ACL object. The access is denied to a specified @@ -895,9 +884,9 @@ Returns: None """ - pass + ... - def AddAccessDeniedAceEx(self, revision: 'Any', aceflags: 'Any', access: 'Any', sid: 'PySID') -> 'None': + def AddAccessDeniedAceEx(self, revision: Any, aceflags: Any, access: Any, sid: PySID) -> None: """ Add access denied ACE to an ACL with ACE flags (Requires Win2k or higher) @@ -913,9 +902,9 @@ Returns: None """ - pass + ... - def AddMandatoryAce(self, AceRevision: 'Any', AceFlags: 'Any', MandatoryPolicy: 'Any', LabelSid: 'PySID') -> 'None': + def AddMandatoryAce(self, AceRevision: Any, AceFlags: Any, MandatoryPolicy: Any, LabelSid: PySID) -> None: """ Adds a mandatory integrity level ACE to a SACL @@ -931,15 +920,15 @@ Returns: None """ - pass + ... def AddAuditAccessAce( self, - dwAceRevision: 'Any', - dwAccessMask: 'Any', - sid: 'PySID', - bAuditSuccess: 'Any', - bAuditFailure: 'Any') -> 'None': + dwAceRevision: Any, + dwAccessMask: Any, + sid: PySID, + bAuditSuccess: Any, + bAuditFailure: Any) -> None: """ Adds an audit ACE to a Sacl @@ -956,16 +945,16 @@ Returns: None """ - pass + ... def AddAuditAccessAceEx( self, - dwAceRevision: 'Any', - AceFlags: 'Any', - dwAccessMask: 'Any', - sid: 'PySID', - bAuditSuccess: 'Any', - bAuditFailure: 'Any') -> 'None': + dwAceRevision: Any, + AceFlags: Any, + dwAccessMask: Any, + sid: PySID, + bAuditSuccess: Any, + bAuditFailure: Any) -> None: """ Adds an audit ACE to an Sacl, includes ace flags @@ -983,18 +972,18 @@ Returns: None """ - pass + ... def AddAuditAccessObjectAce( self, - dwAceRevision: 'Any', - AceFlags: 'Any', - dwAccessMask: 'Any', - ObjectTypeGuid: 'PyIID', - InheritedObjectTypeGuid: 'PyIID', - sid: 'PySID', - bAuditSuccess: 'Any', - bAuditFailure: 'Any') -> 'None': + dwAceRevision: Any, + AceFlags: Any, + dwAccessMask: Any, + ObjectTypeGuid: PyIID, + InheritedObjectTypeGuid: PyIID, + sid: PySID, + bAuditSuccess: Any, + bAuditFailure: Any) -> None: """ Adds an audit ACE for an object type identified by GUID @@ -1014,9 +1003,9 @@ Returns: None """ - pass + ... - def GetAclSize(self,) -> 'Any': + def GetAclSize(self) -> Any: """ Returns the storage size of the ACL. @@ -1029,9 +1018,9 @@ Returns: Any """ - pass + ... - def GetAclRevision(self,) -> 'Any': + def GetAclRevision(self) -> Any: """ Returns revision of the ACL. @@ -1044,9 +1033,9 @@ Returns: Any """ - pass + ... - def GetAceCount(self,) -> 'Any': + def GetAceCount(self) -> Any: """ Returns the number of ACEs in the ACL. @@ -1059,9 +1048,9 @@ Returns: Any """ - pass + ... - def GetAce(self, index: 'Any') -> 'Any': + def GetAce(self, index: Any) -> Any: """ Gets an Ace from the ACL @@ -1095,9 +1084,9 @@ For details see the API documentation. """ - pass + ... - def DeleteAce(self, index: 'Any') -> 'None': + def DeleteAce(self, index: Any) -> None: """ Deletes specified Ace from an ACL. @@ -1110,9 +1099,9 @@ Returns: None """ - pass + ... - def GetEffectiveRightsFromAcl(self, trustee: 'PyTRUSTEE') -> 'Any': + def GetEffectiveRightsFromAcl(self, trustee: PyTRUSTEE) -> Any: """ Return access rights (ACCESS_MASK) that the ACL grants to @@ -1127,9 +1116,9 @@ Returns: Any """ - pass + ... - def GetAuditedPermissionsFromAcl(self, trustee: 'PyTRUSTEE') -> 'Tuple[Any, Any]': + def GetAuditedPermissionsFromAcl(self, trustee: PyTRUSTEE) -> Tuple[Any, Any]: """ Return types of access for @@ -1144,42 +1133,37 @@ Returns: Tuple[Any, Any] """ - pass + ... -class PyBITMAP(object): +class PyBITMAP: """A Python object, representing an PyBITMAP structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def bmType(self) -> 'int': - """""" - pass + def bmType(self) -> int: + ... @property - def bmWidth(self) -> 'int': - """""" - pass + def bmWidth(self) -> int: + ... @property - def bmHeight(self) -> 'int': - """""" - pass + def bmHeight(self) -> int: + ... @property - def bmWidthBytes(self) -> 'int': - """""" - pass + def bmWidthBytes(self) -> int: + ... @property - def bmPlanes(self) -> 'int': - """""" - pass + def bmPlanes(self) -> int: + ... -class PyBLENDFUNCTION(object): +class PyBLENDFUNCTION: """Tuple of four small ints used to fill a BLENDFUNCTION struct Each int must fit in a byte (0-255).""" @@ -1188,25 +1172,25 @@ Each int must fit in a byte (0-255).""" raise Exception('This class just for typing, can not be instanced!') -class PyCEHANDLE(object): +class PyCEHANDLE: """A Python object, representing a remote Windows CE handle""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyCERTSTORE(object): +class PyCERTSTORE: """Handle to a certificate store""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def HCERTSTORE(self) -> 'Any': + def HCERTSTORE(self) -> Any: """Integer handle""" - pass + ... - def CertCloseStore(self, Flags: 'Any' = 0) -> 'None': + def CertCloseStore(self, Flags: Any = 0) -> None: """ Closes the certificate store @@ -1219,9 +1203,9 @@ Returns: None """ - pass + ... - def CertControlStore(self, Flags: 'Any', CtrlType: 'Any', CtrlPara: 'int') -> 'None': + def CertControlStore(self, Flags: Any, CtrlType: Any, CtrlPara: int) -> None: """ Controls sychronization of the certificate store @@ -1236,9 +1220,9 @@ Returns: None """ - pass + ... - def CertEnumCertificatesInStore(self,) -> 'List[PyCERT_CONTEXT]': + def CertEnumCertificatesInStore(self) -> List[PyCERT_CONTEXT]: """ Lists all certificates in the store @@ -1251,9 +1235,9 @@ Returns: List[PyCERT_CONTEXT] """ - pass + ... - def CertEnumCTLsInStore(self,) -> 'List[PyCTL_CONTEXT]': + def CertEnumCTLsInStore(self) -> List[PyCTL_CONTEXT]: """ Finds all Certificate Trust Lists in store @@ -1266,15 +1250,15 @@ Returns: List[PyCTL_CONTEXT] """ - pass + ... def CertSaveStore( self, - MsgAndCertEncodingType: 'Any', - SaveAs: 'Any', - SaveTo: 'Any', - SaveToPara: 'Union[str, int]', - Flags: 'Any' = 0) -> 'None': + MsgAndCertEncodingType: Any, + SaveAs: Any, + SaveTo: Any, + SaveToPara: Union[str, int], + Flags: Any = 0) -> None: """ Serializes the store to memory or a file @@ -1291,13 +1275,13 @@ Returns: None """ - pass + ... def CertAddEncodedCertificateToStore( self, - CertEncodingType: 'Any', - CertEncoded: 'Any', - AddDisposition: 'Any') -> 'PyCERT_CONTEXT': + CertEncodingType: Any, + CertEncoded: Any, + AddDisposition: Any) -> PyCERT_CONTEXT: """ Imports an encoded certificate into the @@ -1314,10 +1298,10 @@ Returns: PyCERT_CONTEXT """ - pass + ... - def CertAddCertificateContextToStore(self, CertContext: 'PyCERT_CONTEXT', - AddDisposition: 'Any') -> 'PyCERT_CONTEXT': + def CertAddCertificateContextToStore(self, CertContext: PyCERT_CONTEXT, + AddDisposition: Any) -> PyCERT_CONTEXT: """ Adds a certificate context to the store @@ -1331,9 +1315,9 @@ Returns: PyCERT_CONTEXT """ - pass + ... - def CertAddCertificateLinkToStore(self, CertContext: 'PyCERT_CONTEXT', AddDisposition: 'Any') -> 'PyCERT_CONTEXT': + def CertAddCertificateLinkToStore(self, CertContext: PyCERT_CONTEXT, AddDisposition: Any) -> PyCERT_CONTEXT: """ Adds a link to a cert in another store @@ -1347,9 +1331,9 @@ Returns: PyCERT_CONTEXT """ - pass + ... - def CertAddCTLContextToStore(self, CtlContext: 'PyCTL_CONTEXT', AddDisposition: 'Any') -> 'PyCTL_CONTEXT': + def CertAddCTLContextToStore(self, CtlContext: PyCTL_CONTEXT, AddDisposition: Any) -> PyCTL_CONTEXT: """ Adds a certificate trust list to the store @@ -1363,9 +1347,9 @@ Returns: PyCTL_CONTEXT """ - pass + ... - def CertAddCTLLinkToStore(self, CtlContext: 'PyCTL_CONTEXT', AddDisposition: 'Any') -> 'PyCTL_CONTEXT': + def CertAddCTLLinkToStore(self, CtlContext: PyCTL_CONTEXT, AddDisposition: Any) -> PyCTL_CONTEXT: """ Adds a link to a CTL in another store @@ -1379,13 +1363,13 @@ Returns: PyCTL_CONTEXT """ - pass + ... def CertAddStoreToCollection( self, - SiblingStore: 'PyCERTSTORE', - UpdateFlag: 'Any' = 0, - Priority: 'Any' = 0) -> 'None': + SiblingStore: PyCERTSTORE, + UpdateFlag: Any = 0, + Priority: Any = 0) -> None: """ Adds a sibling store to a store collection @@ -1400,9 +1384,9 @@ Returns: None """ - pass + ... - def CertRemoveStoreFromCollection(self, SiblingStore: 'PyCERTSTORE') -> 'None': + def CertRemoveStoreFromCollection(self, SiblingStore: PyCERTSTORE) -> None: """ Removes a sibling store from a collection @@ -1415,182 +1399,181 @@ Returns: None """ - pass + ... - def PFXExportCertStoreEx(self, Flags: 'Any', Password: 'Any' = None) -> 'Any': + def PFXExportCertStoreEx(self, Flags: Any, password: Any = None) -> Any: """ Exports certificates and associated private keys in PKCS#12 format Args: Flags(Any):Options to be used while exporting - Password(Any):Passphrase to be used to encrypt the output + password(Any):passphrase to be used to encrypt the output Returns: Any """ - pass + ... -class PyCERT_ALT_NAME_ENTRY(object): +class PyCERT_ALT_NAME_ENTRY: """Represented as a 2-tuple""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyCERT_ALT_NAME_INFO(object): - """""" +class PyCERT_ALT_NAME_INFO: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyCERT_AUTHORITY_KEY_ID_INFO(object): +class PyCERT_AUTHORITY_KEY_ID_INFO: """Dict containing the identity of a CA""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def KeyId(self) -> 'Any': + def KeyId(self) -> Any: """Unique identifier of private key, usually a hash""" - pass + ... @property - def CertIssuer(self) -> 'Any': + def CertIssuer(self) -> Any: """Encoded DN of the Certificate Authority. Decode using X509_UNICODE_NAME""" - pass + ... @property - def CertSerialNumber(self) -> 'Any': + def CertSerialNumber(self) -> Any: """Serial nbr of the CA's signing certificate""" - pass + ... -class PyCERT_BASIC_CONSTRAINTS2_INFO(object): +class PyCERT_BASIC_CONSTRAINTS2_INFO: """Dict representing a CERT_BASIC_CONSTRAINTS2_INFO struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def fCA(self) -> 'Any': + def fCA(self) -> Any: """Indicates if cert represents a certificate authority""" - pass + ... @property - def fPathLenConstraint(self) -> 'Any': + def fPathLenConstraint(self) -> Any: """Indicates if PathLenConstraint member is used""" - pass + ... @property - def PathLenConstraint(self) -> 'Any': + def PathLenConstraint(self) -> Any: """Limits number of intermediate CA's between root CA and end user""" - pass + ... -class PyCERT_BASIC_CONSTRAINTS_INFO(object): +class PyCERT_BASIC_CONSTRAINTS_INFO: """Dict representing a CERT_BASIC_CONSTRAINTS_INFO struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def SubjectType(self) -> 'PyCRYPT_BIT_BLOB': + def SubjectType(self) -> PyCRYPT_BIT_BLOB: """Contains a combination of CERT_CA_SUBJECT_FLAG,CERT_END_ENTITY_SUBJECT_FLAG""" - pass + ... @property - def fPathLenConstraint(self) -> 'Any': + def fPathLenConstraint(self) -> Any: """Indicates if PathLenConstraint member is used""" - pass + ... @property - def PathLenConstraint(self) -> 'Any': + def PathLenConstraint(self) -> Any: """Limits number of intermediate CA's between root CA and end user""" - pass + ... @property - def SubtreesConstraint(self) -> 'Any': + def SubtreesConstraint(self) -> Any: """Sequence of encoded name blobs""" - pass + ... -class PyCERT_CONTEXT(object): +class PyCERT_CONTEXT: """Handle to a certificate context""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def HANDLE(self) -> 'Any': + def HANDLE(self) -> Any: """Pointer to CERT_CONTEXT struct""" - pass + ... @property - def CertStore(self) -> 'PyCERTSTORE': + def CertStore(self) -> PyCERTSTORE: """Handle to the certificate store that contains this certificate""" - pass + ... @property - def CertEncoded(self) -> 'Any': + def CertEncoded(self) -> Any: """Content of the certificate as encoded bytes""" - pass + ... @property - def CertEncodingType(self) -> 'Any': + def CertEncodingType(self) -> Any: """Method used to encode the certifcate, usually X509_ASN_ENCODING or PKCS_7_ASN_ENCODING""" - pass + ... @property - def Version(self) -> 'Any': + def Version(self) -> Any: """One of the CERT_V* values""" - pass + ... @property - def Subject(self) -> 'str': + def Subject(self) -> str: """Encoded CERT_NAME_INFO struct containing the subject name. Can be decoded using cryptoapi::CryptDecodeObjectEx with X509_UNICODE_NAME, or formatted using cryptoapi::CertNameToStr""" - pass + ... @property - def Issuer(self) -> 'str': + def Issuer(self) -> str: """Certificate Authority that issued certificate as encoded CERT_NAME_INFO. Use cryptoapi::CryptDecodeObjectEx to decode into individual components, or cryptoapi::CertNameToStr to return a single formatted string""" - pass + ... @property - def NotBefore(self) -> 'PyTime': + def NotBefore(self) -> PyTime: """Beginning of certificate's period of validity""" - pass + ... @property - def NotAfter(self) -> 'PyTime': + def NotAfter(self) -> PyTime: """End of certificate's period of validity""" - pass + ... @property - def SignatureAlgorithm(self) -> 'Any': + def SignatureAlgorithm(self) -> Any: """Object id of the certifcate's signature algorithm""" - pass + ... @property - def Extension(self) -> 'Tuple[PyCERT_EXTENSION, ...]': + def Extension(self) -> Tuple[PyCERT_EXTENSION, ...]: """Sequence of CERT_EXTENSION dicts containing certificate's extensions""" - pass + ... @property - def SubjectPublicKeyInfo(self) -> 'PyCERT_PUBLIC_KEY_INFO': + def SubjectPublicKeyInfo(self) -> PyCERT_PUBLIC_KEY_INFO: """Encoded public key of certificate""" - pass + ... @property - def SerialNumber(self) -> 'Any': + def SerialNumber(self) -> Any: """Serial number assigned by the issuer""" - pass + ... - def CertFreeCertificateContext(self,) -> 'None': + def CertFreeCertificateContext(self) -> None: """ Frees the certificate context @@ -1603,9 +1586,9 @@ Returns: None """ - pass + ... - def CertEnumCertificateContextProperties(self,) -> 'List[Any]': + def CertEnumCertificateContextProperties(self) -> List[Any]: """ Lists property ids for the certificate @@ -1618,9 +1601,9 @@ Returns: List[Any] """ - pass + ... - def CryptAcquireCertificatePrivateKey(self, Flags: 'Any' = 0) -> 'Tuple[Any, PyCRYPTPROV]': + def CryptAcquireCertificatePrivateKey(self, Flags: Any = 0) -> Tuple[Any, PyCRYPTPROV]: """ Retrieves the private key associated @@ -1640,9 +1623,9 @@ Return ValueReturns the KeySpec (AT_KEYEXCHANGE or AT_SIGNATURE) and a CSP handl """ - pass + ... - def CertGetIntendedKeyUsage(self,) -> 'Any': + def CertGetIntendedKeyUsage(self) -> Any: """ Returns the intended key usage from the certificate extensions @@ -1663,9 +1646,9 @@ Return ValueReturns a combination of CERT_*_KEY_USAGE values """ - pass + ... - def CertGetEnhancedKeyUsage(self, Flags: 'Any' = 0) -> 'Any': + def CertGetEnhancedKeyUsage(self, Flags: Any = 0) -> Any: """ Finds the enhanced key usage property and/or extension for the @@ -1684,9 +1667,9 @@ Return ValueReturns a sequence of usage OIDs """ - pass + ... - def CertSerializeCertificateStoreElement(self, Flags: 'Any' = 0) -> 'str': + def CertSerializeCertificateStoreElement(self, Flags: Any = 0) -> str: """ Serializes the certificate and its properties @@ -1699,9 +1682,9 @@ Returns: str """ - pass + ... - def CertVerifySubjectCertificateContext(self, Issuer: 'PyCERT_CONTEXT', Flags: 'Any') -> 'Any': + def CertVerifySubjectCertificateContext(self, Issuer: PyCERT_CONTEXT, Flags: Any) -> Any: """ Checks the validity of the certificate @@ -1718,9 +1701,9 @@ CERT_STORE_TIME_VALIDITY_FLAG indicating which checks should be performedReturn """ - pass + ... - def CertDeleteCertificateFromStore(self,) -> 'None': + def CertDeleteCertificateFromStore(self) -> None: """ Removes the certificate from its store @@ -1733,9 +1716,9 @@ Returns: None """ - pass + ... - def CertGetCertificateContextProperty(self, PropId: 'Any') -> 'Any': + def CertGetCertificateContextProperty(self, PropId: Any) -> Any: """ Retrieves the specified property from the @@ -1799,9 +1782,9 @@ Return ValueType of object returned is dependent on the property id requested. """ - pass + ... - def CertSetCertificateContextProperty(self, PropId: 'Any', Data: 'Any', Flags: 'Any' = 0) -> 'None': + def CertSetCertificateContextProperty(self, PropId: Any, Data: Any, Flags: Any = 0) -> None: """ Sets a property for a certificate @@ -1816,68 +1799,68 @@ Returns: None """ - pass + ... -class PyCERT_EXTENSION(object): +class PyCERT_EXTENSION: """Dict containing a certificate extension""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def ObjId(self) -> 'Any': + def ObjId(self) -> Any: """The OID identifying the type of extension""" - pass + ... @property - def Critical(self) -> 'Any': + def Critical(self) -> Any: """If true, any contraints or limits contained in the extension should be considered absolute""" - pass + ... @property - def Value(self) -> 'Any': + def Value(self) -> Any: """Binary string containing ASN encoded data. To interpret or display extension data, see cryptoapi::CryptDecodeObjectEx and cryptoapi::CryptFormatObject.""" - pass + ... -class PyCERT_KEY_ATTRIBUTES_INFO(object): +class PyCERT_KEY_ATTRIBUTES_INFO: """Dict representing a CERT_KEY_ATTRIBUTES_INFO struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def KeyId(self) -> 'Any': + def KeyId(self) -> Any: """Usually a hash that uniquely identifies the key""" - pass + ... @property - def IntendedKeyUsage(self) -> 'PyCRYPT_BIT_BLOB': + def IntendedKeyUsage(self) -> PyCRYPT_BIT_BLOB: """Contains a byte with CERT_*_KEY_USAGE flags""" - pass + ... @property - def PrivateKeyUsagePeriod(self) -> 'Any': + def PrivateKeyUsagePeriod(self) -> Any: """Private key's begin and end effective dates, may be None""" - pass + ... -class PyCERT_NAME_INFO(object): +class PyCERT_NAME_INFO: """Sequence of CERT_RDN's""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyCERT_NAME_VALUE(object): +class PyCERT_NAME_VALUE: """Dict containing type (CERT_RDN_*) and a unicode string""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyCERT_OTHER_NAME(object): +class PyCERT_OTHER_NAME: """Dict containing {ObjId, Value}. ObjId is one of the string object id's identifying the type of name. @@ -1890,279 +1873,273 @@ using X509_UNICODE_NAME_VALUE to return the actual unicode string""" raise Exception('This class just for typing, can not be instanced!') -class PyCERT_POLICY_INFO(object): +class PyCERT_POLICY_INFO: """Dict containing a certificate policy""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def PolicyIdentifier(self) -> 'Any': + def PolicyIdentifier(self) -> Any: """OID identifying the policy""" - pass + ... @property - def PolicyQualifier(self) -> 'Any': + def PolicyQualifier(self) -> Any: """Sequence of CERT_POLICY_QUALIFIER dicts""" - pass + ... -class PyCERT_PUBLIC_KEY_INFO(object): +class PyCERT_PUBLIC_KEY_INFO: """Dict containing an exported public key""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def Algorithm(self) -> 'PyCRYPT_ALGORITHM_IDENTIFIER': + def Algorithm(self) -> PyCRYPT_ALGORITHM_IDENTIFIER: """Dict containing OID of the public key algorithm""" - pass + ... @property - def PublicKey(self) -> 'PyCRYPT_BIT_BLOB': + def PublicKey(self) -> PyCRYPT_BIT_BLOB: """Dict containing the encoded public key""" - pass + ... -class PyCOMSTAT(object): +class PyCOMSTAT: """A Python object, representing an COMSTAT structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def cbInQue(self) -> 'int': + def cbInQue(self) -> int: """Specifies the number of bytes received by the serial provider but not yet read by a win32file::ReadFile operation""" - pass + ... @property - def cbOutQue(self) -> 'int': + def cbOutQue(self) -> int: """Specifies the number of bytes of user data remaining to be transmitted for all write operations. This value will be zero for a nonoverlapped write.""" - pass + ... @property - def fCtsHold(self) -> 'int': + def fCtsHold(self) -> int: """Specifies whether transmission is waiting for the CTS (clear-to-send) signal to be sent. If this member is TRUE, transmission is waiting.""" - pass + ... @property - def fDsrHold(self) -> 'int': + def fDsrHold(self) -> int: """Specifies whether transmission is waiting for the DSR (data-set-ready) signal to be sent. If this member is TRUE, transmission is waiting.""" - pass + ... @property - def fRlsdHold(self) -> 'int': + def fRlsdHold(self) -> int: """Specifies whether transmission is waiting for the RLSD (receive-line-signal-detect) signal to be sent. If this member is TRUE, transmission is waiting.""" - pass + ... @property - def fXoffHold(self) -> 'int': + def fXoffHold(self) -> int: """Specifies whether transmission is waiting because the XOFF character was received. If this member is TRUE, transmission is waiting.""" - pass + ... @property - def fXoffSent(self) -> 'int': + def fXoffSent(self) -> int: """Specifies whether transmission is waiting because the XOFF character was transmitted. If this member is TRUE, transmission is waiting. Transmission halts when the XOFF character is transmitted to a system that takes the next character as XON, regardless of the actual character.""" - pass + ... @property - def fEof(self) -> 'int': + def fEof(self) -> int: """Specifies whether the end-of-file (EOF) character has been received. If this member is TRUE, the EOF character has been received.""" - pass + ... @property - def fTxim(self) -> 'int': + def fTxim(self) -> int: """If this member is TRUE, there is a character queued for transmission that has come to the communications device by way of the TransmitCommChar function. The communications device transmits such a character ahead of other characters in the device's output buffer.""" - pass + ... @property - def fReserved(self) -> 'int': + def fReserved(self) -> int: """Reserved; do not use.""" - pass + ... -class PyCOORD(object): +class PyCOORD: """Wrapper for a COORD struct. Create using PyCOORDType(X,Y)""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def X(self) -> 'Any': + def X(self) -> Any: """Horizontal coordinate""" - pass + ... @property - def Y(self) -> 'Any': + def Y(self) -> Any: """Vertical coordinate""" - pass + ... -class PyCREDENTIAL(object): +class PyCREDENTIAL: """A dictionary containing information for a CREDENTIAL struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def Flags(self) -> 'Any': + def Flags(self) -> Any: """Combination of CRED_FLAGS_PROMPT_NOW, CRED_FLAGS_USERNAME_TARGET""" - pass + ... @property - def Type(self) -> 'Any': + def Type(self) -> Any: """Type of credential, one of CRED_TYPE_* values""" - pass + ... @property - def TargetName(self) -> 'str': + def TargetName(self) -> str: """Target of credential, can end with * for wildcard matching""" - pass + ... @property - def Comment(self) -> 'str': + def Comment(self) -> str: """Descriptive text""" - pass + ... @property - def LastWritten(self) -> 'PyTime': + def LastWritten(self) -> PyTime: """Modification time, ignored on input""" - pass + ... @property - def CredentialBlob(self) -> 'str': + def CredentialBlob(self) -> str: """Contains password for username credential, or PIN for certificate credential. This member is write-only.""" - pass + ... @property - def Persist(self) -> 'Any': + def Persist(self) -> Any: """Specifies scope of persistence, one of CRED_PERSIST_* values""" - pass + ... @property - def Attributes(self) -> 'Any': + def Attributes(self) -> Any: """Tuple of PyCREDENTIAL_ATTRIBUTE dicts containing application-specific data, can be None""" - pass + ... @property - def TargetAlias(self) -> 'str': + def TargetAlias(self) -> str: """Alias for TargetName, only valid with CRED_TYPE_GENERIC""" - pass + ... @property - def UserName(self) -> 'str': + def UserName(self) -> str: """User to be authenticated by target. Can be of the form username@domain or domain\\username. For CRED_TYPE_DOMAIN_CERTIFICATE, use win32cred::CredMarshalCredential to marshal the SHA1 hash of user's certficate""" - pass + ... -class PyCREDENTIAL_ATTRIBUTE(object): +class PyCREDENTIAL_ATTRIBUTE: """A dictionary containing information for a CREDENTIAL_ATTRIBUTE struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def Keyword(self) -> 'str': + def Keyword(self) -> str: """Attribute name, at most CRED_MAX_STRING_LENGTH chars""" - pass + ... @property - def Flags(self) -> 'Any': + def Flags(self) -> Any: """Reserved, use only 0""" - pass + ... @property - def Value(self) -> 'Any': + def Value(self) -> Any: """Attribute value, at most CRED_MAX_VALUE_SIZE bytes. Unicode objects are treated as raw bytes.""" - pass + ... -class PyCREDENTIAL_TARGET_INFORMATION(object): +class PyCREDENTIAL_TARGET_INFORMATION: """A dictionary representing a CREDENTIAL_TARGET_INFORMATION struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def TargetName(self) -> 'str': + def TargetName(self) -> str: """Target of credentials""" - pass + ... @property - def NetbiosServerName(self) -> 'str': - """""" - pass + def NetbiosServerName(self) -> str: + ... @property - def DnsServerName(self) -> 'str': - """""" - pass + def DnsServerName(self) -> str: + ... @property - def NetbiosDomainName(self) -> 'str': - """""" - pass + def NetbiosDomainName(self) -> str: + ... @property - def DnsDomainName(self) -> 'str': - """""" - pass + def DnsDomainName(self) -> str: + ... @property - def DnsTreeName(self) -> 'str': - """""" - pass + def DnsTreeName(self) -> str: + ... @property - def PackageName(self) -> 'str': + def PackageName(self) -> str: """Name of security package which mapped TargetName""" - pass + ... @property - def Flags(self) -> 'Any': + def Flags(self) -> Any: """CRED_TI_* flags""" - pass + ... @property - def CredTypes(self) -> 'Tuple[Any, ...]': + def CredTypes(self) -> Tuple[Any, ...]: """Tuple of CRED_TYPE_* values indicating which types of credentials are acceptable to target""" - pass + ... -class PyCREDUI_INFO(object): - """""" +class PyCREDUI_INFO: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def Parent(self) -> 'int': + def Parent(self) -> int: """Handle to parent window, can be None""" - pass + ... @property - def MessageText(self) -> 'str': + def MessageText(self) -> str: """Message to appear in dialog""" - pass + ... @property - def CaptionText(self) -> 'str': + def CaptionText(self) -> str: """Title of the dialog window""" - pass + ... @property - def Banner(self) -> 'int': + def Banner(self) -> int: """Handle to a bitmap to be displayed""" - pass + ... -class PyCRYPTHASH(object): +class PyCRYPTHASH: """Handle to a cryptographic hash""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CryptDestroyHash(self,) -> 'None': + def CryptDestroyHash(self) -> None: """ Frees the hash object @@ -2175,9 +2152,9 @@ Returns: None """ - pass + ... - def CryptDuplicateHash(self, Flags: 'Any' = 0) -> 'PyCRYPTHASH': + def CryptDuplicateHash(self, Flags: Any = 0) -> PyCRYPTHASH: """ Clones the hash object @@ -2190,9 +2167,9 @@ Returns: PyCRYPTHASH """ - pass + ... - def CryptHashData(self, Data: 'str', Flags: 'Any' = 0) -> 'None': + def CryptHashData(self, Data: str, Flags: Any = 0) -> None: """ Adds data to the hash @@ -2206,9 +2183,9 @@ Returns: None """ - pass + ... - def CryptHashSessionKey(self, Key: 'PyCRYPTKEY', Flags: 'Any' = 0) -> 'None': + def CryptHashSessionKey(self, Key: PyCRYPTKEY, Flags: Any = 0) -> None: """ Hashes a session key @@ -2222,9 +2199,9 @@ Returns: None """ - pass + ... - def CryptSignHash(self, KeySpec: 'Any', Flags: 'Any' = 0) -> 'str': + def CryptSignHash(self, KeySpec: Any, Flags: Any = 0) -> str: """ Signs the hash @@ -2238,9 +2215,9 @@ Returns: str """ - pass + ... - def CryptVerifySignature(self, Signature: 'str', PubKey: 'PyCRYPTKEY', Flags: 'Any' = 0) -> 'None': + def CryptVerifySignature(self, Signature: str, PubKey: PyCRYPTKEY, Flags: Any = 0) -> None: """ Verifies that a signature matches hashed data @@ -2255,9 +2232,9 @@ Returns: None """ - pass + ... - def CryptGetHashParam(self, Param: 'Any', Flags: 'Any' = 0) -> 'Union[Any]': + def CryptGetHashParam(self, Param: Any, Flags: Any = 0) -> Any: """ Retrieves the specified attribute of the hash @@ -2268,7 +2245,7 @@ Args: Returns: - Union[Any]:Reserved, use 0 if passed in + Any:Reserved, use 0 if passed in Comments After this method has been called, no more data can be hashed @@ -2276,26 +2253,26 @@ Return ValueType of returned object is dependent on the Param passed in """ - pass + ... -class PyCRYPTKEY(object): +class PyCRYPTKEY: """Handle to a cryptographic key""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def HCRYPTPROV(self) -> 'Any': + def HCRYPTPROV(self) -> Any: """CSP used by the key""" - pass + ... @property - def HCRYPTKEY(self) -> 'Any': + def HCRYPTKEY(self) -> Any: """Plain integer handle to the key""" - pass + ... - def CryptDestroyKey(self,) -> 'None': + def CryptDestroyKey(self) -> None: """ Releases the handle to the key (does not delete permanent keys) @@ -2308,9 +2285,9 @@ Returns: None """ - pass + ... - def CryptExportKey(self, ExpKey: 'PyCRYPTKEY', BlobType: 'Any', Flags: 'Any' = 0) -> 'Any': + def CryptExportKey(self, ExpKey: PyCRYPTKEY, BlobType: Any, Flags: Any = 0) -> Any: """ Exports key or key pair as an encrypted blob @@ -2327,9 +2304,9 @@ Return ValueReturns a binary blob that can be imported via PyCRYPTPROV::CryptImp """ - pass + ... - def CryptGetKeyParam(self, Param: 'Any', Flags: 'Any' = 0) -> 'Any': + def CryptGetKeyParam(self, Param: Any, Flags: Any = 0) -> Any: """ Retrieves key parameters @@ -2345,9 +2322,9 @@ Return ValueType of returned object is dependent on the requested attribute """ - pass + ... - def CryptDuplicateKey(self, Reserved: 'Any' = 0, Flags: 'Any' = 0) -> 'PyCRYPTKEY': + def CryptDuplicateKey(self, Reserved: Any = 0, Flags: Any = 0) -> PyCRYPTKEY: """ Creates an independent copy of the key @@ -2361,9 +2338,9 @@ Returns: PyCRYPTKEY """ - pass + ... - def CryptEncrypt(self, Final: 'Any', Data: 'Any', Hash: 'PyCRYPTHASH' = None, Flags: 'Any' = 0) -> 'Any': + def CryptEncrypt(self, Final: Any, Data: Any, Hash: PyCRYPTHASH = None, Flags: Any = 0) -> Any: """ Encrypts and optionally hashes data @@ -2379,9 +2356,9 @@ Returns: Any """ - pass + ... - def CryptDecrypt(self, Final: 'Any', Data: 'Any', Hash: 'PyCRYPTHASH' = None, Flags: 'Any' = 0) -> 'Any': + def CryptDecrypt(self, Final: Any, Data: Any, Hash: PyCRYPTHASH = None, Flags: Any = 0) -> Any: """ Decrypts data @@ -2397,21 +2374,21 @@ Returns: Any """ - pass + ... -class PyCRYPTMSG(object): +class PyCRYPTMSG: """Wrapper for a cryptographic message handle""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def HCRYPTMSG(self) -> 'Any': + def HCRYPTMSG(self) -> Any: """Raw message handle""" - pass + ... - def CryptMsgClose(self,) -> 'None': + def CryptMsgClose(self) -> None: """ Closes the message handle @@ -2424,23 +2401,22 @@ Returns: None """ - pass + ... -class PyCRYPTPROTECT_PROMPTSTRUCT(object): +class PyCRYPTPROTECT_PROMPTSTRUCT: """A tuple representing a CRYPTPROTECT_PROMPTSTRUCT structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyCRYPTPROV(object): - """""" +class PyCRYPTPROV: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CryptReleaseContext(self, Flags: 'Any' = 0) -> 'None': + def CryptReleaseContext(self, Flags: Any = 0) -> None: """ Releases the CSP handle @@ -2453,9 +2429,9 @@ Returns: None """ - pass + ... - def CryptGenKey(self, Algid: 'Any', Flags: 'Any', KeyLen: 'Any' = 0) -> 'PyCRYPTKEY': + def CryptGenKey(self, Algid: Any, Flags: Any, KeyLen: Any = 0) -> PyCRYPTKEY: """ Generates a key pair or a session key @@ -2470,9 +2446,9 @@ Returns: PyCRYPTKEY """ - pass + ... - def CryptGetProvParam(self, Param: 'Any', Flags: 'Any' = 0) -> 'None': + def CryptGetProvParam(self, Param: Any, Flags: Any = 0) -> None: """ Retrieves specified attribute of provider @@ -2490,9 +2466,9 @@ Return ValueType of returned object is dependent on the attribute requested """ - pass + ... - def CryptGetUserKey(self, KeySpec: 'Any') -> 'PyCRYPTKEY': + def CryptGetUserKey(self, KeySpec: Any) -> PyCRYPTKEY: """ Returns a handle to one of user's key pairs @@ -2505,9 +2481,9 @@ Returns: PyCRYPTKEY """ - pass + ... - def CryptGenRandom(self, Len: 'Any', SeedData: 'str' = None) -> 'str': + def CryptGenRandom(self, Len: Any, SeedData: str = None) -> str: """ Generates random data of specified length @@ -2521,9 +2497,9 @@ Returns: str """ - pass + ... - def CryptCreateHash(self, Algid: 'Any', Key: 'PyCRYPTKEY' = None, Flags: 'Any' = 0) -> 'PyCRYPTHASH': + def CryptCreateHash(self, Algid: Any, Key: PyCRYPTKEY = None, Flags: Any = 0) -> PyCRYPTHASH: """ Creates a hash object for hashing large amounts of data @@ -2538,9 +2514,9 @@ Returns: PyCRYPTHASH """ - pass + ... - def CryptImportKey(self, Data: 'Any', PubKey: 'PyCRYPTKEY' = None, Flags: 'Any' = 0) -> 'PyCRYPTKEY': + def CryptImportKey(self, Data: Any, PubKey: PyCRYPTKEY = None, Flags: Any = 0) -> PyCRYPTKEY: """ None @@ -2555,9 +2531,9 @@ Returns: PyCRYPTKEY """ - pass + ... - def CryptExportPublicKeyInfo(self, KeySpec: 'Any', CertEncodingType: 'Any') -> 'PyCERT_PUBLIC_KEY_INFO': + def CryptExportPublicKeyInfo(self, KeySpec: Any, CertEncodingType: Any) -> PyCERT_PUBLIC_KEY_INFO: """ Exports a public key to send to other users @@ -2573,9 +2549,9 @@ Returns: PyCERT_PUBLIC_KEY_INFO """ - pass + ... - def CryptImportPublicKeyInfo(self, Info: 'Any', CertEncodingType: 'Any') -> 'PyCRYPTKEY': + def CryptImportPublicKeyInfo(self, Info: Any, CertEncodingType: Any) -> PyCRYPTKEY: """ Imports another user's public key @@ -2589,10 +2565,10 @@ Returns: PyCRYPTKEY """ - pass + ... -class PyCRYPT_ALGORITHM_IDENTIFIER(object): +class PyCRYPT_ALGORITHM_IDENTIFIER: """Dictionary containing information that identifies an encryption algorithm and any extra parameters it requires""" @@ -2601,205 +2577,202 @@ algorithm and any extra parameters it requires""" raise Exception('This class just for typing, can not be instanced!') @property - def ObjId(self) -> 'Any': + def ObjId(self) -> Any: """An szOID_* string identifying the algorithm""" - pass + ... @property - def Parameters(self) -> 'Any': + def Parameters(self) -> Any: """Blob of binary data containing encoded parameters""" - pass + ... -class PyCRYPT_ATTRIBUTE(object): +class PyCRYPT_ATTRIBUTE: """Dict representing a CRYPT_ATTRIBUTE struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def ObjId(self) -> 'Any': + def ObjId(self) -> Any: """An szOID_* string identifying the attribute""" - pass + ... @property - def Value(self) -> 'Tuple[Any, ...]': + def Value(self) -> Tuple[Any, ...]: """A sequence of buffers containing the attribute values""" - pass + ... -class PyCRYPT_BIT_BLOB(object): +class PyCRYPT_BIT_BLOB: """Dict containing raw data of a certain bit length""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def Data(self) -> 'Any': + def Data(self) -> Any: """Binary data""" - pass + ... @property - def UnusedBits(self) -> 'Any': + def UnusedBits(self) -> Any: """Nbr of bits of last byte that are unused""" - pass + ... -class PyCRYPT_DECRYPT_MESSAGE_PARA(object): - """""" +class PyCRYPT_DECRYPT_MESSAGE_PARA: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def CertStores(self) -> 'Tuple[Any, ...]': + def CertStores(self) -> Tuple[Any, ...]: """Sequence of certificate stores to be searched for a certificate with a private key that can be used to decrypt the message""" - pass + ... @property - def MsgAndCertEncodingType(self) -> 'Any': + def MsgAndCertEncodingType(self) -> Any: """Encoding types, optional. Defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" - pass + ... @property - def Flags(self) -> 'Any': + def Flags(self) -> Any: """Optional. CRYPT_MESSAGE_SILENT_KEYSET_FLAG can be used to suppress any dialogs that might be triggered by accessing a key container, such as a request for a PIN.""" - pass + ... -class PyCRYPT_ENCRYPT_MESSAGE_PARA(object): - """""" +class PyCRYPT_ENCRYPT_MESSAGE_PARA: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def ContentEncryptionAlgorithm(self) -> 'PyCRYPT_ALGORITHM_IDENTIFIER': + def ContentEncryptionAlgorithm(self) -> PyCRYPT_ALGORITHM_IDENTIFIER: """Identifies the algorithm to be used""" - pass + ... @property - def CryptProv(self) -> 'PyCRYPTPROV': + def CryptProv(self) -> PyCRYPTPROV: """Optional. Handle to provider that will perform encryption, can be None for default provider""" - pass + ... @property - def EncryptionAuxInfo(self) -> 'Any': + def EncryptionAuxInfo(self) -> Any: """Optional. Extra info required by some CSP's. Not supported yet, use only None""" - pass + ... @property - def Flags(self) -> 'Any': + def Flags(self) -> Any: """Optional. Combination of CRYPT_MESSAGE_*_FLAG constants""" - pass + ... @property - def InnerContentType(self) -> 'Any': + def InnerContentType(self) -> Any: """Optional. Only used if message to be encrypted is already encoded""" - pass + ... @property - def MsgEncodingType(self) -> 'Any': + def MsgEncodingType(self) -> Any: """Optional. Defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" - pass + ... -class PyCRYPT_SIGN_MESSAGE_PARA(object): +class PyCRYPT_SIGN_MESSAGE_PARA: """Dict of parms defining how a message will be signed""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def SigningCert(self) -> 'PyCERT_CONTEXT': + def SigningCert(self) -> PyCERT_CONTEXT: """Certficate to be used to sign message""" - pass + ... @property - def HashAlgorithm(self) -> 'PyCRYPT_ALGORITHM_IDENTIFIER': + def HashAlgorithm(self) -> PyCRYPT_ALGORITHM_IDENTIFIER: """Algorithm to be used for signed hash""" - pass + ... @property - def HashAuxInfo(self) -> 'Any': + def HashAuxInfo(self) -> Any: """Optional. Param is reserved, use only None.""" - pass + ... @property - def MsgCert(self) -> 'Tuple[PyCERT_CONTEXT, ...]': + def MsgCert(self) -> Tuple[PyCERT_CONTEXT, ...]: """Optional sequence of certificate to be included in the message.""" - pass + ... @property - def MsgCrl(self) -> 'Tuple[Any, ...]': + def MsgCrl(self) -> Tuple[Any, ...]: """Optional. Sequence of certificate revocation lists. Not yet supported, use only None.""" - pass + ... @property - def AuthAttr(self) -> 'Tuple[PyCRYPT_ATTRIBUTE, ...]': + def AuthAttr(self) -> Tuple[PyCRYPT_ATTRIBUTE, ...]: """Sequence of canonical attributes to be added to the message""" - pass + ... @property - def UnauthAttr(self) -> 'Tuple[PyCRYPT_ATTRIBUTE, ...]': + def UnauthAttr(self) -> Tuple[PyCRYPT_ATTRIBUTE, ...]: """Sequence of arbitrary attributes""" - pass + ... @property - def Flags(self) -> 'Any': + def Flags(self) -> Any: """Optional CRYPT_MESSAGE_*_FLAG that indicates content type if output is to be further encoded.""" - pass + ... @property - def InnerContentType(self) -> 'Any': + def InnerContentType(self) -> Any: """Optional, one of the CMSG_* content types if message is already encoded, .""" - pass + ... @property - def MsgEncodingType(self) -> 'Any': + def MsgEncodingType(self) -> Any: """Encoding types, optional. Defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" - pass + ... -class PyCRYPT_VERIFY_MESSAGE_PARA(object): - """""" +class PyCRYPT_VERIFY_MESSAGE_PARA: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def MsgAndCertEncodingType(self) -> 'Any': + def MsgAndCertEncodingType(self) -> Any: """Encoding types, defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" - pass + ... @property - def CryptProv(self) -> 'PyCRYPTPROV': + def CryptProv(self) -> PyCRYPTPROV: """CSP to be used to verify signature. Use None for default provider.""" - pass + ... @property - def PyGetSignerCertificate(self) -> 'Any': + def PyGetSignerCertificate(self) -> Any: """Callback function that locates signer's certificate.""" - pass + ... @property - def GetArg(self) -> 'Any': + def GetArg(self) -> Any: """Argument to be passed to above function, can be any object.""" - pass + ... -class PyCTL_CONTEXT(object): +class PyCTL_CONTEXT: """Object containing a Certificate Trust List""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def HCTL_CONTEXT(self) -> 'Any': + def HCTL_CONTEXT(self) -> Any: """Raw message handle""" - pass + ... - def CertFreeCTLContext(self,) -> 'None': + def CertFreeCTLContext(self) -> None: """ Closes the CTL handle @@ -2812,9 +2785,9 @@ Returns: None """ - pass + ... - def CertEnumCTLContextProperties(self,) -> 'Tuple[Any, ...]': + def CertEnumCTLContextProperties(self) -> Tuple[Any, ...]: """ Lists property id's for the context @@ -2827,9 +2800,9 @@ Returns: Tuple[Any, ...] """ - pass + ... - def CertEnumSubjectInSortedCTL(self,) -> 'Tuple[Tuple[Any, Any], ...]': + def CertEnumSubjectInSortedCTL(self) -> Tuple[Tuple[Any, Any], ...]: """ Retrieves trusted subjects contained in CRL @@ -2846,9 +2819,9 @@ Return ValueReturns a sequence of tuples containing two strings (SubjectIdentifi """ - pass + ... - def CertDeleteCTLFromStore(self,) -> 'None': + def CertDeleteCTLFromStore(self) -> None: """ Removes the CTL from the store that it is contained in @@ -2861,9 +2834,9 @@ Returns: None """ - pass + ... - def CertSerializeCTLStoreElement(self, Flags: 'Any' = 0) -> 'str': + def CertSerializeCTLStoreElement(self, Flags: Any = 0) -> str: """ Serializes the CTL and its properties @@ -2876,23 +2849,22 @@ Returns: str """ - pass + ... -class PyCTL_USAGE(object): +class PyCTL_USAGE: """Sequence of string OIDs (szOID_*). This struct is identical to CERT_ENHKEY_USAGE.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyConsoleScreenBuffer(object): - """""" +class PyConsoleScreenBuffer: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def SetConsoleActiveScreenBuffer(self,) -> 'None': + def SetConsoleActiveScreenBuffer(self) -> None: """ Sets this handle as the currently displayed screen @@ -2907,9 +2879,9 @@ Returns: None """ - pass + ... - def GetConsoleCursorInfo(self,) -> 'Tuple[Any, Any]': + def GetConsoleCursorInfo(self) -> Tuple[Any, Any]: """ Retrieves size and visibility of console's @@ -2932,9 +2904,9 @@ if cursor is visible """ - pass + ... - def SetConsoleCursorInfo(self, Size: 'Any', Visible: 'Any') -> 'None': + def SetConsoleCursorInfo(self, Size: Any, Visible: Any) -> None: """ Sets the size and visibility of console's cursor @@ -2948,9 +2920,9 @@ Returns: None """ - pass + ... - def GetConsoleMode(self,) -> 'Any': + def GetConsoleMode(self) -> Any: """ Returns the input or output mode of the console buffer @@ -2967,9 +2939,9 @@ Return ValueReturns a combination of ENABLE_*_INPUT or ENABLE_*_OUTPUT constants """ - pass + ... - def SetConsoleMode(self, Mode: 'Any') -> 'None': + def SetConsoleMode(self, Mode: Any) -> None: """ Sets the input or output mode of the console buffer @@ -2982,9 +2954,9 @@ Returns: None """ - pass + ... - def ReadConsole(self, NumberOfCharsToRead: 'Any') -> 'Any': + def ReadConsole(self, NumberOfCharsToRead: Any) -> Any: """ Reads characters from the console input buffer @@ -2997,9 +2969,9 @@ Returns: Any """ - pass + ... - def WriteConsole(self, Buffer: 'Any') -> 'Any': + def WriteConsole(self, Buffer: Any) -> Any: """ Writes characters at current cursor position @@ -3013,9 +2985,9 @@ Returns: """ - pass + ... - def FlushConsoleInputBuffer(self,) -> 'None': + def FlushConsoleInputBuffer(self) -> None: """ Flush input buffer @@ -3028,9 +3000,9 @@ Returns: None """ - pass + ... - def SetConsoleTextAttribute(self, Attributes: 'Any') -> 'None': + def SetConsoleTextAttribute(self, Attributes: Any) -> None: """ Sets character attributes for subsequent write operations @@ -3043,9 +3015,9 @@ Returns: None """ - pass + ... - def SetConsoleCursorPosition(self, CursorPosition: 'PyCOORD') -> 'None': + def SetConsoleCursorPosition(self, CursorPosition: PyCOORD) -> None: """ Sets the console screen buffer's cursor position @@ -3058,9 +3030,9 @@ Returns: None """ - pass + ... - def SetConsoleScreenBufferSize(self, Size: 'PyCOORD') -> 'None': + def SetConsoleScreenBufferSize(self, Size: PyCOORD) -> None: """ Sets the size of the console screen buffer @@ -3073,9 +3045,9 @@ Returns: None """ - pass + ... - def SetConsoleWindowInfo(self, Absolute: 'Any', ConsoleWindow: 'PySMALL_RECT') -> 'None': + def SetConsoleWindowInfo(self, Absolute: Any, ConsoleWindow: PySMALL_RECT) -> None: """ Changes size and position of a console's window @@ -3089,9 +3061,9 @@ Returns: None """ - pass + ... - def GetConsoleScreenBufferInfo(self,) -> 'Any': + def GetConsoleScreenBufferInfo(self) -> Any: """ Returns the state of the screen buffer @@ -3104,9 +3076,9 @@ Returns: Any """ - pass + ... - def GetLargestConsoleWindowSize(self,) -> 'PyCOORD': + def GetLargestConsoleWindowSize(self) -> PyCOORD: """ Returns the largest possible size for the @@ -3121,9 +3093,9 @@ Returns: PyCOORD """ - pass + ... - def FillConsoleOutputAttribute(self, Attribute: 'Any', Length: 'Any', WriteCoord: 'PyCOORD') -> 'Any': + def FillConsoleOutputAttribute(self, Attribute: Any, Length: Any, WriteCoord: PyCOORD) -> Any: """ Set text attributes for a consecutive series of @@ -3141,9 +3113,9 @@ Returns: """ - pass + ... - def FillConsoleOutputCharacter(self, Character: 'Any', Length: 'Any', WriteCoord: 'PyCOORD') -> 'Any': + def FillConsoleOutputCharacter(self, Character: Any, Length: Any, WriteCoord: PyCOORD) -> Any: """ Sets consecutive character positions to a specified @@ -3161,9 +3133,9 @@ Returns: """ - pass + ... - def ReadConsoleOutputCharacter(self, Length: 'Any', ReadCoord: 'PyCOORD') -> 'str': + def ReadConsoleOutputCharacter(self, Length: Any, ReadCoord: PyCOORD) -> str: """ Reads consecutive characters from a starting @@ -3179,9 +3151,9 @@ Returns: str """ - pass + ... - def ReadConsoleOutputAttribute(self, Length: 'Any', ReadCoord: 'PyCOORD') -> 'Tuple[Any, ...]': + def ReadConsoleOutputAttribute(self, Length: Any, ReadCoord: PyCOORD) -> Tuple[Any, ...]: """ Retrieves attributes from consecutive character @@ -3198,9 +3170,9 @@ Returns: """ - pass + ... - def WriteConsoleOutputCharacter(self, Characters: 'Any', WriteCoord: 'PyCOORD') -> 'Any': + def WriteConsoleOutputCharacter(self, Characters: Any, WriteCoord: PyCOORD) -> Any: """ Writes a string of characters at a specified position @@ -3215,9 +3187,9 @@ Returns: """ - pass + ... - def WriteConsoleOutputAttribute(self, Attributes: 'Tuple[Any, ...]', WriteCoord: 'PyCOORD') -> 'Any': + def WriteConsoleOutputAttribute(self, Attributes: Tuple[Any, ...], WriteCoord: PyCOORD) -> Any: """ Sets the attributes of a range of character cells @@ -3232,15 +3204,15 @@ Returns: """ - pass + ... def ScrollConsoleScreenBuffer( self, - ScrollRectangle: 'PySMALL_RECT', - ClipRectangle: 'PySMALL_RECT', - DestinationOrigin: 'PyCOORD', - FillCharacter: 'Any', - FillAttribute: 'Any') -> 'None': + ScrollRectangle: PySMALL_RECT, + ClipRectangle: PySMALL_RECT, + DestinationOrigin: PyCOORD, + FillCharacter: Any, + FillAttribute: Any) -> None: """ Scrolls a region of the display @@ -3257,9 +3229,9 @@ Returns: None """ - pass + ... - def GetCurrentConsoleFont(self, MaximumWindow: 'Any' = False) -> 'Tuple[Any, PyCOORD]': + def GetCurrentConsoleFont(self, MaximumWindow: Any = False) -> Tuple[Any, PyCOORD]: """ Returns currently displayed font @@ -3281,9 +3253,9 @@ Return ValueReturns the index of current font and window size """ - pass + ... - def GetConsoleFontSize(self, Font: 'Any') -> 'PyCOORD': + def GetConsoleFontSize(self, Font: Any) -> PyCOORD: """ Returns size of specified font for the console @@ -3296,9 +3268,9 @@ Returns: PyCOORD """ - pass + ... - def SetConsoleFont(self, Font: 'Any') -> 'None': + def SetConsoleFont(self, Font: Any) -> None: """ Changes the font used by the screen buffer @@ -3311,9 +3283,9 @@ Returns: None """ - pass + ... - def SetStdHandle(self, StdHandle: 'Any') -> 'None': + def SetStdHandle(self, StdHandle: Any) -> None: """ Replaces one of calling process's standard handles with this handle @@ -3326,9 +3298,9 @@ Returns: None """ - pass + ... - def SetConsoleDisplayMode(self, Flags: 'Any', NewScreenBufferDimensions: 'PyCOORD') -> 'None': + def SetConsoleDisplayMode(self, Flags: Any, NewScreenBufferDimensions: PyCOORD) -> None: """ Sets the display mode of the console buffer @@ -3342,9 +3314,9 @@ Returns: None """ - pass + ... - def WriteConsoleInput(self, Buffer: 'Tuple[PyINPUT_RECORD, ...]') -> 'Any': + def WriteConsoleInput(self, Buffer: Tuple[PyINPUT_RECORD, ...]) -> Any: """ Places input records in the console's input queue @@ -3358,9 +3330,9 @@ Returns: """ - pass + ... - def ReadConsoleInput(self, Length: 'Any') -> 'Tuple[PyINPUT_RECORD, ...]': + def ReadConsoleInput(self, Length: Any) -> Tuple[PyINPUT_RECORD, ...]: """ Reads input records and removes them from @@ -3381,9 +3353,9 @@ Return ValueReturns a sequence of PyINPUT_RECORD objects """ - pass + ... - def PeekConsoleInput(self, Length: 'Any') -> 'Tuple[PyINPUT_RECORD, ...]': + def PeekConsoleInput(self, Length: Any) -> Tuple[PyINPUT_RECORD, ...]: """ Returns pending input records without @@ -3404,9 +3376,9 @@ Return ValueReturns a sequence of PyINPUT_RECORD objects """ - pass + ... - def GetNumberOfConsoleInputEvents(self,) -> 'Any': + def GetNumberOfConsoleInputEvents(self) -> Any: """ Returns the number of unread records in the input @@ -3421,16 +3393,16 @@ Returns: Any """ - pass + ... -class PyCredHandle(object): +class PyCredHandle: """Handle to a set of logon credentials, used with sspi authentication functions""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Detach(self,) -> 'Any': + def Detach(self) -> Any: """ Disassociates object from handle and returns integer value of handle, @@ -3443,9 +3415,9 @@ Returns: Any """ - pass + ... - def FreeCredentialsHandle(self,) -> 'None': + def FreeCredentialsHandle(self) -> None: """ Releases the credentials handle and makes object unusable @@ -3458,9 +3430,9 @@ Returns: None """ - pass + ... - def QueryCredentialsAttributes(self, Attribute: 'Any') -> 'None': + def QueryCredentialsAttributes(self, Attribute: Any) -> None: """ Returns information about the credentials @@ -3497,16 +3469,16 @@ Return ValueType of returned values is dependent on Attribute """ - pass + ... -class PyCtxtHandle(object): +class PyCtxtHandle: """Security context handle, as used with sspi functions""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Detach(self,) -> 'Any': + def Detach(self) -> Any: """ Disassociates object from handle and returns integer value of handle @@ -3519,9 +3491,9 @@ Returns: Any """ - pass + ... - def CompleteAuthToken(self, Token: 'PySecBufferDesc') -> 'None': + def CompleteAuthToken(self, Token: PySecBufferDesc) -> None: """ Completes the authentication token @@ -3534,9 +3506,9 @@ Returns: None """ - pass + ... - def QueryContextAttributes(self, Attribute: 'Any') -> 'None': + def QueryContextAttributes(self, Attribute: Any) -> None: """ Retrieves info about a security context @@ -3549,9 +3521,9 @@ Returns: None """ - pass + ... - def DeleteSecurityContext(self,) -> 'None': + def DeleteSecurityContext(self) -> None: """ Frees the security context and invalidates the handle @@ -3564,9 +3536,9 @@ Returns: None """ - pass + ... - def QuerySecurityContextToken(self,) -> 'Any': + def QuerySecurityContextToken(self) -> Any: """ Returns the access token for a security context @@ -3579,9 +3551,9 @@ Returns: Any """ - pass + ... - def MakeSignature(self, fqop: 'Any', Message: 'PySecBufferDesc', MessageSeqNo: 'Any') -> 'None': + def MakeSignature(self, fqop: Any, Message: PySecBufferDesc, MessageSeqNo: Any) -> None: """ Creates a crytographic hash of a message using session key of the security @@ -3606,9 +3578,9 @@ Return ValueReturns None on success, and output buffer in Message will contain t """ - pass + ... - def VerifySignature(self, Message: 'PySecBufferDesc', MessageSeqNo: 'Any') -> 'None': + def VerifySignature(self, Message: PySecBufferDesc, MessageSeqNo: Any) -> None: """ None @@ -3632,9 +3604,9 @@ Return ValueReturns quality of protection flags used to create signature """ - pass + ... - def EncryptMessage(self, fqop: 'Any', Message: 'PySecBufferDesc', MessageSeqNo: 'Any') -> 'None': + def EncryptMessage(self, fqop: Any, Message: PySecBufferDesc, MessageSeqNo: Any) -> None: """ Encrypts data with session key of security context @@ -3659,9 +3631,9 @@ Return ValueReturns None on success, and buffer(s) will contain encrypted data """ - pass + ... - def DecryptMessage(self, Message: 'PySecBufferDesc', MessageSeqNo: 'Any') -> 'None': + def DecryptMessage(self, Message: PySecBufferDesc, MessageSeqNo: Any) -> None: """ None @@ -3687,9 +3659,9 @@ Return ValueReturns flags specfic to security package indicating quality of prot """ - pass + ... - def ImpersonateSecurityContext(self,) -> 'None': + def ImpersonateSecurityContext(self) -> None: """ Impersonates a client security context @@ -3702,9 +3674,9 @@ Returns: None """ - pass + ... - def RevertSecurityContext(self,) -> 'None': + def RevertSecurityContext(self) -> None: """ None @@ -3717,358 +3689,358 @@ Returns: None """ - pass + ... -class PyDCB(object): +class PyDCB: """A Python object, representing an DCB structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def BaudRate(self) -> 'int': + def BaudRate(self) -> int: """current baud rate""" - pass + ... @property - def wReserved(self) -> 'int': + def wReserved(self) -> int: """not currently used""" - pass + ... @property - def XonLim(self) -> 'int': + def XonLim(self) -> int: """transmit XON threshold""" - pass + ... @property - def XoffLim(self) -> 'int': + def XoffLim(self) -> int: """transmit XOFF threshold""" - pass + ... @property - def ByteSize(self) -> 'int': + def ByteSize(self) -> int: """number of bits/byte, 4-8""" - pass + ... @property - def Parity(self) -> 'int': + def Parity(self) -> int: """0-4=no,odd,even,mark,space""" - pass + ... @property - def StopBits(self) -> 'int': + def StopBits(self) -> int: """0,1,2 = 1, 1.5, 2""" - pass + ... @property - def XonChar(self) -> 'str': + def XonChar(self) -> str: """Tx and Rx XON character""" - pass + ... @property - def XoffChar(self) -> 'str': + def XoffChar(self) -> str: """Tx and Rx XOFF character""" - pass + ... @property - def ErrorChar(self) -> 'str': + def ErrorChar(self) -> str: """error replacement character""" - pass + ... @property - def EofChar(self) -> 'str': + def EofChar(self) -> str: """end of input character""" - pass + ... @property - def EvtChar(self) -> 'str': + def EvtChar(self) -> str: """received event character""" - pass + ... @property - def wReserved1(self) -> 'int': + def wReserved1(self) -> int: """reserved; do not use""" - pass + ... @property - def fBinary(self) -> 'int': + def fBinary(self) -> int: """binary mode, no EOF check""" - pass + ... @property - def fParity(self) -> 'int': + def fParity(self) -> int: """enable parity checking""" - pass + ... @property - def fOutxCtsFlow(self) -> 'int': + def fOutxCtsFlow(self) -> int: """CTS output flow control""" - pass + ... @property - def fOutxDsrFlow(self) -> 'int': + def fOutxDsrFlow(self) -> int: """DSR output flow control""" - pass + ... @property - def fDtrControl(self) -> 'int': + def fDtrControl(self) -> int: """DTR flow control type""" - pass + ... @property - def fDsrSensitivity(self) -> 'int': + def fDsrSensitivity(self) -> int: """DSR sensitivity""" - pass + ... @property - def fTXContinueOnXoff(self) -> 'int': + def fTXContinueOnXoff(self) -> int: """XOFF continues Tx""" - pass + ... @property - def fOutX(self) -> 'int': + def fOutX(self) -> int: """XON/XOFF out flow control""" - pass + ... @property - def fInX(self) -> 'int': + def fInX(self) -> int: """XON/XOFF in flow control""" - pass + ... @property - def fErrorChar(self) -> 'int': + def fErrorChar(self) -> int: """enable error replacement""" - pass + ... @property - def fNull(self) -> 'int': + def fNull(self) -> int: """enable null stripping""" - pass + ... @property - def fRtsControl(self) -> 'int': + def fRtsControl(self) -> int: """RTS flow control""" - pass + ... @property - def fAbortOnError(self) -> 'int': + def fAbortOnError(self) -> int: """abort on error""" - pass + ... @property - def fDummy2(self) -> 'int': + def fDummy2(self) -> int: """reserved""" - pass + ... -class PyDEVMODE(object): +class PyDEVMODE: """Python object wrapping a DEVMODE structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def SpecVersion(self) -> 'Any': + def SpecVersion(self) -> Any: """Should always be set to DM_SPECVERSION""" - pass + ... @property - def DriverVersion(self) -> 'Any': + def DriverVersion(self) -> Any: """Version nbr assigned to printer driver by vendor""" - pass + ... @property - def Size(self) -> 'Any': + def Size(self) -> Any: """Size of structure""" - pass + ... @property - def DriverExtra(self) -> 'Any': + def DriverExtra(self) -> Any: """Number of extra bytes allocated for driver data, can only be set when new object is created""" - pass + ... @property - def Fields(self) -> 'Any': + def Fields(self) -> Any: """Bitmask of win32con.DM_* constants indicating which members are set""" - pass + ... @property - def Orientation(self) -> 'Any': + def Orientation(self) -> Any: """Only applies to printers, DMORIENT_PORTRAIT or DMORIENT_LANDSCAPE""" - pass + ... @property - def PaperSize(self) -> 'Any': + def PaperSize(self) -> Any: """Use 0 if PaperWidth and PaperLength are set, otherwise win32con.DMPAPER_* constant""" - pass + ... @property - def PaperLength(self) -> 'Any': + def PaperLength(self) -> Any: """Specified in 1/10 millimeters""" - pass + ... @property - def PaperWidth(self) -> 'Any': + def PaperWidth(self) -> Any: """Specified in 1/10 millimeters""" - pass + ... @property - def Position_x(self) -> 'Any': + def Position_x(self) -> Any: """Position of display relative to desktop""" - pass + ... @property - def Position_y(self) -> 'Any': + def Position_y(self) -> Any: """Position of display relative to desktop""" - pass + ... @property - def DisplayOrientation(self) -> 'Any': + def DisplayOrientation(self) -> Any: """Display rotation: DMDO_DEFAULT,DMDO_90, DMDO_180, DMDO_270""" - pass + ... @property - def DisplayFixedOutput(self) -> 'Any': + def DisplayFixedOutput(self) -> Any: """DMDFO_DEFAULT, DMDFO_CENTER, DMDFO_STRETCH""" - pass + ... @property - def Scale(self) -> 'Any': + def Scale(self) -> Any: """Specified as percentage, eg 50 means half size of original""" - pass + ... @property - def Copies(self) -> 'Any': + def Copies(self) -> Any: """Nbr of copies to print""" - pass + ... @property - def DefaultSource(self) -> 'Any': + def DefaultSource(self) -> Any: """DMBIN_* constant, or can be a printer-specific value""" - pass + ... @property - def PrintQuality(self) -> 'Any': + def PrintQuality(self) -> Any: """DMRES_* constant, interpreted as DPI if positive""" - pass + ... @property - def Color(self) -> 'Any': + def Color(self) -> Any: """DMCOLOR_COLOR or DMCOLOR_MONOCHROME""" - pass + ... @property - def Duplex(self) -> 'Any': + def Duplex(self) -> Any: """For printers that do two-sided printing: DMDUP_SIMPLEX, DMDUP_HORIZONTAL, DMDUP_VERTICAL""" - pass + ... @property - def YResolution(self) -> 'Any': + def YResolution(self) -> Any: """Vertical printer resolution in DPI - if this is set, PrintQuality indicates horizontal DPI""" - pass + ... @property - def TTOption(self) -> 'Any': + def TTOption(self) -> Any: """TrueType options: DMTT_BITMAP, DMTT_DOWNLOAD, DMTT_DOWNLOAD_OUTLINE, DMTT_SUBDEV""" - pass + ... @property - def Collate(self) -> 'Any': + def Collate(self) -> Any: """DMCOLLATE_TRUE or DMCOLLATE_FALSE""" - pass + ... @property - def LogPixels(self) -> 'Any': + def LogPixels(self) -> Any: """Pixels per inch (only for display devices""" - pass + ... @property - def BitsPerPel(self) -> 'Any': + def BitsPerPel(self) -> Any: """Color resolution in bits per pixel""" - pass + ... @property - def PelsWidth(self) -> 'Any': + def PelsWidth(self) -> Any: """Pixel width of display""" - pass + ... @property - def PelsHeight(self) -> 'Any': + def PelsHeight(self) -> Any: """Pixel height of display""" - pass + ... @property - def DisplayFlags(self) -> 'Any': + def DisplayFlags(self) -> Any: """Combination of DM_GRAYSCALE and DM_INTERLACED""" - pass + ... @property - def DisplayFrequency(self) -> 'Any': + def DisplayFrequency(self) -> Any: """Refresh rate""" - pass + ... @property - def ICMMethod(self) -> 'Any': + def ICMMethod(self) -> Any: """Indicates where ICM is performed, one of win32con.DMICMMETHOD_* values""" - pass + ... @property - def ICMIntent(self) -> 'Any': + def ICMIntent(self) -> Any: """Intent of ICM, one of win32con.DMICM_* values""" - pass + ... @property - def MediaType(self) -> 'Any': + def MediaType(self) -> Any: """win32con.DMMEDIA_*, can also be a printer-specific value greater then DMMEDIA_USER""" - pass + ... @property - def DitherType(self) -> 'Any': + def DitherType(self) -> Any: """Dithering option, win32con.DMDITHER_*""" - pass + ... @property - def Reserved1(self) -> 'Any': + def Reserved1(self) -> Any: """Reserved, use only 0""" - pass + ... @property - def Reserved2(self) -> 'Any': + def Reserved2(self) -> Any: """Reserved, use only 0""" - pass + ... @property - def Nup(self) -> 'Any': + def Nup(self) -> Any: """Controls printing of multiple logical pages per physical page, DMNUP_SYSTEM or DMNUP_ONEUP""" - pass + ... @property - def PanningWidth(self) -> 'Any': + def PanningWidth(self) -> Any: """Not used, leave as 0""" - pass + ... @property - def PanningHeight(self) -> 'Any': + def PanningHeight(self) -> Any: """Not used, leave as 0""" - pass + ... @property - def DeviceName(self) -> 'Any': + def DeviceName(self) -> Any: """String of at most 32 chars""" - pass + ... @property - def FormName(self) -> 'Any': + def FormName(self) -> Any: """Name of form as returned by win32print::EnumForms, at most 32 chars""" - pass + ... @property - def DriverData(self) -> 'Any': + def DriverData(self) -> Any: """Driver data appended to end of structure""" - pass + ... - def Clear(self,) -> 'None': + def Clear(self) -> None: """ Resets all members of the structure @@ -4081,253 +4053,252 @@ Returns: None """ - pass + ... -class PyDEVMODEW(object): - """""" +class PyDEVMODEW: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def SpecVersion(self) -> 'Any': + def SpecVersion(self) -> Any: """Should always be set to DM_SPECVERSION""" - pass + ... @property - def DriverVersion(self) -> 'Any': + def DriverVersion(self) -> Any: """Version nbr assigned to printer driver by vendor""" - pass + ... @property - def Size(self) -> 'Any': + def Size(self) -> Any: """Size of structure""" - pass + ... @property - def DriverExtra(self) -> 'Any': + def DriverExtra(self) -> Any: """Number of extra bytes allocated for driver data, can only be set when new object is created""" - pass + ... @property - def Fields(self) -> 'Any': + def Fields(self) -> Any: """Bitmask of win32con.DM_* constants indicating which members are set""" - pass + ... @property - def Orientation(self) -> 'Any': + def Orientation(self) -> Any: """Only applies to printers, DMORIENT_PORTRAIT or DMORIENT_LANDSCAPE""" - pass + ... @property - def PaperSize(self) -> 'Any': + def PaperSize(self) -> Any: """Use 0 if PaperWidth and PaperLength are set, otherwise win32con.DMPAPER_* constant""" - pass + ... @property - def PaperLength(self) -> 'Any': + def PaperLength(self) -> Any: """Specified in 1/10 millimeters""" - pass + ... @property - def PaperWidth(self) -> 'Any': + def PaperWidth(self) -> Any: """Specified in 1/10 millimeters""" - pass + ... @property - def Position_x(self) -> 'Any': + def Position_x(self) -> Any: """Position of display relative to desktop""" - pass + ... @property - def Position_y(self) -> 'Any': + def Position_y(self) -> Any: """Position of display relative to desktop""" - pass + ... @property - def DisplayOrientation(self) -> 'Any': + def DisplayOrientation(self) -> Any: """Display rotation: DMDO_DEFAULT,DMDO_90, DMDO_180, DMDO_270""" - pass + ... @property - def DisplayFixedOutput(self) -> 'Any': + def DisplayFixedOutput(self) -> Any: """DMDFO_DEFAULT, DMDFO_CENTER, DMDFO_STRETCH""" - pass + ... @property - def Scale(self) -> 'Any': + def Scale(self) -> Any: """Specified as percentage, eg 50 means half size of original""" - pass + ... @property - def Copies(self) -> 'Any': + def Copies(self) -> Any: """Nbr of copies to print""" - pass + ... @property - def DefaultSource(self) -> 'Any': + def DefaultSource(self) -> Any: """DMBIN_* constant, or can be a printer-specific value""" - pass + ... @property - def PrintQuality(self) -> 'Any': + def PrintQuality(self) -> Any: """DMRES_* constant, interpreted as DPI if positive""" - pass + ... @property - def Color(self) -> 'Any': + def Color(self) -> Any: """DMCOLOR_COLOR or DMCOLOR_MONOCHROME""" - pass + ... @property - def Duplex(self) -> 'Any': + def Duplex(self) -> Any: """For printers that do two-sided printing: DMDUP_SIMPLEX, DMDUP_HORIZONTAL, DMDUP_VERTICAL""" - pass + ... @property - def YResolution(self) -> 'Any': + def YResolution(self) -> Any: """Vertical printer resolution in DPI - if this is set, PrintQuality indicates horizontal DPI""" - pass + ... @property - def TTOption(self) -> 'Any': + def TTOption(self) -> Any: """TrueType options: DMTT_BITMAP, DMTT_DOWNLOAD, DMTT_DOWNLOAD_OUTLINE, DMTT_SUBDEV""" - pass + ... @property - def Collate(self) -> 'Any': + def Collate(self) -> Any: """DMCOLLATE_TRUE or DMCOLLATE_FALSE""" - pass + ... @property - def LogPixels(self) -> 'Any': + def LogPixels(self) -> Any: """Pixels per inch (only for display devices""" - pass + ... @property - def BitsPerPel(self) -> 'Any': + def BitsPerPel(self) -> Any: """Color resolution in bits per pixel""" - pass + ... @property - def PelsWidth(self) -> 'Any': + def PelsWidth(self) -> Any: """Pixel width of display""" - pass + ... @property - def PelsHeight(self) -> 'Any': + def PelsHeight(self) -> Any: """Pixel height of display""" - pass + ... @property - def DisplayFlags(self) -> 'Any': + def DisplayFlags(self) -> Any: """Combination of DM_GRAYSCALE and DM_INTERLACED""" - pass + ... @property - def DisplayFrequency(self) -> 'Any': + def DisplayFrequency(self) -> Any: """Refresh rate""" - pass + ... @property - def ICMMethod(self) -> 'Any': + def ICMMethod(self) -> Any: """Indicates where ICM is performed, one of win32con.DMICMMETHOD_* values""" - pass + ... @property - def ICMIntent(self) -> 'Any': + def ICMIntent(self) -> Any: """Intent of ICM, one of win32con.DMICM_* values""" - pass + ... @property - def MediaType(self) -> 'Any': + def MediaType(self) -> Any: """win32con.DMMEDIA_*, can also be a printer-specific value greater then DMMEDIA_USER""" - pass + ... @property - def DitherType(self) -> 'Any': + def DitherType(self) -> Any: """Dithering option, win32con.DMDITHER_*""" - pass + ... @property - def Reserved1(self) -> 'Any': + def Reserved1(self) -> Any: """Reserved, use only 0""" - pass + ... @property - def Reserved2(self) -> 'Any': + def Reserved2(self) -> Any: """Reserved, use only 0""" - pass + ... @property - def Nup(self) -> 'Any': + def Nup(self) -> Any: """Controls printing of multiple logical pages per physical page, DMNUP_SYSTEM or DMNUP_ONEUP""" - pass + ... @property - def PanningWidth(self) -> 'Any': + def PanningWidth(self) -> Any: """Not used, leave as 0""" - pass + ... @property - def PanningHeight(self) -> 'Any': + def PanningHeight(self) -> Any: """Not used, leave as 0""" - pass + ... @property - def DeviceName(self) -> 'str': + def DeviceName(self) -> str: """String of at most 32 chars""" - pass + ... @property - def FormName(self) -> 'Any': + def FormName(self) -> Any: """Name of form as returned by win32print::EnumForms, at most 32 chars""" - pass + ... @property - def DriverData(self) -> 'Any': + def DriverData(self) -> Any: """Driver data appended to end of structure""" - pass + ... -class PyDISPLAY_DEVICE(object): +class PyDISPLAY_DEVICE: """Python object wrapping a DISPLAY_DEVICE structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def Size(self) -> 'Any': + def Size(self) -> Any: """Size of structure""" - pass + ... @property - def DeviceName(self) -> 'Any': + def DeviceName(self) -> Any: """String of at most 32 chars""" - pass + ... @property - def DeviceString(self) -> 'Any': + def DeviceString(self) -> Any: """String of at most 128 chars""" - pass + ... @property - def StateFlags(self) -> 'Any': + def StateFlags(self) -> Any: """Bitmask of win32con.DISPLAY_DEVICE_* constants indicating current device status""" - pass + ... @property - def DeviceID(self) -> 'Any': + def DeviceID(self) -> Any: """String of at most 128 chars""" - pass + ... @property - def DeviceKey(self) -> 'Any': + def DeviceKey(self) -> Any: """String of at most 128 chars""" - pass + ... - def Clear(self,) -> 'None': + def Clear(self) -> None: """ Resets all members of the structure @@ -4340,44 +4311,43 @@ Returns: None """ - pass + ... -class PyDLGITEMTEMPLATE(object): +class PyDLGITEMTEMPLATE: """A tuple describing a control in a dialog box.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyDLGTEMPLATE(object): +class PyDLGTEMPLATE: """A tuple of items describing a dialog box, that can be used to create the dialog.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyDS_HANDLE(object): - """""" +class PyDS_HANDLE: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyDS_NAME_RESULT_ITEM(object): +class PyDS_NAME_RESULT_ITEM: """A tuple representing a DS_NAME_RESULT_ITEM""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyDateTime(object): +class PyDateTime: """A Python object, representing an instant in time.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Format(self,) -> 'Any': + def Format(self) -> Any: """ None @@ -4390,24 +4360,22 @@ Returns: Any """ - pass + ... -class PyDialogTemplate(object): - """""" +class PyDialogTemplate: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyEVTLOG_HANDLE(object): - """""" +class PyEVTLOG_HANDLE: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyEVT_HANDLE(object): +class PyEVT_HANDLE: """Handle to an event log, session, query, or any other object used with the Evt* event log functions on Vista and later. @@ -4418,225 +4386,204 @@ When the object is destroyed, EvtClose is called.""" raise Exception('This class just for typing, can not be instanced!') -class PyEVT_RPC_LOGIN(object): +class PyEVT_RPC_LOGIN: """Tuple containing login credentials for a remote Event Log connection""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyEventLogRecord(object): +class PyEventLogRecord: """An object containing the data in an EVENTLOGRECORD.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def Reserved(self) -> 'int': - """""" - pass + def Reserved(self) -> int: + ... @property - def RecordNumber(self) -> 'int': - """""" - pass + def RecordNumber(self) -> int: + ... @property - def TimeGenerated(self) -> 'PyTime': - """""" - pass + def TimeGenerated(self) -> PyTime: + ... @property - def TimeWritten(self) -> 'PyTime': - """""" - pass + def TimeWritten(self) -> PyTime: + ... @property - def EventID(self) -> 'int': - """""" - pass + def EventID(self) -> int: + ... @property - def EventType(self) -> 'int': - """""" - pass + def EventType(self) -> int: + ... @property - def EventCategory(self) -> 'int': - """""" - pass + def EventCategory(self) -> int: + ... @property - def ReservedFlags(self) -> 'int': - """""" - pass + def ReservedFlags(self) -> int: + ... @property - def ClosingRecordNumber(self) -> 'int': - """""" - pass + def ClosingRecordNumber(self) -> int: + ... @property - def SourceName(self) -> 'str': - """""" - pass + def SourceName(self) -> str: + ... @property - def StringInserts(self) -> 'Tuple[str, ...]': - """""" - pass + def StringInserts(self) -> Tuple[str, ...]: + ... @property - def Sid(self) -> 'PySID': - """""" - pass + def Sid(self) -> PySID: + ... @property - def Data(self) -> 'str': - """""" - pass + def Data(self) -> str: + ... @property - def ComputerName(self) -> 'str': - """""" - pass + def ComputerName(self) -> str: + ... -class PyGROUP_INFO_0(object): +class PyGROUP_INFO_0: """A dictionary holding the information in a Win32 GROUP_INFO_0 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def name(self) -> 'Union[str]': + def name(self) -> str: """Name of the group""" - pass + ... -class PyGROUP_INFO_1(object): +class PyGROUP_INFO_1: """A dictionary holding the information in a Win32 GROUP_INFO_1 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def name(self) -> 'Union[str]': + def name(self) -> str: """Name of the group""" - pass + ... @property - def comment(self) -> 'Union[str]': + def comment(self) -> str: """The group's comment.""" - pass + ... -class PyGROUP_INFO_1002(object): +class PyGROUP_INFO_1002: """A dictionary holding the information in a Win32 GROUP_INFO_1002 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def comment(self) -> 'Union[str]': - """""" - pass + def comment(self) -> str: + ... -class PyGROUP_INFO_1005(object): +class PyGROUP_INFO_1005: """A dictionary holding the information in a Win32 GROUP_INFO_1005 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def attributes(self) -> 'Any': - """""" - pass + def attributes(self) -> Any: + ... -class PyGROUP_INFO_2(object): +class PyGROUP_INFO_2: """A dictionary holding the information in a Win32 GROUP_INFO_2 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def name(self) -> 'Union[str]': + def name(self) -> str: """Name of the group""" - pass + ... @property - def comment(self) -> 'Union[str]': + def comment(self) -> str: """The group's comment.""" - pass + ... @property - def group_id(self) -> 'Any': - """""" - pass + def group_id(self) -> Any: + ... @property - def attributes(self) -> 'Any': - """""" - pass + def attributes(self) -> Any: + ... -class PyGROUP_USERS_INFO_0(object): +class PyGROUP_USERS_INFO_0: """A dictionary holding the information in a Win32 GROUP_USERS_INFO_0 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def name(self) -> 'Union[str]': + def name(self) -> str: """Name of the group or user""" - pass + ... -class PyGROUP_USERS_INFO_1(object): +class PyGROUP_USERS_INFO_1: """A dictionary holding the information in a Win32 GROUP_USERS_INFO_1 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def name(self) -> 'Union[str]': + def name(self) -> str: """Name of the group or user""" - pass + ... @property - def attributes(self) -> 'Any': - """""" - pass + def attributes(self) -> Any: + ... -class PyGdiHANDLE(object): - """""" +class PyGdiHANDLE: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyGetSignerCertificate(object): - """""" +class PyGetSignerCertificate: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyHANDLE(object): +class PyHANDLE: """A Python object, representing a win32 HANDLE.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def handle(self) -> 'Any': + def handle(self) -> Any: """Integer value of the handleMethodsCloseCloses the handle closeSynonym for PyHANDLE::Close DetachDetaches the Win32 handle from the handle object. __nonzero__Used for detecting true/false. is nb_bool in Python 3.0 __int__Used when an integer representation of the handle object is required. __print__Used when the object is printed. tp_print __hash__Used when the hash value of an object is required tp_hash __str__Used when a string representation is required tp_str """ - pass + ... - def Close(self,) -> 'None': + def Close(self) -> None: """ Closes the underlying Win32 handle. @@ -4649,9 +4596,9 @@ Returns: None """ - pass + ... - def close(self,) -> 'None': + def close(self) -> None: """ Closes the underlying Win32 handle. @@ -4664,9 +4611,9 @@ Returns: None """ - pass + ... - def Detach(self,) -> 'Any': + def Detach(self) -> Any: """ Detaches the Win32 handle from the handle object. @@ -4694,16 +4641,15 @@ handle is already detached, this will return zero. """ - pass + ... -class PyHDESK(object): - """""" +class PyHDESK: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def SetThreadDesktop(self,) -> 'None': + def SetThreadDesktop(self) -> None: """ Assigns this desktop to the calling thread @@ -4716,9 +4662,9 @@ Returns: None """ - pass + ... - def EnumDesktopWindows(self,) -> 'Tuple[int, ...]': + def EnumDesktopWindows(self) -> Tuple[int, ...]: """ Returns a list of handles to all top-level windows on desktop @@ -4731,9 +4677,9 @@ Returns: Tuple[int, ...] """ - pass + ... - def SwitchDesktop(self,) -> 'None': + def SwitchDesktop(self) -> None: """ Activates the desktop @@ -4746,9 +4692,9 @@ Returns: None """ - pass + ... - def CloseDesktop(self,) -> 'None': + def CloseDesktop(self) -> None: """ Closes the desktop handle @@ -4761,17 +4707,16 @@ Returns: None """ - pass + ... -class PyHDEVNOTIFY(object): - """""" +class PyHDEVNOTIFY: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyHHNTRACK(object): +class PyHHNTRACK: """A Python object, representing an HHNTRACK structure""" @@ -4780,27 +4725,27 @@ structure""" raise Exception('This class just for typing, can not be instanced!') @property - def action(self) -> 'Any': + def action(self) -> Any: """Specifies the action the user is about to take. This is an HHACT_ constant.""" - pass + ... @property - def hdr(self) -> 'Any': + def hdr(self) -> Any: """Standard WM_NOTIFY header(win32help::NMHDR).""" - pass + ... @property - def curUrl(self) -> 'str': + def curUrl(self) -> str: """A multi-byte, zero-terminated string that specifies the topic navigated to, or the name of the help window being created.""" - pass + ... @property - def winType(self) -> 'Any': + def winType(self) -> Any: """A pointer to the current HH_WINTYPE structure (win32help::HH_WINTYPE).""" - pass + ... -class PyHHN_NOTIFY(object): +class PyHHN_NOTIFY: """A Python object, representing an HHN_NOTIFY structure""" @@ -4809,54 +4754,54 @@ structure""" raise Exception('This class just for typing, can not be instanced!') @property - def hdr(self) -> 'Any': + def hdr(self) -> Any: """Standard WM_NOTIFY header.(win32help::NMHDR)""" - pass + ... @property - def url(self) -> 'str': + def url(self) -> str: """A multi-byte, zero-terminated string that specifies the topic navigated to, or the name of the help window being created.""" - pass + ... -class PyHH_AKLINK(object): +class PyHH_AKLINK: """A Python object, representing an HH_AKLINK structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def indexOnFail(self) -> 'Any': + def indexOnFail(self) -> Any: """Specifies whether to display the keyword in the Index tab of the HTML Help Viewer if the lookup fails. The value of window specifies the Help Viewer.""" - pass + ... @property - def keywords(self) -> 'str': + def keywords(self) -> str: """Specifies one or more ALink names or KLink keywords to look up. Multiple entries are delimited by a semicolon.""" - pass + ... @property - def url(self) -> 'str': + def url(self) -> str: """Specifies the topic file to navigate to if the lookup fails. url refers to a valid topic within the specified compiled help (.chm) file and does not support Internet protocols that point to an HTML file.""" - pass + ... @property - def msgText(self) -> 'str': + def msgText(self) -> str: """Specifies the text to display in a message box if the lookup fails and indexOnFail is FALSE and url is NULL.""" - pass + ... @property - def msgTitle(self) -> 'str': + def msgTitle(self) -> str: """Specifies the caption of the message box in which the msgText parameter appears.""" - pass + ... @property - def window(self) -> 'str': + def window(self) -> str: """Specifies the name of the window type in which to display one of the following: The selected topic, if the lookup yields one or more matching topics. The topic specified in url, if the lookup fails and a topic is specified in url. The Index tab, if the lookup fails and indexOnFail is specified as TRUE.""" - pass + ... -class PyHH_FTS_QUERY(object): +class PyHH_FTS_QUERY: """A Python object, representing an HH_FTS_QUERY structure""" @@ -4865,258 +4810,255 @@ structure""" raise Exception('This class just for typing, can not be instanced!') @property - def uniCodeStrings(self) -> 'Any': + def uniCodeStrings(self) -> Any: """TRUE if all strings are Unicode.""" - pass + ... @property - def proximity(self) -> 'Any': + def proximity(self) -> Any: """Word proximity.""" - pass + ... @property - def stemmedSearch(self) -> 'Any': + def stemmedSearch(self) -> Any: """TRUE for StemmedSearch only.""" - pass + ... @property - def titleOnly(self) -> 'Any': + def titleOnly(self) -> Any: """TRUE for Title search only.""" - pass + ... @property - def execute(self) -> 'Any': + def execute(self) -> Any: """TRUE to initiate the search.""" - pass + ... @property - def searchQuery(self) -> 'str': + def searchQuery(self) -> str: """String containing the search query.""" - pass + ... -class PyHH_POPUP(object): +class PyHH_POPUP: """A Python object, representing an HH_POPUP structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def hinst(self) -> 'Any': + def hinst(self) -> Any: """Instance handle of the program or DLL to retrieve the string resource from. Ignored if idString is zero.""" - pass + ... @property - def idString(self) -> 'Any': + def idString(self) -> Any: """Specifies zero, or a resource ID in the program or DLL specified in hinst.""" - pass + ... @property - def clrForeground(self) -> 'Any': + def clrForeground(self) -> Any: """Specifies the RGB value to use for the foreground color of the pop-up window. To use the system color for the window text, specify -1.""" - pass + ... @property - def clrBackground(self) -> 'Any': + def clrBackground(self) -> Any: """Specifies the RGB value to use for the background color of the pop-up window. To use the system color for the window background, specify -1.""" - pass + ... @property - def text(self) -> 'str': + def text(self) -> str: """Specifies the text to display if idString is zero.""" - pass + ... @property - def font(self) -> 'str': + def font(self) -> str: """Specifies the font attributes to use for the text in the pop-up window. Use the following format to specify font family, point size, character set, and font format: facename[, point size[, charset[ BOLD ITALIC UNDERLINE]]] To omit an attribute, enter a comma. For example, to specify bold, 10-pt, MS Sans Serif font, font would be: MS Sans Serif, 10, , BOLD""" - pass + ... @property - def pt(self) -> 'Any': + def pt(self) -> Any: """(x,y). Specifies (in pixels) where the top center of the pop-up window should be located.""" - pass + ... @property - def margins(self) -> 'Any': + def margins(self) -> Any: """(left,top,right,bottom). Specifies (in pixels) the margins to use on the left, top, right, and bottom sides of the pop-up window. The default for all rectangle members is -1.""" - pass + ... -class PyHH_WINTYPE(object): +class PyHH_WINTYPE: """A Python object, representing an HH_WINTYPE structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def uniCodeStrings(self) -> 'Any': + def uniCodeStrings(self) -> Any: """Specifies whether the strings used in this structure are UNICODE.""" - pass + ... @property - def validMembers(self) -> 'Any': + def validMembers(self) -> Any: """Specifies which members in the structure are valid.""" - pass + ... @property - def winProperties(self) -> 'Any': + def winProperties(self) -> Any: """Specifies the properties of the window, such as whether it is the standard HTML Help Viewer or whether it includes a Search tab.""" - pass + ... @property - def styles(self) -> 'Any': + def styles(self) -> Any: """Specifies the styles used to create the window. These styles can be ignored, combined with extended styles, or used exclusively depending on the value of the validMembers and winProperties parameters.""" - pass + ... @property - def exStyles(self) -> 'Any': + def exStyles(self) -> Any: """Specifies the extended styles used to create the window. These styles can be ignored, combined with default styles, or used exclusively depending on the value of the validMembers and winProperties parameters.""" - pass + ... @property - def showState(self) -> 'Any': + def showState(self) -> Any: """Specifies the initial display state of the window. Valid values are the same as those for the Win32 API ShowWindow function.""" - pass + ... @property - def hwndHelp(self) -> 'Any': + def hwndHelp(self) -> Any: """Specifies the handle of the window if the window has been created.""" - pass + ... @property - def hwndCaller(self) -> 'Any': + def hwndCaller(self) -> Any: """Specifies the window that will receive HTML Help notification messages. Notification messages are sent via Windows WM_NOTIFY messages.""" - pass + ... @property - def hwndToolBar(self) -> 'Any': + def hwndToolBar(self) -> Any: """Specifies the handle of the toolbar.""" - pass + ... @property - def hwndNavigation(self) -> 'Any': + def hwndNavigation(self) -> Any: """Specifies the handle of the Navigation pane.""" - pass + ... @property - def hwndHTML(self) -> 'Any': + def hwndHTML(self) -> Any: """Specifies the handle of the Topic pane, which hosts Shdocvw.dll.""" - pass + ... @property - def navWidth(self) -> 'Any': + def navWidth(self) -> Any: """Specifies the width of the Navigation pane when the Help Viewer is expanded.""" - pass + ... @property - def toolBarFlags(self) -> 'Any': + def toolBarFlags(self) -> Any: """Specifies which buttons to include on the toolbar.""" - pass + ... @property - def notExpanded(self) -> 'Any': + def notExpanded(self) -> Any: """Specifies that the Help Viewer open with the Navigation pane closed.""" - pass + ... @property - def curNavType(self) -> 'Any': + def curNavType(self) -> Any: """Specifies the default tab to display on the Navigation pane.""" - pass + ... @property - def idNotify(self) -> 'Any': + def idNotify(self) -> Any: """Specifies a non-zero ID for enabling HTML Help notification messages. This ID is passed as the wParam value of Windows WM_NOTIFY messages.""" - pass + ... @property - def typeName(self) -> 'str': + def typeName(self) -> str: """A null-terminated string that specifies the name of the window type.""" - pass + ... @property - def caption(self) -> 'str': + def caption(self) -> str: """A null-terminated string that specifies the caption to display in the title bar of the window.""" - pass + ... @property - def windowPos(self) -> 'Any': + def windowPos(self) -> Any: """(left,top,right,bottom). Specifies the coordinates of the window in pixels.""" - pass + ... @property - def HTMLPos(self) -> 'Any': + def HTMLPos(self) -> Any: """(left,top,right,bottom). Specifies the coordinates of the Topic pane.""" - pass + ... @property - def toc(self) -> 'str': + def toc(self) -> str: """Specifies the contents (.hhc) file to display in the Navigation pane.""" - pass + ... @property - def index(self) -> 'str': + def index(self) -> str: """Specifies the index (.hhk) file to display in the Navigation pane.""" - pass + ... @property - def file(self) -> 'str': + def file(self) -> str: """Specifies the default HTML file to display in the Topic pane.""" - pass + ... @property - def home(self) -> 'str': + def home(self) -> str: """Specifies the file or URL to display in the Topic pane when the Home button is clicked.""" - pass + ... @property - def jump1(self) -> 'str': + def jump1(self) -> str: """Specifies the text to display underneath the Jump1 button.""" - pass + ... @property - def jump2(self) -> 'str': + def jump2(self) -> str: """Specifies the text to display underneath the Jump2 button.""" - pass + ... @property - def urlJump1(self) -> 'str': + def urlJump1(self) -> str: """Specifies the URL to jump to when the Jump1 button is clicked.""" - pass + ... @property - def urlJump2(self) -> 'str': + def urlJump2(self) -> str: """Specifies the URL to jump to when the Jump2 button is clicked.""" - pass + ... -class PyHINTERNET(object): - """""" +class PyHINTERNET: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyHKEY(object): - """""" +class PyHKEY: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyHTHEME(object): - """""" +class PyHTHEME: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyHWINSTA(object): +class PyHWINSTA: """Wrapper for a handle to a window station - returned by CreateWindowStation, OpenWindowStation, or GetProcessWindowStation""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def EnumDesktops(self,) -> 'Tuple[Any, ...]': + def EnumDesktops(self) -> Tuple[Any, ...]: """ Lists names of desktops in the window station @@ -5129,9 +5071,9 @@ Returns: Tuple[Any, ...] """ - pass + ... - def SetProcessWindowStation(self,) -> 'None': + def SetProcessWindowStation(self) -> None: """ Associates the calling process with the window station @@ -5144,9 +5086,9 @@ Returns: None """ - pass + ... - def CloseWindowStation(self,) -> 'None': + def CloseWindowStation(self) -> None: """ Closes the window station handle @@ -5159,24 +5101,23 @@ Returns: None """ - pass + ... -class PyICONINFO(object): +class PyICONINFO: """Tuple describing an icon or cursor""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyIID(object): - """""" +class PyIID: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyINPUT_RECORD(object): +class PyINPUT_RECORD: """Interface to the INPUT_RECORD struct used with console IO functions. Create using PyINPUT_RECORDType(EventType)""" @@ -5185,113 +5126,112 @@ PyINPUT_RECORDType(EventType)""" raise Exception('This class just for typing, can not be instanced!') @property - def EventType(self) -> 'Any': + def EventType(self) -> Any: """One of KEY_EVENT, MOUSE_EVENT, WINDOW_BUFFER_SIZE_EVENT, MENU_EVENT, FOCUS_EVENT. Cannot be changed after object is created""" - pass + ... @property - def KeyDown(self) -> 'Any': + def KeyDown(self) -> Any: """True for a key press, False for key release""" - pass + ... @property - def RepeatCount(self) -> 'Any': + def RepeatCount(self) -> Any: """Nbr of repeats generated (key was held down if >1)""" - pass + ... @property - def VirtualKeyCode(self) -> 'Any': + def VirtualKeyCode(self) -> Any: """Device-independent key code, win32con.VK_*""" - pass + ... @property - def VirtualScanCode(self) -> 'Any': + def VirtualScanCode(self) -> Any: """Device-dependent scan code generated by keyboard""" - pass + ... @property - def Char(self) -> 'str': + def Char(self) -> str: """Single unicode character generated by the keypress""" - pass + ... @property - def ControlKeyState(self) -> 'Any': + def ControlKeyState(self) -> Any: """State of modifier keys, combination of CAPSLOCK_ON, ENHANCED_KEY, LEFT_ALT_PRESSED, LEFT_CTRL_PRESSED, NUMLOCK_ON, RIGHT_ALT_PRESSED, RIGHT_CTRL_PRESSED, SCROLLLOCK_ON, SHIFT_PRESSED""" - pass + ... @property - def ButtonState(self) -> 'Any': + def ButtonState(self) -> Any: """Bitmask representing which mouse buttons were pressed.""" - pass + ... @property - def EventFlags(self) -> 'Any': + def EventFlags(self) -> Any: """DOUBLE_CLICK, MOUSE_MOVED or MOUSE_WHEELED, or 0. If 0, indicates a mouse button press""" - pass + ... @property - def MousePosition(self) -> 'PyCOORD': + def MousePosition(self) -> PyCOORD: """Position in character coordinates""" - pass + ... @property - def Size(self) -> 'PyCOORD': + def Size(self) -> PyCOORD: """New size of screen buffer in character rows/columns""" - pass + ... @property - def SetFocus(self) -> 'Any': + def SetFocus(self) -> Any: """Reserved - Used only with type FOCUS_EVENT. This event is Reserved, and should be ignored.""" - pass + ... @property - def CommandId(self) -> 'Any': + def CommandId(self) -> Any: """Used only with event type MENU_EVENT, which is reserved and should not be used""" - pass + ... -class PyLOCALGROUP_INFO_0(object): +class PyLOCALGROUP_INFO_0: """A dictionary holding the information in a Win32 LOCALGROUP_INFO_0 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def name(self) -> 'Union[str]': + def name(self) -> str: """Name of the group""" - pass + ... -class PyLOCALGROUP_INFO_1(object): +class PyLOCALGROUP_INFO_1: """A dictionary holding the information in a Win32 LOCALGROUP_INFO_1 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def name(self) -> 'Union[str]': + def name(self) -> str: """Name of the group""" - pass + ... @property - def comment(self) -> 'Union[str]': + def comment(self) -> str: """The group's comment.""" - pass + ... -class PyLOCALGROUP_INFO_1002(object): +class PyLOCALGROUP_INFO_1002: """A dictionary holding the information in a Win32 LOCALGROUP_INFO_1002 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def comment(self) -> 'Union[str]': - """""" - pass + def comment(self) -> str: + ... -class PyLOCALGROUP_MEMBERS_INFO_0(object): +class PyLOCALGROUP_MEMBERS_INFO_0: """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_0 structure.""" @@ -5300,12 +5240,11 @@ structure.""" raise Exception('This class just for typing, can not be instanced!') @property - def sid(self) -> 'PySID': - """""" - pass + def sid(self) -> PySID: + ... -class PyLOCALGROUP_MEMBERS_INFO_1(object): +class PyLOCALGROUP_MEMBERS_INFO_1: """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_1 structure.""" @@ -5314,22 +5253,19 @@ structure.""" raise Exception('This class just for typing, can not be instanced!') @property - def sid(self) -> 'PySID': - """""" - pass + def sid(self) -> PySID: + ... @property - def sidusage(self) -> 'Any': - """""" - pass + def sidusage(self) -> Any: + ... @property - def name(self) -> 'Union[str]': - """""" - pass + def name(self) -> str: + ... -class PyLOCALGROUP_MEMBERS_INFO_2(object): +class PyLOCALGROUP_MEMBERS_INFO_2: """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_2 structure.""" @@ -5338,22 +5274,20 @@ structure.""" raise Exception('This class just for typing, can not be instanced!') @property - def sid(self) -> 'PySID': - """""" - pass + def sid(self) -> PySID: + ... @property - def sidusage(self) -> 'Any': - """""" - pass + def sidusage(self) -> Any: + ... @property - def domainandname(self) -> 'Union[str]': + def domainandname(self) -> str: """string containing the name of the member prefixed by the domain name and the "\\" separator character""" - pass + ... -class PyLOCALGROUP_MEMBERS_INFO_3(object): +class PyLOCALGROUP_MEMBERS_INFO_3: """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_3 structure.""" @@ -5362,207 +5296,180 @@ structure.""" raise Exception('This class just for typing, can not be instanced!') @property - def domainandname(self) -> 'Union[str]': + def domainandname(self) -> str: """string containing the name of the member prefixed by the domain name and the "\\" separator character""" - pass + ... -class PyLOGBRUSH(object): - """""" +class PyLOGBRUSH: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def Style(self) -> 'Any': + def Style(self) -> Any: """Brush style, one of win32con.BS_* values""" - pass + ... @property - def Color(self) -> 'Any': + def Color(self) -> Any: """RGB color value. Can also be DIB_PAL_COLORS or DIB_RGB_COLORS if Style is BS_DIBPATTERN or BS_DIBPATTERNPT=""" - pass + ... @property - def Hatch(self) -> 'Union[Any, int]': + def Hatch(self) -> Union[Any, int]: """For BS_HATCH style, one of win32con.HS_*. Not used For BS_SOLID or BS_HOLLOW. For a pattern brush, this should be a handle to a bitmap""" - pass + ... -class PyLOGFONT(object): +class PyLOGFONT: """A Python object, representing an PyLOGFONT structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def lfHeight(self) -> 'int': - """""" - pass + def lfHeight(self) -> int: + ... @property - def lfWidth(self) -> 'int': - """""" - pass + def lfWidth(self) -> int: + ... @property - def lfEscapement(self) -> 'int': - """""" - pass + def lfEscapement(self) -> int: + ... @property - def lfOrientation(self) -> 'int': - """""" - pass + def lfOrientation(self) -> int: + ... @property - def lfWeight(self) -> 'int': - """""" - pass + def lfWeight(self) -> int: + ... @property - def lfItalic(self) -> 'int': - """""" - pass + def lfItalic(self) -> int: + ... @property - def lfUnderline(self) -> 'int': - """""" - pass + def lfUnderline(self) -> int: + ... @property - def lfStrikeOut(self) -> 'int': - """""" - pass + def lfStrikeOut(self) -> int: + ... @property - def lfCharSet(self) -> 'int': - """""" - pass + def lfCharSet(self) -> int: + ... @property - def lfOutPrecision(self) -> 'int': - """""" - pass + def lfOutPrecision(self) -> int: + ... @property - def lfClipPrecision(self) -> 'int': - """""" - pass + def lfClipPrecision(self) -> int: + ... @property - def lfQuality(self) -> 'int': - """""" - pass + def lfQuality(self) -> int: + ... @property - def lfPitchAndFamily(self) -> 'int': - """""" - pass + def lfPitchAndFamily(self) -> int: + ... @property - def lfFaceName(self) -> 'str': + def lfFaceName(self) -> str: """Name of the typeface, at most 31 characters""" - pass + ... -class PyLSA_HANDLE(object): - """""" +class PyLSA_HANDLE: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyLUID_AND_ATTRIBUTES(object): +class PyLUID_AND_ATTRIBUTES: """A sequence containing (LUID,Attributes) representing an LUID_AND_ATTRIBUTES structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyLsaLogon_HANDLE(object): - """""" +class PyLsaLogon_HANDLE: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyMSG(object): +class PyMSG: """A tuple representing a win32 MSG structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyNETRESOURCE(object): +class PyNETRESOURCE: """A Python object that encapsulates a Win32 NETRESOURCE structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def dwScope(self) -> 'int': - """""" - pass + def dwScope(self) -> int: + ... @property - def dwType(self) -> 'int': - """""" - pass + def dwType(self) -> int: + ... @property - def dwDisplayType(self) -> 'int': - """""" - pass + def dwDisplayType(self) -> int: + ... @property - def dwUsage(self) -> 'int': - """""" - pass + def dwUsage(self) -> int: + ... @property - def localName(self) -> 'str': - """""" - pass + def localName(self) -> str: + ... @property - def remoteName(self) -> 'str': - """""" - pass + def remoteName(self) -> str: + ... @property - def comment(self) -> 'str': - """""" - pass + def comment(self) -> str: + ... @property - def provider(self) -> 'str': - """""" - pass + def provider(self) -> str: + ... -class PyNET_VALIDATE_AUTHENTICATION_INPUT_ARG(object): - """""" +class PyNET_VALIDATE_AUTHENTICATION_INPUT_ARG: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyNET_VALIDATE_PASSWORD_CHANGE_INPUT_ARG(object): - """""" +class PyNET_VALIDATE_PASSWORD_CHANGE_INPUT_ARG: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyNET_VALIDATE_PERSISTED_FIELDS(object): - """""" +class PyNET_VALIDATE_PERSISTED_FIELDS: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyNMHDR(object): +class PyNMHDR: """A Python object, representing an NMHDR structure""" @@ -5571,78 +5478,76 @@ structure""" raise Exception('This class just for typing, can not be instanced!') @property - def hwndFrom(self) -> 'Any': + def hwndFrom(self) -> Any: """Window handle to the control sending a message. ??? 64-bit problem here ???""" - pass + ... @property - def idFrom(self) -> 'Any': + def idFrom(self) -> Any: """Identifier of the control sending a message.""" - pass + ... @property - def code(self) -> 'Any': + def code(self) -> Any: """Notification code. This member can be a control-specific notification code or it can be one of the common notification codes.""" - pass + ... -class PyNOTIFYICONDATA(object): - """""" +class PyNOTIFYICONDATA: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyOVERLAPPED(object): +class PyOVERLAPPED: """A Python object, representing an overlapped structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def Offset(self) -> 'int': + def Offset(self) -> int: """Specifies a file position at which to start the transfer. The file position is a byte offset from the start of the file. The calling process sets this member before calling the ReadFile or WriteFile function. This member is ignored when reading from or writing to named pipes and communications devices.""" - pass + ... @property - def OffsetHigh(self) -> 'int': + def OffsetHigh(self) -> int: """Specifies the high word of the byte offset at which to start the transfer.""" - pass + ... @property - def object(self) -> 'Any': + def object(self) -> Any: """Any python object that you want to attach to your overlapped I/O request.""" - pass + ... @property - def dword(self) -> 'Any': + def dword(self) -> Any: """An integer buffer that may be used by overlapped functions (eg, win32file::WaitCommEvent)""" - pass + ... @property - def hEvent(self) -> 'int': + def hEvent(self) -> int: """Identifies an event set to the signaled state when the transfer has been completed. The calling process sets this member before calling the win32file::ReadFile, win32file::WriteFile, win32pipe::ConnectNamedPipe, or win32pipe::TransactNamedPipe function.""" - pass + ... @property - def Internal(self) -> 'int': + def Internal(self) -> int: """Reserved for operating system use. (pointer-sized value)""" - pass + ... @property - def InternalHigh(self) -> 'int': + def InternalHigh(self) -> int: """Reserved for operating system use. (pointer-sized value)""" - pass + ... -class PyOVERLAPPEDReadBuffer(object): - """""" +class PyOVERLAPPEDReadBuffer: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyPERF_COUNTER_DEFINITION(object): +class PyPERF_COUNTER_DEFINITION: """An object encapsulating a Windows NT Performance Monitor counter definition (PERF_COUNTER_DEFINITION).""" @@ -5651,31 +5556,30 @@ class PyPERF_COUNTER_DEFINITION(object): raise Exception('This class just for typing, can not be instanced!') @property - def DefaultScale(self) -> 'int': + def DefaultScale(self) -> int: """The default scale of the counter.""" - pass + ... @property - def DetailLevel(self) -> 'int': + def DetailLevel(self) -> int: """The detail level of the counter.""" - pass + ... @property - def CounterType(self) -> 'int': + def CounterType(self) -> int: """The counter type.""" - pass + ... @property - def CounterNameTitleIndex(self) -> 'int': - """""" - pass + def CounterNameTitleIndex(self) -> int: + ... @property - def CounterHelpTitleIndex(self) -> 'int': + def CounterHelpTitleIndex(self) -> int: """Sentinel""" - pass + ... - def Increment(self,) -> 'None': + def Increment(self) -> None: """ Increments the value of the performance counter @@ -5688,9 +5592,9 @@ Returns: None """ - pass + ... - def Decrement(self,) -> 'None': + def Decrement(self) -> None: """ Decrements the value of the performance counter @@ -5703,9 +5607,9 @@ Returns: None """ - pass + ... - def Set(self,) -> 'None': + def Set(self) -> None: """ Sets the counter to a specific value @@ -5718,9 +5622,9 @@ Returns: None """ - pass + ... - def Get(self,) -> 'None': + def Get(self) -> None: """ Gets the current value of the counter @@ -5733,31 +5637,28 @@ Returns: None """ - pass + ... -class PyPERF_OBJECT_TYPE(object): +class PyPERF_OBJECT_TYPE: """A Python object, representing a PERF_OBJECT_TYPE structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def ObjectNameTitleIndex(self) -> 'int': - """""" - pass + def ObjectNameTitleIndex(self) -> int: + ... @property - def ObjectHelpTitleIndex(self) -> 'int': - """""" - pass + def ObjectHelpTitleIndex(self) -> int: + ... @property - def DefaultCounterIndex(self) -> 'int': - """""" - pass + def DefaultCounterIndex(self) -> int: + ... - def Close(self,) -> 'None': + def Close(self) -> None: """ Closes the object. @@ -5770,65 +5671,64 @@ Returns: None """ - pass + ... -class PyPOINT(object): +class PyPOINT: """Tuple of two ints (x,y) representing a POINT struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyPROFILEINFO(object): - """""" +class PyPROFILEINFO: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def UserName(self) -> 'str': + def UserName(self) -> str: """Name of user for which to load profile""" - pass + ... @property - def Flags(self) -> 'Any': + def Flags(self) -> Any: """Combination of PI_* flags""" - pass + ... @property - def ProfilePath(self) -> 'str': + def ProfilePath(self) -> str: """Path to roaming profile, can be None. Use win32net::NetUserGetInfo to retrieve user's profile path""" - pass + ... @property - def DefaultPath(self) -> 'str': + def DefaultPath(self) -> str: """Path to Default user profile, can be None""" - pass + ... @property - def ServerName(self) -> 'str': + def ServerName(self) -> str: """Domain controller, can be None""" - pass + ... @property - def PolicyPath(self) -> 'str': + def PolicyPath(self) -> str: """Location of policy file, can be None""" - pass + ... @property - def Profile(self) -> 'PyHKEY': + def Profile(self) -> PyHKEY: """Handle to root of user's registry key. This member is output.""" - pass + ... -class PyPerfMonManager(object): +class PyPerfMonManager: """A Python object""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Close(self,) -> 'None': + def Close(self) -> None: """ Closes the performance monitor manager. @@ -5841,68 +5741,65 @@ Returns: None """ - pass + ... -class PyPrinterHANDLE(object): - """""" +class PyPrinterHANDLE: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyRECT(object): +class PyRECT: """Tuple of 4 ints defining a rectangle: (left, top, right, bottom)""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyResourceId(object): - """""" +class PyResourceId: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PySCROLLINFO(object): +class PySCROLLINFO: """A tuple representing a SCROLLINFO structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PySC_HANDLE(object): - """""" +class PySC_HANDLE: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PySECURITY_ATTRIBUTES(object): +class PySECURITY_ATTRIBUTES: """A Python object, representing a SECURITY_ATTRIBUTES structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def bInheritHandle(self) -> 'Any': + def bInheritHandle(self) -> Any: """Specifies whether the returned handle is inherited when a new process is created. If this member is TRUE, the new process inherits the handle.""" - pass + ... @property - def SECURITY_DESCRIPTOR(self) -> 'PySECURITY_DESCRIPTOR': + def SECURITY_DESCRIPTOR(self) -> PySECURITY_DESCRIPTOR: """A PySECURITY_DESCRIPTOR, or None""" - pass + ... -class PySECURITY_DESCRIPTOR(object): +class PySECURITY_DESCRIPTOR: """A Python object, representing a SECURITY_DESCRIPTOR structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Initialize(self,) -> 'None': + def Initialize(self) -> None: """ Initialize the SD. @@ -5915,9 +5812,9 @@ Returns: None """ - pass + ... - def GetSecurityDescriptorOwner(self,) -> 'PySID': + def GetSecurityDescriptorOwner(self) -> PySID: """ Return the owner of the security descriptor. @@ -5930,9 +5827,9 @@ Returns: PySID """ - pass + ... - def GetSecurityDescriptorDacl(self,) -> 'PyACL': + def GetSecurityDescriptorDacl(self) -> PyACL: """ Return the discretionary ACL of the security @@ -5947,9 +5844,9 @@ Returns: PyACL """ - pass + ... - def GetSecurityDescriptorSacl(self,) -> 'PyACL': + def GetSecurityDescriptorSacl(self) -> PyACL: """ Return system access control list (SACL) of SD @@ -5962,9 +5859,9 @@ Returns: PyACL """ - pass + ... - def GetSecurityDescriptorControl(self,) -> 'Tuple[Any, Any]': + def GetSecurityDescriptorControl(self) -> Tuple[Any, Any]: """ Returns tuple of Control bit flags and @@ -5979,9 +5876,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def SetSecurityDescriptorOwner(self, sid: 'PySID', bOwnerDefaulted: 'Any') -> 'None': + def SetSecurityDescriptorOwner(self, sid: PySID, bOwnerDefaulted: Any) -> None: """ Set owner SID. @@ -5995,9 +5892,9 @@ Returns: None """ - pass + ... - def SetSecurityDescriptorGroup(self, sid: 'PySID', bOwnerDefaulted: 'Any') -> 'Any': + def SetSecurityDescriptorGroup(self, sid: PySID, bOwnerDefaulted: Any) -> Any: """ Set group SID. @@ -6011,9 +5908,9 @@ Returns: Any """ - pass + ... - def SetSecurityDescriptorSacl(self, bSaclPresent: 'Any', SACL: 'PyACL', bSaclDefaulted: 'Any') -> 'None': + def SetSecurityDescriptorSacl(self, bSaclPresent: Any, SACL: PyACL, bSaclDefaulted: Any) -> None: """ Replaces system access control list (SACL) in the security @@ -6030,9 +5927,9 @@ Returns: None """ - pass + ... - def IsValid(self,) -> 'None': + def IsValid(self) -> None: """ Determines if the security descriptor is valid. @@ -6045,9 +5942,9 @@ Returns: None """ - pass + ... - def GetLength(self,) -> 'None': + def GetLength(self) -> None: """ return length of security descriptor (GetSecurityDescriptorLenght). @@ -6060,9 +5957,9 @@ Returns: None """ - pass + ... - def IsSelfRelative(self,) -> 'None': + def IsSelfRelative(self) -> None: """ Returns 1 if security descriptor is self relative, 0 if absolute @@ -6075,9 +5972,9 @@ Returns: None """ - pass + ... - def SetSecurityDescriptorControl(self, ControlBitsOfInterest: 'Any', ControlBitsToSet: 'Any') -> 'None': + def SetSecurityDescriptorControl(self, ControlBitsOfInterest: Any, ControlBitsToSet: Any) -> None: """ Sets the control bit flags related to inheritance for a @@ -6093,895 +5990,738 @@ Returns: None """ - pass + ... -class PySERVER_INFO_100(object): +class PySERVER_INFO_100: """A dictionary holding the information in a Win32 SERVER_INFO_100 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def platform_id(self) -> 'Any': - """""" - pass + def platform_id(self) -> Any: + ... @property - def name(self) -> 'Union[str]': - """""" - pass + def name(self) -> str: + ... -class PySERVER_INFO_101(object): +class PySERVER_INFO_101: """A dictionary holding the information in a Win32 SERVER_INFO_101 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def platform_id(self) -> 'Any': - """""" - pass + def platform_id(self) -> Any: + ... @property - def name(self) -> 'Union[str]': - """""" - pass + def name(self) -> str: + ... @property - def version_major(self) -> 'Any': - """""" - pass + def version_major(self) -> Any: + ... @property - def version_minor(self) -> 'Any': - """""" - pass + def version_minor(self) -> Any: + ... @property - def type(self) -> 'Any': + def type(self) -> Any: """one of the SV_TYPE_* constants""" - pass + ... @property - def comment(self) -> 'Union[str]': - """""" - pass + def comment(self) -> str: + ... -class PySERVER_INFO_102(object): +class PySERVER_INFO_102: """A dictionary holding the information in a Win32 SERVER_INFO_102 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def platform_id(self) -> 'Any': - """""" - pass + def platform_id(self) -> Any: + ... @property - def name(self) -> 'Union[str]': - """""" - pass + def name(self) -> str: + ... @property - def version_major(self) -> 'Any': - """""" - pass + def version_major(self) -> Any: + ... @property - def version_minor(self) -> 'Any': - """""" - pass + def version_minor(self) -> Any: + ... @property - def type(self) -> 'Any': + def type(self) -> Any: """one of the SV_TYPE_* constants""" - pass + ... @property - def comment(self) -> 'Union[str]': - """""" - pass + def comment(self) -> str: + ... @property - def users(self) -> 'Any': - """""" - pass + def users(self) -> Any: + ... @property - def disc(self) -> 'Any': - """""" - pass + def disc(self) -> Any: + ... @property - def hidden(self) -> 'Any': - """""" - pass + def hidden(self) -> Any: + ... @property - def announce(self) -> 'Any': - """""" - pass + def announce(self) -> Any: + ... @property - def anndelta(self) -> 'Any': - """""" - pass + def anndelta(self) -> Any: + ... @property - def userpath(self) -> 'Union[str]': - """""" - pass + def userpath(self) -> str: + ... -class PySERVER_INFO_402(object): +class PySERVER_INFO_402: """A dictionary holding the information in a Win32 SERVER_INFO_402 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def ulist_mtime(self) -> 'Any': - """""" - pass + def ulist_mtime(self) -> Any: + ... @property - def glist_mtime(self) -> 'Any': - """""" - pass + def glist_mtime(self) -> Any: + ... @property - def alist_mtime(self) -> 'Any': - """""" - pass + def alist_mtime(self) -> Any: + ... @property - def security(self) -> 'Any': - """""" - pass + def security(self) -> Any: + ... @property - def numadmin(self) -> 'Any': - """""" - pass + def numadmin(self) -> Any: + ... @property - def lanmask(self) -> 'Any': - """""" - pass + def lanmask(self) -> Any: + ... @property - def guestacct(self) -> 'Union[str]': - """""" - pass + def guestacct(self) -> str: + ... @property - def chdevs(self) -> 'Any': - """""" - pass + def chdevs(self) -> Any: + ... @property - def chdevq(self) -> 'Any': - """""" - pass + def chdevq(self) -> Any: + ... @property - def chdevjobs(self) -> 'Any': - """""" - pass + def chdevjobs(self) -> Any: + ... @property - def connections(self) -> 'Any': - """""" - pass + def connections(self) -> Any: + ... @property - def shares(self) -> 'Any': - """""" - pass + def shares(self) -> Any: + ... @property - def openfiles(self) -> 'Any': - """""" - pass + def openfiles(self) -> Any: + ... @property - def sessopens(self) -> 'Any': - """""" - pass + def sessopens(self) -> Any: + ... @property - def sessvcs(self) -> 'Any': - """""" - pass + def sessvcs(self) -> Any: + ... @property - def sessreqs(self) -> 'Any': - """""" - pass + def sessreqs(self) -> Any: + ... @property - def opensearch(self) -> 'Any': - """""" - pass + def opensearch(self) -> Any: + ... @property - def activelocks(self) -> 'Any': - """""" - pass + def activelocks(self) -> Any: + ... @property - def numreqbuf(self) -> 'Any': - """""" - pass + def numreqbuf(self) -> Any: + ... @property - def sizreqbuf(self) -> 'Any': - """""" - pass + def sizreqbuf(self) -> Any: + ... @property - def numbigbuf(self) -> 'Any': - """""" - pass + def numbigbuf(self) -> Any: + ... @property - def numfiletasks(self) -> 'Any': - """""" - pass + def numfiletasks(self) -> Any: + ... @property - def alertsched(self) -> 'Any': - """""" - pass + def alertsched(self) -> Any: + ... @property - def erroralert(self) -> 'Any': - """""" - pass + def erroralert(self) -> Any: + ... @property - def logonalert(self) -> 'Any': - """""" - pass + def logonalert(self) -> Any: + ... @property - def accessalert(self) -> 'Any': - """""" - pass + def accessalert(self) -> Any: + ... @property - def diskalert(self) -> 'Any': - """""" - pass + def diskalert(self) -> Any: + ... @property - def netioalert(self) -> 'Any': - """""" - pass + def netioalert(self) -> Any: + ... @property - def maxauditsz(self) -> 'Any': - """""" - pass + def maxauditsz(self) -> Any: + ... @property - def srvheuristics(self) -> 'Union[str]': - """""" - pass + def srvheuristics(self) -> str: + ... -class PySERVER_INFO_403(object): +class PySERVER_INFO_403: """A dictionary holding the information in a Win32 SERVER_INFO_403 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def ulist_mtime(self) -> 'Any': - """""" - pass + def ulist_mtime(self) -> Any: + ... @property - def glist_mtime(self) -> 'Any': - """""" - pass + def glist_mtime(self) -> Any: + ... @property - def alist_mtime(self) -> 'Any': - """""" - pass + def alist_mtime(self) -> Any: + ... @property - def security(self) -> 'Any': - """""" - pass + def security(self) -> Any: + ... @property - def numadmin(self) -> 'Any': - """""" - pass + def numadmin(self) -> Any: + ... @property - def lanmask(self) -> 'Any': - """""" - pass + def lanmask(self) -> Any: + ... @property - def guestacct(self) -> 'Union[str]': - """""" - pass + def guestacct(self) -> str: + ... @property - def chdevs(self) -> 'Any': - """""" - pass + def chdevs(self) -> Any: + ... @property - def chdevq(self) -> 'Any': - """""" - pass + def chdevq(self) -> Any: + ... @property - def chdevjobs(self) -> 'Any': - """""" - pass + def chdevjobs(self) -> Any: + ... @property - def connections(self) -> 'Any': - """""" - pass + def connections(self) -> Any: + ... @property - def shares(self) -> 'Any': - """""" - pass + def shares(self) -> Any: + ... @property - def openfiles(self) -> 'Any': - """""" - pass + def openfiles(self) -> Any: + ... @property - def sessopens(self) -> 'Any': - """""" - pass + def sessopens(self) -> Any: + ... @property - def sessvcs(self) -> 'Any': - """""" - pass + def sessvcs(self) -> Any: + ... @property - def sessreqs(self) -> 'Any': - """""" - pass + def sessreqs(self) -> Any: + ... @property - def opensearch(self) -> 'Any': - """""" - pass + def opensearch(self) -> Any: + ... @property - def activelocks(self) -> 'Any': - """""" - pass + def activelocks(self) -> Any: + ... @property - def numreqbuf(self) -> 'Any': - """""" - pass + def numreqbuf(self) -> Any: + ... @property - def sizreqbuf(self) -> 'Any': - """""" - pass + def sizreqbuf(self) -> Any: + ... @property - def numbigbuf(self) -> 'Any': - """""" - pass + def numbigbuf(self) -> Any: + ... @property - def numfiletasks(self) -> 'Any': - """""" - pass + def numfiletasks(self) -> Any: + ... @property - def alertsched(self) -> 'Any': - """""" - pass + def alertsched(self) -> Any: + ... @property - def erroralert(self) -> 'Any': - """""" - pass + def erroralert(self) -> Any: + ... @property - def logonalert(self) -> 'Any': - """""" - pass + def logonalert(self) -> Any: + ... @property - def accessalert(self) -> 'Any': - """""" - pass + def accessalert(self) -> Any: + ... @property - def diskalert(self) -> 'Any': - """""" - pass + def diskalert(self) -> Any: + ... @property - def netioalert(self) -> 'Any': - """""" - pass + def netioalert(self) -> Any: + ... @property - def maxauditsz(self) -> 'Any': - """""" - pass + def maxauditsz(self) -> Any: + ... @property - def srvheuristics(self) -> 'Union[str]': - """""" - pass + def srvheuristics(self) -> str: + ... @property - def auditedevents(self) -> 'Any': - """""" - pass + def auditedevents(self) -> Any: + ... @property - def autoprofile(self) -> 'Any': - """""" - pass + def autoprofile(self) -> Any: + ... @property - def autopath(self) -> 'Union[str]': - """""" - pass + def autopath(self) -> str: + ... -class PySERVER_INFO_502(object): +class PySERVER_INFO_502: """A dictionary holding the information in a Win32 SERVER_INFO_502 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def sessopens(self) -> 'Any': - """""" - pass + def sessopens(self) -> Any: + ... @property - def sessvcs(self) -> 'Any': - """""" - pass + def sessvcs(self) -> Any: + ... @property - def opensearch(self) -> 'Any': - """""" - pass + def opensearch(self) -> Any: + ... @property - def sizreqbuf(self) -> 'Any': - """""" - pass + def sizreqbuf(self) -> Any: + ... @property - def initworkitems(self) -> 'Any': - """""" - pass + def initworkitems(self) -> Any: + ... @property - def maxworkitems(self) -> 'Any': - """""" - pass + def maxworkitems(self) -> Any: + ... @property - def rawworkitems(self) -> 'Any': - """""" - pass + def rawworkitems(self) -> Any: + ... @property - def irpstacksize(self) -> 'Any': - """""" - pass + def irpstacksize(self) -> Any: + ... @property - def maxrawbuflen(self) -> 'Any': - """""" - pass + def maxrawbuflen(self) -> Any: + ... @property - def sessusers(self) -> 'Any': - """""" - pass + def sessusers(self) -> Any: + ... @property - def sessconns(self) -> 'Any': - """""" - pass + def sessconns(self) -> Any: + ... @property - def maxpagedmemoryusage(self) -> 'Any': - """""" - pass + def maxpagedmemoryusage(self) -> Any: + ... @property - def maxnonpagedmemoryusage(self) -> 'Any': - """""" - pass + def maxnonpagedmemoryusage(self) -> Any: + ... @property - def enableforcedlogoff(self) -> 'Any': - """""" - pass + def enableforcedlogoff(self) -> Any: + ... @property - def timesource(self) -> 'Any': - """""" - pass + def timesource(self) -> Any: + ... @property - def acceptdownlevelapis(self) -> 'Any': - """""" - pass + def acceptdownlevelapis(self) -> Any: + ... @property - def lmannounce(self) -> 'Any': - """""" - pass + def lmannounce(self) -> Any: + ... -class PySERVER_INFO_503(object): +class PySERVER_INFO_503: """A dictionary holding the information in a Win32 SERVER_INFO_503 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def sessopens(self) -> 'Any': - """""" - pass + def sessopens(self) -> Any: + ... @property - def sessvcs(self) -> 'Any': - """""" - pass + def sessvcs(self) -> Any: + ... @property - def opensearch(self) -> 'Any': - """""" - pass + def opensearch(self) -> Any: + ... @property - def sizreqbuf(self) -> 'Any': - """""" - pass + def sizreqbuf(self) -> Any: + ... @property - def initworkitems(self) -> 'Any': - """""" - pass + def initworkitems(self) -> Any: + ... @property - def maxworkitems(self) -> 'Any': - """""" - pass + def maxworkitems(self) -> Any: + ... @property - def rawworkitems(self) -> 'Any': - """""" - pass + def rawworkitems(self) -> Any: + ... @property - def irpstacksize(self) -> 'Any': - """""" - pass + def irpstacksize(self) -> Any: + ... @property - def maxrawbuflen(self) -> 'Any': - """""" - pass + def maxrawbuflen(self) -> Any: + ... @property - def sessusers(self) -> 'Any': - """""" - pass + def sessusers(self) -> Any: + ... @property - def sessconns(self) -> 'Any': - """""" - pass + def sessconns(self) -> Any: + ... @property - def maxpagedmemoryusage(self) -> 'Any': - """""" - pass + def maxpagedmemoryusage(self) -> Any: + ... @property - def maxnonpagedmemoryusage(self) -> 'Any': - """""" - pass + def maxnonpagedmemoryusage(self) -> Any: + ... @property - def enableforcedlogoff(self) -> 'Any': - """""" - pass + def enableforcedlogoff(self) -> Any: + ... @property - def timesource(self) -> 'Any': - """""" - pass + def timesource(self) -> Any: + ... @property - def acceptdownlevelapis(self) -> 'Any': - """""" - pass + def acceptdownlevelapis(self) -> Any: + ... @property - def lmannounce(self) -> 'Any': - """""" - pass + def lmannounce(self) -> Any: + ... @property - def domain(self) -> 'Union[str]': - """""" - pass + def domain(self) -> str: + ... @property - def maxkeepsearch(self) -> 'Any': - """""" - pass + def maxkeepsearch(self) -> Any: + ... @property - def scavtimeout(self) -> 'Any': - """""" - pass + def scavtimeout(self) -> Any: + ... @property - def minrcvqueue(self) -> 'Any': - """""" - pass + def minrcvqueue(self) -> Any: + ... @property - def minfreeworkitems(self) -> 'Any': - """""" - pass + def minfreeworkitems(self) -> Any: + ... @property - def xactmemsize(self) -> 'Any': - """""" - pass + def xactmemsize(self) -> Any: + ... @property - def threadpriority(self) -> 'Any': - """""" - pass + def threadpriority(self) -> Any: + ... @property - def maxmpxct(self) -> 'Any': - """""" - pass + def maxmpxct(self) -> Any: + ... @property - def oplockbreakwait(self) -> 'Any': - """""" - pass + def oplockbreakwait(self) -> Any: + ... @property - def oplockbreakresponsewait(self) -> 'Any': - """""" - pass + def oplockbreakresponsewait(self) -> Any: + ... @property - def enableoplocks(self) -> 'Any': - """""" - pass + def enableoplocks(self) -> Any: + ... @property - def enablefcbopens(self) -> 'Any': - """""" - pass + def enablefcbopens(self) -> Any: + ... @property - def enableraw(self) -> 'Any': - """""" - pass + def enableraw(self) -> Any: + ... @property - def enablesharednetdrives(self) -> 'Any': - """""" - pass + def enablesharednetdrives(self) -> Any: + ... @property - def minfreeconnections(self) -> 'Any': - """""" - pass + def minfreeconnections(self) -> Any: + ... @property - def maxfreeconnections(self) -> 'Any': - """""" - pass + def maxfreeconnections(self) -> Any: + ... -class PySHARE_INFO_0(object): +class PySHARE_INFO_0: """A dictionary holding the infomation in a Win32 SHARE_INFO_0 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def netname(self) -> 'Union[str]': - """""" - pass + def netname(self) -> str: + ... -class PySHARE_INFO_1(object): +class PySHARE_INFO_1: """A dictionary holding the infomation in a Win32 SHARE_INFO_1 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def netname(self) -> 'Union[str]': - """""" - pass + def netname(self) -> str: + ... @property - def type(self) -> 'Any': - """""" - pass + def type(self) -> Any: + ... @property - def remark(self) -> 'Union[str]': - """""" - pass + def remark(self) -> str: + ... -class PySHARE_INFO_2(object): +class PySHARE_INFO_2: """A dictionary holding the infomation in a Win32 SHARE_INFO_2 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def netname(self) -> 'Union[str]': - """""" - pass + def netname(self) -> str: + ... @property - def type(self) -> 'Any': - """""" - pass + def type(self) -> Any: + ... @property - def remark(self) -> 'Union[str]': - """""" - pass + def remark(self) -> str: + ... @property - def permissions(self) -> 'Any': - """""" - pass + def permissions(self) -> Any: + ... @property - def max_uses(self) -> 'Any': - """""" - pass + def max_uses(self) -> Any: + ... @property - def current_uses(self) -> 'Any': - """""" - pass + def current_uses(self) -> Any: + ... @property - def path(self) -> 'Union[str]': - """""" - pass + def path(self) -> str: + ... @property - def passwd(self) -> 'Union[str]': - """""" - pass + def passwd(self) -> str: + ... -class PySHARE_INFO_501(object): +class PySHARE_INFO_501: """A dictionary holding the infomation in a Win32 SHARE_INFO_501 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def netname(self) -> 'Union[str]': - """""" - pass + def netname(self) -> str: + ... @property - def type(self) -> 'Any': - """""" - pass + def type(self) -> Any: + ... @property - def remark(self) -> 'Union[str]': - """""" - pass + def remark(self) -> str: + ... @property - def flags(self) -> 'Any': - """""" - pass + def flags(self) -> Any: + ... -class PySHARE_INFO_502(object): +class PySHARE_INFO_502: """A dictionary holding the infomation in a Win32 SHARE_INFO_502 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def netname(self) -> 'Union[str]': - """""" - pass + def netname(self) -> str: + ... @property - def type(self) -> 'Any': - """""" - pass + def type(self) -> Any: + ... @property - def remark(self) -> 'Union[str]': - """""" - pass + def remark(self) -> str: + ... @property - def permissions(self) -> 'Any': - """""" - pass + def permissions(self) -> Any: + ... @property - def max_uses(self) -> 'Any': - """""" - pass + def max_uses(self) -> Any: + ... @property - def current_uses(self) -> 'Any': - """""" - pass + def current_uses(self) -> Any: + ... @property - def path(self) -> 'Union[str]': - """""" - pass + def path(self) -> str: + ... @property - def passwd(self) -> 'Union[str]': - """""" - pass + def passwd(self) -> str: + ... @property - def reserved(self) -> 'Any': - """""" - pass + def reserved(self) -> Any: + ... @property - def security_descriptor(self) -> 'PySECURITY_DESCRIPTOR': - """""" - pass + def security_descriptor(self) -> PySECURITY_DESCRIPTOR: + ... -class PySID(object): +class PySID: """A Python object, representing a SID structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Initialize(self, idAuthority: 'Any', numSubauthorities: 'Any') -> 'None': + def Initialize(self, idAuthority: Any, numSubauthorities: Any) -> None: """ Initialize the SID. @@ -6995,9 +6735,9 @@ Returns: None """ - pass + ... - def IsValid(self,) -> 'None': + def IsValid(self) -> None: """ Determines if the SID is valid. @@ -7010,9 +6750,9 @@ Returns: None """ - pass + ... - def SetSubAuthority(self, index: 'Any', val: 'Any') -> 'None': + def SetSubAuthority(self, index: Any, val: Any) -> None: """ Sets a SID SubAuthority @@ -7026,9 +6766,9 @@ Returns: None """ - pass + ... - def GetLength(self,) -> 'Any': + def GetLength(self) -> Any: """ return length of SID (GetLengthSid). @@ -7041,9 +6781,9 @@ Returns: Any """ - pass + ... - def GetSubAuthorityCount(self,) -> 'Any': + def GetSubAuthorityCount(self) -> Any: """ return nbr of subauthorities from SID @@ -7056,9 +6796,9 @@ Returns: Any """ - pass + ... - def GetSubAuthority(self,) -> 'Any': + def GetSubAuthority(self) -> Any: """ Returns specified subauthority from SID @@ -7071,9 +6811,9 @@ Returns: Any """ - pass + ... - def GetSidIdentifierAuthority(self,) -> 'Tuple[Any, Any, Any, Any, Any, Any]': + def GetSidIdentifierAuthority(self) -> Tuple[Any, Any, Any, Any, Any, Any]: """ Returns a tuple of 6 SID_IDENTIFIER_AUTHORITY @@ -7088,24 +6828,23 @@ Returns: Tuple[Any, Any, Any, Any, Any, Any] """ - pass + ... -class PySID_AND_ATTRIBUTES(object): - """""" +class PySID_AND_ATTRIBUTES: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PySIZE(object): +class PySIZE: """Tuple of two ints (cx,cy) representing a SIZE struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PySMALL_RECT(object): +class PySMALL_RECT: """Wrapper for a SMALL_RECT struct Create using PySMALL_RECTType(Left, Top, Right, Bottom). All params optional, defaulting to 0""" @@ -7114,104 +6853,99 @@ Create using PySMALL_RECTType(Left, Top, Right, Bottom). All params optional, de raise Exception('This class just for typing, can not be instanced!') @property - def Left(self) -> 'Any': + def Left(self) -> Any: """Left side of rectangle""" - pass + ... @property - def Top(self) -> 'Any': + def Top(self) -> Any: """Top edge of rectangle""" - pass + ... @property - def Right(self) -> 'Any': + def Right(self) -> Any: """Right edge of rectangle""" - pass + ... @property - def Bottom(self) -> 'Any': + def Bottom(self) -> Any: """Bottome edge of rectangle""" - pass + ... -class PySTARTUPINFO(object): +class PySTARTUPINFO: """A Python object, representing an STARTUPINFO structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def dwX(self) -> 'int': + def dwX(self) -> int: """Specifies the x offset, in pixels, of the upper left corner of a window if a new window is created. The offset is from the upper left corner of the screen.""" - pass + ... @property - def dwY(self) -> 'int': + def dwY(self) -> int: """Specifies the y offset, in pixels, of the upper left corner of a window if a new window is created. The offset is from the upper left corner of the screen.""" - pass + ... @property - def dwXSize(self) -> 'int': + def dwXSize(self) -> int: """Specifies the width, in pixels, of the window if a new window is created.""" - pass + ... @property - def dwYSize(self) -> 'int': + def dwYSize(self) -> int: """Specifies the height, in pixels, of the window if a new window is created.""" - pass + ... @property - def dwXCountChars(self) -> 'int': + def dwXCountChars(self) -> int: """For console processes, if a new console window is created, specifies the screen buffer width in character columns. This value is ignored in a GUI process.""" - pass + ... @property - def dwYCountChars(self) -> 'int': + def dwYCountChars(self) -> int: """For console processes, if a new console window is created, specifies the screen buffer height in character rows.""" - pass + ... @property - def dwFillAttribute(self) -> 'int': + def dwFillAttribute(self) -> int: """Specifies the initial text and background colors if a new console window is created in a console application. These values are ignored in GUI applications""" - pass + ... @property - def dwFlags(self) -> 'int': + def dwFlags(self) -> int: """This is a bit field that determines whether certain STARTUPINFO attributes are used when the process creates a window. To use many of the additional attributes, you typically must set the appropriate mask in this attribute, and also set the attributes themselves. Any combination of the win32con.STARTF_* flags can be specified.""" - pass + ... @property - def wShowWindow(self) -> 'int': + def wShowWindow(self) -> int: """Can be any of the SW_ constants defined in win32con. For GUI processes, this specifies the default value the first time ShowWindow is called.""" - pass + ... @property - def hStdInput(self) -> 'Union[int]': - """""" - pass + def hStdInput(self) -> int: + ... @property - def hStdOutput(self) -> 'Union[int]': - """""" - pass + def hStdOutput(self) -> int: + ... @property - def hStdError(self) -> 'Union[int]': - """""" - pass + def hStdError(self) -> int: + ... @property - def lpDesktop(self) -> 'Union[Any, str]': - """""" - pass + def lpDesktop(self) -> Union[Any, str]: + ... @property - def lpTitle(self) -> 'Union[Any, str]': - """""" - pass + def lpTitle(self) -> Union[Any, str]: + ... -class PySecBuffer(object): +class PySecBuffer: """Python object wrapping a SecBuffer structure Created using win32security.PySecBufferType(type,size) where type is a SECBUFFER_* constant""" @@ -7220,26 +6954,22 @@ Created using win32security.PySecBufferType(type,size) where type is a SECBUFFER raise Exception('This class just for typing, can not be instanced!') @property - def BufferType(self) -> 'Any': - """""" - pass + def BufferType(self) -> Any: + ... @property - def Buffer(self) -> 'str': - """""" - pass + def Buffer(self) -> str: + ... @property - def BufferSize(self) -> 'Any': - """""" - pass + def BufferSize(self) -> Any: + ... @property - def MaxBufferSize(self) -> 'Any': - """""" - pass + def MaxBufferSize(self) -> Any: + ... - def Clear(self,) -> 'None': + def Clear(self) -> None: """ Resets the buffer to all NULL's, and set the current size to maximum @@ -7252,16 +6982,16 @@ Returns: None """ - pass + ... -class PySecBufferDesc(object): +class PySecBufferDesc: """Sequence-like object that contains a group of buffers to be used with SSPI functions.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def append(self, buffer: 'Any') -> 'None': + def append(self, buffer: Any) -> None: """ None @@ -7274,146 +7004,135 @@ Returns: None """ - pass + ... -class PyTOKEN_GROUPS(object): - """""" +class PyTOKEN_GROUPS: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyTOKEN_PRIVILEGES(object): +class PyTOKEN_PRIVILEGES: """An object representing Win32 token privileges.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyTRIVERTEX(object): +class PyTRIVERTEX: """Dict representing a TRIVERTEX struct containing color information at a point""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def x(self) -> 'Any': + def x(self) -> Any: """X coord in logical units""" - pass + ... @property - def y(self) -> 'Any': + def y(self) -> Any: """Y coord in logical units""" - pass + ... @property - def Red(self) -> 'Any': + def Red(self) -> Any: """Red component""" - pass + ... @property - def Green(self) -> 'Any': + def Green(self) -> Any: """Green component""" - pass + ... @property - def Blue(self) -> 'Any': + def Blue(self) -> Any: """Blue component""" - pass + ... @property - def Alpha(self) -> 'Any': + def Alpha(self) -> Any: """Transparency value""" - pass + ... -class PyTRUSTEE(object): +class PyTRUSTEE: """A dictionary representing a TRUSTEE structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def TrusteeForm(self) -> 'Any': - """""" - pass + def TrusteeForm(self) -> Any: + ... @property - def TrusteeType(self) -> 'Any': - """""" - pass + def TrusteeType(self) -> Any: + ... @property - def Identifier(self) -> 'Any': + def Identifier(self) -> Any: """Depends on the value of TrusteeForm (string or sid)""" - pass + ... @property - def MultipleTrustee(self) -> 'Any': + def MultipleTrustee(self) -> Any: """default is None""" - pass + ... @property - def MultipleTrusteeOperation(self) -> 'Any': + def MultipleTrusteeOperation(self) -> Any: """default is None""" - pass + ... -class PyTS_HANDLE(object): +class PyTS_HANDLE: """Handle to a Terminal Server""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyTime(object): +class PyTime: """A Python object, representing an instant in time.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def year(self) -> 'Any': - """""" - pass + def year(self) -> Any: + ... @property - def month(self) -> 'Any': - """""" - pass + def month(self) -> Any: + ... @property - def weekday(self) -> 'Any': - """""" - pass + def weekday(self) -> Any: + ... @property - def day(self) -> 'Any': - """""" - pass + def day(self) -> Any: + ... @property - def hour(self) -> 'Any': - """""" - pass + def hour(self) -> Any: + ... @property - def minute(self) -> 'Any': - """""" - pass + def minute(self) -> Any: + ... @property - def second(self) -> 'Any': - """""" - pass + def second(self) -> Any: + ... @property - def msec(self) -> 'Any': - """""" - pass + def msec(self) -> Any: + ... - def Format(self, _format: 'str') -> 'str': + def Format(self, _format: str) -> str: """ Formats the time value. @@ -7426,1702 +7145,1525 @@ Returns: str """ - pass + ... -class PyUSER_INFO_0(object): +class PyUSER_INFO_0: """A dictionary holding the information in a Win32 USER_INFO_0 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def name(self) -> 'Union[str]': - """""" - pass + def name(self) -> str: + ... -class PyUSER_INFO_1(object): +class PyUSER_INFO_1: """A dictionary holding the information in a Win32 USER_INFO_1 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def name(self) -> 'Union[str]': - """""" - pass + def name(self) -> str: + ... @property - def password(self) -> 'Union[str]': - """""" - pass + def password(self) -> str: + ... @property - def password_age(self) -> 'Any': - """""" - pass + def password_age(self) -> Any: + ... @property - def priv(self) -> 'Any': - """""" - pass + def priv(self) -> Any: + ... @property - def home_dir(self) -> 'Union[str]': - """""" - pass + def home_dir(self) -> str: + ... @property - def comment(self) -> 'Union[str]': - """""" - pass + def comment(self) -> str: + ... @property - def flags(self) -> 'Any': - """""" - pass + def flags(self) -> Any: + ... @property - def script_path(self) -> 'Union[str]': - """""" - pass + def script_path(self) -> str: + ... -class PyUSER_INFO_10(object): +class PyUSER_INFO_10: """A dictionary holding the information in a Win32 USER_INFO_10 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def name(self) -> 'Union[str]': - """""" - pass + def name(self) -> str: + ... @property - def comment(self) -> 'Union[str]': - """""" - pass + def comment(self) -> str: + ... @property - def usr_comment(self) -> 'Union[str]': - """""" - pass + def usr_comment(self) -> str: + ... @property - def full_name(self) -> 'Union[str]': - """""" - pass + def full_name(self) -> str: + ... -class PyUSER_INFO_1003(object): +class PyUSER_INFO_1003: """A dictionary holding the information in a Win32 USER_INFO_1003 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def password(self) -> 'Union[str]': - """""" - pass + def password(self) -> str: + ... -class PyUSER_INFO_1005(object): +class PyUSER_INFO_1005: """A dictionary holding the information in a Win32 USER_INFO_1005 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def priv(self) -> 'Any': - """""" - pass + def priv(self) -> Any: + ... -class PyUSER_INFO_1006(object): +class PyUSER_INFO_1006: """A dictionary holding the information in a Win32 USER_INFO_1006 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def home_dir(self) -> 'Union[str]': - """""" - pass + def home_dir(self) -> str: + ... -class PyUSER_INFO_1007(object): +class PyUSER_INFO_1007: """A dictionary holding the information in a Win32 USER_INFO_1007 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def comment(self) -> 'Union[str]': - """""" - pass + def comment(self) -> str: + ... -class PyUSER_INFO_1008(object): +class PyUSER_INFO_1008: """A dictionary holding the information in a Win32 USER_INFO_1008 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def flags(self) -> 'Any': - """""" - pass + def flags(self) -> Any: + ... -class PyUSER_INFO_1009(object): +class PyUSER_INFO_1009: """A dictionary holding the information in a Win32 USER_INFO_1009 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def script_path(self) -> 'Union[str]': - """""" - pass + def script_path(self) -> str: + ... -class PyUSER_INFO_1010(object): +class PyUSER_INFO_1010: """A dictionary holding the information in a Win32 USER_INFO_1010 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def auth_flags(self) -> 'Any': - """""" - pass + def auth_flags(self) -> Any: + ... -class PyUSER_INFO_1011(object): +class PyUSER_INFO_1011: """A dictionary holding the information in a Win32 USER_INFO_1011 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def full_name(self) -> 'Union[str]': - """""" - pass + def full_name(self) -> str: + ... -class PyUSER_INFO_11(object): +class PyUSER_INFO_11: """A dictionary holding the information in a Win32 USER_INFO_11 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def name(self) -> 'Union[str]': - """""" - pass + def name(self) -> str: + ... @property - def comment(self) -> 'Union[str]': - """""" - pass + def comment(self) -> str: + ... @property - def usr_comment(self) -> 'Union[str]': - """""" - pass + def usr_comment(self) -> str: + ... @property - def full_name(self) -> 'Union[str]': - """""" - pass + def full_name(self) -> str: + ... @property - def priv(self) -> 'Any': - """""" - pass + def priv(self) -> Any: + ... @property - def auth_flags(self) -> 'Any': - """""" - pass + def auth_flags(self) -> Any: + ... @property - def password_age(self) -> 'Any': - """""" - pass + def password_age(self) -> Any: + ... @property - def home_dir(self) -> 'Union[str]': - """""" - pass + def home_dir(self) -> str: + ... @property - def parms(self) -> 'Union[str]': - """""" - pass + def parms(self) -> str: + ... @property - def last_logon(self) -> 'Any': - """""" - pass + def last_logon(self) -> Any: + ... @property - def last_logoff(self) -> 'Any': - """""" - pass + def last_logoff(self) -> Any: + ... @property - def bad_pw_count(self) -> 'Any': - """""" - pass + def bad_pw_count(self) -> Any: + ... @property - def num_logons(self) -> 'Any': - """""" - pass + def num_logons(self) -> Any: + ... @property - def logon_server(self) -> 'Union[str]': - """""" - pass + def logon_server(self) -> str: + ... @property - def country_code(self) -> 'Any': - """""" - pass + def country_code(self) -> Any: + ... @property - def workstations(self) -> 'Union[str]': - """""" - pass + def workstations(self) -> str: + ... @property - def max_storage(self) -> 'Any': - """""" - pass + def max_storage(self) -> Any: + ... @property - def units_per_week(self) -> 'Any': - """""" - pass + def units_per_week(self) -> Any: + ... @property - def logon_hours(self) -> 'str': - """""" - pass + def logon_hours(self) -> str: + ... @property - def code_page(self) -> 'Any': - """""" - pass + def code_page(self) -> Any: + ... -class PyUSER_INFO_2(object): +class PyUSER_INFO_2: """A dictionary holding the information in a Win32 USER_INFO_2 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def name(self) -> 'Union[str]': - """""" - pass + def name(self) -> str: + ... @property - def password(self) -> 'Union[str]': - """""" - pass + def password(self) -> str: + ... @property - def password_age(self) -> 'Any': - """""" - pass + def password_age(self) -> Any: + ... @property - def priv(self) -> 'Any': - """""" - pass + def priv(self) -> Any: + ... @property - def home_dir(self) -> 'Union[str]': - """""" - pass + def home_dir(self) -> str: + ... @property - def comment(self) -> 'Union[str]': - """""" - pass + def comment(self) -> str: + ... @property - def flags(self) -> 'Any': - """""" - pass + def flags(self) -> Any: + ... @property - def script_path(self) -> 'Union[str]': - """""" - pass + def script_path(self) -> str: + ... @property - def auth_flags(self) -> 'Any': - """""" - pass + def auth_flags(self) -> Any: + ... @property - def full_name(self) -> 'Union[str]': - """""" - pass + def full_name(self) -> str: + ... @property - def usr_comment(self) -> 'Union[str]': - """""" - pass + def usr_comment(self) -> str: + ... @property - def parms(self) -> 'Union[str]': - """""" - pass + def parms(self) -> str: + ... @property - def workstations(self) -> 'Union[str]': - """""" - pass + def workstations(self) -> str: + ... @property - def last_logon(self) -> 'Any': - """""" - pass + def last_logon(self) -> Any: + ... @property - def last_logoff(self) -> 'Any': - """""" - pass + def last_logoff(self) -> Any: + ... @property - def acct_expires(self) -> 'Any': - """""" - pass + def acct_expires(self) -> Any: + ... @property - def max_storage(self) -> 'Any': - """""" - pass + def max_storage(self) -> Any: + ... @property - def units_per_week(self) -> 'Any': - """""" - pass + def units_per_week(self) -> Any: + ... @property - def logon_hours(self) -> 'str': - """""" - pass + def logon_hours(self) -> str: + ... @property - def bad_pw_count(self) -> 'Any': - """""" - pass + def bad_pw_count(self) -> Any: + ... @property - def num_logons(self) -> 'Any': - """""" - pass + def num_logons(self) -> Any: + ... @property - def logon_server(self) -> 'Union[str]': - """""" - pass + def logon_server(self) -> str: + ... @property - def country_code(self) -> 'Any': - """""" - pass + def country_code(self) -> Any: + ... @property - def code_page(self) -> 'Any': - """""" - pass + def code_page(self) -> Any: + ... -class PyUSER_INFO_20(object): +class PyUSER_INFO_20: """A dictionary holding the information in a Win32 USER_INFO_20 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def name(self) -> 'Union[str]': - """""" - pass + def name(self) -> str: + ... @property - def full_name(self) -> 'Union[str]': - """""" - pass + def full_name(self) -> str: + ... @property - def comment(self) -> 'Union[str]': - """""" - pass + def comment(self) -> str: + ... @property - def flags(self) -> 'Any': - """""" - pass + def flags(self) -> Any: + ... @property - def user_id(self) -> 'Any': - """""" - pass + def user_id(self) -> Any: + ... -class PyUSER_INFO_3(object): +class PyUSER_INFO_3: """A dictionary holding the information in a Win32 USER_INFO_3 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def name(self) -> 'Union[str]': - """""" - pass + def name(self) -> str: + ... @property - def password(self) -> 'Union[str]': - """""" - pass + def password(self) -> str: + ... @property - def password_age(self) -> 'Any': - """""" - pass + def password_age(self) -> Any: + ... @property - def priv(self) -> 'Any': - """""" - pass + def priv(self) -> Any: + ... @property - def home_dir(self) -> 'Union[str]': - """""" - pass + def home_dir(self) -> str: + ... @property - def comment(self) -> 'Union[str]': - """""" - pass + def comment(self) -> str: + ... @property - def flags(self) -> 'Any': - """""" - pass + def flags(self) -> Any: + ... @property - def script_path(self) -> 'Union[str]': - """""" - pass + def script_path(self) -> str: + ... @property - def auth_flags(self) -> 'Any': - """""" - pass + def auth_flags(self) -> Any: + ... @property - def full_name(self) -> 'Union[str]': - """""" - pass + def full_name(self) -> str: + ... @property - def usr_comment(self) -> 'Union[str]': - """""" - pass + def usr_comment(self) -> str: + ... @property - def parms(self) -> 'Union[str]': - """""" - pass + def parms(self) -> str: + ... @property - def workstations(self) -> 'Union[str]': - """""" - pass + def workstations(self) -> str: + ... @property - def last_logon(self) -> 'Any': - """""" - pass + def last_logon(self) -> Any: + ... @property - def last_logoff(self) -> 'Any': - """""" - pass + def last_logoff(self) -> Any: + ... @property - def acct_expires(self) -> 'Any': - """""" - pass + def acct_expires(self) -> Any: + ... @property - def max_storage(self) -> 'Any': - """""" - pass + def max_storage(self) -> Any: + ... @property - def units_per_week(self) -> 'Any': - """""" - pass + def units_per_week(self) -> Any: + ... @property - def logon_hours(self) -> 'str': - """""" - pass + def logon_hours(self) -> str: + ... @property - def bad_pw_count(self) -> 'Any': - """""" - pass + def bad_pw_count(self) -> Any: + ... @property - def num_logons(self) -> 'Any': - """""" - pass + def num_logons(self) -> Any: + ... @property - def logon_server(self) -> 'Union[str]': - """""" - pass + def logon_server(self) -> str: + ... @property - def country_code(self) -> 'Any': - """""" - pass + def country_code(self) -> Any: + ... @property - def code_page(self) -> 'Any': - """""" - pass + def code_page(self) -> Any: + ... @property - def user_id(self) -> 'Any': - """""" - pass + def user_id(self) -> Any: + ... @property - def primary_group_id(self) -> 'Any': - """""" - pass + def primary_group_id(self) -> Any: + ... @property - def profile(self) -> 'Union[str]': - """""" - pass + def profile(self) -> str: + ... @property - def home_dir_drive(self) -> 'Union[str]': - """""" - pass + def home_dir_drive(self) -> str: + ... @property - def password_expired(self) -> 'Any': - """""" - pass + def password_expired(self) -> Any: + ... -class PyUSER_INFO_4(object): +class PyUSER_INFO_4: """A dictionary holding the information in a Win32 USER_INFO_4 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def name(self) -> 'Union[str]': - """""" - pass + def name(self) -> str: + ... @property - def password(self) -> 'Union[str]': - """""" - pass + def password(self) -> str: + ... @property - def password_age(self) -> 'Any': - """""" - pass + def password_age(self) -> Any: + ... @property - def priv(self) -> 'Any': - """""" - pass + def priv(self) -> Any: + ... @property - def home_dir(self) -> 'Union[str]': - """""" - pass + def home_dir(self) -> str: + ... @property - def comment(self) -> 'Union[str]': - """""" - pass + def comment(self) -> str: + ... @property - def flags(self) -> 'Any': - """""" - pass + def flags(self) -> Any: + ... @property - def script_path(self) -> 'Union[str]': - """""" - pass + def script_path(self) -> str: + ... @property - def auth_flags(self) -> 'Any': - """""" - pass + def auth_flags(self) -> Any: + ... @property - def full_name(self) -> 'Union[str]': - """""" - pass + def full_name(self) -> str: + ... @property - def usr_comment(self) -> 'Union[str]': - """""" - pass + def usr_comment(self) -> str: + ... @property - def parms(self) -> 'Union[str]': - """""" - pass + def parms(self) -> str: + ... @property - def workstations(self) -> 'Union[str]': - """""" - pass + def workstations(self) -> str: + ... @property - def last_logon(self) -> 'Any': - """""" - pass + def last_logon(self) -> Any: + ... @property - def last_logoff(self) -> 'Any': - """""" - pass + def last_logoff(self) -> Any: + ... @property - def acct_expires(self) -> 'Any': - """""" - pass + def acct_expires(self) -> Any: + ... @property - def max_storage(self) -> 'Any': - """""" - pass + def max_storage(self) -> Any: + ... @property - def units_per_week(self) -> 'Any': - """""" - pass + def units_per_week(self) -> Any: + ... @property - def logon_hours(self) -> 'str': - """""" - pass + def logon_hours(self) -> str: + ... @property - def bad_pw_count(self) -> 'Any': - """""" - pass + def bad_pw_count(self) -> Any: + ... @property - def num_logons(self) -> 'Any': - """""" - pass + def num_logons(self) -> Any: + ... @property - def logon_server(self) -> 'Union[str]': - """""" - pass + def logon_server(self) -> str: + ... @property - def country_code(self) -> 'Any': - """""" - pass + def country_code(self) -> Any: + ... @property - def code_page(self) -> 'Any': - """""" - pass + def code_page(self) -> Any: + ... @property - def user_sid(self) -> 'PySID': - """""" - pass + def user_sid(self) -> PySID: + ... @property - def primary_group_id(self) -> 'Any': - """""" - pass + def primary_group_id(self) -> Any: + ... @property - def profile(self) -> 'Union[str]': - """""" - pass + def profile(self) -> str: + ... @property - def home_dir_drive(self) -> 'Union[str]': - """""" - pass + def home_dir_drive(self) -> str: + ... @property - def password_expired(self) -> 'Any': - """""" - pass + def password_expired(self) -> Any: + ... -class PyUSER_MODALS_INFO_0(object): +class PyUSER_MODALS_INFO_0: """A dictionary holding the information in a Win32 USER_MODALS_INFO_0 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def min_passwd_len(self) -> 'Any': - """""" - pass + def min_passwd_len(self) -> Any: + ... @property - def max_passwd_age(self) -> 'Any': - """""" - pass + def max_passwd_age(self) -> Any: + ... @property - def min_passwd_age(self) -> 'Any': - """""" - pass + def min_passwd_age(self) -> Any: + ... @property - def force_logoff(self) -> 'Any': - """""" - pass + def force_logoff(self) -> Any: + ... @property - def password_hist_len(self) -> 'Any': - """""" - pass + def password_hist_len(self) -> Any: + ... -class PyUSER_MODALS_INFO_1(object): +class PyUSER_MODALS_INFO_1: """A dictionary holding the information in a Win32 USER_MODALS_INFO_1 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def role(self) -> 'Any': - """""" - pass + def role(self) -> Any: + ... @property - def primary(self) -> 'Union[str]': - """""" - pass + def primary(self) -> str: + ... -class PyUSER_MODALS_INFO_2(object): +class PyUSER_MODALS_INFO_2: """A dictionary holding the information in a Win32 USER_MODALS_INFO_2 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def domain_name(self) -> 'Union[str]': - """""" - pass + def domain_name(self) -> str: + ... @property - def domain_id(self) -> 'PySID': - """""" - pass + def domain_id(self) -> PySID: + ... -class PyUSER_MODALS_INFO_3(object): +class PyUSER_MODALS_INFO_3: """A dictionary holding the information in a Win32 USER_MODALS_INFO_3 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def lockout_duration(self) -> 'Any': - """""" - pass + def lockout_duration(self) -> Any: + ... @property - def lockout_observation_window(self) -> 'Any': - """""" - pass + def lockout_observation_window(self) -> Any: + ... @property - def usrmod3_lockout_threshold(self) -> 'Any': - """""" - pass + def usrmod3_lockout_threshold(self) -> Any: + ... -class PyUSE_INFO_0(object): +class PyUSE_INFO_0: """A dictionary holding the infomation in a Win32 USE_INFO_0 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def local(self) -> 'Union[str]': - """""" - pass + def local(self) -> str: + ... @property - def remote(self) -> 'Union[str]': - """""" - pass + def remote(self) -> str: + ... -class PyUSE_INFO_1(object): +class PyUSE_INFO_1: """A dictionary holding the infomation in a Win32 USE_INFO_1 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def local(self) -> 'Union[str]': - """""" - pass + def local(self) -> str: + ... @property - def remote(self) -> 'Union[str]': - """""" - pass + def remote(self) -> str: + ... @property - def password(self) -> 'Union[Any, str]': - """""" - pass + def password(self) -> Union[Any, str]: + ... @property - def status(self) -> 'Any': - """""" - pass + def status(self) -> Any: + ... @property - def asg_type(self) -> 'Any': - """""" - pass + def asg_type(self) -> Any: + ... @property - def refcount(self) -> 'Any': - """""" - pass + def refcount(self) -> Any: + ... @property - def usecount(self) -> 'Any': - """""" - pass + def usecount(self) -> Any: + ... -class PyUSE_INFO_2(object): +class PyUSE_INFO_2: """A dictionary holding the infomation in a Win32 USE_INFO_2 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def local(self) -> 'Union[str]': - """""" - pass + def local(self) -> str: + ... @property - def remote(self) -> 'Union[str]': - """""" - pass + def remote(self) -> str: + ... @property - def password(self) -> 'Union[Any, str]': - """""" - pass + def password(self) -> Union[Any, str]: + ... @property - def status(self) -> 'Any': - """""" - pass + def status(self) -> Any: + ... @property - def asg_type(self) -> 'Any': - """""" - pass + def asg_type(self) -> Any: + ... @property - def refcount(self) -> 'Any': - """""" - pass + def refcount(self) -> Any: + ... @property - def usecount(self) -> 'Any': - """""" - pass + def usecount(self) -> Any: + ... @property - def username(self) -> 'Union[str]': - """""" - pass + def username(self) -> str: + ... @property - def domainname(self) -> 'Union[str]': - """""" - pass + def domainname(self) -> str: + ... -class PyUSE_INFO_3(object): +class PyUSE_INFO_3: """A dictionary holding the infomation in a Win32 USE_INFO_3 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def local(self) -> 'Union[str]': - """""" - pass + def local(self) -> str: + ... @property - def remote(self) -> 'Union[str]': - """""" - pass + def remote(self) -> str: + ... @property - def password(self) -> 'Union[Any, str]': - """""" - pass + def password(self) -> Union[Any, str]: + ... @property - def status(self) -> 'Any': - """""" - pass + def status(self) -> Any: + ... @property - def asg_type(self) -> 'Any': - """""" - pass + def asg_type(self) -> Any: + ... @property - def refcount(self) -> 'Any': - """""" - pass + def refcount(self) -> Any: + ... @property - def usecount(self) -> 'Any': - """""" - pass + def usecount(self) -> Any: + ... @property - def username(self) -> 'Union[str]': - """""" - pass + def username(self) -> str: + ... @property - def domainname(self) -> 'Union[str]': - """""" - pass + def domainname(self) -> str: + ... @property - def flags(self) -> 'Any': - """""" - pass + def flags(self) -> Any: + ... -class PyUnicode(object): +class PyUnicode: """A Python object, representing a Unicode string.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyUrlCacheHANDLE(object): - """""" +class PyUrlCacheHANDLE: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyWAVEFORMATEX(object): +class PyWAVEFORMATEX: """A Python object, representing a WAVEFORMATEX structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def wFormatTag(self) -> 'int': + def wFormatTag(self) -> int: """Waveform-audio format type. pywintypes only defines WAVE_FORMAT_PCM as a constant. Other values must be looked up in the mmsystem.h header file.""" - pass + ... @property - def nChannels(self) -> 'int': + def nChannels(self) -> int: """Number of channels. 1 for Mono, 2 for Stereo, anything, but never 5.1.""" - pass + ... @property - def nSamplesPerSec(self) -> 'int': + def nSamplesPerSec(self) -> int: """Sample rate, in samples per second (hertz), that each channel should be played or recorded. If wFormatTag is WAVE_FORMAT_PCM, then common values for nSamplesPerSec are 8000, 11025, 22050, and 44100 Hz""" - pass + ... @property - def nAvgBytesPerSec(self) -> 'int': + def nAvgBytesPerSec(self) -> int: """Required average data-transfer rate, in bytes per second, for the format tag. If wFormatTag is WAVE_FORMAT_PCM, nAvgBytesPerSec should be equal to the product of nSamplesPerSec and nBlockAlign.""" - pass + ... @property - def nBlockAlign(self) -> 'int': + def nBlockAlign(self) -> int: """Block alignment, in bytes. The block alignment is the minimum atomic unit of data for the wFormatTag format type. If wFormatTag is WAVE_FORMAT_PCM, nBlockAlign should be equal to the product of nChannels and wBitsPerSample divided by 8 (bits per byte). For non-PCM formats, this member must be computed according to the manufacturer’s specification of the format tag.""" - pass + ... @property - def wBitsPerSample(self) -> 'int': + def wBitsPerSample(self) -> int: """Bits per sample for the wFormatTag format type. If wFormatTag is WAVE_FORMAT_PCM, then wBitsPerSample should be equal to 8 or 16. Sentinel""" - pass + ... -class PyWINHTTP_AUTOPROXY_OPTIONS(object): - """""" +class PyWINHTTP_AUTOPROXY_OPTIONS: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyWINHTTP_PROXY_INFO(object): +class PyWINHTTP_PROXY_INFO: """A tuple representing a WINHTTP_PROXY_INFO structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyWKSTA_INFO_100(object): +class PyWKSTA_INFO_100: """A dictionary holding the infomation in a Win32 WKSTA_INFO_100 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def platform_id(self) -> 'Any': + def platform_id(self) -> Any: """Indicates platform level to use to retrieve platform specific information""" - pass + ... @property - def computername(self) -> 'Union[str]': + def computername(self) -> str: """Name of the local computer""" - pass + ... @property - def langroup(self) -> 'Union[str]': + def langroup(self) -> str: """Name of the domain to which computer belongs""" - pass + ... @property - def ver_major(self) -> 'Any': + def ver_major(self) -> Any: """Major version number of operating system running on the computer""" - pass + ... @property - def ver_minor(self) -> 'Any': + def ver_minor(self) -> Any: """Minor version number of operating system running on the computer""" - pass + ... -class PyWKSTA_INFO_101(object): +class PyWKSTA_INFO_101: """A dictionary holding the infomation in a Win32 WKSTA_INFO_101 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def platform_id(self) -> 'Any': + def platform_id(self) -> Any: """Indicates platform level to use to retrieve platform specific information""" - pass + ... @property - def computername(self) -> 'Union[str]': + def computername(self) -> str: """Name of the local computer""" - pass + ... @property - def langroup(self) -> 'Union[str]': + def langroup(self) -> str: """Name of the domain to which computer belongs""" - pass + ... @property - def ver_major(self) -> 'Any': + def ver_major(self) -> Any: """Major version number of operating system running on the computer""" - pass + ... @property - def ver_minor(self) -> 'Any': + def ver_minor(self) -> Any: """Minor version number of operating system running on the computer""" - pass + ... @property - def lanroot(self) -> 'Union[str]': + def lanroot(self) -> str: """Path to the LANMAN directory""" - pass + ... -class PyWKSTA_INFO_102(object): +class PyWKSTA_INFO_102: """A dictionary holding the infomation in a Win32 WKSTA_INFO_102 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def platform_id(self) -> 'Any': + def platform_id(self) -> Any: """Indicate platform level to use to retrieve platform specific information""" - pass + ... @property - def computername(self) -> 'Union[str]': + def computername(self) -> str: """Name of the local computer""" - pass + ... @property - def langroup(self) -> 'Union[str]': + def langroup(self) -> str: """Name of the domain to which computer belongs""" - pass + ... @property - def ver_major(self) -> 'Any': + def ver_major(self) -> Any: """Major version number of operating system running on the computer""" - pass + ... @property - def ver_minor(self) -> 'Any': + def ver_minor(self) -> Any: """Minor version number of operating system running on the computer""" - pass + ... @property - def lanroot(self) -> 'Union[str]': + def lanroot(self) -> str: """Path to the LANMAN directory""" - pass + ... @property - def logged_on_users(self) -> 'Any': + def logged_on_users(self) -> Any: """Number of users who are logged on to the local computer""" - pass + ... -class PyWKSTA_INFO_302(object): +class PyWKSTA_INFO_302: """A dictionary holding the infomation in a Win32 WKSTA_INFO_302 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def char_wait(self) -> 'Any': + def char_wait(self) -> Any: """number of seconds the computer will wait for a remote resource to become available""" - pass + ... @property - def collection_time(self) -> 'Any': + def collection_time(self) -> Any: """number of milliseconds the computer will collect data before sending the data to a character device resource. The workstation waits the specified time or collects the number of characters specified by wki302_maximum_collection_count, whichever comes first.""" - pass + ... @property - def maximum_collection_count(self) -> 'Any': + def maximum_collection_count(self) -> Any: """Specifies the number of bytes of information the computer will collect before sending the data to a character device resource. The workstation collects the specified number of bytes or waits the time specified by wki302_collection_time, whichever comes first.""" - pass + ... @property - def keep_conn(self) -> 'Any': + def keep_conn(self) -> Any: """Specifies the number of seconds the server will maintain an inactive connection to a resource.""" - pass + ... @property - def keep_search(self) -> 'Any': + def keep_search(self) -> Any: """Defines the number of seconds an inactive search will continue.""" - pass + ... @property - def max_cmds(self) -> 'Any': + def max_cmds(self) -> Any: """Specifies the number of simultaneous network device driver commands that can be sent to the network.""" - pass + ... @property - def num_work_buf(self) -> 'Any': + def num_work_buf(self) -> Any: """Specifies the number of internal buffers the computer has.""" - pass + ... @property - def siz_work_buf(self) -> 'Any': + def siz_work_buf(self) -> Any: """Specifies the size, in bytes, of each internal buffer.""" - pass + ... @property - def max_wrk_cache(self) -> 'Any': + def max_wrk_cache(self) -> Any: """Specifies the maximum size, in bytes, of an internal cache buffer.""" - pass + ... @property - def siz_error(self) -> 'Any': + def siz_error(self) -> Any: """Specifies the size, in bytes, of an internal error buffer.""" - pass + ... @property - def num_alerts(self) -> 'Any': + def num_alerts(self) -> Any: """Specifies the maximum number of clients that can receive alert messages. (This member is not supported under MS-DOS.) The Alerter service registers at least three clients when it begins to run.""" - pass + ... @property - def num_services(self) -> 'Any': + def num_services(self) -> Any: """Specifies the number of services that can be installed on the computer at any time.""" - pass + ... @property - def errlog_sz(self) -> 'Any': + def errlog_sz(self) -> Any: """Specifies the maximum size, in kilobytes, of the client's error log file.""" - pass + ... @property - def print_buf_time(self) -> 'Any': + def print_buf_time(self) -> Any: """Specifies the number of seconds the server waits before closing inactive compatibility-mode print jobs.""" - pass + ... @property - def num_char_buf(self) -> 'Any': + def num_char_buf(self) -> Any: """Specifies the number of character pipe buffers and device buffers the client can have.""" - pass + ... @property - def siz_char_buf(self) -> 'Any': + def siz_char_buf(self) -> Any: """Specifies the maximum size, in bytes, of a character pipe buffer and device buffer.""" - pass + ... @property - def wrk_heuristics(self) -> 'Union[str]': + def wrk_heuristics(self) -> str: """Pointer to a Unicode string of flags used to control a client's operation.""" - pass + ... @property - def mailslots(self) -> 'Any': + def mailslots(self) -> Any: """Specifies the maximum number of mailslots allowed.""" - pass + ... @property - def num_dgram_buf(self) -> 'Any': + def num_dgram_buf(self) -> Any: """Specifies the number of buffers to allocate for receiving datagrams.""" - pass + ... -class PyWKSTA_INFO_402(object): +class PyWKSTA_INFO_402: """A dictionary holding the infomation in a Win32 WKSTA_INFO_402 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def char_wait(self) -> 'Any': + def char_wait(self) -> Any: """number of seconds the computer will wait for a remote resource to become available""" - pass + ... @property - def collection_time(self) -> 'Any': + def collection_time(self) -> Any: """number of milliseconds the computer will collect data before sending the data to a character device resource. The workstation waits the specified time or collects the number of characters specified by wki402_maximum_collection_count, whichever comes first.""" - pass + ... @property - def maximum_collection_count(self) -> 'Union[str]': + def maximum_collection_count(self) -> str: """Name of the domain to which computer belongs""" - pass + ... @property - def keep_conn(self) -> 'Any': + def keep_conn(self) -> Any: """Major version number of operating system running on the computer""" - pass + ... @property - def keep_search(self) -> 'Any': + def keep_search(self) -> Any: """Minor version number of operating system running on the computer""" - pass + ... @property - def max_cmds(self) -> 'Any': + def max_cmds(self) -> Any: """..""" - pass + ... @property - def num_work_buf(self) -> 'Any': + def num_work_buf(self) -> Any: """Number of users who are logged on to the local computer""" - pass + ... @property - def siz_work_buf(self) -> 'Any': + def siz_work_buf(self) -> Any: """Number of users who are logged on to the local computer""" - pass + ... @property - def max_wrk_cache(self) -> 'Any': + def max_wrk_cache(self) -> Any: """..""" - pass + ... @property - def sess_timeout(self) -> 'Any': + def sess_timeout(self) -> Any: """..""" - pass + ... @property - def siz_error(self) -> 'Any': + def siz_error(self) -> Any: """..""" - pass + ... @property - def num_alerts(self) -> 'Any': + def num_alerts(self) -> Any: """..""" - pass + ... @property - def num_services(self) -> 'Any': + def num_services(self) -> Any: """..""" - pass + ... @property - def errlog_sz(self) -> 'Any': + def errlog_sz(self) -> Any: """..""" - pass + ... @property - def print_buf_time(self) -> 'Any': + def print_buf_time(self) -> Any: """..""" - pass + ... @property - def num_char_buf(self) -> 'Any': + def num_char_buf(self) -> Any: """..""" - pass + ... @property - def siz_char_buf(self) -> 'Any': + def siz_char_buf(self) -> Any: """Specifies the maximum size, in bytes, of a character pipe buffer and device buffer.""" - pass + ... @property - def mailslots(self) -> 'Any': + def mailslots(self) -> Any: """..""" - pass + ... @property - def num_dgram_buf(self) -> 'Any': + def num_dgram_buf(self) -> Any: """..""" - pass + ... @property - def max_threads(self) -> 'Any': + def max_threads(self) -> Any: """Number of threads the computer can dedicate to the network""" - pass + ... -class PyWKSTA_INFO_502(object): +class PyWKSTA_INFO_502: """A dictionary holding the infomation in a Win32 WKSTA_INFO_502 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def char_wait(self) -> 'Any': + def char_wait(self) -> Any: """number of seconds the computer will wait for a remote resource to become available""" - pass + ... @property - def collection_time(self) -> 'Any': + def collection_time(self) -> Any: """number of milliseconds the computer will collect data before sending the data to a character device resource. The workstation waits the specified time or collects the number of characters specified by wki502_maximum_collection_count, whichever comes first.""" - pass + ... @property - def maximum_collection_count(self) -> 'Any': + def maximum_collection_count(self) -> Any: """Specifies the number of bytes of information the computer will collect before sending the data to a character device resource. The workstation collects the specified number of bytes or waits the time specified by wki302_collection_time, whichever comes first.""" - pass + ... @property - def keep_conn(self) -> 'Any': + def keep_conn(self) -> Any: """Specifies the number of seconds the server will maintain an inactive connection to a resource.""" - pass + ... @property - def max_cmds(self) -> 'Any': + def max_cmds(self) -> Any: """Specifies the number of simultaneous network device driver commands that can be sent to the network.""" - pass + ... @property - def max_wrk_cache(self) -> 'Any': + def max_wrk_cache(self) -> Any: """Indicates the number of seconds the server waits before disconnecting an inactive session.""" - pass + ... @property - def siz_char_buf(self) -> 'Any': + def siz_char_buf(self) -> Any: """Specifies the maximum size, in bytes, of a character pipe buffer and device buffer.""" - pass + ... @property - def lock_quota(self) -> 'Any': + def lock_quota(self) -> Any: """TODO""" - pass + ... @property - def lock_increment(self) -> 'Any': + def lock_increment(self) -> Any: """TODO""" - pass + ... @property - def lock_maximum(self) -> 'Any': + def lock_maximum(self) -> Any: """TODO""" - pass + ... @property - def pipe_increment(self) -> 'Any': + def pipe_increment(self) -> Any: """TODO""" - pass + ... @property - def pipe_maximum(self) -> 'Any': + def pipe_maximum(self) -> Any: """TODO""" - pass + ... @property - def cache_file_timeout(self) -> 'Any': + def cache_file_timeout(self) -> Any: """TODO""" - pass + ... @property - def dormant_file_limit(self) -> 'Any': + def dormant_file_limit(self) -> Any: """TODO""" - pass + ... @property - def read_ahead_throughput(self) -> 'Any': + def read_ahead_throughput(self) -> Any: """TODO""" - pass + ... @property - def num_mailslot_buffers(self) -> 'Any': + def num_mailslot_buffers(self) -> Any: """TODO""" - pass + ... @property - def num_srv_announce_buffers(self) -> 'Any': + def num_srv_announce_buffers(self) -> Any: """TODO""" - pass + ... @property - def max_illegal_datagram_events(self) -> 'Any': + def max_illegal_datagram_events(self) -> Any: """TODO""" - pass + ... @property - def illegal_datagram_event_reset_frequency(self) -> 'Any': + def illegal_datagram_event_reset_frequency(self) -> Any: """TODO""" - pass + ... @property - def log_election_packets(self) -> 'Any': + def log_election_packets(self) -> Any: """TODO""" - pass + ... @property - def use_opportunistic_locking(self) -> 'Any': + def use_opportunistic_locking(self) -> Any: """TODO""" - pass + ... @property - def use_unlock_behind(self) -> 'Any': + def use_unlock_behind(self) -> Any: """TODO""" - pass + ... @property - def use_close_behind(self) -> 'Any': + def use_close_behind(self) -> Any: """TODO""" - pass + ... @property - def buf_named_pipes(self) -> 'Any': + def buf_named_pipes(self) -> Any: """TODO""" - pass + ... @property - def use_lock_read_unlock(self) -> 'Any': + def use_lock_read_unlock(self) -> Any: """TODO""" - pass + ... @property - def utilize_nt_caching(self) -> 'Any': + def utilize_nt_caching(self) -> Any: """TODO""" - pass + ... @property - def use_raw_read(self) -> 'Any': + def use_raw_read(self) -> Any: """TODO""" - pass + ... @property - def use_raw_write(self) -> 'Any': + def use_raw_write(self) -> Any: """TODO""" - pass + ... @property - def use_write_raw_data(self) -> 'Any': + def use_write_raw_data(self) -> Any: """TODO""" - pass + ... @property - def use_encryption(self) -> 'Any': + def use_encryption(self) -> Any: """TODO""" - pass + ... @property - def buf_files_deny_write(self) -> 'Any': + def buf_files_deny_write(self) -> Any: """TODO""" - pass + ... @property - def buf_read_only_files(self) -> 'Any': + def buf_read_only_files(self) -> Any: """TODO""" - pass + ... @property - def force_core_create_mode(self) -> 'Any': + def force_core_create_mode(self) -> Any: """TODO""" - pass + ... @property - def use_512_byte_max_transfer(self) -> 'Any': + def use_512_byte_max_transfer(self) -> Any: """TODO""" - pass + ... -class PyWKSTA_TRANSPORT_INFO_0(object): +class PyWKSTA_TRANSPORT_INFO_0: """A dictionary holding the infomation in a Win32 WKSTA_TRANSPORT_INFO_0 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def quality_of_service(self) -> 'Any': + def quality_of_service(self) -> Any: """Supplies a value that specifies the search order of the transport protocol with respect to other transport protocols. The highest value is searched first.""" - pass + ... @property - def number_of_vcs(self) -> 'Any': + def number_of_vcs(self) -> Any: """Specifies the number of clients communicating with the server using this transport protocol.""" - pass + ... @property - def transport_name(self) -> 'Union[str]': + def transport_name(self) -> str: """Specifies the device name of the transport protocol.""" - pass + ... @property - def transport_address(self) -> 'Union[str]': + def transport_address(self) -> str: """Specifies the address of the server on this transport protocol.""" - pass + ... @property - def wan_ish(self) -> 'Any': + def wan_ish(self) -> Any: """This member is ignored by the NetWkstaTransportAdd function. For the NetWkstaTransportEnum function, this member indicates that this transport protocol is a WAN transport protocol. This member is set TRUE for NetBIOS/TCIP; it is set FALSE for NetBEUI and NetBIOS/IPX.""" - pass + ... -class PyWKSTA_USER_INFO_0(object): +class PyWKSTA_USER_INFO_0: """A dictionary holding the infomation in a Win32 WKSTA_USER_INFO_0 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def username(self) -> 'Union[str]': + def username(self) -> str: """Name of user currently logged on to the workstation""" - pass + ... -class PyWKSTA_USER_INFO_1(object): +class PyWKSTA_USER_INFO_1: """A dictionary holding the infomation in a Win32 WKSTA_USER_INFO_1 structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def username(self) -> 'Union[str]': + def username(self) -> str: """Name of user currently logged on to the workstation""" - pass + ... @property - def logon_domain(self) -> 'Union[str]': + def logon_domain(self) -> str: """Returns the domain name of the user account of the user currently logged on to the workstation.""" - pass + ... @property - def oth_domains(self) -> 'Union[str]': + def oth_domains(self) -> str: """Returns the list of other operating system domains browsed by the workstation. The domain names are separated by blanks.""" - pass + ... @property - def logon_server(self) -> 'Union[str]': + def logon_server(self) -> str: """Returns the name of the computer that authenticated the server.""" - pass + ... -class PyWNDCLASS(object): +class PyWNDCLASS: """A Python object, representing an WNDCLASS structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def style(self) -> 'int': - """""" - pass + def style(self) -> int: + ... @property - def cbWndExtra(self) -> 'int': - """""" - pass + def cbWndExtra(self) -> int: + ... @property - def hInstance(self) -> 'int': - """""" - pass + def hInstance(self) -> int: + ... @property - def hIcon(self) -> 'int': - """""" - pass + def hIcon(self) -> int: + ... @property - def hCursor(self) -> 'int': - """""" - pass + def hCursor(self) -> int: + ... @property - def hbrBackground(self) -> 'int': + def hbrBackground(self) -> int: """These 3 handled manually in PyWNDCLASS::getattro/setattro. The pymeth below is used as an end tag, so these props will be lost if below it""" - pass + ... @property - def lpszMenuName(self) -> 'Union[str]': - """""" - pass + def lpszMenuName(self) -> str: + ... @property - def lpszClassName(self) -> 'Union[str]': - """""" - pass + def lpszClassName(self) -> str: + ... @property - def lpfnWndProc(self) -> 'Any': + def lpfnWndProc(self) -> Any: """MethodsSetDialogProcSets the WNDCLASS to be for a dialog box. """ - pass + ... - def SetDialogProc(self,) -> 'None': + def SetDialogProc(self) -> None: """ Sets the WNDCLASS to be for a dialog box @@ -9134,10 +8676,10 @@ Returns: None """ - pass + ... -class PyXFORM(object): +class PyXFORM: """Dict representing an XFORM struct used as a world transformation matrix All members are optional, defaulting to 0.0.""" @@ -9146,43 +8688,43 @@ All members are optional, defaulting to 0.0.""" raise Exception('This class just for typing, can not be instanced!') @property - def M11(self) -> 'float': + def M11(self) -> float: """Usage is dependent on operation performed, see MSDN docs""" - pass + ... @property - def M12(self) -> 'float': + def M12(self) -> float: """Usage is dependent on operation performed, see MSDN docs""" - pass + ... @property - def M21(self) -> 'float': + def M21(self) -> float: """Usage is dependent on operation performed, see MSDN docs""" - pass + ... @property - def M22(self) -> 'float': + def M22(self) -> float: """Usage is dependent on operation performed, see MSDN docs""" - pass + ... @property - def Dx(self) -> 'float': + def Dx(self) -> float: """Horizontal offset in logical units""" - pass + ... @property - def Dy(self) -> 'float': + def Dy(self) -> float: """Vertical offset in logical units""" - pass + ... -class Pymmapfile(object): +class Pymmapfile: """Object that provides access to memory-mapped file operations.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def close(self,) -> 'None': + def close(self) -> None: """ Closes the file mapping handle and releases mapped view @@ -9195,9 +8737,9 @@ Returns: None """ - pass + ... - def find(self, needle: 'Any', start: 'Any') -> 'Any': + def find(self, needle: Any, start: Any) -> Any: """ Finds a string in the buffer. @@ -9212,9 +8754,9 @@ Returns: """ - pass + ... - def flush(self, offset: 'Any' = 0, size: 'Any' = 0) -> 'None': + def flush(self, offset: Any = 0, size: Any = 0) -> None: """ Flushes memory buffer to disk @@ -9228,9 +8770,9 @@ Returns: None """ - pass + ... - def move(self, dest: 'Any', src: 'Any', count: 'Any') -> 'None': + def move(self, dest: Any, src: Any, count: Any) -> None: """ Moves data from one place in buffer to another @@ -9245,9 +8787,9 @@ Returns: None """ - pass + ... - def read(self, num_bytes: 'Any') -> 'Any': + def read(self, num_bytes: Any) -> Any: """ Returns specified number of bytes from buffer, and advances current position @@ -9260,9 +8802,9 @@ Returns: Any """ - pass + ... - def read_byte(self,) -> 'Any': + def read_byte(self) -> Any: """ Reads a single character from current pos @@ -9275,9 +8817,9 @@ Returns: Any """ - pass + ... - def read_line(self,) -> 'Any': + def read_line(self) -> Any: """ Reads data from current pos up to next EOL. @@ -9290,9 +8832,9 @@ Returns: Any """ - pass + ... - def resize(self, MaximumSize: 'Any', FileOffset: 'Any' = 0, NumberOfBytesToMap: 'Any' = 0) -> 'None': + def resize(self, MaximumSize: Any, FileOffset: Any = 0, NumberOfBytesToMap: Any = 0) -> None: """ Resizes the file mapping and view. @@ -9307,9 +8849,9 @@ Returns: None """ - pass + ... - def seek(self, dist: 'Any', how: 'Any' = 0) -> 'None': + def seek(self, dist: Any, how: Any = 0) -> None: """ Changes current position @@ -9323,9 +8865,9 @@ Returns: None """ - pass + ... - def size(self,) -> 'Any': + def size(self) -> Any: """ Returns size of current view @@ -9338,9 +8880,9 @@ Returns: Any """ - pass + ... - def tell(self,) -> 'Any': + def tell(self) -> Any: """ Returns current position in buffer @@ -9353,9 +8895,9 @@ Returns: Any """ - pass + ... - def write(self, data: 'Any') -> 'None': + def write(self, data: Any) -> None: """ Places data at current pos in buffer. @@ -9368,9 +8910,9 @@ Returns: None """ - pass + ... - def write_byte(self, char: 'Any') -> 'None': + def write_byte(self, char: Any) -> None: """ Writes a single character of data @@ -9383,10 +8925,10 @@ Returns: None """ - pass + ... -class RASDIALEXTENSIONS(object): +class RASDIALEXTENSIONS: """An object that describes a Win32 RASDIALEXTENSIONS structure TRUE*/)""" @@ -9395,124 +8937,120 @@ TRUE*/)""" raise Exception('This class just for typing, can not be instanced!') @property - def dwfOptions(self) -> 'int': + def dwfOptions(self) -> int: """(fOptions may also be used)""" - pass + ... @property - def hwndParent(self) -> 'int': - """""" - pass + def hwndParent(self) -> int: + ... @property - def reserved(self) -> 'int': - """""" - pass + def reserved(self) -> int: + ... @property - def reserved1(self) -> 'int': - """""" - pass + def reserved1(self) -> int: + ... @property - def RasEapInfo(self) -> 'Any': - """""" - pass + def RasEapInfo(self) -> Any: + ... -class RASDIALPARAMS(object): +class RASDIALPARAMS: """A tuple that describes a Win32 RASDIALPARAMS structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class SC_ACTION(object): +class SC_ACTION: """Tuple of 2 ints (Type,Delay) used to represent an SC_ACTION structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def Type(self) -> 'Any': + def Type(self) -> Any: """One of SC_ACTION_NONE, SC_ACTION_REBOOT, SC_ACTION_RESTART, SC_ACTION_RUN_COMMAND""" - pass + ... @property - def Delay(self) -> 'Any': + def Delay(self) -> Any: """Time delay before specified action is taken (in milliseconds)""" - pass + ... -class SERVICE_FAILURE_ACTIONS(object): +class SERVICE_FAILURE_ACTIONS: """A dictionary representing a SERVICE_FAILURE_ACTIONS structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def ResetPeriod(self) -> 'Any': + def ResetPeriod(self) -> Any: """Indicates how many seconds to wait to reset the failure count, can be INFINITE""" - pass + ... @property - def RebootMsg(self) -> 'Union[Any, str]': + def RebootMsg(self) -> Union[Any, str]: """Message displayed when reboot action is taken""" - pass + ... @property - def Command(self) -> 'Union[Any, str]': + def Command(self) -> Union[Any, str]: """Command line to execute for SC_ACTION_RUN_COMMAND""" - pass + ... @property - def Actions(self) -> 'Any': + def Actions(self) -> Any: """A tuple of SC_ACTION tuples""" - pass + ... -class SERVICE_STATUS(object): +class SERVICE_STATUS: """A Win32 service status object is represented by a tuple:""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class TRACKMOUSEEVENT(object): +class TRACKMOUSEEVENT: """A tuple of (dwFlags, hwndTrack, dwHoverTime)""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class ULARGE_INTEGER(object): +class ULARGE_INTEGER: """A Python object used wherever a COM ULARGE_INTEGER is used.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class WIN32_FIND_DATA(object): +class WIN32_FIND_DATA: """A tuple representing a WIN32_FIND_DATA structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class com_error(object): +class com_error: """An exception raised when a COM exception occurs.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class connection(object): +class connection: """An object representing an ODBC connection""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def setautocommit(self, c: 'Any') -> 'None': + def setautocommit(self, c: Any) -> None: """ Sets the autocommit mode. @@ -9525,9 +9063,9 @@ Returns: None """ - pass + ... - def commit(self,) -> 'None': + def commit(self) -> None: """ Commits a transaction. @@ -9540,9 +9078,9 @@ Returns: None """ - pass + ... - def rollback(self,) -> 'None': + def rollback(self) -> None: """ Rollsback a transaction. @@ -9555,9 +9093,9 @@ Returns: None """ - pass + ... - def cursor(self,) -> 'None': + def cursor(self) -> None: """ None @@ -9570,9 +9108,9 @@ Returns: None """ - pass + ... - def close(self,) -> 'None': + def close(self) -> None: """ Closes the connection. @@ -9585,16 +9123,16 @@ Returns: None """ - pass + ... -class cursor(object): +class cursor: """An object representing an ODBC cursor.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def close(self,) -> 'None': + def close(self) -> None: """ Closes the cursor @@ -9607,9 +9145,9 @@ Returns: None """ - pass + ... - def execute(self, sql: 'str', arg: 'Any') -> 'Any': + def execute(self, sql: str, arg: Any) -> Any: """ Execute some SQL @@ -9623,9 +9161,9 @@ Returns: Any """ - pass + ... - def fetchone(self,) -> 'Any': + def fetchone(self) -> Any: """ Fetch one row of data @@ -9638,9 +9176,9 @@ Returns: Any """ - pass + ... - def fetchmany(self,) -> 'List[Any]': + def fetchmany(self) -> List[Any]: """ Fetch many rows of data @@ -9653,9 +9191,9 @@ Returns: List[Any] """ - pass + ... - def fetchall(self,) -> 'List[Any]': + def fetchall(self) -> List[Any]: """ Fetch all rows of data @@ -9668,9 +9206,9 @@ Returns: List[Any] """ - pass + ... - def setinputsizes(self,) -> 'None': + def setinputsizes(self) -> None: """ None @@ -9683,9 +9221,9 @@ Returns: None """ - pass + ... - def setoutputsize(self,) -> 'None': + def setoutputsize(self) -> None: """ None @@ -9698,590 +9236,560 @@ Returns: None """ - pass + ... -class error(object): +class error: """An exception raised when a win32 error occurs""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class COMPONENT(object): +class COMPONENT: """A dictionary containing data to fill a COMPPOS struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def ID(self) -> 'Any': + def ID(self) -> Any: """Id of component, ignored when adding a new component""" - pass + ... @property - def ComponentType(self) -> 'Any': + def ComponentType(self) -> Any: """One of shellcon.COMP_TYPE_* values""" - pass + ... @property - def Checked(self) -> 'Any': + def Checked(self) -> Any: """True indicates item is currently displayed""" - pass + ... @property - def fDirty(self) -> 'Any': + def fDirty(self) -> Any: """Indicates if unsaved changes exist""" - pass + ... @property - def NoScroll(self) -> 'Any': + def NoScroll(self) -> Any: """True disables scrolling""" - pass + ... @property - def Pos(self) -> 'Any': + def Pos(self) -> Any: """COMPPOS dictionary determining window size and placement""" - pass + ... @property - def FriendlyName(self) -> 'Any': + def FriendlyName(self) -> Any: """String of at most MAX_PATH-1 characters, truncated if longer""" - pass + ... @property - def Source(self) -> 'Any': + def Source(self) -> Any: """String of at most INTERNET_MAX_URL_LENGTH-1 characters""" - pass + ... @property - def SubscribedURL(self) -> 'Any': + def SubscribedURL(self) -> Any: """String of at most INTERNET_MAX_URL_LENGTH-1 characters""" - pass + ... @property - def CurItemState(self) -> 'Any': + def CurItemState(self) -> Any: """One of shellcon.IS_* flags""" - pass + ... @property - def Original(self) -> 'Any': + def Original(self) -> Any: """COMPSTATEINFO dictionary""" - pass + ... @property - def Restored(self) -> 'Any': + def Restored(self) -> Any: """COMPSTATEINFO dictionary""" - pass + ... @property - def Size(self) -> 'Any': + def Size(self) -> Any: """Size of structure, ignored on input""" - pass + ... -class COMPONENTSOPT(object): +class COMPONENTSOPT: """A dictionary containing data to fill a COMPONENTSOPT struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def EnableComponents(self) -> 'Any': + def EnableComponents(self) -> Any: """True if components are enabled""" - pass + ... @property - def ActiveDesktop(self) -> 'Any': + def ActiveDesktop(self) -> Any: """True if Active Desktop is enabled""" - pass + ... @property - def Size(self) -> 'Any': + def Size(self) -> Any: """Size of structure, ignored on input""" - pass + ... -class COMPPOS(object): +class COMPPOS: """A dictionary containing data to fill a COMPPOS struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def Left(self) -> 'Any': - """""" - pass + def Left(self) -> Any: + ... @property - def Top(self) -> 'Any': - """""" - pass + def Top(self) -> Any: + ... @property - def Width(self) -> 'Any': - """""" - pass + def Width(self) -> Any: + ... @property - def Height(self) -> 'Any': - """""" - pass + def Height(self) -> Any: + ... @property - def Index(self) -> 'Any': - """""" - pass + def Index(self) -> Any: + ... @property - def CanResize(self) -> 'Any': - """""" - pass + def CanResize(self) -> Any: + ... @property - def CanResizeX(self) -> 'Any': - """""" - pass + def CanResizeX(self) -> Any: + ... @property - def CanResizeY(self) -> 'Any': - """""" - pass + def CanResizeY(self) -> Any: + ... @property - def PreferredLeftPercent(self) -> 'Any': - """""" - pass + def PreferredLeftPercent(self) -> Any: + ... @property - def PreferredTopPercent(self) -> 'Any': - """""" - pass + def PreferredTopPercent(self) -> Any: + ... @property - def Size(self) -> 'Any': + def Size(self) -> Any: """Size of structure, ignored on input""" - pass + ... -class COMPSTATEINFO(object): +class COMPSTATEINFO: """A dictionary containing data to fill a COMPSTATEINFO struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def Left(self) -> 'Any': + def Left(self) -> Any: """Specified as screen coordinates""" - pass + ... @property - def Top(self) -> 'Any': + def Top(self) -> Any: """Specified as screen coordinates""" - pass + ... @property - def Width(self) -> 'Any': + def Width(self) -> Any: """Measured in pixels""" - pass + ... @property - def Height(self) -> 'Any': + def Height(self) -> Any: """Measured in pixels""" - pass + ... @property - def dwItemState(self) -> 'Any': + def dwItemState(self) -> Any: """One of IS_NORMAL, IS_FULLSCREEN IS_SPLIT""" - pass + ... @property - def Size(self) -> 'Any': + def Size(self) -> Any: """Size of structure, ignored on input""" - pass + ... -class DEFCONTENTMENU(object): +class DEFCONTENTMENU: """A tuple representing a DEFCONTEXTMENU structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class ELEMDESC(object): +class ELEMDESC: """An ELEMDESC is respresented as a tuple of""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class EXP_DARWIN_LINK(object): +class EXP_DARWIN_LINK: """Dictionary containing information for a EXP_DARWIN_LINK struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def Signature(self) -> 'Any': + def Signature(self) -> Any: """The type of data block, one of shellcon.*_SIG values""" - pass + ... @property - def DarwinID(self) -> 'Any': + def DarwinID(self) -> Any: """The Windows Installer id for the link""" - pass + ... @property - def wDarwinID(self) -> 'Any': + def wDarwinID(self) -> Any: """The installer id as Unicode""" - pass + ... @property - def Size(self) -> 'Any': + def Size(self) -> Any: """Size of structure, ignored on input""" - pass + ... -class EXP_SPECIAL_FOLDER(object): +class EXP_SPECIAL_FOLDER: """Dictionary containing information for a EXP_SPECIAL_FOLDER struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def Signature(self) -> 'Any': + def Signature(self) -> Any: """The type of data block, one of shellcon.*_SIG values""" - pass + ... @property - def idSpecialFolder(self) -> 'Any': + def idSpecialFolder(self) -> Any: """The special folder id of the target (shellcon.CSIDL_*)""" - pass + ... @property - def Offset(self) -> 'Any': + def Offset(self) -> Any: """Offset into the link's PIDL""" - pass + ... @property - def Size(self) -> 'Any': + def Size(self) -> Any: """Size of structure, ignored on input""" - pass + ... -class EXP_SZ_LINK(object): +class EXP_SZ_LINK: """Dictionary containing information for an EXP_SZ_LINK or EXP_SZ_ICON struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def Signature(self) -> 'Any': + def Signature(self) -> Any: """The type of data block, one of shellcon.*_SIG values""" - pass + ... @property - def Target(self) -> 'Any': + def Target(self) -> Any: """The link's target or icon location""" - pass + ... @property - def wTarget(self) -> 'Any': + def wTarget(self) -> Any: """The target in Unicode form""" - pass + ... @property - def Size(self) -> 'Any': + def Size(self) -> Any: """Size of structure, ignored on input""" - pass + ... -class FUNCDESC(object): +class FUNCDESC: """A FUNCDESC object represents a COM TYPEATTR structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def memid(self) -> 'int': - """""" - pass + def memid(self) -> int: + ... @property - def scodeArray(self) -> 'Tuple[Any, ...]': - """""" - pass + def scodeArray(self) -> Tuple[Any, ...]: + ... @property - def args(self) -> 'Tuple[Any, ...]': - """""" - pass + def args(self) -> Tuple[Any, ...]: + ... @property - def funckind(self) -> 'Any': - """""" - pass + def funckind(self) -> Any: + ... @property - def invkind(self) -> 'Any': - """""" - pass + def invkind(self) -> Any: + ... @property - def callconv(self) -> 'Any': - """""" - pass + def callconv(self) -> Any: + ... @property - def cParamsOpt(self) -> 'Any': - """""" - pass + def cParamsOpt(self) -> Any: + ... @property - def oVft(self) -> 'Any': - """""" - pass + def oVft(self) -> Any: + ... @property - def rettype(self) -> 'Any': - """""" - pass + def rettype(self) -> Any: + ... @property - def wFuncFlags(self) -> 'Any': - """""" - pass + def wFuncFlags(self) -> Any: + ... -class IDLDESC(object): +class IDLDESC: """An IDLDESC is respresented as""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class MAPIINIT_0(object): +class MAPIINIT_0: """A MAPIINIT_0 is represented as a tuple of:""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class NT_CONSOLE_PROPS(object): +class NT_CONSOLE_PROPS: """Dictionary containing information for a NT_CONSOLE_PROPS struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def Signature(self) -> 'Any': + def Signature(self) -> Any: """The type of data block, one of shellcon.*_SIG values""" - pass + ... @property - def FillAttribute(self) -> 'Any': + def FillAttribute(self) -> Any: """Character attributes for fill operations""" - pass + ... @property - def PopupFillAttribute(self) -> 'Any': + def PopupFillAttribute(self) -> Any: """Fill attributes for popups""" - pass + ... @property - def ScreenBufferSize(self) -> 'Tuple[Any, Any]': + def ScreenBufferSize(self) -> Tuple[Any, Any]: """Size of console screen buffer, in character cells""" - pass + ... @property - def WindowSize(self) -> 'Tuple[Any, Any]': + def WindowSize(self) -> Tuple[Any, Any]: """Size of console window in character cells""" - pass + ... @property - def WindowOrigin(self) -> 'Tuple[Any, Any]': + def WindowOrigin(self) -> Tuple[Any, Any]: """Window position, in screen coordinates""" - pass + ... @property - def nFont(self) -> 'Any': + def nFont(self) -> Any: """Number of font to be displayed. See win32console::GetNumberOfConsoleFonts""" - pass + ... @property - def InputBufferSize(self) -> 'Any': + def InputBufferSize(self) -> Any: """Size of console's input buffer""" - pass + ... @property - def FontSize(self) -> 'Tuple[Any, Any]': + def FontSize(self) -> Tuple[Any, Any]: """Size of font""" - pass + ... @property - def FontFamily(self) -> 'Any': + def FontFamily(self) -> Any: """Font family""" - pass + ... @property - def FontWeight(self) -> 'Any': + def FontWeight(self) -> Any: """Controls thickness of displayed font""" - pass + ... @property - def FaceName(self) -> 'Any': + def FaceName(self) -> Any: """Name of font face, 31 characters at most""" - pass + ... @property - def CursorSize(self) -> 'Any': + def CursorSize(self) -> Any: """Relative size of cursor, expressed as percent of character size""" - pass + ... @property - def FullScreen(self) -> 'Any': + def FullScreen(self) -> Any: """Causes console to run in full screen mode""" - pass + ... @property - def QuickEdit(self) -> 'Any': - """""" - pass + def QuickEdit(self) -> Any: + ... @property - def InsertMode(self) -> 'Any': - """""" - pass + def InsertMode(self) -> Any: + ... @property - def AutoPosition(self) -> 'Any': + def AutoPosition(self) -> Any: """Lets system determine window placement""" - pass + ... @property - def HistoryBufferSize(self) -> 'Any': + def HistoryBufferSize(self) -> Any: """Size of command line history buffer""" - pass + ... @property - def NumberOfHistoryBuffers(self) -> 'Any': - """""" - pass + def NumberOfHistoryBuffers(self) -> Any: + ... @property - def HistoryNoDup(self) -> 'Any': - """""" - pass + def HistoryNoDup(self) -> Any: + ... @property - def ColorTable(self) -> 'Any': + def ColorTable(self) -> Any: """Tuple of 16 ints containing console's color attributes""" - pass + ... @property - def Size(self) -> 'Any': + def Size(self) -> Any: """Size of structure, ignored on input""" - pass + ... -class NT_FE_CONSOLE_PROPS(object): +class NT_FE_CONSOLE_PROPS: """Dictionary containing information for a NT_FE_CONSOLE_PROPS struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def Signature(self) -> 'Any': + def Signature(self) -> Any: """The type of data block, one of shellcon.*_SIG values""" - pass + ... @property - def CodePage(self) -> 'Any': + def CodePage(self) -> Any: """The codepage to be used for console text""" - pass + ... @property - def Size(self) -> 'Any': + def Size(self) -> Any: """Size of structure, ignored on input""" - pass + ... -class PROPSPEC(object): +class PROPSPEC: """Identifies a property. Can be either an int property id, or a str/unicode property name.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyADSVALUE(object): +class PyADSVALUE: """A tuple:""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyADS_ATTR_INFO(object): +class PyADS_ATTR_INFO: """Represents a ADS_ATTR_INFO structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def AttrName(self) -> 'Any': + def AttrName(self) -> Any: """The name""" - pass + ... @property - def ControlCode(self) -> 'int': - """""" - pass + def ControlCode(self) -> int: + ... @property - def ADsType(self) -> 'int': - """""" - pass + def ADsType(self) -> int: + ... @property - def Values(self) -> 'List[Any]': - """""" - pass + def Values(self) -> List[Any]: + ... -class PyADS_OBJECT_INFO(object): +class PyADS_OBJECT_INFO: """Represents a ADS_OBJECT_INFO structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def RDN(self) -> 'Any': + def RDN(self) -> Any: """The name""" - pass + ... @property - def ObjectDN(self) -> 'Any': - """""" - pass + def ObjectDN(self) -> Any: + ... @property - def ParentDN(self) -> 'Any': - """""" - pass + def ParentDN(self) -> Any: + ... @property - def ClassName(self) -> 'Any': - """""" - pass + def ClassName(self) -> Any: + ... -class PyADS_SEARCHPREF_INFO(object): +class PyADS_SEARCHPREF_INFO: """A tuple of:""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyBIND_OPTS(object): +class PyBIND_OPTS: """Dictionary representation of a BIND_OPTS struct May eventually be extended to include BIND_OPTS2 members""" @@ -10290,347 +9798,332 @@ May eventually be extended to include BIND_OPTS2 members""" raise Exception('This class just for typing, can not be instanced!') @property - def Flags(self) -> 'Any': + def Flags(self) -> Any: """Value from BIND_FLAGS enum: BIND_MAYBOTHERUSER, BIND_JUSTTESTEXISTENCE or 0""" - pass + ... @property - def Mode(self) -> 'Any': + def Mode(self) -> Any: """Combination of storagecon.STGM_* values""" - pass + ... @property - def TickCountDeadline(self) -> 'Any': + def TickCountDeadline(self) -> Any: """Operation timeout in milliseconds""" - pass + ... @property - def cbStruct(self) -> 'Any': + def cbStruct(self) -> Any: """Size of struct, ignored on input""" - pass + ... -class PyCMINVOKECOMMANDINFO(object): +class PyCMINVOKECOMMANDINFO: """A tuple of parameters to be converted to a CMINVOKECOMMANDINFO struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyDSBCAPS(object): +class PyDSBCAPS: """A Python object, representing a DSBCAPS structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def dwFlags(self) -> 'int': + def dwFlags(self) -> int: """Flags that specify buffer-object capabilities.FlagDescriptionDSBCAPS_PRIMARYBUFFERIndicates that the buffer is a primary sound buffer. If this value is not specified, a secondary sound buffer will be created.DSBCAPS_STATICIndicates that the buffer will be used for static sound data. Typically, these buffers are loaded once and played many times. These buffers are candidates for hardware memory.DSBCAPS_LOCHARDWAREThe buffer is in hardware memory and uses hardware mixing.DSBCAPS_LOCSOFTWAREThe buffer is in software memory and uses software mixing.DSBCAPS_CTRL3DThe buffer is either a primary buffer or a secondary buffer that uses 3-D control. To create a primary buffer, the dwFlags member of the DSBUFFERDESC structure should include the DSBCAPS_PRIMARYBUFFER flag.DSBCAPS_CTRLFREQUENCYThe buffer must have frequency control capability.DSBCAPS_CTRLPANThe buffer must have pan control capability.DSBCAPS_CTRLVOLUMEThe buffer must have volume control capability.DSBCAPS_CTRLPOSITIONNOTIFYThe buffer must have control position notify capability.DSBCAPS_STICKYFOCUSChanges the focus behavior of the sound buffer. This flag can be specified in an IDirectSound::CreateSoundBuffer call. With this flag set, an application using DirectSound can continue to play its sticky focus buffers if the user switches to another application not using DirectSound. In this situation, the application's normal buffers are muted, but the sticky focus buffers are still audible. This is useful for nongame applications, such as movie playback (DirectShow™), when the user wants to hear the soundtrack while typing in Microsoft Word or Microsoft® Excel, for example. However, if the user switches to another DirectSound application, all sound buffers, both normal and sticky focus, in the previous application are muted.DSBCAPS_GLOBALFOCUSThe buffer is a global sound buffer. With this flag set, an application using DirectSound can continue to play its buffers if the user switches focus to another application, even if the new application uses DirectSound. The one exception is if you switch focus to a DirectSound application that uses the DSSCL_EXCLUSIVE or DSSCL_WRITEPRIMARY flag for its cooperative level. In this case, the global sounds from other applications will not be audible.DSBCAPS_GETCURRENTPOSITION2Indicates that IDirectSoundBuffer::GetCurrentPosition should use the new behavior of the play cursor. In DirectSound in DirectX 1, the play cursor was significantly ahead of the actual playing sound on emulated sound cards; it was directly behind the write cursor. Now, if the DSBCAPS_GETCURRENTPOSITION2 flag is specified, the application can get a more accurate play position. If this flag is not specified, the old behavior is preserved for compatibility. Note that this flag affects only emulated sound cards; if a DirectSound driver is present, the play cursor is accurate for DirectSound in all versions of DirectX.DSBCAPS_MUTE3DATMAXDISTANCEThe sound is reduced to silence at the maximum distance. The buffer will stop playing when the maximum distance is exceeded, so that processor time is not wasted.""" - pass + ... @property - def nChannels(self) -> 'int': + def nChannels(self) -> int: """Size of the buffer, in bytes.""" - pass + ... @property - def dwUnlockTransferRate(self) -> 'int': + def dwUnlockTransferRate(self) -> int: """Specifies the rate, in kilobytes per second, at which data is transferred to the buffer memory when IDirectSoundBuffer::Unlock is called. High-performance applications can use this value to determine the time required for IDirectSoundBuffer::Unlock to execute. For software buffers located in system memory, the rate will be very high because no processing is required. For hardware buffers, the rate might be slower because the buffer might have to be downloaded to the sound card, which might have a limited transfer rate.""" - pass + ... @property - def nAvgBytesPerSec(self) -> 'int': + def nAvgBytesPerSec(self) -> int: """Specifies whether the returned handle is inherited when a new process is created. If this member is TRUE, the new process inherits the handle. Sentinel""" - pass + ... -class PyDSBUFFERDESC(object): +class PyDSBUFFERDESC: """A Python object, representing a DSBUFFERDESC structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def dwFlags(self) -> 'int': + def dwFlags(self) -> int: """Identifies the capabilities to include when creating a new DirectSoundBuffer object. Specify one or more of the following:FlagDescriptionDSBCAPS_PRIMARYBUFFERIndicates that the buffer is a primary sound buffer. If this value is not specified, a secondary sound buffer will be created.DSBCAPS_STATICIndicates that the buffer will be used for static sound data. Typically, these buffers are loaded once and played many times. These buffers are candidates for hardware memory.DSBCAPS_LOCHARDWAREThe buffer is in hardware memory and uses hardware mixing.DSBCAPS_LOCSOFTWAREThe buffer is in software memory and uses software mixing.DSBCAPS_CTRL3DThe buffer is either a primary buffer or a secondary buffer that uses 3-D control. To create a primary buffer, the dwFlags member of the DSBUFFERDESC structure should include the DSBCAPS_PRIMARYBUFFER flag.DSBCAPS_CTRLFREQUENCYThe buffer must have frequency control capability.DSBCAPS_CTRLPANThe buffer must have pan control capability.DSBCAPS_CTRLVOLUMEThe buffer must have volume control capability.DSBCAPS_CTRLPOSITIONNOTIFYThe buffer must have control position notify capability.DSBCAPS_STICKYFOCUSChanges the focus behavior of the sound buffer. This flag can be specified in an IDirectSound::CreateSoundBuffer call. With this flag set, an application using DirectSound can continue to play its sticky focus buffers if the user switches to another application not using DirectSound. In this situation, the application's normal buffers are muted, but the sticky focus buffers are still audible. This is useful for nongame applications, such as movie playback (DirectShow™), when the user wants to hear the soundtrack while typing in Microsoft Word or Microsoft® Excel, for example. However, if the user switches to another DirectSound application, all sound buffers, both normal and sticky focus, in the previous application are muted.DSBCAPS_GLOBALFOCUSThe buffer is a global sound buffer. With this flag set, an application using DirectSound can continue to play its buffers if the user switches focus to another application, even if the new application uses DirectSound. The one exception is if you switch focus to a DirectSound application that uses the DSSCL_EXCLUSIVE or DSSCL_WRITEPRIMARY flag for its cooperative level. In this case, the global sounds from other applications will not be audible.DSBCAPS_GETCURRENTPOSITION2Indicates that IDirectSoundBuffer::GetCurrentPosition should use the new behavior of the play cursor. In DirectSound in DirectX 1, the play cursor was significantly ahead of the actual playing sound on emulated sound cards; it was directly behind the write cursor. Now, if the DSBCAPS_GETCURRENTPOSITION2 flag is specified, the application can get a more accurate play position. If this flag is not specified, the old behavior is preserved for compatibility. Note that this flag affects only emulated sound cards; if a DirectSound driver is present, the play cursor is accurate for DirectSound in all versions of DirectX.DSBCAPS_MUTE3DATMAXDISTANCEThe sound is reduced to silence at the maximum distance. The buffer will stop playing when the maximum distance is exceeded, so that processor time is not wasted.""" - pass + ... @property - def dwBufferBytes(self) -> 'int': + def dwBufferBytes(self) -> int: """Size of the new buffer, in bytes. This value must be 0 when creating primary buffers. For secondary buffers, the minimum and maximum sizes allowed are specified by DSBSIZE_MIN and DSBSIZE_MAX.""" - pass + ... @property - def lpwfxFormat(self) -> 'Any': + def lpwfxFormat(self) -> Any: """Structure specifying the waveform format for the buffer. This value must be None for primary buffers. The application can use IDirectSoundBuffer::SetFormat to set the format of the primary buffer. Sentinel""" - pass + ... -class PyDSCAPS(object): +class PyDSCAPS: """A Python object, representing a DSCAPS structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def dwFlags(self) -> 'int': + def dwFlags(self) -> int: """Specifies device capabilities. Can be one or more of the following:FlagDescriptionDSCAPS_PRIMARYMONOThe device supports monophonic primary buffers.DSCAPS_PRIMARYSTEREOThe device supports stereo primary buffers.DSCAPS_PRIMARY8BITThe device supports hardware-mixed secondary buffers with 8-bit samples.DSCAPS_PRIMARY16BITThe device supports primary sound buffers with 16-bit samples.DSCAPS_CONTINUOUSRATEThe device supports all sample rates between the dwMinSecondarySampleRate and dwMaxSecondarySampleRate member values. Typically, this means that the actual output rate will be within +/- 10 hertz (Hz) of the requested frequency.DSCAPS_EMULDRIVERThe device does not have a DirectSound driver installed, so it is being emulated through the waveform-audio functions. Performance degradation should be expected.DSCAPS_CERTIFIEDThis driver has been tested and certified by Microsoft.DSCAPS_SECONDARYMONOThe device supports hardware-mixed monophonic secondary buffers.DSCAPS_SECONDARYSTEREOThe device supports hardware-mixed stereo secondary buffers.DSCAPS_SECONDARY8BITThe device supports hardware-mixed secondary buffers with 8-bit samples.DSCAPS_SECONDARY16BITThe device supports hardware-mixed secondary sound buffers with 16-bit samples.""" - pass + ... @property - def dwMinSecondarySampleRate(self) -> 'int': + def dwMinSecondarySampleRate(self) -> int: """Minimum sample rate supported by this device's hardware secondary sound buffers.""" - pass + ... @property - def dwMaxSecondarySampleRate(self) -> 'int': + def dwMaxSecondarySampleRate(self) -> int: """Maximum sample rate supported by this device's hardware secondary sound buffers.""" - pass + ... @property - def dwPrimaryBuffers(self) -> 'int': + def dwPrimaryBuffers(self) -> int: """Number of primary buffers supported. This value will always be 1.""" - pass + ... @property - def dwMaxHwMixingAllBuffers(self) -> 'int': + def dwMaxHwMixingAllBuffers(self) -> int: """Specifies the total number of buffers that can be mixed in hardware. This member can be less than the sum of dwMaxHwMixingStaticBuffers and dwMaxHwMixingStreamingBuffers. Resource tradeoffs frequently occur.""" - pass + ... @property - def dwMaxHwMixingStaticBuffers(self) -> 'int': + def dwMaxHwMixingStaticBuffers(self) -> int: """Specifies the maximum number of static sound buffers.""" - pass + ... @property - def dwMaxHwMixingStreamingBuffers(self) -> 'int': + def dwMaxHwMixingStreamingBuffers(self) -> int: """Specifies the maximum number of streaming sound buffers.""" - pass + ... @property - def dwFreeHwMixingAllBuffers(self) -> 'int': + def dwFreeHwMixingAllBuffers(self) -> int: """Description of the free hardware mixing capabilities of the device. An application can use this value to determine whether hardware resources are available for allocation to a secondary sound buffer. Also, by comparing these values to the members that specify maximum mixing capabilities, the resources that are already allocated can be determined.""" - pass + ... @property - def dwFreeHwMixingStaticBuffers(self) -> 'int': + def dwFreeHwMixingStaticBuffers(self) -> int: """Description of the free hardware mixing capabilities of the device. An application can use this value to determine whether hardware resources are available for allocation to a secondary sound buffer. Also, by comparing these values to the members that specify maximum mixing capabilities, the resources that are already allocated can be determined.""" - pass + ... @property - def dwFreeHwMixingStreamingBuffers(self) -> 'int': + def dwFreeHwMixingStreamingBuffers(self) -> int: """Description of the free hardware mixing capabilities of the device. An application can use this value to determine whether hardware resources are available for allocation to a secondary sound buffer. Also, by comparing these values to the members that specify maximum mixing capabilities, the resources that are already allocated can be determined.""" - pass + ... @property - def dwMaxHw3DAllBuffers(self) -> 'int': + def dwMaxHw3DAllBuffers(self) -> int: """Description of the hardware 3-D positional capabilities of the device.""" - pass + ... @property - def dwMaxHw3DStaticBuffers(self) -> 'int': + def dwMaxHw3DStaticBuffers(self) -> int: """Description of the hardware 3-D positional capabilities of the device.""" - pass + ... @property - def dwMaxHw3DStreamingBuffers(self) -> 'int': + def dwMaxHw3DStreamingBuffers(self) -> int: """Description of the hardware 3-D positional capabilities of the device.""" - pass + ... @property - def dwFreeHw3DAllBuffers(self) -> 'int': + def dwFreeHw3DAllBuffers(self) -> int: """Description of the free, or unallocated, hardware 3-D positional capabilities of the device.""" - pass + ... @property - def dwFreeHw3DStaticBuffers(self) -> 'int': + def dwFreeHw3DStaticBuffers(self) -> int: """Description of the free, or unallocated, hardware 3-D positional capabilities of the device.""" - pass + ... @property - def dwFreeHw3DStreamingBuffers(self) -> 'int': + def dwFreeHw3DStreamingBuffers(self) -> int: """Description of the free, or unallocated, hardware 3-D positional capabilities of the device.""" - pass + ... @property - def dwTotalHwMemBytes(self) -> 'int': + def dwTotalHwMemBytes(self) -> int: """Size, in bytes, of the amount of memory on the sound card that stores static sound buffers.""" - pass + ... @property - def dwFreeHwMemBytes(self) -> 'int': + def dwFreeHwMemBytes(self) -> int: """Size, in bytes, of the free memory on the sound card.""" - pass + ... @property - def dwMaxContigFreeHwMemBytes(self) -> 'int': + def dwMaxContigFreeHwMemBytes(self) -> int: """Size, in bytes, of the largest contiguous block of free memory on the sound card.""" - pass + ... @property - def dwUnlockTransferRateHwBuffers(self) -> 'int': + def dwUnlockTransferRateHwBuffers(self) -> int: """Description of the rate, in kilobytes per second, at which data can be transferred to hardware static sound buffers. This and the number of bytes transferred determines the duration of a call to the IDirectSoundBuffer::Update method.""" - pass + ... @property - def dwPlayCpuOverheadSwBuffers(self) -> 'int': + def dwPlayCpuOverheadSwBuffers(self) -> int: """Description of the processing overhead, as a percentage of the central processing unit, needed to mix software buffers (those located in main system memory). This varies according to the bus type, the processor type, and the clock speed. The unlock transfer rate for software buffers is 0 because the data need not be transferred anywhere. Similarly, the play processing overhead for hardware buffers is 0 because the mixing is done by the sound device.""" - pass + ... -class PyDSCBCAPS(object): +class PyDSCBCAPS: """A Python object, representing a DSCBCAPS structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def dwFlags(self) -> 'int': + def dwFlags(self) -> int: """Specifies device capabilities. Can be 0 or DSCBCAPS_EMULDRIVER (indicates that no DirectSound Device is available and standard wave audio functions are being used).""" - pass + ... @property - def dwBufferBytes(self) -> 'int': + def dwBufferBytes(self) -> int: """The size, in bytes, of the capture buffer.""" - pass + ... -class PyDSCBUFFERDESC(object): +class PyDSCBUFFERDESC: """A Python object, representing a DSCBUFFERDESC structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def dwFlags(self) -> 'int': + def dwFlags(self) -> int: """Identifies the capabilities to include when creating a new DirectSoundBuffer object. Can be zero or the following flag:FlagDescriptionDSCBCAPS_WAVEMAPPEDThe Win32 wave mapper will be used for formats not supported by the device.""" - pass + ... @property - def dwBufferBytes(self) -> 'int': + def dwBufferBytes(self) -> int: """Size of the new buffer, in bytes. This value must be 0 when creating primary buffers. For secondary buffers, the minimum and maximum sizes allowed are specified by DSBSIZE_MIN and DSBSIZE_MAX.""" - pass + ... @property - def lpwfxFormat(self) -> 'Any': + def lpwfxFormat(self) -> Any: """Structure specifying the waveform format for the buffer. This value must be None for primary buffers. The application can use IDirectSoundBuffer::SetFormat to set the format of the primary buffer. Sentinel""" - pass + ... -class PyDSCCAPS(object): +class PyDSCCAPS: """A Python object, representing a DSCCAPS structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def dwFlags(self) -> 'int': + def dwFlags(self) -> int: """Specifies device capabilities. Can be zero or the following flag:FlagDescriptionDSCCAPS_EMULDRIVERIndicates that no DirectSound Device is available and standard wave audio functions are being used.""" - pass + ... @property - def dwFormats(self) -> 'int': + def dwFormats(self) -> int: """Bitset of supported WAVE_FORMAT formats.""" - pass + ... @property - def dwChannels(self) -> 'int': + def dwChannels(self) -> int: """Number of channels supported by the device.""" - pass + ... -class PyDSOP_FILTER_FLAGS(object): - """""" +class PyDSOP_FILTER_FLAGS: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def uplevel(self) -> 'Any': - """""" - pass + def uplevel(self) -> Any: + ... @property - def downlevel(self) -> 'Any': - """""" - pass + def downlevel(self) -> Any: + ... -class PyDSOP_SCOPE_INIT_INFO(object): - """""" +class PyDSOP_SCOPE_INIT_INFO: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def type(self) -> 'Any': - """""" - pass + def type(self) -> Any: + ... @property - def scope(self) -> 'Any': - """""" - pass + def scope(self) -> Any: + ... @property - def hr(self) -> 'Any': - """""" - pass + def hr(self) -> Any: + ... @property - def dcName(self) -> 'str': - """""" - pass + def dcName(self) -> str: + ... @property - def filterFlags(self) -> 'Any': - """""" - pass + def filterFlags(self) -> Any: + ... -class PyDSOP_SCOPE_INIT_INFOs(object): - """""" +class PyDSOP_SCOPE_INIT_INFOs: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyDSOP_UPLEVEL_FILTER_FLAGS(object): - """""" +class PyDSOP_UPLEVEL_FILTER_FLAGS: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def bothModes(self) -> 'Any': - """""" - pass + def bothModes(self) -> Any: + ... @property - def mixedModeOnly(self) -> 'Any': - """""" - pass + def mixedModeOnly(self) -> Any: + ... @property - def nativeModeOnly(self) -> 'Any': - """""" - pass + def nativeModeOnly(self) -> Any: + ... -class PyFORMATETC(object): +class PyFORMATETC: """Tuple representing a FORMATETC struct describing an OLE data format""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyGFileOperationProgressSink(object): - """""" +class PyGFileOperationProgressSink: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def StartOperations(self,) -> 'None': + def StartOperations(self) -> None: """ Called as operation begins, before any modifications are done @@ -10643,9 +10136,9 @@ Returns: None """ - pass + ... - def FinishOperations(self, Result: 'Any') -> 'None': + def FinishOperations(self, Result: Any) -> None: """ Called after all actions have been performed @@ -10658,9 +10151,9 @@ Returns: None """ - pass + ... - def PreRenameItem(self, Flags: 'Any', Item: 'Any', NewName: 'Any') -> 'None': + def PreRenameItem(self, Flags: Any, Item: Any, NewName: Any) -> None: """ Called before each file rename @@ -10675,9 +10168,9 @@ Returns: None """ - pass + ... - def PostRenameItem(self, Flags: 'Any', Item: 'Any', NewName: 'Any', hrRename: 'Any', NewlyCreated: 'Any') -> 'None': + def PostRenameItem(self, Flags: Any, Item: Any, NewName: Any, hrRename: Any, NewlyCreated: Any) -> None: """ Called after each file rename @@ -10694,9 +10187,9 @@ Returns: None """ - pass + ... - def PreMoveItem(self, Flags: 'Any', Item: 'Any', DestinationFolder: 'Any', NewName: 'Any') -> 'None': + def PreMoveItem(self, Flags: Any, Item: Any, DestinationFolder: Any, NewName: Any) -> None: """ Called before each move operation @@ -10712,16 +10205,16 @@ Returns: None """ - pass + ... def PostMoveItem( self, - Flags: 'Any', - Item: 'Any', - DestinationFolder: 'Any', - NewName: 'Any', - hrMove: 'Any', - NewlyCreated: 'Any') -> 'None': + Flags: Any, + Item: Any, + DestinationFolder: Any, + NewName: Any, + hrMove: Any, + NewlyCreated: Any) -> None: """ Called after each move operation @@ -10739,9 +10232,9 @@ Returns: None """ - pass + ... - def PreCopyItem(self, Flags: 'Any', Item: 'Any', DestinationFolder: 'Any', NewName: 'Any') -> 'None': + def PreCopyItem(self, Flags: Any, Item: Any, DestinationFolder: Any, NewName: Any) -> None: """ Called before each copy operation @@ -10757,16 +10250,16 @@ Returns: None """ - pass + ... def PostCopyItem( self, - Flags: 'Any', - Item: 'Any', - DestinationFolder: 'Any', - NewName: 'Any', - hrCopy: 'Any', - NewlyCreated: 'Any') -> 'None': + Flags: Any, + Item: Any, + DestinationFolder: Any, + NewName: Any, + hrCopy: Any, + NewlyCreated: Any) -> None: """ Called after each copy operation @@ -10784,9 +10277,9 @@ Returns: None """ - pass + ... - def PreDeleteItem(self, Flags: 'Any', Item: 'Any') -> 'None': + def PreDeleteItem(self, Flags: Any, Item: Any) -> None: """ Called before each delete operation @@ -10800,9 +10293,9 @@ Returns: None """ - pass + ... - def PostDeleteItem(self, Flags: 'Any', Item: 'Any', hrDelete: 'Any', NewlyCreated: 'Any') -> 'None': + def PostDeleteItem(self, Flags: Any, Item: Any, hrDelete: Any, NewlyCreated: Any) -> None: """ Called after each delete operation @@ -10818,9 +10311,9 @@ Returns: None """ - pass + ... - def PreNewItem(self, Flags: 'Any', DestinationFolder: 'Any', NewName: 'Any') -> 'None': + def PreNewItem(self, Flags: Any, DestinationFolder: Any, NewName: Any) -> None: """ Called before each new file is created @@ -10835,17 +10328,17 @@ Returns: None """ - pass + ... def PostNewItem( self, - Flags: 'Any', - DestinationFolder: 'Any', - NewName: 'Any', - TemplateName: 'Any', - FileAttributes: 'Any', - hrNew: 'Any', - NewItem: 'Any') -> 'None': + Flags: Any, + DestinationFolder: Any, + NewName: Any, + TemplateName: Any, + FileAttributes: Any, + hrNew: Any, + NewItem: Any) -> None: """ Called after each new file is created @@ -10864,9 +10357,9 @@ Returns: None """ - pass + ... - def UpdateProgress(self, WorkTotal: 'Any', WorkSoFar: 'Any') -> 'None': + def UpdateProgress(self, WorkTotal: Any, WorkSoFar: Any) -> None: """ Gives an estimate of total work completed @@ -10880,9 +10373,9 @@ Returns: None """ - pass + ... - def ResetTimer(self,) -> 'None': + def ResetTimer(self) -> None: """ Not implemented, according to MSDN @@ -10895,9 +10388,9 @@ Returns: None """ - pass + ... - def PauseTimer(self,) -> 'None': + def PauseTimer(self) -> None: """ Not implemented, according to MSDN @@ -10910,9 +10403,9 @@ Returns: None """ - pass + ... - def ResumeTimer(self,) -> 'None': + def ResumeTimer(self) -> None: """ Not implemented, according to MSDN @@ -10925,16 +10418,16 @@ Returns: None """ - pass + ... -class PyGSecurityInformation(object): +class PyGSecurityInformation: """Gateway wrapper for the implement-only ISecurityInformation interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetObjectInformation(self,) -> 'Any': + def GetObjectInformation(self) -> Any: """ Returns information identifying the object @@ -10961,9 +10454,9 @@ Return ValueYour implementation of this method should return a SI_OBJECT_INFO tu """ - pass + ... - def GetSecurity(self, RequestedInformation: 'Any', Default: 'Any') -> 'PySECURITY_DESCRIPTOR': + def GetSecurity(self, RequestedInformation: Any, Default: Any) -> PySECURITY_DESCRIPTOR: """ Retrieves the object's current security @@ -10979,9 +10472,9 @@ Returns: PySECURITY_DESCRIPTOR """ - pass + ... - def SetSecurity(self, SecurityInformation: 'Any', SecurityDescriptor: 'PySECURITY_DESCRIPTOR') -> 'None': + def SetSecurity(self, SecurityInformation: Any, SecurityDescriptor: PySECURITY_DESCRIPTOR) -> None: """ Applies the modified security to the object @@ -10996,9 +10489,9 @@ Returns: """ - pass + ... - def GetAccessRights(self, ObjectType: 'PyIID', Flags: 'Any') -> 'Tuple[Any, Any]': + def GetAccessRights(self, ObjectType: PyIID, Flags: Any) -> Tuple[Any, Any]: """ Retrieves permission that can be set @@ -11017,9 +10510,9 @@ and a zero-based index indicating which of them is the default """ - pass + ... - def MapGeneric(self, ObjectType: 'PyIID', AceFlags: 'Any', Mask: 'Any') -> 'Any': + def MapGeneric(self, ObjectType: PyIID, AceFlags: Any, Mask: Any) -> Any: """ Translates generic access rights to specific equivalents @@ -11038,9 +10531,9 @@ Return ValueThis method should return the input bitmask will all generic rights """ - pass + ... - def GetInheritTypes(self,) -> 'Tuple[Any, ...]': + def GetInheritTypes(self) -> Tuple[Any, ...]: """ Requests types of inheritance that your @@ -11061,9 +10554,9 @@ Return ValueReturns a sequence of SI_INHERIT_TYPE tuples """ - pass + ... - def PropertySheetPageCallback(self, hwnd: 'Any', Msg: 'Any', Page: 'Any') -> 'None': + def PropertySheetPageCallback(self, hwnd: Any, Msg: Any, Page: Any) -> None: """ Called by each page as it is created and destroyed @@ -11079,16 +10572,16 @@ Returns: """ - pass + ... -class PyIADesktopP2(object): +class PyIADesktopP2: """An interface to the ActiveDesktop""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def UpdateAllDesktopSubscriptions(self,) -> 'None': + def UpdateAllDesktopSubscriptions(self) -> None: """ Updates webpage subscriptions on the desktop @@ -11101,10 +10594,10 @@ Returns: None """ - pass + ... -class PyIADs(object): +class PyIADs: """An object representing the IADs interface. In most cases you can achieve the same result via IDispatch - however, this @@ -11117,41 +10610,36 @@ overhead.""" raise Exception('This class just for typing, can not be instanced!') @property - def ADsPath(self) -> 'str': - """""" - pass + def ADsPath(self) -> str: + ... @property - def AdsPath(self) -> 'str': + def AdsPath(self) -> str: """Synonym for ADsPath""" - pass + ... @property - def Class(self) -> 'str': - """""" - pass + def Class(self) -> str: + ... @property - def GUID(self) -> 'str': + def GUID(self) -> str: """Like the IADs method, this returns a string rather than a GUID object.""" - pass + ... @property - def Name(self) -> 'str': - """""" - pass + def Name(self) -> str: + ... @property - def Parent(self) -> 'str': - """""" - pass + def Parent(self) -> str: + ... @property - def Schema(self) -> 'str': - """""" - pass + def Schema(self) -> str: + ... - def GetInfo(self,) -> 'None': + def GetInfo(self) -> None: """ Description of GetInfo. @@ -11164,9 +10652,9 @@ Returns: None """ - pass + ... - def SetInfo(self,) -> 'None': + def SetInfo(self) -> None: """ Description of SetInfo. @@ -11179,9 +10667,9 @@ Returns: None """ - pass + ... - def Get(self, prop: 'str') -> 'Any': + def Get(self, prop: str) -> Any: """ Description of Get. @@ -11197,9 +10685,9 @@ may be an array, or any types supported by COM variant. """ - pass + ... - def Put(self, _property: 'str', val: 'Any') -> 'None': + def Put(self, _property: str, val: Any) -> None: """ Description of Put. @@ -11213,9 +10701,9 @@ Returns: None """ - pass + ... - def get(self, prop: 'str') -> 'Any': + def get(self, prop: str) -> Any: """ Description of Get. @@ -11231,9 +10719,9 @@ may be an array, or any types supported by COM variant. """ - pass + ... - def put(self, _property: 'str', val: 'Any') -> 'None': + def put(self, _property: str, val: Any) -> None: """ Description of Put. @@ -11247,16 +10735,15 @@ Returns: None """ - pass + ... -class PyIADsContainer(object): - """""" +class PyIADsContainer: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetObject(self, _class: 'str', relativeName: 'str') -> 'Any': + def GetObject(self, _class: str, relativeName: str) -> Any: """ None @@ -11270,9 +10757,9 @@ Returns: Any """ - pass + ... - def get_Count(self,) -> 'Any': + def get_Count(self) -> Any: """ None @@ -11285,9 +10772,9 @@ Returns: Any """ - pass + ... - def get_Filter(self,) -> 'Any': + def get_Filter(self) -> Any: """ None @@ -11300,9 +10787,9 @@ Returns: Any """ - pass + ... - def put_Filter(self, val: 'Any') -> 'None': + def put_Filter(self, val: Any) -> None: """ None @@ -11315,9 +10802,9 @@ Returns: None """ - pass + ... - def get_Hints(self,) -> 'Any': + def get_Hints(self) -> Any: """ None @@ -11330,9 +10817,9 @@ Returns: Any """ - pass + ... - def put_Hints(self, val: 'Any') -> 'None': + def put_Hints(self, val: Any) -> None: """ None @@ -11345,16 +10832,15 @@ Returns: None """ - pass + ... -class PyIADsUser(object): - """""" +class PyIADsUser: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def get_AccountDisabled(self,) -> 'Any': + def get_AccountDisabled(self) -> Any: """ None @@ -11367,9 +10853,9 @@ Returns: Any """ - pass + ... - def put_AccountDisabled(self, val: 'Any') -> 'None': + def put_AccountDisabled(self, val: Any) -> None: """ None @@ -11382,9 +10868,9 @@ Returns: None """ - pass + ... - def get_AccountExpirationDate(self,) -> 'Any': + def get_AccountExpirationDate(self) -> Any: """ None @@ -11397,9 +10883,9 @@ Returns: Any """ - pass + ... - def put_AccountExpirationDate(self, val: 'PyTime') -> 'None': + def put_AccountExpirationDate(self, val: PyTime) -> None: """ None @@ -11412,9 +10898,9 @@ Returns: None """ - pass + ... - def get_BadLoginAddress(self,) -> 'Any': + def get_BadLoginAddress(self) -> Any: """ None @@ -11427,9 +10913,9 @@ Returns: Any """ - pass + ... - def get_BadLoginCount(self,) -> 'Any': + def get_BadLoginCount(self) -> Any: """ None @@ -11442,9 +10928,9 @@ Returns: Any """ - pass + ... - def get_Department(self,) -> 'Any': + def get_Department(self) -> Any: """ None @@ -11457,9 +10943,9 @@ Returns: Any """ - pass + ... - def put_Department(self, val: 'Any') -> 'None': + def put_Department(self, val: Any) -> None: """ None @@ -11472,9 +10958,9 @@ Returns: None """ - pass + ... - def get_Description(self,) -> 'Any': + def get_Description(self) -> Any: """ None @@ -11487,9 +10973,9 @@ Returns: Any """ - pass + ... - def put_Description(self, val: 'Any') -> 'None': + def put_Description(self, val: Any) -> None: """ None @@ -11502,9 +10988,9 @@ Returns: None """ - pass + ... - def get_Division(self,) -> 'Any': + def get_Division(self) -> Any: """ None @@ -11517,9 +11003,9 @@ Returns: Any """ - pass + ... - def put_Division(self, val: 'Any') -> 'None': + def put_Division(self, val: Any) -> None: """ None @@ -11532,9 +11018,9 @@ Returns: None """ - pass + ... - def get_EmailAddress(self,) -> 'Any': + def get_EmailAddress(self) -> Any: """ None @@ -11547,9 +11033,9 @@ Returns: Any """ - pass + ... - def put_EmailAddress(self, val: 'Any') -> 'None': + def put_EmailAddress(self, val: Any) -> None: """ None @@ -11562,9 +11048,9 @@ Returns: None """ - pass + ... - def get_EmployeeID(self,) -> 'Any': + def get_EmployeeID(self) -> Any: """ None @@ -11577,9 +11063,9 @@ Returns: Any """ - pass + ... - def put_EmployeeID(self, val: 'Any') -> 'None': + def put_EmployeeID(self, val: Any) -> None: """ None @@ -11592,9 +11078,9 @@ Returns: None """ - pass + ... - def get_FirstName(self,) -> 'Any': + def get_FirstName(self) -> Any: """ None @@ -11607,9 +11093,9 @@ Returns: Any """ - pass + ... - def put_FirstName(self, val: 'Any') -> 'None': + def put_FirstName(self, val: Any) -> None: """ None @@ -11622,9 +11108,9 @@ Returns: None """ - pass + ... - def get_FullName(self,) -> 'Any': + def get_FullName(self) -> Any: """ None @@ -11637,9 +11123,9 @@ Returns: Any """ - pass + ... - def put_FullName(self, val: 'Any') -> 'None': + def put_FullName(self, val: Any) -> None: """ None @@ -11652,9 +11138,9 @@ Returns: None """ - pass + ... - def get_HomeDirectory(self,) -> 'Any': + def get_HomeDirectory(self) -> Any: """ None @@ -11667,9 +11153,9 @@ Returns: Any """ - pass + ... - def put_HomeDirectory(self, val: 'Any') -> 'None': + def put_HomeDirectory(self, val: Any) -> None: """ None @@ -11682,9 +11168,9 @@ Returns: None """ - pass + ... - def get_HomePage(self,) -> 'Any': + def get_HomePage(self) -> Any: """ None @@ -11697,9 +11183,9 @@ Returns: Any """ - pass + ... - def put_HomePage(self, val: 'Any') -> 'None': + def put_HomePage(self, val: Any) -> None: """ None @@ -11712,9 +11198,9 @@ Returns: None """ - pass + ... - def get_LoginScript(self,) -> 'Any': + def get_LoginScript(self) -> Any: """ None @@ -11727,9 +11213,9 @@ Returns: Any """ - pass + ... - def put_LoginScript(self, val: 'Any') -> 'None': + def put_LoginScript(self, val: Any) -> None: """ None @@ -11742,9 +11228,9 @@ Returns: None """ - pass + ... - def SetPassword(self, val: 'Any') -> 'None': + def Setpassword(self, val: Any) -> None: """ None @@ -11757,9 +11243,9 @@ Returns: None """ - pass + ... - def ChangePassword(self, oldval: 'Any', newval: 'Any') -> 'None': + def Changepassword(self, oldval: Any, newval: Any) -> None: """ None @@ -11773,16 +11259,16 @@ Returns: None """ - pass + ... -class PyIActiveDesktop(object): +class PyIActiveDesktop: """An interface to the ActiveDesktop""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def ApplyChanges(self, Flags: 'Any') -> 'None': + def ApplyChanges(self, Flags: Any) -> None: """ Applies changes to ActiveDesktop settings and persists them to the registry. @@ -11795,9 +11281,9 @@ Returns: None """ - pass + ... - def GetWallpaper(self, cchWallpaper: 'Any', Reserved: 'Any' = 0) -> 'Any': + def GetWallpaper(self, cchWallpaper: Any, Reserved: Any = 0) -> Any: """ Returns the current wallpaper @@ -11811,9 +11297,9 @@ Returns: Any """ - pass + ... - def SetWallpaper(self, Wallpaper: 'Any', Reserved: 'Any' = 0) -> 'None': + def SetWallpaper(self, Wallpaper: Any, Reserved: Any = 0) -> None: """ Sets the desktop wallpaper @@ -11827,9 +11313,9 @@ Returns: None """ - pass + ... - def GetWallpaperOptions(self, Reserved: 'Any' = 0) -> 'Any': + def GetWallpaperOptions(self, Reserved: Any = 0) -> Any: """ Returns wallpaper style @@ -11844,9 +11330,9 @@ Return ValueReturns one of the WPSTYLE_* values """ - pass + ... - def SetWallpaperOptions(self, Style: 'Any', Reserved: 'Any' = 0) -> 'None': + def SetWallpaperOptions(self, Style: Any, Reserved: Any = 0) -> None: """ Sets wallpaper style @@ -11860,9 +11346,9 @@ Returns: None """ - pass + ... - def GetPattern(self, cchPattern: 'Any' = 1024, Reserved: 'Any' = 0) -> 'None': + def GetPattern(self, cchPattern: Any = 1024, Reserved: Any = 0) -> None: """ Returns the wallpaper pattern @@ -11878,9 +11364,9 @@ Return ValueReturns a unicode string containing decimal values representing the """ - pass + ... - def SetPattern(self, Pattern: 'Any', Reserved: 'Any' = 0) -> 'None': + def SetPattern(self, Pattern: Any, Reserved: Any = 0) -> None: """ Sets the wallpaper pattern @@ -11894,9 +11380,9 @@ Returns: None """ - pass + ... - def GetDesktopItemOptions(self,) -> 'Any': + def GetDesktopItemOptions(self) -> Any: """ Returns options for Active Desktop. @@ -11913,9 +11399,9 @@ Return ValueReturns a COMPONENTSOPT dictionary """ - pass + ... - def SetDesktopItemOptions(self, comp: 'Any', Reserved: 'Any' = 0) -> 'None': + def SetDesktopItemOptions(self, comp: Any, Reserved: Any = 0) -> None: """ Sets Active Desktop options @@ -11929,9 +11415,9 @@ Returns: None """ - pass + ... - def AddDesktopItem(self, comp: 'Any', Reserved: 'Any' = 0) -> 'None': + def AddDesktopItem(self, comp: Any, Reserved: Any = 0) -> None: """ Creates a new item to display on the desktop @@ -11945,9 +11431,9 @@ Returns: None """ - pass + ... - def AddDesktopItemWithUI(self, hwnd: 'int', comp: 'Any', Flags: 'Any') -> 'None': + def AddDesktopItemWithUI(self, hwnd: int, comp: Any, Flags: Any) -> None: """ Adds a desktop item, allowing user interaction @@ -11962,9 +11448,9 @@ Returns: None """ - pass + ... - def ModifyDesktopItem(self, comp: 'Any', Flags: 'Any') -> 'None': + def ModifyDesktopItem(self, comp: Any, Flags: Any) -> None: """ Changes parameters for a desktop item @@ -11978,9 +11464,9 @@ Returns: None """ - pass + ... - def RemoveDesktopItem(self, comp: 'Any', Reserved: 'Any' = 0) -> 'None': + def RemoveDesktopItem(self, comp: Any, Reserved: Any = 0) -> None: """ Removes an item from the Active Desktop @@ -11994,9 +11480,9 @@ Returns: None """ - pass + ... - def GetDesktopItemCount(self,) -> 'None': + def GetDesktopItemCount(self) -> None: """ Returns number of defined desktop items. @@ -12009,9 +11495,9 @@ Returns: None """ - pass + ... - def GetDesktopItem(self, Component: 'Any', Reserved: 'Any' = 0) -> 'Any': + def GetDesktopItem(self, Component: Any, Reserved: Any = 0) -> Any: """ Returns desktop item parameters by index @@ -12027,9 +11513,9 @@ Return ValueReturns a COMPONENT dictionary describing the item """ - pass + ... - def GetDesktopItemByID(self, ID: 'Any', reserved: 'Any' = 0) -> 'Any': + def GetDesktopItemByID(self, ID: Any, reserved: Any = 0) -> Any: """ Returns desktop item parameters by Id @@ -12045,9 +11531,9 @@ Return ValueReturns a COMPONENT dictionary """ - pass + ... - def GenerateDesktopItemHtml(self, FileName: 'Any', comp: 'Any', Reserved: 'Any' = 0) -> 'None': + def GenerateDesktopItemHtml(self, FileName: Any, comp: Any, Reserved: Any = 0) -> None: """ Creates an HTML page for the desktop item @@ -12062,9 +11548,9 @@ Returns: None """ - pass + ... - def AddUrl(self, hwnd: 'int', Source: 'Any', comp: 'Any', Flags: 'Any') -> 'None': + def AddUrl(self, hwnd: int, Source: Any, comp: Any, Flags: Any) -> None: """ Adds a web page to desktop, allowing user interaction @@ -12080,9 +11566,9 @@ Returns: None """ - pass + ... - def GetDesktopItemBySource(self, Source: 'Any', Reserved: 'Any' = 0) -> 'Any': + def GetDesktopItemBySource(self, Source: Any, Reserved: Any = 0) -> Any: """ Returns desktop item parameters by URL @@ -12098,16 +11584,16 @@ Return ValueReturns a COMPONENT dictionary """ - pass + ... -class PyIActiveDesktopP(object): +class PyIActiveDesktopP: """An interface to the ActiveDesktop""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def SetSafeMode(self, Flags: 'Any') -> 'None': + def SetSafeMode(self, Flags: Any) -> None: """ Changes Active Desktop to safe mode @@ -12120,16 +11606,16 @@ Returns: None """ - pass + ... -class PyIActiveScriptDebug(object): +class PyIActiveScriptDebug: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetScriptTextAttributes(self, pstrCode: 'str', pstrDelimiter: 'str', dwFlags: 'Any') -> 'Tuple[Any, ...]': + def GetScriptTextAttributes(self, pstrCode: str, pstrDelimiter: str, dwFlags: Any) -> Tuple[Any, ...]: """ Returns the text attributes for an arbitrary block @@ -12146,9 +11632,9 @@ Returns: Tuple[Any, ...] """ - pass + ... - def GetScriptletTextAttributes(self, pstrCode: 'str', pstrDelimiter: 'str', dwFlags: 'Any') -> 'None': + def GetScriptletTextAttributes(self, pstrCode: str, pstrDelimiter: str, dwFlags: Any) -> None: """ Description of GetScriptletTextAttributes. @@ -12163,9 +11649,9 @@ Returns: None """ - pass + ... - def EnumCodeContextsOfPosition(self, dwSourceContext: 'Any', uCharacterOffset: 'Any', uNumChars: 'Any') -> 'None': + def EnumCodeContextsOfPosition(self, dwSourceContext: Any, uCharacterOffset: Any, uNumChars: Any) -> None: """ Description of EnumCodeContextsOfPosition. @@ -12180,16 +11666,16 @@ Returns: None """ - pass + ... -class PyIActiveScriptError(object): +class PyIActiveScriptError: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetExceptionInfo(self,) -> 'None': + def GetExceptionInfo(self) -> None: """ Description of GetExceptionInfo. @@ -12202,9 +11688,9 @@ Returns: None """ - pass + ... - def GetSourcePosition(self,) -> 'None': + def GetSourcePosition(self) -> None: """ Description of GetSourcePosition. @@ -12217,9 +11703,9 @@ Returns: None """ - pass + ... - def GetSourceLineText(self,) -> 'None': + def GetSourceLineText(self) -> None: """ Description of GetSourceLineText. @@ -12232,16 +11718,16 @@ Returns: None """ - pass + ... -class PyIActiveScriptErrorDebug(object): +class PyIActiveScriptErrorDebug: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetDocumentContext(self,) -> 'None': + def GetDocumentContext(self) -> None: """ Description of GetDocumentContext. @@ -12254,9 +11740,9 @@ Returns: None """ - pass + ... - def GetStackFrame(self,) -> 'None': + def GetStackFrame(self) -> None: """ Description of GetStackFrame. @@ -12269,10 +11755,10 @@ Returns: None """ - pass + ... -class PyIActiveScriptParseProcedure(object): +class PyIActiveScriptParseProcedure: """Description of the interface""" def __new__(cls): @@ -12280,15 +11766,15 @@ class PyIActiveScriptParseProcedure(object): def ParseProcedureText( self, - pstrCode: 'Any', - pstrFormalParams: 'Any', - pstrProcedureName: 'Any', - pstrItemName: 'Any', - punkContext: 'Any', - pstrDelimiter: 'Any', - dwSourceContextCookie: 'Any', - ulStartingLineNumber: 'Any', - dwFlags: 'Any') -> 'None': + pstrCode: Any, + pstrFormalParams: Any, + pstrProcedureName: Any, + pstrItemName: Any, + punkContext: Any, + pstrDelimiter: Any, + dwSourceContextCookie: Any, + ulStartingLineNumber: Any, + dwFlags: Any) -> None: """ Description of ParseProcedureText. @@ -12309,16 +11795,16 @@ Returns: None """ - pass + ... -class PyIActiveScriptSite(object): +class PyIActiveScriptSite: """An object providing the IActiveScriptSite interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetLCID(self,) -> 'Any': + def GetLCID(self) -> Any: """ None @@ -12331,9 +11817,9 @@ Returns: Any """ - pass + ... - def GetItemInfo(self,) -> 'Any': + def GetItemInfo(self) -> Any: """ None @@ -12346,9 +11832,9 @@ Returns: Any """ - pass + ... - def GetDocVersionString(self,) -> 'Any': + def GetDocVersionString(self) -> Any: """ None @@ -12361,9 +11847,9 @@ Returns: Any """ - pass + ... - def OnStateChange(self,) -> 'Any': + def OnStateChange(self) -> Any: """ None @@ -12376,9 +11862,9 @@ Returns: Any """ - pass + ... - def OnEnterScript(self,) -> 'Any': + def OnEnterScript(self) -> Any: """ None @@ -12391,9 +11877,9 @@ Returns: Any """ - pass + ... - def OnLeaveScript(self,) -> 'Any': + def OnLeaveScript(self) -> Any: """ None @@ -12406,9 +11892,9 @@ Returns: Any """ - pass + ... - def OnScriptError(self,) -> 'Any': + def OnScriptError(self) -> Any: """ None @@ -12421,9 +11907,9 @@ Returns: Any """ - pass + ... - def OnScriptTerminate(self,) -> 'Any': + def OnScriptTerminate(self) -> Any: """ None @@ -12436,10 +11922,10 @@ Returns: Any """ - pass + ... -class PyIActiveScriptSiteDebug(object): +class PyIActiveScriptSiteDebug: """Description of the interface""" def __new__(cls): @@ -12447,9 +11933,9 @@ class PyIActiveScriptSiteDebug(object): def GetDocumentContextFromPosition( self, - dwSourceContext: 'Any', - uCharacterOffset: 'Any', - uNumChars: 'Any') -> 'None': + dwSourceContext: Any, + uCharacterOffset: Any, + uNumChars: Any) -> None: """ Description of GetDocumentContextFromPosition. @@ -12464,9 +11950,9 @@ Returns: None """ - pass + ... - def GetApplication(self,) -> 'None': + def GetApplication(self) -> None: """ Description of GetApplication. @@ -12479,9 +11965,9 @@ Returns: None """ - pass + ... - def GetRootApplicationNode(self,) -> 'None': + def GetRootApplicationNode(self) -> None: """ Description of GetRootApplicationNode. @@ -12494,9 +11980,9 @@ Returns: None """ - pass + ... - def OnScriptErrorDebug(self,) -> 'Tuple[Any, Any]': + def OnScriptErrorDebug(self) -> Tuple[Any, Any]: """ Allows a smart host to control the handling of runtime @@ -12517,16 +12003,15 @@ Return ValueThe result is a tuple of (bCallDebugger, bCallOnScriptErrorWhenConti """ - pass + ... -class PyIAddrBook(object): - """""" +class PyIAddrBook: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def ResolveName(self, uiParm: 'Any', flags: 'Any', entryTitle: 'str', ADRLIST: 'Any') -> 'None': + def ResolveName(self, uiParm: Any, flags: Any, entryTitle: str, ADRLIST: Any) -> None: """ Performs name resolution, assigning entry identifiers to recipients in a recipient list. @@ -12542,9 +12027,9 @@ Returns: None """ - pass + ... - def OpenEntry(self, entryId: 'str', iid: 'PyIID', flags: 'Any') -> 'Any': + def OpenEntry(self, entryId: str, iid: PyIID, flags: Any) -> Any: """ Opens a folder or message and returns an interface object for further access. @@ -12559,9 +12044,9 @@ Returns: Any """ - pass + ... - def CompareEntryIDs(self, entryId: 'str', entryId1: 'str', flags: 'Any' = 0) -> 'Any': + def CompareEntryIDs(self, entryId: str, entryId1: str, flags: Any = 0) -> Any: """ Compares two entry identifiers belonging to a particular address book provider to determine if they refer to the same address book object @@ -12578,16 +12063,16 @@ Return ValueThe result is set to TRUE if the two entry identifiers refer to the """ - pass + ... -class PyIApplicationDebugger(object): +class PyIApplicationDebugger: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def QueryAlive(self,) -> 'None': + def QueryAlive(self) -> None: """ Returns true if alive, else false. @@ -12600,9 +12085,9 @@ Returns: None """ - pass + ... - def CreateInstanceAtDebugger(self, rclsid: 'PyIID', pUnkOuter: 'Any', dwClsContext: 'Any', riid: 'PyIID') -> 'None': + def CreateInstanceAtDebugger(self, rclsid: PyIID, pUnkOuter: Any, dwClsContext: Any, riid: PyIID) -> None: """ Create objects in the application process address space. @@ -12618,9 +12103,9 @@ Returns: None """ - pass + ... - def onDebugOutput(self, pstr: 'Any') -> 'None': + def onDebugOutput(self, pstr: Any) -> None: """ None @@ -12633,9 +12118,9 @@ Returns: None """ - pass + ... - def onHandleBreakPoint(self, prpt: 'Any', br: 'Any', pError: 'Any') -> 'None': + def onHandleBreakPoint(self, prpt: Any, br: Any, pError: Any) -> None: """ Called when a breakpoint is hit. @@ -12650,9 +12135,9 @@ Returns: None """ - pass + ... - def onClose(self,) -> 'None': + def onClose(self) -> None: """ None @@ -12665,9 +12150,9 @@ Returns: None """ - pass + ... - def onDebuggerEvent(self, guid: 'PyIID', uUnknown: 'Any') -> 'None': + def onDebuggerEvent(self, guid: PyIID, uUnknown: Any) -> None: """ Description of onDebuggerEvent. @@ -12681,16 +12166,16 @@ Returns: None """ - pass + ... -class PyIApplicationDestinations(object): +class PyIApplicationDestinations: """Allows an application to removed items from its jump lists""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def SetAppID(self, AppID: 'Any') -> 'None': + def SetAppID(self, AppID: Any) -> None: """ Specifies the application whose jump list is to be accessed @@ -12703,9 +12188,9 @@ Returns: None """ - pass + ... - def RemoveDestination(self, punk: 'Any') -> 'None': + def RemoveDestination(self, punk: Any) -> None: """ Removes a single entry from the jump lists @@ -12718,9 +12203,9 @@ Returns: None """ - pass + ... - def RemoveAllDestinations(self,) -> 'None': + def RemoveAllDestinations(self) -> None: """ Removes all Recent and Frequent jump list entries @@ -12733,16 +12218,16 @@ Returns: None """ - pass + ... -class PyIApplicationDocumentLists(object): +class PyIApplicationDocumentLists: """Interface used to retrieve the jump lists for an application""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def SetAppID(self, AppID: 'Any') -> 'None': + def SetAppID(self, AppID: Any) -> None: """ Specifies the application whose jump list is to be accessed @@ -12755,9 +12240,9 @@ Returns: None """ - pass + ... - def GetList(self, ListType: 'Any', riid: 'PyIID', ItemsDesired: 'Any' = 0) -> 'Any': + def GetList(self, ListType: Any, riid: PyIID, ItemsDesired: Any = 0) -> Any: """ Retrieves a list of items in a jump list @@ -12772,16 +12257,16 @@ Returns: Any """ - pass + ... -class PyIAsyncOperation(object): +class PyIAsyncOperation: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def SetAsyncMode(self, fDoOpAsync: 'Any') -> 'None': + def SetAsyncMode(self, fDoOpAsync: Any) -> None: """ Description of SetAsyncMode. @@ -12794,9 +12279,9 @@ Returns: None """ - pass + ... - def GetAsyncMode(self,) -> 'Any': + def GetAsyncMode(self) -> Any: """ Description of GetAsyncMode. @@ -12809,9 +12294,9 @@ Returns: Any """ - pass + ... - def StartOperation(self, pbcReserved: 'Any') -> 'None': + def StartOperation(self, pbcReserved: Any) -> None: """ Description of StartOperation. @@ -12824,9 +12309,9 @@ Returns: None """ - pass + ... - def InOperation(self,) -> 'None': + def InOperation(self) -> None: """ Description of InOperation. @@ -12839,9 +12324,9 @@ Returns: None """ - pass + ... - def EndOperation(self, hResult: 'Any', pbcReserved: 'Any', dwEffects: 'Any') -> 'None': + def EndOperation(self, hResult: Any, pbcReserved: Any, dwEffects: Any) -> None: """ Description of EndOperation. @@ -12856,16 +12341,15 @@ Returns: None """ - pass + ... -class PyIAttach(object): - """""" +class PyIAttach: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetLastError(self, hr: 'Any', flags: 'Any') -> 'Any': + def GetLastError(self, hr: Any, flags: Any) -> Any: """ Returns the last error code for the object. @@ -12879,16 +12363,15 @@ Returns: Any """ - pass + ... -class PyIBindCtx(object): - """""" +class PyIBindCtx: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetRunningObjectTable(self,) -> 'Any': + def GetRunningObjectTable(self) -> Any: """ Retrieves an object interfacing to the Running @@ -12903,9 +12386,9 @@ Returns: Any """ - pass + ... - def GetBindOptions(self,) -> 'Any': + def GetBindOptions(self) -> Any: """ Retrieves the bind options for the bind context @@ -12918,9 +12401,9 @@ Returns: Any """ - pass + ... - def SetBindOptions(self, bindopts: 'Any') -> 'None': + def SetBindOptions(self, bindopts: Any) -> None: """ Sets the bind options for the context @@ -12933,9 +12416,9 @@ Returns: None """ - pass + ... - def RegisterObjectParam(self, Key: 'str', punk: 'Any') -> 'None': + def RegisterObjectParam(self, Key: str, punk: Any) -> None: """ Adds an object to the context's keyed table of associated objects @@ -12949,9 +12432,9 @@ Returns: None """ - pass + ... - def RevokeObjectParam(self, Key: 'str') -> 'None': + def RevokeObjectParam(self, Key: str) -> None: """ Removes one of the bind context's registered objects @@ -12964,9 +12447,9 @@ Returns: None """ - pass + ... - def GetObjectParam(self, Key: 'str') -> 'Any': + def GetObjectParam(self, Key: str) -> Any: """ Returns one of the bind context's associated objects @@ -12979,9 +12462,9 @@ Returns: Any """ - pass + ... - def EnumObjectParam(self,) -> 'Any': + def EnumObjectParam(self) -> Any: """ Creates an enumerator to list context's string keys @@ -12994,16 +12477,16 @@ Returns: Any """ - pass + ... -class PyIBrowserFrameOptions(object): +class PyIBrowserFrameOptions: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetFrameOptions(self, dwMask: 'Any') -> 'None': + def GetFrameOptions(self, dwMask: Any) -> None: """ Description of GetFrameOptions. @@ -13016,16 +12499,15 @@ Returns: None """ - pass + ... -class PyICancelMethodCalls(object): - """""" +class PyICancelMethodCalls: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Cancel(self, Seconds: 'Any') -> 'None': + def Cancel(self, Seconds: Any) -> None: """ Cancels a pending call @@ -13038,9 +12520,9 @@ Returns: None """ - pass + ... - def TestCancel(self,) -> 'Any': + def TestCancel(self) -> Any: """ Checks if a request has been made to cancel a call @@ -13057,16 +12539,16 @@ Return ValueCan return RPC_S_CALLPENDING or RPC_E_CALL_CANCELED """ - pass + ... -class PyICatInformation(object): +class PyICatInformation: """A Python interface to ICatInformation""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def EnumCategories(self, lcid: 'Any' = 0) -> 'Any': + def EnumCategories(self, lcid: Any = 0) -> Any: """ Returns an enumerator for the component categories @@ -13081,9 +12563,9 @@ Returns: Any """ - pass + ... - def GetCategoryDesc(self, lcid: 'Any' = 0) -> 'str': + def GetCategoryDesc(self, lcid: Any = 0) -> str: """ Retrieves the localized description string for a specific category @@ -13098,9 +12580,9 @@ Returns: str """ - pass + ... - def EnumClassesOfCategories(self, listIIdImplemented: 'List[PyIID]' = None, listIIdRequired: 'Any' = None) -> 'Any': + def EnumClassesOfCategories(self, listIIdImplemented: List[PyIID] = None, listIIdRequired: Any = None) -> Any: """ Returns an enumerator over the classes that @@ -13116,16 +12598,16 @@ Returns: Any """ - pass + ... -class PyICatRegister(object): +class PyICatRegister: """An interface to a COM ICatRegister interface.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def RegisterCategories(self, arg: 'List[Any]') -> 'None': + def RegisterCategories(self, arg: List[Any]) -> None: """ Registers one or more component categories. Each component category @@ -13140,9 +12622,9 @@ Returns: None """ - pass + ... - def UnRegisterCategories(self, arg: 'List[PyIID]') -> 'None': + def UnRegisterCategories(self, arg: List[PyIID]) -> None: """ Unregister one or more previously registered categories. @@ -13155,9 +12637,9 @@ Returns: None """ - pass + ... - def RegisterClassImplCategories(self, clsid: 'PyIID', arg: 'List[PyIID]') -> 'None': + def RegisterClassImplCategories(self, clsid: PyIID, arg: List[PyIID]) -> None: """ Registers the class as implementing one or more component @@ -13173,9 +12655,9 @@ Returns: None """ - pass + ... - def UnRegisterClassImplCategories(self, clsid: 'PyIID', arg: 'List[PyIID]') -> 'None': + def UnRegisterClassImplCategories(self, clsid: PyIID, arg: List[PyIID]) -> None: """ Unregisters the class as implementing one or more component @@ -13191,9 +12673,9 @@ Returns: None """ - pass + ... - def RegisterClassReqCategories(self, clsid: 'PyIID', arg: 'List[PyIID]') -> 'None': + def RegisterClassReqCategories(self, clsid: PyIID, arg: List[PyIID]) -> None: """ Registers the class as requiring one or more component @@ -13209,9 +12691,9 @@ Returns: None """ - pass + ... - def UnRegisterClassReqCategories(self, clsid: 'PyIID', arg: 'List[PyIID]') -> 'None': + def UnRegisterClassReqCategories(self, clsid: PyIID, arg: List[PyIID]) -> None: """ Unregisters the class as requiring one or more component @@ -13227,16 +12709,16 @@ Returns: None """ - pass + ... -class PyICategoryProvider(object): +class PyICategoryProvider: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CanCategorizeOnSCID(self, pscid: 'Any') -> 'None': + def CanCategorizeOnSCID(self, pscid: Any) -> None: """ Description of CanCategorizeOnSCID. @@ -13249,9 +12731,9 @@ Returns: None """ - pass + ... - def GetDefaultCategory(self,) -> 'None': + def GetDefaultCategory(self) -> None: """ Description of GetDefaultCategory. @@ -13264,9 +12746,9 @@ Returns: None """ - pass + ... - def GetCategoryForSCID(self, pscid: 'Any') -> 'None': + def GetCategoryForSCID(self, pscid: Any) -> None: """ Description of GetCategoryForSCID. @@ -13279,9 +12761,9 @@ Returns: None """ - pass + ... - def EnumCategories(self,) -> 'None': + def EnumCategories(self) -> None: """ Description of EnumCategories. @@ -13294,9 +12776,9 @@ Returns: None """ - pass + ... - def GetCategoryName(self, guid: 'PyIID') -> 'None': + def GetCategoryName(self, guid: PyIID) -> None: """ Description of GetCategoryName. @@ -13309,9 +12791,9 @@ Returns: None """ - pass + ... - def CreateCategory(self, guid: 'PyIID', riid: 'PyIID') -> 'None': + def CreateCategory(self, guid: PyIID, riid: PyIID) -> None: """ Description of CreateCategory. @@ -13325,16 +12807,15 @@ Returns: None """ - pass + ... -class PyIClassFactory(object): - """""" +class PyIClassFactory: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CreateInstance(self, outerUnknown: 'Any', iid: 'PyIID') -> 'Any': + def CreateInstance(self, outerUnknown: Any, iid: PyIID) -> Any: """ Creates an uninitialized object. @@ -13351,9 +12832,9 @@ type specified by iid. """ - pass + ... - def LockServer(self, bInc: 'Any') -> 'None': + def LockServer(self, bInc: Any) -> None: """ Called by the client of a class object to keep a server open in memory, @@ -13368,16 +12849,16 @@ Returns: None """ - pass + ... -class PyIClientSecurity(object): +class PyIClientSecurity: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def QueryBlanket(self, Proxy: 'Any') -> 'Any': + def QueryBlanket(self, Proxy: Any) -> Any: """ Retrieves the authentication settings for an interface @@ -13390,18 +12871,18 @@ Returns: Any """ - pass + ... def SetBlanket( self, - Proxy: 'Any', - AuthnSvc: 'Any', - AuthzSvc: 'Any', - ServerPrincipalName: 'str', - AuthnLevel: 'Any', - ImpLevel: 'Any', - AuthInfo: 'Any', - Capabilities: 'Any') -> 'None': + Proxy: Any, + AuthnSvc: Any, + AuthzSvc: Any, + ServerPrincipalName: str, + AuthnLevel: Any, + ImpLevel: Any, + AuthInfo: Any, + Capabilities: Any) -> None: """ Changes the authentication options used with an interface @@ -13421,9 +12902,9 @@ Returns: None """ - pass + ... - def CopyProxy(self, Proxy: 'Any') -> 'Any': + def CopyProxy(self, Proxy: Any) -> Any: """ Makes a private copy of a proxy interface @@ -13436,16 +12917,16 @@ Returns: Any """ - pass + ... -class PyIColumnProvider(object): +class PyIColumnProvider: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Initialize(self, psci: 'Any') -> 'None': + def Initialize(self, psci: Any) -> None: """ Description of Initialize. @@ -13458,9 +12939,9 @@ Returns: None """ - pass + ... - def GetColumnInfo(self, dwIndex: 'Any') -> 'None': + def GetColumnInfo(self, dwIndex: Any) -> None: """ Description of GetColumnInfo. @@ -13473,9 +12954,9 @@ Returns: None """ - pass + ... - def GetItemData(self, pscid: 'Any', pscd: 'Any') -> 'None': + def GetItemData(self, pscid: Any, pscd: Any) -> None: """ Description of GetItemData. @@ -13489,16 +12970,16 @@ Returns: None """ - pass + ... -class PyIConnectionPoint(object): +class PyIConnectionPoint: """A Python wrapper of a COM IConnectionPoint interface.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetConnectionInterface(self,) -> 'PyIID': + def GetConnectionInterface(self) -> PyIID: """ Retrieves the IID of the interface represented by the @@ -13513,9 +12994,9 @@ Returns: PyIID """ - pass + ... - def GetConnectionPointContainer(self,) -> 'Any': + def GetConnectionPointContainer(self) -> Any: """ Gets the connection point @@ -13530,9 +13011,9 @@ Returns: Any """ - pass + ... - def Advise(self, unk: 'Any') -> 'Any': + def Advise(self, unk: Any) -> Any: """ Establishes a connection between the connection point object and the client's @@ -13548,9 +13029,9 @@ Returns: """ - pass + ... - def Unadvise(self, cookie: 'Any') -> 'None': + def Unadvise(self, cookie: Any) -> None: """ Terminates an advisory connection previously established through @@ -13565,9 +13046,9 @@ Returns: None """ - pass + ... - def EnumConnections(self,) -> 'Any': + def EnumConnections(self) -> Any: """ Creates an enumerator to iterate through the @@ -13582,16 +13063,16 @@ Returns: Any """ - pass + ... -class PyIConnectionPointContainer(object): +class PyIConnectionPointContainer: """A Python wrapper of a COM IConnectionPointContainer interface.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def EnumConnectionPoints(self,) -> 'Any': + def EnumConnectionPoints(self) -> Any: """ Creates an enumerator object @@ -13608,9 +13089,9 @@ Returns: Any """ - pass + ... - def FindConnectionPoint(self, iid: 'PyIID') -> 'Any': + def FindConnectionPoint(self, iid: PyIID) -> Any: """ Finds a connection point for the @@ -13625,16 +13106,16 @@ Returns: Any """ - pass + ... -class PyIContext(object): +class PyIContext: """Allows access to properties defined for the current context (Requires win2k or later)""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def SetProperty(self, rpolicyId: 'PyIID', flags: 'Any', pUnk: 'Any') -> 'None': + def SetProperty(self, rpolicyId: PyIID, flags: Any, pUnk: Any) -> None: """ Sets a property on the context @@ -13649,9 +13130,9 @@ Returns: None """ - pass + ... - def RemoveProperty(self, rPolicyId: 'PyIID') -> 'None': + def RemoveProperty(self, rPolicyId: PyIID) -> None: """ Removes a property from the context @@ -13664,9 +13145,9 @@ Returns: None """ - pass + ... - def GetProperty(self, rGuid: 'PyIID') -> 'Tuple[Any, Any]': + def GetProperty(self, rGuid: PyIID) -> Tuple[Any, Any]: """ Retrieves a context property @@ -13680,9 +13161,9 @@ Returns: """ - pass + ... - def EnumContextProps(self,) -> 'Any': + def EnumContextProps(self) -> Any: """ Returns an enumerator for the context properties @@ -13695,10 +13176,10 @@ Returns: Any """ - pass + ... -class PyIContextMenu(object): +class PyIContextMenu: """Description of the interface""" def __new__(cls): @@ -13706,11 +13187,11 @@ class PyIContextMenu(object): def QueryContextMenu( self, - hmenu: 'int', - indexMenu: 'Any', - idCmdFirst: 'Any', - idCmdLast: 'Any', - uFlags: 'Any') -> 'Any': + hmenu: int, + indexMenu: Any, + idCmdFirst: Any, + idCmdLast: Any, + uFlags: Any) -> Any: """ Adds options to a context menu @@ -13727,9 +13208,9 @@ Returns: Any """ - pass + ... - def InvokeCommand(self, pici: 'Any') -> 'None': + def InvokeCommand(self, pici: Any) -> None: """ Executes a context menu option @@ -13742,9 +13223,9 @@ Returns: None """ - pass + ... - def GetCommandString(self, idCmd: 'Any', uType: 'Any', cchMax: 'Any' = 2048) -> 'Any': + def GetCommandString(self, idCmd: Any, uType: Any, cchMax: Any = 2048) -> Any: """ Retrieves verb or help text for a context menu option @@ -13759,10 +13240,10 @@ Returns: Any """ - pass + ... -class PyICopyHookA(object): +class PyICopyHookA: """Description of the interface""" def __new__(cls): @@ -13770,13 +13251,13 @@ class PyICopyHookA(object): def CopyCallback( self, - hwnd: 'Any', - wFunc: 'Any', - wFlags: 'Any', - srcFile: 'Union[Any, str]', - srcAttribs: 'Any', - destFile: 'Union[Any, str]', - destAttribs: 'Any') -> 'None': + hwnd: Any, + wFunc: Any, + wFlags: Any, + srcFile: Union[Any, str], + srcAttribs: Any, + destFile: Union[Any, str], + destAttribs: Any) -> None: """ Description of CopyCallback. @@ -13795,10 +13276,10 @@ Returns: None """ - pass + ... -class PyICopyHookW(object): +class PyICopyHookW: """Description of the interface""" def __new__(cls): @@ -13806,13 +13287,13 @@ class PyICopyHookW(object): def CopyCallback( self, - hwnd: 'Any', - wFunc: 'Any', - wFlags: 'Any', - srcFile: 'Union[Any, str]', - srcAttribs: 'Any', - destFile: 'Union[Any, str]', - destAttribs: 'Any') -> 'None': + hwnd: Any, + wFunc: Any, + wFlags: Any, + srcFile: Union[Any, str], + srcAttribs: Any, + destFile: Union[Any, str], + destAttribs: Any) -> None: """ Description of CopyCallback. @@ -13831,16 +13312,16 @@ Returns: None """ - pass + ... -class PyICreateTypeInfo(object): +class PyICreateTypeInfo: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def SetGuid(self, guid: 'PyIID') -> 'None': + def SetGuid(self, guid: PyIID) -> None: """ Description of SetGuid. @@ -13853,9 +13334,9 @@ Returns: None """ - pass + ... - def SetTypeFlags(self, uTypeFlags: 'Any') -> 'None': + def SetTypeFlags(self, uTypeFlags: Any) -> None: """ Description of SetTypeFlags. @@ -13868,9 +13349,9 @@ Returns: None """ - pass + ... - def SetDocString(self, pStrDoc: 'Any') -> 'None': + def SetDocString(self, pStrDoc: Any) -> None: """ Description of SetDocString. @@ -13883,9 +13364,9 @@ Returns: None """ - pass + ... - def SetHelpContext(self, dwHelpContext: 'Any') -> 'None': + def SetHelpContext(self, dwHelpContext: Any) -> None: """ Description of SetHelpContext. @@ -13898,9 +13379,9 @@ Returns: None """ - pass + ... - def SetVersion(self, wMajorVerNum: 'Any', wMinorVerNum: 'Any') -> 'None': + def SetVersion(self, wMajorVerNum: Any, wMinorVerNum: Any) -> None: """ Description of SetVersion. @@ -13914,9 +13395,9 @@ Returns: None """ - pass + ... - def AddRefTypeInfo(self, pTInfo: 'Any') -> 'None': + def AddRefTypeInfo(self, pTInfo: Any) -> None: """ Description of AddRefTypeInfo. @@ -13929,9 +13410,9 @@ Returns: None """ - pass + ... - def AddFuncDesc(self, index: 'Any') -> 'None': + def AddFuncDesc(self, index: Any) -> None: """ Description of AddFuncDesc. @@ -13944,9 +13425,9 @@ Returns: None """ - pass + ... - def AddImplType(self, index: 'Any', hRefType: 'Any') -> 'None': + def AddImplType(self, index: Any, hRefType: Any) -> None: """ Description of AddImplType. @@ -13960,9 +13441,9 @@ Returns: None """ - pass + ... - def SetImplTypeFlags(self, index: 'Any', implTypeFlags: 'Any') -> 'None': + def SetImplTypeFlags(self, index: Any, implTypeFlags: Any) -> None: """ Description of SetImplTypeFlags. @@ -13976,9 +13457,9 @@ Returns: None """ - pass + ... - def SetAlignment(self, cbAlignment: 'Any') -> 'None': + def SetAlignment(self, cbAlignment: Any) -> None: """ Description of SetAlignment. @@ -13991,9 +13472,9 @@ Returns: None """ - pass + ... - def SetSchema(self, pStrSchema: 'Any') -> 'None': + def SetSchema(self, pStrSchema: Any) -> None: """ Description of SetSchema. @@ -14006,9 +13487,9 @@ Returns: None """ - pass + ... - def AddVarDesc(self, index: 'Any') -> 'None': + def AddVarDesc(self, index: Any) -> None: """ Description of AddVarDesc. @@ -14021,9 +13502,9 @@ Returns: None """ - pass + ... - def SetFuncAndParamNames(self, index: 'Any', rgszNames: 'Tuple[Any, ...]') -> 'None': + def SetFuncAndParamNames(self, index: Any, rgszNames: Tuple[Any, ...]) -> None: """ Description of SetFuncAndParamNames. @@ -14037,9 +13518,9 @@ Returns: None """ - pass + ... - def SetVarName(self, index: 'Any', szName: 'Any') -> 'None': + def SetVarName(self, index: Any, szName: Any) -> None: """ Description of SetVarName. @@ -14053,9 +13534,9 @@ Returns: None """ - pass + ... - def SetTypeDescAlias(self,) -> 'None': + def SetTypeDescAlias(self) -> None: """ Description of SetTypeDescAlias. @@ -14068,9 +13549,9 @@ Returns: None """ - pass + ... - def DefineFuncAsDllEntry(self, index: 'Any', szDllName: 'Any', szProcName: 'Any') -> 'None': + def DefineFuncAsDllEntry(self, index: Any, szDllName: Any, szProcName: Any) -> None: """ Description of DefineFuncAsDllEntry. @@ -14085,9 +13566,9 @@ Returns: None """ - pass + ... - def SetFuncDocString(self, index: 'Any', szDocString: 'Any') -> 'None': + def SetFuncDocString(self, index: Any, szDocString: Any) -> None: """ Description of SetFuncDocString. @@ -14101,9 +13582,9 @@ Returns: None """ - pass + ... - def SetVarDocString(self, index: 'Any', szDocString: 'Any') -> 'None': + def SetVarDocString(self, index: Any, szDocString: Any) -> None: """ Description of SetVarDocString. @@ -14117,9 +13598,9 @@ Returns: None """ - pass + ... - def SetFuncHelpContext(self, index: 'Any', dwHelpContext: 'Any') -> 'None': + def SetFuncHelpContext(self, index: Any, dwHelpContext: Any) -> None: """ Description of SetFuncHelpContext. @@ -14133,9 +13614,9 @@ Returns: None """ - pass + ... - def SetVarHelpContext(self, index: 'Any', dwHelpContext: 'Any') -> 'None': + def SetVarHelpContext(self, index: Any, dwHelpContext: Any) -> None: """ Description of SetVarHelpContext. @@ -14149,9 +13630,9 @@ Returns: None """ - pass + ... - def SetMops(self, index: 'Any', bstrMops: 'Any') -> 'None': + def SetMops(self, index: Any, bstrMops: Any) -> None: """ Description of SetMops. @@ -14165,9 +13646,9 @@ Returns: None """ - pass + ... - def LayOut(self,) -> 'None': + def LayOut(self) -> None: """ Description of LayOut. @@ -14180,16 +13661,16 @@ Returns: None """ - pass + ... -class PyICreateTypeLib(object): +class PyICreateTypeLib: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CreateTypeInfo(self, szName: 'Any') -> 'None': + def CreateTypeInfo(self, szName: Any) -> None: """ Description of CreateTypeInfo. @@ -14202,9 +13683,9 @@ Returns: None """ - pass + ... - def SetName(self, szName: 'Any') -> 'None': + def SetName(self, szName: Any) -> None: """ Description of SetName. @@ -14217,9 +13698,9 @@ Returns: None """ - pass + ... - def SetVersion(self, wMajorVerNum: 'Any', wMinorVerNum: 'Any') -> 'None': + def SetVersion(self, wMajorVerNum: Any, wMinorVerNum: Any) -> None: """ Description of SetVersion. @@ -14233,9 +13714,9 @@ Returns: None """ - pass + ... - def SetGuid(self, guid: 'PyIID') -> 'None': + def SetGuid(self, guid: PyIID) -> None: """ Description of SetGuid. @@ -14248,9 +13729,9 @@ Returns: None """ - pass + ... - def SetDocString(self, szDoc: 'Any') -> 'None': + def SetDocString(self, szDoc: Any) -> None: """ Description of SetDocString. @@ -14263,9 +13744,9 @@ Returns: None """ - pass + ... - def SetHelpFileName(self, szHelpFileName: 'Any') -> 'None': + def SetHelpFileName(self, szHelpFileName: Any) -> None: """ Description of SetHelpFileName. @@ -14278,9 +13759,9 @@ Returns: None """ - pass + ... - def SetHelpContext(self, dwHelpContext: 'Any') -> 'None': + def SetHelpContext(self, dwHelpContext: Any) -> None: """ Description of SetHelpContext. @@ -14293,9 +13774,9 @@ Returns: None """ - pass + ... - def SetLcid(self,) -> 'None': + def SetLcid(self) -> None: """ Description of SetLcid. @@ -14308,9 +13789,9 @@ Returns: None """ - pass + ... - def SetLibFlags(self, uLibFlags: 'Any') -> 'None': + def SetLibFlags(self, uLibFlags: Any) -> None: """ Description of SetLibFlags. @@ -14323,9 +13804,9 @@ Returns: None """ - pass + ... - def SaveAllChanges(self,) -> 'None': + def SaveAllChanges(self) -> None: """ Description of SaveAllChanges. @@ -14338,16 +13819,16 @@ Returns: None """ - pass + ... -class PyICreateTypeLib2(object): +class PyICreateTypeLib2: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CreateTypeInfo(self, szName: 'Any') -> 'None': + def CreateTypeInfo(self, szName: Any) -> None: """ Description of CreateTypeInfo. @@ -14360,9 +13841,9 @@ Returns: None """ - pass + ... - def SetName(self, szName: 'Any') -> 'None': + def SetName(self, szName: Any) -> None: """ Description of SetName. @@ -14375,9 +13856,9 @@ Returns: None """ - pass + ... - def SetVersion(self, wMajorVerNum: 'Any', wMinorVerNum: 'Any') -> 'None': + def SetVersion(self, wMajorVerNum: Any, wMinorVerNum: Any) -> None: """ Description of SetVersion. @@ -14391,9 +13872,9 @@ Returns: None """ - pass + ... - def SetGuid(self, guid: 'PyIID') -> 'None': + def SetGuid(self, guid: PyIID) -> None: """ Description of SetGuid. @@ -14406,9 +13887,9 @@ Returns: None """ - pass + ... - def SetDocString(self, szDoc: 'Any') -> 'None': + def SetDocString(self, szDoc: Any) -> None: """ Description of SetDocString. @@ -14421,9 +13902,9 @@ Returns: None """ - pass + ... - def SetHelpFileName(self, szHelpFileName: 'Any') -> 'None': + def SetHelpFileName(self, szHelpFileName: Any) -> None: """ Description of SetHelpFileName. @@ -14436,9 +13917,9 @@ Returns: None """ - pass + ... - def SetHelpContext(self, dwHelpContext: 'Any') -> 'None': + def SetHelpContext(self, dwHelpContext: Any) -> None: """ Description of SetHelpContext. @@ -14451,9 +13932,9 @@ Returns: None """ - pass + ... - def SetLcid(self,) -> 'None': + def SetLcid(self) -> None: """ Description of SetLcid. @@ -14466,9 +13947,9 @@ Returns: None """ - pass + ... - def SetLibFlags(self, uLibFlags: 'Any') -> 'None': + def SetLibFlags(self, uLibFlags: Any) -> None: """ Description of SetLibFlags. @@ -14481,9 +13962,9 @@ Returns: None """ - pass + ... - def SaveAllChanges(self,) -> 'None': + def SaveAllChanges(self) -> None: """ Description of SaveAllChanges. @@ -14496,23 +13977,23 @@ Returns: None """ - pass + ... -class PyICurrentItem(object): +class PyICurrentItem: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyICustomDestinationList(object): +class PyICustomDestinationList: """Interface used to customize an application's jump list""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def SetAppID(self, AppID: 'Any') -> 'None': + def SetAppID(self, AppID: Any) -> None: """ Specifies the taskbar identifier for the jump list @@ -14525,9 +14006,9 @@ Returns: None """ - pass + ... - def BeginList(self, riid: 'PyIID') -> 'Tuple[Any, Any]': + def BeginList(self, riid: PyIID) -> Tuple[Any, Any]: """ Clears the jump list and prepares it to be @@ -14544,9 +14025,9 @@ Return ValueReturns the number of slots and a collection of all destinations rem """ - pass + ... - def AppendCategory(self, Category: 'Any', Items: 'Any') -> 'None': + def AppendCategory(self, Category: Any, Items: Any) -> None: """ Adds a custom category to the jump list @@ -14560,9 +14041,9 @@ Returns: None """ - pass + ... - def AppendKnownCategory(self, Category: 'Any') -> 'None': + def AppendKnownCategory(self, Category: Any) -> None: """ Adds one of the predefined categories to the custom list @@ -14575,9 +14056,9 @@ Returns: None """ - pass + ... - def AddUserTasks(self, Items: 'Any') -> 'None': + def AddUserTasks(self, Items: Any) -> None: """ Sets the entries shown in the Tasks category @@ -14590,9 +14071,9 @@ Returns: None """ - pass + ... - def CommitList(self,) -> 'None': + def CommitList(self) -> None: """ Finalizes changes. @@ -14605,9 +14086,9 @@ Returns: None """ - pass + ... - def GetRemovedDestinations(self, riid: 'PyIID') -> 'Any': + def GetRemovedDestinations(self, riid: PyIID) -> Any: """ Returns all the items removed from the @@ -14622,9 +14103,9 @@ Returns: Any """ - pass + ... - def DeleteList(self, AppID: 'Any' = None) -> 'None': + def DeleteList(self, AppID: Any = None) -> None: """ Removes any customization, leaving only the system-maintained Recent @@ -14639,9 +14120,9 @@ Returns: None """ - pass + ... - def AbortList(self,) -> 'None': + def AbortList(self) -> None: """ Discards all changes @@ -14654,10 +14135,10 @@ Returns: None """ - pass + ... -class PyIDL(object): +class PyIDL: """A Python representation of an IDL. Implemented as a sequence of Python strings. FALSE*/, UINT *pcb /* = NULL */)""" @@ -14666,13 +14147,13 @@ FALSE*/, UINT *pcb /* = NULL */)""" raise Exception('This class just for typing, can not be instanced!') -class PyIDataObject(object): +class PyIDataObject: """Used to transfer data in various formats throughout the shell""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetData(self, pformatetcIn: 'Any') -> 'Any': + def GetData(self, pformatetcIn: Any) -> Any: """ Retrieves data from the object in specified format @@ -14685,9 +14166,9 @@ Returns: Any """ - pass + ... - def GetDataHere(self, pformatetcIn: 'Any') -> 'Any': + def GetDataHere(self, pformatetcIn: Any) -> Any: """ Retunrs a copy of the object's data in specified format @@ -14700,9 +14181,9 @@ Returns: Any """ - pass + ... - def QueryGetData(self, pformatetc: 'Any') -> 'None': + def QueryGetData(self, pformatetc: Any) -> None: """ Checks if the objects supports returning data in a particular format. @@ -14718,9 +14199,9 @@ returnedReturn ValueReturns None if the object supports the specified format, ot """ - pass + ... - def GetCanonicalFormatEtc(self, pformatectIn: 'Any') -> 'Any': + def GetCanonicalFormatEtc(self, pformatectIn: Any) -> Any: """ Transforms a FORMATECT data description into a general @@ -14735,9 +14216,9 @@ Returns: Any """ - pass + ... - def SetData(self, pformatetc: 'Any', pmedium: 'Any', fRelease: 'Any') -> 'None': + def SetData(self, pformatetc: Any, pmedium: Any, fRelease: Any) -> None: """ Sets the data that the object will return. @@ -14752,9 +14233,9 @@ Returns: None """ - pass + ... - def EnumFormatEtc(self, dwDirection: 'Any') -> 'Any': + def EnumFormatEtc(self, dwDirection: Any) -> Any: """ Returns an enumerator to list the data formats that the @@ -14769,9 +14250,9 @@ Returns: Any """ - pass + ... - def DAdvise(self, pformatetc: 'Any', advf: 'Any', pAdvSink: 'Any') -> 'Any': + def DAdvise(self, pformatetc: Any, advf: Any, pAdvSink: Any) -> Any: """ Connects the object to an interface that will receive notifications when its data @@ -14789,9 +14270,9 @@ Returns: """ - pass + ... - def DUnadvise(self, dwConnection: 'Any') -> 'None': + def DUnadvise(self, dwConnection: Any) -> None: """ Disconnects a notification sink. @@ -14804,9 +14285,9 @@ Returns: None """ - pass + ... - def EnumDAdvise(self,) -> 'Any': + def EnumDAdvise(self) -> Any: """ Creates an enumerator to list connected notification sinks. @@ -14819,16 +14300,15 @@ Returns: Any """ - pass + ... -class PyIDebugApplication(object): - """""" +class PyIDebugApplication: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def SetName(self, pstrName: 'Any') -> 'None': + def SetName(self, pstrName: Any) -> None: """ Sets the name of the application. @@ -14841,9 +14321,9 @@ Returns: None """ - pass + ... - def StepOutComplete(self,) -> 'None': + def StepOutComplete(self) -> None: """ Called by language engines, in single step mode, just before they @@ -14858,9 +14338,9 @@ Returns: None """ - pass + ... - def DebugOutput(self, pstr: 'Any') -> 'None': + def DebugOutput(self, pstr: Any) -> None: """ Causes the given string to be displayed by the debugger IDE, normally in @@ -14875,9 +14355,9 @@ Returns: None """ - pass + ... - def StartDebugSession(self,) -> 'None': + def StartDebugSession(self) -> None: """ Causes a default debugger IDE to be started and a debug session to @@ -14892,9 +14372,9 @@ Returns: None """ - pass + ... - def HandleBreakPoint(self, br: 'Any') -> 'Any': + def HandleBreakPoint(self, br: Any) -> Any: """ Called by the language engine in the context of a thread that has @@ -14921,9 +14401,9 @@ Return ValueThe result is the break resume action - one of the BREAKRESUMEACTION """ - pass + ... - def Close(self,) -> 'None': + def Close(self) -> None: """ Causes this application to release all references and enter a zombie state. @@ -14936,9 +14416,9 @@ Returns: None """ - pass + ... - def GetBreakFlags(self,) -> 'Any': + def GetBreakFlags(self) -> Any: """ Returns the current break flags for the application. @@ -14951,9 +14431,9 @@ Returns: Any """ - pass + ... - def GetCurrentThread(self,) -> 'Any': + def GetCurrentThread(self) -> Any: """ Returns the application thread object @@ -14968,9 +14448,9 @@ Returns: Any """ - pass + ... - def CreateAsyncDebugOperation(self, psdo: 'Any') -> 'None': + def CreateAsyncDebugOperation(self, psdo: Any) -> None: """ None @@ -14983,9 +14463,9 @@ Returns: None """ - pass + ... - def AddStackFrameSniffer(self, pdsfs: 'Any') -> 'Any': + def AddStackFrameSniffer(self, pdsfs: Any) -> Any: """ Adds a stack frame sniffer to this application. @@ -15006,9 +14486,9 @@ Return ValueThe result is an integer cookie, to be passed to PyIDebugApplication """ - pass + ... - def RemoveStackFrameSniffer(self, dwCookie: 'Any') -> 'None': + def RemoveStackFrameSniffer(self, dwCookie: Any) -> None: """ Removes a stack frame sniffer from this application. @@ -15021,9 +14501,9 @@ Returns: None """ - pass + ... - def QueryCurrentThreadIsDebuggerThread(self,) -> 'None': + def QueryCurrentThreadIsDebuggerThread(self) -> None: """ Determines if the current running thread is the @@ -15045,9 +14525,9 @@ Otherwise, returns S_FALSE. """ - pass + ... - def SynchronousCallInDebuggerThread(self, pptc: 'Any', dwParam1: 'Any', dwParam2: 'Any', dwParam3: 'Any') -> 'None': + def SynchronousCallInDebuggerThread(self, pptc: Any, dwParam1: Any, dwParam2: Any, dwParam3: Any) -> None: """ Provides a mechanism for the caller to run code in the @@ -15065,9 +14545,9 @@ Returns: None """ - pass + ... - def CreateApplicationNode(self,) -> 'Any': + def CreateApplicationNode(self) -> Any: """ Creates a new application node which @@ -15082,9 +14562,9 @@ Returns: Any """ - pass + ... - def FireDebuggerEvent(self, guid: 'Any', unknown: 'Any') -> 'None': + def FireDebuggerEvent(self, guid: Any, unknown: Any) -> None: """ Fire a generic event to the IApplicationDebugger (if any) @@ -15098,9 +14578,9 @@ Returns: None """ - pass + ... - def HandleRuntimeError(self, pErrorDebug: 'Any', pScriptSite: 'Any') -> 'None': + def HandleRuntimeError(self, pErrorDebug: Any, pScriptSite: Any) -> None: """ Description of HandleRuntimeError. @@ -15114,9 +14594,9 @@ Returns: None """ - pass + ... - def FCanJitDebug(self,) -> 'None': + def FCanJitDebug(self) -> None: """ Description of FCanJitDebug. @@ -15129,9 +14609,9 @@ Returns: None """ - pass + ... - def FIsAutoJitDebugEnabled(self,) -> 'None': + def FIsAutoJitDebugEnabled(self) -> None: """ Description of FIsAutoJitDebugEnabled. @@ -15144,9 +14624,9 @@ Returns: None """ - pass + ... - def AddGlobalExpressionContextProvider(self, pdsfs: 'Any') -> 'None': + def AddGlobalExpressionContextProvider(self, pdsfs: Any) -> None: """ Description of AddGlobalExpressionContextProvider. @@ -15159,9 +14639,9 @@ Returns: None """ - pass + ... - def RemoveGlobalExpressionContextProvider(self, dwCookie: 'Any') -> 'None': + def RemoveGlobalExpressionContextProvider(self, dwCookie: Any) -> None: """ Description of @@ -15176,16 +14656,15 @@ Returns: None """ - pass + ... -class PyIDebugApplicationNode(object): - """""" +class PyIDebugApplicationNode: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def EnumChildren(self,) -> 'None': + def EnumChildren(self) -> None: """ Description of EnumChildren. @@ -15198,9 +14677,9 @@ Returns: None """ - pass + ... - def GetParent(self,) -> 'Any': + def GetParent(self) -> Any: """ Returns the parent node. @@ -15213,9 +14692,9 @@ Returns: Any """ - pass + ... - def SetDocumentProvider(self, pddp: 'Any') -> 'None': + def SetDocumentProvider(self, pddp: Any) -> None: """ Description of SetDocumentProvider. @@ -15228,9 +14707,9 @@ Returns: None """ - pass + ... - def Close(self,) -> 'None': + def Close(self) -> None: """ Description of Close. @@ -15243,9 +14722,9 @@ Returns: None """ - pass + ... - def Attach(self, pdanParent: 'Any') -> 'None': + def Attach(self, pdanParent: Any) -> None: """ Attach a node to its parent. @@ -15258,9 +14737,9 @@ Returns: None """ - pass + ... - def Detach(self,) -> 'None': + def Detach(self) -> None: """ Detach a node from its parent. @@ -15273,16 +14752,16 @@ Returns: None """ - pass + ... -class PyIDebugApplicationNodeEvents(object): +class PyIDebugApplicationNodeEvents: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def onAddChild(self, prddpChild: 'Any') -> 'None': + def onAddChild(self, prddpChild: Any) -> None: """ Description of onAddChild. @@ -15295,9 +14774,9 @@ Returns: None """ - pass + ... - def onRemoveChild(self, prddpChild: 'Any') -> 'None': + def onRemoveChild(self, prddpChild: Any) -> None: """ Description of onRemoveChild. @@ -15310,9 +14789,9 @@ Returns: None """ - pass + ... - def onDetach(self,) -> 'None': + def onDetach(self) -> None: """ Description of onDetach. @@ -15325,9 +14804,9 @@ Returns: None """ - pass + ... - def onAttach(self, prddpParent: 'Any') -> 'None': + def onAttach(self, prddpParent: Any) -> None: """ Description of onAttach. @@ -15340,16 +14819,16 @@ Returns: None """ - pass + ... -class PyIDebugApplicationThread(object): +class PyIDebugApplicationThread: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def SynchronousCallIntoThread(self, pstcb: 'Any', dwParam1: 'Any', dwParam2: 'Any', dwParam3: 'Any') -> 'None': + def SynchronousCallIntoThread(self, pstcb: Any, dwParam1: Any, dwParam2: Any, dwParam3: Any) -> None: """ Description of SynchronousCallIntoThread. @@ -15365,9 +14844,9 @@ Returns: None """ - pass + ... - def QueryIsCurrentThread(self,) -> 'None': + def QueryIsCurrentThread(self) -> None: """ Description of QueryIsCurrentThread. @@ -15380,9 +14859,9 @@ Returns: None """ - pass + ... - def QueryIsDebuggerThread(self,) -> 'None': + def QueryIsDebuggerThread(self) -> None: """ Description of QueryIsDebuggerThread. @@ -15395,16 +14874,16 @@ Returns: None """ - pass + ... -class PyIDebugCodeContext(object): +class PyIDebugCodeContext: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetDocumentContext(self,) -> 'None': + def GetDocumentContext(self) -> None: """ Description of GetDocumentContext. @@ -15417,9 +14896,9 @@ Returns: None """ - pass + ... - def SetBreakPoint(self, bps: 'Any') -> 'None': + def SetBreakPoint(self, bps: Any) -> None: """ Description of SetBreakPoint. @@ -15432,23 +14911,22 @@ Returns: None """ - pass + ... -class PyIDebugDocument(object): - """""" +class PyIDebugDocument: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyIDebugDocumentContext(object): +class PyIDebugDocumentContext: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetDocument(self,) -> 'None': + def GetDocument(self) -> None: """ Description of GetDocument. @@ -15461,9 +14939,9 @@ Returns: None """ - pass + ... - def EnumCodeContexts(self,) -> 'None': + def EnumCodeContexts(self) -> None: """ Description of EnumCodeContexts. @@ -15476,16 +14954,16 @@ Returns: None """ - pass + ... -class PyIDebugDocumentHelper(object): +class PyIDebugDocumentHelper: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Init(self, pda: 'Any', pszShortName: 'Any', pszLongName: 'Any', docAttr: 'Any') -> 'None': + def Init(self, pda: Any, pszShortName: Any, pszLongName: Any, docAttr: Any) -> None: """ Description of Init. @@ -15501,9 +14979,9 @@ Returns: None """ - pass + ... - def Attach(self, pddhParent: 'Any') -> 'None': + def Attach(self, pddhParent: Any) -> None: """ Add the document to the doc tree @@ -15516,9 +14994,9 @@ Returns: None """ - pass + ... - def Detach(self,) -> 'None': + def Detach(self) -> None: """ Description of Detach. @@ -15531,9 +15009,9 @@ Returns: None """ - pass + ... - def AddUnicodeText(self, pszText: 'Any') -> 'None': + def AddUnicodeText(self, pszText: Any) -> None: """ Description of AddUnicodeText. @@ -15546,9 +15024,9 @@ Returns: None """ - pass + ... - def AddDBCSText(self,) -> 'None': + def AddDBCSText(self) -> None: """ Description of AddDBCSText. @@ -15561,9 +15039,9 @@ Returns: None """ - pass + ... - def SetDebugDocumentHost(self, pddh: 'Any') -> 'None': + def SetDebugDocumentHost(self, pddh: Any) -> None: """ Description of SetDebugDocumentHost. @@ -15576,9 +15054,9 @@ Returns: None """ - pass + ... - def AddDeferredText(self, cChars: 'Any', dwTextStartCookie: 'Any') -> 'None': + def AddDeferredText(self, cChars: Any, dwTextStartCookie: Any) -> None: """ Description of AddDeferredText. @@ -15592,9 +15070,9 @@ Returns: None """ - pass + ... - def DefineScriptBlock(self, ulCharOffset: 'Any', cChars: 'Any', pas: 'Any', fScriptlet: 'Any') -> 'None': + def DefineScriptBlock(self, ulCharOffset: Any, cChars: Any, pas: Any, fScriptlet: Any) -> None: """ Description of DefineScriptBlock. @@ -15610,9 +15088,9 @@ Returns: None """ - pass + ... - def SetDefaultTextAttr(self, staTextAttr: 'Any') -> 'None': + def SetDefaultTextAttr(self, staTextAttr: Any) -> None: """ Description of SetDefaultTextAttr. @@ -15625,9 +15103,9 @@ Returns: None """ - pass + ... - def SetTextAttributes(self, ulCharOffset: 'Any', obAttr: 'Any') -> 'None': + def SetTextAttributes(self, ulCharOffset: Any, obAttr: Any) -> None: """ Description of SetTextAttributes. @@ -15641,9 +15119,9 @@ Returns: None """ - pass + ... - def SetLongName(self, pszLongName: 'Any') -> 'None': + def SetLongName(self, pszLongName: Any) -> None: """ Description of SetLongName. @@ -15656,9 +15134,9 @@ Returns: None """ - pass + ... - def SetShortName(self, pszShortName: 'Any') -> 'None': + def SetShortName(self, pszShortName: Any) -> None: """ Description of SetShortName. @@ -15671,9 +15149,9 @@ Returns: None """ - pass + ... - def SetDocumentAttr(self, pszAttributes: 'Any') -> 'None': + def SetDocumentAttr(self, pszAttributes: Any) -> None: """ Description of SetDocumentAttr. @@ -15686,9 +15164,9 @@ Returns: None """ - pass + ... - def GetDebugApplicationNode(self,) -> 'None': + def GetDebugApplicationNode(self) -> None: """ Description of GetDebugApplicationNode. @@ -15701,9 +15179,9 @@ Returns: None """ - pass + ... - def GetScriptBlockInfo(self, dwSourceContext: 'Any') -> 'None': + def GetScriptBlockInfo(self, dwSourceContext: Any) -> None: """ Description of GetScriptBlockInfo. @@ -15716,9 +15194,9 @@ Returns: None """ - pass + ... - def CreateDebugDocumentContext(self, iCharPos: 'Any', cChars: 'Any') -> 'None': + def CreateDebugDocumentContext(self, iCharPos: Any, cChars: Any) -> None: """ Description of CreateDebugDocumentContext. @@ -15732,9 +15210,9 @@ Returns: None """ - pass + ... - def BringDocumentToTop(self,) -> 'None': + def BringDocumentToTop(self) -> None: """ Description of BringDocumentToTop. @@ -15747,9 +15225,9 @@ Returns: None """ - pass + ... - def BringDocumentContextToTop(self, pddc: 'Any') -> 'None': + def BringDocumentContextToTop(self, pddc: Any) -> None: """ Description of BringDocumentContextToTop. @@ -15762,16 +15240,16 @@ Returns: None """ - pass + ... -class PyIDebugDocumentHost(object): +class PyIDebugDocumentHost: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetDeferredText(self, dwTextStartCookie: 'Any', cMaxChars: 'Any') -> 'None': + def GetDeferredText(self, dwTextStartCookie: Any, cMaxChars: Any) -> None: """ Description of GetDeferredText. @@ -15785,9 +15263,9 @@ Returns: None """ - pass + ... - def GetScriptTextAttributes(self, pstrCode: 'Any', pstrDelimiter: 'Any', dwFlags: 'Any') -> 'None': + def GetScriptTextAttributes(self, pstrCode: Any, pstrDelimiter: Any, dwFlags: Any) -> None: """ Description of GetScriptTextAttributes. @@ -15802,9 +15280,9 @@ Returns: None """ - pass + ... - def OnCreateDocumentContext(self,) -> 'None': + def OnCreateDocumentContext(self) -> None: """ Description of OnCreateDocumentContext. @@ -15817,9 +15295,9 @@ Returns: None """ - pass + ... - def GetPathName(self,) -> 'None': + def GetPathName(self) -> None: """ Description of GetPathName. @@ -15832,9 +15310,9 @@ Returns: None """ - pass + ... - def GetFileName(self,) -> 'None': + def GetFileName(self) -> None: """ Description of GetFileName. @@ -15847,9 +15325,9 @@ Returns: None """ - pass + ... - def NotifyChanged(self,) -> 'None': + def NotifyChanged(self) -> None: """ Description of NotifyChanged. @@ -15862,16 +15340,16 @@ Returns: None """ - pass + ... -class PyIDebugDocumentInfo(object): +class PyIDebugDocumentInfo: """Provides information on a document, which may or may not be instantiated.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetName(self,) -> 'None': + def GetName(self) -> None: """ Returns the specified name for the document. @@ -15884,9 +15362,9 @@ Returns: None """ - pass + ... - def GetDocumentClassId(self,) -> 'PyIID': + def GetDocumentClassId(self) -> PyIID: """ Returns a CLSID describing the document type. @@ -15899,16 +15377,15 @@ Returns: PyIID """ - pass + ... -class PyIDebugDocumentProvider(object): - """""" +class PyIDebugDocumentProvider: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetDocument(self,) -> 'Any': + def GetDocument(self) -> Any: """ Causes the document to be instantiated if it does @@ -15923,16 +15400,15 @@ Returns: Any """ - pass + ... -class PyIDebugDocumentText(object): - """""" +class PyIDebugDocumentText: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetDocumentAttributes(self,) -> 'None': + def GetDocumentAttributes(self) -> None: """ Description of GetDocumentAttributes. @@ -15945,9 +15421,9 @@ Returns: None """ - pass + ... - def GetSize(self,) -> 'None': + def GetSize(self) -> None: """ Description of GetSize. @@ -15960,9 +15436,9 @@ Returns: None """ - pass + ... - def GetPositionOfLine(self, cLineNumber: 'Any') -> 'None': + def GetPositionOfLine(self, cLineNumber: Any) -> None: """ Description of GetPositionOfLine. @@ -15975,9 +15451,9 @@ Returns: None """ - pass + ... - def GetLineOfPosition(self, cCharacterPosition: 'Any') -> 'None': + def GetLineOfPosition(self, cCharacterPosition: Any) -> None: """ Description of GetLineOfPosition. @@ -15990,9 +15466,9 @@ Returns: None """ - pass + ... - def GetText(self, cCharacterPosition: 'Any', cMaxChars: 'Any', bWantAttr: 'Any' = 1) -> 'None': + def GetText(self, cCharacterPosition: Any, cMaxChars: Any, bWantAttr: Any = 1) -> None: """ Description of GetText. @@ -16007,9 +15483,9 @@ Returns: None """ - pass + ... - def GetPositionOfContext(self, psc: 'Any') -> 'None': + def GetPositionOfContext(self, psc: Any) -> None: """ Description of GetPositionOfContext. @@ -16022,9 +15498,9 @@ Returns: None """ - pass + ... - def GetContextOfPosition(self, cCharacterPosition: 'Any', cNumChars: 'Any') -> 'None': + def GetContextOfPosition(self, cCharacterPosition: Any, cNumChars: Any) -> None: """ Description of GetContextOfPosition. @@ -16038,16 +15514,15 @@ Returns: None """ - pass + ... -class PyIDebugDocumentTextAuthor(object): - """""" +class PyIDebugDocumentTextAuthor: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def InsertText(self, cCharacterPosition: 'Any', cNumToInsert: 'Any', pcharText: 'Any') -> 'None': + def InsertText(self, cCharacterPosition: Any, cNumToInsert: Any, pcharText: Any) -> None: """ Description of InsertText. @@ -16062,9 +15537,9 @@ Returns: None """ - pass + ... - def RemoveText(self, cCharacterPosition: 'Any', cNumToRemove: 'Any') -> 'None': + def RemoveText(self, cCharacterPosition: Any, cNumToRemove: Any) -> None: """ Description of RemoveText. @@ -16078,9 +15553,9 @@ Returns: None """ - pass + ... - def ReplaceText(self, cCharacterPosition: 'Any', cNumToReplace: 'Any', pcharText: 'Any') -> 'None': + def ReplaceText(self, cCharacterPosition: Any, cNumToReplace: Any, pcharText: Any) -> None: """ Description of ReplaceText. @@ -16095,16 +15570,16 @@ Returns: None """ - pass + ... -class PyIDebugDocumentTextEvents(object): +class PyIDebugDocumentTextEvents: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def onDestroy(self,) -> 'None': + def onDestroy(self) -> None: """ Description of onDestroy. @@ -16117,9 +15592,9 @@ Returns: None """ - pass + ... - def onInsertText(self, cCharacterPosition: 'Any', cNumToInsert: 'Any') -> 'None': + def onInsertText(self, cCharacterPosition: Any, cNumToInsert: Any) -> None: """ Description of onInsertText. @@ -16133,9 +15608,9 @@ Returns: None """ - pass + ... - def onRemoveText(self, cCharacterPosition: 'Any', cNumToRemove: 'Any') -> 'None': + def onRemoveText(self, cCharacterPosition: Any, cNumToRemove: Any) -> None: """ Description of onRemoveText. @@ -16149,9 +15624,9 @@ Returns: None """ - pass + ... - def onReplaceText(self, cCharacterPosition: 'Any', cNumToReplace: 'Any') -> 'None': + def onReplaceText(self, cCharacterPosition: Any, cNumToReplace: Any) -> None: """ Description of onReplaceText. @@ -16165,9 +15640,9 @@ Returns: None """ - pass + ... - def onUpdateTextAttributes(self, cCharacterPosition: 'Any', cNumToUpdate: 'Any') -> 'None': + def onUpdateTextAttributes(self, cCharacterPosition: Any, cNumToUpdate: Any) -> None: """ Description of onUpdateTextAttributes. @@ -16181,9 +15656,9 @@ Returns: None """ - pass + ... - def onUpdateDocumentAttributes(self, textdocattr: 'Any') -> 'None': + def onUpdateDocumentAttributes(self, textdocattr: Any) -> None: """ Description of onUpdateDocumentAttributes. @@ -16196,16 +15671,16 @@ Returns: None """ - pass + ... -class PyIDebugDocumentTextExternalAuthor(object): +class PyIDebugDocumentTextExternalAuthor: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetPathName(self,) -> 'None': + def GetPathName(self) -> None: """ Description of GetPathName. @@ -16218,9 +15693,9 @@ Returns: None """ - pass + ... - def GetFileName(self,) -> 'None': + def GetFileName(self) -> None: """ Description of GetFileName. @@ -16233,9 +15708,9 @@ Returns: None """ - pass + ... - def NotifyChanged(self,) -> 'None': + def NotifyChanged(self) -> None: """ Description of NotifyChanged. @@ -16248,16 +15723,16 @@ Returns: None """ - pass + ... -class PyIDebugExpression(object): +class PyIDebugExpression: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Start(self, pdecb: 'Any') -> 'None': + def Start(self, pdecb: Any) -> None: """ Description of Start. @@ -16270,9 +15745,9 @@ Returns: None """ - pass + ... - def Abort(self,) -> 'None': + def Abort(self) -> None: """ Description of Abort. @@ -16285,9 +15760,9 @@ Returns: None """ - pass + ... - def QueryIsComplete(self,) -> 'None': + def QueryIsComplete(self) -> None: """ Description of QueryIsComplete. @@ -16300,9 +15775,9 @@ Returns: None """ - pass + ... - def GetResultAsString(self,) -> 'None': + def GetResultAsString(self) -> None: """ Description of GetResultAsString. @@ -16315,9 +15790,9 @@ Returns: None """ - pass + ... - def GetResultAsDebugProperties(self,) -> 'None': + def GetResultAsDebugProperties(self) -> None: """ Description of GetResultAsDebugProperty. @@ -16330,16 +15805,16 @@ Returns: None """ - pass + ... -class PyIDebugExpressionCallBack(object): +class PyIDebugExpressionCallBack: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def onComplete(self,) -> 'None': + def onComplete(self) -> None: """ Description of onComplete. @@ -16352,16 +15827,16 @@ Returns: None """ - pass + ... -class PyIDebugExpressionContext(object): +class PyIDebugExpressionContext: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def ParseLanguageText(self, pstrCode: 'Any', nRadix: 'Any', pstrDelimiter: 'Any', dwFlags: 'Any') -> 'None': + def ParseLanguageText(self, pstrCode: Any, nRadix: Any, pstrDelimiter: Any, dwFlags: Any) -> None: """ Description of ParseLanguageText. @@ -16377,9 +15852,9 @@ Returns: None """ - pass + ... - def GetLanguageInfo(self,) -> 'None': + def GetLanguageInfo(self) -> None: """ Description of GetLanguageInfo. @@ -16392,16 +15867,16 @@ Returns: None """ - pass + ... -class PyIDebugProperty(object): +class PyIDebugProperty: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetPropertyInfo(self, dwFieldSpec: 'Any', nRadix: 'Any') -> 'None': + def GetPropertyInfo(self, dwFieldSpec: Any, nRadix: Any) -> None: """ Description of GetPropertyInfo. @@ -16415,9 +15890,9 @@ Returns: None """ - pass + ... - def GetExtendedInfo(self,) -> 'None': + def GetExtendedInfo(self) -> None: """ Description of GetExtendedInfo. @@ -16430,9 +15905,9 @@ Returns: None """ - pass + ... - def SetValueAsString(self, pszValue: 'Any', nRadix: 'Any') -> 'None': + def SetValueAsString(self, pszValue: Any, nRadix: Any) -> None: """ Description of SetValueAsString. @@ -16446,9 +15921,9 @@ Returns: None """ - pass + ... - def EnumMembers(self, dwFieldSpec: 'Any', nRadix: 'Any', refiid: 'PyIID') -> 'None': + def EnumMembers(self, dwFieldSpec: Any, nRadix: Any, refiid: PyIID) -> None: """ Description of EnumMembers. @@ -16463,9 +15938,9 @@ Returns: None """ - pass + ... - def GetParent(self,) -> 'None': + def GetParent(self) -> None: """ Description of GetParent. @@ -16478,16 +15953,16 @@ Returns: None """ - pass + ... -class PyIDebugSessionProvider(object): +class PyIDebugSessionProvider: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def StartDebugSession(self, pda: 'Any') -> 'None': + def StartDebugSession(self, pda: Any) -> None: """ Description of StartDebugSession. @@ -16500,16 +15975,16 @@ Returns: None """ - pass + ... -class PyIDebugStackFrame(object): +class PyIDebugStackFrame: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetCodeContext(self,) -> 'None': + def GetCodeContext(self) -> None: """ Returns the current code context associated with the stack frame. @@ -16522,9 +15997,9 @@ Returns: None """ - pass + ... - def GetDescriptionString(self, fLong: 'Any') -> 'Any': + def GetDescriptionString(self, fLong: Any) -> Any: """ Returns a short or long textual description of the @@ -16539,9 +16014,9 @@ Returns: Any """ - pass + ... - def GetLanguageString(self, fLong: 'Any') -> 'Any': + def GetLanguageString(self, fLong: Any) -> Any: """ Returns a short or long textual description of the @@ -16556,9 +16031,9 @@ Returns: Any """ - pass + ... - def GetThread(self,) -> 'Any': + def GetThread(self) -> Any: """ Returns the thread associated with this stack @@ -16573,16 +16048,16 @@ Returns: Any """ - pass + ... -class PyIDebugStackFrameSniffer(object): +class PyIDebugStackFrameSniffer: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def EnumStackFrames(self,) -> 'None': + def EnumStackFrames(self) -> None: """ Description of EnumStackFrames. @@ -16595,16 +16070,15 @@ Returns: None """ - pass + ... -class PyIDebugStackFrameSnifferEx(object): - """""" +class PyIDebugStackFrameSnifferEx: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def EnumStackFramesEx(self,) -> 'None': + def EnumStackFramesEx(self) -> None: """ Description of EnumStackFrames. @@ -16617,16 +16091,16 @@ Returns: None """ - pass + ... -class PyIDebugSyncOperation(object): +class PyIDebugSyncOperation: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetTargetThread(self,) -> 'None': + def GetTargetThread(self) -> None: """ Description of GetTargetThread. @@ -16639,9 +16113,9 @@ Returns: None """ - pass + ... - def Execute(self,) -> 'None': + def Execute(self) -> None: """ Description of Execute. @@ -16654,9 +16128,9 @@ Returns: None """ - pass + ... - def InProgressAbort(self,) -> 'None': + def InProgressAbort(self) -> None: """ Description of InProgressAbort. @@ -16669,16 +16143,16 @@ Returns: None """ - pass + ... -class PyIDefaultExtractIconInit(object): +class PyIDefaultExtractIconInit: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def SetFlags(self, uFlags: 'Any') -> 'None': + def SetFlags(self, uFlags: Any) -> None: """ Description of SetFlags. @@ -16691,9 +16165,9 @@ Returns: None """ - pass + ... - def SetKey(self, hkey: 'PyHKEY') -> 'None': + def SetKey(self, hkey: PyHKEY) -> None: """ Description of SetKey. @@ -16706,9 +16180,9 @@ Returns: None """ - pass + ... - def SetNormalIcon(self, pszFile: 'Any', iIcon: 'Any') -> 'None': + def SetNormalIcon(self, pszFile: Any, iIcon: Any) -> None: """ Description of SetNormalIcon. @@ -16722,9 +16196,9 @@ Returns: None """ - pass + ... - def SetOpenIcon(self, pszFile: 'Any', iIcon: 'Any') -> 'None': + def SetOpenIcon(self, pszFile: Any, iIcon: Any) -> None: """ Description of SetOpenIcon. @@ -16738,9 +16212,9 @@ Returns: None """ - pass + ... - def SetShortcutIcon(self, pszFile: 'Any', iIcon: 'Any') -> 'None': + def SetShortcutIcon(self, pszFile: Any, iIcon: Any) -> None: """ Description of SetShortcutIcon. @@ -16754,9 +16228,9 @@ Returns: None """ - pass + ... - def SetDefaultIcon(self, pszFile: 'Any', iIcon: 'Any') -> 'None': + def SetDefaultIcon(self, pszFile: Any, iIcon: Any) -> None: """ Description of SetDefaultIcon. @@ -16770,31 +16244,31 @@ Returns: None """ - pass + ... -class PyIDirectSound(object): +class PyIDirectSound: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Initialize(self, guid: 'PyIID') -> 'None': + def Initialize(self, guid: PyIID) -> None: """ Description of Initialize. Args: - guid(PyIID):Globally unique identifier (GUID) specifying the sound driver to which this DirectSound object binds. Pass None to select the primary sound driver. + guid(PyIID):Globally unique identifier (GUID) specifying the sound driver to which this DirectSound object binds. ... None to select the primary sound driver. Returns: None """ - pass + ... - def SetCooperativeLevel(self, hwnd: 'Any', level: 'Any') -> 'None': + def SetCooperativeLevel(self, hwnd: Any, level: Any) -> None: """ The IDirectSound::SetCooperativeLevel method sets the cooperative level @@ -16810,9 +16284,9 @@ Returns: None """ - pass + ... - def CreateSoundBuffer(self, lpDSCBufferDesc: 'Any', unk: 'Any' = None) -> 'None': + def CreateSoundBuffer(self, lpDSCBufferDesc: Any, unk: Any = None) -> None: """ The IDirectSound::CreateSoundBuffer method creates a DirectSoundBuffer @@ -16828,9 +16302,9 @@ Returns: None """ - pass + ... - def GetCaps(self,) -> 'None': + def GetCaps(self) -> None: """ None @@ -16843,9 +16317,9 @@ Returns: None """ - pass + ... - def Compact(self,) -> 'None': + def Compact(self) -> None: """ The Compact method moves the unused portions of on-board sound memory, if any, to a @@ -16860,16 +16334,16 @@ Returns: None """ - pass + ... -class PyIDirectSoundBuffer(object): +class PyIDirectSoundBuffer: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Initialize(self,) -> 'None': + def Initialize(self) -> None: """ Description of Initialize. @@ -16882,9 +16356,9 @@ Returns: None """ - pass + ... - def GetStatus(self,) -> 'None': + def GetStatus(self) -> None: """ Retrieves the current status of the sound buffer. @@ -16897,9 +16371,9 @@ Returns: None """ - pass + ... - def GetCaps(self,) -> 'None': + def GetCaps(self) -> None: """ Retrieves the capabilities of the DirectSoundBuffer object as a DSBCAPS @@ -16914,9 +16388,9 @@ Returns: None """ - pass + ... - def Restore(self,) -> 'None': + def Restore(self) -> None: """ Restores the memory allocation for a lost sound buffer for the specified @@ -16931,9 +16405,9 @@ Returns: None """ - pass + ... - def GetCurrentPosition(self,) -> 'None': + def GetCurrentPosition(self) -> None: """ Description of GetCurrentPosition. @@ -16946,9 +16420,9 @@ Returns: None """ - pass + ... - def Play(self,) -> 'None': + def Play(self) -> None: """ Description of Play. @@ -16961,9 +16435,9 @@ Returns: None """ - pass + ... - def SetCurrentPosition(self,) -> 'None': + def SetCurrentPosition(self) -> None: """ Description of SetCurrentPosition. @@ -16976,9 +16450,9 @@ Returns: None """ - pass + ... - def Stop(self,) -> 'None': + def Stop(self) -> None: """ Description of Stop. @@ -16991,9 +16465,9 @@ Returns: None """ - pass + ... - def GetFrequency(self,) -> 'None': + def GetFrequency(self) -> None: """ Description of GetFrequency. @@ -17006,9 +16480,9 @@ Returns: None """ - pass + ... - def GetPan(self,) -> 'None': + def GetPan(self) -> None: """ Description of GetPan. @@ -17021,9 +16495,9 @@ Returns: None """ - pass + ... - def GetVolume(self,) -> 'None': + def GetVolume(self) -> None: """ Description of GetVolume. @@ -17036,9 +16510,9 @@ Returns: None """ - pass + ... - def SetFrequency(self,) -> 'None': + def SetFrequency(self) -> None: """ Description of SetFrequency. @@ -17051,9 +16525,9 @@ Returns: None """ - pass + ... - def SetPan(self,) -> 'None': + def SetPan(self) -> None: """ Description of SetPan. @@ -17066,9 +16540,9 @@ Returns: None """ - pass + ... - def SetVolume(self,) -> 'None': + def SetVolume(self) -> None: """ Description of SetVolume. @@ -17081,10 +16555,10 @@ Returns: None """ - pass + ... -class PyIDirectSoundCapture(object): +class PyIDirectSoundCapture: """The methods of the IDirectSoundCapture interface are used to create sound capture buffers.""" @@ -17092,7 +16566,7 @@ buffers.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Initialize(self,) -> 'None': + def Initialize(self) -> None: """ Not normally called directly. Use DirectSoundCaptureCreate instead. @@ -17105,9 +16579,9 @@ Returns: None """ - pass + ... - def GetCaps(self,) -> 'None': + def GetCaps(self) -> None: """ None @@ -17120,10 +16594,10 @@ Returns: None """ - pass + ... -class PyIDirectSoundCaptureBuffer(object): +class PyIDirectSoundCaptureBuffer: """The methods of the IDirectSoundCaptureBuffer interface are used to manipulate sound capture buffers.""" @@ -17131,7 +16605,7 @@ sound capture buffers.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Initialize(self,) -> 'None': + def Initialize(self) -> None: """ Not normally used. Used IDirectSoundCapture.CreateCaptureBuffer @@ -17146,9 +16620,9 @@ Returns: None """ - pass + ... - def GetStatus(self,) -> 'None': + def GetStatus(self) -> None: """ Retrieves the current status of the sound capture buffer. @@ -17161,9 +16635,9 @@ Returns: None """ - pass + ... - def GetCurrentPosition(self,) -> 'None': + def GetCurrentPosition(self) -> None: """ Returns a tuple of the current capture and read position in @@ -17182,9 +16656,9 @@ Returns: None """ - pass + ... - def Stop(self,) -> 'None': + def Stop(self) -> None: """ The IDirectSoundCaptureBuffer::Stop method puts the capture buffer into @@ -17201,23 +16675,22 @@ Returns: None """ - pass + ... -class PyIDirectSoundNotify(object): +class PyIDirectSoundNotify: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyIDirectoryObject(object): - """""" +class PyIDirectoryObject: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetObjectInformation(self,) -> 'Any': + def GetObjectInformation(self) -> Any: """ None @@ -17230,9 +16703,9 @@ Returns: Any """ - pass + ... - def GetObjectAttributes(self, names: 'Tuple[str, ...]') -> 'Tuple[Any, ...]': + def GetObjectAttributes(self, names: Tuple[str, ...]) -> Tuple[Any, ...]: """ None @@ -17245,9 +16718,9 @@ Returns: Tuple[Any, ...] """ - pass + ... - def SetObjectAttributes(self, attrs: 'Tuple[Any, ...]') -> 'Any': + def SetObjectAttributes(self, attrs: Tuple[Any, ...]) -> Any: """ None @@ -17260,9 +16733,9 @@ Returns: Any """ - pass + ... - def CreateDSObject(self, rdn: 'str', attrs: 'Tuple[Any, ...]') -> 'Any': + def CreateDSObject(self, rdn: str, attrs: Tuple[Any, ...]) -> Any: """ None @@ -17276,9 +16749,9 @@ Returns: Any """ - pass + ... - def DeleteDSObject(self, rdn: 'str') -> 'None': + def DeleteDSObject(self, rdn: str) -> None: """ Deletes a leaf object in a directory tree @@ -17291,16 +16764,15 @@ Returns: None """ - pass + ... -class PyIDirectorySearch(object): - """""" +class PyIDirectorySearch: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def SetSearchPreference(self, prefs: 'Any') -> 'Tuple[Any, Any, Any]': + def SetSearchPreference(self, prefs: Any) -> Tuple[Any, Any, Any]: """ None @@ -17316,9 +16788,9 @@ codes for each of the preferences set. """ - pass + ... - def ExecuteSearch(self, _filter: 'str', attrNames: 'List[str]') -> 'Any': + def ExecuteSearch(self, _filter: str, attrNames: List[str]) -> Any: """ None @@ -17335,9 +16807,9 @@ should be called to close the handle. """ - pass + ... - def GetNextRow(self, handle: 'Any') -> 'Any': + def GetNextRow(self, handle: Any) -> Any: """ None @@ -17351,9 +16823,9 @@ Returns: """ - pass + ... - def GetFirstRow(self, handle: 'Any') -> 'Any': + def GetFirstRow(self, handle: Any) -> Any: """ None @@ -17367,9 +16839,9 @@ Returns: """ - pass + ... - def GetPreviousRow(self, handle: 'Any') -> 'Any': + def GetPreviousRow(self, handle: Any) -> Any: """ None @@ -17383,9 +16855,9 @@ Returns: """ - pass + ... - def CloseSearchHandle(self, handle: 'Any') -> 'None': + def CloseSearchHandle(self, handle: Any) -> None: """ Closes a previously opened search handle. @@ -17398,9 +16870,9 @@ Returns: None """ - pass + ... - def AdandonSearch(self, handle: 'Any') -> 'None': + def AdandonSearch(self, handle: Any) -> None: """ None @@ -17413,9 +16885,9 @@ Returns: None """ - pass + ... - def GetColumn(self, handle: 'Any', name: 'str') -> 'Tuple[Any, Any, Any]': + def GetColumn(self, handle: Any, name: str) -> Tuple[Any, Any, Any]: """ None @@ -17429,9 +16901,9 @@ Returns: Tuple[Any, Any, Any] """ - pass + ... - def GetNextColumnName(self,) -> 'None': + def GetNextColumnName(self) -> None: """ None @@ -17447,16 +16919,16 @@ Return ValueReturns None when the underlying ADSI function return S_ADS_NOMORE_C """ - pass + ... -class PyIDispatch(object): +class PyIDispatch: """A OLE automation client object.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Invoke(self, dispid: 'Any', lcid: 'Any', flags: 'Any', bResultWanted: 'Any', arg: 'Tuple[Any, ...]') -> 'Any': + def Invoke(self, dispid: Any, lcid: Any, flags: Any, bResultWanted: Any, arg: Tuple[Any, ...]) -> Any: """ Invokes a DISPID, using the passed arguments. @@ -17466,26 +16938,26 @@ Args: lcid(Any):The locale id to use. flags(Any):The flags for the call. The following flags can be used.FlagDescriptionDISPATCH_METHODThe member is invoked as a method. If a property has the same name, both this and the DISPATCH_PROPERTYGET flag may be set.DISPATCH_PROPERTYGETThe member is retrieved as a property or data member.DISPATCH_PROPERTYPUTThe member is changed as a property or data member.DISPATCH_PROPERTYPUTREFThe member is changed by a reference assignment, rather than a value assignment. This flag is valid only when the property accepts a reference to an object. bResultWanted(Any):Indicates if the result of the call should be requested. - arg(Tuple[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) + arg(Tuple[Any, ...]):The parameters to ....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) Returns: - Any:The parameters to pass.Return ValueIf the bResultWanted parameter is False, then the result will be None. + Any:The parameters to ....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 + ... def InvokeTypes( self, - dispid: 'Any', - lcid: 'Any', - wFlags: 'Any', - resultTypeDesc: 'Any', - typeDescs: 'Tuple[Any, ...]', - args: 'Tuple[Any, ...]') -> 'Any': + dispid: Any, + lcid: Any, + wFlags: Any, + resultTypeDesc: Any, + typeDescs: Tuple[Any, ...], + args: Tuple[Any, ...]) -> Any: """ Invokes a DISPID, using the passed arguments and type descriptions. @@ -17503,9 +16975,9 @@ Returns: Any """ - pass + ... - def GetIDsOfNames(self, name: 'str', arg: 'Any') -> 'Tuple[Any, Union[Any]]': + def GetIDsOfNames(self, name: str, arg: Any) -> Tuple[Any, Any]: """ Get the DISPID for the passed names. @@ -17516,7 +16988,7 @@ Args: Returns: - Tuple[Any, Union[Any]]:A sequence of string names to query + Tuple[Any, Any]:A sequence of string names to query Comments Currently the LCID can not be specified, and LOCALE_SYSTEM_DEFAULT is used. @@ -17528,9 +17000,9 @@ is a single integer with the ID of requested item. """ - pass + ... - def GetTypeInfo(self, locale: 'Any', index: 'Any' = 0) -> 'Any': + def GetTypeInfo(self, locale: Any, index: Any = 0) -> Any: """ Get type information for the object. @@ -17544,9 +17016,9 @@ Returns: Any """ - pass + ... - def GetTypeInfoCount(self,) -> 'Any': + def GetTypeInfoCount(self) -> Any: """ None @@ -17559,22 +17031,22 @@ Returns: Any """ - pass + ... -class PyIDispatchEx(object): +class PyIDispatchEx: """A OLE automation client object that uses the IDispatchEx scripting interface..""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetDispID(self, name: 'str', fdex: 'Any') -> 'Any': + def GetDispID(self, name: str, fdex: Any) -> Any: """ Returns the member id for a name Args: - name(str):Passed in name to be mapped + name(str):passed in name to be mapped fdex(Any):Determines the options for obtaining the member identifier. This can be a combination of the fdex* constants: Returns: @@ -17582,17 +17054,17 @@ Returns: Any """ - pass + ... def InvokeEx( self, - dispid: 'Any', - lcid: 'Any', - flags: 'Any', - args: 'List[Any]', - types: 'List[Any]' = None, - returnDesc: 'Any' = 1, - serviceProvider: 'Any' = None) -> 'Any': + dispid: Any, + lcid: Any, + flags: Any, + args: List[Any], + types: List[Any] = None, + returnDesc: Any = 1, + serviceProvider: Any = None) -> Any: """ None @@ -17611,15 +17083,15 @@ Returns: Any """ - pass + ... - def DeleteMemberByName(self, name: 'str', fdex: 'Any') -> 'None': + def DeleteMemberByName(self, name: str, fdex: Any) -> None: """ None Args: - name(str):Passed in name to be mapped + name(str):passed in name to be mapped fdex(Any):Determines the options Returns: @@ -17627,9 +17099,9 @@ Returns: None """ - pass + ... - def DeleteMemberByDispID(self, dispid: 'Any') -> 'None': + def DeleteMemberByDispID(self, dispid: Any) -> None: """ None @@ -17642,9 +17114,9 @@ Returns: None """ - pass + ... - def GetMemberProperties(self, dispid: 'Any', fdex: 'Any') -> 'Any': + def GetMemberProperties(self, dispid: Any, fdex: Any) -> Any: """ Returns mask of fdex* flags describing a member @@ -17658,9 +17130,9 @@ Returns: Any """ - pass + ... - def GetMemberName(self, dispid: 'Any') -> 'Any': + def GetMemberName(self, dispid: Any) -> Any: """ Returns the name associated with a member id @@ -17673,9 +17145,9 @@ Returns: Any """ - pass + ... - def GetNextDispID(self, fdex: 'Any', dispid: 'Any') -> 'Any': + def GetNextDispID(self, fdex: Any, dispid: Any) -> Any: """ Enumerates member ids. @@ -17689,23 +17161,23 @@ Returns: Any """ - pass + ... -class PyIDisplayItem(object): +class PyIDisplayItem: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyIDocHostUIHandler(object): +class PyIDocHostUIHandler: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def ShowContextMenu(self, dwID: 'Any', pt: 'Tuple[Any, Any]', pcmdtReserved: 'Any', pdispReserved: 'Any') -> 'None': + def ShowContextMenu(self, dwID: Any, pt: Tuple[Any, Any], pcmdtReserved: Any, pdispReserved: Any) -> None: """ Description of ShowContextMenu. @@ -17721,9 +17193,9 @@ Returns: None """ - pass + ... - def GetHostInfo(self,) -> 'None': + def GetHostInfo(self) -> None: """ Description of GetHostInfo. @@ -17736,9 +17208,9 @@ Returns: None """ - pass + ... - def ShowUI(self, dwID: 'Any', pActiveObject: 'Any', pCommandTarget: 'Any', pFrame: 'Any', pDoc: 'Any') -> 'None': + def ShowUI(self, dwID: Any, pActiveObject: Any, pCommandTarget: Any, pFrame: Any, pDoc: Any) -> None: """ Description of ShowUI. @@ -17755,9 +17227,9 @@ Returns: None """ - pass + ... - def HideUI(self,) -> 'None': + def HideUI(self) -> None: """ Description of HideUI. @@ -17770,9 +17242,9 @@ Returns: None """ - pass + ... - def UpdateUI(self,) -> 'None': + def UpdateUI(self) -> None: """ Description of UpdateUI. @@ -17785,9 +17257,9 @@ Returns: None """ - pass + ... - def EnableModeless(self, fEnable: 'Any') -> 'None': + def EnableModeless(self, fEnable: Any) -> None: """ Description of EnableModeless. @@ -17800,9 +17272,9 @@ Returns: None """ - pass + ... - def OnDocWindowActivate(self, fActivate: 'Any') -> 'None': + def OnDocWindowActivate(self, fActivate: Any) -> None: """ Description of OnDocWindowActivate. @@ -17815,9 +17287,9 @@ Returns: None """ - pass + ... - def OnFrameWindowActivate(self, fActivate: 'Any') -> 'None': + def OnFrameWindowActivate(self, fActivate: Any) -> None: """ Description of OnFrameWindowActivate. @@ -17830,9 +17302,9 @@ Returns: None """ - pass + ... - def ResizeBorder(self, prcBorder: 'Tuple[Any, Any, Any, Any]', pUIWindow: 'Any', fRameWindow: 'Any') -> 'None': + def ResizeBorder(self, prcBorder: Tuple[Any, Any, Any, Any], pUIWindow: Any, fRameWindow: Any) -> None: """ Description of ResizeBorder. @@ -17847,9 +17319,9 @@ Returns: None """ - pass + ... - def TranslateAccelerator(self, lpMsg: 'Any', pguidCmdGroup: 'PyIID', nCmdID: 'Any') -> 'None': + def TranslateAccelerator(self, lpMsg: Any, pguidCmdGroup: PyIID, nCmdID: Any) -> None: """ Description of TranslateAccelerator. @@ -17864,9 +17336,9 @@ Returns: None """ - pass + ... - def GetOptionKeyPath(self, dw: 'Any') -> 'None': + def GetOptionKeyPath(self, dw: Any) -> None: """ Description of GetOptionKeyPath. @@ -17879,9 +17351,9 @@ Returns: None """ - pass + ... - def GetDropTarget(self, pDropTarget: 'Any') -> 'None': + def GetDropTarget(self, pDropTarget: Any) -> None: """ Description of GetDropTarget. @@ -17894,9 +17366,9 @@ Returns: None """ - pass + ... - def GetExternal(self,) -> 'None': + def GetExternal(self) -> None: """ Description of GetExternal. @@ -17909,9 +17381,9 @@ Returns: None """ - pass + ... - def TranslateUrl(self, dwTranslate: 'Any', pchURLIn: 'Any') -> 'None': + def TranslateUrl(self, dwTranslate: Any, pchURLIn: Any) -> None: """ Description of TranslateUrl. @@ -17925,9 +17397,9 @@ Returns: None """ - pass + ... - def FilterDataObject(self, pDO: 'Any') -> 'None': + def FilterDataObject(self, pDO: Any) -> None: """ Description of FilterDataObject. @@ -17940,16 +17412,16 @@ Returns: None """ - pass + ... -class PyIDropSource(object): +class PyIDropSource: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def QueryContinueDrag(self, fEscapePressed: 'Any', grfKeyState: 'Any') -> 'None': + def QueryContinueDrag(self, fEscapePressed: Any, grfKeyState: Any) -> None: """ Description of QueryContinueDrag. @@ -17963,9 +17435,9 @@ Returns: None """ - pass + ... - def GiveFeedback(self, dwEffect: 'Any') -> 'None': + def GiveFeedback(self, dwEffect: Any) -> None: """ Description of GiveFeedback. @@ -17978,16 +17450,16 @@ Returns: None """ - pass + ... -class PyIDropTarget(object): +class PyIDropTarget: """Interface that acts as a target of OLE drag and drop operations""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def DragEnter(self, pDataObj: 'Any', grfKeyState: 'Any', pt: 'Tuple[Any, Any]', pdwEffect: 'Any') -> 'Any': + def DragEnter(self, pDataObj: Any, grfKeyState: Any, pt: Tuple[Any, Any], pdwEffect: Any) -> Any: """ Called when an object is initially dragged into a window @@ -18006,9 +17478,9 @@ be accepted """ - pass + ... - def DragOver(self, grfKeyState: 'Any', pt: 'Tuple[Any, Any]', pdwEffect: 'Any') -> 'Any': + def DragOver(self, grfKeyState: Any, pt: Tuple[Any, Any], pdwEffect: Any) -> Any: """ Called as the dragged object moves over the window @@ -18026,9 +17498,9 @@ object can be accepted at the current position """ - pass + ... - def DragLeave(self,) -> 'None': + def DragLeave(self) -> None: """ Called as the object is dragged back out of the window @@ -18041,9 +17513,9 @@ Returns: None """ - pass + ... - def Drop(self, pDataObj: 'Any', grfKeyState: 'Any', pt: 'Tuple[Any, Any]', dwEffect: 'Any') -> 'Any': + def Drop(self, pDataObj: Any, grfKeyState: Any, pt: Tuple[Any, Any], dwEffect: Any) -> Any: """ Called when the object is dropped onto the window @@ -18060,16 +17532,16 @@ Returns: """ - pass + ... -class PyIDropTargetHelper(object): +class PyIDropTargetHelper: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def DragEnter(self, hwnd: 'int', pDataObj: 'Any', pt: 'Tuple[Any, Any]', dwEffect: 'Any') -> 'None': + def DragEnter(self, hwnd: int, pDataObj: Any, pt: Tuple[Any, Any], dwEffect: Any) -> None: """ Description of DragEnter. @@ -18085,9 +17557,9 @@ Returns: None """ - pass + ... - def DragOver(self, hwnd: 'Any', pt: 'Tuple[Any, Any]', pdwEffect: 'Any') -> 'None': + def DragOver(self, hwnd: Any, pt: Tuple[Any, Any], pdwEffect: Any) -> None: """ Description of DragOver. @@ -18102,9 +17574,9 @@ Returns: None """ - pass + ... - def DragLeave(self,) -> 'None': + def DragLeave(self) -> None: """ Description of DragLeave. @@ -18117,9 +17589,9 @@ Returns: None """ - pass + ... - def Drop(self, pDataObj: 'Any', pt: 'Tuple[Any, Any]', dwEffect: 'Any') -> 'None': + def Drop(self, pDataObj: Any, pt: Tuple[Any, Any], dwEffect: Any) -> None: """ Description of Drop. @@ -18134,21 +17606,20 @@ Returns: None """ - pass + ... -class PyIDsObjectPicker(object): - """""" +class PyIDsObjectPicker: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') def Initialize( self, - targetComputer: 'str', - scopeInfos: 'Any', - options: 'Any' = 0, - attrNames: 'List[str]' = None) -> 'None': + targetComputer: str, + scopeInfos: Any, + options: Any = 0, + attrNames: List[str] = None) -> None: """ Initializes the IDsObjectPicker interface with information about the scopes, filters, and options used by the object picker dialog box. @@ -18164,9 +17635,9 @@ Returns: None """ - pass + ... - def InvokeDialog(self, hwnd: 'Any') -> 'Any': + def InvokeDialog(self, hwnd: Any) -> Any: """ Displays a modal object picker dialog box and returns the user's selections. @@ -18179,30 +17650,28 @@ Returns: Any """ - pass + ... -class PyIEmptyVolumeCache(object): +class PyIEmptyVolumeCache: """Used for cleaning up temporary file ("disk cleanup")""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyIEmptyVolumeCache2(object): - """""" +class PyIEmptyVolumeCache2: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyIEmptyVolumeCacheCallBack(object): - """""" +class PyIEmptyVolumeCacheCallBack: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def ScanProgress(self, dwlSpaceUsed: 'Any', dwFlags: 'Any', pcwszStatus: 'Any') -> 'None': + def ScanProgress(self, dwlSpaceUsed: Any, dwFlags: Any, pcwszStatus: Any) -> None: """ Description of ScanProgress. @@ -18217,15 +17686,15 @@ Returns: None """ - pass + ... def PurgeProgress( self, - dwlSpaceFreed: 'Any', - spaceFreed: 'Any', - spaceToFree: 'Any', - flags: 'Any', - status: 'Any') -> 'None': + dwlSpaceFreed: Any, + spaceFreed: Any, + spaceToFree: Any, + flags: Any, + status: Any) -> None: """ Description of PurgeProgress. @@ -18242,16 +17711,16 @@ Returns: None """ - pass + ... -class PyIEnumCATEGORYINFO(object): +class PyIEnumCATEGORYINFO: """A Python interface to IEnumCATEGORYINFO""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: 'Any' = 1) -> 'Tuple[Tuple[PyIID, Any, str], ...]': + def Next(self, num: Any = 1) -> Tuple[Tuple[PyIID, Any, str], ...]: """ Retrieves a specified number of items in the @@ -18270,9 +17739,9 @@ one for each element returned. """ - pass + ... - def Skip(self, num: 'Any') -> 'None': + def Skip(self, num: Any) -> None: """ Skips over the next specified elementes. @@ -18285,9 +17754,9 @@ Returns: None """ - pass + ... - def Reset(self,) -> 'None': + def Reset(self) -> None: """ Resets the enumeration sequence to the beginning. @@ -18300,9 +17769,9 @@ Returns: None """ - pass + ... - def Clone(self,) -> 'Any': + def Clone(self) -> Any: """ Creates another enumerator that contains the same @@ -18317,16 +17786,16 @@ Returns: Any """ - pass + ... -class PyIEnumConnectionPoints(object): +class PyIEnumConnectionPoints: """A Python interface to IEnumConnectionPoints""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: 'Any' = 1) -> 'Tuple[Any, ...]': + def Next(self, num: Any = 1) -> Tuple[Any, ...]: """ Retrieves a specified number of items in the @@ -18341,9 +17810,9 @@ Returns: Tuple[Any, ...] """ - pass + ... - def Skip(self,) -> 'None': + def Skip(self) -> None: """ Skips over the next specified elementes. @@ -18356,9 +17825,9 @@ Returns: None """ - pass + ... - def Reset(self,) -> 'None': + def Reset(self) -> None: """ Resets the enumeration sequence to the beginning. @@ -18371,9 +17840,9 @@ Returns: None """ - pass + ... - def Clone(self,) -> 'Any': + def Clone(self) -> Any: """ Creates another enumerator that contains the same @@ -18388,16 +17857,16 @@ Returns: Any """ - pass + ... -class PyIEnumConnections(object): +class PyIEnumConnections: """A Python interface to IEnumConnections""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: 'Any' = 1) -> 'Any': + def Next(self, num: Any = 1) -> Any: """ Retrieves a specified number of items in the enumeration sequence. @@ -18410,9 +17879,9 @@ Returns: Any """ - pass + ... - def Skip(self,) -> 'None': + def Skip(self) -> None: """ Skips over the next specified elementes. @@ -18425,9 +17894,9 @@ Returns: None """ - pass + ... - def Reset(self,) -> 'None': + def Reset(self) -> None: """ Resets the enumeration sequence to the beginning. @@ -18440,9 +17909,9 @@ Returns: None """ - pass + ... - def Clone(self,) -> 'Any': + def Clone(self) -> Any: """ Creates another enumerator that contains the same @@ -18457,16 +17926,16 @@ Returns: Any """ - pass + ... -class PyIEnumContextProps(object): +class PyIEnumContextProps: """A Python interface to IEnumContextProps""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: 'Any' = 1) -> 'Tuple[Tuple[PyIID, Any, Any], ...]': + def Next(self, num: Any = 1) -> Tuple[Tuple[PyIID, Any, Any], ...]: """ Retrieves a specified number of items in @@ -18487,9 +17956,9 @@ property value """ - pass + ... - def Skip(self,) -> 'None': + def Skip(self) -> None: """ Skips over the next specified elementes. @@ -18502,9 +17971,9 @@ Returns: None """ - pass + ... - def Reset(self,) -> 'None': + def Reset(self) -> None: """ Resets the enumeration sequence to the beginning. @@ -18517,9 +17986,9 @@ Returns: None """ - pass + ... - def Clone(self,) -> 'Any': + def Clone(self) -> Any: """ Creates another enumerator that contains the same @@ -18534,16 +18003,16 @@ Returns: Any """ - pass + ... -class PyIEnumDebugApplicationNodes(object): +class PyIEnumDebugApplicationNodes: """A Python interface to IEnumDebugApplicationNodes""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: 'Any' = 1) -> 'Any': + def Next(self, num: Any = 1) -> Any: """ Retrieves a specified number of items in the enumeration sequence. @@ -18556,9 +18025,9 @@ Returns: Any """ - pass + ... - def Skip(self,) -> 'None': + def Skip(self) -> None: """ Skips over the next specified elementes. @@ -18571,9 +18040,9 @@ Returns: None """ - pass + ... - def Reset(self,) -> 'None': + def Reset(self) -> None: """ Resets the enumeration sequence to the beginning. @@ -18586,9 +18055,9 @@ Returns: None """ - pass + ... - def Clone(self,) -> 'Any': + def Clone(self) -> Any: """ Creates another enumerator that @@ -18603,16 +18072,16 @@ Returns: Any """ - pass + ... -class PyIEnumDebugCodeContexts(object): +class PyIEnumDebugCodeContexts: """A Python interface to IEnumDebugCodeContexts""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: 'Any' = 1) -> 'Any': + def Next(self, num: Any = 1) -> Any: """ Retrieves a specified number of items in the enumeration sequence. @@ -18625,9 +18094,9 @@ Returns: Any """ - pass + ... - def Skip(self,) -> 'None': + def Skip(self) -> None: """ Skips over the next specified elementes. @@ -18640,9 +18109,9 @@ Returns: None """ - pass + ... - def Reset(self,) -> 'None': + def Reset(self) -> None: """ Resets the enumeration sequence to the beginning. @@ -18655,9 +18124,9 @@ Returns: None """ - pass + ... - def Clone(self,) -> 'Any': + def Clone(self) -> Any: """ Creates another enumerator that contains the @@ -18672,16 +18141,16 @@ Returns: Any """ - pass + ... -class PyIEnumDebugExpressionContexts(object): +class PyIEnumDebugExpressionContexts: """A Python interface to IEnumDebugExpressionContexts""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: 'Any' = 1) -> 'Any': + def Next(self, num: Any = 1) -> Any: """ Retrieves a specified number of items in the enumeration @@ -18696,9 +18165,9 @@ Returns: Any """ - pass + ... - def Skip(self,) -> 'None': + def Skip(self) -> None: """ Skips over the next specified elementes. @@ -18711,9 +18180,9 @@ Returns: None """ - pass + ... - def Reset(self,) -> 'None': + def Reset(self) -> None: """ Resets the enumeration sequence to the beginning. @@ -18726,9 +18195,9 @@ Returns: None """ - pass + ... - def Clone(self,) -> 'Any': + def Clone(self) -> Any: """ Creates another enumerator that @@ -18743,16 +18212,16 @@ Returns: Any """ - pass + ... -class PyIEnumDebugPropertyInfo(object): +class PyIEnumDebugPropertyInfo: """A Python interface to IEnumDebugPropertyInfo""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: 'Any' = 1) -> 'Any': + def Next(self, num: Any = 1) -> Any: """ Retrieves a specified number of items in the enumeration sequence. @@ -18765,9 +18234,9 @@ Returns: Any """ - pass + ... - def Skip(self,) -> 'None': + def Skip(self) -> None: """ Skips over the next specified elementes. @@ -18780,9 +18249,9 @@ Returns: None """ - pass + ... - def Reset(self,) -> 'None': + def Reset(self) -> None: """ Resets the enumeration sequence to the beginning. @@ -18795,9 +18264,9 @@ Returns: None """ - pass + ... - def Clone(self,) -> 'Any': + def Clone(self) -> Any: """ Creates another enumerator that contains the @@ -18812,9 +18281,9 @@ Returns: Any """ - pass + ... - def GetCount(self,) -> 'Any': + def GetCount(self) -> Any: """ Obtains the number of items @@ -18827,16 +18296,16 @@ Returns: Any """ - pass + ... -class PyIEnumDebugStackFrames(object): +class PyIEnumDebugStackFrames: """A Python interface to IEnumDebugStackFrames""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: 'Any' = 1) -> 'Any': + def Next(self, num: Any = 1) -> Any: """ Retrieves a specified number of items in the enumeration sequence. @@ -18849,9 +18318,9 @@ Returns: Any """ - pass + ... - def Skip(self,) -> 'None': + def Skip(self) -> None: """ Skips over the next specified elementes. @@ -18864,9 +18333,9 @@ Returns: None """ - pass + ... - def Reset(self,) -> 'None': + def Reset(self) -> None: """ Resets the enumeration sequence to the beginning. @@ -18879,9 +18348,9 @@ Returns: None """ - pass + ... - def Clone(self,) -> 'Any': + def Clone(self) -> Any: """ Creates another enumerator that contains the same @@ -18896,16 +18365,16 @@ Returns: Any """ - pass + ... -class PyIEnumExplorerCommand(object): +class PyIEnumExplorerCommand: """A Python interface to IEnumExplorerCommand""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: 'Any' = 1) -> 'Any': + def Next(self, num: Any = 1) -> Any: """ Retrieves a specified number of items in the enumeration sequence. @@ -18918,9 +18387,9 @@ Returns: Any """ - pass + ... - def Skip(self,) -> 'None': + def Skip(self) -> None: """ Skips over the next specified elementes. @@ -18933,9 +18402,9 @@ Returns: None """ - pass + ... - def Reset(self,) -> 'None': + def Reset(self) -> None: """ Resets the enumeration sequence to the beginning. @@ -18948,9 +18417,9 @@ Returns: None """ - pass + ... - def Clone(self,) -> 'Any': + def Clone(self) -> Any: """ Creates another enumerator that contains the same @@ -18965,16 +18434,16 @@ Returns: Any """ - pass + ... -class PyIEnumFORMATETC(object): +class PyIEnumFORMATETC: """A Python interface to IEnumFORMATETC""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: 'Any' = 1) -> 'Any': + def Next(self, num: Any = 1) -> Any: """ Retrieves a specified number of items in the enumeration sequence. @@ -18987,9 +18456,9 @@ Returns: Any """ - pass + ... - def Skip(self,) -> 'None': + def Skip(self) -> None: """ Skips over the next specified elementes. @@ -19002,9 +18471,9 @@ Returns: None """ - pass + ... - def Reset(self,) -> 'None': + def Reset(self) -> None: """ Resets the enumeration sequence to the beginning. @@ -19017,9 +18486,9 @@ Returns: None """ - pass + ... - def Clone(self,) -> 'Any': + def Clone(self) -> Any: """ Creates another enumerator that contains the same enumeration @@ -19034,16 +18503,16 @@ Returns: Any """ - pass + ... -class PyIEnumGUID(object): +class PyIEnumGUID: """A Python interface to IEnumGUID""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: 'Any' = 1) -> 'Tuple[PyIID, ...]': + def Next(self, num: Any = 1) -> Tuple[PyIID, ...]: """ Retrieves a specified number of items in the enumeration sequence. @@ -19062,9 +18531,9 @@ an error condition - an empty tuple is simply returned. """ - pass + ... - def Skip(self, num: 'Any') -> 'None': + def Skip(self, num: Any) -> None: """ Skips over the next specified elementes. @@ -19077,9 +18546,9 @@ Returns: None """ - pass + ... - def Reset(self,) -> 'None': + def Reset(self) -> None: """ Resets the enumeration sequence to the beginning. @@ -19092,9 +18561,9 @@ Returns: None """ - pass + ... - def Clone(self,) -> 'Any': + def Clone(self) -> Any: """ Creates another enumerator that contains the same enumeration state as @@ -19109,16 +18578,16 @@ Returns: Any """ - pass + ... -class PyIEnumIDList(object): +class PyIEnumIDList: """A Python interface to IEnumIDList""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: 'Any' = 1) -> 'Any': + def Next(self, num: Any = 1) -> Any: """ Retrieves a specified number of items in the enumeration sequence. @@ -19131,9 +18600,9 @@ Returns: Any """ - pass + ... - def Skip(self,) -> 'None': + def Skip(self) -> None: """ Skips over the next specified elementes. @@ -19146,9 +18615,9 @@ Returns: None """ - pass + ... - def Reset(self,) -> 'None': + def Reset(self) -> None: """ Resets the enumeration sequence to the beginning. @@ -19161,9 +18630,9 @@ Returns: None """ - pass + ... - def Clone(self,) -> 'Any': + def Clone(self) -> Any: """ Creates another enumerator that contains the same enumeration state @@ -19178,16 +18647,16 @@ Returns: Any """ - pass + ... -class PyIEnumMoniker(object): +class PyIEnumMoniker: """A Python interface to IEnumMoniker""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: 'Any' = 1) -> 'Any': + def Next(self, num: Any = 1) -> Any: """ Retrieves a specified number of items in the enumeration sequence. @@ -19206,9 +18675,9 @@ an error condition - an empty tuple is simply returned. """ - pass + ... - def Skip(self, num: 'Any') -> 'None': + def Skip(self, num: Any) -> None: """ Skips over the next specified elementes. @@ -19221,9 +18690,9 @@ Returns: None """ - pass + ... - def Reset(self,) -> 'None': + def Reset(self) -> None: """ Resets the enumeration sequence to the beginning. @@ -19236,9 +18705,9 @@ Returns: None """ - pass + ... - def Clone(self,) -> 'Any': + def Clone(self) -> Any: """ Creates another enumerator that contains the same enumeration state @@ -19253,16 +18722,16 @@ Returns: Any """ - pass + ... -class PyIEnumObjects(object): +class PyIEnumObjects: """Iterates through a number of arbitrary interfaces""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, riid: 'PyIID', num: 'Any' = 1) -> 'Tuple[Any, ...]': + def Next(self, riid: PyIID, num: Any = 1) -> Tuple[Any, ...]: """ Retrieves a specified number of items in the enumeration sequence. @@ -19276,9 +18745,9 @@ Returns: Tuple[Any, ...] """ - pass + ... - def Skip(self,) -> 'None': + def Skip(self) -> None: """ Skips over the next specified elementes. @@ -19291,9 +18760,9 @@ Returns: None """ - pass + ... - def Reset(self,) -> 'None': + def Reset(self) -> None: """ Resets the enumeration sequence to the beginning. @@ -19306,9 +18775,9 @@ Returns: None """ - pass + ... - def Clone(self,) -> 'Any': + def Clone(self) -> Any: """ Creates another enumerator that contains the same enumeration state @@ -19323,16 +18792,16 @@ Returns: Any """ - pass + ... -class PyIEnumRemoteDebugApplicationThreads(object): +class PyIEnumRemoteDebugApplicationThreads: """A Python interface to IEnumRemoteDebugApplicationThreads""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: 'Any' = 1) -> 'Any': + def Next(self, num: Any = 1) -> Any: """ Retrieves a specified number of items in the enumeration @@ -19347,9 +18816,9 @@ Returns: Any """ - pass + ... - def Skip(self,) -> 'None': + def Skip(self) -> None: """ Skips over the next specified elementes. @@ -19362,9 +18831,9 @@ Returns: None """ - pass + ... - def Reset(self,) -> 'None': + def Reset(self) -> None: """ Resets the enumeration sequence to the beginning. @@ -19377,9 +18846,9 @@ Returns: None """ - pass + ... - def Clone(self,) -> 'Any': + def Clone(self) -> Any: """ Creates another @@ -19394,16 +18863,16 @@ Returns: Any """ - pass + ... -class PyIEnumRemoteDebugApplications(object): +class PyIEnumRemoteDebugApplications: """A Python interface to IEnumRemoteDebugApplications""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: 'Any' = 1) -> 'Any': + def Next(self, num: Any = 1) -> Any: """ Retrieves a specified number of items in the enumeration @@ -19418,9 +18887,9 @@ Returns: Any """ - pass + ... - def Skip(self,) -> 'None': + def Skip(self) -> None: """ Skips over the next specified elementes. @@ -19433,9 +18902,9 @@ Returns: None """ - pass + ... - def Reset(self,) -> 'None': + def Reset(self) -> None: """ Resets the enumeration sequence to the beginning. @@ -19448,9 +18917,9 @@ Returns: None """ - pass + ... - def Clone(self,) -> 'Any': + def Clone(self) -> Any: """ Creates another enumerator that @@ -19465,16 +18934,16 @@ Returns: Any """ - pass + ... -class PyIEnumResources(object): +class PyIEnumResources: """A Python interface to IEnumResources""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: 'Any' = 1) -> 'Any': + def Next(self, num: Any = 1) -> Any: """ Retrieves a specified number of items in the enumeration sequence. @@ -19487,9 +18956,9 @@ Returns: Any """ - pass + ... - def Skip(self,) -> 'None': + def Skip(self) -> None: """ Skips over the next specified elementes. @@ -19502,9 +18971,9 @@ Returns: None """ - pass + ... - def Reset(self,) -> 'None': + def Reset(self) -> None: """ Resets the enumeration sequence to the beginning. @@ -19517,9 +18986,9 @@ Returns: None """ - pass + ... - def Clone(self,) -> 'Any': + def Clone(self) -> Any: """ Creates another enumerator that contains the same enumeration @@ -19534,16 +19003,16 @@ Returns: Any """ - pass + ... -class PyIEnumSTATPROPSETSTG(object): +class PyIEnumSTATPROPSETSTG: """A Python interface to IEnumSTATPROPSETSTG""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: 'Any' = 1) -> 'Any': + def Next(self, num: Any = 1) -> Any: """ Retrieves a specified number of items in the enumeration sequence. @@ -19556,9 +19025,9 @@ Returns: Any """ - pass + ... - def Skip(self,) -> 'None': + def Skip(self) -> None: """ Skips over the next specified elementes. @@ -19571,9 +19040,9 @@ Returns: None """ - pass + ... - def Reset(self,) -> 'None': + def Reset(self) -> None: """ Resets the enumeration sequence to the beginning. @@ -19586,9 +19055,9 @@ Returns: None """ - pass + ... - def Clone(self,) -> 'Any': + def Clone(self) -> Any: """ Creates another enumerator that contains the same @@ -19603,16 +19072,16 @@ Returns: Any """ - pass + ... -class PyIEnumSTATPROPSTG(object): +class PyIEnumSTATPROPSTG: """A Python interface to IEnumSTATPROPSTG""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: 'Any' = 1) -> 'Any': + def Next(self, num: Any = 1) -> Any: """ Retrieves a specified number of items in the enumeration sequence. @@ -19625,9 +19094,9 @@ Returns: Any """ - pass + ... - def Skip(self,) -> 'None': + def Skip(self) -> None: """ Skips over the next specified elementes. @@ -19640,9 +19109,9 @@ Returns: None """ - pass + ... - def Reset(self,) -> 'None': + def Reset(self) -> None: """ Resets the enumeration sequence to the beginning. @@ -19655,9 +19124,9 @@ Returns: None """ - pass + ... - def Clone(self,) -> 'Any': + def Clone(self) -> Any: """ Creates another enumerator that contains the same @@ -19672,16 +19141,15 @@ Returns: Any """ - pass + ... -class PyIEnumSTATSTG(object): - """""" +class PyIEnumSTATSTG: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: 'Any' = 1) -> 'Tuple[Any, ...]': + def Next(self, num: Any = 1) -> Tuple[Any, ...]: """ Retrieves a specified number of items in the enumeration sequence. @@ -19694,9 +19162,9 @@ Returns: Tuple[Any, ...] """ - pass + ... - def Skip(self,) -> 'None': + def Skip(self) -> None: """ Skips over the next specified elementes. @@ -19709,9 +19177,9 @@ Returns: None """ - pass + ... - def Reset(self,) -> 'None': + def Reset(self) -> None: """ Resets the enumeration sequence to the beginning. @@ -19724,9 +19192,9 @@ Returns: None """ - pass + ... - def Clone(self,) -> 'Any': + def Clone(self) -> Any: """ Creates another enumerator that contains the same enumeration state @@ -19741,16 +19209,16 @@ Returns: Any """ - pass + ... -class PyIEnumShellItems(object): +class PyIEnumShellItems: """A Python interface to IEnumShellItems""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: 'Any' = 1) -> 'Tuple[Any, ...]': + def Next(self, num: Any = 1) -> Tuple[Any, ...]: """ Retrieves a specified number of items in the enumeration @@ -19765,9 +19233,9 @@ Returns: Tuple[Any, ...] """ - pass + ... - def Skip(self,) -> 'None': + def Skip(self) -> None: """ Skips over the next specified elementes. @@ -19780,9 +19248,9 @@ Returns: None """ - pass + ... - def Reset(self,) -> 'None': + def Reset(self) -> None: """ Resets the enumeration sequence to the beginning. @@ -19795,9 +19263,9 @@ Returns: None """ - pass + ... - def Clone(self,) -> 'Any': + def Clone(self) -> Any: """ Creates another enumerator that contains the same enumeration @@ -19812,16 +19280,16 @@ Returns: Any """ - pass + ... -class PyIEnumString(object): +class PyIEnumString: """An enumerator interface to list strings""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: 'Any' = 1) -> 'Tuple[str, ...]': + def Next(self, num: Any = 1) -> Tuple[str, ...]: """ Retrieves a specified number of items in the enumeration sequence. @@ -19834,9 +19302,9 @@ Returns: Tuple[str, ...] """ - pass + ... - def Skip(self,) -> 'None': + def Skip(self) -> None: """ Skips over the next specified elementes. @@ -19849,9 +19317,9 @@ Returns: None """ - pass + ... - def Reset(self,) -> 'None': + def Reset(self) -> None: """ Resets the enumeration sequence to the beginning. @@ -19864,9 +19332,9 @@ Returns: None """ - pass + ... - def Clone(self,) -> 'Any': + def Clone(self) -> Any: """ Creates another enumerator that contains the same enumeration state @@ -19881,16 +19349,16 @@ Returns: Any """ - pass + ... -class PyIErrorLog(object): +class PyIErrorLog: """A Python wrapper for a COM IErrorLog interface.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def AddError(self, propName: 'str', excepInfo: 'Any' = None) -> 'None': + def AddError(self, propName: str, excepInfo: Any = None) -> None: """ Adds an error to the error log. @@ -19904,16 +19372,16 @@ Returns: None """ - pass + ... -class PyIExplorerBrowser(object): +class PyIExplorerBrowser: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Initialize(self, hwndParent: 'Any', prc: 'PyRECT', pfs: 'Any') -> 'None': + def Initialize(self, hwndParent: Any, prc: PyRECT, pfs: Any) -> None: """ Description of Initialize. @@ -19928,9 +19396,9 @@ Returns: None """ - pass + ... - def Destroy(self,) -> 'None': + def Destroy(self) -> None: """ Description of Destroy. @@ -19943,9 +19411,9 @@ Returns: None """ - pass + ... - def SetRect(self, hdwp: 'Any', rcBrowser: 'PyRECT') -> 'int': + def SetRect(self, hdwp: Any, rcBrowser: PyRECT) -> int: """ Description of SetRect. @@ -19959,9 +19427,9 @@ Returns: int """ - pass + ... - def SetPropertyBag(self, PropertyBag: 'Any') -> 'None': + def SetPropertyBag(self, PropertyBag: Any) -> None: """ Description of SetPropertyBag. @@ -19974,9 +19442,9 @@ Returns: None """ - pass + ... - def SetEmptyText(self, EmptyText: 'Any') -> 'None': + def SetEmptyText(self, EmptyText: Any) -> None: """ Description of SetEmptyText. @@ -19989,9 +19457,9 @@ Returns: None """ - pass + ... - def SetFolderSettings(self, pfs: 'Any') -> 'None': + def SetFolderSettings(self, pfs: Any) -> None: """ Description of SetFolderSettings. @@ -20004,9 +19472,9 @@ Returns: None """ - pass + ... - def Advise(self, psbe: 'Any') -> 'Any': + def Advise(self, psbe: Any) -> Any: """ Description of Advise. @@ -20019,9 +19487,9 @@ Returns: Any """ - pass + ... - def Unadvise(self, dwCookie: 'Any') -> 'None': + def Unadvise(self, dwCookie: Any) -> None: """ Description of Unadvise. @@ -20034,9 +19502,9 @@ Returns: None """ - pass + ... - def SetOptions(self, dwFlag: 'Any') -> 'None': + def SetOptions(self, dwFlag: Any) -> None: """ Description of SetOptions. @@ -20049,9 +19517,9 @@ Returns: None """ - pass + ... - def GetOptions(self,) -> 'Any': + def GetOptions(self) -> Any: """ Description of GetOptions. @@ -20064,9 +19532,9 @@ Returns: Any """ - pass + ... - def BrowseToIDList(self, pidl: 'Any', uFlags: 'Any') -> 'None': + def BrowseToIDList(self, pidl: Any, uFlags: Any) -> None: """ Description of BrowseToIDList. @@ -20080,9 +19548,9 @@ Returns: None """ - pass + ... - def BrowseToObject(self, punk: 'Any', uFlags: 'Any') -> 'None': + def BrowseToObject(self, punk: Any, uFlags: Any) -> None: """ Description of BrowseToObject. @@ -20096,9 +19564,9 @@ Returns: None """ - pass + ... - def FillFromObject(self, punk: 'Any', dwFlags: 'Any') -> 'None': + def FillFromObject(self, punk: Any, dwFlags: Any) -> None: """ Description of FillFromObject. @@ -20112,9 +19580,9 @@ Returns: None """ - pass + ... - def RemoveAll(self,) -> 'None': + def RemoveAll(self) -> None: """ Description of RemoveAll. @@ -20127,9 +19595,9 @@ Returns: None """ - pass + ... - def GetCurrentView(self, riid: 'PyIID') -> 'Any': + def GetCurrentView(self, riid: PyIID) -> Any: """ Description of GetCurrentView. @@ -20142,16 +19610,16 @@ Returns: Any """ - pass + ... -class PyIExplorerBrowserEvents(object): +class PyIExplorerBrowserEvents: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def OnNavigationPending(self, pidlFolder: 'Any') -> 'None': + def OnNavigationPending(self, pidlFolder: Any) -> None: """ Description of OnNavigationPending. @@ -20164,9 +19632,9 @@ Returns: None """ - pass + ... - def OnViewCreated(self, psv: 'Any') -> 'None': + def OnViewCreated(self, psv: Any) -> None: """ Description of OnViewCreated. @@ -20179,9 +19647,9 @@ Returns: None """ - pass + ... - def OnNavigationComplete(self, pidlFolder: 'Any') -> 'None': + def OnNavigationComplete(self, pidlFolder: Any) -> None: """ Description of OnNavigationComplete. @@ -20194,9 +19662,9 @@ Returns: None """ - pass + ... - def OnNavigationFailed(self, pidlFolder: 'Any') -> 'None': + def OnNavigationFailed(self, pidlFolder: Any) -> None: """ Description of OnNavigationFailed. @@ -20209,16 +19677,16 @@ Returns: None """ - pass + ... -class PyIExplorerCommand(object): +class PyIExplorerCommand: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetTitle(self, psiItemArray: 'Any') -> 'Any': + def GetTitle(self, psiItemArray: Any) -> Any: """ Description of GetTitle. @@ -20231,9 +19699,9 @@ Returns: Any """ - pass + ... - def GetIcon(self, psiItemArray: 'Any') -> 'Any': + def GetIcon(self, psiItemArray: Any) -> Any: """ Description of GetIcon. @@ -20246,9 +19714,9 @@ Returns: Any """ - pass + ... - def GetToolTip(self, psiItemArray: 'Any') -> 'Any': + def GetToolTip(self, psiItemArray: Any) -> Any: """ Description of GetToolTip. @@ -20261,9 +19729,9 @@ Returns: Any """ - pass + ... - def GetCanonicalName(self,) -> 'PyIID': + def GetCanonicalName(self) -> PyIID: """ Description of GetCanonicalName. @@ -20276,9 +19744,9 @@ Returns: PyIID """ - pass + ... - def GetState(self, psiItemArray: 'Any', fOkToBeSlow: 'Any') -> 'Any': + def GetState(self, psiItemArray: Any, fOkToBeSlow: Any) -> Any: """ Description of GetState. @@ -20292,9 +19760,9 @@ Returns: Any """ - pass + ... - def Invoke(self, psiItemArray: 'Any', pbc: 'Any') -> 'None': + def Invoke(self, psiItemArray: Any, pbc: Any) -> None: """ Description of Invoke. @@ -20308,9 +19776,9 @@ Returns: None """ - pass + ... - def GetFlags(self,) -> 'Any': + def GetFlags(self) -> Any: """ Description of GetFlags. @@ -20323,9 +19791,9 @@ Returns: Any """ - pass + ... - def EnumSubCommands(self,) -> 'Any': + def EnumSubCommands(self) -> Any: """ Description of EnumSubCommands. @@ -20338,30 +19806,30 @@ Returns: Any """ - pass + ... -class PyIExplorerCommandProvider(object): +class PyIExplorerCommandProvider: """This is a gateway only interface.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyIExplorerPaneVisibility(object): +class PyIExplorerPaneVisibility: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyIExternalConnection(object): +class PyIExternalConnection: """A Python wrapper for a COM IExternalConnection interface.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def AddConnection(self, extconn: 'Any', reserved: 'Any' = 0) -> 'Any': + def AddConnection(self, extconn: Any, reserved: Any = 0) -> Any: """ Increments an object's count of its strong external connections @@ -20379,9 +19847,9 @@ Return ValueThe result is the number of reference counts on the object; used for """ - pass + ... - def ReleaseConnection(self, extconn: 'Any', reserved: 'Any', fLastReleaseCloses: 'Any') -> 'Any': + def ReleaseConnection(self, extconn: Any, reserved: Any, fLastReleaseCloses: Any) -> Any: """ Decrements an object's count of its strong external connections @@ -20403,16 +19871,16 @@ or another process.Return ValueThe result is the number of reference counts on t """ - pass + ... -class PyIExtractIcon(object): +class PyIExtractIcon: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Extract(self, pszFile: 'Any', nIconIndex: 'Any', nIconSize: 'Any') -> 'None': + def Extract(self, pszFile: Any, nIconIndex: Any, nIconSize: Any) -> None: """ Description of Extract. @@ -20432,9 +19900,9 @@ the calling application should extract it. """ - pass + ... - def GetIconLocation(self, uFlags: 'Any', cchMax: 'Any') -> 'None': + def GetIconLocation(self, uFlags: Any, cchMax: Any) -> None: """ Description of GetIconLocation. @@ -20448,16 +19916,16 @@ Returns: None """ - pass + ... -class PyIExtractIconW(object): +class PyIExtractIconW: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Extract(self, pszFile: 'Any', nIconIndex: 'Any', nIconSize: 'Any') -> 'None': + def Extract(self, pszFile: Any, nIconIndex: Any, nIconSize: Any) -> None: """ Description of Extract. @@ -20477,9 +19945,9 @@ the calling application should extract it. """ - pass + ... - def GetIconLocation(self, uFlags: 'Any', cchMax: 'Any') -> 'None': + def GetIconLocation(self, uFlags: Any, cchMax: Any) -> None: """ Description of GetIconLocation. @@ -20493,16 +19961,16 @@ Returns: None """ - pass + ... -class PyIExtractImage(object): +class PyIExtractImage: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetLocation(self, dwPriority: 'Any', size: 'Tuple[Any, Any]', dwRecClrDepth: 'Any', pdwFlags: 'Any') -> 'None': + def GetLocation(self, dwPriority: Any, size: Tuple[Any, Any], dwRecClrDepth: Any, pdwFlags: Any) -> None: """ Description of GetLocation. @@ -20518,9 +19986,9 @@ Returns: None """ - pass + ... - def Extract(self,) -> 'None': + def Extract(self) -> None: """ Description of Extract. @@ -20533,16 +20001,15 @@ Returns: None """ - pass + ... -class PyIFileOperation(object): - """""" +class PyIFileOperation: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Advise(self, Sink: 'Any') -> 'Any': + def Advise(self, Sink: Any) -> Any: """ Connects an event sink to receive updates @@ -20556,9 +20023,9 @@ Returns: """ - pass + ... - def Unadvise(self, Cookie: 'Any') -> 'None': + def Unadvise(self, Cookie: Any) -> None: """ Disconnects a progress sink @@ -20571,9 +20038,9 @@ Returns: None """ - pass + ... - def SetOperationFlags(self, OperationFlags: 'Any') -> 'None': + def SetOperationFlags(self, OperationFlags: Any) -> None: """ Sets option flags for the operation @@ -20586,9 +20053,9 @@ Returns: None """ - pass + ... - def SetProgressMessage(self, Message: 'Any') -> 'None': + def SetProgressMessage(self, Message: Any) -> None: """ Not implemented. @@ -20601,9 +20068,9 @@ Returns: None """ - pass + ... - def SetProgressDialog(self, popd: 'Any') -> 'None': + def SetProgressDialog(self, popd: Any) -> None: """ Provides an interface used to display a progress dialog @@ -20616,24 +20083,24 @@ Returns: None """ - pass + ... - def SetProperties(self, proparray: 'Any') -> 'None': + def SetProperties(self, proparray: Any) -> None: """ Specifies a set of properties to be changed. Args: - proparray(Any):Sequence of property changes to be performed (see propsys::PSCreatePropertyChangeArray)CommentsNote that these properties will be set for *any* files created by the operation, not just items passed to ApplyPropertiesToItem(s). New items created as the result of a rename, copy, or move must have a property handler, or the operation fails with the vague com_error: (-2147467259, 'Unspecified error', None, None) (E_FAIL, or 0x80004005 in hex) even though the given file operation was actually performed. + proparray(Any):Sequence of property changes to be performed (see propsys::PSCreatePropertyChangeArray)CommentsNote that these properties will be set for *any* files created by the operation, not just items passed to ApplyPropertiesToItem(s). New items created as the result of a rename, copy, or move must have a property handler, or the operation fails with the vague com_error: (-2147467259, 'Unspecified error, None, None) (E_FAIL, or 0x80004005 in hex) even though the given file operation was actually performed. Returns: None """ - pass + ... - def SetOwnerWindow(self, Owner: 'int') -> 'None': + def SetOwnerWindow(self, Owner: int) -> None: """ Sets the parent window for any UI displayed. @@ -20646,9 +20113,9 @@ Returns: None """ - pass + ... - def ApplyPropertiesToItem(self, Item: 'Any') -> 'None': + def ApplyPropertiesToItem(self, Item: Any) -> None: """ Specifies the item that will receive property changes @@ -20661,9 +20128,9 @@ Returns: None """ - pass + ... - def ApplyPropertiesToItems(self, Items: 'Any') -> 'None': + def ApplyPropertiesToItems(self, Items: Any) -> None: """ Specifies multiple items that will receive property changes @@ -20676,9 +20143,9 @@ Returns: None """ - pass + ... - def RenameItem(self, Item: 'Any', NewName: 'Any', Sink: 'Any' = None) -> 'None': + def RenameItem(self, Item: Any, NewName: Any, Sink: Any = None) -> None: """ Adds a rename to the operation sequence @@ -20693,9 +20160,9 @@ Returns: None """ - pass + ... - def RenameItems(self, pUnkItems: 'Any', NewName: 'Any') -> 'None': + def RenameItems(self, pUnkItems: Any, NewName: Any) -> None: """ Adds multiple renames to the operation sequence @@ -20709,9 +20176,9 @@ Returns: None """ - pass + ... - def MoveItem(self, Item: 'Any', DestinationFolder: 'Any', pszNewName: 'Any' = None, Sink: 'Any' = None) -> 'None': + def MoveItem(self, Item: Any, DestinationFolder: Any, pszNewName: Any = None, Sink: Any = None) -> None: """ Adds a move operation to the configuration @@ -20727,9 +20194,9 @@ Returns: None """ - pass + ... - def MoveItems(self, Items: 'Any', DestinationFolder: 'Any') -> 'None': + def MoveItems(self, Items: Any, DestinationFolder: Any) -> None: """ Adds multiple move operations to the configuration @@ -20743,9 +20210,9 @@ Returns: None """ - pass + ... - def CopyItem(self, Item: 'Any', DestinationFolder: 'Any', CopyName: 'Any' = None, Sink: 'Any' = None) -> 'None': + def CopyItem(self, Item: Any, DestinationFolder: Any, CopyName: Any = None, Sink: Any = None) -> None: """ Adds a copy operation to the configuration @@ -20761,9 +20228,9 @@ Returns: None """ - pass + ... - def CopyItems(self, Items: 'Any', DestinationFolder: 'Any') -> 'None': + def CopyItems(self, Items: Any, DestinationFolder: Any) -> None: """ Adds multiple copy operations to the configuration @@ -20777,9 +20244,9 @@ Returns: None """ - pass + ... - def DeleteItem(self, Item: 'Any', Sink: 'Any' = None) -> 'None': + def DeleteItem(self, Item: Any, Sink: Any = None) -> None: """ Adds a delete operation to the configuration @@ -20793,9 +20260,9 @@ Returns: None """ - pass + ... - def DeleteItems(self, Items: 'Any') -> 'None': + def DeleteItems(self, Items: Any) -> None: """ Adds multiple delete operations to the configuration @@ -20808,15 +20275,15 @@ Returns: None """ - pass + ... def NewItem( self, - DestinationFolder: 'Any', - FileAttributes: 'Any', - Name: 'Any', - TemplateName: 'Any' = None, - Sink: 'Any' = None) -> 'None': + DestinationFolder: Any, + FileAttributes: Any, + Name: Any, + TemplateName: Any = None, + Sink: Any = None) -> None: """ Creates a new file as part of the operation @@ -20833,9 +20300,9 @@ Returns: None """ - pass + ... - def PerformOperations(self,) -> 'None': + def PerformOperations(self) -> None: """ Effects all configured file system modifications @@ -20848,9 +20315,9 @@ Returns: None """ - pass + ... - def GetAnyOperationsAborted(self,) -> 'Any': + def GetAnyOperationsAborted(self) -> Any: """ Determines if any operations were terminated @@ -20863,25 +20330,25 @@ Returns: Any """ - pass + ... -class PyIIdentityName(object): +class PyIIdentityName: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyIInitializeWithFile(object): +class PyIInitializeWithFile: """Initializes a property handler that requires a file path instead of a stream""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Initialize(self, FilePath: 'Any', Mode: 'Any') -> 'None': + def Initialize(self, FilePath: Any, Mode: Any) -> None: """ - passes a file path to a property handler on startup + ...es a file path to a property handler on startup Args: @@ -20893,16 +20360,16 @@ Returns: None """ - pass + ... -class PyIInitializeWithStream(object): +class PyIInitializeWithStream: """Interface that initializes a handler capable of reading properties from a stream""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Initialize(self, Stream: 'Any', Mode: 'Any') -> 'None': + def Initialize(self, Stream: Any, Mode: Any) -> None: """ Initializes a property handler with a stream @@ -20916,16 +20383,16 @@ Returns: None """ - pass + ... -class PyIInputObject(object): +class PyIInputObject: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def TranslateAccelerator(self, pmsg: 'Any') -> 'None': + def TranslateAccelerator(self, pmsg: Any) -> None: """ Description of TranslateAccelerator. @@ -20938,9 +20405,9 @@ Returns: None """ - pass + ... - def UIActivate(self, uState: 'Any') -> 'None': + def UIActivate(self, uState: Any) -> None: """ Description of UIActivate. @@ -20953,9 +20420,9 @@ Returns: None """ - pass + ... - def HasFocusIO(self,) -> 'None': + def HasFocusIO(self) -> None: """ Description of Refresh. @@ -20968,16 +20435,16 @@ Returns: None """ - pass + ... -class PyIInternetBindInfo(object): +class PyIInternetBindInfo: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetBindInfo(self,) -> 'None': + def GetBindInfo(self) -> None: """ Description of GetBindInfo. @@ -20990,9 +20457,9 @@ Returns: None """ - pass + ... - def GetBindString(self,) -> 'None': + def GetBindString(self) -> None: """ Description of GetBindString. @@ -21005,16 +20472,16 @@ Returns: None """ - pass + ... -class PyIInternetPriority(object): +class PyIInternetPriority: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def SetPriority(self, nPriority: 'Any') -> 'None': + def SetPriority(self, nPriority: Any) -> None: """ Description of SetPriority. @@ -21027,9 +20494,9 @@ Returns: None """ - pass + ... - def GetPriority(self,) -> 'None': + def GetPriority(self) -> None: """ Description of GetPriority. @@ -21042,16 +20509,16 @@ Returns: None """ - pass + ... -class PyIInternetProtocol(object): +class PyIInternetProtocol: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Read(self, cb: 'Any') -> 'None': + def Read(self, cb: Any) -> None: """ Description of Read. @@ -21064,9 +20531,9 @@ Returns: None """ - pass + ... - def Seek(self, dlibMove: 'LARGE_INTEGER', dwOrigin: 'Any') -> 'None': + def Seek(self, dlibMove: LARGE_INTEGER, dwOrigin: Any) -> None: """ Description of Seek. @@ -21080,9 +20547,9 @@ Returns: None """ - pass + ... - def LockRequest(self, dwOptions: 'Any') -> 'None': + def LockRequest(self, dwOptions: Any) -> None: """ Description of LockRequest. @@ -21095,9 +20562,9 @@ Returns: None """ - pass + ... - def UnlockRequest(self,) -> 'None': + def UnlockRequest(self) -> None: """ Description of UnlockRequest. @@ -21110,10 +20577,10 @@ Returns: None """ - pass + ... -class PyIInternetProtocolInfo(object): +class PyIInternetProtocolInfo: """Description of the interface""" def __new__(cls): @@ -21121,11 +20588,11 @@ class PyIInternetProtocolInfo(object): def ParseUrl( self, - pwzUrl: 'Any', - ParseAction: 'Any', - dwParseFlags: 'Any', - cchResult: 'Any', - dwReserved: 'Any') -> 'None': + pwzUrl: Any, + ParseAction: Any, + dwParseFlags: Any, + cchResult: Any, + dwReserved: Any) -> None: """ Description of ParseUrl. @@ -21142,15 +20609,15 @@ Returns: None """ - pass + ... def CombineUrl( self, - pwzBaseUrl: 'Any', - pwzRelativeUrl: 'Any', - dwCombineFlags: 'Any', - cchResult: 'Any', - dwReserved: 'Any') -> 'None': + pwzBaseUrl: Any, + pwzRelativeUrl: Any, + dwCombineFlags: Any, + cchResult: Any, + dwReserved: Any) -> None: """ Description of CombineUrl. @@ -21167,9 +20634,9 @@ Returns: None """ - pass + ... - def CompareUrl(self, pwzUrl1: 'Any', pwzUrl2: 'Any', dwCompareFlags: 'Any') -> 'None': + def CompareUrl(self, pwzUrl1: Any, pwzUrl2: Any, dwCompareFlags: Any) -> None: """ Description of CompareUrl. @@ -21184,15 +20651,15 @@ Returns: None """ - pass + ... def QueryInfo( self, - pwzUrl: 'Any', - OueryOption: 'Any', - dwQueryFlags: 'Any', - cbBuffer: 'Any', - dwReserved: 'Any') -> 'Any': + pwzUrl: Any, + OueryOption: Any, + dwQueryFlags: Any, + cbBuffer: Any, + dwReserved: Any) -> Any: """ Description of QueryInfo. @@ -21209,16 +20676,16 @@ Returns: Any """ - pass + ... -class PyIInternetProtocolRoot(object): +class PyIInternetProtocolRoot: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Start(self, szUrl: 'Any', pOIProtSink: 'Any', pOIBindInfo: 'Any', grfPI: 'Any', dwReserved: 'Any') -> 'None': + def Start(self, szUrl: Any, pOIProtSink: Any, pOIBindInfo: Any, grfPI: Any, dwReserved: Any) -> None: """ Description of Start. @@ -21235,9 +20702,9 @@ Returns: None """ - pass + ... - def Continue(self,) -> 'None': + def Continue(self) -> None: """ Description of Continue. @@ -21250,9 +20717,9 @@ Returns: None """ - pass + ... - def Abort(self, hrReason: 'Any', dwOptions: 'Any') -> 'None': + def Abort(self, hrReason: Any, dwOptions: Any) -> None: """ Description of Abort. @@ -21266,9 +20733,9 @@ Returns: None """ - pass + ... - def Terminate(self, dwOptions: 'Any') -> 'None': + def Terminate(self, dwOptions: Any) -> None: """ Description of Terminate. @@ -21281,9 +20748,9 @@ Returns: None """ - pass + ... - def Suspend(self,) -> 'None': + def Suspend(self) -> None: """ Description of Suspend. @@ -21296,9 +20763,9 @@ Returns: None """ - pass + ... - def Resume(self,) -> 'None': + def Resume(self) -> None: """ Description of Resume. @@ -21311,16 +20778,16 @@ Returns: None """ - pass + ... -class PyIInternetProtocolSink(object): +class PyIInternetProtocolSink: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Switch(self,) -> 'None': + def Switch(self) -> None: """ Description of Switch. @@ -21333,9 +20800,9 @@ Returns: None """ - pass + ... - def ReportProgress(self, ulStatusCode: 'Any', szStatusText: 'Any') -> 'None': + def ReportProgress(self, ulStatusCode: Any, szStatusText: Any) -> None: """ Description of ReportProgress. @@ -21349,9 +20816,9 @@ Returns: None """ - pass + ... - def ReportData(self, grfBSCF: 'Any', ulProgress: 'Any', ulProgressMax: 'Any') -> 'None': + def ReportData(self, grfBSCF: Any, ulProgress: Any, ulProgressMax: Any) -> None: """ Description of ReportData. @@ -21366,9 +20833,9 @@ Returns: None """ - pass + ... - def ReportResult(self, hrResult: 'Any', dwError: 'Any', szResult: 'Any') -> 'None': + def ReportResult(self, hrResult: Any, dwError: Any, szResult: Any) -> None: """ Description of ReportResult. @@ -21383,16 +20850,16 @@ Returns: None """ - pass + ... -class PyIInternetSecurityManager(object): +class PyIInternetSecurityManager: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def SetSecuritySite(self, pSite: 'Any') -> 'None': + def SetSecuritySite(self, pSite: Any) -> None: """ Description of SetSecuritySite. @@ -21405,9 +20872,9 @@ Returns: None """ - pass + ... - def GetSecuritySite(self,) -> 'None': + def GetSecuritySite(self) -> None: """ Description of GetSecuritySite. @@ -21420,9 +20887,9 @@ Returns: None """ - pass + ... - def MapUrlToZone(self, pwszUrl: 'Any', dwFlags: 'Any') -> 'None': + def MapUrlToZone(self, pwszUrl: Any, dwFlags: Any) -> None: """ Description of MapUrlToZone. @@ -21436,9 +20903,9 @@ Returns: None """ - pass + ... - def GetSecurityId(self, pwszUrl: 'Any', pcbSecurityId: 'Any') -> 'None': + def GetSecurityId(self, pwszUrl: Any, pcbSecurityId: Any) -> None: """ Description of GetSecurityId. @@ -21452,9 +20919,9 @@ Returns: None """ - pass + ... - def ProcessUrlAction(self, pwszUrl: 'Any', dwAction: 'Any', context: 'Any', dwFlags: 'Any') -> 'None': + def ProcessUrlAction(self, pwszUrl: Any, dwAction: Any, context: Any, dwFlags: Any) -> None: """ Description of ProcessUrlAction. @@ -21470,9 +20937,9 @@ Returns: None """ - pass + ... - def SetZoneMapping(self, dwZone: 'Any', lpszPattern: 'Any', dwFlags: 'Any') -> 'None': + def SetZoneMapping(self, dwZone: Any, lpszPattern: Any, dwFlags: Any) -> None: """ Description of SetZoneMapping. @@ -21487,9 +20954,9 @@ Returns: None """ - pass + ... - def GetZoneMappings(self, dwZone: 'Any', dwFlags: 'Any') -> 'None': + def GetZoneMappings(self, dwZone: Any, dwFlags: Any) -> None: """ Description of GetZoneMappings. @@ -21503,10 +20970,10 @@ Returns: None """ - pass + ... -class PyIKnownFolder(object): +class PyIKnownFolder: """Interface representing a known folder that serves as a replacement for the numeric CSIDL definitions and API functions. @@ -21516,7 +20983,7 @@ Requires Vista or later.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetId(self,) -> 'PyIID': + def GetId(self) -> PyIID: """ Returns the id of the folder @@ -21529,9 +20996,9 @@ Returns: PyIID """ - pass + ... - def GetCategory(self,) -> 'Any': + def GetCategory(self) -> Any: """ Returns the category for a folder (shellcon.KF_CATEGORY_*) @@ -21544,9 +21011,9 @@ Returns: Any """ - pass + ... - def GetShellItem(self, riid: 'PyIID', Flags: 'Any' = 0) -> 'Any': + def GetShellItem(self, riid: PyIID, Flags: Any = 0) -> Any: """ Returns a shell interface for the folder @@ -21560,9 +21027,9 @@ Returns: Any """ - pass + ... - def GetPath(self, Flags: 'Any' = 0) -> 'Any': + def GetPath(self, Flags: Any = 0) -> Any: """ Returns the path to the folder @@ -21575,9 +21042,9 @@ Returns: Any """ - pass + ... - def SetPath(self, Flags: 'Any', Path: 'Any') -> 'None': + def SetPath(self, Flags: Any, Path: Any) -> None: """ Changes the location of the folder @@ -21591,9 +21058,9 @@ Returns: None """ - pass + ... - def GetIDList(self, Flags: 'Any') -> 'Any': + def GetIDList(self, Flags: Any) -> Any: """ Returns the folder's location as an item id list. @@ -21606,9 +21073,9 @@ Returns: Any """ - pass + ... - def GetFolderType(self,) -> 'PyIID': + def GetFolderType(self) -> PyIID: """ Returns the type of the folder @@ -21624,9 +21091,9 @@ Return ValueReturns a folder type guid (shell.FOLDERTYPEID_*) """ - pass + ... - def GetRedirectionCapabilities(self,) -> 'Any': + def GetRedirectionCapabilities(self) -> Any: """ Returns flags indicating how the folder can be redirected @@ -21643,9 +21110,9 @@ Return ValueCombination of shellcon.KF_REDIRECTION_CAPABILITIES_* flags """ - pass + ... - def GetFolderDefinition(self,) -> 'Any': + def GetFolderDefinition(self) -> Any: """ Retrieves detailed information about a known folder @@ -21662,16 +21129,16 @@ Return ValueReturns a dict containing info from a KNOWNFOLDER_DEFINITION struct """ - pass + ... -class PyIKnownFolderManager(object): +class PyIKnownFolderManager: """Interface used to manage known folder definitions.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def FolderIdFromCsidl(self, Csidl: 'Any') -> 'PyIID': + def FolderIdFromCsidl(self, Csidl: Any) -> PyIID: """ Returns the folder id that corresponds to a CSIDL @@ -21684,9 +21151,9 @@ Returns: PyIID """ - pass + ... - def FolderIdToCsidl(self, _id: 'PyIID') -> 'Any': + def FolderIdToCsidl(self, _id: PyIID) -> Any: """ Returns the CSIDL equivalent of a known folder @@ -21699,9 +21166,9 @@ Returns: Any """ - pass + ... - def GetFolderIds(self,) -> 'Tuple[PyIID, ...]': + def GetFolderIds(self) -> Tuple[PyIID, ...]: """ Retrieves all known folder ids. @@ -21714,9 +21181,9 @@ Returns: Tuple[PyIID, ...] """ - pass + ... - def GetFolder(self, _id: 'PyIID') -> 'Any': + def GetFolder(self, _id: PyIID) -> Any: """ Returns a folder by its id. @@ -21729,9 +21196,9 @@ Returns: Any """ - pass + ... - def GetFolderByName(self, Name: 'Any') -> 'Any': + def GetFolderByName(self, Name: Any) -> Any: """ Returns a folder by canonical name @@ -21744,9 +21211,9 @@ Returns: Any """ - pass + ... - def RegisterFolder(self, _id: 'PyIID', Definition: 'Any') -> 'None': + def RegisterFolder(self, _id: PyIID, Definition: Any) -> None: """ defines a new known folder @@ -21760,9 +21227,9 @@ Returns: None """ - pass + ... - def UnregisterFolder(self, _id: 'PyIID') -> 'None': + def UnregisterFolder(self, _id: PyIID) -> None: """ Removes the definition of a known folder @@ -21775,9 +21242,9 @@ Returns: None """ - pass + ... - def FindFolderFromPath(self, Path: 'Any', Mode: 'Any') -> 'Any': + def FindFolderFromPath(self, Path: Any, Mode: Any) -> Any: """ Retrieves a known folder by path @@ -21791,9 +21258,9 @@ Returns: Any """ - pass + ... - def FindFolderFromIDList(self, pidl: 'Any') -> 'Any': + def FindFolderFromIDList(self, pidl: Any) -> Any: """ Retrieves a known folder using its item id @@ -21808,15 +21275,15 @@ Returns: Any """ - pass + ... def Redirect( self, - _id: 'PyIID', - hwnd: 'int', - flags: 'Any', - TargetPath: 'Any', - Exclusion: 'Tuple[PyIID, ...]') -> 'None': + _id: PyIID, + hwnd: int, + flags: Any, + TargetPath: Any, + Exclusion: Tuple[PyIID, ...]) -> None: """ Redirects a known folder to an alternate location @@ -21833,16 +21300,16 @@ Returns: None """ - pass + ... -class PyILockBytes(object): +class PyILockBytes: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def ReadAt(self, ulOffset: 'ULARGE_INTEGER', cb: 'Any') -> 'str': + def ReadAt(self, ulOffset: ULARGE_INTEGER, cb: Any) -> str: """ Reads a specified number of bytes starting at a specified offset from the @@ -21858,9 +21325,9 @@ Returns: str """ - pass + ... - def WriteAt(self, ulOffset: 'ULARGE_INTEGER', data: 'str') -> 'Any': + def WriteAt(self, ulOffset: ULARGE_INTEGER, data: str) -> Any: """ Writes the specified number of bytes starting at a specified offset from the @@ -21877,9 +21344,9 @@ Returns: """ - pass + ... - def Flush(self,) -> 'None': + def Flush(self) -> None: """ Ensures that any internal buffers maintained by the byte array object are written out @@ -21894,9 +21361,9 @@ Returns: None """ - pass + ... - def SetSize(self, cb: 'ULARGE_INTEGER') -> 'None': + def SetSize(self, cb: ULARGE_INTEGER) -> None: """ Changes the size of the byte array. @@ -21909,9 +21376,9 @@ Returns: None """ - pass + ... - def LockRegion(self, libOffset: 'ULARGE_INTEGER', cb: 'ULARGE_INTEGER', dwLockType: 'Any') -> 'None': + def LockRegion(self, libOffset: ULARGE_INTEGER, cb: ULARGE_INTEGER, dwLockType: Any) -> None: """ Restricts access to a specified range of bytes in the byte array. @@ -21926,9 +21393,9 @@ Returns: None """ - pass + ... - def UnlockRegion(self, libOffset: 'ULARGE_INTEGER', cb: 'ULARGE_INTEGER', dwLockType: 'Any') -> 'None': + def UnlockRegion(self, libOffset: ULARGE_INTEGER, cb: ULARGE_INTEGER, dwLockType: Any) -> None: """ None @@ -21943,9 +21410,9 @@ Returns: None """ - pass + ... - def Stat(self, grfStatFlag: 'Any') -> 'Any': + def Stat(self, grfStatFlag: Any) -> Any: """ None @@ -21958,16 +21425,15 @@ Returns: Any """ - pass + ... -class PyIMAPIContainer(object): - """""" +class PyIMAPIContainer: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def OpenEntry(self, entryId: 'str', iid: 'PyIID', flags: 'Any') -> 'Any': + def OpenEntry(self, entryId: str, iid: PyIID, flags: Any) -> Any: """ Opens an object and returns an interface object for further access. @@ -21982,9 +21448,9 @@ Returns: Any """ - pass + ... - def GetContentsTable(self, flags: 'Any') -> 'Any': + def GetContentsTable(self, flags: Any) -> Any: """ Returns an object representing the container's contents table. @@ -21997,9 +21463,9 @@ Returns: Any """ - pass + ... - def GetHierarchyTable(self, flags: 'Any') -> 'Any': + def GetHierarchyTable(self, flags: Any) -> Any: """ Returns an object representing the container's hierarchy table. @@ -22012,16 +21478,15 @@ Returns: Any """ - pass + ... -class PyIMAPIFolder(object): - """""" +class PyIMAPIFolder: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetLastError(self, hr: 'Any', flags: 'Any') -> 'Any': + def GetLastError(self, hr: Any, flags: Any) -> Any: """ Returns the last error code for the object. @@ -22035,15 +21500,15 @@ Returns: Any """ - pass + ... def CreateFolder( self, - folderType: 'Any', - folderName: 'str', - folderComment: 'str' = None, - iid: 'PyIID' = None, - flags: 'Any' = 0) -> 'Any': + folderType: Any, + folderName: str, + folderComment: str = None, + iid: PyIID = None, + flags: Any = 0) -> Any: """ Creates a folder object. @@ -22060,9 +21525,9 @@ Returns: Any """ - pass + ... - def CreateMessage(self, iid: 'PyIID', flags: 'Any') -> 'Any': + def CreateMessage(self, iid: PyIID, flags: Any) -> Any: """ Creates a message in a folder @@ -22076,16 +21541,16 @@ Returns: Any """ - pass + ... def CopyMessages( self, - msgs: 'Any', - iid: 'PyIID', - folder: 'Any', - ulUIParam: 'Any', - progress: 'Any', - flags: 'Any') -> 'Any': + msgs: Any, + iid: PyIID, + folder: Any, + ulUIParam: Any, + progress: Any, + flags: Any) -> Any: """ Copies the specified messages @@ -22103,9 +21568,9 @@ Returns: Any """ - pass + ... - def DeleteFolder(self, entryId: 'str', uiParam: 'Any', progress: 'Any') -> 'None': + def DeleteFolder(self, entryId: str, uiParam: Any, progress: Any) -> None: """ Deletes a subfolder. @@ -22120,9 +21585,9 @@ Returns: None """ - pass + ... - def DeleteMessages(self, msgs: 'Any', uiParam: 'Any', progress: 'Any', flags: 'Any') -> 'Any': + def DeleteMessages(self, msgs: Any, uiParam: Any, progress: Any, flags: Any) -> Any: """ Deletes the specified messages. @@ -22138,9 +21603,9 @@ Returns: Any """ - pass + ... - def EmptyFolder(self, uiParam: 'Any', progress: 'Any', flags: 'Any') -> 'Any': + def EmptyFolder(self, uiParam: Any, progress: Any, flags: Any) -> Any: """ deletes all messages and subfolders from a folder without deleting the folder itself. @@ -22155,9 +21620,9 @@ Returns: Any """ - pass + ... - def SetReadFlags(self, msgs: 'Any', uiParam: 'Any', progress: 'Any', flag: 'Any') -> 'None': + def SetReadFlags(self, msgs: Any, uiParam: Any, progress: Any, flag: Any) -> None: """ Sets or clears the MSGFLAG_READ flag in the PR_MESSAGE_FLAGS (PidTagMessageFlags) property of one or more of the folder's messages, and manages the sending of read reports. @@ -22173,16 +21638,15 @@ Returns: None """ - pass + ... -class PyIMAPIProp(object): - """""" +class PyIMAPIProp: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetProps(self, propList: 'Any', flags: 'Any' = 0) -> 'Tuple[Any, Any, Any]': + def GetProps(self, propList: Any, flags: Any = 0) -> Tuple[Any, Any, Any]: """ Returns a list of property values. @@ -22196,9 +21660,9 @@ Returns: Tuple[Any, Any, Any] """ - pass + ... - def DeleteProps(self, propList: 'Any', wantProblems: 'Any' = False) -> 'Tuple[Any, Any, Any]': + def DeleteProps(self, propList: Any, wantProblems: Any = False) -> Tuple[Any, Any, Any]: """ Deletes a set of properties. @@ -22212,9 +21676,9 @@ Returns: Tuple[Any, Any, Any] """ - pass + ... - def SetProps(self, propList: 'Tuple[Any, Any]', wantProblems: 'Any' = False) -> 'Tuple[Any, Any, Any]': + def SetProps(self, propList: Tuple[Any, Any], wantProblems: Any = False) -> Tuple[Any, Any, Any]: """ Sets a set of properties. @@ -22228,18 +21692,18 @@ Returns: Tuple[Any, Any, Any] """ - pass + ... def CopyTo( self, - IIDExcludeList: 'Tuple[Any, Any]', - propTags: 'Any', - uiParam: 'Any', - progress: 'Any', - resultIID: 'PyIID', - dest: 'Any', - flags: 'Any', - wantProblems: 'Any' = False) -> 'Tuple[Any, Any, Any]': + IIDExcludeList: Tuple[Any, Any], + propTags: Any, + uiParam: Any, + progress: Any, + resultIID: PyIID, + dest: Any, + flags: Any, + wantProblems: Any = False) -> Tuple[Any, Any, Any]: """ Copies an object to another @@ -22248,7 +21712,7 @@ Args: IIDExcludeList(Tuple[Any, Any]):A sequence of IIDs to exclude. propTags(Any):The property tags to exclude. uiParam(Any):Handle to the parent window of the progress object - progress(Any):Reserved - must pass None + progress(Any):Reserved - must ... None resultIID(PyIID):IID of the destination object dest(Any):The destination object flags(Any):flags @@ -22259,10 +21723,10 @@ Returns: Tuple[Any, Any, Any] """ - pass + ... - def CopyProps(self, propTags: 'Any', uiParam: 'Any', progress: 'Any', resultIID: 'PyIID', - dest: 'Any', flags: 'Any', wantProblems: 'Any' = False) -> 'Tuple[Any, Any, Any]': + def CopyProps(self, propTags: Any, uiParam: Any, progress: Any, resultIID: PyIID, + dest: Any, flags: Any, wantProblems: Any = False) -> Tuple[Any, Any, Any]: """ Copies a set of properties to another object @@ -22270,7 +21734,7 @@ Args: propTags(Any):The property tags to copy uiParam(Any):Handle to the parent window of the progress object - progress(Any):Reserved - must pass None + progress(Any):Reserved - must ... None resultIID(PyIID):IID of the destination object dest(Any):The destination object flags(Any):flags @@ -22281,9 +21745,9 @@ Returns: Tuple[Any, Any, Any] """ - pass + ... - def OpenProperty(self, propTag: 'Any', iid: 'PyIID', interfaceOptions: 'Any', flags: 'Any') -> 'Any': + def OpenProperty(self, propTag: Any, iid: PyIID, interfaceOptions: Any, flags: Any) -> Any: """ Returns an interface object to be used to access a property. @@ -22299,9 +21763,9 @@ Returns: Any """ - pass + ... - def GetIDsFromNames(self, nameIds: 'Any', flags: 'Any' = 0) -> 'Any': + def GetIDsFromNames(self, nameIds: Any, flags: Any = 0) -> Any: """ Determines property IDs @@ -22315,9 +21779,9 @@ Returns: Any """ - pass + ... - def GetNamesFromIDs(self, propTags: 'Any', propSetGuid: 'PyIID' = None, flags: 'Any' = 0) -> 'Tuple[Any, Any, Any]': + def GetNamesFromIDs(self, propTags: Any, propSetGuid: PyIID = None, flags: Any = 0) -> Tuple[Any, Any, Any]: """ Determines property names @@ -22332,9 +21796,9 @@ Returns: Tuple[Any, Any, Any] """ - pass + ... - def GetLastError(self, hr: 'Any', flags: 'Any') -> 'Any': + def GetLastError(self, hr: Any, flags: Any) -> Any: """ Returns the last error code for the object. @@ -22348,9 +21812,9 @@ Returns: Any """ - pass + ... - def SaveChanges(self, flags: 'Any') -> 'None': + def SaveChanges(self, flags: Any) -> None: """ Saves pending changes to the object @@ -22363,9 +21827,9 @@ Returns: None """ - pass + ... - def GetPropList(self, flags: 'Any') -> 'Any': + def GetPropList(self, flags: Any) -> Any: """ Gets a list of properties @@ -22378,16 +21842,15 @@ Returns: Any """ - pass + ... -class PyIMAPISession(object): - """""" +class PyIMAPISession: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def OpenEntry(self, entryId: 'str', iid: 'PyIID', flags: 'Any') -> 'Any': + def OpenEntry(self, entryId: str, iid: PyIID, flags: Any) -> Any: """ Opens an object and returns an interface object for further access. @@ -22402,9 +21865,9 @@ Returns: Any """ - pass + ... - def OpenMsgStore(self, uiParam: 'Any', entryId: 'str', iid: 'PyIID', flags: 'Any') -> 'Any': + def OpenMsgStore(self, uiParam: Any, entryId: str, iid: PyIID, flags: Any) -> Any: """ Opens a message store. @@ -22420,9 +21883,9 @@ Returns: Any """ - pass + ... - def QueryIdentity(self,) -> 'str': + def QueryIdentity(self) -> str: """ Returns the entry identifier of the object that provides the primary identity for the session. @@ -22435,9 +21898,9 @@ Returns: str """ - pass + ... - def Advise(self, entryId: 'str', mask: 'Any', sink: 'Any') -> 'Any': + def Advise(self, entryId: str, mask: Any, sink: Any) -> Any: """ None @@ -22455,9 +21918,9 @@ PyIMAPISession::Unadvise """ - pass + ... - def Unadvise(self, connection: 'Any') -> 'None': + def Unadvise(self, connection: Any) -> None: """ None @@ -22470,9 +21933,9 @@ Returns: None """ - pass + ... - def CompareEntryIDs(self, entryId: 'str', entryId1: 'str', flags: 'Any' = 0) -> 'Any': + def CompareEntryIDs(self, entryId: str, entryId1: str, flags: Any = 0) -> Any: """ Compares two entry identifiers belonging to a particular address book provider to determine if they refer to the same address book object @@ -22489,9 +21952,9 @@ Return ValueThe result is set to TRUE if the two entry identifiers refer to the """ - pass + ... - def GetLastError(self, hr: 'Any', flags: 'Any') -> 'Any': + def GetLastError(self, hr: Any, flags: Any) -> Any: """ Returns the last error code for the object. @@ -22505,9 +21968,9 @@ Returns: Any """ - pass + ... - def GetMsgStoresTable(self, flags: 'Any') -> 'Any': + def GetMsgStoresTable(self, flags: Any) -> Any: """ Provides access to the message store table - a table with information about all of the message stores in the session profile. @@ -22520,9 +21983,9 @@ Returns: Any """ - pass + ... - def GetStatusTable(self, flags: 'Any') -> 'Any': + def GetStatusTable(self, flags: Any) -> Any: """ Provides access to the status table - a table with information about all of the MAPI resources in the session. @@ -22535,9 +21998,9 @@ Returns: Any """ - pass + ... - def Logoff(self, uiParm: 'Any', flags: 'Any', reserved: 'Any') -> 'None': + def Logoff(self, uiParm: Any, flags: Any, reserved: Any) -> None: """ Ends a MAPI session. @@ -22552,9 +22015,9 @@ Returns: None """ - pass + ... - def OpenAddressBook(self, uiParm: 'Any', iid: 'PyIID', flags: 'Any') -> 'Any': + def OpenAddressBook(self, uiParm: Any, iid: PyIID, flags: Any) -> Any: """ Opens the integrated address book. @@ -22569,9 +22032,9 @@ Returns: Any """ - pass + ... - def OpenProfileSection(self, iidSection: 'PyIID', iid: 'PyIID', flags: 'Any') -> 'Any': + def OpenProfileSection(self, iidSection: PyIID, iid: PyIID, flags: Any) -> Any: """ Opens a section of the current profile and returns an object for futher access @@ -22586,9 +22049,9 @@ Returns: Any """ - pass + ... - def AdminServices(self, flags: 'Any' = 0) -> 'Any': + def AdminServices(self, flags: Any = 0) -> Any: """ Provides access to a message service administration object for making changes to the message services. @@ -22601,23 +22064,22 @@ Returns: Any """ - pass + ... -class PyIMAPIStatus(object): - """""" +class PyIMAPIStatus: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def ChangePassword(self, oldPassword: 'Any', newPassword: 'Any', ulFlags: 'Any') -> 'None': + def Changepassword(self, oldpassword: Any, newpassword: Any, ulFlags: Any) -> None: """ None Args: - oldPassword(Any): - newPassword(Any): + oldpassword(Any): + newpassword(Any): ulFlags(Any): Returns: @@ -22625,9 +22087,9 @@ Returns: None """ - pass + ... - def SettingsDialog(self, ulUIParam: 'Any', ulFlags: 'Any') -> 'None': + def SettingsDialog(self, ulUIParam: Any, ulFlags: Any) -> None: """ None @@ -22641,9 +22103,9 @@ Returns: None """ - pass + ... - def ValidateState(self, ulUIParam: 'Any', ulFlags: 'Any') -> 'None': + def ValidateState(self, ulUIParam: Any, ulFlags: Any) -> None: """ None @@ -22657,9 +22119,9 @@ Returns: None """ - pass + ... - def FlushQueues(self, ulUIParam: 'Any', transport: 'str', ulFlags: 'Any') -> 'None': + def FlushQueues(self, ulUIParam: Any, transport: str, ulFlags: Any) -> None: """ None @@ -22674,16 +22136,15 @@ Returns: None """ - pass + ... -class PyIMAPITable(object): - """""" +class PyIMAPITable: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetLastError(self, hr: 'Any', flags: 'Any') -> 'Any': + def GetLastError(self, hr: Any, flags: Any) -> Any: """ Returns the last error code for the object. @@ -22697,9 +22158,9 @@ Returns: Any """ - pass + ... - def Advise(self, eventMask: 'Any', adviseSink: 'Any') -> 'Any': + def Advise(self, eventMask: Any, adviseSink: Any) -> Any: """ Registers to receive notification of specified events affecting the table. @@ -22713,9 +22174,9 @@ Returns: Any """ - pass + ... - def SeekRow(self, bookmark: 'Any', rowCount: 'Any') -> 'Any': + def SeekRow(self, bookmark: Any, rowCount: Any) -> Any: """ Moves the cursor to a specific position in the table. @@ -22730,9 +22191,9 @@ Returns: """ - pass + ... - def SeekRowApprox(self, numerator: 'Any', denominator: 'Any') -> 'None': + def SeekRowApprox(self, numerator: Any, denominator: Any) -> None: """ Moves the cursor to an approximate fractional position in the table. @@ -22746,9 +22207,9 @@ Returns: None """ - pass + ... - def GetRowCount(self, flags: 'Any') -> 'Any': + def GetRowCount(self, flags: Any) -> Any: """ Returns the total number of rows in the table. @@ -22761,9 +22222,9 @@ Returns: Any """ - pass + ... - def QueryRows(self, rowCount: 'Any', flags: 'Any') -> 'Any': + def QueryRows(self, rowCount: Any, flags: Any) -> Any: """ Returns one or more rows from a table, beginning at the current cursor position. @@ -22777,9 +22238,9 @@ Returns: Any """ - pass + ... - def SetColumns(self, propTags: 'Any', flags: 'Any') -> 'None': + def SetColumns(self, propTags: Any, flags: Any) -> None: """ defines the particular properties and order of properties to appear as columns in the table. @@ -22793,9 +22254,9 @@ Returns: None """ - pass + ... - def GetStatus(self,) -> 'None': + def GetStatus(self) -> None: """ Returns the table's status and type. @@ -22811,9 +22272,9 @@ Return ValueResult is a tuple of (tableStatus, tableType) """ - pass + ... - def QueryPosition(self,) -> 'None': + def QueryPosition(self) -> None: """ Retrieves the current table row position of the cursor, based on a fractional value. @@ -22829,9 +22290,9 @@ Return ValueResult is a tuple of (row, numerator, denominator) """ - pass + ... - def QueryColumns(self, flags: 'Any') -> 'Any': + def QueryColumns(self, flags: Any) -> Any: """ Returns a list of columns for the table. @@ -22844,9 +22305,9 @@ Returns: Any """ - pass + ... - def Abort(self,) -> 'None': + def Abort(self) -> None: """ Stops any asynchronous operations currently in progress for the table. @@ -22859,9 +22320,9 @@ Returns: None """ - pass + ... - def FreeBookmark(self, bookmark: 'Any') -> 'None': + def FreeBookmark(self, bookmark: Any) -> None: """ Releases the memory associated with a bookmark. @@ -22874,9 +22335,9 @@ Returns: None """ - pass + ... - def CreateBookmark(self,) -> 'Any': + def CreateBookmark(self) -> Any: """ Marks the table's current position. @@ -22889,9 +22350,9 @@ Returns: Any """ - pass + ... - def Restrict(self, restriction: 'Any', flags: 'Any') -> 'None': + def Restrict(self, restriction: Any, flags: Any) -> None: """ Applies a filter to a table, reducing the row set to only those rows matching the specified criteria. @@ -22905,9 +22366,9 @@ Returns: None """ - pass + ... - def FindRow(self, restriction: 'Any', bookmarkOrigin: 'Any', flags: 'Any') -> 'None': + def FindRow(self, restriction: Any, bookmarkOrigin: Any, flags: Any) -> None: """ Finds the next row in a table that matches specific search criteria. @@ -22922,9 +22383,9 @@ Returns: None """ - pass + ... - def SortTable(self, sortOrderSet: 'Any', flags: 'Any') -> 'None': + def SortTable(self, sortOrderSet: Any, flags: Any) -> None: """ Orders the rows of the table based on sort criteria. @@ -22938,9 +22399,9 @@ Returns: None """ - pass + ... - def Unadvise(self, handle: 'Any') -> 'None': + def Unadvise(self, handle: Any) -> None: """ Cancels the sending of notifications previously set up with a call to the IMAPITable::Advise method. @@ -22953,16 +22414,16 @@ Returns: None """ - pass + ... -class PyIMachineDebugManager(object): +class PyIMachineDebugManager: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def AddApplication(self, pda: 'Any') -> 'None': + def AddApplication(self, pda: Any) -> None: """ Description of AddApplication. @@ -22975,9 +22436,9 @@ Returns: None """ - pass + ... - def RemoveApplication(self, dwAppCookie: 'Any') -> 'None': + def RemoveApplication(self, dwAppCookie: Any) -> None: """ Description of RemoveApplication. @@ -22990,9 +22451,9 @@ Returns: None """ - pass + ... - def EnumApplications(self,) -> 'None': + def EnumApplications(self) -> None: """ Description of EnumApplications. @@ -23005,16 +22466,16 @@ Returns: None """ - pass + ... -class PyIMachineDebugManagerEvents(object): +class PyIMachineDebugManagerEvents: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def onAddApplication(self, pda: 'Any', dwAppCookie: 'Any') -> 'None': + def onAddApplication(self, pda: Any, dwAppCookie: Any) -> None: """ Description of onAddApplication. @@ -23028,9 +22489,9 @@ Returns: None """ - pass + ... - def onRemoveApplication(self, pda: 'Any', dwAppCookie: 'Any') -> 'None': + def onRemoveApplication(self, pda: Any, dwAppCookie: Any) -> None: """ Description of onRemoveApplication. @@ -23044,16 +22505,15 @@ Returns: None """ - pass + ... -class PyIMessage(object): - """""" +class PyIMessage: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def SetReadFlag(self, flag: 'Any') -> 'None': + def SetReadFlag(self, flag: Any) -> None: """ Sets the read flags for a message @@ -23066,9 +22526,9 @@ Returns: None """ - pass + ... - def GetAttachmentTable(self, flags: 'Any') -> 'Any': + def GetAttachmentTable(self, flags: Any) -> Any: """ Returns the message's attachment table. @@ -23081,9 +22541,9 @@ Returns: Any """ - pass + ... - def OpenAttach(self, attachmentNum: 'Any', interface: 'PyIID', flags: 'Any') -> 'Any': + def OpenAttach(self, attachmentNum: Any, interface: PyIID, flags: Any) -> Any: """ Opens an attachment @@ -23098,9 +22558,9 @@ Returns: Any """ - pass + ... - def CreateAttach(self, interface: 'PyIID', flags: 'Any') -> 'Tuple[Any, Any]': + def CreateAttach(self, interface: PyIID, flags: Any) -> Tuple[Any, Any]: """ Creates an attachment @@ -23115,9 +22575,9 @@ Returns: """ - pass + ... - def DeleteAttach(self, attachmentNum: 'Any', ulUIParam: 'Any', interface: 'Any', flags: 'Any') -> 'None': + def DeleteAttach(self, attachmentNum: Any, ulUIParam: Any, interface: Any, flags: Any) -> None: """ Deletes an attachment @@ -23133,9 +22593,9 @@ Returns: None """ - pass + ... - def ModifyRecipients(self, flags: 'Any', mods: 'Any') -> 'None': + def ModifyRecipients(self, flags: Any, mods: Any) -> None: """ adds, deletes, or modifies message recipients. @@ -23149,9 +22609,9 @@ Returns: None """ - pass + ... - def GetRecipientTable(self, flags: 'Any') -> 'Any': + def GetRecipientTable(self, flags: Any) -> Any: """ Returns the message's recipient table. @@ -23164,9 +22624,9 @@ Returns: Any """ - pass + ... - def SubmitMessage(self, flags: 'Any') -> 'None': + def SubmitMessage(self, flags: Any) -> None: """ Saves all of the message's properties and marks the message as ready to be sent. @@ -23179,16 +22639,16 @@ Returns: None """ - pass + ... -class PyIMoniker(object): +class PyIMoniker: """A Python interface to IMoniker""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def BindToObject(self, bindCtx: 'Any', moniker: 'Any', iidResult: 'Any') -> 'Any': + def BindToObject(self, bindCtx: Any, moniker: Any, iidResult: Any) -> Any: """ Uses the moniker to bind to the object it identifies. @@ -23203,9 +22663,9 @@ Returns: Any """ - pass + ... - def BindToStorage(self, bindCtx: 'Any', moniker: 'Any', iidResult: 'Any') -> 'Any': + def BindToStorage(self, bindCtx: Any, moniker: Any, iidResult: Any) -> Any: """ Retrieves an interface object to the storage that contains the @@ -23222,9 +22682,9 @@ Returns: Any """ - pass + ... - def GetDisplayName(self, bindCtx: 'Any', moniker: 'Any') -> 'str': + def GetDisplayName(self, bindCtx: Any, moniker: Any) -> str: """ Gets the display name , which is a user-readable representation of this @@ -23240,9 +22700,9 @@ Returns: str """ - pass + ... - def ComposeWith(self, mkRight: 'Any', fOnlyIfNotGeneric: 'Any') -> 'Any': + def ComposeWith(self, mkRight: Any, fOnlyIfNotGeneric: Any) -> Any: """ Combines the current moniker with another moniker, creating a new @@ -23258,9 +22718,9 @@ Returns: Any """ - pass + ... - def Enum(self, fForward: 'Any' = True) -> 'Any': + def Enum(self, fForward: Any = True) -> Any: """ Supplies an enumerator that can enumerate the components of a composite @@ -23275,9 +22735,9 @@ Returns: Any """ - pass + ... - def IsEqual(self, other: 'Any') -> 'Any': + def IsEqual(self, other: Any) -> Any: """ Compares this moniker with a specified moniker and indicates whether they are @@ -23292,9 +22752,9 @@ Returns: Any """ - pass + ... - def IsSystemMoniker(self,) -> 'Any': + def IsSystemMoniker(self) -> Any: """ Indicates whether this moniker is of one of the system-supplied moniker @@ -23309,9 +22769,9 @@ Returns: Any """ - pass + ... - def Hash(self,) -> 'Any': + def Hash(self) -> Any: """ Calculates a 32-bit integer using the internal state of the moniker. @@ -23324,16 +22784,15 @@ Returns: Any """ - pass + ... -class PyIMsgServiceAdmin(object): - """""" +class PyIMsgServiceAdmin: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetLastError(self, hr: 'Any', flags: 'Any') -> 'Any': + def GetLastError(self, hr: Any, flags: Any) -> Any: """ Returns the last error code for the object. @@ -23347,9 +22806,9 @@ Returns: Any """ - pass + ... - def CreateMsgService(self, serviceName: 'str', displayName: 'str', flags: 'Any', uiParam: 'Any' = 0) -> 'None': + def CreateMsgService(self, serviceName: str, displayName: str, flags: Any, uiParam: Any = 0) -> None: """ Creates a message service. @@ -23365,9 +22824,9 @@ Returns: None """ - pass + ... - def ConfigureMsgService(self, iid: 'PyIID', ulUIParam: 'Any', ulFlags: 'Any', arg: 'List[Any]') -> 'None': + def ConfigureMsgService(self, iid: PyIID, ulUIParam: Any, ulFlags: Any, arg: List[Any]) -> None: """ Reconfigures a message service. @@ -23383,9 +22842,9 @@ Returns: None """ - pass + ... - def GetMsgServiceTable(self, flags: 'Any') -> 'Any': + def GetMsgServiceTable(self, flags: Any) -> Any: """ Retrieves a table of services. @@ -23398,9 +22857,9 @@ Returns: Any """ - pass + ... - def GetProviderTable(self, flags: 'Any') -> 'Any': + def GetProviderTable(self, flags: Any) -> Any: """ Retrieves a table of service providers. @@ -23413,9 +22872,9 @@ Returns: Any """ - pass + ... - def DeleteMsgService(self, uuid: 'PyIID') -> 'None': + def DeleteMsgService(self, uuid: PyIID) -> None: """ Deletes the specified service @@ -23428,9 +22887,9 @@ Returns: None """ - pass + ... - def RenameMsgService(self, uuid: 'PyIID', flags: 'Any', newName: 'str') -> 'None': + def RenameMsgService(self, uuid: PyIID, flags: Any, newName: str) -> None: """ Renames the specified service @@ -23445,9 +22904,9 @@ Returns: None """ - pass + ... - def OpenProfileSection(self, uuid: 'PyIID', iid: 'PyIID', flags: 'Any') -> 'Any': + def OpenProfileSection(self, uuid: PyIID, iid: PyIID, flags: Any) -> Any: """ Opens a profile section @@ -23462,9 +22921,9 @@ Returns: Any """ - pass + ... - def AdminProviders(self, uuid: 'PyIID', flags: 'Any') -> 'Any': + def AdminProviders(self, uuid: PyIID, flags: Any) -> Any: """ Returns an object providing access @@ -23480,16 +22939,15 @@ Returns: Any """ - pass + ... -class PyIMsgStore(object): - """""" +class PyIMsgStore: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def OpenEntry(self, entryId: 'str', iid: 'PyIID', flags: 'Any') -> 'Any': + def OpenEntry(self, entryId: str, iid: PyIID, flags: Any) -> Any: """ Opens a folder or message and returns an interface object for further access. @@ -23504,9 +22962,9 @@ Returns: Any """ - pass + ... - def GetReceiveFolder(self, messageClass: 'str' = None, flags: 'Any' = 0) -> 'Tuple[PyIID, str]': + def GetReceiveFolder(self, messageClass: str = None, flags: Any = 0) -> Tuple[PyIID, str]: """ Obtains the folder that was established as the destination for incoming messages of a specified message class or the default receive folder for the message store. @@ -23520,9 +22978,9 @@ Returns: Tuple[PyIID, str] """ - pass + ... - def GetReceiveFolderTable(self, flags: 'Any') -> 'Any': + def GetReceiveFolderTable(self, flags: Any) -> Any: """ provides access to the receive folder table, a table that includes information about all of the receive folders for the message store. @@ -23535,9 +22993,9 @@ Returns: Any """ - pass + ... - def CompareEntryIDs(self, entryId: 'str', entryId1: 'str', flags: 'Any' = 0) -> 'Any': + def CompareEntryIDs(self, entryId: str, entryId1: str, flags: Any = 0) -> Any: """ Compares two entry identifiers belonging to a particular address book provider to determine if they refer to the same address book object @@ -23554,9 +23012,9 @@ Return ValueThe result is set to TRUE if the two entry identifiers refer to the """ - pass + ... - def GetLastError(self, hr: 'Any', flags: 'Any') -> 'Any': + def GetLastError(self, hr: Any, flags: Any) -> Any: """ Returns the last error code for the object. @@ -23570,9 +23028,9 @@ Returns: Any """ - pass + ... - def AbortSubmit(self, entryId: 'str', flags: 'Any' = 0) -> 'Any': + def AbortSubmit(self, entryId: str, flags: Any = 0) -> Any: """ Attempts to remove a message from the outgoing queue. @@ -23586,9 +23044,9 @@ Returns: Any """ - pass + ... - def Advise(self, entryId: 'str', eventMask: 'Any', adviseSink: 'Any') -> 'None': + def Advise(self, entryId: str, eventMask: Any, adviseSink: Any) -> None: """ Registers to receive notification of specified events that affect the message store. @@ -23603,9 +23061,9 @@ Returns: None """ - pass + ... - def Unadvise(self, connection: 'Any') -> 'None': + def Unadvise(self, connection: Any) -> None: """ Cancels the sending of notifications previously set up with a call to the IMsgStore::Advise method. @@ -23618,22 +23076,22 @@ Returns: None """ - pass + ... -class PyINameSpaceTreeControl(object): +class PyINameSpaceTreeControl: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Initialize(self, hwndParent: 'Union[Any]', prc: 'Tuple[Any, Any, Any, Any]', nsctsFlags: 'Any') -> 'None': + def Initialize(self, hwndParent: Any, prc: Tuple[Any, Any, Any, Any], nsctsFlags: Any) -> None: """ Description of Initialize. Args: - hwndParent(Union[Any]):Description for hwndParent + hwndParent(Any):Description for hwndParent prc(Tuple[Any, Any, Any, Any]):Description for prc nsctsFlags(Any):Description for nsctsFlags @@ -23642,9 +23100,9 @@ Returns: None """ - pass + ... - def TreeAdvise(self, punk: 'Any') -> 'None': + def TreeAdvise(self, punk: Any) -> None: """ Description of TreeAdvise. @@ -23657,9 +23115,9 @@ Returns: None """ - pass + ... - def TreeUnadvise(self, dwCookie: 'Any') -> 'None': + def TreeUnadvise(self, dwCookie: Any) -> None: """ Description of TreeUnadvise. @@ -23672,9 +23130,9 @@ Returns: None """ - pass + ... - def AppendRoot(self, psiRoot: 'Any', grfEnumFlags: 'Any', grfRootStyle: 'Any', pif: 'Any') -> 'None': + def AppendRoot(self, psiRoot: Any, grfEnumFlags: Any, grfRootStyle: Any, pif: Any) -> None: """ Description of AppendRoot. @@ -23690,9 +23148,9 @@ Returns: None """ - pass + ... - def InsertRoot(self, iIndex: 'Any', psiRoot: 'Any', grfEnumFlags: 'Any', grfRootStyle: 'Any', pif: 'Any') -> 'None': + def InsertRoot(self, iIndex: Any, psiRoot: Any, grfEnumFlags: Any, grfRootStyle: Any, pif: Any) -> None: """ Description of InsertRoot. @@ -23709,9 +23167,9 @@ Returns: None """ - pass + ... - def RemoveRoot(self, psiRoot: 'Any') -> 'None': + def RemoveRoot(self, psiRoot: Any) -> None: """ Description of RemoveRoot. @@ -23724,9 +23182,9 @@ Returns: None """ - pass + ... - def RemoveAllRoots(self,) -> 'None': + def RemoveAllRoots(self) -> None: """ Description of RemoveAllRoots. @@ -23739,9 +23197,9 @@ Returns: None """ - pass + ... - def GetRootItems(self,) -> 'None': + def GetRootItems(self) -> None: """ Description of GetRootItems. @@ -23754,9 +23212,9 @@ Returns: None """ - pass + ... - def SetItemState(self, psi: 'Any', nstcisMask: 'Any', nstcisFlags: 'Any') -> 'None': + def SetItemState(self, psi: Any, nstcisMask: Any, nstcisFlags: Any) -> None: """ Description of SetItemState. @@ -23771,9 +23229,9 @@ Returns: None """ - pass + ... - def GetItemState(self, psi: 'Any', nstcisMask: 'Any') -> 'None': + def GetItemState(self, psi: Any, nstcisMask: Any) -> None: """ Description of GetItemState. @@ -23787,9 +23245,9 @@ Returns: None """ - pass + ... - def GetSelectedItems(self,) -> 'None': + def GetSelectedItems(self) -> None: """ Description of GetSelectedItems. @@ -23802,9 +23260,9 @@ Returns: None """ - pass + ... - def GetItemCustomState(self, psi: 'Any') -> 'None': + def GetItemCustomState(self, psi: Any) -> None: """ Description of GetItemCustomState. @@ -23817,9 +23275,9 @@ Returns: None """ - pass + ... - def SetItemCustomState(self, psi: 'Any', iStateNumber: 'Any') -> 'None': + def SetItemCustomState(self, psi: Any, iStateNumber: Any) -> None: """ Description of SetItemCustomState. @@ -23833,9 +23291,9 @@ Returns: None """ - pass + ... - def EnsureItemVisible(self, psi: 'Any') -> 'None': + def EnsureItemVisible(self, psi: Any) -> None: """ Description of EnsureItemVisible. @@ -23848,9 +23306,9 @@ Returns: None """ - pass + ... - def SetTheme(self, pszTheme: 'Any') -> 'None': + def SetTheme(self, pszTheme: Any) -> None: """ Description of SetTheme. @@ -23863,9 +23321,9 @@ Returns: None """ - pass + ... - def GetNextItem(self, psi: 'Any', nstcgi: 'Any') -> 'None': + def GetNextItem(self, psi: Any, nstcgi: Any) -> None: """ Description of GetNextItem. @@ -23879,9 +23337,9 @@ Returns: None """ - pass + ... - def HitTest(self, pt: 'Tuple[Any, Any]') -> 'None': + def HitTest(self, pt: Tuple[Any, Any]) -> None: """ Description of HitTest. @@ -23894,9 +23352,9 @@ Returns: None """ - pass + ... - def GetItemRect(self,) -> 'None': + def GetItemRect(self) -> None: """ Description of GetItemRect. @@ -23909,9 +23367,9 @@ Returns: None """ - pass + ... - def CollapseAll(self,) -> 'None': + def CollapseAll(self) -> None: """ Description of CollapseAll. @@ -23924,16 +23382,16 @@ Returns: None """ - pass + ... -class PyINamedPropertyStore(object): +class PyINamedPropertyStore: """Contains a collection of properties indentified by name""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetNamedValue(self, Name: 'Any') -> 'Any': + def GetNamedValue(self, Name: Any) -> Any: """ Retrieves a property value by name @@ -23946,9 +23404,9 @@ Returns: Any """ - pass + ... - def SetNamedValue(self, propvar: 'Any') -> 'None': + def SetNamedValue(self, propvar: Any) -> None: """ Sets the value of a property @@ -23961,9 +23419,9 @@ Returns: None """ - pass + ... - def GetNameCount(self,) -> 'Any': + def GetNameCount(self) -> Any: """ Retrieves the number of named properties in the store @@ -23976,9 +23434,9 @@ Returns: Any """ - pass + ... - def GetNameAt(self, Index: 'Any') -> 'Any': + def GetNameAt(self, Index: Any) -> Any: """ Retrieves a property name by zero-based index @@ -23991,16 +23449,16 @@ Returns: Any """ - pass + ... -class PyIObjectArray(object): +class PyIObjectArray: """Holds a collection of interface objects""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetCount(self,) -> 'Any': + def GetCount(self) -> Any: """ Returns number of objects in collection @@ -24013,9 +23471,9 @@ Returns: Any """ - pass + ... - def GetAt(self, Index: 'Any', riid: 'PyIID') -> 'Any': + def GetAt(self, Index: Any, riid: PyIID) -> Any: """ Retrieves an item by zero-based index @@ -24029,16 +23487,16 @@ Returns: Any """ - pass + ... -class PyIObjectCollection(object): +class PyIObjectCollection: """Modifiable container for a number of IUnknown objects""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def AddObject(self, punk: 'Any') -> 'None': + def AddObject(self, punk: Any) -> None: """ Adds a single object to the collection @@ -24051,9 +23509,9 @@ Returns: None """ - pass + ... - def AddFromArray(self, Source: 'Any') -> 'None': + def AddFromArray(self, Source: Any) -> None: """ None @@ -24066,9 +23524,9 @@ Returns: None """ - pass + ... - def RemoveObjectAt(self, Index: 'Any') -> 'None': + def RemoveObjectAt(self, Index: Any) -> None: """ Removes a single object from the collection @@ -24081,9 +23539,9 @@ Returns: None """ - pass + ... - def Clear(self,) -> 'None': + def Clear(self) -> None: """ Empties the container. @@ -24096,16 +23554,16 @@ Returns: None """ - pass + ... -class PyIObjectWithPropertyKey(object): +class PyIObjectWithPropertyKey: """Interface implemented by objects that have an associated property id""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def SetPropertyKey(self, key: 'Any') -> 'None': + def SetPropertyKey(self, key: Any) -> None: """ Sets the property id @@ -24118,9 +23576,9 @@ Returns: None """ - pass + ... - def GetPropertyKey(self,) -> 'Any': + def GetPropertyKey(self) -> Any: """ Returns the property id @@ -24133,16 +23591,16 @@ Returns: Any """ - pass + ... -class PyIObjectWithSite(object): +class PyIObjectWithSite: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def SetSite(self, pUnkSite: 'Any') -> 'None': + def SetSite(self, pUnkSite: Any) -> None: """ Description of SetSite. @@ -24155,9 +23613,9 @@ Returns: None """ - pass + ... - def GetSite(self, riid: 'PyIID') -> 'None': + def GetSite(self, riid: PyIID) -> None: """ Description of GetSite. @@ -24170,16 +23628,16 @@ Returns: None """ - pass + ... -class PyIOleClientSite(object): +class PyIOleClientSite: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def SaveObject(self,) -> 'None': + def SaveObject(self) -> None: """ Description of SaveObject. @@ -24192,9 +23650,9 @@ Returns: None """ - pass + ... - def GetMoniker(self, dwAssign: 'Any', dwWhichMoniker: 'Any') -> 'None': + def GetMoniker(self, dwAssign: Any, dwWhichMoniker: Any) -> None: """ Description of GetMoniker. @@ -24208,9 +23666,9 @@ Returns: None """ - pass + ... - def GetContainer(self,) -> 'None': + def GetContainer(self) -> None: """ Description of GetContainer. @@ -24223,9 +23681,9 @@ Returns: None """ - pass + ... - def ShowObject(self,) -> 'None': + def ShowObject(self) -> None: """ Description of ShowObject. @@ -24238,9 +23696,9 @@ Returns: None """ - pass + ... - def OnShowWindow(self, fShow: 'Any') -> 'None': + def OnShowWindow(self, fShow: Any) -> None: """ Description of OnShowWindow. @@ -24253,9 +23711,9 @@ Returns: None """ - pass + ... - def RequestNewObjectLayout(self,) -> 'None': + def RequestNewObjectLayout(self) -> None: """ Description of RequestNewObjectLayout. @@ -24268,16 +23726,16 @@ Returns: None """ - pass + ... -class PyIOleCommandTarget(object): +class PyIOleCommandTarget: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def QueryStatus(self,) -> 'None': + def QueryStatus(self) -> None: """ Description of QueryStatus. @@ -24290,9 +23748,9 @@ Returns: None """ - pass + ... - def Exec(self,) -> 'None': + def Exec(self) -> None: """ Description of Exec. @@ -24305,16 +23763,16 @@ Returns: None """ - pass + ... -class PyIOleControl(object): +class PyIOleControl: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetControlInfo(self,) -> 'None': + def GetControlInfo(self) -> None: """ Description of GetControlInfo. @@ -24327,9 +23785,9 @@ Returns: None """ - pass + ... - def OnMnemonic(self, msg: 'Any') -> 'None': + def OnMnemonic(self, msg: Any) -> None: """ Description of OnMnemonic. @@ -24342,9 +23800,9 @@ Returns: None """ - pass + ... - def OnAmbientPropertyChange(self, dispID: 'Any') -> 'None': + def OnAmbientPropertyChange(self, dispID: Any) -> None: """ Description of OnAmbientPropertyChange. @@ -24357,9 +23815,9 @@ Returns: None """ - pass + ... - def FreezeEvents(self, bFreeze: 'Any') -> 'None': + def FreezeEvents(self, bFreeze: Any) -> None: """ Description of FreezeEvents. @@ -24372,16 +23830,16 @@ Returns: None """ - pass + ... -class PyIOleControlSite(object): +class PyIOleControlSite: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def OnControlInfoChanged(self,) -> 'None': + def OnControlInfoChanged(self) -> None: """ Description of OnControlInfoChanged. @@ -24394,9 +23852,9 @@ Returns: None """ - pass + ... - def LockInPlaceActive(self, fLock: 'Any') -> 'None': + def LockInPlaceActive(self, fLock: Any) -> None: """ Description of LockInPlaceActive. @@ -24409,9 +23867,9 @@ Returns: None """ - pass + ... - def GetExtendedControl(self,) -> 'None': + def GetExtendedControl(self) -> None: """ Description of GetExtendedControl. @@ -24424,13 +23882,13 @@ Returns: None """ - pass + ... def TransformCoords( self, - PtlHimetric: 'Tuple[Any, Any]', - pPtfContainer: 'Tuple[float, float]', - dwFlags: 'Any') -> 'None': + PtlHimetric: Tuple[Any, Any], + pPtfContainer: Tuple[float, float], + dwFlags: Any) -> None: """ Description of TransformCoords. @@ -24448,9 +23906,9 @@ a tuple of ((int, int), (float, float)) """ - pass + ... - def TranslateAccelerator(self, pMsg: 'PyMSG', grfModifiers: 'Any') -> 'None': + def TranslateAccelerator(self, pMsg: PyMSG, grfModifiers: Any) -> None: """ Description of TranslateAccelerator. @@ -24464,9 +23922,9 @@ Returns: None """ - pass + ... - def OnFocus(self, fGotFocus: 'Any') -> 'None': + def OnFocus(self, fGotFocus: Any) -> None: """ Description of OnFocus. @@ -24479,9 +23937,9 @@ Returns: None """ - pass + ... - def ShowPropertyFrame(self,) -> 'None': + def ShowPropertyFrame(self) -> None: """ Description of ShowPropertyFrame. @@ -24494,16 +23952,16 @@ Returns: None """ - pass + ... -class PyIOleInPlaceActiveObject(object): +class PyIOleInPlaceActiveObject: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def TranslateAccelerator(self, lpmsg: 'PyMSG') -> 'None': + def TranslateAccelerator(self, lpmsg: PyMSG) -> None: """ Description of TranslateAccelerator. @@ -24516,9 +23974,9 @@ Returns: None """ - pass + ... - def OnFrameWindowActivate(self, fActivate: 'Any') -> 'None': + def OnFrameWindowActivate(self, fActivate: Any) -> None: """ Description of OnFrameWindowActivate. @@ -24531,9 +23989,9 @@ Returns: None """ - pass + ... - def OnDocWindowActivate(self, fActivate: 'Any') -> 'None': + def OnDocWindowActivate(self, fActivate: Any) -> None: """ Description of OnDocWindowActivate. @@ -24546,9 +24004,9 @@ Returns: None """ - pass + ... - def ResizeBorder(self, rcBorder: 'Tuple[Any, Any, Any, Any]', pUIWindow: 'Any', fFrameWindow: 'Any') -> 'None': + def ResizeBorder(self, rcBorder: Tuple[Any, Any, Any, Any], pUIWindow: Any, fFrameWindow: Any) -> None: """ Description of ResizeBorder. @@ -24563,9 +24021,9 @@ Returns: None """ - pass + ... - def EnableModeless(self, fEnable: 'Any') -> 'None': + def EnableModeless(self, fEnable: Any) -> None: """ Description of EnableModeless. @@ -24578,22 +24036,22 @@ Returns: None """ - pass + ... -class PyIOleInPlaceFrame(object): +class PyIOleInPlaceFrame: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def InsertMenus(self, hmenuShared: 'Union[Any]', menuWidths: 'Any') -> 'None': + def InsertMenus(self, hmenuShared: Any, menuWidths: Any) -> None: """ Description of InsertMenus. Args: - hmenuShared(Union[Any]):Description for hmenuShared + hmenuShared(Any):Description for hmenuShared menuWidths(Any): Returns: @@ -24601,41 +24059,41 @@ Returns: None """ - pass + ... - def SetMenu(self, hmenuShared: 'Union[Any]', holemenu: 'Union[Any]', hwndActiveObject: 'Union[Any]') -> 'None': + def SetMenu(self, hmenuShared: Any, holemenu: Any, hwndActiveObject: Any) -> None: """ Description of SetMenu. Args: - hmenuShared(Union[Any]):Description for hmenuShared - holemenu(Union[Any]):Description for holemenu - hwndActiveObject(Union[Any]):Description for hwndActiveObject + hmenuShared(Any):Description for hmenuShared + holemenu(Any):Description for holemenu + hwndActiveObject(Any):Description for hwndActiveObject Returns: None """ - pass + ... - def RemoveMenus(self, hmenuShared: 'Union[Any]') -> 'None': + def RemoveMenus(self, hmenuShared: Any) -> None: """ Description of RemoveMenus. Args: - hmenuShared(Union[Any]):Description for hmenuShared + hmenuShared(Any):Description for hmenuShared Returns: None """ - pass + ... - def SetStatusText(self, pszStatusText: 'Any') -> 'None': + def SetStatusText(self, pszStatusText: Any) -> None: """ Description of SetStatusText. @@ -24648,9 +24106,9 @@ Returns: None """ - pass + ... - def EnableModeless(self, fEnable: 'Any') -> 'None': + def EnableModeless(self, fEnable: Any) -> None: """ Description of EnableModeless. @@ -24663,9 +24121,9 @@ Returns: None """ - pass + ... - def TranslateAccelerator(self, lpmsg: 'PyMSG', wID: 'Any') -> 'None': + def TranslateAccelerator(self, lpmsg: PyMSG, wID: Any) -> None: """ Description of TranslateAccelerator. @@ -24679,16 +24137,16 @@ Returns: None """ - pass + ... -class PyIOleInPlaceObject(object): +class PyIOleInPlaceObject: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def InPlaceDeactivate(self,) -> 'None': + def InPlaceDeactivate(self) -> None: """ Description of InPlaceDeactivate. @@ -24701,9 +24159,9 @@ Returns: None """ - pass + ... - def UIDeactivate(self,) -> 'None': + def UIDeactivate(self) -> None: """ Description of UIDeactivate. @@ -24716,9 +24174,9 @@ Returns: None """ - pass + ... - def SetObjectRects(self,) -> 'None': + def SetObjectRects(self) -> None: """ Description of SetObjectRects. @@ -24731,9 +24189,9 @@ Returns: None """ - pass + ... - def ReactivateAndUndo(self,) -> 'None': + def ReactivateAndUndo(self) -> None: """ Description of ReactivateAndUndo. @@ -24746,16 +24204,16 @@ Returns: None """ - pass + ... -class PyIOleInPlaceSite(object): +class PyIOleInPlaceSite: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CanInPlaceActivate(self,) -> 'None': + def CanInPlaceActivate(self) -> None: """ Description of CanInPlaceActivate. @@ -24768,9 +24226,9 @@ Returns: None """ - pass + ... - def OnInPlaceActivate(self,) -> 'None': + def OnInPlaceActivate(self) -> None: """ Description of OnInPlaceActivate. @@ -24783,9 +24241,9 @@ Returns: None """ - pass + ... - def OnUIActivate(self,) -> 'None': + def OnUIActivate(self) -> None: """ Description of OnUIActivate. @@ -24798,9 +24256,9 @@ Returns: None """ - pass + ... - def GetWindowContext(self,) -> 'None': + def GetWindowContext(self) -> None: """ Description of GetWindowContext. @@ -24813,9 +24271,9 @@ Returns: None """ - pass + ... - def Scroll(self,) -> 'None': + def Scroll(self) -> None: """ Description of Scroll. @@ -24828,9 +24286,9 @@ Returns: None """ - pass + ... - def OnUIDeactivate(self, fUndoable: 'Any') -> 'None': + def OnUIDeactivate(self, fUndoable: Any) -> None: """ Description of OnUIDeactivate. @@ -24843,9 +24301,9 @@ Returns: None """ - pass + ... - def OnInPlaceDeactivate(self,) -> 'None': + def OnInPlaceDeactivate(self) -> None: """ Description of OnInPlaceDeactivate. @@ -24858,9 +24316,9 @@ Returns: None """ - pass + ... - def DiscardUndoState(self,) -> 'None': + def DiscardUndoState(self) -> None: """ Description of DiscardUndoState. @@ -24873,9 +24331,9 @@ Returns: None """ - pass + ... - def DeactivateAndUndo(self,) -> 'None': + def DeactivateAndUndo(self) -> None: """ Description of DeactivateAndUndo. @@ -24888,9 +24346,9 @@ Returns: None """ - pass + ... - def OnPosRectChange(self,) -> 'None': + def OnPosRectChange(self) -> None: """ Description of OnPosRectChange. @@ -24903,16 +24361,16 @@ Returns: None """ - pass + ... -class PyIOleInPlaceSiteEx(object): +class PyIOleInPlaceSiteEx: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def OnInPlaceActivateEx(self, dwFlags: 'Any') -> 'None': + def OnInPlaceActivateEx(self, dwFlags: Any) -> None: """ Description of OnInPlaceActivateEx. @@ -24925,9 +24383,9 @@ Returns: None """ - pass + ... - def OnInPlaceDeactivateEx(self, fNoRedraw: 'Any') -> 'None': + def OnInPlaceDeactivateEx(self, fNoRedraw: Any) -> None: """ Description of OnInPlaceDeactivateEx. @@ -24940,9 +24398,9 @@ Returns: None """ - pass + ... - def RequestUIActivate(self,) -> 'None': + def RequestUIActivate(self) -> None: """ Description of RequestUIActivate. @@ -24955,16 +24413,16 @@ Returns: None """ - pass + ... -class PyIOleInPlaceSiteWindowless(object): +class PyIOleInPlaceSiteWindowless: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CanWindowlessActivate(self,) -> 'None': + def CanWindowlessActivate(self) -> None: """ Description of CanWindowlessActivate. @@ -24977,9 +24435,9 @@ Returns: None """ - pass + ... - def GetCapture(self,) -> 'None': + def GetCapture(self) -> None: """ Description of GetCapture. @@ -24992,9 +24450,9 @@ Returns: None """ - pass + ... - def SetCapture(self, fCapture: 'Any') -> 'None': + def SetCapture(self, fCapture: Any) -> None: """ Description of SetCapture. @@ -25007,9 +24465,9 @@ Returns: None """ - pass + ... - def GetFocus(self,) -> 'None': + def GetFocus(self) -> None: """ Description of GetFocus. @@ -25022,9 +24480,9 @@ Returns: None """ - pass + ... - def SetFocus(self, fFocus: 'Any') -> 'None': + def SetFocus(self, fFocus: Any) -> None: """ Description of SetFocus. @@ -25037,9 +24495,9 @@ Returns: None """ - pass + ... - def GetDC(self, grfFlags: 'Any', rect: 'Tuple[Any, Any, Any, Any]') -> 'None': + def GetDC(self, grfFlags: Any, rect: Tuple[Any, Any, Any, Any]) -> None: """ Description of GetDC. @@ -25053,9 +24511,9 @@ Returns: None """ - pass + ... - def ReleaseDC(self, hDC: 'Any') -> 'None': + def ReleaseDC(self, hDC: Any) -> None: """ Description of ReleaseDC. @@ -25068,9 +24526,9 @@ Returns: None """ - pass + ... - def InvalidateRect(self, rect: 'Tuple[Any, Any, Any, Any]', fErase: 'Any') -> 'None': + def InvalidateRect(self, rect: Tuple[Any, Any, Any, Any], fErase: Any) -> None: """ Description of InvalidateRect. @@ -25084,9 +24542,9 @@ Returns: None """ - pass + ... - def InvalidateRgn(self, hRgn: 'Any', fErase: 'Any') -> 'None': + def InvalidateRgn(self, hRgn: Any, fErase: Any) -> None: """ Description of InvalidateRgn. @@ -25100,9 +24558,9 @@ Returns: None """ - pass + ... - def ScrollRect(self, dx: 'Any', dy: 'Any') -> 'None': + def ScrollRect(self, dx: Any, dy: Any) -> None: """ Description of ScrollRect. @@ -25116,9 +24574,9 @@ Returns: None """ - pass + ... - def AdjustRect(self,) -> 'None': + def AdjustRect(self) -> None: """ Description of AdjustRect. @@ -25131,9 +24589,9 @@ Returns: None """ - pass + ... - def OnDefWindowMessage(self, msg: 'Any', wParam: 'Any', lParam: 'Any') -> 'None': + def OnDefWindowMessage(self, msg: Any, wParam: Any, lParam: Any) -> None: """ Description of OnDefWindowMessage. @@ -25148,16 +24606,16 @@ Returns: None """ - pass + ... -class PyIOleInPlaceUIWindow(object): +class PyIOleInPlaceUIWindow: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetBorder(self,) -> 'None': + def GetBorder(self) -> None: """ Description of GetBorder. @@ -25170,9 +24628,9 @@ Returns: None """ - pass + ... - def RequestBorderSpace(self, borderwidths: 'Tuple[Any, Any, Any, Any]') -> 'None': + def RequestBorderSpace(self, borderwidths: Tuple[Any, Any, Any, Any]) -> None: """ Description of RequestBorderSpace. @@ -25185,9 +24643,9 @@ Returns: None """ - pass + ... - def SetBorderSpace(self, borderwidths: 'Tuple[Any, Any, Any, Any]') -> 'None': + def SetBorderSpace(self, borderwidths: Tuple[Any, Any, Any, Any]) -> None: """ Description of SetBorderSpace. @@ -25200,9 +24658,9 @@ Returns: None """ - pass + ... - def SetActiveObject(self, pActiveObject: 'Any', pszObjName: 'Any') -> 'None': + def SetActiveObject(self, pActiveObject: Any, pszObjName: Any) -> None: """ Description of SetActiveObject. @@ -25216,16 +24674,16 @@ Returns: None """ - pass + ... -class PyIOleObject(object): +class PyIOleObject: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def SetClientSite(self, pClientSite: 'Any') -> 'None': + def SetClientSite(self, pClientSite: Any) -> None: """ Description of SetClientSite. @@ -25238,9 +24696,9 @@ Returns: None """ - pass + ... - def GetClientSite(self,) -> 'None': + def GetClientSite(self) -> None: """ Description of GetClientSite. @@ -25253,9 +24711,9 @@ Returns: None """ - pass + ... - def SetHostNames(self, szContainerApp: 'Any', szContainerObj: 'Any') -> 'None': + def SetHostNames(self, szContainerApp: Any, szContainerObj: Any) -> None: """ Description of SetHostNames. @@ -25269,9 +24727,9 @@ Returns: None """ - pass + ... - def Close(self, dwSaveOption: 'Any') -> 'None': + def Close(self, dwSaveOption: Any) -> None: """ Description of Close. @@ -25284,9 +24742,9 @@ Returns: None """ - pass + ... - def SetMoniker(self, dwWhichMoniker: 'Any', pmk: 'Any') -> 'None': + def SetMoniker(self, dwWhichMoniker: Any, pmk: Any) -> None: """ Description of SetMoniker. @@ -25300,9 +24758,9 @@ Returns: None """ - pass + ... - def GetMoniker(self, dwAssign: 'Any', dwWhichMoniker: 'Any') -> 'None': + def GetMoniker(self, dwAssign: Any, dwWhichMoniker: Any) -> None: """ Description of GetMoniker. @@ -25316,9 +24774,9 @@ Returns: None """ - pass + ... - def InitFromData(self, pDataObject: 'Any', fCreation: 'Any', dwReserved: 'Any') -> 'None': + def InitFromData(self, pDataObject: Any, fCreation: Any, dwReserved: Any) -> None: """ Description of InitFromData. @@ -25333,9 +24791,9 @@ Returns: None """ - pass + ... - def GetClipboardData(self, dwReserved: 'Any') -> 'None': + def GetClipboardData(self, dwReserved: Any) -> None: """ Description of GetClipboardData. @@ -25348,10 +24806,10 @@ Returns: None """ - pass + ... - def DoVerb(self, iVerb: 'Any', msg: 'PyMSG', pActiveSite: 'Any', lindex: 'Any', - hwndParent: 'Any', rect: 'Tuple[Any, Any, Any, Any]') -> 'None': + def DoVerb(self, iVerb: Any, msg: PyMSG, pActiveSite: Any, lindex: Any, + hwndParent: Any, rect: Tuple[Any, Any, Any, Any]) -> None: """ Description of DoVerb. @@ -25369,9 +24827,9 @@ Returns: None """ - pass + ... - def EnumVerbs(self,) -> 'None': + def EnumVerbs(self) -> None: """ Description of EnumVerbs. @@ -25384,9 +24842,9 @@ Returns: None """ - pass + ... - def Update(self,) -> 'None': + def Update(self) -> None: """ Description of Update. @@ -25399,9 +24857,9 @@ Returns: None """ - pass + ... - def IsUpToDate(self,) -> 'None': + def IsUpToDate(self) -> None: """ Description of IsUpToDate. @@ -25414,9 +24872,9 @@ Returns: None """ - pass + ... - def GetUserClassID(self,) -> 'None': + def GetUserClassID(self) -> None: """ Description of GetUserClassID. @@ -25429,9 +24887,9 @@ Returns: None """ - pass + ... - def GetUserType(self, dwFormOfType: 'Any') -> 'None': + def GetUserType(self, dwFormOfType: Any) -> None: """ Description of GetUserType. @@ -25444,9 +24902,9 @@ Returns: None """ - pass + ... - def SetExtent(self, dwDrawAspect: 'Any', size: 'Tuple[Any, Any]') -> 'None': + def SetExtent(self, dwDrawAspect: Any, size: Tuple[Any, Any]) -> None: """ Description of SetExtent. @@ -25460,9 +24918,9 @@ Returns: None """ - pass + ... - def GetExtent(self, dwDrawAspect: 'Any', size: 'Tuple[Any, Any]') -> 'None': + def GetExtent(self, dwDrawAspect: Any, size: Tuple[Any, Any]) -> None: """ Description of GetExtent. @@ -25476,9 +24934,9 @@ Returns: None """ - pass + ... - def Advise(self, pAdvSink: 'Any') -> 'None': + def Advise(self, pAdvSink: Any) -> None: """ Description of Advise. @@ -25491,9 +24949,9 @@ Returns: None """ - pass + ... - def Unadvise(self, dwConnection: 'Any') -> 'None': + def Unadvise(self, dwConnection: Any) -> None: """ Description of Unadvise. @@ -25506,9 +24964,9 @@ Returns: None """ - pass + ... - def EnumAdvise(self,) -> 'None': + def EnumAdvise(self) -> None: """ Description of EnumAdvise. @@ -25521,9 +24979,9 @@ Returns: None """ - pass + ... - def GetMiscStatus(self, dwAspect: 'Any') -> 'None': + def GetMiscStatus(self, dwAspect: Any) -> None: """ Description of GetMiscStatus. @@ -25536,9 +24994,9 @@ Returns: None """ - pass + ... - def SetColorScheme(self,) -> 'None': + def SetColorScheme(self) -> None: """ Description of SetColorScheme. @@ -25551,16 +25009,16 @@ Returns: None """ - pass + ... -class PyIOleWindow(object): +class PyIOleWindow: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetWindow(self,) -> 'None': + def GetWindow(self) -> None: """ Description of GetWindow. @@ -25573,9 +25031,9 @@ Returns: None """ - pass + ... - def ContextSensitiveHelp(self, fEnterMode: 'Any') -> 'None': + def ContextSensitiveHelp(self, fEnterMode: Any) -> None: """ Description of ContextSensitiveHelp. @@ -25588,16 +25046,16 @@ Returns: None """ - pass + ... -class PyIPersist(object): +class PyIPersist: """A Python interface to IPersist""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetClassID(self,) -> 'PyIID': + def GetClassID(self) -> PyIID: """ Returns the class identifier (CLSID) for the component object. @@ -25610,16 +25068,16 @@ Returns: PyIID """ - pass + ... -class PyIPersistFile(object): +class PyIPersistFile: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def IsDirty(self,) -> 'None': + def IsDirty(self) -> None: """ Checks an object for changes since it was last saved to its current file. @@ -25639,9 +25097,9 @@ Unless this method explicitly returns S_FALSE, assume that the object must be sa """ - pass + ... - def Load(self, FileName: 'Any', Mode: 'Any') -> 'None': + def Load(self, FileName: Any, Mode: Any) -> None: """ Opens the specified file and initializes an object from the file contents. @@ -25655,9 +25113,9 @@ Returns: None """ - pass + ... - def Save(self, FileName: 'Any', fRemember: 'Any') -> 'None': + def Save(self, FileName: Any, fRemember: Any) -> None: """ Saves the object into the specified file. @@ -25671,9 +25129,9 @@ Returns: None """ - pass + ... - def SaveCompleted(self, FileName: 'Any') -> 'None': + def SaveCompleted(self, FileName: Any) -> None: """ Notifies the object that it can revert from NoScribble mode to Normal mode. @@ -25686,9 +25144,9 @@ Returns: None """ - pass + ... - def GetCurFile(self,) -> 'Any': + def GetCurFile(self) -> Any: """ Gets the current name of the file associated with the object. @@ -25701,16 +25159,16 @@ Returns: Any """ - pass + ... -class PyIPersistFolder(object): +class PyIPersistFolder: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Initialize(self, pidl: 'Any') -> 'None': + def Initialize(self, pidl: Any) -> None: """ Description of Initialize. @@ -25723,16 +25181,16 @@ Returns: None """ - pass + ... -class PyIPersistFolder2(object): +class PyIPersistFolder2: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetCurFolder(self,) -> 'None': + def GetCurFolder(self) -> None: """ Description of GetCurFolder. @@ -25745,16 +25203,16 @@ Returns: None """ - pass + ... -class PyIPersistPropertyBag(object): +class PyIPersistPropertyBag: """A Python wrapper for a COM IPersistPropertyBag interface.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def InitNew(self,) -> 'None': + def InitNew(self) -> None: """ Called by the container when the control is initialized to initialize the @@ -25769,9 +25227,9 @@ Returns: None """ - pass + ... - def Load(self, bag: 'Any', log: 'Any' = None) -> 'None': + def Load(self, bag: Any, log: Any = None) -> None: """ Called by the container to load the control's properties. @@ -25785,9 +25243,9 @@ Returns: None """ - pass + ... - def Save(self, bag: 'Any', clearDirty: 'Any', saveProperties: 'Any') -> 'None': + def Save(self, bag: Any, clearDirty: Any, saveProperties: Any) -> None: """ Called by the container to save the object's properties. @@ -25802,16 +25260,15 @@ Returns: None """ - pass + ... -class PyIPersistSerializedPropStorage(object): - """""" +class PyIPersistSerializedPropStorage: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def SetFlags(self, flags: 'Any') -> 'None': + def SetFlags(self, flags: Any) -> None: """ Sets flags for the store @@ -25824,9 +25281,9 @@ Returns: None """ - pass + ... - def SetPropertyStorage(self, ps: 'Any') -> 'None': + def SetPropertyStorage(self, ps: Any) -> None: """ Initializes the store with a serialized buffer @@ -25839,9 +25296,9 @@ Returns: None """ - pass + ... - def GetPropertyStorage(self,) -> 'Any': + def GetPropertyStorage(self) -> Any: """ Retrieves the current contents of the property @@ -25856,16 +25313,16 @@ Returns: Any """ - pass + ... -class PyIPersistStorage(object): +class PyIPersistStorage: """A Python wrapper of a COM IPersistStorage interface.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def IsDirty(self,) -> 'Any': + def IsDirty(self) -> Any: """ Checks the object for changes since it was last saved. @@ -25878,9 +25335,9 @@ Returns: Any """ - pass + ... - def InitNew(self, PyIStorage: 'Any') -> 'None': + def InitNew(self, PyIStorage: Any) -> None: """ Initializes a new object, providing a storage object to be used for the object. @@ -25893,9 +25350,9 @@ Returns: None """ - pass + ... - def Load(self, storage: 'Any') -> 'None': + def Load(self, storage: Any) -> None: """ Loads an object from its existing storage. @@ -25908,9 +25365,9 @@ Returns: None """ - pass + ... - def Save(self, PyIStorage: 'Any', _int: 'Any') -> 'None': + def Save(self, PyIStorage: Any, _int: Any) -> None: """ None @@ -25924,9 +25381,9 @@ Returns: None """ - pass + ... - def SaveCompleted(self, PyIStorage: 'Any') -> 'None': + def SaveCompleted(self, PyIStorage: Any) -> None: """ None @@ -25939,9 +25396,9 @@ Returns: None """ - pass + ... - def HandsOffStorage(self,) -> 'None': + def HandsOffStorage(self) -> None: """ Instructs the object to release all storage objects that have been @@ -25958,16 +25415,16 @@ Returns: None """ - pass + ... -class PyIPersistStream(object): +class PyIPersistStream: """A Python interface to IPersistStream""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def IsDirty(self,) -> 'Any': + def IsDirty(self) -> Any: """ Checks the object for changes since it was last saved. @@ -25980,9 +25437,9 @@ Returns: Any """ - pass + ... - def Load(self, stream: 'Any') -> 'None': + def Load(self, stream: Any) -> None: """ Initializes an object from the stream where it was previously saved. @@ -25995,9 +25452,9 @@ Returns: None """ - pass + ... - def Save(self, stream: 'Any', bClearDirty: 'Any') -> 'None': + def Save(self, stream: Any, bClearDirty: Any) -> None: """ Saves an object to the specified stream. @@ -26011,9 +25468,9 @@ Returns: None """ - pass + ... - def GetSizeMax(self,) -> 'ULARGE_INTEGER': + def GetSizeMax(self) -> ULARGE_INTEGER: """ Returns the size in bytes of the stream needed to save the @@ -26028,16 +25485,16 @@ Returns: ULARGE_INTEGER """ - pass + ... -class PyIPersistStreamInit(object): +class PyIPersistStreamInit: """A Python interface to IPersistStreamInit""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def InitNew(self,) -> 'None': + def InitNew(self) -> None: """ Initializes the object to a default state. @@ -26050,16 +25507,16 @@ Returns: None """ - pass + ... -class PyIProcessDebugManager(object): +class PyIProcessDebugManager: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CreateApplication(self,) -> 'None': + def CreateApplication(self) -> None: """ Description of CreateApplication. @@ -26072,9 +25529,9 @@ Returns: None """ - pass + ... - def GetDefaultApplication(self,) -> 'None': + def GetDefaultApplication(self) -> None: """ Description of GetDefaultApplication. @@ -26087,9 +25544,9 @@ Returns: None """ - pass + ... - def AddApplication(self, pda: 'Any') -> 'None': + def AddApplication(self, pda: Any) -> None: """ Description of AddApplication. @@ -26102,9 +25559,9 @@ Returns: None """ - pass + ... - def RemoveApplication(self, dwAppCookie: 'Any') -> 'None': + def RemoveApplication(self, dwAppCookie: Any) -> None: """ Description of RemoveApplication. @@ -26117,9 +25574,9 @@ Returns: None """ - pass + ... - def CreateDebugDocumentHelper(self, unkOuter: 'Any') -> 'None': + def CreateDebugDocumentHelper(self, unkOuter: Any) -> None: """ Description of CreateDebugDocumentHelper. @@ -26132,16 +25589,15 @@ Returns: None """ - pass + ... -class PyIProfAdmin(object): - """""" +class PyIProfAdmin: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetLastError(self, hr: 'Any', flags: 'Any') -> 'Any': + def GetLastError(self, hr: Any, flags: Any) -> Any: """ Returns the last error code for the object. @@ -26155,16 +25611,16 @@ Returns: Any """ - pass + ... - def CreateProfile(self, oldProfileName: 'str', Password: 'str', uiParam: 'Any' = 0, flags: 'Any' = 0) -> 'None': + def CreateProfile(self, oldProfileName: str, password: str, uiParam: Any = 0, flags: Any = 0) -> None: """ Creates a new profile. Args: oldProfileName(str):The name of the new profile. - Password(str):Must be None + password(str):Must be None uiParam(Any):A handle of the parent window for any dialog boxes or windows that this method displays. flags(Any): @@ -26173,9 +25629,9 @@ Returns: None """ - pass + ... - def DeleteProfile(self, oldProfileName: 'str', flags: 'Any' = 0) -> 'None': + def DeleteProfile(self, oldProfileName: str, flags: Any = 0) -> None: """ Deletes a profile. @@ -26189,22 +25645,22 @@ Returns: None """ - pass + ... def CopyProfile( self, - oldProfileName: 'str', - Password: 'str', - newProfileName: 'str', - uiParam: 'Any' = 0, - flags: 'Any' = 0) -> 'None': + oldProfileName: str, + password: str, + newProfileName: str, + uiParam: Any = 0, + flags: Any = 0) -> None: """ Copies a profile. Args: oldProfileName(str):The name of the profile to copy. - Password(str):Must be None + password(str):Must be None newProfileName(str):The new name of the copied profile. uiParam(Any):A handle of the parent window for any dialog boxes or windows that this method displays. flags(Any): @@ -26214,22 +25670,22 @@ Returns: None """ - pass + ... def RenameProfile( self, - oldProfileName: 'str', - Password: 'str', - newProfileName: 'str', - uiParam: 'Any' = 0, - flags: 'Any' = 0) -> 'None': + oldProfileName: str, + password: str, + newProfileName: str, + uiParam: Any = 0, + flags: Any = 0) -> None: """ Assigns a new name to a profile. Args: oldProfileName(str):The current name of the profile to rename. - Password(str):Must be None + password(str):Must be None newProfileName(str):The new name of the profile to rename. uiParam(Any):A handle of the parent window for any dialog boxes or windows that this method displays. flags(Any): @@ -26239,9 +25695,9 @@ Returns: None """ - pass + ... - def SetDefaultProfile(self, profileName: 'str', flags: 'Any' = 0) -> 'None': + def SetDefaultProfile(self, profileName: str, flags: Any = 0) -> None: """ Sets or clears a client's default profile. @@ -26255,16 +25711,16 @@ Returns: None """ - pass + ... - def AdminServices(self, profileName: 'str', Password: 'str' = None, uiParam: 'Any' = 0, flags: 'Any' = 0) -> 'Any': + def AdminServices(self, profileName: str, password: str = None, uiParam: Any = 0, flags: Any = 0) -> Any: """ Provides access to a message service administration object for making changes to the message services in a profile. Args: profileName(str):The name of the profile to be modified. - Password(str): + password(str): uiParam(Any):A handle of the parent window for any dialog boxes or windows that this method displays. flags(Any): @@ -26273,16 +25729,16 @@ Returns: Any """ - pass + ... -class PyIPropertyBag(object): +class PyIPropertyBag: """A Python wrapper for a COM IPropertyBag interface.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Read(self, propName: 'Any', propType: 'Any', errorLog: 'Any' = None) -> 'Any': + def Read(self, propName: Any, propType: Any, errorLog: Any = None) -> Any: """ Called by the control to read a property from the storage provided by the @@ -26299,9 +25755,9 @@ Returns: Any """ - pass + ... - def Write(self, propName: 'Any', value: 'Any') -> 'None': + def Write(self, propName: Any, value: Any) -> None: """ Called by the control to write each property in turn to the storage provided by the @@ -26317,16 +25773,16 @@ Returns: None """ - pass + ... -class PyIPropertyChange(object): +class PyIPropertyChange: """Interface used to specify a change to a property""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def ApplyToPropVariant(self, OrigVal: 'Any') -> 'Any': + def ApplyToPropVariant(self, OrigVal: Any) -> Any: """ Applies the change to a variant value @@ -26339,16 +25795,15 @@ Returns: Any """ - pass + ... -class PyIPropertyChangeArray(object): - """""" +class PyIPropertyChangeArray: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetCount(self,) -> 'Any': + def GetCount(self) -> Any: """ Returns the number of changes in the array @@ -26361,9 +25816,9 @@ Returns: Any """ - pass + ... - def GetAt(self, Index: 'Any', riid: 'PyIID') -> 'Any': + def GetAt(self, Index: Any, riid: PyIID) -> Any: """ Retrieves a change by zero-based index @@ -26377,9 +25832,9 @@ Returns: Any """ - pass + ... - def InsertAt(self, Index: 'Any', PropChange: 'Any') -> 'None': + def InsertAt(self, Index: Any, PropChange: Any) -> None: """ Inserts a change at a specific position @@ -26393,9 +25848,9 @@ Returns: None """ - pass + ... - def Append(self, PropChange: 'Any') -> 'None': + def Append(self, PropChange: Any) -> None: """ Adds a change to the end of the array @@ -26408,9 +25863,9 @@ Returns: None """ - pass + ... - def AppendOrReplace(self, PropChange: 'Any') -> 'None': + def AppendOrReplace(self, PropChange: Any) -> None: """ Adds a change, or replaces if an identical property key is already @@ -26425,9 +25880,9 @@ Returns: None """ - pass + ... - def RemoveAt(self, Index: 'Any') -> 'None': + def RemoveAt(self, Index: Any) -> None: """ Removes a change from the array @@ -26440,9 +25895,9 @@ Returns: None """ - pass + ... - def IsKeyInArray(self, key: 'Any') -> 'Any': + def IsKeyInArray(self, key: Any) -> Any: """ Checks if array contains a change to a property @@ -26455,16 +25910,16 @@ Returns: Any """ - pass + ... -class PyIPropertyDescription(object): +class PyIPropertyDescription: """Gives access to the details of a property definition""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetPropertyKey(self,) -> 'Any': + def GetPropertyKey(self) -> Any: """ Returns the unique identifier for a property @@ -26477,9 +25932,9 @@ Returns: Any """ - pass + ... - def GetCanonicalName(self,) -> 'Any': + def GetCanonicalName(self) -> Any: """ Returns the name of the property @@ -26492,9 +25947,9 @@ Returns: Any """ - pass + ... - def GetPropertyType(self,) -> 'Any': + def GetPropertyType(self) -> Any: """ Returns the variant type of the property (VT_*) @@ -26507,9 +25962,9 @@ Returns: Any """ - pass + ... - def GetDisplayName(self,) -> 'Any': + def GetDisplayName(self) -> Any: """ Returns the property name as shown in the UI @@ -26522,9 +25977,9 @@ Returns: Any """ - pass + ... - def GetEditInvitation(self,) -> 'Any': + def GetEditInvitation(self) -> Any: """ Returns the input prompt used in edit controls @@ -26537,9 +25992,9 @@ Returns: Any """ - pass + ... - def GetTypeFlags(self, mask: 'Any') -> 'Any': + def GetTypeFlags(self, mask: Any) -> Any: """ Returns type flags for the property @@ -26552,9 +26007,9 @@ Returns: Any """ - pass + ... - def GetViewFlags(self,) -> 'Any': + def GetViewFlags(self) -> Any: """ Returns the view flags that control how the property is displayed @@ -26569,9 +26024,9 @@ Returns: Any """ - pass + ... - def GetDefaultColumnWidth(self,) -> 'Any': + def GetDefaultColumnWidth(self) -> Any: """ Returns the default width in characters @@ -26584,9 +26039,9 @@ Returns: Any """ - pass + ... - def GetDisplayType(self,) -> 'Any': + def GetDisplayType(self) -> Any: """ Returns the display type (PDDT_*) @@ -26599,9 +26054,9 @@ Returns: Any """ - pass + ... - def GetColumnState(self,) -> 'Any': + def GetColumnState(self) -> Any: """ Returns flags that control how property is displayed in column @@ -26616,9 +26071,9 @@ Returns: Any """ - pass + ... - def GetGroupingRange(self,) -> 'Any': + def GetGroupingRange(self) -> Any: """ Returns property's grouping attributes (PDGR_*) @@ -26631,9 +26086,9 @@ Returns: Any """ - pass + ... - def GetRelativeDescriptionType(self,) -> 'Any': + def GetRelativeDescriptionType(self) -> Any: """ Returns the relative description type (PDRDT_*) @@ -26646,9 +26101,9 @@ Returns: Any """ - pass + ... - def GetRelativeDescription(self, var1: 'Any', var2: 'Any') -> 'Tuple[Any, Any]': + def GetRelativeDescription(self, var1: Any, var2: Any) -> Tuple[Any, Any]: """ Compares two values @@ -26662,9 +26117,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def GetSortDescription(self,) -> 'Any': + def GetSortDescription(self) -> Any: """ Returns value that determines how sorting options are @@ -26679,9 +26134,9 @@ Returns: Any """ - pass + ... - def GetSortDescriptionLabel(self, Descending: 'Any') -> 'Any': + def GetSortDescriptionLabel(self, Descending: Any) -> Any: """ Returns description of current sort order @@ -26694,9 +26149,9 @@ Returns: Any """ - pass + ... - def GetAggregationType(self,) -> 'Any': + def GetAggregationType(self) -> Any: """ Describes how properties for multiple items are displayed @@ -26711,9 +26166,9 @@ Returns: Any """ - pass + ... - def GetConditionType(self,) -> 'Tuple[Any, Any]': + def GetConditionType(self) -> Tuple[Any, Any]: """ Returns options that determine how the property is used @@ -26734,9 +26189,9 @@ Return ValueReturns the condition type (PDCOT_*) and default operation (COP_*) """ - pass + ... - def GetEnumTypeList(self, riid: 'PyIID') -> 'Any': + def GetEnumTypeList(self, riid: PyIID) -> Any: """ Returns an interface used for querying @@ -26751,9 +26206,9 @@ Returns: Any """ - pass + ... - def CoerceToCanonicalValue(self, Value: 'Any') -> 'Any': + def CoerceToCanonicalValue(self, Value: Any) -> Any: """ Converts a variant value to the exact type expected by @@ -26772,9 +26227,9 @@ Return ValueReturns the HRESULT from the operation on success. """ - pass + ... - def FormatForDisplay(self, Value: 'Any', Flags: 'Any') -> 'Any': + def FormatForDisplay(self, Value: Any, Flags: Any) -> Any: """ Converts a value to its string representation @@ -26788,9 +26243,9 @@ Returns: Any """ - pass + ... - def IsValueCanonical(self, Value: 'Any') -> 'Any': + def IsValueCanonical(self, Value: Any) -> Any: """ Determines if a value exactly matches the specification for @@ -26805,16 +26260,16 @@ Returns: Any """ - pass + ... -class PyIPropertyDescriptionAliasInfo(object): +class PyIPropertyDescriptionAliasInfo: """Interface that gives access to the sorting columns for a property""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetSortByAlias(self, riid: 'PyIID') -> 'Any': + def GetSortByAlias(self, riid: PyIID) -> Any: """ Returns the primary column used @@ -26829,9 +26284,9 @@ Returns: Any """ - pass + ... - def GetAdditionalSortByAliases(self, riid: 'PyIID') -> 'Any': + def GetAdditionalSortByAliases(self, riid: PyIID) -> Any: """ Returns secondary @@ -26846,16 +26301,16 @@ Returns: Any """ - pass + ... -class PyIPropertyDescriptionList(object): +class PyIPropertyDescriptionList: """Container for a number of property descriptions""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetCount(self,) -> 'Any': + def GetCount(self) -> Any: """ Gets the number of properties in the list @@ -26868,9 +26323,9 @@ Returns: Any """ - pass + ... - def GetAt(self, Elem: 'Any', riid: 'PyIID') -> 'Any': + def GetAt(self, Elem: Any, riid: PyIID) -> Any: """ Retrieves a description from the list @@ -26884,16 +26339,15 @@ Returns: Any """ - pass + ... -class PyIPropertyDescriptionSearchInfo(object): - """""" +class PyIPropertyDescriptionSearchInfo: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetSearchInfoFlags(self,) -> 'Any': + def GetSearchInfoFlags(self) -> Any: """ Returns flags controlling how property is indexed @@ -26910,9 +26364,9 @@ Return ValueReturns a combination of PROPDESC_SEARCHINFO_FLAGS values """ - pass + ... - def GetColumnIndexType(self,) -> 'Any': + def GetColumnIndexType(self) -> Any: """ Returns flags indicating type of property @@ -26929,9 +26383,9 @@ Return ValueReturns a value from the PROPDESC_COLUMNINDEX_TYPE enum """ - pass + ... - def GetProjectionString(self,) -> 'Any': + def GetProjectionString(self) -> Any: """ Returns the canonical name of the property @@ -26944,9 +26398,9 @@ Returns: Any """ - pass + ... - def GetMaxSize(self,) -> 'Any': + def GetMaxSize(self) -> Any: """ Returns the maximum size specified in search options @@ -26959,16 +26413,16 @@ Returns: Any """ - pass + ... -class PyIPropertyEnumType(object): +class PyIPropertyEnumType: """Contains information about an allowable value or range for a property""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetEnumType(self,) -> 'Any': + def GetEnumType(self) -> Any: """ Retrieves the type (PROPENUMTYPE) @@ -26985,9 +26439,9 @@ Return Valuepscon.PET_* """ - pass + ... - def GetValue(self,) -> 'Any': + def GetValue(self) -> Any: """ Retrieves the defined value @@ -27000,9 +26454,9 @@ Returns: Any """ - pass + ... - def GetRangeMinValue(self,) -> 'Any': + def GetRangeMinValue(self) -> Any: """ Returns the minimum allowed value for the property @@ -27015,9 +26469,9 @@ Returns: Any """ - pass + ... - def GetRangeSetValue(self,) -> 'Any': + def GetRangeSetValue(self) -> Any: """ Returns a fixed value defined for the property @@ -27030,9 +26484,9 @@ Returns: Any """ - pass + ... - def GetDisplayText(self,) -> 'None': + def GetDisplayText(self) -> None: """ Returns the display text for the enumerated type @@ -27045,16 +26499,15 @@ Returns: None """ - pass + ... -class PyIPropertyEnumTypeList(object): - """""" +class PyIPropertyEnumTypeList: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetCount(self,) -> 'Any': + def GetCount(self) -> Any: """ Returns the number of objects in the list @@ -27067,9 +26520,9 @@ Returns: Any """ - pass + ... - def GetAt(self, itype: 'Any', riid: 'PyIID') -> 'Any': + def GetAt(self, itype: Any, riid: PyIID) -> Any: """ Retrieves an item by index @@ -27083,9 +26536,9 @@ Returns: Any """ - pass + ... - def FindMatchingIndex(self, Cmp: 'Any') -> 'Any': + def FindMatchingIndex(self, Cmp: Any) -> Any: """ Attempts to match the specified value to one of the allowable @@ -27100,10 +26553,10 @@ Returns: Any """ - pass + ... -class PyIPropertySetStorage(object): +class PyIPropertySetStorage: """Container for a collection of property sets. Can be iterated over to enumerate property sets.""" @@ -27111,7 +26564,7 @@ Can be iterated over to enumerate property sets.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Create(self, fmtid: 'PyIID', clsid: 'PyIID', Flags: 'Any', Mode: 'Any') -> 'Any': + def Create(self, fmtid: PyIID, clsid: PyIID, Flags: Any, Mode: Any) -> Any: """ Creates a new property set in the storage object @@ -27127,9 +26580,9 @@ Returns: Any """ - pass + ... - def Open(self, fmtid: 'PyIID', Mode: 'Any') -> 'Any': + def Open(self, fmtid: PyIID, Mode: Any) -> Any: """ Opens an existing property set @@ -27143,9 +26596,9 @@ Returns: Any """ - pass + ... - def Delete(self, fmtid: 'PyIID') -> 'None': + def Delete(self, fmtid: PyIID) -> None: """ Removes a property set from this storage object @@ -27158,9 +26611,9 @@ Returns: None """ - pass + ... - def Enum(self,) -> 'Any': + def Enum(self) -> Any: """ Creates an iterator to enumerate contained property @@ -27175,10 +26628,10 @@ Returns: Any """ - pass + ... -class PyIPropertyStorage(object): +class PyIPropertyStorage: """Structured storage object that contains a set of properties. Supports iteration to list properties.""" @@ -27186,7 +26639,7 @@ Supports iteration to list properties.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def ReadMultiple(self, props: 'Tuple[Any, ...]') -> 'Tuple[Any, ...]': + def ReadMultiple(self, props: Tuple[Any, ...]) -> Tuple[Any, ...]: """ Reads specified properties from the current property set. @@ -27200,9 +26653,9 @@ Returns: """ - pass + ... - def WriteMultiple(self, props: 'Tuple[Any, ...]', values: 'Tuple[Any, ...]', propidNameFirst: 'Any' = 2) -> 'None': + def WriteMultiple(self, props: Tuple[Any, ...], values: Tuple[Any, ...], propidNameFirst: Any = 2) -> None: """ Creates or modifies properties in the property set @@ -27217,9 +26670,9 @@ Returns: None """ - pass + ... - def DeleteMultiple(self, props: 'Tuple[Any, ...]') -> 'None': + def DeleteMultiple(self, props: Tuple[Any, ...]) -> None: """ Deletes properties from the property set @@ -27232,9 +26685,9 @@ Returns: None """ - pass + ... - def ReadPropertyNames(self, props: 'Tuple[Any, ...]') -> 'Tuple[Any, ...]': + def ReadPropertyNames(self, props: Tuple[Any, ...]) -> Tuple[Any, ...]: """ Retrieves any existing string names for the specified @@ -27249,9 +26702,9 @@ Returns: Tuple[Any, ...] """ - pass + ... - def WritePropertyNames(self, props: 'Tuple[Any, ...]', names: 'Tuple[str, ...]') -> 'None': + def WritePropertyNames(self, props: Tuple[Any, ...], names: Tuple[str, ...]) -> None: """ Assigns string names to a specified array of property IDs in the @@ -27267,9 +26720,9 @@ Returns: None """ - pass + ... - def DeletePropertyNames(self, props: 'Tuple[Any, ...]') -> 'None': + def DeletePropertyNames(self, props: Tuple[Any, ...]) -> None: """ Removes property names from specified properties. @@ -27282,9 +26735,9 @@ Returns: None """ - pass + ... - def Commit(self, CommitFlags: 'Any') -> 'None': + def Commit(self, CommitFlags: Any) -> None: """ Persists the property set to its base storage @@ -27297,9 +26750,9 @@ Returns: None """ - pass + ... - def Revert(self,) -> 'None': + def Revert(self) -> None: """ Discards any changes that have been made @@ -27312,9 +26765,9 @@ Returns: None """ - pass + ... - def Enum(self,) -> 'Any': + def Enum(self) -> Any: """ Creates an enumerator for properties in the property set @@ -27327,9 +26780,9 @@ Returns: Any """ - pass + ... - def SetTimes(self, ctime: 'PyTime', atime: 'PyTime', mtime: 'PyTime') -> 'None': + def SetTimes(self, ctime: PyTime, atime: PyTime, mtime: PyTime) -> None: """ Sets the creation, last access, and modification time @@ -27344,9 +26797,9 @@ Returns: None """ - pass + ... - def SetClass(self, clsid: 'PyIID') -> 'None': + def SetClass(self, clsid: PyIID) -> None: """ Sets the GUID for the property set @@ -27359,9 +26812,9 @@ Returns: None """ - pass + ... - def Stat(self,) -> 'Any': + def Stat(self) -> Any: """ Returns various infomation about the property set @@ -27378,16 +26831,16 @@ Return ValueReturns a tuple representing a STATPROPSETSTG struct. """ - pass + ... -class PyIPropertyStore(object): +class PyIPropertyStore: """Contains a collection of properties""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetCount(self,) -> 'Any': + def GetCount(self) -> Any: """ Returns the number of properties in the store @@ -27400,9 +26853,9 @@ Returns: Any """ - pass + ... - def GetAt(self, iProp: 'Any') -> 'Any': + def GetAt(self, iProp: Any) -> Any: """ Returns the property key for the specified property @@ -27415,9 +26868,9 @@ Returns: Any """ - pass + ... - def GetValue(self, Key: 'Any') -> 'Any': + def GetValue(self, Key: Any) -> Any: """ Retrieves the value of a property @@ -27430,25 +26883,25 @@ Returns: Any """ - pass + ... - def SetValue(self, Key: 'Any', Value: 'Any') -> 'None': + def SetValue(self, Key: Any, Value: Any) -> None: """ Sets the value of a property Args: Key(Any):Property key (see PyIPropertyStore::GetAt) - Value(Any):Variant value which can be converted to the appropriate variant type for the property Pass a VT_EMPTY variant to indicate that the property should be removed. + Value(Any):Variant value which can be converted to the appropriate variant type for the property ... a VT_EMPTY variant to indicate that the property should be removed. Returns: None """ - pass + ... - def Commit(self,) -> 'None': + def Commit(self) -> None: """ Commits property changes @@ -27461,16 +26914,15 @@ Returns: None """ - pass + ... -class PyIPropertyStoreCache(object): - """""" +class PyIPropertyStoreCache: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetState(self, key: 'Any') -> 'Any': + def GetState(self, key: Any) -> Any: """ Retrieves the current state of a property @@ -27484,9 +26936,9 @@ Returns: """ - pass + ... - def GetValueAndState(self, key: 'Any') -> 'Tuple[Any, Any]': + def GetValueAndState(self, key: Any) -> Tuple[Any, Any]: """ Retrieves the current value and state of a @@ -27501,9 +26953,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def SetState(self, key: 'Any', state: 'Any') -> 'None': + def SetState(self, key: Any, state: Any) -> None: """ Sets the state of a property @@ -27517,9 +26969,9 @@ Returns: None """ - pass + ... - def SetValueAndState(self, key: 'Any', value: 'Any', state: 'Any') -> 'None': + def SetValueAndState(self, key: Any, value: Any, state: Any) -> None: """ Sets the value and state of a property @@ -27534,10 +26986,10 @@ Returns: None """ - pass + ... -class PyIPropertyStoreCapabilities(object): +class PyIPropertyStoreCapabilities: """Property providers use this interface to indicate whether properties are writeable.""" @@ -27545,7 +26997,7 @@ writeable.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def IsPropertyWritable(self, key: 'Any') -> 'Any': + def IsPropertyWritable(self, key: Any) -> Any: """ Asks provider if a property can be editted. @@ -27558,16 +27010,16 @@ Returns: Any """ - pass + ... -class PyIPropertySystem(object): +class PyIPropertySystem: """Wraps the IPropertySystem interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetPropertyDescription(self, Key: 'Any', riid: 'PyIID') -> 'Any': + def GetPropertyDescription(self, Key: Any, riid: PyIID) -> Any: """ Returns an interface used to describe a @@ -27583,9 +27035,9 @@ Returns: Any """ - pass + ... - def GetPropertyDescriptionByName(self, CanonicalName: 'Any', riid: 'PyIID') -> 'Any': + def GetPropertyDescriptionByName(self, CanonicalName: Any, riid: PyIID) -> Any: """ Returns an interface used to @@ -27601,9 +27053,9 @@ Returns: Any """ - pass + ... - def GetPropertyDescriptionListFromString(self, PropList: 'Any', riid: 'PyIID') -> 'Any': + def GetPropertyDescriptionListFromString(self, PropList: Any, riid: PyIID) -> Any: """ Retrieves property @@ -27619,9 +27071,9 @@ Returns: Any """ - pass + ... - def EnumeratePropertyDescriptions(self, Filter: 'Any', riid: 'PyIID') -> 'Any': + def EnumeratePropertyDescriptions(self, Filter: Any, riid: PyIID) -> Any: """ Returns an interface used to @@ -27637,9 +27089,9 @@ Returns: Any """ - pass + ... - def FormatForDisplay(self, Key: 'Any', Value: 'Any', Flags: 'Any') -> 'Any': + def FormatForDisplay(self, Key: Any, Value: Any, Flags: Any) -> Any: """ Formats a property into a string @@ -27654,9 +27106,9 @@ Returns: Any """ - pass + ... - def RegisterPropertySchema(self, Path: 'Any') -> 'None': + def RegisterPropertySchema(self, Path: Any) -> None: """ Registers a set of properties defined in a .propdesc file @@ -27669,9 +27121,9 @@ Returns: None """ - pass + ... - def UnregisterPropertySchema(self, Path: 'Any') -> 'None': + def UnregisterPropertySchema(self, Path: Any) -> None: """ Removes a set of registered properties @@ -27684,9 +27136,9 @@ Returns: None """ - pass + ... - def RefreshPropertySchema(self,) -> 'None': + def RefreshPropertySchema(self) -> None: """ Not currently implemented by the OS @@ -27699,16 +27151,16 @@ Returns: None """ - pass + ... -class PyIProvideClassInfo(object): +class PyIProvideClassInfo: """A Python interface to IProvideClassInfo""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetClassInfo(self,) -> 'Any': + def GetClassInfo(self) -> Any: """ Gets information about the CO_CLASS. @@ -27721,16 +27173,15 @@ Returns: Any """ - pass + ... -class PyIProvideClassInfo2(object): - """""" +class PyIProvideClassInfo2: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetGUID(self, flags: 'Any') -> 'PyIID': + def GetGUID(self, flags: Any) -> PyIID: """ Gets the GUID for the object. @@ -27743,16 +27194,16 @@ Returns: PyIID """ - pass + ... -class PyIProvideExpressionContexts(object): +class PyIProvideExpressionContexts: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def EnumExpressionContexts(self,) -> 'None': + def EnumExpressionContexts(self) -> None: """ Description of EnumStackFrames. @@ -27765,16 +27216,16 @@ Returns: None """ - pass + ... -class PyIProvideTaskPage(object): +class PyIProvideTaskPage: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetPage(self, tpType: 'Any', PersistChanges: 'Any') -> 'None': + def GetPage(self, tpType: Any, PersistChanges: Any) -> None: """ Return a property sheet page handle for the spedified type @@ -27790,16 +27241,16 @@ Returns: None """ - pass + ... -class PyIQueryAssociations(object): +class PyIQueryAssociations: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Init(self, flags: 'Any', assoc: 'str', hkeyProgId: 'PyHKEY' = None, hwnd: 'int' = None) -> 'None': + def Init(self, flags: Any, assoc: str, hkeyProgId: PyHKEY = None, hwnd: int = None) -> None: """ Initializes the IQueryAssociations interface and sets the root key to the @@ -27817,9 +27268,9 @@ Returns: None """ - pass + ... - def GetKey(self, flags: 'Any', assocKey: 'Any', arg: 'str') -> 'Any': + def GetKey(self, flags: Any, assocKey: Any, arg: str) -> Any: """ Searches for and retrieves a file association-related key from the @@ -27836,9 +27287,9 @@ Returns: Any """ - pass + ... - def GetString(self, flags: 'Any', assocStr: 'Any', arg: 'str') -> 'Any': + def GetString(self, flags: Any, assocStr: Any, arg: str) -> Any: """ Searches for and retrieves a file association-related string from the @@ -27855,10 +27306,10 @@ Returns: Any """ - pass + ... -class PyIRelatedItem(object): +class PyIRelatedItem: """Interface used as the base for objects that have a related shell item (eg ITransferMediumItem, IDisplayItem, etc). Should not be used directly.""" @@ -27866,7 +27317,7 @@ class PyIRelatedItem(object): def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetItemIDList(self,) -> 'Any': + def GetItemIDList(self) -> Any: """ Returns the ID list of the related item @@ -27879,9 +27330,9 @@ Returns: Any """ - pass + ... - def GetItem(self,) -> 'Any': + def GetItem(self) -> Any: """ Returns the related item @@ -27894,16 +27345,16 @@ Returns: Any """ - pass + ... -class PyIRemoteDebugApplication(object): +class PyIRemoteDebugApplication: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def ResumeFromBreakPoint(self, prptFocus: 'Any', bra: 'Any', era: 'Any') -> 'None': + def ResumeFromBreakPoint(self, prptFocus: Any, bra: Any, era: Any) -> None: """ Continue an application which is currently in a breakpoint. @@ -27918,9 +27369,9 @@ Returns: None """ - pass + ... - def CauseBreak(self,) -> 'None': + def CauseBreak(self) -> None: """ Causes the application to break into the debugger at the earliest @@ -27935,9 +27386,9 @@ Returns: None """ - pass + ... - def ConnectDebugger(self, pad: 'Any') -> 'None': + def ConnectDebugger(self, pad: Any) -> None: """ Connects a debugger to the application. @@ -27950,9 +27401,9 @@ Returns: None """ - pass + ... - def DisconnectDebugger(self,) -> 'None': + def DisconnectDebugger(self) -> None: """ Disconnects the current debugger from the application. @@ -27965,9 +27416,9 @@ Returns: None """ - pass + ... - def GetDebugger(self,) -> 'Any': + def GetDebugger(self) -> Any: """ Returns the current debugger connected to @@ -27982,14 +27433,14 @@ Returns: Any """ - pass + ... def CreateInstanceAtApplication( self, - rclsid: 'PyIID', - pUnkOuter: 'Any', - dwClsContext: 'Any', - riid: 'PyIID') -> 'Any': + rclsid: PyIID, + pUnkOuter: Any, + dwClsContext: Any, + riid: PyIID) -> Any: """ Create objects in the application @@ -28007,9 +27458,9 @@ Returns: Any """ - pass + ... - def QueryAlive(self,) -> 'None': + def QueryAlive(self) -> None: """ Returns True if alive, else False. @@ -28022,9 +27473,9 @@ Returns: None """ - pass + ... - def EnumThreads(self,) -> 'Any': + def EnumThreads(self) -> Any: """ Enumerates all threads known @@ -28039,9 +27490,9 @@ Returns: Any """ - pass + ... - def GetName(self,) -> 'None': + def GetName(self) -> None: """ Description of GetName. @@ -28054,9 +27505,9 @@ Returns: None """ - pass + ... - def GetRootNode(self,) -> 'Any': + def GetRootNode(self) -> Any: """ Returns the application node under which @@ -28071,9 +27522,9 @@ Returns: Any """ - pass + ... - def EnumGlobalExpressionContexts(self,) -> 'Any': + def EnumGlobalExpressionContexts(self) -> Any: """ Enumerates all @@ -28088,16 +27539,16 @@ Returns: Any """ - pass + ... -class PyIRemoteDebugApplicationEvents(object): +class PyIRemoteDebugApplicationEvents: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def OnConnectDebugger(self, pad: 'Any') -> 'None': + def OnConnectDebugger(self, pad: Any) -> None: """ Description of OnConnectDebugger. @@ -28110,9 +27561,9 @@ Returns: None """ - pass + ... - def OnDisconnectDebugger(self,) -> 'None': + def OnDisconnectDebugger(self) -> None: """ Description of OnDisconnectDebugger. @@ -28125,9 +27576,9 @@ Returns: None """ - pass + ... - def OnSetName(self, pstrName: 'Any') -> 'None': + def OnSetName(self, pstrName: Any) -> None: """ Description of OnSetName. @@ -28140,9 +27591,9 @@ Returns: None """ - pass + ... - def OnDebugOutput(self, pstr: 'Any') -> 'None': + def OnDebugOutput(self, pstr: Any) -> None: """ Description of OnDebugOutput. @@ -28155,9 +27606,9 @@ Returns: None """ - pass + ... - def OnClose(self,) -> 'None': + def OnClose(self) -> None: """ Description of OnClose. @@ -28170,9 +27621,9 @@ Returns: None """ - pass + ... - def OnEnterBreakPoint(self, prdat: 'Any') -> 'None': + def OnEnterBreakPoint(self, prdat: Any) -> None: """ Description of OnEnterBreakPoint. @@ -28185,9 +27636,9 @@ Returns: None """ - pass + ... - def OnLeaveBreakPoint(self, prdat: 'Any') -> 'None': + def OnLeaveBreakPoint(self, prdat: Any) -> None: """ Description of OnLeaveBreakPoint. @@ -28200,9 +27651,9 @@ Returns: None """ - pass + ... - def OnCreateThread(self, prdat: 'Any') -> 'None': + def OnCreateThread(self, prdat: Any) -> None: """ Description of OnCreateThread. @@ -28215,9 +27666,9 @@ Returns: None """ - pass + ... - def OnDestroyThread(self, prdat: 'Any') -> 'None': + def OnDestroyThread(self, prdat: Any) -> None: """ Description of OnDestroyThread. @@ -28230,9 +27681,9 @@ Returns: None """ - pass + ... - def OnBreakFlagChange(self, abf: 'Any', prdatSteppingThread: 'Any') -> 'None': + def OnBreakFlagChange(self, abf: Any, prdatSteppingThread: Any) -> None: """ Description of OnBreakFlagChange. @@ -28246,16 +27697,16 @@ Returns: None """ - pass + ... -class PyIRemoteDebugApplicationThread(object): +class PyIRemoteDebugApplicationThread: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetSystemThreadId(self,) -> 'None': + def GetSystemThreadId(self) -> None: """ Description of GetSystemThreadId. @@ -28268,9 +27719,9 @@ Returns: None """ - pass + ... - def GetApplication(self,) -> 'None': + def GetApplication(self) -> None: """ Description of GetApplication. @@ -28283,9 +27734,9 @@ Returns: None """ - pass + ... - def EnumStackFrames(self,) -> 'None': + def EnumStackFrames(self) -> None: """ Description of EnumStackFrames. @@ -28298,9 +27749,9 @@ Returns: None """ - pass + ... - def GetDescription(self,) -> 'None': + def GetDescription(self) -> None: """ Description of GetDescription. @@ -28313,9 +27764,9 @@ Returns: None """ - pass + ... - def SetNextStatement(self, pStackFrame: 'Any', pCodeContext: 'Any') -> 'None': + def SetNextStatement(self, pStackFrame: Any, pCodeContext: Any) -> None: """ Description of SetNextStatement. @@ -28329,9 +27780,9 @@ Returns: None """ - pass + ... - def GetState(self,) -> 'None': + def GetState(self) -> None: """ Description of GetState. @@ -28344,9 +27795,9 @@ Returns: None """ - pass + ... - def Suspend(self,) -> 'None': + def Suspend(self) -> None: """ Description of Suspend. @@ -28359,9 +27810,9 @@ Returns: None """ - pass + ... - def Resume(self,) -> 'None': + def Resume(self) -> None: """ Description of Resume. @@ -28374,9 +27825,9 @@ Returns: None """ - pass + ... - def GetSuspendCount(self,) -> 'None': + def GetSuspendCount(self) -> None: """ Description of GetSuspendCount. @@ -28389,16 +27840,16 @@ Returns: None """ - pass + ... -class PyIRunningObjectTable(object): +class PyIRunningObjectTable: """A Python interface to IRunningObjectTable""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Register(self,) -> 'Any': + def Register(self) -> Any: """ Registers an object and its identifying moniker in the Running Object @@ -28413,9 +27864,9 @@ Returns: Any """ - pass + ... - def Revoke(self,) -> 'Any': + def Revoke(self) -> Any: """ None @@ -28428,9 +27879,9 @@ Returns: Any """ - pass + ... - def IsRunning(self, objectName: 'Any') -> 'Any': + def IsRunning(self, objectName: Any) -> Any: """ Checks whether an object is running. @@ -28443,9 +27894,9 @@ Returns: Any """ - pass + ... - def GetObject(self, objectName: 'Any') -> 'Any': + def GetObject(self, objectName: Any) -> Any: """ Checks whether an object is running. @@ -28458,9 +27909,9 @@ Returns: Any """ - pass + ... - def EnumRunning(self,) -> 'Any': + def EnumRunning(self) -> Any: """ Creates an enumerator that can list the monikers of @@ -28475,16 +27926,16 @@ Returns: Any """ - pass + ... -class PyIScheduledWorkItem(object): +class PyIScheduledWorkItem: """Python object that encapsulates the IScheduledWorkItem interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CreateTrigger(self,) -> 'Tuple[Any, Any]': + def CreateTrigger(self) -> Tuple[Any, Any]: """ Creates a new trigger for a task, returns index and @@ -28499,9 +27950,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def DeleteTrigger(self, Trigger: 'Any') -> 'None': + def DeleteTrigger(self, Trigger: Any) -> None: """ Deletes specified trigger @@ -28514,9 +27965,9 @@ Returns: None """ - pass + ... - def GetTriggerCount(self,) -> 'Any': + def GetTriggerCount(self) -> Any: """ Returns number of triggers defined for the task @@ -28529,9 +27980,9 @@ Returns: Any """ - pass + ... - def GetTrigger(self, iTrigger: 'Any') -> 'Any': + def GetTrigger(self, iTrigger: Any) -> Any: """ Retrieves ITaskTrigger interface for specified trigger @@ -28546,9 +27997,9 @@ Returns: Any """ - pass + ... - def GetTriggerString(self,) -> 'Any': + def GetTriggerString(self) -> Any: """ Creates a human-readable summary of specified trigger @@ -28561,9 +28012,9 @@ Returns: Any """ - pass + ... - def GetRunTimes(self, Count: 'Any', Begin: 'PyTime', End: 'PyTime') -> 'Tuple[PyTime, Any, Any, Any]': + def GetRunTimes(self, Count: Any, Begin: PyTime, End: PyTime) -> Tuple[PyTime, Any, Any, Any]: """ Return specified number of run times within given time @@ -28580,9 +28031,9 @@ Returns: Tuple[PyTime, Any, Any, Any] """ - pass + ... - def GetNextRunTime(self,) -> 'PyTime': + def GetNextRunTime(self) -> PyTime: """ Returns next time that task is scheduled to run @@ -28595,9 +28046,9 @@ Returns: PyTime """ - pass + ... - def SetIdleWait(self, wIdleMinutes: 'Any', wDeadlineMinutes: 'Any') -> 'None': + def SetIdleWait(self, wIdleMinutes: Any, wDeadlineMinutes: Any) -> None: """ Sets idle parms for task with trigger of type TASK_EVENT_TRIGGER_ON_IDLE @@ -28611,9 +28062,9 @@ Returns: None """ - pass + ... - def GetIdleWait(self,) -> 'Tuple[Any, Any]': + def GetIdleWait(self) -> Tuple[Any, Any]: """ Gets IdleMinutes and DeadlineMinutes parms for task with trigger @@ -28628,9 +28079,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def Run(self,) -> 'None': + def Run(self) -> None: """ Starts task @@ -28643,9 +28094,9 @@ Returns: None """ - pass + ... - def Terminate(self,) -> 'None': + def Terminate(self) -> None: """ Terminate process if task is running @@ -28658,9 +28109,9 @@ Returns: None """ - pass + ... - def EditWorkItem(self, hParent: 'int', dwReserved: 'Any') -> 'None': + def EditWorkItem(self, hParent: int, dwReserved: Any) -> None: """ Brings up standard Scheduled Task dialog @@ -28674,9 +28125,9 @@ Returns: None """ - pass + ... - def GetMostRecentRunTime(self,) -> 'PyTime': + def GetMostRecentRunTime(self) -> PyTime: """ Returns last time task ran @@ -28689,9 +28140,9 @@ Returns: PyTime """ - pass + ... - def GetStatus(self,) -> 'Any': + def GetStatus(self) -> Any: """ Returns status (SCHED_S_TASK... constants) @@ -28704,9 +28155,9 @@ Returns: Any """ - pass + ... - def GetExitCode(self,) -> 'Tuple[Any, Any]': + def GetExitCode(self) -> Tuple[Any, Any]: """ Returns tuple of task's exit code and error returned to Task @@ -28721,9 +28172,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def SetComment(self, Comment: 'Any') -> 'None': + def SetComment(self, Comment: Any) -> None: """ Set comment string for task @@ -28736,9 +28187,9 @@ Returns: None """ - pass + ... - def GetComment(self,) -> 'str': + def GetComment(self) -> str: """ Return comment string associated with task. @@ -28751,9 +28202,9 @@ Returns: str """ - pass + ... - def SetCreator(self, Creator: 'Any') -> 'None': + def SetCreator(self, Creator: Any) -> None: """ Specify who (or what) created task, can be any string @@ -28766,9 +28217,9 @@ Returns: None """ - pass + ... - def GetCreator(self,) -> 'None': + def GetCreator(self) -> None: """ Returns creator info, can be any string data @@ -28781,9 +28232,9 @@ Returns: None """ - pass + ... - def SetWorkItemData(self, Data: 'str') -> 'None': + def SetWorkItemData(self, Data: str) -> None: """ Set data associated with task (treated as uninterpreted bytes) @@ -28796,9 +28247,9 @@ Returns: None """ - pass + ... - def GetWorkItemData(self,) -> 'str': + def GetWorkItemData(self) -> str: """ Retrieve data associated with task @@ -28811,9 +28262,9 @@ Returns: str """ - pass + ... - def SetErrorRetryCount(self, wRetryCount: 'Any') -> 'None': + def SetErrorRetryCount(self, wRetryCount: Any) -> None: """ Specify nbr of times to attempt to run task if it can't start (not @@ -28828,9 +28279,9 @@ Returns: None """ - pass + ... - def GetErrorRetryCount(self,) -> 'None': + def GetErrorRetryCount(self) -> None: """ Return nbr of times Task scheduler should try to run task (not @@ -28845,9 +28296,9 @@ Returns: None """ - pass + ... - def SetErrorRetryInterval(self, RetryInterval: 'Any') -> 'None': + def SetErrorRetryInterval(self, RetryInterval: Any) -> None: """ Interval in minutes between attempts to run task. Not @@ -28862,9 +28313,9 @@ Returns: None """ - pass + ... - def GetErrorRetryInterval(self,) -> 'None': + def GetErrorRetryInterval(self) -> None: """ Returns nbr of minutes between attempts to run task. Not @@ -28879,9 +28330,9 @@ Returns: None """ - pass + ... - def SetFlags(self, dwFlags: 'Any') -> 'None': + def SetFlags(self, dwFlags: Any) -> None: """ Set flags for task @@ -28894,9 +28345,9 @@ Returns: None """ - pass + ... - def GetFlags(self,) -> 'Any': + def GetFlags(self) -> Any: """ Returns flags for task (TASK_FLAG_* constants) @@ -28909,25 +28360,25 @@ Returns: Any """ - pass + ... - def SetAccountInformation(self, AccountName: 'Any', Password: 'Any') -> 'None': + def SetAccountInformation(self, AccountName: Any, password: Any) -> None: """ Set username and password under which task will run Args: AccountName(Any):AccountName, use "" for local system account (can only be used by Administrators) - Password(Any):Password - Can be None for local System account, or if TASK_FLAG_RUN_ONLY_IF_LOGGED_ON is setCommentsOn some systems, username and password are verified at the time the task is saved, on others when the task tries to run + password(Any):password - Can be None for local System account, or if TASK_FLAG_RUN_ONLY_IF_LOGGED_ON is setCommentsOn some systems, username and password are verified at the time the task is saved, on others when the task tries to run Returns: None """ - pass + ... - def GetAccountInformation(self,) -> 'Any': + def GetAccountInformation(self) -> Any: """ Returns username that task will run under @@ -28940,16 +28391,16 @@ Returns: Any """ - pass + ... -class PyIServerSecurity(object): +class PyIServerSecurity: """Interface used to access client security settings and perform impersonation""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def QueryBlanket(self, Capabilities: 'Any' = 0) -> 'Any': + def QueryBlanket(self, Capabilities: Any = 0) -> Any: """ Retrieves security settings specified by the client @@ -28962,9 +28413,9 @@ Returns: Any """ - pass + ... - def ImpersonateClient(self,) -> 'None': + def ImpersonateClient(self) -> None: """ Initiates impersonation of client @@ -28977,9 +28428,9 @@ Returns: None """ - pass + ... - def RevertToSelf(self,) -> 'None': + def RevertToSelf(self) -> None: """ Ends impersonation of client @@ -28992,9 +28443,9 @@ Returns: None """ - pass + ... - def IsImpersonating(self,) -> 'Any': + def IsImpersonating(self) -> Any: """ Determines if server is currently impersonating a client @@ -29007,16 +28458,16 @@ Returns: Any """ - pass + ... -class PyIServiceProvider(object): +class PyIServiceProvider: """A Python interface to IServiceProvider""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def QueryService(self, clsid: 'PyIID', iid: 'PyIID') -> 'Any': + def QueryService(self, clsid: PyIID, iid: PyIID) -> Any: """ Creates or accesses the specified service and returns an @@ -29032,10 +28483,10 @@ Returns: Any """ - pass + ... -class PyIShellBrowser(object): +class PyIShellBrowser: """Exposed by Windows Explorer and the Open File common dialog box to provide services for namespace extensions.""" @@ -29043,7 +28494,7 @@ namespace extensions.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def InsertMenusSB(self, hmenuShared: 'int', lpMenuWidths: 'Any') -> 'Any': + def InsertMenusSB(self, hmenuShared: int, lpMenuWidths: Any) -> Any: """ Updates a composite menu with container's options @@ -29057,9 +28508,9 @@ Returns: Any """ - pass + ... - def SetMenuSB(self, hmenuShared: 'int', holemenuRes: 'int', hwndActiveObject: 'int') -> 'None': + def SetMenuSB(self, hmenuShared: int, holemenuRes: int, hwndActiveObject: int) -> None: """ Attaches a shared menu to a shell view window @@ -29074,9 +28525,9 @@ Returns: None """ - pass + ... - def RemoveMenusSB(self, hmenuShared: 'int') -> 'None': + def RemoveMenusSB(self, hmenuShared: int) -> None: """ Asks container to remove any items it added to a composite menu @@ -29089,9 +28540,9 @@ Returns: None """ - pass + ... - def SetStatusTextSB(self, pszStatusText: 'Any') -> 'None': + def SetStatusTextSB(self, pszStatusText: Any) -> None: """ Sets the status text in view's status bar @@ -29104,9 +28555,9 @@ Returns: None """ - pass + ... - def EnableModelessSB(self, fEnable: 'Any') -> 'None': + def EnableModelessSB(self, fEnable: Any) -> None: """ Enables or disables modeless dialogs @@ -29119,9 +28570,9 @@ Returns: None """ - pass + ... - def TranslateAcceleratorSB(self, pmsg: 'PyMSG', wID: 'Any') -> 'None': + def TranslateAcceleratorSB(self, pmsg: PyMSG, wID: Any) -> None: """ Translates keystrokes used as menu item activators @@ -29135,9 +28586,9 @@ Returns: None """ - pass + ... - def BrowseObject(self, pidl: 'Any', wFlags: 'Any') -> 'None': + def BrowseObject(self, pidl: Any, wFlags: Any) -> None: """ Navigates to a different location @@ -29151,9 +28602,9 @@ Returns: None """ - pass + ... - def GetViewStateStream(self, grfMode: 'Any') -> 'Any': + def GetViewStateStream(self, grfMode: Any) -> Any: """ Returns a stream that can be used to access view state @@ -29168,9 +28619,9 @@ Returns: Any """ - pass + ... - def GetControlWindow(self, _id: 'Any') -> 'None': + def GetControlWindow(self, _id: Any) -> None: """ Returns a handle to one of the browser's control elements @@ -29183,9 +28634,9 @@ Returns: None """ - pass + ... - def SendControlMsg(self, _id: 'Any', uMsg: 'Any', wParam: 'Any', lParam: 'Any') -> 'Any': + def SendControlMsg(self, _id: Any, uMsg: Any, wParam: Any, lParam: Any) -> Any: """ Sends a control msg to browser's toolbar or status bar @@ -29201,9 +28652,9 @@ Returns: Any """ - pass + ... - def QueryActiveShellView(self,) -> 'Any': + def QueryActiveShellView(self) -> Any: """ Returns the currently displayed view @@ -29216,9 +28667,9 @@ Returns: Any """ - pass + ... - def OnViewWindowActive(self, pshv: 'Any') -> 'None': + def OnViewWindowActive(self, pshv: Any) -> None: """ Callback triggered when a view window is activated @@ -29231,9 +28682,9 @@ Returns: None """ - pass + ... - def SetToolbarItems(self, lpButtons: 'Any', uFlags: 'Any') -> 'None': + def SetToolbarItems(self, lpButtons: Any, uFlags: Any) -> None: """ Adds toolbar buttons to the browser's toolbar @@ -29247,16 +28698,16 @@ Returns: None """ - pass + ... -class PyIShellExtInit(object): +class PyIShellExtInit: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Initialize(self, pFolder: 'Any', pDataObject: 'Any', hkey: 'int') -> 'None': + def Initialize(self, pFolder: Any, pDataObject: Any, hkey: int) -> None: """ Description of Initialize. @@ -29271,16 +28722,16 @@ Returns: None """ - pass + ... -class PyIShellFolder(object): +class PyIShellFolder: """Interface that represents an Explorer folder""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def ParseDisplayName(self, hwndOwner: 'int', pbc: 'Any', DisplayName: 'Any', Attributes: 'Any' = 0) -> 'Any': + def ParseDisplayName(self, hwndOwner: int, pbc: Any, DisplayName: Any, Attributes: Any = 0) -> Any: """ Returns the PIDL of an item in a shell folder @@ -29288,7 +28739,7 @@ Args: hwndOwner(int):Window in which to display any dialogs or message boxes, can be 0 pbc(Any):Bind context that affects how parsing is performed, can be None - DisplayName(Any):Display name to parse, format is dependent on the shell folder. Desktop folder will accept a file path, as well as guids of the form ::{guid} Example: '::%s\\::%s' %(shell.CLSID_MyComputer,shell.CLSID_ControlPanel) + DisplayName(Any):Display name to parse, format is dependent on the shell folder. Desktop folder will accept a file path, as well as guids of the form ::{guid} Example: ::%s\\::%s' %(shell.CLSID_MyComputer,shell.CLSID_ControlPanel) Attributes(Any):Combination of shellcon.SFGAO_* constants specifying which attributes should be returnedReturn ValueThe result is a tuple of cchEaten, pidl, attrItems[0] int : cchEatenthe number of characters of the input name that were parsed[1] PyIDL : pidlspecifies the relative path from the parsing folder to the object[2] int : Attributesreturns any requested attributes Returns: @@ -29304,9 +28755,9 @@ returns any requested attributes """ - pass + ... - def EnumObjects(self, grfFlags: 'Any', hwndOwner: 'int' = None) -> 'Any': + def EnumObjects(self, grfFlags: Any, hwndOwner: int = None) -> Any: """ Creates an enumerator to list the contents of the shell folder @@ -29320,9 +28771,9 @@ Returns: Any """ - pass + ... - def BindToObject(self, pidl: 'Any', pbc: 'Any', riid: 'PyIID') -> 'Any': + def BindToObject(self, pidl: Any, pbc: Any, riid: PyIID) -> Any: """ Returns an IShellFolder interface for a subfolder @@ -29337,9 +28788,9 @@ Returns: Any """ - pass + ... - def BindToStorage(self, pidl: 'Any', pbc: 'Any', riid: 'PyIID') -> 'Any': + def BindToStorage(self, pidl: Any, pbc: Any, riid: PyIID) -> Any: """ Returns an interface to a storage object in a shell folder @@ -29355,9 +28806,9 @@ Returns: """ - pass + ... - def CompareIDs(self, lparam: 'Any', pidl1: 'Any', pidl2: 'Any') -> 'Any': + def CompareIDs(self, lparam: Any, pidl1: Any, pidl2: Any) -> Any: """ Determines the sorting order of 2 items in shell folder @@ -29373,9 +28824,9 @@ Returns: """ - pass + ... - def CreateViewObject(self, hwndOwner: 'Any', riid: 'PyIID') -> 'Any': + def CreateViewObject(self, hwndOwner: Any, riid: PyIID) -> Any: """ Creates a view object for a shell folder. @@ -29389,9 +28840,9 @@ Returns: Any """ - pass + ... - def GetAttributesOf(self, pidl: 'Tuple[Any, ...]', rgfInOut: 'Any') -> 'Any': + def GetAttributesOf(self, pidl: Tuple[Any, ...], rgfInOut: Any) -> Any: """ Queries attributes of items within the shell folder @@ -29406,15 +28857,15 @@ Returns: """ - pass + ... def GetUIObjectOf( self, - hwndOwner: 'int', - pidl: 'Tuple[Any, ...]', - riid: 'PyIID', - iidout: 'PyIID', - Reserved: 'Any' = 0) -> 'Tuple[Any, Any]': + hwndOwner: int, + pidl: Tuple[Any, ...], + riid: PyIID, + iidout: PyIID, + Reserved: Any = 0) -> Tuple[Any, Any]: """ Creates an interface to one or more items in a shell @@ -29441,9 +28892,9 @@ Return ValueReturns the Reserved parameter and the requested interface """ - pass + ... - def GetDisplayNameOf(self, pidl: 'Any', uFlags: 'Any') -> 'Any': + def GetDisplayNameOf(self, pidl: Any, uFlags: Any) -> Any: """ Returns the display name of an item within this shell folder @@ -29457,9 +28908,9 @@ Returns: Any """ - pass + ... - def SetNameOf(self, hwndOwner: 'Any', pidl: 'Any', Name: 'Any', Flags: 'Any') -> 'Any': + def SetNameOf(self, hwndOwner: Any, pidl: Any, Name: Any, Flags: Any) -> Any: """ Sets the display name of an item and changes its PIDL @@ -29476,16 +28927,15 @@ Returns: """ - pass + ... -class PyIShellFolder2(object): - """""" +class PyIShellFolder2: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetDefaultSearchGUID(self, pguid: 'PyIID') -> 'PyIID': + def GetDefaultSearchGUID(self, pguid: PyIID) -> PyIID: """ Retrieves the default search for the folder @@ -29498,9 +28948,9 @@ Returns: PyIID """ - pass + ... - def EnumSearches(self,) -> 'Any': + def EnumSearches(self) -> Any: """ Returns an interface that lists searches defined for @@ -29515,9 +28965,9 @@ Returns: Any """ - pass + ... - def GetDefaultColumn(self,) -> 'Tuple[Any, Any]': + def GetDefaultColumn(self) -> Tuple[Any, Any]: """ Returns the columns used for sorting and display @@ -29530,9 +28980,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def GetDefaultColumnState(self, iColumn: 'Any') -> 'Any': + def GetDefaultColumnState(self, iColumn: Any) -> Any: """ Returns flags indicating the default behaviour of the column @@ -29546,9 +28996,9 @@ Returns: """ - pass + ... - def GetDetailsEx(self, pidl: 'Any', pscid: 'Any') -> 'Any': + def GetDetailsEx(self, pidl: Any, pscid: Any) -> Any: """ Returns the details of an item by Column ID @@ -29563,9 +29013,9 @@ Returns: """ - pass + ... - def GetDetailsOf(self, pidl: 'Any', iColumn: 'Any') -> 'Tuple[Any, Any, Any]': + def GetDetailsOf(self, pidl: Any, iColumn: Any) -> Tuple[Any, Any, Any]: """ Returns the value or title of a column in the folder's Details @@ -29586,9 +29036,9 @@ and string representation of the requested value """ - pass + ... - def MapColumnToSCID(self, Column: 'Any') -> 'Any': + def MapColumnToSCID(self, Column: Any) -> Any: """ Returns the unique identifier (FMTID, pid) of a column @@ -29604,16 +29054,16 @@ For Vista and later, this is the Property Key used with the property system inte """ - pass + ... -class PyIShellIcon(object): +class PyIShellIcon: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetIconOf(self, pidl: 'Any') -> 'None': + def GetIconOf(self, pidl: Any) -> None: """ Description of GetIconOf. @@ -29626,16 +29076,16 @@ Returns: None """ - pass + ... -class PyIShellIconOverlay(object): +class PyIShellIconOverlay: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetOverlayIndex(self, pidl: 'Any') -> 'None': + def GetOverlayIndex(self, pidl: Any) -> None: """ Description of GetOverlayIndex. @@ -29648,9 +29098,9 @@ Returns: None """ - pass + ... - def GetOverlayIconIndex(self, pidl: 'Any') -> 'None': + def GetOverlayIconIndex(self, pidl: Any) -> None: """ Description of GetOverlayIconIndex. @@ -29663,16 +29113,16 @@ Returns: None """ - pass + ... -class PyIShellIconOverlayIdentifier(object): +class PyIShellIconOverlayIdentifier: """Interface that supplies icon overlay information to the shell""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def IsMemberOf(self, path: 'str', attrib: 'Any') -> 'Any': + def IsMemberOf(self, path: str, attrib: Any) -> Any: """ Determines if a shell object should have an icon overlay @@ -29693,9 +29143,9 @@ Python's True and False should not be used, as S_OK==0==False. """ - pass + ... - def GetOverlayInfo(self,) -> 'Tuple[str, Any, Any]': + def GetOverlayInfo(self) -> Tuple[str, Any, Any]: """ Retrieves the path to the overlay @@ -29718,9 +29168,9 @@ combination of shellcon.ISIOI_ICON* flags """ - pass + ... - def GetPriority(self,) -> 'Any': + def GetPriority(self) -> Any: """ Retrieves the relative priority of the overlay @@ -29737,16 +29187,16 @@ Return ValueImplementation of this function should return a number in the range """ - pass + ... -class PyIShellIconOverlayManager(object): +class PyIShellIconOverlayManager: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetFileOverlayInfo(self, path: 'Any', attrib: 'Any', flags: 'Any') -> 'Any': + def GetFileOverlayInfo(self, path: Any, attrib: Any, flags: Any) -> Any: """ Returns an index into the system image list for the icon @@ -29763,9 +29213,9 @@ Returns: Any """ - pass + ... - def GetReservedOverlayInfo(self, path: 'Any', attrib: 'Any', flags: 'Any', ireservedID: 'Any') -> 'None': + def GetReservedOverlayInfo(self, path: Any, attrib: Any, flags: Any, ireservedID: Any) -> None: """ Description of GetReservedOverlayInfo. @@ -29781,9 +29231,9 @@ Returns: None """ - pass + ... - def RefreshOverlayImages(self, flags: 'Any') -> 'None': + def RefreshOverlayImages(self, flags: Any) -> None: """ Description of RefreshOverlayImages. @@ -29796,9 +29246,9 @@ Returns: None """ - pass + ... - def LoadNonloadedOverlayIdentifiers(self,) -> 'None': + def LoadNonloadedOverlayIdentifiers(self) -> None: """ Description of LoadNonloadedOverlayIdentifiers. @@ -29811,9 +29261,9 @@ Returns: None """ - pass + ... - def OverlayIndexFromImageIndex(self, iImage: 'Any', fAdd: 'Any') -> 'None': + def OverlayIndexFromImageIndex(self, iImage: Any, fAdd: Any) -> None: """ Description of OverlayIndexFromImageIndex. @@ -29827,22 +29277,22 @@ Returns: None """ - pass + ... -class PyIShellItem(object): +class PyIShellItem: """Interface that represents an item in the Explorer shell""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def BindToHandler(self, pbc: 'Any', bhid: 'PyIID', riid: 'PyIID') -> 'Any': + def BindToHandler(self, pbc: Any, bhid: PyIID, riid: PyIID) -> Any: """ Creates an instance of one of the item's handlers Args: - pbc(Any):Used to pass parameters that influence the binding operation, can be None + pbc(Any):Used to ... parameters that influence the binding operation, can be None bhid(PyIID):GUID that identifies a handler (shell.BHID_*) riid(PyIID):The interface to return @@ -29851,9 +29301,9 @@ Returns: Any """ - pass + ... - def GetParent(self,) -> 'Any': + def GetParent(self) -> Any: """ Retrieves the parent of this item @@ -29866,9 +29316,9 @@ Returns: Any """ - pass + ... - def GetDisplayName(self, sigdnName: 'Any') -> 'Any': + def GetDisplayName(self, sigdnName: Any) -> Any: """ Returns the display name of the item in the specified format @@ -29881,9 +29331,9 @@ Returns: Any """ - pass + ... - def GetAttributes(self, Mask: 'Any') -> 'Any': + def GetAttributes(self, Mask: Any) -> Any: """ Returns shell attributes of the item @@ -29897,9 +29347,9 @@ Returns: """ - pass + ... - def Compare(self, psi: 'Any', hint: 'Any') -> 'Any': + def Compare(self, psi: Any, hint: Any) -> Any: """ Compares another shell item with this item @@ -29914,16 +29364,16 @@ Returns: """ - pass + ... -class PyIShellItem2(object): +class PyIShellItem2: """Extends the IShellItem interface, giving access to an item's properties""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetPropertyStore(self, Flags: 'Any', riid: 'PyIID') -> 'Any': + def GetPropertyStore(self, Flags: Any, riid: PyIID) -> Any: """ Returns a collection of the item's properties @@ -29937,9 +29387,9 @@ Returns: Any """ - pass + ... - def GetPropertyStoreForKeys(self, Keys: 'Tuple[Any, ...]', Flags: 'Any', riid: 'PyIID') -> 'Any': + def GetPropertyStoreForKeys(self, Keys: Tuple[Any, ...], Flags: Any, riid: PyIID) -> Any: """ Creates a property store containing just the @@ -29956,9 +29406,9 @@ Returns: Any """ - pass + ... - def GetPropertyStoreWithCreateObject(self, Flags: 'Any', CreateObject: 'Any', riid: 'PyIID') -> 'Any': + def GetPropertyStoreWithCreateObject(self, Flags: Any, CreateObject: Any, riid: PyIID) -> Any: """ Returns the property store for the @@ -29975,9 +29425,9 @@ Returns: Any """ - pass + ... - def GetPropertyDescriptionList(self, Type: 'Any', riid: 'PyIID') -> 'Any': + def GetPropertyDescriptionList(self, Type: Any, riid: PyIID) -> Any: """ Retrieves descriptions of @@ -29993,9 +29443,9 @@ Returns: Any """ - pass + ... - def Update(self, BindCtx: 'Any' = None) -> 'None': + def Update(self, BindCtx: Any = None) -> None: """ Refreshes properties that have been modified since interface was created @@ -30008,9 +29458,9 @@ Returns: None """ - pass + ... - def GetProperty(self, key: 'Any') -> 'Any': + def GetProperty(self, key: Any) -> Any: """ Retrieves the value of a property, converted to an appropriate python type @@ -30024,9 +29474,9 @@ Returns: """ - pass + ... - def GetCLSID(self, key: 'Any') -> 'PyIID': + def GetCLSID(self, key: Any) -> PyIID: """ Retrieves the value of a property as a CLSID (VT_CLSID) @@ -30039,9 +29489,9 @@ Returns: PyIID """ - pass + ... - def GetFileTime(self, key: 'Any') -> 'PyTime': + def GetFileTime(self, key: Any) -> PyTime: """ Retrieves the value of a property as a FILETIME @@ -30054,9 +29504,9 @@ Returns: PyTime """ - pass + ... - def GetInt32(self, key: 'Any') -> 'Any': + def GetInt32(self, key: Any) -> Any: """ Retrieves the value of a property as a 32 bit int. @@ -30069,9 +29519,9 @@ Returns: Any """ - pass + ... - def GetString(self, key: 'Any') -> 'Any': + def GetString(self, key: Any) -> Any: """ Retrieves the value of a property as a string @@ -30084,9 +29534,9 @@ Returns: Any """ - pass + ... - def GetUInt32(self, key: 'Any') -> 'Any': + def GetUInt32(self, key: Any) -> Any: """ Returns the value of a property as a 32 bit unsigned int @@ -30099,9 +29549,9 @@ Returns: Any """ - pass + ... - def GetUInt64(self, key: 'Any') -> 'Any': + def GetUInt64(self, key: Any) -> Any: """ Returns the value of a property as an unsigned 64-bit int @@ -30114,9 +29564,9 @@ Returns: Any """ - pass + ... - def GetBool(self, key: 'Any') -> 'Any': + def GetBool(self, key: Any) -> Any: """ Returns the value of a property as a boolean @@ -30129,16 +29579,16 @@ Returns: Any """ - pass + ... -class PyIShellItemArray(object): +class PyIShellItemArray: """Container for a number of shell items""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def BindToHandler(self, pbc: 'Any', rbhid: 'PyIID', riid: 'PyIID') -> 'Any': + def BindToHandler(self, pbc: Any, rbhid: PyIID, riid: PyIID) -> Any: """ Creates an instance of a handler for the items in the container @@ -30153,9 +29603,9 @@ Returns: Any """ - pass + ... - def GetPropertyStore(self, flags: 'Any', riid: 'PyIID') -> 'Any': + def GetPropertyStore(self, flags: Any, riid: PyIID) -> Any: """ Retrieves a store containing consolidated @@ -30171,9 +29621,9 @@ Returns: Any """ - pass + ... - def GetPropertyDescriptionList(self, Type: 'Any', riid: 'PyIID') -> 'Any': + def GetPropertyDescriptionList(self, Type: Any, riid: PyIID) -> Any: """ Retrieves descriptions for a @@ -30189,9 +29639,9 @@ Returns: Any """ - pass + ... - def GetAttributes(self, AttribFlags: 'Any', Mask: 'Any') -> 'Any': + def GetAttributes(self, AttribFlags: Any, Mask: Any) -> Any: """ Retrieves shell attributes of contained items @@ -30205,9 +29655,9 @@ Returns: Any """ - pass + ... - def GetCount(self,) -> 'Any': + def GetCount(self) -> Any: """ Returns the number of items in the container @@ -30220,9 +29670,9 @@ Returns: Any """ - pass + ... - def GetItemAt(self, dwIndex: 'Any') -> 'Any': + def GetItemAt(self, dwIndex: Any) -> Any: """ Retrieves an item by index @@ -30235,9 +29685,9 @@ Returns: Any """ - pass + ... - def EnumItems(self,) -> 'Any': + def EnumItems(self) -> Any: """ Returns an enumeration interface to list contained items @@ -30250,16 +29700,16 @@ Returns: Any """ - pass + ... -class PyIShellItemResources(object): +class PyIShellItemResources: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetAttributes(self,) -> 'None': + def GetAttributes(self) -> None: """ Description of GetAttributes. @@ -30272,9 +29722,9 @@ Returns: None """ - pass + ... - def GetSize(self,) -> 'Any': + def GetSize(self) -> Any: """ Description of GetSize. @@ -30287,9 +29737,9 @@ Returns: Any """ - pass + ... - def GetTimes(self,) -> 'None': + def GetTimes(self) -> None: """ Description of GetTimes. @@ -30302,9 +29752,9 @@ Returns: None """ - pass + ... - def SetTimes(self, pftCreation: 'PyTime', pftWrite: 'PyTime', pftAccess: 'PyTime') -> 'None': + def SetTimes(self, pftCreation: PyTime, pftWrite: PyTime, pftAccess: PyTime) -> None: """ Description of SetTimes. @@ -30319,9 +29769,9 @@ Returns: None """ - pass + ... - def GetResourceDescription(self, pcsir: 'Any') -> 'None': + def GetResourceDescription(self, pcsir: Any) -> None: """ Description of GetResourceDescription. @@ -30334,9 +29784,9 @@ Returns: None """ - pass + ... - def EnumResources(self,) -> 'Any': + def EnumResources(self) -> Any: """ Description of EnumResources. @@ -30349,9 +29799,9 @@ Returns: Any """ - pass + ... - def SupportsResource(self, pcsir: 'Any') -> 'Any': + def SupportsResource(self, pcsir: Any) -> Any: """ Description of SupportsResource. @@ -30364,9 +29814,9 @@ Returns: Any """ - pass + ... - def OpenResource(self, pcsir: 'Any', riid: 'PyIID') -> 'Any': + def OpenResource(self, pcsir: Any, riid: PyIID) -> Any: """ Description of OpenResource. @@ -30380,9 +29830,9 @@ Returns: Any """ - pass + ... - def CreateResource(self, sir: 'Any', riid: 'PyIID') -> 'Any': + def CreateResource(self, sir: Any, riid: PyIID) -> Any: """ Description of CreateResource. @@ -30396,9 +29846,9 @@ Returns: Any """ - pass + ... - def MarkForDelete(self,) -> 'None': + def MarkForDelete(self) -> None: """ Description of MarkForDelete. @@ -30411,16 +29861,16 @@ Returns: None """ - pass + ... -class PyIShellLibrary(object): +class PyIShellLibrary: """Interface used to access Libraries""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def LoadLibraryFromItem(self, Library: 'Any', Mode: 'Any') -> 'None': + def LoadLibraryFromItem(self, Library: Any, Mode: Any) -> None: """ Loads an existing library file @@ -30434,9 +29884,9 @@ Returns: None """ - pass + ... - def LoadLibraryFromKnownFolder(self, Library: 'PyIID', Mode: 'Any') -> 'None': + def LoadLibraryFromKnownFolder(self, Library: PyIID, Mode: Any) -> None: """ Initializes library from a known folder @@ -30450,9 +29900,9 @@ Returns: None """ - pass + ... - def AddFolder(self, Location: 'Any') -> 'None': + def AddFolder(self, Location: Any) -> None: """ Includes a folder @@ -30465,9 +29915,9 @@ Returns: None """ - pass + ... - def RemoveFolder(self, Location: 'Any') -> 'None': + def RemoveFolder(self, Location: Any) -> None: """ Removes a folder @@ -30480,9 +29930,9 @@ Returns: None """ - pass + ... - def GetFolders(self, Filter: 'Any', riid: 'PyIID') -> 'Any': + def GetFolders(self, Filter: Any, riid: PyIID) -> Any: """ Retrieves a collection of folders in the library @@ -30496,9 +29946,9 @@ Returns: Any """ - pass + ... - def ResolveFolder(self, FolderToResolve: 'Any', Timeout: 'Any', riid: 'PyIID') -> 'Any': + def ResolveFolder(self, FolderToResolve: Any, Timeout: Any, riid: PyIID) -> Any: """ Attempts to locate a folder that has been moved or renamed @@ -30513,9 +29963,9 @@ Returns: Any """ - pass + ... - def GetDefaultSaveFolder(self, Type: 'Any', riid: 'PyIID') -> 'Any': + def GetDefaultSaveFolder(self, Type: Any, riid: PyIID) -> Any: """ Returns the default folder in which new items are @@ -30531,9 +29981,9 @@ Returns: Any """ - pass + ... - def SetDefaultSaveFolder(self, Type: 'Any', SaveFolder: 'Any') -> 'None': + def SetDefaultSaveFolder(self, Type: Any, SaveFolder: Any) -> None: """ Sets the default save location @@ -30547,9 +29997,9 @@ Returns: None """ - pass + ... - def GetOptions(self,) -> 'Any': + def GetOptions(self) -> Any: """ Retrieves library option flags @@ -30566,9 +30016,9 @@ Return ValueReturns a combination of shellcon.LOF_* flags """ - pass + ... - def SetOptions(self, Mask: 'Any', Options: 'Any') -> 'None': + def SetOptions(self, Mask: Any, Options: Any) -> None: """ Sets library option flags @@ -30582,9 +30032,9 @@ Returns: None """ - pass + ... - def GetFolderType(self,) -> 'PyIID': + def GetFolderType(self) -> PyIID: """ Returns the library type, shell.FOLDERTYPEID_* @@ -30597,9 +30047,9 @@ Returns: PyIID """ - pass + ... - def SetFolderType(self, Type: 'PyIID') -> 'None': + def SetFolderType(self, Type: PyIID) -> None: """ Sets the folder type for the library @@ -30612,9 +30062,9 @@ Returns: None """ - pass + ... - def GetIcon(self,) -> 'Any': + def GetIcon(self) -> Any: """ Returns the location of the library's icon @@ -30631,9 +30081,9 @@ Return ValueUses "module,resource" format """ - pass + ... - def SetIcon(self, Icon: 'Any') -> 'None': + def SetIcon(self, Icon: Any) -> None: """ Sets the library icon @@ -30646,9 +30096,9 @@ Returns: None """ - pass + ... - def Commit(self,) -> 'None': + def Commit(self) -> None: """ Saves changes (only if loaded from an existing library) @@ -30661,9 +30111,9 @@ Returns: None """ - pass + ... - def Save(self, FolderToSaveIn: 'Any', LibraryName: 'Any', Flags: 'Any') -> 'Any': + def Save(self, FolderToSaveIn: Any, LibraryName: Any, Flags: Any) -> Any: """ Saves the library to a specific location @@ -30679,9 +30129,9 @@ Returns: """ - pass + ... - def SaveInKnownFolder(self, FolderToSaveIn: 'PyIID', LibraryName: 'Any', Flags: 'Any') -> 'Any': + def SaveInKnownFolder(self, FolderToSaveIn: PyIID, LibraryName: Any, Flags: Any) -> Any: """ Saves the library in a known folder @@ -30696,16 +30146,16 @@ Returns: Any """ - pass + ... -class PyIShellLink(object): +class PyIShellLink: """Interface used to access the properties of a shell link file (*.lnk)""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetPath(self, fFlags: 'Any', cchMaxPath: 'Any') -> 'Tuple[Any, WIN32_FIND_DATA]': + def GetPath(self, fFlags: Any, cchMaxPath: Any) -> Tuple[Any, WIN32_FIND_DATA]: """ Retrieves the target path and file name of a shell link @@ -30721,9 +30171,9 @@ Returns: Tuple[Any, WIN32_FIND_DATA] """ - pass + ... - def GetIDList(self,) -> 'Any': + def GetIDList(self) -> Any: """ Retrieves the item id list that identifies the target of the shell link. @@ -30736,9 +30186,9 @@ Returns: Any """ - pass + ... - def SetIDList(self, pidl: 'Any') -> 'None': + def SetIDList(self, pidl: Any) -> None: """ Sets the target of the link using an item id list @@ -30751,9 +30201,9 @@ Returns: None """ - pass + ... - def GetDescription(self, cchMaxName: 'Any' = 1024) -> 'Any': + def GetDescription(self, cchMaxName: Any = 1024) -> Any: """ Retrieves the description of the link (displays as Comment in the UI) @@ -30766,9 +30216,9 @@ Returns: Any """ - pass + ... - def SetDescription(self, Name: 'Any') -> 'None': + def SetDescription(self, Name: Any) -> None: """ Sets the description of the link (displays as Comment in the UI) @@ -30781,9 +30231,9 @@ Returns: None """ - pass + ... - def GetWorkingDirectory(self, cchMaxName: 'Any' = 1024) -> 'Any': + def GetWorkingDirectory(self, cchMaxName: Any = 1024) -> Any: """ Retrieves the working directory for the link @@ -30796,9 +30246,9 @@ Returns: Any """ - pass + ... - def SetWorkingDirectory(self, Dir: 'Any') -> 'None': + def SetWorkingDirectory(self, Dir: Any) -> None: """ Sets the working directory for the link. @@ -30811,9 +30261,9 @@ Returns: None """ - pass + ... - def GetArguments(self, cchMaxName: 'Any' = 1024) -> 'Any': + def GetArguments(self, cchMaxName: Any = 1024) -> Any: """ Retrieves the command-line arguments associated with a shell link object. @@ -30826,9 +30276,9 @@ Returns: Any """ - pass + ... - def SetArguments(self, args: 'Any') -> 'None': + def SetArguments(self, args: Any) -> None: """ Sets the command-line arguments associated with a shell link object. @@ -30841,9 +30291,9 @@ Returns: None """ - pass + ... - def GetHotkey(self,) -> 'Any': + def GetHotkey(self) -> Any: """ Retrieves the hot key for a shell link object. @@ -30856,9 +30306,9 @@ Returns: Any """ - pass + ... - def SetHotkey(self, wHotkey: 'Any') -> 'None': + def SetHotkey(self, wHotkey: Any) -> None: """ Sets the hot key for a shell link object. @@ -30871,9 +30321,9 @@ Returns: None """ - pass + ... - def GetShowCmd(self,) -> 'Any': + def GetShowCmd(self) -> Any: """ Retrieves the show (SW_) command for a shell link object. @@ -30886,9 +30336,9 @@ Returns: Any """ - pass + ... - def SetShowCmd(self, iShowCmd: 'Any') -> 'None': + def SetShowCmd(self, iShowCmd: Any) -> None: """ Sets the show (SW_) command for a shell link object. @@ -30901,9 +30351,9 @@ Returns: None """ - pass + ... - def GetIconLocation(self, cchMaxPath: 'Any') -> 'Any': + def GetIconLocation(self, cchMaxPath: Any) -> Any: """ Retrieves the location (path and index) of the icon for a shell link @@ -30918,9 +30368,9 @@ Returns: Any """ - pass + ... - def SetIconLocation(self, iconPath: 'str', iIcon: 'Any') -> 'None': + def SetIconLocation(self, iconPath: str, iIcon: Any) -> None: """ Sets the location (path and index) of the icon for a shell link object. @@ -30934,9 +30384,9 @@ Returns: None """ - pass + ... - def SetRelativePath(self, relPath: 'str', reserved: 'Any' = 0) -> 'None': + def SetRelativePath(self, relPath: str, reserved: Any = 0) -> None: """ Sets the relative path for a shell link object. @@ -30950,9 +30400,9 @@ Returns: None """ - pass + ... - def Resolve(self, hwnd: 'Any', fFlags: 'Any') -> 'None': + def Resolve(self, hwnd: Any, fFlags: Any) -> None: """ Resolves a shell link by searching for the shell link object and updating the @@ -30968,9 +30418,9 @@ Returns: None """ - pass + ... - def SetPath(self, path: 'str') -> 'None': + def SetPath(self, path: str) -> None: """ Sets the path and file name of a shell link object. @@ -30983,16 +30433,15 @@ Returns: None """ - pass + ... -class PyIShellLinkDataList(object): - """""" +class PyIShellLinkDataList: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def AddDataBlock(self, DataBlock: 'Any') -> 'None': + def AddDataBlock(self, DataBlock: Any) -> None: """ Inserts a data block into the link @@ -31005,9 +30454,9 @@ Returns: None """ - pass + ... - def CopyDataBlock(self, Sig: 'Any') -> 'Any': + def CopyDataBlock(self, Sig: Any) -> Any: """ Retrieves the specified data block from the link @@ -31021,9 +30470,9 @@ Returns: """ - pass + ... - def GetFlags(self,) -> 'Any': + def GetFlags(self) -> Any: """ Retrieves the link's flags @@ -31040,9 +30489,9 @@ Return ValueReturns combination of shellcon.SLDF_* flags """ - pass + ... - def RemoveDataBlock(self, Sig: 'Any') -> 'None': + def RemoveDataBlock(self, Sig: Any) -> None: """ Deletes one of the link's data blocks @@ -31055,9 +30504,9 @@ Returns: None """ - pass + ... - def SetFlags(self, Flags: 'Any') -> 'None': + def SetFlags(self, Flags: Any) -> None: """ Sets the flags indicating which data blocks are present @@ -31070,16 +30519,16 @@ Returns: None """ - pass + ... -class PyIShellView(object): +class PyIShellView: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def TranslateAccelerator(self, pmsg: 'Any') -> 'Any': + def TranslateAccelerator(self, pmsg: Any) -> Any: """ Description of TranslateAccelerator. @@ -31093,9 +30542,9 @@ Returns: """ - pass + ... - def EnableModeless(self, fEnable: 'Any') -> 'None': + def EnableModeless(self, fEnable: Any) -> None: """ Description of EnableModeless. @@ -31108,9 +30557,9 @@ Returns: None """ - pass + ... - def UIActivate(self, uState: 'Any') -> 'None': + def UIActivate(self, uState: Any) -> None: """ Description of UIActivate. @@ -31123,9 +30572,9 @@ Returns: None """ - pass + ... - def Refresh(self,) -> 'None': + def Refresh(self) -> None: """ Description of Refresh. @@ -31138,14 +30587,14 @@ Returns: None """ - pass + ... def CreateViewWindow( self, - psvPrevious: 'Any', - pfs: 'Tuple[Any, Any]', - psb: 'Any', - prcView: 'Tuple[Any, Any, Any, Any]') -> 'Any': + psvPrevious: Any, + pfs: Tuple[Any, Any], + psb: Any, + prcView: Tuple[Any, Any, Any, Any]) -> Any: """ Description of CreateViewWindow. @@ -31162,9 +30611,9 @@ Returns: """ - pass + ... - def DestroyViewWindow(self,) -> 'None': + def DestroyViewWindow(self) -> None: """ Description of DestroyViewWindow. @@ -31177,9 +30626,9 @@ Returns: None """ - pass + ... - def GetCurrentInfo(self,) -> 'Any': + def GetCurrentInfo(self) -> Any: """ Description of GetCurrentInfo. @@ -31192,9 +30641,9 @@ Returns: Any """ - pass + ... - def SaveViewState(self,) -> 'None': + def SaveViewState(self) -> None: """ Description of SaveViewState. @@ -31207,9 +30656,9 @@ Returns: None """ - pass + ... - def SelectItem(self, pidlItem: 'Any', uFlags: 'Any') -> 'None': + def SelectItem(self, pidlItem: Any, uFlags: Any) -> None: """ Description of SelectItem. @@ -31223,9 +30672,9 @@ Returns: None """ - pass + ... - def GetItemObject(self, uItem: 'Any', riid: 'PyIID') -> 'Any': + def GetItemObject(self, uItem: Any, riid: PyIID) -> Any: """ Description of GetItemObject. @@ -31239,16 +30688,16 @@ Returns: Any """ - pass + ... -class PyISpecifyPropertyPages(object): +class PyISpecifyPropertyPages: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetPages(self,) -> 'None': + def GetPages(self) -> None: """ Description of GetPages. @@ -31261,16 +30710,16 @@ Returns: None """ - pass + ... -class PyIStorage(object): +class PyIStorage: """Structured storage compound storage object""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CreateStream(self, Name: 'Any', Mode: 'Any', reserved1: 'Any' = 0, reserved2: 'Any' = 0) -> 'Any': + def CreateStream(self, Name: Any, Mode: Any, reserved1: Any = 0, reserved2: Any = 0) -> Any: """ Creates and opens a stream object with the specified name contained @@ -31290,9 +30739,9 @@ Returns: Any """ - pass + ... - def OpenStream(self, Name: 'Any', reserved1: 'Any', Mode: 'Any', reserved2: 'Any' = 0) -> 'Any': + def OpenStream(self, Name: Any, reserved1: Any, Mode: Any, reserved2: Any = 0) -> Any: """ Opens an existing stream object within this storage object in the @@ -31301,7 +30750,7 @@ specified access mode. Args: Name(Any):Name of stream to be opened - reserved1(Any):A reserved param. Always pass None. NULL is always passed to the COM function + reserved1(Any):A reserved param. Always ... None. NULL is always passed to the COM function Mode(Any):Access mode, storagecon.STGM_* reserved2(Any):Reserved - must be zero. @@ -31310,9 +30759,9 @@ Returns: Any """ - pass + ... - def CreateStorage(self, Name: 'Any', Mode: 'Any', StgFmt: 'Any', reserved2: 'Any' = 0) -> 'Any': + def CreateStorage(self, Name: Any, Mode: Any, StgFmt: Any, reserved2: Any = 0) -> Any: """ Creates and opens a new storage object nested within this storage @@ -31330,9 +30779,9 @@ Returns: Any """ - pass + ... - def OpenStorage(self, Name: 'Any', Priority: 'Any', Mode: 'Any', snbExclude: 'Any', reserved: 'Any' = 0) -> 'Any': + def OpenStorage(self, Name: Any, Priority: Any, Mode: Any, snbExclude: Any, reserved: Any = 0) -> Any: """ Opens an existing storage object with the specified name in the @@ -31351,9 +30800,9 @@ Returns: Any """ - pass + ... - def CopyTo(self, rgiidExclude: 'Tuple[Any, Any]', snbExclude: 'Any', stgDest: 'Any') -> 'None': + def CopyTo(self, rgiidExclude: Tuple[Any, Any], snbExclude: Any, stgDest: Any) -> None: """ Copies the entire contents of an open storage object to another storage object. @@ -31368,9 +30817,9 @@ Returns: None """ - pass + ... - def MoveElementTo(self, Name: 'Any', stgDest: 'Any', NewName: 'Any', Flags: 'Any') -> 'None': + def MoveElementTo(self, Name: Any, stgDest: Any, NewName: Any, Flags: Any) -> None: """ Copies or moves a substorage or stream from this storage object to another @@ -31388,9 +30837,9 @@ Returns: None """ - pass + ... - def Commit(self, grfCommitFlags: 'Any') -> 'None': + def Commit(self, grfCommitFlags: Any) -> None: """ Ensures that any changes made to a storage object open in transacted mode are reflected @@ -31409,9 +30858,9 @@ Returns: None """ - pass + ... - def Revert(self,) -> 'None': + def Revert(self) -> None: """ Discards all changes that have been made to the storage object since the last commit. @@ -31424,9 +30873,9 @@ Returns: None """ - pass + ... - def EnumElements(self, reserved1: 'Any' = 0, reserved2: 'Any' = None, reserved3: 'Any' = 0) -> 'Any': + def EnumElements(self, reserved1: Any = 0, reserved2: Any = None, reserved3: Any = 0) -> Any: """ Retrieves an enumerator object that can be used to enumerate the @@ -31435,7 +30884,7 @@ storage and stream objects contained within this storage object. Args: reserved1(Any):Reserved - must be zero. - reserved2(Any):A reserved param. Always pass None. NULL is always passed to the COM function + reserved2(Any):A reserved param. Always ... None. NULL is always passed to the COM function reserved3(Any):Reserved - must be zero. Returns: @@ -31443,9 +30892,9 @@ Returns: Any """ - pass + ... - def DestroyElement(self, name: 'str') -> 'None': + def DestroyElement(self, name: str) -> None: """ Removes the specified storage or stream from this storage object. @@ -31458,9 +30907,9 @@ Returns: None """ - pass + ... - def RenameElement(self, OldName: 'Any', NewName: 'Any') -> 'None': + def RenameElement(self, OldName: Any, NewName: Any) -> None: """ Renames the specified substorage or stream in this storage object. @@ -31474,9 +30923,9 @@ Returns: None """ - pass + ... - def SetElementTimes(self, name: 'Any', ctime: 'PyTime', atime: 'PyTime', mtime: 'PyTime') -> 'None': + def SetElementTimes(self, name: Any, ctime: PyTime, atime: PyTime, mtime: PyTime) -> None: """ Sets the modification, access, and creation times of the specified storage @@ -31494,9 +30943,9 @@ Returns: None """ - pass + ... - def SetClass(self, clsid: 'PyIID') -> 'None': + def SetClass(self, clsid: PyIID) -> None: """ Assigns the specified CLSID to this storage object. @@ -31509,9 +30958,9 @@ Returns: None """ - pass + ... - def SetStateBits(self, grfStateBits: 'Any', grfMask: 'Any') -> 'None': + def SetStateBits(self, grfStateBits: Any, grfMask: Any) -> None: """ Stores up to 32 bits of state information in this storage object. @@ -31525,9 +30974,9 @@ Returns: None """ - pass + ... - def Stat(self, grfStatFlag: 'Any') -> 'Any': + def Stat(self, grfStatFlag: Any) -> Any: """ Retrieves the STATSTG structure for this open storage object. @@ -31540,16 +30989,16 @@ Returns: Any """ - pass + ... -class PyIStream(object): +class PyIStream: """A Python interface to IStream""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Read(self, numBytes: 'Any') -> 'str': + def Read(self, numBytes: Any) -> str: """ Read the specified number of bytes from the string. @@ -31563,9 +31012,9 @@ Returns: """ - pass + ... - def read(self, numBytes: 'Any') -> 'str': + def read(self, numBytes: Any) -> str: """ Read the specified number of bytes from the string. @@ -31579,9 +31028,9 @@ Returns: """ - pass + ... - def Write(self, data: 'str') -> 'None': + def Write(self, data: str) -> None: """ Write data to a stream @@ -31594,9 +31043,9 @@ Returns: None """ - pass + ... - def write(self, data: 'str') -> 'None': + def write(self, data: str) -> None: """ Write data to a stream @@ -31609,9 +31058,9 @@ Returns: None """ - pass + ... - def Seek(self, offset: 'Any', origin: 'Any') -> 'ULARGE_INTEGER': + def Seek(self, offset: Any, origin: Any) -> ULARGE_INTEGER: """ Changes the seek pointer to a new location. @@ -31625,9 +31074,9 @@ Returns: ULARGE_INTEGER """ - pass + ... - def SetSize(self, newSize: 'ULARGE_INTEGER') -> 'None': + def SetSize(self, newSize: ULARGE_INTEGER) -> None: """ Changes the size of the stream object. @@ -31640,9 +31089,9 @@ Returns: None """ - pass + ... - def CopyTo(self, stream: 'Any', cb: 'ULARGE_INTEGER') -> 'ULARGE_INTEGER': + def CopyTo(self, stream: Any, cb: ULARGE_INTEGER) -> ULARGE_INTEGER: """ Copies a specified number of bytes from the current seek pointer in the @@ -31659,9 +31108,9 @@ Returns: """ - pass + ... - def Commit(self, flags: 'Any') -> 'None': + def Commit(self, flags: Any) -> None: """ Ensures that any changes made to a stream object open in transacted mode are reflected in @@ -31676,9 +31125,9 @@ Returns: None """ - pass + ... - def Revert(self,) -> 'None': + def Revert(self) -> None: """ None @@ -31691,9 +31140,9 @@ Returns: None """ - pass + ... - def LockRegion(self, offset: 'ULARGE_INTEGER', cb: 'ULARGE_INTEGER', lockType: 'Any') -> 'None': + def LockRegion(self, offset: ULARGE_INTEGER, cb: ULARGE_INTEGER, lockType: Any) -> None: """ Restricts access to a specified range of bytes in the stream. @@ -31708,9 +31157,9 @@ Returns: None """ - pass + ... - def UnLockRegion(self, offset: 'ULARGE_INTEGER', cb: 'ULARGE_INTEGER', lockType: 'Any') -> 'None': + def UnLockRegion(self, offset: ULARGE_INTEGER, cb: ULARGE_INTEGER, lockType: Any) -> None: """ None @@ -31725,9 +31174,9 @@ Returns: None """ - pass + ... - def Clone(self,) -> 'Any': + def Clone(self) -> Any: """ Creates a new stream object with its own seek pointer that references the @@ -31742,9 +31191,9 @@ Returns: Any """ - pass + ... - def Stat(self, grfStatFlag: 'Any' = 0) -> 'Any': + def Stat(self, grfStatFlag: Any = 0) -> Any: """ Returns information about the stream @@ -31757,16 +31206,16 @@ Returns: Any """ - pass + ... -class PyITask(object): +class PyITask: """Python object that encapsulates the ITask interface, inherits all the methods of PyIScheduledWorkItem""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def SetApplicationName(self, ApplicationName: 'Any') -> 'None': + def SetApplicationName(self, ApplicationName: Any) -> None: """ Specify which program the task will run @@ -31779,9 +31228,9 @@ Returns: None """ - pass + ... - def GetApplicationName(self,) -> 'Any': + def GetApplicationName(self) -> Any: """ Retrieve name of program that task will run @@ -31794,9 +31243,9 @@ Returns: Any """ - pass + ... - def SetParameters(self, Parameters: 'Any') -> 'None': + def SetParameters(self, Parameters: Any) -> None: """ Sets command line parameters @@ -31809,9 +31258,9 @@ Returns: None """ - pass + ... - def GetParameters(self,) -> 'Any': + def GetParameters(self) -> Any: """ Returns command line parameters for task @@ -31824,9 +31273,9 @@ Returns: Any """ - pass + ... - def SetWorkingDirectory(self, WorkingDirectory: 'Any') -> 'None': + def SetWorkingDirectory(self, WorkingDirectory: Any) -> None: """ Sets initial working directory for task @@ -31839,9 +31288,9 @@ Returns: None """ - pass + ... - def GetWorkingDirectory(self,) -> 'Any': + def GetWorkingDirectory(self) -> Any: """ Return working directory that the task will start out in @@ -31854,9 +31303,9 @@ Returns: Any """ - pass + ... - def SetPriority(self, Priority: 'Any') -> 'None': + def SetPriority(self, Priority: Any) -> None: """ Sets priority for task @@ -31869,9 +31318,9 @@ Returns: None """ - pass + ... - def GetPriority(self,) -> 'Any': + def GetPriority(self) -> Any: """ Gets priority that will be assigned to process when task starts @@ -31884,9 +31333,9 @@ Returns: Any """ - pass + ... - def SetTaskFlags(self, dwFlags: 'Any') -> 'None': + def SetTaskFlags(self, dwFlags: Any) -> None: """ Sets flag for task. @@ -31899,9 +31348,9 @@ Returns: None """ - pass + ... - def GetTaskFlags(self,) -> 'Any': + def GetTaskFlags(self) -> Any: """ Retrieve task flags (None currently defined) @@ -31914,9 +31363,9 @@ Returns: Any """ - pass + ... - def SetMaxRunTime(self, MaxRunTimeMS: 'Any') -> 'None': + def SetMaxRunTime(self, MaxRunTimeMS: Any) -> None: """ Sets maximun run time for task, use -1 to disable @@ -31929,9 +31378,9 @@ Returns: None """ - pass + ... - def GetMaxRunTime(self,) -> 'Any': + def GetMaxRunTime(self) -> Any: """ Returns maximun run time for task @@ -31944,16 +31393,16 @@ Returns: Any """ - pass + ... -class PyITaskScheduler(object): +class PyITaskScheduler: """Interface to the Windows Task Scheduler""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def SetTargetComputer(self, Computer: 'Any') -> 'None': + def SetTargetComputer(self, Computer: Any) -> None: """ Connect to another machine to manage its tasks @@ -31966,9 +31415,9 @@ Returns: None """ - pass + ... - def GetTargetComputer(self,) -> 'Any': + def GetTargetComputer(self) -> Any: """ Returns name of computer that the Task Scheduler is @@ -31983,9 +31432,9 @@ Returns: Any """ - pass + ... - def Enum(self,) -> 'Tuple[str, ...]': + def Enum(self) -> Tuple[str, ...]: """ Retrieve list of task names @@ -31998,9 +31447,9 @@ Returns: Tuple[str, ...] """ - pass + ... - def Activate(self, Name: 'Any', riid: 'PyIID') -> 'Any': + def Activate(self, Name: Any, riid: PyIID) -> Any: """ Opens the specified task and returns an ITask interface for it @@ -32014,9 +31463,9 @@ Returns: Any """ - pass + ... - def Delete(self, TaskName: 'Any') -> 'None': + def Delete(self, TaskName: Any) -> None: """ Delete task by name @@ -32029,9 +31478,9 @@ Returns: None """ - pass + ... - def NewWorkItem(self, TaskName: 'Any', rclsid: 'PyIID', riid: 'PyIID') -> 'Any': + def NewWorkItem(self, TaskName: Any, rclsid: PyIID, riid: PyIID) -> Any: """ Creates a new task @@ -32046,9 +31495,9 @@ Returns: Any """ - pass + ... - def AddWorkItem(self, TaskName: 'Any', WorkItem: 'Any') -> 'None': + def AddWorkItem(self, TaskName: Any, WorkItem: Any) -> None: """ Create a new scheduled task from PyITask object @@ -32062,9 +31511,9 @@ Returns: None """ - pass + ... - def IsOfType(self, Name: 'Any', riid: 'PyIID') -> 'None': + def IsOfType(self, Name: Any, riid: PyIID) -> None: """ Check if named object supports specified interface @@ -32078,16 +31527,16 @@ Returns: None """ - pass + ... -class PyITaskTrigger(object): +class PyITaskTrigger: """Python object that encapsulates the ITaskTrigger interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def SetTrigger(self, Trigger: 'Any') -> 'None': + def SetTrigger(self, Trigger: Any) -> None: """ Set trigger parameters from a PyTASK_TRIGGER object @@ -32100,9 +31549,9 @@ Returns: None """ - pass + ... - def GetTrigger(self,) -> 'Any': + def GetTrigger(self) -> Any: """ Retrieves trigger parms as a PyTASK_TRIGGER object @@ -32115,9 +31564,9 @@ Returns: Any """ - pass + ... - def GetTriggerString(self,) -> 'str': + def GetTriggerString(self) -> str: """ Build text summary of trigger @@ -32130,16 +31579,16 @@ Returns: str """ - pass + ... -class PyITaskbarList(object): +class PyITaskbarList: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def HrInit(self,) -> 'None': + def HrInit(self) -> None: """ Intializes the interface before use @@ -32152,9 +31601,9 @@ Returns: None """ - pass + ... - def AddTab(self, hwnd: 'int') -> 'None': + def AddTab(self, hwnd: int) -> None: """ Places a window on the taskbar @@ -32167,9 +31616,9 @@ Returns: None """ - pass + ... - def DeleteTab(self, hwnd: 'int') -> 'None': + def DeleteTab(self, hwnd: int) -> None: """ Removes a window from the taskbar @@ -32182,9 +31631,9 @@ Returns: None """ - pass + ... - def ActivateTab(self, hwnd: 'int') -> 'None': + def ActivateTab(self, hwnd: int) -> None: """ Marks a window as the active tab on the taskbar @@ -32197,9 +31646,9 @@ Returns: None """ - pass + ... - def SetActiveAlt(self, hwnd: 'int') -> 'None': + def SetActiveAlt(self, hwnd: int) -> None: """ Sets the window as the active tab, without displaying it as pressed on the @@ -32214,23 +31663,22 @@ Returns: None """ - pass + ... -class PyITransferAdviseSink(object): - """""" +class PyITransferAdviseSink: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') def UpdateProgress( self, - SizeCurrent: 'Any', - SizeTotal: 'Any', - FilesCurrent: 'Any', - FilesTotal: 'Any', - FoldersCurrent: 'Any', - FoldersTotal: 'Any') -> 'None': + SizeCurrent: Any, + SizeTotal: Any, + FilesCurrent: Any, + FilesTotal: Any, + FoldersCurrent: Any, + FoldersTotal: Any) -> None: """ Gives an estimate of amount of work completed @@ -32248,9 +31696,9 @@ Returns: None """ - pass + ... - def UpdateTransferState(self, State: 'Any') -> 'None': + def UpdateTransferState(self, State: Any) -> None: """ Notifies client of current operation state @@ -32263,9 +31711,9 @@ Returns: None """ - pass + ... - def ConfirmOverwrite(self, Source: 'Any', DestParent: 'Any', Name: 'Any') -> 'Any': + def ConfirmOverwrite(self, Source: Any, DestParent: Any, Name: Any) -> Any: """ Asks user for permission to overwrite an existing item @@ -32280,9 +31728,9 @@ Returns: Any """ - pass + ... - def ConfirmEncryptionLoss(self, Source: 'Any') -> 'Any': + def ConfirmEncryptionLoss(self, Source: Any) -> Any: """ Notifies user when an item can't be encrypted at @@ -32297,9 +31745,9 @@ Returns: Any """ - pass + ... - def FileFailure(self, Item: 'Any', ItemName: 'Any', Error: 'Any') -> 'Tuple[Any, Any]': + def FileFailure(self, Item: Any, ItemName: Any, Error: Any) -> Tuple[Any, Any]: """ Notifies user of failure, and queries how to proceed @@ -32315,9 +31763,9 @@ Returns: """ - pass + ... - def SubStreamFailure(self, Item: 'Any', StreamName: 'Any', Error: 'Any') -> 'Any': + def SubStreamFailure(self, Item: Any, StreamName: Any, Error: Any) -> Any: """ Notifies user of failure on a substream, and queries how to @@ -32335,9 +31783,9 @@ Returns: """ - pass + ... - def PropertyFailure(self, Item: 'Any', key: 'Any', Error: 'Any') -> 'Any': + def PropertyFailure(self, Item: Any, key: Any, Error: Any) -> Any: """ Notifies user of failure to set an item's properties @@ -32355,16 +31803,16 @@ COPYENGINE_E_USERCANCELLED to cancel pending operations """ - pass + ... -class PyITransferDestination(object): +class PyITransferDestination: """Implemented by shell extensions that act as targets for item copy or move operations""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Advise(self, Sink: 'Any') -> 'Any': + def Advise(self, Sink: Any) -> Any: """ Connects an advise sink @@ -32378,9 +31826,9 @@ Returns: """ - pass + ... - def Unadvise(self, Cookie: 'Any') -> 'None': + def Unadvise(self, Cookie: Any) -> None: """ Disconnects an advise sink @@ -32393,10 +31841,10 @@ Returns: None """ - pass + ... - def CreateItem(self, Name: 'Any', Attributes: 'Any', Size: 'Any', Flags: 'Any', - riidItem: 'PyIID', riidResources: 'PyIID') -> 'Tuple[Any, Any, Any]': + def CreateItem(self, Name: Any, Attributes: Any, Size: Any, Flags: Any, + riidItem: PyIID, riidResources: PyIID) -> Tuple[Any, Any, Any]: """ Requests that a new item be created @@ -32418,23 +31866,23 @@ function returns one of the informational codes (shellcon.COPYENGINE_S_*) """ - pass + ... -class PyITransferMediumItem(object): +class PyITransferMediumItem: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyITransferSource(object): +class PyITransferSource: """Implemented by shell folders that can act as the source of shell item operations""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Advise(self, Sink: 'Any') -> 'Any': + def Advise(self, Sink: Any) -> Any: """ Connects an advise sink to receive notifications @@ -32447,9 +31895,9 @@ Returns: Any """ - pass + ... - def Unadvise(self, Cookie: 'Any') -> 'None': + def Unadvise(self, Cookie: Any) -> None: """ Disconnects an event sink @@ -32462,9 +31910,9 @@ Returns: None """ - pass + ... - def SetProperties(self, proparray: 'Any') -> 'None': + def SetProperties(self, proparray: Any) -> None: """ Specifies changes to be applied to items' properties @@ -32477,9 +31925,9 @@ Returns: None """ - pass + ... - def OpenItem(self, Item: 'Any', flags: 'Any', riid: 'PyIID') -> 'Tuple[Any, Any]': + def OpenItem(self, Item: Any, flags: Any, riid: PyIID) -> Tuple[Any, Any]: """ Initiates the copying of an item @@ -32494,9 +31942,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def MoveItem(self, Item: 'Any', ParentDst: 'Any', NameDst: 'Any', flags: 'Any') -> 'Tuple[Any, Any]': + def MoveItem(self, Item: Any, ParentDst: Any, NameDst: Any, flags: Any) -> Tuple[Any, Any]: """ Moves a shell item into another folder @@ -32517,9 +31965,9 @@ of expected actions for specific error codes. """ - pass + ... - def RecycleItem(self, Source: 'Any', ParentDest: 'Any', flags: 'Any') -> 'Tuple[Any, Any]': + def RecycleItem(self, Source: Any, ParentDest: Any, flags: Any) -> Tuple[Any, Any]: """ Moves an item to the recycle bin @@ -32534,9 +31982,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def RemoveItem(self, Source: 'Any', flags: 'Any') -> 'Any': + def RemoveItem(self, Source: Any, flags: Any) -> Any: """ Deletes an item without recycling @@ -32551,9 +31999,9 @@ Returns: """ - pass + ... - def RenameItem(self, Source: 'Any', NewName: 'Any', flags: 'Any') -> 'Tuple[Any, Any]': + def RenameItem(self, Source: Any, NewName: Any, flags: Any) -> Tuple[Any, Any]: """ Renames a shell item @@ -32568,9 +32016,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def LinkItem(self, Source: 'Any', ParentDest: 'Any', NewName: 'Any', flags: 'Any') -> 'Tuple[Any, Any]': + def LinkItem(self, Source: Any, ParentDest: Any, NewName: Any, flags: Any) -> Tuple[Any, Any]: """ Not implemented, according to MSDN @@ -32586,9 +32034,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def ApplyPropertiesToItem(self, Source: 'Any') -> 'Any': + def ApplyPropertiesToItem(self, Source: Any) -> Any: """ None @@ -32601,9 +32049,9 @@ Returns: Any """ - pass + ... - def GetDefaultDestinationName(self, Source: 'Any', ParentDest: 'Any') -> 'Any': + def GetDefaultDestinationName(self, Source: Any, ParentDest: Any) -> Any: """ Determines the name of an item as it would appear in a @@ -32619,9 +32067,9 @@ Returns: Any """ - pass + ... - def EnterFolder(self, ChildFolderDest: 'Any') -> 'Any': + def EnterFolder(self, ChildFolderDest: Any) -> Any: """ Informs the copy engine that a folder will be the target of a file @@ -32636,9 +32084,9 @@ Returns: Any """ - pass + ... - def LeaveFolder(self, ChildFolderDest: 'Any') -> 'Any': + def LeaveFolder(self, ChildFolderDest: Any) -> Any: """ Informs the copy engine that the operation on a destination folder is @@ -32653,16 +32101,16 @@ Returns: Any """ - pass + ... -class PyITypeComp(object): +class PyITypeComp: """An object that implements the ITypeComp interface.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Bind(self, szName: 'str', wflags: 'Any' = 0) -> 'Any': + def Bind(self, szName: str, wflags: Any = 0) -> Any: """ binds to a variable/type @@ -32676,9 +32124,9 @@ Returns: Any """ - pass + ... - def BindType(self, szName: 'str') -> 'Any': + def BindType(self, szName: str) -> Any: """ binds to a type @@ -32691,16 +32139,15 @@ Returns: Any """ - pass + ... -class PyITypeInfo(object): - """""" +class PyITypeInfo: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetContainingTypeLib(self,) -> 'Tuple[Any, Any]': + def GetContainingTypeLib(self) -> Tuple[Any, Any]: """ Retrieves the containing type library and the index of @@ -32715,9 +32162,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def GetDocumentation(self, memberId: 'Any') -> 'Tuple[Any, Any, Any, Any]': + def GetDocumentation(self, memberId: Any) -> Tuple[Any, Any, Any, Any]: """ Retrieves the documentation string, @@ -32732,9 +32179,9 @@ Returns: Tuple[Any, Any, Any, Any] """ - pass + ... - def GetFuncDesc(self, memberId: 'Any') -> 'Any': + def GetFuncDesc(self, memberId: Any) -> Any: """ None @@ -32747,9 +32194,9 @@ Returns: Any """ - pass + ... - def GetImplTypeFlags(self, index: 'Any') -> 'Any': + def GetImplTypeFlags(self, index: Any) -> Any: """ Retrieves the IMPLTYPEFLAGS enumeration for one implemented interface or @@ -32764,9 +32211,9 @@ Returns: Any """ - pass + ... - def GetIDsOfNames(self,) -> 'Any': + def GetIDsOfNames(self) -> Any: """ Maps between member names and member IDs, and parameter names and parameter @@ -32781,9 +32228,9 @@ Returns: Any """ - pass + ... - def GetNames(self, memberId: 'Any') -> 'Any': + def GetNames(self, memberId: Any) -> Any: """ Retrieves the variable with the specified member ID (or the name of @@ -32798,9 +32245,9 @@ Returns: Any """ - pass + ... - def GetTypeAttr(self,) -> 'Any': + def GetTypeAttr(self) -> Any: """ None @@ -32813,9 +32260,9 @@ Returns: Any """ - pass + ... - def GetRefTypeInfo(self, hRefType: 'Any') -> 'Any': + def GetRefTypeInfo(self, hRefType: Any) -> Any: """ If a type description references other type descriptions, it @@ -32830,9 +32277,9 @@ Returns: Any """ - pass + ... - def GetRefTypeOfImplType(self, hRefType: 'Any') -> 'Any': + def GetRefTypeOfImplType(self, hRefType: Any) -> Any: """ Retrieves the type description of the implemented interface types. @@ -32845,9 +32292,9 @@ Returns: Any """ - pass + ... - def GetVarDesc(self, memberId: 'Any') -> 'Any': + def GetVarDesc(self, memberId: Any) -> Any: """ None @@ -32860,9 +32307,9 @@ Returns: Any """ - pass + ... - def GetTypeComp(self,) -> 'Any': + def GetTypeComp(self) -> Any: """ None @@ -32875,16 +32322,16 @@ Returns: Any """ - pass + ... -class PyITypeLib(object): +class PyITypeLib: """An object that implements the ITypeLib interface.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetDocumentation(self, index: 'Any') -> 'Any': + def GetDocumentation(self, index: Any) -> Any: """ Retrieves documentation information about the library. @@ -32898,9 +32345,9 @@ Returns: """ - pass + ... - def GetLibAttr(self,) -> 'Any': + def GetLibAttr(self) -> Any: """ Retrieves the libraries attributes @@ -32913,9 +32360,9 @@ Returns: Any """ - pass + ... - def GetTypeComp(self,) -> 'Any': + def GetTypeComp(self) -> Any: """ None @@ -32928,9 +32375,9 @@ Returns: Any """ - pass + ... - def GetTypeInfo(self, index: 'Any') -> 'Any': + def GetTypeInfo(self, index: Any) -> Any: """ Retrieves the specified type description in the library. @@ -32943,9 +32390,9 @@ Returns: Any """ - pass + ... - def GetTypeInfoCount(self,) -> 'Any': + def GetTypeInfoCount(self) -> Any: """ None @@ -32958,9 +32405,9 @@ Returns: Any """ - pass + ... - def GetTypeInfoOfGuid(self, iid: 'PyIID') -> 'Any': + def GetTypeInfoOfGuid(self, iid: PyIID) -> Any: """ Retrieves the type info of the specified GUID. @@ -32973,9 +32420,9 @@ Returns: Any """ - pass + ... - def GetTypeInfoType(self, index: 'Any') -> 'Any': + def GetTypeInfoType(self, index: Any) -> Any: """ Retrieves the type of a type description. @@ -32988,16 +32435,16 @@ Returns: Any """ - pass + ... -class PyIUniformResourceLocator(object): +class PyIUniformResourceLocator: """Interface to an internet shortcut""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetURL(self,) -> 'Any': + def GetURL(self) -> Any: """ Returns the URL for the shortcut @@ -33010,9 +32457,9 @@ Returns: Any """ - pass + ... - def SetURL(self, URL: 'Any', InFlags: 'Any' = 0) -> 'None': + def SetURL(self, URL: Any, InFlags: Any = 0) -> None: """ Sets the URL for the shortcut @@ -33026,9 +32473,9 @@ Returns: None """ - pass + ... - def InvokeCommand(self, Verb: 'Any', Flags: 'Any' = 0, hwndParent: 'int' = 0) -> 'Any': + def InvokeCommand(self, Verb: Any, Flags: Any = 0, hwndParent: int = 0) -> Any: """ Performs one of the object's predefined actions @@ -33043,16 +32490,16 @@ Returns: Any """ - pass + ... -class PyIUnknown(object): +class PyIUnknown: """The base object for all PythonCOM objects. Wraps a COM IUnknown object.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def QueryInterface(self, iid: 'Any', useIID: 'Any' = None) -> 'Any': + def QueryInterface(self, iid: Any, useIID: Any = None) -> Any: """ Queries an object for a specific interface. @@ -33099,10 +32546,10 @@ Any error (including E_NOINTERFACE) will generate a com_error exception. """ - pass + ... -class PyIViewObject(object): +class PyIViewObject: """Description of the interface""" def __new__(cls): @@ -33110,15 +32557,15 @@ class PyIViewObject(object): def Draw( self, - dwDrawAspect: 'Any', - lindex: 'Any', - aspectFlags: 'Any', - hdcTargetDev: 'Any', - hdcDraw: 'Any', - arg: 'Tuple[Any, Any, Any, Any]', - arg1: 'Tuple[Any, Any, Any, Any]', - funcContinue: 'Any', - obContinue: 'Any') -> 'None': + dwDrawAspect: Any, + lindex: Any, + aspectFlags: Any, + hdcTargetDev: Any, + hdcDraw: Any, + arg: Tuple[Any, Any, Any, Any], + arg1: Tuple[Any, Any, Any, Any], + funcContinue: Any, + obContinue: Any) -> None: """ Description of Draw. @@ -33139,9 +32586,9 @@ Returns: None """ - pass + ... - def GetColorSet(self, dwDrawAspect: 'Any', lindex: 'Any', aspectFlags: 'Any', hicTargetDev: 'Any') -> 'None': + def GetColorSet(self, dwDrawAspect: Any, lindex: Any, aspectFlags: Any, hicTargetDev: Any) -> None: """ Description of GetColorSet. @@ -33157,9 +32604,9 @@ Returns: None """ - pass + ... - def Freeze(self, dwDrawAspect: 'Any', lindex: 'Any', aspectFlags: 'Any') -> 'None': + def Freeze(self, dwDrawAspect: Any, lindex: Any, aspectFlags: Any) -> None: """ Description of Freeze. @@ -33174,9 +32621,9 @@ Returns: None """ - pass + ... - def Unfreeze(self, dwFreeze: 'Any') -> 'None': + def Unfreeze(self, dwFreeze: Any) -> None: """ Description of Unfreeze. @@ -33189,9 +32636,9 @@ Returns: None """ - pass + ... - def SetAdvise(self, aspects: 'Any', advf: 'Any', pAdvSink: 'Any') -> 'None': + def SetAdvise(self, aspects: Any, advf: Any, pAdvSink: Any) -> None: """ Description of SetAdvise. @@ -33206,9 +32653,9 @@ Returns: None """ - pass + ... - def GetAdvise(self,) -> 'None': + def GetAdvise(self) -> None: """ Description of GetAdvise. @@ -33221,16 +32668,16 @@ Returns: None """ - pass + ... -class PyIViewObject2(object): +class PyIViewObject2: """Description of the interface""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetExtent(self, dwDrawAspect: 'Any', lindex: 'Any', targetDevice: 'Any') -> 'None': + def GetExtent(self, dwDrawAspect: Any, lindex: Any, targetDevice: Any) -> None: """ Description of GetExtent. @@ -33245,42 +32692,40 @@ Returns: None """ - pass + ... -class PyMAPINAMEIDArray(object): - """""" +class PyMAPINAMEIDArray: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyOLEMENUGROUPWIDTHS(object): +class PyOLEMENUGROUPWIDTHS: """Tuple containing 6 ints indicating nbr of options in each menu group""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyPROPERTYKEY(object): +class PyPROPERTYKEY: """A tuple of a fmtid and property id (IID, int) that uniquely identifies a property""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyPROPVARIANT(object): - """""" +class PyPROPVARIANT: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def vt(self) -> 'Any': + def vt(self) -> Any: """The variant type, a combination of VARENUM values including flags. (read only)MethodsGetValueReturns an object representing the variant value ToStringReturns the value as a string ChangeTypeCoerce to a different variant type """ - pass + ... - def GetValue(self,) -> 'Any': + def GetValue(self) -> Any: """ Returns an object representing the variant value @@ -33293,9 +32738,9 @@ Returns: Any """ - pass + ... - def ToString(self,) -> 'Any': + def ToString(self) -> Any: """ Returns the value as a string @@ -33308,9 +32753,9 @@ Returns: Any """ - pass + ... - def ChangeType(self, Type: 'Any', Flags: 'Any' = 0) -> 'Any': + def ChangeType(self, Type: Any, Flags: Any = 0) -> Any: """ Coerce to a different variant type @@ -33324,73 +32769,66 @@ Returns: Any """ - pass + ... -class PySAndRestriction(object): - """""" +class PySAndRestriction: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PySBinaryArray(object): +class PySBinaryArray: """A sequence of strings containing binary data.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PySBitMaskRestriction(object): - """""" +class PySBitMaskRestriction: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PySContentRestriction(object): - """""" +class PySContentRestriction: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PySExistRestriction(object): - """""" +class PySExistRestriction: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PySHELL_ITEM_RESOURCE(object): - """""" +class PySHELL_ITEM_RESOURCE: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PySNotRestriction(object): - """""" +class PySNotRestriction: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PySOrRestriction(object): - """""" +class PySOrRestriction: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PySPropTagArray(object): +class PySPropTagArray: """A sequence of integers""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PySPropValue(object): +class PySPropValue: """A MAPI property value. Property values can either be passed from python into MAPI functions, or returned from MAPI functions to Python.""" @@ -33399,77 +32837,72 @@ python into MAPI functions, or returned from MAPI functions to Python.""" raise Exception('This class just for typing, can not be instanced!') -class PySPropValueArray(object): - """""" +class PySPropValueArray: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PySPropertyRestriction(object): - """""" +class PySPropertyRestriction: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PySRestriction(object): - """""" +class PySRestriction: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PySRow(object): - """""" +class PySRow: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PySRowSet(object): - """""" +class PySRowSet: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PySSortOrderItem(object): +class PySSortOrderItem: """An item in a SortOrderSet.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PySSortOrderSet(object): +class PySSortOrderSet: """An object describing a SortOrderSet.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PySTGMEDIUM(object): +class PySTGMEDIUM: """A STGMEDIUM object represents a COM STGMEDIUM structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def tymed(self) -> 'Any': + def tymed(self) -> Any: """An integer indicating the type of data in the stgmedium""" - pass + ... @property - def data(self) -> 'Any': + def data(self) -> Any: """The data in the stgmedium. The result depends on the value of the 'tymed' property of the PySTGMEDIUM object.tymedResult TypeTYMED_GDIAn integer GDI handleTYMED_MFPICTAn integer METAFILE handleTYMED_ENHMFAn integer ENHMETAFILE handleTYMED_HGLOBALA string with the bytes of the global memory object.TYMED_FILEA string/unicode filenameTYMED_ISTREAMA PyIStream objectTYMED_ISTORAGEA PyIStorage object""" - pass + ... @property - def data_handle(self) -> 'Any': + def data_handle(self) -> Any: """The raw 'integer' representation of the data. For TYMED_HGLOBAL, this is the handle rather than the string data. For the string and interface types, this is an integer holding the pointer.""" - pass + ... - def set(self, tymed: 'Any', data: 'Any') -> 'None': + def set(self, tymed: Any, data: Any) -> None: """ Sets the type and data of the object. @@ -33483,24 +32916,24 @@ Returns: None """ - pass + ... -class PyTASK_TRIGGER(object): +class PyTASK_TRIGGER: """Python object representing a TASK_TRIGGER structure via the structmember Api""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class RTF_WCSINFO(object): +class RTF_WCSINFO: """A tuple representing a RTF_WCSINFO structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class SHFILEINFO(object): +class SHFILEINFO: """A tuple representing a SHFILEINFO structure Represented as a tuple of (hIcon, iIcon, dwAttributes, displayName, typeName)""" @@ -33509,136 +32942,135 @@ Represented as a tuple of (hIcon, iIcon, dwAttributes, displayName, typeName)""" raise Exception('This class just for typing, can not be instanced!') -class SHFILEOPSTRUCT(object): - """""" +class SHFILEOPSTRUCT: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class SI_ACCESS(object): +class SI_ACCESS: """Tuple of 4 items representing SI_ACCESS struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class SI_INHERIT_TYPE(object): +class SI_INHERIT_TYPE: """Tuple of 3 items describing a method of inheritance""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class SI_OBJECT_INFO(object): +class SI_OBJECT_INFO: """Six-tuple representing SI_OBJECT_INFO struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class STATSTG(object): +class STATSTG: """A tuple representing a STATSTG structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class TLIBATTR(object): +class TLIBATTR: """Type library attributes are represented as a tuple of:""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class TYPEATTR(object): +class TYPEATTR: """A TYPEATTR object represents a COM TYPEATTR structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def iid(self) -> 'PyIID': + def iid(self) -> PyIID: """The IID""" - pass + ... @property - def lcid(self) -> 'Any': + def lcid(self) -> Any: """The lcid""" - pass + ... @property - def memidConstructor(self) -> 'Any': + def memidConstructor(self) -> Any: """ID of constructor""" - pass + ... @property - def memidDestructor(self) -> 'Any': + def memidDestructor(self) -> Any: """ID of destructor""" - pass + ... @property - def cbSizeInstance(self) -> 'Any': + def cbSizeInstance(self) -> Any: """The size of an instance of this type""" - pass + ... @property - def typekind(self) -> 'Any': + def typekind(self) -> Any: """The kind of type this information describes. One of the win32con.TKIND_* constants.""" - pass + ... @property - def cFuncs(self) -> 'Any': + def cFuncs(self) -> Any: """Number of functions.""" - pass + ... @property - def cVars(self) -> 'Any': + def cVars(self) -> Any: """Number of variables/data members.""" - pass + ... @property - def cImplTypes(self) -> 'Any': + def cImplTypes(self) -> Any: """Number of implemented interfaces.""" - pass + ... @property - def cbSizeVft(self) -> 'Any': + def cbSizeVft(self) -> Any: """The size of this type's VTBL""" - pass + ... @property - def cbAlignment(self) -> 'Any': + def cbAlignment(self) -> Any: """Byte alignment for an instance of this type.""" - pass + ... @property - def wTypeFlags(self) -> 'Any': + def wTypeFlags(self) -> Any: """One of the pythoncom TYPEFLAG_""" - pass + ... @property - def wMajorVerNum(self) -> 'Any': + def wMajorVerNum(self) -> Any: """Major version number.""" - pass + ... @property - def wMinorVerNum(self) -> 'Any': + def wMinorVerNum(self) -> Any: """Minor version number.""" - pass + ... @property - def tdescAlias(self) -> 'Any': + def tdescAlias(self) -> Any: """If TypeKind == pythoncom.TKIND_ALIAS, specifies the type for which this type is an alias.""" - pass + ... @property - def idldeskType(self) -> 'Any': + def idldeskType(self) -> Any: """IDL attributes of the described type.""" - pass + ... -class TYPEDESC(object): +class TYPEDESC: """A typedesc is a complicated, recursive object, It may be either a simple Python type, or a tuple of (indirectType, object), where object @@ -33649,87 +33081,85 @@ may be a simple Python type, or a tuple of etc ...""" raise Exception('This class just for typing, can not be instanced!') -class VARDESC(object): +class VARDESC: """A VARDESC object represents a COM VARDESC structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def memid(self) -> 'Any': + def memid(self) -> Any: """The dispid of the member""" - pass + ... @property - def value(self) -> 'Union[Any]': + def value(self) -> Any: """A value for the variant. If PERINSTANCE then an offset into the instance, otherwise a variant converted to a Python object.""" - pass + ... @property - def elemdescVar(self) -> 'Any': + def elemdescVar(self) -> Any: """Object describing the member.""" - pass + ... @property - def varFlags(self) -> 'Any': + def varFlags(self) -> Any: """Variable flags""" - pass + ... @property - def varkind(self) -> 'Any': + def varkind(self) -> Any: """Kind flags.""" - pass + ... -class CHARFORMAT(object): +class CHARFORMAT: """Describes a CHARFORMAT tuple""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class CREATESTRUCT(object): +class CREATESTRUCT: """A representation of a Windows CREATESTRUCT structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class LV_COLUMN(object): - """""" +class LV_COLUMN: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class LV_ITEM(object): - """""" +class LV_ITEM: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PARAFORMAT(object): +class PARAFORMAT: """Describes a PARAFORMAT tuple""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyAssocCObject(object): +class PyAssocCObject: """An internal class.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyAssocObject(object): +class PyAssocObject: """An internal class.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def AttachObject(self,) -> 'None': + def AttachObject(self) -> None: """ Attaches a Python object for lookup of "virtual" functions. @@ -33742,9 +33172,9 @@ Returns: None """ - pass + ... - def GetAttachedObject(self,) -> 'Any': + def GetAttachedObject(self) -> Any: """ Returned the attached Python object, or None. @@ -33757,16 +33187,15 @@ Returns: Any """ - pass + ... -class PyCBitmap(object): - """""" +class PyCBitmap: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CreateCompatibleBitmap(self, dc: 'Any', width: 'Any', height: 'Any') -> 'None': + def CreateCompatibleBitmap(self, dc: Any, width: Any, height: Any) -> None: """ Creates a bitmap compatible with the specified device context. @@ -33781,9 +33210,9 @@ Returns: None """ - pass + ... - def GetSize(self,) -> 'Tuple[Any, Any]': + def GetSize(self) -> Tuple[Any, Any]: """ Returns the size of the bitmap object. @@ -33796,9 +33225,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def GetHandle(self,) -> 'Any': + def GetHandle(self) -> Any: """ Returns the HBITMAP for a bitmap object @@ -33811,9 +33240,9 @@ Returns: Any """ - pass + ... - def LoadBitmap(self, idRes: 'Any', obDLL: 'Any' = None) -> 'None': + def LoadBitmap(self, idRes: Any, obDLL: Any = None) -> None: """ Loads a bitmap from a DLL object. @@ -33827,9 +33256,9 @@ Returns: None """ - pass + ... - def LoadBitmapFile(self, fileObject: 'Any') -> 'None': + def LoadBitmapFile(self, fileObject: Any) -> None: """ Loads a bitmap (.BMP) format @@ -33844,9 +33273,9 @@ Returns: None """ - pass + ... - def LoadPPMFile(self, fileObject: 'Any', cols: 'Any', rows: 'Any') -> 'None': + def LoadPPMFile(self, fileObject: Any, cols: Any, rows: Any) -> None: """ Loads a bitmap in Portable Pix Map (PPM) format @@ -33863,9 +33292,9 @@ Returns: None """ - pass + ... - def Paint(self, dcObject: 'Any', arg: 'Tuple[Any, Any, Any, Any]', arg1: 'Tuple[Any, Any, Any, Any]') -> 'None': + def Paint(self, dcObject: Any, arg: Tuple[Any, Any, Any, Any], arg1: Tuple[Any, Any, Any, Any]) -> None: """ Paint a bitmap. @@ -33880,9 +33309,9 @@ Returns: None """ - pass + ... - def GetInfo(self,) -> 'Any': + def GetInfo(self) -> Any: """ Returns the BITMAP structure info @@ -33911,9 +33340,9 @@ bmBitsPixel """ - pass + ... - def GetBitmapBits(self, asString: 'Any' = 0) -> 'Union[Any, str]': + def GetBitmapBits(self, asString: Any = 0) -> Union[Any, str]: """ Returns the bitmap bits. @@ -33926,9 +33355,9 @@ Returns: Union[Any, str] """ - pass + ... - def SaveBitmapFile(self, dcObject: 'Any', Filename: 'str') -> 'Any': + def SaveBitmapFile(self, dcObject: Any, Filename: str) -> Any: """ Saves a bitmap to a file. @@ -33942,16 +33371,16 @@ Returns: Any """ - pass + ... -class PyCBrush(object): +class PyCBrush: """An object encapsulating an MFC PyCBrush class.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CreateSolidBrush(self,) -> 'None': + def CreateSolidBrush(self) -> None: """ Initializes a brush with a specified solid color. @@ -33964,9 +33393,9 @@ Returns: None """ - pass + ... - def GetSafeHandle(self,) -> 'Any': + def GetSafeHandle(self) -> Any: """ Retrieves the HBRUSH for the brush as an integer @@ -33979,22 +33408,21 @@ Returns: Any """ - pass + ... -class PyCButton(object): - """""" +class PyCButton: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') def CreateWindow( self, - caption: 'str', - style: 'Any', - rect: 'Tuple[Any, Any, Any, Any]', - parent: 'Any', - _id: 'Any') -> 'None': + caption: str, + style: Any, + rect: Tuple[Any, Any, Any, Any], + parent: Any, + _id: Any) -> None: """ Creates the window for a new button object. @@ -34011,9 +33439,9 @@ Returns: None """ - pass + ... - def GetBitmap(self,) -> 'Any': + def GetBitmap(self) -> Any: """ Get the button's bitmap @@ -34026,9 +33454,9 @@ Returns: Any """ - pass + ... - def SetBitmap(self, hBitmap: 'Any' = 1) -> 'Any': + def SetBitmap(self, hBitmap: Any = 1) -> Any: """ Set the button's bitmap @@ -34041,9 +33469,9 @@ Returns: Any """ - pass + ... - def GetCheck(self,) -> 'Any': + def GetCheck(self) -> Any: """ Retrieves the check state of a radio button or check box. @@ -34056,9 +33484,9 @@ Returns: Any """ - pass + ... - def SetCheck(self, idCheck: 'Any') -> 'None': + def SetCheck(self, idCheck: Any) -> None: """ Sets or resets the state of a radio button or check box. @@ -34071,9 +33499,9 @@ Returns: None """ - pass + ... - def GetState(self,) -> 'Any': + def GetState(self) -> Any: """ Returns the state of the button. @@ -34086,9 +33514,9 @@ Returns: Any """ - pass + ... - def SetState(self, bHighlight: 'Any') -> 'Any': + def SetState(self, bHighlight: Any) -> Any: """ Sets the state of the button. @@ -34101,9 +33529,9 @@ Returns: Any """ - pass + ... - def GetButtonStyle(self,) -> 'Any': + def GetButtonStyle(self) -> Any: """ Gets the style of the button. @@ -34116,9 +33544,9 @@ Returns: Any """ - pass + ... - def SetButtonStyle(self, style: 'Any', bRedraw: 'Any' = 1) -> 'Any': + def SetButtonStyle(self, style: Any, bRedraw: Any = 1) -> Any: """ Sets the style of the button. @@ -34132,16 +33560,15 @@ Returns: Any """ - pass + ... -class PyCCmdTarget(object): - """""" +class PyCCmdTarget: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def BeginWaitCursor(self,) -> 'None': + def BeginWaitCursor(self) -> None: """ None @@ -34154,9 +33581,9 @@ Returns: None """ - pass + ... - def EndWaitCursor(self,) -> 'None': + def EndWaitCursor(self) -> None: """ None @@ -34169,9 +33596,9 @@ Returns: None """ - pass + ... - def HookCommand(self, obHandler: 'Any', _id: 'Any') -> 'Any': + def HookCommand(self, obHandler: Any, _id: Any) -> Any: """ Hook a windows command handler. @@ -34215,9 +33642,9 @@ Return ValueThe return value is the previous handler, or None. """ - pass + ... - def HookCommandUpdate(self, obHandler: 'Any', _id: 'Any') -> 'Any': + def HookCommandUpdate(self, obHandler: Any, _id: Any) -> Any: """ Hook a windows command update handler. @@ -34243,9 +33670,9 @@ Return ValueThe return value is the previous handler, or None. """ - pass + ... - def HookOleEvent(self,) -> 'Any': + def HookOleEvent(self) -> Any: """ Hook an OLE Event. @@ -34262,9 +33689,9 @@ Return ValueThe return value is the previous handler, or None. """ - pass + ... - def HookNotify(self, obHandler: 'Any', _id: 'Any') -> 'Any': + def HookNotify(self, obHandler: Any, _id: Any) -> Any: """ Hook a windows command handler. @@ -34306,9 +33733,9 @@ Return ValueThe return value is the previous handler, or None. """ - pass + ... - def RestoreWaitCursor(self,) -> 'None': + def RestoreWaitCursor(self) -> None: """ Restores the appropriate hourglass cursor after the system cursor has @@ -34323,36 +33750,31 @@ Returns: None """ - pass + ... -class PyCCmdUI(object): - """""" +class PyCCmdUI: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def m_nIndex(self) -> 'Any': - """""" - pass + def m_nIndex(self) -> Any: + ... @property - def m_nID(self) -> 'Any': - """""" - pass + def m_nID(self) -> Any: + ... @property - def m_pMenu(self) -> 'Any': - """""" - pass + def m_pMenu(self) -> Any: + ... @property - def m_pSubMenu(self) -> 'Any': - """""" - pass + def m_pSubMenu(self) -> Any: + ... - def Enable(self, bEnable: 'Any' = 1) -> 'None': + def Enable(self, bEnable: Any = 1) -> None: """ Enables or disables the user-interface item for this command. @@ -34365,9 +33787,9 @@ Returns: None """ - pass + ... - def SetCheck(self, state: 'Any' = 1) -> 'None': + def SetCheck(self, state: Any = 1) -> None: """ Sets the check state of the user-interface item for this command. @@ -34380,9 +33802,9 @@ Returns: None """ - pass + ... - def SetRadio(self, bOn: 'Any' = 1) -> 'None': + def SetRadio(self, bOn: Any = 1) -> None: """ Like the SetCheck member function, but operates on radio groups. @@ -34395,9 +33817,9 @@ Returns: None """ - pass + ... - def SetText(self, text: 'str') -> 'None': + def SetText(self, text: str) -> None: """ Sets the text for the user-interface item for this command. @@ -34410,9 +33832,9 @@ Returns: None """ - pass + ... - def ContinueRouting(self,) -> 'None': + def ContinueRouting(self) -> None: """ Tells the command-routing mechanism to continue routing the current message down @@ -34427,16 +33849,15 @@ Returns: None """ - pass + ... -class PyCColorDialog(object): - """""" +class PyCColorDialog: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetColor(self,) -> 'Any': + def GetColor(self) -> Any: """ Determines the selected color. @@ -34449,9 +33870,9 @@ Returns: Any """ - pass + ... - def DoModal(self,) -> 'Any': + def DoModal(self) -> Any: """ Displays a dialog and allows the user to make a selection. @@ -34464,9 +33885,9 @@ Returns: Any """ - pass + ... - def GetSavedCustomColors(self,) -> 'Any': + def GetSavedCustomColors(self) -> Any: """ Returns the saved custom colors. @@ -34479,9 +33900,9 @@ Returns: Any """ - pass + ... - def SetCurrentColor(self, color: 'Any') -> 'None': + def SetCurrentColor(self, color: Any) -> None: """ Sets the currently selected color. @@ -34494,9 +33915,9 @@ Returns: None """ - pass + ... - def SetCustomColors(self,) -> 'None': + def SetCustomColors(self) -> None: """ Sets one or more custom colors @@ -34509,9 +33930,9 @@ Returns: None """ - pass + ... - def GetCustomColors(self,) -> 'Tuple[Any, ...]': + def GetCustomColors(self) -> Tuple[Any, ...]: """ Gets the 16 currently defined custom colors @@ -34524,16 +33945,15 @@ Returns: Tuple[Any, ...] """ - pass + ... -class PyCComboBox(object): - """""" +class PyCComboBox: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def AddString(self, _object: 'Any') -> 'Any': + def AddString(self, _object: Any) -> Any: """ Adds a string to a combobox. @@ -34548,9 +33968,9 @@ Return ValueThe zero based index of the new string. """ - pass + ... - def DeleteString(self, pos: 'Any') -> 'Any': + def DeleteString(self, pos: Any) -> Any: """ Deletes an item from a combobox. @@ -34565,9 +33985,9 @@ Return ValueThe count of the items remaining in the list. """ - pass + ... - def Dir(self, attr: 'Any', wild: 'str') -> 'Any': + def Dir(self, attr: Any, wild: str) -> Any: """ Fills the list portion of a combobox with a directory listing. @@ -34583,9 +34003,9 @@ Return ValueThe index of the last file name added to the list. """ - pass + ... - def GetCount(self,) -> 'Any': + def GetCount(self) -> Any: """ Returns the count of items in the combobox. @@ -34600,9 +34020,9 @@ Return ValueReturns the number of items currently in the combobox. """ - pass + ... - def GetCurSel(self,) -> 'Any': + def GetCurSel(self) -> Any: """ Returns the index of the currently selected item. @@ -34615,9 +34035,9 @@ Returns: Any """ - pass + ... - def GetEditSel(self,) -> 'Any': + def GetEditSel(self) -> Any: """ Returns the selection of the edit control portion of a combo box. @@ -34638,9 +34058,9 @@ without an edit control, an exception is raised. """ - pass + ... - def GetExtendedUI(self,) -> 'Any': + def GetExtendedUI(self) -> Any: """ Indicates if the combo has the extended interface. @@ -34655,9 +34075,9 @@ Return ValueNonzero if the combo box has the extended user interface; otherwise """ - pass + ... - def GetItemData(self, item: 'Any') -> 'Any': + def GetItemData(self, item: Any) -> Any: """ Retrieves the application-specific object associated with an item. @@ -34670,9 +34090,9 @@ Returns: Any """ - pass + ... - def GetItemValue(self, item: 'Any') -> 'Any': + def GetItemValue(self, item: Any) -> Any: """ Retrieves the application-specific value associated with an item. @@ -34685,9 +34105,9 @@ Returns: Any """ - pass + ... - def GetLBText(self, index: 'Any') -> 'str': + def GetLBText(self, index: Any) -> str: """ Gets the string from the list of a combo box. @@ -34703,9 +34123,9 @@ not specify a valid index, no exception is raised. """ - pass + ... - def GetLBTextLen(self, index: 'Any') -> 'Any': + def GetLBTextLen(self, index: Any) -> Any: """ Returns the length of a string in the list of a combobox. @@ -34718,9 +34138,9 @@ Returns: Any """ - pass + ... - def InsertString(self, pos: 'Any', _object: 'Any') -> 'Any': + def InsertString(self, pos: Any, _object: Any) -> Any: """ Insert a string into a combobox. @@ -34736,9 +34156,9 @@ Return ValueThe zero based index of the new string added. """ - pass + ... - def LimitText(self, _max: 'Any') -> 'Any': + def LimitText(self, _max: Any) -> Any: """ Limits the amount of text the edit portion of a combo box can hold. @@ -34751,9 +34171,9 @@ Returns: Any """ - pass + ... - def ResetContent(self,) -> 'None': + def ResetContent(self) -> None: """ Clear all the items from a combobox. @@ -34766,9 +34186,9 @@ Returns: None """ - pass + ... - def SelectString(self, after: 'Any', string: 'str') -> 'None': + def SelectString(self, after: Any, string: str) -> None: """ Searches for a combobox item that matches the specified string, and selects it. @@ -34784,9 +34204,9 @@ Return ValueThe return value is always None - an exception is raised if the stri """ - pass + ... - def SetCurSel(self, index: 'Any') -> 'None': + def SetCurSel(self, index: Any) -> None: """ Selects an item in a combobox. @@ -34799,9 +34219,9 @@ Returns: None """ - pass + ... - def SetEditSel(self, start: 'Any', end: 'Any') -> 'None': + def SetEditSel(self, start: Any, end: Any) -> None: """ Sets the selection in the edit control portion of a combo box. @@ -34819,9 +34239,9 @@ have an edit control. """ - pass + ... - def SetExtendedUI(self, bExtended: 'Any' = 1) -> 'None': + def SetExtendedUI(self, bExtended: Any = 1) -> None: """ Selects the Extended UI mode for a combo box. @@ -34834,9 +34254,9 @@ Returns: None """ - pass + ... - def SetItemData(self, item: 'Any', Data: 'Any') -> 'Any': + def SetItemData(self, item: Any, Data: Any) -> Any: """ Sets the item's application-specific object value. @@ -34850,9 +34270,9 @@ Returns: Any """ - pass + ... - def SetItemValue(self, item: 'Any', data: 'Any') -> 'Any': + def SetItemValue(self, item: Any, data: Any) -> Any: """ Sets the item's application-specific value. @@ -34866,9 +34286,9 @@ Returns: Any """ - pass + ... - def ShowDropDown(self, bShowIt: 'Any' = 1) -> 'None': + def ShowDropDown(self, bShowIt: Any = 1) -> None: """ Shows or hides the listbox portion of a combo box. @@ -34881,55 +34301,52 @@ Returns: None """ - pass + ... -class PyCCommonDialog(object): - """""" +class PyCCommonDialog: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyCControl(object): - """""" +class PyCControl: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyCControlBar(object): - """""" +class PyCControlBar: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def dockSite(self) -> 'Any': + def dockSite(self) -> Any: """Current dock site, if dockable""" - pass + ... @property - def dockBar(self) -> 'Any': + def dockBar(self) -> Any: """Current dock bar, if dockable""" - pass + ... @property - def dockContext(self) -> 'Any': + def dockContext(self) -> Any: """Used during dragging""" - pass + ... @property - def dwStyle(self) -> 'Any': + def dwStyle(self) -> Any: """creation style (used for layout)""" - pass + ... @property - def dwDockStyle(self) -> 'Any': + def dwDockStyle(self) -> Any: """indicates how bar can be docked""" - pass + ... - def CalcDynamicLayout(self, length: 'Any', dwMode: 'Any') -> 'Any': + def CalcDynamicLayout(self, length: Any, dwMode: Any) -> Any: """ The framework calls this member function to calculate the dimensions of @@ -34945,9 +34362,9 @@ Returns: Any """ - pass + ... - def CalcFixedLayout(self, bStretch: 'Any', bHorz: 'Any') -> 'Any': + def CalcFixedLayout(self, bStretch: Any, bHorz: Any) -> Any: """ Calculates the horizontal size of a control bar @@ -34961,9 +34378,9 @@ Returns: Any """ - pass + ... - def EnableDocking(self, style: 'Any') -> 'None': + def EnableDocking(self, style: Any) -> None: """ pecifies whether the control bar supports docking and the sides of its parent @@ -34978,9 +34395,9 @@ Returns: None """ - pass + ... - def EraseNonClient(self,) -> 'None': + def EraseNonClient(self) -> None: """ None @@ -34993,9 +34410,9 @@ Returns: None """ - pass + ... - def GetBarStyle(self,) -> 'Any': + def GetBarStyle(self) -> Any: """ Retrieves the control bar style settings. @@ -35008,9 +34425,9 @@ Returns: Any """ - pass + ... - def GetCount(self,) -> 'Any': + def GetCount(self) -> Any: """ Returns the number of non-HWND elements in the control bar. @@ -35023,9 +34440,9 @@ Returns: Any """ - pass + ... - def GetDockingFrame(self,) -> 'Any': + def GetDockingFrame(self) -> Any: """ Returns the frame window to which a control bar is docked. @@ -35038,9 +34455,9 @@ Returns: Any """ - pass + ... - def IsFloating(self,) -> 'Any': + def IsFloating(self) -> Any: """ Returns a nonzero value if the control bar in question is a floating control @@ -35055,9 +34472,9 @@ Returns: Any """ - pass + ... - def SetBarStyle(self, style: 'Any') -> 'None': + def SetBarStyle(self, style: Any) -> None: """ Modifies the control bar style settings. @@ -35070,9 +34487,9 @@ Returns: None """ - pass + ... - def ShowWindow(self,) -> 'Any': + def ShowWindow(self) -> Any: """ Shows the toolbar, and recalculates the button layout. @@ -35094,16 +34511,16 @@ Return ValueThe return value is that returned from PyCWnd::ShowWindow """ - pass + ... -class PyCCtrlView(object): +class PyCCtrlView: """A class which implementes a CCtrlView (ie, a view based on a dialog resource.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def OnCommand(self, wparam: 'Any', lparam: 'Any') -> 'None': + def OnCommand(self, wparam: Any, lparam: Any) -> None: """ Calls the standard Python framework OnCommand handler @@ -35117,16 +34534,15 @@ Returns: None """ - pass + ... -class PyCDC(object): - """""" +class PyCDC: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def AbortDoc(self,) -> 'None': + def AbortDoc(self) -> None: """ Aborts a print job @@ -35139,13 +34555,13 @@ Returns: None """ - pass + ... def Arc( self, - rect: 'Tuple[Any, Any, Any, Any]', - pointStart: 'Tuple[Any, Any]', - pointEnd: 'Tuple[Any, Any]') -> 'None': + rect: Tuple[Any, Any, Any, Any], + pointStart: Tuple[Any, Any], + pointEnd: Tuple[Any, Any]) -> None: """ Draws an eliptical arc. @@ -35162,9 +34578,9 @@ Return ValueAlways none. If the function fails, an exception is raised. """ - pass + ... - def BeginPath(self,) -> 'None': + def BeginPath(self) -> None: """ Opens a path bracket in the device context @@ -35177,15 +34593,15 @@ Returns: None """ - pass + ... def BitBlt( self, - destPos: 'Tuple[Any, Any]', - size: 'Tuple[Any, Any]', - dc: 'Any', - srcPos: 'Tuple[Any, Any]', - rop: 'Any') -> 'None': + destPos: Tuple[Any, Any], + size: Tuple[Any, Any], + dc: Any, + srcPos: Tuple[Any, Any], + rop: Any) -> None: """ Copies a bitmap from the source device context to this device context. @@ -35202,13 +34618,13 @@ Returns: None """ - pass + ... def Chord( self, - rect: 'Tuple[Any, Any, Any, Any]', - pointStart: 'Tuple[Any, Any]', - pointEnd: 'Tuple[Any, Any]') -> 'None': + rect: Tuple[Any, Any, Any, Any], + pointStart: Tuple[Any, Any], + pointEnd: Tuple[Any, Any]) -> None: """ Draws a chord. @@ -35225,9 +34641,9 @@ Return ValueAlways none. If the function fails, an exception is raised. """ - pass + ... - def CreateCompatibleDC(self, dcFrom: 'Any' = None) -> PyCDC: + def CreateCompatibleDC(self, dcFrom: Any = None) -> PyCDC: """ Creates a memory device context that is compatible with this DC. @@ -35240,9 +34656,9 @@ Returns: None """ - pass + ... - def CreatePrinterDC(self, printerName: 'str' = None) -> 'None': + def CreatePrinterDC(self, printerName: str = None) -> None: """ Creates a device context for a specific printer @@ -35255,9 +34671,9 @@ Returns: None """ - pass + ... - def DeleteDC(self,) -> 'None': + def DeleteDC(self) -> None: """ Deletes all resources associated with a device context. @@ -35270,9 +34686,9 @@ Returns: None """ - pass + ... - def DPtoLP(self, point: 'Tuple[Any, Any]', x: 'Any', y: 'Any') -> 'Tuple[Any, Any]': + def DPtoLP(self, point: Tuple[Any, Any], x: Any, y: Any) -> Tuple[Any, Any]: """ Converts device units into logical units. @@ -35290,9 +34706,9 @@ Return ValueThe converted coordinates. """ - pass + ... - def Draw3dRect(self, rect: 'Tuple[Any, Any, Any, Any]', colorTopLeft: 'Any', colorBotRight: 'Any') -> 'None': + def Draw3dRect(self, rect: Tuple[Any, Any, Any, Any], colorTopLeft: Any, colorBotRight: Any) -> None: """ Draws a three-dimensional rectangle. @@ -35307,9 +34723,9 @@ Returns: None """ - pass + ... - def DrawFocusRect(self, rect: 'Tuple[Any, Any, Any, Any]') -> 'None': + def DrawFocusRect(self, rect: Tuple[Any, Any, Any, Any]) -> None: """ Draws a rectangle in the style used to @@ -35324,9 +34740,9 @@ Returns: None """ - pass + ... - def DrawFrameControl(self, rect: 'Tuple[Any, Any, Any, Any]', typ: 'Any', state: 'Any') -> 'None': + def DrawFrameControl(self, rect: Tuple[Any, Any, Any, Any], typ: Any, state: Any) -> None: """ Draws a frame control of the specified type and style. @@ -35341,9 +34757,9 @@ Returns: None """ - pass + ... - def DrawIcon(self, point: 'Tuple[Any, Any]', hIcon: 'int') -> 'None': + def DrawIcon(self, point: Tuple[Any, Any], hIcon: int) -> None: """ Draws an icon on the DC. @@ -35357,9 +34773,9 @@ Returns: None """ - pass + ... - def DrawText(self, s: 'str', _tuple: 'Tuple[Any, Any, Any, Any]', _format: 'Any') -> 'Tuple[Any, Any, Any]': + def DrawText(self, s: str, _tuple: Tuple[Any, Any, Any, Any], _format: Any) -> Tuple[Any, Any, Any]: """ Formats text in the given rectangle @@ -35367,7 +34783,7 @@ Args: s(str):The desired output string _tuple(Tuple[Any, Any, Any, Any]):The bounding rectangle in the form: (left, top, right, bottom) expressed in logical units (depending on selected coordinate system - see PyCDC::SetMapMode) - _format(Any):Specifies one or more bit-or'd format values, such as DT_BOTTOM, DT_CENTERDT_RIGHT, DT_VCENTER. For a complete list, see the Microsoft Win32 API documentation.ExampleExampleimport win32ui<nl> import win32con<nl> INCH = 1440 # twips - 1440 per inch allows fine res<nl> def drawtext_test():<nl> dc = win32ui.CreateDC()<nl> dc.CreatePrinterDC() # ties to default printer<nl> dc.StartDoc('My Python Document')<nl> dc.StartPage()<nl> <nl> # note: upper left is 0,0 with x increasing to the right,<nl> # and y decreasing (negative) moving down<nl> dc.SetMapMode(win32con.MM_TWIPS)<nl> <nl> # Centers "TEST" about an inch down on page<nl> dc.DrawText('TEST', (0,INCH*-1,INCH*8,INCH*-2), win32con.DT_CENTER )<nl> dc.EndPage()<nl> dc.EndDoc()<nl> del dc<nl>Return ValueHeight of text in pixelsThe return value is the height of the text, in logical units. If DT_VCENTER or DT_BOTTOM is specified, the return value is the 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) + _format(Any):Specifies one or more bit-or'd format values, such as DT_BOTTOM, DT_CENTERDT_RIGHT, DT_VCENTER. For a complete list, see the Microsoft Win32 API documentation.ExampleExampleimport win32ui<nl> import win32con<nl> INCH = 1440 # twips - 1440 per inch allows fine res<nl> def drawtext_test():<nl> dc = win32ui.CreateDC()<nl> dc.CreatePrinterDC() # ties to default printer<nl> dc.StartDoc('My Python Document')<nl> dc.StartPage()<nl> <nl> # note: upper left is 0,0 with x increasing to the right,<nl> # and y decreasing (negative) moving down<nl> dc.SetMapMode(win32con.MM_TWIPS)<nl> <nl> # Centers "TEST" about an inch down on page<nl> dc.DrawText('TEST, (0,INCH*-1,INCH*8,INCH*-2), win32con.DT_CENTER )<nl> dc.EndPage()<nl> dc.EndDoc()<nl> del dc<nl>Return ValueHeight of text in pixelsThe return value is the height of the text, in logical units. If DT_VCENTER or DT_BOTTOM is specified, the return value is the 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) Returns: @@ -35404,7 +34820,7 @@ import win32ui<nl> # Centers "TEST" about an inch down on page<nl> - dc.DrawText('TEST', (0,INCH*-1,INCH*8,INCH*-2), win32con.DT_CENTER )<nl> + dc.DrawText('TEST, (0,INCH*-1,INCH*8,INCH*-2), win32con.DT_CENTER )<nl> dc.EndPage()<nl> @@ -35427,9 +34843,9 @@ If the function fails, the return value is zero (no Python exception is thrown) """ - pass + ... - def Ellipse(self, rect: 'Tuple[Any, Any, Any, Any]') -> 'None': + def Ellipse(self, rect: Tuple[Any, Any, Any, Any]) -> None: """ Draws an Ellipse. @@ -35444,9 +34860,9 @@ Return ValueAlways none. If the function fails, an exception is raised. """ - pass + ... - def EndDoc(self,) -> 'None': + def EndDoc(self) -> None: """ Finishes spooling the document and starts printing it @@ -35459,9 +34875,9 @@ Returns: None """ - pass + ... - def EndPage(self,) -> 'None': + def EndPage(self) -> None: """ Finishes a page on a printer DC @@ -35474,9 +34890,9 @@ Returns: None """ - pass + ... - def EndPath(self,) -> 'None': + def EndPath(self) -> None: """ Closes a path bracket and selects the path defined by the bracket into the specified device @@ -35491,16 +34907,16 @@ Returns: None """ - pass + ... def ExtTextOut( self, - _int: 'Any', - _int1: 'Any', - _int2: 'Any', - rect: 'Tuple[Any, Any, Any, Any]', - string: 'Any', - _tuple: 'Tuple[Tuple[Any, Any], ...]') -> 'None': + _int: Any, + _int1: Any, + _int2: Any, + rect: Tuple[Any, Any, Any, Any], + string: Any, + _tuple: Tuple[Tuple[Any, Any], ...]) -> None: """ Writes text to the DC. @@ -35520,9 +34936,9 @@ Return ValueAlways none. If the function fails, an exception is raised. """ - pass + ... - def FillPath(self,) -> 'None': + def FillPath(self) -> None: """ Closes any open figures in the current path and fills the path's interior by using the @@ -35537,9 +34953,9 @@ Returns: None """ - pass + ... - def FillRect(self, rect: 'Tuple[Any, Any, Any, Any]', brush: 'Any') -> 'None': + def FillRect(self, rect: Tuple[Any, Any, Any, Any], brush: Any) -> None: """ Fills a given rectangle with the specified brush @@ -35553,9 +34969,9 @@ Returns: None """ - pass + ... - def FillSolidRect(self, rect: 'Tuple[Any, Any, Any, Any]', color: 'Any') -> 'None': + def FillSolidRect(self, rect: Tuple[Any, Any, Any, Any], color: Any) -> None: """ Fills the given rectangle with the specified solid color. @@ -35569,9 +34985,9 @@ Returns: None """ - pass + ... - def FrameRect(self, rect: 'Tuple[Any, Any, Any, Any]', brush: 'Any') -> 'None': + def FrameRect(self, rect: Tuple[Any, Any, Any, Any], brush: Any) -> None: """ Draws a border around the rectangle specified by rect @@ -35585,9 +35001,9 @@ Returns: None """ - pass + ... - def GetBrushOrg(self,) -> 'Tuple[Any, Any]': + def GetBrushOrg(self) -> Tuple[Any, Any]: """ Retrieves the origin (in device units) of the brush currently selected for the @@ -35602,9 +35018,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def GetClipBox(self,) -> 'Tuple[Any, Any, Any, Any]': + def GetClipBox(self) -> Tuple[Any, Any, Any, Any]: """ Retrieves the dimensions of the smallest bounding rectangle @@ -35621,9 +35037,9 @@ Return ValueA tuple of integers specifying the rectangle. """ - pass + ... - def GetCurrentPosition(self,) -> 'Tuple[Any, Any]': + def GetCurrentPosition(self) -> Tuple[Any, Any]: """ Retrieves the current position (in logical coordinates). @@ -35636,9 +35052,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def GetDeviceCaps(self, index: 'Any') -> 'Any': + def GetDeviceCaps(self, index: Any) -> Any: """ Retrieves a capability of the device context. @@ -35653,9 +35069,9 @@ Return ValueThe value of the requested capability """ - pass + ... - def GetHandleAttrib(self,) -> 'Any': + def GetHandleAttrib(self) -> Any: """ Retrieves the handle of the attribute device context. @@ -35668,9 +35084,9 @@ Returns: Any """ - pass + ... - def GetHandleOutput(self,) -> 'Any': + def GetHandleOutput(self) -> Any: """ Retrieves the handle of the output device context. @@ -35683,9 +35099,9 @@ Returns: Any """ - pass + ... - def GetMapMode(self,) -> 'Any': + def GetMapMode(self) -> Any: """ Gets the mapping mode for the device context. @@ -35698,9 +35114,9 @@ Returns: Any """ - pass + ... - def GetNearestColor(self, color: 'Any') -> 'Any': + def GetNearestColor(self, color: Any) -> Any: """ Returns the closest color a device can map. @@ -35713,9 +35129,9 @@ Returns: Any """ - pass + ... - def GetPixel(self, x: 'Any', y: 'Any') -> 'None': + def GetPixel(self, x: Any, y: Any) -> None: """ Gets a pixel at a local in a device context @@ -35729,9 +35145,9 @@ Returns: None """ - pass + ... - def GetSafeHdc(self,) -> 'Any': + def GetSafeHdc(self) -> Any: """ Returns the HDC of this DC object. @@ -35744,9 +35160,9 @@ Returns: Any """ - pass + ... - def GetTextExtent(self, text: 'str') -> 'Tuple[Any, Any]': + def GetTextExtent(self, text: str) -> Tuple[Any, Any]: """ Calculates the width and height of a line of text using the current font to @@ -35763,9 +35179,9 @@ Return ValueA tuple of integers with the size of the string, in logical units. """ - pass + ... - def GetTextExtentPoint(self, text: 'str') -> 'Tuple[Any, Any]': + def GetTextExtentPoint(self, text: str) -> Tuple[Any, Any]: """ None @@ -35779,9 +35195,9 @@ Returns: """ - pass + ... - def GetTextFace(self,) -> 'str': + def GetTextFace(self) -> str: """ Returns typeface name of the current font. @@ -35794,9 +35210,9 @@ Returns: str """ - pass + ... - def GetTextMetrics(self,) -> 'Any': + def GetTextMetrics(self) -> Any: """ Retrieves the metrics for the current font in this device context. @@ -35851,9 +35267,9 @@ tmDigitizedAspectY """ - pass + ... - def GetViewportExt(self,) -> 'Tuple[Any, Any]': + def GetViewportExt(self) -> Tuple[Any, Any]: """ Gets the viewport extent of the device context @@ -35866,9 +35282,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def GetViewportOrg(self,) -> 'Tuple[Any, Any]': + def GetViewportOrg(self) -> Tuple[Any, Any]: """ Gets the viewport origin of the device context @@ -35881,9 +35297,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def GetWindowExt(self,) -> 'Tuple[Any, Any]': + def GetWindowExt(self) -> Tuple[Any, Any]: """ Gets the window extent of the device context @@ -35896,9 +35312,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def GetWindowOrg(self,) -> 'Tuple[Any, Any]': + def GetWindowOrg(self) -> Tuple[Any, Any]: """ Retrieves the x- and y-coordinates of the origin of the window associated with the @@ -35913,9 +35329,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def IntersectClipRect(self, rect: 'Tuple[Any, Any, Any, Any]') -> 'None': + def IntersectClipRect(self, rect: Tuple[Any, Any, Any, Any]) -> None: """ Creates a new clipping region by forming the intersection of the current region @@ -35932,9 +35348,9 @@ Return Valueregion type as integer """ - pass + ... - def IsPrinting(self,) -> 'Any': + def IsPrinting(self) -> Any: """ Returns 1 if the DC is currently printing, else 0 @@ -35947,9 +35363,9 @@ Returns: Any """ - pass + ... - def LineTo(self, point: 'Tuple[Any, Any]', x: 'Any', y: 'Any') -> 'None': + def LineTo(self, point: Tuple[Any, Any], x: Any, y: Any) -> None: """ Draws a line to a specified point, using the currently selected pen. @@ -35964,9 +35380,9 @@ Returns: None """ - pass + ... - def LPtoDP(self, point: 'Tuple[Any, Any]', x: 'Any', y: 'Any') -> 'Tuple[Any, Any]': + def LPtoDP(self, point: Tuple[Any, Any], x: Any, y: Any) -> Tuple[Any, Any]: """ Converts logical units into device units. @@ -35983,9 +35399,9 @@ Return ValueThe converted coordinates. """ - pass + ... - def MoveTo(self, point: 'Tuple[Any, Any]', x: 'Any', y: 'Any') -> 'Tuple[Any, Any]': + def MoveTo(self, point: Tuple[Any, Any], x: Any, y: Any) -> Tuple[Any, Any]: """ Moves the current position to a specified point. @@ -36002,9 +35418,9 @@ Return ValueThe previous position. """ - pass + ... - def OffsetWindowOrg(self, arg: 'Tuple[Any, Any]') -> 'Tuple[Any, Any]': + def OffsetWindowOrg(self, arg: Tuple[Any, Any]) -> Tuple[Any, Any]: """ Modifies the coordinates of the window origin relative to the coordinates of the @@ -36020,9 +35436,9 @@ Returns: """ - pass + ... - def OffsetViewportOrg(self, arg: 'Tuple[Any, Any]') -> 'Tuple[Any, Any]': + def OffsetViewportOrg(self, arg: Tuple[Any, Any]) -> Tuple[Any, Any]: """ Modifies the coordinates of the viewport origin relative to the coordinates of @@ -36038,9 +35454,9 @@ Returns: """ - pass + ... - def PatBlt(self, destPos: 'Tuple[Any, Any]', size: 'Tuple[Any, Any]', rop: 'Any') -> 'None': + def PatBlt(self, destPos: Tuple[Any, Any], size: Tuple[Any, Any], rop: Any) -> None: """ Creates a bit pattern on the device. @@ -36055,9 +35471,9 @@ Returns: None """ - pass + ... - def Pie(self, x1: 'Any', y1: 'Any', x2: 'Any', y2: 'Any', x3: 'Any', y3: 'Any', x4: 'Any', y4: 'Any') -> 'None': + def Pie(self, x1: Any, y1: Any, x2: Any, y2: Any, x3: Any, y3: Any, x4: Any, y4: Any) -> None: """ Draws a pie slice in a device context @@ -36077,9 +35493,9 @@ Returns: None """ - pass + ... - def PolyBezier(self,) -> 'None': + def PolyBezier(self) -> None: """ Draws one or more Bezier splines. @@ -36092,9 +35508,9 @@ Returns: None """ - pass + ... - def Polygon(self,) -> 'None': + def Polygon(self) -> None: """ Draws an Polygon. @@ -36107,9 +35523,9 @@ Returns: None """ - pass + ... - def Polyline(self, points: 'List[Any]') -> 'None': + def Polyline(self, points: List[Any]) -> None: """ Draws a Polyline. @@ -36122,9 +35538,9 @@ Returns: None """ - pass + ... - def RealizePalette(self,) -> 'Any': + def RealizePalette(self) -> Any: """ Maps palette entries in the current logical palette to the system palette. @@ -36147,9 +35563,9 @@ was last realized. """ - pass + ... - def Rectangle(self,) -> 'Any': + def Rectangle(self) -> Any: """ Draws a rectangle using the current pen. The interior of the rectangle is filled using @@ -36164,9 +35580,9 @@ Returns: Any """ - pass + ... - def RectVisible(self, rect: 'Tuple[Any, Any, Any, Any]') -> 'Any': + def RectVisible(self, rect: Tuple[Any, Any, Any, Any]) -> Any: """ Determines whether any part of the given rectangle lies within the clipping region of @@ -36183,9 +35599,9 @@ Return ValueNon zero if any part of the rectangle lies within the clipping regio """ - pass + ... - def RestoreDC(self, saved: 'Any') -> 'None': + def RestoreDC(self, saved: Any) -> None: """ Restores the state of the device context. @@ -36198,9 +35614,9 @@ Returns: None """ - pass + ... - def SaveDC(self,) -> 'Any': + def SaveDC(self) -> Any: """ None @@ -36217,9 +35633,9 @@ An exception is raised if this function fails. """ - pass + ... - def ScaleWindowExt(self,) -> 'Tuple[Any, Any]': + def ScaleWindowExt(self) -> Tuple[Any, Any]: """ Modifies the window extents relative to the current values. @@ -36232,9 +35648,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def ScaleViewportExt(self,) -> 'Tuple[Any, Any]': + def ScaleViewportExt(self) -> Tuple[Any, Any]: """ Modifies the viewport extents relative to the current values. @@ -36247,9 +35663,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def SelectClipRgn(self,) -> 'Any': + def SelectClipRgn(self) -> Any: """ Selects the given region as the current clipping region for the device context @@ -36266,9 +35682,9 @@ Return ValueThe return value specifies the region's complexity (integer) """ - pass + ... - def SelectObject(self, ob: 'Any') -> 'Any': + def SelectObject(self, ob: Any) -> Any: """ None @@ -36283,9 +35699,9 @@ Return ValueThe previously selected object. This will be the same type as the o """ - pass + ... - def SetBkColor(self, color: 'Any') -> 'Any': + def SetBkColor(self, color: Any) -> Any: """ Sets the current background color to the specified color. @@ -36300,9 +35716,9 @@ Return ValueThe return value is the previous background color. """ - pass + ... - def SetBkMode(self, mode: 'Any') -> 'Any': + def SetBkMode(self, mode: Any) -> Any: """ Sets the current background mode to the specified mode. @@ -36317,9 +35733,9 @@ Return ValueThe return value is the previous background mode. """ - pass + ... - def SetBrushOrg(self, point: 'Tuple[Any, Any]') -> 'Tuple[Any, Any]': + def SetBrushOrg(self, point: Tuple[Any, Any]) -> Tuple[Any, Any]: """ Specifies the origin that GDI will assign to the next brush that the @@ -36336,9 +35752,9 @@ Return ValueThe previous origin in device units. """ - pass + ... - def SetGraphicsMode(self, mode: 'Any') -> 'Any': + def SetGraphicsMode(self, mode: Any) -> Any: """ Sets the graphics mode for the specified device context @@ -36351,9 +35767,9 @@ Returns: Any """ - pass + ... - def SetMapMode(self, newMode: 'Any') -> 'Any': + def SetMapMode(self, newMode: Any) -> Any: """ Sets the mapping mode for the device context. @@ -36368,9 +35784,9 @@ Return ValueThe previous mapping mode. """ - pass + ... - def SetPixel(self, x: 'Any', y: 'Any', color: 'Any') -> 'None': + def SetPixel(self, x: Any, y: Any, color: Any) -> None: """ Sets a pixel in a device context @@ -36385,9 +35801,9 @@ Returns: None """ - pass + ... - def SetPolyFillMode(self, point: 'Tuple[Any, Any]') -> 'Any': + def SetPolyFillMode(self, point: Tuple[Any, Any]) -> Any: """ Sets the polygon-filling mode. @@ -36406,9 +35822,9 @@ The previous PolyFillMode. """ - pass + ... - def SetROP2(self, mode: 'Any') -> 'Any': + def SetROP2(self, mode: Any) -> Any: """ Sets the current drawing mode. @@ -36421,9 +35837,9 @@ Returns: Any """ - pass + ... - def SetTextAlign(self, newFlags: 'Any') -> 'Any': + def SetTextAlign(self, newFlags: Any) -> Any: """ Sets the text-alignment flags. @@ -36438,9 +35854,9 @@ Return ValueThe old alignment flags. """ - pass + ... - def SetTextColor(self, color: 'Any') -> 'Any': + def SetTextColor(self, color: Any) -> Any: """ Sets the text color to the specified color. @@ -36455,9 +35871,9 @@ Return ValueThe return value is the previous text color. """ - pass + ... - def SetWindowExt(self, size: 'Tuple[Any, Any]') -> 'Tuple[Any, Any]': + def SetWindowExt(self, size: Tuple[Any, Any]) -> Tuple[Any, Any]: """ Sets the x,y extents of the window associated with the device context. @@ -36472,9 +35888,9 @@ Return ValueThe previous extents of the window (in logical units). """ - pass + ... - def SetWindowOrg(self, arg: 'Tuple[Any, Any]') -> 'Tuple[Any, Any]': + def SetWindowOrg(self, arg: Tuple[Any, Any]) -> Tuple[Any, Any]: """ Sets the window origin of the device context @@ -36487,9 +35903,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def SetViewportExt(self, size: 'Tuple[Any, Any]') -> 'Tuple[Any, Any]': + def SetViewportExt(self, size: Tuple[Any, Any]) -> Tuple[Any, Any]: """ Sets the x,y extents of the viewport of the device context. @@ -36504,9 +35920,9 @@ Return ValueThe previous extents of the viewport (in logical units). """ - pass + ... - def SetViewportOrg(self, arg: 'Tuple[Any, Any]') -> 'Tuple[Any, Any]': + def SetViewportOrg(self, arg: Tuple[Any, Any]) -> Tuple[Any, Any]: """ Sets the viewport origin of the device context @@ -36519,9 +35935,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def SetWorldTransform(self,) -> 'Any': + def SetWorldTransform(self) -> Any: """ sets a two-dimensional linear transformation between world space and page space @@ -36538,9 +35954,9 @@ Returns: Any """ - pass + ... - def StartDoc(self, docName: 'str', outputFile: 'str') -> 'None': + def StartDoc(self, docName: str, outputFile: str) -> None: """ Starts spooling a document to a printer DC @@ -36554,9 +35970,9 @@ Returns: None """ - pass + ... - def StartPage(self,) -> 'None': + def StartPage(self) -> None: """ Starts a new page on a printer DC @@ -36569,16 +35985,16 @@ Returns: None """ - pass + ... def StretchBlt( self, - destPos: 'Tuple[Any, Any]', - size: 'Tuple[Any, Any]', - dc: 'Any', - srcPos: 'Tuple[Any, Any]', - size1: 'Tuple[Any, Any]', - rop: 'Any') -> 'None': + destPos: Tuple[Any, Any], + size: Tuple[Any, Any], + dc: Any, + srcPos: Tuple[Any, Any], + size1: Tuple[Any, Any], + rop: Any) -> None: """ Copies a bitmap from the source device context to this device context. @@ -36596,9 +36012,9 @@ Returns: None """ - pass + ... - def StrokeAndFillPath(self,) -> 'None': + def StrokeAndFillPath(self) -> None: """ Closes any open figures in a path, strokes the outline of the path by using the @@ -36613,9 +36029,9 @@ Returns: None """ - pass + ... - def StrokePath(self,) -> 'None': + def StrokePath(self) -> None: """ Renders the specified path by using the current pen. @@ -36628,9 +36044,9 @@ Returns: None """ - pass + ... - def TextOut(self, _int: 'Any', _int1: 'Any', string: 'Any') -> 'None': + def TextOut(self, _int: Any, _int1: Any, string: Any) -> None: """ Outputs text to the display context, using the currently selected font. @@ -36647,16 +36063,15 @@ Return ValueAlways none. If the function fails, an exception is raised. """ - pass + ... -class PyCDialog(object): - """""" +class PyCDialog: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CreateWindow(self, obParent: 'Any' = None) -> 'None': + def CreateWindow(self, obParent: Any = None) -> None: """ Create a modeless window for the dialog box. @@ -36669,9 +36084,9 @@ Returns: None """ - pass + ... - def DoModal(self,) -> 'Any': + def DoModal(self) -> Any: """ Create a modal window for the dialog box. @@ -36686,9 +36101,9 @@ Return ValueThe return value from the dialog. This is the value passed to PyCDi """ - pass + ... - def EndDialog(self, result: 'Any') -> 'None': + def EndDialog(self, result: Any) -> None: """ Ends a modal dialog box. @@ -36701,9 +36116,9 @@ Returns: None """ - pass + ... - def GotoDlgCtrl(self, control: 'Any') -> 'None': + def GotoDlgCtrl(self, control: Any) -> None: """ Moves the focus to the specified control in the dialog box. @@ -36716,9 +36131,9 @@ Returns: None """ - pass + ... - def MapDialogRect(self, rect: 'Tuple[Any, Any, Any, Any]') -> 'Tuple[Any, Any, Any, Any]': + def MapDialogRect(self, rect: Tuple[Any, Any, Any, Any]) -> Tuple[Any, Any, Any, Any]: """ Converts the dialog-box units of a rectangle to screen @@ -36733,9 +36148,9 @@ Returns: Tuple[Any, Any, Any, Any] """ - pass + ... - def OnCancel(self,) -> 'None': + def OnCancel(self) -> None: """ Calls the default MFC OnCancel handler. @@ -36748,9 +36163,9 @@ Returns: None """ - pass + ... - def OnOK(self,) -> 'None': + def OnOK(self) -> None: """ Calls the default MFC OnOK handler. @@ -36763,9 +36178,9 @@ Returns: None """ - pass + ... - def OnInitDialog(self,) -> 'Any': + def OnInitDialog(self) -> Any: """ Calls the default MFC OnInitDialog handler. @@ -36778,16 +36193,15 @@ Returns: Any """ - pass + ... -class PyCDialogBar(object): - """""" +class PyCDialogBar: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CreateWindow(self, parent: 'Any', template: 'PyResourceId', style: 'Any', _id: 'Any') -> 'None': + def CreateWindow(self, parent: Any, template: PyResourceId, style: Any, _id: Any) -> None: """ None @@ -36803,16 +36217,15 @@ Returns: None """ - pass + ... -class PyCDocTemplate(object): - """""" +class PyCDocTemplate: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def DoCreateDoc(self, fileName: 'str' = None) -> 'Any': + def DoCreateDoc(self, fileName: str = None) -> Any: """ Creates an underlying document object. @@ -36825,9 +36238,9 @@ Returns: Any """ - pass + ... - def FindOpenDocument(self, fileName: 'str') -> 'Any': + def FindOpenDocument(self, fileName: str) -> Any: """ Returns an existing document with the specified file name. @@ -36840,9 +36253,9 @@ Returns: Any """ - pass + ... - def GetDocString(self, docIndex: 'Any') -> 'str': + def GetDocString(self, docIndex: Any) -> str: """ Retrieves a specific substring describing the document type. @@ -36855,9 +36268,9 @@ Returns: str """ - pass + ... - def GetDocumentList(self,) -> 'Any': + def GetDocumentList(self) -> Any: """ Return a list of all open documents. @@ -36870,9 +36283,9 @@ Returns: Any """ - pass + ... - def GetResourceID(self,) -> 'None': + def GetResourceID(self) -> None: """ Returns the resource ID in use. @@ -36885,9 +36298,9 @@ Returns: None """ - pass + ... - def GetSharedMenu(self,) -> 'Any': + def GetSharedMenu(self) -> Any: """ Returns the shared menu object for all frames using this template. @@ -36900,9 +36313,9 @@ Returns: Any """ - pass + ... - def InitialUpdateFrame(self, frame: 'Any' = None, doc: 'Any' = None, bMakeVisible: 'Any' = 1) -> 'None': + def InitialUpdateFrame(self, frame: Any = None, doc: Any = None, bMakeVisible: Any = 1) -> None: """ Calls the default OnInitialFrame handler. @@ -36917,9 +36330,9 @@ Returns: None """ - pass + ... - def SetContainerInfo(self, _id: 'Any') -> 'None': + def SetContainerInfo(self, _id: Any) -> None: """ Sets the resources to be used when an OLE 2 object is in-place activated. @@ -36932,9 +36345,9 @@ Returns: None """ - pass + ... - def SetDocStrings(self, docStrings: 'str') -> 'None': + def SetDocStrings(self, docStrings: str) -> None: """ Assigns the document strings for the template. @@ -36947,9 +36360,9 @@ Returns: None """ - pass + ... - def OpenDocumentFile(self, filename: 'str', bMakeVisible: 'Any' = 1) -> 'None': + def OpenDocumentFile(self, filename: str, bMakeVisible: Any = 1) -> None: """ Opens a document file, creating a view and frame. @@ -36963,111 +36376,98 @@ Returns: None """ - pass + ... -class PyCDockContext(object): +class PyCDockContext: """A class which encapsulates an MFC CDockContext object""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def ptLast(self) -> 'Tuple[Any, Any]': - """""" - pass + def ptLast(self) -> Tuple[Any, Any]: + ... @property - def rectLast(self) -> 'Tuple[Any, Any, Any, Any]': - """""" - pass + def rectLast(self) -> Tuple[Any, Any, Any, Any]: + ... @property - def sizeLast(self) -> 'Tuple[Any, Any]': - """""" - pass + def sizeLast(self) -> Tuple[Any, Any]: + ... @property - def bDitherLast(self) -> 'Any': - """""" - pass + def bDitherLast(self) -> Any: + ... @property - def rectDragHorz(self) -> 'Tuple[Any, Any, Any, Any]': - """""" - pass + def rectDragHorz(self) -> Tuple[Any, Any, Any, Any]: + ... @property - def rectDragVert(self) -> 'Tuple[Any, Any, Any, Any]': - """""" - pass + def rectDragVert(self) -> Tuple[Any, Any, Any, Any]: + ... @property - def rectFrameDragHorz(self) -> 'Tuple[Any, Any, Any, Any]': - """""" - pass + def rectFrameDragHorz(self) -> Tuple[Any, Any, Any, Any]: + ... @property - def rectFrameDragVert(self) -> 'Tuple[Any, Any, Any, Any]': - """""" - pass + def rectFrameDragVert(self) -> Tuple[Any, Any, Any, Any]: + ... @property - def dwDockStyle(self) -> 'Any': + def dwDockStyle(self) -> Any: """allowable dock styles for bar""" - pass + ... @property - def dwOverDockStyle(self) -> 'Any': + def dwOverDockStyle(self) -> Any: """style of dock that rect is over""" - pass + ... @property - def dwStyle(self) -> 'Any': + def dwStyle(self) -> Any: """style of control bar""" - pass + ... @property - def bFlip(self) -> 'Any': + def bFlip(self) -> Any: """if shift key is down""" - pass + ... @property - def bForceFrame(self) -> 'Any': + def bForceFrame(self) -> Any: """if ctrl key is down CDC* m_pDC; // where to draw during drag""" - pass + ... @property - def bDragging(self) -> 'Any': - """""" - pass + def bDragging(self) -> Any: + ... @property - def nHitTest(self) -> 'Any': - """""" - pass + def nHitTest(self) -> Any: + ... @property - def uMRUDockID(self) -> 'Any': - """""" - pass + def uMRUDockID(self) -> Any: + ... @property - def rectMRUDockPos(self) -> 'Tuple[Any, Any, Any, Any]': - """""" - pass + def rectMRUDockPos(self) -> Tuple[Any, Any, Any, Any]: + ... @property - def dwMRUFloatStyle(self) -> 'Any': - """""" - pass + def dwMRUFloatStyle(self) -> Any: + ... @property - def ptMRUFloatPos(self) -> 'Tuple[Any, Any]': + def ptMRUFloatPos(self) -> Tuple[Any, Any]: """Sentinel""" - pass + ... - def EndDrag(self,) -> 'Any': + def EndDrag(self) -> Any: """ None @@ -37080,9 +36480,9 @@ Returns: Any """ - pass + ... - def StartDrag(self, pt: 'Tuple[Any, Any]') -> 'Any': + def StartDrag(self, pt: Tuple[Any, Any]) -> Any: """ None @@ -37095,9 +36495,9 @@ Returns: Any """ - pass + ... - def EndResize(self,) -> 'Any': + def EndResize(self) -> Any: """ None @@ -37110,9 +36510,9 @@ Returns: Any """ - pass + ... - def StartResize(self, hittest: 'Any', pt: 'Tuple[Any, Any]') -> 'Any': + def StartResize(self, hittest: Any, pt: Tuple[Any, Any]) -> Any: """ None @@ -37126,9 +36526,9 @@ Returns: Any """ - pass + ... - def ToggleDocking(self,) -> 'Any': + def ToggleDocking(self) -> Any: """ None @@ -37141,16 +36541,15 @@ Returns: Any """ - pass + ... -class PyCDocument(object): - """""" +class PyCDocument: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def DeleteContents(self,) -> 'None': + def DeleteContents(self) -> None: """ Call the MFC DeleteContents method. @@ -37167,9 +36566,9 @@ Returns: None """ - pass + ... - def DoSave(self, fileName: 'str', bReplace: 'Any' = 1) -> 'None': + def DoSave(self, fileName: str, bReplace: Any = 1) -> None: """ Calls the underlying MFC DoSave method. @@ -37183,9 +36582,9 @@ Returns: None """ - pass + ... - def DoFileSave(self,) -> 'None': + def DoFileSave(self) -> None: """ Checks the file attributes. @@ -37202,9 +36601,9 @@ Returns: None """ - pass + ... - def GetDocTemplate(self,) -> 'Any': + def GetDocTemplate(self) -> Any: """ Returns the template for the document. @@ -37217,9 +36616,9 @@ Returns: Any """ - pass + ... - def GetAllViews(self,) -> 'List[Any]': + def GetAllViews(self) -> List[Any]: """ Returns a list of all views for the current document. @@ -37232,9 +36631,9 @@ Returns: List[Any] """ - pass + ... - def GetFirstView(self,) -> 'Any': + def GetFirstView(self) -> Any: """ Returns the first view object attached to this document. @@ -37247,9 +36646,9 @@ Returns: Any """ - pass + ... - def GetPathName(self,) -> 'str': + def GetPathName(self) -> str: """ Returns the full path name of the current document. @@ -37264,9 +36663,9 @@ Returns: str """ - pass + ... - def GetTitle(self,) -> 'str': + def GetTitle(self) -> str: """ Returns the title of the current document. @@ -37281,9 +36680,9 @@ Returns: str """ - pass + ... - def IsModified(self,) -> 'Any': + def IsModified(self) -> Any: """ Return a flag indicating if the document has been modified. @@ -37296,9 +36695,9 @@ Returns: Any """ - pass + ... - def OnChangedViewList(self,) -> 'None': + def OnChangedViewList(self) -> None: """ Informs the document when a view is added or removed. @@ -37311,9 +36710,9 @@ Returns: None """ - pass + ... - def OnCloseDocument(self,) -> 'None': + def OnCloseDocument(self) -> None: """ Call the MFC OnCloseDocument handler. @@ -37330,9 +36729,9 @@ Returns: None """ - pass + ... - def OnNewDocument(self,) -> 'None': + def OnNewDocument(self) -> None: """ Call the MFC OnNewDocument handler. @@ -37349,9 +36748,9 @@ Returns: None """ - pass + ... - def OnOpenDocument(self, pathName: 'str') -> 'None': + def OnOpenDocument(self, pathName: str) -> None: """ Call the MFC OnOpenDocument handler. @@ -37368,9 +36767,9 @@ Returns: None """ - pass + ... - def OnSaveDocument(self, pathName: 'str') -> 'None': + def OnSaveDocument(self, pathName: str) -> None: """ Call the MFC OnSaveDocument handler. @@ -37387,9 +36786,9 @@ Returns: None """ - pass + ... - def SetModifiedFlag(self, bModified: 'Any' = 1) -> 'None': + def SetModifiedFlag(self, bModified: Any = 1) -> None: """ Set the "dirty" flag for the document. @@ -37402,9 +36801,9 @@ Returns: None """ - pass + ... - def SaveModified(self,) -> 'Any': + def SaveModified(self) -> Any: """ Call the underlying MFC method. @@ -37419,9 +36818,9 @@ Return ValueNonzero if it is safe to continue and close the document; 0 if the d """ - pass + ... - def SetPathName(self, path: 'str') -> 'None': + def SetPathName(self, path: str) -> None: """ Set the full path name for the document. @@ -37434,9 +36833,9 @@ Returns: None """ - pass + ... - def SetTitle(self, title: 'str') -> 'None': + def SetTitle(self, title: str) -> None: """ Set the title of the document (ie, the name @@ -37451,9 +36850,9 @@ Returns: None """ - pass + ... - def UpdateAllViews(self, sender: 'Any', hint: 'Any' = None) -> 'None': + def UpdateAllViews(self, sender: Any, hint: Any = None) -> None: """ Informs each view when a document changes. @@ -37467,16 +36866,15 @@ Returns: None """ - pass + ... -class PyCEdit(object): - """""" +class PyCEdit: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CreateWindow(self, style: 'Any', rect: 'Tuple[Any, Any, Any, Any]', parent: 'Any', _id: 'Any') -> 'None': + def CreateWindow(self, style: Any, rect: Tuple[Any, Any, Any, Any], parent: Any, _id: Any) -> None: """ Creates the window for a new Edit object. @@ -37492,9 +36890,9 @@ Returns: None """ - pass + ... - def Clear(self,) -> 'Any': + def Clear(self) -> Any: """ Clears all text in an edit control. @@ -37507,9 +36905,9 @@ Returns: Any """ - pass + ... - def Copy(self,) -> 'None': + def Copy(self) -> None: """ Copys the current selection to the clipboard. @@ -37522,9 +36920,9 @@ Returns: None """ - pass + ... - def Cut(self,) -> 'None': + def Cut(self) -> None: """ Cuts the current selection to the clipboard. @@ -37537,9 +36935,9 @@ Returns: None """ - pass + ... - def FmtLines(self, bAddEOL: 'Any') -> 'Any': + def FmtLines(self, bAddEOL: Any) -> Any: """ Sets the formatting options for the control. @@ -37554,9 +36952,9 @@ Return ValueNonzero if any formatting occurs; otherwise 0. """ - pass + ... - def GetFirstVisibleLine(self,) -> 'Any': + def GetFirstVisibleLine(self) -> Any: """ Returns zero-based index of the topmost visible line. @@ -37571,9 +36969,9 @@ Return ValueThe zero-based index of the topmost visible line. For single-line ed """ - pass + ... - def GetSel(self,) -> 'Tuple[Any, Any]': + def GetSel(self) -> Tuple[Any, Any]: """ Returns the start and end of the current selection. @@ -37590,9 +36988,9 @@ end of the current selection) """ - pass + ... - def GetLine(self, lineNo: 'Any') -> 'Any': + def GetLine(self, lineNo: Any) -> Any: """ Returns the text in a specified line. @@ -37605,9 +37003,9 @@ Returns: Any """ - pass + ... - def GetLineCount(self,) -> 'Any': + def GetLineCount(self) -> Any: """ Gets the number of lines in an edit control. @@ -37622,9 +37020,9 @@ Return ValueThe number of lines in the buffer. If the control is empty, the ret """ - pass + ... - def LimitText(self, nChars: 'Any' = 0) -> 'None': + def LimitText(self, nChars: Any = 0) -> None: """ Sets max length of text that user can enter @@ -37637,9 +37035,9 @@ Returns: None """ - pass + ... - def LineFromChar(self, charNo: 'Any' = -1) -> 'Any': + def LineFromChar(self, charNo: Any = -1) -> Any: """ Returns the line number of the specified character. @@ -37658,9 +37056,9 @@ If there is no selection, the current line number is returned. """ - pass + ... - def LineIndex(self, lineNo: 'Any' = -1) -> 'Any': + def LineIndex(self, lineNo: Any = -1) -> Any: """ Retrieves the character index of a line within a multiple-line edit control. @@ -37679,9 +37077,9 @@ the edit control. """ - pass + ... - def LineScroll(self, nLines: 'Any', nChars: 'Any' = 0) -> 'Any': + def LineScroll(self, nLines: Any, nChars: Any = 0) -> Any: """ Scroll the control vertically and horizontally @@ -37695,9 +37093,9 @@ Returns: Any """ - pass + ... - def Paste(self,) -> 'None': + def Paste(self) -> None: """ Pastes the contents of the clipboard into the control. @@ -37710,9 +37108,9 @@ Returns: None """ - pass + ... - def ReplaceSel(self, text: 'str') -> 'None': + def ReplaceSel(self, text: str) -> None: """ Replaces the selection with the specified text. @@ -37725,9 +37123,9 @@ Returns: None """ - pass + ... - def SetReadOnly(self, bReadOnly: 'Any' = 1) -> 'None': + def SetReadOnly(self, bReadOnly: Any = 1) -> None: """ Sets or clears the read-only status of the listbox. @@ -37740,9 +37138,9 @@ Returns: None """ - pass + ... - def SetSel(self, start: 'Any', end: 'Any', arg: 'Any', bNoScroll1: 'Any', bNoScroll: 'Any' = 0) -> 'None': + def SetSel(self, start: Any, end: Any, arg: Any, bNoScroll1: Any, bNoScroll: Any = 0) -> None: """ Sets the selection in the edit control. @@ -37759,16 +37157,15 @@ Returns: None """ - pass + ... -class PyCEditView(object): - """""" +class PyCEditView: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def IsModified(self,) -> 'Any': + def IsModified(self) -> Any: """ Indicates if the view's document has the modified flag set. @@ -37781,9 +37178,9 @@ Returns: Any """ - pass + ... - def LoadFile(self, fileName: 'str') -> 'None': + def LoadFile(self, fileName: str) -> None: """ Loads a file into the view. @@ -37796,9 +37193,9 @@ Returns: None """ - pass + ... - def SetModifiedFlag(self, bModified: 'Any' = 1) -> 'None': + def SetModifiedFlag(self, bModified: Any = 1) -> None: """ Sets the modified flag for the view's document. @@ -37811,9 +37208,9 @@ Returns: None """ - pass + ... - def GetEditCtrl(self,) -> 'Any': + def GetEditCtrl(self) -> Any: """ returns the underlying edit control object. @@ -37826,9 +37223,9 @@ Returns: Any """ - pass + ... - def PreCreateWindow(self, createStruct: 'Any') -> 'Any': + def PreCreateWindow(self, createStruct: Any) -> Any: """ Calls the underlying MFC PreCreateWindow method. @@ -37841,9 +37238,9 @@ Returns: Any """ - pass + ... - def SaveFile(self, fileName: 'str') -> 'None': + def SaveFile(self, fileName: str) -> None: """ Saves the view to a file. @@ -37856,9 +37253,9 @@ Returns: None """ - pass + ... - def OnCommand(self, wparam: 'Any', lparam: 'Any') -> 'None': + def OnCommand(self, wparam: Any, lparam: Any) -> None: """ Calls the standard Python framework OnCommand handler @@ -37872,16 +37269,15 @@ Returns: None """ - pass + ... -class PyCFileDialog(object): - """""" +class PyCFileDialog: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetPathName(self,) -> 'str': + def GetPathName(self) -> str: """ Retrives the path name from the file dialog. @@ -37894,9 +37290,9 @@ Returns: str """ - pass + ... - def GetFileName(self,) -> 'str': + def GetFileName(self) -> str: """ Retrives the file name from the file dialog. @@ -37909,9 +37305,9 @@ Returns: str """ - pass + ... - def GetFileExt(self,) -> 'str': + def GetFileExt(self) -> str: """ Retrives the file extension from the file dialog. @@ -37924,9 +37320,9 @@ Returns: str """ - pass + ... - def GetFileTitle(self,) -> 'str': + def GetFileTitle(self) -> str: """ Retrives the file title from the file dialog. @@ -37939,9 +37335,9 @@ Returns: str """ - pass + ... - def GetPathNames(self,) -> 'str': + def GetPathNames(self) -> str: """ Retrieves the list of path names from the file dialog. @@ -37954,9 +37350,9 @@ Returns: str """ - pass + ... - def GetReadOnlyPref(self,) -> 'Any': + def GetReadOnlyPref(self) -> Any: """ Retrives the value of the "Read Only" checkbox on the file dialog. @@ -37969,9 +37365,9 @@ Returns: Any """ - pass + ... - def SetOFNTitle(self, title: 'str') -> 'None': + def SetOFNTitle(self, title: str) -> None: """ Sets the Title for the dialog. @@ -37984,9 +37380,9 @@ Returns: None """ - pass + ... - def SetOFNInitialDir(self, title: 'str') -> 'None': + def SetOFNInitialDir(self, title: str) -> None: """ Sets the initial directory for the dialog. @@ -37999,16 +37395,15 @@ Returns: None """ - pass + ... -class PyCFont(object): - """""" +class PyCFont: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetSafeHandle(self,) -> 'Any': + def GetSafeHandle(self) -> Any: """ Retrieves the HFONT for the font as an integer @@ -38021,16 +37416,15 @@ Returns: Any """ - pass + ... -class PyCFontDialog(object): - """""" +class PyCFontDialog: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def DoModal(self,) -> 'Any': + def DoModal(self) -> Any: """ Displays a dialog and allows the user to make a selection. @@ -38043,9 +37437,9 @@ Returns: Any """ - pass + ... - def GetCurrentFont(self,) -> 'Any': + def GetCurrentFont(self) -> Any: """ Returns a dictionary describing the current font. @@ -38058,9 +37452,9 @@ Returns: Any """ - pass + ... - def GetCharFormat(self,) -> 'Any': + def GetCharFormat(self) -> Any: """ Returns the font selection in a CHARFORMAT tuple. @@ -38073,9 +37467,9 @@ Returns: Any """ - pass + ... - def GetColor(self,) -> 'Any': + def GetColor(self) -> Any: """ Determines the color of the selected font. @@ -38088,9 +37482,9 @@ Returns: Any """ - pass + ... - def GetFaceName(self,) -> 'str': + def GetFaceName(self) -> str: """ Returns the face name of the selected font. @@ -38103,9 +37497,9 @@ Returns: str """ - pass + ... - def GetStyleName(self,) -> 'str': + def GetStyleName(self) -> str: """ Returns the style name of the selected font. @@ -38118,9 +37512,9 @@ Returns: str """ - pass + ... - def GetSize(self,) -> 'Any': + def GetSize(self) -> Any: """ Returns he font's size, in tenths of a point. @@ -38133,9 +37527,9 @@ Returns: Any """ - pass + ... - def GetWeight(self,) -> 'Any': + def GetWeight(self) -> Any: """ Returns the font's weight. @@ -38148,9 +37542,9 @@ Returns: Any """ - pass + ... - def IsStrikeOut(self,) -> 'Any': + def IsStrikeOut(self) -> Any: """ Determines whether the font is displayed with strikeout. @@ -38163,9 +37557,9 @@ Returns: Any """ - pass + ... - def IsUnderline(self,) -> 'Any': + def IsUnderline(self) -> Any: """ Determines whether the font is displayed with underline. @@ -38178,9 +37572,9 @@ Returns: Any """ - pass + ... - def IsBold(self,) -> 'Any': + def IsBold(self) -> Any: """ Determines whether the font is displayed bold. @@ -38193,9 +37587,9 @@ Returns: Any """ - pass + ... - def IsItalic(self,) -> 'Any': + def IsItalic(self) -> Any: """ Determines whether the font is displayed with italic. @@ -38208,16 +37602,16 @@ Returns: Any """ - pass + ... -class PyCFormView(object): +class PyCFormView: """A class which implementes a CFormView (ie, a view based on a dialog resource.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def OnCommand(self, wparam: 'Any', lparam: 'Any') -> 'None': + def OnCommand(self, wparam: Any, lparam: Any) -> None: """ Calls the standard Python framework OnCommand handler @@ -38231,16 +37625,15 @@ Returns: None """ - pass + ... -class PyCFrameWnd(object): - """""" +class PyCFrameWnd: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def BeginModalState(self,) -> 'None': + def BeginModalState(self) -> None: """ Sets the frame window to modal. @@ -38253,18 +37646,18 @@ Returns: None """ - pass + ... def CreateWindow( self, - wndClass: 'str', - title: 'str', - style: 'Any', - PyCWnd: 'Any', - menuId: 'Any', - styleEx: 'Any', - rect: 'Tuple[Any, Any, Any, Any]' = None, - createContext: 'Any' = None) -> 'Any': + wndClass: str, + title: str, + style: Any, + PyCWnd: Any, + menuId: Any, + styleEx: Any, + rect: Tuple[Any, Any, Any, Any] = None, + createContext: Any = None) -> Any: """ Creates the actual window for the PyCFrameWnd object. @@ -38284,9 +37677,9 @@ Returns: Any """ - pass + ... - def EndModalState(self,) -> 'None': + def EndModalState(self) -> None: """ None @@ -38299,9 +37692,9 @@ Returns: None """ - pass + ... - def DockControlBar(self, controlBar: 'Any', arg: 'Tuple[Any, Any, Any, Any]', dockBarId: 'Any' = 0) -> 'None': + def DockControlBar(self, controlBar: Any, arg: Tuple[Any, Any, Any, Any], dockBarId: Any = 0) -> None: """ Docks a control bar. @@ -38316,9 +37709,9 @@ Returns: None """ - pass + ... - def EnableDocking(self, style: 'Any') -> 'None': + def EnableDocking(self, style: Any) -> None: """ Enable dockable control bars in a frame window @@ -38331,9 +37724,9 @@ Returns: None """ - pass + ... - def FloatControlBar(self, controlBar: 'Any', arg: 'Tuple[Any, Any]', style: 'Any') -> 'None': + def FloatControlBar(self, controlBar: Any, arg: Tuple[Any, Any], style: Any) -> None: """ Floats a control bar. @@ -38348,9 +37741,9 @@ Returns: None """ - pass + ... - def GetActiveDocument(self,) -> 'Any': + def GetActiveDocument(self) -> Any: """ Gets the currently active document, else None @@ -38363,9 +37756,9 @@ Returns: Any """ - pass + ... - def GetControlBar(self, _id: 'Any') -> 'Any': + def GetControlBar(self, _id: Any) -> Any: """ Retrieves the specified control bar. @@ -38378,9 +37771,9 @@ Returns: Any """ - pass + ... - def GetMessageString(self, _id: 'Any') -> 'str': + def GetMessageString(self, _id: Any) -> str: """ Retrieves message corresponding to a command ID. @@ -38393,9 +37786,9 @@ Returns: str """ - pass + ... - def GetMessageBar(self,) -> 'Any': + def GetMessageBar(self) -> Any: """ Retrieves the message bar for the frame. @@ -38408,9 +37801,9 @@ Returns: Any """ - pass + ... - def IsTracking(self,) -> 'Any': + def IsTracking(self) -> Any: """ Determines if splitter bar is currently being moved. @@ -38423,9 +37816,9 @@ Returns: Any """ - pass + ... - def InModalState(self,) -> 'Any': + def InModalState(self) -> Any: """ Returns a value indicating whether or not a frame window is in a modal state. @@ -38438,9 +37831,9 @@ Returns: Any """ - pass + ... - def LoadAccelTable(self, _id: 'PyResourceId') -> 'None': + def LoadAccelTable(self, _id: PyResourceId) -> None: """ Loads an accelerator table. @@ -38453,9 +37846,9 @@ Returns: None """ - pass + ... - def LoadFrame(self, idResource: 'Any', style: 'Any' = -1, wndParent: 'Any' = None, context: 'Any' = None) -> 'None': + def LoadFrame(self, idResource: Any, style: Any = -1, wndParent: Any = None, context: Any = None) -> None: """ Loads a Windows frame window and associated resources @@ -38471,9 +37864,9 @@ Returns: None """ - pass + ... - def LoadBarState(self, profileName: 'str') -> 'None': + def LoadBarState(self, profileName: str) -> None: """ Loads a control bars settings @@ -38486,9 +37879,9 @@ Returns: None """ - pass + ... - def PreCreateWindow(self, createStruct: 'Any') -> 'Any': + def PreCreateWindow(self, createStruct: Any) -> Any: """ Calls the underlying MFC PreCreateWindow method. @@ -38501,9 +37894,9 @@ Returns: Any """ - pass + ... - def SaveBarState(self, profileName: 'str') -> 'None': + def SaveBarState(self, profileName: str) -> None: """ Saves a control bars settings @@ -38516,9 +37909,9 @@ Returns: None """ - pass + ... - def ShowControlBar(self, controlBar: 'Any', bShow: 'Any', bDelay: 'Any') -> 'None': + def ShowControlBar(self, controlBar: Any, bShow: Any, bDelay: Any) -> None: """ Shows a control bar. @@ -38533,9 +37926,9 @@ Returns: None """ - pass + ... - def RecalcLayout(self, bNotify: 'Any' = 1) -> 'None': + def RecalcLayout(self, bNotify: Any = 1) -> None: """ Called by the framework when the standard control bars are toggled on or off or @@ -38550,9 +37943,9 @@ Returns: None """ - pass + ... - def GetActiveView(self,) -> 'Any': + def GetActiveView(self) -> Any: """ Retrieves the active view. @@ -38565,9 +37958,9 @@ Returns: Any """ - pass + ... - def OnBarCheck(self, _id: 'Any') -> 'Any': + def OnBarCheck(self, _id: Any) -> Any: """ Changes the state of the specified controlbar. @@ -38580,9 +37973,9 @@ Returns: Any """ - pass + ... - def OnUpdateControlBarMenu(self, cmdUI: 'Any') -> 'Any': + def OnUpdateControlBarMenu(self, cmdUI: Any) -> Any: """ Checks the state of a menu item @@ -38595,9 +37988,9 @@ Returns: Any """ - pass + ... - def SetActiveView(self, view: 'Any', bNotify: 'Any' = 1) -> 'None': + def SetActiveView(self, view: Any, bNotify: Any = 1) -> None: """ Sets the active view for a frame. @@ -38611,23 +38004,23 @@ Returns: None """ - pass + ... -class PyCGdiObject(object): +class PyCGdiObject: """A class which encapsulates an MFC CGdiObject.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyCImageList(object): +class PyCImageList: """A Python type encapsulating an MFC CImageList class.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Add(self, arg: 'Tuple[Any, Any]', bitmap: 'Any', color: 'Any', hIcon: 'Any') -> 'Any': + def Add(self, arg: Tuple[Any, Any], bitmap: Any, color: Any, hIcon: Any) -> Any: """ Adds an image to the list. @@ -38645,9 +38038,9 @@ Return ValueZero-based index of the first new image. """ - pass + ... - def Destroy(self,) -> 'None': + def Destroy(self) -> None: """ Destroys the underlying CImageList @@ -38660,9 +38053,9 @@ Returns: None """ - pass + ... - def DeleteImageList(self,) -> 'None': + def DeleteImageList(self) -> None: """ Deletes an image list. @@ -38675,9 +38068,9 @@ Returns: None """ - pass + ... - def GetBkColor(self,) -> 'Any': + def GetBkColor(self) -> Any: """ Retrieves the background color of an Image List. @@ -38690,9 +38083,9 @@ Returns: Any """ - pass + ... - def GetSafeHandle(self,) -> 'Any': + def GetSafeHandle(self) -> Any: """ Retrieves the HIMAGELIST for the object @@ -38705,9 +38098,9 @@ Returns: Any """ - pass + ... - def GetImageCount(self,) -> 'Any': + def GetImageCount(self) -> Any: """ Retrieves the number of images in an image list. @@ -38720,9 +38113,9 @@ Returns: Any """ - pass + ... - def GetImageInfo(self, index: 'Any') -> 'Any': + def GetImageInfo(self, index: Any) -> Any: """ Retrieves information about an image. @@ -38736,9 +38129,9 @@ Returns: """ - pass + ... - def SetBkColor(self, color: 'Any') -> 'None': + def SetBkColor(self, color: Any) -> None: """ Sets the background color for an Image List. @@ -38751,16 +38144,15 @@ Returns: None """ - pass + ... -class PyCListBox(object): - """""" +class PyCListBox: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def AddString(self, _object: 'Any') -> 'Any': + def AddString(self, _object: Any) -> Any: """ Adds a string to a listbox. @@ -38775,9 +38167,9 @@ Return ValueThe zero based index of the new string. """ - pass + ... - def DeleteString(self, pos: 'Any') -> 'Any': + def DeleteString(self, pos: Any) -> Any: """ Deletes an item from a listbox. @@ -38792,9 +38184,9 @@ Return ValueThe count of the items remaining in the list. """ - pass + ... - def Dir(self, attr: 'Any', wild: 'str') -> 'Any': + def Dir(self, attr: Any, wild: str) -> Any: """ Fills a listbox with a directory listing. @@ -38810,9 +38202,9 @@ Return ValueThe index of the last file name added to the list. """ - pass + ... - def GetCaretIndex(self,) -> 'Any': + def GetCaretIndex(self) -> Any: """ Returns the index of the item which has focus. @@ -38833,9 +38225,9 @@ any. """ - pass + ... - def GetCount(self,) -> 'Any': + def GetCount(self) -> Any: """ Returns the count of items in the listbox. @@ -38850,9 +38242,9 @@ Return ValueReturns the number of items currently in the listbox. """ - pass + ... - def GetCurSel(self,) -> 'Any': + def GetCurSel(self) -> Any: """ Returns the index of the currently selected item. @@ -38865,9 +38257,9 @@ Returns: Any """ - pass + ... - def GetItemData(self, item: 'Any') -> 'Any': + def GetItemData(self, item: Any) -> Any: """ Retrieves the application-specific object associated with an item. @@ -38880,9 +38272,9 @@ Returns: Any """ - pass + ... - def GetItemValue(self, item: 'Any') -> 'Any': + def GetItemValue(self, item: Any) -> Any: """ Retrieves the application-specific value associated with an item. @@ -38895,9 +38287,9 @@ Returns: Any """ - pass + ... - def GetSel(self, index: 'Any') -> 'Any': + def GetSel(self, index: Any) -> Any: """ Returns the selection state of a specified item. @@ -38912,9 +38304,9 @@ Return ValueA +ve number if the item is selected, else zero. """ - pass + ... - def GetSelCount(self,) -> 'Any': + def GetSelCount(self) -> Any: """ Returns the number of selected items in a multiple selection listbox. @@ -38927,9 +38319,9 @@ Returns: Any """ - pass + ... - def GetSelItems(self,) -> 'Any': + def GetSelItems(self) -> Any: """ Returns a list of the indexes of the currently selected items in a multiple @@ -38944,9 +38336,9 @@ Returns: Any """ - pass + ... - def GetSelTextItems(self,) -> 'Any': + def GetSelTextItems(self) -> Any: """ Returns a list of the strings of the currently selected items in a multiple @@ -38961,9 +38353,9 @@ Returns: Any """ - pass + ... - def GetTopIndex(self,) -> 'Any': + def GetTopIndex(self) -> Any: """ Returns the index of the top most visible item. @@ -38978,9 +38370,9 @@ Return ValueThe zero based index of the top most visible item. """ - pass + ... - def GetText(self, index: 'Any') -> 'str': + def GetText(self, index: Any) -> str: """ Returns the string for a specified item. @@ -38993,9 +38385,9 @@ Returns: str """ - pass + ... - def GetTextLen(self, index: 'Any') -> 'Any': + def GetTextLen(self, index: Any) -> Any: """ Returns the length of the string for a specified item. @@ -39008,9 +38400,9 @@ Returns: Any """ - pass + ... - def InsertString(self, pos: 'Any', _object: 'Any') -> 'Any': + def InsertString(self, pos: Any, _object: Any) -> Any: """ Insert a string into a listbox. @@ -39026,9 +38418,9 @@ Return ValueThe zero based index of the new string added. """ - pass + ... - def ResetContent(self,) -> 'None': + def ResetContent(self) -> None: """ Clear all the items from a listbox. @@ -39041,9 +38433,9 @@ Returns: None """ - pass + ... - def SetCaretIndex(self, index: 'Any', bScroll: 'Any' = 1) -> 'None': + def SetCaretIndex(self, index: Any, bScroll: Any = 1) -> None: """ Sets the focus rectange to a specified item. @@ -39057,9 +38449,9 @@ Returns: None """ - pass + ... - def SelectString(self, after: 'Any', string: 'str') -> 'None': + def SelectString(self, after: Any, string: str) -> None: """ Searches for a list-box item that matches the specified string, and selects it. @@ -39075,9 +38467,9 @@ Return ValueThe return value is always None - an exception is raised if the stri """ - pass + ... - def SelItemRange(self, bSel: 'Any', start: 'Any', end: 'Any') -> 'None': + def SelItemRange(self, bSel: Any, start: Any, end: Any) -> None: """ Selects an item range. @@ -39092,9 +38484,9 @@ Returns: None """ - pass + ... - def SetCurSel(self, index: 'Any') -> 'None': + def SetCurSel(self, index: Any) -> None: """ Selects an item in a single selection listbox. @@ -39107,9 +38499,9 @@ Returns: None """ - pass + ... - def SetItemData(self, item: 'Any', Data: 'Any') -> 'Any': + def SetItemData(self, item: Any, Data: Any) -> Any: """ Sets the item's application-specific object value. @@ -39123,9 +38515,9 @@ Returns: Any """ - pass + ... - def SetItemValue(self, item: 'Any', data: 'Any') -> 'Any': + def SetItemValue(self, item: Any, data: Any) -> Any: """ Sets the item's application-specific value. @@ -39139,9 +38531,9 @@ Returns: Any """ - pass + ... - def SetSel(self, index: 'Any', bSel: 'Any' = 1) -> 'None': + def SetSel(self, index: Any, bSel: Any = 1) -> None: """ Selects an item in a multiple selection listbox. @@ -39155,9 +38547,9 @@ Returns: None """ - pass + ... - def SetTabStops(self, eachTabStop: 'Any', tabStops: 'Any') -> 'None': + def SetTabStops(self, eachTabStop: Any, tabStops: Any) -> None: """ Sets the tab stops for a listbox. @@ -39171,9 +38563,9 @@ Returns: None """ - pass + ... - def SetTopIndex(self, index: 'Any') -> 'None': + def SetTopIndex(self, index: Any) -> None: """ Sets the top index (top most visible item) of the listbox. @@ -39186,16 +38578,15 @@ Returns: None """ - pass + ... -class PyCListCtrl(object): - """""" +class PyCListCtrl: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Arrange(self, code: 'Any') -> 'None': + def Arrange(self, code: Any) -> None: """ Aligns items on a grid. @@ -39208,9 +38599,9 @@ Returns: None """ - pass + ... - def CreateWindow(self, style: 'Any', rect: 'Tuple[Any, Any, Any, Any]', PyCWnd: 'Any', _id: 'Any') -> 'None': + def CreateWindow(self, style: Any, rect: Tuple[Any, Any, Any, Any], PyCWnd: Any, _id: Any) -> None: """ Creates the actual window for the object. @@ -39226,9 +38617,9 @@ Returns: None """ - pass + ... - def DeleteAllItems(self,) -> 'None': + def DeleteAllItems(self) -> None: """ Deletes all items from the list. @@ -39241,9 +38632,9 @@ Returns: None """ - pass + ... - def DeleteItem(self, item: 'Any') -> 'None': + def DeleteItem(self, item: Any) -> None: """ Deletes the specified item. @@ -39256,9 +38647,9 @@ Returns: None """ - pass + ... - def GetTextColor(self,) -> 'Any': + def GetTextColor(self) -> Any: """ Retrieves the text color of a list view control. @@ -39271,9 +38662,9 @@ Returns: Any """ - pass + ... - def SetTextColor(self, color: 'Any') -> 'None': + def SetTextColor(self, color: Any) -> None: """ Sets the text color of a list view control. @@ -39286,9 +38677,9 @@ Returns: None """ - pass + ... - def GetBkColor(self,) -> 'Any': + def GetBkColor(self) -> Any: """ Retrieves the background color of the control. @@ -39301,9 +38692,9 @@ Returns: Any """ - pass + ... - def SetBkColor(self, color: 'Any') -> 'None': + def SetBkColor(self, color: Any) -> None: """ Sets the background color of the control. @@ -39316,9 +38707,9 @@ Returns: None """ - pass + ... - def GetItem(self, item: 'Any', sub: 'Any') -> 'Any': + def GetItem(self, item: Any, sub: Any) -> Any: """ Retrieves the details of an items attributes. @@ -39332,9 +38723,9 @@ Returns: Any """ - pass + ... - def GetItemCount(self,) -> 'Any': + def GetItemCount(self) -> Any: """ Retrieves the number of items in a list view control. @@ -39347,9 +38738,9 @@ Returns: Any """ - pass + ... - def GetItemRect(self, item: 'Any', bTextOnly: 'Any') -> 'Tuple[Any, Any, Any, Any]': + def GetItemRect(self, item: Any, bTextOnly: Any) -> Tuple[Any, Any, Any, Any]: """ Retrieves the bounding rectangle of a list view item. @@ -39363,9 +38754,9 @@ Returns: Tuple[Any, Any, Any, Any] """ - pass + ... - def GetEditControl(self,) -> 'Any': + def GetEditControl(self) -> Any: """ Retrieves the handle of the edit control used to edit the specified @@ -39380,9 +38771,9 @@ Returns: Any """ - pass + ... - def EditLabel(self, item: 'Any') -> 'Any': + def EditLabel(self, item: Any) -> Any: """ Edits a specified list view item in-place. @@ -39395,9 +38786,9 @@ Returns: Any """ - pass + ... - def EnsureVisible(self, item: 'Any', bPartialOK: 'Any') -> 'Any': + def EnsureVisible(self, item: Any, bPartialOK: Any) -> Any: """ Ensures that a list view item is visible in its list view control. @@ -39411,9 +38802,9 @@ Returns: Any """ - pass + ... - def CreateDragImage(self, item: 'Any') -> 'Tuple[Any, Any, Any]': + def CreateDragImage(self, item: Any) -> Tuple[Any, Any, Any]: """ Creates a dragging bitmap for the specified list view @@ -39428,9 +38819,9 @@ Returns: Tuple[Any, Any, Any] """ - pass + ... - def GetImageList(self, nImageList: 'Any') -> 'Any': + def GetImageList(self, nImageList: Any) -> Any: """ Retrieves the current image list. @@ -39443,9 +38834,9 @@ Returns: Any """ - pass + ... - def GetNextItem(self, item: 'Any', flags: 'Any') -> 'Any': + def GetNextItem(self, item: Any, flags: Any) -> Any: """ Searches for a list view item with specified properties and with specified @@ -39474,9 +38865,9 @@ next item.Return ValueReturns an integer index, or raises a win32ui.error except """ - pass + ... - def InsertColumn(self, colNo: 'Any', item: 'Any') -> 'Any': + def InsertColumn(self, colNo: Any, item: Any) -> Any: """ Inserts a column into a list control when in report view. @@ -39490,9 +38881,9 @@ Returns: Any """ - pass + ... - def InsertItem(self, item: 'Any', item1: 'Any', text: 'Any', image: 'Any', item2: 'Any', text1: 'Any') -> 'Any': + def InsertItem(self, item: Any, item1: Any, text: Any, image: Any, item2: Any, text1: Any) -> Any: """ Inserts an item into the list. @@ -39510,9 +38901,9 @@ Returns: Any """ - pass + ... - def SetImageList(self, imageList: 'Any', imageType: 'Any') -> 'Any': + def SetImageList(self, imageList: Any, imageType: Any) -> Any: """ Assigns an image list to a list view control. @@ -39526,9 +38917,9 @@ Returns: Any """ - pass + ... - def GetColumn(self, column: 'Any') -> 'Any': + def GetColumn(self, column: Any) -> Any: """ Retrieves the details of a column in the control. @@ -39541,9 +38932,9 @@ Returns: Any """ - pass + ... - def GetTextBkColor(self,) -> 'Any': + def GetTextBkColor(self) -> Any: """ Retrieves the text background color of a list view control. @@ -39556,9 +38947,9 @@ Returns: Any """ - pass + ... - def SetTextBkColor(self, color: 'Any') -> 'None': + def SetTextBkColor(self, color: Any) -> None: """ Sets the text background color of a list view control. @@ -39571,9 +38962,9 @@ Returns: None """ - pass + ... - def GetTopIndex(self,) -> 'Any': + def GetTopIndex(self) -> Any: """ Retrieves the index of the topmost visible item. @@ -39586,9 +38977,9 @@ Returns: Any """ - pass + ... - def GetCountPerPage(self,) -> 'Any': + def GetCountPerPage(self) -> Any: """ Calculates the number of items that can fit vertically in a list view @@ -39603,9 +38994,9 @@ Returns: Any """ - pass + ... - def GetSelectedCount(self,) -> 'Any': + def GetSelectedCount(self) -> Any: """ Retrieves the number of selected items in the list view control. @@ -39618,9 +39009,9 @@ Returns: Any """ - pass + ... - def SetItem(self, item: 'Any') -> 'Any': + def SetItem(self, item: Any) -> Any: """ Sets some of all of an items attributes. @@ -39633,9 +39024,9 @@ Returns: Any """ - pass + ... - def SetItemState(self, item: 'Any', state: 'Any', mask: 'Any') -> 'Any': + def SetItemState(self, item: Any, state: Any, mask: Any) -> Any: """ Changes the state of an item in a list view control. @@ -39650,9 +39041,9 @@ Returns: Any """ - pass + ... - def GetItemState(self, item: 'Any', mask: 'Any') -> 'Any': + def GetItemState(self, item: Any, mask: Any) -> Any: """ Retrieves the state of a list view item. @@ -39666,9 +39057,9 @@ Returns: Any """ - pass + ... - def SetItemData(self, item: 'Any', Data: 'Any') -> 'Any': + def SetItemData(self, item: Any, Data: Any) -> Any: """ Sets the item's application-specific value. @@ -39682,9 +39073,9 @@ Returns: Any """ - pass + ... - def GetItemData(self, item: 'Any') -> 'Any': + def GetItemData(self, item: Any) -> Any: """ Retrieves the application-specific value associated with an item. @@ -39697,9 +39088,9 @@ Returns: Any """ - pass + ... - def SetItemCount(self, count: 'Any') -> 'None': + def SetItemCount(self, count: Any) -> None: """ Prepares a list view control for adding a large number of items. @@ -39712,9 +39103,9 @@ Returns: None """ - pass + ... - def SetItemText(self, item: 'Any', sub: 'Any', text: 'str') -> 'Any': + def SetItemText(self, item: Any, sub: Any, text: str) -> Any: """ Changes the text of a list view item or subitem. @@ -39729,9 +39120,9 @@ Returns: Any """ - pass + ... - def GetItemText(self, item: 'Any', sub: 'Any') -> 'Any': + def GetItemText(self, item: Any, sub: Any) -> Any: """ Retrieves the text of a list view item or subitem. @@ -39745,9 +39136,9 @@ Returns: Any """ - pass + ... - def RedrawItems(self, first: 'Any', first1: 'Any') -> 'Any': + def RedrawItems(self, first: Any, first1: Any) -> Any: """ Forces a listview to repaint a range of items. @@ -39761,9 +39152,9 @@ Returns: Any """ - pass + ... - def Update(self, item: 'Any') -> 'None': + def Update(self, item: Any) -> None: """ Forces the control to repaint a specified item. @@ -39776,9 +39167,9 @@ Returns: None """ - pass + ... - def SetColumn(self, colNo: 'Any', item: 'Any') -> 'Any': + def SetColumn(self, colNo: Any, item: Any) -> Any: """ Changes column state in a list control when in report view. @@ -39792,9 +39183,9 @@ Returns: Any """ - pass + ... - def DeleteColumn(self, first: 'Any') -> 'Any': + def DeleteColumn(self, first: Any) -> Any: """ Deletes the specified column from the list control. @@ -39807,9 +39198,9 @@ Returns: Any """ - pass + ... - def GetColumnWidth(self, first: 'Any') -> 'Any': + def GetColumnWidth(self, first: Any) -> Any: """ Gets the width of the specified column in the list control. @@ -39822,9 +39213,9 @@ Returns: Any """ - pass + ... - def SetColumnWidth(self, first: 'Any', first1: 'Any') -> 'Any': + def SetColumnWidth(self, first: Any, first1: Any) -> Any: """ Sets the width of the specified column in the list control. @@ -39838,9 +39229,9 @@ Returns: Any """ - pass + ... - def GetStringWidth(self, first: 'Any') -> 'Any': + def GetStringWidth(self, first: Any) -> Any: """ Gets the necessary column width to fully display this text in a column. @@ -39853,9 +39244,9 @@ Returns: Any """ - pass + ... - def HitTest(self, arg: 'Any') -> 'Tuple[Any, Any, Any]': + def HitTest(self, arg: Any) -> Tuple[Any, Any, Any]: """ Determines which list view item, if any, is at a specified position. @@ -39891,9 +39282,9 @@ commctrl.LVHT_TORIGHTThe position is to the right of the list view control's cli """ - pass + ... - def GetItemPosition(self, item: 'Any') -> 'Tuple[Any, Any]': + def GetItemPosition(self, item: Any) -> Tuple[Any, Any]: """ Determines the position of the specified item. @@ -39906,16 +39297,15 @@ Returns: Tuple[Any, Any] """ - pass + ... -class PyCListView(object): - """""" +class PyCListView: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def PreCreateWindow(self, createStruct: 'Any') -> 'Any': + def PreCreateWindow(self, createStruct: Any) -> Any: """ Calls the underlying MFC PreCreateWindow method. @@ -39928,9 +39318,9 @@ Returns: Any """ - pass + ... - def GetListCtrl(self,) -> 'Any': + def GetListCtrl(self) -> Any: """ Returns the underlying list control object. @@ -39943,9 +39333,9 @@ Returns: Any """ - pass + ... - def OnCommand(self, wparam: 'Any', lparam: 'Any') -> 'None': + def OnCommand(self, wparam: Any, lparam: Any) -> None: """ Calls the standard Python framework OnCommand handler @@ -39959,16 +39349,15 @@ Returns: None """ - pass + ... -class PyCMDIChildWnd(object): - """""" +class PyCMDIChildWnd: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def ActivateFrame(self, cmdShow: 'Any' = -1) -> 'None': + def ActivateFrame(self, cmdShow: Any = -1) -> None: """ Calls the underlying MFC ActivateFrame method. @@ -39981,16 +39370,16 @@ Returns: None """ - pass + ... def CreateWindow( self, - wndClass: 'str', - title: 'str', - style: 'Any', - PyCWnd: 'Any', - rect: 'Tuple[Any, Any, Any, Any]' = None, - createContext: 'Any' = None) -> 'Any': + wndClass: str, + title: str, + style: Any, + PyCWnd: Any, + rect: Tuple[Any, Any, Any, Any] = None, + createContext: Any = None) -> Any: """ Creates the actual window for the PyCWnd object. @@ -40008,9 +39397,9 @@ Returns: Any """ - pass + ... - def GetMDIFrame(self,) -> 'None': + def GetMDIFrame(self) -> None: """ Returns the MDI parent frame @@ -40023,9 +39412,9 @@ Returns: None """ - pass + ... - def MDIActivate(self, cmdShow: 'Any' = -1) -> 'None': + def MDIActivate(self, cmdShow: Any = -1) -> None: """ Activates the MDI frame independent of the main frame. @@ -40038,9 +39427,9 @@ Returns: None """ - pass + ... - def PreCreateWindow(self, createStruct: 'Any') -> 'Any': + def PreCreateWindow(self, createStruct: Any) -> Any: """ Calls the underlying MFC PreCreateWindow method. @@ -40053,9 +39442,9 @@ Returns: Any """ - pass + ... - def PreTranslateMessage(self,) -> 'None': + def PreTranslateMessage(self) -> None: """ Calls the base PreTranslateMessage handler @@ -40068,9 +39457,9 @@ Returns: None """ - pass + ... - def OnCommand(self, wparam: 'Any', lparam: 'Any') -> 'None': + def OnCommand(self, wparam: Any, lparam: Any) -> None: """ Calls the standard Python framework OnCommand handler @@ -40084,9 +39473,9 @@ Returns: None """ - pass + ... - def OnClose(self,) -> 'None': + def OnClose(self) -> None: """ Calls the standard Python framework OnClose handler @@ -40099,16 +39488,15 @@ Returns: None """ - pass + ... -class PyCMDIFrameWnd(object): - """""" +class PyCMDIFrameWnd: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetMDIClient(self,) -> 'Any': + def GetMDIClient(self) -> Any: """ Returns the MDI client window @@ -40121,9 +39509,9 @@ Returns: Any """ - pass + ... - def MDIGetActive(self,) -> 'Tuple[Any, Any]': + def MDIGetActive(self) -> Tuple[Any, Any]: """ Retrieves the current active MDI child window, along @@ -40138,9 +39526,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def MDIActivate(self, window: 'Any') -> 'Any': + def MDIActivate(self, window: Any) -> Any: """ Activate an MDI child window @@ -40153,9 +39541,9 @@ Returns: Any """ - pass + ... - def MDINext(self, fNext: 'Any' = 0) -> 'None': + def MDINext(self, fNext: Any = 0) -> None: """ Activates the next MDI window @@ -40168,9 +39556,9 @@ Returns: None """ - pass + ... - def PreCreateWindow(self, createStruct: 'Any') -> 'Any': + def PreCreateWindow(self, createStruct: Any) -> Any: """ Calls the underlying MFC PreCreateWindow method. @@ -40183,9 +39571,9 @@ Returns: Any """ - pass + ... - def PreTranslateMessage(self,) -> 'None': + def PreTranslateMessage(self) -> None: """ Calls the base PreTranslateMessage handler @@ -40198,9 +39586,9 @@ Returns: None """ - pass + ... - def OnCommand(self, wparam: 'Any', lparam: 'Any') -> 'None': + def OnCommand(self, wparam: Any, lparam: Any) -> None: """ Calls the standard Python framework OnCommand handler @@ -40214,9 +39602,9 @@ Returns: None """ - pass + ... - def OnContextHelp(self,) -> 'Any': + def OnContextHelp(self) -> Any: """ Calls the underlying MFC OnContextHelp method. @@ -40229,9 +39617,9 @@ Returns: Any """ - pass + ... - def OnClose(self,) -> 'None': + def OnClose(self) -> None: """ Calls the standard Python framework OnClose handler @@ -40244,16 +39632,15 @@ Returns: None """ - pass + ... -class PyCMenu(object): - """""" +class PyCMenu: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def AppendMenu(self, flags: 'Any', _id: 'Any' = 0, value: 'Union[Any, str]' = None) -> 'None': + def AppendMenu(self, flags: Any, _id: Any = 0, value: Union[Any, str] = None) -> None: """ Appends a new item to the end of a menu. Python can specify the state of the menu item @@ -40270,9 +39657,9 @@ Returns: None """ - pass + ... - def DeleteMenu(self, _id: 'Any', flags: 'Any') -> 'str': + def DeleteMenu(self, _id: Any, flags: Any) -> str: """ Deletes the specified menu item. @@ -40286,9 +39673,9 @@ Returns: str """ - pass + ... - def EnableMenuItem(self, _id: 'Any', flags: 'Any') -> 'Any': + def EnableMenuItem(self, _id: Any, flags: Any) -> Any: """ Enables, disables, or dims a menu item. @@ -40302,9 +39689,9 @@ Returns: Any """ - pass + ... - def GetHandle(self,) -> 'Any': + def GetHandle(self) -> Any: """ Returns the menu object's underlying hMenu. @@ -40317,9 +39704,9 @@ Returns: Any """ - pass + ... - def GetMenuItemCount(self,) -> 'Any': + def GetMenuItemCount(self) -> Any: """ Determines the number of items in a menu. @@ -40336,9 +39723,9 @@ Return ValueThe number of items in the menu if the function is successful; other """ - pass + ... - def GetMenuItemID(self, pos: 'Any') -> 'Any': + def GetMenuItemID(self, pos: Any) -> Any: """ Returns the item ID for the specified item in a pop-up menu. @@ -40351,9 +39738,9 @@ Returns: Any """ - pass + ... - def GetMenuString(self, _id: 'Any', arg: 'Any') -> 'str': + def GetMenuString(self, _id: Any, arg: Any) -> str: """ Returns the string for a specified menu item. @@ -40367,9 +39754,9 @@ Returns: str """ - pass + ... - def GetSubMenu(self, pos: 'Any') -> 'Any': + def GetSubMenu(self, pos: Any) -> Any: """ Returns a submenu. @@ -40382,9 +39769,9 @@ Returns: Any """ - pass + ... - def InsertMenu(self, pos: 'Any', flags: 'Any', _id: 'Union[Any]' = 0, value: 'Union[Any, str]' = None) -> 'None': + def InsertMenu(self, pos: Any, flags: Any, _id: Any = 0, value: Union[Any, str] = None) -> None: """ Inserts an item into a menu. @@ -40392,7 +39779,7 @@ Args: pos(Any):The position (zero-based) the item should be inserted. flags(Any):Flags for the new item. - _id(Union[Any]):The ID for a new menu item, or handle to a submenu + _id(Any):The ID for a new menu item, or handle to a submenu value(Union[Any, str]):A string for the menu item. Returns: @@ -40400,9 +39787,9 @@ Returns: None """ - pass + ... - def ModifyMenu(self, pos: 'Any', flags: 'Any', _id: 'Any' = 0, value: 'Union[Any, str]' = None) -> 'None': + def ModifyMenu(self, pos: Any, flags: Any, _id: Any = 0, value: Union[Any, str] = None) -> None: """ Modify an item in a menu. @@ -40418,9 +39805,9 @@ Returns: None """ - pass + ... - def TrackPopupMenu(self, arg: 'Tuple[Any, Any]', arg1: 'Any', arg2: 'Any') -> 'None': + def TrackPopupMenu(self, arg: Tuple[Any, Any], arg1: Any, arg2: Any) -> None: """ Creates a popup menu anywhere on the screen. @@ -40446,16 +39833,15 @@ returned instead of the normal exception. """ - pass + ... -class PyCOleClientItem(object): - """""" +class PyCOleClientItem: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CreateNewItem(self,) -> 'None': + def CreateNewItem(self) -> None: """ Creates an embedded item. @@ -40468,9 +39854,9 @@ Returns: None """ - pass + ... - def Close(self,) -> 'None': + def Close(self) -> None: """ Closes the item @@ -40483,9 +39869,9 @@ Returns: None """ - pass + ... - def DoVerb(self,) -> 'None': + def DoVerb(self) -> None: """ Executes the specified verb. @@ -40498,9 +39884,9 @@ Returns: None """ - pass + ... - def Draw(self,) -> 'None': + def Draw(self) -> None: """ Draws the OLE item into the specified bounding rectangle using the specified device @@ -40515,9 +39901,9 @@ Returns: None """ - pass + ... - def GetActiveView(self,) -> 'Any': + def GetActiveView(self) -> Any: """ Obtains the active view for the item @@ -40530,9 +39916,9 @@ Returns: Any """ - pass + ... - def GetDocument(self,) -> 'Any': + def GetDocument(self) -> Any: """ Obtains the current document for the item @@ -40545,9 +39931,9 @@ Returns: Any """ - pass + ... - def GetInPlaceWindow(self,) -> 'Any': + def GetInPlaceWindow(self) -> Any: """ Obtains the window in which the item has been opened for @@ -40562,9 +39948,9 @@ Returns: Any """ - pass + ... - def GetItemState(self,) -> 'None': + def GetItemState(self) -> None: """ Obtains the OLE item's current state @@ -40577,9 +39963,9 @@ Returns: None """ - pass + ... - def GetObject(self,) -> 'Any': + def GetObject(self) -> Any: """ Returns the COM object to the item. This is the m_lpObject @@ -40594,9 +39980,9 @@ Returns: Any """ - pass + ... - def GetStorage(self,) -> 'None': + def GetStorage(self) -> None: """ Returns the COM object used for storage @@ -40609,9 +39995,9 @@ Returns: None """ - pass + ... - def OnActivate(self,) -> 'None': + def OnActivate(self) -> None: """ Calls the underlying MFC method. @@ -40624,9 +40010,9 @@ Returns: None """ - pass + ... - def OnChange(self,) -> 'None': + def OnChange(self) -> None: """ Calls the underlying MFC method. @@ -40639,9 +40025,9 @@ Returns: None """ - pass + ... - def OnChangeItemPosition(self,) -> 'Any': + def OnChangeItemPosition(self) -> Any: """ Calls the underlying MFC method. @@ -40658,9 +40044,9 @@ Return ValueThe result is a BOOL indicating if the function succeeded. No excep """ - pass + ... - def OnDeactivateUI(self,) -> 'Any': + def OnDeactivateUI(self) -> Any: """ Calls the underlying MFC method. @@ -40673,9 +40059,9 @@ Returns: Any """ - pass + ... - def Run(self,) -> 'None': + def Run(self) -> None: """ Runs the application associated with this item. @@ -40688,9 +40074,9 @@ Returns: None """ - pass + ... - def SetItemRects(self,) -> 'None': + def SetItemRects(self) -> None: """ Sets the bounding rectangle or the visible rectangle of the OLE item. @@ -40703,23 +40089,21 @@ Returns: None """ - pass + ... -class PyCOleDialog(object): - """""" +class PyCOleDialog: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyCOleDocument(object): - """""" +class PyCOleDocument: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def EnableCompoundFile(self, bEnable: 'Any' = 1) -> 'None': + def EnableCompoundFile(self, bEnable: Any = 1) -> None: """ Call this function if you want to store the document using the @@ -40734,9 +40118,9 @@ Returns: None """ - pass + ... - def GetStartPosition(self,) -> 'Any': + def GetStartPosition(self) -> Any: """ Obtains the position of the first item in the document. @@ -40749,9 +40133,9 @@ Returns: Any """ - pass + ... - def GetNextItem(self, pos: 'Any') -> 'Tuple[Any, Any]': + def GetNextItem(self, pos: Any) -> Tuple[Any, Any]: """ Call this function repeatedly to access each of @@ -40766,9 +40150,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def GetInPlaceActiveItem(self, wnd: 'Any') -> 'Any': + def GetInPlaceActiveItem(self, wnd: Any) -> Any: """ Obtains the OLE item that is currently activated @@ -40783,16 +40167,15 @@ Returns: Any """ - pass + ... -class PyCOleInsertDialog(object): - """""" +class PyCOleInsertDialog: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetClassID(self,) -> 'Any': + def GetClassID(self) -> Any: """ Returns the CLSID associated with the selected item @@ -40805,9 +40188,9 @@ Returns: Any """ - pass + ... - def GetSelectionType(self,) -> 'Any': + def GetSelectionType(self) -> Any: """ Returns the type of selection made @@ -40820,9 +40203,9 @@ Returns: Any """ - pass + ... - def GetPathName(self,) -> 'Any': + def GetPathName(self) -> Any: """ Returns the full path to the file selected in the dialog box @@ -40835,23 +40218,22 @@ Returns: Any """ - pass + ... -class PyCPrintDialog(object): +class PyCPrintDialog: """An object which encapsulates an MFC CPrintDialog object.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyCPrintInfo(object): - """""" +class PyCPrintInfo: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def DocObject(self,) -> 'None': + def DocObject(self) -> None: """ Return true if the document being printed is a DocObject. @@ -40864,9 +40246,9 @@ Returns: None """ - pass + ... - def GetDwFlags(self,) -> 'None': + def GetDwFlags(self) -> None: """ A flags specifying DocObject printing operations. Valid only if data member @@ -40881,9 +40263,9 @@ Returns: None """ - pass + ... - def SetDwFlags(self,) -> 'None': + def SetDwFlags(self) -> None: """ Set a flag specifying DocObject printing operations. Valid only if data member @@ -40898,9 +40280,9 @@ Returns: None """ - pass + ... - def GetDocOffsetPage(self,) -> 'None': + def GetDocOffsetPage(self) -> None: """ Get the number of pages preceding the first page of a particular DocObject @@ -40915,9 +40297,9 @@ Returns: None """ - pass + ... - def SetDocOffsetPage(self,) -> 'None': + def SetDocOffsetPage(self) -> None: """ Set the number of pages preceding the first page of a particular DocObject @@ -40932,9 +40314,9 @@ Returns: None """ - pass + ... - def SetPrintDialog(self,) -> 'None': + def SetPrintDialog(self) -> None: """ Set a pointer to the CPrintDialog object used to display the Print dialog box @@ -40949,9 +40331,9 @@ Returns: None """ - pass + ... - def GetDirect(self,) -> 'None': + def GetDirect(self) -> None: """ TRUE if the Print dialog box will be bypassed for direct printing; FALSE otherwise. @@ -40964,9 +40346,9 @@ Returns: None """ - pass + ... - def SetDirect(self,) -> 'None': + def SetDirect(self) -> None: """ Sets to TRUE if the Print dialog box will be bypassed for direct printing; FALSE @@ -40981,9 +40363,9 @@ Returns: None """ - pass + ... - def GetPreview(self,) -> 'None': + def GetPreview(self) -> None: """ A flag indicating whether the document is being previewed. @@ -40996,9 +40378,9 @@ Returns: None """ - pass + ... - def SetPreview(self,) -> 'None': + def SetPreview(self) -> None: """ Set whether the document is being previewed. @@ -41011,9 +40393,9 @@ Returns: None """ - pass + ... - def GetContinuePrinting(self,) -> 'None': + def GetContinuePrinting(self) -> None: """ A flag indicating whether the framework should continue the print loop. @@ -41026,9 +40408,9 @@ Returns: None """ - pass + ... - def SetContinuePrinting(self,) -> 'None': + def SetContinuePrinting(self) -> None: """ Set whether the framework should continue the print loop. @@ -41041,9 +40423,9 @@ Returns: None """ - pass + ... - def GetCurPage(self,) -> 'None': + def GetCurPage(self) -> None: """ Get the number of the current page. @@ -41056,9 +40438,9 @@ Returns: None """ - pass + ... - def SetCurPage(self,) -> 'None': + def SetCurPage(self) -> None: """ Set the number of the current page. @@ -41071,9 +40453,9 @@ Returns: None """ - pass + ... - def GetNumPreviewPages(self,) -> 'None': + def GetNumPreviewPages(self) -> None: """ Get the number of pages displayed in preview mode. @@ -41086,9 +40468,9 @@ Returns: None """ - pass + ... - def SetNumPreviewPages(self,) -> 'None': + def SetNumPreviewPages(self) -> None: """ Set the number of pages displayed in preview mode. @@ -41101,9 +40483,9 @@ Returns: None """ - pass + ... - def GetUserData(self,) -> 'None': + def GetUserData(self) -> None: """ Get a user-created structure. @@ -41116,9 +40498,9 @@ Returns: None """ - pass + ... - def SetUserData(self,) -> 'None': + def SetUserData(self) -> None: """ Set a user-created structure. @@ -41131,9 +40513,9 @@ Returns: None """ - pass + ... - def GetDraw(self,) -> 'None': + def GetDraw(self) -> None: """ Get the usable drawing area of the page in logical coordinates. @@ -41146,9 +40528,9 @@ Returns: None """ - pass + ... - def SetDraw(self,) -> 'None': + def SetDraw(self) -> None: """ Set the usable drawing area of the page in logical coordinates. @@ -41161,9 +40543,9 @@ Returns: None """ - pass + ... - def GetPageDesc(self,) -> 'None': + def GetPageDesc(self) -> None: """ Get the format string used to display the page numbers during print preview @@ -41176,9 +40558,9 @@ Returns: None """ - pass + ... - def SetPageDesc(self,) -> 'None': + def SetPageDesc(self) -> None: """ Set the format string used to display the page numbers during print preview @@ -41191,9 +40573,9 @@ Returns: None """ - pass + ... - def GetMinPage(self,) -> 'None': + def GetMinPage(self) -> None: """ Get the number of the first page of the document. @@ -41206,9 +40588,9 @@ Returns: None """ - pass + ... - def SetMinPage(self,) -> 'None': + def SetMinPage(self) -> None: """ Set the number of the first page of the document. @@ -41221,9 +40603,9 @@ Returns: None """ - pass + ... - def GetMaxPage(self,) -> 'None': + def GetMaxPage(self) -> None: """ Get the number of the last page of the document. @@ -41236,9 +40618,9 @@ Returns: None """ - pass + ... - def SetMaxPage(self,) -> 'None': + def SetMaxPage(self) -> None: """ Set the number of the last page of the document. @@ -41251,9 +40633,9 @@ Returns: None """ - pass + ... - def GetOffsetPage(self,) -> 'None': + def GetOffsetPage(self) -> None: """ Get the number of pages preceding the first page of a DocObject item being @@ -41270,9 +40652,9 @@ Returns: None """ - pass + ... - def GetFromPage(self,) -> 'None': + def GetFromPage(self) -> None: """ The number of the first page to be printed. @@ -41285,9 +40667,9 @@ Returns: None """ - pass + ... - def GetToPage(self,) -> 'None': + def GetToPage(self) -> None: """ The number of the last page to be printed. @@ -41300,9 +40682,9 @@ Returns: None """ - pass + ... - def SetHDC(self, hdc: 'Any') -> 'None': + def SetHDC(self, hdc: Any) -> None: """ Sets the printer DC compatible with the users choices, call after the print dialog @@ -41317,9 +40699,9 @@ Returns: None """ - pass + ... - def CreatePrinterDC(self,) -> 'None': + def CreatePrinterDC(self) -> None: """ Handle to the newly created printer device context, call only after DoModal @@ -41334,9 +40716,9 @@ Returns: None """ - pass + ... - def DoModal(self,) -> 'None': + def DoModal(self) -> None: """ Call DoModal on the dialog. @@ -41349,9 +40731,9 @@ Returns: None """ - pass + ... - def GetCopies(self,) -> 'None': + def GetCopies(self) -> None: """ The number of copies requested, call only after DoModal finishes. @@ -41364,9 +40746,9 @@ Returns: None """ - pass + ... - def GetDefaults(self,) -> 'None': + def GetDefaults(self) -> None: """ Nonzero if the function was successful; otherwise 0. Call this function to @@ -41393,9 +40775,9 @@ Returns: None """ - pass + ... - def FreeDefaults(self,) -> 'None': + def FreeDefaults(self) -> None: """ After a call to GetDefaults, and you are through with the CPrintDialog object, @@ -41410,9 +40792,9 @@ Returns: None """ - pass + ... - def GetDeviceName(self,) -> 'None': + def GetDeviceName(self) -> None: """ The name of the currently selected printer, call only after DoModal finishes. @@ -41425,9 +40807,9 @@ Returns: None """ - pass + ... - def GetDriverName(self,) -> 'None': + def GetDriverName(self) -> None: """ The name of the currently selected printer device driver, call only after @@ -41442,9 +40824,9 @@ Returns: None """ - pass + ... - def GetDlgFromPage(self,) -> 'None': + def GetDlgFromPage(self) -> None: """ Retrieves the starting page of the print range. @@ -41457,9 +40839,9 @@ Returns: None """ - pass + ... - def GetDlgToPage(self,) -> 'None': + def GetDlgToPage(self) -> None: """ Retrieves the ending page of the print range. @@ -41472,9 +40854,9 @@ Returns: None """ - pass + ... - def GetPortName(self,) -> 'None': + def GetPortName(self) -> None: """ The name of the currently selected printer port, call only after DoModal @@ -41489,9 +40871,9 @@ Returns: None """ - pass + ... - def GetPrinterDC(self,) -> 'None': + def GetPrinterDC(self) -> None: """ A handle to the printer device context if successful; otherwise NULL. If the @@ -41510,9 +40892,9 @@ Returns: None """ - pass + ... - def PrintAll(self,) -> 'None': + def PrintAll(self) -> None: """ Nonzero if all pages in the document are to be printed; otherwise 0, call only after @@ -41527,9 +40909,9 @@ Returns: None """ - pass + ... - def PrintCollate(self,) -> 'None': + def PrintCollate(self) -> None: """ Nonzero if the user selects the collate check box in the dialog box; otherwise @@ -41544,9 +40926,9 @@ Returns: None """ - pass + ... - def PrintRange(self,) -> 'None': + def PrintRange(self) -> None: """ Nonzero if only a range of pages in the document are to be printed; otherwise 0, @@ -41561,9 +40943,9 @@ Returns: None """ - pass + ... - def PrintSelection(self,) -> 'None': + def PrintSelection(self) -> None: """ Nonzero if only the selected items are to be printed; otherwise 0., call only @@ -41578,9 +40960,9 @@ Returns: None """ - pass + ... - def GetHDC(self,) -> 'None': + def GetHDC(self) -> None: """ Identifies a device context or an information context, depending on whether the Flags @@ -41597,9 +40979,9 @@ Returns: None """ - pass + ... - def GetFlags(self,) -> 'None': + def GetFlags(self) -> None: """ A set of bit flags that you can use to initialize the Print common dialog box. When @@ -41624,9 +41006,9 @@ Returns: None """ - pass + ... - def SetFlags(self,) -> 'None': + def SetFlags(self) -> None: """ A set of bit flags that you can use to initialize the Print common dialog box. When @@ -41651,9 +41033,9 @@ Returns: None """ - pass + ... - def SetFromPage(self,) -> 'None': + def SetFromPage(self) -> None: """ The number of the first page to be printed. @@ -41666,9 +41048,9 @@ Returns: None """ - pass + ... - def SetToPage(self,) -> 'None': + def SetToPage(self) -> None: """ The number of the last page to be printed. @@ -41681,9 +41063,9 @@ Returns: None """ - pass + ... - def GetPRINTDLGMinPage(self,) -> 'None': + def GetPRINTDLGMinPage(self) -> None: """ Get the minimum value for the page range specified in the From and To page @@ -41700,9 +41082,9 @@ Returns: None """ - pass + ... - def SetPRINTDLGMinPage(self,) -> 'None': + def SetPRINTDLGMinPage(self) -> None: """ Set the minimum value for the page range specified in the From and To page @@ -41719,9 +41101,9 @@ Returns: None """ - pass + ... - def GetPRINTDLGCopies(self,) -> 'None': + def GetPRINTDLGCopies(self) -> None: """ Get the initial number of copies for the Copies edit control if hDevMode is @@ -41746,9 +41128,9 @@ Returns: None """ - pass + ... - def SetPRINTDLGCopies(self,) -> 'None': + def SetPRINTDLGCopies(self) -> None: """ Set the initial number of copies for the Copies edit control if hDevMode is @@ -41773,16 +41155,15 @@ Returns: None """ - pass + ... -class PyCProgressCtrl(object): - """""" +class PyCProgressCtrl: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CreateWindow(self, style: 'Any', rect: 'Tuple[Any, Any, Any, Any]', parent: 'Any', _id: 'Any') -> 'None': + def CreateWindow(self, style: Any, rect: Tuple[Any, Any, Any, Any], parent: Any, _id: Any) -> None: """ Creates the actual control. @@ -41798,9 +41179,9 @@ Returns: None """ - pass + ... - def SetRange(self, nLower: 'Any' = 1, nUpper: 'Any' = 1) -> 'None': + def SetRange(self, nLower: Any = 1, nUpper: Any = 1) -> None: """ Set the control's bounds @@ -41814,9 +41195,9 @@ Returns: None """ - pass + ... - def SetPos(self, nPos: 'Any' = 1) -> 'Any': + def SetPos(self, nPos: Any = 1) -> Any: """ Set the control's position @@ -41829,9 +41210,9 @@ Returns: Any """ - pass + ... - def OffsetPos(self, nPos: 'Any' = 1) -> 'Any': + def OffsetPos(self, nPos: Any = 1) -> Any: """ Advances the progress bar control's current position by the increment @@ -41846,9 +41227,9 @@ Returns: Any """ - pass + ... - def SetStep(self, nStep: 'Any' = 1) -> 'Any': + def SetStep(self, nStep: Any = 1) -> Any: """ Specifies the step increment for a progress bar control. @@ -41861,9 +41242,9 @@ Returns: Any """ - pass + ... - def StepIt(self,) -> 'Any': + def StepIt(self) -> Any: """ Advances the current position for a progress bar control by the step increment. @@ -41878,16 +41259,15 @@ Returns: Any """ - pass + ... -class PyCPropertyPage(object): - """""" +class PyCPropertyPage: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CancelToClose(self,) -> 'None': + def CancelToClose(self) -> None: """ Changes the Cancel button to Close. @@ -41900,9 +41280,9 @@ Returns: None """ - pass + ... - def OnCancel(self,) -> 'None': + def OnCancel(self) -> None: """ Calls the default MFC OnCancel handler. @@ -41915,9 +41295,9 @@ Returns: None """ - pass + ... - def OnOK(self,) -> 'None': + def OnOK(self) -> None: """ Calls the default MFC OnOK handler. @@ -41930,9 +41310,9 @@ Returns: None """ - pass + ... - def OnApply(self,) -> 'None': + def OnApply(self) -> None: """ Calls the default MFC OnApply handler. @@ -41945,9 +41325,9 @@ Returns: None """ - pass + ... - def OnReset(self,) -> 'None': + def OnReset(self) -> None: """ Calls the default MFC OnReset handler. @@ -41960,9 +41340,9 @@ Returns: None """ - pass + ... - def OnQueryCancel(self,) -> 'None': + def OnQueryCancel(self) -> None: """ Calls the default MFC OnQueryCancel handler. @@ -41975,9 +41355,9 @@ Returns: None """ - pass + ... - def OnWizardBack(self,) -> 'None': + def OnWizardBack(self) -> None: """ Calls the default MFC OnWizardBack handler. @@ -41990,9 +41370,9 @@ Returns: None """ - pass + ... - def OnWizardNext(self,) -> 'None': + def OnWizardNext(self) -> None: """ Calls the default MFC OnWizardNext handler. @@ -42005,9 +41385,9 @@ Returns: None """ - pass + ... - def OnWizardFinish(self,) -> 'None': + def OnWizardFinish(self) -> None: """ Calls the default MFC OnWizardFinish handler. @@ -42020,9 +41400,9 @@ Returns: None """ - pass + ... - def OnSetActive(self,) -> 'Any': + def OnSetActive(self) -> Any: """ Calls the default MFC OnSetActive handler. @@ -42039,9 +41419,9 @@ Typically this result should be passed to the original OnSetActive handler. """ - pass + ... - def OnKillActive(self,) -> 'Any': + def OnKillActive(self) -> Any: """ Calls the default MFC OnKillActive handler. @@ -42058,9 +41438,9 @@ Typically this result should be passed to the original OnSetActive handler. """ - pass + ... - def SetModified(self, bChanged: 'Any' = 1) -> 'None': + def SetModified(self, bChanged: Any = 1) -> None: """ Sets the modified flag. @@ -42073,9 +41453,9 @@ Returns: None """ - pass + ... - def SetPSPBit(self, bitMask: 'Any', bitValue: 'Any') -> 'None': + def SetPSPBit(self, bitMask: Any, bitValue: Any) -> None: """ Sets or clears a bit in m_psp.dwFlags @@ -42089,16 +41469,15 @@ Returns: None """ - pass + ... -class PyCPropertySheet(object): - """""" +class PyCPropertySheet: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def AddPage(self, page: 'Any') -> 'None': + def AddPage(self, page: Any) -> None: """ Adds the supplied page with the rightmost tab in the property sheet. @@ -42111,9 +41490,9 @@ Returns: None """ - pass + ... - def CreateWindow(self, style: 'Any', exStyle: 'Any', parent: 'Any' = None) -> 'None': + def CreateWindow(self, style: Any, exStyle: Any, parent: Any = None) -> None: """ Displays the property sheet as a modeless dialog. @@ -42128,9 +41507,9 @@ Returns: None """ - pass + ... - def DoModal(self,) -> 'Any': + def DoModal(self) -> Any: """ Displays the property sheet as a modal dialog. @@ -42143,9 +41522,9 @@ Returns: Any """ - pass + ... - def EnableStackedTabs(self, stacked: 'Any') -> 'Any': + def EnableStackedTabs(self, stacked: Any) -> Any: """ Enables or disables stacked tabs. @@ -42158,9 +41537,9 @@ Returns: Any """ - pass + ... - def EndDialog(self, result: 'Any') -> 'None': + def EndDialog(self, result: Any) -> None: """ Closes the dialog, with the specified result. @@ -42173,9 +41552,9 @@ Returns: None """ - pass + ... - def GetActiveIndex(self,) -> 'Any': + def GetActiveIndex(self) -> Any: """ Retrieves the index of the active page of the property sheet. @@ -42188,9 +41567,9 @@ Returns: Any """ - pass + ... - def GetActivePage(self,) -> 'Any': + def GetActivePage(self) -> Any: """ Returns the currently active property page. @@ -42203,9 +41582,9 @@ Returns: Any """ - pass + ... - def GetPage(self, pageNo: 'Any') -> 'Any': + def GetPage(self, pageNo: Any) -> Any: """ Returns the specified property page. @@ -42218,9 +41597,9 @@ Returns: Any """ - pass + ... - def GetPageIndex(self, page: 'Any') -> 'Any': + def GetPageIndex(self, page: Any) -> Any: """ Retrieves the index of the specified page of the property sheet. @@ -42233,9 +41612,9 @@ Returns: Any """ - pass + ... - def GetPageCount(self,) -> 'Any': + def GetPageCount(self) -> Any: """ Returns the number of pages. @@ -42248,9 +41627,9 @@ Returns: Any """ - pass + ... - def GetTabCtrl(self,) -> 'Any': + def GetTabCtrl(self) -> Any: """ Returns the tab control used by the sheet. @@ -42263,9 +41642,9 @@ Returns: Any """ - pass + ... - def OnInitDialog(self,) -> 'Any': + def OnInitDialog(self) -> Any: """ Calls the default MFC OnInitDialog handler. @@ -42278,9 +41657,9 @@ Returns: Any """ - pass + ... - def PressButton(self, button: 'Any') -> 'None': + def PressButton(self, button: Any) -> None: """ Simulates the choice of the specified button in a property sheet. @@ -42293,9 +41672,9 @@ Returns: None """ - pass + ... - def RemovePage(self, offset: 'Any', page: 'Any') -> 'None': + def RemovePage(self, offset: Any, page: Any) -> None: """ Removes the specified page from the sheet. @@ -42309,9 +41688,9 @@ Returns: None """ - pass + ... - def SetActivePage(self, page: 'Any') -> 'None': + def SetActivePage(self, page: Any) -> None: """ Programmatically sets the active page object. @@ -42324,9 +41703,9 @@ Returns: None """ - pass + ... - def SetTitle(self, title: 'str') -> 'None': + def SetTitle(self, title: str) -> None: """ Sets the caption for the property sheet. @@ -42339,9 +41718,9 @@ Returns: None """ - pass + ... - def SetFinishText(self, text: 'str') -> 'None': + def SetFinishText(self, text: str) -> None: """ Sets the text for the Finish button @@ -42354,9 +41733,9 @@ Returns: None """ - pass + ... - def SetWizardMode(self,) -> 'None': + def SetWizardMode(self) -> None: """ Enables the wizard mode @@ -42369,9 +41748,9 @@ Returns: None """ - pass + ... - def SetWizardButtons(self, flags: 'Any') -> 'None': + def SetWizardButtons(self, flags: Any) -> None: """ Enables the wizard buttons @@ -42384,9 +41763,9 @@ Returns: None """ - pass + ... - def SetPSHBit(self, bitMask: 'Any', bitValue: 'Any') -> 'None': + def SetPSHBit(self, bitMask: Any, bitValue: Any) -> None: """ Sets or clears a bit in m_psh.dwFlags @@ -42400,30 +41779,29 @@ Returns: None """ - pass + ... -class PyCRect(object): +class PyCRect: """A Python interface the the MFC CRect class.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyCRgn(object): +class PyCRgn: """An object encapsulating an MFC PyCRgn class.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class PyCRichEditCtrl(object): - """""" +class PyCRichEditCtrl: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Clear(self,) -> 'Any': + def Clear(self) -> Any: """ Clears all text in an edit control. @@ -42436,9 +41814,9 @@ Returns: Any """ - pass + ... - def Copy(self,) -> 'None': + def Copy(self) -> None: """ Copys the current selection to the clipboard. @@ -42451,9 +41829,9 @@ Returns: None """ - pass + ... - def CreateWindow(self, style: 'Any', rect: 'Tuple[Any, Any, Any, Any]', parent: 'Any', _id: 'Any') -> 'None': + def CreateWindow(self, style: Any, rect: Tuple[Any, Any, Any, Any], parent: Any, _id: Any) -> None: """ Creates a rich edit control window. @@ -42469,9 +41847,9 @@ Returns: None """ - pass + ... - def Cut(self,) -> 'None': + def Cut(self) -> None: """ Cuts the current selection to the clipboard. @@ -42484,9 +41862,9 @@ Returns: None """ - pass + ... - def FindText(self, charPos: 'Any') -> 'Tuple[Any, Any, Any]': + def FindText(self, charPos: Any) -> Tuple[Any, Any, Any]: """ Finds text in the control @@ -42499,9 +41877,9 @@ Returns: Tuple[Any, Any, Any] """ - pass + ... - def GetCharPos(self, charPos: 'Any') -> 'Any': + def GetCharPos(self, charPos: Any) -> Any: """ Returns the location of the top-left corner of the character specified @@ -42518,9 +41896,9 @@ Returns: """ - pass + ... - def GetDefaultCharFormat(self,) -> 'Any': + def GetDefaultCharFormat(self) -> Any: """ None @@ -42536,9 +41914,9 @@ Return ValueThe return value is a win32ui::CHARFORMAT tuple """ - pass + ... - def GetEventMask(self,) -> 'Any': + def GetEventMask(self) -> Any: """ Returns the current event mask. @@ -42551,9 +41929,9 @@ Returns: Any """ - pass + ... - def GetSelectionCharFormat(self,) -> 'Any': + def GetSelectionCharFormat(self) -> Any: """ Returns the character formatting of the selection. @@ -42566,9 +41944,9 @@ Returns: Any """ - pass + ... - def GetFirstVisibleLine(self,) -> 'Any': + def GetFirstVisibleLine(self) -> Any: """ Returns zero-based index of the topmost visible line. @@ -42583,9 +41961,9 @@ Return ValueThe zero-based index of the topmost visible line. For single-line ed """ - pass + ... - def GetParaFormat(self,) -> 'Any': + def GetParaFormat(self) -> Any: """ Returns the current paragraph formatting attributes. @@ -42601,9 +41979,9 @@ Return ValueThe return value is a win32ui::PARAFORMAT tuple """ - pass + ... - def GetSel(self,) -> 'Tuple[Any, Any]': + def GetSel(self) -> Tuple[Any, Any]: """ Returns the start and end of the current selection. @@ -42620,9 +41998,9 @@ end of the current selection) """ - pass + ... - def GetSelText(self,) -> 'str': + def GetSelText(self) -> str: """ Returns the currently selected text @@ -42635,9 +42013,9 @@ Returns: str """ - pass + ... - def GetTextLength(self,) -> 'Any': + def GetTextLength(self) -> Any: """ Returns the length of the text in the control. @@ -42650,9 +42028,9 @@ Returns: Any """ - pass + ... - def GetLine(self, lineNo: 'Any') -> 'Any': + def GetLine(self, lineNo: Any) -> Any: """ Returns the text in a specified line. @@ -42665,9 +42043,9 @@ Returns: Any """ - pass + ... - def GetModify(self,) -> 'Any': + def GetModify(self) -> Any: """ Nonzero if the text in this control has been modified; otherwise 0. @@ -42680,9 +42058,9 @@ Returns: Any """ - pass + ... - def GetLineCount(self,) -> 'Any': + def GetLineCount(self) -> Any: """ Gets the number of lines in an edit control. @@ -42697,9 +42075,9 @@ Return ValueThe number of lines in the buffer. If the control is empty, the ret """ - pass + ... - def LimitText(self, nChars: 'Any' = 0) -> 'None': + def LimitText(self, nChars: Any = 0) -> None: """ Sets max length of text that user can enter @@ -42712,9 +42090,9 @@ Returns: None """ - pass + ... - def LineFromChar(self, charNo: 'Any' = -1) -> 'Any': + def LineFromChar(self, charNo: Any = -1) -> Any: """ Returns the line number of the specified character. @@ -42733,9 +42111,9 @@ If there is no selection, the current line number is returned. """ - pass + ... - def LineIndex(self, lineNo: 'Any' = -1) -> 'Any': + def LineIndex(self, lineNo: Any = -1) -> Any: """ Retrieves the character index of a line within a multiple-line edit control. @@ -42754,9 +42132,9 @@ the edit control. """ - pass + ... - def LineScroll(self, nLines: 'Any', nChars: 'Any' = 0) -> 'Any': + def LineScroll(self, nLines: Any, nChars: Any = 0) -> Any: """ Scroll the control vertically and horizontally @@ -42770,9 +42148,9 @@ Returns: Any """ - pass + ... - def Paste(self,) -> 'None': + def Paste(self) -> None: """ Pastes the contents of the clipboard into the control. @@ -42785,9 +42163,9 @@ Returns: None """ - pass + ... - def ReplaceSel(self, text: 'str') -> 'None': + def ReplaceSel(self, text: str) -> None: """ Replaces the selection with the specified text. @@ -42800,9 +42178,9 @@ Returns: None """ - pass + ... - def SetBackgroundColor(self, bSysColor: 'Any', cr: 'Any' = 0) -> 'Any': + def SetBackgroundColor(self, bSysColor: Any, cr: Any = 0) -> Any: """ Sets the background color for the control. @@ -42818,9 +42196,9 @@ Return ValueThe return value is the previous background color. """ - pass + ... - def SetDefaultCharFormat(self, charFormat: 'Any') -> 'None': + def SetDefaultCharFormat(self, charFormat: Any) -> None: """ None @@ -42833,9 +42211,9 @@ Returns: None """ - pass + ... - def SetEventMask(self, eventMask: 'Any') -> 'Any': + def SetEventMask(self, eventMask: Any) -> Any: """ Sets the event motification mask. @@ -42850,9 +42228,9 @@ Return ValueThe return value is the previous event mask. """ - pass + ... - def SetSelectionCharFormat(self, charFormat: 'Any') -> 'None': + def SetSelectionCharFormat(self, charFormat: Any) -> None: """ Sets the current selections character formatting attributes. @@ -42865,9 +42243,9 @@ Returns: None """ - pass + ... - def SetModify(self, modified: 'Any' = 1) -> 'None': + def SetModify(self, modified: Any = 1) -> None: """ Sets the modified flag for this control @@ -42880,9 +42258,9 @@ Returns: None """ - pass + ... - def SetOptions(self, op: 'Any', flags: 'Any') -> 'None': + def SetOptions(self, op: Any, flags: Any) -> None: """ Sets options for the control. @@ -42896,9 +42274,9 @@ Returns: None """ - pass + ... - def SetParaFormat(self, paraFormat: 'Any') -> 'Any': + def SetParaFormat(self, paraFormat: Any) -> Any: """ Sets the paragraph formatting @@ -42917,9 +42295,9 @@ but the BOOL return code is passed back. """ - pass + ... - def SetReadOnly(self, bReadOnly: 'Any' = 1) -> 'None': + def SetReadOnly(self, bReadOnly: Any = 1) -> None: """ Sets or clears the read-only status of the listbox. @@ -42932,9 +42310,9 @@ Returns: None """ - pass + ... - def SetSel(self, start: 'Any', end: 'Any', arg: 'Any') -> 'None': + def SetSel(self, start: Any, end: Any, arg: Any) -> None: """ Sets the selection in the edit control. @@ -42949,9 +42327,9 @@ Returns: None """ - pass + ... - def SetSelAndCharFormat(self, charFormat: 'Any') -> 'None': + def SetSelAndCharFormat(self, charFormat: Any) -> None: """ Sets the selection and char format. @@ -42964,9 +42342,9 @@ Returns: None """ - pass + ... - def SetTargetDevice(self, dc: 'Any', lineWidth: 'Any') -> 'None': + def SetTargetDevice(self, dc: Any, lineWidth: Any) -> None: """ Sets the target device for the control @@ -42980,9 +42358,9 @@ Returns: None """ - pass + ... - def StreamIn(self, _format: 'Any', method: 'Any') -> 'Tuple[Any, Any]': + def StreamIn(self, _format: Any, method: Any) -> Tuple[Any, Any]: """ Invokes a callback to stream data into the control. @@ -42998,9 +42376,9 @@ Return ValueThe return value is a tuple of (no bytes written, error code) """ - pass + ... - def StreamOut(self, _format: 'Any', method: 'Any') -> 'Tuple[Any, Any]': + def StreamOut(self, _format: Any, method: Any) -> Tuple[Any, Any]: """ Invokes a callback to stream data into the control. @@ -43016,16 +42394,15 @@ Return ValueThe return value is a tuple of (no bytes written, error code) """ - pass + ... -class PyCRichEditDoc(object): - """""" +class PyCRichEditDoc: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def OnCloseDocument(self,) -> 'None': + def OnCloseDocument(self) -> None: """ Call the MFC OnCloseDocument handler. @@ -43042,16 +42419,15 @@ Returns: None """ - pass + ... -class PyCRichEditDocTemplate(object): - """""" +class PyCRichEditDocTemplate: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def DoCreateRichEditDoc(self, fileName: 'str' = None) -> 'Any': + def DoCreateRichEditDoc(self, fileName: str = None) -> Any: """ Creates an underlying document object. @@ -43064,16 +42440,15 @@ Returns: Any """ - pass + ... -class PyCRichEditView(object): - """""" +class PyCRichEditView: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetRichEditCtrl(self,) -> 'Any': + def GetRichEditCtrl(self) -> Any: """ Returns the underlying rich edit control object. @@ -43086,9 +42461,9 @@ Returns: Any """ - pass + ... - def SetWordWrap(self, wordWrap: 'Any') -> 'Any': + def SetWordWrap(self, wordWrap: Any) -> Any: """ Sets the wordwrap state for the control. @@ -43101,9 +42476,9 @@ Returns: Any """ - pass + ... - def WrapChanged(self,) -> 'Any': + def WrapChanged(self) -> Any: """ Calls the underlying WrapChanged method. @@ -43116,9 +42491,9 @@ Returns: Any """ - pass + ... - def SaveTextFile(self, FileName: 'Any') -> 'Any': + def SaveTextFile(self, FileName: Any) -> Any: """ Saves the contents of the control as a test file @@ -43131,16 +42506,15 @@ Returns: Any """ - pass + ... -class PyCScrollView(object): - """""" +class PyCScrollView: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetDeviceScrollPosition(self,) -> 'Tuple[Any, Any]': + def GetDeviceScrollPosition(self) -> Tuple[Any, Any]: """ Returns the positon of the scroll bars in device units. @@ -43153,9 +42527,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def GetDC(self,) -> 'Any': + def GetDC(self) -> Any: """ Gets the view's current DC. @@ -43168,9 +42542,9 @@ Returns: Any """ - pass + ... - def GetScrollPosition(self,) -> 'Tuple[Any, Any]': + def GetScrollPosition(self) -> Tuple[Any, Any]: """ Returns the current position of the scroll bars (in logical units). @@ -43183,9 +42557,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def GetTotalSize(self,) -> 'Tuple[Any, Any]': + def GetTotalSize(self) -> Tuple[Any, Any]: """ Returns the total size of the view in logical units. @@ -43198,9 +42572,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def OnCommand(self, wparam: 'Any', lparam: 'Any') -> 'None': + def OnCommand(self, wparam: Any, lparam: Any) -> None: """ Calls the standard Python framework OnCommand handler @@ -43214,9 +42588,9 @@ Returns: None """ - pass + ... - def ResizeParentToFit(self, bShrinkOnly: 'Any' = 1) -> 'Any': + def ResizeParentToFit(self, bShrinkOnly: Any = 1) -> Any: """ Lets the size of a view dictate the size of its frame window. @@ -43229,9 +42603,9 @@ Returns: Any """ - pass + ... - def SetScaleToFitSize(self, size: 'Tuple[Any, Any]') -> 'None': + def SetScaleToFitSize(self, size: Tuple[Any, Any]) -> None: """ Scales the viewport size to the current window size automatically. @@ -43244,9 +42618,9 @@ Returns: None """ - pass + ... - def ScrollToPosition(self, position: 'Tuple[Any, Any]') -> 'None': + def ScrollToPosition(self, position: Tuple[Any, Any]) -> None: """ Scrolls to a given point in the view. @@ -43259,14 +42633,14 @@ Returns: None """ - pass + ... def SetScrollSizes( self, - mapMode: 'Any', - sizeTotal: 'Tuple[Any, Any]', - arg: 'Tuple[Any, Any]', - arg1: 'Tuple[Any, Any]') -> 'None': + mapMode: Any, + sizeTotal: Tuple[Any, Any], + arg: Tuple[Any, Any], + arg1: Tuple[Any, Any]) -> None: """ Sets the sizes of the scroll bars @@ -43282,9 +42656,9 @@ Returns: None """ - pass + ... - def UpdateBars(self,) -> 'None': + def UpdateBars(self) -> None: """ Update the scroll bars state @@ -43297,16 +42671,15 @@ Returns: None """ - pass + ... -class PyCSliderCtrl(object): - """""" +class PyCSliderCtrl: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CreateWindow(self, style: 'Any', rect: 'Tuple[Any, Any, Any, Any]', parent: 'Any', _id: 'Any') -> 'None': + def CreateWindow(self, style: Any, rect: Tuple[Any, Any, Any, Any], parent: Any, _id: Any) -> None: """ Creates the actual control. @@ -43322,9 +42695,9 @@ Returns: None """ - pass + ... - def GetLineSize(self,) -> 'Any': + def GetLineSize(self) -> Any: """ Get the control's position @@ -43337,9 +42710,9 @@ Returns: Any """ - pass + ... - def SetLineSize(self, nLineSize: 'Any' = 1) -> 'Any': + def SetLineSize(self, nLineSize: Any = 1) -> Any: """ Set the control's line size. Returns the previous line size. @@ -43352,9 +42725,9 @@ Returns: Any """ - pass + ... - def GetPageSize(self,) -> 'Any': + def GetPageSize(self) -> Any: """ Get the control's position @@ -43367,9 +42740,9 @@ Returns: Any """ - pass + ... - def SetPageSize(self, nPageSize: 'Any' = 1) -> 'Any': + def SetPageSize(self, nPageSize: Any = 1) -> Any: """ Set the control's page size Returns the previous page size. @@ -43382,9 +42755,9 @@ Returns: Any """ - pass + ... - def GetRangeMax(self,) -> 'Any': + def GetRangeMax(self) -> Any: """ Get the control's Maximum @@ -43397,9 +42770,9 @@ Returns: Any """ - pass + ... - def GetRangeMin(self,) -> 'Any': + def GetRangeMin(self) -> Any: """ Get the control's Minimum @@ -43412,9 +42785,9 @@ Returns: Any """ - pass + ... - def GetRange(self,) -> 'Any': + def GetRange(self) -> Any: """ Get the control's min and max @@ -43427,9 +42800,9 @@ Returns: Any """ - pass + ... - def SetRange(self, nRangeMin: 'Any' = 1, nRangeMax: 'Any' = 1, bRedraw: 'Any' = 1) -> 'Any': + def SetRange(self, nRangeMin: Any = 1, nRangeMax: Any = 1, bRedraw: Any = 1) -> Any: """ Set the control's min and max @@ -43444,9 +42817,9 @@ Returns: Any """ - pass + ... - def GetSelection(self,) -> 'Any': + def GetSelection(self) -> Any: """ Get the control's selection start and end positions @@ -43459,9 +42832,9 @@ Returns: Any """ - pass + ... - def SetSelection(self, nRangeMin: 'Any' = 1, nRangeMax: 'Any' = 1) -> 'Any': + def SetSelection(self, nRangeMin: Any = 1, nRangeMax: Any = 1) -> Any: """ Set the control's selection start and end positions @@ -43475,9 +42848,9 @@ Returns: Any """ - pass + ... - def GetChannelRect(self,) -> 'Any': + def GetChannelRect(self) -> Any: """ Get the control's channel rectangle @@ -43490,9 +42863,9 @@ Returns: Any """ - pass + ... - def GetThumbRect(self,) -> 'Any': + def GetThumbRect(self) -> Any: """ Get the control's thumb rectangle @@ -43505,9 +42878,9 @@ Returns: Any """ - pass + ... - def GetPos(self,) -> 'Any': + def GetPos(self) -> Any: """ Get the control's position @@ -43520,9 +42893,9 @@ Returns: Any """ - pass + ... - def SetPos(self, nPos: 'Any' = 1) -> 'Any': + def SetPos(self, nPos: Any = 1) -> Any: """ Set the control's position @@ -43535,9 +42908,9 @@ Returns: Any """ - pass + ... - def GetNumTics(self,) -> 'Any': + def GetNumTics(self) -> Any: """ Get number of tics in the slider @@ -43550,9 +42923,9 @@ Returns: Any """ - pass + ... - def GetTicArray(self,) -> 'Any': + def GetTicArray(self) -> Any: """ Get a tuple of slider tic positions @@ -43565,9 +42938,9 @@ Returns: Any """ - pass + ... - def GetTic(self, nTic: 'Any' = 1) -> 'Any': + def GetTic(self, nTic: Any = 1) -> Any: """ Get the position of the specified tic number @@ -43580,9 +42953,9 @@ Returns: Any """ - pass + ... - def GetTicPos(self, nTic: 'Any' = 1) -> 'Any': + def GetTicPos(self, nTic: Any = 1) -> Any: """ Get the position of the specified tic number in client coordinates @@ -43595,9 +42968,9 @@ Returns: Any """ - pass + ... - def SetTic(self, nTic: 'Any' = 1) -> 'Any': + def SetTic(self, nTic: Any = 1) -> Any: """ Set a tic at the specified position @@ -43610,9 +42983,9 @@ Returns: Any """ - pass + ... - def SetTicFreq(self, nFreq: 'Any' = 1) -> 'Any': + def SetTicFreq(self, nFreq: Any = 1) -> Any: """ Set the tic frequency @@ -43625,9 +42998,9 @@ Returns: Any """ - pass + ... - def ClearSel(self, bRedraw: 'Any' = 1) -> 'Any': + def ClearSel(self, bRedraw: Any = 1) -> Any: """ Clear the selection @@ -43640,9 +43013,9 @@ Returns: Any """ - pass + ... - def VerifyPos(self,) -> 'Any': + def VerifyPos(self) -> Any: """ Verify the position is between configured min and max @@ -43655,9 +43028,9 @@ Returns: Any """ - pass + ... - def ClearTics(self, bRedraw: 'Any' = 1) -> 'Any': + def ClearTics(self, bRedraw: Any = 1) -> Any: """ Clear the control's tic marks @@ -43670,16 +43043,16 @@ Returns: Any """ - pass + ... -class PyCSpinButtonCtrl(object): +class PyCSpinButtonCtrl: """A windows spin button control. Encapsulates an MFC CSpinButtonCtrl object.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetPos(self,) -> 'Any': + def GetPos(self) -> Any: """ Obtains the current position for a spin button control. @@ -43692,9 +43065,9 @@ Returns: Any """ - pass + ... - def SetPos(self, pos: 'Any') -> 'Any': + def SetPos(self, pos: Any) -> Any: """ Sets the current position for a spin button control. @@ -43708,9 +43081,9 @@ Returns: """ - pass + ... - def SetRange(self,) -> 'Any': + def SetRange(self) -> Any: """ Sets the upper and lower limits (range) for a spin button control. @@ -43723,9 +43096,9 @@ Returns: Any """ - pass + ... - def SetRange32(self,) -> 'Any': + def SetRange32(self) -> Any: """ Sets the 32 bit upper and lower limits (range) for a spin button control. @@ -43738,16 +43111,15 @@ Returns: Any """ - pass + ... -class PyCSplitterWnd(object): - """""" +class PyCSplitterWnd: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetPane(self, row: 'Any', col: 'Any') -> 'Any': + def GetPane(self, row: Any, col: Any) -> Any: """ None @@ -43761,9 +43133,9 @@ Returns: Any """ - pass + ... - def CreateView(self, view: 'Any', row: 'Any', col: 'Any', arg: 'Tuple[Any, Any]') -> 'None': + def CreateView(self, view: Any, row: Any, col: Any, arg: Tuple[Any, Any]) -> None: """ Creates a view in a splitter window @@ -43779,9 +43151,9 @@ Returns: None """ - pass + ... - def CreateStatic(self, parent: 'Any', rows: 'Any', cols: 'Any', style: 'Any', _id: 'Any') -> 'None': + def CreateStatic(self, parent: Any, rows: Any, cols: Any, style: Any, _id: Any) -> None: """ Creates a static splitter window. @@ -43798,9 +43170,9 @@ Returns: None """ - pass + ... - def SetColumnInfo(self, column: 'Any', ideal: 'Any', _min: 'Any') -> 'None': + def SetColumnInfo(self, column: Any, ideal: Any, _min: Any) -> None: """ Sets a new minimum height and ideal height for a column @@ -43815,9 +43187,9 @@ Returns: None """ - pass + ... - def SetRowInfo(self, row: 'Any', ideal: 'Any', _min: 'Any') -> 'None': + def SetRowInfo(self, row: Any, ideal: Any, _min: Any) -> None: """ Sets a new minimum height and ideal height for a row. @@ -43832,9 +43204,9 @@ Returns: None """ - pass + ... - def IdFromRowCol(self, row: 'Any', col: 'Any') -> 'None': + def IdFromRowCol(self, row: Any, col: Any) -> None: """ Gets the child window ID for the specified child. @@ -43848,9 +43220,9 @@ Returns: None """ - pass + ... - def DoKeyboardSplit(self,) -> 'Any': + def DoKeyboardSplit(self) -> Any: """ None @@ -43863,16 +43235,15 @@ Returns: Any """ - pass + ... -class PyCStatusBar(object): - """""" +class PyCStatusBar: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetPaneInfo(self, index: 'Any') -> 'Tuple[Any, Any, Any]': + def GetPaneInfo(self, index: Any) -> Tuple[Any, Any, Any]: """ Returns the id, style, and width of the indicator pane at the @@ -43887,9 +43258,9 @@ Returns: Tuple[Any, Any, Any] """ - pass + ... - def GetStatusBarCtrl(self,) -> 'Any': + def GetStatusBarCtrl(self) -> Any: """ Gets the statusbar control object for the statusbar. @@ -43902,9 +43273,9 @@ Returns: Any """ - pass + ... - def SetIndicators(self, indicators: 'Any') -> 'None': + def SetIndicators(self, indicators: Any) -> None: """ Sets each indicator's ID. @@ -43917,9 +43288,9 @@ Returns: None """ - pass + ... - def SetPaneInfo(self, index: 'Any', _id: 'Any', style: 'Any', width: 'Any') -> 'None': + def SetPaneInfo(self, index: Any, _id: Any, style: Any, width: Any) -> None: """ Sets the specified indicator pane to a new ID, style, and width. @@ -43935,16 +43306,15 @@ Returns: None """ - pass + ... -class PyCStatusBarCtrl(object): - """""" +class PyCStatusBarCtrl: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CreateWindow(self, style: 'Any', rect: 'Tuple[Any, Any, Any, Any]', parent: 'Any', _id: 'Any') -> 'None': + def CreateWindow(self, style: Any, rect: Tuple[Any, Any, Any, Any], parent: Any, _id: Any) -> None: """ Creates the actual control. @@ -43960,9 +43330,9 @@ Returns: None """ - pass + ... - def GetBorders(self,) -> 'Tuple[Any, Any, Any]': + def GetBorders(self) -> Tuple[Any, Any, Any]: """ Retrieve the status bar control's current widths of @@ -43977,9 +43347,9 @@ Returns: Tuple[Any, Any, Any] """ - pass + ... - def GetParts(self, nParts: 'Any') -> 'Any': + def GetParts(self, nParts: Any) -> Any: """ Retrieve coordinates of the parts in a status bar control. @@ -43992,9 +43362,9 @@ Returns: Any """ - pass + ... - def GetRect(self, nPane: 'Any') -> 'Tuple[Any, Any, Any, Any]': + def GetRect(self, nPane: Any) -> Tuple[Any, Any, Any, Any]: """ Retrieves the bounding rectangle of a part in a status @@ -44009,9 +43379,9 @@ Returns: Tuple[Any, Any, Any, Any] """ - pass + ... - def GetText(self, nPane: 'Any') -> 'Any': + def GetText(self, nPane: Any) -> Any: """ Retrieve the text from the given part of a status bar control. @@ -44024,9 +43394,9 @@ Returns: Any """ - pass + ... - def GetTextAttr(self, nPane: 'Any') -> 'Any': + def GetTextAttr(self, nPane: Any) -> Any: """ Retrieve the attributes of the text in the given part of a status bar @@ -44041,9 +43411,9 @@ Returns: Any """ - pass + ... - def GetTextLength(self, nPane: 'Any') -> 'Any': + def GetTextLength(self, nPane: Any) -> Any: """ Retrieve the length the text in the given part of a status bar control. @@ -44056,9 +43426,9 @@ Returns: Any """ - pass + ... - def SetMinHeight(self, nHeight: 'Any') -> 'None': + def SetMinHeight(self, nHeight: Any) -> None: """ Set the minimum height of a status bar control's drawing area. @@ -44071,9 +43441,9 @@ Returns: None """ - pass + ... - def SetParts(self, coord: 'Any') -> 'None': + def SetParts(self, coord: Any) -> None: """ Sets the number of parts in a status bar control and the coordinate of the right @@ -44088,9 +43458,9 @@ Returns: None """ - pass + ... - def SetText(self, text: 'str', nPane: 'Any', nType: 'Any') -> 'None': + def SetText(self, text: str, nPane: Any, nType: Any) -> None: """ Set the text in the given part of a status bar control. @@ -44105,9 +43475,9 @@ Returns: None """ - pass + ... - def SetTipText(self, nPane: 'Any', text: 'str') -> 'None': + def SetTipText(self, nPane: Any, text: str) -> None: """ Sets the tooltip text for a pane in a status bar. The status bar must have @@ -44123,16 +43493,15 @@ Returns: None """ - pass + ... -class PyCTabCtrl(object): - """""" +class PyCTabCtrl: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetCurSel(self,) -> 'Any': + def GetCurSel(self) -> Any: """ Gets the current selection of a tab control. @@ -44149,9 +43518,9 @@ Return ValueThe zero-based index of the currently selected item, or -1 if no sel """ - pass + ... - def GetItemCountl(self,) -> 'Any': + def GetItemCountl(self) -> Any: """ Returns the number of tabs in the control. @@ -44164,9 +43533,9 @@ Returns: Any """ - pass + ... - def SetCurSel(self, index: 'Any') -> 'Any': + def SetCurSel(self, index: Any) -> Any: """ Sets the current selection of a tab control. @@ -44180,16 +43549,15 @@ Returns: """ - pass + ... -class PyCToolBar(object): - """""" +class PyCToolBar: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetButtonStyle(self, index: 'Any') -> 'None': + def GetButtonStyle(self, index: Any) -> None: """ Retrieves the style for a button. @@ -44202,9 +43570,9 @@ Returns: None """ - pass + ... - def GetButtonText(self, index: 'Any') -> 'str': + def GetButtonText(self, index: Any) -> str: """ Gets the text for a button. @@ -44217,9 +43585,9 @@ Returns: str """ - pass + ... - def GetItemID(self, index: 'Any') -> 'None': + def GetItemID(self, index: Any) -> None: """ Returns the command ID of a button or separator at the given index. @@ -44232,9 +43600,9 @@ Returns: None """ - pass + ... - def SetButtonInfo(self, index: 'Any', ID: 'Any', style: 'Any', imageIx: 'Any') -> 'None': + def SetButtonInfo(self, index: Any, ID: Any, style: Any, imageIx: Any) -> None: """ Sets the button's command ID, style, and image number. @@ -44250,9 +43618,9 @@ Returns: None """ - pass + ... - def GetToolBarCtrl(self,) -> 'Any': + def GetToolBarCtrl(self) -> Any: """ Gets the toolbar control object for the toolbar @@ -44265,9 +43633,9 @@ Returns: Any """ - pass + ... - def LoadBitmap(self, _id: 'PyResourceId') -> 'None': + def LoadBitmap(self, _id: PyResourceId) -> None: """ Loads the bitmap containing bitmap-button images. @@ -44280,9 +43648,9 @@ Returns: None """ - pass + ... - def LoadToolBar(self, _id: 'PyResourceId') -> 'None': + def LoadToolBar(self, _id: PyResourceId) -> None: """ Loads a toolbar from a toolbar resource. @@ -44295,9 +43663,9 @@ Returns: None """ - pass + ... - def SetBarStyle(self, style: 'Any') -> 'None': + def SetBarStyle(self, style: Any) -> None: """ Sets the toolbar part of style @@ -44310,9 +43678,9 @@ Returns: None """ - pass + ... - def SetBitmap(self, hBitmap: 'Any') -> 'None': + def SetBitmap(self, hBitmap: Any) -> None: """ Sets a bitmapped image. @@ -44325,9 +43693,9 @@ Returns: None """ - pass + ... - def SetButtons(self, buttons: 'Any', numButtons: 'Any') -> 'None': + def SetButtons(self, buttons: Any, numButtons: Any) -> None: """ Sets button styles and an index of button images within the bitmap. @@ -44341,9 +43709,9 @@ Returns: None """ - pass + ... - def SetButtonStyle(self, index: 'Any', style: 'Any') -> 'None': + def SetButtonStyle(self, index: Any, style: Any) -> None: """ Sets the style for a button. @@ -44357,9 +43725,9 @@ Returns: None """ - pass + ... - def SetHeight(self, height: 'Any') -> 'None': + def SetHeight(self, height: Any) -> None: """ Sets the height of the toolbar. @@ -44372,9 +43740,9 @@ Returns: None """ - pass + ... - def SetSizes(self, sizeButton: 'Tuple[Any, Any]', sizeButton1: 'Tuple[Any, Any]') -> 'None': + def SetSizes(self, sizeButton: Tuple[Any, Any], sizeButton1: Tuple[Any, Any]) -> None: """ Sets the size of each button. @@ -44388,16 +43756,15 @@ Returns: None """ - pass + ... -class PyCToolBarCtrl(object): - """""" +class PyCToolBarCtrl: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def AddBitmap(self, numButtons: 'Any', bitmap: 'Any') -> 'Any': + def AddBitmap(self, numButtons: Any, bitmap: Any) -> Any: """ Add one or more button images to the list of button images @@ -44411,9 +43778,9 @@ Returns: Any """ - pass + ... - def AddButtons(self,) -> 'Any': + def AddButtons(self) -> Any: """ Add one or more buttons to the toolbar @@ -44426,9 +43793,9 @@ Returns: Any """ - pass + ... - def AddStrings(self, strings: 'Any') -> 'Any': + def AddStrings(self, strings: Any) -> Any: """ Add one or more strings to the toolbar @@ -44441,9 +43808,9 @@ Returns: Any """ - pass + ... - def AutoSize(self,) -> 'None': + def AutoSize(self) -> None: """ Resize the entire toolbar control @@ -44456,9 +43823,9 @@ Returns: None """ - pass + ... - def CheckButton(self, nID: 'Any', bCheck: 'Any' = 1) -> 'Any': + def CheckButton(self, nID: Any, bCheck: Any = 1) -> Any: """ Check or clear a given button in a toolbar control @@ -44472,9 +43839,9 @@ Returns: Any """ - pass + ... - def CommandToIndex(self, nID: 'Any') -> 'Any': + def CommandToIndex(self, nID: Any) -> Any: """ Retrieve the zero-based index for the button associated with the @@ -44489,9 +43856,9 @@ Returns: Any """ - pass + ... - def CreateWindow(self, style: 'Any', rect: 'Tuple[Any, Any, Any, Any]', parent: 'Any', _id: 'Any') -> 'None': + def CreateWindow(self, style: Any, rect: Tuple[Any, Any, Any, Any], parent: Any, _id: Any) -> None: """ Creates the window for a new toolbar object @@ -44507,9 +43874,9 @@ Returns: None """ - pass + ... - def Customize(self,) -> 'None': + def Customize(self) -> None: """ Display the Customize Toolbar dialog box. @@ -44522,9 +43889,9 @@ Returns: None """ - pass + ... - def DeleteButton(self, nID: 'Any') -> 'None': + def DeleteButton(self, nID: Any) -> None: """ Delete a button from the toolbar control. @@ -44537,9 +43904,9 @@ Returns: None """ - pass + ... - def EnableButton(self, nID: 'Any', bEnable: 'Any' = 1) -> 'None': + def EnableButton(self, nID: Any, bEnable: Any = 1) -> None: """ Enable or disable a toolbar control button. @@ -44553,9 +43920,9 @@ Returns: None """ - pass + ... - def GetBitmapFlags(self,) -> 'Any': + def GetBitmapFlags(self) -> Any: """ retrieve the bitmap flags from the toolbar. @@ -44568,9 +43935,9 @@ Returns: Any """ - pass + ... - def GetButton(self, nID: 'Any') -> 'Any': + def GetButton(self, nID: Any) -> Any: """ Retrieve information about the specified button in a @@ -44585,9 +43952,9 @@ Returns: Any """ - pass + ... - def GetButtonCount(self,) -> 'Any': + def GetButtonCount(self) -> Any: """ Retrieve a count of the buttons currently in the toolbar control. @@ -44600,9 +43967,9 @@ Returns: Any """ - pass + ... - def GetItemRect(self, nID: 'Any') -> 'Tuple[Any, Any, Any, Any]': + def GetItemRect(self, nID: Any) -> Tuple[Any, Any, Any, Any]: """ Retrieve the bounding rectangle of a button in a @@ -44617,9 +43984,9 @@ Returns: Tuple[Any, Any, Any, Any] """ - pass + ... - def GetRows(self,) -> 'Tuple[Any, Any, Any, Any]': + def GetRows(self) -> Tuple[Any, Any, Any, Any]: """ Retrieve the number of rows of buttons currently displayed @@ -44632,9 +43999,9 @@ Returns: Tuple[Any, Any, Any, Any] """ - pass + ... - def HideButton(self, nID: 'Any', bEnable: 'Any' = 1) -> 'None': + def HideButton(self, nID: Any, bEnable: Any = 1) -> None: """ Hide or show the specified button in a toolbar control. @@ -44648,9 +44015,9 @@ Returns: None """ - pass + ... - def Indeterminate(self, nID: 'Any', bEnable: 'Any' = 1) -> 'None': + def Indeterminate(self, nID: Any, bEnable: Any = 1) -> None: """ Mark or unmark the specified button as indeterminate @@ -44664,9 +44031,9 @@ Returns: None """ - pass + ... - def InsertButton(self, nID: 'Any', button: 'Any') -> 'Any': + def InsertButton(self, nID: Any, button: Any) -> Any: """ Insert a button in a toolbar control. @@ -44680,9 +44047,9 @@ Returns: Any """ - pass + ... - def IsButtonChecked(self, nID: 'Any') -> 'Any': + def IsButtonChecked(self, nID: Any) -> Any: """ Determine whether the specified button in a toolbar control is checked. @@ -44695,9 +44062,9 @@ Returns: Any """ - pass + ... - def IsButtonEnabled(self, nID: 'Any') -> 'Any': + def IsButtonEnabled(self, nID: Any) -> Any: """ Determine whether the specified button in a toolbar control is enabled. @@ -44710,9 +44077,9 @@ Returns: Any """ - pass + ... - def IsButtonHidden(self, nID: 'Any') -> 'Any': + def IsButtonHidden(self, nID: Any) -> Any: """ Determine whether the specified button in a toolbar control is hidden. @@ -44725,9 +44092,9 @@ Returns: Any """ - pass + ... - def IsButtonIndeterminate(self, nID: 'Any') -> 'Any': + def IsButtonIndeterminate(self, nID: Any) -> Any: """ Determine whether the specified button in a toolbar control is @@ -44742,9 +44109,9 @@ Returns: Any """ - pass + ... - def IsButtonPressed(self, nID: 'Any') -> 'Any': + def IsButtonPressed(self, nID: Any) -> Any: """ Determine whether the specified button in a toolbar control is pressed. @@ -44757,9 +44124,9 @@ Returns: Any """ - pass + ... - def PressButton(self, nID: 'Any', bEnable: 'Any' = 1) -> 'None': + def PressButton(self, nID: Any, bEnable: Any = 1) -> None: """ Mark or unmark the specified button as pressed. @@ -44773,9 +44140,9 @@ Returns: None """ - pass + ... - def SetBitmapSize(self, width1: 'Any', height1: 'Any', width: 'Any' = 16, height: 'Any' = 15) -> 'None': + def SetBitmapSize(self, width1: Any, height1: Any, width: Any = 16, height: Any = 15) -> None: """ Set the size of the actual bitmapped images to be added to a toolbar control. @@ -44791,9 +44158,9 @@ Returns: None """ - pass + ... - def SetButtonSize(self, width1: 'Any', height1: 'Any', width: 'Any' = 16, height: 'Any' = 15) -> 'None': + def SetButtonSize(self, width1: Any, height1: Any, width: Any = 16, height: Any = 15) -> None: """ Set the size of the buttons to be added to a toolbar control. @@ -44809,9 +44176,9 @@ Returns: None """ - pass + ... - def SetCmdID(self, nIndex: 'Any', nID: 'Any') -> 'None': + def SetCmdID(self, nIndex: Any, nID: Any) -> None: """ Set the command identifier which will be sent to the owner window when the @@ -44827,9 +44194,9 @@ Returns: None """ - pass + ... - def SetRows(self, nRows: 'Any', bLarger: 'Any') -> 'Tuple[Any, Any, Any, Any]': + def SetRows(self, nRows: Any, bLarger: Any) -> Tuple[Any, Any, Any, Any]: """ Ask the toolbar control to resize itself to the requested @@ -44845,16 +44212,15 @@ Returns: Tuple[Any, Any, Any, Any] """ - pass + ... -class PyCToolTipCtrl(object): - """""" +class PyCToolTipCtrl: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CreateWindow(self, parent: 'Any', style: 'Any') -> 'None': + def CreateWindow(self, parent: Any, style: Any) -> None: """ Creates the actual control. @@ -44868,9 +44234,9 @@ Returns: None """ - pass + ... - def UpdateTipText(self, text: 'str', wnd: 'Any', _id: 'Any') -> 'None': + def UpdateTipText(self, text: str, wnd: Any, _id: Any) -> None: """ Update the tool tip text for a control's tools @@ -44885,9 +44251,9 @@ Returns: None """ - pass + ... - def AddTool(self, wnd: 'Any', text: 'str', _id: 'Any', rect: 'Tuple[Any, Any, Any, Any]' = None) -> 'None': + def AddTool(self, wnd: Any, text: str, _id: Any, rect: Tuple[Any, Any, Any, Any] = None) -> None: """ Adds a tool to tooltip control. @@ -44903,9 +44269,9 @@ Returns: None """ - pass + ... - def SetMaxTipWidth(self, width: 'Any') -> 'Any': + def SetMaxTipWidth(self, width: Any) -> Any: """ None @@ -44918,16 +44284,15 @@ Returns: Any """ - pass + ... -class PyCTreeCtrl(object): - """""" +class PyCTreeCtrl: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CreateWindow(self, style: 'Any', rect: 'Tuple[Any, Any, Any, Any]', PyCWnd: 'Any', _id: 'Any') -> 'None': + def CreateWindow(self, style: Any, rect: Tuple[Any, Any, Any, Any], PyCWnd: Any, _id: Any) -> None: """ Creates the actual window for the object. @@ -44943,9 +44308,9 @@ Returns: None """ - pass + ... - def GetCount(self,) -> 'Any': + def GetCount(self) -> Any: """ Retrieves the number of tree items associated with a tree view control. @@ -44958,9 +44323,9 @@ Returns: Any """ - pass + ... - def GetIndent(self,) -> 'Any': + def GetIndent(self) -> Any: """ Retrieves the offset (in pixels) of a tree view item from its parent. @@ -44973,9 +44338,9 @@ Returns: Any """ - pass + ... - def SetIndent(self, indent: 'Any') -> 'None': + def SetIndent(self, indent: Any) -> None: """ Sets the offset (in pixels) of a tree view item from its parent. @@ -44988,9 +44353,9 @@ Returns: None """ - pass + ... - def GetImageList(self, nImageList: 'Any') -> 'Any': + def GetImageList(self, nImageList: Any) -> Any: """ Retrieves the current image list. @@ -45003,9 +44368,9 @@ Returns: Any """ - pass + ... - def SetImageList(self, imageList: 'Any', imageType: 'Any') -> 'Any': + def SetImageList(self, imageList: Any, imageType: Any) -> Any: """ Assigns an image list to a list view control. @@ -45019,9 +44384,9 @@ Returns: Any """ - pass + ... - def GetNextItem(self, item: 'Any', code: 'Any') -> 'Any': + def GetNextItem(self, item: Any, code: Any) -> Any: """ Retrieves the next item. @@ -45035,9 +44400,9 @@ Returns: Any """ - pass + ... - def ItemHasChildren(self, item: 'Any') -> 'Any': + def ItemHasChildren(self, item: Any) -> Any: """ Returns nonzero if the specified item has child items. @@ -45050,9 +44415,9 @@ Returns: Any """ - pass + ... - def GetChildItem(self, item: 'Any') -> 'Any': + def GetChildItem(self, item: Any) -> Any: """ Retrieves the first child item. @@ -45065,9 +44430,9 @@ Returns: Any """ - pass + ... - def GetNextSiblingItem(self, item: 'Any') -> 'Any': + def GetNextSiblingItem(self, item: Any) -> Any: """ Retrieves the next sibling of the specified tree view item. @@ -45080,9 +44445,9 @@ Returns: Any """ - pass + ... - def GetPrevSiblingItem(self, item: 'Any') -> 'Any': + def GetPrevSiblingItem(self, item: Any) -> Any: """ Retrieves the previous sibling of the specified tree view item. @@ -45095,9 +44460,9 @@ Returns: Any """ - pass + ... - def GetParentItem(self, item: 'Any') -> 'Any': + def GetParentItem(self, item: Any) -> Any: """ Retrieves the parent item of the specified tree view item. @@ -45110,9 +44475,9 @@ Returns: Any """ - pass + ... - def GetFirstVisibleItem(self,) -> 'Any': + def GetFirstVisibleItem(self) -> Any: """ Retrieves the first visible item of the tree view control. @@ -45125,9 +44490,9 @@ Returns: Any """ - pass + ... - def GetNextVisibleItem(self, item: 'Any') -> 'Any': + def GetNextVisibleItem(self, item: Any) -> Any: """ Retrieves the next visible item of the specified tree view item. @@ -45140,9 +44505,9 @@ Returns: Any """ - pass + ... - def GetSelectedItem(self,) -> 'Any': + def GetSelectedItem(self) -> Any: """ Retrieves the currently selected tree view item. @@ -45155,9 +44520,9 @@ Returns: Any """ - pass + ... - def GetDropHilightItem(self,) -> 'Any': + def GetDropHilightItem(self) -> Any: """ Retrieves the target of a drag-and-drop operation. @@ -45170,9 +44535,9 @@ Returns: Any """ - pass + ... - def GetRootItem(self,) -> 'Any': + def GetRootItem(self) -> Any: """ Retrieves the root of the specified tree view item. @@ -45185,9 +44550,9 @@ Returns: Any """ - pass + ... - def GetToolTips(self,) -> 'Any': + def GetToolTips(self) -> Any: """ Returns the tooltip control @@ -45200,9 +44565,9 @@ Returns: Any """ - pass + ... - def GetItem(self, item: 'Any', arg: 'Any') -> 'Any': + def GetItem(self, item: Any, arg: Any) -> Any: """ Retrieves the details of an items attributes. @@ -45216,9 +44581,9 @@ Returns: Any """ - pass + ... - def SetItem(self, item: 'Any') -> 'Any': + def SetItem(self, item: Any) -> Any: """ Sets some of all of an items attributes. @@ -45231,9 +44596,9 @@ Returns: Any """ - pass + ... - def GetItemState(self, item: 'Any', stateMask: 'Any') -> 'Tuple[Any, Any]': + def GetItemState(self, item: Any, stateMask: Any) -> Tuple[Any, Any]: """ Retrieves the state and mask of an item. @@ -45247,9 +44612,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def SetItemState(self, item: 'Any', state: 'Any', stateMask: 'Any') -> 'None': + def SetItemState(self, item: Any, state: Any, stateMask: Any) -> None: """ Sets the state of item. @@ -45264,9 +44629,9 @@ Returns: None """ - pass + ... - def GetItemImage(self, item: 'Any') -> 'Tuple[Any, Any]': + def GetItemImage(self, item: Any) -> Tuple[Any, Any]: """ Retrieves the index of an items images. @@ -45279,9 +44644,9 @@ Returns: Tuple[Any, Any] """ - pass + ... - def SetItemImage(self, item: 'Any', iImage: 'Any', iSelectedImage: 'Any') -> 'None': + def SetItemImage(self, item: Any, iImage: Any, iSelectedImage: Any) -> None: """ Sets the index of an items images. @@ -45296,9 +44661,9 @@ Returns: None """ - pass + ... - def SetItemText(self, item: 'Any', text: 'str') -> 'Any': + def SetItemText(self, item: Any, text: str) -> Any: """ Changes the text of a list view item or subitem. @@ -45312,9 +44677,9 @@ Returns: Any """ - pass + ... - def GetItemText(self, item: 'Any') -> 'Any': + def GetItemText(self, item: Any) -> Any: """ Retrieves the text of a list view item or subitem. @@ -45327,9 +44692,9 @@ Returns: Any """ - pass + ... - def GetItemData(self, item: 'Any') -> 'Any': + def GetItemData(self, item: Any) -> Any: """ Retrieves the application-specific value associated with an item. @@ -45342,9 +44707,9 @@ Returns: Any """ - pass + ... - def SetItemData(self, item: 'Any', Data: 'Any') -> 'Any': + def SetItemData(self, item: Any, Data: Any) -> Any: """ Sets the item's application-specific value. @@ -45358,9 +44723,9 @@ Returns: Any """ - pass + ... - def GetItemRect(self, item: 'Any', bTextOnly: 'Any') -> 'Tuple[Any, Any, Any, Any]': + def GetItemRect(self, item: Any, bTextOnly: Any) -> Tuple[Any, Any, Any, Any]: """ Retrieves the bounding rectangle of a tree view item. @@ -45374,9 +44739,9 @@ Returns: Tuple[Any, Any, Any, Any] """ - pass + ... - def GetEditControl(self,) -> 'Any': + def GetEditControl(self) -> Any: """ Retrieves the handle of the edit control used to edit the specified @@ -45391,9 +44756,9 @@ Returns: Any """ - pass + ... - def GetVisibleCount(self,) -> 'Any': + def GetVisibleCount(self) -> Any: """ Retrieves the number of visible tree items associated with a tree view @@ -45408,30 +44773,30 @@ Returns: Any """ - pass + ... def InsertItem( self, - hParent: 'Any', - hInsertAfter: 'Any', - item: 'Any', - mask: 'Any', - text: 'Any', - image: 'Any', - selectedImage: 'Any', - state: 'Any', - stateMask: 'Any', - lParam: 'Any', - parent: 'Any', - parent1: 'Any', - text1: 'Any', - image1: 'Any', - selectedImage1: 'Any', - parent2: 'Any', - insertAfter: 'Any', - text2: 'Any', - parent3: 'Any', - parent4: 'Any') -> 'Any': + hParent: Any, + hInsertAfter: Any, + item: Any, + mask: Any, + text: Any, + image: Any, + selectedImage: Any, + state: Any, + stateMask: Any, + lParam: Any, + parent: Any, + parent1: Any, + text1: Any, + image1: Any, + selectedImage1: Any, + parent2: Any, + insertAfter: Any, + text2: Any, + parent3: Any, + parent4: Any) -> Any: """ Inserts an item into the list. @@ -45463,9 +44828,9 @@ Returns: Any """ - pass + ... - def DeleteItem(self, item: 'Any') -> 'None': + def DeleteItem(self, item: Any) -> None: """ Deletes the specified item. @@ -45478,9 +44843,9 @@ Returns: None """ - pass + ... - def DeleteAllItems(self,) -> 'Any': + def DeleteAllItems(self) -> Any: """ Deletes all items in the control @@ -45493,9 +44858,9 @@ Returns: Any """ - pass + ... - def Expand(self, item: 'Any', code: 'Any') -> 'None': + def Expand(self, item: Any, code: Any) -> None: """ Expands, or collapses, the child items of the specified tree view item. @@ -45509,9 +44874,9 @@ Returns: None """ - pass + ... - def Select(self, item: 'Any', code: 'Any') -> 'None': + def Select(self, item: Any, code: Any) -> None: """ Selects, scrolls into view, or redraws a specified tree view item. @@ -45525,9 +44890,9 @@ Returns: None """ - pass + ... - def SelectItem(self, item: 'Any') -> 'None': + def SelectItem(self, item: Any) -> None: """ Selects a specified tree view item. @@ -45540,9 +44905,9 @@ Returns: None """ - pass + ... - def SelectDropTarget(self, item: 'Any') -> 'None': + def SelectDropTarget(self, item: Any) -> None: """ Redraws the tree item as the target of a drag-and-drop operation. @@ -45555,9 +44920,9 @@ Returns: None """ - pass + ... - def SelectSetFirstVisible(self, item: 'Any') -> 'None': + def SelectSetFirstVisible(self, item: Any) -> None: """ Selects a specified tree view item as the first visible item. @@ -45570,9 +44935,9 @@ Returns: None """ - pass + ... - def EditLabel(self, item: 'Any') -> 'Any': + def EditLabel(self, item: Any) -> Any: """ Edits a specified tree view item in-place. @@ -45585,9 +44950,9 @@ Returns: Any """ - pass + ... - def CreateDragImage(self, item: 'Any') -> 'Any': + def CreateDragImage(self, item: Any) -> Any: """ Creates a dragging bitmap for the specified tree view item. @@ -45600,9 +44965,9 @@ Returns: Any """ - pass + ... - def SortChildren(self, item: 'Any') -> 'None': + def SortChildren(self, item: Any) -> None: """ Sorts the children of a given parent item. @@ -45615,9 +44980,9 @@ Returns: None """ - pass + ... - def EnsureVisible(self, item: 'Any') -> 'Any': + def EnsureVisible(self, item: Any) -> Any: """ Ensures that a tree view item is visible in its tree view control. @@ -45630,9 +44995,9 @@ Returns: Any """ - pass + ... - def HitTest(self, arg: 'Any') -> 'Tuple[Any, Any]': + def HitTest(self, arg: Any) -> Tuple[Any, Any]: """ Determines which tree view item, if any, is at a specified position. @@ -45670,16 +45035,15 @@ commctrl.TVHT_TORIGHTTo the right of the client area. """ - pass + ... -class PyCTreeView(object): - """""" +class PyCTreeView: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def PreCreateWindow(self, createStruct: 'Any') -> 'Any': + def PreCreateWindow(self, createStruct: Any) -> Any: """ Calls the underlying MFC PreCreateWindow method. @@ -45692,9 +45056,9 @@ Returns: Any """ - pass + ... - def GetTreeCtrl(self,) -> 'Any': + def GetTreeCtrl(self) -> Any: """ Returns the underlying tree control object. @@ -45707,9 +45071,9 @@ Returns: Any """ - pass + ... - def OnCommand(self, wparam: 'Any', lparam: 'Any') -> 'None': + def OnCommand(self, wparam: Any, lparam: Any) -> None: """ Calls the standard Python framework OnCommand handler @@ -45723,16 +45087,15 @@ Returns: None """ - pass + ... -class PyCView(object): - """""" +class PyCView: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CreateWindow(self, parent: 'Any', arg: 'Any', arg1: 'Any', arg2: 'Tuple[Any, Any, Any, Any]') -> 'None': + def CreateWindow(self, parent: Any, arg: Any, arg1: Any, arg2: Tuple[Any, Any, Any, Any]) -> None: """ Creates the window for a view. @@ -45748,9 +45111,9 @@ Returns: None """ - pass + ... - def GetDocument(self,) -> 'Any': + def GetDocument(self) -> Any: """ Returns the document for a view. @@ -45763,9 +45126,9 @@ Returns: Any """ - pass + ... - def OnActivateView(self, activate: 'Any', activateView: 'Any', DeactivateView: 'Any') -> 'Any': + def OnActivateView(self, activate: Any, activateView: Any, DeactivateView: Any) -> Any: """ Calls the underlying MFC OnActivateView method. @@ -45780,9 +45143,9 @@ Returns: Any """ - pass + ... - def OnInitialUpdate(self,) -> 'None': + def OnInitialUpdate(self) -> None: """ Calls the underlying MFC OnInitialUpdate method. @@ -45795,9 +45158,9 @@ Returns: None """ - pass + ... - def OnMouseActivate(self, wnd: 'Any', hittest: 'Any', message: 'Any') -> 'Any': + def OnMouseActivate(self, wnd: Any, hittest: Any, message: Any) -> Any: """ Calls the base MFC OnMouseActivate function. @@ -45812,9 +45175,9 @@ Returns: Any """ - pass + ... - def PreCreateWindow(self, createStruct: 'Any') -> 'Any': + def PreCreateWindow(self, createStruct: Any) -> Any: """ Calls the underlying MFC PreCreateWindow method. @@ -45827,9 +45190,9 @@ Returns: Any """ - pass + ... - def OnFilePrint(self,) -> 'None': + def OnFilePrint(self) -> None: """ Calls the underlying MFC OnFilePrint method. @@ -45842,9 +45205,9 @@ Returns: None """ - pass + ... - def DoPreparePrinting(self,) -> 'Any': + def DoPreparePrinting(self) -> Any: """ Invoke the Print dialog box and create a printer device context. @@ -45857,9 +45220,9 @@ Returns: Any """ - pass + ... - def OnBeginPrinting(self,) -> 'None': + def OnBeginPrinting(self) -> None: """ Calls the underlying MFC OnBeginPrinting method. @@ -45872,9 +45235,9 @@ Returns: None """ - pass + ... - def OnEndPrinting(self,) -> 'None': + def OnEndPrinting(self) -> None: """ Calls the underlying MFC OnEndPrinting method. @@ -45887,16 +45250,15 @@ Returns: None """ - pass + ... -class PyCWinApp(object): - """""" +class PyCWinApp: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def AddDocTemplate(self, template: 'Any') -> 'None': + def AddDocTemplate(self, template: Any) -> None: """ Adds a template to the application list. @@ -45909,9 +45271,9 @@ Returns: None """ - pass + ... - def FindOpenDocument(self, fileName: 'str') -> 'Any': + def FindOpenDocument(self, fileName: str) -> Any: """ Returns an existing document with the specified file name. @@ -45924,9 +45286,9 @@ Returns: Any """ - pass + ... - def GetDocTemplateList(self,) -> 'List[Any]': + def GetDocTemplateList(self) -> List[Any]: """ Returns a list of all document templates. @@ -45939,9 +45301,9 @@ Returns: List[Any] """ - pass + ... - def InitDlgInstance(self, dialog: 'Any') -> 'None': + def InitDlgInstance(self, dialog: Any) -> None: """ Calls critical InitInstance processing for a dialog based application. @@ -45954,9 +45316,9 @@ Returns: None """ - pass + ... - def LoadCursor(self, cursorId: 'PyResourceId') -> 'Any': + def LoadCursor(self, cursorId: PyResourceId) -> Any: """ Loads a cursor. @@ -45969,9 +45331,9 @@ Returns: Any """ - pass + ... - def LoadStandardCursor(self, cursorId: 'PyResourceId') -> 'Any': + def LoadStandardCursor(self, cursorId: PyResourceId) -> Any: """ Loads a standard cursor. @@ -45984,9 +45346,9 @@ Returns: Any """ - pass + ... - def LoadOEMCursor(self, cursorId: 'Any') -> 'Any': + def LoadOEMCursor(self, cursorId: Any) -> Any: """ Loads an OEM cursor. @@ -45999,9 +45361,9 @@ Returns: Any """ - pass + ... - def LoadIcon(self, idResource: 'Any') -> 'Any': + def LoadIcon(self, idResource: Any) -> Any: """ Loads an icon resource. @@ -46014,9 +45376,9 @@ Returns: Any """ - pass + ... - def LoadStandardIcon(self, resourceName: 'PyResourceId') -> 'Any': + def LoadStandardIcon(self, resourceName: PyResourceId) -> Any: """ Loads an icon resource. @@ -46029,9 +45391,9 @@ Returns: Any """ - pass + ... - def OpenDocumentFile(self, fileName: 'str') -> 'None': + def OpenDocumentFile(self, fileName: str) -> None: """ Opens a document file by name. @@ -46044,9 +45406,9 @@ Returns: None """ - pass + ... - def OnFileNew(self,) -> 'None': + def OnFileNew(self) -> None: """ Calls the underlying OnFileNew MFC method. @@ -46059,9 +45421,9 @@ Returns: None """ - pass + ... - def OnFileOpen(self,) -> 'None': + def OnFileOpen(self) -> None: """ Calls the underlying OnFileOpen MFC method. @@ -46074,9 +45436,9 @@ Returns: None """ - pass + ... - def RemoveDocTemplate(self, template: 'Any') -> 'None': + def RemoveDocTemplate(self, template: Any) -> None: """ Removes a template to the application list. @@ -46089,9 +45451,9 @@ Returns: None """ - pass + ... - def Run(self,) -> 'Any': + def Run(self) -> Any: """ Starts the message pump. Advanced users only @@ -46104,9 +45466,9 @@ Returns: Any """ - pass + ... - def IsInproc(self,) -> 'Any': + def IsInproc(self) -> Any: """ Returns a flag to indicate if the created CWinApp was in the DLL, or an external @@ -46121,16 +45483,15 @@ Returns: Any """ - pass + ... -class PyCWinThread(object): - """""" +class PyCWinThread: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CreateThread(self,) -> 'None': + def CreateThread(self) -> None: """ Creates the actual thread behind the thread object. @@ -46143,9 +45504,9 @@ Returns: None """ - pass + ... - def PumpIdle(self,) -> 'None': + def PumpIdle(self) -> None: """ Pumps all idle messages. @@ -46158,9 +45519,9 @@ Returns: None """ - pass + ... - def PumpMessages(self,) -> 'None': + def PumpMessages(self) -> None: """ Pumps all messages to the application until a WM_QUIT message is received. @@ -46173,9 +45534,9 @@ Returns: None """ - pass + ... - def Run(self,) -> 'Any': + def Run(self) -> Any: """ Starts the message pump. Advanced users only @@ -46188,24 +45549,24 @@ Returns: Any """ - pass + ... - def SetMainFrame(self, mainFrame: 'Any') -> 'None': + def SetMainFrame(self, mainFrame: Any) -> None: """ Sets the threads main frame Args: - mainFrame(Any):The applications main frame.CommentsYou can pass None to this function to reset the main frame. Should I free this? I dont think so! + mainFrame(Any):The applications main frame.CommentsYou can ... None to this function to reset the main frame. Should I free this? I dont think so! Returns: None """ - pass + ... - def SetThreadPriority(self, priority: 'Any') -> 'None': + def SetThreadPriority(self, priority: Any) -> None: """ Sets the threads priority. Returns TRUE if successful. @@ -46218,16 +45579,15 @@ Returns: None """ - pass + ... -class PyCWnd(object): - """""" +class PyCWnd: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def ActivateFrame(self, cmdShow: 'Any') -> 'None': + def ActivateFrame(self, cmdShow: Any) -> None: """ Searches upwards for a parent window which has @@ -46242,9 +45602,9 @@ Returns: None """ - pass + ... - def BringWindowToTop(self,) -> 'None': + def BringWindowToTop(self) -> None: """ Brings the window to the top of a stack of overlapping windows. @@ -46257,9 +45617,9 @@ Returns: None """ - pass + ... - def BeginPaint(self,) -> 'Tuple[Any, Any]': + def BeginPaint(self) -> Tuple[Any, Any]: """ Prepares a window for painting @@ -46273,13 +45633,13 @@ Returns: PyCDC, PAINTSTRUCT = BeginPaint()Prepares a window for painting -Return ValueYou must pass the PAINTSTRUCT param to the PyCWnd::EndPaint method. +Return ValueYou must ... the PAINTSTRUCT param to the PyCWnd::EndPaint method. """ - pass + ... - def CalcWindowRect(self, rect: 'Tuple[Any, Any, Any, Any]', nAdjustType: 'Any') -> 'Tuple[Any, Any, Any, Any]': + def CalcWindowRect(self, rect: Tuple[Any, Any, Any, Any], nAdjustType: Any) -> Tuple[Any, Any, Any, Any]: """ Computes the size of the window rectangle based on the desired client @@ -46297,9 +45657,9 @@ Returns: Tuple[Any, Any, Any, Any] """ - pass + ... - def CenterWindow(self, altwin: 'Any' = None) -> 'None': + def CenterWindow(self, altwin: Any = None) -> None: """ Centers a window relative to its parent. @@ -46312,9 +45672,9 @@ Returns: None """ - pass + ... - def CheckRadioButton(self, idFirst: 'Any', idLast: 'Any', idCheck: 'Any') -> 'None': + def CheckRadioButton(self, idFirst: Any, idLast: Any, idCheck: Any) -> None: """ Selects the specified radio button, and clears @@ -46331,9 +45691,9 @@ Returns: None """ - pass + ... - def ChildWindowFromPoint(self, x: 'Any', y: 'Any', flag: 'Any' = 0) -> 'Any': + def ChildWindowFromPoint(self, x: Any, y: Any, flag: Any = 0) -> Any: """ Returns the child window that contains the point @@ -46348,9 +45708,9 @@ Returns: Any """ - pass + ... - def ClientToScreen(self, point: 'Tuple[Any, Any]', rect: 'Any') -> 'Tuple[Any, Any, Any, Any, Any]': + def ClientToScreen(self, point: Tuple[Any, Any], rect: Any) -> Tuple[Any, Any, Any, Any, Any]: """ Converts the client coordinates of a given point on the display @@ -46366,17 +45726,17 @@ Returns: Tuple[Any, Any, Any, Any, Any] """ - pass + ... def CreateWindow( self, - classId: 'str', - windowName: 'str', - style: 'Any', - rect: 'Tuple[Any, Any, Any, Any]', - parent: 'Any', - _id: 'Any', - context: 'Any' = None) -> 'None': + classId: str, + windowName: str, + style: Any, + rect: Tuple[Any, Any, Any, Any], + parent: Any, + _id: Any, + context: Any = None) -> None: """ Creates the actual window @@ -46395,19 +45755,19 @@ Returns: None """ - pass + ... def CreateWindowEx( self, - styleEx: 'Any', - classId: 'str', - windowName: 'str', - style: 'Any', - rect: 'Tuple[Any, Any, Any, Any]', - parent: 'Any', - _id: 'Any', - createStruct1: 'Any', - createStruct: 'Any' = None) -> 'None': + styleEx: Any, + classId: str, + windowName: str, + style: Any, + rect: Tuple[Any, Any, Any, Any], + parent: Any, + _id: Any, + createStruct1: Any, + createStruct: Any = None) -> None: """ Creates the actual window using extended capabilities. @@ -46428,9 +45788,9 @@ Returns: None """ - pass + ... - def DefWindowProc(self, message: 'Any', idLast: 'Any', idCheck: 'Any') -> 'Any': + def DefWindowProc(self, message: Any, idLast: Any, idCheck: Any) -> Any: """ Calls the default message handler. @@ -46445,9 +45805,9 @@ Returns: Any """ - pass + ... - def DestroyWindow(self,) -> 'None': + def DestroyWindow(self) -> None: """ Destroy the window attached to the object. @@ -46460,9 +45820,9 @@ Returns: None """ - pass + ... - def DlgDirList(self, defPath: 'str', idListbox: 'Any', idStaticPath: 'Any', fileType: 'Any') -> 'None': + def DlgDirList(self, defPath: str, idListbox: Any, idStaticPath: Any, fileType: Any) -> None: """ Fill a list box with a file or directory listing. @@ -46478,9 +45838,9 @@ Returns: None """ - pass + ... - def DlgDirListComboBox(self,) -> 'None': + def DlgDirListComboBox(self) -> None: """ None @@ -46493,9 +45853,9 @@ Returns: None """ - pass + ... - def DlgDirSelect(self, idListbox: 'Any') -> 'str': + def DlgDirSelect(self, idListbox: Any) -> str: """ None @@ -46508,9 +45868,9 @@ Returns: str """ - pass + ... - def DlgDirSelectComboBox(self, idListbox: 'Any') -> 'str': + def DlgDirSelectComboBox(self, idListbox: Any) -> str: """ None @@ -46523,9 +45883,9 @@ Returns: str """ - pass + ... - def DragAcceptFiles(self, bAccept: 'Any' = 1) -> 'None': + def DragAcceptFiles(self, bAccept: Any = 1) -> None: """ Indicates that the window and children supports files dropped from file manager @@ -46538,9 +45898,9 @@ Returns: None """ - pass + ... - def DrawMenuBar(self,) -> 'None': + def DrawMenuBar(self) -> None: """ Redraws the menu bar. Can be called if the menu changes. @@ -46553,9 +45913,9 @@ Returns: None """ - pass + ... - def EnableWindow(self, bEnable: 'Any' = 1) -> 'Any': + def EnableWindow(self, bEnable: Any = 1) -> Any: """ Enables or disables the window. Typically used for dialog controls. @@ -46570,9 +45930,9 @@ Return ValueReturns the state before the EnableWindow member function was called """ - pass + ... - def EndModalLoop(self, result: 'Any') -> 'None': + def EndModalLoop(self, result: Any) -> None: """ Ends a modal loop. @@ -46585,9 +45945,9 @@ Returns: None """ - pass + ... - def EndPaint(self, paintStruct: 'Any') -> 'None': + def EndPaint(self, paintStruct: Any) -> None: """ Ends painting @@ -46600,9 +45960,9 @@ Returns: None """ - pass + ... - def GetCheckedRadioButton(self, idFirst: 'Any', idLast: 'Any') -> 'Any': + def GetCheckedRadioButton(self, idFirst: Any, idLast: Any) -> Any: """ Returns the ID of the checked radio button, or 0 if none is selected. @@ -46616,9 +45976,9 @@ Returns: Any """ - pass + ... - def GetClientRect(self,) -> 'Tuple[Any, Any, Any, Any]': + def GetClientRect(self) -> Tuple[Any, Any, Any, Any]: """ Returns the client coordinates of the window. left and top @@ -46633,9 +45993,9 @@ Returns: Tuple[Any, Any, Any, Any] """ - pass + ... - def GetDC(self,) -> 'Any': + def GetDC(self) -> Any: """ Gets the windows current DC object. @@ -46651,9 +46011,9 @@ Return ValueThe result is a PyCDC, or a win32ui.error exception is raised. """ - pass + ... - def GetDCEx(self,) -> 'Any': + def GetDCEx(self) -> Any: """ Gets the windows current DC object with extended caps. @@ -46666,9 +46026,9 @@ Returns: Any """ - pass + ... - def GetDlgCtrlID(self,) -> 'Any': + def GetDlgCtrlID(self) -> Any: """ Returns the ID of this child window. @@ -46681,9 +46041,9 @@ Returns: Any """ - pass + ... - def GetDlgItem(self, idControl: 'Any') -> 'Any': + def GetDlgItem(self, idControl: Any) -> Any: """ None @@ -46698,9 +46058,9 @@ Return ValueThe result is a PyCWnd (or derived) object, or a win32ui.error excep """ - pass + ... - def GetDlgItemInt(self, idControl: 'Any', bUnsigned: 'Any' = 1) -> 'Any': + def GetDlgItemInt(self, idControl: Any, bUnsigned: Any = 1) -> Any: """ Returns the integer value of a child window or control with the specified ID. @@ -46716,9 +46076,9 @@ Return ValueIf the value can not be converted, a ValueError is raised. """ - pass + ... - def GetDlgItemText(self, idControl: 'Any') -> 'str': + def GetDlgItemText(self, idControl: Any) -> str: """ Returns the text of child window or control with the specified ID. @@ -46731,9 +46091,9 @@ Returns: str """ - pass + ... - def GetLastActivePopup(self,) -> 'Any': + def GetLastActivePopup(self) -> Any: """ Returns the last active popup Window, or the Window itself. @@ -46748,9 +46108,9 @@ Return ValueThe result is a PyCWnd object, or None if no Window can be found. """ - pass + ... - def GetMenu(self,) -> 'Any': + def GetMenu(self) -> Any: """ Returns the menu object for the window's menu. @@ -46767,9 +46127,9 @@ Return ValueThe result is a PyMenu """ - pass + ... - def GetParent(self,) -> 'Any': + def GetParent(self) -> Any: """ Returns the window's parent. @@ -46784,9 +46144,9 @@ Return ValueThe result is a PyCWnd object, or None if no Window can be found. """ - pass + ... - def GetParentFrame(self,) -> 'Any': + def GetParentFrame(self) -> Any: """ Returns the window's frame. @@ -46801,9 +46161,9 @@ Return ValueThe result is a PyCWnd object, or None if no Window can be found. """ - pass + ... - def GetSafeHwnd(self,) -> 'Any': + def GetSafeHwnd(self) -> Any: """ Returns the HWnd of this window. @@ -46816,9 +46176,9 @@ Returns: Any """ - pass + ... - def GetScrollInfo(self, nBar: 'Any', mask: 'Any') -> 'Any': + def GetScrollInfo(self, nBar: Any, mask: Any) -> Any: """ Returns information about a scroll bar @@ -46832,9 +46192,9 @@ Returns: Any """ - pass + ... - def GetScrollPos(self, nBar: 'Any') -> 'Any': + def GetScrollPos(self, nBar: Any) -> Any: """ Retrieves the current position of the scroll box of a scroll bar. @@ -46847,9 +46207,9 @@ Returns: Any """ - pass + ... - def GetStyle(self,) -> 'Any': + def GetStyle(self) -> Any: """ Retrieves the window style @@ -46862,9 +46222,9 @@ Returns: Any """ - pass + ... - def GetExStyle(self,) -> 'Any': + def GetExStyle(self) -> Any: """ Retrieves the window's extended style @@ -46877,9 +46237,9 @@ Returns: Any """ - pass + ... - def GetSystemMenu(self,) -> 'Any': + def GetSystemMenu(self) -> Any: """ Returns the menu object for the window's system menu. @@ -46892,9 +46252,9 @@ Returns: Any """ - pass + ... - def GetTopLevelFrame(self,) -> 'Any': + def GetTopLevelFrame(self) -> Any: """ Returns the top-level frame of the window. @@ -46909,9 +46269,9 @@ Return ValueThe result is a PyCWnd object, or None if no Window can be found. """ - pass + ... - def GetTopLevelOwner(self,) -> 'Any': + def GetTopLevelOwner(self) -> Any: """ Returns the top-level owner of the window. @@ -46926,9 +46286,9 @@ Return ValueThe result is a PyCWnd object, or None if no Window can be found. """ - pass + ... - def GetTopLevelParent(self,) -> 'Any': + def GetTopLevelParent(self) -> Any: """ Returns the top-level parent of the window. @@ -46943,9 +46303,9 @@ Return ValueThe result is a PyCWnd object, or None if no Window can be found. """ - pass + ... - def GetTopWindow(self,) -> 'Any': + def GetTopWindow(self) -> Any: """ Identifies the top-level child window in a linked list of child windows. @@ -46960,9 +46320,9 @@ Return ValueIf no child windows exist, the value is None. """ - pass + ... - def GetWindow(self, _type: 'Any') -> 'Any': + def GetWindow(self, _type: Any) -> Any: """ Returns a window, with the specified relationship to this window. @@ -46977,9 +46337,9 @@ Return ValueThe result is a PyCWnd or None if no Window can be found. """ - pass + ... - def GetWindowDC(self,) -> 'Any': + def GetWindowDC(self) -> Any: """ Gets the windows current DC object. @@ -46992,9 +46352,9 @@ Returns: Any """ - pass + ... - def GetWindowPlacement(self,) -> 'Any': + def GetWindowPlacement(self) -> Any: """ Returns placement information about the current window. @@ -47026,9 +46386,9 @@ normalposSpecifies the window's coordinates when the window is in the restored p """ - pass + ... - def GetWindowRect(self,) -> 'Tuple[Any, Any, Any, Any]': + def GetWindowRect(self) -> Tuple[Any, Any, Any, Any]: """ Returns the screen coordinates of the windows upper left @@ -47043,9 +46403,9 @@ Returns: Tuple[Any, Any, Any, Any] """ - pass + ... - def GetWindowText(self,) -> 'str': + def GetWindowText(self) -> str: """ Returns the windows text. @@ -47058,9 +46418,9 @@ Returns: str """ - pass + ... - def HideCaret(self,) -> 'None': + def HideCaret(self) -> None: """ Hides the caret @@ -47073,9 +46433,9 @@ Returns: None """ - pass + ... - def HookAllKeyStrokes(self, obHandler: 'Any') -> 'None': + def HookAllKeyStrokes(self, obHandler: Any) -> None: """ Hook a key stroke handler for all key strokes. @@ -47088,9 +46448,9 @@ Returns: None """ - pass + ... - def HookKeyStroke(self, obHandler: 'Any', ch: 'Any') -> 'Any': + def HookKeyStroke(self, obHandler: Any, ch: Any) -> Any: """ Hook a key stroke handler @@ -47122,9 +46482,9 @@ Return ValueThe return value is the previous handler, or None. """ - pass + ... - def HookMessage(self, obHandler: 'Any', message: 'Any') -> 'Any': + def HookMessage(self, obHandler: Any, message: Any) -> Any: """ Hook a message notification handler @@ -47164,9 +46524,9 @@ Return ValueThe return value is the previous handler, or None. """ - pass + ... - def InvalidateRect(self, arg: 'Tuple[Any, Any, Any, Any]', bErase: 'Any' = 1) -> 'None': + def InvalidateRect(self, arg: Tuple[Any, Any, Any, Any], bErase: Any = 1) -> None: """ Invalidates an area of a window. @@ -47180,9 +46540,9 @@ Returns: None """ - pass + ... - def InvalidateRgn(self, region: 'Any', bErase: 'Any' = 1) -> 'None': + def InvalidateRgn(self, region: Any, bErase: Any = 1) -> None: """ Invalidates a region of the window @@ -47196,9 +46556,9 @@ Returns: None """ - pass + ... - def IsChild(self, obWnd: 'Any') -> 'Any': + def IsChild(self, obWnd: Any) -> Any: """ Determines if a given window is a child of this window. @@ -47211,9 +46571,9 @@ Returns: Any """ - pass + ... - def IsDlgButtonChecked(self, idCtl: 'Any') -> 'Any': + def IsDlgButtonChecked(self, idCtl: Any) -> Any: """ Determines if a dialog button is checked. @@ -47226,9 +46586,9 @@ Returns: Any """ - pass + ... - def IsIconic(self,) -> 'Any': + def IsIconic(self) -> Any: """ Determines if the window is currently displayed as an icon. @@ -47241,9 +46601,9 @@ Returns: Any """ - pass + ... - def IsZoomed(self,) -> 'Any': + def IsZoomed(self) -> Any: """ Determines if the window is currently maximised. @@ -47256,9 +46616,9 @@ Returns: Any """ - pass + ... - def IsWindow(self,) -> 'Any': + def IsWindow(self) -> Any: """ determines whether the specified window handle identifies an existing window @@ -47271,9 +46631,9 @@ Returns: Any """ - pass + ... - def IsWindowVisible(self,) -> 'Any': + def IsWindowVisible(self) -> Any: """ Determines if the window is currently visible. @@ -47286,9 +46646,9 @@ Returns: Any """ - pass + ... - def KillTimer(self,) -> 'Any': + def KillTimer(self) -> Any: """ Kills a system timer @@ -47301,9 +46661,9 @@ Returns: Any """ - pass + ... - def LockWindowUpdate(self,) -> 'None': + def LockWindowUpdate(self) -> None: """ Disables drawing in the given window @@ -47316,9 +46676,9 @@ Returns: None """ - pass + ... - def MapWindowPoints(self, wnd: 'Any', points: 'List[Any]') -> 'None': + def MapWindowPoints(self, wnd: Any, points: List[Any]) -> None: """ Converts (maps) a set of points from the coordinate space of a window to the @@ -47337,9 +46697,9 @@ window. """ - pass + ... - def MouseCaptured(self,) -> 'Any': + def MouseCaptured(self) -> Any: """ Returns 1 if the window has the mouse capture, else 0 @@ -47352,9 +46712,9 @@ Returns: Any """ - pass + ... - def MessageBox(self, message: 'str', arg: 'Any', title: 'Union[Any, str]' = None) -> 'None': + def MessageBox(self, message: str, arg: Any, title: Union[Any, str] = None) -> None: """ Display a message box. @@ -47371,9 +46731,9 @@ Return ValueAn integer identifying the button pressed to dismiss the dialog. """ - pass + ... - def ModifyStyle(self, remove: 'Any', add: 'Any', flags: 'Any' = 0) -> 'Any': + def ModifyStyle(self, remove: Any, add: Any, flags: Any = 0) -> Any: """ Modifies the style of a window. @@ -47392,9 +46752,9 @@ is already the same as requested and no change was made. """ - pass + ... - def ModifyStyleEx(self, remove: 'Any', add: 'Any', flags: 'Any' = 0) -> 'Any': + def ModifyStyleEx(self, remove: Any, add: Any, flags: Any = 0) -> Any: """ Modifies the extended style of a window. @@ -47413,9 +46773,9 @@ is already the same as requested and no change was made. """ - pass + ... - def MoveWindow(self, rect: 'Tuple[Any, Any, Any, Any]', bRepaint: 'Any' = 1) -> 'None': + def MoveWindow(self, rect: Tuple[Any, Any, Any, Any], bRepaint: Any = 1) -> None: """ Move a window to a new location. @@ -47429,9 +46789,9 @@ Returns: None """ - pass + ... - def OnClose(self,) -> 'Any': + def OnClose(self) -> Any: """ Calls the default MFC OnClose handler. @@ -47444,9 +46804,9 @@ Returns: Any """ - pass + ... - def OnCtlColor(self, dc: 'Any', control: 'Any', _type: 'Any') -> 'Any': + def OnCtlColor(self, dc: Any, control: Any, _type: Any) -> Any: """ Calls the default MFC OnCtlColor handler. @@ -47461,9 +46821,9 @@ Returns: Any """ - pass + ... - def OnEraseBkgnd(self, dc: 'Any') -> 'Any': + def OnEraseBkgnd(self, dc: Any) -> Any: """ Calls the default MFC OnEraseBkgnd handler. @@ -47476,9 +46836,9 @@ Returns: Any """ - pass + ... - def OnNcHitTest(self, arg: 'Tuple[Any, Any]') -> 'Any': + def OnNcHitTest(self, arg: Tuple[Any, Any]) -> Any: """ Calls the base MFC OnNcHitTest function. @@ -47491,9 +46851,9 @@ Returns: Any """ - pass + ... - def OnPaint(self,) -> 'Any': + def OnPaint(self) -> Any: """ Calls the default MFC OnPaint handler. @@ -47506,9 +46866,9 @@ Returns: Any """ - pass + ... - def OnQueryDragIcon(self,) -> 'Any': + def OnQueryDragIcon(self) -> Any: """ Calls the default MFC OnQueryDragIcon handler. @@ -47521,9 +46881,9 @@ Returns: Any """ - pass + ... - def OnQueryNewPalette(self,) -> 'Any': + def OnQueryNewPalette(self) -> Any: """ Calls the underlying MFC OnQueryNewPalette method. @@ -47536,9 +46896,9 @@ Returns: Any """ - pass + ... - def OnSetCursor(self, wnd: 'Any', hittest: 'Any', message: 'Any') -> 'Any': + def OnSetCursor(self, wnd: Any, hittest: Any, message: Any) -> Any: """ Calls the base MFC OnSetCursor function. @@ -47553,9 +46913,9 @@ Returns: Any """ - pass + ... - def OnMouseActivate(self, wnd: 'Any', hittest: 'Any', message: 'Any') -> 'Any': + def OnMouseActivate(self, wnd: Any, hittest: Any, message: Any) -> Any: """ Calls the base MFC OnMouseActivate function. @@ -47570,9 +46930,9 @@ Returns: Any """ - pass + ... - def OnWndMsg(self, msg: 'Any', wParam: 'Any', lParam: 'Any') -> 'Tuple[Any, Any]': + def OnWndMsg(self, msg: Any, wParam: Any, lParam: Any) -> Tuple[Any, Any]: """ Calls the default MFC Window Message handler. @@ -47593,9 +46953,9 @@ lResult param. Please see the MFC documentation for more details. """ - pass + ... - def PreCreateWindow(self, createStruct: 'Any') -> 'Any': + def PreCreateWindow(self, createStruct: Any) -> Any: """ Calls the underlying MFC PreCreateWindow method. @@ -47608,9 +46968,9 @@ Returns: Any """ - pass + ... - def PumpWaitingMessages(self, firstMsg: 'Any', lastMsg: 'Any') -> 'None': + def PumpWaitingMessages(self, firstMsg: Any, lastMsg: Any) -> None: """ Pump messages associate with a window. @@ -47624,9 +46984,9 @@ Returns: None """ - pass + ... - def RedrawWindow(self, _object: 'Any', flags: 'Any', rect: 'Tuple[Any, Any, Any, Any]' = None) -> 'None': + def RedrawWindow(self, _object: Any, flags: Any, rect: Tuple[Any, Any, Any, Any] = None) -> None: """ Updates the specified rectangle or region in the given window's client area. @@ -47641,9 +47001,9 @@ Returns: None """ - pass + ... - def ReleaseCapture(self,) -> 'None': + def ReleaseCapture(self) -> None: """ None @@ -47656,9 +47016,9 @@ Returns: None """ - pass + ... - def ReleaseDC(self, dc: 'Any') -> 'None': + def ReleaseDC(self, dc: Any) -> None: """ Releases a device context, freeing it for use by other applications. @@ -47671,9 +47031,9 @@ Returns: None """ - pass + ... - def RepositionBars(self, idFirst: 'Any', idLast: 'Any', idLeftOver: 'Any') -> 'None': + def RepositionBars(self, idFirst: Any, idLast: Any, idLeftOver: Any) -> None: """ Repositions the windows control bars.( UINT nIDFirst, UINT nIDLast, UINT @@ -47692,9 +47052,9 @@ Returns: None """ - pass + ... - def RunModalLoop(self, flags: 'Any') -> 'Any': + def RunModalLoop(self, flags: Any) -> Any: """ Begins a modal loop for the window. @@ -47707,9 +47067,9 @@ Returns: Any """ - pass + ... - def PostMessage(self, idMessage: 'Any', wParam: 'Any' = 0, lParam: 'Any' = 0) -> 'None': + def PostMessage(self, idMessage: Any, wParam: Any = 0, lParam: Any = 0) -> None: """ Post a message to the window. @@ -47724,14 +47084,14 @@ Returns: None """ - pass + ... def SendMessageToDescendants( self, - idMessage: 'Any', - wParam: 'Any' = 0, - lParam: 'Any' = 0, - bDeep: 'Any' = 1) -> 'None': + idMessage: Any, + wParam: Any = 0, + lParam: Any = 0, + bDeep: Any = 1) -> None: """ Send a message to all descendant windows. @@ -47747,15 +47107,15 @@ Returns: None """ - pass + ... def SendMessage( self, - idMessage: 'Any', - idMessage1: 'Any', - ob: 'Any', - wParam: 'Any' = 0, - lParam: 'Any' = 0) -> 'None': + idMessage: Any, + idMessage1: Any, + ob: Any, + wParam: Any = 0, + lParam: Any = 0) -> None: """ Send a message to the window. @@ -47772,9 +47132,9 @@ Returns: None """ - pass + ... - def SetActiveWindow(self,) -> 'Any': + def SetActiveWindow(self) -> Any: """ Sets the window active. Returns the previously active window, or None. @@ -47790,9 +47150,9 @@ Return ValueThe result is the previous window with focus, or None. """ - pass + ... - def SetForegroundWindow(self,) -> 'None': + def SetForegroundWindow(self) -> None: """ Puts the window into the foreground and activates the window. @@ -47805,9 +47165,9 @@ Returns: None """ - pass + ... - def SetWindowPos(self, hWndInsertAfter: 'Any', position: 'Tuple[Any, Any, Any, Any]', flags: 'Any') -> 'None': + def SetWindowPos(self, hWndInsertAfter: Any, position: Tuple[Any, Any, Any, Any], flags: Any) -> None: """ Sets the windows position information @@ -47822,9 +47182,9 @@ Returns: None """ - pass + ... - def ScreenToClient(self, rect: 'Tuple[Any, Any, Any, Any, Any]', pnt: 'Any') -> 'Tuple[Any, Any, Any, Any, Any]': + def ScreenToClient(self, rect: Tuple[Any, Any, Any, Any, Any], pnt: Any) -> Tuple[Any, Any, Any, Any, Any]: """ Converts the screen coordinates of a given point @@ -47842,9 +47202,9 @@ Return ValueThe result is the same size as the input argument. """ - pass + ... - def SetCapture(self,) -> 'None': + def SetCapture(self) -> None: """ Causes all subsequent mouse input to be sent to the window object regardless of the @@ -47859,9 +47219,9 @@ Returns: None """ - pass + ... - def SetDlgItemText(self, idControl: 'Any', text: 'str') -> 'None': + def SetDlgItemText(self, idControl: Any, text: str) -> None: """ Sets the text for the child window or control with the specified ID. @@ -47875,9 +47235,9 @@ Returns: None """ - pass + ... - def SetFocus(self,) -> 'None': + def SetFocus(self) -> None: """ Claims the input focus. The object that previously had the focus loses it. @@ -47890,9 +47250,9 @@ Returns: None """ - pass + ... - def SetFont(self, font: 'Any', bRedraw: 'Any' = 1) -> 'None': + def SetFont(self, font: Any, bRedraw: Any = 1) -> None: """ Sets the window's current font to the specified font. @@ -47906,9 +47266,9 @@ Returns: None """ - pass + ... - def SetIcon(self,) -> 'Any': + def SetIcon(self) -> Any: """ Calls the underlying MFC SetIcon method. @@ -47921,9 +47281,9 @@ Returns: Any """ - pass + ... - def SetMenu(self, menuObj: 'Any') -> 'None': + def SetMenu(self, menuObj: Any) -> None: """ Sets the menu for a window. @@ -47936,9 +47296,9 @@ Returns: None """ - pass + ... - def SetRedraw(self, bState: 'Any' = 1) -> 'None': + def SetRedraw(self, bState: Any = 1) -> None: """ Allows changes to be redrawn or to prevent changes from being redrawn. @@ -47951,9 +47311,9 @@ Returns: None """ - pass + ... - def SetScrollPos(self, nBar: 'Any', nPos: 'Any', redraw: 'Any' = 1) -> 'Any': + def SetScrollPos(self, nBar: Any, nPos: Any, redraw: Any = 1) -> Any: """ Sets the current position of the scroll box of a scroll bar. @@ -47968,9 +47328,9 @@ Returns: Any """ - pass + ... - def SetScrollInfo(self, nBar: 'Any', ScrollInfo: 'Any', redraw: 'Any' = 1) -> 'Any': + def SetScrollInfo(self, nBar: Any, ScrollInfo: Any, redraw: Any = 1) -> Any: """ Set information about a scroll bar @@ -47985,9 +47345,9 @@ Returns: Any """ - pass + ... - def SetTimer(self, idEvent: 'Any', elapse: 'Any') -> 'Any': + def SetTimer(self, idEvent: Any, elapse: Any) -> Any: """ Installs a system timer @@ -48001,9 +47361,9 @@ Returns: Any """ - pass + ... - def SetWindowPlacement(self, placement: 'Any') -> 'None': + def SetWindowPlacement(self, placement: Any) -> None: """ Sets the windows placement @@ -48016,9 +47376,9 @@ Returns: None """ - pass + ... - def SetWindowText(self, text: 'str') -> 'None': + def SetWindowText(self, text: str) -> None: """ Sets the window's text. @@ -48031,9 +47391,9 @@ Returns: None """ - pass + ... - def ShowCaret(self,) -> 'None': + def ShowCaret(self) -> None: """ Shows the caret @@ -48046,9 +47406,9 @@ Returns: None """ - pass + ... - def ShowScrollBar(self, nBar: 'Any', bShow: 'Any' = 1) -> 'None': + def ShowScrollBar(self, nBar: Any, bShow: Any = 1) -> None: """ Shows or hides a scroll bar. @@ -48064,9 +47424,9 @@ Returns: None """ - pass + ... - def ShowWindow(self, arg: 'Any') -> 'Any': + def ShowWindow(self, arg: Any) -> Any: """ Sets the visibility state of the window. @@ -48081,9 +47441,9 @@ Return ValueReturns TRUE is the window was previously visible. """ - pass + ... - def UnLockWindowUpdate(self,) -> 'None': + def UnLockWindowUpdate(self) -> None: """ Unlocks a window that was locked with LockWindowUpdate @@ -48096,9 +47456,9 @@ Returns: None """ - pass + ... - def UpdateData(self, bSaveAndValidate: 'Any' = 1) -> 'Any': + def UpdateData(self, bSaveAndValidate: Any = 1) -> Any: """ Initialises data in a dialog box, or to retrieves and validates dialog data. @@ -48115,9 +47475,9 @@ Returns: Any """ - pass + ... - def UpdateDialogControls(self, pTarget: 'Any', disableIfNoHandler: 'Any') -> 'Any': + def UpdateDialogControls(self, pTarget: Any, disableIfNoHandler: Any) -> Any: """ None @@ -48131,9 +47491,9 @@ Returns: Any """ - pass + ... - def UpdateWindow(self,) -> 'None': + def UpdateWindow(self) -> None: """ Updates a window. This forces a paint message to be sent to the window, if any part @@ -48148,16 +47508,16 @@ Returns: None """ - pass + ... -class PyDDEConv(object): +class PyDDEConv: """A DDE topic.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def ConnectTo(self, service: 'str', topic: 'str') -> 'None': + def ConnectTo(self, service: str, topic: str) -> None: """ Connects to a server @@ -48171,9 +47531,9 @@ Returns: None """ - pass + ... - def Connected(self,) -> 'None': + def Connected(self) -> None: """ Determines if the conversation is connected. @@ -48186,9 +47546,9 @@ Returns: None """ - pass + ... - def Exec(self, Cmd: 'str') -> 'None': + def Exec(self, Cmd: str) -> None: """ Executes a command. @@ -48201,9 +47561,9 @@ Returns: None """ - pass + ... - def Request(self,) -> 'None': + def Request(self) -> None: """ Sends a request. @@ -48216,9 +47576,9 @@ Returns: None """ - pass + ... - def Poke(self,) -> 'None': + def Poke(self) -> None: """ Sends a poke. @@ -48231,16 +47591,16 @@ Returns: None """ - pass + ... -class PyDDEServer(object): +class PyDDEServer: """A DDE server.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def AddTopic(self, topic: 'Any') -> 'None': + def AddTopic(self, topic: Any) -> None: """ None @@ -48253,9 +47613,9 @@ Returns: None """ - pass + ... - def Create(self, name: 'str', filterFlags: 'Any' = 0) -> 'None': + def Create(self, name: str, filterFlags: Any = 0) -> None: """ Create a server @@ -48269,9 +47629,9 @@ Returns: None """ - pass + ... - def Destroy(self,) -> 'None': + def Destroy(self) -> None: """ None @@ -48284,9 +47644,9 @@ Returns: None """ - pass + ... - def GetLastError(self,) -> 'Any': + def GetLastError(self) -> Any: """ None @@ -48299,9 +47659,9 @@ Returns: Any """ - pass + ... - def Shutdown(self,) -> 'None': + def Shutdown(self) -> None: """ None @@ -48314,16 +47674,16 @@ Returns: None """ - pass + ... -class PyDDEStringItem(object): +class PyDDEStringItem: """A DDE string item.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def SetData(self, data: 'str') -> 'None': + def SetData(self, data: str) -> None: """ Sets an items data, and causes any underlying notification. @@ -48336,16 +47696,16 @@ Returns: None """ - pass + ... -class PyDDETopic(object): +class PyDDETopic: """A DDE topic.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def AddItem(self, item: 'Any') -> 'None': + def AddItem(self, item: Any) -> None: """ Add an item to the topic. @@ -48358,9 +47718,9 @@ Returns: None """ - pass + ... - def Destroy(self,) -> 'None': + def Destroy(self) -> None: """ Destroys an item @@ -48373,16 +47733,16 @@ Returns: None """ - pass + ... -class PyDLL(object): +class PyDLL: """A DLL object. A general utility object, and not associated with an MFC object.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetFileName(self,) -> 'str': + def GetFileName(self) -> str: """ Returns the name of the module associated with the DLL. @@ -48395,9 +47755,9 @@ Returns: str """ - pass + ... - def AttachToMFC(self,) -> 'None': + def AttachToMFC(self) -> None: """ Attaches the DLL object to the MFC list of DLL's. @@ -48410,24 +47770,23 @@ Returns: None """ - pass + ... -class SCROLLINFO(object): +class SCROLLINFO: """Tuple representing a SCROLLINFO struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class TV_ITEM(object): - """""" +class TV_ITEM: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') -class EXTENSION_CONTROL_BLOCK(object): +class EXTENSION_CONTROL_BLOCK: """A python representation of an ISAPI EXTENSION_CONTROL_BLOCK.""" @@ -48436,66 +47795,66 @@ EXTENSION_CONTROL_BLOCK.""" raise Exception('This class just for typing, can not be instanced!') @property - def Version(self) -> 'int': + def Version(self) -> int: """Version info of this spec (read-only)""" - pass + ... @property - def TotalBytes(self) -> 'Any': + def TotalBytes(self) -> Any: """Total bytes indicated from client""" - pass + ... @property - def AvailableBytes(self) -> 'Any': + def AvailableBytes(self) -> Any: """Available number of bytes""" - pass + ... @property - def HttpStatusCode(self) -> 'Any': + def HttpStatusCode(self) -> Any: """The status of the current transaction when the request is completed.""" - pass + ... @property - def Method(self) -> 'Any': + def Method(self) -> Any: """REQUEST_METHOD""" - pass + ... @property - def ConnID(self) -> 'Any': + def ConnID(self) -> Any: """Context number (read-only)""" - pass + ... @property - def QueryString(self) -> 'Any': + def QueryString(self) -> Any: """QUERY_STRING""" - pass + ... @property - def PathInfo(self) -> 'Any': + def PathInfo(self) -> Any: """PATH_INFO""" - pass + ... @property - def PathTranslated(self) -> 'Any': + def PathTranslated(self) -> Any: """PATH_TRANSLATED""" - pass + ... @property - def AvailableData(self) -> 'Any': + def AvailableData(self) -> Any: """Pointer to cbAvailable bytes""" - pass + ... @property - def ContentType(self) -> 'Any': + def ContentType(self) -> Any: """Content type of client data""" - pass + ... @property - def LogData(self) -> 'Any': + def LogData(self) -> Any: """log data string""" - pass + ... - def WriteClient(self, data: 'Union[Any, str]', reserved: 'Any' = 0) -> 'Any': + def WriteClient(self, data: Union[Any, str], reserved: Any = 0) -> Any: """ None @@ -48511,16 +47870,16 @@ Return Valuethe result is the number of bytes written. """ - pass + ... - def GetServerVariable(self, variable: 'str', default: 'Any') -> 'str': + def GetServerVariable(self, variable: str, default: Any) -> str: """ None Args: variable(str): - default(Any):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 begins with 'UNICODE_', in which case it is a unicode object - see the ISAPI docs for more details. + default(Any):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 begins with 'UNICODE_, in which case it is a unicode object - see the ISAPI docs for more details. Returns: @@ -48528,15 +47887,15 @@ Returns: 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 + ... - def ReadClient(self, nbytes: 'Any') -> 'str': + def ReadClient(self, nbytes: Any) -> str: """ None @@ -48549,9 +47908,9 @@ Returns: str """ - pass + ... - def SendResponseHeaders(self, reply: 'str', headers: 'str', keepAlive: 'Any' = False) -> 'None': + def SendResponseHeaders(self, reply: str, headers: str, keepAlive: Any = False) -> None: """ Calls ServerSupportFunction with @@ -48568,9 +47927,9 @@ Returns: None """ - pass + ... - def SetFlushFlag(self, flag: 'Any') -> 'None': + def SetFlushFlag(self, flag: Any) -> None: """ Calls ServerSupportFunction with HSE_REQ_SET_FLUSH_FLAG. @@ -48583,19 +47942,19 @@ Returns: None """ - pass + ... def TransmitFile( self, - callback: 'Any', - param: 'Any', - hFile: 'Any', - statusCode: 'str', - BytesToWrite: 'Any', - Offset: 'Any', - head: 'str', - tail: 'str', - flags: 'Any') -> 'Any': + callback: Any, + param: Any, + hFile: Any, + statusCode: str, + BytesToWrite: Any, + Offset: Any, + head: str, + tail: str, + flags: Any) -> Any: """ Calls ServerSupportFunction with HSE_REQ_TRANSMIT_FILE @@ -48616,9 +47975,9 @@ Returns: Any """ - pass + ... - def MapURLToPath(self,) -> 'None': + def MapURLToPath(self) -> None: """ Calls ServerSupportFunction with HSE_REQ_MAP_URL_TO_PATH @@ -48631,9 +47990,9 @@ Returns: None """ - pass + ... - def DoneWithSession(self, status: 'Any') -> 'None': + def DoneWithSession(self, status: Any) -> None: """ Calls ServerSupportFunction with HSE_REQ_DONE_WITH_SESSION @@ -48646,9 +48005,9 @@ Returns: None """ - pass + ... - def Redirect(self, url: 'str') -> 'None': + def Redirect(self, url: str) -> None: """ Calls ServerSupportFunction with HSE_REQ_SEND_URL_REDIRECT_RESP @@ -48661,9 +48020,9 @@ Returns: None """ - pass + ... - def IsKeepAlive(self,) -> 'None': + def IsKeepAlive(self) -> None: """ None @@ -48676,9 +48035,9 @@ Returns: None """ - pass + ... - def GetAnonymousToken(self, metabase_path: 'Union[Any, str]') -> 'Any': + def GetAnonymousToken(self, metabase_path: Union[Any, str]) -> Any: """ Calls ServerSupportFunction with HSE_REQ_GET_ANONYMOUS_TOKEN @@ -48693,9 +48052,9 @@ Returns: Any """ - pass + ... - def GetImpersonationToken(self,) -> 'Any': + def GetImpersonationToken(self) -> Any: """ Calls ServerSupportFunction with @@ -48710,9 +48069,9 @@ Returns: Any """ - pass + ... - def IsKeepConn(self,) -> 'Any': + def IsKeepConn(self) -> Any: """ Calls ServerSupportFunction with HSE_REQ_IS_KEEP_CONN @@ -48725,16 +48084,16 @@ Returns: Any """ - pass + ... def ExecURL( self, - url: 'str', - method: 'str', - clientHeaders: 'str', - info: 'Any', - entity: 'Any', - flags: 'Any') -> 'Any': + url: str, + method: str, + clientHeaders: str, + info: Any, + entity: Any, + flags: Any) -> Any: """ Calls ServerSupportFunction with HSE_REQ_EXEC_URL @@ -48752,9 +48111,9 @@ Returns: Any """ - pass + ... - def GetExecURLStatus(self,) -> 'Any': + def GetExecURLStatus(self) -> Any: """ Calls ServerSupportFunction with HSE_REQ_GET_EXEC_URL_STATUS @@ -48769,9 +48128,9 @@ Return ValueThe result of a tuple of 3 integers - (uHttpStatusCode, uHttpSubStat """ - pass + ... - def IOCompletion(self, func: 'Any', arg: 'Any' = None) -> 'Any': + def IOCompletion(self, func: Any, arg: Any = None) -> Any: """ Set a callback that will be used for handling asynchronous I/O @@ -48787,9 +48146,9 @@ Returns: Any """ - pass + ... - def ReportUnhealthy(self, reason: 'str' = None) -> 'Any': + def ReportUnhealthy(self, reason: str = None) -> Any: """ Calls ServerSupportFunction with HSE_REQ_REPORT_UNHEALTHY @@ -48802,9 +48161,9 @@ Returns: Any """ - pass + ... - def IOCallback(self, ecb: 'Any', arg: 'Any', cbIO: 'Any', dwError: 'Any') -> 'Any': + def IOCallback(self, ecb: Any, arg: Any, cbIO: Any, dwError: Any) -> Any: """ A placeholder for a user-supplied callback function. @@ -48828,22 +48187,22 @@ Return ValueThe result of this function is ignored. """ - pass + ... -class HSE_VERSION_INFO(object): +class HSE_VERSION_INFO: """An object used by ISAPI GetExtensionVersion""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @property - def ExtensionDesc(self) -> 'str': + def ExtensionDesc(self) -> str: """The description of the extension.""" - pass + ... -class HTTP_FILTER_AUTHENT(object): +class HTTP_FILTER_AUTHENT: """A Python representation of an ISAPI HTTP_FILTER_AUTHENT structure.""" @@ -48852,17 +48211,15 @@ HTTP_FILTER_AUTHENT structure.""" raise Exception('This class just for typing, can not be instanced!') @property - def User(self) -> 'str': - """""" - pass + def User(self) -> str: + ... @property - def Password(self) -> 'str': - """""" - pass + def password(self) -> str: + ... -class HTTP_FILTER_CONTEXT(object): +class HTTP_FILTER_CONTEXT: """A Python representation of an ISAPI HTTP_FILTER_CONTEXT structure.""" @@ -48871,26 +48228,26 @@ HTTP_FILTER_CONTEXT structure.""" raise Exception('This class just for typing, can not be instanced!') @property - def Revision(self) -> 'Any': + def Revision(self) -> Any: """(read-only)""" - pass + ... @property - def fIsSecurePort(self) -> 'Any': + def fIsSecurePort(self) -> Any: """(read-only)""" - pass + ... @property - def NotificationType(self) -> 'Any': + def NotificationType(self) -> Any: """(read-only)""" - pass + ... @property - def FilterContext(self) -> 'Any': + def FilterContext(self) -> Any: """Any object you wish to associate with the request.""" - pass + ... - def GetData(self,) -> 'Any': + def GetData(self) -> Any: """ Obtains the data passed to @@ -48932,16 +48289,16 @@ SF_NOTIFY_AUTHENTICATIONHTTP_FILTER_AUTHENT """ - pass + ... - def GetServerVariable(self, variable: 'str', default: 'Any') -> 'str': + def GetServerVariable(self, variable: str, default: Any) -> str: """ None Args: variable(str): - default(Any):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 begins with 'UNICODE_', in which case it is a unicode object - see the ISAPI docs for more details. + default(Any):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 begins with 'UNICODE_, in which case it is a unicode object - see the ISAPI docs for more details. Returns: @@ -48949,15 +48306,15 @@ Returns: 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 + ... - def WriteClient(self, data: 'str', reserverd: 'Any' = 0) -> 'None': + def WriteClient(self, data: str, reserverd: Any = 0) -> None: """ None @@ -48971,9 +48328,9 @@ Returns: None """ - pass + ... - def AddResponseHeaders(self, data: 'str', reserverd: 'Any' = 0) -> 'None': + def AddResponseHeaders(self, data: str, reserverd: Any = 0) -> None: """ None @@ -48987,9 +48344,9 @@ Returns: None """ - pass + ... - def SendResponseHeader(self, status: 'str', header: 'str') -> 'None': + def SendResponseHeader(self, status: str, header: str) -> None: """ None @@ -49003,9 +48360,9 @@ Returns: None """ - pass + ... - def DisableNotifications(self, flags: 'Any') -> 'None': + def DisableNotifications(self, flags: Any) -> None: """ None @@ -49018,10 +48375,10 @@ Returns: None """ - pass + ... -class HTTP_FILTER_LOG(object): +class HTTP_FILTER_LOG: """A Python representation of an ISAPI HTTP_FILTER_LOG structure.""" @@ -49030,42 +48387,35 @@ HTTP_FILTER_LOG structure.""" raise Exception('This class just for typing, can not be instanced!') @property - def ClientHostName(self) -> 'str': - """""" - pass + def ClientHostName(self) -> str: + ... @property - def ClientUserName(self) -> 'str': - """""" - pass + def ClientUserName(self) -> str: + ... @property - def ServerName(self) -> 'str': - """""" - pass + def ServerName(self) -> str: + ... @property - def Operation(self) -> 'str': - """""" - pass + def Operation(self) -> str: + ... @property - def Target(self) -> 'str': - """""" - pass + def Target(self) -> str: + ... @property - def Parameters(self) -> 'str': - """""" - pass + def Parameters(self) -> str: + ... @property - def HttpStatus(self) -> 'Any': - """""" - pass + def HttpStatus(self) -> Any: + ... -class HTTP_FILTER_PREPROC_HEADERS(object): +class HTTP_FILTER_PREPROC_HEADERS: """A Python representation of an ISAPI HTTP_FILTER_PREPROC_HEADERS structure.""" @@ -49073,7 +48423,7 @@ HTTP_FILTER_PREPROC_HEADERS structure.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetHeader(self, header: 'str', default: 'Any') -> 'str': + def GetHeader(self, header: str, default: Any) -> str: """ None @@ -49087,9 +48437,9 @@ Returns: str """ - pass + ... - def SetHeader(self, name: 'str', val: 'str') -> 'None': + def SetHeader(self, name: str, val: str) -> None: """ None @@ -49103,9 +48453,9 @@ Returns: None """ - pass + ... - def AddHeader(self,) -> 'None': + def AddHeader(self) -> None: """ None @@ -49118,10 +48468,10 @@ Returns: None """ - pass + ... -class HTTP_FILTER_RAW_DATA(object): +class HTTP_FILTER_RAW_DATA: """A Python representation of an ISAPI HTTP_FILTER_RAW_DATA structure.""" @@ -49130,12 +48480,11 @@ HTTP_FILTER_RAW_DATA structure.""" raise Exception('This class just for typing, can not be instanced!') @property - def InData(self) -> 'str': - """""" - pass + def InData(self) -> str: + ... -class HTTP_FILTER_URL_MAP(object): +class HTTP_FILTER_URL_MAP: """A Python representation of an ISAPI HTTP_FILTER_URL_MAP structure.""" @@ -49144,17 +48493,15 @@ HTTP_FILTER_URL_MAP structure.""" raise Exception('This class just for typing, can not be instanced!') @property - def URL(self) -> 'str': - """""" - pass + def URL(self) -> str: + ... @property - def PhysicalPath(self) -> 'str': - """""" - pass + def PhysicalPath(self) -> str: + ... -class HTTP_FILTER_VERSION(object): +class HTTP_FILTER_VERSION: """A Python interface to the ISAPI HTTP_FILTER_VERSION structure.""" @@ -49163,21 +48510,18 @@ structure.""" raise Exception('This class just for typing, can not be instanced!') @property - def ServerFilterVersion(self) -> 'Any': + def ServerFilterVersion(self) -> Any: """(read-only)""" - pass + ... @property - def FilterVersion(self) -> 'Any': - """""" - pass + def FilterVersion(self) -> Any: + ... @property - def Flags(self) -> 'Any': - """""" - pass + def Flags(self) -> Any: + ... @property - def FilterDesc(self) -> 'str': - """""" - pass + def FilterDesc(self) -> str: + ... From 17e3e81216d36b939bb59f0bc3fc4bb09d75fed1 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sun, 13 Mar 2022 03:18:03 -0400 Subject: [PATCH 021/137] Further pyi linting --- .flake8 | 30 +- .github/workflows/lint-and-build.yml | 8 +- scripts/requirements.txt | 12 +- src/AutoSplit.py | 4 +- src/capture_windows.py | 4 +- src/user_profile.py | 10 +- typings/PyInstaller/utils/hooks/__init__.pyi | 8 +- typings/cv2-stubs/__init__.pyi | 33 +- typings/imagehash/__init__.pyi | 22 +- typings/keyboard/__init__.pyi | 150 +-- typings/keyboard/_canonical_names.pyi | 2 +- typings/keyboard/_generic.pyi | 2 +- typings/keyboard/_keyboard_event.pyi | 21 +- typings/pyautogui/__init__.pyi | 18 +- typings/win32-stubs/win32gui.pyi | 658 +++++----- typings/win32con/__init__.pyi | 2 +- typings/win32typing/__init__.pyi | 1140 +++++++++--------- 17 files changed, 1052 insertions(+), 1072 deletions(-) diff --git a/.flake8 b/.flake8 index 92ef77a0..13ad4a4c 100644 --- a/.flake8 +++ b/.flake8 @@ -8,19 +8,27 @@ exclude=src/gen/ ; Allow imports at the bottom of file ignore=W503,Y015,E402 per-file-ignores= - ; Uses "pass" for empty body - ; Default arguments - ; Doesn't work when using /** below for some reasons - ; win32typing.pyi: Y010,Y011, - ; win32gui.pyi: Y010,Y011, - ; + ; Function bodys contain other than just ... (eg: raise) + ; Default values for typed arguments + typings/win32typing/__init__.pyi: Q000,E704,E501,N8, Y021,Y020, Y010,Y011 + typings/win32-stubs/win32gui.pyi: Q000,E704,E501,N8, Y021,Y020, Y010,Y011 + + ; Docstrings in type stubs + ; Quoted annotations + ; TypeAlias + typings/win32*/*: Q000,E704,E501,N8, Y021,Y020,Y026 + + ; Docstrings in type stubs + ; Function bodys contain other than just ... (eg: raise) + ; TypeAlias + ; Single quote docstrings + typings/cv2-stubs/__init__.pyi: Q000,E704,E501,N8, Y021,Y010,Y026, Q002 + ; Quotes - ; undefined name 'Unknown' - ; allow ... on same line as def + ; Allow ... on same line as def + ; Line too long ; Naming stuff - ; - ; Q002 quote docstring for cv2-stubs - typings/**: Q000,F821,E704,N8,E501,Y010,Y011,Q002 + typings/**: Q000,E704,E501,N8 ; PyQt methods ignore-names=closeEvent,paintEvent,keyPressEvent,mousePressEvent,mouseMoveEvent,mouseReleaseEvent diff --git a/.github/workflows/lint-and-build.yml b/.github/workflows/lint-and-build.yml index 9b285cbb..efec46de 100644 --- a/.github/workflows/lint-and-build.yml +++ b/.github/workflows/lint-and-build.yml @@ -43,7 +43,7 @@ jobs: pip install -r "scripts/requirements.txt" npm install -g pyright - run: scripts/compile_resources.bat - - name: Analysing the code with ${{ job.name }} + - name: Analysing the code with ${{ github.job }} run: pyright --warnings Pylint: runs-on: windows-latest @@ -64,7 +64,7 @@ jobs: pip install wheel pip install -r "scripts/requirements.txt" - run: scripts/compile_resources.bat - - name: Analysing the code with ${{ job.name }} + - name: Analysing the code with ${{ github.job }} run: pylint --reports=y --output-format=colorized $(git ls-files '**/*.py') Flake8: runs-on: windows-latest @@ -85,7 +85,7 @@ jobs: pip install wheel pip install -r "scripts/requirements.txt" - run: scripts/compile_resources.bat - - name: Analysing the code with ${{ job.name }} + - name: Analysing the code with ${{ github.job }} run: flake8 Bandit: runs-on: windows-latest @@ -106,7 +106,7 @@ jobs: pip install wheel pip install -r "scripts/requirements.txt" - run: scripts/compile_resources.bat - - name: Analysing the code with ${{ job.name }} + - name: Analysing the code with ${{ github.job }} run: bandit -n 1 --severity-level medium --recursive src Build: runs-on: windows-latest diff --git a/scripts/requirements.txt b/scripts/requirements.txt index 50cbb87f..0dafddd0 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -1,11 +1,11 @@ # Requirements file for AutoSplit # -# Python: CPython 3.9+ +# Python: CPython 3.8+ # # Usage: .\scripts\install.bat # # If you're having issues with the libraries, you might want to first run: -# pip3.9 uninstall -r .\scripts\requirements.txt +# pip uninstall -r .\scripts\requirements.txt # # Creating AutoSplit.exe with PyInstaller: .\scripts\build.bat # @@ -23,8 +23,7 @@ pywin32 requests certifi toml -# Not compatible with python 3.10 yet -# PyQt6-tools +# # Linting and Types bandit flake8 @@ -35,5 +34,10 @@ pywin32-stubs simplejson types-simplejson>=3.17.2 types-requests +# +# Not compatible with python 3.10 yet, used to design the UI. Can be downloaded externally +# Uncomment this if you want to run `designer.bat` to quickly open the bundled PyQt Designer +# PyQt6-tools +# # Comment this out if you don't want to build AutoSplit.exe: PyInstaller diff --git a/src/AutoSplit.py b/src/AutoSplit.py index b220dfc9..53be2fe0 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -650,7 +650,9 @@ def __similarity_threshold_loop(self, number_of_split_images: int, dummy_splits_ # Email sent to pyqt@riverbankcomputing.com QtTest.QTest.qWait(wait_delta) # type: ignore continue - elif self.split_image.check_flag(BELOW_FLAG) and self.split_below_threshold: + + elif ( # pylint: disable=confusing-consecutive-elif + self.split_image.check_flag(BELOW_FLAG) and self.split_below_threshold): self.split_below_threshold = False break diff --git a/src/capture_windows.py b/src/capture_windows.py index 94653a81..b8c5f953 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -1,5 +1,5 @@ from __future__ import annotations -from typing import Optional, cast +from typing import Dict, Optional, cast import ctypes import ctypes.wintypes @@ -33,7 +33,7 @@ # toml.dump does not support TypedDicts or dataclasses # TODO: Check if we can just "cast" or "map" it before parsing it as TOML -Region = dict[str, int] +Region = Dict[str, int] # pylint: disable=deprecated-typing-alias def capture_region(hwnd: int, selection: Region, print_window: bool): diff --git a/src/user_profile.py b/src/user_profile.py index 6dd43116..b5e909dd 100644 --- a/src/user_profile.py +++ b/src/user_profile.py @@ -75,8 +75,8 @@ def save_settings(autosplit: AutoSplit): autosplit.last_saved_settings = autosplit.settings_dict # Save settings to a .toml file - with open(autosplit.last_successfully_loaded_settings_file_path, "w") as file: - toml.dump(autosplit.last_saved_settings, file, encoder=toml.TomlNumpyEncoder()) + with open(autosplit.last_successfully_loaded_settings_file_path, "w", encoding="utf-8") as file: + toml.dump(autosplit.last_saved_settings, file) return autosplit.last_successfully_loaded_settings_file_path @@ -99,8 +99,8 @@ def save_settings_as(autosplit: AutoSplit): autosplit.last_saved_settings = autosplit.settings_dict # Save settings to a .toml file - with open(save_settings_file_path, "w") as file: - toml.dump(autosplit.last_saved_settings, file, encoder=toml.TomlNumpyEncoder()) + with open(save_settings_file_path, "w", encoding="utf-8") as file: + toml.dump(autosplit.last_saved_settings, file) autosplit.last_successfully_loaded_settings_file_path = save_settings_file_path return save_settings_file_path @@ -111,7 +111,7 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str autosplit.show_error_signal.emit(error_messages.old_version_settings_file) return False try: - with open(load_settings_file_path, "r") as file: + with open(load_settings_file_path, "r", encoding="utf-8") as file: # Casting here just so we can build an actual UserProfileDict once we're done validating # Fallback to default settings if some are missing from the file. This happens when new settings are added. loaded_settings = cast(UserProfileDict, { diff --git a/typings/PyInstaller/utils/hooks/__init__.pyi b/typings/PyInstaller/utils/hooks/__init__.pyi index 154d59ca..ba3aef20 100644 --- a/typings/PyInstaller/utils/hooks/__init__.pyi +++ b/typings/PyInstaller/utils/hooks/__init__.pyi @@ -1,4 +1,4 @@ -""" +""" # noqa: Y021 This type stub file was generated by pyright. """ from typing import Any, Literal, Optional, Union @@ -85,11 +85,7 @@ def is_module_or_submodule(name, mod_or_submod): ... -PY_DYLIB_PATTERNS = [ - "*.dll", - "*.dylib", - "lib*.so", -] +PY_DYLIB_PATTERNS = ... def collect_dynamic_libs(package: str, destdir: Optional[str] = ...) -> list[tuple[str, str]]: diff --git a/typings/cv2-stubs/__init__.pyi b/typings/cv2-stubs/__init__.pyi index ce47a96c..a44e3cc6 100644 --- a/typings/cv2-stubs/__init__.pyi +++ b/typings/cv2-stubs/__init__.pyi @@ -2050,10 +2050,10 @@ def buildOpticalFlowPyramid( def calcBackProject( - images: typing.List[ndarray], - channels: typing.List[int], + images: list[ndarray], + channels: list[int], hist, - ranges: typing.List[int], + ranges: list[int], scale, dts: ndarray = ...) -> typing.Any: 'calcBackProject(images, channels, hist, ranges, scale[, dst]) -> dst\n. @overload' @@ -2066,11 +2066,11 @@ def calcCovarMatrix(samples, mean, flags: int, covar=..., ctype=...) -> typing.A def calcHist( - images: typing.List[ndarray], - channels: typing.List[int], + images: list[ndarray], + channels: list[int], mask: typing.Optional[ndarray], - histSize: typing.List[int], - ranges: typing.List[int], + histSize: list[int], + ranges: list[int], hist=..., accumulate=...) -> ndarray: 'calcHist(images, channels, mask, histSize, ranges[, hist[, accumulate]]) -> hist\n. @overload' @@ -3332,7 +3332,7 @@ def imshow(winname, mat) -> typing.Any: ... -def imwrite(filename: str, img: ndarray, params: typing.List[int] = ...) -> bool: +def imwrite(filename: str, img: ndarray, params: list[int] = ...) -> bool: "imwrite(filename, img[, params]) -> retval\n. @brief Saves an image to a specified file.\n. \n. The function imwrite saves the image to the specified file. The image format is chosen based on the\n. filename extension (see cv::imread for the list of extensions). In general, only 8-bit\n. single-channel or 3-channel (with 'BGR' channel order) images\n. can be saved using this function, with these exceptions:\n. \n. - 16-bit unsigned (CV_16U) images can be saved in the case of PNG, JPEG 2000, and TIFF formats\n. - 32-bit float (CV_32F) images can be saved in PFM, TIFF, OpenEXR, and Radiance HDR formats;\n. 3-channel (CV_32FC3) TIFF images will be saved using the LogLuv high dynamic range encoding\n. (4 bytes per pixel)\n. - PNG images with an alpha channel can be saved using this function. To do this, create\n. 8-bit (or 16-bit) 4-channel image BGRA, where the alpha channel goes last. Fully transparent pixels\n. should have alpha set to 0, fully opaque pixels should have alpha set to 255/65535 (see the code sample below).\n. - Multiple images (vector of Mat) can be saved in TIFF format (see the code sample below).\n. \n. If the format, depth or channel order is different, use\n. Mat::convertTo and cv::cvtColor to convert it before saving. Or, use the universal FileStorage I/O\n. functions to save the image to XML or YAML format.\n. \n. The sample below shows how to create a BGRA image, how to set custom compression parameters and save it to a PNG file.\n. It also demonstrates how to save multiple images in a TIFF file:\n. @include snippets/imgcodecs_imwrite.cpp\n. @param filename Name of the file.\n. @param img (Mat or vector of Mat) Image or Images to be saved.\n. @param params Format-specific parameters encoded as pairs (paramId_1, paramValue_1, paramId_2, paramValue_2, ... .) see cv::ImwriteFlags" ... @@ -3505,8 +3505,7 @@ def minEnclosingTriangle(points, triangle=...) -> typing.Any: ... -def minMaxLoc(src: ndarray, mask: ndarray = ...) -> typing.Tuple[float, - float, typing.Tuple[int, int], typing.Tuple[int, int]]: +def minMaxLoc(src: ndarray, mask: ndarray = ...) -> tuple[float, float, tuple[int, int], tuple[int, int]]: 'minMaxLoc(src[, mask]) -> minVal, maxVal, minLoc, maxLoc\n. @brief Finds the global minimum and maximum in an array.\n. \n. The function cv::minMaxLoc finds the minimum and maximum element values and their positions. The\n. extremums are searched across the whole array or, if mask is not an empty array, in the specified\n. array region.\n. \n. The function do not work with multi-channel arrays. If you need to find minimum or maximum\n. elements across all the channels, use Mat::reshape first to reinterpret the array as\n. single-channel. Or you may extract the particular channel using either extractImageCOI , or\n. mixChannels , or split .\n. @param src input single-channel array.\n. @param minVal pointer to the returned minimum value; NULL is used if not required.\n. @param maxVal pointer to the returned maximum value; NULL is used if not required.\n. @param minLoc pointer to the returned minimum location (in 2D case); NULL is used if not required.\n. @param maxLoc pointer to the returned maximum location (in 2D case); NULL is used if not required.\n. @param mask optional mask used to select a sub-array.\n. @sa max, min, compare, inRange, extractImageCOI, mixChannels, split, Mat::reshape' ... @@ -3782,7 +3781,7 @@ def reprojectImageTo3D(disparity, Q, _3dImage=..., handleMissingValues=..., ddep ... -def resize(src: ndarray, dsize: typing.Tuple[int, int], dts: ndarray = ..., +def resize(src: ndarray, dsize: tuple[int, int], dts: ndarray = ..., fx: int = ..., fy: int = ..., interpolation: int = ...) -> ndarray: 'resize(src, dsize[, dst[, fx[, fy[, interpolation]]]]) -> dst\n. @brief Resizes an image.\n. \n. The function resize resizes the image src down to or up to the specified size. Note that the\n. initial dst type or size are not taken into account. Instead, the size and type are derived from\n. the `src`,`dsize`,`fx`, and `fy`. If you want to resize src so that it fits the pre-created dst,\n. you may call the function as follows:\n. @code\n. // explicitly specify dsize=dst.size(); fx and fy will be computed from that.\n. resize(src, dst, dst.size(), 0, 0, interpolation);\n. @endcode\n. If you want to decimate the image by factor of 2 in each direction, you can call the function this\n. way:\n. @code\n. // specify fx and fy and let the function compute the destination image size.\n. resize(src, dst, Size(), 0.5, 0.5, interpolation);\n. @endcode\n. To shrink an image, it will generally look best with #INTER_AREA interpolation, whereas to\n. enlarge an image, it will generally look best with c#INTER_CUBIC (slow) or #INTER_LINEAR\n. (faster but still looks OK).\n. \n. @param src input image.\n. @param dst output image; it has the size dsize (when it is non-zero) or the size computed from\n. src.size(), fx, and fy; the type of dst is the same as of src.\n. @param dsize output image size; if it equals zero, it is computed as:\n. \\f[\\texttt{dsize = Size(round(fx*src.cols), round(fy*src.rows))}\\f]\n. Either dsize or both fx and fy must be non-zero.\n. @param fx scale factor along the horizontal axis; when it equals 0, it is computed as\n. \\f[\\texttt{(double)dsize.width/src.cols}\\f]\n. @param fy scale factor along the vertical axis; when it equals 0, it is computed as\n. \\f[\\texttt{(double)dsize.height/src.rows}\\f]\n. @param interpolation interpolation method, see #InterpolationFlags\n. \n. @sa warpAffine, warpPerspective, remap' ... @@ -4189,8 +4188,8 @@ def waitKeyEx(delay=...) -> typing.Any: def warpAffine(src: ndarray, M, - dsize: typing.Tuple[int, - int], + dsize: tuple[int, + int], dts: ndarray = ..., flags: int = ..., borderMode=..., @@ -4201,8 +4200,8 @@ def warpAffine(src: ndarray, def warpPerspective(src: ndarray, M, - dsize: typing.Tuple[int, - int], + dsize: tuple[int, + int], dts: ndarray = ..., flags: int = ..., borderMode=..., @@ -4211,9 +4210,9 @@ def warpPerspective(src: ndarray, ... -def warpPolar(src: ndarray, dsize: typing.Tuple[int, int], center, +def warpPolar(src: ndarray, dsize: tuple[int, int], center, maxRadius, flags: int, dts: ndarray = ...) -> typing.Any: - 'warpPolar(src, dsize: typing.Tuple[int, int], center, maxRadius, flags[, dst]) -> dst\n. \\brief Remaps an image to polar or semilog-polar coordinates space\n. \n. @anchor polar_remaps_reference_image\n. ![Polar remaps reference](pics/polar_remap_doc.png)\n. \n. Transform the source image using the following transformation:\n. \\f[\n. dst(\\rho , \\phi ) = src(x,y)\n. \\f]\n. \n. where\n. \\f[\n. \\begin{array}{l}\n. \\vec{I} = (x - center.x, \\;y - center.y) \\\\\n. \\phi = Kangle \\cdot \\texttt{angle} (\\vec{I}) \\\\\n. \\rho = \\left\\{\\begin{matrix}\n. Klin \\cdot \\texttt{magnitude} (\\vec{I}) & default \\\\\n. Klog \\cdot log_e(\\texttt{magnitude} (\\vec{I})) & if \\; semilog \\\\\n. \\end{matrix}\\right.\n. \\end{array}\n. \\f]\n. \n. and\n. \\f[\n. \\begin{array}{l}\n. Kangle = dsize.height / 2\\Pi \\\\\n. Klin = dsize.width / maxRadius \\\\\n. Klog = dsize.width / log_e(maxRadius) \\\\\n. \\end{array}\n. \\f]\n. \n. \n. \\par Linear vs semilog mapping\n. \n. Polar mapping can be linear or semi-log. Add one of #WarpPolarMode to `flags` to specify the polar mapping mode.\n. \n. Linear is the default mode.\n. \n. The semilog mapping emulates the human "foveal" vision that permit very high acuity on the line of sight (central vision)\n. in contrast to peripheral vision where acuity is minor.\n. \n. \\par Option on `dsize`:\n. \n. - if both values in `dsize <=0 ` (default),\n. the destination image will have (almost) same area of source bounding circle:\n. \\f[\\begin{array}{l}\n. dsize.area \\leftarrow (maxRadius^2 \\cdot \\Pi) \\\\\n. dsize.width = \\texttt{cvRound}(maxRadius) \\\\\n. dsize.height = \\texttt{cvRound}(maxRadius \\cdot \\Pi) \\\\\n. \\end{array}\\f]\n. \n. \n. - if only `dsize.height <= 0`,\n. the destination image area will be proportional to the bounding circle area but scaled by `Kx * Kx`:\n. \\f[\\begin{array}{l}\n. dsize.height = \\texttt{cvRound}(dsize.width \\cdot \\Pi) \\\\\n. \\end{array}\n. \\f]\n. \n. - if both values in `dsize > 0 `,\n. the destination image will have the given size therefore the area of the bounding circle will be scaled to `dsize`.\n. \n. \n. \\par Reverse mapping\n. \n. You can get reverse mapping adding #WARP_INVERSE_MAP to `flags`\n. \\snippet polar_transforms.cpp InverseMap\n. \n. In addiction, to calculate the original coordinate from a polar mapped coordinate \\f$(rho, phi)->(x, y)\\f$:\n. \\snippet polar_transforms.cpp InverseCoordinate\n. \n. @param src Source image.\n. @param dst Destination image. It will have same type as src.\n. @param dsize The destination image size (see description for valid options).\n. @param center The transformation center.\n. @param maxRadius The radius of the bounding circle to transform. It determines the inverse magnitude scale parameter too.\n. @param flags A combination of interpolation methods, #InterpolationFlags + #WarpPolarMode.\n. - Add #WARP_POLAR_LINEAR to select linear polar mapping (default)\n. - Add #WARP_POLAR_LOG to select semilog polar mapping\n. - Add #WARP_INVERSE_MAP for reverse mapping.\n. @note\n. - The function can not operate in-place.\n. - To calculate magnitude and angle in degrees #cartToPolar is used internally thus angles are measured from 0 to 360 with accuracy about 0.3 degrees.\n. - This function uses #remap. Due to current implementation limitations the size of an input and output images should be less than 32767x32767.\n. \n. @sa cv::remap' + 'warpPolar(src, dsize: tuple[int, int], center, maxRadius, flags[, dst]) -> dst\n. \\brief Remaps an image to polar or semilog-polar coordinates space\n. \n. @anchor polar_remaps_reference_image\n. ![Polar remaps reference](pics/polar_remap_doc.png)\n. \n. Transform the source image using the following transformation:\n. \\f[\n. dst(\\rho , \\phi ) = src(x,y)\n. \\f]\n. \n. where\n. \\f[\n. \\begin{array}{l}\n. \\vec{I} = (x - center.x, \\;y - center.y) \\\\\n. \\phi = Kangle \\cdot \\texttt{angle} (\\vec{I}) \\\\\n. \\rho = \\left\\{\\begin{matrix}\n. Klin \\cdot \\texttt{magnitude} (\\vec{I}) & default \\\\\n. Klog \\cdot log_e(\\texttt{magnitude} (\\vec{I})) & if \\; semilog \\\\\n. \\end{matrix}\\right.\n. \\end{array}\n. \\f]\n. \n. and\n. \\f[\n. \\begin{array}{l}\n. Kangle = dsize.height / 2\\Pi \\\\\n. Klin = dsize.width / maxRadius \\\\\n. Klog = dsize.width / log_e(maxRadius) \\\\\n. \\end{array}\n. \\f]\n. \n. \n. \\par Linear vs semilog mapping\n. \n. Polar mapping can be linear or semi-log. Add one of #WarpPolarMode to `flags` to specify the polar mapping mode.\n. \n. Linear is the default mode.\n. \n. The semilog mapping emulates the human "foveal" vision that permit very high acuity on the line of sight (central vision)\n. in contrast to peripheral vision where acuity is minor.\n. \n. \\par Option on `dsize`:\n. \n. - if both values in `dsize <=0 ` (default),\n. the destination image will have (almost) same area of source bounding circle:\n. \\f[\\begin{array}{l}\n. dsize.area \\leftarrow (maxRadius^2 \\cdot \\Pi) \\\\\n. dsize.width = \\texttt{cvRound}(maxRadius) \\\\\n. dsize.height = \\texttt{cvRound}(maxRadius \\cdot \\Pi) \\\\\n. \\end{array}\\f]\n. \n. \n. - if only `dsize.height <= 0`,\n. the destination image area will be proportional to the bounding circle area but scaled by `Kx * Kx`:\n. \\f[\\begin{array}{l}\n. dsize.height = \\texttt{cvRound}(dsize.width \\cdot \\Pi) \\\\\n. \\end{array}\n. \\f]\n. \n. - if both values in `dsize > 0 `,\n. the destination image will have the given size therefore the area of the bounding circle will be scaled to `dsize`.\n. \n. \n. \\par Reverse mapping\n. \n. You can get reverse mapping adding #WARP_INVERSE_MAP to `flags`\n. \\snippet polar_transforms.cpp InverseMap\n. \n. In addiction, to calculate the original coordinate from a polar mapped coordinate \\f$(rho, phi)->(x, y)\\f$:\n. \\snippet polar_transforms.cpp InverseCoordinate\n. \n. @param src Source image.\n. @param dst Destination image. It will have same type as src.\n. @param dsize The destination image size (see description for valid options).\n. @param center The transformation center.\n. @param maxRadius The radius of the bounding circle to transform. It determines the inverse magnitude scale parameter too.\n. @param flags A combination of interpolation methods, #InterpolationFlags + #WarpPolarMode.\n. - Add #WARP_POLAR_LINEAR to select linear polar mapping (default)\n. - Add #WARP_POLAR_LOG to select semilog polar mapping\n. - Add #WARP_INVERSE_MAP for reverse mapping.\n. @note\n. - The function can not operate in-place.\n. - To calculate magnitude and angle in degrees #cartToPolar is used internally thus angles are measured from 0 to 360 with accuracy about 0.3 degrees.\n. - This function uses #remap. Due to current implementation limitations the size of an input and output images should be less than 32767x32767.\n. \n. @sa cv::remap' ... diff --git a/typings/imagehash/__init__.pyi b/typings/imagehash/__init__.pyi index 7abf58bc..91a1d2d7 100644 --- a/typings/imagehash/__init__.pyi +++ b/typings/imagehash/__init__.pyi @@ -1,22 +1,18 @@ -""" +""" # noqa: Y021 This type stub file was generated by pyright. + +https://github.com/JohannesBuchner/imagehash/issues/151 """ -from __future__ import absolute_import, division, print_function +from __future__ import absolute_import, division, print_function, annotations from PIL import Image -__version__: str = ... +__version__: str class ImageHash: def __init__(self, binary_array) -> None: ... - def __str__(self) -> str: - ... - - def __repr__(self) -> str: - ... - def __sub__(self, other: ImageHash) -> int: ... @@ -89,13 +85,7 @@ class ImageMultiHash: def __hash__(self) -> int: ... - def __str__(self) -> str: - ... - - def __repr__(self) -> str: - ... - - def hash_diff(self, other_hash, hamming_cutoff=..., bit_error_rate=...) -> tuple[int, Unknown | int]: + def hash_diff(self, other_hash, hamming_cutoff=..., bit_error_rate=...) -> tuple[int, int]: ... def matches(self, other_hash, region_cutoff=..., hamming_cutoff=..., bit_error_rate=...): diff --git a/typings/keyboard/__init__.pyi b/typings/keyboard/__init__.pyi index ab8aa9dc..a454d39e 100644 --- a/typings/keyboard/__init__.pyi +++ b/typings/keyboard/__init__.pyi @@ -1,24 +1,28 @@ -""" +""" # noqa: Y021 This type stub file was generated by pyright. """ from __future__ import print_function as _print_function from typing import Any, Optional, Union from collections.abc import Callable - from threading import Lock as _Lock +from typing_extensions import TypeAlias + from ._keyboard_event import KEY_DOWN, KEY_UP, KeyboardEvent from ._generic import GenericListener as _GenericListener from ._canonical_names import all_modifiers, normalize_name, sided_modifiers -__all__ = ["all_modifiers", "normalize_name", "sided_modifiers", "KEY_DOWN", "KEY_UP", "KeyboardEvent"] - -__all__ = [ - "KEY_DOWN", - "KEY_UP", - "KeyboardEvent", - "_GenericListener", - "all_modifiers", - "normalize_name", - "sided_modifiers"] +__all__ = ["all_modifiers", + "normalize_name", + "sided_modifiers", + "KEY_DOWN", + "KEY_UP", + "KeyboardEvent", + "KEY_DOWN", + "KEY_UP", + "KeyboardEvent", + "_GenericListener", + "all_modifiers", + "normalize_name", + "sided_modifiers"] try: # Python2 @@ -30,11 +34,11 @@ except NameError: from threading import Event as _UninterruptibleEvent -Callback = Callable[[KeyboardEvent], None] +Callback: TypeAlias = Callable[[KeyboardEvent], None] version: str -_is_str = Callable[[Any], bool] -_is_number = Callable[[Any], bool] +_is_str: Callable[[Any], bool] +_is_number: Callable[[Any], bool] _is_list: Callable[[Any], bool] @@ -61,36 +65,7 @@ _logically_pressed_keys: dict class _KeyboardListener(_GenericListener): - transition_table = { - ('free', KEY_UP, 'modifier'): (False, True, 'free'), - ('free', KEY_DOWN, 'modifier'): (False, False, 'pending'), - ('pending', KEY_UP, 'modifier'): (True, True, 'free'), - ('pending', KEY_DOWN, 'modifier'): (False, True, 'allowed'), - ('suppressed', KEY_UP, 'modifier'): (False, False, 'free'), - ('suppressed', KEY_DOWN, 'modifier'): (False, False, 'suppressed'), - ('allowed', KEY_UP, 'modifier'): (False, True, 'free'), - ('allowed', KEY_DOWN, 'modifier'): (False, True, 'allowed'), - - ('free', KEY_UP, 'hotkey'): (False, None, 'free'), - ('free', KEY_DOWN, 'hotkey'): (False, None, 'free'), - ('pending', KEY_UP, 'hotkey'): (False, None, 'suppressed'), - ('pending', KEY_DOWN, 'hotkey'): (False, None, 'suppressed'), - ('suppressed', KEY_UP, 'hotkey'): (False, None, 'suppressed'), - ('suppressed', KEY_DOWN, 'hotkey'): (False, None, 'suppressed'), - ('allowed', KEY_UP, 'hotkey'): (False, None, 'allowed'), - ('allowed', KEY_DOWN, 'hotkey'): (False, None, 'allowed'), - - ('free', KEY_UP, 'other'): (False, True, 'free'), - ('free', KEY_DOWN, 'other'): (False, True, 'free'), - ('pending', KEY_UP, 'other'): (True, True, 'allowed'), - ('pending', KEY_DOWN, 'other'): (True, True, 'allowed'), - # Necessary when hotkeys are removed after beign triggered, such as - # TestKeyboard.test_add_hotkey_multistep_suppress_modifier. - ('suppressed', KEY_UP, 'other'): (False, False, 'allowed'), - ('suppressed', KEY_DOWN, 'other'): (True, True, 'allowed'), - ('allowed', KEY_UP, 'other'): (False, True, 'allowed'), - ('allowed', KEY_DOWN, 'other'): (False, True, 'allowed'), - } + transition_table = ... def init(self) -> None: ... @@ -112,10 +87,11 @@ def key_to_scan_codes(key: Union[int, str, list[Union[int, str]]], error_if_miss ... -def parse_hotkey(hotkey) -> tuple[ - tuple[tuple[int] | int | tuple[()] | tuple[int, ...]] - | tuple[tuple[tuple[int] | int | tuple[()] | tuple[int, ...], ...]] - | tuple[int, ...]]: +def parse_hotkey(hotkey) -> tuple[Union[ + tuple[Union[tuple[int], int, tuple[()], tuple[int, ...]]], + tuple[tuple[Union[tuple[int], int, tuple[()], tuple[int, ...]], ...]], + tuple[int, ...] +]]: ... @@ -123,7 +99,7 @@ def send(hotkey: Union[str, int], do_press: bool = ..., do_release: bool = ...) ... -press_and_release = send +press_and_release = ... def press(hotkey) -> None: @@ -142,7 +118,7 @@ def call_later(fn, args=..., delay=...) -> None: ... -_hooks: dict[Callable, Unknown] +_hooks: dict[Callable, ...] def hook(callback: Callback, suppress=..., on_remove=...) -> Callable[[], None]: @@ -157,10 +133,11 @@ def on_release(callback: Callback, suppress=...) -> Callable[[], None]: ... -def hook_key(key: Union[int, str, list[Union[int, str]]], - callback: Callback, - suppress: bool = ... - ) -> Callable[[], None]: +def hook_key( + key: Union[int, str, list[Union[int, str]]], + callback: Callback, + suppress: bool = ... +) -> Callable[[], None]: ... @@ -176,7 +153,7 @@ def unhook(remove: Callable[[], None]) -> None: ... -unhook_key = unhook +unhook_key = ... def unhook_all() -> None: @@ -187,58 +164,62 @@ def block_key(key) -> Callable[[], None]: ... -unblock_key = unhook_key +unblock_key = ... def remap_key(src, dst) -> Callable[[], None]: ... -unremap_key = unhook_key +unremap_key = ... -def parse_hotkey_combinations(hotkey) -> tuple[tuple[tuple[Unknown, ...], ...], ...]: +def parse_hotkey_combinations(hotkey) -> tuple[tuple[tuple[..., ...], ...], ...]: ... _hotkeys: dict -def add_hotkey(hotkey, - callback: Callable, - args=..., - suppress=..., - timeout=..., - trigger_on_release=... - ) -> Callable[[], None]: +def add_hotkey( + hotkey, + callback: Callable, + args=..., + suppress=..., + timeout=..., + trigger_on_release=... +) -> Callable[[], None]: ... -register_hotkey = add_hotkey +register_hotkey = ... def remove_hotkey(hotkey_or_callback) -> None: ... -unregister_hotkey = clear_hotkey = remove_hotkey +unregister_hotkey = ... +clear_hotkey = ... def unhook_all_hotkeys() -> None: ... -unregister_all_hotkeys = remove_all_hotkeys = clear_all_hotkeys = unhook_all_hotkeys +unregister_all_hotkeys = ... +remove_all_hotkeys = ... +clear_all_hotkeys = ... def remap_hotkey(src, dst, suppress=..., trigger_on_release=...) -> Callable[[], None]: ... -unremap_hotkey = remove_hotkey +unremap_hotkey = ... -def stash_state() -> list[Unknown]: +def stash_state() -> list: ... @@ -278,18 +259,18 @@ def get_typed_strings(events, allow_backspace=...): ... -_recording: Optional[tuple[Unknown | _queue.Queue[Unknown], Callable[[], None]]] +_recording: Optional[tuple[_queue.Queue, Callable[[], None]]] -def start_recording(recorded_events_queue=...) -> tuple[Unknown | _queue.Queue[Unknown], Callable[[], None]]: +def start_recording(recorded_events_queue=...) -> tuple[_queue.Queue, Callable[[], None]]: ... -def stop_recording() -> list[Unknown | Any]: +def stop_recording() -> list[Any]: ... -def record(until=..., suppress=..., trigger_on_release=...) -> list[Unknown | Any]: +def record(until=..., suppress=..., trigger_on_release=...) -> list[Any]: ... @@ -297,7 +278,7 @@ def play(events, speed_factor=...): ... -replay = play +replay = ... _word_listeners: dict @@ -315,14 +296,15 @@ def remove_word_listener(word_or_handler) -> None: ... -def add_abbreviation(source_text, - replacement_text, - match_suffix=..., - timeout=... - ) -> Callable[[], None]: +def add_abbreviation( + source_text, + replacement_text, + match_suffix=..., + timeout=... +) -> Callable[[], None]: ... -register_word_listener = add_word_listener -register_abbreviation = add_abbreviation -remove_abbreviation = remove_word_listener +register_word_listener = ... +register_abbreviation = ... +remove_abbreviation = ... diff --git a/typings/keyboard/_canonical_names.pyi b/typings/keyboard/_canonical_names.pyi index 0f933132..2c8ad6d3 100644 --- a/typings/keyboard/_canonical_names.pyi +++ b/typings/keyboard/_canonical_names.pyi @@ -1,4 +1,4 @@ -""" +""" # noqa: Y021 This type stub file was generated by pyright. """ diff --git a/typings/keyboard/_generic.pyi b/typings/keyboard/_generic.pyi index 9411e0f7..57d423b2 100644 --- a/typings/keyboard/_generic.pyi +++ b/typings/keyboard/_generic.pyi @@ -1,4 +1,4 @@ -""" +""" # noqa: Y021 This type stub file was generated by pyright. """ diff --git a/typings/keyboard/_keyboard_event.pyi b/typings/keyboard/_keyboard_event.pyi index 65bb2214..28401869 100644 --- a/typings/keyboard/_keyboard_event.pyi +++ b/typings/keyboard/_keyboard_event.pyi @@ -1,21 +1,17 @@ -""" +""" # noqa: Y021 This type stub file was generated by pyright. """ - -from typing import Literal, Optional, Union - - -KEY_DOWN = Literal['down'] -KEY_UP = Literal['up'] +from __future__ import annotations +from typing import Literal, Optional class KeyboardEvent: - event_type: Optional[Union[KEY_DOWN, KEY_UP]] = ... + event_type: Optional[Literal['down', 'up']] = ... scan_code: Optional[int] = ... name: Optional[str] = ... - time: Optional[Unknown] = ... - device: Optional[Unknown] = ... - modifiers: Optional[Unknown] = ... + time: Optional[float] = ... + device: Optional = ... + modifiers: Optional[tuple] = ... is_keypad: Optional[bool] = ... def __init__(self, @@ -32,8 +28,5 @@ class KeyboardEvent: def to_json(self, ensure_ascii: bool = ...) -> str: ... - def __repr__(self) -> str: - ... - def __eq__(self, other: KeyboardEvent) -> bool: ... diff --git a/typings/pyautogui/__init__.pyi b/typings/pyautogui/__init__.pyi index a4252aad..c5382357 100644 --- a/typings/pyautogui/__init__.pyi +++ b/typings/pyautogui/__init__.pyi @@ -1,4 +1,4 @@ -""" +""" # noqa: Y021 This type stub file was generated by pyright. """ @@ -7,8 +7,10 @@ import sys import datetime from collections.abc import Callable from contextlib import contextmanager +from typing import Union, Literal +from typing_extensions import TypeAlias -__version__: str = ... +__version__: str class PyAutoGUIException(Exception): @@ -27,12 +29,12 @@ if sys.version_info[0] == 2 or sys.version_info[0:2] in ((3, 1), (3, 2)): # noq # Python 2 and 3.1 and 3.2 uses collections.Sequence import collections - collectionsSequence = collections.Sequence + collectionsSequence: TypeAlias = collections.Sequence else: # Python 3.3+ uses collections.abc.Sequence import collections.abc - collectionsSequence = collections.abc.Sequence # type: ignore + collectionsSequence: TypeAlias = collections.abc.Sequence # type: ignore def raisePyAutoGUIImageNotFoundException(wrappedFunction) -> Callable: @@ -62,7 +64,7 @@ MINIMUM_DURATION = ... MINIMUM_SLEEP = ... PAUSE = ... DARWIN_CATCH_UP_TIME = ... -FAILSAFE = bool +FAILSAFE: bool FAILSAFE_POINTS = ... LOG_SCREENSHOTS = ... LOG_SCREENSHOTS_LIMIT = ... @@ -71,7 +73,7 @@ Point = ... Size = ... -def getPointOnLine(x1, y1, x2, y2, n) -> tuple[Unknown, Unknown]: +def getPointOnLine(x1, y1, x2, y2, n) -> tuple: ... @@ -91,6 +93,10 @@ def onScreen(x, y=...) -> bool: ... +def _genericPyAutoGUIChecks(wrappedFunction): + ... + + @_genericPyAutoGUIChecks def mouseDown(x=..., y=..., button=..., duration=..., tween=..., logScreenshot=..., _pause=...) -> None: ... diff --git a/typings/win32-stubs/win32gui.pyi b/typings/win32-stubs/win32gui.pyi index f3a81231..1d07ecb4 100644 --- a/typings/win32-stubs/win32gui.pyi +++ b/typings/win32-stubs/win32gui.pyi @@ -410,7 +410,7 @@ Returns: typing.Any """ - pass + ... def set_logger(logger: 'typing.Any') -> 'None': @@ -426,7 +426,7 @@ Returns: None """ - pass + ... def LOGFONT() -> 'win32typing.PyLOGFONT': @@ -442,7 +442,7 @@ Returns: win32typing.PyLOGFONT """ - pass + ... def CreateFontIndirect(lplf: 'win32typing.PyLOGFONT') -> 'typing.Any': @@ -460,7 +460,7 @@ Returns: typing.Any """ - pass + ... def GetObject(handle: 'int') -> 'typing.Any': @@ -476,7 +476,7 @@ Returns: typing.Any """ - pass + ... def GetObjectType(h: 'int') -> 'typing.Any': @@ -492,7 +492,7 @@ Returns: typing.Any """ - pass + ... def PyGetMemory(addr: 'typing.Any', _len: 'typing.Any') -> 'typing.Any': @@ -509,7 +509,7 @@ Returns: typing.Any """ - pass + ... def PyGetString(addr: 'typing.Any', _len: 'typing.Any') -> 'str': @@ -529,7 +529,7 @@ string must be NULL terminated.Return ValueIf win32gui.UNICODE is True, this wil """ - pass + ... def PySetString(addr: 'typing.Any', String: 'typing.Any', maxLen: 'typing.Any') -> 'typing.Any': @@ -547,7 +547,7 @@ Returns: typing.Any """ - pass + ... def PySetMemory(addr: 'typing.Any', String: 'typing.Any') -> 'typing.Any': @@ -564,7 +564,7 @@ Returns: typing.Any """ - pass + ... def PyGetArraySignedLong(array: 'typing.Any', index: 'typing.Any') -> 'typing.Any': @@ -581,7 +581,7 @@ Returns: typing.Any """ - pass + ... def PyGetBufferAddressAndLen(obj: 'typing.Any') -> 'typing.Any': @@ -597,7 +597,7 @@ Returns: typing.Any """ - pass + ... def FlashWindow(hwnd: 'int', bInvert: 'typing.Any') -> 'typing.Any': @@ -614,7 +614,7 @@ Returns: typing.Any """ - pass + ... def FlashWindowEx(hwnd: 'int', dwFlags: 'typing.Any', uCount: 'typing.Any', dwTimeout: 'typing.Any') -> 'typing.Any': @@ -633,7 +633,7 @@ Returns: typing.Any """ - pass + ... def GetWindowLong(hwnd: 'int', index: 'typing.Any') -> 'typing.Any': @@ -650,7 +650,7 @@ Returns: typing.Any """ - pass + ... def GetClassLong(hwnd: 'int', index: 'typing.Any') -> 'typing.Any': @@ -667,7 +667,7 @@ Returns: typing.Any """ - pass + ... def SetWindowLong(hwnd: 'int', index: 'typing.Any', value: 'typing.Any') -> 'typing.Any': @@ -685,7 +685,7 @@ Returns: typing.Any """ - pass + ... def CallWindowProc( @@ -710,7 +710,7 @@ Returns: typing.Any """ - pass + ... def SendMessage( @@ -733,7 +733,7 @@ Returns: typing.Any """ - pass + ... def SendMessageTimeout( @@ -765,7 +765,7 @@ with zero as the error code. See the Microsoft documentation for more informati """ - pass + ... def PostMessage(hwnd: 'int', message: 'typing.Any', wparam: 'typing.Any' = 0, lparam: 'typing.Any' = 0) -> 'None': @@ -784,7 +784,7 @@ Returns: None """ - pass + ... def PostThreadMessage( @@ -807,7 +807,7 @@ Returns: None """ - pass + ... def ReplyMessage(result: 'typing.Any') -> 'typing.Any': @@ -823,7 +823,7 @@ Returns: typing.Any """ - pass + ... def RegisterWindowMessage(name: 'typing.Union[str, typing.Any]') -> 'typing.Any': @@ -839,7 +839,7 @@ Returns: typing.Any """ - pass + ... def DefWindowProc(hwnd: 'int', message: 'typing.Any', wparam: 'typing.Any', lparam: 'typing.Any') -> 'typing.Any': @@ -858,7 +858,7 @@ Returns: typing.Any """ - pass + ... def EnumWindows(callback: 'typing.Any', extra: 'typing.Any') -> 'None': @@ -875,7 +875,7 @@ Returns: None """ - pass + ... def EnumThreadWindows(dwThreadId: 'typing.Any', callback: 'typing.Any', extra: 'typing.Any') -> 'None': @@ -893,7 +893,7 @@ Returns: None """ - pass + ... def EnumChildWindows(hwnd: 'int', callback: 'typing.Any', extra: 'typing.Any') -> 'None': @@ -911,7 +911,7 @@ Returns: None """ - pass + ... def DialogBox( @@ -936,7 +936,7 @@ Returns: typing.Any """ - pass + ... def DialogBoxParam() -> 'typing.Any': @@ -952,7 +952,7 @@ Returns: typing.Any """ - pass + ... def DialogBoxIndirect( @@ -977,7 +977,7 @@ Returns: typing.Any """ - pass + ... def DialogBoxIndirectParam() -> 'typing.Any': @@ -993,7 +993,7 @@ Returns: typing.Any """ - pass + ... def CreateDialogIndirect( @@ -1018,7 +1018,7 @@ Returns: typing.Any """ - pass + ... def EndDialog(hwnd: 'int', result: 'typing.Any') -> 'None': @@ -1035,7 +1035,7 @@ Returns: None """ - pass + ... def GetDlgItem(hDlg: 'int', IDDlgItem: 'typing.Any') -> 'typing.Any': @@ -1052,7 +1052,7 @@ Returns: typing.Any """ - pass + ... def GetDlgItemInt(hDlg: 'int', IDDlgItem: 'typing.Any', Signed: 'typing.Any') -> 'None': @@ -1070,7 +1070,7 @@ Returns: None """ - pass + ... def SetDlgItemInt(hDlg: 'int', IDDlgItem: 'typing.Any', Value: 'typing.Any', Signed: 'typing.Any') -> 'None': @@ -1089,7 +1089,7 @@ Returns: None """ - pass + ... def GetDlgCtrlID(hwnd: 'int') -> 'typing.Any': @@ -1105,7 +1105,7 @@ Returns: typing.Any """ - pass + ... def GetDlgItemText(hDlg: 'int', IDDlgItem: 'typing.Any') -> 'str': @@ -1122,7 +1122,7 @@ Returns: str """ - pass + ... def SetDlgItemText(hDlg: 'int', IDDlgItem: 'typing.Any', String: 'typing.Union[typing.Any]') -> 'None': @@ -1140,7 +1140,7 @@ Returns: None """ - pass + ... def GetNextDlgTabItem(hDlg: 'typing.Any', hCtl: 'typing.Any', bPrevious: 'typing.Any') -> 'typing.Any': @@ -1158,7 +1158,7 @@ Returns: typing.Any """ - pass + ... def GetNextDlgGroupItem(hDlg: 'typing.Any', hCtl: 'typing.Any', bPrevious: 'typing.Any') -> 'typing.Any': @@ -1176,7 +1176,7 @@ Returns: typing.Any """ - pass + ... def SetWindowText() -> 'None': @@ -1192,7 +1192,7 @@ Returns: None """ - pass + ... def GetWindowText(hwnd: 'int') -> 'str': @@ -1208,7 +1208,7 @@ Returns: str """ - pass + ... def InitCommonControls() -> 'None': @@ -1224,7 +1224,7 @@ Returns: None """ - pass + ... def InitCommonControlsEx(flag: 'typing.Any') -> 'None': @@ -1240,7 +1240,7 @@ Returns: None """ - pass + ... def LoadCursor(hinstance: 'typing.Any', resid: 'typing.Any') -> 'typing.Any': @@ -1257,7 +1257,7 @@ Returns: typing.Any """ - pass + ... def SetCursor(hcursor: 'typing.Any') -> 'typing.Any': @@ -1273,7 +1273,7 @@ Returns: typing.Any """ - pass + ... def GetCursor() -> 'typing.Any': @@ -1289,7 +1289,7 @@ Returns: typing.Any """ - pass + ... def GetCursorInfo() -> 'tuple[int, int, int, int]': @@ -1305,7 +1305,7 @@ Returns: tuple[int, int, int, int] """ - pass + ... def CreateAcceleratorTable(accels: 'tuple[tuple[typing.Any, typing.Any, typing.Any], ...]') -> 'typing.Any': @@ -1321,7 +1321,7 @@ Returns: typing.Any """ - pass + ... def DestroyAccleratorTable(haccel: 'typing.Any') -> 'None': @@ -1337,7 +1337,7 @@ Returns: None """ - pass + ... def LoadMenu(hinstance: 'typing.Any', resource_id: 'typing.Union[str, typing.Any]') -> 'typing.Any': @@ -1354,7 +1354,7 @@ Returns: typing.Any """ - pass + ... def DestroyMenu() -> 'None': @@ -1370,7 +1370,7 @@ Returns: None """ - pass + ... def SetMenu(hwnd: 'int', hmenu: 'typing.Any') -> 'None': @@ -1387,7 +1387,7 @@ Returns: None """ - pass + ... def GetMenu() -> 'None': @@ -1403,7 +1403,7 @@ Returns: None """ - pass + ... def LoadIcon(hinstance: 'typing.Any', resource_id: 'typing.Union[str, typing.Any]') -> 'typing.Any': @@ -1420,7 +1420,7 @@ Returns: typing.Any """ - pass + ... def CopyIcon(hicon: 'typing.Any') -> 'typing.Any': @@ -1436,7 +1436,7 @@ Returns: typing.Any """ - pass + ... def DrawIcon(hDC: 'typing.Any', X: 'typing.Any', Y: 'typing.Any', hicon: 'typing.Any') -> 'None': @@ -1455,7 +1455,7 @@ Returns: None """ - pass + ... def DrawIconEx( @@ -1492,7 +1492,7 @@ Returns: None """ - pass + ... def CreateIconIndirect(iconinfo: 'win32typing.PyICONINFO') -> 'typing.Any': @@ -1508,7 +1508,7 @@ Returns: typing.Any """ - pass + ... def CreateIconFromResource(bits: 'str', fIcon: 'typing.Any', ver: 'typing.Any' = 0x00030000) -> 'int': @@ -1526,7 +1526,7 @@ Returns: int """ - pass + ... def LoadImage( @@ -1553,7 +1553,7 @@ Returns: typing.Any """ - pass + ... def DeleteObject(handle: 'win32typing.PyGdiHANDLE') -> 'None': @@ -1569,7 +1569,7 @@ Returns: None """ - pass + ... def BitBlt( @@ -1606,7 +1606,7 @@ Returns: None """ - pass + ... def StretchBlt( @@ -1647,7 +1647,7 @@ Returns: None """ - pass + ... def PatBlt( @@ -1674,7 +1674,7 @@ Returns: None """ - pass + ... def SetStretchBltMode(hdc: 'int', StretchMode: 'typing.Any') -> 'typing.Any': @@ -1694,7 +1694,7 @@ If the function fails, the return value is zero. """ - pass + ... def GetStretchBltMode(hdc: 'int') -> 'typing.Any': @@ -1711,7 +1711,7 @@ Returns: """ - pass + ... def TransparentBlt( @@ -1748,7 +1748,7 @@ Returns: None """ - pass + ... def MaskBlt( @@ -1789,7 +1789,7 @@ Returns: None """ - pass + ... def AlphaBlend( @@ -1826,7 +1826,7 @@ Returns: None """ - pass + ... def ImageList_Add(himl: 'typing.Any', hbmImage: 'win32typing.PyGdiHANDLE', @@ -1846,7 +1846,7 @@ Returns: """ - pass + ... def ImageList_Create() -> 'typing.Any': @@ -1862,7 +1862,7 @@ Returns: typing.Any """ - pass + ... def ImageList_Destroy() -> 'typing.Any': @@ -1878,7 +1878,7 @@ Returns: typing.Any """ - pass + ... def ImageList_Draw() -> 'typing.Any': @@ -1894,7 +1894,7 @@ Returns: typing.Any """ - pass + ... def ImageList_DrawEx() -> 'typing.Any': @@ -1910,7 +1910,7 @@ Returns: typing.Any """ - pass + ... def ImageList_GetIcon() -> 'typing.Any': @@ -1926,7 +1926,7 @@ Returns: typing.Any """ - pass + ... def ImageList_GetImageCount() -> 'typing.Any': @@ -1942,7 +1942,7 @@ Returns: typing.Any """ - pass + ... def ImageList_LoadImage() -> 'typing.Any': @@ -1958,7 +1958,7 @@ Returns: typing.Any """ - pass + ... def ImageList_LoadBitmap() -> 'typing.Any': @@ -1974,7 +1974,7 @@ Returns: typing.Any """ - pass + ... def ImageList_Remove() -> 'typing.Any': @@ -1990,7 +1990,7 @@ Returns: typing.Any """ - pass + ... def ImageList_Replace() -> 'typing.Any': @@ -2006,7 +2006,7 @@ Returns: typing.Any """ - pass + ... def ImageList_ReplaceIcon() -> 'typing.Any': @@ -2022,7 +2022,7 @@ Returns: typing.Any """ - pass + ... def ImageList_SetBkColor() -> 'typing.Any': @@ -2038,7 +2038,7 @@ Returns: typing.Any """ - pass + ... def ImageList_SetOverlayImage(hImageList: 'typing.Any', iImage: 'typing.Any', iOverlay: 'typing.Any') -> 'None': @@ -2056,7 +2056,7 @@ Returns: None """ - pass + ... def MessageBox( @@ -2079,7 +2079,7 @@ Returns: typing.Any """ - pass + ... def MessageBeep(_type: 'typing.Any') -> 'None': @@ -2095,7 +2095,7 @@ Returns: None """ - pass + ... def CreateWindow( @@ -2132,7 +2132,7 @@ Returns: typing.Any """ - pass + ... def DestroyWindow(hwnd: 'int') -> 'None': @@ -2148,7 +2148,7 @@ Returns: None """ - pass + ... def EnableWindow(hWnd: 'int', bEnable: 'typing.Any') -> 'typing.Any': @@ -2166,7 +2166,7 @@ Returns: """ - pass + ... def FindWindow(ClassName: 'win32typing.PyResourceId', WindowName: 'str') -> 'int': @@ -2183,7 +2183,7 @@ Returns: int """ - pass + ... def FindWindowEx(Parent: 'int', ChildAfter: 'int', ClassName: 'win32typing.PyResourceId', WindowName: 'str') -> 'int': @@ -2202,7 +2202,7 @@ Returns: int """ - pass + ... def DragAcceptFiles(hwnd: 'int', fAccept: 'typing.Any') -> 'None': @@ -2219,7 +2219,7 @@ Returns: None """ - pass + ... def DragDetect(hwnd: 'int', point: 'tuple[typing.Any, typing.Any]') -> 'None': @@ -2239,7 +2239,7 @@ If the user did not move the mouse outside of the drag rectangle while holding d """ - pass + ... def SetDoubleClickTime(newVal: 'typing.Any') -> 'None': @@ -2255,7 +2255,7 @@ Returns: None """ - pass + ... def GetDoubleClickTime() -> 'typing.Any': @@ -2271,7 +2271,7 @@ Returns: typing.Any """ - pass + ... def HideCaret(hWnd: 'int') -> 'None': @@ -2287,7 +2287,7 @@ Returns: None """ - pass + ... def SetCaretPos(x: 'typing.Any', y: 'typing.Any') -> 'None': @@ -2304,7 +2304,7 @@ Returns: None """ - pass + ... def GetCaretPos() -> 'tuple[typing.Any, typing.Any]': @@ -2320,7 +2320,7 @@ Returns: tuple[typing.Any, typing.Any] """ - pass + ... def ShowCaret(hWnd: 'int') -> 'None': @@ -2336,7 +2336,7 @@ Returns: None """ - pass + ... def ShowWindow(hWnd: 'typing.Any', cmdShow: 'typing.Any') -> 'typing.Any': @@ -2353,7 +2353,7 @@ Returns: typing.Any """ - pass + ... def IsWindowVisible(hwnd: 'int') -> 'typing.Any': @@ -2369,7 +2369,7 @@ Returns: typing.Any """ - pass + ... def IsWindowEnabled(hwnd: 'int') -> 'typing.Any': @@ -2385,7 +2385,7 @@ Returns: typing.Any """ - pass + ... def SetFocus(hwnd: 'int') -> 'None': @@ -2401,7 +2401,7 @@ Returns: None """ - pass + ... def GetFocus() -> 'None': @@ -2417,7 +2417,7 @@ Returns: None """ - pass + ... def UpdateWindow(hwnd: 'int') -> 'None': @@ -2433,7 +2433,7 @@ Returns: None """ - pass + ... def BringWindowToTop(hwnd: 'int') -> 'None': @@ -2449,7 +2449,7 @@ Returns: None """ - pass + ... def SetActiveWindow(hwnd: 'int') -> 'typing.Any': @@ -2465,7 +2465,7 @@ Returns: typing.Any """ - pass + ... def GetActiveWindow() -> 'typing.Any': @@ -2481,7 +2481,7 @@ Returns: typing.Any """ - pass + ... def SetForegroundWindow(hwnd: 'int') -> 'typing.Any': @@ -2497,7 +2497,7 @@ Returns: typing.Any """ - pass + ... def GetForegroundWindow() -> 'typing.Any': @@ -2513,7 +2513,7 @@ Returns: typing.Any """ - pass + ... def GetClientRect(hwnd: 'int') -> 'tuple[int, int, int, int]': @@ -2529,7 +2529,7 @@ Returns: tuple[int, int, int, int] """ - pass + ... def GetDC(hwnd: 'int') -> 'typing.Any': @@ -2545,7 +2545,7 @@ Returns: typing.Any """ - pass + ... def SaveDC(hdc: 'int') -> 'typing.Any': @@ -2562,7 +2562,7 @@ Returns: """ - pass + ... def RestoreDC(hdc: 'int', SavedDC: 'typing.Any') -> 'None': @@ -2579,7 +2579,7 @@ Returns: None """ - pass + ... def DeleteDC(hdc: 'typing.Any') -> 'None': @@ -2595,7 +2595,7 @@ Returns: None """ - pass + ... def CreateCompatibleDC(dc: 'typing.Any') -> 'typing.Any': @@ -2611,7 +2611,7 @@ Returns: typing.Any """ - pass + ... def CreateCompatibleBitmap(hdc: 'typing.Any', width: 'typing.Any', height: 'typing.Any') -> 'win32typing.PyGdiHANDLE': @@ -2629,7 +2629,7 @@ Returns: win32typing.PyGdiHANDLE """ - pass + ... def CreateBitmap( @@ -2654,7 +2654,7 @@ Returns: win32typing.PyGdiHANDLE """ - pass + ... def SelectObject(hdc: 'typing.Any', _object: 'typing.Any') -> 'typing.Any': @@ -2671,7 +2671,7 @@ Returns: typing.Any """ - pass + ... def GetCurrentObject(hdc: 'int', ObjectType: 'typing.Any') -> 'int': @@ -2688,7 +2688,7 @@ Returns: int """ - pass + ... def GetWindowRect(hwnd: 'int') -> 'tuple[int, int, int, int]': @@ -2704,7 +2704,7 @@ Returns: tuple[int, int, int, int] """ - pass + ... def GetStockObject(Object: 'typing.Any') -> 'int': @@ -2720,7 +2720,7 @@ Returns: int """ - pass + ... def PostQuitMessage(rc: 'typing.Any') -> 'None': @@ -2736,7 +2736,7 @@ Returns: None """ - pass + ... def WaitMessage() -> 'None': @@ -2752,7 +2752,7 @@ Returns: None """ - pass + ... def SetWindowPos( @@ -2781,7 +2781,7 @@ Returns: None """ - pass + ... def GetWindowPlacement() -> 'typing.Any': @@ -2818,7 +2818,7 @@ normalposSpecifies the window's coordinates when the window is in the restored p """ - pass + ... def SetWindowPlacement(hWnd: 'int', placement: 'typing.Any') -> 'None': @@ -2835,7 +2835,7 @@ Returns: None """ - pass + ... def RegisterClass(wndClass: 'win32typing.PyWNDCLASS') -> 'typing.Any': @@ -2851,7 +2851,7 @@ Returns: typing.Any """ - pass + ... def UnregisterClass(atom: 'win32typing.PyResourceId', hinst: 'int') -> 'None': @@ -2868,7 +2868,7 @@ Returns: None """ - pass + ... def PumpMessages() -> 'None': @@ -2886,7 +2886,7 @@ Return ValueReturns exit code from PostQuitMessage when a WM_QUIT message is rec """ - pass + ... def PumpWaitingMessages() -> 'typing.Any': @@ -2904,7 +2904,7 @@ Return ValueReturns non-zero (exit code from PostQuitMessage) if a WM_QUIT messa """ - pass + ... def GetMessage(hwnd: 'int', _min: 'typing.Any', _max: 'typing.Any') -> 'typing.Any': @@ -2922,7 +2922,7 @@ Returns: typing.Any """ - pass + ... def TranslateMessage(msg: 'typing.Any') -> 'typing.Any': @@ -2938,7 +2938,7 @@ Returns: typing.Any """ - pass + ... def DispatchMessage(msg: 'typing.Any') -> 'typing.Any': @@ -2954,7 +2954,7 @@ Returns: typing.Any """ - pass + ... def TranslateAccelerator(hwnd: 'int', haccel: 'typing.Any', msg: 'typing.Any') -> 'typing.Any': @@ -2972,7 +2972,7 @@ Returns: typing.Any """ - pass + ... def PeekMessage( @@ -2995,7 +2995,7 @@ Returns: typing.Any """ - pass + ... def Shell_NotifyIcon(Message: 'typing.Any', nid: 'win32typing.PyNOTIFYICONDATA') -> 'None': @@ -3012,7 +3012,7 @@ Returns: None """ - pass + ... def GetSystemMenu(hwnd: 'int', bRevert: 'typing.Any') -> 'typing.Any': @@ -3030,7 +3030,7 @@ Returns: """ - pass + ... def DrawMenuBar(hwnd: 'int') -> 'None': @@ -3046,7 +3046,7 @@ Returns: None """ - pass + ... def MoveWindow( @@ -3073,7 +3073,7 @@ Returns: None """ - pass + ... def CloseWindow() -> 'None': @@ -3089,7 +3089,7 @@ Returns: None """ - pass + ... def DeleteMenu(hmenu: 'typing.Any', position: 'typing.Any', flags: 'typing.Any') -> 'None': @@ -3107,7 +3107,7 @@ Returns: None """ - pass + ... def RemoveMenu(hmenu: 'typing.Any', position: 'typing.Any', flags: 'typing.Any') -> 'None': @@ -3125,7 +3125,7 @@ Returns: None """ - pass + ... def CreateMenu() -> 'typing.Any': @@ -3145,7 +3145,7 @@ Return ValueThe result is a HMENU to the new menu. """ - pass + ... def CreatePopupMenu() -> 'typing.Any': @@ -3165,7 +3165,7 @@ Return ValueThe result is a HMENU to the new menu. """ - pass + ... def TrackPopupMenu( @@ -3194,7 +3194,7 @@ Returns: typing.Any """ - pass + ... def CommDlgExtendedError() -> 'typing.Any': @@ -3210,7 +3210,7 @@ Returns: typing.Any """ - pass + ... def ExtractIcon(hinstance: 'typing.Any', moduleName: 'typing.Union[str]', index: 'typing.Any') -> 'typing.Any': @@ -3232,7 +3232,7 @@ Return ValueThe result is a HICON. """ - pass + ... def ExtractIconEx(moduleName: 'str', index: 'typing.Any', numIcons: 'typing.Any' = 1) -> 'typing.Any': @@ -3257,7 +3257,7 @@ the file, otherwise it is 2 arrays of icon handles. """ - pass + ... def DestroyIcon(hicon: 'typing.Any') -> 'None': @@ -3273,7 +3273,7 @@ Returns: None """ - pass + ... def GetIconInfo(hicon: 'int') -> 'win32typing.PyICONINFO': @@ -3292,7 +3292,7 @@ The hbmMask and hbmColor items are bitmaps created for the caller, so must be fr """ - pass + ... def ScreenToClient(hWnd: 'int', Point: 'tuple[typing.Any, typing.Any]') -> 'tuple[typing.Any, typing.Any]': @@ -3309,7 +3309,7 @@ Returns: tuple[typing.Any, typing.Any] """ - pass + ... def ClientToScreen(hWnd: 'int', Point: 'tuple[typing.Any, typing.Any]') -> 'tuple[typing.Any, typing.Any]': @@ -3326,7 +3326,7 @@ Returns: tuple[typing.Any, typing.Any] """ - pass + ... def PaintDesktop(hdc: 'int') -> 'None': @@ -3342,7 +3342,7 @@ Returns: None """ - pass + ... def RedrawWindow( @@ -3365,7 +3365,7 @@ Returns: None """ - pass + ... def GetTextExtentPoint32(hdc: 'int', _str: 'str') -> 'tuple[typing.Any, typing.Any]': @@ -3382,7 +3382,7 @@ Returns: tuple[typing.Any, typing.Any] """ - pass + ... def GetTextMetrics() -> 'typing.Any': @@ -3398,7 +3398,7 @@ Returns: typing.Any """ - pass + ... def GetTextCharacterExtra(hdc: 'int') -> 'typing.Any': @@ -3414,7 +3414,7 @@ Returns: typing.Any """ - pass + ... def SetTextCharacterExtra(hdc: 'int', CharExtra: 'typing.Any') -> 'typing.Any': @@ -3432,7 +3432,7 @@ Returns: """ - pass + ... def GetTextAlign(hdc: 'int') -> 'typing.Any': @@ -3449,7 +3449,7 @@ Returns: """ - pass + ... def SetTextAlign(hdc: 'int', Mode: 'typing.Any') -> 'typing.Any': @@ -3467,7 +3467,7 @@ Returns: """ - pass + ... def GetTextFace(hdc: 'int') -> 'str': @@ -3483,7 +3483,7 @@ Returns: str """ - pass + ... def GetMapMode(hdc: 'int') -> 'typing.Any': @@ -3500,7 +3500,7 @@ Returns: """ - pass + ... def SetMapMode(hdc: 'int', MapMode: 'typing.Any') -> 'typing.Any': @@ -3518,7 +3518,7 @@ Returns: """ - pass + ... def GetGraphicsMode(hdc: 'int') -> 'typing.Any': @@ -3535,7 +3535,7 @@ Returns: """ - pass + ... def SetGraphicsMode(hdc: 'int', Mode: 'typing.Any') -> 'typing.Any': @@ -3553,7 +3553,7 @@ Returns: """ - pass + ... def GetLayout(hdc: 'int') -> 'typing.Any': @@ -3570,7 +3570,7 @@ Returns: """ - pass + ... def SetLayout(hdc: 'int', Layout: 'typing.Any') -> 'typing.Any': @@ -3588,7 +3588,7 @@ Returns: """ - pass + ... def GetPolyFillMode(hdc: 'int') -> 'typing.Any': @@ -3605,7 +3605,7 @@ Returns: """ - pass + ... def SetPolyFillMode(hdc: 'int', PolyFillMode: 'typing.Any') -> 'typing.Any': @@ -3623,7 +3623,7 @@ Returns: """ - pass + ... def GetWorldTransform(hdc: 'int') -> 'win32typing.PyXFORM': @@ -3639,7 +3639,7 @@ Returns: win32typing.PyXFORM """ - pass + ... def SetWorldTransform(hdc: 'int', Xform: 'win32typing.PyXFORM') -> 'None': @@ -3656,7 +3656,7 @@ Returns: None """ - pass + ... def ModifyWorldTransform(hdc: 'int', Xform: 'win32typing.PyXFORM', Mode: 'typing.Any') -> 'None': @@ -3674,7 +3674,7 @@ Returns: None """ - pass + ... def CombineTransform(xform1: 'win32typing.PyXFORM', xform2: 'win32typing.PyXFORM') -> 'win32typing.PyXFORM': @@ -3691,7 +3691,7 @@ Returns: win32typing.PyXFORM """ - pass + ... def GetWindowOrgEx(hdc: 'int') -> 'tuple[typing.Any, typing.Any]': @@ -3707,7 +3707,7 @@ Returns: tuple[typing.Any, typing.Any] """ - pass + ... def SetWindowOrgEx(hdc: 'int', X: 'typing.Any', Y: 'typing.Any') -> 'tuple[typing.Any, typing.Any]': @@ -3726,7 +3726,7 @@ Returns: """ - pass + ... def GetViewportOrgEx(hdc: 'int') -> 'tuple[typing.Any, typing.Any]': @@ -3742,7 +3742,7 @@ Returns: tuple[typing.Any, typing.Any] """ - pass + ... def SetViewportOrgEx(hdc: 'int', X: 'typing.Any', Y: 'typing.Any') -> 'tuple[typing.Any, typing.Any]': @@ -3761,7 +3761,7 @@ Returns: """ - pass + ... def GetWindowExtEx(hdc: 'int') -> 'tuple[typing.Any, typing.Any]': @@ -3778,7 +3778,7 @@ Returns: """ - pass + ... def SetWindowExtEx(hdc: 'int', XExtent: 'typing.Any', YExtent: 'typing.Any') -> 'tuple[typing.Any, typing.Any]': @@ -3797,7 +3797,7 @@ Returns: """ - pass + ... def GetViewportExtEx(hdc: 'int') -> 'tuple[typing.Any, typing.Any]': @@ -3814,7 +3814,7 @@ Returns: """ - pass + ... def SetViewportExtEx(hdc: 'int', XExtent: 'typing.Any', YExtent: 'typing.Any') -> 'tuple[typing.Any, typing.Any]': @@ -3833,7 +3833,7 @@ Returns: """ - pass + ... def GradientFill( @@ -3856,7 +3856,7 @@ Returns: None """ - pass + ... def GetOpenFileName(OPENFILENAME: 'typing.Union[str, typing.Any]') -> 'typing.Any': @@ -3878,7 +3878,7 @@ Return ValueIf the user presses OK, the function returns TRUE. Otherwise, use C """ - pass + ... def InsertMenuItem( @@ -3901,7 +3901,7 @@ Returns: None """ - pass + ... def SetMenuItemInfo( @@ -3924,7 +3924,7 @@ Returns: None """ - pass + ... def GetMenuItemInfo( @@ -3947,7 +3947,7 @@ Returns: None """ - pass + ... def GetMenuItemCount(hMenu: 'typing.Any') -> 'typing.Any': @@ -3963,7 +3963,7 @@ Returns: typing.Any """ - pass + ... def GetMenuItemRect(hWnd: 'typing.Any', hMenu: 'typing.Any', uItem: 'typing.Any') -> 'tuple[int, int, int, int]': @@ -3981,7 +3981,7 @@ Returns: tuple[int, int, int, int] """ - pass + ... def GetMenuState(hMenu: 'typing.Any', uID: 'typing.Any', flags: 'typing.Any') -> 'typing.Any': @@ -3999,7 +3999,7 @@ Returns: typing.Any """ - pass + ... def SetMenuDefaultItem(hMenu: 'typing.Any', uItem: 'typing.Any', fByPos: 'typing.Any') -> 'None': @@ -4017,7 +4017,7 @@ Returns: None """ - pass + ... def GetMenuDefaultItem(hMenu: 'typing.Any', fByPos: 'typing.Any', flags: 'typing.Any') -> 'typing.Any': @@ -4035,7 +4035,7 @@ Returns: typing.Any """ - pass + ... def AppendMenu() -> 'None': @@ -4051,7 +4051,7 @@ Returns: None """ - pass + ... def InsertMenu() -> 'None': @@ -4067,7 +4067,7 @@ Returns: None """ - pass + ... def EnableMenuItem() -> 'None': @@ -4083,7 +4083,7 @@ Returns: None """ - pass + ... def CheckMenuItem() -> 'typing.Any': @@ -4099,7 +4099,7 @@ Returns: typing.Any """ - pass + ... def GetSubMenu(hMenu: 'typing.Any', nPos: 'typing.Any') -> 'typing.Any': @@ -4116,7 +4116,7 @@ Returns: typing.Any """ - pass + ... def ModifyMenu( @@ -4141,7 +4141,7 @@ Returns: None """ - pass + ... def GetMenuItemID(hMenu: 'typing.Any', nPos: 'typing.Any') -> 'typing.Any': @@ -4158,7 +4158,7 @@ Returns: typing.Any """ - pass + ... def SetMenuItemBitmaps( @@ -4183,7 +4183,7 @@ Returns: None """ - pass + ... def CheckMenuRadioItem( @@ -4212,7 +4212,7 @@ Returns: None """ - pass + ... def SetMenuInfo(hmenu: 'typing.Any', info: 'typing.Any') -> 'None': @@ -4229,7 +4229,7 @@ Returns: None """ - pass + ... def GetMenuInfo(hmenu: 'typing.Any', info: 'typing.Any') -> 'None': @@ -4246,7 +4246,7 @@ Returns: None """ - pass + ... def DrawFocusRect(hDC: 'int', rc: 'tuple[int, int, int, int]') -> 'None': @@ -4263,7 +4263,7 @@ Returns: None """ - pass + ... def DrawText( @@ -4289,7 +4289,7 @@ Returns: """ - pass + ... def LineTo(hdc: 'int', XEnd: 'typing.Any', YEnd: 'typing.Any') -> 'None': @@ -4307,7 +4307,7 @@ Returns: None """ - pass + ... def Ellipse( @@ -4332,7 +4332,7 @@ Returns: None """ - pass + ... def Pie( @@ -4365,7 +4365,7 @@ Returns: None """ - pass + ... def Arc( @@ -4398,7 +4398,7 @@ Returns: None """ - pass + ... def ArcTo( @@ -4431,7 +4431,7 @@ Returns: None """ - pass + ... def AngleArc( @@ -4458,7 +4458,7 @@ Returns: None """ - pass + ... def Chord( @@ -4491,7 +4491,7 @@ Returns: None """ - pass + ... def ExtFloodFill( @@ -4516,7 +4516,7 @@ Returns: None """ - pass + ... def SetPixel(hdc: 'int', X: 'typing.Any', Y: 'typing.Any', Color: 'typing.Any') -> 'typing.Any': @@ -4536,7 +4536,7 @@ Returns: """ - pass + ... def GetPixel(hdc: 'int', XPos: 'typing.Any', YPos: 'typing.Any') -> 'typing.Any': @@ -4554,7 +4554,7 @@ Returns: typing.Any """ - pass + ... def GetROP2(hdc: 'int') -> 'typing.Any': @@ -4571,7 +4571,7 @@ Returns: """ - pass + ... def SetROP2(hdc: 'int', DrawMode: 'typing.Any') -> 'typing.Any': @@ -4589,7 +4589,7 @@ Returns: """ - pass + ... def SetPixelV(hdc: 'int', X: 'typing.Any', Y: 'typing.Any', Color: 'typing.Any') -> 'None': @@ -4608,7 +4608,7 @@ Returns: None """ - pass + ... def MoveToEx(hdc: 'int', X: 'typing.Any', Y: 'typing.Any') -> 'tuple[typing.Any, typing.Any]': @@ -4627,7 +4627,7 @@ Returns: """ - pass + ... def GetCurrentPositionEx(hdc: 'int') -> 'tuple[typing.Any, typing.Any]': @@ -4643,7 +4643,7 @@ Returns: tuple[typing.Any, typing.Any] """ - pass + ... def GetArcDirection(hdc: 'int') -> 'typing.Any': @@ -4660,7 +4660,7 @@ Returns: """ - pass + ... def SetArcDirection(hdc: 'int', ArcDirection: 'typing.Any') -> 'typing.Any': @@ -4678,7 +4678,7 @@ Returns: """ - pass + ... def Polygon(hdc: 'int', Points: 'typing.List[tuple[typing.Any, typing.Any]]') -> 'None': @@ -4695,7 +4695,7 @@ Returns: None """ - pass + ... def Polyline(hdc: 'int', Points: 'typing.List[tuple[typing.Any, typing.Any]]') -> 'None': @@ -4712,7 +4712,7 @@ Returns: None """ - pass + ... def PolylineTo(hdc: 'int', Points: 'typing.List[tuple[typing.Any, typing.Any]]') -> 'None': @@ -4729,7 +4729,7 @@ Returns: None """ - pass + ... def PolyBezier(hdc: 'int', Points: 'typing.List[tuple[typing.Any, typing.Any]]') -> 'None': @@ -4746,7 +4746,7 @@ Returns: None """ - pass + ... def PolyBezierTo(hdc: 'int', Points: 'typing.List[tuple[typing.Any, typing.Any]]') -> 'None': @@ -4763,7 +4763,7 @@ Returns: None """ - pass + ... def PlgBlt( @@ -4798,7 +4798,7 @@ Returns: None """ - pass + ... def CreatePolygonRgn(Points: 'typing.List[tuple[typing.Any, typing.Any]]', @@ -4816,7 +4816,7 @@ Returns: win32typing.PyGdiHANDLE """ - pass + ... def ExtTextOut( @@ -4847,7 +4847,7 @@ Return ValueAlways none. If the function fails, an exception is raised. """ - pass + ... def GetTextColor(hdc: 'typing.Any') -> 'typing.Any': @@ -4864,7 +4864,7 @@ Returns: """ - pass + ... def SetTextColor(hdc: 'typing.Any', color: 'typing.Any') -> 'typing.Any': @@ -4882,7 +4882,7 @@ Returns: """ - pass + ... def GetBkMode(hdc: 'int') -> 'typing.Any': @@ -4899,7 +4899,7 @@ Returns: """ - pass + ... def SetBkMode(hdc: 'typing.Union[typing.Any, int]', BkMode: 'typing.Any') -> 'typing.Any': @@ -4917,7 +4917,7 @@ Returns: """ - pass + ... def GetBkColor(hdc: 'int') -> 'typing.Any': @@ -4934,7 +4934,7 @@ Returns: """ - pass + ... def SetBkColor(hdc: 'typing.Union[typing.Any, int]', color: 'typing.Any') -> 'typing.Any': @@ -4952,7 +4952,7 @@ Returns: """ - pass + ... def DrawEdge(hdc: 'int', rc: 'win32typing.PyRECT', edge: 'typing.Any', Flags: 'typing.Any') -> 'win32typing.PyRECT': @@ -4972,7 +4972,7 @@ Returns: """ - pass + ... def FillRect(hDC: 'int', rc: 'win32typing.PyRECT', hbr: 'win32typing.PyGdiHANDLE') -> 'None': @@ -4990,7 +4990,7 @@ Returns: None """ - pass + ... def FillRgn(hdc: 'int', hrgn: 'win32typing.PyGdiHANDLE', hbr: 'win32typing.PyGdiHANDLE') -> 'None': @@ -5008,7 +5008,7 @@ Returns: None """ - pass + ... def PaintRgn(hdc: 'int', hrgn: 'win32typing.PyGdiHANDLE') -> 'None': @@ -5025,7 +5025,7 @@ Returns: None """ - pass + ... def FrameRgn(hdc: 'int', hrgn: 'typing.Any', hbr: 'typing.Any', Width: 'typing.Any', Height: 'typing.Any') -> 'None': @@ -5045,7 +5045,7 @@ Returns: None """ - pass + ... def InvertRgn(hdc: 'int', hrgn: 'typing.Any') -> 'None': @@ -5062,7 +5062,7 @@ Returns: None """ - pass + ... def EqualRgn(SrcRgn1: 'typing.Any', SrcRgn2: 'typing.Any') -> 'typing.Any': @@ -5079,7 +5079,7 @@ Returns: typing.Any """ - pass + ... def PtInRegion(hrgn: 'typing.Any', X: 'typing.Any', Y: 'typing.Any') -> 'typing.Any': @@ -5097,7 +5097,7 @@ Returns: typing.Any """ - pass + ... def PtInRect(rect: 'tuple[int, int, int, int]', point: 'tuple[typing.Any, typing.Any]') -> 'typing.Any': @@ -5114,7 +5114,7 @@ Returns: typing.Any """ - pass + ... def RectInRegion(hrgn: 'typing.Any', rc: 'win32typing.PyRECT') -> 'typing.Any': @@ -5131,7 +5131,7 @@ Returns: typing.Any """ - pass + ... def SetRectRgn( @@ -5156,7 +5156,7 @@ Returns: None """ - pass + ... def CombineRgn(Dest: 'typing.Any', Src1: 'typing.Any', Src2: 'typing.Any', CombineMode: 'typing.Any') -> 'typing.Any': @@ -5176,7 +5176,7 @@ Returns: """ - pass + ... def DrawAnimatedRects( @@ -5199,7 +5199,7 @@ Returns: None """ - pass + ... def CreateSolidBrush(Color: 'typing.Any') -> 'win32typing.PyGdiHANDLE': @@ -5215,7 +5215,7 @@ Returns: win32typing.PyGdiHANDLE """ - pass + ... def CreatePatternBrush(hbmp: 'win32typing.PyGdiHANDLE') -> 'win32typing.PyGdiHANDLE': @@ -5231,7 +5231,7 @@ Returns: win32typing.PyGdiHANDLE """ - pass + ... def CreateHatchBrush(Style: 'typing.Any', clrref: 'typing.Any') -> 'win32typing.PyGdiHANDLE': @@ -5248,7 +5248,7 @@ Returns: win32typing.PyGdiHANDLE """ - pass + ... def CreatePen(PenStyle: 'typing.Any', Width: 'typing.Any', Color: 'typing.Any') -> 'win32typing.PyGdiHANDLE': @@ -5266,7 +5266,7 @@ Returns: win32typing.PyGdiHANDLE """ - pass + ... def GetSysColor(Index: 'typing.Any') -> 'typing.Any': @@ -5282,7 +5282,7 @@ Returns: typing.Any """ - pass + ... def GetSysColorBrush(Index: 'typing.Any') -> 'win32typing.PyGdiHANDLE': @@ -5298,7 +5298,7 @@ Returns: win32typing.PyGdiHANDLE """ - pass + ... def InvalidateRect(hWnd: 'int', Rect: 'win32typing.PyRECT', Erase: 'typing.Any') -> 'None': @@ -5316,7 +5316,7 @@ Returns: None """ - pass + ... def FrameRect(hDC: 'int', rc: 'win32typing.PyRECT', hbr: 'win32typing.PyGdiHANDLE') -> 'None': @@ -5334,7 +5334,7 @@ Returns: None """ - pass + ... def InvertRect(hDC: 'int', rc: 'win32typing.PyRECT') -> 'None': @@ -5351,7 +5351,7 @@ Returns: None """ - pass + ... def WindowFromDC(hDC: 'int') -> 'int': @@ -5368,7 +5368,7 @@ Returns: """ - pass + ... def GetUpdateRgn(hWnd: 'int', hRgn: 'win32typing.PyGdiHANDLE', Erase: 'typing.Any') -> 'typing.Any': @@ -5387,7 +5387,7 @@ Returns: """ - pass + ... def GetWindowRgn(hWnd: 'int', hRgn: 'win32typing.PyGdiHANDLE') -> 'typing.Any': @@ -5405,7 +5405,7 @@ Returns: """ - pass + ... def SetWindowRgn(hWnd: 'int', hRgn: 'win32typing.PyGdiHANDLE', Redraw: 'typing.Any') -> 'None': @@ -5423,7 +5423,7 @@ Returns: None """ - pass + ... def GetWindowRgnBox(hWnd: 'int') -> 'tuple[typing.Any, win32typing.PyRECT]': @@ -5443,7 +5443,7 @@ Return ValueReturns type of region and rectangle coordinates in device units """ - pass + ... def ValidateRgn(hWnd: 'int', hRgn: 'win32typing.PyGdiHANDLE') -> 'None': @@ -5460,7 +5460,7 @@ Returns: None """ - pass + ... def InvalidateRgn(hWnd: 'int', hRgn: 'win32typing.PyGdiHANDLE', Erase: 'typing.Any') -> 'None': @@ -5478,7 +5478,7 @@ Returns: None """ - pass + ... def GetRgnBox(hrgn: 'win32typing.PyGdiHANDLE') -> 'tuple[typing.Any, win32typing.PyRECT]': @@ -5495,7 +5495,7 @@ Returns: """ - pass + ... def OffsetRgn(hrgn: 'win32typing.PyGdiHANDLE', XOffset: 'typing.Any', YOffset: 'typing.Any') -> 'typing.Any': @@ -5514,7 +5514,7 @@ Returns: """ - pass + ... def Rectangle( @@ -5539,7 +5539,7 @@ Returns: None """ - pass + ... def RoundRect( @@ -5568,7 +5568,7 @@ Returns: None """ - pass + ... def BeginPaint() -> 'tuple[typing.Any, typing.Any]': @@ -5584,7 +5584,7 @@ Returns: tuple[typing.Any, typing.Any] """ - pass + ... def EndPaint(hwnd: 'int', ps: 'typing.Any') -> 'None': @@ -5601,7 +5601,7 @@ Returns: None """ - pass + ... def BeginPath(hdc: 'int') -> 'None': @@ -5617,7 +5617,7 @@ Returns: None """ - pass + ... def EndPath(hdc: 'int') -> 'None': @@ -5633,7 +5633,7 @@ Returns: None """ - pass + ... def AbortPath(hdc: 'int') -> 'None': @@ -5649,7 +5649,7 @@ Returns: None """ - pass + ... def CloseFigure(hdc: 'int') -> 'None': @@ -5665,7 +5665,7 @@ Returns: None """ - pass + ... def FlattenPath(hdc: 'int') -> 'None': @@ -5681,7 +5681,7 @@ Returns: None """ - pass + ... def FillPath(hdc: 'int') -> 'None': @@ -5697,7 +5697,7 @@ Returns: None """ - pass + ... def WidenPath(hdc: 'int') -> 'None': @@ -5713,7 +5713,7 @@ Returns: None """ - pass + ... def StrokePath(hdc: 'int') -> 'None': @@ -5729,7 +5729,7 @@ Returns: None """ - pass + ... def StrokeAndFillPath(hdc: 'int') -> 'None': @@ -5745,7 +5745,7 @@ Returns: None """ - pass + ... def GetMiterLimit(hdc: 'int') -> 'float': @@ -5761,7 +5761,7 @@ Returns: float """ - pass + ... def SetMiterLimit(hdc: 'int', NewLimit: 'float') -> 'float': @@ -5779,7 +5779,7 @@ Returns: """ - pass + ... def PathToRegion(hdc: 'int') -> 'win32typing.PyGdiHANDLE': @@ -5795,7 +5795,7 @@ Returns: win32typing.PyGdiHANDLE """ - pass + ... def GetPath(hdc: 'int') -> 'tuple[typing.Any, typing.Any]': @@ -5812,7 +5812,7 @@ Returns: """ - pass + ... def CreateRoundRectRgn( @@ -5839,7 +5839,7 @@ Returns: typing.Any """ - pass + ... def CreateRectRgnIndirect(rc: 'win32typing.PyRECT') -> 'typing.Any': @@ -5855,7 +5855,7 @@ Returns: typing.Any """ - pass + ... def CreateEllipticRgnIndirect(rc: 'win32typing.PyRECT') -> 'typing.Any': @@ -5871,7 +5871,7 @@ Returns: typing.Any """ - pass + ... def CreateWindowEx( @@ -5910,7 +5910,7 @@ Returns: typing.Any """ - pass + ... def GetParent(child: 'typing.Any') -> 'typing.Any': @@ -5926,7 +5926,7 @@ Returns: typing.Any """ - pass + ... def SetParent(child: 'typing.Any', child1: 'typing.Any') -> 'typing.Any': @@ -5943,7 +5943,7 @@ Returns: typing.Any """ - pass + ... def GetCursorPos() -> 'tuple[typing.Any, typing.Any]': @@ -5959,7 +5959,7 @@ Returns: tuple[typing.Any, typing.Any] """ - pass + ... def GetDesktopWindow() -> 'typing.Any': @@ -5975,7 +5975,7 @@ Returns: typing.Any """ - pass + ... def GetWindow(hWnd: 'typing.Any', uCmd: 'typing.Any') -> 'typing.Any': @@ -5992,7 +5992,7 @@ Returns: typing.Any """ - pass + ... def GetWindowDC(hWnd: 'typing.Any') -> 'typing.Any': @@ -6008,7 +6008,7 @@ Returns: typing.Any """ - pass + ... def IsIconic(hWnd: 'typing.Any') -> 'None': @@ -6024,7 +6024,7 @@ Returns: None """ - pass + ... def IsWindow(hWnd: 'typing.Any') -> 'None': @@ -6040,7 +6040,7 @@ Returns: None """ - pass + ... def IsChild(hWndParent: 'typing.Any', hWnd: 'typing.Any') -> 'None': @@ -6057,7 +6057,7 @@ Returns: None """ - pass + ... def ReleaseCapture() -> 'None': @@ -6073,7 +6073,7 @@ Returns: None """ - pass + ... def GetCapture() -> 'typing.Any': @@ -6089,7 +6089,7 @@ Returns: typing.Any """ - pass + ... def SetCapture() -> 'None': @@ -6105,7 +6105,7 @@ Returns: None """ - pass + ... def _TrackMouseEvent(tme: 'win32typing.TRACKMOUSEEVENT') -> 'None': @@ -6121,7 +6121,7 @@ Returns: None """ - pass + ... def ReleaseDC(hWnd: 'typing.Any', hDC: 'typing.Any') -> 'typing.Any': @@ -6138,7 +6138,7 @@ Returns: typing.Any """ - pass + ... def CreateCaret( @@ -6161,7 +6161,7 @@ Returns: None """ - pass + ... def DestroyCaret() -> 'None': @@ -6177,7 +6177,7 @@ Returns: None """ - pass + ... def ScrollWindowEx( @@ -6209,7 +6209,7 @@ If SW_SMOOTHSCROLL is specified, use upper 16 bits to specify time in millisecon """ - pass + ... def SetScrollInfo( @@ -6234,7 +6234,7 @@ Return ValueReturns an int with the current position of the scroll box. """ - pass + ... def GetScrollInfo(hwnd: 'int', nBar: 'typing.Any', mask: 'typing.Any') -> 'win32typing.PySCROLLINFO': @@ -6252,7 +6252,7 @@ Returns: win32typing.PySCROLLINFO """ - pass + ... def GetClassName(hwnd: 'int') -> 'str': @@ -6268,7 +6268,7 @@ Returns: str """ - pass + ... def WindowFromPoint(point: 'tuple[typing.Any, typing.Any]') -> 'typing.Any': @@ -6284,7 +6284,7 @@ Returns: typing.Any """ - pass + ... def ChildWindowFromPoint(hwndParent: 'typing.Any', point: 'tuple[typing.Any, typing.Any]') -> 'typing.Any': @@ -6301,7 +6301,7 @@ Returns: typing.Any """ - pass + ... def ListView_SortItems(hwnd: 'int', callback: 'typing.Any', param: 'typing.Any' = None) -> 'None': @@ -6319,7 +6319,7 @@ Returns: None """ - pass + ... def ListView_SortItemsEx(hwnd: 'int', callback: 'typing.Any', param: 'typing.Any' = None) -> 'None': @@ -6337,7 +6337,7 @@ Returns: None """ - pass + ... def CreateDC(Driver: 'str', Device: 'str', InitData: 'win32typing.PyDEVMODE') -> 'typing.Any': @@ -6355,7 +6355,7 @@ Returns: typing.Any """ - pass + ... def GetSaveFileNameW( @@ -6417,7 +6417,7 @@ win32gui.error is raised. If the user pressed cancel, the error number (ie, the """ - pass + ... def GetOpenFileNameW( @@ -6456,7 +6456,7 @@ Returns: tuple[typing.Any, typing.Any, typing.Any] """ - pass + ... def SystemParametersInfo(Action: 'typing.Any', Param: 'typing.Any' = None, WinIni: 'typing.Any' = 0) -> 'None': @@ -6661,7 +6661,7 @@ Return ValueSPI_SET functions all return None on success. Types returned by SPI """ - pass + ... def SetLayeredWindowAttributes(hwnd: 'int', Key: 'typing.Any', Alpha: 'typing.Any', Flags: 'typing.Any') -> 'None': @@ -6680,7 +6680,7 @@ Returns: None """ - pass + ... def GetLayeredWindowAttributes(hwnd: 'int') -> 'tuple[typing.Any, typing.Any, typing.Any]': @@ -6702,7 +6702,7 @@ Return ValueReturns a tuple of (color key, alpha, flags) """ - pass + ... def UpdateLayeredWindow( @@ -6735,7 +6735,7 @@ Returns: None """ - pass + ... def AnimateWindow(hwnd: 'int', Time: 'typing.Any', Flags: 'typing.Any') -> 'None': @@ -6753,7 +6753,7 @@ Returns: None """ - pass + ... def CreateBrushIndirect(lb: 'win32typing.PyLOGBRUSH') -> 'win32typing.PyGdiHANDLE': @@ -6769,7 +6769,7 @@ Returns: win32typing.PyGdiHANDLE """ - pass + ... def ExtCreatePen( @@ -6792,7 +6792,7 @@ Returns: int """ - pass + ... def DrawTextW(hDC: 'int', String: 'str', Count: 'typing.Any', Rect: 'win32typing.PyRECT', @@ -6817,7 +6817,7 @@ Return ValueReturns the height of the drawn text, and the rectangle coordinates """ - pass + ... def EnumPropsEx(hWnd: 'int', EnumFunc: 'typing.Any', Param: 'typing.Any') -> 'None': @@ -6835,7 +6835,7 @@ Returns: None """ - pass + ... def RegisterDeviceNotification(handle: 'int', _filter: 'typing.Any', flags: 'typing.Any') -> 'win32typing.PyHDEVNOTIFY': @@ -6853,7 +6853,7 @@ Returns: win32typing.PyHDEVNOTIFY """ - pass + ... def UnregisterDeviceNotification() -> 'None': @@ -6873,7 +6873,7 @@ Returns: None """ - pass + ... def RegisterHotKey(hWnd: 'int', _id: 'typing.Any', Modifiers: 'typing.Any', vk: 'typing.Any') -> 'None': @@ -6892,7 +6892,7 @@ Returns: None """ - pass + ... CLR_NONE = ... diff --git a/typings/win32con/__init__.pyi b/typings/win32con/__init__.pyi index ae8f3556..cddea27f 100644 --- a/typings/win32con/__init__.pyi +++ b/typings/win32con/__init__.pyi @@ -1,4 +1,4 @@ -""" +""" # noqa: Y021 This type stub file was generated by pyright. """ diff --git a/typings/win32typing/__init__.pyi b/typings/win32typing/__init__.pyi index 4dd08321..d182f30f 100644 --- a/typings/win32typing/__init__.pyi +++ b/typings/win32typing/__init__.pyi @@ -1118,7 +1118,7 @@ Returns: """ ... - def GetAuditedPermissionsFromAcl(self, trustee: PyTRUSTEE) -> Tuple[Any, Any]: + def GetAuditedPermissionsFromAcl(self, trustee: PyTRUSTEE) -> tuple[Any, Any]: """ Return types of access for @@ -1130,7 +1130,7 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... @@ -1164,7 +1164,7 @@ class PyBITMAP: class PyBLENDFUNCTION: - """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).""" @@ -1222,7 +1222,7 @@ Returns: """ ... - def CertEnumCertificatesInStore(self) -> List[PyCERT_CONTEXT]: + def CertEnumCertificatesInStore(self) -> list[PyCERT_CONTEXT]: """ Lists all certificates in the store @@ -1232,12 +1232,12 @@ Args: Returns: - List[PyCERT_CONTEXT] + list[PyCERT_CONTEXT] """ ... - def CertEnumCTLsInStore(self) -> List[PyCTL_CONTEXT]: + def CertEnumCTLsInStore(self) -> list[PyCTL_CONTEXT]: """ Finds all Certificate Trust Lists in store @@ -1247,7 +1247,7 @@ Args: Returns: - List[PyCTL_CONTEXT] + list[PyCTL_CONTEXT] """ ... @@ -1559,7 +1559,7 @@ class PyCERT_CONTEXT: ... @property - def Extension(self) -> Tuple[PyCERT_EXTENSION, ...]: + def Extension(self) -> tuple[PyCERT_EXTENSION, ...]: """Sequence of CERT_EXTENSION dicts containing certificate's extensions""" ... @@ -1588,7 +1588,7 @@ Returns: """ ... - def CertEnumCertificateContextProperties(self) -> List[Any]: + def CertEnumCertificateContextProperties(self) -> list[Any]: """ Lists property ids for the certificate @@ -1598,12 +1598,12 @@ Args: Returns: - List[Any] + list[Any] """ ... - def CryptAcquireCertificatePrivateKey(self, Flags: Any = 0) -> Tuple[Any, PyCRYPTPROV]: + def CryptAcquireCertificatePrivateKey(self, Flags: Any = 0) -> tuple[Any, PyCRYPTPROV]: """ Retrieves the private key associated @@ -1615,7 +1615,7 @@ Args: Returns: - Tuple[Any, PyCRYPTPROV]:Combination of CRYPT_ACQUIRE_*_FLAG constants + tuple[Any, PyCRYPTPROV]:Combination of CRYPT_ACQUIRE_*_FLAG constants Comments Only the owner of the certificate can use this method @@ -2024,7 +2024,7 @@ class PyCREDENTIAL: @property def Attributes(self) -> Any: - """Tuple of PyCREDENTIAL_ATTRIBUTE dicts containing application-specific data, can be None""" + """tuple of PyCREDENTIAL_ATTRIBUTE dicts containing application-specific data, can be None""" ... @property @@ -2102,8 +2102,8 @@ class PyCREDENTIAL_TARGET_INFORMATION: ... @property - def CredTypes(self) -> Tuple[Any, ...]: - """Tuple of CRED_TYPE_* values indicating which types of credentials are acceptable to target""" + def CredTypes(self) -> tuple[Any, ...]: + """tuple of CRED_TYPE_* values indicating which types of credentials are acceptable to target""" ... @@ -2599,7 +2599,7 @@ class PyCRYPT_ATTRIBUTE: ... @property - def Value(self) -> Tuple[Any, ...]: + def Value(self) -> tuple[Any, ...]: """A sequence of buffers containing the attribute values""" ... @@ -2627,7 +2627,7 @@ class PyCRYPT_DECRYPT_MESSAGE_PARA: raise Exception('This class just for typing, can not be instanced!') @property - def CertStores(self) -> Tuple[Any, ...]: + def CertStores(self) -> tuple[Any, ...]: """Sequence of certificate stores to be searched for a certificate with a private key that can be used to decrypt the message""" ... @@ -2700,22 +2700,22 @@ class PyCRYPT_SIGN_MESSAGE_PARA: ... @property - def MsgCert(self) -> Tuple[PyCERT_CONTEXT, ...]: + def MsgCert(self) -> tuple[PyCERT_CONTEXT, ...]: """Optional sequence of certificate to be included in the message.""" ... @property - def MsgCrl(self) -> Tuple[Any, ...]: + def MsgCrl(self) -> tuple[Any, ...]: """Optional. Sequence of certificate revocation lists. Not yet supported, use only None.""" ... @property - def AuthAttr(self) -> Tuple[PyCRYPT_ATTRIBUTE, ...]: + def AuthAttr(self) -> tuple[PyCRYPT_ATTRIBUTE, ...]: """Sequence of canonical attributes to be added to the message""" ... @property - def UnauthAttr(self) -> Tuple[PyCRYPT_ATTRIBUTE, ...]: + def UnauthAttr(self) -> tuple[PyCRYPT_ATTRIBUTE, ...]: """Sequence of arbitrary attributes""" ... @@ -2762,7 +2762,7 @@ class PyCRYPT_VERIFY_MESSAGE_PARA: class PyCTL_CONTEXT: - """Object containing a Certificate Trust List""" + """Object containing a Certificate Trust list""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @@ -2787,7 +2787,7 @@ Returns: """ ... - def CertEnumCTLContextProperties(self) -> Tuple[Any, ...]: + def CertEnumCTLContextProperties(self) -> tuple[Any, ...]: """ Lists property id's for the context @@ -2797,12 +2797,12 @@ Args: Returns: - Tuple[Any, ...] + tuple[Any, ...] """ ... - def CertEnumSubjectInSortedCTL(self) -> Tuple[Tuple[Any, Any], ...]: + def CertEnumSubjectInSortedCTL(self) -> tuple[tuple[Any, Any], ...]: """ Retrieves trusted subjects contained in CRL @@ -2812,7 +2812,7 @@ Args: Returns: - Tuple[Tuple[Any, Any], ...]:PyCTL_CONTEXT.CertEnumSubjectInSortedCTL + tuple[tuple[Any, Any], ...]:PyCTL_CONTEXT.CertEnumSubjectInSortedCTL ((str,str),...) = CertEnumSubjectInSortedCTL()Retrieves trusted subjects contained in CRL Return ValueReturns a sequence of tuples containing two strings (SubjectIdentifier, EncodedAttributes) @@ -2881,7 +2881,7 @@ Returns: """ ... - def GetConsoleCursorInfo(self) -> Tuple[Any, Any]: + def GetConsoleCursorInfo(self) -> tuple[Any, Any]: """ Retrieves size and visibility of console's @@ -2893,7 +2893,7 @@ Args: Returns: - Tuple[Any, Any]:PyConsoleScreenBuffer.GetConsoleCursorInfo + tuple[Any, Any]:PyConsoleScreenBuffer.GetConsoleCursorInfo (Size, bVisible) = GetConsoleCursorInfo()Retrieves size and visibility of console's @@ -3153,7 +3153,7 @@ Returns: """ ... - def ReadConsoleOutputAttribute(self, Length: Any, ReadCoord: PyCOORD) -> Tuple[Any, ...]: + def ReadConsoleOutputAttribute(self, Length: Any, ReadCoord: PyCOORD) -> tuple[Any, ...]: """ Retrieves attributes from consecutive character @@ -3166,7 +3166,7 @@ Args: Returns: - Tuple[Any, ...]:The screen position from which to start readingReturn ValueReturns a sequence of ints containing the attributes of a range of characters + tuple[Any, ...]:The screen position from which to start readingReturn ValueReturns a sequence of ints containing the attributes of a range of characters """ @@ -3189,13 +3189,13 @@ Returns: """ ... - def WriteConsoleOutputAttribute(self, Attributes: Tuple[Any, ...], WriteCoord: PyCOORD) -> Any: + def WriteConsoleOutputAttribute(self, Attributes: tuple[Any, ...], WriteCoord: PyCOORD) -> Any: """ Sets the attributes of a range of character cells Args: - Attributes(Tuple[Any, ...]):A sequence of ints containing the attributes to be set + Attributes(tuple[Any, ...]):A sequence of ints containing the attributes to be set WriteCoord(PyCOORD):The screen position at which to start writingReturn ValueReturns the number of attributes set Returns: @@ -3231,7 +3231,7 @@ Returns: """ ... - def GetCurrentConsoleFont(self, MaximumWindow: Any = False) -> Tuple[Any, PyCOORD]: + def GetCurrentConsoleFont(self, MaximumWindow: Any = False) -> tuple[Any, PyCOORD]: """ Returns currently displayed font @@ -3241,7 +3241,7 @@ Args: Returns: - Tuple[Any, PyCOORD]:If True, retrieves font size for maximum window size + tuple[Any, PyCOORD]:If True, retrieves font size for maximum window size Comments Only exists on XP or later. @@ -3316,13 +3316,13 @@ Returns: """ ... - def WriteConsoleInput(self, Buffer: Tuple[PyINPUT_RECORD, ...]) -> Any: + def WriteConsoleInput(self, Buffer: tuple[PyINPUT_RECORD, ...]) -> Any: """ Places input records in the console's input queue Args: - Buffer(Tuple[PyINPUT_RECORD, ...]):A sequence of PyINPUT_RECORD objectsReturn ValueReturns the number of records written + Buffer(tuple[PyINPUT_RECORD, ...]):A sequence of PyINPUT_RECORD objectsReturn ValueReturns the number of records written Returns: @@ -3332,7 +3332,7 @@ Returns: """ ... - def ReadConsoleInput(self, Length: Any) -> Tuple[PyINPUT_RECORD, ...]: + def ReadConsoleInput(self, Length: Any) -> tuple[PyINPUT_RECORD, ...]: """ Reads input records and removes them from @@ -3344,7 +3344,7 @@ Args: Returns: - Tuple[PyINPUT_RECORD, ...]:The number of input records to readComments + tuple[PyINPUT_RECORD, ...]:The number of input records to readComments This functions blocks until at least one record is read. @@ -3355,7 +3355,7 @@ Return ValueReturns a sequence of PyINPUT_RECORD objects """ ... - def PeekConsoleInput(self, Length: Any) -> Tuple[PyINPUT_RECORD, ...]: + def PeekConsoleInput(self, Length: Any) -> tuple[PyINPUT_RECORD, ...]: """ Returns pending input records without @@ -3367,7 +3367,7 @@ Args: Returns: - Tuple[PyINPUT_RECORD, ...]:The number of input records to readComments + tuple[PyINPUT_RECORD, ...]:The number of input records to readComments This function does not block as ReadConsoleInput does. @@ -4387,7 +4387,7 @@ When the object is destroyed, EvtClose is called.""" class PyEVT_RPC_LOGIN: - """Tuple containing login credentials for a remote Event Log connection""" + """tuple containing login credentials for a remote Event Log connection""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @@ -4440,7 +4440,7 @@ class PyEventLogRecord: ... @property - def StringInserts(self) -> Tuple[str, ...]: + def StringInserts(self) -> tuple[str, ...]: ... @property @@ -4664,7 +4664,7 @@ Returns: """ ... - def EnumDesktopWindows(self) -> Tuple[int, ...]: + def EnumDesktopWindows(self) -> tuple[int, ...]: """ Returns a list of handles to all top-level windows on desktop @@ -4674,7 +4674,7 @@ Args: Returns: - Tuple[int, ...] + tuple[int, ...] """ ... @@ -5058,7 +5058,7 @@ class PyHWINSTA: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def EnumDesktops(self) -> Tuple[Any, ...]: + def EnumDesktops(self) -> tuple[Any, ...]: """ Lists names of desktops in the window station @@ -5068,7 +5068,7 @@ Args: Returns: - Tuple[Any, ...] + tuple[Any, ...] """ ... @@ -5105,7 +5105,7 @@ Returns: class PyICONINFO: - """Tuple describing an icon or cursor""" + """tuple describing an icon or cursor""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @@ -5675,7 +5675,7 @@ Returns: class PyPOINT: - """Tuple of two ints (x,y) representing a POINT struct""" + """tuple of two ints (x,y) representing a POINT struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @@ -5751,7 +5751,7 @@ class PyPrinterHANDLE: class PyRECT: - """Tuple of 4 ints defining a rectangle: (left, top, right, bottom)""" + """tuple of 4 ints defining a rectangle: (left, top, right, bottom)""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @@ -5861,7 +5861,7 @@ Returns: """ ... - def GetSecurityDescriptorControl(self) -> Tuple[Any, Any]: + def GetSecurityDescriptorControl(self) -> tuple[Any, Any]: """ Returns tuple of Control bit flags and @@ -5873,7 +5873,7 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... @@ -6813,7 +6813,7 @@ Returns: """ ... - def GetSidIdentifierAuthority(self) -> Tuple[Any, Any, Any, Any, Any, Any]: + def GetSidIdentifierAuthority(self) -> tuple[Any, Any, Any, Any, Any, Any]: """ Returns a tuple of 6 SID_IDENTIFIER_AUTHORITY @@ -6825,7 +6825,7 @@ Args: Returns: - Tuple[Any, Any, Any, Any, Any, Any] + tuple[Any, Any, Any, Any, Any, Any] """ ... @@ -6838,7 +6838,7 @@ class PySID_AND_ATTRIBUTES: class PySIZE: - """Tuple of two ints (cx,cy) representing a SIZE struct""" + """tuple of two ints (cx,cy) representing a SIZE struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @@ -8966,7 +8966,7 @@ class RASDIALPARAMS: class SC_ACTION: - """Tuple of 2 ints (Type,Delay) used to represent an SC_ACTION structure""" + """tuple of 2 ints (Type,Delay) used to represent an SC_ACTION structure""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @@ -9178,7 +9178,7 @@ Returns: """ ... - def fetchmany(self) -> List[Any]: + def fetchmany(self) -> list[Any]: """ Fetch many rows of data @@ -9188,12 +9188,12 @@ Args: Returns: - List[Any] + list[Any] """ ... - def fetchall(self) -> List[Any]: + def fetchall(self) -> list[Any]: """ Fetch all rows of data @@ -9203,7 +9203,7 @@ Args: Returns: - List[Any] + list[Any] """ ... @@ -9535,11 +9535,11 @@ class FUNCDESC: ... @property - def scodeArray(self) -> Tuple[Any, ...]: + def scodeArray(self) -> tuple[Any, ...]: ... @property - def args(self) -> Tuple[Any, ...]: + def args(self) -> tuple[Any, ...]: ... @property @@ -9607,17 +9607,17 @@ class NT_CONSOLE_PROPS: ... @property - def ScreenBufferSize(self) -> Tuple[Any, Any]: + def ScreenBufferSize(self) -> tuple[Any, Any]: """Size of console screen buffer, in character cells""" ... @property - def WindowSize(self) -> Tuple[Any, Any]: + def WindowSize(self) -> tuple[Any, Any]: """Size of console window in character cells""" ... @property - def WindowOrigin(self) -> Tuple[Any, Any]: + def WindowOrigin(self) -> tuple[Any, Any]: """Window position, in screen coordinates""" ... @@ -9632,7 +9632,7 @@ class NT_CONSOLE_PROPS: ... @property - def FontSize(self) -> Tuple[Any, Any]: + def FontSize(self) -> tuple[Any, Any]: """Size of font""" ... @@ -9689,7 +9689,7 @@ class NT_CONSOLE_PROPS: @property def ColorTable(self) -> Any: - """Tuple of 16 ints containing console's color attributes""" + """tuple of 16 ints containing console's color attributes""" ... @property @@ -9754,7 +9754,7 @@ class PyADS_ATTR_INFO: ... @property - def Values(self) -> List[Any]: + def Values(self) -> list[Any]: ... @@ -10112,7 +10112,7 @@ class PyDSOP_UPLEVEL_FILTER_FLAGS: class PyFORMATETC: - """Tuple representing a FORMATETC struct describing an OLE data format""" + """tuple representing a FORMATETC struct describing an OLE data format""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @@ -10491,7 +10491,7 @@ Returns: """ ... - def GetAccessRights(self, ObjectType: PyIID, Flags: Any) -> Tuple[Any, Any]: + def GetAccessRights(self, ObjectType: PyIID, Flags: Any) -> tuple[Any, Any]: """ Retrieves permission that can be set @@ -10502,7 +10502,7 @@ Args: Returns: - Tuple[Any, Any]:Indicates which page is requesting the access rights (SI_ADVANCED, SI_EDIT_AUDITS, + tuple[Any, 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, @@ -10533,7 +10533,7 @@ Return ValueThis method should return the input bitmask will all generic rights """ ... - def GetInheritTypes(self) -> Tuple[Any, ...]: + def GetInheritTypes(self) -> tuple[Any, ...]: """ Requests types of inheritance that your @@ -10545,7 +10545,7 @@ Args: Returns: - Tuple[Any, ...]:PyGSecurityInformation.GetInheritTypes + tuple[Any, ...]:PyGSecurityInformation.GetInheritTypes (SI_INHERIT_TYPE,...) = GetInheritTypes()Requests types of inheritance that your @@ -11615,7 +11615,7 @@ class PyIActiveScriptDebug: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetScriptTextAttributes(self, pstrCode: str, pstrDelimiter: str, dwFlags: Any) -> Tuple[Any, ...]: + def GetScriptTextAttributes(self, pstrCode: str, pstrDelimiter: str, dwFlags: Any) -> tuple[Any, ...]: """ Returns the text attributes for an arbitrary block @@ -11629,7 +11629,7 @@ Args: Returns: - Tuple[Any, ...] + tuple[Any, ...] """ ... @@ -11982,7 +11982,7 @@ Returns: """ ... - def OnScriptErrorDebug(self) -> Tuple[Any, Any]: + def OnScriptErrorDebug(self) -> tuple[Any, Any]: """ Allows a smart host to control the handling of runtime @@ -11994,7 +11994,7 @@ Args: Returns: - Tuple[Any, Any]:PyIActiveScriptSiteDebug.OnScriptErrorDebug + tuple[Any, Any]:PyIActiveScriptSiteDebug.OnScriptErrorDebug int, int = OnScriptErrorDebug()Allows a smart host to control the handling of runtime @@ -12582,7 +12582,7 @@ Returns: """ ... - def EnumClassesOfCategories(self, listIIdImplemented: List[PyIID] = None, listIIdRequired: Any = None) -> Any: + def EnumClassesOfCategories(self, listIIdImplemented: list[PyIID] = None, listIIdRequired: Any = None) -> Any: """ Returns an enumerator over the classes that @@ -12590,7 +12590,7 @@ implement one or more interfaces. Args: - listIIdImplemented(List[PyIID]):A sequence of PyIID objects, or None. + listIIdImplemented(list[PyIID]):A sequence of PyIID objects, or None. listIIdRequired(Any):A sequence of PyIID objects, or None. Returns: @@ -12607,7 +12607,7 @@ class PyICatRegister: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def RegisterCategories(self, arg: List[Any]) -> None: + def RegisterCategories(self, arg: list[Any]) -> None: """ Registers one or more component categories. Each component category @@ -12615,7 +12615,7 @@ consists of a CATID and a list of locale-dependent description strings. Args: - arg(List[Any]):A sequence of category descriptions. + arg(list[Any]):A sequence of category descriptions. Returns: @@ -12624,13 +12624,13 @@ Returns: """ ... - def UnRegisterCategories(self, arg: List[PyIID]) -> None: + def UnRegisterCategories(self, arg: list[PyIID]) -> None: """ Unregister one or more previously registered categories. Args: - arg(List[PyIID]):The list of category IDs to be unregistered. + arg(list[PyIID]):The list of category IDs to be unregistered. Returns: @@ -12639,7 +12639,7 @@ Returns: """ ... - def RegisterClassImplCategories(self, clsid: PyIID, arg: List[PyIID]) -> None: + def RegisterClassImplCategories(self, clsid: PyIID, arg: list[PyIID]) -> None: """ Registers the class as implementing one or more component @@ -12648,7 +12648,7 @@ categories. Args: clsid(PyIID):Class ID of the relevent class - arg(List[PyIID]):A sequence of category IDs to be associated with the class. + arg(list[PyIID]):A sequence of category IDs to be associated with the class. Returns: @@ -12657,7 +12657,7 @@ Returns: """ ... - def UnRegisterClassImplCategories(self, clsid: PyIID, arg: List[PyIID]) -> None: + def UnRegisterClassImplCategories(self, clsid: PyIID, arg: list[PyIID]) -> None: """ Unregisters the class as implementing one or more component @@ -12666,7 +12666,7 @@ categories. Args: clsid(PyIID):Class ID of the relevent class - arg(List[PyIID]):A sequence of category IDs to be unregistered from the class. + arg(list[PyIID]):A sequence of category IDs to be unregistered from the class. Returns: @@ -12675,7 +12675,7 @@ Returns: """ ... - def RegisterClassReqCategories(self, clsid: PyIID, arg: List[PyIID]) -> None: + def RegisterClassReqCategories(self, clsid: PyIID, arg: list[PyIID]) -> None: """ Registers the class as requiring one or more component @@ -12684,7 +12684,7 @@ categories. Args: clsid(PyIID):Class ID of the relevent class - arg(List[PyIID]):A sequence of category IDs to be associated with the class. + arg(list[PyIID]):A sequence of category IDs to be associated with the class. Returns: @@ -12693,7 +12693,7 @@ Returns: """ ... - def UnRegisterClassReqCategories(self, clsid: PyIID, arg: List[PyIID]) -> None: + def UnRegisterClassReqCategories(self, clsid: PyIID, arg: list[PyIID]) -> None: """ Unregisters the class as requiring one or more component @@ -12702,7 +12702,7 @@ categories. Args: clsid(PyIID):Class ID of the relevent class - arg(List[PyIID]):A sequence of category IDs to be unregistered for the class. + arg(list[PyIID]):A sequence of category IDs to be unregistered for the class. Returns: @@ -13147,7 +13147,7 @@ Returns: """ ... - def GetProperty(self, rGuid: PyIID) -> Tuple[Any, Any]: + def GetProperty(self, rGuid: PyIID) -> tuple[Any, Any]: """ Retrieves a context property @@ -13157,7 +13157,7 @@ Args: Returns: - Tuple[Any, Any]:GUID that identifies a context propertyReturn ValueReturns flags (CPFLAGS is reserved, no defined values) and the IUnknown interface set for the property + tuple[Any, Any]:GUID that identifies a context propertyReturn ValueReturns flags (CPFLAGS is reserved, no defined values) and the IUnknown interface set for the property """ @@ -13216,7 +13216,7 @@ Returns: Args: - pici(Any):Tuple of parameters representing a CMINVOKECOMMANDINFO struct + pici(Any):tuple of parameters representing a CMINVOKECOMMANDINFO struct Returns: @@ -13504,14 +13504,14 @@ Returns: """ ... - def SetFuncAndParamNames(self, index: Any, rgszNames: Tuple[Any, ...]) -> None: + def SetFuncAndParamNames(self, index: Any, rgszNames: tuple[Any, ...]) -> None: """ Description of SetFuncAndParamNames. Args: index(Any):Index of the item to set. - rgszNames(Tuple[Any, ...]):A sequence of unicode or String objects. + rgszNames(tuple[Any, ...]):A sequence of unicode or String objects. Returns: @@ -14008,7 +14008,7 @@ Returns: """ ... - def BeginList(self, riid: PyIID) -> Tuple[Any, Any]: + def BeginList(self, riid: PyIID) -> tuple[Any, Any]: """ Clears the jump list and prepares it to be @@ -14020,7 +14020,7 @@ Args: Returns: - Tuple[Any, Any]:The interface to return + tuple[Any, Any]:The interface to return Return ValueReturns the number of slots and a collection of all destinations removed from the jump list @@ -14159,7 +14159,7 @@ class PyIDataObject: Args: - pformatetcIn(Any):Tuple representing a FORMATETC struct describing how the data should be returned + pformatetcIn(Any):tuple representing a FORMATETC struct describing how the data should be returned Returns: @@ -14174,7 +14174,7 @@ Returns: Args: - pformatetcIn(Any):Tuple representing a FORMATETC struct describing how the data should be returned + pformatetcIn(Any):tuple representing a FORMATETC struct describing how the data should be returned Returns: @@ -14189,11 +14189,11 @@ Returns: Args: - pformatetc(Any):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. + pformatetc(Any):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. 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. @@ -14209,7 +14209,7 @@ format that the object supports Args: - pformatectIn(Any):Tuple representing a FORMATETC struct describing how the data should be returned + pformatectIn(Any):tuple representing a FORMATETC struct describing how the data should be returned Returns: @@ -14224,7 +14224,7 @@ Returns: Args: - pformatetc(Any):Tuple representing a FORMATETC struct describing the type of data to be set + pformatetc(Any):tuple representing a FORMATETC struct describing the type of data to be set pmedium(Any):The data to be placed in the object fRelease(Any):If True, transfers ownership of the data to the object. If False, caller is responsible for releasing the STGMEDIUM. @@ -16705,28 +16705,28 @@ Returns: """ ... - def GetObjectAttributes(self, names: Tuple[str, ...]) -> Tuple[Any, ...]: + def GetObjectAttributes(self, names: tuple[str, ...]) -> tuple[Any, ...]: """ None Args: - names(Tuple[str, ...]): + names(tuple[str, ...]): Returns: - Tuple[Any, ...] + tuple[Any, ...] """ ... - def SetObjectAttributes(self, attrs: Tuple[Any, ...]) -> Any: + def SetObjectAttributes(self, attrs: tuple[Any, ...]) -> Any: """ None Args: - attrs(Tuple[Any, ...]):The attributes to set + attrs(tuple[Any, ...]):The attributes to set Returns: @@ -16735,14 +16735,14 @@ Returns: """ ... - def CreateDSObject(self, rdn: str, attrs: Tuple[Any, ...]) -> Any: + def CreateDSObject(self, rdn: str, attrs: tuple[Any, ...]) -> Any: """ None Args: rdn(str):The relative distinguished name (relative path) of the object to be created. - attrs(Tuple[Any, ...]):The attributes to set. + attrs(tuple[Any, ...]):The attributes to set. Returns: @@ -16772,7 +16772,7 @@ class PyIDirectorySearch: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def SetSearchPreference(self, prefs: Any) -> Tuple[Any, Any, Any]: + def SetSearchPreference(self, prefs: Any) -> tuple[Any, Any, Any]: """ None @@ -16782,7 +16782,7 @@ Args: Returns: - Tuple[Any, Any, Any]:Return ValueThe result is the hresult of the call, and a list of integer status + tuple[Any, Any, Any]:Return ValueThe result is the hresult of the call, and a list of integer status codes for each of the preferences set. @@ -16790,14 +16790,14 @@ codes for each of the preferences set. """ ... - def ExecuteSearch(self, _filter: str, attrNames: List[str]) -> Any: + def ExecuteSearch(self, _filter: str, attrNames: list[str]) -> Any: """ None Args: _filter(str): - attrNames(List[str]):Return ValueThe result is an integer search handle. PyIDirectorySearch::CloseSearchHandle should be called to close the handle. + attrNames(list[str]):Return ValueThe result is an integer search handle. PyIDirectorySearch::CloseSearchHandle should be called to close the handle. Returns: @@ -16887,7 +16887,7 @@ Returns: """ ... - def GetColumn(self, handle: Any, name: str) -> Tuple[Any, Any, Any]: + def GetColumn(self, handle: Any, name: str) -> tuple[Any, Any, Any]: """ None @@ -16898,7 +16898,7 @@ Args: Returns: - Tuple[Any, Any, Any] + tuple[Any, Any, Any] """ ... @@ -16928,7 +16928,7 @@ class PyIDispatch: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Invoke(self, dispid: Any, lcid: Any, flags: Any, bResultWanted: Any, arg: Tuple[Any, ...]) -> Any: + def Invoke(self, dispid: Any, lcid: Any, flags: Any, bResultWanted: Any, arg: tuple[Any, ...]) -> Any: """ Invokes a DISPID, using the passed arguments. @@ -16938,7 +16938,7 @@ Args: lcid(Any):The locale id to use. flags(Any):The flags for the call. The following flags can be used.FlagDescriptionDISPATCH_METHODThe member is invoked as a method. If a property has the same name, both this and the DISPATCH_PROPERTYGET flag may be set.DISPATCH_PROPERTYGETThe member is retrieved as a property or data member.DISPATCH_PROPERTYPUTThe member is changed as a property or data member.DISPATCH_PROPERTYPUTREFThe member is changed by a reference assignment, rather than a value assignment. This flag is valid only when the property accepts a reference to an object. bResultWanted(Any):Indicates if the result of the call should be requested. - arg(Tuple[Any, ...]):The parameters to ....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) + arg(tuple[Any, ...]):The parameters to ....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) Returns: @@ -16956,8 +16956,8 @@ Otherwise, the result is determined by the COM object itself (and may still be N lcid: Any, wFlags: Any, resultTypeDesc: Any, - typeDescs: Tuple[Any, ...], - args: Tuple[Any, ...]) -> Any: + typeDescs: tuple[Any, ...], + args: tuple[Any, ...]) -> Any: """ Invokes a DISPID, using the passed arguments and type descriptions. @@ -16967,8 +16967,8 @@ Args: lcid(Any):The locale ID. Please see PyIDispatch::Invoke. wFlags(Any):Flags for the call. Please see PyIDispatch::Invoke. resultTypeDesc(Any):A tuple describing the type of the result. See the comments for more information. - typeDescs(Tuple[Any, ...]):A sequence of tuples describing the types of the parameters for the function. See the comments for more information. - args(Tuple[Any, ...]):The args to the function.CommentsThe Microsoft documentation for IDispatch should be used for all params except 'resultTypeDesc' and 'typeDescs'. 'resultTypeDesc' describes the return value of the function, and is a tuple of (type_id, flags). 'typeDescs' describes the type of each parameters, and is a list of the same (type_id, flags) tuple.itemDescriptiontype_idA valid "variant type" constant (eg, VT_I4 | VT_ARRAY, VT_DATE, etc - see VARIANT at MSDN).flagsOne of the PARAMFLAG constants (eg, PARAMFLAG_FIN, PARAMFLAG_FOUT etc - see PARAMFLAG at MSDN).ExampleAn example from the makepy generated file for Wordclass Cells(DispatchBaseClass):... def SetWidth(self, ColumnWidth=..., RulerStyle=...): return self._oleobj_.InvokeTypes(202, LCID, 1, (24, 0), ((4, 1), (3, 1)),...)The interesting bits areresultTypeDesc: (24, 0) - (VT_VOID, <no flags>)typeDescs: ((4, 1), (3, 1)) - ((VT_R4, PARAMFLAG_FIN), (VT_I4, PARAMFLAG_FIN))So, in this example, the function returns no value and takes 2 "in" params - ColumnWidth is a float, and RulerStule is an int. + typeDescs(tuple[Any, ...]):A sequence of tuples describing the types of the parameters for the function. See the comments for more information. + args(tuple[Any, ...]):The args to the function.CommentsThe Microsoft documentation for IDispatch should be used for all params except 'resultTypeDesc' and 'typeDescs'. 'resultTypeDesc' describes the return value of the function, and is a tuple of (type_id, flags). 'typeDescs' describes the type of each parameters, and is a list of the same (type_id, flags) tuple.itemDescriptiontype_idA valid "variant type" constant (eg, VT_I4 | VT_ARRAY, VT_DATE, etc - see VARIANT at MSDN).flagsOne of the PARAMFLAG constants (eg, PARAMFLAG_FIN, PARAMFLAG_FOUT etc - see PARAMFLAG at MSDN).ExampleAn example from the makepy generated file for Wordclass Cells(DispatchBaseClass):... def SetWidth(self, ColumnWidth=..., RulerStyle=...): return self._oleobj_.InvokeTypes(202, LCID, 1, (24, 0), ((4, 1), (3, 1)),...)The interesting bits areresultTypeDesc: (24, 0) - (VT_VOID, <no flags>)typeDescs: ((4, 1), (3, 1)) - ((VT_R4, PARAMFLAG_FIN), (VT_I4, PARAMFLAG_FIN))So, in this example, the function returns no value and takes 2 "in" params - ColumnWidth is a float, and RulerStule is an int. Returns: @@ -16977,7 +16977,7 @@ Returns: """ ... - def GetIDsOfNames(self, name: str, arg: Any) -> Tuple[Any, Any]: + def GetIDsOfNames(self, name: str, arg: Any) -> tuple[Any, Any]: """ Get the DISPID for the passed names. @@ -16988,7 +16988,7 @@ Args: Returns: - Tuple[Any, Any]:A sequence of string names to query + tuple[Any, Any]:A sequence of string names to query Comments Currently the LCID can not be specified, and LOCALE_SYSTEM_DEFAULT is used. @@ -17061,8 +17061,8 @@ Returns: dispid: Any, lcid: Any, flags: Any, - args: List[Any], - types: List[Any] = None, + args: list[Any], + types: list[Any] = None, returnDesc: Any = 1, serviceProvider: Any = None) -> Any: """ @@ -17073,8 +17073,8 @@ Args: dispid(Any): lcid(Any): flags(Any): - args(List[Any]):The arguments. - types(List[Any]):A tuple of type description object, or None if type descriptions are not available. + args(list[Any]):The arguments. + types(list[Any]):A tuple of type description object, or None if type descriptions are not available. returnDesc(Any):If types==None, should be a BOOL indicating if the result is needed. If types is a tuple, then should a be type description. serviceProvider(Any):A service provider object supplied by the caller which allows the object to obtain services from the caller. Can be None. @@ -17177,14 +17177,14 @@ class PyIDocHostUIHandler: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def ShowContextMenu(self, dwID: Any, pt: Tuple[Any, Any], pcmdtReserved: Any, pdispReserved: Any) -> None: + def ShowContextMenu(self, dwID: Any, pt: tuple[Any, Any], pcmdtReserved: Any, pdispReserved: Any) -> None: """ Description of ShowContextMenu. Args: dwID(Any):Description for dwID - pt(Tuple[Any, Any]):Description for ppt + pt(tuple[Any, Any]):Description for ppt pcmdtReserved(Any):Description for pcmdtReserved pdispReserved(Any):Description for pdispReserved @@ -17304,13 +17304,13 @@ Returns: """ ... - def ResizeBorder(self, prcBorder: Tuple[Any, Any, Any, Any], pUIWindow: Any, fRameWindow: Any) -> None: + def ResizeBorder(self, prcBorder: tuple[Any, Any, Any, Any], pUIWindow: Any, fRameWindow: Any) -> None: """ Description of ResizeBorder. Args: - prcBorder(Tuple[Any, Any, Any, Any]):Description for prcBorder + prcBorder(tuple[Any, Any, Any, Any]):Description for prcBorder pUIWindow(Any):Description for pUIWindow fRameWindow(Any):Description for fRameWindow @@ -17459,7 +17459,7 @@ class PyIDropTarget: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def DragEnter(self, pDataObj: Any, grfKeyState: Any, pt: Tuple[Any, Any], pdwEffect: Any) -> Any: + def DragEnter(self, pDataObj: Any, grfKeyState: Any, pt: tuple[Any, Any], pdwEffect: Any) -> Any: """ Called when an object is initially dragged into a window @@ -17467,7 +17467,7 @@ Args: pDataObj(Any):IDataObject interface that contains the object being dragged grfKeyState(Any):Combination of win32con.MK_* flags containing keyboard modifier state - pt(Tuple[Any, Any]):(x,y) Screen coordinates of cursor + pt(tuple[Any, Any]):(x,y) Screen coordinates of cursor pdwEffect(Any):shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return a shellcon.DROPEFFECT_* value indicating if the object can be accepted Returns: @@ -17480,14 +17480,14 @@ be accepted """ ... - def DragOver(self, grfKeyState: Any, pt: Tuple[Any, Any], pdwEffect: Any) -> Any: + def DragOver(self, grfKeyState: Any, pt: tuple[Any, Any], pdwEffect: Any) -> Any: """ Called as the dragged object moves over the window Args: grfKeyState(Any):Combination of win32con.MK_* flags containing keyboard modifier state - pt(Tuple[Any, Any]):(x,y) Screen coordinates of cursor + pt(tuple[Any, Any]):(x,y) Screen coordinates of cursor pdwEffect(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 Returns: @@ -17515,7 +17515,7 @@ Returns: """ ... - def Drop(self, pDataObj: Any, grfKeyState: Any, pt: Tuple[Any, Any], dwEffect: Any) -> Any: + def Drop(self, pDataObj: Any, grfKeyState: Any, pt: tuple[Any, Any], dwEffect: Any) -> Any: """ Called when the object is dropped onto the window @@ -17523,7 +17523,7 @@ Args: pDataObj(Any):IDataObject interface containing the dropped object grfKeyState(Any):Combination of win32con.MK_* flags containing keyboard modifier state - pt(Tuple[Any, Any]):(x,y) Screen coordinates of cursor + pt(tuple[Any, Any]):(x,y) Screen coordinates of cursor dwEffect(Any):shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return one of the shellcon.DROPEFFECT_* values Returns: @@ -17541,7 +17541,7 @@ class PyIDropTargetHelper: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def DragEnter(self, hwnd: int, pDataObj: Any, pt: Tuple[Any, Any], dwEffect: Any) -> None: + def DragEnter(self, hwnd: int, pDataObj: Any, pt: tuple[Any, Any], dwEffect: Any) -> None: """ Description of DragEnter. @@ -17549,7 +17549,7 @@ Args: hwnd(int):Handle to target window pDataObj(Any):Object that is dragged onto the window - pt(Tuple[Any, Any]):Coordinates where drag operation entered the window + pt(tuple[Any, Any]):Coordinates where drag operation entered the window dwEffect(Any):One of shellcon.DROPEFFECT_* values Returns: @@ -17559,14 +17559,14 @@ Returns: """ ... - def DragOver(self, hwnd: Any, pt: Tuple[Any, Any], pdwEffect: Any) -> None: + def DragOver(self, hwnd: Any, pt: tuple[Any, Any], pdwEffect: Any) -> None: """ Description of DragOver. Args: hwnd(Any): - pt(Tuple[Any, Any]):Description for pt + pt(tuple[Any, Any]):Description for pt pdwEffect(Any):Description for pdwEffect Returns: @@ -17591,14 +17591,14 @@ Returns: """ ... - def Drop(self, pDataObj: Any, pt: Tuple[Any, Any], dwEffect: Any) -> None: + def Drop(self, pDataObj: Any, pt: tuple[Any, Any], dwEffect: Any) -> None: """ Description of Drop. Args: pDataObj(Any):Description for pDataObj - pt(Tuple[Any, Any]):Description for pt + pt(tuple[Any, Any]):Description for pt dwEffect(Any):Description for dwEffect Returns: @@ -17619,7 +17619,7 @@ class PyIDsObjectPicker: targetComputer: str, scopeInfos: Any, options: Any = 0, - attrNames: List[str] = None) -> None: + attrNames: list[str] = None) -> None: """ Initializes the IDsObjectPicker interface with information about the scopes, filters, and options used by the object picker dialog box. @@ -17628,7 +17628,7 @@ Args: targetComputer(str): scopeInfos(Any): options(Any): - attrNames(List[str]): + attrNames(list[str]): Returns: @@ -17720,7 +17720,7 @@ class PyIEnumCATEGORYINFO: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: Any = 1) -> Tuple[Tuple[PyIID, Any, str], ...]: + def Next(self, num: Any = 1) -> tuple[tuple[PyIID, Any, str], ...]: """ Retrieves a specified number of items in the @@ -17732,7 +17732,7 @@ Args: Returns: - Tuple[Tuple[PyIID, Any, str], ...]:Number of items to retrieve. + tuple[tuple[PyIID, Any, str], ...]:Number of items to retrieve. Return ValueThe result is a tuple of (IID object, LCID, string description) tuples, one for each element returned. @@ -17795,7 +17795,7 @@ class PyIEnumConnectionPoints: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: Any = 1) -> Tuple[Any, ...]: + def Next(self, num: Any = 1) -> tuple[Any, ...]: """ Retrieves a specified number of items in the @@ -17807,7 +17807,7 @@ Args: Returns: - Tuple[Any, ...] + tuple[Any, ...] """ ... @@ -17935,7 +17935,7 @@ class PyIEnumContextProps: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: Any = 1) -> Tuple[Tuple[PyIID, Any, Any], ...]: + def Next(self, num: Any = 1) -> tuple[tuple[PyIID, Any, Any], ...]: """ Retrieves a specified number of items in @@ -17947,7 +17947,7 @@ Args: Returns: - Tuple[Tuple[PyIID, Any, Any], ...]:Number of items to retrieve. + tuple[tuple[PyIID, Any, Any], ...]:Number of items to retrieve. 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 @@ -18512,7 +18512,7 @@ class PyIEnumGUID: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: Any = 1) -> Tuple[PyIID, ...]: + def Next(self, num: Any = 1) -> tuple[PyIID, ...]: """ Retrieves a specified number of items in the enumeration sequence. @@ -18522,7 +18522,7 @@ Args: Returns: - Tuple[PyIID, ...]:Number of items to retrieve. + tuple[PyIID, ...]:Number of items to retrieve. 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 @@ -18731,7 +18731,7 @@ class PyIEnumObjects: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, riid: PyIID, num: Any = 1) -> Tuple[Any, ...]: + def Next(self, riid: PyIID, num: Any = 1) -> tuple[Any, ...]: """ Retrieves a specified number of items in the enumeration sequence. @@ -18742,7 +18742,7 @@ Args: Returns: - Tuple[Any, ...] + tuple[Any, ...] """ ... @@ -19149,7 +19149,7 @@ class PyIEnumSTATSTG: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: Any = 1) -> Tuple[Any, ...]: + def Next(self, num: Any = 1) -> tuple[Any, ...]: """ Retrieves a specified number of items in the enumeration sequence. @@ -19159,7 +19159,7 @@ Args: Returns: - Tuple[Any, ...] + tuple[Any, ...] """ ... @@ -19218,7 +19218,7 @@ class PyIEnumShellItems: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: Any = 1) -> Tuple[Any, ...]: + def Next(self, num: Any = 1) -> tuple[Any, ...]: """ Retrieves a specified number of items in the enumeration @@ -19230,7 +19230,7 @@ Args: Returns: - Tuple[Any, ...] + tuple[Any, ...] """ ... @@ -19289,7 +19289,7 @@ class PyIEnumString: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Next(self, num: Any = 1) -> Tuple[str, ...]: + def Next(self, num: Any = 1) -> tuple[str, ...]: """ Retrieves a specified number of items in the enumeration sequence. @@ -19299,7 +19299,7 @@ Args: Returns: - Tuple[str, ...] + tuple[str, ...] """ ... @@ -19970,14 +19970,14 @@ class PyIExtractImage: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetLocation(self, dwPriority: Any, size: Tuple[Any, Any], dwRecClrDepth: Any, pdwFlags: Any) -> None: + def GetLocation(self, dwPriority: Any, size: tuple[Any, Any], dwRecClrDepth: Any, pdwFlags: Any) -> None: """ Description of GetLocation. Args: dwPriority(Any):Description for dwPriority - size(Tuple[Any, Any]):Description for prgSize + size(tuple[Any, Any]):Description for prgSize dwRecClrDepth(Any):Description for dwRecClrDepth pdwFlags(Any):Description for pdwFlags @@ -21168,7 +21168,7 @@ Returns: """ ... - def GetFolderIds(self) -> Tuple[PyIID, ...]: + def GetFolderIds(self) -> tuple[PyIID, ...]: """ Retrieves all known folder ids. @@ -21178,7 +21178,7 @@ Args: Returns: - Tuple[PyIID, ...] + tuple[PyIID, ...] """ ... @@ -21283,7 +21283,7 @@ Returns: hwnd: int, flags: Any, TargetPath: Any, - Exclusion: Tuple[PyIID, ...]) -> None: + Exclusion: tuple[PyIID, ...]) -> None: """ Redirects a known folder to an alternate location @@ -21293,7 +21293,7 @@ Args: hwnd(int):Handle of window to be used for user interaction flags(Any):Combination of KF_REDIRECT_* flags TargetPath(Any):Path to which the known folder will be redirected - Exclusion(Tuple[PyIID, ...]):Sequence of known folder ids of subfolders to be excluded from redirection + Exclusion(tuple[PyIID, ...]):Sequence of known folder ids of subfolders to be excluded from redirection Returns: @@ -21646,7 +21646,7 @@ class PyIMAPIProp: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetProps(self, propList: Any, flags: Any = 0) -> Tuple[Any, Any, Any]: + def GetProps(self, propList: Any, flags: Any = 0) -> tuple[Any, Any, Any]: """ Returns a list of property values. @@ -21657,12 +21657,12 @@ Args: Returns: - Tuple[Any, Any, Any] + tuple[Any, Any, Any] """ ... - def DeleteProps(self, propList: Any, wantProblems: Any = False) -> Tuple[Any, Any, Any]: + def DeleteProps(self, propList: Any, wantProblems: Any = False) -> tuple[Any, Any, Any]: """ Deletes a set of properties. @@ -21673,43 +21673,43 @@ Args: Returns: - Tuple[Any, Any, Any] + tuple[Any, Any, Any] """ ... - def SetProps(self, propList: Tuple[Any, Any], wantProblems: Any = False) -> Tuple[Any, Any, Any]: + def SetProps(self, propList: tuple[Any, Any], wantProblems: Any = False) -> tuple[Any, Any, Any]: """ Sets a set of properties. Args: - propList(Tuple[Any, Any]):The list of properties + propList(tuple[Any, Any]):The list of properties wantProblems(Any):Return detailed error information Returns: - Tuple[Any, Any, Any] + tuple[Any, Any, Any] """ ... def CopyTo( self, - IIDExcludeList: Tuple[Any, Any], + IIDExcludeList: tuple[Any, Any], propTags: Any, uiParam: Any, progress: Any, resultIID: PyIID, dest: Any, flags: Any, - wantProblems: Any = False) -> Tuple[Any, Any, Any]: + wantProblems: Any = False) -> tuple[Any, Any, Any]: """ Copies an object to another Args: - IIDExcludeList(Tuple[Any, Any]):A sequence of IIDs to exclude. + IIDExcludeList(tuple[Any, Any]):A sequence of IIDs to exclude. propTags(Any):The property tags to exclude. uiParam(Any):Handle to the parent window of the progress object progress(Any):Reserved - must ... None @@ -21720,13 +21720,13 @@ Args: Returns: - Tuple[Any, Any, Any] + tuple[Any, Any, Any] """ ... def CopyProps(self, propTags: Any, uiParam: Any, progress: Any, resultIID: PyIID, - dest: Any, flags: Any, wantProblems: Any = False) -> Tuple[Any, Any, Any]: + dest: Any, flags: Any, wantProblems: Any = False) -> tuple[Any, Any, Any]: """ Copies a set of properties to another object @@ -21742,7 +21742,7 @@ Args: Returns: - Tuple[Any, Any, Any] + tuple[Any, Any, Any] """ ... @@ -21781,7 +21781,7 @@ Returns: """ ... - def GetNamesFromIDs(self, propTags: Any, propSetGuid: PyIID = None, flags: Any = 0) -> Tuple[Any, Any, Any]: + def GetNamesFromIDs(self, propTags: Any, propSetGuid: PyIID = None, flags: Any = 0) -> tuple[Any, Any, Any]: """ Determines property names @@ -21793,7 +21793,7 @@ Args: Returns: - Tuple[Any, Any, Any] + tuple[Any, Any, Any] """ ... @@ -22560,7 +22560,7 @@ Returns: """ ... - def CreateAttach(self, interface: PyIID, flags: Any) -> Tuple[Any, Any]: + def CreateAttach(self, interface: PyIID, flags: Any) -> tuple[Any, Any]: """ Creates an attachment @@ -22571,7 +22571,7 @@ Args: Returns: - Tuple[Any, Any]:Bitmask of flags that controls how the attachment is created.Return ValueThe result is a tuple of (attachmentNum, attachmentObject) + tuple[Any, Any]:Bitmask of flags that controls how the attachment is created.Return ValueThe result is a tuple of (attachmentNum, attachmentObject) """ @@ -22826,7 +22826,7 @@ Returns: """ ... - def ConfigureMsgService(self, iid: PyIID, ulUIParam: Any, ulFlags: Any, arg: List[Any]) -> None: + def ConfigureMsgService(self, iid: PyIID, ulUIParam: Any, ulFlags: Any, arg: list[Any]) -> None: """ Reconfigures a message service. @@ -22835,7 +22835,7 @@ Args: iid(PyIID):The unique identifier for the message service to configure. ulUIParam(Any):Handle of the parent window for the configuration property sheet. ulFlags(Any):Bitmask of flags that controls the display of the property sheet. - arg(List[Any]):Property values describing the properties to display in the property sheet. Should not be None if the service is to be configured without a message service. + arg(list[Any]):Property values describing the properties to display in the property sheet. Should not be None if the service is to be configured without a message service. Returns: @@ -22964,7 +22964,7 @@ Returns: """ ... - def GetReceiveFolder(self, messageClass: str = None, flags: Any = 0) -> Tuple[PyIID, str]: + def GetReceiveFolder(self, messageClass: str = None, flags: Any = 0) -> tuple[PyIID, str]: """ Obtains the folder that was established as the destination for incoming messages of a specified message class or the default receive folder for the message store. @@ -22975,7 +22975,7 @@ Args: Returns: - Tuple[PyIID, str] + tuple[PyIID, str] """ ... @@ -23085,14 +23085,14 @@ class PyINameSpaceTreeControl: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Initialize(self, hwndParent: Any, prc: Tuple[Any, Any, Any, Any], nsctsFlags: Any) -> None: + def Initialize(self, hwndParent: Any, prc: tuple[Any, Any, Any, Any], nsctsFlags: Any) -> None: """ Description of Initialize. Args: hwndParent(Any):Description for hwndParent - prc(Tuple[Any, Any, Any, Any]):Description for prc + prc(tuple[Any, Any, Any, Any]):Description for prc nsctsFlags(Any):Description for nsctsFlags Returns: @@ -23339,13 +23339,13 @@ Returns: """ ... - def HitTest(self, pt: Tuple[Any, Any]) -> None: + def HitTest(self, pt: tuple[Any, Any]) -> None: """ Description of HitTest. Args: - pt(Tuple[Any, Any]):Description for ppt + pt(tuple[Any, Any]):Description for ppt Returns: @@ -23886,16 +23886,16 @@ Returns: def TransformCoords( self, - PtlHimetric: Tuple[Any, Any], - pPtfContainer: Tuple[float, float], + PtlHimetric: tuple[Any, Any], + pPtfContainer: tuple[float, float], dwFlags: Any) -> None: """ Description of TransformCoords. Args: - PtlHimetric(Tuple[Any, Any]):Description for pPtlHimetric - pPtfContainer(Tuple[float, float]):Description for pPtfContainer + PtlHimetric(tuple[Any, Any]):Description for pPtlHimetric + pPtfContainer(tuple[float, float]):Description for pPtfContainer dwFlags(Any):Description for dwFlagsReturn ValueThe result is a tuple of the transformed input points - ie, a tuple of ((int, int), (float, float)) Returns: @@ -24006,13 +24006,13 @@ Returns: """ ... - def ResizeBorder(self, rcBorder: Tuple[Any, Any, Any, Any], pUIWindow: Any, fFrameWindow: Any) -> None: + def ResizeBorder(self, rcBorder: tuple[Any, Any, Any, Any], pUIWindow: Any, fFrameWindow: Any) -> None: """ Description of ResizeBorder. Args: - rcBorder(Tuple[Any, Any, Any, Any]):Description for prcBorder + rcBorder(tuple[Any, Any, Any, Any]):Description for prcBorder pUIWindow(Any):Description for pUIWindow fFrameWindow(Any):Description for fFrameWindow @@ -24497,14 +24497,14 @@ Returns: """ ... - def GetDC(self, grfFlags: Any, rect: Tuple[Any, Any, Any, Any]) -> None: + def GetDC(self, grfFlags: Any, rect: tuple[Any, Any, Any, Any]) -> None: """ Description of GetDC. Args: grfFlags(Any):Description for grfFlags - rect(Tuple[Any, Any, Any, Any]): + rect(tuple[Any, Any, Any, Any]): Returns: @@ -24528,13 +24528,13 @@ Returns: """ ... - def InvalidateRect(self, rect: Tuple[Any, Any, Any, Any], fErase: Any) -> None: + def InvalidateRect(self, rect: tuple[Any, Any, Any, Any], fErase: Any) -> None: """ Description of InvalidateRect. Args: - rect(Tuple[Any, Any, Any, Any]): + rect(tuple[Any, Any, Any, Any]): fErase(Any):Description for fErase Returns: @@ -24630,13 +24630,13 @@ Returns: """ ... - def RequestBorderSpace(self, borderwidths: Tuple[Any, Any, Any, Any]) -> None: + def RequestBorderSpace(self, borderwidths: tuple[Any, Any, Any, Any]) -> None: """ Description of RequestBorderSpace. Args: - borderwidths(Tuple[Any, Any, Any, Any]):Description for pborderwidths + borderwidths(tuple[Any, Any, Any, Any]):Description for pborderwidths Returns: @@ -24645,13 +24645,13 @@ Returns: """ ... - def SetBorderSpace(self, borderwidths: Tuple[Any, Any, Any, Any]) -> None: + def SetBorderSpace(self, borderwidths: tuple[Any, Any, Any, Any]) -> None: """ Description of SetBorderSpace. Args: - borderwidths(Tuple[Any, Any, Any, Any]):Description for pborderwidths + borderwidths(tuple[Any, Any, Any, Any]):Description for pborderwidths Returns: @@ -24809,7 +24809,7 @@ Returns: ... def DoVerb(self, iVerb: Any, msg: PyMSG, pActiveSite: Any, lindex: Any, - hwndParent: Any, rect: Tuple[Any, Any, Any, Any]) -> None: + hwndParent: Any, rect: tuple[Any, Any, Any, Any]) -> None: """ Description of DoVerb. @@ -24820,7 +24820,7 @@ Args: pActiveSite(Any):Description for pActiveSite lindex(Any):Description for lindex hwndParent(Any):Description for hwndParent - rect(Tuple[Any, Any, Any, Any]): + rect(tuple[Any, Any, Any, Any]): Returns: @@ -24904,14 +24904,14 @@ Returns: """ ... - def SetExtent(self, dwDrawAspect: Any, size: Tuple[Any, Any]) -> None: + def SetExtent(self, dwDrawAspect: Any, size: tuple[Any, Any]) -> None: """ Description of SetExtent. Args: dwDrawAspect(Any):Description for dwDrawAspect - size(Tuple[Any, Any]):Size limit for the object. + size(tuple[Any, Any]):Size limit for the object. Returns: @@ -24920,14 +24920,14 @@ Returns: """ ... - def GetExtent(self, dwDrawAspect: Any, size: Tuple[Any, Any]) -> None: + def GetExtent(self, dwDrawAspect: Any, size: tuple[Any, Any]) -> None: """ Description of GetExtent. Args: dwDrawAspect(Any):Description for dwDrawAspect - size(Tuple[Any, Any]):Size limit for the object. + size(tuple[Any, Any]):Size limit for the object. Returns: @@ -26103,7 +26103,7 @@ Returns: """ ... - def GetRelativeDescription(self, var1: Any, var2: Any) -> Tuple[Any, Any]: + def GetRelativeDescription(self, var1: Any, var2: Any) -> tuple[Any, Any]: """ Compares two values @@ -26114,7 +26114,7 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... @@ -26168,7 +26168,7 @@ Returns: """ ... - def GetConditionType(self) -> Tuple[Any, Any]: + def GetConditionType(self) -> tuple[Any, Any]: """ Returns options that determine how the property is used @@ -26180,7 +26180,7 @@ Args: Returns: - Tuple[Any, Any]:PyIPropertyDescription.GetConditionType + tuple[Any, Any]:PyIPropertyDescription.GetConditionType (int, int) = GetConditionType()Returns options that determine how the property is used @@ -26639,30 +26639,30 @@ Supports iteration to list properties.""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def ReadMultiple(self, props: Tuple[Any, ...]) -> Tuple[Any, ...]: + def ReadMultiple(self, props: tuple[Any, ...]) -> tuple[Any, ...]: """ Reads specified properties from the current property set. Args: - props(Tuple[Any, ...]):Sequence of property IDs or names.Return ValueReturned values are automatically converted to an appropriate python type + props(tuple[Any, ...]):Sequence of property IDs or names.Return ValueReturned values are automatically converted to an appropriate python type Returns: - Tuple[Any, ...]:Sequence of property IDs or names.Return ValueReturned values are automatically converted to an appropriate python type + tuple[Any, ...]:Sequence of property IDs or names.Return ValueReturned values are automatically converted to an appropriate python type """ ... - def WriteMultiple(self, props: Tuple[Any, ...], values: Tuple[Any, ...], propidNameFirst: Any = 2) -> None: + def WriteMultiple(self, props: tuple[Any, ...], values: tuple[Any, ...], propidNameFirst: Any = 2) -> None: """ Creates or modifies properties in the property set Args: - props(Tuple[Any, ...]):Sequence containing names or integer ids of properties to write - values(Tuple[Any, ...]):The values for the properties. + props(tuple[Any, ...]):Sequence containing names or integer ids of properties to write + values(tuple[Any, ...]):The values for the properties. propidNameFirst(Any):Minimum property id to be assigned to new properties specified by name Returns: @@ -26672,13 +26672,13 @@ Returns: """ ... - def DeleteMultiple(self, props: Tuple[Any, ...]) -> None: + def DeleteMultiple(self, props: tuple[Any, ...]) -> None: """ Deletes properties from the property set Args: - props(Tuple[Any, ...]):Sequence containing names or IDs of properties to be deleted + props(tuple[Any, ...]):Sequence containing names or IDs of properties to be deleted Returns: @@ -26687,7 +26687,7 @@ Returns: """ ... - def ReadPropertyNames(self, props: Tuple[Any, ...]) -> Tuple[Any, ...]: + def ReadPropertyNames(self, props: tuple[Any, ...]) -> tuple[Any, ...]: """ Retrieves any existing string names for the specified @@ -26695,16 +26695,16 @@ property identifiers. Args: - props(Tuple[Any, ...]):Sequence of ints containing property IDs. + props(tuple[Any, ...]):Sequence of ints containing property IDs. Returns: - Tuple[Any, ...] + tuple[Any, ...] """ ... - def WritePropertyNames(self, props: Tuple[Any, ...], names: Tuple[str, ...]) -> None: + def WritePropertyNames(self, props: tuple[Any, ...], names: tuple[str, ...]) -> None: """ Assigns string names to a specified array of property IDs in the @@ -26712,8 +26712,8 @@ current property set. Args: - props(Tuple[Any, ...]):Sequence containing the property IDs. - names(Tuple[str, ...]):Equal length sequence of property names. + props(tuple[Any, ...]):Sequence containing the property IDs. + names(tuple[str, ...]):Equal length sequence of property names. Returns: @@ -26722,13 +26722,13 @@ Returns: """ ... - def DeletePropertyNames(self, props: Tuple[Any, ...]) -> None: + def DeletePropertyNames(self, props: tuple[Any, ...]) -> None: """ Removes property names from specified properties. Args: - props(Tuple[Any, ...]):Sequence of ints containing property IDs. + props(tuple[Any, ...]):Sequence of ints containing property IDs. Returns: @@ -26938,7 +26938,7 @@ Returns: """ ... - def GetValueAndState(self, key: Any) -> Tuple[Any, Any]: + def GetValueAndState(self, key: Any) -> tuple[Any, Any]: """ Retrieves the current value and state of a @@ -26950,7 +26950,7 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... @@ -27935,7 +27935,7 @@ class PyIScheduledWorkItem: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CreateTrigger(self) -> Tuple[Any, Any]: + def CreateTrigger(self) -> tuple[Any, Any]: """ Creates a new trigger for a task, returns index and @@ -27947,7 +27947,7 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... @@ -28014,7 +28014,7 @@ Returns: """ ... - def GetRunTimes(self, Count: Any, Begin: PyTime, End: PyTime) -> Tuple[PyTime, Any, Any, Any]: + def GetRunTimes(self, Count: Any, Begin: PyTime, End: PyTime) -> tuple[PyTime, Any, Any, Any]: """ Return specified number of run times within given time @@ -28028,7 +28028,7 @@ Args: Returns: - Tuple[PyTime, Any, Any, Any] + tuple[PyTime, Any, Any, Any] """ ... @@ -28064,7 +28064,7 @@ Returns: """ ... - def GetIdleWait(self) -> Tuple[Any, Any]: + def GetIdleWait(self) -> tuple[Any, Any]: """ Gets IdleMinutes and DeadlineMinutes parms for task with trigger @@ -28076,7 +28076,7 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... @@ -28157,7 +28157,7 @@ Returns: """ ... - def GetExitCode(self) -> Tuple[Any, Any]: + def GetExitCode(self) -> tuple[Any, Any]: """ Returns tuple of task's exit code and error returned to Task @@ -28169,7 +28169,7 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... @@ -28501,7 +28501,7 @@ namespace extensions.""" Args: hmenuShared(int):Newly created menu that contains no items - lpMenuWidths(Any):Tuple of 6 ints. Items 0,2,and 4 are updated when the tuple is returned. + lpMenuWidths(Any):tuple of 6 ints. Items 0,2,and 4 are updated when the tuple is returned. Returns: @@ -28842,13 +28842,13 @@ Returns: """ ... - def GetAttributesOf(self, pidl: Tuple[Any, ...], rgfInOut: Any) -> Any: + def GetAttributesOf(self, pidl: tuple[Any, ...], rgfInOut: Any) -> Any: """ Queries attributes of items within the shell folder Args: - pidl(Tuple[Any, ...]):A sequence of single-level pidls identifying items directly contained by the folder + pidl(tuple[Any, ...]):A sequence of single-level pidls identifying items directly contained by the folder rgfInOut(Any):Combination of shellcon.SFGAO_* constantsReturn ValueThe requested attributes are only returned if they are common to all of the specified items Returns: @@ -28862,10 +28862,10 @@ Returns: def GetUIObjectOf( self, hwndOwner: int, - pidl: Tuple[Any, ...], + pidl: tuple[Any, ...], riid: PyIID, iidout: PyIID, - Reserved: Any = 0) -> Tuple[Any, Any]: + Reserved: Any = 0) -> tuple[Any, Any]: """ Creates an interface to one or more items in a shell @@ -28874,14 +28874,14 @@ folder Args: hwndOwner(int):Specifies a window in which to display any required dialogs or errors, can be 0 - pidl(Tuple[Any, ...]):A sequence of single-level pidls identifying items in the folder + pidl(tuple[Any, ...]):A sequence of single-level pidls identifying items in the folder riid(PyIID):The interface to create, one of IID_IContextMenu, IID_IContextMenu2, IID_IDataObject, IID_IDropTarget, IID_IExtractIcon, IID_IQueryInfo iidout(PyIID):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 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 Reserved(Any):Reserved, use 0 if passed in Returns: - Tuple[Any, Any]:The interface to return. Can be used in the case where there is not a + tuple[Any, Any]: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 @@ -28967,7 +28967,7 @@ Returns: """ ... - def GetDefaultColumn(self) -> Tuple[Any, Any]: + def GetDefaultColumn(self) -> tuple[Any, Any]: """ Returns the columns used for sorting and display @@ -28977,7 +28977,7 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... @@ -29015,7 +29015,7 @@ Returns: """ ... - def GetDetailsOf(self, pidl: Any, iColumn: Any) -> Tuple[Any, Any, Any]: + def GetDetailsOf(self, pidl: Any, iColumn: Any) -> tuple[Any, Any, Any]: """ Returns the value or title of a column in the folder's Details @@ -29028,7 +29028,7 @@ Args: Returns: - Tuple[Any, Any, Any]:Zero based index of columnReturn ValueReturns a tuple representing a SHELLDETAILS struct, containing the formst (LVCFMT_*), column width in + tuple[Any, Any, Any]:Zero based index of columnReturn ValueReturns a tuple representing a SHELLDETAILS struct, containing the formst (LVCFMT_*), column width in characters, @@ -29145,7 +29145,7 @@ Python's True and False should not be used, as S_OK==0==False. """ ... - def GetOverlayInfo(self) -> Tuple[str, Any, Any]: + def GetOverlayInfo(self) -> tuple[str, Any, Any]: """ Retrieves the path to the overlay @@ -29157,7 +29157,7 @@ Args: Returns: - Tuple[str, Any, Any]:PyIShellIconOverlayIdentifier.GetOverlayInfo + tuple[str, Any, Any]:PyIShellIconOverlayIdentifier.GetOverlayInfo (PyUnicode, int, int) = GetOverlayInfo()Retrieves the path to the overlay @@ -29389,7 +29389,7 @@ Returns: """ ... - def GetPropertyStoreForKeys(self, Keys: Tuple[Any, ...], Flags: Any, riid: PyIID) -> Any: + def GetPropertyStoreForKeys(self, Keys: tuple[Any, ...], Flags: Any, riid: PyIID) -> Any: """ Creates a property store containing just the @@ -29397,7 +29397,7 @@ specified properties of the item Args: - Keys(Tuple[Any, ...]):A sequence of property identifiers + Keys(tuple[Any, ...]):A sequence of property identifiers Flags(Any):Combination of GETPROPERTYSTOREFLAGS values (shellcon.GPS_*) riid(PyIID):The interface to return @@ -30155,7 +30155,7 @@ class PyIShellLink: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetPath(self, fFlags: Any, cchMaxPath: Any) -> Tuple[Any, WIN32_FIND_DATA]: + def GetPath(self, fFlags: Any, cchMaxPath: Any) -> tuple[Any, WIN32_FIND_DATA]: """ Retrieves the target path and file name of a shell link @@ -30168,7 +30168,7 @@ Args: Returns: - Tuple[Any, WIN32_FIND_DATA] + tuple[Any, WIN32_FIND_DATA] """ ... @@ -30592,18 +30592,18 @@ Returns: def CreateViewWindow( self, psvPrevious: Any, - pfs: Tuple[Any, Any], + pfs: tuple[Any, Any], psb: Any, - prcView: Tuple[Any, Any, Any, Any]) -> Any: + prcView: tuple[Any, Any, Any, Any]) -> Any: """ Description of CreateViewWindow. Args: psvPrevious(Any):Description for psvPrevious - pfs(Tuple[Any, Any]):Description for pfs + pfs(tuple[Any, Any]):Description for pfs psb(Any):Description for psb - prcView(Tuple[Any, Any, Any, Any]):Description for prcViewReturn ValueThe result is an integer handle to the new window. + prcView(tuple[Any, Any, Any, Any]):Description for prcViewReturn ValueThe result is an integer handle to the new window. Returns: @@ -30802,13 +30802,13 @@ Returns: """ ... - def CopyTo(self, rgiidExclude: Tuple[Any, Any], snbExclude: Any, stgDest: Any) -> None: + def CopyTo(self, rgiidExclude: tuple[Any, Any], snbExclude: Any, stgDest: Any) -> None: """ Copies the entire contents of an open storage object to another storage object. Args: - rgiidExclude(Tuple[Any, Any]):List of IID's to be excluded. Use empty seq to exclude all objects, or None to indicate no excludes. + rgiidExclude(tuple[Any, Any]):list of IID's to be excluded. Use empty seq to exclude all objects, or None to indicate no excludes. snbExclude(Any):Reserved for later - Must be None stgDest(Any):The open storage object into which this storage object is to be copied. The destination storage object can be a different implementation of the PyIStorage interface from the source storage object. Thus, IStorage::CopyTo can only use publicly available methods of the destination storage object. If stgDest is open in transacted mode, it can be reverted by calling its PyIStorage::Revert method. @@ -31434,7 +31434,7 @@ Returns: """ ... - def Enum(self) -> Tuple[str, ...]: + def Enum(self) -> tuple[str, ...]: """ Retrieve list of task names @@ -31444,7 +31444,7 @@ Args: Returns: - Tuple[str, ...] + tuple[str, ...] """ ... @@ -31747,7 +31747,7 @@ Returns: """ ... - def FileFailure(self, Item: Any, ItemName: Any, Error: Any) -> Tuple[Any, Any]: + def FileFailure(self, Item: Any, ItemName: Any, Error: Any) -> tuple[Any, Any]: """ Notifies user of failure, and queries how to proceed @@ -31759,7 +31759,7 @@ Args: Returns: - Tuple[Any, Any]:HRESULT error code from operationReturn ValueReturns the HRESULT and new file name if renaming resolved the failure + tuple[Any, Any]:HRESULT error code from operationReturn ValueReturns the HRESULT and new file name if renaming resolved the failure """ @@ -31844,7 +31844,7 @@ Returns: ... def CreateItem(self, Name: Any, Attributes: Any, Size: Any, Flags: Any, - riidItem: PyIID, riidResources: PyIID) -> Tuple[Any, Any, Any]: + riidItem: PyIID, riidResources: PyIID) -> tuple[Any, Any, Any]: """ Requests that a new item be created @@ -31859,7 +31859,7 @@ Args: Returns: - Tuple[Any, Any, Any]:Resource interface to return + tuple[Any, Any, Any]:Resource interface to return Return ValueReturns the HRESULT and requested interfaces. Interfaces may be None if function returns one of the informational codes (shellcon.COPYENGINE_S_*) @@ -31927,7 +31927,7 @@ Returns: """ ... - def OpenItem(self, Item: Any, flags: Any, riid: PyIID) -> Tuple[Any, Any]: + def OpenItem(self, Item: Any, flags: Any, riid: PyIID) -> tuple[Any, Any]: """ Initiates the copying of an item @@ -31939,12 +31939,12 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... - def MoveItem(self, Item: Any, ParentDst: Any, NameDst: Any, flags: Any) -> Tuple[Any, Any]: + def MoveItem(self, Item: Any, ParentDst: Any, NameDst: Any, flags: Any) -> tuple[Any, Any]: """ Moves a shell item into another folder @@ -31957,7 +31957,7 @@ Args: Returns: - Tuple[Any, Any]:Combination of shellcon.TSF_* flagsReturn ValueReturns the HRESULT from the operation and the new shell item, which may be None + tuple[Any, Any]: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 @@ -31967,7 +31967,7 @@ of expected actions for specific error codes. """ ... - def RecycleItem(self, Source: Any, ParentDest: Any, flags: Any) -> Tuple[Any, Any]: + def RecycleItem(self, Source: Any, ParentDest: Any, flags: Any) -> tuple[Any, Any]: """ Moves an item to the recycle bin @@ -31979,7 +31979,7 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... @@ -32001,7 +32001,7 @@ Returns: """ ... - def RenameItem(self, Source: Any, NewName: Any, flags: Any) -> Tuple[Any, Any]: + def RenameItem(self, Source: Any, NewName: Any, flags: Any) -> tuple[Any, Any]: """ Renames a shell item @@ -32013,12 +32013,12 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... - def LinkItem(self, Source: Any, ParentDest: Any, NewName: Any, flags: Any) -> Tuple[Any, Any]: + def LinkItem(self, Source: Any, ParentDest: Any, NewName: Any, flags: Any) -> tuple[Any, Any]: """ Not implemented, according to MSDN @@ -32031,7 +32031,7 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... @@ -32147,7 +32147,7 @@ class PyITypeInfo: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetContainingTypeLib(self) -> Tuple[Any, Any]: + def GetContainingTypeLib(self) -> tuple[Any, Any]: """ Retrieves the containing type library and the index of @@ -32159,12 +32159,12 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... - def GetDocumentation(self, memberId: Any) -> Tuple[Any, Any, Any, Any]: + def GetDocumentation(self, memberId: Any) -> tuple[Any, Any, Any, Any]: """ Retrieves the documentation string, @@ -32176,7 +32176,7 @@ Args: Returns: - Tuple[Any, Any, Any, Any] + tuple[Any, Any, Any, Any] """ ... @@ -32562,8 +32562,8 @@ class PyIViewObject: aspectFlags: Any, hdcTargetDev: Any, hdcDraw: Any, - arg: Tuple[Any, Any, Any, Any], - arg1: Tuple[Any, Any, Any, Any], + arg: tuple[Any, Any, Any, Any], + arg1: tuple[Any, Any, Any, Any], funcContinue: Any, obContinue: Any) -> None: """ @@ -32576,8 +32576,8 @@ Args: aspectFlags(Any):Integer value for the dwFlags item of the DVASPECTINFO structure. hdcTargetDev(Any):Description for hdcTargetDev hdcDraw(Any):Description for hdcDraw - arg(Tuple[Any, Any, Any, Any]):Bounds rectangle. - arg1(Tuple[Any, Any, Any, Any]):WBounds rectangle. + arg(tuple[Any, Any, Any, Any]):Bounds rectangle. + arg1(tuple[Any, Any, Any, Any]):WBounds rectangle. funcContinue(Any):A continue function. obContinue(Any):Value passed to the function. @@ -32702,7 +32702,7 @@ class PyMAPINAMEIDArray: class PyOLEMENUGROUPWIDTHS: - """Tuple containing 6 ints indicating nbr of options in each menu group""" + """tuple containing 6 ints indicating nbr of options in each menu group""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @@ -32949,14 +32949,14 @@ class SHFILEOPSTRUCT: class SI_ACCESS: - """Tuple of 4 items representing SI_ACCESS struct""" + """tuple of 4 items representing SI_ACCESS struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') class SI_INHERIT_TYPE: - """Tuple of 3 items describing a method of inheritance""" + """tuple of 3 items describing a method of inheritance""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') @@ -33212,7 +33212,7 @@ Returns: """ ... - def GetSize(self) -> Tuple[Any, Any]: + def GetSize(self) -> tuple[Any, Any]: """ Returns the size of the bitmap object. @@ -33222,7 +33222,7 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... @@ -33294,15 +33294,15 @@ Returns: """ ... - def Paint(self, dcObject: Any, arg: Tuple[Any, Any, Any, Any], arg1: Tuple[Any, Any, Any, Any]) -> None: + def Paint(self, dcObject: Any, arg: tuple[Any, Any, Any, Any], arg1: tuple[Any, Any, Any, Any]) -> None: """ Paint a bitmap. Args: dcObject(Any):The DC object to paint the bitmap to. - arg(Tuple[Any, Any, Any, Any]):The destination rectangle to paint to. - arg1(Tuple[Any, Any, Any, Any]):The source rectangle to paint from. + arg(tuple[Any, Any, Any, Any]):The destination rectangle to paint to. + arg1(tuple[Any, Any, Any, Any]):The source rectangle to paint from. Returns: @@ -33420,7 +33420,7 @@ class PyCButton: self, caption: str, style: Any, - rect: Tuple[Any, Any, Any, Any], + rect: tuple[Any, Any, Any, Any], parent: Any, _id: Any) -> None: """ @@ -33430,7 +33430,7 @@ Args: caption(str):The caption (text) for the button. style(Any):The style for the button. Use any of the win32con.BS_* constants. - rect(Tuple[Any, Any, Any, Any]):The size and position of the button. + rect(tuple[Any, Any, Any, Any]):The size and position of the button. parent(Any):The parent window of the button. Usually a PyCDialog. _id(Any):The buttons control ID. @@ -33932,7 +33932,7 @@ Returns: """ ... - def GetCustomColors(self) -> Tuple[Any, ...]: + def GetCustomColors(self) -> tuple[Any, ...]: """ Gets the 16 currently defined custom colors @@ -33942,7 +33942,7 @@ Args: Returns: - Tuple[Any, ...] + tuple[Any, ...] """ ... @@ -34559,17 +34559,17 @@ Returns: def Arc( self, - rect: Tuple[Any, Any, Any, Any], - pointStart: Tuple[Any, Any], - pointEnd: Tuple[Any, Any]) -> None: + rect: tuple[Any, Any, Any, Any], + pointStart: tuple[Any, Any], + pointEnd: tuple[Any, Any]) -> None: """ Draws an eliptical arc. Args: - rect(Tuple[Any, Any, Any, Any]):Specifies the ellipse's bounding rectangle - pointStart(Tuple[Any, Any]):Specifies the x- and y-coordinates of the point that defines the arc's starting point (in logical units). This point does not have to lie exactly on the arc. - pointEnd(Tuple[Any, Any]):Specifies the x- and y-coordinates of the point that defines the arc's ending point (in logical units). This point does not have to lie exactly on the arc.CommentsThe arc drawn by using the function is a segment of the ellipse defined by the specified bounding rectangle. The actual starting point of the arc is the point at which a ray drawn from the center of the bounding rectangle through the specified starting point intersects the ellipse. The actual ending point of the arc is the point at which a ray drawn from the center of the bounding rectangle through the specified ending point intersects the ellipse. The arc is drawn in a counterclockwise direction. Since an arc is not a closed figure, it is not filled. Both the width and height of the rectangle must be greater than 2 units and less than 32,767 units.MFC References + rect(tuple[Any, Any, Any, Any]):Specifies the ellipse's bounding rectangle + pointStart(tuple[Any, Any]):Specifies the x- and y-coordinates of the point that defines the arc's starting point (in logical units). This point does not have to lie exactly on the arc. + pointEnd(tuple[Any, Any]):Specifies the x- and y-coordinates of the point that defines the arc's ending point (in logical units). This point does not have to lie exactly on the arc.CommentsThe arc drawn by using the function is a segment of the ellipse defined by the specified bounding rectangle. The actual starting point of the arc is the point at which a ray drawn from the center of the bounding rectangle through the specified starting point intersects the ellipse. The actual ending point of the arc is the point at which a ray drawn from the center of the bounding rectangle through the specified ending point intersects the ellipse. The arc is drawn in a counterclockwise direction. Since an arc is not a closed figure, it is not filled. Both the width and height of the rectangle must be greater than 2 units and less than 32,767 units.MFC References Returns: @@ -34597,20 +34597,20 @@ Returns: def BitBlt( self, - destPos: Tuple[Any, Any], - size: Tuple[Any, Any], + destPos: tuple[Any, Any], + size: tuple[Any, Any], dc: Any, - srcPos: Tuple[Any, Any], + srcPos: tuple[Any, Any], rop: Any) -> None: """ Copies a bitmap from the source device context to this device context. Args: - destPos(Tuple[Any, Any]):The logical x,y coordinates of the upper-left corner of the destination rectangle. - size(Tuple[Any, Any]):Specifies the width and height (in logical units) of the destination rectangle and source bitmap. + destPos(tuple[Any, Any]):The logical x,y coordinates of the upper-left corner of the destination rectangle. + size(tuple[Any, Any]):Specifies the width and height (in logical units) of the destination rectangle and source bitmap. dc(Any):Specifies the PyCDC object from which the bitmap will be copied. It must be None if rop specifies a raster operation that does not include a source. - srcPos(Tuple[Any, Any]):Specifies the logical x,y coordinates of the upper-left corner of the source bitmap. + srcPos(tuple[Any, Any]):Specifies the logical x,y coordinates of the upper-left corner of the source bitmap. rop(Any):Specifies the raster operation to be performed. See the win32 api documentation for details.MFC References Returns: @@ -34622,17 +34622,17 @@ Returns: def Chord( self, - rect: Tuple[Any, Any, Any, Any], - pointStart: Tuple[Any, Any], - pointEnd: Tuple[Any, Any]) -> None: + rect: tuple[Any, Any, Any, Any], + pointStart: tuple[Any, Any], + pointEnd: tuple[Any, Any]) -> None: """ Draws a chord. Args: - rect(Tuple[Any, Any, Any, Any]):Specifies the ellipse's bounding rectangle - pointStart(Tuple[Any, Any]):Specifies the x- and y-coordinates of the point that defines the arc's starting point (in logical units). This point does not have to lie exactly on the arc. - pointEnd(Tuple[Any, Any]):Specifies the x- and y-coordinates of the point that defines the arc's ending point (in logical units). This point does not have to lie exactly on the arc.CommentsDraws a chord (a closed figure bounded by the intersection of an ellipse and a line segment). The rect parameter specify the upper-left and lower-right corners, respectively, of a rectangle bounding the ellipse that is part of the chord. The pointStart and pointEnd parameters specify the endpoints of a line that intersects the ellipse. The chord is drawn by using the selected pen and filled by using the selected brush.MFC References + rect(tuple[Any, Any, Any, Any]):Specifies the ellipse's bounding rectangle + pointStart(tuple[Any, Any]):Specifies the x- and y-coordinates of the point that defines the arc's starting point (in logical units). This point does not have to lie exactly on the arc. + pointEnd(tuple[Any, Any]):Specifies the x- and y-coordinates of the point that defines the arc's ending point (in logical units). This point does not have to lie exactly on the arc.CommentsDraws a chord (a closed figure bounded by the intersection of an ellipse and a line segment). The rect parameter specify the upper-left and lower-right corners, respectively, of a rectangle bounding the ellipse that is part of the chord. The pointStart and pointEnd parameters specify the endpoints of a line that intersects the ellipse. The chord is drawn by using the selected pen and filled by using the selected brush.MFC References Returns: @@ -34688,19 +34688,19 @@ Returns: """ ... - def DPtoLP(self, point: Tuple[Any, Any], x: Any, y: Any) -> Tuple[Any, Any]: + def DPtoLP(self, point: tuple[Any, Any], x: Any, y: Any) -> tuple[Any, Any]: """ Converts device units into logical units. Args: - point(Tuple[Any, Any]):The point to convertAlternative Parameters + point(tuple[Any, Any]):The point to convertAlternative Parameters x(Any):The x coordinate to convert. y(Any):The y coordinate to convert.MFC References Returns: - Tuple[Any, Any]:CDC::DPtoLP + tuple[Any, Any]:CDC::DPtoLP To Do Should really handle list of (x,y) points Return ValueThe converted coordinates. @@ -34708,13 +34708,13 @@ Return ValueThe converted coordinates. """ ... - def Draw3dRect(self, rect: Tuple[Any, Any, Any, Any], colorTopLeft: Any, colorBotRight: Any) -> None: + def Draw3dRect(self, rect: tuple[Any, Any, Any, Any], colorTopLeft: Any, colorBotRight: Any) -> None: """ Draws a three-dimensional rectangle. Args: - rect(Tuple[Any, Any, Any, Any]):Specifies the bounding rectangle, in logical units. + rect(tuple[Any, Any, Any, Any]):Specifies the bounding rectangle, in logical units. colorTopLeft(Any):Specifies the color of the top and left sides of the three-dimensional rectangle. colorBotRight(Any):Specifies the color of the bottom and right sides of the three-dimensional rectangle.MFC References @@ -34725,7 +34725,7 @@ Returns: """ ... - def DrawFocusRect(self, rect: Tuple[Any, Any, Any, Any]) -> None: + def DrawFocusRect(self, rect: tuple[Any, Any, Any, Any]) -> None: """ Draws a rectangle in the style used to @@ -34733,7 +34733,7 @@ indicate the rectangle has focus Args: - rect(Tuple[Any, Any, Any, Any]):The coordinates of the rectangleMFC References + rect(tuple[Any, Any, Any, Any]):The coordinates of the rectangleMFC References Returns: @@ -34742,13 +34742,13 @@ Returns: """ ... - def DrawFrameControl(self, rect: Tuple[Any, Any, Any, Any], typ: Any, state: Any) -> None: + def DrawFrameControl(self, rect: tuple[Any, Any, Any, Any], typ: Any, state: Any) -> None: """ Draws a frame control of the specified type and style. Args: - rect(Tuple[Any, Any, Any, Any]):Specifies the bounding rectangle, in logical units. + rect(tuple[Any, Any, Any, Any]):Specifies the bounding rectangle, in logical units. typ(Any): state(Any):MFC References @@ -34759,13 +34759,13 @@ Returns: """ ... - def DrawIcon(self, point: Tuple[Any, Any], hIcon: int) -> None: + def DrawIcon(self, point: tuple[Any, Any], hIcon: int) -> None: """ Draws an icon on the DC. Args: - point(Tuple[Any, Any]):The point coordinate to draw to. + point(tuple[Any, Any]):The point coordinate to draw to. hIcon(int):The handle of the icon to draw.MFC References Returns: @@ -34775,19 +34775,19 @@ Returns: """ ... - def DrawText(self, s: str, _tuple: Tuple[Any, Any, Any, Any], _format: Any) -> Tuple[Any, Any, Any]: + def DrawText(self, s: str, _tuple: tuple[Any, Any, Any, Any], _format: Any) -> tuple[Any, Any, Any]: """ Formats text in the given rectangle Args: s(str):The desired output string - _tuple(Tuple[Any, Any, Any, Any]):The bounding rectangle in the form: (left, top, right, bottom) expressed in logical units (depending on selected coordinate system - see PyCDC::SetMapMode) + _tuple(tuple[Any, Any, Any, Any]):The bounding rectangle in the form: (left, top, right, bottom) expressed in logical units (depending on selected coordinate system - see PyCDC::SetMapMode) _format(Any):Specifies one or more bit-or'd format values, such as DT_BOTTOM, DT_CENTERDT_RIGHT, DT_VCENTER. For a complete list, see the Microsoft Win32 API documentation.ExampleExampleimport win32ui<nl> import win32con<nl> INCH = 1440 # twips - 1440 per inch allows fine res<nl> def drawtext_test():<nl> dc = win32ui.CreateDC()<nl> dc.CreatePrinterDC() # ties to default printer<nl> dc.StartDoc('My Python Document')<nl> dc.StartPage()<nl> <nl> # note: upper left is 0,0 with x increasing to the right,<nl> # and y decreasing (negative) moving down<nl> dc.SetMapMode(win32con.MM_TWIPS)<nl> <nl> # Centers "TEST" about an inch down on page<nl> dc.DrawText('TEST, (0,INCH*-1,INCH*8,INCH*-2), win32con.DT_CENTER )<nl> dc.EndPage()<nl> dc.EndDoc()<nl> del dc<nl>Return ValueHeight of text in pixelsThe return value is the height of the text, in logical units. If DT_VCENTER or DT_BOTTOM is specified, the return value is the 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) Returns: - Tuple[Any, Any, Any]:Specifies one or more bit-or'd format values, such as + tuple[Any, Any, Any]:Specifies one or more bit-or'd format values, such as DT_BOTTOM, DT_CENTERDT_RIGHT, DT_VCENTER. For a complete list, see @@ -34845,13 +34845,13 @@ If the function fails, the return value is zero (no Python exception is thrown) """ ... - def Ellipse(self, rect: Tuple[Any, Any, Any, Any]) -> None: + def Ellipse(self, rect: tuple[Any, Any, Any, Any]) -> None: """ Draws an Ellipse. Args: - rect(Tuple[Any, Any, Any, Any]):Specifies the ellipse's bounding rectangleCommentsThe center of the ellipse is the center of the bounding rectangle specified by rect. The ellipse is drawn with the current pen, and its interior is filled with the current brush.MFC References + rect(tuple[Any, Any, Any, Any]):Specifies the ellipse's bounding rectangleCommentsThe center of the ellipse is the center of the bounding rectangle specified by rect. The ellipse is drawn with the current pen, and its interior is filled with the current brush.MFC References Returns: @@ -34914,9 +34914,9 @@ Returns: _int: Any, _int1: Any, _int2: Any, - rect: Tuple[Any, Any, Any, Any], + rect: tuple[Any, Any, Any, Any], string: Any, - _tuple: Tuple[Tuple[Any, Any], ...]) -> None: + _tuple: tuple[tuple[Any, Any], ...]) -> None: """ Writes text to the DC. @@ -34925,9 +34925,9 @@ Args: _int(Any):The x coordinate to write the text to. _int1(Any):The y coordinate to write the text to. _int2(Any):Specifies the rectangle type. This parameter can be one, both, or neither of ETO_CLIPPED and ETO_OPAQUE - rect(Tuple[Any, Any, Any, Any]):Specifies the text's bounding rectangle. (Can be None.) + rect(tuple[Any, Any, Any, Any]):Specifies the text's bounding rectangle. (Can be None.) string(Any):The text to write. - _tuple(Tuple[Tuple[Any, Any], ...]):Optional array of values that indicate distance between origins of character cells.MFC References + _tuple(tuple[tuple[Any, Any], ...]):Optional array of values that indicate distance between origins of character cells.MFC References Returns: @@ -34955,13 +34955,13 @@ Returns: """ ... - def FillRect(self, rect: Tuple[Any, Any, Any, Any], brush: Any) -> None: + def FillRect(self, rect: tuple[Any, Any, Any, Any], brush: Any) -> None: """ Fills a given rectangle with the specified brush Args: - rect(Tuple[Any, Any, Any, Any]):Specifies the bounding rectangle, in logical units. + rect(tuple[Any, Any, Any, Any]):Specifies the bounding rectangle, in logical units. brush(Any):Specifies the brush to use.MFC References Returns: @@ -34971,13 +34971,13 @@ Returns: """ ... - def FillSolidRect(self, rect: Tuple[Any, Any, Any, Any], color: Any) -> None: + def FillSolidRect(self, rect: tuple[Any, Any, Any, Any], color: Any) -> None: """ Fills the given rectangle with the specified solid color. Args: - rect(Tuple[Any, Any, Any, Any]):Specifies the bounding rectangle, in logical units. + rect(tuple[Any, Any, Any, Any]):Specifies the bounding rectangle, in logical units. color(Any):Specifies the color to use.MFC References Returns: @@ -34987,13 +34987,13 @@ Returns: """ ... - def FrameRect(self, rect: Tuple[Any, Any, Any, Any], brush: Any) -> None: + def FrameRect(self, rect: tuple[Any, Any, Any, Any], brush: Any) -> None: """ Draws a border around the rectangle specified by rect Args: - rect(Tuple[Any, Any, Any, Any]):Specifies the bounding rectangle, in logical units. + rect(tuple[Any, Any, Any, Any]):Specifies the bounding rectangle, in logical units. brush(Any):Specifies the brush to use.MFC References Returns: @@ -35003,7 +35003,7 @@ Returns: """ ... - def GetBrushOrg(self) -> Tuple[Any, Any]: + def GetBrushOrg(self) -> tuple[Any, Any]: """ Retrieves the origin (in device units) of the brush currently selected for the @@ -35015,12 +35015,12 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... - def GetClipBox(self) -> Tuple[Any, Any, Any, Any]: + def GetClipBox(self) -> tuple[Any, Any, Any, Any]: """ Retrieves the dimensions of the smallest bounding rectangle @@ -35032,14 +35032,14 @@ Args: Returns: - Tuple[Any, Any, Any, Any]:CDC::GetClipBox + tuple[Any, Any, Any, Any]:CDC::GetClipBox Return ValueA tuple of integers specifying the rectangle. """ ... - def GetCurrentPosition(self) -> Tuple[Any, Any]: + def GetCurrentPosition(self) -> tuple[Any, Any]: """ Retrieves the current position (in logical coordinates). @@ -35049,7 +35049,7 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... @@ -35162,7 +35162,7 @@ Returns: """ ... - def GetTextExtent(self, text: str) -> Tuple[Any, Any]: + def GetTextExtent(self, text: str) -> tuple[Any, Any]: """ Calculates the width and height of a line of text using the current font to @@ -35174,14 +35174,14 @@ Args: Returns: - Tuple[Any, Any]:CFC::GetTextExtent + tuple[Any, Any]:CFC::GetTextExtent Return ValueA tuple of integers with the size of the string, in logical units. """ ... - def GetTextExtentPoint(self, text: str) -> Tuple[Any, Any]: + def GetTextExtentPoint(self, text: str) -> tuple[Any, Any]: """ None @@ -35191,7 +35191,7 @@ Args: Returns: - Tuple[Any, Any]:The text to calculate for.Return ValueA tuple of integers with the size of the string, in logical units. + tuple[Any, Any]:The text to calculate for.Return ValueA tuple of integers with the size of the string, in logical units. """ @@ -35269,7 +35269,7 @@ tmDigitizedAspectY """ ... - def GetViewportExt(self) -> Tuple[Any, Any]: + def GetViewportExt(self) -> tuple[Any, Any]: """ Gets the viewport extent of the device context @@ -35279,12 +35279,12 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... - def GetViewportOrg(self) -> Tuple[Any, Any]: + def GetViewportOrg(self) -> tuple[Any, Any]: """ Gets the viewport origin of the device context @@ -35294,12 +35294,12 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... - def GetWindowExt(self) -> Tuple[Any, Any]: + def GetWindowExt(self) -> tuple[Any, Any]: """ Gets the window extent of the device context @@ -35309,12 +35309,12 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... - def GetWindowOrg(self) -> Tuple[Any, Any]: + def GetWindowOrg(self) -> tuple[Any, Any]: """ Retrieves the x- and y-coordinates of the origin of the window associated with the @@ -35326,12 +35326,12 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... - def IntersectClipRect(self, rect: Tuple[Any, Any, Any, Any]) -> None: + def IntersectClipRect(self, rect: tuple[Any, Any, Any, Any]) -> None: """ Creates a new clipping region by forming the intersection of the current region @@ -35339,7 +35339,7 @@ and the rectangle specified Args: - rect(Tuple[Any, Any, Any, Any]):Specifies the bounding rectangle, in logical units.MFC References + rect(tuple[Any, Any, Any, Any]):Specifies the bounding rectangle, in logical units.MFC References Returns: @@ -35365,13 +35365,13 @@ Returns: """ ... - def LineTo(self, point: Tuple[Any, Any], x: Any, y: Any) -> None: + def LineTo(self, point: tuple[Any, Any], x: Any, y: Any) -> None: """ Draws a line to a specified point, using the currently selected pen. Args: - point(Tuple[Any, Any]):The point coordinate to draw to.Alternative Parameters + point(tuple[Any, Any]):The point coordinate to draw to.Alternative Parameters x(Any):The x coordinate to draw to. y(Any):The y coordinate to draw to.MFC References @@ -35382,45 +35382,45 @@ Returns: """ ... - def LPtoDP(self, point: Tuple[Any, Any], x: Any, y: Any) -> Tuple[Any, Any]: + def LPtoDP(self, point: tuple[Any, Any], x: Any, y: Any) -> tuple[Any, Any]: """ Converts logical units into device units. Args: - point(Tuple[Any, Any]):The point coordinate to convert.Alternative Parameters + point(tuple[Any, Any]):The point coordinate to convert.Alternative Parameters x(Any):The x coordinate to convert. y(Any):The y coordinate to convert.MFC References Returns: - Tuple[Any, Any]:CDC::LPtoDP + tuple[Any, Any]:CDC::LPtoDP Return ValueThe converted coordinates. """ ... - def MoveTo(self, point: Tuple[Any, Any], x: Any, y: Any) -> Tuple[Any, Any]: + def MoveTo(self, point: tuple[Any, Any], x: Any, y: Any) -> tuple[Any, Any]: """ Moves the current position to a specified point. Args: - point(Tuple[Any, Any]):The point coordinate to move to.Alternative Parameters + point(tuple[Any, Any]):The point coordinate to move to.Alternative Parameters x(Any):The x coordinate to move to. y(Any):The y coordinate to move to.MFC References Returns: - Tuple[Any, Any]:CDC::MoveTo + tuple[Any, Any]:CDC::MoveTo Return ValueThe previous position. """ ... - def OffsetWindowOrg(self, arg: Tuple[Any, Any]) -> Tuple[Any, Any]: + def OffsetWindowOrg(self, arg: tuple[Any, Any]) -> tuple[Any, Any]: """ Modifies the coordinates of the window origin relative to the coordinates of the @@ -35428,17 +35428,17 @@ current window origin. Args: - arg(Tuple[Any, Any]):The new origin offset.Return ValueThe previous origin as a tuple (x,y) + arg(tuple[Any, Any]):The new origin offset.Return ValueThe previous origin as a tuple (x,y) Returns: - Tuple[Any, Any]:The new origin offset.Return ValueThe previous origin as a tuple (x,y) + tuple[Any, Any]:The new origin offset.Return ValueThe previous origin as a tuple (x,y) """ ... - def OffsetViewportOrg(self, arg: Tuple[Any, Any]) -> Tuple[Any, Any]: + def OffsetViewportOrg(self, arg: tuple[Any, Any]) -> tuple[Any, Any]: """ Modifies the coordinates of the viewport origin relative to the coordinates of @@ -35446,24 +35446,24 @@ the current viewport origin Args: - arg(Tuple[Any, Any]):The new origin offset.Return ValueThe previous viewport origin as a tuple (x,y) + arg(tuple[Any, Any]):The new origin offset.Return ValueThe previous viewport origin as a tuple (x,y) Returns: - Tuple[Any, Any]:The new origin offset.Return ValueThe previous viewport origin as a tuple (x,y) + tuple[Any, Any]:The new origin offset.Return ValueThe previous viewport origin as a tuple (x,y) """ ... - def PatBlt(self, destPos: Tuple[Any, Any], size: Tuple[Any, Any], rop: Any) -> None: + def PatBlt(self, destPos: tuple[Any, Any], size: tuple[Any, Any], rop: Any) -> None: """ Creates a bit pattern on the device. Args: - destPos(Tuple[Any, Any]):The logical x,y coordinates of the upper-left corner of the destination rectangle. - size(Tuple[Any, Any]):Specifies the width and height (in logical units) of the destination rectangle and source bitmap. + destPos(tuple[Any, Any]):The logical x,y coordinates of the upper-left corner of the destination rectangle. + size(tuple[Any, Any]):Specifies the width and height (in logical units) of the destination rectangle and source bitmap. rop(Any):Specifies the raster operation to be performed. See the win32 api documentation for details.MFC References Returns: @@ -35525,13 +35525,13 @@ Returns: """ ... - def Polyline(self, points: List[Any]) -> None: + def Polyline(self, points: list[Any]) -> None: """ Draws a Polyline. Args: - points(List[Any]):A sequence of points + points(list[Any]):A sequence of points Returns: @@ -35582,7 +35582,7 @@ Returns: """ ... - def RectVisible(self, rect: Tuple[Any, Any, Any, Any]) -> Any: + def RectVisible(self, rect: tuple[Any, Any, Any, Any]) -> Any: """ Determines whether any part of the given rectangle lies within the clipping region of @@ -35590,7 +35590,7 @@ the display context. Args: - rect(Tuple[Any, Any, Any, Any]):The coordinates of the reactangle to be checked.MFC References + rect(tuple[Any, Any, Any, Any]):The coordinates of the reactangle to be checked.MFC References Returns: @@ -35635,7 +35635,7 @@ An exception is raised if this function fails. """ ... - def ScaleWindowExt(self) -> Tuple[Any, Any]: + def ScaleWindowExt(self) -> tuple[Any, Any]: """ Modifies the window extents relative to the current values. @@ -35645,12 +35645,12 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... - def ScaleViewportExt(self) -> Tuple[Any, Any]: + def ScaleViewportExt(self) -> tuple[Any, Any]: """ Modifies the viewport extents relative to the current values. @@ -35660,7 +35660,7 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... @@ -35735,7 +35735,7 @@ Return ValueThe return value is the previous background mode. """ ... - def SetBrushOrg(self, point: Tuple[Any, Any]) -> Tuple[Any, Any]: + def SetBrushOrg(self, point: tuple[Any, Any]) -> tuple[Any, Any]: """ Specifies the origin that GDI will assign to the next brush that the @@ -35743,11 +35743,11 @@ application selects into the device context. Args: - point(Tuple[Any, Any]):The new origin in device units.MFC References + point(tuple[Any, Any]):The new origin in device units.MFC References Returns: - Tuple[Any, Any]:CDC::SetBrushOrg + tuple[Any, Any]:CDC::SetBrushOrg Return ValueThe previous origin in device units. @@ -35803,13 +35803,13 @@ Returns: """ ... - def SetPolyFillMode(self, point: Tuple[Any, Any]) -> Any: + def SetPolyFillMode(self, point: tuple[Any, Any]) -> Any: """ Sets the polygon-filling mode. Args: - point(Tuple[Any, Any]):The new origin in device units.MFC References + point(tuple[Any, Any]):The new origin in device units.MFC References Returns: @@ -35873,66 +35873,66 @@ Return ValueThe return value is the previous text color. """ ... - def SetWindowExt(self, size: Tuple[Any, Any]) -> Tuple[Any, Any]: + def SetWindowExt(self, size: tuple[Any, Any]) -> tuple[Any, Any]: """ Sets the x,y extents of the window associated with the device context. Args: - size(Tuple[Any, Any]):The new size.MFC References + size(tuple[Any, Any]):The new size.MFC References Returns: - Tuple[Any, Any]:CDC::SetWindowExt + tuple[Any, Any]:CDC::SetWindowExt Return ValueThe previous extents of the window (in logical units). """ ... - def SetWindowOrg(self, arg: Tuple[Any, Any]) -> Tuple[Any, Any]: + def SetWindowOrg(self, arg: tuple[Any, Any]) -> tuple[Any, Any]: """ Sets the window origin of the device context Args: - arg(Tuple[Any, Any]):The new origin. + arg(tuple[Any, Any]):The new origin. Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... - def SetViewportExt(self, size: Tuple[Any, Any]) -> Tuple[Any, Any]: + def SetViewportExt(self, size: tuple[Any, Any]) -> tuple[Any, Any]: """ Sets the x,y extents of the viewport of the device context. Args: - size(Tuple[Any, Any]):The new size.MFC References + size(tuple[Any, Any]):The new size.MFC References Returns: - Tuple[Any, Any]:CDC::SetViewportExt + tuple[Any, Any]:CDC::SetViewportExt Return ValueThe previous extents of the viewport (in logical units). """ ... - def SetViewportOrg(self, arg: Tuple[Any, Any]) -> Tuple[Any, Any]: + def SetViewportOrg(self, arg: tuple[Any, Any]) -> tuple[Any, Any]: """ Sets the viewport origin of the device context Args: - arg(Tuple[Any, Any]):The new origin. + arg(tuple[Any, Any]):The new origin. Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... @@ -35989,22 +35989,22 @@ Returns: def StretchBlt( self, - destPos: Tuple[Any, Any], - size: Tuple[Any, Any], + destPos: tuple[Any, Any], + size: tuple[Any, Any], dc: Any, - srcPos: Tuple[Any, Any], - size1: Tuple[Any, Any], + srcPos: tuple[Any, Any], + size1: tuple[Any, Any], rop: Any) -> None: """ Copies a bitmap from the source device context to this device context. Args: - destPos(Tuple[Any, Any]):The logical x,y coordinates of the upper-left corner of the destination rectangle. - size(Tuple[Any, Any]):Specifies the width and height (in logical units) of the destination rectangle and source bitmap. + destPos(tuple[Any, Any]):The logical x,y coordinates of the upper-left corner of the destination rectangle. + size(tuple[Any, Any]):Specifies the width and height (in logical units) of the destination rectangle and source bitmap. dc(Any):Specifies the PyCDC object from which the bitmap will be copied. It must be None if rop specifies a raster operation that does not include a source. - srcPos(Tuple[Any, Any]):Specifies the logical x,y coordinates of the upper-left corner of the source bitmap. - size1(Tuple[Any, Any]):Specifies the width and height (in logical units) of the destination rectangle and source bitmap. + srcPos(tuple[Any, Any]):Specifies the logical x,y coordinates of the upper-left corner of the source bitmap. + size1(tuple[Any, Any]):Specifies the width and height (in logical units) of the destination rectangle and source bitmap. rop(Any):Specifies the raster operation to be performed. See the win32 api documentation for details.MFC References Returns: @@ -36133,7 +36133,7 @@ Returns: """ ... - def MapDialogRect(self, rect: Tuple[Any, Any, Any, Any]) -> Tuple[Any, Any, Any, Any]: + def MapDialogRect(self, rect: tuple[Any, Any, Any, Any]) -> tuple[Any, Any, Any, Any]: """ Converts the dialog-box units of a rectangle to screen @@ -36141,11 +36141,11 @@ units. Args: - rect(Tuple[Any, Any, Any, Any]):The rect to be converted + rect(tuple[Any, Any, Any, Any]):The rect to be converted Returns: - Tuple[Any, Any, Any, Any] + tuple[Any, Any, Any, Any] """ ... @@ -36386,15 +36386,15 @@ class PyCDockContext: raise Exception('This class just for typing, can not be instanced!') @property - def ptLast(self) -> Tuple[Any, Any]: + def ptLast(self) -> tuple[Any, Any]: ... @property - def rectLast(self) -> Tuple[Any, Any, Any, Any]: + def rectLast(self) -> tuple[Any, Any, Any, Any]: ... @property - def sizeLast(self) -> Tuple[Any, Any]: + def sizeLast(self) -> tuple[Any, Any]: ... @property @@ -36402,19 +36402,19 @@ class PyCDockContext: ... @property - def rectDragHorz(self) -> Tuple[Any, Any, Any, Any]: + def rectDragHorz(self) -> tuple[Any, Any, Any, Any]: ... @property - def rectDragVert(self) -> Tuple[Any, Any, Any, Any]: + def rectDragVert(self) -> tuple[Any, Any, Any, Any]: ... @property - def rectFrameDragHorz(self) -> Tuple[Any, Any, Any, Any]: + def rectFrameDragHorz(self) -> tuple[Any, Any, Any, Any]: ... @property - def rectFrameDragVert(self) -> Tuple[Any, Any, Any, Any]: + def rectFrameDragVert(self) -> tuple[Any, Any, Any, Any]: ... @property @@ -36455,7 +36455,7 @@ class PyCDockContext: ... @property - def rectMRUDockPos(self) -> Tuple[Any, Any, Any, Any]: + def rectMRUDockPos(self) -> tuple[Any, Any, Any, Any]: ... @property @@ -36463,7 +36463,7 @@ class PyCDockContext: ... @property - def ptMRUFloatPos(self) -> Tuple[Any, Any]: + def ptMRUFloatPos(self) -> tuple[Any, Any]: """Sentinel""" ... @@ -36482,13 +36482,13 @@ Returns: """ ... - def StartDrag(self, pt: Tuple[Any, Any]) -> Any: + def StartDrag(self, pt: tuple[Any, Any]) -> Any: """ None Args: - pt(Tuple[Any, Any]): + pt(tuple[Any, Any]): Returns: @@ -36512,14 +36512,14 @@ Returns: """ ... - def StartResize(self, hittest: Any, pt: Tuple[Any, Any]) -> Any: + def StartResize(self, hittest: Any, pt: tuple[Any, Any]) -> Any: """ None Args: hittest(Any): - pt(Tuple[Any, Any]): + pt(tuple[Any, Any]): Returns: @@ -36618,7 +36618,7 @@ Returns: """ ... - def GetAllViews(self) -> List[Any]: + def GetAllViews(self) -> list[Any]: """ Returns a list of all views for the current document. @@ -36628,7 +36628,7 @@ Args: Returns: - List[Any] + list[Any] """ ... @@ -36874,14 +36874,14 @@ class PyCEdit: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CreateWindow(self, style: Any, rect: Tuple[Any, Any, Any, Any], parent: Any, _id: Any) -> None: + def CreateWindow(self, style: Any, rect: tuple[Any, Any, Any, Any], parent: Any, _id: Any) -> None: """ Creates the window for a new Edit object. Args: style(Any):The style for the Edit. Use any of the win32con.BS_* constants. - rect(Tuple[Any, Any, Any, Any]):The size and position of the Edit. + rect(tuple[Any, Any, Any, Any]):The size and position of the Edit. parent(Any):The parent window of the Edit. Usually a PyCDialog. _id(Any):The Edits control ID. @@ -36971,7 +36971,7 @@ Return ValueThe zero-based index of the topmost visible line. For single-line ed """ ... - def GetSel(self) -> Tuple[Any, Any]: + def GetSel(self) -> tuple[Any, Any]: """ Returns the start and end of the current selection. @@ -36981,7 +36981,7 @@ Args: Returns: - Tuple[Any, Any]:CEdit::GetSel + tuple[Any, Any]:CEdit::GetSel Return ValueThe return tuple is (the first character in the current selection, first nonselected character past the end of the current selection) @@ -37656,7 +37656,7 @@ Returns: PyCWnd: Any, menuId: Any, styleEx: Any, - rect: Tuple[Any, Any, Any, Any] = None, + rect: tuple[Any, Any, Any, Any] = None, createContext: Any = None) -> Any: """ Creates the actual window for the PyCFrameWnd object. @@ -37669,7 +37669,7 @@ Args: PyCWnd(Any):The parent window menuId(Any):The string or integer id for the menu. styleEx(Any):The extended style of the window being created.MFC References - rect(Tuple[Any, Any, Any, Any]):The default rectangle + rect(tuple[Any, Any, Any, Any]):The default rectangle createContext(Any):A tuple representing a CREATECONTEXT structure. Returns: @@ -37694,14 +37694,14 @@ Returns: """ ... - def DockControlBar(self, controlBar: Any, arg: Tuple[Any, Any, Any, Any], dockBarId: Any = 0) -> None: + def DockControlBar(self, controlBar: Any, arg: tuple[Any, Any, Any, Any], dockBarId: Any = 0) -> None: """ Docks a control bar. Args: controlBar(Any):The control bar to dock. - arg(Tuple[Any, Any, Any, Any]):Determines, in screen coordinates, where the control bar will be docked in the nonclient area of the destination frame window.MFC References + arg(tuple[Any, Any, Any, Any]):Determines, in screen coordinates, where the control bar will be docked in the nonclient area of the destination frame window.MFC References dockBarId(Any):Determines which sides of the frame window to consider for docking. Returns: @@ -37726,14 +37726,14 @@ Returns: """ ... - def FloatControlBar(self, controlBar: Any, arg: Tuple[Any, Any], style: Any) -> None: + def FloatControlBar(self, controlBar: Any, arg: tuple[Any, Any], style: Any) -> None: """ Floats a control bar. Args: controlBar(Any):The control bar to dock. - arg(Tuple[Any, Any]):The location, in screen coordinates, where the top left corner of the control bar will be placed. + arg(tuple[Any, Any]):The location, in screen coordinates, where the top left corner of the control bar will be placed. style(Any):Determines which sides of the frame window to consider for docking.MFC References Returns: @@ -38020,13 +38020,13 @@ class PyCImageList: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def Add(self, arg: Tuple[Any, Any], bitmap: Any, color: Any, hIcon: Any) -> Any: + def Add(self, arg: tuple[Any, Any], bitmap: Any, color: Any, hIcon: Any) -> Any: """ Adds an image to the list. Args: - arg(Tuple[Any, Any]):2 Bitmaps to use (primary and mask)Alternative Parameters + arg(tuple[Any, Any]):2 Bitmaps to use (primary and mask)Alternative Parameters bitmap(Any):Bitmap to use color(Any):Color to use for the mask.Alternative Parameters hIcon(Any):Handle of an icon to add.Return ValueZero-based index of the first new image. @@ -38072,7 +38072,7 @@ Returns: def GetBkColor(self) -> Any: """ - Retrieves the background color of an Image List. + Retrieves the background color of an Image list. Args: @@ -38133,7 +38133,7 @@ Returns: def SetBkColor(self, color: Any) -> None: """ - Sets the background color for an Image List. + Sets the background color for an Image list. Args: @@ -38601,14 +38601,14 @@ Returns: """ ... - def CreateWindow(self, style: Any, rect: Tuple[Any, Any, Any, Any], PyCWnd: Any, _id: Any) -> None: + def CreateWindow(self, style: Any, rect: tuple[Any, Any, Any, Any], PyCWnd: Any, _id: Any) -> None: """ Creates the actual window for the object. Args: style(Any):The window style - rect(Tuple[Any, Any, Any, Any]):The default rectangle + rect(tuple[Any, Any, Any, Any]):The default rectangle PyCWnd(Any):The parent window _id(Any):The control IDMFC References @@ -38740,7 +38740,7 @@ Returns: """ ... - def GetItemRect(self, item: Any, bTextOnly: Any) -> Tuple[Any, Any, Any, Any]: + def GetItemRect(self, item: Any, bTextOnly: Any) -> tuple[Any, Any, Any, Any]: """ Retrieves the bounding rectangle of a list view item. @@ -38751,7 +38751,7 @@ Args: Returns: - Tuple[Any, Any, Any, Any] + tuple[Any, Any, Any, Any] """ ... @@ -38804,7 +38804,7 @@ Returns: """ ... - def CreateDragImage(self, item: Any) -> Tuple[Any, Any, Any]: + def CreateDragImage(self, item: Any) -> tuple[Any, Any, Any]: """ Creates a dragging bitmap for the specified list view @@ -38816,7 +38816,7 @@ Args: Returns: - Tuple[Any, Any, Any] + tuple[Any, Any, Any] """ ... @@ -38909,7 +38909,7 @@ Returns: Args: - imageList(Any):The Image List to use. + imageList(Any):The Image list to use. imageType(Any):Type of image list. It can be one of (COMMCTRL.) LVSIL_NORMAL, LVSIL_SMALL or LVSIL_STATE Returns: @@ -39246,7 +39246,7 @@ Returns: """ ... - def HitTest(self, arg: Any) -> Tuple[Any, Any, Any]: + def HitTest(self, arg: Any) -> tuple[Any, Any, Any]: """ Determines which list view item, if any, is at a specified position. @@ -39256,7 +39256,7 @@ Args: Returns: - Tuple[Any, Any, Any]:The point to test.Return ValueThe result is a tuple of (flags, item, subItem). + tuple[Any, Any, Any]:The point to test.Return ValueThe result is a tuple of (flags, item, subItem). flags may be a combination of the following values: @@ -39284,7 +39284,7 @@ commctrl.LVHT_TORIGHTThe position is to the right of the list view control's cli """ ... - def GetItemPosition(self, item: Any) -> Tuple[Any, Any]: + def GetItemPosition(self, item: Any) -> tuple[Any, Any]: """ Determines the position of the specified item. @@ -39294,7 +39294,7 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... @@ -39378,7 +39378,7 @@ Returns: title: str, style: Any, PyCWnd: Any, - rect: Tuple[Any, Any, Any, Any] = None, + rect: tuple[Any, Any, Any, Any] = None, createContext: Any = None) -> Any: """ Creates the actual window for the PyCWnd object. @@ -39389,7 +39389,7 @@ Args: title(str):The window title style(Any):The window style PyCWnd(Any):The parent window - rect(Tuple[Any, Any, Any, Any]):The default rectangle + rect(tuple[Any, Any, Any, Any]):The default rectangle createContext(Any):A tuple representing a CREATECONTEXT structure.CommentsYou do not need to call this method if you use the MFC Document/View framework. Returns: @@ -39511,7 +39511,7 @@ Returns: """ ... - def MDIGetActive(self) -> Tuple[Any, Any]: + def MDIGetActive(self) -> tuple[Any, Any]: """ Retrieves the current active MDI child window, along @@ -39523,7 +39523,7 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... @@ -39807,13 +39807,13 @@ Returns: """ ... - def TrackPopupMenu(self, arg: Tuple[Any, Any], arg1: Any, arg2: Any) -> None: + def TrackPopupMenu(self, arg: tuple[Any, Any], arg1: Any, arg2: Any) -> None: """ Creates a popup menu anywhere on the screen. Args: - arg(Tuple[Any, Any]):The position for the menu.. + arg(tuple[Any, Any]):The position for the menu.. arg1(Any):Flags for the menu. arg2(Any):The owner of the menu.CommentsThe TrackPopupMenu function displays a floating pop-up menu at the 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 returned instead of the normal exception. @@ -40135,7 +40135,7 @@ Returns: """ ... - def GetNextItem(self, pos: Any) -> Tuple[Any, Any]: + def GetNextItem(self, pos: Any) -> tuple[Any, Any]: """ Call this function repeatedly to access each of @@ -40147,7 +40147,7 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... @@ -41163,14 +41163,14 @@ class PyCProgressCtrl: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CreateWindow(self, style: Any, rect: Tuple[Any, Any, Any, Any], parent: Any, _id: Any) -> None: + def CreateWindow(self, style: Any, rect: tuple[Any, Any, Any, Any], parent: Any, _id: Any) -> None: """ Creates the actual control. Args: style(Any):The style for the control. - rect(Tuple[Any, Any, Any, Any]):The size and position of the control. + rect(tuple[Any, Any, Any, Any]):The size and position of the control. parent(Any):The parent window of the control. Usually a PyCDialog. _id(Any):The control's ID. @@ -41831,14 +41831,14 @@ Returns: """ ... - def CreateWindow(self, style: Any, rect: Tuple[Any, Any, Any, Any], parent: Any, _id: Any) -> None: + def CreateWindow(self, style: Any, rect: tuple[Any, Any, Any, Any], parent: Any, _id: Any) -> None: """ Creates a rich edit control window. Args: style(Any):The control style - rect(Tuple[Any, Any, Any, Any]):The position of the control + rect(tuple[Any, Any, Any, Any]):The position of the control parent(Any):The parent window. Must not be None _id(Any):The control ID @@ -41864,7 +41864,7 @@ Returns: """ ... - def FindText(self, charPos: Any) -> Tuple[Any, Any, Any]: + def FindText(self, charPos: Any) -> tuple[Any, Any, Any]: """ Finds text in the control @@ -41874,7 +41874,7 @@ Args: Returns: - Tuple[Any, Any, Any] + tuple[Any, Any, Any] """ ... @@ -41981,7 +41981,7 @@ Return ValueThe return value is a win32ui::PARAFORMAT tuple """ ... - def GetSel(self) -> Tuple[Any, Any]: + def GetSel(self) -> tuple[Any, Any]: """ Returns the start and end of the current selection. @@ -41991,7 +41991,7 @@ Args: Returns: - Tuple[Any, Any]:CRichEditCtrl::GetSel + tuple[Any, Any]:CRichEditCtrl::GetSel Return ValueThe return tuple is (the first character in the current selection, first nonselected character past the end of the current selection) @@ -42360,7 +42360,7 @@ Returns: """ ... - def StreamIn(self, _format: Any, method: Any) -> Tuple[Any, Any]: + def StreamIn(self, _format: Any, method: Any) -> tuple[Any, Any]: """ Invokes a callback to stream data into the control. @@ -42371,14 +42371,14 @@ Args: Returns: - Tuple[Any, Any]:CRichEditCtrl::StreamIn + tuple[Any, Any]:CRichEditCtrl::StreamIn Return ValueThe return value is a tuple of (no bytes written, error code) """ ... - def StreamOut(self, _format: Any, method: Any) -> Tuple[Any, Any]: + def StreamOut(self, _format: Any, method: Any) -> tuple[Any, Any]: """ Invokes a callback to stream data into the control. @@ -42389,7 +42389,7 @@ Args: Returns: - Tuple[Any, Any]:CRichEditCtrl::StreamOut + tuple[Any, Any]:CRichEditCtrl::StreamOut Return ValueThe return value is a tuple of (no bytes written, error code) @@ -42514,7 +42514,7 @@ class PyCScrollView: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetDeviceScrollPosition(self) -> Tuple[Any, Any]: + def GetDeviceScrollPosition(self) -> tuple[Any, Any]: """ Returns the positon of the scroll bars in device units. @@ -42524,7 +42524,7 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... @@ -42544,7 +42544,7 @@ Returns: """ ... - def GetScrollPosition(self) -> Tuple[Any, Any]: + def GetScrollPosition(self) -> tuple[Any, Any]: """ Returns the current position of the scroll bars (in logical units). @@ -42554,12 +42554,12 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... - def GetTotalSize(self) -> Tuple[Any, Any]: + def GetTotalSize(self) -> tuple[Any, Any]: """ Returns the total size of the view in logical units. @@ -42569,7 +42569,7 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... @@ -42605,13 +42605,13 @@ Returns: """ ... - def SetScaleToFitSize(self, size: Tuple[Any, Any]) -> None: + def SetScaleToFitSize(self, size: tuple[Any, Any]) -> None: """ Scales the viewport size to the current window size automatically. Args: - size(Tuple[Any, Any]):The horizontal and vertical sizes to which the view is to be scaled. The scroll view's size is measured in logical units. + size(tuple[Any, Any]):The horizontal and vertical sizes to which the view is to be scaled. The scroll view's size is measured in logical units. Returns: @@ -42620,13 +42620,13 @@ Returns: """ ... - def ScrollToPosition(self, position: Tuple[Any, Any]) -> None: + def ScrollToPosition(self, position: tuple[Any, Any]) -> None: """ Scrolls to a given point in the view. Args: - position(Tuple[Any, Any]):The position to scroll to. + position(tuple[Any, Any]):The position to scroll to. Returns: @@ -42638,18 +42638,18 @@ Returns: def SetScrollSizes( self, mapMode: Any, - sizeTotal: Tuple[Any, Any], - arg: Tuple[Any, Any], - arg1: Tuple[Any, Any]) -> None: + sizeTotal: tuple[Any, Any], + arg: tuple[Any, Any], + arg1: tuple[Any, Any]) -> None: """ Sets the sizes of the scroll bars Args: mapMode(Any):The mapping mode for this view. - sizeTotal(Tuple[Any, Any]):The total size of the view. Sizes are in logical units. Both x and y must be greater than zero. - arg(Tuple[Any, Any]):The number of untils to scroll in response to a page-down command. - arg1(Tuple[Any, Any]):The number of untils to scroll in response to a line-down command. + sizeTotal(tuple[Any, Any]):The total size of the view. Sizes are in logical units. Both x and y must be greater than zero. + arg(tuple[Any, Any]):The number of untils to scroll in response to a page-down command. + arg1(tuple[Any, Any]):The number of untils to scroll in response to a line-down command. Returns: @@ -42679,14 +42679,14 @@ class PyCSliderCtrl: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CreateWindow(self, style: Any, rect: Tuple[Any, Any, Any, Any], parent: Any, _id: Any) -> None: + def CreateWindow(self, style: Any, rect: tuple[Any, Any, Any, Any], parent: Any, _id: Any) -> None: """ Creates the actual control. Args: style(Any):The style for the control. - rect(Tuple[Any, Any, Any, Any]):The size and position of the control. + rect(tuple[Any, Any, Any, Any]):The size and position of the control. parent(Any):The parent window of the control. Usually a PyCDialog. _id(Any):The control's ID. @@ -43135,7 +43135,7 @@ Returns: """ ... - def CreateView(self, view: Any, row: Any, col: Any, arg: Tuple[Any, Any]) -> None: + def CreateView(self, view: Any, row: Any, col: Any, arg: tuple[Any, Any]) -> None: """ Creates a view in a splitter window @@ -43144,7 +43144,7 @@ Args: view(Any):The view to place in the splitter pane. row(Any):The row in the splitter to place the view. col(Any):The column in the splitter to place the view. - arg(Tuple[Any, Any]):The initial size of the new view.MFC References + arg(tuple[Any, Any]):The initial size of the new view.MFC References Returns: @@ -43243,7 +43243,7 @@ class PyCStatusBar: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def GetPaneInfo(self, index: Any) -> Tuple[Any, Any, Any]: + def GetPaneInfo(self, index: Any) -> tuple[Any, Any, Any]: """ Returns the id, style, and width of the indicator pane at the @@ -43255,7 +43255,7 @@ Args: Returns: - Tuple[Any, Any, Any] + tuple[Any, Any, Any] """ ... @@ -43314,14 +43314,14 @@ class PyCStatusBarCtrl: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CreateWindow(self, style: Any, rect: Tuple[Any, Any, Any, Any], parent: Any, _id: Any) -> None: + def CreateWindow(self, style: Any, rect: tuple[Any, Any, Any, Any], parent: Any, _id: Any) -> None: """ Creates the actual control. Args: style(Any):The style for the control. - rect(Tuple[Any, Any, Any, Any]):The size and position of the control. + rect(tuple[Any, Any, Any, Any]):The size and position of the control. parent(Any):The parent window of the control. Usually a PyCDialog. _id(Any):The control's ID. @@ -43332,7 +43332,7 @@ Returns: """ ... - def GetBorders(self) -> Tuple[Any, Any, Any]: + def GetBorders(self) -> tuple[Any, Any, Any]: """ Retrieve the status bar control's current widths of @@ -43344,7 +43344,7 @@ Args: Returns: - Tuple[Any, Any, Any] + tuple[Any, Any, Any] """ ... @@ -43355,7 +43355,7 @@ Returns: Args: - nParts(Any):The number of coordinates to retrieveCommentsThis function, as designed in MFC, returns both the *number* of parts, and, through an OUT parameter, an array of ints giving the coordinates of the parts. There is also an IN parameter saying how many coordinates to give back. Here, we're explicitly changing the semantics a bit.GetParts() -> Tuple of all coordinates GetParts(n) -> Tuple of the first n coordinates (or all coordinates, if fewer than n)So, in Python, you can't simultaneously find out how many coordinates there are, and retrieve a subset of them. In a reasonable universe, there would have been GetParts() -> int, and GetCoords() -> List. This means that I need to call the MFC method twice; once to find out how many there are, and another time to get them. + nParts(Any):The number of coordinates to retrieveCommentsThis function, as designed in MFC, returns both the *number* of parts, and, through an OUT parameter, an array of ints giving the coordinates of the parts. There is also an IN parameter saying how many coordinates to give back. Here, we're explicitly changing the semantics a bit.GetParts() -> tuple of all coordinates GetParts(n) -> tuple of the first n coordinates (or all coordinates, if fewer than n)So, in Python, you can't simultaneously find out how many coordinates there are, and retrieve a subset of them. In a reasonable universe, there would have been GetParts() -> int, and GetCoords() -> list. This means that I need to call the MFC method twice; once to find out how many there are, and another time to get them. Returns: @@ -43364,7 +43364,7 @@ Returns: """ ... - def GetRect(self, nPane: Any) -> Tuple[Any, Any, Any, Any]: + def GetRect(self, nPane: Any) -> tuple[Any, Any, Any, Any]: """ Retrieves the bounding rectangle of a part in a status @@ -43376,7 +43376,7 @@ Args: Returns: - Tuple[Any, Any, Any, Any] + tuple[Any, Any, Any, Any] """ ... @@ -43742,14 +43742,14 @@ Returns: """ ... - def SetSizes(self, sizeButton: Tuple[Any, Any], sizeButton1: Tuple[Any, Any]) -> None: + def SetSizes(self, sizeButton: tuple[Any, Any], sizeButton1: tuple[Any, Any]) -> None: """ Sets the size of each button. Args: - sizeButton(Tuple[Any, Any]):The size of each button. - sizeButton1(Tuple[Any, Any]):The size of each bitmap. + sizeButton(tuple[Any, Any]):The size of each button. + sizeButton1(tuple[Any, Any]):The size of each bitmap. Returns: @@ -43858,14 +43858,14 @@ Returns: """ ... - def CreateWindow(self, style: Any, rect: Tuple[Any, Any, Any, Any], parent: Any, _id: Any) -> None: + def CreateWindow(self, style: Any, rect: tuple[Any, Any, Any, Any], parent: Any, _id: Any) -> None: """ Creates the window for a new toolbar object Args: style(Any):The style for the button. Use any of the win32con.BS_* constants. - rect(Tuple[Any, Any, Any, Any]):The size and position of the button. + rect(tuple[Any, Any, Any, Any]):The size and position of the button. parent(Any):The parent window of the button. Usually a PyCDialog. _id(Any):The buttons control ID.MFC References @@ -43969,7 +43969,7 @@ Returns: """ ... - def GetItemRect(self, nID: Any) -> Tuple[Any, Any, Any, Any]: + def GetItemRect(self, nID: Any) -> tuple[Any, Any, Any, Any]: """ Retrieve the bounding rectangle of a button in a @@ -43981,12 +43981,12 @@ Args: Returns: - Tuple[Any, Any, Any, Any] + tuple[Any, Any, Any, Any] """ ... - def GetRows(self) -> Tuple[Any, Any, Any, Any]: + def GetRows(self) -> tuple[Any, Any, Any, Any]: """ Retrieve the number of rows of buttons currently displayed @@ -43996,7 +43996,7 @@ Args: Returns: - Tuple[Any, Any, Any, Any] + tuple[Any, Any, Any, Any] """ ... @@ -44196,7 +44196,7 @@ Returns: """ ... - def SetRows(self, nRows: Any, bLarger: Any) -> Tuple[Any, Any, Any, Any]: + def SetRows(self, nRows: Any, bLarger: Any) -> tuple[Any, Any, Any, Any]: """ Ask the toolbar control to resize itself to the requested @@ -44209,7 +44209,7 @@ Args: Returns: - Tuple[Any, Any, Any, Any] + tuple[Any, Any, Any, Any] """ ... @@ -44253,7 +44253,7 @@ Returns: """ ... - def AddTool(self, wnd: Any, text: str, _id: Any, rect: Tuple[Any, Any, Any, Any] = None) -> None: + def AddTool(self, wnd: Any, text: str, _id: Any, rect: tuple[Any, Any, Any, Any] = None) -> None: """ Adds a tool to tooltip control. @@ -44262,7 +44262,7 @@ Args: wnd(Any):The window of the tool. text(str):The text for the tool. _id(Any):The id of the tool - rect(Tuple[Any, Any, Any, Any]):The default rectangle + rect(tuple[Any, Any, Any, Any]):The default rectangle Returns: @@ -44292,14 +44292,14 @@ class PyCTreeCtrl: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CreateWindow(self, style: Any, rect: Tuple[Any, Any, Any, Any], PyCWnd: Any, _id: Any) -> None: + def CreateWindow(self, style: Any, rect: tuple[Any, Any, Any, Any], PyCWnd: Any, _id: Any) -> None: """ Creates the actual window for the object. Args: style(Any):The window style - rect(Tuple[Any, Any, Any, Any]):The default rectangle + rect(tuple[Any, Any, Any, Any]):The default rectangle PyCWnd(Any):The parent window _id(Any):The control IDMFC References @@ -44376,7 +44376,7 @@ Returns: Args: - imageList(Any):The Image List to use. + imageList(Any):The Image list to use. imageType(Any):Type of image list. It can be one of (COMMCTRL.) LVSIL_NORMAL, LVSIL_SMALL or LVSIL_STATE Returns: @@ -44598,7 +44598,7 @@ Returns: """ ... - def GetItemState(self, item: Any, stateMask: Any) -> Tuple[Any, Any]: + def GetItemState(self, item: Any, stateMask: Any) -> tuple[Any, Any]: """ Retrieves the state and mask of an item. @@ -44609,7 +44609,7 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... @@ -44631,7 +44631,7 @@ Returns: """ ... - def GetItemImage(self, item: Any) -> Tuple[Any, Any]: + def GetItemImage(self, item: Any) -> tuple[Any, Any]: """ Retrieves the index of an items images. @@ -44641,7 +44641,7 @@ Args: Returns: - Tuple[Any, Any] + tuple[Any, Any] """ ... @@ -44725,7 +44725,7 @@ Returns: """ ... - def GetItemRect(self, item: Any, bTextOnly: Any) -> Tuple[Any, Any, Any, Any]: + def GetItemRect(self, item: Any, bTextOnly: Any) -> tuple[Any, Any, Any, Any]: """ Retrieves the bounding rectangle of a tree view item. @@ -44736,7 +44736,7 @@ Args: Returns: - Tuple[Any, Any, Any, Any] + tuple[Any, Any, Any, Any] """ ... @@ -44997,7 +44997,7 @@ Returns: """ ... - def HitTest(self, arg: Any) -> Tuple[Any, Any]: + def HitTest(self, arg: Any) -> tuple[Any, Any]: """ Determines which tree view item, if any, is at a specified position. @@ -45007,7 +45007,7 @@ Args: Returns: - Tuple[Any, Any]:The point to test.Return ValueThe result is a tuple of (flags, hItem). + tuple[Any, Any]:The point to test.Return ValueThe result is a tuple of (flags, hItem). flags may be a combination of the following values: @@ -45095,7 +45095,7 @@ class PyCView: def __new__(cls): raise Exception('This class just for typing, can not be instanced!') - def CreateWindow(self, parent: Any, arg: Any, arg1: Any, arg2: Tuple[Any, Any, Any, Any]) -> None: + def CreateWindow(self, parent: Any, arg: Any, arg1: Any, arg2: tuple[Any, Any, Any, Any]) -> None: """ Creates the window for a view. @@ -45104,7 +45104,7 @@ Args: parent(Any):The parent window (usually a frame) arg(Any):The child ID for the view arg1(Any):The style for the view - arg2(Tuple[Any, Any, Any, Any]):The default position of the window. + arg2(tuple[Any, Any, Any, Any]):The default position of the window. Returns: @@ -45288,7 +45288,7 @@ Returns: """ ... - def GetDocTemplateList(self) -> List[Any]: + def GetDocTemplateList(self) -> list[Any]: """ Returns a list of all document templates. @@ -45298,7 +45298,7 @@ Args: Returns: - List[Any] + list[Any] """ ... @@ -45619,7 +45619,7 @@ Returns: """ ... - def BeginPaint(self) -> Tuple[Any, Any]: + def BeginPaint(self) -> tuple[Any, Any]: """ Prepares a window for painting @@ -45629,7 +45629,7 @@ Args: Returns: - Tuple[Any, Any]:PyCWnd.BeginPaint + tuple[Any, Any]:PyCWnd.BeginPaint PyCDC, PAINTSTRUCT = BeginPaint()Prepares a window for painting @@ -45639,7 +45639,7 @@ Return ValueYou must ... the PAINTSTRUCT param to the PyCWnd::EndPaint method. """ ... - def CalcWindowRect(self, rect: Tuple[Any, Any, Any, Any], nAdjustType: Any) -> Tuple[Any, Any, Any, Any]: + def CalcWindowRect(self, rect: tuple[Any, Any, Any, Any], nAdjustType: Any) -> tuple[Any, Any, Any, Any]: """ Computes the size of the window rectangle based on the desired client @@ -45649,12 +45649,12 @@ size for the window object. Args: - rect(Tuple[Any, Any, Any, Any]):The size to calculate from + rect(tuple[Any, Any, Any, Any]):The size to calculate from nAdjustType(Any):An enumerated type used for in-place editing. It can have the following values: CWnd::adjustBorder = 0, which means that scrollbar sizes are ignored in calculation; and CWnd::adjustOutside = 1, which means that they are added into the final measurements of the rectangle.MFC References Returns: - Tuple[Any, Any, Any, Any] + tuple[Any, Any, Any, Any] """ ... @@ -45710,7 +45710,7 @@ Returns: """ ... - def ClientToScreen(self, point: Tuple[Any, Any], rect: Any) -> Tuple[Any, Any, Any, Any, Any]: + def ClientToScreen(self, point: tuple[Any, Any], rect: Any) -> tuple[Any, Any, Any, Any, Any]: """ Converts the client coordinates of a given point on the display @@ -45718,12 +45718,12 @@ to screen coordinates. Args: - point(Tuple[Any, Any]):The client coordinates.Alternative Parameters + point(tuple[Any, Any]):The client coordinates.Alternative Parameters rect(Any):The client coordinates.CommentsThe new screen coordinates are relative to the upper-left corner of the system display. This function assumes that the given pointis in client coordinates.MFC References Returns: - Tuple[Any, Any, Any, Any, Any] + tuple[Any, Any, Any, Any, Any] """ ... @@ -45733,7 +45733,7 @@ Returns: classId: str, windowName: str, style: Any, - rect: Tuple[Any, Any, Any, Any], + rect: tuple[Any, Any, Any, Any], parent: Any, _id: Any, context: Any = None) -> None: @@ -45745,7 +45745,7 @@ Args: classId(str):The class ID for the window, or None windowName(str):The title for the window, or None style(Any):The style for the window. - rect(Tuple[Any, Any, Any, Any]):The size and position of the window. + rect(tuple[Any, Any, Any, Any]):The size and position of the window. parent(Any):The parent window of the new window.. _id(Any):The control's ID. context(Any):A CreateContext object.MFC References @@ -45763,7 +45763,7 @@ Returns: classId: str, windowName: str, style: Any, - rect: Tuple[Any, Any, Any, Any], + rect: tuple[Any, Any, Any, Any], parent: Any, _id: Any, createStruct1: Any, @@ -45777,7 +45777,7 @@ Args: classId(str):The class ID for the window. May not be None. windowName(str):The title for the window, or None style(Any):The style for the window. - rect(Tuple[Any, Any, Any, Any]):The size and position of the window. + rect(tuple[Any, Any, Any, Any]):The size and position of the window. parent(Any):The parent window of the new window.. _id(Any):The control's ID. createStruct1(Any):A tuple representing a CREATESTRUCT structure.MFC References @@ -45978,7 +45978,7 @@ Returns: """ ... - def GetClientRect(self) -> Tuple[Any, Any, Any, Any]: + def GetClientRect(self) -> tuple[Any, Any, Any, Any]: """ Returns the client coordinates of the window. left and top @@ -45990,7 +45990,7 @@ Args: Returns: - Tuple[Any, Any, Any, Any] + tuple[Any, Any, Any, Any] """ ... @@ -46388,7 +46388,7 @@ normalposSpecifies the window's coordinates when the window is in the restored p """ ... - def GetWindowRect(self) -> Tuple[Any, Any, Any, Any]: + def GetWindowRect(self) -> tuple[Any, Any, Any, Any]: """ Returns the screen coordinates of the windows upper left @@ -46400,7 +46400,7 @@ Args: Returns: - Tuple[Any, Any, Any, Any] + tuple[Any, Any, Any, Any] """ ... @@ -46526,13 +46526,13 @@ Return ValueThe return value is the previous handler, or None. """ ... - def InvalidateRect(self, arg: Tuple[Any, Any, Any, Any], bErase: Any = 1) -> None: + def InvalidateRect(self, arg: tuple[Any, Any, Any, Any], bErase: Any = 1) -> None: """ Invalidates an area of a window. Args: - arg(Tuple[Any, Any, Any, Any]):Rectangle to be updated. If default param is used, the entire window is invalidated. + arg(tuple[Any, Any, Any, Any]):Rectangle to be updated. If default param is used, the entire window is invalidated. bErase(Any):Specifies whether the background within the update region is to be erased.MFC References Returns: @@ -46678,7 +46678,7 @@ Returns: """ ... - def MapWindowPoints(self, wnd: Any, points: List[Any]) -> None: + def MapWindowPoints(self, wnd: Any, points: list[Any]) -> None: """ Converts (maps) a set of points from the coordinate space of a window to the @@ -46687,7 +46687,7 @@ coordinate space of another window. Args: wnd(Any): - points(List[Any]):The points to mapReturn ValueA list of the mapped points from the coordinate space of the CWnd to the coordinate space of another window. + points(list[Any]):The points to mapReturn ValueA list of the mapped points from the coordinate space of the CWnd to the coordinate space of another window. Returns: @@ -46775,13 +46775,13 @@ is already the same as requested and no change was made. """ ... - def MoveWindow(self, rect: Tuple[Any, Any, Any, Any], bRepaint: Any = 1) -> None: + def MoveWindow(self, rect: tuple[Any, Any, Any, Any], bRepaint: Any = 1) -> None: """ Move a window to a new location. Args: - rect(Tuple[Any, Any, Any, Any]):The new location of the window, relative to the parent. + rect(tuple[Any, Any, Any, Any]):The new location of the window, relative to the parent. bRepaint(Any):Indicates if the window should be repainted after the move.MFC References Returns: @@ -46838,13 +46838,13 @@ Returns: """ ... - def OnNcHitTest(self, arg: Tuple[Any, Any]) -> Any: + def OnNcHitTest(self, arg: tuple[Any, Any]) -> Any: """ Calls the base MFC OnNcHitTest function. Args: - arg(Tuple[Any, Any]):The pointSee Also + arg(tuple[Any, Any]):The pointSee Also Returns: @@ -46932,7 +46932,7 @@ Returns: """ ... - def OnWndMsg(self, msg: Any, wParam: Any, lParam: Any) -> Tuple[Any, Any]: + def OnWndMsg(self, msg: Any, wParam: Any, lParam: Any) -> tuple[Any, Any]: """ Calls the default MFC Window Message handler. @@ -46944,7 +46944,7 @@ Args: Returns: - Tuple[Any, Any]:CWnd::OnWndMsg + tuple[Any, Any]:CWnd::OnWndMsg Return ValueThe return value is a tuple of (int, int), being the return value from the MFC function call, and the value of the @@ -46986,7 +46986,7 @@ Returns: """ ... - def RedrawWindow(self, _object: Any, flags: Any, rect: Tuple[Any, Any, Any, Any] = None) -> None: + def RedrawWindow(self, _object: Any, flags: Any, rect: tuple[Any, Any, Any, Any] = None) -> None: """ Updates the specified rectangle or region in the given window's client area. @@ -46994,7 +46994,7 @@ Args: _object(Any):A region flags(Any):MFC References - rect(Tuple[Any, Any, Any, Any]):A rect, or None + rect(tuple[Any, Any, Any, Any]):A rect, or None Returns: @@ -47167,14 +47167,14 @@ Returns: """ ... - def SetWindowPos(self, hWndInsertAfter: Any, position: Tuple[Any, Any, Any, Any], flags: Any) -> None: + def SetWindowPos(self, hWndInsertAfter: Any, position: tuple[Any, Any, Any, Any], flags: Any) -> None: """ Sets the windows position information Args: hWndInsertAfter(Any):A hwnd, else one of the win32con.HWND_* constants. - position(Tuple[Any, Any, Any, Any]):The new position of the window. + position(tuple[Any, Any, Any, Any]):The new position of the window. flags(Any):Window positioning flags.MFC References Returns: @@ -47184,7 +47184,7 @@ Returns: """ ... - def ScreenToClient(self, rect: Tuple[Any, Any, Any, Any, Any], pnt: Any) -> Tuple[Any, Any, Any, Any, Any]: + def ScreenToClient(self, rect: tuple[Any, Any, Any, Any, Any], pnt: Any) -> tuple[Any, Any, Any, Any, Any]: """ Converts the screen coordinates of a given point @@ -47192,12 +47192,12 @@ or rectangle on the display to client coordinates. Args: - rect(Tuple[Any, Any, Any, Any, Any]):The coordinates to convert.Alternative Parameters + rect(tuple[Any, Any, Any, Any, Any]):The coordinates to convert.Alternative Parameters pnt(Any):The coordinates to convert.MFC References Returns: - Tuple[Any, Any, Any, Any, Any]:CWnd::ScreenToClient + tuple[Any, Any, Any, Any, Any]:CWnd::ScreenToClient Return ValueThe result is the same size as the input argument. @@ -47774,7 +47774,7 @@ Returns: class SCROLLINFO: - """Tuple representing a SCROLLINFO struct""" + """tuple representing a SCROLLINFO struct""" def __new__(cls): raise Exception('This class just for typing, can not be instanced!') From 125d4b24600119d724f7e613b2d55af088f6fa09 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 2 Apr 2022 11:26:38 -0400 Subject: [PATCH 022/137] Updated some messages --- src/AutoControlledWorker.py | 3 +-- src/capture_windows.py | 16 ++++++---------- src/error_messages.py | 3 ++- src/user_profile.py | 2 +- 4 files changed, 10 insertions(+), 14 deletions(-) diff --git a/src/AutoControlledWorker.py b/src/AutoControlledWorker.py index db8ee07e..16f85b96 100644 --- a/src/AutoControlledWorker.py +++ b/src/AutoControlledWorker.py @@ -22,8 +22,7 @@ def run(self): break except EOFError: continue - # TODO: "AutoSplit Integration" needs to call this and wait instead of outright killing the app. - # For now this can only used in a Development environment + # This is for use in a Development environment if line == "kill": self.autosplit.closeEvent() break diff --git a/src/capture_windows.py b/src/capture_windows.py index b8c5f953..d2ff8b49 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -1,5 +1,5 @@ from __future__ import annotations -from typing import Dict, Optional, cast +from typing import Optional, TypedDict, cast import ctypes import ctypes.wintypes @@ -25,15 +25,11 @@ # self.y = y # self.width = width # self.height = height -# class Region(TypedDict): -# x: int -# y: int -# width: int -# height: int - -# toml.dump does not support TypedDicts or dataclasses -# TODO: Check if we can just "cast" or "map" it before parsing it as TOML -Region = Dict[str, int] # pylint: disable=deprecated-typing-alias +class Region(TypedDict): + x: int + y: int + width: int + height: int def capture_region(hwnd: int, selection: Region, print_window: bool): diff --git a/src/error_messages.py b/src/error_messages.py index cb437f36..4eb424b0 100644 --- a/src/error_messages.py +++ b/src/error_messages.py @@ -69,7 +69,8 @@ def reset_hotkey(): def old_version_settings_file(): - set_text_message("Old version settings file detected. This version allows settings files from v1.3 and above.") + set_text_message( + "Old version settings file detected. This version allows settings files in .toml format. Starting from v2.0.") def invalid_settings(): diff --git a/src/user_profile.py b/src/user_profile.py index b5e909dd..804ef3d4 100644 --- a/src/user_profile.py +++ b/src/user_profile.py @@ -58,7 +58,7 @@ class UserProfileDict(TypedDict): loop_splits=False, split_image_directory="", captured_window_title="", - capture_region={"x": 0, "y": 0, "width": 0, "height": 0}, + capture_region=Region(x=0, y=0, width=1, height=1), ) From a64c5ce4b9058600b005f396c78e499ee8b2fb0d Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 2 Apr 2022 23:44:10 -0400 Subject: [PATCH 023/137] Implement D3D Desktop Duplication --- .vscode/launch.json | 16 ++++++++ res/settings.ui | 62 ++++++++++++++----------------- scripts/requirements.txt | 1 + src/AutoSplit.py | 8 ++-- src/capture_method.py | 80 ++++++++++++++++++++++++++++++++++++++++ src/capture_windows.py | 72 ++++++++++++++++++++++++------------ src/menu_bar.py | 22 ++++++++--- src/screen_region.py | 4 +- src/user_profile.py | 24 ++++++------ 9 files changed, 208 insertions(+), 81 deletions(-) create mode 100644 .vscode/launch.json create mode 100644 src/capture_method.py diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 00000000..dec98523 --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,16 @@ +{ + // Use IntelliSense to learn about possible attributes. + // Hover to view descriptions of existing attributes. + // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 + "version": "0.2.0", + "configurations": [ + { + "name": "Python: AutoSplit", + "type": "python", + "request": "launch", + "program": "src/AutoSplit.py", + "console": "integratedTerminal", + "justMyCode": true + } + ] +} diff --git a/res/settings.ui b/res/settings.ui index 0546658c..bd86a6b9 100644 --- a/res/settings.ui +++ b/res/settings.ui @@ -7,7 +7,7 @@ 0 0 289 - 540 + 572 @@ -19,13 +19,13 @@ 289 - 540 + 572 289 - 540 + 572 @@ -46,40 +46,12 @@ 10 180 271 - 101 + 131 Capture Settings - - - true - - - - 6 - 73 - 204 - 20 - - - - Force a full render of the capture window, which is required for some applications to be captured - - - - - - Force Full Render (slower Max FPS) - - - false - - - false - - @@ -143,12 +115,35 @@ false + + + + 6 + 97 + 251 + 22 + + + + + + + 6 + 75 + 151 + 16 + + + + Capture method: + + 10 - 290 + 320 271 241 @@ -646,7 +641,6 @@ loop_splits_checkbox fps_limit_spinbox live_capture_region_checkbox - force_print_window_checkbox diff --git a/scripts/requirements.txt b/scripts/requirements.txt index 0dafddd0..900bbc11 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -23,6 +23,7 @@ pywin32 requests certifi toml +git+https://github.com/ranchen421/D3DShot.git#egg=D3DShot # https://github.com/SerpentAI/D3DShot/issues/44 # # Linting and Types bandit diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 53be2fe0..15e90bf3 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -249,7 +249,7 @@ def __live_image_function(self): if self.hwnd: capture = capture_region(self.hwnd, self.settings_dict["capture_region"], - self.settings_dict["force_print_window"]) + self.settings_dict["capture_method"]) set_ui_image(self.live_image, capture, False) def __load_start_image(self, started_by_button: bool = False, wait_for_delay: bool = True): @@ -385,7 +385,7 @@ def __take_screenshot(self): # Grab screenshot of capture region capture = capture_region(self.hwnd, self.settings_dict["capture_region"], - self.settings_dict["force_print_window"]) + self.settings_dict["capture_method"]) if capture is None: error_messages.region() return @@ -752,7 +752,7 @@ def __get_capture_for_comparison(self): """ capture = capture_region(self.hwnd, self.settings_dict["capture_region"], - self.settings_dict["force_print_window"]) + self.settings_dict["capture_method"]) # This most likely means we lost capture (ie the captured window was closed, crashed, etc.) if capture is None: @@ -765,7 +765,7 @@ def __get_capture_for_comparison(self): self.hwnd = hwnd capture = capture_region(self.hwnd, self.settings_dict["capture_region"], - self.settings_dict["force_print_window"]) + self.settings_dict["capture_method"]) return None if capture is None else cv2.resize(capture, COMPARISON_RESIZE, interpolation=cv2.INTER_NEAREST) def __reset_if_should(self, capture: Optional[cv2.ndarray]): diff --git a/src/capture_method.py b/src/capture_method.py new file mode 100644 index 00000000..55e34e64 --- /dev/null +++ b/src/capture_method.py @@ -0,0 +1,80 @@ +from typing import TypedDict + +from collections import OrderedDict +from enum import Enum, unique + + +class CaptureMethodInfo(TypedDict): + name: str + short_description: str + description: str + + +@unique +class CaptureMethod(Enum): + # Allow TOML to save as a simple string + def __repr__(self): + return self.value + __str__ = __repr__ + + # Allow direct comparison with strings + def __eq__(self, other: object): + return self.value == other.__str__() + + # Restore hashing functionality + def __hash__(self): + return self.value.__hash__() + + BITBLT = "BITBLT" + WINDOWS_GRAPHICS_CAPTURE = "WINDOWS_GRAPHICS_CAPTURE" + PRINTWINDOW_RENDERFULLCONTENT = "PRINTWINDOW_RENDERFULLCONTENT" + DESKTOP_DUPLICATION = "DESKTOP_DUPLICATION" + + +CAPTURE_METHODS = OrderedDict({ + CaptureMethod.BITBLT: CaptureMethodInfo( + name="BitBlt", + short_description="fast, issues with Hardware Acceleration and OpenGL", + description="A good default fast option. Allows recording background windows " + + "(as long as they still decide to render in the background), " + + "but it cannot properly record OpenGL or Hardware Accelerated Windows.", + ), + CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: CaptureMethodInfo( + name="Windows Graphics Capture", + short_description="Windows 10 1903 and up, most compatible if available", + description="Only available in recent Windows updates. Allows recording UWP apps " + + "(hardware accelerated and fullscreen exclusives? To be tested). " + + "Adds a yellow border around the recorded window.", + ), + CaptureMethod.DESKTOP_DUPLICATION: CaptureMethodInfo( + name="Direct3D Desktop Duplication", + short_description="very slow, overlapping windows, supports OpenGL and DirectX 11/12 exclusive fullscreen", + description="Duplicates the desktop using Direct3D. It can record OpenGL and Hardware Accelerated windows. " + + "But it's about 10-15x slower than BitBlt and overlapping windows will show up.", + ), + CaptureMethod.PRINTWINDOW_RENDERFULLCONTENT: CaptureMethodInfo( + name="Force Full Content Rendering", + short_description="very slow, can affect rendering pipeline", + description="Uses BitBlt behind the scene, but passes a special flag to PrintWindow to force rendering the " + + "entire desktop window. About 10-15x slower than BitBlt based on window size and can mess up some " + + "applications' rendering pipelines.", + ), +}) + + +def get_capture_method_index(capture_method: CaptureMethod): + """ + Returns 0 if the capture_method is invalid or unsupported + """ + try: + return list(CAPTURE_METHODS.keys()).index(capture_method) + except ValueError: + return 0 + + +def get_capture_method_by_index(index: int): + return list(CAPTURE_METHODS.keys())[index] + + +# Detect and remove unsupported capture methods +CAPTURE_METHODS.pop(CaptureMethod.WINDOWS_GRAPHICS_CAPTURE) # Not yet implemented diff --git a/src/capture_windows.py b/src/capture_windows.py index d2ff8b49..3157ddbb 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -3,8 +3,11 @@ import ctypes import ctypes.wintypes +import d3dshot from PyQt6 import QtCore, QtGui from PyQt6.QtWidgets import QLabel +# from winrt.windows.graphics import capture +# from winrt._winrt import initialize_with_window import cv2 import numpy as np @@ -14,17 +17,15 @@ from win32 import win32gui from win32typing import PyCBitmap, PyCDC +from capture_method import CaptureMethod + + # This is an undocumented nFlag value for PrintWindow PW_RENDERFULLCONTENT = 0x00000002 +desktop_duplication = d3dshot.create(capture_output="numpy") + -# @dataclass -# class Region(): -# def __init__(self, x: int, y: int, width: int, height: int): -# self.x = x -# self.y = y -# self.width = width -# self.height = height class Region(TypedDict): x: int y: int @@ -32,16 +33,8 @@ class Region(TypedDict): height: int -def capture_region(hwnd: int, selection: Region, print_window: bool): - """ - Captures an image of the region for a window matching the given - parameters of the bounding box - - @param hwnd: Handle to the window being captured - @param selection: The coordinates of the region - @return: The image of the region in the window in BGRA format - """ - +def __bit_blt_capture(hwnd: int, selection: Region, render_full_content: bool = False): + image: Optional[cv2.ndarray] = None # If the window closes while it's being manipulated, it could cause a crash try: window_dc: int = win32gui.GetWindowDC(hwnd) @@ -49,7 +42,7 @@ def capture_region(hwnd: int, selection: Region, print_window: bool): dc_object: PyCDC = win32ui.CreateDCFromHandle(window_dc) # type: ignore # Causes a 10-15x performance drop. But allows recording hardware accelerated windows - if print_window: + if render_full_content: ctypes.windll.user32.PrintWindow(hwnd, dc_object.GetSafeHdc(), PW_RENDERFULLCONTENT) compatible_dc = dc_object.CreateCompatibleDC() @@ -62,14 +55,13 @@ def capture_region(hwnd: int, selection: Region, print_window: bool): dc_object, (selection["x"], selection["y"]), win32con.SRCCOPY) + image = np.frombuffer(cast(bytes, bitmap.GetBitmapBits(True)), dtype="uint8") + image.shape = (selection["height"], selection["width"], 4) # https://github.com/kaluluosi/pywin32-stubs/issues/5 # pylint: disable=no-member except (win32ui.error, pywintypes.error): # type: ignore return None - - image = np.frombuffer(cast(bytes, bitmap.GetBitmapBits(True)), dtype="uint8") - image.shape = (selection["height"], selection["width"], 4) - + # We already obtained the image, so we can ignore errors during cleanup try: dc_object.DeleteDC() compatible_dc.DeleteDC() @@ -78,10 +70,44 @@ def capture_region(hwnd: int, selection: Region, print_window: bool): # https://github.com/kaluluosi/pywin32-stubs/issues/5 except win32ui.error: # type: ignore pass - return image +def __d3d_capture(hwnd: int, selection: Region): + offset_x, offset_y, *_ = win32gui.GetWindowRect(hwnd) + hmonitor = ctypes.windll.user32.MonitorFromWindow(hwnd, win32con.MONITOR_DEFAULTTONEAREST) + desktop_duplication.display = [ + display for display in desktop_duplication.displays if display.hmonitor == hmonitor][0] + screenshot = desktop_duplication.screenshot(( + selection["x"] + offset_x, + selection["y"] + offset_y, + selection["width"] + selection["x"] + offset_x, + selection["height"] + selection["y"] + offset_y)) + return cv2.cvtColor(screenshot, cv2.COLOR_RGB2BGRA) + + +def capture_region(hwnd: int, selection: Region, capture_method: CaptureMethod): + """ + Captures an image of the region for a window matching the given + parameters of the bounding box + + @param hwnd: Handle to the window being captured + @param selection: The coordinates of the region + @return: The image of the region in the window in BGRA format + """ + + if capture_method == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + # Missing the InitializeWithWindow function in winrt https://github.com/microsoft/xlang/issues/756 + return None + # picker = capture.GraphicsCapturePicker() + # initialize_with_window(picker, hwnd) + + if capture_method == CaptureMethod.DESKTOP_DUPLICATION: + return __d3d_capture(hwnd, selection) + + return __bit_blt_capture(hwnd, selection, capture_method == CaptureMethod.PRINTWINDOW_RENDERFULLCONTENT) + + def set_ui_image(qlabel: QLabel, image: Optional[cv2.ndarray], transparency: bool): if image is None: # Clear current pixmap if image is None. But don't clear text diff --git a/src/menu_bar.py b/src/menu_bar.py index 22c16caf..1974dc42 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -15,6 +15,7 @@ import error_messages import user_profile +from capture_method import CAPTURE_METHODS, get_capture_method_by_index, get_capture_method_index from gen import about, design, resources_rc, settings as settings_ui, update_checker # noqa: F401 from hotkeys import set_hotkey @@ -116,6 +117,16 @@ def __init__(self, autosplit: AutoSplit): self.setupUi(self) self.autosplit = autosplit + # Build the Capture method combobox + list_view = QtWidgets.QListView() + list_view.setWordWrap(True) + self.capture_method_combobox.setView(list_view) + capture_methods = [ + f"- {method['name']} ({method['short_description']})" + for method in CAPTURE_METHODS.values()] + self.capture_method_combobox.setMinimumContentsLength(len(capture_methods) * 2) + self.capture_method_combobox.addItems(capture_methods) + # region Set initial values # Hotkeys self.split_input.setText(autosplit.settings_dict["split_hotkey"]) @@ -127,7 +138,8 @@ def __init__(self, autosplit: AutoSplit): # Capture Settings self.fps_limit_spinbox.setValue(autosplit.settings_dict["fps_limit"]) self.live_capture_region_checkbox.setChecked(autosplit.settings_dict["live_capture_region"]) - self.force_print_window_checkbox.setChecked(autosplit.settings_dict["force_print_window"]) + self.capture_method_combobox.setCurrentIndex( + get_capture_method_index(autosplit.settings_dict["capture_method"])) # Image Settings self.default_comparison_method.setCurrentIndex(autosplit.settings_dict["default_comparison_method"]) @@ -151,9 +163,9 @@ def __init__(self, autosplit: AutoSplit): self.live_capture_region_checkbox.stateChanged.connect(lambda: self.__set_value( "live_capture_region", self.live_capture_region_checkbox.isChecked())) - self.force_print_window_checkbox.stateChanged.connect(lambda: self.__set_value( - "force_print_window", - self.force_print_window_checkbox.isChecked())) + self.capture_method_combobox.currentIndexChanged.connect(lambda: self.__set_value( + "capture_method", + get_capture_method_by_index(self.capture_method_combobox.currentIndex()))) # Image Settings self.default_comparison_method.currentIndexChanged.connect(lambda: self.__set_value( @@ -191,7 +203,7 @@ def get_default_settings_from_ui(autosplit: AutoSplit): "pause_hotkey": default_settings_dialog.pause_input.text(), "fps_limit": default_settings_dialog.fps_limit_spinbox.value(), "live_capture_region": default_settings_dialog.live_capture_region_checkbox.isChecked(), - "force_print_window": default_settings_dialog.force_print_window_checkbox.isChecked(), + "capture_method": get_capture_method_by_index(default_settings_dialog.capture_method_combobox.currentIndex()), "default_comparison_method": default_settings_dialog.default_comparison_method.currentIndex(), "default_similarity_threshold": default_settings_dialog.default_similarity_threshold_spinbox.value(), "default_delay_time": default_settings_dialog.default_delay_time_spinbox.value(), diff --git a/src/screen_region.py b/src/screen_region.py index a3c348a3..f81ded7a 100644 --- a/src/screen_region.py +++ b/src/screen_region.py @@ -82,7 +82,7 @@ def select_window(autosplit: AutoSplit): # On Windows there is a shadow around the windows that we need to account for # The top bar with the window name is also not accounted for # HACK: This isn't an ideal solution because it assumes every window will have a top bar and shadows of default size - # FIXME: Which results in cutting *into* windows which don't have shadows or have a smaller top bars + # FIXME: Which results in cutting *into* windows which don't have shadows or have a smaller top bar _, __, width, height = win32gui.GetClientRect(autosplit.hwnd) __set_region_values(autosplit, left=WINDOWS_SHADOW_SIZE, @@ -135,7 +135,7 @@ def align_region(autosplit: AutoSplit): capture = capture_windows.capture_region( autosplit.hwnd, autosplit.settings_dict["capture_region"], - autosplit.settings_dict["force_print_window"]) + autosplit.settings_dict["capture_method"]) if capture is None: error_messages.region() diff --git a/src/user_profile.py b/src/user_profile.py index 804ef3d4..3da2e29e 100644 --- a/src/user_profile.py +++ b/src/user_profile.py @@ -12,7 +12,8 @@ from PyQt6 import QtCore, QtWidgets import error_messages -from capture_windows import Region +from capture_method import get_capture_method_by_index +from capture_windows import CaptureMethod, Region from gen import design from hotkeys import set_hotkey @@ -30,7 +31,7 @@ class UserProfileDict(TypedDict): pause_hotkey: str fps_limit: int live_capture_region: bool - force_print_window: bool + capture_method: CaptureMethod default_comparison_method: int default_similarity_threshold: float default_delay_time: int @@ -50,7 +51,7 @@ class UserProfileDict(TypedDict): pause_hotkey="", fps_limit=60, live_capture_region=True, - force_print_window=False, + capture_method=get_capture_method_by_index(0), default_comparison_method=0, default_similarity_threshold=0.95, default_delay_time=0, @@ -70,14 +71,9 @@ def save_settings(autosplit: AutoSplit): """ @return: The save settings filepath. Or None if "Save Settings As" is cancelled """ - if not autosplit.last_successfully_loaded_settings_file_path: - return save_settings_as(autosplit) - - autosplit.last_saved_settings = autosplit.settings_dict - # Save settings to a .toml file - with open(autosplit.last_successfully_loaded_settings_file_path, "w", encoding="utf-8") as file: - toml.dump(autosplit.last_saved_settings, file) - return autosplit.last_successfully_loaded_settings_file_path + return __save_settings_to_file(autosplit, autosplit.last_successfully_loaded_settings_file_path) \ + if autosplit.last_successfully_loaded_settings_file_path \ + else save_settings_as(autosplit) def save_settings_as(autosplit: AutoSplit): @@ -96,12 +92,14 @@ def save_settings_as(autosplit: AutoSplit): if not save_settings_file_path: return "" - autosplit.last_saved_settings = autosplit.settings_dict + return __save_settings_to_file(autosplit, save_settings_file_path) + +def __save_settings_to_file(autosplit: AutoSplit, save_settings_file_path: str): + autosplit.last_saved_settings = autosplit.settings_dict # Save settings to a .toml file with open(save_settings_file_path, "w", encoding="utf-8") as file: toml.dump(autosplit.last_saved_settings, file) - autosplit.last_successfully_loaded_settings_file_path = save_settings_file_path return save_settings_file_path From 6d334c3fad0e098d564ae64629e841a96e3fded7 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 2 Apr 2022 23:44:18 -0400 Subject: [PATCH 024/137] d3dshot stub --- typings/d3dshot/__init__.pyi | 20 +++ typings/d3dshot/capture_output.pyi | 37 ++++++ typings/d3dshot/capture_outputs/__init__.pyi | 4 + .../capture_outputs/numpy_capture_output.pyi | 23 ++++ .../numpy_float_capture_output.pyi | 15 +++ .../capture_outputs/pil_capture_output.pyi | 20 +++ .../pytorch_capture_output.pyi | 20 +++ .../pytorch_float_capture_output.pyi | 14 ++ .../pytorch_float_gpu_capture_output.pyi | 14 ++ .../pytorch_gpu_capture_output.pyi | 17 +++ typings/d3dshot/d3dshot.pyi | 86 +++++++++++++ typings/d3dshot/display.pyi | 47 +++++++ typings/d3dshot/dll/__init__.pyi | 4 + typings/d3dshot/dll/d3d.pyi | 55 ++++++++ typings/d3dshot/dll/dxgi.pyi | 121 ++++++++++++++++++ typings/d3dshot/dll/shcore.pyi | 7 + typings/d3dshot/dll/user32.pyi | 18 +++ 17 files changed, 522 insertions(+) create mode 100644 typings/d3dshot/__init__.pyi create mode 100644 typings/d3dshot/capture_output.pyi create mode 100644 typings/d3dshot/capture_outputs/__init__.pyi create mode 100644 typings/d3dshot/capture_outputs/numpy_capture_output.pyi create mode 100644 typings/d3dshot/capture_outputs/numpy_float_capture_output.pyi create mode 100644 typings/d3dshot/capture_outputs/pil_capture_output.pyi create mode 100644 typings/d3dshot/capture_outputs/pytorch_capture_output.pyi create mode 100644 typings/d3dshot/capture_outputs/pytorch_float_capture_output.pyi create mode 100644 typings/d3dshot/capture_outputs/pytorch_float_gpu_capture_output.pyi create mode 100644 typings/d3dshot/capture_outputs/pytorch_gpu_capture_output.pyi create mode 100644 typings/d3dshot/d3dshot.pyi create mode 100644 typings/d3dshot/display.pyi create mode 100644 typings/d3dshot/dll/__init__.pyi create mode 100644 typings/d3dshot/dll/d3d.pyi create mode 100644 typings/d3dshot/dll/dxgi.pyi create mode 100644 typings/d3dshot/dll/shcore.pyi create mode 100644 typings/d3dshot/dll/user32.pyi diff --git a/typings/d3dshot/__init__.pyi b/typings/d3dshot/__init__.pyi new file mode 100644 index 00000000..4fd2e1bd --- /dev/null +++ b/typings/d3dshot/__init__.pyi @@ -0,0 +1,20 @@ +""" # noqa: Y021 +This type stub file was generated by pyright. +""" + +from d3dshot.d3dshot import D3DShot + +pil_is_available = ... +numpy_is_available = ... +pytorch_is_available = ... +pytorch_gpu_is_available = ... +capture_output_mapping = ... +capture_outputs = ... + + +def determine_available_capture_outputs() -> list: + ... + + +def create(capture_output=..., frame_buffer_size=...) -> D3DShot: + ... diff --git a/typings/d3dshot/capture_output.pyi b/typings/d3dshot/capture_output.pyi new file mode 100644 index 00000000..2ee804e0 --- /dev/null +++ b/typings/d3dshot/capture_output.pyi @@ -0,0 +1,37 @@ +""" # noqa: Y021 +This type stub file was generated by pyright. +""" +import enum +from typing import Any +from PIL import Image +from numpy.typing import NDArray +from numpy import uint8 + + +class CaptureOutputs(enum.Enum): + PIL = ... + NUMPY = ... + NUMPY_FLOAT = ... + PYTORCH = ... + PYTORCH_FLOAT = ... + PYTORCH_GPU = ... + PYTORCH_FLOAT_GPU = ... + + +class CaptureOutputError(BaseException): + ... + + +class CaptureOutput: + def __init__(self, backend=...) -> None: + ... + + def process(self, pointer, pitch, size, width, height, region, + rotation) -> Image | NDArray | NDArray[uint8] | Any: + ... + + def to_pil(self, frame) -> Image: + ... + + def stack(self, frames, stack_dimension) -> NDArray: + ... diff --git a/typings/d3dshot/capture_outputs/__init__.pyi b/typings/d3dshot/capture_outputs/__init__.pyi new file mode 100644 index 00000000..006bc274 --- /dev/null +++ b/typings/d3dshot/capture_outputs/__init__.pyi @@ -0,0 +1,4 @@ +""" +This type stub file was generated by pyright. +""" + diff --git a/typings/d3dshot/capture_outputs/numpy_capture_output.pyi b/typings/d3dshot/capture_outputs/numpy_capture_output.pyi new file mode 100644 index 00000000..66c473a3 --- /dev/null +++ b/typings/d3dshot/capture_outputs/numpy_capture_output.pyi @@ -0,0 +1,23 @@ +""" # noqa: Y021 +This type stub file was generated by pyright. +""" + +from numpy import uint8 +from numpy.typing import NDArray +from PIL import Image +from d3dshot.capture_output import CaptureOutput + + +class NumpyCaptureOutput(CaptureOutput): + def __init__(self) -> None: + ... + + def process(self, pointer, pitch, size, width, height, region, + rotation) -> NDArray | NDArray[uint8]: + ... + + def to_pil(self, frame) -> Image: + ... + + def stack(self, frames, stack_dimension) -> NDArray: + ... diff --git a/typings/d3dshot/capture_outputs/numpy_float_capture_output.pyi b/typings/d3dshot/capture_outputs/numpy_float_capture_output.pyi new file mode 100644 index 00000000..d1fd482a --- /dev/null +++ b/typings/d3dshot/capture_outputs/numpy_float_capture_output.pyi @@ -0,0 +1,15 @@ +""" # noqa: Y021 +This type stub file was generated by pyright. +""" + +from typing import Any +from PIL import Image +from d3dshot.capture_outputs.numpy_capture_output import NumpyCaptureOutput + + +class NumpyFloatCaptureOutput(NumpyCaptureOutput): + def process(self, pointer, pitch, size, width, height, region, rotation) -> Any: + ... + + def to_pil(self, frame) -> Image: + ... diff --git a/typings/d3dshot/capture_outputs/pil_capture_output.pyi b/typings/d3dshot/capture_outputs/pil_capture_output.pyi new file mode 100644 index 00000000..53a91a11 --- /dev/null +++ b/typings/d3dshot/capture_outputs/pil_capture_output.pyi @@ -0,0 +1,20 @@ +""" # noqa: Y021 +This type stub file was generated by pyright. +""" + +from PIL import Image +from d3dshot.capture_output import CaptureOutput + + +class PILCaptureOutput(CaptureOutput): + def __init__(self) -> None: + ... + + def process(self, pointer, pitch, size, width, height, region, rotation) -> Image: + ... + + def to_pil(self, frame): + ... + + def stack(self, frames, stack_dimension): + ... diff --git a/typings/d3dshot/capture_outputs/pytorch_capture_output.pyi b/typings/d3dshot/capture_outputs/pytorch_capture_output.pyi new file mode 100644 index 00000000..5c301c91 --- /dev/null +++ b/typings/d3dshot/capture_outputs/pytorch_capture_output.pyi @@ -0,0 +1,20 @@ +""" # noqa: Y021 +This type stub file was generated by pyright. +""" + +from PIL import Image +from d3dshot.capture_output import CaptureOutput + + +class PytorchCaptureOutput(CaptureOutput): + def __init__(self) -> None: + ... + + def process(self, pointer, pitch, size, width, height, region, rotation): + ... + + def to_pil(self, frame) -> Image: + ... + + def stack(self, frames, stack_dimension): + ... diff --git a/typings/d3dshot/capture_outputs/pytorch_float_capture_output.pyi b/typings/d3dshot/capture_outputs/pytorch_float_capture_output.pyi new file mode 100644 index 00000000..01387617 --- /dev/null +++ b/typings/d3dshot/capture_outputs/pytorch_float_capture_output.pyi @@ -0,0 +1,14 @@ +""" # noqa: Y021 +This type stub file was generated by pyright. +""" + +from PIL import Image +from d3dshot.capture_outputs.pytorch_capture_output import PytorchCaptureOutput + + +class PytorchFloatCaptureOutput(PytorchCaptureOutput): + def process(self, pointer, pitch, size, width, height, region, rotation): + ... + + def to_pil(self, frame) -> Image: + ... diff --git a/typings/d3dshot/capture_outputs/pytorch_float_gpu_capture_output.pyi b/typings/d3dshot/capture_outputs/pytorch_float_gpu_capture_output.pyi new file mode 100644 index 00000000..0fe4245b --- /dev/null +++ b/typings/d3dshot/capture_outputs/pytorch_float_gpu_capture_output.pyi @@ -0,0 +1,14 @@ +""" # noqa: Y021 +This type stub file was generated by pyright. +""" + +from PIL import Image +from d3dshot.capture_outputs.pytorch_gpu_capture_output import PytorchGPUCaptureOutput + + +class PytorchFloatGPUCaptureOutput(PytorchGPUCaptureOutput): + def process(self, pointer, pitch, size, width, height, region, rotation): + ... + + def to_pil(self, frame) -> Image: + ... diff --git a/typings/d3dshot/capture_outputs/pytorch_gpu_capture_output.pyi b/typings/d3dshot/capture_outputs/pytorch_gpu_capture_output.pyi new file mode 100644 index 00000000..ad2339ba --- /dev/null +++ b/typings/d3dshot/capture_outputs/pytorch_gpu_capture_output.pyi @@ -0,0 +1,17 @@ +""" # noqa: Y021 +This type stub file was generated by pyright. +""" + +from PIL import Image +from d3dshot.capture_outputs.pytorch_capture_output import PytorchCaptureOutput + + +class PytorchGPUCaptureOutput(PytorchCaptureOutput): + def __init__(self) -> None: + ... + + def process(self, pointer, pitch, size, width, height, region, rotation): + ... + + def to_pil(self, frame) -> Image: + ... diff --git a/typings/d3dshot/d3dshot.pyi b/typings/d3dshot/d3dshot.pyi new file mode 100644 index 00000000..f5e60832 --- /dev/null +++ b/typings/d3dshot/d3dshot.pyi @@ -0,0 +1,86 @@ +""" # noqa: Y021 +This type stub file was generated by pyright. +""" +from typing import Optional +from collections import deque +from numpy.typing import NDArray +from d3dshot.display import Display +from d3dshot.capture_output import CaptureOutput + +import cv2 + + +class Singleton(type): + _instances = ... + + def __call__(cls, *args, **kwargs): + ... + + +class D3DShot(metaclass=Singleton): + def __init__( + self, + capture_output=..., + frame_buffer_size: int = ..., + pil_is_available: bool = ..., + numpy_is_available: bool = ..., + pytorch_is_available: bool = ..., + pytorch_gpu_is_available: bool = ...) -> None: + ... + + displays: list[Display] + display: Display + capture_output: CaptureOutput + frame_buffer_size: int + frame_buffer: deque + previous_screenshot: Optional + region: Optional + _pil_is_available: bool + _numpy_is_available: bool + _pytorch_is_available: bool + _pytorch_gpu_is_available: bool + _capture_thread: Optional + _is_capturing: bool + + @property + def is_capturing(self) -> bool: + ... + + def get_latest_frame(self) -> None: + ... + + def get_frame(self, frame_index) -> None: + ... + + def get_frames(self, frame_indices) -> list: + ... + + def get_frame_stack(self, frame_indices, stack_dimension=...) -> NDArray: + ... + + def screenshot(self, region: tuple[int, int, int, int] = ...) -> cv2.ndarray: + ... + + def screenshot_to_disk(self, directory=..., file_name=..., region: tuple[int, int, int, int] = ...) -> str: + ... + + def frame_buffer_to_disk(self, directory=...) -> None: + ... + + def capture(self, target_fps=..., region: tuple[int, int, int, int] = ...) -> bool: + ... + + def screenshot_every(self, interval, region: tuple[int, int, int, int] = ...) -> bool: + ... + + def screenshot_to_disk_every(self, interval, directory=..., region: tuple[int, int, int, int] = ...) -> bool: + ... + + def stop(self) -> bool: + ... + + def benchmark(self) -> None: + ... + + def detect_displays(self) -> None: + ... diff --git a/typings/d3dshot/display.pyi b/typings/d3dshot/display.pyi new file mode 100644 index 00000000..56eb40be --- /dev/null +++ b/typings/d3dshot/display.pyi @@ -0,0 +1,47 @@ +""" # noqa: Y021 +This type stub file was generated by pyright. +""" + + +from typing import Literal, Optional +import ctypes + + +class Display: + name: str + adapter_name: str + resolution: tuple[int, int] + position: dict[Literal["left", "top", "right", "bottom"], int] + rotation: int + scale_factor: int + is_primary: bool + hmonitor: int + dxgi_output: Optional = ... + dxgi_adapter: Optional = ... + d3d_device: Optional = ... + d3d_device_context: Optional = ... + dxgi_output_duplication: ctypes.pointer + + def __init__( + self, + name=..., + adapter_name=..., + resolution=..., + position=..., + rotation=..., + scale_factor=..., + is_primary=..., + hmonitor=..., + dxgi_output=..., + dxgi_adapter=...) -> None: + ... + + def __repr__(self) -> str: + ... + + def capture(self, process_func, region=...) -> None: + ... + + @classmethod + def discover_displays(cls) -> list: + ... diff --git a/typings/d3dshot/dll/__init__.pyi b/typings/d3dshot/dll/__init__.pyi new file mode 100644 index 00000000..006bc274 --- /dev/null +++ b/typings/d3dshot/dll/__init__.pyi @@ -0,0 +1,4 @@ +""" +This type stub file was generated by pyright. +""" + diff --git a/typings/d3dshot/dll/d3d.pyi b/typings/d3dshot/dll/d3d.pyi new file mode 100644 index 00000000..a904e68a --- /dev/null +++ b/typings/d3dshot/dll/d3d.pyi @@ -0,0 +1,55 @@ +""" # noqa: Y021 +This type stub file was generated by pyright. +""" + +import ctypes +import comtypes + + +class DXGI_SAMPLE_DESC(ctypes.Structure): + _fields_ = ... + + +class D3D11_BOX(ctypes.Structure): + _fields_ = ... + + +class D3D11_TEXTURE2D_DESC(ctypes.Structure): + _fields_ = ... + + +class ID3D11DeviceChild(comtypes.IUnknown): + _iid_ = ... + _methods_ = ... + + +class ID3D11Resource(ID3D11DeviceChild): + _iid_ = ... + _methods_ = ... + + +class ID3D11Texture2D(ID3D11Resource): + _iid_ = ... + _methods_ = ... + + +class ID3D11DeviceContext(ID3D11DeviceChild): + _iid_ = ... + _methods_ = ... + + +class ID3D11Device(comtypes.IUnknown): + _iid_ = ... + _methods_ = ... + + +def initialize_d3d_device(dxgi_adapter) -> tuple[ctypes.pointer, ctypes.pointer]: + ... + + +def describe_d3d11_texture_2d(d3d11_texture_2d) -> D3D11_TEXTURE2D_DESC: + ... + + +def prepare_d3d11_texture_2d_for_cpu(d3d11_texture_2d, d3d_device) -> ctypes.pointer: + ... diff --git a/typings/d3dshot/dll/dxgi.pyi b/typings/d3dshot/dll/dxgi.pyi new file mode 100644 index 00000000..acf927e9 --- /dev/null +++ b/typings/d3dshot/dll/dxgi.pyi @@ -0,0 +1,121 @@ +""" # noqa: Y021 +This type stub file was generated by pyright. +""" + +from typing import Any, Union +import ctypes +import comtypes + + +class LUID(ctypes.Structure): + _fields_ = ... + + +class DXGI_ADAPTER_DESC1(ctypes.Structure): + _fields_ = ... + + +class DXGI_OUTPUT_DESC(ctypes.Structure): + _fields_ = ... + + +class DXGI_OUTDUPL_POINTER_POSITION(ctypes.Structure): + _fields_ = ... + + +class DXGI_OUTDUPL_FRAME_INFO(ctypes.Structure): + _fields_ = ... + + +class DXGI_MAPPED_RECT(ctypes.Structure): + _fields_ = ... + + +class IDXGIObject(comtypes.IUnknown): + _iid_ = ... + _methods_ = ... + + +class IDXGIDeviceSubObject(IDXGIObject): + _iid_ = ... + _methods_ = ... + + +class IDXGIResource(IDXGIDeviceSubObject): + _iid_ = ... + _methods_ = ... + + +class IDXGISurface(IDXGIDeviceSubObject): + _iid_ = ... + _methods_ = ... + + +class IDXGIOutputDuplication(IDXGIObject): + _iid_ = ... + _methods_ = ... + + +class IDXGIOutput(IDXGIObject): + _iid_ = ... + _methods_ = ... + + +class IDXGIOutput1(IDXGIOutput): + _iid_ = ... + _methods_ = ... + + +class IDXGIAdapter(IDXGIObject): + _iid_ = ... + _methods_ = ... + + +class IDXGIAdapter1(IDXGIAdapter): + _iid_ = ... + _methods_ = ... + + +class IDXGIFactory(IDXGIObject): + _iid_ = ... + _methods_ = ... + + +class IDXGIFactory1(IDXGIFactory): + _iid_ = ... + _methods_ = ... + + +def initialize_dxgi_factory() -> ctypes.pointer: + ... + + +def discover_dxgi_adapters(dxgi_factory) -> list: + ... + + +def describe_dxgi_adapter(dxgi_adapter) -> Any: + ... + + +def discover_dxgi_outputs(dxgi_adapter) -> list: + ... + + +def describe_dxgi_output(dxgi_output) -> dict[str, Union[Any, dict[str, Any], tuple[Any, Any], int, bool]]: + ... + + +def initialize_dxgi_output_duplication(dxgi_output, d3d_device) -> ctypes.pointer: + ... + + +def get_dxgi_output_duplication_frame( + dxgi_output_duplication, + d3d_device, + process_func=..., + width=..., + height=..., + region=..., + rotation=...) -> None: + ... diff --git a/typings/d3dshot/dll/shcore.pyi b/typings/d3dshot/dll/shcore.pyi new file mode 100644 index 00000000..fc42f4e8 --- /dev/null +++ b/typings/d3dshot/dll/shcore.pyi @@ -0,0 +1,7 @@ +""" # noqa: Y021 +This type stub file was generated by pyright. +""" + + +def get_scale_factor_for_monitor(hmonitor) -> float: + ... diff --git a/typings/d3dshot/dll/user32.pyi b/typings/d3dshot/dll/user32.pyi new file mode 100644 index 00000000..a4d9f20f --- /dev/null +++ b/typings/d3dshot/dll/user32.pyi @@ -0,0 +1,18 @@ +""" # noqa: Y021 +This type stub file was generated by pyright. +""" + +from typing import Any +import ctypes + + +class DISPLAY_DEVICE(ctypes.Structure): + _fields_ = ... + + +def get_display_device_name_mapping() -> dict: + ... + + +def get_hmonitor_by_point(x, y) -> Any: + ... From 7d4f860920315e19bc144d01f2eb3a79cf1ed5df Mon Sep 17 00:00:00 2001 From: Avasam Date: Sun, 3 Apr 2022 18:13:58 -0400 Subject: [PATCH 025/137] Split dropdown for supported imread filetypes --- src/screen_region.py | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/src/screen_region.py b/src/screen_region.py index f81ded7a..74c1b18c 100644 --- a/src/screen_region.py +++ b/src/screen_region.py @@ -16,7 +16,24 @@ import capture_windows import error_messages - +SUPPORTED_IMREAD_FORMATS = [ + ("Windows bitmaps", "*.bmp *.dib"), + ("JPEG files", "*.jpeg *.jpg *.jpe"), + ("JPEG 2000 files", "*.jp2"), + ("Portable Network Graphics", "*.png"), + ("WebP", "*.webp"), + ("Portable image format", "*.pbm *.pgm *.ppm *.pxm *.pnm"), + ("PFM files", "*.pfm"), + ("Sun rasters", "*.sr *.ras"), + ("TIFF files", "*.tiff *.tif"), + ("OpenEXR Image files", "*.exr"), + ("Radiance HDR", "*.hdr *.pic"), +] +"""https://docs.opencv.org/4.5.4/d4/da8/group__imgcodecs.html#ga288b8b3da0892bd651fce07b3bbd3a56""" +IMREAD_EXT_FILTER = "All Files (" \ + + " ".join([f"{extensions}" for _, extensions in SUPPORTED_IMREAD_FORMATS]) \ + + ");;"\ + + ";;".join([f"{format} ({extensions})" for format, extensions in SUPPORTED_IMREAD_FORMATS]) WINDOWS_SHADOW_SIZE = 8 WINDOWS_TOPBAR_SIZE = 24 user32 = ctypes.windll.user32 @@ -116,7 +133,7 @@ def align_region(autosplit: AutoSplit): autosplit, "Select Reference Image", "", - "Image Files (*.png *.jpg *.jpeg *.jpe *.jp2 *.bmp *.tiff *.tif *.dib *.webp *.pbm *.pgm *.ppm *.sr *.ras)" + IMREAD_EXT_FILTER, )[0] # Return if the user presses cancel From 54c68c05f8125ab3f1a45a974e14c22bc0421fe3 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sun, 3 Apr 2022 18:15:02 -0400 Subject: [PATCH 026/137] Finished implementing desktop duplicaton Added a check for Win version for graphics capture --- src/AutoSplit.py | 16 ++++------------ src/capture_method.py | 41 +++++++++++++++++++++++++++-------------- src/capture_windows.py | 35 ++++++++++++++++++++++++----------- src/screen_region.py | 5 +---- 4 files changed, 56 insertions(+), 41 deletions(-) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 15e90bf3..464064c3 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -247,9 +247,7 @@ def __live_image_function(self): return # Set live image in UI if self.hwnd: - capture = capture_region(self.hwnd, - self.settings_dict["capture_region"], - self.settings_dict["capture_method"]) + capture = capture_region(self) set_ui_image(self.live_image, capture, False) def __load_start_image(self, started_by_button: bool = False, wait_for_delay: bool = True): @@ -383,9 +381,7 @@ def __take_screenshot(self): screenshot_index += 1 # Grab screenshot of capture region - capture = capture_region(self.hwnd, - self.settings_dict["capture_region"], - self.settings_dict["capture_method"]) + capture = capture_region(self) if capture is None: error_messages.region() return @@ -750,9 +746,7 @@ def __get_capture_for_comparison(self): """ Grab capture region and resize for comparison """ - capture = capture_region(self.hwnd, - self.settings_dict["capture_region"], - self.settings_dict["capture_method"]) + capture = capture_region(self) # This most likely means we lost capture (ie the captured window was closed, crashed, etc.) if capture is None: @@ -763,9 +757,7 @@ def __get_capture_for_comparison(self): # Don't fallback to desktop if hwnd: self.hwnd = hwnd - capture = capture_region(self.hwnd, - self.settings_dict["capture_region"], - self.settings_dict["capture_method"]) + capture = capture_region(self) return None if capture is None else cv2.resize(capture, COMPARISON_RESIZE, interpolation=cv2.INTER_NEAREST) def __reset_if_should(self, capture: Optional[cv2.ndarray]): diff --git a/src/capture_method.py b/src/capture_method.py index 55e34e64..8a1acac7 100644 --- a/src/capture_method.py +++ b/src/capture_method.py @@ -1,7 +1,10 @@ from typing import TypedDict +from platform import version from collections import OrderedDict from enum import Enum, unique +# https://docs.microsoft.com/en-us/uwp/api/windows.graphics.capture.graphicscapturepicker#applies-to +WCG_MIN_BUILD = 17134 class CaptureMethodInfo(TypedDict): @@ -35,29 +38,38 @@ def __hash__(self): CaptureMethod.BITBLT: CaptureMethodInfo( name="BitBlt", short_description="fast, issues with Hardware Acceleration and OpenGL", - description="A good default fast option. Allows recording background windows " - + "(as long as they still decide to render in the background), " - + "but it cannot properly record OpenGL or Hardware Accelerated Windows.", + description=( + "A good default fast option. Allows recording background windows " + "(as long as they still decide to render in the background), " + "but it cannot properly record OpenGL or Hardware Accelerated Windows." + ), ), CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: CaptureMethodInfo( name="Windows Graphics Capture", - short_description="Windows 10 1903 and up, most compatible if available", - description="Only available in recent Windows updates. Allows recording UWP apps " - + "(hardware accelerated and fullscreen exclusives? To be tested). " - + "Adds a yellow border around the recorded window.", + short_description="Windows 10 {WCG_MIN_BUILD} and up, most compatible if available", + description=( + "Only available in recent Windows updates. Allows recording UWP apps " + "(hardware accelerated and fullscreen exclusives? To be tested). " + "Adds a yellow border around the recorded window." + ), ), CaptureMethod.DESKTOP_DUPLICATION: CaptureMethodInfo( name="Direct3D Desktop Duplication", - short_description="very slow, overlapping windows, supports OpenGL and DirectX 11/12 exclusive fullscreen", - description="Duplicates the desktop using Direct3D. It can record OpenGL and Hardware Accelerated windows. " - + "But it's about 10-15x slower than BitBlt and overlapping windows will show up.", + short_description="very slow, bound to display, supports OpenGL and DirectX 11/12 exclusive fullscreen", + description=( + "Duplicates the desktop using Direct3D. It can record OpenGL and Hardware Accelerated windows. " + "But it's about 10-15x slower than BitBlt, " + "overlapping windows will show up and can't record across displays." + ), ), CaptureMethod.PRINTWINDOW_RENDERFULLCONTENT: CaptureMethodInfo( name="Force Full Content Rendering", short_description="very slow, can affect rendering pipeline", - description="Uses BitBlt behind the scene, but passes a special flag to PrintWindow to force rendering the " - + "entire desktop window. About 10-15x slower than BitBlt based on window size and can mess up some " - + "applications' rendering pipelines.", + description=( + "Uses BitBlt behind the scene, but passes a special flag to PrintWindow to force rendering the " + "entire desktop window. About 10-15x slower than BitBlt based on window size and can mess up some " + "applications' rendering pipelines." + ), ), }) @@ -77,4 +89,5 @@ def get_capture_method_by_index(index: int): # Detect and remove unsupported capture methods -CAPTURE_METHODS.pop(CaptureMethod.WINDOWS_GRAPHICS_CAPTURE) # Not yet implemented +if int(version().split(".")[2]) < WCG_MIN_BUILD: + CAPTURE_METHODS.pop(CaptureMethod.WINDOWS_GRAPHICS_CAPTURE) # Not yet implemented diff --git a/src/capture_windows.py b/src/capture_windows.py index 3157ddbb..85f47a2c 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -1,13 +1,16 @@ from __future__ import annotations -from typing import Optional, TypedDict, cast +from typing import Optional, TypedDict, cast, TYPE_CHECKING +if TYPE_CHECKING: + from AutoSplit import AutoSplit import ctypes import ctypes.wintypes import d3dshot +# from winsdk.windows.graphics.capture import GraphicsCapturePicker +# from winsdk._winrt import initialize_with_window + from PyQt6 import QtCore, QtGui from PyQt6.QtWidgets import QLabel -# from winrt.windows.graphics import capture -# from winrt._winrt import initialize_with_window import cv2 import numpy as np @@ -74,10 +77,14 @@ def __bit_blt_capture(hwnd: int, selection: Region, render_full_content: bool = def __d3d_capture(hwnd: int, selection: Region): - offset_x, offset_y, *_ = win32gui.GetWindowRect(hwnd) hmonitor = ctypes.windll.user32.MonitorFromWindow(hwnd, win32con.MONITOR_DEFAULTTONEAREST) desktop_duplication.display = [ - display for display in desktop_duplication.displays if display.hmonitor == hmonitor][0] + display for display + in desktop_duplication.displays + if display.hmonitor == hmonitor][0] + offset_x, offset_y, *_ = win32gui.GetWindowRect(hwnd) + offset_x -= desktop_duplication.display.position["left"] + offset_y -= desktop_duplication.display.position["top"] screenshot = desktop_duplication.screenshot(( selection["x"] + offset_x, selection["y"] + offset_y, @@ -86,7 +93,13 @@ def __d3d_capture(hwnd: int, selection: Region): return cv2.cvtColor(screenshot, cv2.COLOR_RGB2BGRA) -def capture_region(hwnd: int, selection: Region, capture_method: CaptureMethod): +# def __windows_graphics_capture(hwnd: int, selection: Region, autosplit_hwnd: int): +# picker = GraphicsCapturePicker() +# initialize_with_window(picker, autosplit_hwnd) +# picker.pick_single_item_async() + + +def capture_region(autosplit: AutoSplit): """ Captures an image of the region for a window matching the given parameters of the bounding box @@ -95,12 +108,12 @@ def capture_region(hwnd: int, selection: Region, capture_method: CaptureMethod): @param selection: The coordinates of the region @return: The image of the region in the window in BGRA format """ + hwnd = autosplit.hwnd + selection = autosplit.settings_dict["capture_region"] + capture_method = autosplit.settings_dict["capture_method"] - if capture_method == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: - # Missing the InitializeWithWindow function in winrt https://github.com/microsoft/xlang/issues/756 - return None - # picker = capture.GraphicsCapturePicker() - # initialize_with_window(picker, hwnd) + # if capture_method == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + # return __windows_graphics_capture(hwnd, selection, autosplit.effectiveWinId().__int__()) if capture_method == CaptureMethod.DESKTOP_DUPLICATION: return __d3d_capture(hwnd, selection) diff --git a/src/screen_region.py b/src/screen_region.py index 74c1b18c..3370e887 100644 --- a/src/screen_region.py +++ b/src/screen_region.py @@ -149,10 +149,7 @@ def align_region(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.settings_dict["capture_region"], - autosplit.settings_dict["capture_method"]) + capture = capture_windows.capture_region(autosplit) if capture is None: error_messages.region() From 886b5969e3e8b7b434f592694f133621af7df38b Mon Sep 17 00:00:00 2001 From: Avasam Date: Sun, 3 Apr 2022 19:29:22 -0400 Subject: [PATCH 027/137] Fixed dropdown height on first open and added tooltip --- src/capture_method.py | 28 +++++++++++++++------------- src/capture_windows.py | 2 ++ src/menu_bar.py | 23 +++++++++++++++-------- 3 files changed, 32 insertions(+), 21 deletions(-) diff --git a/src/capture_method.py b/src/capture_method.py index 8a1acac7..dbfbc02b 100644 --- a/src/capture_method.py +++ b/src/capture_method.py @@ -39,36 +39,38 @@ def __hash__(self): name="BitBlt", short_description="fast, issues with Hardware Acceleration and OpenGL", description=( - "A good default fast option. Allows recording background windows " - "(as long as they still decide to render in the background), " - "but it cannot properly record OpenGL or Hardware Accelerated Windows." + "\nA good default fast option. Allows recording background windows " + "\n(as long as they still decide to render in the background), " + "\nbut it cannot properly record OpenGL or Hardware Accelerated Windows. " ), ), CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: CaptureMethodInfo( name="Windows Graphics Capture", - short_description="Windows 10 {WCG_MIN_BUILD} and up, most compatible if available", + short_description=f"Windows 10 {WCG_MIN_BUILD} and up, most compatible if available", description=( - "Only available in recent Windows updates. Allows recording UWP apps " - "(hardware accelerated and fullscreen exclusives? To be tested). " - "Adds a yellow border around the recorded window." + "\nOnly available in recent Windows updates. Allows recording UWP apps " + "\n(hardware accelerated and fullscreen exclusives? To be tested). " + "\nAdds a yellow border around the recorded window. " ), ), CaptureMethod.DESKTOP_DUPLICATION: CaptureMethodInfo( name="Direct3D Desktop Duplication", short_description="very slow, bound to display, supports OpenGL and DirectX 11/12 exclusive fullscreen", description=( - "Duplicates the desktop using Direct3D. It can record OpenGL and Hardware Accelerated windows. " - "But it's about 10-15x slower than BitBlt, " - "overlapping windows will show up and can't record across displays." + "\nDuplicates the desktop using Direct3D. " + "\nIt can record OpenGL and Hardware Accelerated windows. " + "\nBut it's about 10-15x slower than BitBlt, " + "\noverlapping windows will show up and can't record across displays. " ), ), CaptureMethod.PRINTWINDOW_RENDERFULLCONTENT: CaptureMethodInfo( name="Force Full Content Rendering", short_description="very slow, can affect rendering pipeline", description=( - "Uses BitBlt behind the scene, but passes a special flag to PrintWindow to force rendering the " - "entire desktop window. About 10-15x slower than BitBlt based on window size and can mess up some " - "applications' rendering pipelines." + "\nUses BitBlt behind the scene, but passes a special flag " + "\nto PrintWindow to force rendering the entire desktop window. " + "\nAbout 10-15x slower than BitBlt based on window size " + "\nand can mess up some applications' rendering pipelines. " ), ), }) diff --git a/src/capture_windows.py b/src/capture_windows.py index 85f47a2c..33b76061 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -78,6 +78,8 @@ def __bit_blt_capture(hwnd: int, selection: Region, render_full_content: bool = def __d3d_capture(hwnd: int, selection: Region): hmonitor = ctypes.windll.user32.MonitorFromWindow(hwnd, win32con.MONITOR_DEFAULTTONEAREST) + if not hmonitor: + return None desktop_duplication.display = [ display for display in desktop_duplication.displays diff --git a/src/menu_bar.py b/src/menu_bar.py index 1974dc42..56dea750 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -9,8 +9,7 @@ import requests from simplejson.errors import JSONDecodeError from packaging import version -from PyQt6 import QtWidgets -from PyQt6.QtCore import QThread +from PyQt6 import QtWidgets, QtCore from requests.exceptions import RequestException import error_messages @@ -22,8 +21,9 @@ # AutoSplit Version number VERSION = "1.6.1" - # About Window + + class __AboutWidget(QtWidgets.QWidget, about.Ui_AboutAutoSplitWidget): def __init__(self): super().__init__() @@ -76,7 +76,7 @@ def view_help(): webbrowser.open("https://github.com/Toufool/Auto-Split#tutorial") -class __CheckForUpdatesThread(QThread): +class __CheckForUpdatesThread(QtCore.QThread): def __init__(self, autosplit: AutoSplit, check_on_open: bool): super().__init__() self.autosplit = autosplit @@ -118,14 +118,21 @@ def __init__(self, autosplit: AutoSplit): self.autosplit = autosplit # Build the Capture method combobox - list_view = QtWidgets.QListView() - list_view.setWordWrap(True) - self.capture_method_combobox.setView(list_view) capture_methods = [ f"- {method['name']} ({method['short_description']})" for method in CAPTURE_METHODS.values()] - self.capture_method_combobox.setMinimumContentsLength(len(capture_methods) * 2) + list_view = QtWidgets.QListView() + list_view.setWordWrap(True) + # HACK: The first time the dropdown is rendered, it does not have the right height + # Assuming all options take 2 lines (except D3D which has 3). And all lines (with separator) takes 17 pixels + lines = (2 * len(capture_methods)) + 1 + list_view.setMinimumHeight((17 * lines) - 1) + list_view.setVerticalScrollBarPolicy(QtCore.Qt.ScrollBarPolicy.ScrollBarAlwaysOff) + self.capture_method_combobox.setView(list_view) self.capture_method_combobox.addItems(capture_methods) + self.capture_method_combobox.setToolTip("\n\n".join([ + f"{method['name']} :\n{method['description']}" + for method in CAPTURE_METHODS.values()])) # region Set initial values # Hotkeys From a7a13081696c8e3d9b48a8b8696ffa9d63ec0623 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sun, 3 Apr 2022 20:45:11 -0400 Subject: [PATCH 028/137] Prevent some infinite error loops --- src/AutoSplit.py | 13 +++++++------ src/capture_method.py | 4 ++-- src/error_messages.py | 16 +++++++++++++++- 3 files changed, 24 insertions(+), 9 deletions(-) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 464064c3..4f9f9d86 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -497,18 +497,18 @@ def __check_for_reset_state_update_ui(self): if self.settings_dict["loop_splits"]: self.start_auto_splitter_signal.emit() else: - self.gui_changes_on_reset() + self.gui_changes_on_reset(True) return True return False def __auto_splitter(self): if not self.settings_dict["split_hotkey"] and not self.is_auto_controlled: - self.gui_changes_on_reset() + self.gui_changes_on_reset(True) error_messages.split_hotkey() return if not (validate_before_parsing(self) and parse_and_validate_images(self)): - self.gui_changes_on_reset() + self.gui_changes_on_reset(True) return # Construct a list of images + loop count tuples. @@ -592,7 +592,7 @@ def __auto_splitter(self): return # loop breaks to here when the last image splits - self.gui_changes_on_reset() + self.gui_changes_on_reset(True) def __similarity_threshold_loop(self, number_of_split_images: int, dummy_splits_array: list[bool]): """ @@ -711,7 +711,7 @@ def gui_changes_on_start(self): QApplication.processEvents() - def gui_changes_on_reset(self): + def gui_changes_on_reset(self, safe_to_reload_start_image: bool = False): self.start_auto_splitter_button.setText(START_AUTO_SPLITTER_TEXT) self.image_loop_value_label.setText("N/A") self.current_split_image.clear() @@ -740,7 +740,8 @@ def gui_changes_on_reset(self): self.skip_split_button.setEnabled(False) QApplication.processEvents() - self.load_start_image_signal[bool, bool].emit(False, False) + if safe_to_reload_start_image: + self.load_start_image_signal[bool, bool].emit(False, False) def __get_capture_for_comparison(self): """ diff --git a/src/capture_method.py b/src/capture_method.py index dbfbc02b..59553d31 100644 --- a/src/capture_method.py +++ b/src/capture_method.py @@ -91,5 +91,5 @@ def get_capture_method_by_index(index: int): # Detect and remove unsupported capture methods -if int(version().split(".")[2]) < WCG_MIN_BUILD: - CAPTURE_METHODS.pop(CaptureMethod.WINDOWS_GRAPHICS_CAPTURE) # Not yet implemented +if int(version().split(".")[2]) < WCG_MIN_BUILD or True: # TODO: Not yet implemented + CAPTURE_METHODS.pop(CaptureMethod.WINDOWS_GRAPHICS_CAPTURE) diff --git a/src/error_messages.py b/src/error_messages.py index 4eb424b0..ecda5dc0 100644 --- a/src/error_messages.py +++ b/src/error_messages.py @@ -1,15 +1,29 @@ -# Error messages +"""Error messages""" +import os +import signal +import sys import traceback + from PyQt6 import QtCore, QtWidgets +def __exit_program(): + # stop main thread (which is probably blocked reading input) via an interrupt signal + # only available for windows in version 3.2 or higher + os.kill(os.getpid(), signal.SIGINT) + sys.exit(1) + + def set_text_message(message: str, details: str = ""): message_box = QtWidgets.QMessageBox() message_box.setWindowTitle("Error") message_box.setTextFormat(QtCore.Qt.TextFormat.RichText) message_box.setText(message) if details: + force_quit_button = message_box.addButton("Close AutoSplit", QtWidgets.QMessageBox.ButtonRole.ResetRole) + force_quit_button.clicked.connect(__exit_program) message_box.setDetailedText(details) + # Preopen the details for button in message_box.buttons(): if message_box.buttonRole(button) == QtWidgets.QMessageBox.ButtonRole.ActionRole: button.click() From fa6037b9d9ed2a0f8c70b23d0400e040ff4dcb34 Mon Sep 17 00:00:00 2001 From: Avasam Date: Mon, 4 Apr 2022 16:20:38 -0400 Subject: [PATCH 029/137] Massively sped up Flake tests Removed 400+kb of type stubs --- .flake8 | 15 +- .gitignore | 1 + .vscode/settings.json | 6 + pyproject.toml | 11 +- scripts/requirements.txt | 4 +- src/AutoSplit.py | 3 +- src/capture_windows.py | 3 +- src/settings_file.py | 3 +- typings/pythonwin-stubs/win32typing.pyi | 51700 --------------------- typings/win32-stubs/win32gui.pyi | 6238 --- typings/win32con/__init__.pyi | 5045 --- typings/win32helper/__init__.pyi | 0 typings/win32helper/ntsecuritycon.pyi | 689 - typings/win32helper/sspicon.pyi | 479 - typings/win32helper/win32cryptcon.pyi | 1900 - typings/win32helper/win32inetcon.pyi | 1103 - typings/win32helper/win32netcon.pyi | 655 - typings/win32helper/winioctlcon.pyi | 711 - typings/win32typing/__init__.pyi | 51704 ---------------------- 19 files changed, 33 insertions(+), 120237 deletions(-) delete mode 100644 typings/pythonwin-stubs/win32typing.pyi delete mode 100644 typings/win32-stubs/win32gui.pyi delete mode 100644 typings/win32con/__init__.pyi delete mode 100644 typings/win32helper/__init__.pyi delete mode 100644 typings/win32helper/ntsecuritycon.pyi delete mode 100644 typings/win32helper/sspicon.pyi delete mode 100644 typings/win32helper/win32cryptcon.pyi delete mode 100644 typings/win32helper/win32inetcon.pyi delete mode 100644 typings/win32helper/win32netcon.pyi delete mode 100644 typings/win32helper/winioctlcon.pyi delete mode 100644 typings/win32typing/__init__.pyi diff --git a/.flake8 b/.flake8 index 65910611..63ee4e39 100644 --- a/.flake8 +++ b/.flake8 @@ -3,11 +3,18 @@ color=always max-line-length=120 ; Auto generated exclude=src/gen/ -; Linebreak before binary operator -; Allow default value other than "..." -; Allow imports at the bottom of file -ignore=W503,Y015,E402 +ignore= + W503, ; Linebreak before binary operator + Y015, ; Allow default value other than "..." + E402, ; Allow imports at the bottom of file + Y026, ; Not using typing_extensions per-file-ignores= + ; Docstrings in type stubs + ; Function bodys contain other than just ... (eg: raise) + + ; Single quote docstrings + typings/cv2-stubs/__init__.pyi: Q000,E704,E501,N8, Y021,Y010, Q002 + ; Quotes __init__.pyi:Q000 ; PyQt methods diff --git a/.gitignore b/.gitignore index 76ff082c..0aff38f5 100644 --- a/.gitignore +++ b/.gitignore @@ -19,3 +19,4 @@ dist/ # Dev settings *.pkl +settings.toml diff --git a/.vscode/settings.json b/.vscode/settings.json index 6252fc0e..6b21a4a1 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -58,6 +58,12 @@ "python.linting.pylintCategorySeverity.refactor": "Warning", "python.linting.flake8Enabled": true, "python.linting.flake8CategorySeverity.E": "Warning", + // Pyflakes + "python.linting.flake8CategorySeverity.F": "Warning", + // PEP8 Naming convention + "python.linting.flake8CategorySeverity.N": "Warning", + // PYI + "python.linting.flake8CategorySeverity.Y": "Warning", // PyRight obsoletes mypy "python.linting.mypyEnabled": false, // Is already wrapped by Flake8, prospector and pylama diff --git a/pyproject.toml b/pyproject.toml index 8001ad5f..bd52f3a5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -15,13 +15,22 @@ aggressive = 3 [tool.pyright] pythonPlatform = "Windows" typeCheckingMode = "strict" +# Extra strict +reportImplicitStringConcatenation="error" +reportCallInDefaultInitializer="error" +reportMissingSuperCall="none" # False positives on base classes +reportPropertyTypeMismatch="error" +reportUninitializedInstanceVariable="error" +reportUnnecessaryTypeIgnoreComment="error" +reportUnusedCallResult="none" ignore = [ # Auto generated "src/gen/", # We expect stub files to be incomplete or contain useless statements as they're external "typings/", ] -reportMissingTypeStubs = "information" +# Type stubs may not be completable +reportMissingTypeStubs = "warning" # False positives with TYPE_CHECKING reportImportCycles = "information" # PyQt .connect diff --git a/scripts/requirements.txt b/scripts/requirements.txt index 30eb0766..4d84a6ca 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -26,8 +26,8 @@ requests bandit flake8 flake8-quotes -pylint -pywin32-stubs +pylint>=2.13 +git+https://github.com/Avasam/pywin32-stubs.git#egg=pywin32-stubs # https://github.com/kaluluosi/pywin32-stubs/pull/4 simplejson types-simplejson>=3.17.2 types-requests diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 97031748..6ea62006 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -796,8 +796,7 @@ def __get_capture_for_comparison(self): if capture is None: # Try to recover by using the window name self.live_image.setText("Trying to recover window...") - # https://github.com/kaluluosi/pywin32-stubs/issues/7 - hwnd = win32gui.FindWindow(None, self.window_text) # type: ignore + hwnd = win32gui.FindWindow(None, self.window_text) # Don't fallback to desktop if hwnd: self.hwnd = hwnd diff --git a/src/capture_windows.py b/src/capture_windows.py index c991cc38..b9eb6beb 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -45,8 +45,7 @@ def capture_region(hwnd: int, selection: Rect, print_window: bool): # If the window closes while it's being manipulated, it could cause a crash try: window_dc: int = win32gui.GetWindowDC(hwnd) - # https://github.com/kaluluosi/pywin32-stubs/issues/6 - dc_object: PyCDC = win32ui.CreateDCFromHandle(window_dc) # type: ignore + dc_object: PyCDC = win32ui.CreateDCFromHandle(window_dc) # Causes a 10-15x performance drop. But allows recording hardware accelerated windows if print_window: diff --git a/src/settings_file.py b/src/settings_file.py index c0315c23..4122fc3d 100644 --- a/src/settings_file.py +++ b/src/settings_file.py @@ -146,8 +146,7 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str autosplit.force_print_window_checkbox.setChecked(settings[20]) if autosplit.window_text: - # https://github.com/kaluluosi/pywin32-stubs/issues/7 - hwnd = win32gui.FindWindow(None, autosplit.window_text) # type: ignore + hwnd = win32gui.FindWindow(None, autosplit.window_text) if hwnd: autosplit.hwnd = hwnd else: diff --git a/typings/pythonwin-stubs/win32typing.pyi b/typings/pythonwin-stubs/win32typing.pyi deleted file mode 100644 index 270cb353..00000000 --- a/typings/pythonwin-stubs/win32typing.pyi +++ /dev/null @@ -1,51700 +0,0 @@ -__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'] -from typing import * - -class COMMTIMEOUTS(object): - """A tuple representing a COMMTIMEOUTS structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class CopyProgressRoutine(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class DOCINFO(object): - """A tuple of information representing a DOCINFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def DocName(self)->'Union[str]': - """Name of document""" - pass - - - @property - def Output(self)->'Union[str]': - """Name of output file when printing to file. Use None for normal printing.""" - pass - - - @property - def DataType(self)->'Union[str]': - """Type of data to be sent to printer, eg RAW, EMF, TEXT. Use None for printer default.""" - pass - - - @property - def Type(self)->'Any': - """Flag specifying mode of operation. Can be DI_APPBANDING, DI_ROPS_READ_DESTINATION, or 0""" - pass - - -class ExportCallback(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class FORM_INFO_1(object): - """A dictionary containing FORM_INFO_1W data""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Flags(self)->'Any': - """FORM_USER, FORM_BUILTIN, or FORM_PRINTER""" - pass - - - @property - def Name(self)->'str': - """Name of form""" - pass - - - @property - def Size(self)->'Any': - """A dictionary representing a SIZEL structure {'cx':int,'cy':int}""" - pass - - - @property - def ImageableArea(self)->'Any': - """A dictionary representing a RECTL structure {'left':int, 'top':int, 'right':int, 'bottom':int}""" - pass - - -class ImportCallback(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class LARGE_INTEGER(object): - """A Python object used wherever a COM LARGE_INTEGER is used.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class NCB(object): - """A Python object that encapsulates a Win32 NCB structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Command(self)->'Any': - """""" - pass - - - @property - def Retcode(self)->'Any': - """""" - pass - - - @property - def Lsn(self)->'Any': - """""" - pass - - - @property - def Num(self)->'Any': - """""" - pass - - - @property - def Bufflen(self)->'Any': - """read-only""" - pass - - - @property - def Callname(self)->'str': - """- The strings need to be space padded to 16 chars exactly""" - pass - - - @property - def Name(self)->'str': - """- The strings need to be space padded to 16 chars exactly""" - pass - - - @property - def Rto(self)->'str': - """- The strings need to be space padded to 16 chars exactly""" - pass - - - @property - def Sto(self)->'str': - """- The strings need to be space padded to 16 chars exactly""" - pass - - - @property - def Lana_num(self)->'Any': - """""" - pass - - - @property - def Cmd_cplt(self)->'Any': - """""" - pass - - - @property - def Event(self)->'Any': - """""" - pass - - - @property - def Post(self)->'Any': - """""" - pass - - -class PRINTER_DEFAULTS(object): - """A dictionary representing a PRINTER_DEFAULTS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def pDatatype(self)->'str': - """Data type to be used for print jobs, see win32print::EnumPrintProcessorDatatypes, optional, can be None""" - pass - - - @property - def pDevMode(self)->'PyDEVMODE': - """A PyDEVMODE that specifies default printer parameters, optional, can be None""" - pass - - - @property - def DesiredAccess(self)->'Any': - """An ACCESS_MASK specifying what level of access is needed, eg PRINTER_ACCESS_ADMINISTER, PRINTER_ACCESS_USE""" - pass - - -class PyACL(object): - """A Python object, representing a ACL structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,) -> 'None': - """ - Initialize the ACL. - -Args: - - - -Returns: - - None - - """ - pass - - - def IsValid(self,) -> 'None': - """ - Determines if the ACL is valid (IsValidAcl) - -Args: - - - -Returns: - - None - - """ - pass - - - def AddAccessAllowedAce(self,revision:'Any',access:'Any',sid:'PySID',access1:'Any',sid1:'Any') -> 'None': - """ - Adds an access-allowed ACE to an DACL object. The access is granted to a - -specified SID. - -Args: - - revision(Any):Pre-win2k, must be ACL_REVISION, otherwise also may be ACL_REVISION_DS. - access(Any):Specifies the mask of access rights to be denied to the specified SID. - sid(PySID):A SID object representing a user, group, or logon account being denied access.Alternative Parameters - access1(Any):Specifies the mask of access rights to be denied to the specified SID. - sid1(Any):A SID object representing a user, group, or logon account being denied access.CommentsNote that early versions of this function supported only two arguments. This has been deprecated in preference of the three argument version, which reflects the win32 API and the new functions in this module. - -Returns: - - None - - """ - pass - - - def AddAccessAllowedAceEx(self,revision:'Any',aceflags:'Any',access:'Any',sid:'PySID') -> 'None': - """ - Add access allowed ACE to an ACL with ACE flags (Requires Win2k or higher) - -Args: - - revision(Any):Must be at least ACL_REVISION_DS - aceflags(Any):Combination of ACE inheritance flags (CONTAINER_INHERIT_ACE,INHERIT_ONLY_ACE,INHERITED_ACE,NO_PROPAGATE_INHERIT_ACE, and OBJECT_INHERIT_ACE) - access(Any):Specifies the mask of access rights to be granted to the specified SID. - sid(PySID):A SID object representing a user, group, or logon account being granted access. - -Returns: - - None - - """ - pass - - - def AddAccessAllowedObjectAce(self,AceRevision:'Any',AceFlags:'Any',AccessMask:'Any',ObjectTypeGuid:'PyIID',InheritedObjectTypeGuid:'PyIID',sid:'PySID') -> 'None': - """ - Adds an ACCESS_ALLOWED_OBJECT_ACE to the ACL - -Args: - - AceRevision(Any):Must be at least ACL_REVISION_DS - AceFlags(Any):Combination of ACE inheritance flags (CONTAINER_INHERIT_ACE,INHERIT_ONLY_ACE,INHERITED_ACE,NO_PROPAGATE_INHERIT_ACE, and OBJECT_INHERIT_ACE) - AccessMask(Any):Specifies the mask of access rights to be granted to the specified SID - ObjectTypeGuid(PyIID):GUID of object type or property set to which ace applies, can be None - InheritedObjectTypeGuid(PyIID):GUID of object type or property that will inherit ACE, can be None - sid(PySID):A SID object representing a user, group, or logon account being granted access. - -Returns: - - None - - """ - pass - - - def AddAccessDeniedAce(self,revision:'Any',access:'Any',sid:'PySID',access1:'Any',sid1:'Any') -> 'None': - """ - Adds an access-denied ACE to an ACL object. The access is denied to a specified - -SID. - -Args: - - revision(Any):Pre-win2k, must be ACL_REVISION, otherwise also may be ACL_REVISION_DS. - access(Any):Specifies the mask of access rights to be denied to the specified SID. - sid(PySID):A SID object representing a user, group, or logon account being denied access.Alternative Parameters - access1(Any):Specifies the mask of access rights to be denied to the specified SID. - sid1(Any):A SID object representing a user, group, or logon account being denied access.CommentsNote that early versions of this function supported only two arguments. This has been deprecated in preference of the three argument version, which reflects the win32 API and the new functions in this module. - -Returns: - - None - - """ - pass - - - def AddAccessDeniedAceEx(self,revision:'Any',aceflags:'Any',access:'Any',sid:'PySID') -> 'None': - """ - Add access denied ACE to an ACL with ACE flags (Requires Win2k or higher) - -Args: - - revision(Any):Must be at least ACL_REVISION_DS - aceflags(Any):Combination of ACE inheritance flags (CONTAINER_INHERIT_ACE,INHERIT_ONLY_ACE,INHERITED_ACE,NO_PROPAGATE_INHERIT_ACE, and OBJECT_INHERIT_ACE) - access(Any):Specifies the mask of access rights to be denied to the specified SID. - sid(PySID):A SID object representing a user, group, or logon account being denied access. - -Returns: - - None - - """ - pass - - - def AddMandatoryAce(self,AceRevision:'Any',AceFlags:'Any',MandatoryPolicy:'Any',LabelSid:'PySID') -> 'None': - """ - Adds a mandatory integrity level ACE to a SACL - -Args: - - AceRevision(Any):ACL_REVISION or ACL_REVISION_DS - AceFlags(Any):Combination of ACE inheritance flags (CONTAINER_INHERIT_ACE,INHERIT_ONLY_ACE,INHERITED_ACE,NO_PROPAGATE_INHERIT_ACE, and OBJECT_INHERIT_ACE) - MandatoryPolicy(Any):Access policy for processes with lower integrity level, combination of SYSTEM_MANDATORY_LABEL_* flags - LabelSid(PySID):Integrity level SID. This can be created using CreateWellKnownSid with Win*LabelSid. Also can be constructed manually using SECURITY_MANDATORY_LABEL_AUTHORITY and a SECURITY_MANDATORY_*_RID - -Returns: - - None - - """ - pass - - - def AddAuditAccessAce(self,dwAceRevision:'Any',dwAccessMask:'Any',sid:'PySID',bAuditSuccess:'Any',bAuditFailure:'Any') -> 'None': - """ - Adds an audit ACE to a Sacl - -Args: - - dwAceRevision(Any):Revision of ACL: Pre-Win2k, must be ACL_REVISION. Win2K on up, can also be ACL_REVISION_DS - dwAccessMask(Any):Bitmask of access types to be audited - sid(PySID):SID for whom system audit messages will be generated - bAuditSuccess(Any):Set to 1 if access success should be audited, else 0 - bAuditFailure(Any):Set to 1 if access failure should be audited, else 0 - -Returns: - - None - - """ - pass - - - def AddAuditAccessAceEx(self,dwAceRevision:'Any',AceFlags:'Any',dwAccessMask:'Any',sid:'PySID',bAuditSuccess:'Any',bAuditFailure:'Any') -> 'None': - """ - Adds an audit ACE to an Sacl, includes ace flags - -Args: - - dwAceRevision(Any):Revision of ACL: Must be at least ACL_REVISION_DS - AceFlags(Any):Combination of FAILED_ACCESS_ACE_FLAG,SUCCESSFUL_ACCESS_ACE_FLAG,CONTAINER_INHERIT_ACE,INHERIT_ONLY_ACE,INHERITED_ACE,NO_PROPAGATE_INHERIT_ACE and OBJECT_INHERIT_ACE - dwAccessMask(Any):Bitmask of access types to be audited - sid(PySID):SID for whom system audit messages will be generated - bAuditSuccess(Any):Set to 1 if access success should be audited, else 0 - bAuditFailure(Any):Set to 1 if access failure should be audited, else 0 - -Returns: - - None - - """ - pass - - - def AddAuditAccessObjectAce(self,dwAceRevision:'Any',AceFlags:'Any',dwAccessMask:'Any',ObjectTypeGuid:'PyIID',InheritedObjectTypeGuid:'PyIID',sid:'PySID',bAuditSuccess:'Any',bAuditFailure:'Any') -> 'None': - """ - Adds an audit ACE for an object type identified by GUID - -Args: - - dwAceRevision(Any):Revision of ACL: Must be at least ACL_REVISION_DS - AceFlags(Any):Combination of FAILED_ACCESS_ACE_FLAG,SUCCESSFUL_ACCESS_ACE_FLAG,CONTAINER_INHERIT_ACE,INHERIT_ONLY_ACE,INHERITED_ACE,NO_PROPAGATE_INHERIT_ACE and OBJECT_INHERIT_ACE - dwAccessMask(Any):Bitmask of access types to be audited - ObjectTypeGuid(PyIID):GUID of object type or property set to which ace applies, can be None - InheritedObjectTypeGuid(PyIID):GUID of object type or property that will inherit ACE, can be None - sid(PySID):SID for whom system audit messages will be generated - bAuditSuccess(Any):Set to 1 if access success should be audited, else 0 - bAuditFailure(Any):Set to 1 if access failure should be audited, else 0 - -Returns: - - None - - """ - pass - - - def GetAclSize(self,) -> 'Any': - """ - Returns the storage size of the ACL. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetAclRevision(self,) -> 'Any': - """ - Returns revision of the ACL. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetAceCount(self,) -> 'Any': - """ - Returns the number of ACEs in the ACL. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetAce(self,index:'Any') -> 'Any': - """ - Gets an Ace from the ACL - -Args: - - index(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[1] int : Mask[2] PySID : sidObject 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[1] int : mask[2] PyIID : ObjectType[3] PyIID : InheritedObjectType[4] PySID : sidFor details see the API documentation. - -Returns: - - 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 - -[1] int : Mask - -[2] PySID : sid -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 - -[1] int : mask - -[2] PyIID : ObjectType - -[3] PyIID : InheritedObjectType - -[4] PySID : sid -For details see the API documentation. - - - """ - pass - - - def DeleteAce(self,index:'Any') -> 'None': - """ - Deletes specified Ace from an ACL. - -Args: - - index(Any):Zero-based index of the ACE to delete. - -Returns: - - None - - """ - pass - - - def GetEffectiveRightsFromAcl(self,trustee:'PyTRUSTEE') -> 'Any': - """ - Return access rights (ACCESS_MASK) that the ACL grants to - -specified trustee - -Args: - - trustee(PyTRUSTEE):Dictionary representing a TRUSTEE structure - -Returns: - - Any - - """ - pass - - - def GetAuditedPermissionsFromAcl(self,trustee:'PyTRUSTEE') -> 'Tuple[Any, Any]': - """ - Return types of access for - -which ACL will generate an audit event for specified trustee - -Args: - - trustee(PyTRUSTEE):Dictionary representing a TRUSTEE structureCommentsThis function is known to return the success and failure access masks in the the wrong order on Windows 2000 service pack 4. Problem has been reported to Microsoft. - -Returns: - - Tuple[Any, Any] - - """ - pass - - -class PyBITMAP(object): - """A Python object, representing an PyBITMAP structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def bmType(self)->'int': - """""" - pass - - - @property - def bmWidth(self)->'int': - """""" - pass - - - @property - def bmHeight(self)->'int': - """""" - pass - - - @property - def bmWidthBytes(self)->'int': - """""" - pass - - - @property - def bmPlanes(self)->'int': - """""" - pass - - -class PyBLENDFUNCTION(object): - """Tuple of four small ints used to fill a BLENDFUNCTION struct - -Each int must fit in a byte (0-255).""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCEHANDLE(object): - """A Python object, representing a remote Windows CE handle""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCERTSTORE(object): - """Handle to a certificate store""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def HCERTSTORE(self)->'Any': - """Integer handle""" - pass - - - def CertCloseStore(self,Flags:'Any'=0) -> 'None': - """ - Closes the certificate store - -Args: - - Flags(Any):Combination of CERT_CLOSE_*_FLAG flags - -Returns: - - None - - """ - pass - - - def CertControlStore(self,Flags:'Any',CtrlType:'Any',CtrlPara:'int') -> 'None': - """ - Controls sychronization of the certificate store - -Args: - - Flags(Any):One of the CERT_STORE_CTRL_*_FLAG flags - CtrlType(Any):One of the CERT_STORE_CTRL_* flags - CtrlPara(int):Event handle, can be None (not used with CERT_STORE_CTRL_COMMIT) - -Returns: - - None - - """ - pass - - - def CertEnumCertificatesInStore(self,) -> 'List[PyCERT_CONTEXT]': - """ - Lists all certificates in the store - -Args: - - - -Returns: - - List[PyCERT_CONTEXT] - - """ - pass - - - def CertEnumCTLsInStore(self,) -> 'List[PyCTL_CONTEXT]': - """ - Finds all Certificate Trust Lists in store - -Args: - - - -Returns: - - List[PyCTL_CONTEXT] - - """ - pass - - - def CertSaveStore(self,MsgAndCertEncodingType:'Any',SaveAs:'Any',SaveTo:'Any',SaveToPara:'Union[str, int]',Flags:'Any'=0) -> 'None': - """ - Serializes the store to memory or a file - -Args: - - MsgAndCertEncodingType(Any):Only used when saveas is CERT_STORE_SAVE_AS_PKCS7 - usually X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING - SaveAs(Any):One of the CERT_STORE_SAVE_AS_* constants - SaveTo(Any):One of the CERT_STORE_SAVE_TO_* constants (CERT_STORE_SAVE_TO_MEMORY not supported yet) - SaveToPara(Union[str, int]):File name or open file handle depending on SaveTo parm - Flags(Any):Reserved, use 0 - -Returns: - - None - - """ - pass - - - def CertAddEncodedCertificateToStore(self,CertEncodingType:'Any',CertEncoded:'Any',AddDisposition:'Any') -> 'PyCERT_CONTEXT': - """ - Imports an encoded certificate into the - -store - -Args: - - CertEncodingType(Any):Usually X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING - CertEncoded(Any):Data containing a serialized certificate - AddDisposition(Any):Combination of CERT_STORE_ADD_* flags - -Returns: - - PyCERT_CONTEXT - - """ - pass - - - def CertAddCertificateContextToStore(self,CertContext:'PyCERT_CONTEXT',AddDisposition:'Any') -> 'PyCERT_CONTEXT': - """ - Adds a certificate context to the store - -Args: - - CertContext(PyCERT_CONTEXT):Certificate context to be added - AddDisposition(Any):CERT_STORE_ADD_* constant - -Returns: - - PyCERT_CONTEXT - - """ - pass - - - def CertAddCertificateLinkToStore(self,CertContext:'PyCERT_CONTEXT',AddDisposition:'Any') -> 'PyCERT_CONTEXT': - """ - Adds a link to a cert in another store - -Args: - - CertContext(PyCERT_CONTEXT):Certificate context to be linked - AddDisposition(Any):One of the CERT_STORE_ADD_* values - -Returns: - - PyCERT_CONTEXT - - """ - pass - - - def CertAddCTLContextToStore(self,CtlContext:'PyCTL_CONTEXT',AddDisposition:'Any') -> 'PyCTL_CONTEXT': - """ - Adds a certificate trust list to the store - -Args: - - CtlContext(PyCTL_CONTEXT):CTL to be added - AddDisposition(Any):CERT_STORE_ADD_* constant - -Returns: - - PyCTL_CONTEXT - - """ - pass - - - def CertAddCTLLinkToStore(self,CtlContext:'PyCTL_CONTEXT',AddDisposition:'Any') -> 'PyCTL_CONTEXT': - """ - Adds a link to a CTL in another store - -Args: - - CtlContext(PyCTL_CONTEXT):CTL to be linked - AddDisposition(Any):One of the CERT_STORE_ADD_* values - -Returns: - - PyCTL_CONTEXT - - """ - pass - - - def CertAddStoreToCollection(self,SiblingStore:'PyCERTSTORE',UpdateFlag:'Any'=0,Priority:'Any'=0) -> 'None': - """ - Adds a sibling store to a store collection - -Args: - - SiblingStore(PyCERTSTORE):Store to be added to the collection - UpdateFlag(Any):Can be CERT_PHYSICAL_STORE_ADD_ENABLE_FLAG to enable changes to persist - Priority(Any):Determines order in which store are searched and updatedCommentsA collection store is created by using cryptoapi::CertOpenStore with CERT_STORE_PROV_COLLECTION - -Returns: - - None - - """ - pass - - - def CertRemoveStoreFromCollection(self,SiblingStore:'PyCERTSTORE') -> 'None': - """ - Removes a sibling store from a collection - -Args: - - SiblingStore(PyCERTSTORE):Store to be removed from the collection - -Returns: - - None - - """ - pass - - - def PFXExportCertStoreEx(self,Flags:'Any',Password:'Any'=None) -> 'Any': - """ - Exports certificates and associated private keys in PKCS#12 format - -Args: - - Flags(Any):Options to be used while exporting - Password(Any):Passphrase to be used to encrypt the output - -Returns: - - Any - - """ - pass - - -class PyCERT_ALT_NAME_ENTRY(object): - """Represented as a 2-tuple""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCERT_ALT_NAME_INFO(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCERT_AUTHORITY_KEY_ID_INFO(object): - """Dict containing the identity of a CA""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def KeyId(self)->'Any': - """Unique identifier of private key, usually a hash""" - pass - - - @property - def CertIssuer(self)->'Any': - """Encoded DN of the Certificate Authority. Decode using X509_UNICODE_NAME""" - pass - - - @property - def CertSerialNumber(self)->'Any': - """Serial nbr of the CA's signing certificate""" - pass - - -class PyCERT_BASIC_CONSTRAINTS2_INFO(object): - """Dict representing a CERT_BASIC_CONSTRAINTS2_INFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def fCA(self)->'Any': - """Indicates if cert represents a certificate authority""" - pass - - - @property - def fPathLenConstraint(self)->'Any': - """Indicates if PathLenConstraint member is used""" - pass - - - @property - def PathLenConstraint(self)->'Any': - """Limits number of intermediate CA's between root CA and end user""" - pass - - -class PyCERT_BASIC_CONSTRAINTS_INFO(object): - """Dict representing a CERT_BASIC_CONSTRAINTS_INFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def SubjectType(self)->'PyCRYPT_BIT_BLOB': - """Contains a combination of CERT_CA_SUBJECT_FLAG,CERT_END_ENTITY_SUBJECT_FLAG""" - pass - - - @property - def fPathLenConstraint(self)->'Any': - """Indicates if PathLenConstraint member is used""" - pass - - - @property - def PathLenConstraint(self)->'Any': - """Limits number of intermediate CA's between root CA and end user""" - pass - - - @property - def SubtreesConstraint(self)->'Any': - """Sequence of encoded name blobs""" - pass - - -class PyCERT_CONTEXT(object): - """Handle to a certificate context""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def HANDLE(self)->'Any': - """Pointer to CERT_CONTEXT struct""" - pass - - - @property - def CertStore(self)->'PyCERTSTORE': - """Handle to the certificate store that contains this certificate""" - pass - - - @property - def CertEncoded(self)->'Any': - """Content of the certificate as encoded bytes""" - pass - - - @property - def CertEncodingType(self)->'Any': - """Method used to encode the certifcate, usually X509_ASN_ENCODING or PKCS_7_ASN_ENCODING""" - pass - - - @property - def Version(self)->'Any': - """One of the CERT_V* values""" - pass - - - @property - def Subject(self)->'str': - """Encoded CERT_NAME_INFO struct containing the subject name. Can be decoded using cryptoapi::CryptDecodeObjectEx with X509_UNICODE_NAME, or formatted using cryptoapi::CertNameToStr""" - pass - - - @property - def Issuer(self)->'str': - """Certificate Authority that issued certificate as encoded CERT_NAME_INFO. Use cryptoapi::CryptDecodeObjectEx to decode into individual components, or cryptoapi::CertNameToStr to return a single formatted string""" - pass - - - @property - def NotBefore(self)->'PyTime': - """Beginning of certificate's period of validity""" - pass - - - @property - def NotAfter(self)->'PyTime': - """End of certificate's period of validity""" - pass - - - @property - def SignatureAlgorithm(self)->'Any': - """Object id of the certifcate's signature algorithm""" - pass - - - @property - def Extension(self)->'Tuple[PyCERT_EXTENSION, ...]': - """Sequence of CERT_EXTENSION dicts containing certificate's extensions""" - pass - - - @property - def SubjectPublicKeyInfo(self)->'PyCERT_PUBLIC_KEY_INFO': - """Encoded public key of certificate""" - pass - - - @property - def SerialNumber(self)->'Any': - """Serial number assigned by the issuer""" - pass - - - def CertFreeCertificateContext(self,) -> 'None': - """ - Frees the certificate context - -Args: - - - -Returns: - - None - - """ - pass - - - def CertEnumCertificateContextProperties(self,) -> 'List[Any]': - """ - Lists property ids for the certificate - -Args: - - - -Returns: - - List[Any] - - """ - pass - - - def CryptAcquireCertificatePrivateKey(self,Flags:'Any'=0) -> 'Tuple[Any, PyCRYPTPROV]': - """ - Retrieves the private key associated - -with the certificate - -Args: - - Flags(Any):Combination of CRYPT_ACQUIRE_*_FLAG constantsCommentsOnly the owner of the certificate can use this methodReturn ValueReturns the KeySpec (AT_KEYEXCHANGE or AT_SIGNATURE) and a CSP handle to the key - -Returns: - - Tuple[Any, PyCRYPTPROV]:Combination of CRYPT_ACQUIRE_*_FLAG constants -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,) -> 'Any': - """ - Returns the intended key usage from the certificate extensions - -(szOID_KEY_USAGE or szOID_KEY_ATTRIBUTES) - -Args: - - - -Returns: - - Any:PyCERT_CONTEXT.CertGetIntendedKeyUsage - -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:'Any'=0) -> 'Any': - """ - Finds the enhanced key usage property and/or extension for the - -certificate - -Args: - - Flags(Any):CERT_FIND_EXT_ONLY_ENHKEY_USAGE_FLAG, CERT_FIND_PROP_ONLY_ENHKEY_USAGE_FLAG, or 0Return ValueReturns a sequence of usage OIDs - -Returns: - - 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 - - - def CertSerializeCertificateStoreElement(self,Flags:'Any'=0) -> 'str': - """ - Serializes the certificate and its properties - -Args: - - Flags(Any):Reserved, use only 0 if passed in - -Returns: - - str - - """ - pass - - - def CertVerifySubjectCertificateContext(self,Issuer:'PyCERT_CONTEXT',Flags:'Any') -> 'Any': - """ - Checks the validity of the certificate - -Args: - - Issuer(PyCERT_CONTEXT):Certificate of authority that issued the certificate - Flags(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. - -Returns: - - 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 - - - def CertDeleteCertificateFromStore(self,) -> 'None': - """ - Removes the certificate from its store - -Args: - - - -Returns: - - None - - """ - pass - - - def CertGetCertificateContextProperty(self,PropId:'Any') -> 'Any': - """ - Retrieves the specified property from the - -certificate - -Args: - - PropId(Any):One of the CERT_*_PROP_ID constantsPropIdReturned valueCERT_ARCHIVED_PROP_IDBooleanCERT_DATE_STAMP_PROP_IDPyTimeCERT_ACCESS_STATE_PROP_IDintCERT_KEY_SPEC_PROP_IDintCERT_DESCRIPTION_PROP_IDUnicodeCERT_FRIENDLY_NAME_PROP_IDUnicodeCERT_PVK_FILE_PROP_IDUnicodeCERT_AUTO_ENROLL_PROP_IDUnicodeCERT_HASH_PROP_IDString containing a hashCERT_SHA1_HASH_PROP_IDString containing a hashCERT_MD5_HASH_PROP_IDString containing a hashCERT_SIGNATURE_HASH_PROP_IDString containing a hashCERT_KEY_IDENTIFIER_PROP_IDString containing a hashCERT_SUBJECT_NAME_MD5_HASH_PROP_IDString containing a hashCERT_KEY_PROV_HANDLE_PROP_IDPyCRYPTPROVCERT_SUBJECT_PUBLIC_KEY_MD5_HASH_PROP_IDString containing a hashCERT_ISSUER_PUBLIC_KEY_MD5_HASH_PROP_IDString containing a hashCERT_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_USAGECERT_KEY_PROV_INFO_PROP_IDCRYPT_KEY_PROV_INFO dictCERT_KEY_CONTEXT_PROP_IDDict representing CERT_KEY_CONTEXT structCERT_NEXT_UPDATE_LOCATION_PROP_IDEncoded CERT_ALT_NAME_INFO, decode using cryptoapi::CryptDecodeObjectEx with szOID_NEXT_UPDATE_LOCATIONReturn ValueType of object returned is dependent on the property id requested. - -Returns: - - Any:One of the CERT_*_PROP_ID constants - - -PropId - - -Returned value - - - -CERT_ARCHIVED_PROP_IDBoolean -CERT_DATE_STAMP_PROP_IDPyTime -CERT_ACCESS_STATE_PROP_IDint -CERT_KEY_SPEC_PROP_IDint -CERT_DESCRIPTION_PROP_IDUnicode -CERT_FRIENDLY_NAME_PROP_IDUnicode -CERT_PVK_FILE_PROP_IDUnicode -CERT_AUTO_ENROLL_PROP_IDUnicode -CERT_HASH_PROP_IDString containing a hash -CERT_SHA1_HASH_PROP_IDString containing a hash -CERT_MD5_HASH_PROP_IDString containing a hash -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 - -containing a hash -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_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 -CERT_KEY_CONTEXT_PROP_IDDict representing CERT_KEY_CONTEXT struct -CERT_NEXT_UPDATE_LOCATION_PROP_IDEncoded CERT_ALT_NAME_INFO, decode using cryptoapi::CryptDecodeObjectEx - - - - with szOID_NEXT_UPDATE_LOCATION -Return ValueType of object returned is dependent on the property id requested. - - - """ - pass - - - def CertSetCertificateContextProperty(self,PropId:'Any',Data:'Any',Flags:'Any'=0) -> 'None': - """ - Sets a property for a certificate - -Args: - - PropId(Any):Id of property to be set, CERT_*_PROP_ID - Data(Any):The value to be set for the property. Type is dependent on PropId. Use None to delete a property. - Flags(Any):Combination of CERT_SET_* flagsPropIdType of inputCERT_ARCHIVED_PROP_IDNone causes Archived flag to be cleared, any other causes it to be set no actual data, non-NULL pvData indicates presence of flagCERT_DATE_STAMP_PROP_IDPyTime specifying when cert was added to storeCERT_DESCRIPTION_PROP_IDUnicode stringCERT_FRIENDLY_NAME_PROP_IDUnicode stringCERT_PVK_FILE_PROP_IDUnicode stringCERT_AUTO_ENROLL_PROP_IDUnicode stringCERT_KEY_SPEC_PROP_IDInt, usually AT_KEYEXCHANGE or AT_SIGNATURECERT_HASH_PROP_IDString containing the hashCERT_SHA1_HASH_PROP_IDString containing the hashCERT_MD5_HASH_PROP_IDString containingg the hashCERT_SIGNATURE_HASH_PROP_IDString containing the hashCERT_KEY_IDENTIFIER_PROP_IDString containing the key idCERT_SUBJECT_PUBLIC_KEY_MD5_HASH_PROP_IDString containing the hashCERT_ISSUER_PUBLIC_KEY_MD5_HASH_PROP_IDString containing the hashCERT_SUBJECT_NAME_MD5_HASH_PROP_IDString containing the hashCERT_RENEWAL_PROP_IDString containing the hashCERT_ENHKEY_USAGE_PROP_IDString containing an encoded PyCTL_USAGE. Use cryptoapi::CryptEncodeObjectEx with X509_ENHANCED_KEY_USAGE.CERT_CTL_USAGE_PROP_IDSame as CERT_ENHKEY_USAGE_PROP_ID - -Returns: - - None - - """ - pass - - -class PyCERT_EXTENSION(object): - """Dict containing a certificate extension""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ObjId(self)->'Any': - """The OID identifying the type of extension""" - pass - - - @property - def Critical(self)->'Any': - """If true, any contraints or limits contained in the extension should be considered absolute""" - pass - - - @property - def Value(self)->'Any': - """Binary string containing ASN encoded data. To interpret or display extension data, see cryptoapi::CryptDecodeObjectEx and cryptoapi::CryptFormatObject.""" - pass - - -class PyCERT_KEY_ATTRIBUTES_INFO(object): - """Dict representing a CERT_KEY_ATTRIBUTES_INFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def KeyId(self)->'Any': - """Usually a hash that uniquely identifies the key""" - pass - - - @property - def IntendedKeyUsage(self)->'PyCRYPT_BIT_BLOB': - """Contains a byte with CERT_*_KEY_USAGE flags""" - pass - - - @property - def PrivateKeyUsagePeriod(self)->'Any': - """Private key's begin and end effective dates, may be None""" - pass - - -class PyCERT_NAME_INFO(object): - """Sequence of CERT_RDN's""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCERT_NAME_VALUE(object): - """Dict containing type (CERT_RDN_*) and a unicode string""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCERT_OTHER_NAME(object): - """Dict containing {ObjId, Value}. - -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 - -using X509_UNICODE_NAME_VALUE to return the actual unicode string""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCERT_POLICY_INFO(object): - """Dict containing a certificate policy""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def PolicyIdentifier(self)->'Any': - """OID identifying the policy""" - pass - - - @property - def PolicyQualifier(self)->'Any': - """Sequence of CERT_POLICY_QUALIFIER dicts""" - pass - - -class PyCERT_PUBLIC_KEY_INFO(object): - """Dict containing an exported public key""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Algorithm(self)->'PyCRYPT_ALGORITHM_IDENTIFIER': - """Dict containing OID of the public key algorithm""" - pass - - - @property - def PublicKey(self)->'PyCRYPT_BIT_BLOB': - """Dict containing the encoded public key""" - pass - - -class PyCOMSTAT(object): - """A Python object, representing an COMSTAT structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def cbInQue(self)->'int': - """Specifies the number of bytes received by the serial provider but not yet read by a win32file::ReadFile operation""" - pass - - - @property - def cbOutQue(self)->'int': - """Specifies the number of bytes of user data remaining to be transmitted for all write operations. This value will be zero for a nonoverlapped write.""" - pass - - - @property - def fCtsHold(self)->'int': - """Specifies whether transmission is waiting for the CTS (clear-to-send) signal to be sent. If this member is TRUE, transmission is waiting.""" - pass - - - @property - def fDsrHold(self)->'int': - """Specifies whether transmission is waiting for the DSR (data-set-ready) signal to be sent. If this member is TRUE, transmission is waiting.""" - pass - - - @property - def fRlsdHold(self)->'int': - """Specifies whether transmission is waiting for the RLSD (receive-line-signal-detect) signal to be sent. If this member is TRUE, transmission is waiting.""" - pass - - - @property - def fXoffHold(self)->'int': - """Specifies whether transmission is waiting because the XOFF character was received. If this member is TRUE, transmission is waiting.""" - pass - - - @property - def fXoffSent(self)->'int': - """Specifies whether transmission is waiting because the XOFF character was transmitted. If this member is TRUE, transmission is waiting. Transmission halts when the XOFF character is transmitted to a system that takes the next character as XON, regardless of the actual character.""" - pass - - - @property - def fEof(self)->'int': - """Specifies whether the end-of-file (EOF) character has been received. If this member is TRUE, the EOF character has been received.""" - pass - - - @property - def fTxim(self)->'int': - """If this member is TRUE, there is a character queued for transmission that has come to the communications device by way of the TransmitCommChar function. The communications device transmits such a character ahead of other characters in the device's output buffer.""" - pass - - - @property - def fReserved(self)->'int': - """Reserved; do not use.""" - pass - - -class PyCOORD(object): - """Wrapper for a COORD struct. Create using PyCOORDType(X,Y)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def X(self)->'Any': - """Horizontal coordinate""" - pass - - - @property - def Y(self)->'Any': - """Vertical coordinate""" - pass - - -class PyCREDENTIAL(object): - """A dictionary containing information for a CREDENTIAL struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Flags(self)->'Any': - """Combination of CRED_FLAGS_PROMPT_NOW, CRED_FLAGS_USERNAME_TARGET""" - pass - - - @property - def Type(self)->'Any': - """Type of credential, one of CRED_TYPE_* values""" - pass - - - @property - def TargetName(self)->'str': - """Target of credential, can end with * for wildcard matching""" - pass - - - @property - def Comment(self)->'str': - """Descriptive text""" - pass - - - @property - def LastWritten(self)->'PyTime': - """Modification time, ignored on input""" - pass - - - @property - def CredentialBlob(self)->'str': - """Contains password for username credential, or PIN for certificate credential. This member is write-only.""" - pass - - - @property - def Persist(self)->'Any': - """Specifies scope of persistence, one of CRED_PERSIST_* values""" - pass - - - @property - def Attributes(self)->'Any': - """Tuple of PyCREDENTIAL_ATTRIBUTE dicts containing application-specific data, can be None""" - pass - - - @property - def TargetAlias(self)->'str': - """Alias for TargetName, only valid with CRED_TYPE_GENERIC""" - pass - - - @property - def UserName(self)->'str': - """User to be authenticated by target. Can be of the form username@domain or domain\\username. For CRED_TYPE_DOMAIN_CERTIFICATE, use win32cred::CredMarshalCredential to marshal the SHA1 hash of user's certficate""" - pass - - -class PyCREDENTIAL_ATTRIBUTE(object): - """A dictionary containing information for a CREDENTIAL_ATTRIBUTE struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Keyword(self)->'str': - """Attribute name, at most CRED_MAX_STRING_LENGTH chars""" - pass - - - @property - def Flags(self)->'Any': - """Reserved, use only 0""" - pass - - - @property - def Value(self)->'Any': - """Attribute value, at most CRED_MAX_VALUE_SIZE bytes. Unicode objects are treated as raw bytes.""" - pass - - -class PyCREDENTIAL_TARGET_INFORMATION(object): - """A dictionary representing a CREDENTIAL_TARGET_INFORMATION struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def TargetName(self)->'str': - """Target of credentials""" - pass - - - @property - def NetbiosServerName(self)->'str': - """""" - pass - - - @property - def DnsServerName(self)->'str': - """""" - pass - - - @property - def NetbiosDomainName(self)->'str': - """""" - pass - - - @property - def DnsDomainName(self)->'str': - """""" - pass - - - @property - def DnsTreeName(self)->'str': - """""" - pass - - - @property - def PackageName(self)->'str': - """Name of security package which mapped TargetName""" - pass - - - @property - def Flags(self)->'Any': - """CRED_TI_* flags""" - pass - - - @property - def CredTypes(self)->'Tuple[Any, ...]': - """Tuple of CRED_TYPE_* values indicating which types of credentials are acceptable to target""" - pass - - -class PyCREDUI_INFO(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Parent(self)->'int': - """Handle to parent window, can be None""" - pass - - - @property - def MessageText(self)->'str': - """Message to appear in dialog""" - pass - - - @property - def CaptionText(self)->'str': - """Title of the dialog window""" - pass - - - @property - def Banner(self)->'int': - """Handle to a bitmap to be displayed""" - pass - - -class PyCRYPTHASH(object): - """Handle to a cryptographic hash""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CryptDestroyHash(self,) -> 'None': - """ - Frees the hash object - -Args: - - - -Returns: - - None - - """ - pass - - - def CryptDuplicateHash(self,Flags:'Any'=0) -> 'PyCRYPTHASH': - """ - Clones the hash object - -Args: - - Flags(Any):Reserved, use 0 if passed - -Returns: - - PyCRYPTHASH - - """ - pass - - - def CryptHashData(self,Data:'str',Flags:'Any'=0) -> 'None': - """ - Adds data to the hash - -Args: - - Data(str):Data to be hashed - Flags(Any):CRYPT_USERDATA or 0CommentsIf Flags is CRYPT_USERDATA, provider is expected to prompt user to enter data. MSDN says that MS CSPs ignore this flag - -Returns: - - None - - """ - pass - - - def CryptHashSessionKey(self,Key:'PyCRYPTKEY',Flags:'Any'=0) -> 'None': - """ - Hashes a session key - -Args: - - Key(PyCRYPTKEY):The session key to be hashed - Flags(Any):CRYPT_LITTLE_ENDIAN or 0 - -Returns: - - None - - """ - pass - - - def CryptSignHash(self,KeySpec:'Any',Flags:'Any'=0) -> 'str': - """ - Signs the hash - -Args: - - KeySpec(Any):The key to be used to sign the hash, AT_KEYEXCHANGE,AT_SIGNATURE - Flags(Any):CRYPT_NOHASHOID,CRYPT_X931_FORMAT or 0CommentsThis methods signs only the hash, not the data that the hash represents - -Returns: - - str - - """ - pass - - - def CryptVerifySignature(self,Signature:'str',PubKey:'PyCRYPTKEY',Flags:'Any'=0) -> 'None': - """ - Verifies that a signature matches hashed data - -Args: - - Signature(str):Signature data to verify - PubKey(PyCRYPTKEY):Public key of signer - Flags(Any):CRYPT_NOHASHOID,CRYPT_X931_FORMAT or 0 - -Returns: - - None - - """ - pass - - - def CryptGetHashParam(self,Param:'Any',Flags:'Any'=0) -> 'Union[Any]': - """ - Retrieves the specified attribute of the hash - -Args: - - Param(Any):The parameter to retrieve: HP_ALGID, HP_HASHSIZE, or HP_HASHVAL - Flags(Any):Reserved, use 0 if passed inCommentsAfter this method has been called, no more data can be hashedReturn ValueType of returned object is dependent on the Param passed in - -Returns: - - Union[Any]:Reserved, use 0 if passed in -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 - - -class PyCRYPTKEY(object): - """Handle to a cryptographic key""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def HCRYPTPROV(self)->'Any': - """CSP used by the key""" - pass - - - @property - def HCRYPTKEY(self)->'Any': - """Plain integer handle to the key""" - pass - - - def CryptDestroyKey(self,) -> 'None': - """ - Releases the handle to the key (does not delete permanent keys) - -Args: - - - -Returns: - - None - - """ - pass - - - def CryptExportKey(self,ExpKey:'PyCRYPTKEY',BlobType:'Any',Flags:'Any'=0) -> 'Any': - """ - Exports key or key pair as an encrypted blob - -Args: - - ExpKey(PyCRYPTKEY):Public key or session key of destination user. Use None if exporting a PUBLICKEYBLOB - BlobType(Any):One of OPAQUEKEYBLOB,PRIVATEKEYBLOB,PUBLICKEYBLOB,SIMPLEBLOB,PLAINTEXTKEYBLOB,SYMMETRICWRAPKEYBLOB - Flags(Any):Combination of CRYPT_DESTROYKEY,CRYPT_SSL2_FALLBACK,CRYPT_OAEP or 0Return ValueReturns a binary blob that can be imported via PyCRYPTPROV::CryptImportKey - -Returns: - - 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 - - - def CryptGetKeyParam(self,Param:'Any',Flags:'Any'=0) -> 'Any': - """ - Retrieves key parameters - -Args: - - Param(Any):One of the KP_* constants - Flags(Any):Reserved, use only 0Return ValueType of returned object is dependent on the requested attribute - -Returns: - - Any:Reserved, use only 0 -Return ValueType of returned object is dependent on the requested attribute - - - """ - pass - - - def CryptDuplicateKey(self,Reserved:'Any'=0,Flags:'Any'=0) -> 'PyCRYPTKEY': - """ - Creates an independent copy of the key - -Args: - - Reserved(Any):Use 0 if passed in - Flags(Any):Also reserved, use 0 - -Returns: - - PyCRYPTKEY - - """ - pass - - - def CryptEncrypt(self,Final:'Any',Data:'Any',Hash:'PyCRYPTHASH'=None,Flags:'Any'=0) -> 'Any': - """ - Encrypts and optionally hashes data - -Args: - - Final(Any):Boolean, use True if this is final encryption operation - Data(Any):Data to be encrypted - Hash(PyCRYPTHASH):Hash to be updated with data passed in, can be None - Flags(Any):Reserved, use 0 if passed in - -Returns: - - Any - - """ - pass - - - def CryptDecrypt(self,Final:'Any',Data:'Any',Hash:'PyCRYPTHASH'=None,Flags:'Any'=0) -> 'Any': - """ - Decrypts data - -Args: - - Final(Any):Boolean, use True is this is last (or only) operation - Data(Any):Data to be decrypted - Hash(PyCRYPTHASH):Hash to be used in signature verification, can be None - Flags(Any):Reserved, use only 0 - -Returns: - - Any - - """ - pass - - -class PyCRYPTMSG(object): - """Wrapper for a cryptographic message handle""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def HCRYPTMSG(self)->'Any': - """Raw message handle""" - pass - - - def CryptMsgClose(self,) -> 'None': - """ - Closes the message handle - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCRYPTPROTECT_PROMPTSTRUCT(object): - """A tuple representing a CRYPTPROTECT_PROMPTSTRUCT structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCRYPTPROV(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CryptReleaseContext(self,Flags:'Any'=0) -> 'None': - """ - Releases the CSP handle - -Args: - - Flags(Any):Reserved, use 0 if passed in - -Returns: - - None - - """ - pass - - - def CryptGenKey(self,Algid:'Any',Flags:'Any',KeyLen:'Any'=0) -> 'PyCRYPTKEY': - """ - Generates a key pair or a session key - -Args: - - Algid(Any):Algorithm identifier, one of the CALG_* values, or AT_KEYEXCHANGE/AT_SIGNATURE - Flags(Any):Combination of CRYPT_CREATE_SALT,CRYPT_EXPORTABLE,CRYPT_NO_SALT,CRYPT_PREGEN,CRYPT_USER_PROTECTED,CRYPT_ARCHIVABLE - KeyLen(Any):Length of key to generate, can be 0 to use provider's default key lengthCommentsDiffers from Api call in that the length is passed in separately - -Returns: - - PyCRYPTKEY - - """ - pass - - - def CryptGetProvParam(self,Param:'Any',Flags:'Any'=0) -> 'None': - """ - Retrieves specified attribute of provider - -Args: - - Param(Any):One of the PP_* values - Flags(Any):If param if PP_KEYSET_SEC_DESCR, can be a combination of OWNER_SECURITY_INFORMATION,GROUP_SECURITY_INFORMATION,DACL_SECURITY_INFORMATION,SACL_SECURITY_INFORMATIONReturn ValueType of returned object is dependent on the attribute requested - -Returns: - - 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 - - - def CryptGetUserKey(self,KeySpec:'Any') -> 'PyCRYPTKEY': - """ - Returns a handle to one of user's key pairs - -Args: - - KeySpec(Any):AT_KEYEXCHANGE or AT_SIGNATURE (some providers may implement extra key specs) - -Returns: - - PyCRYPTKEY - - """ - pass - - - def CryptGenRandom(self,Len:'Any',SeedData:'str'=None) -> 'str': - """ - Generates random data of specified length - -Args: - - Len(Any):Number of bytes to generate - SeedData(str):Random seed data - -Returns: - - str - - """ - pass - - - def CryptCreateHash(self,Algid:'Any',Key:'PyCRYPTKEY'=None,Flags:'Any'=0) -> 'PyCRYPTHASH': - """ - Creates a hash object for hashing large amounts of data - -Args: - - Algid(Any):An algorithm identifier, CALG_*. - Key(PyCRYPTKEY):Used only for keyed hashes (MAC or HMAC), use None otherwise - Flags(Any):Reserved, use 0 if passed in - -Returns: - - PyCRYPTHASH - - """ - pass - - - def CryptImportKey(self,Data:'Any',PubKey:'PyCRYPTKEY'=None,Flags:'Any'=0) -> 'PyCRYPTKEY': - """ - None - -Args: - - Data(Any):The key blob to be imported - PubKey(PyCRYPTKEY):Key to be used to decrypt the blob, not used for importing public keys - Flags(Any):Combination of CRYPT_EXPORTABLE, CRYPT_OAEP, CRYPT_NO_SALT, CRYPT_USER_PROTECTED - -Returns: - - PyCRYPTKEY - - """ - pass - - - def CryptExportPublicKeyInfo(self,KeySpec:'Any',CertEncodingType:'Any') -> 'PyCERT_PUBLIC_KEY_INFO': - """ - Exports a public key to send to other users - -Returned dict can be serialized for sending to another python application using pickle.dump - -Args: - - KeySpec(Any):AT_KEYEXCHANGE or AT_SIGNATURE - CertEncodingType(Any):Specifies encoding for exported key info - -Returns: - - PyCERT_PUBLIC_KEY_INFO - - """ - pass - - - def CryptImportPublicKeyInfo(self,Info:'Any',CertEncodingType:'Any') -> 'PyCRYPTKEY': - """ - Imports another user's public key - -Args: - - Info(Any):PyCERT_PUBLIC_KEY_INFO dictionary as returned by PyCRYPTPROV::CryptExportPublicKeyInfo - CertEncodingType(Any):Specifies encoding for exported key info - -Returns: - - PyCRYPTKEY - - """ - pass - - -class PyCRYPT_ALGORITHM_IDENTIFIER(object): - """Dictionary containing information that identifies an encryption - -algorithm and any extra parameters it requires""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ObjId(self)->'Any': - """An szOID_* string identifying the algorithm""" - pass - - - @property - def Parameters(self)->'Any': - """Blob of binary data containing encoded parameters""" - pass - - -class PyCRYPT_ATTRIBUTE(object): - """Dict representing a CRYPT_ATTRIBUTE struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ObjId(self)->'Any': - """An szOID_* string identifying the attribute""" - pass - - - @property - def Value(self)->'Tuple[Any, ...]': - """A sequence of buffers containing the attribute values""" - pass - - -class PyCRYPT_BIT_BLOB(object): - """Dict containing raw data of a certain bit length""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Data(self)->'Any': - """Binary data""" - pass - - - @property - def UnusedBits(self)->'Any': - """Nbr of bits of last byte that are unused""" - pass - - -class PyCRYPT_DECRYPT_MESSAGE_PARA(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def CertStores(self)->'Tuple[Any, ...]': - """Sequence of certificate stores to be searched for a certificate with a private key that can be used to decrypt the message""" - pass - - - @property - def MsgAndCertEncodingType(self)->'Any': - """Encoding types, optional. Defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" - pass - - - @property - def Flags(self)->'Any': - """Optional. CRYPT_MESSAGE_SILENT_KEYSET_FLAG can be used to suppress any dialogs that might be triggered by accessing a key container, such as a request for a PIN.""" - pass - - -class PyCRYPT_ENCRYPT_MESSAGE_PARA(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ContentEncryptionAlgorithm(self)->'PyCRYPT_ALGORITHM_IDENTIFIER': - """Identifies the algorithm to be used""" - pass - - - @property - def CryptProv(self)->'PyCRYPTPROV': - """Optional. Handle to provider that will perform encryption, can be None for default provider""" - pass - - - @property - def EncryptionAuxInfo(self)->'Any': - """Optional. Extra info required by some CSP's. Not supported yet, use only None""" - pass - - - @property - def Flags(self)->'Any': - """Optional. Combination of CRYPT_MESSAGE_*_FLAG constants""" - pass - - - @property - def InnerContentType(self)->'Any': - """Optional. Only used if message to be encrypted is already encoded""" - pass - - - @property - def MsgEncodingType(self)->'Any': - """Optional. Defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" - pass - - -class PyCRYPT_SIGN_MESSAGE_PARA(object): - """Dict of parms defining how a message will be signed""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def SigningCert(self)->'PyCERT_CONTEXT': - """Certficate to be used to sign message""" - pass - - - @property - def HashAlgorithm(self)->'PyCRYPT_ALGORITHM_IDENTIFIER': - """Algorithm to be used for signed hash""" - pass - - - @property - def HashAuxInfo(self)->'Any': - """Optional. Param is reserved, use only None.""" - pass - - - @property - def MsgCert(self)->'Tuple[PyCERT_CONTEXT, ...]': - """Optional sequence of certificate to be included in the message.""" - pass - - - @property - def MsgCrl(self)->'Tuple[Any, ...]': - """Optional. Sequence of certificate revocation lists. Not yet supported, use only None.""" - pass - - - @property - def AuthAttr(self)->'Tuple[PyCRYPT_ATTRIBUTE, ...]': - """Sequence of canonical attributes to be added to the message""" - pass - - - @property - def UnauthAttr(self)->'Tuple[PyCRYPT_ATTRIBUTE, ...]': - """Sequence of arbitrary attributes""" - pass - - - @property - def Flags(self)->'Any': - """Optional CRYPT_MESSAGE_*_FLAG that indicates content type if output is to be further encoded.""" - pass - - - @property - def InnerContentType(self)->'Any': - """Optional, one of the CMSG_* content types if message is already encoded, .""" - pass - - - @property - def MsgEncodingType(self)->'Any': - """Encoding types, optional. Defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" - pass - - -class PyCRYPT_VERIFY_MESSAGE_PARA(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def MsgAndCertEncodingType(self)->'Any': - """Encoding types, defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" - pass - - - @property - def CryptProv(self)->'PyCRYPTPROV': - """CSP to be used to verify signature. Use None for default provider.""" - pass - - - @property - def PyGetSignerCertificate(self)->'Any': - """Callback function that locates signer's certificate.""" - pass - - - @property - def GetArg(self)->'Any': - """Argument to be passed to above function, can be any object.""" - pass - - -class PyCTL_CONTEXT(object): - """Object containing a Certificate Trust List""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def HCTL_CONTEXT(self)->'Any': - """Raw message handle""" - pass - - - def CertFreeCTLContext(self,) -> 'None': - """ - Closes the CTL handle - -Args: - - - -Returns: - - None - - """ - pass - - - def CertEnumCTLContextProperties(self,) -> 'Tuple[Any, ...]': - """ - Lists property id's for the context - -Args: - - - -Returns: - - Tuple[Any, ...] - - """ - pass - - - def CertEnumSubjectInSortedCTL(self,) -> 'Tuple[Tuple[Any, Any], ...]': - """ - Retrieves trusted subjects contained in CRL - -Args: - - - -Returns: - - Tuple[Tuple[Any, Any], ...]:PyCTL_CONTEXT.CertEnumSubjectInSortedCTL - -((str,str),...) = CertEnumSubjectInSortedCTL()Retrieves trusted subjects contained in CRL -Return ValueReturns a sequence of tuples containing two strings (SubjectIdentifier, EncodedAttributes) - - - """ - pass - - - def CertDeleteCTLFromStore(self,) -> 'None': - """ - Removes the CTL from the store that it is contained in - -Args: - - - -Returns: - - None - - """ - pass - - - def CertSerializeCTLStoreElement(self,Flags:'Any'=0) -> 'str': - """ - Serializes the CTL and its properties - -Args: - - Flags(Any):Reserved, use only 0 if passed in - -Returns: - - str - - """ - pass - - -class PyCTL_USAGE(object): - """Sequence of string OIDs (szOID_*). This struct is identical to CERT_ENHKEY_USAGE.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyConsoleScreenBuffer(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetConsoleActiveScreenBuffer(self,) -> 'None': - """ - Sets this handle as the currently displayed screen - -buffer - -Args: - - - -Returns: - - None - - """ - pass - - - def GetConsoleCursorInfo(self,) -> 'Tuple[Any, Any]': - """ - Retrieves size and visibility of console's - -cursor - -Args: - - - -Returns: - - Tuple[Any, Any]:PyConsoleScreenBuffer.GetConsoleCursorInfo - -(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 - -if cursor is visible - - - """ - pass - - - def SetConsoleCursorInfo(self,Size:'Any',Visible:'Any') -> 'None': - """ - Sets the size and visibility of console's cursor - -Args: - - Size(Any):Percentage of character size that cursor will occupy - Visible(Any):Determines if cursor is visible - -Returns: - - None - - """ - pass - - - def GetConsoleMode(self,) -> 'Any': - """ - Returns the input or output mode of the console buffer - -Args: - - - -Returns: - - Any:PyConsoleScreenBuffer.GetConsoleMode - -int = GetConsoleMode()Returns the input or output mode of the console buffer -Return ValueReturns a combination of ENABLE_*_INPUT or ENABLE_*_OUTPUT constants - - - """ - pass - - - def SetConsoleMode(self,Mode:'Any') -> 'None': - """ - Sets the input or output mode of the console buffer - -Args: - - Mode(Any):Combination of ENABLE_*_INPUT or ENABLE_*_OUTPUT constants - -Returns: - - None - - """ - pass - - - def ReadConsole(self,NumberOfCharsToRead:'Any') -> 'Any': - """ - Reads characters from the console input buffer - -Args: - - NumberOfCharsToRead(Any):Characters to read - -Returns: - - Any - - """ - pass - - - def WriteConsole(self,Buffer:'Any') -> 'Any': - """ - Writes characters at current cursor position - -Args: - - Buffer(Any):String or Unicode to be written to consoleReturn ValueReturns the number of characters written - -Returns: - - Any:String or Unicode to be written to consoleReturn ValueReturns the number of characters written - - - """ - pass - - - def FlushConsoleInputBuffer(self,) -> 'None': - """ - Flush input buffer - -Args: - - - -Returns: - - None - - """ - pass - - - def SetConsoleTextAttribute(self,Attributes:'Any') -> 'None': - """ - Sets character attributes for subsequent write operations - -Args: - - Attributes(Any):Attributes to be set, combination of FOREGROUND_*, BACKGROUND_*, and COMMON_LVB_* constants - -Returns: - - None - - """ - pass - - - def SetConsoleCursorPosition(self,CursorPosition:'PyCOORD') -> 'None': - """ - Sets the console screen buffer's cursor position - -Args: - - CursorPosition(PyCOORD):A PyCOORD containing the new cursor position - -Returns: - - None - - """ - pass - - - def SetConsoleScreenBufferSize(self,Size:'PyCOORD') -> 'None': - """ - Sets the size of the console screen buffer - -Args: - - Size(PyCOORD):COORD object containing the new dimensions - -Returns: - - None - - """ - pass - - - def SetConsoleWindowInfo(self,Absolute:'Any',ConsoleWindow:'PySMALL_RECT') -> 'None': - """ - Changes size and position of a console's window - -Args: - - Absolute(Any):If False, coordinates are relative to current position - ConsoleWindow(PySMALL_RECT):A SMALL_RECT containing the new window coordinates - -Returns: - - None - - """ - pass - - - def GetConsoleScreenBufferInfo(self,) -> 'Any': - """ - Returns the state of the screen buffer - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetLargestConsoleWindowSize(self,) -> 'PyCOORD': - """ - Returns the largest possible size for the - -console's window - -Args: - - - -Returns: - - PyCOORD - - """ - pass - - - def FillConsoleOutputAttribute(self,Attribute:'Any',Length:'Any',WriteCoord:'PyCOORD') -> 'Any': - """ - Set text attributes for a consecutive series of - -characters - -Args: - - Attribute(Any):Text attributes to be set, combination of FOREGROUND_*, BACKGROUND_*, and COMMON_LVB_* constants - Length(Any):The number of characters to set - WriteCoord(PyCOORD):The screen position to begin atReturn ValueReturns the number of character cells whose attributes were set - -Returns: - - Any:The screen position to begin atReturn ValueReturns the number of character cells whose attributes were set - - - """ - pass - - - def FillConsoleOutputCharacter(self,Character:'Any',Length:'Any',WriteCoord:'PyCOORD') -> 'Any': - """ - Sets consecutive character positions to a specified - -character - -Args: - - Character(Any):A single character to be used to fill the specified range - Length(Any):The number of characters positions to fill - WriteCoord(PyCOORD):The screen position to begin atReturn ValueReturns the number of characters actually written - -Returns: - - Any:The screen position to begin atReturn ValueReturns the number of characters actually written - - - """ - pass - - - def ReadConsoleOutputCharacter(self,Length:'Any',ReadCoord:'PyCOORD') -> 'str': - """ - Reads consecutive characters from a starting - -position - -Args: - - Length(Any):The number of characters positions to read - ReadCoord(PyCOORD):The screen position start reading from - -Returns: - - str - - """ - pass - - - def ReadConsoleOutputAttribute(self,Length:'Any',ReadCoord:'PyCOORD') -> 'Tuple[Any, ...]': - """ - Retrieves attributes from consecutive character - -cells - -Args: - - Length(Any):The number of attributes to read - ReadCoord(PyCOORD):The screen position from which to start readingReturn ValueReturns a sequence of ints containing the attributes of a range of characters - -Returns: - - Tuple[Any, ...]:The screen position from which to start readingReturn ValueReturns a sequence of ints containing the attributes of a range of characters - - - """ - pass - - - def WriteConsoleOutputCharacter(self,Characters:'Any',WriteCoord:'PyCOORD') -> 'Any': - """ - Writes a string of characters at a specified position - -Args: - - Characters(Any):Characters to be written - WriteCoord(PyCOORD):The screen position at which to start writingReturn ValueReturns the number of characters actually written - -Returns: - - Any:The screen position at which to start writingReturn ValueReturns the number of characters actually written - - - """ - pass - - - def WriteConsoleOutputAttribute(self,Attributes:'Tuple[Any, ...]',WriteCoord:'PyCOORD') -> 'Any': - """ - Sets the attributes of a range of character cells - -Args: - - Attributes(Tuple[Any, ...]):A sequence of ints containing the attributes to be set - WriteCoord(PyCOORD):The screen position at which to start writingReturn ValueReturns the number of attributes set - -Returns: - - Any:The screen position at which to start writingReturn ValueReturns the number of attributes set - - - """ - pass - - - def ScrollConsoleScreenBuffer(self,ScrollRectangle:'PySMALL_RECT',ClipRectangle:'PySMALL_RECT',DestinationOrigin:'PyCOORD',FillCharacter:'Any',FillAttribute:'Any') -> 'None': - """ - Scrolls a region of the display - -Args: - - ScrollRectangle(PySMALL_RECT):The region to be scrolled - ClipRectangle(PySMALL_RECT):Rectangle that limits display area affected, can be None - DestinationOrigin(PyCOORD):The position to which ScrollRectangle will be moved - FillCharacter(Any):Character to fill in the area left blank by scrolling operation - FillAttribute(Any):Text attributes to apply to FillCharacter - -Returns: - - None - - """ - pass - - - def GetCurrentConsoleFont(self,MaximumWindow:'Any'=False) -> 'Tuple[Any, PyCOORD]': - """ - Returns currently displayed font - -Args: - - MaximumWindow(Any):If True, retrieves font size for maximum window sizeCommentsOnly exists on XP or later. 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 - -Returns: - - Tuple[Any, PyCOORD]:If True, retrieves font size for maximum window size -Comments - -Only exists on XP or later. - -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 - - - def GetConsoleFontSize(self,Font:'Any') -> 'PyCOORD': - """ - Returns size of specified font for the console - -Args: - - Font(Any):Index of font as returned by GetCurrentConsoleFontCommentsOnly exists on XP or later. - -Returns: - - PyCOORD - - """ - pass - - - def SetConsoleFont(self,Font:'Any') -> 'None': - """ - Changes the font used by the screen buffer - -Args: - - Font(Any):The number of the font to be setCommentsFunction is not documented on MSDN - -Returns: - - None - - """ - pass - - - def SetStdHandle(self,StdHandle:'Any') -> 'None': - """ - Replaces one of calling process's standard handles with this handle - -Args: - - StdHandle(Any):Specifies handle to be replaced - STD_INPUT_HANDLE, STD_OUTPUT_HANDLE, or STD_ERROR_HANDLE - -Returns: - - None - - """ - pass - - - def SetConsoleDisplayMode(self,Flags:'Any',NewScreenBufferDimensions:'PyCOORD') -> 'None': - """ - Sets the display mode of the console buffer - -Args: - - Flags(Any):CONSOLE_FULLSCREEN_MODE or CONSOLE_WINDOWED_MODE - NewScreenBufferDimensions(PyCOORD):New size of the screen buffer in characters - -Returns: - - None - - """ - pass - - - def WriteConsoleInput(self,Buffer:'Tuple[PyINPUT_RECORD, ...]') -> 'Any': - """ - Places input records in the console's input queue - -Args: - - Buffer(Tuple[PyINPUT_RECORD, ...]):A sequence of PyINPUT_RECORD objectsReturn ValueReturns the number of records written - -Returns: - - Any:A sequence of PyINPUT_RECORD objectsReturn ValueReturns the number of records written - - - """ - pass - - - def ReadConsoleInput(self,Length:'Any') -> 'Tuple[PyINPUT_RECORD, ...]': - """ - Reads input records and removes them from - -the input queue - -Args: - - Length(Any):The number of input records to readCommentsThis functions blocks until at least one record is read. The number of records returned may be less than the nbr requestedReturn ValueReturns a sequence of PyINPUT_RECORD objects - -Returns: - - Tuple[PyINPUT_RECORD, ...]:The number of input records to readComments - -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:'Any') -> 'Tuple[PyINPUT_RECORD, ...]': - """ - Returns pending input records without - -removing them from the input queue - -Args: - - Length(Any):The number of input records to readCommentsThis function does not block as ReadConsoleInput does. The number of records returned may be less than the nbr requestedReturn ValueReturns a sequence of PyINPUT_RECORD objects - -Returns: - - Tuple[PyINPUT_RECORD, ...]:The number of input records to readComments - -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,) -> 'Any': - """ - Returns the number of unread records in the input - -queue - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyCredHandle(object): - """Handle to a set of logon credentials, used with sspi authentication functions""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Detach(self,) -> 'Any': - """ - Disassociates object from handle and returns integer value of handle, - -Args: - - - -Returns: - - Any - - """ - pass - - - def FreeCredentialsHandle(self,) -> 'None': - """ - Releases the credentials handle and makes object unusable - -Args: - - - -Returns: - - None - - """ - pass - - - def QueryCredentialsAttributes(self,Attribute:'Any') -> 'None': - """ - Returns information about the credentials - -Args: - - Attribute(Any):SECPKG_* constant specifying which type of information to returnCommentsOnly SECPKG_CRED_ATTR_NAMES currently supportedAttributeReturn typeSECPKG_CRED_ATTR_NAMESPyUnicode - returns username that credentials representSECPKG_ATTR_SUPPORTED_ALGSNot supported yet SecPkgCred_SupportedAlgs:SECPKG_ATTR_CIPHER_STRENGTHSNot supported yet SecPkgCred_CipherStrengths:SECPKG_ATTR_SUPPORTED_PROTOCOLSNot supported yet SecPkgCred_SupportedProtocols:Return ValueType of returned values is dependent on Attribute - -Returns: - - None:SECPKG_* constant specifying which type of information to returnComments - -Only SECPKG_CRED_ATTR_NAMES currently supported - - - -Attribute - - -Return type - - - -SECPKG_CRED_ATTR_NAMESPyUnicode - returns username that credentials represent -SECPKG_ATTR_SUPPORTED_ALGSNot supported yet - -SecPkgCred_SupportedAlgs: -SECPKG_ATTR_CIPHER_STRENGTHSNot supported yet - -SecPkgCred_CipherStrengths: -SECPKG_ATTR_SUPPORTED_PROTOCOLSNot supported yet - -SecPkgCred_SupportedProtocols: -Return ValueType of returned values is dependent on Attribute - - - """ - pass - - -class PyCtxtHandle(object): - """Security context handle, as used with sspi functions""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Detach(self,) -> 'Any': - """ - Disassociates object from handle and returns integer value of handle - -Args: - - - -Returns: - - Any - - """ - pass - - - def CompleteAuthToken(self,Token:'PySecBufferDesc') -> 'None': - """ - Completes the authentication token - -Args: - - Token(PySecBufferDesc):The buffer that contains the token buffer used when the context was initializedCommentsThis method should be invoked on a context handle if the InitializeSecurityContext call that created it returned SEC_I_COMPLETE_NEEDED or SEC_I_COMPLETE_AND_CONTINUE - -Returns: - - None - - """ - pass - - - def QueryContextAttributes(self,Attribute:'Any') -> 'None': - """ - Retrieves info about a security context - -Args: - - Attribute(Any):SECPKG_ATTR_* constantCommentsNot all attributes are available for every security packageAttributeReturn typeSECPKG_ATTR_ACCESS_TOKENPyHANDLE - returns a handle to the context's access tokenSECPKG_ATTR_AUTHORITYPyUnicode - returns the name of the authenticating entitySECPKG_ATTR_CIPHER_STRENGTHS(int,int) - returns the mininum and maximum cipher strengths allowedSECPKG_ATTR_CONNECTION_INFOReturns a dictionary of connection info representing a SecPkgContext_ConnectionInfo structSECPKG_ATTR_SESSION_KEYstring - returns the session key for the contextSECPKG_ATTR_ISSUER_LIST_EX(int, string) - Returns names of trusted certificate issuersSECPKG_ATTR_FLAGSint - returns flags negotiated when context was establishedSECPKG_ATTR_PACKAGE_INFOdict - returns dictionary containing info for context's security packageSECPKG_ATTR_NEGOTIATION_INFO(int, dict) - returns state of negotiation (SECPKG_NEGOTIATION_COMPLETE, SECPKG_NEGOTIATION_OPTIMISTIC,SECPKG_NEGOTIATION_IN_PROGRESS) and info for negotiated packageSECPKG_ATTR_NAMESPyUnicode - returns the user name for the contextSECPKG_ATTR_SIZESdict containing buffer sizes to be used with the contextSECPKG_ATTR_PASSWORD_EXPIRYPyTime - returns time password expiresSECPKG_ATTR_LIFESPAN(PyTime,PyTime) - returns time period during which context is validSECPKG_ATTR_NATIVE_NAMES(PyUnicode,PyUnicode) - returns client and server namesSECPKG_ATTR_TARGET_INFORMATIONstring - returns the target for the contextSECPKG_ATTR_STREAM_SIZESdict (see SecPkgContext_StreamSizes) containing message buffer sizesSECPKG_ATTR_KEY_INFOdict (see SecPkgContext_KeyInfo) containing encryption key parametersSECPKG_ATTR_DCE_INFOnot supported yet SecPkgContext_DceInfoSECPKG_ATTR_LOCAL_CERT_CONTEXTnot supported yet PCCERT_CONTEXTSECPKG_ATTR_REMOTE_CERT_CONTEXTnot supported yet PCCERT_CONTEXTSECPKG_ATTR_ROOT_STOREnot supported yet HCERTCONTEXTSECPKG_ATTR_SUPPORTED_ALGSnot supported yet SecPkgCred_SupportedAlgsSECPKG_ATTR_SUPPORTED_PROTOCOLSnot supported yet SecPkgCred_SupportedProtocols - -Returns: - - None - - """ - pass - - - def DeleteSecurityContext(self,) -> 'None': - """ - Frees the security context and invalidates the handle - -Args: - - - -Returns: - - None - - """ - pass - - - def QuerySecurityContextToken(self,) -> 'Any': - """ - Returns the access token for a security context - -Args: - - - -Returns: - - Any - - """ - pass - - - def MakeSignature(self,fqop:'Any',Message:'PySecBufferDesc',MessageSeqNo:'Any') -> 'None': - """ - Creates a crytographic hash of a message using session key of the security - -context - -Args: - - fqop(Any):Flags that indicate quality of protection desired, specific to each security package - Message(PySecBufferDesc):Buffer set that includes buffers for input data and output signature - MessageSeqNo(Any):A sequential number used by some packages to verify that no extraneous messages have been receivedCommentsThe 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_TOKENReturn ValueReturns None on success, and output buffer in Message will contain the signature - -Returns: - - 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 - -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 - - - def VerifySignature(self,Message:'PySecBufferDesc',MessageSeqNo:'Any') -> 'None': - """ - None - -Args: - - Message(PySecBufferDesc):SecBufferDesc that contains data buffer and signature buffer - MessageSeqNo(Any):A sequential number used by some packages to verify that no extraneous messages have been receivedCommentsThe buffer configuration is dependent on the security package. Usually there is a data buffer of type SECBUFFER_DATA and a signature buffer of type SECBUFFER_TOKENReturn ValueReturns quality of protection flags used to create signature - -Returns: - - 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 - -SECBUFFER_DATA - -and a signature buffer of type SECBUFFER_TOKEN -Return ValueReturns quality of protection flags used to create signature - - - """ - pass - - - def EncryptMessage(self,fqop:'Any',Message:'PySecBufferDesc',MessageSeqNo:'Any') -> 'None': - """ - Encrypts data with session key of security context - -Args: - - fqop(Any):Flags that indicate quality of protection desired, specific to each security package - Message(PySecBufferDesc):PySecBufferDesc that contains data buffer(s) to be encrypted - MessageSeqNo(Any):A sequential number used by some packages to verify that no extraneous messages have been receivedCommentsThe 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 SECBUFFER_TOKEN to receive signature or padding dataReturn ValueReturns None on success, and buffer(s) will contain encrypted data - -Returns: - - 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 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 - - - def DecryptMessage(self,Message:'PySecBufferDesc',MessageSeqNo:'Any') -> 'None': - """ - None - -Args: - - Message(PySecBufferDesc):PySecBufferDesc containing data buffers to be decrypted - MessageSeqNo(Any):A sequential number used by some packages to verify that no extraneous messages have been receivedCommentsThe 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 SECBUFFER_PADDING containing signature, padding, or other extra data from encryption process that doesn't fit in first bufferReturn ValueReturns flags specfic to security package indicating quality of protection - -Returns: - - 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 - -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 - -in first buffer -Return ValueReturns flags specfic to security package indicating quality of protection - - - """ - pass - - - def ImpersonateSecurityContext(self,) -> 'None': - """ - Impersonates a client security context - -Args: - - - -Returns: - - None - - """ - pass - - - def RevertSecurityContext(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - -class PyDCB(object): - """A Python object, representing an DCB structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def BaudRate(self)->'int': - """current baud rate""" - pass - - - @property - def wReserved(self)->'int': - """not currently used""" - pass - - - @property - def XonLim(self)->'int': - """transmit XON threshold""" - pass - - - @property - def XoffLim(self)->'int': - """transmit XOFF threshold""" - pass - - - @property - def ByteSize(self)->'int': - """number of bits/byte, 4-8""" - pass - - - @property - def Parity(self)->'int': - """0-4=no,odd,even,mark,space""" - pass - - - @property - def StopBits(self)->'int': - """0,1,2 = 1, 1.5, 2""" - pass - - - @property - def XonChar(self)->'str': - """Tx and Rx XON character""" - pass - - - @property - def XoffChar(self)->'str': - """Tx and Rx XOFF character""" - pass - - - @property - def ErrorChar(self)->'str': - """error replacement character""" - pass - - - @property - def EofChar(self)->'str': - """end of input character""" - pass - - - @property - def EvtChar(self)->'str': - """received event character""" - pass - - - @property - def wReserved1(self)->'int': - """reserved; do not use""" - pass - - - @property - def fBinary(self)->'int': - """binary mode, no EOF check""" - pass - - - @property - def fParity(self)->'int': - """enable parity checking""" - pass - - - @property - def fOutxCtsFlow(self)->'int': - """CTS output flow control""" - pass - - - @property - def fOutxDsrFlow(self)->'int': - """DSR output flow control""" - pass - - - @property - def fDtrControl(self)->'int': - """DTR flow control type""" - pass - - - @property - def fDsrSensitivity(self)->'int': - """DSR sensitivity""" - pass - - - @property - def fTXContinueOnXoff(self)->'int': - """XOFF continues Tx""" - pass - - - @property - def fOutX(self)->'int': - """XON/XOFF out flow control""" - pass - - - @property - def fInX(self)->'int': - """XON/XOFF in flow control""" - pass - - - @property - def fErrorChar(self)->'int': - """enable error replacement""" - pass - - - @property - def fNull(self)->'int': - """enable null stripping""" - pass - - - @property - def fRtsControl(self)->'int': - """RTS flow control""" - pass - - - @property - def fAbortOnError(self)->'int': - """abort on error""" - pass - - - @property - def fDummy2(self)->'int': - """reserved""" - pass - - -class PyDEVMODE(object): - """Python object wrapping a DEVMODE structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def SpecVersion(self)->'Any': - """Should always be set to DM_SPECVERSION""" - pass - - - @property - def DriverVersion(self)->'Any': - """Version nbr assigned to printer driver by vendor""" - pass - - - @property - def Size(self)->'Any': - """Size of structure""" - pass - - - @property - def DriverExtra(self)->'Any': - """Number of extra bytes allocated for driver data, can only be set when new object is created""" - pass - - - @property - def Fields(self)->'Any': - """Bitmask of win32con.DM_* constants indicating which members are set""" - pass - - - @property - def Orientation(self)->'Any': - """Only applies to printers, DMORIENT_PORTRAIT or DMORIENT_LANDSCAPE""" - pass - - - @property - def PaperSize(self)->'Any': - """Use 0 if PaperWidth and PaperLength are set, otherwise win32con.DMPAPER_* constant""" - pass - - - @property - def PaperLength(self)->'Any': - """Specified in 1/10 millimeters""" - pass - - - @property - def PaperWidth(self)->'Any': - """Specified in 1/10 millimeters""" - pass - - - @property - def Position_x(self)->'Any': - """Position of display relative to desktop""" - pass - - - @property - def Position_y(self)->'Any': - """Position of display relative to desktop""" - pass - - - @property - def DisplayOrientation(self)->'Any': - """Display rotation: DMDO_DEFAULT,DMDO_90, DMDO_180, DMDO_270""" - pass - - - @property - def DisplayFixedOutput(self)->'Any': - """DMDFO_DEFAULT, DMDFO_CENTER, DMDFO_STRETCH""" - pass - - - @property - def Scale(self)->'Any': - """Specified as percentage, eg 50 means half size of original""" - pass - - - @property - def Copies(self)->'Any': - """Nbr of copies to print""" - pass - - - @property - def DefaultSource(self)->'Any': - """DMBIN_* constant, or can be a printer-specific value""" - pass - - - @property - def PrintQuality(self)->'Any': - """DMRES_* constant, interpreted as DPI if positive""" - pass - - - @property - def Color(self)->'Any': - """DMCOLOR_COLOR or DMCOLOR_MONOCHROME""" - pass - - - @property - def Duplex(self)->'Any': - """For printers that do two-sided printing: DMDUP_SIMPLEX, DMDUP_HORIZONTAL, DMDUP_VERTICAL""" - pass - - - @property - def YResolution(self)->'Any': - """Vertical printer resolution in DPI - if this is set, PrintQuality indicates horizontal DPI""" - pass - - - @property - def TTOption(self)->'Any': - """TrueType options: DMTT_BITMAP, DMTT_DOWNLOAD, DMTT_DOWNLOAD_OUTLINE, DMTT_SUBDEV""" - pass - - - @property - def Collate(self)->'Any': - """DMCOLLATE_TRUE or DMCOLLATE_FALSE""" - pass - - - @property - def LogPixels(self)->'Any': - """Pixels per inch (only for display devices""" - pass - - - @property - def BitsPerPel(self)->'Any': - """Color resolution in bits per pixel""" - pass - - - @property - def PelsWidth(self)->'Any': - """Pixel width of display""" - pass - - - @property - def PelsHeight(self)->'Any': - """Pixel height of display""" - pass - - - @property - def DisplayFlags(self)->'Any': - """Combination of DM_GRAYSCALE and DM_INTERLACED""" - pass - - - @property - def DisplayFrequency(self)->'Any': - """Refresh rate""" - pass - - - @property - def ICMMethod(self)->'Any': - """Indicates where ICM is performed, one of win32con.DMICMMETHOD_* values""" - pass - - - @property - def ICMIntent(self)->'Any': - """Intent of ICM, one of win32con.DMICM_* values""" - pass - - - @property - def MediaType(self)->'Any': - """win32con.DMMEDIA_*, can also be a printer-specific value greater then DMMEDIA_USER""" - pass - - - @property - def DitherType(self)->'Any': - """Dithering option, win32con.DMDITHER_*""" - pass - - - @property - def Reserved1(self)->'Any': - """Reserved, use only 0""" - pass - - - @property - def Reserved2(self)->'Any': - """Reserved, use only 0""" - pass - - - @property - def Nup(self)->'Any': - """Controls printing of multiple logical pages per physical page, DMNUP_SYSTEM or DMNUP_ONEUP""" - pass - - - @property - def PanningWidth(self)->'Any': - """Not used, leave as 0""" - pass - - - @property - def PanningHeight(self)->'Any': - """Not used, leave as 0""" - pass - - - @property - def DeviceName(self)->'Any': - """String of at most 32 chars""" - pass - - - @property - def FormName(self)->'Any': - """Name of form as returned by win32print::EnumForms, at most 32 chars""" - pass - - - @property - def DriverData(self)->'Any': - """Driver data appended to end of structure""" - pass - - - def Clear(self,) -> 'None': - """ - Resets all members of the structure - -Args: - - - -Returns: - - None - - """ - pass - - -class PyDEVMODEW(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def SpecVersion(self)->'Any': - """Should always be set to DM_SPECVERSION""" - pass - - - @property - def DriverVersion(self)->'Any': - """Version nbr assigned to printer driver by vendor""" - pass - - - @property - def Size(self)->'Any': - """Size of structure""" - pass - - - @property - def DriverExtra(self)->'Any': - """Number of extra bytes allocated for driver data, can only be set when new object is created""" - pass - - - @property - def Fields(self)->'Any': - """Bitmask of win32con.DM_* constants indicating which members are set""" - pass - - - @property - def Orientation(self)->'Any': - """Only applies to printers, DMORIENT_PORTRAIT or DMORIENT_LANDSCAPE""" - pass - - - @property - def PaperSize(self)->'Any': - """Use 0 if PaperWidth and PaperLength are set, otherwise win32con.DMPAPER_* constant""" - pass - - - @property - def PaperLength(self)->'Any': - """Specified in 1/10 millimeters""" - pass - - - @property - def PaperWidth(self)->'Any': - """Specified in 1/10 millimeters""" - pass - - - @property - def Position_x(self)->'Any': - """Position of display relative to desktop""" - pass - - - @property - def Position_y(self)->'Any': - """Position of display relative to desktop""" - pass - - - @property - def DisplayOrientation(self)->'Any': - """Display rotation: DMDO_DEFAULT,DMDO_90, DMDO_180, DMDO_270""" - pass - - - @property - def DisplayFixedOutput(self)->'Any': - """DMDFO_DEFAULT, DMDFO_CENTER, DMDFO_STRETCH""" - pass - - - @property - def Scale(self)->'Any': - """Specified as percentage, eg 50 means half size of original""" - pass - - - @property - def Copies(self)->'Any': - """Nbr of copies to print""" - pass - - - @property - def DefaultSource(self)->'Any': - """DMBIN_* constant, or can be a printer-specific value""" - pass - - - @property - def PrintQuality(self)->'Any': - """DMRES_* constant, interpreted as DPI if positive""" - pass - - - @property - def Color(self)->'Any': - """DMCOLOR_COLOR or DMCOLOR_MONOCHROME""" - pass - - - @property - def Duplex(self)->'Any': - """For printers that do two-sided printing: DMDUP_SIMPLEX, DMDUP_HORIZONTAL, DMDUP_VERTICAL""" - pass - - - @property - def YResolution(self)->'Any': - """Vertical printer resolution in DPI - if this is set, PrintQuality indicates horizontal DPI""" - pass - - - @property - def TTOption(self)->'Any': - """TrueType options: DMTT_BITMAP, DMTT_DOWNLOAD, DMTT_DOWNLOAD_OUTLINE, DMTT_SUBDEV""" - pass - - - @property - def Collate(self)->'Any': - """DMCOLLATE_TRUE or DMCOLLATE_FALSE""" - pass - - - @property - def LogPixels(self)->'Any': - """Pixels per inch (only for display devices""" - pass - - - @property - def BitsPerPel(self)->'Any': - """Color resolution in bits per pixel""" - pass - - - @property - def PelsWidth(self)->'Any': - """Pixel width of display""" - pass - - - @property - def PelsHeight(self)->'Any': - """Pixel height of display""" - pass - - - @property - def DisplayFlags(self)->'Any': - """Combination of DM_GRAYSCALE and DM_INTERLACED""" - pass - - - @property - def DisplayFrequency(self)->'Any': - """Refresh rate""" - pass - - - @property - def ICMMethod(self)->'Any': - """Indicates where ICM is performed, one of win32con.DMICMMETHOD_* values""" - pass - - - @property - def ICMIntent(self)->'Any': - """Intent of ICM, one of win32con.DMICM_* values""" - pass - - - @property - def MediaType(self)->'Any': - """win32con.DMMEDIA_*, can also be a printer-specific value greater then DMMEDIA_USER""" - pass - - - @property - def DitherType(self)->'Any': - """Dithering option, win32con.DMDITHER_*""" - pass - - - @property - def Reserved1(self)->'Any': - """Reserved, use only 0""" - pass - - - @property - def Reserved2(self)->'Any': - """Reserved, use only 0""" - pass - - - @property - def Nup(self)->'Any': - """Controls printing of multiple logical pages per physical page, DMNUP_SYSTEM or DMNUP_ONEUP""" - pass - - - @property - def PanningWidth(self)->'Any': - """Not used, leave as 0""" - pass - - - @property - def PanningHeight(self)->'Any': - """Not used, leave as 0""" - pass - - - @property - def DeviceName(self)->'str': - """String of at most 32 chars""" - pass - - - @property - def FormName(self)->'Any': - """Name of form as returned by win32print::EnumForms, at most 32 chars""" - pass - - - @property - def DriverData(self)->'Any': - """Driver data appended to end of structure""" - pass - - -class PyDISPLAY_DEVICE(object): - """Python object wrapping a DISPLAY_DEVICE structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Size(self)->'Any': - """Size of structure""" - pass - - - @property - def DeviceName(self)->'Any': - """String of at most 32 chars""" - pass - - - @property - def DeviceString(self)->'Any': - """String of at most 128 chars""" - pass - - - @property - def StateFlags(self)->'Any': - """Bitmask of win32con.DISPLAY_DEVICE_* constants indicating current device status""" - pass - - - @property - def DeviceID(self)->'Any': - """String of at most 128 chars""" - pass - - - @property - def DeviceKey(self)->'Any': - """String of at most 128 chars""" - pass - - - def Clear(self,) -> 'None': - """ - Resets all members of the structure - -Args: - - - -Returns: - - None - - """ - pass - - -class PyDLGITEMTEMPLATE(object): - """A tuple describing a control in a dialog box.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyDLGTEMPLATE(object): - """A tuple of items describing a dialog box, that can be used to create the dialog.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyDS_HANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyDS_NAME_RESULT_ITEM(object): - """A tuple representing a DS_NAME_RESULT_ITEM""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyDateTime(object): - """A Python object, representing an instant in time.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Format(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyDialogTemplate(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyEVTLOG_HANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyEVT_HANDLE(object): - """Handle to an event log, session, query, or any other object used with - -the Evt* event log functions on Vista and later. - -When the object is destroyed, EvtClose is called.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyEVT_RPC_LOGIN(object): - """Tuple containing login credentials for a remote Event Log connection""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyEventLogRecord(object): - """An object containing the data in an EVENTLOGRECORD.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Reserved(self)->'int': - """""" - pass - - - @property - def RecordNumber(self)->'int': - """""" - pass - - - @property - def TimeGenerated(self)->'PyTime': - """""" - pass - - - @property - def TimeWritten(self)->'PyTime': - """""" - pass - - - @property - def EventID(self)->'int': - """""" - pass - - - @property - def EventType(self)->'int': - """""" - pass - - - @property - def EventCategory(self)->'int': - """""" - pass - - - @property - def ReservedFlags(self)->'int': - """""" - pass - - - @property - def ClosingRecordNumber(self)->'int': - """""" - pass - - - @property - def SourceName(self)->'str': - """""" - pass - - - @property - def StringInserts(self)->'Tuple[str, ...]': - """""" - pass - - - @property - def Sid(self)->'PySID': - """""" - pass - - - @property - def Data(self)->'str': - """""" - pass - - - @property - def ComputerName(self)->'str': - """""" - pass - - -class PyGROUP_INFO_0(object): - """A dictionary holding the information in a Win32 GROUP_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'Union[str]': - """Name of the group""" - pass - - -class PyGROUP_INFO_1(object): - """A dictionary holding the information in a Win32 GROUP_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'Union[str]': - """Name of the group""" - pass - - - @property - def comment(self)->'Union[str]': - """The group's comment.""" - pass - - -class PyGROUP_INFO_1002(object): - """A dictionary holding the information in a Win32 GROUP_INFO_1002 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def comment(self)->'Union[str]': - """""" - pass - - -class PyGROUP_INFO_1005(object): - """A dictionary holding the information in a Win32 GROUP_INFO_1005 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def attributes(self)->'Any': - """""" - pass - - -class PyGROUP_INFO_2(object): - """A dictionary holding the information in a Win32 GROUP_INFO_2 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'Union[str]': - """Name of the group""" - pass - - - @property - def comment(self)->'Union[str]': - """The group's comment.""" - pass - - - @property - def group_id(self)->'Any': - """""" - pass - - - @property - def attributes(self)->'Any': - """""" - pass - - -class PyGROUP_USERS_INFO_0(object): - """A dictionary holding the information in a Win32 GROUP_USERS_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'Union[str]': - """Name of the group or user""" - pass - - -class PyGROUP_USERS_INFO_1(object): - """A dictionary holding the information in a Win32 GROUP_USERS_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'Union[str]': - """Name of the group or user""" - pass - - - @property - def attributes(self)->'Any': - """""" - pass - - -class PyGdiHANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyGetSignerCertificate(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyHANDLE(object): - """A Python object, representing a win32 HANDLE.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def handle(self)->'Any': - """Integer value of the handleMethodsCloseCloses the handle closeSynonym for PyHANDLE::Close DetachDetaches the Win32 handle from the handle object. __nonzero__Used for detecting true/false. is nb_bool in Python 3.0 __int__Used when an integer representation of the handle object is required. __print__Used when the object is printed. tp_print __hash__Used when the hash value of an object is required tp_hash __str__Used when a string representation is required tp_str """ - pass - - - def Close(self,) -> 'None': - """ - Closes the underlying Win32 handle. - -Args: - - - -Returns: - - None - - """ - pass - - - def close(self,) -> 'None': - """ - Closes the underlying Win32 handle. - -Args: - - - -Returns: - - None - - """ - pass - - - def Detach(self,) -> 'Any': - """ - Detaches the Win32 handle from the handle object. - -Args: - - - -Returns: - - Any:PyHANDLE.Detach - -int = Detach()Detaches the Win32 handle from the handle object. -Comments - -After calling this function, the handle is effectively invalidated, - -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 - -handle object. -Return ValueThe result is the value of the handle before it is detached. If the - -handle is already detached, this will return zero. - - - """ - pass - - -class PyHDESK(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetThreadDesktop(self,) -> 'None': - """ - Assigns this desktop to the calling thread - -Args: - - - -Returns: - - None - - """ - pass - - - def EnumDesktopWindows(self,) -> 'Tuple[int, ...]': - """ - Returns a list of handles to all top-level windows on desktop - -Args: - - - -Returns: - - Tuple[int, ...] - - """ - pass - - - def SwitchDesktop(self,) -> 'None': - """ - Activates the desktop - -Args: - - - -Returns: - - None - - """ - pass - - - def CloseDesktop(self,) -> 'None': - """ - Closes the desktop handle - -Args: - - - -Returns: - - None - - """ - pass - - -class PyHDEVNOTIFY(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyHHNTRACK(object): - """A Python object, representing an HHNTRACK - -structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def action(self)->'Any': - """Specifies the action the user is about to take. This is an HHACT_ constant.""" - pass - - - @property - def hdr(self)->'Any': - """Standard WM_NOTIFY header(win32help::NMHDR).""" - pass - - - @property - def curUrl(self)->'str': - """A multi-byte, zero-terminated string that specifies the topic navigated to, or the name of the help window being created.""" - pass - - - @property - def winType(self)->'Any': - """A pointer to the current HH_WINTYPE structure (win32help::HH_WINTYPE).""" - pass - - -class PyHHN_NOTIFY(object): - """A Python object, representing an HHN_NOTIFY - -structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def hdr(self)->'Any': - """Standard WM_NOTIFY header.(win32help::NMHDR)""" - pass - - - @property - def url(self)->'str': - """A multi-byte, zero-terminated string that specifies the topic navigated to, or the name of the help window being created.""" - pass - - -class PyHH_AKLINK(object): - """A Python object, representing an HH_AKLINK structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def indexOnFail(self)->'Any': - """Specifies whether to display the keyword in the Index tab of the HTML Help Viewer if the lookup fails. The value of window specifies the Help Viewer.""" - pass - - - @property - def keywords(self)->'str': - """Specifies one or more ALink names or KLink keywords to look up. Multiple entries are delimited by a semicolon.""" - pass - - - @property - def url(self)->'str': - """Specifies the topic file to navigate to if the lookup fails. url refers to a valid topic within the specified compiled help (.chm) file and does not support Internet protocols that point to an HTML file.""" - pass - - - @property - def msgText(self)->'str': - """Specifies the text to display in a message box if the lookup fails and indexOnFail is FALSE and url is NULL.""" - pass - - - @property - def msgTitle(self)->'str': - """Specifies the caption of the message box in which the msgText parameter appears.""" - pass - - - @property - def window(self)->'str': - """Specifies the name of the window type in which to display one of the following: The selected topic, if the lookup yields one or more matching topics. The topic specified in url, if the lookup fails and a topic is specified in url. The Index tab, if the lookup fails and indexOnFail is specified as TRUE.""" - pass - - -class PyHH_FTS_QUERY(object): - """A Python object, representing an HH_FTS_QUERY - -structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def uniCodeStrings(self)->'Any': - """TRUE if all strings are Unicode.""" - pass - - - @property - def proximity(self)->'Any': - """Word proximity.""" - pass - - - @property - def stemmedSearch(self)->'Any': - """TRUE for StemmedSearch only.""" - pass - - - @property - def titleOnly(self)->'Any': - """TRUE for Title search only.""" - pass - - - @property - def execute(self)->'Any': - """TRUE to initiate the search.""" - pass - - - @property - def searchQuery(self)->'str': - """String containing the search query.""" - pass - - -class PyHH_POPUP(object): - """A Python object, representing an HH_POPUP structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def hinst(self)->'Any': - """Instance handle of the program or DLL to retrieve the string resource from. Ignored if idString is zero.""" - pass - - - @property - def idString(self)->'Any': - """Specifies zero, or a resource ID in the program or DLL specified in hinst.""" - pass - - - @property - def clrForeground(self)->'Any': - """Specifies the RGB value to use for the foreground color of the pop-up window. To use the system color for the window text, specify -1.""" - pass - - - @property - def clrBackground(self)->'Any': - """Specifies the RGB value to use for the background color of the pop-up window. To use the system color for the window background, specify -1.""" - pass - - - @property - def text(self)->'str': - """Specifies the text to display if idString is zero.""" - pass - - - @property - def font(self)->'str': - """Specifies the font attributes to use for the text in the pop-up window. Use the following format to specify font family, point size, character set, and font format: facename[, point size[, charset[ BOLD ITALIC UNDERLINE]]] To omit an attribute, enter a comma. For example, to specify bold, 10-pt, MS Sans Serif font, font would be: MS Sans Serif, 10, , BOLD""" - pass - - - @property - def pt(self)->'Any': - """(x,y). Specifies (in pixels) where the top center of the pop-up window should be located.""" - pass - - - @property - def margins(self)->'Any': - """(left,top,right,bottom). Specifies (in pixels) the margins to use on the left, top, right, and bottom sides of the pop-up window. The default for all rectangle members is -1.""" - pass - - -class PyHH_WINTYPE(object): - """A Python object, representing an HH_WINTYPE structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def uniCodeStrings(self)->'Any': - """Specifies whether the strings used in this structure are UNICODE.""" - pass - - - @property - def validMembers(self)->'Any': - """Specifies which members in the structure are valid.""" - pass - - - @property - def winProperties(self)->'Any': - """Specifies the properties of the window, such as whether it is the standard HTML Help Viewer or whether it includes a Search tab.""" - pass - - - @property - def styles(self)->'Any': - """Specifies the styles used to create the window. These styles can be ignored, combined with extended styles, or used exclusively depending on the value of the validMembers and winProperties parameters.""" - pass - - - @property - def exStyles(self)->'Any': - """Specifies the extended styles used to create the window. These styles can be ignored, combined with default styles, or used exclusively depending on the value of the validMembers and winProperties parameters.""" - pass - - - @property - def showState(self)->'Any': - """Specifies the initial display state of the window. Valid values are the same as those for the Win32 API ShowWindow function.""" - pass - - - @property - def hwndHelp(self)->'Any': - """Specifies the handle of the window if the window has been created.""" - pass - - - @property - def hwndCaller(self)->'Any': - """Specifies the window that will receive HTML Help notification messages. Notification messages are sent via Windows WM_NOTIFY messages.""" - pass - - - @property - def hwndToolBar(self)->'Any': - """Specifies the handle of the toolbar.""" - pass - - - @property - def hwndNavigation(self)->'Any': - """Specifies the handle of the Navigation pane.""" - pass - - - @property - def hwndHTML(self)->'Any': - """Specifies the handle of the Topic pane, which hosts Shdocvw.dll.""" - pass - - - @property - def navWidth(self)->'Any': - """Specifies the width of the Navigation pane when the Help Viewer is expanded.""" - pass - - - @property - def toolBarFlags(self)->'Any': - """Specifies which buttons to include on the toolbar.""" - pass - - - @property - def notExpanded(self)->'Any': - """Specifies that the Help Viewer open with the Navigation pane closed.""" - pass - - - @property - def curNavType(self)->'Any': - """Specifies the default tab to display on the Navigation pane.""" - pass - - - @property - def idNotify(self)->'Any': - """Specifies a non-zero ID for enabling HTML Help notification messages. This ID is passed as the wParam value of Windows WM_NOTIFY messages.""" - pass - - - @property - def typeName(self)->'str': - """A null-terminated string that specifies the name of the window type.""" - pass - - - @property - def caption(self)->'str': - """A null-terminated string that specifies the caption to display in the title bar of the window.""" - pass - - - @property - def windowPos(self)->'Any': - """(left,top,right,bottom). Specifies the coordinates of the window in pixels.""" - pass - - - @property - def HTMLPos(self)->'Any': - """(left,top,right,bottom). Specifies the coordinates of the Topic pane.""" - pass - - - @property - def toc(self)->'str': - """Specifies the contents (.hhc) file to display in the Navigation pane.""" - pass - - - @property - def index(self)->'str': - """Specifies the index (.hhk) file to display in the Navigation pane.""" - pass - - - @property - def file(self)->'str': - """Specifies the default HTML file to display in the Topic pane.""" - pass - - - @property - def home(self)->'str': - """Specifies the file or URL to display in the Topic pane when the Home button is clicked.""" - pass - - - @property - def jump1(self)->'str': - """Specifies the text to display underneath the Jump1 button.""" - pass - - - @property - def jump2(self)->'str': - """Specifies the text to display underneath the Jump2 button.""" - pass - - - @property - def urlJump1(self)->'str': - """Specifies the URL to jump to when the Jump1 button is clicked.""" - pass - - - @property - def urlJump2(self)->'str': - """Specifies the URL to jump to when the Jump2 button is clicked.""" - pass - - -class PyHINTERNET(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyHKEY(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyHTHEME(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyHWINSTA(object): - """Wrapper for a handle to a window station - returned by CreateWindowStation, OpenWindowStation, or GetProcessWindowStation""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def EnumDesktops(self,) -> 'Tuple[Any, ...]': - """ - Lists names of desktops in the window station - -Args: - - - -Returns: - - Tuple[Any, ...] - - """ - pass - - - def SetProcessWindowStation(self,) -> 'None': - """ - Associates the calling process with the window station - -Args: - - - -Returns: - - None - - """ - pass - - - def CloseWindowStation(self,) -> 'None': - """ - Closes the window station handle - -Args: - - - -Returns: - - None - - """ - pass - - -class PyICONINFO(object): - """Tuple describing an icon or cursor""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIID(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyINPUT_RECORD(object): - """Interface to the INPUT_RECORD struct used with console IO functions. Create using - -PyINPUT_RECORDType(EventType)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def EventType(self)->'Any': - """One of KEY_EVENT, MOUSE_EVENT, WINDOW_BUFFER_SIZE_EVENT, MENU_EVENT, FOCUS_EVENT. Cannot be changed after object is created""" - pass - - - @property - def KeyDown(self)->'Any': - """True for a key press, False for key release""" - pass - - - @property - def RepeatCount(self)->'Any': - """Nbr of repeats generated (key was held down if >1)""" - pass - - - @property - def VirtualKeyCode(self)->'Any': - """Device-independent key code, win32con.VK_*""" - pass - - - @property - def VirtualScanCode(self)->'Any': - """Device-dependent scan code generated by keyboard""" - pass - - - @property - def Char(self)->'str': - """Single unicode character generated by the keypress""" - pass - - - @property - def ControlKeyState(self)->'Any': - """State of modifier keys, combination of CAPSLOCK_ON, ENHANCED_KEY, LEFT_ALT_PRESSED, LEFT_CTRL_PRESSED, NUMLOCK_ON, RIGHT_ALT_PRESSED, RIGHT_CTRL_PRESSED, SCROLLLOCK_ON, SHIFT_PRESSED""" - pass - - - @property - def ButtonState(self)->'Any': - """Bitmask representing which mouse buttons were pressed.""" - pass - - - @property - def EventFlags(self)->'Any': - """DOUBLE_CLICK, MOUSE_MOVED or MOUSE_WHEELED, or 0. If 0, indicates a mouse button press""" - pass - - - @property - def MousePosition(self)->'PyCOORD': - """Position in character coordinates""" - pass - - - @property - def Size(self)->'PyCOORD': - """New size of screen buffer in character rows/columns""" - pass - - - @property - def SetFocus(self)->'Any': - """Reserved - Used only with type FOCUS_EVENT. This event is Reserved, and should be ignored.""" - pass - - - @property - def CommandId(self)->'Any': - """Used only with event type MENU_EVENT, which is reserved and should not be used""" - pass - - -class PyLOCALGROUP_INFO_0(object): - """A dictionary holding the information in a Win32 LOCALGROUP_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'Union[str]': - """Name of the group""" - pass - - -class PyLOCALGROUP_INFO_1(object): - """A dictionary holding the information in a Win32 LOCALGROUP_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'Union[str]': - """Name of the group""" - pass - - - @property - def comment(self)->'Union[str]': - """The group's comment.""" - pass - - -class PyLOCALGROUP_INFO_1002(object): - """A dictionary holding the information in a Win32 LOCALGROUP_INFO_1002 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def comment(self)->'Union[str]': - """""" - pass - - -class PyLOCALGROUP_MEMBERS_INFO_0(object): - """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_0 - -structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def sid(self)->'PySID': - """""" - pass - - -class PyLOCALGROUP_MEMBERS_INFO_1(object): - """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_1 - -structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def sid(self)->'PySID': - """""" - pass - - - @property - def sidusage(self)->'Any': - """""" - pass - - - @property - def name(self)->'Union[str]': - """""" - pass - - -class PyLOCALGROUP_MEMBERS_INFO_2(object): - """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_2 - -structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def sid(self)->'PySID': - """""" - pass - - - @property - def sidusage(self)->'Any': - """""" - pass - - - @property - def domainandname(self)->'Union[str]': - """string containing the name of the member prefixed by the domain name and the "\\" separator character""" - pass - - -class PyLOCALGROUP_MEMBERS_INFO_3(object): - """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_3 - -structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def domainandname(self)->'Union[str]': - """string containing the name of the member prefixed by the domain name and the "\\" separator character""" - pass - - -class PyLOGBRUSH(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Style(self)->'Any': - """Brush style, one of win32con.BS_* values""" - pass - - - @property - def Color(self)->'Any': - """RGB color value. Can also be DIB_PAL_COLORS or DIB_RGB_COLORS if Style is BS_DIBPATTERN or BS_DIBPATTERNPT=""" - pass - - - @property - def Hatch(self)->'Union[Any, int]': - """For BS_HATCH style, one of win32con.HS_*. Not used For BS_SOLID or BS_HOLLOW. For a pattern brush, this should be a handle to a bitmap""" - pass - - -class PyLOGFONT(object): - """A Python object, representing an PyLOGFONT structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def lfHeight(self)->'int': - """""" - pass - - - @property - def lfWidth(self)->'int': - """""" - pass - - - @property - def lfEscapement(self)->'int': - """""" - pass - - - @property - def lfOrientation(self)->'int': - """""" - pass - - - @property - def lfWeight(self)->'int': - """""" - pass - - - @property - def lfItalic(self)->'int': - """""" - pass - - - @property - def lfUnderline(self)->'int': - """""" - pass - - - @property - def lfStrikeOut(self)->'int': - """""" - pass - - - @property - def lfCharSet(self)->'int': - """""" - pass - - - @property - def lfOutPrecision(self)->'int': - """""" - pass - - - @property - def lfClipPrecision(self)->'int': - """""" - pass - - - @property - def lfQuality(self)->'int': - """""" - pass - - - @property - def lfPitchAndFamily(self)->'int': - """""" - pass - - - @property - def lfFaceName(self)->'str': - """Name of the typeface, at most 31 characters""" - pass - - -class PyLSA_HANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyLUID_AND_ATTRIBUTES(object): - """A sequence containing (LUID,Attributes) representing an LUID_AND_ATTRIBUTES structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyLsaLogon_HANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyMSG(object): - """A tuple representing a win32 MSG structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyNETRESOURCE(object): - """A Python object that encapsulates a Win32 NETRESOURCE structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwScope(self)->'int': - """""" - pass - - - @property - def dwType(self)->'int': - """""" - pass - - - @property - def dwDisplayType(self)->'int': - """""" - pass - - - @property - def dwUsage(self)->'int': - """""" - pass - - - @property - def localName(self)->'str': - """""" - pass - - - @property - def remoteName(self)->'str': - """""" - pass - - - @property - def comment(self)->'str': - """""" - pass - - - @property - def provider(self)->'str': - """""" - pass - - -class PyNET_VALIDATE_AUTHENTICATION_INPUT_ARG(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyNET_VALIDATE_PASSWORD_CHANGE_INPUT_ARG(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyNET_VALIDATE_PERSISTED_FIELDS(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyNMHDR(object): - """A Python object, representing an NMHDR - -structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def hwndFrom(self)->'Any': - """Window handle to the control sending a message. ??? 64-bit problem here ???""" - pass - - - @property - def idFrom(self)->'Any': - """Identifier of the control sending a message.""" - pass - - - @property - def code(self)->'Any': - """Notification code. This member can be a control-specific notification code or it can be one of the common notification codes.""" - pass - - -class PyNOTIFYICONDATA(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyOVERLAPPED(object): - """A Python object, representing an overlapped structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Offset(self)->'int': - """Specifies a file position at which to start the transfer. The file position is a byte offset from the start of the file. The calling process sets this member before calling the ReadFile or WriteFile function. This member is ignored when reading from or writing to named pipes and communications devices.""" - pass - - - @property - def OffsetHigh(self)->'int': - """Specifies the high word of the byte offset at which to start the transfer.""" - pass - - - @property - def object(self)->'Any': - """Any python object that you want to attach to your overlapped I/O request.""" - pass - - - @property - def dword(self)->'Any': - """An integer buffer that may be used by overlapped functions (eg, win32file::WaitCommEvent)""" - pass - - - @property - def hEvent(self)->'int': - """Identifies an event set to the signaled state when the transfer has been completed. The calling process sets this member before calling the win32file::ReadFile, win32file::WriteFile, win32pipe::ConnectNamedPipe, or win32pipe::TransactNamedPipe function.""" - pass - - - @property - def Internal(self)->'int': - """Reserved for operating system use. (pointer-sized value)""" - pass - - - @property - def InternalHigh(self)->'int': - """Reserved for operating system use. (pointer-sized value)""" - pass - - -class PyOVERLAPPEDReadBuffer(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyPERF_COUNTER_DEFINITION(object): - """An object encapsulating a Windows NT Performance Monitor counter definition - -(PERF_COUNTER_DEFINITION).""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def DefaultScale(self)->'int': - """The default scale of the counter.""" - pass - - - @property - def DetailLevel(self)->'int': - """The detail level of the counter.""" - pass - - - @property - def CounterType(self)->'int': - """The counter type.""" - pass - - - @property - def CounterNameTitleIndex(self)->'int': - """""" - pass - - - @property - def CounterHelpTitleIndex(self)->'int': - """Sentinel""" - pass - - - def Increment(self,) -> 'None': - """ - Increments the value of the performance counter - -Args: - - - -Returns: - - None - - """ - pass - - - def Decrement(self,) -> 'None': - """ - Decrements the value of the performance counter - -Args: - - - -Returns: - - None - - """ - pass - - - def Set(self,) -> 'None': - """ - Sets the counter to a specific value - -Args: - - - -Returns: - - None - - """ - pass - - - def Get(self,) -> 'None': - """ - Gets the current value of the counter - -Args: - - - -Returns: - - None - - """ - pass - - -class PyPERF_OBJECT_TYPE(object): - """A Python object, representing a PERF_OBJECT_TYPE structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ObjectNameTitleIndex(self)->'int': - """""" - pass - - - @property - def ObjectHelpTitleIndex(self)->'int': - """""" - pass - - - @property - def DefaultCounterIndex(self)->'int': - """""" - pass - - - def Close(self,) -> 'None': - """ - Closes the object. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyPOINT(object): - """Tuple of two ints (x,y) representing a POINT struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyPROFILEINFO(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def UserName(self)->'str': - """Name of user for which to load profile""" - pass - - - @property - def Flags(self)->'Any': - """Combination of PI_* flags""" - pass - - - @property - def ProfilePath(self)->'str': - """Path to roaming profile, can be None. Use win32net::NetUserGetInfo to retrieve user's profile path""" - pass - - - @property - def DefaultPath(self)->'str': - """Path to Default user profile, can be None""" - pass - - - @property - def ServerName(self)->'str': - """Domain controller, can be None""" - pass - - - @property - def PolicyPath(self)->'str': - """Location of policy file, can be None""" - pass - - - @property - def Profile(self)->'PyHKEY': - """Handle to root of user's registry key. This member is output.""" - pass - - -class PyPerfMonManager(object): - """A Python object""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Close(self,) -> 'None': - """ - Closes the performance monitor manager. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyPrinterHANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyRECT(object): - """Tuple of 4 ints defining a rectangle: (left, top, right, bottom)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyResourceId(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySCROLLINFO(object): - """A tuple representing a SCROLLINFO structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySC_HANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySECURITY_ATTRIBUTES(object): - """A Python object, representing a SECURITY_ATTRIBUTES structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def bInheritHandle(self)->'Any': - """Specifies whether the returned handle is inherited when a new process is created. If this member is TRUE, the new process inherits the handle.""" - pass - - - @property - def SECURITY_DESCRIPTOR(self)->'PySECURITY_DESCRIPTOR': - """A PySECURITY_DESCRIPTOR, or None""" - pass - - -class PySECURITY_DESCRIPTOR(object): - """A Python object, representing a SECURITY_DESCRIPTOR structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,) -> 'None': - """ - Initialize the SD. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetSecurityDescriptorOwner(self,) -> 'PySID': - """ - Return the owner of the security descriptor. - -Args: - - - -Returns: - - PySID - - """ - pass - - - def GetSecurityDescriptorDacl(self,) -> 'PyACL': - """ - Return the discretionary ACL of the security - -descriptor. - -Args: - - - -Returns: - - PyACL - - """ - pass - - - def GetSecurityDescriptorSacl(self,) -> 'PyACL': - """ - Return system access control list (SACL) of SD - -Args: - - - -Returns: - - PyACL - - """ - pass - - - def GetSecurityDescriptorControl(self,) -> 'Tuple[Any, Any]': - """ - Returns tuple of Control bit flags and - -revision of SD. - -Args: - - - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def SetSecurityDescriptorOwner(self,sid:'PySID',bOwnerDefaulted:'Any') -> 'None': - """ - Set owner SID. - -Args: - - sid(PySID):The sid to be set as owner in the security descriptor. - bOwnerDefaulted(Any):Normally set to false since this explicitely set the owner. - -Returns: - - None - - """ - pass - - - def SetSecurityDescriptorGroup(self,sid:'PySID',bOwnerDefaulted:'Any') -> 'Any': - """ - Set group SID. - -Args: - - sid(PySID):The group sid to be set in the security descriptor. - bOwnerDefaulted(Any):Normally set to false since this explicitely set the owner. - -Returns: - - Any - - """ - pass - - - def SetSecurityDescriptorSacl(self,bSaclPresent:'Any',SACL:'PyACL',bSaclDefaulted:'Any') -> 'None': - """ - Replaces system access control list (SACL) in the security - -descriptor. - -Args: - - bSaclPresent(Any):A flag indicating if SACL is to be used. If false, last 2 parms are ignored. - SACL(PyACL):The SACL to set in the security descriptor - bSaclDefaulted(Any):Flag, set to false if user has specifically set the SACL. - -Returns: - - None - - """ - pass - - - def IsValid(self,) -> 'None': - """ - Determines if the security descriptor is valid. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetLength(self,) -> 'None': - """ - return length of security descriptor (GetSecurityDescriptorLenght). - -Args: - - - -Returns: - - None - - """ - pass - - - def IsSelfRelative(self,) -> 'None': - """ - Returns 1 if security descriptor is self relative, 0 if absolute - -Args: - - - -Returns: - - None - - """ - pass - - - def SetSecurityDescriptorControl(self,ControlBitsOfInterest:'Any',ControlBitsToSet:'Any') -> 'None': - """ - Sets the control bit flags related to inheritance for a - -security descriptor - -Args: - - ControlBitsOfInterest(Any):Bitmask of flags to be modified - ControlBitsToSet(Any):Bitmask containing flag values to setCommentsOnly exists on Windows 2000 or later - -Returns: - - None - - """ - pass - - -class PySERVER_INFO_100(object): - """A dictionary holding the information in a Win32 SERVER_INFO_100 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def platform_id(self)->'Any': - """""" - pass - - - @property - def name(self)->'Union[str]': - """""" - pass - - -class PySERVER_INFO_101(object): - """A dictionary holding the information in a Win32 SERVER_INFO_101 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def platform_id(self)->'Any': - """""" - pass - - - @property - def name(self)->'Union[str]': - """""" - pass - - - @property - def version_major(self)->'Any': - """""" - pass - - - @property - def version_minor(self)->'Any': - """""" - pass - - - @property - def type(self)->'Any': - """one of the SV_TYPE_* constants""" - pass - - - @property - def comment(self)->'Union[str]': - """""" - pass - - -class PySERVER_INFO_102(object): - """A dictionary holding the information in a Win32 SERVER_INFO_102 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def platform_id(self)->'Any': - """""" - pass - - - @property - def name(self)->'Union[str]': - """""" - pass - - - @property - def version_major(self)->'Any': - """""" - pass - - - @property - def version_minor(self)->'Any': - """""" - pass - - - @property - def type(self)->'Any': - """one of the SV_TYPE_* constants""" - pass - - - @property - def comment(self)->'Union[str]': - """""" - pass - - - @property - def users(self)->'Any': - """""" - pass - - - @property - def disc(self)->'Any': - """""" - pass - - - @property - def hidden(self)->'Any': - """""" - pass - - - @property - def announce(self)->'Any': - """""" - pass - - - @property - def anndelta(self)->'Any': - """""" - pass - - - @property - def userpath(self)->'Union[str]': - """""" - pass - - -class PySERVER_INFO_402(object): - """A dictionary holding the information in a Win32 SERVER_INFO_402 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ulist_mtime(self)->'Any': - """""" - pass - - - @property - def glist_mtime(self)->'Any': - """""" - pass - - - @property - def alist_mtime(self)->'Any': - """""" - pass - - - @property - def security(self)->'Any': - """""" - pass - - - @property - def numadmin(self)->'Any': - """""" - pass - - - @property - def lanmask(self)->'Any': - """""" - pass - - - @property - def guestacct(self)->'Union[str]': - """""" - pass - - - @property - def chdevs(self)->'Any': - """""" - pass - - - @property - def chdevq(self)->'Any': - """""" - pass - - - @property - def chdevjobs(self)->'Any': - """""" - pass - - - @property - def connections(self)->'Any': - """""" - pass - - - @property - def shares(self)->'Any': - """""" - pass - - - @property - def openfiles(self)->'Any': - """""" - pass - - - @property - def sessopens(self)->'Any': - """""" - pass - - - @property - def sessvcs(self)->'Any': - """""" - pass - - - @property - def sessreqs(self)->'Any': - """""" - pass - - - @property - def opensearch(self)->'Any': - """""" - pass - - - @property - def activelocks(self)->'Any': - """""" - pass - - - @property - def numreqbuf(self)->'Any': - """""" - pass - - - @property - def sizreqbuf(self)->'Any': - """""" - pass - - - @property - def numbigbuf(self)->'Any': - """""" - pass - - - @property - def numfiletasks(self)->'Any': - """""" - pass - - - @property - def alertsched(self)->'Any': - """""" - pass - - - @property - def erroralert(self)->'Any': - """""" - pass - - - @property - def logonalert(self)->'Any': - """""" - pass - - - @property - def accessalert(self)->'Any': - """""" - pass - - - @property - def diskalert(self)->'Any': - """""" - pass - - - @property - def netioalert(self)->'Any': - """""" - pass - - - @property - def maxauditsz(self)->'Any': - """""" - pass - - - @property - def srvheuristics(self)->'Union[str]': - """""" - pass - - -class PySERVER_INFO_403(object): - """A dictionary holding the information in a Win32 SERVER_INFO_403 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ulist_mtime(self)->'Any': - """""" - pass - - - @property - def glist_mtime(self)->'Any': - """""" - pass - - - @property - def alist_mtime(self)->'Any': - """""" - pass - - - @property - def security(self)->'Any': - """""" - pass - - - @property - def numadmin(self)->'Any': - """""" - pass - - - @property - def lanmask(self)->'Any': - """""" - pass - - - @property - def guestacct(self)->'Union[str]': - """""" - pass - - - @property - def chdevs(self)->'Any': - """""" - pass - - - @property - def chdevq(self)->'Any': - """""" - pass - - - @property - def chdevjobs(self)->'Any': - """""" - pass - - - @property - def connections(self)->'Any': - """""" - pass - - - @property - def shares(self)->'Any': - """""" - pass - - - @property - def openfiles(self)->'Any': - """""" - pass - - - @property - def sessopens(self)->'Any': - """""" - pass - - - @property - def sessvcs(self)->'Any': - """""" - pass - - - @property - def sessreqs(self)->'Any': - """""" - pass - - - @property - def opensearch(self)->'Any': - """""" - pass - - - @property - def activelocks(self)->'Any': - """""" - pass - - - @property - def numreqbuf(self)->'Any': - """""" - pass - - - @property - def sizreqbuf(self)->'Any': - """""" - pass - - - @property - def numbigbuf(self)->'Any': - """""" - pass - - - @property - def numfiletasks(self)->'Any': - """""" - pass - - - @property - def alertsched(self)->'Any': - """""" - pass - - - @property - def erroralert(self)->'Any': - """""" - pass - - - @property - def logonalert(self)->'Any': - """""" - pass - - - @property - def accessalert(self)->'Any': - """""" - pass - - - @property - def diskalert(self)->'Any': - """""" - pass - - - @property - def netioalert(self)->'Any': - """""" - pass - - - @property - def maxauditsz(self)->'Any': - """""" - pass - - - @property - def srvheuristics(self)->'Union[str]': - """""" - pass - - - @property - def auditedevents(self)->'Any': - """""" - pass - - - @property - def autoprofile(self)->'Any': - """""" - pass - - - @property - def autopath(self)->'Union[str]': - """""" - pass - - -class PySERVER_INFO_502(object): - """A dictionary holding the information in a Win32 SERVER_INFO_502 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def sessopens(self)->'Any': - """""" - pass - - - @property - def sessvcs(self)->'Any': - """""" - pass - - - @property - def opensearch(self)->'Any': - """""" - pass - - - @property - def sizreqbuf(self)->'Any': - """""" - pass - - - @property - def initworkitems(self)->'Any': - """""" - pass - - - @property - def maxworkitems(self)->'Any': - """""" - pass - - - @property - def rawworkitems(self)->'Any': - """""" - pass - - - @property - def irpstacksize(self)->'Any': - """""" - pass - - - @property - def maxrawbuflen(self)->'Any': - """""" - pass - - - @property - def sessusers(self)->'Any': - """""" - pass - - - @property - def sessconns(self)->'Any': - """""" - pass - - - @property - def maxpagedmemoryusage(self)->'Any': - """""" - pass - - - @property - def maxnonpagedmemoryusage(self)->'Any': - """""" - pass - - - @property - def enableforcedlogoff(self)->'Any': - """""" - pass - - - @property - def timesource(self)->'Any': - """""" - pass - - - @property - def acceptdownlevelapis(self)->'Any': - """""" - pass - - - @property - def lmannounce(self)->'Any': - """""" - pass - - -class PySERVER_INFO_503(object): - """A dictionary holding the information in a Win32 SERVER_INFO_503 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def sessopens(self)->'Any': - """""" - pass - - - @property - def sessvcs(self)->'Any': - """""" - pass - - - @property - def opensearch(self)->'Any': - """""" - pass - - - @property - def sizreqbuf(self)->'Any': - """""" - pass - - - @property - def initworkitems(self)->'Any': - """""" - pass - - - @property - def maxworkitems(self)->'Any': - """""" - pass - - - @property - def rawworkitems(self)->'Any': - """""" - pass - - - @property - def irpstacksize(self)->'Any': - """""" - pass - - - @property - def maxrawbuflen(self)->'Any': - """""" - pass - - - @property - def sessusers(self)->'Any': - """""" - pass - - - @property - def sessconns(self)->'Any': - """""" - pass - - - @property - def maxpagedmemoryusage(self)->'Any': - """""" - pass - - - @property - def maxnonpagedmemoryusage(self)->'Any': - """""" - pass - - - @property - def enableforcedlogoff(self)->'Any': - """""" - pass - - - @property - def timesource(self)->'Any': - """""" - pass - - - @property - def acceptdownlevelapis(self)->'Any': - """""" - pass - - - @property - def lmannounce(self)->'Any': - """""" - pass - - - @property - def domain(self)->'Union[str]': - """""" - pass - - - @property - def maxkeepsearch(self)->'Any': - """""" - pass - - - @property - def scavtimeout(self)->'Any': - """""" - pass - - - @property - def minrcvqueue(self)->'Any': - """""" - pass - - - @property - def minfreeworkitems(self)->'Any': - """""" - pass - - - @property - def xactmemsize(self)->'Any': - """""" - pass - - - @property - def threadpriority(self)->'Any': - """""" - pass - - - @property - def maxmpxct(self)->'Any': - """""" - pass - - - @property - def oplockbreakwait(self)->'Any': - """""" - pass - - - @property - def oplockbreakresponsewait(self)->'Any': - """""" - pass - - - @property - def enableoplocks(self)->'Any': - """""" - pass - - - @property - def enablefcbopens(self)->'Any': - """""" - pass - - - @property - def enableraw(self)->'Any': - """""" - pass - - - @property - def enablesharednetdrives(self)->'Any': - """""" - pass - - - @property - def minfreeconnections(self)->'Any': - """""" - pass - - - @property - def maxfreeconnections(self)->'Any': - """""" - pass - - -class PySHARE_INFO_0(object): - """A dictionary holding the infomation in a Win32 SHARE_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def netname(self)->'Union[str]': - """""" - pass - - -class PySHARE_INFO_1(object): - """A dictionary holding the infomation in a Win32 SHARE_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def netname(self)->'Union[str]': - """""" - pass - - - @property - def type(self)->'Any': - """""" - pass - - - @property - def remark(self)->'Union[str]': - """""" - pass - - -class PySHARE_INFO_2(object): - """A dictionary holding the infomation in a Win32 SHARE_INFO_2 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def netname(self)->'Union[str]': - """""" - pass - - - @property - def type(self)->'Any': - """""" - pass - - - @property - def remark(self)->'Union[str]': - """""" - pass - - - @property - def permissions(self)->'Any': - """""" - pass - - - @property - def max_uses(self)->'Any': - """""" - pass - - - @property - def current_uses(self)->'Any': - """""" - pass - - - @property - def path(self)->'Union[str]': - """""" - pass - - - @property - def passwd(self)->'Union[str]': - """""" - pass - - -class PySHARE_INFO_501(object): - """A dictionary holding the infomation in a Win32 SHARE_INFO_501 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def netname(self)->'Union[str]': - """""" - pass - - - @property - def type(self)->'Any': - """""" - pass - - - @property - def remark(self)->'Union[str]': - """""" - pass - - - @property - def flags(self)->'Any': - """""" - pass - - -class PySHARE_INFO_502(object): - """A dictionary holding the infomation in a Win32 SHARE_INFO_502 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def netname(self)->'Union[str]': - """""" - pass - - - @property - def type(self)->'Any': - """""" - pass - - - @property - def remark(self)->'Union[str]': - """""" - pass - - - @property - def permissions(self)->'Any': - """""" - pass - - - @property - def max_uses(self)->'Any': - """""" - pass - - - @property - def current_uses(self)->'Any': - """""" - pass - - - @property - def path(self)->'Union[str]': - """""" - pass - - - @property - def passwd(self)->'Union[str]': - """""" - pass - - - @property - def reserved(self)->'Any': - """""" - pass - - - @property - def security_descriptor(self)->'PySECURITY_DESCRIPTOR': - """""" - pass - - -class PySID(object): - """A Python object, representing a SID structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,idAuthority:'Any',numSubauthorities:'Any') -> 'None': - """ - Initialize the SID. - -Args: - - idAuthority(Any):The identifier authority. - numSubauthorities(Any):The number of sub authorities to allocate. - -Returns: - - None - - """ - pass - - - def IsValid(self,) -> 'None': - """ - Determines if the SID is valid. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetSubAuthority(self,index:'Any',val:'Any') -> 'None': - """ - Sets a SID SubAuthority - -Args: - - index(Any):The index of the sub authority to set - val(Any):The value for the sub authorityCommentsSee the function SetSidSubAuthority - -Returns: - - None - - """ - pass - - - def GetLength(self,) -> 'Any': - """ - return length of SID (GetLengthSid). - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetSubAuthorityCount(self,) -> 'Any': - """ - return nbr of subauthorities from SID - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetSubAuthority(self,) -> 'Any': - """ - Returns specified subauthority from SID - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetSidIdentifierAuthority(self,) -> 'Tuple[Any, Any, Any, Any, Any, Any]': - """ - Returns a tuple of 6 SID_IDENTIFIER_AUTHORITY - -constants - -Args: - - - -Returns: - - Tuple[Any, Any, Any, Any, Any, Any] - - """ - pass - - -class PySID_AND_ATTRIBUTES(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySIZE(object): - """Tuple of two ints (cx,cy) representing a SIZE struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySMALL_RECT(object): - """Wrapper for a SMALL_RECT struct - -Create using PySMALL_RECTType(Left, Top, Right, Bottom). All params optional, defaulting to 0""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Left(self)->'Any': - """Left side of rectangle""" - pass - - - @property - def Top(self)->'Any': - """Top edge of rectangle""" - pass - - - @property - def Right(self)->'Any': - """Right edge of rectangle""" - pass - - - @property - def Bottom(self)->'Any': - """Bottome edge of rectangle""" - pass - - -class PySTARTUPINFO(object): - """A Python object, representing an STARTUPINFO structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwX(self)->'int': - """Specifies the x offset, in pixels, of the upper left corner of a window if a new window is created. The offset is from the upper left corner of the screen.""" - pass - - - @property - def dwY(self)->'int': - """Specifies the y offset, in pixels, of the upper left corner of a window if a new window is created. The offset is from the upper left corner of the screen.""" - pass - - - @property - def dwXSize(self)->'int': - """Specifies the width, in pixels, of the window if a new window is created.""" - pass - - - @property - def dwYSize(self)->'int': - """Specifies the height, in pixels, of the window if a new window is created.""" - pass - - - @property - def dwXCountChars(self)->'int': - """For console processes, if a new console window is created, specifies the screen buffer width in character columns. This value is ignored in a GUI process.""" - pass - - - @property - def dwYCountChars(self)->'int': - """For console processes, if a new console window is created, specifies the screen buffer height in character rows.""" - pass - - - @property - def dwFillAttribute(self)->'int': - """Specifies the initial text and background colors if a new console window is created in a console application. These values are ignored in GUI applications""" - pass - - - @property - def dwFlags(self)->'int': - """This is a bit field that determines whether certain STARTUPINFO attributes are used when the process creates a window. To use many of the additional attributes, you typically must set the appropriate mask in this attribute, and also set the attributes themselves. Any combination of the win32con.STARTF_* flags can be specified.""" - pass - - - @property - def wShowWindow(self)->'int': - """Can be any of the SW_ constants defined in win32con. For GUI processes, this specifies the default value the first time ShowWindow is called.""" - pass - - - @property - def hStdInput(self)->'Union[int]': - """""" - pass - - - @property - def hStdOutput(self)->'Union[int]': - """""" - pass - - - @property - def hStdError(self)->'Union[int]': - """""" - pass - - - @property - def lpDesktop(self)->'Union[Any, str]': - """""" - pass - - - @property - def lpTitle(self)->'Union[Any, str]': - """""" - pass - - -class PySecBuffer(object): - """Python object wrapping a SecBuffer structure - -Created using win32security.PySecBufferType(type,size) where type is a SECBUFFER_* constant""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def BufferType(self)->'Any': - """""" - pass - - - @property - def Buffer(self)->'str': - """""" - pass - - - @property - def BufferSize(self)->'Any': - """""" - pass - - - @property - def MaxBufferSize(self)->'Any': - """""" - pass - - - def Clear(self,) -> 'None': - """ - Resets the buffer to all NULL's, and set the current size to maximum - -Args: - - - -Returns: - - None - - """ - pass - - -class PySecBufferDesc(object): - """Sequence-like object that contains a group of buffers to be used with SSPI functions.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def append(self,buffer:'Any') -> 'None': - """ - None - -Args: - - buffer(Any):PySecBuffer object to be attached to the group of buffers - -Returns: - - None - - """ - pass - - -class PyTOKEN_GROUPS(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyTOKEN_PRIVILEGES(object): - """An object representing Win32 token privileges.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyTRIVERTEX(object): - """Dict representing a TRIVERTEX struct containing color information at a point""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def x(self)->'Any': - """X coord in logical units""" - pass - - - @property - def y(self)->'Any': - """Y coord in logical units""" - pass - - - @property - def Red(self)->'Any': - """Red component""" - pass - - - @property - def Green(self)->'Any': - """Green component""" - pass - - - @property - def Blue(self)->'Any': - """Blue component""" - pass - - - @property - def Alpha(self)->'Any': - """Transparency value""" - pass - - -class PyTRUSTEE(object): - """A dictionary representing a TRUSTEE structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def TrusteeForm(self)->'Any': - """""" - pass - - - @property - def TrusteeType(self)->'Any': - """""" - pass - - - @property - def Identifier(self)->'Any': - """Depends on the value of TrusteeForm (string or sid)""" - pass - - - @property - def MultipleTrustee(self)->'Any': - """default is None""" - pass - - - @property - def MultipleTrusteeOperation(self)->'Any': - """default is None""" - pass - - -class PyTS_HANDLE(object): - """Handle to a Terminal Server""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyTime(object): - """A Python object, representing an instant in time.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def year(self)->'Any': - """""" - pass - - - @property - def month(self)->'Any': - """""" - pass - - - @property - def weekday(self)->'Any': - """""" - pass - - - @property - def day(self)->'Any': - """""" - pass - - - @property - def hour(self)->'Any': - """""" - pass - - - @property - def minute(self)->'Any': - """""" - pass - - - @property - def second(self)->'Any': - """""" - pass - - - @property - def msec(self)->'Any': - """""" - pass - - - def Format(self,_format:'str') -> 'str': - """ - Formats the time value. - -Args: - - _format(str):The format. See the comments section for a description of the supported flags.CommentsThe following format characters are supported.CharacterDescription%aAbbreviated weekday name%AFull weekday name%bAbbreviated month name%BFull month name%cDate and time representation appropriate for locale%dDay of month as decimal number (01 - 31)%HHour in 24-hour format (00 - 23)%IHour in 12-hour format (01 - 12)%jDay of year as decimal number (001 - 366)%mMonth as decimal number (01 - 12)%MMinute as decimal number (00 - 59)%pCurrent locale's A.M./P.M. indicator for 12-hour clock%SSecond as decimal number (00 - 59)%UWeek of year as decimal number, with Sunday as first day of week (00 - 51)%wWeekday as decimal number (0 - 6; Sunday is 0)%WWeek of year as decimal number, with Monday as first day of week (00 - 51)%xDate representation for current locale%XTime representation for current locale%yYear without century, as decimal number (00 - 99)%YYear with century, as decimal number%z, %ZTime-zone name or abbreviation; no characters if time zone is unknown%%Percent signAs in the printf function, the # flag may prefix any formatting code. In that case, the meaning of the format code is changed as follows.Format CodeMeaning%#a, %#A, %#b, %#B, %#p, %#X, %#z, %#Z, %#%# flag is ignored.%#cLong date and time representation, appropriate for current locale. For example: "Tuesday, March 14, 1995, 12:41:29".%#xLong date representation, appropriate to current locale. For example: "Tuesday, March 14, 1995".%#d, %#H, %#I, %#j, %#m, %#M, %#S, %#U, %#w, %#W, %#y, %#YRemove leading zeros (if any). - -Returns: - - str - - """ - pass - - -class PyUSER_INFO_0(object): - """A dictionary holding the information in a Win32 USER_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'Union[str]': - """""" - pass - - -class PyUSER_INFO_1(object): - """A dictionary holding the information in a Win32 USER_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'Union[str]': - """""" - pass - - - @property - def password(self)->'Union[str]': - """""" - pass - - - @property - def password_age(self)->'Any': - """""" - pass - - - @property - def priv(self)->'Any': - """""" - pass - - - @property - def home_dir(self)->'Union[str]': - """""" - pass - - - @property - def comment(self)->'Union[str]': - """""" - pass - - - @property - def flags(self)->'Any': - """""" - pass - - - @property - def script_path(self)->'Union[str]': - """""" - pass - - -class PyUSER_INFO_10(object): - """A dictionary holding the information in a Win32 USER_INFO_10 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'Union[str]': - """""" - pass - - - @property - def comment(self)->'Union[str]': - """""" - pass - - - @property - def usr_comment(self)->'Union[str]': - """""" - pass - - - @property - def full_name(self)->'Union[str]': - """""" - pass - - -class PyUSER_INFO_1003(object): - """A dictionary holding the information in a Win32 USER_INFO_1003 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def password(self)->'Union[str]': - """""" - pass - - -class PyUSER_INFO_1005(object): - """A dictionary holding the information in a Win32 USER_INFO_1005 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def priv(self)->'Any': - """""" - pass - - -class PyUSER_INFO_1006(object): - """A dictionary holding the information in a Win32 USER_INFO_1006 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def home_dir(self)->'Union[str]': - """""" - pass - - -class PyUSER_INFO_1007(object): - """A dictionary holding the information in a Win32 USER_INFO_1007 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def comment(self)->'Union[str]': - """""" - pass - - -class PyUSER_INFO_1008(object): - """A dictionary holding the information in a Win32 USER_INFO_1008 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def flags(self)->'Any': - """""" - pass - - -class PyUSER_INFO_1009(object): - """A dictionary holding the information in a Win32 USER_INFO_1009 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def script_path(self)->'Union[str]': - """""" - pass - - -class PyUSER_INFO_1010(object): - """A dictionary holding the information in a Win32 USER_INFO_1010 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def auth_flags(self)->'Any': - """""" - pass - - -class PyUSER_INFO_1011(object): - """A dictionary holding the information in a Win32 USER_INFO_1011 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def full_name(self)->'Union[str]': - """""" - pass - - -class PyUSER_INFO_11(object): - """A dictionary holding the information in a Win32 USER_INFO_11 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'Union[str]': - """""" - pass - - - @property - def comment(self)->'Union[str]': - """""" - pass - - - @property - def usr_comment(self)->'Union[str]': - """""" - pass - - - @property - def full_name(self)->'Union[str]': - """""" - pass - - - @property - def priv(self)->'Any': - """""" - pass - - - @property - def auth_flags(self)->'Any': - """""" - pass - - - @property - def password_age(self)->'Any': - """""" - pass - - - @property - def home_dir(self)->'Union[str]': - """""" - pass - - - @property - def parms(self)->'Union[str]': - """""" - pass - - - @property - def last_logon(self)->'Any': - """""" - pass - - - @property - def last_logoff(self)->'Any': - """""" - pass - - - @property - def bad_pw_count(self)->'Any': - """""" - pass - - - @property - def num_logons(self)->'Any': - """""" - pass - - - @property - def logon_server(self)->'Union[str]': - """""" - pass - - - @property - def country_code(self)->'Any': - """""" - pass - - - @property - def workstations(self)->'Union[str]': - """""" - pass - - - @property - def max_storage(self)->'Any': - """""" - pass - - - @property - def units_per_week(self)->'Any': - """""" - pass - - - @property - def logon_hours(self)->'str': - """""" - pass - - - @property - def code_page(self)->'Any': - """""" - pass - - -class PyUSER_INFO_2(object): - """A dictionary holding the information in a Win32 USER_INFO_2 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'Union[str]': - """""" - pass - - - @property - def password(self)->'Union[str]': - """""" - pass - - - @property - def password_age(self)->'Any': - """""" - pass - - - @property - def priv(self)->'Any': - """""" - pass - - - @property - def home_dir(self)->'Union[str]': - """""" - pass - - - @property - def comment(self)->'Union[str]': - """""" - pass - - - @property - def flags(self)->'Any': - """""" - pass - - - @property - def script_path(self)->'Union[str]': - """""" - pass - - - @property - def auth_flags(self)->'Any': - """""" - pass - - - @property - def full_name(self)->'Union[str]': - """""" - pass - - - @property - def usr_comment(self)->'Union[str]': - """""" - pass - - - @property - def parms(self)->'Union[str]': - """""" - pass - - - @property - def workstations(self)->'Union[str]': - """""" - pass - - - @property - def last_logon(self)->'Any': - """""" - pass - - - @property - def last_logoff(self)->'Any': - """""" - pass - - - @property - def acct_expires(self)->'Any': - """""" - pass - - - @property - def max_storage(self)->'Any': - """""" - pass - - - @property - def units_per_week(self)->'Any': - """""" - pass - - - @property - def logon_hours(self)->'str': - """""" - pass - - - @property - def bad_pw_count(self)->'Any': - """""" - pass - - - @property - def num_logons(self)->'Any': - """""" - pass - - - @property - def logon_server(self)->'Union[str]': - """""" - pass - - - @property - def country_code(self)->'Any': - """""" - pass - - - @property - def code_page(self)->'Any': - """""" - pass - - -class PyUSER_INFO_20(object): - """A dictionary holding the information in a Win32 USER_INFO_20 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'Union[str]': - """""" - pass - - - @property - def full_name(self)->'Union[str]': - """""" - pass - - - @property - def comment(self)->'Union[str]': - """""" - pass - - - @property - def flags(self)->'Any': - """""" - pass - - - @property - def user_id(self)->'Any': - """""" - pass - - -class PyUSER_INFO_3(object): - """A dictionary holding the information in a Win32 USER_INFO_3 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'Union[str]': - """""" - pass - - - @property - def password(self)->'Union[str]': - """""" - pass - - - @property - def password_age(self)->'Any': - """""" - pass - - - @property - def priv(self)->'Any': - """""" - pass - - - @property - def home_dir(self)->'Union[str]': - """""" - pass - - - @property - def comment(self)->'Union[str]': - """""" - pass - - - @property - def flags(self)->'Any': - """""" - pass - - - @property - def script_path(self)->'Union[str]': - """""" - pass - - - @property - def auth_flags(self)->'Any': - """""" - pass - - - @property - def full_name(self)->'Union[str]': - """""" - pass - - - @property - def usr_comment(self)->'Union[str]': - """""" - pass - - - @property - def parms(self)->'Union[str]': - """""" - pass - - - @property - def workstations(self)->'Union[str]': - """""" - pass - - - @property - def last_logon(self)->'Any': - """""" - pass - - - @property - def last_logoff(self)->'Any': - """""" - pass - - - @property - def acct_expires(self)->'Any': - """""" - pass - - - @property - def max_storage(self)->'Any': - """""" - pass - - - @property - def units_per_week(self)->'Any': - """""" - pass - - - @property - def logon_hours(self)->'str': - """""" - pass - - - @property - def bad_pw_count(self)->'Any': - """""" - pass - - - @property - def num_logons(self)->'Any': - """""" - pass - - - @property - def logon_server(self)->'Union[str]': - """""" - pass - - - @property - def country_code(self)->'Any': - """""" - pass - - - @property - def code_page(self)->'Any': - """""" - pass - - - @property - def user_id(self)->'Any': - """""" - pass - - - @property - def primary_group_id(self)->'Any': - """""" - pass - - - @property - def profile(self)->'Union[str]': - """""" - pass - - - @property - def home_dir_drive(self)->'Union[str]': - """""" - pass - - - @property - def password_expired(self)->'Any': - """""" - pass - - -class PyUSER_INFO_4(object): - """A dictionary holding the information in a Win32 USER_INFO_4 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'Union[str]': - """""" - pass - - - @property - def password(self)->'Union[str]': - """""" - pass - - - @property - def password_age(self)->'Any': - """""" - pass - - - @property - def priv(self)->'Any': - """""" - pass - - - @property - def home_dir(self)->'Union[str]': - """""" - pass - - - @property - def comment(self)->'Union[str]': - """""" - pass - - - @property - def flags(self)->'Any': - """""" - pass - - - @property - def script_path(self)->'Union[str]': - """""" - pass - - - @property - def auth_flags(self)->'Any': - """""" - pass - - - @property - def full_name(self)->'Union[str]': - """""" - pass - - - @property - def usr_comment(self)->'Union[str]': - """""" - pass - - - @property - def parms(self)->'Union[str]': - """""" - pass - - - @property - def workstations(self)->'Union[str]': - """""" - pass - - - @property - def last_logon(self)->'Any': - """""" - pass - - - @property - def last_logoff(self)->'Any': - """""" - pass - - - @property - def acct_expires(self)->'Any': - """""" - pass - - - @property - def max_storage(self)->'Any': - """""" - pass - - - @property - def units_per_week(self)->'Any': - """""" - pass - - - @property - def logon_hours(self)->'str': - """""" - pass - - - @property - def bad_pw_count(self)->'Any': - """""" - pass - - - @property - def num_logons(self)->'Any': - """""" - pass - - - @property - def logon_server(self)->'Union[str]': - """""" - pass - - - @property - def country_code(self)->'Any': - """""" - pass - - - @property - def code_page(self)->'Any': - """""" - pass - - - @property - def user_sid(self)->'PySID': - """""" - pass - - - @property - def primary_group_id(self)->'Any': - """""" - pass - - - @property - def profile(self)->'Union[str]': - """""" - pass - - - @property - def home_dir_drive(self)->'Union[str]': - """""" - pass - - - @property - def password_expired(self)->'Any': - """""" - pass - - -class PyUSER_MODALS_INFO_0(object): - """A dictionary holding the information in a Win32 USER_MODALS_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def min_passwd_len(self)->'Any': - """""" - pass - - - @property - def max_passwd_age(self)->'Any': - """""" - pass - - - @property - def min_passwd_age(self)->'Any': - """""" - pass - - - @property - def force_logoff(self)->'Any': - """""" - pass - - - @property - def password_hist_len(self)->'Any': - """""" - pass - - -class PyUSER_MODALS_INFO_1(object): - """A dictionary holding the information in a Win32 USER_MODALS_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def role(self)->'Any': - """""" - pass - - - @property - def primary(self)->'Union[str]': - """""" - pass - - -class PyUSER_MODALS_INFO_2(object): - """A dictionary holding the information in a Win32 USER_MODALS_INFO_2 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def domain_name(self)->'Union[str]': - """""" - pass - - - @property - def domain_id(self)->'PySID': - """""" - pass - - -class PyUSER_MODALS_INFO_3(object): - """A dictionary holding the information in a Win32 USER_MODALS_INFO_3 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def lockout_duration(self)->'Any': - """""" - pass - - - @property - def lockout_observation_window(self)->'Any': - """""" - pass - - - @property - def usrmod3_lockout_threshold(self)->'Any': - """""" - pass - - -class PyUSE_INFO_0(object): - """A dictionary holding the infomation in a Win32 USE_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def local(self)->'Union[str]': - """""" - pass - - - @property - def remote(self)->'Union[str]': - """""" - pass - - -class PyUSE_INFO_1(object): - """A dictionary holding the infomation in a Win32 USE_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def local(self)->'Union[str]': - """""" - pass - - - @property - def remote(self)->'Union[str]': - """""" - pass - - - @property - def password(self)->'Union[Any, str]': - """""" - pass - - - @property - def status(self)->'Any': - """""" - pass - - - @property - def asg_type(self)->'Any': - """""" - pass - - - @property - def refcount(self)->'Any': - """""" - pass - - - @property - def usecount(self)->'Any': - """""" - pass - - -class PyUSE_INFO_2(object): - """A dictionary holding the infomation in a Win32 USE_INFO_2 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def local(self)->'Union[str]': - """""" - pass - - - @property - def remote(self)->'Union[str]': - """""" - pass - - - @property - def password(self)->'Union[Any, str]': - """""" - pass - - - @property - def status(self)->'Any': - """""" - pass - - - @property - def asg_type(self)->'Any': - """""" - pass - - - @property - def refcount(self)->'Any': - """""" - pass - - - @property - def usecount(self)->'Any': - """""" - pass - - - @property - def username(self)->'Union[str]': - """""" - pass - - - @property - def domainname(self)->'Union[str]': - """""" - pass - - -class PyUSE_INFO_3(object): - """A dictionary holding the infomation in a Win32 USE_INFO_3 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def local(self)->'Union[str]': - """""" - pass - - - @property - def remote(self)->'Union[str]': - """""" - pass - - - @property - def password(self)->'Union[Any, str]': - """""" - pass - - - @property - def status(self)->'Any': - """""" - pass - - - @property - def asg_type(self)->'Any': - """""" - pass - - - @property - def refcount(self)->'Any': - """""" - pass - - - @property - def usecount(self)->'Any': - """""" - pass - - - @property - def username(self)->'Union[str]': - """""" - pass - - - @property - def domainname(self)->'Union[str]': - """""" - pass - - - @property - def flags(self)->'Any': - """""" - pass - - -class PyUnicode(object): - """A Python object, representing a Unicode string.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyUrlCacheHANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyWAVEFORMATEX(object): - """A Python object, representing a WAVEFORMATEX structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def wFormatTag(self)->'int': - """Waveform-audio format type. pywintypes only defines WAVE_FORMAT_PCM as a constant. Other values must be looked up in the mmsystem.h header file.""" - pass - - - @property - def nChannels(self)->'int': - """Number of channels. 1 for Mono, 2 for Stereo, anything, but never 5.1.""" - pass - - - @property - def nSamplesPerSec(self)->'int': - """Sample rate, in samples per second (hertz), that each channel should be played or recorded. If wFormatTag is WAVE_FORMAT_PCM, then common values for nSamplesPerSec are 8000, 11025, 22050, and 44100 Hz""" - pass - - - @property - def nAvgBytesPerSec(self)->'int': - """Required average data-transfer rate, in bytes per second, for the format tag. If wFormatTag is WAVE_FORMAT_PCM, nAvgBytesPerSec should be equal to the product of nSamplesPerSec and nBlockAlign.""" - pass - - - @property - def nBlockAlign(self)->'int': - """Block alignment, in bytes. The block alignment is the minimum atomic unit of data for the wFormatTag format type. If wFormatTag is WAVE_FORMAT_PCM, nBlockAlign should be equal to the product of nChannels and wBitsPerSample divided by 8 (bits per byte). For non-PCM formats, this member must be computed according to the manufacturer’s specification of the format tag.""" - pass - - - @property - def wBitsPerSample(self)->'int': - """Bits per sample for the wFormatTag format type. If wFormatTag is WAVE_FORMAT_PCM, then wBitsPerSample should be equal to 8 or 16. Sentinel""" - pass - - -class PyWINHTTP_AUTOPROXY_OPTIONS(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyWINHTTP_PROXY_INFO(object): - """A tuple representing a WINHTTP_PROXY_INFO structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyWKSTA_INFO_100(object): - """A dictionary holding the infomation in a Win32 WKSTA_INFO_100 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def platform_id(self)->'Any': - """Indicates platform level to use to retrieve platform specific information""" - pass - - - @property - def computername(self)->'Union[str]': - """Name of the local computer""" - pass - - - @property - def langroup(self)->'Union[str]': - """Name of the domain to which computer belongs""" - pass - - - @property - def ver_major(self)->'Any': - """Major version number of operating system running on the computer""" - pass - - - @property - def ver_minor(self)->'Any': - """Minor version number of operating system running on the computer""" - pass - - -class PyWKSTA_INFO_101(object): - """A dictionary holding the infomation in a Win32 WKSTA_INFO_101 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def platform_id(self)->'Any': - """Indicates platform level to use to retrieve platform specific information""" - pass - - - @property - def computername(self)->'Union[str]': - """Name of the local computer""" - pass - - - @property - def langroup(self)->'Union[str]': - """Name of the domain to which computer belongs""" - pass - - - @property - def ver_major(self)->'Any': - """Major version number of operating system running on the computer""" - pass - - - @property - def ver_minor(self)->'Any': - """Minor version number of operating system running on the computer""" - pass - - - @property - def lanroot(self)->'Union[str]': - """Path to the LANMAN directory""" - pass - - -class PyWKSTA_INFO_102(object): - """A dictionary holding the infomation in a Win32 WKSTA_INFO_102 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def platform_id(self)->'Any': - """Indicate platform level to use to retrieve platform specific information""" - pass - - - @property - def computername(self)->'Union[str]': - """Name of the local computer""" - pass - - - @property - def langroup(self)->'Union[str]': - """Name of the domain to which computer belongs""" - pass - - - @property - def ver_major(self)->'Any': - """Major version number of operating system running on the computer""" - pass - - - @property - def ver_minor(self)->'Any': - """Minor version number of operating system running on the computer""" - pass - - - @property - def lanroot(self)->'Union[str]': - """Path to the LANMAN directory""" - pass - - - @property - def logged_on_users(self)->'Any': - """Number of users who are logged on to the local computer""" - pass - - -class PyWKSTA_INFO_302(object): - """A dictionary holding the infomation in a Win32 WKSTA_INFO_302 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def char_wait(self)->'Any': - """number of seconds the computer will wait for a remote resource to become available""" - pass - - - @property - def collection_time(self)->'Any': - """number of milliseconds the computer will collect data before sending the data to a character device resource. The workstation waits the specified time or collects the number of characters specified by wki302_maximum_collection_count, whichever comes first.""" - pass - - - @property - def maximum_collection_count(self)->'Any': - """Specifies the number of bytes of information the computer will collect before sending the data to a character device resource. The workstation collects the specified number of bytes or waits the time specified by wki302_collection_time, whichever comes first.""" - pass - - - @property - def keep_conn(self)->'Any': - """Specifies the number of seconds the server will maintain an inactive connection to a resource.""" - pass - - - @property - def keep_search(self)->'Any': - """Defines the number of seconds an inactive search will continue.""" - pass - - - @property - def max_cmds(self)->'Any': - """Specifies the number of simultaneous network device driver commands that can be sent to the network.""" - pass - - - @property - def num_work_buf(self)->'Any': - """Specifies the number of internal buffers the computer has.""" - pass - - - @property - def siz_work_buf(self)->'Any': - """Specifies the size, in bytes, of each internal buffer.""" - pass - - - @property - def max_wrk_cache(self)->'Any': - """Specifies the maximum size, in bytes, of an internal cache buffer.""" - pass - - - @property - def siz_error(self)->'Any': - """Specifies the size, in bytes, of an internal error buffer.""" - pass - - - @property - def num_alerts(self)->'Any': - """Specifies the maximum number of clients that can receive alert messages. (This member is not supported under MS-DOS.) The Alerter service registers at least three clients when it begins to run.""" - pass - - - @property - def num_services(self)->'Any': - """Specifies the number of services that can be installed on the computer at any time.""" - pass - - - @property - def errlog_sz(self)->'Any': - """Specifies the maximum size, in kilobytes, of the client's error log file.""" - pass - - - @property - def print_buf_time(self)->'Any': - """Specifies the number of seconds the server waits before closing inactive compatibility-mode print jobs.""" - pass - - - @property - def num_char_buf(self)->'Any': - """Specifies the number of character pipe buffers and device buffers the client can have.""" - pass - - - @property - def siz_char_buf(self)->'Any': - """Specifies the maximum size, in bytes, of a character pipe buffer and device buffer.""" - pass - - - @property - def wrk_heuristics(self)->'Union[str]': - """Pointer to a Unicode string of flags used to control a client's operation.""" - pass - - - @property - def mailslots(self)->'Any': - """Specifies the maximum number of mailslots allowed.""" - pass - - - @property - def num_dgram_buf(self)->'Any': - """Specifies the number of buffers to allocate for receiving datagrams.""" - pass - - -class PyWKSTA_INFO_402(object): - """A dictionary holding the infomation in a Win32 WKSTA_INFO_402 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def char_wait(self)->'Any': - """number of seconds the computer will wait for a remote resource to become available""" - pass - - - @property - def collection_time(self)->'Any': - """number of milliseconds the computer will collect data before sending the data to a character device resource. The workstation waits the specified time or collects the number of characters specified by wki402_maximum_collection_count, whichever comes first.""" - pass - - - @property - def maximum_collection_count(self)->'Union[str]': - """Name of the domain to which computer belongs""" - pass - - - @property - def keep_conn(self)->'Any': - """Major version number of operating system running on the computer""" - pass - - - @property - def keep_search(self)->'Any': - """Minor version number of operating system running on the computer""" - pass - - - @property - def max_cmds(self)->'Any': - """..""" - pass - - - @property - def num_work_buf(self)->'Any': - """Number of users who are logged on to the local computer""" - pass - - - @property - def siz_work_buf(self)->'Any': - """Number of users who are logged on to the local computer""" - pass - - - @property - def max_wrk_cache(self)->'Any': - """..""" - pass - - - @property - def sess_timeout(self)->'Any': - """..""" - pass - - - @property - def siz_error(self)->'Any': - """..""" - pass - - - @property - def num_alerts(self)->'Any': - """..""" - pass - - - @property - def num_services(self)->'Any': - """..""" - pass - - - @property - def errlog_sz(self)->'Any': - """..""" - pass - - - @property - def print_buf_time(self)->'Any': - """..""" - pass - - - @property - def num_char_buf(self)->'Any': - """..""" - pass - - - @property - def siz_char_buf(self)->'Any': - """Specifies the maximum size, in bytes, of a character pipe buffer and device buffer.""" - pass - - - @property - def mailslots(self)->'Any': - """..""" - pass - - - @property - def num_dgram_buf(self)->'Any': - """..""" - pass - - - @property - def max_threads(self)->'Any': - """Number of threads the computer can dedicate to the network""" - pass - - -class PyWKSTA_INFO_502(object): - """A dictionary holding the infomation in a Win32 WKSTA_INFO_502 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def char_wait(self)->'Any': - """number of seconds the computer will wait for a remote resource to become available""" - pass - - - @property - def collection_time(self)->'Any': - """number of milliseconds the computer will collect data before sending the data to a character device resource. The workstation waits the specified time or collects the number of characters specified by wki502_maximum_collection_count, whichever comes first.""" - pass - - - @property - def maximum_collection_count(self)->'Any': - """Specifies the number of bytes of information the computer will collect before sending the data to a character device resource. The workstation collects the specified number of bytes or waits the time specified by wki302_collection_time, whichever comes first.""" - pass - - - @property - def keep_conn(self)->'Any': - """Specifies the number of seconds the server will maintain an inactive connection to a resource.""" - pass - - - @property - def max_cmds(self)->'Any': - """Specifies the number of simultaneous network device driver commands that can be sent to the network.""" - pass - - - @property - def max_wrk_cache(self)->'Any': - """Indicates the number of seconds the server waits before disconnecting an inactive session.""" - pass - - - @property - def siz_char_buf(self)->'Any': - """Specifies the maximum size, in bytes, of a character pipe buffer and device buffer.""" - pass - - - @property - def lock_quota(self)->'Any': - """TODO""" - pass - - - @property - def lock_increment(self)->'Any': - """TODO""" - pass - - - @property - def lock_maximum(self)->'Any': - """TODO""" - pass - - - @property - def pipe_increment(self)->'Any': - """TODO""" - pass - - - @property - def pipe_maximum(self)->'Any': - """TODO""" - pass - - - @property - def cache_file_timeout(self)->'Any': - """TODO""" - pass - - - @property - def dormant_file_limit(self)->'Any': - """TODO""" - pass - - - @property - def read_ahead_throughput(self)->'Any': - """TODO""" - pass - - - @property - def num_mailslot_buffers(self)->'Any': - """TODO""" - pass - - - @property - def num_srv_announce_buffers(self)->'Any': - """TODO""" - pass - - - @property - def max_illegal_datagram_events(self)->'Any': - """TODO""" - pass - - - @property - def illegal_datagram_event_reset_frequency(self)->'Any': - """TODO""" - pass - - - @property - def log_election_packets(self)->'Any': - """TODO""" - pass - - - @property - def use_opportunistic_locking(self)->'Any': - """TODO""" - pass - - - @property - def use_unlock_behind(self)->'Any': - """TODO""" - pass - - - @property - def use_close_behind(self)->'Any': - """TODO""" - pass - - - @property - def buf_named_pipes(self)->'Any': - """TODO""" - pass - - - @property - def use_lock_read_unlock(self)->'Any': - """TODO""" - pass - - - @property - def utilize_nt_caching(self)->'Any': - """TODO""" - pass - - - @property - def use_raw_read(self)->'Any': - """TODO""" - pass - - - @property - def use_raw_write(self)->'Any': - """TODO""" - pass - - - @property - def use_write_raw_data(self)->'Any': - """TODO""" - pass - - - @property - def use_encryption(self)->'Any': - """TODO""" - pass - - - @property - def buf_files_deny_write(self)->'Any': - """TODO""" - pass - - - @property - def buf_read_only_files(self)->'Any': - """TODO""" - pass - - - @property - def force_core_create_mode(self)->'Any': - """TODO""" - pass - - - @property - def use_512_byte_max_transfer(self)->'Any': - """TODO""" - pass - - -class PyWKSTA_TRANSPORT_INFO_0(object): - """A dictionary holding the infomation in a Win32 WKSTA_TRANSPORT_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def quality_of_service(self)->'Any': - """Supplies a value that specifies the search order of the transport protocol with respect to other transport protocols. The highest value is searched first.""" - pass - - - @property - def number_of_vcs(self)->'Any': - """Specifies the number of clients communicating with the server using this transport protocol.""" - pass - - - @property - def transport_name(self)->'Union[str]': - """Specifies the device name of the transport protocol.""" - pass - - - @property - def transport_address(self)->'Union[str]': - """Specifies the address of the server on this transport protocol.""" - pass - - - @property - def wan_ish(self)->'Any': - """This member is ignored by the NetWkstaTransportAdd function. For the NetWkstaTransportEnum function, this member indicates that this transport protocol is a WAN transport protocol. This member is set TRUE for NetBIOS/TCIP; it is set FALSE for NetBEUI and NetBIOS/IPX.""" - pass - - -class PyWKSTA_USER_INFO_0(object): - """A dictionary holding the infomation in a Win32 WKSTA_USER_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def username(self)->'Union[str]': - """Name of user currently logged on to the workstation""" - pass - - -class PyWKSTA_USER_INFO_1(object): - """A dictionary holding the infomation in a Win32 WKSTA_USER_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def username(self)->'Union[str]': - """Name of user currently logged on to the workstation""" - pass - - - @property - def logon_domain(self)->'Union[str]': - """Returns the domain name of the user account of the user currently logged on to the workstation.""" - pass - - - @property - def oth_domains(self)->'Union[str]': - """Returns the list of other operating system domains browsed by the workstation. The domain names are separated by blanks.""" - pass - - - @property - def logon_server(self)->'Union[str]': - """Returns the name of the computer that authenticated the server.""" - pass - - -class PyWNDCLASS(object): - """A Python object, representing an WNDCLASS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def style(self)->'int': - """""" - pass - - - @property - def cbWndExtra(self)->'int': - """""" - pass - - - @property - def hInstance(self)->'int': - """""" - pass - - - @property - def hIcon(self)->'int': - """""" - pass - - - @property - def hCursor(self)->'int': - """""" - pass - - - @property - def hbrBackground(self)->'int': - """These 3 handled manually in PyWNDCLASS::getattro/setattro. The pymeth below is used as an end tag, so these props will be lost if below it""" - pass - - - @property - def lpszMenuName(self)->'Union[str]': - """""" - pass - - - @property - def lpszClassName(self)->'Union[str]': - """""" - pass - - - @property - def lpfnWndProc(self)->'Any': - """MethodsSetDialogProcSets the WNDCLASS to be for a dialog box. """ - pass - - - def SetDialogProc(self,) -> 'None': - """ - Sets the WNDCLASS to be for a dialog box - -Args: - - - -Returns: - - None - - """ - pass - - -class PyXFORM(object): - """Dict representing an XFORM struct used as a world transformation matrix - -All members are optional, defaulting to 0.0.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def M11(self)->'float': - """Usage is dependent on operation performed, see MSDN docs""" - pass - - - @property - def M12(self)->'float': - """Usage is dependent on operation performed, see MSDN docs""" - pass - - - @property - def M21(self)->'float': - """Usage is dependent on operation performed, see MSDN docs""" - pass - - - @property - def M22(self)->'float': - """Usage is dependent on operation performed, see MSDN docs""" - pass - - - @property - def Dx(self)->'float': - """Horizontal offset in logical units""" - pass - - - @property - def Dy(self)->'float': - """Vertical offset in logical units""" - pass - - -class Pymmapfile(object): - """Object that provides access to memory-mapped file operations.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def close(self,) -> 'None': - """ - Closes the file mapping handle and releases mapped view - -Args: - - - -Returns: - - None - - """ - pass - - - def find(self,needle:'Any',start:'Any') -> 'Any': - """ - Finds a string in the buffer. - -Args: - - needle(Any):String to be located - start(Any):Pos at which to start search, current pos assumed if not specifiedReturn ValueReturns pos of string, or -1 if not found - -Returns: - - Any:Pos at which to start search, current pos assumed if not specifiedReturn ValueReturns pos of string, or -1 if not found - - - """ - pass - - - def flush(self,offset:'Any'=0,size:'Any'=0) -> 'None': - """ - Flushes memory buffer to disk - -Args: - - offset(Any):Position in buffer at which to flush - size(Any):Number of bytes to flush, 0 to flush remainder of buffer past the offset - -Returns: - - None - - """ - pass - - - def move(self,dest:'Any',src:'Any',count:'Any') -> 'None': - """ - Moves data from one place in buffer to another - -Args: - - dest(Any):Destination position in buffer - src(Any):Source position in buffer - count(Any):Number of bytes to move - -Returns: - - None - - """ - pass - - - def read(self,num_bytes:'Any') -> 'Any': - """ - Returns specified number of bytes from buffer, and advances current position - -Args: - - num_bytes(Any):Number of bytes to read - -Returns: - - Any - - """ - pass - - - def read_byte(self,) -> 'Any': - """ - Reads a single character from current pos - -Args: - - - -Returns: - - Any - - """ - pass - - - def read_line(self,) -> 'Any': - """ - Reads data from current pos up to next EOL. - -Args: - - - -Returns: - - Any - - """ - pass - - - def resize(self,MaximumSize:'Any',FileOffset:'Any'=0,NumberOfBytesToMap:'Any'=0) -> 'None': - """ - Resizes the file mapping and view. - -Args: - - MaximumSize(Any):New size for file mapping. Use a multiple of system page size (see win32api::GetSystemInfo) - FileOffset(Any):Offset into file mapping. Must be multiple of allocation granularity. - NumberOfBytesToMap(Any):New view size. Specify a multiple of system page size.CommentsIf MaximumSize is 0, only the mapped view will be affected.Accepts keyword args. - -Returns: - - None - - """ - pass - - - def seek(self,dist:'Any',how:'Any'=0) -> 'None': - """ - Changes current position - -Args: - - dist(Any):Distance to seek - how(Any):Pos from which to seekhowmeaning0Seek from start of buffer1Seek from current position2Seek backwards from end of buffer - -Returns: - - None - - """ - pass - - - def size(self,) -> 'Any': - """ - Returns size of current view - -Args: - - - -Returns: - - Any - - """ - pass - - - def tell(self,) -> 'Any': - """ - Returns current position in buffer - -Args: - - - -Returns: - - Any - - """ - pass - - - def write(self,data:'Any') -> 'None': - """ - Places data at current pos in buffer. - -Args: - - data(Any):Data to be written - -Returns: - - None - - """ - pass - - - def write_byte(self,char:'Any') -> 'None': - """ - Writes a single character of data - -Args: - - char(Any):Single byte to be placed in buffer - -Returns: - - None - - """ - pass - - -class RASDIALEXTENSIONS(object): - """An object that describes a Win32 RASDIALEXTENSIONS structure - -TRUE*/)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwfOptions(self)->'int': - """(fOptions may also be used)""" - pass - - - @property - def hwndParent(self)->'int': - """""" - pass - - - @property - def reserved(self)->'int': - """""" - pass - - - @property - def reserved1(self)->'int': - """""" - pass - - - @property - def RasEapInfo(self)->'Any': - """""" - pass - - -class RASDIALPARAMS(object): - """A tuple that describes a Win32 RASDIALPARAMS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SC_ACTION(object): - """Tuple of 2 ints (Type,Delay) used to represent an SC_ACTION structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Type(self)->'Any': - """One of SC_ACTION_NONE, SC_ACTION_REBOOT, SC_ACTION_RESTART, SC_ACTION_RUN_COMMAND""" - pass - - - @property - def Delay(self)->'Any': - """Time delay before specified action is taken (in milliseconds)""" - pass - - -class SERVICE_FAILURE_ACTIONS(object): - """A dictionary representing a SERVICE_FAILURE_ACTIONS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ResetPeriod(self)->'Any': - """Indicates how many seconds to wait to reset the failure count, can be INFINITE""" - pass - - - @property - def RebootMsg(self)->'Union[Any, str]': - """Message displayed when reboot action is taken""" - pass - - - @property - def Command(self)->'Union[Any, str]': - """Command line to execute for SC_ACTION_RUN_COMMAND""" - pass - - - @property - def Actions(self)->'Any': - """A tuple of SC_ACTION tuples""" - pass - - -class SERVICE_STATUS(object): - """A Win32 service status object is represented by a tuple:""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class TRACKMOUSEEVENT(object): - """A tuple of (dwFlags, hwndTrack, dwHoverTime)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class ULARGE_INTEGER(object): - """A Python object used wherever a COM ULARGE_INTEGER is used.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class WIN32_FIND_DATA(object): - """A tuple representing a WIN32_FIND_DATA structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class com_error(object): - """An exception raised when a COM exception occurs.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class connection(object): - """An object representing an ODBC connection""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def setautocommit(self,c:'Any') -> 'None': - """ - Sets the autocommit mode. - -Args: - - c(Any):The boolean autocommit mode. - -Returns: - - None - - """ - pass - - - def commit(self,) -> 'None': - """ - Commits a transaction. - -Args: - - - -Returns: - - None - - """ - pass - - - def rollback(self,) -> 'None': - """ - Rollsback a transaction. - -Args: - - - -Returns: - - None - - """ - pass - - - def cursor(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def close(self,) -> 'None': - """ - Closes the connection. - -Args: - - - -Returns: - - None - - """ - pass - - -class cursor(object): - """An object representing an ODBC cursor.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def close(self,) -> 'None': - """ - Closes the cursor - -Args: - - - -Returns: - - None - - """ - pass - - - def execute(self,sql:'str',arg:'Any') -> 'Any': - """ - Execute some SQL - -Args: - - sql(str):The SQL to execute - arg(Any):Input variables. - -Returns: - - Any - - """ - pass - - - def fetchone(self,) -> 'Any': - """ - Fetch one row of data - -Args: - - - -Returns: - - Any - - """ - pass - - - def fetchmany(self,) -> 'List[Any]': - """ - Fetch many rows of data - -Args: - - - -Returns: - - List[Any] - - """ - pass - - - def fetchall(self,) -> 'List[Any]': - """ - Fetch all rows of data - -Args: - - - -Returns: - - List[Any] - - """ - pass - - - def setinputsizes(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def setoutputsize(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - -class error(object): - """An exception raised when a win32 error occurs""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class COMPONENT(object): - """A dictionary containing data to fill a COMPPOS struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ID(self)->'Any': - """Id of component, ignored when adding a new component""" - pass - - - @property - def ComponentType(self)->'Any': - """One of shellcon.COMP_TYPE_* values""" - pass - - - @property - def Checked(self)->'Any': - """True indicates item is currently displayed""" - pass - - - @property - def fDirty(self)->'Any': - """Indicates if unsaved changes exist""" - pass - - - @property - def NoScroll(self)->'Any': - """True disables scrolling""" - pass - - - @property - def Pos(self)->'Any': - """COMPPOS dictionary determining window size and placement""" - pass - - - @property - def FriendlyName(self)->'Any': - """String of at most MAX_PATH-1 characters, truncated if longer""" - pass - - - @property - def Source(self)->'Any': - """String of at most INTERNET_MAX_URL_LENGTH-1 characters""" - pass - - - @property - def SubscribedURL(self)->'Any': - """String of at most INTERNET_MAX_URL_LENGTH-1 characters""" - pass - - - @property - def CurItemState(self)->'Any': - """One of shellcon.IS_* flags""" - pass - - - @property - def Original(self)->'Any': - """COMPSTATEINFO dictionary""" - pass - - - @property - def Restored(self)->'Any': - """COMPSTATEINFO dictionary""" - pass - - - @property - def Size(self)->'Any': - """Size of structure, ignored on input""" - pass - - -class COMPONENTSOPT(object): - """A dictionary containing data to fill a COMPONENTSOPT struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def EnableComponents(self)->'Any': - """True if components are enabled""" - pass - - - @property - def ActiveDesktop(self)->'Any': - """True if Active Desktop is enabled""" - pass - - - @property - def Size(self)->'Any': - """Size of structure, ignored on input""" - pass - - -class COMPPOS(object): - """A dictionary containing data to fill a COMPPOS struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Left(self)->'Any': - """""" - pass - - - @property - def Top(self)->'Any': - """""" - pass - - - @property - def Width(self)->'Any': - """""" - pass - - - @property - def Height(self)->'Any': - """""" - pass - - - @property - def Index(self)->'Any': - """""" - pass - - - @property - def CanResize(self)->'Any': - """""" - pass - - - @property - def CanResizeX(self)->'Any': - """""" - pass - - - @property - def CanResizeY(self)->'Any': - """""" - pass - - - @property - def PreferredLeftPercent(self)->'Any': - """""" - pass - - - @property - def PreferredTopPercent(self)->'Any': - """""" - pass - - - @property - def Size(self)->'Any': - """Size of structure, ignored on input""" - pass - - -class COMPSTATEINFO(object): - """A dictionary containing data to fill a COMPSTATEINFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Left(self)->'Any': - """Specified as screen coordinates""" - pass - - - @property - def Top(self)->'Any': - """Specified as screen coordinates""" - pass - - - @property - def Width(self)->'Any': - """Measured in pixels""" - pass - - - @property - def Height(self)->'Any': - """Measured in pixels""" - pass - - - @property - def dwItemState(self)->'Any': - """One of IS_NORMAL, IS_FULLSCREEN IS_SPLIT""" - pass - - - @property - def Size(self)->'Any': - """Size of structure, ignored on input""" - pass - - -class DEFCONTENTMENU(object): - """A tuple representing a DEFCONTEXTMENU structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class ELEMDESC(object): - """An ELEMDESC is respresented as a tuple of""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class EXP_DARWIN_LINK(object): - """Dictionary containing information for a EXP_DARWIN_LINK struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Signature(self)->'Any': - """The type of data block, one of shellcon.*_SIG values""" - pass - - - @property - def DarwinID(self)->'Any': - """The Windows Installer id for the link""" - pass - - - @property - def wDarwinID(self)->'Any': - """The installer id as Unicode""" - pass - - - @property - def Size(self)->'Any': - """Size of structure, ignored on input""" - pass - - -class EXP_SPECIAL_FOLDER(object): - """Dictionary containing information for a EXP_SPECIAL_FOLDER struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Signature(self)->'Any': - """The type of data block, one of shellcon.*_SIG values""" - pass - - - @property - def idSpecialFolder(self)->'Any': - """The special folder id of the target (shellcon.CSIDL_*)""" - pass - - - @property - def Offset(self)->'Any': - """Offset into the link's PIDL""" - pass - - - @property - def Size(self)->'Any': - """Size of structure, ignored on input""" - pass - - -class EXP_SZ_LINK(object): - """Dictionary containing information for an EXP_SZ_LINK or EXP_SZ_ICON struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Signature(self)->'Any': - """The type of data block, one of shellcon.*_SIG values""" - pass - - - @property - def Target(self)->'Any': - """The link's target or icon location""" - pass - - - @property - def wTarget(self)->'Any': - """The target in Unicode form""" - pass - - - @property - def Size(self)->'Any': - """Size of structure, ignored on input""" - pass - - -class FUNCDESC(object): - """A FUNCDESC object represents a COM TYPEATTR structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def memid(self)->'int': - """""" - pass - - - @property - def scodeArray(self)->'Tuple[Any, ...]': - """""" - pass - - - @property - def args(self)->'Tuple[Any, ...]': - """""" - pass - - - @property - def funckind(self)->'Any': - """""" - pass - - - @property - def invkind(self)->'Any': - """""" - pass - - - @property - def callconv(self)->'Any': - """""" - pass - - - @property - def cParamsOpt(self)->'Any': - """""" - pass - - - @property - def oVft(self)->'Any': - """""" - pass - - - @property - def rettype(self)->'Any': - """""" - pass - - - @property - def wFuncFlags(self)->'Any': - """""" - pass - - -class IDLDESC(object): - """An IDLDESC is respresented as""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class MAPIINIT_0(object): - """A MAPIINIT_0 is represented as a tuple of:""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class NT_CONSOLE_PROPS(object): - """Dictionary containing information for a NT_CONSOLE_PROPS struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Signature(self)->'Any': - """The type of data block, one of shellcon.*_SIG values""" - pass - - - @property - def FillAttribute(self)->'Any': - """Character attributes for fill operations""" - pass - - - @property - def PopupFillAttribute(self)->'Any': - """Fill attributes for popups""" - pass - - - @property - def ScreenBufferSize(self)->'Tuple[Any, Any]': - """Size of console screen buffer, in character cells""" - pass - - - @property - def WindowSize(self)->'Tuple[Any, Any]': - """Size of console window in character cells""" - pass - - - @property - def WindowOrigin(self)->'Tuple[Any, Any]': - """Window position, in screen coordinates""" - pass - - - @property - def nFont(self)->'Any': - """Number of font to be displayed. See win32console::GetNumberOfConsoleFonts""" - pass - - - @property - def InputBufferSize(self)->'Any': - """Size of console's input buffer""" - pass - - - @property - def FontSize(self)->'Tuple[Any, Any]': - """Size of font""" - pass - - - @property - def FontFamily(self)->'Any': - """Font family""" - pass - - - @property - def FontWeight(self)->'Any': - """Controls thickness of displayed font""" - pass - - - @property - def FaceName(self)->'Any': - """Name of font face, 31 characters at most""" - pass - - - @property - def CursorSize(self)->'Any': - """Relative size of cursor, expressed as percent of character size""" - pass - - - @property - def FullScreen(self)->'Any': - """Causes console to run in full screen mode""" - pass - - - @property - def QuickEdit(self)->'Any': - """""" - pass - - - @property - def InsertMode(self)->'Any': - """""" - pass - - - @property - def AutoPosition(self)->'Any': - """Lets system determine window placement""" - pass - - - @property - def HistoryBufferSize(self)->'Any': - """Size of command line history buffer""" - pass - - - @property - def NumberOfHistoryBuffers(self)->'Any': - """""" - pass - - - @property - def HistoryNoDup(self)->'Any': - """""" - pass - - - @property - def ColorTable(self)->'Any': - """Tuple of 16 ints containing console's color attributes""" - pass - - - @property - def Size(self)->'Any': - """Size of structure, ignored on input""" - pass - - -class NT_FE_CONSOLE_PROPS(object): - """Dictionary containing information for a NT_FE_CONSOLE_PROPS struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Signature(self)->'Any': - """The type of data block, one of shellcon.*_SIG values""" - pass - - - @property - def CodePage(self)->'Any': - """The codepage to be used for console text""" - pass - - - @property - def Size(self)->'Any': - """Size of structure, ignored on input""" - pass - - -class PROPSPEC(object): - """Identifies a property. Can be either an int property id, or a str/unicode property name.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyADSVALUE(object): - """A tuple:""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyADS_ATTR_INFO(object): - """Represents a ADS_ATTR_INFO structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def AttrName(self)->'Any': - """The name""" - pass - - - @property - def ControlCode(self)->'int': - """""" - pass - - - @property - def ADsType(self)->'int': - """""" - pass - - - @property - def Values(self)->'List[Any]': - """""" - pass - - -class PyADS_OBJECT_INFO(object): - """Represents a ADS_OBJECT_INFO structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def RDN(self)->'Any': - """The name""" - pass - - - @property - def ObjectDN(self)->'Any': - """""" - pass - - - @property - def ParentDN(self)->'Any': - """""" - pass - - - @property - def ClassName(self)->'Any': - """""" - pass - - -class PyADS_SEARCHPREF_INFO(object): - """A tuple of:""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyBIND_OPTS(object): - """Dictionary representation of a BIND_OPTS struct - -May eventually be extended to include BIND_OPTS2 members""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Flags(self)->'Any': - """Value from BIND_FLAGS enum: BIND_MAYBOTHERUSER, BIND_JUSTTESTEXISTENCE or 0""" - pass - - - @property - def Mode(self)->'Any': - """Combination of storagecon.STGM_* values""" - pass - - - @property - def TickCountDeadline(self)->'Any': - """Operation timeout in milliseconds""" - pass - - - @property - def cbStruct(self)->'Any': - """Size of struct, ignored on input""" - pass - - -class PyCMINVOKECOMMANDINFO(object): - """A tuple of parameters to be converted to a CMINVOKECOMMANDINFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyDSBCAPS(object): - """A Python object, representing a DSBCAPS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwFlags(self)->'int': - """Flags that specify buffer-object capabilities.FlagDescriptionDSBCAPS_PRIMARYBUFFERIndicates that the buffer is a primary sound buffer. If this value is not specified, a secondary sound buffer will be created.DSBCAPS_STATICIndicates that the buffer will be used for static sound data. Typically, these buffers are loaded once and played many times. These buffers are candidates for hardware memory.DSBCAPS_LOCHARDWAREThe buffer is in hardware memory and uses hardware mixing.DSBCAPS_LOCSOFTWAREThe buffer is in software memory and uses software mixing.DSBCAPS_CTRL3DThe buffer is either a primary buffer or a secondary buffer that uses 3-D control. To create a primary buffer, the dwFlags member of the DSBUFFERDESC structure should include the DSBCAPS_PRIMARYBUFFER flag.DSBCAPS_CTRLFREQUENCYThe buffer must have frequency control capability.DSBCAPS_CTRLPANThe buffer must have pan control capability.DSBCAPS_CTRLVOLUMEThe buffer must have volume control capability.DSBCAPS_CTRLPOSITIONNOTIFYThe buffer must have control position notify capability.DSBCAPS_STICKYFOCUSChanges the focus behavior of the sound buffer. This flag can be specified in an IDirectSound::CreateSoundBuffer call. With this flag set, an application using DirectSound can continue to play its sticky focus buffers if the user switches to another application not using DirectSound. In this situation, the application's normal buffers are muted, but the sticky focus buffers are still audible. This is useful for nongame applications, such as movie playback (DirectShow™), when the user wants to hear the soundtrack while typing in Microsoft Word or Microsoft® Excel, for example. However, if the user switches to another DirectSound application, all sound buffers, both normal and sticky focus, in the previous application are muted.DSBCAPS_GLOBALFOCUSThe buffer is a global sound buffer. With this flag set, an application using DirectSound can continue to play its buffers if the user switches focus to another application, even if the new application uses DirectSound. The one exception is if you switch focus to a DirectSound application that uses the DSSCL_EXCLUSIVE or DSSCL_WRITEPRIMARY flag for its cooperative level. In this case, the global sounds from other applications will not be audible.DSBCAPS_GETCURRENTPOSITION2Indicates that IDirectSoundBuffer::GetCurrentPosition should use the new behavior of the play cursor. In DirectSound in DirectX 1, the play cursor was significantly ahead of the actual playing sound on emulated sound cards; it was directly behind the write cursor. Now, if the DSBCAPS_GETCURRENTPOSITION2 flag is specified, the application can get a more accurate play position. If this flag is not specified, the old behavior is preserved for compatibility. Note that this flag affects only emulated sound cards; if a DirectSound driver is present, the play cursor is accurate for DirectSound in all versions of DirectX.DSBCAPS_MUTE3DATMAXDISTANCEThe sound is reduced to silence at the maximum distance. The buffer will stop playing when the maximum distance is exceeded, so that processor time is not wasted.""" - pass - - - @property - def nChannels(self)->'int': - """Size of the buffer, in bytes.""" - pass - - - @property - def dwUnlockTransferRate(self)->'int': - """Specifies the rate, in kilobytes per second, at which data is transferred to the buffer memory when IDirectSoundBuffer::Unlock is called. High-performance applications can use this value to determine the time required for IDirectSoundBuffer::Unlock to execute. For software buffers located in system memory, the rate will be very high because no processing is required. For hardware buffers, the rate might be slower because the buffer might have to be downloaded to the sound card, which might have a limited transfer rate.""" - pass - - - @property - def nAvgBytesPerSec(self)->'int': - """Specifies whether the returned handle is inherited when a new process is created. If this member is TRUE, the new process inherits the handle. Sentinel""" - pass - - -class PyDSBUFFERDESC(object): - """A Python object, representing a DSBUFFERDESC structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwFlags(self)->'int': - """Identifies the capabilities to include when creating a new DirectSoundBuffer object. Specify one or more of the following:FlagDescriptionDSBCAPS_PRIMARYBUFFERIndicates that the buffer is a primary sound buffer. If this value is not specified, a secondary sound buffer will be created.DSBCAPS_STATICIndicates that the buffer will be used for static sound data. Typically, these buffers are loaded once and played many times. These buffers are candidates for hardware memory.DSBCAPS_LOCHARDWAREThe buffer is in hardware memory and uses hardware mixing.DSBCAPS_LOCSOFTWAREThe buffer is in software memory and uses software mixing.DSBCAPS_CTRL3DThe buffer is either a primary buffer or a secondary buffer that uses 3-D control. To create a primary buffer, the dwFlags member of the DSBUFFERDESC structure should include the DSBCAPS_PRIMARYBUFFER flag.DSBCAPS_CTRLFREQUENCYThe buffer must have frequency control capability.DSBCAPS_CTRLPANThe buffer must have pan control capability.DSBCAPS_CTRLVOLUMEThe buffer must have volume control capability.DSBCAPS_CTRLPOSITIONNOTIFYThe buffer must have control position notify capability.DSBCAPS_STICKYFOCUSChanges the focus behavior of the sound buffer. This flag can be specified in an IDirectSound::CreateSoundBuffer call. With this flag set, an application using DirectSound can continue to play its sticky focus buffers if the user switches to another application not using DirectSound. In this situation, the application's normal buffers are muted, but the sticky focus buffers are still audible. This is useful for nongame applications, such as movie playback (DirectShow™), when the user wants to hear the soundtrack while typing in Microsoft Word or Microsoft® Excel, for example. However, if the user switches to another DirectSound application, all sound buffers, both normal and sticky focus, in the previous application are muted.DSBCAPS_GLOBALFOCUSThe buffer is a global sound buffer. With this flag set, an application using DirectSound can continue to play its buffers if the user switches focus to another application, even if the new application uses DirectSound. The one exception is if you switch focus to a DirectSound application that uses the DSSCL_EXCLUSIVE or DSSCL_WRITEPRIMARY flag for its cooperative level. In this case, the global sounds from other applications will not be audible.DSBCAPS_GETCURRENTPOSITION2Indicates that IDirectSoundBuffer::GetCurrentPosition should use the new behavior of the play cursor. In DirectSound in DirectX 1, the play cursor was significantly ahead of the actual playing sound on emulated sound cards; it was directly behind the write cursor. Now, if the DSBCAPS_GETCURRENTPOSITION2 flag is specified, the application can get a more accurate play position. If this flag is not specified, the old behavior is preserved for compatibility. Note that this flag affects only emulated sound cards; if a DirectSound driver is present, the play cursor is accurate for DirectSound in all versions of DirectX.DSBCAPS_MUTE3DATMAXDISTANCEThe sound is reduced to silence at the maximum distance. The buffer will stop playing when the maximum distance is exceeded, so that processor time is not wasted.""" - pass - - - @property - def dwBufferBytes(self)->'int': - """Size of the new buffer, in bytes. This value must be 0 when creating primary buffers. For secondary buffers, the minimum and maximum sizes allowed are specified by DSBSIZE_MIN and DSBSIZE_MAX.""" - pass - - - @property - def lpwfxFormat(self)->'Any': - """Structure specifying the waveform format for the buffer. This value must be None for primary buffers. The application can use IDirectSoundBuffer::SetFormat to set the format of the primary buffer. Sentinel""" - pass - - -class PyDSCAPS(object): - """A Python object, representing a DSCAPS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwFlags(self)->'int': - """Specifies device capabilities. Can be one or more of the following:FlagDescriptionDSCAPS_PRIMARYMONOThe device supports monophonic primary buffers.DSCAPS_PRIMARYSTEREOThe device supports stereo primary buffers.DSCAPS_PRIMARY8BITThe device supports hardware-mixed secondary buffers with 8-bit samples.DSCAPS_PRIMARY16BITThe device supports primary sound buffers with 16-bit samples.DSCAPS_CONTINUOUSRATEThe device supports all sample rates between the dwMinSecondarySampleRate and dwMaxSecondarySampleRate member values. Typically, this means that the actual output rate will be within +/- 10 hertz (Hz) of the requested frequency.DSCAPS_EMULDRIVERThe device does not have a DirectSound driver installed, so it is being emulated through the waveform-audio functions. Performance degradation should be expected.DSCAPS_CERTIFIEDThis driver has been tested and certified by Microsoft.DSCAPS_SECONDARYMONOThe device supports hardware-mixed monophonic secondary buffers.DSCAPS_SECONDARYSTEREOThe device supports hardware-mixed stereo secondary buffers.DSCAPS_SECONDARY8BITThe device supports hardware-mixed secondary buffers with 8-bit samples.DSCAPS_SECONDARY16BITThe device supports hardware-mixed secondary sound buffers with 16-bit samples.""" - pass - - - @property - def dwMinSecondarySampleRate(self)->'int': - """Minimum sample rate supported by this device's hardware secondary sound buffers.""" - pass - - - @property - def dwMaxSecondarySampleRate(self)->'int': - """Maximum sample rate supported by this device's hardware secondary sound buffers.""" - pass - - - @property - def dwPrimaryBuffers(self)->'int': - """Number of primary buffers supported. This value will always be 1.""" - pass - - - @property - def dwMaxHwMixingAllBuffers(self)->'int': - """Specifies the total number of buffers that can be mixed in hardware. This member can be less than the sum of dwMaxHwMixingStaticBuffers and dwMaxHwMixingStreamingBuffers. Resource tradeoffs frequently occur.""" - pass - - - @property - def dwMaxHwMixingStaticBuffers(self)->'int': - """Specifies the maximum number of static sound buffers.""" - pass - - - @property - def dwMaxHwMixingStreamingBuffers(self)->'int': - """Specifies the maximum number of streaming sound buffers.""" - pass - - - @property - def dwFreeHwMixingAllBuffers(self)->'int': - """Description of the free hardware mixing capabilities of the device. An application can use this value to determine whether hardware resources are available for allocation to a secondary sound buffer. Also, by comparing these values to the members that specify maximum mixing capabilities, the resources that are already allocated can be determined.""" - pass - - - @property - def dwFreeHwMixingStaticBuffers(self)->'int': - """Description of the free hardware mixing capabilities of the device. An application can use this value to determine whether hardware resources are available for allocation to a secondary sound buffer. Also, by comparing these values to the members that specify maximum mixing capabilities, the resources that are already allocated can be determined.""" - pass - - - @property - def dwFreeHwMixingStreamingBuffers(self)->'int': - """Description of the free hardware mixing capabilities of the device. An application can use this value to determine whether hardware resources are available for allocation to a secondary sound buffer. Also, by comparing these values to the members that specify maximum mixing capabilities, the resources that are already allocated can be determined.""" - pass - - - @property - def dwMaxHw3DAllBuffers(self)->'int': - """Description of the hardware 3-D positional capabilities of the device.""" - pass - - - @property - def dwMaxHw3DStaticBuffers(self)->'int': - """Description of the hardware 3-D positional capabilities of the device.""" - pass - - - @property - def dwMaxHw3DStreamingBuffers(self)->'int': - """Description of the hardware 3-D positional capabilities of the device.""" - pass - - - @property - def dwFreeHw3DAllBuffers(self)->'int': - """Description of the free, or unallocated, hardware 3-D positional capabilities of the device.""" - pass - - - @property - def dwFreeHw3DStaticBuffers(self)->'int': - """Description of the free, or unallocated, hardware 3-D positional capabilities of the device.""" - pass - - - @property - def dwFreeHw3DStreamingBuffers(self)->'int': - """Description of the free, or unallocated, hardware 3-D positional capabilities of the device.""" - pass - - - @property - def dwTotalHwMemBytes(self)->'int': - """Size, in bytes, of the amount of memory on the sound card that stores static sound buffers.""" - pass - - - @property - def dwFreeHwMemBytes(self)->'int': - """Size, in bytes, of the free memory on the sound card.""" - pass - - - @property - def dwMaxContigFreeHwMemBytes(self)->'int': - """Size, in bytes, of the largest contiguous block of free memory on the sound card.""" - pass - - - @property - def dwUnlockTransferRateHwBuffers(self)->'int': - """Description of the rate, in kilobytes per second, at which data can be transferred to hardware static sound buffers. This and the number of bytes transferred determines the duration of a call to the IDirectSoundBuffer::Update method.""" - pass - - - @property - def dwPlayCpuOverheadSwBuffers(self)->'int': - """Description of the processing overhead, as a percentage of the central processing unit, needed to mix software buffers (those located in main system memory). This varies according to the bus type, the processor type, and the clock speed. The unlock transfer rate for software buffers is 0 because the data need not be transferred anywhere. Similarly, the play processing overhead for hardware buffers is 0 because the mixing is done by the sound device.""" - pass - - -class PyDSCBCAPS(object): - """A Python object, representing a DSCBCAPS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwFlags(self)->'int': - """Specifies device capabilities. Can be 0 or DSCBCAPS_EMULDRIVER (indicates that no DirectSound Device is available and standard wave audio functions are being used).""" - pass - - - @property - def dwBufferBytes(self)->'int': - """The size, in bytes, of the capture buffer.""" - pass - - -class PyDSCBUFFERDESC(object): - """A Python object, representing a DSCBUFFERDESC structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwFlags(self)->'int': - """Identifies the capabilities to include when creating a new DirectSoundBuffer object. Can be zero or the following flag:FlagDescriptionDSCBCAPS_WAVEMAPPEDThe Win32 wave mapper will be used for formats not supported by the device.""" - pass - - - @property - def dwBufferBytes(self)->'int': - """Size of the new buffer, in bytes. This value must be 0 when creating primary buffers. For secondary buffers, the minimum and maximum sizes allowed are specified by DSBSIZE_MIN and DSBSIZE_MAX.""" - pass - - - @property - def lpwfxFormat(self)->'Any': - """Structure specifying the waveform format for the buffer. This value must be None for primary buffers. The application can use IDirectSoundBuffer::SetFormat to set the format of the primary buffer. Sentinel""" - pass - - -class PyDSCCAPS(object): - """A Python object, representing a DSCCAPS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwFlags(self)->'int': - """Specifies device capabilities. Can be zero or the following flag:FlagDescriptionDSCCAPS_EMULDRIVERIndicates that no DirectSound Device is available and standard wave audio functions are being used.""" - pass - - - @property - def dwFormats(self)->'int': - """Bitset of supported WAVE_FORMAT formats.""" - pass - - - @property - def dwChannels(self)->'int': - """Number of channels supported by the device.""" - pass - - -class PyDSOP_FILTER_FLAGS(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def uplevel(self)->'Any': - """""" - pass - - - @property - def downlevel(self)->'Any': - """""" - pass - - -class PyDSOP_SCOPE_INIT_INFO(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def type(self)->'Any': - """""" - pass - - - @property - def scope(self)->'Any': - """""" - pass - - - @property - def hr(self)->'Any': - """""" - pass - - - @property - def dcName(self)->'str': - """""" - pass - - - @property - def filterFlags(self)->'Any': - """""" - pass - - -class PyDSOP_SCOPE_INIT_INFOs(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyDSOP_UPLEVEL_FILTER_FLAGS(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def bothModes(self)->'Any': - """""" - pass - - - @property - def mixedModeOnly(self)->'Any': - """""" - pass - - - @property - def nativeModeOnly(self)->'Any': - """""" - pass - - -class PyFORMATETC(object): - """Tuple representing a FORMATETC struct describing an OLE data format""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyGFileOperationProgressSink(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def StartOperations(self,) -> 'None': - """ - Called as operation begins, before any modifications are done - -Args: - - - -Returns: - - None - - """ - pass - - - def FinishOperations(self,Result:'Any') -> 'None': - """ - Called after all actions have been performed - -Args: - - Result(Any):HRESULT of last operation performed - -Returns: - - None - - """ - pass - - - def PreRenameItem(self,Flags:'Any',Item:'Any',NewName:'Any') -> 'None': - """ - Called before each file rename - -Args: - - Flags(Any):Flags specifying copy behaviour, combination of shellcon.TSF_* flags - Item(Any):Shell interface of the copied item - NewName(Any):New display name of the item - -Returns: - - None - - """ - pass - - - def PostRenameItem(self,Flags:'Any',Item:'Any',NewName:'Any',hrRename:'Any',NewlyCreated:'Any') -> 'None': - """ - Called after each file rename - -Args: - - Flags(Any):Flags specifying rename behaviour, combination of shellcon.TSF_* flags - Item(Any):Shell interface of item before rename - NewName(Any):The new name of the item, may be mangled to resolve filename conflicts - hrRename(Any):HRESULT of the rename operation - NewlyCreated(Any):Shell interface of the item after rename - -Returns: - - None - - """ - pass - - - def PreMoveItem(self,Flags:'Any',Item:'Any',DestinationFolder:'Any',NewName:'Any') -> 'None': - """ - Called before each move operation - -Args: - - Flags(Any):Flags specifying move behaviour, combination of shellcon.TSF_* flags - Item(Any):The item to be moved - DestinationFolder(Any):The folder into which it will be moved - NewName(Any):Name of moved item, may be None if not to be changed - -Returns: - - None - - """ - pass - - - def PostMoveItem(self,Flags:'Any',Item:'Any',DestinationFolder:'Any',NewName:'Any',hrMove:'Any',NewlyCreated:'Any') -> 'None': - """ - Called after each move operation - -Args: - - Flags(Any):Flags specifying move behaviour, combination of shellcon.TSF_* flags - Item(Any):Interface of the item before it was moved - DestinationFolder(Any):The folder into which it was moved - NewName(Any):Name of item in its new location, may be mangled in case of conflict - hrMove(Any):HRESULT of the move operation - NewlyCreated(Any):Shell interface of the item in its new location - -Returns: - - None - - """ - pass - - - def PreCopyItem(self,Flags:'Any',Item:'Any',DestinationFolder:'Any',NewName:'Any') -> 'None': - """ - Called before each copy operation - -Args: - - Flags(Any):Flags specifying copy behaviour, combination of shellcon.TSF_* flags - Item(Any):The item to be copied - DestinationFolder(Any):Folder into which it will be copied - NewName(Any):Name to be given to the copy, will be None if keeping original name - -Returns: - - None - - """ - pass - - - def PostCopyItem(self,Flags:'Any',Item:'Any',DestinationFolder:'Any',NewName:'Any',hrCopy:'Any',NewlyCreated:'Any') -> 'None': - """ - Called after each copy operation - -Args: - - Flags(Any):Flags specifying copy behaviour, combination of shellcon.TSF_* flags - Item(Any):The original item - DestinationFolder(Any):Folder into which it was copied - NewName(Any):Name of item after copy, may be mangled in case of name conflict - hrCopy(Any):HRESULT of the copy operation - NewlyCreated(Any):Shell interface of the copy - -Returns: - - None - - """ - pass - - - def PreDeleteItem(self,Flags:'Any',Item:'Any') -> 'None': - """ - Called before each delete operation - -Args: - - Flags(Any):Flags specifying delete behaviour, combination of shellcon.TSF_* flags - Item(Any):Item to be deleted - -Returns: - - None - - """ - pass - - - def PostDeleteItem(self,Flags:'Any',Item:'Any',hrDelete:'Any',NewlyCreated:'Any') -> 'None': - """ - Called after each delete operation - -Args: - - Flags(Any):Flags specifying delete behaviour, combination of shellcon.TSF_* flags - Item(Any):Item that was deleted - hrDelete(Any):HRESULT of the delete operation - NewlyCreated(Any):Item in the recycle bin, or None if deleted without recycling - -Returns: - - None - - """ - pass - - - def PreNewItem(self,Flags:'Any',DestinationFolder:'Any',NewName:'Any') -> 'None': - """ - Called before each new file is created - -Args: - - Flags(Any):Flags specifying creation behaviour, combination of shellcon.TSF_* flags - DestinationFolder(Any):Folder where item will be created - NewName(Any):Name of item to be created - -Returns: - - None - - """ - pass - - - def PostNewItem(self,Flags:'Any',DestinationFolder:'Any',NewName:'Any',TemplateName:'Any',FileAttributes:'Any',hrNew:'Any',NewItem:'Any') -> 'None': - """ - Called after each new file is created - -Args: - - Flags(Any):Flags specifying creation behaviour, combination of shellcon.TSF_* flags - DestinationFolder(Any):Folder in which item was created - NewName(Any):Name of created item, may be mangled if file name conflicts occurred - TemplateName(Any):Template file used to initialize new item - FileAttributes(Any):File attributes of new item - hrNew(Any):HRESULT of the create operation - NewItem(Any):Shell interface of created item - -Returns: - - None - - """ - pass - - - def UpdateProgress(self,WorkTotal:'Any',WorkSoFar:'Any') -> 'None': - """ - Gives an estimate of total work completed - -Args: - - WorkTotal(Any):Undimensioned number representing total amount of work - WorkSoFar(Any):Undimensioned number representing amount already completed - -Returns: - - None - - """ - pass - - - def ResetTimer(self,) -> 'None': - """ - Not implemented, according to MSDN - -Args: - - - -Returns: - - None - - """ - pass - - - def PauseTimer(self,) -> 'None': - """ - Not implemented, according to MSDN - -Args: - - - -Returns: - - None - - """ - pass - - - def ResumeTimer(self,) -> 'None': - """ - Not implemented, according to MSDN - -Args: - - - -Returns: - - None - - """ - pass - - -class PyGSecurityInformation(object): - """Gateway wrapper for the implement-only ISecurityInformation interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetObjectInformation(self,) -> 'Any': - """ - Returns information identifying the object - -whose security is to be editted, and which pages are to appear in the property sheet - -Args: - - - -Returns: - - Any:PyGSecurityInformation.GetObjectInformation -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, - -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:'Any',Default:'Any') -> 'PySECURITY_DESCRIPTOR': - """ - Retrieves the object's current security - -settings - -Args: - - RequestedInformation(Any):Combination of SECURITY_INFORMATION flags indicating which components of the object's security descriptor you should return - Default(Any):If true, return a default security descriptor rather than current security. (invoked when 'Reset' button is clicked) - -Returns: - - PySECURITY_DESCRIPTOR - - """ - pass - - - def SetSecurity(self,SecurityInformation:'Any',SecurityDescriptor:'PySECURITY_DESCRIPTOR') -> 'None': - """ - Applies the modified security to the object - -Args: - - SecurityInformation(Any):SECURITY_INFORMATION flags specifying which types of security information are to be applied - SecurityDescriptor(PySECURITY_DESCRIPTOR):The security information to be applied to the objectReturn ValueAny returned value is ignored - -Returns: - - None:The security information to be applied to the objectReturn ValueAny returned value is ignored - - - """ - pass - - - def GetAccessRights(self,ObjectType:'PyIID',Flags:'Any') -> 'Tuple[Any, Any]': - """ - Retrieves permission that can be set - -Args: - - ObjectType(PyIID):GUID representing type of object, may be None - Flags(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, and a zero-based index indicating which of them is the default - -Returns: - - Tuple[Any, 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, - -and a zero-based index indicating which of them is the default - - - """ - pass - - - def MapGeneric(self,ObjectType:'PyIID',AceFlags:'Any',Mask:'Any') -> 'Any': - """ - Translates generic access rights to specific equivalents - -Args: - - ObjectType(PyIID):Type of object that permissions apply to, None or GUID_NULL indicates object itself - AceFlags(Any):Flags from the ACE that contains the permissions - Mask(Any):Bitmask containing access rightsCommentsSee win32security::MapGenericMaskReturn ValueThis method should return the input bitmask will all generic rights mapped to specific rights - -Returns: - - Any:Bitmask containing access rightsComments - -See win32security::MapGenericMask -Return ValueThis method should return the input bitmask will all generic rights mapped to specific rights - - - """ - pass - - - def GetInheritTypes(self,) -> 'Tuple[Any, ...]': - """ - Requests types of inheritance that your - -implementation supports - -Args: - - - -Returns: - - Tuple[Any, ...]:PyGSecurityInformation.GetInheritTypes - -(SI_INHERIT_TYPE,...) = GetInheritTypes()Requests types of inheritance that your - -implementation supports -Return ValueReturns a sequence of SI_INHERIT_TYPE tuples - - - """ - pass - - - def PropertySheetPageCallback(self,hwnd:'Any',Msg:'Any',Page:'Any') -> 'None': - """ - Called by each page as it is created and destroyed - -Args: - - hwnd(Any):Handle to the window for the page - Msg(Any):Flag indicating type of event, one of PSPCB_CREATE,PSPCB_RELEASE,PSPCB_SI_INITDIALOG - Page(Any):SI_PAGE_TYPE value indicating which page is making the call (ntsecuritycon.SI_PAGE_*)Return ValueAny returned value will be ignored - -Returns: - - None:SI_PAGE_TYPE value indicating which page is making the call (ntsecuritycon.SI_PAGE_*)Return ValueAny returned value will be ignored - - - """ - pass - - -class PyIADesktopP2(object): - """An interface to the ActiveDesktop""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def UpdateAllDesktopSubscriptions(self,) -> 'None': - """ - Updates webpage subscriptions on the desktop - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIADs(object): - """An object representing the IADs interface. - -In most cases you can achieve the same result via IDispatch - however, this - -interface allows you get get and set properties without the IDispatch - -overhead.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ADsPath(self)->'str': - """""" - pass - - - @property - def AdsPath(self)->'str': - """Synonym for ADsPath""" - pass - - - @property - def Class(self)->'str': - """""" - pass - - - @property - def GUID(self)->'str': - """Like the IADs method, this returns a string rather than a GUID object.""" - pass - - - @property - def Name(self)->'str': - """""" - pass - - - @property - def Parent(self)->'str': - """""" - pass - - - @property - def Schema(self)->'str': - """""" - pass - - - def GetInfo(self,) -> 'None': - """ - Description of GetInfo. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetInfo(self,) -> 'None': - """ - Description of SetInfo. - -Args: - - - -Returns: - - None - - """ - pass - - - def Get(self,prop:'str') -> 'Any': - """ - Description of Get. - -Args: - - prop(str):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. - -Returns: - - 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 - - - def Put(self,_property:'str',val:'Any') -> 'None': - """ - Description of Put. - -Args: - - _property(str):The property name to set - val(Any):The value to set. - -Returns: - - None - - """ - pass - - - def get(self,prop:'str') -> 'Any': - """ - Description of Get. - -Args: - - prop(str):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. - -Returns: - - 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 - - - def put(self,_property:'str',val:'Any') -> 'None': - """ - Description of Put. - -Args: - - _property(str):The property name to set - val(Any):The value to set. - -Returns: - - None - - """ - pass - - -class PyIADsContainer(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetObject(self,_class:'str',relativeName:'str') -> 'Any': - """ - None - -Args: - - _class(str):Specifies the name of the object class as known in the underlying directory and identical to the one retrieved through the get_Class property method. If the class name is None, the provider returns the first item found in the container. - relativeName(str):Specifies the name of the object as known in the underlying directory and identical to the one retrieved through the get_Name property method. - -Returns: - - Any - - """ - pass - - - def get_Count(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def get_Filter(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def put_Filter(self,val:'Any') -> 'None': - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - pass - - - def get_Hints(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def put_Hints(self,val:'Any') -> 'None': - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - pass - - -class PyIADsUser(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def get_AccountDisabled(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def put_AccountDisabled(self,val:'Any') -> 'None': - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - pass - - - def get_AccountExpirationDate(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def put_AccountExpirationDate(self,val:'PyTime') -> 'None': - """ - None - -Args: - - val(PyTime): - -Returns: - - None - - """ - pass - - - def get_BadLoginAddress(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def get_BadLoginCount(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def get_Department(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def put_Department(self,val:'Any') -> 'None': - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - pass - - - def get_Description(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def put_Description(self,val:'Any') -> 'None': - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - pass - - - def get_Division(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def put_Division(self,val:'Any') -> 'None': - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - pass - - - def get_EmailAddress(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def put_EmailAddress(self,val:'Any') -> 'None': - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - pass - - - def get_EmployeeID(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def put_EmployeeID(self,val:'Any') -> 'None': - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - pass - - - def get_FirstName(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def put_FirstName(self,val:'Any') -> 'None': - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - pass - - - def get_FullName(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def put_FullName(self,val:'Any') -> 'None': - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - pass - - - def get_HomeDirectory(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def put_HomeDirectory(self,val:'Any') -> 'None': - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - pass - - - def get_HomePage(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def put_HomePage(self,val:'Any') -> 'None': - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - pass - - - def get_LoginScript(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def put_LoginScript(self,val:'Any') -> 'None': - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - pass - - - def SetPassword(self,val:'Any') -> 'None': - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - pass - - - def ChangePassword(self,oldval:'Any',newval:'Any') -> 'None': - """ - None - -Args: - - oldval(Any): - newval(Any): - -Returns: - - None - - """ - pass - - -class PyIActiveDesktop(object): - """An interface to the ActiveDesktop""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ApplyChanges(self,Flags:'Any') -> 'None': - """ - Applies changes to ActiveDesktop settings and persists them to the registry. - -Args: - - Flags(Any):Combination of shellcon.AD_APPLY_* flags - -Returns: - - None - - """ - pass - - - def GetWallpaper(self,cchWallpaper:'Any',Reserved:'Any'=0) -> 'Any': - """ - Returns the current wallpaper - -Args: - - cchWallpaper(Any):Number of characters to allocate for buffer - Reserved(Any):Use 0 if passed in - -Returns: - - Any - - """ - pass - - - def SetWallpaper(self,Wallpaper:'Any',Reserved:'Any'=0) -> 'None': - """ - Sets the desktop wallpaper - -Args: - - Wallpaper(Any):File to be used as new wallpaper - Reserved(Any):Reserved, use 0 if passed in - -Returns: - - None - - """ - pass - - - def GetWallpaperOptions(self,Reserved:'Any'=0) -> 'Any': - """ - Returns wallpaper style - -Args: - - Reserved(Any):Use 0 if passed inReturn ValueReturns one of the WPSTYLE_* values - -Returns: - - Any:Use 0 if passed in -Return ValueReturns one of the WPSTYLE_* values - - - """ - pass - - - def SetWallpaperOptions(self,Style:'Any',Reserved:'Any'=0) -> 'None': - """ - Sets wallpaper style - -Args: - - Style(Any):The wallpaper style, one of the WPSTYLE_* constants - Reserved(Any):Reserved, use 0 if passed in - -Returns: - - None - - """ - pass - - - def GetPattern(self,cchPattern:'Any'=1024,Reserved:'Any'=0) -> 'None': - """ - Returns the wallpaper pattern - -Args: - - cchPattern(Any):Number of characters to allocate for buffer - Reserved(Any):Use 0 if passed inReturn ValueReturns a unicode string containing decimal values representing the pattern - -Returns: - - None:Use 0 if passed in -Return ValueReturns a unicode string containing decimal values representing the pattern - - - """ - pass - - - def SetPattern(self,Pattern:'Any',Reserved:'Any'=0) -> 'None': - """ - Sets the wallpaper pattern - -Args: - - Pattern(Any):String of decimal numbers representing a picture - Reserved(Any):Use 0 if passed in - -Returns: - - None - - """ - pass - - - def GetDesktopItemOptions(self,) -> 'Any': - """ - Returns options for Active Desktop. - -Args: - - - -Returns: - - Any:PyIActiveDesktop.GetDesktopItemOptions - -dict = GetDesktopItemOptions()Returns options for Active Desktop. -Return ValueReturns a COMPONENTSOPT dictionary - - - """ - pass - - - def SetDesktopItemOptions(self,comp:'Any',Reserved:'Any'=0) -> 'None': - """ - Sets Active Desktop options - -Args: - - comp(Any):COMPONENTSOPT dictionary - Reserved(Any):Use 0 if passed in - -Returns: - - None - - """ - pass - - - def AddDesktopItem(self,comp:'Any',Reserved:'Any'=0) -> 'None': - """ - Creates a new item to display on the desktop - -Args: - - comp(Any):COMPONENT dictionary - Reserved(Any):Use 0 if passed in - -Returns: - - None - - """ - pass - - - def AddDesktopItemWithUI(self,hwnd:'int',comp:'Any',Flags:'Any') -> 'None': - """ - Adds a desktop item, allowing user interaction - -Args: - - hwnd(int):Handle to parent window - comp(Any):COMPONENT dictionary - Flags(Any):One of shellcon.DTI_ADDUI_* flags - -Returns: - - None - - """ - pass - - - def ModifyDesktopItem(self,comp:'Any',Flags:'Any') -> 'None': - """ - Changes parameters for a desktop item - -Args: - - comp(Any):COMPONENT dictionary - Flags(Any):Combination of shellcon.COMP_ELEM_* flags - -Returns: - - None - - """ - pass - - - def RemoveDesktopItem(self,comp:'Any',Reserved:'Any'=0) -> 'None': - """ - Removes an item from the Active Desktop - -Args: - - comp(Any):COMPONENT dictionary specifying which component to remove - Reserved(Any):Use 0 if passed in - -Returns: - - None - - """ - pass - - - def GetDesktopItemCount(self,) -> 'None': - """ - Returns number of defined desktop items. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDesktopItem(self,Component:'Any',Reserved:'Any'=0) -> 'Any': - """ - Returns desktop item parameters by index - -Args: - - Component(Any):The zero-based index of the component to get - Reserved(Any):Use 0 if passed inReturn ValueReturns a COMPONENT dictionary describing the item - -Returns: - - Any:Use 0 if passed in -Return ValueReturns a COMPONENT dictionary describing the item - - - """ - pass - - - def GetDesktopItemByID(self,ID:'Any',reserved:'Any'=0) -> 'Any': - """ - Returns desktop item parameters by Id - -Args: - - ID(Any):The Id of the desktop item - reserved(Any):Use 0 if passed inReturn ValueReturns a COMPONENT dictionary - -Returns: - - Any:Use 0 if passed in -Return ValueReturns a COMPONENT dictionary - - - """ - pass - - - def GenerateDesktopItemHtml(self,FileName:'Any',comp:'Any',Reserved:'Any'=0) -> 'None': - """ - Creates an HTML page for the desktop item - -Args: - - FileName(Any):Name of file to be created - comp(Any):COMPONENT dictionary specifying the desktop item - Reserved(Any):Use 0 if passed in - -Returns: - - None - - """ - pass - - - def AddUrl(self,hwnd:'int',Source:'Any',comp:'Any',Flags:'Any') -> 'None': - """ - Adds a web page to desktop, allowing user interaction - -Args: - - hwnd(int):Parent windows for any user interactive - Source(Any):Source URL - comp(Any):COMPONENT dictionary - Flags(Any):ADDURL_SILENT, or 0 - -Returns: - - None - - """ - pass - - - def GetDesktopItemBySource(self,Source:'Any',Reserved:'Any'=0) -> 'Any': - """ - Returns desktop item parameters by URL - -Args: - - Source(Any):The URL address of the item to retrieve - Reserved(Any):Use 0 if passed inReturn ValueReturns a COMPONENT dictionary - -Returns: - - Any:Use 0 if passed in -Return ValueReturns a COMPONENT dictionary - - - """ - pass - - -class PyIActiveDesktopP(object): - """An interface to the ActiveDesktop""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetSafeMode(self,Flags:'Any') -> 'None': - """ - Changes Active Desktop to safe mode - -Args: - - Flags(Any):One of shellcon.SSM_* flags - -Returns: - - None - - """ - pass - - -class PyIActiveScriptDebug(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetScriptTextAttributes(self,pstrCode:'str',pstrDelimiter:'str',dwFlags:'Any') -> 'Tuple[Any, ...]': - """ - Returns the text attributes for an arbitrary block - -of script text. - -Args: - - pstrCode(str):The script block text. - pstrDelimiter(str):See PyIActiveScriptParse::ParseScriptText for a description of this argument. - dwFlags(Any):See PyIActiveScriptParse::ParseScriptText for a description of this argument.CommentsSmart hosts use this call to delegate GetText calls made on their axscript::PyIDebugDocumentText - -Returns: - - Tuple[Any, ...] - - """ - pass - - - def GetScriptletTextAttributes(self,pstrCode:'str',pstrDelimiter:'str',dwFlags:'Any') -> 'None': - """ - Description of GetScriptletTextAttributes. - -Args: - - pstrCode(str):The script block text. - pstrDelimiter(str):See PyIActiveScriptParse::ParseScriptText for a description of this argument. - dwFlags(Any):See PyIActiveScriptParse::ParseScriptText for a description of this argument. - -Returns: - - None - - """ - pass - - - def EnumCodeContextsOfPosition(self,dwSourceContext:'Any',uCharacterOffset:'Any',uNumChars:'Any') -> 'None': - """ - Description of EnumCodeContextsOfPosition. - -Args: - - dwSourceContext(Any):Description for dwSourceContext - uCharacterOffset(Any):Description for uCharacterOffset - uNumChars(Any):Description for uNumChars - -Returns: - - None - - """ - pass - - -class PyIActiveScriptError(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetExceptionInfo(self,) -> 'None': - """ - Description of GetExceptionInfo. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetSourcePosition(self,) -> 'None': - """ - Description of GetSourcePosition. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetSourceLineText(self,) -> 'None': - """ - Description of GetSourceLineText. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIActiveScriptErrorDebug(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDocumentContext(self,) -> 'None': - """ - Description of GetDocumentContext. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetStackFrame(self,) -> 'None': - """ - Description of GetStackFrame. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIActiveScriptParseProcedure(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ParseProcedureText(self,pstrCode:'Any',pstrFormalParams:'Any',pstrProcedureName:'Any',pstrItemName:'Any',punkContext:'Any',pstrDelimiter:'Any',dwSourceContextCookie:'Any',ulStartingLineNumber:'Any',dwFlags:'Any') -> 'None': - """ - Description of ParseProcedureText. - -Args: - - pstrCode(Any):Description for pstrCode - pstrFormalParams(Any):Description for pstrFormalParams - pstrProcedureName(Any):Description for pstrProcedureName - pstrItemName(Any):Description for pstrItemName - punkContext(Any):Description for punkContext - pstrDelimiter(Any):Description for pstrDelimiter - dwSourceContextCookie(Any):Description for dwSourceContextCookie - ulStartingLineNumber(Any):Description for ulStartingLineNumber - dwFlags(Any):Description for dwFlags - -Returns: - - None - - """ - pass - - -class PyIActiveScriptSite(object): - """An object providing the IActiveScriptSite interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetLCID(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetItemInfo(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetDocVersionString(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def OnStateChange(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def OnEnterScript(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def OnLeaveScript(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def OnScriptError(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def OnScriptTerminate(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIActiveScriptSiteDebug(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDocumentContextFromPosition(self,dwSourceContext:'Any',uCharacterOffset:'Any',uNumChars:'Any') -> 'None': - """ - Description of GetDocumentContextFromPosition. - -Args: - - dwSourceContext(Any):Description for dwSourceContext - uCharacterOffset(Any):Description for uCharacterOffset - uNumChars(Any):Description for uNumChars - -Returns: - - None - - """ - pass - - - def GetApplication(self,) -> 'None': - """ - Description of GetApplication. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetRootApplicationNode(self,) -> 'None': - """ - Description of GetRootApplicationNode. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnScriptErrorDebug(self,) -> 'Tuple[Any, Any]': - """ - Allows a smart host to control the handling of runtime - -errors - -Args: - - - -Returns: - - Tuple[Any, Any]:PyIActiveScriptSiteDebug.OnScriptErrorDebug - -int, int = OnScriptErrorDebug()Allows a smart host to control the handling of runtime - -errors -Return ValueThe result is a tuple of (bCallDebugger, bCallOnScriptErrorWhenContinuing) - - - """ - pass - - -class PyIAddrBook(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ResolveName(self,uiParm:'Any',flags:'Any',entryTitle:'str',ADRLIST:'Any') -> 'None': - """ - Performs name resolution, assigning entry identifiers to recipients in a recipient list. - -Args: - - uiParm(Any):hwnd of a dialogs parent. - flags(Any):Bitmask of flags that controls whether a dialog box can be displayed. - entryTitle(str): - ADRLIST(Any):Partial addresses to resolve. - -Returns: - - None - - """ - pass - - - def OpenEntry(self,entryId:'str',iid:'PyIID',flags:'Any') -> 'Any': - """ - Opens a folder or message and returns an interface object for further access. - -Args: - - entryId(str):The entryID of the object - iid(PyIID):The IID of the object to return, or None for the default IID - flags(Any):Bitmask of flags that controls how the object is opened. - -Returns: - - Any - - """ - pass - - - def CompareEntryIDs(self,entryId:'str',entryId1:'str',flags:'Any'=0) -> 'Any': - """ - Compares two entry identifiers belonging to a particular address book provider to determine if they refer to the same address book object - -Args: - - entryId(str):The first entry ID to be compared - entryId1(str):The second entry ID to be compared - flags(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. - -Returns: - - 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 - - -class PyIApplicationDebugger(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def QueryAlive(self,) -> 'None': - """ - Returns true if alive, else false. - -Args: - - - -Returns: - - None - - """ - pass - - - def CreateInstanceAtDebugger(self,rclsid:'PyIID',pUnkOuter:'Any',dwClsContext:'Any',riid:'PyIID') -> 'None': - """ - Create objects in the application process address space. - -Args: - - rclsid(PyIID):Description for rclsid - pUnkOuter(Any):Description for pUnkOuter - dwClsContext(Any):Description for dwClsContext - riid(PyIID):Description for riidCommentsProvides a mechanism for the debugger IDE, running out-of-process to the application, to create objects in the application process. This method simply delegates to CoCreateInstance. - -Returns: - - None - - """ - pass - - - def onDebugOutput(self,pstr:'Any') -> 'None': - """ - None - -Args: - - pstr(Any):Description for pstrCommentsThe debugger can use this to display the string in an output window. - -Returns: - - None - - """ - pass - - - def onHandleBreakPoint(self,prpt:'Any',br:'Any',pError:'Any') -> 'None': - """ - Called when a breakpoint is hit. - -Args: - - prpt(Any):Description for prpt - br(Any):Description for br - pError(Any):Description for pErrorCommentsThe application will remain suspended until the debugger IDE calls PyIDebugApplication::ResumeFromBreakPoint. - -Returns: - - None - - """ - pass - - - def onClose(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def onDebuggerEvent(self,guid:'PyIID',uUnknown:'Any') -> 'None': - """ - Description of onDebuggerEvent. - -Args: - - guid(PyIID): - uUnknown(Any):CommentsThe semantics of guid and unknown are entirely application/debugger defined This method may return E_NOTIMPL. - -Returns: - - None - - """ - pass - - -class PyIApplicationDestinations(object): - """Allows an application to removed items from its jump lists""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetAppID(self,AppID:'Any') -> 'None': - """ - Specifies the application whose jump list is to be accessed - -Args: - - AppID(Any):Taskbar identifier for the applicationCommentsThis method is only needed if the application sets its own taskbar identifier - -Returns: - - None - - """ - pass - - - def RemoveDestination(self,punk:'Any') -> 'None': - """ - Removes a single entry from the jump lists - -Args: - - punk(Any):IShellItem or IShellLink representing an item in the application's jump listCommentsDoes not remove pinned items - -Returns: - - None - - """ - pass - - - def RemoveAllDestinations(self,) -> 'None': - """ - Removes all Recent and Frequent jump list entries - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIApplicationDocumentLists(object): - """Interface used to retrieve the jump lists for an application""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetAppID(self,AppID:'Any') -> 'None': - """ - Specifies the application whose jump list is to be accessed - -Args: - - AppID(Any):Taskbar identifier for the applicationCommentsThis method is only needed if the application sets its own taskbar identifier - -Returns: - - None - - """ - pass - - - def GetList(self,ListType:'Any',riid:'PyIID',ItemsDesired:'Any'=0) -> 'Any': - """ - Retrieves a list of items in a jump list - -Args: - - ListType(Any):Type of document list to return, shellcon.ADLT_RECENT or ADLT_FREQUENT - riid(PyIID):The interface to return, IID_IEnumObjects or IID_IObjectArray - ItemsDesired(Any):Number of items to return, use 0 for all available - -Returns: - - Any - - """ - pass - - -class PyIAsyncOperation(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetAsyncMode(self,fDoOpAsync:'Any') -> 'None': - """ - Description of SetAsyncMode. - -Args: - - fDoOpAsync(Any):Description for fDoOpAsync - -Returns: - - None - - """ - pass - - - def GetAsyncMode(self,) -> 'Any': - """ - Description of GetAsyncMode. - -Args: - - - -Returns: - - Any - - """ - pass - - - def StartOperation(self,pbcReserved:'Any') -> 'None': - """ - Description of StartOperation. - -Args: - - pbcReserved(Any):Description for pbcReserved - -Returns: - - None - - """ - pass - - - def InOperation(self,) -> 'None': - """ - Description of InOperation. - -Args: - - - -Returns: - - None - - """ - pass - - - def EndOperation(self,hResult:'Any',pbcReserved:'Any',dwEffects:'Any') -> 'None': - """ - Description of EndOperation. - -Args: - - hResult(Any):Description for hResult - pbcReserved(Any):Description for pbcReserved - dwEffects(Any):Description for dwEffects - -Returns: - - None - - """ - pass - - -class PyIAttach(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetLastError(self,hr:'Any',flags:'Any') -> 'Any': - """ - Returns the last error code for the object. - -Args: - - hr(Any):Contains the error code generated in the previous method call. - flags(Any):Indicates for format for the output. - -Returns: - - Any - - """ - pass - - -class PyIBindCtx(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetRunningObjectTable(self,) -> 'Any': - """ - Retrieves an object interfacing to the Running - -Object Table. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetBindOptions(self,) -> 'Any': - """ - Retrieves the bind options for the bind context - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetBindOptions(self,bindopts:'Any') -> 'None': - """ - Sets the bind options for the context - -Args: - - bindopts(Any):PyBIND_OPTS dictionary containing the binding options - -Returns: - - None - - """ - pass - - - def RegisterObjectParam(self,Key:'str',punk:'Any') -> 'None': - """ - Adds an object to the context's keyed table of associated objects - -Args: - - Key(str):The string key for the object to be registered - punk(Any):COM object to be registered with the bind context - -Returns: - - None - - """ - pass - - - def RevokeObjectParam(self,Key:'str') -> 'None': - """ - Removes one of the bind context's registered objects - -Args: - - Key(str):The string key for the object to be removed - -Returns: - - None - - """ - pass - - - def GetObjectParam(self,Key:'str') -> 'Any': - """ - Returns one of the bind context's associated objects - -Args: - - Key(str):The string key for the object to be returned - -Returns: - - Any - - """ - pass - - - def EnumObjectParam(self,) -> 'Any': - """ - Creates an enumerator to list context's string keys - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIBrowserFrameOptions(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetFrameOptions(self,dwMask:'Any') -> 'None': - """ - Description of GetFrameOptions. - -Args: - - dwMask(Any):Description for dwMask - -Returns: - - None - - """ - pass - - -class PyICancelMethodCalls(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Cancel(self,Seconds:'Any') -> 'None': - """ - Cancels a pending call - -Args: - - Seconds(Any):Wait timeout in seconds - -Returns: - - None - - """ - pass - - - def TestCancel(self,) -> 'Any': - """ - Checks if a request has been made to cancel a call - -Args: - - - -Returns: - - Any:PyICancelMethodCalls.TestCancel - -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 - - -class PyICatInformation(object): - """A Python interface to ICatInformation""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def EnumCategories(self,lcid:'Any'=0) -> 'Any': - """ - Returns an enumerator for the component categories - -registered on the system. - -Args: - - lcid(Any):lcid - -Returns: - - Any - - """ - pass - - - def GetCategoryDesc(self,lcid:'Any'=0) -> 'str': - """ - Retrieves the localized description string for a specific category - -ID. - -Args: - - lcid(Any):lcidCommentsThe return type is a unicode object. - -Returns: - - str - - """ - pass - - - def EnumClassesOfCategories(self,listIIdImplemented:'List[PyIID]'=None,listIIdRequired:'Any'=None) -> 'Any': - """ - Returns an enumerator over the classes that - -implement one or more interfaces. - -Args: - - listIIdImplemented(List[PyIID]):A sequence of PyIID objects, or None. - listIIdRequired(Any):A sequence of PyIID objects, or None. - -Returns: - - Any - - """ - pass - - -class PyICatRegister(object): - """An interface to a COM ICatRegister interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def RegisterCategories(self,arg:'List[Any]') -> 'None': - """ - Registers one or more component categories. Each component category - -consists of a CATID and a list of locale-dependent description strings. - -Args: - - arg(List[Any]):A sequence of category descriptions. - -Returns: - - None - - """ - pass - - - def UnRegisterCategories(self,arg:'List[PyIID]') -> 'None': - """ - Unregister one or more previously registered categories. - -Args: - - arg(List[PyIID]):The list of category IDs to be unregistered. - -Returns: - - None - - """ - pass - - - def RegisterClassImplCategories(self,clsid:'PyIID',arg:'List[PyIID]') -> 'None': - """ - Registers the class as implementing one or more component - -categories. - -Args: - - clsid(PyIID):Class ID of the relevent class - arg(List[PyIID]):A sequence of category IDs to be associated with the class. - -Returns: - - None - - """ - pass - - - def UnRegisterClassImplCategories(self,clsid:'PyIID',arg:'List[PyIID]') -> 'None': - """ - Unregisters the class as implementing one or more component - -categories. - -Args: - - clsid(PyIID):Class ID of the relevent class - arg(List[PyIID]):A sequence of category IDs to be unregistered from the class. - -Returns: - - None - - """ - pass - - - def RegisterClassReqCategories(self,clsid:'PyIID',arg:'List[PyIID]') -> 'None': - """ - Registers the class as requiring one or more component - -categories. - -Args: - - clsid(PyIID):Class ID of the relevent class - arg(List[PyIID]):A sequence of category IDs to be associated with the class. - -Returns: - - None - - """ - pass - - - def UnRegisterClassReqCategories(self,clsid:'PyIID',arg:'List[PyIID]') -> 'None': - """ - Unregisters the class as requiring one or more component - -categories. - -Args: - - clsid(PyIID):Class ID of the relevent class - arg(List[PyIID]):A sequence of category IDs to be unregistered for the class. - -Returns: - - None - - """ - pass - - -class PyICategoryProvider(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CanCategorizeOnSCID(self,pscid:'Any') -> 'None': - """ - Description of CanCategorizeOnSCID. - -Args: - - pscid(Any):Description for pscid - -Returns: - - None - - """ - pass - - - def GetDefaultCategory(self,) -> 'None': - """ - Description of GetDefaultCategory. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCategoryForSCID(self,pscid:'Any') -> 'None': - """ - Description of GetCategoryForSCID. - -Args: - - pscid(Any):Description for pscid - -Returns: - - None - - """ - pass - - - def EnumCategories(self,) -> 'None': - """ - Description of EnumCategories. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCategoryName(self,guid:'PyIID') -> 'None': - """ - Description of GetCategoryName. - -Args: - - guid(PyIID):Description for pguidCommentsThe buffer is always 1024 chars long - -Returns: - - None - - """ - pass - - - def CreateCategory(self,guid:'PyIID',riid:'PyIID') -> 'None': - """ - Description of CreateCategory. - -Args: - - guid(PyIID):Description for pguid - riid(PyIID):Description for riid - -Returns: - - None - - """ - pass - - -class PyIClassFactory(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateInstance(self,outerUnknown:'Any',iid:'PyIID') -> 'Any': - """ - Creates an uninitialized object. - -Args: - - outerUnknown(Any):Usually None, otherwise the outer unknown if the object is being created as part of an aggregate. - iid(PyIID):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. - -Returns: - - Any: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:'Any') -> 'None': - """ - Called by the client of a class object to keep a server open in memory, - -allowing instances to be created more quickly. - -Args: - - bInc(Any):1 of the server should be locked, 0 if the server should be unlocked. - -Returns: - - None - - """ - pass - - -class PyIClientSecurity(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def QueryBlanket(self,Proxy:'Any') -> 'Any': - """ - Retrieves the authentication settings for an interface - -Args: - - Proxy(Any):An interface created through a proxy - -Returns: - - Any - - """ - pass - - - def SetBlanket(self,Proxy:'Any',AuthnSvc:'Any',AuthzSvc:'Any',ServerPrincipalName:'str',AuthnLevel:'Any',ImpLevel:'Any',AuthInfo:'Any',Capabilities:'Any') -> 'None': - """ - Changes the authentication options used with an interface - -Args: - - Proxy(Any):The proxy interface for which to set security options - AuthnSvc(Any):Authentication service identifier, pythoncom.RPC_C_AUTHN_* (but not RPC_C_AUTHN_LEVEL_*) - AuthzSvc(Any):Authorization service identifier, pythoncom.RPC_C_AUTHZ_* - ServerPrincipalName(str):SPN that identifies the server, can be None - AuthnLevel(Any):Authentication level, pythoncom.RPC_C_AUTHN_LEVEL_* - ImpLevel(Any):Impersonation level, pythoncom.RPC_C_IMP_LEVEL_* - AuthInfo(Any):Not supported yet, use only None - Capabilities(Any):Combination of pythoncom.EOAC_* flags. Must be a subset of the capabilities of the specified authentication service. - -Returns: - - None - - """ - pass - - - def CopyProxy(self,Proxy:'Any') -> 'Any': - """ - Makes a private copy of a proxy interface - -Args: - - Proxy(Any):The remote interface to be copied - -Returns: - - Any - - """ - pass - - -class PyIColumnProvider(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,psci:'Any') -> 'None': - """ - Description of Initialize. - -Args: - - psci(Any):Description for psci - -Returns: - - None - - """ - pass - - - def GetColumnInfo(self,dwIndex:'Any') -> 'None': - """ - Description of GetColumnInfo. - -Args: - - dwIndex(Any):Description for dwIndex - -Returns: - - None - - """ - pass - - - def GetItemData(self,pscid:'Any',pscd:'Any') -> 'None': - """ - Description of GetItemData. - -Args: - - pscid(Any):Description for pscid - pscd(Any):Description for pscd - -Returns: - - None - - """ - pass - - -class PyIConnectionPoint(object): - """A Python wrapper of a COM IConnectionPoint interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetConnectionInterface(self,) -> 'PyIID': - """ - Retrieves the IID of the interface represented by the - -connection point. - -Args: - - - -Returns: - - PyIID - - """ - pass - - - def GetConnectionPointContainer(self,) -> 'Any': - """ - Gets the connection point - -container for the object. - -Args: - - - -Returns: - - Any - - """ - pass - - - def Advise(self,unk:'Any') -> 'Any': - """ - Establishes a connection between the connection point object and the client's - -sink. - -Args: - - unk(Any):The client's advise sinkReturn ValueThe result is the connection point identifier used by PyIConnectionPoint::Unadvise - -Returns: - - Any:The client's advise sinkReturn ValueThe result is the connection point identifier used by PyIConnectionPoint::Unadvise - - - """ - pass - - - def Unadvise(self,cookie:'Any') -> 'None': - """ - Terminates an advisory connection previously established through - -IConnectionPoint::Advise. The dwCookie parameter identifies the connection to terminate. - -Args: - - cookie(Any):The connection token - -Returns: - - None - - """ - pass - - - def EnumConnections(self,) -> 'Any': - """ - Creates an enumerator to iterate through the - -connections for the connection point - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIConnectionPointContainer(object): - """A Python wrapper of a COM IConnectionPointContainer interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def EnumConnectionPoints(self,) -> 'Any': - """ - Creates an enumerator object - -to iterate through all the connection points supported in the connectable object, one connection point per outgoing - -IID. - -Args: - - - -Returns: - - Any - - """ - pass - - - def FindConnectionPoint(self,iid:'PyIID') -> 'Any': - """ - Finds a connection point for the - -given IID - -Args: - - iid(PyIID):The IID of the requested connection. - -Returns: - - Any - - """ - pass - - -class PyIContext(object): - """Allows access to properties defined for the current context (Requires win2k or later)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetProperty(self,rpolicyId:'PyIID',flags:'Any',pUnk:'Any') -> 'None': - """ - Sets a property on the context - -Args: - - rpolicyId(PyIID):GUID identifying the property to be set - flags(Any):Reserved, use only 0 - pUnk(Any):The property value - -Returns: - - None - - """ - pass - - - def RemoveProperty(self,rPolicyId:'PyIID') -> 'None': - """ - Removes a property from the context - -Args: - - rPolicyId(PyIID):GUID that identifies a context property - -Returns: - - None - - """ - pass - - - def GetProperty(self,rGuid:'PyIID') -> 'Tuple[Any, Any]': - """ - Retrieves a context property - -Args: - - rGuid(PyIID):GUID that identifies a context propertyReturn ValueReturns flags (CPFLAGS is reserved, no defined values) and the IUnknown interface set for the property - -Returns: - - Tuple[Any, Any]:GUID that identifies a context propertyReturn ValueReturns flags (CPFLAGS is reserved, no defined values) and the IUnknown interface set for the property - - - """ - pass - - - def EnumContextProps(self,) -> 'Any': - """ - Returns an enumerator for the context properties - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIContextMenu(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def QueryContextMenu(self,hmenu:'int',indexMenu:'Any',idCmdFirst:'Any',idCmdLast:'Any',uFlags:'Any') -> 'Any': - """ - Adds options to a context menu - -Args: - - hmenu(int):Handle to menu to which items should be added - indexMenu(Any):Zero-based index at which to add first item - idCmdFirst(Any):Minimum menu item Id - idCmdLast(Any):Max menu item Id - uFlags(Any):Combination of shellcon.CMF_* flags, can be 0 - -Returns: - - Any - - """ - pass - - - def InvokeCommand(self,pici:'Any') -> 'None': - """ - Executes a context menu option - -Args: - - pici(Any):Tuple of parameters representing a CMINVOKECOMMANDINFO struct - -Returns: - - None - - """ - pass - - - def GetCommandString(self,idCmd:'Any',uType:'Any',cchMax:'Any'=2048) -> 'Any': - """ - Retrieves verb or help text for a context menu option - -Args: - - idCmd(Any):Id of the command - uType(Any):One of the shellcon.GCS_* constants - cchMax(Any):Size of buffer to create for returned string - -Returns: - - Any - - """ - pass - - -class PyICopyHookA(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CopyCallback(self,hwnd:'Any',wFunc:'Any',wFlags:'Any',srcFile:'Union[Any, str]',srcAttribs:'Any',destFile:'Union[Any, str]',destAttribs:'Any') -> 'None': - """ - Description of CopyCallback. - -Args: - - hwnd(Any):Description for hwnd - wFunc(Any):Description for wFunc - wFlags(Any):Description for wFlags - srcFile(Union[Any, str]):Description for srcFile - srcAttribs(Any):Description for srcAttribs - destFile(Union[Any, str]):Description for destFile - destAttribs(Any):Description for destAttribs - -Returns: - - None - - """ - pass - - -class PyICopyHookW(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CopyCallback(self,hwnd:'Any',wFunc:'Any',wFlags:'Any',srcFile:'Union[Any, str]',srcAttribs:'Any',destFile:'Union[Any, str]',destAttribs:'Any') -> 'None': - """ - Description of CopyCallback. - -Args: - - hwnd(Any):Description for hwnd - wFunc(Any):Description for wFunc - wFlags(Any):Description for wFlags - srcFile(Union[Any, str]):Description for srcFile - srcAttribs(Any):Description for srcAttribs - destFile(Union[Any, str]):Description for destFile - destAttribs(Any):Description for destAttribs - -Returns: - - None - - """ - pass - - -class PyICreateTypeInfo(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetGuid(self,guid:'PyIID') -> 'None': - """ - Description of SetGuid. - -Args: - - guid(PyIID):Description for guid - -Returns: - - None - - """ - pass - - - def SetTypeFlags(self,uTypeFlags:'Any') -> 'None': - """ - Description of SetTypeFlags. - -Args: - - uTypeFlags(Any):Description for uTypeFlags - -Returns: - - None - - """ - pass - - - def SetDocString(self,pStrDoc:'Any') -> 'None': - """ - Description of SetDocString. - -Args: - - pStrDoc(Any):Description for pStrDoc - -Returns: - - None - - """ - pass - - - def SetHelpContext(self,dwHelpContext:'Any') -> 'None': - """ - Description of SetHelpContext. - -Args: - - dwHelpContext(Any):Description for dwHelpContext - -Returns: - - None - - """ - pass - - - def SetVersion(self,wMajorVerNum:'Any',wMinorVerNum:'Any') -> 'None': - """ - Description of SetVersion. - -Args: - - wMajorVerNum(Any):Description for wMajorVerNum - wMinorVerNum(Any):Description for wMinorVerNum - -Returns: - - None - - """ - pass - - - def AddRefTypeInfo(self,pTInfo:'Any') -> 'None': - """ - Description of AddRefTypeInfo. - -Args: - - pTInfo(Any):Description for pTInfo - -Returns: - - None - - """ - pass - - - def AddFuncDesc(self,index:'Any') -> 'None': - """ - Description of AddFuncDesc. - -Args: - - index(Any):Description for index - -Returns: - - None - - """ - pass - - - def AddImplType(self,index:'Any',hRefType:'Any') -> 'None': - """ - Description of AddImplType. - -Args: - - index(Any):Description for index - hRefType(Any):A hRefType - -Returns: - - None - - """ - pass - - - def SetImplTypeFlags(self,index:'Any',implTypeFlags:'Any') -> 'None': - """ - Description of SetImplTypeFlags. - -Args: - - index(Any):Description for index - implTypeFlags(Any):Description for implTypeFlags - -Returns: - - None - - """ - pass - - - def SetAlignment(self,cbAlignment:'Any') -> 'None': - """ - Description of SetAlignment. - -Args: - - cbAlignment(Any):Description for cbAlignment - -Returns: - - None - - """ - pass - - - def SetSchema(self,pStrSchema:'Any') -> 'None': - """ - Description of SetSchema. - -Args: - - pStrSchema(Any):Description for pStrSchema - -Returns: - - None - - """ - pass - - - def AddVarDesc(self,index:'Any') -> 'None': - """ - Description of AddVarDesc. - -Args: - - index(Any):Description for index - -Returns: - - None - - """ - pass - - - def SetFuncAndParamNames(self,index:'Any',rgszNames:'Tuple[Any, ...]') -> 'None': - """ - Description of SetFuncAndParamNames. - -Args: - - index(Any):Index of the item to set. - rgszNames(Tuple[Any, ...]):A sequence of unicode or String objects. - -Returns: - - None - - """ - pass - - - def SetVarName(self,index:'Any',szName:'Any') -> 'None': - """ - Description of SetVarName. - -Args: - - index(Any):Description for index - szName(Any):Description for szName - -Returns: - - None - - """ - pass - - - def SetTypeDescAlias(self,) -> 'None': - """ - Description of SetTypeDescAlias. - -Args: - - - -Returns: - - None - - """ - pass - - - def DefineFuncAsDllEntry(self,index:'Any',szDllName:'Any',szProcName:'Any') -> 'None': - """ - Description of DefineFuncAsDllEntry. - -Args: - - index(Any):Description for index - szDllName(Any):Description for szDllName - szProcName(Any):Description for szProcName - -Returns: - - None - - """ - pass - - - def SetFuncDocString(self,index:'Any',szDocString:'Any') -> 'None': - """ - Description of SetFuncDocString. - -Args: - - index(Any):Description for index - szDocString(Any):Description for szDocString - -Returns: - - None - - """ - pass - - - def SetVarDocString(self,index:'Any',szDocString:'Any') -> 'None': - """ - Description of SetVarDocString. - -Args: - - index(Any):Description for index - szDocString(Any):Description for szDocString - -Returns: - - None - - """ - pass - - - def SetFuncHelpContext(self,index:'Any',dwHelpContext:'Any') -> 'None': - """ - Description of SetFuncHelpContext. - -Args: - - index(Any):Description for index - dwHelpContext(Any):Description for dwHelpContext - -Returns: - - None - - """ - pass - - - def SetVarHelpContext(self,index:'Any',dwHelpContext:'Any') -> 'None': - """ - Description of SetVarHelpContext. - -Args: - - index(Any):Description for index - dwHelpContext(Any):Description for dwHelpContext - -Returns: - - None - - """ - pass - - - def SetMops(self,index:'Any',bstrMops:'Any') -> 'None': - """ - Description of SetMops. - -Args: - - index(Any):Description for index - bstrMops(Any):Description for bstrMops - -Returns: - - None - - """ - pass - - - def LayOut(self,) -> 'None': - """ - Description of LayOut. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyICreateTypeLib(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateTypeInfo(self,szName:'Any') -> 'None': - """ - Description of CreateTypeInfo. - -Args: - - szName(Any):Description for szName - -Returns: - - None - - """ - pass - - - def SetName(self,szName:'Any') -> 'None': - """ - Description of SetName. - -Args: - - szName(Any):Description for szName - -Returns: - - None - - """ - pass - - - def SetVersion(self,wMajorVerNum:'Any',wMinorVerNum:'Any') -> 'None': - """ - Description of SetVersion. - -Args: - - wMajorVerNum(Any):Description for wMajorVerNum - wMinorVerNum(Any):Description for wMinorVerNum - -Returns: - - None - - """ - pass - - - def SetGuid(self,guid:'PyIID') -> 'None': - """ - Description of SetGuid. - -Args: - - guid(PyIID):Description for guid - -Returns: - - None - - """ - pass - - - def SetDocString(self,szDoc:'Any') -> 'None': - """ - Description of SetDocString. - -Args: - - szDoc(Any):Description for szDoc - -Returns: - - None - - """ - pass - - - def SetHelpFileName(self,szHelpFileName:'Any') -> 'None': - """ - Description of SetHelpFileName. - -Args: - - szHelpFileName(Any):Description for szHelpFileName - -Returns: - - None - - """ - pass - - - def SetHelpContext(self,dwHelpContext:'Any') -> 'None': - """ - Description of SetHelpContext. - -Args: - - dwHelpContext(Any):Description for dwHelpContext - -Returns: - - None - - """ - pass - - - def SetLcid(self,) -> 'None': - """ - Description of SetLcid. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetLibFlags(self,uLibFlags:'Any') -> 'None': - """ - Description of SetLibFlags. - -Args: - - uLibFlags(Any):Description for uLibFlags - -Returns: - - None - - """ - pass - - - def SaveAllChanges(self,) -> 'None': - """ - Description of SaveAllChanges. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyICreateTypeLib2(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateTypeInfo(self,szName:'Any') -> 'None': - """ - Description of CreateTypeInfo. - -Args: - - szName(Any):Description for szName - -Returns: - - None - - """ - pass - - - def SetName(self,szName:'Any') -> 'None': - """ - Description of SetName. - -Args: - - szName(Any):Description for szName - -Returns: - - None - - """ - pass - - - def SetVersion(self,wMajorVerNum:'Any',wMinorVerNum:'Any') -> 'None': - """ - Description of SetVersion. - -Args: - - wMajorVerNum(Any):Description for wMajorVerNum - wMinorVerNum(Any):Description for wMinorVerNum - -Returns: - - None - - """ - pass - - - def SetGuid(self,guid:'PyIID') -> 'None': - """ - Description of SetGuid. - -Args: - - guid(PyIID):Description for guid - -Returns: - - None - - """ - pass - - - def SetDocString(self,szDoc:'Any') -> 'None': - """ - Description of SetDocString. - -Args: - - szDoc(Any):Description for szDoc - -Returns: - - None - - """ - pass - - - def SetHelpFileName(self,szHelpFileName:'Any') -> 'None': - """ - Description of SetHelpFileName. - -Args: - - szHelpFileName(Any):Description for szHelpFileName - -Returns: - - None - - """ - pass - - - def SetHelpContext(self,dwHelpContext:'Any') -> 'None': - """ - Description of SetHelpContext. - -Args: - - dwHelpContext(Any):Description for dwHelpContext - -Returns: - - None - - """ - pass - - - def SetLcid(self,) -> 'None': - """ - Description of SetLcid. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetLibFlags(self,uLibFlags:'Any') -> 'None': - """ - Description of SetLibFlags. - -Args: - - uLibFlags(Any):Description for uLibFlags - -Returns: - - None - - """ - pass - - - def SaveAllChanges(self,) -> 'None': - """ - Description of SaveAllChanges. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyICurrentItem(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyICustomDestinationList(object): - """Interface used to customize an application's jump list""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetAppID(self,AppID:'Any') -> 'None': - """ - Specifies the taskbar identifier for the jump list - -Args: - - AppID(Any):The taskbar identifier of the applicationCommentsOnly needed if the calling app doesn't use the system-assigned default - -Returns: - - None - - """ - pass - - - def BeginList(self,riid:'PyIID') -> 'Tuple[Any, Any]': - """ - Clears the jump list and prepares it to be - -repopulated - -Args: - - riid(PyIID):The interface to returnReturn ValueReturns the number of slots and a collection of all destinations removed from the jump list - -Returns: - - Tuple[Any, Any]:The interface to return -Return ValueReturns the number of slots and a collection of all destinations removed from the jump list - - - """ - pass - - - def AppendCategory(self,Category:'Any',Items:'Any') -> 'None': - """ - Adds a custom category to the jump list - -Args: - - Category(Any):Display name of the category, can also be a dll and resource id for localization - Items(Any):Collection of IShellItem and/or IShellLink interfaces - -Returns: - - None - - """ - pass - - - def AppendKnownCategory(self,Category:'Any') -> 'None': - """ - Adds one of the predefined categories to the custom list - -Args: - - Category(Any):shellcon.KDC_RECENT or KDC_FREQUENT - -Returns: - - None - - """ - pass - - - def AddUserTasks(self,Items:'Any') -> 'None': - """ - Sets the entries shown in the Tasks category - -Args: - - Items(Any):Collection of PyIShellItem and/or PyIShellLink interfaces - -Returns: - - None - - """ - pass - - - def CommitList(self,) -> 'None': - """ - Finalizes changes. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetRemovedDestinations(self,riid:'PyIID') -> 'Any': - """ - Returns all the items removed from the - -jump list - -Args: - - riid(PyIID):The interface to return - -Returns: - - Any - - """ - pass - - - def DeleteList(self,AppID:'Any'=None) -> 'None': - """ - Removes any customization, leaving only the system-maintained Recent - -and Frequent lists - -Args: - - AppID(Any):The taskbar identifier of the application - -Returns: - - None - - """ - pass - - - def AbortList(self,) -> 'None': - """ - Discards all changes - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDL(object): - """A Python representation of an IDL. Implemented as a sequence of Python strings. - -FALSE*/, UINT *pcb /* = NULL */)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIDataObject(object): - """Used to transfer data in various formats throughout the shell""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetData(self,pformatetcIn:'Any') -> 'Any': - """ - Retrieves data from the object in specified format - -Args: - - pformatetcIn(Any):Tuple representing a FORMATETC struct describing how the data should be returned - -Returns: - - Any - - """ - pass - - - def GetDataHere(self,pformatetcIn:'Any') -> 'Any': - """ - Retunrs a copy of the object's data in specified format - -Args: - - pformatetcIn(Any):Tuple representing a FORMATETC struct describing how the data should be returned - -Returns: - - Any - - """ - pass - - - def QueryGetData(self,pformatetc:'Any') -> 'None': - """ - Checks if the objects supports returning data in a particular format. - -Args: - - pformatetc(Any):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. - -Returns: - - 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:'Any') -> 'Any': - """ - Transforms a FORMATECT data description into a general - -format that the object supports - -Args: - - pformatectIn(Any):Tuple representing a FORMATETC struct describing how the data should be returned - -Returns: - - Any - - """ - pass - - - def SetData(self,pformatetc:'Any',pmedium:'Any',fRelease:'Any') -> 'None': - """ - Sets the data that the object will return. - -Args: - - pformatetc(Any):Tuple representing a FORMATETC struct describing the type of data to be set - pmedium(Any):The data to be placed in the object - fRelease(Any):If True, transfers ownership of the data to the object. If False, caller is responsible for releasing the STGMEDIUM. - -Returns: - - None - - """ - pass - - - def EnumFormatEtc(self,dwDirection:'Any') -> 'Any': - """ - Returns an enumerator to list the data formats that the - -object supports. - -Args: - - dwDirection(Any):Indicates whether to return formats that can be queried or set (pythoncom.DATADIR_GET or DATADIR_SET) - -Returns: - - Any - - """ - pass - - - def DAdvise(self,pformatetc:'Any',advf:'Any',pAdvSink:'Any') -> 'Any': - """ - Connects the object to an interface that will receive notifications when its data - -changes - -Args: - - pformatetc(Any):Defines the type of data for which the sink will receive notifications. - advf(Any):Combination of values from ADVF enum. (which currently do not appear in any of the constants modules!) - pAdvSink(Any):Currently this interface is not wrapped.Return ValueReturns a unique number that is used to identify the connection - -Returns: - - Any:Currently this interface is not wrapped.Return ValueReturns a unique number that is used to identify the connection - - - """ - pass - - - def DUnadvise(self,dwConnection:'Any') -> 'None': - """ - Disconnects a notification sink. - -Args: - - dwConnection(Any):Identifier of the connection as returned by DAdvise. - -Returns: - - None - - """ - pass - - - def EnumDAdvise(self,) -> 'Any': - """ - Creates an enumerator to list connected notification sinks. - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIDebugApplication(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetName(self,pstrName:'Any') -> 'None': - """ - Sets the name of the application. - -Args: - - pstrName(Any):The name of the application.CommentsThe provided name will be returned in subsequent calls to >om PyIRemoteDebugApplication.GetName>. - -Returns: - - None - - """ - pass - - - def StepOutComplete(self,) -> 'None': - """ - Called by language engines, in single step mode, just before they - -return to their caller. - -Args: - - - -Returns: - - None - - """ - pass - - - def DebugOutput(self,pstr:'Any') -> 'None': - """ - Causes the given string to be displayed by the debugger IDE, normally in - -an output window. - -Args: - - pstr(Any):Description for pstrCommentsThis mechanism provides the means for a language engine to implement language specific debugging output support. Example: Debug.writeln("Help") in JavaScript. - -Returns: - - None - - """ - pass - - - def StartDebugSession(self,) -> 'None': - """ - Causes a default debugger IDE to be started and a debug session to - -be attached to this application if one does not already exist. - -Args: - - - -Returns: - - None - - """ - pass - - - def HandleBreakPoint(self,br:'Any') -> 'Any': - """ - Called by the language engine in the context of a thread that has - -hit a breakpoint. - -Args: - - br(Any):Break reason - one of the BREAKREASON_* constants.CommentsThis 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 method returns with the action to be taken.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. - -Returns: - - Any:Break reason - one of the BREAKREASON_* constants.Comments - -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 - -method returns with the action to be taken. - -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 - - - def Close(self,) -> 'None': - """ - Causes this application to release all references and enter a zombie state. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetBreakFlags(self,) -> 'Any': - """ - Returns the current break flags for the application. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetCurrentThread(self,) -> 'Any': - """ - Returns the application thread object - -associated with the currently running thread. - -Args: - - - -Returns: - - Any - - """ - pass - - - def CreateAsyncDebugOperation(self,psdo:'Any') -> 'None': - """ - None - -Args: - - psdo(Any):Description for psdoCommentsThis provides a mechanism for language engines to implement asynchronous expression and evaluation, etc. without having to know the details of synchronization with the debugger thread. See the descriptions for PyIDebugSyncOperation and PyIDebugAsyncOperation for more details. - -Returns: - - None - - """ - pass - - - def AddStackFrameSniffer(self,pdsfs:'Any') -> 'Any': - """ - Adds a stack frame sniffer to this application. - -Args: - - pdsfs(Any):Description for pdsfsCommentsGenerally called by a language engine 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 - -Returns: - - Any:Description for pdsfsComments - -Generally called by a language engine - -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 - - - def RemoveStackFrameSniffer(self,dwCookie:'Any') -> 'None': - """ - Removes a stack frame sniffer from this application. - -Args: - - dwCookie(Any):A cookie obtained from PyIDebugApplication::AddStackFrameSniffer - -Returns: - - None - - """ - pass - - - def QueryCurrentThreadIsDebuggerThread(self,) -> 'None': - """ - Determines if the current running thread is the - -debugger thread. - -Args: - - - -Returns: - - None:PyIDebugApplication.QueryCurrentThreadIsDebuggerThread -QueryCurrentThreadIsDebuggerThread()Determines 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:'Any',dwParam1:'Any',dwParam2:'Any',dwParam3:'Any') -> 'None': - """ - Provides a mechanism for the caller to run code in the - -debugger thread. - -Args: - - pptc(Any):Description for pptc - dwParam1(Any):Description for dwParam1 - dwParam2(Any):Description for dwParam2 - dwParam3(Any):Description for dwParam3CommentsThis is generally used so that language engines and hosts can implement free threaded objects on top of their single threaded implementations. - -Returns: - - None - - """ - pass - - - def CreateApplicationNode(self,) -> 'Any': - """ - Creates a new application node which - -is associated with a specific document provider. - -Args: - - - -Returns: - - Any - - """ - pass - - - def FireDebuggerEvent(self,guid:'Any',unknown:'Any') -> 'None': - """ - Fire a generic event to the IApplicationDebugger (if any) - -Args: - - guid(Any):A GUID. - unknown(Any):An unknown object. - -Returns: - - None - - """ - pass - - - def HandleRuntimeError(self,pErrorDebug:'Any',pScriptSite:'Any') -> 'None': - """ - Description of HandleRuntimeError. - -Args: - - pErrorDebug(Any):Description for pErrorDebug - pScriptSite(Any):Description for pScriptSite - -Returns: - - None - - """ - pass - - - def FCanJitDebug(self,) -> 'None': - """ - Description of FCanJitDebug. - -Args: - - - -Returns: - - None - - """ - pass - - - def FIsAutoJitDebugEnabled(self,) -> 'None': - """ - Description of FIsAutoJitDebugEnabled. - -Args: - - - -Returns: - - None - - """ - pass - - - def AddGlobalExpressionContextProvider(self,pdsfs:'Any') -> 'None': - """ - Description of AddGlobalExpressionContextProvider. - -Args: - - pdsfs(Any):Description for pdsfs - -Returns: - - None - - """ - pass - - - def RemoveGlobalExpressionContextProvider(self,dwCookie:'Any') -> 'None': - """ - Description of - -RemoveGlobalExpressionContextProvider. - -Args: - - dwCookie(Any):Description for dwCookie - -Returns: - - None - - """ - pass - - -class PyIDebugApplicationNode(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def EnumChildren(self,) -> 'None': - """ - Description of EnumChildren. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetParent(self,) -> 'Any': - """ - Returns the parent node. - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetDocumentProvider(self,pddp:'Any') -> 'None': - """ - Description of SetDocumentProvider. - -Args: - - pddp(Any):Description for pddp - -Returns: - - None - - """ - pass - - - def Close(self,) -> 'None': - """ - Description of Close. - -Args: - - - -Returns: - - None - - """ - pass - - - def Attach(self,pdanParent:'Any') -> 'None': - """ - Attach a node to its parent. - -Args: - - pdanParent(Any):The parent node. None is not acceptable. - -Returns: - - None - - """ - pass - - - def Detach(self,) -> 'None': - """ - Detach a node from its parent. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugApplicationNodeEvents(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def onAddChild(self,prddpChild:'Any') -> 'None': - """ - Description of onAddChild. - -Args: - - prddpChild(Any):Description for prddpChild - -Returns: - - None - - """ - pass - - - def onRemoveChild(self,prddpChild:'Any') -> 'None': - """ - Description of onRemoveChild. - -Args: - - prddpChild(Any):Description for prddpChild - -Returns: - - None - - """ - pass - - - def onDetach(self,) -> 'None': - """ - Description of onDetach. - -Args: - - - -Returns: - - None - - """ - pass - - - def onAttach(self,prddpParent:'Any') -> 'None': - """ - Description of onAttach. - -Args: - - prddpParent(Any):Description for prddpParent - -Returns: - - None - - """ - pass - - -class PyIDebugApplicationThread(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SynchronousCallIntoThread(self,pstcb:'Any',dwParam1:'Any',dwParam2:'Any',dwParam3:'Any') -> 'None': - """ - Description of SynchronousCallIntoThread. - -Args: - - pstcb(Any):Description for pstcb - dwParam1(Any):Description for dwParam1 - dwParam2(Any):Description for dwParam2 - dwParam3(Any):Description for dwParam3 - -Returns: - - None - - """ - pass - - - def QueryIsCurrentThread(self,) -> 'None': - """ - Description of QueryIsCurrentThread. - -Args: - - - -Returns: - - None - - """ - pass - - - def QueryIsDebuggerThread(self,) -> 'None': - """ - Description of QueryIsDebuggerThread. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugCodeContext(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDocumentContext(self,) -> 'None': - """ - Description of GetDocumentContext. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetBreakPoint(self,bps:'Any') -> 'None': - """ - Description of SetBreakPoint. - -Args: - - bps(Any):Description for bps - -Returns: - - None - - """ - pass - - -class PyIDebugDocument(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIDebugDocumentContext(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDocument(self,) -> 'None': - """ - Description of GetDocument. - -Args: - - - -Returns: - - None - - """ - pass - - - def EnumCodeContexts(self,) -> 'None': - """ - Description of EnumCodeContexts. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugDocumentHelper(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Init(self,pda:'Any',pszShortName:'Any',pszLongName:'Any',docAttr:'Any') -> 'None': - """ - Description of Init. - -Args: - - pda(Any):Description for pda - pszShortName(Any):Description for pszShortName - pszLongName(Any):Description for pszLongName - docAttr(Any):Description for docAttr - -Returns: - - None - - """ - pass - - - def Attach(self,pddhParent:'Any') -> 'None': - """ - Add the document to the doc tree - -Args: - - pddhParent(Any):Parent item. If none, this item is top level. - -Returns: - - None - - """ - pass - - - def Detach(self,) -> 'None': - """ - Description of Detach. - -Args: - - - -Returns: - - None - - """ - pass - - - def AddUnicodeText(self,pszText:'Any') -> 'None': - """ - Description of AddUnicodeText. - -Args: - - pszText(Any):Description for pszText - -Returns: - - None - - """ - pass - - - def AddDBCSText(self,) -> 'None': - """ - Description of AddDBCSText. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetDebugDocumentHost(self,pddh:'Any') -> 'None': - """ - Description of SetDebugDocumentHost. - -Args: - - pddh(Any):Description for pddh - -Returns: - - None - - """ - pass - - - def AddDeferredText(self,cChars:'Any',dwTextStartCookie:'Any') -> 'None': - """ - Description of AddDeferredText. - -Args: - - cChars(Any):Description for cChars - dwTextStartCookie(Any):Description for dwTextStartCookie - -Returns: - - None - - """ - pass - - - def DefineScriptBlock(self,ulCharOffset:'Any',cChars:'Any',pas:'Any',fScriptlet:'Any') -> 'None': - """ - Description of DefineScriptBlock. - -Args: - - ulCharOffset(Any):Description for ulCharOffset - cChars(Any):Description for cChars - pas(Any):Description for pas - fScriptlet(Any):Description for fScriptlet - -Returns: - - None - - """ - pass - - - def SetDefaultTextAttr(self,staTextAttr:'Any') -> 'None': - """ - Description of SetDefaultTextAttr. - -Args: - - staTextAttr(Any):Description for staTextAttr - -Returns: - - None - - """ - pass - - - def SetTextAttributes(self,ulCharOffset:'Any',obAttr:'Any') -> 'None': - """ - Description of SetTextAttributes. - -Args: - - ulCharOffset(Any):Description for ulCharOffset - obAttr(Any):A sequence of attributes. - -Returns: - - None - - """ - pass - - - def SetLongName(self,pszLongName:'Any') -> 'None': - """ - Description of SetLongName. - -Args: - - pszLongName(Any):Description for pszLongName - -Returns: - - None - - """ - pass - - - def SetShortName(self,pszShortName:'Any') -> 'None': - """ - Description of SetShortName. - -Args: - - pszShortName(Any):Description for pszShortName - -Returns: - - None - - """ - pass - - - def SetDocumentAttr(self,pszAttributes:'Any') -> 'None': - """ - Description of SetDocumentAttr. - -Args: - - pszAttributes(Any):Description for pszAttributes - -Returns: - - None - - """ - pass - - - def GetDebugApplicationNode(self,) -> 'None': - """ - Description of GetDebugApplicationNode. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetScriptBlockInfo(self,dwSourceContext:'Any') -> 'None': - """ - Description of GetScriptBlockInfo. - -Args: - - dwSourceContext(Any):Description for dwSourceContext - -Returns: - - None - - """ - pass - - - def CreateDebugDocumentContext(self,iCharPos:'Any',cChars:'Any') -> 'None': - """ - Description of CreateDebugDocumentContext. - -Args: - - iCharPos(Any):Description for iCharPos - cChars(Any):Description for cChars - -Returns: - - None - - """ - pass - - - def BringDocumentToTop(self,) -> 'None': - """ - Description of BringDocumentToTop. - -Args: - - - -Returns: - - None - - """ - pass - - - def BringDocumentContextToTop(self,pddc:'Any') -> 'None': - """ - Description of BringDocumentContextToTop. - -Args: - - pddc(Any):Description for pddc - -Returns: - - None - - """ - pass - - -class PyIDebugDocumentHost(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDeferredText(self,dwTextStartCookie:'Any',cMaxChars:'Any') -> 'None': - """ - Description of GetDeferredText. - -Args: - - dwTextStartCookie(Any):Description for dwTextStartCookie - cMaxChars(Any):Description for cMaxChars - -Returns: - - None - - """ - pass - - - def GetScriptTextAttributes(self,pstrCode:'Any',pstrDelimiter:'Any',dwFlags:'Any') -> 'None': - """ - Description of GetScriptTextAttributes. - -Args: - - pstrCode(Any):Description for pstrCode - pstrDelimiter(Any):Description for pstrDelimiter - dwFlags(Any):Description for dwFlags - -Returns: - - None - - """ - pass - - - def OnCreateDocumentContext(self,) -> 'None': - """ - Description of OnCreateDocumentContext. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPathName(self,) -> 'None': - """ - Description of GetPathName. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetFileName(self,) -> 'None': - """ - Description of GetFileName. - -Args: - - - -Returns: - - None - - """ - pass - - - def NotifyChanged(self,) -> 'None': - """ - Description of NotifyChanged. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugDocumentInfo(object): - """Provides information on a document, which may or may not be instantiated.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetName(self,) -> 'None': - """ - Returns the specified name for the document. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDocumentClassId(self,) -> 'PyIID': - """ - Returns a CLSID describing the document type. - -Args: - - - -Returns: - - PyIID - - """ - pass - - -class PyIDebugDocumentProvider(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDocument(self,) -> 'Any': - """ - Causes the document to be instantiated if it does - -not already exist. - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIDebugDocumentText(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDocumentAttributes(self,) -> 'None': - """ - Description of GetDocumentAttributes. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetSize(self,) -> 'None': - """ - Description of GetSize. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPositionOfLine(self,cLineNumber:'Any') -> 'None': - """ - Description of GetPositionOfLine. - -Args: - - cLineNumber(Any):Description for cLineNumber - -Returns: - - None - - """ - pass - - - def GetLineOfPosition(self,cCharacterPosition:'Any') -> 'None': - """ - Description of GetLineOfPosition. - -Args: - - cCharacterPosition(Any):Description for cCharacterPosition - -Returns: - - None - - """ - pass - - - def GetText(self,cCharacterPosition:'Any',cMaxChars:'Any',bWantAttr:'Any'=1) -> 'None': - """ - Description of GetText. - -Args: - - cCharacterPosition(Any): - cMaxChars(Any):Max chars to return - bWantAttr(Any):Should the attributes be returned? - -Returns: - - None - - """ - pass - - - def GetPositionOfContext(self,psc:'Any') -> 'None': - """ - Description of GetPositionOfContext. - -Args: - - psc(Any):Description for psc - -Returns: - - None - - """ - pass - - - def GetContextOfPosition(self,cCharacterPosition:'Any',cNumChars:'Any') -> 'None': - """ - Description of GetContextOfPosition. - -Args: - - cCharacterPosition(Any):Description for cCharacterPosition - cNumChars(Any):Description for cNumChars - -Returns: - - None - - """ - pass - - -class PyIDebugDocumentTextAuthor(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def InsertText(self,cCharacterPosition:'Any',cNumToInsert:'Any',pcharText:'Any') -> 'None': - """ - Description of InsertText. - -Args: - - cCharacterPosition(Any):Description for cCharacterPosition - cNumToInsert(Any):Description for cNumToInsert - pcharText(Any):Description for pcharText - -Returns: - - None - - """ - pass - - - def RemoveText(self,cCharacterPosition:'Any',cNumToRemove:'Any') -> 'None': - """ - Description of RemoveText. - -Args: - - cCharacterPosition(Any):Description for cCharacterPosition - cNumToRemove(Any):Description for cNumToRemove - -Returns: - - None - - """ - pass - - - def ReplaceText(self,cCharacterPosition:'Any',cNumToReplace:'Any',pcharText:'Any') -> 'None': - """ - Description of ReplaceText. - -Args: - - cCharacterPosition(Any):Description for cCharacterPosition - cNumToReplace(Any):Description for cNumToReplace - pcharText(Any):Description for pcharText - -Returns: - - None - - """ - pass - - -class PyIDebugDocumentTextEvents(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def onDestroy(self,) -> 'None': - """ - Description of onDestroy. - -Args: - - - -Returns: - - None - - """ - pass - - - def onInsertText(self,cCharacterPosition:'Any',cNumToInsert:'Any') -> 'None': - """ - Description of onInsertText. - -Args: - - cCharacterPosition(Any):Description for cCharacterPosition - cNumToInsert(Any):Description for cNumToInsert - -Returns: - - None - - """ - pass - - - def onRemoveText(self,cCharacterPosition:'Any',cNumToRemove:'Any') -> 'None': - """ - Description of onRemoveText. - -Args: - - cCharacterPosition(Any):Description for cCharacterPosition - cNumToRemove(Any):Description for cNumToRemove - -Returns: - - None - - """ - pass - - - def onReplaceText(self,cCharacterPosition:'Any',cNumToReplace:'Any') -> 'None': - """ - Description of onReplaceText. - -Args: - - cCharacterPosition(Any):Description for cCharacterPosition - cNumToReplace(Any):Description for cNumToReplace - -Returns: - - None - - """ - pass - - - def onUpdateTextAttributes(self,cCharacterPosition:'Any',cNumToUpdate:'Any') -> 'None': - """ - Description of onUpdateTextAttributes. - -Args: - - cCharacterPosition(Any):Description for cCharacterPosition - cNumToUpdate(Any):Description for cNumToUpdate - -Returns: - - None - - """ - pass - - - def onUpdateDocumentAttributes(self,textdocattr:'Any') -> 'None': - """ - Description of onUpdateDocumentAttributes. - -Args: - - textdocattr(Any):Description for textdocattr - -Returns: - - None - - """ - pass - - -class PyIDebugDocumentTextExternalAuthor(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPathName(self,) -> 'None': - """ - Description of GetPathName. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetFileName(self,) -> 'None': - """ - Description of GetFileName. - -Args: - - - -Returns: - - None - - """ - pass - - - def NotifyChanged(self,) -> 'None': - """ - Description of NotifyChanged. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugExpression(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Start(self,pdecb:'Any') -> 'None': - """ - Description of Start. - -Args: - - pdecb(Any):Description for pdecb - -Returns: - - None - - """ - pass - - - def Abort(self,) -> 'None': - """ - Description of Abort. - -Args: - - - -Returns: - - None - - """ - pass - - - def QueryIsComplete(self,) -> 'None': - """ - Description of QueryIsComplete. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetResultAsString(self,) -> 'None': - """ - Description of GetResultAsString. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetResultAsDebugProperties(self,) -> 'None': - """ - Description of GetResultAsDebugProperty. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugExpressionCallBack(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def onComplete(self,) -> 'None': - """ - Description of onComplete. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugExpressionContext(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ParseLanguageText(self,pstrCode:'Any',nRadix:'Any',pstrDelimiter:'Any',dwFlags:'Any') -> 'None': - """ - Description of ParseLanguageText. - -Args: - - pstrCode(Any):Description for pstrCode - nRadix(Any):Description for nRadix - pstrDelimiter(Any):Description for pstrDelimiter - dwFlags(Any):Description for dwFlags - -Returns: - - None - - """ - pass - - - def GetLanguageInfo(self,) -> 'None': - """ - Description of GetLanguageInfo. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugProperty(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPropertyInfo(self,dwFieldSpec:'Any',nRadix:'Any') -> 'None': - """ - Description of GetPropertyInfo. - -Args: - - dwFieldSpec(Any):Description for dwFieldSpec - nRadix(Any):Description for nRadix - -Returns: - - None - - """ - pass - - - def GetExtendedInfo(self,) -> 'None': - """ - Description of GetExtendedInfo. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetValueAsString(self,pszValue:'Any',nRadix:'Any') -> 'None': - """ - Description of SetValueAsString. - -Args: - - pszValue(Any):Description for pszValue - nRadix(Any):Description for nRadix - -Returns: - - None - - """ - pass - - - def EnumMembers(self,dwFieldSpec:'Any',nRadix:'Any',refiid:'PyIID') -> 'None': - """ - Description of EnumMembers. - -Args: - - dwFieldSpec(Any):Description for dwFieldSpec - nRadix(Any):Description for nRadix - refiid(PyIID):Description for refiid - -Returns: - - None - - """ - pass - - - def GetParent(self,) -> 'None': - """ - Description of GetParent. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugSessionProvider(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def StartDebugSession(self,pda:'Any') -> 'None': - """ - Description of StartDebugSession. - -Args: - - pda(Any):Description for pda - -Returns: - - None - - """ - pass - - -class PyIDebugStackFrame(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetCodeContext(self,) -> 'None': - """ - Returns the current code context associated with the stack frame. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDescriptionString(self,fLong:'Any') -> 'Any': - """ - Returns a short or long textual description of the - -stack frame. - -Args: - - fLong(Any):If false, provide only the name of the function associated with the stack frame. When true it may also provide the parameter(s) to the function or whatever else is relevant. - -Returns: - - Any - - """ - pass - - - def GetLanguageString(self,fLong:'Any') -> 'Any': - """ - Returns a short or long textual description of the - -language. - -Args: - - fLong(Any):If False, just the language name should be provided, eg, "Python". If True a full product description may be provided (eg, "Python 1.4 ActiveX Debugging Host") - -Returns: - - Any - - """ - pass - - - def GetThread(self,) -> 'Any': - """ - Returns the thread associated with this stack - -frame. - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIDebugStackFrameSniffer(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def EnumStackFrames(self,) -> 'None': - """ - Description of EnumStackFrames. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugStackFrameSnifferEx(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def EnumStackFramesEx(self,) -> 'None': - """ - Description of EnumStackFrames. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugSyncOperation(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetTargetThread(self,) -> 'None': - """ - Description of GetTargetThread. - -Args: - - - -Returns: - - None - - """ - pass - - - def Execute(self,) -> 'None': - """ - Description of Execute. - -Args: - - - -Returns: - - None - - """ - pass - - - def InProgressAbort(self,) -> 'None': - """ - Description of InProgressAbort. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDefaultExtractIconInit(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetFlags(self,uFlags:'Any') -> 'None': - """ - Description of SetFlags. - -Args: - - uFlags(Any):Description for uFlags - -Returns: - - None - - """ - pass - - - def SetKey(self,hkey:'PyHKEY') -> 'None': - """ - Description of SetKey. - -Args: - - hkey(PyHKEY):Description for hkey - -Returns: - - None - - """ - pass - - - def SetNormalIcon(self,pszFile:'Any',iIcon:'Any') -> 'None': - """ - Description of SetNormalIcon. - -Args: - - pszFile(Any):Description for pszFile - iIcon(Any):Description for iIcon - -Returns: - - None - - """ - pass - - - def SetOpenIcon(self,pszFile:'Any',iIcon:'Any') -> 'None': - """ - Description of SetOpenIcon. - -Args: - - pszFile(Any):Description for pszFile - iIcon(Any):Description for iIcon - -Returns: - - None - - """ - pass - - - def SetShortcutIcon(self,pszFile:'Any',iIcon:'Any') -> 'None': - """ - Description of SetShortcutIcon. - -Args: - - pszFile(Any):Description for pszFile - iIcon(Any):Description for iIcon - -Returns: - - None - - """ - pass - - - def SetDefaultIcon(self,pszFile:'Any',iIcon:'Any') -> 'None': - """ - Description of SetDefaultIcon. - -Args: - - pszFile(Any):Description for pszFile - iIcon(Any):Description for iIcon - -Returns: - - None - - """ - pass - - -class PyIDirectSound(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,guid:'PyIID') -> 'None': - """ - Description of Initialize. - -Args: - - guid(PyIID):Globally unique identifier (GUID) specifying the sound driver to which this DirectSound object binds. Pass None to select the primary sound driver. - -Returns: - - None - - """ - pass - - - def SetCooperativeLevel(self,hwnd:'Any',level:'Any') -> 'None': - """ - The IDirectSound::SetCooperativeLevel method sets the cooperative level - -of the application for this sound device. - -Args: - - hwnd(Any):Window handle to the application or None. - level(Any):Requested priority level. Specify one of the following values:LevelDescriptionDSSCL_NORMALSets the application to a fully cooperative status. Most applications should use this level, because it has the smoothest multitasking and resource-sharing behavior.DSSCL_PRIORITYSets the application to the priority level. Applications with this cooperative level can call the DirectSoundBuffer.setFormat and DirectSound.compact methods.DSSCL_EXCLUSIVESets the application to the exclusive level. When it has the input focus, the application will be the only one audible (sounds from applications with the DSBCAPS_GLOBALFOCUS flag set will be muted). With this level, it also has all the privileges of the DSSCL_PRIORITY level. DirectSound will restore the hardware format, as specified by the most recent call to the DirectSoundBuffer.setFormat method, once the application gains the input focus. (Note that DirectSound will always restore the wave format, no matter what priority level is set.)DSSCL_WRITEPRIMARYThis is the highest priority level. The application has write access to the primary sound buffers. No secondary sound buffers in any application can be played. - -Returns: - - None - - """ - pass - - - def CreateSoundBuffer(self,lpDSCBufferDesc:'Any',unk:'Any'=None) -> 'None': - """ - The IDirectSound::CreateSoundBuffer method creates a DirectSoundBuffer - -object to hold a sequence of audio samples. - -Args: - - lpDSCBufferDesc(Any):a DSBUFFERDESC structure containing values for the sound buffer being created. - unk(Any):The IUnknown for COM aggregation. - -Returns: - - None - - """ - pass - - - def GetCaps(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def Compact(self,) -> 'None': - """ - 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. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDirectSoundBuffer(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,) -> 'None': - """ - Description of Initialize. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetStatus(self,) -> 'None': - """ - Retrieves the current status of the sound buffer. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCaps(self,) -> 'None': - """ - Retrieves the capabilities of the DirectSoundBuffer object as a DSBCAPS - -object. - -Args: - - - -Returns: - - None - - """ - pass - - - def Restore(self,) -> 'None': - """ - Restores the memory allocation for a lost sound buffer for the specified - -DirectSoundBuffer object. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCurrentPosition(self,) -> 'None': - """ - Description of GetCurrentPosition. - -Args: - - - -Returns: - - None - - """ - pass - - - def Play(self,) -> 'None': - """ - Description of Play. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetCurrentPosition(self,) -> 'None': - """ - Description of SetCurrentPosition. - -Args: - - - -Returns: - - None - - """ - pass - - - def Stop(self,) -> 'None': - """ - Description of Stop. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetFrequency(self,) -> 'None': - """ - Description of GetFrequency. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPan(self,) -> 'None': - """ - Description of GetPan. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetVolume(self,) -> 'None': - """ - Description of GetVolume. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetFrequency(self,) -> 'None': - """ - Description of SetFrequency. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetPan(self,) -> 'None': - """ - Description of SetPan. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetVolume(self,) -> 'None': - """ - Description of SetVolume. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDirectSoundCapture(object): - """The methods of the IDirectSoundCapture interface are used to create sound capture - -buffers.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,) -> 'None': - """ - Not normally called directly. Use DirectSoundCaptureCreate instead. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCaps(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDirectSoundCaptureBuffer(object): - """The methods of the IDirectSoundCaptureBuffer interface are used to manipulate - -sound capture buffers.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,) -> 'None': - """ - Not normally used. Used IDirectSoundCapture.CreateCaptureBuffer - -instead. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetStatus(self,) -> 'None': - """ - Retrieves the current status of the sound capture buffer. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCurrentPosition(self,) -> 'None': - """ - 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 - -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. - -Args: - - - -Returns: - - None - - """ - pass - - - def Stop(self,) -> 'None': - """ - 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 - -effect. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDirectSoundNotify(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIDirectoryObject(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetObjectInformation(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetObjectAttributes(self,names:'Tuple[str, ...]') -> 'Tuple[Any, ...]': - """ - None - -Args: - - names(Tuple[str, ...]): - -Returns: - - Tuple[Any, ...] - - """ - pass - - - def SetObjectAttributes(self,attrs:'Tuple[Any, ...]') -> 'Any': - """ - None - -Args: - - attrs(Tuple[Any, ...]):The attributes to set - -Returns: - - Any - - """ - pass - - - def CreateDSObject(self,rdn:'str',attrs:'Tuple[Any, ...]') -> 'Any': - """ - None - -Args: - - rdn(str):The relative distinguished name (relative path) of the object to be created. - attrs(Tuple[Any, ...]):The attributes to set. - -Returns: - - Any - - """ - pass - - - def DeleteDSObject(self,rdn:'str') -> 'None': - """ - Deletes a leaf object in a directory tree - -Args: - - rdn(str):The relative distinguished name (relative path) of the object to be deleted. - -Returns: - - None - - """ - pass - - -class PyIDirectorySearch(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetSearchPreference(self,prefs:'Any') -> 'Tuple[Any, Any, Any]': - """ - None - -Args: - - prefs(Any):Return ValueThe result is the hresult of the call, and a list of integer status codes for each of the preferences set. - -Returns: - - Tuple[Any, Any, Any]:Return ValueThe result is the hresult of the call, and a list of integer status - -codes for each of the preferences set. - - - """ - pass - - - def ExecuteSearch(self,_filter:'str',attrNames:'List[str]') -> 'Any': - """ - None - -Args: - - _filter(str): - attrNames(List[str]):Return ValueThe result is an integer search handle. PyIDirectorySearch::CloseSearchHandle should be called to close the handle. - -Returns: - - Any:Return ValueThe result is an integer search handle. PyIDirectorySearch::CloseSearchHandle - -should be called to close the handle. - - - """ - pass - - - def GetNextRow(self,handle:'Any') -> 'Any': - """ - None - -Args: - - handle(Any):Return ValueThe result is the HRESULT from the call - no exceptions are thrown - -Returns: - - Any:Return ValueThe result is the HRESULT from the call - no exceptions are thrown - - - """ - pass - - - def GetFirstRow(self,handle:'Any') -> 'Any': - """ - None - -Args: - - handle(Any):Return ValueThe result is the HRESULT from the call - no exceptions are thrown - -Returns: - - Any:Return ValueThe result is the HRESULT from the call - no exceptions are thrown - - - """ - pass - - - def GetPreviousRow(self,handle:'Any') -> 'Any': - """ - None - -Args: - - handle(Any):Return ValueThe result is the HRESULT from the call - no exceptions are thrown - -Returns: - - Any:Return ValueThe result is the HRESULT from the call - no exceptions are thrown - - - """ - pass - - - def CloseSearchHandle(self,handle:'Any') -> 'None': - """ - Closes a previously opened search handle. - -Args: - - handle(Any): - -Returns: - - None - - """ - pass - - - def AdandonSearch(self,handle:'Any') -> 'None': - """ - None - -Args: - - handle(Any): - -Returns: - - None - - """ - pass - - - def GetColumn(self,handle:'Any',name:'str') -> 'Tuple[Any, Any, Any]': - """ - None - -Args: - - handle(Any):Handle to a search - name(str):The column name to fetch - -Returns: - - Tuple[Any, Any, Any] - - """ - pass - - - def GetNextColumnName(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None:PyIDirectorySearch.GetNextColumnName -GetNextColumnName() -Return ValueReturns None when the underlying ADSI function return S_ADS_NOMORE_COLUMNS. - - - """ - pass - - -class PyIDispatch(object): - """A OLE automation client object.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Invoke(self,dispid:'Any',lcid:'Any',flags:'Any',bResultWanted:'Any',arg:'Tuple[Any, ...]') -> 'Any': - """ - Invokes a DISPID, using the passed arguments. - -Args: - - dispid(Any):The dispid to use. Typically this value will come from PyIDispatch::GetIDsOfNames or from a type library. - lcid(Any):The locale id to use. - flags(Any):The flags for the call. The following flags can be used.FlagDescriptionDISPATCH_METHODThe member is invoked as a method. If a property has the same name, both this and the DISPATCH_PROPERTYGET flag may be set.DISPATCH_PROPERTYGETThe member is retrieved as a property or data member.DISPATCH_PROPERTYPUTThe member is changed as a property or data member.DISPATCH_PROPERTYPUTREFThe member is changed by a reference assignment, rather than a value assignment. This flag is valid only when the property accepts a reference to an object. - bResultWanted(Any):Indicates if the result of the call should be requested. - arg(Tuple[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) - -Returns: - - 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 - - - def InvokeTypes(self,dispid:'Any',lcid:'Any',wFlags:'Any',resultTypeDesc:'Any',typeDescs:'Tuple[Any, ...]',args:'Tuple[Any, ...]') -> 'Any': - """ - Invokes a DISPID, using the passed arguments and type descriptions. - -Args: - - dispid(Any):The dispid to use. Please see PyIDispatch::Invoke. - lcid(Any):The locale ID. Please see PyIDispatch::Invoke. - wFlags(Any):Flags for the call. Please see PyIDispatch::Invoke. - resultTypeDesc(Any):A tuple describing the type of the result. See the comments for more information. - typeDescs(Tuple[Any, ...]):A sequence of tuples describing the types of the parameters for the function. See the comments for more information. - args(Tuple[Any, ...]):The args to the function.CommentsThe Microsoft documentation for IDispatch should be used for all params except 'resultTypeDesc' and 'typeDescs'. 'resultTypeDesc' describes the return value of the function, and is a tuple of (type_id, flags). 'typeDescs' describes the type of each parameters, and is a list of the same (type_id, flags) tuple.itemDescriptiontype_idA valid "variant type" constant (eg, VT_I4 | VT_ARRAY, VT_DATE, etc - see VARIANT at MSDN).flagsOne of the PARAMFLAG constants (eg, PARAMFLAG_FIN, PARAMFLAG_FOUT etc - see PARAMFLAG at MSDN).ExampleAn example from the makepy generated file for Wordclass Cells(DispatchBaseClass):... def SetWidth(self, ColumnWidth=..., RulerStyle=...): return self._oleobj_.InvokeTypes(202, LCID, 1, (24, 0), ((4, 1), (3, 1)),...)The interesting bits areresultTypeDesc: (24, 0) - (VT_VOID, <no flags>)typeDescs: ((4, 1), (3, 1)) - ((VT_R4, PARAMFLAG_FIN), (VT_I4, PARAMFLAG_FIN))So, in this example, the function returns no value and takes 2 "in" params - ColumnWidth is a float, and RulerStule is an int. - -Returns: - - Any - - """ - pass - - - def GetIDsOfNames(self,name:'str',arg:'Any') -> 'Tuple[Any, Union[Any]]': - """ - Get the DISPID for the passed names. - -Args: - - name(str):A name to query forAlternative Parameters - arg(Any):A sequence of string names to queryCommentsCurrently 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 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. - -Returns: - - Tuple[Any, Union[Any]]:A sequence of string names to query -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 - -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 - - - def GetTypeInfo(self,locale:'Any',index:'Any'=0) -> 'Any': - """ - Get type information for the object. - -Args: - - locale(Any):The locale to use. - index(Any):The index of the typelibrary to fetch. Note that these params are reversed from the win32 call. - -Returns: - - Any - - """ - pass - - - def GetTypeInfoCount(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIDispatchEx(object): - """A OLE automation client object that uses the IDispatchEx scripting interface..""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDispID(self,name:'str',fdex:'Any') -> 'Any': - """ - Returns the member id for a name - -Args: - - name(str):Passed in name to be mapped - fdex(Any):Determines the options for obtaining the member identifier. This can be a combination of the fdex* constants: - -Returns: - - Any - - """ - pass - - - def InvokeEx(self,dispid:'Any',lcid:'Any',flags:'Any',args:'List[Any]',types:'List[Any]'=None,returnDesc:'Any'=1,serviceProvider:'Any'=None) -> 'Any': - """ - None - -Args: - - dispid(Any): - lcid(Any): - flags(Any): - args(List[Any]):The arguments. - types(List[Any]):A tuple of type description object, or None if type descriptions are not available. - returnDesc(Any):If types==None, should be a BOOL indicating if the result is needed. If types is a tuple, then should a be type description. - serviceProvider(Any):A service provider object supplied by the caller which allows the object to obtain services from the caller. Can be None. - -Returns: - - Any - - """ - pass - - - def DeleteMemberByName(self,name:'str',fdex:'Any') -> 'None': - """ - None - -Args: - - name(str):Passed in name to be mapped - fdex(Any):Determines the options - -Returns: - - None - - """ - pass - - - def DeleteMemberByDispID(self,dispid:'Any') -> 'None': - """ - None - -Args: - - dispid(Any): - -Returns: - - None - - """ - pass - - - def GetMemberProperties(self,dispid:'Any',fdex:'Any') -> 'Any': - """ - Returns mask of fdex* flags describing a member - -Args: - - dispid(Any):The member id - fdex(Any):fdex* flags specifying which properties to return - -Returns: - - Any - - """ - pass - - - def GetMemberName(self,dispid:'Any') -> 'Any': - """ - Returns the name associated with a member id - -Args: - - dispid(Any):The member id - -Returns: - - Any - - """ - pass - - - def GetNextDispID(self,fdex:'Any',dispid:'Any') -> 'Any': - """ - Enumerates member ids. - -Args: - - fdex(Any):Determines the options - dispid(Any):Current member, or DISPID_STARTENUM to begin enumeration. GetNextDispID will retrieve the item in the enumeration after this one. - -Returns: - - Any - - """ - pass - - -class PyIDisplayItem(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIDocHostUIHandler(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ShowContextMenu(self,dwID:'Any',pt:'Tuple[Any, Any]',pcmdtReserved:'Any',pdispReserved:'Any') -> 'None': - """ - Description of ShowContextMenu. - -Args: - - dwID(Any):Description for dwID - pt(Tuple[Any, Any]):Description for ppt - pcmdtReserved(Any):Description for pcmdtReserved - pdispReserved(Any):Description for pdispReserved - -Returns: - - None - - """ - pass - - - def GetHostInfo(self,) -> 'None': - """ - Description of GetHostInfo. - -Args: - - - -Returns: - - None - - """ - pass - - - def ShowUI(self,dwID:'Any',pActiveObject:'Any',pCommandTarget:'Any',pFrame:'Any',pDoc:'Any') -> 'None': - """ - Description of ShowUI. - -Args: - - dwID(Any):Description for dwID - pActiveObject(Any):Description for pActiveObject - pCommandTarget(Any):Description for pCommandTarget - pFrame(Any):Description for pFrame - pDoc(Any):Description for pDoc - -Returns: - - None - - """ - pass - - - def HideUI(self,) -> 'None': - """ - Description of HideUI. - -Args: - - - -Returns: - - None - - """ - pass - - - def UpdateUI(self,) -> 'None': - """ - Description of UpdateUI. - -Args: - - - -Returns: - - None - - """ - pass - - - def EnableModeless(self,fEnable:'Any') -> 'None': - """ - Description of EnableModeless. - -Args: - - fEnable(Any):Description for fEnable - -Returns: - - None - - """ - pass - - - def OnDocWindowActivate(self,fActivate:'Any') -> 'None': - """ - Description of OnDocWindowActivate. - -Args: - - fActivate(Any):Description for fActivate - -Returns: - - None - - """ - pass - - - def OnFrameWindowActivate(self,fActivate:'Any') -> 'None': - """ - Description of OnFrameWindowActivate. - -Args: - - fActivate(Any):Description for fActivate - -Returns: - - None - - """ - pass - - - def ResizeBorder(self,prcBorder:'Tuple[Any, Any, Any, Any]',pUIWindow:'Any',fRameWindow:'Any') -> 'None': - """ - Description of ResizeBorder. - -Args: - - prcBorder(Tuple[Any, Any, Any, Any]):Description for prcBorder - pUIWindow(Any):Description for pUIWindow - fRameWindow(Any):Description for fRameWindow - -Returns: - - None - - """ - pass - - - def TranslateAccelerator(self,lpMsg:'Any',pguidCmdGroup:'PyIID',nCmdID:'Any') -> 'None': - """ - Description of TranslateAccelerator. - -Args: - - lpMsg(Any):Description for lpMsg - pguidCmdGroup(PyIID):Description for pguidCmdGroup - nCmdID(Any):Description for nCmdID - -Returns: - - None - - """ - pass - - - def GetOptionKeyPath(self,dw:'Any') -> 'None': - """ - Description of GetOptionKeyPath. - -Args: - - dw(Any):Description for dw - -Returns: - - None - - """ - pass - - - def GetDropTarget(self,pDropTarget:'Any') -> 'None': - """ - Description of GetDropTarget. - -Args: - - pDropTarget(Any):Description for pDropTarget - -Returns: - - None - - """ - pass - - - def GetExternal(self,) -> 'None': - """ - Description of GetExternal. - -Args: - - - -Returns: - - None - - """ - pass - - - def TranslateUrl(self,dwTranslate:'Any',pchURLIn:'Any') -> 'None': - """ - Description of TranslateUrl. - -Args: - - dwTranslate(Any):Description for dwTranslate - pchURLIn(Any):Description for pchURLIn - -Returns: - - None - - """ - pass - - - def FilterDataObject(self,pDO:'Any') -> 'None': - """ - Description of FilterDataObject. - -Args: - - pDO(Any):Description for pDO - -Returns: - - None - - """ - pass - - -class PyIDropSource(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def QueryContinueDrag(self,fEscapePressed:'Any',grfKeyState:'Any') -> 'None': - """ - Description of QueryContinueDrag. - -Args: - - fEscapePressed(Any):Description for fEscapePressed - grfKeyState(Any):Description for grfKeyState - -Returns: - - None - - """ - pass - - - def GiveFeedback(self,dwEffect:'Any') -> 'None': - """ - Description of GiveFeedback. - -Args: - - dwEffect(Any):Description for dwEffect - -Returns: - - None - - """ - pass - - -class PyIDropTarget(object): - """Interface that acts as a target of OLE drag and drop operations""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def DragEnter(self,pDataObj:'Any',grfKeyState:'Any',pt:'Tuple[Any, Any]',pdwEffect:'Any') -> 'Any': - """ - Called when an object is initially dragged into a window - -Args: - - pDataObj(Any):IDataObject interface that contains the object being dragged - grfKeyState(Any):Combination of win32con.MK_* flags containing keyboard modifier state - pt(Tuple[Any, Any]):(x,y) Screen coordinates of cursor - pdwEffect(Any):shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return a shellcon.DROPEFFECT_* value indicating if the object can be accepted - -Returns: - - Any:shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return a shellcon.DROPEFFECT_* value indicating if the object can - -be accepted - - - """ - pass - - - def DragOver(self,grfKeyState:'Any',pt:'Tuple[Any, Any]',pdwEffect:'Any') -> 'Any': - """ - Called as the dragged object moves over the window - -Args: - - grfKeyState(Any):Combination of win32con.MK_* flags containing keyboard modifier state - pt(Tuple[Any, Any]):(x,y) Screen coordinates of cursor - pdwEffect(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 - -Returns: - - 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 - - - def DragLeave(self,) -> 'None': - """ - Called as the object is dragged back out of the window - -Args: - - - -Returns: - - None - - """ - pass - - - def Drop(self,pDataObj:'Any',grfKeyState:'Any',pt:'Tuple[Any, Any]',dwEffect:'Any') -> 'Any': - """ - Called when the object is dropped onto the window - -Args: - - pDataObj(Any):IDataObject interface containing the dropped object - grfKeyState(Any):Combination of win32con.MK_* flags containing keyboard modifier state - pt(Tuple[Any, Any]):(x,y) Screen coordinates of cursor - dwEffect(Any):shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return one of the shellcon.DROPEFFECT_* values - -Returns: - - Any:shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return one of the shellcon.DROPEFFECT_* values - - - """ - pass - - -class PyIDropTargetHelper(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def DragEnter(self,hwnd:'int',pDataObj:'Any',pt:'Tuple[Any, Any]',dwEffect:'Any') -> 'None': - """ - Description of DragEnter. - -Args: - - hwnd(int):Handle to target window - pDataObj(Any):Object that is dragged onto the window - pt(Tuple[Any, Any]):Coordinates where drag operation entered the window - dwEffect(Any):One of shellcon.DROPEFFECT_* values - -Returns: - - None - - """ - pass - - - def DragOver(self,hwnd:'Any',pt:'Tuple[Any, Any]',pdwEffect:'Any') -> 'None': - """ - Description of DragOver. - -Args: - - hwnd(Any): - pt(Tuple[Any, Any]):Description for pt - pdwEffect(Any):Description for pdwEffect - -Returns: - - None - - """ - pass - - - def DragLeave(self,) -> 'None': - """ - Description of DragLeave. - -Args: - - - -Returns: - - None - - """ - pass - - - def Drop(self,pDataObj:'Any',pt:'Tuple[Any, Any]',dwEffect:'Any') -> 'None': - """ - Description of Drop. - -Args: - - pDataObj(Any):Description for pDataObj - pt(Tuple[Any, Any]):Description for pt - dwEffect(Any):Description for dwEffect - -Returns: - - None - - """ - pass - - -class PyIDsObjectPicker(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,targetComputer:'str',scopeInfos:'Any',options:'Any'=0,attrNames:'List[str]'=None) -> 'None': - """ - Initializes the IDsObjectPicker interface with information about the scopes, filters, and options used by the object picker dialog box. - -Args: - - targetComputer(str): - scopeInfos(Any): - options(Any): - attrNames(List[str]): - -Returns: - - None - - """ - pass - - - def InvokeDialog(self,hwnd:'Any') -> 'Any': - """ - Displays a modal object picker dialog box and returns the user's selections. - -Args: - - hwnd(Any): - -Returns: - - Any - - """ - pass - - -class PyIEmptyVolumeCache(object): - """Used for cleaning up temporary file ("disk cleanup")""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIEmptyVolumeCache2(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIEmptyVolumeCacheCallBack(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ScanProgress(self,dwlSpaceUsed:'Any',dwFlags:'Any',pcwszStatus:'Any') -> 'None': - """ - Description of ScanProgress. - -Args: - - dwlSpaceUsed(Any):Description for dwlSpaceUsed - dwFlags(Any):Description for dwFlags - pcwszStatus(Any):Description for pcwszStatus - -Returns: - - None - - """ - pass - - - def PurgeProgress(self,dwlSpaceFreed:'Any',spaceFreed:'Any',spaceToFree:'Any',flags:'Any',status:'Any') -> 'None': - """ - Description of PurgeProgress. - -Args: - - dwlSpaceFreed(Any):Description for dwlSpaceFreed - spaceFreed(Any): - spaceToFree(Any): - flags(Any): - status(Any): - -Returns: - - None - - """ - pass - - -class PyIEnumCATEGORYINFO(object): - """A Python interface to IEnumCATEGORYINFO""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'Any'=1) -> 'Tuple[Tuple[PyIID, Any, str], ...]': - """ - Retrieves a specified number of items in the - -enumeration sequence. - -Args: - - num(Any):Number of items to retrieve.Return ValueThe result is a tuple of (IID object, LCID, string description) tuples, one for each element returned. - -Returns: - - Tuple[Tuple[PyIID, Any, str], ...]:Number of items to retrieve. -Return ValueThe result is a tuple of (IID object, LCID, string description) tuples, - -one for each element returned. - - - """ - pass - - - def Skip(self,num:'Any') -> 'None': - """ - Skips over the next specified elementes. - -Args: - - num(Any):The number of elements being requested. - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIEnumConnectionPoints(object): - """A Python interface to IEnumConnectionPoints""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'Any'=1) -> 'Tuple[Any, ...]': - """ - Retrieves a specified number of items in the - -enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Tuple[Any, ...] - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIEnumConnections(object): - """A Python interface to IEnumConnections""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'Any'=1) -> 'Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIEnumContextProps(object): - """A Python interface to IEnumContextProps""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'Any'=1) -> 'Tuple[Tuple[PyIID, Any, Any], ...]': - """ - Retrieves a specified number of items in - -the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve.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 property value - -Returns: - - Tuple[Tuple[PyIID, Any, Any], ...]:Number of items to retrieve. -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 - -property value - - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIEnumDebugApplicationNodes(object): - """A Python interface to IEnumDebugApplicationNodes""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'Any'=1) -> 'Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'Any': - """ - Creates another enumerator that - -contains the same enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIEnumDebugCodeContexts(object): - """A Python interface to IEnumDebugCodeContexts""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'Any'=1) -> 'Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the - -same enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIEnumDebugExpressionContexts(object): - """A Python interface to IEnumDebugExpressionContexts""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'Any'=1) -> 'Any': - """ - Retrieves a specified number of items in the enumeration - -sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'Any': - """ - Creates another enumerator that - -contains the same enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIEnumDebugPropertyInfo(object): - """A Python interface to IEnumDebugPropertyInfo""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'Any'=1) -> 'Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the - -same enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetCount(self,) -> 'Any': - """ - Obtains the number of items - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIEnumDebugStackFrames(object): - """A Python interface to IEnumDebugStackFrames""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'Any'=1) -> 'Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIEnumExplorerCommand(object): - """A Python interface to IEnumExplorerCommand""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'Any'=1) -> 'Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIEnumFORMATETC(object): - """A Python interface to IEnumFORMATETC""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'Any'=1) -> 'Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same enumeration - -state as the current one - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIEnumGUID(object): - """A Python interface to IEnumGUID""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'Any'=1) -> 'Tuple[PyIID, ...]': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve.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 an error condition - an empty tuple is simply returned. - -Returns: - - Tuple[PyIID, ...]:Number of items to retrieve. -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 - -an error condition - an empty tuple is simply returned. - - - """ - pass - - - def Skip(self,num:'Any') -> 'None': - """ - Skips over the next specified elementes. - -Args: - - num(Any):The number of elements being requested. - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same enumeration state as - -the current one - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIEnumIDList(object): - """A Python interface to IEnumIDList""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'Any'=1) -> 'Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same enumeration state - -as the current one - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIEnumMoniker(object): - """A Python interface to IEnumMoniker""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'Any'=1) -> 'Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve.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 an error condition - an empty tuple is simply returned. - -Returns: - - Any:Number of items to retrieve. -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 - -an error condition - an empty tuple is simply returned. - - - """ - pass - - - def Skip(self,num:'Any') -> 'None': - """ - Skips over the next specified elementes. - -Args: - - num(Any):The number of elements being requested. - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same enumeration state - -as the current one - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIEnumObjects(object): - """Iterates through a number of arbitrary interfaces""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,riid:'PyIID',num:'Any'=1) -> 'Tuple[Any, ...]': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - riid(PyIID):The interfaces to return - num(Any):Number of items to retrieve. - -Returns: - - Tuple[Any, ...] - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same enumeration state - -as the current one - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIEnumRemoteDebugApplicationThreads(object): - """A Python interface to IEnumRemoteDebugApplicationThreads""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'Any'=1) -> 'Any': - """ - Retrieves a specified number of items in the enumeration - -sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'Any': - """ - Creates another - -enumerator that contains the same enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIEnumRemoteDebugApplications(object): - """A Python interface to IEnumRemoteDebugApplications""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'Any'=1) -> 'Any': - """ - Retrieves a specified number of items in the enumeration - -sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'Any': - """ - Creates another enumerator that - -contains the same enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIEnumResources(object): - """A Python interface to IEnumResources""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'Any'=1) -> 'Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same enumeration - -state as the current one - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIEnumSTATPROPSETSTG(object): - """A Python interface to IEnumSTATPROPSETSTG""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'Any'=1) -> 'Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIEnumSTATPROPSTG(object): - """A Python interface to IEnumSTATPROPSTG""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'Any'=1) -> 'Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIEnumSTATSTG(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'Any'=1) -> 'Tuple[Any, ...]': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Tuple[Any, ...] - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same enumeration state - -as the current one - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIEnumShellItems(object): - """A Python interface to IEnumShellItems""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'Any'=1) -> 'Tuple[Any, ...]': - """ - Retrieves a specified number of items in the enumeration - -sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Tuple[Any, ...] - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same enumeration - -state as the current one - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIEnumString(object): - """An enumerator interface to list strings""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'Any'=1) -> 'Tuple[str, ...]': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Tuple[str, ...] - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'Any': - """ - Creates another enumerator that contains the same enumeration state - -as the current one - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIErrorLog(object): - """A Python wrapper for a COM IErrorLog interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddError(self,propName:'str',excepInfo:'Any'=None) -> 'None': - """ - Adds an error to the error log. - -Args: - - propName(str):The name of the error - excepInfo(Any):A COM exception. Must be a complete COM exception (ie, pythoncom.com_error, or win32com.server.exceptions.COMException()) - -Returns: - - None - - """ - pass - - -class PyIExplorerBrowser(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,hwndParent:'Any',prc:'PyRECT',pfs:'Any') -> 'None': - """ - Description of Initialize. - -Args: - - hwndParent(Any):Description for hwndParent - prc(PyRECT):Description for prc - pfs(Any):Description for pfs - -Returns: - - None - - """ - pass - - - def Destroy(self,) -> 'None': - """ - Description of Destroy. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetRect(self,hdwp:'Any',rcBrowser:'PyRECT') -> 'int': - """ - Description of SetRect. - -Args: - - hdwp(Any):Description for phdwp - rcBrowser(PyRECT):Description for rcBrowser - -Returns: - - int - - """ - pass - - - def SetPropertyBag(self,PropertyBag:'Any') -> 'None': - """ - Description of SetPropertyBag. - -Args: - - PropertyBag(Any):Description for pszPropertyBag - -Returns: - - None - - """ - pass - - - def SetEmptyText(self,EmptyText:'Any') -> 'None': - """ - Description of SetEmptyText. - -Args: - - EmptyText(Any):Description for pszEmptyText - -Returns: - - None - - """ - pass - - - def SetFolderSettings(self,pfs:'Any') -> 'None': - """ - Description of SetFolderSettings. - -Args: - - pfs(Any):Description for pfs - -Returns: - - None - - """ - pass - - - def Advise(self,psbe:'Any') -> 'Any': - """ - Description of Advise. - -Args: - - psbe(Any):Description for psbe - -Returns: - - Any - - """ - pass - - - def Unadvise(self,dwCookie:'Any') -> 'None': - """ - Description of Unadvise. - -Args: - - dwCookie(Any):Description for dwCookie - -Returns: - - None - - """ - pass - - - def SetOptions(self,dwFlag:'Any') -> 'None': - """ - Description of SetOptions. - -Args: - - dwFlag(Any):Description for dwFlag - -Returns: - - None - - """ - pass - - - def GetOptions(self,) -> 'Any': - """ - Description of GetOptions. - -Args: - - - -Returns: - - Any - - """ - pass - - - def BrowseToIDList(self,pidl:'Any',uFlags:'Any') -> 'None': - """ - Description of BrowseToIDList. - -Args: - - pidl(Any):Description for pidl - uFlags(Any):Description for uFlags - -Returns: - - None - - """ - pass - - - def BrowseToObject(self,punk:'Any',uFlags:'Any') -> 'None': - """ - Description of BrowseToObject. - -Args: - - punk(Any):Description for punk - uFlags(Any):Description for uFlags - -Returns: - - None - - """ - pass - - - def FillFromObject(self,punk:'Any',dwFlags:'Any') -> 'None': - """ - Description of FillFromObject. - -Args: - - punk(Any):Description for punk - dwFlags(Any):Description for dwFlags - -Returns: - - None - - """ - pass - - - def RemoveAll(self,) -> 'None': - """ - Description of RemoveAll. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCurrentView(self,riid:'PyIID') -> 'Any': - """ - Description of GetCurrentView. - -Args: - - riid(PyIID):Description for riid - -Returns: - - Any - - """ - pass - - -class PyIExplorerBrowserEvents(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OnNavigationPending(self,pidlFolder:'Any') -> 'None': - """ - Description of OnNavigationPending. - -Args: - - pidlFolder(Any):Description for pidlFolder - -Returns: - - None - - """ - pass - - - def OnViewCreated(self,psv:'Any') -> 'None': - """ - Description of OnViewCreated. - -Args: - - psv(Any):Description for psv - -Returns: - - None - - """ - pass - - - def OnNavigationComplete(self,pidlFolder:'Any') -> 'None': - """ - Description of OnNavigationComplete. - -Args: - - pidlFolder(Any):Description for pidlFolder - -Returns: - - None - - """ - pass - - - def OnNavigationFailed(self,pidlFolder:'Any') -> 'None': - """ - Description of OnNavigationFailed. - -Args: - - pidlFolder(Any):Description for pidlFolder - -Returns: - - None - - """ - pass - - -class PyIExplorerCommand(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetTitle(self,psiItemArray:'Any') -> 'Any': - """ - Description of GetTitle. - -Args: - - psiItemArray(Any):Description for psiItemArray - -Returns: - - Any - - """ - pass - - - def GetIcon(self,psiItemArray:'Any') -> 'Any': - """ - Description of GetIcon. - -Args: - - psiItemArray(Any):Description for psiItemArray - -Returns: - - Any - - """ - pass - - - def GetToolTip(self,psiItemArray:'Any') -> 'Any': - """ - Description of GetToolTip. - -Args: - - psiItemArray(Any):Description for psiItemArray - -Returns: - - Any - - """ - pass - - - def GetCanonicalName(self,) -> 'PyIID': - """ - Description of GetCanonicalName. - -Args: - - - -Returns: - - PyIID - - """ - pass - - - def GetState(self,psiItemArray:'Any',fOkToBeSlow:'Any') -> 'Any': - """ - Description of GetState. - -Args: - - psiItemArray(Any):Description for psiItemArray - fOkToBeSlow(Any):Description for fOkToBeSlow - -Returns: - - Any - - """ - pass - - - def Invoke(self,psiItemArray:'Any',pbc:'Any') -> 'None': - """ - Description of Invoke. - -Args: - - psiItemArray(Any):Description for psiItemArray - pbc(Any):Description for pbc - -Returns: - - None - - """ - pass - - - def GetFlags(self,) -> 'Any': - """ - Description of GetFlags. - -Args: - - - -Returns: - - Any - - """ - pass - - - def EnumSubCommands(self,) -> 'Any': - """ - Description of EnumSubCommands. - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIExplorerCommandProvider(object): - """This is a gateway only interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIExplorerPaneVisibility(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIExternalConnection(object): - """A Python wrapper for a COM IExternalConnection interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddConnection(self,extconn:'Any',reserved:'Any'=0) -> 'Any': - """ - Increments an object's count of its strong external connections - -(links). - -Args: - - extconn(Any):Type of external connection to the object. The only type of external connection currently supported by this interface is strong, which means that the object must remain alive as long as this external connection exists. Strong external connections are represented by the value EXTCONN_STRONG = 0x0001, which is defined in the enumeration EXTCON - reserved(Any):A reserved parameterReturn ValueThe result is the number of reference counts on the object; used for debugging purposes only. - -Returns: - - 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:'Any',reserved:'Any',fLastReleaseCloses:'Any') -> 'Any': - """ - Decrements an object's count of its strong external connections - -(references). - -Args: - - extconn(Any):Type of external connection - reserved(Any):A reserved parameter. - fLastReleaseCloses(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 or another process.Return ValueThe result is the number of reference counts on the object; used for debugging purposes only. - -Returns: - - 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 - -or another process.Return ValueThe result is the number of reference counts on the object; used for debugging purposes only. - - - """ - pass - - -class PyIExtractIcon(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Extract(self,pszFile:'Any',nIconIndex:'Any',nIconSize:'Any') -> 'None': - """ - Description of Extract. - -Args: - - pszFile(Any):Description for pszFile - nIconIndex(Any):Description for nIconIndex - nIconSize(Any):Description for nIconIndexReturn ValueThe result is (hicon_large, hicon_small), or (None,None) if the underlying function returns S_FALSE, indicating the calling application should extract it. - -Returns: - - None:Description for nIconIndexReturn ValueThe result is (hicon_large, hicon_small), or - -(None,None) if the underlying function returns S_FALSE, indicating - -the calling application should extract it. - - - """ - pass - - - def GetIconLocation(self,uFlags:'Any',cchMax:'Any') -> 'None': - """ - Description of GetIconLocation. - -Args: - - uFlags(Any):Description for uFlags - cchMax(Any):Buffer size to allocate for file name - -Returns: - - None - - """ - pass - - -class PyIExtractIconW(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Extract(self,pszFile:'Any',nIconIndex:'Any',nIconSize:'Any') -> 'None': - """ - Description of Extract. - -Args: - - pszFile(Any):Description for pszFile - nIconIndex(Any):Description for nIconIndex - nIconSize(Any):Description for nIconIndexReturn ValueThe result is (hicon_large, hicon_small), or (None,None) if the underlying function returns S_FALSE, indicating the calling application should extract it. - -Returns: - - None:Description for nIconIndexReturn ValueThe result is (hicon_large, hicon_small), or - -(None,None) if the underlying function returns S_FALSE, indicating - -the calling application should extract it. - - - """ - pass - - - def GetIconLocation(self,uFlags:'Any',cchMax:'Any') -> 'None': - """ - Description of GetIconLocation. - -Args: - - uFlags(Any):Description for uFlags - cchMax(Any):Buffer size to allocate for file name - -Returns: - - None - - """ - pass - - -class PyIExtractImage(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetLocation(self,dwPriority:'Any',size:'Tuple[Any, Any]',dwRecClrDepth:'Any',pdwFlags:'Any') -> 'None': - """ - Description of GetLocation. - -Args: - - dwPriority(Any):Description for dwPriority - size(Tuple[Any, Any]):Description for prgSize - dwRecClrDepth(Any):Description for dwRecClrDepth - pdwFlags(Any):Description for pdwFlags - -Returns: - - None - - """ - pass - - - def Extract(self,) -> 'None': - """ - Description of Extract. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIFileOperation(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Advise(self,Sink:'Any') -> 'Any': - """ - Connects an event sink to receive updates - -Args: - - Sink(Any):Interface that receives progress updatesReturn ValueReturns a cookie to be passed to PyIFileOperation::Unadvise to disconnect - -Returns: - - Any:Interface that receives progress updatesReturn ValueReturns a cookie to be passed to PyIFileOperation::Unadvise to disconnect - - - """ - pass - - - def Unadvise(self,Cookie:'Any') -> 'None': - """ - Disconnects a progress sink - -Args: - - Cookie(Any):Identifies the sink to disconnect, as returned by PyIFileOperation::Advise - -Returns: - - None - - """ - pass - - - def SetOperationFlags(self,OperationFlags:'Any') -> 'None': - """ - Sets option flags for the operation - -Args: - - OperationFlags(Any):Combination of shellcon.FOF_* and FOFX_* flags - -Returns: - - None - - """ - pass - - - def SetProgressMessage(self,Message:'Any') -> 'None': - """ - Not implemented. - -Args: - - Message(Any):Description for Message - -Returns: - - None - - """ - pass - - - def SetProgressDialog(self,popd:'Any') -> 'None': - """ - Provides an interface used to display a progress dialog - -Args: - - popd(Any):Progress dialog interfaceCommentsIOperationsProgressDialog is not yet supported - -Returns: - - None - - """ - pass - - - def SetProperties(self,proparray:'Any') -> 'None': - """ - Specifies a set of properties to be changed. - -Args: - - proparray(Any):Sequence of property changes to be performed (see propsys::PSCreatePropertyChangeArray)CommentsNote that these properties will be set for *any* files created by the operation, not just items passed to ApplyPropertiesToItem(s). New items created as the result of a rename, copy, or move must have a property handler, or the operation fails with the vague com_error: (-2147467259, 'Unspecified error', None, None) (E_FAIL, or 0x80004005 in hex) even though the given file operation was actually performed. - -Returns: - - None - - """ - pass - - - def SetOwnerWindow(self,Owner:'int') -> 'None': - """ - Sets the parent window for any UI displayed. - -Args: - - Owner(int):Handle to parent window - -Returns: - - None - - """ - pass - - - def ApplyPropertiesToItem(self,Item:'Any') -> 'None': - """ - Specifies the item that will receive property changes - -Args: - - Item(Any):The item to which property changes will be applied - -Returns: - - None - - """ - pass - - - def ApplyPropertiesToItems(self,Items:'Any') -> 'None': - """ - Specifies multiple items that will receive property changes - -Args: - - Items(Any):PyIShellItemArray, PyIDataObject, or PyIEnumShellItems containing the target items - -Returns: - - None - - """ - pass - - - def RenameItem(self,Item:'Any',NewName:'Any',Sink:'Any'=None) -> 'None': - """ - Adds a rename to the operation sequence - -Args: - - Item(Any):The item to be renamed - NewName(Any):The new name - Sink(Any):Progress sink for this operation only. - -Returns: - - None - - """ - pass - - - def RenameItems(self,pUnkItems:'Any',NewName:'Any') -> 'None': - """ - Adds multiple renames to the operation sequence - -Args: - - pUnkItems(Any):PyIShellItemArray, PyIDataObject, or PyIEnumShellItems containing items to be renamed - NewName(Any):New name for all items. Collisions handled automatically. - -Returns: - - None - - """ - pass - - - def MoveItem(self,Item:'Any',DestinationFolder:'Any',pszNewName:'Any'=None,Sink:'Any'=None) -> 'None': - """ - Adds a move operation to the configuration - -Args: - - Item(Any):The item to be moved - DestinationFolder(Any):The folder into which it will be moved - pszNewName(Any):Name to be given to moved item, use None to keep original name - Sink(Any):Progress sink to receive notification for just this operation - -Returns: - - None - - """ - pass - - - def MoveItems(self,Items:'Any',DestinationFolder:'Any') -> 'None': - """ - Adds multiple move operations to the configuration - -Args: - - Items(Any):PyIShellItemArray, PyIDataObject, or PyIEnumShellItems containing the items to be moved - DestinationFolder(Any):Folder into which all items will be moved - -Returns: - - None - - """ - pass - - - def CopyItem(self,Item:'Any',DestinationFolder:'Any',CopyName:'Any'=None,Sink:'Any'=None) -> 'None': - """ - Adds a copy operation to the configuration - -Args: - - Item(Any):Item to be copied - DestinationFolder(Any):Folder into which it will be copied - CopyName(Any):New name for the copied file, use None to keep original name - Sink(Any):Progress sink for just this operation - -Returns: - - None - - """ - pass - - - def CopyItems(self,Items:'Any',DestinationFolder:'Any') -> 'None': - """ - Adds multiple copy operations to the configuration - -Args: - - Items(Any):PyIShellItemArray, PyIDataObject, or PyIEnumShellItems containing items to be copied - DestinationFolder(Any):Folder into which they will be copied - -Returns: - - None - - """ - pass - - - def DeleteItem(self,Item:'Any',Sink:'Any'=None) -> 'None': - """ - Adds a delete operation to the configuration - -Args: - - Item(Any):Description for psiItem - Sink(Any):Progress sink for just this operation - -Returns: - - None - - """ - pass - - - def DeleteItems(self,Items:'Any') -> 'None': - """ - Adds multiple delete operations to the configuration - -Args: - - Items(Any):PyIShellItemArray, PyIDataObject, or PyIEnumShellItems containing the items to be deleted - -Returns: - - None - - """ - pass - - - def NewItem(self,DestinationFolder:'Any',FileAttributes:'Any',Name:'Any',TemplateName:'Any'=None,Sink:'Any'=None) -> 'None': - """ - Creates a new file as part of the operation - -Args: - - DestinationFolder(Any):Folder in which to create the file - FileAttributes(Any):Combination of win32con.FILE_ATTRIBUTE_* flags - Name(Any):Name of the new file - TemplateName(Any):Template file used to initialize the new file - Sink(Any):Progress sink for just this operation - -Returns: - - None - - """ - pass - - - def PerformOperations(self,) -> 'None': - """ - Effects all configured file system modifications - -Args: - - - -Returns: - - None - - """ - pass - - - def GetAnyOperationsAborted(self,) -> 'Any': - """ - Determines if any operations were terminated - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIIdentityName(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIInitializeWithFile(object): - """Initializes a property handler that requires a file path instead of a stream""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,FilePath:'Any',Mode:'Any') -> 'None': - """ - Passes a file path to a property handler on startup - -Args: - - FilePath(Any):Full path to the file whose properties are to be accessed - Mode(Any):Indicates if properties can be written, STGM_READ or STGM_READWRITE - -Returns: - - None - - """ - pass - - -class PyIInitializeWithStream(object): - """Interface that initializes a handler capable of reading properties from a stream""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,Stream:'Any',Mode:'Any') -> 'None': - """ - Initializes a property handler with a stream - -Args: - - Stream(Any):Stream containing the contents from which to extract properties - Mode(Any):Indicates if stream is writable, STGM_READ or STGM_READWRITE - -Returns: - - None - - """ - pass - - -class PyIInputObject(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def TranslateAccelerator(self,pmsg:'Any') -> 'None': - """ - Description of TranslateAccelerator. - -Args: - - pmsg(Any):Description for pmsg - -Returns: - - None - - """ - pass - - - def UIActivate(self,uState:'Any') -> 'None': - """ - Description of UIActivate. - -Args: - - uState(Any):Description for uState - -Returns: - - None - - """ - pass - - - def HasFocusIO(self,) -> 'None': - """ - Description of Refresh. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIInternetBindInfo(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetBindInfo(self,) -> 'None': - """ - Description of GetBindInfo. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetBindString(self,) -> 'None': - """ - Description of GetBindString. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIInternetPriority(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetPriority(self,nPriority:'Any') -> 'None': - """ - Description of SetPriority. - -Args: - - nPriority(Any):Description for nPriority - -Returns: - - None - - """ - pass - - - def GetPriority(self,) -> 'None': - """ - Description of GetPriority. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIInternetProtocol(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Read(self,cb:'Any') -> 'None': - """ - Description of Read. - -Args: - - cb(Any):Description for cb - -Returns: - - None - - """ - pass - - - def Seek(self,dlibMove:'LARGE_INTEGER',dwOrigin:'Any') -> 'None': - """ - Description of Seek. - -Args: - - dlibMove(LARGE_INTEGER):Description for dlibMove - dwOrigin(Any):Description for dwOrigin - -Returns: - - None - - """ - pass - - - def LockRequest(self,dwOptions:'Any') -> 'None': - """ - Description of LockRequest. - -Args: - - dwOptions(Any):Description for dwOptions - -Returns: - - None - - """ - pass - - - def UnlockRequest(self,) -> 'None': - """ - Description of UnlockRequest. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIInternetProtocolInfo(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ParseUrl(self,pwzUrl:'Any',ParseAction:'Any',dwParseFlags:'Any',cchResult:'Any',dwReserved:'Any') -> 'None': - """ - Description of ParseUrl. - -Args: - - pwzUrl(Any):Description for pwzUrl - ParseAction(Any):Description for ParseAction - dwParseFlags(Any):Description for dwParseFlags - cchResult(Any):Description for cchResult - dwReserved(Any):Description for dwReserved - -Returns: - - None - - """ - pass - - - def CombineUrl(self,pwzBaseUrl:'Any',pwzRelativeUrl:'Any',dwCombineFlags:'Any',cchResult:'Any',dwReserved:'Any') -> 'None': - """ - Description of CombineUrl. - -Args: - - pwzBaseUrl(Any):Description for pwzBaseUrl - pwzRelativeUrl(Any):Description for pwzRelativeUrl - dwCombineFlags(Any):Description for dwCombineFlags - cchResult(Any):Description for cchResult - dwReserved(Any):Description for dwReserved - -Returns: - - None - - """ - pass - - - def CompareUrl(self,pwzUrl1:'Any',pwzUrl2:'Any',dwCompareFlags:'Any') -> 'None': - """ - Description of CompareUrl. - -Args: - - pwzUrl1(Any):Description for pwzUrl1 - pwzUrl2(Any):Description for pwzUrl2 - dwCompareFlags(Any):Description for dwCompareFlags - -Returns: - - None - - """ - pass - - - def QueryInfo(self,pwzUrl:'Any',OueryOption:'Any',dwQueryFlags:'Any',cbBuffer:'Any',dwReserved:'Any') -> 'Any': - """ - Description of QueryInfo. - -Args: - - pwzUrl(Any):Description for pwzUrl - OueryOption(Any):Description for OueryOption - dwQueryFlags(Any):Description for dwQueryFlags - cbBuffer(Any):Description for cbBuffer - dwReserved(Any):Description for dwReservedCommentsIf the buffer size is the size of an integer, an integer will be returned, otherwise a string. - -Returns: - - Any - - """ - pass - - -class PyIInternetProtocolRoot(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Start(self,szUrl:'Any',pOIProtSink:'Any',pOIBindInfo:'Any',grfPI:'Any',dwReserved:'Any') -> 'None': - """ - Description of Start. - -Args: - - szUrl(Any):Description for szUrl - pOIProtSink(Any):Description for pOIProtSink - pOIBindInfo(Any):Description for pOIBindInfo - grfPI(Any):Description for grfPI - dwReserved(Any):Description for dwReserved - -Returns: - - None - - """ - pass - - - def Continue(self,) -> 'None': - """ - Description of Continue. - -Args: - - - -Returns: - - None - - """ - pass - - - def Abort(self,hrReason:'Any',dwOptions:'Any') -> 'None': - """ - Description of Abort. - -Args: - - hrReason(Any):Description for hrReason - dwOptions(Any):Description for dwOptions - -Returns: - - None - - """ - pass - - - def Terminate(self,dwOptions:'Any') -> 'None': - """ - Description of Terminate. - -Args: - - dwOptions(Any):Description for dwOptions - -Returns: - - None - - """ - pass - - - def Suspend(self,) -> 'None': - """ - Description of Suspend. - -Args: - - - -Returns: - - None - - """ - pass - - - def Resume(self,) -> 'None': - """ - Description of Resume. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIInternetProtocolSink(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Switch(self,) -> 'None': - """ - Description of Switch. - -Args: - - - -Returns: - - None - - """ - pass - - - def ReportProgress(self,ulStatusCode:'Any',szStatusText:'Any') -> 'None': - """ - Description of ReportProgress. - -Args: - - ulStatusCode(Any):Description for ulStatusCode - szStatusText(Any):Description for szStatusText - -Returns: - - None - - """ - pass - - - def ReportData(self,grfBSCF:'Any',ulProgress:'Any',ulProgressMax:'Any') -> 'None': - """ - Description of ReportData. - -Args: - - grfBSCF(Any):Description for grfBSCF - ulProgress(Any):Description for ulProgress - ulProgressMax(Any):Description for ulProgressMax - -Returns: - - None - - """ - pass - - - def ReportResult(self,hrResult:'Any',dwError:'Any',szResult:'Any') -> 'None': - """ - Description of ReportResult. - -Args: - - hrResult(Any):Description for hrResult - dwError(Any):Description for dwError - szResult(Any):Description for szResult - -Returns: - - None - - """ - pass - - -class PyIInternetSecurityManager(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetSecuritySite(self,pSite:'Any') -> 'None': - """ - Description of SetSecuritySite. - -Args: - - pSite(Any):Description for pSite - -Returns: - - None - - """ - pass - - - def GetSecuritySite(self,) -> 'None': - """ - Description of GetSecuritySite. - -Args: - - - -Returns: - - None - - """ - pass - - - def MapUrlToZone(self,pwszUrl:'Any',dwFlags:'Any') -> 'None': - """ - Description of MapUrlToZone. - -Args: - - pwszUrl(Any):Description for pwszUrl - dwFlags(Any):Description for dwFlags - -Returns: - - None - - """ - pass - - - def GetSecurityId(self,pwszUrl:'Any',pcbSecurityId:'Any') -> 'None': - """ - Description of GetSecurityId. - -Args: - - pwszUrl(Any):Description for pwszUrl - pcbSecurityId(Any):Description for pcbSecurityId - -Returns: - - None - - """ - pass - - - def ProcessUrlAction(self,pwszUrl:'Any',dwAction:'Any',context:'Any',dwFlags:'Any') -> 'None': - """ - Description of ProcessUrlAction. - -Args: - - pwszUrl(Any):Description for pwszUrl - dwAction(Any):Description for dwAction - context(Any): - dwFlags(Any):Description for dwFlags - -Returns: - - None - - """ - pass - - - def SetZoneMapping(self,dwZone:'Any',lpszPattern:'Any',dwFlags:'Any') -> 'None': - """ - Description of SetZoneMapping. - -Args: - - dwZone(Any):Description for dwZone - lpszPattern(Any):Description for lpszPattern - dwFlags(Any):Description for dwFlags - -Returns: - - None - - """ - pass - - - def GetZoneMappings(self,dwZone:'Any',dwFlags:'Any') -> 'None': - """ - Description of GetZoneMappings. - -Args: - - dwZone(Any):Description for dwZone - dwFlags(Any):Description for dwFlags - -Returns: - - None - - """ - pass - - -class PyIKnownFolder(object): - """Interface representing a known folder that serves - -as a replacement for the numeric CSIDL definitions and API functions. - -Requires Vista or later.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetId(self,) -> 'PyIID': - """ - Returns the id of the folder - -Args: - - - -Returns: - - PyIID - - """ - pass - - - def GetCategory(self,) -> 'Any': - """ - Returns the category for a folder (shellcon.KF_CATEGORY_*) - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetShellItem(self,riid:'PyIID',Flags:'Any'=0) -> 'Any': - """ - Returns a shell interface for the folder - -Args: - - riid(PyIID):The interface to return (IShellItem or IShellItem2) - Flags(Any):Combination of shellcon.KF_FLAG_* values - -Returns: - - Any - - """ - pass - - - def GetPath(self,Flags:'Any'=0) -> 'Any': - """ - Returns the path to the folder - -Args: - - Flags(Any):Combination of shellcon.KF_FLAG_* flags controlling how the path is returned - -Returns: - - Any - - """ - pass - - - def SetPath(self,Flags:'Any',Path:'Any') -> 'None': - """ - Changes the location of the folder - -Args: - - Flags(Any):KF_FLAG_DONT_UNEXPAND, or 0 - Path(Any):New path for known folder - -Returns: - - None - - """ - pass - - - def GetIDList(self,Flags:'Any') -> 'Any': - """ - Returns the folder's location as an item id list. - -Args: - - Flags(Any):Combination of shellcon.KF_FLAG_* values that affect how the operation is performed - -Returns: - - Any - - """ - pass - - - def GetFolderType(self,) -> 'PyIID': - """ - Returns the type of the folder - -Args: - - - -Returns: - - PyIID:PyIKnownFolder.GetFolderType -PyIID = GetFolderType()Returns the type of the folder -Return ValueReturns a folder type guid (shell.FOLDERTYPEID_*) - - - """ - pass - - - def GetRedirectionCapabilities(self,) -> 'Any': - """ - Returns flags indicating how the folder can be redirected - -Args: - - - -Returns: - - Any:PyIKnownFolder.GetRedirectionCapabilities - -int = GetRedirectionCapabilities()Returns flags indicating how the folder can be redirected -Return ValueCombination of shellcon.KF_REDIRECTION_CAPABILITIES_* flags - - - """ - pass - - - def GetFolderDefinition(self,) -> 'Any': - """ - Retrieves detailed information about a known folder - -Args: - - - -Returns: - - Any:PyIKnownFolder.GetFolderDefinition - -dict = GetFolderDefinition()Retrieves detailed information about a known folder -Return ValueReturns a dict containing info from a KNOWNFOLDER_DEFINITION struct - - - """ - pass - - -class PyIKnownFolderManager(object): - """Interface used to manage known folder definitions.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def FolderIdFromCsidl(self,Csidl:'Any') -> 'PyIID': - """ - Returns the folder id that corresponds to a CSIDL - -Args: - - Csidl(Any):The legacy CSIDL identifying a folder - -Returns: - - PyIID - - """ - pass - - - def FolderIdToCsidl(self,_id:'PyIID') -> 'Any': - """ - Returns the CSIDL equivalent of a known folder - -Args: - - _id(PyIID):A known folder id (shell.FOLDERID_*) - -Returns: - - Any - - """ - pass - - - def GetFolderIds(self,) -> 'Tuple[PyIID, ...]': - """ - Retrieves all known folder ids. - -Args: - - - -Returns: - - Tuple[PyIID, ...] - - """ - pass - - - def GetFolder(self,_id:'PyIID') -> 'Any': - """ - Returns a folder by its id. - -Args: - - _id(PyIID):A known folder id (shell.FOLDERID_*) - -Returns: - - Any - - """ - pass - - - def GetFolderByName(self,Name:'Any') -> 'Any': - """ - Returns a folder by canonical name - -Args: - - Name(Any):The nonlocalized name of a known folder - -Returns: - - Any - - """ - pass - - - def RegisterFolder(self,_id:'PyIID',Definition:'Any') -> 'None': - """ - Defines a new known folder - -Args: - - _id(PyIID):GUID used to identify the new known folder - Definition(Any):Dictionary containing info to be placed in a KNOWNFOLDER_DEFINITION structCommentsPyIKnownFolder::GetFolderDefinition can be used to get a template dictionary - -Returns: - - None - - """ - pass - - - def UnregisterFolder(self,_id:'PyIID') -> 'None': - """ - Removes the definition of a known folder - -Args: - - _id(PyIID):GUID of a known folder to be unregistered - -Returns: - - None - - """ - pass - - - def FindFolderFromPath(self,Path:'Any',Mode:'Any') -> 'Any': - """ - Retrieves a known folder by path - -Args: - - Path(Any):Path of a folder - Mode(Any):FFFP_EXACTMATCH or FFFP_NEARESTPARENTMATCH - -Returns: - - Any - - """ - pass - - - def FindFolderFromIDList(self,pidl:'Any') -> 'Any': - """ - Retrieves a known folder using its item id - -list. - -Args: - - pidl(Any):Item id list of the folder - -Returns: - - Any - - """ - pass - - - def Redirect(self,_id:'PyIID',hwnd:'int',flags:'Any',TargetPath:'Any',Exclusion:'Tuple[PyIID, ...]') -> 'None': - """ - Redirects a known folder to an alternate location - -Args: - - _id(PyIID):Id of the known folder to be redirected - hwnd(int):Handle of window to be used for user interaction - flags(Any):Combination of KF_REDIRECT_* flags - TargetPath(Any):Path to which the known folder will be redirected - Exclusion(Tuple[PyIID, ...]):Sequence of known folder ids of subfolders to be excluded from redirection - -Returns: - - None - - """ - pass - - -class PyILockBytes(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ReadAt(self,ulOffset:'ULARGE_INTEGER',cb:'Any') -> 'str': - """ - Reads a specified number of bytes starting at a specified offset from the - -beginning of the byte array object. - -Args: - - ulOffset(ULARGE_INTEGER):Offset to start reading - cb(Any):Number of bytes to readCommentsThe result is a binary buffer returned in a string. - -Returns: - - str - - """ - pass - - - def WriteAt(self,ulOffset:'ULARGE_INTEGER',data:'str') -> 'Any': - """ - Writes the specified number of bytes starting at a specified offset from the - -beginning of the byte array. - -Args: - - ulOffset(ULARGE_INTEGER):Offset to write at. - data(str):Data to writeReturn ValueThe result is the number of bytes actually written. - -Returns: - - 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 - -to the backing storage. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetSize(self,cb:'ULARGE_INTEGER') -> 'None': - """ - Changes the size of the byte array. - -Args: - - cb(ULARGE_INTEGER):The new size. - -Returns: - - None - - """ - pass - - - def LockRegion(self,libOffset:'ULARGE_INTEGER',cb:'ULARGE_INTEGER',dwLockType:'Any') -> 'None': - """ - Restricts access to a specified range of bytes in the byte array. - -Args: - - libOffset(ULARGE_INTEGER):The beginning of the region to lock. - cb(ULARGE_INTEGER):The number of bytes to lock. - dwLockType(Any):Specifies the restrictions being requested on accessing the range. - -Returns: - - None - - """ - pass - - - def UnlockRegion(self,libOffset:'ULARGE_INTEGER',cb:'ULARGE_INTEGER',dwLockType:'Any') -> 'None': - """ - None - -Args: - - libOffset(ULARGE_INTEGER):The beginning of the region to unlock. - cb(ULARGE_INTEGER):The number of bytes to lock. - dwLockType(Any):Specifies the restrictions being requested on accessing the range. - -Returns: - - None - - """ - pass - - - def Stat(self,grfStatFlag:'Any') -> 'Any': - """ - None - -Args: - - grfStatFlag(Any):Specifies that this method does not return some of the fields in the STATSTG structure, thus saving a memory allocation operation. Values are taken from the STATFLAG enumerationg - -Returns: - - Any - - """ - pass - - -class PyIMAPIContainer(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OpenEntry(self,entryId:'str',iid:'PyIID',flags:'Any') -> 'Any': - """ - Opens an object and returns an interface object for further access. - -Args: - - entryId(str):The EntryID to open. - iid(PyIID):The IID of the returned interface, or None for the default interface. - flags(Any):Flags for the call. May include MAPI_BEST_ACCESS, MAPI_DEFERRED_ERRORS, MAPI_MODIFY and possibly others (see the MAPI documentation) - -Returns: - - Any - - """ - pass - - - def GetContentsTable(self,flags:'Any') -> 'Any': - """ - Returns an object representing the container's contents table. - -Args: - - flags(Any):The flags to use. - -Returns: - - Any - - """ - pass - - - def GetHierarchyTable(self,flags:'Any') -> 'Any': - """ - Returns an object representing the container's hierarchy table. - -Args: - - flags(Any):The flags to use. - -Returns: - - Any - - """ - pass - - -class PyIMAPIFolder(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetLastError(self,hr:'Any',flags:'Any') -> 'Any': - """ - Returns the last error code for the object. - -Args: - - hr(Any):Contains the error code generated in the previous method call. - flags(Any):Indicates for format for the output. - -Returns: - - Any - - """ - pass - - - def CreateFolder(self,folderType:'Any',folderName:'str',folderComment:'str'=None,iid:'PyIID'=None,flags:'Any'=0) -> 'Any': - """ - Creates a folder object. - -Args: - - folderType(Any):The type of folder to create - folderName(str):The name of the folder. - folderComment(str):A comment for the folder or None - iid(PyIID):The IID of the object to return. Should usually be None. - flags(Any): - -Returns: - - Any - - """ - pass - - - def CreateMessage(self,iid:'PyIID',flags:'Any') -> 'Any': - """ - Creates a message in a folder - -Args: - - iid(PyIID):The IID of the object to return. Should usually be None. - flags(Any): - -Returns: - - Any - - """ - pass - - - def CopyMessages(self,msgs:'Any',iid:'PyIID',folder:'Any',ulUIParam:'Any',progress:'Any',flags:'Any') -> 'Any': - """ - Copies the specified messages - -Args: - - msgs(Any): - iid(PyIID):IID representing the interface to be used to access the destination folder. Should usually be None. - folder(Any):The destination folder - ulUIParam(Any):Handle of the parent window for any dialog boxes or windows this method displays. - progress(Any):A progress object, or None - flags(Any):A bitmask ofMaskDescriptionMAPI_DECLINE_OKInforms the message store provider to immediately return MAPI_E_DECLINE_COPY if it implements CopyMessage by calling the support object's IMAPISupport::DoCopyTo or IMAPISupport::DoCopyProps method.MESSAGE_DIALOGDisplays a progress indicator as the operation proceeds.MESSAGE_MOVEThe message or messages are to be moved rather than copied. If MESSAGE_MOVE is not set, the messages are copied. - -Returns: - - Any - - """ - pass - - - def DeleteFolder(self,entryId:'str',uiParam:'Any',progress:'Any') -> 'None': - """ - Deletes a subfolder. - -Args: - - entryId(str):The EntryID of the subfolder to delete. - uiParam(Any):Handle of the parent window of the progress indicator. - progress(Any):A progress object, or None - -Returns: - - None - - """ - pass - - - def DeleteMessages(self,msgs:'Any',uiParam:'Any',progress:'Any',flags:'Any') -> 'Any': - """ - Deletes the specified messages. - -Args: - - msgs(Any): - uiParam(Any):A HWND for the progress - progress(Any):A progress object, or None - flags(Any): - -Returns: - - Any - - """ - pass - - - def EmptyFolder(self,uiParam:'Any',progress:'Any',flags:'Any') -> 'Any': - """ - deletes all messages and subfolders from a folder without deleting the folder itself. - -Args: - - uiParam(Any):A HWND for the progress - progress(Any):A progress object, or None - flags(Any): - -Returns: - - Any - - """ - pass - - - def SetReadFlags(self,msgs:'Any',uiParam:'Any',progress:'Any',flag:'Any') -> 'None': - """ - Sets or clears the MSGFLAG_READ flag in the PR_MESSAGE_FLAGS (PidTagMessageFlags) property of one or more of the folder's messages, and manages the sending of read reports. - -Args: - - msgs(Any): - uiParam(Any):A HWND for the progress - progress(Any):A progress object, or None - flag(Any):Bitmask of flags that controls the setting of a message's read flag - that is, the message's MSGFLAG_READ flag in its PR_MESSAGE_FLAGS property and the processing of read reports. - -Returns: - - None - - """ - pass - - -class PyIMAPIProp(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetProps(self,propList:'Any',flags:'Any'=0) -> 'Tuple[Any, Any, Any]': - """ - Returns a list of property values. - -Args: - - propList(Any):The list of properties - flags(Any): - -Returns: - - Tuple[Any, Any, Any] - - """ - pass - - - def DeleteProps(self,propList:'Any',wantProblems:'Any'=False) -> 'Tuple[Any, Any, Any]': - """ - Deletes a set of properties. - -Args: - - propList(Any):The list of properties - wantProblems(Any):Return detailed error information - -Returns: - - Tuple[Any, Any, Any] - - """ - pass - - - def SetProps(self,propList:'Tuple[Any, Any]',wantProblems:'Any'=False) -> 'Tuple[Any, Any, Any]': - """ - Sets a set of properties. - -Args: - - propList(Tuple[Any, Any]):The list of properties - wantProblems(Any):Return detailed error information - -Returns: - - Tuple[Any, Any, Any] - - """ - pass - - - def CopyTo(self,IIDExcludeList:'Tuple[Any, Any]',propTags:'Any',uiParam:'Any',progress:'Any',resultIID:'PyIID',dest:'Any',flags:'Any',wantProblems:'Any'=False) -> 'Tuple[Any, Any, Any]': - """ - Copies an object to another - -Args: - - IIDExcludeList(Tuple[Any, Any]):A sequence of IIDs to exclude. - propTags(Any):The property tags to exclude. - uiParam(Any):Handle to the parent window of the progress object - progress(Any):Reserved - must pass None - resultIID(PyIID):IID of the destination object - dest(Any):The destination object - flags(Any):flags - wantProblems(Any):Return detailed error information - -Returns: - - Tuple[Any, Any, Any] - - """ - pass - - - def CopyProps(self,propTags:'Any',uiParam:'Any',progress:'Any',resultIID:'PyIID',dest:'Any',flags:'Any',wantProblems:'Any'=False) -> 'Tuple[Any, Any, Any]': - """ - Copies a set of properties to another object - -Args: - - propTags(Any):The property tags to copy - uiParam(Any):Handle to the parent window of the progress object - progress(Any):Reserved - must pass None - resultIID(PyIID):IID of the destination object - dest(Any):The destination object - flags(Any):flags - wantProblems(Any):Return detailed error information - -Returns: - - Tuple[Any, Any, Any] - - """ - pass - - - def OpenProperty(self,propTag:'Any',iid:'PyIID',interfaceOptions:'Any',flags:'Any') -> 'Any': - """ - Returns an interface object to be used to access a property. - -Args: - - propTag(Any):The property tag to open - iid(PyIID):The IID of the resulting interface. - interfaceOptions(Any):Data that relates to the interface identified by the lpiid parameter. - flags(Any):flags - -Returns: - - Any - - """ - pass - - - def GetIDsFromNames(self,nameIds:'Any',flags:'Any'=0) -> 'Any': - """ - Determines property IDs - -Args: - - nameIds(Any):Sequence of name ids - flags(Any): - -Returns: - - Any - - """ - pass - - - def GetNamesFromIDs(self,propTags:'Any',propSetGuid:'PyIID'=None,flags:'Any'=0) -> 'Tuple[Any, Any, Any]': - """ - Determines property names - -Args: - - propTags(Any):Sequence of property tags, or None - propSetGuid(PyIID):a globally unique identifier, identifying a property set, or None - flags(Any): - -Returns: - - Tuple[Any, Any, Any] - - """ - pass - - - def GetLastError(self,hr:'Any',flags:'Any') -> 'Any': - """ - Returns the last error code for the object. - -Args: - - hr(Any):Contains the error code generated in the previous method call. - flags(Any):Indicates for format for the output. - -Returns: - - Any - - """ - pass - - - def SaveChanges(self,flags:'Any') -> 'None': - """ - Saves pending changes to the object - -Args: - - flags(Any):flags - -Returns: - - None - - """ - pass - - - def GetPropList(self,flags:'Any') -> 'Any': - """ - Gets a list of properties - -Args: - - flags(Any):flags - -Returns: - - Any - - """ - pass - - -class PyIMAPISession(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OpenEntry(self,entryId:'str',iid:'PyIID',flags:'Any') -> 'Any': - """ - Opens an object and returns an interface object for further access. - -Args: - - entryId(str):The EntryID to open. - iid(PyIID):The IID of the returned interface, or None for the default interface. - flags(Any):Flags for the call. May include MAPI_BEST_ACCESS, MAPI_DEFERRED_ERRORS, MAPI_MODIFY and possibly others (see the MAPI documentation) - -Returns: - - Any - - """ - pass - - - def OpenMsgStore(self,uiParam:'Any',entryId:'str',iid:'PyIID',flags:'Any') -> 'Any': - """ - Opens a message store. - -Args: - - uiParam(Any):Handle to the parent window for dialogs. - entryId(str):The entry ID of the message store to open. - iid(PyIID):The IID of the interface returned, or None - flags(Any):Options for the call.CommentsThe result is the interface specified by the IID, or IID_IMsgStore if None is used. - -Returns: - - Any - - """ - pass - - - def QueryIdentity(self,) -> 'str': - """ - Returns the entry identifier of the object that provides the primary identity for the session. - -Args: - - - -Returns: - - str - - """ - pass - - - def Advise(self,entryId:'str',mask:'Any',sink:'Any') -> 'Any': - """ - None - -Args: - - entryId(str):The entryID of the object - mask(Any): - sink(Any):Return ValueThe result is an integer which should be passed to PyIMAPISession::Unadvise - -Returns: - - Any:Return ValueThe result is an integer which should be passed to - -PyIMAPISession::Unadvise - - - """ - pass - - - def Unadvise(self,connection:'Any') -> 'None': - """ - None - -Args: - - connection(Any):Value returned from PyIMAPISession::Advise - -Returns: - - None - - """ - pass - - - def CompareEntryIDs(self,entryId:'str',entryId1:'str',flags:'Any'=0) -> 'Any': - """ - Compares two entry identifiers belonging to a particular address book provider to determine if they refer to the same address book object - -Args: - - entryId(str):The first entry ID to be compared - entryId1(str):The second entry ID to be compared - flags(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. - -Returns: - - 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 - - - def GetLastError(self,hr:'Any',flags:'Any') -> 'Any': - """ - Returns the last error code for the object. - -Args: - - hr(Any):Contains the error code generated in the previous method call. - flags(Any):Indicates for format for the output. - -Returns: - - Any - - """ - pass - - - def GetMsgStoresTable(self,flags:'Any') -> 'Any': - """ - Provides access to the message store table - a table with information about all of the message stores in the session profile. - -Args: - - flags(Any):Flags that control the opening. - -Returns: - - Any - - """ - pass - - - def GetStatusTable(self,flags:'Any') -> 'Any': - """ - Provides access to the status table - a table with information about all of the MAPI resources in the session. - -Args: - - flags(Any):Flags that control the opening. - -Returns: - - Any - - """ - pass - - - def Logoff(self,uiParm:'Any',flags:'Any',reserved:'Any') -> 'None': - """ - Ends a MAPI session. - -Args: - - uiParm(Any):hwnd of a dialog is to be displayed. - flags(Any):Bitmask of flags that control the logoff operation. - reserved(Any):Reserved; must be zero. - -Returns: - - None - - """ - pass - - - def OpenAddressBook(self,uiParm:'Any',iid:'PyIID',flags:'Any') -> 'Any': - """ - Opens the integrated address book. - -Args: - - uiParm(Any):hwnd of a dialog is to be displayed. - iid(PyIID):The IID of the interface, or None. - flags(Any):Flags that control the opening - AB_NO_DIALOG. - -Returns: - - Any - - """ - pass - - - def OpenProfileSection(self,iidSection:'PyIID',iid:'PyIID',flags:'Any') -> 'Any': - """ - Opens a section of the current profile and returns an object for futher access - -Args: - - iidSection(PyIID):The MAPIIID of the profile section - iid(PyIID):The IID of the interface, or None. - flags(Any):Flags that control the opening. - -Returns: - - Any - - """ - pass - - - def AdminServices(self,flags:'Any'=0) -> 'Any': - """ - Provides access to a message service administration object for making changes to the message services. - -Args: - - flags(Any):reserved; must be zero. - -Returns: - - Any - - """ - pass - - -class PyIMAPIStatus(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ChangePassword(self,oldPassword:'Any',newPassword:'Any',ulFlags:'Any') -> 'None': - """ - None - -Args: - - oldPassword(Any): - newPassword(Any): - ulFlags(Any): - -Returns: - - None - - """ - pass - - - def SettingsDialog(self,ulUIParam:'Any',ulFlags:'Any') -> 'None': - """ - None - -Args: - - ulUIParam(Any): - ulFlags(Any): - -Returns: - - None - - """ - pass - - - def ValidateState(self,ulUIParam:'Any',ulFlags:'Any') -> 'None': - """ - None - -Args: - - ulUIParam(Any): - ulFlags(Any): - -Returns: - - None - - """ - pass - - - def FlushQueues(self,ulUIParam:'Any',transport:'str',ulFlags:'Any') -> 'None': - """ - None - -Args: - - ulUIParam(Any): - transport(str):Blob of data - ulFlags(Any): - -Returns: - - None - - """ - pass - - -class PyIMAPITable(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetLastError(self,hr:'Any',flags:'Any') -> 'Any': - """ - Returns the last error code for the object. - -Args: - - hr(Any):Contains the error code generated in the previous method call. - flags(Any):Indicates for format for the output. - -Returns: - - Any - - """ - pass - - - def Advise(self,eventMask:'Any',adviseSink:'Any') -> 'Any': - """ - Registers to receive notification of specified events affecting the table. - -Args: - - eventMask(Any): - adviseSink(Any): - -Returns: - - Any - - """ - pass - - - def SeekRow(self,bookmark:'Any',rowCount:'Any') -> 'Any': - """ - Moves the cursor to a specific position in the table. - -Args: - - bookmark(Any):The bookmark. - rowCount(Any):Return ValueThe result is the number of rows processed. - -Returns: - - Any:Return ValueThe result is the number of rows processed. - - - """ - pass - - - def SeekRowApprox(self,numerator:'Any',denominator:'Any') -> 'None': - """ - Moves the cursor to an approximate fractional position in the table. - -Args: - - numerator(Any):The numerator of the fraction representing the table position - denominator(Any):The denominator of the fraction representing the table position. This must not be zero. - -Returns: - - None - - """ - pass - - - def GetRowCount(self,flags:'Any') -> 'Any': - """ - Returns the total number of rows in the table. - -Args: - - flags(Any):Reserved - must be zero - -Returns: - - Any - - """ - pass - - - def QueryRows(self,rowCount:'Any',flags:'Any') -> 'Any': - """ - Returns one or more rows from a table, beginning at the current cursor position. - -Args: - - rowCount(Any):Number of rows to retrieve - flags(Any):Flags. - -Returns: - - Any - - """ - pass - - - def SetColumns(self,propTags:'Any',flags:'Any') -> 'None': - """ - Defines the particular properties and order of properties to appear as columns in the table. - -Args: - - propTags(Any):Sequence of property tags identifying properties to be included as columns in the table. - flags(Any): - -Returns: - - None - - """ - pass - - - def GetStatus(self,) -> 'None': - """ - Returns the table's status and type. - -Args: - - - -Returns: - - None:PyIMAPITable.GetStatus -GetStatus()Returns the table's status and type. -Return ValueResult is a tuple of (tableStatus, tableType) - - - """ - pass - - - def QueryPosition(self,) -> 'None': - """ - Retrieves the current table row position of the cursor, based on a fractional value. - -Args: - - - -Returns: - - None:PyIMAPITable.QueryPosition -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 - - - def QueryColumns(self,flags:'Any') -> 'Any': - """ - Returns a list of columns for the table. - -Args: - - flags(Any): - -Returns: - - Any - - """ - pass - - - def Abort(self,) -> 'None': - """ - Stops any asynchronous operations currently in progress for the table. - -Args: - - - -Returns: - - None - - """ - pass - - - def FreeBookmark(self,bookmark:'Any') -> 'None': - """ - Releases the memory associated with a bookmark. - -Args: - - bookmark(Any): - -Returns: - - None - - """ - pass - - - def CreateBookmark(self,) -> 'Any': - """ - Marks the table's current position. - -Args: - - - -Returns: - - Any - - """ - pass - - - def Restrict(self,restriction:'Any',flags:'Any') -> 'None': - """ - Applies a filter to a table, reducing the row set to only those rows matching the specified criteria. - -Args: - - restriction(Any): - flags(Any): - -Returns: - - None - - """ - pass - - - def FindRow(self,restriction:'Any',bookmarkOrigin:'Any',flags:'Any') -> 'None': - """ - Finds the next row in a table that matches specific search criteria. - -Args: - - restriction(Any): - bookmarkOrigin(Any): - flags(Any): - -Returns: - - None - - """ - pass - - - def SortTable(self,sortOrderSet:'Any',flags:'Any') -> 'None': - """ - Orders the rows of the table based on sort criteria. - -Args: - - sortOrderSet(Any): - flags(Any): - -Returns: - - None - - """ - pass - - - def Unadvise(self,handle:'Any') -> 'None': - """ - Cancels the sending of notifications previously set up with a call to the IMAPITable::Advise method. - -Args: - - handle(Any):Handle returned from PyIMAPITable::Advise - -Returns: - - None - - """ - pass - - -class PyIMachineDebugManager(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddApplication(self,pda:'Any') -> 'None': - """ - Description of AddApplication. - -Args: - - pda(Any):Description for pda - -Returns: - - None - - """ - pass - - - def RemoveApplication(self,dwAppCookie:'Any') -> 'None': - """ - Description of RemoveApplication. - -Args: - - dwAppCookie(Any):Description for dwAppCookie - -Returns: - - None - - """ - pass - - - def EnumApplications(self,) -> 'None': - """ - Description of EnumApplications. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIMachineDebugManagerEvents(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def onAddApplication(self,pda:'Any',dwAppCookie:'Any') -> 'None': - """ - Description of onAddApplication. - -Args: - - pda(Any):Description for pda - dwAppCookie(Any):Description for dwAppCookie - -Returns: - - None - - """ - pass - - - def onRemoveApplication(self,pda:'Any',dwAppCookie:'Any') -> 'None': - """ - Description of onRemoveApplication. - -Args: - - pda(Any):Description for pda - dwAppCookie(Any):Description for dwAppCookie - -Returns: - - None - - """ - pass - - -class PyIMessage(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetReadFlag(self,flag:'Any') -> 'None': - """ - Sets the read flags for a message - -Args: - - flag(Any):Bitmask of flags that controls the setting of a message's read flag - that is, the message's MSGFLAG_READ flag in its PR_MESSAGE_FLAGS property and the processing of read reports. - -Returns: - - None - - """ - pass - - - def GetAttachmentTable(self,flags:'Any') -> 'Any': - """ - Returns the message's attachment table. - -Args: - - flags(Any):Bitmask of flags that relate to the creation of the table. - -Returns: - - Any - - """ - pass - - - def OpenAttach(self,attachmentNum:'Any',interface:'PyIID',flags:'Any') -> 'Any': - """ - Opens an attachment - -Args: - - attachmentNum(Any): - interface(PyIID):The interface to use, or None - flags(Any):Bitmask of flags that controls how the attachment is opened. - -Returns: - - Any - - """ - pass - - - def CreateAttach(self,interface:'PyIID',flags:'Any') -> 'Tuple[Any, Any]': - """ - Creates an attachment - -Args: - - interface(PyIID):The interface to use, or None - flags(Any):Bitmask of flags that controls how the attachment is created.Return ValueThe result is a tuple of (attachmentNum, attachmentObject) - -Returns: - - Tuple[Any, Any]:Bitmask of flags that controls how the attachment is created.Return ValueThe result is a tuple of (attachmentNum, attachmentObject) - - - """ - pass - - - def DeleteAttach(self,attachmentNum:'Any',ulUIParam:'Any',interface:'Any',flags:'Any') -> 'None': - """ - Deletes an attachment - -Args: - - attachmentNum(Any): - ulUIParam(Any): - interface(Any):The interface to use, or None - flags(Any):Bitmask of flags that controls the display of a user interface. - -Returns: - - None - - """ - pass - - - def ModifyRecipients(self,flags:'Any',mods:'Any') -> 'None': - """ - adds, deletes, or modifies message recipients. - -Args: - - flags(Any):Bitmask of flags that controls the recipient changes. If zero is passed for the ulFlags parameter, ModifyRecipients replaces all existing recipients with the recipient list in the mods parameter. - mods(Any):The list of recipients. - -Returns: - - None - - """ - pass - - - def GetRecipientTable(self,flags:'Any') -> 'Any': - """ - Returns the message's recipient table. - -Args: - - flags(Any):Bitmask of flags that relate to the creation of the table. - -Returns: - - Any - - """ - pass - - - def SubmitMessage(self,flags:'Any') -> 'None': - """ - Saves all of the message's properties and marks the message as ready to be sent. - -Args: - - flags(Any):Flags which specify how the message is submitted. - -Returns: - - None - - """ - pass - - -class PyIMoniker(object): - """A Python interface to IMoniker""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def BindToObject(self,bindCtx:'Any',moniker:'Any',iidResult:'Any') -> 'Any': - """ - Uses the moniker to bind to the object it identifies. - -Args: - - bindCtx(Any):bind context object to be used. - moniker(Any):If the moniker is part of a composite moniker, otherwise None - iidResult(Any):IID of the result object. - -Returns: - - Any - - """ - pass - - - def BindToStorage(self,bindCtx:'Any',moniker:'Any',iidResult:'Any') -> 'Any': - """ - Retrieves an interface object to the storage that contains the - -object identified by the moniker. - -Args: - - bindCtx(Any):bind context object to be used. - moniker(Any):If the moniker is part of a composite moniker, otherwise None - iidResult(Any):IID of the result object. - -Returns: - - Any - - """ - pass - - - def GetDisplayName(self,bindCtx:'Any',moniker:'Any') -> 'str': - """ - Gets the display name , which is a user-readable representation of this - -moniker. - -Args: - - bindCtx(Any):bind context object to be used. - moniker(Any):If the moniker is part of a composite moniker, otherwise None - -Returns: - - str - - """ - pass - - - def ComposeWith(self,mkRight:'Any',fOnlyIfNotGeneric:'Any') -> 'Any': - """ - Combines the current moniker with another moniker, creating a new - -composite moniker. - -Args: - - mkRight(Any):The IMoniker interface on the moniker to compose onto the end of this moniker. - fOnlyIfNotGeneric(Any):If TRUE, the caller requires a non-generic composition, so the operation should proceed only if pmkRight is a moniker class that this moniker can compose with in some way other than forming a generic composite. If FALSE, the method can create a generic composite if necessary. - -Returns: - - Any - - """ - pass - - - def Enum(self,fForward:'Any'=True) -> 'Any': - """ - Supplies an enumerator that can enumerate the components of a composite - -moniker. - -Args: - - fForward(Any):If TRUE, enumerates the monikers from left to right. If FALSE, enumerates from right to left. - -Returns: - - Any - - """ - pass - - - def IsEqual(self,other:'Any') -> 'Any': - """ - Compares this moniker with a specified moniker and indicates whether they are - -identical. - -Args: - - other(Any):The moniker to compare - -Returns: - - Any - - """ - pass - - - def IsSystemMoniker(self,) -> 'Any': - """ - Indicates whether this moniker is of one of the system-supplied moniker - -classes. - -Args: - - - -Returns: - - Any - - """ - pass - - - def Hash(self,) -> 'Any': - """ - Calculates a 32-bit integer using the internal state of the moniker. - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIMsgServiceAdmin(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetLastError(self,hr:'Any',flags:'Any') -> 'Any': - """ - Returns the last error code for the object. - -Args: - - hr(Any):Contains the error code generated in the previous method call. - flags(Any):Indicates for format for the output. - -Returns: - - Any - - """ - pass - - - def CreateMsgService(self,serviceName:'str',displayName:'str',flags:'Any',uiParam:'Any'=0) -> 'None': - """ - Creates a message service. - -Args: - - serviceName(str):The name of the service. - displayName(str):Display name of the service, or None - flags(Any):A bitmask of flags that controls how the message service is installed. - uiParam(Any):A handle of the parent window for any dialog boxes or windows that this method displays. - -Returns: - - None - - """ - pass - - - def ConfigureMsgService(self,iid:'PyIID',ulUIParam:'Any',ulFlags:'Any',arg:'List[Any]') -> 'None': - """ - Reconfigures a message service. - -Args: - - iid(PyIID):The unique identifier for the message service to configure. - ulUIParam(Any):Handle of the parent window for the configuration property sheet. - ulFlags(Any):Bitmask of flags that controls the display of the property sheet. - arg(List[Any]):Property values describing the properties to display in the property sheet. Should not be None if the service is to be configured without a message service. - -Returns: - - None - - """ - pass - - - def GetMsgServiceTable(self,flags:'Any') -> 'Any': - """ - Retrieves a table of services. - -Args: - - flags(Any): - -Returns: - - Any - - """ - pass - - - def GetProviderTable(self,flags:'Any') -> 'Any': - """ - Retrieves a table of service providers. - -Args: - - flags(Any): - -Returns: - - Any - - """ - pass - - - def DeleteMsgService(self,uuid:'PyIID') -> 'None': - """ - Deletes the specified service - -Args: - - uuid(PyIID):The ID of the service - -Returns: - - None - - """ - pass - - - def RenameMsgService(self,uuid:'PyIID',flags:'Any',newName:'str') -> 'None': - """ - Renames the specified service - -Args: - - uuid(PyIID):The ID of the service - flags(Any): - newName(str):The new name for the service.CommentsThis is deprecated, and there is no replacement referenced to use instead. - -Returns: - - None - - """ - pass - - - def OpenProfileSection(self,uuid:'PyIID',iid:'PyIID',flags:'Any') -> 'Any': - """ - Opens a profile section - -Args: - - uuid(PyIID):The ID of the service - iid(PyIID):The IID of the resulting object, or None for the default - flags(Any): - -Returns: - - Any - - """ - pass - - - def AdminProviders(self,uuid:'PyIID',flags:'Any') -> 'Any': - """ - Returns an object providing access - -to a provider administration object. - -Args: - - uuid(PyIID):The ID of the service - flags(Any): - -Returns: - - Any - - """ - pass - - -class PyIMsgStore(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OpenEntry(self,entryId:'str',iid:'PyIID',flags:'Any') -> 'Any': - """ - Opens a folder or message and returns an interface object for further access. - -Args: - - entryId(str):The entryID of the object - iid(PyIID):The IID of the object to return, or None for the default IID - flags(Any):Bitmask of flags that controls how the object is opened. - -Returns: - - Any - - """ - pass - - - def GetReceiveFolder(self,messageClass:'str'=None,flags:'Any'=0) -> 'Tuple[PyIID, str]': - """ - Obtains the folder that was established as the destination for incoming messages of a specified message class or the default receive folder for the message store. - -Args: - - messageClass(str):Message class that is associated with a receive folder. If this parameter is set to None or an empty string, GetReceiveFolder returns the default receive folder for the message store. - flags(Any): - -Returns: - - Tuple[PyIID, str] - - """ - pass - - - def GetReceiveFolderTable(self,flags:'Any') -> 'Any': - """ - provides access to the receive folder table, a table that includes information about all of the receive folders for the message store. - -Args: - - flags(Any):Bitmask of flags that controls table access - -Returns: - - Any - - """ - pass - - - def CompareEntryIDs(self,entryId:'str',entryId1:'str',flags:'Any'=0) -> 'Any': - """ - Compares two entry identifiers belonging to a particular address book provider to determine if they refer to the same address book object - -Args: - - entryId(str):The first entry ID to be compared - entryId1(str):The second entry ID to be compared - flags(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. - -Returns: - - 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 - - - def GetLastError(self,hr:'Any',flags:'Any') -> 'Any': - """ - Returns the last error code for the object. - -Args: - - hr(Any):Contains the error code generated in the previous method call. - flags(Any):Indicates for format for the output. - -Returns: - - Any - - """ - pass - - - def AbortSubmit(self,entryId:'str',flags:'Any'=0) -> 'Any': - """ - Attempts to remove a message from the outgoing queue. - -Args: - - entryId(str):The entry ID of the item to be aborted. - flags(Any):Reserved - must be zero. - -Returns: - - Any - - """ - pass - - - def Advise(self,entryId:'str',eventMask:'Any',adviseSink:'Any') -> 'None': - """ - Registers to receive notification of specified events that affect the message store. - -Args: - - entryId(str):entry identifier of the folder or message about which notifications should be generated, or None - eventMask(Any):A mask of values that indicate the types of notification events. - adviseSink(Any):An advise sink. - -Returns: - - None - - """ - pass - - - def Unadvise(self,connection:'Any') -> 'None': - """ - Cancels the sending of notifications previously set up with a call to the IMsgStore::Advise method. - -Args: - - connection(Any):Connection number returned from PyIMsgStore::Advise - -Returns: - - None - - """ - pass - - -class PyINameSpaceTreeControl(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,hwndParent:'Union[Any]',prc:'Tuple[Any, Any, Any, Any]',nsctsFlags:'Any') -> 'None': - """ - Description of Initialize. - -Args: - - hwndParent(Union[Any]):Description for hwndParent - prc(Tuple[Any, Any, Any, Any]):Description for prc - nsctsFlags(Any):Description for nsctsFlags - -Returns: - - None - - """ - pass - - - def TreeAdvise(self,punk:'Any') -> 'None': - """ - Description of TreeAdvise. - -Args: - - punk(Any):Description for punk - -Returns: - - None - - """ - pass - - - def TreeUnadvise(self,dwCookie:'Any') -> 'None': - """ - Description of TreeUnadvise. - -Args: - - dwCookie(Any):Description for dwCookie - -Returns: - - None - - """ - pass - - - def AppendRoot(self,psiRoot:'Any',grfEnumFlags:'Any',grfRootStyle:'Any',pif:'Any') -> 'None': - """ - Description of AppendRoot. - -Args: - - psiRoot(Any):Description for psiRoot - grfEnumFlags(Any):Description for grfEnumFlags - grfRootStyle(Any):Description for grfRootStyle - pif(Any):Description for pif - -Returns: - - None - - """ - pass - - - def InsertRoot(self,iIndex:'Any',psiRoot:'Any',grfEnumFlags:'Any',grfRootStyle:'Any',pif:'Any') -> 'None': - """ - Description of InsertRoot. - -Args: - - iIndex(Any):Description for iIndex - psiRoot(Any):Description for psiRoot - grfEnumFlags(Any):Description for grfEnumFlags - grfRootStyle(Any):Description for grfRootStyle - pif(Any):Description for pif - -Returns: - - None - - """ - pass - - - def RemoveRoot(self,psiRoot:'Any') -> 'None': - """ - Description of RemoveRoot. - -Args: - - psiRoot(Any):Description for psiRoot - -Returns: - - None - - """ - pass - - - def RemoveAllRoots(self,) -> 'None': - """ - Description of RemoveAllRoots. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetRootItems(self,) -> 'None': - """ - Description of GetRootItems. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetItemState(self,psi:'Any',nstcisMask:'Any',nstcisFlags:'Any') -> 'None': - """ - Description of SetItemState. - -Args: - - psi(Any):Description for psi - nstcisMask(Any):Description for nstcisMask - nstcisFlags(Any):Description for nstcisFlags - -Returns: - - None - - """ - pass - - - def GetItemState(self,psi:'Any',nstcisMask:'Any') -> 'None': - """ - Description of GetItemState. - -Args: - - psi(Any):Description for psi - nstcisMask(Any):Description for nstcisMask - -Returns: - - None - - """ - pass - - - def GetSelectedItems(self,) -> 'None': - """ - Description of GetSelectedItems. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetItemCustomState(self,psi:'Any') -> 'None': - """ - Description of GetItemCustomState. - -Args: - - psi(Any):Description for psi - -Returns: - - None - - """ - pass - - - def SetItemCustomState(self,psi:'Any',iStateNumber:'Any') -> 'None': - """ - Description of SetItemCustomState. - -Args: - - psi(Any):Description for psi - iStateNumber(Any):Description for iStateNumber - -Returns: - - None - - """ - pass - - - def EnsureItemVisible(self,psi:'Any') -> 'None': - """ - Description of EnsureItemVisible. - -Args: - - psi(Any):Description for psi - -Returns: - - None - - """ - pass - - - def SetTheme(self,pszTheme:'Any') -> 'None': - """ - Description of SetTheme. - -Args: - - pszTheme(Any):Description for pszTheme - -Returns: - - None - - """ - pass - - - def GetNextItem(self,psi:'Any',nstcgi:'Any') -> 'None': - """ - Description of GetNextItem. - -Args: - - psi(Any):Description for psi - nstcgi(Any):Description for nstcgi - -Returns: - - None - - """ - pass - - - def HitTest(self,pt:'Tuple[Any, Any]') -> 'None': - """ - Description of HitTest. - -Args: - - pt(Tuple[Any, Any]):Description for ppt - -Returns: - - None - - """ - pass - - - def GetItemRect(self,) -> 'None': - """ - Description of GetItemRect. - -Args: - - - -Returns: - - None - - """ - pass - - - def CollapseAll(self,) -> 'None': - """ - Description of CollapseAll. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyINamedPropertyStore(object): - """Contains a collection of properties indentified by name""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetNamedValue(self,Name:'Any') -> 'Any': - """ - Retrieves a property value by name - -Args: - - Name(Any):Name of the property - -Returns: - - Any - - """ - pass - - - def SetNamedValue(self,propvar:'Any') -> 'None': - """ - Sets the value of a property - -Args: - - propvar(Any):Description for propvar - -Returns: - - None - - """ - pass - - - def GetNameCount(self,) -> 'Any': - """ - Retrieves the number of named properties in the store - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetNameAt(self,Index:'Any') -> 'Any': - """ - Retrieves a property name by zero-based index - -Args: - - Index(Any):Index of the property name - -Returns: - - Any - - """ - pass - - -class PyIObjectArray(object): - """Holds a collection of interface objects""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetCount(self,) -> 'Any': - """ - Returns number of objects in collection - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetAt(self,Index:'Any',riid:'PyIID') -> 'Any': - """ - Retrieves an item by zero-based index - -Args: - - Index(Any):Index of item to retrieve - riid(PyIID):The interface to return - -Returns: - - Any - - """ - pass - - -class PyIObjectCollection(object): - """Modifiable container for a number of IUnknown objects""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddObject(self,punk:'Any') -> 'None': - """ - Adds a single object to the collection - -Args: - - punk(Any):Object to be added - -Returns: - - None - - """ - pass - - - def AddFromArray(self,Source:'Any') -> 'None': - """ - None - -Args: - - Source(Any):Objects to be added to the collection - -Returns: - - None - - """ - pass - - - def RemoveObjectAt(self,Index:'Any') -> 'None': - """ - Removes a single object from the collection - -Args: - - Index(Any):Zero-based index of item to remove - -Returns: - - None - - """ - pass - - - def Clear(self,) -> 'None': - """ - Empties the container. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIObjectWithPropertyKey(object): - """Interface implemented by objects that have an associated property id""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetPropertyKey(self,key:'Any') -> 'None': - """ - Sets the property id - -Args: - - key(Any):The identifier of the property - -Returns: - - None - - """ - pass - - - def GetPropertyKey(self,) -> 'Any': - """ - Returns the property id - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIObjectWithSite(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetSite(self,pUnkSite:'Any') -> 'None': - """ - Description of SetSite. - -Args: - - pUnkSite(Any):Description for pUnkSite - -Returns: - - None - - """ - pass - - - def GetSite(self,riid:'PyIID') -> 'None': - """ - Description of GetSite. - -Args: - - riid(PyIID):Description for riid - -Returns: - - None - - """ - pass - - -class PyIOleClientSite(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SaveObject(self,) -> 'None': - """ - Description of SaveObject. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetMoniker(self,dwAssign:'Any',dwWhichMoniker:'Any') -> 'None': - """ - Description of GetMoniker. - -Args: - - dwAssign(Any):Description for dwAssign - dwWhichMoniker(Any):Description for dwWhichMoniker - -Returns: - - None - - """ - pass - - - def GetContainer(self,) -> 'None': - """ - Description of GetContainer. - -Args: - - - -Returns: - - None - - """ - pass - - - def ShowObject(self,) -> 'None': - """ - Description of ShowObject. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnShowWindow(self,fShow:'Any') -> 'None': - """ - Description of OnShowWindow. - -Args: - - fShow(Any):Description for fShow - -Returns: - - None - - """ - pass - - - def RequestNewObjectLayout(self,) -> 'None': - """ - Description of RequestNewObjectLayout. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIOleCommandTarget(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def QueryStatus(self,) -> 'None': - """ - Description of QueryStatus. - -Args: - - - -Returns: - - None - - """ - pass - - - def Exec(self,) -> 'None': - """ - Description of Exec. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIOleControl(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetControlInfo(self,) -> 'None': - """ - Description of GetControlInfo. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnMnemonic(self,msg:'Any') -> 'None': - """ - Description of OnMnemonic. - -Args: - - msg(Any):A tuple representing a MSG structure. - -Returns: - - None - - """ - pass - - - def OnAmbientPropertyChange(self,dispID:'Any') -> 'None': - """ - Description of OnAmbientPropertyChange. - -Args: - - dispID(Any):Description for dispID - -Returns: - - None - - """ - pass - - - def FreezeEvents(self,bFreeze:'Any') -> 'None': - """ - Description of FreezeEvents. - -Args: - - bFreeze(Any):Description for bFreeze - -Returns: - - None - - """ - pass - - -class PyIOleControlSite(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OnControlInfoChanged(self,) -> 'None': - """ - Description of OnControlInfoChanged. - -Args: - - - -Returns: - - None - - """ - pass - - - def LockInPlaceActive(self,fLock:'Any') -> 'None': - """ - Description of LockInPlaceActive. - -Args: - - fLock(Any):Description for fLock - -Returns: - - None - - """ - pass - - - def GetExtendedControl(self,) -> 'None': - """ - Description of GetExtendedControl. - -Args: - - - -Returns: - - None - - """ - pass - - - def TransformCoords(self,PtlHimetric:'Tuple[Any, Any]',pPtfContainer:'Tuple[float, float]',dwFlags:'Any') -> 'None': - """ - Description of TransformCoords. - -Args: - - PtlHimetric(Tuple[Any, Any]):Description for pPtlHimetric - pPtfContainer(Tuple[float, float]):Description for pPtfContainer - dwFlags(Any):Description for dwFlagsReturn ValueThe result is a tuple of the transformed input points - ie, a tuple of ((int, int), (float, float)) - -Returns: - - None:Description for dwFlagsReturn ValueThe result is a tuple of the transformed input points - ie, - -a tuple of ((int, int), (float, float)) - - - """ - pass - - - def TranslateAccelerator(self,pMsg:'PyMSG',grfModifiers:'Any') -> 'None': - """ - Description of TranslateAccelerator. - -Args: - - pMsg(PyMSG):Description for pMsg - grfModifiers(Any):Description for grfModifiers - -Returns: - - None - - """ - pass - - - def OnFocus(self,fGotFocus:'Any') -> 'None': - """ - Description of OnFocus. - -Args: - - fGotFocus(Any):Description for fGotFocus - -Returns: - - None - - """ - pass - - - def ShowPropertyFrame(self,) -> 'None': - """ - Description of ShowPropertyFrame. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIOleInPlaceActiveObject(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def TranslateAccelerator(self,lpmsg:'PyMSG') -> 'None': - """ - Description of TranslateAccelerator. - -Args: - - lpmsg(PyMSG):Description for lpmsg - -Returns: - - None - - """ - pass - - - def OnFrameWindowActivate(self,fActivate:'Any') -> 'None': - """ - Description of OnFrameWindowActivate. - -Args: - - fActivate(Any):Description for fActivate - -Returns: - - None - - """ - pass - - - def OnDocWindowActivate(self,fActivate:'Any') -> 'None': - """ - Description of OnDocWindowActivate. - -Args: - - fActivate(Any):Description for fActivate - -Returns: - - None - - """ - pass - - - def ResizeBorder(self,rcBorder:'Tuple[Any, Any, Any, Any]',pUIWindow:'Any',fFrameWindow:'Any') -> 'None': - """ - Description of ResizeBorder. - -Args: - - rcBorder(Tuple[Any, Any, Any, Any]):Description for prcBorder - pUIWindow(Any):Description for pUIWindow - fFrameWindow(Any):Description for fFrameWindow - -Returns: - - None - - """ - pass - - - def EnableModeless(self,fEnable:'Any') -> 'None': - """ - Description of EnableModeless. - -Args: - - fEnable(Any):Description for fEnable - -Returns: - - None - - """ - pass - - -class PyIOleInPlaceFrame(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def InsertMenus(self,hmenuShared:'Union[Any]',menuWidths:'Any') -> 'None': - """ - Description of InsertMenus. - -Args: - - hmenuShared(Union[Any]):Description for hmenuShared - menuWidths(Any): - -Returns: - - None - - """ - pass - - - def SetMenu(self,hmenuShared:'Union[Any]',holemenu:'Union[Any]',hwndActiveObject:'Union[Any]') -> 'None': - """ - Description of SetMenu. - -Args: - - hmenuShared(Union[Any]):Description for hmenuShared - holemenu(Union[Any]):Description for holemenu - hwndActiveObject(Union[Any]):Description for hwndActiveObject - -Returns: - - None - - """ - pass - - - def RemoveMenus(self,hmenuShared:'Union[Any]') -> 'None': - """ - Description of RemoveMenus. - -Args: - - hmenuShared(Union[Any]):Description for hmenuShared - -Returns: - - None - - """ - pass - - - def SetStatusText(self,pszStatusText:'Any') -> 'None': - """ - Description of SetStatusText. - -Args: - - pszStatusText(Any):Description for pszStatusText - -Returns: - - None - - """ - pass - - - def EnableModeless(self,fEnable:'Any') -> 'None': - """ - Description of EnableModeless. - -Args: - - fEnable(Any):Description for fEnable - -Returns: - - None - - """ - pass - - - def TranslateAccelerator(self,lpmsg:'PyMSG',wID:'Any') -> 'None': - """ - Description of TranslateAccelerator. - -Args: - - lpmsg(PyMSG):Description for lpmsg - wID(Any):Description for wID - -Returns: - - None - - """ - pass - - -class PyIOleInPlaceObject(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def InPlaceDeactivate(self,) -> 'None': - """ - Description of InPlaceDeactivate. - -Args: - - - -Returns: - - None - - """ - pass - - - def UIDeactivate(self,) -> 'None': - """ - Description of UIDeactivate. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetObjectRects(self,) -> 'None': - """ - Description of SetObjectRects. - -Args: - - - -Returns: - - None - - """ - pass - - - def ReactivateAndUndo(self,) -> 'None': - """ - Description of ReactivateAndUndo. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIOleInPlaceSite(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CanInPlaceActivate(self,) -> 'None': - """ - Description of CanInPlaceActivate. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnInPlaceActivate(self,) -> 'None': - """ - Description of OnInPlaceActivate. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnUIActivate(self,) -> 'None': - """ - Description of OnUIActivate. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetWindowContext(self,) -> 'None': - """ - Description of GetWindowContext. - -Args: - - - -Returns: - - None - - """ - pass - - - def Scroll(self,) -> 'None': - """ - Description of Scroll. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnUIDeactivate(self,fUndoable:'Any') -> 'None': - """ - Description of OnUIDeactivate. - -Args: - - fUndoable(Any):Description for fUndoable - -Returns: - - None - - """ - pass - - - def OnInPlaceDeactivate(self,) -> 'None': - """ - Description of OnInPlaceDeactivate. - -Args: - - - -Returns: - - None - - """ - pass - - - def DiscardUndoState(self,) -> 'None': - """ - Description of DiscardUndoState. - -Args: - - - -Returns: - - None - - """ - pass - - - def DeactivateAndUndo(self,) -> 'None': - """ - Description of DeactivateAndUndo. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnPosRectChange(self,) -> 'None': - """ - Description of OnPosRectChange. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIOleInPlaceSiteEx(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OnInPlaceActivateEx(self,dwFlags:'Any') -> 'None': - """ - Description of OnInPlaceActivateEx. - -Args: - - dwFlags(Any):Description for dwFlags - -Returns: - - None - - """ - pass - - - def OnInPlaceDeactivateEx(self,fNoRedraw:'Any') -> 'None': - """ - Description of OnInPlaceDeactivateEx. - -Args: - - fNoRedraw(Any):Description for fNoRedraw - -Returns: - - None - - """ - pass - - - def RequestUIActivate(self,) -> 'None': - """ - Description of RequestUIActivate. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIOleInPlaceSiteWindowless(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CanWindowlessActivate(self,) -> 'None': - """ - Description of CanWindowlessActivate. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCapture(self,) -> 'None': - """ - Description of GetCapture. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetCapture(self,fCapture:'Any') -> 'None': - """ - Description of SetCapture. - -Args: - - fCapture(Any):Description for fCapture - -Returns: - - None - - """ - pass - - - def GetFocus(self,) -> 'None': - """ - Description of GetFocus. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetFocus(self,fFocus:'Any') -> 'None': - """ - Description of SetFocus. - -Args: - - fFocus(Any):Description for fFocus - -Returns: - - None - - """ - pass - - - def GetDC(self,grfFlags:'Any',rect:'Tuple[Any, Any, Any, Any]') -> 'None': - """ - Description of GetDC. - -Args: - - grfFlags(Any):Description for grfFlags - rect(Tuple[Any, Any, Any, Any]): - -Returns: - - None - - """ - pass - - - def ReleaseDC(self,hDC:'Any') -> 'None': - """ - Description of ReleaseDC. - -Args: - - hDC(Any):Description for hDC - -Returns: - - None - - """ - pass - - - def InvalidateRect(self,rect:'Tuple[Any, Any, Any, Any]',fErase:'Any') -> 'None': - """ - Description of InvalidateRect. - -Args: - - rect(Tuple[Any, Any, Any, Any]): - fErase(Any):Description for fErase - -Returns: - - None - - """ - pass - - - def InvalidateRgn(self,hRgn:'Any',fErase:'Any') -> 'None': - """ - Description of InvalidateRgn. - -Args: - - hRgn(Any):Handle to a region - fErase(Any):Description for fErase - -Returns: - - None - - """ - pass - - - def ScrollRect(self,dx:'Any',dy:'Any') -> 'None': - """ - Description of ScrollRect. - -Args: - - dx(Any):Description for dx - dy(Any):Description for dy - -Returns: - - None - - """ - pass - - - def AdjustRect(self,) -> 'None': - """ - Description of AdjustRect. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnDefWindowMessage(self,msg:'Any',wParam:'Any',lParam:'Any') -> 'None': - """ - Description of OnDefWindowMessage. - -Args: - - msg(Any):Description for msg - wParam(Any):Description for wParam - lParam(Any):Description for lParam - -Returns: - - None - - """ - pass - - -class PyIOleInPlaceUIWindow(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetBorder(self,) -> 'None': - """ - Description of GetBorder. - -Args: - - - -Returns: - - None - - """ - pass - - - def RequestBorderSpace(self,borderwidths:'Tuple[Any, Any, Any, Any]') -> 'None': - """ - Description of RequestBorderSpace. - -Args: - - borderwidths(Tuple[Any, Any, Any, Any]):Description for pborderwidths - -Returns: - - None - - """ - pass - - - def SetBorderSpace(self,borderwidths:'Tuple[Any, Any, Any, Any]') -> 'None': - """ - Description of SetBorderSpace. - -Args: - - borderwidths(Tuple[Any, Any, Any, Any]):Description for pborderwidths - -Returns: - - None - - """ - pass - - - def SetActiveObject(self,pActiveObject:'Any',pszObjName:'Any') -> 'None': - """ - Description of SetActiveObject. - -Args: - - pActiveObject(Any):Description for pActiveObject - pszObjName(Any):Description for pszObjName - -Returns: - - None - - """ - pass - - -class PyIOleObject(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetClientSite(self,pClientSite:'Any') -> 'None': - """ - Description of SetClientSite. - -Args: - - pClientSite(Any):Description for pClientSite - -Returns: - - None - - """ - pass - - - def GetClientSite(self,) -> 'None': - """ - Description of GetClientSite. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetHostNames(self,szContainerApp:'Any',szContainerObj:'Any') -> 'None': - """ - Description of SetHostNames. - -Args: - - szContainerApp(Any):Description for szContainerApp - szContainerObj(Any):Description for szContainerObj - -Returns: - - None - - """ - pass - - - def Close(self,dwSaveOption:'Any') -> 'None': - """ - Description of Close. - -Args: - - dwSaveOption(Any):Description for dwSaveOption - -Returns: - - None - - """ - pass - - - def SetMoniker(self,dwWhichMoniker:'Any',pmk:'Any') -> 'None': - """ - Description of SetMoniker. - -Args: - - dwWhichMoniker(Any):Description for dwWhichMoniker - pmk(Any):Description for pmk - -Returns: - - None - - """ - pass - - - def GetMoniker(self,dwAssign:'Any',dwWhichMoniker:'Any') -> 'None': - """ - Description of GetMoniker. - -Args: - - dwAssign(Any):Description for dwAssign - dwWhichMoniker(Any):Description for dwWhichMoniker - -Returns: - - None - - """ - pass - - - def InitFromData(self,pDataObject:'Any',fCreation:'Any',dwReserved:'Any') -> 'None': - """ - Description of InitFromData. - -Args: - - pDataObject(Any):Description for pDataObject - fCreation(Any):Description for fCreation - dwReserved(Any):Description for dwReserved - -Returns: - - None - - """ - pass - - - def GetClipboardData(self,dwReserved:'Any') -> 'None': - """ - Description of GetClipboardData. - -Args: - - dwReserved(Any):Description for dwReserved - -Returns: - - None - - """ - pass - - - def DoVerb(self,iVerb:'Any',msg:'PyMSG',pActiveSite:'Any',lindex:'Any',hwndParent:'Any',rect:'Tuple[Any, Any, Any, Any]') -> 'None': - """ - Description of DoVerb. - -Args: - - iVerb(Any):Description for iVerb - msg(PyMSG):MSG tuple, a-la win32gui etc. - pActiveSite(Any):Description for pActiveSite - lindex(Any):Description for lindex - hwndParent(Any):Description for hwndParent - rect(Tuple[Any, Any, Any, Any]): - -Returns: - - None - - """ - pass - - - def EnumVerbs(self,) -> 'None': - """ - Description of EnumVerbs. - -Args: - - - -Returns: - - None - - """ - pass - - - def Update(self,) -> 'None': - """ - Description of Update. - -Args: - - - -Returns: - - None - - """ - pass - - - def IsUpToDate(self,) -> 'None': - """ - Description of IsUpToDate. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetUserClassID(self,) -> 'None': - """ - Description of GetUserClassID. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetUserType(self,dwFormOfType:'Any') -> 'None': - """ - Description of GetUserType. - -Args: - - dwFormOfType(Any):Description for dwFormOfType - -Returns: - - None - - """ - pass - - - def SetExtent(self,dwDrawAspect:'Any',size:'Tuple[Any, Any]') -> 'None': - """ - Description of SetExtent. - -Args: - - dwDrawAspect(Any):Description for dwDrawAspect - size(Tuple[Any, Any]):Size limit for the object. - -Returns: - - None - - """ - pass - - - def GetExtent(self,dwDrawAspect:'Any',size:'Tuple[Any, Any]') -> 'None': - """ - Description of GetExtent. - -Args: - - dwDrawAspect(Any):Description for dwDrawAspect - size(Tuple[Any, Any]):Size limit for the object. - -Returns: - - None - - """ - pass - - - def Advise(self,pAdvSink:'Any') -> 'None': - """ - Description of Advise. - -Args: - - pAdvSink(Any):Description for pAdvSink - -Returns: - - None - - """ - pass - - - def Unadvise(self,dwConnection:'Any') -> 'None': - """ - Description of Unadvise. - -Args: - - dwConnection(Any):Description for dwConnection - -Returns: - - None - - """ - pass - - - def EnumAdvise(self,) -> 'None': - """ - Description of EnumAdvise. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetMiscStatus(self,dwAspect:'Any') -> 'None': - """ - Description of GetMiscStatus. - -Args: - - dwAspect(Any):Description for dwAspect - -Returns: - - None - - """ - pass - - - def SetColorScheme(self,) -> 'None': - """ - Description of SetColorScheme. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIOleWindow(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetWindow(self,) -> 'None': - """ - Description of GetWindow. - -Args: - - - -Returns: - - None - - """ - pass - - - def ContextSensitiveHelp(self,fEnterMode:'Any') -> 'None': - """ - Description of ContextSensitiveHelp. - -Args: - - fEnterMode(Any):Description for fEnterMode - -Returns: - - None - - """ - pass - - -class PyIPersist(object): - """A Python interface to IPersist""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetClassID(self,) -> 'PyIID': - """ - Returns the class identifier (CLSID) for the component object. - -Args: - - - -Returns: - - PyIID - - """ - pass - - -class PyIPersistFile(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def IsDirty(self,) -> 'None': - """ - Checks an object for changes since it was last saved to its current file. - -Args: - - - -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. - -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 - - - def Load(self,FileName:'Any',Mode:'Any') -> 'None': - """ - Opens the specified file and initializes an object from the file contents. - -Args: - - FileName(Any):Absolute path of the file to open - Mode(Any):Specifies the access mode from the STGM enumeration. - -Returns: - - None - - """ - pass - - - def Save(self,FileName:'Any',fRemember:'Any') -> 'None': - """ - Saves the object into the specified file. - -Args: - - FileName(Any):absolute path of the file where the object is saved. - fRemember(Any):Specifies whether the file is to be the current working file or not. - -Returns: - - None - - """ - pass - - - def SaveCompleted(self,FileName:'Any') -> 'None': - """ - Notifies the object that it can revert from NoScribble mode to Normal mode. - -Args: - - FileName(Any):Absolute path of the file where the object was saved. - -Returns: - - None - - """ - pass - - - def GetCurFile(self,) -> 'Any': - """ - Gets the current name of the file associated with the object. - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIPersistFolder(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,pidl:'Any') -> 'None': - """ - Description of Initialize. - -Args: - - pidl(Any):Description for pidl - -Returns: - - None - - """ - pass - - -class PyIPersistFolder2(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetCurFolder(self,) -> 'None': - """ - Description of GetCurFolder. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIPersistPropertyBag(object): - """A Python wrapper for a COM IPersistPropertyBag interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def InitNew(self,) -> 'None': - """ - Called by the container when the control is initialized to initialize the - -property bag. - -Args: - - - -Returns: - - None - - """ - pass - - - def Load(self,bag:'Any',log:'Any'=None) -> 'None': - """ - Called by the container to load the control's properties. - -Args: - - bag(Any):the caller's property bag. - log(Any):the caller's error log, or None - -Returns: - - None - - """ - pass - - - def Save(self,bag:'Any',clearDirty:'Any',saveProperties:'Any') -> 'None': - """ - Called by the container to save the object's properties. - -Args: - - bag(Any):the caller's property bag. - clearDirty(Any):Specifies whether to clear the dirty flag. - saveProperties(Any):Specifies whether to save all properties or just those that have changed - -Returns: - - None - - """ - pass - - -class PyIPersistSerializedPropStorage(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetFlags(self,flags:'Any') -> 'None': - """ - Sets flags for the store - -Args: - - flags(Any):Combination of pscon.FPSPS_* values - -Returns: - - None - - """ - pass - - - def SetPropertyStorage(self,ps:'Any') -> 'None': - """ - Initializes the store with a serialized buffer - -Args: - - ps(Any):Bytes or buffer object containing a serialized property store - -Returns: - - None - - """ - pass - - - def GetPropertyStorage(self,) -> 'Any': - """ - Retrieves the current contents of the property - -store - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIPersistStorage(object): - """A Python wrapper of a COM IPersistStorage interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def IsDirty(self,) -> 'Any': - """ - Checks the object for changes since it was last saved. - -Args: - - - -Returns: - - Any - - """ - pass - - - def InitNew(self,PyIStorage:'Any') -> 'None': - """ - Initializes a new object, providing a storage object to be used for the object. - -Args: - - PyIStorage(Any):PyIStorage for the new storage object to be initialized. The container creates a nested storage object in its storage object (see PyIStorage::CreateStorage). Then, the container calls the PyIPersistStorage::WriteClassStg function to initialize the new storage object with the object class identifier (CLSID). - -Returns: - - None - - """ - pass - - - def Load(self,storage:'Any') -> 'None': - """ - Loads an object from its existing storage. - -Args: - - storage(Any):Existing storage for the object. - -Returns: - - None - - """ - pass - - - def Save(self,PyIStorage:'Any',_int:'Any') -> 'None': - """ - None - -Args: - - PyIStorage(Any):Storage for the object - _int(Any):Indicates whether the specified storage object is the current one. This parameter is set to FALSE when performing a Save As or Save A Copy To operation or when performing a full save. In the latter case, this method saves to a temporary file, deletes the original file, and renames the temporary file. This parameter is set to TRUE to perform a full save in a low-memory situation or to perform a fast incremental save in which only the dirty components are saved. - -Returns: - - None - - """ - pass - - - def SaveCompleted(self,PyIStorage:'Any') -> 'None': - """ - None - -Args: - - PyIStorage(Any):The current storage object - -Returns: - - None - - """ - pass - - - def HandsOffStorage(self,) -> 'None': - """ - 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 - -operation that works is a close operation. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIPersistStream(object): - """A Python interface to IPersistStream""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def IsDirty(self,) -> 'Any': - """ - Checks the object for changes since it was last saved. - -Args: - - - -Returns: - - Any - - """ - pass - - - def Load(self,stream:'Any') -> 'None': - """ - Initializes an object from the stream where it was previously saved. - -Args: - - stream(Any):Stream object to load from.CommentsThis method loads an object from its associated stream. The seek pointer is set as it was in the most recent PyIPersistStream::Save method. This method can seek and read from the stream, but cannot write to it.On exit, the seek pointer must be in the same position it was in on entry, immediately past the end of the data. - -Returns: - - None - - """ - pass - - - def Save(self,stream:'Any',bClearDirty:'Any') -> 'None': - """ - Saves an object to the specified stream. - -Args: - - stream(Any):The stream to save to. - bClearDirty(Any):Indicates whether to clear the dirty flag after the save is complete - -Returns: - - None - - """ - pass - - - def GetSizeMax(self,) -> 'ULARGE_INTEGER': - """ - Returns the size in bytes of the stream needed to save the - -object. - -Args: - - - -Returns: - - ULARGE_INTEGER - - """ - pass - - -class PyIPersistStreamInit(object): - """A Python interface to IPersistStreamInit""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def InitNew(self,) -> 'None': - """ - Initializes the object to a default state. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIProcessDebugManager(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateApplication(self,) -> 'None': - """ - Description of CreateApplication. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDefaultApplication(self,) -> 'None': - """ - Description of GetDefaultApplication. - -Args: - - - -Returns: - - None - - """ - pass - - - def AddApplication(self,pda:'Any') -> 'None': - """ - Description of AddApplication. - -Args: - - pda(Any):Description for pda - -Returns: - - None - - """ - pass - - - def RemoveApplication(self,dwAppCookie:'Any') -> 'None': - """ - Description of RemoveApplication. - -Args: - - dwAppCookie(Any):Description for dwAppCookie - -Returns: - - None - - """ - pass - - - def CreateDebugDocumentHelper(self,unkOuter:'Any') -> 'None': - """ - Description of CreateDebugDocumentHelper. - -Args: - - unkOuter(Any):The outer object for aggregation, or (usually!) None - -Returns: - - None - - """ - pass - - -class PyIProfAdmin(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetLastError(self,hr:'Any',flags:'Any') -> 'Any': - """ - Returns the last error code for the object. - -Args: - - hr(Any):Contains the error code generated in the previous method call. - flags(Any):Indicates for format for the output. - -Returns: - - Any - - """ - pass - - - def CreateProfile(self,oldProfileName:'str',Password:'str',uiParam:'Any'=0,flags:'Any'=0) -> 'None': - """ - Creates a new profile. - -Args: - - oldProfileName(str):The name of the new profile. - Password(str):Must be None - uiParam(Any):A handle of the parent window for any dialog boxes or windows that this method displays. - flags(Any): - -Returns: - - None - - """ - pass - - - def DeleteProfile(self,oldProfileName:'str',flags:'Any'=0) -> 'None': - """ - Deletes a profile. - -Args: - - oldProfileName(str):The name of the profile to be deleted. - flags(Any): - -Returns: - - None - - """ - pass - - - def CopyProfile(self,oldProfileName:'str',Password:'str',newProfileName:'str',uiParam:'Any'=0,flags:'Any'=0) -> 'None': - """ - Copies a profile. - -Args: - - oldProfileName(str):The name of the profile to copy. - Password(str):Must be None - newProfileName(str):The new name of the copied profile. - uiParam(Any):A handle of the parent window for any dialog boxes or windows that this method displays. - flags(Any): - -Returns: - - None - - """ - pass - - - def RenameProfile(self,oldProfileName:'str',Password:'str',newProfileName:'str',uiParam:'Any'=0,flags:'Any'=0) -> 'None': - """ - Assigns a new name to a profile. - -Args: - - oldProfileName(str):The current name of the profile to rename. - Password(str):Must be None - newProfileName(str):The new name of the profile to rename. - uiParam(Any):A handle of the parent window for any dialog boxes or windows that this method displays. - flags(Any): - -Returns: - - None - - """ - pass - - - def SetDefaultProfile(self,profileName:'str',flags:'Any'=0) -> 'None': - """ - Sets or clears a client's default profile. - -Args: - - profileName(str):The name of the profile that will become the default, or None. Setting profileName to None indicates that SetDefaultProfile should remove the existing default profile, leaving the client without a default. - flags(Any): - -Returns: - - None - - """ - pass - - - def AdminServices(self,profileName:'str',Password:'str'=None,uiParam:'Any'=0,flags:'Any'=0) -> 'Any': - """ - Provides access to a message service administration object for making changes to the message services in a profile. - -Args: - - profileName(str):The name of the profile to be modified. - Password(str): - uiParam(Any):A handle of the parent window for any dialog boxes or windows that this method displays. - flags(Any): - -Returns: - - Any - - """ - pass - - -class PyIPropertyBag(object): - """A Python wrapper for a COM IPropertyBag interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Read(self,propName:'Any',propType:'Any',errorLog:'Any'=None) -> 'Any': - """ - Called by the control to read a property from the storage provided by the - -container. - -Args: - - propName(Any):Name of the property to read. - propType(Any):The type of the object to read. Must be a VT_* Variant Type constant. - errorLog(Any):The caller's PyIErrorLog object in which the property bag stores any errors that occur during reads. Can be None in which case the caller is not interested in errors.CommentsThe result is a Python object, mapped from a COM VARIANT of type as specified in the propType parameter. - -Returns: - - Any - - """ - pass - - - def Write(self,propName:'Any',value:'Any') -> 'None': - """ - Called by the control to write each property in turn to the storage provided by the - -container. - -Args: - - propName(Any):Name of the property to read. - value(Any):The value for the property. The value must be able to be converted to a COM VARIANT. - -Returns: - - None - - """ - pass - - -class PyIPropertyChange(object): - """Interface used to specify a change to a property""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ApplyToPropVariant(self,OrigVal:'Any') -> 'Any': - """ - Applies the change to a variant value - -Args: - - OrigVal(Any):The value to be modified - -Returns: - - Any - - """ - pass - - -class PyIPropertyChangeArray(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetCount(self,) -> 'Any': - """ - Returns the number of changes in the array - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetAt(self,Index:'Any',riid:'PyIID') -> 'Any': - """ - Retrieves a change by zero-based index - -Args: - - Index(Any):Index of the change to retrieve - riid(PyIID):The interface to return - -Returns: - - Any - - """ - pass - - - def InsertAt(self,Index:'Any',PropChange:'Any') -> 'None': - """ - Inserts a change at a specific position - -Args: - - Index(Any):Position at which to place the change - PropChange(Any):The change to be added - -Returns: - - None - - """ - pass - - - def Append(self,PropChange:'Any') -> 'None': - """ - Adds a change to the end of the array - -Args: - - PropChange(Any):The change to be added - -Returns: - - None - - """ - pass - - - def AppendOrReplace(self,PropChange:'Any') -> 'None': - """ - Adds a change, or replaces if an identical property key is already - -in container - -Args: - - PropChange(Any):The change to be added or replaced - -Returns: - - None - - """ - pass - - - def RemoveAt(self,Index:'Any') -> 'None': - """ - Removes a change from the array - -Args: - - Index(Any):Index of change to be removed - -Returns: - - None - - """ - pass - - - def IsKeyInArray(self,key:'Any') -> 'Any': - """ - Checks if array contains a change to a property - -Args: - - key(Any):Property key to look for - -Returns: - - Any - - """ - pass - - -class PyIPropertyDescription(object): - """Gives access to the details of a property definition""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPropertyKey(self,) -> 'Any': - """ - Returns the unique identifier for a property - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetCanonicalName(self,) -> 'Any': - """ - Returns the name of the property - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetPropertyType(self,) -> 'Any': - """ - Returns the variant type of the property (VT_*) - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetDisplayName(self,) -> 'Any': - """ - Returns the property name as shown in the UI - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetEditInvitation(self,) -> 'Any': - """ - Returns the input prompt used in edit controls - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetTypeFlags(self,mask:'Any') -> 'Any': - """ - Returns type flags for the property - -Args: - - mask(Any):Specifies which flags to retrieve (PDTF_*) - -Returns: - - Any - - """ - pass - - - def GetViewFlags(self,) -> 'Any': - """ - Returns the view flags that control how the property is displayed - -(PDVF_*) - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetDefaultColumnWidth(self,) -> 'Any': - """ - Returns the default width in characters - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetDisplayType(self,) -> 'Any': - """ - Returns the display type (PDDT_*) - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetColumnState(self,) -> 'Any': - """ - Returns flags that control how property is displayed in column - -(SHCOLSTATE_*) - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetGroupingRange(self,) -> 'Any': - """ - Returns property's grouping attributes (PDGR_*) - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetRelativeDescriptionType(self,) -> 'Any': - """ - Returns the relative description type (PDRDT_*) - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetRelativeDescription(self,var1:'Any',var2:'Any') -> 'Tuple[Any, Any]': - """ - Compares two values - -Args: - - var1(Any):The first value - var2(Any):The second value - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def GetSortDescription(self,) -> 'Any': - """ - Returns value that determines how sorting options are - -displayed (PDSD_*) - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetSortDescriptionLabel(self,Descending:'Any') -> 'Any': - """ - Returns description of current sort order - -Args: - - Descending(Any):Indicates if order is reversed - -Returns: - - Any - - """ - pass - - - def GetAggregationType(self,) -> 'Any': - """ - Describes how properties for multiple items are displayed - -(PDAT_*) - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetConditionType(self,) -> 'Tuple[Any, Any]': - """ - Returns options that determine how the property is used - -to build a search query - -Args: - - - -Returns: - - Tuple[Any, Any]:PyIPropertyDescription.GetConditionType - -(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') -> 'Any': - """ - Returns an interface used for querying - -valid property range - -Args: - - riid(PyIID):IID of the requested interface - -Returns: - - Any - - """ - pass - - - def CoerceToCanonicalValue(self,Value:'Any') -> 'Any': - """ - Converts a variant value to the exact type expected by - -the property - -Args: - - Value(Any):The property value to be convertedCommentsThis method mutates the PyPROPVARIANT in place. It may be cleared on failure.Return ValueReturns the HRESULT from the operation on success. - -Returns: - - Any:The property value to be convertedComments - -This method mutates the PyPROPVARIANT in place. It may be cleared on failure. -Return ValueReturns the HRESULT from the operation on success. - - - """ - pass - - - def FormatForDisplay(self,Value:'Any',Flags:'Any') -> 'Any': - """ - Converts a value to its string representation - -Args: - - Value(Any):The value to be formatted - Flags(Any):Combination of PROPDESC_FORMAT_FLAGS (PDFF_*) - -Returns: - - Any - - """ - pass - - - def IsValueCanonical(self,Value:'Any') -> 'Any': - """ - Determines if a value exactly matches the specification for - -the property - -Args: - - Value(Any):The value to check - -Returns: - - Any - - """ - pass - - -class PyIPropertyDescriptionAliasInfo(object): - """Interface that gives access to the sorting columns for a property""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetSortByAlias(self,riid:'PyIID') -> 'Any': - """ - Returns the primary column used - -for sorting - -Args: - - riid(PyIID):The interface to return - -Returns: - - Any - - """ - pass - - - def GetAdditionalSortByAliases(self,riid:'PyIID') -> 'Any': - """ - Returns secondary - -sorting columns - -Args: - - riid(PyIID):The interface to return - -Returns: - - Any - - """ - pass - - -class PyIPropertyDescriptionList(object): - """Container for a number of property descriptions""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetCount(self,) -> 'Any': - """ - Gets the number of properties in the list - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetAt(self,Elem:'Any',riid:'PyIID') -> 'Any': - """ - Retrieves a description from the list - -Args: - - Elem(Any):Index of the element to return - riid(PyIID):The interface to return - -Returns: - - Any - - """ - pass - - -class PyIPropertyDescriptionSearchInfo(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetSearchInfoFlags(self,) -> 'Any': - """ - Returns flags controlling how property is indexed - -Args: - - - -Returns: - - Any:PyIPropertyDescriptionSearchInfo.GetSearchInfoFlags - -int = GetSearchInfoFlags()Returns flags controlling how property is indexed -Return ValueReturns a combination of PROPDESC_SEARCHINFO_FLAGS values - - - """ - pass - - - def GetColumnIndexType(self,) -> 'Any': - """ - Returns flags indicating type of property - -Args: - - - -Returns: - - Any:PyIPropertyDescriptionSearchInfo.GetColumnIndexType - -int = GetColumnIndexType()Returns flags indicating type of property -Return ValueReturns a value from the PROPDESC_COLUMNINDEX_TYPE enum - - - """ - pass - - - def GetProjectionString(self,) -> 'Any': - """ - Returns the canonical name of the property - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetMaxSize(self,) -> 'Any': - """ - Returns the maximum size specified in search options - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIPropertyEnumType(object): - """Contains information about an allowable value or range for a property""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetEnumType(self,) -> 'Any': - """ - Retrieves the type (PROPENUMTYPE) - -Args: - - - -Returns: - - Any:PyIPropertyEnumType.GetEnumType - -int = GetEnumType()Retrieves the type (PROPENUMTYPE) -Return Valuepscon.PET_* - - - """ - pass - - - def GetValue(self,) -> 'Any': - """ - Retrieves the defined value - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetRangeMinValue(self,) -> 'Any': - """ - Returns the minimum allowed value for the property - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetRangeSetValue(self,) -> 'Any': - """ - Returns a fixed value defined for the property - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetDisplayText(self,) -> 'None': - """ - Returns the display text for the enumerated type - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIPropertyEnumTypeList(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetCount(self,) -> 'Any': - """ - Returns the number of objects in the list - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetAt(self,itype:'Any',riid:'PyIID') -> 'Any': - """ - Retrieves an item by index - -Args: - - itype(Any):Zero based index of type to return - riid(PyIID):The interface to return - -Returns: - - Any - - """ - pass - - - def FindMatchingIndex(self,Cmp:'Any') -> 'Any': - """ - Attempts to match the specified value to one of the allowable - -values for the property - -Args: - - Cmp(Any):A value to match against the defined values of the property - -Returns: - - Any - - """ - pass - - -class PyIPropertySetStorage(object): - """Container for a collection of property sets. - -Can be iterated over to enumerate property sets.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Create(self,fmtid:'PyIID',clsid:'PyIID',Flags:'Any',Mode:'Any') -> 'Any': - """ - Creates a new property set in the storage object - -Args: - - fmtid(PyIID):GUID identifying a property set, pythoncom.FMTID_* - clsid(PyIID):CLSID of property set handler, usually same as fmtid - Flags(Any):Specifies behaviour of property set, storagecon.PROPSETFLAG_* - Mode(Any):Access mode, combination of storagecon.STGM_* flags - -Returns: - - Any - - """ - pass - - - def Open(self,fmtid:'PyIID',Mode:'Any') -> 'Any': - """ - Opens an existing property set - -Args: - - fmtid(PyIID):GUID of a property set, pythoncom.FMTID_* - Mode(Any):Access mode, combination of storagecon.STGM_* flags - -Returns: - - Any - - """ - pass - - - def Delete(self,fmtid:'PyIID') -> 'None': - """ - Removes a property set from this storage object - -Args: - - fmtid(PyIID):GUID of a property set, pythoncom.FMTID_* - -Returns: - - None - - """ - pass - - - def Enum(self,) -> 'Any': - """ - Creates an iterator to enumerate contained property - -sets - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIPropertyStorage(object): - """Structured storage object that contains a set of properties. - -Supports iteration to list properties.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ReadMultiple(self,props:'Tuple[Any, ...]') -> 'Tuple[Any, ...]': - """ - Reads specified properties from the current property set. - -Args: - - props(Tuple[Any, ...]):Sequence of property IDs or names.Return ValueReturned values are automatically converted to an appropriate python type - -Returns: - - Tuple[Any, ...]:Sequence of property IDs or names.Return ValueReturned values are automatically converted to an appropriate python type - - - """ - pass - - - def WriteMultiple(self,props:'Tuple[Any, ...]',values:'Tuple[Any, ...]',propidNameFirst:'Any'=2) -> 'None': - """ - Creates or modifies properties in the property set - -Args: - - props(Tuple[Any, ...]):Sequence containing names or integer ids of properties to write - values(Tuple[Any, ...]):The values for the properties. - propidNameFirst(Any):Minimum property id to be assigned to new properties specified by name - -Returns: - - None - - """ - pass - - - def DeleteMultiple(self,props:'Tuple[Any, ...]') -> 'None': - """ - Deletes properties from the property set - -Args: - - props(Tuple[Any, ...]):Sequence containing names or IDs of properties to be deleted - -Returns: - - None - - """ - pass - - - def ReadPropertyNames(self,props:'Tuple[Any, ...]') -> 'Tuple[Any, ...]': - """ - Retrieves any existing string names for the specified - -property identifiers. - -Args: - - props(Tuple[Any, ...]):Sequence of ints containing property IDs. - -Returns: - - Tuple[Any, ...] - - """ - pass - - - def WritePropertyNames(self,props:'Tuple[Any, ...]',names:'Tuple[str, ...]') -> 'None': - """ - Assigns string names to a specified array of property IDs in the - -current property set. - -Args: - - props(Tuple[Any, ...]):Sequence containing the property IDs. - names(Tuple[str, ...]):Equal length sequence of property names. - -Returns: - - None - - """ - pass - - - def DeletePropertyNames(self,props:'Tuple[Any, ...]') -> 'None': - """ - Removes property names from specified properties. - -Args: - - props(Tuple[Any, ...]):Sequence of ints containing property IDs. - -Returns: - - None - - """ - pass - - - def Commit(self,CommitFlags:'Any') -> 'None': - """ - Persists the property set to its base storage - -Args: - - CommitFlags(Any):Combination of storagecon.STGC_* flags - -Returns: - - None - - """ - pass - - - def Revert(self,) -> 'None': - """ - Discards any changes that have been made - -Args: - - - -Returns: - - None - - """ - pass - - - def Enum(self,) -> 'Any': - """ - Creates an enumerator for properties in the property set - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetTimes(self,ctime:'PyTime',atime:'PyTime',mtime:'PyTime') -> 'None': - """ - Sets the creation, last access, and modification time - -Args: - - ctime(PyTime):Creation time, or None for no change - atime(PyTime):Last access time, or None for no change - mtime(PyTime):Modification time, or None for no changeCommentsSome property sets do not support these times. - -Returns: - - None - - """ - pass - - - def SetClass(self,clsid:'PyIID') -> 'None': - """ - Sets the GUID for the property set - -Args: - - clsid(PyIID):Description for clsid - -Returns: - - None - - """ - pass - - - def Stat(self,) -> 'Any': - """ - Returns various infomation about the property set - -Args: - - - -Returns: - - Any:PyIPropertyStorage.Stat - -tuple = Stat()Returns various infomation about the property set -Return ValueReturns a tuple representing a STATPROPSETSTG struct. - - - """ - pass - - -class PyIPropertyStore(object): - """Contains a collection of properties""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetCount(self,) -> 'Any': - """ - Returns the number of properties in the store - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetAt(self,iProp:'Any') -> 'Any': - """ - Returns the property key for the specified property - -Args: - - iProp(Any):Zero-based index of property - -Returns: - - Any - - """ - pass - - - def GetValue(self,Key:'Any') -> 'Any': - """ - Retrieves the value of a property - -Args: - - Key(Any):Property key as returned by PyIPropertyStore::GetAt - -Returns: - - Any - - """ - pass - - - def SetValue(self,Key:'Any',Value:'Any') -> 'None': - """ - Sets the value of a property - -Args: - - Key(Any):Property key (see PyIPropertyStore::GetAt) - Value(Any):Variant value which can be converted to the appropriate variant type for the property Pass a VT_EMPTY variant to indicate that the property should be removed. - -Returns: - - None - - """ - pass - - - def Commit(self,) -> 'None': - """ - Commits property changes - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIPropertyStoreCache(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetState(self,key:'Any') -> 'Any': - """ - Retrieves the current state of a property - -Args: - - key(Any):Property identifierReturn ValueA value from the PSC_STATE enum (PSC_NORMAL, PSC_NOTINSOURCE. PSC_DIRTY) - -Returns: - - Any:Property identifierReturn ValueA value from the PSC_STATE enum (PSC_NORMAL, PSC_NOTINSOURCE. PSC_DIRTY) - - - """ - pass - - - def GetValueAndState(self,key:'Any') -> 'Tuple[Any, Any]': - """ - Retrieves the current value and state of a - -property - -Args: - - key(Any):Property identifier - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def SetState(self,key:'Any',state:'Any') -> 'None': - """ - Sets the state of a property - -Args: - - key(Any):Property identifier - state(Any):Value from the PSC_STATE enum (pscon.PSC_*) - -Returns: - - None - - """ - pass - - - def SetValueAndState(self,key:'Any',value:'Any',state:'Any') -> 'None': - """ - Sets the value and state of a property - -Args: - - key(Any):Property identifier - value(Any):The new value - state(Any):The new state (pscon.PSC_*) - -Returns: - - None - - """ - pass - - -class PyIPropertyStoreCapabilities(object): - """Property providers use this interface to indicate whether properties are - -writeable.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def IsPropertyWritable(self,key:'Any') -> 'Any': - """ - Asks provider if a property can be editted. - -Args: - - key(Any):Property identifier - -Returns: - - Any - - """ - pass - - -class PyIPropertySystem(object): - """Wraps the IPropertySystem interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPropertyDescription(self,Key:'Any',riid:'PyIID') -> 'Any': - """ - Returns an interface used to describe a - -property - -Args: - - Key(Any):Fmtid and propertyid that uniquely identifies a property - riid(PyIID):The interface to return - -Returns: - - Any - - """ - pass - - - def GetPropertyDescriptionByName(self,CanonicalName:'Any',riid:'PyIID') -> 'Any': - """ - Returns an interface used to - -describe a property - -Args: - - CanonicalName(Any):Registered name of the property - riid(PyIID):The interface to return - -Returns: - - Any - - """ - pass - - - def GetPropertyDescriptionListFromString(self,PropList:'Any',riid:'PyIID') -> 'Any': - """ - Retrieves property - -descriptions from a string of property names - -Args: - - PropList(Any):String containing a list of properties and flags - riid(PyIID):The interface to return - -Returns: - - Any - - """ - pass - - - def EnumeratePropertyDescriptions(self,Filter:'Any',riid:'PyIID') -> 'Any': - """ - Returns an interface used to - -list defined properties - -Args: - - Filter(Any):Value from PROPDESC_ENUMFILTER (pscon.PDEF_*) that limits what types of properties are listed - riid(PyIID):The interface to return - -Returns: - - Any - - """ - pass - - - def FormatForDisplay(self,Key:'Any',Value:'Any',Flags:'Any') -> 'Any': - """ - Formats a property into a string - -Args: - - Key(Any):Fmtid and property id that identifies the property - Value(Any):The value to format - Flags(Any):Combination of PROPDESC_FORMAT_FLAGS (pscon.PDFF_*) indicating formatting options - -Returns: - - Any - - """ - pass - - - def RegisterPropertySchema(self,Path:'Any') -> 'None': - """ - Registers a set of properties defined in a .propdesc file - -Args: - - Path(Any):Path to a property schema XML file (.propdesc) - -Returns: - - None - - """ - pass - - - def UnregisterPropertySchema(self,Path:'Any') -> 'None': - """ - Removes a set of registered properties - -Args: - - Path(Any):Path to a property schema XML file (.propdesc) - -Returns: - - None - - """ - pass - - - def RefreshPropertySchema(self,) -> 'None': - """ - Not currently implemented by the OS - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIProvideClassInfo(object): - """A Python interface to IProvideClassInfo""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetClassInfo(self,) -> 'Any': - """ - Gets information about the CO_CLASS. - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIProvideClassInfo2(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetGUID(self,flags:'Any') -> 'PyIID': - """ - Gets the GUID for the object. - -Args: - - flags(Any):The flags for the GUID. - -Returns: - - PyIID - - """ - pass - - -class PyIProvideExpressionContexts(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def EnumExpressionContexts(self,) -> 'None': - """ - Description of EnumStackFrames. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIProvideTaskPage(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPage(self,tpType:'Any',PersistChanges:'Any') -> 'None': - """ - Return a property sheet page handle for the spedified type - -(TASKPAGE_TASK,TASKPAGE_SCHEDULE,TASKPAGE_SETTINGS) - -Args: - - tpType(Any):Type of page to retreive (TASKPAGE_TASK,TASKPAGE_SCHEDULE,TASKPAGE_SETTINGS) - PersistChanges(Any):Indicates if changes should be saved automaticallyCommentsThere's not yet anything useful that can be done with this handle - return type subject to change - -Returns: - - None - - """ - pass - - -class PyIQueryAssociations(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Init(self,flags:'Any',assoc:'str',hkeyProgId:'PyHKEY'=None,hwnd:'int'=None) -> 'None': - """ - Initializes the IQueryAssociations interface and sets the root key to the - -appropriate ProgID. - -Args: - - flags(Any):One of shellcon.ASSOCF_* flags - assoc(str):The string data (ie, extension, prog-id, etc) - hkeyProgId(PyHKEY):Root registry key, can be None - hwnd(int):Reserved, must be 0 or None - -Returns: - - None - - """ - pass - - - def GetKey(self,flags:'Any',assocKey:'Any',arg:'str') -> 'Any': - """ - Searches for and retrieves a file association-related key from the - -registry. - -Args: - - flags(Any):Used to control the search. - assocKey(Any):Specifies the type of key that is to be returned. - arg(str):Optional string with information about the location of the key. It is normally set to a shell verb such as 'open'. Set this parameter to None if it is not used. - -Returns: - - Any - - """ - pass - - - def GetString(self,flags:'Any',assocStr:'Any',arg:'str') -> 'Any': - """ - Searches for and retrieves a file association-related string from the - -registry. - -Args: - - flags(Any):Used to control the search. - assocStr(Any):Specifies the type of string that is to be returned. - arg(str):Optional string with information about the location of the key. It is normally set to a shell verb such as 'open'. Set this parameter to None if it is not used.CommentsNote that ASSOCF_NOTRUNCATE semantics are currently not supported - the buffer passed is 2048 bytes long, and will be truncated by the shell if too small. - -Returns: - - Any - - """ - pass - - -class PyIRelatedItem(object): - """Interface used as the base for objects that have a related shell item - -(eg ITransferMediumItem, IDisplayItem, etc). Should not be used directly.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetItemIDList(self,) -> 'Any': - """ - Returns the ID list of the related item - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetItem(self,) -> 'Any': - """ - Returns the related item - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIRemoteDebugApplication(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ResumeFromBreakPoint(self,prptFocus:'Any',bra:'Any',era:'Any') -> 'None': - """ - Continue an application which is currently in a breakpoint. - -Args: - - prptFocus(Any):Description for prptFocus - bra(Any):Break resume action - era(Any):Error resume action - -Returns: - - None - - """ - pass - - - def CauseBreak(self,) -> 'None': - """ - Causes the application to break into the debugger at the earliest - -opportunity. - -Args: - - - -Returns: - - None - - """ - pass - - - def ConnectDebugger(self,pad:'Any') -> 'None': - """ - Connects a debugger to the application. - -Args: - - pad(Any):Description for padCommentsOnly one debugger may be connected at a time; this method fails if there is already a debugger connected. - -Returns: - - None - - """ - pass - - - def DisconnectDebugger(self,) -> 'None': - """ - Disconnects the current debugger from the application. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDebugger(self,) -> 'Any': - """ - Returns the current debugger connected to - -the application. - -Args: - - - -Returns: - - Any - - """ - pass - - - def CreateInstanceAtApplication(self,rclsid:'PyIID',pUnkOuter:'Any',dwClsContext:'Any',riid:'PyIID') -> 'Any': - """ - Create objects in the application - -process address space. - -Args: - - rclsid(PyIID):Description for rclsid - pUnkOuter(Any):Description for pUnkOuter - dwClsContext(Any):Description for dwClsContext - riid(PyIID):Description for riidCommentsProvides a mechanism for the debugger IDE, running out-of-process to the application, to create objects in the application process. This method simply delegates to CoCreateInstance. - -Returns: - - Any - - """ - pass - - - def QueryAlive(self,) -> 'None': - """ - Returns True if alive, else False. - -Args: - - - -Returns: - - None - - """ - pass - - - def EnumThreads(self,) -> 'Any': - """ - Enumerates all threads known - -to be associated with the application. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetName(self,) -> 'None': - """ - Description of GetName. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetRootNode(self,) -> 'Any': - """ - Returns the application node under which - -all nodes associated with the application are added. - -Args: - - - -Returns: - - Any - - """ - pass - - - def EnumGlobalExpressionContexts(self,) -> 'Any': - """ - Enumerates all - -global expression contexts - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIRemoteDebugApplicationEvents(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OnConnectDebugger(self,pad:'Any') -> 'None': - """ - Description of OnConnectDebugger. - -Args: - - pad(Any):Description for pad - -Returns: - - None - - """ - pass - - - def OnDisconnectDebugger(self,) -> 'None': - """ - Description of OnDisconnectDebugger. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnSetName(self,pstrName:'Any') -> 'None': - """ - Description of OnSetName. - -Args: - - pstrName(Any):Description for pstrName - -Returns: - - None - - """ - pass - - - def OnDebugOutput(self,pstr:'Any') -> 'None': - """ - Description of OnDebugOutput. - -Args: - - pstr(Any):Description for pstr - -Returns: - - None - - """ - pass - - - def OnClose(self,) -> 'None': - """ - Description of OnClose. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnEnterBreakPoint(self,prdat:'Any') -> 'None': - """ - Description of OnEnterBreakPoint. - -Args: - - prdat(Any):Description for prdat - -Returns: - - None - - """ - pass - - - def OnLeaveBreakPoint(self,prdat:'Any') -> 'None': - """ - Description of OnLeaveBreakPoint. - -Args: - - prdat(Any):Description for prdat - -Returns: - - None - - """ - pass - - - def OnCreateThread(self,prdat:'Any') -> 'None': - """ - Description of OnCreateThread. - -Args: - - prdat(Any):Description for prdat - -Returns: - - None - - """ - pass - - - def OnDestroyThread(self,prdat:'Any') -> 'None': - """ - Description of OnDestroyThread. - -Args: - - prdat(Any):Description for prdat - -Returns: - - None - - """ - pass - - - def OnBreakFlagChange(self,abf:'Any',prdatSteppingThread:'Any') -> 'None': - """ - Description of OnBreakFlagChange. - -Args: - - abf(Any):Description for abf - prdatSteppingThread(Any):Description for prdatSteppingThread - -Returns: - - None - - """ - pass - - -class PyIRemoteDebugApplicationThread(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetSystemThreadId(self,) -> 'None': - """ - Description of GetSystemThreadId. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetApplication(self,) -> 'None': - """ - Description of GetApplication. - -Args: - - - -Returns: - - None - - """ - pass - - - def EnumStackFrames(self,) -> 'None': - """ - Description of EnumStackFrames. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDescription(self,) -> 'None': - """ - Description of GetDescription. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetNextStatement(self,pStackFrame:'Any',pCodeContext:'Any') -> 'None': - """ - Description of SetNextStatement. - -Args: - - pStackFrame(Any):Description for pStackFrame - pCodeContext(Any):Description for pCodeContext - -Returns: - - None - - """ - pass - - - def GetState(self,) -> 'None': - """ - Description of GetState. - -Args: - - - -Returns: - - None - - """ - pass - - - def Suspend(self,) -> 'None': - """ - Description of Suspend. - -Args: - - - -Returns: - - None - - """ - pass - - - def Resume(self,) -> 'None': - """ - Description of Resume. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetSuspendCount(self,) -> 'None': - """ - Description of GetSuspendCount. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIRunningObjectTable(object): - """A Python interface to IRunningObjectTable""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Register(self,) -> 'Any': - """ - Registers an object and its identifying moniker in the Running Object - -Table (ROT). - -Args: - - - -Returns: - - Any - - """ - pass - - - def Revoke(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def IsRunning(self,objectName:'Any') -> 'Any': - """ - Checks whether an object is running. - -Args: - - objectName(Any):The PyIMoniker interface on the moniker to search for in the Running Object Table.Return ValueDescriptionS_OK (ie, 0)The object identified by objectName is running.S_FALSE (ie, 1)There is no entry for objectName in the ROT, or that the object it identifies is no longer running (in which case, the entry is revoked). - -Returns: - - Any - - """ - pass - - - def GetObject(self,objectName:'Any') -> 'Any': - """ - Checks whether an object is running. - -Args: - - objectName(Any):The PyIMoniker interface on the moniker to search for in the Running Object Table. - -Returns: - - Any - - """ - pass - - - def EnumRunning(self,) -> 'Any': - """ - Creates an enumerator that can list the monikers of - -all the objects currently registered in the Running Object Table (ROT). - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIScheduledWorkItem(object): - """Python object that encapsulates the IScheduledWorkItem interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateTrigger(self,) -> 'Tuple[Any, Any]': - """ - Creates a new trigger for a task, returns index and - -new ITaskTrigger interface - -Args: - - - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def DeleteTrigger(self,Trigger:'Any') -> 'None': - """ - Deletes specified trigger - -Args: - - Trigger(Any):Index of trigger to delete - -Returns: - - None - - """ - pass - - - def GetTriggerCount(self,) -> 'Any': - """ - Returns number of triggers defined for the task - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetTrigger(self,iTrigger:'Any') -> 'Any': - """ - Retrieves ITaskTrigger interface for specified trigger - -index - -Args: - - iTrigger(Any):Index of trigger to retrieve - -Returns: - - Any - - """ - pass - - - def GetTriggerString(self,) -> 'Any': - """ - Creates a human-readable summary of specified trigger - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetRunTimes(self,Count:'Any',Begin:'PyTime',End:'PyTime') -> 'Tuple[PyTime, Any, Any, Any]': - """ - Return specified number of run times within given time - -frame - -Args: - - Count(Any):Number of run times to retrieve - Begin(PyTime):Start time, defaults to current time if not passed or None - End(PyTime):End time, defaults to unlimited if not passed or None - -Returns: - - Tuple[PyTime, Any, Any, Any] - - """ - pass - - - def GetNextRunTime(self,) -> 'PyTime': - """ - Returns next time that task is scheduled to run - -Args: - - - -Returns: - - PyTime - - """ - pass - - - def SetIdleWait(self,wIdleMinutes:'Any',wDeadlineMinutes:'Any') -> 'None': - """ - Sets idle parms for task with trigger of type TASK_EVENT_TRIGGER_ON_IDLE - -Args: - - wIdleMinutes(Any):Nbr of minutes computer must be idle before task fires - wDeadlineMinutes(Any):Maximum nbr of minutes task will wait for computer to become idle - -Returns: - - None - - """ - pass - - - def GetIdleWait(self,) -> 'Tuple[Any, Any]': - """ - Gets IdleMinutes and DeadlineMinutes parms for task with trigger - -of type TASK_EVENT_TRIGGER_ON_IDLE - -Args: - - - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def Run(self,) -> 'None': - """ - Starts task - -Args: - - - -Returns: - - None - - """ - pass - - - def Terminate(self,) -> 'None': - """ - Terminate process if task is running - -Args: - - - -Returns: - - None - - """ - pass - - - def EditWorkItem(self,hParent:'int',dwReserved:'Any') -> 'None': - """ - Brings up standard Scheduled Task dialog - -Args: - - hParent(int):Reserved, use 0 or None if passed - dwReserved(Any):Reserved, use 0 if passed - -Returns: - - None - - """ - pass - - - def GetMostRecentRunTime(self,) -> 'PyTime': - """ - Returns last time task ran - -Args: - - - -Returns: - - PyTime - - """ - pass - - - def GetStatus(self,) -> 'Any': - """ - Returns status (SCHED_S_TASK... constants) - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetExitCode(self,) -> 'Tuple[Any, Any]': - """ - Returns tuple of task's exit code and error returned to Task - -Scheduler if process could not start - -Args: - - - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def SetComment(self,Comment:'Any') -> 'None': - """ - Set comment string for task - -Args: - - Comment(Any):Freeform comment string - -Returns: - - None - - """ - pass - - - def GetComment(self,) -> 'str': - """ - Return comment string associated with task. - -Args: - - - -Returns: - - str - - """ - pass - - - def SetCreator(self,Creator:'Any') -> 'None': - """ - Specify who (or what) created task, can be any string - -Args: - - Creator(Any):Originator of task, does not have to be valid username - -Returns: - - None - - """ - pass - - - def GetCreator(self,) -> 'None': - """ - Returns creator info, can be any string data - -Args: - - - -Returns: - - None - - """ - pass - - - def SetWorkItemData(self,Data:'str') -> 'None': - """ - Set data associated with task (treated as uninterpreted bytes) - -Args: - - Data(str):Character data, treated as uninterpreted bytes - -Returns: - - None - - """ - pass - - - def GetWorkItemData(self,) -> 'str': - """ - Retrieve data associated with task - -Args: - - - -Returns: - - str - - """ - pass - - - def SetErrorRetryCount(self,wRetryCount:'Any') -> 'None': - """ - Specify nbr of times to attempt to run task if it can't start (not - -currently implemented) - -Args: - - wRetryCount(Any):Nbr of attemps to start task - -Returns: - - None - - """ - pass - - - def GetErrorRetryCount(self,) -> 'None': - """ - Return nbr of times Task scheduler should try to run task (not - -currently implemented) - -Args: - - - -Returns: - - None - - """ - pass - - - def SetErrorRetryInterval(self,RetryInterval:'Any') -> 'None': - """ - Interval in minutes between attempts to run task. Not - -implemented according to SDK - -Args: - - RetryInterval(Any):Interval in minutes - -Returns: - - None - - """ - pass - - - def GetErrorRetryInterval(self,) -> 'None': - """ - Returns nbr of minutes between attempts to run task. Not - -implemented according to SDK - -Args: - - - -Returns: - - None - - """ - pass - - - def SetFlags(self,dwFlags:'Any') -> 'None': - """ - Set flags for task - -Args: - - dwFlags(Any):Combination of TASK_FLAG_* constants - -Returns: - - None - - """ - pass - - - def GetFlags(self,) -> 'Any': - """ - Returns flags for task (TASK_FLAG_* constants) - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetAccountInformation(self,AccountName:'Any',Password:'Any') -> 'None': - """ - Set username and password under which task will run - -Args: - - AccountName(Any):AccountName, use "" for local system account (can only be used by Administrators) - Password(Any):Password - Can be None for local System account, or if TASK_FLAG_RUN_ONLY_IF_LOGGED_ON is setCommentsOn some systems, username and password are verified at the time the task is saved, on others when the task tries to run - -Returns: - - None - - """ - pass - - - def GetAccountInformation(self,) -> 'Any': - """ - Returns username that task will run under - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIServerSecurity(object): - """Interface used to access client security settings and perform impersonation""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def QueryBlanket(self,Capabilities:'Any'=0) -> 'Any': - """ - Retrieves security settings specified by the client - -Args: - - Capabilities(Any):Can be EOAC_MAKE_FULLSIC for SChannel provider - -Returns: - - Any - - """ - pass - - - def ImpersonateClient(self,) -> 'None': - """ - Initiates impersonation of client - -Args: - - - -Returns: - - None - - """ - pass - - - def RevertToSelf(self,) -> 'None': - """ - Ends impersonation of client - -Args: - - - -Returns: - - None - - """ - pass - - - def IsImpersonating(self,) -> 'Any': - """ - Determines if server is currently impersonating a client - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIServiceProvider(object): - """A Python interface to IServiceProvider""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def QueryService(self,clsid:'PyIID',iid:'PyIID') -> 'Any': - """ - Creates or accesses the specified service and returns an - -interface object to the specified interface for the service. - -Args: - - clsid(PyIID):Unique identifier for the requested service. - iid(PyIID):Unique identifier for the requested interface on the service. - -Returns: - - Any - - """ - pass - - -class PyIShellBrowser(object): - """Exposed by Windows Explorer and the Open File common dialog box to provide services for - -namespace extensions.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def InsertMenusSB(self,hmenuShared:'int',lpMenuWidths:'Any') -> 'Any': - """ - Updates a composite menu with container's options - -Args: - - hmenuShared(int):Newly created menu that contains no items - lpMenuWidths(Any):Tuple of 6 ints. Items 0,2,and 4 are updated when the tuple is returned. - -Returns: - - Any - - """ - pass - - - def SetMenuSB(self,hmenuShared:'int',holemenuRes:'int',hwndActiveObject:'int') -> 'None': - """ - Attaches a shared menu to a shell view window - -Args: - - hmenuShared(int):Handle to the shared menu - holemenuRes(int):Reserved, use only None (or 0) - hwndActiveObject(int):Handle to the shell window - -Returns: - - None - - """ - pass - - - def RemoveMenusSB(self,hmenuShared:'int') -> 'None': - """ - Asks container to remove any items it added to a composite menu - -Args: - - hmenuShared(int):Handle to the composite menu - -Returns: - - None - - """ - pass - - - def SetStatusTextSB(self,pszStatusText:'Any') -> 'None': - """ - Sets the status text in view's status bar - -Args: - - pszStatusText(Any):New status to be displayed - -Returns: - - None - - """ - pass - - - def EnableModelessSB(self,fEnable:'Any') -> 'None': - """ - Enables or disables modeless dialogs - -Args: - - fEnable(Any):Use True to enable or False to disable modeless dialog boxes - -Returns: - - None - - """ - pass - - - def TranslateAcceleratorSB(self,pmsg:'PyMSG',wID:'Any') -> 'None': - """ - Translates keystrokes used as menu item activators - -Args: - - pmsg(PyMSG):Keystroke message to be translated - wID(Any):Menu command id for the keystroke - -Returns: - - None - - """ - pass - - - def BrowseObject(self,pidl:'Any',wFlags:'Any') -> 'None': - """ - Navigates to a different location - -Args: - - pidl(Any):Item id list that specifies the new browse location, can be None - wFlags(Any):Combination of shellcon.SBSP_* flags - -Returns: - - None - - """ - pass - - - def GetViewStateStream(self,grfMode:'Any') -> 'Any': - """ - Returns a stream that can be used to access view state - -information - -Args: - - grfMode(Any):Read/write mode, one of STGM_READ,STGM_WRITE,STGM_READWRITE - -Returns: - - Any - - """ - pass - - - def GetControlWindow(self,_id:'Any') -> 'None': - """ - Returns a handle to one of the browser's control elements - -Args: - - _id(Any):One of shellcon.FCW_* values - -Returns: - - None - - """ - pass - - - def SendControlMsg(self,_id:'Any',uMsg:'Any',wParam:'Any',lParam:'Any') -> 'Any': - """ - Sends a control msg to browser's toolbar or status bar - -Args: - - _id(Any):shellcon.FCW_TOOLBAR or FCW_STATUS - uMsg(Any):The message to send - wParam(Any):Value is dependent on the message - lParam(Any):Value is dependent on the message - -Returns: - - Any - - """ - pass - - - def QueryActiveShellView(self,) -> 'Any': - """ - Returns the currently displayed view - -Args: - - - -Returns: - - Any - - """ - pass - - - def OnViewWindowActive(self,pshv:'Any') -> 'None': - """ - Callback triggered when a view window is activated - -Args: - - pshv(Any):The activated view object - -Returns: - - None - - """ - pass - - - def SetToolbarItems(self,lpButtons:'Any',uFlags:'Any') -> 'None': - """ - Adds toolbar buttons to the browser's toolbar - -Args: - - lpButtons(Any):Sequence of tuples describing the buttons to be added - uFlags(Any):Indicates button positions, combination of shellcon.FCT_* - -Returns: - - None - - """ - pass - - -class PyIShellExtInit(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,pFolder:'Any',pDataObject:'Any',hkey:'int') -> 'None': - """ - Description of Initialize. - -Args: - - pFolder(Any):Description for pFolder - pDataObject(Any):Description for pDataObject - hkey(int):Description for hkey - -Returns: - - None - - """ - pass - - -class PyIShellFolder(object): - """Interface that represents an Explorer folder""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ParseDisplayName(self,hwndOwner:'int',pbc:'Any',DisplayName:'Any',Attributes:'Any'=0) -> 'Any': - """ - Returns the PIDL of an item in a shell folder - -Args: - - hwndOwner(int):Window in which to display any dialogs or message boxes, can be 0 - pbc(Any):Bind context that affects how parsing is performed, can be None - DisplayName(Any):Display name to parse, format is dependent on the shell folder. Desktop folder will accept a file path, as well as guids of the form ::{guid} Example: '::%s\\::%s' %(shell.CLSID_MyComputer,shell.CLSID_ControlPanel) - Attributes(Any):Combination of shellcon.SFGAO_* constants specifying which attributes should be returnedReturn ValueThe result is a tuple of cchEaten, pidl, attrItems[0] int : cchEatenthe number of characters of the input name that were parsed[1] PyIDL : pidlspecifies the relative path from the parsing folder to the object[2] int : Attributesreturns any requested attributes - -Returns: - - Any:Combination of shellcon.SFGAO_* constants specifying which attributes should be returned -Return ValueThe result is a tuple of cchEaten, pidl, attr -Items[0] int : cchEaten -the number of characters of the input name that were parsed -[1] PyIDL : pidl -specifies the relative path from the parsing folder to the object -[2] int : Attributes -returns any requested attributes - - - """ - pass - - - def EnumObjects(self,grfFlags:'Any',hwndOwner:'int'=None) -> 'Any': - """ - Creates an enumerator to list the contents of the shell folder - -Args: - - grfFlags(Any):Combination of shellcon.SHCONTF_* constants - hwndOwner(int):Window to use if any user interaction is required - -Returns: - - Any - - """ - pass - - - def BindToObject(self,pidl:'Any',pbc:'Any',riid:'PyIID') -> 'Any': - """ - Returns an IShellFolder interface for a subfolder - -Args: - - pidl(Any):Relative item id list that identifies the subfolder, can be multi-level - pbc(Any):Bind context to be used, can be None - riid(PyIID):IID of the desired interface, usually IID_IShellFolder - -Returns: - - Any - - """ - pass - - - def BindToStorage(self,pidl:'Any',pbc:'Any',riid:'PyIID') -> 'Any': - """ - Returns an interface to a storage object in a shell folder - -Args: - - pidl(Any):Relative pidl for the folder item, must be a single item id - pbc(Any):Bind context that affects how binding is performed, can be None - riid(PyIID):IID of the desired interface, one of IID_IStream, IID_IStorage, IID_IPropertySetStorageReturn ValueReturns PyIStream, PyIStorage or PyIPropertySetStorage depending on the riid passed in - -Returns: - - 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 - - - def CompareIDs(self,lparam:'Any',pidl1:'Any',pidl2:'Any') -> 'Any': - """ - Determines the sorting order of 2 items in shell folder - -Args: - - lparam(Any):Lower 16 bits specify folder-dependent sorting rules, 0 means to sort by display name. System folder view uses these as a column number. Upper sixteen bits is used for flags SHCIDS_ALLFIELDS or SHCIDS_CANONICALONLY - pidl1(Any):Item id list that idenfies an object relative to the folder - pidl2(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 - -Returns: - - 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 - - - def CreateViewObject(self,hwndOwner:'Any',riid:'PyIID') -> 'Any': - """ - Creates a view object for a shell folder. - -Args: - - hwndOwner(Any):Parent window for a custom folder view, or 0 - riid(PyIID):IID of the desired interface, usually IID_IShellView - -Returns: - - Any - - """ - pass - - - def GetAttributesOf(self,pidl:'Tuple[Any, ...]',rgfInOut:'Any') -> 'Any': - """ - Queries attributes of items within the shell folder - -Args: - - pidl(Tuple[Any, ...]):A sequence of single-level pidls identifying items directly contained by the folder - rgfInOut(Any):Combination of shellcon.SFGAO_* constantsReturn ValueThe requested attributes are only returned if they are common to all of the specified items - -Returns: - - 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:'Tuple[Any, ...]',riid:'PyIID',iidout:'PyIID',Reserved:'Any'=0) -> 'Tuple[Any, Any]': - """ - Creates an interface to one or more items in a shell - -folder - -Args: - - hwndOwner(int):Specifies a window in which to display any required dialogs or errors, can be 0 - pidl(Tuple[Any, ...]):A sequence of single-level pidls identifying items in the folder - riid(PyIID):The interface to create, one of IID_IContextMenu, IID_IContextMenu2, IID_IDataObject, IID_IDropTarget, IID_IExtractIcon, IID_IQueryInfo - iidout(PyIID):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 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 - Reserved(Any):Reserved, use 0 if passed in - -Returns: - - Tuple[Any, Any]: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 - -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 - - - def GetDisplayNameOf(self,pidl:'Any',uFlags:'Any') -> 'Any': - """ - Returns the display name of an item within this shell folder - -Args: - - pidl(Any):PIDL that identifies the item relative to the parent folder - uFlags(Any):Combination of shellcon.SHGDN_* flags - -Returns: - - Any - - """ - pass - - - def SetNameOf(self,hwndOwner:'Any',pidl:'Any',Name:'Any',Flags:'Any') -> 'Any': - """ - Sets the display name of an item and changes its PIDL - -Args: - - hwndOwner(Any):Window in which to display any message boxes or dialogs, can be 0 - pidl(Any):PIDL that identifies the item relative to the parent folder - Name(Any):New name for the item - Flags(Any):Combination of shellcon.SHGDM_* valuesReturn ValueReturns the new PIDL for item - -Returns: - - Any:Combination of shellcon.SHGDM_* valuesReturn ValueReturns the new PIDL for item - - - """ - pass - - -class PyIShellFolder2(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDefaultSearchGUID(self,pguid:'PyIID') -> 'PyIID': - """ - Retrieves the default search for the folder - -Args: - - pguid(PyIID):Description for pguid - -Returns: - - PyIID - - """ - pass - - - def EnumSearches(self,) -> 'Any': - """ - Returns an interface that lists searches defined for - -the folder - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetDefaultColumn(self,) -> 'Tuple[Any, Any]': - """ - Returns the columns used for sorting and display - -Args: - - - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def GetDefaultColumnState(self,iColumn:'Any') -> 'Any': - """ - Returns flags indicating the default behaviour of the column - -Args: - - iColumn(Any):Zero-based index of the columnReturn ValueReturns a combination of shellcon.SHCOLSTATE_* flags - -Returns: - - Any:Zero-based index of the columnReturn ValueReturns a combination of shellcon.SHCOLSTATE_* flags - - - """ - pass - - - def GetDetailsEx(self,pidl:'Any',pscid:'Any') -> 'Any': - """ - Returns the details of an item by Column ID - -Args: - - pidl(Any):Relative id list of an item in the folder - pscid(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 - -Returns: - - 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:'Any',iColumn:'Any') -> 'Tuple[Any, Any, Any]': - """ - Returns the value or title of a column in the folder's Details - -view. - -Args: - - pidl(Any):The relative idl of an item in the folder. Use None to retrieve column title. - iColumn(Any):Zero based index of columnReturn ValueReturns a tuple representing a SHELLDETAILS struct, containing the formst (LVCFMT_*), column width in characters, and string representation of the requested value - -Returns: - - Tuple[Any, Any, Any]:Zero based index of columnReturn ValueReturns a tuple representing a SHELLDETAILS struct, containing the formst (LVCFMT_*), column width in - -characters, - -and string representation of the requested value - - - """ - pass - - - def MapColumnToSCID(self,Column:'Any') -> 'Any': - """ - Returns the unique identifier (FMTID, pid) of a column - -Args: - - Column(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. - -Returns: - - 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 - - -class PyIShellIcon(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetIconOf(self,pidl:'Any') -> 'None': - """ - Description of GetIconOf. - -Args: - - pidl(Any):Description for pidl - -Returns: - - None - - """ - pass - - -class PyIShellIconOverlay(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetOverlayIndex(self,pidl:'Any') -> 'None': - """ - Description of GetOverlayIndex. - -Args: - - pidl(Any):Description for pidl - -Returns: - - None - - """ - pass - - - def GetOverlayIconIndex(self,pidl:'Any') -> 'None': - """ - Description of GetOverlayIconIndex. - -Args: - - pidl(Any):Description for pidl - -Returns: - - None - - """ - pass - - -class PyIShellIconOverlayIdentifier(object): - """Interface that supplies icon overlay information to the shell""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def IsMemberOf(self,path:'str',attrib:'Any') -> 'Any': - """ - Determines if a shell object should have an icon overlay - -Args: - - path(str):Fully qualified path of the shell object - attrib(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. 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. - -Returns: - - 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. - -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,) -> 'Tuple[str, Any, Any]': - """ - Retrieves the path to the overlay - -icon - -Args: - - - -Returns: - - Tuple[str, Any, Any]:PyIShellIconOverlayIdentifier.GetOverlayInfo - -(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 - -combination of shellcon.ISIOI_ICON* flags - - - """ - pass - - - def GetPriority(self,) -> 'Any': - """ - Retrieves the relative priority of the overlay - -Args: - - - -Returns: - - Any:PyIShellIconOverlayIdentifier.GetPriority - -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 - - -class PyIShellIconOverlayManager(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetFileOverlayInfo(self,path:'Any',attrib:'Any',flags:'Any') -> 'Any': - """ - Returns an index into the system image list for the icon - -image or overlay image - -Args: - - path(Any):Full path to the file - attrib(Any):File attributes (win32com.FILE_ATTRIBUTE_*) - flags(Any):SIOM_OVERLAYINDEX (1) or SIOM_ICONINDEX (2) - -Returns: - - Any - - """ - pass - - - def GetReservedOverlayInfo(self,path:'Any',attrib:'Any',flags:'Any',ireservedID:'Any') -> 'None': - """ - Description of GetReservedOverlayInfo. - -Args: - - path(Any):Description for path - attrib(Any):Description for attrib - flags(Any):Description for flags - ireservedID(Any):Description for ireservedID - -Returns: - - None - - """ - pass - - - def RefreshOverlayImages(self,flags:'Any') -> 'None': - """ - Description of RefreshOverlayImages. - -Args: - - flags(Any):Description for flags - -Returns: - - None - - """ - pass - - - def LoadNonloadedOverlayIdentifiers(self,) -> 'None': - """ - Description of LoadNonloadedOverlayIdentifiers. - -Args: - - - -Returns: - - None - - """ - pass - - - def OverlayIndexFromImageIndex(self,iImage:'Any',fAdd:'Any') -> 'None': - """ - Description of OverlayIndexFromImageIndex. - -Args: - - iImage(Any):Description for iImage - fAdd(Any):Description for fAdd - -Returns: - - None - - """ - pass - - -class PyIShellItem(object): - """Interface that represents an item in the Explorer shell""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def BindToHandler(self,pbc:'Any',bhid:'PyIID',riid:'PyIID') -> 'Any': - """ - Creates an instance of one of the item's handlers - -Args: - - pbc(Any):Used to pass parameters that influence the binding operation, can be None - bhid(PyIID):GUID that identifies a handler (shell.BHID_*) - riid(PyIID):The interface to return - -Returns: - - Any - - """ - pass - - - def GetParent(self,) -> 'Any': - """ - Retrieves the parent of this item - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetDisplayName(self,sigdnName:'Any') -> 'Any': - """ - Returns the display name of the item in the specified format - -Args: - - sigdnName(Any):Format of name to return, shellcon.SIGDN_* - -Returns: - - Any - - """ - pass - - - def GetAttributes(self,Mask:'Any') -> 'Any': - """ - Returns shell attributes of the item - -Args: - - Mask(Any):Combination of shellcon.SFGAO_* values indicating the flags to returnReturn ValueReturns a combination of shellcon.SFGAO_* values - -Returns: - - Any:Combination of shellcon.SFGAO_* values indicating the flags to returnReturn ValueReturns a combination of shellcon.SFGAO_* values - - - """ - pass - - - def Compare(self,psi:'Any',hint:'Any') -> 'Any': - """ - Compares another shell item with this item - -Args: - - psi(Any):A shell item to be compared with this item - hint(Any):shellcon.SICHINT_* value indicating how the comparison is to be performedReturn ValueReturns 0 if items compare as equal, nonzero otherwise - -Returns: - - Any:shellcon.SICHINT_* value indicating how the comparison is to be performedReturn ValueReturns 0 if items compare as equal, nonzero otherwise - - - """ - pass - - -class PyIShellItem2(object): - """Extends the IShellItem interface, giving access to an item's properties""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPropertyStore(self,Flags:'Any',riid:'PyIID') -> 'Any': - """ - Returns a collection of the item's properties - -Args: - - Flags(Any):Combination of GETPROPERTYSTOREFLAGS values (shellcon.GPS_*) - riid(PyIID):The interface to return - -Returns: - - Any - - """ - pass - - - def GetPropertyStoreForKeys(self,Keys:'Tuple[Any, ...]',Flags:'Any',riid:'PyIID') -> 'Any': - """ - Creates a property store containing just the - -specified properties of the item - -Args: - - Keys(Tuple[Any, ...]):A sequence of property identifiers - Flags(Any):Combination of GETPROPERTYSTOREFLAGS values (shellcon.GPS_*) - riid(PyIID):The interface to return - -Returns: - - Any - - """ - pass - - - def GetPropertyStoreWithCreateObject(self,Flags:'Any',CreateObject:'Any',riid:'PyIID') -> 'Any': - """ - Returns the property store for the - -item, with alternate handler instantiation - -Args: - - Flags(Any):Combination of GETPROPERTYSTOREFLAGS values (shellcon.GPS_*) - CreateObject(Any):An interface that implements ICreateObject, used to create the property handler - riid(PyIID):The interface to be createdCommentsPrimarily used to create a handler in a separate process with reduced privileges - -Returns: - - Any - - """ - pass - - - def GetPropertyDescriptionList(self,Type:'Any',riid:'PyIID') -> 'Any': - """ - Retrieves descriptions of - -properties in a particular group - -Args: - - Type(Any):Property list identifier (pscon.PKEY_PropList_*) - riid(PyIID):The interface to return - -Returns: - - Any - - """ - pass - - - def Update(self,BindCtx:'Any'=None) -> 'None': - """ - Refreshes properties that have been modified since interface was created - -Args: - - BindCtx(Any):Bind context used when requesting the interface, or None - -Returns: - - None - - """ - pass - - - def GetProperty(self,key:'Any') -> 'Any': - """ - Retrieves the value of a property, converted to an appropriate python type - -Args: - - key(Any):The id of the property to retrieveReturn ValueType of returned object is determined by the variant type of the property - -Returns: - - Any:The id of the property to retrieveReturn ValueType of returned object is determined by the variant type of the property - - - """ - pass - - - def GetCLSID(self,key:'Any') -> 'PyIID': - """ - Retrieves the value of a property as a CLSID (VT_CLSID) - -Args: - - key(Any):The id of the property to retrieve - -Returns: - - PyIID - - """ - pass - - - def GetFileTime(self,key:'Any') -> 'PyTime': - """ - Retrieves the value of a property as a FILETIME - -Args: - - key(Any):The id of the property to retrieve - -Returns: - - PyTime - - """ - pass - - - def GetInt32(self,key:'Any') -> 'Any': - """ - Retrieves the value of a property as a 32 bit int. - -Args: - - key(Any):The id of the property to retrieve - -Returns: - - Any - - """ - pass - - - def GetString(self,key:'Any') -> 'Any': - """ - Retrieves the value of a property as a string - -Args: - - key(Any):The id of the property to retrieve - -Returns: - - Any - - """ - pass - - - def GetUInt32(self,key:'Any') -> 'Any': - """ - Returns the value of a property as a 32 bit unsigned int - -Args: - - key(Any):The id of the property to retrieve - -Returns: - - Any - - """ - pass - - - def GetUInt64(self,key:'Any') -> 'Any': - """ - Returns the value of a property as an unsigned 64-bit int - -Args: - - key(Any):The id of the property to retrieve - -Returns: - - Any - - """ - pass - - - def GetBool(self,key:'Any') -> 'Any': - """ - Returns the value of a property as a boolean - -Args: - - key(Any):The id of the property to retrieve - -Returns: - - Any - - """ - pass - - -class PyIShellItemArray(object): - """Container for a number of shell items""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def BindToHandler(self,pbc:'Any',rbhid:'PyIID',riid:'PyIID') -> 'Any': - """ - Creates an instance of a handler for the items in the container - -Args: - - pbc(Any):Bind context, can be None - rbhid(PyIID):Bind handler GUID (shell.BHID_*) - riid(PyIID):The interface to return - -Returns: - - Any - - """ - pass - - - def GetPropertyStore(self,flags:'Any',riid:'PyIID') -> 'Any': - """ - Retrieves a store containing consolidated - -properties of items in container - -Args: - - flags(Any):Flags indicating how the properties are retrieved (shellcon.GPS_*) - riid(PyIID):The interface to return, IID_IPropertyStore or related interface - -Returns: - - Any - - """ - pass - - - def GetPropertyDescriptionList(self,Type:'Any',riid:'PyIID') -> 'Any': - """ - Retrieves descriptions for a - -defined group of properties - -Args: - - Type(Any):Property list identifier (pscon.PKEY_PropList_*) - riid(PyIID):The interface to return - -Returns: - - Any - - """ - pass - - - def GetAttributes(self,AttribFlags:'Any',Mask:'Any') -> 'Any': - """ - Retrieves shell attributes of contained items - -Args: - - AttribFlags(Any):SIATTRIBFLAGS value (shellcon.SIATTRIBFLAGS_*) specifying how to combine attributes of multiple items - Mask(Any):Combination of SFGAOF flags (shellcon.SFGAO_*) specifying which attributes to return - -Returns: - - Any - - """ - pass - - - def GetCount(self,) -> 'Any': - """ - Returns the number of items in the container - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetItemAt(self,dwIndex:'Any') -> 'Any': - """ - Retrieves an item by index - -Args: - - dwIndex(Any):Zero-based index of item to retrieve - -Returns: - - Any - - """ - pass - - - def EnumItems(self,) -> 'Any': - """ - Returns an enumeration interface to list contained items - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyIShellItemResources(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetAttributes(self,) -> 'None': - """ - Description of GetAttributes. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetSize(self,) -> 'Any': - """ - Description of GetSize. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetTimes(self,) -> 'None': - """ - Description of GetTimes. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetTimes(self,pftCreation:'PyTime',pftWrite:'PyTime',pftAccess:'PyTime') -> 'None': - """ - Description of SetTimes. - -Args: - - pftCreation(PyTime):Description for pftCreation - pftWrite(PyTime):Description for pftWrite - pftAccess(PyTime):Description for pftAccess - -Returns: - - None - - """ - pass - - - def GetResourceDescription(self,pcsir:'Any') -> 'None': - """ - Description of GetResourceDescription. - -Args: - - pcsir(Any):Description for pcsir - -Returns: - - None - - """ - pass - - - def EnumResources(self,) -> 'Any': - """ - Description of EnumResources. - -Args: - - - -Returns: - - Any - - """ - pass - - - def SupportsResource(self,pcsir:'Any') -> 'Any': - """ - Description of SupportsResource. - -Args: - - pcsir(Any):Description for pcsir - -Returns: - - Any - - """ - pass - - - def OpenResource(self,pcsir:'Any',riid:'PyIID') -> 'Any': - """ - Description of OpenResource. - -Args: - - pcsir(Any):Description for pcsir - riid(PyIID):The interface to return - -Returns: - - Any - - """ - pass - - - def CreateResource(self,sir:'Any',riid:'PyIID') -> 'Any': - """ - Description of CreateResource. - -Args: - - sir(Any):Resource identifier - riid(PyIID):The interface to return - -Returns: - - Any - - """ - pass - - - def MarkForDelete(self,) -> 'None': - """ - Description of MarkForDelete. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIShellLibrary(object): - """Interface used to access Libraries""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def LoadLibraryFromItem(self,Library:'Any',Mode:'Any') -> 'None': - """ - Loads an existing library file - -Args: - - Library(Any):Shell item interface representing the library file - Mode(Any):Access mode, combination of storagecon.STGM_* flags - -Returns: - - None - - """ - pass - - - def LoadLibraryFromKnownFolder(self,Library:'PyIID',Mode:'Any') -> 'None': - """ - Initializes library from a known folder - -Args: - - Library(PyIID):Known folder id, shell.FOLDERID_* - Mode(Any):Access mode, combination of storagecon.STGM_* flags - -Returns: - - None - - """ - pass - - - def AddFolder(self,Location:'Any') -> 'None': - """ - Includes a folder - -Args: - - Location(Any):Shell item interface representing the folder - -Returns: - - None - - """ - pass - - - def RemoveFolder(self,Location:'Any') -> 'None': - """ - Removes a folder - -Args: - - Location(Any):Shell item interface representing the folder - -Returns: - - None - - """ - pass - - - def GetFolders(self,Filter:'Any',riid:'PyIID') -> 'Any': - """ - Retrieves a collection of folders in the library - -Args: - - Filter(Any):Specifies what types of folder to return (shellcon.LFF_*) - riid(PyIID):The interface to return, IObjectCollection and IObjectArray also accepted. - -Returns: - - Any - - """ - pass - - - def ResolveFolder(self,FolderToResolve:'Any',Timeout:'Any',riid:'PyIID') -> 'Any': - """ - Attempts to locate a folder that has been moved or renamed - -Args: - - FolderToResolve(Any):Library item whose location has changed - Timeout(Any):Max search time, specified in milliseconds - riid(PyIID):The interface to return - -Returns: - - Any - - """ - pass - - - def GetDefaultSaveFolder(self,Type:'Any',riid:'PyIID') -> 'Any': - """ - Returns the default folder in which new items are - -saved - -Args: - - Type(Any):Specifies whether to return public or private save location, shellcon.DSFT_* - riid(PyIID):The interface to return - -Returns: - - Any - - """ - pass - - - def SetDefaultSaveFolder(self,Type:'Any',SaveFolder:'Any') -> 'None': - """ - Sets the default save location - -Args: - - Type(Any):Specifies public or private save location, shellcon.DSFT_* - SaveFolder(Any):New default location, must be in the library - -Returns: - - None - - """ - pass - - - def GetOptions(self,) -> 'Any': - """ - Retrieves library option flags - -Args: - - - -Returns: - - Any:PyIShellLibrary.GetOptions - -int = GetOptions()Retrieves library option flags -Return ValueReturns a combination of shellcon.LOF_* flags - - - """ - pass - - - def SetOptions(self,Mask:'Any',Options:'Any') -> 'None': - """ - Sets library option flags - -Args: - - Mask(Any):Bitmask of flags to be changed, combination of shellcon.LOF_* values - Options(Any):New options, combination of shellcon.LOF_* values - -Returns: - - None - - """ - pass - - - def GetFolderType(self,) -> 'PyIID': - """ - Returns the library type, shell.FOLDERTYPEID_* - -Args: - - - -Returns: - - PyIID - - """ - pass - - - def SetFolderType(self,Type:'PyIID') -> 'None': - """ - Sets the folder type for the library - -Args: - - Type(PyIID):New type, shell.FOLDERTYPEID_* - -Returns: - - None - - """ - pass - - - def GetIcon(self,) -> 'Any': - """ - Returns the location of the library's icon - -Args: - - - -Returns: - - Any:PyIShellLibrary.GetIcon - -str = GetIcon()Returns the location of the library's icon -Return ValueUses "module,resource" format - - - """ - pass - - - def SetIcon(self,Icon:'Any') -> 'None': - """ - Sets the library icon - -Args: - - Icon(Any):Icon location in "module,resource" syntax - -Returns: - - None - - """ - pass - - - def Commit(self,) -> 'None': - """ - Saves changes (only if loaded from an existing library) - -Args: - - - -Returns: - - None - - """ - pass - - - def Save(self,FolderToSaveIn:'Any',LibraryName:'Any',Flags:'Any') -> 'Any': - """ - Saves the library to a specific location - -Args: - - FolderToSaveIn(Any):The destination folder, use None to save in current user's Libraries folder - LibraryName(Any):Filename for the new library, without file extension - Flags(Any):Determines behaviour if file already exists, shellcon.LSF_*Return ValueReturns a shell item for the saved file. - -Returns: - - Any:Determines behaviour if file already exists, shellcon.LSF_*Return ValueReturns a shell item for the saved file. - - - """ - pass - - - def SaveInKnownFolder(self,FolderToSaveIn:'PyIID',LibraryName:'Any',Flags:'Any') -> 'Any': - """ - Saves the library in a known folder - -Args: - - FolderToSaveIn(PyIID):The destination folder, shell.FOLDERID_* - LibraryName(Any):Filename for the new library, without file extension - Flags(Any):Determines behaviour if file already exists, shellcon.LSF_* - -Returns: - - Any - - """ - pass - - -class PyIShellLink(object): - """Interface used to access the properties of a shell link file (*.lnk)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPath(self,fFlags:'Any',cchMaxPath:'Any') -> 'Tuple[Any, WIN32_FIND_DATA]': - """ - Retrieves the target path and file name of a shell link - -object - -Args: - - fFlags(Any):One of the following values:ValueDescriptionSLGP_SHORTPATHRetrieves the standard short (8.3 format) file name.SLGP_UNCPRIORITYRetrieves the Universal Naming Convention (UNC) path name of the file.SLGP_RAWPATHRetrieves the raw path name. A raw path is something that might not exist and may include environment variables that need to be expanded. - cchMaxPath(Any):Number of characters to allocate for returned filenameCommentsThe AlternateFileName (8.3) member of WIN32_FIND_DATA does not return information - -Returns: - - Tuple[Any, WIN32_FIND_DATA] - - """ - pass - - - def GetIDList(self,) -> 'Any': - """ - Retrieves the item id list that identifies the target of the shell link. - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetIDList(self,pidl:'Any') -> 'None': - """ - Sets the target of the link using an item id list - -Args: - - pidl(Any):Absolute item id list that identifies the target - -Returns: - - None - - """ - pass - - - def GetDescription(self,cchMaxName:'Any'=1024) -> 'Any': - """ - Retrieves the description of the link (displays as Comment in the UI) - -Args: - - cchMaxName(Any):Number of character to allocate for the retrieved text - -Returns: - - Any - - """ - pass - - - def SetDescription(self,Name:'Any') -> 'None': - """ - Sets the description of the link (displays as Comment in the UI) - -Args: - - Name(Any):The description for the link - -Returns: - - None - - """ - pass - - - def GetWorkingDirectory(self,cchMaxName:'Any'=1024) -> 'Any': - """ - Retrieves the working directory for the link - -Args: - - cchMaxName(Any):Number of characters to allocate for returned text - -Returns: - - Any - - """ - pass - - - def SetWorkingDirectory(self,Dir:'Any') -> 'None': - """ - Sets the working directory for the link. - -Args: - - Dir(Any):The working directory for the link - -Returns: - - None - - """ - pass - - - def GetArguments(self,cchMaxName:'Any'=1024) -> 'Any': - """ - Retrieves the command-line arguments associated with a shell link object. - -Args: - - cchMaxName(Any):Number of characters to fetch. - -Returns: - - Any - - """ - pass - - - def SetArguments(self,args:'Any') -> 'None': - """ - Sets the command-line arguments associated with a shell link object. - -Args: - - args(Any):The new arguments. - -Returns: - - None - - """ - pass - - - def GetHotkey(self,) -> 'Any': - """ - Retrieves the hot key for a shell link object. - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetHotkey(self,wHotkey:'Any') -> 'None': - """ - Sets the hot key for a shell link object. - -Args: - - wHotkey(Any):The virtual key code is in the low-order byte, and the modifier flags are in the high-order byte. The modifier flags can be a combination of the values specified in the description of the PyIShellLink::GetHotkey method. - -Returns: - - None - - """ - pass - - - def GetShowCmd(self,) -> 'Any': - """ - Retrieves the show (SW_) command for a shell link object. - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetShowCmd(self,iShowCmd:'Any') -> 'None': - """ - Sets the show (SW_) command for a shell link object. - -Args: - - iShowCmd(Any):The new show command value. - -Returns: - - None - - """ - pass - - - def GetIconLocation(self,cchMaxPath:'Any') -> 'Any': - """ - Retrieves the location (path and index) of the icon for a shell link - -object. - -Args: - - cchMaxPath(Any):Number of characters to allocate for the result string. - -Returns: - - Any - - """ - pass - - - def SetIconLocation(self,iconPath:'str',iIcon:'Any') -> 'None': - """ - Sets the location (path and index) of the icon for a shell link object. - -Args: - - iconPath(str):Path to the file with the icon. - iIcon(Any):Index of the icon. - -Returns: - - None - - """ - pass - - - def SetRelativePath(self,relPath:'str',reserved:'Any'=0) -> 'None': - """ - Sets the relative path for a shell link object. - -Args: - - relPath(str):The relative path. - reserved(Any):Reserved - must be zero.CommentsThis mechanism allows for moved link files to reestablish connection with relative files through similar-prefix comparisons - -Returns: - - None - - """ - pass - - - def Resolve(self,hwnd:'Any',fFlags:'Any') -> 'None': - """ - Resolves a shell link by searching for the shell link object and updating the - -shell link path and its list of identifiers (if necessary) - -Args: - - hwnd(Any):The parent window of a dialog which will pop up if resolution fails. - fFlags(Any):One of the following constants:ValueDescriptionSLR_INVOKE_MSICall the Microsoft Windows Installer.SLR_NOLINKINFODisable distributed link tracking. By default, distributed link tracking tracks removable media across multiple devices based on the volume name. It also uses the UNC path to track remote file systems whose drive letter has changed. Setting SLR_NOLINKINFO disables both types of tracking.SLR_NO_UIDo not display a dialog box if the link cannot be resolved. When SLR_NO_UI is set, the high-order word of fFlags can be set to a time-out value that specifies the maximum amount of time to be spent resolving the link. The function returns if the link cannot be resolved within the time-out duration. If the high-order word is set to zero, the time-out duration will be set to the default value of 3,000 milliseconds (3 seconds). To specify a value, set the high word of fFlags to the desired time-out duration, in milliseconds.SLR_NOUPDATEDo not update the link information.SLR_NOSEARCHDo not execute the search heuristics.SLR_NOTRACKDo not use distributed link tracking.SLR_UPDATEIf the link object has changed, update its path and list of identifiers. If SLR_UPDATE is set, you do not need to call IPersistFile::IsDirty to determine whether or not the link object has changed. - -Returns: - - None - - """ - pass - - - def SetPath(self,path:'str') -> 'None': - """ - Sets the path and file name of a shell link object. - -Args: - - path(str):The path and filename of the link. - -Returns: - - None - - """ - pass - - -class PyIShellLinkDataList(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddDataBlock(self,DataBlock:'Any') -> 'None': - """ - Inserts a data block into the link - -Args: - - DataBlock(Any):Contents are dependent on type of data block being addedCommentsInput should be one of NT_CONSOLE_PROPS, NT_FE_CONSOLE_PROPS, EXP_SPECIAL_FOLDER, EXP_DARWIN_LINK, or EXP_SZ_LINK. Expected form is indicated by the Signature member. - -Returns: - - None - - """ - pass - - - def CopyDataBlock(self,Sig:'Any') -> 'Any': - """ - Retrieves the specified data block from the link - -Args: - - Sig(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 - -Returns: - - 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 - - - def GetFlags(self,) -> 'Any': - """ - Retrieves the link's flags - -Args: - - - -Returns: - - Any:PyIShellLinkDataList.GetFlags - -int = GetFlags()Retrieves the link's flags -Return ValueReturns combination of shellcon.SLDF_* flags - - - """ - pass - - - def RemoveDataBlock(self,Sig:'Any') -> 'None': - """ - Deletes one of the link's data blocks - -Args: - - Sig(Any):Identifies which block is to be removed, one of shellcon.*_SIG constants - -Returns: - - None - - """ - pass - - - def SetFlags(self,Flags:'Any') -> 'None': - """ - Sets the flags indicating which data blocks are present - -Args: - - Flags(Any):Combination of shellcon.SLDF_* flags - -Returns: - - None - - """ - pass - - -class PyIShellView(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def TranslateAccelerator(self,pmsg:'Any') -> 'Any': - """ - Description of TranslateAccelerator. - -Args: - - pmsg(Any):Description for pmsgReturn ValueThe result is the HRESULT from the underlying TranslateAccelerator call - -Returns: - - Any:Description for pmsgReturn ValueThe result is the HRESULT from the underlying TranslateAccelerator call - - - """ - pass - - - def EnableModeless(self,fEnable:'Any') -> 'None': - """ - Description of EnableModeless. - -Args: - - fEnable(Any):Description for fEnable - -Returns: - - None - - """ - pass - - - def UIActivate(self,uState:'Any') -> 'None': - """ - Description of UIActivate. - -Args: - - uState(Any):Description for uState - -Returns: - - None - - """ - pass - - - def Refresh(self,) -> 'None': - """ - Description of Refresh. - -Args: - - - -Returns: - - None - - """ - pass - - - def CreateViewWindow(self,psvPrevious:'Any',pfs:'Tuple[Any, Any]',psb:'Any',prcView:'Tuple[Any, Any, Any, Any]') -> 'Any': - """ - Description of CreateViewWindow. - -Args: - - psvPrevious(Any):Description for psvPrevious - pfs(Tuple[Any, Any]):Description for pfs - psb(Any):Description for psb - prcView(Tuple[Any, Any, Any, Any]):Description for prcViewReturn ValueThe result is an integer handle to the new window. - -Returns: - - Any:Description for prcViewReturn ValueThe result is an integer handle to the new window. - - - """ - pass - - - def DestroyViewWindow(self,) -> 'None': - """ - Description of DestroyViewWindow. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCurrentInfo(self,) -> 'Any': - """ - Description of GetCurrentInfo. - -Args: - - - -Returns: - - Any - - """ - pass - - - def SaveViewState(self,) -> 'None': - """ - Description of SaveViewState. - -Args: - - - -Returns: - - None - - """ - pass - - - def SelectItem(self,pidlItem:'Any',uFlags:'Any') -> 'None': - """ - Description of SelectItem. - -Args: - - pidlItem(Any):Description for pidlItem - uFlags(Any):Description for uFlags - -Returns: - - None - - """ - pass - - - def GetItemObject(self,uItem:'Any',riid:'PyIID') -> 'Any': - """ - Description of GetItemObject. - -Args: - - uItem(Any):Description for uItem - riid(PyIID):Description for riid - -Returns: - - Any - - """ - pass - - -class PyISpecifyPropertyPages(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPages(self,) -> 'None': - """ - Description of GetPages. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIStorage(object): - """Structured storage compound storage object""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateStream(self,Name:'Any',Mode:'Any',reserved1:'Any'=0,reserved2:'Any'=0) -> 'Any': - """ - 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 - -the same name space. - -Args: - - Name(Any):Name of the new stream - Mode(Any):Access mode, storagecon.STGM_* - reserved1(Any):Reserved - must be zero. - reserved2(Any):Reserved - must be zero. - -Returns: - - Any - - """ - pass - - - def OpenStream(self,Name:'Any',reserved1:'Any',Mode:'Any',reserved2:'Any'=0) -> 'Any': - """ - Opens an existing stream object within this storage object in the - -specified access mode. - -Args: - - Name(Any):Name of stream to be opened - reserved1(Any):A reserved param. Always pass None. NULL is always passed to the COM function - Mode(Any):Access mode, storagecon.STGM_* - reserved2(Any):Reserved - must be zero. - -Returns: - - Any - - """ - pass - - - def CreateStorage(self,Name:'Any',Mode:'Any',StgFmt:'Any',reserved2:'Any'=0) -> 'Any': - """ - Creates and opens a new storage object nested within this storage - -object. - -Args: - - Name(Any):The name of the newly created stream. - Mode(Any):Access mode - combination of storagecon.STGM_* flags - StgFmt(Any):Documented as "reserved"! - reserved2(Any):Description for reserved2 - -Returns: - - Any - - """ - pass - - - def OpenStorage(self,Name:'Any',Priority:'Any',Mode:'Any',snbExclude:'Any',reserved:'Any'=0) -> 'Any': - """ - Opens an existing storage object with the specified name in the - -specified access mode. - -Args: - - Name(Any):Name of the storage, or None. - Priority(Any):If the pstgPriority parameter is not None, it is a PyIStorage object to a previous opening of an element of the storage object, usually one that was opened in priority mode. The storage object should be closed and re-opened according to grfMode. When the PyIStorage::OpenStorage method returns, pstgPriority is no longer valid - use the result value. If the pstgPriority parameter is None, it is ignored. - Mode(Any):Access mode - combination of storagecon.STGM_* flags (must include STGM_SHARE_EXCLUSIVE) - snbExclude(Any):Reserved for later - Must be None - reserved(Any):Reserved integer param. - -Returns: - - Any - - """ - pass - - - def CopyTo(self,rgiidExclude:'Tuple[Any, Any]',snbExclude:'Any',stgDest:'Any') -> 'None': - """ - Copies the entire contents of an open storage object to another storage object. - -Args: - - rgiidExclude(Tuple[Any, Any]):List of IID's to be excluded. Use empty seq to exclude all objects, or None to indicate no excludes. - snbExclude(Any):Reserved for later - Must be None - stgDest(Any):The open storage object into which this storage object is to be copied. The destination storage object can be a different implementation of the PyIStorage interface from the source storage object. Thus, IStorage::CopyTo can only use publicly available methods of the destination storage object. If stgDest is open in transacted mode, it can be reverted by calling its PyIStorage::Revert method. - -Returns: - - None - - """ - pass - - - def MoveElementTo(self,Name:'Any',stgDest:'Any',NewName:'Any',Flags:'Any') -> 'None': - """ - Copies or moves a substorage or stream from this storage object to another - -storage object. - -Args: - - Name(Any):A string that contains the name of the element in this storage object to be moved or copied. - stgDest(Any):PyIStorage for the destination storage object. - NewName(Any):A string that contains the new name for the element in its new storage object. - Flags(Any):Specifies whether to move or copy (storagecon.STGMOVE_MOVE or STGMOVE_COPY) - -Returns: - - None - - """ - pass - - - def Commit(self,grfCommitFlags:'Any') -> 'None': - """ - 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. - -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. - -Args: - - grfCommitFlags(Any):Controls how the changes are committed to the storage object. See the STGC enumeration for a definition of these values. - -Returns: - - None - - """ - pass - - - def Revert(self,) -> 'None': - """ - Discards all changes that have been made to the storage object since the last commit. - -Args: - - - -Returns: - - None - - """ - pass - - - def EnumElements(self,reserved1:'Any'=0,reserved2:'Any'=None,reserved3:'Any'=0) -> 'Any': - """ - Retrieves an enumerator object that can be used to enumerate the - -storage and stream objects contained within this storage object. - -Args: - - reserved1(Any):Reserved - must be zero. - reserved2(Any):A reserved param. Always pass None. NULL is always passed to the COM function - reserved3(Any):Reserved - must be zero. - -Returns: - - Any - - """ - pass - - - def DestroyElement(self,name:'str') -> 'None': - """ - Removes the specified storage or stream from this storage object. - -Args: - - name(str):The name of the element to be removed. - -Returns: - - None - - """ - pass - - - def RenameElement(self,OldName:'Any',NewName:'Any') -> 'None': - """ - Renames the specified substorage or stream in this storage object. - -Args: - - OldName(Any):The name of the substorage or stream to be changed. - NewName(Any):The new name for the specified sustorage or stream. - -Returns: - - None - - """ - pass - - - def SetElementTimes(self,name:'Any',ctime:'PyTime',atime:'PyTime',mtime:'PyTime') -> 'None': - """ - Sets the modification, access, and creation times of the specified storage - -element, if supported by the underlying file system. - -Args: - - name(Any):The name of the storage object element whose times are to be modified. If NULL, the time is set on the root storage rather than one of its elements. - ctime(PyTime):Either the new creation time for the element or None if the creation time is not to be modified. - atime(PyTime):Either the new access time for the element or None if the access time is not to be modified. - mtime(PyTime):Either the new modification time for the element or None if the modification time is not to be modified. - -Returns: - - None - - """ - pass - - - def SetClass(self,clsid:'PyIID') -> 'None': - """ - Assigns the specified CLSID to this storage object. - -Args: - - clsid(PyIID):The class identifier (CLSID) that is to be associated with the storage object. - -Returns: - - None - - """ - pass - - - def SetStateBits(self,grfStateBits:'Any',grfMask:'Any') -> 'None': - """ - Stores up to 32 bits of state information in this storage object. - -Args: - - grfStateBits(Any):Specifies the new values of the bits to set. No legal values are defined for these bits; they are all reserved for future use and must not be used by applications. - grfMask(Any):A binary mask indicating which bits in grfStateBits are significant in this call. - -Returns: - - None - - """ - pass - - - def Stat(self,grfStatFlag:'Any') -> 'Any': - """ - Retrieves the STATSTG structure for this open storage object. - -Args: - - grfStatFlag(Any):Specifies that some of the fields in the STATSTG structure are not returned, thus saving a memory allocation operation. Values are taken from the STATFLAG enumeration. - -Returns: - - Any - - """ - pass - - -class PyIStream(object): - """A Python interface to IStream""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Read(self,numBytes:'Any') -> 'str': - """ - Read the specified number of bytes from the string. - -Args: - - numBytes(Any):The number of bytes to read from the stream. Must not be zero.Return ValueThe result is a string containing binary data. - -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 - - - def read(self,numBytes:'Any') -> 'str': - """ - Read the specified number of bytes from the string. - -Args: - - numBytes(Any):The number of bytes to read from the stream. Must not be zero.Return ValueThe result is a string containing binary data. - -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 - - - def Write(self,data:'str') -> 'None': - """ - Write data to a stream - -Args: - - data(str):The binary data to write. - -Returns: - - None - - """ - pass - - - def write(self,data:'str') -> 'None': - """ - Write data to a stream - -Args: - - data(str):The binary data to write. - -Returns: - - None - - """ - pass - - - def Seek(self,offset:'Any',origin:'Any') -> 'ULARGE_INTEGER': - """ - Changes the seek pointer to a new location. - -Args: - - offset(Any):The new location - origin(Any):Relative to where? - -Returns: - - ULARGE_INTEGER - - """ - pass - - - def SetSize(self,newSize:'ULARGE_INTEGER') -> 'None': - """ - Changes the size of the stream object. - -Args: - - newSize(ULARGE_INTEGER):The new size - -Returns: - - None - - """ - pass - - - def CopyTo(self,stream:'Any',cb:'ULARGE_INTEGER') -> 'ULARGE_INTEGER': - """ - Copies a specified number of bytes from the current seek pointer in the - -stream to the current seek pointer in another stream. - -Args: - - stream(Any):The stream to write to. - cb(ULARGE_INTEGER):The number of bytes to write.Return ValueThe return value is the number of bytes actually written. - -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:'Any') -> 'None': - """ - Ensures that any changes made to a stream object open in transacted mode are reflected in - -the parent storage. - -Args: - - flags(Any):Controls how changes are performed. - -Returns: - - None - - """ - pass - - - def Revert(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def LockRegion(self,offset:'ULARGE_INTEGER',cb:'ULARGE_INTEGER',lockType:'Any') -> 'None': - """ - Restricts access to a specified range of bytes in the stream. - -Args: - - offset(ULARGE_INTEGER):Integer that specifies the byte offset for the beginning of the range. - cb(ULARGE_INTEGER):The number of bytes to restrict. - lockType(Any):Restrictions requested. - -Returns: - - None - - """ - pass - - - def UnLockRegion(self,offset:'ULARGE_INTEGER',cb:'ULARGE_INTEGER',lockType:'Any') -> 'None': - """ - None - -Args: - - offset(ULARGE_INTEGER):Integer that specifies the byte offset for the beginning of the range. - cb(ULARGE_INTEGER):The number of bytes to restrict. - lockType(Any):Restrictions requested. - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'Any': - """ - Creates a new stream object with its own seek pointer that references the - -same bytes as the original stream. - -Args: - - - -Returns: - - Any - - """ - pass - - - def Stat(self,grfStatFlag:'Any'=0) -> 'Any': - """ - Returns information about the stream - -Args: - - grfStatFlag(Any):Flags. - -Returns: - - Any - - """ - pass - - -class PyITask(object): - """Python object that encapsulates the ITask interface, inherits all the methods of PyIScheduledWorkItem""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetApplicationName(self,ApplicationName:'Any') -> 'None': - """ - Specify which program the task will run - -Args: - - ApplicationName(Any):Program to execute - -Returns: - - None - - """ - pass - - - def GetApplicationName(self,) -> 'Any': - """ - Retrieve name of program that task will run - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetParameters(self,Parameters:'Any') -> 'None': - """ - Sets command line parameters - -Args: - - Parameters(Any):String containing command line parameters - -Returns: - - None - - """ - pass - - - def GetParameters(self,) -> 'Any': - """ - Returns command line parameters for task - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetWorkingDirectory(self,WorkingDirectory:'Any') -> 'None': - """ - Sets initial working directory for task - -Args: - - WorkingDirectory(Any):Initial working directory - -Returns: - - None - - """ - pass - - - def GetWorkingDirectory(self,) -> 'Any': - """ - Return working directory that the task will start out in - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetPriority(self,Priority:'Any') -> 'None': - """ - Sets priority for task - -Args: - - Priority(Any):One of REALTIME_PRIORITY_CLASS, HIGH_PRIORITY_CLASS, NORMAL_PRIORITY_CLASS, IDLE_PRIORITY_CLASS - -Returns: - - None - - """ - pass - - - def GetPriority(self,) -> 'Any': - """ - Gets priority that will be assigned to process when task starts - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetTaskFlags(self,dwFlags:'Any') -> 'None': - """ - Sets flag for task. - -Args: - - dwFlags(Any):None currently defined - -Returns: - - None - - """ - pass - - - def GetTaskFlags(self,) -> 'Any': - """ - Retrieve task flags (None currently defined) - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetMaxRunTime(self,MaxRunTimeMS:'Any') -> 'None': - """ - Sets maximun run time for task, use -1 to disable - -Args: - - MaxRunTimeMS(Any):Specified in milliseconds (use -1 to disable, not 0) - -Returns: - - None - - """ - pass - - - def GetMaxRunTime(self,) -> 'Any': - """ - Returns maximun run time for task - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyITaskScheduler(object): - """Interface to the Windows Task Scheduler""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetTargetComputer(self,Computer:'Any') -> 'None': - """ - Connect to another machine to manage its tasks - -Args: - - Computer(Any):Name of system to connect toCommentsLeading backslashes are required. Call will succeed without them, but no other methods will work. - -Returns: - - None - - """ - pass - - - def GetTargetComputer(self,) -> 'Any': - """ - Returns name of computer that the Task Scheduler is - -connected to - -Args: - - - -Returns: - - Any - - """ - pass - - - def Enum(self,) -> 'Tuple[str, ...]': - """ - Retrieve list of task names - -Args: - - - -Returns: - - Tuple[str, ...] - - """ - pass - - - def Activate(self,Name:'Any',riid:'PyIID') -> 'Any': - """ - Opens the specified task and returns an ITask interface for it - -Args: - - Name(Any):Name of task to retreive - riid(PyIID):IID to return, currently only IID_ITask accepted - -Returns: - - Any - - """ - pass - - - def Delete(self,TaskName:'Any') -> 'None': - """ - Delete task by name - -Args: - - TaskName(Any):Name of task to delete - -Returns: - - None - - """ - pass - - - def NewWorkItem(self,TaskName:'Any',rclsid:'PyIID',riid:'PyIID') -> 'Any': - """ - Creates a new task - -Args: - - TaskName(Any):Name of new task - rclsid(PyIID):Class id of work item, currently only CLSID_CTask (defaults if not passed in) - riid(PyIID):Interface IID to return, currently only IID_ITask (defaults if not passed in) - -Returns: - - Any - - """ - pass - - - def AddWorkItem(self,TaskName:'Any',WorkItem:'Any') -> 'None': - """ - Create a new scheduled task from PyITask object - -Args: - - TaskName(Any):Name of task to be created - WorkItem(Any):Existing PyITask objectCommentsThe PyItask passed in is modified in place and on success is associated with the new task, not the old one - -Returns: - - None - - """ - pass - - - def IsOfType(self,Name:'Any',riid:'PyIID') -> 'None': - """ - Check if named object supports specified interface - -Args: - - Name(Any):Name of object - riid(PyIID):Named object is checked that it supports the interface of this IID - -Returns: - - None - - """ - pass - - -class PyITaskTrigger(object): - """Python object that encapsulates the ITaskTrigger interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetTrigger(self,Trigger:'Any') -> 'None': - """ - Set trigger parameters from a PyTASK_TRIGGER object - -Args: - - Trigger(Any):Python object representing a TASK_TRIGGER struct - -Returns: - - None - - """ - pass - - - def GetTrigger(self,) -> 'Any': - """ - Retrieves trigger parms as a PyTASK_TRIGGER object - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetTriggerString(self,) -> 'str': - """ - Build text summary of trigger - -Args: - - - -Returns: - - str - - """ - pass - - -class PyITaskbarList(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def HrInit(self,) -> 'None': - """ - Intializes the interface before use - -Args: - - - -Returns: - - None - - """ - pass - - - def AddTab(self,hwnd:'int') -> 'None': - """ - Places a window on the taskbar - -Args: - - hwnd(int):Handle to window, should have WS_CAPTION style - -Returns: - - None - - """ - pass - - - def DeleteTab(self,hwnd:'int') -> 'None': - """ - Removes a window from the taskbar - -Args: - - hwnd(int):Handle to window, should have WS_CAPTION style - -Returns: - - None - - """ - pass - - - def ActivateTab(self,hwnd:'int') -> 'None': - """ - Marks a window as the active tab on the taskbar - -Args: - - hwnd(int):Handle to window, should have WS_CAPTION style - -Returns: - - None - - """ - pass - - - def SetActiveAlt(self,hwnd:'int') -> 'None': - """ - Sets the window as the active tab, without displaying it as pressed on the - -taskbar - -Args: - - hwnd(int):Handle to window, should have WS_CAPTION style - -Returns: - - None - - """ - pass - - -class PyITransferAdviseSink(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def UpdateProgress(self,SizeCurrent:'Any',SizeTotal:'Any',FilesCurrent:'Any',FilesTotal:'Any',FoldersCurrent:'Any',FoldersTotal:'Any') -> 'None': - """ - Gives an estimate of amount of work completed - -Args: - - SizeCurrent(Any):Bytes transferred so far - SizeTotal(Any):Total number of bytes - FilesCurrent(Any):Number of files processed already - FilesTotal(Any):Total number of files - FoldersCurrent(Any):Number of folders processed already - FoldersTotal(Any):Total number of folder - -Returns: - - None - - """ - pass - - - def UpdateTransferState(self,State:'Any') -> 'None': - """ - Notifies client of current operation state - -Args: - - State(Any):A TRANSFER_ADVISE_STATE value (shellcon.TS_*) - -Returns: - - None - - """ - pass - - - def ConfirmOverwrite(self,Source:'Any',DestParent:'Any',Name:'Any') -> 'Any': - """ - Asks user for permission to overwrite an existing item - -Args: - - Source(Any):The item that will replace existing item - DestParent(Any):Folder into which item will be placed - Name(Any):New name for item, or None if item is to keep original name - -Returns: - - Any - - """ - pass - - - def ConfirmEncryptionLoss(self,Source:'Any') -> 'Any': - """ - Notifies user when an item can't be encrypted at - -destination - -Args: - - Source(Any):Item that failed to be encrypted - -Returns: - - Any - - """ - pass - - - def FileFailure(self,Item:'Any',ItemName:'Any',Error:'Any') -> 'Tuple[Any, Any]': - """ - Notifies user of failure, and queries how to proceed - -Args: - - Item(Any):The shell item that caused the failure - ItemName(Any):Name of item if different than above, can be None - Error(Any):HRESULT error code from operationReturn ValueReturns the HRESULT and new file name if renaming resolved the failure - -Returns: - - Tuple[Any, Any]:HRESULT error code from operationReturn ValueReturns the HRESULT and new file name if renaming resolved the failure - - - """ - pass - - - def SubStreamFailure(self,Item:'Any',StreamName:'Any',Error:'Any') -> 'Any': - """ - Notifies user of failure on a substream, and queries how to - -proceed - -Args: - - Item(Any):The item whose stream couldn't be created - StreamName(Any):Name of the failed stream - Error(Any):HRESULT failure code from operationReturn ValueReturns COPYENGINE_S_* if operation is to continue, or COPYENGINE_E_* HRESULT if cancelled - -Returns: - - Any:HRESULT failure code from operationReturn ValueReturns COPYENGINE_S_* if operation is to continue, or COPYENGINE_E_* HRESULT if cancelled - - - """ - pass - - - def PropertyFailure(self,Item:'Any',key:'Any',Error:'Any') -> 'Any': - """ - Notifies user of failure to set an item's properties - -Args: - - Item(Any):The item whose property could not be set - key(Any):Identifies the property that caused the error, or None if all properties failed - Error(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 - -Returns: - - 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 - - -class PyITransferDestination(object): - """Implemented by shell extensions that act as targets for item copy or move operations""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Advise(self,Sink:'Any') -> 'Any': - """ - Connects an advise sink - -Args: - - Sink(Any):Event sink to receive notificationsReturn ValueReturns an id for the connection, to be passed to PyITransferDestination::Unadvise - -Returns: - - Any:Event sink to receive notificationsReturn ValueReturns an id for the connection, to be passed to PyITransferDestination::Unadvise - - - """ - pass - - - def Unadvise(self,Cookie:'Any') -> 'None': - """ - Disconnects an advise sink - -Args: - - Cookie(Any):Connection identifier as returned by PyITransferDestination::Advise - -Returns: - - None - - """ - pass - - - def CreateItem(self,Name:'Any',Attributes:'Any',Size:'Any',Flags:'Any',riidItem:'PyIID',riidResources:'PyIID') -> 'Tuple[Any, Any, Any]': - """ - Requests that a new item be created - -Args: - - Name(Any):Filename to be created - Attributes(Any):File attributes - Size(Any):Size of file - Flags(Any):Combination of shellcon.TSF_* flags - riidItem(PyIID):Item interface to return - riidResources(PyIID):Resource interface to returnReturn ValueReturns the HRESULT and requested interfaces. Interfaces may be None if function returns one of the informational codes (shellcon.COPYENGINE_S_*) - -Returns: - - Tuple[Any, Any, Any]:Resource interface to return -Return ValueReturns the HRESULT and requested interfaces. Interfaces may be None if - -function returns one of the informational codes (shellcon.COPYENGINE_S_*) - - - """ - pass - - -class PyITransferMediumItem(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyITransferSource(object): - """Implemented by shell folders that can act as the source of shell item operations""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Advise(self,Sink:'Any') -> 'Any': - """ - Connects an advise sink to receive notifications - -Args: - - Sink(Any):Event sink to respond to notifications - -Returns: - - Any - - """ - pass - - - def Unadvise(self,Cookie:'Any') -> 'None': - """ - Disconnects an event sink - -Args: - - Cookie(Any):Connection id as returned by PyITransferSource::Advise - -Returns: - - None - - """ - pass - - - def SetProperties(self,proparray:'Any') -> 'None': - """ - Specifies changes to be applied to items' properties - -Args: - - proparray(Any):Property changes to be applied by PyITransferSource::ApplyPropertiesToItem - -Returns: - - None - - """ - pass - - - def OpenItem(self,Item:'Any',flags:'Any',riid:'PyIID') -> 'Tuple[Any, Any]': - """ - Initiates the copying of an item - -Args: - - Item(Any):The item to be copied. - flags(Any):Combination of shellcon.TSF_* flags - riid(PyIID):The interface to return - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def MoveItem(self,Item:'Any',ParentDst:'Any',NameDst:'Any',flags:'Any') -> 'Tuple[Any, Any]': - """ - Moves a shell item into another folder - -Args: - - Item(Any):Item to be moved - ParentDst(Any):The folder into which it will be moved - NameDst(Any):New name for item after move, None to keep same name - flags(Any):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 of expected actions for specific error codes. - -Returns: - - Tuple[Any, Any]: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 - -of expected actions for specific error codes. - - - """ - pass - - - def RecycleItem(self,Source:'Any',ParentDest:'Any',flags:'Any') -> 'Tuple[Any, Any]': - """ - Moves an item to the recycle bin - -Args: - - Source(Any):The item to be recycled - ParentDest(Any):Shell item representing the recycle bin - flags(Any):Combination of shellcon.TSF_* flags - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def RemoveItem(self,Source:'Any',flags:'Any') -> 'Any': - """ - Deletes an item without recycling - -Args: - - Source(Any):The item to be deleted - flags(Any):Combination of shellcon.TSF_* flagsReturn ValueReturns the HRESULT of the operation - -Returns: - - Any:Combination of shellcon.TSF_* flagsReturn ValueReturns the HRESULT of the operation - - - """ - pass - - - def RenameItem(self,Source:'Any',NewName:'Any',flags:'Any') -> 'Tuple[Any, Any]': - """ - Renames a shell item - -Args: - - Source(Any):Item to be renamed - NewName(Any):The name to be given to the item - flags(Any):Combination of shellcon.TSF_* flags - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def LinkItem(self,Source:'Any',ParentDest:'Any',NewName:'Any',flags:'Any') -> 'Tuple[Any, Any]': - """ - Not implemented, according to MSDN - -Args: - - Source(Any):Description for psiSource - ParentDest(Any):Description for psiParentDest - NewName(Any):Description for NewName - flags(Any):Combination of shellcon.TSF_* flags - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def ApplyPropertiesToItem(self,Source:'Any') -> 'Any': - """ - None - -Args: - - Source(Any):Item whose properties are to be changed - -Returns: - - Any - - """ - pass - - - def GetDefaultDestinationName(self,Source:'Any',ParentDest:'Any') -> 'Any': - """ - Determines the name of an item as it would appear in a - -given folder - -Args: - - Source(Any):The item whose name is wanted - ParentDest(Any):The destination folder - -Returns: - - Any - - """ - pass - - - def EnterFolder(self,ChildFolderDest:'Any') -> 'Any': - """ - Informs the copy engine that a folder will be the target of a file - -operation - -Args: - - ChildFolderDest(Any):The destination folder for the operation - -Returns: - - Any - - """ - pass - - - def LeaveFolder(self,ChildFolderDest:'Any') -> 'Any': - """ - Informs the copy engine that the operation on a destination folder is - -finished - -Args: - - ChildFolderDest(Any):Destination folder - -Returns: - - Any - - """ - pass - - -class PyITypeComp(object): - """An object that implements the ITypeComp interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Bind(self,szName:'str',wflags:'Any'=0) -> 'Any': - """ - binds to a variable/type - -Args: - - szName(str):The name to bind to - wflags(Any):the bind flags - -Returns: - - Any - - """ - pass - - - def BindType(self,szName:'str') -> 'Any': - """ - binds to a type - -Args: - - szName(str):The name to bind to - -Returns: - - Any - - """ - pass - - -class PyITypeInfo(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetContainingTypeLib(self,) -> 'Tuple[Any, Any]': - """ - Retrieves the containing type library and the index of - -the type description within that type library. - -Args: - - - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def GetDocumentation(self,memberId:'Any') -> 'Tuple[Any, Any, Any, Any]': - """ - Retrieves the documentation string, - -the complete Help file name and path, and the context ID for the Help topic for a specified type description. - -Args: - - memberId(Any): - -Returns: - - Tuple[Any, Any, Any, Any] - - """ - pass - - - def GetFuncDesc(self,memberId:'Any') -> 'Any': - """ - None - -Args: - - memberId(Any): - -Returns: - - Any - - """ - pass - - - def GetImplTypeFlags(self,index:'Any') -> 'Any': - """ - Retrieves the IMPLTYPEFLAGS enumeration for one implemented interface or - -base interface in a type description. - -Args: - - index(Any): - -Returns: - - Any - - """ - pass - - - def GetIDsOfNames(self,) -> 'Any': - """ - Maps between member names and member IDs, and parameter names and parameter - -IDs. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetNames(self,memberId:'Any') -> 'Any': - """ - 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. - -Args: - - memberId(Any): - -Returns: - - Any - - """ - pass - - - def GetTypeAttr(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetRefTypeInfo(self,hRefType:'Any') -> 'Any': - """ - If a type description references other type descriptions, it - -retrieves the referenced type descriptions. - -Args: - - hRefType(Any): - -Returns: - - Any - - """ - pass - - - def GetRefTypeOfImplType(self,hRefType:'Any') -> 'Any': - """ - Retrieves the type description of the implemented interface types. - -Args: - - hRefType(Any):CommentsIf a type description describes a COM class, it retrieves the type description of the implemented interface types. For an interface, GetRefTypeOfImplType returns the type information for inherited interfaces, if any exist. - -Returns: - - Any - - """ - pass - - - def GetVarDesc(self,memberId:'Any') -> 'Any': - """ - None - -Args: - - memberId(Any): - -Returns: - - Any - - """ - pass - - - def GetTypeComp(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyITypeLib(object): - """An object that implements the ITypeLib interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDocumentation(self,index:'Any') -> 'Any': - """ - Retrieves documentation information about the library. - -Args: - - index(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) - -Returns: - - 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 - - - def GetLibAttr(self,) -> 'Any': - """ - Retrieves the libraries attributes - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetTypeComp(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetTypeInfo(self,index:'Any') -> 'Any': - """ - Retrieves the specified type description in the library. - -Args: - - index(Any):The index of the type description within the library - -Returns: - - Any - - """ - pass - - - def GetTypeInfoCount(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetTypeInfoOfGuid(self,iid:'PyIID') -> 'Any': - """ - Retrieves the type info of the specified GUID. - -Args: - - iid(PyIID):GUID of the type description. - -Returns: - - Any - - """ - pass - - - def GetTypeInfoType(self,index:'Any') -> 'Any': - """ - Retrieves the type of a type description. - -Args: - - index(Any):The index of the type description within the library - -Returns: - - Any - - """ - pass - - -class PyIUniformResourceLocator(object): - """Interface to an internet shortcut""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetURL(self,) -> 'Any': - """ - Returns the URL for the shortcut - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetURL(self,URL:'Any',InFlags:'Any'=0) -> 'None': - """ - Sets the URL for the shortcut - -Args: - - URL(Any):The url to be set - InFlags(Any):One of the shellcon.IURL_SETURL* flags - -Returns: - - None - - """ - pass - - - def InvokeCommand(self,Verb:'Any',Flags:'Any'=0,hwndParent:'int'=0) -> 'Any': - """ - Performs one of the object's predefined actions - -Args: - - Verb(Any):The verb to be invoked - Flags(Any):Combination of shellcon.IURL_INVOKECOMMAND_* flags - hwndParent(int):Handle to parent window - -Returns: - - Any - - """ - pass - - -class PyIUnknown(object): - """The base object for all PythonCOM objects. Wraps a COM IUnknown object.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def QueryInterface(self,iid:'Any',useIID:'Any'=None) -> 'Any': - """ - Queries an object for a specific interface. - -Args: - - iid(Any):The IID requested. - useIID(Any):If provided and not None, will return an 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.CommentsThe useIID parameter is a very dangerous option, and should only be used when you are sure you need it! 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 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. For example, this option can be used to obtain a PyIUnknown object if pythoncom does not natively support the interface. Another example might be to return an unsupported persistence interface as a PyIPersist instance. 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. Any error (including E_NOINTERFACE) will generate a com_error exception. - -Returns: - - Any:If provided and not None, will return an - -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 - -be used when you are sure you need it! - -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 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. - -For example, this option can be used to obtain a PyIUnknown object if - -pythoncom does not natively support the interface. - -Another example might be to return an unsupported persistence interface as a - -PyIPersist instance. - -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. - -Any error (including E_NOINTERFACE) will generate a com_error exception. - - - """ - pass - - -class PyIViewObject(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Draw(self,dwDrawAspect:'Any',lindex:'Any',aspectFlags:'Any',hdcTargetDev:'Any',hdcDraw:'Any',arg:'Tuple[Any, Any, Any, Any]',arg1:'Tuple[Any, Any, Any, Any]',funcContinue:'Any',obContinue:'Any') -> 'None': - """ - Description of Draw. - -Args: - - dwDrawAspect(Any):Description for dwDrawAspect - lindex(Any):Description for lindex - aspectFlags(Any):Integer value for the dwFlags item of the DVASPECTINFO structure. - hdcTargetDev(Any):Description for hdcTargetDev - hdcDraw(Any):Description for hdcDraw - arg(Tuple[Any, Any, Any, Any]):Bounds rectangle. - arg1(Tuple[Any, Any, Any, Any]):WBounds rectangle. - funcContinue(Any):A continue function. - obContinue(Any):Value passed to the function. - -Returns: - - None - - """ - pass - - - def GetColorSet(self,dwDrawAspect:'Any',lindex:'Any',aspectFlags:'Any',hicTargetDev:'Any') -> 'None': - """ - Description of GetColorSet. - -Args: - - dwDrawAspect(Any):Description for dwDrawAspect - lindex(Any):Description for lindex - aspectFlags(Any):Integer value for the dwFlags item of the DVASPECTINFO structure. - hicTargetDev(Any):Description for hicTargetDev - -Returns: - - None - - """ - pass - - - def Freeze(self,dwDrawAspect:'Any',lindex:'Any',aspectFlags:'Any') -> 'None': - """ - Description of Freeze. - -Args: - - dwDrawAspect(Any):Description for dwDrawAspect - lindex(Any):Description for lindex - aspectFlags(Any):Integer value for the dwFlags item of the DVASPECTINFO structure. - -Returns: - - None - - """ - pass - - - def Unfreeze(self,dwFreeze:'Any') -> 'None': - """ - Description of Unfreeze. - -Args: - - dwFreeze(Any):Description for dwFreeze - -Returns: - - None - - """ - pass - - - def SetAdvise(self,aspects:'Any',advf:'Any',pAdvSink:'Any') -> 'None': - """ - Description of SetAdvise. - -Args: - - aspects(Any):Description for aspects - advf(Any):Description for advf - pAdvSink(Any):Description for pAdvSink - -Returns: - - None - - """ - pass - - - def GetAdvise(self,) -> 'None': - """ - Description of GetAdvise. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIViewObject2(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetExtent(self,dwDrawAspect:'Any',lindex:'Any',targetDevice:'Any') -> 'None': - """ - Description of GetExtent. - -Args: - - dwDrawAspect(Any):Description for dwDrawAspect - lindex(Any):Description for lindex - targetDevice(Any):Description for lindex - -Returns: - - None - - """ - pass - - -class PyMAPINAMEIDArray(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyOLEMENUGROUPWIDTHS(object): - """Tuple containing 6 ints indicating nbr of options in each menu group""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyPROPERTYKEY(object): - """A tuple of a fmtid and property id (IID, int) that uniquely identifies a property""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyPROPVARIANT(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def vt(self)->'Any': - """The variant type, a combination of VARENUM values including flags. (read only)MethodsGetValueReturns an object representing the variant value ToStringReturns the value as a string ChangeTypeCoerce to a different variant type """ - pass - - - def GetValue(self,) -> 'Any': - """ - Returns an object representing the variant value - -Args: - - - -Returns: - - Any - - """ - pass - - - def ToString(self,) -> 'Any': - """ - Returns the value as a string - -Args: - - - -Returns: - - Any - - """ - pass - - - def ChangeType(self,Type:'Any',Flags:'Any'=0) -> 'Any': - """ - Coerce to a different variant type - -Args: - - Type(Any):New variant type, combination of pythoncom.VT_* values - Flags(Any):Reserved (PROPVAR_CHANGE_FLAGS)Win32 API References - -Returns: - - Any - - """ - pass - - -class PySAndRestriction(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySBinaryArray(object): - """A sequence of strings containing binary data.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySBitMaskRestriction(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySContentRestriction(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySExistRestriction(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySHELL_ITEM_RESOURCE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySNotRestriction(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySOrRestriction(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySPropTagArray(object): - """A sequence of integers""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySPropValue(object): - """A MAPI property value. Property values can either be passed from - -python into MAPI functions, or returned from MAPI functions to Python.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySPropValueArray(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySPropertyRestriction(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySRestriction(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySRow(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySRowSet(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySSortOrderItem(object): - """An item in a SortOrderSet.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySSortOrderSet(object): - """An object describing a SortOrderSet.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySTGMEDIUM(object): - """A STGMEDIUM object represents a COM STGMEDIUM structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def tymed(self)->'Any': - """An integer indicating the type of data in the stgmedium""" - pass - - - @property - def data(self)->'Any': - """The data in the stgmedium. The result depends on the value of the 'tymed' property of the PySTGMEDIUM object.tymedResult TypeTYMED_GDIAn integer GDI handleTYMED_MFPICTAn integer METAFILE handleTYMED_ENHMFAn integer ENHMETAFILE handleTYMED_HGLOBALA string with the bytes of the global memory object.TYMED_FILEA string/unicode filenameTYMED_ISTREAMA PyIStream objectTYMED_ISTORAGEA PyIStorage object""" - pass - - - @property - def data_handle(self)->'Any': - """The raw 'integer' representation of the data. For TYMED_HGLOBAL, this is the handle rather than the string data. For the string and interface types, this is an integer holding the pointer.""" - pass - - - def set(self,tymed:'Any',data:'Any') -> 'None': - """ - Sets the type and data of the object. - -Args: - - tymed(Any):The type of the data - data(Any): - -Returns: - - None - - """ - pass - - -class PyTASK_TRIGGER(object): - """Python object representing a TASK_TRIGGER structure via the structmember Api""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class RTF_WCSINFO(object): - """A tuple representing a RTF_WCSINFO structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SHFILEINFO(object): - """A tuple representing a SHFILEINFO structure - -Represented as a tuple of (hIcon, iIcon, dwAttributes, displayName, typeName)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SHFILEOPSTRUCT(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SI_ACCESS(object): - """Tuple of 4 items representing SI_ACCESS struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SI_INHERIT_TYPE(object): - """Tuple of 3 items describing a method of inheritance""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SI_OBJECT_INFO(object): - """Six-tuple representing SI_OBJECT_INFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class STATSTG(object): - """A tuple representing a STATSTG structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class TLIBATTR(object): - """Type library attributes are represented as a tuple of:""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class TYPEATTR(object): - """A TYPEATTR object represents a COM TYPEATTR structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def iid(self)->'PyIID': - """The IID""" - pass - - - @property - def lcid(self)->'Any': - """The lcid""" - pass - - - @property - def memidConstructor(self)->'Any': - """ID of constructor""" - pass - - - @property - def memidDestructor(self)->'Any': - """ID of destructor""" - pass - - - @property - def cbSizeInstance(self)->'Any': - """The size of an instance of this type""" - pass - - - @property - def typekind(self)->'Any': - """The kind of type this information describes. One of the win32con.TKIND_* constants.""" - pass - - - @property - def cFuncs(self)->'Any': - """Number of functions.""" - pass - - - @property - def cVars(self)->'Any': - """Number of variables/data members.""" - pass - - - @property - def cImplTypes(self)->'Any': - """Number of implemented interfaces.""" - pass - - - @property - def cbSizeVft(self)->'Any': - """The size of this type's VTBL""" - pass - - - @property - def cbAlignment(self)->'Any': - """Byte alignment for an instance of this type.""" - pass - - - @property - def wTypeFlags(self)->'Any': - """One of the pythoncom TYPEFLAG_""" - pass - - - @property - def wMajorVerNum(self)->'Any': - """Major version number.""" - pass - - - @property - def wMinorVerNum(self)->'Any': - """Minor version number.""" - pass - - - @property - def tdescAlias(self)->'Any': - """If TypeKind == pythoncom.TKIND_ALIAS, specifies the type for which this type is an alias.""" - pass - - - @property - def idldeskType(self)->'Any': - """IDL attributes of the described type.""" - pass - - -class TYPEDESC(object): - """A typedesc is a complicated, recursive 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 ...""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class VARDESC(object): - """A VARDESC object represents a COM VARDESC structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def memid(self)->'Any': - """The dispid of the member""" - pass - - - @property - def value(self)->'Union[Any]': - """A value for the variant. If PERINSTANCE then an offset into the instance, otherwise a variant converted to a Python object.""" - pass - - - @property - def elemdescVar(self)->'Any': - """Object describing the member.""" - pass - - - @property - def varFlags(self)->'Any': - """Variable flags""" - pass - - - @property - def varkind(self)->'Any': - """Kind flags.""" - pass - - -class CHARFORMAT(object): - """Describes a CHARFORMAT tuple""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class CREATESTRUCT(object): - """A representation of a Windows CREATESTRUCT structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class LV_COLUMN(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class LV_ITEM(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PARAFORMAT(object): - """Describes a PARAFORMAT tuple""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyAssocCObject(object): - """An internal class.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyAssocObject(object): - """An internal class.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AttachObject(self,) -> 'None': - """ - Attaches a Python object for lookup of "virtual" functions. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetAttachedObject(self,) -> 'Any': - """ - Returned the attached Python object, or None. - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyCBitmap(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateCompatibleBitmap(self,dc:'Any',width:'Any',height:'Any') -> 'None': - """ - Creates a bitmap compatible with the specified device context. - -Args: - - dc(Any):Specifies the device context. - width(Any):The width (in bits) of the bitmap - height(Any):The height (in bits) of the bitmap. - -Returns: - - None - - """ - pass - - - def GetSize(self,) -> 'Tuple[Any, Any]': - """ - Returns the size of the bitmap object. - -Args: - - - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def GetHandle(self,) -> 'Any': - """ - Returns the HBITMAP for a bitmap object - -Args: - - - -Returns: - - Any - - """ - pass - - - def LoadBitmap(self,idRes:'Any',obDLL:'Any'=None) -> 'None': - """ - Loads a bitmap from a DLL object. - -Args: - - idRes(Any):The resource ID of the bitmap - obDLL(Any):The DLL object to load from. - -Returns: - - None - - """ - pass - - - def LoadBitmapFile(self,fileObject:'Any') -> 'None': - """ - Loads a bitmap (.BMP) format - -from a file object. - -Args: - - fileObject(Any):The file object to load the .BMP format file from. - -Returns: - - None - - """ - pass - - - def LoadPPMFile(self,fileObject:'Any',cols:'Any',rows:'Any') -> 'None': - """ - Loads a bitmap in Portable Pix Map (PPM) format - -from a file object. - -Args: - - fileObject(Any):The file object to load the PPM format file from. - cols(Any):The number of columns in the bitmap. - rows(Any):The number of rows in the bitmap. - -Returns: - - None - - """ - pass - - - def Paint(self,dcObject:'Any',arg:'Tuple[Any, Any, Any, Any]',arg1:'Tuple[Any, Any, Any, Any]') -> 'None': - """ - Paint a bitmap. - -Args: - - dcObject(Any):The DC object to paint the bitmap to. - arg(Tuple[Any, Any, Any, Any]):The destination rectangle to paint to. - arg1(Tuple[Any, Any, Any, Any]):The source rectangle to paint from. - -Returns: - - None - - """ - pass - - - def GetInfo(self,) -> 'Any': - """ - Returns the BITMAP structure info - -Args: - - - -Returns: - - Any:PyCBitmap.GetInfo - -dict = GetInfo()Returns the BITMAP structure info -Return ValueA dictionary of integers, keyed by the following strings: - -bmType - -bmWidth - -bmHeight - -bmWidthBytes - -bmPlanes - -bmBitsPixel - - - """ - pass - - - def GetBitmapBits(self,asString:'Any'=0) -> 'Union[Any, str]': - """ - Returns the bitmap bits. - -Args: - - asString(Any):If False, the result is a tuple of integers, if True, the result is a Python string - -Returns: - - Union[Any, str] - - """ - pass - - - def SaveBitmapFile(self,dcObject:'Any',Filename:'str') -> 'Any': - """ - Saves a bitmap to a file. - -Args: - - dcObject(Any):The DC object that has rendered the bitmap. - Filename(str):The file to save the bitmap to - -Returns: - - Any - - """ - pass - - -class PyCBrush(object): - """An object encapsulating an MFC PyCBrush class.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateSolidBrush(self,) -> 'None': - """ - Initializes a brush with a specified solid color. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetSafeHandle(self,) -> 'Any': - """ - Retrieves the HBRUSH for the brush as an integer - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyCButton(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,caption:'str',style:'Any',rect:'Tuple[Any, Any, Any, Any]',parent:'Any',_id:'Any') -> 'None': - """ - Creates the window for a new button object. - -Args: - - caption(str):The caption (text) for the button. - style(Any):The style for the button. Use any of the win32con.BS_* constants. - rect(Tuple[Any, Any, Any, Any]):The size and position of the button. - parent(Any):The parent window of the button. Usually a PyCDialog. - _id(Any):The buttons control ID. - -Returns: - - None - - """ - pass - - - def GetBitmap(self,) -> 'Any': - """ - Get the button's bitmap - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetBitmap(self,hBitmap:'Any'=1) -> 'Any': - """ - Set the button's bitmap - -Args: - - hBitmap(Any):Handle of the new bitmap - -Returns: - - Any - - """ - pass - - - def GetCheck(self,) -> 'Any': - """ - Retrieves the check state of a radio button or check box. - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetCheck(self,idCheck:'Any') -> 'None': - """ - Sets or resets the state of a radio button or check box. - -Args: - - idCheck(Any):The ID of the button. - -Returns: - - None - - """ - pass - - - def GetState(self,) -> 'Any': - """ - Returns the state of the button. - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetState(self,bHighlight:'Any') -> 'Any': - """ - Sets the state of the button. - -Args: - - bHighlight(Any):The new state for the button.CommentsHighlighting affects the exterior of a button control. It has no effect on the check state of a radio button or check box. - -Returns: - - Any - - """ - pass - - - def GetButtonStyle(self,) -> 'Any': - """ - Gets the style of the button. - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetButtonStyle(self,style:'Any',bRedraw:'Any'=1) -> 'Any': - """ - Sets the style of the button. - -Args: - - style(Any):The new style for the button. - bRedraw(Any):Should the button be redrawn? - -Returns: - - Any - - """ - pass - - -class PyCCmdTarget(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def BeginWaitCursor(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def EndWaitCursor(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def HookCommand(self,obHandler:'Any',_id:'Any') -> 'Any': - """ - Hook a windows command handler. - -Args: - - obHandler(Any):The handler for the command message. This must be a callable object. - _id(Any):The ID of the command to be handled, or zero to handle all command messages.CommentsobHandler 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. When updating a user interface element, Pythonwin will first check if a handler has been installed via PyCCmdTarget::HookCommandUpdate. If so, this alone 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 The handler will be called with 2 arguments * The command id being handled. * The command notification code. If the handler returns TRUE, then the command will be passed on to the default handler, otherwise the message will be consumed. This method is best suited to handling messages from user interface elements, such as menus, toolbars, etc. To handle notification messages from a control, you should use PyCCmdTarget::HookNotifyReturn ValueThe return value is the previous handler, or None. - -Returns: - - 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. - -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 - -handler has been installed via PyCCmdTarget::HookCommandUpdate. If so, this alone - -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 - -The handler will be called with 2 arguments - -* The command id being handled. - -* The command notification code. - -If the handler returns TRUE, then the command will be passed on to the - -default handler, otherwise the message will be consumed. - -This method is best suited to handling messages from user interface - -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 - - - def HookCommandUpdate(self,obHandler:'Any',_id:'Any') -> 'Any': - """ - Hook a windows command update handler. - -Args: - - obHandler(Any):The handler for the command message. This must be a callable object. - _id(Any):The ID of the command to be handled.CommentsThe handler object passed will be called as the application updates user interface elements with the specified ID. 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. - -Returns: - - Any:The ID of the command to be handled.Comments - -The handler object passed will be called as - -the application updates user interface elements - -with the specified ID. - -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 - - - def HookOleEvent(self,) -> 'Any': - """ - Hook an OLE Event. - -Args: - - - -Returns: - - Any:PyCCmdTarget.HookOleEvent - -object = HookOleEvent()Hook an OLE Event. -Return ValueThe return value is the previous handler, or None. - - - """ - pass - - - def HookNotify(self,obHandler:'Any',_id:'Any') -> 'Any': - """ - Hook a windows command handler. - -Args: - - obHandler(Any):The handler for the command message. This must be a callable object. - _id(Any):The ID of the command to be handled, or zero to handle all command messages.CommentsobHandler will be called as the application receives control notification messages. 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 A tuple describing standard notification information. 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, otherwise the message will be consumed.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 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 can install certain knowledge about handlers, but this has not been implemented.)Return ValueThe return value is the previous handler, or None. - -Returns: - - 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. - -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 - -A tuple describing standard notification information. - -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, - -otherwise the message will be consumed. - -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 - -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 - -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 - -changed. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCCmdUI(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def m_nIndex(self)->'Any': - """""" - pass - - - @property - def m_nID(self)->'Any': - """""" - pass - - - @property - def m_pMenu(self)->'Any': - """""" - pass - - - @property - def m_pSubMenu(self)->'Any': - """""" - pass - - - def Enable(self,bEnable:'Any'=1) -> 'None': - """ - Enables or disables the user-interface item for this command. - -Args: - - bEnable(Any):TRUE if the item should be enabled, false otherwise. - -Returns: - - None - - """ - pass - - - def SetCheck(self,state:'Any'=1) -> 'None': - """ - Sets the check state of the user-interface item for this command. - -Args: - - state(Any):0 for unchecked, 1 for checked, or 2 for indeterminate. - -Returns: - - None - - """ - pass - - - def SetRadio(self,bOn:'Any'=1) -> 'None': - """ - Like the SetCheck member function, but operates on radio groups. - -Args: - - bOn(Any):TRUE if the item should be enabled, false otherwise. - -Returns: - - None - - """ - pass - - - def SetText(self,text:'str') -> 'None': - """ - Sets the text for the user-interface item for this command. - -Args: - - text(str):The text for the interface element. - -Returns: - - None - - """ - pass - - - def ContinueRouting(self,) -> 'None': - """ - Tells the command-routing mechanism to continue routing the current message down - -the chain of handlers. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCColorDialog(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetColor(self,) -> 'Any': - """ - Determines the selected color. - -Args: - - - -Returns: - - Any - - """ - pass - - - def DoModal(self,) -> 'Any': - """ - Displays a dialog and allows the user to make a selection. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetSavedCustomColors(self,) -> 'Any': - """ - Returns the saved custom colors. - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetCurrentColor(self,color:'Any') -> 'None': - """ - Sets the currently selected color. - -Args: - - color(Any):The color to set.MFC References - -Returns: - - None - - """ - pass - - - def SetCustomColors(self,) -> 'None': - """ - Sets one or more custom colors - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCustomColors(self,) -> 'Tuple[Any, ...]': - """ - Gets the 16 currently defined custom colors - -Args: - - - -Returns: - - Tuple[Any, ...] - - """ - pass - - -class PyCComboBox(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddString(self,_object:'Any') -> 'Any': - """ - Adds a string to a combobox. - -Args: - - _object(Any):Any object. If not a string, __str__, __repr__ or a default repr() will be usedMFC References - -Returns: - - Any:CComboBox::AddString -Return ValueThe zero based index of the new string. - - - """ - pass - - - def DeleteString(self,pos:'Any') -> 'Any': - """ - Deletes an item from a combobox. - -Args: - - pos(Any):The zero based index of the item to delete.MFC References - -Returns: - - Any:CComboBox::DeleteString -Return ValueThe count of the items remaining in the list. - - - """ - pass - - - def Dir(self,attr:'Any',wild:'str') -> 'Any': - """ - Fills the list portion of a combobox with a directory listing. - -Args: - - attr(Any):The attributes of the files to locate - wild(str):A file specification string - eg, *.*MFC References - -Returns: - - Any:CComboBox::Dir -Return ValueThe index of the last file name added to the list. - - - """ - pass - - - def GetCount(self,) -> 'Any': - """ - Returns the count of items in the combobox. - -Args: - - - -Returns: - - Any:CListBox::GetCount -Return ValueReturns the number of items currently in the combobox. - - - """ - pass - - - def GetCurSel(self,) -> 'Any': - """ - Returns the index of the currently selected item. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetEditSel(self,) -> 'Any': - """ - Returns the selection of the edit control portion of a combo box. - -Args: - - - -Returns: - - Any:CComboBox::GetEditSel -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 selection in the high-order word. If this function is used on a combo box - -without an edit control, an exception is raised. - - - """ - pass - - - def GetExtendedUI(self,) -> 'Any': - """ - Indicates if the combo has the extended interface. - -Args: - - - -Returns: - - Any:CComboBox::GetExtendedUI -Return ValueNonzero if the combo box has the extended user interface; otherwise 0. - - - """ - pass - - - def GetItemData(self,item:'Any') -> 'Any': - """ - Retrieves the application-specific object associated with an item. - -Args: - - item(Any):The index of the item whose data is to be retrieved. - -Returns: - - Any - - """ - pass - - - def GetItemValue(self,item:'Any') -> 'Any': - """ - Retrieves the application-specific value associated with an item. - -Args: - - item(Any):The index of the item whose data is to be retrieved. - -Returns: - - Any - - """ - pass - - - def GetLBText(self,index:'Any') -> 'str': - """ - Gets the string from the list of a combo box. - -Args: - - index(Any):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. - -Returns: - - 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 - - - def GetLBTextLen(self,index:'Any') -> 'Any': - """ - Returns the length of a string in the list of a combobox. - -Args: - - index(Any):The index of the item to return the length of.MFC References - -Returns: - - Any - - """ - pass - - - def InsertString(self,pos:'Any',_object:'Any') -> 'Any': - """ - Insert a string into a combobox. - -Args: - - pos(Any):The zero based index in the combobox to insert the new string - _object(Any):The object to be added to the comboboxMFC References - -Returns: - - Any:CComboBox::InsertString -Return ValueThe zero based index of the new string added. - - - """ - pass - - - def LimitText(self,_max:'Any') -> 'Any': - """ - Limits the amount of text the edit portion of a combo box can hold. - -Args: - - _max(Any):The maximum number of characters the user can enter. If zero, the size is set to (virtually) unlimited.MFC References - -Returns: - - Any - - """ - pass - - - def ResetContent(self,) -> 'None': - """ - Clear all the items from a combobox. - -Args: - - - -Returns: - - None - - """ - pass - - - def SelectString(self,after:'Any',string:'str') -> 'None': - """ - Searches for a combobox item that matches the specified string, and selects it. - -Args: - - after(Any):Contains the zero-based index of the item before the first item to be searched, or -1 for the entire combobox. - string(str):The string to search for.MFC References - -Returns: - - None:CComboBoxBox::SelectString -Return ValueThe return value is always None - an exception is raised if the string can not be located. - - - """ - pass - - - def SetCurSel(self,index:'Any') -> 'None': - """ - Selects an item in a combobox. - -Args: - - index(Any):The zero based index of the item to select.MFC References - -Returns: - - None - - """ - pass - - - def SetEditSel(self,start:'Any',end:'Any') -> 'None': - """ - Sets the selection in the edit control portion of a combo box. - -Args: - - start(Any):Specifies the starting position. If the starting position is set to -1, then any existing selection is removed. - end(Any):Specifies the ending position. If the ending position is set to -1, then all text from the starting position to the last character in the edit control is selected.MFC References - -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 - -have an edit control. - - - """ - pass - - - def SetExtendedUI(self,bExtended:'Any'=1) -> 'None': - """ - Selects the Extended UI mode for a combo box. - -Args: - - bExtended(Any):Indicates if the combo should have the extended user interface.CommentsA combo box with the Extended UI flag set can be identified in the following ways:~ Clicking the static control displays the list box only for combo boxes with the CBS_DROPDOWNLIST style.~ Pressing the DOWN ARROW key displays the list box (F4 is disabled).~ Scrolling in the static control is disabled when the item list is not visible (the arrow keys are disabled).MFC References - -Returns: - - None - - """ - pass - - - def SetItemData(self,item:'Any',Data:'Any') -> 'Any': - """ - Sets the item's application-specific object value. - -Args: - - item(Any):Index of the item whose Data is to be set. - Data(Any):New value for the data.CommentsNote that a reference count is not added to the object. This it is your responsibility to make sure the object remains alive while in the list. - -Returns: - - Any - - """ - pass - - - def SetItemValue(self,item:'Any',data:'Any') -> 'Any': - """ - Sets the item's application-specific value. - -Args: - - item(Any):Index of the item whose Data is to be set. - data(Any):New value for the data. - -Returns: - - Any - - """ - pass - - - def ShowDropDown(self,bShowIt:'Any'=1) -> 'None': - """ - Shows or hides the listbox portion of a combo box. - -Args: - - bShowIt(Any):Indicates if the listbox should be shown or hidden. - -Returns: - - None - - """ - pass - - -class PyCCommonDialog(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCControl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCControlBar(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dockSite(self)->'Any': - """Current dock site, if dockable""" - pass - - - @property - def dockBar(self)->'Any': - """Current dock bar, if dockable""" - pass - - - @property - def dockContext(self)->'Any': - """Used during dragging""" - pass - - - @property - def dwStyle(self)->'Any': - """creation style (used for layout)""" - pass - - - @property - def dwDockStyle(self)->'Any': - """indicates how bar can be docked""" - pass - - - def CalcDynamicLayout(self,length:'Any',dwMode:'Any') -> 'Any': - """ - The framework calls this member function to calculate the dimensions of - -a dynamic toolbar. - -Args: - - length(Any):The requested dimension of the control bar, either horizontal or vertical, depending on dwMode. - dwMode(Any):A combination of flags. - -Returns: - - Any - - """ - pass - - - def CalcFixedLayout(self,bStretch:'Any',bHorz:'Any') -> 'Any': - """ - Calculates the horizontal size of a control bar - -Args: - - bStretch(Any):Indicates whether the bar should be stretched to the size of the frame. The bStretch parameter is nonzero when the bar is not a docking bar (not available for docking) and is 0 when it is docked or floating (available for docking). - bHorz(Any):Indicates that the bar is horizontally or vertically oriented. - -Returns: - - Any - - """ - pass - - - def EnableDocking(self,style:'Any') -> 'None': - """ - pecifies whether the control bar supports docking and the sides of its parent - -window. - -Args: - - style(Any):Enables a control bar to be docked. - -Returns: - - None - - """ - pass - - - def EraseNonClient(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def GetBarStyle(self,) -> 'Any': - """ - Retrieves the control bar style settings. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetCount(self,) -> 'Any': - """ - Returns the number of non-HWND elements in the control bar. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetDockingFrame(self,) -> 'Any': - """ - Returns the frame window to which a control bar is docked. - -Args: - - - -Returns: - - Any - - """ - pass - - - def IsFloating(self,) -> 'Any': - """ - Returns a nonzero value if the control bar in question is a floating control - -bar. - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetBarStyle(self,style:'Any') -> 'None': - """ - Modifies the control bar style settings. - -Args: - - style(Any):The new style - -Returns: - - None - - """ - pass - - - def ShowWindow(self,) -> 'Any': - """ - Shows the toolbar, and recalculates the button layout. - -Args: - - - -Returns: - - Any:PyCControlBar.ShowWindow - -int = ShowWindow()Shows the toolbar, and recalculates the button layout. -Comments - -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 - - -class PyCCtrlView(object): - """A class which implementes a CCtrlView (ie, a view based on a dialog resource.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OnCommand(self,wparam:'Any',lparam:'Any') -> 'None': - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(Any): - lparam(Any):See Also - -Returns: - - None - - """ - pass - - -class PyCDC(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AbortDoc(self,) -> 'None': - """ - Aborts a print job - -Args: - - - -Returns: - - None - - """ - pass - - - def Arc(self,rect:'Tuple[Any, Any, Any, Any]',pointStart:'Tuple[Any, Any]',pointEnd:'Tuple[Any, Any]') -> 'None': - """ - Draws an eliptical arc. - -Args: - - rect(Tuple[Any, Any, Any, Any]):Specifies the ellipse's bounding rectangle - pointStart(Tuple[Any, Any]):Specifies the x- and y-coordinates of the point that defines the arc's starting point (in logical units). This point does not have to lie exactly on the arc. - pointEnd(Tuple[Any, Any]):Specifies the x- and y-coordinates of the point that defines the arc's ending point (in logical units). This point does not have to lie exactly on the arc.CommentsThe arc drawn by using the function is a segment of the ellipse defined by the specified bounding rectangle. The actual starting point of the arc is the point at which a ray drawn from the center of the bounding rectangle through the specified starting point intersects the ellipse. The actual ending point of the arc is the point at which a ray drawn from the center of the bounding rectangle through the specified ending point intersects the ellipse. The arc is drawn in a counterclockwise direction. Since an arc is not a closed figure, it is not filled. Both the width and height of the rectangle must be greater than 2 units and less than 32,767 units.MFC References - -Returns: - - None:CDC::Arc -Return ValueAlways none. If the function fails, an exception is raised. - - - """ - pass - - - def BeginPath(self,) -> 'None': - """ - Opens a path bracket in the device context - -Args: - - - -Returns: - - None - - """ - pass - - - def BitBlt(self,destPos:'Tuple[Any, Any]',size:'Tuple[Any, Any]',dc:'Any',srcPos:'Tuple[Any, Any]',rop:'Any') -> 'None': - """ - Copies a bitmap from the source device context to this device context. - -Args: - - destPos(Tuple[Any, Any]):The logical x,y coordinates of the upper-left corner of the destination rectangle. - size(Tuple[Any, Any]):Specifies the width and height (in logical units) of the destination rectangle and source bitmap. - dc(Any):Specifies the PyCDC object from which the bitmap will be copied. It must be None if rop specifies a raster operation that does not include a source. - srcPos(Tuple[Any, Any]):Specifies the logical x,y coordinates of the upper-left corner of the source bitmap. - rop(Any):Specifies the raster operation to be performed. See the win32 api documentation for details.MFC References - -Returns: - - None - - """ - pass - - - def Chord(self,rect:'Tuple[Any, Any, Any, Any]',pointStart:'Tuple[Any, Any]',pointEnd:'Tuple[Any, Any]') -> 'None': - """ - Draws a chord. - -Args: - - rect(Tuple[Any, Any, Any, Any]):Specifies the ellipse's bounding rectangle - pointStart(Tuple[Any, Any]):Specifies the x- and y-coordinates of the point that defines the arc's starting point (in logical units). This point does not have to lie exactly on the arc. - pointEnd(Tuple[Any, Any]):Specifies the x- and y-coordinates of the point that defines the arc's ending point (in logical units). This point does not have to lie exactly on the arc.CommentsDraws a chord (a closed figure bounded by the intersection of an ellipse and a line segment). The rect parameter specify the upper-left and lower-right corners, respectively, of a rectangle bounding the ellipse that is part of the chord. The pointStart and pointEnd parameters specify the endpoints of a line that intersects the ellipse. The chord is drawn by using the selected pen and filled by using the selected brush.MFC References - -Returns: - - None:CDC::Chord -Return ValueAlways none. If the function fails, an exception is raised. - - - """ - pass - - - def CreateCompatibleDC(self,dcFrom:'Any'=None) -> PyCDC: - """ - Creates a memory device context that is compatible with this DC. - -Args: - - dcFrom(Any):The source DC, or None to make a screen compatible DC.CommentsNote that unlike the MFC version, this function calls the global CreateCompatibleDC function and returns a new PyCDC object.MFC References - -Returns: - - None - - """ - pass - - - def CreatePrinterDC(self,printerName:'str'=None) -> 'None': - """ - Creates a device context for a specific printer - -Args: - - printerName(str):The printer name, or None for the default printerMFC References - -Returns: - - None - - """ - pass - - - def DeleteDC(self,) -> 'None': - """ - Deletes all resources associated with a device context. - -Args: - - - -Returns: - - None - - """ - pass - - - def DPtoLP(self,point:'Tuple[Any, Any]',x:'Any',y:'Any') -> 'Tuple[Any, Any]': - """ - Converts device units into logical units. - -Args: - - point(Tuple[Any, Any]):The point to convertAlternative Parameters - x(Any):The x coordinate to convert. - y(Any):The y coordinate to convert.MFC References - -Returns: - - Tuple[Any, Any]:CDC::DPtoLP - To Do Should really handle list of (x,y) points -Return ValueThe converted coordinates. - - - """ - pass - - - def Draw3dRect(self,rect:'Tuple[Any, Any, Any, Any]',colorTopLeft:'Any',colorBotRight:'Any') -> 'None': - """ - Draws a three-dimensional rectangle. - -Args: - - rect(Tuple[Any, Any, Any, Any]):Specifies the bounding rectangle, in logical units. - colorTopLeft(Any):Specifies the color of the top and left sides of the three-dimensional rectangle. - colorBotRight(Any):Specifies the color of the bottom and right sides of the three-dimensional rectangle.MFC References - -Returns: - - None - - """ - pass - - - def DrawFocusRect(self,rect:'Tuple[Any, Any, Any, Any]') -> 'None': - """ - Draws a rectangle in the style used to - -indicate the rectangle has focus - -Args: - - rect(Tuple[Any, Any, Any, Any]):The coordinates of the rectangleMFC References - -Returns: - - None - - """ - pass - - - def DrawFrameControl(self,rect:'Tuple[Any, Any, Any, Any]',typ:'Any',state:'Any') -> 'None': - """ - Draws a frame control of the specified type and style. - -Args: - - rect(Tuple[Any, Any, Any, Any]):Specifies the bounding rectangle, in logical units. - typ(Any): - state(Any):MFC References - -Returns: - - None - - """ - pass - - - def DrawIcon(self,point:'Tuple[Any, Any]',hIcon:'int') -> 'None': - """ - Draws an icon on the DC. - -Args: - - point(Tuple[Any, Any]):The point coordinate to draw to. - hIcon(int):The handle of the icon to draw.MFC References - -Returns: - - None - - """ - pass - - - def DrawText(self,s:'str',_tuple:'Tuple[Any, Any, Any, Any]',_format:'Any') -> 'Tuple[Any, Any, Any]': - """ - Formats text in the given rectangle - -Args: - - s(str):The desired output string - _tuple(Tuple[Any, Any, Any, Any]):The bounding rectangle in the form: (left, top, right, bottom) expressed in logical units (depending on selected coordinate system - see PyCDC::SetMapMode) - _format(Any):Specifies one or more bit-or'd format values, such as DT_BOTTOM, DT_CENTERDT_RIGHT, DT_VCENTER. For a complete list, see the Microsoft Win32 API documentation.ExampleExampleimport win32ui<nl> import win32con<nl> INCH = 1440 # twips - 1440 per inch allows fine res<nl> def drawtext_test():<nl> dc = win32ui.CreateDC()<nl> dc.CreatePrinterDC() # ties to default printer<nl> dc.StartDoc('My Python Document')<nl> dc.StartPage()<nl> <nl> # note: upper left is 0,0 with x increasing to the right,<nl> # and y decreasing (negative) moving down<nl> dc.SetMapMode(win32con.MM_TWIPS)<nl> <nl> # Centers "TEST" about an inch down on page<nl> dc.DrawText('TEST', (0,INCH*-1,INCH*8,INCH*-2), win32con.DT_CENTER )<nl> dc.EndPage()<nl> dc.EndDoc()<nl> del dc<nl>Return ValueHeight of text in pixelsThe return value is the height of the text, in logical units. If DT_VCENTER or DT_BOTTOM is specified, the return value is the 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) - -Returns: - - Tuple[Any, Any, Any]:Specifies one or more bit-or'd format values, such as - -DT_BOTTOM, DT_CENTERDT_RIGHT, DT_VCENTER. For a complete list, see - -the Microsoft Win32 API documentation.ExampleExample -import win32ui<nl> - - import win32con<nl> - - INCH = 1440 # twips - 1440 per inch allows fine res<nl> - - def drawtext_test():<nl> - - dc = win32ui.CreateDC()<nl> - - dc.CreatePrinterDC() # ties to default printer<nl> - - dc.StartDoc('My Python Document')<nl> - - dc.StartPage()<nl> - - <nl> - - # note: upper left is 0,0 with x increasing to the right,<nl> - - # and y decreasing (negative) moving down<nl> - - dc.SetMapMode(win32con.MM_TWIPS)<nl> - - <nl> - - # Centers "TEST" about an inch down on page<nl> - - dc.DrawText('TEST', (0,INCH*-1,INCH*8,INCH*-2), win32con.DT_CENTER )<nl> - - dc.EndPage()<nl> - - dc.EndDoc()<nl> - - del dc<nl> - - -Return ValueHeight of text in pixels - - - -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 - -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 - - - def Ellipse(self,rect:'Tuple[Any, Any, Any, Any]') -> 'None': - """ - Draws an Ellipse. - -Args: - - rect(Tuple[Any, Any, Any, Any]):Specifies the ellipse's bounding rectangleCommentsThe center of the ellipse is the center of the bounding rectangle specified by rect. The ellipse is drawn with the current pen, and its interior is filled with the current brush.MFC References - -Returns: - - None:CDC::Ellipse -Return ValueAlways none. If the function fails, an exception is raised. - - - """ - pass - - - def EndDoc(self,) -> 'None': - """ - Finishes spooling the document and starts printing it - -Args: - - - -Returns: - - None - - """ - pass - - - def EndPage(self,) -> 'None': - """ - Finishes a page on a printer DC - -Args: - - - -Returns: - - None - - """ - pass - - - def EndPath(self,) -> 'None': - """ - Closes a path bracket and selects the path defined by the bracket into the specified device - -context - -Args: - - - -Returns: - - None - - """ - pass - - - def ExtTextOut(self,_int:'Any',_int1:'Any',_int2:'Any',rect:'Tuple[Any, Any, Any, Any]',string:'Any',_tuple:'Tuple[Tuple[Any, Any], ...]') -> 'None': - """ - Writes text to the DC. - -Args: - - _int(Any):The x coordinate to write the text to. - _int1(Any):The y coordinate to write the text to. - _int2(Any):Specifies the rectangle type. This parameter can be one, both, or neither of ETO_CLIPPED and ETO_OPAQUE - rect(Tuple[Any, Any, Any, Any]):Specifies the text's bounding rectangle. (Can be None.) - string(Any):The text to write. - _tuple(Tuple[Tuple[Any, Any], ...]):Optional array of values that indicate distance between origins of character cells.MFC References - -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 - -current brush and polygon-filling mode. After its interior is filled, the path is discarded from the device context. - -Args: - - - -Returns: - - None - - """ - pass - - - def FillRect(self,rect:'Tuple[Any, Any, Any, Any]',brush:'Any') -> 'None': - """ - Fills a given rectangle with the specified brush - -Args: - - rect(Tuple[Any, Any, Any, Any]):Specifies the bounding rectangle, in logical units. - brush(Any):Specifies the brush to use.MFC References - -Returns: - - None - - """ - pass - - - def FillSolidRect(self,rect:'Tuple[Any, Any, Any, Any]',color:'Any') -> 'None': - """ - Fills the given rectangle with the specified solid color. - -Args: - - rect(Tuple[Any, Any, Any, Any]):Specifies the bounding rectangle, in logical units. - color(Any):Specifies the color to use.MFC References - -Returns: - - None - - """ - pass - - - def FrameRect(self,rect:'Tuple[Any, Any, Any, Any]',brush:'Any') -> 'None': - """ - Draws a border around the rectangle specified by rect - -Args: - - rect(Tuple[Any, Any, Any, Any]):Specifies the bounding rectangle, in logical units. - brush(Any):Specifies the brush to use.MFC References - -Returns: - - None - - """ - pass - - - def GetBrushOrg(self,) -> 'Tuple[Any, Any]': - """ - Retrieves the origin (in device units) of the brush currently selected for the - -device context. - -Args: - - - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def GetClipBox(self,) -> 'Tuple[Any, Any, Any, Any]': - """ - Retrieves the dimensions of the smallest bounding rectangle - -around the current clipping boundary. - -Args: - - - -Returns: - - Tuple[Any, Any, Any, Any]:CDC::GetClipBox -Return ValueA tuple of integers specifying the rectangle. - - - """ - pass - - - def GetCurrentPosition(self,) -> 'Tuple[Any, Any]': - """ - Retrieves the current position (in logical coordinates). - -Args: - - - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def GetDeviceCaps(self,index:'Any') -> 'Any': - """ - Retrieves a capability of the device context. - -Args: - - index(Any):The information requested. See the win32api documentation for details.MFC References - -Returns: - - Any:CDC::GetDeviceCaps -Return ValueThe value of the requested capability - - - """ - pass - - - def GetHandleAttrib(self,) -> 'Any': - """ - Retrieves the handle of the attribute device context. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetHandleOutput(self,) -> 'Any': - """ - Retrieves the handle of the output device context. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetMapMode(self,) -> 'Any': - """ - Gets the mapping mode for the device context. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetNearestColor(self,color:'Any') -> 'Any': - """ - Returns the closest color a device can map. - -Args: - - color(Any):Specifies the color to be matched. - -Returns: - - Any - - """ - pass - - - def GetPixel(self,x:'Any',y:'Any') -> 'None': - """ - Gets a pixel at a local in a device context - -Args: - - x(Any):Horizontal coordinate. - y(Any):Vertical coordinate. - -Returns: - - None - - """ - pass - - - def GetSafeHdc(self,) -> 'Any': - """ - Returns the HDC of this DC object. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetTextExtent(self,text:'str') -> 'Tuple[Any, Any]': - """ - Calculates the width and height of a line of text using the current font to - -determine the dimensions. - -Args: - - text(str):The text to calculate for.MFC References - -Returns: - - Tuple[Any, Any]:CFC::GetTextExtent -Return ValueA tuple of integers with the size of the string, in logical units. - - - """ - pass - - - def GetTextExtentPoint(self,text:'str') -> 'Tuple[Any, Any]': - """ - None - -Args: - - text(str):The text to calculate for.Return ValueA tuple of integers with the size of the string, in logical units. - -Returns: - - Tuple[Any, Any]:The text to calculate for.Return ValueA tuple of integers with the size of the string, in logical units. - - - """ - pass - - - def GetTextFace(self,) -> 'str': - """ - Returns typeface name of the current font. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetTextMetrics(self,) -> 'Any': - """ - Retrieves the metrics for the current font in this device context. - -Args: - - - -Returns: - - Any:CDC::GetTextMetrics -Return ValueA dictionary of integers, keyed by the following strings: - -tmHeight - -tmAscent - -tmDescent - -tmInternalLeading - -tmExternalLeading - -tmAveCharWidth - -tmMaxCharWidth - -tmWeight - -tmItalic - -tmUnderlined - -tmStruckOut - -tmFirstChar - -tmLastChar - -tmDefaultChar - -tmBreakChar - -tmPitchAndFamily - -tmCharSet - -tmOverhang - -tmDigitizedAspectX - -tmDigitizedAspectY - - - """ - pass - - - def GetViewportExt(self,) -> 'Tuple[Any, Any]': - """ - Gets the viewport extent of the device context - -Args: - - - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def GetViewportOrg(self,) -> 'Tuple[Any, Any]': - """ - Gets the viewport origin of the device context - -Args: - - - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def GetWindowExt(self,) -> 'Tuple[Any, Any]': - """ - Gets the window extent of the device context - -Args: - - - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def GetWindowOrg(self,) -> 'Tuple[Any, Any]': - """ - Retrieves the x- and y-coordinates of the origin of the window associated with the - -device context. - -Args: - - - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def IntersectClipRect(self,rect:'Tuple[Any, Any, Any, Any]') -> 'None': - """ - Creates a new clipping region by forming the intersection of the current region - -and the rectangle specified - -Args: - - rect(Tuple[Any, Any, Any, Any]):Specifies the bounding rectangle, in logical units.MFC References - -Returns: - - None:CDC::IntersectClipRect -Return Valueregion type as integer - - - """ - pass - - - def IsPrinting(self,) -> 'Any': - """ - Returns 1 if the DC is currently printing, else 0 - -Args: - - - -Returns: - - Any - - """ - pass - - - def LineTo(self,point:'Tuple[Any, Any]',x:'Any',y:'Any') -> 'None': - """ - Draws a line to a specified point, using the currently selected pen. - -Args: - - point(Tuple[Any, Any]):The point coordinate to draw to.Alternative Parameters - x(Any):The x coordinate to draw to. - y(Any):The y coordinate to draw to.MFC References - -Returns: - - None - - """ - pass - - - def LPtoDP(self,point:'Tuple[Any, Any]',x:'Any',y:'Any') -> 'Tuple[Any, Any]': - """ - Converts logical units into device units. - -Args: - - point(Tuple[Any, Any]):The point coordinate to convert.Alternative Parameters - x(Any):The x coordinate to convert. - y(Any):The y coordinate to convert.MFC References - -Returns: - - Tuple[Any, Any]:CDC::LPtoDP -Return ValueThe converted coordinates. - - - """ - pass - - - def MoveTo(self,point:'Tuple[Any, Any]',x:'Any',y:'Any') -> 'Tuple[Any, Any]': - """ - Moves the current position to a specified point. - -Args: - - point(Tuple[Any, Any]):The point coordinate to move to.Alternative Parameters - x(Any):The x coordinate to move to. - y(Any):The y coordinate to move to.MFC References - -Returns: - - Tuple[Any, Any]:CDC::MoveTo -Return ValueThe previous position. - - - """ - pass - - - def OffsetWindowOrg(self,arg:'Tuple[Any, Any]') -> 'Tuple[Any, Any]': - """ - Modifies the coordinates of the window origin relative to the coordinates of the - -current window origin. - -Args: - - arg(Tuple[Any, Any]):The new origin offset.Return ValueThe previous origin as a tuple (x,y) - -Returns: - - Tuple[Any, Any]:The new origin offset.Return ValueThe previous origin as a tuple (x,y) - - - """ - pass - - - def OffsetViewportOrg(self,arg:'Tuple[Any, Any]') -> 'Tuple[Any, Any]': - """ - Modifies the coordinates of the viewport origin relative to the coordinates of - -the current viewport origin - -Args: - - arg(Tuple[Any, Any]):The new origin offset.Return ValueThe previous viewport origin as a tuple (x,y) - -Returns: - - Tuple[Any, Any]:The new origin offset.Return ValueThe previous viewport origin as a tuple (x,y) - - - """ - pass - - - def PatBlt(self,destPos:'Tuple[Any, Any]',size:'Tuple[Any, Any]',rop:'Any') -> 'None': - """ - Creates a bit pattern on the device. - -Args: - - destPos(Tuple[Any, Any]):The logical x,y coordinates of the upper-left corner of the destination rectangle. - size(Tuple[Any, Any]):Specifies the width and height (in logical units) of the destination rectangle and source bitmap. - rop(Any):Specifies the raster operation to be performed. See the win32 api documentation for details.MFC References - -Returns: - - None - - """ - pass - - - def Pie(self,x1:'Any',y1:'Any',x2:'Any',y2:'Any',x3:'Any',y3:'Any',x4:'Any',y4:'Any') -> 'None': - """ - Draws a pie slice in a device context - -Args: - - x1(Any):X coordinate of upper left corner - y1(Any):Y coordinate of upper left corner - x2(Any):X coordinate of lower right corner - y2(Any):Y coordinate of lower right corner - x3(Any):X coordinate of starting point of arc - y3(Any):Y coordinate of starting point of arc - x4(Any):X coordinate of ending point of arc - y4(Any):Y coordinate of ending point of arc - -Returns: - - None - - """ - pass - - - def PolyBezier(self,) -> 'None': - """ - Draws one or more Bezier splines. - -Args: - - - -Returns: - - None - - """ - pass - - - def Polygon(self,) -> 'None': - """ - Draws an Polygon. - -Args: - - - -Returns: - - None - - """ - pass - - - def Polyline(self,points:'List[Any]') -> 'None': - """ - Draws a Polyline. - -Args: - - points(List[Any]):A sequence of points - -Returns: - - None - - """ - pass - - - def RealizePalette(self,) -> 'Any': - """ - Maps palette entries in the current logical palette to the system palette. - -Args: - - - -Returns: - - 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 - -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 - -was last realized. - - - """ - pass - - - def Rectangle(self,) -> 'Any': - """ - Draws a rectangle using the current pen. The interior of the rectangle is filled using - -the current brush. - -Args: - - - -Returns: - - Any - - """ - pass - - - def RectVisible(self,rect:'Tuple[Any, Any, Any, Any]') -> 'Any': - """ - Determines whether any part of the given rectangle lies within the clipping region of - -the display context. - -Args: - - rect(Tuple[Any, Any, Any, Any]):The coordinates of the reactangle to be checked.MFC References - -Returns: - - Any:CDC::RectVisible -Return ValueNon zero if any part of the rectangle lies within the clipping region, else zero. - - - """ - pass - - - def RestoreDC(self,saved:'Any') -> 'None': - """ - Restores the state of the device context. - -Args: - - saved(Any):The id of a previously saved device context. See PyCDC::SaveDCMFC References - -Returns: - - None - - """ - pass - - - def SaveDC(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any:CDC::SaveDC -Return ValueAn integer identifying the context, which can be used by PyCDC::RestoreDC. - -An exception is raised if this function fails. - - - """ - pass - - - def ScaleWindowExt(self,) -> 'Tuple[Any, Any]': - """ - Modifies the window extents relative to the current values. - -Args: - - - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def ScaleViewportExt(self,) -> 'Tuple[Any, Any]': - """ - Modifies the viewport extents relative to the current values. - -Args: - - - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def SelectClipRgn(self,) -> 'Any': - """ - Selects the given region as the current clipping region for the device context - -Args: - - - -Returns: - - Any:PyCDC.SelectClipRgn - -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 - - - def SelectObject(self,ob:'Any') -> 'Any': - """ - None - -Args: - - ob(Any):The object to select.MFC References - -Returns: - - Any:CDC::SelectObject -Return ValueThe previously selected object. This will be the same type as the object parameter. - - - """ - pass - - - def SetBkColor(self,color:'Any') -> 'Any': - """ - Sets the current background color to the specified color. - -Args: - - color(Any):A windows color specification. See the win32api documentation for details.CommentsIf the background mode is OPAQUE, the system uses the background color to fill the gaps in styled lines, the gaps between hatched lines in brushes, and the background in character cells. The system also uses the background color when converting bitmaps between color and monochrome device contexts.MFC References - -Returns: - - Any:CDC::SetBkColor -Return ValueThe return value is the previous background color. - - - """ - pass - - - def SetBkMode(self,mode:'Any') -> 'Any': - """ - Sets the current background mode to the specified mode. - -Args: - - mode(Any):A background mode. May be either TRANSPARENT or OPAQUE.CommentsSpecifies the mode to be set. This parameter can be either OPAQUE or TRANSPARENTMFC References - -Returns: - - Any:CDC::SetBkMode -Return ValueThe return value is the previous background mode. - - - """ - pass - - - def SetBrushOrg(self,point:'Tuple[Any, Any]') -> 'Tuple[Any, Any]': - """ - Specifies the origin that GDI will assign to the next brush that the - -application selects into the device context. - -Args: - - point(Tuple[Any, Any]):The new origin in device units.MFC References - -Returns: - - Tuple[Any, Any]:CDC::SetBrushOrg -Return ValueThe previous origin in device units. - - - """ - pass - - - def SetGraphicsMode(self,mode:'Any') -> 'Any': - """ - Sets the graphics mode for the specified device context - -Args: - - mode(Any):The new mode. - -Returns: - - Any - - """ - pass - - - def SetMapMode(self,newMode:'Any') -> 'Any': - """ - Sets the mapping mode for the device context. - -Args: - - newMode(Any):The new mode. Can be one of MM_ANISOTROPIC, MM_HIENGLISH, MM_HIMETRIC, MM_ISOTROPIC, MM_LOENGLISH, MM_LOMETRIC, MM_TEXT, MM_TWIPSMFC References - -Returns: - - Any:CDC::SetMapMode -Return ValueThe previous mapping mode. - - - """ - pass - - - def SetPixel(self,x:'Any',y:'Any',color:'Any') -> 'None': - """ - Sets a pixel in a device context - -Args: - - x(Any):Horizontal coordinate. - y(Any):Vertical coordinate. - color(Any):The brush color. - -Returns: - - None - - """ - pass - - - def SetPolyFillMode(self,point:'Tuple[Any, Any]') -> 'Any': - """ - Sets the polygon-filling mode. - -Args: - - point(Tuple[Any, Any]):The new origin in device units.MFC References - -Returns: - - Any:CDC::SetPolyFillMode -Return ValueThe previous PolyFillMode as integer - - - -The previous PolyFillMode. - - - """ - pass - - - def SetROP2(self,mode:'Any') -> 'Any': - """ - Sets the current drawing mode. - -Args: - - mode(Any):The new drawing mode.MFC References - -Returns: - - Any - - """ - pass - - - def SetTextAlign(self,newFlags:'Any') -> 'Any': - """ - Sets the text-alignment flags. - -Args: - - newFlags(Any):The new alignment flags. Can be a combination of (TA_CENTER, TA_LEFT, TA_RIGHT), (TA_BASELINE, TA_BOTTOM, TA_TOP) and (TA_NOUPDATECP, TA_UPDATECP) The default is TA_LEFT|TA_TOP|TA_NOUPDATECPMFC References - -Returns: - - Any:CDC::SetTextAlign -Return ValueThe old alignment flags. - - - """ - pass - - - def SetTextColor(self,color:'Any') -> 'Any': - """ - Sets the text color to the specified color. - -Args: - - color(Any):A windows color specification. See the win32api documentation for details.CommentsThis text color is used when writing text to this device context and also when converting bitmaps between color and monochrome device contexts. If the device cannot represent the specified color, the system sets the text color to the nearest physical color. The background color for a character is specified by the SetBkColor and SetBkMode member functions.MFC References - -Returns: - - Any:CDC::SetTextColor -Return ValueThe return value is the previous text color. - - - """ - pass - - - def SetWindowExt(self,size:'Tuple[Any, Any]') -> 'Tuple[Any, Any]': - """ - Sets the x,y extents of the window associated with the device context. - -Args: - - size(Tuple[Any, Any]):The new size.MFC References - -Returns: - - Tuple[Any, Any]:CDC::SetWindowExt -Return ValueThe previous extents of the window (in logical units). - - - """ - pass - - - def SetWindowOrg(self,arg:'Tuple[Any, Any]') -> 'Tuple[Any, Any]': - """ - Sets the window origin of the device context - -Args: - - arg(Tuple[Any, Any]):The new origin. - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def SetViewportExt(self,size:'Tuple[Any, Any]') -> 'Tuple[Any, Any]': - """ - Sets the x,y extents of the viewport of the device context. - -Args: - - size(Tuple[Any, Any]):The new size.MFC References - -Returns: - - Tuple[Any, Any]:CDC::SetViewportExt -Return ValueThe previous extents of the viewport (in logical units). - - - """ - pass - - - def SetViewportOrg(self,arg:'Tuple[Any, Any]') -> 'Tuple[Any, Any]': - """ - Sets the viewport origin of the device context - -Args: - - arg(Tuple[Any, Any]):The new origin. - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def SetWorldTransform(self,) -> 'Any': - """ - 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 - -output. - -Args: - - - -Returns: - - Any - - """ - pass - - - def StartDoc(self,docName:'str',outputFile:'str') -> 'None': - """ - Starts spooling a document to a printer DC - -Args: - - docName(str):The document name - outputFile(str):The output file name. Use this to spool to a file. Omit to send to the printer. - -Returns: - - None - - """ - pass - - - def StartPage(self,) -> 'None': - """ - Starts a new page on a printer DC - -Args: - - - -Returns: - - None - - """ - pass - - - def StretchBlt(self,destPos:'Tuple[Any, Any]',size:'Tuple[Any, Any]',dc:'Any',srcPos:'Tuple[Any, Any]',size1:'Tuple[Any, Any]',rop:'Any') -> 'None': - """ - Copies a bitmap from the source device context to this device context. - -Args: - - destPos(Tuple[Any, Any]):The logical x,y coordinates of the upper-left corner of the destination rectangle. - size(Tuple[Any, Any]):Specifies the width and height (in logical units) of the destination rectangle and source bitmap. - dc(Any):Specifies the PyCDC object from which the bitmap will be copied. It must be None if rop specifies a raster operation that does not include a source. - srcPos(Tuple[Any, Any]):Specifies the logical x,y coordinates of the upper-left corner of the source bitmap. - size1(Tuple[Any, Any]):Specifies the width and height (in logical units) of the destination rectangle and source bitmap. - rop(Any):Specifies the raster operation to be performed. See the win32 api documentation for details.MFC References - -Returns: - - None - - """ - pass - - - def StrokeAndFillPath(self,) -> 'None': - """ - 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. - -Args: - - - -Returns: - - None - - """ - pass - - - def StrokePath(self,) -> 'None': - """ - Renders the specified path by using the current pen. - -Args: - - - -Returns: - - None - - """ - pass - - - def TextOut(self,_int:'Any',_int1:'Any',string:'Any') -> 'None': - """ - Outputs text to the display context, using the currently selected font. - -Args: - - _int(Any):The x coordinate to write the text to. - _int1(Any):The y coordinate to write the text to. - string(Any):The text to write.MFC References - -Returns: - - None:CDC::TextOut -Return ValueAlways none. If the function fails, an exception is raised. - - - """ - pass - - -class PyCDialog(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,obParent:'Any'=None) -> 'None': - """ - Create a modeless window for the dialog box. - -Args: - - obParent(Any):The parent window for the new windowMFC References - -Returns: - - None - - """ - pass - - - def DoModal(self,) -> 'Any': - """ - Create a modal window for the dialog box. - -Args: - - - -Returns: - - Any:CDialog::DoModal -Return ValueThe return value from the dialog. This is the value passed to PyCDialog::EndDialog. - - - """ - pass - - - def EndDialog(self,result:'Any') -> 'None': - """ - Ends a modal dialog box. - -Args: - - result(Any):The value to be returned by the PyCDialog::DoModal method.MFC References - -Returns: - - None - - """ - pass - - - def GotoDlgCtrl(self,control:'Any') -> 'None': - """ - Moves the focus to the specified control in the dialog box. - -Args: - - control(Any):The control to get the focus. - -Returns: - - None - - """ - pass - - - def MapDialogRect(self,rect:'Tuple[Any, Any, Any, Any]') -> 'Tuple[Any, Any, Any, Any]': - """ - Converts the dialog-box units of a rectangle to screen - -units. - -Args: - - rect(Tuple[Any, Any, Any, Any]):The rect to be converted - -Returns: - - Tuple[Any, Any, Any, Any] - - """ - pass - - - def OnCancel(self,) -> 'None': - """ - Calls the default MFC OnCancel handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnOK(self,) -> 'None': - """ - Calls the default MFC OnOK handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnInitDialog(self,) -> 'Any': - """ - Calls the default MFC OnInitDialog handler. - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyCDialogBar(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,parent:'Any',template:'PyResourceId',style:'Any',_id:'Any') -> 'None': - """ - None - -Args: - - parent(Any):The parent window - template(PyResourceId):Template name or integer resource id - style(Any):The style for the window - _id(Any):The ID of the window - -Returns: - - None - - """ - pass - - -class PyCDocTemplate(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def DoCreateDoc(self,fileName:'str'=None) -> 'Any': - """ - Creates an underlying document object. - -Args: - - fileName(str):The name of the file to load. - -Returns: - - Any - - """ - pass - - - def FindOpenDocument(self,fileName:'str') -> 'Any': - """ - Returns an existing document with the specified file name. - -Args: - - fileName(str):The fully qualified filename to search for. - -Returns: - - Any - - """ - pass - - - def GetDocString(self,docIndex:'Any') -> 'str': - """ - Retrieves a specific substring describing the document type. - -Args: - - docIndex(Any):The document index. Must be one of the win32ui.CDocTemplate_* constants.CommentsFor more information on the doc strings, please see PyCDocTemplate::SetDocStrings - -Returns: - - str - - """ - pass - - - def GetDocumentList(self,) -> 'Any': - """ - Return a list of all open documents. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetResourceID(self,) -> 'None': - """ - Returns the resource ID in use. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetSharedMenu(self,) -> 'Any': - """ - Returns the shared menu object for all frames using this template. - -Args: - - - -Returns: - - Any - - """ - pass - - - def InitialUpdateFrame(self,frame:'Any'=None,doc:'Any'=None,bMakeVisible:'Any'=1) -> 'None': - """ - Calls the default OnInitialFrame handler. - -Args: - - frame(Any):The frame window. - doc(Any):A document for the frame. - bMakeVisible(Any):Indicates of the frame should be shown.See Also - -Returns: - - None - - """ - pass - - - def SetContainerInfo(self,_id:'Any') -> 'None': - """ - Sets the resources to be used when an OLE 2 object is in-place activated. - -Args: - - _id(Any):The resource ID. - -Returns: - - None - - """ - pass - - - def SetDocStrings(self,docStrings:'str') -> 'None': - """ - Assigns the document strings for the template. - -Args: - - docStrings(str):The document strings.CommentsThe string must be a \\n seperated list of docstrings. The elements are:elementNameDescriptionwindowTitleTitle used for the window (only for SDI applications)docNameRoot for the default document name.fileNewNameName of the document type, as displayed in the "File/New" dialogfilterNameDescription of the document type and a wildcard spec for the file open dialog.filterExtExtension for documents of this file type.regFileTypeIdInternal Id of the document as registered in the registry. Used to associate the extension with the file type.regFileTypeNameName of the document, as stored in the reigstry. This is the name presented to the user. - -Returns: - - None - - """ - pass - - - def OpenDocumentFile(self,filename:'str',bMakeVisible:'Any'=1) -> 'None': - """ - Opens a document file, creating a view and frame. - -Args: - - filename(str):Name of file to open, or None - bMakeVisible(Any):Indicates if the document should be created visible. - -Returns: - - None - - """ - pass - - -class PyCDockContext(object): - """A class which encapsulates an MFC CDockContext object""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ptLast(self)->'Tuple[Any, Any]': - """""" - pass - - - @property - def rectLast(self)->'Tuple[Any, Any, Any, Any]': - """""" - pass - - - @property - def sizeLast(self)->'Tuple[Any, Any]': - """""" - pass - - - @property - def bDitherLast(self)->'Any': - """""" - pass - - - @property - def rectDragHorz(self)->'Tuple[Any, Any, Any, Any]': - """""" - pass - - - @property - def rectDragVert(self)->'Tuple[Any, Any, Any, Any]': - """""" - pass - - - @property - def rectFrameDragHorz(self)->'Tuple[Any, Any, Any, Any]': - """""" - pass - - - @property - def rectFrameDragVert(self)->'Tuple[Any, Any, Any, Any]': - """""" - pass - - - @property - def dwDockStyle(self)->'Any': - """allowable dock styles for bar""" - pass - - - @property - def dwOverDockStyle(self)->'Any': - """style of dock that rect is over""" - pass - - - @property - def dwStyle(self)->'Any': - """style of control bar""" - pass - - - @property - def bFlip(self)->'Any': - """if shift key is down""" - pass - - - @property - def bForceFrame(self)->'Any': - """if ctrl key is down CDC* m_pDC; // where to draw during drag""" - pass - - - @property - def bDragging(self)->'Any': - """""" - pass - - - @property - def nHitTest(self)->'Any': - """""" - pass - - - @property - def uMRUDockID(self)->'Any': - """""" - pass - - - @property - def rectMRUDockPos(self)->'Tuple[Any, Any, Any, Any]': - """""" - pass - - - @property - def dwMRUFloatStyle(self)->'Any': - """""" - pass - - - @property - def ptMRUFloatPos(self)->'Tuple[Any, Any]': - """Sentinel""" - pass - - - def EndDrag(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def StartDrag(self,pt:'Tuple[Any, Any]') -> 'Any': - """ - None - -Args: - - pt(Tuple[Any, Any]): - -Returns: - - Any - - """ - pass - - - def EndResize(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def StartResize(self,hittest:'Any',pt:'Tuple[Any, Any]') -> 'Any': - """ - None - -Args: - - hittest(Any): - pt(Tuple[Any, Any]): - -Returns: - - Any - - """ - pass - - - def ToggleDocking(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyCDocument(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def DeleteContents(self,) -> 'None': - """ - Call the MFC DeleteContents method. - -This routine is provided so a document object which overrides this method - -can call the original MFC version if required. - -Args: - - - -Returns: - - None - - """ - pass - - - def DoSave(self,fileName:'str',bReplace:'Any'=1) -> 'None': - """ - Calls the underlying MFC DoSave method. - -Args: - - fileName(str):The name of the file to save to. - bReplace(Any):Should an existing file be silently replaced?.CommentsIf invalid or no filename, will prompt for a name, else will perform the actual saving of the document.See Also - -Returns: - - None - - """ - pass - - - def DoFileSave(self,) -> 'None': - """ - Checks the file attributes. - -If the file is read only, a new name is prompted, else the - -file is saved (by calling DoSave) - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDocTemplate(self,) -> 'Any': - """ - Returns the template for the document. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetAllViews(self,) -> 'List[Any]': - """ - Returns a list of all views for the current document. - -Args: - - - -Returns: - - List[Any] - - """ - pass - - - def GetFirstView(self,) -> 'Any': - """ - Returns the first view object attached to this document. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetPathName(self,) -> 'str': - """ - Returns the full path name of the current document. - -The string will be empty if no path name has been set. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetTitle(self,) -> 'str': - """ - Returns the title of the current document. - -This will often be the file name portion of the path name. - -Args: - - - -Returns: - - str - - """ - pass - - - def IsModified(self,) -> 'Any': - """ - Return a flag indicating if the document has been modified. - -Args: - - - -Returns: - - Any - - """ - pass - - - def OnChangedViewList(self,) -> 'None': - """ - Informs the document when a view is added or removed. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnCloseDocument(self,) -> 'None': - """ - Call the MFC OnCloseDocument handler. - -This routine is provided so a document object which overrides this method - -can call the original MFC version if required. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnNewDocument(self,) -> 'None': - """ - Call the MFC OnNewDocument handler. - -This routine is provided so a document object which overrides this method - -can call the original MFC version if required. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnOpenDocument(self,pathName:'str') -> 'None': - """ - Call the MFC OnOpenDocument handler. - -This routine is provided so a document object which overrides this method - -can call the original MFC version if required. - -Args: - - pathName(str):The full path of the file to open.MFC References - -Returns: - - None - - """ - pass - - - def OnSaveDocument(self,pathName:'str') -> 'None': - """ - Call the MFC OnSaveDocument handler. - -This routine is provided so a document object which overrides this method - -can call the original MFC version if required. - -Args: - - pathName(str):The full path of the file to save.MFC References - -Returns: - - None - - """ - pass - - - def SetModifiedFlag(self,bModified:'Any'=1) -> 'None': - """ - Set the "dirty" flag for the document. - -Args: - - bModified(Any):Set dirty flagMFC References - -Returns: - - None - - """ - pass - - - def SaveModified(self,) -> 'Any': - """ - Call the underlying MFC method. - -Args: - - - -Returns: - - Any:CDocument::SaveModified -Return ValueNonzero if it is safe to continue and close the document; 0 if the document should not be closed. - - - """ - pass - - - def SetPathName(self,path:'str') -> 'None': - """ - Set the full path name for the document. - -Args: - - path(str):The full path of the file.MFC References - -Returns: - - None - - """ - pass - - - def SetTitle(self,title:'str') -> 'None': - """ - Set the title of the document (ie, the name - -to appear in the window caption for the document. - -Args: - - title(str):The new title.MFC References - -Returns: - - None - - """ - pass - - - def UpdateAllViews(self,sender:'Any',hint:'Any'=None) -> 'None': - """ - Informs each view when a document changes. - -Args: - - sender(Any):The view who initiated the update - hint(Any):A hint for the update.MFC References - -Returns: - - None - - """ - pass - - -class PyCEdit(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,style:'Any',rect:'Tuple[Any, Any, Any, Any]',parent:'Any',_id:'Any') -> 'None': - """ - Creates the window for a new Edit object. - -Args: - - style(Any):The style for the Edit. Use any of the win32con.BS_* constants. - rect(Tuple[Any, Any, Any, Any]):The size and position of the Edit. - parent(Any):The parent window of the Edit. Usually a PyCDialog. - _id(Any):The Edits control ID. - -Returns: - - None - - """ - pass - - - def Clear(self,) -> 'Any': - """ - Clears all text in an edit control. - -Args: - - - -Returns: - - Any - - """ - pass - - - def Copy(self,) -> 'None': - """ - Copys the current selection to the clipboard. - -Args: - - - -Returns: - - None - - """ - pass - - - def Cut(self,) -> 'None': - """ - Cuts the current selection to the clipboard. - -Args: - - - -Returns: - - None - - """ - pass - - - def FmtLines(self,bAddEOL:'Any') -> 'Any': - """ - Sets the formatting options for the control. - -Args: - - bAddEOL(Any):Specifies whether soft line-break characters are to be inserted. A value of TRUE inserts the characters; a value of FALSE removes them.MFC References - -Returns: - - Any:CEdit::FmtLines -Return ValueNonzero if any formatting occurs; otherwise 0. - - - """ - pass - - - def GetFirstVisibleLine(self,) -> 'Any': - """ - Returns zero-based index of the topmost visible line. - -Args: - - - -Returns: - - Any:CEdit::GetFirstVisibleLine -Return ValueThe zero-based index of the topmost visible line. For single-line edit controls, the return value is 0. - - - """ - pass - - - def GetSel(self,) -> 'Tuple[Any, Any]': - """ - Returns the start and end of the current selection. - -Args: - - - -Returns: - - Tuple[Any, Any]:CEdit::GetSel -Return ValueThe return tuple is (the first character in the current selection, first nonselected character past the - -end of the current selection) - - - """ - pass - - - def GetLine(self,lineNo:'Any') -> 'Any': - """ - Returns the text in a specified line. - -Args: - - lineNo(Any):Contains the zero-based index value for the desired line.CommentsThis function is not an MFC wrapper. - -Returns: - - Any - - """ - pass - - - def GetLineCount(self,) -> 'Any': - """ - Gets the number of lines in an edit control. - -Args: - - - -Returns: - - Any:CEdit::GetLineCount -Return ValueThe number of lines in the buffer. If the control is empty, the return value is 1. - - - """ - pass - - - def LimitText(self,nChars:'Any'=0) -> 'None': - """ - Sets max length of text that user can enter - -Args: - - nChars(Any):Specifies the length (in bytes) of the text that the user can enter. If this parameter is 0, the text length is set to UINT_MAX bytes. This is the default behavior.MFC References - -Returns: - - None - - """ - pass - - - def LineFromChar(self,charNo:'Any'=-1) -> 'Any': - """ - Returns the line number of the specified character. - -Args: - - charNo(Any):Contains the zero-based index value for the desired character in the text of the edit control, or -1. If -1, then it specifies the current line.MFC References - -Returns: - - Any:CEdit::LineFromChar -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 there is no selection, the current line number is returned. - - - """ - pass - - - def LineIndex(self,lineNo:'Any'=-1) -> 'Any': - """ - Retrieves the character index of a line within a multiple-line edit control. - -Args: - - lineNo(Any):Contains the index value for the desired line in the text of the edit control, or contains -1. If -1, then it specifies the current line.CommentsThis method only works on multi-linr edit controls.MFC References - -Returns: - - Any:CEdit::LineIndex -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 edit control. - - - """ - pass - - - def LineScroll(self,nLines:'Any',nChars:'Any'=0) -> 'Any': - """ - Scroll the control vertically and horizontally - -Args: - - nLines(Any):Specifies the number of lines to scroll vertically. - nChars(Any):Specifies the number of character positions to scroll horizontally. This value is ignored if the edit control has either the ES_RIGHT or ES_CENTER style.CommentsThis method only works on multi-linr edit controls.MFC References - -Returns: - - Any - - """ - pass - - - def Paste(self,) -> 'None': - """ - Pastes the contents of the clipboard into the control. - -Args: - - - -Returns: - - None - - """ - pass - - - def ReplaceSel(self,text:'str') -> 'None': - """ - Replaces the selection with the specified text. - -Args: - - text(str):The text to replace the selection with.MFC References - -Returns: - - None - - """ - pass - - - def SetReadOnly(self,bReadOnly:'Any'=1) -> 'None': - """ - Sets or clears the read-only status of the listbox. - -Args: - - bReadOnly(Any):The read-only state to set.MFC References - -Returns: - - None - - """ - pass - - - def SetSel(self,start:'Any',end:'Any',arg:'Any',bNoScroll1:'Any',bNoScroll:'Any'=0) -> 'None': - """ - Sets the selection in the edit control. - -Args: - - start(Any):Specifies the starting position. If start is 0 and end is -1, all the text in the edit control is selected. If start is -1, any current selection is removed. - end(Any):Specifies the ending position. - arg(Any):As for normal start, end args. - bNoScroll1(Any):Indicates whether the caret should be scrolled into view. If 0, the caret is scrolled into view. If 1, the caret is not scrolled into view.MFC References - bNoScroll(Any):Indicates whether the caret should be scrolled into view. If 0, the caret is scrolled into view. If 1, the caret is not scrolled into view.Alternative Parameters - -Returns: - - None - - """ - pass - - -class PyCEditView(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def IsModified(self,) -> 'Any': - """ - Indicates if the view's document has the modified flag set. - -Args: - - - -Returns: - - Any - - """ - pass - - - def LoadFile(self,fileName:'str') -> 'None': - """ - Loads a file into the view. - -Args: - - fileName(str):The name of the file to be loaded. - -Returns: - - None - - """ - pass - - - def SetModifiedFlag(self,bModified:'Any'=1) -> 'None': - """ - Sets the modified flag for the view's document. - -Args: - - bModified(Any):The modified state to set. - -Returns: - - None - - """ - pass - - - def GetEditCtrl(self,) -> 'Any': - """ - returns the underlying edit control object. - -Args: - - - -Returns: - - Any - - """ - pass - - - def PreCreateWindow(self,createStruct:'Any') -> 'Any': - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(Any):A tuple representing a CREATESTRUCT structure. - -Returns: - - Any - - """ - pass - - - def SaveFile(self,fileName:'str') -> 'None': - """ - Saves the view to a file. - -Args: - - fileName(str):The name of the file to be written. - -Returns: - - None - - """ - pass - - - def OnCommand(self,wparam:'Any',lparam:'Any') -> 'None': - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(Any): - lparam(Any):See Also - -Returns: - - None - - """ - pass - - -class PyCFileDialog(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPathName(self,) -> 'str': - """ - Retrives the path name from the file dialog. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetFileName(self,) -> 'str': - """ - Retrives the file name from the file dialog. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetFileExt(self,) -> 'str': - """ - Retrives the file extension from the file dialog. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetFileTitle(self,) -> 'str': - """ - Retrives the file title from the file dialog. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetPathNames(self,) -> 'str': - """ - Retrieves the list of path names from the file dialog. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetReadOnlyPref(self,) -> 'Any': - """ - Retrives the value of the "Read Only" checkbox on the file dialog. - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetOFNTitle(self,title:'str') -> 'None': - """ - Sets the Title for the dialog. - -Args: - - title(str):The title for the dialog box. May be None. - -Returns: - - None - - """ - pass - - - def SetOFNInitialDir(self,title:'str') -> 'None': - """ - Sets the initial directory for the dialog. - -Args: - - title(str):The initial directory for the dialog box. May be None. - -Returns: - - None - - """ - pass - - -class PyCFont(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetSafeHandle(self,) -> 'Any': - """ - Retrieves the HFONT for the font as an integer - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyCFontDialog(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def DoModal(self,) -> 'Any': - """ - Displays a dialog and allows the user to make a selection. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetCurrentFont(self,) -> 'Any': - """ - Returns a dictionary describing the current font. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetCharFormat(self,) -> 'Any': - """ - Returns the font selection in a CHARFORMAT tuple. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetColor(self,) -> 'Any': - """ - Determines the color of the selected font. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetFaceName(self,) -> 'str': - """ - Returns the face name of the selected font. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetStyleName(self,) -> 'str': - """ - Returns the style name of the selected font. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetSize(self,) -> 'Any': - """ - Returns he font's size, in tenths of a point. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetWeight(self,) -> 'Any': - """ - Returns the font's weight. - -Args: - - - -Returns: - - Any - - """ - pass - - - def IsStrikeOut(self,) -> 'Any': - """ - Determines whether the font is displayed with strikeout. - -Args: - - - -Returns: - - Any - - """ - pass - - - def IsUnderline(self,) -> 'Any': - """ - Determines whether the font is displayed with underline. - -Args: - - - -Returns: - - Any - - """ - pass - - - def IsBold(self,) -> 'Any': - """ - Determines whether the font is displayed bold. - -Args: - - - -Returns: - - Any - - """ - pass - - - def IsItalic(self,) -> 'Any': - """ - Determines whether the font is displayed with italic. - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyCFormView(object): - """A class which implementes a CFormView (ie, a view based on a dialog resource.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OnCommand(self,wparam:'Any',lparam:'Any') -> 'None': - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(Any): - lparam(Any):See Also - -Returns: - - None - - """ - pass - - -class PyCFrameWnd(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def BeginModalState(self,) -> 'None': - """ - Sets the frame window to modal. - -Args: - - - -Returns: - - None - - """ - pass - - - def CreateWindow(self,wndClass:'str',title:'str',style:'Any',PyCWnd:'Any',menuId:'Any',styleEx:'Any',rect:'Tuple[Any, Any, Any, Any]'=None,createContext:'Any'=None) -> 'Any': - """ - Creates the actual window for the PyCFrameWnd object. - -Args: - - wndClass(str):The window class name, or None - title(str):The window title - style(Any):The window style - PyCWnd(Any):The parent window - menuId(Any):The string or integer id for the menu. - styleEx(Any):The extended style of the window being created.MFC References - rect(Tuple[Any, Any, Any, Any]):The default rectangle - createContext(Any):A tuple representing a CREATECONTEXT structure. - -Returns: - - Any - - """ - pass - - - def EndModalState(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def DockControlBar(self,controlBar:'Any',arg:'Tuple[Any, Any, Any, Any]',dockBarId:'Any'=0) -> 'None': - """ - Docks a control bar. - -Args: - - controlBar(Any):The control bar to dock. - arg(Tuple[Any, Any, Any, Any]):Determines, in screen coordinates, where the control bar will be docked in the nonclient area of the destination frame window.MFC References - dockBarId(Any):Determines which sides of the frame window to consider for docking. - -Returns: - - None - - """ - pass - - - def EnableDocking(self,style:'Any') -> 'None': - """ - Enable dockable control bars in a frame window - -Args: - - style(Any):Specifies which sides of the frame window can serve as docking sites for control bars.CommentsBy default, control bars will be docked to a side of the frame window in the following order: top, bottom, left, right. - -Returns: - - None - - """ - pass - - - def FloatControlBar(self,controlBar:'Any',arg:'Tuple[Any, Any]',style:'Any') -> 'None': - """ - Floats a control bar. - -Args: - - controlBar(Any):The control bar to dock. - arg(Tuple[Any, Any]):The location, in screen coordinates, where the top left corner of the control bar will be placed. - style(Any):Determines which sides of the frame window to consider for docking.MFC References - -Returns: - - None - - """ - pass - - - def GetActiveDocument(self,) -> 'Any': - """ - Gets the currently active document, else None - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetControlBar(self,_id:'Any') -> 'Any': - """ - Retrieves the specified control bar. - -Args: - - _id(Any):The ID of the toolbar to be retrieved - -Returns: - - Any - - """ - pass - - - def GetMessageString(self,_id:'Any') -> 'str': - """ - Retrieves message corresponding to a command ID. - -Args: - - _id(Any):The ID to be retrievedSee Also - -Returns: - - str - - """ - pass - - - def GetMessageBar(self,) -> 'Any': - """ - Retrieves the message bar for the frame. - -Args: - - - -Returns: - - Any - - """ - pass - - - def IsTracking(self,) -> 'Any': - """ - Determines if splitter bar is currently being moved. - -Args: - - - -Returns: - - Any - - """ - pass - - - def InModalState(self,) -> 'Any': - """ - Returns a value indicating whether or not a frame window is in a modal state. - -Args: - - - -Returns: - - Any - - """ - pass - - - def LoadAccelTable(self,_id:'PyResourceId') -> 'None': - """ - Loads an accelerator table. - -Args: - - _id(PyResourceId):Name or id of the resource that contains the table - -Returns: - - None - - """ - pass - - - def LoadFrame(self,idResource:'Any',style:'Any'=-1,wndParent:'Any'=None,context:'Any'=None) -> 'None': - """ - Loads a Windows frame window and associated resources - -Args: - - idResource(Any):The Id of the resources (menu, icon, etc) for this window - style(Any):The window style. Note -1 implies win32con.WS_OVERLAPPEDWINDOW|win32con.FWS_ADDTOTITLE - wndParent(Any):The parent of the window, or None. - context(Any):An object passed to the OnCreateClient for the frame,MFC References - -Returns: - - None - - """ - pass - - - def LoadBarState(self,profileName:'str') -> 'None': - """ - Loads a control bars settings - -Args: - - profileName(str):Name of a section in the initialization file or a key in the Windows registry where state information is stored.MFC References - -Returns: - - None - - """ - pass - - - def PreCreateWindow(self,createStruct:'Any') -> 'Any': - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(Any):A tuple representing a CREATESTRUCT structure.See Also - -Returns: - - Any - - """ - pass - - - def SaveBarState(self,profileName:'str') -> 'None': - """ - Saves a control bars settings - -Args: - - profileName(str):Name of a section in the initialization file or a key in the Windows registry where state information is stored.MFC References - -Returns: - - None - - """ - pass - - - def ShowControlBar(self,controlBar:'Any',bShow:'Any',bDelay:'Any') -> 'None': - """ - Shows a control bar. - -Args: - - controlBar(Any):The control bar to dock. - bShow(Any):Show or hide flag. - bDelay(Any):If TRUE, delay showing the control bar. If FALSE, show the control bar immediately.MFC References - -Returns: - - None - - """ - pass - - - def RecalcLayout(self,bNotify:'Any'=1) -> 'None': - """ - Called by the framework when the standard control bars are toggled on or off or - -when the frame window is resized. - -Args: - - bNotify(Any):Notify flagMFC References - -Returns: - - None - - """ - pass - - - def GetActiveView(self,) -> 'Any': - """ - Retrieves the active view. - -Args: - - - -Returns: - - Any - - """ - pass - - - def OnBarCheck(self,_id:'Any') -> 'Any': - """ - Changes the state of the specified controlbar. - -Args: - - _id(Any):The control ID of the control bar. - -Returns: - - Any - - """ - pass - - - def OnUpdateControlBarMenu(self,cmdUI:'Any') -> 'Any': - """ - Checks the state of a menu item - -Args: - - cmdUI(Any):A cmdui object - -Returns: - - Any - - """ - pass - - - def SetActiveView(self,view:'Any',bNotify:'Any'=1) -> 'None': - """ - Sets the active view for a frame. - -Args: - - view(Any):The view to set active. - bNotify(Any):Specifies whether the view is to be notified of activation. If TRUE, OnActivateView is called for the new view; if FALSE, it is not. - -Returns: - - None - - """ - pass - - -class PyCGdiObject(object): - """A class which encapsulates an MFC CGdiObject.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCImageList(object): - """A Python type encapsulating an MFC CImageList class.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Add(self,arg:'Tuple[Any, Any]',bitmap:'Any',color:'Any',hIcon:'Any') -> 'Any': - """ - Adds an image to the list. - -Args: - - arg(Tuple[Any, Any]):2 Bitmaps to use (primary and mask)Alternative Parameters - bitmap(Any):Bitmap to use - color(Any):Color to use for the mask.Alternative Parameters - hIcon(Any):Handle of an icon to add.Return ValueZero-based index of the first new image. - -Returns: - - Any:Handle of an icon to add. -Return ValueZero-based index of the first new image. - - - """ - pass - - - def Destroy(self,) -> 'None': - """ - Destroys the underlying CImageList - -Args: - - - -Returns: - - None - - """ - pass - - - def DeleteImageList(self,) -> 'None': - """ - Deletes an image list. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetBkColor(self,) -> 'Any': - """ - Retrieves the background color of an Image List. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetSafeHandle(self,) -> 'Any': - """ - Retrieves the HIMAGELIST for the object - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetImageCount(self,) -> 'Any': - """ - Retrieves the number of images in an image list. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetImageInfo(self,index:'Any') -> 'Any': - """ - Retrieves information about an image. - -Args: - - index(Any):Index of image.Return ValueThe return info is a tuple describing an IMAGELIST structure. - -Returns: - - Any:Index of image.Return ValueThe return info is a tuple describing an IMAGELIST structure. - - - """ - pass - - - def SetBkColor(self,color:'Any') -> 'None': - """ - Sets the background color for an Image List. - -Args: - - color(Any):The new background color. - -Returns: - - None - - """ - pass - - -class PyCListBox(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddString(self,_object:'Any') -> 'Any': - """ - Adds a string to a listbox. - -Args: - - _object(Any):Any object. If not a string, __str__, __repr__ or a default repr() will be usedMFC References - -Returns: - - Any:CListBox::AddString -Return ValueThe zero based index of the new string. - - - """ - pass - - - def DeleteString(self,pos:'Any') -> 'Any': - """ - Deletes an item from a listbox. - -Args: - - pos(Any):The zero based index of the item to delete.MFC References - -Returns: - - Any:CListBox::DeleteString -Return ValueThe count of the items remaining in the list. - - - """ - pass - - - def Dir(self,attr:'Any',wild:'str') -> 'Any': - """ - Fills a listbox with a directory listing. - -Args: - - attr(Any):The attributes of the files to locate - wild(str):A file specification string - eg, *.*MFC References - -Returns: - - Any:CListBox::Dir -Return ValueThe index of the last file name added to the list. - - - """ - pass - - - def GetCaretIndex(self,) -> 'Any': - """ - Returns the index of the item which has focus. - -Args: - - - -Returns: - - 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. - -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 - - - def GetCount(self,) -> 'Any': - """ - Returns the count of items in the listbox. - -Args: - - - -Returns: - - Any:CListBox::GetCount -Return ValueReturns the number of items currently in the listbox. - - - """ - pass - - - def GetCurSel(self,) -> 'Any': - """ - Returns the index of the currently selected item. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetItemData(self,item:'Any') -> 'Any': - """ - Retrieves the application-specific object associated with an item. - -Args: - - item(Any):The index of the item whose data is to be retrieved. - -Returns: - - Any - - """ - pass - - - def GetItemValue(self,item:'Any') -> 'Any': - """ - Retrieves the application-specific value associated with an item. - -Args: - - item(Any):The index of the item whose data is to be retrieved. - -Returns: - - Any - - """ - pass - - - def GetSel(self,index:'Any') -> 'Any': - """ - Returns the selection state of a specified item. - -Args: - - index(Any):The index of the item to return the state for.MFC References - -Returns: - - Any:CListBox::GetSel -Return ValueA +ve number if the item is selected, else zero. - - - """ - pass - - - def GetSelCount(self,) -> 'Any': - """ - Returns the number of selected items in a multiple selection listbox. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetSelItems(self,) -> 'Any': - """ - Returns a list of the indexes of the currently selected items in a multiple - -selection listbox. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetSelTextItems(self,) -> 'Any': - """ - Returns a list of the strings of the currently selected items in a multiple - -selection listbox. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetTopIndex(self,) -> 'Any': - """ - Returns the index of the top most visible item. - -Args: - - - -Returns: - - Any:CListBox::GetTopIndex -Return ValueThe zero based index of the top most visible item. - - - """ - pass - - - def GetText(self,index:'Any') -> 'str': - """ - Returns the string for a specified item. - -Args: - - index(Any):The index of the item to retrieve the text of - -Returns: - - str - - """ - pass - - - def GetTextLen(self,index:'Any') -> 'Any': - """ - Returns the length of the string for a specified item. - -Args: - - index(Any):The index of the item to retrieve the length of the text.MFC References - -Returns: - - Any - - """ - pass - - - def InsertString(self,pos:'Any',_object:'Any') -> 'Any': - """ - Insert a string into a listbox. - -Args: - - pos(Any):The zero based index in the listbox to insert the new string - _object(Any):The object to be added to the listboxMFC References - -Returns: - - Any:CListBox::InsertString -Return ValueThe zero based index of the new string added. - - - """ - pass - - - def ResetContent(self,) -> 'None': - """ - Clear all the items from a listbox. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetCaretIndex(self,index:'Any',bScroll:'Any'=1) -> 'None': - """ - Sets the focus rectange to a specified item. - -Args: - - index(Any):The zero based index of the item. - bScroll(Any):Should the listbox scroll to the item?MFC References - -Returns: - - None - - """ - pass - - - def SelectString(self,after:'Any',string:'str') -> 'None': - """ - Searches for a list-box item that matches the specified string, and selects it. - -Args: - - after(Any):Contains the zero-based index of the item before the first item to be searched, or -1 for the entire listbox. - string(str):The string to search for.MFC References - -Returns: - - None:CListBox::SelectString -Return ValueThe return value is always None - an exception is raised if the string can not be located. - - - """ - pass - - - def SelItemRange(self,bSel:'Any',start:'Any',end:'Any') -> 'None': - """ - Selects an item range. - -Args: - - bSel(Any):Should the selection specified be set or cleared? - start(Any):The zero based index of the first item to select. - end(Any):The zero based index of the last item to select. - -Returns: - - None - - """ - pass - - - def SetCurSel(self,index:'Any') -> 'None': - """ - Selects an item in a single selection listbox. - -Args: - - index(Any):The zero based index of the item to select.MFC References - -Returns: - - None - - """ - pass - - - def SetItemData(self,item:'Any',Data:'Any') -> 'Any': - """ - Sets the item's application-specific object value. - -Args: - - item(Any):Index of the item whose Data is to be set. - Data(Any):New value for the data.CommentsNote that a reference count is not added to the object. This it is your responsibility to make sure the object remains alive while in the list. - -Returns: - - Any - - """ - pass - - - def SetItemValue(self,item:'Any',data:'Any') -> 'Any': - """ - Sets the item's application-specific value. - -Args: - - item(Any):Index of the item whose Data is to be set. - data(Any):New value for the data. - -Returns: - - Any - - """ - pass - - - def SetSel(self,index:'Any',bSel:'Any'=1) -> 'None': - """ - Selects an item in a multiple selection listbox. - -Args: - - index(Any):The zero based index of the item to select. - bSel(Any):Should the item be selected or deselected?MFC References - -Returns: - - None - - """ - pass - - - def SetTabStops(self,eachTabStop:'Any',tabStops:'Any') -> 'None': - """ - Sets the tab stops for a listbox. - -Args: - - eachTabStop(Any):The position for each tab stop.Alternative Parameters - tabStops(Any):Each individual tab stop. - -Returns: - - None - - """ - pass - - - def SetTopIndex(self,index:'Any') -> 'None': - """ - Sets the top index (top most visible item) of the listbox. - -Args: - - index(Any):The zero based index of the item to place at the top of the list.MFC References - -Returns: - - None - - """ - pass - - -class PyCListCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Arrange(self,code:'Any') -> 'None': - """ - Aligns items on a grid. - -Args: - - code(Any):Specifies the alignment style for the items - -Returns: - - None - - """ - pass - - - def CreateWindow(self,style:'Any',rect:'Tuple[Any, Any, Any, Any]',PyCWnd:'Any',_id:'Any') -> 'None': - """ - Creates the actual window for the object. - -Args: - - style(Any):The window style - rect(Tuple[Any, Any, Any, Any]):The default rectangle - PyCWnd(Any):The parent window - _id(Any):The control IDMFC References - -Returns: - - None - - """ - pass - - - def DeleteAllItems(self,) -> 'None': - """ - Deletes all items from the list. - -Args: - - - -Returns: - - None - - """ - pass - - - def DeleteItem(self,item:'Any') -> 'None': - """ - Deletes the specified item. - -Args: - - item(Any):The item to delete. - -Returns: - - None - - """ - pass - - - def GetTextColor(self,) -> 'Any': - """ - Retrieves the text color of a list view control. - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetTextColor(self,color:'Any') -> 'None': - """ - Sets the text color of a list view control. - -Args: - - color(Any):The new color. - -Returns: - - None - - """ - pass - - - def GetBkColor(self,) -> 'Any': - """ - Retrieves the background color of the control. - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetBkColor(self,color:'Any') -> 'None': - """ - Sets the background color of the control. - -Args: - - color(Any):The new background color. - -Returns: - - None - - """ - pass - - - def GetItem(self,item:'Any',sub:'Any') -> 'Any': - """ - Retrieves the details of an items attributes. - -Args: - - item(Any):The index of the item whose attributes are to be retrieved. - sub(Any):Specifies the subitem whose text is to be retrieved. - -Returns: - - Any - - """ - pass - - - def GetItemCount(self,) -> 'Any': - """ - Retrieves the number of items in a list view control. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetItemRect(self,item:'Any',bTextOnly:'Any') -> 'Tuple[Any, Any, Any, Any]': - """ - Retrieves the bounding rectangle of a list view item. - -Args: - - item(Any):Index of the item whose Data is to be set. - bTextOnly(Any):f this parameter is nonzero, the bounding rectangle includes only the text of the item. Otherwise it includes the entire line that the item occupies in the list view control. - -Returns: - - Tuple[Any, Any, Any, Any] - - """ - pass - - - def GetEditControl(self,) -> 'Any': - """ - Retrieves the handle of the edit control used to edit the specified - -list view item. - -Args: - - - -Returns: - - Any - - """ - pass - - - def EditLabel(self,item:'Any') -> 'Any': - """ - Edits a specified list view item in-place. - -Args: - - item(Any):The index of item to edit. - -Returns: - - Any - - """ - pass - - - def EnsureVisible(self,item:'Any',bPartialOK:'Any') -> 'Any': - """ - Ensures that a list view item is visible in its list view control. - -Args: - - item(Any):The index of item to edit. - bPartialOK(Any):Specifies whether partial visibility is acceptable. - -Returns: - - Any - - """ - pass - - - def CreateDragImage(self,item:'Any') -> 'Tuple[Any, Any, Any]': - """ - Creates a dragging bitmap for the specified list view - -item. - -Args: - - item(Any):The index of the item to edit. - -Returns: - - Tuple[Any, Any, Any] - - """ - pass - - - def GetImageList(self,nImageList:'Any') -> 'Any': - """ - Retrieves the current image list. - -Args: - - nImageList(Any):Value specifying which image list to retrieve. It can be one of: - commctrl.LVSIL_NORMAL Image list with large icons. - commctrl.LVSIL_SMALL Image list with small icons. - commctrl.LVSIL_STATE Image list with state images. - -Returns: - - Any - - """ - pass - - - def GetNextItem(self,item:'Any',flags:'Any') -> 'Any': - """ - Searches for a list view item with specified properties and with specified - -relationship to a given item. - -Args: - - item(Any):Index of the item to begin the searching with, or -1 to find the first item that matches the specified flags. The specified item itself is excluded from the search. - flags(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: LVNI_ABOVELVNI_ALLLVNI_BELOWLVNI_TOLEFTLVNI_TORIGHT The state can be zero, or it can be one or more of these values: LVNI_DROPHILITEDLVNI_FOCUSEDLVNI_HIDDENLVNI_MARKEDLVNI_SELECTED 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. - -Returns: - - 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: - -LVNI_ABOVELVNI_ALLLVNI_BELOWLVNI_TOLEFTLVNI_TORIGHT - -The state can be zero, or it can be one or more of these values: - -LVNI_DROPHILITEDLVNI_FOCUSEDLVNI_HIDDENLVNI_MARKEDLVNI_SELECTED - -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 - - - def InsertColumn(self,colNo:'Any',item:'Any') -> 'Any': - """ - Inserts a column into a list control when in report view. - -Args: - - colNo(Any):The new column number - item(Any):A tuple describing the new column. - -Returns: - - Any - - """ - pass - - - def InsertItem(self,item:'Any',item1:'Any',text:'Any',image:'Any',item2:'Any',text1:'Any') -> 'Any': - """ - Inserts an item into the list. - -Args: - - item(Any):A tuple describing the new item.Alternative Parameters - item1(Any):The index of the item. - text(Any):The text of the item. - image(Any):The index of the image to use.Alternative Parameters - item2(Any):The index of the item. - text1(Any):The text of the item. - -Returns: - - Any - - """ - pass - - - def SetImageList(self,imageList:'Any',imageType:'Any') -> 'Any': - """ - Assigns an image list to a list view control. - -Args: - - imageList(Any):The Image List to use. - imageType(Any):Type of image list. It can be one of (COMMCTRL.) LVSIL_NORMAL, LVSIL_SMALL or LVSIL_STATE - -Returns: - - Any - - """ - pass - - - def GetColumn(self,column:'Any') -> 'Any': - """ - Retrieves the details of a column in the control. - -Args: - - column(Any):The index of the column whose attributes are to be retrieved. - -Returns: - - Any - - """ - pass - - - def GetTextBkColor(self,) -> 'Any': - """ - Retrieves the text background color of a list view control. - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetTextBkColor(self,color:'Any') -> 'None': - """ - Sets the text background color of a list view control. - -Args: - - color(Any):The new background color. - -Returns: - - None - - """ - pass - - - def GetTopIndex(self,) -> 'Any': - """ - Retrieves the index of the topmost visible item. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetCountPerPage(self,) -> 'Any': - """ - Calculates the number of items that can fit vertically in a list view - -control. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetSelectedCount(self,) -> 'Any': - """ - Retrieves the number of selected items in the list view control. - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetItem(self,item:'Any') -> 'Any': - """ - Sets some of all of an items attributes. - -Args: - - item(Any):A tuple describing the new item. - -Returns: - - Any - - """ - pass - - - def SetItemState(self,item:'Any',state:'Any',mask:'Any') -> 'Any': - """ - Changes the state of an item in a list view control. - -Args: - - item(Any):Index of the item whose state is to be set. - state(Any):New values for the state bits. - mask(Any):Mask specifying which state bits to change. - -Returns: - - Any - - """ - pass - - - def GetItemState(self,item:'Any',mask:'Any') -> 'Any': - """ - Retrieves the state of a list view item. - -Args: - - item(Any):The index of the item whose position is to be retrieved. - mask(Any):Mask specifying which of the item's state flags to return. - -Returns: - - Any - - """ - pass - - - def SetItemData(self,item:'Any',Data:'Any') -> 'Any': - """ - Sets the item's application-specific value. - -Args: - - item(Any):Index of the item whose Data is to be set. - Data(Any):New value for the data.CommentsNote that a reference count is not added to the object. This it is your responsibility to make sure the object remains alive while in the list. - -Returns: - - Any - - """ - pass - - - def GetItemData(self,item:'Any') -> 'Any': - """ - Retrieves the application-specific value associated with an item. - -Args: - - item(Any):The index of the item whose data is to be retrieved. - -Returns: - - Any - - """ - pass - - - def SetItemCount(self,count:'Any') -> 'None': - """ - Prepares a list view control for adding a large number of items. - -Args: - - count(Any):Number of items that the control will ultimately contain.CommentsBy calling this function before adding a large number of items, you enable a list view control to reallocate its internal data structures only once rather than every time you add an item. - -Returns: - - None - - """ - pass - - - def SetItemText(self,item:'Any',sub:'Any',text:'str') -> 'Any': - """ - Changes the text of a list view item or subitem. - -Args: - - item(Any):Index of the item whose text is to be set. - sub(Any):Index of the subitem, or zero to set the item label. - text(str):String that contains the new item text. - -Returns: - - Any - - """ - pass - - - def GetItemText(self,item:'Any',sub:'Any') -> 'Any': - """ - Retrieves the text of a list view item or subitem. - -Args: - - item(Any):The index of the item whose text is to be retrieved. - sub(Any):Specifies the subitem whose text is to be retrieved. - -Returns: - - Any - - """ - pass - - - def RedrawItems(self,first:'Any',first1:'Any') -> 'Any': - """ - Forces a listview to repaint a range of items. - -Args: - - first(Any):Index of the first item to be repainted. - first1(Any):Index of the last item to be repainted.CommentsThe specified items are not actually repainted until the list view window receives a WM_PAINT message. To repaint immediately, call the Windows UpdateWindow function after using this function. - -Returns: - - Any - - """ - pass - - - def Update(self,item:'Any') -> 'None': - """ - Forces the control to repaint a specified item. - -Args: - - item(Any):The new color. - -Returns: - - None - - """ - pass - - - def SetColumn(self,colNo:'Any',item:'Any') -> 'Any': - """ - Changes column state in a list control when in report view. - -Args: - - colNo(Any):The to be modified column number - item(Any):A tuple describing the modified column. - -Returns: - - Any - - """ - pass - - - def DeleteColumn(self,first:'Any') -> 'Any': - """ - Deletes the specified column from the list control. - -Args: - - first(Any):Index of the column to be removed. - -Returns: - - Any - - """ - pass - - - def GetColumnWidth(self,first:'Any') -> 'Any': - """ - Gets the width of the specified column in the list control. - -Args: - - first(Any):Index of the column whose width is to be retrieved. - -Returns: - - Any - - """ - pass - - - def SetColumnWidth(self,first:'Any',first1:'Any') -> 'Any': - """ - Sets the width of the specified column in the list control. - -Args: - - first(Any):Index of the column to be changed. - first1(Any):New width of the column. - -Returns: - - Any - - """ - pass - - - def GetStringWidth(self,first:'Any') -> 'Any': - """ - Gets the necessary column width to fully display this text in a column. - -Args: - - first(Any):String that contains the text whose width is to be determined.CommentsDoesn't take the size of an included Image in account, only the size of the text is determined. - -Returns: - - Any - - """ - pass - - - def HitTest(self,arg:'Any') -> 'Tuple[Any, Any, Any]': - """ - Determines which list view item, if any, is at a specified position. - -Args: - - arg(Any):The point to test.Return ValueThe result is a tuple of (flags, item, subItem). flags may be a combination of the following values:ValueDescriptioncommctrl.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 list item.commctrl.LVHT_ONITEMICONThe position is over a list view item's icon.commctrl.LVHT_ONITEMLABELThe position is over a list view item's text.commctrl.LVHT_ONITEMSTATEICONThe position is over the state image of a list view item.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. - -Returns: - - Tuple[Any, Any, Any]:The point to test.Return ValueThe result is a tuple of (flags, item, subItem). - -flags may be a combination of the following values: - - - -Value - - -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 - -list item. -commctrl.LVHT_ONITEMICONThe position is over a list view item's icon. -commctrl.LVHT_ONITEMLABELThe position is over a list view item's text. -commctrl.LVHT_ONITEMSTATEICONThe position is over the state image of a list view item. -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 - - - def GetItemPosition(self,item:'Any') -> 'Tuple[Any, Any]': - """ - Determines the position of the specified item. - -Args: - - item(Any):The item to determine the position for. - -Returns: - - Tuple[Any, Any] - - """ - pass - - -class PyCListView(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def PreCreateWindow(self,createStruct:'Any') -> 'Any': - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(Any):A tuple representing a CREATESTRUCT structure. - -Returns: - - Any - - """ - pass - - - def GetListCtrl(self,) -> 'Any': - """ - Returns the underlying list control object. - -Args: - - - -Returns: - - Any - - """ - pass - - - def OnCommand(self,wparam:'Any',lparam:'Any') -> 'None': - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(Any): - lparam(Any):See Also - -Returns: - - None - - """ - pass - - -class PyCMDIChildWnd(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ActivateFrame(self,cmdShow:'Any'=-1) -> 'None': - """ - Calls the underlying MFC ActivateFrame method. - -Args: - - cmdShow(Any):The status of the window.See Also - -Returns: - - None - - """ - pass - - - def CreateWindow(self,wndClass:'str',title:'str',style:'Any',PyCWnd:'Any',rect:'Tuple[Any, Any, Any, Any]'=None,createContext:'Any'=None) -> 'Any': - """ - Creates the actual window for the PyCWnd object. - -Args: - - wndClass(str):The window class name, or None - title(str):The window title - style(Any):The window style - PyCWnd(Any):The parent window - rect(Tuple[Any, Any, Any, Any]):The default rectangle - createContext(Any):A tuple representing a CREATECONTEXT structure.CommentsYou do not need to call this method if you use the MFC Document/View framework. - -Returns: - - Any - - """ - pass - - - def GetMDIFrame(self,) -> 'None': - """ - Returns the MDI parent frame - -Args: - - - -Returns: - - None - - """ - pass - - - def MDIActivate(self,cmdShow:'Any'=-1) -> 'None': - """ - Activates the MDI frame independent of the main frame. - -Args: - - cmdShow(Any):The status of the window.See Also - -Returns: - - None - - """ - pass - - - def PreCreateWindow(self,createStruct:'Any') -> 'Any': - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(Any):A tuple representing a CREATESTRUCT structure.See Also - -Returns: - - Any - - """ - pass - - - def PreTranslateMessage(self,) -> 'None': - """ - Calls the base PreTranslateMessage handler - -Args: - - - -Returns: - - None - - """ - pass - - - def OnCommand(self,wparam:'Any',lparam:'Any') -> 'None': - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(Any): - lparam(Any):See Also - -Returns: - - None - - """ - pass - - - def OnClose(self,) -> 'None': - """ - Calls the standard Python framework OnClose handler - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCMDIFrameWnd(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetMDIClient(self,) -> 'Any': - """ - Returns the MDI client window - -Args: - - - -Returns: - - Any - - """ - pass - - - def MDIGetActive(self,) -> 'Tuple[Any, Any]': - """ - Retrieves the current active MDI child window, along - -with a flag indicating whether the child window is maximized. - -Args: - - - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def MDIActivate(self,window:'Any') -> 'Any': - """ - Activate an MDI child window - -Args: - - window(Any):The window to activate. - -Returns: - - Any - - """ - pass - - - def MDINext(self,fNext:'Any'=0) -> 'None': - """ - Activates the next MDI window - -Args: - - fNext(Any):Indicates if the next (0) or previous (non-zero) window is requested.CommentsUnlike MFC, this version supports the fNext param in the WM_MDINEXT message. - -Returns: - - None - - """ - pass - - - def PreCreateWindow(self,createStruct:'Any') -> 'Any': - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(Any):A tuple representing a CREATESTRUCT structure.See Also - -Returns: - - Any - - """ - pass - - - def PreTranslateMessage(self,) -> 'None': - """ - Calls the base PreTranslateMessage handler - -Args: - - - -Returns: - - None - - """ - pass - - - def OnCommand(self,wparam:'Any',lparam:'Any') -> 'None': - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(Any): - lparam(Any):See Also - -Returns: - - None - - """ - pass - - - def OnContextHelp(self,) -> 'Any': - """ - Calls the underlying MFC OnContextHelp method. - -Args: - - - -Returns: - - Any - - """ - pass - - - def OnClose(self,) -> 'None': - """ - Calls the standard Python framework OnClose handler - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCMenu(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AppendMenu(self,flags:'Any',_id:'Any'=0,value:'Union[Any, str]'=None) -> 'None': - """ - Appends a new item to the end of a menu. Python can specify the state of the menu item - -by setting values in nFlags. - -Args: - - flags(Any):Specifies information about the state of the new menu item when it is added to the menu. May be a combination of the win32con.MF_* values. - _id(Any):Specifies either the command ID of the new menu item. - value(Union[Any, str]):Specifies the content of the new menu item. If used, flags must contain win32con.MF_STRING. - -Returns: - - None - - """ - pass - - - def DeleteMenu(self,_id:'Any',flags:'Any') -> 'str': - """ - Deletes the specified menu item. - -Args: - - _id(Any):The id of the item being deleted. - flags(Any):Specifies how the id parameter is interpreted. It must be one of win32con.MF_BYCOMMAND or win32con.MF_BYPOSITION. - -Returns: - - str - - """ - pass - - - def EnableMenuItem(self,_id:'Any',flags:'Any') -> 'Any': - """ - Enables, disables, or dims a menu item. - -Args: - - _id(Any):Specifies the command ID of the menu item. This parameter can specify pop-up menu items as well as standard menu items. - flags(Any):Specifies the action to take. It can be a combination of MF_DISABLED, MF_ENABLED, or MF_GRAYED, with MF_BYCOMMAND or MF_BYPOSITIONCommentsThe PyCMenu::CreateMenu, PyCMenu::InsertMenu, PyCMenu::ModifyMenu, and PyCMenu::LoadMenuIndirect member functions can also set the state (enabled, disabled, or dimmed) of a menu item. - -Returns: - - Any - - """ - pass - - - def GetHandle(self,) -> 'Any': - """ - Returns the menu object's underlying hMenu. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetMenuItemCount(self,) -> 'Any': - """ - Determines the number of items in a menu. - -Args: - - - -Returns: - - Any:PyCMenu.GetMenuItemCount - -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 - - - def GetMenuItemID(self,pos:'Any') -> 'Any': - """ - Returns the item ID for the specified item in a pop-up menu. - -Args: - - pos(Any):The position (zero-based) of the menu item whose ID is being retrieved.CommentsIf the specified item is a pop-up menu (as opposed to an item within the pop-up menu), the return value is -1. If nPos corresponds to a SEPARATOR menu item, the return value is 0. - -Returns: - - Any - - """ - pass - - - def GetMenuString(self,_id:'Any',arg:'Any') -> 'str': - """ - Returns the string for a specified menu item. - -Args: - - _id(Any):The id of the item being requested. - arg(Any):Specifies how the id parameter is interpreted. It must be one of win32con.MF_BYCOMMAND or win32con.MF_BYPOSITION. - -Returns: - - str - - """ - pass - - - def GetSubMenu(self,pos:'Any') -> 'Any': - """ - Returns a submenu. - -Args: - - pos(Any):The position (zero-based) of the menu item being retrieved. - -Returns: - - Any - - """ - pass - - - def InsertMenu(self,pos:'Any',flags:'Any',_id:'Union[Any]'=0,value:'Union[Any, str]'=None) -> 'None': - """ - Inserts an item into a menu. - -Args: - - pos(Any):The position (zero-based) the item should be inserted. - flags(Any):Flags for the new item. - _id(Union[Any]):The ID for a new menu item, or handle to a submenu - value(Union[Any, str]):A string for the menu item. - -Returns: - - None - - """ - pass - - - def ModifyMenu(self,pos:'Any',flags:'Any',_id:'Any'=0,value:'Union[Any, str]'=None) -> 'None': - """ - Modify an item in a menu. - -Args: - - pos(Any):The position (zero-based) the item to be changed. - flags(Any):Flags for the item. - _id(Any):The ID for the item. - value(Union[Any, str]):A string for the menu item. - -Returns: - - None - - """ - pass - - - def TrackPopupMenu(self,arg:'Tuple[Any, Any]',arg1:'Any',arg2:'Any') -> 'None': - """ - Creates a popup menu anywhere on the screen. - -Args: - - arg(Tuple[Any, Any]):The position for the menu.. - arg1(Any):Flags for the menu. - arg2(Any):The owner of the menu.CommentsThe TrackPopupMenu function displays a floating pop-up menu at the 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 returned instead of the normal exception. - -Returns: - - None:The owner of the menu. -Comments - -The TrackPopupMenu function displays a floating pop-up menu at the - -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 - -returned instead of the normal exception. - - - """ - pass - - -class PyCOleClientItem(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateNewItem(self,) -> 'None': - """ - Creates an embedded item. - -Args: - - - -Returns: - - None - - """ - pass - - - def Close(self,) -> 'None': - """ - Closes the item - -Args: - - - -Returns: - - None - - """ - pass - - - def DoVerb(self,) -> 'None': - """ - Executes the specified verb. - -Args: - - - -Returns: - - None - - """ - pass - - - def Draw(self,) -> 'None': - """ - Draws the OLE item into the specified bounding rectangle using the specified device - -context. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetActiveView(self,) -> 'Any': - """ - Obtains the active view for the item - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetDocument(self,) -> 'Any': - """ - Obtains the current document for the item - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetInPlaceWindow(self,) -> 'Any': - """ - Obtains the window in which the item has been opened for - -in-place editing. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetItemState(self,) -> 'None': - """ - Obtains the OLE item's current state - -Args: - - - -Returns: - - None - - """ - pass - - - def GetObject(self,) -> 'Any': - """ - Returns the COM object to the item. This is the m_lpObject - -variable in MFC. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetStorage(self,) -> 'None': - """ - Returns the COM object used for storage - -Args: - - - -Returns: - - None - - """ - pass - - - def OnActivate(self,) -> 'None': - """ - Calls the underlying MFC method. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnChange(self,) -> 'None': - """ - Calls the underlying MFC method. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnChangeItemPosition(self,) -> 'Any': - """ - Calls the underlying MFC method. - -Args: - - - -Returns: - - Any:PyCOleClientItem.OnChangeItemPosition - -int = OnChangeItemPosition()Calls the underlying MFC method. -Return ValueThe result is a BOOL indicating if the function succeeded. No exception is thrown. - - - """ - pass - - - def OnDeactivateUI(self,) -> 'Any': - """ - Calls the underlying MFC method. - -Args: - - - -Returns: - - Any - - """ - pass - - - def Run(self,) -> 'None': - """ - Runs the application associated with this item. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetItemRects(self,) -> 'None': - """ - Sets the bounding rectangle or the visible rectangle of the OLE item. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCOleDialog(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCOleDocument(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def EnableCompoundFile(self,bEnable:'Any'=1) -> 'None': - """ - Call this function if you want to store the document using the - -compound-file format. - -Args: - - bEnable(Any):Specifies whether compound file support is enabled or disabled. - -Returns: - - None - - """ - pass - - - def GetStartPosition(self,) -> 'Any': - """ - Obtains the position of the first item in the document. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetNextItem(self,pos:'Any') -> 'Tuple[Any, Any]': - """ - Call this function repeatedly to access each of - -the items in your document. - -Args: - - pos(Any):The position to iterate from. - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def GetInPlaceActiveItem(self,wnd:'Any') -> 'Any': - """ - Obtains the OLE item that is currently activated - -in place in the frame window containing the view identified by obWnd. - -Args: - - wnd(Any):The window. - -Returns: - - Any - - """ - pass - - -class PyCOleInsertDialog(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetClassID(self,) -> 'Any': - """ - Returns the CLSID associated with the selected item - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetSelectionType(self,) -> 'Any': - """ - Returns the type of selection made - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetPathName(self,) -> 'Any': - """ - Returns the full path to the file selected in the dialog box - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyCPrintDialog(object): - """An object which encapsulates an MFC CPrintDialog object.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCPrintInfo(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def DocObject(self,) -> 'None': - """ - Return true if the document being printed is a DocObject. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDwFlags(self,) -> 'None': - """ - A flags specifying DocObject printing operations. Valid only if data member - -m_bDocObject is TRUE. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetDwFlags(self,) -> 'None': - """ - Set a flag specifying DocObject printing operations. Valid only if data member - -m_bDocObject is TRUE. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDocOffsetPage(self,) -> 'None': - """ - Get the number of pages preceding the first page of a particular DocObject - -in a combined DocObject print job. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetDocOffsetPage(self,) -> 'None': - """ - Set the number of pages preceding the first page of a particular DocObject - -in a combined DocObject print job. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetPrintDialog(self,) -> 'None': - """ - Set a pointer to the CPrintDialog object used to display the Print dialog box - -for the print job. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDirect(self,) -> 'None': - """ - TRUE if the Print dialog box will be bypassed for direct printing; FALSE otherwise. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetDirect(self,) -> 'None': - """ - Sets to TRUE if the Print dialog box will be bypassed for direct printing; FALSE - -otherwise. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPreview(self,) -> 'None': - """ - A flag indicating whether the document is being previewed. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetPreview(self,) -> 'None': - """ - Set whether the document is being previewed. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetContinuePrinting(self,) -> 'None': - """ - A flag indicating whether the framework should continue the print loop. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetContinuePrinting(self,) -> 'None': - """ - Set whether the framework should continue the print loop. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCurPage(self,) -> 'None': - """ - Get the number of the current page. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetCurPage(self,) -> 'None': - """ - Set the number of the current page. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetNumPreviewPages(self,) -> 'None': - """ - Get the number of pages displayed in preview mode. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetNumPreviewPages(self,) -> 'None': - """ - Set the number of pages displayed in preview mode. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetUserData(self,) -> 'None': - """ - Get a user-created structure. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetUserData(self,) -> 'None': - """ - Set a user-created structure. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDraw(self,) -> 'None': - """ - Get the usable drawing area of the page in logical coordinates. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetDraw(self,) -> 'None': - """ - Set the usable drawing area of the page in logical coordinates. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPageDesc(self,) -> 'None': - """ - Get the format string used to display the page numbers during print preview - -Args: - - - -Returns: - - None - - """ - pass - - - def SetPageDesc(self,) -> 'None': - """ - Set the format string used to display the page numbers during print preview - -Args: - - - -Returns: - - None - - """ - pass - - - def GetMinPage(self,) -> 'None': - """ - Get the number of the first page of the document. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetMinPage(self,) -> 'None': - """ - Set the number of the first page of the document. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetMaxPage(self,) -> 'None': - """ - Get the number of the last page of the document. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetMaxPage(self,) -> 'None': - """ - Set the number of the last page of the document. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetOffsetPage(self,) -> 'None': - """ - 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 - -pInfo->GetOffsetPage(), the link fails to find its definition. Allways returns 0. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetFromPage(self,) -> 'None': - """ - The number of the first page to be printed. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetToPage(self,) -> 'None': - """ - The number of the last page to be printed. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetHDC(self,hdc:'Any') -> 'None': - """ - Sets the printer DC compatible with the users choices, call after the print dialog - -DoModal finishes. - -Args: - - hdc(Any):The DC.MFC References - -Returns: - - None - - """ - pass - - - def CreatePrinterDC(self,) -> 'None': - """ - Handle to the newly created printer device context, call only after DoModal - -finishes. - -Args: - - - -Returns: - - None - - """ - pass - - - def DoModal(self,) -> 'None': - """ - Call DoModal on the dialog. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCopies(self,) -> 'None': - """ - The number of copies requested, call only after DoModal finishes. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDefaults(self,) -> 'None': - """ - 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 - -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 - -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) - -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. - -Args: - - - -Returns: - - None - - """ - pass - - - def FreeDefaults(self,) -> 'None': - """ - 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. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDeviceName(self,) -> 'None': - """ - The name of the currently selected printer, call only after DoModal finishes. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDriverName(self,) -> 'None': - """ - The name of the currently selected printer device driver, call only after - -DoModal finishes. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDlgFromPage(self,) -> 'None': - """ - Retrieves the starting page of the print range. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDlgToPage(self,) -> 'None': - """ - Retrieves the ending page of the print range. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPortName(self,) -> 'None': - """ - The name of the currently selected printer port, call only after DoModal - -finishes. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPrinterDC(self,) -> 'None': - """ - 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 - -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. - -Args: - - - -Returns: - - None - - """ - pass - - - def PrintAll(self,) -> 'None': - """ - Nonzero if all pages in the document are to be printed; otherwise 0, call only after - -DoModal finishes. - -Args: - - - -Returns: - - None - - """ - pass - - - def PrintCollate(self,) -> 'None': - """ - Nonzero if the user selects the collate check box in the dialog box; otherwise - -0, call only after DoModal finishes. - -Args: - - - -Returns: - - None - - """ - pass - - - def PrintRange(self,) -> 'None': - """ - Nonzero if only a range of pages in the document are to be printed; otherwise 0, - -call only after DoModal finishes. - -Args: - - - -Returns: - - None - - """ - pass - - - def PrintSelection(self,) -> 'None': - """ - Nonzero if only the selected items are to be printed; otherwise 0., call only - -after DoModal finishes - -Args: - - - -Returns: - - None - - """ - pass - - - def GetHDC(self,) -> 'None': - """ - 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 - -undefined. If both flags are specified, PD_RETURNDC has priority. - -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 - -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, - -PD_ENABLEPRINTTEMPLATEHANDLE, PD_ENABLESETUPHOOK, PD_ENABLESETUPTEMPLATE, PD_ENABLESETUPTEMPLATEHANDLE, - -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_USEDEVMODECOPIESANDCOLLATE. - -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 - -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, - -PD_ENABLEPRINTTEMPLATEHANDLE, PD_ENABLESETUPHOOK, PD_ENABLESETUPTEMPLATE, PD_ENABLESETUPTEMPLATEHANDLE, - -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_USEDEVMODECOPIESANDCOLLATE. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetFromPage(self,) -> 'None': - """ - The number of the first page to be printed. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetToPage(self,) -> 'None': - """ - The number of the last page to be printed. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPRINTDLGMinPage(self,) -> 'None': - """ - 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 - -disabled. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetPRINTDLGMinPage(self,) -> 'None': - """ - 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 - -disabled. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPRINTDLGCopies(self,) -> 'None': - """ - 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, - -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 - -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 - -information, see the description of the PD_USEDEVMODECOPIESANDCOLLATE flag. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetPRINTDLGCopies(self,) -> 'None': - """ - 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, - -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 - -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 - -information, see the description of the PD_USEDEVMODECOPIESANDCOLLATE flag. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCProgressCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,style:'Any',rect:'Tuple[Any, Any, Any, Any]',parent:'Any',_id:'Any') -> 'None': - """ - Creates the actual control. - -Args: - - style(Any):The style for the control. - rect(Tuple[Any, Any, Any, Any]):The size and position of the control. - parent(Any):The parent window of the control. Usually a PyCDialog. - _id(Any):The control's ID. - -Returns: - - None - - """ - pass - - - def SetRange(self,nLower:'Any'=1,nUpper:'Any'=1) -> 'None': - """ - Set the control's bounds - -Args: - - nLower(Any):Specifies the lower limit of the range (default is zero). - nUpper(Any):Specifies the upper limit of the range (default is 100). - -Returns: - - None - - """ - pass - - - def SetPos(self,nPos:'Any'=1) -> 'Any': - """ - Set the control's position - -Args: - - nPos(Any):New position of the progress bar control. - -Returns: - - Any - - """ - pass - - - def OffsetPos(self,nPos:'Any'=1) -> 'Any': - """ - Advances the progress bar control's current position by the increment - -specified - -Args: - - nPos(Any):Amount to advance the position. - -Returns: - - Any - - """ - pass - - - def SetStep(self,nStep:'Any'=1) -> 'Any': - """ - Specifies the step increment for a progress bar control. - -Args: - - nStep(Any):New step increment. - -Returns: - - Any - - """ - pass - - - def StepIt(self,) -> 'Any': - """ - Advances the current position for a progress bar control by the step increment. - -Returns previous position. - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyCPropertyPage(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CancelToClose(self,) -> 'None': - """ - Changes the Cancel button to Close. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnCancel(self,) -> 'None': - """ - Calls the default MFC OnCancel handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnOK(self,) -> 'None': - """ - Calls the default MFC OnOK handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnApply(self,) -> 'None': - """ - Calls the default MFC OnApply handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnReset(self,) -> 'None': - """ - Calls the default MFC OnReset handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnQueryCancel(self,) -> 'None': - """ - Calls the default MFC OnQueryCancel handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnWizardBack(self,) -> 'None': - """ - Calls the default MFC OnWizardBack handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnWizardNext(self,) -> 'None': - """ - Calls the default MFC OnWizardNext handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnWizardFinish(self,) -> 'None': - """ - Calls the default MFC OnWizardFinish handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnSetActive(self,) -> 'Any': - """ - Calls the default MFC OnSetActive handler. - -Args: - - - -Returns: - - Any:PyCPropertyPage.OnSetActive virtual method -Return ValueThe result is true if the page should be made active. - -Typically this result should be passed to the original OnSetActive handler. - - - """ - pass - - - def OnKillActive(self,) -> 'Any': - """ - Calls the default MFC OnKillActive handler. - -Args: - - - -Returns: - - Any:PyCPropertyPage.OnKillActive virtual method -Return ValueThe result is true if the page should be deselected. - -Typically this result should be passed to the original OnSetActive handler. - - - """ - pass - - - def SetModified(self,bChanged:'Any'=1) -> 'None': - """ - Sets the modified flag. - -Args: - - bChanged(Any):A flag to indicate the new modified state. - -Returns: - - None - - """ - pass - - - def SetPSPBit(self,bitMask:'Any',bitValue:'Any') -> 'None': - """ - Sets or clears a bit in m_psp.dwFlags - -Args: - - bitMask(Any):The PSP_* bit mask constant - bitValue(Any):1 to set, 0 to clear - -Returns: - - None - - """ - pass - - -class PyCPropertySheet(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddPage(self,page:'Any') -> 'None': - """ - Adds the supplied page with the rightmost tab in the property sheet. - -Args: - - page(Any):The page to be added.CommentsAdd pages to the property sheet in the left-to-right order you want them to appear.MFC References - -Returns: - - None - - """ - pass - - - def CreateWindow(self,style:'Any',exStyle:'Any',parent:'Any'=None) -> 'None': - """ - Displays the property sheet as a modeless dialog. - -Args: - - style(Any):The style for the window. - exStyle(Any):The extended style for the window. - parent(Any):The parent of the dialog. - -Returns: - - None - - """ - pass - - - def DoModal(self,) -> 'Any': - """ - Displays the property sheet as a modal dialog. - -Args: - - - -Returns: - - Any - - """ - pass - - - def EnableStackedTabs(self,stacked:'Any') -> 'Any': - """ - Enables or disables stacked tabs. - -Args: - - stacked(Any):A boolean flag - -Returns: - - Any - - """ - pass - - - def EndDialog(self,result:'Any') -> 'None': - """ - Closes the dialog, with the specified result. - -Args: - - result(Any):The result to be returned by DoModal. - -Returns: - - None - - """ - pass - - - def GetActiveIndex(self,) -> 'Any': - """ - Retrieves the index of the active page of the property sheet. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetActivePage(self,) -> 'Any': - """ - Returns the currently active property page. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetPage(self,pageNo:'Any') -> 'Any': - """ - Returns the specified property page. - -Args: - - pageNo(Any):The index of the page toretrieve.MFC References - -Returns: - - Any - - """ - pass - - - def GetPageIndex(self,page:'Any') -> 'Any': - """ - Retrieves the index of the specified page of the property sheet. - -Args: - - page(Any):The page. - -Returns: - - Any - - """ - pass - - - def GetPageCount(self,) -> 'Any': - """ - Returns the number of pages. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetTabCtrl(self,) -> 'Any': - """ - Returns the tab control used by the sheet. - -Args: - - - -Returns: - - Any - - """ - pass - - - def OnInitDialog(self,) -> 'Any': - """ - Calls the default MFC OnInitDialog handler. - -Args: - - - -Returns: - - Any - - """ - pass - - - def PressButton(self,button:'Any') -> 'None': - """ - Simulates the choice of the specified button in a property sheet. - -Args: - - button(Any):The button to press - -Returns: - - None - - """ - pass - - - def RemovePage(self,offset:'Any',page:'Any') -> 'None': - """ - Removes the specified page from the sheet. - -Args: - - offset(Any):The page number to removeAlternative Parameters - page(Any):The page to remove - -Returns: - - None - - """ - pass - - - def SetActivePage(self,page:'Any') -> 'None': - """ - Programmatically sets the active page object. - -Args: - - page(Any):The page. - -Returns: - - None - - """ - pass - - - def SetTitle(self,title:'str') -> 'None': - """ - Sets the caption for the property sheet. - -Args: - - title(str):The new caption - -Returns: - - None - - """ - pass - - - def SetFinishText(self,text:'str') -> 'None': - """ - Sets the text for the Finish button - -Args: - - text(str):The next for the button - -Returns: - - None - - """ - pass - - - def SetWizardMode(self,) -> 'None': - """ - Enables the wizard mode - -Args: - - - -Returns: - - None - - """ - pass - - - def SetWizardButtons(self,flags:'Any') -> 'None': - """ - Enables the wizard buttons - -Args: - - flags(Any):The wizard flags - -Returns: - - None - - """ - pass - - - def SetPSHBit(self,bitMask:'Any',bitValue:'Any') -> 'None': - """ - Sets or clears a bit in m_psh.dwFlags - -Args: - - bitMask(Any):The PSH_* bit mask constant - bitValue(Any):1 to set, 0 to clear - -Returns: - - None - - """ - pass - - -class PyCRect(object): - """A Python interface the the MFC CRect class.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCRgn(object): - """An object encapsulating an MFC PyCRgn class.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCRichEditCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Clear(self,) -> 'Any': - """ - Clears all text in an edit control. - -Args: - - - -Returns: - - Any - - """ - pass - - - def Copy(self,) -> 'None': - """ - Copys the current selection to the clipboard. - -Args: - - - -Returns: - - None - - """ - pass - - - def CreateWindow(self,style:'Any',rect:'Tuple[Any, Any, Any, Any]',parent:'Any',_id:'Any') -> 'None': - """ - Creates a rich edit control window. - -Args: - - style(Any):The control style - rect(Tuple[Any, Any, Any, Any]):The position of the control - parent(Any):The parent window. Must not be None - _id(Any):The control ID - -Returns: - - None - - """ - pass - - - def Cut(self,) -> 'None': - """ - Cuts the current selection to the clipboard. - -Args: - - - -Returns: - - None - - """ - pass - - - def FindText(self,charPos:'Any') -> 'Tuple[Any, Any, Any]': - """ - Finds text in the control - -Args: - - charPos(Any):The character position - -Returns: - - Tuple[Any, Any, Any] - - """ - pass - - - def GetCharPos(self,charPos:'Any') -> 'Any': - """ - Returns the location of the top-left corner of the character specified - -by charPos. - -Args: - - charPos(Any):The character positionReturn ValueThe return value is a win32ui::CHARFORMAT tuple - -Returns: - - Any:The character positionReturn ValueThe return value is a win32ui::CHARFORMAT tuple - - - - """ - pass - - - def GetDefaultCharFormat(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any:CRichEditCtrl::GetDefaultCharFormat -Return ValueThe return value is a win32ui::CHARFORMAT tuple - - - - """ - pass - - - def GetEventMask(self,) -> 'Any': - """ - Returns the current event mask. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetSelectionCharFormat(self,) -> 'Any': - """ - Returns the character formatting of the selection. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetFirstVisibleLine(self,) -> 'Any': - """ - Returns zero-based index of the topmost visible line. - -Args: - - - -Returns: - - Any:CRichEditCtrl::GetFirstVisibleLine -Return ValueThe zero-based index of the topmost visible line. For single-line edit controls, the return value is 0. - - - """ - pass - - - def GetParaFormat(self,) -> 'Any': - """ - Returns the current paragraph formatting attributes. - -Args: - - - -Returns: - - Any:CRichEditCtrl::GetParaFormat -Return ValueThe return value is a win32ui::PARAFORMAT tuple - - - - """ - pass - - - def GetSel(self,) -> 'Tuple[Any, Any]': - """ - Returns the start and end of the current selection. - -Args: - - - -Returns: - - Tuple[Any, Any]:CRichEditCtrl::GetSel -Return ValueThe return tuple is (the first character in the current selection, first nonselected character past the - -end of the current selection) - - - """ - pass - - - def GetSelText(self,) -> 'str': - """ - Returns the currently selected text - -Args: - - - -Returns: - - str - - """ - pass - - - def GetTextLength(self,) -> 'Any': - """ - Returns the length of the text in the control. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetLine(self,lineNo:'Any') -> 'Any': - """ - Returns the text in a specified line. - -Args: - - lineNo(Any):Contains the zero-based index value for the desired line.CommentsThis function is not an MFC wrapper. - -Returns: - - Any - - """ - pass - - - def GetModify(self,) -> 'Any': - """ - Nonzero if the text in this control has been modified; otherwise 0. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetLineCount(self,) -> 'Any': - """ - Gets the number of lines in an edit control. - -Args: - - - -Returns: - - Any:CRichEditCtrl::GetLineCount -Return ValueThe number of lines in the buffer. If the control is empty, the return value is 1. - - - """ - pass - - - def LimitText(self,nChars:'Any'=0) -> 'None': - """ - Sets max length of text that user can enter - -Args: - - nChars(Any):Specifies the length (in bytes) of the text that the user can enter. If this parameter is 0, the text length is set to UINT_MAX bytes. This is the default behavior.MFC References - -Returns: - - None - - """ - pass - - - def LineFromChar(self,charNo:'Any'=-1) -> 'Any': - """ - Returns the line number of the specified character. - -Args: - - charNo(Any):Contains the zero-based index value for the desired character in the text of the edit control, or -1. If -1, then it specifies the current line.MFC References - -Returns: - - Any:CRichEditCtrl::LineFromChar -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 there is no selection, the current line number is returned. - - - """ - pass - - - def LineIndex(self,lineNo:'Any'=-1) -> 'Any': - """ - Retrieves the character index of a line within a multiple-line edit control. - -Args: - - lineNo(Any):Contains the index value for the desired line in the text of the edit control, or contains -1. If -1, then it specifies the current line.CommentsThis method only works on multi-linr edit controls.MFC References - -Returns: - - Any:CRichEditCtrl::LineIndex -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 edit control. - - - """ - pass - - - def LineScroll(self,nLines:'Any',nChars:'Any'=0) -> 'Any': - """ - Scroll the control vertically and horizontally - -Args: - - nLines(Any):Specifies the number of lines to scroll vertically. - nChars(Any):Specifies the number of character positions to scroll horizontally. This value is ignored if the edit control has either the ES_RIGHT or ES_CENTER style.CommentsThis method only works on multi-linr edit controls.MFC References - -Returns: - - Any - - """ - pass - - - def Paste(self,) -> 'None': - """ - Pastes the contents of the clipboard into the control. - -Args: - - - -Returns: - - None - - """ - pass - - - def ReplaceSel(self,text:'str') -> 'None': - """ - Replaces the selection with the specified text. - -Args: - - text(str):The text to replace the selection with.MFC References - -Returns: - - None - - """ - pass - - - def SetBackgroundColor(self,bSysColor:'Any',cr:'Any'=0) -> 'Any': - """ - Sets the background color for the control. - -Args: - - bSysColor(Any):Indicates if the background color should be set to the system value. If this value is TRUE, cr is ignored. - cr(Any):The requested background color. Used only if bSysColor is FALSE.MFC References - -Returns: - - Any:CRichEditCtrl::SetEventMask -Return ValueThe return value is the previous background color. - - - """ - pass - - - def SetDefaultCharFormat(self,charFormat:'Any') -> 'None': - """ - None - -Args: - - charFormat(Any):A charformat tuple. See win32ui::CHARFORMAT tuple for details.MFC References - -Returns: - - None - - """ - pass - - - def SetEventMask(self,eventMask:'Any') -> 'Any': - """ - Sets the event motification mask. - -Args: - - eventMask(Any):The new event mask. Must be one of the win32con.ENM_* flags.MFC References - -Returns: - - Any:CRichEditCtrl::SetEventMask -Return ValueThe return value is the previous event mask. - - - """ - pass - - - def SetSelectionCharFormat(self,charFormat:'Any') -> 'None': - """ - Sets the current selections character formatting attributes. - -Args: - - charFormat(Any):A charformat tuple. See win32ui::CHARFORMAT tuple for details.MFC References - -Returns: - - None - - """ - pass - - - def SetModify(self,modified:'Any'=1) -> 'None': - """ - Sets the modified flag for this control - -Args: - - modified(Any):Indicates the new value for the modified flag.MFC References - -Returns: - - None - - """ - pass - - - def SetOptions(self,op:'Any',flags:'Any') -> 'None': - """ - Sets options for the control. - -Args: - - op(Any):Indicates the operation. Must be one of the win32con.ECOOP_* flags. - flags(Any):Indicates the options. Must be one a combination of win32con.ECO_* flags.MFC References - -Returns: - - None - - """ - pass - - - def SetParaFormat(self,paraFormat:'Any') -> 'Any': - """ - Sets the paragraph formatting - -Args: - - paraFormat(Any):A charformat tuple. See win32ui::PARAFORMAT tuple for details.MFC References - -Returns: - - Any:CRichEditCtrl::SetParaFormat -Return ValueThis function seems to return occasionally return failure, but - -the formatting is applied. Therefore an exception is not raised on failure, - -but the BOOL return code is passed back. - - - """ - pass - - - def SetReadOnly(self,bReadOnly:'Any'=1) -> 'None': - """ - Sets or clears the read-only status of the listbox. - -Args: - - bReadOnly(Any):The read-only state to set.MFC References - -Returns: - - None - - """ - pass - - - def SetSel(self,start:'Any',end:'Any',arg:'Any') -> 'None': - """ - Sets the selection in the edit control. - -Args: - - start(Any):Specifies the starting position. If start is 0 and end is -1, all the text in the edit control is selected. If start is -1, any current selection is removed. - end(Any):Specifies the ending position.Alternative Parameters - arg(Any):As for normal start, end args.MFC References - -Returns: - - None - - """ - pass - - - def SetSelAndCharFormat(self,charFormat:'Any') -> 'None': - """ - Sets the selection and char format. - -Args: - - charFormat(Any):A charformat tuple. See win32ui::CHARFORMAT tuple for details.CommentsHighly optimised for speed for color editors.MFC References - -Returns: - - None - - """ - pass - - - def SetTargetDevice(self,dc:'Any',lineWidth:'Any') -> 'None': - """ - Sets the target device for the control - -Args: - - dc(Any):The new DC - may be None - lineWidth(Any):Line width to use for formatting.MFC References - -Returns: - - None - - """ - pass - - - def StreamIn(self,_format:'Any',method:'Any') -> 'Tuple[Any, Any]': - """ - Invokes a callback to stream data into the control. - -Args: - - _format(Any):The format. One of the win32con.SF_* flags (SF_TEXT,SF_RTF) - method(Any):A callable object (eg, a method or function) This method is called with a single integer param, which is the maximum number of bytes to fetch. The method should return a zero length string, or None to finish the operation, and a string otherwise.MFC References - -Returns: - - Tuple[Any, Any]:CRichEditCtrl::StreamIn -Return ValueThe return value is a tuple of (no bytes written, error code) - - - """ - pass - - - def StreamOut(self,_format:'Any',method:'Any') -> 'Tuple[Any, Any]': - """ - Invokes a callback to stream data into the control. - -Args: - - _format(Any):The format. One of the win32con.SF_* flags (SF_TEXT,SF_RTF) and may also combine SFF_SELECTION. - method(Any):A callable object (eg, a method or function) This method is called with a string parameter. It should return an integer, zero to abort, non zero otherwise.MFC References - -Returns: - - Tuple[Any, Any]:CRichEditCtrl::StreamOut -Return ValueThe return value is a tuple of (no bytes written, error code) - - - """ - pass - - -class PyCRichEditDoc(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OnCloseDocument(self,) -> 'None': - """ - Call the MFC OnCloseDocument handler. - -This routine is provided so a document object which overrides this method - -can call the original MFC version if required. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCRichEditDocTemplate(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def DoCreateRichEditDoc(self,fileName:'str'=None) -> 'Any': - """ - Creates an underlying document object. - -Args: - - fileName(str):The name of the file to load. - -Returns: - - Any - - """ - pass - - -class PyCRichEditView(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetRichEditCtrl(self,) -> 'Any': - """ - Returns the underlying rich edit control object. - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetWordWrap(self,wordWrap:'Any') -> 'Any': - """ - Sets the wordwrap state for the control. - -Args: - - wordWrap(Any):The new word-wrap state.MFC References - -Returns: - - Any - - """ - pass - - - def WrapChanged(self,) -> 'Any': - """ - Calls the underlying WrapChanged method. - -Args: - - - -Returns: - - Any - - """ - pass - - - def SaveTextFile(self,FileName:'Any') -> 'Any': - """ - Saves the contents of the control as a test file - -Args: - - FileName(Any):Name of file to saveCommentsTheere is no equivilent MFC method. This is implemented in this module for performance reasons. - -Returns: - - Any - - """ - pass - - -class PyCScrollView(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDeviceScrollPosition(self,) -> 'Tuple[Any, Any]': - """ - Returns the positon of the scroll bars in device units. - -Args: - - - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def GetDC(self,) -> 'Any': - """ - Gets the view's current DC. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetScrollPosition(self,) -> 'Tuple[Any, Any]': - """ - Returns the current position of the scroll bars (in logical units). - -Args: - - - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def GetTotalSize(self,) -> 'Tuple[Any, Any]': - """ - Returns the total size of the view in logical units. - -Args: - - - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def OnCommand(self,wparam:'Any',lparam:'Any') -> 'None': - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(Any): - lparam(Any):See Also - -Returns: - - None - - """ - pass - - - def ResizeParentToFit(self,bShrinkOnly:'Any'=1) -> 'Any': - """ - Lets the size of a view dictate the size of its frame window. - -Args: - - bShrinkOnly(Any):The kind of resizing to perform. The default value, TRUE, shrinks the frame window if appropriate.CommentsThis is recommended only for views in MDI child frame windows. Use ResizeParentToFit in the OnInitialUpdate handler function of your View class. You must ensure the parent's PyCFrameWnd::RecalcLayout is called before using this method. - -Returns: - - Any - - """ - pass - - - def SetScaleToFitSize(self,size:'Tuple[Any, Any]') -> 'None': - """ - Scales the viewport size to the current window size automatically. - -Args: - - size(Tuple[Any, Any]):The horizontal and vertical sizes to which the view is to be scaled. The scroll view's size is measured in logical units. - -Returns: - - None - - """ - pass - - - def ScrollToPosition(self,position:'Tuple[Any, Any]') -> 'None': - """ - Scrolls to a given point in the view. - -Args: - - position(Tuple[Any, Any]):The position to scroll to. - -Returns: - - None - - """ - pass - - - def SetScrollSizes(self,mapMode:'Any',sizeTotal:'Tuple[Any, Any]',arg:'Tuple[Any, Any]',arg1:'Tuple[Any, Any]') -> 'None': - """ - Sets the sizes of the scroll bars - -Args: - - mapMode(Any):The mapping mode for this view. - sizeTotal(Tuple[Any, Any]):The total size of the view. Sizes are in logical units. Both x and y must be greater than zero. - arg(Tuple[Any, Any]):The number of untils to scroll in response to a page-down command. - arg1(Tuple[Any, Any]):The number of untils to scroll in response to a line-down command. - -Returns: - - None - - """ - pass - - - def UpdateBars(self,) -> 'None': - """ - Update the scroll bars state - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCSliderCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,style:'Any',rect:'Tuple[Any, Any, Any, Any]',parent:'Any',_id:'Any') -> 'None': - """ - Creates the actual control. - -Args: - - style(Any):The style for the control. - rect(Tuple[Any, Any, Any, Any]):The size and position of the control. - parent(Any):The parent window of the control. Usually a PyCDialog. - _id(Any):The control's ID. - -Returns: - - None - - """ - pass - - - def GetLineSize(self,) -> 'Any': - """ - Get the control's position - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetLineSize(self,nLineSize:'Any'=1) -> 'Any': - """ - Set the control's line size. Returns the previous line size. - -Args: - - nLineSize(Any):New line size of the Slider bar control - -Returns: - - Any - - """ - pass - - - def GetPageSize(self,) -> 'Any': - """ - Get the control's position - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetPageSize(self,nPageSize:'Any'=1) -> 'Any': - """ - Set the control's page size Returns the previous page size. - -Args: - - nPageSize(Any):New page size of the Slider bar control. - -Returns: - - Any - - """ - pass - - - def GetRangeMax(self,) -> 'Any': - """ - Get the control's Maximum - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetRangeMin(self,) -> 'Any': - """ - Get the control's Minimum - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetRange(self,) -> 'Any': - """ - Get the control's min and max - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetRange(self,nRangeMin:'Any'=1,nRangeMax:'Any'=1,bRedraw:'Any'=1) -> 'Any': - """ - Set the control's min and max - -Args: - - nRangeMin(Any):New minimum of the Slider bar control. - nRangeMax(Any):New maximum of the Slider bar control. - bRedraw(Any):Should slider be redrawn? - -Returns: - - Any - - """ - pass - - - def GetSelection(self,) -> 'Any': - """ - Get the control's selection start and end positions - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetSelection(self,nRangeMin:'Any'=1,nRangeMax:'Any'=1) -> 'Any': - """ - Set the control's selection start and end positions - -Args: - - nRangeMin(Any):New start of the Slider's selection. - nRangeMax(Any):New end of the Slider's selection. - -Returns: - - Any - - """ - pass - - - def GetChannelRect(self,) -> 'Any': - """ - Get the control's channel rectangle - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetThumbRect(self,) -> 'Any': - """ - Get the control's thumb rectangle - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetPos(self,) -> 'Any': - """ - Get the control's position - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetPos(self,nPos:'Any'=1) -> 'Any': - """ - Set the control's position - -Args: - - nPos(Any):New position of the Slider bar control. - -Returns: - - Any - - """ - pass - - - def GetNumTics(self,) -> 'Any': - """ - Get number of tics in the slider - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetTicArray(self,) -> 'Any': - """ - Get a tuple of slider tic positions - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetTic(self,nTic:'Any'=1) -> 'Any': - """ - Get the position of the specified tic number - -Args: - - nTic(Any):Zero based index of the tic mark - -Returns: - - Any - - """ - pass - - - def GetTicPos(self,nTic:'Any'=1) -> 'Any': - """ - Get the position of the specified tic number in client coordinates - -Args: - - nTic(Any):Zero based index of the tic mark - -Returns: - - Any - - """ - pass - - - def SetTic(self,nTic:'Any'=1) -> 'Any': - """ - Set a tic at the specified position - -Args: - - nTic(Any):Position of the desired tic mark - -Returns: - - Any - - """ - pass - - - def SetTicFreq(self,nFreq:'Any'=1) -> 'Any': - """ - Set the tic frequency - -Args: - - nFreq(Any):Frequency of tic marks - -Returns: - - Any - - """ - pass - - - def ClearSel(self,bRedraw:'Any'=1) -> 'Any': - """ - Clear the selection - -Args: - - bRedraw(Any):Redraw the control? - -Returns: - - Any - - """ - pass - - - def VerifyPos(self,) -> 'Any': - """ - Verify the position is between configured min and max - -Args: - - - -Returns: - - Any - - """ - pass - - - def ClearTics(self,bRedraw:'Any'=1) -> 'Any': - """ - Clear the control's tic marks - -Args: - - bRedraw(Any):Redraw the control? - -Returns: - - Any - - """ - pass - - -class PyCSpinButtonCtrl(object): - """A windows spin button control. Encapsulates an MFC CSpinButtonCtrl object.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPos(self,) -> 'Any': - """ - Obtains the current position for a spin button control. - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetPos(self,pos:'Any') -> 'Any': - """ - Sets the current position for a spin button control. - -Args: - - pos(Any):The new position.Return ValueThe result is the previous position. - -Returns: - - Any:The new position.Return ValueThe result is the previous position. - - - """ - pass - - - def SetRange(self,) -> 'Any': - """ - Sets the upper and lower limits (range) for a spin button control. - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetRange32(self,) -> 'Any': - """ - Sets the 32 bit upper and lower limits (range) for a spin button control. - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyCSplitterWnd(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPane(self,row:'Any',col:'Any') -> 'Any': - """ - None - -Args: - - row(Any):The row in the splitter. - col(Any):The column in the splitter.CommentsTheoretically the return value can be a PyCWnd object, but currently it will always be a PyCView or derived object. - -Returns: - - Any - - """ - pass - - - def CreateView(self,view:'Any',row:'Any',col:'Any',arg:'Tuple[Any, Any]') -> 'None': - """ - Creates a view in a splitter window - -Args: - - view(Any):The view to place in the splitter pane. - row(Any):The row in the splitter to place the view. - col(Any):The column in the splitter to place the view. - arg(Tuple[Any, Any]):The initial size of the new view.MFC References - -Returns: - - None - - """ - pass - - - def CreateStatic(self,parent:'Any',rows:'Any',cols:'Any',style:'Any',_id:'Any') -> 'None': - """ - Creates a static splitter window. - -Args: - - parent(Any):The parent window. - rows(Any):The number of rows in the splitter. - cols(Any):The number of columns in the splitter. - style(Any):Specifies the window style - _id(Any):The child window ID of the window. The ID can be AFX_IDW_PANE_FIRST unless the splitter window is nested inside another splitter window.CommentsA static splitter window is a splitter where the number of panes are fixed at window creation time. Currently this is the only splitter window supported by win32ui.MFC References - -Returns: - - None - - """ - pass - - - def SetColumnInfo(self,column:'Any',ideal:'Any',_min:'Any') -> 'None': - """ - Sets a new minimum height and ideal height for a column - -Args: - - column(Any):The column in the splitter. - ideal(Any):Specifies an ideal height for the splitter window column in pixels. - _min(Any):Specifies a minimum height for the splitter window column in pixels. - -Returns: - - None - - """ - pass - - - def SetRowInfo(self,row:'Any',ideal:'Any',_min:'Any') -> 'None': - """ - Sets a new minimum height and ideal height for a row. - -Args: - - row(Any):The row in the splitter. - ideal(Any):Specifies an ideal height for the splitter window row in pixels. - _min(Any):Specifies a minimum height for the splitter window row in pixels. - -Returns: - - None - - """ - pass - - - def IdFromRowCol(self,row:'Any',col:'Any') -> 'None': - """ - Gets the child window ID for the specified child. - -Args: - - row(Any):The row in the splitter. - col(Any):The col in the splitter - -Returns: - - None - - """ - pass - - - def DoKeyboardSplit(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyCStatusBar(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPaneInfo(self,index:'Any') -> 'Tuple[Any, Any, Any]': - """ - Returns the id, style, and width of the indicator pane at the - -location specified by index. - -Args: - - index(Any):Index of the pane whose information is to be retrieved.MFC References - -Returns: - - Tuple[Any, Any, Any] - - """ - pass - - - def GetStatusBarCtrl(self,) -> 'Any': - """ - Gets the statusbar control object for the statusbar. - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetIndicators(self,indicators:'Any') -> 'None': - """ - Sets each indicator's ID. - -Args: - - indicators(Any):A tuple containing the ID's of the indicators. - -Returns: - - None - - """ - pass - - - def SetPaneInfo(self,index:'Any',_id:'Any',style:'Any',width:'Any') -> 'None': - """ - Sets the specified indicator pane to a new ID, style, and width. - -Args: - - index(Any):Index of the indicator pane whose style is to be set. - _id(Any):New ID for the indicator pane. - style(Any):New style for the indicator pane.The following indicator styles are supported:afxres.SBPS_NOBORDERS - No 3-D border around the pane.afxres.SBPS_POPOUT - Reverse border so that text "pops out."afxres.SBPS_DISABLED - Do not draw text.afxres.SBPS_STRETCH - Stretch pane to fill unused space. Only one pane per status bar can have this style.afxres.SBPS_NORMAL - No stretch, borders, or pop-out. - width(Any):New width for the indicator pane.MFC References - -Returns: - - None - - """ - pass - - -class PyCStatusBarCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,style:'Any',rect:'Tuple[Any, Any, Any, Any]',parent:'Any',_id:'Any') -> 'None': - """ - Creates the actual control. - -Args: - - style(Any):The style for the control. - rect(Tuple[Any, Any, Any, Any]):The size and position of the control. - parent(Any):The parent window of the control. Usually a PyCDialog. - _id(Any):The control's ID. - -Returns: - - None - - """ - pass - - - def GetBorders(self,) -> 'Tuple[Any, Any, Any]': - """ - Retrieve the status bar control's current widths of - -the horizontal and vertical borders and of the space between rectangles. - -Args: - - - -Returns: - - Tuple[Any, Any, Any] - - """ - pass - - - def GetParts(self,nParts:'Any') -> 'Any': - """ - Retrieve coordinates of the parts in a status bar control. - -Args: - - nParts(Any):The number of coordinates to retrieveCommentsThis function, as designed in MFC, returns both the *number* of parts, and, through an OUT parameter, an array of ints giving the coordinates of the parts. There is also an IN parameter saying how many coordinates to give back. Here, we're explicitly changing the semantics a bit.GetParts() -> Tuple of all coordinates GetParts(n) -> Tuple of the first n coordinates (or all coordinates, if fewer than n)So, in Python, you can't simultaneously find out how many coordinates there are, and retrieve a subset of them. In a reasonable universe, there would have been GetParts() -> int, and GetCoords() -> List. This means that I need to call the MFC method twice; once to find out how many there are, and another time to get them. - -Returns: - - Any - - """ - pass - - - def GetRect(self,nPane:'Any') -> 'Tuple[Any, Any, Any, Any]': - """ - Retrieves the bounding rectangle of a part in a status - -bar control. - -Args: - - nPane(Any):Zero-based index of the part whose bounding rectangle is to be retrieved. - -Returns: - - Tuple[Any, Any, Any, Any] - - """ - pass - - - def GetText(self,nPane:'Any') -> 'Any': - """ - Retrieve the text from the given part of a status bar control. - -Args: - - nPane(Any):Zero-based index of the part whose text is to be retrieved. - -Returns: - - Any - - """ - pass - - - def GetTextAttr(self,nPane:'Any') -> 'Any': - """ - Retrieve the attributes of the text in the given part of a status bar - -control. - -Args: - - nPane(Any):Zero-based index of the part whose text is to be retrieved. - -Returns: - - Any - - """ - pass - - - def GetTextLength(self,nPane:'Any') -> 'Any': - """ - Retrieve the length the text in the given part of a status bar control. - -Args: - - nPane(Any):Zero-based index of the part whose text is to be retrieved. - -Returns: - - Any - - """ - pass - - - def SetMinHeight(self,nHeight:'Any') -> 'None': - """ - Set the minimum height of a status bar control's drawing area. - -Args: - - nHeight(Any):Minimum height - -Returns: - - None - - """ - pass - - - def SetParts(self,coord:'Any') -> 'None': - """ - Sets the number of parts in a status bar control and the coordinate of the right - -edge of each part. - -Args: - - coord(Any):Coordinates of each part - -Returns: - - None - - """ - pass - - - def SetText(self,text:'str',nPane:'Any',nType:'Any') -> 'None': - """ - Set the text in the given part of a status bar control. - -Args: - - text(str):The text to display - nPane(Any):Zero-based index of the part to set. - nType(Any):Type of drawing operation.CommentsThe drawing type can be set to one of:~ 0 - The text is drawn with a border to appear lower than the plane of the status bar.~ win32con.SBT_NOBORDERS - The text is drawn without borders.~ win32con.SBT_OWNERDRAW - The text is drawn by the parent window.~ win32con.SBT_POPOUT - The text is drawn with a border to appear higher than the plane of the status bar. - -Returns: - - None - - """ - pass - - - def SetTipText(self,nPane:'Any',text:'str') -> 'None': - """ - 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. - -Args: - - nPane(Any):The zero-based index of status bar pane to receive the tooltip text. - text(str):The string containing the tooltip text.CommentsPay attention, this tooltip text is ONLY displayed in two situations: 1. When the corresponding pane in the status bar contains only an icon. 2. When the corresponding pane in the status bar contains text that is truncated due to the size of the pane. To make the tooltip appear even if the text is not truncated, you could add additional spaces to the end of the pane text.MFC References - -Returns: - - None - - """ - pass - - -class PyCTabCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetCurSel(self,) -> 'Any': - """ - Gets the current selection of a tab control. - -Args: - - - -Returns: - - Any:PyCTabCtrl.GetCurSel - -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 - - - def GetItemCountl(self,) -> 'Any': - """ - Returns the number of tabs in the control. - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetCurSel(self,index:'Any') -> 'Any': - """ - Sets the current selection of a tab control. - -Args: - - index(Any):The index of the tab to set current.Return ValueThe zero-based index of the previously selected item. - -Returns: - - Any:The index of the tab to set current.Return ValueThe zero-based index of the previously selected item. - - - """ - pass - - -class PyCToolBar(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetButtonStyle(self,index:'Any') -> 'None': - """ - Retrieves the style for a button. - -Args: - - index(Any):Index of the item whose style is to be retrieved. - -Returns: - - None - - """ - pass - - - def GetButtonText(self,index:'Any') -> 'str': - """ - Gets the text for a button. - -Args: - - index(Any):Index of the item whose text is to be retrieved. - -Returns: - - str - - """ - pass - - - def GetItemID(self,index:'Any') -> 'None': - """ - Returns the command ID of a button or separator at the given index. - -Args: - - index(Any):Index of the item whose ID is to be retrieved. - -Returns: - - None - - """ - pass - - - def SetButtonInfo(self,index:'Any',ID:'Any',style:'Any',imageIx:'Any') -> 'None': - """ - Sets the button's command ID, style, and image number. - -Args: - - index(Any):Index of the button or separator whose information is to be set. - ID(Any):The value to which the button's command ID is set. - style(Any):The new button style - imageIx(Any):New index for the button's image within the bitmap - -Returns: - - None - - """ - pass - - - def GetToolBarCtrl(self,) -> 'Any': - """ - Gets the toolbar control object for the toolbar - -Args: - - - -Returns: - - Any - - """ - pass - - - def LoadBitmap(self,_id:'PyResourceId') -> 'None': - """ - Loads the bitmap containing bitmap-button images. - -Args: - - _id(PyResourceId):Name or id of the resource that contains the bitmap.CommentsThe bitmap should contain one image for each toolbar button. If the images are not of the standard size (16 pixels wide and 15 pixels high), call PyCToolBar::SetSizes to set the button sizes and their images. - -Returns: - - None - - """ - pass - - - def LoadToolBar(self,_id:'PyResourceId') -> 'None': - """ - Loads a toolbar from a toolbar resource. - -Args: - - _id(PyResourceId):Name or resource id of the resourceCommentsThe bitmap should contain one image for each toolbar button. If the images are not of the standard size (16 pixels wide and 15 pixels high), call PyCToolBar::SetSizes to set the button sizes and their images. - -Returns: - - None - - """ - pass - - - def SetBarStyle(self,style:'Any') -> 'None': - """ - Sets the toolbar part of style - -Args: - - style(Any):The toolbar style to set. - -Returns: - - None - - """ - pass - - - def SetBitmap(self,hBitmap:'Any') -> 'None': - """ - Sets a bitmapped image. - -Args: - - hBitmap(Any):The handle to a bitmap resource.CommentsCall this method to set the bitmap image for the toolbar. For example, call SetBitmap to change the bitmapped image after the user takes an action on a document that changes the action of a button. - -Returns: - - None - - """ - pass - - - def SetButtons(self,buttons:'Any',numButtons:'Any') -> 'None': - """ - Sets button styles and an index of button images within the bitmap. - -Args: - - buttons(Any):A tuple containing the ID's of the buttons.Alternative Parameters - numButtons(Any):The number of buttons to pre-allocate. If this option is used, then PyCToolBar::PySetButtonInfo must be used. - -Returns: - - None - - """ - pass - - - def SetButtonStyle(self,index:'Any',style:'Any') -> 'None': - """ - Sets the style for a button. - -Args: - - index(Any):Index of the item whose style is to be set - style(Any):The new style - -Returns: - - None - - """ - pass - - - def SetHeight(self,height:'Any') -> 'None': - """ - Sets the height of the toolbar. - -Args: - - height(Any):The height in pixels of the toolbar. - -Returns: - - None - - """ - pass - - - def SetSizes(self,sizeButton:'Tuple[Any, Any]',sizeButton1:'Tuple[Any, Any]') -> 'None': - """ - Sets the size of each button. - -Args: - - sizeButton(Tuple[Any, Any]):The size of each button. - sizeButton1(Tuple[Any, Any]):The size of each bitmap. - -Returns: - - None - - """ - pass - - -class PyCToolBarCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddBitmap(self,numButtons:'Any',bitmap:'Any') -> 'Any': - """ - Add one or more button images to the list of button images - -Args: - - numButtons(Any):Number of button images in the bitmap. - bitmap(Any):Bitmap containing button or buttons to be addedMFC References - -Returns: - - Any - - """ - pass - - - def AddButtons(self,) -> 'Any': - """ - Add one or more buttons to the toolbar - -Args: - - - -Returns: - - Any - - """ - pass - - - def AddStrings(self,strings:'Any') -> 'Any': - """ - Add one or more strings to the toolbar - -Args: - - strings(Any):Strings to add. Can give more than one string. - -Returns: - - Any - - """ - pass - - - def AutoSize(self,) -> 'None': - """ - Resize the entire toolbar control - -Args: - - - -Returns: - - None - - """ - pass - - - def CheckButton(self,nID:'Any',bCheck:'Any'=1) -> 'Any': - """ - Check or clear a given button in a toolbar control - -Args: - - nID(Any):Command identifier of the button to check or clear. - bCheck(Any):1 to check, 0 to clear the buttonMFC References - -Returns: - - Any - - """ - pass - - - def CommandToIndex(self,nID:'Any') -> 'Any': - """ - Retrieve the zero-based index for the button associated with the - -specified command identifier. - -Args: - - nID(Any):Command identifier of the button you want to find.MFC References - -Returns: - - Any - - """ - pass - - - def CreateWindow(self,style:'Any',rect:'Tuple[Any, Any, Any, Any]',parent:'Any',_id:'Any') -> 'None': - """ - Creates the window for a new toolbar object - -Args: - - style(Any):The style for the button. Use any of the win32con.BS_* constants. - rect(Tuple[Any, Any, Any, Any]):The size and position of the button. - parent(Any):The parent window of the button. Usually a PyCDialog. - _id(Any):The buttons control ID.MFC References - -Returns: - - None - - """ - pass - - - def Customize(self,) -> 'None': - """ - Display the Customize Toolbar dialog box. - -Args: - - - -Returns: - - None - - """ - pass - - - def DeleteButton(self,nID:'Any') -> 'None': - """ - Delete a button from the toolbar control. - -Args: - - nID(Any):ID of the button to delete.MFC References - -Returns: - - None - - """ - pass - - - def EnableButton(self,nID:'Any',bEnable:'Any'=1) -> 'None': - """ - Enable or disable a toolbar control button. - -Args: - - nID(Any):ID of the button to enable or disable. - bEnable(Any):1 to enable, 0 to disableMFC References - -Returns: - - None - - """ - pass - - - def GetBitmapFlags(self,) -> 'Any': - """ - retrieve the bitmap flags from the toolbar. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetButton(self,nID:'Any') -> 'Any': - """ - Retrieve information about the specified button in a - -toolbar control. - -Args: - - nID(Any):ID of the button to retrieve.MFC References - -Returns: - - Any - - """ - pass - - - def GetButtonCount(self,) -> 'Any': - """ - Retrieve a count of the buttons currently in the toolbar control. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetItemRect(self,nID:'Any') -> 'Tuple[Any, Any, Any, Any]': - """ - Retrieve the bounding rectangle of a button in a - -toolbar control. - -Args: - - nID(Any):ID of the button.MFC References - -Returns: - - Tuple[Any, Any, Any, Any] - - """ - pass - - - def GetRows(self,) -> 'Tuple[Any, Any, Any, Any]': - """ - Retrieve the number of rows of buttons currently displayed - -Args: - - - -Returns: - - Tuple[Any, Any, Any, Any] - - """ - pass - - - def HideButton(self,nID:'Any',bEnable:'Any'=1) -> 'None': - """ - Hide or show the specified button in a toolbar control. - -Args: - - nID(Any):ID of the button to hide. - bEnable(Any):1 to hide, 0 to show.MFC References - -Returns: - - None - - """ - pass - - - def Indeterminate(self,nID:'Any',bEnable:'Any'=1) -> 'None': - """ - Mark or unmark the specified button as indeterminate - -Args: - - nID(Any):ID of the button to mark. - bEnable(Any):1 to hide, 0 to show.MFC References - -Returns: - - None - - """ - pass - - - def InsertButton(self,nID:'Any',button:'Any') -> 'Any': - """ - Insert a button in a toolbar control. - -Args: - - nID(Any):Zero-based index of a button. This function inserts the new button to the left of this button. - button(Any):Bitmap containing button to be insertedCommentsThe image and/or string whose index you provide must have previously been added to the toolbar control's list using PyCToolBarCtrl::AddBitmap, PyCToolBarCtrl::AddString, and/or PyCToolBarCtrl::AddStrings.MFC References - -Returns: - - Any - - """ - pass - - - def IsButtonChecked(self,nID:'Any') -> 'Any': - """ - Determine whether the specified button in a toolbar control is checked. - -Args: - - nID(Any):ID of the button to check.MFC References - -Returns: - - Any - - """ - pass - - - def IsButtonEnabled(self,nID:'Any') -> 'Any': - """ - Determine whether the specified button in a toolbar control is enabled. - -Args: - - nID(Any):ID of the button to check.MFC References - -Returns: - - Any - - """ - pass - - - def IsButtonHidden(self,nID:'Any') -> 'Any': - """ - Determine whether the specified button in a toolbar control is hidden. - -Args: - - nID(Any):ID of the button to check.MFC References - -Returns: - - Any - - """ - pass - - - def IsButtonIndeterminate(self,nID:'Any') -> 'Any': - """ - Determine whether the specified button in a toolbar control is - -indeterminate. - -Args: - - nID(Any):ID of the button to check.MFC References - -Returns: - - Any - - """ - pass - - - def IsButtonPressed(self,nID:'Any') -> 'Any': - """ - Determine whether the specified button in a toolbar control is pressed. - -Args: - - nID(Any):ID of the button to check.MFC References - -Returns: - - Any - - """ - pass - - - def PressButton(self,nID:'Any',bEnable:'Any'=1) -> 'None': - """ - Mark or unmark the specified button as pressed. - -Args: - - nID(Any):ID of the button to mark. - bEnable(Any):1 to mark, 0 to unmark.MFC References - -Returns: - - None - - """ - pass - - - def SetBitmapSize(self,width1:'Any',height1:'Any',width:'Any'=16,height:'Any'=15) -> 'None': - """ - Set the size of the actual bitmapped images to be added to a toolbar control. - -Args: - - width1(Any):Width of bitmap images. - height1(Any):Height of bitmap images.MFC References - width(Any):Width of bitmap images. - height(Any):Height of bitmap images.Alternative Parameters - -Returns: - - None - - """ - pass - - - def SetButtonSize(self,width1:'Any',height1:'Any',width:'Any'=16,height:'Any'=15) -> 'None': - """ - Set the size of the buttons to be added to a toolbar control. - -Args: - - width1(Any):Width of bitmap images. - height1(Any):Height of bitmap images.MFC References - width(Any):Width of buttons - height(Any):Height of buttonsAlternative Parameters - -Returns: - - None - - """ - pass - - - def SetCmdID(self,nIndex:'Any',nID:'Any') -> 'None': - """ - Set the command identifier which will be sent to the owner window when the - -specified button is pressed. - -Args: - - nIndex(Any):The zero-based index of the button whose command ID is to be set. - nID(Any):The command ID to set the selected button to.MFC References - -Returns: - - None - - """ - pass - - - def SetRows(self,nRows:'Any',bLarger:'Any') -> 'Tuple[Any, Any, Any, Any]': - """ - Ask the toolbar control to resize itself to the requested - -number of rows. - -Args: - - nRows(Any):Requested number of rows. - bLarger(Any):Tells whether to use more rows or fewer rows if the toolbar cannot be resized to the requested number of rows.MFC References - -Returns: - - Tuple[Any, Any, Any, Any] - - """ - pass - - -class PyCToolTipCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,parent:'Any',style:'Any') -> 'None': - """ - Creates the actual control. - -Args: - - parent(Any):The parent window of the control. - style(Any):The style for the control. - -Returns: - - None - - """ - pass - - - def UpdateTipText(self,text:'str',wnd:'Any',_id:'Any') -> 'None': - """ - Update the tool tip text for a control's tools - -Args: - - text(str):The text for the tool. - wnd(Any):The window of the tool. - _id(Any):The id of the tool - -Returns: - - None - - """ - pass - - - def AddTool(self,wnd:'Any',text:'str',_id:'Any',rect:'Tuple[Any, Any, Any, Any]'=None) -> 'None': - """ - Adds a tool to tooltip control. - -Args: - - wnd(Any):The window of the tool. - text(str):The text for the tool. - _id(Any):The id of the tool - rect(Tuple[Any, Any, Any, Any]):The default rectangle - -Returns: - - None - - """ - pass - - - def SetMaxTipWidth(self,width:'Any') -> 'Any': - """ - None - -Args: - - width(Any):The new width - -Returns: - - Any - - """ - pass - - -class PyCTreeCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,style:'Any',rect:'Tuple[Any, Any, Any, Any]',PyCWnd:'Any',_id:'Any') -> 'None': - """ - Creates the actual window for the object. - -Args: - - style(Any):The window style - rect(Tuple[Any, Any, Any, Any]):The default rectangle - PyCWnd(Any):The parent window - _id(Any):The control IDMFC References - -Returns: - - None - - """ - pass - - - def GetCount(self,) -> 'Any': - """ - Retrieves the number of tree items associated with a tree view control. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetIndent(self,) -> 'Any': - """ - Retrieves the offset (in pixels) of a tree view item from its parent. - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetIndent(self,indent:'Any') -> 'None': - """ - Sets the offset (in pixels) of a tree view item from its parent. - -Args: - - indent(Any):The new indent. - -Returns: - - None - - """ - pass - - - def GetImageList(self,nImageList:'Any') -> 'Any': - """ - Retrieves the current image list. - -Args: - - nImageList(Any):Value specifying which image list to retrieve. It can be one of: - commctrl.LVSIL_NORMAL Image list with large icons. - commctrl.LVSIL_SMALL Image list with small icons. - commctrl.LVSIL_STATE Image list with state images. - -Returns: - - Any - - """ - pass - - - def SetImageList(self,imageList:'Any',imageType:'Any') -> 'Any': - """ - Assigns an image list to a list view control. - -Args: - - imageList(Any):The Image List to use. - imageType(Any):Type of image list. It can be one of (COMMCTRL.) LVSIL_NORMAL, LVSIL_SMALL or LVSIL_STATE - -Returns: - - Any - - """ - pass - - - def GetNextItem(self,item:'Any',code:'Any') -> 'Any': - """ - Retrieves the next item. - -Args: - - item(Any):The specified item - code(Any):Specifies the relationship of the item to fetch. - -Returns: - - Any - - """ - pass - - - def ItemHasChildren(self,item:'Any') -> 'Any': - """ - Returns nonzero if the specified item has child items. - -Args: - - item(Any):The specified item - -Returns: - - Any - - """ - pass - - - def GetChildItem(self,item:'Any') -> 'Any': - """ - Retrieves the first child item. - -Args: - - item(Any):The specified item - -Returns: - - Any - - """ - pass - - - def GetNextSiblingItem(self,item:'Any') -> 'Any': - """ - Retrieves the next sibling of the specified tree view item. - -Args: - - item(Any):The specified item - -Returns: - - Any - - """ - pass - - - def GetPrevSiblingItem(self,item:'Any') -> 'Any': - """ - Retrieves the previous sibling of the specified tree view item. - -Args: - - item(Any):The specified item - -Returns: - - Any - - """ - pass - - - def GetParentItem(self,item:'Any') -> 'Any': - """ - Retrieves the parent item of the specified tree view item. - -Args: - - item(Any):The specified item - -Returns: - - Any - - """ - pass - - - def GetFirstVisibleItem(self,) -> 'Any': - """ - Retrieves the first visible item of the tree view control. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetNextVisibleItem(self,item:'Any') -> 'Any': - """ - Retrieves the next visible item of the specified tree view item. - -Args: - - item(Any):The specified item - -Returns: - - Any - - """ - pass - - - def GetSelectedItem(self,) -> 'Any': - """ - Retrieves the currently selected tree view item. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetDropHilightItem(self,) -> 'Any': - """ - Retrieves the target of a drag-and-drop operation. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetRootItem(self,) -> 'Any': - """ - Retrieves the root of the specified tree view item. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetToolTips(self,) -> 'Any': - """ - Returns the tooltip control - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetItem(self,item:'Any',arg:'Any') -> 'Any': - """ - Retrieves the details of an items attributes. - -Args: - - item(Any):The item whose attributes are to be retrieved. - arg(Any):The requested attributes. - -Returns: - - Any - - """ - pass - - - def SetItem(self,item:'Any') -> 'Any': - """ - Sets some of all of an items attributes. - -Args: - - item(Any):A tuple describing the new item. - -Returns: - - Any - - """ - pass - - - def GetItemState(self,item:'Any',stateMask:'Any') -> 'Tuple[Any, Any]': - """ - Retrieves the state and mask of an item. - -Args: - - item(Any):The specified item - stateMask(Any):The mask for the result. - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def SetItemState(self,item:'Any',state:'Any',stateMask:'Any') -> 'None': - """ - Sets the state of item. - -Args: - - item(Any):The specified item - state(Any):The new state - stateMask(Any):The mask for the new state - -Returns: - - None - - """ - pass - - - def GetItemImage(self,item:'Any') -> 'Tuple[Any, Any]': - """ - Retrieves the index of an items images. - -Args: - - item(Any):The specified item - -Returns: - - Tuple[Any, Any] - - """ - pass - - - def SetItemImage(self,item:'Any',iImage:'Any',iSelectedImage:'Any') -> 'None': - """ - Sets the index of an items images. - -Args: - - item(Any):The specified item - iImage(Any):The offset of the image. - iSelectedImage(Any):The offset of the selected image. - -Returns: - - None - - """ - pass - - - def SetItemText(self,item:'Any',text:'str') -> 'Any': - """ - Changes the text of a list view item or subitem. - -Args: - - item(Any):The item whose text is to be retrieved. - text(str):String that contains the new item text. - -Returns: - - Any - - """ - pass - - - def GetItemText(self,item:'Any') -> 'Any': - """ - Retrieves the text of a list view item or subitem. - -Args: - - item(Any):The item whose text is to be retrieved. - -Returns: - - Any - - """ - pass - - - def GetItemData(self,item:'Any') -> 'Any': - """ - Retrieves the application-specific value associated with an item. - -Args: - - item(Any):The index of the item whose data is to be retrieved. - -Returns: - - Any - - """ - pass - - - def SetItemData(self,item:'Any',Data:'Any') -> 'Any': - """ - Sets the item's application-specific value. - -Args: - - item(Any):The item whose Data is to be set. - Data(Any):New value for the data.CommentsNote that a reference count is not added to the object. This it is your responsibility to make sure the object remains alive while in the list. - -Returns: - - Any - - """ - pass - - - def GetItemRect(self,item:'Any',bTextOnly:'Any') -> 'Tuple[Any, Any, Any, Any]': - """ - Retrieves the bounding rectangle of a tree view item. - -Args: - - item(Any):The item whose Data is to be set. - bTextOnly(Any):f this parameter is nonzero, the bounding rectangle includes only the text of the item. Otherwise it includes the entire line that the item occupies in the tree view control. - -Returns: - - Tuple[Any, Any, Any, Any] - - """ - pass - - - def GetEditControl(self,) -> 'Any': - """ - Retrieves the handle of the edit control used to edit the specified - -tree view item. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetVisibleCount(self,) -> 'Any': - """ - Retrieves the number of visible tree items associated with a tree view - -control. - -Args: - - - -Returns: - - Any - - """ - pass - - - def InsertItem(self,hParent:'Any',hInsertAfter:'Any',item:'Any',mask:'Any',text:'Any',image:'Any',selectedImage:'Any',state:'Any',stateMask:'Any',lParam:'Any',parent:'Any',parent1:'Any',text1:'Any',image1:'Any',selectedImage1:'Any',parent2:'Any',insertAfter:'Any',text2:'Any',parent3:'Any',parent4:'Any') -> 'Any': - """ - Inserts an item into the list. - -Args: - - hParent(Any):The parent item. If commctrl.TVI_ROOT or 0, it is added to the root. - hInsertAfter(Any):The item to insert after. Can be an item or TVI_FIRST, TVI_LAST or TVI_SORT - item(Any):A tuple describing the new item.Alternative Parameters - mask(Any):Integer specifying which attributes to set - text(Any):The text of the item. - image(Any):The index of the image to use. - selectedImage(Any):The index of the items selected image. - state(Any):The initial state of the item. - stateMask(Any):Specifies which bits of the state are valid. - lParam(Any):A user defined object for the item. - parent(Any):The parent of the item. - parent1(Any):The parent of the item.Alternative Parameters - text1(Any):The text for the item. - image1(Any):The index of the image to use. - selectedImage1(Any):The index of the items selected image. - parent2(Any):The parent of the item. - insertAfter(Any):The item to insert the new item after, or TVI_FIRST, TVI_LAST or TVI_SORTAlternative Parameters - text2(Any):The text for the item. - parent3(Any):The parent of the item. - parent4(Any):The parent of the item. - -Returns: - - Any - - """ - pass - - - def DeleteItem(self,item:'Any') -> 'None': - """ - Deletes the specified item. - -Args: - - item(Any):The specified item - -Returns: - - None - - """ - pass - - - def DeleteAllItems(self,) -> 'Any': - """ - Deletes all items in the control - -Args: - - - -Returns: - - Any - - """ - pass - - - def Expand(self,item:'Any',code:'Any') -> 'None': - """ - Expands, or collapses, the child items of the specified tree view item. - -Args: - - item(Any):The specified item - code(Any):The action to take - -Returns: - - None - - """ - pass - - - def Select(self,item:'Any',code:'Any') -> 'None': - """ - Selects, scrolls into view, or redraws a specified tree view item. - -Args: - - item(Any):The specified item - code(Any):The action to take - -Returns: - - None - - """ - pass - - - def SelectItem(self,item:'Any') -> 'None': - """ - Selects a specified tree view item. - -Args: - - item(Any):The specified item - -Returns: - - None - - """ - pass - - - def SelectDropTarget(self,item:'Any') -> 'None': - """ - Redraws the tree item as the target of a drag-and-drop operation. - -Args: - - item(Any):The specified item - -Returns: - - None - - """ - pass - - - def SelectSetFirstVisible(self,item:'Any') -> 'None': - """ - Selects a specified tree view item as the first visible item. - -Args: - - item(Any):The specified item - -Returns: - - None - - """ - pass - - - def EditLabel(self,item:'Any') -> 'Any': - """ - Edits a specified tree view item in-place. - -Args: - - item(Any):The item to edit. - -Returns: - - Any - - """ - pass - - - def CreateDragImage(self,item:'Any') -> 'Any': - """ - Creates a dragging bitmap for the specified tree view item. - -Args: - - item(Any):The item to edit. - -Returns: - - Any - - """ - pass - - - def SortChildren(self,item:'Any') -> 'None': - """ - Sorts the children of a given parent item. - -Args: - - item(Any):The specified parent item - -Returns: - - None - - """ - pass - - - def EnsureVisible(self,item:'Any') -> 'Any': - """ - Ensures that a tree view item is visible in its tree view control. - -Args: - - item(Any):The item to edit. - -Returns: - - Any - - """ - pass - - - def HitTest(self,arg:'Any') -> 'Tuple[Any, Any]': - """ - Determines which tree view item, if any, is at a specified position. - -Args: - - arg(Any):The point to test.Return ValueThe result is a tuple of (flags, hItem). flags may be a combination of the following values:ValueDescriptioncommctrl.TVHT_ABOVEAbove the client area.commctrl.TVHT_BELOWBelow the client area.commctrl.TVHT_NOWHEREIn the client area, but below the last item.commctrl.TVHT_ONITEMOn the bitmap or label associated with an item.commctrl.TVHT_ONITEMBUTTONOn the button associated with an item.commctrl.TVHT_ONITEMICONOn the bitmap associated with an item.commctrl.TVHT_ONITEMINDENTIn the indentation associated with an item.commctrl.TVHT_ONITEMLABELOn the label (string) associated with an item.commctrl.TVHT_ONITEMRIGHTIn the area to the right of an item.commctrl.TVHT_ONITEMSTATEICONOn the state icon for a tree view item that is in a user-defined state.commctrl.TVHT_TOLEFTTo the left of the client area.commctrl.TVHT_TORIGHTTo the right of the client area. - -Returns: - - Tuple[Any, Any]:The point to test.Return ValueThe result is a tuple of (flags, hItem). - -flags may be a combination of the following values: - - - -Value - - -Description - - - -commctrl.TVHT_ABOVEAbove the client area. -commctrl.TVHT_BELOWBelow the client area. -commctrl.TVHT_NOWHEREIn the client area, but below the last item. -commctrl.TVHT_ONITEMOn the bitmap or label associated with an item. -commctrl.TVHT_ONITEMBUTTONOn the button associated with an item. -commctrl.TVHT_ONITEMICONOn the bitmap associated with an item. -commctrl.TVHT_ONITEMINDENTIn the indentation associated with an item. -commctrl.TVHT_ONITEMLABELOn the label (string) associated with an item. -commctrl.TVHT_ONITEMRIGHTIn the area to the right of an item. -commctrl.TVHT_ONITEMSTATEICONOn the state icon for a tree view item that is in a user-defined state. -commctrl.TVHT_TOLEFTTo the left of the client area. -commctrl.TVHT_TORIGHTTo the right of the client area. - - - """ - pass - - -class PyCTreeView(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def PreCreateWindow(self,createStruct:'Any') -> 'Any': - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(Any):A tuple representing a CREATESTRUCT structure. - -Returns: - - Any - - """ - pass - - - def GetTreeCtrl(self,) -> 'Any': - """ - Returns the underlying tree control object. - -Args: - - - -Returns: - - Any - - """ - pass - - - def OnCommand(self,wparam:'Any',lparam:'Any') -> 'None': - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(Any): - lparam(Any):See Also - -Returns: - - None - - """ - pass - - -class PyCView(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,parent:'Any',arg:'Any',arg1:'Any',arg2:'Tuple[Any, Any, Any, Any]') -> 'None': - """ - Creates the window for a view. - -Args: - - parent(Any):The parent window (usually a frame) - arg(Any):The child ID for the view - arg1(Any):The style for the view - arg2(Tuple[Any, Any, Any, Any]):The default position of the window. - -Returns: - - None - - """ - pass - - - def GetDocument(self,) -> 'Any': - """ - Returns the document for a view. - -Args: - - - -Returns: - - Any - - """ - pass - - - def OnActivateView(self,activate:'Any',activateView:'Any',DeactivateView:'Any') -> 'Any': - """ - Calls the underlying MFC OnActivateView method. - -Args: - - activate(Any):Indicates whether the view is being activated or deactivated. - activateView(Any):The view object that is being activated. - DeactivateView(Any):The view object that is being deactivated.See Also - -Returns: - - Any - - """ - pass - - - def OnInitialUpdate(self,) -> 'None': - """ - Calls the underlying MFC OnInitialUpdate method. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnMouseActivate(self,wnd:'Any',hittest:'Any',message:'Any') -> 'Any': - """ - Calls the base MFC OnMouseActivate function. - -Args: - - wnd(Any): - hittest(Any): - message(Any):See Also - -Returns: - - Any - - """ - pass - - - def PreCreateWindow(self,createStruct:'Any') -> 'Any': - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(Any):A tuple representing a CREATESTRUCT structure.See Also - -Returns: - - Any - - """ - pass - - - def OnFilePrint(self,) -> 'None': - """ - Calls the underlying MFC OnFilePrint method. - -Args: - - - -Returns: - - None - - """ - pass - - - def DoPreparePrinting(self,) -> 'Any': - """ - Invoke the Print dialog box and create a printer device context. - -Args: - - - -Returns: - - Any - - """ - pass - - - def OnBeginPrinting(self,) -> 'None': - """ - Calls the underlying MFC OnBeginPrinting method. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnEndPrinting(self,) -> 'None': - """ - Calls the underlying MFC OnEndPrinting method. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCWinApp(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddDocTemplate(self,template:'Any') -> 'None': - """ - Adds a template to the application list. - -Args: - - template(Any):The template to be added. - -Returns: - - None - - """ - pass - - - def FindOpenDocument(self,fileName:'str') -> 'Any': - """ - Returns an existing document with the specified file name. - -Args: - - fileName(str):The fully qualified filename to search for. - -Returns: - - Any - - """ - pass - - - def GetDocTemplateList(self,) -> 'List[Any]': - """ - Returns a list of all document templates. - -Args: - - - -Returns: - - List[Any] - - """ - pass - - - def InitDlgInstance(self,dialog:'Any') -> 'None': - """ - Calls critical InitInstance processing for a dialog based application. - -Args: - - dialog(Any):The dialog object to be used as the main window for the application. - -Returns: - - None - - """ - pass - - - def LoadCursor(self,cursorId:'PyResourceId') -> 'Any': - """ - Loads a cursor. - -Args: - - cursorId(PyResourceId):The resource id or name of the cursor to load. - -Returns: - - Any - - """ - pass - - - def LoadStandardCursor(self,cursorId:'PyResourceId') -> 'Any': - """ - Loads a standard cursor. - -Args: - - cursorId(PyResourceId):The resource ID or name of the cursor to load. - -Returns: - - Any - - """ - pass - - - def LoadOEMCursor(self,cursorId:'Any') -> 'Any': - """ - Loads an OEM cursor. - -Args: - - cursorId(Any):The ID of the cursor to load. - -Returns: - - Any - - """ - pass - - - def LoadIcon(self,idResource:'Any') -> 'Any': - """ - Loads an icon resource. - -Args: - - idResource(Any):The ID of the icon to load. - -Returns: - - Any - - """ - pass - - - def LoadStandardIcon(self,resourceName:'PyResourceId') -> 'Any': - """ - Loads an icon resource. - -Args: - - resourceName(PyResourceId):The resource name or id of the standard icon to load. - -Returns: - - Any - - """ - pass - - - def OpenDocumentFile(self,fileName:'str') -> 'None': - """ - Opens a document file by name. - -Args: - - fileName(str):The name of the document to open. - -Returns: - - None - - """ - pass - - - def OnFileNew(self,) -> 'None': - """ - Calls the underlying OnFileNew MFC method. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnFileOpen(self,) -> 'None': - """ - Calls the underlying OnFileOpen MFC method. - -Args: - - - -Returns: - - None - - """ - pass - - - def RemoveDocTemplate(self,template:'Any') -> 'None': - """ - Removes a template to the application list. - -Args: - - template(Any):The template to be removed. Must have previously been added by PyCWinApp::AddDocTemplate.CommentsNote that MFC does not provide an equivilent function. - -Returns: - - None - - """ - pass - - - def Run(self,) -> 'Any': - """ - Starts the message pump. Advanced users only - -Args: - - - -Returns: - - Any - - """ - pass - - - def IsInproc(self,) -> 'Any': - """ - Returns a flag to indicate if the created CWinApp was in the DLL, or an external - -EXE. - -Args: - - - -Returns: - - Any - - """ - pass - - -class PyCWinThread(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateThread(self,) -> 'None': - """ - Creates the actual thread behind the thread object. - -Args: - - - -Returns: - - None - - """ - pass - - - def PumpIdle(self,) -> 'None': - """ - Pumps all idle messages. - -Args: - - - -Returns: - - None - - """ - pass - - - def PumpMessages(self,) -> 'None': - """ - Pumps all messages to the application until a WM_QUIT message is received. - -Args: - - - -Returns: - - None - - """ - pass - - - def Run(self,) -> 'Any': - """ - Starts the message pump. Advanced users only - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetMainFrame(self,mainFrame:'Any') -> 'None': - """ - Sets the threads main frame - -Args: - - mainFrame(Any):The applications main frame.CommentsYou can pass None to this function to reset the main frame. Should I free this? I dont think so! - -Returns: - - None - - """ - pass - - - def SetThreadPriority(self,priority:'Any') -> 'None': - """ - Sets the threads priority. Returns TRUE if successful. - -Args: - - priority(Any):The threads priority. - -Returns: - - None - - """ - pass - - -class PyCWnd(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ActivateFrame(self,cmdShow:'Any') -> 'None': - """ - Searches upwards for a parent window which has - -a frame, and activates it. - -Args: - - cmdShow(Any):The param passed to CFrameWnd::ShowWindow. See also PyCWnd::ShowWindow.MFC References - -Returns: - - None - - """ - pass - - - def BringWindowToTop(self,) -> 'None': - """ - Brings the window to the top of a stack of overlapping windows. - -Args: - - - -Returns: - - None - - """ - pass - - - def BeginPaint(self,) -> 'Tuple[Any, Any]': - """ - Prepares a window for painting - -Args: - - - -Returns: - - Tuple[Any, Any]:PyCWnd.BeginPaint -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:'Tuple[Any, Any, Any, Any]',nAdjustType:'Any') -> 'Tuple[Any, Any, Any, Any]': - """ - Computes the size of the window rectangle based on the desired client - -rectangle size. The resulting size can then be used as the initial - -size for the window object. - -Args: - - rect(Tuple[Any, Any, Any, Any]):The size to calculate from - nAdjustType(Any):An enumerated type used for in-place editing. It can have the following values: CWnd::adjustBorder = 0, which means that scrollbar sizes are ignored in calculation; and CWnd::adjustOutside = 1, which means that they are added into the final measurements of the rectangle.MFC References - -Returns: - - Tuple[Any, Any, Any, Any] - - """ - pass - - - def CenterWindow(self,altwin:'Any'=None) -> 'None': - """ - Centers a window relative to its parent. - -Args: - - altwin(Any):alternate window relative to which it will be centered (other than the parent window).MFC References - -Returns: - - None - - """ - pass - - - def CheckRadioButton(self,idFirst:'Any',idLast:'Any',idCheck:'Any') -> 'None': - """ - Selects the specified radio button, and clears - -all others in the group. - -Args: - - idFirst(Any):The identifier of the first radio button in the group. - idLast(Any):The identifier of the last radio button in the group. - idCheck(Any):The identifier of the radio button to be checked.MFC References - -Returns: - - None - - """ - pass - - - def ChildWindowFromPoint(self,x:'Any',y:'Any',flag:'Any'=0) -> 'Any': - """ - Returns the child window that contains the point - -Args: - - x(Any):x coordinate of point - y(Any):y coordinate of point - flag(Any):Specifies which child windows to skipMFC References - -Returns: - - Any - - """ - pass - - - def ClientToScreen(self,point:'Tuple[Any, Any]',rect:'Any') -> 'Tuple[Any, Any, Any, Any, Any]': - """ - Converts the client coordinates of a given point on the display - -to screen coordinates. - -Args: - - point(Tuple[Any, Any]):The client coordinates.Alternative Parameters - rect(Any):The client coordinates.CommentsThe new screen coordinates are relative to the upper-left corner of the system display. This function assumes that the given pointis in client coordinates.MFC References - -Returns: - - Tuple[Any, Any, Any, Any, Any] - - """ - pass - - - def CreateWindow(self,classId:'str',windowName:'str',style:'Any',rect:'Tuple[Any, Any, Any, Any]',parent:'Any',_id:'Any',context:'Any'=None) -> 'None': - """ - Creates the actual window - -Args: - - classId(str):The class ID for the window, or None - windowName(str):The title for the window, or None - style(Any):The style for the window. - rect(Tuple[Any, Any, Any, Any]):The size and position of the window. - parent(Any):The parent window of the new window.. - _id(Any):The control's ID. - context(Any):A CreateContext object.MFC References - -Returns: - - None - - """ - pass - - - def CreateWindowEx(self,styleEx:'Any',classId:'str',windowName:'str',style:'Any',rect:'Tuple[Any, Any, Any, Any]',parent:'Any',_id:'Any',createStruct1:'Any',createStruct:'Any'=None) -> 'None': - """ - Creates the actual window using extended capabilities. - -Args: - - styleEx(Any):The extended style of the window being created. - classId(str):The class ID for the window. May not be None. - windowName(str):The title for the window, or None - style(Any):The style for the window. - rect(Tuple[Any, Any, Any, Any]):The size and position of the window. - parent(Any):The parent window of the new window.. - _id(Any):The control's ID. - createStruct1(Any):A tuple representing a CREATESTRUCT structure.MFC References - createStruct(Any):A CreateStruct object (ie, a tuple) - -Returns: - - None - - """ - pass - - - def DefWindowProc(self,message:'Any',idLast:'Any',idCheck:'Any') -> 'Any': - """ - Calls the default message handler. - -Args: - - message(Any):The Windows message. - idLast(Any):The lParam for the message. - idCheck(Any):The wParam for the message.MFC References - -Returns: - - Any - - """ - pass - - - def DestroyWindow(self,) -> 'None': - """ - Destroy the window attached to the object. - -Args: - - - -Returns: - - None - - """ - pass - - - def DlgDirList(self,defPath:'str',idListbox:'Any',idStaticPath:'Any',fileType:'Any') -> 'None': - """ - Fill a list box with a file or directory listing. - -Args: - - defPath(str):The file spec to fill the list box with - idListbox(Any):The Id of the listbox control to fill. - idStaticPath(Any):The Id of the static control used to display the current drive and directory. If idStaticPath is 0, it is assumed that no such control exists. - fileType(Any):Specifies the attributes of the files to be displayed. It can be any combination of DDL_READWRITE, DDL_READONLY, DDL_HIDDEN, DDL_SYSTEM, DDL_DIRECTORY, DDL_ARCHIVE, DDL_POSTMSGS, DDL_DRIVES or DDL_EXCLUSIVEMFC References - -Returns: - - None - - """ - pass - - - def DlgDirListComboBox(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def DlgDirSelect(self,idListbox:'Any') -> 'str': - """ - None - -Args: - - idListbox(Any):The Id of the listbox.MFC References - -Returns: - - str - - """ - pass - - - def DlgDirSelectComboBox(self,idListbox:'Any') -> 'str': - """ - None - -Args: - - idListbox(Any):The Id of the combobox.MFC References - -Returns: - - str - - """ - pass - - - def DragAcceptFiles(self,bAccept:'Any'=1) -> 'None': - """ - Indicates that the window and children supports files dropped from file manager - -Args: - - bAccept(Any):A flag indicating if files are accepted.MFC References - -Returns: - - None - - """ - pass - - - def DrawMenuBar(self,) -> 'None': - """ - Redraws the menu bar. Can be called if the menu changes. - -Args: - - - -Returns: - - None - - """ - pass - - - def EnableWindow(self,bEnable:'Any'=1) -> 'Any': - """ - Enables or disables the window. Typically used for dialog controls. - -Args: - - bEnable(Any):A flag indicating if the window is to be enabled or disabled.MFC References - -Returns: - - Any:CWnd::EnableWindow -Return ValueReturns the state before the EnableWindow member function was called - - - """ - pass - - - def EndModalLoop(self,result:'Any') -> 'None': - """ - Ends a modal loop. - -Args: - - result(Any):The result as returned to RunModalLoop - -Returns: - - None - - """ - pass - - - def EndPaint(self,paintStruct:'Any') -> 'None': - """ - Ends painting - -Args: - - paintStruct(Any):The object returned from PyCWnd::BeginPaint - -Returns: - - None - - """ - pass - - - def GetCheckedRadioButton(self,idFirst:'Any',idLast:'Any') -> 'Any': - """ - Returns the ID of the checked radio button, or 0 if none is selected. - -Args: - - idFirst(Any):The Id of the first radio button in the group. - idLast(Any):The Id of the last radio button in the group.MFC References - -Returns: - - Any - - """ - pass - - - def GetClientRect(self,) -> 'Tuple[Any, Any, Any, Any]': - """ - Returns the client coordinates of the window. left and top - -will be zero. - -Args: - - - -Returns: - - Tuple[Any, Any, Any, Any] - - """ - pass - - - def GetDC(self,) -> 'Any': - """ - Gets the windows current DC object. - -Args: - - - -Returns: - - Any:PyCWnd.GetDC -PyCDC = GetDC()Gets the windows current DC object. -Return ValueThe result is a PyCDC, or a win32ui.error exception is raised. - - - """ - pass - - - def GetDCEx(self,) -> 'Any': - """ - Gets the windows current DC object with extended caps. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetDlgCtrlID(self,) -> 'Any': - """ - Returns the ID of this child window. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetDlgItem(self,idControl:'Any') -> 'Any': - """ - None - -Args: - - idControl(Any):The Id of the control to be retrieved.MFC References - -Returns: - - Any:CWnd::GetDlgItem -Return ValueThe result is a PyCWnd (or derived) object, or a win32ui.error exception is raised. - - - """ - pass - - - def GetDlgItemInt(self,idControl:'Any',bUnsigned:'Any'=1) -> 'Any': - """ - Returns the integer value of a child window or control with the specified ID. - -Args: - - idControl(Any):The Id of the control to be retrieved. - bUnsigned(Any):Should the function check for a minus signMFC References - -Returns: - - Any:CWnd::GetDlgItemInt -Return ValueIf the value can not be converted, a ValueError is raised. - - - """ - pass - - - def GetDlgItemText(self,idControl:'Any') -> 'str': - """ - Returns the text of child window or control with the specified ID. - -Args: - - idControl(Any):The Id of the control to be retrieved.MFC References - -Returns: - - str - - """ - pass - - - def GetLastActivePopup(self,) -> 'Any': - """ - Returns the last active popup Window, or the Window itself. - -Args: - - - -Returns: - - Any:CWnd::GetLastActivePopup -Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - - """ - pass - - - def GetMenu(self,) -> 'Any': - """ - Returns the menu object for the window's menu. - -Args: - - - -Returns: - - Any:CWnd::GetMenu -Return ValueThe result is a PyMenu - - object, or an exception is thrown. - - - """ - pass - - - def GetParent(self,) -> 'Any': - """ - Returns the window's parent. - -Args: - - - -Returns: - - Any:CWnd::GetParent -Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - - """ - pass - - - def GetParentFrame(self,) -> 'Any': - """ - Returns the window's frame. - -Args: - - - -Returns: - - Any:CWnd::GetParentFrame -Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - - """ - pass - - - def GetSafeHwnd(self,) -> 'Any': - """ - Returns the HWnd of this window. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetScrollInfo(self,nBar:'Any',mask:'Any') -> 'Any': - """ - Returns information about a scroll bar - -Args: - - nBar(Any):The scroll bar to examine. Can be one of win32con.SB_BOTH, win32con.SB_VERT or win32con.SB_HORZ - mask(Any):The mask for attributes to retrieve. - -Returns: - - Any - - """ - pass - - - def GetScrollPos(self,nBar:'Any') -> 'Any': - """ - Retrieves the current position of the scroll box of a scroll bar. - -Args: - - nBar(Any):The scroll bar to examine. Can be one of win32con.SB_VERT or win32con.SB_HORZ - -Returns: - - Any - - """ - pass - - - def GetStyle(self,) -> 'Any': - """ - Retrieves the window style - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetExStyle(self,) -> 'Any': - """ - Retrieves the window's extended style - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetSystemMenu(self,) -> 'Any': - """ - Returns the menu object for the window's system menu. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetTopLevelFrame(self,) -> 'Any': - """ - Returns the top-level frame of the window. - -Args: - - - -Returns: - - Any:CWnd::GetTopLevelFrame -Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - - """ - pass - - - def GetTopLevelOwner(self,) -> 'Any': - """ - Returns the top-level owner of the window. - -Args: - - - -Returns: - - Any:CWnd::GetTopLevelOwner -Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - - """ - pass - - - def GetTopLevelParent(self,) -> 'Any': - """ - Returns the top-level parent of the window. - -Args: - - - -Returns: - - Any:CWnd::GetTopLevelParent -Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - - """ - pass - - - def GetTopWindow(self,) -> 'Any': - """ - Identifies the top-level child window in a linked list of child windows. - -Args: - - - -Returns: - - Any:CWnd::GetTopWindow -Return ValueIf no child windows exist, the value is None. - - - """ - pass - - - def GetWindow(self,_type:'Any') -> 'Any': - """ - Returns a window, with the specified relationship to this window. - -Args: - - _type(Any):Specifies the relationship between the current and the returned window. It can take one of the following values: GW_CHILD, GW_HWNDFIRST, GW_HWNDLAST, GW_HWNDNEXT, GW_HWNDPREV or GW_OWNERMFC References - -Returns: - - Any:CWnd::GetWindow -Return ValueThe result is a PyCWnd or None if no Window can be found. - - - """ - pass - - - def GetWindowDC(self,) -> 'Any': - """ - Gets the windows current DC object. - -Args: - - - -Returns: - - Any - - """ - pass - - - def GetWindowPlacement(self,) -> 'Any': - """ - Returns placement information about the current window. - -Args: - - - -Returns: - - Any:CWnd::GetWindowPlacement -Return ValueThe result is a tuple of - -(flags, showCmd, (minposX, minposY), (maxposX, maxposY), (normalposX, normalposY)) - - - -Item - - -Description - - - -flagsOne of the WPF_* constants -showCmdCurrent state - one of the SW_* constants. -minposSpecifies the coordinates of the window's upper-left corner when the window is minimized. -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,) -> 'Tuple[Any, Any, Any, Any]': - """ - Returns the screen coordinates of the windows upper left - -corner - -Args: - - - -Returns: - - Tuple[Any, Any, Any, Any] - - """ - pass - - - def GetWindowText(self,) -> 'str': - """ - Returns the windows text. - -Args: - - - -Returns: - - str - - """ - pass - - - def HideCaret(self,) -> 'None': - """ - Hides the caret - -Args: - - - -Returns: - - None - - """ - pass - - - def HookAllKeyStrokes(self,obHandler:'Any') -> 'None': - """ - Hook a key stroke handler for all key strokes. - -Args: - - obHandler(Any):The handler for the keystrokes. This must be a callable object.CommentsThe handler object passed will be called as the application receives WM_CHAR messages. The handler will be called with 2 arguments The handler object (as per all hook functions). The keystroke being handled. If the handler returns TRUE, then the keystroke will be passed on to the default handler, otherwise it will be consumed. Note: This handler will prevent any PyCWnd::HookKeyStroke hooks from being called. - -Returns: - - None - - """ - pass - - - def HookKeyStroke(self,obHandler:'Any',ch:'Any') -> 'Any': - """ - Hook a key stroke handler - -Args: - - obHandler(Any):The handler of the keystroke. This must be a callable object. - ch(Any):The ID for the keystroke to be handled. This may be an ascii code, or a virtual key code.CommentsThe 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 The handler object (as per all hook functions) The keystroke being handled. If the handler returns TRUE, then the keystroke will be passed on to the 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. - -Returns: - - 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 - -character code. The handler will be called with 2 arguments - -The handler object (as per all hook functions) - -The keystroke being handled. - -If the handler returns TRUE, then the keystroke will be passed on to the - -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 - - - def HookMessage(self,obHandler:'Any',message:'Any') -> 'Any': - """ - Hook a message notification handler - -Args: - - obHandler(Any):The handler for the message notification. This must be a callable object. - message(Any):The ID of the message to be handled.CommentsThe 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. The handler will be called with 2 arguments The handler object (as per all hook functions). A tuple representing the message. The message tuple is in the following format:Items[0] int : hwndThe hwnd of the window.[1] int : messageThe message.[2] int : wParamThe wParam sent with the message.[3] int : lParamThe lParam sent with the message.[4] int : timeThe time the message was posted.[5] int, int : pointThe point where the mouse was when the message was posted.Return ValueThe return value is the previous handler, or None. - -Returns: - - 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. - -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 object (as per all hook functions). - -A tuple representing the message. - -The message tuple is in the following format: -Items[0] int : hwnd -The hwnd of the window. -[1] int : message -The message. -[2] int : wParam -The wParam sent with the message. -[3] int : lParam -The lParam sent with the message. -[4] int : time -The time the message was posted. -[5] int, int : point -The point where the mouse was when the message was posted. -Return ValueThe return value is the previous handler, or None. - - - """ - pass - - - def InvalidateRect(self,arg:'Tuple[Any, Any, Any, Any]',bErase:'Any'=1) -> 'None': - """ - Invalidates an area of a window. - -Args: - - arg(Tuple[Any, Any, Any, Any]):Rectangle to be updated. If default param is used, the entire window is invalidated. - bErase(Any):Specifies whether the background within the update region is to be erased.MFC References - -Returns: - - None - - """ - pass - - - def InvalidateRgn(self,region:'Any',bErase:'Any'=1) -> 'None': - """ - Invalidates a region of the window - -Args: - - region(Any):The region to erase. - bErase(Any):Indicates if the region should be erased. - -Returns: - - None - - """ - pass - - - def IsChild(self,obWnd:'Any') -> 'Any': - """ - Determines if a given window is a child of this window. - -Args: - - obWnd(Any):The window to be checkedMFC References - -Returns: - - Any - - """ - pass - - - def IsDlgButtonChecked(self,idCtl:'Any') -> 'Any': - """ - Determines if a dialog button is checked. - -Args: - - idCtl(Any):The ID of the button to check.MFC References - -Returns: - - Any - - """ - pass - - - def IsIconic(self,) -> 'Any': - """ - Determines if the window is currently displayed as an icon. - -Args: - - - -Returns: - - Any - - """ - pass - - - def IsZoomed(self,) -> 'Any': - """ - Determines if the window is currently maximised. - -Args: - - - -Returns: - - Any - - """ - pass - - - def IsWindow(self,) -> 'Any': - """ - determines whether the specified window handle identifies an existing window - -Args: - - - -Returns: - - Any - - """ - pass - - - def IsWindowVisible(self,) -> 'Any': - """ - Determines if the window is currently visible. - -Args: - - - -Returns: - - Any - - """ - pass - - - def KillTimer(self,) -> 'Any': - """ - Kills a system timer - -Args: - - - -Returns: - - Any - - """ - pass - - - def LockWindowUpdate(self,) -> 'None': - """ - Disables drawing in the given window - -Args: - - - -Returns: - - None - - """ - pass - - - def MapWindowPoints(self,wnd:'Any',points:'List[Any]') -> 'None': - """ - Converts (maps) a set of points from the coordinate space of a window to the - -coordinate space of another window. - -Args: - - wnd(Any): - points(List[Any]):The points to mapReturn ValueA list of the mapped points from the coordinate space of the CWnd to the coordinate space of another window. - -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 - -window. - - - """ - pass - - - def MouseCaptured(self,) -> 'Any': - """ - Returns 1 if the window has the mouse capture, else 0 - -Args: - - - -Returns: - - Any - - """ - pass - - - def MessageBox(self,message:'str',arg:'Any',title:'Union[Any, str]'=None) -> 'None': - """ - Display a message box. - -Args: - - message(str):The message to be displayed in the message box. - arg(Any):The style of the message box.MFC References - title(Union[Any, str]):The title for the message box. If None, the applications title will be used. - -Returns: - - None:CWnd::MessageBox -Return ValueAn integer identifying the button pressed to dismiss the dialog. - - - """ - pass - - - def ModifyStyle(self,remove:'Any',add:'Any',flags:'Any'=0) -> 'Any': - """ - Modifies the style of a window. - -Args: - - remove(Any):Specifies window styles to be removed during style modification. - add(Any):Specifies window styles to be added during style modification. - flags(Any):Flags to be passed to SetWindowPos, or zero if SetWindowPos should not be called. The default is zero.CommentsIf nFlags is nonzero, ModifyStyle calls the Windows API function ::SetWindowPos and redraws the window by combining nFlags with the following four preset flags: * SWP_NOSIZE Retains the current size. * SWP_NOMOVE Retains the current position. * SWP_NOZORDER Retains the current Z order. * SWP_NOACTIVATE Does not activate the window. See also PyCWnd::ModifyStyleExMFC References - -Returns: - - Any:CWnd::ModifyStyle -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 - - - def ModifyStyleEx(self,remove:'Any',add:'Any',flags:'Any'=0) -> 'Any': - """ - Modifies the extended style of a window. - -Args: - - remove(Any):Specifies extended window styles to be removed during style modification. - add(Any):Specifies extended extended window styles to be added during style modification. - flags(Any):Flags to be passed to SetWindowPos, or zero if SetWindowPos should not be called. The default is zero.CommentsIf nFlags is nonzero, ModifyStyleEx calls the Windows API function ::SetWindowPos and redraws the window by combining nFlags with the following four preset flags: * SWP_NOSIZE Retains the current size. * SWP_NOMOVE Retains the current position. * SWP_NOZORDER Retains the current Z order. * SWP_NOACTIVATE Does not activate the window. See also PyCWnd::ModifyStyleMFC References - -Returns: - - Any:CWnd::ModifyStyleEx -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 - - - def MoveWindow(self,rect:'Tuple[Any, Any, Any, Any]',bRepaint:'Any'=1) -> 'None': - """ - Move a window to a new location. - -Args: - - rect(Tuple[Any, Any, Any, Any]):The new location of the window, relative to the parent. - bRepaint(Any):Indicates if the window should be repainted after the move.MFC References - -Returns: - - None - - """ - pass - - - def OnClose(self,) -> 'Any': - """ - Calls the default MFC OnClose handler. - -Args: - - - -Returns: - - Any - - """ - pass - - - def OnCtlColor(self,dc:'Any',control:'Any',_type:'Any') -> 'Any': - """ - Calls the default MFC OnCtlColor handler. - -Args: - - dc(Any):The dc - control(Any):The control that want's it's color changed - _type(Any):Type of controlSee Also - -Returns: - - Any - - """ - pass - - - def OnEraseBkgnd(self,dc:'Any') -> 'Any': - """ - Calls the default MFC OnEraseBkgnd handler. - -Args: - - dc(Any):The dcSee Also - -Returns: - - Any - - """ - pass - - - def OnNcHitTest(self,arg:'Tuple[Any, Any]') -> 'Any': - """ - Calls the base MFC OnNcHitTest function. - -Args: - - arg(Tuple[Any, Any]):The pointSee Also - -Returns: - - Any - - """ - pass - - - def OnPaint(self,) -> 'Any': - """ - Calls the default MFC OnPaint handler. - -Args: - - - -Returns: - - Any - - """ - pass - - - def OnQueryDragIcon(self,) -> 'Any': - """ - Calls the default MFC OnQueryDragIcon handler. - -Args: - - - -Returns: - - Any - - """ - pass - - - def OnQueryNewPalette(self,) -> 'Any': - """ - Calls the underlying MFC OnQueryNewPalette method. - -Args: - - - -Returns: - - Any - - """ - pass - - - def OnSetCursor(self,wnd:'Any',hittest:'Any',message:'Any') -> 'Any': - """ - Calls the base MFC OnSetCursor function. - -Args: - - wnd(Any): - hittest(Any): - message(Any):See Also - -Returns: - - Any - - """ - pass - - - def OnMouseActivate(self,wnd:'Any',hittest:'Any',message:'Any') -> 'Any': - """ - Calls the base MFC OnMouseActivate function. - -Args: - - wnd(Any): - hittest(Any): - message(Any):See Also - -Returns: - - Any - - """ - pass - - - def OnWndMsg(self,msg:'Any',wParam:'Any',lParam:'Any') -> 'Tuple[Any, Any]': - """ - Calls the default MFC Window Message handler. - -Args: - - msg(Any):The message - wParam(Any):The wParam for the message - lParam(Any):The lParam for the messageMFC References - -Returns: - - Tuple[Any, Any]:CWnd::OnWndMsg -Return ValueThe return value is a tuple of (int, int), being the - -return value from the MFC function call, and the value of the - -lResult param. Please see the MFC documentation for more details. - - - """ - pass - - - def PreCreateWindow(self,createStruct:'Any') -> 'Any': - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(Any):A tuple representing a CREATESTRUCT structure.See Also - -Returns: - - Any - - """ - pass - - - def PumpWaitingMessages(self,firstMsg:'Any',lastMsg:'Any') -> 'None': - """ - Pump messages associate with a window. - -Args: - - firstMsg(Any):First message ID to process - lastMsg(Any):First message ID to processMFC References - -Returns: - - None - - """ - pass - - - def RedrawWindow(self,_object:'Any',flags:'Any',rect:'Tuple[Any, Any, Any, Any]'=None) -> 'None': - """ - Updates the specified rectangle or region in the given window's client area. - -Args: - - _object(Any):A region - flags(Any):MFC References - rect(Tuple[Any, Any, Any, Any]):A rect, or None - -Returns: - - None - - """ - pass - - - def ReleaseCapture(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def ReleaseDC(self,dc:'Any') -> 'None': - """ - Releases a device context, freeing it for use by other applications. - -Args: - - dc(Any):The DC to be released. - -Returns: - - None - - """ - pass - - - def RepositionBars(self,idFirst:'Any',idLast:'Any',idLeftOver:'Any') -> 'None': - """ - Repositions the windows control bars.( UINT nIDFirst, UINT nIDLast, UINT - -nIDLeftOver, UINT nFlag = CWnd::reposDefault, LPRECT lpRectParam = NULL, LPCRECT lpRectClient = NULL, BOOL bStretch = - -TRUE ); - -Args: - - idFirst(Any):The ID of the first control to reposition. - idLast(Any):The ID of the last control to reposition. - idLeftOver(Any): - -Returns: - - None - - """ - pass - - - def RunModalLoop(self,flags:'Any') -> 'Any': - """ - Begins a modal loop for the window. - -Args: - - flags(Any): - -Returns: - - Any - - """ - pass - - - def PostMessage(self,idMessage:'Any',wParam:'Any'=0,lParam:'Any'=0) -> 'None': - """ - Post a message to the window. - -Args: - - idMessage(Any):The ID of the message to post. - wParam(Any):The wParam for the message - lParam(Any):The lParam for the messageMFC References - -Returns: - - None - - """ - pass - - - def SendMessageToDescendants(self,idMessage:'Any',wParam:'Any'=0,lParam:'Any'=0,bDeep:'Any'=1) -> 'None': - """ - Send a message to all descendant windows. - -Args: - - idMessage(Any):The ID of the message to send. - wParam(Any):The wParam for the message - lParam(Any):The lParam for the message - bDeep(Any):Indicates if the message should be recursively sent to all childrenMFC References - -Returns: - - None - - """ - pass - - - def SendMessage(self,idMessage:'Any',idMessage1:'Any',ob:'Any',wParam:'Any'=0,lParam:'Any'=0) -> 'None': - """ - Send a message to the window. - -Args: - - idMessage(Any):The ID of the message to send. - idMessage1(Any):The ID of the message to send. - ob(Any):A buffer whose size is passed in wParam, and address is passed in lParamMFC References - wParam(Any):The wParam for the message - lParam(Any):The lParam for the messageAlternative Parameters - -Returns: - - None - - """ - pass - - - def SetActiveWindow(self,) -> 'Any': - """ - Sets the window active. Returns the previously active window, or None. - -Args: - - - -Returns: - - Any:PyCWnd.SetActiveWindow -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 - - - def SetForegroundWindow(self,) -> 'None': - """ - Puts the window into the foreground and activates the window. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetWindowPos(self,hWndInsertAfter:'Any',position:'Tuple[Any, Any, Any, Any]',flags:'Any') -> 'None': - """ - Sets the windows position information - -Args: - - hWndInsertAfter(Any):A hwnd, else one of the win32con.HWND_* constants. - position(Tuple[Any, Any, Any, Any]):The new position of the window. - flags(Any):Window positioning flags.MFC References - -Returns: - - None - - """ - pass - - - def ScreenToClient(self,rect:'Tuple[Any, Any, Any, Any, Any]',pnt:'Any') -> 'Tuple[Any, Any, Any, Any, Any]': - """ - Converts the screen coordinates of a given point - -or rectangle on the display to client coordinates. - -Args: - - rect(Tuple[Any, Any, Any, Any, Any]):The coordinates to convert.Alternative Parameters - pnt(Any):The coordinates to convert.MFC References - -Returns: - - Tuple[Any, Any, Any, Any, 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 - -position of the cursor. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetDlgItemText(self,idControl:'Any',text:'str') -> 'None': - """ - Sets the text for the child window or control with the specified ID. - -Args: - - idControl(Any):The Id of the control - text(str):The new textMFC References - -Returns: - - None - - """ - pass - - - def SetFocus(self,) -> 'None': - """ - Claims the input focus. The object that previously had the focus loses it. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetFont(self,font:'Any',bRedraw:'Any'=1) -> 'None': - """ - Sets the window's current font to the specified font. - -Args: - - font(Any):The new font to use. - bRedraw(Any):If TRUE, redraw the window. - -Returns: - - None - - """ - pass - - - def SetIcon(self,) -> 'Any': - """ - Calls the underlying MFC SetIcon method. - -Args: - - - -Returns: - - Any - - """ - pass - - - def SetMenu(self,menuObj:'Any') -> 'None': - """ - Sets the menu for a window. - -Args: - - menuObj(Any):The menu object to set, or None to remove the window. - -Returns: - - None - - """ - pass - - - def SetRedraw(self,bState:'Any'=1) -> 'None': - """ - Allows changes to be redrawn or to prevent changes from being redrawn. - -Args: - - bState(Any):Specifies the state of the redraw flag.MFC References - -Returns: - - None - - """ - pass - - - def SetScrollPos(self,nBar:'Any',nPos:'Any',redraw:'Any'=1) -> 'Any': - """ - Sets the current position of the scroll box of a scroll bar. - -Args: - - nBar(Any):The scroll bar to set. Can be one of win32con.SB_VERT or win32con.SB_HORZ - nPos(Any):The new position - redraw(Any):A flag indicating if the scrollbar should be redrawn. - -Returns: - - Any - - """ - pass - - - def SetScrollInfo(self,nBar:'Any',ScrollInfo:'Any',redraw:'Any'=1) -> 'Any': - """ - Set information about a scroll bar - -Args: - - nBar(Any):The scroll bar to examine. Can be one of win32con.SB_BOTH, win32con.SB_VERT or win32con.SB_HORZ - ScrollInfo(Any):The information to set - redraw(Any):A flag indicating if the scrollbar should be re-drawn. - -Returns: - - Any - - """ - pass - - - def SetTimer(self,idEvent:'Any',elapse:'Any') -> 'Any': - """ - Installs a system timer - -Args: - - idEvent(Any):The ID of the event - elapse(Any):How often the timer should fire.MFC References - -Returns: - - Any - - """ - pass - - - def SetWindowPlacement(self,placement:'Any') -> 'None': - """ - Sets the windows placement - -Args: - - placement(Any):A tuple representing the WINDOWPLACEMENT structure.MFC References - -Returns: - - None - - """ - pass - - - def SetWindowText(self,text:'str') -> 'None': - """ - Sets the window's text. - -Args: - - text(str):The windows text.MFC References - -Returns: - - None - - """ - pass - - - def ShowCaret(self,) -> 'None': - """ - Shows the caret - -Args: - - - -Returns: - - None - - """ - pass - - - def ShowScrollBar(self,nBar:'Any',bShow:'Any'=1) -> 'None': - """ - Shows or hides a scroll bar. - -An application should not call ShowScrollBar to hide a scroll bar while processing a scroll-bar notification message. - -Args: - - nBar(Any):Specifies whether the scroll bar is a control or part of a window's nonclient area. If it is part of the nonclient area, nBar also indicates whether the scroll bar is positioned horizontally, vertically, or both. It must be one of win32con.SB_BOTH, win32con.SB_HORZ or win32con.SB_VERT. - bShow(Any):Indicates if the scroll bar should be shown or hidden.MFC References - -Returns: - - None - - """ - pass - - - def ShowWindow(self,arg:'Any') -> 'Any': - """ - Sets the visibility state of the window. - -Args: - - arg(Any):Specifies how the window is to be shown. It must be one of win32con.SW_HIDE, win32con.SW_MINIMIZE, win32con.SW_RESTORE, win32con.SW_SHOW, win32con.SW_SHOWMAXIMIZED win32con.SW_SHOWMINIMIZED, win32con.SW_SHOWMINNOACTIVE, win32con.SW_SHOWNA, win32con.SW_SHOWNOACTIVATE, or win32con.SW_SHOWNORMALMFC References - -Returns: - - Any:CWnd::ShowWindow -Return ValueReturns TRUE is the window was previously visible. - - - """ - pass - - - def UnLockWindowUpdate(self,) -> 'None': - """ - Unlocks a window that was locked with LockWindowUpdate - -Args: - - - -Returns: - - None - - """ - pass - - - def UpdateData(self,bSaveAndValidate:'Any'=1) -> 'Any': - """ - 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 - -nonzero means that the data is successfully validated. - -Args: - - bSaveAndValidate(Any):Flag that indicates whether dialog box is being initialized (FALSE) or data is being retrieved (TRUE).MFC References - -Returns: - - Any - - """ - pass - - - def UpdateDialogControls(self,pTarget:'Any',disableIfNoHandler:'Any') -> 'Any': - """ - None - -Args: - - pTarget(Any):The main frame window of the application, and is used for routing update messages. - disableIfNoHandler(Any):Flag that indicates whether a control that has no update handler should be automatically displayed as disabled. - -Returns: - - Any - - """ - pass - - - def UpdateWindow(self,) -> 'None': - """ - Updates a window. This forces a paint message to be sent to the window, if any part - -of the window is marked as invalid. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyDDEConv(object): - """A DDE topic.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ConnectTo(self,service:'str',topic:'str') -> 'None': - """ - Connects to a server - -Args: - - service(str):The service to connect to - topic(str):The topic to connect to - -Returns: - - None - - """ - pass - - - def Connected(self,) -> 'None': - """ - Determines if the conversation is connected. - -Args: - - - -Returns: - - None - - """ - pass - - - def Exec(self,Cmd:'str') -> 'None': - """ - Executes a command. - -Args: - - Cmd(str):The Python statement to execute - -Returns: - - None - - """ - pass - - - def Request(self,) -> 'None': - """ - Sends a request. - -Args: - - - -Returns: - - None - - """ - pass - - - def Poke(self,) -> 'None': - """ - Sends a poke. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyDDEServer(object): - """A DDE server.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddTopic(self,topic:'Any') -> 'None': - """ - None - -Args: - - topic(Any):The topic to add. - -Returns: - - None - - """ - pass - - - def Create(self,name:'str',filterFlags:'Any'=0) -> 'None': - """ - Create a server - -Args: - - name(str):Name of the server to start. - filterFlags(Any):Filter flags.CommentsNote there can only be one server per application. - -Returns: - - None - - """ - pass - - - def Destroy(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def GetLastError(self,) -> 'Any': - """ - None - -Args: - - - -Returns: - - Any - - """ - pass - - - def Shutdown(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - -class PyDDEStringItem(object): - """A DDE string item.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetData(self,data:'str') -> 'None': - """ - Sets an items data, and causes any underlying notification. - -Args: - - data(str):The data to set. - -Returns: - - None - - """ - pass - - -class PyDDETopic(object): - """A DDE topic.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddItem(self,item:'Any') -> 'None': - """ - Add an item to the topic. - -Args: - - item(Any):The item to add - -Returns: - - None - - """ - pass - - - def Destroy(self,) -> 'None': - """ - Destroys an item - -Args: - - - -Returns: - - None - - """ - pass - - -class PyDLL(object): - """A DLL object. A general utility object, and not associated with an MFC object.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetFileName(self,) -> 'str': - """ - Returns the name of the module associated with the DLL. - -Args: - - - -Returns: - - str - - """ - pass - - - def AttachToMFC(self,) -> 'None': - """ - Attaches the DLL object to the MFC list of DLL's. - -Args: - - - -Returns: - - None - - """ - pass - - -class SCROLLINFO(object): - """Tuple representing a SCROLLINFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class TV_ITEM(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class EXTENSION_CONTROL_BLOCK(object): - """A python representation of an ISAPI - -EXTENSION_CONTROL_BLOCK.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Version(self)->'int': - """Version info of this spec (read-only)""" - pass - - - @property - def TotalBytes(self)->'Any': - """Total bytes indicated from client""" - pass - - - @property - def AvailableBytes(self)->'Any': - """Available number of bytes""" - pass - - - @property - def HttpStatusCode(self)->'Any': - """The status of the current transaction when the request is completed.""" - pass - - - @property - def Method(self)->'Any': - """REQUEST_METHOD""" - pass - - - @property - def ConnID(self)->'Any': - """Context number (read-only)""" - pass - - - @property - def QueryString(self)->'Any': - """QUERY_STRING""" - pass - - - @property - def PathInfo(self)->'Any': - """PATH_INFO""" - pass - - - @property - def PathTranslated(self)->'Any': - """PATH_TRANSLATED""" - pass - - - @property - def AvailableData(self)->'Any': - """Pointer to cbAvailable bytes""" - pass - - - @property - def ContentType(self)->'Any': - """Content type of client data""" - pass - - - @property - def LogData(self)->'Any': - """log data string""" - pass - - - def WriteClient(self,data:'Union[Any, str]',reserved:'Any'=0) -> 'Any': - """ - None - -Args: - - data(Union[Any, str]):The data to write - reserved(Any):Return Valuethe result is the number of bytes written. - -Returns: - - Any: -Return Valuethe result is the number of bytes written. - - - """ - pass - - - def GetServerVariable(self,variable:'str',default:'Any') -> 'str': - """ - None - -Args: - - variable(str): - default(Any):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 begins with 'UNICODE_', in which case it is a unicode object - see the ISAPI docs for more details. - -Returns: - - 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 - -begins with 'UNICODE_', in which case it is a unicode object - see the - -ISAPI docs for more details. - - - """ - pass - - - def ReadClient(self,nbytes:'Any') -> 'str': - """ - None - -Args: - - nbytes(Any):Default is to read all available data. - -Returns: - - str - - """ - pass - - - def SendResponseHeaders(self,reply:'str',headers:'str',keepAlive:'Any'=False) -> 'None': - """ - Calls ServerSupportFunction with - -HSE_REQ_SEND_RESPONSE_HEADER_EX - -Args: - - reply(str): - headers(str): - keepAlive(Any): - -Returns: - - None - - """ - pass - - - def SetFlushFlag(self,flag:'Any') -> 'None': - """ - Calls ServerSupportFunction with HSE_REQ_SET_FLUSH_FLAG. - -Args: - - flag(Any): - -Returns: - - None - - """ - pass - - - def TransmitFile(self,callback:'Any',param:'Any',hFile:'Any',statusCode:'str',BytesToWrite:'Any',Offset:'Any',head:'str',tail:'str',flags:'Any') -> 'Any': - """ - Calls ServerSupportFunction with HSE_REQ_TRANSMIT_FILE - -Args: - - callback(Any): - param(Any):Any object - passed as 2nd arg to callback. - hFile(Any): - statusCode(str): - BytesToWrite(Any): - Offset(Any): - head(str): - tail(str): - flags(Any):CommentsThe callback is called with 4 args - (PyECB, param, cbIO, dwErrCode) - -Returns: - - Any - - """ - pass - - - def MapURLToPath(self,) -> 'None': - """ - Calls ServerSupportFunction with HSE_REQ_MAP_URL_TO_PATH - -Args: - - - -Returns: - - None - - """ - pass - - - def DoneWithSession(self,status:'Any') -> 'None': - """ - Calls ServerSupportFunction with HSE_REQ_DONE_WITH_SESSION - -Args: - - status(Any):An optional status. HSE_STATUS_SUCCESS_AND_KEEP_CONN is supported by IIS to keep the connection alive. - -Returns: - - None - - """ - pass - - - def Redirect(self,url:'str') -> 'None': - """ - Calls ServerSupportFunction with HSE_REQ_SEND_URL_REDIRECT_RESP - -Args: - - url(str):The URL to redirect to - -Returns: - - None - - """ - pass - - - def IsKeepAlive(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def GetAnonymousToken(self,metabase_path:'Union[Any, str]') -> 'Any': - """ - Calls ServerSupportFunction with HSE_REQ_GET_ANONYMOUS_TOKEN - -or HSE_REQ_GET_UNICODE_ANONYMOUS_TOKEN - -Args: - - metabase_path(Union[Any, str]): - -Returns: - - Any - - """ - pass - - - def GetImpersonationToken(self,) -> 'Any': - """ - Calls ServerSupportFunction with - -HSE_REQ_GET_IMPERSONATION_TOKEN - -Args: - - - -Returns: - - Any - - """ - pass - - - def IsKeepConn(self,) -> 'Any': - """ - Calls ServerSupportFunction with HSE_REQ_IS_KEEP_CONN - -Args: - - - -Returns: - - Any - - """ - pass - - - def ExecURL(self,url:'str',method:'str',clientHeaders:'str',info:'Any',entity:'Any',flags:'Any') -> 'Any': - """ - Calls ServerSupportFunction with HSE_REQ_EXEC_URL - -Args: - - url(str): - method(str): - clientHeaders(str): - info(Any):Must be None - entity(Any):Must be None - flags(Any):CommentsThis function is only available in IIS6 and later. - -Returns: - - Any - - """ - pass - - - def GetExecURLStatus(self,) -> 'Any': - """ - Calls ServerSupportFunction with HSE_REQ_GET_EXEC_URL_STATUS - -Args: - - - -Returns: - - 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:'Any',arg:'Any'=None) -> 'Any': - """ - Set a callback that will be used for handling asynchronous I/O - -operations. - -Args: - - func(Any):The function to call, as described by the EXTENSION_CONTROL_BLOCK::IOCallback method. - arg(Any):Any object which will be supplied as an argument to the callback function.CommentsIf you call this multiple times, the previous callback will be discarded.A reference to the callback and args are held until EXTENSION_CONTROL_BLOCK::DoneWithSession is called. If the callback function fails, DoneWithSession(HSE_STATUS_ERROR) will automatically be called and no further callbacks for the ECB will be made. - -Returns: - - Any - - """ - pass - - - def ReportUnhealthy(self,reason:'str'=None) -> 'Any': - """ - Calls ServerSupportFunction with HSE_REQ_REPORT_UNHEALTHY - -Args: - - reason(str):An optional reason to be written to the log. - -Returns: - - Any - - """ - pass - - - def IOCallback(self,ecb:'Any',arg:'Any',cbIO:'Any',dwError:'Any') -> 'Any': - """ - A placeholder for a user-supplied callback function. - -Args: - - ecb(Any):The extension control block that is associated with the current, active request. - arg(Any):The user-supplied argument supplied to the EXTENSION_CONTROL_BLOCK::IOCompletion function. - cbIO(Any):An integer that contains the number of bytes of I/O in the last call. - dwError(Any):The error code returned.CommentsThis is not a function you can call, it describes the signature of the callback function supplied to the EXTENSION_CONTROL_BLOCK::IOCompletion function.Return ValueThe result of this function is ignored. - -Returns: - - Any:The error code returned.Comments - -This is not a function you can call, it describes the signature of - -the callback function supplied to the EXTENSION_CONTROL_BLOCK::IOCompletion - -function. -Return ValueThe result of this function is ignored. - - - """ - pass - - -class HSE_VERSION_INFO(object): - """An object used by ISAPI GetExtensionVersion""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ExtensionDesc(self)->'str': - """The description of the extension.""" - pass - - -class HTTP_FILTER_AUTHENT(object): - """A Python representation of an ISAPI - -HTTP_FILTER_AUTHENT structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def User(self)->'str': - """""" - pass - - - @property - def Password(self)->'str': - """""" - pass - - -class HTTP_FILTER_CONTEXT(object): - """A Python representation of an ISAPI - -HTTP_FILTER_CONTEXT structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Revision(self)->'Any': - """(read-only)""" - pass - - - @property - def fIsSecurePort(self)->'Any': - """(read-only)""" - pass - - - @property - def NotificationType(self)->'Any': - """(read-only)""" - pass - - - @property - def FilterContext(self)->'Any': - """Any object you wish to associate with the request.""" - pass - - - def GetData(self,) -> 'Any': - """ - Obtains the data passed to - -The HttpFilterProc function. This is not techinally part of the - -HTTP_FILTER_CONTEXT structure, but packaged here for convenience. - -Args: - - - -Returns: - - Any:HTTP_FILTER_CONTEXT.GetData - -object = GetData()Obtains the data passed to - -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 - - - - -NotificationType - - -Result type - - - -SF_NOTIFY_URL_MAPHTTP_FILTER_URL_MAP -SF_NOTIFY_PREPROC_HEADERSHTTP_FILTER_PREPROC_HEADERS -SF_NOTIFY_LOGHTTP_FILTER_LOG -SF_NOTIFY_SEND_RAW_DATAHTTP_FILTER_RAW_DATA -SF_NOTIFY_READ_RAW_DATAHTTP_FILTER_RAW_DATA -SF_NOTIFY_AUTHENTICATIONHTTP_FILTER_AUTHENT - - - """ - pass - - - def GetServerVariable(self,variable:'str',default:'Any') -> 'str': - """ - None - -Args: - - variable(str): - default(Any):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 begins with 'UNICODE_', in which case it is a unicode object - see the ISAPI docs for more details. - -Returns: - - 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 - -begins with 'UNICODE_', in which case it is a unicode object - see the - -ISAPI docs for more details. - - - """ - pass - - - def WriteClient(self,data:'str',reserverd:'Any'=0) -> 'None': - """ - None - -Args: - - data(str): - reserverd(Any): - -Returns: - - None - - """ - pass - - - def AddResponseHeaders(self,data:'str',reserverd:'Any'=0) -> 'None': - """ - None - -Args: - - data(str): - reserverd(Any): - -Returns: - - None - - """ - pass - - - def SendResponseHeader(self,status:'str',header:'str') -> 'None': - """ - None - -Args: - - status(str): - header(str): - -Returns: - - None - - """ - pass - - - def DisableNotifications(self,flags:'Any') -> 'None': - """ - None - -Args: - - flags(Any): - -Returns: - - None - - """ - pass - - -class HTTP_FILTER_LOG(object): - """A Python representation of an ISAPI - -HTTP_FILTER_LOG structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ClientHostName(self)->'str': - """""" - pass - - - @property - def ClientUserName(self)->'str': - """""" - pass - - - @property - def ServerName(self)->'str': - """""" - pass - - - @property - def Operation(self)->'str': - """""" - pass - - - @property - def Target(self)->'str': - """""" - pass - - - @property - def Parameters(self)->'str': - """""" - pass - - - @property - def HttpStatus(self)->'Any': - """""" - pass - - -class HTTP_FILTER_PREPROC_HEADERS(object): - """A Python representation of an ISAPI - -HTTP_FILTER_PREPROC_HEADERS structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetHeader(self,header:'str',default:'Any') -> 'str': - """ - None - -Args: - - header(str): - default(Any):If specified, this will be returned on error. - -Returns: - - str - - """ - pass - - - def SetHeader(self,name:'str',val:'str') -> 'None': - """ - None - -Args: - - name(str): - val(str): - -Returns: - - None - - """ - pass - - - def AddHeader(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - -class HTTP_FILTER_RAW_DATA(object): - """A Python representation of an ISAPI - -HTTP_FILTER_RAW_DATA structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def InData(self)->'str': - """""" - pass - - -class HTTP_FILTER_URL_MAP(object): - """A Python representation of an ISAPI - -HTTP_FILTER_URL_MAP structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def URL(self)->'str': - """""" - pass - - - @property - def PhysicalPath(self)->'str': - """""" - pass - - -class HTTP_FILTER_VERSION(object): - """A Python interface to the ISAPI HTTP_FILTER_VERSION - -structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ServerFilterVersion(self)->'Any': - """(read-only)""" - pass - - - @property - def FilterVersion(self)->'Any': - """""" - pass - - - @property - def Flags(self)->'Any': - """""" - pass - - - @property - def FilterDesc(self)->'str': - """""" - pass diff --git a/typings/win32-stubs/win32gui.pyi b/typings/win32-stubs/win32gui.pyi deleted file mode 100644 index 46d7019c..00000000 --- a/typings/win32-stubs/win32gui.pyi +++ /dev/null @@ -1,6238 +0,0 @@ -__all__=['', 'EnumFontFamilies', 'set_logger', 'LOGFONT', 'CreateFontIndirect', 'GetObject', 'GetObjectType', 'PyGetMemory', 'PyGetString', 'PySetString', 'PySetMemory', 'PyGetArraySignedLong', 'PyGetBufferAddressAndLen', 'FlashWindow', 'FlashWindowEx', 'GetWindowLong', 'GetClassLong', 'SetWindowLong', 'CallWindowProc', 'SendMessage', 'SendMessageTimeout', 'PostMessage', 'PostThreadMessage', 'ReplyMessage', 'RegisterWindowMessage', 'DefWindowProc', 'EnumWindows', 'EnumThreadWindows', 'EnumChildWindows', 'DialogBox', 'DialogBoxParam', 'DialogBoxIndirect', 'DialogBoxIndirectParam', 'CreateDialogIndirect', 'DialogBoxIndirectParam', 'EndDialog', 'GetDlgItem', 'GetDlgItemInt', 'SetDlgItemInt', 'GetDlgCtrlID', 'GetDlgItemText', 'SetDlgItemText', 'GetNextDlgTabItem', 'GetNextDlgGroupItem', 'SetWindowText', 'GetWindowText', 'InitCommonControls', 'InitCommonControlsEx', 'LoadCursor', 'SetCursor', 'GetCursor', 'GetCursorInfo', 'CreateAcceleratorTable', 'DestroyAccleratorTable', 'LoadMenu', 'DestroyMenu', 'SetMenu', 'GetMenu', 'LoadIcon', 'CopyIcon', 'DrawIcon', 'DrawIconEx', 'CreateIconIndirect', 'CreateIconFromResource', 'LoadImage', 'DeleteObject', 'BitBlt', 'StretchBlt', 'PatBlt', 'SetStretchBltMode', 'GetStretchBltMode', 'TransparentBlt', 'MaskBlt', 'AlphaBlend', 'ImageList_Add', 'ImageList_Create', 'ImageList_Destroy', 'ImageList_Draw', 'ImageList_DrawEx', 'ImageList_GetIcon', 'ImageList_GetImageCount', 'ImageList_LoadImage', 'ImageList_LoadBitmap', 'ImageList_Remove', 'ImageList_Replace', 'ImageList_ReplaceIcon', 'ImageList_SetBkColor', 'ImageList_SetOverlayImage', 'MessageBox', 'MessageBeep', 'CreateWindow', 'DestroyWindow', 'EnableWindow', 'FindWindow', 'FindWindowEx', 'DragAcceptFiles', 'DragDetect', 'SetDoubleClickTime', 'GetDoubleClickTime', 'HideCaret', 'SetCaretPos', 'GetCaretPos', 'ShowCaret', 'ShowWindow', 'IsWindowVisible', 'IsWindowEnabled', 'SetFocus', 'GetFocus', 'UpdateWindow', 'BringWindowToTop', 'SetActiveWindow', 'GetActiveWindow', 'SetForegroundWindow', 'GetForegroundWindow', 'GetClientRect', 'GetDC', 'SaveDC', 'RestoreDC', 'DeleteDC', 'CreateCompatibleDC', 'CreateCompatibleBitmap', 'CreateBitmap', 'SelectObject', 'GetCurrentObject', 'GetWindowRect', 'GetStockObject', 'PostQuitMessage', 'WaitMessage', 'SetWindowPos', 'GetWindowPlacement', 'SetWindowPlacement', 'RegisterClass', 'UnregisterClass', 'PumpMessages', 'PumpWaitingMessages', 'GetMessage', 'TranslateMessage', 'DispatchMessage', 'TranslateAccelerator', 'PeekMessage', 'Shell_NotifyIcon', 'GetSystemMenu', 'DrawMenuBar', 'MoveWindow', 'CloseWindow', 'DeleteMenu', 'RemoveMenu', 'CreateMenu', 'CreatePopupMenu', 'TrackPopupMenu', 'CommDlgExtendedError', 'ExtractIcon', 'ExtractIconEx', 'DestroyIcon', 'GetIconInfo', 'ScreenToClient', 'ClientToScreen', 'PaintDesktop', 'RedrawWindow', 'GetTextExtentPoint32', 'GetTextMetrics', 'GetTextCharacterExtra', 'SetTextCharacterExtra', 'GetTextAlign', 'SetTextAlign', 'GetTextFace', 'GetMapMode', 'SetMapMode', 'GetGraphicsMode', 'SetGraphicsMode', 'GetLayout', 'SetLayout', 'GetPolyFillMode', 'SetPolyFillMode', 'GetWorldTransform', 'SetWorldTransform', 'ModifyWorldTransform', 'CombineTransform', 'GetWindowOrgEx', 'SetWindowOrgEx', 'GetViewportOrgEx', 'SetViewportOrgEx', 'GetWindowExtEx', 'SetWindowExtEx', 'GetViewportExtEx', 'SetViewportExtEx', 'GradientFill', 'GetOpenFileName', 'InsertMenuItem', 'SetMenuItemInfo', 'GetMenuItemInfo', 'GetMenuItemCount', 'GetMenuItemRect', 'GetMenuState', 'SetMenuDefaultItem', 'GetMenuDefaultItem', 'AppendMenu', 'InsertMenu', 'EnableMenuItem', 'CheckMenuItem', 'GetSubMenu', 'ModifyMenu', 'GetMenuItemID', 'SetMenuItemBitmaps', 'CheckMenuRadioItem', 'SetMenuInfo', 'GetMenuInfo', 'DrawFocusRect', 'DrawText', 'LineTo', 'Ellipse', 'Pie', 'Arc', 'ArcTo', 'AngleArc', 'Chord', 'ExtFloodFill', 'SetPixel', 'GetPixel', 'GetROP2', 'SetROP2', 'SetPixelV', 'MoveToEx', 'GetCurrentPositionEx', 'GetArcDirection', 'SetArcDirection', 'Polygon', 'Polyline', 'PolylineTo', 'PolyBezier', 'PolyBezierTo', 'PlgBlt', 'CreatePolygonRgn', 'ExtTextOut', 'GetTextColor', 'SetTextColor', 'GetBkMode', 'SetBkMode', 'GetBkColor', 'SetBkColor', 'DrawEdge', 'FillRect', 'FillRgn', 'PaintRgn', 'FrameRgn', 'InvertRgn', 'EqualRgn', 'PtInRegion', 'PtInRect', 'RectInRegion', 'SetRectRgn', 'CombineRgn', 'DrawAnimatedRects', 'CreateSolidBrush', 'CreatePatternBrush', 'CreateHatchBrush', 'CreatePen', 'GetSysColor', 'GetSysColorBrush', 'InvalidateRect', 'FrameRect', 'InvertRect', 'WindowFromDC', 'GetUpdateRgn', 'GetWindowRgn', 'SetWindowRgn', 'GetWindowRgnBox', 'ValidateRgn', 'InvalidateRgn', 'GetRgnBox', 'OffsetRgn', 'Rectangle', 'RoundRect', 'BeginPaint', 'EndPaint', 'BeginPath', 'EndPath', 'AbortPath', 'CloseFigure', 'FlattenPath', 'FillPath', 'WidenPath', 'StrokePath', 'StrokeAndFillPath', 'GetMiterLimit', 'SetMiterLimit', 'PathToRegion', 'GetPath', 'CreateRoundRectRgn', 'CreateRectRgnIndirect', 'CreateEllipticRgnIndirect', 'CreateWindowEx', 'GetParent', 'SetParent', 'GetCursorPos', 'GetDesktopWindow', 'GetWindow', 'GetWindowDC', 'IsIconic', 'IsWindow', 'IsChild', 'ReleaseCapture', 'GetCapture', 'SetCapture', '_TrackMouseEvent', 'ReleaseDC', 'CreateCaret', 'DestroyCaret', 'ScrollWindowEx', 'SetScrollInfo', 'GetScrollInfo', 'GetClassName', 'WindowFromPoint', 'ChildWindowFromPoint', 'ChildWindowFromPoint', 'ListView_SortItems', 'ListView_SortItemsEx', 'CreateDC', 'GetSaveFileNameW', 'GetOpenFileNameW', 'SystemParametersInfo', 'SetLayeredWindowAttributes', 'GetLayeredWindowAttributes', 'UpdateLayeredWindow', 'AnimateWindow', 'CreateBrushIndirect', 'ExtCreatePen', 'DrawTextW', 'EnumPropsEx', 'RegisterDeviceNotification', 'UnregisterDeviceNotification', 'RegisterHotKey', 'CLR_NONE', 'ILC_COLOR', 'ILC_COLOR16', 'ILC_COLOR24', 'ILC_COLOR32', 'ILC_COLOR4', 'ILC_COLOR8', 'ILC_COLORDDB', 'ILC_MASK', 'ILD_BLEND', 'ILD_BLEND25', 'ILD_BLEND50', 'ILD_FOCUS', 'ILD_MASK', 'ILD_NORMAL', 'ILD_SELECTED', 'ILD_TRANSPARENT', 'IMAGE_BITMAP', 'IMAGE_CURSOR', 'IMAGE_ICON', 'LR_CREATEDIBSECTION', 'LR_DEFAULTCOLOR', 'LR_DEFAULTSIZE', 'LR_LOADFROMFILE', 'LR_LOADMAP3DCOLORS', 'LR_LOADTRANSPARENT', 'LR_MONOCHROME', 'LR_SHARED', 'LR_VGACOLOR', 'NIF_ICON', 'NIF_INFO', 'NIF_MESSAGE', 'NIF_STATE', 'NIF_TIP', 'NIIF_ERROR', 'NIIF_ICON_MASK', 'NIIF_INFO', 'NIIF_NONE', 'NIIF_NOSOUND', 'NIIF_WARNING', 'NIM_ADD', 'NIM_DELETE', 'NIM_MODIFY', 'NIM_SETFOCUS', 'NIM_SETVERSION', 'TPM_BOTTOMALIGN', 'TPM_CENTERALIGN', 'TPM_LEFTALIGN', 'TPM_LEFTBUTTON', 'TPM_NONOTIFY', 'TPM_RETURNCMD', 'TPM_RIGHTALIGN', 'TPM_RIGHTBUTTON', 'TPM_TOPALIGN', 'TPM_VCENTERALIGN'] -import typing -import win32typing -"""""" - - -def EnumFontFamilies(hdc:'int',Family:'typing.Union[str]',EnumFontFamProc:'typing.Any',Param:'typing.Any') -> 'typing.Any': - """ - Enumerates the available font families. - -Args: - - hdc(int):Handle to a device context for which to enumerate available fonts - Family(typing.Union[str]):Family of fonts to enumerate. If none, first member of each font family will be returned. - EnumFontFamProc(typing.Any):The Python function called with each font family. This function is called with 4 arguments. - Param(typing.Any):An arbitrary object to be passed to the callback functionCommentsThe parameters that the callback function will receive are as follows:PyLOGFONT - contains the font parameters None - Placeholder for a TEXTMETRIC structure, not supported yet int - Font type, combination of DEVICE_FONTTYPE, RASTER_FONTTYPE, TRUETYPE_FONTTYPE object - The Param originally passed in to EnumFontFamilies - -Returns: - - typing.Any - - """ - pass - - -def set_logger(logger:'typing.Any') -> 'None': - """ - Sets a logger object for exceptions and error information - -Args: - - logger(typing.Any):A logger object, generally from the standard logger package.CommentsOnce a logger has been set for the module, unhandled exceptions, such as from a window's WNDPROC, will be written (via logger.exception()) to the log instead of to stderr. Note that using this with the Python 2.3 logging package will prevent the traceback from being written to the log. However, it is possible to use the Python 2.4 logging package directly with Python 2.3 - -Returns: - - None - - """ - pass - - -def LOGFONT() -> 'win32typing.PyLOGFONT': - """ - Creates a LOGFONT object. - -Args: - - - -Returns: - - win32typing.PyLOGFONT - - """ - pass - - -def CreateFontIndirect(lplf:'win32typing.PyLOGFONT') -> 'typing.Any': - """ - function creates a logical font that has the specified characteristics. - -The font can subsequently be selected as the current font for any device context. - -Args: - - lplf(win32typing.PyLOGFONT):A LOGFONT object as returned by win32gui::LOGFONT - -Returns: - - typing.Any - - """ - pass - - -def GetObject(handle:'int') -> 'typing.Any': - """ - Returns a struct containing the parameters used to create a GDI object - -Args: - - handle(int):Handle to the object.CommentsThe result depends on the type of the handle.Object type as determined by win32gui::GetObjectTypeReturned objectOBJ_FONTPyLOGFONTOBJ_BITMAPPyBITMAPOBJ_PENDict representing a LOGPEN struct - -Returns: - - typing.Any - - """ - pass - - -def GetObjectType(h:'int') -> 'typing.Any': - """ - Returns the type (OBJ_* constant) of a GDI handle - -Args: - - h(int):A handle to a GDI object - -Returns: - - typing.Any - - """ - pass - - -def PyGetMemory(addr:'typing.Any',_len:'typing.Any') -> 'typing.Any': - """ - Returns a buffer object from and address and length - -Args: - - addr(typing.Any):Address of the memory to reference. - _len(typing.Any):Number of bytes to return.CommentsIf zero is passed a ValueError will be raised. - -Returns: - - typing.Any - - """ - pass - - -def PyGetString(addr:'typing.Any',_len:'typing.Any') -> 'str': - """ - Returns a string from an address. - -Args: - - addr(typing.Any):Address of the memory to reference - _len(typing.Any):Number of characters to read. If not specified, the string must be NULL terminated.Return ValueIf win32gui.UNICODE is True, this will return a unicode object. - -Returns: - - str:Number of characters to read. If not specified, the - -string must be NULL terminated.Return ValueIf win32gui.UNICODE is True, this will return a unicode object. - - - """ - pass - - -def PySetString(addr:'typing.Any',String:'typing.Any',maxLen:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - addr(typing.Any):Address of the memory to reference - String(typing.Any):The string to copy - maxLen(typing.Any):Maximum number of chars to copy (optional) - -Returns: - - typing.Any - - """ - pass - - -def PySetMemory(addr:'typing.Any',String:'typing.Any') -> 'typing.Any': - """ - Copies bytes to an address. - -Args: - - addr(typing.Any):Address of the memory to reference - String(typing.Any):The string to copy - -Returns: - - typing.Any - - """ - pass - - -def PyGetArraySignedLong(array:'typing.Any',index:'typing.Any') -> 'typing.Any': - """ - Returns a signed long from an array object at specified index - -Args: - - array(typing.Any):array object to use - index(typing.Any):index of offset - -Returns: - - typing.Any - - """ - pass - - -def PyGetBufferAddressAndLen(obj:'typing.Any') -> 'typing.Any': - """ - Returns a buffer object address and len - -Args: - - obj(typing.Any):the buffer object - -Returns: - - typing.Any - - """ - pass - - -def FlashWindow(hwnd:'int',bInvert:'typing.Any') -> 'typing.Any': - """ - The FlashWindow function flashes the specified window one time. It does not change the active state of the window. - -Args: - - hwnd(int):Handle to a window - bInvert(typing.Any):Indicates if window should toggle between active and inactive - -Returns: - - typing.Any - - """ - pass - - -def FlashWindowEx(hwnd:'int',dwFlags:'typing.Any',uCount:'typing.Any',dwTimeout:'typing.Any') -> 'typing.Any': - """ - The FlashWindowEx function flashes the specified window a specified number of times. - -Args: - - hwnd(int):Handle to a window - dwFlags(typing.Any):Combination of win32con.FLASHW_* flags - uCount(typing.Any):Nbr of times to flash - dwTimeout(typing.Any):Elapsed time between flashes, in milliseconds - -Returns: - - typing.Any - - """ - pass - - -def GetWindowLong(hwnd:'int',index:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hwnd(typing.Any): - index(typing.Any): - -Returns: - - typing.Any - - """ - pass - - -def GetClassLong(hwnd:'int',index:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hwnd(typing.Any): - index(typing.Any): - -Returns: - - typing.Any - - """ - pass - - -def SetWindowLong(hwnd:'int',index:'typing.Any',value:'typing.Any') -> 'typing.Any': - """ - Places a long value at the specified offset into the extra window memory of the given window. - -Args: - - hwnd(int):The handle to the window - index(typing.Any):The index of the item to set. - value(typing.Any):The value to set.CommentsThis function calls the SetWindowLongPtr Api functionIf index is GWLP_WNDPROC, then the value parameter must be a callable object (or a dictionary) to use as the new window procedure. - -Returns: - - typing.Any - - """ - pass - - -def CallWindowProc(wndproc:'typing.Any',hwnd:'int',msg:'typing.Any',wparam:'typing.Union[typing.Any]',lparam:'typing.Union[typing.Any]') -> 'typing.Any': - """ - None - -Args: - - wndproc(typing.Any):The wndproc to call - this is generally the return value of SetWindowLong(GWL_WNDPROC) - hwnd(int):Handle to the window - msg(typing.Any):A window message - wparam(typing.Union[typing.Any]):Type is dependent on the message - lparam(typing.Union[typing.Any]):Type is dependent on the message - -Returns: - - typing.Any - - """ - pass - - -def SendMessage(hwnd:'int',message:'typing.Any',wparam:'typing.Union[typing.Any]'=None,lparam:'typing.Union[typing.Any]'=None) -> 'typing.Any': - """ - Sends a message to the window. - -Args: - - hwnd(typing.Any):The handle to the Window - message(typing.Any):The ID of the message to post - wparam(typing.Union[typing.Any]):Type depends on the message - lparam(typing.Union[typing.Any]):Type depends on the message - -Returns: - - typing.Any - - """ - pass - - -def SendMessageTimeout(hwnd:'int',message:'typing.Any',wparam:'typing.Any',lparam:'typing.Any',flags:'typing.Any',timeout:'typing.Any') -> 'tuple[typing.Any, typing.Any]': - """ - Sends a message to the window. - -Args: - - hwnd(typing.Any):The handle to the Window - message(typing.Any):The ID of the message to post - wparam(typing.Any):An integer whose value depends on the message - lparam(typing.Any):An integer whose value depends on the message - flags(typing.Any):Send options - timeout(typing.Any):Timeout duration in milliseconds.Return ValueThe result is the result of the SendMessageTimeout call, plus the last 'result' param. If the timeout period expires, a pywintypes.error exception will be thrown, with zero as the error code. See the Microsoft documentation for more information. - -Returns: - - tuple[typing.Any, typing.Any]:Timeout duration in milliseconds.Return ValueThe result is the result of the SendMessageTimeout call, plus the last 'result' param. - -If the timeout period expires, a pywintypes.error exception will be thrown, - -with zero as the error code. See the Microsoft documentation for more information. - - - """ - pass - - -def PostMessage(hwnd:'int',message:'typing.Any',wparam:'typing.Any'=0,lparam:'typing.Any'=0) -> 'None': - """ - None - -Args: - - hwnd(typing.Any):The handle to the Window - message(typing.Any):The ID of the message to post - wparam(typing.Any):An integer whose value depends on the message - lparam(typing.Any):An integer whose value depends on the message - -Returns: - - None - - """ - pass - - -def PostThreadMessage(threadId:'typing.Any',message:'typing.Any',wparam:'typing.Any',lparam:'typing.Any') -> 'None': - """ - None - -Args: - - threadId(typing.Any):The ID of the thread to post the message to. - message(typing.Any):The ID of the message to post - wparam(typing.Any):An integer whose value depends on the message - lparam(typing.Any):An integer whose value depends on the message - -Returns: - - None - - """ - pass - - -def ReplyMessage(result:'typing.Any') -> 'typing.Any': - """ - Used to reply to a message sent through the SendMessage function without returning control to the function that called SendMessage. - -Args: - - result(typing.Any):Specifies the result of the message processing. The possible values are based on the message sent. - -Returns: - - typing.Any - - """ - pass - - -def RegisterWindowMessage(name:'typing.Union[str, typing.Any]') -> 'typing.Any': - """ - Defines a new window message that is guaranteed to be unique throughout the system. The message value can be used when sending or posting messages. - -Args: - - name(typing.Union[str, typing.Any]):The string - -Returns: - - typing.Any - - """ - pass - - -def DefWindowProc(hwnd:'int',message:'typing.Any',wparam:'typing.Any',lparam:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hwnd(typing.Any):The handle to the Window - message(typing.Any):The ID of the message to send - wparam(typing.Any):An integer whose value depends on the message - lparam(typing.Any):An integer whose value depends on the message - -Returns: - - typing.Any - - """ - pass - - -def EnumWindows(callback:'typing.Any',extra:'typing.Any') -> 'None': - """ - Enumerates all top-level windows on the screen by passing the handle to each window, in turn, to an application-defined callback function. - -Args: - - callback(typing.Any):A Python function to be used as the callback. Function can return False to stop enumeration, or raise an exception. - extra(typing.Any):Any python object - this is passed to the callback function as the second param (first is the hwnd). - -Returns: - - None - - """ - pass - - -def EnumThreadWindows(dwThreadId:'typing.Any',callback:'typing.Any',extra:'typing.Any') -> 'None': - """ - Enumerates all top-level windows associated with a thread on the screen by passing the handle to each window, in turn, to an application-defined callback function. EnumThreadWindows continues until the last top-level window associated with the thread is enumerated or the callback function returns FALSE - -Args: - - dwThreadId(typing.Any):The id of the thread for which the windows need to be enumerated. - callback(typing.Any):A Python function to be used as the callback. - extra(typing.Any):Any python object - this is passed to the callback function as the second param (first is the hwnd). - -Returns: - - None - - """ - pass - - -def EnumChildWindows(hwnd:'int',callback:'typing.Any',extra:'typing.Any') -> 'None': - """ - Enumerates the child windows that belong to the specified parent window by passing the handle to each child window, in turn, to an application-defined callback function. EnumChildWindows continues until the last child window is enumerated or the callback function returns FALSE. - -Args: - - hwnd(int):The handle to the window to enumerate. - callback(typing.Any):A Python function to be used as the callback. - extra(typing.Any):Any python object - this is passed to the callback function as the second param (first is the hwnd). - -Returns: - - None - - """ - pass - - -def DialogBox(hInstance:'int',TemplateName:'win32typing.PyResourceId',hWndParent:'int',DialogFunc:'typing.Any',InitParam:'typing.Any'=0) -> 'typing.Any': - """ - Creates a modal dialog box. - -Args: - - hInstance(int):Handle to module that contains the dialog template - TemplateName(win32typing.PyResourceId):Name or resource id of the dialog resource - hWndParent(int):Handle to dialog's parent window - DialogFunc(typing.Any):Dialog box procedure to process messages - InitParam(typing.Any):Initialization data to be passed to above procedure during WM_INITDIALOG processing - -Returns: - - typing.Any - - """ - pass - - -def DialogBoxParam() -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -def DialogBoxIndirect(hInstance:'int',controlList:'win32typing.PyDialogTemplate',hWndParent:'int',DialogFunc:'typing.Any',InitParam:'typing.Any'=0) -> 'typing.Any': - """ - None - -Args: - - hInstance(int):Handle to module creating the dialog box - controlList(win32typing.PyDialogTemplate):Sequence of items defining the dialog box and subcontrols - hWndParent(int):Handle to dialog's parent window - DialogFunc(typing.Any):Dialog box procedure to process messages - InitParam(typing.Any):Initialization data to be passed to above procedure during WM_INITDIALOG processing - -Returns: - - typing.Any - - """ - pass - - -def DialogBoxIndirectParam() -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -def CreateDialogIndirect(hInstance:'int',controlList:'win32typing.PyDialogTemplate',hWndParent:'int',DialogFunc:'typing.Any',InitParam:'typing.Any'=0) -> 'typing.Any': - """ - None - -Args: - - hInstance(int):Handle to module creating the dialog box - controlList(win32typing.PyDialogTemplate):Sequence containing a PyDLGTEMPLATE, followed by variable number of PyDLGITEMTEMPLATEs - hWndParent(int):Handle to dialog's parent window - DialogFunc(typing.Any):Dialog box procedure to process messages - InitParam(typing.Any):Initialization data to be passed to above procedure during WM_INITDIALOG processing - -Returns: - - typing.Any - - """ - pass - - -def DialogBoxIndirectParam() -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -def EndDialog(hwnd:'int',result:'typing.Any') -> 'None': - """ - Ends a dialog box. - -Args: - - hwnd(typing.Any):Handle to the window. - result(typing.Any):result - -Returns: - - None - - """ - pass - - -def GetDlgItem(hDlg:'int',IDDlgItem:'typing.Any') -> 'typing.Any': - """ - Retrieves the handle to a control in the specified dialog box. - -Args: - - hDlg(int):Handle to a dialog window - IDDlgItem(typing.Any):Identifier of one of the dialog's controls - -Returns: - - typing.Any - - """ - pass - - -def GetDlgItemInt(hDlg:'int',IDDlgItem:'typing.Any',Signed:'typing.Any') -> 'None': - """ - Returns the integer value of a dialog control - -Args: - - hDlg(int):Handle to a dialog window - IDDlgItem(typing.Any):Identifier of one of the dialog's controls - Signed(typing.Any):Indicates whether control value should be interpreted as signed - -Returns: - - None - - """ - pass - - -def SetDlgItemInt(hDlg:'int',IDDlgItem:'typing.Any',Value:'typing.Any',Signed:'typing.Any') -> 'None': - """ - Places an integer value in a dialog control - -Args: - - hDlg(int):Handle to a dialog window - IDDlgItem(typing.Any):Identifier of one of the dialog's controls - Value(typing.Any):Value to placed in the control - Signed(typing.Any):Indicates if the input value is signed - -Returns: - - None - - """ - pass - - -def GetDlgCtrlID(hwnd:'int') -> 'typing.Any': - """ - Retrieves the identifier of the specified control. - -Args: - - hwnd(typing.Any):The handle to the control - -Returns: - - typing.Any - - """ - pass - - -def GetDlgItemText(hDlg:'int',IDDlgItem:'typing.Any') -> 'str': - """ - Returns the text of a dialog control - -Args: - - hDlg(int):Handle to a dialog window - IDDlgItem(typing.Any):The Id of a control within the dialog - -Returns: - - str - - """ - pass - - -def SetDlgItemText(hDlg:'int',IDDlgItem:'typing.Any',String:'typing.Union[typing.Any]') -> 'None': - """ - Sets the text for a window or control - -Args: - - hDlg(int):Handle to a dialog window - IDDlgItem(typing.Any):The Id of a control within the dialog - String(typing.Union[typing.Any]):The text to put in the control - -Returns: - - None - - """ - pass - - -def GetNextDlgTabItem(hDlg:'typing.Any',hCtl:'typing.Any',bPrevious:'typing.Any') -> 'typing.Any': - """ - Retrieves a handle to the first control that has the WS_TABSTOP style that precedes (or follows) the specified control. - -Args: - - hDlg(typing.Any):handle to dialog box - hCtl(typing.Any):handle to known control - bPrevious(typing.Any):direction flag - -Returns: - - typing.Any - - """ - pass - - -def GetNextDlgGroupItem(hDlg:'typing.Any',hCtl:'typing.Any',bPrevious:'typing.Any') -> 'typing.Any': - """ - Retrieves a handle to the first control in a group of controls that precedes (or follows) the specified control in a dialog box. - -Args: - - hDlg(typing.Any):handle to dialog box - hCtl(typing.Any):handle to known control - bPrevious(typing.Any):direction flag - -Returns: - - typing.Any - - """ - pass - - -def SetWindowText() -> 'None': - """ - Sets the window text. - -Args: - - - -Returns: - - None - - """ - pass - - -def GetWindowText(hwnd:'int') -> 'str': - """ - Get the window text. - -Args: - - hwnd(int):The handle to the windowCommentsNote that previous versions of PyWin32 returned a (empty) Unicode object when the string was empty, or an MBCS encoded string value otherwise. A String is now returned in all cases. - -Returns: - - str - - """ - pass - - -def InitCommonControls() -> 'None': - """ - Initializes the common controls. - -Args: - - - -Returns: - - None - - """ - pass - - -def InitCommonControlsEx(flag:'typing.Any') -> 'None': - """ - Initializes specific common controls. - -Args: - - flag(typing.Any):One of the ICC_ constants - -Returns: - - None - - """ - pass - - -def LoadCursor(hinstance:'typing.Any',resid:'typing.Any') -> 'typing.Any': - """ - Loads a cursor. - -Args: - - hinstance(typing.Any):The module to load from - resid(typing.Any):The resource ID - -Returns: - - typing.Any - - """ - pass - - -def SetCursor(hcursor:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hcursor(typing.Any): - -Returns: - - typing.Any - - """ - pass - - -def GetCursor() -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -def GetCursorInfo() -> 'tuple[int, int, int, int]': - """ - Retrieves information about the global cursor. - -Args: - - - -Returns: - - tuple[int, int, int, int] - - """ - pass - - -def CreateAcceleratorTable(accels:'tuple[tuple[typing.Any, typing.Any, typing.Any], ...]') -> 'typing.Any': - """ - Creates an accelerator table - -Args: - - accels(tuple[tuple[typing.Any, typing.Any, typing.Any], ...]):A sequence of (fVirt, key, cmd), as per the Win32 ACCEL structure. - -Returns: - - typing.Any - - """ - pass - - -def DestroyAccleratorTable(haccel:'typing.Any') -> 'None': - """ - Destroys an accelerator table - -Args: - - haccel(typing.Any): - -Returns: - - None - - """ - pass - - -def LoadMenu(hinstance:'typing.Any',resource_id:'typing.Union[str, typing.Any]') -> 'typing.Any': - """ - Loads a menu - -Args: - - hinstance(typing.Any): - resource_id(typing.Union[str, typing.Any]): - -Returns: - - typing.Any - - """ - pass - - -def DestroyMenu() -> 'None': - """ - Destroys a previously loaded menu. - -Args: - - - -Returns: - - None - - """ - pass - - -def SetMenu(hwnd:'int',hmenu:'typing.Any') -> 'None': - """ - Sets the menu for the specified window. - -Args: - - hwnd(typing.Any): - hmenu(typing.Any): - -Returns: - - None - - """ - pass - - -def GetMenu() -> 'None': - """ - Gets the menu for the specified window. - -Args: - - - -Returns: - - None - - """ - pass - - -def LoadIcon(hinstance:'typing.Any',resource_id:'typing.Union[str, typing.Any]') -> 'typing.Any': - """ - Loads an icon - -Args: - - hinstance(typing.Any): - resource_id(typing.Union[str, typing.Any]): - -Returns: - - typing.Any - - """ - pass - - -def CopyIcon(hicon:'typing.Any') -> 'typing.Any': - """ - Copies an icon - -Args: - - hicon(typing.Any):Existing icon - -Returns: - - typing.Any - - """ - pass - - -def DrawIcon(hDC:'typing.Any',X:'typing.Any',Y:'typing.Any',hicon:'typing.Any') -> 'None': - """ - None - -Args: - - hDC(typing.Any):handle to DC - X(typing.Any):x-coordinate of upper-left corner - Y(typing.Any):y-coordinate of upper-left corner - hicon(typing.Any):handle to icon - -Returns: - - None - - """ - pass - - -def DrawIconEx(hDC:'typing.Any',xLeft:'typing.Any',yTop:'typing.Any',hIcon:'typing.Any',cxWidth:'typing.Any',cyWidth:'typing.Any',istepIfAniCur:'typing.Any',hbrFlickerFreeDraw:'win32typing.PyGdiHANDLE',diFlags:'typing.Any') -> 'None': - """ - Draws an icon or cursor into the specified device context, - -performing the specified raster operations, and stretching or compressing the - -icon or cursor as specified. - -Args: - - hDC(typing.Any):handle to device context - xLeft(typing.Any):x-coord of upper left corner - yTop(typing.Any):y-coord of upper left corner - hIcon(typing.Any):handle to icon - cxWidth(typing.Any):icon width - cyWidth(typing.Any):icon height - istepIfAniCur(typing.Any):frame index, animated cursor - hbrFlickerFreeDraw(win32typing.PyGdiHANDLE):handle to background brush, can be None - diFlags(typing.Any):icon-drawing flags (win32con.DI_*) - -Returns: - - None - - """ - pass - - -def CreateIconIndirect(iconinfo:'win32typing.PyICONINFO') -> 'typing.Any': - """ - Creates an icon or cursor from an ICONINFO structure. - -Args: - - iconinfo(win32typing.PyICONINFO):Tuple defining the icon parameters - -Returns: - - typing.Any - - """ - pass - - -def CreateIconFromResource(bits:'str',fIcon:'typing.Any',ver:'typing.Any'=0x00030000) -> 'int': - """ - Creates an icon or cursor from resource bits describing the icon. - -Args: - - bits(str):The bits - fIcon(typing.Any):True if an icon, False if a cursor. - ver(typing.Any):Specifies the version number of the icon or cursor format for the resource bits pointed to by the presbits parameter. This parameter can be 0x00030000. - -Returns: - - int - - """ - pass - - -def LoadImage(hinst:'typing.Any',name:'typing.Union[str, typing.Any]',_type:'typing.Any',cxDesired:'typing.Any',cyDesired:'typing.Any',fuLoad:'typing.Any') -> 'typing.Any': - """ - Loads a bitmap, cursor or icon - -Args: - - hinst(typing.Any):Handle to an instance of the module that contains the image to be loaded. To load an OEM image, set this parameter to zero. - name(typing.Union[str, typing.Any]):Specifies the image to load. If the hInst parameter is non-zero and the fuLoad parameter omits LR_LOADFROMFILE, name specifies the image resource in the hInst module. If the image resource is to be loaded by name, the name parameter is a string that contains the name of the image resource. - _type(typing.Any):Specifies the type of image to be loaded. - cxDesired(typing.Any):Specifies the width, in pixels, of the icon or cursor. If this parameter is zero and the fuLoad parameter is LR_DEFAULTSIZE, the function uses the SM_CXICON or SM_CXCURSOR system metric value to set the width. If this parameter is zero and LR_DEFAULTSIZE is not used, the function uses the actual resource width. - cyDesired(typing.Any):Specifies the height, in pixels, of the icon or cursor. If this parameter is zero and the fuLoad parameter is LR_DEFAULTSIZE, the function uses the SM_CYICON or SM_CYCURSOR system metric value to set the height. If this parameter is zero and LR_DEFAULTSIZE is not used, the function uses the actual resource height. - fuLoad(typing.Any): - -Returns: - - typing.Any - - """ - pass - - -def DeleteObject(handle:'win32typing.PyGdiHANDLE') -> 'None': - """ - Deletes a logical pen, brush, font, bitmap, region, or palette, freeing all system resources associated with the object. After the object is deleted, the specified handle is no longer valid. - -Args: - - handle(win32typing.PyGdiHANDLE):handle to the object to delete. - -Returns: - - None - - """ - pass - - -def BitBlt(hdcDest:'typing.Any',x:'typing.Any',y:'typing.Any',width:'typing.Any',height:'typing.Any',hdcSrc:'typing.Any',nXSrc:'typing.Any',nYSrc:'typing.Any',dwRop:'typing.Any') -> 'None': - """ - Performs a bit-block transfer of the color data corresponding - -to a rectangle of pixels from the specified source device context into a - -destination device context. - -Args: - - hdcDest(typing.Any):handle to destination DC - x(typing.Any):x-coord of destination upper-left corner - y(typing.Any):y-coord of destination upper-left corner - width(typing.Any):width of destination rectangle - height(typing.Any):height of destination rectangle - hdcSrc(typing.Any):handle to source DC - nXSrc(typing.Any):x-coordinate of source upper-left corner - nYSrc(typing.Any):y-coordinate of source upper-left corner - dwRop(typing.Any):raster operation code - -Returns: - - None - - """ - pass - - -def StretchBlt(hdcDest:'typing.Any',x:'typing.Any',y:'typing.Any',width:'typing.Any',height:'typing.Any',hdcSrc:'typing.Any',nXSrc:'typing.Any',nYSrc:'typing.Any',nWidthSrc:'typing.Any',nHeightSrc:'typing.Any',dwRop:'typing.Any') -> 'None': - """ - Copies a bitmap from a source rectangle into a destination - -rectangle, stretching or compressing the bitmap to fit the dimensions of the - -destination rectangle, if necessary - -Args: - - hdcDest(typing.Any):handle to destination DC - x(typing.Any):x-coord of destination upper-left corner - y(typing.Any):y-coord of destination upper-left corner - width(typing.Any):width of destination rectangle - height(typing.Any):height of destination rectangle - hdcSrc(typing.Any):handle to source DC - nXSrc(typing.Any):x-coord of source upper-left corner - nYSrc(typing.Any):y-coord of source upper-left corner - nWidthSrc(typing.Any):width of source rectangle - nHeightSrc(typing.Any):height of source rectangle - dwRop(typing.Any):raster operation code - -Returns: - - None - - """ - pass - - -def PatBlt(hdc:'int',XLeft:'typing.Any',YLeft:'typing.Any',Width:'typing.Any',Height:'typing.Any',Rop:'typing.Any') -> 'None': - """ - Paints a rectangle by combining the current brush with existing colors - -Args: - - hdc(int):Handle to a device context - XLeft(typing.Any):Horizontal pos - YLeft(typing.Any):Vertical pos - Width(typing.Any):Width of rectangular area - Height(typing.Any):Height of rectangular area - Rop(typing.Any):Raster operation, one of PATCOPY,PATINVERT,DSTINVERT,BLACKNESS,WHITENESS - -Returns: - - None - - """ - pass - - -def SetStretchBltMode(hdc:'int',StretchMode:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hdc(int):Handle to a device context - StretchMode(typing.Any):One of BLACKONWHITE,COLORONCOLOR,HALFTONE,STRETCH_ANDSCANS,STRETCH_DELETESCANS,STRETCH_HALFTONE,STRETCH_ORSCANS, or WHITEONBLACK (from win32con)Return ValueIf the function succeeds, the return value is the previous stretching mode. If the function fails, the return value is zero. - -Returns: - - typing.Any:One of BLACKONWHITE,COLORONCOLOR,HALFTONE,STRETCH_ANDSCANS,STRETCH_DELETESCANS,STRETCH_HALFTONE,STRETCH_ORSCANS, or WHITEONBLACK (from win32con)Return ValueIf the function succeeds, the return value is the previous stretching mode. - -If the function fails, the return value is zero. - - - """ - pass - - -def GetStretchBltMode(hdc:'int') -> 'typing.Any': - """ - None - -Args: - - hdc(int):Handle to a device contextReturn ValueReturns one of BLACKONWHITE,COLORONCOLOR,HALFTONE,STRETCH_ANDSCANS,STRETCH_DELETESCANS,STRETCH_HALFTONE,STRETCH_ORSCANS,WHITEONBLACK, or 0 on error. - -Returns: - - typing.Any:Handle to a device contextReturn ValueReturns one of BLACKONWHITE,COLORONCOLOR,HALFTONE,STRETCH_ANDSCANS,STRETCH_DELETESCANS,STRETCH_HALFTONE,STRETCH_ORSCANS,WHITEONBLACK, or 0 on error. - - - """ - pass - - -def TransparentBlt(Dest:'int',XOriginDest:'typing.Any',YOriginDest:'typing.Any',WidthDest:'typing.Any',HeightDest:'typing.Any',Src:'int',XOriginSrc:'typing.Any',YOriginSrc:'typing.Any',WidthSrc:'typing.Any',HeightSrc:'typing.Any',Transparent:'typing.Any') -> 'None': - """ - Transfers color from one DC to another, with one color treated as transparent - -Args: - - Dest(int):Destination device context handle - XOriginDest(typing.Any):X pos of dest rect - YOriginDest(typing.Any):Y pos of dest rect - WidthDest(typing.Any):Width of dest rect - HeightDest(typing.Any):Height of dest rect - Src(int):Source DC handle - XOriginSrc(typing.Any):X pos of src rect - YOriginSrc(typing.Any):Y pos of src rect - WidthSrc(typing.Any):Width of src rect - HeightSrc(typing.Any):Height of src rect - Transparent(typing.Any):RGB color value that will be transparent - -Returns: - - None - - """ - pass - - -def MaskBlt(Dest:'int',XDest:'typing.Any',YDest:'typing.Any',Width:'typing.Any',Height:'typing.Any',Src:'int',XSrc:'typing.Any',YSrc:'typing.Any',Mask:'win32typing.PyGdiHANDLE',xMask:'typing.Any',yMask:'typing.Any',Rop:'typing.Any') -> 'None': - """ - Combines the color data for the source and destination - -bitmaps using the specified mask and raster operation. - -Args: - - Dest(int):Destination device context handle - XDest(typing.Any):X pos of dest rect - YDest(typing.Any):Y pos of dest rect - Width(typing.Any):Width of rect to be copied - Height(typing.Any):Height of rect to be copied - Src(int):Source DC handle - XSrc(typing.Any):X pos of src rect - YSrc(typing.Any):Y pos of src rect - Mask(win32typing.PyGdiHANDLE):Handle to monochrome bitmap used to mask color - xMask(typing.Any):X pos in mask - yMask(typing.Any):Y pos in mask - Rop(typing.Any):Foreground and background raster operations. See MSDN docs for how to construct this value.CommentsThis function is not supported on Win9x.Win32 API References - -Returns: - - None - - """ - pass - - -def AlphaBlend(Dest:'int',XOriginDest:'typing.Any',YOriginDest:'typing.Any',WidthDest:'typing.Any',HeightDest:'typing.Any',Src:'int',XOriginSrc:'typing.Any',YOriginSrc:'typing.Any',WidthSrc:'typing.Any',HeightSrc:'typing.Any',blendFunction:'win32typing.PyBLENDFUNCTION') -> 'None': - """ - Transfers color information using alpha blending - -Args: - - Dest(int):Destination device context handle - XOriginDest(typing.Any):X pos of dest rect - YOriginDest(typing.Any):Y pos of dest rect - WidthDest(typing.Any):Width of dest rect - HeightDest(typing.Any):Height of dest rect - Src(int):Source DC handle - XOriginSrc(typing.Any):X pos of src rect - YOriginSrc(typing.Any):Y pos of src rect - WidthSrc(typing.Any):Width of src rect - HeightSrc(typing.Any):Height of src rect - blendFunction(win32typing.PyBLENDFUNCTION):Alpha blending parameters - -Returns: - - None - - """ - pass - - -def ImageList_Add(himl:'typing.Any',hbmImage:'win32typing.PyGdiHANDLE',hbmMask:'win32typing.PyGdiHANDLE') -> 'typing.Any': - """ - Adds an image or images to an image list. - -Args: - - himl(typing.Any):Handle to the image list. - hbmImage(win32typing.PyGdiHANDLE):Handle to the bitmap that contains the image or images. The number of images is inferred from the width of the bitmap. - hbmMask(win32typing.PyGdiHANDLE):Handle to the bitmap that contains the mask. If no mask is used with the image list, this parameter is ignoredReturn ValueReturns the index of the first new image if successful, or -1 otherwise. - -Returns: - - typing.Any:Handle to the bitmap that contains the mask. If no mask is used with the image list, this parameter is ignoredReturn ValueReturns the index of the first new image if successful, or -1 otherwise. - - - """ - pass - - -def ImageList_Create() -> 'typing.Any': - """ - Create an image list - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -def ImageList_Destroy() -> 'typing.Any': - """ - Destroy an imagelist - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -def ImageList_Draw() -> 'typing.Any': - """ - Draw an image on an HDC - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -def ImageList_DrawEx() -> 'typing.Any': - """ - Draw an image on an HDC - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -def ImageList_GetIcon() -> 'typing.Any': - """ - Extract an icon from an imagelist - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -def ImageList_GetImageCount() -> 'typing.Any': - """ - Return count of images in imagelist - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -def ImageList_LoadImage() -> 'typing.Any': - """ - Loads bitmaps, cursors or icons, creates imagelist - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -def ImageList_LoadBitmap() -> 'typing.Any': - """ - Creates an image list from the specified bitmap resource. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -def ImageList_Remove() -> 'typing.Any': - """ - Remove an image from an imagelist - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -def ImageList_Replace() -> 'typing.Any': - """ - Replace an image in an imagelist with a bitmap image - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -def ImageList_ReplaceIcon() -> 'typing.Any': - """ - Replace an image in an imagelist with an icon image - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -def ImageList_SetBkColor() -> 'typing.Any': - """ - Set the background color for the imagelist - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -def ImageList_SetOverlayImage(hImageList:'typing.Any',iImage:'typing.Any',iOverlay:'typing.Any') -> 'None': - """ - Adds a specified image to the list of images to be used as overlay masks. An image list can have up to four overlay masks in version 4.70 and earlier and up to 15 in version 4.71. The function assigns an overlay mask index to the specified image. - -Args: - - hImageList(typing.Any): - iImage(typing.Any): - iOverlay(typing.Any): - -Returns: - - None - - """ - pass - - -def MessageBox(parent:'typing.Any',text:'typing.Union[str]',caption:'typing.Union[str]',flags:'typing.Any') -> 'typing.Any': - """ - Displays a message box - -Args: - - parent(typing.Any):The parent window - text(typing.Union[str]):The text for the message box - caption(typing.Union[str]):The caption for the message box - flags(typing.Any): - -Returns: - - typing.Any - - """ - pass - - -def MessageBeep(_type:'typing.Any') -> 'None': - """ - Plays a waveform sound. - -Args: - - _type(typing.Any):The type of the beep - -Returns: - - None - - """ - pass - - -def CreateWindow(className:'typing.Union[str, typing.Any]',windowTitle:'str',style:'typing.Any',x:'typing.Any',y:'typing.Any',width:'typing.Any',height:'typing.Any',parent:'typing.Any',menu:'typing.Any',hinstance:'typing.Any',reserved:'typing.Any') -> 'typing.Any': - """ - Creates a new window. - -Args: - - className(typing.Union[str, typing.Any]): - windowTitle(str): - style(typing.Any):The style for the window. - x(typing.Any): - y(typing.Any): - width(typing.Any): - height(typing.Any): - parent(typing.Any):Handle to the parent window. - menu(typing.Any):Handle to the menu to use for this window. - hinstance(typing.Any): - reserved(typing.Any):Must be None - -Returns: - - typing.Any - - """ - pass - - -def DestroyWindow(hwnd:'int') -> 'None': - """ - None - -Args: - - hwnd(typing.Any):The handle to the window - -Returns: - - None - - """ - pass - - -def EnableWindow(hWnd:'int',bEnable:'typing.Any') -> 'typing.Any': - """ - Enables and disables keyboard and mouse input to a window - -Args: - - hWnd(int):Handle to window - bEnable(typing.Any):True to enable input to the window, False to disable inputReturn ValueReturns True if window was already disabled when call was made, False otherwise - -Returns: - - typing.Any:True to enable input to the window, False to disable inputReturn ValueReturns True if window was already disabled when call was made, False otherwise - - - """ - pass - - -def FindWindow(ClassName:'win32typing.PyResourceId',WindowName:'str') -> 'int': - """ - Retrieves a handle to the top-level window whose class name and window name match the specified strings. - -Args: - - ClassName(win32typing.PyResourceId):Name or atom of window class to find, can be None - WindowName(str):Title of window to find, can be None - -Returns: - - int - - """ - pass - - -def FindWindowEx(Parent:'int',ChildAfter:'int',ClassName:'win32typing.PyResourceId',WindowName:'str') -> 'int': - """ - Retrieves a handle to the top-level window whose class name and window name match the specified strings. - -Args: - - Parent(int):Window whose child windows will be searched. If 0, desktop window is assumed. - ChildAfter(int):Child window after which to search in Z-order, can be 0 to search all - ClassName(win32typing.PyResourceId):Name or atom of window class to find, can be None - WindowName(str):Title of window to find, can be None - -Returns: - - int - - """ - pass - - -def DragAcceptFiles(hwnd:'int',fAccept:'typing.Any') -> 'None': - """ - Registers whether a window accepts dropped files. - -Args: - - hwnd(typing.Any):Handle to the Window - fAccept(typing.Any):Value that indicates if the window identified by the hWnd parameter accepts dropped files. This value is True to accept dropped files or False to discontinue accepting dropped files. - -Returns: - - None - - """ - pass - - -def DragDetect(hwnd:'int',point:'tuple[typing.Any, typing.Any]') -> 'None': - """ - captures the mouse and tracks its movement until the user releases the left button, presses the ESC key, or moves the mouse outside the drag rectangle around the specified point. - -Args: - - hwnd(typing.Any):Handle to the Window - point(tuple[typing.Any, typing.Any]):Initial position of the mouse, in screen coordinates. The function determines the coordinates of the drag rectangle by using this point.Return ValueIf the user moved the mouse outside of the drag rectangle while holding down the left button , the return value is nonzero. If the user did not move the mouse outside of the drag rectangle while holding down the left button , the return value is zero. - -Returns: - - None:Initial position of the mouse, in screen coordinates. The function determines the coordinates of the drag rectangle by using this point.Return ValueIf the user moved the mouse outside of the drag rectangle while holding down the left button , the return value is nonzero. - -If the user did not move the mouse outside of the drag rectangle while holding down the left button , the return value is zero. - - - """ - pass - - -def SetDoubleClickTime(newVal:'typing.Any') -> 'None': - """ - None - -Args: - - newVal(typing.Any): - -Returns: - - None - - """ - pass - - -def GetDoubleClickTime() -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -def HideCaret(hWnd:'int') -> 'None': - """ - Hides the caret - -Args: - - hWnd(int):Window that owns the caret, can be 0. - -Returns: - - None - - """ - pass - - -def SetCaretPos(x:'typing.Any',y:'typing.Any') -> 'None': - """ - Changes the position of the caret - -Args: - - x(typing.Any):horizontal position - y(typing.Any):vertical position - -Returns: - - None - - """ - pass - - -def GetCaretPos() -> 'tuple[typing.Any, typing.Any]': - """ - Returns the current caret position - -Args: - - - -Returns: - - tuple[typing.Any, typing.Any] - - """ - pass - - -def ShowCaret(hWnd:'int') -> 'None': - """ - Shows the caret at its current position - -Args: - - hWnd(int):Window that owns the caret, can be 0. - -Returns: - - None - - """ - pass - - -def ShowWindow(hWnd:'typing.Any',cmdShow:'typing.Any') -> 'typing.Any': - """ - Shows or hides a window and changes its state - -Args: - - hWnd(typing.Any):The handle to the window - cmdShow(typing.Any):Combination of win32con.SW_* flags - -Returns: - - typing.Any - - """ - pass - - -def IsWindowVisible(hwnd:'int') -> 'typing.Any': - """ - Indicates if the window has the WS_VISIBLE style. - -Args: - - hwnd(typing.Any):The handle to the window - -Returns: - - typing.Any - - """ - pass - - -def IsWindowEnabled(hwnd:'int') -> 'typing.Any': - """ - Indicates if the window is enabled. - -Args: - - hwnd(typing.Any):The handle to the window - -Returns: - - typing.Any - - """ - pass - - -def SetFocus(hwnd:'int') -> 'None': - """ - Sets focus to the specified window. - -Args: - - hwnd(typing.Any):The handle to the window - -Returns: - - None - - """ - pass - - -def GetFocus() -> 'None': - """ - Returns the HWND of the window with focus. - -Args: - - - -Returns: - - None - - """ - pass - - -def UpdateWindow(hwnd:'int') -> 'None': - """ - None - -Args: - - hwnd(typing.Any):The handle to the window - -Returns: - - None - - """ - pass - - -def BringWindowToTop(hwnd:'int') -> 'None': - """ - None - -Args: - - hwnd(typing.Any):The handle to the window - -Returns: - - None - - """ - pass - - -def SetActiveWindow(hwnd:'int') -> 'typing.Any': - """ - None - -Args: - - hwnd(typing.Any):The handle to the window - -Returns: - - typing.Any - - """ - pass - - -def GetActiveWindow() -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -def SetForegroundWindow(hwnd:'int') -> 'typing.Any': - """ - None - -Args: - - hwnd(typing.Any):The handle to the window - -Returns: - - typing.Any - - """ - pass - - -def GetForegroundWindow() -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -def GetClientRect(hwnd:'int') -> 'tuple[int, int, int, int]': - """ - Returns the rectangle of the client area of a window, in client coordinates - -Args: - - hwnd(typing.Any):The handle to the window - -Returns: - - tuple[int, int, int, int] - - """ - pass - - -def GetDC(hwnd:'int') -> 'typing.Any': - """ - Gets the device context for the window. - -Args: - - hwnd(typing.Any):The handle to the window - -Returns: - - typing.Any - - """ - pass - - -def SaveDC(hdc:'int') -> 'typing.Any': - """ - Save the state of a device context - -Args: - - hdc(int):Handle to device contextReturn ValueReturns a value identifying the state that can be passed to win32gui::RestoreDC. On error, returns 0. - -Returns: - - typing.Any:Handle to device contextReturn ValueReturns a value identifying the state that can be passed to win32gui::RestoreDC. On error, returns 0. - - - """ - pass - - -def RestoreDC(hdc:'int',SavedDC:'typing.Any') -> 'None': - """ - Restores a device context state - -Args: - - hdc(int):Handle to a device context - SavedDC(typing.Any):Identifier of state to be restored, as returned by win32gui::SaveDC. - -Returns: - - None - - """ - pass - - -def DeleteDC(hdc:'typing.Any') -> 'None': - """ - Deletes a DC - -Args: - - hdc(typing.Any):The source DC - -Returns: - - None - - """ - pass - - -def CreateCompatibleDC(dc:'typing.Any') -> 'typing.Any': - """ - Creates a memory device context (DC) compatible with the specified device. - -Args: - - dc(typing.Any):handle to DC - -Returns: - - typing.Any - - """ - pass - - -def CreateCompatibleBitmap(hdc:'typing.Any',width:'typing.Any',height:'typing.Any') -> 'win32typing.PyGdiHANDLE': - """ - Creates a bitmap compatible with the device that is associated with the specified device context. - -Args: - - hdc(typing.Any):handle to DC - width(typing.Any):width of bitmap, in pixels - height(typing.Any):height of bitmap, in pixels - -Returns: - - win32typing.PyGdiHANDLE - - """ - pass - - -def CreateBitmap(width:'typing.Any',height:'typing.Any',cPlanes:'typing.Any',cBitsPerPixel:'typing.Any',bitmap_bits:'typing.Any') -> 'win32typing.PyGdiHANDLE': - """ - Creates a bitmap - -Args: - - width(typing.Any):bitmap width, in pixels - height(typing.Any):bitmap height, in pixels - cPlanes(typing.Any):number of color planes - cBitsPerPixel(typing.Any):number of bits to identify color - bitmap_bits(typing.Any):Must be None - -Returns: - - win32typing.PyGdiHANDLE - - """ - pass - - -def SelectObject(hdc:'typing.Any',_object:'typing.Any') -> 'typing.Any': - """ - Selects an object into the specified device context (DC). The new object replaces the previous object of the same type. - -Args: - - hdc(typing.Any):handle to DC - _object(typing.Any):The GDI object - -Returns: - - typing.Any - - """ - pass - - -def GetCurrentObject(hdc:'int',ObjectType:'typing.Any') -> 'int': - """ - Retrieves currently selected object from a DC - -Args: - - hdc(int):Handle to a device context - ObjectType(typing.Any):Type of object to retrieve, one of win32con.OBJ_*; - -Returns: - - int - - """ - pass - - -def GetWindowRect(hwnd:'int') -> 'tuple[int, int, int, int]': - """ - Returns the rectangle for a window in screen coordinates - -Args: - - hwnd(typing.Any):The handle to the window - -Returns: - - tuple[int, int, int, int] - - """ - pass - - -def GetStockObject(Object:'typing.Any') -> 'int': - """ - Creates a handle to one of the standard system Gdi objects - -Args: - - Object(typing.Any):One of *_BRUSH, *_PEN, *_FONT, or *_PALLETTE constants - -Returns: - - int - - """ - pass - - -def PostQuitMessage(rc:'typing.Any') -> 'None': - """ - None - -Args: - - rc(typing.Any): - -Returns: - - None - - """ - pass - - -def WaitMessage() -> 'None': - """ - Waits for a message - -Args: - - - -Returns: - - None - - """ - pass - - -def SetWindowPos(hWnd:'int',InsertAfter:'int',X:'typing.Any',Y:'typing.Any',cx:'typing.Any',cy:'typing.Any',Flags:'typing.Any') -> 'None': - """ - Sets the position and size of a window - -Args: - - hWnd(int):Handle to the window - InsertAfter(int):Window that hWnd will be placed below. Can be a window handle or one of HWND_BOTTOM,HWND_NOTOPMOST,HWND_TOP, or HWND_TOPMOST - X(typing.Any):New X coord - Y(typing.Any):New Y coord - cx(typing.Any):New width of window - cy(typing.Any):New height of window - Flags(typing.Any):Combination of win32con.SWP_* flags - -Returns: - - None - - """ - pass - - -def GetWindowPlacement() -> 'typing.Any': - """ - Returns placement information about the current window. - -Args: - - - -Returns: - - typing.Any:win32gui.GetWindowPlacement - -tuple = GetWindowPlacement()Returns placement information about the current window. -Return ValueThe result is a tuple of - -(flags, showCmd, (minposX, minposY), (maxposX, maxposY), (normalposX, normalposY)) - - - -Item - - -Description - - - -flagsOne of the WPF_* constants -showCmdCurrent state - one of the SW_* constants. -minposSpecifies the coordinates of the window's upper-left corner when the window is minimized. -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 SetWindowPlacement(hWnd:'int',placement:'typing.Any') -> 'None': - """ - Sets the windows placement - -Args: - - hWnd(int):Handle to a window - placement(typing.Any):A tuple representing the WINDOWPLACEMENT structure. - -Returns: - - None - - """ - pass - - -def RegisterClass(wndClass:'win32typing.PyWNDCLASS') -> 'typing.Any': - """ - Registers a window class. - -Args: - - wndClass(win32typing.PyWNDCLASS):An object describing the window class. - -Returns: - - typing.Any - - """ - pass - - -def UnregisterClass(atom:'win32typing.PyResourceId',hinst:'int') -> 'None': - """ - None - -Args: - - atom(win32typing.PyResourceId):The atom or classname identifying the class previously registered. - hinst(int):The handle to the instance unregistering the class, can be None - -Returns: - - None - - """ - pass - - -def PumpMessages() -> 'None': - """ - Runs a message loop until a WM_QUIT message is received. - -Args: - - - -Returns: - - None:win32gui::PumpWaitingMessages -Return ValueReturns exit code from PostQuitMessage when a WM_QUIT message is received - - - """ - pass - - -def PumpWaitingMessages() -> 'typing.Any': - """ - Pumps all waiting messages for the current thread. - -Args: - - - -Returns: - - typing.Any:Search for PeekMessage and DispatchMessage at msdn, google or google groups. -Return ValueReturns non-zero (exit code from PostQuitMessage) if a WM_QUIT message was received, else 0 - - - """ - pass - - -def GetMessage(hwnd:'int',_min:'typing.Any',_max:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hwnd(typing.Any): - _min(typing.Any): - _max(typing.Any): - -Returns: - - typing.Any - - """ - pass - - -def TranslateMessage(msg:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - msg(typing.Any): - -Returns: - - typing.Any - - """ - pass - - -def DispatchMessage(msg:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - msg(typing.Any): - -Returns: - - typing.Any - - """ - pass - - -def TranslateAccelerator(hwnd:'int',haccel:'typing.Any',msg:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hwnd(typing.Any): - haccel(typing.Any): - msg(typing.Any): - -Returns: - - typing.Any - - """ - pass - - -def PeekMessage(hwnd:'int',filterMin:'typing.Any',filterMax:'typing.Any',removalOptions:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hwnd(typing.Any): - filterMin(typing.Any): - filterMax(typing.Any): - removalOptions(typing.Any): - -Returns: - - typing.Any - - """ - pass - - -def Shell_NotifyIcon(Message:'typing.Any',nid:'win32typing.PyNOTIFYICONDATA') -> 'None': - """ - Adds, removes or modifies a taskbar icon. - -Args: - - Message(typing.Any):One of win32gui.NIM_* flags - nid(win32typing.PyNOTIFYICONDATA):Tuple containing NOTIFYICONDATA info - -Returns: - - None - - """ - pass - - -def GetSystemMenu(hwnd:'int',bRevert:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hwnd(typing.Any):The handle to the window - bRevert(typing.Any):Return ValueThe result is a HMENU to the menu. - -Returns: - - typing.Any:Return ValueThe result is a HMENU to the menu. - - - """ - pass - - -def DrawMenuBar(hwnd:'int') -> 'None': - """ - None - -Args: - - hwnd(typing.Any):The handle to the window - -Returns: - - None - - """ - pass - - -def MoveWindow(hwnd:'int',x:'typing.Any',y:'typing.Any',width:'typing.Any',height:'typing.Any',bRepaint:'typing.Any') -> 'None': - """ - None - -Args: - - hwnd(typing.Any):The handle to the window - x(typing.Any): - y(typing.Any): - width(typing.Any): - height(typing.Any): - bRepaint(typing.Any): - -Returns: - - None - - """ - pass - - -def CloseWindow() -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - -def DeleteMenu(hmenu:'typing.Any',position:'typing.Any',flags:'typing.Any') -> 'None': - """ - None - -Args: - - hmenu(typing.Any):The handle to the menu - position(typing.Any):The position to delete. - flags(typing.Any): - -Returns: - - None - - """ - pass - - -def RemoveMenu(hmenu:'typing.Any',position:'typing.Any',flags:'typing.Any') -> 'None': - """ - None - -Args: - - hmenu(typing.Any):The handle to the menu - position(typing.Any):The position to delete. - flags(typing.Any): - -Returns: - - None - - """ - pass - - -def CreateMenu() -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any:win32gui.CreateMenu - -int = CreateMenu() -Return ValueThe result is a HMENU to the new menu. - - - """ - pass - - -def CreatePopupMenu() -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any:win32gui.CreatePopupMenu - -int = CreatePopupMenu() -Return ValueThe result is a HMENU to the new menu. - - - """ - pass - - -def TrackPopupMenu(hmenu:'typing.Any',flags:'typing.Any',x:'typing.Any',y:'typing.Any',reserved:'typing.Any',hwnd:'int',prcRect:'win32typing.PyRECT') -> 'typing.Any': - """ - Display popup shortcut menu - -Args: - - hmenu(typing.Any):The handle to the menu - flags(typing.Any):flags - x(typing.Any):x pos - y(typing.Any):y pos - reserved(typing.Any):reserved - hwnd(typing.Any):owner window - prcRect(win32typing.PyRECT):Pointer to rec (can be None) - -Returns: - - typing.Any - - """ - pass - - -def CommDlgExtendedError() -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -def ExtractIcon(hinstance:'typing.Any',moduleName:'typing.Union[str]',index:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hinstance(typing.Any): - moduleName(typing.Union[str]): - index(typing.Any):CommentsYou must destroy the icon handle returned by calling the win32gui::DestroyIcon function.Return ValueThe result is a HICON. - -Returns: - - typing.Any:Comments - -You must destroy the icon handle returned by calling the win32gui::DestroyIcon function. -Return ValueThe result is a HICON. - - - """ - pass - - -def ExtractIconEx(moduleName:'str',index:'typing.Any',numIcons:'typing.Any'=1) -> 'typing.Any': - """ - None - -Args: - - moduleName(str): - index(typing.Any): - numIcons(typing.Any):CommentsYou must destroy each icon handle returned by calling the win32gui::DestroyIcon function.Return ValueIf index==-1, the result is an integer with the number of icons in the file, otherwise it is 2 arrays of icon handles. - -Returns: - - typing.Any: -Comments - -You must destroy each icon handle returned by calling the win32gui::DestroyIcon function. -Return ValueIf index==-1, the result is an integer with the number of icons in - -the file, otherwise it is 2 arrays of icon handles. - - - """ - pass - - -def DestroyIcon(hicon:'typing.Any') -> 'None': - """ - None - -Args: - - hicon(typing.Any):The icon to destroy. - -Returns: - - None - - """ - pass - - -def GetIconInfo(hicon:'int') -> 'win32typing.PyICONINFO': - """ - Returns parameters for an icon or cursor - -Args: - - hicon(int):The icon to queryReturn ValueThe result is a tuple of (fIcon, xHotspot, yHotspot, hbmMask, hbmColor) The hbmMask and hbmColor items are bitmaps created for the caller, so must be freed. - -Returns: - - win32typing.PyICONINFO:The icon to queryReturn ValueThe result is a tuple of (fIcon, xHotspot, yHotspot, hbmMask, hbmColor) - -The hbmMask and hbmColor items are bitmaps created for the caller, so must be freed. - - - """ - pass - - -def ScreenToClient(hWnd:'int',Point:'tuple[typing.Any, typing.Any]') -> 'tuple[typing.Any, typing.Any]': - """ - Convert screen coordinates to client coords - -Args: - - hWnd(int):Handle to a window - Point(tuple[typing.Any, typing.Any]):Screen coordinates to be converted - -Returns: - - tuple[typing.Any, typing.Any] - - """ - pass - - -def ClientToScreen(hWnd:'int',Point:'tuple[typing.Any, typing.Any]') -> 'tuple[typing.Any, typing.Any]': - """ - Convert client coordinates to screen coords - -Args: - - hWnd(int):Handle to a window - Point(tuple[typing.Any, typing.Any]):Client coordinates to be converted - -Returns: - - tuple[typing.Any, typing.Any] - - """ - pass - - -def PaintDesktop(hdc:'int') -> 'None': - """ - Fills a DC with the destop background - -Args: - - hdc(int):Handle to a device context - -Returns: - - None - - """ - pass - - -def RedrawWindow(hWnd:'int',rcUpdate:'tuple[int, int, int, int]',hrgnUpdate:'win32typing.PyGdiHANDLE',flags:'typing.Any') -> 'None': - """ - Causes a portion of a window to be redrawn - -Args: - - hWnd(int):Handle to window to be redrawn - rcUpdate(tuple[int, int, int, int]):Rectangle (left, top, right, bottom) identifying part of window to be redrawn, can be None - hrgnUpdate(win32typing.PyGdiHANDLE):Handle to region to be redrawn, can be None to indicate entire client area - flags(typing.Any):Combination of win32con.RDW_* flags - -Returns: - - None - - """ - pass - - -def GetTextExtentPoint32(hdc:'int',_str:'str') -> 'tuple[typing.Any, typing.Any]': - """ - Computes the width and height of the specified string of text. - -Args: - - hdc(int):The device context - _str(str):The string to measure. - -Returns: - - tuple[typing.Any, typing.Any] - - """ - pass - - -def GetTextMetrics() -> 'typing.Any': - """ - Returns info for the font selected into a DC - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -def GetTextCharacterExtra(hdc:'int') -> 'typing.Any': - """ - Returns the space between characters - -Args: - - hdc(int):Handle to a device context - -Returns: - - typing.Any - - """ - pass - - -def SetTextCharacterExtra(hdc:'int',CharExtra:'typing.Any') -> 'typing.Any': - """ - Sets the spacing between characters - -Args: - - hdc(int):Handle to a device context - CharExtra(typing.Any):Space between adjacent chars, in logical unitsReturn ValueReturns the previous spacing - -Returns: - - typing.Any:Space between adjacent chars, in logical unitsReturn ValueReturns the previous spacing - - - """ - pass - - -def GetTextAlign(hdc:'int') -> 'typing.Any': - """ - Returns horizontal and vertical alignment for text in a device context - -Args: - - hdc(int):Handle to a device contextReturn ValueReturns combination of win32con.TA_* flags - -Returns: - - typing.Any:Handle to a device contextReturn ValueReturns combination of win32con.TA_* flags - - - """ - pass - - -def SetTextAlign(hdc:'int',Mode:'typing.Any') -> 'typing.Any': - """ - Sets horizontal and vertical alignment for text in a device context - -Args: - - hdc(int):Handle to a device context - Mode(typing.Any):Combination of win32con.TA_* constantsReturn ValueReturns the previous alignment flags - -Returns: - - typing.Any:Combination of win32con.TA_* constantsReturn ValueReturns the previous alignment flags - - - """ - pass - - -def GetTextFace(hdc:'int') -> 'str': - """ - Retrieves the name of the font currently selected in a DC - -Args: - - hdc(int):Handle to a device contextCommentsCalls unicode api function (GetTextFaceW) - -Returns: - - str - - """ - pass - - -def GetMapMode(hdc:'int') -> 'typing.Any': - """ - Returns the method a device context uses to translate logical units to physical units - -Args: - - hdc(int):Handle to a device contextReturn ValueReturns one of win32con.MM_* values - -Returns: - - typing.Any:Handle to a device contextReturn ValueReturns one of win32con.MM_* values - - - """ - pass - - -def SetMapMode(hdc:'int',MapMode:'typing.Any') -> 'typing.Any': - """ - Sets the method used for translating logical units to device units - -Args: - - hdc(int):Handle to a device context - MapMode(typing.Any):The new mapping mode (win32con.MM_*)Return ValueReturns the previous mapping mode, one of win32con.MM_* constants - -Returns: - - typing.Any:The new mapping mode (win32con.MM_*)Return ValueReturns the previous mapping mode, one of win32con.MM_* constants - - - """ - pass - - -def GetGraphicsMode(hdc:'int') -> 'typing.Any': - """ - Determines if advanced GDI features are enabled for a device context - -Args: - - hdc(int):Handle to a device contextReturn ValueReturns GM_COMPATIBLE or GM_ADVANCED - -Returns: - - typing.Any:Handle to a device contextReturn ValueReturns GM_COMPATIBLE or GM_ADVANCED - - - """ - pass - - -def SetGraphicsMode(hdc:'int',Mode:'typing.Any') -> 'typing.Any': - """ - Enables or disables advanced graphics features for a DC - -Args: - - hdc(int):Handle to a device context - Mode(typing.Any):GM_COMPATIBLE or GM_ADVANCED (from win32con)Return ValueReturns the previous mode, one of win32con.GM_COMPATIBLE or win32con.GM_ADVANCED - -Returns: - - typing.Any:GM_COMPATIBLE or GM_ADVANCED (from win32con)Return ValueReturns the previous mode, one of win32con.GM_COMPATIBLE or win32con.GM_ADVANCED - - - """ - pass - - -def GetLayout(hdc:'int') -> 'typing.Any': - """ - Retrieves the layout mode of a device context - -Args: - - hdc(int):Handle to a device contextReturn ValueReturns one of win32con.LAYOUT_* - -Returns: - - typing.Any:Handle to a device contextReturn ValueReturns one of win32con.LAYOUT_* - - - """ - pass - - -def SetLayout(hdc:'int',Layout:'typing.Any') -> 'typing.Any': - """ - Sets the layout for a device context - -Args: - - hdc(int):Handle to a device context - Layout(typing.Any):One of win32con.LAYOUT_* constantsReturn ValueReturns the previous layout mode - -Returns: - - typing.Any:One of win32con.LAYOUT_* constantsReturn ValueReturns the previous layout mode - - - """ - pass - - -def GetPolyFillMode(hdc:'int') -> 'typing.Any': - """ - Returns the polygon filling mode for a device context - -Args: - - hdc(int):Handle to a device contextReturn ValueReturns win32con.ALTERNATE or win32con.WINDING - -Returns: - - typing.Any:Handle to a device contextReturn ValueReturns win32con.ALTERNATE or win32con.WINDING - - - """ - pass - - -def SetPolyFillMode(hdc:'int',PolyFillMode:'typing.Any') -> 'typing.Any': - """ - Sets the polygon filling mode for a device context - -Args: - - hdc(int):Handle to a device context - PolyFillMode(typing.Any):One of ALTERNATE or WINDINGReturn ValueReturns the previous mode, one of win32con.ALTERNATE or win32con.WINDING - -Returns: - - typing.Any:One of ALTERNATE or WINDINGReturn ValueReturns the previous mode, one of win32con.ALTERNATE or win32con.WINDING - - - """ - pass - - -def GetWorldTransform(hdc:'int') -> 'win32typing.PyXFORM': - """ - Retrieves a device context's coordinate space translation matrix - -Args: - - hdc(int):Handle to a device contextCommentsDC's mode must be set to GM_ADVANCED. See win32gui::SetGraphicsMode. - -Returns: - - win32typing.PyXFORM - - """ - pass - - -def SetWorldTransform(hdc:'int',Xform:'win32typing.PyXFORM') -> 'None': - """ - Transforms a device context's coordinate space - -Args: - - hdc(int):Handle to a device context - Xform(win32typing.PyXFORM):Matrix defining the transformationCommentsDC's mode must be set to GM_ADVANCED. See win32gui::SetGraphicsMode. - -Returns: - - None - - """ - pass - - -def ModifyWorldTransform(hdc:'int',Xform:'win32typing.PyXFORM',Mode:'typing.Any') -> 'None': - """ - Combines a coordinate tranformation with device context's current transformation - -Args: - - hdc(int):Handle to a device context - Xform(win32typing.PyXFORM):Transformation to be applied. Ignored if Mode is MWT_IDENTITY. - Mode(typing.Any):One of win32con.MWT_* values specifying how transformations will be combinedCommentsDC's mode must be set to GM_ADVANCED. See win32gui::SetGraphicsMode. - -Returns: - - None - - """ - pass - - -def CombineTransform(xform1:'win32typing.PyXFORM',xform2:'win32typing.PyXFORM') -> 'win32typing.PyXFORM': - """ - Combines two coordinate space transformations - -Args: - - xform1(win32typing.PyXFORM):First transformation - xform2(win32typing.PyXFORM):Second transformation - -Returns: - - win32typing.PyXFORM - - """ - pass - - -def GetWindowOrgEx(hdc:'int') -> 'tuple[typing.Any, typing.Any]': - """ - Retrievs the window origin for a DC - -Args: - - hdc(int):Handle to a device context - -Returns: - - tuple[typing.Any, typing.Any] - - """ - pass - - -def SetWindowOrgEx(hdc:'int',X:'typing.Any',Y:'typing.Any') -> 'tuple[typing.Any, typing.Any]': - """ - Changes the window origin for a DC - -Args: - - hdc(int):Handle to a device context - X(typing.Any):New X coord in logical units - Y(typing.Any):New Y coord in logical unitsReturn ValueReturns the previous origin - -Returns: - - tuple[typing.Any, typing.Any]:New Y coord in logical unitsReturn ValueReturns the previous origin - - - """ - pass - - -def GetViewportOrgEx(hdc:'int') -> 'tuple[typing.Any, typing.Any]': - """ - Retrievs the origin for a DC's viewport - -Args: - - hdc(int):Handle to a device context - -Returns: - - tuple[typing.Any, typing.Any] - - """ - pass - - -def SetViewportOrgEx(hdc:'int',X:'typing.Any',Y:'typing.Any') -> 'tuple[typing.Any, typing.Any]': - """ - Changes the viewport origin for a DC - -Args: - - hdc(int):Handle to a device context - X(typing.Any):New X coord in logical units - Y(typing.Any):New Y coord in logical unitsReturn ValueReturns the previous origin as (x,y) - -Returns: - - tuple[typing.Any, typing.Any]:New Y coord in logical unitsReturn ValueReturns the previous origin as (x,y) - - - """ - pass - - -def GetWindowExtEx(hdc:'int') -> 'tuple[typing.Any, typing.Any]': - """ - Retrieves the window extents for a DC - -Args: - - hdc(int):Handle to a device contextReturn ValueReturns the extents as (x,y) in logical units - -Returns: - - tuple[typing.Any, typing.Any]:Handle to a device contextReturn ValueReturns the extents as (x,y) in logical units - - - """ - pass - - -def SetWindowExtEx(hdc:'int',XExtent:'typing.Any',YExtent:'typing.Any') -> 'tuple[typing.Any, typing.Any]': - """ - Changes the window extents for a DC - -Args: - - hdc(int):Handle to a device context - XExtent(typing.Any):New X extent in logical units - YExtent(typing.Any):New Y extent in logical unitsReturn ValueReturns the previous extents - -Returns: - - tuple[typing.Any, typing.Any]:New Y extent in logical unitsReturn ValueReturns the previous extents - - - """ - pass - - -def GetViewportExtEx(hdc:'int') -> 'tuple[typing.Any, typing.Any]': - """ - Retrieves the viewport extents for a DC - -Args: - - hdc(int):Handle to a device contextReturn ValueReturns the extents as (x,y) in logical units - -Returns: - - tuple[typing.Any, typing.Any]:Handle to a device contextReturn ValueReturns the extents as (x,y) in logical units - - - """ - pass - - -def SetViewportExtEx(hdc:'int',XExtent:'typing.Any',YExtent:'typing.Any') -> 'tuple[typing.Any, typing.Any]': - """ - Changes the viewport extents for a DC - -Args: - - hdc(int):Handle to a device context - XExtent(typing.Any):New X extent in logical units - YExtent(typing.Any):New Y extent in logical unitsReturn ValueReturns the previous extents as (x,y) in logical units - -Returns: - - tuple[typing.Any, typing.Any]:New Y extent in logical unitsReturn ValueReturns the previous extents as (x,y) in logical units - - - """ - pass - - -def GradientFill(hdc:'typing.Any',Vertex:'tuple[win32typing.PyTRIVERTEX, ...]',Mesh:'typing.Any',Mode:'typing.Any') -> 'None': - """ - Shades triangles or rectangles by interpolating between vertex colors - -Args: - - hdc(typing.Any):Handle to device context - Vertex(tuple[win32typing.PyTRIVERTEX, ...]):Sequence of TRIVERTEX dicts defining color info - Mesh(typing.Any):Sequence of tuples containing either 2 or 3 ints that index into the trivertex array to define either triangles or rectangles - Mode(typing.Any):win32con.GRADIENT_FILL_* value defining whether to fill by triangle or by rectangle - -Returns: - - None - - """ - pass - - -def GetOpenFileName(OPENFILENAME:'typing.Union[str, typing.Any]') -> 'typing.Any': - """ - Creates an Open dialog box that lets the user specify the drive, directory, and the name of a file or set of files to open. - -Args: - - OPENFILENAME(typing.Union[str, typing.Any]):A string packed into an OPENFILENAME structure, probably via the struct module.CommentsThe win32gui::GetOpenFileNameW function is far more convenient to use.Return ValueIf the user presses OK, the function returns TRUE. Otherwise, use CommDlgExtendedError for error details (ie, a win32gui.error is raised). If the user cancels the dialog, the winerror attribute of the exception will be zero. - -Returns: - - typing.Any:A string packed into an OPENFILENAME structure, probably via the struct module.Comments - -The win32gui::GetOpenFileNameW function is far more convenient to use. -Return ValueIf the user presses OK, the function returns TRUE. Otherwise, use CommDlgExtendedError for error details - -(ie, a win32gui.error is raised). If the user cancels the dialog, the winerror attribute of the exception will be zero. - - - """ - pass - - -def InsertMenuItem(hMenu:'typing.Any',uItem:'typing.Any',fByPosition:'typing.Any',menuItem:'typing.Any') -> 'None': - """ - Inserts a menu item - -Args: - - hMenu(typing.Any):Handle to the menu - uItem(typing.Any):The menu item identifier or the menu item position. - fByPosition(typing.Any):Boolean value of True if uItem is set to a menu item position. This parameter is set to False if uItem is set to a menu item identifier. - menuItem(typing.Any):A string or buffer in the format of a MENUITEMINFO structure. - -Returns: - - None - - """ - pass - - -def SetMenuItemInfo(hMenu:'typing.Any',uItem:'typing.Any',fByPosition:'typing.Any',menuItem:'typing.Any') -> 'None': - """ - Sets menu information - -Args: - - hMenu(typing.Any):Handle to the menu - uItem(typing.Any):The menu item identifier or the menu item position. - fByPosition(typing.Any):Boolean value of True if uItem is set to a menu item position. This parameter is set to False if uItem is set to a menu item identifier. - menuItem(typing.Any):A string or buffer in the format of a MENUITEMINFO structure. - -Returns: - - None - - """ - pass - - -def GetMenuItemInfo(hMenu:'typing.Any',uItem:'typing.Any',fByPosition:'typing.Any',menuItem:'typing.Any') -> 'None': - """ - Gets menu information - -Args: - - hMenu(typing.Any):Handle to the menu - uItem(typing.Any):The menu item identifier or the menu item position. - fByPosition(typing.Any):Boolean value of True if uItem is set to a menu item position. This parameter is set to False if uItem is set to a menu item identifier. - menuItem(typing.Any):A string or buffer in the format of a MENUITEMINFO structure. - -Returns: - - None - - """ - pass - - -def GetMenuItemCount(hMenu:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hMenu(typing.Any):Handle to the menu - -Returns: - - typing.Any - - """ - pass - - -def GetMenuItemRect(hWnd:'typing.Any',hMenu:'typing.Any',uItem:'typing.Any') -> 'tuple[int, int, int, int]': - """ - None - -Args: - - hWnd(typing.Any): - hMenu(typing.Any):Handle to the menu - uItem(typing.Any): - -Returns: - - tuple[int, int, int, int] - - """ - pass - - -def GetMenuState(hMenu:'typing.Any',uID:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hMenu(typing.Any):Handle to the menu - uID(typing.Any): - flags(typing.Any): - -Returns: - - typing.Any - - """ - pass - - -def SetMenuDefaultItem(hMenu:'typing.Any',uItem:'typing.Any',fByPos:'typing.Any') -> 'None': - """ - None - -Args: - - hMenu(typing.Any):Handle to the menu - uItem(typing.Any): - fByPos(typing.Any): - -Returns: - - None - - """ - pass - - -def GetMenuDefaultItem(hMenu:'typing.Any',fByPos:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hMenu(typing.Any):Handle to the menu - fByPos(typing.Any): - flags(typing.Any): - -Returns: - - typing.Any - - """ - pass - - -def AppendMenu() -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - -def InsertMenu() -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - -def EnableMenuItem() -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - -def CheckMenuItem() -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -def GetSubMenu(hMenu:'typing.Any',nPos:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hMenu(typing.Any):Handle to the menu - nPos(typing.Any): - -Returns: - - typing.Any - - """ - pass - - -def ModifyMenu(hMnu:'typing.Any',uPosition:'typing.Any',uFlags:'typing.Any',uIDNewItem:'typing.Any',newItem:'str') -> 'None': - """ - Changes an existing menu item. This function is used to specify the content, appearance, and behavior of the menu item. - -Args: - - hMnu(typing.Any):handle to menu - uPosition(typing.Any):menu item to modify - uFlags(typing.Any):options - uIDNewItem(typing.Any):identifier, menu, or submenu - newItem(str):menu item content - -Returns: - - None - - """ - pass - - -def GetMenuItemID(hMenu:'typing.Any',nPos:'typing.Any') -> 'typing.Any': - """ - Retrieves the menu item identifier of a menu item located at the specified position in a menu. - -Args: - - hMenu(typing.Any):handle to menu - nPos(typing.Any):position of menu item - -Returns: - - typing.Any - - """ - pass - - -def SetMenuItemBitmaps(hMenu:'typing.Any',uPosition:'typing.Any',uFlags:'typing.Any',hBitmapUnchecked:'win32typing.PyGdiHANDLE',hBitmapChecked:'win32typing.PyGdiHANDLE') -> 'None': - """ - Associates the specified bitmap with a menu item. Whether the menu item is selected or clear, the system displays the appropriate bitmap next to the menu item. - -Args: - - hMenu(typing.Any):handle to menu - uPosition(typing.Any):menu item - uFlags(typing.Any):options - hBitmapUnchecked(win32typing.PyGdiHANDLE):handle to unchecked bitmap, can be None - hBitmapChecked(win32typing.PyGdiHANDLE):handle to checked bitmap, can be None - -Returns: - - None - - """ - pass - - -def CheckMenuRadioItem(hMenu:'typing.Any',idFirst:'typing.Any',idLast:'typing.Any',idCheck:'typing.Any',uFlags:'typing.Any') -> 'None': - """ - Checks a specified menu item and makes it a - -radio item. At the same time, the function clears all other menu items in - -the associated group and clears the radio-item type flag for those items. - -Args: - - hMenu(typing.Any):handle to menu - idFirst(typing.Any):identifier or position of first item - idLast(typing.Any):identifier or position of last item - idCheck(typing.Any):identifier or position of item to check - uFlags(typing.Any):options - -Returns: - - None - - """ - pass - - -def SetMenuInfo(hmenu:'typing.Any',info:'typing.Any') -> 'None': - """ - Sets information for a specified menu. - -Args: - - hmenu(typing.Any):handle to menu - info(typing.Any):menu information in the format of a buffer.CommentsSee win32gui_struct for helper functions.This function will raise NotImplementedError on early platforms (eg, Windows NT.) - -Returns: - - None - - """ - pass - - -def GetMenuInfo(hmenu:'typing.Any',info:'typing.Any') -> 'None': - """ - Gets information about a specified menu. - -Args: - - hmenu(typing.Any):handle to menu - info(typing.Any):A buffer to fill with the information.CommentsSee win32gui_struct for helper functions.This function will raise NotImplementedError on early platforms (eg, Windows NT.) - -Returns: - - None - - """ - pass - - -def DrawFocusRect(hDC:'int',rc:'tuple[int, int, int, int]') -> 'None': - """ - Draws a standard focus outline around a rectangle - -Args: - - hDC(int):Handle to a device context - rc(tuple[int, int, int, int]):Tuple of (left,top,right,bottom) defining the rectangle - -Returns: - - None - - """ - pass - - -def DrawText(hDC:'typing.Union[typing.Any, int]',String:'typing.Any',nCount:'typing.Any',Rect:'win32typing.PyRECT',Format:'typing.Any') -> 'tuple[typing.Any, win32typing.PyRECT]': - """ - Draws formatted text on a device context - -Args: - - hDC(typing.Union[typing.Any, int]):The device context on which to draw - String(typing.Any):The text to be drawn - nCount(typing.Any):The number of characters, use -1 for simple null-terminated string - Rect(win32typing.PyRECT):Tuple of 4 ints specifying the position (left, top, right, bottom) - Format(typing.Any):Formatting flags, combination of win32con.DT_* valuesReturn ValueReturns the height of the drawn text, and the rectangle coordinates - -Returns: - - tuple[typing.Any, win32typing.PyRECT]:Formatting flags, combination of win32con.DT_* valuesReturn ValueReturns the height of the drawn text, and the rectangle coordinates - - - """ - pass - - -def LineTo(hdc:'int',XEnd:'typing.Any',YEnd:'typing.Any') -> 'None': - """ - Draw a line from current position to specified point - -Args: - - hdc(int):Handle to a device context - XEnd(typing.Any):Horizontal position in logical units - YEnd(typing.Any):Vertical position in logical units - -Returns: - - None - - """ - pass - - -def Ellipse(hdc:'int',LeftRect:'typing.Any',TopRect:'typing.Any',RightRect:'typing.Any',BottomRect:'typing.Any') -> 'None': - """ - Draws a filled ellipse on a device context - -Args: - - hdc(int):Device context on which to draw - LeftRect(typing.Any):Left limit of ellipse - TopRect(typing.Any):Top limit of ellipse - RightRect(typing.Any):Right limit of ellipse - BottomRect(typing.Any):Bottom limit of ellipse - -Returns: - - None - - """ - pass - - -def Pie(hdc:'int',LeftRect:'typing.Any',TopRect:'typing.Any',RightRect:'typing.Any',BottomRect:'typing.Any',XRadial1:'typing.Any',YRadial1:'typing.Any',XRadial2:'typing.Any',YRadial2:'typing.Any') -> 'None': - """ - Draws a section of an ellipse cut by 2 radials - -Args: - - hdc(int):Device context on which to draw - LeftRect(typing.Any):Left limit of ellipse - TopRect(typing.Any):Top limit of ellipse - RightRect(typing.Any):Right limit of ellipse - BottomRect(typing.Any):Bottom limit of ellipse - XRadial1(typing.Any):Horizontal pos of Radial1 endpoint - YRadial1(typing.Any):Vertical pos of Radial1 endpoint - XRadial2(typing.Any):Horizontal pos of Radial2 endpoint - YRadial2(typing.Any):Vertical pos of Radial2 endpoint - -Returns: - - None - - """ - pass - - -def Arc(hdc:'int',LeftRect:'typing.Any',TopRect:'typing.Any',RightRect:'typing.Any',BottomRect:'typing.Any',XRadial1:'typing.Any',YRadial1:'typing.Any',XRadial2:'typing.Any',YRadial2:'typing.Any') -> 'None': - """ - Draws an arc defined by an ellipse and 2 radials - -Args: - - hdc(int):Device context on which to draw - LeftRect(typing.Any):Left limit of ellipse - TopRect(typing.Any):Top limit of ellipse - RightRect(typing.Any):Right limit of ellipse - BottomRect(typing.Any):Bottom limit of ellipse - XRadial1(typing.Any):Horizontal pos of Radial1 endpoint - YRadial1(typing.Any):Vertical pos of Radial1 endpoint - XRadial2(typing.Any):Horizontal pos of Radial2 endpoint - YRadial2(typing.Any):Vertical pos of Radial2 endpoint - -Returns: - - None - - """ - pass - - -def ArcTo(hdc:'int',LeftRect:'typing.Any',TopRect:'typing.Any',RightRect:'typing.Any',BottomRect:'typing.Any',XRadial1:'typing.Any',YRadial1:'typing.Any',XRadial2:'typing.Any',YRadial2:'typing.Any') -> 'None': - """ - Draws an arc defined by an ellipse and 2 radials - -Args: - - hdc(int):Device context on which to draw - LeftRect(typing.Any):Left limit of ellipse - TopRect(typing.Any):Top limit of ellipse - RightRect(typing.Any):Right limit of ellipse - BottomRect(typing.Any):Bottom limit of ellipse - XRadial1(typing.Any):Horizontal pos of Radial1 endpoint - YRadial1(typing.Any):Vertical pos of Radial1 endpoint - XRadial2(typing.Any):Horizontal pos of Radial2 endpoint - YRadial2(typing.Any):Vertical pos of Radial2 endpointCommentsDraws exactly as win32gui::Arc, but changes current drawing position - -Returns: - - None - - """ - pass - - -def AngleArc(hdc:'int',Y:'typing.Any',Y1:'typing.Any',Radius:'typing.Any',StartAngle:'float',SweepAngle:'float') -> 'None': - """ - Draws a line from current pos and a section of a circle's arc - -Args: - - hdc(int):Handle to a device context - Y(typing.Any):x pos of circle - Y1(typing.Any):y pos of circle - Radius(typing.Any):Radius of circle - StartAngle(float):Angle where arc starts, in degrees - SweepAngle(float):Angle that arc covers, in degrees - -Returns: - - None - - """ - pass - - -def Chord(hdc:'int',LeftRect:'typing.Any',TopRect:'typing.Any',RightRect:'typing.Any',BottomRect:'typing.Any',XRadial1:'typing.Any',YRadial1:'typing.Any',XRadial2:'typing.Any',YRadial2:'typing.Any') -> 'None': - """ - Draws a chord defined by an ellipse and 2 radials - -Args: - - hdc(int):Device context on which to draw - LeftRect(typing.Any):Left limit of ellipse - TopRect(typing.Any):Top limit of ellipse - RightRect(typing.Any):Right limit of ellipse - BottomRect(typing.Any):Bottom limit of ellipse - XRadial1(typing.Any):Horizontal pos of Radial1 endpoint - YRadial1(typing.Any):Vertical pos of Radial1 endpoint - XRadial2(typing.Any):Horizontal pos of Radial2 endpoint - YRadial2(typing.Any):Vertical pos of Radial2 endpoint - -Returns: - - None - - """ - pass - - -def ExtFloodFill(arg:'int',XStart:'typing.Any',YStart:'typing.Any',Color:'typing.Any',FillType:'typing.Any') -> 'None': - """ - Fills an area with current brush - -Args: - - arg(int):Handle to a device context - XStart(typing.Any):Horizontal starting pos - YStart(typing.Any):Vertical starting pos - Color(typing.Any):RGB color value. See win32api::RGB. - FillType(typing.Any):One of win32con.FLOODFILL* values - -Returns: - - None - - """ - pass - - -def SetPixel(hdc:'int',X:'typing.Any',Y:'typing.Any',Color:'typing.Any') -> 'typing.Any': - """ - Set the color of a single pixel - -Args: - - hdc(int):Handle to a device context - X(typing.Any):Horizontal pos - Y(typing.Any):Vertical pos - Color(typing.Any):RGB color to be set.Return ValueReturns the RGB color actually set, which may be different from the one passed in - -Returns: - - typing.Any:RGB color to be set.Return ValueReturns the RGB color actually set, which may be different from the one passed in - - - """ - pass - - -def GetPixel(hdc:'int',XPos:'typing.Any',YPos:'typing.Any') -> 'typing.Any': - """ - Returns the RGB color of a single pixel - -Args: - - hdc(int):Handle to a device context - XPos(typing.Any):Horizontal pos - YPos(typing.Any):Vertical pos - -Returns: - - typing.Any - - """ - pass - - -def GetROP2(hdc:'int') -> 'typing.Any': - """ - Returns the foreground mixing mode of a DC - -Args: - - hdc(int):Handle to a device contextReturn ValueReturns one of win32con.R2_* values - -Returns: - - typing.Any:Handle to a device contextReturn ValueReturns one of win32con.R2_* values - - - """ - pass - - -def SetROP2(hdc:'int',DrawMode:'typing.Any') -> 'typing.Any': - """ - Sets the foreground mixing mode of a DC - -Args: - - hdc(int):Handle to a device context - DrawMode(typing.Any):Mixing mode, one of win32con.R2_*.Return ValueReturns previous mode - -Returns: - - typing.Any:Mixing mode, one of win32con.R2_*.Return ValueReturns previous mode - - - """ - pass - - -def SetPixelV(hdc:'int',X:'typing.Any',Y:'typing.Any',Color:'typing.Any') -> 'None': - """ - Sets the color of a single pixel to an approximation of specified color - -Args: - - hdc(int):Handle to a device context - X(typing.Any):Horizontal pos - Y(typing.Any):Vertical pos - Color(typing.Any):RGB color to be set. - -Returns: - - None - - """ - pass - - -def MoveToEx(hdc:'int',X:'typing.Any',Y:'typing.Any') -> 'tuple[typing.Any, typing.Any]': - """ - Changes the current drawing position - -Args: - - hdc(int):Device context handle - X(typing.Any):Horizontal pos in logical units - Y(typing.Any):Vertical pos in logical unitsReturn ValueReturns the previous position as (X, Y) - -Returns: - - tuple[typing.Any, typing.Any]:Vertical pos in logical unitsReturn ValueReturns the previous position as (X, Y) - - - """ - pass - - -def GetCurrentPositionEx(hdc:'int') -> 'tuple[typing.Any, typing.Any]': - """ - Returns a device context's current drawing position - -Args: - - hdc(int):Device context - -Returns: - - tuple[typing.Any, typing.Any] - - """ - pass - - -def GetArcDirection(hdc:'int') -> 'typing.Any': - """ - Returns the direction in which rectangles and arcs are drawn - -Args: - - hdc(int):Handle to a device contextReturn ValueRecturns one of win32con.AD_* values - -Returns: - - typing.Any:Handle to a device contextReturn ValueRecturns one of win32con.AD_* values - - - """ - pass - - -def SetArcDirection(hdc:'int',ArcDirection:'typing.Any') -> 'typing.Any': - """ - Sets the drawing direction for arcs and rectangles - -Args: - - hdc(int):Handle to a device context - ArcDirection(typing.Any):One of win32con.AD_* constantsReturn ValueReturns the previous direction, or 0 on error. - -Returns: - - typing.Any:One of win32con.AD_* constantsReturn ValueReturns the previous direction, or 0 on error. - - - """ - pass - - -def Polygon(hdc:'int',Points:'typing.List[tuple[typing.Any, typing.Any]]') -> 'None': - """ - Draws a closed filled polygon defined by a sequence of points - -Args: - - hdc(int):Handle to a device context - Points(typing.List[tuple[typing.Any, typing.Any]]):Sequence of POINT tuples: ((x,y),...) - -Returns: - - None - - """ - pass - - -def Polyline(hdc:'int',Points:'typing.List[tuple[typing.Any, typing.Any]]') -> 'None': - """ - Connects a sequence of points using currently selected pen - -Args: - - hdc(int):Handle to a device context - Points(typing.List[tuple[typing.Any, typing.Any]]):Sequence of POINT tuples: ((x,y),...) - -Returns: - - None - - """ - pass - - -def PolylineTo(hdc:'int',Points:'typing.List[tuple[typing.Any, typing.Any]]') -> 'None': - """ - Draws a series of lines starting from current position. Updates current position with end point. - -Args: - - hdc(int):Handle to a device context - Points(typing.List[tuple[typing.Any, typing.Any]]):Sequence of POINT tuples: ((x,y),...) - -Returns: - - None - - """ - pass - - -def PolyBezier(hdc:'int',Points:'typing.List[tuple[typing.Any, typing.Any]]') -> 'None': - """ - Draws a series of Bezier curves starting from first point specified. - -Args: - - hdc(int):Handle to a device context - Points(typing.List[tuple[typing.Any, typing.Any]]):Sequence of POINT tuples: ((x,y),...).CommentsNumber of points must be a multiple of 3 plus 1. - -Returns: - - None - - """ - pass - - -def PolyBezierTo(hdc:'int',Points:'typing.List[tuple[typing.Any, typing.Any]]') -> 'None': - """ - Draws a series of Bezier curves starting from current drawing position. - -Args: - - hdc(int):Handle to a device context - Points(typing.List[tuple[typing.Any, typing.Any]]):Sequence of POINT tuples: ((x,y),...).CommentsPoints must contain 3 points for each curve. Current position is updated with last endpoint. - -Returns: - - None - - """ - pass - - -def PlgBlt(Dest:'int',Point:'typing.Any',Src:'int',XSrc:'typing.Any',YSrc:'typing.Any',Width:'typing.Any',Height:'typing.Any',Mask:'win32typing.PyGdiHANDLE'=None,xMask:'typing.Any'=0,yMask:'typing.Any'=0) -> 'None': - """ - Copies color from a rectangle into a parallelogram - -Args: - - Dest(int):Destination DC - Point(typing.Any):Sequence of 3 POINT tuples (x,y) describing a paralellogram - Src(int):Source device context - XSrc(typing.Any):Left edge of source rectangle - YSrc(typing.Any):Top of source rectangle - Width(typing.Any):Width of source rectangle - Height(typing.Any):Height of source rectangle - Mask(win32typing.PyGdiHANDLE):Handle to monochrome bitmap to mask source, can be None - xMask(typing.Any):x pos in mask - yMask(typing.Any):y pos in mask - -Returns: - - None - - """ - pass - - -def CreatePolygonRgn(Points:'typing.List[tuple[typing.Any, typing.Any]]',PolyFillMode:'typing.Any') -> 'win32typing.PyGdiHANDLE': - """ - Creates a region from a sequence of vertices - -Args: - - Points(typing.List[tuple[typing.Any, typing.Any]]):Sequence of POINT tuples: ((x,y),...). - PolyFillMode(typing.Any):Filling mode, one of ALTERNATE, WINDING - -Returns: - - win32typing.PyGdiHANDLE - - """ - pass - - -def ExtTextOut(hdc:'int',_int:'typing.Any',_int1:'typing.Any',_int2:'typing.Any',rect:'win32typing.PyRECT',string:'typing.Any',_tuple:'tuple[tuple[typing.Any, typing.Any], ...]') -> 'typing.Any': - """ - Writes text to a DC. - -Args: - - hdc(int):Handle to a device context - _int(typing.Any):The x coordinate to write the text to. - _int1(typing.Any):The y coordinate to write the text to. - _int2(typing.Any):Specifies the rectangle type. This parameter can be one, both, or neither of ETO_CLIPPED and ETO_OPAQUE - rect(win32typing.PyRECT):Specifies the text's bounding rectangle. (Can be None.) - string(typing.Any):The text to write. - _tuple(tuple[tuple[typing.Any, typing.Any], ...]):Optional array of values that indicate distance between origins of character cells.Win32 API References - -Returns: - - typing.Any:Search for ExtTextOut at msdn, google or google groups. -Return ValueAlways none. If the function fails, an exception is raised. - - - """ - pass - - -def GetTextColor(hdc:'typing.Any') -> 'typing.Any': - """ - Returns the text color for a DC - -Args: - - hdc(typing.Any):Handle to a device contextReturn ValueReturns an RGB color. On error, returns CLR_INVALID - -Returns: - - typing.Any:Handle to a device contextReturn ValueReturns an RGB color. On error, returns CLR_INVALID - - - """ - pass - - -def SetTextColor(hdc:'typing.Any',color:'typing.Any') -> 'typing.Any': - """ - Changes the text color for a device context - -Args: - - hdc(typing.Any):Handle to a device context - color(typing.Any):The RGB color value - see win32api::RGBReturn ValueReturns the previous color, or CLR_INVALID on failure - -Returns: - - typing.Any:The RGB color value - see win32api::RGBReturn ValueReturns the previous color, or CLR_INVALID on failure - - - """ - pass - - -def GetBkMode(hdc:'int') -> 'typing.Any': - """ - Returns the background mode for a device context - -Args: - - hdc(int):Handle to a device contextReturn ValueReturns OPAQUE, TRANSPARENT, or 0 on failure - -Returns: - - typing.Any:Handle to a device contextReturn ValueReturns OPAQUE, TRANSPARENT, or 0 on failure - - - """ - pass - - -def SetBkMode(hdc:'typing.Union[typing.Any, int]',BkMode:'typing.Any') -> 'typing.Any': - """ - Sets the background mode for a device context - -Args: - - hdc(typing.Union[typing.Any, int]):Handle to a device context - BkMode(typing.Any):OPAQUE or TRANSPARENTReturn ValueReturns the previous mode, or 0 on failure - -Returns: - - typing.Any:OPAQUE or TRANSPARENTReturn ValueReturns the previous mode, or 0 on failure - - - """ - pass - - -def GetBkColor(hdc:'int') -> 'typing.Any': - """ - Returns the background color for a device context - -Args: - - hdc(int):Handle to a device contextReturn ValueReturns an RGB color value. On error, returns CLR_INVALID. - -Returns: - - typing.Any:Handle to a device contextReturn ValueReturns an RGB color value. On error, returns CLR_INVALID. - - - """ - pass - - -def SetBkColor(hdc:'typing.Union[typing.Any, int]',color:'typing.Any') -> 'typing.Any': - """ - Sets the background color for a device context - -Args: - - hdc(typing.Union[typing.Any, int]):Handle to a device context - color(typing.Any):Return ValueReturns the previous color, or CLR_INVALID on failure - -Returns: - - typing.Any:Return ValueReturns the previous color, or CLR_INVALID on failure - - - """ - pass - - -def DrawEdge(hdc:'int',rc:'win32typing.PyRECT',edge:'typing.Any',Flags:'typing.Any') -> 'win32typing.PyRECT': - """ - Draws edge(s) of a rectangle - -Args: - - hdc(int):Handle to a device context - rc(win32typing.PyRECT):Rectangle whose edge(s) will be drawn - edge(typing.Any):Combination of win32con.BDR_* flags, or one of win32con.EDGE_* flags - Flags(typing.Any):Combination of win32con.BF_* flagsReturn ValueBF_ADJUST flag causes input rectange to be shrunk by size of border.. Rectangle is always returned. - -Returns: - - win32typing.PyRECT:Combination of win32con.BF_* flagsReturn ValueBF_ADJUST flag causes input rectange to be shrunk by size of border.. Rectangle is always returned. - - - """ - pass - - -def FillRect(hDC:'int',rc:'win32typing.PyRECT',hbr:'win32typing.PyGdiHANDLE') -> 'None': - """ - Fills a rectangular area with specified brush - -Args: - - hDC(int):Handle to a device context - rc(win32typing.PyRECT):Rectangle to be filled - hbr(win32typing.PyGdiHANDLE):Handle to brush to be used to fill area - -Returns: - - None - - """ - pass - - -def FillRgn(hdc:'int',hrgn:'win32typing.PyGdiHANDLE',hbr:'win32typing.PyGdiHANDLE') -> 'None': - """ - Fills a region with specified brush - -Args: - - hdc(int):Handle to the device context - hrgn(win32typing.PyGdiHANDLE):Handle to the region - hbr(win32typing.PyGdiHANDLE):Brush to be used - -Returns: - - None - - """ - pass - - -def PaintRgn(hdc:'int',hrgn:'win32typing.PyGdiHANDLE') -> 'None': - """ - Paints a region with current brush - -Args: - - hdc(int):Handle to the device context - hrgn(win32typing.PyGdiHANDLE):Handle to the region - -Returns: - - None - - """ - pass - - -def FrameRgn(hdc:'int',hrgn:'typing.Any',hbr:'typing.Any',Width:'typing.Any',Height:'typing.Any') -> 'None': - """ - Draws a frame around a region - -Args: - - hdc(int):Handle to the device context - hrgn(typing.Any):Handle to the region - hbr(typing.Any):Handle to brush to be used - Width(typing.Any):Frame width - Height(typing.Any):Frame height - -Returns: - - None - - """ - pass - - -def InvertRgn(hdc:'int',hrgn:'typing.Any') -> 'None': - """ - Inverts the colors in a region - -Args: - - hdc(int):Handle to the device context - hrgn(typing.Any):Handle to the region - -Returns: - - None - - """ - pass - - -def EqualRgn(SrcRgn1:'typing.Any',SrcRgn2:'typing.Any') -> 'typing.Any': - """ - Determines if 2 regions are equal - -Args: - - SrcRgn1(typing.Any):Handle to a region - SrcRgn2(typing.Any):Handle to a region - -Returns: - - typing.Any - - """ - pass - - -def PtInRegion(hrgn:'typing.Any',X:'typing.Any',Y:'typing.Any') -> 'typing.Any': - """ - Determines if a region contains a point - -Args: - - hrgn(typing.Any):Handle to a region - X(typing.Any):X coord - Y(typing.Any):Y coord - -Returns: - - typing.Any - - """ - pass - - -def PtInRect(rect:'tuple[int, int, int, int]',point:'tuple[typing.Any, typing.Any]') -> 'typing.Any': - """ - Determines if a rectangle contains a point - -Args: - - rect(tuple[int, int, int, int]):The rect to check - point(tuple[typing.Any, typing.Any]):The point - -Returns: - - typing.Any - - """ - pass - - -def RectInRegion(hrgn:'typing.Any',rc:'win32typing.PyRECT') -> 'typing.Any': - """ - Determines if a region and rectangle overlap at any point - -Args: - - hrgn(typing.Any):Handle to a region - rc(win32typing.PyRECT):Rectangle coordinates in logical units - -Returns: - - typing.Any - - """ - pass - - -def SetRectRgn(hrgn:'typing.Any',LeftRect:'typing.Any',TopRect:'typing.Any',RightRect:'typing.Any',BottomRect:'typing.Any') -> 'None': - """ - Makes an existing region rectangular - -Args: - - hrgn(typing.Any):Handle to a region - LeftRect(typing.Any):Left edge in logical units - TopRect(typing.Any):Top edge in logical units - RightRect(typing.Any):Right edge in logical units - BottomRect(typing.Any):Bottom edge in logical units - -Returns: - - None - - """ - pass - - -def CombineRgn(Dest:'typing.Any',Src1:'typing.Any',Src2:'typing.Any',CombineMode:'typing.Any') -> 'typing.Any': - """ - Combines two regions - -Args: - - Dest(typing.Any):Handle to existing region that will receive combined region - Src1(typing.Any):Handle to first region - Src2(typing.Any):Handle to second region - CombineMode(typing.Any):One of RGN_AND,RGN_COPY,RGN_DIFF,RGN_OR,RGN_XORReturn ValueReturns the type of region created, one of NULLREGION, SIMPLEREGION, COMPLEXREGION - -Returns: - - typing.Any:One of RGN_AND,RGN_COPY,RGN_DIFF,RGN_OR,RGN_XORReturn ValueReturns the type of region created, one of NULLREGION, SIMPLEREGION, COMPLEXREGION - - - """ - pass - - -def DrawAnimatedRects(hwnd:'int',idAni:'typing.Any',minCoords:'win32typing.PyRECT',restCoords:'win32typing.PyRECT') -> 'None': - """ - Animates a rectangle in the manner of minimizing, mazimizing, or opening - -Args: - - hwnd(typing.Any):handle to clipping window - idAni(typing.Any):type of animation, win32con.IDANI_* - minCoords(win32typing.PyRECT):rectangle coordinates (minimized) - restCoords(win32typing.PyRECT):rectangle coordinates (restored) - -Returns: - - None - - """ - pass - - -def CreateSolidBrush(Color:'typing.Any') -> 'win32typing.PyGdiHANDLE': - """ - Creates a solid brush of specified color - -Args: - - Color(typing.Any):RGB color value. See win32api::RGB. - -Returns: - - win32typing.PyGdiHANDLE - - """ - pass - - -def CreatePatternBrush(hbmp:'win32typing.PyGdiHANDLE') -> 'win32typing.PyGdiHANDLE': - """ - Creates a brush using a bitmap as a pattern - -Args: - - hbmp(win32typing.PyGdiHANDLE):Handle to a bitmap - -Returns: - - win32typing.PyGdiHANDLE - - """ - pass - - -def CreateHatchBrush(Style:'typing.Any',clrref:'typing.Any') -> 'win32typing.PyGdiHANDLE': - """ - Creates a hatch brush with specified style and color - -Args: - - Style(typing.Any):Hatch style, one of win32con.HS_* constants - clrref(typing.Any):Rgb color value. See win32api::RGB. - -Returns: - - win32typing.PyGdiHANDLE - - """ - pass - - -def CreatePen(PenStyle:'typing.Any',Width:'typing.Any',Color:'typing.Any') -> 'win32typing.PyGdiHANDLE': - """ - Create a GDI pen - -Args: - - PenStyle(typing.Any):One of win32con.PS_* pen styles - Width(typing.Any):Drawing width in logical units. Use zero for single pixel. - Color(typing.Any):RGB color value. See win32api::RGB. - -Returns: - - win32typing.PyGdiHANDLE - - """ - pass - - -def GetSysColor(Index:'typing.Any') -> 'typing.Any': - """ - Returns the color of a window element - -Args: - - Index(typing.Any):One of win32con.COLOR_* values - -Returns: - - typing.Any - - """ - pass - - -def GetSysColorBrush(Index:'typing.Any') -> 'win32typing.PyGdiHANDLE': - """ - Creates a handle to a system color brush - -Args: - - Index(typing.Any):Index of a window element color (win32con.COLOR_*) - -Returns: - - win32typing.PyGdiHANDLE - - """ - pass - - -def InvalidateRect(hWnd:'int',Rect:'win32typing.PyRECT',Erase:'typing.Any') -> 'None': - """ - Invalidates a rectangular area of a window and adds it to the window's update region - -Args: - - hWnd(int):Handle to the window - Rect(win32typing.PyRECT):Client coordinates defining area to be redrawn. Use None for entire client area. - Erase(typing.Any):Indicates if background should be erased - -Returns: - - None - - """ - pass - - -def FrameRect(hDC:'int',rc:'win32typing.PyRECT',hbr:'win32typing.PyGdiHANDLE') -> 'None': - """ - Draws an outline around a rectangle - -Args: - - hDC(int):Handle to a device context - rc(win32typing.PyRECT):Rectangle around which to draw - hbr(win32typing.PyGdiHANDLE):Handle to brush created using CreateHatchBrush, CreatePatternBrush, CreateSolidBrush, or GetStockObject - -Returns: - - None - - """ - pass - - -def InvertRect(hDC:'int',rc:'win32typing.PyRECT') -> 'None': - """ - Inverts the colors in a regtangular region - -Args: - - hDC(int):Handle to a device context - rc(win32typing.PyRECT):Coordinates of rectangle to invert - -Returns: - - None - - """ - pass - - -def WindowFromDC(hDC:'int') -> 'int': - """ - Finds the window associated with a device context - -Args: - - hDC(int):Handle to a device contextReturn ValueReturns a handle to the window, or 0 if the DC is not associated with a window - -Returns: - - int:Handle to a device contextReturn ValueReturns a handle to the window, or 0 if the DC is not associated with a window - - - """ - pass - - -def GetUpdateRgn(hWnd:'int',hRgn:'win32typing.PyGdiHANDLE',Erase:'typing.Any') -> 'typing.Any': - """ - Copies the update region of a window into an existing region - -Args: - - hWnd(int):Handle to a window - hRgn(win32typing.PyGdiHANDLE):Handle to an existing region to receive update area - Erase(typing.Any):Indicates if window background is to be erasedReturn ValueReturns type of region, one of COMPLEXREGION, NULLREGION, or SIMPLEREGION - -Returns: - - typing.Any:Indicates if window background is to be erasedReturn ValueReturns type of region, one of COMPLEXREGION, NULLREGION, or SIMPLEREGION - - - """ - pass - - -def GetWindowRgn(hWnd:'int',hRgn:'win32typing.PyGdiHANDLE') -> 'typing.Any': - """ - Copies the window region of a window into an existing region - -Args: - - hWnd(int):Handle to a window - hRgn(win32typing.PyGdiHANDLE):Handle to an existing region that receives window regionReturn ValueReturns type of region, one of COMPLEXREGION, NULLREGION, or SIMPLEREGION - -Returns: - - typing.Any:Handle to an existing region that receives window regionReturn ValueReturns type of region, one of COMPLEXREGION, NULLREGION, or SIMPLEREGION - - - """ - pass - - -def SetWindowRgn(hWnd:'int',hRgn:'win32typing.PyGdiHANDLE',Redraw:'typing.Any') -> 'None': - """ - Sets the visible region of a window - -Args: - - hWnd(int):Handle to a window - hRgn(win32typing.PyGdiHANDLE):Handle to region to be set, can be None - Redraw(typing.Any):Indicates if window should be completely redrawnCommentsOn success, the system assumes ownership of the region so you should call the handle's Detach() method to prevent it from being automatically closed. - -Returns: - - None - - """ - pass - - -def GetWindowRgnBox(hWnd:'int') -> 'tuple[typing.Any, win32typing.PyRECT]': - """ - Returns the bounding box for a window's region - -Args: - - hWnd(int):Handle to a window that has a window region. (see win32gui::SetWindowRgn)CommentsOnly available in winxpguiReturn ValueReturns type of region and rectangle coordinates in device units - -Returns: - - tuple[typing.Any, win32typing.PyRECT]:Handle to a window that has a window region. (see win32gui::SetWindowRgn)Comments - -Only available in winxpgui -Return ValueReturns type of region and rectangle coordinates in device units - - - """ - pass - - -def ValidateRgn(hWnd:'int',hRgn:'win32typing.PyGdiHANDLE') -> 'None': - """ - Removes a region from a window's update region - -Args: - - hWnd(int):Handle to the window - hRgn(win32typing.PyGdiHANDLE):Region to be validated - -Returns: - - None - - """ - pass - - -def InvalidateRgn(hWnd:'int',hRgn:'win32typing.PyGdiHANDLE',Erase:'typing.Any') -> 'None': - """ - Adds a region to a window's update region - -Args: - - hWnd(int):Handle to the window - hRgn(win32typing.PyGdiHANDLE):Region to be redrawn - Erase(typing.Any):Indidates if background should be erased - -Returns: - - None - - """ - pass - - -def GetRgnBox(hrgn:'win32typing.PyGdiHANDLE') -> 'tuple[typing.Any, win32typing.PyRECT]': - """ - Calculates the bounding box of a region - -Args: - - hrgn(win32typing.PyGdiHANDLE):Handle to a regionReturn ValueReturns type of region (COMPLEXREGION, NULLREGION, or SIMPLEREGION) and rectangle in logical units - -Returns: - - tuple[typing.Any, win32typing.PyRECT]:Handle to a regionReturn ValueReturns type of region (COMPLEXREGION, NULLREGION, or SIMPLEREGION) and rectangle in logical units - - - """ - pass - - -def OffsetRgn(hrgn:'win32typing.PyGdiHANDLE',XOffset:'typing.Any',YOffset:'typing.Any') -> 'typing.Any': - """ - Relocates a region - -Args: - - hrgn(win32typing.PyGdiHANDLE):Handle to a region - XOffset(typing.Any):Horizontal offset - YOffset(typing.Any):Vertical offsetReturn ValueReturns type of region (COMPLEXREGION, NULLREGION, or SIMPLEREGION) - -Returns: - - typing.Any:Vertical offsetReturn ValueReturns type of region (COMPLEXREGION, NULLREGION, or SIMPLEREGION) - - - """ - pass - - -def Rectangle(hdc:'int',LeftRect:'typing.Any',TopRect:'typing.Any',RightRect:'typing.Any',BottomRect:'typing.Any') -> 'None': - """ - Creates a solid rectangle using currently selected pen and brush - -Args: - - hdc(int):Handle to device context - LeftRect(typing.Any):Position of left edge of rectangle - TopRect(typing.Any):Position of top edge of rectangle - RightRect(typing.Any):Position of right edge of rectangle - BottomRect(typing.Any):Position of bottom edge of rectangle - -Returns: - - None - - """ - pass - - -def RoundRect(hdc:'int',LeftRect:'typing.Any',TopRect:'typing.Any',RightRect:'typing.Any',BottomRect:'typing.Any',Width:'typing.Any',Height:'typing.Any') -> 'None': - """ - Draws a rectangle with elliptically rounded corners, filled using using current brush - -Args: - - hdc(int):Handle to device context - LeftRect(typing.Any):Position of left edge of rectangle - TopRect(typing.Any):Position of top edge of rectangle - RightRect(typing.Any):Position of right edge of rectangle - BottomRect(typing.Any):Position of bottom edge of rectangle - Width(typing.Any):Width of ellipse - Height(typing.Any):Height of ellipse - -Returns: - - None - - """ - pass - - -def BeginPaint() -> 'tuple[typing.Any, typing.Any]': - """ - None - -Args: - - - -Returns: - - tuple[typing.Any, typing.Any] - - """ - pass - - -def EndPaint(hwnd:'int',ps:'typing.Any') -> 'None': - """ - None - -Args: - - hwnd(typing.Any): - ps(typing.Any):As returned from win32gui::BeginPaint - -Returns: - - None - - """ - pass - - -def BeginPath(hdc:'int') -> 'None': - """ - Initializes a path in a DC - -Args: - - hdc(int):Handle to a device context - -Returns: - - None - - """ - pass - - -def EndPath(hdc:'int') -> 'None': - """ - None - -Args: - - hdc(int):Handle to a device context - -Returns: - - None - - """ - pass - - -def AbortPath(hdc:'int') -> 'None': - """ - None - -Args: - - hdc(int):Handle to a device context - -Returns: - - None - - """ - pass - - -def CloseFigure(hdc:'int') -> 'None': - """ - Closes a section of a path by connecting the beginning pos with the current pos - -Args: - - hdc(int):Handle to a device context that contains an open path. See win32gui::BeginPath. - -Returns: - - None - - """ - pass - - -def FlattenPath(hdc:'int') -> 'None': - """ - Flattens any curves in current path into a series of lines - -Args: - - hdc(int):Handle to a device context that contains a closed path. See win32gui::EndPath. - -Returns: - - None - - """ - pass - - -def FillPath(hdc:'int') -> 'None': - """ - Fills a path with currently selected brush - -Args: - - hdc(int):Handle to a device context that contains a finalized path. See win32gui::EndPath.CommentsAny open figures are closed and path is deselected from the DC. - -Returns: - - None - - """ - pass - - -def WidenPath(hdc:'int') -> 'None': - """ - Widens current path by amount it would increase by if drawn with currently selected pen - -Args: - - hdc(int):Handle to a device context that contains a closed path. See win32gui::EndPath. - -Returns: - - None - - """ - pass - - -def StrokePath(hdc:'int') -> 'None': - """ - Draws current path with currently selected pen - -Args: - - hdc(int):Handle to a device context that contains a closed path. See win32gui::EndPath. - -Returns: - - None - - """ - pass - - -def StrokeAndFillPath(hdc:'int') -> 'None': - """ - Combines operations of StrokePath and FillPath with no overlap - -Args: - - hdc(int):Handle to a device context that contains a closed path. See win32gui::EndPath. - -Returns: - - None - - """ - pass - - -def GetMiterLimit(hdc:'int') -> 'float': - """ - Retrieves the limit of miter joins for a DC - -Args: - - hdc(int):Handle to a device context - -Returns: - - float - - """ - pass - - -def SetMiterLimit(hdc:'int',NewLimit:'float') -> 'float': - """ - Set the limit of miter joins for a DC - -Args: - - hdc(int):Handle to a device context - NewLimit(float):New limit to be setReturn ValueReturns the previous limit - -Returns: - - float:New limit to be setReturn ValueReturns the previous limit - - - """ - pass - - -def PathToRegion(hdc:'int') -> 'win32typing.PyGdiHANDLE': - """ - Converts a closed path in a DC to a region - -Args: - - hdc(int):Handle to a device context that contains a closed path. See win32gui::EndPath.CommentsOn success, the path is deselected from the DC - -Returns: - - win32typing.PyGdiHANDLE - - """ - pass - - -def GetPath(hdc:'int') -> 'tuple[typing.Any, typing.Any]': - """ - Returns a sequence of points that describe the current path - -Args: - - hdc(int):Handle to a device context containing a finalized path. See win32gui::EndPathReturn ValueReturns a sequence of POINT tuples, and a sequence of ints designating each point's function (combination of win32con.PT_* values) - -Returns: - - tuple[typing.Any, typing.Any]:Handle to a device context containing a finalized path. See win32gui::EndPathReturn ValueReturns a sequence of POINT tuples, and a sequence of ints designating each point's function (combination of win32con.PT_* values) - - - """ - pass - - -def CreateRoundRectRgn(LeftRect:'typing.Any',TopRect:'typing.Any',RightRect:'typing.Any',BottomRect:'typing.Any',WidthEllipse:'typing.Any',HeightEllipse:'typing.Any') -> 'typing.Any': - """ - Create a rectangular region with elliptically rounded corners, - -Args: - - LeftRect(typing.Any):Position of left edge of rectangle - TopRect(typing.Any):Position of top edge of rectangle - RightRect(typing.Any):Position of right edge of rectangle - BottomRect(typing.Any):Position of bottom edge of rectangle - WidthEllipse(typing.Any):Width of ellipse - HeightEllipse(typing.Any):Height of ellipse - -Returns: - - typing.Any - - """ - pass - - -def CreateRectRgnIndirect(rc:'win32typing.PyRECT') -> 'typing.Any': - """ - Creates a rectangular region, - -Args: - - rc(win32typing.PyRECT):Coordinates of rectangle - -Returns: - - typing.Any - - """ - pass - - -def CreateEllipticRgnIndirect(rc:'win32typing.PyRECT') -> 'typing.Any': - """ - Creates an ellipse region, - -Args: - - rc(win32typing.PyRECT):Coordinates of bounding rectangle in logical units - -Returns: - - typing.Any - - """ - pass - - -def CreateWindowEx(dwExStyle:'typing.Any',className:'typing.Union[str, typing.Any]',windowTitle:'str',style:'typing.Any',x:'typing.Any',y:'typing.Any',width:'typing.Any',height:'typing.Any',parent:'typing.Any',menu:'typing.Any',hinstance:'typing.Any',reserved:'typing.Any') -> 'typing.Any': - """ - Creates a new window with Extended Style. - -Args: - - dwExStyle(typing.Any):extended window style - className(typing.Union[str, typing.Any]): - windowTitle(str): - style(typing.Any):The style for the window. - x(typing.Any): - y(typing.Any): - width(typing.Any): - height(typing.Any): - parent(typing.Any):Handle to the parent window. - menu(typing.Any):Handle to the menu to use for this window. - hinstance(typing.Any): - reserved(typing.Any):Must be None - -Returns: - - typing.Any - - """ - pass - - -def GetParent(child:'typing.Any') -> 'typing.Any': - """ - Retrieves a handle to the specified child window's parent window. - -Args: - - child(typing.Any):handle to child window - -Returns: - - typing.Any - - """ - pass - - -def SetParent(child:'typing.Any',child1:'typing.Any') -> 'typing.Any': - """ - changes the parent window of the specified child window. - -Args: - - child(typing.Any):handle to window whose parent is changing - child1(typing.Any):handle to new parent window - -Returns: - - typing.Any - - """ - pass - - -def GetCursorPos() -> 'tuple[typing.Any, typing.Any]': - """ - retrieves the cursor's position, in screen coordinates. - -Args: - - - -Returns: - - tuple[typing.Any, typing.Any] - - """ - pass - - -def GetDesktopWindow() -> 'typing.Any': - """ - returns the desktop window - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -def GetWindow(hWnd:'typing.Any',uCmd:'typing.Any') -> 'typing.Any': - """ - returns a window that has the specified relationship (Z order or owner) to the specified window. - -Args: - - hWnd(typing.Any):handle to original window - uCmd(typing.Any):relationship flag - -Returns: - - typing.Any - - """ - pass - - -def GetWindowDC(hWnd:'typing.Any') -> 'typing.Any': - """ - returns the device context (DC) for the entire window, including title bar, menus, and scroll bars. - -Args: - - hWnd(typing.Any):handle of window - -Returns: - - typing.Any - - """ - pass - - -def IsIconic(hWnd:'typing.Any') -> 'None': - """ - determines whether the specified window is minimized (iconic). - -Args: - - hWnd(typing.Any):handle to window - -Returns: - - None - - """ - pass - - -def IsWindow(hWnd:'typing.Any') -> 'None': - """ - determines whether the specified window handle identifies an existing window. - -Args: - - hWnd(typing.Any):handle to window - -Returns: - - None - - """ - pass - - -def IsChild(hWndParent:'typing.Any',hWnd:'typing.Any') -> 'None': - """ - Tests whether a window is a child window or descendant window of a specified parent window - -Args: - - hWndParent(typing.Any):handle to parent window - hWnd(typing.Any):handle to window to test - -Returns: - - None - - """ - pass - - -def ReleaseCapture() -> 'None': - """ - Releases the moust capture for a window. - -Args: - - - -Returns: - - None - - """ - pass - - -def GetCapture() -> 'typing.Any': - """ - Returns the window with the mouse capture. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -def SetCapture() -> 'None': - """ - Captures the mouse for the specified window. - -Args: - - - -Returns: - - None - - """ - pass - - -def _TrackMouseEvent(tme:'win32typing.TRACKMOUSEEVENT') -> 'None': - """ - Posts messages when the mouse pointer leaves a window or hovers over a window for a specified amount of time. - -Args: - - tme(win32typing.TRACKMOUSEEVENT): - -Returns: - - None - - """ - pass - - -def ReleaseDC(hWnd:'typing.Any',hDC:'typing.Any') -> 'typing.Any': - """ - Releases a device context. - -Args: - - hWnd(typing.Any):handle to window - hDC(typing.Any):handle to device context - -Returns: - - typing.Any - - """ - pass - - -def CreateCaret(hWnd:'typing.Any',hBitmap:'win32typing.PyGdiHANDLE',nWidth:'typing.Any',nHeight:'typing.Any') -> 'None': - """ - Creates a new caret for a window - -Args: - - hWnd(typing.Any):handle to owner window - hBitmap(win32typing.PyGdiHANDLE):handle to bitmap for caret shape - nWidth(typing.Any):caret width - nHeight(typing.Any):caret height - -Returns: - - None - - """ - pass - - -def DestroyCaret() -> 'None': - """ - Destroys caret for current task - -Args: - - - -Returns: - - None - - """ - pass - - -def ScrollWindowEx(hWnd:'typing.Any',dx:'typing.Any',dy:'typing.Any',rcScroll:'win32typing.PyRECT',rcClip:'win32typing.PyRECT',hrgnUpdate:'typing.Any',flags:'typing.Any') -> 'tuple[typing.Any, win32typing.PyRECT]': - """ - scrolls the content of the specified window's client area. - -Args: - - hWnd(typing.Any):handle to window to scroll - dx(typing.Any):Amount of horizontal scrolling, in device units - dy(typing.Any):Amount of vertical scrolling, in device units - rcScroll(win32typing.PyRECT):Scroll rectangle, can be None for entire client area - rcClip(win32typing.PyRECT):Clipping rectangle, can be None - hrgnUpdate(typing.Any):Handle to region which will be updated with area invalidated by scroll operation, can be None - flags(typing.Any):Scrolling flags, combination of SW_ERASE,SW_INVALIDATE,SW_SCROLLCHILDREN,SW_SMOOTHSCROLL. If SW_SMOOTHSCROLL is specified, use upper 16 bits to specify time in milliseconds.Return ValueReturns the type of region invalidated by scrolling, and a rectangle defining the affected area. - -Returns: - - tuple[typing.Any, win32typing.PyRECT]:Scrolling flags, combination of SW_ERASE,SW_INVALIDATE,SW_SCROLLCHILDREN,SW_SMOOTHSCROLL. - -If SW_SMOOTHSCROLL is specified, use upper 16 bits to specify time in milliseconds.Return ValueReturns the type of region invalidated by scrolling, and a rectangle defining the affected area. - - - """ - pass - - -def SetScrollInfo(hwnd:'int',nBar:'typing.Any',scollInfo:'win32typing.PySCROLLINFO',bRedraw:'typing.Any'=1) -> 'None': - """ - Sets information about a scroll-bar - -Args: - - hwnd(typing.Any):The handle to the window. - nBar(typing.Any):Identifies the bar. - scollInfo(win32typing.PySCROLLINFO):Scollbar info. - bRedraw(typing.Any):Should the bar be redrawn?Return ValueReturns an int with the current position of the scroll box. - -Returns: - - None:Should the bar be redrawn? -Return ValueReturns an int with the current position of the scroll box. - - - """ - pass - - -def GetScrollInfo(hwnd:'int',nBar:'typing.Any',mask:'typing.Any') -> 'win32typing.PySCROLLINFO': - """ - Returns information about a scroll bar - -Args: - - hwnd(typing.Any):The handle to the window. - nBar(typing.Any):The scroll bar to examine. Can be one of win32con.SB_CTL, win32con.SB_VERT or win32con.SB_HORZ - mask(typing.Any):The mask for attributes to retrieve. - -Returns: - - win32typing.PySCROLLINFO - - """ - pass - - -def GetClassName(hwnd:'int') -> 'str': - """ - Retrieves the name of the class to which the specified window belongs. - -Args: - - hwnd(int):The handle to the window - -Returns: - - str - - """ - pass - - -def WindowFromPoint(point:'tuple[typing.Any, typing.Any]') -> 'typing.Any': - """ - Retrieves a handle to the window that contains the specified point. - -Args: - - point(tuple[typing.Any, typing.Any]):The point. - -Returns: - - typing.Any - - """ - pass - - -def ChildWindowFromPoint(hwndParent:'typing.Any',point:'tuple[typing.Any, typing.Any]') -> 'typing.Any': - """ - Determines which, if any, of the child windows belonging to a parent window contains the specified point. - -Args: - - hwndParent(typing.Any):The parent. - point(tuple[typing.Any, typing.Any]):The point. - -Returns: - - typing.Any - - """ - pass - - -def ChildWindowFromPoint(hwndParent:'typing.Any',point:'tuple[typing.Any, typing.Any]') -> 'typing.Any': - """ - Determines which, if any, of the child windows belonging to a parent window contains the specified point. - -Args: - - hwndParent(typing.Any):The parent. - point(tuple[typing.Any, typing.Any]):The point. - -Returns: - - typing.Any - - """ - pass - - -def ListView_SortItems(hwnd:'int',callback:'typing.Any',param:'typing.Any'=None) -> 'None': - """ - Uses an application-defined comparison function to sort the items of a list view control. - -Args: - - hwnd(typing.Any):The handle to the window - callback(typing.Any):A callback object, taking 3 params. - param(typing.Any):The third param to the callback function. - -Returns: - - None - - """ - pass - - -def ListView_SortItemsEx(hwnd:'int',callback:'typing.Any',param:'typing.Any'=None) -> 'None': - """ - Uses an application-defined comparison function to sort the items of a list view control. - -Args: - - hwnd(typing.Any):The handle to the window - callback(typing.Any):A callback object, taking 3 params. - param(typing.Any):The third param to the callback function. - -Returns: - - None - - """ - pass - - -def CreateDC(Driver:'str',Device:'str',InitData:'win32typing.PyDEVMODE') -> 'typing.Any': - """ - Creates a device context for a printer or display device - -Args: - - Driver(str):Name of display or print provider, usually DISPLAY or WINSPOOL - Device(str):Name of specific device, eg printer name returned from GetDefaultPrinter - InitData(win32typing.PyDEVMODE):A PyDEVMODE that specifies printing parameters, use None for printer defaults - -Returns: - - typing.Any - - """ - pass - - -def GetSaveFileNameW(hwndOwner:'int'=None,hInstance:'int'=None,Filter:'typing.Any'=None,CustomFilter:'typing.Any'=None,FilterIndex:'typing.Any'=0,File:'typing.Any'=None,MaxFile:'typing.Any'=1024,InitialDir:'typing.Any'=None,Title:'typing.Any'=None,Flags:'typing.Any'=0,DefExt:'typing.Any'=None,TemplateName:'win32typing.PyResourceId'=None) -> 'tuple[typing.Any, typing.Any, typing.Any]': - """ - Creates a dialog for user to specify location to save a file or files - -Args: - - hwndOwner(int):Handle to window that owns dialog - hInstance(int):Handle to module that contains dialog template - Filter(typing.Any):Contains pairs of descriptions and filespecs separated by NULLS, with a final trailing NULL. Example: 'Python Scripts\\0*.py;*.pyw;*.pys\\0Text files\\0*.txt\\0' - CustomFilter(typing.Any):Description to be used for filter that user selected or typed, can also contain a filespec as above - FilterIndex(typing.Any):Specifies which of the filters is initially selected, use 0 for CustomFilter - File(typing.Any):The file name initially displayed - MaxFile(typing.Any):Number of characters to allocate for selected filename(s), override if large number of files expected - InitialDir(typing.Any):The starting directory - Title(typing.Any):The title of the dialog box - Flags(typing.Any):Combination of win32con.OFN_* constants - DefExt(typing.Any):The default extension to use - TemplateName(win32typing.PyResourceId):Name or resource id of dialog box templateCommentsAccepts keyword arguments, all arguments optionalReturn ValueReturns a tuple of 3 values (PyUNICODE, PyUNICODE, int): First is the selected file(s). If multiple files are selected, returned string will be the directory followed by files names separated by nulls, otherwise it will be the full path. In other words, if you use the OFN_ALLOWMULTISELECT flag you should split this value on \\0 characters and if the length of the result list is 1, it will be the full path, otherwise element 0 will be the directory and the rest of the elements will be filenames in this directory. Second is a unicode string containing user-selected filter, will be None if CustomFilter was not specified Third item contains flags pertaining to users input, such as OFN_READONLY and OFN_EXTENSIONDIFFERENT If the user presses cancel or an error occurs, a win32gui.error is raised. If the user pressed cancel, the error number (ie, the winerror attribute of the exception) will be zero. - -Returns: - - tuple[typing.Any, typing.Any, typing.Any]:Name or resource id of dialog box template -Comments - -Accepts keyword arguments, all arguments optional -Return ValueReturns a tuple of 3 values (PyUNICODE, PyUNICODE, int): - -First is the selected file(s). If multiple files are selected, returned string will be the directory followed by files names - -separated by nulls, otherwise it will be the full path. In other words, if you use the OFN_ALLOWMULTISELECT flag - -you should split this value on \\0 characters and if the length of the result list is 1, it will be - -the full path, otherwise element 0 will be the directory and the rest of the elements will be filenames in - -this directory. - -Second is a unicode string containing user-selected filter, will be None if CustomFilter was not specified - -Third item contains flags pertaining to users input, such as OFN_READONLY and OFN_EXTENSIONDIFFERENT - -If the user presses cancel or an error occurs, a - -win32gui.error is raised. If the user pressed cancel, the error number (ie, the winerror attribute of the exception) will be zero. - - - """ - pass - - -def GetOpenFileNameW(hwndOwner:'int'=None,hInstance:'int'=None,Filter:'typing.Any'=None,CustomFilter:'typing.Any'=None,FilterIndex:'typing.Any'=0,File:'typing.Any'=None,MaxFile:'typing.Any'=1024,InitialDir:'typing.Any'=None,Title:'typing.Any'=None,Flags:'typing.Any'=0,DefExt:'typing.Any'=None,TemplateName:'win32typing.PyResourceId'=None) -> 'tuple[typing.Any, typing.Any, typing.Any]': - """ - Creates a dialog to allow user to select file(s) to open - -Args: - - hwndOwner(int):Handle to window that owns dialog - hInstance(int):Handle to module that contains dialog template - Filter(typing.Any):Contains pairs of descriptions and filespecs separated by NULLS, with a final trailing NULL. Example: 'Python Scripts\\0*.py;*.pyw;*.pys\\0Text files\\0*.txt\\0' - CustomFilter(typing.Any):Description to be used for filter that user selected or typed, can also contain a filespec as above - FilterIndex(typing.Any):Specifies which of the filters is initially selected, use 0 for CustomFilter - File(typing.Any):The file name initially displayed - MaxFile(typing.Any):Number of characters to allocate for selected filename, override if large number of files expected - InitialDir(typing.Any):The starting directory - Title(typing.Any):The title of the dialog box - Flags(typing.Any):Combination of win32con.OFN_* constants - DefExt(typing.Any):The default extension to use - TemplateName(win32typing.PyResourceId):Name or resource id of dialog box templateCommentsAccepts keyword arguments, all arguments optional Input parameters and return values are identical to win32gui::GetSaveFileNameW - -Returns: - - tuple[typing.Any, typing.Any, typing.Any] - - """ - pass - - -def SystemParametersInfo(Action:'typing.Any',Param:'typing.Any'=None,WinIni:'typing.Any'=0) -> 'None': - """ - Queries or sets system-wide parameters. This function can also update the user profile while setting a parameter. - -Args: - - Action(typing.Any):System parameter to query or set, one of the SPI_GET* or SPI_SET* constants - Param(typing.Any):depends on action to be taken - WinIni(typing.Any):Flags specifying whether change should be permanent, and if all windows should be notified of change. Combination of SPIF_UPDATEINIFILE, SPIF_SENDCHANGE, SPIF_SENDWININICHANGEActionInput/return typeSPI_GETDESKWALLPAPERReturns the path to the bmp used as wallpaperSPI_SETDESKWALLPAPERParam should be a string specifying a .bmp fileSPI_GETDROPSHADOWReturns a booleanSPI_GETFLATMENUReturns a booleanSPI_GETFONTSMOOTHINGReturns a booleanSPI_GETICONTITLEWRAPReturns a booleanSPI_GETSNAPTODEFBUTTONReturns a booleanSPI_GETBEEPReturns a booleanSPI_GETBLOCKSENDINPUTRESETSReturns a booleanSPI_GETMENUUNDERLINESReturns a booleanSPI_GETKEYBOARDCUESReturns a booleanSPI_GETKEYBOARDPREFReturns a booleanSPI_GETSCREENSAVEACTIVEReturns a booleanSPI_GETSCREENSAVERRUNNINGReturns a booleanSPI_GETMENUDROPALIGNMENTReturns a boolean (True indicates left aligned, False right aligned)SPI_GETMENUFADEReturns a booleanSPI_GETLOWPOWERACTIVEReturns a booleanSPI_GETPOWEROFFACTIVEReturns a booleanSPI_GETCOMBOBOXANIMATIONReturns a booleanSPI_GETCURSORSHADOWReturns a booleanSPI_GETGRADIENTCAPTIONSReturns a booleanSPI_GETHOTTRACKINGReturns a booleanSPI_GETLISTBOXSMOOTHSCROLLINGReturns a booleanSPI_GETMENUANIMATIONReturns a booleanSPI_GETSELECTIONFADEReturns a booleanSPI_GETTOOLTIPANIMATIONReturns a booleanSPI_GETTOOLTIPFADEReturns a boolean (TRUE=fade, False=slide)SPI_GETUIEFFECTSReturns a booleanSPI_GETACTIVEWINDOWTRACKINGReturns a booleanSPI_GETACTIVEWNDTRKZORDERReturns a booleanSPI_GETDRAGFULLWINDOWSReturns a booleanSPI_GETSHOWIMEUIReturns a booleanSPI_GETMOUSECLICKLOCKReturns a booleanSPI_GETMOUSESONARReturns a booleanSPI_GETMOUSEVANISHReturns a booleanSPI_GETSCREENREADERReturns a booleanSPI_GETSHOWSOUNDSReturns a booleanSPI_SETDROPSHADOWParam must be a booleanSPI_SETDROPSHADOWParam must be a booleanSPI_SETMENUUNDERLINESParam must be a booleanSPI_SETKEYBOARDCUESParam must be a booleanSPI_SETMENUFADEParam must be a booleanSPI_SETCOMBOBOXANIMATIONParam must be a booleanSPI_SETCURSORSHADOWParam must be a booleanSPI_SETGRADIENTCAPTIONSParam must be a booleanSPI_SETHOTTRACKINGParam must be a booleanSPI_SETLISTBOXSMOOTHSCROLLINGParam must be a booleanSPI_SETMENUANIMATIONParam must be a booleanSPI_SETSELECTIONFADEParam must be a booleanSPI_SETTOOLTIPANIMATIONParam must be a booleanSPI_SETTOOLTIPFADEParam must be a booleanSPI_SETUIEFFECTSParam must be a booleanSPI_SETACTIVEWINDOWTRACKINGParam must be a booleanSPI_SETACTIVEWNDTRKZORDERParam must be a booleanSPI_SETMOUSESONARParam must be a booleanSPI_SETMOUSEVANISHParam must be a booleanSPI_SETMOUSECLICKLOCKParam must be a booleanSPI_SETFONTSMOOTHINGParam should specify a booleanSPI_SETICONTITLEWRAPParam should specify a booleanSPI_SETSNAPTODEFBUTTONParam is a booleanSPI_SETBEEPParam is a booleanSPI_SETBLOCKSENDINPUTRESETSParam is a booleanSPI_SETKEYBOARDPREFParam is a booleanSPI_SETMOUSEBUTTONSWAPParam is a booleanSPI_SETSCREENSAVEACTIVEParam is a booleanSPI_SETMENUDROPALIGNMENTParam is a boolean (True=left aligned, False=right aligned)SPI_SETLOWPOWERACTIVEParam is a booleanSPI_SETPOWEROFFACTIVEParam is a booleanSPI_SETDRAGFULLWINDOWSParam is a booleanSPI_SETSHOWIMEUIParam is a booleanSPI_SETSCREENREADERParam is a booleanSPI_SETSHOWSOUNDSParam is a booleanSPI_SETMOUSETRAILSParam should be an int specifying the nbr of cursors in the trail (0 or 1 means disabled)SPI_SETWHEELSCROLLLINESParam is an int specifying nbr of linesSPI_SETKEYBOARDDELAYParam is an int in the range 0 - 3SPI_SETKEYBOARDSPEEDParam is an int in the range 0 - 31SPI_SETDOUBLECLICKTIMEParam is an int (in milliseconds), Use win32gui::GetDoubleClickTime to retrieve the value.SPI_SETDOUBLECLKWIDTHParam is an int. Use win32api.GetSystemMetrics(SM_CXDOUBLECLK) to retrieve the value.SPI_SETDOUBLECLKHEIGHTParam is an int, Use win32api.GetSystemMetrics(SM_CYDOUBLECLK) to retrieve the value.SPI_SETMOUSEHOVERHEIGHTParam is an intSPI_SETMOUSEHOVERWIDTHParam is an intSPI_SETMOUSEHOVERTIMEParam is an intSPI_SETSCREENSAVETIMEOUTParam is an int specifying the timeout in secondsSPI_SETMENUSHOWDELAYParam is an int specifying the shortcut menu delay in millisecondsSPI_SETLOWPOWERTIMEOUTParam is an int (in seconds)SPI_SETPOWEROFFTIMEOUTParam is an int (in seconds)SPI_SETDRAGHEIGHTParam is an int. Use win32api.GetSystemMetrics(SM_CYDRAG) to retrieve the value.SPI_SETDRAGWIDTHParam is an int. Use win32api.GetSystemMetrics(SM_CXDRAG) to retrieve the value.SPI_SETBORDERParam is an intSPI_GETFONTSMOOTHINGCONTRASTReturns an intSPI_GETFONTSMOOTHINGTYPEReturns an intSPI_GETMOUSETRAILSReturns an int specifying the nbr of cursor images in the trail, 0 or 1 indicates disabledSPI_GETWHEELSCROLLLINESReturns the nbr of lines to scroll for the mouse wheelSPI_GETKEYBOARDDELAYReturns an intSPI_GETKEYBOARDSPEEDReturns an intSPI_GETMOUSESPEEDReturns an intSPI_GETMOUSEHOVERHEIGHTReturns an intSPI_GETMOUSEHOVERWIDTHReturns an intSPI_GETMOUSEHOVERTIMEReturns an intSPI_GETSCREENSAVETIMEOUTReturns an int (idle time in seconds)SPI_GETMENUSHOWDELAYReturns an int (shortcut delay in milliseconds)SPI_GETLOWPOWERTIMEOUTReturns an int (in seconds)SPI_GETPOWEROFFTIMEOUTReturns an int (in seconds)SPI_GETACTIVEWNDTRKTIMEOUTReturns an int (milliseconds)SPI_GETBORDERReturns an intSPI_GETCARETWIDTHReturns an intSPI_GETFOREGROUNDFLASHCOUNTReturns an intSPI_GETFOREGROUNDLOCKTIMEOUTReturns an intSPI_GETFOCUSBORDERHEIGHTReturns an intSPI_GETFOCUSBORDERWIDTHReturns an intSPI_GETMOUSECLICKLOCKTIMEReturns an int (in milliseconds)SPI_SETFONTSMOOTHINGCONTRASTParam should be an int in the range 1000 to 2200SPI_SETFONTSMOOTHINGTYPEParam should be one of the FE_FONTSMOOTHING* constantsSPI_SETMOUSESPEEDParam should be an int in the range 1 - 20SPI_SETACTIVEWNDTRKTIMEOUTParam is an int (in milliseconds)SPI_SETCARETWIDTHParam is an int (in pixels)SPI_SETFOREGROUNDFLASHCOUNTParam is an intSPI_SETFOREGROUNDLOCKTIMEOUTParam is an int (in milliseconds)SPI_SETFOCUSBORDERHEIGHTReturns an intSPI_SETFOCUSBORDERWIDTHReturns an intSPI_SETMOUSECLICKLOCKTIMEParam is an int (in milliseconds)SPI_GETICONTITLELOGFONTReturns a PyLOGFONT,SPI_SETICONTITLELOGFONTParam must be a PyLOGFONT,SPI_SETLANGTOGGLEParam is ignored. Sets the language toggle hotkey from registry key HKCU\\keyboard layout\\toggleSPI_SETICONSReloads the system icons. Param is not usedSPI_GETMOUSEReturns a tuple of 3 ints containing the x and y mouse thresholds and the acceleration factor.SPI_SETMOUSEParam should be a sequence of 3 intsSPI_GETDEFAULTINPUTLANGReturns an int (locale id for default language)SPI_SETDEFAULTINPUTLANGParam is an int containing a locale idSPI_GETANIMATIONReturns an intSPI_SETANIMATIONParam is an intSPI_ICONHORIZONTALSPACINGFunctions as both a get and set operation. If Param is None, functions as a get operation, otherwise Param is an int to be set as the new valueSPI_ICONVERTICALSPACINGFunctions as both a get and set operation. If Param is None, functions as a get operation, otherwise Param is an int to be set as the new valueSPI_GETNONCLIENTMETRICSParam must be None. The result is a dict.SPI_SETNONCLIENTMETRICSParam is a dict in the form of a NONCLIENTMETRICS struct, as returned by SPI_GETNONCLIENTMETRICS operationSPI_GETMINIMIZEDMETRICSReturns a dict representing a MINIMIZEDMETRICS struct. Param is not used.SPI_SETMINIMIZEDMETRICSParam should be a MINIMIZEDMETRICS dict as returned by SPI_GETMINIMIZEDMETRICS actionSPI_SETDESKPATTERNUnsupported (obsolete)SPI_GETFASTTASKSWITCHUnsupported (obsolete)SPI_SETFASTTASKSWITCHUnsupported (obsolete)SPI_SETSCREENSAVERRUNNINGUnsupported (documented as internal use only)SPI_SCREENSAVERRUNNINGSame as SPI_SETSCREENSAVERRUNNINGSPI_SETPENWINDOWSUnsupported (only relevant for win95)SPI_GETWINDOWSEXTENSIONUnsupported (only relevant for win95)SPI_GETGRIDGRANULARITYUnsupported (obsolete)SPI_SETGRIDGRANULARITYUnsupported (obsolete)SPI_LANGDRIVERUnsupported (use is not documented)SPI_GETFONTSMOOTHINGORIENTATIONUnsupported (use is not documented)SPI_SETFONTSMOOTHINGORIENTATIONUnsupported (use is not documented)SPI_SETHANDHELDUnsupported (use is not documented)SPI_GETICONMETRICSNot implemented yetSPI_SETICONMETRICSNot implemented yetSPI_GETWORKAREANot implemented yetSPI_SETWORKAREANot implemented yetSPI_GETSERIALKEYSNot implemented yetSPI_SETSERIALKEYSNot implemented yetSPI_SETMOUSEKEYSNot implemented yetSPI_GETMOUSEKEYSNot implemented yetSPI_GETHIGHCONTRASTNot implemented yetSPI_SETHIGHCONTRASTNot implemented yetSPI_GETSOUNDSENTRYNot implemented yetSPI_SETSOUNDSENTRYNot implemented yetSPI_GETSTICKYKEYSNot implemented yetSPI_SETSTICKYKEYSNot implemented yetSPI_GETTOGGLEKEYSNot implemented yetSPI_SETTOGGLEKEYSNot implemented yetSPI_GETACCESSTIMEOUTNot implemented yetSPI_SETACCESSTIMEOUTNot implemented yetSPI_GETFILTERKEYSNot implemented yetSPI_SETFILTERKEYSNot implemented yetCommentsParam and WinIni are not used with any of the SPI_GET operations Boolean parameters can be any object that can be evaluated as True or FalseReturn ValueSPI_SET functions all return None on success. Types returned by SPI_GET functions are dependent on the operation - -Returns: - - None:Flags specifying whether change should be permanent, and if all windows should be notified of change. Combination of SPIF_UPDATEINIFILE, SPIF_SENDCHANGE, SPIF_SENDWININICHANGE - - - -Action - - -Input/return type - - - -SPI_GETDESKWALLPAPERReturns the path to the bmp used as wallpaper -SPI_SETDESKWALLPAPERParam should be a string specifying a .bmp file -SPI_GETDROPSHADOWReturns a boolean -SPI_GETFLATMENUReturns a boolean -SPI_GETFONTSMOOTHINGReturns a boolean -SPI_GETICONTITLEWRAPReturns a boolean -SPI_GETSNAPTODEFBUTTONReturns a boolean -SPI_GETBEEPReturns a boolean -SPI_GETBLOCKSENDINPUTRESETSReturns a boolean -SPI_GETMENUUNDERLINESReturns a boolean -SPI_GETKEYBOARDCUESReturns a boolean -SPI_GETKEYBOARDPREFReturns a boolean -SPI_GETSCREENSAVEACTIVEReturns a boolean -SPI_GETSCREENSAVERRUNNINGReturns a boolean -SPI_GETMENUDROPALIGNMENTReturns a boolean (True indicates left aligned, False right aligned) -SPI_GETMENUFADEReturns a boolean -SPI_GETLOWPOWERACTIVEReturns a boolean -SPI_GETPOWEROFFACTIVEReturns a boolean -SPI_GETCOMBOBOXANIMATIONReturns a boolean -SPI_GETCURSORSHADOWReturns a boolean -SPI_GETGRADIENTCAPTIONSReturns a boolean -SPI_GETHOTTRACKINGReturns a boolean -SPI_GETLISTBOXSMOOTHSCROLLINGReturns a boolean -SPI_GETMENUANIMATIONReturns a boolean -SPI_GETSELECTIONFADEReturns a boolean -SPI_GETTOOLTIPANIMATIONReturns a boolean -SPI_GETTOOLTIPFADEReturns a boolean (TRUE=fade, False=slide) -SPI_GETUIEFFECTSReturns a boolean -SPI_GETACTIVEWINDOWTRACKINGReturns a boolean -SPI_GETACTIVEWNDTRKZORDERReturns a boolean -SPI_GETDRAGFULLWINDOWSReturns a boolean -SPI_GETSHOWIMEUIReturns a boolean -SPI_GETMOUSECLICKLOCKReturns a boolean -SPI_GETMOUSESONARReturns a boolean -SPI_GETMOUSEVANISHReturns a boolean -SPI_GETSCREENREADERReturns a boolean -SPI_GETSHOWSOUNDSReturns a boolean -SPI_SETDROPSHADOWParam must be a boolean -SPI_SETDROPSHADOWParam must be a boolean -SPI_SETMENUUNDERLINESParam must be a boolean -SPI_SETKEYBOARDCUESParam must be a boolean -SPI_SETMENUFADEParam must be a boolean -SPI_SETCOMBOBOXANIMATIONParam must be a boolean -SPI_SETCURSORSHADOWParam must be a boolean -SPI_SETGRADIENTCAPTIONSParam must be a boolean -SPI_SETHOTTRACKINGParam must be a boolean -SPI_SETLISTBOXSMOOTHSCROLLINGParam must be a boolean -SPI_SETMENUANIMATIONParam must be a boolean -SPI_SETSELECTIONFADEParam must be a boolean -SPI_SETTOOLTIPANIMATIONParam must be a boolean -SPI_SETTOOLTIPFADEParam must be a boolean -SPI_SETUIEFFECTSParam must be a boolean -SPI_SETACTIVEWINDOWTRACKINGParam must be a boolean -SPI_SETACTIVEWNDTRKZORDERParam must be a boolean -SPI_SETMOUSESONARParam must be a boolean -SPI_SETMOUSEVANISHParam must be a boolean -SPI_SETMOUSECLICKLOCKParam must be a boolean -SPI_SETFONTSMOOTHINGParam should specify a boolean -SPI_SETICONTITLEWRAPParam should specify a boolean -SPI_SETSNAPTODEFBUTTONParam is a boolean -SPI_SETBEEPParam is a boolean -SPI_SETBLOCKSENDINPUTRESETSParam is a boolean -SPI_SETKEYBOARDPREFParam is a boolean -SPI_SETMOUSEBUTTONSWAPParam is a boolean -SPI_SETSCREENSAVEACTIVEParam is a boolean -SPI_SETMENUDROPALIGNMENTParam is a boolean (True=left aligned, False=right aligned) -SPI_SETLOWPOWERACTIVEParam is a boolean -SPI_SETPOWEROFFACTIVEParam is a boolean -SPI_SETDRAGFULLWINDOWSParam is a boolean -SPI_SETSHOWIMEUIParam is a boolean -SPI_SETSCREENREADERParam is a boolean -SPI_SETSHOWSOUNDSParam is a boolean -SPI_SETMOUSETRAILSParam should be an int specifying the nbr of cursors in the trail (0 or 1 means disabled) -SPI_SETWHEELSCROLLLINESParam is an int specifying nbr of lines -SPI_SETKEYBOARDDELAYParam is an int in the range 0 - 3 -SPI_SETKEYBOARDSPEEDParam is an int in the range 0 - 31 -SPI_SETDOUBLECLICKTIMEParam is an int (in milliseconds), Use win32gui::GetDoubleClickTime to retrieve the value. -SPI_SETDOUBLECLKWIDTHParam is an int. Use win32api.GetSystemMetrics(SM_CXDOUBLECLK) to retrieve the value. -SPI_SETDOUBLECLKHEIGHTParam is an int, Use win32api.GetSystemMetrics(SM_CYDOUBLECLK) to retrieve the value. -SPI_SETMOUSEHOVERHEIGHTParam is an int -SPI_SETMOUSEHOVERWIDTHParam is an int -SPI_SETMOUSEHOVERTIMEParam is an int -SPI_SETSCREENSAVETIMEOUTParam is an int specifying the timeout in seconds -SPI_SETMENUSHOWDELAYParam is an int specifying the shortcut menu delay in milliseconds -SPI_SETLOWPOWERTIMEOUTParam is an int (in seconds) -SPI_SETPOWEROFFTIMEOUTParam is an int (in seconds) -SPI_SETDRAGHEIGHTParam is an int. Use win32api.GetSystemMetrics(SM_CYDRAG) to retrieve the value. -SPI_SETDRAGWIDTHParam is an int. Use win32api.GetSystemMetrics(SM_CXDRAG) to retrieve the value. -SPI_SETBORDERParam is an int -SPI_GETFONTSMOOTHINGCONTRASTReturns an int -SPI_GETFONTSMOOTHINGTYPEReturns an int -SPI_GETMOUSETRAILSReturns an int specifying the nbr of cursor images in the trail, 0 or 1 indicates disabled -SPI_GETWHEELSCROLLLINESReturns the nbr of lines to scroll for the mouse wheel -SPI_GETKEYBOARDDELAYReturns an int -SPI_GETKEYBOARDSPEEDReturns an int -SPI_GETMOUSESPEEDReturns an int -SPI_GETMOUSEHOVERHEIGHTReturns an int -SPI_GETMOUSEHOVERWIDTHReturns an int -SPI_GETMOUSEHOVERTIMEReturns an int -SPI_GETSCREENSAVETIMEOUTReturns an int (idle time in seconds) -SPI_GETMENUSHOWDELAYReturns an int (shortcut delay in milliseconds) -SPI_GETLOWPOWERTIMEOUTReturns an int (in seconds) -SPI_GETPOWEROFFTIMEOUTReturns an int (in seconds) -SPI_GETACTIVEWNDTRKTIMEOUTReturns an int (milliseconds) -SPI_GETBORDERReturns an int -SPI_GETCARETWIDTHReturns an int -SPI_GETFOREGROUNDFLASHCOUNTReturns an int -SPI_GETFOREGROUNDLOCKTIMEOUTReturns an int -SPI_GETFOCUSBORDERHEIGHTReturns an int -SPI_GETFOCUSBORDERWIDTHReturns an int -SPI_GETMOUSECLICKLOCKTIMEReturns an int (in milliseconds) -SPI_SETFONTSMOOTHINGCONTRASTParam should be an int in the range 1000 to 2200 -SPI_SETFONTSMOOTHINGTYPEParam should be one of the FE_FONTSMOOTHING* constants -SPI_SETMOUSESPEEDParam should be an int in the range 1 - 20 -SPI_SETACTIVEWNDTRKTIMEOUTParam is an int (in milliseconds) -SPI_SETCARETWIDTHParam is an int (in pixels) -SPI_SETFOREGROUNDFLASHCOUNTParam is an int -SPI_SETFOREGROUNDLOCKTIMEOUTParam is an int (in milliseconds) -SPI_SETFOCUSBORDERHEIGHTReturns an int -SPI_SETFOCUSBORDERWIDTHReturns an int -SPI_SETMOUSECLICKLOCKTIMEParam is an int (in milliseconds) -SPI_GETICONTITLELOGFONTReturns a PyLOGFONT, -SPI_SETICONTITLELOGFONTParam must be a PyLOGFONT, -SPI_SETLANGTOGGLEParam is ignored. Sets the language toggle hotkey from registry key HKCU\\keyboard layout\\toggle -SPI_SETICONSReloads the system icons. Param is not used -SPI_GETMOUSEReturns a tuple of 3 ints containing the x and y mouse thresholds and the acceleration factor. -SPI_SETMOUSEParam should be a sequence of 3 ints -SPI_GETDEFAULTINPUTLANGReturns an int (locale id for default language) -SPI_SETDEFAULTINPUTLANGParam is an int containing a locale id -SPI_GETANIMATIONReturns an int -SPI_SETANIMATIONParam is an int -SPI_ICONHORIZONTALSPACINGFunctions as both a get and set operation. If Param is None, functions as a get operation, otherwise Param is an int to be set as the new value -SPI_ICONVERTICALSPACINGFunctions as both a get and set operation. If Param is None, functions as a get operation, otherwise Param is an int to be set as the new value -SPI_GETNONCLIENTMETRICSParam must be None. The result is a dict. -SPI_SETNONCLIENTMETRICSParam is a dict in the form of a NONCLIENTMETRICS struct, as returned by SPI_GETNONCLIENTMETRICS operation -SPI_GETMINIMIZEDMETRICSReturns a dict representing a MINIMIZEDMETRICS struct. Param is not used. -SPI_SETMINIMIZEDMETRICSParam should be a MINIMIZEDMETRICS dict as returned by SPI_GETMINIMIZEDMETRICS action -SPI_SETDESKPATTERNUnsupported (obsolete) -SPI_GETFASTTASKSWITCHUnsupported (obsolete) -SPI_SETFASTTASKSWITCHUnsupported (obsolete) -SPI_SETSCREENSAVERRUNNINGUnsupported (documented as internal use only) -SPI_SCREENSAVERRUNNINGSame as SPI_SETSCREENSAVERRUNNING -SPI_SETPENWINDOWSUnsupported (only relevant for win95) -SPI_GETWINDOWSEXTENSIONUnsupported (only relevant for win95) -SPI_GETGRIDGRANULARITYUnsupported (obsolete) -SPI_SETGRIDGRANULARITYUnsupported (obsolete) -SPI_LANGDRIVERUnsupported (use is not documented) -SPI_GETFONTSMOOTHINGORIENTATIONUnsupported (use is not documented) -SPI_SETFONTSMOOTHINGORIENTATIONUnsupported (use is not documented) -SPI_SETHANDHELDUnsupported (use is not documented) -SPI_GETICONMETRICSNot implemented yet -SPI_SETICONMETRICSNot implemented yet -SPI_GETWORKAREANot implemented yet -SPI_SETWORKAREANot implemented yet -SPI_GETSERIALKEYSNot implemented yet -SPI_SETSERIALKEYSNot implemented yet -SPI_SETMOUSEKEYSNot implemented yet -SPI_GETMOUSEKEYSNot implemented yet -SPI_GETHIGHCONTRASTNot implemented yet -SPI_SETHIGHCONTRASTNot implemented yet -SPI_GETSOUNDSENTRYNot implemented yet -SPI_SETSOUNDSENTRYNot implemented yet -SPI_GETSTICKYKEYSNot implemented yet -SPI_SETSTICKYKEYSNot implemented yet -SPI_GETTOGGLEKEYSNot implemented yet -SPI_SETTOGGLEKEYSNot implemented yet -SPI_GETACCESSTIMEOUTNot implemented yet -SPI_SETACCESSTIMEOUTNot implemented yet -SPI_GETFILTERKEYSNot implemented yet -SPI_SETFILTERKEYSNot implemented yet -Comments - -Param and WinIni are not used with any of the SPI_GET operations - -Boolean parameters can be any object that can be evaluated as True or False -Return ValueSPI_SET functions all return None on success. Types returned by SPI_GET functions are dependent on the operation - - - """ - pass - - -def SetLayeredWindowAttributes(hwnd:'int',Key:'typing.Any',Alpha:'typing.Any',Flags:'typing.Any') -> 'None': - """ - Sets the opacity and transparency color key of a layered window. - -Args: - - hwnd(int):handle to the layered window - Key(typing.Any):Specifies the color key. Use win32api::RGB to generate value. - Alpha(typing.Any):Opacity, in the range 0-255 - Flags(typing.Any):Combination of win32con.LWA_* valuesCommentsThis function only exists on Win2k and laterAccepts keyword arguments - -Returns: - - None - - """ - pass - - -def GetLayeredWindowAttributes(hwnd:'int') -> 'tuple[typing.Any, typing.Any, typing.Any]': - """ - Retrieves the layering parameters of a window with the WS_EX_LAYERED extended style - -Args: - - hwnd(int):Handle to a layered windowCommentsThis function only exists on WinXP and later.Accepts keyword arguments.Return ValueReturns a tuple of (color key, alpha, flags) - -Returns: - - tuple[typing.Any, typing.Any, typing.Any]:Handle to a layered windowComments - -This function only exists on WinXP and later. - -Accepts keyword arguments. -Return ValueReturns a tuple of (color key, alpha, flags) - - - """ - pass - - -def UpdateLayeredWindow(hwnd:'int',arg:'tuple[int, int, int, int]',hdcDst:'int'=None,ptDst:'tuple[typing.Any, typing.Any]'=None,size:'tuple[typing.Any, typing.Any]'=None,hdcSrc:'typing.Any'=None,ptSrc:'tuple[typing.Any, typing.Any]'=None,Key:'typing.Any'=0,Flags:'typing.Any'=0) -> 'None': - """ - Updates the position, size, shape, content, and translucency of a layered window. - -Args: - - hwnd(int):handle to layered window - arg(tuple[int, int, int, int]):PyBLENDFUNCTION specifying alpha blending parameters - hdcDst(int):handle to screen DC, can be None. *Must* be None if hdcSrc is None - ptDst(tuple[typing.Any, typing.Any]):New screen position, can be None. - size(tuple[typing.Any, typing.Any]):New size of the layered window, can be None. *Must* be None if hdcSrc is None. - hdcSrc(typing.Any):handle to surface DC for the window, can be None - ptSrc(tuple[typing.Any, typing.Any]):layer position, can be None. *Must* be None if hdcSrc is None. - Key(typing.Any):Color key, generate using win32api::RGB - Flags(typing.Any):One of the win32con.ULW_* values. Use 0 if hdcSrc is None.CommentsThis function is only available on Windows 2000 and laterAccepts keyword arguments. - -Returns: - - None - - """ - pass - - -def AnimateWindow(hwnd:'int',Time:'typing.Any',Flags:'typing.Any') -> 'None': - """ - Enables you to produce special effects when showing or hiding windows. There are three types of animation: roll, slide, and alpha-blended fade. - -Args: - - hwnd(int):handle to window - Time(typing.Any):Duration of animation in ms - Flags(typing.Any):Animation type, combination of win32con.AW_* flagsCommentsThis function is available on Win2k and laterAccepts keyword args - -Returns: - - None - - """ - pass - - -def CreateBrushIndirect(lb:'win32typing.PyLOGBRUSH') -> 'win32typing.PyGdiHANDLE': - """ - Creates a GDI brush from a LOGBRUSH struct - -Args: - - lb(win32typing.PyLOGBRUSH):Dict containing brush creation parameters - -Returns: - - win32typing.PyGdiHANDLE - - """ - pass - - -def ExtCreatePen(PenStyle:'typing.Any',Width:'typing.Any',lb:'win32typing.PyLOGBRUSH',Style:'tuple[typing.Any, ...]'=None) -> 'int': - """ - Creates a GDI pen object - -Args: - - PenStyle(typing.Any):Combination of win32con.PS_*. Must contain either PS_GEOMETRIC or PS_COSMETIC. - Width(typing.Any):Width of pen in logical units. Must be 1 for PS_COSMETIC. - lb(win32typing.PyLOGBRUSH):Dict containing brush creation parameters - Style(tuple[typing.Any, ...]):Sequence containing lengths of dashes and spaces Used only with PS_USERSTYLE, otherwise must be None. - -Returns: - - int - - """ - pass - - -def DrawTextW(hDC:'int',String:'str',Count:'typing.Any',Rect:'win32typing.PyRECT',Format:'typing.Any') -> 'tuple[typing.Any, win32typing.PyRECT]': - """ - Draws Unicode text on a device context. - -Args: - - hDC(int):Handle to a device context - String(str):Text to be drawn - Count(typing.Any):Number of characters to draw, use -1 for entire null terminated string - Rect(win32typing.PyRECT):Rectangle in which to draw text - Format(typing.Any):Formatting flags, combination of win32con.DT_* valuesCommentsAccepts keyword args.Return ValueReturns the height of the drawn text, and the rectangle coordinates - -Returns: - - tuple[typing.Any, win32typing.PyRECT]:Formatting flags, combination of win32con.DT_* valuesComments - -Accepts keyword args. -Return ValueReturns the height of the drawn text, and the rectangle coordinates - - - """ - pass - - -def EnumPropsEx(hWnd:'int',EnumFunc:'typing.Any',Param:'typing.Any') -> 'None': - """ - None - -Args: - - hWnd(int):Handle to a window - EnumFunc(typing.Any):Callback function - Param(typing.Any):Arbitrary object to be passed to callback function - -Returns: - - None - - """ - pass - - -def RegisterDeviceNotification(handle:'int',_filter:'typing.Any',flags:'typing.Any') -> 'win32typing.PyHDEVNOTIFY': - """ - Registers the device or type of device for which a window will receive notifications. - -Args: - - handle(int):The handle to a window or a service - _filter(typing.Any):A buffer laid out like one of the DEV_BROADCAST_* structures, generally built by one of the win32gui_struct helpers. - flags(typing.Any):Win32 API References - -Returns: - - win32typing.PyHDEVNOTIFY - - """ - pass - - -def UnregisterDeviceNotification() -> 'None': - """ - Unregisters a Device Notification handle. - -It is generally not necessary to call this function manually, but in some cases, - -handle values may be extracted via the struct module and need to be closed explicitly. - -Args: - - - -Returns: - - None - - """ - pass - - -def RegisterHotKey(hWnd:'int',_id:'typing.Any',Modifiers:'typing.Any',vk:'typing.Any') -> 'None': - """ - Registers a hotkey for a window - -Args: - - hWnd(int):Handle to window that will receive WM_HOTKEY messages - _id(typing.Any):Unique id to be used for the hot key - Modifiers(typing.Any):Control keys, combination of win32con.MOD_* - vk(typing.Any):Virtual key codeWin32 API References - -Returns: - - None - - """ - pass - -CLR_NONE = ... -ILC_COLOR = ... -ILC_COLOR16 = ... -ILC_COLOR24 = ... -ILC_COLOR32 = ... -ILC_COLOR4 = ... -ILC_COLOR8 = ... -ILC_COLORDDB = ... -ILC_MASK = ... -ILD_BLEND = ... -ILD_BLEND25 = ... -ILD_BLEND50 = ... -ILD_FOCUS = ... -ILD_MASK = ... -ILD_NORMAL = ... -ILD_SELECTED = ... -ILD_TRANSPARENT = ... -IMAGE_BITMAP = ... -IMAGE_CURSOR = ... -IMAGE_ICON = ... -LR_CREATEDIBSECTION = ... -LR_DEFAULTCOLOR = ... -LR_DEFAULTSIZE = ... -LR_LOADFROMFILE = ... -LR_LOADMAP3DCOLORS = ... -LR_LOADTRANSPARENT = ... -LR_MONOCHROME = ... -LR_SHARED = ... -LR_VGACOLOR = ... -NIF_ICON = ... -NIF_INFO = ... -NIF_MESSAGE = ... -NIF_STATE = ... -NIF_TIP = ... -NIIF_ERROR = ... -NIIF_ICON_MASK = ... -NIIF_INFO = ... -NIIF_NONE = ... -NIIF_NOSOUND = ... -NIIF_WARNING = ... -NIM_ADD = ... -NIM_DELETE = ... -NIM_MODIFY = ... -NIM_SETFOCUS = ... -NIM_SETVERSION = ... -TPM_BOTTOMALIGN = ... -TPM_CENTERALIGN = ... -TPM_LEFTALIGN = ... -TPM_LEFTBUTTON = ... -TPM_NONOTIFY = ... -TPM_RETURNCMD = ... -TPM_RIGHTALIGN = ... -TPM_RIGHTBUTTON = ... -TPM_TOPALIGN = ... -TPM_VCENTERALIGN = ... diff --git a/typings/win32con/__init__.pyi b/typings/win32con/__init__.pyi deleted file mode 100644 index 92e62fdc..00000000 --- a/typings/win32con/__init__.pyi +++ /dev/null @@ -1,5045 +0,0 @@ -""" -This type stub file was generated by pyright. -""" - -# Generated by h2py from commdlg.h (plus modifications 4jan98) -WINVER = 1280 -WM_USER = 1024 -PY_0U = 0 -OFN_READONLY = 1 -OFN_OVERWRITEPROMPT = 2 -OFN_HIDEREADONLY = 4 -OFN_NOCHANGEDIR = 8 -OFN_SHOWHELP = 16 -OFN_ENABLEHOOK = 32 -OFN_ENABLETEMPLATE = 64 -OFN_ENABLETEMPLATEHANDLE = 128 -OFN_NOVALIDATE = 256 -OFN_ALLOWMULTISELECT = 512 -OFN_EXTENSIONDIFFERENT = 1024 -OFN_PATHMUSTEXIST = 2048 -OFN_FILEMUSTEXIST = 4096 -OFN_CREATEPROMPT = 8192 -OFN_SHAREAWARE = 16384 -OFN_NOREADONLYRETURN = 32768 -OFN_NOTESTFILECREATE = 65536 -OFN_NONETWORKBUTTON = 131072 -OFN_NOLONGNAMES = 262144 -OFN_EXPLORER = 524288 # new look commdlg -OFN_NODEREFERENCELINKS = 1048576 -OFN_LONGNAMES = 2097152 # force long names for 3.x modules -OFN_ENABLEINCLUDENOTIFY = 4194304 # send include message to callback -OFN_ENABLESIZING = 8388608 -OFN_DONTADDTORECENT = 33554432 -OFN_FORCESHOWHIDDEN = 268435456 # Show All files including System and hidden files -OFN_EX_NOPLACESBAR = 1 -OFN_SHAREFALLTHROUGH = 2 -OFN_SHARENOWARN = 1 -OFN_SHAREWARN = 0 -CDN_FIRST = (PY_0U-601) -CDN_LAST = (PY_0U-699) -CDN_INITDONE = (CDN_FIRST - 0) -CDN_SELCHANGE = (CDN_FIRST - 1) -CDN_FOLDERCHANGE = (CDN_FIRST - 2) -CDN_SHAREVIOLATION = (CDN_FIRST - 3) -CDN_HELP = (CDN_FIRST - 4) -CDN_FILEOK = (CDN_FIRST - 5) -CDN_TYPECHANGE = (CDN_FIRST - 6) -CDN_INCLUDEITEM = (CDN_FIRST - 7) -CDM_FIRST = (WM_USER + 100) -CDM_LAST = (WM_USER + 200) -CDM_GETSPEC = (CDM_FIRST + 0) -CDM_GETFILEPATH = (CDM_FIRST + 1) -CDM_GETFOLDERPATH = (CDM_FIRST + 2) -CDM_GETFOLDERIDLIST = (CDM_FIRST + 3) -CDM_SETCONTROLTEXT = (CDM_FIRST + 4) -CDM_HIDECONTROL = (CDM_FIRST + 5) -CDM_SETDEFEXT = (CDM_FIRST + 6) -CC_RGBINIT = 1 -CC_FULLOPEN = 2 -CC_PREVENTFULLOPEN = 4 -CC_SHOWHELP = 8 -CC_ENABLEHOOK = 16 -CC_ENABLETEMPLATE = 32 -CC_ENABLETEMPLATEHANDLE = 64 -CC_SOLIDCOLOR = 128 -CC_ANYCOLOR = 256 -FR_DOWN = 1 -FR_WHOLEWORD = 2 -FR_MATCHCASE = 4 -FR_FINDNEXT = 8 -FR_REPLACE = 16 -FR_REPLACEALL = 32 -FR_DIALOGTERM = 64 -FR_SHOWHELP = 128 -FR_ENABLEHOOK = 256 -FR_ENABLETEMPLATE = 512 -FR_NOUPDOWN = 1024 -FR_NOMATCHCASE = 2048 -FR_NOWHOLEWORD = 4096 -FR_ENABLETEMPLATEHANDLE = 8192 -FR_HIDEUPDOWN = 16384 -FR_HIDEMATCHCASE = 32768 -FR_HIDEWHOLEWORD = 65536 -CF_SCREENFONTS = 1 -CF_PRINTERFONTS = 2 -CF_BOTH = (CF_SCREENFONTS | CF_PRINTERFONTS) -CF_SHOWHELP = 4 -CF_ENABLEHOOK = 8 -CF_ENABLETEMPLATE = 16 -CF_ENABLETEMPLATEHANDLE = 32 -CF_INITTOLOGFONTSTRUCT = 64 -CF_USESTYLE = 128 -CF_EFFECTS = 256 -CF_APPLY = 512 -CF_ANSIONLY = 1024 -CF_SCRIPTSONLY = CF_ANSIONLY -CF_NOVECTORFONTS = 2048 -CF_NOOEMFONTS = CF_NOVECTORFONTS -CF_NOSIMULATIONS = 4096 -CF_LIMITSIZE = 8192 -CF_FIXEDPITCHONLY = 16384 -CF_WYSIWYG = 32768 # must also have CF_SCREENFONTS & CF_PRINTERFONTS -CF_FORCEFONTEXIST = 65536 -CF_SCALABLEONLY = 131072 -CF_TTONLY = 262144 -CF_NOFACESEL = 524288 -CF_NOSTYLESEL = 1048576 -CF_NOSIZESEL = 2097152 -CF_SELECTSCRIPT = 4194304 -CF_NOSCRIPTSEL = 8388608 -CF_NOVERTFONTS = 16777216 -SIMULATED_FONTTYPE = 32768 -PRINTER_FONTTYPE = 16384 -SCREEN_FONTTYPE = 8192 -BOLD_FONTTYPE = 256 -ITALIC_FONTTYPE = 512 -REGULAR_FONTTYPE = 1024 -OPENTYPE_FONTTYPE = 65536 -TYPE1_FONTTYPE = 131072 -DSIG_FONTTYPE = 262144 -WM_CHOOSEFONT_GETLOGFONT = (WM_USER + 1) -WM_CHOOSEFONT_SETLOGFONT = (WM_USER + 101) -WM_CHOOSEFONT_SETFLAGS = (WM_USER + 102) -LBSELCHSTRINGA = "commdlg_LBSelChangedNotify" -SHAREVISTRINGA = "commdlg_ShareViolation" -FILEOKSTRINGA = "commdlg_FileNameOK" -COLOROKSTRINGA = "commdlg_ColorOK" -SETRGBSTRINGA = "commdlg_SetRGBColor" -HELPMSGSTRINGA = "commdlg_help" -FINDMSGSTRINGA = "commdlg_FindReplace" -LBSELCHSTRING = LBSELCHSTRINGA -SHAREVISTRING = SHAREVISTRINGA -FILEOKSTRING = FILEOKSTRINGA -COLOROKSTRING = COLOROKSTRINGA -SETRGBSTRING = SETRGBSTRINGA -HELPMSGSTRING = HELPMSGSTRINGA -FINDMSGSTRING = FINDMSGSTRINGA -CD_LBSELNOITEMS = -1 -CD_LBSELCHANGE = 0 -CD_LBSELSUB = 1 -CD_LBSELADD = 2 -PD_ALLPAGES = 0 -PD_SELECTION = 1 -PD_PAGENUMS = 2 -PD_NOSELECTION = 4 -PD_NOPAGENUMS = 8 -PD_COLLATE = 16 -PD_PRINTTOFILE = 32 -PD_PRINTSETUP = 64 -PD_NOWARNING = 128 -PD_RETURNDC = 256 -PD_RETURNIC = 512 -PD_RETURNDEFAULT = 1024 -PD_SHOWHELP = 2048 -PD_ENABLEPRINTHOOK = 4096 -PD_ENABLESETUPHOOK = 8192 -PD_ENABLEPRINTTEMPLATE = 16384 -PD_ENABLESETUPTEMPLATE = 32768 -PD_ENABLEPRINTTEMPLATEHANDLE = 65536 -PD_ENABLESETUPTEMPLATEHANDLE = 131072 -PD_USEDEVMODECOPIES = 262144 -PD_DISABLEPRINTTOFILE = 524288 -PD_HIDEPRINTTOFILE = 1048576 -PD_NONETWORKBUTTON = 2097152 -DN_DEFAULTPRN = 1 -WM_PSD_PAGESETUPDLG = (WM_USER ) -WM_PSD_FULLPAGERECT = (WM_USER+1) -WM_PSD_MINMARGINRECT = (WM_USER+2) -WM_PSD_MARGINRECT = (WM_USER+3) -WM_PSD_GREEKTEXTRECT = (WM_USER+4) -WM_PSD_ENVSTAMPRECT = (WM_USER+5) -WM_PSD_YAFULLPAGERECT = (WM_USER+6) -PSD_DEFAULTMINMARGINS = 0 # default (printer's) -PSD_INWININIINTLMEASURE = 0 # 1st of 4 possible -PSD_MINMARGINS = 1 # use caller's -PSD_MARGINS = 2 # use caller's -PSD_INTHOUSANDTHSOFINCHES = 4 # 2nd of 4 possible -PSD_INHUNDREDTHSOFMILLIMETERS = 8 # 3rd of 4 possible -PSD_DISABLEMARGINS = 16 -PSD_DISABLEPRINTER = 32 -PSD_NOWARNING = 128 # must be same as PD_* -PSD_DISABLEORIENTATION = 256 -PSD_RETURNDEFAULT = 1024 # must be same as PD_* -PSD_DISABLEPAPER = 512 -PSD_SHOWHELP = 2048 # must be same as PD_* -PSD_ENABLEPAGESETUPHOOK = 8192 # must be same as PD_* -PSD_ENABLEPAGESETUPTEMPLATE = 32768 # must be same as PD_* -PSD_ENABLEPAGESETUPTEMPLATEHANDLE = 131072 # must be same as PD_* -PSD_ENABLEPAGEPAINTHOOK = 262144 -PSD_DISABLEPAGEPAINTING = 524288 -PSD_NONETWORKBUTTON = 2097152 # must be same as PD_* - -# Generated by h2py from winreg.h -HKEY_CLASSES_ROOT = -2147483648 -HKEY_CURRENT_USER = -2147483647 -HKEY_LOCAL_MACHINE = -2147483646 -HKEY_USERS = -2147483645 -HKEY_PERFORMANCE_DATA = -2147483644 -HKEY_CURRENT_CONFIG = -2147483643 -HKEY_DYN_DATA = -2147483642 -HKEY_PERFORMANCE_TEXT = -2147483568 # ?? 4Jan98 -HKEY_PERFORMANCE_NLSTEXT = -2147483552 # ?? 4Jan98 - -# Generated by h2py from winuser.h -HWND_BROADCAST = 65535 -HWND_DESKTOP = 0 -HWND_TOP = 0 -HWND_BOTTOM = 1 -HWND_TOPMOST = -1 -HWND_NOTOPMOST = -2 -HWND_MESSAGE = -3 - -# winuser.h line 4601 -SM_CXSCREEN = 0 -SM_CYSCREEN = 1 -SM_CXVSCROLL = 2 -SM_CYHSCROLL = 3 -SM_CYCAPTION = 4 -SM_CXBORDER = 5 -SM_CYBORDER = 6 -SM_CXDLGFRAME = 7 -SM_CYDLGFRAME = 8 -SM_CYVTHUMB = 9 -SM_CXHTHUMB = 10 -SM_CXICON = 11 -SM_CYICON = 12 -SM_CXCURSOR = 13 -SM_CYCURSOR = 14 -SM_CYMENU = 15 -SM_CXFULLSCREEN = 16 -SM_CYFULLSCREEN = 17 -SM_CYKANJIWINDOW = 18 -SM_MOUSEPRESENT = 19 -SM_CYVSCROLL = 20 -SM_CXHSCROLL = 21 -SM_DEBUG = 22 -SM_SWAPBUTTON = 23 -SM_RESERVED1 = 24 -SM_RESERVED2 = 25 -SM_RESERVED3 = 26 -SM_RESERVED4 = 27 -SM_CXMIN = 28 -SM_CYMIN = 29 -SM_CXSIZE = 30 -SM_CYSIZE = 31 -SM_CXFRAME = 32 -SM_CYFRAME = 33 -SM_CXMINTRACK = 34 -SM_CYMINTRACK = 35 -SM_CXDOUBLECLK = 36 -SM_CYDOUBLECLK = 37 -SM_CXICONSPACING = 38 -SM_CYICONSPACING = 39 -SM_MENUDROPALIGNMENT = 40 -SM_PENWINDOWS = 41 -SM_DBCSENABLED = 42 -SM_CMOUSEBUTTONS = 43 -SM_CXFIXEDFRAME = SM_CXDLGFRAME -SM_CYFIXEDFRAME = SM_CYDLGFRAME -SM_CXSIZEFRAME = SM_CXFRAME -SM_CYSIZEFRAME = SM_CYFRAME -SM_SECURE = 44 -SM_CXEDGE = 45 -SM_CYEDGE = 46 -SM_CXMINSPACING = 47 -SM_CYMINSPACING = 48 -SM_CXSMICON = 49 -SM_CYSMICON = 50 -SM_CYSMCAPTION = 51 -SM_CXSMSIZE = 52 -SM_CYSMSIZE = 53 -SM_CXMENUSIZE = 54 -SM_CYMENUSIZE = 55 -SM_ARRANGE = 56 -SM_CXMINIMIZED = 57 -SM_CYMINIMIZED = 58 -SM_CXMAXTRACK = 59 -SM_CYMAXTRACK = 60 -SM_CXMAXIMIZED = 61 -SM_CYMAXIMIZED = 62 -SM_NETWORK = 63 -SM_CLEANBOOT = 67 -SM_CXDRAG = 68 -SM_CYDRAG = 69 -SM_SHOWSOUNDS = 70 -SM_CXMENUCHECK = 71 -SM_CYMENUCHECK = 72 -SM_SLOWMACHINE = 73 -SM_MIDEASTENABLED = 74 -SM_MOUSEWHEELPRESENT = 75 -SM_XVIRTUALSCREEN = 76 -SM_YVIRTUALSCREEN = 77 -SM_CXVIRTUALSCREEN = 78 -SM_CYVIRTUALSCREEN = 79 -SM_CMONITORS = 80 -SM_SAMEDISPLAYFORMAT = 81 -SM_CMETRICS = 83 -MNC_IGNORE = 0 -MNC_CLOSE = 1 -MNC_EXECUTE = 2 -MNC_SELECT = 3 -MNS_NOCHECK = -2147483648 -MNS_MODELESS = 1073741824 -MNS_DRAGDROP = 536870912 -MNS_AUTODISMISS = 268435456 -MNS_NOTIFYBYPOS = 134217728 -MNS_CHECKORBMP = 67108864 -MIM_MAXHEIGHT = 1 -MIM_BACKGROUND = 2 -MIM_HELPID = 4 -MIM_MENUDATA = 8 -MIM_STYLE = 16 -MIM_APPLYTOSUBMENUS = -2147483648 -MND_CONTINUE = 0 -MND_ENDMENU = 1 -MNGOF_GAP = 3 -MNGO_NOINTERFACE = 0 -MNGO_NOERROR = 1 -MIIM_STATE = 1 -MIIM_ID = 2 -MIIM_SUBMENU = 4 -MIIM_CHECKMARKS = 8 -MIIM_TYPE = 16 -MIIM_DATA = 32 -MIIM_STRING = 64 -MIIM_BITMAP = 128 -MIIM_FTYPE = 256 -HBMMENU_CALLBACK = -1 -HBMMENU_SYSTEM = 1 -HBMMENU_MBAR_RESTORE = 2 -HBMMENU_MBAR_MINIMIZE = 3 -HBMMENU_MBAR_CLOSE = 5 -HBMMENU_MBAR_CLOSE_D = 6 -HBMMENU_MBAR_MINIMIZE_D = 7 -HBMMENU_POPUP_CLOSE = 8 -HBMMENU_POPUP_RESTORE = 9 -HBMMENU_POPUP_MAXIMIZE = 10 -HBMMENU_POPUP_MINIMIZE = 11 -GMDI_USEDISABLED = 1 -GMDI_GOINTOPOPUPS = 2 -TPM_LEFTBUTTON = 0 -TPM_RIGHTBUTTON = 2 -TPM_LEFTALIGN = 0 -TPM_CENTERALIGN = 4 -TPM_RIGHTALIGN = 8 -TPM_TOPALIGN = 0 -TPM_VCENTERALIGN = 16 -TPM_BOTTOMALIGN = 32 -TPM_HORIZONTAL = 0 -TPM_VERTICAL = 64 -TPM_NONOTIFY = 128 -TPM_RETURNCMD = 256 -TPM_RECURSE = 1 -DOF_EXECUTABLE = 32769 -DOF_DOCUMENT = 32770 -DOF_DIRECTORY = 32771 -DOF_MULTIPLE = 32772 -DOF_PROGMAN = 1 -DOF_SHELLDATA = 2 -DO_DROPFILE = 1162627398 -DO_PRINTFILE = 1414419024 -DT_TOP = 0 -DT_LEFT = 0 -DT_CENTER = 1 -DT_RIGHT = 2 -DT_VCENTER = 4 -DT_BOTTOM = 8 -DT_WORDBREAK = 16 -DT_SINGLELINE = 32 -DT_EXPANDTABS = 64 -DT_TABSTOP = 128 -DT_NOCLIP = 256 -DT_EXTERNALLEADING = 512 -DT_CALCRECT = 1024 -DT_NOPREFIX = 2048 -DT_INTERNAL = 4096 -DT_EDITCONTROL = 8192 -DT_PATH_ELLIPSIS = 16384 -DT_END_ELLIPSIS = 32768 -DT_MODIFYSTRING = 65536 -DT_RTLREADING = 131072 -DT_WORD_ELLIPSIS = 262144 -DST_COMPLEX = 0 -DST_TEXT = 1 -DST_PREFIXTEXT = 2 -DST_ICON = 3 -DST_BITMAP = 4 -DSS_NORMAL = 0 -DSS_UNION = 16 -DSS_DISABLED = 32 -DSS_MONO = 128 -DSS_RIGHT = 32768 -DCX_WINDOW = 1 -DCX_CACHE = 2 -DCX_NORESETATTRS = 4 -DCX_CLIPCHILDREN = 8 -DCX_CLIPSIBLINGS = 16 -DCX_PARENTCLIP = 32 -DCX_EXCLUDERGN = 64 -DCX_INTERSECTRGN = 128 -DCX_EXCLUDEUPDATE = 256 -DCX_INTERSECTUPDATE = 512 -DCX_LOCKWINDOWUPDATE = 1024 -DCX_VALIDATE = 2097152 -CUDR_NORMAL = 0 -CUDR_NOSNAPTOGRID = 1 -CUDR_NORESOLVEPOSITIONS = 2 -CUDR_NOCLOSEGAPS = 4 -CUDR_NEGATIVECOORDS = 8 -CUDR_NOPRIMARY = 16 -RDW_INVALIDATE = 1 -RDW_INTERNALPAINT = 2 -RDW_ERASE = 4 -RDW_VALIDATE = 8 -RDW_NOINTERNALPAINT = 16 -RDW_NOERASE = 32 -RDW_NOCHILDREN = 64 -RDW_ALLCHILDREN = 128 -RDW_UPDATENOW = 256 -RDW_ERASENOW = 512 -RDW_FRAME = 1024 -RDW_NOFRAME = 2048 -SW_SCROLLCHILDREN = 1 -SW_INVALIDATE = 2 -SW_ERASE = 4 -SW_SMOOTHSCROLL = 16 # Use smooth scrolling -ESB_ENABLE_BOTH = 0 -ESB_DISABLE_BOTH = 3 -ESB_DISABLE_LEFT = 1 -ESB_DISABLE_RIGHT = 2 -ESB_DISABLE_UP = 1 -ESB_DISABLE_DOWN = 2 -ESB_DISABLE_LTUP = ESB_DISABLE_LEFT -ESB_DISABLE_RTDN = ESB_DISABLE_RIGHT -HELPINFO_WINDOW = 1 -HELPINFO_MENUITEM = 2 -MB_OK = 0 -MB_OKCANCEL = 1 -MB_ABORTRETRYIGNORE = 2 -MB_YESNOCANCEL = 3 -MB_YESNO = 4 -MB_RETRYCANCEL = 5 -MB_ICONHAND = 16 -MB_ICONQUESTION = 32 -MB_ICONEXCLAMATION = 48 -MB_ICONASTERISK = 64 -MB_ICONWARNING = MB_ICONEXCLAMATION -MB_ICONERROR = MB_ICONHAND -MB_ICONINFORMATION = MB_ICONASTERISK -MB_ICONSTOP = MB_ICONHAND -MB_DEFBUTTON1 = 0 -MB_DEFBUTTON2 = 256 -MB_DEFBUTTON3 = 512 -MB_DEFBUTTON4 = 768 -MB_APPLMODAL = 0 -MB_SYSTEMMODAL = 4096 -MB_TASKMODAL = 8192 -MB_HELP = 16384 -MB_NOFOCUS = 32768 -MB_SETFOREGROUND = 65536 -MB_DEFAULT_DESKTOP_ONLY = 131072 -MB_TOPMOST = 262144 -MB_RIGHT = 524288 -MB_RTLREADING = 1048576 -MB_SERVICE_NOTIFICATION = 2097152 -MB_TYPEMASK = 15 -MB_USERICON = 128 -MB_ICONMASK = 240 -MB_DEFMASK = 3840 -MB_MODEMASK = 12288 -MB_MISCMASK = 49152 -# winuser.h line 6373 -CWP_ALL = 0 -CWP_SKIPINVISIBLE = 1 -CWP_SKIPDISABLED = 2 -CWP_SKIPTRANSPARENT = 4 -CTLCOLOR_MSGBOX = 0 -CTLCOLOR_EDIT = 1 -CTLCOLOR_LISTBOX = 2 -CTLCOLOR_BTN = 3 -CTLCOLOR_DLG = 4 -CTLCOLOR_SCROLLBAR = 5 -CTLCOLOR_STATIC = 6 -CTLCOLOR_MAX = 7 -COLOR_SCROLLBAR = 0 -COLOR_BACKGROUND = 1 -COLOR_ACTIVECAPTION = 2 -COLOR_INACTIVECAPTION = 3 -COLOR_MENU = 4 -COLOR_WINDOW = 5 -COLOR_WINDOWFRAME = 6 -COLOR_MENUTEXT = 7 -COLOR_WINDOWTEXT = 8 -COLOR_CAPTIONTEXT = 9 -COLOR_ACTIVEBORDER = 10 -COLOR_INACTIVEBORDER = 11 -COLOR_APPWORKSPACE = 12 -COLOR_HIGHLIGHT = 13 -COLOR_HIGHLIGHTTEXT = 14 -COLOR_BTNFACE = 15 -COLOR_BTNSHADOW = 16 -COLOR_GRAYTEXT = 17 -COLOR_BTNTEXT = 18 -COLOR_INACTIVECAPTIONTEXT = 19 -COLOR_BTNHIGHLIGHT = 20 -COLOR_3DDKSHADOW = 21 -COLOR_3DLIGHT = 22 -COLOR_INFOTEXT = 23 -COLOR_INFOBK = 24 -COLOR_HOTLIGHT = 26 -COLOR_GRADIENTACTIVECAPTION = 27 -COLOR_GRADIENTINACTIVECAPTION = 28 -COLOR_DESKTOP = COLOR_BACKGROUND -COLOR_3DFACE = COLOR_BTNFACE -COLOR_3DSHADOW = COLOR_BTNSHADOW -COLOR_3DHIGHLIGHT = COLOR_BTNHIGHLIGHT -COLOR_3DHILIGHT = COLOR_BTNHIGHLIGHT -COLOR_BTNHILIGHT = COLOR_BTNHIGHLIGHT -GW_HWNDFIRST = 0 -GW_HWNDLAST = 1 -GW_HWNDNEXT = 2 -GW_HWNDPREV = 3 -GW_OWNER = 4 -GW_CHILD = 5 -GW_ENABLEDPOPUP = 6 -GW_MAX = 6 -MF_INSERT = 0 -MF_CHANGE = 128 -MF_APPEND = 256 -MF_DELETE = 512 -MF_REMOVE = 4096 -MF_BYCOMMAND = 0 -MF_BYPOSITION = 1024 -MF_SEPARATOR = 2048 -MF_ENABLED = 0 -MF_GRAYED = 1 -MF_DISABLED = 2 -MF_UNCHECKED = 0 -MF_CHECKED = 8 -MF_USECHECKBITMAPS = 512 -MF_STRING = 0 -MF_BITMAP = 4 -MF_OWNERDRAW = 256 -MF_POPUP = 16 -MF_MENUBARBREAK = 32 -MF_MENUBREAK = 64 -MF_UNHILITE = 0 -MF_HILITE = 128 -MF_DEFAULT = 4096 -MF_SYSMENU = 8192 -MF_HELP = 16384 -MF_RIGHTJUSTIFY = 16384 -MF_MOUSESELECT = 32768 -MF_END = 128 -MFT_STRING = MF_STRING -MFT_BITMAP = MF_BITMAP -MFT_MENUBARBREAK = MF_MENUBARBREAK -MFT_MENUBREAK = MF_MENUBREAK -MFT_OWNERDRAW = MF_OWNERDRAW -MFT_RADIOCHECK = 512 -MFT_SEPARATOR = MF_SEPARATOR -MFT_RIGHTORDER = 8192 -MFT_RIGHTJUSTIFY = MF_RIGHTJUSTIFY -MFS_GRAYED = 3 -MFS_DISABLED = MFS_GRAYED -MFS_CHECKED = MF_CHECKED -MFS_HILITE = MF_HILITE -MFS_ENABLED = MF_ENABLED -MFS_UNCHECKED = MF_UNCHECKED -MFS_UNHILITE = MF_UNHILITE -MFS_DEFAULT = MF_DEFAULT -MFS_MASK = 4235 -MFS_HOTTRACKDRAWN = 268435456 -MFS_CACHEDBMP = 536870912 -MFS_BOTTOMGAPDROP = 1073741824 -MFS_TOPGAPDROP = -2147483648 -MFS_GAPDROP = -1073741824 -SC_SIZE = 61440 -SC_MOVE = 61456 -SC_MINIMIZE = 61472 -SC_MAXIMIZE = 61488 -SC_NEXTWINDOW = 61504 -SC_PREVWINDOW = 61520 -SC_CLOSE = 61536 -SC_VSCROLL = 61552 -SC_HSCROLL = 61568 -SC_MOUSEMENU = 61584 -SC_KEYMENU = 61696 -SC_ARRANGE = 61712 -SC_RESTORE = 61728 -SC_TASKLIST = 61744 -SC_SCREENSAVE = 61760 -SC_HOTKEY = 61776 -SC_DEFAULT = 61792 -SC_MONITORPOWER = 61808 -SC_CONTEXTHELP = 61824 -SC_SEPARATOR = 61455 -SC_ICON = SC_MINIMIZE -SC_ZOOM = SC_MAXIMIZE -IDC_ARROW = 32512 -IDC_IBEAM = 32513 -IDC_WAIT = 32514 -IDC_CROSS = 32515 -IDC_UPARROW = 32516 -IDC_SIZE = 32640 # OBSOLETE: use IDC_SIZEALL -IDC_ICON = 32641 # OBSOLETE: use IDC_ARROW -IDC_SIZENWSE = 32642 -IDC_SIZENESW = 32643 -IDC_SIZEWE = 32644 -IDC_SIZENS = 32645 -IDC_SIZEALL = 32646 -IDC_NO = 32648 -IDC_HAND = 32649 -IDC_APPSTARTING = 32650 -IDC_HELP = 32651 -IMAGE_BITMAP = 0 -IMAGE_ICON = 1 -IMAGE_CURSOR = 2 -IMAGE_ENHMETAFILE = 3 -LR_DEFAULTCOLOR = 0 -LR_MONOCHROME = 1 -LR_COLOR = 2 -LR_COPYRETURNORG = 4 -LR_COPYDELETEORG = 8 -LR_LOADFROMFILE = 16 -LR_LOADTRANSPARENT = 32 -LR_DEFAULTSIZE = 64 -LR_LOADREALSIZE = 128 -LR_LOADMAP3DCOLORS = 4096 -LR_CREATEDIBSECTION = 8192 -LR_COPYFROMRESOURCE = 16384 -LR_SHARED = 32768 -DI_MASK = 1 -DI_IMAGE = 2 -DI_NORMAL = 3 -DI_COMPAT = 4 -DI_DEFAULTSIZE = 8 -RES_ICON = 1 -RES_CURSOR = 2 -OBM_CLOSE = 32754 -OBM_UPARROW = 32753 -OBM_DNARROW = 32752 -OBM_RGARROW = 32751 -OBM_LFARROW = 32750 -OBM_REDUCE = 32749 -OBM_ZOOM = 32748 -OBM_RESTORE = 32747 -OBM_REDUCED = 32746 -OBM_ZOOMD = 32745 -OBM_RESTORED = 32744 -OBM_UPARROWD = 32743 -OBM_DNARROWD = 32742 -OBM_RGARROWD = 32741 -OBM_LFARROWD = 32740 -OBM_MNARROW = 32739 -OBM_COMBO = 32738 -OBM_UPARROWI = 32737 -OBM_DNARROWI = 32736 -OBM_RGARROWI = 32735 -OBM_LFARROWI = 32734 -OBM_OLD_CLOSE = 32767 -OBM_SIZE = 32766 -OBM_OLD_UPARROW = 32765 -OBM_OLD_DNARROW = 32764 -OBM_OLD_RGARROW = 32763 -OBM_OLD_LFARROW = 32762 -OBM_BTSIZE = 32761 -OBM_CHECK = 32760 -OBM_CHECKBOXES = 32759 -OBM_BTNCORNERS = 32758 -OBM_OLD_REDUCE = 32757 -OBM_OLD_ZOOM = 32756 -OBM_OLD_RESTORE = 32755 -OCR_NORMAL = 32512 -OCR_IBEAM = 32513 -OCR_WAIT = 32514 -OCR_CROSS = 32515 -OCR_UP = 32516 -OCR_SIZE = 32640 -OCR_ICON = 32641 -OCR_SIZENWSE = 32642 -OCR_SIZENESW = 32643 -OCR_SIZEWE = 32644 -OCR_SIZENS = 32645 -OCR_SIZEALL = 32646 -OCR_ICOCUR = 32647 -OCR_NO = 32648 -OCR_HAND = 32649 -OCR_APPSTARTING = 32650 -# winuser.h line 7455 -OIC_SAMPLE = 32512 -OIC_HAND = 32513 -OIC_QUES = 32514 -OIC_BANG = 32515 -OIC_NOTE = 32516 -OIC_WINLOGO = 32517 -OIC_WARNING = OIC_BANG -OIC_ERROR = OIC_HAND -OIC_INFORMATION = OIC_NOTE -ORD_LANGDRIVER = 1 -IDI_APPLICATION = 32512 -IDI_HAND = 32513 -IDI_QUESTION = 32514 -IDI_EXCLAMATION = 32515 -IDI_ASTERISK = 32516 -IDI_WINLOGO = 32517 -IDI_WARNING = IDI_EXCLAMATION -IDI_ERROR = IDI_HAND -IDI_INFORMATION = IDI_ASTERISK -IDOK = 1 -IDCANCEL = 2 -IDABORT = 3 -IDRETRY = 4 -IDIGNORE = 5 -IDYES = 6 -IDNO = 7 -IDCLOSE = 8 -IDHELP = 9 -ES_LEFT = 0 -ES_CENTER = 1 -ES_RIGHT = 2 -ES_MULTILINE = 4 -ES_UPPERCASE = 8 -ES_LOWERCASE = 16 -ES_PASSWORD = 32 -ES_AUTOVSCROLL = 64 -ES_AUTOHSCROLL = 128 -ES_NOHIDESEL = 256 -ES_OEMCONVERT = 1024 -ES_READONLY = 2048 -ES_WANTRETURN = 4096 -ES_NUMBER = 8192 -EN_SETFOCUS = 256 -EN_KILLFOCUS = 512 -EN_CHANGE = 768 -EN_UPDATE = 1024 -EN_ERRSPACE = 1280 -EN_MAXTEXT = 1281 -EN_HSCROLL = 1537 -EN_VSCROLL = 1538 -EC_LEFTMARGIN = 1 -EC_RIGHTMARGIN = 2 -EC_USEFONTINFO = 65535 -EMSIS_COMPOSITIONSTRING = 1 -EIMES_GETCOMPSTRATONCE = 1 -EIMES_CANCELCOMPSTRINFOCUS = 2 -EIMES_COMPLETECOMPSTRKILLFOCUS = 4 -EM_GETSEL = 176 -EM_SETSEL = 177 -EM_GETRECT = 178 -EM_SETRECT = 179 -EM_SETRECTNP = 180 -EM_SCROLL = 181 -EM_LINESCROLL = 182 -EM_SCROLLCARET = 183 -EM_GETMODIFY = 184 -EM_SETMODIFY = 185 -EM_GETLINECOUNT = 186 -EM_LINEINDEX = 187 -EM_SETHANDLE = 188 -EM_GETHANDLE = 189 -EM_GETTHUMB = 190 -EM_LINELENGTH = 193 -EM_REPLACESEL = 194 -EM_GETLINE = 196 -EM_LIMITTEXT = 197 -EM_CANUNDO = 198 -EM_UNDO = 199 -EM_FMTLINES = 200 -EM_LINEFROMCHAR = 201 -EM_SETTABSTOPS = 203 -EM_SETPASSWORDCHAR = 204 -EM_EMPTYUNDOBUFFER = 205 -EM_GETFIRSTVISIBLELINE = 206 -EM_SETREADONLY = 207 -EM_SETWORDBREAKPROC = 208 -EM_GETWORDBREAKPROC = 209 -EM_GETPASSWORDCHAR = 210 -EM_SETMARGINS = 211 -EM_GETMARGINS = 212 -EM_SETLIMITTEXT = EM_LIMITTEXT -EM_GETLIMITTEXT = 213 -EM_POSFROMCHAR = 214 -EM_CHARFROMPOS = 215 -EM_SETIMESTATUS = 216 -EM_GETIMESTATUS = 217 -WB_LEFT = 0 -WB_RIGHT = 1 -WB_ISDELIMITER = 2 -BS_PUSHBUTTON = 0 -BS_DEFPUSHBUTTON = 1 -BS_CHECKBOX = 2 -BS_AUTOCHECKBOX = 3 -BS_RADIOBUTTON = 4 -BS_3STATE = 5 -BS_AUTO3STATE = 6 -BS_GROUPBOX = 7 -BS_USERBUTTON = 8 -BS_AUTORADIOBUTTON = 9 -BS_OWNERDRAW = 11 -BS_LEFTTEXT = 32 -BS_TEXT = 0 -BS_ICON = 64 -BS_BITMAP = 128 -BS_LEFT = 256 -BS_RIGHT = 512 -BS_CENTER = 768 -BS_TOP = 1024 -BS_BOTTOM = 2048 -BS_VCENTER = 3072 -BS_PUSHLIKE = 4096 -BS_MULTILINE = 8192 -BS_NOTIFY = 16384 -BS_FLAT = 32768 -BS_RIGHTBUTTON = BS_LEFTTEXT -BN_CLICKED = 0 -BN_PAINT = 1 -BN_HILITE = 2 -BN_UNHILITE = 3 -BN_DISABLE = 4 -BN_DOUBLECLICKED = 5 -BN_PUSHED = BN_HILITE -BN_UNPUSHED = BN_UNHILITE -BN_DBLCLK = BN_DOUBLECLICKED -BN_SETFOCUS = 6 -BN_KILLFOCUS = 7 -BM_GETCHECK = 240 -BM_SETCHECK = 241 -BM_GETSTATE = 242 -BM_SETSTATE = 243 -BM_SETSTYLE = 244 -BM_CLICK = 245 -BM_GETIMAGE = 246 -BM_SETIMAGE = 247 -BST_UNCHECKED = 0 -BST_CHECKED = 1 -BST_INDETERMINATE = 2 -BST_PUSHED = 4 -BST_FOCUS = 8 -SS_LEFT = 0 -SS_CENTER = 1 -SS_RIGHT = 2 -SS_ICON = 3 -SS_BLACKRECT = 4 -SS_GRAYRECT = 5 -SS_WHITERECT = 6 -SS_BLACKFRAME = 7 -SS_GRAYFRAME = 8 -SS_WHITEFRAME = 9 -SS_USERITEM = 10 -SS_SIMPLE = 11 -SS_LEFTNOWORDWRAP = 12 -SS_BITMAP = 14 -SS_OWNERDRAW = 13 -SS_ENHMETAFILE = 15 -SS_ETCHEDHORZ = 16 -SS_ETCHEDVERT = 17 -SS_ETCHEDFRAME = 18 -SS_TYPEMASK = 31 -SS_NOPREFIX = 128 -SS_NOTIFY = 256 -SS_CENTERIMAGE = 512 -SS_RIGHTJUST = 1024 -SS_REALSIZEIMAGE = 2048 -SS_SUNKEN = 4096 -SS_ENDELLIPSIS = 16384 -SS_PATHELLIPSIS = 32768 -SS_WORDELLIPSIS = 49152 -SS_ELLIPSISMASK = 49152 -STM_SETICON = 368 -STM_GETICON = 369 -STM_SETIMAGE = 370 -STM_GETIMAGE = 371 -STN_CLICKED = 0 -STN_DBLCLK = 1 -STN_ENABLE = 2 -STN_DISABLE = 3 -STM_MSGMAX = 372 -DWL_MSGRESULT = 0 -DWL_DLGPROC = 4 -DWL_USER = 8 -DDL_READWRITE = 0 -DDL_READONLY = 1 -DDL_HIDDEN = 2 -DDL_SYSTEM = 4 -DDL_DIRECTORY = 16 -DDL_ARCHIVE = 32 -DDL_POSTMSGS = 8192 -DDL_DRIVES = 16384 -DDL_EXCLUSIVE = 32768 - -#from winuser.h line 153 -RT_CURSOR = 1 -RT_BITMAP = 2 -RT_ICON = 3 -RT_MENU = 4 -RT_DIALOG = 5 -RT_STRING = 6 -RT_FONTDIR = 7 -RT_FONT = 8 -RT_ACCELERATOR = 9 -RT_RCDATA = 10 -RT_MESSAGETABLE = 11 -DIFFERENCE = 11 -RT_GROUP_CURSOR = (RT_CURSOR + DIFFERENCE) -RT_GROUP_ICON = (RT_ICON + DIFFERENCE) -RT_VERSION = 16 -RT_DLGINCLUDE = 17 -RT_PLUGPLAY = 19 -RT_VXD = 20 -RT_ANICURSOR = 21 -RT_ANIICON = 22 -RT_HTML = 23 -# from winuser.h line 218 -SB_HORZ = 0 -SB_VERT = 1 -SB_CTL = 2 -SB_BOTH = 3 -SB_LINEUP = 0 -SB_LINELEFT = 0 -SB_LINEDOWN = 1 -SB_LINERIGHT = 1 -SB_PAGEUP = 2 -SB_PAGELEFT = 2 -SB_PAGEDOWN = 3 -SB_PAGERIGHT = 3 -SB_THUMBPOSITION = 4 -SB_THUMBTRACK = 5 -SB_TOP = 6 -SB_LEFT = 6 -SB_BOTTOM = 7 -SB_RIGHT = 7 -SB_ENDSCROLL = 8 -SW_HIDE = 0 -SW_SHOWNORMAL = 1 -SW_NORMAL = 1 -SW_SHOWMINIMIZED = 2 -SW_SHOWMAXIMIZED = 3 -SW_MAXIMIZE = 3 -SW_SHOWNOACTIVATE = 4 -SW_SHOW = 5 -SW_MINIMIZE = 6 -SW_SHOWMINNOACTIVE = 7 -SW_SHOWNA = 8 -SW_RESTORE = 9 -SW_SHOWDEFAULT = 10 -SW_FORCEMINIMIZE = 11 -SW_MAX = 11 -HIDE_WINDOW = 0 -SHOW_OPENWINDOW = 1 -SHOW_ICONWINDOW = 2 -SHOW_FULLSCREEN = 3 -SHOW_OPENNOACTIVATE = 4 -SW_PARENTCLOSING = 1 -SW_OTHERZOOM = 2 -SW_PARENTOPENING = 3 -SW_OTHERUNZOOM = 4 -AW_HOR_POSITIVE = 1 -AW_HOR_NEGATIVE = 2 -AW_VER_POSITIVE = 4 -AW_VER_NEGATIVE = 8 -AW_CENTER = 16 -AW_HIDE = 65536 -AW_ACTIVATE = 131072 -AW_SLIDE = 262144 -AW_BLEND = 524288 -KF_EXTENDED = 256 -KF_DLGMODE = 2048 -KF_MENUMODE = 4096 -KF_ALTDOWN = 8192 -KF_REPEAT = 16384 -KF_UP = 32768 -VK_LBUTTON = 1 -VK_RBUTTON = 2 -VK_CANCEL = 3 -VK_MBUTTON = 4 -VK_BACK = 8 -VK_TAB = 9 -VK_CLEAR = 12 -VK_RETURN = 13 -VK_SHIFT = 16 -VK_CONTROL = 17 -VK_MENU = 18 -VK_PAUSE = 19 -VK_CAPITAL = 20 -VK_KANA = 21 -VK_HANGEUL = 21 # old name - should be here for compatibility -VK_HANGUL = 21 -VK_JUNJA = 23 -VK_FINAL = 24 -VK_HANJA = 25 -VK_KANJI = 25 -VK_ESCAPE = 27 -VK_CONVERT = 28 -VK_NONCONVERT = 29 -VK_ACCEPT = 30 -VK_MODECHANGE = 31 -VK_SPACE = 32 -VK_PRIOR = 33 -VK_NEXT = 34 -VK_END = 35 -VK_HOME = 36 -VK_LEFT = 37 -VK_UP = 38 -VK_RIGHT = 39 -VK_DOWN = 40 -VK_SELECT = 41 -VK_PRINT = 42 -VK_EXECUTE = 43 -VK_SNAPSHOT = 44 -VK_INSERT = 45 -VK_DELETE = 46 -VK_HELP = 47 -VK_LWIN = 91 -VK_RWIN = 92 -VK_APPS = 93 -VK_NUMPAD0 = 96 -VK_NUMPAD1 = 97 -VK_NUMPAD2 = 98 -VK_NUMPAD3 = 99 -VK_NUMPAD4 = 100 -VK_NUMPAD5 = 101 -VK_NUMPAD6 = 102 -VK_NUMPAD7 = 103 -VK_NUMPAD8 = 104 -VK_NUMPAD9 = 105 -VK_MULTIPLY = 106 -VK_ADD = 107 -VK_SEPARATOR = 108 -VK_SUBTRACT = 109 -VK_DECIMAL = 110 -VK_DIVIDE = 111 -VK_F1 = 112 -VK_F2 = 113 -VK_F3 = 114 -VK_F4 = 115 -VK_F5 = 116 -VK_F6 = 117 -VK_F7 = 118 -VK_F8 = 119 -VK_F9 = 120 -VK_F10 = 121 -VK_F11 = 122 -VK_F12 = 123 -VK_F13 = 124 -VK_F14 = 125 -VK_F15 = 126 -VK_F16 = 127 -VK_F17 = 128 -VK_F18 = 129 -VK_F19 = 130 -VK_F20 = 131 -VK_F21 = 132 -VK_F22 = 133 -VK_F23 = 134 -VK_F24 = 135 -VK_NUMLOCK = 144 -VK_SCROLL = 145 -VK_LSHIFT = 160 -VK_RSHIFT = 161 -VK_LCONTROL = 162 -VK_RCONTROL = 163 -VK_LMENU = 164 -VK_RMENU = 165 -VK_PROCESSKEY = 229 -VK_ATTN = 246 -VK_CRSEL = 247 -VK_EXSEL = 248 -VK_EREOF = 249 -VK_PLAY = 250 -VK_ZOOM = 251 -VK_NONAME = 252 -VK_PA1 = 253 -VK_OEM_CLEAR = 254 -# multi-media related "keys" -MOUSEEVENTF_XDOWN = 0x0080 -MOUSEEVENTF_XUP = 0x0100 -MOUSEEVENTF_WHEEL = 0x0800 -VK_XBUTTON1 = 0x05 -VK_XBUTTON2 = 0x06 -VK_VOLUME_MUTE = 0xAD -VK_VOLUME_DOWN = 0xAE -VK_VOLUME_UP = 0xAF -VK_MEDIA_NEXT_TRACK = 0xB0 -VK_MEDIA_PREV_TRACK = 0xB1 -VK_MEDIA_PLAY_PAUSE = 0xB3 -VK_BROWSER_BACK = 0xA6 -VK_BROWSER_FORWARD = 0xA7 -WH_MIN = (-1) -WH_MSGFILTER = (-1) -WH_JOURNALRECORD = 0 -WH_JOURNALPLAYBACK = 1 -WH_KEYBOARD = 2 -WH_GETMESSAGE = 3 -WH_CALLWNDPROC = 4 -WH_CBT = 5 -WH_SYSMSGFILTER = 6 -WH_MOUSE = 7 -WH_HARDWARE = 8 -WH_DEBUG = 9 -WH_SHELL = 10 -WH_FOREGROUNDIDLE = 11 -WH_CALLWNDPROCRET = 12 -WH_KEYBOARD_LL = 13 -WH_MOUSE_LL = 14 -WH_MAX = 14 -WH_MINHOOK = WH_MIN -WH_MAXHOOK = WH_MAX -HC_ACTION = 0 -HC_GETNEXT = 1 -HC_SKIP = 2 -HC_NOREMOVE = 3 -HC_NOREM = HC_NOREMOVE -HC_SYSMODALON = 4 -HC_SYSMODALOFF = 5 -HCBT_MOVESIZE = 0 -HCBT_MINMAX = 1 -HCBT_QS = 2 -HCBT_CREATEWND = 3 -HCBT_DESTROYWND = 4 -HCBT_ACTIVATE = 5 -HCBT_CLICKSKIPPED = 6 -HCBT_KEYSKIPPED = 7 -HCBT_SYSCOMMAND = 8 -HCBT_SETFOCUS = 9 -MSGF_DIALOGBOX = 0 -MSGF_MESSAGEBOX = 1 -MSGF_MENU = 2 -#MSGF_MOVE = 3 -#MSGF_SIZE = 4 -MSGF_SCROLLBAR = 5 -MSGF_NEXTWINDOW = 6 -#MSGF_MAINLOOP = 8 -MSGF_MAX = 8 -MSGF_USER = 4096 -HSHELL_WINDOWCREATED = 1 -HSHELL_WINDOWDESTROYED = 2 -HSHELL_ACTIVATESHELLWINDOW = 3 -HSHELL_WINDOWACTIVATED = 4 -HSHELL_GETMINRECT = 5 -HSHELL_REDRAW = 6 -HSHELL_TASKMAN = 7 -HSHELL_LANGUAGE = 8 -HSHELL_ACCESSIBILITYSTATE = 11 -ACCESS_STICKYKEYS = 1 -ACCESS_FILTERKEYS = 2 -ACCESS_MOUSEKEYS = 3 -# winuser.h line 624 -LLKHF_EXTENDED = 1 -LLKHF_INJECTED = 16 -LLKHF_ALTDOWN = 32 -LLKHF_UP = 128 -LLKHF_LOWER_IL_INJECTED = 2 -LLMHF_INJECTED = 1 -LLMHF_LOWER_IL_INJECTED = 2 -# line 692 -HKL_PREV = 0 -HKL_NEXT = 1 -KLF_ACTIVATE = 1 -KLF_SUBSTITUTE_OK = 2 -KLF_UNLOADPREVIOUS = 4 -KLF_REORDER = 8 -KLF_REPLACELANG = 16 -KLF_NOTELLSHELL = 128 -KLF_SETFORPROCESS = 256 -KL_NAMELENGTH = 9 -DESKTOP_READOBJECTS = 1 -DESKTOP_CREATEWINDOW = 2 -DESKTOP_CREATEMENU = 4 -DESKTOP_HOOKCONTROL = 8 -DESKTOP_JOURNALRECORD = 16 -DESKTOP_JOURNALPLAYBACK = 32 -DESKTOP_ENUMERATE = 64 -DESKTOP_WRITEOBJECTS = 128 -DESKTOP_SWITCHDESKTOP = 256 -DF_ALLOWOTHERACCOUNTHOOK = 1 -WINSTA_ENUMDESKTOPS = 1 -WINSTA_READATTRIBUTES = 2 -WINSTA_ACCESSCLIPBOARD = 4 -WINSTA_CREATEDESKTOP = 8 -WINSTA_WRITEATTRIBUTES = 16 -WINSTA_ACCESSGLOBALATOMS = 32 -WINSTA_EXITWINDOWS = 64 -WINSTA_ENUMERATE = 256 -WINSTA_READSCREEN = 512 -WSF_VISIBLE = 1 -UOI_FLAGS = 1 -UOI_NAME = 2 -UOI_TYPE = 3 -UOI_USER_SID = 4 -GWL_WNDPROC = (-4) -GWL_HINSTANCE = (-6) -GWL_HWNDPARENT = (-8) -GWL_STYLE = (-16) -GWL_EXSTYLE = (-20) -GWL_USERDATA = (-21) -GWL_ID = (-12) -GCL_MENUNAME = (-8) -GCL_HBRBACKGROUND = (-10) -GCL_HCURSOR = (-12) -GCL_HICON = (-14) -GCL_HMODULE = (-16) -GCL_CBWNDEXTRA = (-18) -GCL_CBCLSEXTRA = (-20) -GCL_WNDPROC = (-24) -GCL_STYLE = (-26) -GCW_ATOM = (-32) -GCL_HICONSM = (-34) -# line 1291 -WM_NULL = 0 -WM_CREATE = 1 -WM_DESTROY = 2 -WM_MOVE = 3 -WM_SIZE = 5 -WM_ACTIVATE = 6 -WA_INACTIVE = 0 -WA_ACTIVE = 1 -WA_CLICKACTIVE = 2 -WM_SETFOCUS = 7 -WM_KILLFOCUS = 8 -WM_ENABLE = 10 -WM_SETREDRAW = 11 -WM_SETTEXT = 12 -WM_GETTEXT = 13 -WM_GETTEXTLENGTH = 14 -WM_PAINT = 15 -WM_CLOSE = 16 -WM_QUERYENDSESSION = 17 -WM_QUIT = 18 -WM_QUERYOPEN = 19 -WM_ERASEBKGND = 20 -WM_SYSCOLORCHANGE = 21 -WM_ENDSESSION = 22 -WM_SHOWWINDOW = 24 -WM_WININICHANGE = 26 -WM_SETTINGCHANGE = WM_WININICHANGE -WM_DEVMODECHANGE = 27 -WM_ACTIVATEAPP = 28 -WM_FONTCHANGE = 29 -WM_TIMECHANGE = 30 -WM_CANCELMODE = 31 -WM_SETCURSOR = 32 -WM_MOUSEACTIVATE = 33 -WM_CHILDACTIVATE = 34 -WM_QUEUESYNC = 35 -WM_GETMINMAXINFO = 36 -WM_PAINTICON = 38 -WM_ICONERASEBKGND = 39 -WM_NEXTDLGCTL = 40 -WM_SPOOLERSTATUS = 42 -WM_DRAWITEM = 43 -WM_MEASUREITEM = 44 -WM_DELETEITEM = 45 -WM_VKEYTOITEM = 46 -WM_CHARTOITEM = 47 -WM_SETFONT = 48 -WM_GETFONT = 49 -WM_SETHOTKEY = 50 -WM_GETHOTKEY = 51 -WM_QUERYDRAGICON = 55 -WM_COMPAREITEM = 57 -WM_GETOBJECT = 61 -WM_COMPACTING = 65 -WM_COMMNOTIFY = 68 -WM_WINDOWPOSCHANGING = 70 -WM_WINDOWPOSCHANGED = 71 -WM_POWER = 72 -PWR_OK = 1 -PWR_FAIL = (-1) -PWR_SUSPENDREQUEST = 1 -PWR_SUSPENDRESUME = 2 -PWR_CRITICALRESUME = 3 -WM_COPYDATA = 74 -WM_CANCELJOURNAL = 75 -WM_NOTIFY = 78 -WM_INPUTLANGCHANGEREQUEST = 80 -WM_INPUTLANGCHANGE = 81 -WM_TCARD = 82 -WM_HELP = 83 -WM_USERCHANGED = 84 -WM_NOTIFYFORMAT = 85 -NFR_ANSI = 1 -NFR_UNICODE = 2 -NF_QUERY = 3 -NF_REQUERY = 4 -WM_CONTEXTMENU = 123 -WM_STYLECHANGING = 124 -WM_STYLECHANGED = 125 -WM_DISPLAYCHANGE = 126 -WM_GETICON = 127 -WM_SETICON = 128 -WM_NCCREATE = 129 -WM_NCDESTROY = 130 -WM_NCCALCSIZE = 131 -WM_NCHITTEST = 132 -WM_NCPAINT = 133 -WM_NCACTIVATE = 134 -WM_GETDLGCODE = 135 -WM_SYNCPAINT = 136 -WM_NCMOUSEMOVE = 160 -WM_NCLBUTTONDOWN = 161 -WM_NCLBUTTONUP = 162 -WM_NCLBUTTONDBLCLK = 163 -WM_NCRBUTTONDOWN = 164 -WM_NCRBUTTONUP = 165 -WM_NCRBUTTONDBLCLK = 166 -WM_NCMBUTTONDOWN = 167 -WM_NCMBUTTONUP = 168 -WM_NCMBUTTONDBLCLK = 169 -WM_KEYFIRST = 256 -WM_KEYDOWN = 256 -WM_KEYUP = 257 -WM_CHAR = 258 -WM_DEADCHAR = 259 -WM_SYSKEYDOWN = 260 -WM_SYSKEYUP = 261 -WM_SYSCHAR = 262 -WM_SYSDEADCHAR = 263 -WM_KEYLAST = 264 -WM_IME_STARTCOMPOSITION = 269 -WM_IME_ENDCOMPOSITION = 270 -WM_IME_COMPOSITION = 271 -WM_IME_KEYLAST = 271 -WM_INITDIALOG = 272 -WM_COMMAND = 273 -WM_SYSCOMMAND = 274 -WM_TIMER = 275 -WM_HSCROLL = 276 -WM_VSCROLL = 277 -WM_INITMENU = 278 -WM_INITMENUPOPUP = 279 -WM_MENUSELECT = 287 -WM_MENUCHAR = 288 -WM_ENTERIDLE = 289 -WM_MENURBUTTONUP = 290 -WM_MENUDRAG = 291 -WM_MENUGETOBJECT = 292 -WM_UNINITMENUPOPUP = 293 -WM_MENUCOMMAND = 294 -WM_CTLCOLORMSGBOX = 306 -WM_CTLCOLOREDIT = 307 -WM_CTLCOLORLISTBOX = 308 -WM_CTLCOLORBTN = 309 -WM_CTLCOLORDLG = 310 -WM_CTLCOLORSCROLLBAR = 311 -WM_CTLCOLORSTATIC = 312 -WM_MOUSEFIRST = 512 -WM_MOUSEMOVE = 512 -WM_LBUTTONDOWN = 513 -WM_LBUTTONUP = 514 -WM_LBUTTONDBLCLK = 515 -WM_RBUTTONDOWN = 516 -WM_RBUTTONUP = 517 -WM_RBUTTONDBLCLK = 518 -WM_MBUTTONDOWN = 519 -WM_MBUTTONUP = 520 -WM_MBUTTONDBLCLK = 521 -WM_MOUSEWHEEL = 522 -WM_MOUSELAST = 522 -WHEEL_DELTA = 120 # Value for rolling one detent -WHEEL_PAGESCROLL = -1 # Scroll one page -WM_PARENTNOTIFY = 528 -MENULOOP_WINDOW = 0 -MENULOOP_POPUP = 1 -WM_ENTERMENULOOP = 529 -WM_EXITMENULOOP = 530 -WM_NEXTMENU = 531 -WM_SIZING = 532 -WM_CAPTURECHANGED = 533 -WM_MOVING = 534 -WM_POWERBROADCAST = 536 -PBT_APMQUERYSUSPEND = 0 -PBT_APMQUERYSTANDBY = 1 -PBT_APMQUERYSUSPENDFAILED = 2 -PBT_APMQUERYSTANDBYFAILED = 3 -PBT_APMSUSPEND = 4 -PBT_APMSTANDBY = 5 -PBT_APMRESUMECRITICAL = 6 -PBT_APMRESUMESUSPEND = 7 -PBT_APMRESUMESTANDBY = 8 -PBTF_APMRESUMEFROMFAILURE = 1 -PBT_APMBATTERYLOW = 9 -PBT_APMPOWERSTATUSCHANGE = 10 -PBT_APMOEMEVENT = 11 -PBT_APMRESUMEAUTOMATIC = 18 -WM_DEVICECHANGE = 537 -WM_MDICREATE = 544 -WM_MDIDESTROY = 545 -WM_MDIACTIVATE = 546 -WM_MDIRESTORE = 547 -WM_MDINEXT = 548 -WM_MDIMAXIMIZE = 549 -WM_MDITILE = 550 -WM_MDICASCADE = 551 -WM_MDIICONARRANGE = 552 -WM_MDIGETACTIVE = 553 -WM_MDISETMENU = 560 -WM_ENTERSIZEMOVE = 561 -WM_EXITSIZEMOVE = 562 -WM_DROPFILES = 563 -WM_MDIREFRESHMENU = 564 -WM_IME_SETCONTEXT = 641 -WM_IME_NOTIFY = 642 -WM_IME_CONTROL = 643 -WM_IME_COMPOSITIONFULL = 644 -WM_IME_SELECT = 645 -WM_IME_CHAR = 646 -WM_IME_REQUEST = 648 -WM_IME_KEYDOWN = 656 -WM_IME_KEYUP = 657 -WM_MOUSEHOVER = 673 -WM_MOUSELEAVE = 675 -WM_CUT = 768 -WM_COPY = 769 -WM_PASTE = 770 -WM_CLEAR = 771 -WM_UNDO = 772 -WM_RENDERFORMAT = 773 -WM_RENDERALLFORMATS = 774 -WM_DESTROYCLIPBOARD = 775 -WM_DRAWCLIPBOARD = 776 -WM_PAINTCLIPBOARD = 777 -WM_VSCROLLCLIPBOARD = 778 -WM_SIZECLIPBOARD = 779 -WM_ASKCBFORMATNAME = 780 -WM_CHANGECBCHAIN = 781 -WM_HSCROLLCLIPBOARD = 782 -WM_QUERYNEWPALETTE = 783 -WM_PALETTEISCHANGING = 784 -WM_PALETTECHANGED = 785 -WM_HOTKEY = 786 -WM_PRINT = 791 -WM_PRINTCLIENT = 792 -WM_HANDHELDFIRST = 856 -WM_HANDHELDLAST = 863 -WM_AFXFIRST = 864 -WM_AFXLAST = 895 -WM_PENWINFIRST = 896 -WM_PENWINLAST = 911 -WM_APP = 32768 -WMSZ_LEFT = 1 -WMSZ_RIGHT = 2 -WMSZ_TOP = 3 -WMSZ_TOPLEFT = 4 -WMSZ_TOPRIGHT = 5 -WMSZ_BOTTOM = 6 -WMSZ_BOTTOMLEFT = 7 -WMSZ_BOTTOMRIGHT = 8 -#ST_BEGINSWP = 0 -#ST_ENDSWP = 1 -HTERROR = (-2) -HTTRANSPARENT = (-1) -HTNOWHERE = 0 -HTCLIENT = 1 -HTCAPTION = 2 -HTSYSMENU = 3 -HTGROWBOX = 4 -HTSIZE = HTGROWBOX -HTMENU = 5 -HTHSCROLL = 6 -HTVSCROLL = 7 -HTMINBUTTON = 8 -HTMAXBUTTON = 9 -HTLEFT = 10 -HTRIGHT = 11 -HTTOP = 12 -HTTOPLEFT = 13 -HTTOPRIGHT = 14 -HTBOTTOM = 15 -HTBOTTOMLEFT = 16 -HTBOTTOMRIGHT = 17 -HTBORDER = 18 -HTREDUCE = HTMINBUTTON -HTZOOM = HTMAXBUTTON -HTSIZEFIRST = HTLEFT -HTSIZELAST = HTBOTTOMRIGHT -HTOBJECT = 19 -HTCLOSE = 20 -HTHELP = 21 -SMTO_NORMAL = 0 -SMTO_BLOCK = 1 -SMTO_ABORTIFHUNG = 2 -SMTO_NOTIMEOUTIFNOTHUNG = 8 -MA_ACTIVATE = 1 -MA_ACTIVATEANDEAT = 2 -MA_NOACTIVATE = 3 -MA_NOACTIVATEANDEAT = 4 -ICON_SMALL = 0 -ICON_BIG = 1 -SIZE_RESTORED = 0 -SIZE_MINIMIZED = 1 -SIZE_MAXIMIZED = 2 -SIZE_MAXSHOW = 3 -SIZE_MAXHIDE = 4 -SIZENORMAL = SIZE_RESTORED -SIZEICONIC = SIZE_MINIMIZED -SIZEFULLSCREEN = SIZE_MAXIMIZED -SIZEZOOMSHOW = SIZE_MAXSHOW -SIZEZOOMHIDE = SIZE_MAXHIDE -WVR_ALIGNTOP = 16 -WVR_ALIGNLEFT = 32 -WVR_ALIGNBOTTOM = 64 -WVR_ALIGNRIGHT = 128 -WVR_HREDRAW = 256 -WVR_VREDRAW = 512 -WVR_REDRAW = (WVR_HREDRAW | WVR_VREDRAW) -WVR_VALIDRECTS = 1024 -MK_LBUTTON = 1 -MK_RBUTTON = 2 -MK_SHIFT = 4 -MK_CONTROL = 8 -MK_MBUTTON = 16 -TME_HOVER = 1 -TME_LEAVE = 2 -TME_QUERY = 1073741824 -TME_CANCEL = -2147483648 -HOVER_DEFAULT = -1 -WS_OVERLAPPED = 0 -WS_POPUP = -2147483648 -WS_CHILD = 1073741824 -WS_MINIMIZE = 536870912 -WS_VISIBLE = 268435456 -WS_DISABLED = 134217728 -WS_CLIPSIBLINGS = 67108864 -WS_CLIPCHILDREN = 33554432 -WS_MAXIMIZE = 16777216 -WS_CAPTION = 12582912 -WS_BORDER = 8388608 -WS_DLGFRAME = 4194304 -WS_VSCROLL = 2097152 -WS_HSCROLL = 1048576 -WS_SYSMENU = 524288 -WS_THICKFRAME = 262144 -WS_GROUP = 131072 -WS_TABSTOP = 65536 -WS_MINIMIZEBOX = 131072 -WS_MAXIMIZEBOX = 65536 -WS_TILED = WS_OVERLAPPED -WS_ICONIC = WS_MINIMIZE -WS_SIZEBOX = WS_THICKFRAME -WS_OVERLAPPEDWINDOW = (WS_OVERLAPPED | \ - WS_CAPTION | \ - WS_SYSMENU | \ - WS_THICKFRAME | \ - WS_MINIMIZEBOX | \ - WS_MAXIMIZEBOX) -WS_POPUPWINDOW = (WS_POPUP | \ - WS_BORDER | \ - WS_SYSMENU) -WS_CHILDWINDOW = (WS_CHILD) -WS_TILEDWINDOW = WS_OVERLAPPEDWINDOW -WS_EX_DLGMODALFRAME = 1 -WS_EX_NOPARENTNOTIFY = 4 -WS_EX_TOPMOST = 8 -WS_EX_ACCEPTFILES = 16 -WS_EX_TRANSPARENT = 32 -WS_EX_MDICHILD = 64 -WS_EX_TOOLWINDOW = 128 -WS_EX_WINDOWEDGE = 256 -WS_EX_CLIENTEDGE = 512 -WS_EX_CONTEXTHELP = 1024 -WS_EX_RIGHT = 4096 -WS_EX_LEFT = 0 -WS_EX_RTLREADING = 8192 -WS_EX_LTRREADING = 0 -WS_EX_LEFTSCROLLBAR = 16384 -WS_EX_RIGHTSCROLLBAR = 0 -WS_EX_CONTROLPARENT = 65536 -WS_EX_STATICEDGE = 131072 -WS_EX_APPWINDOW = 262144 -WS_EX_OVERLAPPEDWINDOW = (WS_EX_WINDOWEDGE | WS_EX_CLIENTEDGE) -WS_EX_PALETTEWINDOW = (WS_EX_WINDOWEDGE | WS_EX_TOOLWINDOW | WS_EX_TOPMOST) -WS_EX_LAYERED = 0x00080000 -WS_EX_NOINHERITLAYOUT = 0x00100000 -WS_EX_LAYOUTRTL = 0x00400000 -WS_EX_COMPOSITED = 0x02000000 -WS_EX_NOACTIVATE = 0x08000000 - -CS_VREDRAW = 1 -CS_HREDRAW = 2 -#CS_KEYCVTWINDOW = 0x0004 -CS_DBLCLKS = 8 -CS_OWNDC = 32 -CS_CLASSDC = 64 -CS_PARENTDC = 128 -#CS_NOKEYCVT = 0x0100 -CS_NOCLOSE = 512 -CS_SAVEBITS = 2048 -CS_BYTEALIGNCLIENT = 4096 -CS_BYTEALIGNWINDOW = 8192 -CS_GLOBALCLASS = 16384 -CS_IME = 65536 -PRF_CHECKVISIBLE = 1 -PRF_NONCLIENT = 2 -PRF_CLIENT = 4 -PRF_ERASEBKGND = 8 -PRF_CHILDREN = 16 -PRF_OWNED = 32 -BDR_RAISEDOUTER = 1 -BDR_SUNKENOUTER = 2 -BDR_RAISEDINNER = 4 -BDR_SUNKENINNER = 8 -BDR_OUTER = 3 -BDR_INNER = 12 -#BDR_RAISED = 0x0005 -#BDR_SUNKEN = 0x000a -EDGE_RAISED = (BDR_RAISEDOUTER | BDR_RAISEDINNER) -EDGE_SUNKEN = (BDR_SUNKENOUTER | BDR_SUNKENINNER) -EDGE_ETCHED = (BDR_SUNKENOUTER | BDR_RAISEDINNER) -EDGE_BUMP = (BDR_RAISEDOUTER | BDR_SUNKENINNER) - -# winuser.h line 2879 -ISMEX_NOSEND = 0 -ISMEX_SEND = 1 -ISMEX_NOTIFY = 2 -ISMEX_CALLBACK = 4 -ISMEX_REPLIED = 8 -CW_USEDEFAULT = -2147483648 -FLASHW_STOP = 0 -FLASHW_CAPTION = 1 -FLASHW_TRAY = 2 -FLASHW_ALL = (FLASHW_CAPTION | FLASHW_TRAY) -FLASHW_TIMER = 4 -FLASHW_TIMERNOFG = 12 - -# winuser.h line 7963 -DS_ABSALIGN = 1 -DS_SYSMODAL = 2 -DS_LOCALEDIT = 32 -DS_SETFONT = 64 -DS_MODALFRAME = 128 -DS_NOIDLEMSG = 256 -DS_SETFOREGROUND = 512 -DS_3DLOOK = 4 -DS_FIXEDSYS = 8 -DS_NOFAILCREATE = 16 -DS_CONTROL = 1024 -DS_CENTER = 2048 -DS_CENTERMOUSE = 4096 -DS_CONTEXTHELP = 8192 -DM_GETDEFID = (WM_USER+0) -DM_SETDEFID = (WM_USER+1) -DM_REPOSITION = (WM_USER+2) -#PSM_PAGEINFO = (WM_USER+100) -#PSM_SHEETINFO = (WM_USER+101) -#PSI_SETACTIVE = 0x0001 -#PSI_KILLACTIVE = 0x0002 -#PSI_APPLY = 0x0003 -#PSI_RESET = 0x0004 -#PSI_HASHELP = 0x0005 -#PSI_HELP = 0x0006 -#PSI_CHANGED = 0x0001 -#PSI_GUISTART = 0x0002 -#PSI_REBOOT = 0x0003 -#PSI_GETSIBLINGS = 0x0004 -DC_HASDEFID = 21323 -DLGC_WANTARROWS = 1 -DLGC_WANTTAB = 2 -DLGC_WANTALLKEYS = 4 -DLGC_WANTMESSAGE = 4 -DLGC_HASSETSEL = 8 -DLGC_DEFPUSHBUTTON = 16 -DLGC_UNDEFPUSHBUTTON = 32 -DLGC_RADIOBUTTON = 64 -DLGC_WANTCHARS = 128 -DLGC_STATIC = 256 -DLGC_BUTTON = 8192 -LB_CTLCODE = 0 -LB_OKAY = 0 -LB_ERR = (-1) -LB_ERRSPACE = (-2) -LBN_ERRSPACE = (-2) -LBN_SELCHANGE = 1 -LBN_DBLCLK = 2 -LBN_SELCANCEL = 3 -LBN_SETFOCUS = 4 -LBN_KILLFOCUS = 5 -LB_ADDSTRING = 384 -LB_INSERTSTRING = 385 -LB_DELETESTRING = 386 -LB_SELITEMRANGEEX = 387 -LB_RESETCONTENT = 388 -LB_SETSEL = 389 -LB_SETCURSEL = 390 -LB_GETSEL = 391 -LB_GETCURSEL = 392 -LB_GETTEXT = 393 -LB_GETTEXTLEN = 394 -LB_GETCOUNT = 395 -LB_SELECTSTRING = 396 -LB_DIR = 397 -LB_GETTOPINDEX = 398 -LB_FINDSTRING = 399 -LB_GETSELCOUNT = 400 -LB_GETSELITEMS = 401 -LB_SETTABSTOPS = 402 -LB_GETHORIZONTALEXTENT = 403 -LB_SETHORIZONTALEXTENT = 404 -LB_SETCOLUMNWIDTH = 405 -LB_ADDFILE = 406 -LB_SETTOPINDEX = 407 -LB_GETITEMRECT = 408 -LB_GETITEMDATA = 409 -LB_SETITEMDATA = 410 -LB_SELITEMRANGE = 411 -LB_SETANCHORINDEX = 412 -LB_GETANCHORINDEX = 413 -LB_SETCARETINDEX = 414 -LB_GETCARETINDEX = 415 -LB_SETITEMHEIGHT = 416 -LB_GETITEMHEIGHT = 417 -LB_FINDSTRINGEXACT = 418 -LB_SETLOCALE = 421 -LB_GETLOCALE = 422 -LB_SETCOUNT = 423 -LB_INITSTORAGE = 424 -LB_ITEMFROMPOINT = 425 -LB_MSGMAX = 432 -LBS_NOTIFY = 1 -LBS_SORT = 2 -LBS_NOREDRAW = 4 -LBS_MULTIPLESEL = 8 -LBS_OWNERDRAWFIXED = 16 -LBS_OWNERDRAWVARIABLE = 32 -LBS_HASSTRINGS = 64 -LBS_USETABSTOPS = 128 -LBS_NOINTEGRALHEIGHT = 256 -LBS_MULTICOLUMN = 512 -LBS_WANTKEYBOARDINPUT = 1024 -LBS_EXTENDEDSEL = 2048 -LBS_DISABLENOSCROLL = 4096 -LBS_NODATA = 8192 -LBS_NOSEL = 16384 -LBS_STANDARD = (LBS_NOTIFY | LBS_SORT | WS_VSCROLL | WS_BORDER) -CB_OKAY = 0 -CB_ERR = (-1) -CB_ERRSPACE = (-2) -CBN_ERRSPACE = (-1) -CBN_SELCHANGE = 1 -CBN_DBLCLK = 2 -CBN_SETFOCUS = 3 -CBN_KILLFOCUS = 4 -CBN_EDITCHANGE = 5 -CBN_EDITUPDATE = 6 -CBN_DROPDOWN = 7 -CBN_CLOSEUP = 8 -CBN_SELENDOK = 9 -CBN_SELENDCANCEL = 10 -CBS_SIMPLE = 1 -CBS_DROPDOWN = 2 -CBS_DROPDOWNLIST = 3 -CBS_OWNERDRAWFIXED = 16 -CBS_OWNERDRAWVARIABLE = 32 -CBS_AUTOHSCROLL = 64 -CBS_OEMCONVERT = 128 -CBS_SORT = 256 -CBS_HASSTRINGS = 512 -CBS_NOINTEGRALHEIGHT = 1024 -CBS_DISABLENOSCROLL = 2048 -CBS_UPPERCASE = 8192 -CBS_LOWERCASE = 16384 -CB_GETEDITSEL = 320 -CB_LIMITTEXT = 321 -CB_SETEDITSEL = 322 -CB_ADDSTRING = 323 -CB_DELETESTRING = 324 -CB_DIR = 325 -CB_GETCOUNT = 326 -CB_GETCURSEL = 327 -CB_GETLBTEXT = 328 -CB_GETLBTEXTLEN = 329 -CB_INSERTSTRING = 330 -CB_RESETCONTENT = 331 -CB_FINDSTRING = 332 -CB_SELECTSTRING = 333 -CB_SETCURSEL = 334 -CB_SHOWDROPDOWN = 335 -CB_GETITEMDATA = 336 -CB_SETITEMDATA = 337 -CB_GETDROPPEDCONTROLRECT = 338 -CB_SETITEMHEIGHT = 339 -CB_GETITEMHEIGHT = 340 -CB_SETEXTENDEDUI = 341 -CB_GETEXTENDEDUI = 342 -CB_GETDROPPEDSTATE = 343 -CB_FINDSTRINGEXACT = 344 -CB_SETLOCALE = 345 -CB_GETLOCALE = 346 -CB_GETTOPINDEX = 347 -CB_SETTOPINDEX = 348 -CB_GETHORIZONTALEXTENT = 349 -CB_SETHORIZONTALEXTENT = 350 -CB_GETDROPPEDWIDTH = 351 -CB_SETDROPPEDWIDTH = 352 -CB_INITSTORAGE = 353 -CB_MSGMAX = 354 -SBS_HORZ = 0 -SBS_VERT = 1 -SBS_TOPALIGN = 2 -SBS_LEFTALIGN = 2 -SBS_BOTTOMALIGN = 4 -SBS_RIGHTALIGN = 4 -SBS_SIZEBOXTOPLEFTALIGN = 2 -SBS_SIZEBOXBOTTOMRIGHTALIGN = 4 -SBS_SIZEBOX = 8 -SBS_SIZEGRIP = 16 -SBM_SETPOS = 224 -SBM_GETPOS = 225 -SBM_SETRANGE = 226 -SBM_SETRANGEREDRAW = 230 -SBM_GETRANGE = 227 -SBM_ENABLE_ARROWS = 228 -SBM_SETSCROLLINFO = 233 -SBM_GETSCROLLINFO = 234 -SIF_RANGE = 1 -SIF_PAGE = 2 -SIF_POS = 4 -SIF_DISABLENOSCROLL = 8 -SIF_TRACKPOS = 16 -SIF_ALL = (SIF_RANGE | SIF_PAGE | SIF_POS | SIF_TRACKPOS) -MDIS_ALLCHILDSTYLES = 1 -MDITILE_VERTICAL = 0 -MDITILE_HORIZONTAL = 1 -MDITILE_SKIPDISABLED = 2 - -IMC_GETCANDIDATEPOS = 7 -IMC_SETCANDIDATEPOS = 8 -IMC_GETCOMPOSITIONFONT = 9 -IMC_SETCOMPOSITIONFONT = 10 -IMC_GETCOMPOSITIONWINDOW = 11 -IMC_SETCOMPOSITIONWINDOW = 12 -IMC_GETSTATUSWINDOWPOS = 15 -IMC_SETSTATUSWINDOWPOS = 16 -IMC_CLOSESTATUSWINDOW = 33 -IMC_OPENSTATUSWINDOW = 34 -# Generated by h2py from \msvc20\include\winnt.h -# hacked and split by mhammond. -DELETE = (65536) -READ_CONTROL = (131072) -WRITE_DAC = (262144) -WRITE_OWNER = (524288) -SYNCHRONIZE = (1048576) -STANDARD_RIGHTS_REQUIRED = (983040) -STANDARD_RIGHTS_READ = (READ_CONTROL) -STANDARD_RIGHTS_WRITE = (READ_CONTROL) -STANDARD_RIGHTS_EXECUTE = (READ_CONTROL) -STANDARD_RIGHTS_ALL = (2031616) -SPECIFIC_RIGHTS_ALL = (65535) -ACCESS_SYSTEM_SECURITY = (16777216) -MAXIMUM_ALLOWED = (33554432) -GENERIC_READ = (-2147483648) -GENERIC_WRITE = (1073741824) -GENERIC_EXECUTE = (536870912) -GENERIC_ALL = (268435456) - -SERVICE_KERNEL_DRIVER = 1 -SERVICE_FILE_SYSTEM_DRIVER = 2 -SERVICE_ADAPTER = 4 -SERVICE_RECOGNIZER_DRIVER = 8 -SERVICE_DRIVER = (SERVICE_KERNEL_DRIVER | \ - SERVICE_FILE_SYSTEM_DRIVER | \ - SERVICE_RECOGNIZER_DRIVER) -SERVICE_WIN32_OWN_PROCESS = 16 -SERVICE_WIN32_SHARE_PROCESS = 32 -SERVICE_WIN32 = (SERVICE_WIN32_OWN_PROCESS | \ - SERVICE_WIN32_SHARE_PROCESS) -SERVICE_INTERACTIVE_PROCESS = 256 -SERVICE_TYPE_ALL = (SERVICE_WIN32 | \ - SERVICE_ADAPTER | \ - SERVICE_DRIVER | \ - SERVICE_INTERACTIVE_PROCESS) -SERVICE_BOOT_START = 0 -SERVICE_SYSTEM_START = 1 -SERVICE_AUTO_START = 2 -SERVICE_DEMAND_START = 3 -SERVICE_DISABLED = 4 -SERVICE_ERROR_IGNORE = 0 -SERVICE_ERROR_NORMAL = 1 -SERVICE_ERROR_SEVERE = 2 -SERVICE_ERROR_CRITICAL = 3 -TAPE_ERASE_SHORT = 0 -TAPE_ERASE_LONG = 1 -TAPE_LOAD = 0 -TAPE_UNLOAD = 1 -TAPE_TENSION = 2 -TAPE_LOCK = 3 -TAPE_UNLOCK = 4 -TAPE_FORMAT = 5 -TAPE_SETMARKS = 0 -TAPE_FILEMARKS = 1 -TAPE_SHORT_FILEMARKS = 2 -TAPE_LONG_FILEMARKS = 3 -TAPE_ABSOLUTE_POSITION = 0 -TAPE_LOGICAL_POSITION = 1 -TAPE_PSEUDO_LOGICAL_POSITION = 2 -TAPE_REWIND = 0 -TAPE_ABSOLUTE_BLOCK = 1 -TAPE_LOGICAL_BLOCK = 2 -TAPE_PSEUDO_LOGICAL_BLOCK = 3 -TAPE_SPACE_END_OF_DATA = 4 -TAPE_SPACE_RELATIVE_BLOCKS = 5 -TAPE_SPACE_FILEMARKS = 6 -TAPE_SPACE_SEQUENTIAL_FMKS = 7 -TAPE_SPACE_SETMARKS = 8 -TAPE_SPACE_SEQUENTIAL_SMKS = 9 -TAPE_DRIVE_FIXED = 1 -TAPE_DRIVE_SELECT = 2 -TAPE_DRIVE_INITIATOR = 4 -TAPE_DRIVE_ERASE_SHORT = 16 -TAPE_DRIVE_ERASE_LONG = 32 -TAPE_DRIVE_ERASE_BOP_ONLY = 64 -TAPE_DRIVE_ERASE_IMMEDIATE = 128 -TAPE_DRIVE_TAPE_CAPACITY = 256 -TAPE_DRIVE_TAPE_REMAINING = 512 -TAPE_DRIVE_FIXED_BLOCK = 1024 -TAPE_DRIVE_VARIABLE_BLOCK = 2048 -TAPE_DRIVE_WRITE_PROTECT = 4096 -TAPE_DRIVE_EOT_WZ_SIZE = 8192 -TAPE_DRIVE_ECC = 65536 -TAPE_DRIVE_COMPRESSION = 131072 -TAPE_DRIVE_PADDING = 262144 -TAPE_DRIVE_REPORT_SMKS = 524288 -TAPE_DRIVE_GET_ABSOLUTE_BLK = 1048576 -TAPE_DRIVE_GET_LOGICAL_BLK = 2097152 -TAPE_DRIVE_SET_EOT_WZ_SIZE = 4194304 -TAPE_DRIVE_LOAD_UNLOAD = -2147483647 -TAPE_DRIVE_TENSION = -2147483646 -TAPE_DRIVE_LOCK_UNLOCK = -2147483644 -TAPE_DRIVE_REWIND_IMMEDIATE = -2147483640 -TAPE_DRIVE_SET_BLOCK_SIZE = -2147483632 -TAPE_DRIVE_LOAD_UNLD_IMMED = -2147483616 -TAPE_DRIVE_TENSION_IMMED = -2147483584 -TAPE_DRIVE_LOCK_UNLK_IMMED = -2147483520 -TAPE_DRIVE_SET_ECC = -2147483392 -TAPE_DRIVE_SET_COMPRESSION = -2147483136 -TAPE_DRIVE_SET_PADDING = -2147482624 -TAPE_DRIVE_SET_REPORT_SMKS = -2147481600 -TAPE_DRIVE_ABSOLUTE_BLK = -2147479552 -TAPE_DRIVE_ABS_BLK_IMMED = -2147475456 -TAPE_DRIVE_LOGICAL_BLK = -2147467264 -TAPE_DRIVE_LOG_BLK_IMMED = -2147450880 -TAPE_DRIVE_END_OF_DATA = -2147418112 -TAPE_DRIVE_RELATIVE_BLKS = -2147352576 -TAPE_DRIVE_FILEMARKS = -2147221504 -TAPE_DRIVE_SEQUENTIAL_FMKS = -2146959360 -TAPE_DRIVE_SETMARKS = -2146435072 -TAPE_DRIVE_SEQUENTIAL_SMKS = -2145386496 -TAPE_DRIVE_REVERSE_POSITION = -2143289344 -TAPE_DRIVE_SPACE_IMMEDIATE = -2139095040 -TAPE_DRIVE_WRITE_SETMARKS = -2130706432 -TAPE_DRIVE_WRITE_FILEMARKS = -2113929216 -TAPE_DRIVE_WRITE_SHORT_FMKS = -2080374784 -TAPE_DRIVE_WRITE_LONG_FMKS = -2013265920 -TAPE_DRIVE_WRITE_MARK_IMMED = -1879048192 -TAPE_DRIVE_FORMAT = -1610612736 -TAPE_DRIVE_FORMAT_IMMEDIATE = -1073741824 -TAPE_FIXED_PARTITIONS = 0 -TAPE_SELECT_PARTITIONS = 1 -TAPE_INITIATOR_PARTITIONS = 2 -# Generated by h2py from \msvc20\include\winnt.h -# hacked and split by mhammond. - -APPLICATION_ERROR_MASK = 536870912 -ERROR_SEVERITY_SUCCESS = 0 -ERROR_SEVERITY_INFORMATIONAL = 1073741824 -ERROR_SEVERITY_WARNING = -2147483648 -ERROR_SEVERITY_ERROR = -1073741824 -MINCHAR = 128 -MAXCHAR = 127 -MINSHORT = 32768 -MAXSHORT = 32767 -MINLONG = -2147483648 -MAXLONG = 2147483647 -MAXBYTE = 255 -MAXWORD = 65535 -MAXDWORD = -1 -LANG_NEUTRAL = 0 -LANG_BULGARIAN = 2 -LANG_CHINESE = 4 -LANG_CROATIAN = 26 -LANG_CZECH = 5 -LANG_DANISH = 6 -LANG_DUTCH = 19 -LANG_ENGLISH = 9 -LANG_FINNISH = 11 -LANG_FRENCH = 12 -LANG_GERMAN = 7 -LANG_GREEK = 8 -LANG_HUNGARIAN = 14 -LANG_ICELANDIC = 15 -LANG_ITALIAN = 16 -LANG_JAPANESE = 17 -LANG_KOREAN = 18 -LANG_NORWEGIAN = 20 -LANG_POLISH = 21 -LANG_PORTUGUESE = 22 -LANG_ROMANIAN = 24 -LANG_RUSSIAN = 25 -LANG_SLOVAK = 27 -LANG_SLOVENIAN = 36 -LANG_SPANISH = 10 -LANG_SWEDISH = 29 -LANG_TURKISH = 31 -SUBLANG_NEUTRAL = 0 -SUBLANG_DEFAULT = 1 -SUBLANG_SYS_DEFAULT = 2 -SUBLANG_CHINESE_TRADITIONAL = 1 -SUBLANG_CHINESE_SIMPLIFIED = 2 -SUBLANG_CHINESE_HONGKONG = 3 -SUBLANG_CHINESE_SINGAPORE = 4 -SUBLANG_DUTCH = 1 -SUBLANG_DUTCH_BELGIAN = 2 -SUBLANG_ENGLISH_US = 1 -SUBLANG_ENGLISH_UK = 2 -SUBLANG_ENGLISH_AUS = 3 -SUBLANG_ENGLISH_CAN = 4 -SUBLANG_ENGLISH_NZ = 5 -SUBLANG_ENGLISH_EIRE = 6 -SUBLANG_FRENCH = 1 -SUBLANG_FRENCH_BELGIAN = 2 -SUBLANG_FRENCH_CANADIAN = 3 -SUBLANG_FRENCH_SWISS = 4 -SUBLANG_GERMAN = 1 -SUBLANG_GERMAN_SWISS = 2 -SUBLANG_GERMAN_AUSTRIAN = 3 -SUBLANG_ITALIAN = 1 -SUBLANG_ITALIAN_SWISS = 2 -SUBLANG_NORWEGIAN_BOKMAL = 1 -SUBLANG_NORWEGIAN_NYNORSK = 2 -SUBLANG_PORTUGUESE = 2 -SUBLANG_PORTUGUESE_BRAZILIAN = 1 -SUBLANG_SPANISH = 1 -SUBLANG_SPANISH_MEXICAN = 2 -SUBLANG_SPANISH_MODERN = 3 -SORT_DEFAULT = 0 -SORT_JAPANESE_XJIS = 0 -SORT_JAPANESE_UNICODE = 1 -SORT_CHINESE_BIG5 = 0 -SORT_CHINESE_UNICODE = 1 -SORT_KOREAN_KSC = 0 -SORT_KOREAN_UNICODE = 1 -def PRIMARYLANGID(lgid): return ((lgid) & 1023) - -def SUBLANGID(lgid): return ((lgid) >> 10) - -NLS_VALID_LOCALE_MASK = 1048575 -CONTEXT_PORTABLE_32BIT = 1048576 -CONTEXT_ALPHA = 131072 -CONTEXT_CONTROL = (CONTEXT_ALPHA | 1) -CONTEXT_FLOATING_POINT = (CONTEXT_ALPHA | 2) -CONTEXT_INTEGER = (CONTEXT_ALPHA | 4) -CONTEXT_FULL = (CONTEXT_CONTROL | CONTEXT_FLOATING_POINT | CONTEXT_INTEGER) -SIZE_OF_80387_REGISTERS = 80 -CONTEXT_FULL = (CONTEXT_CONTROL | CONTEXT_FLOATING_POINT | CONTEXT_INTEGER) -CONTEXT_CONTROL = 1 -CONTEXT_FLOATING_POINT = 2 -CONTEXT_INTEGER = 4 -CONTEXT_FULL = (CONTEXT_CONTROL | CONTEXT_FLOATING_POINT | CONTEXT_INTEGER) -PROCESS_TERMINATE = (1) -PROCESS_CREATE_THREAD = (2) -PROCESS_VM_OPERATION = (8) -PROCESS_VM_READ = (16) -PROCESS_VM_WRITE = (32) -PROCESS_DUP_HANDLE = (64) -PROCESS_CREATE_PROCESS = (128) -PROCESS_SET_QUOTA = (256) -PROCESS_SET_INFORMATION = (512) -PROCESS_QUERY_INFORMATION = (1024) -PROCESS_SUSPEND_RESUME = (2048) -PROCESS_QUERY_LIMITED_INFORMATION = (4096) -PROCESS_SET_LIMITED_INFORMATION = (8192) -PROCESS_ALL_ACCESS = (STANDARD_RIGHTS_REQUIRED | SYNCHRONIZE | 4095) -THREAD_TERMINATE = (1) -THREAD_SUSPEND_RESUME = (2) -THREAD_GET_CONTEXT = (8) -THREAD_SET_CONTEXT = (16) -THREAD_SET_INFORMATION = (32) -THREAD_QUERY_INFORMATION = (64) -THREAD_SET_THREAD_TOKEN = (128) -THREAD_IMPERSONATE = (256) -THREAD_DIRECT_IMPERSONATION = (512) -THREAD_SET_LIMITED_INFORMATION = (1024) -THREAD_QUERY_LIMITED_INFORMATION = (2048) -THREAD_RESUME = (4096) -TLS_MINIMUM_AVAILABLE = 64 -EVENT_MODIFY_STATE = 2 -MUTANT_QUERY_STATE = 1 -SEMAPHORE_MODIFY_STATE = 2 -TIME_ZONE_ID_UNKNOWN = 0 -TIME_ZONE_ID_STANDARD = 1 -TIME_ZONE_ID_DAYLIGHT = 2 -PROCESSOR_INTEL_386 = 386 -PROCESSOR_INTEL_486 = 486 -PROCESSOR_INTEL_PENTIUM = 586 -PROCESSOR_INTEL_860 = 860 -PROCESSOR_MIPS_R2000 = 2000 -PROCESSOR_MIPS_R3000 = 3000 -PROCESSOR_MIPS_R4000 = 4000 -PROCESSOR_ALPHA_21064 = 21064 -PROCESSOR_PPC_601 = 601 -PROCESSOR_PPC_603 = 603 -PROCESSOR_PPC_604 = 604 -PROCESSOR_PPC_620 = 620 -SECTION_QUERY = 1 -SECTION_MAP_WRITE = 2 -SECTION_MAP_READ = 4 -SECTION_MAP_EXECUTE = 8 -SECTION_EXTEND_SIZE = 16 -PAGE_NOACCESS = 1 -PAGE_READONLY = 2 -PAGE_READWRITE = 4 -PAGE_WRITECOPY = 8 -PAGE_EXECUTE = 16 -PAGE_EXECUTE_READ = 32 -PAGE_EXECUTE_READWRITE = 64 -PAGE_EXECUTE_WRITECOPY = 128 -PAGE_GUARD = 256 -PAGE_NOCACHE = 512 -MEM_COMMIT = 4096 -MEM_RESERVE = 8192 -MEM_DECOMMIT = 16384 -MEM_RELEASE = 32768 -MEM_FREE = 65536 -MEM_PRIVATE = 131072 -MEM_MAPPED = 262144 -MEM_TOP_DOWN = 1048576 - -# Generated by h2py from \msvc20\include\winnt.h -# hacked and split by mhammond. -SEC_FILE = 8388608 -SEC_IMAGE = 16777216 -SEC_RESERVE = 67108864 -SEC_COMMIT = 134217728 -SEC_NOCACHE = 268435456 -MEM_IMAGE = SEC_IMAGE -FILE_SHARE_READ = 1 -FILE_SHARE_WRITE = 2 -FILE_SHARE_DELETE = 4 -FILE_ATTRIBUTE_READONLY = 1 -FILE_ATTRIBUTE_HIDDEN = 2 -FILE_ATTRIBUTE_SYSTEM = 4 -FILE_ATTRIBUTE_DIRECTORY = 16 -FILE_ATTRIBUTE_ARCHIVE = 32 -FILE_ATTRIBUTE_DEVICE = 64 -FILE_ATTRIBUTE_NORMAL = 128 -FILE_ATTRIBUTE_TEMPORARY = 256 -FILE_ATTRIBUTE_SPARSE_FILE = 512 -FILE_ATTRIBUTE_REPARSE_POINT = 1024 -FILE_ATTRIBUTE_COMPRESSED = 2048 -FILE_ATTRIBUTE_OFFLINE = 4096 -FILE_ATTRIBUTE_NOT_CONTENT_INDEXED = 8192 -FILE_ATTRIBUTE_ENCRYPTED = 16384 -FILE_ATTRIBUTE_VIRTUAL = 65536 -# These FILE_ATTRIBUTE_* flags are apparently old definitions from Windows 95 -# and conflict with current values above - but they live on for b/w compat... -FILE_ATTRIBUTE_ATOMIC_WRITE = 512 -FILE_ATTRIBUTE_XACTION_WRITE = 1024 - -FILE_NOTIFY_CHANGE_FILE_NAME = 1 -FILE_NOTIFY_CHANGE_DIR_NAME = 2 -FILE_NOTIFY_CHANGE_ATTRIBUTES = 4 -FILE_NOTIFY_CHANGE_SIZE = 8 -FILE_NOTIFY_CHANGE_LAST_WRITE = 16 -FILE_NOTIFY_CHANGE_SECURITY = 256 -FILE_CASE_SENSITIVE_SEARCH = 1 -FILE_CASE_PRESERVED_NAMES = 2 -FILE_UNICODE_ON_DISK = 4 -FILE_PERSISTENT_ACLS = 8 -FILE_FILE_COMPRESSION = 16 -FILE_VOLUME_IS_COMPRESSED = 32768 -IO_COMPLETION_MODIFY_STATE = 2 -DUPLICATE_CLOSE_SOURCE = 1 -DUPLICATE_SAME_ACCESS = 2 -SID_MAX_SUB_AUTHORITIES = (15) -SECURITY_NULL_RID = (0) -SECURITY_WORLD_RID = (0) -SECURITY_LOCAL_RID = (0X00000000) -SECURITY_CREATOR_OWNER_RID = (0) -SECURITY_CREATOR_GROUP_RID = (1) -SECURITY_DIALUP_RID = (1) -SECURITY_NETWORK_RID = (2) -SECURITY_BATCH_RID = (3) -SECURITY_INTERACTIVE_RID = (4) -SECURITY_SERVICE_RID = (6) -SECURITY_ANONYMOUS_LOGON_RID = (7) -SECURITY_LOGON_IDS_RID = (5) -SECURITY_LOGON_IDS_RID_COUNT = (3) -SECURITY_LOCAL_SYSTEM_RID = (18) -SECURITY_NT_NON_UNIQUE = (21) -SECURITY_BUILTIN_DOMAIN_RID = (32) -DOMAIN_USER_RID_ADMIN = (500) -DOMAIN_USER_RID_GUEST = (501) -DOMAIN_GROUP_RID_ADMINS = (512) -DOMAIN_GROUP_RID_USERS = (513) -DOMAIN_GROUP_RID_GUESTS = (514) -DOMAIN_ALIAS_RID_ADMINS = (544) -DOMAIN_ALIAS_RID_USERS = (545) -DOMAIN_ALIAS_RID_GUESTS = (546) -DOMAIN_ALIAS_RID_POWER_USERS = (547) -DOMAIN_ALIAS_RID_ACCOUNT_OPS = (548) -DOMAIN_ALIAS_RID_SYSTEM_OPS = (549) -DOMAIN_ALIAS_RID_PRINT_OPS = (550) -DOMAIN_ALIAS_RID_BACKUP_OPS = (551) -DOMAIN_ALIAS_RID_REPLICATOR = (552) -SE_GROUP_MANDATORY = (1) -SE_GROUP_ENABLED_BY_DEFAULT = (2) -SE_GROUP_ENABLED = (4) -SE_GROUP_OWNER = (8) -SE_GROUP_LOGON_ID = (-1073741824) -ACL_REVISION = (2) -ACL_REVISION1 = (1) -ACL_REVISION2 = (2) -ACCESS_ALLOWED_ACE_TYPE = (0) -ACCESS_DENIED_ACE_TYPE = (1) -SYSTEM_AUDIT_ACE_TYPE = (2) -SYSTEM_ALARM_ACE_TYPE = (3) -OBJECT_INHERIT_ACE = (1) -CONTAINER_INHERIT_ACE = (2) -NO_PROPAGATE_INHERIT_ACE = (4) -INHERIT_ONLY_ACE = (8) -VALID_INHERIT_FLAGS = (15) -SUCCESSFUL_ACCESS_ACE_FLAG = (64) -FAILED_ACCESS_ACE_FLAG = (128) -SECURITY_DESCRIPTOR_REVISION = (1) -SECURITY_DESCRIPTOR_REVISION1 = (1) -SECURITY_DESCRIPTOR_MIN_LENGTH = (20) -SE_OWNER_DEFAULTED = (1) -SE_GROUP_DEFAULTED = (2) -SE_DACL_PRESENT = (4) -SE_DACL_DEFAULTED = (8) -SE_SACL_PRESENT = (16) -SE_SACL_DEFAULTED = (32) -SE_SELF_RELATIVE = (32768) -SE_PRIVILEGE_ENABLED_BY_DEFAULT = (1) -SE_PRIVILEGE_ENABLED = (2) -SE_PRIVILEGE_USED_FOR_ACCESS = (-2147483648) -PRIVILEGE_SET_ALL_NECESSARY = (1) -SE_CREATE_TOKEN_NAME = "SeCreateTokenPrivilege" -SE_ASSIGNPRIMARYTOKEN_NAME = "SeAssignPrimaryTokenPrivilege" -SE_LOCK_MEMORY_NAME = "SeLockMemoryPrivilege" -SE_INCREASE_QUOTA_NAME = "SeIncreaseQuotaPrivilege" -SE_UNSOLICITED_INPUT_NAME = "SeUnsolicitedInputPrivilege" -SE_MACHINE_ACCOUNT_NAME = "SeMachineAccountPrivilege" -SE_TCB_NAME = "SeTcbPrivilege" -SE_SECURITY_NAME = "SeSecurityPrivilege" -SE_TAKE_OWNERSHIP_NAME = "SeTakeOwnershipPrivilege" -SE_LOAD_DRIVER_NAME = "SeLoadDriverPrivilege" -SE_SYSTEM_PROFILE_NAME = "SeSystemProfilePrivilege" -SE_SYSTEMTIME_NAME = "SeSystemtimePrivilege" -SE_PROF_SINGLE_PROCESS_NAME = "SeProfileSingleProcessPrivilege" -SE_INC_BASE_PRIORITY_NAME = "SeIncreaseBasePriorityPrivilege" -SE_CREATE_PAGEFILE_NAME = "SeCreatePagefilePrivilege" -SE_CREATE_PERMANENT_NAME = "SeCreatePermanentPrivilege" -SE_BACKUP_NAME = "SeBackupPrivilege" -SE_RESTORE_NAME = "SeRestorePrivilege" -SE_SHUTDOWN_NAME = "SeShutdownPrivilege" -SE_DEBUG_NAME = "SeDebugPrivilege" -SE_AUDIT_NAME = "SeAuditPrivilege" -SE_SYSTEM_ENVIRONMENT_NAME = "SeSystemEnvironmentPrivilege" -SE_CHANGE_NOTIFY_NAME = "SeChangeNotifyPrivilege" -SE_REMOTE_SHUTDOWN_NAME = "SeRemoteShutdownPrivilege" - -TOKEN_ASSIGN_PRIMARY = (1) -TOKEN_DUPLICATE = (2) -TOKEN_IMPERSONATE = (4) -TOKEN_QUERY = (8) -TOKEN_QUERY_SOURCE = (16) -TOKEN_ADJUST_PRIVILEGES = (32) -TOKEN_ADJUST_GROUPS = (64) -TOKEN_ADJUST_DEFAULT = (128) -TOKEN_ALL_ACCESS = (STANDARD_RIGHTS_REQUIRED |\ - TOKEN_ASSIGN_PRIMARY |\ - TOKEN_DUPLICATE |\ - TOKEN_IMPERSONATE |\ - TOKEN_QUERY |\ - TOKEN_QUERY_SOURCE |\ - TOKEN_ADJUST_PRIVILEGES |\ - TOKEN_ADJUST_GROUPS |\ - TOKEN_ADJUST_DEFAULT) -TOKEN_READ = (STANDARD_RIGHTS_READ |\ - TOKEN_QUERY) -TOKEN_WRITE = (STANDARD_RIGHTS_WRITE |\ - TOKEN_ADJUST_PRIVILEGES |\ - TOKEN_ADJUST_GROUPS |\ - TOKEN_ADJUST_DEFAULT) -TOKEN_EXECUTE = (STANDARD_RIGHTS_EXECUTE) -TOKEN_SOURCE_LENGTH = 8 - -KEY_QUERY_VALUE = (1) -KEY_SET_VALUE = (2) -KEY_CREATE_SUB_KEY = (4) -KEY_ENUMERATE_SUB_KEYS = (8) -KEY_NOTIFY = (16) -KEY_CREATE_LINK = (32) -KEY_WOW64_32KEY = 512 -KEY_WOW64_64KEY = 256 -KEY_WOW64_RES = 768 -KEY_READ = ((STANDARD_RIGHTS_READ |\ - KEY_QUERY_VALUE |\ - KEY_ENUMERATE_SUB_KEYS |\ - KEY_NOTIFY) \ - & \ - (~SYNCHRONIZE)) -KEY_WRITE = ((STANDARD_RIGHTS_WRITE |\ - KEY_SET_VALUE |\ - KEY_CREATE_SUB_KEY) \ - & \ - (~SYNCHRONIZE)) -KEY_EXECUTE = ((KEY_READ) \ - & \ - (~SYNCHRONIZE)) -KEY_ALL_ACCESS = ((STANDARD_RIGHTS_ALL |\ - KEY_QUERY_VALUE |\ - KEY_SET_VALUE |\ - KEY_CREATE_SUB_KEY |\ - KEY_ENUMERATE_SUB_KEYS |\ - KEY_NOTIFY |\ - KEY_CREATE_LINK) \ - & \ - (~SYNCHRONIZE)) -REG_NOTIFY_CHANGE_ATTRIBUTES = (2) -REG_NOTIFY_CHANGE_SECURITY = (8) -REG_RESOURCE_REQUIREMENTS_LIST = ( 10 ) -REG_NONE = ( 0 ) # No value type -REG_SZ = ( 1 ) # Unicode nul terminated string -REG_EXPAND_SZ = ( 2 ) # Unicode nul terminated string - # (with environment variable references) -REG_BINARY = ( 3 ) # Free form binary -REG_DWORD = ( 4 ) # 32-bit number -REG_DWORD_LITTLE_ENDIAN = ( 4 ) # 32-bit number (same as REG_DWORD) -REG_DWORD_BIG_ENDIAN = ( 5 ) # 32-bit number -REG_LINK = ( 6 ) # Symbolic Link (unicode) -REG_MULTI_SZ = ( 7 ) # Multiple Unicode strings -REG_RESOURCE_LIST = ( 8 ) # Resource list in the resource map -REG_FULL_RESOURCE_DESCRIPTOR =( 9 ) # Resource list in the hardware description -REG_RESOURCE_REQUIREMENTS_LIST = ( 10 ) -REG_QWORD = ( 11 ) # 64-bit number -REG_QWORD_LITTLE_ENDIAN = ( 11 ) # 64-bit number (same as REG_QWORD) - - -# Generated by h2py from \msvc20\include\winnt.h -# hacked and split by mhammond. -# Included from string.h -_NLSCMPERROR = 2147483647 -NULL = 0 -HEAP_NO_SERIALIZE = 1 -HEAP_GROWABLE = 2 -HEAP_GENERATE_EXCEPTIONS = 4 -HEAP_ZERO_MEMORY = 8 -HEAP_REALLOC_IN_PLACE_ONLY = 16 -HEAP_TAIL_CHECKING_ENABLED = 32 -HEAP_FREE_CHECKING_ENABLED = 64 -HEAP_DISABLE_COALESCE_ON_FREE = 128 -IS_TEXT_UNICODE_ASCII16 = 1 -IS_TEXT_UNICODE_REVERSE_ASCII16 = 16 -IS_TEXT_UNICODE_STATISTICS = 2 -IS_TEXT_UNICODE_REVERSE_STATISTICS = 32 -IS_TEXT_UNICODE_CONTROLS = 4 -IS_TEXT_UNICODE_REVERSE_CONTROLS = 64 -IS_TEXT_UNICODE_SIGNATURE = 8 -IS_TEXT_UNICODE_REVERSE_SIGNATURE = 128 -IS_TEXT_UNICODE_ILLEGAL_CHARS = 256 -IS_TEXT_UNICODE_ODD_LENGTH = 512 -IS_TEXT_UNICODE_DBCS_LEADBYTE = 1024 -IS_TEXT_UNICODE_NULL_BYTES = 4096 -IS_TEXT_UNICODE_UNICODE_MASK = 15 -IS_TEXT_UNICODE_REVERSE_MASK = 240 -IS_TEXT_UNICODE_NOT_UNICODE_MASK = 3840 -IS_TEXT_UNICODE_NOT_ASCII_MASK = 61440 -COMPRESSION_FORMAT_NONE = (0) -COMPRESSION_FORMAT_DEFAULT = (1) -COMPRESSION_FORMAT_LZNT1 = (2) -COMPRESSION_ENGINE_STANDARD = (0) -COMPRESSION_ENGINE_MAXIMUM = (256) -MESSAGE_RESOURCE_UNICODE = 1 -RTL_CRITSECT_TYPE = 0 -RTL_RESOURCE_TYPE = 1 -DLL_PROCESS_ATTACH = 1 -DLL_THREAD_ATTACH = 2 -DLL_THREAD_DETACH = 3 -DLL_PROCESS_DETACH = 0 -EVENTLOG_SEQUENTIAL_READ = 0X0001 -EVENTLOG_SEEK_READ = 0X0002 -EVENTLOG_FORWARDS_READ = 0X0004 -EVENTLOG_BACKWARDS_READ = 0X0008 -EVENTLOG_SUCCESS = 0X0000 -EVENTLOG_ERROR_TYPE = 1 -EVENTLOG_WARNING_TYPE = 2 -EVENTLOG_INFORMATION_TYPE = 4 -EVENTLOG_AUDIT_SUCCESS = 8 -EVENTLOG_AUDIT_FAILURE = 16 -EVENTLOG_START_PAIRED_EVENT = 1 -EVENTLOG_END_PAIRED_EVENT = 2 -EVENTLOG_END_ALL_PAIRED_EVENTS = 4 -EVENTLOG_PAIRED_EVENT_ACTIVE = 8 -EVENTLOG_PAIRED_EVENT_INACTIVE = 16 -# Generated by h2py from \msvc20\include\winnt.h -# hacked and split by mhammond. -OWNER_SECURITY_INFORMATION = (0X00000001) -GROUP_SECURITY_INFORMATION = (0X00000002) -DACL_SECURITY_INFORMATION = (0X00000004) -SACL_SECURITY_INFORMATION = (0X00000008) -IMAGE_SIZEOF_FILE_HEADER = 20 -IMAGE_FILE_MACHINE_UNKNOWN = 0 -IMAGE_NUMBEROF_DIRECTORY_ENTRIES = 16 -IMAGE_SIZEOF_ROM_OPTIONAL_HEADER = 56 -IMAGE_SIZEOF_STD_OPTIONAL_HEADER = 28 -IMAGE_SIZEOF_NT_OPTIONAL_HEADER = 224 -IMAGE_NT_OPTIONAL_HDR_MAGIC = 267 -IMAGE_ROM_OPTIONAL_HDR_MAGIC = 263 -IMAGE_SIZEOF_SHORT_NAME = 8 -IMAGE_SIZEOF_SECTION_HEADER = 40 -IMAGE_SIZEOF_SYMBOL = 18 -IMAGE_SYM_CLASS_NULL = 0 -IMAGE_SYM_CLASS_AUTOMATIC = 1 -IMAGE_SYM_CLASS_EXTERNAL = 2 -IMAGE_SYM_CLASS_STATIC = 3 -IMAGE_SYM_CLASS_REGISTER = 4 -IMAGE_SYM_CLASS_EXTERNAL_DEF = 5 -IMAGE_SYM_CLASS_LABEL = 6 -IMAGE_SYM_CLASS_UNDEFINED_LABEL = 7 -IMAGE_SYM_CLASS_MEMBER_OF_STRUCT = 8 -IMAGE_SYM_CLASS_ARGUMENT = 9 -IMAGE_SYM_CLASS_STRUCT_TAG = 10 -IMAGE_SYM_CLASS_MEMBER_OF_UNION = 11 -IMAGE_SYM_CLASS_UNION_TAG = 12 -IMAGE_SYM_CLASS_TYPE_DEFINITION = 13 -IMAGE_SYM_CLASS_UNDEFINED_STATIC = 14 -IMAGE_SYM_CLASS_ENUM_TAG = 15 -IMAGE_SYM_CLASS_MEMBER_OF_ENUM = 16 -IMAGE_SYM_CLASS_REGISTER_PARAM = 17 -IMAGE_SYM_CLASS_BIT_FIELD = 18 -IMAGE_SYM_CLASS_BLOCK = 100 -IMAGE_SYM_CLASS_FUNCTION = 101 -IMAGE_SYM_CLASS_END_OF_STRUCT = 102 -IMAGE_SYM_CLASS_FILE = 103 -IMAGE_SYM_CLASS_SECTION = 104 -IMAGE_SYM_CLASS_WEAK_EXTERNAL = 105 -N_BTMASK = 15 -N_TMASK = 48 -N_TMASK1 = 192 -N_TMASK2 = 240 -N_BTSHFT = 4 -N_TSHIFT = 2 -IMAGE_SIZEOF_AUX_SYMBOL = 18 -IMAGE_COMDAT_SELECT_NODUPLICATES = 1 -IMAGE_COMDAT_SELECT_ANY = 2 -IMAGE_COMDAT_SELECT_SAME_SIZE = 3 -IMAGE_COMDAT_SELECT_EXACT_MATCH = 4 -IMAGE_COMDAT_SELECT_ASSOCIATIVE = 5 -IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY = 1 -IMAGE_WEAK_EXTERN_SEARCH_LIBRARY = 2 -IMAGE_WEAK_EXTERN_SEARCH_ALIAS = 3 -IMAGE_SIZEOF_RELOCATION = 10 -IMAGE_REL_I386_SECTION = 10 -IMAGE_REL_I386_SECREL = 11 -IMAGE_REL_MIPS_REFHALF = 1 -IMAGE_REL_MIPS_REFWORD = 2 -IMAGE_REL_MIPS_JMPADDR = 3 -IMAGE_REL_MIPS_REFHI = 4 -IMAGE_REL_MIPS_REFLO = 5 -IMAGE_REL_MIPS_GPREL = 6 -IMAGE_REL_MIPS_LITERAL = 7 -IMAGE_REL_MIPS_SECTION = 10 -IMAGE_REL_MIPS_SECREL = 11 -IMAGE_REL_MIPS_REFWORDNB = 34 -IMAGE_REL_MIPS_PAIR = 37 -IMAGE_REL_ALPHA_ABSOLUTE = 0 -IMAGE_REL_ALPHA_REFLONG = 1 -IMAGE_REL_ALPHA_REFQUAD = 2 -IMAGE_REL_ALPHA_GPREL32 = 3 -IMAGE_REL_ALPHA_LITERAL = 4 -IMAGE_REL_ALPHA_LITUSE = 5 -IMAGE_REL_ALPHA_GPDISP = 6 -IMAGE_REL_ALPHA_BRADDR = 7 -IMAGE_REL_ALPHA_HINT = 8 -IMAGE_REL_ALPHA_INLINE_REFLONG = 9 -IMAGE_REL_ALPHA_REFHI = 10 -IMAGE_REL_ALPHA_REFLO = 11 -IMAGE_REL_ALPHA_PAIR = 12 -IMAGE_REL_ALPHA_MATCH = 13 -IMAGE_REL_ALPHA_SECTION = 14 -IMAGE_REL_ALPHA_SECREL = 15 -IMAGE_REL_ALPHA_REFLONGNB = 16 -IMAGE_SIZEOF_BASE_RELOCATION = 8 -IMAGE_REL_BASED_ABSOLUTE = 0 -IMAGE_REL_BASED_HIGH = 1 -IMAGE_REL_BASED_LOW = 2 -IMAGE_REL_BASED_HIGHLOW = 3 -IMAGE_REL_BASED_HIGHADJ = 4 -IMAGE_REL_BASED_MIPS_JMPADDR = 5 -IMAGE_SIZEOF_LINENUMBER = 6 -IMAGE_ARCHIVE_START_SIZE = 8 -IMAGE_ARCHIVE_START = "!\n" -IMAGE_ARCHIVE_END = "`\n" -IMAGE_ARCHIVE_PAD = "\n" -IMAGE_ARCHIVE_LINKER_MEMBER = "/ " -IMAGE_ARCHIVE_LONGNAMES_MEMBER = "// " -IMAGE_SIZEOF_ARCHIVE_MEMBER_HDR = 60 -IMAGE_ORDINAL_FLAG = -2147483648 -def IMAGE_SNAP_BY_ORDINAL(Ordinal): return ((Ordinal & IMAGE_ORDINAL_FLAG) != 0) - -def IMAGE_ORDINAL(Ordinal): return (Ordinal & 65535) - -IMAGE_RESOURCE_NAME_IS_STRING = -2147483648 -IMAGE_RESOURCE_DATA_IS_DIRECTORY = -2147483648 -IMAGE_DEBUG_TYPE_UNKNOWN = 0 -IMAGE_DEBUG_TYPE_COFF = 1 -IMAGE_DEBUG_TYPE_CODEVIEW = 2 -IMAGE_DEBUG_TYPE_FPO = 3 -IMAGE_DEBUG_TYPE_MISC = 4 -IMAGE_DEBUG_TYPE_EXCEPTION = 5 -IMAGE_DEBUG_TYPE_FIXUP = 6 -IMAGE_DEBUG_TYPE_OMAP_TO_SRC = 7 -IMAGE_DEBUG_TYPE_OMAP_FROM_SRC = 8 -FRAME_FPO = 0 -FRAME_TRAP = 1 -FRAME_TSS = 2 -SIZEOF_RFPO_DATA = 16 -IMAGE_DEBUG_MISC_EXENAME = 1 -IMAGE_SEPARATE_DEBUG_SIGNATURE = 18756 -# Generated by h2py from \msvcnt\include\wingdi.h -# hacked and split manually by mhammond. -NEWFRAME = 1 -ABORTDOC = 2 -NEXTBAND = 3 -SETCOLORTABLE = 4 -GETCOLORTABLE = 5 -FLUSHOUTPUT = 6 -DRAFTMODE = 7 -QUERYESCSUPPORT = 8 -SETABORTPROC = 9 -STARTDOC = 10 -ENDDOC = 11 -GETPHYSPAGESIZE = 12 -GETPRINTINGOFFSET = 13 -GETSCALINGFACTOR = 14 -MFCOMMENT = 15 -GETPENWIDTH = 16 -SETCOPYCOUNT = 17 -SELECTPAPERSOURCE = 18 -DEVICEDATA = 19 -PASSTHROUGH = 19 -GETTECHNOLGY = 20 -GETTECHNOLOGY = 20 -SETLINECAP = 21 -SETLINEJOIN = 22 -SETMITERLIMIT = 23 -BANDINFO = 24 -DRAWPATTERNRECT = 25 -GETVECTORPENSIZE = 26 -GETVECTORBRUSHSIZE = 27 -ENABLEDUPLEX = 28 -GETSETPAPERBINS = 29 -GETSETPRINTORIENT = 30 -ENUMPAPERBINS = 31 -SETDIBSCALING = 32 -EPSPRINTING = 33 -ENUMPAPERMETRICS = 34 -GETSETPAPERMETRICS = 35 -POSTSCRIPT_DATA = 37 -POSTSCRIPT_IGNORE = 38 -MOUSETRAILS = 39 -GETDEVICEUNITS = 42 -GETEXTENDEDTEXTMETRICS = 256 -GETEXTENTTABLE = 257 -GETPAIRKERNTABLE = 258 -GETTRACKKERNTABLE = 259 -EXTTEXTOUT = 512 -GETFACENAME = 513 -DOWNLOADFACE = 514 -ENABLERELATIVEWIDTHS = 768 -ENABLEPAIRKERNING = 769 -SETKERNTRACK = 770 -SETALLJUSTVALUES = 771 -SETCHARSET = 772 -STRETCHBLT = 2048 -GETSETSCREENPARAMS = 3072 -BEGIN_PATH = 4096 -CLIP_TO_PATH = 4097 -END_PATH = 4098 -EXT_DEVICE_CAPS = 4099 -RESTORE_CTM = 4100 -SAVE_CTM = 4101 -SET_ARC_DIRECTION = 4102 -SET_BACKGROUND_COLOR = 4103 -SET_POLY_MODE = 4104 -SET_SCREEN_ANGLE = 4105 -SET_SPREAD = 4106 -TRANSFORM_CTM = 4107 -SET_CLIP_BOX = 4108 -SET_BOUNDS = 4109 -SET_MIRROR_MODE = 4110 -OPENCHANNEL = 4110 -DOWNLOADHEADER = 4111 -CLOSECHANNEL = 4112 -POSTSCRIPT_PASSTHROUGH = 4115 -ENCAPSULATED_POSTSCRIPT = 4116 -SP_NOTREPORTED = 16384 -SP_ERROR = (-1) -SP_APPABORT = (-2) -SP_USERABORT = (-3) -SP_OUTOFDISK = (-4) -SP_OUTOFMEMORY = (-5) -PR_JOBSTATUS = 0 - -## GDI object types -OBJ_PEN = 1 -OBJ_BRUSH = 2 -OBJ_DC = 3 -OBJ_METADC = 4 -OBJ_PAL = 5 -OBJ_FONT = 6 -OBJ_BITMAP = 7 -OBJ_REGION = 8 -OBJ_METAFILE = 9 -OBJ_MEMDC = 10 -OBJ_EXTPEN = 11 -OBJ_ENHMETADC = 12 -OBJ_ENHMETAFILE = 13 -OBJ_COLORSPACE = 14 - -MWT_IDENTITY = 1 -MWT_LEFTMULTIPLY = 2 -MWT_RIGHTMULTIPLY = 3 -MWT_MIN = MWT_IDENTITY -MWT_MAX = MWT_RIGHTMULTIPLY -BI_RGB = 0 -BI_RLE8 = 1 -BI_RLE4 = 2 -BI_BITFIELDS = 3 -TMPF_FIXED_PITCH = 1 -TMPF_VECTOR = 2 -TMPF_DEVICE = 8 -TMPF_TRUETYPE = 4 -NTM_REGULAR = 64 -NTM_BOLD = 32 -NTM_ITALIC = 1 -LF_FACESIZE = 32 -LF_FULLFACESIZE = 64 -OUT_DEFAULT_PRECIS = 0 -OUT_STRING_PRECIS = 1 -OUT_CHARACTER_PRECIS = 2 -OUT_STROKE_PRECIS = 3 -OUT_TT_PRECIS = 4 -OUT_DEVICE_PRECIS = 5 -OUT_RASTER_PRECIS = 6 -OUT_TT_ONLY_PRECIS = 7 -OUT_OUTLINE_PRECIS = 8 -CLIP_DEFAULT_PRECIS = 0 -CLIP_CHARACTER_PRECIS = 1 -CLIP_STROKE_PRECIS = 2 -CLIP_MASK = 15 -CLIP_LH_ANGLES = (1<<4) -CLIP_TT_ALWAYS = (2<<4) -CLIP_EMBEDDED = (8<<4) -DEFAULT_QUALITY = 0 -DRAFT_QUALITY = 1 -PROOF_QUALITY = 2 -NONANTIALIASED_QUALITY = 3 -ANTIALIASED_QUALITY = 4 -CLEARTYPE_QUALITY = 5 -CLEARTYPE_NATURAL_QUALITY = 6 -DEFAULT_PITCH = 0 -FIXED_PITCH = 1 -VARIABLE_PITCH = 2 -ANSI_CHARSET = 0 -DEFAULT_CHARSET = 1 -SYMBOL_CHARSET = 2 -SHIFTJIS_CHARSET = 128 -HANGEUL_CHARSET = 129 -CHINESEBIG5_CHARSET = 136 -OEM_CHARSET = 255 -JOHAB_CHARSET = 130 -HEBREW_CHARSET = 177 -ARABIC_CHARSET = 178 -GREEK_CHARSET = 161 -TURKISH_CHARSET = 162 -VIETNAMESE_CHARSET = 163 -THAI_CHARSET = 222 -EASTEUROPE_CHARSET = 238 -RUSSIAN_CHARSET = 204 -MAC_CHARSET = 77 -BALTIC_CHARSET = 186 -FF_DONTCARE = (0<<4) -FF_ROMAN = (1<<4) -FF_SWISS = (2<<4) -FF_MODERN = (3<<4) -FF_SCRIPT = (4<<4) -FF_DECORATIVE = (5<<4) -FW_DONTCARE = 0 -FW_THIN = 100 -FW_EXTRALIGHT = 200 -FW_LIGHT = 300 -FW_NORMAL = 400 -FW_MEDIUM = 500 -FW_SEMIBOLD = 600 -FW_BOLD = 700 -FW_EXTRABOLD = 800 -FW_HEAVY = 900 -FW_ULTRALIGHT = FW_EXTRALIGHT -FW_REGULAR = FW_NORMAL -FW_DEMIBOLD = FW_SEMIBOLD -FW_ULTRABOLD = FW_EXTRABOLD -FW_BLACK = FW_HEAVY -# Generated by h2py from \msvcnt\include\wingdi.h -# hacked and split manually by mhammond. -BS_SOLID = 0 -BS_NULL = 1 -BS_HOLLOW = BS_NULL -BS_HATCHED = 2 -BS_PATTERN = 3 -BS_INDEXED = 4 -BS_DIBPATTERN = 5 -BS_DIBPATTERNPT = 6 -BS_PATTERN8X8 = 7 -BS_DIBPATTERN8X8 = 8 -HS_HORIZONTAL = 0 -HS_VERTICAL = 1 -HS_FDIAGONAL = 2 -HS_BDIAGONAL = 3 -HS_CROSS = 4 -HS_DIAGCROSS = 5 -HS_FDIAGONAL1 = 6 -HS_BDIAGONAL1 = 7 -HS_SOLID = 8 -HS_DENSE1 = 9 -HS_DENSE2 = 10 -HS_DENSE3 = 11 -HS_DENSE4 = 12 -HS_DENSE5 = 13 -HS_DENSE6 = 14 -HS_DENSE7 = 15 -HS_DENSE8 = 16 -HS_NOSHADE = 17 -HS_HALFTONE = 18 -HS_SOLIDCLR = 19 -HS_DITHEREDCLR = 20 -HS_SOLIDTEXTCLR = 21 -HS_DITHEREDTEXTCLR = 22 -HS_SOLIDBKCLR = 23 -HS_DITHEREDBKCLR = 24 -HS_API_MAX = 25 -PS_SOLID = 0 -PS_DASH = 1 -PS_DOT = 2 -PS_DASHDOT = 3 -PS_DASHDOTDOT = 4 -PS_NULL = 5 -PS_INSIDEFRAME = 6 -PS_USERSTYLE = 7 -PS_ALTERNATE = 8 -PS_STYLE_MASK = 15 -PS_ENDCAP_ROUND = 0 -PS_ENDCAP_SQUARE = 256 -PS_ENDCAP_FLAT = 512 -PS_ENDCAP_MASK = 3840 -PS_JOIN_ROUND = 0 -PS_JOIN_BEVEL = 4096 -PS_JOIN_MITER = 8192 -PS_JOIN_MASK = 61440 -PS_COSMETIC = 0 -PS_GEOMETRIC = 65536 -PS_TYPE_MASK = 983040 -AD_COUNTERCLOCKWISE = 1 -AD_CLOCKWISE = 2 -DRIVERVERSION = 0 -TECHNOLOGY = 2 -HORZSIZE = 4 -VERTSIZE = 6 -HORZRES = 8 -VERTRES = 10 -BITSPIXEL = 12 -PLANES = 14 -NUMBRUSHES = 16 -NUMPENS = 18 -NUMMARKERS = 20 -NUMFONTS = 22 -NUMCOLORS = 24 -PDEVICESIZE = 26 -CURVECAPS = 28 -LINECAPS = 30 -POLYGONALCAPS = 32 -TEXTCAPS = 34 -CLIPCAPS = 36 -RASTERCAPS = 38 -ASPECTX = 40 -ASPECTY = 42 -ASPECTXY = 44 -LOGPIXELSX = 88 -LOGPIXELSY = 90 -SIZEPALETTE = 104 -NUMRESERVED = 106 -COLORRES = 108 - -PHYSICALWIDTH = 110 -PHYSICALHEIGHT = 111 -PHYSICALOFFSETX = 112 -PHYSICALOFFSETY = 113 -SCALINGFACTORX = 114 -SCALINGFACTORY = 115 -VREFRESH = 116 -DESKTOPVERTRES = 117 -DESKTOPHORZRES = 118 -BLTALIGNMENT = 119 -SHADEBLENDCAPS = 120 -COLORMGMTCAPS = 121 - -DT_PLOTTER = 0 -DT_RASDISPLAY = 1 -DT_RASPRINTER = 2 -DT_RASCAMERA = 3 -DT_CHARSTREAM = 4 -DT_METAFILE = 5 -DT_DISPFILE = 6 -CC_NONE = 0 -CC_CIRCLES = 1 -CC_PIE = 2 -CC_CHORD = 4 -CC_ELLIPSES = 8 -CC_WIDE = 16 -CC_STYLED = 32 -CC_WIDESTYLED = 64 -CC_INTERIORS = 128 -CC_ROUNDRECT = 256 -LC_NONE = 0 -LC_POLYLINE = 2 -LC_MARKER = 4 -LC_POLYMARKER = 8 -LC_WIDE = 16 -LC_STYLED = 32 -LC_WIDESTYLED = 64 -LC_INTERIORS = 128 -PC_NONE = 0 -PC_POLYGON = 1 -PC_RECTANGLE = 2 -PC_WINDPOLYGON = 4 -PC_TRAPEZOID = 4 -PC_SCANLINE = 8 -PC_WIDE = 16 -PC_STYLED = 32 -PC_WIDESTYLED = 64 -PC_INTERIORS = 128 -CP_NONE = 0 -CP_RECTANGLE = 1 -CP_REGION = 2 -TC_OP_CHARACTER = 1 -TC_OP_STROKE = 2 -TC_CP_STROKE = 4 -TC_CR_90 = 8 -TC_CR_ANY = 16 -TC_SF_X_YINDEP = 32 -TC_SA_DOUBLE = 64 -TC_SA_INTEGER = 128 -TC_SA_CONTIN = 256 -TC_EA_DOUBLE = 512 -TC_IA_ABLE = 1024 -TC_UA_ABLE = 2048 -TC_SO_ABLE = 4096 -TC_RA_ABLE = 8192 -TC_VA_ABLE = 16384 -TC_RESERVED = 32768 -TC_SCROLLBLT = 65536 -RC_BITBLT = 1 -RC_BANDING = 2 -RC_SCALING = 4 -RC_BITMAP64 = 8 -RC_GDI20_OUTPUT = 16 -RC_GDI20_STATE = 32 -RC_SAVEBITMAP = 64 -RC_DI_BITMAP = 128 -RC_PALETTE = 256 -RC_DIBTODEV = 512 -RC_BIGFONT = 1024 -RC_STRETCHBLT = 2048 -RC_FLOODFILL = 4096 -RC_STRETCHDIB = 8192 -RC_OP_DX_OUTPUT = 16384 -RC_DEVBITS = 32768 -DIB_RGB_COLORS = 0 -DIB_PAL_COLORS = 1 -DIB_PAL_INDICES = 2 -DIB_PAL_PHYSINDICES = 2 -DIB_PAL_LOGINDICES = 4 -SYSPAL_ERROR = 0 -SYSPAL_STATIC = 1 -SYSPAL_NOSTATIC = 2 -CBM_CREATEDIB = 2 -CBM_INIT = 4 -FLOODFILLBORDER = 0 -FLOODFILLSURFACE = 1 -CCHDEVICENAME = 32 -CCHFORMNAME = 32 -# Generated by h2py from \msvcnt\include\wingdi.h -# hacked and split manually by mhammond. - -# DEVMODE.dmFields -DM_SPECVERSION = 800 -DM_ORIENTATION = 1 -DM_PAPERSIZE = 2 -DM_PAPERLENGTH = 4 -DM_PAPERWIDTH = 8 -DM_SCALE = 16 -DM_POSITION = 32 -DM_NUP = 64 -DM_DISPLAYORIENTATION = 128 -DM_COPIES = 256 -DM_DEFAULTSOURCE = 512 -DM_PRINTQUALITY = 1024 -DM_COLOR = 2048 -DM_DUPLEX = 4096 -DM_YRESOLUTION = 8192 -DM_TTOPTION = 16384 -DM_COLLATE = 32768 -DM_FORMNAME = 65536 -DM_LOGPIXELS = 131072 -DM_BITSPERPEL = 262144 -DM_PELSWIDTH = 524288 -DM_PELSHEIGHT = 1048576 -DM_DISPLAYFLAGS = 2097152 -DM_DISPLAYFREQUENCY = 4194304 -DM_ICMMETHOD = 8388608 -DM_ICMINTENT = 16777216 -DM_MEDIATYPE = 33554432 -DM_DITHERTYPE = 67108864 -DM_PANNINGWIDTH = 134217728 -DM_PANNINGHEIGHT = 268435456 -DM_DISPLAYFIXEDOUTPUT = 536870912 - -# DEVMODE.dmOrientation -DMORIENT_PORTRAIT = 1 -DMORIENT_LANDSCAPE = 2 - -# DEVMODE.dmDisplayOrientation -DMDO_DEFAULT = 0 -DMDO_90 = 1 -DMDO_180 = 2 -DMDO_270 = 3 - -# DEVMODE.dmDisplayFixedOutput -DMDFO_DEFAULT = 0 -DMDFO_STRETCH = 1 -DMDFO_CENTER = 2 - -# DEVMODE.dmPaperSize -DMPAPER_LETTER = 1 -DMPAPER_LETTERSMALL = 2 -DMPAPER_TABLOID = 3 -DMPAPER_LEDGER = 4 -DMPAPER_LEGAL = 5 -DMPAPER_STATEMENT = 6 -DMPAPER_EXECUTIVE = 7 -DMPAPER_A3 = 8 -DMPAPER_A4 = 9 -DMPAPER_A4SMALL = 10 -DMPAPER_A5 = 11 -DMPAPER_B4 = 12 -DMPAPER_B5 = 13 -DMPAPER_FOLIO = 14 -DMPAPER_QUARTO = 15 -DMPAPER_10X14 = 16 -DMPAPER_11X17 = 17 -DMPAPER_NOTE = 18 -DMPAPER_ENV_9 = 19 -DMPAPER_ENV_10 = 20 -DMPAPER_ENV_11 = 21 -DMPAPER_ENV_12 = 22 -DMPAPER_ENV_14 = 23 -DMPAPER_CSHEET = 24 -DMPAPER_DSHEET = 25 -DMPAPER_ESHEET = 26 -DMPAPER_ENV_DL = 27 -DMPAPER_ENV_C5 = 28 -DMPAPER_ENV_C3 = 29 -DMPAPER_ENV_C4 = 30 -DMPAPER_ENV_C6 = 31 -DMPAPER_ENV_C65 = 32 -DMPAPER_ENV_B4 = 33 -DMPAPER_ENV_B5 = 34 -DMPAPER_ENV_B6 = 35 -DMPAPER_ENV_ITALY = 36 -DMPAPER_ENV_MONARCH = 37 -DMPAPER_ENV_PERSONAL = 38 -DMPAPER_FANFOLD_US = 39 -DMPAPER_FANFOLD_STD_GERMAN = 40 -DMPAPER_FANFOLD_LGL_GERMAN = 41 -DMPAPER_ISO_B4 = 42 -DMPAPER_JAPANESE_POSTCARD = 43 -DMPAPER_9X11 = 44 -DMPAPER_10X11 = 45 -DMPAPER_15X11 = 46 -DMPAPER_ENV_INVITE = 47 -DMPAPER_RESERVED_48 = 48 -DMPAPER_RESERVED_49 = 49 -DMPAPER_LETTER_EXTRA = 50 -DMPAPER_LEGAL_EXTRA = 51 -DMPAPER_TABLOID_EXTRA = 52 -DMPAPER_A4_EXTRA = 53 -DMPAPER_LETTER_TRANSVERSE = 54 -DMPAPER_A4_TRANSVERSE = 55 -DMPAPER_LETTER_EXTRA_TRANSVERSE = 56 -DMPAPER_A_PLUS = 57 -DMPAPER_B_PLUS = 58 -DMPAPER_LETTER_PLUS = 59 -DMPAPER_A4_PLUS = 60 -DMPAPER_A5_TRANSVERSE = 61 -DMPAPER_B5_TRANSVERSE = 62 -DMPAPER_A3_EXTRA = 63 -DMPAPER_A5_EXTRA = 64 -DMPAPER_B5_EXTRA = 65 -DMPAPER_A2 = 66 -DMPAPER_A3_TRANSVERSE = 67 -DMPAPER_A3_EXTRA_TRANSVERSE = 68 -DMPAPER_DBL_JAPANESE_POSTCARD = 69 -DMPAPER_A6 = 70 -DMPAPER_JENV_KAKU2 = 71 -DMPAPER_JENV_KAKU3 = 72 -DMPAPER_JENV_CHOU3 = 73 -DMPAPER_JENV_CHOU4 = 74 -DMPAPER_LETTER_ROTATED = 75 -DMPAPER_A3_ROTATED = 76 -DMPAPER_A4_ROTATED = 77 -DMPAPER_A5_ROTATED = 78 -DMPAPER_B4_JIS_ROTATED = 79 -DMPAPER_B5_JIS_ROTATED = 80 -DMPAPER_JAPANESE_POSTCARD_ROTATED = 81 -DMPAPER_DBL_JAPANESE_POSTCARD_ROTATED = 82 -DMPAPER_A6_ROTATED = 83 -DMPAPER_JENV_KAKU2_ROTATED = 84 -DMPAPER_JENV_KAKU3_ROTATED = 85 -DMPAPER_JENV_CHOU3_ROTATED = 86 -DMPAPER_JENV_CHOU4_ROTATED = 87 -DMPAPER_B6_JIS = 88 -DMPAPER_B6_JIS_ROTATED = 89 -DMPAPER_12X11 = 90 -DMPAPER_JENV_YOU4 = 91 -DMPAPER_JENV_YOU4_ROTATED = 92 -DMPAPER_P16K = 93 -DMPAPER_P32K = 94 -DMPAPER_P32KBIG = 95 -DMPAPER_PENV_1 = 96 -DMPAPER_PENV_2 = 97 -DMPAPER_PENV_3 = 98 -DMPAPER_PENV_4 = 99 -DMPAPER_PENV_5 = 100 -DMPAPER_PENV_6 = 101 -DMPAPER_PENV_7 = 102 -DMPAPER_PENV_8 = 103 -DMPAPER_PENV_9 = 104 -DMPAPER_PENV_10 = 105 -DMPAPER_P16K_ROTATED = 106 -DMPAPER_P32K_ROTATED = 107 -DMPAPER_P32KBIG_ROTATED = 108 -DMPAPER_PENV_1_ROTATED = 109 -DMPAPER_PENV_2_ROTATED = 110 -DMPAPER_PENV_3_ROTATED = 111 -DMPAPER_PENV_4_ROTATED = 112 -DMPAPER_PENV_5_ROTATED = 113 -DMPAPER_PENV_6_ROTATED = 114 -DMPAPER_PENV_7_ROTATED = 115 -DMPAPER_PENV_8_ROTATED = 116 -DMPAPER_PENV_9_ROTATED = 117 -DMPAPER_PENV_10_ROTATED = 118 -DMPAPER_LAST = DMPAPER_PENV_10_ROTATED -DMPAPER_USER = 256 - -# DEVMODE.dmDefaultSource -DMBIN_UPPER = 1 -DMBIN_ONLYONE = 1 -DMBIN_LOWER = 2 -DMBIN_MIDDLE = 3 -DMBIN_MANUAL = 4 -DMBIN_ENVELOPE = 5 -DMBIN_ENVMANUAL = 6 -DMBIN_AUTO = 7 -DMBIN_TRACTOR = 8 -DMBIN_SMALLFMT = 9 -DMBIN_LARGEFMT = 10 -DMBIN_LARGECAPACITY = 11 -DMBIN_CASSETTE = 14 -DMBIN_FORMSOURCE = 15 -DMBIN_LAST = DMBIN_FORMSOURCE -DMBIN_USER = 256 - -# DEVMODE.dmPrintQuality -DMRES_DRAFT = (-1) -DMRES_LOW = (-2) -DMRES_MEDIUM = (-3) -DMRES_HIGH = (-4) - -# DEVMODE.dmColor -DMCOLOR_MONOCHROME = 1 -DMCOLOR_COLOR = 2 - -# DEVMODE.dmDuplex -DMDUP_SIMPLEX = 1 -DMDUP_VERTICAL = 2 -DMDUP_HORIZONTAL = 3 - -# DEVMODE.dmTTOption -DMTT_BITMAP = 1 -DMTT_DOWNLOAD = 2 -DMTT_SUBDEV = 3 -DMTT_DOWNLOAD_OUTLINE = 4 - -# DEVMODE.dmCollate -DMCOLLATE_FALSE = 0 -DMCOLLATE_TRUE = 1 - -# DEVMODE.dmDisplayFlags -DM_GRAYSCALE = 1 -DM_INTERLACED = 2 - -# DEVMODE.dmICMMethod -DMICMMETHOD_NONE = 1 -DMICMMETHOD_SYSTEM = 2 -DMICMMETHOD_DRIVER = 3 -DMICMMETHOD_DEVICE = 4 -DMICMMETHOD_USER = 256 - -# DEVMODE.dmICMIntent -DMICM_SATURATE = 1 -DMICM_CONTRAST = 2 -DMICM_COLORIMETRIC = 3 -DMICM_ABS_COLORIMETRIC = 4 -DMICM_USER = 256 - -# DEVMODE.dmMediaType -DMMEDIA_STANDARD = 1 -DMMEDIA_TRANSPARENCY = 2 -DMMEDIA_GLOSSY = 3 -DMMEDIA_USER = 256 - -# DEVMODE.dmDitherType -DMDITHER_NONE = 1 -DMDITHER_COARSE = 2 -DMDITHER_FINE = 3 -DMDITHER_LINEART = 4 -DMDITHER_ERRORDIFFUSION = 5 -DMDITHER_RESERVED6 = 6 -DMDITHER_RESERVED7 = 7 -DMDITHER_RESERVED8 = 8 -DMDITHER_RESERVED9 = 9 -DMDITHER_GRAYSCALE = 10 -DMDITHER_USER = 256 - -# DEVMODE.dmNup -DMNUP_SYSTEM = 1 -DMNUP_ONEUP = 2 - -# used with ExtEscape -FEATURESETTING_NUP = 0 -FEATURESETTING_OUTPUT = 1 -FEATURESETTING_PSLEVEL = 2 -FEATURESETTING_CUSTPAPER = 3 -FEATURESETTING_MIRROR = 4 -FEATURESETTING_NEGATIVE = 5 -FEATURESETTING_PROTOCOL = 6 -FEATURESETTING_PRIVATE_BEGIN = 0x1000 -FEATURESETTING_PRIVATE_END = 0x1FFF - -RDH_RECTANGLES = 1 -GGO_METRICS = 0 -GGO_BITMAP = 1 -GGO_NATIVE = 2 -TT_POLYGON_TYPE = 24 -TT_PRIM_LINE = 1 -TT_PRIM_QSPLINE = 2 -TT_AVAILABLE = 1 -TT_ENABLED = 2 -DM_UPDATE = 1 -DM_COPY = 2 -DM_PROMPT = 4 -DM_MODIFY = 8 -DM_IN_BUFFER = DM_MODIFY -DM_IN_PROMPT = DM_PROMPT -DM_OUT_BUFFER = DM_COPY -DM_OUT_DEFAULT = DM_UPDATE - -# DISPLAY_DEVICE.StateFlags -DISPLAY_DEVICE_ATTACHED_TO_DESKTOP = 1 -DISPLAY_DEVICE_MULTI_DRIVER = 2 -DISPLAY_DEVICE_PRIMARY_DEVICE = 4 -DISPLAY_DEVICE_MIRRORING_DRIVER = 8 -DISPLAY_DEVICE_VGA_COMPATIBLE = 16 -DISPLAY_DEVICE_REMOVABLE = 32 -DISPLAY_DEVICE_MODESPRUNED = 134217728 -DISPLAY_DEVICE_REMOTE = 67108864 -DISPLAY_DEVICE_DISCONNECT = 33554432 - -# DeviceCapabilities types -DC_FIELDS = 1 -DC_PAPERS = 2 -DC_PAPERSIZE = 3 -DC_MINEXTENT = 4 -DC_MAXEXTENT = 5 -DC_BINS = 6 -DC_DUPLEX = 7 -DC_SIZE = 8 -DC_EXTRA = 9 -DC_VERSION = 10 -DC_DRIVER = 11 -DC_BINNAMES = 12 -DC_ENUMRESOLUTIONS = 13 -DC_FILEDEPENDENCIES = 14 -DC_TRUETYPE = 15 -DC_PAPERNAMES = 16 -DC_ORIENTATION = 17 -DC_COPIES = 18 -DC_BINADJUST = 19 -DC_EMF_COMPLIANT = 20 -DC_DATATYPE_PRODUCED = 21 -DC_COLLATE = 22 -DC_MANUFACTURER = 23 -DC_MODEL = 24 -DC_PERSONALITY = 25 -DC_PRINTRATE = 26 -DC_PRINTRATEUNIT = 27 -DC_PRINTERMEM = 28 -DC_MEDIAREADY = 29 -DC_STAPLE = 30 -DC_PRINTRATEPPM = 31 -DC_COLORDEVICE = 32 -DC_NUP = 33 -DC_MEDIATYPENAMES = 34 -DC_MEDIATYPES = 35 - -PRINTRATEUNIT_PPM = 1 -PRINTRATEUNIT_CPS = 2 -PRINTRATEUNIT_LPM = 3 -PRINTRATEUNIT_IPM = 4 - -# TrueType constants -DCTT_BITMAP = 1 -DCTT_DOWNLOAD = 2 -DCTT_SUBDEV = 4 -DCTT_DOWNLOAD_OUTLINE = 8 - -DCBA_FACEUPNONE = 0 -DCBA_FACEUPCENTER = 1 -DCBA_FACEUPLEFT = 2 -DCBA_FACEUPRIGHT = 3 -DCBA_FACEDOWNNONE = 256 -DCBA_FACEDOWNCENTER = 257 -DCBA_FACEDOWNLEFT = 258 -DCBA_FACEDOWNRIGHT = 259 - -CA_NEGATIVE = 1 -CA_LOG_FILTER = 2 -ILLUMINANT_DEVICE_DEFAULT = 0 -ILLUMINANT_A = 1 -ILLUMINANT_B = 2 -ILLUMINANT_C = 3 -ILLUMINANT_D50 = 4 -ILLUMINANT_D55 = 5 -ILLUMINANT_D65 = 6 -ILLUMINANT_D75 = 7 -ILLUMINANT_F2 = 8 -ILLUMINANT_MAX_INDEX = ILLUMINANT_F2 -ILLUMINANT_TUNGSTEN = ILLUMINANT_A -ILLUMINANT_DAYLIGHT = ILLUMINANT_C -ILLUMINANT_FLUORESCENT = ILLUMINANT_F2 -ILLUMINANT_NTSC = ILLUMINANT_C - -# Generated by h2py from \msvcnt\include\wingdi.h -# hacked and split manually by mhammond. -FONTMAPPER_MAX = 10 -ENHMETA_SIGNATURE = 1179469088 -ENHMETA_STOCK_OBJECT = -2147483648 -EMR_HEADER = 1 -EMR_POLYBEZIER = 2 -EMR_POLYGON = 3 -EMR_POLYLINE = 4 -EMR_POLYBEZIERTO = 5 -EMR_POLYLINETO = 6 -EMR_POLYPOLYLINE = 7 -EMR_POLYPOLYGON = 8 -EMR_SETWINDOWEXTEX = 9 -EMR_SETWINDOWORGEX = 10 -EMR_SETVIEWPORTEXTEX = 11 -EMR_SETVIEWPORTORGEX = 12 -EMR_SETBRUSHORGEX = 13 -EMR_EOF = 14 -EMR_SETPIXELV = 15 -EMR_SETMAPPERFLAGS = 16 -EMR_SETMAPMODE = 17 -EMR_SETBKMODE = 18 -EMR_SETPOLYFILLMODE = 19 -EMR_SETROP2 = 20 -EMR_SETSTRETCHBLTMODE = 21 -EMR_SETTEXTALIGN = 22 -EMR_SETCOLORADJUSTMENT = 23 -EMR_SETTEXTCOLOR = 24 -EMR_SETBKCOLOR = 25 -EMR_OFFSETCLIPRGN = 26 -EMR_MOVETOEX = 27 -EMR_SETMETARGN = 28 -EMR_EXCLUDECLIPRECT = 29 -EMR_INTERSECTCLIPRECT = 30 -EMR_SCALEVIEWPORTEXTEX = 31 -EMR_SCALEWINDOWEXTEX = 32 -EMR_SAVEDC = 33 -EMR_RESTOREDC = 34 -EMR_SETWORLDTRANSFORM = 35 -EMR_MODIFYWORLDTRANSFORM = 36 -EMR_SELECTOBJECT = 37 -EMR_CREATEPEN = 38 -EMR_CREATEBRUSHINDIRECT = 39 -EMR_DELETEOBJECT = 40 -EMR_ANGLEARC = 41 -EMR_ELLIPSE = 42 -EMR_RECTANGLE = 43 -EMR_ROUNDRECT = 44 -EMR_ARC = 45 -EMR_CHORD = 46 -EMR_PIE = 47 -EMR_SELECTPALETTE = 48 -EMR_CREATEPALETTE = 49 -EMR_SETPALETTEENTRIES = 50 -EMR_RESIZEPALETTE = 51 -EMR_REALIZEPALETTE = 52 -EMR_EXTFLOODFILL = 53 -EMR_LINETO = 54 -EMR_ARCTO = 55 -EMR_POLYDRAW = 56 -EMR_SETARCDIRECTION = 57 -EMR_SETMITERLIMIT = 58 -EMR_BEGINPATH = 59 -EMR_ENDPATH = 60 -EMR_CLOSEFIGURE = 61 -EMR_FILLPATH = 62 -EMR_STROKEANDFILLPATH = 63 -EMR_STROKEPATH = 64 -EMR_FLATTENPATH = 65 -EMR_WIDENPATH = 66 -EMR_SELECTCLIPPATH = 67 -EMR_ABORTPATH = 68 -EMR_GDICOMMENT = 70 -EMR_FILLRGN = 71 -EMR_FRAMERGN = 72 -EMR_INVERTRGN = 73 -EMR_PAINTRGN = 74 -EMR_EXTSELECTCLIPRGN = 75 -EMR_BITBLT = 76 -EMR_STRETCHBLT = 77 -EMR_MASKBLT = 78 -EMR_PLGBLT = 79 -EMR_SETDIBITSTODEVICE = 80 -EMR_STRETCHDIBITS = 81 -EMR_EXTCREATEFONTINDIRECTW = 82 -EMR_EXTTEXTOUTA = 83 -EMR_EXTTEXTOUTW = 84 -EMR_POLYBEZIER16 = 85 -EMR_POLYGON16 = 86 -EMR_POLYLINE16 = 87 -EMR_POLYBEZIERTO16 = 88 -EMR_POLYLINETO16 = 89 -EMR_POLYPOLYLINE16 = 90 -EMR_POLYPOLYGON16 = 91 -EMR_POLYDRAW16 = 92 -EMR_CREATEMONOBRUSH = 93 -EMR_CREATEDIBPATTERNBRUSHPT = 94 -EMR_EXTCREATEPEN = 95 -EMR_POLYTEXTOUTA = 96 -EMR_POLYTEXTOUTW = 97 -EMR_MIN = 1 -EMR_MAX = 97 -# Generated by h2py from \msvcnt\include\wingdi.h -# hacked and split manually by mhammond. -PANOSE_COUNT = 10 -PAN_FAMILYTYPE_INDEX = 0 -PAN_SERIFSTYLE_INDEX = 1 -PAN_WEIGHT_INDEX = 2 -PAN_PROPORTION_INDEX = 3 -PAN_CONTRAST_INDEX = 4 -PAN_STROKEVARIATION_INDEX = 5 -PAN_ARMSTYLE_INDEX = 6 -PAN_LETTERFORM_INDEX = 7 -PAN_MIDLINE_INDEX = 8 -PAN_XHEIGHT_INDEX = 9 -PAN_CULTURE_LATIN = 0 -PAN_ANY = 0 -PAN_NO_FIT = 1 -PAN_FAMILY_TEXT_DISPLAY = 2 -PAN_FAMILY_SCRIPT = 3 -PAN_FAMILY_DECORATIVE = 4 -PAN_FAMILY_PICTORIAL = 5 -PAN_SERIF_COVE = 2 -PAN_SERIF_OBTUSE_COVE = 3 -PAN_SERIF_SQUARE_COVE = 4 -PAN_SERIF_OBTUSE_SQUARE_COVE = 5 -PAN_SERIF_SQUARE = 6 -PAN_SERIF_THIN = 7 -PAN_SERIF_BONE = 8 -PAN_SERIF_EXAGGERATED = 9 -PAN_SERIF_TRIANGLE = 10 -PAN_SERIF_NORMAL_SANS = 11 -PAN_SERIF_OBTUSE_SANS = 12 -PAN_SERIF_PERP_SANS = 13 -PAN_SERIF_FLARED = 14 -PAN_SERIF_ROUNDED = 15 -PAN_WEIGHT_VERY_LIGHT = 2 -PAN_WEIGHT_LIGHT = 3 -PAN_WEIGHT_THIN = 4 -PAN_WEIGHT_BOOK = 5 -PAN_WEIGHT_MEDIUM = 6 -PAN_WEIGHT_DEMI = 7 -PAN_WEIGHT_BOLD = 8 -PAN_WEIGHT_HEAVY = 9 -PAN_WEIGHT_BLACK = 10 -PAN_WEIGHT_NORD = 11 -PAN_PROP_OLD_STYLE = 2 -PAN_PROP_MODERN = 3 -PAN_PROP_EVEN_WIDTH = 4 -PAN_PROP_EXPANDED = 5 -PAN_PROP_CONDENSED = 6 -PAN_PROP_VERY_EXPANDED = 7 -PAN_PROP_VERY_CONDENSED = 8 -PAN_PROP_MONOSPACED = 9 -PAN_CONTRAST_NONE = 2 -PAN_CONTRAST_VERY_LOW = 3 -PAN_CONTRAST_LOW = 4 -PAN_CONTRAST_MEDIUM_LOW = 5 -PAN_CONTRAST_MEDIUM = 6 -PAN_CONTRAST_MEDIUM_HIGH = 7 -PAN_CONTRAST_HIGH = 8 -PAN_CONTRAST_VERY_HIGH = 9 -PAN_STROKE_GRADUAL_DIAG = 2 -PAN_STROKE_GRADUAL_TRAN = 3 -PAN_STROKE_GRADUAL_VERT = 4 -PAN_STROKE_GRADUAL_HORZ = 5 -PAN_STROKE_RAPID_VERT = 6 -PAN_STROKE_RAPID_HORZ = 7 -PAN_STROKE_INSTANT_VERT = 8 -PAN_STRAIGHT_ARMS_HORZ = 2 -PAN_STRAIGHT_ARMS_WEDGE = 3 -PAN_STRAIGHT_ARMS_VERT = 4 -PAN_STRAIGHT_ARMS_SINGLE_SERIF = 5 -PAN_STRAIGHT_ARMS_DOUBLE_SERIF = 6 -PAN_BENT_ARMS_HORZ = 7 -PAN_BENT_ARMS_WEDGE = 8 -PAN_BENT_ARMS_VERT = 9 -PAN_BENT_ARMS_SINGLE_SERIF = 10 -PAN_BENT_ARMS_DOUBLE_SERIF = 11 -PAN_LETT_NORMAL_CONTACT = 2 -PAN_LETT_NORMAL_WEIGHTED = 3 -PAN_LETT_NORMAL_BOXED = 4 -PAN_LETT_NORMAL_FLATTENED = 5 -PAN_LETT_NORMAL_ROUNDED = 6 -PAN_LETT_NORMAL_OFF_CENTER = 7 -PAN_LETT_NORMAL_SQUARE = 8 -PAN_LETT_OBLIQUE_CONTACT = 9 -PAN_LETT_OBLIQUE_WEIGHTED = 10 -PAN_LETT_OBLIQUE_BOXED = 11 -PAN_LETT_OBLIQUE_FLATTENED = 12 -PAN_LETT_OBLIQUE_ROUNDED = 13 -PAN_LETT_OBLIQUE_OFF_CENTER = 14 -PAN_LETT_OBLIQUE_SQUARE = 15 -PAN_MIDLINE_STANDARD_TRIMMED = 2 -PAN_MIDLINE_STANDARD_POINTED = 3 -PAN_MIDLINE_STANDARD_SERIFED = 4 -PAN_MIDLINE_HIGH_TRIMMED = 5 -PAN_MIDLINE_HIGH_POINTED = 6 -PAN_MIDLINE_HIGH_SERIFED = 7 -PAN_MIDLINE_CONSTANT_TRIMMED = 8 -PAN_MIDLINE_CONSTANT_POINTED = 9 -PAN_MIDLINE_CONSTANT_SERIFED = 10 -PAN_MIDLINE_LOW_TRIMMED = 11 -PAN_MIDLINE_LOW_POINTED = 12 -PAN_MIDLINE_LOW_SERIFED = 13 -PAN_XHEIGHT_CONSTANT_SMALL = 2 -PAN_XHEIGHT_CONSTANT_STD = 3 -PAN_XHEIGHT_CONSTANT_LARGE = 4 -PAN_XHEIGHT_DUCKING_SMALL = 5 -PAN_XHEIGHT_DUCKING_STD = 6 -PAN_XHEIGHT_DUCKING_LARGE = 7 -ELF_VENDOR_SIZE = 4 -ELF_VERSION = 0 -ELF_CULTURE_LATIN = 0 -RASTER_FONTTYPE = 1 -DEVICE_FONTTYPE = 2 -TRUETYPE_FONTTYPE = 4 -def PALETTEINDEX(i): return ((16777216 | (i))) - -PC_RESERVED = 1 -PC_EXPLICIT = 2 -PC_NOCOLLAPSE = 4 -def GetRValue(rgb): return rgb & 0xff - -def GetGValue(rgb): return (rgb >> 8) & 0xff - -def GetBValue(rgb): return (rgb >> 16) & 0xff - -TRANSPARENT = 1 -OPAQUE = 2 -BKMODE_LAST = 2 -GM_COMPATIBLE = 1 -GM_ADVANCED = 2 -GM_LAST = 2 -PT_CLOSEFIGURE = 1 -PT_LINETO = 2 -PT_BEZIERTO = 4 -PT_MOVETO = 6 -MM_TEXT = 1 -MM_LOMETRIC = 2 -MM_HIMETRIC = 3 -MM_LOENGLISH = 4 -MM_HIENGLISH = 5 -MM_TWIPS = 6 -MM_ISOTROPIC = 7 -MM_ANISOTROPIC = 8 -MM_MIN = MM_TEXT -MM_MAX = MM_ANISOTROPIC -MM_MAX_FIXEDSCALE = MM_TWIPS -ABSOLUTE = 1 -RELATIVE = 2 -WHITE_BRUSH = 0 -LTGRAY_BRUSH = 1 -GRAY_BRUSH = 2 -DKGRAY_BRUSH = 3 -BLACK_BRUSH = 4 -NULL_BRUSH = 5 -HOLLOW_BRUSH = NULL_BRUSH -WHITE_PEN = 6 -BLACK_PEN = 7 -NULL_PEN = 8 -OEM_FIXED_FONT = 10 -ANSI_FIXED_FONT = 11 -ANSI_VAR_FONT = 12 -SYSTEM_FONT = 13 -DEVICE_DEFAULT_FONT = 14 -DEFAULT_PALETTE = 15 -SYSTEM_FIXED_FONT = 16 -STOCK_LAST = 16 -CLR_INVALID = -1 - -DC_BRUSH = 18 -DC_PEN = 19 - -# Exception/Status codes from winuser.h and winnt.h -STATUS_WAIT_0 = 0 -STATUS_ABANDONED_WAIT_0 = 128 -STATUS_USER_APC = 192 -STATUS_TIMEOUT = 258 -STATUS_PENDING = 259 -STATUS_SEGMENT_NOTIFICATION = 1073741829 -STATUS_GUARD_PAGE_VIOLATION = -2147483647 -STATUS_DATATYPE_MISALIGNMENT = -2147483646 -STATUS_BREAKPOINT = -2147483645 -STATUS_SINGLE_STEP = -2147483644 -STATUS_ACCESS_VIOLATION = -1073741819 -STATUS_IN_PAGE_ERROR = -1073741818 -STATUS_INVALID_HANDLE = -1073741816 -STATUS_NO_MEMORY = -1073741801 -STATUS_ILLEGAL_INSTRUCTION = -1073741795 -STATUS_NONCONTINUABLE_EXCEPTION = -1073741787 -STATUS_INVALID_DISPOSITION = -1073741786 -STATUS_ARRAY_BOUNDS_EXCEEDED = -1073741684 -STATUS_FLOAT_DENORMAL_OPERAND = -1073741683 -STATUS_FLOAT_DIVIDE_BY_ZERO = -1073741682 -STATUS_FLOAT_INEXACT_RESULT = -1073741681 -STATUS_FLOAT_INVALID_OPERATION = -1073741680 -STATUS_FLOAT_OVERFLOW = -1073741679 -STATUS_FLOAT_STACK_CHECK = -1073741678 -STATUS_FLOAT_UNDERFLOW = -1073741677 -STATUS_INTEGER_DIVIDE_BY_ZERO = -1073741676 -STATUS_INTEGER_OVERFLOW = -1073741675 -STATUS_PRIVILEGED_INSTRUCTION = -1073741674 -STATUS_STACK_OVERFLOW = -1073741571 -STATUS_CONTROL_C_EXIT = -1073741510 - - -WAIT_FAILED = -1 -WAIT_OBJECT_0 = STATUS_WAIT_0 + 0 - -WAIT_ABANDONED = STATUS_ABANDONED_WAIT_0 + 0 -WAIT_ABANDONED_0 = STATUS_ABANDONED_WAIT_0 + 0 - -WAIT_TIMEOUT = STATUS_TIMEOUT -WAIT_IO_COMPLETION = STATUS_USER_APC -STILL_ACTIVE = STATUS_PENDING -EXCEPTION_ACCESS_VIOLATION = STATUS_ACCESS_VIOLATION -EXCEPTION_DATATYPE_MISALIGNMENT = STATUS_DATATYPE_MISALIGNMENT -EXCEPTION_BREAKPOINT = STATUS_BREAKPOINT -EXCEPTION_SINGLE_STEP = STATUS_SINGLE_STEP -EXCEPTION_ARRAY_BOUNDS_EXCEEDED = STATUS_ARRAY_BOUNDS_EXCEEDED -EXCEPTION_FLT_DENORMAL_OPERAND = STATUS_FLOAT_DENORMAL_OPERAND -EXCEPTION_FLT_DIVIDE_BY_ZERO = STATUS_FLOAT_DIVIDE_BY_ZERO -EXCEPTION_FLT_INEXACT_RESULT = STATUS_FLOAT_INEXACT_RESULT -EXCEPTION_FLT_INVALID_OPERATION = STATUS_FLOAT_INVALID_OPERATION -EXCEPTION_FLT_OVERFLOW = STATUS_FLOAT_OVERFLOW -EXCEPTION_FLT_STACK_CHECK = STATUS_FLOAT_STACK_CHECK -EXCEPTION_FLT_UNDERFLOW = STATUS_FLOAT_UNDERFLOW -EXCEPTION_INT_DIVIDE_BY_ZERO = STATUS_INTEGER_DIVIDE_BY_ZERO -EXCEPTION_INT_OVERFLOW = STATUS_INTEGER_OVERFLOW -EXCEPTION_PRIV_INSTRUCTION = STATUS_PRIVILEGED_INSTRUCTION -EXCEPTION_IN_PAGE_ERROR = STATUS_IN_PAGE_ERROR -EXCEPTION_ILLEGAL_INSTRUCTION = STATUS_ILLEGAL_INSTRUCTION -EXCEPTION_NONCONTINUABLE_EXCEPTION = STATUS_NONCONTINUABLE_EXCEPTION -EXCEPTION_STACK_OVERFLOW = STATUS_STACK_OVERFLOW -EXCEPTION_INVALID_DISPOSITION = STATUS_INVALID_DISPOSITION -EXCEPTION_GUARD_PAGE = STATUS_GUARD_PAGE_VIOLATION -EXCEPTION_INVALID_HANDLE = STATUS_INVALID_HANDLE -CONTROL_C_EXIT = STATUS_CONTROL_C_EXIT - -# winuser.h line 8594 -# constants used with SystemParametersInfo -SPI_GETBEEP = 1 -SPI_SETBEEP = 2 -SPI_GETMOUSE = 3 -SPI_SETMOUSE = 4 -SPI_GETBORDER = 5 -SPI_SETBORDER = 6 -SPI_GETKEYBOARDSPEED = 10 -SPI_SETKEYBOARDSPEED = 11 -SPI_LANGDRIVER = 12 -SPI_ICONHORIZONTALSPACING = 13 -SPI_GETSCREENSAVETIMEOUT = 14 -SPI_SETSCREENSAVETIMEOUT = 15 -SPI_GETSCREENSAVEACTIVE = 16 -SPI_SETSCREENSAVEACTIVE = 17 -SPI_GETGRIDGRANULARITY = 18 -SPI_SETGRIDGRANULARITY = 19 -SPI_SETDESKWALLPAPER = 20 -SPI_SETDESKPATTERN = 21 -SPI_GETKEYBOARDDELAY = 22 -SPI_SETKEYBOARDDELAY = 23 -SPI_ICONVERTICALSPACING = 24 -SPI_GETICONTITLEWRAP = 25 -SPI_SETICONTITLEWRAP = 26 -SPI_GETMENUDROPALIGNMENT = 27 -SPI_SETMENUDROPALIGNMENT = 28 -SPI_SETDOUBLECLKWIDTH = 29 -SPI_SETDOUBLECLKHEIGHT = 30 -SPI_GETICONTITLELOGFONT = 31 -SPI_SETDOUBLECLICKTIME = 32 -SPI_SETMOUSEBUTTONSWAP = 33 -SPI_SETICONTITLELOGFONT = 34 -SPI_GETFASTTASKSWITCH = 35 -SPI_SETFASTTASKSWITCH = 36 -SPI_SETDRAGFULLWINDOWS = 37 -SPI_GETDRAGFULLWINDOWS = 38 -SPI_GETNONCLIENTMETRICS = 41 -SPI_SETNONCLIENTMETRICS = 42 -SPI_GETMINIMIZEDMETRICS = 43 -SPI_SETMINIMIZEDMETRICS = 44 -SPI_GETICONMETRICS = 45 -SPI_SETICONMETRICS = 46 -SPI_SETWORKAREA = 47 -SPI_GETWORKAREA = 48 -SPI_SETPENWINDOWS = 49 -SPI_GETFILTERKEYS = 50 -SPI_SETFILTERKEYS = 51 -SPI_GETTOGGLEKEYS = 52 -SPI_SETTOGGLEKEYS = 53 -SPI_GETMOUSEKEYS = 54 -SPI_SETMOUSEKEYS = 55 -SPI_GETSHOWSOUNDS = 56 -SPI_SETSHOWSOUNDS = 57 -SPI_GETSTICKYKEYS = 58 -SPI_SETSTICKYKEYS = 59 -SPI_GETACCESSTIMEOUT = 60 -SPI_SETACCESSTIMEOUT = 61 -SPI_GETSERIALKEYS = 62 -SPI_SETSERIALKEYS = 63 -SPI_GETSOUNDSENTRY = 64 -SPI_SETSOUNDSENTRY = 65 -SPI_GETHIGHCONTRAST = 66 -SPI_SETHIGHCONTRAST = 67 -SPI_GETKEYBOARDPREF = 68 -SPI_SETKEYBOARDPREF = 69 -SPI_GETSCREENREADER = 70 -SPI_SETSCREENREADER = 71 -SPI_GETANIMATION = 72 -SPI_SETANIMATION = 73 -SPI_GETFONTSMOOTHING = 74 -SPI_SETFONTSMOOTHING = 75 -SPI_SETDRAGWIDTH = 76 -SPI_SETDRAGHEIGHT = 77 -SPI_SETHANDHELD = 78 -SPI_GETLOWPOWERTIMEOUT = 79 -SPI_GETPOWEROFFTIMEOUT = 80 -SPI_SETLOWPOWERTIMEOUT = 81 -SPI_SETPOWEROFFTIMEOUT = 82 -SPI_GETLOWPOWERACTIVE = 83 -SPI_GETPOWEROFFACTIVE = 84 -SPI_SETLOWPOWERACTIVE = 85 -SPI_SETPOWEROFFACTIVE = 86 -SPI_SETCURSORS = 87 -SPI_SETICONS = 88 -SPI_GETDEFAULTINPUTLANG = 89 -SPI_SETDEFAULTINPUTLANG = 90 -SPI_SETLANGTOGGLE = 91 -SPI_GETWINDOWSEXTENSION = 92 -SPI_SETMOUSETRAILS = 93 -SPI_GETMOUSETRAILS = 94 -SPI_GETSNAPTODEFBUTTON = 95 -SPI_SETSNAPTODEFBUTTON = 96 -SPI_SETSCREENSAVERRUNNING = 97 -SPI_SCREENSAVERRUNNING = SPI_SETSCREENSAVERRUNNING -SPI_GETMOUSEHOVERWIDTH = 98 -SPI_SETMOUSEHOVERWIDTH = 99 -SPI_GETMOUSEHOVERHEIGHT = 100 -SPI_SETMOUSEHOVERHEIGHT = 101 -SPI_GETMOUSEHOVERTIME = 102 -SPI_SETMOUSEHOVERTIME = 103 -SPI_GETWHEELSCROLLLINES = 104 -SPI_SETWHEELSCROLLLINES = 105 -SPI_GETMENUSHOWDELAY = 106 -SPI_SETMENUSHOWDELAY = 107 - -SPI_GETSHOWIMEUI = 110 -SPI_SETSHOWIMEUI = 111 -SPI_GETMOUSESPEED = 112 -SPI_SETMOUSESPEED = 113 -SPI_GETSCREENSAVERRUNNING = 114 -SPI_GETDESKWALLPAPER = 115 - -SPI_GETACTIVEWINDOWTRACKING = 4096 -SPI_SETACTIVEWINDOWTRACKING = 4097 -SPI_GETMENUANIMATION = 4098 -SPI_SETMENUANIMATION = 4099 -SPI_GETCOMBOBOXANIMATION = 4100 -SPI_SETCOMBOBOXANIMATION = 4101 -SPI_GETLISTBOXSMOOTHSCROLLING = 4102 -SPI_SETLISTBOXSMOOTHSCROLLING = 4103 -SPI_GETGRADIENTCAPTIONS = 4104 -SPI_SETGRADIENTCAPTIONS = 4105 -SPI_GETKEYBOARDCUES = 4106 -SPI_SETKEYBOARDCUES = 4107 -SPI_GETMENUUNDERLINES = 4106 -SPI_SETMENUUNDERLINES = 4107 -SPI_GETACTIVEWNDTRKZORDER = 4108 -SPI_SETACTIVEWNDTRKZORDER = 4109 -SPI_GETHOTTRACKING = 4110 -SPI_SETHOTTRACKING = 4111 - -SPI_GETMENUFADE = 4114 -SPI_SETMENUFADE = 4115 -SPI_GETSELECTIONFADE = 4116 -SPI_SETSELECTIONFADE = 4117 -SPI_GETTOOLTIPANIMATION = 4118 -SPI_SETTOOLTIPANIMATION = 4119 -SPI_GETTOOLTIPFADE = 4120 -SPI_SETTOOLTIPFADE = 4121 -SPI_GETCURSORSHADOW = 4122 -SPI_SETCURSORSHADOW = 4123 -SPI_GETMOUSESONAR = 4124 -SPI_SETMOUSESONAR = 4125 -SPI_GETMOUSECLICKLOCK = 4126 -SPI_SETMOUSECLICKLOCK = 4127 -SPI_GETMOUSEVANISH = 4128 -SPI_SETMOUSEVANISH = 4129 -SPI_GETFLATMENU = 4130 -SPI_SETFLATMENU = 4131 -SPI_GETDROPSHADOW = 4132 -SPI_SETDROPSHADOW = 4133 -SPI_GETBLOCKSENDINPUTRESETS = 4134 -SPI_SETBLOCKSENDINPUTRESETS = 4135 -SPI_GETUIEFFECTS = 4158 -SPI_SETUIEFFECTS = 4159 - -SPI_GETFOREGROUNDLOCKTIMEOUT = 8192 -SPI_SETFOREGROUNDLOCKTIMEOUT = 8193 -SPI_GETACTIVEWNDTRKTIMEOUT = 8194 -SPI_SETACTIVEWNDTRKTIMEOUT = 8195 -SPI_GETFOREGROUNDFLASHCOUNT = 8196 -SPI_SETFOREGROUNDFLASHCOUNT = 8197 -SPI_GETCARETWIDTH = 8198 -SPI_SETCARETWIDTH = 8199 -SPI_GETMOUSECLICKLOCKTIME = 8200 -SPI_SETMOUSECLICKLOCKTIME = 8201 -SPI_GETFONTSMOOTHINGTYPE = 8202 -SPI_SETFONTSMOOTHINGTYPE = 8203 -SPI_GETFONTSMOOTHINGCONTRAST = 8204 -SPI_SETFONTSMOOTHINGCONTRAST = 8205 -SPI_GETFOCUSBORDERWIDTH = 8206 -SPI_SETFOCUSBORDERWIDTH = 8207 -SPI_GETFOCUSBORDERHEIGHT = 8208 -SPI_SETFOCUSBORDERHEIGHT = 8209 -SPI_GETFONTSMOOTHINGORIENTATION = 8210 -SPI_SETFONTSMOOTHINGORIENTATION = 8211 - -# fWinIni flags for SystemParametersInfo -SPIF_UPDATEINIFILE = 1 -SPIF_SENDWININICHANGE = 2 -SPIF_SENDCHANGE = SPIF_SENDWININICHANGE - -# used with SystemParametersInfo and SPI_GETFONTSMOOTHINGTYPE/SPI_SETFONTSMOOTHINGTYPE -FE_FONTSMOOTHINGSTANDARD = 1 -FE_FONTSMOOTHINGCLEARTYPE = 2 -FE_FONTSMOOTHINGDOCKING = 32768 - -METRICS_USEDEFAULT = -1 -ARW_BOTTOMLEFT = 0 -ARW_BOTTOMRIGHT = 1 -ARW_TOPLEFT = 2 -ARW_TOPRIGHT = 3 -ARW_STARTMASK = 3 -ARW_STARTRIGHT = 1 -ARW_STARTTOP = 2 -ARW_LEFT = 0 -ARW_RIGHT = 0 -ARW_UP = 4 -ARW_DOWN = 4 -ARW_HIDE = 8 -#ARW_VALID = 0x000F -SERKF_SERIALKEYSON = 1 -SERKF_AVAILABLE = 2 -SERKF_INDICATOR = 4 -HCF_HIGHCONTRASTON = 1 -HCF_AVAILABLE = 2 -HCF_HOTKEYACTIVE = 4 -HCF_CONFIRMHOTKEY = 8 -HCF_HOTKEYSOUND = 16 -HCF_INDICATOR = 32 -HCF_HOTKEYAVAILABLE = 64 -CDS_UPDATEREGISTRY = 1 -CDS_TEST = 2 -CDS_FULLSCREEN = 4 -CDS_GLOBAL = 8 -CDS_SET_PRIMARY = 16 -CDS_RESET = 1073741824 -CDS_SETRECT = 536870912 -CDS_NORESET = 268435456 - -# return values from ChangeDisplaySettings and ChangeDisplaySettingsEx -DISP_CHANGE_SUCCESSFUL = 0 -DISP_CHANGE_RESTART = 1 -DISP_CHANGE_FAILED = -1 -DISP_CHANGE_BADMODE = -2 -DISP_CHANGE_NOTUPDATED = -3 -DISP_CHANGE_BADFLAGS = -4 -DISP_CHANGE_BADPARAM = -5 -DISP_CHANGE_BADDUALVIEW = -6 - -ENUM_CURRENT_SETTINGS = -1 -ENUM_REGISTRY_SETTINGS = -2 -FKF_FILTERKEYSON = 1 -FKF_AVAILABLE = 2 -FKF_HOTKEYACTIVE = 4 -FKF_CONFIRMHOTKEY = 8 -FKF_HOTKEYSOUND = 16 -FKF_INDICATOR = 32 -FKF_CLICKON = 64 -SKF_STICKYKEYSON = 1 -SKF_AVAILABLE = 2 -SKF_HOTKEYACTIVE = 4 -SKF_CONFIRMHOTKEY = 8 -SKF_HOTKEYSOUND = 16 -SKF_INDICATOR = 32 -SKF_AUDIBLEFEEDBACK = 64 -SKF_TRISTATE = 128 -SKF_TWOKEYSOFF = 256 -SKF_LALTLATCHED = 268435456 -SKF_LCTLLATCHED = 67108864 -SKF_LSHIFTLATCHED = 16777216 -SKF_RALTLATCHED = 536870912 -SKF_RCTLLATCHED = 134217728 -SKF_RSHIFTLATCHED = 33554432 -SKF_LWINLATCHED = 1073741824 -SKF_RWINLATCHED = -2147483648 -SKF_LALTLOCKED = 1048576 -SKF_LCTLLOCKED = 262144 -SKF_LSHIFTLOCKED = 65536 -SKF_RALTLOCKED = 2097152 -SKF_RCTLLOCKED = 524288 -SKF_RSHIFTLOCKED = 131072 -SKF_LWINLOCKED = 4194304 -SKF_RWINLOCKED = 8388608 -MKF_MOUSEKEYSON = 1 -MKF_AVAILABLE = 2 -MKF_HOTKEYACTIVE = 4 -MKF_CONFIRMHOTKEY = 8 -MKF_HOTKEYSOUND = 16 -MKF_INDICATOR = 32 -MKF_MODIFIERS = 64 -MKF_REPLACENUMBERS = 128 -MKF_LEFTBUTTONSEL = 268435456 -MKF_RIGHTBUTTONSEL = 536870912 -MKF_LEFTBUTTONDOWN = 16777216 -MKF_RIGHTBUTTONDOWN = 33554432 -MKF_MOUSEMODE = -2147483648 -ATF_TIMEOUTON = 1 -ATF_ONOFFFEEDBACK = 2 -SSGF_NONE = 0 -SSGF_DISPLAY = 3 -SSTF_NONE = 0 -SSTF_CHARS = 1 -SSTF_BORDER = 2 -SSTF_DISPLAY = 3 -SSWF_NONE = 0 -SSWF_TITLE = 1 -SSWF_WINDOW = 2 -SSWF_DISPLAY = 3 -SSWF_CUSTOM = 4 -SSF_SOUNDSENTRYON = 1 -SSF_AVAILABLE = 2 -SSF_INDICATOR = 4 -TKF_TOGGLEKEYSON = 1 -TKF_AVAILABLE = 2 -TKF_HOTKEYACTIVE = 4 -TKF_CONFIRMHOTKEY = 8 -TKF_HOTKEYSOUND = 16 -TKF_INDICATOR = 32 -SLE_ERROR = 1 -SLE_MINORERROR = 2 -SLE_WARNING = 3 -MONITOR_DEFAULTTONULL = 0 -MONITOR_DEFAULTTOPRIMARY = 1 -MONITOR_DEFAULTTONEAREST = 2 -MONITORINFOF_PRIMARY = 1 -CCHDEVICENAME = 32 -CHILDID_SELF = 0 -INDEXID_OBJECT = 0 -INDEXID_CONTAINER = 0 -OBJID_WINDOW = 0 -OBJID_SYSMENU = -1 -OBJID_TITLEBAR = -2 -OBJID_MENU = -3 -OBJID_CLIENT = -4 -OBJID_VSCROLL = -5 -OBJID_HSCROLL = -6 -OBJID_SIZEGRIP = -7 -OBJID_CARET = -8 -OBJID_CURSOR = -9 -OBJID_ALERT = -10 -OBJID_SOUND = -11 -EVENT_MIN = 1 -EVENT_MAX = 2147483647 -EVENT_SYSTEM_SOUND = 1 -EVENT_SYSTEM_ALERT = 2 -EVENT_SYSTEM_FOREGROUND = 3 -EVENT_SYSTEM_MENUSTART = 4 -EVENT_SYSTEM_MENUEND = 5 -EVENT_SYSTEM_MENUPOPUPSTART = 6 -EVENT_SYSTEM_MENUPOPUPEND = 7 -EVENT_SYSTEM_CAPTURESTART = 8 -EVENT_SYSTEM_CAPTUREEND = 9 -EVENT_SYSTEM_MOVESIZESTART = 10 -EVENT_SYSTEM_MOVESIZEEND = 11 -EVENT_SYSTEM_CONTEXTHELPSTART = 12 -EVENT_SYSTEM_CONTEXTHELPEND = 13 -EVENT_SYSTEM_DRAGDROPSTART = 14 -EVENT_SYSTEM_DRAGDROPEND = 15 -EVENT_SYSTEM_DIALOGSTART = 16 -EVENT_SYSTEM_DIALOGEND = 17 -EVENT_SYSTEM_SCROLLINGSTART = 18 -EVENT_SYSTEM_SCROLLINGEND = 19 -EVENT_SYSTEM_SWITCHSTART = 20 -EVENT_SYSTEM_SWITCHEND = 21 -EVENT_SYSTEM_MINIMIZESTART = 22 -EVENT_SYSTEM_MINIMIZEEND = 23 -EVENT_OBJECT_CREATE = 32768 -EVENT_OBJECT_DESTROY = 32769 -EVENT_OBJECT_SHOW = 32770 -EVENT_OBJECT_HIDE = 32771 -EVENT_OBJECT_REORDER = 32772 -EVENT_OBJECT_FOCUS = 32773 -EVENT_OBJECT_SELECTION = 32774 -EVENT_OBJECT_SELECTIONADD = 32775 -EVENT_OBJECT_SELECTIONREMOVE = 32776 -EVENT_OBJECT_SELECTIONWITHIN = 32777 -EVENT_OBJECT_STATECHANGE = 32778 -EVENT_OBJECT_LOCATIONCHANGE = 32779 -EVENT_OBJECT_NAMECHANGE = 32780 -EVENT_OBJECT_DESCRIPTIONCHANGE = 32781 -EVENT_OBJECT_VALUECHANGE = 32782 -EVENT_OBJECT_PARENTCHANGE = 32783 -EVENT_OBJECT_HELPCHANGE = 32784 -EVENT_OBJECT_DEFACTIONCHANGE = 32785 -EVENT_OBJECT_ACCELERATORCHANGE = 32786 -SOUND_SYSTEM_STARTUP = 1 -SOUND_SYSTEM_SHUTDOWN = 2 -SOUND_SYSTEM_BEEP = 3 -SOUND_SYSTEM_ERROR = 4 -SOUND_SYSTEM_QUESTION = 5 -SOUND_SYSTEM_WARNING = 6 -SOUND_SYSTEM_INFORMATION = 7 -SOUND_SYSTEM_MAXIMIZE = 8 -SOUND_SYSTEM_MINIMIZE = 9 -SOUND_SYSTEM_RESTOREUP = 10 -SOUND_SYSTEM_RESTOREDOWN = 11 -SOUND_SYSTEM_APPSTART = 12 -SOUND_SYSTEM_FAULT = 13 -SOUND_SYSTEM_APPEND = 14 -SOUND_SYSTEM_MENUCOMMAND = 15 -SOUND_SYSTEM_MENUPOPUP = 16 -CSOUND_SYSTEM = 16 -ALERT_SYSTEM_INFORMATIONAL = 1 -ALERT_SYSTEM_WARNING = 2 -ALERT_SYSTEM_ERROR = 3 -ALERT_SYSTEM_QUERY = 4 -ALERT_SYSTEM_CRITICAL = 5 -CALERT_SYSTEM = 6 -WINEVENT_OUTOFCONTEXT = 0 -WINEVENT_SKIPOWNTHREAD = 1 -WINEVENT_SKIPOWNPROCESS = 2 -WINEVENT_INCONTEXT = 4 -GUI_CARETBLINKING = 1 -GUI_INMOVESIZE = 2 -GUI_INMENUMODE = 4 -GUI_SYSTEMMENUMODE = 8 -GUI_POPUPMENUMODE = 16 -STATE_SYSTEM_UNAVAILABLE = 1 -STATE_SYSTEM_SELECTED = 2 -STATE_SYSTEM_FOCUSED = 4 -STATE_SYSTEM_PRESSED = 8 -STATE_SYSTEM_CHECKED = 16 -STATE_SYSTEM_MIXED = 32 -STATE_SYSTEM_READONLY = 64 -STATE_SYSTEM_HOTTRACKED = 128 -STATE_SYSTEM_DEFAULT = 256 -STATE_SYSTEM_EXPANDED = 512 -STATE_SYSTEM_COLLAPSED = 1024 -STATE_SYSTEM_BUSY = 2048 -STATE_SYSTEM_FLOATING = 4096 -STATE_SYSTEM_MARQUEED = 8192 -STATE_SYSTEM_ANIMATED = 16384 -STATE_SYSTEM_INVISIBLE = 32768 -STATE_SYSTEM_OFFSCREEN = 65536 -STATE_SYSTEM_SIZEABLE = 131072 -STATE_SYSTEM_MOVEABLE = 262144 -STATE_SYSTEM_SELFVOICING = 524288 -STATE_SYSTEM_FOCUSABLE = 1048576 -STATE_SYSTEM_SELECTABLE = 2097152 -STATE_SYSTEM_LINKED = 4194304 -STATE_SYSTEM_TRAVERSED = 8388608 -STATE_SYSTEM_MULTISELECTABLE = 16777216 -STATE_SYSTEM_EXTSELECTABLE = 33554432 -STATE_SYSTEM_ALERT_LOW = 67108864 -STATE_SYSTEM_ALERT_MEDIUM = 134217728 -STATE_SYSTEM_ALERT_HIGH = 268435456 -STATE_SYSTEM_VALID = 536870911 -CCHILDREN_TITLEBAR = 5 -CCHILDREN_SCROLLBAR = 5 -CURSOR_SHOWING = 1 -WS_ACTIVECAPTION = 1 -GA_MIC = 1 -GA_PARENT = 1 -GA_ROOT = 2 -GA_ROOTOWNER = 3 -GA_MAC = 4 - -# winuser.h line 1979 -BF_LEFT = 1 -BF_TOP = 2 -BF_RIGHT = 4 -BF_BOTTOM = 8 -BF_TOPLEFT = (BF_TOP | BF_LEFT) -BF_TOPRIGHT = (BF_TOP | BF_RIGHT) -BF_BOTTOMLEFT = (BF_BOTTOM | BF_LEFT) -BF_BOTTOMRIGHT = (BF_BOTTOM | BF_RIGHT) -BF_RECT = (BF_LEFT | BF_TOP | BF_RIGHT | BF_BOTTOM) -BF_DIAGONAL = 16 -BF_DIAGONAL_ENDTOPRIGHT = (BF_DIAGONAL | BF_TOP | BF_RIGHT) -BF_DIAGONAL_ENDTOPLEFT = (BF_DIAGONAL | BF_TOP | BF_LEFT) -BF_DIAGONAL_ENDBOTTOMLEFT = (BF_DIAGONAL | BF_BOTTOM | BF_LEFT) -BF_DIAGONAL_ENDBOTTOMRIGHT = (BF_DIAGONAL | BF_BOTTOM | BF_RIGHT) -BF_MIDDLE = 2048 -BF_SOFT = 4096 -BF_ADJUST = 8192 -BF_FLAT = 16384 -BF_MONO = 32768 -DFC_CAPTION = 1 -DFC_MENU = 2 -DFC_SCROLL = 3 -DFC_BUTTON = 4 -DFC_POPUPMENU = 5 -DFCS_CAPTIONCLOSE = 0 -DFCS_CAPTIONMIN = 1 -DFCS_CAPTIONMAX = 2 -DFCS_CAPTIONRESTORE = 3 -DFCS_CAPTIONHELP = 4 -DFCS_MENUARROW = 0 -DFCS_MENUCHECK = 1 -DFCS_MENUBULLET = 2 -DFCS_MENUARROWRIGHT = 4 -DFCS_SCROLLUP = 0 -DFCS_SCROLLDOWN = 1 -DFCS_SCROLLLEFT = 2 -DFCS_SCROLLRIGHT = 3 -DFCS_SCROLLCOMBOBOX = 5 -DFCS_SCROLLSIZEGRIP = 8 -DFCS_SCROLLSIZEGRIPRIGHT = 16 -DFCS_BUTTONCHECK = 0 -DFCS_BUTTONRADIOIMAGE = 1 -DFCS_BUTTONRADIOMASK = 2 -DFCS_BUTTONRADIO = 4 -DFCS_BUTTON3STATE = 8 -DFCS_BUTTONPUSH = 16 -DFCS_INACTIVE = 256 -DFCS_PUSHED = 512 -DFCS_CHECKED = 1024 -DFCS_TRANSPARENT = 2048 -DFCS_HOT = 4096 -DFCS_ADJUSTRECT = 8192 -DFCS_FLAT = 16384 -DFCS_MONO = 32768 -DC_ACTIVE = 1 -DC_SMALLCAP = 2 -DC_ICON = 4 -DC_TEXT = 8 -DC_INBUTTON = 16 -DC_GRADIENT = 32 -IDANI_OPEN = 1 -IDANI_CLOSE = 2 -IDANI_CAPTION = 3 -CF_TEXT = 1 -CF_BITMAP = 2 -CF_METAFILEPICT = 3 -CF_SYLK = 4 -CF_DIF = 5 -CF_TIFF = 6 -CF_OEMTEXT = 7 -CF_DIB = 8 -CF_PALETTE = 9 -CF_PENDATA = 10 -CF_RIFF = 11 -CF_WAVE = 12 -CF_UNICODETEXT = 13 -CF_ENHMETAFILE = 14 -CF_HDROP = 15 -CF_LOCALE = 16 -CF_DIBV5 = 17 -CF_MAX = 18 -CF_OWNERDISPLAY = 128 -CF_DSPTEXT = 129 -CF_DSPBITMAP = 130 -CF_DSPMETAFILEPICT = 131 -CF_DSPENHMETAFILE = 142 -CF_PRIVATEFIRST = 512 -CF_PRIVATELAST = 767 -CF_GDIOBJFIRST = 768 -CF_GDIOBJLAST = 1023 -FVIRTKEY =1 -FNOINVERT = 2 -FSHIFT = 4 -FCONTROL = 8 -FALT = 16 -WPF_SETMINPOSITION = 1 -WPF_RESTORETOMAXIMIZED = 2 -ODT_MENU = 1 -ODT_LISTBOX = 2 -ODT_COMBOBOX = 3 -ODT_BUTTON = 4 -ODT_STATIC = 5 -ODA_DRAWENTIRE = 1 -ODA_SELECT = 2 -ODA_FOCUS = 4 -ODS_SELECTED = 1 -ODS_GRAYED = 2 -ODS_DISABLED = 4 -ODS_CHECKED = 8 -ODS_FOCUS = 16 -ODS_DEFAULT = 32 -ODS_COMBOBOXEDIT = 4096 -ODS_HOTLIGHT = 64 -ODS_INACTIVE = 128 -PM_NOREMOVE = 0 -PM_REMOVE = 1 -PM_NOYIELD = 2 -MOD_ALT = 1 -MOD_CONTROL = 2 -MOD_SHIFT = 4 -MOD_WIN = 8 -IDHOT_SNAPWINDOW = (-1) -IDHOT_SNAPDESKTOP = (-2) -#EW_RESTARTWINDOWS = 0x0042 -#EW_REBOOTSYSTEM = 0x0043 -#EW_EXITANDEXECAPP = 0x0044 -ENDSESSION_LOGOFF = -2147483648 -EWX_LOGOFF = 0 -EWX_SHUTDOWN = 1 -EWX_REBOOT = 2 -EWX_FORCE = 4 -EWX_POWEROFF = 8 -EWX_FORCEIFHUNG = 16 -BSM_ALLCOMPONENTS = 0 -BSM_VXDS = 1 -BSM_NETDRIVER = 2 -BSM_INSTALLABLEDRIVERS = 4 -BSM_APPLICATIONS = 8 -BSM_ALLDESKTOPS = 16 -BSF_QUERY = 1 -BSF_IGNORECURRENTTASK = 2 -BSF_FLUSHDISK = 4 -BSF_NOHANG = 8 -BSF_POSTMESSAGE = 16 -BSF_FORCEIFHUNG = 32 -BSF_NOTIMEOUTIFNOTHUNG = 64 -BROADCAST_QUERY_DENY = 1112363332 # Return this value to deny a query. - -DBWF_LPARAMPOINTER = 32768 - -# winuser.h line 3232 -SWP_NOSIZE = 1 -SWP_NOMOVE = 2 -SWP_NOZORDER = 4 -SWP_NOREDRAW = 8 -SWP_NOACTIVATE = 16 -SWP_FRAMECHANGED = 32 -SWP_SHOWWINDOW = 64 -SWP_HIDEWINDOW = 128 -SWP_NOCOPYBITS = 256 -SWP_NOOWNERZORDER = 512 -SWP_NOSENDCHANGING = 1024 -SWP_DRAWFRAME = SWP_FRAMECHANGED -SWP_NOREPOSITION = SWP_NOOWNERZORDER -SWP_DEFERERASE = 8192 -SWP_ASYNCWINDOWPOS = 16384 - -DLGWINDOWEXTRA = 30 -# winuser.h line 4249 -KEYEVENTF_EXTENDEDKEY = 1 -KEYEVENTF_KEYUP = 2 -MOUSEEVENTF_MOVE = 1 -MOUSEEVENTF_LEFTDOWN = 2 -MOUSEEVENTF_LEFTUP = 4 -MOUSEEVENTF_RIGHTDOWN = 8 -MOUSEEVENTF_RIGHTUP = 16 -MOUSEEVENTF_MIDDLEDOWN = 32 -MOUSEEVENTF_MIDDLEUP = 64 -MOUSEEVENTF_ABSOLUTE = 32768 -INPUT_MOUSE = 0 -INPUT_KEYBOARD = 1 -INPUT_HARDWARE = 2 -MWMO_WAITALL = 1 -MWMO_ALERTABLE = 2 -MWMO_INPUTAVAILABLE = 4 -QS_KEY = 1 -QS_MOUSEMOVE = 2 -QS_MOUSEBUTTON = 4 -QS_POSTMESSAGE = 8 -QS_TIMER = 16 -QS_PAINT = 32 -QS_SENDMESSAGE = 64 -QS_HOTKEY = 128 -QS_MOUSE = (QS_MOUSEMOVE | \ - QS_MOUSEBUTTON) -QS_INPUT = (QS_MOUSE | \ - QS_KEY) -QS_ALLEVENTS = (QS_INPUT | \ - QS_POSTMESSAGE | \ - QS_TIMER | \ - QS_PAINT | \ - QS_HOTKEY) -QS_ALLINPUT = (QS_INPUT | \ - QS_POSTMESSAGE | \ - QS_TIMER | \ - QS_PAINT | \ - QS_HOTKEY | \ - QS_SENDMESSAGE) - - -IMN_CLOSESTATUSWINDOW = 1 -IMN_OPENSTATUSWINDOW = 2 -IMN_CHANGECANDIDATE = 3 -IMN_CLOSECANDIDATE = 4 -IMN_OPENCANDIDATE = 5 -IMN_SETCONVERSIONMODE = 6 -IMN_SETSENTENCEMODE = 7 -IMN_SETOPENSTATUS = 8 -IMN_SETCANDIDATEPOS = 9 -IMN_SETCOMPOSITIONFONT = 10 -IMN_SETCOMPOSITIONWINDOW = 11 -IMN_SETSTATUSWINDOWPOS = 12 -IMN_GUIDELINE = 13 -IMN_PRIVATE = 14 - -# winuser.h line 8518 -HELP_CONTEXT = 1 -HELP_QUIT = 2 -HELP_INDEX = 3 -HELP_CONTENTS = 3 -HELP_HELPONHELP = 4 -HELP_SETINDEX = 5 -HELP_SETCONTENTS = 5 -HELP_CONTEXTPOPUP = 8 -HELP_FORCEFILE = 9 -HELP_KEY = 257 -HELP_COMMAND = 258 -HELP_PARTIALKEY = 261 -HELP_MULTIKEY = 513 -HELP_SETWINPOS = 515 -HELP_CONTEXTMENU = 10 -HELP_FINDER = 11 -HELP_WM_HELP = 12 -HELP_SETPOPUP_POS = 13 -HELP_TCARD = 32768 -HELP_TCARD_DATA = 16 -HELP_TCARD_OTHER_CALLER = 17 -IDH_NO_HELP = 28440 -IDH_MISSING_CONTEXT = 28441 # Control doesn't have matching help context -IDH_GENERIC_HELP_BUTTON = 28442 # Property sheet help button -IDH_OK = 28443 -IDH_CANCEL = 28444 -IDH_HELP = 28445 -GR_GDIOBJECTS = 0 # Count of GDI objects -GR_USEROBJECTS = 1 # Count of USER objects -# Generated by h2py from \msvcnt\include\wingdi.h -# manually added (missed by generation some how! -SRCCOPY = 13369376 # dest = source -SRCPAINT = 15597702 # dest = source OR dest -SRCAND = 8913094 # dest = source AND dest -SRCINVERT = 6684742 # dest = source XOR dest -SRCERASE = 4457256 # dest = source AND (NOT dest ) -NOTSRCCOPY = 3342344 # dest = (NOT source) -NOTSRCERASE = 1114278 # dest = (NOT src) AND (NOT dest) -MERGECOPY = 12583114 # dest = (source AND pattern) -MERGEPAINT = 12255782 # dest = (NOT source) OR dest -PATCOPY = 15728673 # dest = pattern -PATPAINT = 16452105 # dest = DPSnoo -PATINVERT = 5898313 # dest = pattern XOR dest -DSTINVERT = 5570569 # dest = (NOT dest) -BLACKNESS = 66 # dest = BLACK -WHITENESS = 16711778 # dest = WHITE - -# hacked and split manually by mhammond. -R2_BLACK = 1 -R2_NOTMERGEPEN = 2 -R2_MASKNOTPEN = 3 -R2_NOTCOPYPEN = 4 -R2_MASKPENNOT = 5 -R2_NOT = 6 -R2_XORPEN = 7 -R2_NOTMASKPEN = 8 -R2_MASKPEN = 9 -R2_NOTXORPEN = 10 -R2_NOP = 11 -R2_MERGENOTPEN = 12 -R2_COPYPEN = 13 -R2_MERGEPENNOT = 14 -R2_MERGEPEN = 15 -R2_WHITE = 16 -R2_LAST = 16 -GDI_ERROR = (-1) -ERROR = 0 -NULLREGION = 1 -SIMPLEREGION = 2 -COMPLEXREGION = 3 -RGN_ERROR = ERROR -RGN_AND = 1 -RGN_OR = 2 -RGN_XOR = 3 -RGN_DIFF = 4 -RGN_COPY = 5 -RGN_MIN = RGN_AND -RGN_MAX = RGN_COPY - -## Stretching modes used with Get/SetStretchBltMode -BLACKONWHITE = 1 -WHITEONBLACK = 2 -COLORONCOLOR = 3 -HALFTONE = 4 -MAXSTRETCHBLTMODE = 4 -STRETCH_ANDSCANS = BLACKONWHITE -STRETCH_ORSCANS = WHITEONBLACK -STRETCH_DELETESCANS = COLORONCOLOR -STRETCH_HALFTONE = HALFTONE - -ALTERNATE = 1 -WINDING = 2 -POLYFILL_LAST = 2 - -## flags used with SetLayout -LAYOUT_RTL = 1 -LAYOUT_BTT = 2 -LAYOUT_VBH = 4 -LAYOUT_ORIENTATIONMASK = LAYOUT_RTL|LAYOUT_BTT|LAYOUT_VBH -LAYOUT_BITMAPORIENTATIONPRESERVED = 8 - -TA_NOUPDATECP = 0 -TA_UPDATECP = 1 -TA_LEFT = 0 -TA_RIGHT = 2 -TA_CENTER = 6 -TA_TOP = 0 -TA_BOTTOM = 8 -TA_BASELINE = 24 -TA_MASK = (TA_BASELINE+TA_CENTER+TA_UPDATECP) -VTA_BASELINE = TA_BASELINE -VTA_LEFT = TA_BOTTOM -VTA_RIGHT = TA_TOP -VTA_CENTER = TA_CENTER -VTA_BOTTOM = TA_RIGHT -VTA_TOP = TA_LEFT -ETO_GRAYED = 1 -ETO_OPAQUE = 2 -ETO_CLIPPED = 4 -ASPECT_FILTERING = 1 -DCB_RESET = 1 -DCB_ACCUMULATE = 2 -DCB_DIRTY = DCB_ACCUMULATE -DCB_SET = (DCB_RESET | DCB_ACCUMULATE) -DCB_ENABLE = 4 -DCB_DISABLE = 8 -META_SETBKCOLOR = 513 -META_SETBKMODE = 258 -META_SETMAPMODE = 259 -META_SETROP2 = 260 -META_SETRELABS = 261 -META_SETPOLYFILLMODE = 262 -META_SETSTRETCHBLTMODE = 263 -META_SETTEXTCHAREXTRA = 264 -META_SETTEXTCOLOR = 521 -META_SETTEXTJUSTIFICATION = 522 -META_SETWINDOWORG = 523 -META_SETWINDOWEXT = 524 -META_SETVIEWPORTORG = 525 -META_SETVIEWPORTEXT = 526 -META_OFFSETWINDOWORG = 527 -META_SCALEWINDOWEXT = 1040 -META_OFFSETVIEWPORTORG = 529 -META_SCALEVIEWPORTEXT = 1042 -META_LINETO = 531 -META_MOVETO = 532 -META_EXCLUDECLIPRECT = 1045 -META_INTERSECTCLIPRECT = 1046 -META_ARC = 2071 -META_ELLIPSE = 1048 -META_FLOODFILL = 1049 -META_PIE = 2074 -META_RECTANGLE = 1051 -META_ROUNDRECT = 1564 -META_PATBLT = 1565 -META_SAVEDC = 30 -META_SETPIXEL = 1055 -META_OFFSETCLIPRGN = 544 -META_TEXTOUT = 1313 -META_BITBLT = 2338 -META_STRETCHBLT = 2851 -META_POLYGON = 804 -META_POLYLINE = 805 -META_ESCAPE = 1574 -META_RESTOREDC = 295 -META_FILLREGION = 552 -META_FRAMEREGION = 1065 -META_INVERTREGION = 298 -META_PAINTREGION = 299 -META_SELECTCLIPREGION = 300 -META_SELECTOBJECT = 301 -META_SETTEXTALIGN = 302 -META_CHORD = 2096 -META_SETMAPPERFLAGS = 561 -META_EXTTEXTOUT = 2610 -META_SETDIBTODEV = 3379 -META_SELECTPALETTE = 564 -META_REALIZEPALETTE = 53 -META_ANIMATEPALETTE = 1078 -META_SETPALENTRIES = 55 -META_POLYPOLYGON = 1336 -META_RESIZEPALETTE = 313 -META_DIBBITBLT = 2368 -META_DIBSTRETCHBLT = 2881 -META_DIBCREATEPATTERNBRUSH = 322 -META_STRETCHDIB = 3907 -META_EXTFLOODFILL = 1352 -META_DELETEOBJECT = 496 -META_CREATEPALETTE = 247 -META_CREATEPATTERNBRUSH = 505 -META_CREATEPENINDIRECT = 762 -META_CREATEFONTINDIRECT = 763 -META_CREATEBRUSHINDIRECT = 764 -META_CREATEREGION = 1791 -FILE_BEGIN = 0 -FILE_CURRENT = 1 -FILE_END = 2 -FILE_FLAG_WRITE_THROUGH = -2147483648 -FILE_FLAG_OVERLAPPED = 1073741824 -FILE_FLAG_NO_BUFFERING = 536870912 -FILE_FLAG_RANDOM_ACCESS = 268435456 -FILE_FLAG_SEQUENTIAL_SCAN = 134217728 -FILE_FLAG_DELETE_ON_CLOSE = 67108864 -FILE_FLAG_BACKUP_SEMANTICS = 33554432 -FILE_FLAG_POSIX_SEMANTICS = 16777216 -CREATE_NEW = 1 -CREATE_ALWAYS = 2 -OPEN_EXISTING = 3 -OPEN_ALWAYS = 4 -TRUNCATE_EXISTING = 5 -PIPE_ACCESS_INBOUND = 1 -PIPE_ACCESS_OUTBOUND = 2 -PIPE_ACCESS_DUPLEX = 3 -PIPE_CLIENT_END = 0 -PIPE_SERVER_END = 1 -PIPE_WAIT = 0 -PIPE_NOWAIT = 1 -PIPE_READMODE_BYTE = 0 -PIPE_READMODE_MESSAGE = 2 -PIPE_TYPE_BYTE = 0 -PIPE_TYPE_MESSAGE = 4 -PIPE_UNLIMITED_INSTANCES = 255 -SECURITY_CONTEXT_TRACKING = 262144 -SECURITY_EFFECTIVE_ONLY = 524288 -SECURITY_SQOS_PRESENT = 1048576 -SECURITY_VALID_SQOS_FLAGS = 2031616 -DTR_CONTROL_DISABLE = 0 -DTR_CONTROL_ENABLE = 1 -DTR_CONTROL_HANDSHAKE = 2 -RTS_CONTROL_DISABLE = 0 -RTS_CONTROL_ENABLE = 1 -RTS_CONTROL_HANDSHAKE = 2 -RTS_CONTROL_TOGGLE = 3 -GMEM_FIXED = 0 -GMEM_MOVEABLE = 2 -GMEM_NOCOMPACT = 16 -GMEM_NODISCARD = 32 -GMEM_ZEROINIT = 64 -GMEM_MODIFY = 128 -GMEM_DISCARDABLE = 256 -GMEM_NOT_BANKED = 4096 -GMEM_SHARE = 8192 -GMEM_DDESHARE = 8192 -GMEM_NOTIFY = 16384 -GMEM_LOWER = GMEM_NOT_BANKED -GMEM_VALID_FLAGS = 32626 -GMEM_INVALID_HANDLE = 32768 -GHND = (GMEM_MOVEABLE | GMEM_ZEROINIT) -GPTR = (GMEM_FIXED | GMEM_ZEROINIT) -GMEM_DISCARDED = 16384 -GMEM_LOCKCOUNT = 255 -LMEM_FIXED = 0 -LMEM_MOVEABLE = 2 -LMEM_NOCOMPACT = 16 -LMEM_NODISCARD = 32 -LMEM_ZEROINIT = 64 -LMEM_MODIFY = 128 -LMEM_DISCARDABLE = 3840 -LMEM_VALID_FLAGS = 3954 -LMEM_INVALID_HANDLE = 32768 -LHND = (LMEM_MOVEABLE | LMEM_ZEROINIT) -LPTR = (LMEM_FIXED | LMEM_ZEROINIT) -NONZEROLHND = (LMEM_MOVEABLE) -NONZEROLPTR = (LMEM_FIXED) -LMEM_DISCARDED = 16384 -LMEM_LOCKCOUNT = 255 -DEBUG_PROCESS = 1 -DEBUG_ONLY_THIS_PROCESS = 2 -CREATE_SUSPENDED = 4 -DETACHED_PROCESS = 8 -CREATE_NEW_CONSOLE = 16 -NORMAL_PRIORITY_CLASS = 32 -IDLE_PRIORITY_CLASS = 64 -HIGH_PRIORITY_CLASS = 128 -REALTIME_PRIORITY_CLASS = 256 -CREATE_NEW_PROCESS_GROUP = 512 -CREATE_UNICODE_ENVIRONMENT = 1024 -CREATE_SEPARATE_WOW_VDM = 2048 -CREATE_SHARED_WOW_VDM = 4096 -CREATE_DEFAULT_ERROR_MODE = 67108864 -CREATE_NO_WINDOW = 134217728 -PROFILE_USER = 268435456 -PROFILE_KERNEL = 536870912 -PROFILE_SERVER = 1073741824 -THREAD_BASE_PRIORITY_LOWRT = 15 -THREAD_BASE_PRIORITY_MAX = 2 -THREAD_BASE_PRIORITY_MIN = -2 -THREAD_BASE_PRIORITY_IDLE = -15 -THREAD_PRIORITY_LOWEST = THREAD_BASE_PRIORITY_MIN -THREAD_PRIORITY_BELOW_NORMAL = THREAD_PRIORITY_LOWEST+1 -THREAD_PRIORITY_HIGHEST = THREAD_BASE_PRIORITY_MAX -THREAD_PRIORITY_ABOVE_NORMAL = THREAD_PRIORITY_HIGHEST-1 -THREAD_PRIORITY_ERROR_RETURN = MAXLONG -THREAD_PRIORITY_TIME_CRITICAL = THREAD_BASE_PRIORITY_LOWRT -THREAD_PRIORITY_IDLE = THREAD_BASE_PRIORITY_IDLE -THREAD_PRIORITY_NORMAL = 0 -THREAD_MODE_BACKGROUND_BEGIN = 0x00010000 -THREAD_MODE_BACKGROUND_END = 0x00020000 - -EXCEPTION_DEBUG_EVENT = 1 -CREATE_THREAD_DEBUG_EVENT = 2 -CREATE_PROCESS_DEBUG_EVENT = 3 -EXIT_THREAD_DEBUG_EVENT = 4 -EXIT_PROCESS_DEBUG_EVENT = 5 -LOAD_DLL_DEBUG_EVENT = 6 -UNLOAD_DLL_DEBUG_EVENT = 7 -OUTPUT_DEBUG_STRING_EVENT = 8 -RIP_EVENT = 9 -DRIVE_UNKNOWN = 0 -DRIVE_NO_ROOT_DIR = 1 -DRIVE_REMOVABLE = 2 -DRIVE_FIXED = 3 -DRIVE_REMOTE = 4 -DRIVE_CDROM = 5 -DRIVE_RAMDISK = 6 -FILE_TYPE_UNKNOWN = 0 -FILE_TYPE_DISK = 1 -FILE_TYPE_CHAR = 2 -FILE_TYPE_PIPE = 3 -FILE_TYPE_REMOTE = 32768 -NOPARITY = 0 -ODDPARITY = 1 -EVENPARITY = 2 -MARKPARITY = 3 -SPACEPARITY = 4 -ONESTOPBIT = 0 -ONE5STOPBITS = 1 -TWOSTOPBITS = 2 -CBR_110 = 110 -CBR_300 = 300 -CBR_600 = 600 -CBR_1200 = 1200 -CBR_2400 = 2400 -CBR_4800 = 4800 -CBR_9600 = 9600 -CBR_14400 = 14400 -CBR_19200 = 19200 -CBR_38400 = 38400 -CBR_56000 = 56000 -CBR_57600 = 57600 -CBR_115200 = 115200 -CBR_128000 = 128000 -CBR_256000 = 256000 -S_QUEUEEMPTY = 0 -S_THRESHOLD = 1 -S_ALLTHRESHOLD = 2 -S_NORMAL = 0 -S_LEGATO = 1 -S_STACCATO = 2 -NMPWAIT_WAIT_FOREVER = -1 -NMPWAIT_NOWAIT = 1 -NMPWAIT_USE_DEFAULT_WAIT = 0 -OF_READ = 0 -OF_WRITE = 1 -OF_READWRITE = 2 -OF_SHARE_COMPAT = 0 -OF_SHARE_EXCLUSIVE = 16 -OF_SHARE_DENY_WRITE = 32 -OF_SHARE_DENY_READ = 48 -OF_SHARE_DENY_NONE = 64 -OF_PARSE = 256 -OF_DELETE = 512 -OF_VERIFY = 1024 -OF_CANCEL = 2048 -OF_CREATE = 4096 -OF_PROMPT = 8192 -OF_EXIST = 16384 -OF_REOPEN = 32768 -OFS_MAXPATHNAME = 128 -MAXINTATOM = 49152 - -# winbase.h -PROCESS_HEAP_REGION = 1 -PROCESS_HEAP_UNCOMMITTED_RANGE = 2 -PROCESS_HEAP_ENTRY_BUSY = 4 -PROCESS_HEAP_ENTRY_MOVEABLE = 16 -PROCESS_HEAP_ENTRY_DDESHARE = 32 -SCS_32BIT_BINARY = 0 -SCS_DOS_BINARY = 1 -SCS_WOW_BINARY = 2 -SCS_PIF_BINARY = 3 -SCS_POSIX_BINARY = 4 -SCS_OS216_BINARY = 5 -SEM_FAILCRITICALERRORS = 1 -SEM_NOGPFAULTERRORBOX = 2 -SEM_NOALIGNMENTFAULTEXCEPT = 4 -SEM_NOOPENFILEERRORBOX = 32768 -LOCKFILE_FAIL_IMMEDIATELY = 1 -LOCKFILE_EXCLUSIVE_LOCK = 2 -HANDLE_FLAG_INHERIT = 1 -HANDLE_FLAG_PROTECT_FROM_CLOSE = 2 -HINSTANCE_ERROR = 32 -GET_TAPE_MEDIA_INFORMATION = 0 -GET_TAPE_DRIVE_INFORMATION = 1 -SET_TAPE_MEDIA_INFORMATION = 0 -SET_TAPE_DRIVE_INFORMATION = 1 -FORMAT_MESSAGE_ALLOCATE_BUFFER = 256 -FORMAT_MESSAGE_IGNORE_INSERTS = 512 -FORMAT_MESSAGE_FROM_STRING = 1024 -FORMAT_MESSAGE_FROM_HMODULE = 2048 -FORMAT_MESSAGE_FROM_SYSTEM = 4096 -FORMAT_MESSAGE_ARGUMENT_ARRAY = 8192 -FORMAT_MESSAGE_MAX_WIDTH_MASK = 255 -BACKUP_INVALID = 0 -BACKUP_DATA = 1 -BACKUP_EA_DATA = 2 -BACKUP_SECURITY_DATA = 3 -BACKUP_ALTERNATE_DATA = 4 -BACKUP_LINK = 5 -BACKUP_PROPERTY_DATA = 6 -BACKUP_OBJECT_ID = 7 -BACKUP_REPARSE_DATA = 8 -BACKUP_SPARSE_BLOCK = 9 - -STREAM_NORMAL_ATTRIBUTE = 0 -STREAM_MODIFIED_WHEN_READ = 1 -STREAM_CONTAINS_SECURITY = 2 -STREAM_CONTAINS_PROPERTIES = 4 -STARTF_USESHOWWINDOW = 1 -STARTF_USESIZE = 2 -STARTF_USEPOSITION = 4 -STARTF_USECOUNTCHARS = 8 -STARTF_USEFILLATTRIBUTE = 16 -STARTF_FORCEONFEEDBACK = 64 -STARTF_FORCEOFFFEEDBACK = 128 -STARTF_USESTDHANDLES = 256 -STARTF_USEHOTKEY = 512 -SHUTDOWN_NORETRY = 1 -DONT_RESOLVE_DLL_REFERENCES = 1 -LOAD_LIBRARY_AS_DATAFILE = 2 -LOAD_WITH_ALTERED_SEARCH_PATH = 8 -DDD_RAW_TARGET_PATH = 1 -DDD_REMOVE_DEFINITION = 2 -DDD_EXACT_MATCH_ON_REMOVE = 4 -MOVEFILE_REPLACE_EXISTING = 1 -MOVEFILE_COPY_ALLOWED = 2 -MOVEFILE_DELAY_UNTIL_REBOOT = 4 -MAX_COMPUTERNAME_LENGTH = 15 -LOGON32_LOGON_INTERACTIVE = 2 -LOGON32_LOGON_NETWORK = 3 -LOGON32_LOGON_BATCH = 4 -LOGON32_LOGON_SERVICE = 5 -LOGON32_LOGON_UNLOCK = 7 -LOGON32_LOGON_NETWORK_CLEARTEXT = 8 -LOGON32_LOGON_NEW_CREDENTIALS = 9 -LOGON32_PROVIDER_DEFAULT = 0 -LOGON32_PROVIDER_WINNT35 = 1 -LOGON32_PROVIDER_WINNT40 = 2 -LOGON32_PROVIDER_WINNT50 = 3 -VER_PLATFORM_WIN32s = 0 -VER_PLATFORM_WIN32_WINDOWS = 1 -VER_PLATFORM_WIN32_NT = 2 -TC_NORMAL = 0 -TC_HARDERR = 1 -TC_GP_TRAP = 2 -TC_SIGNAL = 3 -AC_LINE_OFFLINE = 0 -AC_LINE_ONLINE = 1 -AC_LINE_BACKUP_POWER = 2 -AC_LINE_UNKNOWN = 255 -BATTERY_FLAG_HIGH = 1 -BATTERY_FLAG_LOW = 2 -BATTERY_FLAG_CRITICAL = 4 -BATTERY_FLAG_CHARGING = 8 -BATTERY_FLAG_NO_BATTERY = 128 -BATTERY_FLAG_UNKNOWN = 255 -BATTERY_PERCENTAGE_UNKNOWN = 255 -BATTERY_LIFE_UNKNOWN = -1 - -# Generated by h2py from d:\msdev\include\richedit.h -cchTextLimitDefault = 32767 -WM_CONTEXTMENU = 123 -WM_PRINTCLIENT = 792 -EN_MSGFILTER = 1792 -EN_REQUESTRESIZE = 1793 -EN_SELCHANGE = 1794 -EN_DROPFILES = 1795 -EN_PROTECTED = 1796 -EN_CORRECTTEXT = 1797 -EN_STOPNOUNDO = 1798 -EN_IMECHANGE = 1799 -EN_SAVECLIPBOARD = 1800 -EN_OLEOPFAILED = 1801 -ENM_NONE = 0 -ENM_CHANGE = 1 -ENM_UPDATE = 2 -ENM_SCROLL = 4 -ENM_KEYEVENTS = 65536 -ENM_MOUSEEVENTS = 131072 -ENM_REQUESTRESIZE = 262144 -ENM_SELCHANGE = 524288 -ENM_DROPFILES = 1048576 -ENM_PROTECTED = 2097152 -ENM_CORRECTTEXT = 4194304 -ENM_IMECHANGE = 8388608 -ES_SAVESEL = 32768 -ES_SUNKEN = 16384 -ES_DISABLENOSCROLL = 8192 -ES_SELECTIONBAR = 16777216 -ES_EX_NOCALLOLEINIT = 16777216 -ES_VERTICAL = 4194304 -ES_NOIME = 524288 -ES_SELFIME = 262144 -ECO_AUTOWORDSELECTION = 1 -ECO_AUTOVSCROLL = 64 -ECO_AUTOHSCROLL = 128 -ECO_NOHIDESEL = 256 -ECO_READONLY = 2048 -ECO_WANTRETURN = 4096 -ECO_SAVESEL = 32768 -ECO_SELECTIONBAR = 16777216 -ECO_VERTICAL = 4194304 -ECOOP_SET = 1 -ECOOP_OR = 2 -ECOOP_AND = 3 -ECOOP_XOR = 4 -WB_CLASSIFY = 3 -WB_MOVEWORDLEFT = 4 -WB_MOVEWORDRIGHT = 5 -WB_LEFTBREAK = 6 -WB_RIGHTBREAK = 7 -WB_MOVEWORDPREV = 4 -WB_MOVEWORDNEXT = 5 -WB_PREVBREAK = 6 -WB_NEXTBREAK = 7 -PC_FOLLOWING = 1 -PC_LEADING = 2 -PC_OVERFLOW = 3 -PC_DELIMITER = 4 -WBF_WORDWRAP = 16 -WBF_WORDBREAK = 32 -WBF_OVERFLOW = 64 -WBF_LEVEL1 = 128 -WBF_LEVEL2 = 256 -WBF_CUSTOM = 512 -CFM_BOLD = 1 -CFM_ITALIC = 2 -CFM_UNDERLINE = 4 -CFM_STRIKEOUT = 8 -CFM_PROTECTED = 16 -CFM_SIZE = -2147483648 -CFM_COLOR = 1073741824 -CFM_FACE = 536870912 -CFM_OFFSET = 268435456 -CFM_CHARSET = 134217728 -CFE_BOLD = 1 -CFE_ITALIC = 2 -CFE_UNDERLINE = 4 -CFE_STRIKEOUT = 8 -CFE_PROTECTED = 16 -CFE_AUTOCOLOR = 1073741824 -yHeightCharPtsMost = 1638 -SCF_SELECTION = 1 -SCF_WORD = 2 -SF_TEXT = 1 -SF_RTF = 2 -SF_RTFNOOBJS = 3 -SF_TEXTIZED = 4 -SFF_SELECTION = 32768 -SFF_PLAINRTF = 16384 -MAX_TAB_STOPS = 32 -lDefaultTab = 720 -PFM_STARTINDENT = 1 -PFM_RIGHTINDENT = 2 -PFM_OFFSET = 4 -PFM_ALIGNMENT = 8 -PFM_TABSTOPS = 16 -PFM_NUMBERING = 32 -PFM_OFFSETINDENT = -2147483648 -PFN_BULLET = 1 -PFA_LEFT = 1 -PFA_RIGHT = 2 -PFA_CENTER = 3 -WM_NOTIFY = 78 -SEL_EMPTY = 0 -SEL_TEXT = 1 -SEL_OBJECT = 2 -SEL_MULTICHAR = 4 -SEL_MULTIOBJECT = 8 -OLEOP_DOVERB = 1 -CF_RTF = "Rich Text Format" -CF_RTFNOOBJS = "Rich Text Format Without Objects" -CF_RETEXTOBJ = "RichEdit Text and Objects" - -# From wincon.h -RIGHT_ALT_PRESSED = 1 # the right alt key is pressed. -LEFT_ALT_PRESSED = 2 # the left alt key is pressed. -RIGHT_CTRL_PRESSED = 4 # the right ctrl key is pressed. -LEFT_CTRL_PRESSED = 8 # the left ctrl key is pressed. -SHIFT_PRESSED = 16 # the shift key is pressed. -NUMLOCK_ON = 32 # the numlock light is on. -SCROLLLOCK_ON = 64 # the scrolllock light is on. -CAPSLOCK_ON = 128 # the capslock light is on. -ENHANCED_KEY = 256 # the key is enhanced. -NLS_DBCSCHAR = 65536 # DBCS for JPN: SBCS/DBCS mode. -NLS_ALPHANUMERIC = 0 # DBCS for JPN: Alphanumeric mode. -NLS_KATAKANA = 131072 # DBCS for JPN: Katakana mode. -NLS_HIRAGANA = 262144 # DBCS for JPN: Hiragana mode. -NLS_ROMAN = 4194304 # DBCS for JPN: Roman/Noroman mode. -NLS_IME_CONVERSION = 8388608 # DBCS for JPN: IME conversion. -NLS_IME_DISABLE = 536870912 # DBCS for JPN: IME enable/disable. - -FROM_LEFT_1ST_BUTTON_PRESSED = 1 -RIGHTMOST_BUTTON_PRESSED = 2 -FROM_LEFT_2ND_BUTTON_PRESSED = 4 -FROM_LEFT_3RD_BUTTON_PRESSED = 8 -FROM_LEFT_4TH_BUTTON_PRESSED = 16 - -CTRL_C_EVENT = 0 -CTRL_BREAK_EVENT = 1 -CTRL_CLOSE_EVENT = 2 -CTRL_LOGOFF_EVENT = 5 -CTRL_SHUTDOWN_EVENT = 6 - -MOUSE_MOVED = 1 -DOUBLE_CLICK = 2 -MOUSE_WHEELED = 4 - -#property sheet window messages from prsht.h -PSM_SETCURSEL = (WM_USER + 101) -PSM_REMOVEPAGE = (WM_USER + 102) -PSM_ADDPAGE = (WM_USER + 103) -PSM_CHANGED = (WM_USER + 104) -PSM_RESTARTWINDOWS = (WM_USER + 105) -PSM_REBOOTSYSTEM = (WM_USER + 106) -PSM_CANCELTOCLOSE = (WM_USER + 107) -PSM_QUERYSIBLINGS = (WM_USER + 108) -PSM_UNCHANGED = (WM_USER + 109) -PSM_APPLY = (WM_USER + 110) -PSM_SETTITLEA = (WM_USER + 111) -PSM_SETTITLEW = (WM_USER + 120) -PSM_SETWIZBUTTONS = (WM_USER + 112) -PSM_PRESSBUTTON = (WM_USER + 113) -PSM_SETCURSELID = (WM_USER + 114) -PSM_SETFINISHTEXTA = (WM_USER + 115) -PSM_SETFINISHTEXTW = (WM_USER + 121) -PSM_GETTABCONTROL = (WM_USER + 116) -PSM_ISDIALOGMESSAGE = (WM_USER + 117) -PSM_GETCURRENTPAGEHWND = (WM_USER + 118) -PSM_INSERTPAGE = (WM_USER + 119) -PSM_SETHEADERTITLEA = (WM_USER + 125) -PSM_SETHEADERTITLEW = (WM_USER + 126) -PSM_SETHEADERSUBTITLEA = (WM_USER + 127) -PSM_SETHEADERSUBTITLEW = (WM_USER + 128) -PSM_HWNDTOINDEX = (WM_USER + 129) -PSM_INDEXTOHWND = (WM_USER + 130) -PSM_PAGETOINDEX = (WM_USER + 131) -PSM_INDEXTOPAGE = (WM_USER + 132) -PSM_IDTOINDEX = (WM_USER + 133) -PSM_INDEXTOID = (WM_USER + 134) -PSM_GETRESULT = (WM_USER + 135) -PSM_RECALCPAGESIZES = (WM_USER + 136) - -# GetUserNameEx/GetComputerNameEx -NameUnknown = 0 -NameFullyQualifiedDN = 1 -NameSamCompatible = 2 -NameDisplay = 3 -NameUniqueId = 6 -NameCanonical = 7 -NameUserPrincipal = 8 -NameCanonicalEx = 9 -NameServicePrincipal = 10 -NameDnsDomain = 12 - -ComputerNameNetBIOS = 0 -ComputerNameDnsHostname = 1 -ComputerNameDnsDomain = 2 -ComputerNameDnsFullyQualified = 3 -ComputerNamePhysicalNetBIOS = 4 -ComputerNamePhysicalDnsHostname = 5 -ComputerNamePhysicalDnsDomain = 6 -ComputerNamePhysicalDnsFullyQualified = 7 - -LWA_COLORKEY = 0x00000001 -LWA_ALPHA = 0x00000002 -ULW_COLORKEY = 0x00000001 -ULW_ALPHA = 0x00000002 -ULW_OPAQUE = 0x00000004 - -# WinDef.h -TRUE = 1 -FALSE = 0 -MAX_PATH = 260 -# WinGDI.h -AC_SRC_OVER = 0 -AC_SRC_ALPHA = 1 -GRADIENT_FILL_RECT_H = 0 -GRADIENT_FILL_RECT_V = 1 -GRADIENT_FILL_TRIANGLE = 2 -GRADIENT_FILL_OP_FLAG = 255 - -## flags used with Get/SetSystemFileCacheSize -MM_WORKING_SET_MAX_HARD_ENABLE = 1 -MM_WORKING_SET_MAX_HARD_DISABLE = 2 -MM_WORKING_SET_MIN_HARD_ENABLE = 4 -MM_WORKING_SET_MIN_HARD_DISABLE = 8 - -## Flags for GetFinalPathNameByHandle -VOLUME_NAME_DOS = 0 -VOLUME_NAME_GUID = 1 -VOLUME_NAME_NT = 2 -VOLUME_NAME_NONE = 4 -FILE_NAME_NORMALIZED = 0 -FILE_NAME_OPENED = 8 - -DEVICE_NOTIFY_WINDOW_HANDLE = 0x00000000 -DEVICE_NOTIFY_SERVICE_HANDLE = 0x00000001 - -# From Dbt.h -# Generated by h2py from Dbt.h -WM_DEVICECHANGE = 0x0219 -BSF_QUERY = 0x00000001 -BSF_IGNORECURRENTTASK = 0x00000002 -BSF_FLUSHDISK = 0x00000004 -BSF_NOHANG = 0x00000008 -BSF_POSTMESSAGE = 0x00000010 -BSF_FORCEIFHUNG = 0x00000020 -BSF_NOTIMEOUTIFNOTHUNG = 0x00000040 -BSF_MSGSRV32ISOK = (-2147483648) -BSF_MSGSRV32ISOK_BIT = 31 -BSM_ALLCOMPONENTS = 0x00000000 -BSM_VXDS = 0x00000001 -BSM_NETDRIVER = 0x00000002 -BSM_INSTALLABLEDRIVERS = 0x00000004 -BSM_APPLICATIONS = 0x00000008 -DBT_APPYBEGIN = 0x0000 -DBT_APPYEND = 0x0001 -DBT_DEVNODES_CHANGED = 0x0007 -DBT_QUERYCHANGECONFIG = 0x0017 -DBT_CONFIGCHANGED = 0x0018 -DBT_CONFIGCHANGECANCELED = 0x0019 -DBT_MONITORCHANGE = 0x001B -DBT_SHELLLOGGEDON = 0x0020 -DBT_CONFIGMGAPI32 = 0x0022 -DBT_VXDINITCOMPLETE = 0x0023 -DBT_VOLLOCKQUERYLOCK = 0x8041 -DBT_VOLLOCKLOCKTAKEN = 0x8042 -DBT_VOLLOCKLOCKFAILED = 0x8043 -DBT_VOLLOCKQUERYUNLOCK = 0x8044 -DBT_VOLLOCKLOCKRELEASED = 0x8045 -DBT_VOLLOCKUNLOCKFAILED = 0x8046 -LOCKP_ALLOW_WRITES = 0x01 -LOCKP_FAIL_WRITES = 0x00 -LOCKP_FAIL_MEM_MAPPING = 0x02 -LOCKP_ALLOW_MEM_MAPPING = 0x00 -LOCKP_USER_MASK = 0x03 -LOCKP_LOCK_FOR_FORMAT = 0x04 -LOCKF_LOGICAL_LOCK = 0x00 -LOCKF_PHYSICAL_LOCK = 0x01 -DBT_NO_DISK_SPACE = 0x0047 -DBT_LOW_DISK_SPACE = 0x0048 -DBT_CONFIGMGPRIVATE = 0x7FFF -DBT_DEVICEARRIVAL = 0x8000 -DBT_DEVICEQUERYREMOVE = 0x8001 -DBT_DEVICEQUERYREMOVEFAILED = 0x8002 -DBT_DEVICEREMOVEPENDING = 0x8003 -DBT_DEVICEREMOVECOMPLETE = 0x8004 -DBT_DEVICETYPESPECIFIC = 0x8005 -DBT_CUSTOMEVENT = 0x8006 -DBT_DEVTYP_OEM = 0x00000000 -DBT_DEVTYP_DEVNODE = 0x00000001 -DBT_DEVTYP_VOLUME = 0x00000002 -DBT_DEVTYP_PORT = 0x00000003 -DBT_DEVTYP_NET = 0x00000004 -DBT_DEVTYP_DEVICEINTERFACE = 0x00000005 -DBT_DEVTYP_HANDLE = 0x00000006 -DBTF_MEDIA = 0x0001 -DBTF_NET = 0x0002 -DBTF_RESOURCE = 0x00000001 -DBTF_XPORT = 0x00000002 -DBTF_SLOWNET = 0x00000004 -DBT_VPOWERDAPI = 0x8100 -DBT_USERDEFINED = 0xFFFF diff --git a/typings/win32helper/__init__.pyi b/typings/win32helper/__init__.pyi deleted file mode 100644 index e69de29b..00000000 diff --git a/typings/win32helper/ntsecuritycon.pyi b/typings/win32helper/ntsecuritycon.pyi deleted file mode 100644 index 716d811d..00000000 --- a/typings/win32helper/ntsecuritycon.pyi +++ /dev/null @@ -1,689 +0,0 @@ -# Hacked from winnt.h - -DELETE = (65536) -READ_CONTROL = (131072) -WRITE_DAC = (262144) -WRITE_OWNER = (524288) -SYNCHRONIZE = (1048576) -STANDARD_RIGHTS_REQUIRED = (983040) -STANDARD_RIGHTS_READ = (READ_CONTROL) -STANDARD_RIGHTS_WRITE = (READ_CONTROL) -STANDARD_RIGHTS_EXECUTE = (READ_CONTROL) -STANDARD_RIGHTS_ALL = (2031616) -SPECIFIC_RIGHTS_ALL = (65535) -ACCESS_SYSTEM_SECURITY = (16777216) -MAXIMUM_ALLOWED = (33554432) -GENERIC_READ = (-2147483648) -GENERIC_WRITE = (1073741824) -GENERIC_EXECUTE = (536870912) -GENERIC_ALL = (268435456) - -# file security permissions -FILE_READ_DATA= ( 1 ) -FILE_LIST_DIRECTORY= ( 1 ) -FILE_WRITE_DATA= ( 2 ) -FILE_ADD_FILE= ( 2 ) -FILE_APPEND_DATA= ( 4 ) -FILE_ADD_SUBDIRECTORY= ( 4 ) -FILE_CREATE_PIPE_INSTANCE= ( 4 ) -FILE_READ_EA= ( 8 ) -FILE_WRITE_EA= ( 16 ) -FILE_EXECUTE= ( 32 ) -FILE_TRAVERSE= ( 32 ) -FILE_DELETE_CHILD= ( 64 ) -FILE_READ_ATTRIBUTES= ( 128 ) -FILE_WRITE_ATTRIBUTES= ( 256 ) -FILE_ALL_ACCESS= (STANDARD_RIGHTS_REQUIRED | SYNCHRONIZE | 511) -FILE_GENERIC_READ= (STANDARD_RIGHTS_READ | FILE_READ_DATA | FILE_READ_ATTRIBUTES | FILE_READ_EA | SYNCHRONIZE) -FILE_GENERIC_WRITE= (STANDARD_RIGHTS_WRITE | FILE_WRITE_DATA | FILE_WRITE_ATTRIBUTES | FILE_WRITE_EA | FILE_APPEND_DATA | SYNCHRONIZE) -FILE_GENERIC_EXECUTE= (STANDARD_RIGHTS_EXECUTE | FILE_READ_ATTRIBUTES | FILE_EXECUTE | SYNCHRONIZE) - - -SECURITY_NULL_SID_AUTHORITY = (0,0,0,0,0,0) -SECURITY_WORLD_SID_AUTHORITY = (0,0,0,0,0,1) -SECURITY_LOCAL_SID_AUTHORITY = (0,0,0,0,0,2) -SECURITY_CREATOR_SID_AUTHORITY = (0,0,0,0,0,3) -SECURITY_NON_UNIQUE_AUTHORITY = (0,0,0,0,0,4) -SECURITY_RESOURCE_MANAGER_AUTHORITY = (0,0,0,0,0,9) - -SECURITY_NULL_RID = 0 -SECURITY_WORLD_RID = 0 -SECURITY_LOCAL_RID = 0X00000000 - -SECURITY_CREATOR_OWNER_RID = 0 -SECURITY_CREATOR_GROUP_RID = 1 - -SECURITY_CREATOR_OWNER_SERVER_RID = 2 -SECURITY_CREATOR_GROUP_SERVER_RID = 3 -SECURITY_CREATOR_OWNER_RIGHTS_RID = 4 - -# NT well-known SIDs -SECURITY_NT_AUTHORITY = (0,0,0,0,0,5) - -SECURITY_DIALUP_RID = 1 -SECURITY_NETWORK_RID = 2 -SECURITY_BATCH_RID = 3 -SECURITY_INTERACTIVE_RID = 4 -SECURITY_SERVICE_RID = 6 -SECURITY_ANONYMOUS_LOGON_RID = 7 -SECURITY_PROXY_RID = 8 -SECURITY_SERVER_LOGON_RID = 9 - -SECURITY_LOGON_IDS_RID = 5 -SECURITY_LOGON_IDS_RID_COUNT = 3 - -SECURITY_LOCAL_SYSTEM_RID = 18 - -SECURITY_NT_NON_UNIQUE = 21 - -SECURITY_BUILTIN_DOMAIN_RID = 32 - -# well-known domain relative sub-authority values (RIDs)... -DOMAIN_USER_RID_ADMIN = 500 -DOMAIN_USER_RID_GUEST = 501 -DOMAIN_USER_RID_KRBTGT = 502 -DOMAIN_USER_RID_MAX = 999 - -# well-known groups ... -DOMAIN_GROUP_RID_ADMINS = 512 -DOMAIN_GROUP_RID_USERS = 513 -DOMAIN_GROUP_RID_GUESTS = 514 -DOMAIN_GROUP_RID_COMPUTERS = 515 -DOMAIN_GROUP_RID_CONTROLLERS = 516 -DOMAIN_GROUP_RID_CERT_ADMINS = 517 -DOMAIN_GROUP_RID_SCHEMA_ADMINS = 518 -DOMAIN_GROUP_RID_ENTERPRISE_ADMINS = 519 -DOMAIN_GROUP_RID_POLICY_ADMINS = 520 -DOMAIN_GROUP_RID_READONLY_CONTROLLERS = 521 - -# well-known aliases ... -DOMAIN_ALIAS_RID_ADMINS = 544 -DOMAIN_ALIAS_RID_USERS = 545 -DOMAIN_ALIAS_RID_GUESTS = 546 -DOMAIN_ALIAS_RID_POWER_USERS = 547 -DOMAIN_ALIAS_RID_ACCOUNT_OPS = 548 -DOMAIN_ALIAS_RID_SYSTEM_OPS = 549 -DOMAIN_ALIAS_RID_PRINT_OPS = 550 -DOMAIN_ALIAS_RID_BACKUP_OPS = 551 -DOMAIN_ALIAS_RID_REPLICATOR = 552 -DOMAIN_ALIAS_RID_RAS_SERVERS = 553 -DOMAIN_ALIAS_RID_PREW2KCOMPACCESS = 554 -DOMAIN_ALIAS_RID_REMOTE_DESKTOP_USERS = 555 -DOMAIN_ALIAS_RID_NETWORK_CONFIGURATION_OPS = 556 -DOMAIN_ALIAS_RID_INCOMING_FOREST_TRUST_BUILDERS = 557 -DOMAIN_ALIAS_RID_MONITORING_USERS = 558 -DOMAIN_ALIAS_RID_LOGGING_USERS = 559 -DOMAIN_ALIAS_RID_AUTHORIZATIONACCESS = 560 -DOMAIN_ALIAS_RID_TS_LICENSE_SERVERS = 561 -DOMAIN_ALIAS_RID_DCOM_USERS = 562 -DOMAIN_ALIAS_RID_IUSERS = 568 -DOMAIN_ALIAS_RID_CRYPTO_OPERATORS = 569 -DOMAIN_ALIAS_RID_CACHEABLE_PRINCIPALS_GROUP = 571 -DOMAIN_ALIAS_RID_NON_CACHEABLE_PRINCIPALS_GROUP = 572 -DOMAIN_ALIAS_RID_EVENT_LOG_READERS_GROUP = 573 - -SECURITY_MANDATORY_LABEL_AUTHORITY = (0,0,0,0,0,16) -SECURITY_MANDATORY_UNTRUSTED_RID = 0x00000000 -SECURITY_MANDATORY_LOW_RID = 0x00001000 -SECURITY_MANDATORY_MEDIUM_RID = 0x00002000 -SECURITY_MANDATORY_HIGH_RID = 0x00003000 -SECURITY_MANDATORY_SYSTEM_RID = 0x00004000 -SECURITY_MANDATORY_PROTECTED_PROCESS_RID = 0x00005000 -SECURITY_MANDATORY_MAXIMUM_USER_RID = SECURITY_MANDATORY_SYSTEM_RID - -SYSTEM_LUID = (999, 0) -ANONYMOUS_LOGON_LUID = (998, 0) -LOCALSERVICE_LUID = (997, 0) -NETWORKSERVICE_LUID = (996, 0) -IUSER_LUID = (995, 0) - -# Group attributes - -SE_GROUP_MANDATORY = 1 -SE_GROUP_ENABLED_BY_DEFAULT = 2 -SE_GROUP_ENABLED = 4 -SE_GROUP_OWNER = 8 -SE_GROUP_USE_FOR_DENY_ONLY = 16 -SE_GROUP_INTEGRITY = 32 -SE_GROUP_INTEGRITY_ENABLED = 64 -SE_GROUP_RESOURCE = 536870912 -SE_GROUP_LOGON_ID = -1073741824 - - -# User attributes -# (None yet defined.) - -# ACE types -ACCESS_MIN_MS_ACE_TYPE = (0) -ACCESS_ALLOWED_ACE_TYPE = (0) -ACCESS_DENIED_ACE_TYPE = (1) -SYSTEM_AUDIT_ACE_TYPE = (2) -SYSTEM_ALARM_ACE_TYPE = (3) -ACCESS_MAX_MS_V2_ACE_TYPE = (3) -ACCESS_ALLOWED_COMPOUND_ACE_TYPE = (4) -ACCESS_MAX_MS_V3_ACE_TYPE = (4) -ACCESS_MIN_MS_OBJECT_ACE_TYPE = (5) -ACCESS_ALLOWED_OBJECT_ACE_TYPE = (5) -ACCESS_DENIED_OBJECT_ACE_TYPE = (6) -SYSTEM_AUDIT_OBJECT_ACE_TYPE = (7) -SYSTEM_ALARM_OBJECT_ACE_TYPE = (8) -ACCESS_MAX_MS_OBJECT_ACE_TYPE = (8) -ACCESS_MAX_MS_V4_ACE_TYPE = (8) -ACCESS_MAX_MS_ACE_TYPE = (8) -ACCESS_ALLOWED_CALLBACK_ACE_TYPE = 9 -ACCESS_DENIED_CALLBACK_ACE_TYPE = 10 -ACCESS_ALLOWED_CALLBACK_OBJECT_ACE_TYPE = 11 -ACCESS_DENIED_CALLBACK_OBJECT_ACE_TYPE = 12 -SYSTEM_AUDIT_CALLBACK_ACE_TYPE = 13 -SYSTEM_ALARM_CALLBACK_ACE_TYPE = 14 -SYSTEM_AUDIT_CALLBACK_OBJECT_ACE_TYPE = 15 -SYSTEM_ALARM_CALLBACK_OBJECT_ACE_TYPE = 16 -SYSTEM_MANDATORY_LABEL_ACE_TYPE = 17 -ACCESS_MAX_MS_V5_ACE_TYPE = 17 - -# The following are the inherit flags that go into the AceFlags field -# of an Ace header. - -OBJECT_INHERIT_ACE = 1 -CONTAINER_INHERIT_ACE = 2 -NO_PROPAGATE_INHERIT_ACE = 4 -INHERIT_ONLY_ACE = 8 -VALID_INHERIT_FLAGS = 15 - - -SUCCESSFUL_ACCESS_ACE_FLAG = 64 -FAILED_ACCESS_ACE_FLAG = 128 - -SE_OWNER_DEFAULTED = 1 -SE_GROUP_DEFAULTED = 2 -SE_DACL_PRESENT = 4 -SE_DACL_DEFAULTED = 8 -SE_SACL_PRESENT = 16 -SE_SACL_DEFAULTED = 32 -SE_SELF_RELATIVE = 32768 - - -SE_PRIVILEGE_ENABLED_BY_DEFAULT = 1 -SE_PRIVILEGE_ENABLED = 2 -SE_PRIVILEGE_USED_FOR_ACCESS = -2147483648 - -PRIVILEGE_SET_ALL_NECESSARY = 1 - -# NT Defined Privileges - -SE_CREATE_TOKEN_NAME = "SeCreateTokenPrivilege" -SE_ASSIGNPRIMARYTOKEN_NAME = "SeAssignPrimaryTokenPrivilege" -SE_LOCK_MEMORY_NAME = "SeLockMemoryPrivilege" -SE_INCREASE_QUOTA_NAME = "SeIncreaseQuotaPrivilege" -SE_UNSOLICITED_INPUT_NAME = "SeUnsolicitedInputPrivilege" -SE_MACHINE_ACCOUNT_NAME = "SeMachineAccountPrivilege" -SE_TCB_NAME = "SeTcbPrivilege" -SE_SECURITY_NAME = "SeSecurityPrivilege" -SE_TAKE_OWNERSHIP_NAME = "SeTakeOwnershipPrivilege" -SE_LOAD_DRIVER_NAME = "SeLoadDriverPrivilege" -SE_SYSTEM_PROFILE_NAME = "SeSystemProfilePrivilege" -SE_SYSTEMTIME_NAME = "SeSystemtimePrivilege" -SE_PROF_SINGLE_PROCESS_NAME = "SeProfileSingleProcessPrivilege" -SE_INC_BASE_PRIORITY_NAME = "SeIncreaseBasePriorityPrivilege" -SE_CREATE_PAGEFILE_NAME = "SeCreatePagefilePrivilege" -SE_CREATE_PERMANENT_NAME = "SeCreatePermanentPrivilege" -SE_BACKUP_NAME = "SeBackupPrivilege" -SE_RESTORE_NAME = "SeRestorePrivilege" -SE_SHUTDOWN_NAME = "SeShutdownPrivilege" -SE_DEBUG_NAME = "SeDebugPrivilege" -SE_AUDIT_NAME = "SeAuditPrivilege" -SE_SYSTEM_ENVIRONMENT_NAME = "SeSystemEnvironmentPrivilege" -SE_CHANGE_NOTIFY_NAME = "SeChangeNotifyPrivilege" -SE_REMOTE_SHUTDOWN_NAME = "SeRemoteShutdownPrivilege" - - -# Enum SECURITY_IMPERSONATION_LEVEL: -SecurityAnonymous = 0 -SecurityIdentification = 1 -SecurityImpersonation = 2 -SecurityDelegation = 3 - -SECURITY_MAX_IMPERSONATION_LEVEL = SecurityDelegation - -DEFAULT_IMPERSONATION_LEVEL = SecurityImpersonation - -TOKEN_ASSIGN_PRIMARY = 1 -TOKEN_DUPLICATE = 2 -TOKEN_IMPERSONATE = 4 -TOKEN_QUERY = 8 -TOKEN_QUERY_SOURCE = 16 -TOKEN_ADJUST_PRIVILEGES = 32 -TOKEN_ADJUST_GROUPS = 64 -TOKEN_ADJUST_DEFAULT = 128 - -TOKEN_ALL_ACCESS = (STANDARD_RIGHTS_REQUIRED |\ - TOKEN_ASSIGN_PRIMARY |\ - TOKEN_DUPLICATE |\ - TOKEN_IMPERSONATE |\ - TOKEN_QUERY |\ - TOKEN_QUERY_SOURCE |\ - TOKEN_ADJUST_PRIVILEGES |\ - TOKEN_ADJUST_GROUPS |\ - TOKEN_ADJUST_DEFAULT) - - -TOKEN_READ = (STANDARD_RIGHTS_READ |\ - TOKEN_QUERY) - - -TOKEN_WRITE = (STANDARD_RIGHTS_WRITE |\ - TOKEN_ADJUST_PRIVILEGES |\ - TOKEN_ADJUST_GROUPS |\ - TOKEN_ADJUST_DEFAULT) - -TOKEN_EXECUTE = (STANDARD_RIGHTS_EXECUTE) - -SidTypeUser = 1 -SidTypeGroup = 2 -SidTypeDomain =3 -SidTypeAlias = 4 -SidTypeWellKnownGroup = 5 -SidTypeDeletedAccount = 6 -SidTypeInvalid = 7 -SidTypeUnknown = 8 -SidTypeComputer = 9 -SidTypeLabel = 10 - -# Token types -TokenPrimary = 1 -TokenImpersonation = 2 - -# TOKEN_INFORMATION_CLASS, used with Get/SetTokenInformation -TokenUser = 1 -TokenGroups = 2 -TokenPrivileges = 3 -TokenOwner = 4 -TokenPrimaryGroup = 5 -TokenDefaultDacl = 6 -TokenSource = 7 -TokenType = 8 -TokenImpersonationLevel = 9 -TokenStatistics = 10 -TokenRestrictedSids = 11 -TokenSessionId = 12 -TokenGroupsAndPrivileges = 13 -TokenSessionReference = 14 -TokenSandBoxInert = 15 -TokenAuditPolicy = 16 -TokenOrigin = 17 -TokenElevationType = 18 -TokenLinkedToken = 19 -TokenElevation = 20 -TokenHasRestrictions = 21 -TokenAccessInformation = 22 -TokenVirtualizationAllowed = 23 -TokenVirtualizationEnabled = 24 -TokenIntegrityLevel = 25 -TokenUIAccess = 26 -TokenMandatoryPolicy = 27 -TokenLogonSid = 28 - -# DirectoryService related constants. -# Generated by h2py from NtDsAPI.h -DS_BEHAVIOR_WIN2000 = 0 -DS_BEHAVIOR_WIN2003_WITH_MIXED_DOMAINS = 1 -DS_BEHAVIOR_WIN2003 = 2 -DS_SYNCED_EVENT_NAME = "NTDSInitialSyncsCompleted" -ACTRL_DS_OPEN = 0x00000000 -ACTRL_DS_CREATE_CHILD = 0x00000001 -ACTRL_DS_DELETE_CHILD = 0x00000002 -ACTRL_DS_LIST = 0x00000004 -ACTRL_DS_SELF = 0x00000008 -ACTRL_DS_READ_PROP = 0x00000010 -ACTRL_DS_WRITE_PROP = 0x00000020 -ACTRL_DS_DELETE_TREE = 0x00000040 -ACTRL_DS_LIST_OBJECT = 0x00000080 -ACTRL_DS_CONTROL_ACCESS = 0x00000100 -NTDSAPI_BIND_ALLOW_DELEGATION = (0x00000001) -DS_REPSYNC_ASYNCHRONOUS_OPERATION = 0x00000001 -DS_REPSYNC_WRITEABLE = 0x00000002 -DS_REPSYNC_PERIODIC = 0x00000004 -DS_REPSYNC_INTERSITE_MESSAGING = 0x00000008 -DS_REPSYNC_ALL_SOURCES = 0x00000010 -DS_REPSYNC_FULL = 0x00000020 -DS_REPSYNC_URGENT = 0x00000040 -DS_REPSYNC_NO_DISCARD = 0x00000080 -DS_REPSYNC_FORCE = 0x00000100 -DS_REPSYNC_ADD_REFERENCE = 0x00000200 -DS_REPSYNC_NEVER_COMPLETED = 0x00000400 -DS_REPSYNC_TWO_WAY = 0x00000800 -DS_REPSYNC_NEVER_NOTIFY = 0x00001000 -DS_REPSYNC_INITIAL = 0x00002000 -DS_REPSYNC_USE_COMPRESSION = 0x00004000 -DS_REPSYNC_ABANDONED = 0x00008000 -DS_REPSYNC_INITIAL_IN_PROGRESS = 0x00010000 -DS_REPSYNC_PARTIAL_ATTRIBUTE_SET = 0x00020000 -DS_REPSYNC_REQUEUE = 0x00040000 -DS_REPSYNC_NOTIFICATION = 0x00080000 -DS_REPSYNC_ASYNCHRONOUS_REPLICA = 0x00100000 -DS_REPSYNC_CRITICAL = 0x00200000 -DS_REPSYNC_FULL_IN_PROGRESS = 0x00400000 -DS_REPSYNC_PREEMPTED = 0x00800000 -DS_REPADD_ASYNCHRONOUS_OPERATION = 0x00000001 -DS_REPADD_WRITEABLE = 0x00000002 -DS_REPADD_INITIAL = 0x00000004 -DS_REPADD_PERIODIC = 0x00000008 -DS_REPADD_INTERSITE_MESSAGING = 0x00000010 -DS_REPADD_ASYNCHRONOUS_REPLICA = 0x00000020 -DS_REPADD_DISABLE_NOTIFICATION = 0x00000040 -DS_REPADD_DISABLE_PERIODIC = 0x00000080 -DS_REPADD_USE_COMPRESSION = 0x00000100 -DS_REPADD_NEVER_NOTIFY = 0x00000200 -DS_REPADD_TWO_WAY = 0x00000400 -DS_REPADD_CRITICAL = 0x00000800 -DS_REPDEL_ASYNCHRONOUS_OPERATION = 0x00000001 -DS_REPDEL_WRITEABLE = 0x00000002 -DS_REPDEL_INTERSITE_MESSAGING = 0x00000004 -DS_REPDEL_IGNORE_ERRORS = 0x00000008 -DS_REPDEL_LOCAL_ONLY = 0x00000010 -DS_REPDEL_NO_SOURCE = 0x00000020 -DS_REPDEL_REF_OK = 0x00000040 -DS_REPMOD_ASYNCHRONOUS_OPERATION = 0x00000001 -DS_REPMOD_WRITEABLE = 0x00000002 -DS_REPMOD_UPDATE_FLAGS = 0x00000001 -DS_REPMOD_UPDATE_ADDRESS = 0x00000002 -DS_REPMOD_UPDATE_SCHEDULE = 0x00000004 -DS_REPMOD_UPDATE_RESULT = 0x00000008 -DS_REPMOD_UPDATE_TRANSPORT = 0x00000010 -DS_REPUPD_ASYNCHRONOUS_OPERATION = 0x00000001 -DS_REPUPD_WRITEABLE = 0x00000002 -DS_REPUPD_ADD_REFERENCE = 0x00000004 -DS_REPUPD_DELETE_REFERENCE = 0x00000008 -DS_INSTANCETYPE_IS_NC_HEAD = 0x00000001 -DS_INSTANCETYPE_NC_IS_WRITEABLE = 0x00000004 -DS_INSTANCETYPE_NC_COMING = 0x00000010 -DS_INSTANCETYPE_NC_GOING = 0x00000020 -NTDSDSA_OPT_IS_GC = ( 1 << 0 ) -NTDSDSA_OPT_DISABLE_INBOUND_REPL = ( 1 << 1 ) -NTDSDSA_OPT_DISABLE_OUTBOUND_REPL = ( 1 << 2 ) -NTDSDSA_OPT_DISABLE_NTDSCONN_XLATE = ( 1 << 3 ) -NTDSCONN_OPT_IS_GENERATED = ( 1 << 0 ) -NTDSCONN_OPT_TWOWAY_SYNC = ( 1 << 1 ) -NTDSCONN_OPT_OVERRIDE_NOTIFY_DEFAULT = (1 << 2 ) -NTDSCONN_OPT_USE_NOTIFY = (1 << 3) -NTDSCONN_OPT_DISABLE_INTERSITE_COMPRESSION = (1 << 4) -NTDSCONN_OPT_USER_OWNED_SCHEDULE = (1 << 5) -NTDSCONN_KCC_NO_REASON = ( 0 ) -NTDSCONN_KCC_GC_TOPOLOGY = ( 1 << 0 ) -NTDSCONN_KCC_RING_TOPOLOGY = ( 1 << 1 ) -NTDSCONN_KCC_MINIMIZE_HOPS_TOPOLOGY = ( 1 << 2 ) -NTDSCONN_KCC_STALE_SERVERS_TOPOLOGY = ( 1 << 3 ) -NTDSCONN_KCC_OSCILLATING_CONNECTION_TOPOLOGY = ( 1 << 4 ) -NTDSCONN_KCC_INTERSITE_GC_TOPOLOGY = (1 << 5) -NTDSCONN_KCC_INTERSITE_TOPOLOGY = (1 << 6) -NTDSCONN_KCC_SERVER_FAILOVER_TOPOLOGY = (1 << 7) -NTDSCONN_KCC_SITE_FAILOVER_TOPOLOGY = (1 << 8) -NTDSCONN_KCC_REDUNDANT_SERVER_TOPOLOGY = (1 << 9) -FRSCONN_PRIORITY_MASK = 0x70000000 -FRSCONN_MAX_PRIORITY = 0x8 -NTDSCONN_OPT_IGNORE_SCHEDULE_MASK = (-2147483648) - -NTDSSETTINGS_OPT_IS_AUTO_TOPOLOGY_DISABLED = ( 1 << 0 ) -NTDSSETTINGS_OPT_IS_TOPL_CLEANUP_DISABLED = ( 1 << 1 ) -NTDSSETTINGS_OPT_IS_TOPL_MIN_HOPS_DISABLED = ( 1 << 2 ) -NTDSSETTINGS_OPT_IS_TOPL_DETECT_STALE_DISABLED = ( 1 << 3 ) -NTDSSETTINGS_OPT_IS_INTER_SITE_AUTO_TOPOLOGY_DISABLED = ( 1 << 4 ) -NTDSSETTINGS_OPT_IS_GROUP_CACHING_ENABLED = ( 1 << 5 ) -NTDSSETTINGS_OPT_FORCE_KCC_WHISTLER_BEHAVIOR = ( 1 << 6 ) -NTDSSETTINGS_OPT_FORCE_KCC_W2K_ELECTION = ( 1 << 7 ) -NTDSSETTINGS_OPT_IS_RAND_BH_SELECTION_DISABLED = ( 1 << 8 ) -NTDSSETTINGS_OPT_IS_SCHEDULE_HASHING_ENABLED = ( 1 << 9 ) -NTDSSETTINGS_OPT_IS_REDUNDANT_SERVER_TOPOLOGY_ENABLED = ( 1 << 10 ) -NTDSSETTINGS_DEFAULT_SERVER_REDUNDANCY = 2 -NTDSTRANSPORT_OPT_IGNORE_SCHEDULES = ( 1 << 0 ) -NTDSTRANSPORT_OPT_BRIDGES_REQUIRED = (1 << 1 ) -NTDSSITECONN_OPT_USE_NOTIFY = ( 1 << 0 ) -NTDSSITECONN_OPT_TWOWAY_SYNC = ( 1 << 1 ) -NTDSSITECONN_OPT_DISABLE_COMPRESSION = ( 1 << 2 ) -NTDSSITELINK_OPT_USE_NOTIFY = ( 1 << 0 ) -NTDSSITELINK_OPT_TWOWAY_SYNC = ( 1 << 1 ) -NTDSSITELINK_OPT_DISABLE_COMPRESSION = ( 1 << 2 ) -GUID_USERS_CONTAINER_A = "a9d1ca15768811d1aded00c04fd8d5cd" -GUID_COMPUTRS_CONTAINER_A = "aa312825768811d1aded00c04fd8d5cd" -GUID_SYSTEMS_CONTAINER_A = "ab1d30f3768811d1aded00c04fd8d5cd" -GUID_DOMAIN_CONTROLLERS_CONTAINER_A = "a361b2ffffd211d1aa4b00c04fd7d83a" -GUID_INFRASTRUCTURE_CONTAINER_A = "2fbac1870ade11d297c400c04fd8d5cd" -GUID_DELETED_OBJECTS_CONTAINER_A = "18e2ea80684f11d2b9aa00c04f79f805" -GUID_LOSTANDFOUND_CONTAINER_A = "ab8153b7768811d1aded00c04fd8d5cd" -GUID_FOREIGNSECURITYPRINCIPALS_CONTAINER_A = "22b70c67d56e4efb91e9300fca3dc1aa" -GUID_PROGRAM_DATA_CONTAINER_A = "09460c08ae1e4a4ea0f64aee7daa1e5a" -GUID_MICROSOFT_PROGRAM_DATA_CONTAINER_A = "f4be92a4c777485e878e9421d53087db" -GUID_NTDS_QUOTAS_CONTAINER_A = "6227f0af1fc2410d8e3bb10615bb5b0f" -GUID_USERS_CONTAINER_BYTE = "\xa9\xd1\xca\x15\x76\x88\x11\xd1\xad\xed\x00\xc0\x4f\xd8\xd5\xcd" -GUID_COMPUTRS_CONTAINER_BYTE = "\xaa\x31\x28\x25\x76\x88\x11\xd1\xad\xed\x00\xc0\x4f\xd8\xd5\xcd" -GUID_SYSTEMS_CONTAINER_BYTE = "\xab\x1d\x30\xf3\x76\x88\x11\xd1\xad\xed\x00\xc0\x4f\xd8\xd5\xcd" -GUID_DOMAIN_CONTROLLERS_CONTAINER_BYTE = "\xa3\x61\xb2\xff\xff\xd2\x11\xd1\xaa\x4b\x00\xc0\x4f\xd7\xd8\x3a" -GUID_INFRASTRUCTURE_CONTAINER_BYTE = "\x2f\xba\xc1\x87\x0a\xde\x11\xd2\x97\xc4\x00\xc0\x4f\xd8\xd5\xcd" -GUID_DELETED_OBJECTS_CONTAINER_BYTE = "\x18\xe2\xea\x80\x68\x4f\x11\xd2\xb9\xaa\x00\xc0\x4f\x79\xf8\x05" -GUID_LOSTANDFOUND_CONTAINER_BYTE = "\xab\x81\x53\xb7\x76\x88\x11\xd1\xad\xed\x00\xc0\x4f\xd8\xd5\xcd" -GUID_FOREIGNSECURITYPRINCIPALS_CONTAINER_BYTE = "\x22\xb7\x0c\x67\xd5\x6e\x4e\xfb\x91\xe9\x30\x0f\xca\x3d\xc1\xaa" -GUID_PROGRAM_DATA_CONTAINER_BYTE = "\x09\x46\x0c\x08\xae\x1e\x4a\x4e\xa0\xf6\x4a\xee\x7d\xaa\x1e\x5a" -GUID_MICROSOFT_PROGRAM_DATA_CONTAINER_BYTE = "\xf4\xbe\x92\xa4\xc7\x77\x48\x5e\x87\x8e\x94\x21\xd5\x30\x87\xdb" -GUID_NTDS_QUOTAS_CONTAINER_BYTE = "\x62\x27\xf0\xaf\x1f\xc2\x41\x0d\x8e\x3b\xb1\x06\x15\xbb\x5b\x0f" -DS_REPSYNCALL_NO_OPTIONS = 0x00000000 -DS_REPSYNCALL_ABORT_IF_SERVER_UNAVAILABLE = 0x00000001 -DS_REPSYNCALL_SYNC_ADJACENT_SERVERS_ONLY = 0x00000002 -DS_REPSYNCALL_ID_SERVERS_BY_DN = 0x00000004 -DS_REPSYNCALL_DO_NOT_SYNC = 0x00000008 -DS_REPSYNCALL_SKIP_INITIAL_CHECK = 0x00000010 -DS_REPSYNCALL_PUSH_CHANGES_OUTWARD = 0x00000020 -DS_REPSYNCALL_CROSS_SITE_BOUNDARIES = 0x00000040 -DS_LIST_DSA_OBJECT_FOR_SERVER = 0 -DS_LIST_DNS_HOST_NAME_FOR_SERVER = 1 -DS_LIST_ACCOUNT_OBJECT_FOR_SERVER = 2 -DS_ROLE_SCHEMA_OWNER = 0 -DS_ROLE_DOMAIN_OWNER = 1 -DS_ROLE_PDC_OWNER = 2 -DS_ROLE_RID_OWNER = 3 -DS_ROLE_INFRASTRUCTURE_OWNER = 4 -DS_SCHEMA_GUID_NOT_FOUND = 0 -DS_SCHEMA_GUID_ATTR = 1 -DS_SCHEMA_GUID_ATTR_SET = 2 -DS_SCHEMA_GUID_CLASS = 3 -DS_SCHEMA_GUID_CONTROL_RIGHT = 4 -DS_KCC_FLAG_ASYNC_OP = (1 << 0) -DS_KCC_FLAG_DAMPED = (1 << 1) -DS_EXIST_ADVISORY_MODE = (0x1) -DS_REPL_INFO_FLAG_IMPROVE_LINKED_ATTRS = (0x00000001) -DS_REPL_NBR_WRITEABLE = (0x00000010) -DS_REPL_NBR_SYNC_ON_STARTUP = (0x00000020) -DS_REPL_NBR_DO_SCHEDULED_SYNCS = (0x00000040) -DS_REPL_NBR_USE_ASYNC_INTERSITE_TRANSPORT = (0x00000080) -DS_REPL_NBR_TWO_WAY_SYNC = (0x00000200) -DS_REPL_NBR_RETURN_OBJECT_PARENTS = (0x00000800) -DS_REPL_NBR_FULL_SYNC_IN_PROGRESS = (0x00010000) -DS_REPL_NBR_FULL_SYNC_NEXT_PACKET = (0x00020000) -DS_REPL_NBR_NEVER_SYNCED = (0x00200000) -DS_REPL_NBR_PREEMPTED = (0x01000000) -DS_REPL_NBR_IGNORE_CHANGE_NOTIFICATIONS = (0x04000000) -DS_REPL_NBR_DISABLE_SCHEDULED_SYNC = (0x08000000) -DS_REPL_NBR_COMPRESS_CHANGES = (0x10000000) -DS_REPL_NBR_NO_CHANGE_NOTIFICATIONS = (0x20000000) -DS_REPL_NBR_PARTIAL_ATTRIBUTE_SET = (0x40000000) -DS_REPL_NBR_MODIFIABLE_MASK = \ - ( \ - DS_REPL_NBR_SYNC_ON_STARTUP | \ - DS_REPL_NBR_DO_SCHEDULED_SYNCS | \ - DS_REPL_NBR_TWO_WAY_SYNC | \ - DS_REPL_NBR_IGNORE_CHANGE_NOTIFICATIONS | \ - DS_REPL_NBR_DISABLE_SCHEDULED_SYNC | \ - DS_REPL_NBR_COMPRESS_CHANGES | \ - DS_REPL_NBR_NO_CHANGE_NOTIFICATIONS \ - ) - -# from enum DS_NAME_FORMAT -DS_UNKNOWN_NAME = 0 -DS_FQDN_1779_NAME = 1 -DS_NT4_ACCOUNT_NAME = 2 -DS_DISPLAY_NAME = 3 -DS_UNIQUE_ID_NAME = 6 -DS_CANONICAL_NAME = 7 -DS_USER_PRINCIPAL_NAME = 8 -DS_CANONICAL_NAME_EX = 9 -DS_SERVICE_PRINCIPAL_NAME = 10 -DS_SID_OR_SID_HISTORY_NAME = 11 -DS_DNS_DOMAIN_NAME = 12 - -DS_DOMAIN_SIMPLE_NAME = DS_USER_PRINCIPAL_NAME -DS_ENTERPRISE_SIMPLE_NAME = DS_USER_PRINCIPAL_NAME - -# from enum DS_NAME_FLAGS -DS_NAME_NO_FLAGS = 0x0 -DS_NAME_FLAG_SYNTACTICAL_ONLY = 0x1 -DS_NAME_FLAG_EVAL_AT_DC = 0x2 -DS_NAME_FLAG_GCVERIFY = 0x4 -DS_NAME_FLAG_TRUST_REFERRAL = 0x8 - -# from enum DS_NAME_ERROR -DS_NAME_NO_ERROR = 0 -DS_NAME_ERROR_RESOLVING = 1 -DS_NAME_ERROR_NOT_FOUND = 2 -DS_NAME_ERROR_NOT_UNIQUE = 3 -DS_NAME_ERROR_NO_MAPPING = 4 -DS_NAME_ERROR_DOMAIN_ONLY = 5 -DS_NAME_ERROR_NO_SYNTACTICAL_MAPPING = 6 -DS_NAME_ERROR_TRUST_REFERRAL = 7 - - -# from enum DS_SPN_NAME_TYPE -DS_SPN_DNS_HOST = 0 -DS_SPN_DN_HOST = 1 -DS_SPN_NB_HOST = 2 -DS_SPN_DOMAIN = 3 -DS_SPN_NB_DOMAIN = 4 -DS_SPN_SERVICE = 5 - -# from enum DS_SPN_WRITE_OP -DS_SPN_ADD_SPN_OP = 0 -DS_SPN_REPLACE_SPN_OP = 1 -DS_SPN_DELETE_SPN_OP = 2 - -# Generated by h2py from DsGetDC.h -DS_FORCE_REDISCOVERY = 0x00000001 -DS_DIRECTORY_SERVICE_REQUIRED = 0x00000010 -DS_DIRECTORY_SERVICE_PREFERRED = 0x00000020 -DS_GC_SERVER_REQUIRED = 0x00000040 -DS_PDC_REQUIRED = 0x00000080 -DS_BACKGROUND_ONLY = 0x00000100 -DS_IP_REQUIRED = 0x00000200 -DS_KDC_REQUIRED = 0x00000400 -DS_TIMESERV_REQUIRED = 0x00000800 -DS_WRITABLE_REQUIRED = 0x00001000 -DS_GOOD_TIMESERV_PREFERRED = 0x00002000 -DS_AVOID_SELF = 0x00004000 -DS_ONLY_LDAP_NEEDED = 0x00008000 -DS_IS_FLAT_NAME = 0x00010000 -DS_IS_DNS_NAME = 0x00020000 -DS_RETURN_DNS_NAME = 0x40000000 -DS_RETURN_FLAT_NAME = (-2147483648) -DSGETDC_VALID_FLAGS = ( \ - DS_FORCE_REDISCOVERY | \ - DS_DIRECTORY_SERVICE_REQUIRED | \ - DS_DIRECTORY_SERVICE_PREFERRED | \ - DS_GC_SERVER_REQUIRED | \ - DS_PDC_REQUIRED | \ - DS_BACKGROUND_ONLY | \ - DS_IP_REQUIRED | \ - DS_KDC_REQUIRED | \ - DS_TIMESERV_REQUIRED | \ - DS_WRITABLE_REQUIRED | \ - DS_GOOD_TIMESERV_PREFERRED | \ - DS_AVOID_SELF | \ - DS_ONLY_LDAP_NEEDED | \ - DS_IS_FLAT_NAME | \ - DS_IS_DNS_NAME | \ - DS_RETURN_FLAT_NAME | \ - DS_RETURN_DNS_NAME ) -DS_INET_ADDRESS = 1 -DS_NETBIOS_ADDRESS = 2 -DS_PDC_FLAG = 0x00000001 -DS_GC_FLAG = 0x00000004 -DS_LDAP_FLAG = 0x00000008 -DS_DS_FLAG = 0x00000010 -DS_KDC_FLAG = 0x00000020 -DS_TIMESERV_FLAG = 0x00000040 -DS_CLOSEST_FLAG = 0x00000080 -DS_WRITABLE_FLAG = 0x00000100 -DS_GOOD_TIMESERV_FLAG = 0x00000200 -DS_NDNC_FLAG = 0x00000400 -DS_PING_FLAGS = 0x0000FFFF -DS_DNS_CONTROLLER_FLAG = 0x20000000 -DS_DNS_DOMAIN_FLAG = 0x40000000 -DS_DNS_FOREST_FLAG = (-2147483648) -DS_DOMAIN_IN_FOREST = 0x0001 -DS_DOMAIN_DIRECT_OUTBOUND = 0x0002 -DS_DOMAIN_TREE_ROOT = 0x0004 -DS_DOMAIN_PRIMARY = 0x0008 -DS_DOMAIN_NATIVE_MODE = 0x0010 -DS_DOMAIN_DIRECT_INBOUND = 0x0020 -DS_DOMAIN_VALID_FLAGS = ( \ - DS_DOMAIN_IN_FOREST | \ - DS_DOMAIN_DIRECT_OUTBOUND | \ - DS_DOMAIN_TREE_ROOT | \ - DS_DOMAIN_PRIMARY | \ - DS_DOMAIN_NATIVE_MODE | \ - DS_DOMAIN_DIRECT_INBOUND ) -DS_GFTI_UPDATE_TDO = 0x1 -DS_GFTI_VALID_FLAGS = 0x1 -DS_ONLY_DO_SITE_NAME = 0x01 -DS_NOTIFY_AFTER_SITE_RECORDS = 0x02 -DS_OPEN_VALID_OPTION_FLAGS = ( DS_ONLY_DO_SITE_NAME | DS_NOTIFY_AFTER_SITE_RECORDS ) -DS_OPEN_VALID_FLAGS = ( \ - DS_FORCE_REDISCOVERY | \ - DS_ONLY_LDAP_NEEDED | \ - DS_KDC_REQUIRED | \ - DS_PDC_REQUIRED | \ - DS_GC_SERVER_REQUIRED | \ - DS_WRITABLE_REQUIRED ) - -## from aclui.h -# SI_OBJECT_INFO.dwFlags -SI_EDIT_PERMS = 0x00000000 -SI_EDIT_OWNER = 0x00000001 -SI_EDIT_AUDITS = 0x00000002 -SI_CONTAINER = 0x00000004 -SI_READONLY = 0x00000008 -SI_ADVANCED = 0x00000010 -SI_RESET = 0x00000020 -SI_OWNER_READONLY = 0x00000040 -SI_EDIT_PROPERTIES = 0x00000080 -SI_OWNER_RECURSE = 0x00000100 -SI_NO_ACL_PROTECT = 0x00000200 -SI_NO_TREE_APPLY = 0x00000400 -SI_PAGE_TITLE = 0x00000800 -SI_SERVER_IS_DC = 0x00001000 -SI_RESET_DACL_TREE = 0x00004000 -SI_RESET_SACL_TREE = 0x00008000 -SI_OBJECT_GUID = 0x00010000 -SI_EDIT_EFFECTIVE = 0x00020000 -SI_RESET_DACL = 0x00040000 -SI_RESET_SACL = 0x00080000 -SI_RESET_OWNER = 0x00100000 -SI_NO_ADDITIONAL_PERMISSION = 0x00200000 -SI_MAY_WRITE = 0x10000000 -SI_EDIT_ALL = (SI_EDIT_PERMS | SI_EDIT_OWNER | SI_EDIT_AUDITS) -SI_AUDITS_ELEVATION_REQUIRED = 0x02000000 -SI_VIEW_ONLY = 0x00400000 -SI_OWNER_ELEVATION_REQUIRED = 0x04000000 -SI_PERMS_ELEVATION_REQUIRED = 0x01000000 - -# SI_ACCESS.dwFlags -SI_ACCESS_SPECIFIC = 0x00010000 -SI_ACCESS_GENERAL = 0x00020000 -SI_ACCESS_CONTAINER = 0x00040000 -SI_ACCESS_PROPERTY = 0x00080000 - -# SI_PAGE_TYPE enum -SI_PAGE_PERM = 0 -SI_PAGE_ADVPERM = 1 -SI_PAGE_AUDIT = 2 -SI_PAGE_OWNER = 3 -SI_PAGE_EFFECTIVE =4 - -CFSTR_ACLUI_SID_INFO_LIST = "CFSTR_ACLUI_SID_INFO_LIST" -PSPCB_SI_INITDIALOG = 1025 ## WM_USER+1 diff --git a/typings/win32helper/sspicon.pyi b/typings/win32helper/sspicon.pyi deleted file mode 100644 index 1e61d498..00000000 --- a/typings/win32helper/sspicon.pyi +++ /dev/null @@ -1,479 +0,0 @@ -# Generated by h2py from c:\microsoft sdk\include\sspi.h -ISSP_LEVEL = 32 -ISSP_MODE = 1 -ISSP_LEVEL = 32 -ISSP_MODE = 0 -ISSP_LEVEL = 32 -ISSP_MODE = 1 -def SEC_SUCCESS(Status): return ((Status) >= 0) - -SECPKG_FLAG_INTEGRITY = 1 -SECPKG_FLAG_PRIVACY = 2 -SECPKG_FLAG_TOKEN_ONLY = 4 -SECPKG_FLAG_DATAGRAM = 8 -SECPKG_FLAG_CONNECTION = 16 -SECPKG_FLAG_MULTI_REQUIRED = 32 -SECPKG_FLAG_CLIENT_ONLY = 64 -SECPKG_FLAG_EXTENDED_ERROR = 128 -SECPKG_FLAG_IMPERSONATION = 256 -SECPKG_FLAG_ACCEPT_WIN32_NAME = 512 -SECPKG_FLAG_STREAM = 1024 -SECPKG_FLAG_NEGOTIABLE = 2048 -SECPKG_FLAG_GSS_COMPATIBLE = 4096 -SECPKG_FLAG_LOGON = 8192 -SECPKG_FLAG_ASCII_BUFFERS = 16384 -SECPKG_FLAG_FRAGMENT = 32768 -SECPKG_FLAG_MUTUAL_AUTH = 65536 -SECPKG_FLAG_DELEGATION = 131072 -SECPKG_FLAG_READONLY_WITH_CHECKSUM = 262144 -SECPKG_ID_NONE = 65535 - -SECBUFFER_VERSION = 0 -SECBUFFER_EMPTY = 0 -SECBUFFER_DATA = 1 -SECBUFFER_TOKEN = 2 -SECBUFFER_PKG_PARAMS = 3 -SECBUFFER_MISSING = 4 -SECBUFFER_EXTRA = 5 -SECBUFFER_STREAM_TRAILER = 6 -SECBUFFER_STREAM_HEADER = 7 -SECBUFFER_NEGOTIATION_INFO = 8 -SECBUFFER_PADDING = 9 -SECBUFFER_STREAM = 10 -SECBUFFER_MECHLIST = 11 -SECBUFFER_MECHLIST_SIGNATURE = 12 -SECBUFFER_TARGET = 13 -SECBUFFER_CHANNEL_BINDINGS = 14 -SECBUFFER_ATTRMASK = (-268435456) -SECBUFFER_READONLY = (-2147483648) -SECBUFFER_READONLY_WITH_CHECKSUM = 268435456 -SECBUFFER_RESERVED = 1610612736 - -SECURITY_NATIVE_DREP = 16 -SECURITY_NETWORK_DREP = 0 - -SECPKG_CRED_INBOUND = 1 -SECPKG_CRED_OUTBOUND = 2 -SECPKG_CRED_BOTH = 3 -SECPKG_CRED_DEFAULT = 4 -SECPKG_CRED_RESERVED = -268435456 - -ISC_REQ_DELEGATE = 1 -ISC_REQ_MUTUAL_AUTH = 2 -ISC_REQ_REPLAY_DETECT = 4 -ISC_REQ_SEQUENCE_DETECT = 8 -ISC_REQ_CONFIDENTIALITY = 16 -ISC_REQ_USE_SESSION_KEY = 32 -ISC_REQ_PROMPT_FOR_CREDS = 64 -ISC_REQ_USE_SUPPLIED_CREDS = 128 -ISC_REQ_ALLOCATE_MEMORY = 256 -ISC_REQ_USE_DCE_STYLE = 512 -ISC_REQ_DATAGRAM = 1024 -ISC_REQ_CONNECTION = 2048 -ISC_REQ_CALL_LEVEL = 4096 -ISC_REQ_FRAGMENT_SUPPLIED = 8192 -ISC_REQ_EXTENDED_ERROR = 16384 -ISC_REQ_STREAM = 32768 -ISC_REQ_INTEGRITY = 65536 -ISC_REQ_IDENTIFY = 131072 -ISC_REQ_NULL_SESSION = 262144 -ISC_REQ_MANUAL_CRED_VALIDATION = 524288 -ISC_REQ_RESERVED1 = 1048576 -ISC_REQ_FRAGMENT_TO_FIT = 2097152 -ISC_REQ_HTTP = 0x10000000 -ISC_RET_DELEGATE = 1 -ISC_RET_MUTUAL_AUTH = 2 -ISC_RET_REPLAY_DETECT = 4 -ISC_RET_SEQUENCE_DETECT = 8 -ISC_RET_CONFIDENTIALITY = 16 -ISC_RET_USE_SESSION_KEY = 32 -ISC_RET_USED_COLLECTED_CREDS = 64 -ISC_RET_USED_SUPPLIED_CREDS = 128 -ISC_RET_ALLOCATED_MEMORY = 256 -ISC_RET_USED_DCE_STYLE = 512 -ISC_RET_DATAGRAM = 1024 -ISC_RET_CONNECTION = 2048 -ISC_RET_INTERMEDIATE_RETURN = 4096 -ISC_RET_CALL_LEVEL = 8192 -ISC_RET_EXTENDED_ERROR = 16384 -ISC_RET_STREAM = 32768 -ISC_RET_INTEGRITY = 65536 -ISC_RET_IDENTIFY = 131072 -ISC_RET_NULL_SESSION = 262144 -ISC_RET_MANUAL_CRED_VALIDATION = 524288 -ISC_RET_RESERVED1 = 1048576 -ISC_RET_FRAGMENT_ONLY = 2097152 - -ASC_REQ_DELEGATE = 1 -ASC_REQ_MUTUAL_AUTH = 2 -ASC_REQ_REPLAY_DETECT = 4 -ASC_REQ_SEQUENCE_DETECT = 8 -ASC_REQ_CONFIDENTIALITY = 16 -ASC_REQ_USE_SESSION_KEY = 32 -ASC_REQ_ALLOCATE_MEMORY = 256 -ASC_REQ_USE_DCE_STYLE = 512 -ASC_REQ_DATAGRAM = 1024 -ASC_REQ_CONNECTION = 2048 -ASC_REQ_CALL_LEVEL = 4096 -ASC_REQ_EXTENDED_ERROR = 32768 -ASC_REQ_STREAM = 65536 -ASC_REQ_INTEGRITY = 131072 -ASC_REQ_LICENSING = 262144 -ASC_REQ_IDENTIFY = 524288 -ASC_REQ_ALLOW_NULL_SESSION = 1048576 -ASC_REQ_ALLOW_NON_USER_LOGONS = 2097152 -ASC_REQ_ALLOW_CONTEXT_REPLAY = 4194304 -ASC_REQ_FRAGMENT_TO_FIT = 8388608 -ASC_REQ_FRAGMENT_SUPPLIED = 8192 -ASC_REQ_NO_TOKEN = 16777216 -ASC_RET_DELEGATE = 1 -ASC_RET_MUTUAL_AUTH = 2 -ASC_RET_REPLAY_DETECT = 4 -ASC_RET_SEQUENCE_DETECT = 8 -ASC_RET_CONFIDENTIALITY = 16 -ASC_RET_USE_SESSION_KEY = 32 -ASC_RET_ALLOCATED_MEMORY = 256 -ASC_RET_USED_DCE_STYLE = 512 -ASC_RET_DATAGRAM = 1024 -ASC_RET_CONNECTION = 2048 -ASC_RET_CALL_LEVEL = 8192 -ASC_RET_THIRD_LEG_FAILED = 16384 -ASC_RET_EXTENDED_ERROR = 32768 -ASC_RET_STREAM = 65536 -ASC_RET_INTEGRITY = 131072 -ASC_RET_LICENSING = 262144 -ASC_RET_IDENTIFY = 524288 -ASC_RET_NULL_SESSION = 1048576 -ASC_RET_ALLOW_NON_USER_LOGONS = 2097152 -ASC_RET_ALLOW_CONTEXT_REPLAY = 4194304 -ASC_RET_FRAGMENT_ONLY = 8388608 - -SECPKG_CRED_ATTR_NAMES = 1 -SECPKG_ATTR_SIZES = 0 -SECPKG_ATTR_NAMES = 1 -SECPKG_ATTR_LIFESPAN = 2 -SECPKG_ATTR_DCE_INFO = 3 -SECPKG_ATTR_STREAM_SIZES = 4 -SECPKG_ATTR_KEY_INFO = 5 -SECPKG_ATTR_AUTHORITY = 6 -SECPKG_ATTR_PROTO_INFO = 7 -SECPKG_ATTR_PASSWORD_EXPIRY = 8 -SECPKG_ATTR_SESSION_KEY = 9 -SECPKG_ATTR_PACKAGE_INFO = 10 -SECPKG_ATTR_USER_FLAGS = 11 -SECPKG_ATTR_NEGOTIATION_INFO = 12 -SECPKG_ATTR_NATIVE_NAMES = 13 -SECPKG_ATTR_FLAGS = 14 -SECPKG_ATTR_USE_VALIDATED = 15 -SECPKG_ATTR_CREDENTIAL_NAME = 16 -SECPKG_ATTR_TARGET_INFORMATION = 17 -SECPKG_ATTR_ACCESS_TOKEN = 18 -SECPKG_ATTR_TARGET = 19 -SECPKG_ATTR_AUTHENTICATION_ID = 20 - -## attributes from schannel.h -SECPKG_ATTR_REMOTE_CERT_CONTEXT = 83 -SECPKG_ATTR_LOCAL_CERT_CONTEXT = 84 -SECPKG_ATTR_ROOT_STORE = 85 -SECPKG_ATTR_SUPPORTED_ALGS = 86 -SECPKG_ATTR_CIPHER_STRENGTHS = 87 -SECPKG_ATTR_SUPPORTED_PROTOCOLS = 88 -SECPKG_ATTR_ISSUER_LIST_EX = 89 -SECPKG_ATTR_CONNECTION_INFO = 90 -SECPKG_ATTR_EAP_KEY_BLOCK = 91 -SECPKG_ATTR_MAPPED_CRED_ATTR = 92 -SECPKG_ATTR_SESSION_INFO = 93 -SECPKG_ATTR_APP_DATA = 94 - -SECPKG_NEGOTIATION_COMPLETE = 0 -SECPKG_NEGOTIATION_OPTIMISTIC = 1 -SECPKG_NEGOTIATION_IN_PROGRESS = 2 -SECPKG_NEGOTIATION_DIRECT = 3 -SECPKG_NEGOTIATION_TRY_MULTICRED = 4 -SECPKG_CONTEXT_EXPORT_RESET_NEW = 1 -SECPKG_CONTEXT_EXPORT_DELETE_OLD = 2 -SECQOP_WRAP_NO_ENCRYPT = (-2147483647) -SECURITY_ENTRYPOINT_ANSIW = "InitSecurityInterfaceW" -SECURITY_ENTRYPOINT_ANSIA = "InitSecurityInterfaceA" -SECURITY_ENTRYPOINT16 = "INITSECURITYINTERFACEA" -SECURITY_ENTRYPOINT_ANSI = SECURITY_ENTRYPOINT_ANSIW -SECURITY_ENTRYPOINT_ANSI = SECURITY_ENTRYPOINT_ANSIA -SECURITY_ENTRYPOINT = SECURITY_ENTRYPOINT16 -SECURITY_ENTRYPOINT_ANSI = SECURITY_ENTRYPOINT16 -SECURITY_SUPPORT_PROVIDER_INTERFACE_VERSION = 1 -SECURITY_SUPPORT_PROVIDER_INTERFACE_VERSION_2 = 2 -SASL_OPTION_SEND_SIZE = 1 -SASL_OPTION_RECV_SIZE = 2 -SASL_OPTION_AUTHZ_STRING = 3 -SASL_OPTION_AUTHZ_PROCESSING = 4 -SEC_WINNT_AUTH_IDENTITY_ANSI = 1 -SEC_WINNT_AUTH_IDENTITY_UNICODE = 2 -SEC_WINNT_AUTH_IDENTITY_VERSION = 512 -SEC_WINNT_AUTH_IDENTITY_MARSHALLED = 4 -SEC_WINNT_AUTH_IDENTITY_ONLY = 8 -SECPKG_OPTIONS_TYPE_UNKNOWN = 0 -SECPKG_OPTIONS_TYPE_LSA = 1 -SECPKG_OPTIONS_TYPE_SSPI = 2 -SECPKG_OPTIONS_PERMANENT = 1 - -SEC_E_INSUFFICIENT_MEMORY = -2146893056 -SEC_E_INVALID_HANDLE = -2146893055 -SEC_E_UNSUPPORTED_FUNCTION = -2146893054 -SEC_E_TARGET_UNKNOWN = -2146893053 -SEC_E_INTERNAL_ERROR = -2146893052 -SEC_E_SECPKG_NOT_FOUND = -2146893051 -SEC_E_NOT_OWNER = -2146893050 -SEC_E_CANNOT_INSTALL = -2146893049 -SEC_E_INVALID_TOKEN = -2146893048 -SEC_E_CANNOT_PACK = -2146893047 -SEC_E_QOP_NOT_SUPPORTED = -2146893046 -SEC_E_NO_IMPERSONATION = -2146893045 -SEC_E_LOGON_DENIED = -2146893044 -SEC_E_UNKNOWN_CREDENTIALS = -2146893043 -SEC_E_NO_CREDENTIALS = -2146893042 -SEC_E_MESSAGE_ALTERED = -2146893041 -SEC_E_OUT_OF_SEQUENCE = -2146893040 -SEC_E_NO_AUTHENTICATING_AUTHORITY = -2146893039 -SEC_I_CONTINUE_NEEDED = 590610 -SEC_I_COMPLETE_NEEDED = 590611 -SEC_I_COMPLETE_AND_CONTINUE = 590612 -SEC_I_LOCAL_LOGON = 590613 -SEC_E_BAD_PKGID = -2146893034 -SEC_E_CONTEXT_EXPIRED = -2146893033 -SEC_I_CONTEXT_EXPIRED = 590615 -SEC_E_INCOMPLETE_MESSAGE = -2146893032 -SEC_E_INCOMPLETE_CREDENTIALS = -2146893024 -SEC_E_BUFFER_TOO_SMALL = -2146893023 -SEC_I_INCOMPLETE_CREDENTIALS = 590624 -SEC_I_RENEGOTIATE = 590625 -SEC_E_WRONG_PRINCIPAL = -2146893022 -SEC_I_NO_LSA_CONTEXT = 590627 -SEC_E_TIME_SKEW = -2146893020 -SEC_E_UNTRUSTED_ROOT = -2146893019 -SEC_E_ILLEGAL_MESSAGE = -2146893018 -SEC_E_CERT_UNKNOWN = -2146893017 -SEC_E_CERT_EXPIRED = -2146893016 -SEC_E_ENCRYPT_FAILURE = -2146893015 -SEC_E_DECRYPT_FAILURE = -2146893008 -SEC_E_ALGORITHM_MISMATCH = -2146893007 -SEC_E_SECURITY_QOS_FAILED = -2146893006 -SEC_E_UNFINISHED_CONTEXT_DELETED = -2146893005 -SEC_E_NO_TGT_REPLY = -2146893004 -SEC_E_NO_IP_ADDRESSES = -2146893003 -SEC_E_WRONG_CREDENTIAL_HANDLE = -2146893002 -SEC_E_CRYPTO_SYSTEM_INVALID = -2146893001 -SEC_E_MAX_REFERRALS_EXCEEDED = -2146893000 -SEC_E_MUST_BE_KDC = -2146892999 -SEC_E_STRONG_CRYPTO_NOT_SUPPORTED = -2146892998 -SEC_E_TOO_MANY_PRINCIPALS = -2146892997 -SEC_E_NO_PA_DATA = -2146892996 -SEC_E_PKINIT_NAME_MISMATCH = -2146892995 -SEC_E_SMARTCARD_LOGON_REQUIRED = -2146892994 -SEC_E_SHUTDOWN_IN_PROGRESS = -2146892993 -SEC_E_KDC_INVALID_REQUEST = -2146892992 -SEC_E_KDC_UNABLE_TO_REFER = -2146892991 -SEC_E_KDC_UNKNOWN_ETYPE = -2146892990 -SEC_E_UNSUPPORTED_PREAUTH = -2146892989 -SEC_E_DELEGATION_REQUIRED = -2146892987 -SEC_E_BAD_BINDINGS = -2146892986 -SEC_E_MULTIPLE_ACCOUNTS = -2146892985 -SEC_E_NO_KERB_KEY = -2146892984 - -ERROR_IPSEC_QM_POLICY_EXISTS = 13000 -ERROR_IPSEC_QM_POLICY_NOT_FOUND = 13001 -ERROR_IPSEC_QM_POLICY_IN_USE = 13002 -ERROR_IPSEC_MM_POLICY_EXISTS = 13003 -ERROR_IPSEC_MM_POLICY_NOT_FOUND = 13004 -ERROR_IPSEC_MM_POLICY_IN_USE = 13005 -ERROR_IPSEC_MM_FILTER_EXISTS = 13006 -ERROR_IPSEC_MM_FILTER_NOT_FOUND = 13007 -ERROR_IPSEC_TRANSPORT_FILTER_EXISTS = 13008 -ERROR_IPSEC_TRANSPORT_FILTER_NOT_FOUND = 13009 -ERROR_IPSEC_MM_AUTH_EXISTS = 13010 -ERROR_IPSEC_MM_AUTH_NOT_FOUND = 13011 -ERROR_IPSEC_MM_AUTH_IN_USE = 13012 -ERROR_IPSEC_DEFAULT_MM_POLICY_NOT_FOUND = 13013 -ERROR_IPSEC_DEFAULT_MM_AUTH_NOT_FOUND = 13014 -ERROR_IPSEC_DEFAULT_QM_POLICY_NOT_FOUND = 13015 -ERROR_IPSEC_TUNNEL_FILTER_EXISTS = 13016 -ERROR_IPSEC_TUNNEL_FILTER_NOT_FOUND = 13017 -ERROR_IPSEC_MM_FILTER_PENDING_DELETION = 13018 -ERROR_IPSEC_TRANSPORT_FILTER_PENDING_DELETION = 13019 -ERROR_IPSEC_TUNNEL_FILTER_PENDING_DELETION = 13020 -ERROR_IPSEC_MM_POLICY_PENDING_DELETION = 13021 -ERROR_IPSEC_MM_AUTH_PENDING_DELETION = 13022 -ERROR_IPSEC_QM_POLICY_PENDING_DELETION = 13023 -WARNING_IPSEC_MM_POLICY_PRUNED = 13024 -WARNING_IPSEC_QM_POLICY_PRUNED = 13025 -ERROR_IPSEC_IKE_NEG_STATUS_BEGIN = 13800 -ERROR_IPSEC_IKE_AUTH_FAIL = 13801 -ERROR_IPSEC_IKE_ATTRIB_FAIL = 13802 -ERROR_IPSEC_IKE_NEGOTIATION_PENDING = 13803 -ERROR_IPSEC_IKE_GENERAL_PROCESSING_ERROR = 13804 -ERROR_IPSEC_IKE_TIMED_OUT = 13805 -ERROR_IPSEC_IKE_NO_CERT = 13806 -ERROR_IPSEC_IKE_SA_DELETED = 13807 -ERROR_IPSEC_IKE_SA_REAPED = 13808 -ERROR_IPSEC_IKE_MM_ACQUIRE_DROP = 13809 -ERROR_IPSEC_IKE_QM_ACQUIRE_DROP = 13810 -ERROR_IPSEC_IKE_QUEUE_DROP_MM = 13811 -ERROR_IPSEC_IKE_QUEUE_DROP_NO_MM = 13812 -ERROR_IPSEC_IKE_DROP_NO_RESPONSE = 13813 -ERROR_IPSEC_IKE_MM_DELAY_DROP = 13814 -ERROR_IPSEC_IKE_QM_DELAY_DROP = 13815 -ERROR_IPSEC_IKE_ERROR = 13816 -ERROR_IPSEC_IKE_CRL_FAILED = 13817 -ERROR_IPSEC_IKE_INVALID_KEY_USAGE = 13818 -ERROR_IPSEC_IKE_INVALID_CERT_TYPE = 13819 -ERROR_IPSEC_IKE_NO_PRIVATE_KEY = 13820 -ERROR_IPSEC_IKE_DH_FAIL = 13822 -ERROR_IPSEC_IKE_INVALID_HEADER = 13824 -ERROR_IPSEC_IKE_NO_POLICY = 13825 -ERROR_IPSEC_IKE_INVALID_SIGNATURE = 13826 -ERROR_IPSEC_IKE_KERBEROS_ERROR = 13827 -ERROR_IPSEC_IKE_NO_PUBLIC_KEY = 13828 -ERROR_IPSEC_IKE_PROCESS_ERR = 13829 -ERROR_IPSEC_IKE_PROCESS_ERR_SA = 13830 -ERROR_IPSEC_IKE_PROCESS_ERR_PROP = 13831 -ERROR_IPSEC_IKE_PROCESS_ERR_TRANS = 13832 -ERROR_IPSEC_IKE_PROCESS_ERR_KE = 13833 -ERROR_IPSEC_IKE_PROCESS_ERR_ID = 13834 -ERROR_IPSEC_IKE_PROCESS_ERR_CERT = 13835 -ERROR_IPSEC_IKE_PROCESS_ERR_CERT_REQ = 13836 -ERROR_IPSEC_IKE_PROCESS_ERR_HASH = 13837 -ERROR_IPSEC_IKE_PROCESS_ERR_SIG = 13838 -ERROR_IPSEC_IKE_PROCESS_ERR_NONCE = 13839 -ERROR_IPSEC_IKE_PROCESS_ERR_NOTIFY = 13840 -ERROR_IPSEC_IKE_PROCESS_ERR_DELETE = 13841 -ERROR_IPSEC_IKE_PROCESS_ERR_VENDOR = 13842 -ERROR_IPSEC_IKE_INVALID_PAYLOAD = 13843 -ERROR_IPSEC_IKE_LOAD_SOFT_SA = 13844 -ERROR_IPSEC_IKE_SOFT_SA_TORN_DOWN = 13845 -ERROR_IPSEC_IKE_INVALID_COOKIE = 13846 -ERROR_IPSEC_IKE_NO_PEER_CERT = 13847 -ERROR_IPSEC_IKE_PEER_CRL_FAILED = 13848 -ERROR_IPSEC_IKE_POLICY_CHANGE = 13849 -ERROR_IPSEC_IKE_NO_MM_POLICY = 13850 -ERROR_IPSEC_IKE_NOTCBPRIV = 13851 -ERROR_IPSEC_IKE_SECLOADFAIL = 13852 -ERROR_IPSEC_IKE_FAILSSPINIT = 13853 -ERROR_IPSEC_IKE_FAILQUERYSSP = 13854 -ERROR_IPSEC_IKE_SRVACQFAIL = 13855 -ERROR_IPSEC_IKE_SRVQUERYCRED = 13856 -ERROR_IPSEC_IKE_GETSPIFAIL = 13857 -ERROR_IPSEC_IKE_INVALID_FILTER = 13858 -ERROR_IPSEC_IKE_OUT_OF_MEMORY = 13859 -ERROR_IPSEC_IKE_ADD_UPDATE_KEY_FAILED = 13860 -ERROR_IPSEC_IKE_INVALID_POLICY = 13861 -ERROR_IPSEC_IKE_UNKNOWN_DOI = 13862 -ERROR_IPSEC_IKE_INVALID_SITUATION = 13863 -ERROR_IPSEC_IKE_DH_FAILURE = 13864 -ERROR_IPSEC_IKE_INVALID_GROUP = 13865 -ERROR_IPSEC_IKE_ENCRYPT = 13866 -ERROR_IPSEC_IKE_DECRYPT = 13867 -ERROR_IPSEC_IKE_POLICY_MATCH = 13868 -ERROR_IPSEC_IKE_UNSUPPORTED_ID = 13869 -ERROR_IPSEC_IKE_INVALID_HASH = 13870 -ERROR_IPSEC_IKE_INVALID_HASH_ALG = 13871 -ERROR_IPSEC_IKE_INVALID_HASH_SIZE = 13872 -ERROR_IPSEC_IKE_INVALID_ENCRYPT_ALG = 13873 -ERROR_IPSEC_IKE_INVALID_AUTH_ALG = 13874 -ERROR_IPSEC_IKE_INVALID_SIG = 13875 -ERROR_IPSEC_IKE_LOAD_FAILED = 13876 -ERROR_IPSEC_IKE_RPC_DELETE = 13877 -ERROR_IPSEC_IKE_BENIGN_REINIT = 13878 -ERROR_IPSEC_IKE_INVALID_RESPONDER_LIFETIME_NOTIFY = 13879 -ERROR_IPSEC_IKE_INVALID_CERT_KEYLEN = 13881 -ERROR_IPSEC_IKE_MM_LIMIT = 13882 -ERROR_IPSEC_IKE_NEGOTIATION_DISABLED = 13883 -ERROR_IPSEC_IKE_NEG_STATUS_END = 13884 -CRYPT_E_MSG_ERROR = ((-2146889727)) -CRYPT_E_UNKNOWN_ALGO = ((-2146889726)) -CRYPT_E_OID_FORMAT = ((-2146889725)) -CRYPT_E_INVALID_MSG_TYPE = ((-2146889724)) -CRYPT_E_UNEXPECTED_ENCODING = ((-2146889723)) -CRYPT_E_AUTH_ATTR_MISSING = ((-2146889722)) -CRYPT_E_HASH_VALUE = ((-2146889721)) -CRYPT_E_INVALID_INDEX = ((-2146889720)) -CRYPT_E_ALREADY_DECRYPTED = ((-2146889719)) -CRYPT_E_NOT_DECRYPTED = ((-2146889718)) -CRYPT_E_RECIPIENT_NOT_FOUND = ((-2146889717)) -CRYPT_E_CONTROL_TYPE = ((-2146889716)) -CRYPT_E_ISSUER_SERIALNUMBER = ((-2146889715)) -CRYPT_E_SIGNER_NOT_FOUND = ((-2146889714)) -CRYPT_E_ATTRIBUTES_MISSING = ((-2146889713)) -CRYPT_E_STREAM_MSG_NOT_READY = ((-2146889712)) -CRYPT_E_STREAM_INSUFFICIENT_DATA = ((-2146889711)) -CRYPT_I_NEW_PROTECTION_REQUIRED = (593938) -CRYPT_E_BAD_LEN = ((-2146885631)) -CRYPT_E_BAD_ENCODE = ((-2146885630)) -CRYPT_E_FILE_ERROR = ((-2146885629)) -CRYPT_E_NOT_FOUND = ((-2146885628)) -CRYPT_E_EXISTS = ((-2146885627)) -CRYPT_E_NO_PROVIDER = ((-2146885626)) -CRYPT_E_SELF_SIGNED = ((-2146885625)) -CRYPT_E_DELETED_PREV = ((-2146885624)) -CRYPT_E_NO_MATCH = ((-2146885623)) -CRYPT_E_UNEXPECTED_MSG_TYPE = ((-2146885622)) -CRYPT_E_NO_KEY_PROPERTY = ((-2146885621)) -CRYPT_E_NO_DECRYPT_CERT = ((-2146885620)) -CRYPT_E_BAD_MSG = ((-2146885619)) -CRYPT_E_NO_SIGNER = ((-2146885618)) -CRYPT_E_PENDING_CLOSE = ((-2146885617)) -CRYPT_E_REVOKED = ((-2146885616)) -CRYPT_E_NO_REVOCATION_DLL = ((-2146885615)) -CRYPT_E_NO_REVOCATION_CHECK = ((-2146885614)) -CRYPT_E_REVOCATION_OFFLINE = ((-2146885613)) -CRYPT_E_NOT_IN_REVOCATION_DATABASE = ((-2146885612)) -CRYPT_E_INVALID_NUMERIC_STRING = ((-2146885600)) -CRYPT_E_INVALID_PRINTABLE_STRING = ((-2146885599)) -CRYPT_E_INVALID_IA5_STRING = ((-2146885598)) -CRYPT_E_INVALID_X500_STRING = ((-2146885597)) -CRYPT_E_NOT_CHAR_STRING = ((-2146885596)) -CRYPT_E_FILERESIZED = ((-2146885595)) -CRYPT_E_SECURITY_SETTINGS = ((-2146885594)) -CRYPT_E_NO_VERIFY_USAGE_DLL = ((-2146885593)) -CRYPT_E_NO_VERIFY_USAGE_CHECK = ((-2146885592)) -CRYPT_E_VERIFY_USAGE_OFFLINE = ((-2146885591)) -CRYPT_E_NOT_IN_CTL = ((-2146885590)) -CRYPT_E_NO_TRUSTED_SIGNER = ((-2146885589)) -CRYPT_E_MISSING_PUBKEY_PARA = ((-2146885588)) -CRYPT_E_OSS_ERROR = ((-2146881536)) - -## Kerberos message types for LsaCallAuthenticationPackage (from ntsecapi.h) -KerbDebugRequestMessage = 0 -KerbQueryTicketCacheMessage = 1 -KerbChangeMachinePasswordMessage = 2 -KerbVerifyPacMessage = 3 -KerbRetrieveTicketMessage = 4 -KerbUpdateAddressesMessage = 5 -KerbPurgeTicketCacheMessage = 6 -KerbChangePasswordMessage = 7 -KerbRetrieveEncodedTicketMessage = 8 -KerbDecryptDataMessage = 9 -KerbAddBindingCacheEntryMessage = 10 -KerbSetPasswordMessage = 11 -KerbSetPasswordExMessage = 12 -KerbVerifyCredentialsMessage = 13 -KerbQueryTicketCacheExMessage = 14 -KerbPurgeTicketCacheExMessage = 15 -KerbRefreshSmartcardCredentialsMessage = 16 -KerbAddExtraCredentialsMessage = 17 -KerbQuerySupplementalCredentialsMessage = 18 - -## messages used with msv1_0 from ntsecapi.h -MsV1_0Lm20ChallengeRequest = 0 -MsV1_0Lm20GetChallengeResponse = 1 -MsV1_0EnumerateUsers = 2 -MsV1_0GetUserInfo = 3 -MsV1_0ReLogonUsers = 4 -MsV1_0ChangePassword = 5 -MsV1_0ChangeCachedPassword = 6 -MsV1_0GenericPassthrough = 7 -MsV1_0CacheLogon = 8 -MsV1_0SubAuth = 9 -MsV1_0DeriveCredential = 10 -MsV1_0CacheLookup = 11 -MsV1_0SetProcessOption = 12 - -SEC_E_OK = 0 diff --git a/typings/win32helper/win32cryptcon.pyi b/typings/win32helper/win32cryptcon.pyi deleted file mode 100644 index 7ad7ed81..00000000 --- a/typings/win32helper/win32cryptcon.pyi +++ /dev/null @@ -1,1900 +0,0 @@ -# Generated by h2py from WinCrypt.h -def GET_ALG_CLASS(x): return (x & (7 << 13)) - -def GET_ALG_TYPE(x): return (x & (15 << 9)) - -def GET_ALG_SID(x): return (x & (511)) - -ALG_CLASS_ANY = (0) -ALG_CLASS_SIGNATURE = (1 << 13) -ALG_CLASS_MSG_ENCRYPT = (2 << 13) -ALG_CLASS_DATA_ENCRYPT = (3 << 13) -ALG_CLASS_HASH = (4 << 13) -ALG_CLASS_KEY_EXCHANGE = (5 << 13) -ALG_CLASS_ALL = (7 << 13) -ALG_TYPE_ANY = (0) -ALG_TYPE_DSS = (1 << 9) -ALG_TYPE_RSA = (2 << 9) -ALG_TYPE_BLOCK = (3 << 9) -ALG_TYPE_STREAM = (4 << 9) -ALG_TYPE_DH = (5 << 9) -ALG_TYPE_SECURECHANNEL = (6 << 9) -ALG_SID_ANY = (0) -ALG_SID_RSA_ANY = 0 -ALG_SID_RSA_PKCS = 1 -ALG_SID_RSA_MSATWORK = 2 -ALG_SID_RSA_ENTRUST = 3 -ALG_SID_RSA_PGP = 4 -ALG_SID_DSS_ANY = 0 -ALG_SID_DSS_PKCS = 1 -ALG_SID_DSS_DMS = 2 -ALG_SID_DES = 1 -ALG_SID_3DES = 3 -ALG_SID_DESX = 4 -ALG_SID_IDEA = 5 -ALG_SID_CAST = 6 -ALG_SID_SAFERSK64 = 7 -ALG_SID_SAFERSK128 = 8 -ALG_SID_3DES_112 = 9 -ALG_SID_CYLINK_MEK = 12 -ALG_SID_RC5 = 13 -ALG_SID_AES_128 = 14 -ALG_SID_AES_192 = 15 -ALG_SID_AES_256 = 16 -ALG_SID_AES = 17 -ALG_SID_SKIPJACK = 10 -ALG_SID_TEK = 11 -CRYPT_MODE_CBCI = 6 -CRYPT_MODE_CFBP = 7 -CRYPT_MODE_OFBP = 8 -CRYPT_MODE_CBCOFM = 9 -CRYPT_MODE_CBCOFMI = 10 -ALG_SID_RC2 = 2 -ALG_SID_RC4 = 1 -ALG_SID_SEAL = 2 -ALG_SID_DH_SANDF = 1 -ALG_SID_DH_EPHEM = 2 -ALG_SID_AGREED_KEY_ANY = 3 -ALG_SID_KEA = 4 -ALG_SID_MD2 = 1 -ALG_SID_MD4 = 2 -ALG_SID_MD5 = 3 -ALG_SID_SHA = 4 -ALG_SID_SHA1 = 4 -ALG_SID_MAC = 5 -ALG_SID_RIPEMD = 6 -ALG_SID_RIPEMD160 = 7 -ALG_SID_SSL3SHAMD5 = 8 -ALG_SID_HMAC = 9 -ALG_SID_TLS1PRF = 10 -ALG_SID_HASH_REPLACE_OWF = 11 -ALG_SID_SHA_256 = 12 -ALG_SID_SHA_384 = 13 -ALG_SID_SHA_512 = 14 -ALG_SID_SSL3_MASTER = 1 -ALG_SID_SCHANNEL_MASTER_HASH = 2 -ALG_SID_SCHANNEL_MAC_KEY = 3 -ALG_SID_PCT1_MASTER = 4 -ALG_SID_SSL2_MASTER = 5 -ALG_SID_TLS1_MASTER = 6 -ALG_SID_SCHANNEL_ENC_KEY = 7 -ALG_SID_EXAMPLE = 80 -CALG_MD2 = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_MD2) -CALG_MD4 = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_MD4) -CALG_MD5 = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_MD5) -CALG_SHA = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_SHA) -CALG_SHA1 = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_SHA1) -CALG_MAC = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_MAC) -CALG_RSA_SIGN = (ALG_CLASS_SIGNATURE | ALG_TYPE_RSA | ALG_SID_RSA_ANY) -CALG_DSS_SIGN = (ALG_CLASS_SIGNATURE | ALG_TYPE_DSS | ALG_SID_DSS_ANY) -CALG_NO_SIGN = (ALG_CLASS_SIGNATURE | ALG_TYPE_ANY | ALG_SID_ANY) -CALG_RSA_KEYX = (ALG_CLASS_KEY_EXCHANGE|ALG_TYPE_RSA|ALG_SID_RSA_ANY) -CALG_DES = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_DES) -CALG_3DES_112 = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_3DES_112) -CALG_3DES = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_3DES) -CALG_DESX = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_DESX) -CALG_RC2 = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_RC2) -CALG_RC4 = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_STREAM|ALG_SID_RC4) -CALG_SEAL = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_STREAM|ALG_SID_SEAL) -CALG_DH_SF = (ALG_CLASS_KEY_EXCHANGE|ALG_TYPE_DH|ALG_SID_DH_SANDF) -CALG_DH_EPHEM = (ALG_CLASS_KEY_EXCHANGE|ALG_TYPE_DH|ALG_SID_DH_EPHEM) -CALG_AGREEDKEY_ANY = (ALG_CLASS_KEY_EXCHANGE|ALG_TYPE_DH|ALG_SID_AGREED_KEY_ANY) -CALG_KEA_KEYX = (ALG_CLASS_KEY_EXCHANGE|ALG_TYPE_DH|ALG_SID_KEA) -CALG_HUGHES_MD5 = (ALG_CLASS_KEY_EXCHANGE|ALG_TYPE_ANY|ALG_SID_MD5) -CALG_SKIPJACK = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_SKIPJACK) -CALG_TEK = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_TEK) -CALG_CYLINK_MEK = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_CYLINK_MEK) -CALG_SSL3_SHAMD5 = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_SSL3SHAMD5) -CALG_SSL3_MASTER = (ALG_CLASS_MSG_ENCRYPT|ALG_TYPE_SECURECHANNEL|ALG_SID_SSL3_MASTER) -CALG_SCHANNEL_MASTER_HASH = (ALG_CLASS_MSG_ENCRYPT|ALG_TYPE_SECURECHANNEL|ALG_SID_SCHANNEL_MASTER_HASH) -CALG_SCHANNEL_MAC_KEY = (ALG_CLASS_MSG_ENCRYPT|ALG_TYPE_SECURECHANNEL|ALG_SID_SCHANNEL_MAC_KEY) -CALG_SCHANNEL_ENC_KEY = (ALG_CLASS_MSG_ENCRYPT|ALG_TYPE_SECURECHANNEL|ALG_SID_SCHANNEL_ENC_KEY) -CALG_PCT1_MASTER = (ALG_CLASS_MSG_ENCRYPT|ALG_TYPE_SECURECHANNEL|ALG_SID_PCT1_MASTER) -CALG_SSL2_MASTER = (ALG_CLASS_MSG_ENCRYPT|ALG_TYPE_SECURECHANNEL|ALG_SID_SSL2_MASTER) -CALG_TLS1_MASTER = (ALG_CLASS_MSG_ENCRYPT|ALG_TYPE_SECURECHANNEL|ALG_SID_TLS1_MASTER) -CALG_RC5 = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_RC5) -CALG_HMAC = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_HMAC) -CALG_TLS1PRF = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_TLS1PRF) -CALG_HASH_REPLACE_OWF = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_HASH_REPLACE_OWF) -CALG_AES_128 = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_AES_128) -CALG_AES_192 = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_AES_192) -CALG_AES_256 = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_AES_256) -CALG_AES = (ALG_CLASS_DATA_ENCRYPT|ALG_TYPE_BLOCK|ALG_SID_AES) -CALG_SHA_256 = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_SHA_256) -CALG_SHA_384 = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_SHA_384) -CALG_SHA_512 = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_SHA_512) -CRYPT_VERIFYCONTEXT = (-268435456) -CRYPT_NEWKEYSET = 0x00000008 -CRYPT_DELETEKEYSET = 0x00000010 -CRYPT_MACHINE_KEYSET = 0x00000020 -CRYPT_SILENT = 0x00000040 -CRYPT_EXPORTABLE = 0x00000001 -CRYPT_USER_PROTECTED = 0x00000002 -CRYPT_CREATE_SALT = 0x00000004 -CRYPT_UPDATE_KEY = 0x00000008 -CRYPT_NO_SALT = 0x00000010 -CRYPT_PREGEN = 0x00000040 -CRYPT_RECIPIENT = 0x00000010 -CRYPT_INITIATOR = 0x00000040 -CRYPT_ONLINE = 0x00000080 -CRYPT_SF = 0x00000100 -CRYPT_CREATE_IV = 0x00000200 -CRYPT_KEK = 0x00000400 -CRYPT_DATA_KEY = 0x00000800 -CRYPT_VOLATILE = 0x00001000 -CRYPT_SGCKEY = 0x00002000 -CRYPT_ARCHIVABLE = 0x00004000 -RSA1024BIT_KEY = 0x04000000 -CRYPT_SERVER = 0x00000400 -KEY_LENGTH_MASK = (-65536) -CRYPT_Y_ONLY = 0x00000001 -CRYPT_SSL2_FALLBACK = 0x00000002 -CRYPT_DESTROYKEY = 0x00000004 -CRYPT_OAEP = 0x00000040 -CRYPT_BLOB_VER3 = 0x00000080 -CRYPT_IPSEC_HMAC_KEY = 0x00000100 -CRYPT_DECRYPT_RSA_NO_PADDING_CHECK = 0x00000020 -CRYPT_SECRETDIGEST = 0x00000001 -CRYPT_OWF_REPL_LM_HASH = 0x00000001 -CRYPT_LITTLE_ENDIAN = 0x00000001 -CRYPT_NOHASHOID = 0x00000001 -CRYPT_TYPE2_FORMAT = 0x00000002 -CRYPT_X931_FORMAT = 0x00000004 -CRYPT_MACHINE_DEFAULT = 0x00000001 -CRYPT_USER_DEFAULT = 0x00000002 -CRYPT_DELETE_DEFAULT = 0x00000004 -SIMPLEBLOB = 0x1 -PUBLICKEYBLOB = 0x6 -PRIVATEKEYBLOB = 0x7 -PLAINTEXTKEYBLOB = 0x8 -OPAQUEKEYBLOB = 0x9 -PUBLICKEYBLOBEX = 0xA -SYMMETRICWRAPKEYBLOB = 0xB -AT_KEYEXCHANGE = 1 -AT_SIGNATURE = 2 -CRYPT_USERDATA = 1 -KP_IV = 1 -KP_SALT = 2 -KP_PADDING = 3 -KP_MODE = 4 -KP_MODE_BITS = 5 -KP_PERMISSIONS = 6 -KP_ALGID = 7 -KP_BLOCKLEN = 8 -KP_KEYLEN = 9 -KP_SALT_EX = 10 -KP_P = 11 -KP_G = 12 -KP_Q = 13 -KP_X = 14 -KP_Y = 15 -KP_RA = 16 -KP_RB = 17 -KP_INFO = 18 -KP_EFFECTIVE_KEYLEN = 19 -KP_SCHANNEL_ALG = 20 -KP_CLIENT_RANDOM = 21 -KP_SERVER_RANDOM = 22 -KP_RP = 23 -KP_PRECOMP_MD5 = 24 -KP_PRECOMP_SHA = 25 -KP_CERTIFICATE = 26 -KP_CLEAR_KEY = 27 -KP_PUB_EX_LEN = 28 -KP_PUB_EX_VAL = 29 -KP_KEYVAL = 30 -KP_ADMIN_PIN = 31 -KP_KEYEXCHANGE_PIN = 32 -KP_SIGNATURE_PIN = 33 -KP_PREHASH = 34 -KP_ROUNDS = 35 -KP_OAEP_PARAMS = 36 -KP_CMS_KEY_INFO = 37 -KP_CMS_DH_KEY_INFO = 38 -KP_PUB_PARAMS = 39 -KP_VERIFY_PARAMS = 40 -KP_HIGHEST_VERSION = 41 -KP_GET_USE_COUNT = 42 -PKCS5_PADDING = 1 -RANDOM_PADDING = 2 -ZERO_PADDING = 3 -CRYPT_MODE_CBC = 1 -CRYPT_MODE_ECB = 2 -CRYPT_MODE_OFB = 3 -CRYPT_MODE_CFB = 4 -CRYPT_MODE_CTS = 5 -CRYPT_ENCRYPT = 0x0001 -CRYPT_DECRYPT = 0x0002 -CRYPT_EXPORT = 0x0004 -CRYPT_READ = 0x0008 -CRYPT_WRITE = 0x0010 -CRYPT_MAC = 0x0020 -CRYPT_EXPORT_KEY = 0x0040 -CRYPT_IMPORT_KEY = 0x0080 -CRYPT_ARCHIVE = 0x0100 -HP_ALGID = 0x0001 -HP_HASHVAL = 0x0002 -HP_HASHSIZE = 0x0004 -HP_HMAC_INFO = 0x0005 -HP_TLS1PRF_LABEL = 0x0006 -HP_TLS1PRF_SEED = 0x0007 - -CRYPT_FAILED = 0 -CRYPT_SUCCEED = 1 -def RCRYPT_SUCCEEDED(rt): return ((rt) == CRYPT_SUCCEED) -def RCRYPT_FAILED(rt): return ((rt) == CRYPT_FAILED) - -PP_ENUMALGS = 1 -PP_ENUMCONTAINERS = 2 -PP_IMPTYPE = 3 -PP_NAME = 4 -PP_VERSION = 5 -PP_CONTAINER = 6 -PP_CHANGE_PASSWORD = 7 -PP_KEYSET_SEC_DESCR = 8 -PP_CERTCHAIN = 9 -PP_KEY_TYPE_SUBTYPE = 10 -PP_PROVTYPE = 16 -PP_KEYSTORAGE = 17 -PP_APPLI_CERT = 18 -PP_SYM_KEYSIZE = 19 -PP_SESSION_KEYSIZE = 20 -PP_UI_PROMPT = 21 -PP_ENUMALGS_EX = 22 -PP_ENUMMANDROOTS = 25 -PP_ENUMELECTROOTS = 26 -PP_KEYSET_TYPE = 27 -PP_ADMIN_PIN = 31 -PP_KEYEXCHANGE_PIN = 32 -PP_SIGNATURE_PIN = 33 -PP_SIG_KEYSIZE_INC = 34 -PP_KEYX_KEYSIZE_INC = 35 -PP_UNIQUE_CONTAINER = 36 -PP_SGC_INFO = 37 -PP_USE_HARDWARE_RNG = 38 -PP_KEYSPEC = 39 -PP_ENUMEX_SIGNING_PROT = 40 -PP_CRYPT_COUNT_KEY_USE = 41 -CRYPT_FIRST = 1 -CRYPT_NEXT = 2 -CRYPT_SGC_ENUM = 4 -CRYPT_IMPL_HARDWARE = 1 -CRYPT_IMPL_SOFTWARE = 2 -CRYPT_IMPL_MIXED = 3 -CRYPT_IMPL_UNKNOWN = 4 -CRYPT_IMPL_REMOVABLE = 8 -CRYPT_SEC_DESCR = 0x00000001 -CRYPT_PSTORE = 0x00000002 -CRYPT_UI_PROMPT = 0x00000004 -CRYPT_FLAG_PCT1 = 0x0001 -CRYPT_FLAG_SSL2 = 0x0002 -CRYPT_FLAG_SSL3 = 0x0004 -CRYPT_FLAG_TLS1 = 0x0008 -CRYPT_FLAG_IPSEC = 0x0010 -CRYPT_FLAG_SIGNING = 0x0020 -CRYPT_SGC = 0x0001 -CRYPT_FASTSGC = 0x0002 -PP_CLIENT_HWND = 1 -PP_CONTEXT_INFO = 11 -PP_KEYEXCHANGE_KEYSIZE = 12 -PP_SIGNATURE_KEYSIZE = 13 -PP_KEYEXCHANGE_ALG = 14 -PP_SIGNATURE_ALG = 15 -PP_DELETEKEY = 24 -PROV_RSA_FULL = 1 -PROV_RSA_SIG = 2 -PROV_DSS = 3 -PROV_FORTEZZA = 4 -PROV_MS_EXCHANGE = 5 -PROV_SSL = 6 -PROV_RSA_SCHANNEL = 12 -PROV_DSS_DH = 13 -PROV_EC_ECDSA_SIG = 14 -PROV_EC_ECNRA_SIG = 15 -PROV_EC_ECDSA_FULL = 16 -PROV_EC_ECNRA_FULL = 17 -PROV_DH_SCHANNEL = 18 -PROV_SPYRUS_LYNKS = 20 -PROV_RNG = 21 -PROV_INTEL_SEC = 22 -PROV_REPLACE_OWF = 23 -PROV_RSA_AES = 24 -MS_DEF_PROV_A = "Microsoft Base Cryptographic Provider v1.0" -MS_DEF_PROV = MS_DEF_PROV_A -MS_ENHANCED_PROV_A = "Microsoft Enhanced Cryptographic Provider v1.0" -MS_ENHANCED_PROV = MS_ENHANCED_PROV_A -MS_STRONG_PROV_A = "Microsoft Strong Cryptographic Provider" -MS_STRONG_PROV = MS_STRONG_PROV_A -MS_DEF_RSA_SIG_PROV_A = "Microsoft RSA Signature Cryptographic Provider" -MS_DEF_RSA_SIG_PROV = MS_DEF_RSA_SIG_PROV_A -MS_DEF_RSA_SCHANNEL_PROV_A = "Microsoft RSA SChannel Cryptographic Provider" -MS_DEF_RSA_SCHANNEL_PROV = MS_DEF_RSA_SCHANNEL_PROV_A -MS_DEF_DSS_PROV_A = "Microsoft Base DSS Cryptographic Provider" -MS_DEF_DSS_PROV = MS_DEF_DSS_PROV_A -MS_DEF_DSS_DH_PROV_A = "Microsoft Base DSS and Diffie-Hellman Cryptographic Provider" -MS_DEF_DSS_DH_PROV = MS_DEF_DSS_DH_PROV_A -MS_ENH_DSS_DH_PROV_A = "Microsoft Enhanced DSS and Diffie-Hellman Cryptographic Provider" -MS_ENH_DSS_DH_PROV = MS_ENH_DSS_DH_PROV_A -MS_DEF_DH_SCHANNEL_PROV_A = "Microsoft DH SChannel Cryptographic Provider" -MS_DEF_DH_SCHANNEL_PROV = MS_DEF_DH_SCHANNEL_PROV_A -MS_SCARD_PROV_A = "Microsoft Base Smart Card Crypto Provider" -MS_SCARD_PROV = MS_SCARD_PROV_A -MS_ENH_RSA_AES_PROV_A = "Microsoft Enhanced RSA and AES Cryptographic Provider" -MS_ENH_RSA_AES_PROV = MS_ENH_RSA_AES_PROV_A -MAXUIDLEN = 64 -EXPO_OFFLOAD_REG_VALUE = "ExpoOffload" -EXPO_OFFLOAD_FUNC_NAME = "OffloadModExpo" -szKEY_CRYPTOAPI_PRIVATE_KEY_OPTIONS = \ - "Software\\Policies\\Microsoft\\Cryptography" -szFORCE_KEY_PROTECTION = "ForceKeyProtection" -dwFORCE_KEY_PROTECTION_DISABLED = 0x0 -dwFORCE_KEY_PROTECTION_USER_SELECT = 0x1 -dwFORCE_KEY_PROTECTION_HIGH = 0x2 -szKEY_CACHE_ENABLED = "CachePrivateKeys" -szKEY_CACHE_SECONDS = "PrivateKeyLifetimeSeconds" -CUR_BLOB_VERSION = 2 -SCHANNEL_MAC_KEY = 0x00000000 -SCHANNEL_ENC_KEY = 0x00000001 -INTERNATIONAL_USAGE = 0x00000001 -szOID_RSA = "1.2.840.113549" -szOID_PKCS = "1.2.840.113549.1" -szOID_RSA_HASH = "1.2.840.113549.2" -szOID_RSA_ENCRYPT = "1.2.840.113549.3" -szOID_PKCS_1 = "1.2.840.113549.1.1" -szOID_PKCS_2 = "1.2.840.113549.1.2" -szOID_PKCS_3 = "1.2.840.113549.1.3" -szOID_PKCS_4 = "1.2.840.113549.1.4" -szOID_PKCS_5 = "1.2.840.113549.1.5" -szOID_PKCS_6 = "1.2.840.113549.1.6" -szOID_PKCS_7 = "1.2.840.113549.1.7" -szOID_PKCS_8 = "1.2.840.113549.1.8" -szOID_PKCS_9 = "1.2.840.113549.1.9" -szOID_PKCS_10 = "1.2.840.113549.1.10" -szOID_PKCS_12 = "1.2.840.113549.1.12" -szOID_RSA_RSA = "1.2.840.113549.1.1.1" -szOID_RSA_MD2RSA = "1.2.840.113549.1.1.2" -szOID_RSA_MD4RSA = "1.2.840.113549.1.1.3" -szOID_RSA_MD5RSA = "1.2.840.113549.1.1.4" -szOID_RSA_SHA1RSA = "1.2.840.113549.1.1.5" -szOID_RSA_SETOAEP_RSA = "1.2.840.113549.1.1.6" -szOID_RSA_DH = "1.2.840.113549.1.3.1" -szOID_RSA_data = "1.2.840.113549.1.7.1" -szOID_RSA_signedData = "1.2.840.113549.1.7.2" -szOID_RSA_envelopedData = "1.2.840.113549.1.7.3" -szOID_RSA_signEnvData = "1.2.840.113549.1.7.4" -szOID_RSA_digestedData = "1.2.840.113549.1.7.5" -szOID_RSA_hashedData = "1.2.840.113549.1.7.5" -szOID_RSA_encryptedData = "1.2.840.113549.1.7.6" -szOID_RSA_emailAddr = "1.2.840.113549.1.9.1" -szOID_RSA_unstructName = "1.2.840.113549.1.9.2" -szOID_RSA_contentType = "1.2.840.113549.1.9.3" -szOID_RSA_messageDigest = "1.2.840.113549.1.9.4" -szOID_RSA_signingTime = "1.2.840.113549.1.9.5" -szOID_RSA_counterSign = "1.2.840.113549.1.9.6" -szOID_RSA_challengePwd = "1.2.840.113549.1.9.7" -szOID_RSA_unstructAddr = "1.2.840.113549.1.9.8" -szOID_RSA_extCertAttrs = "1.2.840.113549.1.9.9" -szOID_RSA_certExtensions = "1.2.840.113549.1.9.14" -szOID_RSA_SMIMECapabilities = "1.2.840.113549.1.9.15" -szOID_RSA_preferSignedData = "1.2.840.113549.1.9.15.1" -szOID_RSA_SMIMEalg = "1.2.840.113549.1.9.16.3" -szOID_RSA_SMIMEalgESDH = "1.2.840.113549.1.9.16.3.5" -szOID_RSA_SMIMEalgCMS3DESwrap = "1.2.840.113549.1.9.16.3.6" -szOID_RSA_SMIMEalgCMSRC2wrap = "1.2.840.113549.1.9.16.3.7" -szOID_RSA_MD2 = "1.2.840.113549.2.2" -szOID_RSA_MD4 = "1.2.840.113549.2.4" -szOID_RSA_MD5 = "1.2.840.113549.2.5" -szOID_RSA_RC2CBC = "1.2.840.113549.3.2" -szOID_RSA_RC4 = "1.2.840.113549.3.4" -szOID_RSA_DES_EDE3_CBC = "1.2.840.113549.3.7" -szOID_RSA_RC5_CBCPad = "1.2.840.113549.3.9" -szOID_ANSI_X942 = "1.2.840.10046" -szOID_ANSI_X942_DH = "1.2.840.10046.2.1" -szOID_X957 = "1.2.840.10040" -szOID_X957_DSA = "1.2.840.10040.4.1" -szOID_X957_SHA1DSA = "1.2.840.10040.4.3" -szOID_DS = "2.5" -szOID_DSALG = "2.5.8" -szOID_DSALG_CRPT = "2.5.8.1" -szOID_DSALG_HASH = "2.5.8.2" -szOID_DSALG_SIGN = "2.5.8.3" -szOID_DSALG_RSA = "2.5.8.1.1" -szOID_OIW = "1.3.14" -szOID_OIWSEC = "1.3.14.3.2" -szOID_OIWSEC_md4RSA = "1.3.14.3.2.2" -szOID_OIWSEC_md5RSA = "1.3.14.3.2.3" -szOID_OIWSEC_md4RSA2 = "1.3.14.3.2.4" -szOID_OIWSEC_desECB = "1.3.14.3.2.6" -szOID_OIWSEC_desCBC = "1.3.14.3.2.7" -szOID_OIWSEC_desOFB = "1.3.14.3.2.8" -szOID_OIWSEC_desCFB = "1.3.14.3.2.9" -szOID_OIWSEC_desMAC = "1.3.14.3.2.10" -szOID_OIWSEC_rsaSign = "1.3.14.3.2.11" -szOID_OIWSEC_dsa = "1.3.14.3.2.12" -szOID_OIWSEC_shaDSA = "1.3.14.3.2.13" -szOID_OIWSEC_mdc2RSA = "1.3.14.3.2.14" -szOID_OIWSEC_shaRSA = "1.3.14.3.2.15" -szOID_OIWSEC_dhCommMod = "1.3.14.3.2.16" -szOID_OIWSEC_desEDE = "1.3.14.3.2.17" -szOID_OIWSEC_sha = "1.3.14.3.2.18" -szOID_OIWSEC_mdc2 = "1.3.14.3.2.19" -szOID_OIWSEC_dsaComm = "1.3.14.3.2.20" -szOID_OIWSEC_dsaCommSHA = "1.3.14.3.2.21" -szOID_OIWSEC_rsaXchg = "1.3.14.3.2.22" -szOID_OIWSEC_keyHashSeal = "1.3.14.3.2.23" -szOID_OIWSEC_md2RSASign = "1.3.14.3.2.24" -szOID_OIWSEC_md5RSASign = "1.3.14.3.2.25" -szOID_OIWSEC_sha1 = "1.3.14.3.2.26" -szOID_OIWSEC_dsaSHA1 = "1.3.14.3.2.27" -szOID_OIWSEC_dsaCommSHA1 = "1.3.14.3.2.28" -szOID_OIWSEC_sha1RSASign = "1.3.14.3.2.29" -szOID_OIWDIR = "1.3.14.7.2" -szOID_OIWDIR_CRPT = "1.3.14.7.2.1" -szOID_OIWDIR_HASH = "1.3.14.7.2.2" -szOID_OIWDIR_SIGN = "1.3.14.7.2.3" -szOID_OIWDIR_md2 = "1.3.14.7.2.2.1" -szOID_OIWDIR_md2RSA = "1.3.14.7.2.3.1" -szOID_INFOSEC = "2.16.840.1.101.2.1" -szOID_INFOSEC_sdnsSignature = "2.16.840.1.101.2.1.1.1" -szOID_INFOSEC_mosaicSignature = "2.16.840.1.101.2.1.1.2" -szOID_INFOSEC_sdnsConfidentiality = "2.16.840.1.101.2.1.1.3" -szOID_INFOSEC_mosaicConfidentiality = "2.16.840.1.101.2.1.1.4" -szOID_INFOSEC_sdnsIntegrity = "2.16.840.1.101.2.1.1.5" -szOID_INFOSEC_mosaicIntegrity = "2.16.840.1.101.2.1.1.6" -szOID_INFOSEC_sdnsTokenProtection = "2.16.840.1.101.2.1.1.7" -szOID_INFOSEC_mosaicTokenProtection = "2.16.840.1.101.2.1.1.8" -szOID_INFOSEC_sdnsKeyManagement = "2.16.840.1.101.2.1.1.9" -szOID_INFOSEC_mosaicKeyManagement = "2.16.840.1.101.2.1.1.10" -szOID_INFOSEC_sdnsKMandSig = "2.16.840.1.101.2.1.1.11" -szOID_INFOSEC_mosaicKMandSig = "2.16.840.1.101.2.1.1.12" -szOID_INFOSEC_SuiteASignature = "2.16.840.1.101.2.1.1.13" -szOID_INFOSEC_SuiteAConfidentiality = "2.16.840.1.101.2.1.1.14" -szOID_INFOSEC_SuiteAIntegrity = "2.16.840.1.101.2.1.1.15" -szOID_INFOSEC_SuiteATokenProtection = "2.16.840.1.101.2.1.1.16" -szOID_INFOSEC_SuiteAKeyManagement = "2.16.840.1.101.2.1.1.17" -szOID_INFOSEC_SuiteAKMandSig = "2.16.840.1.101.2.1.1.18" -szOID_INFOSEC_mosaicUpdatedSig = "2.16.840.1.101.2.1.1.19" -szOID_INFOSEC_mosaicKMandUpdSig = "2.16.840.1.101.2.1.1.20" -szOID_INFOSEC_mosaicUpdatedInteg = "2.16.840.1.101.2.1.1.21" -szOID_COMMON_NAME = "2.5.4.3" -szOID_SUR_NAME = "2.5.4.4" -szOID_DEVICE_SERIAL_NUMBER = "2.5.4.5" -szOID_COUNTRY_NAME = "2.5.4.6" -szOID_LOCALITY_NAME = "2.5.4.7" -szOID_STATE_OR_PROVINCE_NAME = "2.5.4.8" -szOID_STREET_ADDRESS = "2.5.4.9" -szOID_ORGANIZATION_NAME = "2.5.4.10" -szOID_ORGANIZATIONAL_UNIT_NAME = "2.5.4.11" -szOID_TITLE = "2.5.4.12" -szOID_DESCRIPTION = "2.5.4.13" -szOID_SEARCH_GUIDE = "2.5.4.14" -szOID_BUSINESS_CATEGORY = "2.5.4.15" -szOID_POSTAL_ADDRESS = "2.5.4.16" -szOID_POSTAL_CODE = "2.5.4.17" -szOID_POST_OFFICE_BOX = "2.5.4.18" -szOID_PHYSICAL_DELIVERY_OFFICE_NAME = "2.5.4.19" -szOID_TELEPHONE_NUMBER = "2.5.4.20" -szOID_TELEX_NUMBER = "2.5.4.21" -szOID_TELETEXT_TERMINAL_IDENTIFIER = "2.5.4.22" -szOID_FACSIMILE_TELEPHONE_NUMBER = "2.5.4.23" -szOID_X21_ADDRESS = "2.5.4.24" -szOID_INTERNATIONAL_ISDN_NUMBER = "2.5.4.25" -szOID_REGISTERED_ADDRESS = "2.5.4.26" -szOID_DESTINATION_INDICATOR = "2.5.4.27" -szOID_PREFERRED_DELIVERY_METHOD = "2.5.4.28" -szOID_PRESENTATION_ADDRESS = "2.5.4.29" -szOID_SUPPORTED_APPLICATION_CONTEXT = "2.5.4.30" -szOID_MEMBER = "2.5.4.31" -szOID_OWNER = "2.5.4.32" -szOID_ROLE_OCCUPANT = "2.5.4.33" -szOID_SEE_ALSO = "2.5.4.34" -szOID_USER_PASSWORD = "2.5.4.35" -szOID_USER_CERTIFICATE = "2.5.4.36" -szOID_CA_CERTIFICATE = "2.5.4.37" -szOID_AUTHORITY_REVOCATION_LIST = "2.5.4.38" -szOID_CERTIFICATE_REVOCATION_LIST = "2.5.4.39" -szOID_CROSS_CERTIFICATE_PAIR = "2.5.4.40" -szOID_GIVEN_NAME = "2.5.4.42" -szOID_INITIALS = "2.5.4.43" -szOID_DN_QUALIFIER = "2.5.4.46" -szOID_DOMAIN_COMPONENT = "0.9.2342.19200300.100.1.25" -szOID_PKCS_12_FRIENDLY_NAME_ATTR = "1.2.840.113549.1.9.20" -szOID_PKCS_12_LOCAL_KEY_ID = "1.2.840.113549.1.9.21" -szOID_PKCS_12_KEY_PROVIDER_NAME_ATTR = "1.3.6.1.4.1.311.17.1" -szOID_LOCAL_MACHINE_KEYSET = "1.3.6.1.4.1.311.17.2" -szOID_KEYID_RDN = "1.3.6.1.4.1.311.10.7.1" -CERT_RDN_ANY_TYPE = 0 -CERT_RDN_ENCODED_BLOB = 1 -CERT_RDN_OCTET_STRING = 2 -CERT_RDN_NUMERIC_STRING = 3 -CERT_RDN_PRINTABLE_STRING = 4 -CERT_RDN_TELETEX_STRING = 5 -CERT_RDN_T61_STRING = 5 -CERT_RDN_VIDEOTEX_STRING = 6 -CERT_RDN_IA5_STRING = 7 -CERT_RDN_GRAPHIC_STRING = 8 -CERT_RDN_VISIBLE_STRING = 9 -CERT_RDN_ISO646_STRING = 9 -CERT_RDN_GENERAL_STRING = 10 -CERT_RDN_UNIVERSAL_STRING = 11 -CERT_RDN_INT4_STRING = 11 -CERT_RDN_BMP_STRING = 12 -CERT_RDN_UNICODE_STRING = 12 -CERT_RDN_UTF8_STRING = 13 -CERT_RDN_TYPE_MASK = 0x000000FF -CERT_RDN_FLAGS_MASK = (-16777216) -CERT_RDN_ENABLE_T61_UNICODE_FLAG = (-2147483648) -CERT_RDN_ENABLE_UTF8_UNICODE_FLAG = 0x20000000 -CERT_RDN_DISABLE_CHECK_TYPE_FLAG = 0x40000000 -CERT_RDN_DISABLE_IE4_UTF8_FLAG = 0x01000000 -CERT_RSA_PUBLIC_KEY_OBJID = szOID_RSA_RSA -CERT_DEFAULT_OID_PUBLIC_KEY_SIGN = szOID_RSA_RSA -CERT_DEFAULT_OID_PUBLIC_KEY_XCHG = szOID_RSA_RSA -CERT_V1 = 0 -CERT_V2 = 1 -CERT_V3 = 2 -CERT_INFO_VERSION_FLAG = 1 -CERT_INFO_SERIAL_NUMBER_FLAG = 2 -CERT_INFO_SIGNATURE_ALGORITHM_FLAG = 3 -CERT_INFO_ISSUER_FLAG = 4 -CERT_INFO_NOT_BEFORE_FLAG = 5 -CERT_INFO_NOT_AFTER_FLAG = 6 -CERT_INFO_SUBJECT_FLAG = 7 -CERT_INFO_SUBJECT_PUBLIC_KEY_INFO_FLAG = 8 -CERT_INFO_ISSUER_UNIQUE_ID_FLAG = 9 -CERT_INFO_SUBJECT_UNIQUE_ID_FLAG = 10 -CERT_INFO_EXTENSION_FLAG = 11 -CRL_V1 = 0 -CRL_V2 = 1 -CERT_REQUEST_V1 = 0 -CERT_KEYGEN_REQUEST_V1 = 0 -CTL_V1 = 0 -CERT_ENCODING_TYPE_MASK = 0x0000FFFF -CMSG_ENCODING_TYPE_MASK = (-65536) -def GET_CERT_ENCODING_TYPE(X): return (X & CERT_ENCODING_TYPE_MASK) - -def GET_CMSG_ENCODING_TYPE(X): return (X & CMSG_ENCODING_TYPE_MASK) - -CRYPT_ASN_ENCODING = 0x00000001 -CRYPT_NDR_ENCODING = 0x00000002 -X509_ASN_ENCODING = 0x00000001 -X509_NDR_ENCODING = 0x00000002 -PKCS_7_ASN_ENCODING = 0x00010000 -PKCS_7_NDR_ENCODING = 0x00020000 -CRYPT_FORMAT_STR_MULTI_LINE = 0x0001 -CRYPT_FORMAT_STR_NO_HEX = 0x0010 -CRYPT_FORMAT_SIMPLE = 0x0001 -CRYPT_FORMAT_X509 = 0x0002 -CRYPT_FORMAT_OID = 0x0004 -CRYPT_FORMAT_RDN_SEMICOLON = 0x0100 -CRYPT_FORMAT_RDN_CRLF = 0x0200 -CRYPT_FORMAT_RDN_UNQUOTE = 0x0400 -CRYPT_FORMAT_RDN_REVERSE = 0x0800 -CRYPT_FORMAT_COMMA = 0x1000 -CRYPT_FORMAT_SEMICOLON = CRYPT_FORMAT_RDN_SEMICOLON -CRYPT_FORMAT_CRLF = CRYPT_FORMAT_RDN_CRLF -CRYPT_ENCODE_NO_SIGNATURE_BYTE_REVERSAL_FLAG = 0x8 -CRYPT_ENCODE_ALLOC_FLAG = 0x8000 -CRYPT_UNICODE_NAME_ENCODE_ENABLE_T61_UNICODE_FLAG = \ - CERT_RDN_ENABLE_T61_UNICODE_FLAG -CRYPT_UNICODE_NAME_ENCODE_ENABLE_UTF8_UNICODE_FLAG = \ - CERT_RDN_ENABLE_UTF8_UNICODE_FLAG -CRYPT_UNICODE_NAME_ENCODE_DISABLE_CHECK_TYPE_FLAG = \ - CERT_RDN_DISABLE_CHECK_TYPE_FLAG -CRYPT_SORTED_CTL_ENCODE_HASHED_SUBJECT_IDENTIFIER_FLAG = 0x10000 -CRYPT_DECODE_NOCOPY_FLAG = 0x1 -CRYPT_DECODE_TO_BE_SIGNED_FLAG = 0x2 -CRYPT_DECODE_SHARE_OID_STRING_FLAG = 0x4 -CRYPT_DECODE_NO_SIGNATURE_BYTE_REVERSAL_FLAG = 0x8 -CRYPT_DECODE_ALLOC_FLAG = 0x8000 -CRYPT_UNICODE_NAME_DECODE_DISABLE_IE4_UTF8_FLAG = \ - CERT_RDN_DISABLE_IE4_UTF8_FLAG - -CRYPT_ENCODE_DECODE_NONE = 0 -X509_CERT = 1 -X509_CERT_TO_BE_SIGNED = 2 -X509_CERT_CRL_TO_BE_SIGNED = 3 -X509_CERT_REQUEST_TO_BE_SIGNED = 4 -X509_EXTENSIONS = 5 -X509_NAME_VALUE = 6 -X509_NAME = 7 -X509_PUBLIC_KEY_INFO = 8 -X509_AUTHORITY_KEY_ID = 9 -X509_KEY_ATTRIBUTES = 10 -X509_KEY_USAGE_RESTRICTION = 11 -X509_ALTERNATE_NAME = 12 -X509_BASIC_CONSTRAINTS = 13 -X509_KEY_USAGE = 14 -X509_BASIC_CONSTRAINTS2 = 15 -X509_CERT_POLICIES = 16 -PKCS_UTC_TIME = 17 -PKCS_TIME_REQUEST = 18 -RSA_CSP_PUBLICKEYBLOB = 19 -X509_UNICODE_NAME = 20 -X509_KEYGEN_REQUEST_TO_BE_SIGNED = 21 -PKCS_ATTRIBUTE = 22 -PKCS_CONTENT_INFO_SEQUENCE_OF_ANY = 23 -X509_UNICODE_NAME_VALUE = 24 -X509_ANY_STRING = X509_NAME_VALUE -X509_UNICODE_ANY_STRING = X509_UNICODE_NAME_VALUE -X509_OCTET_STRING = 25 -X509_BITS = 26 -X509_INTEGER = 27 -X509_MULTI_BYTE_INTEGER = 28 -X509_ENUMERATED = 29 -X509_CHOICE_OF_TIME = 30 -X509_AUTHORITY_KEY_ID2 = 31 -X509_AUTHORITY_INFO_ACCESS = 32 -X509_SUBJECT_INFO_ACCESS = X509_AUTHORITY_INFO_ACCESS -X509_CRL_REASON_CODE = X509_ENUMERATED -PKCS_CONTENT_INFO = 33 -X509_SEQUENCE_OF_ANY = 34 -X509_CRL_DIST_POINTS = 35 -X509_ENHANCED_KEY_USAGE = 36 -PKCS_CTL = 37 -X509_MULTI_BYTE_UINT = 38 -X509_DSS_PUBLICKEY = X509_MULTI_BYTE_UINT -X509_DSS_PARAMETERS = 39 -X509_DSS_SIGNATURE = 40 -PKCS_RC2_CBC_PARAMETERS = 41 -PKCS_SMIME_CAPABILITIES = 42 -X509_QC_STATEMENTS_EXT = 42 -PKCS_RSA_PRIVATE_KEY = 43 -PKCS_PRIVATE_KEY_INFO = 44 -PKCS_ENCRYPTED_PRIVATE_KEY_INFO = 45 -X509_PKIX_POLICY_QUALIFIER_USERNOTICE = 46 -X509_DH_PUBLICKEY = X509_MULTI_BYTE_UINT -X509_DH_PARAMETERS = 47 -PKCS_ATTRIBUTES = 48 -PKCS_SORTED_CTL = 49 -X509_ECC_SIGNATURE = 47 -X942_DH_PARAMETERS = 50 -X509_BITS_WITHOUT_TRAILING_ZEROES = 51 -X942_OTHER_INFO = 52 -X509_CERT_PAIR = 53 -X509_ISSUING_DIST_POINT = 54 -X509_NAME_CONSTRAINTS = 55 -X509_POLICY_MAPPINGS = 56 -X509_POLICY_CONSTRAINTS = 57 -X509_CROSS_CERT_DIST_POINTS = 58 -CMC_DATA = 59 -CMC_RESPONSE = 60 -CMC_STATUS = 61 -CMC_ADD_EXTENSIONS = 62 -CMC_ADD_ATTRIBUTES = 63 -X509_CERTIFICATE_TEMPLATE = 64 -OCSP_SIGNED_REQUEST = 65 -OCSP_REQUEST = 66 -OCSP_RESPONSE = 67 -OCSP_BASIC_SIGNED_RESPONSE = 68 -OCSP_BASIC_RESPONSE = 69 -X509_LOGOTYPE_EXT = 70 -X509_BIOMETRIC_EXT = 71 -CNG_RSA_PUBLIC_KEY_BLOB = 72 -X509_OBJECT_IDENTIFIER = 73 -X509_ALGORITHM_IDENTIFIER = 74 -PKCS_RSA_SSA_PSS_PARAMETERS = 75 -PKCS_RSAES_OAEP_PARAMETERS = 76 -ECC_CMS_SHARED_INFO = 77 -TIMESTAMP_REQUEST = 78 -TIMESTAMP_RESPONSE = 79 -TIMESTAMP_INFO = 80 -X509_CERT_BUNDLE = 81 -PKCS7_SIGNER_INFO = 500 -CMS_SIGNER_INFO = 501 - -szOID_AUTHORITY_KEY_IDENTIFIER = "2.5.29.1" -szOID_KEY_ATTRIBUTES = "2.5.29.2" -szOID_CERT_POLICIES_95 = "2.5.29.3" -szOID_KEY_USAGE_RESTRICTION = "2.5.29.4" -szOID_SUBJECT_ALT_NAME = "2.5.29.7" -szOID_ISSUER_ALT_NAME = "2.5.29.8" -szOID_BASIC_CONSTRAINTS = "2.5.29.10" -szOID_KEY_USAGE = "2.5.29.15" -szOID_PRIVATEKEY_USAGE_PERIOD = "2.5.29.16" -szOID_BASIC_CONSTRAINTS2 = "2.5.29.19" -szOID_CERT_POLICIES = "2.5.29.32" -szOID_ANY_CERT_POLICY = "2.5.29.32.0" -szOID_AUTHORITY_KEY_IDENTIFIER2 = "2.5.29.35" -szOID_SUBJECT_KEY_IDENTIFIER = "2.5.29.14" -szOID_SUBJECT_ALT_NAME2 = "2.5.29.17" -szOID_ISSUER_ALT_NAME2 = "2.5.29.18" -szOID_CRL_REASON_CODE = "2.5.29.21" -szOID_REASON_CODE_HOLD = "2.5.29.23" -szOID_CRL_DIST_POINTS = "2.5.29.31" -szOID_ENHANCED_KEY_USAGE = "2.5.29.37" -szOID_CRL_NUMBER = "2.5.29.20" -szOID_DELTA_CRL_INDICATOR = "2.5.29.27" -szOID_ISSUING_DIST_POINT = "2.5.29.28" -szOID_FRESHEST_CRL = "2.5.29.46" -szOID_NAME_CONSTRAINTS = "2.5.29.30" -szOID_POLICY_MAPPINGS = "2.5.29.33" -szOID_LEGACY_POLICY_MAPPINGS = "2.5.29.5" -szOID_POLICY_CONSTRAINTS = "2.5.29.36" -szOID_RENEWAL_CERTIFICATE = "1.3.6.1.4.1.311.13.1" -szOID_ENROLLMENT_NAME_VALUE_PAIR = "1.3.6.1.4.1.311.13.2.1" -szOID_ENROLLMENT_CSP_PROVIDER = "1.3.6.1.4.1.311.13.2.2" -szOID_OS_VERSION = "1.3.6.1.4.1.311.13.2.3" -szOID_ENROLLMENT_AGENT = "1.3.6.1.4.1.311.20.2.1" -szOID_PKIX = "1.3.6.1.5.5.7" -szOID_PKIX_PE = "1.3.6.1.5.5.7.1" -szOID_AUTHORITY_INFO_ACCESS = "1.3.6.1.5.5.7.1.1" -szOID_CERT_EXTENSIONS = "1.3.6.1.4.1.311.2.1.14" -szOID_NEXT_UPDATE_LOCATION = "1.3.6.1.4.1.311.10.2" -szOID_REMOVE_CERTIFICATE = "1.3.6.1.4.1.311.10.8.1" -szOID_CROSS_CERT_DIST_POINTS = "1.3.6.1.4.1.311.10.9.1" -szOID_CTL = "1.3.6.1.4.1.311.10.1" -szOID_SORTED_CTL = "1.3.6.1.4.1.311.10.1.1" -szOID_SERIALIZED = "1.3.6.1.4.1.311.10.3.3.1" -szOID_NT_PRINCIPAL_NAME = "1.3.6.1.4.1.311.20.2.3" -szOID_PRODUCT_UPDATE = "1.3.6.1.4.1.311.31.1" -szOID_ANY_APPLICATION_POLICY = "1.3.6.1.4.1.311.10.12.1" -szOID_AUTO_ENROLL_CTL_USAGE = "1.3.6.1.4.1.311.20.1" -szOID_ENROLL_CERTTYPE_EXTENSION = "1.3.6.1.4.1.311.20.2" -szOID_CERT_MANIFOLD = "1.3.6.1.4.1.311.20.3" -szOID_CERTSRV_CA_VERSION = "1.3.6.1.4.1.311.21.1" -szOID_CERTSRV_PREVIOUS_CERT_HASH = "1.3.6.1.4.1.311.21.2" -szOID_CRL_VIRTUAL_BASE = "1.3.6.1.4.1.311.21.3" -szOID_CRL_NEXT_PUBLISH = "1.3.6.1.4.1.311.21.4" -szOID_KP_CA_EXCHANGE = "1.3.6.1.4.1.311.21.5" -szOID_KP_KEY_RECOVERY_AGENT = "1.3.6.1.4.1.311.21.6" -szOID_CERTIFICATE_TEMPLATE = "1.3.6.1.4.1.311.21.7" -szOID_ENTERPRISE_OID_ROOT = "1.3.6.1.4.1.311.21.8" -szOID_RDN_DUMMY_SIGNER = "1.3.6.1.4.1.311.21.9" -szOID_APPLICATION_CERT_POLICIES = "1.3.6.1.4.1.311.21.10" -szOID_APPLICATION_POLICY_MAPPINGS = "1.3.6.1.4.1.311.21.11" -szOID_APPLICATION_POLICY_CONSTRAINTS = "1.3.6.1.4.1.311.21.12" -szOID_ARCHIVED_KEY_ATTR = "1.3.6.1.4.1.311.21.13" -szOID_CRL_SELF_CDP = "1.3.6.1.4.1.311.21.14" -szOID_REQUIRE_CERT_CHAIN_POLICY = "1.3.6.1.4.1.311.21.15" -szOID_ARCHIVED_KEY_CERT_HASH = "1.3.6.1.4.1.311.21.16" -szOID_ISSUED_CERT_HASH = "1.3.6.1.4.1.311.21.17" -szOID_DS_EMAIL_REPLICATION = "1.3.6.1.4.1.311.21.19" -szOID_REQUEST_CLIENT_INFO = "1.3.6.1.4.1.311.21.20" -szOID_ENCRYPTED_KEY_HASH = "1.3.6.1.4.1.311.21.21" -szOID_CERTSRV_CROSSCA_VERSION = "1.3.6.1.4.1.311.21.22" -szOID_NTDS_REPLICATION = "1.3.6.1.4.1.311.25.1" -szOID_SUBJECT_DIR_ATTRS = "2.5.29.9" -szOID_PKIX_KP = "1.3.6.1.5.5.7.3" -szOID_PKIX_KP_SERVER_AUTH = "1.3.6.1.5.5.7.3.1" -szOID_PKIX_KP_CLIENT_AUTH = "1.3.6.1.5.5.7.3.2" -szOID_PKIX_KP_CODE_SIGNING = "1.3.6.1.5.5.7.3.3" -szOID_PKIX_KP_EMAIL_PROTECTION = "1.3.6.1.5.5.7.3.4" -szOID_PKIX_KP_IPSEC_END_SYSTEM = "1.3.6.1.5.5.7.3.5" -szOID_PKIX_KP_IPSEC_TUNNEL = "1.3.6.1.5.5.7.3.6" -szOID_PKIX_KP_IPSEC_USER = "1.3.6.1.5.5.7.3.7" -szOID_PKIX_KP_TIMESTAMP_SIGNING = "1.3.6.1.5.5.7.3.8" -szOID_IPSEC_KP_IKE_INTERMEDIATE = "1.3.6.1.5.5.8.2.2" -szOID_KP_CTL_USAGE_SIGNING = "1.3.6.1.4.1.311.10.3.1" -szOID_KP_TIME_STAMP_SIGNING = "1.3.6.1.4.1.311.10.3.2" -szOID_SERVER_GATED_CRYPTO = "1.3.6.1.4.1.311.10.3.3" -szOID_SGC_NETSCAPE = "2.16.840.1.113730.4.1" -szOID_KP_EFS = "1.3.6.1.4.1.311.10.3.4" -szOID_EFS_RECOVERY = "1.3.6.1.4.1.311.10.3.4.1" -szOID_WHQL_CRYPTO = "1.3.6.1.4.1.311.10.3.5" -szOID_NT5_CRYPTO = "1.3.6.1.4.1.311.10.3.6" -szOID_OEM_WHQL_CRYPTO = "1.3.6.1.4.1.311.10.3.7" -szOID_EMBEDDED_NT_CRYPTO = "1.3.6.1.4.1.311.10.3.8" -szOID_ROOT_LIST_SIGNER = "1.3.6.1.4.1.311.10.3.9" -szOID_KP_QUALIFIED_SUBORDINATION = "1.3.6.1.4.1.311.10.3.10" -szOID_KP_KEY_RECOVERY = "1.3.6.1.4.1.311.10.3.11" -szOID_KP_DOCUMENT_SIGNING = "1.3.6.1.4.1.311.10.3.12" -szOID_KP_LIFETIME_SIGNING = "1.3.6.1.4.1.311.10.3.13" -szOID_KP_MOBILE_DEVICE_SOFTWARE = "1.3.6.1.4.1.311.10.3.14" -szOID_DRM = "1.3.6.1.4.1.311.10.5.1" -szOID_DRM_INDIVIDUALIZATION = "1.3.6.1.4.1.311.10.5.2" -szOID_LICENSES = "1.3.6.1.4.1.311.10.6.1" -szOID_LICENSE_SERVER = "1.3.6.1.4.1.311.10.6.2" -szOID_KP_SMARTCARD_LOGON = "1.3.6.1.4.1.311.20.2.2" -szOID_YESNO_TRUST_ATTR = "1.3.6.1.4.1.311.10.4.1" -szOID_PKIX_POLICY_QUALIFIER_CPS = "1.3.6.1.5.5.7.2.1" -szOID_PKIX_POLICY_QUALIFIER_USERNOTICE = "1.3.6.1.5.5.7.2.2" -szOID_CERT_POLICIES_95_QUALIFIER1 = "2.16.840.1.113733.1.7.1.1" -CERT_UNICODE_RDN_ERR_INDEX_MASK = 0x3FF -CERT_UNICODE_RDN_ERR_INDEX_SHIFT = 22 -CERT_UNICODE_ATTR_ERR_INDEX_MASK = 0x003F -CERT_UNICODE_ATTR_ERR_INDEX_SHIFT = 16 -CERT_UNICODE_VALUE_ERR_INDEX_MASK = 0x0000FFFF -CERT_UNICODE_VALUE_ERR_INDEX_SHIFT = 0 -CERT_DIGITAL_SIGNATURE_KEY_USAGE = 0x80 -CERT_NON_REPUDIATION_KEY_USAGE = 0x40 -CERT_KEY_ENCIPHERMENT_KEY_USAGE = 0x20 -CERT_DATA_ENCIPHERMENT_KEY_USAGE = 0x10 -CERT_KEY_AGREEMENT_KEY_USAGE = 0x08 -CERT_KEY_CERT_SIGN_KEY_USAGE = 0x04 -CERT_OFFLINE_CRL_SIGN_KEY_USAGE = 0x02 -CERT_CRL_SIGN_KEY_USAGE = 0x02 -CERT_ENCIPHER_ONLY_KEY_USAGE = 0x01 -CERT_DECIPHER_ONLY_KEY_USAGE = 0x80 -CERT_ALT_NAME_OTHER_NAME = 1 -CERT_ALT_NAME_RFC822_NAME = 2 -CERT_ALT_NAME_DNS_NAME = 3 -CERT_ALT_NAME_X400_ADDRESS = 4 -CERT_ALT_NAME_DIRECTORY_NAME = 5 -CERT_ALT_NAME_EDI_PARTY_NAME = 6 -CERT_ALT_NAME_URL = 7 -CERT_ALT_NAME_IP_ADDRESS = 8 -CERT_ALT_NAME_REGISTERED_ID = 9 -CERT_ALT_NAME_ENTRY_ERR_INDEX_MASK = 0xFF -CERT_ALT_NAME_ENTRY_ERR_INDEX_SHIFT = 16 -CERT_ALT_NAME_VALUE_ERR_INDEX_MASK = 0x0000FFFF -CERT_ALT_NAME_VALUE_ERR_INDEX_SHIFT = 0 -CERT_CA_SUBJECT_FLAG = 0x80 -CERT_END_ENTITY_SUBJECT_FLAG = 0x40 -szOID_PKIX_ACC_DESCR = "1.3.6.1.5.5.7.48" -szOID_PKIX_OCSP = "1.3.6.1.5.5.7.48.1" -szOID_PKIX_CA_ISSUERS = "1.3.6.1.5.5.7.48.2" -CRL_REASON_UNSPECIFIED = 0 -CRL_REASON_KEY_COMPROMISE = 1 -CRL_REASON_CA_COMPROMISE = 2 -CRL_REASON_AFFILIATION_CHANGED = 3 -CRL_REASON_SUPERSEDED = 4 -CRL_REASON_CESSATION_OF_OPERATION = 5 -CRL_REASON_CERTIFICATE_HOLD = 6 -CRL_REASON_REMOVE_FROM_CRL = 8 -CRL_DIST_POINT_NO_NAME = 0 -CRL_DIST_POINT_FULL_NAME = 1 -CRL_DIST_POINT_ISSUER_RDN_NAME = 2 -CRL_REASON_UNUSED_FLAG = 0x80 -CRL_REASON_KEY_COMPROMISE_FLAG = 0x40 -CRL_REASON_CA_COMPROMISE_FLAG = 0x20 -CRL_REASON_AFFILIATION_CHANGED_FLAG = 0x10 -CRL_REASON_SUPERSEDED_FLAG = 0x08 -CRL_REASON_CESSATION_OF_OPERATION_FLAG = 0x04 -CRL_REASON_CERTIFICATE_HOLD_FLAG = 0x02 -CRL_DIST_POINT_ERR_INDEX_MASK = 0x7F -CRL_DIST_POINT_ERR_INDEX_SHIFT = 24 - -CRL_DIST_POINT_ERR_CRL_ISSUER_BIT = (-2147483648) - -CROSS_CERT_DIST_POINT_ERR_INDEX_MASK = 0xFF -CROSS_CERT_DIST_POINT_ERR_INDEX_SHIFT = 24 - -CERT_EXCLUDED_SUBTREE_BIT = (-2147483648) - -SORTED_CTL_EXT_FLAGS_OFFSET = (0*4) -SORTED_CTL_EXT_COUNT_OFFSET = (1*4) -SORTED_CTL_EXT_MAX_COLLISION_OFFSET = (2*4) -SORTED_CTL_EXT_HASH_BUCKET_OFFSET = (3*4) -SORTED_CTL_EXT_HASHED_SUBJECT_IDENTIFIER_FLAG = 0x1 -CERT_DSS_R_LEN = 20 -CERT_DSS_S_LEN = 20 -CERT_DSS_SIGNATURE_LEN = (CERT_DSS_R_LEN + CERT_DSS_S_LEN) -CERT_MAX_ASN_ENCODED_DSS_SIGNATURE_LEN = (2 + 2*(2 + 20 +1)) -CRYPT_X942_COUNTER_BYTE_LENGTH = 4 -CRYPT_X942_KEY_LENGTH_BYTE_LENGTH = 4 -CRYPT_X942_PUB_INFO_BYTE_LENGTH = (512/8) -CRYPT_RC2_40BIT_VERSION = 160 -CRYPT_RC2_56BIT_VERSION = 52 -CRYPT_RC2_64BIT_VERSION = 120 -CRYPT_RC2_128BIT_VERSION = 58 -szOID_VERISIGN_PRIVATE_6_9 = "2.16.840.1.113733.1.6.9" -szOID_VERISIGN_ONSITE_JURISDICTION_HASH = "2.16.840.1.113733.1.6.11" -szOID_VERISIGN_BITSTRING_6_13 = "2.16.840.1.113733.1.6.13" -szOID_VERISIGN_ISS_STRONG_CRYPTO = "2.16.840.1.113733.1.8.1" -szOID_NETSCAPE = "2.16.840.1.113730" -szOID_NETSCAPE_CERT_EXTENSION = "2.16.840.1.113730.1" -szOID_NETSCAPE_CERT_TYPE = "2.16.840.1.113730.1.1" -szOID_NETSCAPE_BASE_URL = "2.16.840.1.113730.1.2" -szOID_NETSCAPE_REVOCATION_URL = "2.16.840.1.113730.1.3" -szOID_NETSCAPE_CA_REVOCATION_URL = "2.16.840.1.113730.1.4" -szOID_NETSCAPE_CERT_RENEWAL_URL = "2.16.840.1.113730.1.7" -szOID_NETSCAPE_CA_POLICY_URL = "2.16.840.1.113730.1.8" -szOID_NETSCAPE_SSL_SERVER_NAME = "2.16.840.1.113730.1.12" -szOID_NETSCAPE_COMMENT = "2.16.840.1.113730.1.13" -szOID_NETSCAPE_DATA_TYPE = "2.16.840.1.113730.2" -szOID_NETSCAPE_CERT_SEQUENCE = "2.16.840.1.113730.2.5" -NETSCAPE_SSL_CLIENT_AUTH_CERT_TYPE = 0x80 -NETSCAPE_SSL_SERVER_AUTH_CERT_TYPE = 0x40 -NETSCAPE_SMIME_CERT_TYPE = 0x20 -NETSCAPE_SIGN_CERT_TYPE = 0x10 -NETSCAPE_SSL_CA_CERT_TYPE = 0x04 -NETSCAPE_SMIME_CA_CERT_TYPE = 0x02 -NETSCAPE_SIGN_CA_CERT_TYPE = 0x01 -szOID_CT_PKI_DATA = "1.3.6.1.5.5.7.12.2" -szOID_CT_PKI_RESPONSE = "1.3.6.1.5.5.7.12.3" -szOID_PKIX_NO_SIGNATURE = "1.3.6.1.5.5.7.6.2" -szOID_CMC = "1.3.6.1.5.5.7.7" -szOID_CMC_STATUS_INFO = "1.3.6.1.5.5.7.7.1" -szOID_CMC_IDENTIFICATION = "1.3.6.1.5.5.7.7.2" -szOID_CMC_IDENTITY_PROOF = "1.3.6.1.5.5.7.7.3" -szOID_CMC_DATA_RETURN = "1.3.6.1.5.5.7.7.4" -szOID_CMC_TRANSACTION_ID = "1.3.6.1.5.5.7.7.5" -szOID_CMC_SENDER_NONCE = "1.3.6.1.5.5.7.7.6" -szOID_CMC_RECIPIENT_NONCE = "1.3.6.1.5.5.7.7.7" -szOID_CMC_ADD_EXTENSIONS = "1.3.6.1.5.5.7.7.8" -szOID_CMC_ENCRYPTED_POP = "1.3.6.1.5.5.7.7.9" -szOID_CMC_DECRYPTED_POP = "1.3.6.1.5.5.7.7.10" -szOID_CMC_LRA_POP_WITNESS = "1.3.6.1.5.5.7.7.11" -szOID_CMC_GET_CERT = "1.3.6.1.5.5.7.7.15" -szOID_CMC_GET_CRL = "1.3.6.1.5.5.7.7.16" -szOID_CMC_REVOKE_REQUEST = "1.3.6.1.5.5.7.7.17" -szOID_CMC_REG_INFO = "1.3.6.1.5.5.7.7.18" -szOID_CMC_RESPONSE_INFO = "1.3.6.1.5.5.7.7.19" -szOID_CMC_QUERY_PENDING = "1.3.6.1.5.5.7.7.21" -szOID_CMC_ID_POP_LINK_RANDOM = "1.3.6.1.5.5.7.7.22" -szOID_CMC_ID_POP_LINK_WITNESS = "1.3.6.1.5.5.7.7.23" -szOID_CMC_ID_CONFIRM_CERT_ACCEPTANCE = "1.3.6.1.5.5.7.7.24" -szOID_CMC_ADD_ATTRIBUTES = "1.3.6.1.4.1.311.10.10.1" -CMC_TAGGED_CERT_REQUEST_CHOICE = 1 -CMC_OTHER_INFO_NO_CHOICE = 0 -CMC_OTHER_INFO_FAIL_CHOICE = 1 -CMC_OTHER_INFO_PEND_CHOICE = 2 -CMC_STATUS_SUCCESS = 0 -CMC_STATUS_FAILED = 2 -CMC_STATUS_PENDING = 3 -CMC_STATUS_NO_SUPPORT = 4 -CMC_STATUS_CONFIRM_REQUIRED = 5 -CMC_FAIL_BAD_ALG = 0 -CMC_FAIL_BAD_MESSAGE_CHECK = 1 -CMC_FAIL_BAD_REQUEST = 2 -CMC_FAIL_BAD_TIME = 3 -CMC_FAIL_BAD_CERT_ID = 4 -CMC_FAIL_UNSUPORTED_EXT = 5 -CMC_FAIL_MUST_ARCHIVE_KEYS = 6 -CMC_FAIL_BAD_IDENTITY = 7 -CMC_FAIL_POP_REQUIRED = 8 -CMC_FAIL_POP_FAILED = 9 -CMC_FAIL_NO_KEY_REUSE = 10 -CMC_FAIL_INTERNAL_CA_ERROR = 11 -CMC_FAIL_TRY_LATER = 12 -CRYPT_OID_ENCODE_OBJECT_FUNC = "CryptDllEncodeObject" -CRYPT_OID_DECODE_OBJECT_FUNC = "CryptDllDecodeObject" -CRYPT_OID_ENCODE_OBJECT_EX_FUNC = "CryptDllEncodeObjectEx" -CRYPT_OID_DECODE_OBJECT_EX_FUNC = "CryptDllDecodeObjectEx" -CRYPT_OID_CREATE_COM_OBJECT_FUNC = "CryptDllCreateCOMObject" -CRYPT_OID_VERIFY_REVOCATION_FUNC = "CertDllVerifyRevocation" -CRYPT_OID_VERIFY_CTL_USAGE_FUNC = "CertDllVerifyCTLUsage" -CRYPT_OID_FORMAT_OBJECT_FUNC = "CryptDllFormatObject" -CRYPT_OID_FIND_OID_INFO_FUNC = "CryptDllFindOIDInfo" -CRYPT_OID_FIND_LOCALIZED_NAME_FUNC = "CryptDllFindLocalizedName" - -CRYPT_OID_REGPATH = "Software\\Microsoft\\Cryptography\\OID" -CRYPT_OID_REG_ENCODING_TYPE_PREFIX = "EncodingType " -CRYPT_OID_REG_DLL_VALUE_NAME = "Dll" -CRYPT_OID_REG_FUNC_NAME_VALUE_NAME = "FuncName" -CRYPT_OID_REG_FUNC_NAME_VALUE_NAME_A = "FuncName" -CRYPT_OID_REG_FLAGS_VALUE_NAME = "CryptFlags" -CRYPT_DEFAULT_OID = "DEFAULT" -CRYPT_INSTALL_OID_FUNC_BEFORE_FLAG = 1 -CRYPT_GET_INSTALLED_OID_FUNC_FLAG = 0x1 -CRYPT_REGISTER_FIRST_INDEX = 0 -CRYPT_REGISTER_LAST_INDEX = (-1) -CRYPT_MATCH_ANY_ENCODING_TYPE = (-1) -CRYPT_HASH_ALG_OID_GROUP_ID = 1 -CRYPT_ENCRYPT_ALG_OID_GROUP_ID = 2 -CRYPT_PUBKEY_ALG_OID_GROUP_ID = 3 -CRYPT_SIGN_ALG_OID_GROUP_ID = 4 -CRYPT_RDN_ATTR_OID_GROUP_ID = 5 -CRYPT_EXT_OR_ATTR_OID_GROUP_ID = 6 -CRYPT_ENHKEY_USAGE_OID_GROUP_ID = 7 -CRYPT_POLICY_OID_GROUP_ID = 8 -CRYPT_TEMPLATE_OID_GROUP_ID = 9 -CRYPT_LAST_OID_GROUP_ID = 9 -CRYPT_FIRST_ALG_OID_GROUP_ID = CRYPT_HASH_ALG_OID_GROUP_ID -CRYPT_LAST_ALG_OID_GROUP_ID = CRYPT_SIGN_ALG_OID_GROUP_ID -CRYPT_OID_INHIBIT_SIGNATURE_FORMAT_FLAG = 0x1 -CRYPT_OID_USE_PUBKEY_PARA_FOR_PKCS7_FLAG = 0x2 -CRYPT_OID_NO_NULL_ALGORITHM_PARA_FLAG = 0x4 -CRYPT_OID_INFO_OID_KEY = 1 -CRYPT_OID_INFO_NAME_KEY = 2 -CRYPT_OID_INFO_ALGID_KEY = 3 -CRYPT_OID_INFO_SIGN_KEY = 4 -CRYPT_INSTALL_OID_INFO_BEFORE_FLAG = 1 -CRYPT_LOCALIZED_NAME_ENCODING_TYPE = 0 -CRYPT_LOCALIZED_NAME_OID = "LocalizedNames" -szOID_PKCS_7_DATA = "1.2.840.113549.1.7.1" -szOID_PKCS_7_SIGNED = "1.2.840.113549.1.7.2" -szOID_PKCS_7_ENVELOPED = "1.2.840.113549.1.7.3" -szOID_PKCS_7_SIGNEDANDENVELOPED = "1.2.840.113549.1.7.4" -szOID_PKCS_7_DIGESTED = "1.2.840.113549.1.7.5" -szOID_PKCS_7_ENCRYPTED = "1.2.840.113549.1.7.6" -szOID_PKCS_9_CONTENT_TYPE = "1.2.840.113549.1.9.3" -szOID_PKCS_9_MESSAGE_DIGEST = "1.2.840.113549.1.9.4" -CMSG_DATA = 1 -CMSG_SIGNED = 2 -CMSG_ENVELOPED = 3 -CMSG_SIGNED_AND_ENVELOPED = 4 -CMSG_HASHED = 5 -CMSG_ENCRYPTED = 6 - -CMSG_ALL_FLAGS = -1 -CMSG_DATA_FLAG = (1 << CMSG_DATA) -CMSG_SIGNED_FLAG = (1 << CMSG_SIGNED) -CMSG_ENVELOPED_FLAG = (1 << CMSG_ENVELOPED) -CMSG_SIGNED_AND_ENVELOPED_FLAG = (1 << CMSG_SIGNED_AND_ENVELOPED) -CMSG_HASHED_FLAG = (1 << CMSG_HASHED) -CMSG_ENCRYPTED_FLAG = (1 << CMSG_ENCRYPTED) -CERT_ID_ISSUER_SERIAL_NUMBER = 1 -CERT_ID_KEY_IDENTIFIER = 2 -CERT_ID_SHA1_HASH = 3 -CMSG_KEY_AGREE_EPHEMERAL_KEY_CHOICE = 1 -CMSG_KEY_AGREE_STATIC_KEY_CHOICE = 2 -CMSG_MAIL_LIST_HANDLE_KEY_CHOICE = 1 -CMSG_KEY_TRANS_RECIPIENT = 1 -CMSG_KEY_AGREE_RECIPIENT = 2 -CMSG_MAIL_LIST_RECIPIENT = 3 -CMSG_SP3_COMPATIBLE_ENCRYPT_FLAG = (-2147483648) -CMSG_RC4_NO_SALT_FLAG = 0x40000000 -CMSG_INDEFINITE_LENGTH = ((-1)) -CMSG_BARE_CONTENT_FLAG = 0x00000001 -CMSG_LENGTH_ONLY_FLAG = 0x00000002 -CMSG_DETACHED_FLAG = 0x00000004 -CMSG_AUTHENTICATED_ATTRIBUTES_FLAG = 0x00000008 -CMSG_CONTENTS_OCTETS_FLAG = 0x00000010 -CMSG_MAX_LENGTH_FLAG = 0x00000020 -CMSG_CMS_ENCAPSULATED_CONTENT_FLAG = 0x00000040 -CMSG_CRYPT_RELEASE_CONTEXT_FLAG = 0x00008000 -CMSG_TYPE_PARAM = 1 -CMSG_CONTENT_PARAM = 2 -CMSG_BARE_CONTENT_PARAM = 3 -CMSG_INNER_CONTENT_TYPE_PARAM = 4 -CMSG_SIGNER_COUNT_PARAM = 5 -CMSG_SIGNER_INFO_PARAM = 6 -CMSG_SIGNER_CERT_INFO_PARAM = 7 -CMSG_SIGNER_HASH_ALGORITHM_PARAM = 8 -CMSG_SIGNER_AUTH_ATTR_PARAM = 9 -CMSG_SIGNER_UNAUTH_ATTR_PARAM = 10 -CMSG_CERT_COUNT_PARAM = 11 -CMSG_CERT_PARAM = 12 -CMSG_CRL_COUNT_PARAM = 13 -CMSG_CRL_PARAM = 14 -CMSG_ENVELOPE_ALGORITHM_PARAM = 15 -CMSG_RECIPIENT_COUNT_PARAM = 17 -CMSG_RECIPIENT_INDEX_PARAM = 18 -CMSG_RECIPIENT_INFO_PARAM = 19 -CMSG_HASH_ALGORITHM_PARAM = 20 -CMSG_HASH_DATA_PARAM = 21 -CMSG_COMPUTED_HASH_PARAM = 22 -CMSG_ENCRYPT_PARAM = 26 -CMSG_ENCRYPTED_DIGEST = 27 -CMSG_ENCODED_SIGNER = 28 -CMSG_ENCODED_MESSAGE = 29 -CMSG_VERSION_PARAM = 30 -CMSG_ATTR_CERT_COUNT_PARAM = 31 -CMSG_ATTR_CERT_PARAM = 32 -CMSG_CMS_RECIPIENT_COUNT_PARAM = 33 -CMSG_CMS_RECIPIENT_INDEX_PARAM = 34 -CMSG_CMS_RECIPIENT_ENCRYPTED_KEY_INDEX_PARAM = 35 -CMSG_CMS_RECIPIENT_INFO_PARAM = 36 -CMSG_UNPROTECTED_ATTR_PARAM = 37 -CMSG_SIGNER_CERT_ID_PARAM = 38 -CMSG_CMS_SIGNER_INFO_PARAM = 39 -CMSG_SIGNED_DATA_V1 = 1 -CMSG_SIGNED_DATA_V3 = 3 -CMSG_SIGNED_DATA_PKCS_1_5_VERSION = CMSG_SIGNED_DATA_V1 -CMSG_SIGNED_DATA_CMS_VERSION = CMSG_SIGNED_DATA_V3 -CMSG_SIGNER_INFO_V1 = 1 -CMSG_SIGNER_INFO_V3 = 3 -CMSG_SIGNER_INFO_PKCS_1_5_VERSION = CMSG_SIGNER_INFO_V1 -CMSG_SIGNER_INFO_CMS_VERSION = CMSG_SIGNER_INFO_V3 -CMSG_HASHED_DATA_V0 = 0 -CMSG_HASHED_DATA_V2 = 2 -CMSG_HASHED_DATA_PKCS_1_5_VERSION = CMSG_HASHED_DATA_V0 -CMSG_HASHED_DATA_CMS_VERSION = CMSG_HASHED_DATA_V2 -CMSG_ENVELOPED_DATA_V0 = 0 -CMSG_ENVELOPED_DATA_V2 = 2 -CMSG_ENVELOPED_DATA_PKCS_1_5_VERSION = CMSG_ENVELOPED_DATA_V0 -CMSG_ENVELOPED_DATA_CMS_VERSION = CMSG_ENVELOPED_DATA_V2 -CMSG_KEY_AGREE_ORIGINATOR_CERT = 1 -CMSG_KEY_AGREE_ORIGINATOR_PUBLIC_KEY = 2 -CMSG_ENVELOPED_RECIPIENT_V0 = 0 -CMSG_ENVELOPED_RECIPIENT_V2 = 2 -CMSG_ENVELOPED_RECIPIENT_V3 = 3 -CMSG_ENVELOPED_RECIPIENT_V4 = 4 -CMSG_KEY_TRANS_PKCS_1_5_VERSION = CMSG_ENVELOPED_RECIPIENT_V0 -CMSG_KEY_TRANS_CMS_VERSION = CMSG_ENVELOPED_RECIPIENT_V2 -CMSG_KEY_AGREE_VERSION = CMSG_ENVELOPED_RECIPIENT_V3 -CMSG_MAIL_LIST_VERSION = CMSG_ENVELOPED_RECIPIENT_V4 -CMSG_CTRL_VERIFY_SIGNATURE = 1 -CMSG_CTRL_DECRYPT = 2 -CMSG_CTRL_VERIFY_HASH = 5 -CMSG_CTRL_ADD_SIGNER = 6 -CMSG_CTRL_DEL_SIGNER = 7 -CMSG_CTRL_ADD_SIGNER_UNAUTH_ATTR = 8 -CMSG_CTRL_DEL_SIGNER_UNAUTH_ATTR = 9 -CMSG_CTRL_ADD_CERT = 10 -CMSG_CTRL_DEL_CERT = 11 -CMSG_CTRL_ADD_CRL = 12 -CMSG_CTRL_DEL_CRL = 13 -CMSG_CTRL_ADD_ATTR_CERT = 14 -CMSG_CTRL_DEL_ATTR_CERT = 15 -CMSG_CTRL_KEY_TRANS_DECRYPT = 16 -CMSG_CTRL_KEY_AGREE_DECRYPT = 17 -CMSG_CTRL_MAIL_LIST_DECRYPT = 18 -CMSG_CTRL_VERIFY_SIGNATURE_EX = 19 -CMSG_CTRL_ADD_CMS_SIGNER_INFO = 20 -CMSG_VERIFY_SIGNER_PUBKEY = 1 -CMSG_VERIFY_SIGNER_CERT = 2 -CMSG_VERIFY_SIGNER_CHAIN = 3 -CMSG_VERIFY_SIGNER_NULL = 4 -CMSG_OID_GEN_ENCRYPT_KEY_FUNC = "CryptMsgDllGenEncryptKey" -CMSG_OID_EXPORT_ENCRYPT_KEY_FUNC = "CryptMsgDllExportEncryptKey" -CMSG_OID_IMPORT_ENCRYPT_KEY_FUNC = "CryptMsgDllImportEncryptKey" -CMSG_CONTENT_ENCRYPT_PAD_ENCODED_LEN_FLAG = 0x00000001 -CMSG_DEFAULT_INSTALLABLE_FUNC_OID = 1 -CMSG_CONTENT_ENCRYPT_FREE_PARA_FLAG = 0x00000001 -CMSG_CONTENT_ENCRYPT_RELEASE_CONTEXT_FLAG = 0x00008000 -CMSG_OID_GEN_CONTENT_ENCRYPT_KEY_FUNC = "CryptMsgDllGenContentEncryptKey" -CMSG_KEY_TRANS_ENCRYPT_FREE_PARA_FLAG = 0x00000001 -CMSG_OID_EXPORT_KEY_TRANS_FUNC = "CryptMsgDllExportKeyTrans" -CMSG_KEY_AGREE_ENCRYPT_FREE_PARA_FLAG = 0x00000001 -CMSG_KEY_AGREE_ENCRYPT_FREE_MATERIAL_FLAG = 0x00000002 -CMSG_KEY_AGREE_ENCRYPT_FREE_PUBKEY_ALG_FLAG = 0x00000004 -CMSG_KEY_AGREE_ENCRYPT_FREE_PUBKEY_PARA_FLAG = 0x00000008 -CMSG_KEY_AGREE_ENCRYPT_FREE_PUBKEY_BITS_FLAG = 0x00000010 -CMSG_OID_EXPORT_KEY_AGREE_FUNC = "CryptMsgDllExportKeyAgree" -CMSG_MAIL_LIST_ENCRYPT_FREE_PARA_FLAG = 0x00000001 -CMSG_OID_EXPORT_MAIL_LIST_FUNC = "CryptMsgDllExportMailList" -CMSG_OID_IMPORT_KEY_TRANS_FUNC = "CryptMsgDllImportKeyTrans" -CMSG_OID_IMPORT_KEY_AGREE_FUNC = "CryptMsgDllImportKeyAgree" -CMSG_OID_IMPORT_MAIL_LIST_FUNC = "CryptMsgDllImportMailList" - -# Certificate property id's used with CertGetCertificateContextProperty -CERT_KEY_PROV_HANDLE_PROP_ID = 1 -CERT_KEY_PROV_INFO_PROP_ID = 2 -CERT_SHA1_HASH_PROP_ID = 3 -CERT_MD5_HASH_PROP_ID = 4 -CERT_HASH_PROP_ID = CERT_SHA1_HASH_PROP_ID -CERT_KEY_CONTEXT_PROP_ID = 5 -CERT_KEY_SPEC_PROP_ID = 6 -CERT_IE30_RESERVED_PROP_ID = 7 -CERT_PUBKEY_HASH_RESERVED_PROP_ID = 8 -CERT_ENHKEY_USAGE_PROP_ID = 9 -CERT_CTL_USAGE_PROP_ID = CERT_ENHKEY_USAGE_PROP_ID -CERT_NEXT_UPDATE_LOCATION_PROP_ID = 10 -CERT_FRIENDLY_NAME_PROP_ID = 11 -CERT_PVK_FILE_PROP_ID = 12 -CERT_DESCRIPTION_PROP_ID = 13 -CERT_ACCESS_STATE_PROP_ID = 14 -CERT_SIGNATURE_HASH_PROP_ID = 15 -CERT_SMART_CARD_DATA_PROP_ID = 16 -CERT_EFS_PROP_ID = 17 -CERT_FORTEZZA_DATA_PROP_ID = 18 -CERT_ARCHIVED_PROP_ID = 19 -CERT_KEY_IDENTIFIER_PROP_ID = 20 -CERT_AUTO_ENROLL_PROP_ID = 21 -CERT_PUBKEY_ALG_PARA_PROP_ID = 22 -CERT_CROSS_CERT_DIST_POINTS_PROP_ID = 23 -CERT_ISSUER_PUBLIC_KEY_MD5_HASH_PROP_ID = 24 -CERT_SUBJECT_PUBLIC_KEY_MD5_HASH_PROP_ID = 25 -CERT_ENROLLMENT_PROP_ID = 26 -CERT_DATE_STAMP_PROP_ID = 27 -CERT_ISSUER_SERIAL_NUMBER_MD5_HASH_PROP_ID = 28 -CERT_SUBJECT_NAME_MD5_HASH_PROP_ID = 29 -CERT_EXTENDED_ERROR_INFO_PROP_ID = 30 -CERT_RENEWAL_PROP_ID = 64 -CERT_ARCHIVED_KEY_HASH_PROP_ID = 65 -CERT_AUTO_ENROLL_RETRY_PROP_ID = 66 -CERT_AIA_URL_RETRIEVED_PROP_ID = 67 -CERT_AUTHORITY_INFO_ACCESS_PROP_ID = 68 -CERT_BACKED_UP_PROP_ID = 69 -CERT_OCSP_RESPONSE_PROP_ID = 70 -CERT_REQUEST_ORIGINATOR_PROP_ID = 71 -CERT_SOURCE_LOCATION_PROP_ID = 72 -CERT_SOURCE_URL_PROP_ID = 73 -CERT_NEW_KEY_PROP_ID = 74 -CERT_OCSP_CACHE_PREFIX_PROP_ID = 75 -CERT_SMART_CARD_ROOT_INFO_PROP_ID = 76 -CERT_NO_AUTO_EXPIRE_CHECK_PROP_ID = 77 -CERT_NCRYPT_KEY_HANDLE_PROP_ID = 78 -CERT_HCRYPTPROV_OR_NCRYPT_KEY_HANDLE_PROP_ID = 79 -CERT_SUBJECT_INFO_ACCESS_PROP_ID = 80 -CERT_CA_OCSP_AUTHORITY_INFO_ACCESS_PROP_ID = 81 -CERT_CA_DISABLE_CRL_PROP_ID = 82 -CERT_ROOT_PROGRAM_CERT_POLICIES_PROP_ID = 83 -CERT_ROOT_PROGRAM_NAME_CONSTRAINTS_PROP_ID = 84 -CERT_SUBJECT_OCSP_AUTHORITY_INFO_ACCESS_PROP_ID = 85 -CERT_SUBJECT_DISABLE_CRL_PROP_ID = 86 -CERT_CEP_PROP_ID = 87 -CERT_SIGN_HASH_CNG_ALG_PROP_ID = 89 -CERT_SCARD_PIN_ID_PROP_ID = 90 -CERT_SCARD_PIN_INFO_PROP_ID = 91 -CERT_FIRST_RESERVED_PROP_ID = 92 -CERT_LAST_RESERVED_PROP_ID = 0x00007FFF -CERT_FIRST_USER_PROP_ID = 0x00008000 -CERT_LAST_USER_PROP_ID = 0x0000FFFF - -szOID_CERT_PROP_ID_PREFIX = "1.3.6.1.4.1.311.10.11." -szOID_CERT_KEY_IDENTIFIER_PROP_ID = "1.3.6.1.4.1.311.10.11.20" -szOID_CERT_ISSUER_SERIAL_NUMBER_MD5_HASH_PROP_ID = \ - "1.3.6.1.4.1.311.10.11.28" -szOID_CERT_SUBJECT_NAME_MD5_HASH_PROP_ID = \ - "1.3.6.1.4.1.311.10.11.29" -CERT_ACCESS_STATE_WRITE_PERSIST_FLAG = 0x1 -CERT_ACCESS_STATE_SYSTEM_STORE_FLAG = 0x2 -CERT_ACCESS_STATE_LM_SYSTEM_STORE_FLAG = 0x4 -CERT_SET_KEY_PROV_HANDLE_PROP_ID = 0x00000001 -CERT_SET_KEY_CONTEXT_PROP_ID = 0x00000001 -sz_CERT_STORE_PROV_MEMORY = "Memory" -sz_CERT_STORE_PROV_FILENAME_W = "File" -sz_CERT_STORE_PROV_FILENAME = sz_CERT_STORE_PROV_FILENAME_W -sz_CERT_STORE_PROV_SYSTEM_W = "System" -sz_CERT_STORE_PROV_SYSTEM = sz_CERT_STORE_PROV_SYSTEM_W -sz_CERT_STORE_PROV_PKCS7 = "PKCS7" -sz_CERT_STORE_PROV_SERIALIZED = "Serialized" -sz_CERT_STORE_PROV_COLLECTION = "Collection" -sz_CERT_STORE_PROV_SYSTEM_REGISTRY_W = "SystemRegistry" -sz_CERT_STORE_PROV_SYSTEM_REGISTRY = sz_CERT_STORE_PROV_SYSTEM_REGISTRY_W -sz_CERT_STORE_PROV_PHYSICAL_W = "Physical" -sz_CERT_STORE_PROV_PHYSICAL = sz_CERT_STORE_PROV_PHYSICAL_W -sz_CERT_STORE_PROV_SMART_CARD_W = "SmartCard" -sz_CERT_STORE_PROV_SMART_CARD = sz_CERT_STORE_PROV_SMART_CARD_W -sz_CERT_STORE_PROV_LDAP_W = "Ldap" -sz_CERT_STORE_PROV_LDAP = sz_CERT_STORE_PROV_LDAP_W -CERT_STORE_SIGNATURE_FLAG = 0x00000001 -CERT_STORE_TIME_VALIDITY_FLAG = 0x00000002 -CERT_STORE_REVOCATION_FLAG = 0x00000004 -CERT_STORE_NO_CRL_FLAG = 0x00010000 -CERT_STORE_NO_ISSUER_FLAG = 0x00020000 -CERT_STORE_BASE_CRL_FLAG = 0x00000100 -CERT_STORE_DELTA_CRL_FLAG = 0x00000200 -CERT_STORE_NO_CRYPT_RELEASE_FLAG = 0x00000001 -CERT_STORE_SET_LOCALIZED_NAME_FLAG = 0x00000002 -CERT_STORE_DEFER_CLOSE_UNTIL_LAST_FREE_FLAG = 0x00000004 -CERT_STORE_DELETE_FLAG = 0x00000010 -CERT_STORE_UNSAFE_PHYSICAL_FLAG = 0x00000020 -CERT_STORE_SHARE_STORE_FLAG = 0x00000040 -CERT_STORE_SHARE_CONTEXT_FLAG = 0x00000080 -CERT_STORE_MANIFOLD_FLAG = 0x00000100 -CERT_STORE_ENUM_ARCHIVED_FLAG = 0x00000200 -CERT_STORE_UPDATE_KEYID_FLAG = 0x00000400 -CERT_STORE_BACKUP_RESTORE_FLAG = 0x00000800 -CERT_STORE_READONLY_FLAG = 0x00008000 -CERT_STORE_OPEN_EXISTING_FLAG = 0x00004000 -CERT_STORE_CREATE_NEW_FLAG = 0x00002000 -CERT_STORE_MAXIMUM_ALLOWED_FLAG = 0x00001000 -CERT_SYSTEM_STORE_MASK = (-65536) -CERT_SYSTEM_STORE_RELOCATE_FLAG = (-2147483648) -CERT_SYSTEM_STORE_UNPROTECTED_FLAG = 0x40000000 -CERT_SYSTEM_STORE_LOCATION_MASK = 0x00FF0000 -CERT_SYSTEM_STORE_LOCATION_SHIFT = 16 -CERT_SYSTEM_STORE_CURRENT_USER_ID = 1 -CERT_SYSTEM_STORE_LOCAL_MACHINE_ID = 2 -CERT_SYSTEM_STORE_CURRENT_SERVICE_ID = 4 -CERT_SYSTEM_STORE_SERVICES_ID = 5 -CERT_SYSTEM_STORE_USERS_ID = 6 -CERT_SYSTEM_STORE_CURRENT_USER_GROUP_POLICY_ID = 7 -CERT_SYSTEM_STORE_LOCAL_MACHINE_GROUP_POLICY_ID = 8 -CERT_SYSTEM_STORE_LOCAL_MACHINE_ENTERPRISE_ID = 9 -CERT_SYSTEM_STORE_CURRENT_USER = \ - (CERT_SYSTEM_STORE_CURRENT_USER_ID << CERT_SYSTEM_STORE_LOCATION_SHIFT) -CERT_SYSTEM_STORE_LOCAL_MACHINE = \ - (CERT_SYSTEM_STORE_LOCAL_MACHINE_ID << CERT_SYSTEM_STORE_LOCATION_SHIFT) -CERT_SYSTEM_STORE_CURRENT_SERVICE = \ - (CERT_SYSTEM_STORE_CURRENT_SERVICE_ID << CERT_SYSTEM_STORE_LOCATION_SHIFT) -CERT_SYSTEM_STORE_SERVICES = \ - (CERT_SYSTEM_STORE_SERVICES_ID << CERT_SYSTEM_STORE_LOCATION_SHIFT) -CERT_SYSTEM_STORE_USERS = \ - (CERT_SYSTEM_STORE_USERS_ID << CERT_SYSTEM_STORE_LOCATION_SHIFT) -CERT_SYSTEM_STORE_CURRENT_USER_GROUP_POLICY = \ - (CERT_SYSTEM_STORE_CURRENT_USER_GROUP_POLICY_ID << \ - CERT_SYSTEM_STORE_LOCATION_SHIFT) -CERT_SYSTEM_STORE_LOCAL_MACHINE_GROUP_POLICY = \ - (CERT_SYSTEM_STORE_LOCAL_MACHINE_GROUP_POLICY_ID << \ - CERT_SYSTEM_STORE_LOCATION_SHIFT) -CERT_SYSTEM_STORE_LOCAL_MACHINE_ENTERPRISE = \ - (CERT_SYSTEM_STORE_LOCAL_MACHINE_ENTERPRISE_ID << \ - CERT_SYSTEM_STORE_LOCATION_SHIFT) -CERT_PROT_ROOT_DISABLE_CURRENT_USER_FLAG = 0x1 -CERT_PROT_ROOT_INHIBIT_ADD_AT_INIT_FLAG = 0x2 -CERT_PROT_ROOT_INHIBIT_PURGE_LM_FLAG = 0x4 -CERT_PROT_ROOT_DISABLE_LM_AUTH_FLAG = 0x8 -CERT_PROT_ROOT_ONLY_LM_GPT_FLAG = 0x8 -CERT_PROT_ROOT_DISABLE_NT_AUTH_REQUIRED_FLAG = 0x10 -CERT_PROT_ROOT_DISABLE_NOT_DEFINED_NAME_CONSTRAINT_FLAG = 0x20 -CERT_TRUST_PUB_ALLOW_TRUST_MASK = 0x00000003 -CERT_TRUST_PUB_ALLOW_END_USER_TRUST = 0x00000000 -CERT_TRUST_PUB_ALLOW_MACHINE_ADMIN_TRUST = 0x00000001 -CERT_TRUST_PUB_ALLOW_ENTERPRISE_ADMIN_TRUST = 0x00000002 -CERT_TRUST_PUB_CHECK_PUBLISHER_REV_FLAG = 0x00000100 -CERT_TRUST_PUB_CHECK_TIMESTAMP_REV_FLAG = 0x00000200 - -CERT_AUTH_ROOT_AUTO_UPDATE_LOCAL_MACHINE_REGPATH = r"Software\Microsoft\SystemCertificates\AuthRoot\AutoUpdate" -CERT_AUTH_ROOT_AUTO_UPDATE_DISABLE_UNTRUSTED_ROOT_LOGGING_FLAG = 0x1 -CERT_AUTH_ROOT_AUTO_UPDATE_DISABLE_PARTIAL_CHAIN_LOGGING_FLAG = 0x2 -CERT_AUTH_ROOT_AUTO_UPDATE_ROOT_DIR_URL_VALUE_NAME = "RootDirUrl" -CERT_AUTH_ROOT_AUTO_UPDATE_SYNC_DELTA_TIME_VALUE_NAME = "SyncDeltaTime" -CERT_AUTH_ROOT_AUTO_UPDATE_FLAGS_VALUE_NAME = "Flags" -CERT_AUTH_ROOT_CTL_FILENAME = "authroot.stl" -CERT_AUTH_ROOT_CTL_FILENAME_A = "authroot.stl" -CERT_AUTH_ROOT_CAB_FILENAME = "authrootstl.cab" -CERT_AUTH_ROOT_SEQ_FILENAME = "authrootseq.txt" -CERT_AUTH_ROOT_CERT_EXT = ".crt" - -CERT_GROUP_POLICY_SYSTEM_STORE_REGPATH = r"Software\Policies\Microsoft\SystemCertificates" -CERT_EFSBLOB_REGPATH = CERT_GROUP_POLICY_SYSTEM_STORE_REGPATH + r"\EFS" -CERT_EFSBLOB_VALUE_NAME = "EFSBlob" -CERT_PROT_ROOT_FLAGS_REGPATH = CERT_GROUP_POLICY_SYSTEM_STORE_REGPATH +r"\Root\ProtectedRoots" -CERT_PROT_ROOT_FLAGS_VALUE_NAME = "Flags" -CERT_TRUST_PUB_SAFER_GROUP_POLICY_REGPATH = CERT_GROUP_POLICY_SYSTEM_STORE_REGPATH + r"\TrustedPublisher\Safer" -CERT_LOCAL_MACHINE_SYSTEM_STORE_REGPATH = r"Software\Microsoft\SystemCertificates" -CERT_TRUST_PUB_SAFER_LOCAL_MACHINE_REGPATH = CERT_LOCAL_MACHINE_SYSTEM_STORE_REGPATH + r"\TrustedPublisher\Safer" -CERT_TRUST_PUB_AUTHENTICODE_FLAGS_VALUE_NAME = "AuthenticodeFlags" -CERT_OCM_SUBCOMPONENTS_LOCAL_MACHINE_REGPATH = r"SOFTWARE\Microsoft\Windows\CurrentVersion\Setup\OC Manager\Subcomponents" -CERT_OCM_SUBCOMPONENTS_ROOT_AUTO_UPDATE_VALUE_NAME = r"RootAutoUpdate" -CERT_DISABLE_ROOT_AUTO_UPDATE_REGPATH = CERT_GROUP_POLICY_SYSTEM_STORE_REGPATH + r"\AuthRoot" -CERT_DISABLE_ROOT_AUTO_UPDATE_VALUE_NAME = "DisableRootAutoUpdate" -CERT_AUTH_ROOT_AUTO_UPDATE_LOCAL_MACHINE_REGPATH = CERT_LOCAL_MACHINE_SYSTEM_STORE_REGPATH + r"\AuthRoot\AutoUpdate" - -CERT_REGISTRY_STORE_REMOTE_FLAG = 0x10000 -CERT_REGISTRY_STORE_SERIALIZED_FLAG = 0x20000 -CERT_REGISTRY_STORE_CLIENT_GPT_FLAG = (-2147483648) -CERT_REGISTRY_STORE_LM_GPT_FLAG = 0x01000000 -CERT_REGISTRY_STORE_ROAMING_FLAG = 0x40000 -CERT_REGISTRY_STORE_MY_IE_DIRTY_FLAG = 0x80000 -CERT_IE_DIRTY_FLAGS_REGPATH = r"Software\Microsoft\Cryptography\IEDirtyFlags" - -CERT_FILE_STORE_COMMIT_ENABLE_FLAG = 0x10000 -CERT_LDAP_STORE_SIGN_FLAG = 0x10000 -CERT_LDAP_STORE_AREC_EXCLUSIVE_FLAG = 0x20000 -CERT_LDAP_STORE_OPENED_FLAG = 0x40000 -CERT_LDAP_STORE_UNBIND_FLAG = 0x80000 -CRYPT_OID_OPEN_STORE_PROV_FUNC = "CertDllOpenStoreProv" - -CERT_STORE_PROV_EXTERNAL_FLAG = 0x1 -CERT_STORE_PROV_DELETED_FLAG = 0x2 -CERT_STORE_PROV_NO_PERSIST_FLAG = 0x4 -CERT_STORE_PROV_SYSTEM_STORE_FLAG = 0x8 -CERT_STORE_PROV_LM_SYSTEM_STORE_FLAG = 0x10 -CERT_STORE_PROV_CLOSE_FUNC = 0 -CERT_STORE_PROV_READ_CERT_FUNC = 1 -CERT_STORE_PROV_WRITE_CERT_FUNC = 2 -CERT_STORE_PROV_DELETE_CERT_FUNC = 3 -CERT_STORE_PROV_SET_CERT_PROPERTY_FUNC = 4 -CERT_STORE_PROV_READ_CRL_FUNC = 5 -CERT_STORE_PROV_WRITE_CRL_FUNC = 6 -CERT_STORE_PROV_DELETE_CRL_FUNC = 7 -CERT_STORE_PROV_SET_CRL_PROPERTY_FUNC = 8 -CERT_STORE_PROV_READ_CTL_FUNC = 9 -CERT_STORE_PROV_WRITE_CTL_FUNC = 10 -CERT_STORE_PROV_DELETE_CTL_FUNC = 11 -CERT_STORE_PROV_SET_CTL_PROPERTY_FUNC = 12 -CERT_STORE_PROV_CONTROL_FUNC = 13 -CERT_STORE_PROV_FIND_CERT_FUNC = 14 -CERT_STORE_PROV_FREE_FIND_CERT_FUNC = 15 -CERT_STORE_PROV_GET_CERT_PROPERTY_FUNC = 16 -CERT_STORE_PROV_FIND_CRL_FUNC = 17 -CERT_STORE_PROV_FREE_FIND_CRL_FUNC = 18 -CERT_STORE_PROV_GET_CRL_PROPERTY_FUNC = 19 -CERT_STORE_PROV_FIND_CTL_FUNC = 20 -CERT_STORE_PROV_FREE_FIND_CTL_FUNC = 21 -CERT_STORE_PROV_GET_CTL_PROPERTY_FUNC = 22 -CERT_STORE_PROV_WRITE_ADD_FLAG = 0x1 -CERT_STORE_SAVE_AS_STORE = 1 -CERT_STORE_SAVE_AS_PKCS7 = 2 -CERT_STORE_SAVE_TO_FILE = 1 -CERT_STORE_SAVE_TO_MEMORY = 2 -CERT_STORE_SAVE_TO_FILENAME_A = 3 -CERT_STORE_SAVE_TO_FILENAME_W = 4 -CERT_STORE_SAVE_TO_FILENAME = CERT_STORE_SAVE_TO_FILENAME_W -CERT_CLOSE_STORE_FORCE_FLAG = 0x00000001 -CERT_CLOSE_STORE_CHECK_FLAG = 0x00000002 -CERT_COMPARE_MASK = 0xFFFF -CERT_COMPARE_SHIFT = 16 -CERT_COMPARE_ANY = 0 -CERT_COMPARE_SHA1_HASH = 1 -CERT_COMPARE_NAME = 2 -CERT_COMPARE_ATTR = 3 -CERT_COMPARE_MD5_HASH = 4 -CERT_COMPARE_PROPERTY = 5 -CERT_COMPARE_PUBLIC_KEY = 6 -CERT_COMPARE_HASH = CERT_COMPARE_SHA1_HASH -CERT_COMPARE_NAME_STR_A = 7 -CERT_COMPARE_NAME_STR_W = 8 -CERT_COMPARE_KEY_SPEC = 9 -CERT_COMPARE_ENHKEY_USAGE = 10 -CERT_COMPARE_CTL_USAGE = CERT_COMPARE_ENHKEY_USAGE -CERT_COMPARE_SUBJECT_CERT = 11 -CERT_COMPARE_ISSUER_OF = 12 -CERT_COMPARE_EXISTING = 13 -CERT_COMPARE_SIGNATURE_HASH = 14 -CERT_COMPARE_KEY_IDENTIFIER = 15 -CERT_COMPARE_CERT_ID = 16 -CERT_COMPARE_CROSS_CERT_DIST_POINTS = 17 -CERT_COMPARE_PUBKEY_MD5_HASH = 18 -CERT_FIND_ANY = (CERT_COMPARE_ANY << CERT_COMPARE_SHIFT) -CERT_FIND_SHA1_HASH = (CERT_COMPARE_SHA1_HASH << CERT_COMPARE_SHIFT) -CERT_FIND_MD5_HASH = (CERT_COMPARE_MD5_HASH << CERT_COMPARE_SHIFT) -CERT_FIND_SIGNATURE_HASH = (CERT_COMPARE_SIGNATURE_HASH << CERT_COMPARE_SHIFT) -CERT_FIND_KEY_IDENTIFIER = (CERT_COMPARE_KEY_IDENTIFIER << CERT_COMPARE_SHIFT) -CERT_FIND_HASH = CERT_FIND_SHA1_HASH -CERT_FIND_PROPERTY = (CERT_COMPARE_PROPERTY << CERT_COMPARE_SHIFT) -CERT_FIND_PUBLIC_KEY = (CERT_COMPARE_PUBLIC_KEY << CERT_COMPARE_SHIFT) -CERT_FIND_SUBJECT_NAME = (CERT_COMPARE_NAME << CERT_COMPARE_SHIFT | \ - CERT_INFO_SUBJECT_FLAG) -CERT_FIND_SUBJECT_ATTR = (CERT_COMPARE_ATTR << CERT_COMPARE_SHIFT | \ - CERT_INFO_SUBJECT_FLAG) -CERT_FIND_ISSUER_NAME = (CERT_COMPARE_NAME << CERT_COMPARE_SHIFT | \ - CERT_INFO_ISSUER_FLAG) -CERT_FIND_ISSUER_ATTR = (CERT_COMPARE_ATTR << CERT_COMPARE_SHIFT | \ - CERT_INFO_ISSUER_FLAG) -CERT_FIND_SUBJECT_STR_A = (CERT_COMPARE_NAME_STR_A << CERT_COMPARE_SHIFT | \ - CERT_INFO_SUBJECT_FLAG) -CERT_FIND_SUBJECT_STR_W = (CERT_COMPARE_NAME_STR_W << CERT_COMPARE_SHIFT | \ - CERT_INFO_SUBJECT_FLAG) -CERT_FIND_SUBJECT_STR = CERT_FIND_SUBJECT_STR_W -CERT_FIND_ISSUER_STR_A = (CERT_COMPARE_NAME_STR_A << CERT_COMPARE_SHIFT | \ - CERT_INFO_ISSUER_FLAG) -CERT_FIND_ISSUER_STR_W = (CERT_COMPARE_NAME_STR_W << CERT_COMPARE_SHIFT | \ - CERT_INFO_ISSUER_FLAG) -CERT_FIND_ISSUER_STR = CERT_FIND_ISSUER_STR_W -CERT_FIND_KEY_SPEC = (CERT_COMPARE_KEY_SPEC << CERT_COMPARE_SHIFT) -CERT_FIND_ENHKEY_USAGE = (CERT_COMPARE_ENHKEY_USAGE << CERT_COMPARE_SHIFT) -CERT_FIND_CTL_USAGE = CERT_FIND_ENHKEY_USAGE -CERT_FIND_SUBJECT_CERT = (CERT_COMPARE_SUBJECT_CERT << CERT_COMPARE_SHIFT) -CERT_FIND_ISSUER_OF = (CERT_COMPARE_ISSUER_OF << CERT_COMPARE_SHIFT) -CERT_FIND_EXISTING = (CERT_COMPARE_EXISTING << CERT_COMPARE_SHIFT) -CERT_FIND_CERT_ID = (CERT_COMPARE_CERT_ID << CERT_COMPARE_SHIFT) -CERT_FIND_CROSS_CERT_DIST_POINTS = \ - (CERT_COMPARE_CROSS_CERT_DIST_POINTS << CERT_COMPARE_SHIFT) -CERT_FIND_PUBKEY_MD5_HASH = \ - (CERT_COMPARE_PUBKEY_MD5_HASH << CERT_COMPARE_SHIFT) -CERT_FIND_OPTIONAL_ENHKEY_USAGE_FLAG = 0x1 -CERT_FIND_EXT_ONLY_ENHKEY_USAGE_FLAG = 0x2 -CERT_FIND_PROP_ONLY_ENHKEY_USAGE_FLAG = 0x4 -CERT_FIND_NO_ENHKEY_USAGE_FLAG = 0x8 -CERT_FIND_OR_ENHKEY_USAGE_FLAG = 0x10 -CERT_FIND_VALID_ENHKEY_USAGE_FLAG = 0x20 -CERT_FIND_OPTIONAL_CTL_USAGE_FLAG = CERT_FIND_OPTIONAL_ENHKEY_USAGE_FLAG -CERT_FIND_EXT_ONLY_CTL_USAGE_FLAG = \ - CERT_FIND_EXT_ONLY_ENHKEY_USAGE_FLAG -CERT_FIND_PROP_ONLY_CTL_USAGE_FLAG = \ - CERT_FIND_PROP_ONLY_ENHKEY_USAGE_FLAG -CERT_FIND_NO_CTL_USAGE_FLAG = CERT_FIND_NO_ENHKEY_USAGE_FLAG -CERT_FIND_OR_CTL_USAGE_FLAG = CERT_FIND_OR_ENHKEY_USAGE_FLAG -CERT_FIND_VALID_CTL_USAGE_FLAG = CERT_FIND_VALID_ENHKEY_USAGE_FLAG -CERT_SET_PROPERTY_IGNORE_PERSIST_ERROR_FLAG = (-2147483648) -CERT_SET_PROPERTY_INHIBIT_PERSIST_FLAG = 0x40000000 -CTL_ENTRY_FROM_PROP_CHAIN_FLAG = 0x1 -CRL_FIND_ANY = 0 -CRL_FIND_ISSUED_BY = 1 -CRL_FIND_EXISTING = 2 -CRL_FIND_ISSUED_FOR = 3 -CRL_FIND_ISSUED_BY_AKI_FLAG = 0x1 -CRL_FIND_ISSUED_BY_SIGNATURE_FLAG = 0x2 -CRL_FIND_ISSUED_BY_DELTA_FLAG = 0x4 -CRL_FIND_ISSUED_BY_BASE_FLAG = 0x8 -CERT_STORE_ADD_NEW = 1 -CERT_STORE_ADD_USE_EXISTING = 2 -CERT_STORE_ADD_REPLACE_EXISTING = 3 -CERT_STORE_ADD_ALWAYS = 4 -CERT_STORE_ADD_REPLACE_EXISTING_INHERIT_PROPERTIES = 5 -CERT_STORE_ADD_NEWER = 6 -CERT_STORE_ADD_NEWER_INHERIT_PROPERTIES = 7 -CERT_STORE_CERTIFICATE_CONTEXT = 1 -CERT_STORE_CRL_CONTEXT = 2 -CERT_STORE_CTL_CONTEXT = 3 - -CERT_STORE_ALL_CONTEXT_FLAG = -1 -CERT_STORE_CERTIFICATE_CONTEXT_FLAG = \ - (1 << CERT_STORE_CERTIFICATE_CONTEXT) -CERT_STORE_CRL_CONTEXT_FLAG = \ - (1 << CERT_STORE_CRL_CONTEXT) -CERT_STORE_CTL_CONTEXT_FLAG = \ - (1 << CERT_STORE_CTL_CONTEXT) -CTL_ANY_SUBJECT_TYPE = 1 -CTL_CERT_SUBJECT_TYPE = 2 -CTL_FIND_ANY = 0 -CTL_FIND_SHA1_HASH = 1 -CTL_FIND_MD5_HASH = 2 -CTL_FIND_USAGE = 3 -CTL_FIND_SUBJECT = 4 -CTL_FIND_EXISTING = 5 -CTL_FIND_NO_LIST_ID_CBDATA = (-1) -CTL_FIND_SAME_USAGE_FLAG = 0x1 -CERT_STORE_CTRL_RESYNC = 1 -CERT_STORE_CTRL_NOTIFY_CHANGE = 2 -CERT_STORE_CTRL_COMMIT = 3 -CERT_STORE_CTRL_AUTO_RESYNC = 4 -CERT_STORE_CTRL_CANCEL_NOTIFY = 5 -CERT_STORE_CTRL_INHIBIT_DUPLICATE_HANDLE_FLAG = 0x1 -CERT_STORE_CTRL_COMMIT_FORCE_FLAG = 0x1 -CERT_STORE_CTRL_COMMIT_CLEAR_FLAG = 0x2 -CERT_STORE_LOCALIZED_NAME_PROP_ID = 0x1000 -CERT_CREATE_CONTEXT_NOCOPY_FLAG = 0x1 -CERT_CREATE_CONTEXT_SORTED_FLAG = 0x2 -CERT_CREATE_CONTEXT_NO_HCRYPTMSG_FLAG = 0x4 -CERT_CREATE_CONTEXT_NO_ENTRY_FLAG = 0x8 - -CERT_PHYSICAL_STORE_ADD_ENABLE_FLAG = 0x1 -CERT_PHYSICAL_STORE_OPEN_DISABLE_FLAG = 0x2 -CERT_PHYSICAL_STORE_REMOTE_OPEN_DISABLE_FLAG = 0x4 -CERT_PHYSICAL_STORE_INSERT_COMPUTER_NAME_ENABLE_FLAG = 0x8 -CERT_PHYSICAL_STORE_PREDEFINED_ENUM_FLAG = 0x1 - -# Names of physical cert stores -CERT_PHYSICAL_STORE_DEFAULT_NAME = ".Default" -CERT_PHYSICAL_STORE_GROUP_POLICY_NAME = ".GroupPolicy" -CERT_PHYSICAL_STORE_LOCAL_MACHINE_NAME = ".LocalMachine" -CERT_PHYSICAL_STORE_DS_USER_CERTIFICATE_NAME = ".UserCertificate" -CERT_PHYSICAL_STORE_LOCAL_MACHINE_GROUP_POLICY_NAME = ".LocalMachineGroupPolicy" -CERT_PHYSICAL_STORE_ENTERPRISE_NAME = ".Enterprise" -CERT_PHYSICAL_STORE_AUTH_ROOT_NAME = ".AuthRoot" -CERT_PHYSICAL_STORE_SMART_CARD_NAME = ".SmartCard" - -CRYPT_OID_OPEN_SYSTEM_STORE_PROV_FUNC = "CertDllOpenSystemStoreProv" -CRYPT_OID_REGISTER_SYSTEM_STORE_FUNC = "CertDllRegisterSystemStore" -CRYPT_OID_UNREGISTER_SYSTEM_STORE_FUNC = "CertDllUnregisterSystemStore" -CRYPT_OID_ENUM_SYSTEM_STORE_FUNC = "CertDllEnumSystemStore" -CRYPT_OID_REGISTER_PHYSICAL_STORE_FUNC = "CertDllRegisterPhysicalStore" -CRYPT_OID_UNREGISTER_PHYSICAL_STORE_FUNC = "CertDllUnregisterPhysicalStore" -CRYPT_OID_ENUM_PHYSICAL_STORE_FUNC = "CertDllEnumPhysicalStore" -CRYPT_OID_SYSTEM_STORE_LOCATION_VALUE_NAME = "SystemStoreLocation" - -CMSG_TRUSTED_SIGNER_FLAG = 0x1 -CMSG_SIGNER_ONLY_FLAG = 0x2 -CMSG_USE_SIGNER_INDEX_FLAG = 0x4 -CMSG_CMS_ENCAPSULATED_CTL_FLAG = 0x00008000 -CMSG_ENCODE_SORTED_CTL_FLAG = 0x1 -CMSG_ENCODE_HASHED_SUBJECT_IDENTIFIER_FLAG = 0x2 -CERT_VERIFY_INHIBIT_CTL_UPDATE_FLAG = 0x1 -CERT_VERIFY_TRUSTED_SIGNERS_FLAG = 0x2 -CERT_VERIFY_NO_TIME_CHECK_FLAG = 0x4 -CERT_VERIFY_ALLOW_MORE_USAGE_FLAG = 0x8 -CERT_VERIFY_UPDATED_CTL_FLAG = 0x1 -CERT_CONTEXT_REVOCATION_TYPE = 1 -CERT_VERIFY_REV_CHAIN_FLAG = 0x00000001 -CERT_VERIFY_CACHE_ONLY_BASED_REVOCATION = 0x00000002 -CERT_VERIFY_REV_ACCUMULATIVE_TIMEOUT_FLAG = 0x00000004 -CERT_UNICODE_IS_RDN_ATTRS_FLAG = 0x1 -CERT_CASE_INSENSITIVE_IS_RDN_ATTRS_FLAG = 0x2 -CRYPT_VERIFY_CERT_SIGN_SUBJECT_BLOB = 1 -CRYPT_VERIFY_CERT_SIGN_SUBJECT_CERT = 2 -CRYPT_VERIFY_CERT_SIGN_SUBJECT_CRL = 3 -CRYPT_VERIFY_CERT_SIGN_ISSUER_PUBKEY = 1 -CRYPT_VERIFY_CERT_SIGN_ISSUER_CERT = 2 -CRYPT_VERIFY_CERT_SIGN_ISSUER_CHAIN = 3 -CRYPT_VERIFY_CERT_SIGN_ISSUER_NULL = 4 -CRYPT_DEFAULT_CONTEXT_AUTO_RELEASE_FLAG = 0x00000001 -CRYPT_DEFAULT_CONTEXT_PROCESS_FLAG = 0x00000002 -CRYPT_DEFAULT_CONTEXT_CERT_SIGN_OID = 1 -CRYPT_DEFAULT_CONTEXT_MULTI_CERT_SIGN_OID = 2 -CRYPT_OID_EXPORT_PUBLIC_KEY_INFO_FUNC = "CryptDllExportPublicKeyInfoEx" -CRYPT_OID_IMPORT_PUBLIC_KEY_INFO_FUNC = "CryptDllImportPublicKeyInfoEx" -CRYPT_ACQUIRE_CACHE_FLAG = 0x00000001 -CRYPT_ACQUIRE_USE_PROV_INFO_FLAG = 0x00000002 -CRYPT_ACQUIRE_COMPARE_KEY_FLAG = 0x00000004 -CRYPT_ACQUIRE_SILENT_FLAG = 0x00000040 -CRYPT_FIND_USER_KEYSET_FLAG = 0x00000001 -CRYPT_FIND_MACHINE_KEYSET_FLAG = 0x00000002 -CRYPT_FIND_SILENT_KEYSET_FLAG = 0x00000040 -CRYPT_OID_IMPORT_PRIVATE_KEY_INFO_FUNC = "CryptDllImportPrivateKeyInfoEx" -CRYPT_OID_EXPORT_PRIVATE_KEY_INFO_FUNC = "CryptDllExportPrivateKeyInfoEx" -CRYPT_DELETE_KEYSET = CRYPT_DELETEKEYSET -CERT_SIMPLE_NAME_STR = 1 -CERT_OID_NAME_STR = 2 -CERT_X500_NAME_STR = 3 -CERT_NAME_STR_SEMICOLON_FLAG = 0x40000000 -CERT_NAME_STR_NO_PLUS_FLAG = 0x20000000 -CERT_NAME_STR_NO_QUOTING_FLAG = 0x10000000 -CERT_NAME_STR_CRLF_FLAG = 0x08000000 -CERT_NAME_STR_COMMA_FLAG = 0x04000000 -CERT_NAME_STR_REVERSE_FLAG = 0x02000000 -CERT_NAME_STR_DISABLE_IE4_UTF8_FLAG = 0x00010000 -CERT_NAME_STR_ENABLE_T61_UNICODE_FLAG = 0x00020000 -CERT_NAME_STR_ENABLE_UTF8_UNICODE_FLAG = 0x00040000 -CERT_NAME_EMAIL_TYPE = 1 -CERT_NAME_RDN_TYPE = 2 -CERT_NAME_ATTR_TYPE = 3 -CERT_NAME_SIMPLE_DISPLAY_TYPE = 4 -CERT_NAME_FRIENDLY_DISPLAY_TYPE = 5 -CERT_NAME_DNS_TYPE = 6 -CERT_NAME_URL_TYPE = 7 -CERT_NAME_UPN_TYPE = 8 -CERT_NAME_ISSUER_FLAG = 0x1 -CERT_NAME_DISABLE_IE4_UTF8_FLAG = 0x00010000 -CRYPT_MESSAGE_BARE_CONTENT_OUT_FLAG = 0x00000001 -CRYPT_MESSAGE_ENCAPSULATED_CONTENT_OUT_FLAG = 0x00000002 -CRYPT_MESSAGE_KEYID_SIGNER_FLAG = 0x00000004 -CRYPT_MESSAGE_SILENT_KEYSET_FLAG = 0x00000040 -CRYPT_MESSAGE_KEYID_RECIPIENT_FLAG = 0x4 -CERT_QUERY_OBJECT_FILE = 0x00000001 -CERT_QUERY_OBJECT_BLOB = 0x00000002 -CERT_QUERY_CONTENT_CERT = 1 -CERT_QUERY_CONTENT_CTL = 2 -CERT_QUERY_CONTENT_CRL = 3 -CERT_QUERY_CONTENT_SERIALIZED_STORE = 4 -CERT_QUERY_CONTENT_SERIALIZED_CERT = 5 -CERT_QUERY_CONTENT_SERIALIZED_CTL = 6 -CERT_QUERY_CONTENT_SERIALIZED_CRL = 7 -CERT_QUERY_CONTENT_PKCS7_SIGNED = 8 -CERT_QUERY_CONTENT_PKCS7_UNSIGNED = 9 -CERT_QUERY_CONTENT_PKCS7_SIGNED_EMBED = 10 -CERT_QUERY_CONTENT_PKCS10 = 11 -CERT_QUERY_CONTENT_PFX = 12 -CERT_QUERY_CONTENT_CERT_PAIR = 13 -CERT_QUERY_CONTENT_FLAG_CERT = \ - ( 1 << CERT_QUERY_CONTENT_CERT) -CERT_QUERY_CONTENT_FLAG_CTL = \ - ( 1 << CERT_QUERY_CONTENT_CTL) -CERT_QUERY_CONTENT_FLAG_CRL = \ - ( 1 << CERT_QUERY_CONTENT_CRL) -CERT_QUERY_CONTENT_FLAG_SERIALIZED_STORE = \ - ( 1 << CERT_QUERY_CONTENT_SERIALIZED_STORE) -CERT_QUERY_CONTENT_FLAG_SERIALIZED_CERT = \ - ( 1 << CERT_QUERY_CONTENT_SERIALIZED_CERT) -CERT_QUERY_CONTENT_FLAG_SERIALIZED_CTL = \ - ( 1 << CERT_QUERY_CONTENT_SERIALIZED_CTL) -CERT_QUERY_CONTENT_FLAG_SERIALIZED_CRL = \ - ( 1 << CERT_QUERY_CONTENT_SERIALIZED_CRL) -CERT_QUERY_CONTENT_FLAG_PKCS7_SIGNED = \ - ( 1 << CERT_QUERY_CONTENT_PKCS7_SIGNED) -CERT_QUERY_CONTENT_FLAG_PKCS7_UNSIGNED = \ - ( 1 << CERT_QUERY_CONTENT_PKCS7_UNSIGNED) -CERT_QUERY_CONTENT_FLAG_PKCS7_SIGNED_EMBED = \ - ( 1 << CERT_QUERY_CONTENT_PKCS7_SIGNED_EMBED) -CERT_QUERY_CONTENT_FLAG_PKCS10 = \ - ( 1 << CERT_QUERY_CONTENT_PKCS10) -CERT_QUERY_CONTENT_FLAG_PFX = \ - ( 1 << CERT_QUERY_CONTENT_PFX) -CERT_QUERY_CONTENT_FLAG_CERT_PAIR = \ - ( 1 << CERT_QUERY_CONTENT_CERT_PAIR) -CERT_QUERY_CONTENT_FLAG_ALL = \ - CERT_QUERY_CONTENT_FLAG_CERT | \ - CERT_QUERY_CONTENT_FLAG_CTL | \ - CERT_QUERY_CONTENT_FLAG_CRL | \ - CERT_QUERY_CONTENT_FLAG_SERIALIZED_STORE | \ - CERT_QUERY_CONTENT_FLAG_SERIALIZED_CERT | \ - CERT_QUERY_CONTENT_FLAG_SERIALIZED_CTL | \ - CERT_QUERY_CONTENT_FLAG_SERIALIZED_CRL | \ - CERT_QUERY_CONTENT_FLAG_PKCS7_SIGNED | \ - CERT_QUERY_CONTENT_FLAG_PKCS7_UNSIGNED | \ - CERT_QUERY_CONTENT_FLAG_PKCS7_SIGNED_EMBED | \ - CERT_QUERY_CONTENT_FLAG_PKCS10 | \ - CERT_QUERY_CONTENT_FLAG_PFX | \ - CERT_QUERY_CONTENT_FLAG_CERT_PAIR -CERT_QUERY_FORMAT_BINARY = 1 -CERT_QUERY_FORMAT_BASE64_ENCODED = 2 -CERT_QUERY_FORMAT_ASN_ASCII_HEX_ENCODED = 3 -CERT_QUERY_FORMAT_FLAG_BINARY = \ - ( 1 << CERT_QUERY_FORMAT_BINARY) -CERT_QUERY_FORMAT_FLAG_BASE64_ENCODED = \ - ( 1 << CERT_QUERY_FORMAT_BASE64_ENCODED) -CERT_QUERY_FORMAT_FLAG_ASN_ASCII_HEX_ENCODED = \ - ( 1 << CERT_QUERY_FORMAT_ASN_ASCII_HEX_ENCODED) -CERT_QUERY_FORMAT_FLAG_ALL = \ - CERT_QUERY_FORMAT_FLAG_BINARY | \ - CERT_QUERY_FORMAT_FLAG_BASE64_ENCODED | \ - CERT_QUERY_FORMAT_FLAG_ASN_ASCII_HEX_ENCODED - -CREDENTIAL_OID_PASSWORD_CREDENTIALS_A = 1 -CREDENTIAL_OID_PASSWORD_CREDENTIALS_W = 2 -CREDENTIAL_OID_PASSWORD_CREDENTIALS = CREDENTIAL_OID_PASSWORD_CREDENTIALS_W - -SCHEME_OID_RETRIEVE_ENCODED_OBJECT_FUNC = "SchemeDllRetrieveEncodedObject" -SCHEME_OID_RETRIEVE_ENCODED_OBJECTW_FUNC = "SchemeDllRetrieveEncodedObjectW" -CONTEXT_OID_CREATE_OBJECT_CONTEXT_FUNC = "ContextDllCreateObjectContext" -CONTEXT_OID_CERTIFICATE = 1 -CONTEXT_OID_CRL = 2 -CONTEXT_OID_CTL = 3 -CONTEXT_OID_PKCS7 = 4 -CONTEXT_OID_CAPI2_ANY = 5 -CONTEXT_OID_OCSP_RESP = 6 - -CRYPT_RETRIEVE_MULTIPLE_OBJECTS = 0x00000001 -CRYPT_CACHE_ONLY_RETRIEVAL = 0x00000002 -CRYPT_WIRE_ONLY_RETRIEVAL = 0x00000004 -CRYPT_DONT_CACHE_RESULT = 0x00000008 -CRYPT_ASYNC_RETRIEVAL = 0x00000010 -CRYPT_STICKY_CACHE_RETRIEVAL = 0x00001000 -CRYPT_LDAP_SCOPE_BASE_ONLY_RETRIEVAL = 0x00002000 -CRYPT_OFFLINE_CHECK_RETRIEVAL = 0x00004000 -CRYPT_LDAP_INSERT_ENTRY_ATTRIBUTE = 0x00008000 -CRYPT_LDAP_SIGN_RETRIEVAL = 0x00010000 -CRYPT_NO_AUTH_RETRIEVAL = 0x00020000 -CRYPT_LDAP_AREC_EXCLUSIVE_RETRIEVAL = 0x00040000 -CRYPT_AIA_RETRIEVAL = 0x00080000 -CRYPT_VERIFY_CONTEXT_SIGNATURE = 0x00000020 -CRYPT_VERIFY_DATA_HASH = 0x00000040 -CRYPT_KEEP_TIME_VALID = 0x00000080 -CRYPT_DONT_VERIFY_SIGNATURE = 0x00000100 -CRYPT_DONT_CHECK_TIME_VALIDITY = 0x00000200 -CRYPT_CHECK_FRESHNESS_TIME_VALIDITY = 0x00000400 -CRYPT_ACCUMULATIVE_TIMEOUT = 0x00000800 -CRYPT_PARAM_ASYNC_RETRIEVAL_COMPLETION = 1 -CRYPT_PARAM_CANCEL_ASYNC_RETRIEVAL = 2 -CRYPT_GET_URL_FROM_PROPERTY = 0x00000001 -CRYPT_GET_URL_FROM_EXTENSION = 0x00000002 -CRYPT_GET_URL_FROM_UNAUTH_ATTRIBUTE = 0x00000004 -CRYPT_GET_URL_FROM_AUTH_ATTRIBUTE = 0x00000008 -URL_OID_GET_OBJECT_URL_FUNC = "UrlDllGetObjectUrl" -TIME_VALID_OID_GET_OBJECT_FUNC = "TimeValidDllGetObject" -TIME_VALID_OID_FLUSH_OBJECT_FUNC = "TimeValidDllFlushObject" - -TIME_VALID_OID_GET_CTL = 1 -TIME_VALID_OID_GET_CRL = 2 -TIME_VALID_OID_GET_CRL_FROM_CERT = 3 -TIME_VALID_OID_GET_FRESHEST_CRL_FROM_CERT = 4 -TIME_VALID_OID_GET_FRESHEST_CRL_FROM_CRL = 5 - -TIME_VALID_OID_FLUSH_CTL = 1 -TIME_VALID_OID_FLUSH_CRL = 2 -TIME_VALID_OID_FLUSH_CRL_FROM_CERT = 3 -TIME_VALID_OID_FLUSH_FRESHEST_CRL_FROM_CERT = 4 -TIME_VALID_OID_FLUSH_FRESHEST_CRL_FROM_CRL = 5 - -CRYPTPROTECT_PROMPT_ON_UNPROTECT = 0x1 -CRYPTPROTECT_PROMPT_ON_PROTECT = 0x2 -CRYPTPROTECT_PROMPT_RESERVED = 0x04 -CRYPTPROTECT_PROMPT_STRONG = 0x08 -CRYPTPROTECT_PROMPT_REQUIRE_STRONG = 0x10 -CRYPTPROTECT_UI_FORBIDDEN = 0x1 -CRYPTPROTECT_LOCAL_MACHINE = 0x4 -CRYPTPROTECT_CRED_SYNC = 0x8 -CRYPTPROTECT_AUDIT = 0x10 -CRYPTPROTECT_NO_RECOVERY = 0x20 -CRYPTPROTECT_VERIFY_PROTECTION = 0x40 -CRYPTPROTECT_CRED_REGENERATE = 0x80 -CRYPTPROTECT_FIRST_RESERVED_FLAGVAL = 0x0FFFFFFF -CRYPTPROTECT_LAST_RESERVED_FLAGVAL = (-1) -CRYPTPROTECTMEMORY_BLOCK_SIZE = 16 -CRYPTPROTECTMEMORY_SAME_PROCESS = 0x00 -CRYPTPROTECTMEMORY_CROSS_PROCESS = 0x01 -CRYPTPROTECTMEMORY_SAME_LOGON = 0x02 -CERT_CREATE_SELFSIGN_NO_SIGN = 1 -CERT_CREATE_SELFSIGN_NO_KEY_INFO = 2 -CRYPT_KEYID_MACHINE_FLAG = 0x00000020 -CRYPT_KEYID_ALLOC_FLAG = 0x00008000 -CRYPT_KEYID_DELETE_FLAG = 0x00000010 -CRYPT_KEYID_SET_NEW_FLAG = 0x00002000 -CERT_CHAIN_MAX_AIA_URL_COUNT_IN_CERT_DEFAULT = 5 -CERT_CHAIN_MAX_AIA_URL_RETRIEVAL_COUNT_PER_CHAIN_DEFAULT = 10 -CERT_CHAIN_MAX_AIA_URL_RETRIEVAL_BYTE_COUNT_DEFAULT = 100000 -CERT_CHAIN_MAX_AIA_URL_RETRIEVAL_CERT_COUNT_DEFAULT = 10 -CERT_CHAIN_CACHE_END_CERT = 0x00000001 -CERT_CHAIN_THREAD_STORE_SYNC = 0x00000002 -CERT_CHAIN_CACHE_ONLY_URL_RETRIEVAL = 0x00000004 -CERT_CHAIN_USE_LOCAL_MACHINE_STORE = 0x00000008 -CERT_CHAIN_ENABLE_CACHE_AUTO_UPDATE = 0x00000010 -CERT_CHAIN_ENABLE_SHARE_STORE = 0x00000020 -CERT_TRUST_NO_ERROR = 0x00000000 -CERT_TRUST_IS_NOT_TIME_VALID = 0x00000001 -CERT_TRUST_IS_NOT_TIME_NESTED = 0x00000002 -CERT_TRUST_IS_REVOKED = 0x00000004 -CERT_TRUST_IS_NOT_SIGNATURE_VALID = 0x00000008 -CERT_TRUST_IS_NOT_VALID_FOR_USAGE = 0x00000010 -CERT_TRUST_IS_UNTRUSTED_ROOT = 0x00000020 -CERT_TRUST_REVOCATION_STATUS_UNKNOWN = 0x00000040 -CERT_TRUST_IS_CYCLIC = 0x00000080 -CERT_TRUST_INVALID_EXTENSION = 0x00000100 -CERT_TRUST_INVALID_POLICY_CONSTRAINTS = 0x00000200 -CERT_TRUST_INVALID_BASIC_CONSTRAINTS = 0x00000400 -CERT_TRUST_INVALID_NAME_CONSTRAINTS = 0x00000800 -CERT_TRUST_HAS_NOT_SUPPORTED_NAME_CONSTRAINT = 0x00001000 -CERT_TRUST_HAS_NOT_DEFINED_NAME_CONSTRAINT = 0x00002000 -CERT_TRUST_HAS_NOT_PERMITTED_NAME_CONSTRAINT = 0x00004000 -CERT_TRUST_HAS_EXCLUDED_NAME_CONSTRAINT = 0x00008000 -CERT_TRUST_IS_OFFLINE_REVOCATION = 0x01000000 -CERT_TRUST_NO_ISSUANCE_CHAIN_POLICY = 0x02000000 -CERT_TRUST_IS_PARTIAL_CHAIN = 0x00010000 -CERT_TRUST_CTL_IS_NOT_TIME_VALID = 0x00020000 -CERT_TRUST_CTL_IS_NOT_SIGNATURE_VALID = 0x00040000 -CERT_TRUST_CTL_IS_NOT_VALID_FOR_USAGE = 0x00080000 -CERT_TRUST_HAS_EXACT_MATCH_ISSUER = 0x00000001 -CERT_TRUST_HAS_KEY_MATCH_ISSUER = 0x00000002 -CERT_TRUST_HAS_NAME_MATCH_ISSUER = 0x00000004 -CERT_TRUST_IS_SELF_SIGNED = 0x00000008 -CERT_TRUST_HAS_PREFERRED_ISSUER = 0x00000100 -CERT_TRUST_HAS_ISSUANCE_CHAIN_POLICY = 0x00000200 -CERT_TRUST_HAS_VALID_NAME_CONSTRAINTS = 0x00000400 -CERT_TRUST_IS_COMPLEX_CHAIN = 0x00010000 -USAGE_MATCH_TYPE_AND = 0x00000000 -USAGE_MATCH_TYPE_OR = 0x00000001 -CERT_CHAIN_REVOCATION_CHECK_END_CERT = 0x10000000 -CERT_CHAIN_REVOCATION_CHECK_CHAIN = 0x20000000 -CERT_CHAIN_REVOCATION_CHECK_CHAIN_EXCLUDE_ROOT = 0x40000000 -CERT_CHAIN_REVOCATION_CHECK_CACHE_ONLY = (-2147483648) -CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT = 0x08000000 -CERT_CHAIN_DISABLE_PASS1_QUALITY_FILTERING = 0x00000040 -CERT_CHAIN_RETURN_LOWER_QUALITY_CONTEXTS = 0x00000080 -CERT_CHAIN_DISABLE_AUTH_ROOT_AUTO_UPDATE = 0x00000100 -CERT_CHAIN_TIMESTAMP_TIME = 0x00000200 -REVOCATION_OID_CRL_REVOCATION = 1 -CERT_CHAIN_FIND_BY_ISSUER = 1 -CERT_CHAIN_FIND_BY_ISSUER_COMPARE_KEY_FLAG = 0x0001 -CERT_CHAIN_FIND_BY_ISSUER_COMPLEX_CHAIN_FLAG = 0x0002 -CERT_CHAIN_FIND_BY_ISSUER_CACHE_ONLY_URL_FLAG = 0x0004 -CERT_CHAIN_FIND_BY_ISSUER_LOCAL_MACHINE_FLAG = 0x0008 -CERT_CHAIN_FIND_BY_ISSUER_NO_KEY_FLAG = 0x4000 -CERT_CHAIN_FIND_BY_ISSUER_CACHE_ONLY_FLAG = 0x8000 -CERT_CHAIN_POLICY_IGNORE_NOT_TIME_VALID_FLAG = 0x00000001 -CERT_CHAIN_POLICY_IGNORE_CTL_NOT_TIME_VALID_FLAG = 0x00000002 -CERT_CHAIN_POLICY_IGNORE_NOT_TIME_NESTED_FLAG = 0x00000004 -CERT_CHAIN_POLICY_IGNORE_INVALID_BASIC_CONSTRAINTS_FLAG = 0x00000008 -CERT_CHAIN_POLICY_IGNORE_ALL_NOT_TIME_VALID_FLAGS = ( \ - CERT_CHAIN_POLICY_IGNORE_NOT_TIME_VALID_FLAG | \ - CERT_CHAIN_POLICY_IGNORE_CTL_NOT_TIME_VALID_FLAG | \ - CERT_CHAIN_POLICY_IGNORE_NOT_TIME_NESTED_FLAG \ - ) -CERT_CHAIN_POLICY_ALLOW_UNKNOWN_CA_FLAG = 0x00000010 -CERT_CHAIN_POLICY_IGNORE_WRONG_USAGE_FLAG = 0x00000020 -CERT_CHAIN_POLICY_IGNORE_INVALID_NAME_FLAG = 0x00000040 -CERT_CHAIN_POLICY_IGNORE_INVALID_POLICY_FLAG = 0x00000080 -CERT_CHAIN_POLICY_IGNORE_END_REV_UNKNOWN_FLAG = 0x00000100 -CERT_CHAIN_POLICY_IGNORE_CTL_SIGNER_REV_UNKNOWN_FLAG = 0x00000200 -CERT_CHAIN_POLICY_IGNORE_CA_REV_UNKNOWN_FLAG = 0x00000400 -CERT_CHAIN_POLICY_IGNORE_ROOT_REV_UNKNOWN_FLAG = 0x00000800 -CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS = ( \ - CERT_CHAIN_POLICY_IGNORE_END_REV_UNKNOWN_FLAG | \ - CERT_CHAIN_POLICY_IGNORE_CTL_SIGNER_REV_UNKNOWN_FLAG | \ - CERT_CHAIN_POLICY_IGNORE_CA_REV_UNKNOWN_FLAG | \ - CERT_CHAIN_POLICY_IGNORE_ROOT_REV_UNKNOWN_FLAG \ - ) -CERT_CHAIN_POLICY_ALLOW_TESTROOT_FLAG = 0x00008000 -CERT_CHAIN_POLICY_TRUST_TESTROOT_FLAG = 0x00004000 -CRYPT_OID_VERIFY_CERTIFICATE_CHAIN_POLICY_FUNC = \ - "CertDllVerifyCertificateChainPolicy" -AUTHTYPE_CLIENT = 1 -AUTHTYPE_SERVER = 2 -BASIC_CONSTRAINTS_CERT_CHAIN_POLICY_CA_FLAG = (-2147483648) -BASIC_CONSTRAINTS_CERT_CHAIN_POLICY_END_ENTITY_FLAG = 0x40000000 -MICROSOFT_ROOT_CERT_CHAIN_POLICY_ENABLE_TEST_ROOT_FLAG = 0x00010000 -CRYPT_STRING_BASE64HEADER = 0x00000000 -CRYPT_STRING_BASE64 = 0x00000001 -CRYPT_STRING_BINARY = 0x00000002 -CRYPT_STRING_BASE64REQUESTHEADER = 0x00000003 -CRYPT_STRING_HEX = 0x00000004 -CRYPT_STRING_HEXASCII = 0x00000005 -CRYPT_STRING_BASE64_ANY = 0x00000006 -CRYPT_STRING_ANY = 0x00000007 -CRYPT_STRING_HEX_ANY = 0x00000008 -CRYPT_STRING_BASE64X509CRLHEADER = 0x00000009 -CRYPT_STRING_HEXADDR = 0x0000000a -CRYPT_STRING_HEXASCIIADDR = 0x0000000b -CRYPT_STRING_NOCR = (-2147483648) -CRYPT_USER_KEYSET = 0x00001000 -PKCS12_IMPORT_RESERVED_MASK = (-65536) -REPORT_NO_PRIVATE_KEY = 0x0001 -REPORT_NOT_ABLE_TO_EXPORT_PRIVATE_KEY = 0x0002 -EXPORT_PRIVATE_KEYS = 0x0004 -PKCS12_EXPORT_RESERVED_MASK = (-65536) - -# Certificate store provider types used with CertOpenStore -CERT_STORE_PROV_MSG = 1 -CERT_STORE_PROV_MEMORY = 2 -CERT_STORE_PROV_FILE = 3 -CERT_STORE_PROV_REG = 4 -CERT_STORE_PROV_PKCS7 = 5 -CERT_STORE_PROV_SERIALIZED = 6 -CERT_STORE_PROV_FILENAME = 8 -CERT_STORE_PROV_SYSTEM = 10 -CERT_STORE_PROV_COLLECTION = 11 -CERT_STORE_PROV_SYSTEM_REGISTRY = 13 -CERT_STORE_PROV_PHYSICAL = 14 -CERT_STORE_PROV_SMART_CARD = 15 -CERT_STORE_PROV_LDAP = 16 - -URL_OID_CERTIFICATE_ISSUER = 1 -URL_OID_CERTIFICATE_CRL_DIST_POINT = 2 -URL_OID_CTL_ISSUER = 3 -URL_OID_CTL_NEXT_UPDATE = 4 -URL_OID_CRL_ISSUER = 5 -URL_OID_CERTIFICATE_FRESHEST_CRL = 6 -URL_OID_CRL_FRESHEST_CRL = 7 -URL_OID_CROSS_CERT_DIST_POINT = 8 -URL_OID_CERTIFICATE_OCSP = 9 -URL_OID_CERTIFICATE_OCSP_AND_CRL_DIST_POINT = 10 -URL_OID_CERTIFICATE_CRL_DIST_POINT_AND_OCSP = 11 -URL_OID_CROSS_CERT_SUBJECT_INFO_ACCESS = 12 -URL_OID_CERTIFICATE_ONLY_OCSP = 13 diff --git a/typings/win32helper/win32inetcon.pyi b/typings/win32helper/win32inetcon.pyi deleted file mode 100644 index 3338fe25..00000000 --- a/typings/win32helper/win32inetcon.pyi +++ /dev/null @@ -1,1103 +0,0 @@ -# Generated by h2py from \mssdk\include\WinInet.h - -INTERNET_INVALID_PORT_NUMBER = 0 -INTERNET_DEFAULT_FTP_PORT = 21 -INTERNET_DEFAULT_GOPHER_PORT = 70 -INTERNET_DEFAULT_HTTP_PORT = 80 -INTERNET_DEFAULT_HTTPS_PORT = 443 -INTERNET_DEFAULT_SOCKS_PORT = 1080 -INTERNET_MAX_HOST_NAME_LENGTH = 256 -INTERNET_MAX_USER_NAME_LENGTH = 128 -INTERNET_MAX_PASSWORD_LENGTH = 128 -INTERNET_MAX_PORT_NUMBER_LENGTH = 5 -INTERNET_MAX_PORT_NUMBER_VALUE = 65535 -INTERNET_MAX_PATH_LENGTH = 2048 -INTERNET_MAX_SCHEME_LENGTH = 32 -INTERNET_KEEP_ALIVE_ENABLED = 1 -INTERNET_KEEP_ALIVE_DISABLED = 0 -INTERNET_REQFLAG_FROM_CACHE = 0x00000001 -INTERNET_REQFLAG_ASYNC = 0x00000002 -INTERNET_REQFLAG_VIA_PROXY = 0x00000004 -INTERNET_REQFLAG_NO_HEADERS = 0x00000008 -INTERNET_REQFLAG_PASSIVE = 0x00000010 -INTERNET_REQFLAG_CACHE_WRITE_DISABLED = 0x00000040 -INTERNET_REQFLAG_NET_TIMEOUT = 0x00000080 -INTERNET_FLAG_RELOAD = (-2147483648) -INTERNET_FLAG_RAW_DATA = 0x40000000 -INTERNET_FLAG_EXISTING_CONNECT = 0x20000000 -INTERNET_FLAG_ASYNC = 0x10000000 -INTERNET_FLAG_PASSIVE = 0x08000000 -INTERNET_FLAG_NO_CACHE_WRITE = 0x04000000 -INTERNET_FLAG_DONT_CACHE = INTERNET_FLAG_NO_CACHE_WRITE -INTERNET_FLAG_MAKE_PERSISTENT = 0x02000000 -INTERNET_FLAG_FROM_CACHE = 0x01000000 -INTERNET_FLAG_OFFLINE = INTERNET_FLAG_FROM_CACHE -INTERNET_FLAG_SECURE = 0x00800000 -INTERNET_FLAG_KEEP_CONNECTION = 0x00400000 -INTERNET_FLAG_NO_AUTO_REDIRECT = 0x00200000 -INTERNET_FLAG_READ_PREFETCH = 0x00100000 -INTERNET_FLAG_NO_COOKIES = 0x00080000 -INTERNET_FLAG_NO_AUTH = 0x00040000 -INTERNET_FLAG_RESTRICTED_ZONE = 0x00020000 -INTERNET_FLAG_CACHE_IF_NET_FAIL = 0x00010000 -INTERNET_FLAG_IGNORE_REDIRECT_TO_HTTP = 0x00008000 -INTERNET_FLAG_IGNORE_REDIRECT_TO_HTTPS = 0x00004000 -INTERNET_FLAG_IGNORE_CERT_DATE_INVALID = 0x00002000 -INTERNET_FLAG_IGNORE_CERT_CN_INVALID = 0x00001000 -INTERNET_FLAG_RESYNCHRONIZE = 0x00000800 -INTERNET_FLAG_HYPERLINK = 0x00000400 -INTERNET_FLAG_NO_UI = 0x00000200 -INTERNET_FLAG_PRAGMA_NOCACHE = 0x00000100 -INTERNET_FLAG_CACHE_ASYNC = 0x00000080 -INTERNET_FLAG_FORMS_SUBMIT = 0x00000040 -INTERNET_FLAG_FWD_BACK = 0x00000020 -INTERNET_FLAG_NEED_FILE = 0x00000010 -INTERNET_FLAG_MUST_CACHE_REQUEST = INTERNET_FLAG_NEED_FILE -SECURITY_INTERNET_MASK = (INTERNET_FLAG_IGNORE_CERT_CN_INVALID | \ - INTERNET_FLAG_IGNORE_CERT_DATE_INVALID | \ - INTERNET_FLAG_IGNORE_REDIRECT_TO_HTTPS | \ - INTERNET_FLAG_IGNORE_REDIRECT_TO_HTTP ) -INTERNET_ERROR_MASK_INSERT_CDROM = 0x1 -INTERNET_ERROR_MASK_COMBINED_SEC_CERT = 0x2 -INTERNET_ERROR_MASK_NEED_MSN_SSPI_PKG = 0X4 -INTERNET_ERROR_MASK_LOGIN_FAILURE_DISPLAY_ENTITY_BODY = 0x8 -WININET_API_FLAG_ASYNC = 0x00000001 -WININET_API_FLAG_SYNC = 0x00000004 -WININET_API_FLAG_USE_CONTEXT = 0x00000008 -INTERNET_NO_CALLBACK = 0 -IDSI_FLAG_KEEP_ALIVE = 0x00000001 -IDSI_FLAG_SECURE = 0x00000002 -IDSI_FLAG_PROXY = 0x00000004 -IDSI_FLAG_TUNNEL = 0x00000008 -INTERNET_PER_CONN_FLAGS = 1 -INTERNET_PER_CONN_PROXY_SERVER = 2 -INTERNET_PER_CONN_PROXY_BYPASS = 3 -INTERNET_PER_CONN_AUTOCONFIG_URL = 4 -INTERNET_PER_CONN_AUTODISCOVERY_FLAGS = 5 -INTERNET_PER_CONN_AUTOCONFIG_SECONDARY_URL = 6 -INTERNET_PER_CONN_AUTOCONFIG_RELOAD_DELAY_MINS = 7 -INTERNET_PER_CONN_AUTOCONFIG_LAST_DETECT_TIME = 8 -INTERNET_PER_CONN_AUTOCONFIG_LAST_DETECT_URL = 9 -PROXY_TYPE_DIRECT = 0x00000001 -PROXY_TYPE_PROXY = 0x00000002 -PROXY_TYPE_AUTO_PROXY_URL = 0x00000004 -PROXY_TYPE_AUTO_DETECT = 0x00000008 -AUTO_PROXY_FLAG_USER_SET = 0x00000001 -AUTO_PROXY_FLAG_ALWAYS_DETECT = 0x00000002 -AUTO_PROXY_FLAG_DETECTION_RUN = 0x00000004 -AUTO_PROXY_FLAG_MIGRATED = 0x00000008 -AUTO_PROXY_FLAG_DONT_CACHE_PROXY_RESULT = 0x00000010 -AUTO_PROXY_FLAG_CACHE_INIT_RUN = 0x00000020 -AUTO_PROXY_FLAG_DETECTION_SUSPECT = 0x00000040 -ISO_FORCE_DISCONNECTED = 0x00000001 -INTERNET_RFC1123_FORMAT = 0 -INTERNET_RFC1123_BUFSIZE = 30 -ICU_ESCAPE = (-2147483648) -ICU_USERNAME = 0x40000000 -ICU_NO_ENCODE = 0x20000000 -ICU_DECODE = 0x10000000 -ICU_NO_META = 0x08000000 -ICU_ENCODE_SPACES_ONLY = 0x04000000 -ICU_BROWSER_MODE = 0x02000000 -ICU_ENCODE_PERCENT = 0x00001000 -INTERNET_OPEN_TYPE_PRECONFIG = 0 -INTERNET_OPEN_TYPE_DIRECT = 1 -INTERNET_OPEN_TYPE_PROXY = 3 -INTERNET_OPEN_TYPE_PRECONFIG_WITH_NO_AUTOPROXY = 4 -PRE_CONFIG_INTERNET_ACCESS = INTERNET_OPEN_TYPE_PRECONFIG -LOCAL_INTERNET_ACCESS = INTERNET_OPEN_TYPE_DIRECT -CERN_PROXY_INTERNET_ACCESS = INTERNET_OPEN_TYPE_PROXY -INTERNET_SERVICE_FTP = 1 -INTERNET_SERVICE_GOPHER = 2 -INTERNET_SERVICE_HTTP = 3 -IRF_ASYNC = WININET_API_FLAG_ASYNC -IRF_SYNC = WININET_API_FLAG_SYNC -IRF_USE_CONTEXT = WININET_API_FLAG_USE_CONTEXT -IRF_NO_WAIT = 0x00000008 -ISO_GLOBAL = 0x00000001 -ISO_REGISTRY = 0x00000002 -ISO_VALID_FLAGS = (ISO_GLOBAL | ISO_REGISTRY) -INTERNET_OPTION_CALLBACK = 1 -INTERNET_OPTION_CONNECT_TIMEOUT = 2 -INTERNET_OPTION_CONNECT_RETRIES = 3 -INTERNET_OPTION_CONNECT_BACKOFF = 4 -INTERNET_OPTION_SEND_TIMEOUT = 5 -INTERNET_OPTION_CONTROL_SEND_TIMEOUT = INTERNET_OPTION_SEND_TIMEOUT -INTERNET_OPTION_RECEIVE_TIMEOUT = 6 -INTERNET_OPTION_CONTROL_RECEIVE_TIMEOUT = INTERNET_OPTION_RECEIVE_TIMEOUT -INTERNET_OPTION_DATA_SEND_TIMEOUT = 7 -INTERNET_OPTION_DATA_RECEIVE_TIMEOUT = 8 -INTERNET_OPTION_HANDLE_TYPE = 9 -INTERNET_OPTION_LISTEN_TIMEOUT = 11 -INTERNET_OPTION_READ_BUFFER_SIZE = 12 -INTERNET_OPTION_WRITE_BUFFER_SIZE = 13 -INTERNET_OPTION_ASYNC_ID = 15 -INTERNET_OPTION_ASYNC_PRIORITY = 16 -INTERNET_OPTION_PARENT_HANDLE = 21 -INTERNET_OPTION_KEEP_CONNECTION = 22 -INTERNET_OPTION_REQUEST_FLAGS = 23 -INTERNET_OPTION_EXTENDED_ERROR = 24 -INTERNET_OPTION_OFFLINE_MODE = 26 -INTERNET_OPTION_CACHE_STREAM_HANDLE = 27 -INTERNET_OPTION_USERNAME = 28 -INTERNET_OPTION_PASSWORD = 29 -INTERNET_OPTION_ASYNC = 30 -INTERNET_OPTION_SECURITY_FLAGS = 31 -INTERNET_OPTION_SECURITY_CERTIFICATE_STRUCT = 32 -INTERNET_OPTION_DATAFILE_NAME = 33 -INTERNET_OPTION_URL = 34 -INTERNET_OPTION_SECURITY_CERTIFICATE = 35 -INTERNET_OPTION_SECURITY_KEY_BITNESS = 36 -INTERNET_OPTION_REFRESH = 37 -INTERNET_OPTION_PROXY = 38 -INTERNET_OPTION_SETTINGS_CHANGED = 39 -INTERNET_OPTION_VERSION = 40 -INTERNET_OPTION_USER_AGENT = 41 -INTERNET_OPTION_END_BROWSER_SESSION = 42 -INTERNET_OPTION_PROXY_USERNAME = 43 -INTERNET_OPTION_PROXY_PASSWORD = 44 -INTERNET_OPTION_CONTEXT_VALUE = 45 -INTERNET_OPTION_CONNECT_LIMIT = 46 -INTERNET_OPTION_SECURITY_SELECT_CLIENT_CERT = 47 -INTERNET_OPTION_POLICY = 48 -INTERNET_OPTION_DISCONNECTED_TIMEOUT = 49 -INTERNET_OPTION_CONNECTED_STATE = 50 -INTERNET_OPTION_IDLE_STATE = 51 -INTERNET_OPTION_OFFLINE_SEMANTICS = 52 -INTERNET_OPTION_SECONDARY_CACHE_KEY = 53 -INTERNET_OPTION_CALLBACK_FILTER = 54 -INTERNET_OPTION_CONNECT_TIME = 55 -INTERNET_OPTION_SEND_THROUGHPUT = 56 -INTERNET_OPTION_RECEIVE_THROUGHPUT = 57 -INTERNET_OPTION_REQUEST_PRIORITY = 58 -INTERNET_OPTION_HTTP_VERSION = 59 -INTERNET_OPTION_RESET_URLCACHE_SESSION = 60 -INTERNET_OPTION_ERROR_MASK = 62 -INTERNET_OPTION_FROM_CACHE_TIMEOUT = 63 -INTERNET_OPTION_BYPASS_EDITED_ENTRY = 64 -INTERNET_OPTION_DIAGNOSTIC_SOCKET_INFO = 67 -INTERNET_OPTION_CODEPAGE = 68 -INTERNET_OPTION_CACHE_TIMESTAMPS = 69 -INTERNET_OPTION_DISABLE_AUTODIAL = 70 -INTERNET_OPTION_MAX_CONNS_PER_SERVER = 73 -INTERNET_OPTION_MAX_CONNS_PER_1_0_SERVER = 74 -INTERNET_OPTION_PER_CONNECTION_OPTION = 75 -INTERNET_OPTION_DIGEST_AUTH_UNLOAD = 76 -INTERNET_OPTION_IGNORE_OFFLINE = 77 -INTERNET_OPTION_IDENTITY = 78 -INTERNET_OPTION_REMOVE_IDENTITY = 79 -INTERNET_OPTION_ALTER_IDENTITY = 80 -INTERNET_OPTION_SUPPRESS_BEHAVIOR = 81 -INTERNET_OPTION_AUTODIAL_MODE = 82 -INTERNET_OPTION_AUTODIAL_CONNECTION = 83 -INTERNET_OPTION_CLIENT_CERT_CONTEXT = 84 -INTERNET_OPTION_AUTH_FLAGS = 85 -INTERNET_OPTION_COOKIES_3RD_PARTY = 86 -INTERNET_OPTION_DISABLE_PASSPORT_AUTH = 87 -INTERNET_OPTION_SEND_UTF8_SERVERNAME_TO_PROXY = 88 -INTERNET_OPTION_EXEMPT_CONNECTION_LIMIT = 89 -INTERNET_OPTION_ENABLE_PASSPORT_AUTH = 90 -INTERNET_OPTION_HIBERNATE_INACTIVE_WORKER_THREADS = 91 -INTERNET_OPTION_ACTIVATE_WORKER_THREADS = 92 -INTERNET_OPTION_RESTORE_WORKER_THREAD_DEFAULTS = 93 -INTERNET_OPTION_SOCKET_SEND_BUFFER_LENGTH = 94 -INTERNET_OPTION_PROXY_SETTINGS_CHANGED = 95 -INTERNET_FIRST_OPTION = INTERNET_OPTION_CALLBACK -INTERNET_LAST_OPTION = INTERNET_OPTION_PROXY_SETTINGS_CHANGED -INTERNET_PRIORITY_FOREGROUND = 1000 -INTERNET_HANDLE_TYPE_INTERNET = 1 -INTERNET_HANDLE_TYPE_CONNECT_FTP = 2 -INTERNET_HANDLE_TYPE_CONNECT_GOPHER = 3 -INTERNET_HANDLE_TYPE_CONNECT_HTTP = 4 -INTERNET_HANDLE_TYPE_FTP_FIND = 5 -INTERNET_HANDLE_TYPE_FTP_FIND_HTML = 6 -INTERNET_HANDLE_TYPE_FTP_FILE = 7 -INTERNET_HANDLE_TYPE_FTP_FILE_HTML = 8 -INTERNET_HANDLE_TYPE_GOPHER_FIND = 9 -INTERNET_HANDLE_TYPE_GOPHER_FIND_HTML = 10 -INTERNET_HANDLE_TYPE_GOPHER_FILE = 11 -INTERNET_HANDLE_TYPE_GOPHER_FILE_HTML = 12 -INTERNET_HANDLE_TYPE_HTTP_REQUEST = 13 -INTERNET_HANDLE_TYPE_FILE_REQUEST = 14 -AUTH_FLAG_DISABLE_NEGOTIATE = 0x00000001 -AUTH_FLAG_ENABLE_NEGOTIATE = 0x00000002 -SECURITY_FLAG_SECURE = 0x00000001 -SECURITY_FLAG_STRENGTH_WEAK = 0x10000000 -SECURITY_FLAG_STRENGTH_MEDIUM = 0x40000000 -SECURITY_FLAG_STRENGTH_STRONG = 0x20000000 -SECURITY_FLAG_UNKNOWNBIT = (-2147483648) -SECURITY_FLAG_FORTEZZA = 0x08000000 -SECURITY_FLAG_NORMALBITNESS = SECURITY_FLAG_STRENGTH_WEAK -SECURITY_FLAG_SSL = 0x00000002 -SECURITY_FLAG_SSL3 = 0x00000004 -SECURITY_FLAG_PCT = 0x00000008 -SECURITY_FLAG_PCT4 = 0x00000010 -SECURITY_FLAG_IETFSSL4 = 0x00000020 -SECURITY_FLAG_40BIT = SECURITY_FLAG_STRENGTH_WEAK -SECURITY_FLAG_128BIT = SECURITY_FLAG_STRENGTH_STRONG -SECURITY_FLAG_56BIT = SECURITY_FLAG_STRENGTH_MEDIUM -SECURITY_FLAG_IGNORE_REVOCATION = 0x00000080 -SECURITY_FLAG_IGNORE_UNKNOWN_CA = 0x00000100 -SECURITY_FLAG_IGNORE_WRONG_USAGE = 0x00000200 -SECURITY_FLAG_IGNORE_CERT_CN_INVALID = INTERNET_FLAG_IGNORE_CERT_CN_INVALID -SECURITY_FLAG_IGNORE_CERT_DATE_INVALID = INTERNET_FLAG_IGNORE_CERT_DATE_INVALID -SECURITY_FLAG_IGNORE_REDIRECT_TO_HTTPS = INTERNET_FLAG_IGNORE_REDIRECT_TO_HTTPS -SECURITY_FLAG_IGNORE_REDIRECT_TO_HTTP = INTERNET_FLAG_IGNORE_REDIRECT_TO_HTTP -SECURITY_SET_MASK = (SECURITY_FLAG_IGNORE_REVOCATION |\ - SECURITY_FLAG_IGNORE_UNKNOWN_CA |\ - SECURITY_FLAG_IGNORE_CERT_CN_INVALID |\ - SECURITY_FLAG_IGNORE_CERT_DATE_INVALID |\ - SECURITY_FLAG_IGNORE_WRONG_USAGE) -AUTODIAL_MODE_NEVER = 1 -AUTODIAL_MODE_ALWAYS = 2 -AUTODIAL_MODE_NO_NETWORK_PRESENT = 4 -INTERNET_STATUS_RESOLVING_NAME = 10 -INTERNET_STATUS_NAME_RESOLVED = 11 -INTERNET_STATUS_CONNECTING_TO_SERVER = 20 -INTERNET_STATUS_CONNECTED_TO_SERVER = 21 -INTERNET_STATUS_SENDING_REQUEST = 30 -INTERNET_STATUS_REQUEST_SENT = 31 -INTERNET_STATUS_RECEIVING_RESPONSE = 40 -INTERNET_STATUS_RESPONSE_RECEIVED = 41 -INTERNET_STATUS_CTL_RESPONSE_RECEIVED = 42 -INTERNET_STATUS_PREFETCH = 43 -INTERNET_STATUS_CLOSING_CONNECTION = 50 -INTERNET_STATUS_CONNECTION_CLOSED = 51 -INTERNET_STATUS_HANDLE_CREATED = 60 -INTERNET_STATUS_HANDLE_CLOSING = 70 -INTERNET_STATUS_DETECTING_PROXY = 80 -INTERNET_STATUS_REQUEST_COMPLETE = 100 -INTERNET_STATUS_REDIRECT = 110 -INTERNET_STATUS_INTERMEDIATE_RESPONSE = 120 -INTERNET_STATUS_USER_INPUT_REQUIRED = 140 -INTERNET_STATUS_STATE_CHANGE = 200 -INTERNET_STATUS_COOKIE_SENT = 320 -INTERNET_STATUS_COOKIE_RECEIVED = 321 -INTERNET_STATUS_PRIVACY_IMPACTED = 324 -INTERNET_STATUS_P3P_HEADER = 325 -INTERNET_STATUS_P3P_POLICYREF = 326 -INTERNET_STATUS_COOKIE_HISTORY = 327 -INTERNET_STATE_CONNECTED = 0x00000001 -INTERNET_STATE_DISCONNECTED = 0x00000002 -INTERNET_STATE_DISCONNECTED_BY_USER = 0x00000010 -INTERNET_STATE_IDLE = 0x00000100 -INTERNET_STATE_BUSY = 0x00000200 -FTP_TRANSFER_TYPE_UNKNOWN = 0x00000000 -FTP_TRANSFER_TYPE_ASCII = 0x00000001 -FTP_TRANSFER_TYPE_BINARY = 0x00000002 -FTP_TRANSFER_TYPE_MASK = (FTP_TRANSFER_TYPE_ASCII | FTP_TRANSFER_TYPE_BINARY) -MAX_GOPHER_DISPLAY_TEXT = 128 -MAX_GOPHER_SELECTOR_TEXT = 256 -MAX_GOPHER_HOST_NAME = INTERNET_MAX_HOST_NAME_LENGTH -MAX_GOPHER_LOCATOR_LENGTH = (1 \ - + MAX_GOPHER_DISPLAY_TEXT \ - + 1 \ - + MAX_GOPHER_SELECTOR_TEXT \ - + 1 \ - + MAX_GOPHER_HOST_NAME \ - + 1 \ - + INTERNET_MAX_PORT_NUMBER_LENGTH \ - + 1 \ - + 1 \ - + 2 \ - ) -GOPHER_TYPE_TEXT_FILE = 0x00000001 -GOPHER_TYPE_DIRECTORY = 0x00000002 -GOPHER_TYPE_CSO = 0x00000004 -GOPHER_TYPE_ERROR = 0x00000008 -GOPHER_TYPE_MAC_BINHEX = 0x00000010 -GOPHER_TYPE_DOS_ARCHIVE = 0x00000020 -GOPHER_TYPE_UNIX_UUENCODED = 0x00000040 -GOPHER_TYPE_INDEX_SERVER = 0x00000080 -GOPHER_TYPE_TELNET = 0x00000100 -GOPHER_TYPE_BINARY = 0x00000200 -GOPHER_TYPE_REDUNDANT = 0x00000400 -GOPHER_TYPE_TN3270 = 0x00000800 -GOPHER_TYPE_GIF = 0x00001000 -GOPHER_TYPE_IMAGE = 0x00002000 -GOPHER_TYPE_BITMAP = 0x00004000 -GOPHER_TYPE_MOVIE = 0x00008000 -GOPHER_TYPE_SOUND = 0x00010000 -GOPHER_TYPE_HTML = 0x00020000 -GOPHER_TYPE_PDF = 0x00040000 -GOPHER_TYPE_CALENDAR = 0x00080000 -GOPHER_TYPE_INLINE = 0x00100000 -GOPHER_TYPE_UNKNOWN = 0x20000000 -GOPHER_TYPE_ASK = 0x40000000 -GOPHER_TYPE_GOPHER_PLUS = (-2147483648) -GOPHER_TYPE_FILE_MASK = (GOPHER_TYPE_TEXT_FILE \ - | GOPHER_TYPE_MAC_BINHEX \ - | GOPHER_TYPE_DOS_ARCHIVE \ - | GOPHER_TYPE_UNIX_UUENCODED \ - | GOPHER_TYPE_BINARY \ - | GOPHER_TYPE_GIF \ - | GOPHER_TYPE_IMAGE \ - | GOPHER_TYPE_BITMAP \ - | GOPHER_TYPE_MOVIE \ - | GOPHER_TYPE_SOUND \ - | GOPHER_TYPE_HTML \ - | GOPHER_TYPE_PDF \ - | GOPHER_TYPE_CALENDAR \ - | GOPHER_TYPE_INLINE \ - ) -MAX_GOPHER_CATEGORY_NAME = 128 -MAX_GOPHER_ATTRIBUTE_NAME = 128 -MIN_GOPHER_ATTRIBUTE_LENGTH = 256 -GOPHER_ATTRIBUTE_ID_BASE = (-1412641792) -GOPHER_CATEGORY_ID_ALL = (GOPHER_ATTRIBUTE_ID_BASE + 1) -GOPHER_CATEGORY_ID_INFO = (GOPHER_ATTRIBUTE_ID_BASE + 2) -GOPHER_CATEGORY_ID_ADMIN = (GOPHER_ATTRIBUTE_ID_BASE + 3) -GOPHER_CATEGORY_ID_VIEWS = (GOPHER_ATTRIBUTE_ID_BASE + 4) -GOPHER_CATEGORY_ID_ABSTRACT = (GOPHER_ATTRIBUTE_ID_BASE + 5) -GOPHER_CATEGORY_ID_VERONICA = (GOPHER_ATTRIBUTE_ID_BASE + 6) -GOPHER_CATEGORY_ID_ASK = (GOPHER_ATTRIBUTE_ID_BASE + 7) -GOPHER_CATEGORY_ID_UNKNOWN = (GOPHER_ATTRIBUTE_ID_BASE + 8) -GOPHER_ATTRIBUTE_ID_ALL = (GOPHER_ATTRIBUTE_ID_BASE + 9) -GOPHER_ATTRIBUTE_ID_ADMIN = (GOPHER_ATTRIBUTE_ID_BASE + 10) -GOPHER_ATTRIBUTE_ID_MOD_DATE = (GOPHER_ATTRIBUTE_ID_BASE + 11) -GOPHER_ATTRIBUTE_ID_TTL = (GOPHER_ATTRIBUTE_ID_BASE + 12) -GOPHER_ATTRIBUTE_ID_SCORE = (GOPHER_ATTRIBUTE_ID_BASE + 13) -GOPHER_ATTRIBUTE_ID_RANGE = (GOPHER_ATTRIBUTE_ID_BASE + 14) -GOPHER_ATTRIBUTE_ID_SITE = (GOPHER_ATTRIBUTE_ID_BASE + 15) -GOPHER_ATTRIBUTE_ID_ORG = (GOPHER_ATTRIBUTE_ID_BASE + 16) -GOPHER_ATTRIBUTE_ID_LOCATION = (GOPHER_ATTRIBUTE_ID_BASE + 17) -GOPHER_ATTRIBUTE_ID_GEOG = (GOPHER_ATTRIBUTE_ID_BASE + 18) -GOPHER_ATTRIBUTE_ID_TIMEZONE = (GOPHER_ATTRIBUTE_ID_BASE + 19) -GOPHER_ATTRIBUTE_ID_PROVIDER = (GOPHER_ATTRIBUTE_ID_BASE + 20) -GOPHER_ATTRIBUTE_ID_VERSION = (GOPHER_ATTRIBUTE_ID_BASE + 21) -GOPHER_ATTRIBUTE_ID_ABSTRACT = (GOPHER_ATTRIBUTE_ID_BASE + 22) -GOPHER_ATTRIBUTE_ID_VIEW = (GOPHER_ATTRIBUTE_ID_BASE + 23) -GOPHER_ATTRIBUTE_ID_TREEWALK = (GOPHER_ATTRIBUTE_ID_BASE + 24) -GOPHER_ATTRIBUTE_ID_UNKNOWN = (GOPHER_ATTRIBUTE_ID_BASE + 25) -HTTP_MAJOR_VERSION = 1 -HTTP_MINOR_VERSION = 0 -HTTP_VERSIONA = "HTTP/1.0" -HTTP_VERSION = HTTP_VERSIONA -HTTP_QUERY_MIME_VERSION = 0 -HTTP_QUERY_CONTENT_TYPE = 1 -HTTP_QUERY_CONTENT_TRANSFER_ENCODING = 2 -HTTP_QUERY_CONTENT_ID = 3 -HTTP_QUERY_CONTENT_DESCRIPTION = 4 -HTTP_QUERY_CONTENT_LENGTH = 5 -HTTP_QUERY_CONTENT_LANGUAGE = 6 -HTTP_QUERY_ALLOW = 7 -HTTP_QUERY_PUBLIC = 8 -HTTP_QUERY_DATE = 9 -HTTP_QUERY_EXPIRES = 10 -HTTP_QUERY_LAST_MODIFIED = 11 -HTTP_QUERY_MESSAGE_ID = 12 -HTTP_QUERY_URI = 13 -HTTP_QUERY_DERIVED_FROM = 14 -HTTP_QUERY_COST = 15 -HTTP_QUERY_LINK = 16 -HTTP_QUERY_PRAGMA = 17 -HTTP_QUERY_VERSION = 18 -HTTP_QUERY_STATUS_CODE = 19 -HTTP_QUERY_STATUS_TEXT = 20 -HTTP_QUERY_RAW_HEADERS = 21 -HTTP_QUERY_RAW_HEADERS_CRLF = 22 -HTTP_QUERY_CONNECTION = 23 -HTTP_QUERY_ACCEPT = 24 -HTTP_QUERY_ACCEPT_CHARSET = 25 -HTTP_QUERY_ACCEPT_ENCODING = 26 -HTTP_QUERY_ACCEPT_LANGUAGE = 27 -HTTP_QUERY_AUTHORIZATION = 28 -HTTP_QUERY_CONTENT_ENCODING = 29 -HTTP_QUERY_FORWARDED = 30 -HTTP_QUERY_FROM = 31 -HTTP_QUERY_IF_MODIFIED_SINCE = 32 -HTTP_QUERY_LOCATION = 33 -HTTP_QUERY_ORIG_URI = 34 -HTTP_QUERY_REFERER = 35 -HTTP_QUERY_RETRY_AFTER = 36 -HTTP_QUERY_SERVER = 37 -HTTP_QUERY_TITLE = 38 -HTTP_QUERY_USER_AGENT = 39 -HTTP_QUERY_WWW_AUTHENTICATE = 40 -HTTP_QUERY_PROXY_AUTHENTICATE = 41 -HTTP_QUERY_ACCEPT_RANGES = 42 -HTTP_QUERY_SET_COOKIE = 43 -HTTP_QUERY_COOKIE = 44 -HTTP_QUERY_REQUEST_METHOD = 45 -HTTP_QUERY_REFRESH = 46 -HTTP_QUERY_CONTENT_DISPOSITION = 47 -HTTP_QUERY_AGE = 48 -HTTP_QUERY_CACHE_CONTROL = 49 -HTTP_QUERY_CONTENT_BASE = 50 -HTTP_QUERY_CONTENT_LOCATION = 51 -HTTP_QUERY_CONTENT_MD5 = 52 -HTTP_QUERY_CONTENT_RANGE = 53 -HTTP_QUERY_ETAG = 54 -HTTP_QUERY_HOST = 55 -HTTP_QUERY_IF_MATCH = 56 -HTTP_QUERY_IF_NONE_MATCH = 57 -HTTP_QUERY_IF_RANGE = 58 -HTTP_QUERY_IF_UNMODIFIED_SINCE = 59 -HTTP_QUERY_MAX_FORWARDS = 60 -HTTP_QUERY_PROXY_AUTHORIZATION = 61 -HTTP_QUERY_RANGE = 62 -HTTP_QUERY_TRANSFER_ENCODING = 63 -HTTP_QUERY_UPGRADE = 64 -HTTP_QUERY_VARY = 65 -HTTP_QUERY_VIA = 66 -HTTP_QUERY_WARNING = 67 -HTTP_QUERY_EXPECT = 68 -HTTP_QUERY_PROXY_CONNECTION = 69 -HTTP_QUERY_UNLESS_MODIFIED_SINCE = 70 -HTTP_QUERY_ECHO_REQUEST = 71 -HTTP_QUERY_ECHO_REPLY = 72 -HTTP_QUERY_ECHO_HEADERS = 73 -HTTP_QUERY_ECHO_HEADERS_CRLF = 74 -HTTP_QUERY_PROXY_SUPPORT = 75 -HTTP_QUERY_AUTHENTICATION_INFO = 76 -HTTP_QUERY_PASSPORT_URLS = 77 -HTTP_QUERY_PASSPORT_CONFIG = 78 -HTTP_QUERY_MAX = 78 -HTTP_QUERY_CUSTOM = 65535 -HTTP_QUERY_FLAG_REQUEST_HEADERS = (-2147483648) -HTTP_QUERY_FLAG_SYSTEMTIME = 0x40000000 -HTTP_QUERY_FLAG_NUMBER = 0x20000000 -HTTP_QUERY_FLAG_COALESCE = 0x10000000 -HTTP_QUERY_MODIFIER_FLAGS_MASK = (HTTP_QUERY_FLAG_REQUEST_HEADERS \ - | HTTP_QUERY_FLAG_SYSTEMTIME \ - | HTTP_QUERY_FLAG_NUMBER \ - | HTTP_QUERY_FLAG_COALESCE \ - ) -HTTP_QUERY_HEADER_MASK = (~HTTP_QUERY_MODIFIER_FLAGS_MASK) -HTTP_STATUS_CONTINUE = 100 -HTTP_STATUS_SWITCH_PROTOCOLS = 101 -HTTP_STATUS_OK = 200 -HTTP_STATUS_CREATED = 201 -HTTP_STATUS_ACCEPTED = 202 -HTTP_STATUS_PARTIAL = 203 -HTTP_STATUS_NO_CONTENT = 204 -HTTP_STATUS_RESET_CONTENT = 205 -HTTP_STATUS_PARTIAL_CONTENT = 206 -HTTP_STATUS_AMBIGUOUS = 300 -HTTP_STATUS_MOVED = 301 -HTTP_STATUS_REDIRECT = 302 -HTTP_STATUS_REDIRECT_METHOD = 303 -HTTP_STATUS_NOT_MODIFIED = 304 -HTTP_STATUS_USE_PROXY = 305 -HTTP_STATUS_REDIRECT_KEEP_VERB = 307 -HTTP_STATUS_BAD_REQUEST = 400 -HTTP_STATUS_DENIED = 401 -HTTP_STATUS_PAYMENT_REQ = 402 -HTTP_STATUS_FORBIDDEN = 403 -HTTP_STATUS_NOT_FOUND = 404 -HTTP_STATUS_BAD_METHOD = 405 -HTTP_STATUS_NONE_ACCEPTABLE = 406 -HTTP_STATUS_PROXY_AUTH_REQ = 407 -HTTP_STATUS_REQUEST_TIMEOUT = 408 -HTTP_STATUS_CONFLICT = 409 -HTTP_STATUS_GONE = 410 -HTTP_STATUS_LENGTH_REQUIRED = 411 -HTTP_STATUS_PRECOND_FAILED = 412 -HTTP_STATUS_REQUEST_TOO_LARGE = 413 -HTTP_STATUS_URI_TOO_LONG = 414 -HTTP_STATUS_UNSUPPORTED_MEDIA = 415 -HTTP_STATUS_RETRY_WITH = 449 -HTTP_STATUS_SERVER_ERROR = 500 -HTTP_STATUS_NOT_SUPPORTED = 501 -HTTP_STATUS_BAD_GATEWAY = 502 -HTTP_STATUS_SERVICE_UNAVAIL = 503 -HTTP_STATUS_GATEWAY_TIMEOUT = 504 -HTTP_STATUS_VERSION_NOT_SUP = 505 -HTTP_STATUS_FIRST = HTTP_STATUS_CONTINUE -HTTP_STATUS_LAST = HTTP_STATUS_VERSION_NOT_SUP -HTTP_ADDREQ_INDEX_MASK = 0x0000FFFF -HTTP_ADDREQ_FLAGS_MASK = (-65536) -HTTP_ADDREQ_FLAG_ADD_IF_NEW = 0x10000000 -HTTP_ADDREQ_FLAG_ADD = 0x20000000 -HTTP_ADDREQ_FLAG_COALESCE_WITH_COMMA = 0x40000000 -HTTP_ADDREQ_FLAG_COALESCE_WITH_SEMICOLON = 0x01000000 -HTTP_ADDREQ_FLAG_COALESCE = HTTP_ADDREQ_FLAG_COALESCE_WITH_COMMA -HTTP_ADDREQ_FLAG_REPLACE = (-2147483648) -HSR_ASYNC = WININET_API_FLAG_ASYNC -HSR_SYNC = WININET_API_FLAG_SYNC -HSR_USE_CONTEXT = WININET_API_FLAG_USE_CONTEXT -HSR_INITIATE = 0x00000008 -HSR_DOWNLOAD = 0x00000010 -HSR_CHUNKED = 0x00000020 -INTERNET_COOKIE_IS_SECURE = 0x01 -INTERNET_COOKIE_IS_SESSION = 0x02 -INTERNET_COOKIE_THIRD_PARTY = 0x10 -INTERNET_COOKIE_PROMPT_REQUIRED = 0x20 -INTERNET_COOKIE_EVALUATE_P3P = 0x40 -INTERNET_COOKIE_APPLY_P3P = 0x80 -INTERNET_COOKIE_P3P_ENABLED = 0x100 -INTERNET_COOKIE_IS_RESTRICTED = 0x200 -INTERNET_COOKIE_IE6 = 0x400 -INTERNET_COOKIE_IS_LEGACY = 0x800 -FLAG_ICC_FORCE_CONNECTION = 0x00000001 -FLAGS_ERROR_UI_FILTER_FOR_ERRORS = 0x01 -FLAGS_ERROR_UI_FLAGS_CHANGE_OPTIONS = 0x02 -FLAGS_ERROR_UI_FLAGS_GENERATE_DATA = 0x04 -FLAGS_ERROR_UI_FLAGS_NO_UI = 0x08 -FLAGS_ERROR_UI_SERIALIZE_DIALOGS = 0x10 -INTERNET_ERROR_BASE = 12000 -ERROR_INTERNET_OUT_OF_HANDLES = (INTERNET_ERROR_BASE + 1) -ERROR_INTERNET_TIMEOUT = (INTERNET_ERROR_BASE + 2) -ERROR_INTERNET_EXTENDED_ERROR = (INTERNET_ERROR_BASE + 3) -ERROR_INTERNET_INTERNAL_ERROR = (INTERNET_ERROR_BASE + 4) -ERROR_INTERNET_INVALID_URL = (INTERNET_ERROR_BASE + 5) -ERROR_INTERNET_UNRECOGNIZED_SCHEME = (INTERNET_ERROR_BASE + 6) -ERROR_INTERNET_NAME_NOT_RESOLVED = (INTERNET_ERROR_BASE + 7) -ERROR_INTERNET_PROTOCOL_NOT_FOUND = (INTERNET_ERROR_BASE + 8) -ERROR_INTERNET_INVALID_OPTION = (INTERNET_ERROR_BASE + 9) -ERROR_INTERNET_BAD_OPTION_LENGTH = (INTERNET_ERROR_BASE + 10) -ERROR_INTERNET_OPTION_NOT_SETTABLE = (INTERNET_ERROR_BASE + 11) -ERROR_INTERNET_SHUTDOWN = (INTERNET_ERROR_BASE + 12) -ERROR_INTERNET_INCORRECT_USER_NAME = (INTERNET_ERROR_BASE + 13) -ERROR_INTERNET_INCORRECT_PASSWORD = (INTERNET_ERROR_BASE + 14) -ERROR_INTERNET_LOGIN_FAILURE = (INTERNET_ERROR_BASE + 15) -ERROR_INTERNET_INVALID_OPERATION = (INTERNET_ERROR_BASE + 16) -ERROR_INTERNET_OPERATION_CANCELLED = (INTERNET_ERROR_BASE + 17) -ERROR_INTERNET_INCORRECT_HANDLE_TYPE = (INTERNET_ERROR_BASE + 18) -ERROR_INTERNET_INCORRECT_HANDLE_STATE = (INTERNET_ERROR_BASE + 19) -ERROR_INTERNET_NOT_PROXY_REQUEST = (INTERNET_ERROR_BASE + 20) -ERROR_INTERNET_REGISTRY_VALUE_NOT_FOUND = (INTERNET_ERROR_BASE + 21) -ERROR_INTERNET_BAD_REGISTRY_PARAMETER = (INTERNET_ERROR_BASE + 22) -ERROR_INTERNET_NO_DIRECT_ACCESS = (INTERNET_ERROR_BASE + 23) -ERROR_INTERNET_NO_CONTEXT = (INTERNET_ERROR_BASE + 24) -ERROR_INTERNET_NO_CALLBACK = (INTERNET_ERROR_BASE + 25) -ERROR_INTERNET_REQUEST_PENDING = (INTERNET_ERROR_BASE + 26) -ERROR_INTERNET_INCORRECT_FORMAT = (INTERNET_ERROR_BASE + 27) -ERROR_INTERNET_ITEM_NOT_FOUND = (INTERNET_ERROR_BASE + 28) -ERROR_INTERNET_CANNOT_CONNECT = (INTERNET_ERROR_BASE + 29) -ERROR_INTERNET_CONNECTION_ABORTED = (INTERNET_ERROR_BASE + 30) -ERROR_INTERNET_CONNECTION_RESET = (INTERNET_ERROR_BASE + 31) -ERROR_INTERNET_FORCE_RETRY = (INTERNET_ERROR_BASE + 32) -ERROR_INTERNET_INVALID_PROXY_REQUEST = (INTERNET_ERROR_BASE + 33) -ERROR_INTERNET_NEED_UI = (INTERNET_ERROR_BASE + 34) -ERROR_INTERNET_HANDLE_EXISTS = (INTERNET_ERROR_BASE + 36) -ERROR_INTERNET_SEC_CERT_DATE_INVALID = (INTERNET_ERROR_BASE + 37) -ERROR_INTERNET_SEC_CERT_CN_INVALID = (INTERNET_ERROR_BASE + 38) -ERROR_INTERNET_HTTP_TO_HTTPS_ON_REDIR = (INTERNET_ERROR_BASE + 39) -ERROR_INTERNET_HTTPS_TO_HTTP_ON_REDIR = (INTERNET_ERROR_BASE + 40) -ERROR_INTERNET_MIXED_SECURITY = (INTERNET_ERROR_BASE + 41) -ERROR_INTERNET_CHG_POST_IS_NON_SECURE = (INTERNET_ERROR_BASE + 42) -ERROR_INTERNET_POST_IS_NON_SECURE = (INTERNET_ERROR_BASE + 43) -ERROR_INTERNET_CLIENT_AUTH_CERT_NEEDED = (INTERNET_ERROR_BASE + 44) -ERROR_INTERNET_INVALID_CA = (INTERNET_ERROR_BASE + 45) -ERROR_INTERNET_CLIENT_AUTH_NOT_SETUP = (INTERNET_ERROR_BASE + 46) -ERROR_INTERNET_ASYNC_THREAD_FAILED = (INTERNET_ERROR_BASE + 47) -ERROR_INTERNET_REDIRECT_SCHEME_CHANGE = (INTERNET_ERROR_BASE + 48) -ERROR_INTERNET_DIALOG_PENDING = (INTERNET_ERROR_BASE + 49) -ERROR_INTERNET_RETRY_DIALOG = (INTERNET_ERROR_BASE + 50) -ERROR_INTERNET_HTTPS_HTTP_SUBMIT_REDIR = (INTERNET_ERROR_BASE + 52) -ERROR_INTERNET_INSERT_CDROM = (INTERNET_ERROR_BASE + 53) -ERROR_INTERNET_FORTEZZA_LOGIN_NEEDED = (INTERNET_ERROR_BASE + 54) -ERROR_INTERNET_SEC_CERT_ERRORS = (INTERNET_ERROR_BASE + 55) -ERROR_INTERNET_SEC_CERT_NO_REV = (INTERNET_ERROR_BASE + 56) -ERROR_INTERNET_SEC_CERT_REV_FAILED = (INTERNET_ERROR_BASE + 57) -ERROR_FTP_TRANSFER_IN_PROGRESS = (INTERNET_ERROR_BASE + 110) -ERROR_FTP_DROPPED = (INTERNET_ERROR_BASE + 111) -ERROR_FTP_NO_PASSIVE_MODE = (INTERNET_ERROR_BASE + 112) -ERROR_GOPHER_PROTOCOL_ERROR = (INTERNET_ERROR_BASE + 130) -ERROR_GOPHER_NOT_FILE = (INTERNET_ERROR_BASE + 131) -ERROR_GOPHER_DATA_ERROR = (INTERNET_ERROR_BASE + 132) -ERROR_GOPHER_END_OF_DATA = (INTERNET_ERROR_BASE + 133) -ERROR_GOPHER_INVALID_LOCATOR = (INTERNET_ERROR_BASE + 134) -ERROR_GOPHER_INCORRECT_LOCATOR_TYPE = (INTERNET_ERROR_BASE + 135) -ERROR_GOPHER_NOT_GOPHER_PLUS = (INTERNET_ERROR_BASE + 136) -ERROR_GOPHER_ATTRIBUTE_NOT_FOUND = (INTERNET_ERROR_BASE + 137) -ERROR_GOPHER_UNKNOWN_LOCATOR = (INTERNET_ERROR_BASE + 138) -ERROR_HTTP_HEADER_NOT_FOUND = (INTERNET_ERROR_BASE + 150) -ERROR_HTTP_DOWNLEVEL_SERVER = (INTERNET_ERROR_BASE + 151) -ERROR_HTTP_INVALID_SERVER_RESPONSE = (INTERNET_ERROR_BASE + 152) -ERROR_HTTP_INVALID_HEADER = (INTERNET_ERROR_BASE + 153) -ERROR_HTTP_INVALID_QUERY_REQUEST = (INTERNET_ERROR_BASE + 154) -ERROR_HTTP_HEADER_ALREADY_EXISTS = (INTERNET_ERROR_BASE + 155) -ERROR_HTTP_REDIRECT_FAILED = (INTERNET_ERROR_BASE + 156) -ERROR_HTTP_NOT_REDIRECTED = (INTERNET_ERROR_BASE + 160) -ERROR_HTTP_COOKIE_NEEDS_CONFIRMATION = (INTERNET_ERROR_BASE + 161) -ERROR_HTTP_COOKIE_DECLINED = (INTERNET_ERROR_BASE + 162) -ERROR_HTTP_REDIRECT_NEEDS_CONFIRMATION = (INTERNET_ERROR_BASE + 168) -ERROR_INTERNET_SECURITY_CHANNEL_ERROR = (INTERNET_ERROR_BASE + 157) -ERROR_INTERNET_UNABLE_TO_CACHE_FILE = (INTERNET_ERROR_BASE + 158) -ERROR_INTERNET_TCPIP_NOT_INSTALLED = (INTERNET_ERROR_BASE + 159) -ERROR_INTERNET_DISCONNECTED = (INTERNET_ERROR_BASE + 163) -ERROR_INTERNET_SERVER_UNREACHABLE = (INTERNET_ERROR_BASE + 164) -ERROR_INTERNET_PROXY_SERVER_UNREACHABLE = (INTERNET_ERROR_BASE + 165) -ERROR_INTERNET_BAD_AUTO_PROXY_SCRIPT = (INTERNET_ERROR_BASE + 166) -ERROR_INTERNET_UNABLE_TO_DOWNLOAD_SCRIPT = (INTERNET_ERROR_BASE + 167) -ERROR_INTERNET_SEC_INVALID_CERT = (INTERNET_ERROR_BASE + 169) -ERROR_INTERNET_SEC_CERT_REVOKED = (INTERNET_ERROR_BASE + 170) -ERROR_INTERNET_FAILED_DUETOSECURITYCHECK = (INTERNET_ERROR_BASE + 171) -ERROR_INTERNET_NOT_INITIALIZED = (INTERNET_ERROR_BASE + 172) -ERROR_INTERNET_NEED_MSN_SSPI_PKG = (INTERNET_ERROR_BASE + 173) -ERROR_INTERNET_LOGIN_FAILURE_DISPLAY_ENTITY_BODY = (INTERNET_ERROR_BASE + 174) -INTERNET_ERROR_LAST = ERROR_INTERNET_LOGIN_FAILURE_DISPLAY_ENTITY_BODY -NORMAL_CACHE_ENTRY = 0x00000001 -STICKY_CACHE_ENTRY = 0x00000004 -EDITED_CACHE_ENTRY = 0x00000008 -TRACK_OFFLINE_CACHE_ENTRY = 0x00000010 -TRACK_ONLINE_CACHE_ENTRY = 0x00000020 -SPARSE_CACHE_ENTRY = 0x00010000 -COOKIE_CACHE_ENTRY = 0x00100000 -URLHISTORY_CACHE_ENTRY = 0x00200000 -URLCACHE_FIND_DEFAULT_FILTER = NORMAL_CACHE_ENTRY \ - | COOKIE_CACHE_ENTRY \ - | URLHISTORY_CACHE_ENTRY \ - | TRACK_OFFLINE_CACHE_ENTRY \ - | TRACK_ONLINE_CACHE_ENTRY \ - | STICKY_CACHE_ENTRY -CACHEGROUP_ATTRIBUTE_GET_ALL = (-1) -CACHEGROUP_ATTRIBUTE_BASIC = 0x00000001 -CACHEGROUP_ATTRIBUTE_FLAG = 0x00000002 -CACHEGROUP_ATTRIBUTE_TYPE = 0x00000004 -CACHEGROUP_ATTRIBUTE_QUOTA = 0x00000008 -CACHEGROUP_ATTRIBUTE_GROUPNAME = 0x00000010 -CACHEGROUP_ATTRIBUTE_STORAGE = 0x00000020 -CACHEGROUP_FLAG_NONPURGEABLE = 0x00000001 -CACHEGROUP_FLAG_GIDONLY = 0x00000004 -CACHEGROUP_FLAG_FLUSHURL_ONDELETE = 0x00000002 -CACHEGROUP_SEARCH_ALL = 0x00000000 -CACHEGROUP_SEARCH_BYURL = 0x00000001 -CACHEGROUP_TYPE_INVALID = 0x00000001 -CACHEGROUP_READWRITE_MASK = \ - CACHEGROUP_ATTRIBUTE_TYPE \ - | CACHEGROUP_ATTRIBUTE_QUOTA \ - | CACHEGROUP_ATTRIBUTE_GROUPNAME \ - | CACHEGROUP_ATTRIBUTE_STORAGE -GROUPNAME_MAX_LENGTH = 120 -GROUP_OWNER_STORAGE_SIZE = 4 -CACHE_ENTRY_ATTRIBUTE_FC = 0x00000004 -CACHE_ENTRY_HITRATE_FC = 0x00000010 -CACHE_ENTRY_MODTIME_FC = 0x00000040 -CACHE_ENTRY_EXPTIME_FC = 0x00000080 -CACHE_ENTRY_ACCTIME_FC = 0x00000100 -CACHE_ENTRY_SYNCTIME_FC = 0x00000200 -CACHE_ENTRY_HEADERINFO_FC = 0x00000400 -CACHE_ENTRY_EXEMPT_DELTA_FC = 0x00000800 -INTERNET_CACHE_GROUP_ADD = 0 -INTERNET_CACHE_GROUP_REMOVE = 1 -INTERNET_DIAL_FORCE_PROMPT = 0x2000 -INTERNET_DIAL_SHOW_OFFLINE = 0x4000 -INTERNET_DIAL_UNATTENDED = 0x8000 -INTERENT_GOONLINE_REFRESH = 0x00000001 -INTERENT_GOONLINE_MASK = 0x00000001 -INTERNET_AUTODIAL_FORCE_ONLINE = 1 -INTERNET_AUTODIAL_FORCE_UNATTENDED = 2 -INTERNET_AUTODIAL_FAILIFSECURITYCHECK = 4 -INTERNET_AUTODIAL_OVERRIDE_NET_PRESENT = 8 -INTERNET_AUTODIAL_FLAGS_MASK = (INTERNET_AUTODIAL_FORCE_ONLINE | INTERNET_AUTODIAL_FORCE_UNATTENDED | INTERNET_AUTODIAL_FAILIFSECURITYCHECK | INTERNET_AUTODIAL_OVERRIDE_NET_PRESENT) -PROXY_AUTO_DETECT_TYPE_DHCP = 1 -PROXY_AUTO_DETECT_TYPE_DNS_A = 2 -INTERNET_CONNECTION_MODEM = 0x01 -INTERNET_CONNECTION_LAN = 0x02 -INTERNET_CONNECTION_PROXY = 0x04 -INTERNET_CONNECTION_MODEM_BUSY = 0x08 -INTERNET_RAS_INSTALLED = 0x10 -INTERNET_CONNECTION_OFFLINE = 0x20 -INTERNET_CONNECTION_CONFIGURED = 0x40 -INTERNET_CUSTOMDIAL_CONNECT = 0 -INTERNET_CUSTOMDIAL_UNATTENDED = 1 -INTERNET_CUSTOMDIAL_DISCONNECT = 2 -INTERNET_CUSTOMDIAL_SHOWOFFLINE = 4 -INTERNET_CUSTOMDIAL_SAFE_FOR_UNATTENDED = 1 -INTERNET_CUSTOMDIAL_WILL_SUPPLY_STATE = 2 -INTERNET_CUSTOMDIAL_CAN_HANGUP = 4 -INTERNET_DIALSTATE_DISCONNECTED = 1 -INTERNET_IDENTITY_FLAG_PRIVATE_CACHE = 0x01 -INTERNET_IDENTITY_FLAG_SHARED_CACHE = 0x02 -INTERNET_IDENTITY_FLAG_CLEAR_DATA = 0x04 -INTERNET_IDENTITY_FLAG_CLEAR_COOKIES = 0x08 -INTERNET_IDENTITY_FLAG_CLEAR_HISTORY = 0x10 -INTERNET_IDENTITY_FLAG_CLEAR_CONTENT = 0x20 -INTERNET_SUPPRESS_RESET_ALL = 0x00 -INTERNET_SUPPRESS_COOKIE_POLICY = 0x01 -INTERNET_SUPPRESS_COOKIE_POLICY_RESET = 0x02 -PRIVACY_TEMPLATE_NO_COOKIES = 0 -PRIVACY_TEMPLATE_HIGH = 1 -PRIVACY_TEMPLATE_MEDIUM_HIGH = 2 -PRIVACY_TEMPLATE_MEDIUM = 3 -PRIVACY_TEMPLATE_MEDIUM_LOW = 4 -PRIVACY_TEMPLATE_LOW = 5 -PRIVACY_TEMPLATE_CUSTOM = 100 -PRIVACY_TEMPLATE_ADVANCED = 101 -PRIVACY_TEMPLATE_MAX = PRIVACY_TEMPLATE_LOW -PRIVACY_TYPE_FIRST_PARTY = 0 -PRIVACY_TYPE_THIRD_PARTY = 1 - -# Generated by h2py from winhttp.h -INTERNET_DEFAULT_PORT = 0 -INTERNET_DEFAULT_HTTP_PORT = 80 -INTERNET_DEFAULT_HTTPS_PORT = 443 -WINHTTP_FLAG_ASYNC = 0x10000000 -WINHTTP_FLAG_SECURE = 0x00800000 -WINHTTP_FLAG_ESCAPE_PERCENT = 0x00000004 -WINHTTP_FLAG_NULL_CODEPAGE = 0x00000008 -WINHTTP_FLAG_BYPASS_PROXY_CACHE = 0x00000100 -WINHTTP_FLAG_REFRESH = WINHTTP_FLAG_BYPASS_PROXY_CACHE -WINHTTP_FLAG_ESCAPE_DISABLE = 0x00000040 -WINHTTP_FLAG_ESCAPE_DISABLE_QUERY = 0x00000080 -SECURITY_FLAG_IGNORE_UNKNOWN_CA = 0x00000100 -SECURITY_FLAG_IGNORE_CERT_DATE_INVALID = 0x00002000 -SECURITY_FLAG_IGNORE_CERT_CN_INVALID = 0x00001000 -SECURITY_FLAG_IGNORE_CERT_WRONG_USAGE = 0x00000200 -INTERNET_SCHEME_HTTP = (1) -INTERNET_SCHEME_HTTPS = (2) -WINHTTP_AUTOPROXY_AUTO_DETECT = 0x00000001 -WINHTTP_AUTOPROXY_CONFIG_URL = 0x00000002 -WINHTTP_AUTOPROXY_RUN_INPROCESS = 0x00010000 -WINHTTP_AUTOPROXY_RUN_OUTPROCESS_ONLY = 0x00020000 -WINHTTP_AUTO_DETECT_TYPE_DHCP = 0x00000001 -WINHTTP_AUTO_DETECT_TYPE_DNS_A = 0x00000002 -WINHTTP_TIME_FORMAT_BUFSIZE = 62 -ICU_NO_ENCODE = 0x20000000 -ICU_DECODE = 0x10000000 -ICU_NO_META = 0x08000000 -ICU_ENCODE_SPACES_ONLY = 0x04000000 -ICU_BROWSER_MODE = 0x02000000 -ICU_ENCODE_PERCENT = 0x00001000 -ICU_ESCAPE = (-2147483648) -ICU_ESCAPE_AUTHORITY = 0x00002000 -ICU_REJECT_USERPWD = 0x00004000 -WINHTTP_ACCESS_TYPE_DEFAULT_PROXY = 0 -WINHTTP_ACCESS_TYPE_NO_PROXY = 1 -WINHTTP_ACCESS_TYPE_NAMED_PROXY = 3 -WINHTTP_OPTION_CALLBACK = 1 -WINHTTP_OPTION_RESOLVE_TIMEOUT = 2 -WINHTTP_OPTION_CONNECT_TIMEOUT = 3 -WINHTTP_OPTION_CONNECT_RETRIES = 4 -WINHTTP_OPTION_SEND_TIMEOUT = 5 -WINHTTP_OPTION_RECEIVE_TIMEOUT = 6 -WINHTTP_OPTION_RECEIVE_RESPONSE_TIMEOUT = 7 -WINHTTP_OPTION_HANDLE_TYPE = 9 -WINHTTP_OPTION_READ_BUFFER_SIZE = 12 -WINHTTP_OPTION_WRITE_BUFFER_SIZE = 13 -WINHTTP_OPTION_PARENT_HANDLE = 21 -WINHTTP_OPTION_EXTENDED_ERROR = 24 -WINHTTP_OPTION_SECURITY_FLAGS = 31 -WINHTTP_OPTION_SECURITY_CERTIFICATE_STRUCT = 32 -WINHTTP_OPTION_URL = 34 -WINHTTP_OPTION_SECURITY_KEY_BITNESS = 36 -WINHTTP_OPTION_PROXY = 38 -WINHTTP_OPTION_USER_AGENT = 41 -WINHTTP_OPTION_CONTEXT_VALUE = 45 -WINHTTP_OPTION_CLIENT_CERT_CONTEXT = 47 -WINHTTP_OPTION_REQUEST_PRIORITY = 58 -WINHTTP_OPTION_HTTP_VERSION = 59 -WINHTTP_OPTION_DISABLE_FEATURE = 63 -WINHTTP_OPTION_CODEPAGE = 68 -WINHTTP_OPTION_MAX_CONNS_PER_SERVER = 73 -WINHTTP_OPTION_MAX_CONNS_PER_1_0_SERVER = 74 -WINHTTP_OPTION_AUTOLOGON_POLICY = 77 -WINHTTP_OPTION_SERVER_CERT_CONTEXT = 78 -WINHTTP_OPTION_ENABLE_FEATURE = 79 -WINHTTP_OPTION_WORKER_THREAD_COUNT = 80 -WINHTTP_OPTION_PASSPORT_COBRANDING_TEXT = 81 -WINHTTP_OPTION_PASSPORT_COBRANDING_URL = 82 -WINHTTP_OPTION_CONFIGURE_PASSPORT_AUTH = 83 -WINHTTP_OPTION_SECURE_PROTOCOLS = 84 -WINHTTP_OPTION_ENABLETRACING = 85 -WINHTTP_OPTION_PASSPORT_SIGN_OUT = 86 -WINHTTP_OPTION_PASSPORT_RETURN_URL = 87 -WINHTTP_OPTION_REDIRECT_POLICY = 88 -WINHTTP_OPTION_MAX_HTTP_AUTOMATIC_REDIRECTS = 89 -WINHTTP_OPTION_MAX_HTTP_STATUS_CONTINUE = 90 -WINHTTP_OPTION_MAX_RESPONSE_HEADER_SIZE = 91 -WINHTTP_OPTION_MAX_RESPONSE_DRAIN_SIZE = 92 -WINHTTP_OPTION_CONNECTION_INFO = 93 -WINHTTP_OPTION_CLIENT_CERT_ISSUER_LIST = 94 -WINHTTP_OPTION_SPN = 96 -WINHTTP_OPTION_GLOBAL_PROXY_CREDS = 97 -WINHTTP_OPTION_GLOBAL_SERVER_CREDS = 98 -WINHTTP_OPTION_UNLOAD_NOTIFY_EVENT = 99 -WINHTTP_OPTION_REJECT_USERPWD_IN_URL = 100 -WINHTTP_OPTION_USE_GLOBAL_SERVER_CREDENTIALS = 101 -WINHTTP_LAST_OPTION = WINHTTP_OPTION_USE_GLOBAL_SERVER_CREDENTIALS -WINHTTP_OPTION_USERNAME = 0x1000 -WINHTTP_OPTION_PASSWORD = 0x1001 -WINHTTP_OPTION_PROXY_USERNAME = 0x1002 -WINHTTP_OPTION_PROXY_PASSWORD = 0x1003 -WINHTTP_CONNS_PER_SERVER_UNLIMITED = (-1) -WINHTTP_AUTOLOGON_SECURITY_LEVEL_MEDIUM = 0 -WINHTTP_AUTOLOGON_SECURITY_LEVEL_LOW = 1 -WINHTTP_AUTOLOGON_SECURITY_LEVEL_HIGH = 2 -WINHTTP_AUTOLOGON_SECURITY_LEVEL_DEFAULT = WINHTTP_AUTOLOGON_SECURITY_LEVEL_MEDIUM -WINHTTP_OPTION_REDIRECT_POLICY_NEVER = 0 -WINHTTP_OPTION_REDIRECT_POLICY_DISALLOW_HTTPS_TO_HTTP = 1 -WINHTTP_OPTION_REDIRECT_POLICY_ALWAYS = 2 -WINHTTP_OPTION_REDIRECT_POLICY_LAST = WINHTTP_OPTION_REDIRECT_POLICY_ALWAYS -WINHTTP_OPTION_REDIRECT_POLICY_DEFAULT = WINHTTP_OPTION_REDIRECT_POLICY_DISALLOW_HTTPS_TO_HTTP -WINHTTP_DISABLE_PASSPORT_AUTH = 0x00000000 -WINHTTP_ENABLE_PASSPORT_AUTH = 0x10000000 -WINHTTP_DISABLE_PASSPORT_KEYRING = 0x20000000 -WINHTTP_ENABLE_PASSPORT_KEYRING = 0x40000000 -WINHTTP_DISABLE_COOKIES = 0x00000001 -WINHTTP_DISABLE_REDIRECTS = 0x00000002 -WINHTTP_DISABLE_AUTHENTICATION = 0x00000004 -WINHTTP_DISABLE_KEEP_ALIVE = 0x00000008 -WINHTTP_ENABLE_SSL_REVOCATION = 0x00000001 -WINHTTP_ENABLE_SSL_REVERT_IMPERSONATION = 0x00000002 -WINHTTP_DISABLE_SPN_SERVER_PORT = 0x00000000 -WINHTTP_ENABLE_SPN_SERVER_PORT = 0x00000001 -WINHTTP_OPTION_SPN_MASK = WINHTTP_ENABLE_SPN_SERVER_PORT -WINHTTP_HANDLE_TYPE_SESSION = 1 -WINHTTP_HANDLE_TYPE_CONNECT = 2 -WINHTTP_HANDLE_TYPE_REQUEST = 3 -WINHTTP_AUTH_SCHEME_BASIC = 0x00000001 -WINHTTP_AUTH_SCHEME_NTLM = 0x00000002 -WINHTTP_AUTH_SCHEME_PASSPORT = 0x00000004 -WINHTTP_AUTH_SCHEME_DIGEST = 0x00000008 -WINHTTP_AUTH_SCHEME_NEGOTIATE = 0x00000010 -WINHTTP_AUTH_TARGET_SERVER = 0x00000000 -WINHTTP_AUTH_TARGET_PROXY = 0x00000001 -SECURITY_FLAG_SECURE = 0x00000001 -SECURITY_FLAG_STRENGTH_WEAK = 0x10000000 -SECURITY_FLAG_STRENGTH_MEDIUM = 0x40000000 -SECURITY_FLAG_STRENGTH_STRONG = 0x20000000 -WINHTTP_CALLBACK_STATUS_FLAG_CERT_REV_FAILED = 0x00000001 -WINHTTP_CALLBACK_STATUS_FLAG_INVALID_CERT = 0x00000002 -WINHTTP_CALLBACK_STATUS_FLAG_CERT_REVOKED = 0x00000004 -WINHTTP_CALLBACK_STATUS_FLAG_INVALID_CA = 0x00000008 -WINHTTP_CALLBACK_STATUS_FLAG_CERT_CN_INVALID = 0x00000010 -WINHTTP_CALLBACK_STATUS_FLAG_CERT_DATE_INVALID = 0x00000020 -WINHTTP_CALLBACK_STATUS_FLAG_CERT_WRONG_USAGE = 0x00000040 -WINHTTP_CALLBACK_STATUS_FLAG_SECURITY_CHANNEL_ERROR = (-2147483648) -WINHTTP_FLAG_SECURE_PROTOCOL_SSL2 = 0x00000008 -WINHTTP_FLAG_SECURE_PROTOCOL_SSL3 = 0x00000020 -WINHTTP_FLAG_SECURE_PROTOCOL_TLS1 = 0x00000080 -WINHTTP_FLAG_SECURE_PROTOCOL_ALL = (WINHTTP_FLAG_SECURE_PROTOCOL_SSL2 | \ - WINHTTP_FLAG_SECURE_PROTOCOL_SSL3 | \ - WINHTTP_FLAG_SECURE_PROTOCOL_TLS1) -WINHTTP_CALLBACK_STATUS_RESOLVING_NAME = 0x00000001 -WINHTTP_CALLBACK_STATUS_NAME_RESOLVED = 0x00000002 -WINHTTP_CALLBACK_STATUS_CONNECTING_TO_SERVER = 0x00000004 -WINHTTP_CALLBACK_STATUS_CONNECTED_TO_SERVER = 0x00000008 -WINHTTP_CALLBACK_STATUS_SENDING_REQUEST = 0x00000010 -WINHTTP_CALLBACK_STATUS_REQUEST_SENT = 0x00000020 -WINHTTP_CALLBACK_STATUS_RECEIVING_RESPONSE = 0x00000040 -WINHTTP_CALLBACK_STATUS_RESPONSE_RECEIVED = 0x00000080 -WINHTTP_CALLBACK_STATUS_CLOSING_CONNECTION = 0x00000100 -WINHTTP_CALLBACK_STATUS_CONNECTION_CLOSED = 0x00000200 -WINHTTP_CALLBACK_STATUS_HANDLE_CREATED = 0x00000400 -WINHTTP_CALLBACK_STATUS_HANDLE_CLOSING = 0x00000800 -WINHTTP_CALLBACK_STATUS_DETECTING_PROXY = 0x00001000 -WINHTTP_CALLBACK_STATUS_REDIRECT = 0x00004000 -WINHTTP_CALLBACK_STATUS_INTERMEDIATE_RESPONSE = 0x00008000 -WINHTTP_CALLBACK_STATUS_SECURE_FAILURE = 0x00010000 -WINHTTP_CALLBACK_STATUS_HEADERS_AVAILABLE = 0x00020000 -WINHTTP_CALLBACK_STATUS_DATA_AVAILABLE = 0x00040000 -WINHTTP_CALLBACK_STATUS_READ_COMPLETE = 0x00080000 -WINHTTP_CALLBACK_STATUS_WRITE_COMPLETE = 0x00100000 -WINHTTP_CALLBACK_STATUS_REQUEST_ERROR = 0x00200000 -WINHTTP_CALLBACK_STATUS_SENDREQUEST_COMPLETE = 0x00400000 -API_RECEIVE_RESPONSE = (1) -API_QUERY_DATA_AVAILABLE = (2) -API_READ_DATA = (3) -API_WRITE_DATA = (4) -API_SEND_REQUEST = (5) -WINHTTP_CALLBACK_FLAG_RESOLVE_NAME = (WINHTTP_CALLBACK_STATUS_RESOLVING_NAME | WINHTTP_CALLBACK_STATUS_NAME_RESOLVED) -WINHTTP_CALLBACK_FLAG_CONNECT_TO_SERVER = (WINHTTP_CALLBACK_STATUS_CONNECTING_TO_SERVER | WINHTTP_CALLBACK_STATUS_CONNECTED_TO_SERVER) -WINHTTP_CALLBACK_FLAG_SEND_REQUEST = (WINHTTP_CALLBACK_STATUS_SENDING_REQUEST | WINHTTP_CALLBACK_STATUS_REQUEST_SENT) -WINHTTP_CALLBACK_FLAG_RECEIVE_RESPONSE = (WINHTTP_CALLBACK_STATUS_RECEIVING_RESPONSE | WINHTTP_CALLBACK_STATUS_RESPONSE_RECEIVED) -WINHTTP_CALLBACK_FLAG_CLOSE_CONNECTION = (WINHTTP_CALLBACK_STATUS_CLOSING_CONNECTION | WINHTTP_CALLBACK_STATUS_CONNECTION_CLOSED) -WINHTTP_CALLBACK_FLAG_HANDLES = (WINHTTP_CALLBACK_STATUS_HANDLE_CREATED | WINHTTP_CALLBACK_STATUS_HANDLE_CLOSING) -WINHTTP_CALLBACK_FLAG_DETECTING_PROXY = WINHTTP_CALLBACK_STATUS_DETECTING_PROXY -WINHTTP_CALLBACK_FLAG_REDIRECT = WINHTTP_CALLBACK_STATUS_REDIRECT -WINHTTP_CALLBACK_FLAG_INTERMEDIATE_RESPONSE = WINHTTP_CALLBACK_STATUS_INTERMEDIATE_RESPONSE -WINHTTP_CALLBACK_FLAG_SECURE_FAILURE = WINHTTP_CALLBACK_STATUS_SECURE_FAILURE -WINHTTP_CALLBACK_FLAG_SENDREQUEST_COMPLETE = WINHTTP_CALLBACK_STATUS_SENDREQUEST_COMPLETE -WINHTTP_CALLBACK_FLAG_HEADERS_AVAILABLE = WINHTTP_CALLBACK_STATUS_HEADERS_AVAILABLE -WINHTTP_CALLBACK_FLAG_DATA_AVAILABLE = WINHTTP_CALLBACK_STATUS_DATA_AVAILABLE -WINHTTP_CALLBACK_FLAG_READ_COMPLETE = WINHTTP_CALLBACK_STATUS_READ_COMPLETE -WINHTTP_CALLBACK_FLAG_WRITE_COMPLETE = WINHTTP_CALLBACK_STATUS_WRITE_COMPLETE -WINHTTP_CALLBACK_FLAG_REQUEST_ERROR = WINHTTP_CALLBACK_STATUS_REQUEST_ERROR -WINHTTP_CALLBACK_FLAG_ALL_COMPLETIONS = (WINHTTP_CALLBACK_STATUS_SENDREQUEST_COMPLETE \ - | WINHTTP_CALLBACK_STATUS_HEADERS_AVAILABLE \ - | WINHTTP_CALLBACK_STATUS_DATA_AVAILABLE \ - | WINHTTP_CALLBACK_STATUS_READ_COMPLETE \ - | WINHTTP_CALLBACK_STATUS_WRITE_COMPLETE \ - | WINHTTP_CALLBACK_STATUS_REQUEST_ERROR) -WINHTTP_CALLBACK_FLAG_ALL_NOTIFICATIONS = (-1) -WINHTTP_QUERY_MIME_VERSION = 0 -WINHTTP_QUERY_CONTENT_TYPE = 1 -WINHTTP_QUERY_CONTENT_TRANSFER_ENCODING = 2 -WINHTTP_QUERY_CONTENT_ID = 3 -WINHTTP_QUERY_CONTENT_DESCRIPTION = 4 -WINHTTP_QUERY_CONTENT_LENGTH = 5 -WINHTTP_QUERY_CONTENT_LANGUAGE = 6 -WINHTTP_QUERY_ALLOW = 7 -WINHTTP_QUERY_PUBLIC = 8 -WINHTTP_QUERY_DATE = 9 -WINHTTP_QUERY_EXPIRES = 10 -WINHTTP_QUERY_LAST_MODIFIED = 11 -WINHTTP_QUERY_MESSAGE_ID = 12 -WINHTTP_QUERY_URI = 13 -WINHTTP_QUERY_DERIVED_FROM = 14 -WINHTTP_QUERY_COST = 15 -WINHTTP_QUERY_LINK = 16 -WINHTTP_QUERY_PRAGMA = 17 -WINHTTP_QUERY_VERSION = 18 -WINHTTP_QUERY_STATUS_CODE = 19 -WINHTTP_QUERY_STATUS_TEXT = 20 -WINHTTP_QUERY_RAW_HEADERS = 21 -WINHTTP_QUERY_RAW_HEADERS_CRLF = 22 -WINHTTP_QUERY_CONNECTION = 23 -WINHTTP_QUERY_ACCEPT = 24 -WINHTTP_QUERY_ACCEPT_CHARSET = 25 -WINHTTP_QUERY_ACCEPT_ENCODING = 26 -WINHTTP_QUERY_ACCEPT_LANGUAGE = 27 -WINHTTP_QUERY_AUTHORIZATION = 28 -WINHTTP_QUERY_CONTENT_ENCODING = 29 -WINHTTP_QUERY_FORWARDED = 30 -WINHTTP_QUERY_FROM = 31 -WINHTTP_QUERY_IF_MODIFIED_SINCE = 32 -WINHTTP_QUERY_LOCATION = 33 -WINHTTP_QUERY_ORIG_URI = 34 -WINHTTP_QUERY_REFERER = 35 -WINHTTP_QUERY_RETRY_AFTER = 36 -WINHTTP_QUERY_SERVER = 37 -WINHTTP_QUERY_TITLE = 38 -WINHTTP_QUERY_USER_AGENT = 39 -WINHTTP_QUERY_WWW_AUTHENTICATE = 40 -WINHTTP_QUERY_PROXY_AUTHENTICATE = 41 -WINHTTP_QUERY_ACCEPT_RANGES = 42 -WINHTTP_QUERY_SET_COOKIE = 43 -WINHTTP_QUERY_COOKIE = 44 -WINHTTP_QUERY_REQUEST_METHOD = 45 -WINHTTP_QUERY_REFRESH = 46 -WINHTTP_QUERY_CONTENT_DISPOSITION = 47 -WINHTTP_QUERY_AGE = 48 -WINHTTP_QUERY_CACHE_CONTROL = 49 -WINHTTP_QUERY_CONTENT_BASE = 50 -WINHTTP_QUERY_CONTENT_LOCATION = 51 -WINHTTP_QUERY_CONTENT_MD5 = 52 -WINHTTP_QUERY_CONTENT_RANGE = 53 -WINHTTP_QUERY_ETAG = 54 -WINHTTP_QUERY_HOST = 55 -WINHTTP_QUERY_IF_MATCH = 56 -WINHTTP_QUERY_IF_NONE_MATCH = 57 -WINHTTP_QUERY_IF_RANGE = 58 -WINHTTP_QUERY_IF_UNMODIFIED_SINCE = 59 -WINHTTP_QUERY_MAX_FORWARDS = 60 -WINHTTP_QUERY_PROXY_AUTHORIZATION = 61 -WINHTTP_QUERY_RANGE = 62 -WINHTTP_QUERY_TRANSFER_ENCODING = 63 -WINHTTP_QUERY_UPGRADE = 64 -WINHTTP_QUERY_VARY = 65 -WINHTTP_QUERY_VIA = 66 -WINHTTP_QUERY_WARNING = 67 -WINHTTP_QUERY_EXPECT = 68 -WINHTTP_QUERY_PROXY_CONNECTION = 69 -WINHTTP_QUERY_UNLESS_MODIFIED_SINCE = 70 -WINHTTP_QUERY_PROXY_SUPPORT = 75 -WINHTTP_QUERY_AUTHENTICATION_INFO = 76 -WINHTTP_QUERY_PASSPORT_URLS = 77 -WINHTTP_QUERY_PASSPORT_CONFIG = 78 -WINHTTP_QUERY_MAX = 78 -WINHTTP_QUERY_CUSTOM = 65535 -WINHTTP_QUERY_FLAG_REQUEST_HEADERS = (-2147483648) -WINHTTP_QUERY_FLAG_SYSTEMTIME = 0x40000000 -WINHTTP_QUERY_FLAG_NUMBER = 0x20000000 -HTTP_STATUS_CONTINUE = 100 -HTTP_STATUS_SWITCH_PROTOCOLS = 101 -HTTP_STATUS_OK = 200 -HTTP_STATUS_CREATED = 201 -HTTP_STATUS_ACCEPTED = 202 -HTTP_STATUS_PARTIAL = 203 -HTTP_STATUS_NO_CONTENT = 204 -HTTP_STATUS_RESET_CONTENT = 205 -HTTP_STATUS_PARTIAL_CONTENT = 206 -HTTP_STATUS_WEBDAV_MULTI_STATUS = 207 -HTTP_STATUS_AMBIGUOUS = 300 -HTTP_STATUS_MOVED = 301 -HTTP_STATUS_REDIRECT = 302 -HTTP_STATUS_REDIRECT_METHOD = 303 -HTTP_STATUS_NOT_MODIFIED = 304 -HTTP_STATUS_USE_PROXY = 305 -HTTP_STATUS_REDIRECT_KEEP_VERB = 307 -HTTP_STATUS_BAD_REQUEST = 400 -HTTP_STATUS_DENIED = 401 -HTTP_STATUS_PAYMENT_REQ = 402 -HTTP_STATUS_FORBIDDEN = 403 -HTTP_STATUS_NOT_FOUND = 404 -HTTP_STATUS_BAD_METHOD = 405 -HTTP_STATUS_NONE_ACCEPTABLE = 406 -HTTP_STATUS_PROXY_AUTH_REQ = 407 -HTTP_STATUS_REQUEST_TIMEOUT = 408 -HTTP_STATUS_CONFLICT = 409 -HTTP_STATUS_GONE = 410 -HTTP_STATUS_LENGTH_REQUIRED = 411 -HTTP_STATUS_PRECOND_FAILED = 412 -HTTP_STATUS_REQUEST_TOO_LARGE = 413 -HTTP_STATUS_URI_TOO_LONG = 414 -HTTP_STATUS_UNSUPPORTED_MEDIA = 415 -HTTP_STATUS_RETRY_WITH = 449 -HTTP_STATUS_SERVER_ERROR = 500 -HTTP_STATUS_NOT_SUPPORTED = 501 -HTTP_STATUS_BAD_GATEWAY = 502 -HTTP_STATUS_SERVICE_UNAVAIL = 503 -HTTP_STATUS_GATEWAY_TIMEOUT = 504 -HTTP_STATUS_VERSION_NOT_SUP = 505 -HTTP_STATUS_FIRST = HTTP_STATUS_CONTINUE -HTTP_STATUS_LAST = HTTP_STATUS_VERSION_NOT_SUP -WINHTTP_ADDREQ_INDEX_MASK = 0x0000FFFF -WINHTTP_ADDREQ_FLAGS_MASK = (-65536) -WINHTTP_ADDREQ_FLAG_ADD_IF_NEW = 0x10000000 -WINHTTP_ADDREQ_FLAG_ADD = 0x20000000 -WINHTTP_ADDREQ_FLAG_COALESCE_WITH_COMMA = 0x40000000 -WINHTTP_ADDREQ_FLAG_COALESCE_WITH_SEMICOLON = 0x01000000 -WINHTTP_ADDREQ_FLAG_COALESCE = WINHTTP_ADDREQ_FLAG_COALESCE_WITH_COMMA -WINHTTP_ADDREQ_FLAG_REPLACE = (-2147483648) -WINHTTP_IGNORE_REQUEST_TOTAL_LENGTH = 0 -WINHTTP_ERROR_BASE = 12000 -ERROR_WINHTTP_OUT_OF_HANDLES = (WINHTTP_ERROR_BASE + 1) -ERROR_WINHTTP_TIMEOUT = (WINHTTP_ERROR_BASE + 2) -ERROR_WINHTTP_INTERNAL_ERROR = (WINHTTP_ERROR_BASE + 4) -ERROR_WINHTTP_INVALID_URL = (WINHTTP_ERROR_BASE + 5) -ERROR_WINHTTP_UNRECOGNIZED_SCHEME = (WINHTTP_ERROR_BASE + 6) -ERROR_WINHTTP_NAME_NOT_RESOLVED = (WINHTTP_ERROR_BASE + 7) -ERROR_WINHTTP_INVALID_OPTION = (WINHTTP_ERROR_BASE + 9) -ERROR_WINHTTP_OPTION_NOT_SETTABLE = (WINHTTP_ERROR_BASE + 11) -ERROR_WINHTTP_SHUTDOWN = (WINHTTP_ERROR_BASE + 12) -ERROR_WINHTTP_LOGIN_FAILURE = (WINHTTP_ERROR_BASE + 15) -ERROR_WINHTTP_OPERATION_CANCELLED = (WINHTTP_ERROR_BASE + 17) -ERROR_WINHTTP_INCORRECT_HANDLE_TYPE = (WINHTTP_ERROR_BASE + 18) -ERROR_WINHTTP_INCORRECT_HANDLE_STATE = (WINHTTP_ERROR_BASE + 19) -ERROR_WINHTTP_CANNOT_CONNECT = (WINHTTP_ERROR_BASE + 29) -ERROR_WINHTTP_CONNECTION_ERROR = (WINHTTP_ERROR_BASE + 30) -ERROR_WINHTTP_RESEND_REQUEST = (WINHTTP_ERROR_BASE + 32) -ERROR_WINHTTP_CLIENT_AUTH_CERT_NEEDED = (WINHTTP_ERROR_BASE + 44) -ERROR_WINHTTP_CANNOT_CALL_BEFORE_OPEN = (WINHTTP_ERROR_BASE + 100) -ERROR_WINHTTP_CANNOT_CALL_BEFORE_SEND = (WINHTTP_ERROR_BASE + 101) -ERROR_WINHTTP_CANNOT_CALL_AFTER_SEND = (WINHTTP_ERROR_BASE + 102) -ERROR_WINHTTP_CANNOT_CALL_AFTER_OPEN = (WINHTTP_ERROR_BASE + 103) -ERROR_WINHTTP_HEADER_NOT_FOUND = (WINHTTP_ERROR_BASE + 150) -ERROR_WINHTTP_INVALID_SERVER_RESPONSE = (WINHTTP_ERROR_BASE + 152) -ERROR_WINHTTP_INVALID_HEADER = (WINHTTP_ERROR_BASE + 153) -ERROR_WINHTTP_INVALID_QUERY_REQUEST = (WINHTTP_ERROR_BASE + 154) -ERROR_WINHTTP_HEADER_ALREADY_EXISTS = (WINHTTP_ERROR_BASE + 155) -ERROR_WINHTTP_REDIRECT_FAILED = (WINHTTP_ERROR_BASE + 156) -ERROR_WINHTTP_AUTO_PROXY_SERVICE_ERROR = (WINHTTP_ERROR_BASE + 178) -ERROR_WINHTTP_BAD_AUTO_PROXY_SCRIPT = (WINHTTP_ERROR_BASE + 166) -ERROR_WINHTTP_UNABLE_TO_DOWNLOAD_SCRIPT = (WINHTTP_ERROR_BASE + 167) -ERROR_WINHTTP_NOT_INITIALIZED = (WINHTTP_ERROR_BASE + 172) -ERROR_WINHTTP_SECURE_FAILURE = (WINHTTP_ERROR_BASE + 175) -ERROR_WINHTTP_SECURE_CERT_DATE_INVALID = (WINHTTP_ERROR_BASE + 37) -ERROR_WINHTTP_SECURE_CERT_CN_INVALID = (WINHTTP_ERROR_BASE + 38) -ERROR_WINHTTP_SECURE_INVALID_CA = (WINHTTP_ERROR_BASE + 45) -ERROR_WINHTTP_SECURE_CERT_REV_FAILED = (WINHTTP_ERROR_BASE + 57) -ERROR_WINHTTP_SECURE_CHANNEL_ERROR = (WINHTTP_ERROR_BASE + 157) -ERROR_WINHTTP_SECURE_INVALID_CERT = (WINHTTP_ERROR_BASE + 169) -ERROR_WINHTTP_SECURE_CERT_REVOKED = (WINHTTP_ERROR_BASE + 170) -ERROR_WINHTTP_SECURE_CERT_WRONG_USAGE = (WINHTTP_ERROR_BASE + 179) -ERROR_WINHTTP_AUTODETECTION_FAILED = (WINHTTP_ERROR_BASE + 180) -ERROR_WINHTTP_HEADER_COUNT_EXCEEDED = (WINHTTP_ERROR_BASE + 181) -ERROR_WINHTTP_HEADER_SIZE_OVERFLOW = (WINHTTP_ERROR_BASE + 182) -ERROR_WINHTTP_CHUNKED_ENCODING_HEADER_SIZE_OVERFLOW = (WINHTTP_ERROR_BASE + 183) -ERROR_WINHTTP_RESPONSE_DRAIN_OVERFLOW = (WINHTTP_ERROR_BASE + 184) -ERROR_WINHTTP_CLIENT_CERT_NO_PRIVATE_KEY = (WINHTTP_ERROR_BASE + 185) -ERROR_WINHTTP_CLIENT_CERT_NO_ACCESS_PRIVATE_KEY = (WINHTTP_ERROR_BASE + 186) -WINHTTP_ERROR_LAST = (WINHTTP_ERROR_BASE + 186) - -WINHTTP_NO_PROXY_NAME = None -WINHTTP_NO_PROXY_BYPASS = None -WINHTTP_NO_REFERER = None -WINHTTP_DEFAULT_ACCEPT_TYPES = None -WINHTTP_NO_ADDITIONAL_HEADERS = None -WINHTTP_NO_REQUEST_DATA = None diff --git a/typings/win32helper/win32netcon.pyi b/typings/win32helper/win32netcon.pyi deleted file mode 100644 index 73795969..00000000 --- a/typings/win32helper/win32netcon.pyi +++ /dev/null @@ -1,655 +0,0 @@ -# Generated by h2py from lmaccess.h - -# Included from lmcons.h -CNLEN = 15 -LM20_CNLEN = 15 -DNLEN = CNLEN -LM20_DNLEN = LM20_CNLEN -UNCLEN = (CNLEN+2) -LM20_UNCLEN = (LM20_CNLEN+2) -NNLEN = 80 -LM20_NNLEN = 12 -RMLEN = (UNCLEN+1+NNLEN) -LM20_RMLEN = (LM20_UNCLEN+1+LM20_NNLEN) -SNLEN = 80 -LM20_SNLEN = 15 -STXTLEN = 256 -LM20_STXTLEN = 63 -PATHLEN = 256 -LM20_PATHLEN = 256 -DEVLEN = 80 -LM20_DEVLEN = 8 -EVLEN = 16 -UNLEN = 256 -LM20_UNLEN = 20 -GNLEN = UNLEN -LM20_GNLEN = LM20_UNLEN -PWLEN = 256 -LM20_PWLEN = 14 -SHPWLEN = 8 -CLTYPE_LEN = 12 -MAXCOMMENTSZ = 256 -LM20_MAXCOMMENTSZ = 48 -QNLEN = NNLEN -LM20_QNLEN = LM20_NNLEN -ALERTSZ = 128 -NETBIOS_NAME_LEN = 16 -CRYPT_KEY_LEN = 7 -CRYPT_TXT_LEN = 8 -ENCRYPTED_PWLEN = 16 -SESSION_PWLEN = 24 -SESSION_CRYPT_KLEN = 21 -PARMNUM_ALL = 0 -PARM_ERROR_NONE = 0 -PARMNUM_BASE_INFOLEVEL = 1000 -NULL = 0 -PLATFORM_ID_DOS = 300 -PLATFORM_ID_OS2 = 400 -PLATFORM_ID_NT = 500 -PLATFORM_ID_OSF = 600 -PLATFORM_ID_VMS = 700 -MAX_LANMAN_MESSAGE_ID = 5799 -UF_SCRIPT = 1 -UF_ACCOUNTDISABLE = 2 -UF_HOMEDIR_REQUIRED = 8 -UF_LOCKOUT = 16 -UF_PASSWD_NOTREQD = 32 -UF_PASSWD_CANT_CHANGE = 64 -UF_TEMP_DUPLICATE_ACCOUNT = 256 -UF_NORMAL_ACCOUNT = 512 -UF_INTERDOMAIN_TRUST_ACCOUNT = 2048 -UF_WORKSTATION_TRUST_ACCOUNT = 4096 -UF_SERVER_TRUST_ACCOUNT = 8192 -UF_MACHINE_ACCOUNT_MASK = ( UF_INTERDOMAIN_TRUST_ACCOUNT | \ - UF_WORKSTATION_TRUST_ACCOUNT | \ - UF_SERVER_TRUST_ACCOUNT ) -UF_ACCOUNT_TYPE_MASK = ( \ - UF_TEMP_DUPLICATE_ACCOUNT | \ - UF_NORMAL_ACCOUNT | \ - UF_INTERDOMAIN_TRUST_ACCOUNT | \ - UF_WORKSTATION_TRUST_ACCOUNT | \ - UF_SERVER_TRUST_ACCOUNT \ - ) -UF_DONT_EXPIRE_PASSWD = 65536 -UF_MNS_LOGON_ACCOUNT = 131072 -UF_SETTABLE_BITS = ( \ - UF_SCRIPT | \ - UF_ACCOUNTDISABLE | \ - UF_LOCKOUT | \ - UF_HOMEDIR_REQUIRED | \ - UF_PASSWD_NOTREQD | \ - UF_PASSWD_CANT_CHANGE | \ - UF_ACCOUNT_TYPE_MASK | \ - UF_DONT_EXPIRE_PASSWD | \ - UF_MNS_LOGON_ACCOUNT \ - ) -FILTER_TEMP_DUPLICATE_ACCOUNT = (1) -FILTER_NORMAL_ACCOUNT = (2) -FILTER_INTERDOMAIN_TRUST_ACCOUNT = (8) -FILTER_WORKSTATION_TRUST_ACCOUNT = (16) -FILTER_SERVER_TRUST_ACCOUNT = (32) -LG_INCLUDE_INDIRECT = (1) -AF_OP_PRINT = 1 -AF_OP_COMM = 2 -AF_OP_SERVER = 4 -AF_OP_ACCOUNTS = 8 -AF_SETTABLE_BITS = (AF_OP_PRINT | AF_OP_COMM | \ - AF_OP_SERVER | AF_OP_ACCOUNTS) -UAS_ROLE_STANDALONE = 0 -UAS_ROLE_MEMBER = 1 -UAS_ROLE_BACKUP = 2 -UAS_ROLE_PRIMARY = 3 -USER_NAME_PARMNUM = 1 -USER_PASSWORD_PARMNUM = 3 -USER_PASSWORD_AGE_PARMNUM = 4 -USER_PRIV_PARMNUM = 5 -USER_HOME_DIR_PARMNUM = 6 -USER_COMMENT_PARMNUM = 7 -USER_FLAGS_PARMNUM = 8 -USER_SCRIPT_PATH_PARMNUM = 9 -USER_AUTH_FLAGS_PARMNUM = 10 -USER_FULL_NAME_PARMNUM = 11 -USER_USR_COMMENT_PARMNUM = 12 -USER_PARMS_PARMNUM = 13 -USER_WORKSTATIONS_PARMNUM = 14 -USER_LAST_LOGON_PARMNUM = 15 -USER_LAST_LOGOFF_PARMNUM = 16 -USER_ACCT_EXPIRES_PARMNUM = 17 -USER_MAX_STORAGE_PARMNUM = 18 -USER_UNITS_PER_WEEK_PARMNUM = 19 -USER_LOGON_HOURS_PARMNUM = 20 -USER_PAD_PW_COUNT_PARMNUM = 21 -USER_NUM_LOGONS_PARMNUM = 22 -USER_LOGON_SERVER_PARMNUM = 23 -USER_COUNTRY_CODE_PARMNUM = 24 -USER_CODE_PAGE_PARMNUM = 25 -USER_PRIMARY_GROUP_PARMNUM = 51 -USER_PROFILE = 52 -USER_PROFILE_PARMNUM = 52 -USER_HOME_DIR_DRIVE_PARMNUM = 53 -USER_NAME_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_NAME_PARMNUM) -USER_PASSWORD_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_PASSWORD_PARMNUM) -USER_PASSWORD_AGE_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_PASSWORD_AGE_PARMNUM) -USER_PRIV_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_PRIV_PARMNUM) -USER_HOME_DIR_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_HOME_DIR_PARMNUM) -USER_COMMENT_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_COMMENT_PARMNUM) -USER_FLAGS_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_FLAGS_PARMNUM) -USER_SCRIPT_PATH_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_SCRIPT_PATH_PARMNUM) -USER_AUTH_FLAGS_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_AUTH_FLAGS_PARMNUM) -USER_FULL_NAME_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_FULL_NAME_PARMNUM) -USER_USR_COMMENT_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_USR_COMMENT_PARMNUM) -USER_PARMS_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_PARMS_PARMNUM) -USER_WORKSTATIONS_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_WORKSTATIONS_PARMNUM) -USER_LAST_LOGON_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_LAST_LOGON_PARMNUM) -USER_LAST_LOGOFF_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_LAST_LOGOFF_PARMNUM) -USER_ACCT_EXPIRES_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_ACCT_EXPIRES_PARMNUM) -USER_MAX_STORAGE_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_MAX_STORAGE_PARMNUM) -USER_UNITS_PER_WEEK_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_UNITS_PER_WEEK_PARMNUM) -USER_LOGON_HOURS_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_LOGON_HOURS_PARMNUM) -USER_PAD_PW_COUNT_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_PAD_PW_COUNT_PARMNUM) -USER_NUM_LOGONS_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_NUM_LOGONS_PARMNUM) -USER_LOGON_SERVER_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_LOGON_SERVER_PARMNUM) -USER_COUNTRY_CODE_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_COUNTRY_CODE_PARMNUM) -USER_CODE_PAGE_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_CODE_PAGE_PARMNUM) -USER_PRIMARY_GROUP_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_PRIMARY_GROUP_PARMNUM) -USER_HOME_DIR_DRIVE_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_HOME_DIR_DRIVE_PARMNUM) -NULL_USERSETINFO_PASSWD = " " -UNITS_PER_DAY = 24 -UNITS_PER_WEEK = UNITS_PER_DAY * 7 -USER_PRIV_MASK = 3 -USER_PRIV_GUEST = 0 -USER_PRIV_USER = 1 -USER_PRIV_ADMIN = 2 -MAX_PASSWD_LEN = PWLEN -DEF_MIN_PWLEN = 6 -DEF_PWUNIQUENESS = 5 -DEF_MAX_PWHIST = 8 -DEF_MAX_BADPW = 0 -VALIDATED_LOGON = 0 -PASSWORD_EXPIRED = 2 -NON_VALIDATED_LOGON = 3 -VALID_LOGOFF = 1 -MODALS_MIN_PASSWD_LEN_PARMNUM = 1 -MODALS_MAX_PASSWD_AGE_PARMNUM = 2 -MODALS_MIN_PASSWD_AGE_PARMNUM = 3 -MODALS_FORCE_LOGOFF_PARMNUM = 4 -MODALS_PASSWD_HIST_LEN_PARMNUM = 5 -MODALS_ROLE_PARMNUM = 6 -MODALS_PRIMARY_PARMNUM = 7 -MODALS_DOMAIN_NAME_PARMNUM = 8 -MODALS_DOMAIN_ID_PARMNUM = 9 -MODALS_LOCKOUT_DURATION_PARMNUM = 10 -MODALS_LOCKOUT_OBSERVATION_WINDOW_PARMNUM = 11 -MODALS_LOCKOUT_THRESHOLD_PARMNUM = 12 -MODALS_MIN_PASSWD_LEN_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_MIN_PASSWD_LEN_PARMNUM) -MODALS_MAX_PASSWD_AGE_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_MAX_PASSWD_AGE_PARMNUM) -MODALS_MIN_PASSWD_AGE_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_MIN_PASSWD_AGE_PARMNUM) -MODALS_FORCE_LOGOFF_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_FORCE_LOGOFF_PARMNUM) -MODALS_PASSWD_HIST_LEN_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_PASSWD_HIST_LEN_PARMNUM) -MODALS_ROLE_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_ROLE_PARMNUM) -MODALS_PRIMARY_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_PRIMARY_PARMNUM) -MODALS_DOMAIN_NAME_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_DOMAIN_NAME_PARMNUM) -MODALS_DOMAIN_ID_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_DOMAIN_ID_PARMNUM) -GROUPIDMASK = 32768 -GROUP_ALL_PARMNUM = 0 -GROUP_NAME_PARMNUM = 1 -GROUP_COMMENT_PARMNUM = 2 -GROUP_ATTRIBUTES_PARMNUM = 3 -GROUP_ALL_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + GROUP_ALL_PARMNUM) -GROUP_NAME_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + GROUP_NAME_PARMNUM) -GROUP_COMMENT_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + GROUP_COMMENT_PARMNUM) -GROUP_ATTRIBUTES_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + GROUP_ATTRIBUTES_PARMNUM) -LOCALGROUP_NAME_PARMNUM = 1 -LOCALGROUP_COMMENT_PARMNUM = 2 -MAXPERMENTRIES = 64 -ACCESS_NONE = 0 -ACCESS_READ = 1 -ACCESS_WRITE = 2 -ACCESS_CREATE = 4 -ACCESS_EXEC = 8 -ACCESS_DELETE = 16 -ACCESS_ATRIB = 32 -ACCESS_PERM = 64 -ACCESS_GROUP = 32768 -ACCESS_AUDIT = 1 -ACCESS_SUCCESS_OPEN = 16 -ACCESS_SUCCESS_WRITE = 32 -ACCESS_SUCCESS_DELETE = 64 -ACCESS_SUCCESS_ACL = 128 -ACCESS_SUCCESS_MASK = 240 -ACCESS_FAIL_OPEN = 256 -ACCESS_FAIL_WRITE = 512 -ACCESS_FAIL_DELETE = 1024 -ACCESS_FAIL_ACL = 2048 -ACCESS_FAIL_MASK = 3840 -ACCESS_FAIL_SHIFT = 4 -ACCESS_RESOURCE_NAME_PARMNUM = 1 -ACCESS_ATTR_PARMNUM = 2 -ACCESS_COUNT_PARMNUM = 3 -ACCESS_ACCESS_LIST_PARMNUM = 4 -ACCESS_RESOURCE_NAME_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + ACCESS_RESOURCE_NAME_PARMNUM) -ACCESS_ATTR_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + ACCESS_ATTR_PARMNUM) -ACCESS_COUNT_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + ACCESS_COUNT_PARMNUM) -ACCESS_ACCESS_LIST_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + ACCESS_ACCESS_LIST_PARMNUM) -ACCESS_LETTERS = "RWCXDAP " -NETLOGON_CONTROL_QUERY = 1 -NETLOGON_CONTROL_REPLICATE = 2 -NETLOGON_CONTROL_SYNCHRONIZE = 3 -NETLOGON_CONTROL_PDC_REPLICATE = 4 -NETLOGON_CONTROL_REDISCOVER = 5 -NETLOGON_CONTROL_TC_QUERY = 6 -NETLOGON_CONTROL_TRANSPORT_NOTIFY = 7 -NETLOGON_CONTROL_FIND_USER = 8 -NETLOGON_CONTROL_UNLOAD_NETLOGON_DLL = 65531 -NETLOGON_CONTROL_BACKUP_CHANGE_LOG = 65532 -NETLOGON_CONTROL_TRUNCATE_LOG = 65533 -NETLOGON_CONTROL_SET_DBFLAG = 65534 -NETLOGON_CONTROL_BREAKPOINT = 65535 -NETLOGON_REPLICATION_NEEDED = 1 -NETLOGON_REPLICATION_IN_PROGRESS = 2 -NETLOGON_FULL_SYNC_REPLICATION = 4 -NETLOGON_REDO_NEEDED = 8 - -###################### -# Manual stuff - -TEXT=lambda x:x - -MAX_PREFERRED_LENGTH = -1 -PARM_ERROR_UNKNOWN = -1 -MESSAGE_FILENAME = TEXT("NETMSG") -OS2MSG_FILENAME = TEXT("BASE") -HELP_MSG_FILENAME = TEXT("NETH") -BACKUP_MSG_FILENAME = TEXT("BAK.MSG") -TIMEQ_FOREVER = -1 -USER_MAXSTORAGE_UNLIMITED = -1 -USER_NO_LOGOFF = -1 -DEF_MAX_PWAGE = TIMEQ_FOREVER -DEF_MIN_PWAGE = 0 -DEF_FORCE_LOGOFF = -1 -ONE_DAY = 1*24*3600 -GROUP_SPECIALGRP_USERS = "USERS" -GROUP_SPECIALGRP_ADMINS = "ADMINS" -GROUP_SPECIALGRP_GUESTS = "GUESTS" -GROUP_SPECIALGRP_LOCAL = "LOCAL" -ACCESS_ALL = ( ACCESS_READ | ACCESS_WRITE | ACCESS_CREATE | ACCESS_EXEC | ACCESS_DELETE | ACCESS_ATRIB | ACCESS_PERM ) - -# From lmserver.h -SV_PLATFORM_ID_OS2 = 400 -SV_PLATFORM_ID_NT = 500 -MAJOR_VERSION_MASK = 15 -SV_TYPE_WORKSTATION = 1 -SV_TYPE_SERVER = 2 -SV_TYPE_SQLSERVER = 4 -SV_TYPE_DOMAIN_CTRL = 8 -SV_TYPE_DOMAIN_BAKCTRL = 16 -SV_TYPE_TIME_SOURCE = 32 -SV_TYPE_AFP = 64 -SV_TYPE_NOVELL = 128 -SV_TYPE_DOMAIN_MEMBER = 256 -SV_TYPE_PRINTQ_SERVER = 512 -SV_TYPE_DIALIN_SERVER = 1024 -SV_TYPE_XENIX_SERVER = 2048 -SV_TYPE_SERVER_UNIX = SV_TYPE_XENIX_SERVER -SV_TYPE_NT = 4096 -SV_TYPE_WFW = 8192 -SV_TYPE_SERVER_MFPN = 16384 -SV_TYPE_SERVER_NT = 32768 -SV_TYPE_POTENTIAL_BROWSER = 65536 -SV_TYPE_BACKUP_BROWSER = 131072 -SV_TYPE_MASTER_BROWSER = 262144 -SV_TYPE_DOMAIN_MASTER = 524288 -SV_TYPE_SERVER_OSF = 1048576 -SV_TYPE_SERVER_VMS = 2097152 -SV_TYPE_WINDOWS = 4194304 -SV_TYPE_DFS = 8388608 -SV_TYPE_CLUSTER_NT = 16777216 -SV_TYPE_DCE = 268435456 -SV_TYPE_ALTERNATE_XPORT = 536870912 -SV_TYPE_LOCAL_LIST_ONLY = 1073741824 -SV_TYPE_DOMAIN_ENUM = -2147483648 -SV_TYPE_ALL = -1 -SV_NODISC = -1 -SV_USERSECURITY = 1 -SV_SHARESECURITY = 0 -SV_HIDDEN = 1 -SV_VISIBLE = 0 -SV_PLATFORM_ID_PARMNUM = 101 -SV_NAME_PARMNUM = 102 -SV_VERSION_MAJOR_PARMNUM = 103 -SV_VERSION_MINOR_PARMNUM = 104 -SV_TYPE_PARMNUM = 105 -SV_COMMENT_PARMNUM = 5 -SV_USERS_PARMNUM = 107 -SV_DISC_PARMNUM = 10 -SV_HIDDEN_PARMNUM = 16 -SV_ANNOUNCE_PARMNUM = 17 -SV_ANNDELTA_PARMNUM = 18 -SV_USERPATH_PARMNUM = 112 -SV_ULIST_MTIME_PARMNUM = 401 -SV_GLIST_MTIME_PARMNUM = 402 -SV_ALIST_MTIME_PARMNUM = 403 -SV_ALERTS_PARMNUM = 11 -SV_SECURITY_PARMNUM = 405 -SV_NUMADMIN_PARMNUM = 406 -SV_LANMASK_PARMNUM = 407 -SV_GUESTACC_PARMNUM = 408 -SV_CHDEVQ_PARMNUM = 410 -SV_CHDEVJOBS_PARMNUM = 411 -SV_CONNECTIONS_PARMNUM = 412 -SV_SHARES_PARMNUM = 413 -SV_OPENFILES_PARMNUM = 414 -SV_SESSREQS_PARMNUM = 417 -SV_ACTIVELOCKS_PARMNUM = 419 -SV_NUMREQBUF_PARMNUM = 420 -SV_NUMBIGBUF_PARMNUM = 422 -SV_NUMFILETASKS_PARMNUM = 423 -SV_ALERTSCHED_PARMNUM = 37 -SV_ERRORALERT_PARMNUM = 38 -SV_LOGONALERT_PARMNUM = 39 -SV_ACCESSALERT_PARMNUM = 40 -SV_DISKALERT_PARMNUM = 41 -SV_NETIOALERT_PARMNUM = 42 -SV_MAXAUDITSZ_PARMNUM = 43 -SV_SRVHEURISTICS_PARMNUM = 431 -SV_SESSOPENS_PARMNUM = 501 -SV_SESSVCS_PARMNUM = 502 -SV_OPENSEARCH_PARMNUM = 503 -SV_SIZREQBUF_PARMNUM = 504 -SV_INITWORKITEMS_PARMNUM = 505 -SV_MAXWORKITEMS_PARMNUM = 506 -SV_RAWWORKITEMS_PARMNUM = 507 -SV_IRPSTACKSIZE_PARMNUM = 508 -SV_MAXRAWBUFLEN_PARMNUM = 509 -SV_SESSUSERS_PARMNUM = 510 -SV_SESSCONNS_PARMNUM = 511 -SV_MAXNONPAGEDMEMORYUSAGE_PARMNUM = 512 -SV_MAXPAGEDMEMORYUSAGE_PARMNUM = 513 -SV_ENABLESOFTCOMPAT_PARMNUM = 514 -SV_ENABLEFORCEDLOGOFF_PARMNUM = 515 -SV_TIMESOURCE_PARMNUM = 516 -SV_ACCEPTDOWNLEVELAPIS_PARMNUM = 517 -SV_LMANNOUNCE_PARMNUM = 518 -SV_DOMAIN_PARMNUM = 519 -SV_MAXCOPYREADLEN_PARMNUM = 520 -SV_MAXCOPYWRITELEN_PARMNUM = 521 -SV_MINKEEPSEARCH_PARMNUM = 522 -SV_MAXKEEPSEARCH_PARMNUM = 523 -SV_MINKEEPCOMPLSEARCH_PARMNUM = 524 -SV_MAXKEEPCOMPLSEARCH_PARMNUM = 525 -SV_THREADCOUNTADD_PARMNUM = 526 -SV_NUMBLOCKTHREADS_PARMNUM = 527 -SV_SCAVTIMEOUT_PARMNUM = 528 -SV_MINRCVQUEUE_PARMNUM = 529 -SV_MINFREEWORKITEMS_PARMNUM = 530 -SV_XACTMEMSIZE_PARMNUM = 531 -SV_THREADPRIORITY_PARMNUM = 532 -SV_MAXMPXCT_PARMNUM = 533 -SV_OPLOCKBREAKWAIT_PARMNUM = 534 -SV_OPLOCKBREAKRESPONSEWAIT_PARMNUM = 535 -SV_ENABLEOPLOCKS_PARMNUM = 536 -SV_ENABLEOPLOCKFORCECLOSE_PARMNUM = 537 -SV_ENABLEFCBOPENS_PARMNUM = 538 -SV_ENABLERAW_PARMNUM = 539 -SV_ENABLESHAREDNETDRIVES_PARMNUM = 540 -SV_MINFREECONNECTIONS_PARMNUM = 541 -SV_MAXFREECONNECTIONS_PARMNUM = 542 -SV_INITSESSTABLE_PARMNUM = 543 -SV_INITCONNTABLE_PARMNUM = 544 -SV_INITFILETABLE_PARMNUM = 545 -SV_INITSEARCHTABLE_PARMNUM = 546 -SV_ALERTSCHEDULE_PARMNUM = 547 -SV_ERRORTHRESHOLD_PARMNUM = 548 -SV_NETWORKERRORTHRESHOLD_PARMNUM = 549 -SV_DISKSPACETHRESHOLD_PARMNUM = 550 -SV_MAXLINKDELAY_PARMNUM = 552 -SV_MINLINKTHROUGHPUT_PARMNUM = 553 -SV_LINKINFOVALIDTIME_PARMNUM = 554 -SV_SCAVQOSINFOUPDATETIME_PARMNUM = 555 -SV_MAXWORKITEMIDLETIME_PARMNUM = 556 -SV_MAXRAWWORKITEMS_PARMNUM = 557 -SV_PRODUCTTYPE_PARMNUM = 560 -SV_SERVERSIZE_PARMNUM = 561 -SV_CONNECTIONLESSAUTODISC_PARMNUM = 562 -SV_SHARINGVIOLATIONRETRIES_PARMNUM = 563 -SV_SHARINGVIOLATIONDELAY_PARMNUM = 564 -SV_MAXGLOBALOPENSEARCH_PARMNUM = 565 -SV_REMOVEDUPLICATESEARCHES_PARMNUM = 566 -SV_LOCKVIOLATIONRETRIES_PARMNUM = 567 -SV_LOCKVIOLATIONOFFSET_PARMNUM = 568 -SV_LOCKVIOLATIONDELAY_PARMNUM = 569 -SV_MDLREADSWITCHOVER_PARMNUM = 570 -SV_CACHEDOPENLIMIT_PARMNUM = 571 -SV_CRITICALTHREADS_PARMNUM = 572 -SV_RESTRICTNULLSESSACCESS_PARMNUM = 573 -SV_ENABLEWFW311DIRECTIPX_PARMNUM = 574 -SV_OTHERQUEUEAFFINITY_PARMNUM = 575 -SV_QUEUESAMPLESECS_PARMNUM = 576 -SV_BALANCECOUNT_PARMNUM = 577 -SV_PREFERREDAFFINITY_PARMNUM = 578 -SV_MAXFREERFCBS_PARMNUM = 579 -SV_MAXFREEMFCBS_PARMNUM = 580 -SV_MAXFREELFCBS_PARMNUM = 581 -SV_MAXFREEPAGEDPOOLCHUNKS_PARMNUM = 582 -SV_MINPAGEDPOOLCHUNKSIZE_PARMNUM = 583 -SV_MAXPAGEDPOOLCHUNKSIZE_PARMNUM = 584 -SV_SENDSFROMPREFERREDPROCESSOR_PARMNUM = 585 -SV_MAXTHREADSPERQUEUE_PARMNUM = 586 -SV_CACHEDDIRECTORYLIMIT_PARMNUM = 587 -SV_MAXCOPYLENGTH_PARMNUM = 588 -SV_ENABLEBULKTRANSFER_PARMNUM = 589 -SV_ENABLECOMPRESSION_PARMNUM = 590 -SV_AUTOSHAREWKS_PARMNUM = 591 -SV_AUTOSHARESERVER_PARMNUM = 592 -SV_ENABLESECURITYSIGNATURE_PARMNUM = 593 -SV_REQUIRESECURITYSIGNATURE_PARMNUM = 594 -SV_MINCLIENTBUFFERSIZE_PARMNUM = 595 -SV_CONNECTIONNOSESSIONSTIMEOUT_PARMNUM = 596 -SVI1_NUM_ELEMENTS = 5 -SVI2_NUM_ELEMENTS = 40 -SVI3_NUM_ELEMENTS = 44 -SW_AUTOPROF_LOAD_MASK = 1 -SW_AUTOPROF_SAVE_MASK = 2 -SV_MAX_SRV_HEUR_LEN = 32 -SV_USERS_PER_LICENSE = 5 -SVTI2_REMAP_PIPE_NAMES = 2 - -# Generated by h2py from lmshare.h -SHARE_NETNAME_PARMNUM = 1 -SHARE_TYPE_PARMNUM = 3 -SHARE_REMARK_PARMNUM = 4 -SHARE_PERMISSIONS_PARMNUM = 5 -SHARE_MAX_USES_PARMNUM = 6 -SHARE_CURRENT_USES_PARMNUM = 7 -SHARE_PATH_PARMNUM = 8 -SHARE_PASSWD_PARMNUM = 9 -SHARE_FILE_SD_PARMNUM = 501 -SHI1_NUM_ELEMENTS = 4 -SHI2_NUM_ELEMENTS = 10 -STYPE_DISKTREE = 0 -STYPE_PRINTQ = 1 -STYPE_DEVICE = 2 -STYPE_IPC = 3 -STYPE_SPECIAL = -2147483648 -SHI1005_FLAGS_DFS = 1 -SHI1005_FLAGS_DFS_ROOT = 2 -COW_PERMACHINE = 4 -COW_PERUSER = 8 -CSC_CACHEABLE = 16 -CSC_NOFLOWOPS = 32 -CSC_AUTO_INWARD = 64 -CSC_AUTO_OUTWARD = 128 -SHI1005_VALID_FLAGS_SET = ( CSC_CACHEABLE | \ - CSC_NOFLOWOPS | \ - CSC_AUTO_INWARD | \ - CSC_AUTO_OUTWARD| \ - COW_PERMACHINE | \ - COW_PERUSER ) -SHI1007_VALID_FLAGS_SET = SHI1005_VALID_FLAGS_SET -SESS_GUEST = 1 -SESS_NOENCRYPTION = 2 -SESI1_NUM_ELEMENTS = 8 -SESI2_NUM_ELEMENTS = 9 -PERM_FILE_READ = 1 -PERM_FILE_WRITE = 2 -PERM_FILE_CREATE = 4 - -# Generated by h2py from d:\mssdk\include\winnetwk.h -WNNC_NET_MSNET = 65536 -WNNC_NET_LANMAN = 131072 -WNNC_NET_NETWARE = 196608 -WNNC_NET_VINES = 262144 -WNNC_NET_10NET = 327680 -WNNC_NET_LOCUS = 393216 -WNNC_NET_SUN_PC_NFS = 458752 -WNNC_NET_LANSTEP = 524288 -WNNC_NET_9TILES = 589824 -WNNC_NET_LANTASTIC = 655360 -WNNC_NET_AS400 = 720896 -WNNC_NET_FTP_NFS = 786432 -WNNC_NET_PATHWORKS = 851968 -WNNC_NET_LIFENET = 917504 -WNNC_NET_POWERLAN = 983040 -WNNC_NET_BWNFS = 1048576 -WNNC_NET_COGENT = 1114112 -WNNC_NET_FARALLON = 1179648 -WNNC_NET_APPLETALK = 1245184 -WNNC_NET_INTERGRAPH = 1310720 -WNNC_NET_SYMFONET = 1376256 -WNNC_NET_CLEARCASE = 1441792 -WNNC_NET_FRONTIER = 1507328 -WNNC_NET_BMC = 1572864 -WNNC_NET_DCE = 1638400 -WNNC_NET_DECORB = 2097152 -WNNC_NET_PROTSTOR = 2162688 -WNNC_NET_FJ_REDIR = 2228224 -WNNC_NET_DISTINCT = 2293760 -WNNC_NET_TWINS = 2359296 -WNNC_NET_RDR2SAMPLE = 2424832 -RESOURCE_CONNECTED = 1 -RESOURCE_GLOBALNET = 2 -RESOURCE_REMEMBERED = 3 -RESOURCE_RECENT = 4 -RESOURCE_CONTEXT = 5 -RESOURCETYPE_ANY = 0 -RESOURCETYPE_DISK = 1 -RESOURCETYPE_PRINT = 2 -RESOURCETYPE_RESERVED = 8 -RESOURCETYPE_UNKNOWN = -1 -RESOURCEUSAGE_CONNECTABLE = 1 -RESOURCEUSAGE_CONTAINER = 2 -RESOURCEUSAGE_NOLOCALDEVICE = 4 -RESOURCEUSAGE_SIBLING = 8 -RESOURCEUSAGE_ATTACHED = 16 -RESOURCEUSAGE_ALL = (RESOURCEUSAGE_CONNECTABLE | RESOURCEUSAGE_CONTAINER | RESOURCEUSAGE_ATTACHED) -RESOURCEUSAGE_RESERVED = -2147483648 -RESOURCEDISPLAYTYPE_GENERIC = 0 -RESOURCEDISPLAYTYPE_DOMAIN = 1 -RESOURCEDISPLAYTYPE_SERVER = 2 -RESOURCEDISPLAYTYPE_SHARE = 3 -RESOURCEDISPLAYTYPE_FILE = 4 -RESOURCEDISPLAYTYPE_GROUP = 5 -RESOURCEDISPLAYTYPE_NETWORK = 6 -RESOURCEDISPLAYTYPE_ROOT = 7 -RESOURCEDISPLAYTYPE_SHAREADMIN = 8 -RESOURCEDISPLAYTYPE_DIRECTORY = 9 -RESOURCEDISPLAYTYPE_TREE = 10 -RESOURCEDISPLAYTYPE_NDSCONTAINER = 11 -NETPROPERTY_PERSISTENT = 1 -CONNECT_UPDATE_PROFILE = 1 -CONNECT_UPDATE_RECENT = 2 -CONNECT_TEMPORARY = 4 -CONNECT_INTERACTIVE = 8 -CONNECT_PROMPT = 16 -CONNECT_NEED_DRIVE = 32 -CONNECT_REFCOUNT = 64 -CONNECT_REDIRECT = 128 -CONNECT_LOCALDRIVE = 256 -CONNECT_CURRENT_MEDIA = 512 -CONNECT_DEFERRED = 1024 -CONNECT_RESERVED = -16777216 -CONNDLG_RO_PATH = 1 -CONNDLG_CONN_POINT = 2 -CONNDLG_USE_MRU = 4 -CONNDLG_HIDE_BOX = 8 -CONNDLG_PERSIST = 16 -CONNDLG_NOT_PERSIST = 32 -DISC_UPDATE_PROFILE = 1 -DISC_NO_FORCE = 64 -UNIVERSAL_NAME_INFO_LEVEL = 1 -REMOTE_NAME_INFO_LEVEL = 2 -WNFMT_MULTILINE = 1 -WNFMT_ABBREVIATED = 2 -WNFMT_INENUM = 16 -WNFMT_CONNECTION = 32 -NETINFO_DLL16 = 1 -NETINFO_DISKRED = 4 -NETINFO_PRINTERRED = 8 -RP_LOGON = 1 -RP_INIFILE = 2 -PP_DISPLAYERRORS = 1 -WNCON_FORNETCARD = 1 -WNCON_NOTROUTED = 2 -WNCON_SLOWLINK = 4 -WNCON_DYNAMIC = 8 - -## NETSETUP_NAME_TYPE, used with NetValidateName -NetSetupUnknown = 0 -NetSetupMachine = 1 -NetSetupWorkgroup = 2 -NetSetupDomain = 3 -NetSetupNonExistentDomain = 4 -NetSetupDnsMachine = 5 - -## NETSETUP_JOIN_STATUS, use with NetGetJoinInformation -NetSetupUnknownStatus = 0 -NetSetupUnjoined = 1 -NetSetupWorkgroupName = 2 -NetSetupDomainName = 3 - -NetValidateAuthentication = 1 -NetValidatePasswordChange = 2 -NetValidatePasswordReset = 3 diff --git a/typings/win32helper/winioctlcon.pyi b/typings/win32helper/winioctlcon.pyi deleted file mode 100644 index 673ea4e5..00000000 --- a/typings/win32helper/winioctlcon.pyi +++ /dev/null @@ -1,711 +0,0 @@ -## flags, enums, guids used with DeviceIoControl from WinIoCtl.h - -import pywintypes -from ntsecuritycon import FILE_READ_DATA,FILE_WRITE_DATA -def CTL_CODE(DeviceType, Function, Method, Access): - return (DeviceType << 16) | (Access << 14) | (Function << 2) | Method - -def DEVICE_TYPE_FROM_CTL_CODE(ctrlCode): - return (ctrlCode & 0xffff0000) >> 16 - -FILE_DEVICE_BEEP = 0x00000001 -FILE_DEVICE_CD_ROM = 0x00000002 -FILE_DEVICE_CD_ROM_FILE_SYSTEM = 0x00000003 -FILE_DEVICE_CONTROLLER = 0x00000004 -FILE_DEVICE_DATALINK = 0x00000005 -FILE_DEVICE_DFS = 0x00000006 -FILE_DEVICE_DISK = 0x00000007 -FILE_DEVICE_DISK_FILE_SYSTEM = 0x00000008 -FILE_DEVICE_FILE_SYSTEM = 0x00000009 -FILE_DEVICE_INPORT_PORT = 0x0000000a -FILE_DEVICE_KEYBOARD = 0x0000000b -FILE_DEVICE_MAILSLOT = 0x0000000c -FILE_DEVICE_MIDI_IN = 0x0000000d -FILE_DEVICE_MIDI_OUT = 0x0000000e -FILE_DEVICE_MOUSE = 0x0000000f -FILE_DEVICE_MULTI_UNC_PROVIDER = 0x00000010 -FILE_DEVICE_NAMED_PIPE = 0x00000011 -FILE_DEVICE_NETWORK = 0x00000012 -FILE_DEVICE_NETWORK_BROWSER = 0x00000013 -FILE_DEVICE_NETWORK_FILE_SYSTEM = 0x00000014 -FILE_DEVICE_NULL = 0x00000015 -FILE_DEVICE_PARALLEL_PORT = 0x00000016 -FILE_DEVICE_PHYSICAL_NETCARD = 0x00000017 -FILE_DEVICE_PRINTER = 0x00000018 -FILE_DEVICE_SCANNER = 0x00000019 -FILE_DEVICE_SERIAL_MOUSE_PORT = 0x0000001a -FILE_DEVICE_SERIAL_PORT = 0x0000001b -FILE_DEVICE_SCREEN = 0x0000001c -FILE_DEVICE_SOUND = 0x0000001d -FILE_DEVICE_STREAMS = 0x0000001e -FILE_DEVICE_TAPE = 0x0000001f -FILE_DEVICE_TAPE_FILE_SYSTEM = 0x00000020 -FILE_DEVICE_TRANSPORT = 0x00000021 -FILE_DEVICE_UNKNOWN = 0x00000022 -FILE_DEVICE_VIDEO = 0x00000023 -FILE_DEVICE_VIRTUAL_DISK = 0x00000024 -FILE_DEVICE_WAVE_IN = 0x00000025 -FILE_DEVICE_WAVE_OUT = 0x00000026 -FILE_DEVICE_8042_PORT = 0x00000027 -FILE_DEVICE_NETWORK_REDIRECTOR = 0x00000028 -FILE_DEVICE_BATTERY = 0x00000029 -FILE_DEVICE_BUS_EXTENDER = 0x0000002a -FILE_DEVICE_MODEM = 0x0000002b -FILE_DEVICE_VDM = 0x0000002c -FILE_DEVICE_MASS_STORAGE = 0x0000002d -FILE_DEVICE_SMB = 0x0000002e -FILE_DEVICE_KS = 0x0000002f -FILE_DEVICE_CHANGER = 0x00000030 -FILE_DEVICE_SMARTCARD = 0x00000031 -FILE_DEVICE_ACPI = 0x00000032 -FILE_DEVICE_DVD = 0x00000033 -FILE_DEVICE_FULLSCREEN_VIDEO = 0x00000034 -FILE_DEVICE_DFS_FILE_SYSTEM = 0x00000035 -FILE_DEVICE_DFS_VOLUME = 0x00000036 -FILE_DEVICE_SERENUM = 0x00000037 -FILE_DEVICE_TERMSRV = 0x00000038 -FILE_DEVICE_KSEC = 0x00000039 -FILE_DEVICE_FIPS = 0x0000003A -FILE_DEVICE_INFINIBAND = 0x0000003B - -METHOD_BUFFERED = 0 -METHOD_IN_DIRECT = 1 -METHOD_OUT_DIRECT = 2 -METHOD_NEITHER = 3 -METHOD_DIRECT_TO_HARDWARE = METHOD_IN_DIRECT -METHOD_DIRECT_FROM_HARDWARE = METHOD_OUT_DIRECT -FILE_ANY_ACCESS = 0 -FILE_SPECIAL_ACCESS = FILE_ANY_ACCESS -FILE_READ_ACCESS = 0x0001 -FILE_WRITE_ACCESS = 0x0002 -IOCTL_STORAGE_BASE = FILE_DEVICE_MASS_STORAGE -RECOVERED_WRITES_VALID = 0x00000001 -UNRECOVERED_WRITES_VALID = 0x00000002 -RECOVERED_READS_VALID = 0x00000004 -UNRECOVERED_READS_VALID = 0x00000008 -WRITE_COMPRESSION_INFO_VALID = 0x00000010 -READ_COMPRESSION_INFO_VALID = 0x00000020 -TAPE_RETURN_STATISTICS = 0 -TAPE_RETURN_ENV_INFO = 1 -TAPE_RESET_STATISTICS = 2 -MEDIA_ERASEABLE = 0x00000001 -MEDIA_WRITE_ONCE = 0x00000002 -MEDIA_READ_ONLY = 0x00000004 -MEDIA_READ_WRITE = 0x00000008 -MEDIA_WRITE_PROTECTED = 0x00000100 -MEDIA_CURRENTLY_MOUNTED = 0x80000000 -IOCTL_DISK_BASE = FILE_DEVICE_DISK -PARTITION_ENTRY_UNUSED = 0x00 -PARTITION_FAT_12 = 0x01 -PARTITION_XENIX_1 = 0x02 -PARTITION_XENIX_2 = 0x03 -PARTITION_FAT_16 = 0x04 -PARTITION_EXTENDED = 0x05 -PARTITION_HUGE = 0x06 -PARTITION_IFS = 0x07 -PARTITION_OS2BOOTMGR = 0x0A -PARTITION_FAT32 = 0x0B -PARTITION_FAT32_XINT13 = 0x0C -PARTITION_XINT13 = 0x0E -PARTITION_XINT13_EXTENDED = 0x0F -PARTITION_PREP = 0x41 -PARTITION_LDM = 0x42 -PARTITION_UNIX = 0x63 -VALID_NTFT = 0xC0 -PARTITION_NTFT = 0x80 - -GPT_ATTRIBUTE_PLATFORM_REQUIRED = 0x0000000000000001 -GPT_BASIC_DATA_ATTRIBUTE_NO_DRIVE_LETTER = 0x8000000000000000 -GPT_BASIC_DATA_ATTRIBUTE_HIDDEN = 0x4000000000000000 -GPT_BASIC_DATA_ATTRIBUTE_SHADOW_COPY = 0x2000000000000000 -GPT_BASIC_DATA_ATTRIBUTE_READ_ONLY = 0x1000000000000000 - -HIST_NO_OF_BUCKETS = 24 -DISK_LOGGING_START = 0 -DISK_LOGGING_STOP = 1 -DISK_LOGGING_DUMP = 2 -DISK_BINNING = 3 -CAP_ATA_ID_CMD = 1 -CAP_ATAPI_ID_CMD = 2 -CAP_SMART_CMD = 4 -ATAPI_ID_CMD = 0xA1 -ID_CMD = 0xEC -SMART_CMD = 0xB0 -SMART_CYL_LOW = 0x4F -SMART_CYL_HI = 0xC2 -SMART_NO_ERROR = 0 -SMART_IDE_ERROR = 1 -SMART_INVALID_FLAG = 2 -SMART_INVALID_COMMAND = 3 -SMART_INVALID_BUFFER = 4 -SMART_INVALID_DRIVE = 5 -SMART_INVALID_IOCTL = 6 -SMART_ERROR_NO_MEM = 7 -SMART_INVALID_REGISTER = 8 -SMART_NOT_SUPPORTED = 9 -SMART_NO_IDE_DEVICE = 10 -SMART_OFFLINE_ROUTINE_OFFLINE = 0 -SMART_SHORT_SELFTEST_OFFLINE = 1 -SMART_EXTENDED_SELFTEST_OFFLINE = 2 -SMART_ABORT_OFFLINE_SELFTEST = 127 -SMART_SHORT_SELFTEST_CAPTIVE = 129 -SMART_EXTENDED_SELFTEST_CAPTIVE = 130 -READ_ATTRIBUTE_BUFFER_SIZE = 512 -IDENTIFY_BUFFER_SIZE = 512 -READ_THRESHOLD_BUFFER_SIZE = 512 -SMART_LOG_SECTOR_SIZE = 512 -READ_ATTRIBUTES = 0xD0 -READ_THRESHOLDS = 0xD1 -ENABLE_DISABLE_AUTOSAVE = 0xD2 -SAVE_ATTRIBUTE_VALUES = 0xD3 -EXECUTE_OFFLINE_DIAGS = 0xD4 -SMART_READ_LOG = 0xD5 -SMART_WRITE_LOG = 0xd6 -ENABLE_SMART = 0xD8 -DISABLE_SMART = 0xD9 -RETURN_SMART_STATUS = 0xDA -ENABLE_DISABLE_AUTO_OFFLINE = 0xDB -IOCTL_CHANGER_BASE = FILE_DEVICE_CHANGER -MAX_VOLUME_ID_SIZE = 36 -MAX_VOLUME_TEMPLATE_SIZE = 40 -VENDOR_ID_LENGTH = 8 -PRODUCT_ID_LENGTH = 16 -REVISION_LENGTH = 4 -SERIAL_NUMBER_LENGTH = 32 -CHANGER_BAR_CODE_SCANNER_INSTALLED = 0x00000001 -CHANGER_INIT_ELEM_STAT_WITH_RANGE = 0x00000002 -CHANGER_CLOSE_IEPORT = 0x00000004 -CHANGER_OPEN_IEPORT = 0x00000008 -CHANGER_STATUS_NON_VOLATILE = 0x00000010 -CHANGER_EXCHANGE_MEDIA = 0x00000020 -CHANGER_CLEANER_SLOT = 0x00000040 -CHANGER_LOCK_UNLOCK = 0x00000080 -CHANGER_CARTRIDGE_MAGAZINE = 0x00000100 -CHANGER_MEDIUM_FLIP = 0x00000200 -CHANGER_POSITION_TO_ELEMENT = 0x00000400 -CHANGER_REPORT_IEPORT_STATE = 0x00000800 -CHANGER_STORAGE_DRIVE = 0x00001000 -CHANGER_STORAGE_IEPORT = 0x00002000 -CHANGER_STORAGE_SLOT = 0x00004000 -CHANGER_STORAGE_TRANSPORT = 0x00008000 -CHANGER_DRIVE_CLEANING_REQUIRED = 0x00010000 -CHANGER_PREDISMOUNT_EJECT_REQUIRED = 0x00020000 -CHANGER_CLEANER_ACCESS_NOT_VALID = 0x00040000 -CHANGER_PREMOUNT_EJECT_REQUIRED = 0x00080000 -CHANGER_VOLUME_IDENTIFICATION = 0x00100000 -CHANGER_VOLUME_SEARCH = 0x00200000 -CHANGER_VOLUME_ASSERT = 0x00400000 -CHANGER_VOLUME_REPLACE = 0x00800000 -CHANGER_VOLUME_UNDEFINE = 0x01000000 -CHANGER_SERIAL_NUMBER_VALID = 0x04000000 -CHANGER_DEVICE_REINITIALIZE_CAPABLE = 0x08000000 -CHANGER_KEYPAD_ENABLE_DISABLE = 0x10000000 -CHANGER_DRIVE_EMPTY_ON_DOOR_ACCESS = 0x20000000 - -CHANGER_RESERVED_BIT = 0x80000000 -CHANGER_PREDISMOUNT_ALIGN_TO_SLOT = 0x80000001 -CHANGER_PREDISMOUNT_ALIGN_TO_DRIVE = 0x80000002 -CHANGER_CLEANER_AUTODISMOUNT = 0x80000004 -CHANGER_TRUE_EXCHANGE_CAPABLE = 0x80000008 -CHANGER_SLOTS_USE_TRAYS = 0x80000010 -CHANGER_RTN_MEDIA_TO_ORIGINAL_ADDR = 0x80000020 -CHANGER_CLEANER_OPS_NOT_SUPPORTED = 0x80000040 -CHANGER_IEPORT_USER_CONTROL_OPEN = 0x80000080 -CHANGER_IEPORT_USER_CONTROL_CLOSE = 0x80000100 -CHANGER_MOVE_EXTENDS_IEPORT = 0x80000200 -CHANGER_MOVE_RETRACTS_IEPORT = 0x80000400 - - -CHANGER_TO_TRANSPORT = 0x01 -CHANGER_TO_SLOT = 0x02 -CHANGER_TO_IEPORT = 0x04 -CHANGER_TO_DRIVE = 0x08 -LOCK_UNLOCK_IEPORT = 0x01 -LOCK_UNLOCK_DOOR = 0x02 -LOCK_UNLOCK_KEYPAD = 0x04 -LOCK_ELEMENT = 0 -UNLOCK_ELEMENT = 1 -EXTEND_IEPORT = 2 -RETRACT_IEPORT = 3 -ELEMENT_STATUS_FULL = 0x00000001 -ELEMENT_STATUS_IMPEXP = 0x00000002 -ELEMENT_STATUS_EXCEPT = 0x00000004 -ELEMENT_STATUS_ACCESS = 0x00000008 -ELEMENT_STATUS_EXENAB = 0x00000010 -ELEMENT_STATUS_INENAB = 0x00000020 -ELEMENT_STATUS_PRODUCT_DATA = 0x00000040 -ELEMENT_STATUS_LUN_VALID = 0x00001000 -ELEMENT_STATUS_ID_VALID = 0x00002000 -ELEMENT_STATUS_NOT_BUS = 0x00008000 -ELEMENT_STATUS_INVERT = 0x00400000 -ELEMENT_STATUS_SVALID = 0x00800000 -ELEMENT_STATUS_PVOLTAG = 0x10000000 -ELEMENT_STATUS_AVOLTAG = 0x20000000 -ERROR_LABEL_UNREADABLE = 0x00000001 -ERROR_LABEL_QUESTIONABLE = 0x00000002 -ERROR_SLOT_NOT_PRESENT = 0x00000004 -ERROR_DRIVE_NOT_INSTALLED = 0x00000008 -ERROR_TRAY_MALFUNCTION = 0x00000010 -ERROR_INIT_STATUS_NEEDED = 0x00000011 -ERROR_UNHANDLED_ERROR = 0xFFFFFFFF -SEARCH_ALL = 0x0 -SEARCH_PRIMARY = 0x1 -SEARCH_ALTERNATE = 0x2 -SEARCH_ALL_NO_SEQ = 0x4 -SEARCH_PRI_NO_SEQ = 0x5 -SEARCH_ALT_NO_SEQ = 0x6 -ASSERT_PRIMARY = 0x8 -ASSERT_ALTERNATE = 0x9 -REPLACE_PRIMARY = 0xA -REPLACE_ALTERNATE = 0xB -UNDEFINE_PRIMARY = 0xC -UNDEFINE_ALTERNATE = 0xD -USN_PAGE_SIZE = 0x1000 -USN_REASON_DATA_OVERWRITE = 0x00000001 -USN_REASON_DATA_EXTEND = 0x00000002 -USN_REASON_DATA_TRUNCATION = 0x00000004 -USN_REASON_NAMED_DATA_OVERWRITE = 0x00000010 -USN_REASON_NAMED_DATA_EXTEND = 0x00000020 -USN_REASON_NAMED_DATA_TRUNCATION = 0x00000040 -USN_REASON_FILE_CREATE = 0x00000100 -USN_REASON_FILE_DELETE = 0x00000200 -USN_REASON_EA_CHANGE = 0x00000400 -USN_REASON_SECURITY_CHANGE = 0x00000800 -USN_REASON_RENAME_OLD_NAME = 0x00001000 -USN_REASON_RENAME_NEW_NAME = 0x00002000 -USN_REASON_INDEXABLE_CHANGE = 0x00004000 -USN_REASON_BASIC_INFO_CHANGE = 0x00008000 -USN_REASON_HARD_LINK_CHANGE = 0x00010000 -USN_REASON_COMPRESSION_CHANGE = 0x00020000 -USN_REASON_ENCRYPTION_CHANGE = 0x00040000 -USN_REASON_OBJECT_ID_CHANGE = 0x00080000 -USN_REASON_REPARSE_POINT_CHANGE = 0x00100000 -USN_REASON_STREAM_CHANGE = 0x00200000 -USN_REASON_TRANSACTED_CHANGE = 0x00400000 -USN_REASON_CLOSE = 0x80000000 -USN_DELETE_FLAG_DELETE = 0x00000001 -USN_DELETE_FLAG_NOTIFY = 0x00000002 -USN_DELETE_VALID_FLAGS = 0x00000003 -USN_SOURCE_DATA_MANAGEMENT = 0x00000001 -USN_SOURCE_AUXILIARY_DATA = 0x00000002 -USN_SOURCE_REPLICATION_MANAGEMENT = 0x00000004 - -MARK_HANDLE_PROTECT_CLUSTERS = 1 -MARK_HANDLE_TXF_SYSTEM_LOG = 4 -MARK_HANDLE_NOT_TXF_SYSTEM_LOG = 8 - -VOLUME_IS_DIRTY = 0x00000001 -VOLUME_UPGRADE_SCHEDULED = 0x00000002 -VOLUME_SESSION_OPEN = 4 - -FILE_PREFETCH_TYPE_FOR_CREATE = 1 -FILE_PREFETCH_TYPE_FOR_DIRENUM = 2 -FILE_PREFETCH_TYPE_FOR_CREATE_EX = 3 -FILE_PREFETCH_TYPE_FOR_DIRENUM_EX = 4 -FILE_PREFETCH_TYPE_MAX = 4 - -FILESYSTEM_STATISTICS_TYPE_NTFS = 1 -FILESYSTEM_STATISTICS_TYPE_FAT = 2 -FILE_SET_ENCRYPTION = 0x00000001 -FILE_CLEAR_ENCRYPTION = 0x00000002 -STREAM_SET_ENCRYPTION = 0x00000003 -STREAM_CLEAR_ENCRYPTION = 0x00000004 -MAXIMUM_ENCRYPTION_VALUE = 0x00000004 -ENCRYPTION_FORMAT_DEFAULT = 0x01 -COMPRESSION_FORMAT_SPARSE = 0x4000 -COPYFILE_SIS_LINK = 0x0001 -COPYFILE_SIS_REPLACE = 0x0002 -COPYFILE_SIS_FLAGS = 0x0003 - -WMI_DISK_GEOMETRY_GUID = pywintypes.IID("{25007F51-57C2-11D1-A528-00A0C9062910}") -GUID_DEVINTERFACE_CDROM = pywintypes.IID("{53F56308-B6BF-11D0-94F2-00A0C91EFB8B}") -GUID_DEVINTERFACE_FLOPPY = pywintypes.IID("{53F56311-B6BF-11D0-94F2-00A0C91EFB8B}") -GUID_DEVINTERFACE_SERENUM_BUS_ENUMERATOR = pywintypes.IID("{4D36E978-E325-11CE-BFC1-08002BE10318}") -GUID_DEVINTERFACE_COMPORT = pywintypes.IID("{86E0D1E0-8089-11D0-9CE4-08003E301F73}") -GUID_DEVINTERFACE_DISK = pywintypes.IID("{53F56307-B6BF-11D0-94F2-00A0C91EFB8B}") -GUID_DEVINTERFACE_STORAGEPORT = pywintypes.IID("{2ACCFE60-C130-11D2-B082-00A0C91EFB8B}") -GUID_DEVINTERFACE_CDCHANGER = pywintypes.IID("{53F56312-B6BF-11D0-94F2-00A0C91EFB8B}") -GUID_DEVINTERFACE_PARTITION = pywintypes.IID("{53F5630A-B6BF-11D0-94F2-00A0C91EFB8B}") -GUID_DEVINTERFACE_VOLUME = pywintypes.IID("{53F5630D-B6BF-11D0-94F2-00A0C91EFB8B}") -GUID_DEVINTERFACE_WRITEONCEDISK = pywintypes.IID("{53F5630C-B6BF-11D0-94F2-00A0C91EFB8B}") -GUID_DEVINTERFACE_TAPE = pywintypes.IID("{53F5630B-B6BF-11D0-94F2-00A0C91EFB8B}") -GUID_DEVINTERFACE_MEDIUMCHANGER = pywintypes.IID("{53F56310-B6BF-11D0-94F2-00A0C91EFB8B}") -GUID_SERENUM_BUS_ENUMERATOR = GUID_DEVINTERFACE_SERENUM_BUS_ENUMERATOR -GUID_CLASS_COMPORT = GUID_DEVINTERFACE_COMPORT - -DiskClassGuid = GUID_DEVINTERFACE_DISK -CdRomClassGuid = GUID_DEVINTERFACE_CDROM -PartitionClassGuid = GUID_DEVINTERFACE_PARTITION -TapeClassGuid = GUID_DEVINTERFACE_TAPE -WriteOnceDiskClassGuid = GUID_DEVINTERFACE_WRITEONCEDISK -VolumeClassGuid = GUID_DEVINTERFACE_VOLUME -MediumChangerClassGuid = GUID_DEVINTERFACE_MEDIUMCHANGER -FloppyClassGuid = GUID_DEVINTERFACE_FLOPPY -CdChangerClassGuid = GUID_DEVINTERFACE_CDCHANGER -StoragePortClassGuid = GUID_DEVINTERFACE_STORAGEPORT - - -IOCTL_STORAGE_CHECK_VERIFY = CTL_CODE(IOCTL_STORAGE_BASE, 0x0200, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_STORAGE_CHECK_VERIFY2 = CTL_CODE(IOCTL_STORAGE_BASE, 0x0200, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_STORAGE_MEDIA_REMOVAL = CTL_CODE(IOCTL_STORAGE_BASE, 0x0201, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_STORAGE_EJECT_MEDIA = CTL_CODE(IOCTL_STORAGE_BASE, 0x0202, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_STORAGE_LOAD_MEDIA = CTL_CODE(IOCTL_STORAGE_BASE, 0x0203, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_STORAGE_LOAD_MEDIA2 = CTL_CODE(IOCTL_STORAGE_BASE, 0x0203, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_STORAGE_RESERVE = CTL_CODE(IOCTL_STORAGE_BASE, 0x0204, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_STORAGE_RELEASE = CTL_CODE(IOCTL_STORAGE_BASE, 0x0205, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_STORAGE_FIND_NEW_DEVICES = CTL_CODE(IOCTL_STORAGE_BASE, 0x0206, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_STORAGE_EJECTION_CONTROL = CTL_CODE(IOCTL_STORAGE_BASE, 0x0250, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_STORAGE_MCN_CONTROL = CTL_CODE(IOCTL_STORAGE_BASE, 0x0251, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_STORAGE_GET_MEDIA_TYPES = CTL_CODE(IOCTL_STORAGE_BASE, 0x0300, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_STORAGE_GET_MEDIA_TYPES_EX = CTL_CODE(IOCTL_STORAGE_BASE, 0x0301, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_STORAGE_GET_MEDIA_SERIAL_NUMBER = CTL_CODE(IOCTL_STORAGE_BASE, 0x0304, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_STORAGE_GET_HOTPLUG_INFO = CTL_CODE(IOCTL_STORAGE_BASE, 0x0305, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_STORAGE_SET_HOTPLUG_INFO = CTL_CODE(IOCTL_STORAGE_BASE, 0x0306, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_STORAGE_RESET_BUS = CTL_CODE(IOCTL_STORAGE_BASE, 0x0400, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_STORAGE_RESET_DEVICE = CTL_CODE(IOCTL_STORAGE_BASE, 0x0401, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_STORAGE_BREAK_RESERVATION = CTL_CODE(IOCTL_STORAGE_BASE, 0x0405, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_STORAGE_GET_DEVICE_NUMBER = CTL_CODE(IOCTL_STORAGE_BASE, 0x0420, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_STORAGE_PREDICT_FAILURE = CTL_CODE(IOCTL_STORAGE_BASE, 0x0440, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_GET_DRIVE_GEOMETRY = CTL_CODE(IOCTL_DISK_BASE, 0x0000, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_GET_PARTITION_INFO = CTL_CODE(IOCTL_DISK_BASE, 0x0001, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_DISK_SET_PARTITION_INFO = CTL_CODE(IOCTL_DISK_BASE, 0x0002, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_DISK_GET_DRIVE_LAYOUT = CTL_CODE(IOCTL_DISK_BASE, 0x0003, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_DISK_SET_DRIVE_LAYOUT = CTL_CODE(IOCTL_DISK_BASE, 0x0004, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_DISK_VERIFY = CTL_CODE(IOCTL_DISK_BASE, 0x0005, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_FORMAT_TRACKS = CTL_CODE(IOCTL_DISK_BASE, 0x0006, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_DISK_REASSIGN_BLOCKS = CTL_CODE(IOCTL_DISK_BASE, 0x0007, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_DISK_PERFORMANCE = CTL_CODE(IOCTL_DISK_BASE, 0x0008, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_IS_WRITABLE = CTL_CODE(IOCTL_DISK_BASE, 0x0009, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_LOGGING = CTL_CODE(IOCTL_DISK_BASE, 0x000a, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_FORMAT_TRACKS_EX = CTL_CODE(IOCTL_DISK_BASE, 0x000b, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_DISK_HISTOGRAM_STRUCTURE = CTL_CODE(IOCTL_DISK_BASE, 0x000c, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_HISTOGRAM_DATA = CTL_CODE(IOCTL_DISK_BASE, 0x000d, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_HISTOGRAM_RESET = CTL_CODE(IOCTL_DISK_BASE, 0x000e, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_REQUEST_STRUCTURE = CTL_CODE(IOCTL_DISK_BASE, 0x000f, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_REQUEST_DATA = CTL_CODE(IOCTL_DISK_BASE, 0x0010, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_PERFORMANCE_OFF = CTL_CODE(IOCTL_DISK_BASE, 0x0018, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_CONTROLLER_NUMBER = CTL_CODE(IOCTL_DISK_BASE, 0x0011, METHOD_BUFFERED, FILE_ANY_ACCESS) -SMART_GET_VERSION = CTL_CODE(IOCTL_DISK_BASE, 0x0020, METHOD_BUFFERED, FILE_READ_ACCESS) -SMART_SEND_DRIVE_COMMAND = CTL_CODE(IOCTL_DISK_BASE, 0x0021, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -SMART_RCV_DRIVE_DATA = CTL_CODE(IOCTL_DISK_BASE, 0x0022, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_DISK_GET_PARTITION_INFO_EX = CTL_CODE(IOCTL_DISK_BASE, 0x0012, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_SET_PARTITION_INFO_EX = CTL_CODE(IOCTL_DISK_BASE, 0x0013, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_DISK_GET_DRIVE_LAYOUT_EX = CTL_CODE(IOCTL_DISK_BASE, 0x0014, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_SET_DRIVE_LAYOUT_EX = CTL_CODE(IOCTL_DISK_BASE, 0x0015, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_DISK_CREATE_DISK = CTL_CODE(IOCTL_DISK_BASE, 0x0016, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_DISK_GET_LENGTH_INFO = CTL_CODE(IOCTL_DISK_BASE, 0x0017, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_DISK_GET_DRIVE_GEOMETRY_EX = CTL_CODE(IOCTL_DISK_BASE, 0x0028, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_REASSIGN_BLOCKS_EX = CTL_CODE(IOCTL_DISK_BASE, 0x0029, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) - -IOCTL_DISK_UPDATE_DRIVE_SIZE = CTL_CODE(IOCTL_DISK_BASE, 0x0032, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_DISK_GROW_PARTITION = CTL_CODE(IOCTL_DISK_BASE, 0x0034, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_DISK_GET_CACHE_INFORMATION = CTL_CODE(IOCTL_DISK_BASE, 0x0035, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_DISK_SET_CACHE_INFORMATION = CTL_CODE(IOCTL_DISK_BASE, 0x0036, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) - -OBSOLETE_IOCTL_STORAGE_RESET_BUS = CTL_CODE(IOCTL_STORAGE_BASE, 0x0400, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -OBSOLETE_IOCTL_STORAGE_RESET_DEVICE = CTL_CODE(IOCTL_STORAGE_BASE, 0x0401, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -## the original define no longer exists in winioctl.h -OBSOLETE_DISK_GET_WRITE_CACHE_STATE = CTL_CODE(IOCTL_DISK_BASE, 0x0037, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_DISK_GET_WRITE_CACHE_STATE=OBSOLETE_DISK_GET_WRITE_CACHE_STATE - - -IOCTL_DISK_DELETE_DRIVE_LAYOUT = CTL_CODE(IOCTL_DISK_BASE, 0x0040, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_DISK_UPDATE_PROPERTIES = CTL_CODE(IOCTL_DISK_BASE, 0x0050, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_FORMAT_DRIVE = CTL_CODE(IOCTL_DISK_BASE, 0x00f3, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_DISK_SENSE_DEVICE = CTL_CODE(IOCTL_DISK_BASE, 0x00f8, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_CHECK_VERIFY = CTL_CODE(IOCTL_DISK_BASE, 0x0200, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_DISK_MEDIA_REMOVAL = CTL_CODE(IOCTL_DISK_BASE, 0x0201, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_DISK_EJECT_MEDIA = CTL_CODE(IOCTL_DISK_BASE, 0x0202, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_DISK_LOAD_MEDIA = CTL_CODE(IOCTL_DISK_BASE, 0x0203, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_DISK_RESERVE = CTL_CODE(IOCTL_DISK_BASE, 0x0204, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_DISK_RELEASE = CTL_CODE(IOCTL_DISK_BASE, 0x0205, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_DISK_FIND_NEW_DEVICES = CTL_CODE(IOCTL_DISK_BASE, 0x0206, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_DISK_GET_MEDIA_TYPES = CTL_CODE(IOCTL_DISK_BASE, 0x0300, METHOD_BUFFERED, FILE_ANY_ACCESS) - -DISK_HISTOGRAM_SIZE = 72 -HISTOGRAM_BUCKET_SIZE = 8 - -IOCTL_CHANGER_GET_PARAMETERS = CTL_CODE(IOCTL_CHANGER_BASE, 0x0000, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_CHANGER_GET_STATUS = CTL_CODE(IOCTL_CHANGER_BASE, 0x0001, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_CHANGER_GET_PRODUCT_DATA = CTL_CODE(IOCTL_CHANGER_BASE, 0x0002, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_CHANGER_SET_ACCESS = CTL_CODE(IOCTL_CHANGER_BASE, 0x0004, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_CHANGER_GET_ELEMENT_STATUS = CTL_CODE(IOCTL_CHANGER_BASE, 0x0005, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_CHANGER_INITIALIZE_ELEMENT_STATUS = CTL_CODE(IOCTL_CHANGER_BASE, 0x0006, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_CHANGER_SET_POSITION = CTL_CODE(IOCTL_CHANGER_BASE, 0x0007, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_CHANGER_EXCHANGE_MEDIUM = CTL_CODE(IOCTL_CHANGER_BASE, 0x0008, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_CHANGER_MOVE_MEDIUM = CTL_CODE(IOCTL_CHANGER_BASE, 0x0009, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_CHANGER_REINITIALIZE_TRANSPORT = CTL_CODE(IOCTL_CHANGER_BASE, 0x000A, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_CHANGER_QUERY_VOLUME_TAGS = CTL_CODE(IOCTL_CHANGER_BASE, 0x000B, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_SERIAL_LSRMST_INSERT = CTL_CODE(FILE_DEVICE_SERIAL_PORT,31,METHOD_BUFFERED,FILE_ANY_ACCESS) -IOCTL_SERENUM_EXPOSE_HARDWARE = CTL_CODE(FILE_DEVICE_SERENUM,128,METHOD_BUFFERED,FILE_ANY_ACCESS) -IOCTL_SERENUM_REMOVE_HARDWARE = CTL_CODE(FILE_DEVICE_SERENUM,129,METHOD_BUFFERED,FILE_ANY_ACCESS) -IOCTL_SERENUM_PORT_DESC = CTL_CODE(FILE_DEVICE_SERENUM,130,METHOD_BUFFERED,FILE_ANY_ACCESS) -IOCTL_SERENUM_GET_PORT_NAME = CTL_CODE(FILE_DEVICE_SERENUM,131,METHOD_BUFFERED,FILE_ANY_ACCESS) - -## ??? can't find where FILE_DEVICE_AVIO is defined ??? -## IOCTL_AVIO_ALLOCATE_STREAM = CTL_CODE(FILE_DEVICE_AVIO, 1, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -## IOCTL_AVIO_FREE_STREAM = CTL_CODE(FILE_DEVICE_AVIO, 2, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -## IOCTL_AVIO_MODIFY_STREAM = CTL_CODE(FILE_DEVICE_AVIO, 3, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) - -SERIAL_LSRMST_ESCAPE = 0x00 -SERIAL_LSRMST_LSR_DATA = 0x01 -SERIAL_LSRMST_LSR_NODATA = 0x02 -SERIAL_LSRMST_MST = 0x03 -SERIAL_IOC_FCR_FIFO_ENABLE = 0x00000001 -SERIAL_IOC_FCR_RCVR_RESET = 0x00000002 -SERIAL_IOC_FCR_XMIT_RESET = 0x00000004 -SERIAL_IOC_FCR_DMA_MODE = 0x00000008 -SERIAL_IOC_FCR_RES1 = 0x00000010 -SERIAL_IOC_FCR_RES2 = 0x00000020 -SERIAL_IOC_FCR_RCVR_TRIGGER_LSB = 0x00000040 -SERIAL_IOC_FCR_RCVR_TRIGGER_MSB = 0x00000080 -SERIAL_IOC_MCR_DTR = 0x00000001 -SERIAL_IOC_MCR_RTS = 0x00000002 -SERIAL_IOC_MCR_OUT1 = 0x00000004 -SERIAL_IOC_MCR_OUT2 = 0x00000008 -SERIAL_IOC_MCR_LOOP = 0x00000010 -FSCTL_REQUEST_OPLOCK_LEVEL_1 = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 0, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_REQUEST_OPLOCK_LEVEL_2 = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 1, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_REQUEST_BATCH_OPLOCK = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 2, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_OPLOCK_BREAK_ACKNOWLEDGE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 3, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_OPBATCH_ACK_CLOSE_PENDING = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 4, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_OPLOCK_BREAK_NOTIFY = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 5, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_LOCK_VOLUME = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 6, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_UNLOCK_VOLUME = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 7, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_DISMOUNT_VOLUME = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 8, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_IS_VOLUME_MOUNTED = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 10, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_IS_PATHNAME_VALID = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 11, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_MARK_VOLUME_DIRTY = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 12, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_QUERY_RETRIEVAL_POINTERS = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 14, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_GET_COMPRESSION = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 15, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_SET_COMPRESSION = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 16, METHOD_BUFFERED, FILE_READ_DATA | FILE_WRITE_DATA) -FSCTL_MARK_AS_SYSTEM_HIVE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 19, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_OPLOCK_BREAK_ACK_NO_2 = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 20, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_INVALIDATE_VOLUMES = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 21, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_QUERY_FAT_BPB = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 22, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_REQUEST_FILTER_OPLOCK = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 23, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_FILESYSTEM_GET_STATISTICS = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 24, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_GET_NTFS_VOLUME_DATA = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 25, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_GET_NTFS_FILE_RECORD = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 26, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_GET_VOLUME_BITMAP = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 27, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_GET_RETRIEVAL_POINTERS = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 28, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_MOVE_FILE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 29, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -FSCTL_IS_VOLUME_DIRTY = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 30, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_ALLOW_EXTENDED_DASD_IO = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 32, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_FIND_FILES_BY_SID = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 35, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_SET_OBJECT_ID = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 38, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -FSCTL_GET_OBJECT_ID = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 39, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_DELETE_OBJECT_ID = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 40, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -FSCTL_SET_REPARSE_POINT = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 41, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -FSCTL_GET_REPARSE_POINT = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 42, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_DELETE_REPARSE_POINT = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 43, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -FSCTL_ENUM_USN_DATA = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 44, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_SECURITY_ID_CHECK = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 45, METHOD_NEITHER, FILE_READ_DATA) -FSCTL_READ_USN_JOURNAL = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 46, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_SET_OBJECT_ID_EXTENDED = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 47, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -FSCTL_CREATE_OR_GET_OBJECT_ID = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 48, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_SET_SPARSE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 49, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -FSCTL_SET_ZERO_DATA = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 50, METHOD_BUFFERED, FILE_WRITE_DATA) -FSCTL_QUERY_ALLOCATED_RANGES = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 51, METHOD_NEITHER, FILE_READ_DATA) -FSCTL_SET_ENCRYPTION = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 53, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_ENCRYPTION_FSCTL_IO = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 54, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_WRITE_RAW_ENCRYPTED = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 55, METHOD_NEITHER, FILE_SPECIAL_ACCESS) -FSCTL_READ_RAW_ENCRYPTED = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 56, METHOD_NEITHER, FILE_SPECIAL_ACCESS) -FSCTL_CREATE_USN_JOURNAL = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 57, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_READ_FILE_USN_DATA = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 58, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_WRITE_USN_CLOSE_RECORD = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 59, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_EXTEND_VOLUME = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 60, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_QUERY_USN_JOURNAL = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 61, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_DELETE_USN_JOURNAL = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 62, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_MARK_HANDLE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 63, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_SIS_COPYFILE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 64, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_SIS_LINK_FILES = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 65, METHOD_BUFFERED, FILE_READ_DATA | FILE_WRITE_DATA) -FSCTL_HSM_MSG = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 66, METHOD_BUFFERED, FILE_READ_DATA | FILE_WRITE_DATA) -FSCTL_HSM_DATA = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 68, METHOD_NEITHER, FILE_READ_DATA | FILE_WRITE_DATA) -FSCTL_RECALL_FILE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 69, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_READ_FROM_PLEX = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 71, METHOD_OUT_DIRECT, FILE_READ_DATA) -FSCTL_FILE_PREFETCH = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 72, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -FSCTL_MAKE_MEDIA_COMPATIBLE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 76, METHOD_BUFFERED, FILE_WRITE_DATA) -FSCTL_SET_DEFECT_MANAGEMENT = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 77, METHOD_BUFFERED, FILE_WRITE_DATA) -FSCTL_QUERY_SPARING_INFO = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 78, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_QUERY_ON_DISK_VOLUME_INFO = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 79, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_SET_VOLUME_COMPRESSION_STATE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 80, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -FSCTL_TXFS_MODIFY_RM = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 81, METHOD_BUFFERED, FILE_WRITE_DATA) -FSCTL_TXFS_QUERY_RM_INFORMATION = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 82, METHOD_BUFFERED, FILE_READ_DATA) -FSCTL_TXFS_ROLLFORWARD_REDO = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 84, METHOD_BUFFERED, FILE_WRITE_DATA) -FSCTL_TXFS_ROLLFORWARD_UNDO = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 85, METHOD_BUFFERED, FILE_WRITE_DATA) -FSCTL_TXFS_START_RM = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 86, METHOD_BUFFERED, FILE_WRITE_DATA) -FSCTL_TXFS_SHUTDOWN_RM = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 87, METHOD_BUFFERED, FILE_WRITE_DATA) -FSCTL_TXFS_READ_BACKUP_INFORMATION = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 88, METHOD_BUFFERED, FILE_READ_DATA) -FSCTL_TXFS_WRITE_BACKUP_INFORMATION = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 89, METHOD_BUFFERED, FILE_WRITE_DATA) -FSCTL_TXFS_CREATE_SECONDARY_RM = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 90, METHOD_BUFFERED, FILE_WRITE_DATA) -FSCTL_TXFS_GET_METADATA_INFO = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 91, METHOD_BUFFERED, FILE_READ_DATA) -FSCTL_TXFS_GET_TRANSACTED_VERSION = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 92, METHOD_BUFFERED, FILE_READ_DATA) -FSCTL_TXFS_CREATE_MINIVERSION = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 95, METHOD_BUFFERED, FILE_WRITE_DATA) -FSCTL_TXFS_TRANSACTION_ACTIVE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 99, METHOD_BUFFERED, FILE_READ_DATA) -FSCTL_SET_ZERO_ON_DEALLOCATION = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 101, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -FSCTL_SET_REPAIR = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 102, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_GET_REPAIR = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 103, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_WAIT_FOR_REPAIR = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 104, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_INITIATE_REPAIR = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 106, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_CSC_INTERNAL = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 107, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_SHRINK_VOLUME = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 108, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -FSCTL_SET_SHORT_NAME_BEHAVIOR = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 109, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_DFSR_SET_GHOST_HANDLE_STATE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 110, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_TXFS_LIST_TRANSACTION_LOCKED_FILES = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 120, METHOD_BUFFERED, FILE_READ_DATA) -FSCTL_TXFS_LIST_TRANSACTIONS = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 121, METHOD_BUFFERED, FILE_READ_DATA) -FSCTL_QUERY_PAGEFILE_ENCRYPTION = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 122, METHOD_BUFFERED, FILE_ANY_ACCESS) - -IOCTL_VOLUME_BASE = ord('V') -IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS = CTL_CODE(IOCTL_VOLUME_BASE, 0, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_VOLUME_ONLINE = CTL_CODE(IOCTL_VOLUME_BASE, 2, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_VOLUME_OFFLINE = CTL_CODE(IOCTL_VOLUME_BASE, 3, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_VOLUME_IS_CLUSTERED = CTL_CODE(IOCTL_VOLUME_BASE, 12, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_VOLUME_GET_GPT_ATTRIBUTES = CTL_CODE(IOCTL_VOLUME_BASE, 14, METHOD_BUFFERED, FILE_ANY_ACCESS) - -## enums -## STORAGE_MEDIA_TYPE -DDS_4mm = 32 -MiniQic = 33 -Travan = 34 -QIC = 35 -MP_8mm = 36 -AME_8mm = 37 -AIT1_8mm = 38 -DLT = 39 -NCTP = 40 -IBM_3480 = 41 -IBM_3490E = 42 -IBM_Magstar_3590 = 43 -IBM_Magstar_MP = 44 -STK_DATA_D3 = 45 -SONY_DTF = 46 -DV_6mm = 47 -DMI = 48 -SONY_D2 = 49 -CLEANER_CARTRIDGE = 50 -CD_ROM = 51 -CD_R = 52 -CD_RW = 53 -DVD_ROM = 54 -DVD_R = 55 -DVD_RW = 56 -MO_3_RW = 57 -MO_5_WO = 58 -MO_5_RW = 59 -MO_5_LIMDOW = 60 -PC_5_WO = 61 -PC_5_RW = 62 -PD_5_RW = 63 -ABL_5_WO = 64 -PINNACLE_APEX_5_RW = 65 -SONY_12_WO = 66 -PHILIPS_12_WO = 67 -HITACHI_12_WO = 68 -CYGNET_12_WO = 69 -KODAK_14_WO = 70 -MO_NFR_525 = 71 -NIKON_12_RW = 72 -IOMEGA_ZIP = 73 -IOMEGA_JAZ = 74 -SYQUEST_EZ135 = 75 -SYQUEST_EZFLYER = 76 -SYQUEST_SYJET = 77 -AVATAR_F2 = 78 -MP2_8mm = 79 -DST_S = 80 -DST_M = 81 -DST_L = 82 -VXATape_1 = 83 -VXATape_2 = 84 -STK_9840 = 85 -LTO_Ultrium = 86 -LTO_Accelis = 87 -DVD_RAM = 88 -AIT_8mm = 89 -ADR_1 = 90 -ADR_2 = 91 -STK_9940 = 92 - -## STORAGE_BUS_TYPE -BusTypeUnknown = 0 -BusTypeScsi = 1 -BusTypeAtapi = 2 -BusTypeAta = 3 -BusType1394 = 4 -BusTypeSsa = 5 -BusTypeFibre = 6 -BusTypeUsb = 7 -BusTypeRAID = 8 -BusTypeiScsi = 9 -BusTypeSas = 10 -BusTypeSata = 11 -BusTypeMaxReserved = 127 - -## MEDIA_TYPE -Unknown = 0 -F5_1Pt2_512 = 1 -F3_1Pt44_512 = 2 -F3_2Pt88_512 = 3 -F3_20Pt8_512 = 4 -F3_720_512 = 5 -F5_360_512 = 6 -F5_320_512 = 7 -F5_320_1024 = 8 -F5_180_512 = 9 -F5_160_512 = 10 -RemovableMedia = 11 -FixedMedia = 12 -F3_120M_512 = 13 -F3_640_512 = 14 -F5_640_512 = 15 -F5_720_512 = 16 -F3_1Pt2_512 = 17 -F3_1Pt23_1024 = 18 -F5_1Pt23_1024 = 19 -F3_128Mb_512 = 20 -F3_230Mb_512 = 21 -F8_256_128 = 22 -F3_200Mb_512 = 23 -F3_240M_512 = 24 -F3_32M_512 = 25 - -## PARTITION_STYLE -PARTITION_STYLE_MBR = 0 -PARTITION_STYLE_GPT = 1 -PARTITION_STYLE_RAW = 2 - -## DETECTION_TYPE -DetectNone = 0 -DetectInt13 = 1 -DetectExInt13 = 2 - -## DISK_CACHE_RETENTION_PRIORITY -EqualPriority = 0 -KeepPrefetchedData = 1 -KeepReadData = 2 - -## DISK_WRITE_CACHE_STATE - ?????? this enum has disappeared from winioctl.h in windows 2003 SP1 sdk ?????? -DiskWriteCacheNormal = 0 -DiskWriteCacheForceDisable = 1 -DiskWriteCacheDisableNotSupported = 2 - -## BIN_TYPES -RequestSize = 0 -RequestLocation = 1 - -## CHANGER_DEVICE_PROBLEM_TYPE -DeviceProblemNone = 0 -DeviceProblemHardware = 1 -DeviceProblemCHMError = 2 -DeviceProblemDoorOpen = 3 -DeviceProblemCalibrationError = 4 -DeviceProblemTargetFailure = 5 -DeviceProblemCHMMoveError = 6 -DeviceProblemCHMZeroError = 7 -DeviceProblemCartridgeInsertError = 8 -DeviceProblemPositionError = 9 -DeviceProblemSensorError = 10 -DeviceProblemCartridgeEjectError = 11 -DeviceProblemGripperError = 12 -DeviceProblemDriveError = 13 diff --git a/typings/win32typing/__init__.pyi b/typings/win32typing/__init__.pyi deleted file mode 100644 index f11a35e4..00000000 --- a/typings/win32typing/__init__.pyi +++ /dev/null @@ -1,51704 +0,0 @@ -""" -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 - -class COMMTIMEOUTS(object): - """A tuple representing a COMMTIMEOUTS structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class CopyProgressRoutine(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class DOCINFO(object): - """A tuple of information representing a DOCINFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def DocName(self)->'typing.Union[str]': - """Name of document""" - pass - - - @property - def Output(self)->'typing.Union[str]': - """Name of output file when printing to file. Use None for normal printing.""" - pass - - - @property - def DataType(self)->'typing.Union[str]': - """Type of data to be sent to printer, eg RAW, EMF, TEXT. Use None for printer default.""" - pass - - - @property - def Type(self)->'typing.Any': - """Flag specifying mode of operation. Can be DI_APPBANDING, DI_ROPS_READ_DESTINATION, or 0""" - pass - - -class ExportCallback(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class FORM_INFO_1(object): - """A dictionary containing FORM_INFO_1W data""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Flags(self)->'typing.Any': - """FORM_USER, FORM_BUILTIN, or FORM_PRINTER""" - pass - - - @property - def Name(self)->'str': - """Name of form""" - pass - - - @property - def Size(self)->'typing.Any': - """A dictionary representing a SIZEL structure {'cx':int,'cy':int}""" - pass - - - @property - def ImageableArea(self)->'typing.Any': - """A dictionary representing a RECTL structure {'left':int, 'top':int, 'right':int, 'bottom':int}""" - pass - - -class ImportCallback(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class LARGE_INTEGER(object): - """A Python object used wherever a COM LARGE_INTEGER is used.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class NCB(object): - """A Python object that encapsulates a Win32 NCB structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Command(self)->'typing.Any': - """""" - pass - - - @property - def Retcode(self)->'typing.Any': - """""" - pass - - - @property - def Lsn(self)->'typing.Any': - """""" - pass - - - @property - def Num(self)->'typing.Any': - """""" - pass - - - @property - def Bufflen(self)->'typing.Any': - """read-only""" - pass - - - @property - def Callname(self)->'str': - """- The strings need to be space padded to 16 chars exactly""" - pass - - - @property - def Name(self)->'str': - """- The strings need to be space padded to 16 chars exactly""" - pass - - - @property - def Rto(self)->'str': - """- The strings need to be space padded to 16 chars exactly""" - pass - - - @property - def Sto(self)->'str': - """- The strings need to be space padded to 16 chars exactly""" - pass - - - @property - def Lana_num(self)->'typing.Any': - """""" - pass - - - @property - def Cmd_cplt(self)->'typing.Any': - """""" - pass - - - @property - def Event(self)->'typing.Any': - """""" - pass - - - @property - def Post(self)->'typing.Any': - """""" - pass - - -class PRINTER_DEFAULTS(object): - """A dictionary representing a PRINTER_DEFAULTS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def pDatatype(self)->'str': - """Data type to be used for print jobs, see win32print::EnumPrintProcessorDatatypes, optional, can be None""" - pass - - - @property - def pDevMode(self)->'PyDEVMODE': - """A PyDEVMODE that specifies default printer parameters, optional, can be None""" - pass - - - @property - def DesiredAccess(self)->'typing.Any': - """An ACCESS_MASK specifying what level of access is needed, eg PRINTER_ACCESS_ADMINISTER, PRINTER_ACCESS_USE""" - pass - - -class PyACL(object): - """A Python object, representing a ACL structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,) -> 'None': - """ - Initialize the ACL. - -Args: - - - -Returns: - - None - - """ - pass - - - def IsValid(self,) -> 'None': - """ - Determines if the ACL is valid (IsValidAcl) - -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 - -specified SID. - -Args: - - revision(typing.Any):Pre-win2k, must be ACL_REVISION, otherwise also may be ACL_REVISION_DS. - access(typing.Any):Specifies the mask of access rights to be denied to the specified SID. - sid(PySID):A SID object representing a user, group, or logon account being denied access.Alternative Parameters - access1(typing.Any):Specifies the mask of access rights to be denied to the specified SID. - sid1(typing.Any):A SID object representing a user, group, or logon account being denied access.CommentsNote that early versions of this function supported only two arguments. This has been deprecated in preference of the three argument version, which reflects the win32 API and the new functions in this module. - -Returns: - - None - - """ - pass - - - def AddAccessAllowedAceEx(self,revision:'typing.Any',aceflags:'typing.Any',access:'typing.Any',sid:'PySID') -> 'None': - """ - Add access allowed ACE to an ACL with ACE flags (Requires Win2k or higher) - -Args: - - revision(typing.Any):Must be at least ACL_REVISION_DS - aceflags(typing.Any):Combination of ACE inheritance flags (CONTAINER_INHERIT_ACE,INHERIT_ONLY_ACE,INHERITED_ACE,NO_PROPAGATE_INHERIT_ACE, and OBJECT_INHERIT_ACE) - access(typing.Any):Specifies the mask of access rights to be granted to the specified SID. - sid(PySID):A SID object representing a user, group, or logon account being granted access. - -Returns: - - None - - """ - pass - - - def AddAccessAllowedObjectAce(self,AceRevision:'typing.Any',AceFlags:'typing.Any',AccessMask:'typing.Any',ObjectTypeGuid:'PyIID',InheritedObjectTypeGuid:'PyIID',sid:'PySID') -> 'None': - """ - Adds an ACCESS_ALLOWED_OBJECT_ACE to the ACL - -Args: - - AceRevision(typing.Any):Must be at least ACL_REVISION_DS - AceFlags(typing.Any):Combination of ACE inheritance flags (CONTAINER_INHERIT_ACE,INHERIT_ONLY_ACE,INHERITED_ACE,NO_PROPAGATE_INHERIT_ACE, and OBJECT_INHERIT_ACE) - AccessMask(typing.Any):Specifies the mask of access rights to be granted to the specified SID - ObjectTypeGuid(PyIID):GUID of object type or property set to which ace applies, can be None - InheritedObjectTypeGuid(PyIID):GUID of object type or property that will inherit ACE, can be None - sid(PySID):A SID object representing a user, group, or logon account being granted access. - -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 - -SID. - -Args: - - revision(typing.Any):Pre-win2k, must be ACL_REVISION, otherwise also may be ACL_REVISION_DS. - access(typing.Any):Specifies the mask of access rights to be denied to the specified SID. - sid(PySID):A SID object representing a user, group, or logon account being denied access.Alternative Parameters - access1(typing.Any):Specifies the mask of access rights to be denied to the specified SID. - sid1(typing.Any):A SID object representing a user, group, or logon account being denied access.CommentsNote that early versions of this function supported only two arguments. This has been deprecated in preference of the three argument version, which reflects the win32 API and the new functions in this module. - -Returns: - - None - - """ - pass - - - def AddAccessDeniedAceEx(self,revision:'typing.Any',aceflags:'typing.Any',access:'typing.Any',sid:'PySID') -> 'None': - """ - Add access denied ACE to an ACL with ACE flags (Requires Win2k or higher) - -Args: - - revision(typing.Any):Must be at least ACL_REVISION_DS - aceflags(typing.Any):Combination of ACE inheritance flags (CONTAINER_INHERIT_ACE,INHERIT_ONLY_ACE,INHERITED_ACE,NO_PROPAGATE_INHERIT_ACE, and OBJECT_INHERIT_ACE) - access(typing.Any):Specifies the mask of access rights to be denied to the specified SID. - sid(PySID):A SID object representing a user, group, or logon account being denied access. - -Returns: - - None - - """ - pass - - - def AddMandatoryAce(self,AceRevision:'typing.Any',AceFlags:'typing.Any',MandatoryPolicy:'typing.Any',LabelSid:'PySID') -> 'None': - """ - Adds a mandatory integrity level ACE to a SACL - -Args: - - AceRevision(typing.Any):ACL_REVISION or ACL_REVISION_DS - AceFlags(typing.Any):Combination of ACE inheritance flags (CONTAINER_INHERIT_ACE,INHERIT_ONLY_ACE,INHERITED_ACE,NO_PROPAGATE_INHERIT_ACE, and OBJECT_INHERIT_ACE) - MandatoryPolicy(typing.Any):Access policy for processes with lower integrity level, combination of SYSTEM_MANDATORY_LABEL_* flags - LabelSid(PySID):Integrity level SID. This can be created using CreateWellKnownSid with Win*LabelSid. Also can be constructed manually using SECURITY_MANDATORY_LABEL_AUTHORITY and a SECURITY_MANDATORY_*_RID - -Returns: - - None - - """ - pass - - - def AddAuditAccessAce(self,dwAceRevision:'typing.Any',dwAccessMask:'typing.Any',sid:'PySID',bAuditSuccess:'typing.Any',bAuditFailure:'typing.Any') -> 'None': - """ - Adds an audit ACE to a Sacl - -Args: - - dwAceRevision(typing.Any):Revision of ACL: Pre-Win2k, must be ACL_REVISION. Win2K on up, can also be ACL_REVISION_DS - dwAccessMask(typing.Any):Bitmask of access types to be audited - sid(PySID):SID for whom system audit messages will be generated - bAuditSuccess(typing.Any):Set to 1 if access success should be audited, else 0 - bAuditFailure(typing.Any):Set to 1 if access failure should be audited, else 0 - -Returns: - - None - - """ - pass - - - def AddAuditAccessAceEx(self,dwAceRevision:'typing.Any',AceFlags:'typing.Any',dwAccessMask:'typing.Any',sid:'PySID',bAuditSuccess:'typing.Any',bAuditFailure:'typing.Any') -> 'None': - """ - Adds an audit ACE to an Sacl, includes ace flags - -Args: - - dwAceRevision(typing.Any):Revision of ACL: Must be at least ACL_REVISION_DS - AceFlags(typing.Any):Combination of FAILED_ACCESS_ACE_FLAG,SUCCESSFUL_ACCESS_ACE_FLAG,CONTAINER_INHERIT_ACE,INHERIT_ONLY_ACE,INHERITED_ACE,NO_PROPAGATE_INHERIT_ACE and OBJECT_INHERIT_ACE - dwAccessMask(typing.Any):Bitmask of access types to be audited - sid(PySID):SID for whom system audit messages will be generated - bAuditSuccess(typing.Any):Set to 1 if access success should be audited, else 0 - bAuditFailure(typing.Any):Set to 1 if access failure should be audited, else 0 - -Returns: - - None - - """ - pass - - - def AddAuditAccessObjectAce(self,dwAceRevision:'typing.Any',AceFlags:'typing.Any',dwAccessMask:'typing.Any',ObjectTypeGuid:'PyIID',InheritedObjectTypeGuid:'PyIID',sid:'PySID',bAuditSuccess:'typing.Any',bAuditFailure:'typing.Any') -> 'None': - """ - Adds an audit ACE for an object type identified by GUID - -Args: - - dwAceRevision(typing.Any):Revision of ACL: Must be at least ACL_REVISION_DS - AceFlags(typing.Any):Combination of FAILED_ACCESS_ACE_FLAG,SUCCESSFUL_ACCESS_ACE_FLAG,CONTAINER_INHERIT_ACE,INHERIT_ONLY_ACE,INHERITED_ACE,NO_PROPAGATE_INHERIT_ACE and OBJECT_INHERIT_ACE - dwAccessMask(typing.Any):Bitmask of access types to be audited - ObjectTypeGuid(PyIID):GUID of object type or property set to which ace applies, can be None - InheritedObjectTypeGuid(PyIID):GUID of object type or property that will inherit ACE, can be None - sid(PySID):SID for whom system audit messages will be generated - bAuditSuccess(typing.Any):Set to 1 if access success should be audited, else 0 - bAuditFailure(typing.Any):Set to 1 if access failure should be audited, else 0 - -Returns: - - None - - """ - pass - - - def GetAclSize(self,) -> 'typing.Any': - """ - Returns the storage size of the ACL. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetAclRevision(self,) -> 'typing.Any': - """ - Returns revision of the ACL. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetAceCount(self,) -> 'typing.Any': - """ - Returns the number of ACEs in the ACL. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetAce(self,index:'typing.Any') -> 'typing.Any': - """ - Gets an Ace from the ACL - -Args: - - index(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[1] int : Mask[2] PySID : sidObject 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[1] int : mask[2] PyIID : ObjectType[3] PyIID : InheritedObjectType[4] PySID : sidFor details see the API documentation. - -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 - -as a tuple of: -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) - -are returned as a tuple: -[0] (int, int) : aceType, AceFlags - -[1] int : mask - -[2] PyIID : ObjectType - -[3] PyIID : InheritedObjectType - -[4] PySID : sid -For details see the API documentation. - - - """ - pass - - - def DeleteAce(self,index:'typing.Any') -> 'None': - """ - Deletes specified Ace from an ACL. - -Args: - - index(typing.Any):Zero-based index of the ACE to delete. - -Returns: - - None - - """ - pass - - - def GetEffectiveRightsFromAcl(self,trustee:'PyTRUSTEE') -> 'typing.Any': - """ - Return access rights (ACCESS_MASK) that the ACL grants to - -specified trustee - -Args: - - trustee(PyTRUSTEE):Dictionary representing a TRUSTEE structure - -Returns: - - typing.Any - - """ - pass - - - def GetAuditedPermissionsFromAcl(self,trustee:'PyTRUSTEE') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Return types of access for - -which ACL will generate an audit event for specified trustee - -Args: - - trustee(PyTRUSTEE):Dictionary representing a TRUSTEE structureCommentsThis function is known to return the success and failure access masks in the the wrong order on Windows 2000 service pack 4. Problem has been reported to Microsoft. - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - -class PyBITMAP(object): - """A Python object, representing an PyBITMAP structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def bmType(self)->'int': - """""" - pass - - - @property - def bmWidth(self)->'int': - """""" - pass - - - @property - def bmHeight(self)->'int': - """""" - pass - - - @property - def bmWidthBytes(self)->'int': - """""" - pass - - - @property - def bmPlanes(self)->'int': - """""" - pass - - -class PyBLENDFUNCTION(object): - """Tuple of four small ints used to fill a BLENDFUNCTION struct - -Each int must fit in a byte (0-255).""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCEHANDLE(object): - """A Python object, representing a remote Windows CE handle""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCERTSTORE(object): - """Handle to a certificate store""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def HCERTSTORE(self)->'typing.Any': - """Integer handle""" - pass - - - def CertCloseStore(self,Flags:'typing.Any'=0) -> 'None': - """ - Closes the certificate store - -Args: - - Flags(typing.Any):Combination of CERT_CLOSE_*_FLAG flags - -Returns: - - None - - """ - pass - - - def CertControlStore(self,Flags:'typing.Any',CtrlType:'typing.Any',CtrlPara:'int') -> 'None': - """ - Controls sychronization of the certificate store - -Args: - - Flags(typing.Any):One of the CERT_STORE_CTRL_*_FLAG flags - CtrlType(typing.Any):One of the CERT_STORE_CTRL_* flags - CtrlPara(int):Event handle, can be None (not used with CERT_STORE_CTRL_COMMIT) - -Returns: - - None - - """ - pass - - - def CertEnumCertificatesInStore(self,) -> 'typing.List[typing.Any]': - """ - Lists all certificates in the store - -Args: - - - -Returns: - - typing.List[typing.Any] - - """ - pass - - - def CertEnumCTLsInStore(self,) -> 'typing.List[typing.Any]': - """ - Finds all Certificate Trust Lists in store - -Args: - - - -Returns: - - typing.List[typing.Any] - - """ - pass - - - def CertSaveStore(self,MsgAndCertEncodingType:'typing.Any',SaveAs:'typing.Any',SaveTo:'typing.Any',SaveToPara:'typing.Union[str, int]',Flags:'typing.Any'=0) -> 'None': - """ - Serializes the store to memory or a file - -Args: - - MsgAndCertEncodingType(typing.Any):Only used when saveas is CERT_STORE_SAVE_AS_PKCS7 - usually X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING - SaveAs(typing.Any):One of the CERT_STORE_SAVE_AS_* constants - SaveTo(typing.Any):One of the CERT_STORE_SAVE_TO_* constants (CERT_STORE_SAVE_TO_MEMORY not supported yet) - SaveToPara(typing.Union[str, int]):File name or open file handle depending on SaveTo parm - Flags(typing.Any):Reserved, use 0 - -Returns: - - None - - """ - pass - - - def CertAddEncodedCertificateToStore(self,CertEncodingType:'typing.Any',CertEncoded:'typing.Any',AddDisposition:'typing.Any') -> 'PyCERT_CONTEXT': - """ - Imports an encoded certificate into the - -store - -Args: - - CertEncodingType(typing.Any):Usually X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING - CertEncoded(typing.Any):Data containing a serialized certificate - AddDisposition(typing.Any):Combination of CERT_STORE_ADD_* flags - -Returns: - - PyCERT_CONTEXT - - """ - pass - - - def CertAddCertificateContextToStore(self,CertContext:'PyCERT_CONTEXT',AddDisposition:'typing.Any') -> 'PyCERT_CONTEXT': - """ - Adds a certificate context to the store - -Args: - - CertContext(PyCERT_CONTEXT):Certificate context to be added - AddDisposition(typing.Any):CERT_STORE_ADD_* constant - -Returns: - - PyCERT_CONTEXT - - """ - pass - - - def CertAddCertificateLinkToStore(self,CertContext:'PyCERT_CONTEXT',AddDisposition:'typing.Any') -> 'PyCERT_CONTEXT': - """ - Adds a link to a cert in another store - -Args: - - CertContext(PyCERT_CONTEXT):Certificate context to be linked - AddDisposition(typing.Any):One of the CERT_STORE_ADD_* values - -Returns: - - PyCERT_CONTEXT - - """ - pass - - - def CertAddCTLContextToStore(self,CtlContext:'PyCTL_CONTEXT',AddDisposition:'typing.Any') -> 'PyCTL_CONTEXT': - """ - Adds a certificate trust list to the store - -Args: - - CtlContext(PyCTL_CONTEXT):CTL to be added - AddDisposition(typing.Any):CERT_STORE_ADD_* constant - -Returns: - - PyCTL_CONTEXT - - """ - pass - - - def CertAddCTLLinkToStore(self,CtlContext:'PyCTL_CONTEXT',AddDisposition:'typing.Any') -> 'PyCTL_CONTEXT': - """ - Adds a link to a CTL in another store - -Args: - - CtlContext(PyCTL_CONTEXT):CTL to be linked - AddDisposition(typing.Any):One of the CERT_STORE_ADD_* values - -Returns: - - PyCTL_CONTEXT - - """ - pass - - - def CertAddStoreToCollection(self,SiblingStore:'PyCERTSTORE',UpdateFlag:'typing.Any'=0,Priority:'typing.Any'=0) -> 'None': - """ - Adds a sibling store to a store collection - -Args: - - SiblingStore(PyCERTSTORE):Store to be added to the collection - UpdateFlag(typing.Any):Can be CERT_PHYSICAL_STORE_ADD_ENABLE_FLAG to enable changes to persist - Priority(typing.Any):Determines order in which store are searched and updatedCommentsA collection store is created by using cryptoapi::CertOpenStore with CERT_STORE_PROV_COLLECTION - -Returns: - - None - - """ - pass - - - def CertRemoveStoreFromCollection(self,SiblingStore:'PyCERTSTORE') -> 'None': - """ - Removes a sibling store from a collection - -Args: - - SiblingStore(PyCERTSTORE):Store to be removed from the collection - -Returns: - - None - - """ - pass - - - def PFXExportCertStoreEx(self,Flags:'typing.Any',Password:'typing.Any'=None) -> 'typing.Any': - """ - Exports certificates and associated private keys in PKCS#12 format - -Args: - - Flags(typing.Any):Options to be used while exporting - Password(typing.Any):Passphrase to be used to encrypt the output - -Returns: - - typing.Any - - """ - pass - - -class PyCERT_ALT_NAME_ENTRY(object): - """Represented as a 2-tuple""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCERT_ALT_NAME_INFO(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCERT_AUTHORITY_KEY_ID_INFO(object): - """Dict containing the identity of a CA""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def KeyId(self)->'typing.Any': - """Unique identifier of private key, usually a hash""" - pass - - - @property - def CertIssuer(self)->'typing.Any': - """Encoded DN of the Certificate Authority. Decode using X509_UNICODE_NAME""" - pass - - - @property - def CertSerialNumber(self)->'typing.Any': - """Serial nbr of the CA's signing certificate""" - pass - - -class PyCERT_BASIC_CONSTRAINTS2_INFO(object): - """Dict representing a CERT_BASIC_CONSTRAINTS2_INFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def fCA(self)->'typing.Any': - """Indicates if cert represents a certificate authority""" - pass - - - @property - def fPathLenConstraint(self)->'typing.Any': - """Indicates if PathLenConstraint member is used""" - pass - - - @property - def PathLenConstraint(self)->'typing.Any': - """Limits number of intermediate CA's between root CA and end user""" - pass - - -class PyCERT_BASIC_CONSTRAINTS_INFO(object): - """Dict representing a CERT_BASIC_CONSTRAINTS_INFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def SubjectType(self)->'PyCRYPT_BIT_BLOB': - """Contains a combination of CERT_CA_SUBJECT_FLAG,CERT_END_ENTITY_SUBJECT_FLAG""" - pass - - - @property - def fPathLenConstraint(self)->'typing.Any': - """Indicates if PathLenConstraint member is used""" - pass - - - @property - def PathLenConstraint(self)->'typing.Any': - """Limits number of intermediate CA's between root CA and end user""" - pass - - - @property - def SubtreesConstraint(self)->'typing.Any': - """Sequence of encoded name blobs""" - pass - - -class PyCERT_CONTEXT(object): - """Handle to a certificate context""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def HANDLE(self)->'typing.Any': - """Pointer to CERT_CONTEXT struct""" - pass - - - @property - def CertStore(self)->'PyCERTSTORE': - """Handle to the certificate store that contains this certificate""" - pass - - - @property - def CertEncoded(self)->'typing.Any': - """Content of the certificate as encoded bytes""" - pass - - - @property - def CertEncodingType(self)->'typing.Any': - """Method used to encode the certifcate, usually X509_ASN_ENCODING or PKCS_7_ASN_ENCODING""" - pass - - - @property - def Version(self)->'typing.Any': - """One of the CERT_V* values""" - pass - - - @property - def Subject(self)->'str': - """Encoded CERT_NAME_INFO struct containing the subject name. Can be decoded using cryptoapi::CryptDecodeObjectEx with X509_UNICODE_NAME, or formatted using cryptoapi::CertNameToStr""" - pass - - - @property - def Issuer(self)->'str': - """Certificate Authority that issued certificate as encoded CERT_NAME_INFO. Use cryptoapi::CryptDecodeObjectEx to decode into individual components, or cryptoapi::CertNameToStr to return a single formatted string""" - pass - - - @property - def NotBefore(self)->'PyTime': - """Beginning of certificate's period of validity""" - pass - - - @property - def NotAfter(self)->'PyTime': - """End of certificate's period of validity""" - pass - - - @property - def SignatureAlgorithm(self)->'typing.Any': - """Object id of the certifcate's signature algorithm""" - pass - - - @property - def Extension(self)->'typing.Tuple[PyCERT_EXTENSION, ...]': - """Sequence of CERT_EXTENSION dicts containing certificate's extensions""" - pass - - - @property - def SubjectPublicKeyInfo(self)->'PyCERT_PUBLIC_KEY_INFO': - """Encoded public key of certificate""" - pass - - - @property - def SerialNumber(self)->'typing.Any': - """Serial number assigned by the issuer""" - pass - - - def CertFreeCertificateContext(self,) -> 'None': - """ - Frees the certificate context - -Args: - - - -Returns: - - None - - """ - pass - - - def CertEnumCertificateContextProperties(self,) -> 'typing.List[typing.Any]': - """ - Lists property ids for the certificate - -Args: - - - -Returns: - - typing.List[typing.Any] - - """ - pass - - - def CryptAcquireCertificatePrivateKey(self,Flags:'typing.Any'=0) -> 'typing.Tuple[typing.Any, PyCRYPTPROV]': - """ - Retrieves the private key associated - -with the certificate - -Args: - - Flags(typing.Any):Combination of CRYPT_ACQUIRE_*_FLAG constantsCommentsOnly the owner of the certificate can use this methodReturn ValueReturns the KeySpec (AT_KEYEXCHANGE or AT_SIGNATURE) and a CSP handle to the key - -Returns: - - typing.Tuple[typing.Any, PyCRYPTPROV]:Combination of CRYPT_ACQUIRE_*_FLAG constants -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 - -(szOID_KEY_USAGE or szOID_KEY_ATTRIBUTES) - -Args: - - - -Returns: - - typing.Any:PyCERT_CONTEXT.CertGetIntendedKeyUsage - -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 - -certificate - -Args: - - Flags(typing.Any):CERT_FIND_EXT_ONLY_ENHKEY_USAGE_FLAG, CERT_FIND_PROP_ONLY_ENHKEY_USAGE_FLAG, or 0Return ValueReturns a sequence of usage OIDs - -Returns: - - 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 - - - def CertSerializeCertificateStoreElement(self,Flags:'typing.Any'=0) -> 'str': - """ - Serializes the certificate and its properties - -Args: - - Flags(typing.Any):Reserved, use only 0 if passed in - -Returns: - - str - - """ - pass - - - def CertVerifySubjectCertificateContext(self,Issuer:'PyCERT_CONTEXT',Flags:'typing.Any') -> 'typing.Any': - """ - Checks the validity of the certificate - -Args: - - Issuer(PyCERT_CONTEXT):Certificate of authority that issued the certificate - Flags(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. - -Returns: - - 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 - - - def CertDeleteCertificateFromStore(self,) -> 'None': - """ - Removes the certificate from its store - -Args: - - - -Returns: - - None - - """ - pass - - - def CertGetCertificateContextProperty(self,PropId:'typing.Any') -> 'typing.Any': - """ - Retrieves the specified property from the - -certificate - -Args: - - PropId(typing.Any):One of the CERT_*_PROP_ID constantsPropIdReturned valueCERT_ARCHIVED_PROP_IDBooleanCERT_DATE_STAMP_PROP_IDPyTimeCERT_ACCESS_STATE_PROP_IDintCERT_KEY_SPEC_PROP_IDintCERT_DESCRIPTION_PROP_IDUnicodeCERT_FRIENDLY_NAME_PROP_IDUnicodeCERT_PVK_FILE_PROP_IDUnicodeCERT_AUTO_ENROLL_PROP_IDUnicodeCERT_HASH_PROP_IDString containing a hashCERT_SHA1_HASH_PROP_IDString containing a hashCERT_MD5_HASH_PROP_IDString containing a hashCERT_SIGNATURE_HASH_PROP_IDString containing a hashCERT_KEY_IDENTIFIER_PROP_IDString containing a hashCERT_SUBJECT_NAME_MD5_HASH_PROP_IDString containing a hashCERT_KEY_PROV_HANDLE_PROP_IDPyCRYPTPROVCERT_SUBJECT_PUBLIC_KEY_MD5_HASH_PROP_IDString containing a hashCERT_ISSUER_PUBLIC_KEY_MD5_HASH_PROP_IDString containing a hashCERT_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_USAGECERT_KEY_PROV_INFO_PROP_IDCRYPT_KEY_PROV_INFO dictCERT_KEY_CONTEXT_PROP_IDDict representing CERT_KEY_CONTEXT structCERT_NEXT_UPDATE_LOCATION_PROP_IDEncoded CERT_ALT_NAME_INFO, decode using cryptoapi::CryptDecodeObjectEx with szOID_NEXT_UPDATE_LOCATIONReturn ValueType of object returned is dependent on the property id requested. - -Returns: - - typing.Any:One of the CERT_*_PROP_ID constants - - -PropId - - -Returned value - - - -CERT_ARCHIVED_PROP_IDBoolean -CERT_DATE_STAMP_PROP_IDPyTime -CERT_ACCESS_STATE_PROP_IDint -CERT_KEY_SPEC_PROP_IDint -CERT_DESCRIPTION_PROP_IDUnicode -CERT_FRIENDLY_NAME_PROP_IDUnicode -CERT_PVK_FILE_PROP_IDUnicode -CERT_AUTO_ENROLL_PROP_IDUnicode -CERT_HASH_PROP_IDString containing a hash -CERT_SHA1_HASH_PROP_IDString containing a hash -CERT_MD5_HASH_PROP_IDString containing a hash -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 - -containing a hash -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_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 -CERT_KEY_CONTEXT_PROP_IDDict representing CERT_KEY_CONTEXT struct -CERT_NEXT_UPDATE_LOCATION_PROP_IDEncoded CERT_ALT_NAME_INFO, decode using cryptoapi::CryptDecodeObjectEx - - - - with szOID_NEXT_UPDATE_LOCATION -Return ValueType of object returned is dependent on the property id requested. - - - """ - pass - - - def CertSetCertificateContextProperty(self,PropId:'typing.Any',Data:'typing.Any',Flags:'typing.Any'=0) -> 'None': - """ - Sets a property for a certificate - -Args: - - PropId(typing.Any):Id of property to be set, CERT_*_PROP_ID - Data(typing.Any):The value to be set for the property. Type is dependent on PropId. Use None to delete a property. - Flags(typing.Any):Combination of CERT_SET_* flagsPropIdType of inputCERT_ARCHIVED_PROP_IDNone causes Archived flag to be cleared, any other causes it to be set no actual data, non-NULL pvData indicates presence of flagCERT_DATE_STAMP_PROP_IDPyTime specifying when cert was added to storeCERT_DESCRIPTION_PROP_IDUnicode stringCERT_FRIENDLY_NAME_PROP_IDUnicode stringCERT_PVK_FILE_PROP_IDUnicode stringCERT_AUTO_ENROLL_PROP_IDUnicode stringCERT_KEY_SPEC_PROP_IDInt, usually AT_KEYEXCHANGE or AT_SIGNATURECERT_HASH_PROP_IDString containing the hashCERT_SHA1_HASH_PROP_IDString containing the hashCERT_MD5_HASH_PROP_IDString containingg the hashCERT_SIGNATURE_HASH_PROP_IDString containing the hashCERT_KEY_IDENTIFIER_PROP_IDString containing the key idCERT_SUBJECT_PUBLIC_KEY_MD5_HASH_PROP_IDString containing the hashCERT_ISSUER_PUBLIC_KEY_MD5_HASH_PROP_IDString containing the hashCERT_SUBJECT_NAME_MD5_HASH_PROP_IDString containing the hashCERT_RENEWAL_PROP_IDString containing the hashCERT_ENHKEY_USAGE_PROP_IDString containing an encoded PyCTL_USAGE. Use cryptoapi::CryptEncodeObjectEx with X509_ENHANCED_KEY_USAGE.CERT_CTL_USAGE_PROP_IDSame as CERT_ENHKEY_USAGE_PROP_ID - -Returns: - - None - - """ - pass - - -class PyCERT_EXTENSION(object): - """Dict containing a certificate extension""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ObjId(self)->'typing.Any': - """The OID identifying the type of extension""" - pass - - - @property - def Critical(self)->'typing.Any': - """If true, any contraints or limits contained in the extension should be considered absolute""" - pass - - - @property - def Value(self)->'typing.Any': - """Binary string containing ASN encoded data. To interpret or display extension data, see cryptoapi::CryptDecodeObjectEx and cryptoapi::CryptFormatObject.""" - pass - - -class PyCERT_KEY_ATTRIBUTES_INFO(object): - """Dict representing a CERT_KEY_ATTRIBUTES_INFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def KeyId(self)->'typing.Any': - """Usually a hash that uniquely identifies the key""" - pass - - - @property - def IntendedKeyUsage(self)->'PyCRYPT_BIT_BLOB': - """Contains a byte with CERT_*_KEY_USAGE flags""" - pass - - - @property - def PrivateKeyUsagePeriod(self)->'typing.Any': - """Private key's begin and end effective dates, may be None""" - pass - - -class PyCERT_NAME_INFO(object): - """Sequence of CERT_RDN's""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCERT_NAME_VALUE(object): - """Dict containing type (CERT_RDN_*) and a unicode string""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCERT_OTHER_NAME(object): - """Dict containing {ObjId, Value}. - -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 - -using X509_UNICODE_NAME_VALUE to return the actual unicode string""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCERT_POLICY_INFO(object): - """Dict containing a certificate policy""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def PolicyIdentifier(self)->'typing.Any': - """OID identifying the policy""" - pass - - - @property - def PolicyQualifier(self)->'typing.Any': - """Sequence of CERT_POLICY_QUALIFIER dicts""" - pass - - -class PyCERT_PUBLIC_KEY_INFO(object): - """Dict containing an exported public key""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Algorithm(self)->'PyCRYPT_ALGORITHM_IDENTIFIER': - """Dict containing OID of the public key algorithm""" - pass - - - @property - def PublicKey(self)->'PyCRYPT_BIT_BLOB': - """Dict containing the encoded public key""" - pass - - -class PyCOMSTAT(object): - """A Python object, representing an COMSTAT structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def cbInQue(self)->'int': - """Specifies the number of bytes received by the serial provider but not yet read by a win32file::ReadFile operation""" - pass - - - @property - def cbOutQue(self)->'int': - """Specifies the number of bytes of user data remaining to be transmitted for all write operations. This value will be zero for a nonoverlapped write.""" - pass - - - @property - def fCtsHold(self)->'int': - """Specifies whether transmission is waiting for the CTS (clear-to-send) signal to be sent. If this member is TRUE, transmission is waiting.""" - pass - - - @property - def fDsrHold(self)->'int': - """Specifies whether transmission is waiting for the DSR (data-set-ready) signal to be sent. If this member is TRUE, transmission is waiting.""" - pass - - - @property - def fRlsdHold(self)->'int': - """Specifies whether transmission is waiting for the RLSD (receive-line-signal-detect) signal to be sent. If this member is TRUE, transmission is waiting.""" - pass - - - @property - def fXoffHold(self)->'int': - """Specifies whether transmission is waiting because the XOFF character was received. If this member is TRUE, transmission is waiting.""" - pass - - - @property - def fXoffSent(self)->'int': - """Specifies whether transmission is waiting because the XOFF character was transmitted. If this member is TRUE, transmission is waiting. Transmission halts when the XOFF character is transmitted to a system that takes the next character as XON, regardless of the actual character.""" - pass - - - @property - def fEof(self)->'int': - """Specifies whether the end-of-file (EOF) character has been received. If this member is TRUE, the EOF character has been received.""" - pass - - - @property - def fTxim(self)->'int': - """If this member is TRUE, there is a character queued for transmission that has come to the communications device by way of the TransmitCommChar function. The communications device transmits such a character ahead of other characters in the device's output buffer.""" - pass - - - @property - def fReserved(self)->'int': - """Reserved; do not use.""" - pass - - -class PyCOORD(object): - """Wrapper for a COORD struct. Create using PyCOORDType(X,Y)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def X(self)->'typing.Any': - """Horizontal coordinate""" - pass - - - @property - def Y(self)->'typing.Any': - """Vertical coordinate""" - pass - - -class PyCREDENTIAL(object): - """A dictionary containing information for a CREDENTIAL struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Flags(self)->'typing.Any': - """Combination of CRED_FLAGS_PROMPT_NOW, CRED_FLAGS_USERNAME_TARGET""" - pass - - - @property - def Type(self)->'typing.Any': - """Type of credential, one of CRED_TYPE_* values""" - pass - - - @property - def TargetName(self)->'str': - """Target of credential, can end with * for wildcard matching""" - pass - - - @property - def Comment(self)->'str': - """Descriptive text""" - pass - - - @property - def LastWritten(self)->'PyTime': - """Modification time, ignored on input""" - pass - - - @property - def CredentialBlob(self)->'str': - """Contains password for username credential, or PIN for certificate credential. This member is write-only.""" - pass - - - @property - def Persist(self)->'typing.Any': - """Specifies scope of persistence, one of CRED_PERSIST_* values""" - pass - - - @property - def Attributes(self)->'typing.Any': - """Tuple of PyCREDENTIAL_ATTRIBUTE dicts containing application-specific data, can be None""" - pass - - - @property - def TargetAlias(self)->'str': - """Alias for TargetName, only valid with CRED_TYPE_GENERIC""" - pass - - - @property - def UserName(self)->'str': - """User to be authenticated by target. Can be of the form username@domain or domain\\username. For CRED_TYPE_DOMAIN_CERTIFICATE, use win32cred::CredMarshalCredential to marshal the SHA1 hash of user's certficate""" - pass - - -class PyCREDENTIAL_ATTRIBUTE(object): - """A dictionary containing information for a CREDENTIAL_ATTRIBUTE struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Keyword(self)->'str': - """Attribute name, at most CRED_MAX_STRING_LENGTH chars""" - pass - - - @property - def Flags(self)->'typing.Any': - """Reserved, use only 0""" - pass - - - @property - def Value(self)->'typing.Any': - """Attribute value, at most CRED_MAX_VALUE_SIZE bytes. Unicode objects are treated as raw bytes.""" - pass - - -class PyCREDENTIAL_TARGET_INFORMATION(object): - """A dictionary representing a CREDENTIAL_TARGET_INFORMATION struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def TargetName(self)->'str': - """Target of credentials""" - pass - - - @property - def NetbiosServerName(self)->'str': - """""" - pass - - - @property - def DnsServerName(self)->'str': - """""" - pass - - - @property - def NetbiosDomainName(self)->'str': - """""" - pass - - - @property - def DnsDomainName(self)->'str': - """""" - pass - - - @property - def DnsTreeName(self)->'str': - """""" - pass - - - @property - def PackageName(self)->'str': - """Name of security package which mapped TargetName""" - pass - - - @property - def Flags(self)->'typing.Any': - """CRED_TI_* flags""" - pass - - - @property - def CredTypes(self)->'typing.Tuple[typing.Any, ...]': - """Tuple of CRED_TYPE_* values indicating which types of credentials are acceptable to target""" - pass - - -class PyCREDUI_INFO(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Parent(self)->'int': - """Handle to parent window, can be None""" - pass - - - @property - def MessageText(self)->'str': - """Message to appear in dialog""" - pass - - - @property - def CaptionText(self)->'str': - """Title of the dialog window""" - pass - - - @property - def Banner(self)->'int': - """Handle to a bitmap to be displayed""" - pass - - -class PyCRYPTHASH(object): - """Handle to a cryptographic hash""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CryptDestroyHash(self,) -> 'None': - """ - Frees the hash object - -Args: - - - -Returns: - - None - - """ - pass - - - def CryptDuplicateHash(self,Flags:'typing.Any'=0) -> 'PyCRYPTHASH': - """ - Clones the hash object - -Args: - - Flags(typing.Any):Reserved, use 0 if passed - -Returns: - - PyCRYPTHASH - - """ - pass - - - def CryptHashData(self,Data:'str',Flags:'typing.Any'=0) -> 'None': - """ - Adds data to the hash - -Args: - - Data(str):Data to be hashed - Flags(typing.Any):CRYPT_USERDATA or 0CommentsIf Flags is CRYPT_USERDATA, provider is expected to prompt user to enter data. MSDN says that MS CSPs ignore this flag - -Returns: - - None - - """ - pass - - - def CryptHashSessionKey(self,Key:'PyCRYPTKEY',Flags:'typing.Any'=0) -> 'None': - """ - Hashes a session key - -Args: - - Key(PyCRYPTKEY):The session key to be hashed - Flags(typing.Any):CRYPT_LITTLE_ENDIAN or 0 - -Returns: - - None - - """ - pass - - - def CryptSignHash(self,KeySpec:'typing.Any',Flags:'typing.Any'=0) -> 'str': - """ - Signs the hash - -Args: - - KeySpec(typing.Any):The key to be used to sign the hash, AT_KEYEXCHANGE,AT_SIGNATURE - Flags(typing.Any):CRYPT_NOHASHOID,CRYPT_X931_FORMAT or 0CommentsThis methods signs only the hash, not the data that the hash represents - -Returns: - - str - - """ - pass - - - def CryptVerifySignature(self,Signature:'str',PubKey:'PyCRYPTKEY',Flags:'typing.Any'=0) -> 'None': - """ - Verifies that a signature matches hashed data - -Args: - - Signature(str):Signature data to verify - PubKey(PyCRYPTKEY):Public key of signer - Flags(typing.Any):CRYPT_NOHASHOID,CRYPT_X931_FORMAT or 0 - -Returns: - - None - - """ - pass - - - def CryptGetHashParam(self,Param:'typing.Any',Flags:'typing.Any'=0) -> 'typing.Union[typing.Any]': - """ - Retrieves the specified attribute of the hash - -Args: - - Param(typing.Any):The parameter to retrieve: HP_ALGID, HP_HASHSIZE, or HP_HASHVAL - Flags(typing.Any):Reserved, use 0 if passed inCommentsAfter this method has been called, no more data can be hashedReturn ValueType of returned object is dependent on the Param passed in - -Returns: - - typing.Union[typing.Any]:Reserved, use 0 if passed in -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 - - -class PyCRYPTKEY(object): - """Handle to a cryptographic key""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def HCRYPTPROV(self)->'typing.Any': - """CSP used by the key""" - pass - - - @property - def HCRYPTKEY(self)->'typing.Any': - """Plain integer handle to the key""" - pass - - - def CryptDestroyKey(self,) -> 'None': - """ - Releases the handle to the key (does not delete permanent keys) - -Args: - - - -Returns: - - None - - """ - pass - - - def CryptExportKey(self,ExpKey:'PyCRYPTKEY',BlobType:'typing.Any',Flags:'typing.Any'=0) -> 'typing.Any': - """ - Exports key or key pair as an encrypted blob - -Args: - - ExpKey(PyCRYPTKEY):Public key or session key of destination user. Use None if exporting a PUBLICKEYBLOB - BlobType(typing.Any):One of OPAQUEKEYBLOB,PRIVATEKEYBLOB,PUBLICKEYBLOB,SIMPLEBLOB,PLAINTEXTKEYBLOB,SYMMETRICWRAPKEYBLOB - Flags(typing.Any):Combination of CRYPT_DESTROYKEY,CRYPT_SSL2_FALLBACK,CRYPT_OAEP or 0Return ValueReturns a binary blob that can be imported via PyCRYPTPROV::CryptImportKey - -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 - - - def CryptGetKeyParam(self,Param:'typing.Any',Flags:'typing.Any'=0) -> 'typing.Any': - """ - Retrieves key parameters - -Args: - - Param(typing.Any):One of the KP_* constants - Flags(typing.Any):Reserved, use only 0Return ValueType of returned object is dependent on the requested attribute - -Returns: - - typing.Any:Reserved, use only 0 -Return ValueType of returned object is dependent on the requested attribute - - - """ - pass - - - def CryptDuplicateKey(self,Reserved:'typing.Any'=0,Flags:'typing.Any'=0) -> 'PyCRYPTKEY': - """ - Creates an independent copy of the key - -Args: - - Reserved(typing.Any):Use 0 if passed in - Flags(typing.Any):Also reserved, use 0 - -Returns: - - PyCRYPTKEY - - """ - pass - - - def CryptEncrypt(self,Final:'typing.Any',Data:'typing.Any',Hash:'PyCRYPTHASH'=None,Flags:'typing.Any'=0) -> 'typing.Any': - """ - Encrypts and optionally hashes data - -Args: - - Final(typing.Any):Boolean, use True if this is final encryption operation - Data(typing.Any):Data to be encrypted - Hash(PyCRYPTHASH):Hash to be updated with data passed in, can be None - Flags(typing.Any):Reserved, use 0 if passed in - -Returns: - - typing.Any - - """ - pass - - - def CryptDecrypt(self,Final:'typing.Any',Data:'typing.Any',Hash:'PyCRYPTHASH'=None,Flags:'typing.Any'=0) -> 'typing.Any': - """ - Decrypts data - -Args: - - Final(typing.Any):Boolean, use True is this is last (or only) operation - Data(typing.Any):Data to be decrypted - Hash(PyCRYPTHASH):Hash to be used in signature verification, can be None - Flags(typing.Any):Reserved, use only 0 - -Returns: - - typing.Any - - """ - pass - - -class PyCRYPTMSG(object): - """Wrapper for a cryptographic message handle""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def HCRYPTMSG(self)->'typing.Any': - """Raw message handle""" - pass - - - def CryptMsgClose(self,) -> 'None': - """ - Closes the message handle - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCRYPTPROTECT_PROMPTSTRUCT(object): - """A tuple representing a CRYPTPROTECT_PROMPTSTRUCT structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCRYPTPROV(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CryptReleaseContext(self,Flags:'typing.Any'=0) -> 'None': - """ - Releases the CSP handle - -Args: - - Flags(typing.Any):Reserved, use 0 if passed in - -Returns: - - None - - """ - pass - - - def CryptGenKey(self,Algid:'typing.Any',Flags:'typing.Any',KeyLen:'typing.Any'=0) -> 'PyCRYPTKEY': - """ - Generates a key pair or a session key - -Args: - - Algid(typing.Any):Algorithm identifier, one of the CALG_* values, or AT_KEYEXCHANGE/AT_SIGNATURE - Flags(typing.Any):Combination of CRYPT_CREATE_SALT,CRYPT_EXPORTABLE,CRYPT_NO_SALT,CRYPT_PREGEN,CRYPT_USER_PROTECTED,CRYPT_ARCHIVABLE - KeyLen(typing.Any):Length of key to generate, can be 0 to use provider's default key lengthCommentsDiffers from Api call in that the length is passed in separately - -Returns: - - PyCRYPTKEY - - """ - pass - - - def CryptGetProvParam(self,Param:'typing.Any',Flags:'typing.Any'=0) -> 'None': - """ - Retrieves specified attribute of provider - -Args: - - Param(typing.Any):One of the PP_* values - Flags(typing.Any):If param if PP_KEYSET_SEC_DESCR, can be a combination of OWNER_SECURITY_INFORMATION,GROUP_SECURITY_INFORMATION,DACL_SECURITY_INFORMATION,SACL_SECURITY_INFORMATIONReturn ValueType of returned object is dependent on the attribute requested - -Returns: - - 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 - - - def CryptGetUserKey(self,KeySpec:'typing.Any') -> 'PyCRYPTKEY': - """ - Returns a handle to one of user's key pairs - -Args: - - KeySpec(typing.Any):AT_KEYEXCHANGE or AT_SIGNATURE (some providers may implement extra key specs) - -Returns: - - PyCRYPTKEY - - """ - pass - - - def CryptGenRandom(self,Len:'typing.Any',SeedData:'str'=None) -> 'str': - """ - Generates random data of specified length - -Args: - - Len(typing.Any):Number of bytes to generate - SeedData(str):Random seed data - -Returns: - - str - - """ - pass - - - def CryptCreateHash(self,Algid:'typing.Any',Key:'PyCRYPTKEY'=None,Flags:'typing.Any'=0) -> 'PyCRYPTHASH': - """ - Creates a hash object for hashing large amounts of data - -Args: - - Algid(typing.Any):An algorithm identifier, CALG_*. - Key(PyCRYPTKEY):Used only for keyed hashes (MAC or HMAC), use None otherwise - Flags(typing.Any):Reserved, use 0 if passed in - -Returns: - - PyCRYPTHASH - - """ - pass - - - def CryptImportKey(self,Data:'typing.Any',PubKey:'PyCRYPTKEY'=None,Flags:'typing.Any'=0) -> 'PyCRYPTKEY': - """ - None - -Args: - - Data(typing.Any):The key blob to be imported - PubKey(PyCRYPTKEY):Key to be used to decrypt the blob, not used for importing public keys - Flags(typing.Any):Combination of CRYPT_EXPORTABLE, CRYPT_OAEP, CRYPT_NO_SALT, CRYPT_USER_PROTECTED - -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 - -Returned dict can be serialized for sending to another python application using pickle.dump - -Args: - - KeySpec(typing.Any):AT_KEYEXCHANGE or AT_SIGNATURE - CertEncodingType(typing.Any):Specifies encoding for exported key info - -Returns: - - PyCERT_PUBLIC_KEY_INFO - - """ - pass - - - def CryptImportPublicKeyInfo(self,Info:'typing.Any',CertEncodingType:'typing.Any') -> 'PyCRYPTKEY': - """ - Imports another user's public key - -Args: - - Info(typing.Any):PyCERT_PUBLIC_KEY_INFO dictionary as returned by PyCRYPTPROV::CryptExportPublicKeyInfo - CertEncodingType(typing.Any):Specifies encoding for exported key info - -Returns: - - PyCRYPTKEY - - """ - pass - - -class PyCRYPT_ALGORITHM_IDENTIFIER(object): - """Dictionary containing information that identifies an encryption - -algorithm and any extra parameters it requires""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ObjId(self)->'typing.Any': - """An szOID_* string identifying the algorithm""" - pass - - - @property - def Parameters(self)->'typing.Any': - """Blob of binary data containing encoded parameters""" - pass - - -class PyCRYPT_ATTRIBUTE(object): - """Dict representing a CRYPT_ATTRIBUTE struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ObjId(self)->'typing.Any': - """An szOID_* string identifying the attribute""" - pass - - - @property - def Value(self)->'typing.Tuple[typing.Any, ...]': - """A sequence of buffers containing the attribute values""" - pass - - -class PyCRYPT_BIT_BLOB(object): - """Dict containing raw data of a certain bit length""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Data(self)->'typing.Any': - """Binary data""" - pass - - - @property - def UnusedBits(self)->'typing.Any': - """Nbr of bits of last byte that are unused""" - pass - - -class PyCRYPT_DECRYPT_MESSAGE_PARA(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def CertStores(self)->'typing.Tuple[typing.Any, ...]': - """Sequence of certificate stores to be searched for a certificate with a private key that can be used to decrypt the message""" - pass - - - @property - def MsgAndCertEncodingType(self)->'typing.Any': - """Encoding types, optional. Defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" - pass - - - @property - def Flags(self)->'typing.Any': - """Optional. CRYPT_MESSAGE_SILENT_KEYSET_FLAG can be used to suppress any dialogs that might be triggered by accessing a key container, such as a request for a PIN.""" - pass - - -class PyCRYPT_ENCRYPT_MESSAGE_PARA(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ContentEncryptionAlgorithm(self)->'PyCRYPT_ALGORITHM_IDENTIFIER': - """Identifies the algorithm to be used""" - pass - - - @property - def CryptProv(self)->'PyCRYPTPROV': - """Optional. Handle to provider that will perform encryption, can be None for default provider""" - pass - - - @property - def EncryptionAuxInfo(self)->'typing.Any': - """Optional. Extra info required by some CSP's. Not supported yet, use only None""" - pass - - - @property - def Flags(self)->'typing.Any': - """Optional. Combination of CRYPT_MESSAGE_*_FLAG constants""" - pass - - - @property - def InnerContentType(self)->'typing.Any': - """Optional. Only used if message to be encrypted is already encoded""" - pass - - - @property - def MsgEncodingType(self)->'typing.Any': - """Optional. Defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" - pass - - -class PyCRYPT_SIGN_MESSAGE_PARA(object): - """Dict of parms defining how a message will be signed""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def SigningCert(self)->'PyCERT_CONTEXT': - """Certficate to be used to sign message""" - pass - - - @property - def HashAlgorithm(self)->'PyCRYPT_ALGORITHM_IDENTIFIER': - """Algorithm to be used for signed hash""" - pass - - - @property - def HashAuxInfo(self)->'typing.Any': - """Optional. Param is reserved, use only None.""" - pass - - - @property - def MsgCert(self)->'typing.Tuple[PyCERT_CONTEXT, ...]': - """Optional sequence of certificate to be included in the message.""" - pass - - - @property - def MsgCrl(self)->'typing.Tuple[typing.Any, ...]': - """Optional. Sequence of certificate revocation lists. Not yet supported, use only None.""" - pass - - - @property - def AuthAttr(self)->'typing.Tuple[PyCRYPT_ATTRIBUTE, ...]': - """Sequence of canonical attributes to be added to the message""" - pass - - - @property - def UnauthAttr(self)->'typing.Tuple[PyCRYPT_ATTRIBUTE, ...]': - """Sequence of arbitrary attributes""" - pass - - - @property - def Flags(self)->'typing.Any': - """Optional CRYPT_MESSAGE_*_FLAG that indicates content type if output is to be further encoded.""" - pass - - - @property - def InnerContentType(self)->'typing.Any': - """Optional, one of the CMSG_* content types if message is already encoded, .""" - pass - - - @property - def MsgEncodingType(self)->'typing.Any': - """Encoding types, optional. Defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" - pass - - -class PyCRYPT_VERIFY_MESSAGE_PARA(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def MsgAndCertEncodingType(self)->'typing.Any': - """Encoding types, defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" - pass - - - @property - def CryptProv(self)->'PyCRYPTPROV': - """CSP to be used to verify signature. Use None for default provider.""" - pass - - - @property - def PyGetSignerCertificate(self)->'typing.Any': - """Callback function that locates signer's certificate.""" - pass - - - @property - def GetArg(self)->'typing.Any': - """Argument to be passed to above function, can be any object.""" - pass - - -class PyCTL_CONTEXT(object): - """Object containing a Certificate Trust List""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def HCTL_CONTEXT(self)->'typing.Any': - """Raw message handle""" - pass - - - def CertFreeCTLContext(self,) -> 'None': - """ - Closes the CTL handle - -Args: - - - -Returns: - - None - - """ - pass - - - def CertEnumCTLContextProperties(self,) -> 'typing.Tuple[typing.Any, ...]': - """ - Lists property id's for the context - -Args: - - - -Returns: - - typing.Tuple[typing.Any, ...] - - """ - pass - - - def CertEnumSubjectInSortedCTL(self,) -> 'typing.Tuple[typing.Tuple[typing.Any, typing.Any], ...]': - """ - Retrieves trusted subjects contained in CRL - -Args: - - - -Returns: - - typing.Tuple[typing.Tuple[typing.Any, typing.Any], ...]:PyCTL_CONTEXT.CertEnumSubjectInSortedCTL - -((str,str),...) = CertEnumSubjectInSortedCTL()Retrieves trusted subjects contained in CRL -Return ValueReturns a sequence of tuples containing two strings (SubjectIdentifier, EncodedAttributes) - - - """ - pass - - - def CertDeleteCTLFromStore(self,) -> 'None': - """ - Removes the CTL from the store that it is contained in - -Args: - - - -Returns: - - None - - """ - pass - - - def CertSerializeCTLStoreElement(self,Flags:'typing.Any'=0) -> 'str': - """ - Serializes the CTL and its properties - -Args: - - Flags(typing.Any):Reserved, use only 0 if passed in - -Returns: - - str - - """ - pass - - -class PyCTL_USAGE(object): - """Sequence of string OIDs (szOID_*). This struct is identical to CERT_ENHKEY_USAGE.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyConsoleScreenBuffer(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetConsoleActiveScreenBuffer(self,) -> 'None': - """ - Sets this handle as the currently displayed screen - -buffer - -Args: - - - -Returns: - - None - - """ - pass - - - def GetConsoleCursorInfo(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Retrieves size and visibility of console's - -cursor - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any]:PyConsoleScreenBuffer.GetConsoleCursorInfo - -(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 - -if cursor is visible - - - """ - pass - - - def SetConsoleCursorInfo(self,Size:'typing.Any',Visible:'typing.Any') -> 'None': - """ - Sets the size and visibility of console's cursor - -Args: - - Size(typing.Any):Percentage of character size that cursor will occupy - Visible(typing.Any):Determines if cursor is visible - -Returns: - - None - - """ - pass - - - def GetConsoleMode(self,) -> 'typing.Any': - """ - Returns the input or output mode of the console buffer - -Args: - - - -Returns: - - typing.Any:PyConsoleScreenBuffer.GetConsoleMode - -int = GetConsoleMode()Returns the input or output mode of the console buffer -Return ValueReturns a combination of ENABLE_*_INPUT or ENABLE_*_OUTPUT constants - - - """ - pass - - - def SetConsoleMode(self,Mode:'typing.Any') -> 'None': - """ - Sets the input or output mode of the console buffer - -Args: - - Mode(typing.Any):Combination of ENABLE_*_INPUT or ENABLE_*_OUTPUT constants - -Returns: - - None - - """ - pass - - - def ReadConsole(self,NumberOfCharsToRead:'typing.Any') -> 'typing.Any': - """ - Reads characters from the console input buffer - -Args: - - NumberOfCharsToRead(typing.Any):Characters to read - -Returns: - - typing.Any - - """ - pass - - - def WriteConsole(self,Buffer:'typing.Any') -> 'typing.Any': - """ - Writes characters at current cursor position - -Args: - - Buffer(typing.Any):String or Unicode to be written to consoleReturn ValueReturns the number of characters written - -Returns: - - typing.Any:String or Unicode to be written to consoleReturn ValueReturns the number of characters written - - - """ - pass - - - def FlushConsoleInputBuffer(self,) -> 'None': - """ - Flush input buffer - -Args: - - - -Returns: - - None - - """ - pass - - - def SetConsoleTextAttribute(self,Attributes:'typing.Any') -> 'None': - """ - Sets character attributes for subsequent write operations - -Args: - - Attributes(typing.Any):Attributes to be set, combination of FOREGROUND_*, BACKGROUND_*, and COMMON_LVB_* constants - -Returns: - - None - - """ - pass - - - def SetConsoleCursorPosition(self,CursorPosition:'PyCOORD') -> 'None': - """ - Sets the console screen buffer's cursor position - -Args: - - CursorPosition(PyCOORD):A PyCOORD containing the new cursor position - -Returns: - - None - - """ - pass - - - def SetConsoleScreenBufferSize(self,Size:'PyCOORD') -> 'None': - """ - Sets the size of the console screen buffer - -Args: - - Size(PyCOORD):COORD object containing the new dimensions - -Returns: - - None - - """ - pass - - - def SetConsoleWindowInfo(self,Absolute:'typing.Any',ConsoleWindow:'PySMALL_RECT') -> 'None': - """ - Changes size and position of a console's window - -Args: - - Absolute(typing.Any):If False, coordinates are relative to current position - ConsoleWindow(PySMALL_RECT):A SMALL_RECT containing the new window coordinates - -Returns: - - None - - """ - pass - - - def GetConsoleScreenBufferInfo(self,) -> 'typing.Any': - """ - Returns the state of the screen buffer - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetLargestConsoleWindowSize(self,) -> 'PyCOORD': - """ - Returns the largest possible size for the - -console's window - -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 - -characters - -Args: - - Attribute(typing.Any):Text attributes to be set, combination of FOREGROUND_*, BACKGROUND_*, and COMMON_LVB_* constants - Length(typing.Any):The number of characters to set - WriteCoord(PyCOORD):The screen position to begin atReturn ValueReturns the number of character cells whose attributes were set - -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 - -character - -Args: - - Character(typing.Any):A single character to be used to fill the specified range - Length(typing.Any):The number of characters positions to fill - WriteCoord(PyCOORD):The screen position to begin atReturn ValueReturns the number of characters actually written - -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 - -position - -Args: - - Length(typing.Any):The number of characters positions to read - ReadCoord(PyCOORD):The screen position start reading from - -Returns: - - str - - """ - pass - - - def ReadConsoleOutputAttribute(self,Length:'typing.Any',ReadCoord:'PyCOORD') -> 'typing.Tuple[typing.Any, ...]': - """ - Retrieves attributes from consecutive character - -cells - -Args: - - Length(typing.Any):The number of attributes to read - ReadCoord(PyCOORD):The screen position from which to start readingReturn ValueReturns a sequence of ints containing the attributes of a range of characters - -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 - - - def WriteConsoleOutputCharacter(self,Characters:'typing.Any',WriteCoord:'PyCOORD') -> 'typing.Any': - """ - Writes a string of characters at a specified position - -Args: - - Characters(typing.Any):Characters to be written - WriteCoord(PyCOORD):The screen position at which to start writingReturn ValueReturns the number of characters actually written - -Returns: - - typing.Any:The screen position at which to start writingReturn ValueReturns the number of characters actually written - - - """ - pass - - - def WriteConsoleOutputAttribute(self,Attributes:'typing.Tuple[typing.Any, ...]',WriteCoord:'PyCOORD') -> 'typing.Any': - """ - Sets the attributes of a range of character cells - -Args: - - Attributes(typing.Tuple[typing.Any, ...]):A sequence of ints containing the attributes to be set - WriteCoord(PyCOORD):The screen position at which to start writingReturn ValueReturns the number of attributes set - -Returns: - - typing.Any:The screen position at which to start writingReturn ValueReturns the number of attributes set - - - """ - pass - - - def ScrollConsoleScreenBuffer(self,ScrollRectangle:'PySMALL_RECT',ClipRectangle:'PySMALL_RECT',DestinationOrigin:'PyCOORD',FillCharacter:'typing.Any',FillAttribute:'typing.Any') -> 'None': - """ - Scrolls a region of the display - -Args: - - ScrollRectangle(PySMALL_RECT):The region to be scrolled - ClipRectangle(PySMALL_RECT):Rectangle that limits display area affected, can be None - DestinationOrigin(PyCOORD):The position to which ScrollRectangle will be moved - FillCharacter(typing.Any):Character to fill in the area left blank by scrolling operation - FillAttribute(typing.Any):Text attributes to apply to FillCharacter - -Returns: - - None - - """ - pass - - - def GetCurrentConsoleFont(self,MaximumWindow:'typing.Any'=False) -> 'typing.Tuple[typing.Any, PyCOORD]': - """ - Returns currently displayed font - -Args: - - MaximumWindow(typing.Any):If True, retrieves font size for maximum window sizeCommentsOnly exists on XP or later. 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 - -Returns: - - typing.Tuple[typing.Any, PyCOORD]:If True, retrieves font size for maximum window size -Comments - -Only exists on XP or later. - -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 - - - def GetConsoleFontSize(self,Font:'typing.Any') -> 'PyCOORD': - """ - Returns size of specified font for the console - -Args: - - Font(typing.Any):Index of font as returned by GetCurrentConsoleFontCommentsOnly exists on XP or later. - -Returns: - - PyCOORD - - """ - pass - - - def SetConsoleFont(self,Font:'typing.Any') -> 'None': - """ - Changes the font used by the screen buffer - -Args: - - Font(typing.Any):The number of the font to be setCommentsFunction is not documented on MSDN - -Returns: - - None - - """ - pass - - - def SetStdHandle(self,StdHandle:'typing.Any') -> 'None': - """ - Replaces one of calling process's standard handles with this handle - -Args: - - StdHandle(typing.Any):Specifies handle to be replaced - STD_INPUT_HANDLE, STD_OUTPUT_HANDLE, or STD_ERROR_HANDLE - -Returns: - - None - - """ - pass - - - def SetConsoleDisplayMode(self,Flags:'typing.Any',NewScreenBufferDimensions:'PyCOORD') -> 'None': - """ - Sets the display mode of the console buffer - -Args: - - Flags(typing.Any):CONSOLE_FULLSCREEN_MODE or CONSOLE_WINDOWED_MODE - NewScreenBufferDimensions(PyCOORD):New size of the screen buffer in characters - -Returns: - - None - - """ - pass - - - def WriteConsoleInput(self,Buffer:'typing.Tuple[PyINPUT_RECORD, ...]') -> 'typing.Any': - """ - Places input records in the console's input queue - -Args: - - Buffer(typing.Tuple[PyINPUT_RECORD, ...]):A sequence of PyINPUT_RECORD objectsReturn ValueReturns the number of records written - -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 - -the input queue - -Args: - - Length(typing.Any):The number of input records to readCommentsThis functions blocks until at least one record is read. The number of records returned may be less than the nbr requestedReturn ValueReturns a sequence of PyINPUT_RECORD objects - -Returns: - - typing.Tuple[PyINPUT_RECORD, ...]:The number of input records to readComments - -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 - -removing them from the input queue - -Args: - - Length(typing.Any):The number of input records to readCommentsThis function does not block as ReadConsoleInput does. The number of records returned may be less than the nbr requestedReturn ValueReturns a sequence of PyINPUT_RECORD objects - -Returns: - - typing.Tuple[PyINPUT_RECORD, ...]:The number of input records to readComments - -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 - -queue - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyCredHandle(object): - """Handle to a set of logon credentials, used with sspi authentication functions""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Detach(self,) -> 'typing.Any': - """ - Disassociates object from handle and returns integer value of handle, - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def FreeCredentialsHandle(self,) -> 'None': - """ - Releases the credentials handle and makes object unusable - -Args: - - - -Returns: - - None - - """ - pass - - - def QueryCredentialsAttributes(self,Attribute:'typing.Any') -> 'None': - """ - Returns information about the credentials - -Args: - - Attribute(typing.Any):SECPKG_* constant specifying which type of information to returnCommentsOnly SECPKG_CRED_ATTR_NAMES currently supportedAttributeReturn typeSECPKG_CRED_ATTR_NAMESPyUnicode - returns username that credentials representSECPKG_ATTR_SUPPORTED_ALGSNot supported yet SecPkgCred_SupportedAlgs:SECPKG_ATTR_CIPHER_STRENGTHSNot supported yet SecPkgCred_CipherStrengths:SECPKG_ATTR_SUPPORTED_PROTOCOLSNot supported yet SecPkgCred_SupportedProtocols:Return ValueType of returned values is dependent on Attribute - -Returns: - - None:SECPKG_* constant specifying which type of information to returnComments - -Only SECPKG_CRED_ATTR_NAMES currently supported - - - -Attribute - - -Return type - - - -SECPKG_CRED_ATTR_NAMESPyUnicode - returns username that credentials represent -SECPKG_ATTR_SUPPORTED_ALGSNot supported yet - -SecPkgCred_SupportedAlgs: -SECPKG_ATTR_CIPHER_STRENGTHSNot supported yet - -SecPkgCred_CipherStrengths: -SECPKG_ATTR_SUPPORTED_PROTOCOLSNot supported yet - -SecPkgCred_SupportedProtocols: -Return ValueType of returned values is dependent on Attribute - - - """ - pass - - -class PyCtxtHandle(object): - """Security context handle, as used with sspi functions""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Detach(self,) -> 'typing.Any': - """ - Disassociates object from handle and returns integer value of handle - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def CompleteAuthToken(self,Token:'PySecBufferDesc') -> 'None': - """ - Completes the authentication token - -Args: - - Token(PySecBufferDesc):The buffer that contains the token buffer used when the context was initializedCommentsThis method should be invoked on a context handle if the InitializeSecurityContext call that created it returned SEC_I_COMPLETE_NEEDED or SEC_I_COMPLETE_AND_CONTINUE - -Returns: - - None - - """ - pass - - - def QueryContextAttributes(self,Attribute:'typing.Any') -> 'None': - """ - Retrieves info about a security context - -Args: - - Attribute(typing.Any):SECPKG_ATTR_* constantCommentsNot all attributes are available for every security packageAttributeReturn typeSECPKG_ATTR_ACCESS_TOKENPyHANDLE - returns a handle to the context's access tokenSECPKG_ATTR_AUTHORITYPyUnicode - returns the name of the authenticating entitySECPKG_ATTR_CIPHER_STRENGTHS(int,int) - returns the mininum and maximum cipher strengths allowedSECPKG_ATTR_CONNECTION_INFOReturns a dictionary of connection info representing a SecPkgContext_ConnectionInfo structSECPKG_ATTR_SESSION_KEYstring - returns the session key for the contextSECPKG_ATTR_ISSUER_LIST_EX(int, string) - Returns names of trusted certificate issuersSECPKG_ATTR_FLAGSint - returns flags negotiated when context was establishedSECPKG_ATTR_PACKAGE_INFOdict - returns dictionary containing info for context's security packageSECPKG_ATTR_NEGOTIATION_INFO(int, dict) - returns state of negotiation (SECPKG_NEGOTIATION_COMPLETE, SECPKG_NEGOTIATION_OPTIMISTIC,SECPKG_NEGOTIATION_IN_PROGRESS) and info for negotiated packageSECPKG_ATTR_NAMESPyUnicode - returns the user name for the contextSECPKG_ATTR_SIZESdict containing buffer sizes to be used with the contextSECPKG_ATTR_PASSWORD_EXPIRYPyTime - returns time password expiresSECPKG_ATTR_LIFESPAN(PyTime,PyTime) - returns time period during which context is validSECPKG_ATTR_NATIVE_NAMES(PyUnicode,PyUnicode) - returns client and server namesSECPKG_ATTR_TARGET_INFORMATIONstring - returns the target for the contextSECPKG_ATTR_STREAM_SIZESdict (see SecPkgContext_StreamSizes) containing message buffer sizesSECPKG_ATTR_KEY_INFOdict (see SecPkgContext_KeyInfo) containing encryption key parametersSECPKG_ATTR_DCE_INFOnot supported yet SecPkgContext_DceInfoSECPKG_ATTR_LOCAL_CERT_CONTEXTnot supported yet PCCERT_CONTEXTSECPKG_ATTR_REMOTE_CERT_CONTEXTnot supported yet PCCERT_CONTEXTSECPKG_ATTR_ROOT_STOREnot supported yet HCERTCONTEXTSECPKG_ATTR_SUPPORTED_ALGSnot supported yet SecPkgCred_SupportedAlgsSECPKG_ATTR_SUPPORTED_PROTOCOLSnot supported yet SecPkgCred_SupportedProtocols - -Returns: - - None - - """ - pass - - - def DeleteSecurityContext(self,) -> 'None': - """ - Frees the security context and invalidates the handle - -Args: - - - -Returns: - - None - - """ - pass - - - def QuerySecurityContextToken(self,) -> 'typing.Any': - """ - Returns the access token for a security context - -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 - -context - -Args: - - fqop(typing.Any):Flags that indicate quality of protection desired, specific to each security package - Message(PySecBufferDesc):Buffer set that includes buffers for input data and output signature - MessageSeqNo(typing.Any):A sequential number used by some packages to verify that no extraneous messages have been receivedCommentsThe 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_TOKENReturn ValueReturns None on success, and output buffer in Message will contain the signature - -Returns: - - 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 - -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 - - - def VerifySignature(self,Message:'PySecBufferDesc',MessageSeqNo:'typing.Any') -> 'None': - """ - None - -Args: - - Message(PySecBufferDesc):SecBufferDesc that contains data buffer and signature buffer - MessageSeqNo(typing.Any):A sequential number used by some packages to verify that no extraneous messages have been receivedCommentsThe buffer configuration is dependent on the security package. Usually there is a data buffer of type SECBUFFER_DATA and a signature buffer of type SECBUFFER_TOKENReturn ValueReturns quality of protection flags used to create signature - -Returns: - - 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 - -SECBUFFER_DATA - -and a signature buffer of type SECBUFFER_TOKEN -Return ValueReturns quality of protection flags used to create signature - - - """ - pass - - - def EncryptMessage(self,fqop:'typing.Any',Message:'PySecBufferDesc',MessageSeqNo:'typing.Any') -> 'None': - """ - Encrypts data with session key of security context - -Args: - - fqop(typing.Any):Flags that indicate quality of protection desired, specific to each security package - Message(PySecBufferDesc):PySecBufferDesc that contains data buffer(s) to be encrypted - MessageSeqNo(typing.Any):A sequential number used by some packages to verify that no extraneous messages have been receivedCommentsThe 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 SECBUFFER_TOKEN to receive signature or padding dataReturn ValueReturns None on success, and buffer(s) will contain encrypted data - -Returns: - - 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 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 - - - def DecryptMessage(self,Message:'PySecBufferDesc',MessageSeqNo:'typing.Any') -> 'None': - """ - None - -Args: - - Message(PySecBufferDesc):PySecBufferDesc containing data buffers to be decrypted - MessageSeqNo(typing.Any):A sequential number used by some packages to verify that no extraneous messages have been receivedCommentsThe 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 SECBUFFER_PADDING containing signature, padding, or other extra data from encryption process that doesn't fit in first bufferReturn ValueReturns flags specfic to security package indicating quality of protection - -Returns: - - 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 - -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 - -in first buffer -Return ValueReturns flags specfic to security package indicating quality of protection - - - """ - pass - - - def ImpersonateSecurityContext(self,) -> 'None': - """ - Impersonates a client security context - -Args: - - - -Returns: - - None - - """ - pass - - - def RevertSecurityContext(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - -class PyDCB(object): - """A Python object, representing an DCB structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def BaudRate(self)->'int': - """current baud rate""" - pass - - - @property - def wReserved(self)->'int': - """not currently used""" - pass - - - @property - def XonLim(self)->'int': - """transmit XON threshold""" - pass - - - @property - def XoffLim(self)->'int': - """transmit XOFF threshold""" - pass - - - @property - def ByteSize(self)->'int': - """number of bits/byte, 4-8""" - pass - - - @property - def Parity(self)->'int': - """0-4=no,odd,even,mark,space""" - pass - - - @property - def StopBits(self)->'int': - """0,1,2 = 1, 1.5, 2""" - pass - - - @property - def XonChar(self)->'str': - """Tx and Rx XON character""" - pass - - - @property - def XoffChar(self)->'str': - """Tx and Rx XOFF character""" - pass - - - @property - def ErrorChar(self)->'str': - """error replacement character""" - pass - - - @property - def EofChar(self)->'str': - """end of input character""" - pass - - - @property - def EvtChar(self)->'str': - """received event character""" - pass - - - @property - def wReserved1(self)->'int': - """reserved; do not use""" - pass - - - @property - def fBinary(self)->'int': - """binary mode, no EOF check""" - pass - - - @property - def fParity(self)->'int': - """enable parity checking""" - pass - - - @property - def fOutxCtsFlow(self)->'int': - """CTS output flow control""" - pass - - - @property - def fOutxDsrFlow(self)->'int': - """DSR output flow control""" - pass - - - @property - def fDtrControl(self)->'int': - """DTR flow control type""" - pass - - - @property - def fDsrSensitivity(self)->'int': - """DSR sensitivity""" - pass - - - @property - def fTXContinueOnXoff(self)->'int': - """XOFF continues Tx""" - pass - - - @property - def fOutX(self)->'int': - """XON/XOFF out flow control""" - pass - - - @property - def fInX(self)->'int': - """XON/XOFF in flow control""" - pass - - - @property - def fErrorChar(self)->'int': - """enable error replacement""" - pass - - - @property - def fNull(self)->'int': - """enable null stripping""" - pass - - - @property - def fRtsControl(self)->'int': - """RTS flow control""" - pass - - - @property - def fAbortOnError(self)->'int': - """abort on error""" - pass - - - @property - def fDummy2(self)->'int': - """reserved""" - pass - - -class PyDEVMODE(object): - """Python object wrapping a DEVMODE structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def SpecVersion(self)->'typing.Any': - """Should always be set to DM_SPECVERSION""" - pass - - - @property - def DriverVersion(self)->'typing.Any': - """Version nbr assigned to printer driver by vendor""" - pass - - - @property - def Size(self)->'typing.Any': - """Size of structure""" - pass - - - @property - def DriverExtra(self)->'typing.Any': - """Number of extra bytes allocated for driver data, can only be set when new object is created""" - pass - - - @property - def Fields(self)->'typing.Any': - """Bitmask of win32con.DM_* constants indicating which members are set""" - pass - - - @property - def Orientation(self)->'typing.Any': - """Only applies to printers, DMORIENT_PORTRAIT or DMORIENT_LANDSCAPE""" - pass - - - @property - def PaperSize(self)->'typing.Any': - """Use 0 if PaperWidth and PaperLength are set, otherwise win32con.DMPAPER_* constant""" - pass - - - @property - def PaperLength(self)->'typing.Any': - """Specified in 1/10 millimeters""" - pass - - - @property - def PaperWidth(self)->'typing.Any': - """Specified in 1/10 millimeters""" - pass - - - @property - def Position_x(self)->'typing.Any': - """Position of display relative to desktop""" - pass - - - @property - def Position_y(self)->'typing.Any': - """Position of display relative to desktop""" - pass - - - @property - def DisplayOrientation(self)->'typing.Any': - """Display rotation: DMDO_DEFAULT,DMDO_90, DMDO_180, DMDO_270""" - pass - - - @property - def DisplayFixedOutput(self)->'typing.Any': - """DMDFO_DEFAULT, DMDFO_CENTER, DMDFO_STRETCH""" - pass - - - @property - def Scale(self)->'typing.Any': - """Specified as percentage, eg 50 means half size of original""" - pass - - - @property - def Copies(self)->'typing.Any': - """Nbr of copies to print""" - pass - - - @property - def DefaultSource(self)->'typing.Any': - """DMBIN_* constant, or can be a printer-specific value""" - pass - - - @property - def PrintQuality(self)->'typing.Any': - """DMRES_* constant, interpreted as DPI if positive""" - pass - - - @property - def Color(self)->'typing.Any': - """DMCOLOR_COLOR or DMCOLOR_MONOCHROME""" - pass - - - @property - def Duplex(self)->'typing.Any': - """For printers that do two-sided printing: DMDUP_SIMPLEX, DMDUP_HORIZONTAL, DMDUP_VERTICAL""" - pass - - - @property - def YResolution(self)->'typing.Any': - """Vertical printer resolution in DPI - if this is set, PrintQuality indicates horizontal DPI""" - pass - - - @property - def TTOption(self)->'typing.Any': - """TrueType options: DMTT_BITMAP, DMTT_DOWNLOAD, DMTT_DOWNLOAD_OUTLINE, DMTT_SUBDEV""" - pass - - - @property - def Collate(self)->'typing.Any': - """DMCOLLATE_TRUE or DMCOLLATE_FALSE""" - pass - - - @property - def LogPixels(self)->'typing.Any': - """Pixels per inch (only for display devices""" - pass - - - @property - def BitsPerPel(self)->'typing.Any': - """Color resolution in bits per pixel""" - pass - - - @property - def PelsWidth(self)->'typing.Any': - """Pixel width of display""" - pass - - - @property - def PelsHeight(self)->'typing.Any': - """Pixel height of display""" - pass - - - @property - def DisplayFlags(self)->'typing.Any': - """Combination of DM_GRAYSCALE and DM_INTERLACED""" - pass - - - @property - def DisplayFrequency(self)->'typing.Any': - """Refresh rate""" - pass - - - @property - def ICMMethod(self)->'typing.Any': - """Indicates where ICM is performed, one of win32con.DMICMMETHOD_* values""" - pass - - - @property - def ICMIntent(self)->'typing.Any': - """Intent of ICM, one of win32con.DMICM_* values""" - pass - - - @property - def MediaType(self)->'typing.Any': - """win32con.DMMEDIA_*, can also be a printer-specific value greater then DMMEDIA_USER""" - pass - - - @property - def DitherType(self)->'typing.Any': - """Dithering option, win32con.DMDITHER_*""" - pass - - - @property - def Reserved1(self)->'typing.Any': - """Reserved, use only 0""" - pass - - - @property - def Reserved2(self)->'typing.Any': - """Reserved, use only 0""" - pass - - - @property - def Nup(self)->'typing.Any': - """Controls printing of multiple logical pages per physical page, DMNUP_SYSTEM or DMNUP_ONEUP""" - pass - - - @property - def PanningWidth(self)->'typing.Any': - """Not used, leave as 0""" - pass - - - @property - def PanningHeight(self)->'typing.Any': - """Not used, leave as 0""" - pass - - - @property - def DeviceName(self)->'typing.Any': - """String of at most 32 chars""" - pass - - - @property - def FormName(self)->'typing.Any': - """Name of form as returned by win32print::EnumForms, at most 32 chars""" - pass - - - @property - def DriverData(self)->'typing.Any': - """Driver data appended to end of structure""" - pass - - - def Clear(self,) -> 'None': - """ - Resets all members of the structure - -Args: - - - -Returns: - - None - - """ - pass - - -class PyDEVMODEW(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def SpecVersion(self)->'typing.Any': - """Should always be set to DM_SPECVERSION""" - pass - - - @property - def DriverVersion(self)->'typing.Any': - """Version nbr assigned to printer driver by vendor""" - pass - - - @property - def Size(self)->'typing.Any': - """Size of structure""" - pass - - - @property - def DriverExtra(self)->'typing.Any': - """Number of extra bytes allocated for driver data, can only be set when new object is created""" - pass - - - @property - def Fields(self)->'typing.Any': - """Bitmask of win32con.DM_* constants indicating which members are set""" - pass - - - @property - def Orientation(self)->'typing.Any': - """Only applies to printers, DMORIENT_PORTRAIT or DMORIENT_LANDSCAPE""" - pass - - - @property - def PaperSize(self)->'typing.Any': - """Use 0 if PaperWidth and PaperLength are set, otherwise win32con.DMPAPER_* constant""" - pass - - - @property - def PaperLength(self)->'typing.Any': - """Specified in 1/10 millimeters""" - pass - - - @property - def PaperWidth(self)->'typing.Any': - """Specified in 1/10 millimeters""" - pass - - - @property - def Position_x(self)->'typing.Any': - """Position of display relative to desktop""" - pass - - - @property - def Position_y(self)->'typing.Any': - """Position of display relative to desktop""" - pass - - - @property - def DisplayOrientation(self)->'typing.Any': - """Display rotation: DMDO_DEFAULT,DMDO_90, DMDO_180, DMDO_270""" - pass - - - @property - def DisplayFixedOutput(self)->'typing.Any': - """DMDFO_DEFAULT, DMDFO_CENTER, DMDFO_STRETCH""" - pass - - - @property - def Scale(self)->'typing.Any': - """Specified as percentage, eg 50 means half size of original""" - pass - - - @property - def Copies(self)->'typing.Any': - """Nbr of copies to print""" - pass - - - @property - def DefaultSource(self)->'typing.Any': - """DMBIN_* constant, or can be a printer-specific value""" - pass - - - @property - def PrintQuality(self)->'typing.Any': - """DMRES_* constant, interpreted as DPI if positive""" - pass - - - @property - def Color(self)->'typing.Any': - """DMCOLOR_COLOR or DMCOLOR_MONOCHROME""" - pass - - - @property - def Duplex(self)->'typing.Any': - """For printers that do two-sided printing: DMDUP_SIMPLEX, DMDUP_HORIZONTAL, DMDUP_VERTICAL""" - pass - - - @property - def YResolution(self)->'typing.Any': - """Vertical printer resolution in DPI - if this is set, PrintQuality indicates horizontal DPI""" - pass - - - @property - def TTOption(self)->'typing.Any': - """TrueType options: DMTT_BITMAP, DMTT_DOWNLOAD, DMTT_DOWNLOAD_OUTLINE, DMTT_SUBDEV""" - pass - - - @property - def Collate(self)->'typing.Any': - """DMCOLLATE_TRUE or DMCOLLATE_FALSE""" - pass - - - @property - def LogPixels(self)->'typing.Any': - """Pixels per inch (only for display devices""" - pass - - - @property - def BitsPerPel(self)->'typing.Any': - """Color resolution in bits per pixel""" - pass - - - @property - def PelsWidth(self)->'typing.Any': - """Pixel width of display""" - pass - - - @property - def PelsHeight(self)->'typing.Any': - """Pixel height of display""" - pass - - - @property - def DisplayFlags(self)->'typing.Any': - """Combination of DM_GRAYSCALE and DM_INTERLACED""" - pass - - - @property - def DisplayFrequency(self)->'typing.Any': - """Refresh rate""" - pass - - - @property - def ICMMethod(self)->'typing.Any': - """Indicates where ICM is performed, one of win32con.DMICMMETHOD_* values""" - pass - - - @property - def ICMIntent(self)->'typing.Any': - """Intent of ICM, one of win32con.DMICM_* values""" - pass - - - @property - def MediaType(self)->'typing.Any': - """win32con.DMMEDIA_*, can also be a printer-specific value greater then DMMEDIA_USER""" - pass - - - @property - def DitherType(self)->'typing.Any': - """Dithering option, win32con.DMDITHER_*""" - pass - - - @property - def Reserved1(self)->'typing.Any': - """Reserved, use only 0""" - pass - - - @property - def Reserved2(self)->'typing.Any': - """Reserved, use only 0""" - pass - - - @property - def Nup(self)->'typing.Any': - """Controls printing of multiple logical pages per physical page, DMNUP_SYSTEM or DMNUP_ONEUP""" - pass - - - @property - def PanningWidth(self)->'typing.Any': - """Not used, leave as 0""" - pass - - - @property - def PanningHeight(self)->'typing.Any': - """Not used, leave as 0""" - pass - - - @property - def DeviceName(self)->'str': - """String of at most 32 chars""" - pass - - - @property - def FormName(self)->'typing.Any': - """Name of form as returned by win32print::EnumForms, at most 32 chars""" - pass - - - @property - def DriverData(self)->'typing.Any': - """Driver data appended to end of structure""" - pass - - -class PyDISPLAY_DEVICE(object): - """Python object wrapping a DISPLAY_DEVICE structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Size(self)->'typing.Any': - """Size of structure""" - pass - - - @property - def DeviceName(self)->'typing.Any': - """String of at most 32 chars""" - pass - - - @property - def DeviceString(self)->'typing.Any': - """String of at most 128 chars""" - pass - - - @property - def StateFlags(self)->'typing.Any': - """Bitmask of win32con.DISPLAY_DEVICE_* constants indicating current device status""" - pass - - - @property - def DeviceID(self)->'typing.Any': - """String of at most 128 chars""" - pass - - - @property - def DeviceKey(self)->'typing.Any': - """String of at most 128 chars""" - pass - - - def Clear(self,) -> 'None': - """ - Resets all members of the structure - -Args: - - - -Returns: - - None - - """ - pass - - -class PyDLGITEMTEMPLATE(object): - """A tuple describing a control in a dialog box.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyDLGTEMPLATE(object): - """A tuple of items describing a dialog box, that can be used to create the dialog.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyDS_HANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyDS_NAME_RESULT_ITEM(object): - """A tuple representing a DS_NAME_RESULT_ITEM""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyDateTime(object): - """A Python object, representing an instant in time.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Format(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyDialogTemplate(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyEVTLOG_HANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyEVT_HANDLE(object): - """Handle to an event log, session, query, or any other object used with - -the Evt* event log functions on Vista and later. - -When the object is destroyed, EvtClose is called.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyEVT_RPC_LOGIN(object): - """Tuple containing login credentials for a remote Event Log connection""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyEventLogRecord(object): - """An object containing the data in an EVENTLOGRECORD.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Reserved(self)->'int': - """""" - pass - - - @property - def RecordNumber(self)->'int': - """""" - pass - - - @property - def TimeGenerated(self)->'PyTime': - """""" - pass - - - @property - def TimeWritten(self)->'PyTime': - """""" - pass - - - @property - def EventID(self)->'int': - """""" - pass - - - @property - def EventType(self)->'int': - """""" - pass - - - @property - def EventCategory(self)->'int': - """""" - pass - - - @property - def ReservedFlags(self)->'int': - """""" - pass - - - @property - def ClosingRecordNumber(self)->'int': - """""" - pass - - - @property - def SourceName(self)->'str': - """""" - pass - - - @property - def StringInserts(self)->'typing.Tuple[str, ...]': - """""" - pass - - - @property - def Sid(self)->'PySID': - """""" - pass - - - @property - def Data(self)->'str': - """""" - pass - - - @property - def ComputerName(self)->'str': - """""" - pass - - -class PyGROUP_INFO_0(object): - """A dictionary holding the information in a Win32 GROUP_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """Name of the group""" - pass - - -class PyGROUP_INFO_1(object): - """A dictionary holding the information in a Win32 GROUP_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """Name of the group""" - pass - - - @property - def comment(self)->'typing.Union[str]': - """The group's comment.""" - pass - - -class PyGROUP_INFO_1002(object): - """A dictionary holding the information in a Win32 GROUP_INFO_1002 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def comment(self)->'typing.Union[str]': - """""" - pass - - -class PyGROUP_INFO_1005(object): - """A dictionary holding the information in a Win32 GROUP_INFO_1005 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def attributes(self)->'typing.Any': - """""" - pass - - -class PyGROUP_INFO_2(object): - """A dictionary holding the information in a Win32 GROUP_INFO_2 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """Name of the group""" - pass - - - @property - def comment(self)->'typing.Union[str]': - """The group's comment.""" - pass - - - @property - def group_id(self)->'typing.Any': - """""" - pass - - - @property - def attributes(self)->'typing.Any': - """""" - pass - - -class PyGROUP_USERS_INFO_0(object): - """A dictionary holding the information in a Win32 GROUP_USERS_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """Name of the group or user""" - pass - - -class PyGROUP_USERS_INFO_1(object): - """A dictionary holding the information in a Win32 GROUP_USERS_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """Name of the group or user""" - pass - - - @property - def attributes(self)->'typing.Any': - """""" - pass - - -class PyGdiHANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyGetSignerCertificate(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyHANDLE(object): - """A Python object, representing a win32 HANDLE.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def handle(self)->'typing.Any': - """Integer value of the handleMethodsCloseCloses the handle closeSynonym for PyHANDLE::Close DetachDetaches the Win32 handle from the handle object. __nonzero__Used for detecting true/false. is nb_bool in Python 3.0 __int__Used when an integer representation of the handle object is required. __print__Used when the object is printed. tp_print __hash__Used when the hash value of an object is required tp_hash __str__Used when a string representation is required tp_str """ - pass - - - def Close(self,) -> 'None': - """ - Closes the underlying Win32 handle. - -Args: - - - -Returns: - - None - - """ - pass - - - def close(self,) -> 'None': - """ - Closes the underlying Win32 handle. - -Args: - - - -Returns: - - None - - """ - pass - - - def Detach(self,) -> 'typing.Any': - """ - Detaches the Win32 handle from the handle object. - -Args: - - - -Returns: - - typing.Any:PyHANDLE.Detach - -int = Detach()Detaches the Win32 handle from the handle object. -Comments - -After calling this function, the handle is effectively invalidated, - -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 - -handle object. -Return ValueThe result is the value of the handle before it is detached. If the - -handle is already detached, this will return zero. - - - """ - pass - - -class PyHDESK(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetThreadDesktop(self,) -> 'None': - """ - Assigns this desktop to the calling thread - -Args: - - - -Returns: - - None - - """ - pass - - - def EnumDesktopWindows(self,) -> 'typing.Tuple[int, ...]': - """ - Returns a list of handles to all top-level windows on desktop - -Args: - - - -Returns: - - typing.Tuple[int, ...] - - """ - pass - - - def SwitchDesktop(self,) -> 'None': - """ - Activates the desktop - -Args: - - - -Returns: - - None - - """ - pass - - - def CloseDesktop(self,) -> 'None': - """ - Closes the desktop handle - -Args: - - - -Returns: - - None - - """ - pass - - -class PyHDEVNOTIFY(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyHHNTRACK(object): - """A Python object, representing an HHNTRACK - -structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def action(self)->'typing.Any': - """Specifies the action the user is about to take. This is an HHACT_ constant.""" - pass - - - @property - def hdr(self)->'typing.Any': - """Standard WM_NOTIFY header(win32help::NMHDR).""" - pass - - - @property - def curUrl(self)->'str': - """A multi-byte, zero-terminated string that specifies the topic navigated to, or the name of the help window being created.""" - pass - - - @property - def winType(self)->'typing.Any': - """A pointer to the current HH_WINTYPE structure (win32help::HH_WINTYPE).""" - pass - - -class PyHHN_NOTIFY(object): - """A Python object, representing an HHN_NOTIFY - -structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def hdr(self)->'typing.Any': - """Standard WM_NOTIFY header.(win32help::NMHDR)""" - pass - - - @property - def url(self)->'str': - """A multi-byte, zero-terminated string that specifies the topic navigated to, or the name of the help window being created.""" - pass - - -class PyHH_AKLINK(object): - """A Python object, representing an HH_AKLINK structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def indexOnFail(self)->'typing.Any': - """Specifies whether to display the keyword in the Index tab of the HTML Help Viewer if the lookup fails. The value of window specifies the Help Viewer.""" - pass - - - @property - def keywords(self)->'str': - """Specifies one or more ALink names or KLink keywords to look up. Multiple entries are delimited by a semicolon.""" - pass - - - @property - def url(self)->'str': - """Specifies the topic file to navigate to if the lookup fails. url refers to a valid topic within the specified compiled help (.chm) file and does not support Internet protocols that point to an HTML file.""" - pass - - - @property - def msgText(self)->'str': - """Specifies the text to display in a message box if the lookup fails and indexOnFail is FALSE and url is NULL.""" - pass - - - @property - def msgTitle(self)->'str': - """Specifies the caption of the message box in which the msgText parameter appears.""" - pass - - - @property - def window(self)->'str': - """Specifies the name of the window type in which to display one of the following: The selected topic, if the lookup yields one or more matching topics. The topic specified in url, if the lookup fails and a topic is specified in url. The Index tab, if the lookup fails and indexOnFail is specified as TRUE.""" - pass - - -class PyHH_FTS_QUERY(object): - """A Python object, representing an HH_FTS_QUERY - -structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def uniCodeStrings(self)->'typing.Any': - """TRUE if all strings are Unicode.""" - pass - - - @property - def proximity(self)->'typing.Any': - """Word proximity.""" - pass - - - @property - def stemmedSearch(self)->'typing.Any': - """TRUE for StemmedSearch only.""" - pass - - - @property - def titleOnly(self)->'typing.Any': - """TRUE for Title search only.""" - pass - - - @property - def execute(self)->'typing.Any': - """TRUE to initiate the search.""" - pass - - - @property - def searchQuery(self)->'str': - """String containing the search query.""" - pass - - -class PyHH_POPUP(object): - """A Python object, representing an HH_POPUP structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def hinst(self)->'typing.Any': - """Instance handle of the program or DLL to retrieve the string resource from. Ignored if idString is zero.""" - pass - - - @property - def idString(self)->'typing.Any': - """Specifies zero, or a resource ID in the program or DLL specified in hinst.""" - pass - - - @property - def clrForeground(self)->'typing.Any': - """Specifies the RGB value to use for the foreground color of the pop-up window. To use the system color for the window text, specify -1.""" - pass - - - @property - def clrBackground(self)->'typing.Any': - """Specifies the RGB value to use for the background color of the pop-up window. To use the system color for the window background, specify -1.""" - pass - - - @property - def text(self)->'str': - """Specifies the text to display if idString is zero.""" - pass - - - @property - def font(self)->'str': - """Specifies the font attributes to use for the text in the pop-up window. Use the following format to specify font family, point size, character set, and font format: facename[, point size[, charset[ BOLD ITALIC UNDERLINE]]] To omit an attribute, enter a comma. For example, to specify bold, 10-pt, MS Sans Serif font, font would be: MS Sans Serif, 10, , BOLD""" - pass - - - @property - def pt(self)->'typing.Any': - """(x,y). Specifies (in pixels) where the top center of the pop-up window should be located.""" - pass - - - @property - def margins(self)->'typing.Any': - """(left,top,right,bottom). Specifies (in pixels) the margins to use on the left, top, right, and bottom sides of the pop-up window. The default for all rectangle members is -1.""" - pass - - -class PyHH_WINTYPE(object): - """A Python object, representing an HH_WINTYPE structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def uniCodeStrings(self)->'typing.Any': - """Specifies whether the strings used in this structure are UNICODE.""" - pass - - - @property - def validMembers(self)->'typing.Any': - """Specifies which members in the structure are valid.""" - pass - - - @property - def winProperties(self)->'typing.Any': - """Specifies the properties of the window, such as whether it is the standard HTML Help Viewer or whether it includes a Search tab.""" - pass - - - @property - def styles(self)->'typing.Any': - """Specifies the styles used to create the window. These styles can be ignored, combined with extended styles, or used exclusively depending on the value of the validMembers and winProperties parameters.""" - pass - - - @property - def exStyles(self)->'typing.Any': - """Specifies the extended styles used to create the window. These styles can be ignored, combined with default styles, or used exclusively depending on the value of the validMembers and winProperties parameters.""" - pass - - - @property - def showState(self)->'typing.Any': - """Specifies the initial display state of the window. Valid values are the same as those for the Win32 API ShowWindow function.""" - pass - - - @property - def hwndHelp(self)->'typing.Any': - """Specifies the handle of the window if the window has been created.""" - pass - - - @property - def hwndCaller(self)->'typing.Any': - """Specifies the window that will receive HTML Help notification messages. Notification messages are sent via Windows WM_NOTIFY messages.""" - pass - - - @property - def hwndToolBar(self)->'typing.Any': - """Specifies the handle of the toolbar.""" - pass - - - @property - def hwndNavigation(self)->'typing.Any': - """Specifies the handle of the Navigation pane.""" - pass - - - @property - def hwndHTML(self)->'typing.Any': - """Specifies the handle of the Topic pane, which hosts Shdocvw.dll.""" - pass - - - @property - def navWidth(self)->'typing.Any': - """Specifies the width of the Navigation pane when the Help Viewer is expanded.""" - pass - - - @property - def toolBarFlags(self)->'typing.Any': - """Specifies which buttons to include on the toolbar.""" - pass - - - @property - def notExpanded(self)->'typing.Any': - """Specifies that the Help Viewer open with the Navigation pane closed.""" - pass - - - @property - def curNavType(self)->'typing.Any': - """Specifies the default tab to display on the Navigation pane.""" - pass - - - @property - def idNotify(self)->'typing.Any': - """Specifies a non-zero ID for enabling HTML Help notification messages. This ID is passed as the wParam value of Windows WM_NOTIFY messages.""" - pass - - - @property - def typeName(self)->'str': - """A null-terminated string that specifies the name of the window type.""" - pass - - - @property - def caption(self)->'str': - """A null-terminated string that specifies the caption to display in the title bar of the window.""" - pass - - - @property - def windowPos(self)->'typing.Any': - """(left,top,right,bottom). Specifies the coordinates of the window in pixels.""" - pass - - - @property - def HTMLPos(self)->'typing.Any': - """(left,top,right,bottom). Specifies the coordinates of the Topic pane.""" - pass - - - @property - def toc(self)->'str': - """Specifies the contents (.hhc) file to display in the Navigation pane.""" - pass - - - @property - def index(self)->'str': - """Specifies the index (.hhk) file to display in the Navigation pane.""" - pass - - - @property - def file(self)->'str': - """Specifies the default HTML file to display in the Topic pane.""" - pass - - - @property - def home(self)->'str': - """Specifies the file or URL to display in the Topic pane when the Home button is clicked.""" - pass - - - @property - def jump1(self)->'str': - """Specifies the text to display underneath the Jump1 button.""" - pass - - - @property - def jump2(self)->'str': - """Specifies the text to display underneath the Jump2 button.""" - pass - - - @property - def urlJump1(self)->'str': - """Specifies the URL to jump to when the Jump1 button is clicked.""" - pass - - - @property - def urlJump2(self)->'str': - """Specifies the URL to jump to when the Jump2 button is clicked.""" - pass - - -class PyHINTERNET(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyHKEY(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyHTHEME(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyHWINSTA(object): - """Wrapper for a handle to a window station - returned by CreateWindowStation, OpenWindowStation, or GetProcessWindowStation""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def EnumDesktops(self,) -> 'typing.Tuple[typing.Any, ...]': - """ - Lists names of desktops in the window station - -Args: - - - -Returns: - - typing.Tuple[typing.Any, ...] - - """ - pass - - - def SetProcessWindowStation(self,) -> 'None': - """ - Associates the calling process with the window station - -Args: - - - -Returns: - - None - - """ - pass - - - def CloseWindowStation(self,) -> 'None': - """ - Closes the window station handle - -Args: - - - -Returns: - - None - - """ - pass - - -class PyICONINFO(object): - """Tuple describing an icon or cursor""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIID(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyINPUT_RECORD(object): - """Interface to the INPUT_RECORD struct used with console IO functions. Create using - -PyINPUT_RECORDType(EventType)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def EventType(self)->'typing.Any': - """One of KEY_EVENT, MOUSE_EVENT, WINDOW_BUFFER_SIZE_EVENT, MENU_EVENT, FOCUS_EVENT. Cannot be changed after object is created""" - pass - - - @property - def KeyDown(self)->'typing.Any': - """True for a key press, False for key release""" - pass - - - @property - def RepeatCount(self)->'typing.Any': - """Nbr of repeats generated (key was held down if >1)""" - pass - - - @property - def VirtualKeyCode(self)->'typing.Any': - """Device-independent key code, win32con.VK_*""" - pass - - - @property - def VirtualScanCode(self)->'typing.Any': - """Device-dependent scan code generated by keyboard""" - pass - - - @property - def Char(self)->'str': - """Single unicode character generated by the keypress""" - pass - - - @property - def ControlKeyState(self)->'typing.Any': - """State of modifier keys, combination of CAPSLOCK_ON, ENHANCED_KEY, LEFT_ALT_PRESSED, LEFT_CTRL_PRESSED, NUMLOCK_ON, RIGHT_ALT_PRESSED, RIGHT_CTRL_PRESSED, SCROLLLOCK_ON, SHIFT_PRESSED""" - pass - - - @property - def ButtonState(self)->'typing.Any': - """Bitmask representing which mouse buttons were pressed.""" - pass - - - @property - def EventFlags(self)->'typing.Any': - """DOUBLE_CLICK, MOUSE_MOVED or MOUSE_WHEELED, or 0. If 0, indicates a mouse button press""" - pass - - - @property - def MousePosition(self)->'PyCOORD': - """Position in character coordinates""" - pass - - - @property - def Size(self)->'PyCOORD': - """New size of screen buffer in character rows/columns""" - pass - - - @property - def SetFocus(self)->'typing.Any': - """Reserved - Used only with type FOCUS_EVENT. This event is Reserved, and should be ignored.""" - pass - - - @property - def CommandId(self)->'typing.Any': - """Used only with event type MENU_EVENT, which is reserved and should not be used""" - pass - - -class PyLOCALGROUP_INFO_0(object): - """A dictionary holding the information in a Win32 LOCALGROUP_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """Name of the group""" - pass - - -class PyLOCALGROUP_INFO_1(object): - """A dictionary holding the information in a Win32 LOCALGROUP_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """Name of the group""" - pass - - - @property - def comment(self)->'typing.Union[str]': - """The group's comment.""" - pass - - -class PyLOCALGROUP_INFO_1002(object): - """A dictionary holding the information in a Win32 LOCALGROUP_INFO_1002 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def comment(self)->'typing.Union[str]': - """""" - pass - - -class PyLOCALGROUP_MEMBERS_INFO_0(object): - """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_0 - -structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def sid(self)->'PySID': - """""" - pass - - -class PyLOCALGROUP_MEMBERS_INFO_1(object): - """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_1 - -structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def sid(self)->'PySID': - """""" - pass - - - @property - def sidusage(self)->'typing.Any': - """""" - pass - - - @property - def name(self)->'typing.Union[str]': - """""" - pass - - -class PyLOCALGROUP_MEMBERS_INFO_2(object): - """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_2 - -structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def sid(self)->'PySID': - """""" - pass - - - @property - def sidusage(self)->'typing.Any': - """""" - pass - - - @property - def domainandname(self)->'typing.Union[str]': - """string containing the name of the member prefixed by the domain name and the "\\" separator character""" - pass - - -class PyLOCALGROUP_MEMBERS_INFO_3(object): - """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_3 - -structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def domainandname(self)->'typing.Union[str]': - """string containing the name of the member prefixed by the domain name and the "\\" separator character""" - pass - - -class PyLOGBRUSH(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Style(self)->'typing.Any': - """Brush style, one of win32con.BS_* values""" - pass - - - @property - def Color(self)->'typing.Any': - """RGB color value. Can also be DIB_PAL_COLORS or DIB_RGB_COLORS if Style is BS_DIBPATTERN or BS_DIBPATTERNPT=""" - pass - - - @property - def Hatch(self)->'typing.Union[int, typing.Any]': - """For BS_HATCH style, one of win32con.HS_*. Not used For BS_SOLID or BS_HOLLOW. For a pattern brush, this should be a handle to a bitmap""" - pass - - -class PyLOGFONT(object): - """A Python object, representing an PyLOGFONT structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def lfHeight(self)->'int': - """""" - pass - - - @property - def lfWidth(self)->'int': - """""" - pass - - - @property - def lfEscapement(self)->'int': - """""" - pass - - - @property - def lfOrientation(self)->'int': - """""" - pass - - - @property - def lfWeight(self)->'int': - """""" - pass - - - @property - def lfItalic(self)->'int': - """""" - pass - - - @property - def lfUnderline(self)->'int': - """""" - pass - - - @property - def lfStrikeOut(self)->'int': - """""" - pass - - - @property - def lfCharSet(self)->'int': - """""" - pass - - - @property - def lfOutPrecision(self)->'int': - """""" - pass - - - @property - def lfClipPrecision(self)->'int': - """""" - pass - - - @property - def lfQuality(self)->'int': - """""" - pass - - - @property - def lfPitchAndFamily(self)->'int': - """""" - pass - - - @property - def lfFaceName(self)->'str': - """Name of the typeface, at most 31 characters""" - pass - - -class PyLSA_HANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyLUID_AND_ATTRIBUTES(object): - """A sequence containing (LUID,Attributes) representing an LUID_AND_ATTRIBUTES structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyLsaLogon_HANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyMSG(object): - """A tuple representing a win32 MSG structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyNETRESOURCE(object): - """A Python object that encapsulates a Win32 NETRESOURCE structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwScope(self)->'int': - """""" - pass - - - @property - def dwType(self)->'int': - """""" - pass - - - @property - def dwDisplayType(self)->'int': - """""" - pass - - - @property - def dwUsage(self)->'int': - """""" - pass - - - @property - def localName(self)->'str': - """""" - pass - - - @property - def remoteName(self)->'str': - """""" - pass - - - @property - def comment(self)->'str': - """""" - pass - - - @property - def provider(self)->'str': - """""" - pass - - -class PyNET_VALIDATE_AUTHENTICATION_INPUT_ARG(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyNET_VALIDATE_PASSWORD_CHANGE_INPUT_ARG(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyNET_VALIDATE_PERSISTED_FIELDS(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyNMHDR(object): - """A Python object, representing an NMHDR - -structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def hwndFrom(self)->'typing.Any': - """Window handle to the control sending a message. ??? 64-bit problem here ???""" - pass - - - @property - def idFrom(self)->'typing.Any': - """Identifier of the control sending a message.""" - pass - - - @property - def code(self)->'typing.Any': - """Notification code. This member can be a control-specific notification code or it can be one of the common notification codes.""" - pass - - -class PyNOTIFYICONDATA(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyOVERLAPPED(object): - """A Python object, representing an overlapped structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Offset(self)->'int': - """Specifies a file position at which to start the transfer. The file position is a byte offset from the start of the file. The calling process sets this member before calling the ReadFile or WriteFile function. This member is ignored when reading from or writing to named pipes and communications devices.""" - pass - - - @property - def OffsetHigh(self)->'int': - """Specifies the high word of the byte offset at which to start the transfer.""" - pass - - - @property - def object(self)->'typing.Any': - """Any python object that you want to attach to your overlapped I/O request.""" - pass - - - @property - def dword(self)->'typing.Any': - """An integer buffer that may be used by overlapped functions (eg, win32file::WaitCommEvent)""" - pass - - - @property - def hEvent(self)->'int': - """Identifies an event set to the signaled state when the transfer has been completed. The calling process sets this member before calling the win32file::ReadFile, win32file::WriteFile, win32pipe::ConnectNamedPipe, or win32pipe::TransactNamedPipe function.""" - pass - - - @property - def Internal(self)->'int': - """Reserved for operating system use. (pointer-sized value)""" - pass - - - @property - def InternalHigh(self)->'int': - """Reserved for operating system use. (pointer-sized value)""" - pass - - -class PyOVERLAPPEDReadBuffer(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyPERF_COUNTER_DEFINITION(object): - """An object encapsulating a Windows NT Performance Monitor counter definition - -(PERF_COUNTER_DEFINITION).""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def DefaultScale(self)->'int': - """The default scale of the counter.""" - pass - - - @property - def DetailLevel(self)->'int': - """The detail level of the counter.""" - pass - - - @property - def CounterType(self)->'int': - """The counter type.""" - pass - - - @property - def CounterNameTitleIndex(self)->'int': - """""" - pass - - - @property - def CounterHelpTitleIndex(self)->'int': - """Sentinel""" - pass - - - def Increment(self,) -> 'None': - """ - Increments the value of the performance counter - -Args: - - - -Returns: - - None - - """ - pass - - - def Decrement(self,) -> 'None': - """ - Decrements the value of the performance counter - -Args: - - - -Returns: - - None - - """ - pass - - - def Set(self,) -> 'None': - """ - Sets the counter to a specific value - -Args: - - - -Returns: - - None - - """ - pass - - - def Get(self,) -> 'None': - """ - Gets the current value of the counter - -Args: - - - -Returns: - - None - - """ - pass - - -class PyPERF_OBJECT_TYPE(object): - """A Python object, representing a PERF_OBJECT_TYPE structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ObjectNameTitleIndex(self)->'int': - """""" - pass - - - @property - def ObjectHelpTitleIndex(self)->'int': - """""" - pass - - - @property - def DefaultCounterIndex(self)->'int': - """""" - pass - - - def Close(self,) -> 'None': - """ - Closes the object. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyPOINT(object): - """Tuple of two ints (x,y) representing a POINT struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyPROFILEINFO(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def UserName(self)->'str': - """Name of user for which to load profile""" - pass - - - @property - def Flags(self)->'typing.Any': - """Combination of PI_* flags""" - pass - - - @property - def ProfilePath(self)->'str': - """Path to roaming profile, can be None. Use win32net::NetUserGetInfo to retrieve user's profile path""" - pass - - - @property - def DefaultPath(self)->'str': - """Path to Default user profile, can be None""" - pass - - - @property - def ServerName(self)->'str': - """Domain controller, can be None""" - pass - - - @property - def PolicyPath(self)->'str': - """Location of policy file, can be None""" - pass - - - @property - def Profile(self)->'PyHKEY': - """Handle to root of user's registry key. This member is output.""" - pass - - -class PyPerfMonManager(object): - """A Python object""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Close(self,) -> 'None': - """ - Closes the performance monitor manager. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyPrinterHANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyRECT(object): - """Tuple of 4 ints defining a rectangle: (left, top, right, bottom)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyResourceId(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySCROLLINFO(object): - """A tuple representing a SCROLLINFO structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySC_HANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySECURITY_ATTRIBUTES(object): - """A Python object, representing a SECURITY_ATTRIBUTES structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def bInheritHandle(self)->'typing.Any': - """Specifies whether the returned handle is inherited when a new process is created. If this member is TRUE, the new process inherits the handle.""" - pass - - - @property - def SECURITY_DESCRIPTOR(self)->'PySECURITY_DESCRIPTOR': - """A PySECURITY_DESCRIPTOR, or None""" - pass - - -class PySECURITY_DESCRIPTOR(object): - """A Python object, representing a SECURITY_DESCRIPTOR structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,) -> 'None': - """ - Initialize the SD. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetSecurityDescriptorOwner(self,) -> 'PySID': - """ - Return the owner of the security descriptor. - -Args: - - - -Returns: - - PySID - - """ - pass - - - def GetSecurityDescriptorDacl(self,) -> 'PyACL': - """ - Return the discretionary ACL of the security - -descriptor. - -Args: - - - -Returns: - - PyACL - - """ - pass - - - def GetSecurityDescriptorSacl(self,) -> 'PyACL': - """ - Return system access control list (SACL) of SD - -Args: - - - -Returns: - - PyACL - - """ - pass - - - def GetSecurityDescriptorControl(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Returns tuple of Control bit flags and - -revision of SD. - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def SetSecurityDescriptorOwner(self,sid:'PySID',bOwnerDefaulted:'typing.Any') -> 'None': - """ - Set owner SID. - -Args: - - sid(PySID):The sid to be set as owner in the security descriptor. - bOwnerDefaulted(typing.Any):Normally set to false since this explicitely set the owner. - -Returns: - - None - - """ - pass - - - def SetSecurityDescriptorGroup(self,sid:'PySID',bOwnerDefaulted:'typing.Any') -> 'typing.Any': - """ - Set group SID. - -Args: - - sid(PySID):The group sid to be set in the security descriptor. - bOwnerDefaulted(typing.Any):Normally set to false since this explicitely set the owner. - -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 - -descriptor. - -Args: - - bSaclPresent(typing.Any):A flag indicating if SACL is to be used. If false, last 2 parms are ignored. - SACL(PyACL):The SACL to set in the security descriptor - bSaclDefaulted(typing.Any):Flag, set to false if user has specifically set the SACL. - -Returns: - - None - - """ - pass - - - def IsValid(self,) -> 'None': - """ - Determines if the security descriptor is valid. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetLength(self,) -> 'None': - """ - return length of security descriptor (GetSecurityDescriptorLenght). - -Args: - - - -Returns: - - None - - """ - pass - - - def IsSelfRelative(self,) -> 'None': - """ - Returns 1 if security descriptor is self relative, 0 if absolute - -Args: - - - -Returns: - - None - - """ - pass - - - def SetSecurityDescriptorControl(self,ControlBitsOfInterest:'typing.Any',ControlBitsToSet:'typing.Any') -> 'None': - """ - Sets the control bit flags related to inheritance for a - -security descriptor - -Args: - - ControlBitsOfInterest(typing.Any):Bitmask of flags to be modified - ControlBitsToSet(typing.Any):Bitmask containing flag values to setCommentsOnly exists on Windows 2000 or later - -Returns: - - None - - """ - pass - - -class PySERVER_INFO_100(object): - """A dictionary holding the information in a Win32 SERVER_INFO_100 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def platform_id(self)->'typing.Any': - """""" - pass - - - @property - def name(self)->'typing.Union[str]': - """""" - pass - - -class PySERVER_INFO_101(object): - """A dictionary holding the information in a Win32 SERVER_INFO_101 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def platform_id(self)->'typing.Any': - """""" - pass - - - @property - def name(self)->'typing.Union[str]': - """""" - pass - - - @property - def version_major(self)->'typing.Any': - """""" - pass - - - @property - def version_minor(self)->'typing.Any': - """""" - pass - - - @property - def type(self)->'typing.Any': - """one of the SV_TYPE_* constants""" - pass - - - @property - def comment(self)->'typing.Union[str]': - """""" - pass - - -class PySERVER_INFO_102(object): - """A dictionary holding the information in a Win32 SERVER_INFO_102 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def platform_id(self)->'typing.Any': - """""" - pass - - - @property - def name(self)->'typing.Union[str]': - """""" - pass - - - @property - def version_major(self)->'typing.Any': - """""" - pass - - - @property - def version_minor(self)->'typing.Any': - """""" - pass - - - @property - def type(self)->'typing.Any': - """one of the SV_TYPE_* constants""" - pass - - - @property - def comment(self)->'typing.Union[str]': - """""" - pass - - - @property - def users(self)->'typing.Any': - """""" - pass - - - @property - def disc(self)->'typing.Any': - """""" - pass - - - @property - def hidden(self)->'typing.Any': - """""" - pass - - - @property - def announce(self)->'typing.Any': - """""" - pass - - - @property - def anndelta(self)->'typing.Any': - """""" - pass - - - @property - def userpath(self)->'typing.Union[str]': - """""" - pass - - -class PySERVER_INFO_402(object): - """A dictionary holding the information in a Win32 SERVER_INFO_402 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ulist_mtime(self)->'typing.Any': - """""" - pass - - - @property - def glist_mtime(self)->'typing.Any': - """""" - pass - - - @property - def alist_mtime(self)->'typing.Any': - """""" - pass - - - @property - def security(self)->'typing.Any': - """""" - pass - - - @property - def numadmin(self)->'typing.Any': - """""" - pass - - - @property - def lanmask(self)->'typing.Any': - """""" - pass - - - @property - def guestacct(self)->'typing.Union[str]': - """""" - pass - - - @property - def chdevs(self)->'typing.Any': - """""" - pass - - - @property - def chdevq(self)->'typing.Any': - """""" - pass - - - @property - def chdevjobs(self)->'typing.Any': - """""" - pass - - - @property - def connections(self)->'typing.Any': - """""" - pass - - - @property - def shares(self)->'typing.Any': - """""" - pass - - - @property - def openfiles(self)->'typing.Any': - """""" - pass - - - @property - def sessopens(self)->'typing.Any': - """""" - pass - - - @property - def sessvcs(self)->'typing.Any': - """""" - pass - - - @property - def sessreqs(self)->'typing.Any': - """""" - pass - - - @property - def opensearch(self)->'typing.Any': - """""" - pass - - - @property - def activelocks(self)->'typing.Any': - """""" - pass - - - @property - def numreqbuf(self)->'typing.Any': - """""" - pass - - - @property - def sizreqbuf(self)->'typing.Any': - """""" - pass - - - @property - def numbigbuf(self)->'typing.Any': - """""" - pass - - - @property - def numfiletasks(self)->'typing.Any': - """""" - pass - - - @property - def alertsched(self)->'typing.Any': - """""" - pass - - - @property - def erroralert(self)->'typing.Any': - """""" - pass - - - @property - def logonalert(self)->'typing.Any': - """""" - pass - - - @property - def accessalert(self)->'typing.Any': - """""" - pass - - - @property - def diskalert(self)->'typing.Any': - """""" - pass - - - @property - def netioalert(self)->'typing.Any': - """""" - pass - - - @property - def maxauditsz(self)->'typing.Any': - """""" - pass - - - @property - def srvheuristics(self)->'typing.Union[str]': - """""" - pass - - -class PySERVER_INFO_403(object): - """A dictionary holding the information in a Win32 SERVER_INFO_403 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ulist_mtime(self)->'typing.Any': - """""" - pass - - - @property - def glist_mtime(self)->'typing.Any': - """""" - pass - - - @property - def alist_mtime(self)->'typing.Any': - """""" - pass - - - @property - def security(self)->'typing.Any': - """""" - pass - - - @property - def numadmin(self)->'typing.Any': - """""" - pass - - - @property - def lanmask(self)->'typing.Any': - """""" - pass - - - @property - def guestacct(self)->'typing.Union[str]': - """""" - pass - - - @property - def chdevs(self)->'typing.Any': - """""" - pass - - - @property - def chdevq(self)->'typing.Any': - """""" - pass - - - @property - def chdevjobs(self)->'typing.Any': - """""" - pass - - - @property - def connections(self)->'typing.Any': - """""" - pass - - - @property - def shares(self)->'typing.Any': - """""" - pass - - - @property - def openfiles(self)->'typing.Any': - """""" - pass - - - @property - def sessopens(self)->'typing.Any': - """""" - pass - - - @property - def sessvcs(self)->'typing.Any': - """""" - pass - - - @property - def sessreqs(self)->'typing.Any': - """""" - pass - - - @property - def opensearch(self)->'typing.Any': - """""" - pass - - - @property - def activelocks(self)->'typing.Any': - """""" - pass - - - @property - def numreqbuf(self)->'typing.Any': - """""" - pass - - - @property - def sizreqbuf(self)->'typing.Any': - """""" - pass - - - @property - def numbigbuf(self)->'typing.Any': - """""" - pass - - - @property - def numfiletasks(self)->'typing.Any': - """""" - pass - - - @property - def alertsched(self)->'typing.Any': - """""" - pass - - - @property - def erroralert(self)->'typing.Any': - """""" - pass - - - @property - def logonalert(self)->'typing.Any': - """""" - pass - - - @property - def accessalert(self)->'typing.Any': - """""" - pass - - - @property - def diskalert(self)->'typing.Any': - """""" - pass - - - @property - def netioalert(self)->'typing.Any': - """""" - pass - - - @property - def maxauditsz(self)->'typing.Any': - """""" - pass - - - @property - def srvheuristics(self)->'typing.Union[str]': - """""" - pass - - - @property - def auditedevents(self)->'typing.Any': - """""" - pass - - - @property - def autoprofile(self)->'typing.Any': - """""" - pass - - - @property - def autopath(self)->'typing.Union[str]': - """""" - pass - - -class PySERVER_INFO_502(object): - """A dictionary holding the information in a Win32 SERVER_INFO_502 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def sessopens(self)->'typing.Any': - """""" - pass - - - @property - def sessvcs(self)->'typing.Any': - """""" - pass - - - @property - def opensearch(self)->'typing.Any': - """""" - pass - - - @property - def sizreqbuf(self)->'typing.Any': - """""" - pass - - - @property - def initworkitems(self)->'typing.Any': - """""" - pass - - - @property - def maxworkitems(self)->'typing.Any': - """""" - pass - - - @property - def rawworkitems(self)->'typing.Any': - """""" - pass - - - @property - def irpstacksize(self)->'typing.Any': - """""" - pass - - - @property - def maxrawbuflen(self)->'typing.Any': - """""" - pass - - - @property - def sessusers(self)->'typing.Any': - """""" - pass - - - @property - def sessconns(self)->'typing.Any': - """""" - pass - - - @property - def maxpagedmemoryusage(self)->'typing.Any': - """""" - pass - - - @property - def maxnonpagedmemoryusage(self)->'typing.Any': - """""" - pass - - - @property - def enableforcedlogoff(self)->'typing.Any': - """""" - pass - - - @property - def timesource(self)->'typing.Any': - """""" - pass - - - @property - def acceptdownlevelapis(self)->'typing.Any': - """""" - pass - - - @property - def lmannounce(self)->'typing.Any': - """""" - pass - - -class PySERVER_INFO_503(object): - """A dictionary holding the information in a Win32 SERVER_INFO_503 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def sessopens(self)->'typing.Any': - """""" - pass - - - @property - def sessvcs(self)->'typing.Any': - """""" - pass - - - @property - def opensearch(self)->'typing.Any': - """""" - pass - - - @property - def sizreqbuf(self)->'typing.Any': - """""" - pass - - - @property - def initworkitems(self)->'typing.Any': - """""" - pass - - - @property - def maxworkitems(self)->'typing.Any': - """""" - pass - - - @property - def rawworkitems(self)->'typing.Any': - """""" - pass - - - @property - def irpstacksize(self)->'typing.Any': - """""" - pass - - - @property - def maxrawbuflen(self)->'typing.Any': - """""" - pass - - - @property - def sessusers(self)->'typing.Any': - """""" - pass - - - @property - def sessconns(self)->'typing.Any': - """""" - pass - - - @property - def maxpagedmemoryusage(self)->'typing.Any': - """""" - pass - - - @property - def maxnonpagedmemoryusage(self)->'typing.Any': - """""" - pass - - - @property - def enableforcedlogoff(self)->'typing.Any': - """""" - pass - - - @property - def timesource(self)->'typing.Any': - """""" - pass - - - @property - def acceptdownlevelapis(self)->'typing.Any': - """""" - pass - - - @property - def lmannounce(self)->'typing.Any': - """""" - pass - - - @property - def domain(self)->'typing.Union[str]': - """""" - pass - - - @property - def maxkeepsearch(self)->'typing.Any': - """""" - pass - - - @property - def scavtimeout(self)->'typing.Any': - """""" - pass - - - @property - def minrcvqueue(self)->'typing.Any': - """""" - pass - - - @property - def minfreeworkitems(self)->'typing.Any': - """""" - pass - - - @property - def xactmemsize(self)->'typing.Any': - """""" - pass - - - @property - def threadpriority(self)->'typing.Any': - """""" - pass - - - @property - def maxmpxct(self)->'typing.Any': - """""" - pass - - - @property - def oplockbreakwait(self)->'typing.Any': - """""" - pass - - - @property - def oplockbreakresponsewait(self)->'typing.Any': - """""" - pass - - - @property - def enableoplocks(self)->'typing.Any': - """""" - pass - - - @property - def enablefcbopens(self)->'typing.Any': - """""" - pass - - - @property - def enableraw(self)->'typing.Any': - """""" - pass - - - @property - def enablesharednetdrives(self)->'typing.Any': - """""" - pass - - - @property - def minfreeconnections(self)->'typing.Any': - """""" - pass - - - @property - def maxfreeconnections(self)->'typing.Any': - """""" - pass - - -class PySHARE_INFO_0(object): - """A dictionary holding the infomation in a Win32 SHARE_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def netname(self)->'typing.Union[str]': - """""" - pass - - -class PySHARE_INFO_1(object): - """A dictionary holding the infomation in a Win32 SHARE_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def netname(self)->'typing.Union[str]': - """""" - pass - - - @property - def type(self)->'typing.Any': - """""" - pass - - - @property - def remark(self)->'typing.Union[str]': - """""" - pass - - -class PySHARE_INFO_2(object): - """A dictionary holding the infomation in a Win32 SHARE_INFO_2 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def netname(self)->'typing.Union[str]': - """""" - pass - - - @property - def type(self)->'typing.Any': - """""" - pass - - - @property - def remark(self)->'typing.Union[str]': - """""" - pass - - - @property - def permissions(self)->'typing.Any': - """""" - pass - - - @property - def max_uses(self)->'typing.Any': - """""" - pass - - - @property - def current_uses(self)->'typing.Any': - """""" - pass - - - @property - def path(self)->'typing.Union[str]': - """""" - pass - - - @property - def passwd(self)->'typing.Union[str]': - """""" - pass - - -class PySHARE_INFO_501(object): - """A dictionary holding the infomation in a Win32 SHARE_INFO_501 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def netname(self)->'typing.Union[str]': - """""" - pass - - - @property - def type(self)->'typing.Any': - """""" - pass - - - @property - def remark(self)->'typing.Union[str]': - """""" - pass - - - @property - def flags(self)->'typing.Any': - """""" - pass - - -class PySHARE_INFO_502(object): - """A dictionary holding the infomation in a Win32 SHARE_INFO_502 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def netname(self)->'typing.Union[str]': - """""" - pass - - - @property - def type(self)->'typing.Any': - """""" - pass - - - @property - def remark(self)->'typing.Union[str]': - """""" - pass - - - @property - def permissions(self)->'typing.Any': - """""" - pass - - - @property - def max_uses(self)->'typing.Any': - """""" - pass - - - @property - def current_uses(self)->'typing.Any': - """""" - pass - - - @property - def path(self)->'typing.Union[str]': - """""" - pass - - - @property - def passwd(self)->'typing.Union[str]': - """""" - pass - - - @property - def reserved(self)->'typing.Any': - """""" - pass - - - @property - def security_descriptor(self)->'PySECURITY_DESCRIPTOR': - """""" - pass - - -class PySID(object): - """A Python object, representing a SID structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,idAuthority:'typing.Any',numSubauthorities:'typing.Any') -> 'None': - """ - Initialize the SID. - -Args: - - idAuthority(typing.Any):The identifier authority. - numSubauthorities(typing.Any):The number of sub authorities to allocate. - -Returns: - - None - - """ - pass - - - def IsValid(self,) -> 'None': - """ - Determines if the SID is valid. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetSubAuthority(self,index:'typing.Any',val:'typing.Any') -> 'None': - """ - Sets a SID SubAuthority - -Args: - - index(typing.Any):The index of the sub authority to set - val(typing.Any):The value for the sub authorityCommentsSee the function SetSidSubAuthority - -Returns: - - None - - """ - pass - - - def GetLength(self,) -> 'typing.Any': - """ - return length of SID (GetLengthSid). - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetSubAuthorityCount(self,) -> 'typing.Any': - """ - return nbr of subauthorities from SID - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetSubAuthority(self,) -> 'typing.Any': - """ - Returns specified subauthority from SID - -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 - -constants - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any, typing.Any, typing.Any] - - """ - pass - - -class PySID_AND_ATTRIBUTES(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySIZE(object): - """Tuple of two ints (cx,cy) representing a SIZE struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySMALL_RECT(object): - """Wrapper for a SMALL_RECT struct - -Create using PySMALL_RECTType(Left, Top, Right, Bottom). All params optional, defaulting to 0""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Left(self)->'typing.Any': - """Left side of rectangle""" - pass - - - @property - def Top(self)->'typing.Any': - """Top edge of rectangle""" - pass - - - @property - def Right(self)->'typing.Any': - """Right edge of rectangle""" - pass - - - @property - def Bottom(self)->'typing.Any': - """Bottome edge of rectangle""" - pass - - -class PySTARTUPINFO(object): - """A Python object, representing an STARTUPINFO structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwX(self)->'int': - """Specifies the x offset, in pixels, of the upper left corner of a window if a new window is created. The offset is from the upper left corner of the screen.""" - pass - - - @property - def dwY(self)->'int': - """Specifies the y offset, in pixels, of the upper left corner of a window if a new window is created. The offset is from the upper left corner of the screen.""" - pass - - - @property - def dwXSize(self)->'int': - """Specifies the width, in pixels, of the window if a new window is created.""" - pass - - - @property - def dwYSize(self)->'int': - """Specifies the height, in pixels, of the window if a new window is created.""" - pass - - - @property - def dwXCountChars(self)->'int': - """For console processes, if a new console window is created, specifies the screen buffer width in character columns. This value is ignored in a GUI process.""" - pass - - - @property - def dwYCountChars(self)->'int': - """For console processes, if a new console window is created, specifies the screen buffer height in character rows.""" - pass - - - @property - def dwFillAttribute(self)->'int': - """Specifies the initial text and background colors if a new console window is created in a console application. These values are ignored in GUI applications""" - pass - - - @property - def dwFlags(self)->'int': - """This is a bit field that determines whether certain STARTUPINFO attributes are used when the process creates a window. To use many of the additional attributes, you typically must set the appropriate mask in this attribute, and also set the attributes themselves. Any combination of the win32con.STARTF_* flags can be specified.""" - pass - - - @property - def wShowWindow(self)->'int': - """Can be any of the SW_ constants defined in win32con. For GUI processes, this specifies the default value the first time ShowWindow is called.""" - pass - - - @property - def hStdInput(self)->'typing.Union[int]': - """""" - pass - - - @property - def hStdOutput(self)->'typing.Union[int]': - """""" - pass - - - @property - def hStdError(self)->'typing.Union[int]': - """""" - pass - - - @property - def lpDesktop(self)->'typing.Union[str, typing.Any]': - """""" - pass - - - @property - def lpTitle(self)->'typing.Union[str, typing.Any]': - """""" - pass - - -class PySecBuffer(object): - """Python object wrapping a SecBuffer structure - -Created using win32security.PySecBufferType(type,size) where type is a SECBUFFER_* constant""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def BufferType(self)->'typing.Any': - """""" - pass - - - @property - def Buffer(self)->'str': - """""" - pass - - - @property - def BufferSize(self)->'typing.Any': - """""" - pass - - - @property - def MaxBufferSize(self)->'typing.Any': - """""" - pass - - - def Clear(self,) -> 'None': - """ - Resets the buffer to all NULL's, and set the current size to maximum - -Args: - - - -Returns: - - None - - """ - pass - - -class PySecBufferDesc(object): - """Sequence-like object that contains a group of buffers to be used with SSPI functions.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def append(self,buffer:'typing.Any') -> 'None': - """ - None - -Args: - - buffer(typing.Any):PySecBuffer object to be attached to the group of buffers - -Returns: - - None - - """ - pass - - -class PyTOKEN_GROUPS(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyTOKEN_PRIVILEGES(object): - """An object representing Win32 token privileges.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyTRIVERTEX(object): - """Dict representing a TRIVERTEX struct containing color information at a point""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def x(self)->'typing.Any': - """X coord in logical units""" - pass - - - @property - def y(self)->'typing.Any': - """Y coord in logical units""" - pass - - - @property - def Red(self)->'typing.Any': - """Red component""" - pass - - - @property - def Green(self)->'typing.Any': - """Green component""" - pass - - - @property - def Blue(self)->'typing.Any': - """Blue component""" - pass - - - @property - def Alpha(self)->'typing.Any': - """Transparency value""" - pass - - -class PyTRUSTEE(object): - """A dictionary representing a TRUSTEE structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def TrusteeForm(self)->'typing.Any': - """""" - pass - - - @property - def TrusteeType(self)->'typing.Any': - """""" - pass - - - @property - def Identifier(self)->'typing.Any': - """Depends on the value of TrusteeForm (string or sid)""" - pass - - - @property - def MultipleTrustee(self)->'typing.Any': - """default is None""" - pass - - - @property - def MultipleTrusteeOperation(self)->'typing.Any': - """default is None""" - pass - - -class PyTS_HANDLE(object): - """Handle to a Terminal Server""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyTime(object): - """A Python object, representing an instant in time.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def year(self)->'typing.Any': - """""" - pass - - - @property - def month(self)->'typing.Any': - """""" - pass - - - @property - def weekday(self)->'typing.Any': - """""" - pass - - - @property - def day(self)->'typing.Any': - """""" - pass - - - @property - def hour(self)->'typing.Any': - """""" - pass - - - @property - def minute(self)->'typing.Any': - """""" - pass - - - @property - def second(self)->'typing.Any': - """""" - pass - - - @property - def msec(self)->'typing.Any': - """""" - pass - - - def Format(self,_format:'str') -> 'str': - """ - Formats the time value. - -Args: - - _format(str):The format. See the comments section for a description of the supported flags.CommentsThe following format characters are supported.CharacterDescription%aAbbreviated weekday name%AFull weekday name%bAbbreviated month name%BFull month name%cDate and time representation appropriate for locale%dDay of month as decimal number (01 - 31)%HHour in 24-hour format (00 - 23)%IHour in 12-hour format (01 - 12)%jDay of year as decimal number (001 - 366)%mMonth as decimal number (01 - 12)%MMinute as decimal number (00 - 59)%pCurrent locale's A.M./P.M. indicator for 12-hour clock%SSecond as decimal number (00 - 59)%UWeek of year as decimal number, with Sunday as first day of week (00 - 51)%wWeekday as decimal number (0 - 6; Sunday is 0)%WWeek of year as decimal number, with Monday as first day of week (00 - 51)%xDate representation for current locale%XTime representation for current locale%yYear without century, as decimal number (00 - 99)%YYear with century, as decimal number%z, %ZTime-zone name or abbreviation; no characters if time zone is unknown%%Percent signAs in the printf function, the # flag may prefix any formatting code. In that case, the meaning of the format code is changed as follows.Format CodeMeaning%#a, %#A, %#b, %#B, %#p, %#X, %#z, %#Z, %#%# flag is ignored.%#cLong date and time representation, appropriate for current locale. For example: "Tuesday, March 14, 1995, 12:41:29".%#xLong date representation, appropriate to current locale. For example: "Tuesday, March 14, 1995".%#d, %#H, %#I, %#j, %#m, %#M, %#S, %#U, %#w, %#W, %#y, %#YRemove leading zeros (if any). - -Returns: - - str - - """ - pass - - -class PyUSER_INFO_0(object): - """A dictionary holding the information in a Win32 USER_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """""" - pass - - -class PyUSER_INFO_1(object): - """A dictionary holding the information in a Win32 USER_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """""" - pass - - - @property - def password(self)->'typing.Union[str]': - """""" - pass - - - @property - def password_age(self)->'typing.Any': - """""" - pass - - - @property - def priv(self)->'typing.Any': - """""" - pass - - - @property - def home_dir(self)->'typing.Union[str]': - """""" - pass - - - @property - def comment(self)->'typing.Union[str]': - """""" - pass - - - @property - def flags(self)->'typing.Any': - """""" - pass - - - @property - def script_path(self)->'typing.Union[str]': - """""" - pass - - -class PyUSER_INFO_10(object): - """A dictionary holding the information in a Win32 USER_INFO_10 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """""" - pass - - - @property - def comment(self)->'typing.Union[str]': - """""" - pass - - - @property - def usr_comment(self)->'typing.Union[str]': - """""" - pass - - - @property - def full_name(self)->'typing.Union[str]': - """""" - pass - - -class PyUSER_INFO_1003(object): - """A dictionary holding the information in a Win32 USER_INFO_1003 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def password(self)->'typing.Union[str]': - """""" - pass - - -class PyUSER_INFO_1005(object): - """A dictionary holding the information in a Win32 USER_INFO_1005 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def priv(self)->'typing.Any': - """""" - pass - - -class PyUSER_INFO_1006(object): - """A dictionary holding the information in a Win32 USER_INFO_1006 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def home_dir(self)->'typing.Union[str]': - """""" - pass - - -class PyUSER_INFO_1007(object): - """A dictionary holding the information in a Win32 USER_INFO_1007 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def comment(self)->'typing.Union[str]': - """""" - pass - - -class PyUSER_INFO_1008(object): - """A dictionary holding the information in a Win32 USER_INFO_1008 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def flags(self)->'typing.Any': - """""" - pass - - -class PyUSER_INFO_1009(object): - """A dictionary holding the information in a Win32 USER_INFO_1009 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def script_path(self)->'typing.Union[str]': - """""" - pass - - -class PyUSER_INFO_1010(object): - """A dictionary holding the information in a Win32 USER_INFO_1010 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def auth_flags(self)->'typing.Any': - """""" - pass - - -class PyUSER_INFO_1011(object): - """A dictionary holding the information in a Win32 USER_INFO_1011 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def full_name(self)->'typing.Union[str]': - """""" - pass - - -class PyUSER_INFO_11(object): - """A dictionary holding the information in a Win32 USER_INFO_11 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """""" - pass - - - @property - def comment(self)->'typing.Union[str]': - """""" - pass - - - @property - def usr_comment(self)->'typing.Union[str]': - """""" - pass - - - @property - def full_name(self)->'typing.Union[str]': - """""" - pass - - - @property - def priv(self)->'typing.Any': - """""" - pass - - - @property - def auth_flags(self)->'typing.Any': - """""" - pass - - - @property - def password_age(self)->'typing.Any': - """""" - pass - - - @property - def home_dir(self)->'typing.Union[str]': - """""" - pass - - - @property - def parms(self)->'typing.Union[str]': - """""" - pass - - - @property - def last_logon(self)->'typing.Any': - """""" - pass - - - @property - def last_logoff(self)->'typing.Any': - """""" - pass - - - @property - def bad_pw_count(self)->'typing.Any': - """""" - pass - - - @property - def num_logons(self)->'typing.Any': - """""" - pass - - - @property - def logon_server(self)->'typing.Union[str]': - """""" - pass - - - @property - def country_code(self)->'typing.Any': - """""" - pass - - - @property - def workstations(self)->'typing.Union[str]': - """""" - pass - - - @property - def max_storage(self)->'typing.Any': - """""" - pass - - - @property - def units_per_week(self)->'typing.Any': - """""" - pass - - - @property - def logon_hours(self)->'str': - """""" - pass - - - @property - def code_page(self)->'typing.Any': - """""" - pass - - -class PyUSER_INFO_2(object): - """A dictionary holding the information in a Win32 USER_INFO_2 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """""" - pass - - - @property - def password(self)->'typing.Union[str]': - """""" - pass - - - @property - def password_age(self)->'typing.Any': - """""" - pass - - - @property - def priv(self)->'typing.Any': - """""" - pass - - - @property - def home_dir(self)->'typing.Union[str]': - """""" - pass - - - @property - def comment(self)->'typing.Union[str]': - """""" - pass - - - @property - def flags(self)->'typing.Any': - """""" - pass - - - @property - def script_path(self)->'typing.Union[str]': - """""" - pass - - - @property - def auth_flags(self)->'typing.Any': - """""" - pass - - - @property - def full_name(self)->'typing.Union[str]': - """""" - pass - - - @property - def usr_comment(self)->'typing.Union[str]': - """""" - pass - - - @property - def parms(self)->'typing.Union[str]': - """""" - pass - - - @property - def workstations(self)->'typing.Union[str]': - """""" - pass - - - @property - def last_logon(self)->'typing.Any': - """""" - pass - - - @property - def last_logoff(self)->'typing.Any': - """""" - pass - - - @property - def acct_expires(self)->'typing.Any': - """""" - pass - - - @property - def max_storage(self)->'typing.Any': - """""" - pass - - - @property - def units_per_week(self)->'typing.Any': - """""" - pass - - - @property - def logon_hours(self)->'str': - """""" - pass - - - @property - def bad_pw_count(self)->'typing.Any': - """""" - pass - - - @property - def num_logons(self)->'typing.Any': - """""" - pass - - - @property - def logon_server(self)->'typing.Union[str]': - """""" - pass - - - @property - def country_code(self)->'typing.Any': - """""" - pass - - - @property - def code_page(self)->'typing.Any': - """""" - pass - - -class PyUSER_INFO_20(object): - """A dictionary holding the information in a Win32 USER_INFO_20 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """""" - pass - - - @property - def full_name(self)->'typing.Union[str]': - """""" - pass - - - @property - def comment(self)->'typing.Union[str]': - """""" - pass - - - @property - def flags(self)->'typing.Any': - """""" - pass - - - @property - def user_id(self)->'typing.Any': - """""" - pass - - -class PyUSER_INFO_3(object): - """A dictionary holding the information in a Win32 USER_INFO_3 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """""" - pass - - - @property - def password(self)->'typing.Union[str]': - """""" - pass - - - @property - def password_age(self)->'typing.Any': - """""" - pass - - - @property - def priv(self)->'typing.Any': - """""" - pass - - - @property - def home_dir(self)->'typing.Union[str]': - """""" - pass - - - @property - def comment(self)->'typing.Union[str]': - """""" - pass - - - @property - def flags(self)->'typing.Any': - """""" - pass - - - @property - def script_path(self)->'typing.Union[str]': - """""" - pass - - - @property - def auth_flags(self)->'typing.Any': - """""" - pass - - - @property - def full_name(self)->'typing.Union[str]': - """""" - pass - - - @property - def usr_comment(self)->'typing.Union[str]': - """""" - pass - - - @property - def parms(self)->'typing.Union[str]': - """""" - pass - - - @property - def workstations(self)->'typing.Union[str]': - """""" - pass - - - @property - def last_logon(self)->'typing.Any': - """""" - pass - - - @property - def last_logoff(self)->'typing.Any': - """""" - pass - - - @property - def acct_expires(self)->'typing.Any': - """""" - pass - - - @property - def max_storage(self)->'typing.Any': - """""" - pass - - - @property - def units_per_week(self)->'typing.Any': - """""" - pass - - - @property - def logon_hours(self)->'str': - """""" - pass - - - @property - def bad_pw_count(self)->'typing.Any': - """""" - pass - - - @property - def num_logons(self)->'typing.Any': - """""" - pass - - - @property - def logon_server(self)->'typing.Union[str]': - """""" - pass - - - @property - def country_code(self)->'typing.Any': - """""" - pass - - - @property - def code_page(self)->'typing.Any': - """""" - pass - - - @property - def user_id(self)->'typing.Any': - """""" - pass - - - @property - def primary_group_id(self)->'typing.Any': - """""" - pass - - - @property - def profile(self)->'typing.Union[str]': - """""" - pass - - - @property - def home_dir_drive(self)->'typing.Union[str]': - """""" - pass - - - @property - def password_expired(self)->'typing.Any': - """""" - pass - - -class PyUSER_INFO_4(object): - """A dictionary holding the information in a Win32 USER_INFO_4 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def name(self)->'typing.Union[str]': - """""" - pass - - - @property - def password(self)->'typing.Union[str]': - """""" - pass - - - @property - def password_age(self)->'typing.Any': - """""" - pass - - - @property - def priv(self)->'typing.Any': - """""" - pass - - - @property - def home_dir(self)->'typing.Union[str]': - """""" - pass - - - @property - def comment(self)->'typing.Union[str]': - """""" - pass - - - @property - def flags(self)->'typing.Any': - """""" - pass - - - @property - def script_path(self)->'typing.Union[str]': - """""" - pass - - - @property - def auth_flags(self)->'typing.Any': - """""" - pass - - - @property - def full_name(self)->'typing.Union[str]': - """""" - pass - - - @property - def usr_comment(self)->'typing.Union[str]': - """""" - pass - - - @property - def parms(self)->'typing.Union[str]': - """""" - pass - - - @property - def workstations(self)->'typing.Union[str]': - """""" - pass - - - @property - def last_logon(self)->'typing.Any': - """""" - pass - - - @property - def last_logoff(self)->'typing.Any': - """""" - pass - - - @property - def acct_expires(self)->'typing.Any': - """""" - pass - - - @property - def max_storage(self)->'typing.Any': - """""" - pass - - - @property - def units_per_week(self)->'typing.Any': - """""" - pass - - - @property - def logon_hours(self)->'str': - """""" - pass - - - @property - def bad_pw_count(self)->'typing.Any': - """""" - pass - - - @property - def num_logons(self)->'typing.Any': - """""" - pass - - - @property - def logon_server(self)->'typing.Union[str]': - """""" - pass - - - @property - def country_code(self)->'typing.Any': - """""" - pass - - - @property - def code_page(self)->'typing.Any': - """""" - pass - - - @property - def user_sid(self)->'PySID': - """""" - pass - - - @property - def primary_group_id(self)->'typing.Any': - """""" - pass - - - @property - def profile(self)->'typing.Union[str]': - """""" - pass - - - @property - def home_dir_drive(self)->'typing.Union[str]': - """""" - pass - - - @property - def password_expired(self)->'typing.Any': - """""" - pass - - -class PyUSER_MODALS_INFO_0(object): - """A dictionary holding the information in a Win32 USER_MODALS_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def min_passwd_len(self)->'typing.Any': - """""" - pass - - - @property - def max_passwd_age(self)->'typing.Any': - """""" - pass - - - @property - def min_passwd_age(self)->'typing.Any': - """""" - pass - - - @property - def force_logoff(self)->'typing.Any': - """""" - pass - - - @property - def password_hist_len(self)->'typing.Any': - """""" - pass - - -class PyUSER_MODALS_INFO_1(object): - """A dictionary holding the information in a Win32 USER_MODALS_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def role(self)->'typing.Any': - """""" - pass - - - @property - def primary(self)->'typing.Union[str]': - """""" - pass - - -class PyUSER_MODALS_INFO_2(object): - """A dictionary holding the information in a Win32 USER_MODALS_INFO_2 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def domain_name(self)->'typing.Union[str]': - """""" - pass - - - @property - def domain_id(self)->'PySID': - """""" - pass - - -class PyUSER_MODALS_INFO_3(object): - """A dictionary holding the information in a Win32 USER_MODALS_INFO_3 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def lockout_duration(self)->'typing.Any': - """""" - pass - - - @property - def lockout_observation_window(self)->'typing.Any': - """""" - pass - - - @property - def usrmod3_lockout_threshold(self)->'typing.Any': - """""" - pass - - -class PyUSE_INFO_0(object): - """A dictionary holding the infomation in a Win32 USE_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def local(self)->'typing.Union[str]': - """""" - pass - - - @property - def remote(self)->'typing.Union[str]': - """""" - pass - - -class PyUSE_INFO_1(object): - """A dictionary holding the infomation in a Win32 USE_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def local(self)->'typing.Union[str]': - """""" - pass - - - @property - def remote(self)->'typing.Union[str]': - """""" - pass - - - @property - def password(self)->'typing.Union[str, typing.Any]': - """""" - pass - - - @property - def status(self)->'typing.Any': - """""" - pass - - - @property - def asg_type(self)->'typing.Any': - """""" - pass - - - @property - def refcount(self)->'typing.Any': - """""" - pass - - - @property - def usecount(self)->'typing.Any': - """""" - pass - - -class PyUSE_INFO_2(object): - """A dictionary holding the infomation in a Win32 USE_INFO_2 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def local(self)->'typing.Union[str]': - """""" - pass - - - @property - def remote(self)->'typing.Union[str]': - """""" - pass - - - @property - def password(self)->'typing.Union[str, typing.Any]': - """""" - pass - - - @property - def status(self)->'typing.Any': - """""" - pass - - - @property - def asg_type(self)->'typing.Any': - """""" - pass - - - @property - def refcount(self)->'typing.Any': - """""" - pass - - - @property - def usecount(self)->'typing.Any': - """""" - pass - - - @property - def username(self)->'typing.Union[str]': - """""" - pass - - - @property - def domainname(self)->'typing.Union[str]': - """""" - pass - - -class PyUSE_INFO_3(object): - """A dictionary holding the infomation in a Win32 USE_INFO_3 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def local(self)->'typing.Union[str]': - """""" - pass - - - @property - def remote(self)->'typing.Union[str]': - """""" - pass - - - @property - def password(self)->'typing.Union[str, typing.Any]': - """""" - pass - - - @property - def status(self)->'typing.Any': - """""" - pass - - - @property - def asg_type(self)->'typing.Any': - """""" - pass - - - @property - def refcount(self)->'typing.Any': - """""" - pass - - - @property - def usecount(self)->'typing.Any': - """""" - pass - - - @property - def username(self)->'typing.Union[str]': - """""" - pass - - - @property - def domainname(self)->'typing.Union[str]': - """""" - pass - - - @property - def flags(self)->'typing.Any': - """""" - pass - - -class PyUnicode(object): - """A Python object, representing a Unicode string.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyUrlCacheHANDLE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyWAVEFORMATEX(object): - """A Python object, representing a WAVEFORMATEX structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def wFormatTag(self)->'int': - """Waveform-audio format type. pywintypes only defines WAVE_FORMAT_PCM as a constant. Other values must be looked up in the mmsystem.h header file.""" - pass - - - @property - def nChannels(self)->'int': - """Number of channels. 1 for Mono, 2 for Stereo, anything, but never 5.1.""" - pass - - - @property - def nSamplesPerSec(self)->'int': - """Sample rate, in samples per second (hertz), that each channel should be played or recorded. If wFormatTag is WAVE_FORMAT_PCM, then common values for nSamplesPerSec are 8000, 11025, 22050, and 44100 Hz""" - pass - - - @property - def nAvgBytesPerSec(self)->'int': - """Required average data-transfer rate, in bytes per second, for the format tag. If wFormatTag is WAVE_FORMAT_PCM, nAvgBytesPerSec should be equal to the product of nSamplesPerSec and nBlockAlign.""" - pass - - - @property - def nBlockAlign(self)->'int': - """Block alignment, in bytes. The block alignment is the minimum atomic unit of data for the wFormatTag format type. If wFormatTag is WAVE_FORMAT_PCM, nBlockAlign should be equal to the product of nChannels and wBitsPerSample divided by 8 (bits per byte). For non-PCM formats, this member must be computed according to the manufacturer’s specification of the format tag.""" - pass - - - @property - def wBitsPerSample(self)->'int': - """Bits per sample for the wFormatTag format type. If wFormatTag is WAVE_FORMAT_PCM, then wBitsPerSample should be equal to 8 or 16. Sentinel""" - pass - - -class PyWINHTTP_AUTOPROXY_OPTIONS(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyWINHTTP_PROXY_INFO(object): - """A tuple representing a WINHTTP_PROXY_INFO structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyWKSTA_INFO_100(object): - """A dictionary holding the infomation in a Win32 WKSTA_INFO_100 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def platform_id(self)->'typing.Any': - """Indicates platform level to use to retrieve platform specific information""" - pass - - - @property - def computername(self)->'typing.Union[str]': - """Name of the local computer""" - pass - - - @property - def langroup(self)->'typing.Union[str]': - """Name of the domain to which computer belongs""" - pass - - - @property - def ver_major(self)->'typing.Any': - """Major version number of operating system running on the computer""" - pass - - - @property - def ver_minor(self)->'typing.Any': - """Minor version number of operating system running on the computer""" - pass - - -class PyWKSTA_INFO_101(object): - """A dictionary holding the infomation in a Win32 WKSTA_INFO_101 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def platform_id(self)->'typing.Any': - """Indicates platform level to use to retrieve platform specific information""" - pass - - - @property - def computername(self)->'typing.Union[str]': - """Name of the local computer""" - pass - - - @property - def langroup(self)->'typing.Union[str]': - """Name of the domain to which computer belongs""" - pass - - - @property - def ver_major(self)->'typing.Any': - """Major version number of operating system running on the computer""" - pass - - - @property - def ver_minor(self)->'typing.Any': - """Minor version number of operating system running on the computer""" - pass - - - @property - def lanroot(self)->'typing.Union[str]': - """Path to the LANMAN directory""" - pass - - -class PyWKSTA_INFO_102(object): - """A dictionary holding the infomation in a Win32 WKSTA_INFO_102 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def platform_id(self)->'typing.Any': - """Indicate platform level to use to retrieve platform specific information""" - pass - - - @property - def computername(self)->'typing.Union[str]': - """Name of the local computer""" - pass - - - @property - def langroup(self)->'typing.Union[str]': - """Name of the domain to which computer belongs""" - pass - - - @property - def ver_major(self)->'typing.Any': - """Major version number of operating system running on the computer""" - pass - - - @property - def ver_minor(self)->'typing.Any': - """Minor version number of operating system running on the computer""" - pass - - - @property - def lanroot(self)->'typing.Union[str]': - """Path to the LANMAN directory""" - pass - - - @property - def logged_on_users(self)->'typing.Any': - """Number of users who are logged on to the local computer""" - pass - - -class PyWKSTA_INFO_302(object): - """A dictionary holding the infomation in a Win32 WKSTA_INFO_302 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def char_wait(self)->'typing.Any': - """number of seconds the computer will wait for a remote resource to become available""" - pass - - - @property - def collection_time(self)->'typing.Any': - """number of milliseconds the computer will collect data before sending the data to a character device resource. The workstation waits the specified time or collects the number of characters specified by wki302_maximum_collection_count, whichever comes first.""" - pass - - - @property - def maximum_collection_count(self)->'typing.Any': - """Specifies the number of bytes of information the computer will collect before sending the data to a character device resource. The workstation collects the specified number of bytes or waits the time specified by wki302_collection_time, whichever comes first.""" - pass - - - @property - def keep_conn(self)->'typing.Any': - """Specifies the number of seconds the server will maintain an inactive connection to a resource.""" - pass - - - @property - def keep_search(self)->'typing.Any': - """Defines the number of seconds an inactive search will continue.""" - pass - - - @property - def max_cmds(self)->'typing.Any': - """Specifies the number of simultaneous network device driver commands that can be sent to the network.""" - pass - - - @property - def num_work_buf(self)->'typing.Any': - """Specifies the number of internal buffers the computer has.""" - pass - - - @property - def siz_work_buf(self)->'typing.Any': - """Specifies the size, in bytes, of each internal buffer.""" - pass - - - @property - def max_wrk_cache(self)->'typing.Any': - """Specifies the maximum size, in bytes, of an internal cache buffer.""" - pass - - - @property - def siz_error(self)->'typing.Any': - """Specifies the size, in bytes, of an internal error buffer.""" - pass - - - @property - def num_alerts(self)->'typing.Any': - """Specifies the maximum number of clients that can receive alert messages. (This member is not supported under MS-DOS.) The Alerter service registers at least three clients when it begins to run.""" - pass - - - @property - def num_services(self)->'typing.Any': - """Specifies the number of services that can be installed on the computer at any time.""" - pass - - - @property - def errlog_sz(self)->'typing.Any': - """Specifies the maximum size, in kilobytes, of the client's error log file.""" - pass - - - @property - def print_buf_time(self)->'typing.Any': - """Specifies the number of seconds the server waits before closing inactive compatibility-mode print jobs.""" - pass - - - @property - def num_char_buf(self)->'typing.Any': - """Specifies the number of character pipe buffers and device buffers the client can have.""" - pass - - - @property - def siz_char_buf(self)->'typing.Any': - """Specifies the maximum size, in bytes, of a character pipe buffer and device buffer.""" - pass - - - @property - def wrk_heuristics(self)->'typing.Union[str]': - """Pointer to a Unicode string of flags used to control a client's operation.""" - pass - - - @property - def mailslots(self)->'typing.Any': - """Specifies the maximum number of mailslots allowed.""" - pass - - - @property - def num_dgram_buf(self)->'typing.Any': - """Specifies the number of buffers to allocate for receiving datagrams.""" - pass - - -class PyWKSTA_INFO_402(object): - """A dictionary holding the infomation in a Win32 WKSTA_INFO_402 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def char_wait(self)->'typing.Any': - """number of seconds the computer will wait for a remote resource to become available""" - pass - - - @property - def collection_time(self)->'typing.Any': - """number of milliseconds the computer will collect data before sending the data to a character device resource. The workstation waits the specified time or collects the number of characters specified by wki402_maximum_collection_count, whichever comes first.""" - pass - - - @property - def maximum_collection_count(self)->'typing.Union[str]': - """Name of the domain to which computer belongs""" - pass - - - @property - def keep_conn(self)->'typing.Any': - """Major version number of operating system running on the computer""" - pass - - - @property - def keep_search(self)->'typing.Any': - """Minor version number of operating system running on the computer""" - pass - - - @property - def max_cmds(self)->'typing.Any': - """..""" - pass - - - @property - def num_work_buf(self)->'typing.Any': - """Number of users who are logged on to the local computer""" - pass - - - @property - def siz_work_buf(self)->'typing.Any': - """Number of users who are logged on to the local computer""" - pass - - - @property - def max_wrk_cache(self)->'typing.Any': - """..""" - pass - - - @property - def sess_timeout(self)->'typing.Any': - """..""" - pass - - - @property - def siz_error(self)->'typing.Any': - """..""" - pass - - - @property - def num_alerts(self)->'typing.Any': - """..""" - pass - - - @property - def num_services(self)->'typing.Any': - """..""" - pass - - - @property - def errlog_sz(self)->'typing.Any': - """..""" - pass - - - @property - def print_buf_time(self)->'typing.Any': - """..""" - pass - - - @property - def num_char_buf(self)->'typing.Any': - """..""" - pass - - - @property - def siz_char_buf(self)->'typing.Any': - """Specifies the maximum size, in bytes, of a character pipe buffer and device buffer.""" - pass - - - @property - def mailslots(self)->'typing.Any': - """..""" - pass - - - @property - def num_dgram_buf(self)->'typing.Any': - """..""" - pass - - - @property - def max_threads(self)->'typing.Any': - """Number of threads the computer can dedicate to the network""" - pass - - -class PyWKSTA_INFO_502(object): - """A dictionary holding the infomation in a Win32 WKSTA_INFO_502 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def char_wait(self)->'typing.Any': - """number of seconds the computer will wait for a remote resource to become available""" - pass - - - @property - def collection_time(self)->'typing.Any': - """number of milliseconds the computer will collect data before sending the data to a character device resource. The workstation waits the specified time or collects the number of characters specified by wki502_maximum_collection_count, whichever comes first.""" - pass - - - @property - def maximum_collection_count(self)->'typing.Any': - """Specifies the number of bytes of information the computer will collect before sending the data to a character device resource. The workstation collects the specified number of bytes or waits the time specified by wki302_collection_time, whichever comes first.""" - pass - - - @property - def keep_conn(self)->'typing.Any': - """Specifies the number of seconds the server will maintain an inactive connection to a resource.""" - pass - - - @property - def max_cmds(self)->'typing.Any': - """Specifies the number of simultaneous network device driver commands that can be sent to the network.""" - pass - - - @property - def max_wrk_cache(self)->'typing.Any': - """Indicates the number of seconds the server waits before disconnecting an inactive session.""" - pass - - - @property - def siz_char_buf(self)->'typing.Any': - """Specifies the maximum size, in bytes, of a character pipe buffer and device buffer.""" - pass - - - @property - def lock_quota(self)->'typing.Any': - """TODO""" - pass - - - @property - def lock_increment(self)->'typing.Any': - """TODO""" - pass - - - @property - def lock_maximum(self)->'typing.Any': - """TODO""" - pass - - - @property - def pipe_increment(self)->'typing.Any': - """TODO""" - pass - - - @property - def pipe_maximum(self)->'typing.Any': - """TODO""" - pass - - - @property - def cache_file_timeout(self)->'typing.Any': - """TODO""" - pass - - - @property - def dormant_file_limit(self)->'typing.Any': - """TODO""" - pass - - - @property - def read_ahead_throughput(self)->'typing.Any': - """TODO""" - pass - - - @property - def num_mailslot_buffers(self)->'typing.Any': - """TODO""" - pass - - - @property - def num_srv_announce_buffers(self)->'typing.Any': - """TODO""" - pass - - - @property - def max_illegal_datagram_events(self)->'typing.Any': - """TODO""" - pass - - - @property - def illegal_datagram_event_reset_frequency(self)->'typing.Any': - """TODO""" - pass - - - @property - def log_election_packets(self)->'typing.Any': - """TODO""" - pass - - - @property - def use_opportunistic_locking(self)->'typing.Any': - """TODO""" - pass - - - @property - def use_unlock_behind(self)->'typing.Any': - """TODO""" - pass - - - @property - def use_close_behind(self)->'typing.Any': - """TODO""" - pass - - - @property - def buf_named_pipes(self)->'typing.Any': - """TODO""" - pass - - - @property - def use_lock_read_unlock(self)->'typing.Any': - """TODO""" - pass - - - @property - def utilize_nt_caching(self)->'typing.Any': - """TODO""" - pass - - - @property - def use_raw_read(self)->'typing.Any': - """TODO""" - pass - - - @property - def use_raw_write(self)->'typing.Any': - """TODO""" - pass - - - @property - def use_write_raw_data(self)->'typing.Any': - """TODO""" - pass - - - @property - def use_encryption(self)->'typing.Any': - """TODO""" - pass - - - @property - def buf_files_deny_write(self)->'typing.Any': - """TODO""" - pass - - - @property - def buf_read_only_files(self)->'typing.Any': - """TODO""" - pass - - - @property - def force_core_create_mode(self)->'typing.Any': - """TODO""" - pass - - - @property - def use_512_byte_max_transfer(self)->'typing.Any': - """TODO""" - pass - - -class PyWKSTA_TRANSPORT_INFO_0(object): - """A dictionary holding the infomation in a Win32 WKSTA_TRANSPORT_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def quality_of_service(self)->'typing.Any': - """Supplies a value that specifies the search order of the transport protocol with respect to other transport protocols. The highest value is searched first.""" - pass - - - @property - def number_of_vcs(self)->'typing.Any': - """Specifies the number of clients communicating with the server using this transport protocol.""" - pass - - - @property - def transport_name(self)->'typing.Union[str]': - """Specifies the device name of the transport protocol.""" - pass - - - @property - def transport_address(self)->'typing.Union[str]': - """Specifies the address of the server on this transport protocol.""" - pass - - - @property - def wan_ish(self)->'typing.Any': - """This member is ignored by the NetWkstaTransportAdd function. For the NetWkstaTransportEnum function, this member indicates that this transport protocol is a WAN transport protocol. This member is set TRUE for NetBIOS/TCIP; it is set FALSE for NetBEUI and NetBIOS/IPX.""" - pass - - -class PyWKSTA_USER_INFO_0(object): - """A dictionary holding the infomation in a Win32 WKSTA_USER_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def username(self)->'typing.Union[str]': - """Name of user currently logged on to the workstation""" - pass - - -class PyWKSTA_USER_INFO_1(object): - """A dictionary holding the infomation in a Win32 WKSTA_USER_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def username(self)->'typing.Union[str]': - """Name of user currently logged on to the workstation""" - pass - - - @property - def logon_domain(self)->'typing.Union[str]': - """Returns the domain name of the user account of the user currently logged on to the workstation.""" - pass - - - @property - def oth_domains(self)->'typing.Union[str]': - """Returns the list of other operating system domains browsed by the workstation. The domain names are separated by blanks.""" - pass - - - @property - def logon_server(self)->'typing.Union[str]': - """Returns the name of the computer that authenticated the server.""" - pass - - -class PyWNDCLASS(object): - """A Python object, representing an WNDCLASS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def style(self)->'int': - """""" - pass - - - @property - def cbWndExtra(self)->'int': - """""" - pass - - - @property - def hInstance(self)->'int': - """""" - pass - - - @property - def hIcon(self)->'int': - """""" - pass - - - @property - def hCursor(self)->'int': - """""" - pass - - - @property - def hbrBackground(self)->'int': - """These 3 handled manually in PyWNDCLASS::getattro/setattro. The pymeth below is used as an end tag, so these props will be lost if below it""" - pass - - - @property - def lpszMenuName(self)->'typing.Union[str]': - """""" - pass - - - @property - def lpszClassName(self)->'typing.Union[str]': - """""" - pass - - - @property - def lpfnWndProc(self)->'typing.Any': - """MethodsSetDialogProcSets the WNDCLASS to be for a dialog box. """ - pass - - - def SetDialogProc(self,) -> 'None': - """ - Sets the WNDCLASS to be for a dialog box - -Args: - - - -Returns: - - None - - """ - pass - - -class PyXFORM(object): - """Dict representing an XFORM struct used as a world transformation matrix - -All members are optional, defaulting to 0.0.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def M11(self)->'float': - """Usage is dependent on operation performed, see MSDN docs""" - pass - - - @property - def M12(self)->'float': - """Usage is dependent on operation performed, see MSDN docs""" - pass - - - @property - def M21(self)->'float': - """Usage is dependent on operation performed, see MSDN docs""" - pass - - - @property - def M22(self)->'float': - """Usage is dependent on operation performed, see MSDN docs""" - pass - - - @property - def Dx(self)->'float': - """Horizontal offset in logical units""" - pass - - - @property - def Dy(self)->'float': - """Vertical offset in logical units""" - pass - - -class Pymmapfile(object): - """Object that provides access to memory-mapped file operations.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def close(self,) -> 'None': - """ - Closes the file mapping handle and releases mapped view - -Args: - - - -Returns: - - None - - """ - pass - - - def find(self,needle:'typing.Any',start:'typing.Any') -> 'typing.Any': - """ - Finds a string in the buffer. - -Args: - - needle(typing.Any):String to be located - start(typing.Any):Pos at which to start search, current pos assumed if not specifiedReturn ValueReturns pos of string, or -1 if not found - -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 - - - def flush(self,offset:'typing.Any'=0,size:'typing.Any'=0) -> 'None': - """ - Flushes memory buffer to disk - -Args: - - offset(typing.Any):Position in buffer at which to flush - size(typing.Any):Number of bytes to flush, 0 to flush remainder of buffer past the offset - -Returns: - - None - - """ - pass - - - def move(self,dest:'typing.Any',src:'typing.Any',count:'typing.Any') -> 'None': - """ - Moves data from one place in buffer to another - -Args: - - dest(typing.Any):Destination position in buffer - src(typing.Any):Source position in buffer - count(typing.Any):Number of bytes to move - -Returns: - - None - - """ - pass - - - def read(self,num_bytes:'typing.Any') -> 'typing.Any': - """ - Returns specified number of bytes from buffer, and advances current position - -Args: - - num_bytes(typing.Any):Number of bytes to read - -Returns: - - typing.Any - - """ - pass - - - def read_byte(self,) -> 'typing.Any': - """ - Reads a single character from current pos - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def read_line(self,) -> 'typing.Any': - """ - Reads data from current pos up to next EOL. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def resize(self,MaximumSize:'typing.Any',FileOffset:'typing.Any'=0,NumberOfBytesToMap:'typing.Any'=0) -> 'None': - """ - Resizes the file mapping and view. - -Args: - - MaximumSize(typing.Any):New size for file mapping. Use a multiple of system page size (see win32api::GetSystemInfo) - FileOffset(typing.Any):Offset into file mapping. Must be multiple of allocation granularity. - NumberOfBytesToMap(typing.Any):New view size. Specify a multiple of system page size.CommentsIf MaximumSize is 0, only the mapped view will be affected.Accepts keyword args. - -Returns: - - None - - """ - pass - - - def seek(self,dist:'typing.Any',how:'typing.Any'=0) -> 'None': - """ - Changes current position - -Args: - - dist(typing.Any):Distance to seek - how(typing.Any):Pos from which to seekhowmeaning0Seek from start of buffer1Seek from current position2Seek backwards from end of buffer - -Returns: - - None - - """ - pass - - - def size(self,) -> 'typing.Any': - """ - Returns size of current view - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def tell(self,) -> 'typing.Any': - """ - Returns current position in buffer - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def write(self,data:'typing.Any') -> 'None': - """ - Places data at current pos in buffer. - -Args: - - data(typing.Any):Data to be written - -Returns: - - None - - """ - pass - - - def write_byte(self,char:'typing.Any') -> 'None': - """ - Writes a single character of data - -Args: - - char(typing.Any):Single byte to be placed in buffer - -Returns: - - None - - """ - pass - - -class RASDIALEXTENSIONS(object): - """An object that describes a Win32 RASDIALEXTENSIONS structure - -TRUE*/)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwfOptions(self)->'int': - """(fOptions may also be used)""" - pass - - - @property - def hwndParent(self)->'int': - """""" - pass - - - @property - def reserved(self)->'int': - """""" - pass - - - @property - def reserved1(self)->'int': - """""" - pass - - - @property - def RasEapInfo(self)->'typing.Any': - """""" - pass - - -class RASDIALPARAMS(object): - """A tuple that describes a Win32 RASDIALPARAMS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SC_ACTION(object): - """Tuple of 2 ints (Type,Delay) used to represent an SC_ACTION structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Type(self)->'typing.Any': - """One of SC_ACTION_NONE, SC_ACTION_REBOOT, SC_ACTION_RESTART, SC_ACTION_RUN_COMMAND""" - pass - - - @property - def Delay(self)->'typing.Any': - """Time delay before specified action is taken (in milliseconds)""" - pass - - -class SERVICE_FAILURE_ACTIONS(object): - """A dictionary representing a SERVICE_FAILURE_ACTIONS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ResetPeriod(self)->'typing.Any': - """Indicates how many seconds to wait to reset the failure count, can be INFINITE""" - pass - - - @property - def RebootMsg(self)->'typing.Union[str, typing.Any]': - """Message displayed when reboot action is taken""" - pass - - - @property - def Command(self)->'typing.Union[str, typing.Any]': - """Command line to execute for SC_ACTION_RUN_COMMAND""" - pass - - - @property - def Actions(self)->'typing.Any': - """A tuple of SC_ACTION tuples""" - pass - - -class SERVICE_STATUS(object): - """A Win32 service status object is represented by a tuple:""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class TRACKMOUSEEVENT(object): - """A tuple of (dwFlags, hwndTrack, dwHoverTime)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class ULARGE_INTEGER(object): - """A Python object used wherever a COM ULARGE_INTEGER is used.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class WIN32_FIND_DATA(object): - """A tuple representing a WIN32_FIND_DATA structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class com_error(object): - """An exception raised when a COM exception occurs.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class connection(object): - """An object representing an ODBC connection""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def setautocommit(self,c:'typing.Any') -> 'None': - """ - Sets the autocommit mode. - -Args: - - c(typing.Any):The boolean autocommit mode. - -Returns: - - None - - """ - pass - - - def commit(self,) -> 'None': - """ - Commits a transaction. - -Args: - - - -Returns: - - None - - """ - pass - - - def rollback(self,) -> 'None': - """ - Rollsback a transaction. - -Args: - - - -Returns: - - None - - """ - pass - - - def cursor(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def close(self,) -> 'None': - """ - Closes the connection. - -Args: - - - -Returns: - - None - - """ - pass - - -class cursor(object): - """An object representing an ODBC cursor.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def close(self,) -> 'None': - """ - Closes the cursor - -Args: - - - -Returns: - - None - - """ - pass - - - def execute(self,sql:'str',arg:'typing.Any') -> 'typing.Any': - """ - Execute some SQL - -Args: - - sql(str):The SQL to execute - arg(typing.Any):Input variables. - -Returns: - - typing.Any - - """ - pass - - - def fetchone(self,) -> 'typing.Any': - """ - Fetch one row of data - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def fetchmany(self,) -> 'typing.List[typing.Any]': - """ - Fetch many rows of data - -Args: - - - -Returns: - - typing.List[typing.Any] - - """ - pass - - - def fetchall(self,) -> 'typing.List[typing.Any]': - """ - Fetch all rows of data - -Args: - - - -Returns: - - typing.List[typing.Any] - - """ - pass - - - def setinputsizes(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def setoutputsize(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - -class error(object): - """An exception raised when a win32 error occurs""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class COMPONENT(object): - """A dictionary containing data to fill a COMPPOS struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ID(self)->'typing.Any': - """Id of component, ignored when adding a new component""" - pass - - - @property - def ComponentType(self)->'typing.Any': - """One of shellcon.COMP_TYPE_* values""" - pass - - - @property - def Checked(self)->'typing.Any': - """True indicates item is currently displayed""" - pass - - - @property - def fDirty(self)->'typing.Any': - """Indicates if unsaved changes exist""" - pass - - - @property - def NoScroll(self)->'typing.Any': - """True disables scrolling""" - pass - - - @property - def Pos(self)->'typing.Any': - """COMPPOS dictionary determining window size and placement""" - pass - - - @property - def FriendlyName(self)->'typing.Any': - """String of at most MAX_PATH-1 characters, truncated if longer""" - pass - - - @property - def Source(self)->'typing.Any': - """String of at most INTERNET_MAX_URL_LENGTH-1 characters""" - pass - - - @property - def SubscribedURL(self)->'typing.Any': - """String of at most INTERNET_MAX_URL_LENGTH-1 characters""" - pass - - - @property - def CurItemState(self)->'typing.Any': - """One of shellcon.IS_* flags""" - pass - - - @property - def Original(self)->'typing.Any': - """COMPSTATEINFO dictionary""" - pass - - - @property - def Restored(self)->'typing.Any': - """COMPSTATEINFO dictionary""" - pass - - - @property - def Size(self)->'typing.Any': - """Size of structure, ignored on input""" - pass - - -class COMPONENTSOPT(object): - """A dictionary containing data to fill a COMPONENTSOPT struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def EnableComponents(self)->'typing.Any': - """True if components are enabled""" - pass - - - @property - def ActiveDesktop(self)->'typing.Any': - """True if Active Desktop is enabled""" - pass - - - @property - def Size(self)->'typing.Any': - """Size of structure, ignored on input""" - pass - - -class COMPPOS(object): - """A dictionary containing data to fill a COMPPOS struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Left(self)->'typing.Any': - """""" - pass - - - @property - def Top(self)->'typing.Any': - """""" - pass - - - @property - def Width(self)->'typing.Any': - """""" - pass - - - @property - def Height(self)->'typing.Any': - """""" - pass - - - @property - def Index(self)->'typing.Any': - """""" - pass - - - @property - def CanResize(self)->'typing.Any': - """""" - pass - - - @property - def CanResizeX(self)->'typing.Any': - """""" - pass - - - @property - def CanResizeY(self)->'typing.Any': - """""" - pass - - - @property - def PreferredLeftPercent(self)->'typing.Any': - """""" - pass - - - @property - def PreferredTopPercent(self)->'typing.Any': - """""" - pass - - - @property - def Size(self)->'typing.Any': - """Size of structure, ignored on input""" - pass - - -class COMPSTATEINFO(object): - """A dictionary containing data to fill a COMPSTATEINFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Left(self)->'typing.Any': - """Specified as screen coordinates""" - pass - - - @property - def Top(self)->'typing.Any': - """Specified as screen coordinates""" - pass - - - @property - def Width(self)->'typing.Any': - """Measured in pixels""" - pass - - - @property - def Height(self)->'typing.Any': - """Measured in pixels""" - pass - - - @property - def dwItemState(self)->'typing.Any': - """One of IS_NORMAL, IS_FULLSCREEN IS_SPLIT""" - pass - - - @property - def Size(self)->'typing.Any': - """Size of structure, ignored on input""" - pass - - -class DEFCONTENTMENU(object): - """A tuple representing a DEFCONTEXTMENU structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class ELEMDESC(object): - """An ELEMDESC is respresented as a tuple of""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class EXP_DARWIN_LINK(object): - """Dictionary containing information for a EXP_DARWIN_LINK struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Signature(self)->'typing.Any': - """The type of data block, one of shellcon.*_SIG values""" - pass - - - @property - def DarwinID(self)->'typing.Any': - """The Windows Installer id for the link""" - pass - - - @property - def wDarwinID(self)->'typing.Any': - """The installer id as Unicode""" - pass - - - @property - def Size(self)->'typing.Any': - """Size of structure, ignored on input""" - pass - - -class EXP_SPECIAL_FOLDER(object): - """Dictionary containing information for a EXP_SPECIAL_FOLDER struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Signature(self)->'typing.Any': - """The type of data block, one of shellcon.*_SIG values""" - pass - - - @property - def idSpecialFolder(self)->'typing.Any': - """The special folder id of the target (shellcon.CSIDL_*)""" - pass - - - @property - def Offset(self)->'typing.Any': - """Offset into the link's PIDL""" - pass - - - @property - def Size(self)->'typing.Any': - """Size of structure, ignored on input""" - pass - - -class EXP_SZ_LINK(object): - """Dictionary containing information for an EXP_SZ_LINK or EXP_SZ_ICON struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Signature(self)->'typing.Any': - """The type of data block, one of shellcon.*_SIG values""" - pass - - - @property - def Target(self)->'typing.Any': - """The link's target or icon location""" - pass - - - @property - def wTarget(self)->'typing.Any': - """The target in Unicode form""" - pass - - - @property - def Size(self)->'typing.Any': - """Size of structure, ignored on input""" - pass - - -class FUNCDESC(object): - """A FUNCDESC object represents a COM TYPEATTR structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def memid(self)->'int': - """""" - pass - - - @property - def scodeArray(self)->'typing.Tuple[typing.Any, ...]': - """""" - pass - - - @property - def args(self)->'typing.Tuple[ELEMDESC, ...]': - """""" - pass - - - @property - def funckind(self)->'typing.Any': - """""" - pass - - - @property - def invkind(self)->'typing.Any': - """""" - pass - - - @property - def callconv(self)->'typing.Any': - """""" - pass - - - @property - def cParamsOpt(self)->'typing.Any': - """""" - pass - - - @property - def oVft(self)->'typing.Any': - """""" - pass - - - @property - def rettype(self)->'ELEMDESC': - """""" - pass - - - @property - def wFuncFlags(self)->'typing.Any': - """""" - pass - - -class IDLDESC(object): - """An IDLDESC is respresented as""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class MAPIINIT_0(object): - """A MAPIINIT_0 is represented as a tuple of:""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class NT_CONSOLE_PROPS(object): - """Dictionary containing information for a NT_CONSOLE_PROPS struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Signature(self)->'typing.Any': - """The type of data block, one of shellcon.*_SIG values""" - pass - - - @property - def FillAttribute(self)->'typing.Any': - """Character attributes for fill operations""" - pass - - - @property - def PopupFillAttribute(self)->'typing.Any': - """Fill attributes for popups""" - pass - - - @property - def ScreenBufferSize(self)->'typing.Tuple[typing.Any, typing.Any]': - """Size of console screen buffer, in character cells""" - pass - - - @property - def WindowSize(self)->'typing.Tuple[typing.Any, typing.Any]': - """Size of console window in character cells""" - pass - - - @property - def WindowOrigin(self)->'typing.Tuple[typing.Any, typing.Any]': - """Window position, in screen coordinates""" - pass - - - @property - def nFont(self)->'typing.Any': - """Number of font to be displayed. See win32console::GetNumberOfConsoleFonts""" - pass - - - @property - def InputBufferSize(self)->'typing.Any': - """Size of console's input buffer""" - pass - - - @property - def FontSize(self)->'typing.Tuple[typing.Any, typing.Any]': - """Size of font""" - pass - - - @property - def FontFamily(self)->'typing.Any': - """Font family""" - pass - - - @property - def FontWeight(self)->'typing.Any': - """Controls thickness of displayed font""" - pass - - - @property - def FaceName(self)->'typing.Any': - """Name of font face, 31 characters at most""" - pass - - - @property - def CursorSize(self)->'typing.Any': - """Relative size of cursor, expressed as percent of character size""" - pass - - - @property - def FullScreen(self)->'typing.Any': - """Causes console to run in full screen mode""" - pass - - - @property - def QuickEdit(self)->'typing.Any': - """""" - pass - - - @property - def InsertMode(self)->'typing.Any': - """""" - pass - - - @property - def AutoPosition(self)->'typing.Any': - """Lets system determine window placement""" - pass - - - @property - def HistoryBufferSize(self)->'typing.Any': - """Size of command line history buffer""" - pass - - - @property - def NumberOfHistoryBuffers(self)->'typing.Any': - """""" - pass - - - @property - def HistoryNoDup(self)->'typing.Any': - """""" - pass - - - @property - def ColorTable(self)->'typing.Any': - """Tuple of 16 ints containing console's color attributes""" - pass - - - @property - def Size(self)->'typing.Any': - """Size of structure, ignored on input""" - pass - - -class NT_FE_CONSOLE_PROPS(object): - """Dictionary containing information for a NT_FE_CONSOLE_PROPS struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Signature(self)->'typing.Any': - """The type of data block, one of shellcon.*_SIG values""" - pass - - - @property - def CodePage(self)->'typing.Any': - """The codepage to be used for console text""" - pass - - - @property - def Size(self)->'typing.Any': - """Size of structure, ignored on input""" - pass - - -class PROPSPEC(object): - """Identifies a property. Can be either an int property id, or a str/unicode property name.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyADSVALUE(object): - """A tuple:""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyADS_ATTR_INFO(object): - """Represents a ADS_ATTR_INFO structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def AttrName(self)->'typing.Any': - """The name""" - pass - - - @property - def ControlCode(self)->'int': - """""" - pass - - - @property - def ADsType(self)->'int': - """""" - pass - - - @property - def Values(self)->'typing.List[typing.Any]': - """""" - pass - - -class PyADS_OBJECT_INFO(object): - """Represents a ADS_OBJECT_INFO structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def RDN(self)->'typing.Any': - """The name""" - pass - - - @property - def ObjectDN(self)->'typing.Any': - """""" - pass - - - @property - def ParentDN(self)->'typing.Any': - """""" - pass - - - @property - def ClassName(self)->'typing.Any': - """""" - pass - - -class PyADS_SEARCHPREF_INFO(object): - """A tuple of:""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyBIND_OPTS(object): - """Dictionary representation of a BIND_OPTS struct - -May eventually be extended to include BIND_OPTS2 members""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Flags(self)->'typing.Any': - """Value from BIND_FLAGS enum: BIND_MAYBOTHERUSER, BIND_JUSTTESTEXISTENCE or 0""" - pass - - - @property - def Mode(self)->'typing.Any': - """Combination of storagecon.STGM_* values""" - pass - - - @property - def TickCountDeadline(self)->'typing.Any': - """Operation timeout in milliseconds""" - pass - - - @property - def cbStruct(self)->'typing.Any': - """Size of struct, ignored on input""" - pass - - -class PyCMINVOKECOMMANDINFO(object): - """A tuple of parameters to be converted to a CMINVOKECOMMANDINFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyDSBCAPS(object): - """A Python object, representing a DSBCAPS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwFlags(self)->'int': - """Flags that specify buffer-object capabilities.FlagDescriptionDSBCAPS_PRIMARYBUFFERIndicates that the buffer is a primary sound buffer. If this value is not specified, a secondary sound buffer will be created.DSBCAPS_STATICIndicates that the buffer will be used for static sound data. Typically, these buffers are loaded once and played many times. These buffers are candidates for hardware memory.DSBCAPS_LOCHARDWAREThe buffer is in hardware memory and uses hardware mixing.DSBCAPS_LOCSOFTWAREThe buffer is in software memory and uses software mixing.DSBCAPS_CTRL3DThe buffer is either a primary buffer or a secondary buffer that uses 3-D control. To create a primary buffer, the dwFlags member of the DSBUFFERDESC structure should include the DSBCAPS_PRIMARYBUFFER flag.DSBCAPS_CTRLFREQUENCYThe buffer must have frequency control capability.DSBCAPS_CTRLPANThe buffer must have pan control capability.DSBCAPS_CTRLVOLUMEThe buffer must have volume control capability.DSBCAPS_CTRLPOSITIONNOTIFYThe buffer must have control position notify capability.DSBCAPS_STICKYFOCUSChanges the focus behavior of the sound buffer. This flag can be specified in an IDirectSound::CreateSoundBuffer call. With this flag set, an application using DirectSound can continue to play its sticky focus buffers if the user switches to another application not using DirectSound. In this situation, the application's normal buffers are muted, but the sticky focus buffers are still audible. This is useful for nongame applications, such as movie playback (DirectShow™), when the user wants to hear the soundtrack while typing in Microsoft Word or Microsoft® Excel, for example. However, if the user switches to another DirectSound application, all sound buffers, both normal and sticky focus, in the previous application are muted.DSBCAPS_GLOBALFOCUSThe buffer is a global sound buffer. With this flag set, an application using DirectSound can continue to play its buffers if the user switches focus to another application, even if the new application uses DirectSound. The one exception is if you switch focus to a DirectSound application that uses the DSSCL_EXCLUSIVE or DSSCL_WRITEPRIMARY flag for its cooperative level. In this case, the global sounds from other applications will not be audible.DSBCAPS_GETCURRENTPOSITION2Indicates that IDirectSoundBuffer::GetCurrentPosition should use the new behavior of the play cursor. In DirectSound in DirectX 1, the play cursor was significantly ahead of the actual playing sound on emulated sound cards; it was directly behind the write cursor. Now, if the DSBCAPS_GETCURRENTPOSITION2 flag is specified, the application can get a more accurate play position. If this flag is not specified, the old behavior is preserved for compatibility. Note that this flag affects only emulated sound cards; if a DirectSound driver is present, the play cursor is accurate for DirectSound in all versions of DirectX.DSBCAPS_MUTE3DATMAXDISTANCEThe sound is reduced to silence at the maximum distance. The buffer will stop playing when the maximum distance is exceeded, so that processor time is not wasted.""" - pass - - - @property - def nChannels(self)->'int': - """Size of the buffer, in bytes.""" - pass - - - @property - def dwUnlockTransferRate(self)->'int': - """Specifies the rate, in kilobytes per second, at which data is transferred to the buffer memory when IDirectSoundBuffer::Unlock is called. High-performance applications can use this value to determine the time required for IDirectSoundBuffer::Unlock to execute. For software buffers located in system memory, the rate will be very high because no processing is required. For hardware buffers, the rate might be slower because the buffer might have to be downloaded to the sound card, which might have a limited transfer rate.""" - pass - - - @property - def nAvgBytesPerSec(self)->'int': - """Specifies whether the returned handle is inherited when a new process is created. If this member is TRUE, the new process inherits the handle. Sentinel""" - pass - - -class PyDSBUFFERDESC(object): - """A Python object, representing a DSBUFFERDESC structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwFlags(self)->'int': - """Identifies the capabilities to include when creating a new DirectSoundBuffer object. Specify one or more of the following:FlagDescriptionDSBCAPS_PRIMARYBUFFERIndicates that the buffer is a primary sound buffer. If this value is not specified, a secondary sound buffer will be created.DSBCAPS_STATICIndicates that the buffer will be used for static sound data. Typically, these buffers are loaded once and played many times. These buffers are candidates for hardware memory.DSBCAPS_LOCHARDWAREThe buffer is in hardware memory and uses hardware mixing.DSBCAPS_LOCSOFTWAREThe buffer is in software memory and uses software mixing.DSBCAPS_CTRL3DThe buffer is either a primary buffer or a secondary buffer that uses 3-D control. To create a primary buffer, the dwFlags member of the DSBUFFERDESC structure should include the DSBCAPS_PRIMARYBUFFER flag.DSBCAPS_CTRLFREQUENCYThe buffer must have frequency control capability.DSBCAPS_CTRLPANThe buffer must have pan control capability.DSBCAPS_CTRLVOLUMEThe buffer must have volume control capability.DSBCAPS_CTRLPOSITIONNOTIFYThe buffer must have control position notify capability.DSBCAPS_STICKYFOCUSChanges the focus behavior of the sound buffer. This flag can be specified in an IDirectSound::CreateSoundBuffer call. With this flag set, an application using DirectSound can continue to play its sticky focus buffers if the user switches to another application not using DirectSound. In this situation, the application's normal buffers are muted, but the sticky focus buffers are still audible. This is useful for nongame applications, such as movie playback (DirectShow™), when the user wants to hear the soundtrack while typing in Microsoft Word or Microsoft® Excel, for example. However, if the user switches to another DirectSound application, all sound buffers, both normal and sticky focus, in the previous application are muted.DSBCAPS_GLOBALFOCUSThe buffer is a global sound buffer. With this flag set, an application using DirectSound can continue to play its buffers if the user switches focus to another application, even if the new application uses DirectSound. The one exception is if you switch focus to a DirectSound application that uses the DSSCL_EXCLUSIVE or DSSCL_WRITEPRIMARY flag for its cooperative level. In this case, the global sounds from other applications will not be audible.DSBCAPS_GETCURRENTPOSITION2Indicates that IDirectSoundBuffer::GetCurrentPosition should use the new behavior of the play cursor. In DirectSound in DirectX 1, the play cursor was significantly ahead of the actual playing sound on emulated sound cards; it was directly behind the write cursor. Now, if the DSBCAPS_GETCURRENTPOSITION2 flag is specified, the application can get a more accurate play position. If this flag is not specified, the old behavior is preserved for compatibility. Note that this flag affects only emulated sound cards; if a DirectSound driver is present, the play cursor is accurate for DirectSound in all versions of DirectX.DSBCAPS_MUTE3DATMAXDISTANCEThe sound is reduced to silence at the maximum distance. The buffer will stop playing when the maximum distance is exceeded, so that processor time is not wasted.""" - pass - - - @property - def dwBufferBytes(self)->'int': - """Size of the new buffer, in bytes. This value must be 0 when creating primary buffers. For secondary buffers, the minimum and maximum sizes allowed are specified by DSBSIZE_MIN and DSBSIZE_MAX.""" - pass - - - @property - def lpwfxFormat(self)->'typing.Any': - """Structure specifying the waveform format for the buffer. This value must be None for primary buffers. The application can use IDirectSoundBuffer::SetFormat to set the format of the primary buffer. Sentinel""" - pass - - -class PyDSCAPS(object): - """A Python object, representing a DSCAPS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwFlags(self)->'int': - """Specifies device capabilities. Can be one or more of the following:FlagDescriptionDSCAPS_PRIMARYMONOThe device supports monophonic primary buffers.DSCAPS_PRIMARYSTEREOThe device supports stereo primary buffers.DSCAPS_PRIMARY8BITThe device supports hardware-mixed secondary buffers with 8-bit samples.DSCAPS_PRIMARY16BITThe device supports primary sound buffers with 16-bit samples.DSCAPS_CONTINUOUSRATEThe device supports all sample rates between the dwMinSecondarySampleRate and dwMaxSecondarySampleRate member values. Typically, this means that the actual output rate will be within +/- 10 hertz (Hz) of the requested frequency.DSCAPS_EMULDRIVERThe device does not have a DirectSound driver installed, so it is being emulated through the waveform-audio functions. Performance degradation should be expected.DSCAPS_CERTIFIEDThis driver has been tested and certified by Microsoft.DSCAPS_SECONDARYMONOThe device supports hardware-mixed monophonic secondary buffers.DSCAPS_SECONDARYSTEREOThe device supports hardware-mixed stereo secondary buffers.DSCAPS_SECONDARY8BITThe device supports hardware-mixed secondary buffers with 8-bit samples.DSCAPS_SECONDARY16BITThe device supports hardware-mixed secondary sound buffers with 16-bit samples.""" - pass - - - @property - def dwMinSecondarySampleRate(self)->'int': - """Minimum sample rate supported by this device's hardware secondary sound buffers.""" - pass - - - @property - def dwMaxSecondarySampleRate(self)->'int': - """Maximum sample rate supported by this device's hardware secondary sound buffers.""" - pass - - - @property - def dwPrimaryBuffers(self)->'int': - """Number of primary buffers supported. This value will always be 1.""" - pass - - - @property - def dwMaxHwMixingAllBuffers(self)->'int': - """Specifies the total number of buffers that can be mixed in hardware. This member can be less than the sum of dwMaxHwMixingStaticBuffers and dwMaxHwMixingStreamingBuffers. Resource tradeoffs frequently occur.""" - pass - - - @property - def dwMaxHwMixingStaticBuffers(self)->'int': - """Specifies the maximum number of static sound buffers.""" - pass - - - @property - def dwMaxHwMixingStreamingBuffers(self)->'int': - """Specifies the maximum number of streaming sound buffers.""" - pass - - - @property - def dwFreeHwMixingAllBuffers(self)->'int': - """Description of the free hardware mixing capabilities of the device. An application can use this value to determine whether hardware resources are available for allocation to a secondary sound buffer. Also, by comparing these values to the members that specify maximum mixing capabilities, the resources that are already allocated can be determined.""" - pass - - - @property - def dwFreeHwMixingStaticBuffers(self)->'int': - """Description of the free hardware mixing capabilities of the device. An application can use this value to determine whether hardware resources are available for allocation to a secondary sound buffer. Also, by comparing these values to the members that specify maximum mixing capabilities, the resources that are already allocated can be determined.""" - pass - - - @property - def dwFreeHwMixingStreamingBuffers(self)->'int': - """Description of the free hardware mixing capabilities of the device. An application can use this value to determine whether hardware resources are available for allocation to a secondary sound buffer. Also, by comparing these values to the members that specify maximum mixing capabilities, the resources that are already allocated can be determined.""" - pass - - - @property - def dwMaxHw3DAllBuffers(self)->'int': - """Description of the hardware 3-D positional capabilities of the device.""" - pass - - - @property - def dwMaxHw3DStaticBuffers(self)->'int': - """Description of the hardware 3-D positional capabilities of the device.""" - pass - - - @property - def dwMaxHw3DStreamingBuffers(self)->'int': - """Description of the hardware 3-D positional capabilities of the device.""" - pass - - - @property - def dwFreeHw3DAllBuffers(self)->'int': - """Description of the free, or unallocated, hardware 3-D positional capabilities of the device.""" - pass - - - @property - def dwFreeHw3DStaticBuffers(self)->'int': - """Description of the free, or unallocated, hardware 3-D positional capabilities of the device.""" - pass - - - @property - def dwFreeHw3DStreamingBuffers(self)->'int': - """Description of the free, or unallocated, hardware 3-D positional capabilities of the device.""" - pass - - - @property - def dwTotalHwMemBytes(self)->'int': - """Size, in bytes, of the amount of memory on the sound card that stores static sound buffers.""" - pass - - - @property - def dwFreeHwMemBytes(self)->'int': - """Size, in bytes, of the free memory on the sound card.""" - pass - - - @property - def dwMaxContigFreeHwMemBytes(self)->'int': - """Size, in bytes, of the largest contiguous block of free memory on the sound card.""" - pass - - - @property - def dwUnlockTransferRateHwBuffers(self)->'int': - """Description of the rate, in kilobytes per second, at which data can be transferred to hardware static sound buffers. This and the number of bytes transferred determines the duration of a call to the IDirectSoundBuffer::Update method.""" - pass - - - @property - def dwPlayCpuOverheadSwBuffers(self)->'int': - """Description of the processing overhead, as a percentage of the central processing unit, needed to mix software buffers (those located in main system memory). This varies according to the bus type, the processor type, and the clock speed. The unlock transfer rate for software buffers is 0 because the data need not be transferred anywhere. Similarly, the play processing overhead for hardware buffers is 0 because the mixing is done by the sound device.""" - pass - - -class PyDSCBCAPS(object): - """A Python object, representing a DSCBCAPS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwFlags(self)->'int': - """Specifies device capabilities. Can be 0 or DSCBCAPS_EMULDRIVER (indicates that no DirectSound Device is available and standard wave audio functions are being used).""" - pass - - - @property - def dwBufferBytes(self)->'int': - """The size, in bytes, of the capture buffer.""" - pass - - -class PyDSCBUFFERDESC(object): - """A Python object, representing a DSCBUFFERDESC structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwFlags(self)->'int': - """Identifies the capabilities to include when creating a new DirectSoundBuffer object. Can be zero or the following flag:FlagDescriptionDSCBCAPS_WAVEMAPPEDThe Win32 wave mapper will be used for formats not supported by the device.""" - pass - - - @property - def dwBufferBytes(self)->'int': - """Size of the new buffer, in bytes. This value must be 0 when creating primary buffers. For secondary buffers, the minimum and maximum sizes allowed are specified by DSBSIZE_MIN and DSBSIZE_MAX.""" - pass - - - @property - def lpwfxFormat(self)->'typing.Any': - """Structure specifying the waveform format for the buffer. This value must be None for primary buffers. The application can use IDirectSoundBuffer::SetFormat to set the format of the primary buffer. Sentinel""" - pass - - -class PyDSCCAPS(object): - """A Python object, representing a DSCCAPS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dwFlags(self)->'int': - """Specifies device capabilities. Can be zero or the following flag:FlagDescriptionDSCCAPS_EMULDRIVERIndicates that no DirectSound Device is available and standard wave audio functions are being used.""" - pass - - - @property - def dwFormats(self)->'int': - """Bitset of supported WAVE_FORMAT formats.""" - pass - - - @property - def dwChannels(self)->'int': - """Number of channels supported by the device.""" - pass - - -class PyDSOP_FILTER_FLAGS(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def uplevel(self)->'PyDSOP_UPLEVEL_FILTER_FLAGS': - """""" - pass - - - @property - def downlevel(self)->'typing.Any': - """""" - pass - - -class PyDSOP_SCOPE_INIT_INFO(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def type(self)->'typing.Any': - """""" - pass - - - @property - def scope(self)->'typing.Any': - """""" - pass - - - @property - def hr(self)->'typing.Any': - """""" - pass - - - @property - def dcName(self)->'str': - """""" - pass - - - @property - def filterFlags(self)->'PyDSOP_FILTER_FLAGS': - """""" - pass - - -class PyDSOP_SCOPE_INIT_INFOs(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyDSOP_UPLEVEL_FILTER_FLAGS(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def bothModes(self)->'typing.Any': - """""" - pass - - - @property - def mixedModeOnly(self)->'typing.Any': - """""" - pass - - - @property - def nativeModeOnly(self)->'typing.Any': - """""" - pass - - -class PyFORMATETC(object): - """Tuple representing a FORMATETC struct describing an OLE data format""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyGFileOperationProgressSink(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def StartOperations(self,) -> 'None': - """ - Called as operation begins, before any modifications are done - -Args: - - - -Returns: - - None - - """ - pass - - - def FinishOperations(self,Result:'typing.Any') -> 'None': - """ - Called after all actions have been performed - -Args: - - Result(typing.Any):HRESULT of last operation performed - -Returns: - - None - - """ - pass - - - def PreRenameItem(self,Flags:'typing.Any',Item:'PyIShellItem',NewName:'typing.Any') -> 'None': - """ - Called before each file rename - -Args: - - Flags(typing.Any):Flags specifying copy behaviour, combination of shellcon.TSF_* flags - Item(PyIShellItem):Shell interface of the copied item - NewName(typing.Any):New display name of the item - -Returns: - - None - - """ - pass - - - def PostRenameItem(self,Flags:'typing.Any',Item:'PyIShellItem',NewName:'typing.Any',hrRename:'typing.Any',NewlyCreated:'PyIShellItem') -> 'None': - """ - Called after each file rename - -Args: - - Flags(typing.Any):Flags specifying rename behaviour, combination of shellcon.TSF_* flags - Item(PyIShellItem):Shell interface of item before rename - NewName(typing.Any):The new name of the item, may be mangled to resolve filename conflicts - hrRename(typing.Any):HRESULT of the rename operation - NewlyCreated(PyIShellItem):Shell interface of the item after rename - -Returns: - - None - - """ - pass - - - def PreMoveItem(self,Flags:'typing.Any',Item:'PyIShellItem',DestinationFolder:'PyIShellItem',NewName:'typing.Any') -> 'None': - """ - Called before each move operation - -Args: - - Flags(typing.Any):Flags specifying move behaviour, combination of shellcon.TSF_* flags - Item(PyIShellItem):The item to be moved - DestinationFolder(PyIShellItem):The folder into which it will be moved - NewName(typing.Any):Name of moved item, may be None if not to be changed - -Returns: - - None - - """ - pass - - - def PostMoveItem(self,Flags:'typing.Any',Item:'PyIShellItem',DestinationFolder:'PyIShellItem',NewName:'typing.Any',hrMove:'typing.Any',NewlyCreated:'PyIShellItem') -> 'None': - """ - Called after each move operation - -Args: - - Flags(typing.Any):Flags specifying move behaviour, combination of shellcon.TSF_* flags - Item(PyIShellItem):Interface of the item before it was moved - DestinationFolder(PyIShellItem):The folder into which it was moved - NewName(typing.Any):Name of item in its new location, may be mangled in case of conflict - hrMove(typing.Any):HRESULT of the move operation - NewlyCreated(PyIShellItem):Shell interface of the item in its new location - -Returns: - - None - - """ - pass - - - def PreCopyItem(self,Flags:'typing.Any',Item:'PyIShellItem',DestinationFolder:'PyIShellItem',NewName:'typing.Any') -> 'None': - """ - Called before each copy operation - -Args: - - Flags(typing.Any):Flags specifying copy behaviour, combination of shellcon.TSF_* flags - Item(PyIShellItem):The item to be copied - DestinationFolder(PyIShellItem):Folder into which it will be copied - NewName(typing.Any):Name to be given to the copy, will be None if keeping original name - -Returns: - - None - - """ - pass - - - def PostCopyItem(self,Flags:'typing.Any',Item:'PyIShellItem',DestinationFolder:'PyIShellItem',NewName:'typing.Any',hrCopy:'typing.Any',NewlyCreated:'PyIShellItem') -> 'None': - """ - Called after each copy operation - -Args: - - Flags(typing.Any):Flags specifying copy behaviour, combination of shellcon.TSF_* flags - Item(PyIShellItem):The original item - DestinationFolder(PyIShellItem):Folder into which it was copied - NewName(typing.Any):Name of item after copy, may be mangled in case of name conflict - hrCopy(typing.Any):HRESULT of the copy operation - NewlyCreated(PyIShellItem):Shell interface of the copy - -Returns: - - None - - """ - pass - - - def PreDeleteItem(self,Flags:'typing.Any',Item:'PyIShellItem') -> 'None': - """ - Called before each delete operation - -Args: - - Flags(typing.Any):Flags specifying delete behaviour, combination of shellcon.TSF_* flags - Item(PyIShellItem):Item to be deleted - -Returns: - - None - - """ - pass - - - def PostDeleteItem(self,Flags:'typing.Any',Item:'PyIShellItem',hrDelete:'typing.Any',NewlyCreated:'PyIShellItem') -> 'None': - """ - Called after each delete operation - -Args: - - Flags(typing.Any):Flags specifying delete behaviour, combination of shellcon.TSF_* flags - Item(PyIShellItem):Item that was deleted - hrDelete(typing.Any):HRESULT of the delete operation - NewlyCreated(PyIShellItem):Item in the recycle bin, or None if deleted without recycling - -Returns: - - None - - """ - pass - - - def PreNewItem(self,Flags:'typing.Any',DestinationFolder:'PyIShellItem',NewName:'typing.Any') -> 'None': - """ - Called before each new file is created - -Args: - - Flags(typing.Any):Flags specifying creation behaviour, combination of shellcon.TSF_* flags - DestinationFolder(PyIShellItem):Folder where item will be created - NewName(typing.Any):Name of item to be created - -Returns: - - None - - """ - pass - - - def PostNewItem(self,Flags:'typing.Any',DestinationFolder:'PyIShellItem',NewName:'typing.Any',TemplateName:'typing.Any',FileAttributes:'typing.Any',hrNew:'typing.Any',NewItem:'PyIShellItem') -> 'None': - """ - Called after each new file is created - -Args: - - Flags(typing.Any):Flags specifying creation behaviour, combination of shellcon.TSF_* flags - DestinationFolder(PyIShellItem):Folder in which item was created - NewName(typing.Any):Name of created item, may be mangled if file name conflicts occurred - TemplateName(typing.Any):Template file used to initialize new item - FileAttributes(typing.Any):File attributes of new item - hrNew(typing.Any):HRESULT of the create operation - NewItem(PyIShellItem):Shell interface of created item - -Returns: - - None - - """ - pass - - - def UpdateProgress(self,WorkTotal:'typing.Any',WorkSoFar:'typing.Any') -> 'None': - """ - Gives an estimate of total work completed - -Args: - - WorkTotal(typing.Any):Undimensioned number representing total amount of work - WorkSoFar(typing.Any):Undimensioned number representing amount already completed - -Returns: - - None - - """ - pass - - - def ResetTimer(self,) -> 'None': - """ - Not implemented, according to MSDN - -Args: - - - -Returns: - - None - - """ - pass - - - def PauseTimer(self,) -> 'None': - """ - Not implemented, according to MSDN - -Args: - - - -Returns: - - None - - """ - pass - - - def ResumeTimer(self,) -> 'None': - """ - Not implemented, according to MSDN - -Args: - - - -Returns: - - None - - """ - pass - - -class PyGSecurityInformation(object): - """Gateway wrapper for the implement-only ISecurityInformation interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetObjectInformation(self,) -> 'SI_OBJECT_INFO': - """ - Returns information identifying the object - -whose security is to be editted, and which pages are to appear in the property sheet - -Args: - - - -Returns: - - SI_OBJECT_INFO:PyGSecurityInformation.GetObjectInformation -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, - -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 - -settings - -Args: - - RequestedInformation(typing.Any):Combination of SECURITY_INFORMATION flags indicating which components of the object's security descriptor you should return - Default(typing.Any):If true, return a default security descriptor rather than current security. (invoked when 'Reset' button is clicked) - -Returns: - - PySECURITY_DESCRIPTOR - - """ - pass - - - def SetSecurity(self,SecurityInformation:'typing.Any',SecurityDescriptor:'PySECURITY_DESCRIPTOR') -> 'None': - """ - Applies the modified security to the object - -Args: - - SecurityInformation(typing.Any):SECURITY_INFORMATION flags specifying which types of security information are to be applied - SecurityDescriptor(PySECURITY_DESCRIPTOR):The security information to be applied to the objectReturn ValueAny returned value is ignored - -Returns: - - None:The security information to be applied to the objectReturn ValueAny returned value is ignored - - - """ - pass - - - def GetAccessRights(self,ObjectType:'PyIID',Flags:'typing.Any') -> 'typing.Tuple[SI_ACCESS, typing.Any]': - """ - Retrieves permission that can be set - -Args: - - ObjectType(PyIID):GUID representing type of object, may be None - Flags(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, and a zero-based index indicating which of them is the default - -Returns: - - 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, - -and a zero-based index indicating which of them is the default - - - """ - pass - - - def MapGeneric(self,ObjectType:'PyIID',AceFlags:'typing.Any',Mask:'typing.Any') -> 'typing.Any': - """ - Translates generic access rights to specific equivalents - -Args: - - ObjectType(PyIID):Type of object that permissions apply to, None or GUID_NULL indicates object itself - AceFlags(typing.Any):Flags from the ACE that contains the permissions - Mask(typing.Any):Bitmask containing access rightsCommentsSee win32security::MapGenericMaskReturn ValueThis method should return the input bitmask will all generic rights mapped to specific rights - -Returns: - - typing.Any:Bitmask containing access rightsComments - -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 - -implementation supports - -Args: - - - -Returns: - - typing.Tuple[SI_INHERIT_TYPE, ...]:PyGSecurityInformation.GetInheritTypes - -(SI_INHERIT_TYPE,...) = GetInheritTypes()Requests types of inheritance that your - -implementation supports -Return ValueReturns a sequence of SI_INHERIT_TYPE tuples - - - """ - pass - - - def PropertySheetPageCallback(self,hwnd:'typing.Any',Msg:'typing.Any',Page:'typing.Any') -> 'None': - """ - Called by each page as it is created and destroyed - -Args: - - hwnd(typing.Any):Handle to the window for the page - Msg(typing.Any):Flag indicating type of event, one of PSPCB_CREATE,PSPCB_RELEASE,PSPCB_SI_INITDIALOG - Page(typing.Any):SI_PAGE_TYPE value indicating which page is making the call (ntsecuritycon.SI_PAGE_*)Return ValueAny returned value will be ignored - -Returns: - - None:SI_PAGE_TYPE value indicating which page is making the call (ntsecuritycon.SI_PAGE_*)Return ValueAny returned value will be ignored - - - """ - pass - - -class PyIADesktopP2(object): - """An interface to the ActiveDesktop""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def UpdateAllDesktopSubscriptions(self,) -> 'None': - """ - Updates webpage subscriptions on the desktop - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIADs(object): - """An object representing the IADs interface. - -In most cases you can achieve the same result via IDispatch - however, this - -interface allows you get get and set properties without the IDispatch - -overhead.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ADsPath(self)->'str': - """""" - pass - - - @property - def AdsPath(self)->'str': - """Synonym for ADsPath""" - pass - - - @property - def Class(self)->'str': - """""" - pass - - - @property - def GUID(self)->'str': - """Like the IADs method, this returns a string rather than a GUID object.""" - pass - - - @property - def Name(self)->'str': - """""" - pass - - - @property - def Parent(self)->'str': - """""" - pass - - - @property - def Schema(self)->'str': - """""" - pass - - - def GetInfo(self,) -> 'None': - """ - Description of GetInfo. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetInfo(self,) -> 'None': - """ - Description of SetInfo. - -Args: - - - -Returns: - - None - - """ - pass - - - def Get(self,prop:'str') -> 'typing.Any': - """ - Description of Get. - -Args: - - prop(str):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. - -Returns: - - 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 - - - def Put(self,_property:'str',val:'typing.Any') -> 'None': - """ - Description of Put. - -Args: - - _property(str):The property name to set - val(typing.Any):The value to set. - -Returns: - - None - - """ - pass - - - def get(self,prop:'str') -> 'typing.Any': - """ - Description of Get. - -Args: - - prop(str):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. - -Returns: - - 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 - - - def put(self,_property:'str',val:'typing.Any') -> 'None': - """ - Description of Put. - -Args: - - _property(str):The property name to set - val(typing.Any):The value to set. - -Returns: - - None - - """ - pass - - -class PyIADsContainer(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetObject(self,_class:'str',relativeName:'str') -> 'PyIDispatch': - """ - None - -Args: - - _class(str):Specifies the name of the object class as known in the underlying directory and identical to the one retrieved through the get_Class property method. If the class name is None, the provider returns the first item found in the container. - relativeName(str):Specifies the name of the object as known in the underlying directory and identical to the one retrieved through the get_Name property method. - -Returns: - - PyIDispatch - - """ - pass - - - def get_Count(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def get_Filter(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_Filter(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - - def get_Hints(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_Hints(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - -class PyIADsUser(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def get_AccountDisabled(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_AccountDisabled(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - - def get_AccountExpirationDate(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_AccountExpirationDate(self,val:'PyTime') -> 'None': - """ - None - -Args: - - val(PyTime): - -Returns: - - None - - """ - pass - - - def get_BadLoginAddress(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def get_BadLoginCount(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def get_Department(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_Department(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - - def get_Description(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_Description(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - - def get_Division(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_Division(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - - def get_EmailAddress(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_EmailAddress(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - - def get_EmployeeID(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_EmployeeID(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - - def get_FirstName(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_FirstName(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - - def get_FullName(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_FullName(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - - def get_HomeDirectory(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_HomeDirectory(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - - def get_HomePage(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_HomePage(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - - def get_LoginScript(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def put_LoginScript(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - - def SetPassword(self,val:'typing.Any') -> 'None': - """ - None - -Args: - - val(typing.Any): - -Returns: - - None - - """ - pass - - - def ChangePassword(self,oldval:'typing.Any',newval:'typing.Any') -> 'None': - """ - None - -Args: - - oldval(typing.Any): - newval(typing.Any): - -Returns: - - None - - """ - pass - - -class PyIActiveDesktop(object): - """An interface to the ActiveDesktop""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ApplyChanges(self,Flags:'typing.Any') -> 'None': - """ - Applies changes to ActiveDesktop settings and persists them to the registry. - -Args: - - Flags(typing.Any):Combination of shellcon.AD_APPLY_* flags - -Returns: - - None - - """ - pass - - - def GetWallpaper(self,cchWallpaper:'typing.Any',Reserved:'typing.Any'=0) -> 'typing.Any': - """ - Returns the current wallpaper - -Args: - - cchWallpaper(typing.Any):Number of characters to allocate for buffer - Reserved(typing.Any):Use 0 if passed in - -Returns: - - typing.Any - - """ - pass - - - def SetWallpaper(self,Wallpaper:'typing.Any',Reserved:'typing.Any'=0) -> 'None': - """ - Sets the desktop wallpaper - -Args: - - Wallpaper(typing.Any):File to be used as new wallpaper - Reserved(typing.Any):Reserved, use 0 if passed in - -Returns: - - None - - """ - pass - - - def GetWallpaperOptions(self,Reserved:'typing.Any'=0) -> 'typing.Any': - """ - Returns wallpaper style - -Args: - - Reserved(typing.Any):Use 0 if passed inReturn ValueReturns one of the WPSTYLE_* values - -Returns: - - typing.Any:Use 0 if passed in -Return ValueReturns one of the WPSTYLE_* values - - - """ - pass - - - def SetWallpaperOptions(self,Style:'typing.Any',Reserved:'typing.Any'=0) -> 'None': - """ - Sets wallpaper style - -Args: - - Style(typing.Any):The wallpaper style, one of the WPSTYLE_* constants - Reserved(typing.Any):Reserved, use 0 if passed in - -Returns: - - None - - """ - pass - - - def GetPattern(self,cchPattern:'typing.Any'=1024,Reserved:'typing.Any'=0) -> 'None': - """ - Returns the wallpaper pattern - -Args: - - cchPattern(typing.Any):Number of characters to allocate for buffer - Reserved(typing.Any):Use 0 if passed inReturn ValueReturns a unicode string containing decimal values representing the pattern - -Returns: - - None:Use 0 if passed in -Return ValueReturns a unicode string containing decimal values representing the pattern - - - """ - pass - - - def SetPattern(self,Pattern:'typing.Any',Reserved:'typing.Any'=0) -> 'None': - """ - Sets the wallpaper pattern - -Args: - - Pattern(typing.Any):String of decimal numbers representing a picture - Reserved(typing.Any):Use 0 if passed in - -Returns: - - None - - """ - pass - - - def GetDesktopItemOptions(self,) -> 'typing.Any': - """ - Returns options for Active Desktop. - -Args: - - - -Returns: - - typing.Any:PyIActiveDesktop.GetDesktopItemOptions - -dict = GetDesktopItemOptions()Returns options for Active Desktop. -Return ValueReturns a COMPONENTSOPT dictionary - - - """ - pass - - - def SetDesktopItemOptions(self,comp:'typing.Any',Reserved:'typing.Any'=0) -> 'None': - """ - Sets Active Desktop options - -Args: - - comp(typing.Any):COMPONENTSOPT dictionary - Reserved(typing.Any):Use 0 if passed in - -Returns: - - None - - """ - pass - - - def AddDesktopItem(self,comp:'typing.Any',Reserved:'typing.Any'=0) -> 'None': - """ - Creates a new item to display on the desktop - -Args: - - comp(typing.Any):COMPONENT dictionary - Reserved(typing.Any):Use 0 if passed in - -Returns: - - None - - """ - pass - - - def AddDesktopItemWithUI(self,hwnd:'int',comp:'typing.Any',Flags:'typing.Any') -> 'None': - """ - Adds a desktop item, allowing user interaction - -Args: - - hwnd(int):Handle to parent window - comp(typing.Any):COMPONENT dictionary - Flags(typing.Any):One of shellcon.DTI_ADDUI_* flags - -Returns: - - None - - """ - pass - - - def ModifyDesktopItem(self,comp:'typing.Any',Flags:'typing.Any') -> 'None': - """ - Changes parameters for a desktop item - -Args: - - comp(typing.Any):COMPONENT dictionary - Flags(typing.Any):Combination of shellcon.COMP_ELEM_* flags - -Returns: - - None - - """ - pass - - - def RemoveDesktopItem(self,comp:'typing.Any',Reserved:'typing.Any'=0) -> 'None': - """ - Removes an item from the Active Desktop - -Args: - - comp(typing.Any):COMPONENT dictionary specifying which component to remove - Reserved(typing.Any):Use 0 if passed in - -Returns: - - None - - """ - pass - - - def GetDesktopItemCount(self,) -> 'None': - """ - Returns number of defined desktop items. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDesktopItem(self,Component:'typing.Any',Reserved:'typing.Any'=0) -> 'typing.Any': - """ - Returns desktop item parameters by index - -Args: - - Component(typing.Any):The zero-based index of the component to get - Reserved(typing.Any):Use 0 if passed inReturn ValueReturns a COMPONENT dictionary describing the item - -Returns: - - typing.Any:Use 0 if passed in -Return ValueReturns a COMPONENT dictionary describing the item - - - """ - pass - - - def GetDesktopItemByID(self,ID:'typing.Any',reserved:'typing.Any'=0) -> 'typing.Any': - """ - Returns desktop item parameters by Id - -Args: - - ID(typing.Any):The Id of the desktop item - reserved(typing.Any):Use 0 if passed inReturn ValueReturns a COMPONENT dictionary - -Returns: - - typing.Any:Use 0 if passed in -Return ValueReturns a COMPONENT dictionary - - - """ - pass - - - def GenerateDesktopItemHtml(self,FileName:'typing.Any',comp:'typing.Any',Reserved:'typing.Any'=0) -> 'None': - """ - Creates an HTML page for the desktop item - -Args: - - FileName(typing.Any):Name of file to be created - comp(typing.Any):COMPONENT dictionary specifying the desktop item - Reserved(typing.Any):Use 0 if passed in - -Returns: - - None - - """ - pass - - - def AddUrl(self,hwnd:'int',Source:'typing.Any',comp:'typing.Any',Flags:'typing.Any') -> 'None': - """ - Adds a web page to desktop, allowing user interaction - -Args: - - hwnd(int):Parent windows for any user interactive - Source(typing.Any):Source URL - comp(typing.Any):COMPONENT dictionary - Flags(typing.Any):ADDURL_SILENT, or 0 - -Returns: - - None - - """ - pass - - - def GetDesktopItemBySource(self,Source:'typing.Any',Reserved:'typing.Any'=0) -> 'typing.Any': - """ - Returns desktop item parameters by URL - -Args: - - Source(typing.Any):The URL address of the item to retrieve - Reserved(typing.Any):Use 0 if passed inReturn ValueReturns a COMPONENT dictionary - -Returns: - - typing.Any:Use 0 if passed in -Return ValueReturns a COMPONENT dictionary - - - """ - pass - - -class PyIActiveDesktopP(object): - """An interface to the ActiveDesktop""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetSafeMode(self,Flags:'typing.Any') -> 'None': - """ - Changes Active Desktop to safe mode - -Args: - - Flags(typing.Any):One of shellcon.SSM_* flags - -Returns: - - None - - """ - pass - - -class PyIActiveScriptDebug(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetScriptTextAttributes(self,pstrCode:'str',pstrDelimiter:'str',dwFlags:'typing.Any') -> 'typing.Tuple[typing.Any, ...]': - """ - Returns the text attributes for an arbitrary block - -of script text. - -Args: - - pstrCode(str):The script block text. - pstrDelimiter(str):See PyIActiveScriptParse::ParseScriptText for a description of this argument. - dwFlags(typing.Any):See PyIActiveScriptParse::ParseScriptText for a description of this argument.CommentsSmart hosts use this call to delegate GetText calls made on their axscript::PyIDebugDocumentText - -Returns: - - typing.Tuple[typing.Any, ...] - - """ - pass - - - def GetScriptletTextAttributes(self,pstrCode:'str',pstrDelimiter:'str',dwFlags:'typing.Any') -> 'None': - """ - Description of GetScriptletTextAttributes. - -Args: - - pstrCode(str):The script block text. - pstrDelimiter(str):See PyIActiveScriptParse::ParseScriptText for a description of this argument. - dwFlags(typing.Any):See PyIActiveScriptParse::ParseScriptText for a description of this argument. - -Returns: - - None - - """ - pass - - - def EnumCodeContextsOfPosition(self,dwSourceContext:'typing.Any',uCharacterOffset:'typing.Any',uNumChars:'typing.Any') -> 'None': - """ - Description of EnumCodeContextsOfPosition. - -Args: - - dwSourceContext(typing.Any):Description for dwSourceContext - uCharacterOffset(typing.Any):Description for uCharacterOffset - uNumChars(typing.Any):Description for uNumChars - -Returns: - - None - - """ - pass - - -class PyIActiveScriptError(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetExceptionInfo(self,) -> 'None': - """ - Description of GetExceptionInfo. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetSourcePosition(self,) -> 'None': - """ - Description of GetSourcePosition. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetSourceLineText(self,) -> 'None': - """ - Description of GetSourceLineText. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIActiveScriptErrorDebug(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDocumentContext(self,) -> 'None': - """ - Description of GetDocumentContext. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetStackFrame(self,) -> 'None': - """ - Description of GetStackFrame. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIActiveScriptParseProcedure(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ParseProcedureText(self,pstrCode:'typing.Any',pstrFormalParams:'typing.Any',pstrProcedureName:'typing.Any',pstrItemName:'typing.Any',punkContext:'PyIUnknown',pstrDelimiter:'typing.Any',dwSourceContextCookie:'typing.Any',ulStartingLineNumber:'typing.Any',dwFlags:'typing.Any') -> 'None': - """ - Description of ParseProcedureText. - -Args: - - pstrCode(typing.Any):Description for pstrCode - pstrFormalParams(typing.Any):Description for pstrFormalParams - pstrProcedureName(typing.Any):Description for pstrProcedureName - pstrItemName(typing.Any):Description for pstrItemName - punkContext(PyIUnknown):Description for punkContext - pstrDelimiter(typing.Any):Description for pstrDelimiter - dwSourceContextCookie(typing.Any):Description for dwSourceContextCookie - ulStartingLineNumber(typing.Any):Description for ulStartingLineNumber - dwFlags(typing.Any):Description for dwFlags - -Returns: - - None - - """ - pass - - -class PyIActiveScriptSite(object): - """An object providing the IActiveScriptSite interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetLCID(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetItemInfo(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetDocVersionString(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def OnStateChange(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def OnEnterScript(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def OnLeaveScript(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def OnScriptError(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def OnScriptTerminate(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyIActiveScriptSiteDebug(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDocumentContextFromPosition(self,dwSourceContext:'typing.Any',uCharacterOffset:'typing.Any',uNumChars:'typing.Any') -> 'None': - """ - Description of GetDocumentContextFromPosition. - -Args: - - dwSourceContext(typing.Any):Description for dwSourceContext - uCharacterOffset(typing.Any):Description for uCharacterOffset - uNumChars(typing.Any):Description for uNumChars - -Returns: - - None - - """ - pass - - - def GetApplication(self,) -> 'None': - """ - Description of GetApplication. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetRootApplicationNode(self,) -> 'None': - """ - Description of GetRootApplicationNode. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnScriptErrorDebug(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Allows a smart host to control the handling of runtime - -errors - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any]:PyIActiveScriptSiteDebug.OnScriptErrorDebug - -int, int = OnScriptErrorDebug()Allows a smart host to control the handling of runtime - -errors -Return ValueThe result is a tuple of (bCallDebugger, bCallOnScriptErrorWhenContinuing) - - - """ - pass - - -class PyIAddrBook(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ResolveName(self,uiParm:'typing.Any',flags:'typing.Any',entryTitle:'str',ADRLIST:'typing.Any') -> 'None': - """ - Performs name resolution, assigning entry identifiers to recipients in a recipient list. - -Args: - - uiParm(typing.Any):hwnd of a dialogs parent. - flags(typing.Any):Bitmask of flags that controls whether a dialog box can be displayed. - entryTitle(str): - ADRLIST(typing.Any):Partial addresses to resolve. - -Returns: - - None - - """ - pass - - - def OpenEntry(self,entryId:'str',iid:'PyIID',flags:'typing.Any') -> 'typing.Any': - """ - Opens a folder or message and returns an interface object for further access. - -Args: - - entryId(str):The entryID of the object - iid(PyIID):The IID of the object to return, or None for the default IID - flags(typing.Any):Bitmask of flags that controls how the object is opened. - -Returns: - - typing.Any - - """ - pass - - - def CompareEntryIDs(self,entryId:'str',entryId1:'str',flags:'typing.Any'=0) -> 'typing.Any': - """ - Compares two entry identifiers belonging to a particular address book provider to determine if they refer to the same address book object - -Args: - - entryId(str):The first entry ID to be compared - entryId1(str):The second entry ID to be compared - flags(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. - -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 - - -class PyIApplicationDebugger(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def QueryAlive(self,) -> 'None': - """ - Returns true if alive, else false. - -Args: - - - -Returns: - - None - - """ - pass - - - def CreateInstanceAtDebugger(self,rclsid:'PyIID',pUnkOuter:'PyIUnknown',dwClsContext:'typing.Any',riid:'PyIID') -> 'None': - """ - Create objects in the application process address space. - -Args: - - rclsid(PyIID):Description for rclsid - pUnkOuter(PyIUnknown):Description for pUnkOuter - dwClsContext(typing.Any):Description for dwClsContext - riid(PyIID):Description for riidCommentsProvides a mechanism for the debugger IDE, running out-of-process to the application, to create objects in the application process. This method simply delegates to CoCreateInstance. - -Returns: - - None - - """ - pass - - - def onDebugOutput(self,pstr:'typing.Any') -> 'None': - """ - None - -Args: - - pstr(typing.Any):Description for pstrCommentsThe debugger can use this to display the string in an output window. - -Returns: - - None - - """ - pass - - - def onHandleBreakPoint(self,prpt:'PyIRemoteDebugApplicationThread',br:'typing.Any',pError:'typing.Any') -> 'None': - """ - Called when a breakpoint is hit. - -Args: - - prpt(PyIRemoteDebugApplicationThread):Description for prpt - br(typing.Any):Description for br - pError(typing.Any):Description for pErrorCommentsThe application will remain suspended until the debugger IDE calls PyIDebugApplication::ResumeFromBreakPoint. - -Returns: - - None - - """ - pass - - - def onClose(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def onDebuggerEvent(self,guid:'PyIID',uUnknown:'PyIUnknown') -> 'None': - """ - Description of onDebuggerEvent. - -Args: - - guid(PyIID): - uUnknown(PyIUnknown):CommentsThe semantics of guid and unknown are entirely application/debugger defined This method may return E_NOTIMPL. - -Returns: - - None - - """ - pass - - -class PyIApplicationDestinations(object): - """Allows an application to removed items from its jump lists""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetAppID(self,AppID:'typing.Any') -> 'None': - """ - Specifies the application whose jump list is to be accessed - -Args: - - AppID(typing.Any):Taskbar identifier for the applicationCommentsThis method is only needed if the application sets its own taskbar identifier - -Returns: - - None - - """ - pass - - - def RemoveDestination(self,punk:'PyIUnknown') -> 'None': - """ - Removes a single entry from the jump lists - -Args: - - punk(PyIUnknown):IShellItem or IShellLink representing an item in the application's jump listCommentsDoes not remove pinned items - -Returns: - - None - - """ - pass - - - def RemoveAllDestinations(self,) -> 'None': - """ - Removes all Recent and Frequent jump list entries - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIApplicationDocumentLists(object): - """Interface used to retrieve the jump lists for an application""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetAppID(self,AppID:'typing.Any') -> 'None': - """ - Specifies the application whose jump list is to be accessed - -Args: - - AppID(typing.Any):Taskbar identifier for the applicationCommentsThis method is only needed if the application sets its own taskbar identifier - -Returns: - - None - - """ - pass - - - def GetList(self,ListType:'typing.Any',riid:'PyIID',ItemsDesired:'typing.Any'=0) -> 'PyIEnumObjects': - """ - Retrieves a list of items in a jump list - -Args: - - ListType(typing.Any):Type of document list to return, shellcon.ADLT_RECENT or ADLT_FREQUENT - riid(PyIID):The interface to return, IID_IEnumObjects or IID_IObjectArray - ItemsDesired(typing.Any):Number of items to return, use 0 for all available - -Returns: - - PyIEnumObjects - - """ - pass - - -class PyIAsyncOperation(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetAsyncMode(self,fDoOpAsync:'typing.Any') -> 'None': - """ - Description of SetAsyncMode. - -Args: - - fDoOpAsync(typing.Any):Description for fDoOpAsync - -Returns: - - None - - """ - pass - - - def GetAsyncMode(self,) -> 'typing.Any': - """ - Description of GetAsyncMode. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def StartOperation(self,pbcReserved:'PyIBindCtx') -> 'None': - """ - Description of StartOperation. - -Args: - - pbcReserved(PyIBindCtx):Description for pbcReserved - -Returns: - - None - - """ - pass - - - def InOperation(self,) -> 'None': - """ - Description of InOperation. - -Args: - - - -Returns: - - None - - """ - pass - - - def EndOperation(self,hResult:'typing.Any',pbcReserved:'PyIBindCtx',dwEffects:'typing.Any') -> 'None': - """ - Description of EndOperation. - -Args: - - hResult(typing.Any):Description for hResult - pbcReserved(PyIBindCtx):Description for pbcReserved - dwEffects(typing.Any):Description for dwEffects - -Returns: - - None - - """ - pass - - -class PyIAttach(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetLastError(self,hr:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - Returns the last error code for the object. - -Args: - - hr(typing.Any):Contains the error code generated in the previous method call. - flags(typing.Any):Indicates for format for the output. - -Returns: - - typing.Any - - """ - pass - - -class PyIBindCtx(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetRunningObjectTable(self,) -> 'PyIRunningObjectTable': - """ - Retrieves an object interfacing to the Running - -Object Table. - -Args: - - - -Returns: - - PyIRunningObjectTable - - """ - pass - - - def GetBindOptions(self,) -> 'PyBIND_OPTS': - """ - Retrieves the bind options for the bind context - -Args: - - - -Returns: - - PyBIND_OPTS - - """ - pass - - - def SetBindOptions(self,bindopts:'typing.Any') -> 'None': - """ - Sets the bind options for the context - -Args: - - bindopts(typing.Any):PyBIND_OPTS dictionary containing the binding options - -Returns: - - None - - """ - pass - - - def RegisterObjectParam(self,Key:'str',punk:'PyIUnknown') -> 'None': - """ - Adds an object to the context's keyed table of associated objects - -Args: - - Key(str):The string key for the object to be registered - punk(PyIUnknown):COM object to be registered with the bind context - -Returns: - - None - - """ - pass - - - def RevokeObjectParam(self,Key:'str') -> 'None': - """ - Removes one of the bind context's registered objects - -Args: - - Key(str):The string key for the object to be removed - -Returns: - - None - - """ - pass - - - def GetObjectParam(self,Key:'str') -> 'PyIUnknown': - """ - Returns one of the bind context's associated objects - -Args: - - Key(str):The string key for the object to be returned - -Returns: - - PyIUnknown - - """ - pass - - - def EnumObjectParam(self,) -> 'PyIEnumString': - """ - Creates an enumerator to list context's string keys - -Args: - - - -Returns: - - PyIEnumString - - """ - pass - - -class PyIBrowserFrameOptions(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetFrameOptions(self,dwMask:'typing.Any') -> 'None': - """ - Description of GetFrameOptions. - -Args: - - dwMask(typing.Any):Description for dwMask - -Returns: - - None - - """ - pass - - -class PyICancelMethodCalls(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Cancel(self,Seconds:'typing.Any') -> 'None': - """ - Cancels a pending call - -Args: - - Seconds(typing.Any):Wait timeout in seconds - -Returns: - - None - - """ - pass - - - def TestCancel(self,) -> 'typing.Any': - """ - Checks if a request has been made to cancel a call - -Args: - - - -Returns: - - typing.Any:PyICancelMethodCalls.TestCancel - -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 - - -class PyICatInformation(object): - """A Python interface to ICatInformation""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def EnumCategories(self,lcid:'typing.Any'=0) -> 'PyIEnumCATEGORYINFO': - """ - Returns an enumerator for the component categories - -registered on the system. - -Args: - - lcid(typing.Any):lcid - -Returns: - - PyIEnumCATEGORYINFO - - """ - pass - - - def GetCategoryDesc(self,lcid:'typing.Any'=0) -> 'str': - """ - Retrieves the localized description string for a specific category - -ID. - -Args: - - lcid(typing.Any):lcidCommentsThe return type is a unicode object. - -Returns: - - str - - """ - pass - - - def EnumClassesOfCategories(self,listIIdImplemented:'typing.List[PyIID]'=None,listIIdRequired:'typing.Any'=None) -> 'PyIEnumGUID': - """ - Returns an enumerator over the classes that - -implement one or more interfaces. - -Args: - - listIIdImplemented(typing.List[PyIID]):A sequence of PyIID objects, or None. - listIIdRequired(typing.Any):A sequence of PyIID objects, or None. - -Returns: - - PyIEnumGUID - - """ - pass - - -class PyICatRegister(object): - """An interface to a COM ICatRegister interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def RegisterCategories(self,arg:'typing.List[typing.Tuple[PyIID, typing.Any, str]]') -> 'None': - """ - Registers one or more component categories. Each component category - -consists of a CATID and a list of locale-dependent description strings. - -Args: - - arg(typing.List[typing.Tuple[PyIID, typing.Any, str]]):A sequence of category descriptions. - -Returns: - - None - - """ - pass - - - def UnRegisterCategories(self,arg:'typing.List[PyIID]') -> 'None': - """ - Unregister one or more previously registered categories. - -Args: - - arg(typing.List[PyIID]):The list of category IDs to be unregistered. - -Returns: - - None - - """ - pass - - - def RegisterClassImplCategories(self,clsid:'PyIID',arg:'typing.List[PyIID]') -> 'None': - """ - Registers the class as implementing one or more component - -categories. - -Args: - - clsid(PyIID):Class ID of the relevent class - arg(typing.List[PyIID]):A sequence of category IDs to be associated with the class. - -Returns: - - None - - """ - pass - - - def UnRegisterClassImplCategories(self,clsid:'PyIID',arg:'typing.List[PyIID]') -> 'None': - """ - Unregisters the class as implementing one or more component - -categories. - -Args: - - clsid(PyIID):Class ID of the relevent class - arg(typing.List[PyIID]):A sequence of category IDs to be unregistered from the class. - -Returns: - - None - - """ - pass - - - def RegisterClassReqCategories(self,clsid:'PyIID',arg:'typing.List[PyIID]') -> 'None': - """ - Registers the class as requiring one or more component - -categories. - -Args: - - clsid(PyIID):Class ID of the relevent class - arg(typing.List[PyIID]):A sequence of category IDs to be associated with the class. - -Returns: - - None - - """ - pass - - - def UnRegisterClassReqCategories(self,clsid:'PyIID',arg:'typing.List[PyIID]') -> 'None': - """ - Unregisters the class as requiring one or more component - -categories. - -Args: - - clsid(PyIID):Class ID of the relevent class - arg(typing.List[PyIID]):A sequence of category IDs to be unregistered for the class. - -Returns: - - None - - """ - pass - - -class PyICategoryProvider(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CanCategorizeOnSCID(self,pscid:'typing.Any') -> 'None': - """ - Description of CanCategorizeOnSCID. - -Args: - - pscid(typing.Any):Description for pscid - -Returns: - - None - - """ - pass - - - def GetDefaultCategory(self,) -> 'None': - """ - Description of GetDefaultCategory. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCategoryForSCID(self,pscid:'typing.Any') -> 'None': - """ - Description of GetCategoryForSCID. - -Args: - - pscid(typing.Any):Description for pscid - -Returns: - - None - - """ - pass - - - def EnumCategories(self,) -> 'None': - """ - Description of EnumCategories. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCategoryName(self,guid:'PyIID') -> 'None': - """ - Description of GetCategoryName. - -Args: - - guid(PyIID):Description for pguidCommentsThe buffer is always 1024 chars long - -Returns: - - None - - """ - pass - - - def CreateCategory(self,guid:'PyIID',riid:'PyIID') -> 'None': - """ - Description of CreateCategory. - -Args: - - guid(PyIID):Description for pguid - riid(PyIID):Description for riid - -Returns: - - None - - """ - pass - - -class PyIClassFactory(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateInstance(self,outerUnknown:'PyIUnknown',iid:'PyIID') -> 'PyIUnknown': - """ - Creates an uninitialized object. - -Args: - - outerUnknown(PyIUnknown):Usually None, otherwise the outer unknown if the object is being created as part of an aggregate. - iid(PyIID):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. - -Returns: - - 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, - -allowing instances to be created more quickly. - -Args: - - bInc(typing.Any):1 of the server should be locked, 0 if the server should be unlocked. - -Returns: - - None - - """ - pass - - -class PyIClientSecurity(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def QueryBlanket(self,Proxy:'PyIUnknown') -> 'typing.Any': - """ - Retrieves the authentication settings for an interface - -Args: - - Proxy(PyIUnknown):An interface created through a proxy - -Returns: - - typing.Any - - """ - pass - - - def SetBlanket(self,Proxy:'PyIUnknown',AuthnSvc:'typing.Any',AuthzSvc:'typing.Any',ServerPrincipalName:'str',AuthnLevel:'typing.Any',ImpLevel:'typing.Any',AuthInfo:'typing.Any',Capabilities:'typing.Any') -> 'None': - """ - Changes the authentication options used with an interface - -Args: - - Proxy(PyIUnknown):The proxy interface for which to set security options - AuthnSvc(typing.Any):Authentication service identifier, pythoncom.RPC_C_AUTHN_* (but not RPC_C_AUTHN_LEVEL_*) - AuthzSvc(typing.Any):Authorization service identifier, pythoncom.RPC_C_AUTHZ_* - ServerPrincipalName(str):SPN that identifies the server, can be None - AuthnLevel(typing.Any):Authentication level, pythoncom.RPC_C_AUTHN_LEVEL_* - ImpLevel(typing.Any):Impersonation level, pythoncom.RPC_C_IMP_LEVEL_* - AuthInfo(typing.Any):Not supported yet, use only None - Capabilities(typing.Any):Combination of pythoncom.EOAC_* flags. Must be a subset of the capabilities of the specified authentication service. - -Returns: - - None - - """ - pass - - - def CopyProxy(self,Proxy:'PyIUnknown') -> 'PyIUnknown': - """ - Makes a private copy of a proxy interface - -Args: - - Proxy(PyIUnknown):The remote interface to be copied - -Returns: - - PyIUnknown - - """ - pass - - -class PyIColumnProvider(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,psci:'typing.Any') -> 'None': - """ - Description of Initialize. - -Args: - - psci(typing.Any):Description for psci - -Returns: - - None - - """ - pass - - - def GetColumnInfo(self,dwIndex:'typing.Any') -> 'None': - """ - Description of GetColumnInfo. - -Args: - - dwIndex(typing.Any):Description for dwIndex - -Returns: - - None - - """ - pass - - - def GetItemData(self,pscid:'typing.Any',pscd:'typing.Any') -> 'None': - """ - Description of GetItemData. - -Args: - - pscid(typing.Any):Description for pscid - pscd(typing.Any):Description for pscd - -Returns: - - None - - """ - pass - - -class PyIConnectionPoint(object): - """A Python wrapper of a COM IConnectionPoint interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetConnectionInterface(self,) -> 'PyIID': - """ - Retrieves the IID of the interface represented by the - -connection point. - -Args: - - - -Returns: - - PyIID - - """ - pass - - - def GetConnectionPointContainer(self,) -> 'PyIConnectionPointContainer': - """ - Gets the connection point - -container for the object. - -Args: - - - -Returns: - - PyIConnectionPointContainer - - """ - pass - - - def Advise(self,unk:'PyIUnknown') -> 'typing.Any': - """ - Establishes a connection between the connection point object and the client's - -sink. - -Args: - - unk(PyIUnknown):The client's advise sinkReturn ValueThe result is the connection point identifier used by PyIConnectionPoint::Unadvise - -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 - -IConnectionPoint::Advise. The dwCookie parameter identifies the connection to terminate. - -Args: - - cookie(typing.Any):The connection token - -Returns: - - None - - """ - pass - - - def EnumConnections(self,) -> 'PyIEnumConnections': - """ - Creates an enumerator to iterate through the - -connections for the connection point - -Args: - - - -Returns: - - PyIEnumConnections - - """ - pass - - -class PyIConnectionPointContainer(object): - """A Python wrapper of a COM IConnectionPointContainer interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def EnumConnectionPoints(self,) -> 'PyIEnumConnectionPoints': - """ - Creates an enumerator object - -to iterate through all the connection points supported in the connectable object, one connection point per outgoing - -IID. - -Args: - - - -Returns: - - PyIEnumConnectionPoints - - """ - pass - - - def FindConnectionPoint(self,iid:'PyIID') -> 'PyIConnectionPoint': - """ - Finds a connection point for the - -given IID - -Args: - - iid(PyIID):The IID of the requested connection. - -Returns: - - PyIConnectionPoint - - """ - pass - - -class PyIContext(object): - """Allows access to properties defined for the current context (Requires win2k or later)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetProperty(self,rpolicyId:'PyIID',flags:'typing.Any',pUnk:'PyIUnknown') -> 'None': - """ - Sets a property on the context - -Args: - - rpolicyId(PyIID):GUID identifying the property to be set - flags(typing.Any):Reserved, use only 0 - pUnk(PyIUnknown):The property value - -Returns: - - None - - """ - pass - - - def RemoveProperty(self,rPolicyId:'PyIID') -> 'None': - """ - Removes a property from the context - -Args: - - rPolicyId(PyIID):GUID that identifies a context property - -Returns: - - None - - """ - pass - - - def GetProperty(self,rGuid:'PyIID') -> 'typing.Tuple[typing.Any, PyIUnknown]': - """ - Retrieves a context property - -Args: - - rGuid(PyIID):GUID that identifies a context propertyReturn ValueReturns flags (CPFLAGS is reserved, no defined values) and the IUnknown interface set for the property - -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 - - - def EnumContextProps(self,) -> 'PyIEnumContextProps': - """ - Returns an enumerator for the context properties - -Args: - - - -Returns: - - PyIEnumContextProps - - """ - pass - - -class PyIContextMenu(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def QueryContextMenu(self,hmenu:'int',indexMenu:'typing.Any',idCmdFirst:'typing.Any',idCmdLast:'typing.Any',uFlags:'typing.Any') -> 'typing.Any': - """ - Adds options to a context menu - -Args: - - hmenu(int):Handle to menu to which items should be added - indexMenu(typing.Any):Zero-based index at which to add first item - idCmdFirst(typing.Any):Minimum menu item Id - idCmdLast(typing.Any):Max menu item Id - uFlags(typing.Any):Combination of shellcon.CMF_* flags, can be 0 - -Returns: - - typing.Any - - """ - pass - - - def InvokeCommand(self,pici:'PyCMINVOKECOMMANDINFO') -> 'None': - """ - Executes a context menu option - -Args: - - pici(PyCMINVOKECOMMANDINFO):Tuple of parameters representing a CMINVOKECOMMANDINFO struct - -Returns: - - None - - """ - pass - - - def GetCommandString(self,idCmd:'typing.Any',uType:'typing.Any',cchMax:'typing.Any'=2048) -> 'typing.Any': - """ - Retrieves verb or help text for a context menu option - -Args: - - idCmd(typing.Any):Id of the command - uType(typing.Any):One of the shellcon.GCS_* constants - cchMax(typing.Any):Size of buffer to create for returned string - -Returns: - - typing.Any - - """ - pass - - -class PyICopyHookA(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CopyCallback(self,hwnd:'typing.Any',wFunc:'typing.Any',wFlags:'typing.Any',srcFile:'typing.Union[str, typing.Any]',srcAttribs:'typing.Any',destFile:'typing.Union[str, typing.Any]',destAttribs:'typing.Any') -> 'None': - """ - Description of CopyCallback. - -Args: - - hwnd(typing.Any):Description for hwnd - wFunc(typing.Any):Description for wFunc - wFlags(typing.Any):Description for wFlags - srcFile(typing.Union[str, typing.Any]):Description for srcFile - srcAttribs(typing.Any):Description for srcAttribs - destFile(typing.Union[str, typing.Any]):Description for destFile - destAttribs(typing.Any):Description for destAttribs - -Returns: - - None - - """ - pass - - -class PyICopyHookW(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CopyCallback(self,hwnd:'typing.Any',wFunc:'typing.Any',wFlags:'typing.Any',srcFile:'typing.Union[str, typing.Any]',srcAttribs:'typing.Any',destFile:'typing.Union[str, typing.Any]',destAttribs:'typing.Any') -> 'None': - """ - Description of CopyCallback. - -Args: - - hwnd(typing.Any):Description for hwnd - wFunc(typing.Any):Description for wFunc - wFlags(typing.Any):Description for wFlags - srcFile(typing.Union[str, typing.Any]):Description for srcFile - srcAttribs(typing.Any):Description for srcAttribs - destFile(typing.Union[str, typing.Any]):Description for destFile - destAttribs(typing.Any):Description for destAttribs - -Returns: - - None - - """ - pass - - -class PyICreateTypeInfo(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetGuid(self,guid:'PyIID') -> 'None': - """ - Description of SetGuid. - -Args: - - guid(PyIID):Description for guid - -Returns: - - None - - """ - pass - - - def SetTypeFlags(self,uTypeFlags:'typing.Any') -> 'None': - """ - Description of SetTypeFlags. - -Args: - - uTypeFlags(typing.Any):Description for uTypeFlags - -Returns: - - None - - """ - pass - - - def SetDocString(self,pStrDoc:'typing.Any') -> 'None': - """ - Description of SetDocString. - -Args: - - pStrDoc(typing.Any):Description for pStrDoc - -Returns: - - None - - """ - pass - - - def SetHelpContext(self,dwHelpContext:'typing.Any') -> 'None': - """ - Description of SetHelpContext. - -Args: - - dwHelpContext(typing.Any):Description for dwHelpContext - -Returns: - - None - - """ - pass - - - def SetVersion(self,wMajorVerNum:'typing.Any',wMinorVerNum:'typing.Any') -> 'None': - """ - Description of SetVersion. - -Args: - - wMajorVerNum(typing.Any):Description for wMajorVerNum - wMinorVerNum(typing.Any):Description for wMinorVerNum - -Returns: - - None - - """ - pass - - - def AddRefTypeInfo(self,pTInfo:'PyITypeInfo') -> 'None': - """ - Description of AddRefTypeInfo. - -Args: - - pTInfo(PyITypeInfo):Description for pTInfo - -Returns: - - None - - """ - pass - - - def AddFuncDesc(self,index:'typing.Any') -> 'None': - """ - Description of AddFuncDesc. - -Args: - - index(typing.Any):Description for index - -Returns: - - None - - """ - pass - - - def AddImplType(self,index:'typing.Any',hRefType:'typing.Any') -> 'None': - """ - Description of AddImplType. - -Args: - - index(typing.Any):Description for index - hRefType(typing.Any):A hRefType - -Returns: - - None - - """ - pass - - - def SetImplTypeFlags(self,index:'typing.Any',implTypeFlags:'typing.Any') -> 'None': - """ - Description of SetImplTypeFlags. - -Args: - - index(typing.Any):Description for index - implTypeFlags(typing.Any):Description for implTypeFlags - -Returns: - - None - - """ - pass - - - def SetAlignment(self,cbAlignment:'typing.Any') -> 'None': - """ - Description of SetAlignment. - -Args: - - cbAlignment(typing.Any):Description for cbAlignment - -Returns: - - None - - """ - pass - - - def SetSchema(self,pStrSchema:'typing.Any') -> 'None': - """ - Description of SetSchema. - -Args: - - pStrSchema(typing.Any):Description for pStrSchema - -Returns: - - None - - """ - pass - - - def AddVarDesc(self,index:'typing.Any') -> 'None': - """ - Description of AddVarDesc. - -Args: - - index(typing.Any):Description for index - -Returns: - - None - - """ - pass - - - def SetFuncAndParamNames(self,index:'typing.Any',rgszNames:'typing.Tuple[typing.Any, ...]') -> 'None': - """ - Description of SetFuncAndParamNames. - -Args: - - index(typing.Any):Index of the item to set. - rgszNames(typing.Tuple[typing.Any, ...]):A sequence of unicode or String objects. - -Returns: - - None - - """ - pass - - - def SetVarName(self,index:'typing.Any',szName:'typing.Any') -> 'None': - """ - Description of SetVarName. - -Args: - - index(typing.Any):Description for index - szName(typing.Any):Description for szName - -Returns: - - None - - """ - pass - - - def SetTypeDescAlias(self,) -> 'None': - """ - Description of SetTypeDescAlias. - -Args: - - - -Returns: - - None - - """ - pass - - - def DefineFuncAsDllEntry(self,index:'typing.Any',szDllName:'typing.Any',szProcName:'typing.Any') -> 'None': - """ - Description of DefineFuncAsDllEntry. - -Args: - - index(typing.Any):Description for index - szDllName(typing.Any):Description for szDllName - szProcName(typing.Any):Description for szProcName - -Returns: - - None - - """ - pass - - - def SetFuncDocString(self,index:'typing.Any',szDocString:'typing.Any') -> 'None': - """ - Description of SetFuncDocString. - -Args: - - index(typing.Any):Description for index - szDocString(typing.Any):Description for szDocString - -Returns: - - None - - """ - pass - - - def SetVarDocString(self,index:'typing.Any',szDocString:'typing.Any') -> 'None': - """ - Description of SetVarDocString. - -Args: - - index(typing.Any):Description for index - szDocString(typing.Any):Description for szDocString - -Returns: - - None - - """ - pass - - - def SetFuncHelpContext(self,index:'typing.Any',dwHelpContext:'typing.Any') -> 'None': - """ - Description of SetFuncHelpContext. - -Args: - - index(typing.Any):Description for index - dwHelpContext(typing.Any):Description for dwHelpContext - -Returns: - - None - - """ - pass - - - def SetVarHelpContext(self,index:'typing.Any',dwHelpContext:'typing.Any') -> 'None': - """ - Description of SetVarHelpContext. - -Args: - - index(typing.Any):Description for index - dwHelpContext(typing.Any):Description for dwHelpContext - -Returns: - - None - - """ - pass - - - def SetMops(self,index:'typing.Any',bstrMops:'typing.Any') -> 'None': - """ - Description of SetMops. - -Args: - - index(typing.Any):Description for index - bstrMops(typing.Any):Description for bstrMops - -Returns: - - None - - """ - pass - - - def LayOut(self,) -> 'None': - """ - Description of LayOut. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyICreateTypeLib(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateTypeInfo(self,szName:'typing.Any') -> 'None': - """ - Description of CreateTypeInfo. - -Args: - - szName(typing.Any):Description for szName - -Returns: - - None - - """ - pass - - - def SetName(self,szName:'typing.Any') -> 'None': - """ - Description of SetName. - -Args: - - szName(typing.Any):Description for szName - -Returns: - - None - - """ - pass - - - def SetVersion(self,wMajorVerNum:'typing.Any',wMinorVerNum:'typing.Any') -> 'None': - """ - Description of SetVersion. - -Args: - - wMajorVerNum(typing.Any):Description for wMajorVerNum - wMinorVerNum(typing.Any):Description for wMinorVerNum - -Returns: - - None - - """ - pass - - - def SetGuid(self,guid:'PyIID') -> 'None': - """ - Description of SetGuid. - -Args: - - guid(PyIID):Description for guid - -Returns: - - None - - """ - pass - - - def SetDocString(self,szDoc:'typing.Any') -> 'None': - """ - Description of SetDocString. - -Args: - - szDoc(typing.Any):Description for szDoc - -Returns: - - None - - """ - pass - - - def SetHelpFileName(self,szHelpFileName:'typing.Any') -> 'None': - """ - Description of SetHelpFileName. - -Args: - - szHelpFileName(typing.Any):Description for szHelpFileName - -Returns: - - None - - """ - pass - - - def SetHelpContext(self,dwHelpContext:'typing.Any') -> 'None': - """ - Description of SetHelpContext. - -Args: - - dwHelpContext(typing.Any):Description for dwHelpContext - -Returns: - - None - - """ - pass - - - def SetLcid(self,) -> 'None': - """ - Description of SetLcid. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetLibFlags(self,uLibFlags:'typing.Any') -> 'None': - """ - Description of SetLibFlags. - -Args: - - uLibFlags(typing.Any):Description for uLibFlags - -Returns: - - None - - """ - pass - - - def SaveAllChanges(self,) -> 'None': - """ - Description of SaveAllChanges. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyICreateTypeLib2(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateTypeInfo(self,szName:'typing.Any') -> 'None': - """ - Description of CreateTypeInfo. - -Args: - - szName(typing.Any):Description for szName - -Returns: - - None - - """ - pass - - - def SetName(self,szName:'typing.Any') -> 'None': - """ - Description of SetName. - -Args: - - szName(typing.Any):Description for szName - -Returns: - - None - - """ - pass - - - def SetVersion(self,wMajorVerNum:'typing.Any',wMinorVerNum:'typing.Any') -> 'None': - """ - Description of SetVersion. - -Args: - - wMajorVerNum(typing.Any):Description for wMajorVerNum - wMinorVerNum(typing.Any):Description for wMinorVerNum - -Returns: - - None - - """ - pass - - - def SetGuid(self,guid:'PyIID') -> 'None': - """ - Description of SetGuid. - -Args: - - guid(PyIID):Description for guid - -Returns: - - None - - """ - pass - - - def SetDocString(self,szDoc:'typing.Any') -> 'None': - """ - Description of SetDocString. - -Args: - - szDoc(typing.Any):Description for szDoc - -Returns: - - None - - """ - pass - - - def SetHelpFileName(self,szHelpFileName:'typing.Any') -> 'None': - """ - Description of SetHelpFileName. - -Args: - - szHelpFileName(typing.Any):Description for szHelpFileName - -Returns: - - None - - """ - pass - - - def SetHelpContext(self,dwHelpContext:'typing.Any') -> 'None': - """ - Description of SetHelpContext. - -Args: - - dwHelpContext(typing.Any):Description for dwHelpContext - -Returns: - - None - - """ - pass - - - def SetLcid(self,) -> 'None': - """ - Description of SetLcid. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetLibFlags(self,uLibFlags:'typing.Any') -> 'None': - """ - Description of SetLibFlags. - -Args: - - uLibFlags(typing.Any):Description for uLibFlags - -Returns: - - None - - """ - pass - - - def SaveAllChanges(self,) -> 'None': - """ - Description of SaveAllChanges. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyICurrentItem(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyICustomDestinationList(object): - """Interface used to customize an application's jump list""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetAppID(self,AppID:'typing.Any') -> 'None': - """ - Specifies the taskbar identifier for the jump list - -Args: - - AppID(typing.Any):The taskbar identifier of the applicationCommentsOnly needed if the calling app doesn't use the system-assigned default - -Returns: - - None - - """ - pass - - - def BeginList(self,riid:'PyIID') -> 'typing.Tuple[typing.Any, PyIObjectArray]': - """ - Clears the jump list and prepares it to be - -repopulated - -Args: - - riid(PyIID):The interface to returnReturn ValueReturns the number of slots and a collection of all destinations removed from the jump list - -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 - - - def AppendCategory(self,Category:'typing.Any',Items:'PyIObjectArray') -> 'None': - """ - Adds a custom category to the jump list - -Args: - - Category(typing.Any):Display name of the category, can also be a dll and resource id for localization - Items(PyIObjectArray):Collection of IShellItem and/or IShellLink interfaces - -Returns: - - None - - """ - pass - - - def AppendKnownCategory(self,Category:'typing.Any') -> 'None': - """ - Adds one of the predefined categories to the custom list - -Args: - - Category(typing.Any):shellcon.KDC_RECENT or KDC_FREQUENT - -Returns: - - None - - """ - pass - - - def AddUserTasks(self,Items:'PyIObjectArray') -> 'None': - """ - Sets the entries shown in the Tasks category - -Args: - - Items(PyIObjectArray):Collection of PyIShellItem and/or PyIShellLink interfaces - -Returns: - - None - - """ - pass - - - def CommitList(self,) -> 'None': - """ - Finalizes changes. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetRemovedDestinations(self,riid:'PyIID') -> 'PyIObjectArray': - """ - Returns all the items removed from the - -jump list - -Args: - - riid(PyIID):The interface to return - -Returns: - - PyIObjectArray - - """ - pass - - - def DeleteList(self,AppID:'typing.Any'=None) -> 'None': - """ - Removes any customization, leaving only the system-maintained Recent - -and Frequent lists - -Args: - - AppID(typing.Any):The taskbar identifier of the application - -Returns: - - None - - """ - pass - - - def AbortList(self,) -> 'None': - """ - Discards all changes - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDL(object): - """A Python representation of an IDL. Implemented as a sequence of Python strings. - -FALSE*/, UINT *pcb /* = NULL */)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIDataObject(object): - """Used to transfer data in various formats throughout the shell""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetData(self,pformatetcIn:'PyFORMATETC') -> 'PySTGMEDIUM': - """ - Retrieves data from the object in specified format - -Args: - - pformatetcIn(PyFORMATETC):Tuple representing a FORMATETC struct describing how the data should be returned - -Returns: - - PySTGMEDIUM - - """ - pass - - - def GetDataHere(self,pformatetcIn:'PyFORMATETC') -> 'PySTGMEDIUM': - """ - Retunrs a copy of the object's data in specified format - -Args: - - pformatetcIn(PyFORMATETC):Tuple representing a FORMATETC struct describing how the data should be returned - -Returns: - - PySTGMEDIUM - - """ - pass - - - def QueryGetData(self,pformatetc:'PyFORMATETC') -> 'None': - """ - Checks if the objects supports returning data in a particular format. - -Args: - - pformatetc(PyFORMATETC):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. - -Returns: - - 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 - -format that the object supports - -Args: - - pformatectIn(PyFORMATETC):Tuple representing a FORMATETC struct describing how the data should be returned - -Returns: - - PyFORMATETC - - """ - pass - - - def SetData(self,pformatetc:'PyFORMATETC',pmedium:'PySTGMEDIUM',fRelease:'typing.Any') -> 'None': - """ - Sets the data that the object will return. - -Args: - - pformatetc(PyFORMATETC):Tuple representing a FORMATETC struct describing the type of data to be set - pmedium(PySTGMEDIUM):The data to be placed in the object - fRelease(typing.Any):If True, transfers ownership of the data to the object. If False, caller is responsible for releasing the STGMEDIUM. - -Returns: - - None - - """ - pass - - - def EnumFormatEtc(self,dwDirection:'typing.Any') -> 'PyIEnumFORMATETC': - """ - Returns an enumerator to list the data formats that the - -object supports. - -Args: - - dwDirection(typing.Any):Indicates whether to return formats that can be queried or set (pythoncom.DATADIR_GET or DATADIR_SET) - -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 - -changes - -Args: - - pformatetc(PyFORMATETC):Defines the type of data for which the sink will receive notifications. - advf(typing.Any):Combination of values from ADVF enum. (which currently do not appear in any of the constants modules!) - pAdvSink(typing.Any):Currently this interface is not wrapped.Return ValueReturns a unique number that is used to identify the connection - -Returns: - - typing.Any:Currently this interface is not wrapped.Return ValueReturns a unique number that is used to identify the connection - - - """ - pass - - - def DUnadvise(self,dwConnection:'typing.Any') -> 'None': - """ - Disconnects a notification sink. - -Args: - - dwConnection(typing.Any):Identifier of the connection as returned by DAdvise. - -Returns: - - None - - """ - pass - - - def EnumDAdvise(self,) -> 'typing.Any': - """ - Creates an enumerator to list connected notification sinks. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyIDebugApplication(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetName(self,pstrName:'typing.Any') -> 'None': - """ - Sets the name of the application. - -Args: - - pstrName(typing.Any):The name of the application.CommentsThe provided name will be returned in subsequent calls to >om PyIRemoteDebugApplication.GetName>. - -Returns: - - None - - """ - pass - - - def StepOutComplete(self,) -> 'None': - """ - Called by language engines, in single step mode, just before they - -return to their caller. - -Args: - - - -Returns: - - None - - """ - pass - - - def DebugOutput(self,pstr:'typing.Any') -> 'None': - """ - Causes the given string to be displayed by the debugger IDE, normally in - -an output window. - -Args: - - pstr(typing.Any):Description for pstrCommentsThis mechanism provides the means for a language engine to implement language specific debugging output support. Example: Debug.writeln("Help") in JavaScript. - -Returns: - - None - - """ - pass - - - def StartDebugSession(self,) -> 'None': - """ - Causes a default debugger IDE to be started and a debug session to - -be attached to this application if one does not already exist. - -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 - -hit a breakpoint. - -Args: - - br(typing.Any):Break reason - one of the BREAKREASON_* constants.CommentsThis 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 method returns with the action to be taken.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. - -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 - -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 - -various things such as enumerating stack frames or evaluating expressions. -Return ValueThe result is the break resume action - one of the BREAKRESUMEACTION contsants. - - - """ - pass - - - def Close(self,) -> 'None': - """ - Causes this application to release all references and enter a zombie state. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetBreakFlags(self,) -> 'typing.Any': - """ - Returns the current break flags for the application. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetCurrentThread(self,) -> 'PyIDebugApplicationThread': - """ - Returns the application thread object - -associated with the currently running thread. - -Args: - - - -Returns: - - PyIDebugApplicationThread - - """ - pass - - - def CreateAsyncDebugOperation(self,psdo:'PyIDebugSyncOperation') -> 'None': - """ - None - -Args: - - psdo(PyIDebugSyncOperation):Description for psdoCommentsThis provides a mechanism for language engines to implement asynchronous expression and evaluation, etc. without having to know the details of synchronization with the debugger thread. See the descriptions for PyIDebugSyncOperation and PyIDebugAsyncOperation for more details. - -Returns: - - None - - """ - pass - - - def AddStackFrameSniffer(self,pdsfs:'PyIDebugStackFrameSniffer') -> 'typing.Any': - """ - Adds a stack frame sniffer to this application. - -Args: - - pdsfs(PyIDebugStackFrameSniffer):Description for pdsfsCommentsGenerally called by a language engine 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 - -Returns: - - typing.Any:Description for pdsfsComments - -Generally called by a language engine - -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 - - - def RemoveStackFrameSniffer(self,dwCookie:'typing.Any') -> 'None': - """ - Removes a stack frame sniffer from this application. - -Args: - - dwCookie(typing.Any):A cookie obtained from PyIDebugApplication::AddStackFrameSniffer - -Returns: - - None - - """ - pass - - - def QueryCurrentThreadIsDebuggerThread(self,) -> 'None': - """ - Determines if the current running thread is the - -debugger thread. - -Args: - - - -Returns: - - None:PyIDebugApplication.QueryCurrentThreadIsDebuggerThread -QueryCurrentThreadIsDebuggerThread()Determines 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 - -debugger thread. - -Args: - - pptc(typing.Any):Description for pptc - dwParam1(typing.Any):Description for dwParam1 - dwParam2(typing.Any):Description for dwParam2 - dwParam3(typing.Any):Description for dwParam3CommentsThis is generally used so that language engines and hosts can implement free threaded objects on top of their single threaded implementations. - -Returns: - - None - - """ - pass - - - def CreateApplicationNode(self,) -> 'PyIDebugApplicationNode': - """ - Creates a new application node which - -is associated with a specific document provider. - -Args: - - - -Returns: - - PyIDebugApplicationNode - - """ - pass - - - def FireDebuggerEvent(self,guid:'typing.Any',unknown:'PyIUnknown') -> 'None': - """ - Fire a generic event to the IApplicationDebugger (if any) - -Args: - - guid(typing.Any):A GUID. - unknown(PyIUnknown):An unknown object. - -Returns: - - None - - """ - pass - - - def HandleRuntimeError(self,pErrorDebug:'PyIActiveScriptErrorDebug',pScriptSite:'PyIActiveScriptSite') -> 'None': - """ - Description of HandleRuntimeError. - -Args: - - pErrorDebug(PyIActiveScriptErrorDebug):Description for pErrorDebug - pScriptSite(PyIActiveScriptSite):Description for pScriptSite - -Returns: - - None - - """ - pass - - - def FCanJitDebug(self,) -> 'None': - """ - Description of FCanJitDebug. - -Args: - - - -Returns: - - None - - """ - pass - - - def FIsAutoJitDebugEnabled(self,) -> 'None': - """ - Description of FIsAutoJitDebugEnabled. - -Args: - - - -Returns: - - None - - """ - pass - - - def AddGlobalExpressionContextProvider(self,pdsfs:'PyIProvideExpressionContexts') -> 'None': - """ - Description of AddGlobalExpressionContextProvider. - -Args: - - pdsfs(PyIProvideExpressionContexts):Description for pdsfs - -Returns: - - None - - """ - pass - - - def RemoveGlobalExpressionContextProvider(self,dwCookie:'typing.Any') -> 'None': - """ - Description of - -RemoveGlobalExpressionContextProvider. - -Args: - - dwCookie(typing.Any):Description for dwCookie - -Returns: - - None - - """ - pass - - -class PyIDebugApplicationNode(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def EnumChildren(self,) -> 'None': - """ - Description of EnumChildren. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetParent(self,) -> 'PyIDebugApplicationNode': - """ - Returns the parent node. - -Args: - - - -Returns: - - PyIDebugApplicationNode - - """ - pass - - - def SetDocumentProvider(self,pddp:'PyIDebugDocumentProvider') -> 'None': - """ - Description of SetDocumentProvider. - -Args: - - pddp(PyIDebugDocumentProvider):Description for pddp - -Returns: - - None - - """ - pass - - - def Close(self,) -> 'None': - """ - Description of Close. - -Args: - - - -Returns: - - None - - """ - pass - - - def Attach(self,pdanParent:'PyIDebugApplicationNode') -> 'None': - """ - Attach a node to its parent. - -Args: - - pdanParent(PyIDebugApplicationNode):The parent node. None is not acceptable. - -Returns: - - None - - """ - pass - - - def Detach(self,) -> 'None': - """ - Detach a node from its parent. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugApplicationNodeEvents(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def onAddChild(self,prddpChild:'PyIDebugApplicationNode') -> 'None': - """ - Description of onAddChild. - -Args: - - prddpChild(PyIDebugApplicationNode):Description for prddpChild - -Returns: - - None - - """ - pass - - - def onRemoveChild(self,prddpChild:'PyIDebugApplicationNode') -> 'None': - """ - Description of onRemoveChild. - -Args: - - prddpChild(PyIDebugApplicationNode):Description for prddpChild - -Returns: - - None - - """ - pass - - - def onDetach(self,) -> 'None': - """ - Description of onDetach. - -Args: - - - -Returns: - - None - - """ - pass - - - def onAttach(self,prddpParent:'PyIDebugApplicationNode') -> 'None': - """ - Description of onAttach. - -Args: - - prddpParent(PyIDebugApplicationNode):Description for prddpParent - -Returns: - - None - - """ - pass - - -class PyIDebugApplicationThread(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SynchronousCallIntoThread(self,pstcb:'typing.Any',dwParam1:'typing.Any',dwParam2:'typing.Any',dwParam3:'typing.Any') -> 'None': - """ - Description of SynchronousCallIntoThread. - -Args: - - pstcb(typing.Any):Description for pstcb - dwParam1(typing.Any):Description for dwParam1 - dwParam2(typing.Any):Description for dwParam2 - dwParam3(typing.Any):Description for dwParam3 - -Returns: - - None - - """ - pass - - - def QueryIsCurrentThread(self,) -> 'None': - """ - Description of QueryIsCurrentThread. - -Args: - - - -Returns: - - None - - """ - pass - - - def QueryIsDebuggerThread(self,) -> 'None': - """ - Description of QueryIsDebuggerThread. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugCodeContext(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDocumentContext(self,) -> 'None': - """ - Description of GetDocumentContext. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetBreakPoint(self,bps:'typing.Any') -> 'None': - """ - Description of SetBreakPoint. - -Args: - - bps(typing.Any):Description for bps - -Returns: - - None - - """ - pass - - -class PyIDebugDocument(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIDebugDocumentContext(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDocument(self,) -> 'None': - """ - Description of GetDocument. - -Args: - - - -Returns: - - None - - """ - pass - - - def EnumCodeContexts(self,) -> 'None': - """ - Description of EnumCodeContexts. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugDocumentHelper(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Init(self,pda:'PyIDebugApplication',pszShortName:'typing.Any',pszLongName:'typing.Any',docAttr:'typing.Any') -> 'None': - """ - Description of Init. - -Args: - - pda(PyIDebugApplication):Description for pda - pszShortName(typing.Any):Description for pszShortName - pszLongName(typing.Any):Description for pszLongName - docAttr(typing.Any):Description for docAttr - -Returns: - - None - - """ - pass - - - def Attach(self,pddhParent:'PyIDebugDocumentHelper') -> 'None': - """ - Add the document to the doc tree - -Args: - - pddhParent(PyIDebugDocumentHelper):Parent item. If none, this item is top level. - -Returns: - - None - - """ - pass - - - def Detach(self,) -> 'None': - """ - Description of Detach. - -Args: - - - -Returns: - - None - - """ - pass - - - def AddUnicodeText(self,pszText:'typing.Any') -> 'None': - """ - Description of AddUnicodeText. - -Args: - - pszText(typing.Any):Description for pszText - -Returns: - - None - - """ - pass - - - def AddDBCSText(self,) -> 'None': - """ - Description of AddDBCSText. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetDebugDocumentHost(self,pddh:'PyIDebugDocumentHost') -> 'None': - """ - Description of SetDebugDocumentHost. - -Args: - - pddh(PyIDebugDocumentHost):Description for pddh - -Returns: - - None - - """ - pass - - - def AddDeferredText(self,cChars:'typing.Any',dwTextStartCookie:'typing.Any') -> 'None': - """ - Description of AddDeferredText. - -Args: - - cChars(typing.Any):Description for cChars - dwTextStartCookie(typing.Any):Description for dwTextStartCookie - -Returns: - - None - - """ - pass - - - def DefineScriptBlock(self,ulCharOffset:'typing.Any',cChars:'typing.Any',pas:'typing.Any',fScriptlet:'typing.Any') -> 'None': - """ - Description of DefineScriptBlock. - -Args: - - ulCharOffset(typing.Any):Description for ulCharOffset - cChars(typing.Any):Description for cChars - pas(typing.Any):Description for pas - fScriptlet(typing.Any):Description for fScriptlet - -Returns: - - None - - """ - pass - - - def SetDefaultTextAttr(self,staTextAttr:'typing.Any') -> 'None': - """ - Description of SetDefaultTextAttr. - -Args: - - staTextAttr(typing.Any):Description for staTextAttr - -Returns: - - None - - """ - pass - - - def SetTextAttributes(self,ulCharOffset:'typing.Any',obAttr:'typing.Any') -> 'None': - """ - Description of SetTextAttributes. - -Args: - - ulCharOffset(typing.Any):Description for ulCharOffset - obAttr(typing.Any):A sequence of attributes. - -Returns: - - None - - """ - pass - - - def SetLongName(self,pszLongName:'typing.Any') -> 'None': - """ - Description of SetLongName. - -Args: - - pszLongName(typing.Any):Description for pszLongName - -Returns: - - None - - """ - pass - - - def SetShortName(self,pszShortName:'typing.Any') -> 'None': - """ - Description of SetShortName. - -Args: - - pszShortName(typing.Any):Description for pszShortName - -Returns: - - None - - """ - pass - - - def SetDocumentAttr(self,pszAttributes:'typing.Any') -> 'None': - """ - Description of SetDocumentAttr. - -Args: - - pszAttributes(typing.Any):Description for pszAttributes - -Returns: - - None - - """ - pass - - - def GetDebugApplicationNode(self,) -> 'None': - """ - Description of GetDebugApplicationNode. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetScriptBlockInfo(self,dwSourceContext:'typing.Any') -> 'None': - """ - Description of GetScriptBlockInfo. - -Args: - - dwSourceContext(typing.Any):Description for dwSourceContext - -Returns: - - None - - """ - pass - - - def CreateDebugDocumentContext(self,iCharPos:'typing.Any',cChars:'typing.Any') -> 'None': - """ - Description of CreateDebugDocumentContext. - -Args: - - iCharPos(typing.Any):Description for iCharPos - cChars(typing.Any):Description for cChars - -Returns: - - None - - """ - pass - - - def BringDocumentToTop(self,) -> 'None': - """ - Description of BringDocumentToTop. - -Args: - - - -Returns: - - None - - """ - pass - - - def BringDocumentContextToTop(self,pddc:'PyIDebugDocumentContext') -> 'None': - """ - Description of BringDocumentContextToTop. - -Args: - - pddc(PyIDebugDocumentContext):Description for pddc - -Returns: - - None - - """ - pass - - -class PyIDebugDocumentHost(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDeferredText(self,dwTextStartCookie:'typing.Any',cMaxChars:'typing.Any') -> 'None': - """ - Description of GetDeferredText. - -Args: - - dwTextStartCookie(typing.Any):Description for dwTextStartCookie - cMaxChars(typing.Any):Description for cMaxChars - -Returns: - - None - - """ - pass - - - def GetScriptTextAttributes(self,pstrCode:'typing.Any',pstrDelimiter:'typing.Any',dwFlags:'typing.Any') -> 'None': - """ - Description of GetScriptTextAttributes. - -Args: - - pstrCode(typing.Any):Description for pstrCode - pstrDelimiter(typing.Any):Description for pstrDelimiter - dwFlags(typing.Any):Description for dwFlags - -Returns: - - None - - """ - pass - - - def OnCreateDocumentContext(self,) -> 'None': - """ - Description of OnCreateDocumentContext. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPathName(self,) -> 'None': - """ - Description of GetPathName. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetFileName(self,) -> 'None': - """ - Description of GetFileName. - -Args: - - - -Returns: - - None - - """ - pass - - - def NotifyChanged(self,) -> 'None': - """ - Description of NotifyChanged. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugDocumentInfo(object): - """Provides information on a document, which may or may not be instantiated.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetName(self,) -> 'None': - """ - Returns the specified name for the document. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDocumentClassId(self,) -> 'PyIID': - """ - Returns a CLSID describing the document type. - -Args: - - - -Returns: - - PyIID - - """ - pass - - -class PyIDebugDocumentProvider(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDocument(self,) -> 'PyIDebugDocument': - """ - Causes the document to be instantiated if it does - -not already exist. - -Args: - - - -Returns: - - PyIDebugDocument - - """ - pass - - -class PyIDebugDocumentText(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDocumentAttributes(self,) -> 'None': - """ - Description of GetDocumentAttributes. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetSize(self,) -> 'None': - """ - Description of GetSize. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPositionOfLine(self,cLineNumber:'typing.Any') -> 'None': - """ - Description of GetPositionOfLine. - -Args: - - cLineNumber(typing.Any):Description for cLineNumber - -Returns: - - None - - """ - pass - - - def GetLineOfPosition(self,cCharacterPosition:'typing.Any') -> 'None': - """ - Description of GetLineOfPosition. - -Args: - - cCharacterPosition(typing.Any):Description for cCharacterPosition - -Returns: - - None - - """ - pass - - - def GetText(self,cCharacterPosition:'typing.Any',cMaxChars:'typing.Any',bWantAttr:'typing.Any'=1) -> 'None': - """ - Description of GetText. - -Args: - - cCharacterPosition(typing.Any): - cMaxChars(typing.Any):Max chars to return - bWantAttr(typing.Any):Should the attributes be returned? - -Returns: - - None - - """ - pass - - - def GetPositionOfContext(self,psc:'PyIDebugDocumentContext') -> 'None': - """ - Description of GetPositionOfContext. - -Args: - - psc(PyIDebugDocumentContext):Description for psc - -Returns: - - None - - """ - pass - - - def GetContextOfPosition(self,cCharacterPosition:'typing.Any',cNumChars:'typing.Any') -> 'None': - """ - Description of GetContextOfPosition. - -Args: - - cCharacterPosition(typing.Any):Description for cCharacterPosition - cNumChars(typing.Any):Description for cNumChars - -Returns: - - None - - """ - pass - - -class PyIDebugDocumentTextAuthor(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def InsertText(self,cCharacterPosition:'typing.Any',cNumToInsert:'typing.Any',pcharText:'typing.Any') -> 'None': - """ - Description of InsertText. - -Args: - - cCharacterPosition(typing.Any):Description for cCharacterPosition - cNumToInsert(typing.Any):Description for cNumToInsert - pcharText(typing.Any):Description for pcharText - -Returns: - - None - - """ - pass - - - def RemoveText(self,cCharacterPosition:'typing.Any',cNumToRemove:'typing.Any') -> 'None': - """ - Description of RemoveText. - -Args: - - cCharacterPosition(typing.Any):Description for cCharacterPosition - cNumToRemove(typing.Any):Description for cNumToRemove - -Returns: - - None - - """ - pass - - - def ReplaceText(self,cCharacterPosition:'typing.Any',cNumToReplace:'typing.Any',pcharText:'typing.Any') -> 'None': - """ - Description of ReplaceText. - -Args: - - cCharacterPosition(typing.Any):Description for cCharacterPosition - cNumToReplace(typing.Any):Description for cNumToReplace - pcharText(typing.Any):Description for pcharText - -Returns: - - None - - """ - pass - - -class PyIDebugDocumentTextEvents(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def onDestroy(self,) -> 'None': - """ - Description of onDestroy. - -Args: - - - -Returns: - - None - - """ - pass - - - def onInsertText(self,cCharacterPosition:'typing.Any',cNumToInsert:'typing.Any') -> 'None': - """ - Description of onInsertText. - -Args: - - cCharacterPosition(typing.Any):Description for cCharacterPosition - cNumToInsert(typing.Any):Description for cNumToInsert - -Returns: - - None - - """ - pass - - - def onRemoveText(self,cCharacterPosition:'typing.Any',cNumToRemove:'typing.Any') -> 'None': - """ - Description of onRemoveText. - -Args: - - cCharacterPosition(typing.Any):Description for cCharacterPosition - cNumToRemove(typing.Any):Description for cNumToRemove - -Returns: - - None - - """ - pass - - - def onReplaceText(self,cCharacterPosition:'typing.Any',cNumToReplace:'typing.Any') -> 'None': - """ - Description of onReplaceText. - -Args: - - cCharacterPosition(typing.Any):Description for cCharacterPosition - cNumToReplace(typing.Any):Description for cNumToReplace - -Returns: - - None - - """ - pass - - - def onUpdateTextAttributes(self,cCharacterPosition:'typing.Any',cNumToUpdate:'typing.Any') -> 'None': - """ - Description of onUpdateTextAttributes. - -Args: - - cCharacterPosition(typing.Any):Description for cCharacterPosition - cNumToUpdate(typing.Any):Description for cNumToUpdate - -Returns: - - None - - """ - pass - - - def onUpdateDocumentAttributes(self,textdocattr:'typing.Any') -> 'None': - """ - Description of onUpdateDocumentAttributes. - -Args: - - textdocattr(typing.Any):Description for textdocattr - -Returns: - - None - - """ - pass - - -class PyIDebugDocumentTextExternalAuthor(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPathName(self,) -> 'None': - """ - Description of GetPathName. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetFileName(self,) -> 'None': - """ - Description of GetFileName. - -Args: - - - -Returns: - - None - - """ - pass - - - def NotifyChanged(self,) -> 'None': - """ - Description of NotifyChanged. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugExpression(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Start(self,pdecb:'PyIDebugExpressionCallBack') -> 'None': - """ - Description of Start. - -Args: - - pdecb(PyIDebugExpressionCallBack):Description for pdecb - -Returns: - - None - - """ - pass - - - def Abort(self,) -> 'None': - """ - Description of Abort. - -Args: - - - -Returns: - - None - - """ - pass - - - def QueryIsComplete(self,) -> 'None': - """ - Description of QueryIsComplete. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetResultAsString(self,) -> 'None': - """ - Description of GetResultAsString. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetResultAsDebugProperties(self,) -> 'None': - """ - Description of GetResultAsDebugProperty. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugExpressionCallBack(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def onComplete(self,) -> 'None': - """ - Description of onComplete. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugExpressionContext(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ParseLanguageText(self,pstrCode:'typing.Any',nRadix:'typing.Any',pstrDelimiter:'typing.Any',dwFlags:'typing.Any') -> 'None': - """ - Description of ParseLanguageText. - -Args: - - pstrCode(typing.Any):Description for pstrCode - nRadix(typing.Any):Description for nRadix - pstrDelimiter(typing.Any):Description for pstrDelimiter - dwFlags(typing.Any):Description for dwFlags - -Returns: - - None - - """ - pass - - - def GetLanguageInfo(self,) -> 'None': - """ - Description of GetLanguageInfo. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugProperty(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPropertyInfo(self,dwFieldSpec:'typing.Any',nRadix:'typing.Any') -> 'None': - """ - Description of GetPropertyInfo. - -Args: - - dwFieldSpec(typing.Any):Description for dwFieldSpec - nRadix(typing.Any):Description for nRadix - -Returns: - - None - - """ - pass - - - def GetExtendedInfo(self,) -> 'None': - """ - Description of GetExtendedInfo. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetValueAsString(self,pszValue:'typing.Any',nRadix:'typing.Any') -> 'None': - """ - Description of SetValueAsString. - -Args: - - pszValue(typing.Any):Description for pszValue - nRadix(typing.Any):Description for nRadix - -Returns: - - None - - """ - pass - - - def EnumMembers(self,dwFieldSpec:'typing.Any',nRadix:'typing.Any',refiid:'PyIID') -> 'None': - """ - Description of EnumMembers. - -Args: - - dwFieldSpec(typing.Any):Description for dwFieldSpec - nRadix(typing.Any):Description for nRadix - refiid(PyIID):Description for refiid - -Returns: - - None - - """ - pass - - - def GetParent(self,) -> 'None': - """ - Description of GetParent. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugSessionProvider(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def StartDebugSession(self,pda:'PyIRemoteDebugApplication') -> 'None': - """ - Description of StartDebugSession. - -Args: - - pda(PyIRemoteDebugApplication):Description for pda - -Returns: - - None - - """ - pass - - -class PyIDebugStackFrame(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetCodeContext(self,) -> 'None': - """ - Returns the current code context associated with the stack frame. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDescriptionString(self,fLong:'typing.Any') -> 'typing.Any': - """ - Returns a short or long textual description of the - -stack frame. - -Args: - - fLong(typing.Any):If false, provide only the name of the function associated with the stack frame. When true it may also provide the parameter(s) to the function or whatever else is relevant. - -Returns: - - typing.Any - - """ - pass - - - def GetLanguageString(self,fLong:'typing.Any') -> 'typing.Any': - """ - Returns a short or long textual description of the - -language. - -Args: - - fLong(typing.Any):If False, just the language name should be provided, eg, "Python". If True a full product description may be provided (eg, "Python 1.4 ActiveX Debugging Host") - -Returns: - - typing.Any - - """ - pass - - - def GetThread(self,) -> 'PyIDebugApplicationThread': - """ - Returns the thread associated with this stack - -frame. - -Args: - - - -Returns: - - PyIDebugApplicationThread - - """ - pass - - -class PyIDebugStackFrameSniffer(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def EnumStackFrames(self,) -> 'None': - """ - Description of EnumStackFrames. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugStackFrameSnifferEx(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def EnumStackFramesEx(self,) -> 'None': - """ - Description of EnumStackFrames. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDebugSyncOperation(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetTargetThread(self,) -> 'None': - """ - Description of GetTargetThread. - -Args: - - - -Returns: - - None - - """ - pass - - - def Execute(self,) -> 'None': - """ - Description of Execute. - -Args: - - - -Returns: - - None - - """ - pass - - - def InProgressAbort(self,) -> 'None': - """ - Description of InProgressAbort. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDefaultExtractIconInit(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetFlags(self,uFlags:'typing.Any') -> 'None': - """ - Description of SetFlags. - -Args: - - uFlags(typing.Any):Description for uFlags - -Returns: - - None - - """ - pass - - - def SetKey(self,hkey:'PyHKEY') -> 'None': - """ - Description of SetKey. - -Args: - - hkey(PyHKEY):Description for hkey - -Returns: - - None - - """ - pass - - - def SetNormalIcon(self,pszFile:'typing.Any',iIcon:'typing.Any') -> 'None': - """ - Description of SetNormalIcon. - -Args: - - pszFile(typing.Any):Description for pszFile - iIcon(typing.Any):Description for iIcon - -Returns: - - None - - """ - pass - - - def SetOpenIcon(self,pszFile:'typing.Any',iIcon:'typing.Any') -> 'None': - """ - Description of SetOpenIcon. - -Args: - - pszFile(typing.Any):Description for pszFile - iIcon(typing.Any):Description for iIcon - -Returns: - - None - - """ - pass - - - def SetShortcutIcon(self,pszFile:'typing.Any',iIcon:'typing.Any') -> 'None': - """ - Description of SetShortcutIcon. - -Args: - - pszFile(typing.Any):Description for pszFile - iIcon(typing.Any):Description for iIcon - -Returns: - - None - - """ - pass - - - def SetDefaultIcon(self,pszFile:'typing.Any',iIcon:'typing.Any') -> 'None': - """ - Description of SetDefaultIcon. - -Args: - - pszFile(typing.Any):Description for pszFile - iIcon(typing.Any):Description for iIcon - -Returns: - - None - - """ - pass - - -class PyIDirectSound(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,guid:'PyIID') -> 'None': - """ - Description of Initialize. - -Args: - - guid(PyIID):Globally unique identifier (GUID) specifying the sound driver to which this DirectSound object binds. Pass None to select the primary sound driver. - -Returns: - - None - - """ - pass - - - def SetCooperativeLevel(self,hwnd:'typing.Any',level:'typing.Any') -> 'None': - """ - The IDirectSound::SetCooperativeLevel method sets the cooperative level - -of the application for this sound device. - -Args: - - hwnd(typing.Any):Window handle to the application or None. - level(typing.Any):Requested priority level. Specify one of the following values:LevelDescriptionDSSCL_NORMALSets the application to a fully cooperative status. Most applications should use this level, because it has the smoothest multitasking and resource-sharing behavior.DSSCL_PRIORITYSets the application to the priority level. Applications with this cooperative level can call the DirectSoundBuffer.setFormat and DirectSound.compact methods.DSSCL_EXCLUSIVESets the application to the exclusive level. When it has the input focus, the application will be the only one audible (sounds from applications with the DSBCAPS_GLOBALFOCUS flag set will be muted). With this level, it also has all the privileges of the DSSCL_PRIORITY level. DirectSound will restore the hardware format, as specified by the most recent call to the DirectSoundBuffer.setFormat method, once the application gains the input focus. (Note that DirectSound will always restore the wave format, no matter what priority level is set.)DSSCL_WRITEPRIMARYThis is the highest priority level. The application has write access to the primary sound buffers. No secondary sound buffers in any application can be played. - -Returns: - - None - - """ - pass - - - def CreateSoundBuffer(self,lpDSCBufferDesc:'PyDSCBUFFERDESC',unk:'typing.Any'=None) -> 'None': - """ - The IDirectSound::CreateSoundBuffer method creates a DirectSoundBuffer - -object to hold a sequence of audio samples. - -Args: - - lpDSCBufferDesc(PyDSCBUFFERDESC):a DSBUFFERDESC structure containing values for the sound buffer being created. - unk(typing.Any):The IUnknown for COM aggregation. - -Returns: - - None - - """ - pass - - - def GetCaps(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def Compact(self,) -> 'None': - """ - 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. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDirectSoundBuffer(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,) -> 'None': - """ - Description of Initialize. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetStatus(self,) -> 'None': - """ - Retrieves the current status of the sound buffer. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCaps(self,) -> 'None': - """ - Retrieves the capabilities of the DirectSoundBuffer object as a DSBCAPS - -object. - -Args: - - - -Returns: - - None - - """ - pass - - - def Restore(self,) -> 'None': - """ - Restores the memory allocation for a lost sound buffer for the specified - -DirectSoundBuffer object. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCurrentPosition(self,) -> 'None': - """ - Description of GetCurrentPosition. - -Args: - - - -Returns: - - None - - """ - pass - - - def Play(self,) -> 'None': - """ - Description of Play. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetCurrentPosition(self,) -> 'None': - """ - Description of SetCurrentPosition. - -Args: - - - -Returns: - - None - - """ - pass - - - def Stop(self,) -> 'None': - """ - Description of Stop. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetFrequency(self,) -> 'None': - """ - Description of GetFrequency. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPan(self,) -> 'None': - """ - Description of GetPan. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetVolume(self,) -> 'None': - """ - Description of GetVolume. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetFrequency(self,) -> 'None': - """ - Description of SetFrequency. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetPan(self,) -> 'None': - """ - Description of SetPan. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetVolume(self,) -> 'None': - """ - Description of SetVolume. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDirectSoundCapture(object): - """The methods of the IDirectSoundCapture interface are used to create sound capture - -buffers.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,) -> 'None': - """ - Not normally called directly. Use DirectSoundCaptureCreate instead. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCaps(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDirectSoundCaptureBuffer(object): - """The methods of the IDirectSoundCaptureBuffer interface are used to manipulate - -sound capture buffers.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,) -> 'None': - """ - Not normally used. Used IDirectSoundCapture.CreateCaptureBuffer - -instead. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetStatus(self,) -> 'None': - """ - Retrieves the current status of the sound capture buffer. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCurrentPosition(self,) -> 'None': - """ - 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 - -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. - -Args: - - - -Returns: - - None - - """ - pass - - - def Stop(self,) -> 'None': - """ - 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 - -effect. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIDirectSoundNotify(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIDirectoryObject(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetObjectInformation(self,) -> 'PyADS_OBJECT_INFO': - """ - None - -Args: - - - -Returns: - - PyADS_OBJECT_INFO - - """ - pass - - - def GetObjectAttributes(self,names:'typing.Tuple[str, ...]') -> 'typing.Tuple[PyADS_ATTR_INFO, ...]': - """ - None - -Args: - - names(typing.Tuple[str, ...]): - -Returns: - - typing.Tuple[PyADS_ATTR_INFO, ...] - - """ - pass - - - def SetObjectAttributes(self,attrs:'typing.Tuple[PyADS_ATTR_INFO, ...]') -> 'typing.Any': - """ - None - -Args: - - attrs(typing.Tuple[PyADS_ATTR_INFO, ...]):The attributes to set - -Returns: - - typing.Any - - """ - pass - - - def CreateDSObject(self,rdn:'str',attrs:'typing.Tuple[PyADS_ATTR_INFO, ...]') -> 'PyIDispatch': - """ - None - -Args: - - rdn(str):The relative distinguished name (relative path) of the object to be created. - attrs(typing.Tuple[PyADS_ATTR_INFO, ...]):The attributes to set. - -Returns: - - PyIDispatch - - """ - pass - - - def DeleteDSObject(self,rdn:'str') -> 'None': - """ - Deletes a leaf object in a directory tree - -Args: - - rdn(str):The relative distinguished name (relative path) of the object to be deleted. - -Returns: - - None - - """ - pass - - -class PyIDirectorySearch(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetSearchPreference(self,prefs:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': - """ - None - -Args: - - prefs(typing.Any):Return ValueThe result is the hresult of the call, and a list of integer status codes for each of the preferences set. - -Returns: - - 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 - - - def ExecuteSearch(self,_filter:'str',attrNames:'typing.List[str]') -> 'typing.Any': - """ - None - -Args: - - _filter(str): - attrNames(typing.List[str]):Return ValueThe result is an integer search handle. PyIDirectorySearch::CloseSearchHandle should be called to close the handle. - -Returns: - - typing.Any:Return ValueThe result is an integer search handle. PyIDirectorySearch::CloseSearchHandle - -should be called to close the handle. - - - """ - pass - - - def GetNextRow(self,handle:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - handle(typing.Any):Return ValueThe result is the HRESULT from the call - no exceptions are thrown - -Returns: - - typing.Any:Return ValueThe result is the HRESULT from the call - no exceptions are thrown - - - """ - pass - - - def GetFirstRow(self,handle:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - handle(typing.Any):Return ValueThe result is the HRESULT from the call - no exceptions are thrown - -Returns: - - typing.Any:Return ValueThe result is the HRESULT from the call - no exceptions are thrown - - - """ - pass - - - def GetPreviousRow(self,handle:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - handle(typing.Any):Return ValueThe result is the HRESULT from the call - no exceptions are thrown - -Returns: - - typing.Any:Return ValueThe result is the HRESULT from the call - no exceptions are thrown - - - """ - pass - - - def CloseSearchHandle(self,handle:'typing.Any') -> 'None': - """ - Closes a previously opened search handle. - -Args: - - handle(typing.Any): - -Returns: - - None - - """ - pass - - - def AdandonSearch(self,handle:'typing.Any') -> 'None': - """ - None - -Args: - - handle(typing.Any): - -Returns: - - None - - """ - pass - - - def GetColumn(self,handle:'typing.Any',name:'str') -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': - """ - None - -Args: - - handle(typing.Any):Handle to a search - name(str):The column name to fetch - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any] - - """ - pass - - - def GetNextColumnName(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None:PyIDirectorySearch.GetNextColumnName -GetNextColumnName() -Return ValueReturns None when the underlying ADSI function return S_ADS_NOMORE_COLUMNS. - - - """ - pass - - -class PyIDispatch(object): - """A OLE automation client object.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Invoke(self,dispid:'typing.Any',lcid:'typing.Any',flags:'typing.Any',bResultWanted:'typing.Any',arg:'typing.Tuple[typing.Any, ...]') -> 'typing.Any': - """ - Invokes a DISPID, using the passed arguments. - -Args: - - dispid(typing.Any):The dispid to use. Typically this value will come from PyIDispatch::GetIDsOfNames or from a type library. - lcid(typing.Any):The locale id to use. - flags(typing.Any):The flags for the call. The following flags can be used.FlagDescriptionDISPATCH_METHODThe member is invoked as a method. If a property has the same name, both this and the DISPATCH_PROPERTYGET flag may be set.DISPATCH_PROPERTYGETThe member is retrieved as a property or data member.DISPATCH_PROPERTYPUTThe member is changed as a property or data member.DISPATCH_PROPERTYPUTREFThe member is changed by a reference assignment, rather than a value assignment. This flag is valid only when the property accepts a reference to an object. - bResultWanted(typing.Any):Indicates if the result of the call should be requested. - arg(typing.Tuple[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) - -Returns: - - 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 - - - def InvokeTypes(self,dispid:'typing.Any',lcid:'typing.Any',wFlags:'typing.Any',resultTypeDesc:'typing.Any',typeDescs:'typing.Tuple[typing.Any, ...]',args:'typing.Tuple[typing.Any, ...]') -> 'typing.Any': - """ - Invokes a DISPID, using the passed arguments and type descriptions. - -Args: - - dispid(typing.Any):The dispid to use. Please see PyIDispatch::Invoke. - lcid(typing.Any):The locale ID. Please see PyIDispatch::Invoke. - wFlags(typing.Any):Flags for the call. Please see PyIDispatch::Invoke. - resultTypeDesc(typing.Any):A tuple describing the type of the result. See the comments for more information. - typeDescs(typing.Tuple[typing.Any, ...]):A sequence of tuples describing the types of the parameters for the function. See the comments for more information. - args(typing.Tuple[typing.Any, ...]):The args to the function.CommentsThe Microsoft documentation for IDispatch should be used for all params except 'resultTypeDesc' and 'typeDescs'. 'resultTypeDesc' describes the return value of the function, and is a tuple of (type_id, flags). 'typeDescs' describes the type of each parameters, and is a list of the same (type_id, flags) tuple.itemDescriptiontype_idA valid "variant type" constant (eg, VT_I4 | VT_ARRAY, VT_DATE, etc - see VARIANT at MSDN).flagsOne of the PARAMFLAG constants (eg, PARAMFLAG_FIN, PARAMFLAG_FOUT etc - see PARAMFLAG at MSDN).ExampleAn example from the makepy generated file for Wordclass Cells(DispatchBaseClass):... def SetWidth(self, ColumnWidth=..., RulerStyle=...): return self._oleobj_.InvokeTypes(202, LCID, 1, (24, 0), ((4, 1), (3, 1)),...)The interesting bits areresultTypeDesc: (24, 0) - (VT_VOID, <no flags>)typeDescs: ((4, 1), (3, 1)) - ((VT_R4, PARAMFLAG_FIN), (VT_I4, PARAMFLAG_FIN))So, in this example, the function returns no value and takes 2 "in" params - ColumnWidth is a float, and RulerStule is an int. - -Returns: - - typing.Any - - """ - pass - - - def GetIDsOfNames(self,name:'str',arg:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Union[typing.Any]]': - """ - Get the DISPID for the passed names. - -Args: - - name(str):A name to query forAlternative Parameters - arg(typing.Any):A sequence of string names to queryCommentsCurrently 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 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. - -Returns: - - typing.Tuple[typing.Any, typing.Union[typing.Any]]:A sequence of string names to query -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 - -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 - - - def GetTypeInfo(self,locale:'typing.Any',index:'typing.Any'=0) -> 'PyITypeInfo': - """ - Get type information for the object. - -Args: - - locale(typing.Any):The locale to use. - index(typing.Any):The index of the typelibrary to fetch. Note that these params are reversed from the win32 call. - -Returns: - - PyITypeInfo - - """ - pass - - - def GetTypeInfoCount(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyIDispatchEx(object): - """A OLE automation client object that uses the IDispatchEx scripting interface..""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDispID(self,name:'str',fdex:'typing.Any') -> 'typing.Any': - """ - Returns the member id for a name - -Args: - - name(str):Passed in name to be mapped - fdex(typing.Any):Determines the options for obtaining the member identifier. This can be a combination of the fdex* constants: - -Returns: - - typing.Any - - """ - pass - - - def InvokeEx(self,dispid:'typing.Any',lcid:'typing.Any',flags:'typing.Any',args:'typing.List[typing.Any]',types:'typing.List[typing.Any]'=None,returnDesc:'typing.Any'=1,serviceProvider:'PyIServiceProvider'=None) -> 'typing.Any': - """ - None - -Args: - - dispid(typing.Any): - lcid(typing.Any): - flags(typing.Any): - args(typing.List[typing.Any]):The arguments. - types(typing.List[typing.Any]):A tuple of type description object, or None if type descriptions are not available. - returnDesc(typing.Any):If types==None, should be a BOOL indicating if the result is needed. If types is a tuple, then should a be type description. - serviceProvider(PyIServiceProvider):A service provider object supplied by the caller which allows the object to obtain services from the caller. Can be None. - -Returns: - - typing.Any - - """ - pass - - - def DeleteMemberByName(self,name:'str',fdex:'typing.Any') -> 'None': - """ - None - -Args: - - name(str):Passed in name to be mapped - fdex(typing.Any):Determines the options - -Returns: - - None - - """ - pass - - - def DeleteMemberByDispID(self,dispid:'typing.Any') -> 'None': - """ - None - -Args: - - dispid(typing.Any): - -Returns: - - None - - """ - pass - - - def GetMemberProperties(self,dispid:'typing.Any',fdex:'typing.Any') -> 'typing.Any': - """ - Returns mask of fdex* flags describing a member - -Args: - - dispid(typing.Any):The member id - fdex(typing.Any):fdex* flags specifying which properties to return - -Returns: - - typing.Any - - """ - pass - - - def GetMemberName(self,dispid:'typing.Any') -> 'typing.Any': - """ - Returns the name associated with a member id - -Args: - - dispid(typing.Any):The member id - -Returns: - - typing.Any - - """ - pass - - - def GetNextDispID(self,fdex:'typing.Any',dispid:'typing.Any') -> 'typing.Any': - """ - Enumerates member ids. - -Args: - - fdex(typing.Any):Determines the options - dispid(typing.Any):Current member, or DISPID_STARTENUM to begin enumeration. GetNextDispID will retrieve the item in the enumeration after this one. - -Returns: - - typing.Any - - """ - pass - - -class PyIDisplayItem(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIDocHostUIHandler(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ShowContextMenu(self,dwID:'typing.Any',pt:'typing.Tuple[typing.Any, typing.Any]',pcmdtReserved:'PyIUnknown',pdispReserved:'PyIDispatch') -> 'None': - """ - Description of ShowContextMenu. - -Args: - - dwID(typing.Any):Description for dwID - pt(typing.Tuple[typing.Any, typing.Any]):Description for ppt - pcmdtReserved(PyIUnknown):Description for pcmdtReserved - pdispReserved(PyIDispatch):Description for pdispReserved - -Returns: - - None - - """ - pass - - - def GetHostInfo(self,) -> 'None': - """ - Description of GetHostInfo. - -Args: - - - -Returns: - - None - - """ - pass - - - def ShowUI(self,dwID:'typing.Any',pActiveObject:'PyIOleInPlaceActiveObject',pCommandTarget:'PyIOleCommandTarget',pFrame:'PyIOleInPlaceFrame',pDoc:'PyIOleInPlaceUIWindow') -> 'None': - """ - Description of ShowUI. - -Args: - - dwID(typing.Any):Description for dwID - pActiveObject(PyIOleInPlaceActiveObject):Description for pActiveObject - pCommandTarget(PyIOleCommandTarget):Description for pCommandTarget - pFrame(PyIOleInPlaceFrame):Description for pFrame - pDoc(PyIOleInPlaceUIWindow):Description for pDoc - -Returns: - - None - - """ - pass - - - def HideUI(self,) -> 'None': - """ - Description of HideUI. - -Args: - - - -Returns: - - None - - """ - pass - - - def UpdateUI(self,) -> 'None': - """ - Description of UpdateUI. - -Args: - - - -Returns: - - None - - """ - pass - - - def EnableModeless(self,fEnable:'typing.Any') -> 'None': - """ - Description of EnableModeless. - -Args: - - fEnable(typing.Any):Description for fEnable - -Returns: - - None - - """ - pass - - - def OnDocWindowActivate(self,fActivate:'typing.Any') -> 'None': - """ - Description of OnDocWindowActivate. - -Args: - - fActivate(typing.Any):Description for fActivate - -Returns: - - None - - """ - pass - - - def OnFrameWindowActivate(self,fActivate:'typing.Any') -> 'None': - """ - Description of OnFrameWindowActivate. - -Args: - - fActivate(typing.Any):Description for fActivate - -Returns: - - None - - """ - pass - - - def ResizeBorder(self,prcBorder:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',pUIWindow:'PyIOleInPlaceUIWindow',fRameWindow:'typing.Any') -> 'None': - """ - Description of ResizeBorder. - -Args: - - prcBorder(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Description for prcBorder - pUIWindow(PyIOleInPlaceUIWindow):Description for pUIWindow - fRameWindow(typing.Any):Description for fRameWindow - -Returns: - - None - - """ - pass - - - def TranslateAccelerator(self,lpMsg:'typing.Any',pguidCmdGroup:'PyIID',nCmdID:'typing.Any') -> 'None': - """ - Description of TranslateAccelerator. - -Args: - - lpMsg(typing.Any):Description for lpMsg - pguidCmdGroup(PyIID):Description for pguidCmdGroup - nCmdID(typing.Any):Description for nCmdID - -Returns: - - None - - """ - pass - - - def GetOptionKeyPath(self,dw:'typing.Any') -> 'None': - """ - Description of GetOptionKeyPath. - -Args: - - dw(typing.Any):Description for dw - -Returns: - - None - - """ - pass - - - def GetDropTarget(self,pDropTarget:'PyIDropTarget') -> 'None': - """ - Description of GetDropTarget. - -Args: - - pDropTarget(PyIDropTarget):Description for pDropTarget - -Returns: - - None - - """ - pass - - - def GetExternal(self,) -> 'None': - """ - Description of GetExternal. - -Args: - - - -Returns: - - None - - """ - pass - - - def TranslateUrl(self,dwTranslate:'typing.Any',pchURLIn:'typing.Any') -> 'None': - """ - Description of TranslateUrl. - -Args: - - dwTranslate(typing.Any):Description for dwTranslate - pchURLIn(typing.Any):Description for pchURLIn - -Returns: - - None - - """ - pass - - - def FilterDataObject(self,pDO:'PyIDataObject') -> 'None': - """ - Description of FilterDataObject. - -Args: - - pDO(PyIDataObject):Description for pDO - -Returns: - - None - - """ - pass - - -class PyIDropSource(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def QueryContinueDrag(self,fEscapePressed:'typing.Any',grfKeyState:'typing.Any') -> 'None': - """ - Description of QueryContinueDrag. - -Args: - - fEscapePressed(typing.Any):Description for fEscapePressed - grfKeyState(typing.Any):Description for grfKeyState - -Returns: - - None - - """ - pass - - - def GiveFeedback(self,dwEffect:'typing.Any') -> 'None': - """ - Description of GiveFeedback. - -Args: - - dwEffect(typing.Any):Description for dwEffect - -Returns: - - None - - """ - pass - - -class PyIDropTarget(object): - """Interface that acts as a target of OLE drag and drop operations""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def DragEnter(self,pDataObj:'PyIDataObject',grfKeyState:'typing.Any',pt:'typing.Tuple[typing.Any, typing.Any]',pdwEffect:'typing.Any') -> 'typing.Any': - """ - Called when an object is initially dragged into a window - -Args: - - pDataObj(PyIDataObject):IDataObject interface that contains the object being dragged - grfKeyState(typing.Any):Combination of win32con.MK_* flags containing keyboard modifier state - pt(typing.Tuple[typing.Any, typing.Any]):(x,y) Screen coordinates of cursor - pdwEffect(typing.Any):shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return a shellcon.DROPEFFECT_* value indicating if the object can be accepted - -Returns: - - typing.Any:shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return a shellcon.DROPEFFECT_* value indicating if the object can - -be accepted - - - """ - pass - - - def DragOver(self,grfKeyState:'typing.Any',pt:'typing.Tuple[typing.Any, typing.Any]',pdwEffect:'typing.Any') -> 'typing.Any': - """ - Called as the dragged object moves over the window - -Args: - - grfKeyState(typing.Any):Combination of win32con.MK_* flags containing keyboard modifier state - pt(typing.Tuple[typing.Any, typing.Any]):(x,y) Screen coordinates of cursor - pdwEffect(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 - -Returns: - - 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 - - - def DragLeave(self,) -> 'None': - """ - Called as the object is dragged back out of the window - -Args: - - - -Returns: - - None - - """ - pass - - - def Drop(self,pDataObj:'PyIDataObject',grfKeyState:'typing.Any',pt:'typing.Tuple[typing.Any, typing.Any]',dwEffect:'typing.Any') -> 'typing.Any': - """ - Called when the object is dropped onto the window - -Args: - - pDataObj(PyIDataObject):IDataObject interface containing the dropped object - grfKeyState(typing.Any):Combination of win32con.MK_* flags containing keyboard modifier state - pt(typing.Tuple[typing.Any, typing.Any]):(x,y) Screen coordinates of cursor - dwEffect(typing.Any):shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return one of the shellcon.DROPEFFECT_* values - -Returns: - - typing.Any:shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return one of the shellcon.DROPEFFECT_* values - - - """ - pass - - -class PyIDropTargetHelper(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def DragEnter(self,hwnd:'int',pDataObj:'PyIDataObject',pt:'typing.Tuple[typing.Any, typing.Any]',dwEffect:'typing.Any') -> 'None': - """ - Description of DragEnter. - -Args: - - hwnd(int):Handle to target window - pDataObj(PyIDataObject):Object that is dragged onto the window - pt(typing.Tuple[typing.Any, typing.Any]):Coordinates where drag operation entered the window - dwEffect(typing.Any):One of shellcon.DROPEFFECT_* values - -Returns: - - None - - """ - pass - - - def DragOver(self,hwnd:'typing.Any',pt:'typing.Tuple[typing.Any, typing.Any]',pdwEffect:'typing.Any') -> 'None': - """ - Description of DragOver. - -Args: - - hwnd(typing.Any): - pt(typing.Tuple[typing.Any, typing.Any]):Description for pt - pdwEffect(typing.Any):Description for pdwEffect - -Returns: - - None - - """ - pass - - - def DragLeave(self,) -> 'None': - """ - Description of DragLeave. - -Args: - - - -Returns: - - None - - """ - pass - - - def Drop(self,pDataObj:'PyIDataObject',pt:'typing.Tuple[typing.Any, typing.Any]',dwEffect:'typing.Any') -> 'None': - """ - Description of Drop. - -Args: - - pDataObj(PyIDataObject):Description for pDataObj - pt(typing.Tuple[typing.Any, typing.Any]):Description for pt - dwEffect(typing.Any):Description for dwEffect - -Returns: - - None - - """ - pass - - -class PyIDsObjectPicker(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,targetComputer:'str',scopeInfos:'PyDSOP_SCOPE_INIT_INFOs',options:'typing.Any'=0,attrNames:'typing.List[str]'=None) -> 'None': - """ - Initializes the IDsObjectPicker interface with information about the scopes, filters, and options used by the object picker dialog box. - -Args: - - targetComputer(str): - scopeInfos(PyDSOP_SCOPE_INIT_INFOs): - options(typing.Any): - attrNames(typing.List[str]): - -Returns: - - None - - """ - pass - - - def InvokeDialog(self,hwnd:'typing.Any') -> 'PyIDataObject': - """ - Displays a modal object picker dialog box and returns the user's selections. - -Args: - - hwnd(typing.Any): - -Returns: - - PyIDataObject - - """ - pass - - -class PyIEmptyVolumeCache(object): - """Used for cleaning up temporary file ("disk cleanup")""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIEmptyVolumeCache2(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIEmptyVolumeCacheCallBack(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ScanProgress(self,dwlSpaceUsed:'typing.Any',dwFlags:'typing.Any',pcwszStatus:'typing.Any') -> 'None': - """ - Description of ScanProgress. - -Args: - - dwlSpaceUsed(typing.Any):Description for dwlSpaceUsed - dwFlags(typing.Any):Description for dwFlags - pcwszStatus(typing.Any):Description for pcwszStatus - -Returns: - - None - - """ - pass - - - def PurgeProgress(self,dwlSpaceFreed:'typing.Any',spaceFreed:'typing.Any',spaceToFree:'typing.Any',flags:'typing.Any',status:'typing.Any') -> 'None': - """ - Description of PurgeProgress. - -Args: - - dwlSpaceFreed(typing.Any):Description for dwlSpaceFreed - spaceFreed(typing.Any): - spaceToFree(typing.Any): - flags(typing.Any): - status(typing.Any): - -Returns: - - None - - """ - pass - - -class PyIEnumCATEGORYINFO(object): - """A Python interface to IEnumCATEGORYINFO""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Tuple[typing.Tuple[PyIID, typing.Any, str], ...]': - """ - Retrieves a specified number of items in the - -enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve.Return ValueThe result is a tuple of (IID object, LCID, string description) tuples, one for each element returned. - -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, - -one for each element returned. - - - """ - pass - - - def Skip(self,num:'typing.Any') -> 'None': - """ - Skips over the next specified elementes. - -Args: - - num(typing.Any):The number of elements being requested. - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumCATEGORYINFO': - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumCATEGORYINFO - - """ - pass - - -class PyIEnumConnectionPoints(object): - """A Python interface to IEnumConnectionPoints""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Tuple[PyIConnectionPoint, ...]': - """ - Retrieves a specified number of items in the - -enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Tuple[PyIConnectionPoint, ...] - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumConnectionPoints': - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumConnectionPoints - - """ - pass - - -class PyIEnumConnections(object): - """A Python interface to IEnumConnections""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumConnections': - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumConnections - - """ - pass - - -class PyIEnumContextProps(object): - """A Python interface to IEnumContextProps""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Tuple[typing.Tuple[PyIID, typing.Any, PyIUnknown], ...]': - """ - Retrieves a specified number of items in - -the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve.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 property value - -Returns: - - typing.Tuple[typing.Tuple[PyIID, typing.Any, PyIUnknown], ...]:Number of items to retrieve. -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 - -property value - - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumContextProps': - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumContextProps - - """ - pass - - -class PyIEnumDebugApplicationNodes(object): - """A Python interface to IEnumDebugApplicationNodes""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumDebugApplicationNodes': - """ - Creates another enumerator that - -contains the same enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumDebugApplicationNodes - - """ - pass - - -class PyIEnumDebugCodeContexts(object): - """A Python interface to IEnumDebugCodeContexts""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumDebugCodeContexts': - """ - Creates another enumerator that contains the - -same enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumDebugCodeContexts - - """ - pass - - -class PyIEnumDebugExpressionContexts(object): - """A Python interface to IEnumDebugExpressionContexts""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration - -sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumDebugExpressionContexts': - """ - Creates another enumerator that - -contains the same enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumDebugExpressionContexts - - """ - pass - - -class PyIEnumDebugPropertyInfo(object): - """A Python interface to IEnumDebugPropertyInfo""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumDebugPropertyInfo': - """ - Creates another enumerator that contains the - -same enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumDebugPropertyInfo - - """ - pass - - - def GetCount(self,) -> 'typing.Any': - """ - Obtains the number of items - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyIEnumDebugStackFrames(object): - """A Python interface to IEnumDebugStackFrames""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumDebugStackFrames': - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumDebugStackFrames - - """ - pass - - -class PyIEnumExplorerCommand(object): - """A Python interface to IEnumExplorerCommand""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumExplorerCommand': - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumExplorerCommand - - """ - pass - - -class PyIEnumFORMATETC(object): - """A Python interface to IEnumFORMATETC""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumFORMATETC': - """ - Creates another enumerator that contains the same enumeration - -state as the current one - -Args: - - - -Returns: - - PyIEnumFORMATETC - - """ - pass - - -class PyIEnumGUID(object): - """A Python interface to IEnumGUID""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Tuple[PyIID, ...]': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve.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 an error condition - an empty tuple is simply returned. - -Returns: - - typing.Tuple[PyIID, ...]:Number of items to retrieve. -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 - -an error condition - an empty tuple is simply returned. - - - """ - pass - - - def Skip(self,num:'typing.Any') -> 'None': - """ - Skips over the next specified elementes. - -Args: - - num(typing.Any):The number of elements being requested. - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumGUID': - """ - Creates another enumerator that contains the same enumeration state as - -the current one - -Args: - - - -Returns: - - PyIEnumGUID - - """ - pass - - -class PyIEnumIDList(object): - """A Python interface to IEnumIDList""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumIDList': - """ - Creates another enumerator that contains the same enumeration state - -as the current one - -Args: - - - -Returns: - - PyIEnumIDList - - """ - pass - - -class PyIEnumMoniker(object): - """A Python interface to IEnumMoniker""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'PyIMoniker': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve.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 an error condition - an empty tuple is simply returned. - -Returns: - - PyIMoniker:Number of items to retrieve. -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 - -an error condition - an empty tuple is simply returned. - - - """ - pass - - - def Skip(self,num:'typing.Any') -> 'None': - """ - Skips over the next specified elementes. - -Args: - - num(typing.Any):The number of elements being requested. - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumMoniker': - """ - Creates another enumerator that contains the same enumeration state - -as the current one - -Args: - - - -Returns: - - PyIEnumMoniker - - """ - pass - - -class PyIEnumObjects(object): - """Iterates through a number of arbitrary interfaces""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,riid:'PyIID',num:'typing.Any'=1) -> 'typing.Tuple[PyIUnknown, ...]': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - riid(PyIID):The interfaces to return - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Tuple[PyIUnknown, ...] - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumObjects': - """ - Creates another enumerator that contains the same enumeration state - -as the current one - -Args: - - - -Returns: - - PyIEnumObjects - - """ - pass - - -class PyIEnumRemoteDebugApplicationThreads(object): - """A Python interface to IEnumRemoteDebugApplicationThreads""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration - -sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumRemoteDebugApplicationThreads': - """ - Creates another - -enumerator that contains the same enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumRemoteDebugApplicationThreads - - """ - pass - - -class PyIEnumRemoteDebugApplications(object): - """A Python interface to IEnumRemoteDebugApplications""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration - -sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumRemoteDebugApplications': - """ - Creates another enumerator that - -contains the same enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumRemoteDebugApplications - - """ - pass - - -class PyIEnumResources(object): - """A Python interface to IEnumResources""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumResources': - """ - Creates another enumerator that contains the same enumeration - -state as the current one - -Args: - - - -Returns: - - PyIEnumResources - - """ - pass - - -class PyIEnumSTATPROPSETSTG(object): - """A Python interface to IEnumSTATPROPSETSTG""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumSTATPROPSETSTG': - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumSTATPROPSETSTG - - """ - pass - - -class PyIEnumSTATPROPSTG(object): - """A Python interface to IEnumSTATPROPSTG""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Any': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumSTATPROPSTG': - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - PyIEnumSTATPROPSTG - - """ - pass - - -class PyIEnumSTATSTG(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Tuple[STATSTG, ...]': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Tuple[STATSTG, ...] - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumSTATSTG': - """ - Creates another enumerator that contains the same enumeration state - -as the current one - -Args: - - - -Returns: - - PyIEnumSTATSTG - - """ - pass - - -class PyIEnumShellItems(object): - """A Python interface to IEnumShellItems""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Tuple[PyIShellItem, ...]': - """ - Retrieves a specified number of items in the enumeration - -sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Tuple[PyIShellItem, ...] - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumShellItems': - """ - Creates another enumerator that contains the same enumeration - -state as the current one - -Args: - - - -Returns: - - PyIEnumShellItems - - """ - pass - - -class PyIEnumString(object): - """An enumerator interface to list strings""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Next(self,num:'typing.Any'=1) -> 'typing.Tuple[str, ...]': - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(typing.Any):Number of items to retrieve. - -Returns: - - typing.Tuple[str, ...] - - """ - pass - - - def Skip(self,) -> 'None': - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - pass - - - def Reset(self,) -> 'None': - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIEnumString': - """ - Creates another enumerator that contains the same enumeration state - -as the current one - -Args: - - - -Returns: - - PyIEnumString - - """ - pass - - -class PyIErrorLog(object): - """A Python wrapper for a COM IErrorLog interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddError(self,propName:'str',excepInfo:'typing.Any'=None) -> 'None': - """ - Adds an error to the error log. - -Args: - - propName(str):The name of the error - excepInfo(typing.Any):A COM exception. Must be a complete COM exception (ie, pythoncom.com_error, or win32com.server.exceptions.COMException()) - -Returns: - - None - - """ - pass - - -class PyIExplorerBrowser(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,hwndParent:'typing.Any',prc:'PyRECT',pfs:'typing.Any') -> 'None': - """ - Description of Initialize. - -Args: - - hwndParent(typing.Any):Description for hwndParent - prc(PyRECT):Description for prc - pfs(typing.Any):Description for pfs - -Returns: - - None - - """ - pass - - - def Destroy(self,) -> 'None': - """ - Description of Destroy. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetRect(self,hdwp:'typing.Any',rcBrowser:'PyRECT') -> 'int': - """ - Description of SetRect. - -Args: - - hdwp(typing.Any):Description for phdwp - rcBrowser(PyRECT):Description for rcBrowser - -Returns: - - int - - """ - pass - - - def SetPropertyBag(self,PropertyBag:'typing.Any') -> 'None': - """ - Description of SetPropertyBag. - -Args: - - PropertyBag(typing.Any):Description for pszPropertyBag - -Returns: - - None - - """ - pass - - - def SetEmptyText(self,EmptyText:'typing.Any') -> 'None': - """ - Description of SetEmptyText. - -Args: - - EmptyText(typing.Any):Description for pszEmptyText - -Returns: - - None - - """ - pass - - - def SetFolderSettings(self,pfs:'typing.Any') -> 'None': - """ - Description of SetFolderSettings. - -Args: - - pfs(typing.Any):Description for pfs - -Returns: - - None - - """ - pass - - - def Advise(self,psbe:'PyIExplorerBrowserEvents') -> 'typing.Any': - """ - Description of Advise. - -Args: - - psbe(PyIExplorerBrowserEvents):Description for psbe - -Returns: - - typing.Any - - """ - pass - - - def Unadvise(self,dwCookie:'typing.Any') -> 'None': - """ - Description of Unadvise. - -Args: - - dwCookie(typing.Any):Description for dwCookie - -Returns: - - None - - """ - pass - - - def SetOptions(self,dwFlag:'typing.Any') -> 'None': - """ - Description of SetOptions. - -Args: - - dwFlag(typing.Any):Description for dwFlag - -Returns: - - None - - """ - pass - - - def GetOptions(self,) -> 'typing.Any': - """ - Description of GetOptions. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def BrowseToIDList(self,pidl:'typing.Any',uFlags:'typing.Any') -> 'None': - """ - Description of BrowseToIDList. - -Args: - - pidl(typing.Any):Description for pidl - uFlags(typing.Any):Description for uFlags - -Returns: - - None - - """ - pass - - - def BrowseToObject(self,punk:'PyIUnknown',uFlags:'typing.Any') -> 'None': - """ - Description of BrowseToObject. - -Args: - - punk(PyIUnknown):Description for punk - uFlags(typing.Any):Description for uFlags - -Returns: - - None - - """ - pass - - - def FillFromObject(self,punk:'PyIUnknown',dwFlags:'typing.Any') -> 'None': - """ - Description of FillFromObject. - -Args: - - punk(PyIUnknown):Description for punk - dwFlags(typing.Any):Description for dwFlags - -Returns: - - None - - """ - pass - - - def RemoveAll(self,) -> 'None': - """ - Description of RemoveAll. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCurrentView(self,riid:'PyIID') -> 'PyIUnknown': - """ - Description of GetCurrentView. - -Args: - - riid(PyIID):Description for riid - -Returns: - - PyIUnknown - - """ - pass - - -class PyIExplorerBrowserEvents(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OnNavigationPending(self,pidlFolder:'typing.Any') -> 'None': - """ - Description of OnNavigationPending. - -Args: - - pidlFolder(typing.Any):Description for pidlFolder - -Returns: - - None - - """ - pass - - - def OnViewCreated(self,psv:'PyIShellView') -> 'None': - """ - Description of OnViewCreated. - -Args: - - psv(PyIShellView):Description for psv - -Returns: - - None - - """ - pass - - - def OnNavigationComplete(self,pidlFolder:'typing.Any') -> 'None': - """ - Description of OnNavigationComplete. - -Args: - - pidlFolder(typing.Any):Description for pidlFolder - -Returns: - - None - - """ - pass - - - def OnNavigationFailed(self,pidlFolder:'typing.Any') -> 'None': - """ - Description of OnNavigationFailed. - -Args: - - pidlFolder(typing.Any):Description for pidlFolder - -Returns: - - None - - """ - pass - - -class PyIExplorerCommand(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetTitle(self,psiItemArray:'PyIShellItemArray') -> 'typing.Any': - """ - Description of GetTitle. - -Args: - - psiItemArray(PyIShellItemArray):Description for psiItemArray - -Returns: - - typing.Any - - """ - pass - - - def GetIcon(self,psiItemArray:'PyIShellItemArray') -> 'typing.Any': - """ - Description of GetIcon. - -Args: - - psiItemArray(PyIShellItemArray):Description for psiItemArray - -Returns: - - typing.Any - - """ - pass - - - def GetToolTip(self,psiItemArray:'PyIShellItemArray') -> 'typing.Any': - """ - Description of GetToolTip. - -Args: - - psiItemArray(PyIShellItemArray):Description for psiItemArray - -Returns: - - typing.Any - - """ - pass - - - def GetCanonicalName(self,) -> 'PyIID': - """ - Description of GetCanonicalName. - -Args: - - - -Returns: - - PyIID - - """ - pass - - - def GetState(self,psiItemArray:'PyIShellItemArray',fOkToBeSlow:'typing.Any') -> 'typing.Any': - """ - Description of GetState. - -Args: - - psiItemArray(PyIShellItemArray):Description for psiItemArray - fOkToBeSlow(typing.Any):Description for fOkToBeSlow - -Returns: - - typing.Any - - """ - pass - - - def Invoke(self,psiItemArray:'PyIShellItemArray',pbc:'PyIBindCtx') -> 'None': - """ - Description of Invoke. - -Args: - - psiItemArray(PyIShellItemArray):Description for psiItemArray - pbc(PyIBindCtx):Description for pbc - -Returns: - - None - - """ - pass - - - def GetFlags(self,) -> 'typing.Any': - """ - Description of GetFlags. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def EnumSubCommands(self,) -> 'PyIEnumExplorerCommand': - """ - Description of EnumSubCommands. - -Args: - - - -Returns: - - PyIEnumExplorerCommand - - """ - pass - - -class PyIExplorerCommandProvider(object): - """This is a gateway only interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIExplorerPaneVisibility(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIExternalConnection(object): - """A Python wrapper for a COM IExternalConnection interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddConnection(self,extconn:'typing.Any',reserved:'typing.Any'=0) -> 'typing.Any': - """ - Increments an object's count of its strong external connections - -(links). - -Args: - - extconn(typing.Any):Type of external connection to the object. The only type of external connection currently supported by this interface is strong, which means that the object must remain alive as long as this external connection exists. Strong external connections are represented by the value EXTCONN_STRONG = 0x0001, which is defined in the enumeration EXTCON - reserved(typing.Any):A reserved parameterReturn ValueThe result is the number of reference counts on the object; used for debugging purposes only. - -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 - -(references). - -Args: - - extconn(typing.Any):Type of external connection - reserved(typing.Any):A reserved parameter. - fLastReleaseCloses(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 or another process.Return ValueThe result is the number of reference counts on the object; used for debugging purposes only. - -Returns: - - 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 - -or another process.Return ValueThe result is the number of reference counts on the object; used for debugging purposes only. - - - """ - pass - - -class PyIExtractIcon(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Extract(self,pszFile:'typing.Any',nIconIndex:'typing.Any',nIconSize:'typing.Any') -> 'None': - """ - Description of Extract. - -Args: - - pszFile(typing.Any):Description for pszFile - nIconIndex(typing.Any):Description for nIconIndex - nIconSize(typing.Any):Description for nIconIndexReturn ValueThe result is (hicon_large, hicon_small), or (None,None) if the underlying function returns S_FALSE, indicating the calling application should extract it. - -Returns: - - None:Description for nIconIndexReturn ValueThe result is (hicon_large, hicon_small), or - -(None,None) if the underlying function returns S_FALSE, indicating - -the calling application should extract it. - - - """ - pass - - - def GetIconLocation(self,uFlags:'typing.Any',cchMax:'typing.Any') -> 'None': - """ - Description of GetIconLocation. - -Args: - - uFlags(typing.Any):Description for uFlags - cchMax(typing.Any):Buffer size to allocate for file name - -Returns: - - None - - """ - pass - - -class PyIExtractIconW(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Extract(self,pszFile:'typing.Any',nIconIndex:'typing.Any',nIconSize:'typing.Any') -> 'None': - """ - Description of Extract. - -Args: - - pszFile(typing.Any):Description for pszFile - nIconIndex(typing.Any):Description for nIconIndex - nIconSize(typing.Any):Description for nIconIndexReturn ValueThe result is (hicon_large, hicon_small), or (None,None) if the underlying function returns S_FALSE, indicating the calling application should extract it. - -Returns: - - None:Description for nIconIndexReturn ValueThe result is (hicon_large, hicon_small), or - -(None,None) if the underlying function returns S_FALSE, indicating - -the calling application should extract it. - - - """ - pass - - - def GetIconLocation(self,uFlags:'typing.Any',cchMax:'typing.Any') -> 'None': - """ - Description of GetIconLocation. - -Args: - - uFlags(typing.Any):Description for uFlags - cchMax(typing.Any):Buffer size to allocate for file name - -Returns: - - None - - """ - pass - - -class PyIExtractImage(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetLocation(self,dwPriority:'typing.Any',size:'typing.Tuple[typing.Any, typing.Any]',dwRecClrDepth:'typing.Any',pdwFlags:'typing.Any') -> 'None': - """ - Description of GetLocation. - -Args: - - dwPriority(typing.Any):Description for dwPriority - size(typing.Tuple[typing.Any, typing.Any]):Description for prgSize - dwRecClrDepth(typing.Any):Description for dwRecClrDepth - pdwFlags(typing.Any):Description for pdwFlags - -Returns: - - None - - """ - pass - - - def Extract(self,) -> 'None': - """ - Description of Extract. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIFileOperation(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Advise(self,Sink:'PyGFileOperationProgressSink') -> 'typing.Any': - """ - Connects an event sink to receive updates - -Args: - - Sink(PyGFileOperationProgressSink):Interface that receives progress updatesReturn ValueReturns a cookie to be passed to PyIFileOperation::Unadvise to disconnect - -Returns: - - typing.Any:Interface that receives progress updatesReturn ValueReturns a cookie to be passed to PyIFileOperation::Unadvise to disconnect - - - """ - pass - - - def Unadvise(self,Cookie:'typing.Any') -> 'None': - """ - Disconnects a progress sink - -Args: - - Cookie(typing.Any):Identifies the sink to disconnect, as returned by PyIFileOperation::Advise - -Returns: - - None - - """ - pass - - - def SetOperationFlags(self,OperationFlags:'typing.Any') -> 'None': - """ - Sets option flags for the operation - -Args: - - OperationFlags(typing.Any):Combination of shellcon.FOF_* and FOFX_* flags - -Returns: - - None - - """ - pass - - - def SetProgressMessage(self,Message:'typing.Any') -> 'None': - """ - Not implemented. - -Args: - - Message(typing.Any):Description for Message - -Returns: - - None - - """ - pass - - - def SetProgressDialog(self,popd:'typing.Any') -> 'None': - """ - Provides an interface used to display a progress dialog - -Args: - - popd(typing.Any):Progress dialog interfaceCommentsIOperationsProgressDialog is not yet supported - -Returns: - - None - - """ - pass - - - def SetProperties(self,proparray:'PyIPropertyChangeArray') -> 'None': - """ - Specifies a set of properties to be changed. - -Args: - - proparray(PyIPropertyChangeArray):Sequence of property changes to be performed (see propsys::PSCreatePropertyChangeArray)CommentsNote that these properties will be set for *any* files created by the operation, not just items passed to ApplyPropertiesToItem(s). New items created as the result of a rename, copy, or move must have a property handler, or the operation fails with the vague com_error: (-2147467259, 'Unspecified error', None, None) (E_FAIL, or 0x80004005 in hex) even though the given file operation was actually performed. - -Returns: - - None - - """ - pass - - - def SetOwnerWindow(self,Owner:'int') -> 'None': - """ - Sets the parent window for any UI displayed. - -Args: - - Owner(int):Handle to parent window - -Returns: - - None - - """ - pass - - - def ApplyPropertiesToItem(self,Item:'PyIShellItem') -> 'None': - """ - Specifies the item that will receive property changes - -Args: - - Item(PyIShellItem):The item to which property changes will be applied - -Returns: - - None - - """ - pass - - - def ApplyPropertiesToItems(self,Items:'PyIUnknown') -> 'None': - """ - Specifies multiple items that will receive property changes - -Args: - - Items(PyIUnknown):PyIShellItemArray, PyIDataObject, or PyIEnumShellItems containing the target items - -Returns: - - None - - """ - pass - - - def RenameItem(self,Item:'PyIShellItem',NewName:'typing.Any',Sink:'PyGFileOperationProgressSink'=None) -> 'None': - """ - Adds a rename to the operation sequence - -Args: - - Item(PyIShellItem):The item to be renamed - NewName(typing.Any):The new name - Sink(PyGFileOperationProgressSink):Progress sink for this operation only. - -Returns: - - None - - """ - pass - - - def RenameItems(self,pUnkItems:'PyIUnknown',NewName:'typing.Any') -> 'None': - """ - Adds multiple renames to the operation sequence - -Args: - - pUnkItems(PyIUnknown):PyIShellItemArray, PyIDataObject, or PyIEnumShellItems containing items to be renamed - NewName(typing.Any):New name for all items. Collisions handled automatically. - -Returns: - - None - - """ - pass - - - def MoveItem(self,Item:'PyIShellItem',DestinationFolder:'PyIShellItem',pszNewName:'typing.Any'=None,Sink:'PyGFileOperationProgressSink'=None) -> 'None': - """ - Adds a move operation to the configuration - -Args: - - Item(PyIShellItem):The item to be moved - DestinationFolder(PyIShellItem):The folder into which it will be moved - pszNewName(typing.Any):Name to be given to moved item, use None to keep original name - Sink(PyGFileOperationProgressSink):Progress sink to receive notification for just this operation - -Returns: - - None - - """ - pass - - - def MoveItems(self,Items:'PyIUnknown',DestinationFolder:'PyIShellItem') -> 'None': - """ - Adds multiple move operations to the configuration - -Args: - - Items(PyIUnknown):PyIShellItemArray, PyIDataObject, or PyIEnumShellItems containing the items to be moved - DestinationFolder(PyIShellItem):Folder into which all items will be moved - -Returns: - - None - - """ - pass - - - def CopyItem(self,Item:'PyIShellItem',DestinationFolder:'PyIShellItem',CopyName:'typing.Any'=None,Sink:'PyGFileOperationProgressSink'=None) -> 'None': - """ - Adds a copy operation to the configuration - -Args: - - Item(PyIShellItem):Item to be copied - DestinationFolder(PyIShellItem):Folder into which it will be copied - CopyName(typing.Any):New name for the copied file, use None to keep original name - Sink(PyGFileOperationProgressSink):Progress sink for just this operation - -Returns: - - None - - """ - pass - - - def CopyItems(self,Items:'PyIUnknown',DestinationFolder:'PyIShellItem') -> 'None': - """ - Adds multiple copy operations to the configuration - -Args: - - Items(PyIUnknown):PyIShellItemArray, PyIDataObject, or PyIEnumShellItems containing items to be copied - DestinationFolder(PyIShellItem):Folder into which they will be copied - -Returns: - - None - - """ - pass - - - def DeleteItem(self,Item:'PyIShellItem',Sink:'PyGFileOperationProgressSink'=None) -> 'None': - """ - Adds a delete operation to the configuration - -Args: - - Item(PyIShellItem):Description for psiItem - Sink(PyGFileOperationProgressSink):Progress sink for just this operation - -Returns: - - None - - """ - pass - - - def DeleteItems(self,Items:'PyIUnknown') -> 'None': - """ - Adds multiple delete operations to the configuration - -Args: - - Items(PyIUnknown):PyIShellItemArray, PyIDataObject, or PyIEnumShellItems containing the items to be deleted - -Returns: - - None - - """ - pass - - - def NewItem(self,DestinationFolder:'PyIShellItem',FileAttributes:'typing.Any',Name:'typing.Any',TemplateName:'typing.Any'=None,Sink:'PyGFileOperationProgressSink'=None) -> 'None': - """ - Creates a new file as part of the operation - -Args: - - DestinationFolder(PyIShellItem):Folder in which to create the file - FileAttributes(typing.Any):Combination of win32con.FILE_ATTRIBUTE_* flags - Name(typing.Any):Name of the new file - TemplateName(typing.Any):Template file used to initialize the new file - Sink(PyGFileOperationProgressSink):Progress sink for just this operation - -Returns: - - None - - """ - pass - - - def PerformOperations(self,) -> 'None': - """ - Effects all configured file system modifications - -Args: - - - -Returns: - - None - - """ - pass - - - def GetAnyOperationsAborted(self,) -> 'typing.Any': - """ - Determines if any operations were terminated - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyIIdentityName(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIInitializeWithFile(object): - """Initializes a property handler that requires a file path instead of a stream""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,FilePath:'typing.Any',Mode:'typing.Any') -> 'None': - """ - Passes a file path to a property handler on startup - -Args: - - FilePath(typing.Any):Full path to the file whose properties are to be accessed - Mode(typing.Any):Indicates if properties can be written, STGM_READ or STGM_READWRITE - -Returns: - - None - - """ - pass - - -class PyIInitializeWithStream(object): - """Interface that initializes a handler capable of reading properties from a stream""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,Stream:'PyIStream',Mode:'typing.Any') -> 'None': - """ - Initializes a property handler with a stream - -Args: - - Stream(PyIStream):Stream containing the contents from which to extract properties - Mode(typing.Any):Indicates if stream is writable, STGM_READ or STGM_READWRITE - -Returns: - - None - - """ - pass - - -class PyIInputObject(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def TranslateAccelerator(self,pmsg:'typing.Any') -> 'None': - """ - Description of TranslateAccelerator. - -Args: - - pmsg(typing.Any):Description for pmsg - -Returns: - - None - - """ - pass - - - def UIActivate(self,uState:'typing.Any') -> 'None': - """ - Description of UIActivate. - -Args: - - uState(typing.Any):Description for uState - -Returns: - - None - - """ - pass - - - def HasFocusIO(self,) -> 'None': - """ - Description of Refresh. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIInternetBindInfo(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetBindInfo(self,) -> 'None': - """ - Description of GetBindInfo. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetBindString(self,) -> 'None': - """ - Description of GetBindString. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIInternetPriority(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetPriority(self,nPriority:'typing.Any') -> 'None': - """ - Description of SetPriority. - -Args: - - nPriority(typing.Any):Description for nPriority - -Returns: - - None - - """ - pass - - - def GetPriority(self,) -> 'None': - """ - Description of GetPriority. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIInternetProtocol(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Read(self,cb:'typing.Any') -> 'None': - """ - Description of Read. - -Args: - - cb(typing.Any):Description for cb - -Returns: - - None - - """ - pass - - - def Seek(self,dlibMove:'LARGE_INTEGER',dwOrigin:'typing.Any') -> 'None': - """ - Description of Seek. - -Args: - - dlibMove(LARGE_INTEGER):Description for dlibMove - dwOrigin(typing.Any):Description for dwOrigin - -Returns: - - None - - """ - pass - - - def LockRequest(self,dwOptions:'typing.Any') -> 'None': - """ - Description of LockRequest. - -Args: - - dwOptions(typing.Any):Description for dwOptions - -Returns: - - None - - """ - pass - - - def UnlockRequest(self,) -> 'None': - """ - Description of UnlockRequest. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIInternetProtocolInfo(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ParseUrl(self,pwzUrl:'typing.Any',ParseAction:'typing.Any',dwParseFlags:'typing.Any',cchResult:'typing.Any',dwReserved:'typing.Any') -> 'None': - """ - Description of ParseUrl. - -Args: - - pwzUrl(typing.Any):Description for pwzUrl - ParseAction(typing.Any):Description for ParseAction - dwParseFlags(typing.Any):Description for dwParseFlags - cchResult(typing.Any):Description for cchResult - dwReserved(typing.Any):Description for dwReserved - -Returns: - - None - - """ - pass - - - def CombineUrl(self,pwzBaseUrl:'typing.Any',pwzRelativeUrl:'typing.Any',dwCombineFlags:'typing.Any',cchResult:'typing.Any',dwReserved:'typing.Any') -> 'None': - """ - Description of CombineUrl. - -Args: - - pwzBaseUrl(typing.Any):Description for pwzBaseUrl - pwzRelativeUrl(typing.Any):Description for pwzRelativeUrl - dwCombineFlags(typing.Any):Description for dwCombineFlags - cchResult(typing.Any):Description for cchResult - dwReserved(typing.Any):Description for dwReserved - -Returns: - - None - - """ - pass - - - def CompareUrl(self,pwzUrl1:'typing.Any',pwzUrl2:'typing.Any',dwCompareFlags:'typing.Any') -> 'None': - """ - Description of CompareUrl. - -Args: - - pwzUrl1(typing.Any):Description for pwzUrl1 - pwzUrl2(typing.Any):Description for pwzUrl2 - dwCompareFlags(typing.Any):Description for dwCompareFlags - -Returns: - - None - - """ - pass - - - def QueryInfo(self,pwzUrl:'typing.Any',OueryOption:'typing.Any',dwQueryFlags:'typing.Any',cbBuffer:'typing.Any',dwReserved:'typing.Any') -> 'typing.Any': - """ - Description of QueryInfo. - -Args: - - pwzUrl(typing.Any):Description for pwzUrl - OueryOption(typing.Any):Description for OueryOption - dwQueryFlags(typing.Any):Description for dwQueryFlags - cbBuffer(typing.Any):Description for cbBuffer - dwReserved(typing.Any):Description for dwReservedCommentsIf the buffer size is the size of an integer, an integer will be returned, otherwise a string. - -Returns: - - typing.Any - - """ - pass - - -class PyIInternetProtocolRoot(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Start(self,szUrl:'typing.Any',pOIProtSink:'PyIInternetProtocolSink',pOIBindInfo:'PyIInternetBindInfo',grfPI:'typing.Any',dwReserved:'typing.Any') -> 'None': - """ - Description of Start. - -Args: - - szUrl(typing.Any):Description for szUrl - pOIProtSink(PyIInternetProtocolSink):Description for pOIProtSink - pOIBindInfo(PyIInternetBindInfo):Description for pOIBindInfo - grfPI(typing.Any):Description for grfPI - dwReserved(typing.Any):Description for dwReserved - -Returns: - - None - - """ - pass - - - def Continue(self,) -> 'None': - """ - Description of Continue. - -Args: - - - -Returns: - - None - - """ - pass - - - def Abort(self,hrReason:'typing.Any',dwOptions:'typing.Any') -> 'None': - """ - Description of Abort. - -Args: - - hrReason(typing.Any):Description for hrReason - dwOptions(typing.Any):Description for dwOptions - -Returns: - - None - - """ - pass - - - def Terminate(self,dwOptions:'typing.Any') -> 'None': - """ - Description of Terminate. - -Args: - - dwOptions(typing.Any):Description for dwOptions - -Returns: - - None - - """ - pass - - - def Suspend(self,) -> 'None': - """ - Description of Suspend. - -Args: - - - -Returns: - - None - - """ - pass - - - def Resume(self,) -> 'None': - """ - Description of Resume. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIInternetProtocolSink(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Switch(self,) -> 'None': - """ - Description of Switch. - -Args: - - - -Returns: - - None - - """ - pass - - - def ReportProgress(self,ulStatusCode:'typing.Any',szStatusText:'typing.Any') -> 'None': - """ - Description of ReportProgress. - -Args: - - ulStatusCode(typing.Any):Description for ulStatusCode - szStatusText(typing.Any):Description for szStatusText - -Returns: - - None - - """ - pass - - - def ReportData(self,grfBSCF:'typing.Any',ulProgress:'typing.Any',ulProgressMax:'typing.Any') -> 'None': - """ - Description of ReportData. - -Args: - - grfBSCF(typing.Any):Description for grfBSCF - ulProgress(typing.Any):Description for ulProgress - ulProgressMax(typing.Any):Description for ulProgressMax - -Returns: - - None - - """ - pass - - - def ReportResult(self,hrResult:'typing.Any',dwError:'typing.Any',szResult:'typing.Any') -> 'None': - """ - Description of ReportResult. - -Args: - - hrResult(typing.Any):Description for hrResult - dwError(typing.Any):Description for dwError - szResult(typing.Any):Description for szResult - -Returns: - - None - - """ - pass - - -class PyIInternetSecurityManager(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetSecuritySite(self,pSite:'typing.Any') -> 'None': - """ - Description of SetSecuritySite. - -Args: - - pSite(typing.Any):Description for pSite - -Returns: - - None - - """ - pass - - - def GetSecuritySite(self,) -> 'None': - """ - Description of GetSecuritySite. - -Args: - - - -Returns: - - None - - """ - pass - - - def MapUrlToZone(self,pwszUrl:'typing.Any',dwFlags:'typing.Any') -> 'None': - """ - Description of MapUrlToZone. - -Args: - - pwszUrl(typing.Any):Description for pwszUrl - dwFlags(typing.Any):Description for dwFlags - -Returns: - - None - - """ - pass - - - def GetSecurityId(self,pwszUrl:'typing.Any',pcbSecurityId:'typing.Any') -> 'None': - """ - Description of GetSecurityId. - -Args: - - pwszUrl(typing.Any):Description for pwszUrl - pcbSecurityId(typing.Any):Description for pcbSecurityId - -Returns: - - None - - """ - pass - - - def ProcessUrlAction(self,pwszUrl:'typing.Any',dwAction:'typing.Any',context:'typing.Any',dwFlags:'typing.Any') -> 'None': - """ - Description of ProcessUrlAction. - -Args: - - pwszUrl(typing.Any):Description for pwszUrl - dwAction(typing.Any):Description for dwAction - context(typing.Any): - dwFlags(typing.Any):Description for dwFlags - -Returns: - - None - - """ - pass - - - def SetZoneMapping(self,dwZone:'typing.Any',lpszPattern:'typing.Any',dwFlags:'typing.Any') -> 'None': - """ - Description of SetZoneMapping. - -Args: - - dwZone(typing.Any):Description for dwZone - lpszPattern(typing.Any):Description for lpszPattern - dwFlags(typing.Any):Description for dwFlags - -Returns: - - None - - """ - pass - - - def GetZoneMappings(self,dwZone:'typing.Any',dwFlags:'typing.Any') -> 'None': - """ - Description of GetZoneMappings. - -Args: - - dwZone(typing.Any):Description for dwZone - dwFlags(typing.Any):Description for dwFlags - -Returns: - - None - - """ - pass - - -class PyIKnownFolder(object): - """Interface representing a known folder that serves - -as a replacement for the numeric CSIDL definitions and API functions. - -Requires Vista or later.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetId(self,) -> 'PyIID': - """ - Returns the id of the folder - -Args: - - - -Returns: - - PyIID - - """ - pass - - - def GetCategory(self,) -> 'typing.Any': - """ - Returns the category for a folder (shellcon.KF_CATEGORY_*) - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetShellItem(self,riid:'PyIID',Flags:'typing.Any'=0) -> 'PyIShellItem': - """ - Returns a shell interface for the folder - -Args: - - riid(PyIID):The interface to return (IShellItem or IShellItem2) - Flags(typing.Any):Combination of shellcon.KF_FLAG_* values - -Returns: - - PyIShellItem - - """ - pass - - - def GetPath(self,Flags:'typing.Any'=0) -> 'typing.Any': - """ - Returns the path to the folder - -Args: - - Flags(typing.Any):Combination of shellcon.KF_FLAG_* flags controlling how the path is returned - -Returns: - - typing.Any - - """ - pass - - - def SetPath(self,Flags:'typing.Any',Path:'typing.Any') -> 'None': - """ - Changes the location of the folder - -Args: - - Flags(typing.Any):KF_FLAG_DONT_UNEXPAND, or 0 - Path(typing.Any):New path for known folder - -Returns: - - None - - """ - pass - - - def GetIDList(self,Flags:'typing.Any') -> 'PyIDL': - """ - Returns the folder's location as an item id list. - -Args: - - Flags(typing.Any):Combination of shellcon.KF_FLAG_* values that affect how the operation is performed - -Returns: - - PyIDL - - """ - pass - - - def GetFolderType(self,) -> 'PyIID': - """ - Returns the type of the folder - -Args: - - - -Returns: - - PyIID:PyIKnownFolder.GetFolderType -PyIID = GetFolderType()Returns the type of the folder -Return ValueReturns a folder type guid (shell.FOLDERTYPEID_*) - - - """ - pass - - - def GetRedirectionCapabilities(self,) -> 'typing.Any': - """ - Returns flags indicating how the folder can be redirected - -Args: - - - -Returns: - - typing.Any:PyIKnownFolder.GetRedirectionCapabilities - -int = GetRedirectionCapabilities()Returns flags indicating how the folder can be redirected -Return ValueCombination of shellcon.KF_REDIRECTION_CAPABILITIES_* flags - - - """ - pass - - - def GetFolderDefinition(self,) -> 'typing.Any': - """ - Retrieves detailed information about a known folder - -Args: - - - -Returns: - - typing.Any:PyIKnownFolder.GetFolderDefinition - -dict = GetFolderDefinition()Retrieves detailed information about a known folder -Return ValueReturns a dict containing info from a KNOWNFOLDER_DEFINITION struct - - - """ - pass - - -class PyIKnownFolderManager(object): - """Interface used to manage known folder definitions.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def FolderIdFromCsidl(self,Csidl:'typing.Any') -> 'PyIID': - """ - Returns the folder id that corresponds to a CSIDL - -Args: - - Csidl(typing.Any):The legacy CSIDL identifying a folder - -Returns: - - PyIID - - """ - pass - - - def FolderIdToCsidl(self,_id:'PyIID') -> 'typing.Any': - """ - Returns the CSIDL equivalent of a known folder - -Args: - - _id(PyIID):A known folder id (shell.FOLDERID_*) - -Returns: - - typing.Any - - """ - pass - - - def GetFolderIds(self,) -> 'typing.Tuple[PyIID, ...]': - """ - Retrieves all known folder ids. - -Args: - - - -Returns: - - typing.Tuple[PyIID, ...] - - """ - pass - - - def GetFolder(self,_id:'PyIID') -> 'PyIKnownFolder': - """ - Returns a folder by its id. - -Args: - - _id(PyIID):A known folder id (shell.FOLDERID_*) - -Returns: - - PyIKnownFolder - - """ - pass - - - def GetFolderByName(self,Name:'typing.Any') -> 'PyIKnownFolder': - """ - Returns a folder by canonical name - -Args: - - Name(typing.Any):The nonlocalized name of a known folder - -Returns: - - PyIKnownFolder - - """ - pass - - - def RegisterFolder(self,_id:'PyIID',Definition:'typing.Any') -> 'None': - """ - Defines a new known folder - -Args: - - _id(PyIID):GUID used to identify the new known folder - Definition(typing.Any):Dictionary containing info to be placed in a KNOWNFOLDER_DEFINITION structCommentsPyIKnownFolder::GetFolderDefinition can be used to get a template dictionary - -Returns: - - None - - """ - pass - - - def UnregisterFolder(self,_id:'PyIID') -> 'None': - """ - Removes the definition of a known folder - -Args: - - _id(PyIID):GUID of a known folder to be unregistered - -Returns: - - None - - """ - pass - - - def FindFolderFromPath(self,Path:'typing.Any',Mode:'typing.Any') -> 'PyIKnownFolder': - """ - Retrieves a known folder by path - -Args: - - Path(typing.Any):Path of a folder - Mode(typing.Any):FFFP_EXACTMATCH or FFFP_NEARESTPARENTMATCH - -Returns: - - PyIKnownFolder - - """ - pass - - - def FindFolderFromIDList(self,pidl:'PyIDL') -> 'PyIKnownFolder': - """ - Retrieves a known folder using its item id - -list. - -Args: - - pidl(PyIDL):Item id list of the folder - -Returns: - - PyIKnownFolder - - """ - pass - - - def Redirect(self,_id:'PyIID',hwnd:'int',flags:'typing.Any',TargetPath:'typing.Any',Exclusion:'typing.Tuple[PyIID, ...]') -> 'None': - """ - Redirects a known folder to an alternate location - -Args: - - _id(PyIID):Id of the known folder to be redirected - hwnd(int):Handle of window to be used for user interaction - flags(typing.Any):Combination of KF_REDIRECT_* flags - TargetPath(typing.Any):Path to which the known folder will be redirected - Exclusion(typing.Tuple[PyIID, ...]):Sequence of known folder ids of subfolders to be excluded from redirection - -Returns: - - None - - """ - pass - - -class PyILockBytes(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ReadAt(self,ulOffset:'ULARGE_INTEGER',cb:'typing.Any') -> 'str': - """ - Reads a specified number of bytes starting at a specified offset from the - -beginning of the byte array object. - -Args: - - ulOffset(ULARGE_INTEGER):Offset to start reading - cb(typing.Any):Number of bytes to readCommentsThe result is a binary buffer returned in a string. - -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 - -beginning of the byte array. - -Args: - - ulOffset(ULARGE_INTEGER):Offset to write at. - data(str):Data to writeReturn ValueThe result is the number of bytes actually written. - -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 - -to the backing storage. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetSize(self,cb:'ULARGE_INTEGER') -> 'None': - """ - Changes the size of the byte array. - -Args: - - cb(ULARGE_INTEGER):The new size. - -Returns: - - None - - """ - pass - - - def LockRegion(self,libOffset:'ULARGE_INTEGER',cb:'ULARGE_INTEGER',dwLockType:'typing.Any') -> 'None': - """ - Restricts access to a specified range of bytes in the byte array. - -Args: - - libOffset(ULARGE_INTEGER):The beginning of the region to lock. - cb(ULARGE_INTEGER):The number of bytes to lock. - dwLockType(typing.Any):Specifies the restrictions being requested on accessing the range. - -Returns: - - None - - """ - pass - - - def UnlockRegion(self,libOffset:'ULARGE_INTEGER',cb:'ULARGE_INTEGER',dwLockType:'typing.Any') -> 'None': - """ - None - -Args: - - libOffset(ULARGE_INTEGER):The beginning of the region to unlock. - cb(ULARGE_INTEGER):The number of bytes to lock. - dwLockType(typing.Any):Specifies the restrictions being requested on accessing the range. - -Returns: - - None - - """ - pass - - - def Stat(self,grfStatFlag:'typing.Any') -> 'STATSTG': - """ - None - -Args: - - grfStatFlag(typing.Any):Specifies that this method does not return some of the fields in the STATSTG structure, thus saving a memory allocation operation. Values are taken from the STATFLAG enumerationg - -Returns: - - STATSTG - - """ - pass - - -class PyIMAPIContainer(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OpenEntry(self,entryId:'str',iid:'PyIID',flags:'typing.Any') -> 'typing.Any': - """ - Opens an object and returns an interface object for further access. - -Args: - - entryId(str):The EntryID to open. - iid(PyIID):The IID of the returned interface, or None for the default interface. - flags(typing.Any):Flags for the call. May include MAPI_BEST_ACCESS, MAPI_DEFERRED_ERRORS, MAPI_MODIFY and possibly others (see the MAPI documentation) - -Returns: - - typing.Any - - """ - pass - - - def GetContentsTable(self,flags:'typing.Any') -> 'PyIMAPITable': - """ - Returns an object representing the container's contents table. - -Args: - - flags(typing.Any):The flags to use. - -Returns: - - PyIMAPITable - - """ - pass - - - def GetHierarchyTable(self,flags:'typing.Any') -> 'PyIMAPITable': - """ - Returns an object representing the container's hierarchy table. - -Args: - - flags(typing.Any):The flags to use. - -Returns: - - PyIMAPITable - - """ - pass - - -class PyIMAPIFolder(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetLastError(self,hr:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - Returns the last error code for the object. - -Args: - - hr(typing.Any):Contains the error code generated in the previous method call. - flags(typing.Any):Indicates for format for the output. - -Returns: - - typing.Any - - """ - pass - - - def CreateFolder(self,folderType:'typing.Any',folderName:'str',folderComment:'str'=None,iid:'PyIID'=None,flags:'typing.Any'=0) -> 'PyIMAPIFolder': - """ - Creates a folder object. - -Args: - - folderType(typing.Any):The type of folder to create - folderName(str):The name of the folder. - folderComment(str):A comment for the folder or None - iid(PyIID):The IID of the object to return. Should usually be None. - flags(typing.Any): - -Returns: - - PyIMAPIFolder - - """ - pass - - - def CreateMessage(self,iid:'PyIID',flags:'typing.Any') -> 'PyIMessage': - """ - Creates a message in a folder - -Args: - - iid(PyIID):The IID of the object to return. Should usually be None. - flags(typing.Any): - -Returns: - - PyIMessage - - """ - pass - - - def CopyMessages(self,msgs:'PySBinaryArray',iid:'PyIID',folder:'PyIMAPIFolder',ulUIParam:'typing.Any',progress:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - Copies the specified messages - -Args: - - msgs(PySBinaryArray): - iid(PyIID):IID representing the interface to be used to access the destination folder. Should usually be None. - folder(PyIMAPIFolder):The destination folder - ulUIParam(typing.Any):Handle of the parent window for any dialog boxes or windows this method displays. - progress(typing.Any):A progress object, or None - flags(typing.Any):A bitmask ofMaskDescriptionMAPI_DECLINE_OKInforms the message store provider to immediately return MAPI_E_DECLINE_COPY if it implements CopyMessage by calling the support object's IMAPISupport::DoCopyTo or IMAPISupport::DoCopyProps method.MESSAGE_DIALOGDisplays a progress indicator as the operation proceeds.MESSAGE_MOVEThe message or messages are to be moved rather than copied. If MESSAGE_MOVE is not set, the messages are copied. - -Returns: - - typing.Any - - """ - pass - - - def DeleteFolder(self,entryId:'str',uiParam:'typing.Any',progress:'typing.Any') -> 'None': - """ - Deletes a subfolder. - -Args: - - entryId(str):The EntryID of the subfolder to delete. - uiParam(typing.Any):Handle of the parent window of the progress indicator. - progress(typing.Any):A progress object, or None - -Returns: - - None - - """ - pass - - - def DeleteMessages(self,msgs:'PySBinaryArray',uiParam:'typing.Any',progress:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - Deletes the specified messages. - -Args: - - msgs(PySBinaryArray): - uiParam(typing.Any):A HWND for the progress - progress(typing.Any):A progress object, or None - flags(typing.Any): - -Returns: - - typing.Any - - """ - pass - - - def EmptyFolder(self,uiParam:'typing.Any',progress:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - deletes all messages and subfolders from a folder without deleting the folder itself. - -Args: - - uiParam(typing.Any):A HWND for the progress - progress(typing.Any):A progress object, or None - flags(typing.Any): - -Returns: - - typing.Any - - """ - pass - - - def SetReadFlags(self,msgs:'PySBinaryArray',uiParam:'typing.Any',progress:'typing.Any',flag:'typing.Any') -> 'None': - """ - Sets or clears the MSGFLAG_READ flag in the PR_MESSAGE_FLAGS (PidTagMessageFlags) property of one or more of the folder's messages, and manages the sending of read reports. - -Args: - - msgs(PySBinaryArray): - uiParam(typing.Any):A HWND for the progress - progress(typing.Any):A progress object, or None - flag(typing.Any):Bitmask of flags that controls the setting of a message's read flag - that is, the message's MSGFLAG_READ flag in its PR_MESSAGE_FLAGS property and the processing of read reports. - -Returns: - - None - - """ - pass - - -class PyIMAPIProp(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetProps(self,propList:'PySPropTagArray',flags:'typing.Any'=0) -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': - """ - Returns a list of property values. - -Args: - - propList(PySPropTagArray):The list of properties - flags(typing.Any): - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any] - - """ - pass - - - def DeleteProps(self,propList:'PySPropTagArray',wantProblems:'typing.Any'=False) -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': - """ - Deletes a set of properties. - -Args: - - propList(PySPropTagArray):The list of properties - wantProblems(typing.Any):Return detailed error information - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any] - - """ - pass - - - def SetProps(self,propList:'typing.Tuple[typing.Any, typing.Any]',wantProblems:'typing.Any'=False) -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': - """ - Sets a set of properties. - -Args: - - propList(typing.Tuple[typing.Any, typing.Any]):The list of properties - wantProblems(typing.Any):Return detailed error information - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any] - - """ - pass - - - def CopyTo(self,IIDExcludeList:'typing.Tuple[typing.Any, typing.Any]',propTags:'PySPropTagArray',uiParam:'typing.Any',progress:'typing.Any',resultIID:'PyIID',dest:'PyIMAPIProp',flags:'typing.Any',wantProblems:'typing.Any'=False) -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': - """ - Copies an object to another - -Args: - - IIDExcludeList(typing.Tuple[typing.Any, typing.Any]):A sequence of IIDs to exclude. - propTags(PySPropTagArray):The property tags to exclude. - uiParam(typing.Any):Handle to the parent window of the progress object - progress(typing.Any):Reserved - must pass None - resultIID(PyIID):IID of the destination object - dest(PyIMAPIProp):The destination object - flags(typing.Any):flags - wantProblems(typing.Any):Return detailed error information - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any] - - """ - pass - - - def CopyProps(self,propTags:'PySPropTagArray',uiParam:'typing.Any',progress:'typing.Any',resultIID:'PyIID',dest:'PyIMAPIProp',flags:'typing.Any',wantProblems:'typing.Any'=False) -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': - """ - Copies a set of properties to another object - -Args: - - propTags(PySPropTagArray):The property tags to copy - uiParam(typing.Any):Handle to the parent window of the progress object - progress(typing.Any):Reserved - must pass None - resultIID(PyIID):IID of the destination object - dest(PyIMAPIProp):The destination object - flags(typing.Any):flags - wantProblems(typing.Any):Return detailed error information - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any] - - """ - pass - - - def OpenProperty(self,propTag:'typing.Any',iid:'PyIID',interfaceOptions:'typing.Any',flags:'typing.Any') -> 'PyIUnknown': - """ - Returns an interface object to be used to access a property. - -Args: - - propTag(typing.Any):The property tag to open - iid(PyIID):The IID of the resulting interface. - interfaceOptions(typing.Any):Data that relates to the interface identified by the lpiid parameter. - flags(typing.Any):flags - -Returns: - - PyIUnknown - - """ - pass - - - def GetIDsFromNames(self,nameIds:'PyMAPINAMEIDArray',flags:'typing.Any'=0) -> 'PySPropTagArray': - """ - Determines property IDs - -Args: - - nameIds(PyMAPINAMEIDArray):Sequence of name ids - flags(typing.Any): - -Returns: - - PySPropTagArray - - """ - pass - - - def GetNamesFromIDs(self,propTags:'PySPropTagArray',propSetGuid:'PyIID'=None,flags:'typing.Any'=0) -> 'typing.Tuple[typing.Any, PySPropTagArray, PyMAPINAMEIDArray]': - """ - Determines property names - -Args: - - propTags(PySPropTagArray):Sequence of property tags, or None - propSetGuid(PyIID):a globally unique identifier, identifying a property set, or None - flags(typing.Any): - -Returns: - - typing.Tuple[typing.Any, PySPropTagArray, PyMAPINAMEIDArray] - - """ - pass - - - def GetLastError(self,hr:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - Returns the last error code for the object. - -Args: - - hr(typing.Any):Contains the error code generated in the previous method call. - flags(typing.Any):Indicates for format for the output. - -Returns: - - typing.Any - - """ - pass - - - def SaveChanges(self,flags:'typing.Any') -> 'None': - """ - Saves pending changes to the object - -Args: - - flags(typing.Any):flags - -Returns: - - None - - """ - pass - - - def GetPropList(self,flags:'typing.Any') -> 'PySPropTagArray': - """ - Gets a list of properties - -Args: - - flags(typing.Any):flags - -Returns: - - PySPropTagArray - - """ - pass - - -class PyIMAPISession(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OpenEntry(self,entryId:'str',iid:'PyIID',flags:'typing.Any') -> 'typing.Any': - """ - Opens an object and returns an interface object for further access. - -Args: - - entryId(str):The EntryID to open. - iid(PyIID):The IID of the returned interface, or None for the default interface. - flags(typing.Any):Flags for the call. May include MAPI_BEST_ACCESS, MAPI_DEFERRED_ERRORS, MAPI_MODIFY and possibly others (see the MAPI documentation) - -Returns: - - typing.Any - - """ - pass - - - def OpenMsgStore(self,uiParam:'typing.Any',entryId:'str',iid:'PyIID',flags:'typing.Any') -> 'PyIUnknown': - """ - Opens a message store. - -Args: - - uiParam(typing.Any):Handle to the parent window for dialogs. - entryId(str):The entry ID of the message store to open. - iid(PyIID):The IID of the interface returned, or None - flags(typing.Any):Options for the call.CommentsThe result is the interface specified by the IID, or IID_IMsgStore if None is used. - -Returns: - - PyIUnknown - - """ - pass - - - def QueryIdentity(self,) -> 'str': - """ - Returns the entry identifier of the object that provides the primary identity for the session. - -Args: - - - -Returns: - - str - - """ - pass - - - def Advise(self,entryId:'str',mask:'typing.Any',sink:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - entryId(str):The entryID of the object - mask(typing.Any): - sink(typing.Any):Return ValueThe result is an integer which should be passed to PyIMAPISession::Unadvise - -Returns: - - typing.Any:Return ValueThe result is an integer which should be passed to - -PyIMAPISession::Unadvise - - - """ - pass - - - def Unadvise(self,connection:'typing.Any') -> 'None': - """ - None - -Args: - - connection(typing.Any):Value returned from PyIMAPISession::Advise - -Returns: - - None - - """ - pass - - - def CompareEntryIDs(self,entryId:'str',entryId1:'str',flags:'typing.Any'=0) -> 'typing.Any': - """ - Compares two entry identifiers belonging to a particular address book provider to determine if they refer to the same address book object - -Args: - - entryId(str):The first entry ID to be compared - entryId1(str):The second entry ID to be compared - flags(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. - -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 - - - def GetLastError(self,hr:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - Returns the last error code for the object. - -Args: - - hr(typing.Any):Contains the error code generated in the previous method call. - flags(typing.Any):Indicates for format for the output. - -Returns: - - typing.Any - - """ - pass - - - def GetMsgStoresTable(self,flags:'typing.Any') -> 'PyIMAPITable': - """ - Provides access to the message store table - a table with information about all of the message stores in the session profile. - -Args: - - flags(typing.Any):Flags that control the opening. - -Returns: - - PyIMAPITable - - """ - pass - - - def GetStatusTable(self,flags:'typing.Any') -> 'PyIMAPITable': - """ - Provides access to the status table - a table with information about all of the MAPI resources in the session. - -Args: - - flags(typing.Any):Flags that control the opening. - -Returns: - - PyIMAPITable - - """ - pass - - - def Logoff(self,uiParm:'typing.Any',flags:'typing.Any',reserved:'typing.Any') -> 'None': - """ - Ends a MAPI session. - -Args: - - uiParm(typing.Any):hwnd of a dialog is to be displayed. - flags(typing.Any):Bitmask of flags that control the logoff operation. - reserved(typing.Any):Reserved; must be zero. - -Returns: - - None - - """ - pass - - - def OpenAddressBook(self,uiParm:'typing.Any',iid:'PyIID',flags:'typing.Any') -> 'PyIAddrBook': - """ - Opens the integrated address book. - -Args: - - uiParm(typing.Any):hwnd of a dialog is to be displayed. - iid(PyIID):The IID of the interface, or None. - flags(typing.Any):Flags that control the opening - AB_NO_DIALOG. - -Returns: - - PyIAddrBook - - """ - pass - - - def OpenProfileSection(self,iidSection:'PyIID',iid:'PyIID',flags:'typing.Any') -> 'typing.Any': - """ - Opens a section of the current profile and returns an object for futher access - -Args: - - iidSection(PyIID):The MAPIIID of the profile section - iid(PyIID):The IID of the interface, or None. - flags(typing.Any):Flags that control the opening. - -Returns: - - typing.Any - - """ - pass - - - def AdminServices(self,flags:'typing.Any'=0) -> 'PyIMsgServiceAdmin': - """ - Provides access to a message service administration object for making changes to the message services. - -Args: - - flags(typing.Any):reserved; must be zero. - -Returns: - - PyIMsgServiceAdmin - - """ - pass - - -class PyIMAPIStatus(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ChangePassword(self,oldPassword:'typing.Any',newPassword:'typing.Any',ulFlags:'typing.Any') -> 'None': - """ - None - -Args: - - oldPassword(typing.Any): - newPassword(typing.Any): - ulFlags(typing.Any): - -Returns: - - None - - """ - pass - - - def SettingsDialog(self,ulUIParam:'typing.Any',ulFlags:'typing.Any') -> 'None': - """ - None - -Args: - - ulUIParam(typing.Any): - ulFlags(typing.Any): - -Returns: - - None - - """ - pass - - - def ValidateState(self,ulUIParam:'typing.Any',ulFlags:'typing.Any') -> 'None': - """ - None - -Args: - - ulUIParam(typing.Any): - ulFlags(typing.Any): - -Returns: - - None - - """ - pass - - - def FlushQueues(self,ulUIParam:'typing.Any',transport:'str',ulFlags:'typing.Any') -> 'None': - """ - None - -Args: - - ulUIParam(typing.Any): - transport(str):Blob of data - ulFlags(typing.Any): - -Returns: - - None - - """ - pass - - -class PyIMAPITable(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetLastError(self,hr:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - Returns the last error code for the object. - -Args: - - hr(typing.Any):Contains the error code generated in the previous method call. - flags(typing.Any):Indicates for format for the output. - -Returns: - - typing.Any - - """ - pass - - - def Advise(self,eventMask:'typing.Any',adviseSink:'typing.Any') -> 'typing.Any': - """ - Registers to receive notification of specified events affecting the table. - -Args: - - eventMask(typing.Any): - adviseSink(typing.Any): - -Returns: - - typing.Any - - """ - pass - - - def SeekRow(self,bookmark:'typing.Any',rowCount:'typing.Any') -> 'typing.Any': - """ - Moves the cursor to a specific position in the table. - -Args: - - bookmark(typing.Any):The bookmark. - rowCount(typing.Any):Return ValueThe result is the number of rows processed. - -Returns: - - typing.Any:Return ValueThe result is the number of rows processed. - - - """ - pass - - - def SeekRowApprox(self,numerator:'typing.Any',denominator:'typing.Any') -> 'None': - """ - Moves the cursor to an approximate fractional position in the table. - -Args: - - numerator(typing.Any):The numerator of the fraction representing the table position - denominator(typing.Any):The denominator of the fraction representing the table position. This must not be zero. - -Returns: - - None - - """ - pass - - - def GetRowCount(self,flags:'typing.Any') -> 'typing.Any': - """ - Returns the total number of rows in the table. - -Args: - - flags(typing.Any):Reserved - must be zero - -Returns: - - typing.Any - - """ - pass - - - def QueryRows(self,rowCount:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - Returns one or more rows from a table, beginning at the current cursor position. - -Args: - - rowCount(typing.Any):Number of rows to retrieve - flags(typing.Any):Flags. - -Returns: - - typing.Any - - """ - pass - - - def SetColumns(self,propTags:'typing.Any',flags:'typing.Any') -> 'None': - """ - Defines the particular properties and order of properties to appear as columns in the table. - -Args: - - propTags(typing.Any):Sequence of property tags identifying properties to be included as columns in the table. - flags(typing.Any): - -Returns: - - None - - """ - pass - - - def GetStatus(self,) -> 'None': - """ - Returns the table's status and type. - -Args: - - - -Returns: - - None:PyIMAPITable.GetStatus -GetStatus()Returns the table's status and type. -Return ValueResult is a tuple of (tableStatus, tableType) - - - """ - pass - - - def QueryPosition(self,) -> 'None': - """ - Retrieves the current table row position of the cursor, based on a fractional value. - -Args: - - - -Returns: - - None:PyIMAPITable.QueryPosition -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 - - - def QueryColumns(self,flags:'typing.Any') -> 'typing.Any': - """ - Returns a list of columns for the table. - -Args: - - flags(typing.Any): - -Returns: - - typing.Any - - """ - pass - - - def Abort(self,) -> 'None': - """ - Stops any asynchronous operations currently in progress for the table. - -Args: - - - -Returns: - - None - - """ - pass - - - def FreeBookmark(self,bookmark:'typing.Any') -> 'None': - """ - Releases the memory associated with a bookmark. - -Args: - - bookmark(typing.Any): - -Returns: - - None - - """ - pass - - - def CreateBookmark(self,) -> 'typing.Any': - """ - Marks the table's current position. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def Restrict(self,restriction:'PySRestriction',flags:'typing.Any') -> 'None': - """ - Applies a filter to a table, reducing the row set to only those rows matching the specified criteria. - -Args: - - restriction(PySRestriction): - flags(typing.Any): - -Returns: - - None - - """ - pass - - - def FindRow(self,restriction:'PySRestriction',bookmarkOrigin:'typing.Any',flags:'typing.Any') -> 'None': - """ - Finds the next row in a table that matches specific search criteria. - -Args: - - restriction(PySRestriction): - bookmarkOrigin(typing.Any): - flags(typing.Any): - -Returns: - - None - - """ - pass - - - def SortTable(self,sortOrderSet:'PySSortOrderSet',flags:'typing.Any') -> 'None': - """ - Orders the rows of the table based on sort criteria. - -Args: - - sortOrderSet(PySSortOrderSet): - flags(typing.Any): - -Returns: - - None - - """ - pass - - - def Unadvise(self,handle:'typing.Any') -> 'None': - """ - Cancels the sending of notifications previously set up with a call to the IMAPITable::Advise method. - -Args: - - handle(typing.Any):Handle returned from PyIMAPITable::Advise - -Returns: - - None - - """ - pass - - -class PyIMachineDebugManager(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddApplication(self,pda:'PyIRemoteDebugApplication') -> 'None': - """ - Description of AddApplication. - -Args: - - pda(PyIRemoteDebugApplication):Description for pda - -Returns: - - None - - """ - pass - - - def RemoveApplication(self,dwAppCookie:'typing.Any') -> 'None': - """ - Description of RemoveApplication. - -Args: - - dwAppCookie(typing.Any):Description for dwAppCookie - -Returns: - - None - - """ - pass - - - def EnumApplications(self,) -> 'None': - """ - Description of EnumApplications. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIMachineDebugManagerEvents(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def onAddApplication(self,pda:'PyIRemoteDebugApplication',dwAppCookie:'typing.Any') -> 'None': - """ - Description of onAddApplication. - -Args: - - pda(PyIRemoteDebugApplication):Description for pda - dwAppCookie(typing.Any):Description for dwAppCookie - -Returns: - - None - - """ - pass - - - def onRemoveApplication(self,pda:'PyIRemoteDebugApplication',dwAppCookie:'typing.Any') -> 'None': - """ - Description of onRemoveApplication. - -Args: - - pda(PyIRemoteDebugApplication):Description for pda - dwAppCookie(typing.Any):Description for dwAppCookie - -Returns: - - None - - """ - pass - - -class PyIMessage(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetReadFlag(self,flag:'typing.Any') -> 'None': - """ - Sets the read flags for a message - -Args: - - flag(typing.Any):Bitmask of flags that controls the setting of a message's read flag - that is, the message's MSGFLAG_READ flag in its PR_MESSAGE_FLAGS property and the processing of read reports. - -Returns: - - None - - """ - pass - - - def GetAttachmentTable(self,flags:'typing.Any') -> 'PyIMAPITable': - """ - Returns the message's attachment table. - -Args: - - flags(typing.Any):Bitmask of flags that relate to the creation of the table. - -Returns: - - PyIMAPITable - - """ - pass - - - def OpenAttach(self,attachmentNum:'typing.Any',interface:'PyIID',flags:'typing.Any') -> 'PyIAttach': - """ - Opens an attachment - -Args: - - attachmentNum(typing.Any): - interface(PyIID):The interface to use, or None - flags(typing.Any):Bitmask of flags that controls how the attachment is opened. - -Returns: - - PyIAttach - - """ - pass - - - def CreateAttach(self,interface:'PyIID',flags:'typing.Any') -> 'typing.Tuple[typing.Any, PyIAttach]': - """ - Creates an attachment - -Args: - - interface(PyIID):The interface to use, or None - flags(typing.Any):Bitmask of flags that controls how the attachment is created.Return ValueThe result is a tuple of (attachmentNum, attachmentObject) - -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 - - - def DeleteAttach(self,attachmentNum:'typing.Any',ulUIParam:'typing.Any',interface:'typing.Any',flags:'typing.Any') -> 'None': - """ - Deletes an attachment - -Args: - - attachmentNum(typing.Any): - ulUIParam(typing.Any): - interface(typing.Any):The interface to use, or None - flags(typing.Any):Bitmask of flags that controls the display of a user interface. - -Returns: - - None - - """ - pass - - - def ModifyRecipients(self,flags:'typing.Any',mods:'typing.Any') -> 'None': - """ - adds, deletes, or modifies message recipients. - -Args: - - flags(typing.Any):Bitmask of flags that controls the recipient changes. If zero is passed for the ulFlags parameter, ModifyRecipients replaces all existing recipients with the recipient list in the mods parameter. - mods(typing.Any):The list of recipients. - -Returns: - - None - - """ - pass - - - def GetRecipientTable(self,flags:'typing.Any') -> 'PyIMAPITable': - """ - Returns the message's recipient table. - -Args: - - flags(typing.Any):Bitmask of flags that relate to the creation of the table. - -Returns: - - PyIMAPITable - - """ - pass - - - def SubmitMessage(self,flags:'typing.Any') -> 'None': - """ - Saves all of the message's properties and marks the message as ready to be sent. - -Args: - - flags(typing.Any):Flags which specify how the message is submitted. - -Returns: - - None - - """ - pass - - -class PyIMoniker(object): - """A Python interface to IMoniker""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def BindToObject(self,bindCtx:'PyIBindCtx',moniker:'PyIMoniker',iidResult:'typing.Any') -> 'PyIUnknown': - """ - Uses the moniker to bind to the object it identifies. - -Args: - - bindCtx(PyIBindCtx):bind context object to be used. - moniker(PyIMoniker):If the moniker is part of a composite moniker, otherwise None - iidResult(typing.Any):IID of the result object. - -Returns: - - PyIUnknown - - """ - pass - - - def BindToStorage(self,bindCtx:'PyIBindCtx',moniker:'PyIMoniker',iidResult:'typing.Any') -> 'PyIUnknown': - """ - Retrieves an interface object to the storage that contains the - -object identified by the moniker. - -Args: - - bindCtx(PyIBindCtx):bind context object to be used. - moniker(PyIMoniker):If the moniker is part of a composite moniker, otherwise None - iidResult(typing.Any):IID of the result object. - -Returns: - - PyIUnknown - - """ - pass - - - def GetDisplayName(self,bindCtx:'PyIBindCtx',moniker:'PyIMoniker') -> 'str': - """ - Gets the display name , which is a user-readable representation of this - -moniker. - -Args: - - bindCtx(PyIBindCtx):bind context object to be used. - moniker(PyIMoniker):If the moniker is part of a composite moniker, otherwise None - -Returns: - - str - - """ - pass - - - def ComposeWith(self,mkRight:'PyIMoniker',fOnlyIfNotGeneric:'typing.Any') -> 'PyIMoniker': - """ - Combines the current moniker with another moniker, creating a new - -composite moniker. - -Args: - - mkRight(PyIMoniker):The IMoniker interface on the moniker to compose onto the end of this moniker. - fOnlyIfNotGeneric(typing.Any):If TRUE, the caller requires a non-generic composition, so the operation should proceed only if pmkRight is a moniker class that this moniker can compose with in some way other than forming a generic composite. If FALSE, the method can create a generic composite if necessary. - -Returns: - - PyIMoniker - - """ - pass - - - def Enum(self,fForward:'typing.Any'=True) -> 'PyIEnumMoniker': - """ - Supplies an enumerator that can enumerate the components of a composite - -moniker. - -Args: - - fForward(typing.Any):If TRUE, enumerates the monikers from left to right. If FALSE, enumerates from right to left. - -Returns: - - PyIEnumMoniker - - """ - pass - - - def IsEqual(self,other:'PyIMoniker') -> 'typing.Any': - """ - Compares this moniker with a specified moniker and indicates whether they are - -identical. - -Args: - - other(PyIMoniker):The moniker to compare - -Returns: - - typing.Any - - """ - pass - - - def IsSystemMoniker(self,) -> 'typing.Any': - """ - Indicates whether this moniker is of one of the system-supplied moniker - -classes. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def Hash(self,) -> 'typing.Any': - """ - Calculates a 32-bit integer using the internal state of the moniker. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyIMsgServiceAdmin(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetLastError(self,hr:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - Returns the last error code for the object. - -Args: - - hr(typing.Any):Contains the error code generated in the previous method call. - flags(typing.Any):Indicates for format for the output. - -Returns: - - typing.Any - - """ - pass - - - def CreateMsgService(self,serviceName:'str',displayName:'str',flags:'typing.Any',uiParam:'typing.Any'=0) -> 'None': - """ - Creates a message service. - -Args: - - serviceName(str):The name of the service. - displayName(str):Display name of the service, or None - flags(typing.Any):A bitmask of flags that controls how the message service is installed. - uiParam(typing.Any):A handle of the parent window for any dialog boxes or windows that this method displays. - -Returns: - - None - - """ - pass - - - def ConfigureMsgService(self,iid:'PyIID',ulUIParam:'typing.Any',ulFlags:'typing.Any',arg:'typing.List[typing.Any]') -> 'None': - """ - Reconfigures a message service. - -Args: - - iid(PyIID):The unique identifier for the message service to configure. - ulUIParam(typing.Any):Handle of the parent window for the configuration property sheet. - ulFlags(typing.Any):Bitmask of flags that controls the display of the property sheet. - arg(typing.List[typing.Any]):Property values describing the properties to display in the property sheet. Should not be None if the service is to be configured without a message service. - -Returns: - - None - - """ - pass - - - def GetMsgServiceTable(self,flags:'typing.Any') -> 'PyIMAPITable': - """ - Retrieves a table of services. - -Args: - - flags(typing.Any): - -Returns: - - PyIMAPITable - - """ - pass - - - def GetProviderTable(self,flags:'typing.Any') -> 'PyIMAPITable': - """ - Retrieves a table of service providers. - -Args: - - flags(typing.Any): - -Returns: - - PyIMAPITable - - """ - pass - - - def DeleteMsgService(self,uuid:'PyIID') -> 'None': - """ - Deletes the specified service - -Args: - - uuid(PyIID):The ID of the service - -Returns: - - None - - """ - pass - - - def RenameMsgService(self,uuid:'PyIID',flags:'typing.Any',newName:'str') -> 'None': - """ - Renames the specified service - -Args: - - uuid(PyIID):The ID of the service - flags(typing.Any): - newName(str):The new name for the service.CommentsThis is deprecated, and there is no replacement referenced to use instead. - -Returns: - - None - - """ - pass - - - def OpenProfileSection(self,uuid:'PyIID',iid:'PyIID',flags:'typing.Any') -> 'typing.Any': - """ - Opens a profile section - -Args: - - uuid(PyIID):The ID of the service - iid(PyIID):The IID of the resulting object, or None for the default - flags(typing.Any): - -Returns: - - typing.Any - - """ - pass - - - def AdminProviders(self,uuid:'PyIID',flags:'typing.Any') -> 'typing.Any': - """ - Returns an object providing access - -to a provider administration object. - -Args: - - uuid(PyIID):The ID of the service - flags(typing.Any): - -Returns: - - typing.Any - - """ - pass - - -class PyIMsgStore(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OpenEntry(self,entryId:'str',iid:'PyIID',flags:'typing.Any') -> 'typing.Any': - """ - Opens a folder or message and returns an interface object for further access. - -Args: - - entryId(str):The entryID of the object - iid(PyIID):The IID of the object to return, or None for the default IID - flags(typing.Any):Bitmask of flags that controls how the object is opened. - -Returns: - - typing.Any - - """ - pass - - - def GetReceiveFolder(self,messageClass:'str'=None,flags:'typing.Any'=0) -> 'typing.Tuple[PyIID, str]': - """ - Obtains the folder that was established as the destination for incoming messages of a specified message class or the default receive folder for the message store. - -Args: - - messageClass(str):Message class that is associated with a receive folder. If this parameter is set to None or an empty string, GetReceiveFolder returns the default receive folder for the message store. - flags(typing.Any): - -Returns: - - typing.Tuple[PyIID, str] - - """ - pass - - - def GetReceiveFolderTable(self,flags:'typing.Any') -> 'PyIMAPITable': - """ - provides access to the receive folder table, a table that includes information about all of the receive folders for the message store. - -Args: - - flags(typing.Any):Bitmask of flags that controls table access - -Returns: - - PyIMAPITable - - """ - pass - - - def CompareEntryIDs(self,entryId:'str',entryId1:'str',flags:'typing.Any'=0) -> 'typing.Any': - """ - Compares two entry identifiers belonging to a particular address book provider to determine if they refer to the same address book object - -Args: - - entryId(str):The first entry ID to be compared - entryId1(str):The second entry ID to be compared - flags(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. - -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 - - - def GetLastError(self,hr:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - Returns the last error code for the object. - -Args: - - hr(typing.Any):Contains the error code generated in the previous method call. - flags(typing.Any):Indicates for format for the output. - -Returns: - - typing.Any - - """ - pass - - - def AbortSubmit(self,entryId:'str',flags:'typing.Any'=0) -> 'typing.Any': - """ - Attempts to remove a message from the outgoing queue. - -Args: - - entryId(str):The entry ID of the item to be aborted. - flags(typing.Any):Reserved - must be zero. - -Returns: - - typing.Any - - """ - pass - - - def Advise(self,entryId:'str',eventMask:'typing.Any',adviseSink:'typing.Any') -> 'None': - """ - Registers to receive notification of specified events that affect the message store. - -Args: - - entryId(str):entry identifier of the folder or message about which notifications should be generated, or None - eventMask(typing.Any):A mask of values that indicate the types of notification events. - adviseSink(typing.Any):An advise sink. - -Returns: - - None - - """ - pass - - - def Unadvise(self,connection:'typing.Any') -> 'None': - """ - Cancels the sending of notifications previously set up with a call to the IMsgStore::Advise method. - -Args: - - connection(typing.Any):Connection number returned from PyIMsgStore::Advise - -Returns: - - None - - """ - pass - - -class PyINameSpaceTreeControl(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,hwndParent:'typing.Union[typing.Any]',prc:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',nsctsFlags:'typing.Any') -> 'None': - """ - Description of Initialize. - -Args: - - hwndParent(typing.Union[typing.Any]):Description for hwndParent - prc(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Description for prc - nsctsFlags(typing.Any):Description for nsctsFlags - -Returns: - - None - - """ - pass - - - def TreeAdvise(self,punk:'PyIUnknown') -> 'None': - """ - Description of TreeAdvise. - -Args: - - punk(PyIUnknown):Description for punk - -Returns: - - None - - """ - pass - - - def TreeUnadvise(self,dwCookie:'typing.Any') -> 'None': - """ - Description of TreeUnadvise. - -Args: - - dwCookie(typing.Any):Description for dwCookie - -Returns: - - None - - """ - pass - - - def AppendRoot(self,psiRoot:'PyIShellItem',grfEnumFlags:'typing.Any',grfRootStyle:'typing.Any',pif:'typing.Any') -> 'None': - """ - Description of AppendRoot. - -Args: - - psiRoot(PyIShellItem):Description for psiRoot - grfEnumFlags(typing.Any):Description for grfEnumFlags - grfRootStyle(typing.Any):Description for grfRootStyle - pif(typing.Any):Description for pif - -Returns: - - None - - """ - pass - - - def InsertRoot(self,iIndex:'typing.Any',psiRoot:'PyIShellItem',grfEnumFlags:'typing.Any',grfRootStyle:'typing.Any',pif:'typing.Any') -> 'None': - """ - Description of InsertRoot. - -Args: - - iIndex(typing.Any):Description for iIndex - psiRoot(PyIShellItem):Description for psiRoot - grfEnumFlags(typing.Any):Description for grfEnumFlags - grfRootStyle(typing.Any):Description for grfRootStyle - pif(typing.Any):Description for pif - -Returns: - - None - - """ - pass - - - def RemoveRoot(self,psiRoot:'PyIShellItem') -> 'None': - """ - Description of RemoveRoot. - -Args: - - psiRoot(PyIShellItem):Description for psiRoot - -Returns: - - None - - """ - pass - - - def RemoveAllRoots(self,) -> 'None': - """ - Description of RemoveAllRoots. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetRootItems(self,) -> 'None': - """ - Description of GetRootItems. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetItemState(self,psi:'PyIShellItem',nstcisMask:'typing.Any',nstcisFlags:'typing.Any') -> 'None': - """ - Description of SetItemState. - -Args: - - psi(PyIShellItem):Description for psi - nstcisMask(typing.Any):Description for nstcisMask - nstcisFlags(typing.Any):Description for nstcisFlags - -Returns: - - None - - """ - pass - - - def GetItemState(self,psi:'PyIShellItem',nstcisMask:'typing.Any') -> 'None': - """ - Description of GetItemState. - -Args: - - psi(PyIShellItem):Description for psi - nstcisMask(typing.Any):Description for nstcisMask - -Returns: - - None - - """ - pass - - - def GetSelectedItems(self,) -> 'None': - """ - Description of GetSelectedItems. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetItemCustomState(self,psi:'PyIShellItem') -> 'None': - """ - Description of GetItemCustomState. - -Args: - - psi(PyIShellItem):Description for psi - -Returns: - - None - - """ - pass - - - def SetItemCustomState(self,psi:'PyIShellItem',iStateNumber:'typing.Any') -> 'None': - """ - Description of SetItemCustomState. - -Args: - - psi(PyIShellItem):Description for psi - iStateNumber(typing.Any):Description for iStateNumber - -Returns: - - None - - """ - pass - - - def EnsureItemVisible(self,psi:'PyIShellItem') -> 'None': - """ - Description of EnsureItemVisible. - -Args: - - psi(PyIShellItem):Description for psi - -Returns: - - None - - """ - pass - - - def SetTheme(self,pszTheme:'typing.Any') -> 'None': - """ - Description of SetTheme. - -Args: - - pszTheme(typing.Any):Description for pszTheme - -Returns: - - None - - """ - pass - - - def GetNextItem(self,psi:'PyIShellItem',nstcgi:'typing.Any') -> 'None': - """ - Description of GetNextItem. - -Args: - - psi(PyIShellItem):Description for psi - nstcgi(typing.Any):Description for nstcgi - -Returns: - - None - - """ - pass - - - def HitTest(self,pt:'typing.Tuple[typing.Any, typing.Any]') -> 'None': - """ - Description of HitTest. - -Args: - - pt(typing.Tuple[typing.Any, typing.Any]):Description for ppt - -Returns: - - None - - """ - pass - - - def GetItemRect(self,) -> 'None': - """ - Description of GetItemRect. - -Args: - - - -Returns: - - None - - """ - pass - - - def CollapseAll(self,) -> 'None': - """ - Description of CollapseAll. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyINamedPropertyStore(object): - """Contains a collection of properties indentified by name""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetNamedValue(self,Name:'typing.Any') -> 'PyPROPVARIANT': - """ - Retrieves a property value by name - -Args: - - Name(typing.Any):Name of the property - -Returns: - - PyPROPVARIANT - - """ - pass - - - def SetNamedValue(self,propvar:'typing.Any') -> 'None': - """ - Sets the value of a property - -Args: - - propvar(typing.Any):Description for propvar - -Returns: - - None - - """ - pass - - - def GetNameCount(self,) -> 'typing.Any': - """ - Retrieves the number of named properties in the store - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetNameAt(self,Index:'typing.Any') -> 'typing.Any': - """ - Retrieves a property name by zero-based index - -Args: - - Index(typing.Any):Index of the property name - -Returns: - - typing.Any - - """ - pass - - -class PyIObjectArray(object): - """Holds a collection of interface objects""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetCount(self,) -> 'typing.Any': - """ - Returns number of objects in collection - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetAt(self,Index:'typing.Any',riid:'PyIID') -> 'PyIUnknown': - """ - Retrieves an item by zero-based index - -Args: - - Index(typing.Any):Index of item to retrieve - riid(PyIID):The interface to return - -Returns: - - PyIUnknown - - """ - pass - - -class PyIObjectCollection(object): - """Modifiable container for a number of IUnknown objects""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddObject(self,punk:'PyIUnknown') -> 'None': - """ - Adds a single object to the collection - -Args: - - punk(PyIUnknown):Object to be added - -Returns: - - None - - """ - pass - - - def AddFromArray(self,Source:'PyIObjectArray') -> 'None': - """ - None - -Args: - - Source(PyIObjectArray):Objects to be added to the collection - -Returns: - - None - - """ - pass - - - def RemoveObjectAt(self,Index:'typing.Any') -> 'None': - """ - Removes a single object from the collection - -Args: - - Index(typing.Any):Zero-based index of item to remove - -Returns: - - None - - """ - pass - - - def Clear(self,) -> 'None': - """ - Empties the container. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIObjectWithPropertyKey(object): - """Interface implemented by objects that have an associated property id""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetPropertyKey(self,key:'PyPROPERTYKEY') -> 'None': - """ - Sets the property id - -Args: - - key(PyPROPERTYKEY):The identifier of the property - -Returns: - - None - - """ - pass - - - def GetPropertyKey(self,) -> 'PyPROPERTYKEY': - """ - Returns the property id - -Args: - - - -Returns: - - PyPROPERTYKEY - - """ - pass - - -class PyIObjectWithSite(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetSite(self,pUnkSite:'typing.Any') -> 'None': - """ - Description of SetSite. - -Args: - - pUnkSite(typing.Any):Description for pUnkSite - -Returns: - - None - - """ - pass - - - def GetSite(self,riid:'PyIID') -> 'None': - """ - Description of GetSite. - -Args: - - riid(PyIID):Description for riid - -Returns: - - None - - """ - pass - - -class PyIOleClientSite(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SaveObject(self,) -> 'None': - """ - Description of SaveObject. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetMoniker(self,dwAssign:'typing.Any',dwWhichMoniker:'typing.Any') -> 'None': - """ - Description of GetMoniker. - -Args: - - dwAssign(typing.Any):Description for dwAssign - dwWhichMoniker(typing.Any):Description for dwWhichMoniker - -Returns: - - None - - """ - pass - - - def GetContainer(self,) -> 'None': - """ - Description of GetContainer. - -Args: - - - -Returns: - - None - - """ - pass - - - def ShowObject(self,) -> 'None': - """ - Description of ShowObject. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnShowWindow(self,fShow:'typing.Any') -> 'None': - """ - Description of OnShowWindow. - -Args: - - fShow(typing.Any):Description for fShow - -Returns: - - None - - """ - pass - - - def RequestNewObjectLayout(self,) -> 'None': - """ - Description of RequestNewObjectLayout. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIOleCommandTarget(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def QueryStatus(self,) -> 'None': - """ - Description of QueryStatus. - -Args: - - - -Returns: - - None - - """ - pass - - - def Exec(self,) -> 'None': - """ - Description of Exec. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIOleControl(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetControlInfo(self,) -> 'None': - """ - Description of GetControlInfo. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnMnemonic(self,msg:'typing.Any') -> 'None': - """ - Description of OnMnemonic. - -Args: - - msg(typing.Any):A tuple representing a MSG structure. - -Returns: - - None - - """ - pass - - - def OnAmbientPropertyChange(self,dispID:'typing.Any') -> 'None': - """ - Description of OnAmbientPropertyChange. - -Args: - - dispID(typing.Any):Description for dispID - -Returns: - - None - - """ - pass - - - def FreezeEvents(self,bFreeze:'typing.Any') -> 'None': - """ - Description of FreezeEvents. - -Args: - - bFreeze(typing.Any):Description for bFreeze - -Returns: - - None - - """ - pass - - -class PyIOleControlSite(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OnControlInfoChanged(self,) -> 'None': - """ - Description of OnControlInfoChanged. - -Args: - - - -Returns: - - None - - """ - pass - - - def LockInPlaceActive(self,fLock:'typing.Any') -> 'None': - """ - Description of LockInPlaceActive. - -Args: - - fLock(typing.Any):Description for fLock - -Returns: - - None - - """ - pass - - - def GetExtendedControl(self,) -> 'None': - """ - Description of GetExtendedControl. - -Args: - - - -Returns: - - None - - """ - pass - - - def TransformCoords(self,PtlHimetric:'typing.Tuple[typing.Any, typing.Any]',pPtfContainer:'typing.Tuple[float, float]',dwFlags:'typing.Any') -> 'None': - """ - Description of TransformCoords. - -Args: - - PtlHimetric(typing.Tuple[typing.Any, typing.Any]):Description for pPtlHimetric - pPtfContainer(typing.Tuple[float, float]):Description for pPtfContainer - dwFlags(typing.Any):Description for dwFlagsReturn ValueThe result is a tuple of the transformed input points - ie, a tuple of ((int, int), (float, float)) - -Returns: - - None:Description for dwFlagsReturn ValueThe result is a tuple of the transformed input points - ie, - -a tuple of ((int, int), (float, float)) - - - """ - pass - - - def TranslateAccelerator(self,pMsg:'PyMSG',grfModifiers:'typing.Any') -> 'None': - """ - Description of TranslateAccelerator. - -Args: - - pMsg(PyMSG):Description for pMsg - grfModifiers(typing.Any):Description for grfModifiers - -Returns: - - None - - """ - pass - - - def OnFocus(self,fGotFocus:'typing.Any') -> 'None': - """ - Description of OnFocus. - -Args: - - fGotFocus(typing.Any):Description for fGotFocus - -Returns: - - None - - """ - pass - - - def ShowPropertyFrame(self,) -> 'None': - """ - Description of ShowPropertyFrame. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIOleInPlaceActiveObject(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def TranslateAccelerator(self,lpmsg:'PyMSG') -> 'None': - """ - Description of TranslateAccelerator. - -Args: - - lpmsg(PyMSG):Description for lpmsg - -Returns: - - None - - """ - pass - - - def OnFrameWindowActivate(self,fActivate:'typing.Any') -> 'None': - """ - Description of OnFrameWindowActivate. - -Args: - - fActivate(typing.Any):Description for fActivate - -Returns: - - None - - """ - pass - - - def OnDocWindowActivate(self,fActivate:'typing.Any') -> 'None': - """ - Description of OnDocWindowActivate. - -Args: - - fActivate(typing.Any):Description for fActivate - -Returns: - - None - - """ - pass - - - def ResizeBorder(self,rcBorder:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',pUIWindow:'PyIOleInPlaceUIWindow',fFrameWindow:'typing.Any') -> 'None': - """ - Description of ResizeBorder. - -Args: - - rcBorder(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Description for prcBorder - pUIWindow(PyIOleInPlaceUIWindow):Description for pUIWindow - fFrameWindow(typing.Any):Description for fFrameWindow - -Returns: - - None - - """ - pass - - - def EnableModeless(self,fEnable:'typing.Any') -> 'None': - """ - Description of EnableModeless. - -Args: - - fEnable(typing.Any):Description for fEnable - -Returns: - - None - - """ - pass - - -class PyIOleInPlaceFrame(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def InsertMenus(self,hmenuShared:'typing.Union[typing.Any]',menuWidths:'PyOLEMENUGROUPWIDTHS') -> 'None': - """ - Description of InsertMenus. - -Args: - - hmenuShared(typing.Union[typing.Any]):Description for hmenuShared - menuWidths(PyOLEMENUGROUPWIDTHS): - -Returns: - - None - - """ - pass - - - def SetMenu(self,hmenuShared:'typing.Union[typing.Any]',holemenu:'typing.Union[typing.Any]',hwndActiveObject:'typing.Union[typing.Any]') -> 'None': - """ - Description of SetMenu. - -Args: - - hmenuShared(typing.Union[typing.Any]):Description for hmenuShared - holemenu(typing.Union[typing.Any]):Description for holemenu - hwndActiveObject(typing.Union[typing.Any]):Description for hwndActiveObject - -Returns: - - None - - """ - pass - - - def RemoveMenus(self,hmenuShared:'typing.Union[typing.Any]') -> 'None': - """ - Description of RemoveMenus. - -Args: - - hmenuShared(typing.Union[typing.Any]):Description for hmenuShared - -Returns: - - None - - """ - pass - - - def SetStatusText(self,pszStatusText:'typing.Any') -> 'None': - """ - Description of SetStatusText. - -Args: - - pszStatusText(typing.Any):Description for pszStatusText - -Returns: - - None - - """ - pass - - - def EnableModeless(self,fEnable:'typing.Any') -> 'None': - """ - Description of EnableModeless. - -Args: - - fEnable(typing.Any):Description for fEnable - -Returns: - - None - - """ - pass - - - def TranslateAccelerator(self,lpmsg:'PyMSG',wID:'typing.Any') -> 'None': - """ - Description of TranslateAccelerator. - -Args: - - lpmsg(PyMSG):Description for lpmsg - wID(typing.Any):Description for wID - -Returns: - - None - - """ - pass - - -class PyIOleInPlaceObject(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def InPlaceDeactivate(self,) -> 'None': - """ - Description of InPlaceDeactivate. - -Args: - - - -Returns: - - None - - """ - pass - - - def UIDeactivate(self,) -> 'None': - """ - Description of UIDeactivate. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetObjectRects(self,) -> 'None': - """ - Description of SetObjectRects. - -Args: - - - -Returns: - - None - - """ - pass - - - def ReactivateAndUndo(self,) -> 'None': - """ - Description of ReactivateAndUndo. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIOleInPlaceSite(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CanInPlaceActivate(self,) -> 'None': - """ - Description of CanInPlaceActivate. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnInPlaceActivate(self,) -> 'None': - """ - Description of OnInPlaceActivate. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnUIActivate(self,) -> 'None': - """ - Description of OnUIActivate. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetWindowContext(self,) -> 'None': - """ - Description of GetWindowContext. - -Args: - - - -Returns: - - None - - """ - pass - - - def Scroll(self,) -> 'None': - """ - Description of Scroll. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnUIDeactivate(self,fUndoable:'typing.Any') -> 'None': - """ - Description of OnUIDeactivate. - -Args: - - fUndoable(typing.Any):Description for fUndoable - -Returns: - - None - - """ - pass - - - def OnInPlaceDeactivate(self,) -> 'None': - """ - Description of OnInPlaceDeactivate. - -Args: - - - -Returns: - - None - - """ - pass - - - def DiscardUndoState(self,) -> 'None': - """ - Description of DiscardUndoState. - -Args: - - - -Returns: - - None - - """ - pass - - - def DeactivateAndUndo(self,) -> 'None': - """ - Description of DeactivateAndUndo. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnPosRectChange(self,) -> 'None': - """ - Description of OnPosRectChange. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIOleInPlaceSiteEx(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OnInPlaceActivateEx(self,dwFlags:'typing.Any') -> 'None': - """ - Description of OnInPlaceActivateEx. - -Args: - - dwFlags(typing.Any):Description for dwFlags - -Returns: - - None - - """ - pass - - - def OnInPlaceDeactivateEx(self,fNoRedraw:'typing.Any') -> 'None': - """ - Description of OnInPlaceDeactivateEx. - -Args: - - fNoRedraw(typing.Any):Description for fNoRedraw - -Returns: - - None - - """ - pass - - - def RequestUIActivate(self,) -> 'None': - """ - Description of RequestUIActivate. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIOleInPlaceSiteWindowless(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CanWindowlessActivate(self,) -> 'None': - """ - Description of CanWindowlessActivate. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCapture(self,) -> 'None': - """ - Description of GetCapture. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetCapture(self,fCapture:'typing.Any') -> 'None': - """ - Description of SetCapture. - -Args: - - fCapture(typing.Any):Description for fCapture - -Returns: - - None - - """ - pass - - - def GetFocus(self,) -> 'None': - """ - Description of GetFocus. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetFocus(self,fFocus:'typing.Any') -> 'None': - """ - Description of SetFocus. - -Args: - - fFocus(typing.Any):Description for fFocus - -Returns: - - None - - """ - pass - - - def GetDC(self,grfFlags:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]') -> 'None': - """ - Description of GetDC. - -Args: - - grfFlags(typing.Any):Description for grfFlags - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]): - -Returns: - - None - - """ - pass - - - def ReleaseDC(self,hDC:'typing.Any') -> 'None': - """ - Description of ReleaseDC. - -Args: - - hDC(typing.Any):Description for hDC - -Returns: - - None - - """ - pass - - - def InvalidateRect(self,rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',fErase:'typing.Any') -> 'None': - """ - Description of InvalidateRect. - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]): - fErase(typing.Any):Description for fErase - -Returns: - - None - - """ - pass - - - def InvalidateRgn(self,hRgn:'typing.Any',fErase:'typing.Any') -> 'None': - """ - Description of InvalidateRgn. - -Args: - - hRgn(typing.Any):Handle to a region - fErase(typing.Any):Description for fErase - -Returns: - - None - - """ - pass - - - def ScrollRect(self,dx:'typing.Any',dy:'typing.Any') -> 'None': - """ - Description of ScrollRect. - -Args: - - dx(typing.Any):Description for dx - dy(typing.Any):Description for dy - -Returns: - - None - - """ - pass - - - def AdjustRect(self,) -> 'None': - """ - Description of AdjustRect. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnDefWindowMessage(self,msg:'typing.Any',wParam:'typing.Any',lParam:'typing.Any') -> 'None': - """ - Description of OnDefWindowMessage. - -Args: - - msg(typing.Any):Description for msg - wParam(typing.Any):Description for wParam - lParam(typing.Any):Description for lParam - -Returns: - - None - - """ - pass - - -class PyIOleInPlaceUIWindow(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetBorder(self,) -> 'None': - """ - Description of GetBorder. - -Args: - - - -Returns: - - None - - """ - pass - - - def RequestBorderSpace(self,borderwidths:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]') -> 'None': - """ - Description of RequestBorderSpace. - -Args: - - borderwidths(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Description for pborderwidths - -Returns: - - None - - """ - pass - - - def SetBorderSpace(self,borderwidths:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]') -> 'None': - """ - Description of SetBorderSpace. - -Args: - - borderwidths(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Description for pborderwidths - -Returns: - - None - - """ - pass - - - def SetActiveObject(self,pActiveObject:'PyIOleInPlaceActiveObject',pszObjName:'typing.Any') -> 'None': - """ - Description of SetActiveObject. - -Args: - - pActiveObject(PyIOleInPlaceActiveObject):Description for pActiveObject - pszObjName(typing.Any):Description for pszObjName - -Returns: - - None - - """ - pass - - -class PyIOleObject(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetClientSite(self,pClientSite:'PyIOleClientSite') -> 'None': - """ - Description of SetClientSite. - -Args: - - pClientSite(PyIOleClientSite):Description for pClientSite - -Returns: - - None - - """ - pass - - - def GetClientSite(self,) -> 'None': - """ - Description of GetClientSite. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetHostNames(self,szContainerApp:'typing.Any',szContainerObj:'typing.Any') -> 'None': - """ - Description of SetHostNames. - -Args: - - szContainerApp(typing.Any):Description for szContainerApp - szContainerObj(typing.Any):Description for szContainerObj - -Returns: - - None - - """ - pass - - - def Close(self,dwSaveOption:'typing.Any') -> 'None': - """ - Description of Close. - -Args: - - dwSaveOption(typing.Any):Description for dwSaveOption - -Returns: - - None - - """ - pass - - - def SetMoniker(self,dwWhichMoniker:'typing.Any',pmk:'PyIMoniker') -> 'None': - """ - Description of SetMoniker. - -Args: - - dwWhichMoniker(typing.Any):Description for dwWhichMoniker - pmk(PyIMoniker):Description for pmk - -Returns: - - None - - """ - pass - - - def GetMoniker(self,dwAssign:'typing.Any',dwWhichMoniker:'typing.Any') -> 'None': - """ - Description of GetMoniker. - -Args: - - dwAssign(typing.Any):Description for dwAssign - dwWhichMoniker(typing.Any):Description for dwWhichMoniker - -Returns: - - None - - """ - pass - - - def InitFromData(self,pDataObject:'PyIDataObject',fCreation:'typing.Any',dwReserved:'typing.Any') -> 'None': - """ - Description of InitFromData. - -Args: - - pDataObject(PyIDataObject):Description for pDataObject - fCreation(typing.Any):Description for fCreation - dwReserved(typing.Any):Description for dwReserved - -Returns: - - None - - """ - pass - - - def GetClipboardData(self,dwReserved:'typing.Any') -> 'None': - """ - Description of GetClipboardData. - -Args: - - dwReserved(typing.Any):Description for dwReserved - -Returns: - - None - - """ - pass - - - def DoVerb(self,iVerb:'typing.Any',msg:'PyMSG',pActiveSite:'PyIOleClientSite',lindex:'typing.Any',hwndParent:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]') -> 'None': - """ - Description of DoVerb. - -Args: - - iVerb(typing.Any):Description for iVerb - msg(PyMSG):MSG tuple, a-la win32gui etc. - pActiveSite(PyIOleClientSite):Description for pActiveSite - lindex(typing.Any):Description for lindex - hwndParent(typing.Any):Description for hwndParent - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]): - -Returns: - - None - - """ - pass - - - def EnumVerbs(self,) -> 'None': - """ - Description of EnumVerbs. - -Args: - - - -Returns: - - None - - """ - pass - - - def Update(self,) -> 'None': - """ - Description of Update. - -Args: - - - -Returns: - - None - - """ - pass - - - def IsUpToDate(self,) -> 'None': - """ - Description of IsUpToDate. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetUserClassID(self,) -> 'None': - """ - Description of GetUserClassID. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetUserType(self,dwFormOfType:'typing.Any') -> 'None': - """ - Description of GetUserType. - -Args: - - dwFormOfType(typing.Any):Description for dwFormOfType - -Returns: - - None - - """ - pass - - - def SetExtent(self,dwDrawAspect:'typing.Any',size:'typing.Tuple[typing.Any, typing.Any]') -> 'None': - """ - Description of SetExtent. - -Args: - - dwDrawAspect(typing.Any):Description for dwDrawAspect - size(typing.Tuple[typing.Any, typing.Any]):Size limit for the object. - -Returns: - - None - - """ - pass - - - def GetExtent(self,dwDrawAspect:'typing.Any',size:'typing.Tuple[typing.Any, typing.Any]') -> 'None': - """ - Description of GetExtent. - -Args: - - dwDrawAspect(typing.Any):Description for dwDrawAspect - size(typing.Tuple[typing.Any, typing.Any]):Size limit for the object. - -Returns: - - None - - """ - pass - - - def Advise(self,pAdvSink:'typing.Any') -> 'None': - """ - Description of Advise. - -Args: - - pAdvSink(typing.Any):Description for pAdvSink - -Returns: - - None - - """ - pass - - - def Unadvise(self,dwConnection:'typing.Any') -> 'None': - """ - Description of Unadvise. - -Args: - - dwConnection(typing.Any):Description for dwConnection - -Returns: - - None - - """ - pass - - - def EnumAdvise(self,) -> 'None': - """ - Description of EnumAdvise. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetMiscStatus(self,dwAspect:'typing.Any') -> 'None': - """ - Description of GetMiscStatus. - -Args: - - dwAspect(typing.Any):Description for dwAspect - -Returns: - - None - - """ - pass - - - def SetColorScheme(self,) -> 'None': - """ - Description of SetColorScheme. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIOleWindow(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetWindow(self,) -> 'None': - """ - Description of GetWindow. - -Args: - - - -Returns: - - None - - """ - pass - - - def ContextSensitiveHelp(self,fEnterMode:'typing.Any') -> 'None': - """ - Description of ContextSensitiveHelp. - -Args: - - fEnterMode(typing.Any):Description for fEnterMode - -Returns: - - None - - """ - pass - - -class PyIPersist(object): - """A Python interface to IPersist""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetClassID(self,) -> 'PyIID': - """ - Returns the class identifier (CLSID) for the component object. - -Args: - - - -Returns: - - PyIID - - """ - pass - - -class PyIPersistFile(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def IsDirty(self,) -> 'None': - """ - Checks an object for changes since it was last saved to its current file. - -Args: - - - -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. - -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 - - - def Load(self,FileName:'typing.Any',Mode:'typing.Any') -> 'None': - """ - Opens the specified file and initializes an object from the file contents. - -Args: - - FileName(typing.Any):Absolute path of the file to open - Mode(typing.Any):Specifies the access mode from the STGM enumeration. - -Returns: - - None - - """ - pass - - - def Save(self,FileName:'typing.Any',fRemember:'typing.Any') -> 'None': - """ - Saves the object into the specified file. - -Args: - - FileName(typing.Any):absolute path of the file where the object is saved. - fRemember(typing.Any):Specifies whether the file is to be the current working file or not. - -Returns: - - None - - """ - pass - - - def SaveCompleted(self,FileName:'typing.Any') -> 'None': - """ - Notifies the object that it can revert from NoScribble mode to Normal mode. - -Args: - - FileName(typing.Any):Absolute path of the file where the object was saved. - -Returns: - - None - - """ - pass - - - def GetCurFile(self,) -> 'typing.Any': - """ - Gets the current name of the file associated with the object. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyIPersistFolder(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,pidl:'PyIDL') -> 'None': - """ - Description of Initialize. - -Args: - - pidl(PyIDL):Description for pidl - -Returns: - - None - - """ - pass - - -class PyIPersistFolder2(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetCurFolder(self,) -> 'None': - """ - Description of GetCurFolder. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIPersistPropertyBag(object): - """A Python wrapper for a COM IPersistPropertyBag interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def InitNew(self,) -> 'None': - """ - Called by the container when the control is initialized to initialize the - -property bag. - -Args: - - - -Returns: - - None - - """ - pass - - - def Load(self,bag:'PyIPropertyBag',log:'PyIErrorLog'=None) -> 'None': - """ - Called by the container to load the control's properties. - -Args: - - bag(PyIPropertyBag):the caller's property bag. - log(PyIErrorLog):the caller's error log, or None - -Returns: - - None - - """ - pass - - - def Save(self,bag:'PyIPropertyBag',clearDirty:'typing.Any',saveProperties:'typing.Any') -> 'None': - """ - Called by the container to save the object's properties. - -Args: - - bag(PyIPropertyBag):the caller's property bag. - clearDirty(typing.Any):Specifies whether to clear the dirty flag. - saveProperties(typing.Any):Specifies whether to save all properties or just those that have changed - -Returns: - - None - - """ - pass - - -class PyIPersistSerializedPropStorage(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetFlags(self,flags:'typing.Any') -> 'None': - """ - Sets flags for the store - -Args: - - flags(typing.Any):Combination of pscon.FPSPS_* values - -Returns: - - None - - """ - pass - - - def SetPropertyStorage(self,ps:'typing.Any') -> 'None': - """ - Initializes the store with a serialized buffer - -Args: - - ps(typing.Any):Bytes or buffer object containing a serialized property store - -Returns: - - None - - """ - pass - - - def GetPropertyStorage(self,) -> 'typing.Any': - """ - Retrieves the current contents of the property - -store - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyIPersistStorage(object): - """A Python wrapper of a COM IPersistStorage interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def IsDirty(self,) -> 'typing.Any': - """ - Checks the object for changes since it was last saved. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def InitNew(self,PyIStorage:'PyIStorage') -> 'None': - """ - Initializes a new object, providing a storage object to be used for the object. - -Args: - - PyIStorage(PyIStorage):PyIStorage for the new storage object to be initialized. The container creates a nested storage object in its storage object (see PyIStorage::CreateStorage). Then, the container calls the PyIPersistStorage::WriteClassStg function to initialize the new storage object with the object class identifier (CLSID). - -Returns: - - None - - """ - pass - - - def Load(self,storage:'PyIStorage') -> 'None': - """ - Loads an object from its existing storage. - -Args: - - storage(PyIStorage):Existing storage for the object. - -Returns: - - None - - """ - pass - - - def Save(self,PyIStorage:'PyIStorage',_int:'typing.Any') -> 'None': - """ - None - -Args: - - PyIStorage(PyIStorage):Storage for the object - _int(typing.Any):Indicates whether the specified storage object is the current one. This parameter is set to FALSE when performing a Save As or Save A Copy To operation or when performing a full save. In the latter case, this method saves to a temporary file, deletes the original file, and renames the temporary file. This parameter is set to TRUE to perform a full save in a low-memory situation or to perform a fast incremental save in which only the dirty components are saved. - -Returns: - - None - - """ - pass - - - def SaveCompleted(self,PyIStorage:'PyIStorage') -> 'None': - """ - None - -Args: - - PyIStorage(PyIStorage):The current storage object - -Returns: - - None - - """ - pass - - - def HandsOffStorage(self,) -> 'None': - """ - 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 - -operation that works is a close operation. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIPersistStream(object): - """A Python interface to IPersistStream""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def IsDirty(self,) -> 'typing.Any': - """ - Checks the object for changes since it was last saved. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def Load(self,stream:'PyIStream') -> 'None': - """ - Initializes an object from the stream where it was previously saved. - -Args: - - stream(PyIStream):Stream object to load from.CommentsThis method loads an object from its associated stream. The seek pointer is set as it was in the most recent PyIPersistStream::Save method. This method can seek and read from the stream, but cannot write to it.On exit, the seek pointer must be in the same position it was in on entry, immediately past the end of the data. - -Returns: - - None - - """ - pass - - - def Save(self,stream:'PyIStream',bClearDirty:'typing.Any') -> 'None': - """ - Saves an object to the specified stream. - -Args: - - stream(PyIStream):The stream to save to. - bClearDirty(typing.Any):Indicates whether to clear the dirty flag after the save is complete - -Returns: - - None - - """ - pass - - - def GetSizeMax(self,) -> 'ULARGE_INTEGER': - """ - Returns the size in bytes of the stream needed to save the - -object. - -Args: - - - -Returns: - - ULARGE_INTEGER - - """ - pass - - -class PyIPersistStreamInit(object): - """A Python interface to IPersistStreamInit""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def InitNew(self,) -> 'None': - """ - Initializes the object to a default state. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIProcessDebugManager(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateApplication(self,) -> 'None': - """ - Description of CreateApplication. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDefaultApplication(self,) -> 'None': - """ - Description of GetDefaultApplication. - -Args: - - - -Returns: - - None - - """ - pass - - - def AddApplication(self,pda:'PyIDebugApplication') -> 'None': - """ - Description of AddApplication. - -Args: - - pda(PyIDebugApplication):Description for pda - -Returns: - - None - - """ - pass - - - def RemoveApplication(self,dwAppCookie:'typing.Any') -> 'None': - """ - Description of RemoveApplication. - -Args: - - dwAppCookie(typing.Any):Description for dwAppCookie - -Returns: - - None - - """ - pass - - - def CreateDebugDocumentHelper(self,unkOuter:'typing.Any') -> 'None': - """ - Description of CreateDebugDocumentHelper. - -Args: - - unkOuter(typing.Any):The outer object for aggregation, or (usually!) None - -Returns: - - None - - """ - pass - - -class PyIProfAdmin(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetLastError(self,hr:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - Returns the last error code for the object. - -Args: - - hr(typing.Any):Contains the error code generated in the previous method call. - flags(typing.Any):Indicates for format for the output. - -Returns: - - typing.Any - - """ - pass - - - def CreateProfile(self,oldProfileName:'str',Password:'str',uiParam:'typing.Any'=0,flags:'typing.Any'=0) -> 'None': - """ - Creates a new profile. - -Args: - - oldProfileName(str):The name of the new profile. - Password(str):Must be None - uiParam(typing.Any):A handle of the parent window for any dialog boxes or windows that this method displays. - flags(typing.Any): - -Returns: - - None - - """ - pass - - - def DeleteProfile(self,oldProfileName:'str',flags:'typing.Any'=0) -> 'None': - """ - Deletes a profile. - -Args: - - oldProfileName(str):The name of the profile to be deleted. - flags(typing.Any): - -Returns: - - None - - """ - pass - - - def CopyProfile(self,oldProfileName:'str',Password:'str',newProfileName:'str',uiParam:'typing.Any'=0,flags:'typing.Any'=0) -> 'None': - """ - Copies a profile. - -Args: - - oldProfileName(str):The name of the profile to copy. - Password(str):Must be None - newProfileName(str):The new name of the copied profile. - uiParam(typing.Any):A handle of the parent window for any dialog boxes or windows that this method displays. - flags(typing.Any): - -Returns: - - None - - """ - pass - - - def RenameProfile(self,oldProfileName:'str',Password:'str',newProfileName:'str',uiParam:'typing.Any'=0,flags:'typing.Any'=0) -> 'None': - """ - Assigns a new name to a profile. - -Args: - - oldProfileName(str):The current name of the profile to rename. - Password(str):Must be None - newProfileName(str):The new name of the profile to rename. - uiParam(typing.Any):A handle of the parent window for any dialog boxes or windows that this method displays. - flags(typing.Any): - -Returns: - - None - - """ - pass - - - def SetDefaultProfile(self,profileName:'str',flags:'typing.Any'=0) -> 'None': - """ - Sets or clears a client's default profile. - -Args: - - profileName(str):The name of the profile that will become the default, or None. Setting profileName to None indicates that SetDefaultProfile should remove the existing default profile, leaving the client without a default. - flags(typing.Any): - -Returns: - - None - - """ - pass - - - def AdminServices(self,profileName:'str',Password:'str'=None,uiParam:'typing.Any'=0,flags:'typing.Any'=0) -> 'PyIProfAdmin': - """ - Provides access to a message service administration object for making changes to the message services in a profile. - -Args: - - profileName(str):The name of the profile to be modified. - Password(str): - uiParam(typing.Any):A handle of the parent window for any dialog boxes or windows that this method displays. - flags(typing.Any): - -Returns: - - PyIProfAdmin - - """ - pass - - -class PyIPropertyBag(object): - """A Python wrapper for a COM IPropertyBag interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - 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 - -container. - -Args: - - propName(typing.Any):Name of the property to read. - propType(typing.Any):The type of the object to read. Must be a VT_* Variant Type constant. - errorLog(PyIErrorLog):The caller's PyIErrorLog object in which the property bag stores any errors that occur during reads. Can be None in which case the caller is not interested in errors.CommentsThe result is a Python object, mapped from a COM VARIANT of type as specified in the propType parameter. - -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 - -container. - -Args: - - propName(typing.Any):Name of the property to read. - value(typing.Any):The value for the property. The value must be able to be converted to a COM VARIANT. - -Returns: - - None - - """ - pass - - -class PyIPropertyChange(object): - """Interface used to specify a change to a property""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ApplyToPropVariant(self,OrigVal:'PyPROPVARIANT') -> 'PyPROPVARIANT': - """ - Applies the change to a variant value - -Args: - - OrigVal(PyPROPVARIANT):The value to be modified - -Returns: - - PyPROPVARIANT - - """ - pass - - -class PyIPropertyChangeArray(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetCount(self,) -> 'typing.Any': - """ - Returns the number of changes in the array - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetAt(self,Index:'typing.Any',riid:'PyIID') -> 'PyIPropertyChange': - """ - Retrieves a change by zero-based index - -Args: - - Index(typing.Any):Index of the change to retrieve - riid(PyIID):The interface to return - -Returns: - - PyIPropertyChange - - """ - pass - - - def InsertAt(self,Index:'typing.Any',PropChange:'PyIPropertyChange') -> 'None': - """ - Inserts a change at a specific position - -Args: - - Index(typing.Any):Position at which to place the change - PropChange(PyIPropertyChange):The change to be added - -Returns: - - None - - """ - pass - - - def Append(self,PropChange:'PyIPropertyChange') -> 'None': - """ - Adds a change to the end of the array - -Args: - - PropChange(PyIPropertyChange):The change to be added - -Returns: - - None - - """ - pass - - - def AppendOrReplace(self,PropChange:'PyIPropertyChange') -> 'None': - """ - Adds a change, or replaces if an identical property key is already - -in container - -Args: - - PropChange(PyIPropertyChange):The change to be added or replaced - -Returns: - - None - - """ - pass - - - def RemoveAt(self,Index:'typing.Any') -> 'None': - """ - Removes a change from the array - -Args: - - Index(typing.Any):Index of change to be removed - -Returns: - - None - - """ - pass - - - def IsKeyInArray(self,key:'PyPROPERTYKEY') -> 'typing.Any': - """ - Checks if array contains a change to a property - -Args: - - key(PyPROPERTYKEY):Property key to look for - -Returns: - - typing.Any - - """ - pass - - -class PyIPropertyDescription(object): - """Gives access to the details of a property definition""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPropertyKey(self,) -> 'PyPROPERTYKEY': - """ - Returns the unique identifier for a property - -Args: - - - -Returns: - - PyPROPERTYKEY - - """ - pass - - - def GetCanonicalName(self,) -> 'typing.Any': - """ - Returns the name of the property - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetPropertyType(self,) -> 'typing.Any': - """ - Returns the variant type of the property (VT_*) - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetDisplayName(self,) -> 'typing.Any': - """ - Returns the property name as shown in the UI - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetEditInvitation(self,) -> 'typing.Any': - """ - Returns the input prompt used in edit controls - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetTypeFlags(self,mask:'typing.Any') -> 'typing.Any': - """ - Returns type flags for the property - -Args: - - mask(typing.Any):Specifies which flags to retrieve (PDTF_*) - -Returns: - - typing.Any - - """ - pass - - - def GetViewFlags(self,) -> 'typing.Any': - """ - Returns the view flags that control how the property is displayed - -(PDVF_*) - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetDefaultColumnWidth(self,) -> 'typing.Any': - """ - Returns the default width in characters - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetDisplayType(self,) -> 'typing.Any': - """ - Returns the display type (PDDT_*) - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetColumnState(self,) -> 'typing.Any': - """ - Returns flags that control how property is displayed in column - -(SHCOLSTATE_*) - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetGroupingRange(self,) -> 'typing.Any': - """ - Returns property's grouping attributes (PDGR_*) - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetRelativeDescriptionType(self,) -> 'typing.Any': - """ - Returns the relative description type (PDRDT_*) - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetRelativeDescription(self,var1:'PyPROPVARIANT',var2:'PyPROPVARIANT') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Compares two values - -Args: - - var1(PyPROPVARIANT):The first value - var2(PyPROPVARIANT):The second value - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def GetSortDescription(self,) -> 'typing.Any': - """ - Returns value that determines how sorting options are - -displayed (PDSD_*) - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetSortDescriptionLabel(self,Descending:'typing.Any') -> 'typing.Any': - """ - Returns description of current sort order - -Args: - - Descending(typing.Any):Indicates if order is reversed - -Returns: - - typing.Any - - """ - pass - - - def GetAggregationType(self,) -> 'typing.Any': - """ - Describes how properties for multiple items are displayed - -(PDAT_*) - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetConditionType(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Returns options that determine how the property is used - -to build a search query - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any]:PyIPropertyDescription.GetConditionType - -(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 - -valid property range - -Args: - - riid(PyIID):IID of the requested interface - -Returns: - - PyIPropertyEnumTypeList - - """ - pass - - - def CoerceToCanonicalValue(self,Value:'PyPROPVARIANT') -> 'typing.Any': - """ - Converts a variant value to the exact type expected by - -the property - -Args: - - Value(PyPROPVARIANT):The property value to be convertedCommentsThis method mutates the PyPROPVARIANT in place. It may be cleared on failure.Return ValueReturns the HRESULT from the operation on success. - -Returns: - - typing.Any:The property value to be convertedComments - -This method mutates the PyPROPVARIANT in place. It may be cleared on failure. -Return ValueReturns the HRESULT from the operation on success. - - - """ - pass - - - def FormatForDisplay(self,Value:'PyPROPVARIANT',Flags:'typing.Any') -> 'typing.Any': - """ - Converts a value to its string representation - -Args: - - Value(PyPROPVARIANT):The value to be formatted - Flags(typing.Any):Combination of PROPDESC_FORMAT_FLAGS (PDFF_*) - -Returns: - - typing.Any - - """ - pass - - - def IsValueCanonical(self,Value:'typing.Any') -> 'typing.Any': - """ - Determines if a value exactly matches the specification for - -the property - -Args: - - Value(typing.Any):The value to check - -Returns: - - typing.Any - - """ - pass - - -class PyIPropertyDescriptionAliasInfo(object): - """Interface that gives access to the sorting columns for a property""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetSortByAlias(self,riid:'PyIID') -> 'PyIPropertyDescription': - """ - Returns the primary column used - -for sorting - -Args: - - riid(PyIID):The interface to return - -Returns: - - PyIPropertyDescription - - """ - pass - - - def GetAdditionalSortByAliases(self,riid:'PyIID') -> 'PyIPropertyDescriptionList': - """ - Returns secondary - -sorting columns - -Args: - - riid(PyIID):The interface to return - -Returns: - - PyIPropertyDescriptionList - - """ - pass - - -class PyIPropertyDescriptionList(object): - """Container for a number of property descriptions""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetCount(self,) -> 'typing.Any': - """ - Gets the number of properties in the list - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetAt(self,Elem:'typing.Any',riid:'PyIID') -> 'PyIPropertyDescription': - """ - Retrieves a description from the list - -Args: - - Elem(typing.Any):Index of the element to return - riid(PyIID):The interface to return - -Returns: - - PyIPropertyDescription - - """ - pass - - -class PyIPropertyDescriptionSearchInfo(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetSearchInfoFlags(self,) -> 'typing.Any': - """ - Returns flags controlling how property is indexed - -Args: - - - -Returns: - - typing.Any:PyIPropertyDescriptionSearchInfo.GetSearchInfoFlags - -int = GetSearchInfoFlags()Returns flags controlling how property is indexed -Return ValueReturns a combination of PROPDESC_SEARCHINFO_FLAGS values - - - """ - pass - - - def GetColumnIndexType(self,) -> 'typing.Any': - """ - Returns flags indicating type of property - -Args: - - - -Returns: - - typing.Any:PyIPropertyDescriptionSearchInfo.GetColumnIndexType - -int = GetColumnIndexType()Returns flags indicating type of property -Return ValueReturns a value from the PROPDESC_COLUMNINDEX_TYPE enum - - - """ - pass - - - def GetProjectionString(self,) -> 'typing.Any': - """ - Returns the canonical name of the property - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetMaxSize(self,) -> 'typing.Any': - """ - Returns the maximum size specified in search options - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyIPropertyEnumType(object): - """Contains information about an allowable value or range for a property""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetEnumType(self,) -> 'typing.Any': - """ - Retrieves the type (PROPENUMTYPE) - -Args: - - - -Returns: - - typing.Any:PyIPropertyEnumType.GetEnumType - -int = GetEnumType()Retrieves the type (PROPENUMTYPE) -Return Valuepscon.PET_* - - - """ - pass - - - def GetValue(self,) -> 'PyPROPVARIANT': - """ - Retrieves the defined value - -Args: - - - -Returns: - - PyPROPVARIANT - - """ - pass - - - def GetRangeMinValue(self,) -> 'PyPROPVARIANT': - """ - Returns the minimum allowed value for the property - -Args: - - - -Returns: - - PyPROPVARIANT - - """ - pass - - - def GetRangeSetValue(self,) -> 'PyPROPVARIANT': - """ - Returns a fixed value defined for the property - -Args: - - - -Returns: - - PyPROPVARIANT - - """ - pass - - - def GetDisplayText(self,) -> 'None': - """ - Returns the display text for the enumerated type - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIPropertyEnumTypeList(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetCount(self,) -> 'typing.Any': - """ - Returns the number of objects in the list - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetAt(self,itype:'typing.Any',riid:'PyIID') -> 'PyIPropertyEnumType': - """ - Retrieves an item by index - -Args: - - itype(typing.Any):Zero based index of type to return - riid(PyIID):The interface to return - -Returns: - - PyIPropertyEnumType - - """ - pass - - - def FindMatchingIndex(self,Cmp:'PyPROPVARIANT') -> 'typing.Any': - """ - Attempts to match the specified value to one of the allowable - -values for the property - -Args: - - Cmp(PyPROPVARIANT):A value to match against the defined values of the property - -Returns: - - typing.Any - - """ - pass - - -class PyIPropertySetStorage(object): - """Container for a collection of property sets. - -Can be iterated over to enumerate property sets.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Create(self,fmtid:'PyIID',clsid:'PyIID',Flags:'typing.Any',Mode:'typing.Any') -> 'PyIPropertyStorage': - """ - Creates a new property set in the storage object - -Args: - - fmtid(PyIID):GUID identifying a property set, pythoncom.FMTID_* - clsid(PyIID):CLSID of property set handler, usually same as fmtid - Flags(typing.Any):Specifies behaviour of property set, storagecon.PROPSETFLAG_* - Mode(typing.Any):Access mode, combination of storagecon.STGM_* flags - -Returns: - - PyIPropertyStorage - - """ - pass - - - def Open(self,fmtid:'PyIID',Mode:'typing.Any') -> 'PyIPropertyStorage': - """ - Opens an existing property set - -Args: - - fmtid(PyIID):GUID of a property set, pythoncom.FMTID_* - Mode(typing.Any):Access mode, combination of storagecon.STGM_* flags - -Returns: - - PyIPropertyStorage - - """ - pass - - - def Delete(self,fmtid:'PyIID') -> 'None': - """ - Removes a property set from this storage object - -Args: - - fmtid(PyIID):GUID of a property set, pythoncom.FMTID_* - -Returns: - - None - - """ - pass - - - def Enum(self,) -> 'PyIEnumSTATPROPSETSTG': - """ - Creates an iterator to enumerate contained property - -sets - -Args: - - - -Returns: - - PyIEnumSTATPROPSETSTG - - """ - pass - - -class PyIPropertyStorage(object): - """Structured storage object that contains a set of properties. - -Supports iteration to list properties.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ReadMultiple(self,props:'typing.Tuple[PROPSPEC, ...]') -> 'typing.Tuple[typing.Any, ...]': - """ - Reads specified properties from the current property set. - -Args: - - props(typing.Tuple[PROPSPEC, ...]):Sequence of property IDs or names.Return ValueReturned values are automatically converted to an appropriate python type - -Returns: - - typing.Tuple[typing.Any, ...]:Sequence of property IDs or names.Return ValueReturned values are automatically converted to an appropriate python type - - - """ - pass - - - def WriteMultiple(self,props:'typing.Tuple[PROPSPEC, ...]',values:'typing.Tuple[typing.Any, ...]',propidNameFirst:'typing.Any'=2) -> 'None': - """ - Creates or modifies properties in the property set - -Args: - - props(typing.Tuple[PROPSPEC, ...]):Sequence containing names or integer ids of properties to write - values(typing.Tuple[typing.Any, ...]):The values for the properties. - propidNameFirst(typing.Any):Minimum property id to be assigned to new properties specified by name - -Returns: - - None - - """ - pass - - - def DeleteMultiple(self,props:'typing.Tuple[PROPSPEC, ...]') -> 'None': - """ - Deletes properties from the property set - -Args: - - props(typing.Tuple[PROPSPEC, ...]):Sequence containing names or IDs of properties to be deleted - -Returns: - - None - - """ - pass - - - def ReadPropertyNames(self,props:'typing.Tuple[typing.Any, ...]') -> 'typing.Tuple[typing.Any, ...]': - """ - Retrieves any existing string names for the specified - -property identifiers. - -Args: - - props(typing.Tuple[typing.Any, ...]):Sequence of ints containing property IDs. - -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 - -current property set. - -Args: - - props(typing.Tuple[typing.Any, ...]):Sequence containing the property IDs. - names(typing.Tuple[str, ...]):Equal length sequence of property names. - -Returns: - - None - - """ - pass - - - def DeletePropertyNames(self,props:'typing.Tuple[typing.Any, ...]') -> 'None': - """ - Removes property names from specified properties. - -Args: - - props(typing.Tuple[typing.Any, ...]):Sequence of ints containing property IDs. - -Returns: - - None - - """ - pass - - - def Commit(self,CommitFlags:'typing.Any') -> 'None': - """ - Persists the property set to its base storage - -Args: - - CommitFlags(typing.Any):Combination of storagecon.STGC_* flags - -Returns: - - None - - """ - pass - - - def Revert(self,) -> 'None': - """ - Discards any changes that have been made - -Args: - - - -Returns: - - None - - """ - pass - - - def Enum(self,) -> 'PyIEnumSTATPROPSTG': - """ - Creates an enumerator for properties in the property set - -Args: - - - -Returns: - - PyIEnumSTATPROPSTG - - """ - pass - - - def SetTimes(self,ctime:'PyTime',atime:'PyTime',mtime:'PyTime') -> 'None': - """ - Sets the creation, last access, and modification time - -Args: - - ctime(PyTime):Creation time, or None for no change - atime(PyTime):Last access time, or None for no change - mtime(PyTime):Modification time, or None for no changeCommentsSome property sets do not support these times. - -Returns: - - None - - """ - pass - - - def SetClass(self,clsid:'PyIID') -> 'None': - """ - Sets the GUID for the property set - -Args: - - clsid(PyIID):Description for clsid - -Returns: - - None - - """ - pass - - - def Stat(self,) -> 'typing.Any': - """ - Returns various infomation about the property set - -Args: - - - -Returns: - - typing.Any:PyIPropertyStorage.Stat - -tuple = Stat()Returns various infomation about the property set -Return ValueReturns a tuple representing a STATPROPSETSTG struct. - - - """ - pass - - -class PyIPropertyStore(object): - """Contains a collection of properties""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetCount(self,) -> 'typing.Any': - """ - Returns the number of properties in the store - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetAt(self,iProp:'typing.Any') -> 'PyPROPERTYKEY': - """ - Returns the property key for the specified property - -Args: - - iProp(typing.Any):Zero-based index of property - -Returns: - - PyPROPERTYKEY - - """ - pass - - - def GetValue(self,Key:'PyPROPERTYKEY') -> 'PyPROPVARIANT': - """ - Retrieves the value of a property - -Args: - - Key(PyPROPERTYKEY):Property key as returned by PyIPropertyStore::GetAt - -Returns: - - PyPROPVARIANT - - """ - pass - - - def SetValue(self,Key:'PyPROPERTYKEY',Value:'PyPROPVARIANT') -> 'None': - """ - Sets the value of a property - -Args: - - Key(PyPROPERTYKEY):Property key (see PyIPropertyStore::GetAt) - Value(PyPROPVARIANT):Variant value which can be converted to the appropriate variant type for the property Pass a VT_EMPTY variant to indicate that the property should be removed. - -Returns: - - None - - """ - pass - - - def Commit(self,) -> 'None': - """ - Commits property changes - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIPropertyStoreCache(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetState(self,key:'PyPROPERTYKEY') -> 'typing.Any': - """ - Retrieves the current state of a property - -Args: - - key(PyPROPERTYKEY):Property identifierReturn ValueA value from the PSC_STATE enum (PSC_NORMAL, PSC_NOTINSOURCE. PSC_DIRTY) - -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 - -property - -Args: - - key(PyPROPERTYKEY):Property identifier - -Returns: - - typing.Tuple[PyPROPVARIANT, typing.Any] - - """ - pass - - - def SetState(self,key:'PyPROPERTYKEY',state:'typing.Any') -> 'None': - """ - Sets the state of a property - -Args: - - key(PyPROPERTYKEY):Property identifier - state(typing.Any):Value from the PSC_STATE enum (pscon.PSC_*) - -Returns: - - None - - """ - pass - - - def SetValueAndState(self,key:'PyPROPERTYKEY',value:'PyPROPVARIANT',state:'typing.Any') -> 'None': - """ - Sets the value and state of a property - -Args: - - key(PyPROPERTYKEY):Property identifier - value(PyPROPVARIANT):The new value - state(typing.Any):The new state (pscon.PSC_*) - -Returns: - - None - - """ - pass - - -class PyIPropertyStoreCapabilities(object): - """Property providers use this interface to indicate whether properties are - -writeable.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def IsPropertyWritable(self,key:'PyPROPERTYKEY') -> 'typing.Any': - """ - Asks provider if a property can be editted. - -Args: - - key(PyPROPERTYKEY):Property identifier - -Returns: - - typing.Any - - """ - pass - - -class PyIPropertySystem(object): - """Wraps the IPropertySystem interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPropertyDescription(self,Key:'PyPROPERTYKEY',riid:'PyIID') -> 'PyIPropertyDescription': - """ - Returns an interface used to describe a - -property - -Args: - - Key(PyPROPERTYKEY):Fmtid and propertyid that uniquely identifies a property - riid(PyIID):The interface to return - -Returns: - - PyIPropertyDescription - - """ - pass - - - def GetPropertyDescriptionByName(self,CanonicalName:'typing.Any',riid:'PyIID') -> 'PyIPropertyDescription': - """ - Returns an interface used to - -describe a property - -Args: - - CanonicalName(typing.Any):Registered name of the property - riid(PyIID):The interface to return - -Returns: - - PyIPropertyDescription - - """ - pass - - - def GetPropertyDescriptionListFromString(self,PropList:'typing.Any',riid:'PyIID') -> 'PyIPropertyDescriptionList': - """ - Retrieves property - -descriptions from a string of property names - -Args: - - PropList(typing.Any):String containing a list of properties and flags - riid(PyIID):The interface to return - -Returns: - - PyIPropertyDescriptionList - - """ - pass - - - def EnumeratePropertyDescriptions(self,Filter:'typing.Any',riid:'PyIID') -> 'PyIPropertyDescriptionList': - """ - Returns an interface used to - -list defined properties - -Args: - - Filter(typing.Any):Value from PROPDESC_ENUMFILTER (pscon.PDEF_*) that limits what types of properties are listed - riid(PyIID):The interface to return - -Returns: - - PyIPropertyDescriptionList - - """ - pass - - - def FormatForDisplay(self,Key:'PyPROPERTYKEY',Value:'PyPROPVARIANT',Flags:'typing.Any') -> 'typing.Any': - """ - Formats a property into a string - -Args: - - Key(PyPROPERTYKEY):Fmtid and property id that identifies the property - Value(PyPROPVARIANT):The value to format - Flags(typing.Any):Combination of PROPDESC_FORMAT_FLAGS (pscon.PDFF_*) indicating formatting options - -Returns: - - typing.Any - - """ - pass - - - def RegisterPropertySchema(self,Path:'typing.Any') -> 'None': - """ - Registers a set of properties defined in a .propdesc file - -Args: - - Path(typing.Any):Path to a property schema XML file (.propdesc) - -Returns: - - None - - """ - pass - - - def UnregisterPropertySchema(self,Path:'typing.Any') -> 'None': - """ - Removes a set of registered properties - -Args: - - Path(typing.Any):Path to a property schema XML file (.propdesc) - -Returns: - - None - - """ - pass - - - def RefreshPropertySchema(self,) -> 'None': - """ - Not currently implemented by the OS - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIProvideClassInfo(object): - """A Python interface to IProvideClassInfo""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetClassInfo(self,) -> 'PyITypeInfo': - """ - Gets information about the CO_CLASS. - -Args: - - - -Returns: - - PyITypeInfo - - """ - pass - - -class PyIProvideClassInfo2(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetGUID(self,flags:'typing.Any') -> 'PyIID': - """ - Gets the GUID for the object. - -Args: - - flags(typing.Any):The flags for the GUID. - -Returns: - - PyIID - - """ - pass - - -class PyIProvideExpressionContexts(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def EnumExpressionContexts(self,) -> 'None': - """ - Description of EnumStackFrames. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIProvideTaskPage(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPage(self,tpType:'typing.Any',PersistChanges:'typing.Any') -> 'None': - """ - Return a property sheet page handle for the spedified type - -(TASKPAGE_TASK,TASKPAGE_SCHEDULE,TASKPAGE_SETTINGS) - -Args: - - tpType(typing.Any):Type of page to retreive (TASKPAGE_TASK,TASKPAGE_SCHEDULE,TASKPAGE_SETTINGS) - PersistChanges(typing.Any):Indicates if changes should be saved automaticallyCommentsThere's not yet anything useful that can be done with this handle - return type subject to change - -Returns: - - None - - """ - pass - - -class PyIQueryAssociations(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - 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 - -appropriate ProgID. - -Args: - - flags(typing.Any):One of shellcon.ASSOCF_* flags - assoc(str):The string data (ie, extension, prog-id, etc) - hkeyProgId(PyHKEY):Root registry key, can be None - hwnd(int):Reserved, must be 0 or None - -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 - -registry. - -Args: - - flags(typing.Any):Used to control the search. - assocKey(typing.Any):Specifies the type of key that is to be returned. - arg(str):Optional string with information about the location of the key. It is normally set to a shell verb such as 'open'. Set this parameter to None if it is not used. - -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 - -registry. - -Args: - - flags(typing.Any):Used to control the search. - assocStr(typing.Any):Specifies the type of string that is to be returned. - arg(str):Optional string with information about the location of the key. It is normally set to a shell verb such as 'open'. Set this parameter to None if it is not used.CommentsNote that ASSOCF_NOTRUNCATE semantics are currently not supported - the buffer passed is 2048 bytes long, and will be truncated by the shell if too small. - -Returns: - - typing.Any - - """ - pass - - -class PyIRelatedItem(object): - """Interface used as the base for objects that have a related shell item - -(eg ITransferMediumItem, IDisplayItem, etc). Should not be used directly.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetItemIDList(self,) -> 'PyIDL': - """ - Returns the ID list of the related item - -Args: - - - -Returns: - - PyIDL - - """ - pass - - - def GetItem(self,) -> 'PyIShellItem': - """ - Returns the related item - -Args: - - - -Returns: - - PyIShellItem - - """ - pass - - -class PyIRemoteDebugApplication(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ResumeFromBreakPoint(self,prptFocus:'PyIRemoteDebugApplicationThread',bra:'typing.Any',era:'typing.Any') -> 'None': - """ - Continue an application which is currently in a breakpoint. - -Args: - - prptFocus(PyIRemoteDebugApplicationThread):Description for prptFocus - bra(typing.Any):Break resume action - era(typing.Any):Error resume action - -Returns: - - None - - """ - pass - - - def CauseBreak(self,) -> 'None': - """ - Causes the application to break into the debugger at the earliest - -opportunity. - -Args: - - - -Returns: - - None - - """ - pass - - - def ConnectDebugger(self,pad:'PyIApplicationDebugger') -> 'None': - """ - Connects a debugger to the application. - -Args: - - pad(PyIApplicationDebugger):Description for padCommentsOnly one debugger may be connected at a time; this method fails if there is already a debugger connected. - -Returns: - - None - - """ - pass - - - def DisconnectDebugger(self,) -> 'None': - """ - Disconnects the current debugger from the application. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDebugger(self,) -> 'PyIApplicationDebugger': - """ - Returns the current debugger connected to - -the application. - -Args: - - - -Returns: - - PyIApplicationDebugger - - """ - pass - - - def CreateInstanceAtApplication(self,rclsid:'PyIID',pUnkOuter:'PyIUnknown',dwClsContext:'typing.Any',riid:'PyIID') -> 'PyIUnknown': - """ - Create objects in the application - -process address space. - -Args: - - rclsid(PyIID):Description for rclsid - pUnkOuter(PyIUnknown):Description for pUnkOuter - dwClsContext(typing.Any):Description for dwClsContext - riid(PyIID):Description for riidCommentsProvides a mechanism for the debugger IDE, running out-of-process to the application, to create objects in the application process. This method simply delegates to CoCreateInstance. - -Returns: - - PyIUnknown - - """ - pass - - - def QueryAlive(self,) -> 'None': - """ - Returns True if alive, else False. - -Args: - - - -Returns: - - None - - """ - pass - - - def EnumThreads(self,) -> 'PyIEnumRemoteDebugApplicationThreads': - """ - Enumerates all threads known - -to be associated with the application. - -Args: - - - -Returns: - - PyIEnumRemoteDebugApplicationThreads - - """ - pass - - - def GetName(self,) -> 'None': - """ - Description of GetName. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetRootNode(self,) -> 'PyIDebugApplicationNode': - """ - Returns the application node under which - -all nodes associated with the application are added. - -Args: - - - -Returns: - - PyIDebugApplicationNode - - """ - pass - - - def EnumGlobalExpressionContexts(self,) -> 'typing.Any': - """ - Enumerates all - -global expression contexts - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyIRemoteDebugApplicationEvents(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OnConnectDebugger(self,pad:'PyIApplicationDebugger') -> 'None': - """ - Description of OnConnectDebugger. - -Args: - - pad(PyIApplicationDebugger):Description for pad - -Returns: - - None - - """ - pass - - - def OnDisconnectDebugger(self,) -> 'None': - """ - Description of OnDisconnectDebugger. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnSetName(self,pstrName:'typing.Any') -> 'None': - """ - Description of OnSetName. - -Args: - - pstrName(typing.Any):Description for pstrName - -Returns: - - None - - """ - pass - - - def OnDebugOutput(self,pstr:'typing.Any') -> 'None': - """ - Description of OnDebugOutput. - -Args: - - pstr(typing.Any):Description for pstr - -Returns: - - None - - """ - pass - - - def OnClose(self,) -> 'None': - """ - Description of OnClose. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnEnterBreakPoint(self,prdat:'PyIRemoteDebugApplicationThread') -> 'None': - """ - Description of OnEnterBreakPoint. - -Args: - - prdat(PyIRemoteDebugApplicationThread):Description for prdat - -Returns: - - None - - """ - pass - - - def OnLeaveBreakPoint(self,prdat:'PyIRemoteDebugApplicationThread') -> 'None': - """ - Description of OnLeaveBreakPoint. - -Args: - - prdat(PyIRemoteDebugApplicationThread):Description for prdat - -Returns: - - None - - """ - pass - - - def OnCreateThread(self,prdat:'PyIRemoteDebugApplicationThread') -> 'None': - """ - Description of OnCreateThread. - -Args: - - prdat(PyIRemoteDebugApplicationThread):Description for prdat - -Returns: - - None - - """ - pass - - - def OnDestroyThread(self,prdat:'PyIRemoteDebugApplicationThread') -> 'None': - """ - Description of OnDestroyThread. - -Args: - - prdat(PyIRemoteDebugApplicationThread):Description for prdat - -Returns: - - None - - """ - pass - - - def OnBreakFlagChange(self,abf:'typing.Any',prdatSteppingThread:'PyIRemoteDebugApplicationThread') -> 'None': - """ - Description of OnBreakFlagChange. - -Args: - - abf(typing.Any):Description for abf - prdatSteppingThread(PyIRemoteDebugApplicationThread):Description for prdatSteppingThread - -Returns: - - None - - """ - pass - - -class PyIRemoteDebugApplicationThread(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetSystemThreadId(self,) -> 'None': - """ - Description of GetSystemThreadId. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetApplication(self,) -> 'None': - """ - Description of GetApplication. - -Args: - - - -Returns: - - None - - """ - pass - - - def EnumStackFrames(self,) -> 'None': - """ - Description of EnumStackFrames. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDescription(self,) -> 'None': - """ - Description of GetDescription. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetNextStatement(self,pStackFrame:'PyIDebugStackFrame',pCodeContext:'PyIDebugCodeContext') -> 'None': - """ - Description of SetNextStatement. - -Args: - - pStackFrame(PyIDebugStackFrame):Description for pStackFrame - pCodeContext(PyIDebugCodeContext):Description for pCodeContext - -Returns: - - None - - """ - pass - - - def GetState(self,) -> 'None': - """ - Description of GetState. - -Args: - - - -Returns: - - None - - """ - pass - - - def Suspend(self,) -> 'None': - """ - Description of Suspend. - -Args: - - - -Returns: - - None - - """ - pass - - - def Resume(self,) -> 'None': - """ - Description of Resume. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetSuspendCount(self,) -> 'None': - """ - Description of GetSuspendCount. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIRunningObjectTable(object): - """A Python interface to IRunningObjectTable""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Register(self,) -> 'typing.Any': - """ - Registers an object and its identifying moniker in the Running Object - -Table (ROT). - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def Revoke(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def IsRunning(self,objectName:'PyIMoniker') -> 'typing.Any': - """ - Checks whether an object is running. - -Args: - - objectName(PyIMoniker):The PyIMoniker interface on the moniker to search for in the Running Object Table.Return ValueDescriptionS_OK (ie, 0)The object identified by objectName is running.S_FALSE (ie, 1)There is no entry for objectName in the ROT, or that the object it identifies is no longer running (in which case, the entry is revoked). - -Returns: - - typing.Any - - """ - pass - - - def GetObject(self,objectName:'PyIMoniker') -> 'PyIUnknown': - """ - Checks whether an object is running. - -Args: - - objectName(PyIMoniker):The PyIMoniker interface on the moniker to search for in the Running Object Table. - -Returns: - - PyIUnknown - - """ - pass - - - def EnumRunning(self,) -> 'PyIEnumMoniker': - """ - Creates an enumerator that can list the monikers of - -all the objects currently registered in the Running Object Table (ROT). - -Args: - - - -Returns: - - PyIEnumMoniker - - """ - pass - - -class PyIScheduledWorkItem(object): - """Python object that encapsulates the IScheduledWorkItem interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateTrigger(self,) -> 'typing.Tuple[typing.Any, PyITaskTrigger]': - """ - Creates a new trigger for a task, returns index and - -new ITaskTrigger interface - -Args: - - - -Returns: - - typing.Tuple[typing.Any, PyITaskTrigger] - - """ - pass - - - def DeleteTrigger(self,Trigger:'typing.Any') -> 'None': - """ - Deletes specified trigger - -Args: - - Trigger(typing.Any):Index of trigger to delete - -Returns: - - None - - """ - pass - - - def GetTriggerCount(self,) -> 'typing.Any': - """ - Returns number of triggers defined for the task - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetTrigger(self,iTrigger:'typing.Any') -> 'PyITaskTrigger': - """ - Retrieves ITaskTrigger interface for specified trigger - -index - -Args: - - iTrigger(typing.Any):Index of trigger to retrieve - -Returns: - - PyITaskTrigger - - """ - pass - - - def GetTriggerString(self,) -> 'typing.Any': - """ - Creates a human-readable summary of specified trigger - -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 - -frame - -Args: - - Count(typing.Any):Number of run times to retrieve - Begin(PyTime):Start time, defaults to current time if not passed or None - End(PyTime):End time, defaults to unlimited if not passed or None - -Returns: - - typing.Tuple[PyTime, typing.Any, typing.Any, typing.Any] - - """ - pass - - - def GetNextRunTime(self,) -> 'PyTime': - """ - Returns next time that task is scheduled to run - -Args: - - - -Returns: - - PyTime - - """ - pass - - - def SetIdleWait(self,wIdleMinutes:'typing.Any',wDeadlineMinutes:'typing.Any') -> 'None': - """ - Sets idle parms for task with trigger of type TASK_EVENT_TRIGGER_ON_IDLE - -Args: - - wIdleMinutes(typing.Any):Nbr of minutes computer must be idle before task fires - wDeadlineMinutes(typing.Any):Maximum nbr of minutes task will wait for computer to become idle - -Returns: - - None - - """ - pass - - - def GetIdleWait(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Gets IdleMinutes and DeadlineMinutes parms for task with trigger - -of type TASK_EVENT_TRIGGER_ON_IDLE - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def Run(self,) -> 'None': - """ - Starts task - -Args: - - - -Returns: - - None - - """ - pass - - - def Terminate(self,) -> 'None': - """ - Terminate process if task is running - -Args: - - - -Returns: - - None - - """ - pass - - - def EditWorkItem(self,hParent:'int',dwReserved:'typing.Any') -> 'None': - """ - Brings up standard Scheduled Task dialog - -Args: - - hParent(int):Reserved, use 0 or None if passed - dwReserved(typing.Any):Reserved, use 0 if passed - -Returns: - - None - - """ - pass - - - def GetMostRecentRunTime(self,) -> 'PyTime': - """ - Returns last time task ran - -Args: - - - -Returns: - - PyTime - - """ - pass - - - def GetStatus(self,) -> 'typing.Any': - """ - Returns status (SCHED_S_TASK... constants) - -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 - -Scheduler if process could not start - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def SetComment(self,Comment:'typing.Any') -> 'None': - """ - Set comment string for task - -Args: - - Comment(typing.Any):Freeform comment string - -Returns: - - None - - """ - pass - - - def GetComment(self,) -> 'str': - """ - Return comment string associated with task. - -Args: - - - -Returns: - - str - - """ - pass - - - def SetCreator(self,Creator:'typing.Any') -> 'None': - """ - Specify who (or what) created task, can be any string - -Args: - - Creator(typing.Any):Originator of task, does not have to be valid username - -Returns: - - None - - """ - pass - - - def GetCreator(self,) -> 'None': - """ - Returns creator info, can be any string data - -Args: - - - -Returns: - - None - - """ - pass - - - def SetWorkItemData(self,Data:'str') -> 'None': - """ - Set data associated with task (treated as uninterpreted bytes) - -Args: - - Data(str):Character data, treated as uninterpreted bytes - -Returns: - - None - - """ - pass - - - def GetWorkItemData(self,) -> 'str': - """ - Retrieve data associated with task - -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 - -currently implemented) - -Args: - - wRetryCount(typing.Any):Nbr of attemps to start task - -Returns: - - None - - """ - pass - - - def GetErrorRetryCount(self,) -> 'None': - """ - Return nbr of times Task scheduler should try to run task (not - -currently implemented) - -Args: - - - -Returns: - - None - - """ - pass - - - def SetErrorRetryInterval(self,RetryInterval:'typing.Any') -> 'None': - """ - Interval in minutes between attempts to run task. Not - -implemented according to SDK - -Args: - - RetryInterval(typing.Any):Interval in minutes - -Returns: - - None - - """ - pass - - - def GetErrorRetryInterval(self,) -> 'None': - """ - Returns nbr of minutes between attempts to run task. Not - -implemented according to SDK - -Args: - - - -Returns: - - None - - """ - pass - - - def SetFlags(self,dwFlags:'typing.Any') -> 'None': - """ - Set flags for task - -Args: - - dwFlags(typing.Any):Combination of TASK_FLAG_* constants - -Returns: - - None - - """ - pass - - - def GetFlags(self,) -> 'typing.Any': - """ - Returns flags for task (TASK_FLAG_* constants) - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetAccountInformation(self,AccountName:'typing.Any',Password:'typing.Any') -> 'None': - """ - Set username and password under which task will run - -Args: - - AccountName(typing.Any):AccountName, use "" for local system account (can only be used by Administrators) - Password(typing.Any):Password - Can be None for local System account, or if TASK_FLAG_RUN_ONLY_IF_LOGGED_ON is setCommentsOn some systems, username and password are verified at the time the task is saved, on others when the task tries to run - -Returns: - - None - - """ - pass - - - def GetAccountInformation(self,) -> 'typing.Any': - """ - Returns username that task will run under - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyIServerSecurity(object): - """Interface used to access client security settings and perform impersonation""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def QueryBlanket(self,Capabilities:'typing.Any'=0) -> 'typing.Any': - """ - Retrieves security settings specified by the client - -Args: - - Capabilities(typing.Any):Can be EOAC_MAKE_FULLSIC for SChannel provider - -Returns: - - typing.Any - - """ - pass - - - def ImpersonateClient(self,) -> 'None': - """ - Initiates impersonation of client - -Args: - - - -Returns: - - None - - """ - pass - - - def RevertToSelf(self,) -> 'None': - """ - Ends impersonation of client - -Args: - - - -Returns: - - None - - """ - pass - - - def IsImpersonating(self,) -> 'typing.Any': - """ - Determines if server is currently impersonating a client - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyIServiceProvider(object): - """A Python interface to IServiceProvider""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def QueryService(self,clsid:'PyIID',iid:'PyIID') -> 'PyIUnknown': - """ - Creates or accesses the specified service and returns an - -interface object to the specified interface for the service. - -Args: - - clsid(PyIID):Unique identifier for the requested service. - iid(PyIID):Unique identifier for the requested interface on the service. - -Returns: - - PyIUnknown - - """ - pass - - -class PyIShellBrowser(object): - """Exposed by Windows Explorer and the Open File common dialog box to provide services for - -namespace extensions.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def InsertMenusSB(self,hmenuShared:'int',lpMenuWidths:'PyOLEMENUGROUPWIDTHS') -> 'PyOLEMENUGROUPWIDTHS': - """ - Updates a composite menu with container's options - -Args: - - hmenuShared(int):Newly created menu that contains no items - lpMenuWidths(PyOLEMENUGROUPWIDTHS):Tuple of 6 ints. Items 0,2,and 4 are updated when the tuple is returned. - -Returns: - - PyOLEMENUGROUPWIDTHS - - """ - pass - - - def SetMenuSB(self,hmenuShared:'int',holemenuRes:'int',hwndActiveObject:'int') -> 'None': - """ - Attaches a shared menu to a shell view window - -Args: - - hmenuShared(int):Handle to the shared menu - holemenuRes(int):Reserved, use only None (or 0) - hwndActiveObject(int):Handle to the shell window - -Returns: - - None - - """ - pass - - - def RemoveMenusSB(self,hmenuShared:'int') -> 'None': - """ - Asks container to remove any items it added to a composite menu - -Args: - - hmenuShared(int):Handle to the composite menu - -Returns: - - None - - """ - pass - - - def SetStatusTextSB(self,pszStatusText:'typing.Any') -> 'None': - """ - Sets the status text in view's status bar - -Args: - - pszStatusText(typing.Any):New status to be displayed - -Returns: - - None - - """ - pass - - - def EnableModelessSB(self,fEnable:'typing.Any') -> 'None': - """ - Enables or disables modeless dialogs - -Args: - - fEnable(typing.Any):Use True to enable or False to disable modeless dialog boxes - -Returns: - - None - - """ - pass - - - def TranslateAcceleratorSB(self,pmsg:'PyMSG',wID:'typing.Any') -> 'None': - """ - Translates keystrokes used as menu item activators - -Args: - - pmsg(PyMSG):Keystroke message to be translated - wID(typing.Any):Menu command id for the keystroke - -Returns: - - None - - """ - pass - - - def BrowseObject(self,pidl:'PyIDL',wFlags:'typing.Any') -> 'None': - """ - Navigates to a different location - -Args: - - pidl(PyIDL):Item id list that specifies the new browse location, can be None - wFlags(typing.Any):Combination of shellcon.SBSP_* flags - -Returns: - - None - - """ - pass - - - def GetViewStateStream(self,grfMode:'typing.Any') -> 'PyIStream': - """ - Returns a stream that can be used to access view state - -information - -Args: - - grfMode(typing.Any):Read/write mode, one of STGM_READ,STGM_WRITE,STGM_READWRITE - -Returns: - - PyIStream - - """ - pass - - - def GetControlWindow(self,_id:'typing.Any') -> 'None': - """ - Returns a handle to one of the browser's control elements - -Args: - - _id(typing.Any):One of shellcon.FCW_* values - -Returns: - - None - - """ - pass - - - def SendControlMsg(self,_id:'typing.Any',uMsg:'typing.Any',wParam:'typing.Any',lParam:'typing.Any') -> 'typing.Any': - """ - Sends a control msg to browser's toolbar or status bar - -Args: - - _id(typing.Any):shellcon.FCW_TOOLBAR or FCW_STATUS - uMsg(typing.Any):The message to send - wParam(typing.Any):Value is dependent on the message - lParam(typing.Any):Value is dependent on the message - -Returns: - - typing.Any - - """ - pass - - - def QueryActiveShellView(self,) -> 'PyIShellView': - """ - Returns the currently displayed view - -Args: - - - -Returns: - - PyIShellView - - """ - pass - - - def OnViewWindowActive(self,pshv:'PyIShellView') -> 'None': - """ - Callback triggered when a view window is activated - -Args: - - pshv(PyIShellView):The activated view object - -Returns: - - None - - """ - pass - - - def SetToolbarItems(self,lpButtons:'typing.Any',uFlags:'typing.Any') -> 'None': - """ - Adds toolbar buttons to the browser's toolbar - -Args: - - lpButtons(typing.Any):Sequence of tuples describing the buttons to be added - uFlags(typing.Any):Indicates button positions, combination of shellcon.FCT_* - -Returns: - - None - - """ - pass - - -class PyIShellExtInit(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Initialize(self,pFolder:'PyIDL',pDataObject:'PyIDataObject',hkey:'int') -> 'None': - """ - Description of Initialize. - -Args: - - pFolder(PyIDL):Description for pFolder - pDataObject(PyIDataObject):Description for pDataObject - hkey(int):Description for hkey - -Returns: - - None - - """ - pass - - -class PyIShellFolder(object): - """Interface that represents an Explorer folder""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ParseDisplayName(self,hwndOwner:'int',pbc:'PyIBindCtx',DisplayName:'typing.Any',Attributes:'typing.Any'=0) -> 'typing.Any': - """ - Returns the PIDL of an item in a shell folder - -Args: - - hwndOwner(int):Window in which to display any dialogs or message boxes, can be 0 - pbc(PyIBindCtx):Bind context that affects how parsing is performed, can be None - DisplayName(typing.Any):Display name to parse, format is dependent on the shell folder. Desktop folder will accept a file path, as well as guids of the form ::{guid} Example: '::%s\\::%s' %(shell.CLSID_MyComputer,shell.CLSID_ControlPanel) - Attributes(typing.Any):Combination of shellcon.SFGAO_* constants specifying which attributes should be returnedReturn ValueThe result is a tuple of cchEaten, pidl, attrItems[0] int : cchEatenthe number of characters of the input name that were parsed[1] PyIDL : pidlspecifies the relative path from the parsing folder to the object[2] int : Attributesreturns any requested attributes - -Returns: - - typing.Any:Combination of shellcon.SFGAO_* constants specifying which attributes should be returned -Return ValueThe result is a tuple of cchEaten, pidl, attr -Items[0] int : cchEaten -the number of characters of the input name that were parsed -[1] PyIDL : pidl -specifies the relative path from the parsing folder to the object -[2] int : Attributes -returns any requested attributes - - - """ - pass - - - def EnumObjects(self,grfFlags:'typing.Any',hwndOwner:'int'=None) -> 'PyIEnumIDList': - """ - Creates an enumerator to list the contents of the shell folder - -Args: - - grfFlags(typing.Any):Combination of shellcon.SHCONTF_* constants - hwndOwner(int):Window to use if any user interaction is required - -Returns: - - PyIEnumIDList - - """ - pass - - - def BindToObject(self,pidl:'PyIDL',pbc:'PyIBindCtx',riid:'PyIID') -> 'PyIShellFolder': - """ - Returns an IShellFolder interface for a subfolder - -Args: - - pidl(PyIDL):Relative item id list that identifies the subfolder, can be multi-level - pbc(PyIBindCtx):Bind context to be used, can be None - riid(PyIID):IID of the desired interface, usually IID_IShellFolder - -Returns: - - PyIShellFolder - - """ - pass - - - def BindToStorage(self,pidl:'PyIDL',pbc:'PyIBindCtx',riid:'PyIID') -> 'typing.Any': - """ - Returns an interface to a storage object in a shell folder - -Args: - - pidl(PyIDL):Relative pidl for the folder item, must be a single item id - pbc(PyIBindCtx):Bind context that affects how binding is performed, can be None - riid(PyIID):IID of the desired interface, one of IID_IStream, IID_IStorage, IID_IPropertySetStorageReturn ValueReturns PyIStream, PyIStorage or PyIPropertySetStorage depending on the riid passed in - -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 - - - def CompareIDs(self,lparam:'typing.Any',pidl1:'PyIDL',pidl2:'PyIDL') -> 'typing.Any': - """ - Determines the sorting order of 2 items in shell folder - -Args: - - lparam(typing.Any):Lower 16 bits specify folder-dependent sorting rules, 0 means to sort by display name. System folder view uses these as a column number. Upper sixteen bits is used for flags SHCIDS_ALLFIELDS or SHCIDS_CANONICALONLY - pidl1(PyIDL):Item id list that idenfies an object relative to the folder - pidl2(PyIDL):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 - -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 - - - def CreateViewObject(self,hwndOwner:'typing.Any',riid:'PyIID') -> 'PyIShellView': - """ - Creates a view object for a shell folder. - -Args: - - hwndOwner(typing.Any):Parent window for a custom folder view, or 0 - riid(PyIID):IID of the desired interface, usually IID_IShellView - -Returns: - - PyIShellView - - """ - pass - - - def GetAttributesOf(self,pidl:'typing.Tuple[PyIDL, ...]',rgfInOut:'typing.Any') -> 'typing.Any': - """ - Queries attributes of items within the shell folder - -Args: - - pidl(typing.Tuple[PyIDL, ...]):A sequence of single-level pidls identifying items directly contained by the folder - rgfInOut(typing.Any):Combination of shellcon.SFGAO_* constantsReturn ValueThe requested attributes are only returned if they are common to all of the specified items - -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 - -folder - -Args: - - hwndOwner(int):Specifies a window in which to display any required dialogs or errors, can be 0 - pidl(typing.Tuple[PyIDL, ...]):A sequence of single-level pidls identifying items in the folder - riid(PyIID):The interface to create, one of IID_IContextMenu, IID_IContextMenu2, IID_IDataObject, IID_IDropTarget, IID_IExtractIcon, IID_IQueryInfo - iidout(PyIID):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 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 - Reserved(typing.Any):Reserved, use 0 if passed in - -Returns: - - 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 - -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 - - - def GetDisplayNameOf(self,pidl:'PyIDL',uFlags:'typing.Any') -> 'typing.Any': - """ - Returns the display name of an item within this shell folder - -Args: - - pidl(PyIDL):PIDL that identifies the item relative to the parent folder - uFlags(typing.Any):Combination of shellcon.SHGDN_* flags - -Returns: - - typing.Any - - """ - pass - - - def SetNameOf(self,hwndOwner:'typing.Any',pidl:'PyIDL',Name:'typing.Any',Flags:'typing.Any') -> 'PyIDL': - """ - Sets the display name of an item and changes its PIDL - -Args: - - hwndOwner(typing.Any):Window in which to display any message boxes or dialogs, can be 0 - pidl(PyIDL):PIDL that identifies the item relative to the parent folder - Name(typing.Any):New name for the item - Flags(typing.Any):Combination of shellcon.SHGDM_* valuesReturn ValueReturns the new PIDL for item - -Returns: - - PyIDL:Combination of shellcon.SHGDM_* valuesReturn ValueReturns the new PIDL for item - - - """ - pass - - -class PyIShellFolder2(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDefaultSearchGUID(self,pguid:'PyIID') -> 'PyIID': - """ - Retrieves the default search for the folder - -Args: - - pguid(PyIID):Description for pguid - -Returns: - - PyIID - - """ - pass - - - def EnumSearches(self,) -> 'typing.Any': - """ - Returns an interface that lists searches defined for - -the folder - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetDefaultColumn(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Returns the columns used for sorting and display - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def GetDefaultColumnState(self,iColumn:'typing.Any') -> 'typing.Any': - """ - Returns flags indicating the default behaviour of the column - -Args: - - iColumn(typing.Any):Zero-based index of the columnReturn ValueReturns a combination of shellcon.SHCOLSTATE_* flags - -Returns: - - typing.Any:Zero-based index of the columnReturn ValueReturns a combination of shellcon.SHCOLSTATE_* flags - - - """ - pass - - - def GetDetailsEx(self,pidl:'PyIDL',pscid:'typing.Any') -> 'typing.Any': - """ - Returns the details of an item by Column ID - -Args: - - pidl(PyIDL):Relative id list of an item in the folder - pscid(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 - -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 - -view. - -Args: - - pidl(PyIDL):The relative idl of an item in the folder. Use None to retrieve column title. - iColumn(typing.Any):Zero based index of columnReturn ValueReturns a tuple representing a SHELLDETAILS struct, containing the formst (LVCFMT_*), column width in characters, and string representation of the requested value - -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 - -characters, - -and string representation of the requested value - - - """ - pass - - - def MapColumnToSCID(self,Column:'typing.Any') -> 'typing.Any': - """ - Returns the unique identifier (FMTID, pid) of a column - -Args: - - Column(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. - -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. - -For Vista and later, this is the Property Key used with the property system interfaces. - - - """ - pass - - -class PyIShellIcon(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetIconOf(self,pidl:'PyIDL') -> 'None': - """ - Description of GetIconOf. - -Args: - - pidl(PyIDL):Description for pidl - -Returns: - - None - - """ - pass - - -class PyIShellIconOverlay(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetOverlayIndex(self,pidl:'PyIDL') -> 'None': - """ - Description of GetOverlayIndex. - -Args: - - pidl(PyIDL):Description for pidl - -Returns: - - None - - """ - pass - - - def GetOverlayIconIndex(self,pidl:'PyIDL') -> 'None': - """ - Description of GetOverlayIconIndex. - -Args: - - pidl(PyIDL):Description for pidl - -Returns: - - None - - """ - pass - - -class PyIShellIconOverlayIdentifier(object): - """Interface that supplies icon overlay information to the shell""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def IsMemberOf(self,path:'str',attrib:'typing.Any') -> 'typing.Any': - """ - Determines if a shell object should have an icon overlay - -Args: - - path(str):Fully qualified path of the shell object - attrib(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. 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. - -Returns: - - 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. - -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 - -icon - -Args: - - - -Returns: - - typing.Tuple[str, typing.Any, typing.Any]:PyIShellIconOverlayIdentifier.GetOverlayInfo - -(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 - -combination of shellcon.ISIOI_ICON* flags - - - """ - pass - - - def GetPriority(self,) -> 'typing.Any': - """ - Retrieves the relative priority of the overlay - -Args: - - - -Returns: - - typing.Any:PyIShellIconOverlayIdentifier.GetPriority - -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 - - -class PyIShellIconOverlayManager(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - 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 - -image or overlay image - -Args: - - path(typing.Any):Full path to the file - attrib(typing.Any):File attributes (win32com.FILE_ATTRIBUTE_*) - flags(typing.Any):SIOM_OVERLAYINDEX (1) or SIOM_ICONINDEX (2) - -Returns: - - typing.Any - - """ - pass - - - def GetReservedOverlayInfo(self,path:'typing.Any',attrib:'typing.Any',flags:'typing.Any',ireservedID:'typing.Any') -> 'None': - """ - Description of GetReservedOverlayInfo. - -Args: - - path(typing.Any):Description for path - attrib(typing.Any):Description for attrib - flags(typing.Any):Description for flags - ireservedID(typing.Any):Description for ireservedID - -Returns: - - None - - """ - pass - - - def RefreshOverlayImages(self,flags:'typing.Any') -> 'None': - """ - Description of RefreshOverlayImages. - -Args: - - flags(typing.Any):Description for flags - -Returns: - - None - - """ - pass - - - def LoadNonloadedOverlayIdentifiers(self,) -> 'None': - """ - Description of LoadNonloadedOverlayIdentifiers. - -Args: - - - -Returns: - - None - - """ - pass - - - def OverlayIndexFromImageIndex(self,iImage:'typing.Any',fAdd:'typing.Any') -> 'None': - """ - Description of OverlayIndexFromImageIndex. - -Args: - - iImage(typing.Any):Description for iImage - fAdd(typing.Any):Description for fAdd - -Returns: - - None - - """ - pass - - -class PyIShellItem(object): - """Interface that represents an item in the Explorer shell""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def BindToHandler(self,pbc:'PyIBindCtx',bhid:'PyIID',riid:'PyIID') -> 'typing.Any': - """ - Creates an instance of one of the item's handlers - -Args: - - pbc(PyIBindCtx):Used to pass parameters that influence the binding operation, can be None - bhid(PyIID):GUID that identifies a handler (shell.BHID_*) - riid(PyIID):The interface to return - -Returns: - - typing.Any - - """ - pass - - - def GetParent(self,) -> 'PyIShellItem': - """ - Retrieves the parent of this item - -Args: - - - -Returns: - - PyIShellItem - - """ - pass - - - def GetDisplayName(self,sigdnName:'typing.Any') -> 'typing.Any': - """ - Returns the display name of the item in the specified format - -Args: - - sigdnName(typing.Any):Format of name to return, shellcon.SIGDN_* - -Returns: - - typing.Any - - """ - pass - - - def GetAttributes(self,Mask:'typing.Any') -> 'typing.Any': - """ - Returns shell attributes of the item - -Args: - - Mask(typing.Any):Combination of shellcon.SFGAO_* values indicating the flags to returnReturn ValueReturns a combination of shellcon.SFGAO_* values - -Returns: - - typing.Any:Combination of shellcon.SFGAO_* values indicating the flags to returnReturn ValueReturns a combination of shellcon.SFGAO_* values - - - """ - pass - - - def Compare(self,psi:'PyIShellItem',hint:'typing.Any') -> 'typing.Any': - """ - Compares another shell item with this item - -Args: - - psi(PyIShellItem):A shell item to be compared with this item - hint(typing.Any):shellcon.SICHINT_* value indicating how the comparison is to be performedReturn ValueReturns 0 if items compare as equal, nonzero otherwise - -Returns: - - typing.Any:shellcon.SICHINT_* value indicating how the comparison is to be performedReturn ValueReturns 0 if items compare as equal, nonzero otherwise - - - """ - pass - - -class PyIShellItem2(object): - """Extends the IShellItem interface, giving access to an item's properties""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPropertyStore(self,Flags:'typing.Any',riid:'PyIID') -> 'PyIPropertyStore': - """ - Returns a collection of the item's properties - -Args: - - Flags(typing.Any):Combination of GETPROPERTYSTOREFLAGS values (shellcon.GPS_*) - riid(PyIID):The interface to return - -Returns: - - PyIPropertyStore - - """ - pass - - - def GetPropertyStoreForKeys(self,Keys:'typing.Tuple[typing.Any, ...]',Flags:'typing.Any',riid:'PyIID') -> 'PyIPropertyStore': - """ - Creates a property store containing just the - -specified properties of the item - -Args: - - Keys(typing.Tuple[typing.Any, ...]):A sequence of property identifiers - Flags(typing.Any):Combination of GETPROPERTYSTOREFLAGS values (shellcon.GPS_*) - riid(PyIID):The interface to return - -Returns: - - PyIPropertyStore - - """ - pass - - - def GetPropertyStoreWithCreateObject(self,Flags:'typing.Any',CreateObject:'PyIUnknown',riid:'PyIID') -> 'PyIPropertyStore': - """ - Returns the property store for the - -item, with alternate handler instantiation - -Args: - - Flags(typing.Any):Combination of GETPROPERTYSTOREFLAGS values (shellcon.GPS_*) - CreateObject(PyIUnknown):An interface that implements ICreateObject, used to create the property handler - riid(PyIID):The interface to be createdCommentsPrimarily used to create a handler in a separate process with reduced privileges - -Returns: - - PyIPropertyStore - - """ - pass - - - def GetPropertyDescriptionList(self,Type:'PyPROPERTYKEY',riid:'PyIID') -> 'PyIPropertyDescriptionList': - """ - Retrieves descriptions of - -properties in a particular group - -Args: - - Type(PyPROPERTYKEY):Property list identifier (pscon.PKEY_PropList_*) - riid(PyIID):The interface to return - -Returns: - - PyIPropertyDescriptionList - - """ - pass - - - def Update(self,BindCtx:'typing.Any'=None) -> 'None': - """ - Refreshes properties that have been modified since interface was created - -Args: - - BindCtx(typing.Any):Bind context used when requesting the interface, or None - -Returns: - - None - - """ - pass - - - def GetProperty(self,key:'PyPROPERTYKEY') -> 'typing.Any': - """ - Retrieves the value of a property, converted to an appropriate python type - -Args: - - key(PyPROPERTYKEY):The id of the property to retrieveReturn ValueType of returned object is determined by the variant type of the property - -Returns: - - typing.Any:The id of the property to retrieveReturn ValueType of returned object is determined by the variant type of the property - - - """ - pass - - - def GetCLSID(self,key:'PyPROPERTYKEY') -> 'PyIID': - """ - Retrieves the value of a property as a CLSID (VT_CLSID) - -Args: - - key(PyPROPERTYKEY):The id of the property to retrieve - -Returns: - - PyIID - - """ - pass - - - def GetFileTime(self,key:'PyPROPERTYKEY') -> 'PyTime': - """ - Retrieves the value of a property as a FILETIME - -Args: - - key(PyPROPERTYKEY):The id of the property to retrieve - -Returns: - - PyTime - - """ - pass - - - def GetInt32(self,key:'PyPROPERTYKEY') -> 'typing.Any': - """ - Retrieves the value of a property as a 32 bit int. - -Args: - - key(PyPROPERTYKEY):The id of the property to retrieve - -Returns: - - typing.Any - - """ - pass - - - def GetString(self,key:'PyPROPERTYKEY') -> 'typing.Any': - """ - Retrieves the value of a property as a string - -Args: - - key(PyPROPERTYKEY):The id of the property to retrieve - -Returns: - - typing.Any - - """ - pass - - - def GetUInt32(self,key:'PyPROPERTYKEY') -> 'typing.Any': - """ - Returns the value of a property as a 32 bit unsigned int - -Args: - - key(PyPROPERTYKEY):The id of the property to retrieve - -Returns: - - typing.Any - - """ - pass - - - def GetUInt64(self,key:'PyPROPERTYKEY') -> 'typing.Any': - """ - Returns the value of a property as an unsigned 64-bit int - -Args: - - key(PyPROPERTYKEY):The id of the property to retrieve - -Returns: - - typing.Any - - """ - pass - - - def GetBool(self,key:'PyPROPERTYKEY') -> 'typing.Any': - """ - Returns the value of a property as a boolean - -Args: - - key(PyPROPERTYKEY):The id of the property to retrieve - -Returns: - - typing.Any - - """ - pass - - -class PyIShellItemArray(object): - """Container for a number of shell items""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def BindToHandler(self,pbc:'PyIBindCtx',rbhid:'PyIID',riid:'PyIID') -> 'typing.Any': - """ - Creates an instance of a handler for the items in the container - -Args: - - pbc(PyIBindCtx):Bind context, can be None - rbhid(PyIID):Bind handler GUID (shell.BHID_*) - riid(PyIID):The interface to return - -Returns: - - typing.Any - - """ - pass - - - def GetPropertyStore(self,flags:'typing.Any',riid:'PyIID') -> 'PyIPropertyStore': - """ - Retrieves a store containing consolidated - -properties of items in container - -Args: - - flags(typing.Any):Flags indicating how the properties are retrieved (shellcon.GPS_*) - riid(PyIID):The interface to return, IID_IPropertyStore or related interface - -Returns: - - PyIPropertyStore - - """ - pass - - - def GetPropertyDescriptionList(self,Type:'PyPROPERTYKEY',riid:'PyIID') -> 'PyIPropertyDescriptionList': - """ - Retrieves descriptions for a - -defined group of properties - -Args: - - Type(PyPROPERTYKEY):Property list identifier (pscon.PKEY_PropList_*) - riid(PyIID):The interface to return - -Returns: - - PyIPropertyDescriptionList - - """ - pass - - - def GetAttributes(self,AttribFlags:'typing.Any',Mask:'typing.Any') -> 'typing.Any': - """ - Retrieves shell attributes of contained items - -Args: - - AttribFlags(typing.Any):SIATTRIBFLAGS value (shellcon.SIATTRIBFLAGS_*) specifying how to combine attributes of multiple items - Mask(typing.Any):Combination of SFGAOF flags (shellcon.SFGAO_*) specifying which attributes to return - -Returns: - - typing.Any - - """ - pass - - - def GetCount(self,) -> 'typing.Any': - """ - Returns the number of items in the container - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetItemAt(self,dwIndex:'typing.Any') -> 'PyIShellItem': - """ - Retrieves an item by index - -Args: - - dwIndex(typing.Any):Zero-based index of item to retrieve - -Returns: - - PyIShellItem - - """ - pass - - - def EnumItems(self,) -> 'PyIEnumShellItems': - """ - Returns an enumeration interface to list contained items - -Args: - - - -Returns: - - PyIEnumShellItems - - """ - pass - - -class PyIShellItemResources(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetAttributes(self,) -> 'None': - """ - Description of GetAttributes. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetSize(self,) -> 'typing.Any': - """ - Description of GetSize. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetTimes(self,) -> 'None': - """ - Description of GetTimes. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetTimes(self,pftCreation:'PyTime',pftWrite:'PyTime',pftAccess:'PyTime') -> 'None': - """ - Description of SetTimes. - -Args: - - pftCreation(PyTime):Description for pftCreation - pftWrite(PyTime):Description for pftWrite - pftAccess(PyTime):Description for pftAccess - -Returns: - - None - - """ - pass - - - def GetResourceDescription(self,pcsir:'PySHELL_ITEM_RESOURCE') -> 'None': - """ - Description of GetResourceDescription. - -Args: - - pcsir(PySHELL_ITEM_RESOURCE):Description for pcsir - -Returns: - - None - - """ - pass - - - def EnumResources(self,) -> 'PyIEnumResources': - """ - Description of EnumResources. - -Args: - - - -Returns: - - PyIEnumResources - - """ - pass - - - def SupportsResource(self,pcsir:'PySHELL_ITEM_RESOURCE') -> 'typing.Any': - """ - Description of SupportsResource. - -Args: - - pcsir(PySHELL_ITEM_RESOURCE):Description for pcsir - -Returns: - - typing.Any - - """ - pass - - - def OpenResource(self,pcsir:'PySHELL_ITEM_RESOURCE',riid:'PyIID') -> 'PyIUnknown': - """ - Description of OpenResource. - -Args: - - pcsir(PySHELL_ITEM_RESOURCE):Description for pcsir - riid(PyIID):The interface to return - -Returns: - - PyIUnknown - - """ - pass - - - def CreateResource(self,sir:'PySHELL_ITEM_RESOURCE',riid:'PyIID') -> 'typing.Any': - """ - Description of CreateResource. - -Args: - - sir(PySHELL_ITEM_RESOURCE):Resource identifier - riid(PyIID):The interface to return - -Returns: - - typing.Any - - """ - pass - - - def MarkForDelete(self,) -> 'None': - """ - Description of MarkForDelete. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIShellLibrary(object): - """Interface used to access Libraries""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def LoadLibraryFromItem(self,Library:'PyIShellItem',Mode:'typing.Any') -> 'None': - """ - Loads an existing library file - -Args: - - Library(PyIShellItem):Shell item interface representing the library file - Mode(typing.Any):Access mode, combination of storagecon.STGM_* flags - -Returns: - - None - - """ - pass - - - def LoadLibraryFromKnownFolder(self,Library:'PyIID',Mode:'typing.Any') -> 'None': - """ - Initializes library from a known folder - -Args: - - Library(PyIID):Known folder id, shell.FOLDERID_* - Mode(typing.Any):Access mode, combination of storagecon.STGM_* flags - -Returns: - - None - - """ - pass - - - def AddFolder(self,Location:'PyIShellItem') -> 'None': - """ - Includes a folder - -Args: - - Location(PyIShellItem):Shell item interface representing the folder - -Returns: - - None - - """ - pass - - - def RemoveFolder(self,Location:'PyIShellItem') -> 'None': - """ - Removes a folder - -Args: - - Location(PyIShellItem):Shell item interface representing the folder - -Returns: - - None - - """ - pass - - - def GetFolders(self,Filter:'typing.Any',riid:'PyIID') -> 'PyIShellItemArray': - """ - Retrieves a collection of folders in the library - -Args: - - Filter(typing.Any):Specifies what types of folder to return (shellcon.LFF_*) - riid(PyIID):The interface to return, IObjectCollection and IObjectArray also accepted. - -Returns: - - PyIShellItemArray - - """ - pass - - - def ResolveFolder(self,FolderToResolve:'PyIShellItem',Timeout:'typing.Any',riid:'PyIID') -> 'PyIShellItem': - """ - Attempts to locate a folder that has been moved or renamed - -Args: - - FolderToResolve(PyIShellItem):Library item whose location has changed - Timeout(typing.Any):Max search time, specified in milliseconds - riid(PyIID):The interface to return - -Returns: - - PyIShellItem - - """ - pass - - - def GetDefaultSaveFolder(self,Type:'typing.Any',riid:'PyIID') -> 'PyIShellItem': - """ - Returns the default folder in which new items are - -saved - -Args: - - Type(typing.Any):Specifies whether to return public or private save location, shellcon.DSFT_* - riid(PyIID):The interface to return - -Returns: - - PyIShellItem - - """ - pass - - - def SetDefaultSaveFolder(self,Type:'typing.Any',SaveFolder:'PyIShellItem') -> 'None': - """ - Sets the default save location - -Args: - - Type(typing.Any):Specifies public or private save location, shellcon.DSFT_* - SaveFolder(PyIShellItem):New default location, must be in the library - -Returns: - - None - - """ - pass - - - def GetOptions(self,) -> 'typing.Any': - """ - Retrieves library option flags - -Args: - - - -Returns: - - typing.Any:PyIShellLibrary.GetOptions - -int = GetOptions()Retrieves library option flags -Return ValueReturns a combination of shellcon.LOF_* flags - - - """ - pass - - - def SetOptions(self,Mask:'typing.Any',Options:'typing.Any') -> 'None': - """ - Sets library option flags - -Args: - - Mask(typing.Any):Bitmask of flags to be changed, combination of shellcon.LOF_* values - Options(typing.Any):New options, combination of shellcon.LOF_* values - -Returns: - - None - - """ - pass - - - def GetFolderType(self,) -> 'PyIID': - """ - Returns the library type, shell.FOLDERTYPEID_* - -Args: - - - -Returns: - - PyIID - - """ - pass - - - def SetFolderType(self,Type:'PyIID') -> 'None': - """ - Sets the folder type for the library - -Args: - - Type(PyIID):New type, shell.FOLDERTYPEID_* - -Returns: - - None - - """ - pass - - - def GetIcon(self,) -> 'typing.Any': - """ - Returns the location of the library's icon - -Args: - - - -Returns: - - typing.Any:PyIShellLibrary.GetIcon - -str = GetIcon()Returns the location of the library's icon -Return ValueUses "module,resource" format - - - """ - pass - - - def SetIcon(self,Icon:'typing.Any') -> 'None': - """ - Sets the library icon - -Args: - - Icon(typing.Any):Icon location in "module,resource" syntax - -Returns: - - None - - """ - pass - - - def Commit(self,) -> 'None': - """ - Saves changes (only if loaded from an existing library) - -Args: - - - -Returns: - - None - - """ - pass - - - def Save(self,FolderToSaveIn:'PyIShellItem',LibraryName:'typing.Any',Flags:'typing.Any') -> 'PyIShellItem': - """ - Saves the library to a specific location - -Args: - - FolderToSaveIn(PyIShellItem):The destination folder, use None to save in current user's Libraries folder - LibraryName(typing.Any):Filename for the new library, without file extension - Flags(typing.Any):Determines behaviour if file already exists, shellcon.LSF_*Return ValueReturns a shell item for the saved file. - -Returns: - - PyIShellItem:Determines behaviour if file already exists, shellcon.LSF_*Return ValueReturns a shell item for the saved file. - - - """ - pass - - - def SaveInKnownFolder(self,FolderToSaveIn:'PyIID',LibraryName:'typing.Any',Flags:'typing.Any') -> 'PyIShellItem': - """ - Saves the library in a known folder - -Args: - - FolderToSaveIn(PyIID):The destination folder, shell.FOLDERID_* - LibraryName(typing.Any):Filename for the new library, without file extension - Flags(typing.Any):Determines behaviour if file already exists, shellcon.LSF_* - -Returns: - - PyIShellItem - - """ - pass - - -class PyIShellLink(object): - """Interface used to access the properties of a shell link file (*.lnk)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - 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 - -object - -Args: - - fFlags(typing.Any):One of the following values:ValueDescriptionSLGP_SHORTPATHRetrieves the standard short (8.3 format) file name.SLGP_UNCPRIORITYRetrieves the Universal Naming Convention (UNC) path name of the file.SLGP_RAWPATHRetrieves the raw path name. A raw path is something that might not exist and may include environment variables that need to be expanded. - cchMaxPath(typing.Any):Number of characters to allocate for returned filenameCommentsThe AlternateFileName (8.3) member of WIN32_FIND_DATA does not return information - -Returns: - - typing.Tuple[typing.Any, WIN32_FIND_DATA] - - """ - pass - - - def GetIDList(self,) -> 'PyIDL': - """ - Retrieves the item id list that identifies the target of the shell link. - -Args: - - - -Returns: - - PyIDL - - """ - pass - - - def SetIDList(self,pidl:'PyIDL') -> 'None': - """ - Sets the target of the link using an item id list - -Args: - - pidl(PyIDL):Absolute item id list that identifies the target - -Returns: - - None - - """ - pass - - - def GetDescription(self,cchMaxName:'typing.Any'=1024) -> 'typing.Any': - """ - Retrieves the description of the link (displays as Comment in the UI) - -Args: - - cchMaxName(typing.Any):Number of character to allocate for the retrieved text - -Returns: - - typing.Any - - """ - pass - - - def SetDescription(self,Name:'typing.Any') -> 'None': - """ - Sets the description of the link (displays as Comment in the UI) - -Args: - - Name(typing.Any):The description for the link - -Returns: - - None - - """ - pass - - - def GetWorkingDirectory(self,cchMaxName:'typing.Any'=1024) -> 'typing.Any': - """ - Retrieves the working directory for the link - -Args: - - cchMaxName(typing.Any):Number of characters to allocate for returned text - -Returns: - - typing.Any - - """ - pass - - - def SetWorkingDirectory(self,Dir:'typing.Any') -> 'None': - """ - Sets the working directory for the link. - -Args: - - Dir(typing.Any):The working directory for the link - -Returns: - - None - - """ - pass - - - def GetArguments(self,cchMaxName:'typing.Any'=1024) -> 'typing.Any': - """ - Retrieves the command-line arguments associated with a shell link object. - -Args: - - cchMaxName(typing.Any):Number of characters to fetch. - -Returns: - - typing.Any - - """ - pass - - - def SetArguments(self,args:'typing.Any') -> 'None': - """ - Sets the command-line arguments associated with a shell link object. - -Args: - - args(typing.Any):The new arguments. - -Returns: - - None - - """ - pass - - - def GetHotkey(self,) -> 'typing.Any': - """ - Retrieves the hot key for a shell link object. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetHotkey(self,wHotkey:'typing.Any') -> 'None': - """ - Sets the hot key for a shell link object. - -Args: - - wHotkey(typing.Any):The virtual key code is in the low-order byte, and the modifier flags are in the high-order byte. The modifier flags can be a combination of the values specified in the description of the PyIShellLink::GetHotkey method. - -Returns: - - None - - """ - pass - - - def GetShowCmd(self,) -> 'typing.Any': - """ - Retrieves the show (SW_) command for a shell link object. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetShowCmd(self,iShowCmd:'typing.Any') -> 'None': - """ - Sets the show (SW_) command for a shell link object. - -Args: - - iShowCmd(typing.Any):The new show command value. - -Returns: - - None - - """ - pass - - - def GetIconLocation(self,cchMaxPath:'typing.Any') -> 'typing.Any': - """ - Retrieves the location (path and index) of the icon for a shell link - -object. - -Args: - - cchMaxPath(typing.Any):Number of characters to allocate for the result string. - -Returns: - - typing.Any - - """ - pass - - - def SetIconLocation(self,iconPath:'str',iIcon:'typing.Any') -> 'None': - """ - Sets the location (path and index) of the icon for a shell link object. - -Args: - - iconPath(str):Path to the file with the icon. - iIcon(typing.Any):Index of the icon. - -Returns: - - None - - """ - pass - - - def SetRelativePath(self,relPath:'str',reserved:'typing.Any'=0) -> 'None': - """ - Sets the relative path for a shell link object. - -Args: - - relPath(str):The relative path. - reserved(typing.Any):Reserved - must be zero.CommentsThis mechanism allows for moved link files to reestablish connection with relative files through similar-prefix comparisons - -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 - -shell link path and its list of identifiers (if necessary) - -Args: - - hwnd(typing.Any):The parent window of a dialog which will pop up if resolution fails. - fFlags(typing.Any):One of the following constants:ValueDescriptionSLR_INVOKE_MSICall the Microsoft Windows Installer.SLR_NOLINKINFODisable distributed link tracking. By default, distributed link tracking tracks removable media across multiple devices based on the volume name. It also uses the UNC path to track remote file systems whose drive letter has changed. Setting SLR_NOLINKINFO disables both types of tracking.SLR_NO_UIDo not display a dialog box if the link cannot be resolved. When SLR_NO_UI is set, the high-order word of fFlags can be set to a time-out value that specifies the maximum amount of time to be spent resolving the link. The function returns if the link cannot be resolved within the time-out duration. If the high-order word is set to zero, the time-out duration will be set to the default value of 3,000 milliseconds (3 seconds). To specify a value, set the high word of fFlags to the desired time-out duration, in milliseconds.SLR_NOUPDATEDo not update the link information.SLR_NOSEARCHDo not execute the search heuristics.SLR_NOTRACKDo not use distributed link tracking.SLR_UPDATEIf the link object has changed, update its path and list of identifiers. If SLR_UPDATE is set, you do not need to call IPersistFile::IsDirty to determine whether or not the link object has changed. - -Returns: - - None - - """ - pass - - - def SetPath(self,path:'str') -> 'None': - """ - Sets the path and file name of a shell link object. - -Args: - - path(str):The path and filename of the link. - -Returns: - - None - - """ - pass - - -class PyIShellLinkDataList(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddDataBlock(self,DataBlock:'typing.Any') -> 'None': - """ - Inserts a data block into the link - -Args: - - DataBlock(typing.Any):Contents are dependent on type of data block being addedCommentsInput should be one of NT_CONSOLE_PROPS, NT_FE_CONSOLE_PROPS, EXP_SPECIAL_FOLDER, EXP_DARWIN_LINK, or EXP_SZ_LINK. Expected form is indicated by the Signature member. - -Returns: - - None - - """ - pass - - - def CopyDataBlock(self,Sig:'typing.Any') -> 'typing.Any': - """ - Retrieves the specified data block from the link - -Args: - - Sig(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 - -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 - - - def GetFlags(self,) -> 'typing.Any': - """ - Retrieves the link's flags - -Args: - - - -Returns: - - typing.Any:PyIShellLinkDataList.GetFlags - -int = GetFlags()Retrieves the link's flags -Return ValueReturns combination of shellcon.SLDF_* flags - - - """ - pass - - - def RemoveDataBlock(self,Sig:'typing.Any') -> 'None': - """ - Deletes one of the link's data blocks - -Args: - - Sig(typing.Any):Identifies which block is to be removed, one of shellcon.*_SIG constants - -Returns: - - None - - """ - pass - - - def SetFlags(self,Flags:'typing.Any') -> 'None': - """ - Sets the flags indicating which data blocks are present - -Args: - - Flags(typing.Any):Combination of shellcon.SLDF_* flags - -Returns: - - None - - """ - pass - - -class PyIShellView(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def TranslateAccelerator(self,pmsg:'typing.Any') -> 'typing.Any': - """ - Description of TranslateAccelerator. - -Args: - - pmsg(typing.Any):Description for pmsgReturn ValueThe result is the HRESULT from the underlying TranslateAccelerator call - -Returns: - - typing.Any:Description for pmsgReturn ValueThe result is the HRESULT from the underlying TranslateAccelerator call - - - """ - pass - - - def EnableModeless(self,fEnable:'typing.Any') -> 'None': - """ - Description of EnableModeless. - -Args: - - fEnable(typing.Any):Description for fEnable - -Returns: - - None - - """ - pass - - - def UIActivate(self,uState:'typing.Any') -> 'None': - """ - Description of UIActivate. - -Args: - - uState(typing.Any):Description for uState - -Returns: - - None - - """ - pass - - - def Refresh(self,) -> 'None': - """ - Description of Refresh. - -Args: - - - -Returns: - - None - - """ - pass - - - def CreateViewWindow(self,psvPrevious:'PyIShellView',pfs:'typing.Tuple[typing.Any, typing.Any]',psb:'PyIShellBrowser',prcView:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]') -> 'typing.Any': - """ - Description of CreateViewWindow. - -Args: - - psvPrevious(PyIShellView):Description for psvPrevious - pfs(typing.Tuple[typing.Any, typing.Any]):Description for pfs - psb(PyIShellBrowser):Description for psb - prcView(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Description for prcViewReturn ValueThe result is an integer handle to the new window. - -Returns: - - typing.Any:Description for prcViewReturn ValueThe result is an integer handle to the new window. - - - """ - pass - - - def DestroyViewWindow(self,) -> 'None': - """ - Description of DestroyViewWindow. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCurrentInfo(self,) -> 'typing.Any': - """ - Description of GetCurrentInfo. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SaveViewState(self,) -> 'None': - """ - Description of SaveViewState. - -Args: - - - -Returns: - - None - - """ - pass - - - def SelectItem(self,pidlItem:'PyIDL',uFlags:'typing.Any') -> 'None': - """ - Description of SelectItem. - -Args: - - pidlItem(PyIDL):Description for pidlItem - uFlags(typing.Any):Description for uFlags - -Returns: - - None - - """ - pass - - - def GetItemObject(self,uItem:'typing.Any',riid:'PyIID') -> 'PyIUnknown': - """ - Description of GetItemObject. - -Args: - - uItem(typing.Any):Description for uItem - riid(PyIID):Description for riid - -Returns: - - PyIUnknown - - """ - pass - - -class PyISpecifyPropertyPages(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPages(self,) -> 'None': - """ - Description of GetPages. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIStorage(object): - """Structured storage compound storage object""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - 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 - -in this storage object. All elements within a storage object — both streams and other storage objects — are kept in - -the same name space. - -Args: - - Name(typing.Any):Name of the new stream - Mode(typing.Any):Access mode, storagecon.STGM_* - reserved1(typing.Any):Reserved - must be zero. - reserved2(typing.Any):Reserved - must be zero. - -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 - -specified access mode. - -Args: - - Name(typing.Any):Name of stream to be opened - reserved1(typing.Any):A reserved param. Always pass None. NULL is always passed to the COM function - Mode(typing.Any):Access mode, storagecon.STGM_* - reserved2(typing.Any):Reserved - must be zero. - -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 - -object. - -Args: - - Name(typing.Any):The name of the newly created stream. - Mode(typing.Any):Access mode - combination of storagecon.STGM_* flags - StgFmt(typing.Any):Documented as "reserved"! - reserved2(typing.Any):Description for reserved2 - -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 - -specified access mode. - -Args: - - Name(typing.Any):Name of the storage, or None. - Priority(PyIStorage):If the pstgPriority parameter is not None, it is a PyIStorage object to a previous opening of an element of the storage object, usually one that was opened in priority mode. The storage object should be closed and re-opened according to grfMode. When the PyIStorage::OpenStorage method returns, pstgPriority is no longer valid - use the result value. If the pstgPriority parameter is None, it is ignored. - Mode(typing.Any):Access mode - combination of storagecon.STGM_* flags (must include STGM_SHARE_EXCLUSIVE) - snbExclude(typing.Any):Reserved for later - Must be None - reserved(typing.Any):Reserved integer param. - -Returns: - - PyIStorage - - """ - pass - - - def CopyTo(self,rgiidExclude:'typing.Tuple[typing.Any, typing.Any]',snbExclude:'typing.Any',stgDest:'PyIStorage') -> 'None': - """ - Copies the entire contents of an open storage object to another storage object. - -Args: - - rgiidExclude(typing.Tuple[typing.Any, typing.Any]):List of IID's to be excluded. Use empty seq to exclude all objects, or None to indicate no excludes. - snbExclude(typing.Any):Reserved for later - Must be None - stgDest(PyIStorage):The open storage object into which this storage object is to be copied. The destination storage object can be a different implementation of the PyIStorage interface from the source storage object. Thus, IStorage::CopyTo can only use publicly available methods of the destination storage object. If stgDest is open in transacted mode, it can be reverted by calling its PyIStorage::Revert method. - -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 - -storage object. - -Args: - - Name(typing.Any):A string that contains the name of the element in this storage object to be moved or copied. - stgDest(PyIStorage):PyIStorage for the destination storage object. - NewName(typing.Any):A string that contains the new name for the element in its new storage object. - Flags(typing.Any):Specifies whether to move or copy (storagecon.STGMOVE_MOVE or STGMOVE_COPY) - -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 - -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 - -disk. For non-root storage objects in direct mode, this method has no effect. - -Args: - - grfCommitFlags(typing.Any):Controls how the changes are committed to the storage object. See the STGC enumeration for a definition of these values. - -Returns: - - None - - """ - pass - - - def Revert(self,) -> 'None': - """ - Discards all changes that have been made to the storage object since the last commit. - -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 - -storage and stream objects contained within this storage object. - -Args: - - reserved1(typing.Any):Reserved - must be zero. - reserved2(typing.Any):A reserved param. Always pass None. NULL is always passed to the COM function - reserved3(typing.Any):Reserved - must be zero. - -Returns: - - PyIEnumSTATSTG - - """ - pass - - - def DestroyElement(self,name:'str') -> 'None': - """ - Removes the specified storage or stream from this storage object. - -Args: - - name(str):The name of the element to be removed. - -Returns: - - None - - """ - pass - - - def RenameElement(self,OldName:'typing.Any',NewName:'typing.Any') -> 'None': - """ - Renames the specified substorage or stream in this storage object. - -Args: - - OldName(typing.Any):The name of the substorage or stream to be changed. - NewName(typing.Any):The new name for the specified sustorage or stream. - -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 - -element, if supported by the underlying file system. - -Args: - - name(typing.Any):The name of the storage object element whose times are to be modified. If NULL, the time is set on the root storage rather than one of its elements. - ctime(PyTime):Either the new creation time for the element or None if the creation time is not to be modified. - atime(PyTime):Either the new access time for the element or None if the access time is not to be modified. - mtime(PyTime):Either the new modification time for the element or None if the modification time is not to be modified. - -Returns: - - None - - """ - pass - - - def SetClass(self,clsid:'PyIID') -> 'None': - """ - Assigns the specified CLSID to this storage object. - -Args: - - clsid(PyIID):The class identifier (CLSID) that is to be associated with the storage object. - -Returns: - - None - - """ - pass - - - def SetStateBits(self,grfStateBits:'typing.Any',grfMask:'typing.Any') -> 'None': - """ - Stores up to 32 bits of state information in this storage object. - -Args: - - grfStateBits(typing.Any):Specifies the new values of the bits to set. No legal values are defined for these bits; they are all reserved for future use and must not be used by applications. - grfMask(typing.Any):A binary mask indicating which bits in grfStateBits are significant in this call. - -Returns: - - None - - """ - pass - - - def Stat(self,grfStatFlag:'typing.Any') -> 'STATSTG': - """ - Retrieves the STATSTG structure for this open storage object. - -Args: - - grfStatFlag(typing.Any):Specifies that some of the fields in the STATSTG structure are not returned, thus saving a memory allocation operation. Values are taken from the STATFLAG enumeration. - -Returns: - - STATSTG - - """ - pass - - -class PyIStream(object): - """A Python interface to IStream""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Read(self,numBytes:'typing.Any') -> 'str': - """ - Read the specified number of bytes from the string. - -Args: - - numBytes(typing.Any):The number of bytes to read from the stream. Must not be zero.Return ValueThe result is a string containing binary data. - -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 - - - def read(self,numBytes:'typing.Any') -> 'str': - """ - Read the specified number of bytes from the string. - -Args: - - numBytes(typing.Any):The number of bytes to read from the stream. Must not be zero.Return ValueThe result is a string containing binary data. - -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 - - - def Write(self,data:'str') -> 'None': - """ - Write data to a stream - -Args: - - data(str):The binary data to write. - -Returns: - - None - - """ - pass - - - def write(self,data:'str') -> 'None': - """ - Write data to a stream - -Args: - - data(str):The binary data to write. - -Returns: - - None - - """ - pass - - - def Seek(self,offset:'typing.Any',origin:'typing.Any') -> 'ULARGE_INTEGER': - """ - Changes the seek pointer to a new location. - -Args: - - offset(typing.Any):The new location - origin(typing.Any):Relative to where? - -Returns: - - ULARGE_INTEGER - - """ - pass - - - def SetSize(self,newSize:'ULARGE_INTEGER') -> 'None': - """ - Changes the size of the stream object. - -Args: - - newSize(ULARGE_INTEGER):The new size - -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 - -stream to the current seek pointer in another stream. - -Args: - - stream(PyIStream):The stream to write to. - cb(ULARGE_INTEGER):The number of bytes to write.Return ValueThe return value is the number of bytes actually written. - -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 - -the parent storage. - -Args: - - flags(typing.Any):Controls how changes are performed. - -Returns: - - None - - """ - pass - - - def Revert(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def LockRegion(self,offset:'ULARGE_INTEGER',cb:'ULARGE_INTEGER',lockType:'typing.Any') -> 'None': - """ - Restricts access to a specified range of bytes in the stream. - -Args: - - offset(ULARGE_INTEGER):Integer that specifies the byte offset for the beginning of the range. - cb(ULARGE_INTEGER):The number of bytes to restrict. - lockType(typing.Any):Restrictions requested. - -Returns: - - None - - """ - pass - - - def UnLockRegion(self,offset:'ULARGE_INTEGER',cb:'ULARGE_INTEGER',lockType:'typing.Any') -> 'None': - """ - None - -Args: - - offset(ULARGE_INTEGER):Integer that specifies the byte offset for the beginning of the range. - cb(ULARGE_INTEGER):The number of bytes to restrict. - lockType(typing.Any):Restrictions requested. - -Returns: - - None - - """ - pass - - - def Clone(self,) -> 'PyIStream': - """ - Creates a new stream object with its own seek pointer that references the - -same bytes as the original stream. - -Args: - - - -Returns: - - PyIStream - - """ - pass - - - def Stat(self,grfStatFlag:'typing.Any'=0) -> 'STATSTG': - """ - Returns information about the stream - -Args: - - grfStatFlag(typing.Any):Flags. - -Returns: - - STATSTG - - """ - pass - - -class PyITask(object): - """Python object that encapsulates the ITask interface, inherits all the methods of PyIScheduledWorkItem""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetApplicationName(self,ApplicationName:'typing.Any') -> 'None': - """ - Specify which program the task will run - -Args: - - ApplicationName(typing.Any):Program to execute - -Returns: - - None - - """ - pass - - - def GetApplicationName(self,) -> 'typing.Any': - """ - Retrieve name of program that task will run - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetParameters(self,Parameters:'typing.Any') -> 'None': - """ - Sets command line parameters - -Args: - - Parameters(typing.Any):String containing command line parameters - -Returns: - - None - - """ - pass - - - def GetParameters(self,) -> 'typing.Any': - """ - Returns command line parameters for task - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetWorkingDirectory(self,WorkingDirectory:'typing.Any') -> 'None': - """ - Sets initial working directory for task - -Args: - - WorkingDirectory(typing.Any):Initial working directory - -Returns: - - None - - """ - pass - - - def GetWorkingDirectory(self,) -> 'typing.Any': - """ - Return working directory that the task will start out in - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetPriority(self,Priority:'typing.Any') -> 'None': - """ - Sets priority for task - -Args: - - Priority(typing.Any):One of REALTIME_PRIORITY_CLASS, HIGH_PRIORITY_CLASS, NORMAL_PRIORITY_CLASS, IDLE_PRIORITY_CLASS - -Returns: - - None - - """ - pass - - - def GetPriority(self,) -> 'typing.Any': - """ - Gets priority that will be assigned to process when task starts - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetTaskFlags(self,dwFlags:'typing.Any') -> 'None': - """ - Sets flag for task. - -Args: - - dwFlags(typing.Any):None currently defined - -Returns: - - None - - """ - pass - - - def GetTaskFlags(self,) -> 'typing.Any': - """ - Retrieve task flags (None currently defined) - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetMaxRunTime(self,MaxRunTimeMS:'typing.Any') -> 'None': - """ - Sets maximun run time for task, use -1 to disable - -Args: - - MaxRunTimeMS(typing.Any):Specified in milliseconds (use -1 to disable, not 0) - -Returns: - - None - - """ - pass - - - def GetMaxRunTime(self,) -> 'typing.Any': - """ - Returns maximun run time for task - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyITaskScheduler(object): - """Interface to the Windows Task Scheduler""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetTargetComputer(self,Computer:'typing.Any') -> 'None': - """ - Connect to another machine to manage its tasks - -Args: - - Computer(typing.Any):Name of system to connect toCommentsLeading backslashes are required. Call will succeed without them, but no other methods will work. - -Returns: - - None - - """ - pass - - - def GetTargetComputer(self,) -> 'typing.Any': - """ - Returns name of computer that the Task Scheduler is - -connected to - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def Enum(self,) -> 'typing.Tuple[str, ...]': - """ - Retrieve list of task names - -Args: - - - -Returns: - - typing.Tuple[str, ...] - - """ - pass - - - def Activate(self,Name:'typing.Any',riid:'PyIID') -> 'PyITask': - """ - Opens the specified task and returns an ITask interface for it - -Args: - - Name(typing.Any):Name of task to retreive - riid(PyIID):IID to return, currently only IID_ITask accepted - -Returns: - - PyITask - - """ - pass - - - def Delete(self,TaskName:'typing.Any') -> 'None': - """ - Delete task by name - -Args: - - TaskName(typing.Any):Name of task to delete - -Returns: - - None - - """ - pass - - - def NewWorkItem(self,TaskName:'typing.Any',rclsid:'PyIID',riid:'PyIID') -> 'PyITask': - """ - Creates a new task - -Args: - - TaskName(typing.Any):Name of new task - rclsid(PyIID):Class id of work item, currently only CLSID_CTask (defaults if not passed in) - riid(PyIID):Interface IID to return, currently only IID_ITask (defaults if not passed in) - -Returns: - - PyITask - - """ - pass - - - def AddWorkItem(self,TaskName:'typing.Any',WorkItem:'PyITask') -> 'None': - """ - Create a new scheduled task from PyITask object - -Args: - - TaskName(typing.Any):Name of task to be created - WorkItem(PyITask):Existing PyITask objectCommentsThe PyItask passed in is modified in place and on success is associated with the new task, not the old one - -Returns: - - None - - """ - pass - - - def IsOfType(self,Name:'typing.Any',riid:'PyIID') -> 'None': - """ - Check if named object supports specified interface - -Args: - - Name(typing.Any):Name of object - riid(PyIID):Named object is checked that it supports the interface of this IID - -Returns: - - None - - """ - pass - - -class PyITaskTrigger(object): - """Python object that encapsulates the ITaskTrigger interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetTrigger(self,Trigger:'PyTASK_TRIGGER') -> 'None': - """ - Set trigger parameters from a PyTASK_TRIGGER object - -Args: - - Trigger(PyTASK_TRIGGER):Python object representing a TASK_TRIGGER struct - -Returns: - - None - - """ - pass - - - def GetTrigger(self,) -> 'PyTASK_TRIGGER': - """ - Retrieves trigger parms as a PyTASK_TRIGGER object - -Args: - - - -Returns: - - PyTASK_TRIGGER - - """ - pass - - - def GetTriggerString(self,) -> 'str': - """ - Build text summary of trigger - -Args: - - - -Returns: - - str - - """ - pass - - -class PyITaskbarList(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def HrInit(self,) -> 'None': - """ - Intializes the interface before use - -Args: - - - -Returns: - - None - - """ - pass - - - def AddTab(self,hwnd:'int') -> 'None': - """ - Places a window on the taskbar - -Args: - - hwnd(int):Handle to window, should have WS_CAPTION style - -Returns: - - None - - """ - pass - - - def DeleteTab(self,hwnd:'int') -> 'None': - """ - Removes a window from the taskbar - -Args: - - hwnd(int):Handle to window, should have WS_CAPTION style - -Returns: - - None - - """ - pass - - - def ActivateTab(self,hwnd:'int') -> 'None': - """ - Marks a window as the active tab on the taskbar - -Args: - - hwnd(int):Handle to window, should have WS_CAPTION style - -Returns: - - None - - """ - pass - - - def SetActiveAlt(self,hwnd:'int') -> 'None': - """ - Sets the window as the active tab, without displaying it as pressed on the - -taskbar - -Args: - - hwnd(int):Handle to window, should have WS_CAPTION style - -Returns: - - None - - """ - pass - - -class PyITransferAdviseSink(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def UpdateProgress(self,SizeCurrent:'typing.Any',SizeTotal:'typing.Any',FilesCurrent:'typing.Any',FilesTotal:'typing.Any',FoldersCurrent:'typing.Any',FoldersTotal:'typing.Any') -> 'None': - """ - Gives an estimate of amount of work completed - -Args: - - SizeCurrent(typing.Any):Bytes transferred so far - SizeTotal(typing.Any):Total number of bytes - FilesCurrent(typing.Any):Number of files processed already - FilesTotal(typing.Any):Total number of files - FoldersCurrent(typing.Any):Number of folders processed already - FoldersTotal(typing.Any):Total number of folder - -Returns: - - None - - """ - pass - - - def UpdateTransferState(self,State:'typing.Any') -> 'None': - """ - Notifies client of current operation state - -Args: - - State(typing.Any):A TRANSFER_ADVISE_STATE value (shellcon.TS_*) - -Returns: - - None - - """ - pass - - - def ConfirmOverwrite(self,Source:'PyIShellItem',DestParent:'PyIShellItem',Name:'typing.Any') -> 'typing.Any': - """ - Asks user for permission to overwrite an existing item - -Args: - - Source(PyIShellItem):The item that will replace existing item - DestParent(PyIShellItem):Folder into which item will be placed - Name(typing.Any):New name for item, or None if item is to keep original name - -Returns: - - typing.Any - - """ - pass - - - def ConfirmEncryptionLoss(self,Source:'PyIShellItem') -> 'typing.Any': - """ - Notifies user when an item can't be encrypted at - -destination - -Args: - - Source(PyIShellItem):Item that failed to be encrypted - -Returns: - - typing.Any - - """ - pass - - - def FileFailure(self,Item:'PyIShellItem',ItemName:'typing.Any',Error:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Notifies user of failure, and queries how to proceed - -Args: - - Item(PyIShellItem):The shell item that caused the failure - ItemName(typing.Any):Name of item if different than above, can be None - Error(typing.Any):HRESULT error code from operationReturn ValueReturns the HRESULT and new file name if renaming resolved the failure - -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 - -proceed - -Args: - - Item(PyIShellItem):The item whose stream couldn't be created - StreamName(typing.Any):Name of the failed stream - Error(typing.Any):HRESULT failure code from operationReturn ValueReturns COPYENGINE_S_* if operation is to continue, or COPYENGINE_E_* HRESULT if cancelled - -Returns: - - typing.Any:HRESULT failure code from operationReturn ValueReturns COPYENGINE_S_* if operation is to continue, or COPYENGINE_E_* HRESULT if cancelled - - - """ - pass - - - def PropertyFailure(self,Item:'PyIShellItem',key:'PyPROPERTYKEY',Error:'typing.Any') -> 'typing.Any': - """ - Notifies user of failure to set an item's properties - -Args: - - Item(PyIShellItem):The item whose property could not be set - key(PyPROPERTYKEY):Identifies the property that caused the error, or None if all properties failed - Error(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 - -Returns: - - 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 - - -class PyITransferDestination(object): - """Implemented by shell extensions that act as targets for item copy or move operations""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Advise(self,Sink:'PyITransferAdviseSink') -> 'typing.Any': - """ - Connects an advise sink - -Args: - - Sink(PyITransferAdviseSink):Event sink to receive notificationsReturn ValueReturns an id for the connection, to be passed to PyITransferDestination::Unadvise - -Returns: - - typing.Any:Event sink to receive notificationsReturn ValueReturns an id for the connection, to be passed to PyITransferDestination::Unadvise - - - """ - pass - - - def Unadvise(self,Cookie:'typing.Any') -> 'None': - """ - Disconnects an advise sink - -Args: - - Cookie(typing.Any):Connection identifier as returned by PyITransferDestination::Advise - -Returns: - - None - - """ - pass - - - def CreateItem(self,Name:'typing.Any',Attributes:'typing.Any',Size:'typing.Any',Flags:'typing.Any',riidItem:'PyIID',riidResources:'PyIID') -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': - """ - Requests that a new item be created - -Args: - - Name(typing.Any):Filename to be created - Attributes(typing.Any):File attributes - Size(typing.Any):Size of file - Flags(typing.Any):Combination of shellcon.TSF_* flags - riidItem(PyIID):Item interface to return - riidResources(PyIID):Resource interface to returnReturn ValueReturns the HRESULT and requested interfaces. Interfaces may be None if function returns one of the informational codes (shellcon.COPYENGINE_S_*) - -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 - -function returns one of the informational codes (shellcon.COPYENGINE_S_*) - - - """ - pass - - -class PyITransferMediumItem(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyITransferSource(object): - """Implemented by shell folders that can act as the source of shell item operations""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Advise(self,Sink:'PyITransferAdviseSink') -> 'typing.Any': - """ - Connects an advise sink to receive notifications - -Args: - - Sink(PyITransferAdviseSink):Event sink to respond to notifications - -Returns: - - typing.Any - - """ - pass - - - def Unadvise(self,Cookie:'typing.Any') -> 'None': - """ - Disconnects an event sink - -Args: - - Cookie(typing.Any):Connection id as returned by PyITransferSource::Advise - -Returns: - - None - - """ - pass - - - def SetProperties(self,proparray:'PyIPropertyChangeArray') -> 'None': - """ - Specifies changes to be applied to items' properties - -Args: - - proparray(PyIPropertyChangeArray):Property changes to be applied by PyITransferSource::ApplyPropertiesToItem - -Returns: - - None - - """ - pass - - - def OpenItem(self,Item:'PyIShellItem',flags:'typing.Any',riid:'PyIID') -> 'typing.Tuple[typing.Any, PyIShellItemResources]': - """ - Initiates the copying of an item - -Args: - - Item(PyIShellItem):The item to be copied. - flags(typing.Any):Combination of shellcon.TSF_* flags - riid(PyIID):The interface to return - -Returns: - - typing.Tuple[typing.Any, PyIShellItemResources] - - """ - pass - - - def MoveItem(self,Item:'PyIShellItem',ParentDst:'PyIShellItem',NameDst:'typing.Any',flags:'typing.Any') -> 'typing.Tuple[typing.Any, PyIShellItem]': - """ - Moves a shell item into another folder - -Args: - - Item(PyIShellItem):Item to be moved - ParentDst(PyIShellItem):The folder into which it will be moved - NameDst(typing.Any):New name for item after move, None to keep same name - flags(typing.Any):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 of expected actions for specific error codes. - -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 - -when the code in one of the informational COPYENGINE_S_* values. See MSDN for descriptions - -of expected actions for specific error codes. - - - """ - pass - - - def RecycleItem(self,Source:'PyIShellItem',ParentDest:'PyIShellItem',flags:'typing.Any') -> 'typing.Tuple[typing.Any, PyIShellItem]': - """ - Moves an item to the recycle bin - -Args: - - Source(PyIShellItem):The item to be recycled - ParentDest(PyIShellItem):Shell item representing the recycle bin - flags(typing.Any):Combination of shellcon.TSF_* flags - -Returns: - - typing.Tuple[typing.Any, PyIShellItem] - - """ - pass - - - def RemoveItem(self,Source:'PyIShellItem',flags:'typing.Any') -> 'typing.Any': - """ - Deletes an item without recycling - -Args: - - Source(PyIShellItem):The item to be deleted - flags(typing.Any):Combination of shellcon.TSF_* flagsReturn ValueReturns the HRESULT of the operation - -Returns: - - typing.Any:Combination of shellcon.TSF_* flagsReturn ValueReturns the HRESULT of the operation - - - """ - pass - - - def RenameItem(self,Source:'PyIShellItem',NewName:'typing.Any',flags:'typing.Any') -> 'typing.Tuple[typing.Any, PyIShellItem]': - """ - Renames a shell item - -Args: - - Source(PyIShellItem):Item to be renamed - NewName(typing.Any):The name to be given to the item - flags(typing.Any):Combination of shellcon.TSF_* flags - -Returns: - - typing.Tuple[typing.Any, PyIShellItem] - - """ - pass - - - def LinkItem(self,Source:'PyIShellItem',ParentDest:'PyIShellItem',NewName:'typing.Any',flags:'typing.Any') -> 'typing.Tuple[typing.Any, PyIShellItem]': - """ - Not implemented, according to MSDN - -Args: - - Source(PyIShellItem):Description for psiSource - ParentDest(PyIShellItem):Description for psiParentDest - NewName(typing.Any):Description for NewName - flags(typing.Any):Combination of shellcon.TSF_* flags - -Returns: - - typing.Tuple[typing.Any, PyIShellItem] - - """ - pass - - - def ApplyPropertiesToItem(self,Source:'PyIShellItem') -> 'PyIShellItem': - """ - None - -Args: - - Source(PyIShellItem):Item whose properties are to be changed - -Returns: - - PyIShellItem - - """ - pass - - - def GetDefaultDestinationName(self,Source:'PyIShellItem',ParentDest:'PyIShellItem') -> 'typing.Any': - """ - Determines the name of an item as it would appear in a - -given folder - -Args: - - Source(PyIShellItem):The item whose name is wanted - ParentDest(PyIShellItem):The destination folder - -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 - -operation - -Args: - - ChildFolderDest(PyIShellItem):The destination folder for the operation - -Returns: - - typing.Any - - """ - pass - - - def LeaveFolder(self,ChildFolderDest:'PyIShellItem') -> 'typing.Any': - """ - Informs the copy engine that the operation on a destination folder is - -finished - -Args: - - ChildFolderDest(PyIShellItem):Destination folder - -Returns: - - typing.Any - - """ - pass - - -class PyITypeComp(object): - """An object that implements the ITypeComp interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Bind(self,szName:'str',wflags:'typing.Any'=0) -> 'typing.Any': - """ - binds to a variable/type - -Args: - - szName(str):The name to bind to - wflags(typing.Any):the bind flags - -Returns: - - typing.Any - - """ - pass - - - def BindType(self,szName:'str') -> 'typing.Any': - """ - binds to a type - -Args: - - szName(str):The name to bind to - -Returns: - - typing.Any - - """ - pass - - -class PyITypeInfo(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetContainingTypeLib(self,) -> 'typing.Tuple[PyITypeLib, typing.Any]': - """ - Retrieves the containing type library and the index of - -the type description within that type library. - -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, - -the complete Help file name and path, and the context ID for the Help topic for a specified type description. - -Args: - - memberId(typing.Any): - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - - """ - pass - - - def GetFuncDesc(self,memberId:'typing.Any') -> 'FUNCDESC': - """ - None - -Args: - - memberId(typing.Any): - -Returns: - - FUNCDESC - - """ - pass - - - def GetImplTypeFlags(self,index:'typing.Any') -> 'typing.Any': - """ - Retrieves the IMPLTYPEFLAGS enumeration for one implemented interface or - -base interface in a type description. - -Args: - - index(typing.Any): - -Returns: - - typing.Any - - """ - pass - - - def GetIDsOfNames(self,) -> 'typing.Any': - """ - Maps between member names and member IDs, and parameter names and parameter - -IDs. - -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 - -the property or method and its parameters) that correspond to the specified function ID. - -Args: - - memberId(typing.Any): - -Returns: - - typing.Any - - """ - pass - - - def GetTypeAttr(self,) -> 'TYPEATTR': - """ - None - -Args: - - - -Returns: - - TYPEATTR - - """ - pass - - - def GetRefTypeInfo(self,hRefType:'typing.Any') -> 'PyITypeInfo': - """ - If a type description references other type descriptions, it - -retrieves the referenced type descriptions. - -Args: - - hRefType(typing.Any): - -Returns: - - PyITypeInfo - - """ - pass - - - def GetRefTypeOfImplType(self,hRefType:'typing.Any') -> 'typing.Any': - """ - Retrieves the type description of the implemented interface types. - -Args: - - hRefType(typing.Any):CommentsIf a type description describes a COM class, it retrieves the type description of the implemented interface types. For an interface, GetRefTypeOfImplType returns the type information for inherited interfaces, if any exist. - -Returns: - - typing.Any - - """ - pass - - - def GetVarDesc(self,memberId:'typing.Any') -> 'VARDESC': - """ - None - -Args: - - memberId(typing.Any): - -Returns: - - VARDESC - - """ - pass - - - def GetTypeComp(self,) -> 'PyITypeComp': - """ - None - -Args: - - - -Returns: - - PyITypeComp - - """ - pass - - -class PyITypeLib(object): - """An object that implements the ITypeLib interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDocumentation(self,index:'typing.Any') -> 'typing.Any': - """ - Retrieves documentation information about the library. - -Args: - - index(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) - -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 - - - def GetLibAttr(self,) -> 'TLIBATTR': - """ - Retrieves the libraries attributes - -Args: - - - -Returns: - - TLIBATTR - - """ - pass - - - def GetTypeComp(self,) -> 'PyITypeComp': - """ - None - -Args: - - - -Returns: - - PyITypeComp - - """ - pass - - - def GetTypeInfo(self,index:'typing.Any') -> 'PyITypeInfo': - """ - Retrieves the specified type description in the library. - -Args: - - index(typing.Any):The index of the type description within the library - -Returns: - - PyITypeInfo - - """ - pass - - - def GetTypeInfoCount(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetTypeInfoOfGuid(self,iid:'PyIID') -> 'PyITypeInfo': - """ - Retrieves the type info of the specified GUID. - -Args: - - iid(PyIID):GUID of the type description. - -Returns: - - PyITypeInfo - - """ - pass - - - def GetTypeInfoType(self,index:'typing.Any') -> 'typing.Any': - """ - Retrieves the type of a type description. - -Args: - - index(typing.Any):The index of the type description within the library - -Returns: - - typing.Any - - """ - pass - - -class PyIUniformResourceLocator(object): - """Interface to an internet shortcut""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetURL(self,) -> 'typing.Any': - """ - Returns the URL for the shortcut - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetURL(self,URL:'typing.Any',InFlags:'typing.Any'=0) -> 'None': - """ - Sets the URL for the shortcut - -Args: - - URL(typing.Any):The url to be set - InFlags(typing.Any):One of the shellcon.IURL_SETURL* flags - -Returns: - - None - - """ - pass - - - def InvokeCommand(self,Verb:'typing.Any',Flags:'typing.Any'=0,hwndParent:'int'=0) -> 'typing.Any': - """ - Performs one of the object's predefined actions - -Args: - - Verb(typing.Any):The verb to be invoked - Flags(typing.Any):Combination of shellcon.IURL_INVOKECOMMAND_* flags - hwndParent(int):Handle to parent window - -Returns: - - typing.Any - - """ - pass - - -class PyIUnknown(object): - """The base object for all PythonCOM objects. Wraps a COM IUnknown object.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def QueryInterface(self,iid:'typing.Any',useIID:'typing.Any'=None) -> 'PyIUnknown': - """ - Queries an object for a specific interface. - -Args: - - iid(typing.Any):The IID requested. - useIID(typing.Any):If provided and not None, will return an 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.CommentsThe useIID parameter is a very dangerous option, and should only be used when you are sure you need it! 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 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. For example, this option can be used to obtain a PyIUnknown object if pythoncom does not natively support the interface. Another example might be to return an unsupported persistence interface as a PyIPersist instance. 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. Any error (including E_NOINTERFACE) will generate a com_error exception. - -Returns: - - 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. - -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 - -be used when you are sure you need it! - -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 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. - -For example, this option can be used to obtain a PyIUnknown object if - -pythoncom does not natively support the interface. - -Another example might be to return an unsupported persistence interface as a - -PyIPersist instance. - -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. - -Any error (including E_NOINTERFACE) will generate a com_error exception. - - - """ - pass - - -class PyIViewObject(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Draw(self,dwDrawAspect:'typing.Any',lindex:'typing.Any',aspectFlags:'typing.Any',hdcTargetDev:'typing.Any',hdcDraw:'typing.Any',arg:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',arg1:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',funcContinue:'typing.Any',obContinue:'typing.Any') -> 'None': - """ - Description of Draw. - -Args: - - dwDrawAspect(typing.Any):Description for dwDrawAspect - lindex(typing.Any):Description for lindex - aspectFlags(typing.Any):Integer value for the dwFlags item of the DVASPECTINFO structure. - hdcTargetDev(typing.Any):Description for hdcTargetDev - hdcDraw(typing.Any):Description for hdcDraw - arg(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Bounds rectangle. - arg1(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):WBounds rectangle. - funcContinue(typing.Any):A continue function. - obContinue(typing.Any):Value passed to the function. - -Returns: - - None - - """ - pass - - - def GetColorSet(self,dwDrawAspect:'typing.Any',lindex:'typing.Any',aspectFlags:'typing.Any',hicTargetDev:'typing.Any') -> 'None': - """ - Description of GetColorSet. - -Args: - - dwDrawAspect(typing.Any):Description for dwDrawAspect - lindex(typing.Any):Description for lindex - aspectFlags(typing.Any):Integer value for the dwFlags item of the DVASPECTINFO structure. - hicTargetDev(typing.Any):Description for hicTargetDev - -Returns: - - None - - """ - pass - - - def Freeze(self,dwDrawAspect:'typing.Any',lindex:'typing.Any',aspectFlags:'typing.Any') -> 'None': - """ - Description of Freeze. - -Args: - - dwDrawAspect(typing.Any):Description for dwDrawAspect - lindex(typing.Any):Description for lindex - aspectFlags(typing.Any):Integer value for the dwFlags item of the DVASPECTINFO structure. - -Returns: - - None - - """ - pass - - - def Unfreeze(self,dwFreeze:'typing.Any') -> 'None': - """ - Description of Unfreeze. - -Args: - - dwFreeze(typing.Any):Description for dwFreeze - -Returns: - - None - - """ - pass - - - def SetAdvise(self,aspects:'typing.Any',advf:'typing.Any',pAdvSink:'typing.Any') -> 'None': - """ - Description of SetAdvise. - -Args: - - aspects(typing.Any):Description for aspects - advf(typing.Any):Description for advf - pAdvSink(typing.Any):Description for pAdvSink - -Returns: - - None - - """ - pass - - - def GetAdvise(self,) -> 'None': - """ - Description of GetAdvise. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyIViewObject2(object): - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetExtent(self,dwDrawAspect:'typing.Any',lindex:'typing.Any',targetDevice:'typing.Any') -> 'None': - """ - Description of GetExtent. - -Args: - - dwDrawAspect(typing.Any):Description for dwDrawAspect - lindex(typing.Any):Description for lindex - targetDevice(typing.Any):Description for lindex - -Returns: - - None - - """ - pass - - -class PyMAPINAMEIDArray(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyOLEMENUGROUPWIDTHS(object): - """Tuple containing 6 ints indicating nbr of options in each menu group""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyPROPERTYKEY(object): - """A tuple of a fmtid and property id (IID, int) that uniquely identifies a property""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyPROPVARIANT(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def vt(self)->'typing.Any': - """The variant type, a combination of VARENUM values including flags. (read only)MethodsGetValueReturns an object representing the variant value ToStringReturns the value as a string ChangeTypeCoerce to a different variant type """ - pass - - - def GetValue(self,) -> 'typing.Any': - """ - Returns an object representing the variant value - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def ToString(self,) -> 'typing.Any': - """ - Returns the value as a string - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def ChangeType(self,Type:'typing.Any',Flags:'typing.Any'=0) -> 'PyPROPVARIANT': - """ - Coerce to a different variant type - -Args: - - Type(typing.Any):New variant type, combination of pythoncom.VT_* values - Flags(typing.Any):Reserved (PROPVAR_CHANGE_FLAGS)Win32 API References - -Returns: - - PyPROPVARIANT - - """ - pass - - -class PySAndRestriction(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySBinaryArray(object): - """A sequence of strings containing binary data.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySBitMaskRestriction(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySContentRestriction(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySExistRestriction(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySHELL_ITEM_RESOURCE(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySNotRestriction(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySOrRestriction(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySPropTagArray(object): - """A sequence of integers""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySPropValue(object): - """A MAPI property value. Property values can either be passed from - -python into MAPI functions, or returned from MAPI functions to Python.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySPropValueArray(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySPropertyRestriction(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySRestriction(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySRow(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySRowSet(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySSortOrderItem(object): - """An item in a SortOrderSet.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySSortOrderSet(object): - """An object describing a SortOrderSet.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySTGMEDIUM(object): - """A STGMEDIUM object represents a COM STGMEDIUM structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def tymed(self)->'typing.Any': - """An integer indicating the type of data in the stgmedium""" - pass - - - @property - def data(self)->'typing.Any': - """The data in the stgmedium. The result depends on the value of the 'tymed' property of the PySTGMEDIUM object.tymedResult TypeTYMED_GDIAn integer GDI handleTYMED_MFPICTAn integer METAFILE handleTYMED_ENHMFAn integer ENHMETAFILE handleTYMED_HGLOBALA string with the bytes of the global memory object.TYMED_FILEA string/unicode filenameTYMED_ISTREAMA PyIStream objectTYMED_ISTORAGEA PyIStorage object""" - pass - - - @property - def data_handle(self)->'typing.Any': - """The raw 'integer' representation of the data. For TYMED_HGLOBAL, this is the handle rather than the string data. For the string and interface types, this is an integer holding the pointer.""" - pass - - - def set(self,tymed:'typing.Any',data:'typing.Any') -> 'None': - """ - Sets the type and data of the object. - -Args: - - tymed(typing.Any):The type of the data - data(typing.Any): - -Returns: - - None - - """ - pass - - -class PyTASK_TRIGGER(object): - """Python object representing a TASK_TRIGGER structure via the structmember Api""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class RTF_WCSINFO(object): - """A tuple representing a RTF_WCSINFO structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SHFILEINFO(object): - """A tuple representing a SHFILEINFO structure - -Represented as a tuple of (hIcon, iIcon, dwAttributes, displayName, typeName)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SHFILEOPSTRUCT(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SI_ACCESS(object): - """Tuple of 4 items representing SI_ACCESS struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SI_INHERIT_TYPE(object): - """Tuple of 3 items describing a method of inheritance""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SI_OBJECT_INFO(object): - """Six-tuple representing SI_OBJECT_INFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class STATSTG(object): - """A tuple representing a STATSTG structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class TLIBATTR(object): - """Type library attributes are represented as a tuple of:""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class TYPEATTR(object): - """A TYPEATTR object represents a COM TYPEATTR structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def iid(self)->'PyIID': - """The IID""" - pass - - - @property - def lcid(self)->'typing.Any': - """The lcid""" - pass - - - @property - def memidConstructor(self)->'typing.Any': - """ID of constructor""" - pass - - - @property - def memidDestructor(self)->'typing.Any': - """ID of destructor""" - pass - - - @property - def cbSizeInstance(self)->'typing.Any': - """The size of an instance of this type""" - pass - - - @property - def typekind(self)->'typing.Any': - """The kind of type this information describes. One of the win32con.TKIND_* constants.""" - pass - - - @property - def cFuncs(self)->'typing.Any': - """Number of functions.""" - pass - - - @property - def cVars(self)->'typing.Any': - """Number of variables/data members.""" - pass - - - @property - def cImplTypes(self)->'typing.Any': - """Number of implemented interfaces.""" - pass - - - @property - def cbSizeVft(self)->'typing.Any': - """The size of this type's VTBL""" - pass - - - @property - def cbAlignment(self)->'typing.Any': - """Byte alignment for an instance of this type.""" - pass - - - @property - def wTypeFlags(self)->'typing.Any': - """One of the pythoncom TYPEFLAG_""" - pass - - - @property - def wMajorVerNum(self)->'typing.Any': - """Major version number.""" - pass - - - @property - def wMinorVerNum(self)->'typing.Any': - """Minor version number.""" - pass - - - @property - def tdescAlias(self)->'TYPEDESC': - """If TypeKind == pythoncom.TKIND_ALIAS, specifies the type for which this type is an alias.""" - pass - - - @property - def idldeskType(self)->'IDLDESC': - """IDL attributes of the described type.""" - pass - - -class TYPEDESC(object): - """A typedesc is a complicated, recursive 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 ...""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class VARDESC(object): - """A VARDESC object represents a COM VARDESC structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def memid(self)->'typing.Any': - """The dispid of the member""" - pass - - - @property - def value(self)->'typing.Union[typing.Any]': - """A value for the variant. If PERINSTANCE then an offset into the instance, otherwise a variant converted to a Python object.""" - pass - - - @property - def elemdescVar(self)->'ELEMDESC': - """Object describing the member.""" - pass - - - @property - def varFlags(self)->'typing.Any': - """Variable flags""" - pass - - - @property - def varkind(self)->'typing.Any': - """Kind flags.""" - pass - - -class CHARFORMAT(object): - """Describes a CHARFORMAT tuple""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class CREATESTRUCT(object): - """A representation of a Windows CREATESTRUCT structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class LV_COLUMN(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class LV_ITEM(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PARAFORMAT(object): - """Describes a PARAFORMAT tuple""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyAssocCObject(object): - """An internal class.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyAssocObject(object): - """An internal class.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AttachObject(self,) -> 'None': - """ - Attaches a Python object for lookup of "virtual" functions. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetAttachedObject(self,) -> 'typing.Any': - """ - Returned the attached Python object, or None. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyCBitmap(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateCompatibleBitmap(self,dc:'PyCDC',width:'typing.Any',height:'typing.Any') -> 'None': - """ - Creates a bitmap compatible with the specified device context. - -Args: - - dc(PyCDC):Specifies the device context. - width(typing.Any):The width (in bits) of the bitmap - height(typing.Any):The height (in bits) of the bitmap. - -Returns: - - None - - """ - pass - - - def GetSize(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Returns the size of the bitmap object. - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def GetHandle(self,) -> 'typing.Any': - """ - Returns the HBITMAP for a bitmap object - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def LoadBitmap(self,idRes:'typing.Any',obDLL:'PyDLL'=None) -> 'None': - """ - Loads a bitmap from a DLL object. - -Args: - - idRes(typing.Any):The resource ID of the bitmap - obDLL(PyDLL):The DLL object to load from. - -Returns: - - None - - """ - pass - - - def LoadBitmapFile(self,fileObject:'typing.Any') -> 'None': - """ - Loads a bitmap (.BMP) format - -from a file object. - -Args: - - fileObject(typing.Any):The file object to load the .BMP format file from. - -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 - -from a file object. - -Args: - - fileObject(typing.Any):The file object to load the PPM format file from. - cols(typing.Any):The number of columns in the bitmap. - rows(typing.Any):The number of rows in the bitmap. - -Returns: - - None - - """ - pass - - - def Paint(self,dcObject:'PyCDC',arg:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',arg1:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]') -> 'None': - """ - Paint a bitmap. - -Args: - - dcObject(PyCDC):The DC object to paint the bitmap to. - arg(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The destination rectangle to paint to. - arg1(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The source rectangle to paint from. - -Returns: - - None - - """ - pass - - - def GetInfo(self,) -> 'typing.Any': - """ - Returns the BITMAP structure info - -Args: - - - -Returns: - - typing.Any:PyCBitmap.GetInfo - -dict = GetInfo()Returns the BITMAP structure info -Return ValueA dictionary of integers, keyed by the following strings: - -bmType - -bmWidth - -bmHeight - -bmWidthBytes - -bmPlanes - -bmBitsPixel - - - """ - pass - - - def GetBitmapBits(self,asString:'typing.Any'=0) -> 'typing.Union[str, typing.Any]': - """ - Returns the bitmap bits. - -Args: - - asString(typing.Any):If False, the result is a tuple of integers, if True, the result is a Python string - -Returns: - - typing.Union[str, typing.Any] - - """ - pass - - - def SaveBitmapFile(self,dcObject:'PyCDC',Filename:'str') -> 'typing.Any': - """ - Saves a bitmap to a file. - -Args: - - dcObject(PyCDC):The DC object that has rendered the bitmap. - Filename(str):The file to save the bitmap to - -Returns: - - typing.Any - - """ - pass - - -class PyCBrush(object): - """An object encapsulating an MFC PyCBrush class.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateSolidBrush(self,) -> 'None': - """ - Initializes a brush with a specified solid color. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetSafeHandle(self,) -> 'typing.Any': - """ - Retrieves the HBRUSH for the brush as an integer - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyCButton(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,caption:'str',style:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',parent:'PyCWnd',_id:'typing.Any') -> 'None': - """ - Creates the window for a new button object. - -Args: - - caption(str):The caption (text) for the button. - style(typing.Any):The style for the button. Use any of the win32con.BS_* constants. - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The size and position of the button. - parent(PyCWnd):The parent window of the button. Usually a PyCDialog. - _id(typing.Any):The buttons control ID. - -Returns: - - None - - """ - pass - - - def GetBitmap(self,) -> 'typing.Any': - """ - Get the button's bitmap - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetBitmap(self,hBitmap:'typing.Any'=1) -> 'typing.Any': - """ - Set the button's bitmap - -Args: - - hBitmap(typing.Any):Handle of the new bitmap - -Returns: - - typing.Any - - """ - pass - - - def GetCheck(self,) -> 'typing.Any': - """ - Retrieves the check state of a radio button or check box. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetCheck(self,idCheck:'typing.Any') -> 'None': - """ - Sets or resets the state of a radio button or check box. - -Args: - - idCheck(typing.Any):The ID of the button. - -Returns: - - None - - """ - pass - - - def GetState(self,) -> 'typing.Any': - """ - Returns the state of the button. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetState(self,bHighlight:'typing.Any') -> 'typing.Any': - """ - Sets the state of the button. - -Args: - - bHighlight(typing.Any):The new state for the button.CommentsHighlighting affects the exterior of a button control. It has no effect on the check state of a radio button or check box. - -Returns: - - typing.Any - - """ - pass - - - def GetButtonStyle(self,) -> 'typing.Any': - """ - Gets the style of the button. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetButtonStyle(self,style:'typing.Any',bRedraw:'typing.Any'=1) -> 'typing.Any': - """ - Sets the style of the button. - -Args: - - style(typing.Any):The new style for the button. - bRedraw(typing.Any):Should the button be redrawn? - -Returns: - - typing.Any - - """ - pass - - -class PyCCmdTarget(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def BeginWaitCursor(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def EndWaitCursor(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def HookCommand(self,obHandler:'typing.Any',_id:'typing.Any') -> 'typing.Any': - """ - Hook a windows command handler. - -Args: - - obHandler(typing.Any):The handler for the command message. This must be a callable object. - _id(typing.Any):The ID of the command to be handled, or zero to handle all command messages.CommentsobHandler 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. When updating a user interface element, Pythonwin will first check if a handler has been installed via PyCCmdTarget::HookCommandUpdate. If so, this alone 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 The handler will be called with 2 arguments * The command id being handled. * The command notification code. If the handler returns TRUE, then the command will be passed on to the default handler, otherwise the message will be consumed. This method is best suited to handling messages from user interface elements, such as menus, toolbars, etc. To handle notification messages from a control, you should use PyCCmdTarget::HookNotifyReturn ValueThe return value is the previous handler, or None. - -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. - -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 - -handler has been installed via PyCCmdTarget::HookCommandUpdate. If so, this alone - -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 - -The handler will be called with 2 arguments - -* The command id being handled. - -* The command notification code. - -If the handler returns TRUE, then the command will be passed on to the - -default handler, otherwise the message will be consumed. - -This method is best suited to handling messages from user interface - -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 - - - def HookCommandUpdate(self,obHandler:'typing.Any',_id:'typing.Any') -> 'typing.Any': - """ - Hook a windows command update handler. - -Args: - - obHandler(typing.Any):The handler for the command message. This must be a callable object. - _id(typing.Any):The ID of the command to be handled.CommentsThe handler object passed will be called as the application updates user interface elements with the specified ID. 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. - -Returns: - - typing.Any:The ID of the command to be handled.Comments - -The handler object passed will be called as - -the application updates user interface elements - -with the specified ID. - -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 - - - def HookOleEvent(self,) -> 'typing.Any': - """ - Hook an OLE Event. - -Args: - - - -Returns: - - typing.Any:PyCCmdTarget.HookOleEvent - -object = HookOleEvent()Hook an OLE Event. -Return ValueThe return value is the previous handler, or None. - - - """ - pass - - - def HookNotify(self,obHandler:'typing.Any',_id:'typing.Any') -> 'typing.Any': - """ - Hook a windows command handler. - -Args: - - obHandler(typing.Any):The handler for the command message. This must be a callable object. - _id(typing.Any):The ID of the command to be handled, or zero to handle all command messages.CommentsobHandler will be called as the application receives control notification messages. 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 A tuple describing standard notification information. 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, otherwise the message will be consumed.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 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 can install certain knowledge about handlers, but this has not been implemented.)Return ValueThe return value is the previous handler, or None. - -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. - -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 - -A tuple describing standard notification information. - -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, - -otherwise the message will be consumed. - -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 - -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 - -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 - -changed. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCCmdUI(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def m_nIndex(self)->'typing.Any': - """""" - pass - - - @property - def m_nID(self)->'typing.Any': - """""" - pass - - - @property - def m_pMenu(self)->'PyCMenu': - """""" - pass - - - @property - def m_pSubMenu(self)->'PyCMenu': - """""" - pass - - - def Enable(self,bEnable:'typing.Any'=1) -> 'None': - """ - Enables or disables the user-interface item for this command. - -Args: - - bEnable(typing.Any):TRUE if the item should be enabled, false otherwise. - -Returns: - - None - - """ - pass - - - def SetCheck(self,state:'typing.Any'=1) -> 'None': - """ - Sets the check state of the user-interface item for this command. - -Args: - - state(typing.Any):0 for unchecked, 1 for checked, or 2 for indeterminate. - -Returns: - - None - - """ - pass - - - def SetRadio(self,bOn:'typing.Any'=1) -> 'None': - """ - Like the SetCheck member function, but operates on radio groups. - -Args: - - bOn(typing.Any):TRUE if the item should be enabled, false otherwise. - -Returns: - - None - - """ - pass - - - def SetText(self,text:'str') -> 'None': - """ - Sets the text for the user-interface item for this command. - -Args: - - text(str):The text for the interface element. - -Returns: - - None - - """ - pass - - - def ContinueRouting(self,) -> 'None': - """ - Tells the command-routing mechanism to continue routing the current message down - -the chain of handlers. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCColorDialog(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetColor(self,) -> 'typing.Any': - """ - Determines the selected color. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def DoModal(self,) -> 'typing.Any': - """ - Displays a dialog and allows the user to make a selection. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetSavedCustomColors(self,) -> 'typing.Any': - """ - Returns the saved custom colors. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetCurrentColor(self,color:'typing.Any') -> 'None': - """ - Sets the currently selected color. - -Args: - - color(typing.Any):The color to set.MFC References - -Returns: - - None - - """ - pass - - - def SetCustomColors(self,) -> 'None': - """ - Sets one or more custom colors - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCustomColors(self,) -> 'typing.Tuple[typing.Any, ...]': - """ - Gets the 16 currently defined custom colors - -Args: - - - -Returns: - - typing.Tuple[typing.Any, ...] - - """ - pass - - -class PyCComboBox(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddString(self,_object:'typing.Any') -> 'typing.Any': - """ - Adds a string to a combobox. - -Args: - - _object(typing.Any):Any object. If not a string, __str__, __repr__ or a default repr() will be usedMFC References - -Returns: - - typing.Any:CComboBox::AddString -Return ValueThe zero based index of the new string. - - - """ - pass - - - def DeleteString(self,pos:'typing.Any') -> 'typing.Any': - """ - Deletes an item from a combobox. - -Args: - - pos(typing.Any):The zero based index of the item to delete.MFC References - -Returns: - - typing.Any:CComboBox::DeleteString -Return ValueThe count of the items remaining in the list. - - - """ - pass - - - def Dir(self,attr:'typing.Any',wild:'str') -> 'typing.Any': - """ - Fills the list portion of a combobox with a directory listing. - -Args: - - attr(typing.Any):The attributes of the files to locate - wild(str):A file specification string - eg, *.*MFC References - -Returns: - - typing.Any:CComboBox::Dir -Return ValueThe index of the last file name added to the list. - - - """ - pass - - - def GetCount(self,) -> 'typing.Any': - """ - Returns the count of items in the combobox. - -Args: - - - -Returns: - - typing.Any:CListBox::GetCount -Return ValueReturns the number of items currently in the combobox. - - - """ - pass - - - def GetCurSel(self,) -> 'typing.Any': - """ - Returns the index of the currently selected item. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetEditSel(self,) -> 'typing.Any': - """ - Returns the selection of the edit control portion of a combo box. - -Args: - - - -Returns: - - typing.Any:CComboBox::GetEditSel -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 selection in the high-order word. If this function is used on a combo box - -without an edit control, an exception is raised. - - - """ - pass - - - def GetExtendedUI(self,) -> 'typing.Any': - """ - Indicates if the combo has the extended interface. - -Args: - - - -Returns: - - typing.Any:CComboBox::GetExtendedUI -Return ValueNonzero if the combo box has the extended user interface; otherwise 0. - - - """ - pass - - - def GetItemData(self,item:'typing.Any') -> 'typing.Any': - """ - Retrieves the application-specific object associated with an item. - -Args: - - item(typing.Any):The index of the item whose data is to be retrieved. - -Returns: - - typing.Any - - """ - pass - - - def GetItemValue(self,item:'typing.Any') -> 'typing.Any': - """ - Retrieves the application-specific value associated with an item. - -Args: - - item(typing.Any):The index of the item whose data is to be retrieved. - -Returns: - - typing.Any - - """ - pass - - - def GetLBText(self,index:'typing.Any') -> 'str': - """ - Gets the string from the list of a combo box. - -Args: - - index(typing.Any):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. - -Returns: - - 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 - - - def GetLBTextLen(self,index:'typing.Any') -> 'typing.Any': - """ - Returns the length of a string in the list of a combobox. - -Args: - - index(typing.Any):The index of the item to return the length of.MFC References - -Returns: - - typing.Any - - """ - pass - - - def InsertString(self,pos:'typing.Any',_object:'typing.Any') -> 'typing.Any': - """ - Insert a string into a combobox. - -Args: - - pos(typing.Any):The zero based index in the combobox to insert the new string - _object(typing.Any):The object to be added to the comboboxMFC References - -Returns: - - typing.Any:CComboBox::InsertString -Return ValueThe zero based index of the new string added. - - - """ - pass - - - def LimitText(self,_max:'typing.Any') -> 'typing.Any': - """ - Limits the amount of text the edit portion of a combo box can hold. - -Args: - - _max(typing.Any):The maximum number of characters the user can enter. If zero, the size is set to (virtually) unlimited.MFC References - -Returns: - - typing.Any - - """ - pass - - - def ResetContent(self,) -> 'None': - """ - Clear all the items from a combobox. - -Args: - - - -Returns: - - None - - """ - pass - - - def SelectString(self,after:'typing.Any',string:'str') -> 'None': - """ - Searches for a combobox item that matches the specified string, and selects it. - -Args: - - after(typing.Any):Contains the zero-based index of the item before the first item to be searched, or -1 for the entire combobox. - string(str):The string to search for.MFC References - -Returns: - - None:CComboBoxBox::SelectString -Return ValueThe return value is always None - an exception is raised if the string can not be located. - - - """ - pass - - - def SetCurSel(self,index:'typing.Any') -> 'None': - """ - Selects an item in a combobox. - -Args: - - index(typing.Any):The zero based index of the item to select.MFC References - -Returns: - - None - - """ - pass - - - def SetEditSel(self,start:'typing.Any',end:'typing.Any') -> 'None': - """ - Sets the selection in the edit control portion of a combo box. - -Args: - - start(typing.Any):Specifies the starting position. If the starting position is set to -1, then any existing selection is removed. - end(typing.Any):Specifies the ending position. If the ending position is set to -1, then all text from the starting position to the last character in the edit control is selected.MFC References - -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 - -have an edit control. - - - """ - pass - - - def SetExtendedUI(self,bExtended:'typing.Any'=1) -> 'None': - """ - Selects the Extended UI mode for a combo box. - -Args: - - bExtended(typing.Any):Indicates if the combo should have the extended user interface.CommentsA combo box with the Extended UI flag set can be identified in the following ways:~ Clicking the static control displays the list box only for combo boxes with the CBS_DROPDOWNLIST style.~ Pressing the DOWN ARROW key displays the list box (F4 is disabled).~ Scrolling in the static control is disabled when the item list is not visible (the arrow keys are disabled).MFC References - -Returns: - - None - - """ - pass - - - def SetItemData(self,item:'typing.Any',Data:'typing.Any') -> 'typing.Any': - """ - Sets the item's application-specific object value. - -Args: - - item(typing.Any):Index of the item whose Data is to be set. - Data(typing.Any):New value for the data.CommentsNote that a reference count is not added to the object. This it is your responsibility to make sure the object remains alive while in the list. - -Returns: - - typing.Any - - """ - pass - - - def SetItemValue(self,item:'typing.Any',data:'typing.Any') -> 'typing.Any': - """ - Sets the item's application-specific value. - -Args: - - item(typing.Any):Index of the item whose Data is to be set. - data(typing.Any):New value for the data. - -Returns: - - typing.Any - - """ - pass - - - def ShowDropDown(self,bShowIt:'typing.Any'=1) -> 'None': - """ - Shows or hides the listbox portion of a combo box. - -Args: - - bShowIt(typing.Any):Indicates if the listbox should be shown or hidden. - -Returns: - - None - - """ - pass - - -class PyCCommonDialog(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCControl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCControlBar(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def dockSite(self)->'PyCFrameWnd': - """Current dock site, if dockable""" - pass - - - @property - def dockBar(self)->'PyCWnd': - """Current dock bar, if dockable""" - pass - - - @property - def dockContext(self)->'PyCDockContext': - """Used during dragging""" - pass - - - @property - def dwStyle(self)->'typing.Any': - """creation style (used for layout)""" - pass - - - @property - def dwDockStyle(self)->'typing.Any': - """indicates how bar can be docked""" - pass - - - def CalcDynamicLayout(self,length:'typing.Any',dwMode:'typing.Any') -> 'typing.Any': - """ - The framework calls this member function to calculate the dimensions of - -a dynamic toolbar. - -Args: - - length(typing.Any):The requested dimension of the control bar, either horizontal or vertical, depending on dwMode. - dwMode(typing.Any):A combination of flags. - -Returns: - - typing.Any - - """ - pass - - - def CalcFixedLayout(self,bStretch:'typing.Any',bHorz:'typing.Any') -> 'typing.Any': - """ - Calculates the horizontal size of a control bar - -Args: - - bStretch(typing.Any):Indicates whether the bar should be stretched to the size of the frame. The bStretch parameter is nonzero when the bar is not a docking bar (not available for docking) and is 0 when it is docked or floating (available for docking). - bHorz(typing.Any):Indicates that the bar is horizontally or vertically oriented. - -Returns: - - typing.Any - - """ - pass - - - def EnableDocking(self,style:'typing.Any') -> 'None': - """ - pecifies whether the control bar supports docking and the sides of its parent - -window. - -Args: - - style(typing.Any):Enables a control bar to be docked. - -Returns: - - None - - """ - pass - - - def EraseNonClient(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def GetBarStyle(self,) -> 'typing.Any': - """ - Retrieves the control bar style settings. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetCount(self,) -> 'typing.Any': - """ - Returns the number of non-HWND elements in the control bar. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetDockingFrame(self,) -> 'PyCFrameWnd': - """ - Returns the frame window to which a control bar is docked. - -Args: - - - -Returns: - - PyCFrameWnd - - """ - pass - - - def IsFloating(self,) -> 'typing.Any': - """ - Returns a nonzero value if the control bar in question is a floating control - -bar. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetBarStyle(self,style:'typing.Any') -> 'None': - """ - Modifies the control bar style settings. - -Args: - - style(typing.Any):The new style - -Returns: - - None - - """ - pass - - - def ShowWindow(self,) -> 'typing.Any': - """ - Shows the toolbar, and recalculates the button layout. - -Args: - - - -Returns: - - typing.Any:PyCControlBar.ShowWindow - -int = ShowWindow()Shows the toolbar, and recalculates the button layout. -Comments - -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 - - -class PyCCtrlView(object): - """A class which implementes a CCtrlView (ie, a view based on a dialog resource.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OnCommand(self,wparam:'typing.Any',lparam:'typing.Any') -> 'None': - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(typing.Any): - lparam(typing.Any):See Also - -Returns: - - None - - """ - pass - - -class PyCDC(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AbortDoc(self,) -> 'None': - """ - Aborts a print job - -Args: - - - -Returns: - - None - - """ - pass - - - def Arc(self,rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',pointStart:'typing.Tuple[typing.Any, typing.Any]',pointEnd:'typing.Tuple[typing.Any, typing.Any]') -> 'None': - """ - Draws an eliptical arc. - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Specifies the ellipse's bounding rectangle - pointStart(typing.Tuple[typing.Any, typing.Any]):Specifies the x- and y-coordinates of the point that defines the arc's starting point (in logical units). This point does not have to lie exactly on the arc. - pointEnd(typing.Tuple[typing.Any, typing.Any]):Specifies the x- and y-coordinates of the point that defines the arc's ending point (in logical units). This point does not have to lie exactly on the arc.CommentsThe arc drawn by using the function is a segment of the ellipse defined by the specified bounding rectangle. The actual starting point of the arc is the point at which a ray drawn from the center of the bounding rectangle through the specified starting point intersects the ellipse. The actual ending point of the arc is the point at which a ray drawn from the center of the bounding rectangle through the specified ending point intersects the ellipse. The arc is drawn in a counterclockwise direction. Since an arc is not a closed figure, it is not filled. Both the width and height of the rectangle must be greater than 2 units and less than 32,767 units.MFC References - -Returns: - - None:CDC::Arc -Return ValueAlways none. If the function fails, an exception is raised. - - - """ - pass - - - def BeginPath(self,) -> 'None': - """ - Opens a path bracket in the device context - -Args: - - - -Returns: - - None - - """ - pass - - - def BitBlt(self,destPos:'typing.Tuple[typing.Any, typing.Any]',size:'typing.Tuple[typing.Any, typing.Any]',dc:'PyCDC',srcPos:'typing.Tuple[typing.Any, typing.Any]',rop:'typing.Any') -> 'None': - """ - Copies a bitmap from the source device context to this device context. - -Args: - - destPos(typing.Tuple[typing.Any, typing.Any]):The logical x,y coordinates of the upper-left corner of the destination rectangle. - size(typing.Tuple[typing.Any, typing.Any]):Specifies the width and height (in logical units) of the destination rectangle and source bitmap. - dc(PyCDC):Specifies the PyCDC object from which the bitmap will be copied. It must be None if rop specifies a raster operation that does not include a source. - srcPos(typing.Tuple[typing.Any, typing.Any]):Specifies the logical x,y coordinates of the upper-left corner of the source bitmap. - rop(typing.Any):Specifies the raster operation to be performed. See the win32 api documentation for details.MFC References - -Returns: - - None - - """ - pass - - - def Chord(self,rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',pointStart:'typing.Tuple[typing.Any, typing.Any]',pointEnd:'typing.Tuple[typing.Any, typing.Any]') -> 'None': - """ - Draws a chord. - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Specifies the ellipse's bounding rectangle - pointStart(typing.Tuple[typing.Any, typing.Any]):Specifies the x- and y-coordinates of the point that defines the arc's starting point (in logical units). This point does not have to lie exactly on the arc. - pointEnd(typing.Tuple[typing.Any, typing.Any]):Specifies the x- and y-coordinates of the point that defines the arc's ending point (in logical units). This point does not have to lie exactly on the arc.CommentsDraws a chord (a closed figure bounded by the intersection of an ellipse and a line segment). The rect parameter specify the upper-left and lower-right corners, respectively, of a rectangle bounding the ellipse that is part of the chord. The pointStart and pointEnd parameters specify the endpoints of a line that intersects the ellipse. The chord is drawn by using the selected pen and filled by using the selected brush.MFC References - -Returns: - - None:CDC::Chord -Return ValueAlways none. If the function fails, an exception is raised. - - - """ - pass - - - def CreateCompatibleDC(self,dcFrom:'PyCDC'=None) -> 'None': - """ - Creates a memory device context that is compatible with this DC. - -Args: - - dcFrom(PyCDC):The source DC, or None to make a screen compatible DC.CommentsNote that unlike the MFC version, this function calls the global CreateCompatibleDC function and returns a new PyCDC object.MFC References - -Returns: - - None - - """ - pass - - - def CreatePrinterDC(self,printerName:'str'=None) -> 'None': - """ - Creates a device context for a specific printer - -Args: - - printerName(str):The printer name, or None for the default printerMFC References - -Returns: - - None - - """ - pass - - - def DeleteDC(self,) -> 'None': - """ - Deletes all resources associated with a device context. - -Args: - - - -Returns: - - None - - """ - pass - - - def DPtoLP(self,point:'typing.Tuple[typing.Any, typing.Any]',x:'typing.Any',y:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Converts device units into logical units. - -Args: - - point(typing.Tuple[typing.Any, typing.Any]):The point to convertAlternative Parameters - x(typing.Any):The x coordinate to convert. - y(typing.Any):The y coordinate to convert.MFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any]:CDC::DPtoLP - To Do Should really handle list of (x,y) points -Return ValueThe converted coordinates. - - - """ - pass - - - def Draw3dRect(self,rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',colorTopLeft:'typing.Any',colorBotRight:'typing.Any') -> 'None': - """ - Draws a three-dimensional rectangle. - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Specifies the bounding rectangle, in logical units. - colorTopLeft(typing.Any):Specifies the color of the top and left sides of the three-dimensional rectangle. - colorBotRight(typing.Any):Specifies the color of the bottom and right sides of the three-dimensional rectangle.MFC References - -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 - -indicate the rectangle has focus - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The coordinates of the rectangleMFC References - -Returns: - - None - - """ - pass - - - def DrawFrameControl(self,rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',typ:'typing.Any',state:'typing.Any') -> 'None': - """ - Draws a frame control of the specified type and style. - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Specifies the bounding rectangle, in logical units. - typ(typing.Any): - state(typing.Any):MFC References - -Returns: - - None - - """ - pass - - - def DrawIcon(self,point:'typing.Tuple[typing.Any, typing.Any]',hIcon:'int') -> 'None': - """ - Draws an icon on the DC. - -Args: - - point(typing.Tuple[typing.Any, typing.Any]):The point coordinate to draw to. - hIcon(int):The handle of the icon to draw.MFC References - -Returns: - - None - - """ - pass - - - def DrawText(self,s:'str',_tuple:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',_format:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': - """ - Formats text in the given rectangle - -Args: - - s(str):The desired output string - _tuple(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The bounding rectangle in the form: (left, top, right, bottom) expressed in logical units (depending on selected coordinate system - see PyCDC::SetMapMode) - _format(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 the Microsoft Win32 API documentation.ExampleExampleimport win32ui<nl> import win32con<nl> INCH = 1440 # twips - 1440 per inch allows fine res<nl> def drawtext_test():<nl> dc = win32ui.CreateDC()<nl> dc.CreatePrinterDC() # ties to default printer<nl> dc.StartDoc('My Python Document')<nl> dc.StartPage()<nl> <nl> # note: upper left is 0,0 with x increasing to the right,<nl> # and y decreasing (negative) moving down<nl> dc.SetMapMode(win32con.MM_TWIPS)<nl> <nl> # Centers "TEST" about an inch down on page<nl> dc.DrawText('TEST', (0,INCH*-1,INCH*8,INCH*-2), win32con.DT_CENTER )<nl> dc.EndPage()<nl> dc.EndDoc()<nl> del dc<nl>Return ValueHeight of text in pixelsThe return value is the height of the text, in logical units. If DT_VCENTER or DT_BOTTOM is specified, the return value is the 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) - -Returns: - - 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 - -the Microsoft Win32 API documentation.ExampleExample -import win32ui<nl> - - import win32con<nl> - - INCH = 1440 # twips - 1440 per inch allows fine res<nl> - - def drawtext_test():<nl> - - dc = win32ui.CreateDC()<nl> - - dc.CreatePrinterDC() # ties to default printer<nl> - - dc.StartDoc('My Python Document')<nl> - - dc.StartPage()<nl> - - <nl> - - # note: upper left is 0,0 with x increasing to the right,<nl> - - # and y decreasing (negative) moving down<nl> - - dc.SetMapMode(win32con.MM_TWIPS)<nl> - - <nl> - - # Centers "TEST" about an inch down on page<nl> - - dc.DrawText('TEST', (0,INCH*-1,INCH*8,INCH*-2), win32con.DT_CENTER )<nl> - - dc.EndPage()<nl> - - dc.EndDoc()<nl> - - del dc<nl> - - -Return ValueHeight of text in pixels - - - -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 - -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 - - - def Ellipse(self,rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]') -> 'None': - """ - Draws an Ellipse. - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Specifies the ellipse's bounding rectangleCommentsThe center of the ellipse is the center of the bounding rectangle specified by rect. The ellipse is drawn with the current pen, and its interior is filled with the current brush.MFC References - -Returns: - - None:CDC::Ellipse -Return ValueAlways none. If the function fails, an exception is raised. - - - """ - pass - - - def EndDoc(self,) -> 'None': - """ - Finishes spooling the document and starts printing it - -Args: - - - -Returns: - - None - - """ - pass - - - def EndPage(self,) -> 'None': - """ - Finishes a page on a printer DC - -Args: - - - -Returns: - - None - - """ - pass - - - def EndPath(self,) -> 'None': - """ - Closes a path bracket and selects the path defined by the bracket into the specified device - -context - -Args: - - - -Returns: - - None - - """ - pass - - - def ExtTextOut(self,_int:'typing.Any',_int1:'typing.Any',_int2:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',string:'typing.Any',_tuple:'typing.Tuple[typing.Tuple[typing.Any, typing.Any], ...]') -> 'None': - """ - Writes text to the DC. - -Args: - - _int(typing.Any):The x coordinate to write the text to. - _int1(typing.Any):The y coordinate to write the text to. - _int2(typing.Any):Specifies the rectangle type. This parameter can be one, both, or neither of ETO_CLIPPED and ETO_OPAQUE - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Specifies the text's bounding rectangle. (Can be None.) - string(typing.Any):The text to write. - _tuple(typing.Tuple[typing.Tuple[typing.Any, typing.Any], ...]):Optional array of values that indicate distance between origins of character cells.MFC References - -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 - -current brush and polygon-filling mode. After its interior is filled, the path is discarded from the device context. - -Args: - - - -Returns: - - None - - """ - pass - - - def FillRect(self,rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',brush:'PyCBrush') -> 'None': - """ - Fills a given rectangle with the specified brush - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Specifies the bounding rectangle, in logical units. - brush(PyCBrush):Specifies the brush to use.MFC References - -Returns: - - None - - """ - pass - - - def FillSolidRect(self,rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',color:'typing.Any') -> 'None': - """ - Fills the given rectangle with the specified solid color. - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Specifies the bounding rectangle, in logical units. - color(typing.Any):Specifies the color to use.MFC References - -Returns: - - None - - """ - pass - - - def FrameRect(self,rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',brush:'PyCBrush') -> 'None': - """ - Draws a border around the rectangle specified by rect - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Specifies the bounding rectangle, in logical units. - brush(PyCBrush):Specifies the brush to use.MFC References - -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 - -device context. - -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 - -around the current clipping boundary. - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]:CDC::GetClipBox -Return ValueA tuple of integers specifying the rectangle. - - - """ - pass - - - def GetCurrentPosition(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Retrieves the current position (in logical coordinates). - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def GetDeviceCaps(self,index:'typing.Any') -> 'typing.Any': - """ - Retrieves a capability of the device context. - -Args: - - index(typing.Any):The information requested. See the win32api documentation for details.MFC References - -Returns: - - typing.Any:CDC::GetDeviceCaps -Return ValueThe value of the requested capability - - - """ - pass - - - def GetHandleAttrib(self,) -> 'typing.Any': - """ - Retrieves the handle of the attribute device context. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetHandleOutput(self,) -> 'typing.Any': - """ - Retrieves the handle of the output device context. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetMapMode(self,) -> 'typing.Any': - """ - Gets the mapping mode for the device context. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetNearestColor(self,color:'typing.Any') -> 'typing.Any': - """ - Returns the closest color a device can map. - -Args: - - color(typing.Any):Specifies the color to be matched. - -Returns: - - typing.Any - - """ - pass - - - def GetPixel(self,x:'typing.Any',y:'typing.Any') -> 'None': - """ - Gets a pixel at a local in a device context - -Args: - - x(typing.Any):Horizontal coordinate. - y(typing.Any):Vertical coordinate. - -Returns: - - None - - """ - pass - - - def GetSafeHdc(self,) -> 'typing.Any': - """ - Returns the HDC of this DC object. - -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 - -determine the dimensions. - -Args: - - text(str):The text to calculate for.MFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any]:CFC::GetTextExtent -Return ValueA tuple of integers with the size of the string, in logical units. - - - """ - pass - - - def GetTextExtentPoint(self,text:'str') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - None - -Args: - - text(str):The text to calculate for.Return ValueA tuple of integers with the size of the string, in logical units. - -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 - - - def GetTextFace(self,) -> 'str': - """ - Returns typeface name of the current font. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetTextMetrics(self,) -> 'typing.Any': - """ - Retrieves the metrics for the current font in this device context. - -Args: - - - -Returns: - - typing.Any:CDC::GetTextMetrics -Return ValueA dictionary of integers, keyed by the following strings: - -tmHeight - -tmAscent - -tmDescent - -tmInternalLeading - -tmExternalLeading - -tmAveCharWidth - -tmMaxCharWidth - -tmWeight - -tmItalic - -tmUnderlined - -tmStruckOut - -tmFirstChar - -tmLastChar - -tmDefaultChar - -tmBreakChar - -tmPitchAndFamily - -tmCharSet - -tmOverhang - -tmDigitizedAspectX - -tmDigitizedAspectY - - - """ - pass - - - def GetViewportExt(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Gets the viewport extent of the device context - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def GetViewportOrg(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Gets the viewport origin of the device context - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def GetWindowExt(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Gets the window extent of the device context - -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 - -device context. - -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 - -and the rectangle specified - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Specifies the bounding rectangle, in logical units.MFC References - -Returns: - - None:CDC::IntersectClipRect -Return Valueregion type as integer - - - """ - pass - - - def IsPrinting(self,) -> 'typing.Any': - """ - Returns 1 if the DC is currently printing, else 0 - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def LineTo(self,point:'typing.Tuple[typing.Any, typing.Any]',x:'typing.Any',y:'typing.Any') -> 'None': - """ - Draws a line to a specified point, using the currently selected pen. - -Args: - - point(typing.Tuple[typing.Any, typing.Any]):The point coordinate to draw to.Alternative Parameters - x(typing.Any):The x coordinate to draw to. - y(typing.Any):The y coordinate to draw to.MFC References - -Returns: - - None - - """ - pass - - - def LPtoDP(self,point:'typing.Tuple[typing.Any, typing.Any]',x:'typing.Any',y:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Converts logical units into device units. - -Args: - - point(typing.Tuple[typing.Any, typing.Any]):The point coordinate to convert.Alternative Parameters - x(typing.Any):The x coordinate to convert. - y(typing.Any):The y coordinate to convert.MFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any]:CDC::LPtoDP -Return ValueThe converted coordinates. - - - """ - pass - - - def MoveTo(self,point:'typing.Tuple[typing.Any, typing.Any]',x:'typing.Any',y:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Moves the current position to a specified point. - -Args: - - point(typing.Tuple[typing.Any, typing.Any]):The point coordinate to move to.Alternative Parameters - x(typing.Any):The x coordinate to move to. - y(typing.Any):The y coordinate to move to.MFC References - -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 - -current window origin. - -Args: - - arg(typing.Tuple[typing.Any, typing.Any]):The new origin offset.Return ValueThe previous origin as a tuple (x,y) - -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 - -the current viewport origin - -Args: - - arg(typing.Tuple[typing.Any, typing.Any]):The new origin offset.Return ValueThe previous viewport origin as a tuple (x,y) - -Returns: - - typing.Tuple[typing.Any, typing.Any]:The new origin offset.Return ValueThe previous viewport origin as a tuple (x,y) - - - """ - pass - - - def PatBlt(self,destPos:'typing.Tuple[typing.Any, typing.Any]',size:'typing.Tuple[typing.Any, typing.Any]',rop:'typing.Any') -> 'None': - """ - Creates a bit pattern on the device. - -Args: - - destPos(typing.Tuple[typing.Any, typing.Any]):The logical x,y coordinates of the upper-left corner of the destination rectangle. - size(typing.Tuple[typing.Any, typing.Any]):Specifies the width and height (in logical units) of the destination rectangle and source bitmap. - rop(typing.Any):Specifies the raster operation to be performed. See the win32 api documentation for details.MFC References - -Returns: - - None - - """ - pass - - - def Pie(self,x1:'typing.Any',y1:'typing.Any',x2:'typing.Any',y2:'typing.Any',x3:'typing.Any',y3:'typing.Any',x4:'typing.Any',y4:'typing.Any') -> 'None': - """ - Draws a pie slice in a device context - -Args: - - x1(typing.Any):X coordinate of upper left corner - y1(typing.Any):Y coordinate of upper left corner - x2(typing.Any):X coordinate of lower right corner - y2(typing.Any):Y coordinate of lower right corner - x3(typing.Any):X coordinate of starting point of arc - y3(typing.Any):Y coordinate of starting point of arc - x4(typing.Any):X coordinate of ending point of arc - y4(typing.Any):Y coordinate of ending point of arc - -Returns: - - None - - """ - pass - - - def PolyBezier(self,) -> 'None': - """ - Draws one or more Bezier splines. - -Args: - - - -Returns: - - None - - """ - pass - - - def Polygon(self,) -> 'None': - """ - Draws an Polygon. - -Args: - - - -Returns: - - None - - """ - pass - - - def Polyline(self,points:'typing.List[typing.Tuple[typing.Any, typing.Any]]') -> 'None': - """ - Draws a Polyline. - -Args: - - points(typing.List[typing.Tuple[typing.Any, typing.Any]]):A sequence of points - -Returns: - - None - - """ - pass - - - def RealizePalette(self,) -> 'typing.Any': - """ - Maps palette entries in the current logical palette to the system palette. - -Args: - - - -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 - -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 - -was last realized. - - - """ - pass - - - def Rectangle(self,) -> 'typing.Any': - """ - Draws a rectangle using the current pen. The interior of the rectangle is filled using - -the current brush. - -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 - -the display context. - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The coordinates of the reactangle to be checked.MFC References - -Returns: - - typing.Any:CDC::RectVisible -Return ValueNon zero if any part of the rectangle lies within the clipping region, else zero. - - - """ - pass - - - def RestoreDC(self,saved:'typing.Any') -> 'None': - """ - Restores the state of the device context. - -Args: - - saved(typing.Any):The id of a previously saved device context. See PyCDC::SaveDCMFC References - -Returns: - - None - - """ - pass - - - def SaveDC(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any:CDC::SaveDC -Return ValueAn integer identifying the context, which can be used by PyCDC::RestoreDC. - -An exception is raised if this function fails. - - - """ - pass - - - def ScaleWindowExt(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Modifies the window extents relative to the current values. - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def ScaleViewportExt(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Modifies the viewport extents relative to the current values. - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def SelectClipRgn(self,) -> 'typing.Any': - """ - Selects the given region as the current clipping region for the device context - -Args: - - - -Returns: - - typing.Any:PyCDC.SelectClipRgn - -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 - - - def SelectObject(self,ob:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - ob(typing.Any):The object to select.MFC References - -Returns: - - typing.Any:CDC::SelectObject -Return ValueThe previously selected object. This will be the same type as the object parameter. - - - """ - pass - - - def SetBkColor(self,color:'typing.Any') -> 'typing.Any': - """ - Sets the current background color to the specified color. - -Args: - - color(typing.Any):A windows color specification. See the win32api documentation for details.CommentsIf the background mode is OPAQUE, the system uses the background color to fill the gaps in styled lines, the gaps between hatched lines in brushes, and the background in character cells. The system also uses the background color when converting bitmaps between color and monochrome device contexts.MFC References - -Returns: - - typing.Any:CDC::SetBkColor -Return ValueThe return value is the previous background color. - - - """ - pass - - - def SetBkMode(self,mode:'typing.Any') -> 'typing.Any': - """ - Sets the current background mode to the specified mode. - -Args: - - mode(typing.Any):A background mode. May be either TRANSPARENT or OPAQUE.CommentsSpecifies the mode to be set. This parameter can be either OPAQUE or TRANSPARENTMFC References - -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 - -application selects into the device context. - -Args: - - point(typing.Tuple[typing.Any, typing.Any]):The new origin in device units.MFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any]:CDC::SetBrushOrg -Return ValueThe previous origin in device units. - - - """ - pass - - - def SetGraphicsMode(self,mode:'typing.Any') -> 'typing.Any': - """ - Sets the graphics mode for the specified device context - -Args: - - mode(typing.Any):The new mode. - -Returns: - - typing.Any - - """ - pass - - - def SetMapMode(self,newMode:'typing.Any') -> 'typing.Any': - """ - Sets the mapping mode for the device context. - -Args: - - newMode(typing.Any):The new mode. Can be one of MM_ANISOTROPIC, MM_HIENGLISH, MM_HIMETRIC, MM_ISOTROPIC, MM_LOENGLISH, MM_LOMETRIC, MM_TEXT, MM_TWIPSMFC References - -Returns: - - typing.Any:CDC::SetMapMode -Return ValueThe previous mapping mode. - - - """ - pass - - - def SetPixel(self,x:'typing.Any',y:'typing.Any',color:'typing.Any') -> 'None': - """ - Sets a pixel in a device context - -Args: - - x(typing.Any):Horizontal coordinate. - y(typing.Any):Vertical coordinate. - color(typing.Any):The brush color. - -Returns: - - None - - """ - pass - - - def SetPolyFillMode(self,point:'typing.Tuple[typing.Any, typing.Any]') -> 'typing.Any': - """ - Sets the polygon-filling mode. - -Args: - - point(typing.Tuple[typing.Any, typing.Any]):The new origin in device units.MFC References - -Returns: - - typing.Any:CDC::SetPolyFillMode -Return ValueThe previous PolyFillMode as integer - - - -The previous PolyFillMode. - - - """ - pass - - - def SetROP2(self,mode:'typing.Any') -> 'typing.Any': - """ - Sets the current drawing mode. - -Args: - - mode(typing.Any):The new drawing mode.MFC References - -Returns: - - typing.Any - - """ - pass - - - def SetTextAlign(self,newFlags:'typing.Any') -> 'typing.Any': - """ - Sets the text-alignment flags. - -Args: - - newFlags(typing.Any):The new alignment flags. Can be a combination of (TA_CENTER, TA_LEFT, TA_RIGHT), (TA_BASELINE, TA_BOTTOM, TA_TOP) and (TA_NOUPDATECP, TA_UPDATECP) The default is TA_LEFT|TA_TOP|TA_NOUPDATECPMFC References - -Returns: - - typing.Any:CDC::SetTextAlign -Return ValueThe old alignment flags. - - - """ - pass - - - def SetTextColor(self,color:'typing.Any') -> 'typing.Any': - """ - Sets the text color to the specified color. - -Args: - - color(typing.Any):A windows color specification. See the win32api documentation for details.CommentsThis text color is used when writing text to this device context and also when converting bitmaps between color and monochrome device contexts. If the device cannot represent the specified color, the system sets the text color to the nearest physical color. The background color for a character is specified by the SetBkColor and SetBkMode member functions.MFC References - -Returns: - - typing.Any:CDC::SetTextColor -Return ValueThe return value is the previous text color. - - - """ - pass - - - def SetWindowExt(self,size:'typing.Tuple[typing.Any, typing.Any]') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Sets the x,y extents of the window associated with the device context. - -Args: - - size(typing.Tuple[typing.Any, typing.Any]):The new size.MFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any]:CDC::SetWindowExt -Return ValueThe previous extents of the window (in logical units). - - - """ - pass - - - def SetWindowOrg(self,arg:'typing.Tuple[typing.Any, typing.Any]') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Sets the window origin of the device context - -Args: - - arg(typing.Tuple[typing.Any, typing.Any]):The new origin. - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def SetViewportExt(self,size:'typing.Tuple[typing.Any, typing.Any]') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Sets the x,y extents of the viewport of the device context. - -Args: - - size(typing.Tuple[typing.Any, typing.Any]):The new size.MFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any]:CDC::SetViewportExt -Return ValueThe previous extents of the viewport (in logical units). - - - """ - pass - - - def SetViewportOrg(self,arg:'typing.Tuple[typing.Any, typing.Any]') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Sets the viewport origin of the device context - -Args: - - arg(typing.Tuple[typing.Any, typing.Any]):The new origin. - -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 - -for the specified device context. This transformation can be used to scale, rotate, shear, or translate graphics - -output. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def StartDoc(self,docName:'str',outputFile:'str') -> 'None': - """ - Starts spooling a document to a printer DC - -Args: - - docName(str):The document name - outputFile(str):The output file name. Use this to spool to a file. Omit to send to the printer. - -Returns: - - None - - """ - pass - - - def StartPage(self,) -> 'None': - """ - Starts a new page on a printer DC - -Args: - - - -Returns: - - None - - """ - pass - - - def StretchBlt(self,destPos:'typing.Tuple[typing.Any, typing.Any]',size:'typing.Tuple[typing.Any, typing.Any]',dc:'PyCDC',srcPos:'typing.Tuple[typing.Any, typing.Any]',size1:'typing.Tuple[typing.Any, typing.Any]',rop:'typing.Any') -> 'None': - """ - Copies a bitmap from the source device context to this device context. - -Args: - - destPos(typing.Tuple[typing.Any, typing.Any]):The logical x,y coordinates of the upper-left corner of the destination rectangle. - size(typing.Tuple[typing.Any, typing.Any]):Specifies the width and height (in logical units) of the destination rectangle and source bitmap. - dc(PyCDC):Specifies the PyCDC object from which the bitmap will be copied. It must be None if rop specifies a raster operation that does not include a source. - srcPos(typing.Tuple[typing.Any, typing.Any]):Specifies the logical x,y coordinates of the upper-left corner of the source bitmap. - size1(typing.Tuple[typing.Any, typing.Any]):Specifies the width and height (in logical units) of the destination rectangle and source bitmap. - rop(typing.Any):Specifies the raster operation to be performed. See the win32 api documentation for details.MFC References - -Returns: - - None - - """ - pass - - - def StrokeAndFillPath(self,) -> 'None': - """ - 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. - -Args: - - - -Returns: - - None - - """ - pass - - - def StrokePath(self,) -> 'None': - """ - Renders the specified path by using the current pen. - -Args: - - - -Returns: - - None - - """ - pass - - - def TextOut(self,_int:'typing.Any',_int1:'typing.Any',string:'typing.Any') -> 'None': - """ - Outputs text to the display context, using the currently selected font. - -Args: - - _int(typing.Any):The x coordinate to write the text to. - _int1(typing.Any):The y coordinate to write the text to. - string(typing.Any):The text to write.MFC References - -Returns: - - None:CDC::TextOut -Return ValueAlways none. If the function fails, an exception is raised. - - - """ - pass - - -class PyCDialog(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,obParent:'PyCWnd'=None) -> 'None': - """ - Create a modeless window for the dialog box. - -Args: - - obParent(PyCWnd):The parent window for the new windowMFC References - -Returns: - - None - - """ - pass - - - def DoModal(self,) -> 'typing.Any': - """ - Create a modal window for the dialog box. - -Args: - - - -Returns: - - typing.Any:CDialog::DoModal -Return ValueThe return value from the dialog. This is the value passed to PyCDialog::EndDialog. - - - """ - pass - - - def EndDialog(self,result:'typing.Any') -> 'None': - """ - Ends a modal dialog box. - -Args: - - result(typing.Any):The value to be returned by the PyCDialog::DoModal method.MFC References - -Returns: - - None - - """ - pass - - - def GotoDlgCtrl(self,control:'PyCWnd') -> 'None': - """ - Moves the focus to the specified control in the dialog box. - -Args: - - control(PyCWnd):The control to get the focus. - -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 - -units. - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The rect to be converted - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - - """ - pass - - - def OnCancel(self,) -> 'None': - """ - Calls the default MFC OnCancel handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnOK(self,) -> 'None': - """ - Calls the default MFC OnOK handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnInitDialog(self,) -> 'typing.Any': - """ - Calls the default MFC OnInitDialog handler. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyCDialogBar(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,parent:'PyCWnd',template:'PyResourceId',style:'typing.Any',_id:'typing.Any') -> 'None': - """ - None - -Args: - - parent(PyCWnd):The parent window - template(PyResourceId):Template name or integer resource id - style(typing.Any):The style for the window - _id(typing.Any):The ID of the window - -Returns: - - None - - """ - pass - - -class PyCDocTemplate(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def DoCreateDoc(self,fileName:'str'=None) -> 'PyCDocument': - """ - Creates an underlying document object. - -Args: - - fileName(str):The name of the file to load. - -Returns: - - PyCDocument - - """ - pass - - - def FindOpenDocument(self,fileName:'str') -> 'PyCDocument': - """ - Returns an existing document with the specified file name. - -Args: - - fileName(str):The fully qualified filename to search for. - -Returns: - - PyCDocument - - """ - pass - - - def GetDocString(self,docIndex:'typing.Any') -> 'str': - """ - Retrieves a specific substring describing the document type. - -Args: - - docIndex(typing.Any):The document index. Must be one of the win32ui.CDocTemplate_* constants.CommentsFor more information on the doc strings, please see PyCDocTemplate::SetDocStrings - -Returns: - - str - - """ - pass - - - def GetDocumentList(self,) -> 'typing.Any': - """ - Return a list of all open documents. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetResourceID(self,) -> 'None': - """ - Returns the resource ID in use. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetSharedMenu(self,) -> 'PyCMenu': - """ - Returns the shared menu object for all frames using this template. - -Args: - - - -Returns: - - PyCMenu - - """ - pass - - - def InitialUpdateFrame(self,frame:'PyCFrameWnd'=None,doc:'PyCDocument'=None,bMakeVisible:'typing.Any'=1) -> 'None': - """ - Calls the default OnInitialFrame handler. - -Args: - - frame(PyCFrameWnd):The frame window. - doc(PyCDocument):A document for the frame. - bMakeVisible(typing.Any):Indicates of the frame should be shown.See Also - -Returns: - - None - - """ - pass - - - def SetContainerInfo(self,_id:'typing.Any') -> 'None': - """ - Sets the resources to be used when an OLE 2 object is in-place activated. - -Args: - - _id(typing.Any):The resource ID. - -Returns: - - None - - """ - pass - - - def SetDocStrings(self,docStrings:'str') -> 'None': - """ - Assigns the document strings for the template. - -Args: - - docStrings(str):The document strings.CommentsThe string must be a \\n seperated list of docstrings. The elements are:elementNameDescriptionwindowTitleTitle used for the window (only for SDI applications)docNameRoot for the default document name.fileNewNameName of the document type, as displayed in the "File/New" dialogfilterNameDescription of the document type and a wildcard spec for the file open dialog.filterExtExtension for documents of this file type.regFileTypeIdInternal Id of the document as registered in the registry. Used to associate the extension with the file type.regFileTypeNameName of the document, as stored in the reigstry. This is the name presented to the user. - -Returns: - - None - - """ - pass - - - def OpenDocumentFile(self,filename:'str',bMakeVisible:'typing.Any'=1) -> 'None': - """ - Opens a document file, creating a view and frame. - -Args: - - filename(str):Name of file to open, or None - bMakeVisible(typing.Any):Indicates if the document should be created visible. - -Returns: - - None - - """ - pass - - -class PyCDockContext(object): - """A class which encapsulates an MFC CDockContext object""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ptLast(self)->'typing.Tuple[typing.Any, typing.Any]': - """""" - pass - - - @property - def rectLast(self)->'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': - """""" - pass - - - @property - def sizeLast(self)->'typing.Tuple[typing.Any, typing.Any]': - """""" - pass - - - @property - def bDitherLast(self)->'typing.Any': - """""" - pass - - - @property - def rectDragHorz(self)->'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': - """""" - pass - - - @property - def rectDragVert(self)->'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': - """""" - pass - - - @property - def rectFrameDragHorz(self)->'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': - """""" - pass - - - @property - def rectFrameDragVert(self)->'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': - """""" - pass - - - @property - def dwDockStyle(self)->'typing.Any': - """allowable dock styles for bar""" - pass - - - @property - def dwOverDockStyle(self)->'typing.Any': - """style of dock that rect is over""" - pass - - - @property - def dwStyle(self)->'typing.Any': - """style of control bar""" - pass - - - @property - def bFlip(self)->'typing.Any': - """if shift key is down""" - pass - - - @property - def bForceFrame(self)->'typing.Any': - """if ctrl key is down CDC* m_pDC; // where to draw during drag""" - pass - - - @property - def bDragging(self)->'typing.Any': - """""" - pass - - - @property - def nHitTest(self)->'typing.Any': - """""" - pass - - - @property - def uMRUDockID(self)->'typing.Any': - """""" - pass - - - @property - def rectMRUDockPos(self)->'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': - """""" - pass - - - @property - def dwMRUFloatStyle(self)->'typing.Any': - """""" - pass - - - @property - def ptMRUFloatPos(self)->'typing.Tuple[typing.Any, typing.Any]': - """Sentinel""" - pass - - - def EndDrag(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def StartDrag(self,pt:'typing.Tuple[typing.Any, typing.Any]') -> 'typing.Any': - """ - None - -Args: - - pt(typing.Tuple[typing.Any, typing.Any]): - -Returns: - - typing.Any - - """ - pass - - - def EndResize(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def StartResize(self,hittest:'typing.Any',pt:'typing.Tuple[typing.Any, typing.Any]') -> 'typing.Any': - """ - None - -Args: - - hittest(typing.Any): - pt(typing.Tuple[typing.Any, typing.Any]): - -Returns: - - typing.Any - - """ - pass - - - def ToggleDocking(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyCDocument(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def DeleteContents(self,) -> 'None': - """ - Call the MFC DeleteContents method. - -This routine is provided so a document object which overrides this method - -can call the original MFC version if required. - -Args: - - - -Returns: - - None - - """ - pass - - - def DoSave(self,fileName:'str',bReplace:'typing.Any'=1) -> 'None': - """ - Calls the underlying MFC DoSave method. - -Args: - - fileName(str):The name of the file to save to. - bReplace(typing.Any):Should an existing file be silently replaced?.CommentsIf invalid or no filename, will prompt for a name, else will perform the actual saving of the document.See Also - -Returns: - - None - - """ - pass - - - def DoFileSave(self,) -> 'None': - """ - Checks the file attributes. - -If the file is read only, a new name is prompted, else the - -file is saved (by calling DoSave) - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDocTemplate(self,) -> 'PyCDocTemplate': - """ - Returns the template for the document. - -Args: - - - -Returns: - - PyCDocTemplate - - """ - pass - - - def GetAllViews(self,) -> 'typing.List[typing.Any]': - """ - Returns a list of all views for the current document. - -Args: - - - -Returns: - - typing.List[typing.Any] - - """ - pass - - - def GetFirstView(self,) -> 'PyCView': - """ - Returns the first view object attached to this document. - -Args: - - - -Returns: - - PyCView - - """ - pass - - - def GetPathName(self,) -> 'str': - """ - Returns the full path name of the current document. - -The string will be empty if no path name has been set. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetTitle(self,) -> 'str': - """ - Returns the title of the current document. - -This will often be the file name portion of the path name. - -Args: - - - -Returns: - - str - - """ - pass - - - def IsModified(self,) -> 'typing.Any': - """ - Return a flag indicating if the document has been modified. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def OnChangedViewList(self,) -> 'None': - """ - Informs the document when a view is added or removed. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnCloseDocument(self,) -> 'None': - """ - Call the MFC OnCloseDocument handler. - -This routine is provided so a document object which overrides this method - -can call the original MFC version if required. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnNewDocument(self,) -> 'None': - """ - Call the MFC OnNewDocument handler. - -This routine is provided so a document object which overrides this method - -can call the original MFC version if required. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnOpenDocument(self,pathName:'str') -> 'None': - """ - Call the MFC OnOpenDocument handler. - -This routine is provided so a document object which overrides this method - -can call the original MFC version if required. - -Args: - - pathName(str):The full path of the file to open.MFC References - -Returns: - - None - - """ - pass - - - def OnSaveDocument(self,pathName:'str') -> 'None': - """ - Call the MFC OnSaveDocument handler. - -This routine is provided so a document object which overrides this method - -can call the original MFC version if required. - -Args: - - pathName(str):The full path of the file to save.MFC References - -Returns: - - None - - """ - pass - - - def SetModifiedFlag(self,bModified:'typing.Any'=1) -> 'None': - """ - Set the "dirty" flag for the document. - -Args: - - bModified(typing.Any):Set dirty flagMFC References - -Returns: - - None - - """ - pass - - - def SaveModified(self,) -> 'typing.Any': - """ - Call the underlying MFC method. - -Args: - - - -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 - - - def SetPathName(self,path:'str') -> 'None': - """ - Set the full path name for the document. - -Args: - - path(str):The full path of the file.MFC References - -Returns: - - None - - """ - pass - - - def SetTitle(self,title:'str') -> 'None': - """ - Set the title of the document (ie, the name - -to appear in the window caption for the document. - -Args: - - title(str):The new title.MFC References - -Returns: - - None - - """ - pass - - - def UpdateAllViews(self,sender:'PyCView',hint:'typing.Any'=None) -> 'None': - """ - Informs each view when a document changes. - -Args: - - sender(PyCView):The view who initiated the update - hint(typing.Any):A hint for the update.MFC References - -Returns: - - None - - """ - pass - - -class PyCEdit(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,style:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',parent:'PyCWnd',_id:'typing.Any') -> 'None': - """ - Creates the window for a new Edit object. - -Args: - - style(typing.Any):The style for the Edit. Use any of the win32con.BS_* constants. - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The size and position of the Edit. - parent(PyCWnd):The parent window of the Edit. Usually a PyCDialog. - _id(typing.Any):The Edits control ID. - -Returns: - - None - - """ - pass - - - def Clear(self,) -> 'typing.Any': - """ - Clears all text in an edit control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def Copy(self,) -> 'None': - """ - Copys the current selection to the clipboard. - -Args: - - - -Returns: - - None - - """ - pass - - - def Cut(self,) -> 'None': - """ - Cuts the current selection to the clipboard. - -Args: - - - -Returns: - - None - - """ - pass - - - def FmtLines(self,bAddEOL:'typing.Any') -> 'typing.Any': - """ - Sets the formatting options for the control. - -Args: - - bAddEOL(typing.Any):Specifies whether soft line-break characters are to be inserted. A value of TRUE inserts the characters; a value of FALSE removes them.MFC References - -Returns: - - typing.Any:CEdit::FmtLines -Return ValueNonzero if any formatting occurs; otherwise 0. - - - """ - pass - - - def GetFirstVisibleLine(self,) -> 'typing.Any': - """ - Returns zero-based index of the topmost visible line. - -Args: - - - -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 - - - def GetSel(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Returns the start and end of the current selection. - -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 - -end of the current selection) - - - """ - pass - - - def GetLine(self,lineNo:'typing.Any') -> 'typing.Any': - """ - Returns the text in a specified line. - -Args: - - lineNo(typing.Any):Contains the zero-based index value for the desired line.CommentsThis function is not an MFC wrapper. - -Returns: - - typing.Any - - """ - pass - - - def GetLineCount(self,) -> 'typing.Any': - """ - Gets the number of lines in an edit control. - -Args: - - - -Returns: - - typing.Any:CEdit::GetLineCount -Return ValueThe number of lines in the buffer. If the control is empty, the return value is 1. - - - """ - pass - - - def LimitText(self,nChars:'typing.Any'=0) -> 'None': - """ - Sets max length of text that user can enter - -Args: - - nChars(typing.Any):Specifies the length (in bytes) of the text that the user can enter. If this parameter is 0, the text length is set to UINT_MAX bytes. This is the default behavior.MFC References - -Returns: - - None - - """ - pass - - - def LineFromChar(self,charNo:'typing.Any'=-1) -> 'typing.Any': - """ - Returns the line number of the specified character. - -Args: - - charNo(typing.Any):Contains the zero-based index value for the desired character in the text of the edit control, or -1. If -1, then it specifies the current line.MFC References - -Returns: - - typing.Any:CEdit::LineFromChar -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 there is no selection, the current line number is returned. - - - """ - pass - - - def LineIndex(self,lineNo:'typing.Any'=-1) -> 'typing.Any': - """ - Retrieves the character index of a line within a multiple-line edit control. - -Args: - - lineNo(typing.Any):Contains the index value for the desired line in the text of the edit control, or contains -1. If -1, then it specifies the current line.CommentsThis method only works on multi-linr edit controls.MFC References - -Returns: - - typing.Any:CEdit::LineIndex -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 edit control. - - - """ - pass - - - def LineScroll(self,nLines:'typing.Any',nChars:'typing.Any'=0) -> 'typing.Any': - """ - Scroll the control vertically and horizontally - -Args: - - nLines(typing.Any):Specifies the number of lines to scroll vertically. - nChars(typing.Any):Specifies the number of character positions to scroll horizontally. This value is ignored if the edit control has either the ES_RIGHT or ES_CENTER style.CommentsThis method only works on multi-linr edit controls.MFC References - -Returns: - - typing.Any - - """ - pass - - - def Paste(self,) -> 'None': - """ - Pastes the contents of the clipboard into the control. - -Args: - - - -Returns: - - None - - """ - pass - - - def ReplaceSel(self,text:'str') -> 'None': - """ - Replaces the selection with the specified text. - -Args: - - text(str):The text to replace the selection with.MFC References - -Returns: - - None - - """ - pass - - - def SetReadOnly(self,bReadOnly:'typing.Any'=1) -> 'None': - """ - Sets or clears the read-only status of the listbox. - -Args: - - bReadOnly(typing.Any):The read-only state to set.MFC References - -Returns: - - None - - """ - pass - - - def SetSel(self,start:'typing.Any',end:'typing.Any',arg:'typing.Any',bNoScroll1:'typing.Any',bNoScroll:'typing.Any'=0) -> 'None': - """ - Sets the selection in the edit control. - -Args: - - start(typing.Any):Specifies the starting position. If start is 0 and end is -1, all the text in the edit control is selected. If start is -1, any current selection is removed. - end(typing.Any):Specifies the ending position. - arg(typing.Any):As for normal start, end args. - bNoScroll1(typing.Any):Indicates whether the caret should be scrolled into view. If 0, the caret is scrolled into view. If 1, the caret is not scrolled into view.MFC References - bNoScroll(typing.Any):Indicates whether the caret should be scrolled into view. If 0, the caret is scrolled into view. If 1, the caret is not scrolled into view.Alternative Parameters - -Returns: - - None - - """ - pass - - -class PyCEditView(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def IsModified(self,) -> 'typing.Any': - """ - Indicates if the view's document has the modified flag set. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def LoadFile(self,fileName:'str') -> 'None': - """ - Loads a file into the view. - -Args: - - fileName(str):The name of the file to be loaded. - -Returns: - - None - - """ - pass - - - def SetModifiedFlag(self,bModified:'typing.Any'=1) -> 'None': - """ - Sets the modified flag for the view's document. - -Args: - - bModified(typing.Any):The modified state to set. - -Returns: - - None - - """ - pass - - - def GetEditCtrl(self,) -> 'typing.Any': - """ - returns the underlying edit control object. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def PreCreateWindow(self,createStruct:'typing.Any') -> 'typing.Any': - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(typing.Any):A tuple representing a CREATESTRUCT structure. - -Returns: - - typing.Any - - """ - pass - - - def SaveFile(self,fileName:'str') -> 'None': - """ - Saves the view to a file. - -Args: - - fileName(str):The name of the file to be written. - -Returns: - - None - - """ - pass - - - def OnCommand(self,wparam:'typing.Any',lparam:'typing.Any') -> 'None': - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(typing.Any): - lparam(typing.Any):See Also - -Returns: - - None - - """ - pass - - -class PyCFileDialog(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPathName(self,) -> 'str': - """ - Retrives the path name from the file dialog. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetFileName(self,) -> 'str': - """ - Retrives the file name from the file dialog. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetFileExt(self,) -> 'str': - """ - Retrives the file extension from the file dialog. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetFileTitle(self,) -> 'str': - """ - Retrives the file title from the file dialog. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetPathNames(self,) -> 'str': - """ - Retrieves the list of path names from the file dialog. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetReadOnlyPref(self,) -> 'typing.Any': - """ - Retrives the value of the "Read Only" checkbox on the file dialog. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetOFNTitle(self,title:'str') -> 'None': - """ - Sets the Title for the dialog. - -Args: - - title(str):The title for the dialog box. May be None. - -Returns: - - None - - """ - pass - - - def SetOFNInitialDir(self,title:'str') -> 'None': - """ - Sets the initial directory for the dialog. - -Args: - - title(str):The initial directory for the dialog box. May be None. - -Returns: - - None - - """ - pass - - -class PyCFont(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetSafeHandle(self,) -> 'typing.Any': - """ - Retrieves the HFONT for the font as an integer - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyCFontDialog(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def DoModal(self,) -> 'typing.Any': - """ - Displays a dialog and allows the user to make a selection. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetCurrentFont(self,) -> 'typing.Any': - """ - Returns a dictionary describing the current font. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetCharFormat(self,) -> 'typing.Any': - """ - Returns the font selection in a CHARFORMAT tuple. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetColor(self,) -> 'typing.Any': - """ - Determines the color of the selected font. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetFaceName(self,) -> 'str': - """ - Returns the face name of the selected font. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetStyleName(self,) -> 'str': - """ - Returns the style name of the selected font. - -Args: - - - -Returns: - - str - - """ - pass - - - def GetSize(self,) -> 'typing.Any': - """ - Returns he font's size, in tenths of a point. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetWeight(self,) -> 'typing.Any': - """ - Returns the font's weight. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def IsStrikeOut(self,) -> 'typing.Any': - """ - Determines whether the font is displayed with strikeout. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def IsUnderline(self,) -> 'typing.Any': - """ - Determines whether the font is displayed with underline. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def IsBold(self,) -> 'typing.Any': - """ - Determines whether the font is displayed bold. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def IsItalic(self,) -> 'typing.Any': - """ - Determines whether the font is displayed with italic. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyCFormView(object): - """A class which implementes a CFormView (ie, a view based on a dialog resource.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OnCommand(self,wparam:'typing.Any',lparam:'typing.Any') -> 'None': - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(typing.Any): - lparam(typing.Any):See Also - -Returns: - - None - - """ - pass - - -class PyCFrameWnd(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def BeginModalState(self,) -> 'None': - """ - Sets the frame window to modal. - -Args: - - - -Returns: - - None - - """ - pass - - - def CreateWindow(self,wndClass:'str',title:'str',style:'typing.Any',PyCWnd:'typing.Any',menuId:'typing.Any',styleEx:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]'=None,createContext:'typing.Any'=None) -> 'typing.Any': - """ - Creates the actual window for the PyCFrameWnd object. - -Args: - - wndClass(str):The window class name, or None - title(str):The window title - style(typing.Any):The window style - PyCWnd(typing.Any):The parent window - menuId(typing.Any):The string or integer id for the menu. - styleEx(typing.Any):The extended style of the window being created.MFC References - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The default rectangle - createContext(typing.Any):A tuple representing a CREATECONTEXT structure. - -Returns: - - typing.Any - - """ - pass - - - def EndModalState(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def DockControlBar(self,controlBar:'PyCControlBar',arg:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',dockBarId:'typing.Any'=0) -> 'None': - """ - Docks a control bar. - -Args: - - controlBar(PyCControlBar):The control bar to dock. - arg(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Determines, in screen coordinates, where the control bar will be docked in the nonclient area of the destination frame window.MFC References - dockBarId(typing.Any):Determines which sides of the frame window to consider for docking. - -Returns: - - None - - """ - pass - - - def EnableDocking(self,style:'typing.Any') -> 'None': - """ - Enable dockable control bars in a frame window - -Args: - - style(typing.Any):Specifies which sides of the frame window can serve as docking sites for control bars.CommentsBy default, control bars will be docked to a side of the frame window in the following order: top, bottom, left, right. - -Returns: - - None - - """ - pass - - - def FloatControlBar(self,controlBar:'PyCControlBar',arg:'typing.Tuple[typing.Any, typing.Any]',style:'typing.Any') -> 'None': - """ - Floats a control bar. - -Args: - - controlBar(PyCControlBar):The control bar to dock. - arg(typing.Tuple[typing.Any, typing.Any]):The location, in screen coordinates, where the top left corner of the control bar will be placed. - style(typing.Any):Determines which sides of the frame window to consider for docking.MFC References - -Returns: - - None - - """ - pass - - - def GetActiveDocument(self,) -> 'PyCDocument': - """ - Gets the currently active document, else None - -Args: - - - -Returns: - - PyCDocument - - """ - pass - - - def GetControlBar(self,_id:'typing.Any') -> 'PyCControlBar': - """ - Retrieves the specified control bar. - -Args: - - _id(typing.Any):The ID of the toolbar to be retrieved - -Returns: - - PyCControlBar - - """ - pass - - - def GetMessageString(self,_id:'typing.Any') -> 'str': - """ - Retrieves message corresponding to a command ID. - -Args: - - _id(typing.Any):The ID to be retrievedSee Also - -Returns: - - str - - """ - pass - - - def GetMessageBar(self,) -> 'PyCWnd': - """ - Retrieves the message bar for the frame. - -Args: - - - -Returns: - - PyCWnd - - """ - pass - - - def IsTracking(self,) -> 'typing.Any': - """ - Determines if splitter bar is currently being moved. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def InModalState(self,) -> 'typing.Any': - """ - Returns a value indicating whether or not a frame window is in a modal state. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def LoadAccelTable(self,_id:'PyResourceId') -> 'None': - """ - Loads an accelerator table. - -Args: - - _id(PyResourceId):Name or id of the resource that contains the table - -Returns: - - None - - """ - pass - - - def LoadFrame(self,idResource:'typing.Any',style:'typing.Any'=-1,wndParent:'PyCWnd'=None,context:'typing.Any'=None) -> 'None': - """ - Loads a Windows frame window and associated resources - -Args: - - idResource(typing.Any):The Id of the resources (menu, icon, etc) for this window - style(typing.Any):The window style. Note -1 implies win32con.WS_OVERLAPPEDWINDOW|win32con.FWS_ADDTOTITLE - wndParent(PyCWnd):The parent of the window, or None. - context(typing.Any):An object passed to the OnCreateClient for the frame,MFC References - -Returns: - - None - - """ - pass - - - def LoadBarState(self,profileName:'str') -> 'None': - """ - Loads a control bars settings - -Args: - - profileName(str):Name of a section in the initialization file or a key in the Windows registry where state information is stored.MFC References - -Returns: - - None - - """ - pass - - - def PreCreateWindow(self,createStruct:'typing.Any') -> 'typing.Any': - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(typing.Any):A tuple representing a CREATESTRUCT structure.See Also - -Returns: - - typing.Any - - """ - pass - - - def SaveBarState(self,profileName:'str') -> 'None': - """ - Saves a control bars settings - -Args: - - profileName(str):Name of a section in the initialization file or a key in the Windows registry where state information is stored.MFC References - -Returns: - - None - - """ - pass - - - def ShowControlBar(self,controlBar:'PyCControlBar',bShow:'typing.Any',bDelay:'typing.Any') -> 'None': - """ - Shows a control bar. - -Args: - - controlBar(PyCControlBar):The control bar to dock. - bShow(typing.Any):Show or hide flag. - bDelay(typing.Any):If TRUE, delay showing the control bar. If FALSE, show the control bar immediately.MFC References - -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 - -when the frame window is resized. - -Args: - - bNotify(typing.Any):Notify flagMFC References - -Returns: - - None - - """ - pass - - - def GetActiveView(self,) -> 'PyCView': - """ - Retrieves the active view. - -Args: - - - -Returns: - - PyCView - - """ - pass - - - def OnBarCheck(self,_id:'typing.Any') -> 'typing.Any': - """ - Changes the state of the specified controlbar. - -Args: - - _id(typing.Any):The control ID of the control bar. - -Returns: - - typing.Any - - """ - pass - - - def OnUpdateControlBarMenu(self,cmdUI:'PyCCmdUI') -> 'typing.Any': - """ - Checks the state of a menu item - -Args: - - cmdUI(PyCCmdUI):A cmdui object - -Returns: - - typing.Any - - """ - pass - - - def SetActiveView(self,view:'PyCView',bNotify:'typing.Any'=1) -> 'None': - """ - Sets the active view for a frame. - -Args: - - view(PyCView):The view to set active. - bNotify(typing.Any):Specifies whether the view is to be notified of activation. If TRUE, OnActivateView is called for the new view; if FALSE, it is not. - -Returns: - - None - - """ - pass - - -class PyCGdiObject(object): - """A class which encapsulates an MFC CGdiObject.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCImageList(object): - """A Python type encapsulating an MFC CImageList class.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Add(self,arg:'typing.Tuple[typing.Any, typing.Any]',bitmap:'typing.Any',color:'typing.Any',hIcon:'typing.Any') -> 'typing.Any': - """ - Adds an image to the list. - -Args: - - arg(typing.Tuple[typing.Any, typing.Any]):2 Bitmaps to use (primary and mask)Alternative Parameters - bitmap(typing.Any):Bitmap to use - color(typing.Any):Color to use for the mask.Alternative Parameters - hIcon(typing.Any):Handle of an icon to add.Return ValueZero-based index of the first new image. - -Returns: - - typing.Any:Handle of an icon to add. -Return ValueZero-based index of the first new image. - - - """ - pass - - - def Destroy(self,) -> 'None': - """ - Destroys the underlying CImageList - -Args: - - - -Returns: - - None - - """ - pass - - - def DeleteImageList(self,) -> 'None': - """ - Deletes an image list. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetBkColor(self,) -> 'typing.Any': - """ - Retrieves the background color of an Image List. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetSafeHandle(self,) -> 'typing.Any': - """ - Retrieves the HIMAGELIST for the object - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetImageCount(self,) -> 'typing.Any': - """ - Retrieves the number of images in an image list. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetImageInfo(self,index:'typing.Any') -> 'typing.Any': - """ - Retrieves information about an image. - -Args: - - index(typing.Any):Index of image.Return ValueThe return info is a tuple describing an IMAGELIST structure. - -Returns: - - typing.Any:Index of image.Return ValueThe return info is a tuple describing an IMAGELIST structure. - - - """ - pass - - - def SetBkColor(self,color:'typing.Any') -> 'None': - """ - Sets the background color for an Image List. - -Args: - - color(typing.Any):The new background color. - -Returns: - - None - - """ - pass - - -class PyCListBox(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddString(self,_object:'typing.Any') -> 'typing.Any': - """ - Adds a string to a listbox. - -Args: - - _object(typing.Any):Any object. If not a string, __str__, __repr__ or a default repr() will be usedMFC References - -Returns: - - typing.Any:CListBox::AddString -Return ValueThe zero based index of the new string. - - - """ - pass - - - def DeleteString(self,pos:'typing.Any') -> 'typing.Any': - """ - Deletes an item from a listbox. - -Args: - - pos(typing.Any):The zero based index of the item to delete.MFC References - -Returns: - - typing.Any:CListBox::DeleteString -Return ValueThe count of the items remaining in the list. - - - """ - pass - - - def Dir(self,attr:'typing.Any',wild:'str') -> 'typing.Any': - """ - Fills a listbox with a directory listing. - -Args: - - attr(typing.Any):The attributes of the files to locate - wild(str):A file specification string - eg, *.*MFC References - -Returns: - - typing.Any:CListBox::Dir -Return ValueThe index of the last file name added to the list. - - - """ - pass - - - def GetCaretIndex(self,) -> 'typing.Any': - """ - Returns the index of the item which has focus. - -Args: - - - -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. - -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 - - - def GetCount(self,) -> 'typing.Any': - """ - Returns the count of items in the listbox. - -Args: - - - -Returns: - - typing.Any:CListBox::GetCount -Return ValueReturns the number of items currently in the listbox. - - - """ - pass - - - def GetCurSel(self,) -> 'typing.Any': - """ - Returns the index of the currently selected item. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetItemData(self,item:'typing.Any') -> 'typing.Any': - """ - Retrieves the application-specific object associated with an item. - -Args: - - item(typing.Any):The index of the item whose data is to be retrieved. - -Returns: - - typing.Any - - """ - pass - - - def GetItemValue(self,item:'typing.Any') -> 'typing.Any': - """ - Retrieves the application-specific value associated with an item. - -Args: - - item(typing.Any):The index of the item whose data is to be retrieved. - -Returns: - - typing.Any - - """ - pass - - - def GetSel(self,index:'typing.Any') -> 'typing.Any': - """ - Returns the selection state of a specified item. - -Args: - - index(typing.Any):The index of the item to return the state for.MFC References - -Returns: - - typing.Any:CListBox::GetSel -Return ValueA +ve number if the item is selected, else zero. - - - """ - pass - - - def GetSelCount(self,) -> 'typing.Any': - """ - Returns the number of selected items in a multiple selection listbox. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetSelItems(self,) -> 'typing.Any': - """ - Returns a list of the indexes of the currently selected items in a multiple - -selection listbox. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetSelTextItems(self,) -> 'typing.Any': - """ - Returns a list of the strings of the currently selected items in a multiple - -selection listbox. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetTopIndex(self,) -> 'typing.Any': - """ - Returns the index of the top most visible item. - -Args: - - - -Returns: - - typing.Any:CListBox::GetTopIndex -Return ValueThe zero based index of the top most visible item. - - - """ - pass - - - def GetText(self,index:'typing.Any') -> 'str': - """ - Returns the string for a specified item. - -Args: - - index(typing.Any):The index of the item to retrieve the text of - -Returns: - - str - - """ - pass - - - def GetTextLen(self,index:'typing.Any') -> 'typing.Any': - """ - Returns the length of the string for a specified item. - -Args: - - index(typing.Any):The index of the item to retrieve the length of the text.MFC References - -Returns: - - typing.Any - - """ - pass - - - def InsertString(self,pos:'typing.Any',_object:'typing.Any') -> 'typing.Any': - """ - Insert a string into a listbox. - -Args: - - pos(typing.Any):The zero based index in the listbox to insert the new string - _object(typing.Any):The object to be added to the listboxMFC References - -Returns: - - typing.Any:CListBox::InsertString -Return ValueThe zero based index of the new string added. - - - """ - pass - - - def ResetContent(self,) -> 'None': - """ - Clear all the items from a listbox. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetCaretIndex(self,index:'typing.Any',bScroll:'typing.Any'=1) -> 'None': - """ - Sets the focus rectange to a specified item. - -Args: - - index(typing.Any):The zero based index of the item. - bScroll(typing.Any):Should the listbox scroll to the item?MFC References - -Returns: - - None - - """ - pass - - - def SelectString(self,after:'typing.Any',string:'str') -> 'None': - """ - Searches for a list-box item that matches the specified string, and selects it. - -Args: - - after(typing.Any):Contains the zero-based index of the item before the first item to be searched, or -1 for the entire listbox. - string(str):The string to search for.MFC References - -Returns: - - None:CListBox::SelectString -Return ValueThe return value is always None - an exception is raised if the string can not be located. - - - """ - pass - - - def SelItemRange(self,bSel:'typing.Any',start:'typing.Any',end:'typing.Any') -> 'None': - """ - Selects an item range. - -Args: - - bSel(typing.Any):Should the selection specified be set or cleared? - start(typing.Any):The zero based index of the first item to select. - end(typing.Any):The zero based index of the last item to select. - -Returns: - - None - - """ - pass - - - def SetCurSel(self,index:'typing.Any') -> 'None': - """ - Selects an item in a single selection listbox. - -Args: - - index(typing.Any):The zero based index of the item to select.MFC References - -Returns: - - None - - """ - pass - - - def SetItemData(self,item:'typing.Any',Data:'typing.Any') -> 'typing.Any': - """ - Sets the item's application-specific object value. - -Args: - - item(typing.Any):Index of the item whose Data is to be set. - Data(typing.Any):New value for the data.CommentsNote that a reference count is not added to the object. This it is your responsibility to make sure the object remains alive while in the list. - -Returns: - - typing.Any - - """ - pass - - - def SetItemValue(self,item:'typing.Any',data:'typing.Any') -> 'typing.Any': - """ - Sets the item's application-specific value. - -Args: - - item(typing.Any):Index of the item whose Data is to be set. - data(typing.Any):New value for the data. - -Returns: - - typing.Any - - """ - pass - - - def SetSel(self,index:'typing.Any',bSel:'typing.Any'=1) -> 'None': - """ - Selects an item in a multiple selection listbox. - -Args: - - index(typing.Any):The zero based index of the item to select. - bSel(typing.Any):Should the item be selected or deselected?MFC References - -Returns: - - None - - """ - pass - - - def SetTabStops(self,eachTabStop:'typing.Any',tabStops:'typing.Any') -> 'None': - """ - Sets the tab stops for a listbox. - -Args: - - eachTabStop(typing.Any):The position for each tab stop.Alternative Parameters - tabStops(typing.Any):Each individual tab stop. - -Returns: - - None - - """ - pass - - - def SetTopIndex(self,index:'typing.Any') -> 'None': - """ - Sets the top index (top most visible item) of the listbox. - -Args: - - index(typing.Any):The zero based index of the item to place at the top of the list.MFC References - -Returns: - - None - - """ - pass - - -class PyCListCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Arrange(self,code:'typing.Any') -> 'None': - """ - Aligns items on a grid. - -Args: - - code(typing.Any):Specifies the alignment style for the items - -Returns: - - None - - """ - pass - - - def CreateWindow(self,style:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',PyCWnd:'typing.Any',_id:'typing.Any') -> 'None': - """ - Creates the actual window for the object. - -Args: - - style(typing.Any):The window style - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The default rectangle - PyCWnd(typing.Any):The parent window - _id(typing.Any):The control IDMFC References - -Returns: - - None - - """ - pass - - - def DeleteAllItems(self,) -> 'None': - """ - Deletes all items from the list. - -Args: - - - -Returns: - - None - - """ - pass - - - def DeleteItem(self,item:'typing.Any') -> 'None': - """ - Deletes the specified item. - -Args: - - item(typing.Any):The item to delete. - -Returns: - - None - - """ - pass - - - def GetTextColor(self,) -> 'typing.Any': - """ - Retrieves the text color of a list view control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetTextColor(self,color:'typing.Any') -> 'None': - """ - Sets the text color of a list view control. - -Args: - - color(typing.Any):The new color. - -Returns: - - None - - """ - pass - - - def GetBkColor(self,) -> 'typing.Any': - """ - Retrieves the background color of the control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetBkColor(self,color:'typing.Any') -> 'None': - """ - Sets the background color of the control. - -Args: - - color(typing.Any):The new background color. - -Returns: - - None - - """ - pass - - - def GetItem(self,item:'typing.Any',sub:'typing.Any') -> 'LV_ITEM': - """ - Retrieves the details of an items attributes. - -Args: - - item(typing.Any):The index of the item whose attributes are to be retrieved. - sub(typing.Any):Specifies the subitem whose text is to be retrieved. - -Returns: - - LV_ITEM - - """ - pass - - - def GetItemCount(self,) -> 'typing.Any': - """ - Retrieves the number of items in a list view control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetItemRect(self,item:'typing.Any',bTextOnly:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': - """ - Retrieves the bounding rectangle of a list view item. - -Args: - - item(typing.Any):Index of the item whose Data is to be set. - bTextOnly(typing.Any):f this parameter is nonzero, the bounding rectangle includes only the text of the item. Otherwise it includes the entire line that the item occupies in the list view control. - -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 - -list view item. - -Args: - - - -Returns: - - PyCEdit - - """ - pass - - - def EditLabel(self,item:'typing.Any') -> 'PyCEdit': - """ - Edits a specified list view item in-place. - -Args: - - item(typing.Any):The index of item to edit. - -Returns: - - PyCEdit - - """ - pass - - - def EnsureVisible(self,item:'typing.Any',bPartialOK:'typing.Any') -> 'typing.Any': - """ - Ensures that a list view item is visible in its list view control. - -Args: - - item(typing.Any):The index of item to edit. - bPartialOK(typing.Any):Specifies whether partial visibility is acceptable. - -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 - -item. - -Args: - - item(typing.Any):The index of the item to edit. - -Returns: - - typing.Tuple[PyCImageList, typing.Any, typing.Any] - - """ - pass - - - def GetImageList(self,nImageList:'typing.Any') -> 'PyCImageList': - """ - Retrieves the current image list. - -Args: - - nImageList(typing.Any):Value specifying which image list to retrieve. It can be one of: - commctrl.LVSIL_NORMAL Image list with large icons. - commctrl.LVSIL_SMALL Image list with small icons. - commctrl.LVSIL_STATE Image list with state images. - -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 - -relationship to a given item. - -Args: - - item(typing.Any):Index of the item to begin the searching with, or -1 to find the first item that matches the specified flags. The specified item itself is excluded from the search. - flags(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: LVNI_ABOVELVNI_ALLLVNI_BELOWLVNI_TOLEFTLVNI_TORIGHT The state can be zero, or it can be one or more of these values: LVNI_DROPHILITEDLVNI_FOCUSEDLVNI_HIDDENLVNI_MARKEDLVNI_SELECTED 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. - -Returns: - - 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: - -LVNI_ABOVELVNI_ALLLVNI_BELOWLVNI_TOLEFTLVNI_TORIGHT - -The state can be zero, or it can be one or more of these values: - -LVNI_DROPHILITEDLVNI_FOCUSEDLVNI_HIDDENLVNI_MARKEDLVNI_SELECTED - -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 - - - def InsertColumn(self,colNo:'typing.Any',item:'LV_COLUMN') -> 'typing.Any': - """ - Inserts a column into a list control when in report view. - -Args: - - colNo(typing.Any):The new column number - item(LV_COLUMN):A tuple describing the new column. - -Returns: - - typing.Any - - """ - pass - - - def InsertItem(self,item:'LV_ITEM',item1:'typing.Any',text:'typing.Any',image:'typing.Any',item2:'typing.Any',text1:'typing.Any') -> 'typing.Any': - """ - Inserts an item into the list. - -Args: - - item(LV_ITEM):A tuple describing the new item.Alternative Parameters - item1(typing.Any):The index of the item. - text(typing.Any):The text of the item. - image(typing.Any):The index of the image to use.Alternative Parameters - item2(typing.Any):The index of the item. - text1(typing.Any):The text of the item. - -Returns: - - typing.Any - - """ - pass - - - def SetImageList(self,imageList:'PyCImageList',imageType:'typing.Any') -> 'typing.Any': - """ - Assigns an image list to a list view control. - -Args: - - imageList(PyCImageList):The Image List to use. - imageType(typing.Any):Type of image list. It can be one of (COMMCTRL.) LVSIL_NORMAL, LVSIL_SMALL or LVSIL_STATE - -Returns: - - typing.Any - - """ - pass - - - def GetColumn(self,column:'typing.Any') -> 'LV_COLUMN': - """ - Retrieves the details of a column in the control. - -Args: - - column(typing.Any):The index of the column whose attributes are to be retrieved. - -Returns: - - LV_COLUMN - - """ - pass - - - def GetTextBkColor(self,) -> 'typing.Any': - """ - Retrieves the text background color of a list view control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetTextBkColor(self,color:'typing.Any') -> 'None': - """ - Sets the text background color of a list view control. - -Args: - - color(typing.Any):The new background color. - -Returns: - - None - - """ - pass - - - def GetTopIndex(self,) -> 'typing.Any': - """ - Retrieves the index of the topmost visible item. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetCountPerPage(self,) -> 'typing.Any': - """ - Calculates the number of items that can fit vertically in a list view - -control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetSelectedCount(self,) -> 'typing.Any': - """ - Retrieves the number of selected items in the list view control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetItem(self,item:'LV_ITEM') -> 'typing.Any': - """ - Sets some of all of an items attributes. - -Args: - - item(LV_ITEM):A tuple describing the new item. - -Returns: - - typing.Any - - """ - pass - - - def SetItemState(self,item:'typing.Any',state:'typing.Any',mask:'typing.Any') -> 'typing.Any': - """ - Changes the state of an item in a list view control. - -Args: - - item(typing.Any):Index of the item whose state is to be set. - state(typing.Any):New values for the state bits. - mask(typing.Any):Mask specifying which state bits to change. - -Returns: - - typing.Any - - """ - pass - - - def GetItemState(self,item:'typing.Any',mask:'typing.Any') -> 'typing.Any': - """ - Retrieves the state of a list view item. - -Args: - - item(typing.Any):The index of the item whose position is to be retrieved. - mask(typing.Any):Mask specifying which of the item's state flags to return. - -Returns: - - typing.Any - - """ - pass - - - def SetItemData(self,item:'typing.Any',Data:'typing.Any') -> 'typing.Any': - """ - Sets the item's application-specific value. - -Args: - - item(typing.Any):Index of the item whose Data is to be set. - Data(typing.Any):New value for the data.CommentsNote that a reference count is not added to the object. This it is your responsibility to make sure the object remains alive while in the list. - -Returns: - - typing.Any - - """ - pass - - - def GetItemData(self,item:'typing.Any') -> 'typing.Any': - """ - Retrieves the application-specific value associated with an item. - -Args: - - item(typing.Any):The index of the item whose data is to be retrieved. - -Returns: - - typing.Any - - """ - pass - - - def SetItemCount(self,count:'typing.Any') -> 'None': - """ - Prepares a list view control for adding a large number of items. - -Args: - - count(typing.Any):Number of items that the control will ultimately contain.CommentsBy calling this function before adding a large number of items, you enable a list view control to reallocate its internal data structures only once rather than every time you add an item. - -Returns: - - None - - """ - pass - - - def SetItemText(self,item:'typing.Any',sub:'typing.Any',text:'str') -> 'typing.Any': - """ - Changes the text of a list view item or subitem. - -Args: - - item(typing.Any):Index of the item whose text is to be set. - sub(typing.Any):Index of the subitem, or zero to set the item label. - text(str):String that contains the new item text. - -Returns: - - typing.Any - - """ - pass - - - def GetItemText(self,item:'typing.Any',sub:'typing.Any') -> 'typing.Any': - """ - Retrieves the text of a list view item or subitem. - -Args: - - item(typing.Any):The index of the item whose text is to be retrieved. - sub(typing.Any):Specifies the subitem whose text is to be retrieved. - -Returns: - - typing.Any - - """ - pass - - - def RedrawItems(self,first:'typing.Any',first1:'typing.Any') -> 'typing.Any': - """ - Forces a listview to repaint a range of items. - -Args: - - first(typing.Any):Index of the first item to be repainted. - first1(typing.Any):Index of the last item to be repainted.CommentsThe specified items are not actually repainted until the list view window receives a WM_PAINT message. To repaint immediately, call the Windows UpdateWindow function after using this function. - -Returns: - - typing.Any - - """ - pass - - - def Update(self,item:'typing.Any') -> 'None': - """ - Forces the control to repaint a specified item. - -Args: - - item(typing.Any):The new color. - -Returns: - - None - - """ - pass - - - def SetColumn(self,colNo:'typing.Any',item:'LV_COLUMN') -> 'typing.Any': - """ - Changes column state in a list control when in report view. - -Args: - - colNo(typing.Any):The to be modified column number - item(LV_COLUMN):A tuple describing the modified column. - -Returns: - - typing.Any - - """ - pass - - - def DeleteColumn(self,first:'typing.Any') -> 'typing.Any': - """ - Deletes the specified column from the list control. - -Args: - - first(typing.Any):Index of the column to be removed. - -Returns: - - typing.Any - - """ - pass - - - def GetColumnWidth(self,first:'typing.Any') -> 'typing.Any': - """ - Gets the width of the specified column in the list control. - -Args: - - first(typing.Any):Index of the column whose width is to be retrieved. - -Returns: - - typing.Any - - """ - pass - - - def SetColumnWidth(self,first:'typing.Any',first1:'typing.Any') -> 'typing.Any': - """ - Sets the width of the specified column in the list control. - -Args: - - first(typing.Any):Index of the column to be changed. - first1(typing.Any):New width of the column. - -Returns: - - typing.Any - - """ - pass - - - def GetStringWidth(self,first:'typing.Any') -> 'typing.Any': - """ - Gets the necessary column width to fully display this text in a column. - -Args: - - first(typing.Any):String that contains the text whose width is to be determined.CommentsDoesn't take the size of an included Image in account, only the size of the text is determined. - -Returns: - - typing.Any - - """ - pass - - - def HitTest(self,arg:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': - """ - Determines which list view item, if any, is at a specified position. - -Args: - - arg(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:ValueDescriptioncommctrl.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 list item.commctrl.LVHT_ONITEMICONThe position is over a list view item's icon.commctrl.LVHT_ONITEMLABELThe position is over a list view item's text.commctrl.LVHT_ONITEMSTATEICONThe position is over the state image of a list view item.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. - -Returns: - - 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: - - - -Value - - -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 - -list item. -commctrl.LVHT_ONITEMICONThe position is over a list view item's icon. -commctrl.LVHT_ONITEMLABELThe position is over a list view item's text. -commctrl.LVHT_ONITEMSTATEICONThe position is over the state image of a list view item. -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 - - - def GetItemPosition(self,item:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Determines the position of the specified item. - -Args: - - item(typing.Any):The item to determine the position for. - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - -class PyCListView(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def PreCreateWindow(self,createStruct:'typing.Any') -> 'typing.Any': - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(typing.Any):A tuple representing a CREATESTRUCT structure. - -Returns: - - typing.Any - - """ - pass - - - def GetListCtrl(self,) -> 'PyCListCtrl': - """ - Returns the underlying list control object. - -Args: - - - -Returns: - - PyCListCtrl - - """ - pass - - - def OnCommand(self,wparam:'typing.Any',lparam:'typing.Any') -> 'None': - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(typing.Any): - lparam(typing.Any):See Also - -Returns: - - None - - """ - pass - - -class PyCMDIChildWnd(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ActivateFrame(self,cmdShow:'typing.Any'=-1) -> 'None': - """ - Calls the underlying MFC ActivateFrame method. - -Args: - - cmdShow(typing.Any):The status of the window.See Also - -Returns: - - None - - """ - pass - - - def CreateWindow(self,wndClass:'str',title:'str',style:'typing.Any',PyCWnd:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]'=None,createContext:'typing.Any'=None) -> 'typing.Any': - """ - Creates the actual window for the PyCWnd object. - -Args: - - wndClass(str):The window class name, or None - title(str):The window title - style(typing.Any):The window style - PyCWnd(typing.Any):The parent window - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The default rectangle - createContext(typing.Any):A tuple representing a CREATECONTEXT structure.CommentsYou do not need to call this method if you use the MFC Document/View framework. - -Returns: - - typing.Any - - """ - pass - - - def GetMDIFrame(self,) -> 'None': - """ - Returns the MDI parent frame - -Args: - - - -Returns: - - None - - """ - pass - - - def MDIActivate(self,cmdShow:'typing.Any'=-1) -> 'None': - """ - Activates the MDI frame independent of the main frame. - -Args: - - cmdShow(typing.Any):The status of the window.See Also - -Returns: - - None - - """ - pass - - - def PreCreateWindow(self,createStruct:'typing.Any') -> 'typing.Any': - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(typing.Any):A tuple representing a CREATESTRUCT structure.See Also - -Returns: - - typing.Any - - """ - pass - - - def PreTranslateMessage(self,) -> 'None': - """ - Calls the base PreTranslateMessage handler - -Args: - - - -Returns: - - None - - """ - pass - - - def OnCommand(self,wparam:'typing.Any',lparam:'typing.Any') -> 'None': - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(typing.Any): - lparam(typing.Any):See Also - -Returns: - - None - - """ - pass - - - def OnClose(self,) -> 'None': - """ - Calls the standard Python framework OnClose handler - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCMDIFrameWnd(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetMDIClient(self,) -> 'PyCMDIFrameWnd': - """ - Returns the MDI client window - -Args: - - - -Returns: - - PyCMDIFrameWnd - - """ - pass - - - def MDIGetActive(self,) -> 'typing.Tuple[PyCMDIChildWnd, typing.Any]': - """ - Retrieves the current active MDI child window, along - -with a flag indicating whether the child window is maximized. - -Args: - - - -Returns: - - typing.Tuple[PyCMDIChildWnd, typing.Any] - - """ - pass - - - def MDIActivate(self,window:'PyCWnd') -> 'PyCMDIFrameWnd': - """ - Activate an MDI child window - -Args: - - window(PyCWnd):The window to activate. - -Returns: - - PyCMDIFrameWnd - - """ - pass - - - def MDINext(self,fNext:'typing.Any'=0) -> 'None': - """ - Activates the next MDI window - -Args: - - fNext(typing.Any):Indicates if the next (0) or previous (non-zero) window is requested.CommentsUnlike MFC, this version supports the fNext param in the WM_MDINEXT message. - -Returns: - - None - - """ - pass - - - def PreCreateWindow(self,createStruct:'typing.Any') -> 'typing.Any': - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(typing.Any):A tuple representing a CREATESTRUCT structure.See Also - -Returns: - - typing.Any - - """ - pass - - - def PreTranslateMessage(self,) -> 'None': - """ - Calls the base PreTranslateMessage handler - -Args: - - - -Returns: - - None - - """ - pass - - - def OnCommand(self,wparam:'typing.Any',lparam:'typing.Any') -> 'None': - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(typing.Any): - lparam(typing.Any):See Also - -Returns: - - None - - """ - pass - - - def OnContextHelp(self,) -> 'typing.Any': - """ - Calls the underlying MFC OnContextHelp method. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def OnClose(self,) -> 'None': - """ - Calls the standard Python framework OnClose handler - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCMenu(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - 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 - -by setting values in nFlags. - -Args: - - flags(typing.Any):Specifies information about the state of the new menu item when it is added to the menu. May be a combination of the win32con.MF_* values. - _id(typing.Any):Specifies either the command ID of the new menu item. - value(typing.Union[str, typing.Any]):Specifies the content of the new menu item. If used, flags must contain win32con.MF_STRING. - -Returns: - - None - - """ - pass - - - def DeleteMenu(self,_id:'typing.Any',flags:'typing.Any') -> 'str': - """ - Deletes the specified menu item. - -Args: - - _id(typing.Any):The id of the item being deleted. - flags(typing.Any):Specifies how the id parameter is interpreted. It must be one of win32con.MF_BYCOMMAND or win32con.MF_BYPOSITION. - -Returns: - - str - - """ - pass - - - def EnableMenuItem(self,_id:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - Enables, disables, or dims a menu item. - -Args: - - _id(typing.Any):Specifies the command ID of the menu item. This parameter can specify pop-up menu items as well as standard menu items. - flags(typing.Any):Specifies the action to take. It can be a combination of MF_DISABLED, MF_ENABLED, or MF_GRAYED, with MF_BYCOMMAND or MF_BYPOSITIONCommentsThe PyCMenu::CreateMenu, PyCMenu::InsertMenu, PyCMenu::ModifyMenu, and PyCMenu::LoadMenuIndirect member functions can also set the state (enabled, disabled, or dimmed) of a menu item. - -Returns: - - typing.Any - - """ - pass - - - def GetHandle(self,) -> 'typing.Any': - """ - Returns the menu object's underlying hMenu. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetMenuItemCount(self,) -> 'typing.Any': - """ - Determines the number of items in a menu. - -Args: - - - -Returns: - - typing.Any:PyCMenu.GetMenuItemCount - -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 - - - def GetMenuItemID(self,pos:'typing.Any') -> 'typing.Any': - """ - Returns the item ID for the specified item in a pop-up menu. - -Args: - - pos(typing.Any):The position (zero-based) of the menu item whose ID is being retrieved.CommentsIf the specified item is a pop-up menu (as opposed to an item within the pop-up menu), the return value is -1. If nPos corresponds to a SEPARATOR menu item, the return value is 0. - -Returns: - - typing.Any - - """ - pass - - - def GetMenuString(self,_id:'typing.Any',arg:'typing.Any') -> 'str': - """ - Returns the string for a specified menu item. - -Args: - - _id(typing.Any):The id of the item being requested. - arg(typing.Any):Specifies how the id parameter is interpreted. It must be one of win32con.MF_BYCOMMAND or win32con.MF_BYPOSITION. - -Returns: - - str - - """ - pass - - - def GetSubMenu(self,pos:'typing.Any') -> 'PyCMenu': - """ - Returns a submenu. - -Args: - - pos(typing.Any):The position (zero-based) of the menu item being retrieved. - -Returns: - - PyCMenu - - """ - pass - - - def InsertMenu(self,pos:'typing.Any',flags:'typing.Any',_id:'typing.Union[PyCMenu, typing.Any]'=0,value:'typing.Union[str, typing.Any]'=None) -> 'None': - """ - Inserts an item into a menu. - -Args: - - pos(typing.Any):The position (zero-based) the item should be inserted. - flags(typing.Any):Flags for the new item. - _id(typing.Union[PyCMenu, typing.Any]):The ID for a new menu item, or handle to a submenu - value(typing.Union[str, typing.Any]):A string for the menu item. - -Returns: - - None - - """ - pass - - - def ModifyMenu(self,pos:'typing.Any',flags:'typing.Any',_id:'typing.Any'=0,value:'typing.Union[str, typing.Any]'=None) -> 'None': - """ - Modify an item in a menu. - -Args: - - pos(typing.Any):The position (zero-based) the item to be changed. - flags(typing.Any):Flags for the item. - _id(typing.Any):The ID for the item. - value(typing.Union[str, typing.Any]):A string for the menu item. - -Returns: - - None - - """ - pass - - - def TrackPopupMenu(self,arg:'typing.Tuple[typing.Any, typing.Any]',arg1:'typing.Any',arg2:'PyCWnd') -> 'None': - """ - Creates a popup menu anywhere on the screen. - -Args: - - arg(typing.Tuple[typing.Any, typing.Any]):The position for the menu.. - arg1(typing.Any):Flags for the menu. - arg2(PyCWnd):The owner of the menu.CommentsThe TrackPopupMenu function displays a floating pop-up menu at the 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 returned instead of the normal exception. - -Returns: - - None:The owner of the menu. -Comments - -The TrackPopupMenu function displays a floating pop-up menu at the - -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 - -returned instead of the normal exception. - - - """ - pass - - -class PyCOleClientItem(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateNewItem(self,) -> 'None': - """ - Creates an embedded item. - -Args: - - - -Returns: - - None - - """ - pass - - - def Close(self,) -> 'None': - """ - Closes the item - -Args: - - - -Returns: - - None - - """ - pass - - - def DoVerb(self,) -> 'None': - """ - Executes the specified verb. - -Args: - - - -Returns: - - None - - """ - pass - - - def Draw(self,) -> 'None': - """ - Draws the OLE item into the specified bounding rectangle using the specified device - -context. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetActiveView(self,) -> 'PyCView': - """ - Obtains the active view for the item - -Args: - - - -Returns: - - PyCView - - """ - pass - - - def GetDocument(self,) -> 'PyCDocument': - """ - Obtains the current document for the item - -Args: - - - -Returns: - - PyCDocument - - """ - pass - - - def GetInPlaceWindow(self,) -> 'PyCWnd': - """ - Obtains the window in which the item has been opened for - -in-place editing. - -Args: - - - -Returns: - - PyCWnd - - """ - pass - - - def GetItemState(self,) -> 'None': - """ - Obtains the OLE item's current state - -Args: - - - -Returns: - - None - - """ - pass - - - def GetObject(self,) -> 'PyIUnknown': - """ - Returns the COM object to the item. This is the m_lpObject - -variable in MFC. - -Args: - - - -Returns: - - PyIUnknown - - """ - pass - - - def GetStorage(self,) -> 'None': - """ - Returns the COM object used for storage - -Args: - - - -Returns: - - None - - """ - pass - - - def OnActivate(self,) -> 'None': - """ - Calls the underlying MFC method. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnChange(self,) -> 'None': - """ - Calls the underlying MFC method. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnChangeItemPosition(self,) -> 'typing.Any': - """ - Calls the underlying MFC method. - -Args: - - - -Returns: - - typing.Any:PyCOleClientItem.OnChangeItemPosition - -int = OnChangeItemPosition()Calls the underlying MFC method. -Return ValueThe result is a BOOL indicating if the function succeeded. No exception is thrown. - - - """ - pass - - - def OnDeactivateUI(self,) -> 'typing.Any': - """ - Calls the underlying MFC method. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def Run(self,) -> 'None': - """ - Runs the application associated with this item. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetItemRects(self,) -> 'None': - """ - Sets the bounding rectangle or the visible rectangle of the OLE item. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCOleDialog(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCOleDocument(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def EnableCompoundFile(self,bEnable:'typing.Any'=1) -> 'None': - """ - Call this function if you want to store the document using the - -compound-file format. - -Args: - - bEnable(typing.Any):Specifies whether compound file support is enabled or disabled. - -Returns: - - None - - """ - pass - - - def GetStartPosition(self,) -> 'typing.Any': - """ - Obtains the position of the first item in the document. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetNextItem(self,pos:'typing.Any') -> 'typing.Tuple[typing.Any, PyCOleClientItem]': - """ - Call this function repeatedly to access each of - -the items in your document. - -Args: - - pos(typing.Any):The position to iterate from. - -Returns: - - typing.Tuple[typing.Any, PyCOleClientItem] - - """ - pass - - - def GetInPlaceActiveItem(self,wnd:'PyCWnd') -> 'PyCOleClientItem': - """ - Obtains the OLE item that is currently activated - -in place in the frame window containing the view identified by obWnd. - -Args: - - wnd(PyCWnd):The window. - -Returns: - - PyCOleClientItem - - """ - pass - - -class PyCOleInsertDialog(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetClassID(self,) -> 'typing.Any': - """ - Returns the CLSID associated with the selected item - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetSelectionType(self,) -> 'typing.Any': - """ - Returns the type of selection made - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetPathName(self,) -> 'typing.Any': - """ - Returns the full path to the file selected in the dialog box - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyCPrintDialog(object): - """An object which encapsulates an MFC CPrintDialog object.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCPrintInfo(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def DocObject(self,) -> 'None': - """ - Return true if the document being printed is a DocObject. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDwFlags(self,) -> 'None': - """ - A flags specifying DocObject printing operations. Valid only if data member - -m_bDocObject is TRUE. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetDwFlags(self,) -> 'None': - """ - Set a flag specifying DocObject printing operations. Valid only if data member - -m_bDocObject is TRUE. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDocOffsetPage(self,) -> 'None': - """ - Get the number of pages preceding the first page of a particular DocObject - -in a combined DocObject print job. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetDocOffsetPage(self,) -> 'None': - """ - Set the number of pages preceding the first page of a particular DocObject - -in a combined DocObject print job. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetPrintDialog(self,) -> 'None': - """ - Set a pointer to the CPrintDialog object used to display the Print dialog box - -for the print job. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDirect(self,) -> 'None': - """ - TRUE if the Print dialog box will be bypassed for direct printing; FALSE otherwise. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetDirect(self,) -> 'None': - """ - Sets to TRUE if the Print dialog box will be bypassed for direct printing; FALSE - -otherwise. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPreview(self,) -> 'None': - """ - A flag indicating whether the document is being previewed. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetPreview(self,) -> 'None': - """ - Set whether the document is being previewed. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetContinuePrinting(self,) -> 'None': - """ - A flag indicating whether the framework should continue the print loop. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetContinuePrinting(self,) -> 'None': - """ - Set whether the framework should continue the print loop. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCurPage(self,) -> 'None': - """ - Get the number of the current page. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetCurPage(self,) -> 'None': - """ - Set the number of the current page. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetNumPreviewPages(self,) -> 'None': - """ - Get the number of pages displayed in preview mode. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetNumPreviewPages(self,) -> 'None': - """ - Set the number of pages displayed in preview mode. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetUserData(self,) -> 'None': - """ - Get a user-created structure. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetUserData(self,) -> 'None': - """ - Set a user-created structure. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDraw(self,) -> 'None': - """ - Get the usable drawing area of the page in logical coordinates. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetDraw(self,) -> 'None': - """ - Set the usable drawing area of the page in logical coordinates. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPageDesc(self,) -> 'None': - """ - Get the format string used to display the page numbers during print preview - -Args: - - - -Returns: - - None - - """ - pass - - - def SetPageDesc(self,) -> 'None': - """ - Set the format string used to display the page numbers during print preview - -Args: - - - -Returns: - - None - - """ - pass - - - def GetMinPage(self,) -> 'None': - """ - Get the number of the first page of the document. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetMinPage(self,) -> 'None': - """ - Set the number of the first page of the document. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetMaxPage(self,) -> 'None': - """ - Get the number of the last page of the document. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetMaxPage(self,) -> 'None': - """ - Set the number of the last page of the document. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetOffsetPage(self,) -> 'None': - """ - 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 - -pInfo->GetOffsetPage(), the link fails to find its definition. Allways returns 0. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetFromPage(self,) -> 'None': - """ - The number of the first page to be printed. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetToPage(self,) -> 'None': - """ - The number of the last page to be printed. - -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 - -DoModal finishes. - -Args: - - hdc(typing.Any):The DC.MFC References - -Returns: - - None - - """ - pass - - - def CreatePrinterDC(self,) -> 'None': - """ - Handle to the newly created printer device context, call only after DoModal - -finishes. - -Args: - - - -Returns: - - None - - """ - pass - - - def DoModal(self,) -> 'None': - """ - Call DoModal on the dialog. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetCopies(self,) -> 'None': - """ - The number of copies requested, call only after DoModal finishes. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDefaults(self,) -> 'None': - """ - 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 - -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 - -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) - -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. - -Args: - - - -Returns: - - None - - """ - pass - - - def FreeDefaults(self,) -> 'None': - """ - 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. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDeviceName(self,) -> 'None': - """ - The name of the currently selected printer, call only after DoModal finishes. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDriverName(self,) -> 'None': - """ - The name of the currently selected printer device driver, call only after - -DoModal finishes. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDlgFromPage(self,) -> 'None': - """ - Retrieves the starting page of the print range. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetDlgToPage(self,) -> 'None': - """ - Retrieves the ending page of the print range. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPortName(self,) -> 'None': - """ - The name of the currently selected printer port, call only after DoModal - -finishes. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPrinterDC(self,) -> 'None': - """ - 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 - -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. - -Args: - - - -Returns: - - None - - """ - pass - - - def PrintAll(self,) -> 'None': - """ - Nonzero if all pages in the document are to be printed; otherwise 0, call only after - -DoModal finishes. - -Args: - - - -Returns: - - None - - """ - pass - - - def PrintCollate(self,) -> 'None': - """ - Nonzero if the user selects the collate check box in the dialog box; otherwise - -0, call only after DoModal finishes. - -Args: - - - -Returns: - - None - - """ - pass - - - def PrintRange(self,) -> 'None': - """ - Nonzero if only a range of pages in the document are to be printed; otherwise 0, - -call only after DoModal finishes. - -Args: - - - -Returns: - - None - - """ - pass - - - def PrintSelection(self,) -> 'None': - """ - Nonzero if only the selected items are to be printed; otherwise 0., call only - -after DoModal finishes - -Args: - - - -Returns: - - None - - """ - pass - - - def GetHDC(self,) -> 'None': - """ - 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 - -undefined. If both flags are specified, PD_RETURNDC has priority. - -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 - -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, - -PD_ENABLEPRINTTEMPLATEHANDLE, PD_ENABLESETUPHOOK, PD_ENABLESETUPTEMPLATE, PD_ENABLESETUPTEMPLATEHANDLE, - -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_USEDEVMODECOPIESANDCOLLATE. - -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 - -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, - -PD_ENABLEPRINTTEMPLATEHANDLE, PD_ENABLESETUPHOOK, PD_ENABLESETUPTEMPLATE, PD_ENABLESETUPTEMPLATEHANDLE, - -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_USEDEVMODECOPIESANDCOLLATE. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetFromPage(self,) -> 'None': - """ - The number of the first page to be printed. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetToPage(self,) -> 'None': - """ - The number of the last page to be printed. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPRINTDLGMinPage(self,) -> 'None': - """ - 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 - -disabled. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetPRINTDLGMinPage(self,) -> 'None': - """ - 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 - -disabled. - -Args: - - - -Returns: - - None - - """ - pass - - - def GetPRINTDLGCopies(self,) -> 'None': - """ - 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, - -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 - -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 - -information, see the description of the PD_USEDEVMODECOPIESANDCOLLATE flag. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetPRINTDLGCopies(self,) -> 'None': - """ - 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, - -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 - -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 - -information, see the description of the PD_USEDEVMODECOPIESANDCOLLATE flag. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCProgressCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,style:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',parent:'PyCWnd',_id:'typing.Any') -> 'None': - """ - Creates the actual control. - -Args: - - style(typing.Any):The style for the control. - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The size and position of the control. - parent(PyCWnd):The parent window of the control. Usually a PyCDialog. - _id(typing.Any):The control's ID. - -Returns: - - None - - """ - pass - - - def SetRange(self,nLower:'typing.Any'=1,nUpper:'typing.Any'=1) -> 'None': - """ - Set the control's bounds - -Args: - - nLower(typing.Any):Specifies the lower limit of the range (default is zero). - nUpper(typing.Any):Specifies the upper limit of the range (default is 100). - -Returns: - - None - - """ - pass - - - def SetPos(self,nPos:'typing.Any'=1) -> 'typing.Any': - """ - Set the control's position - -Args: - - nPos(typing.Any):New position of the progress bar control. - -Returns: - - typing.Any - - """ - pass - - - def OffsetPos(self,nPos:'typing.Any'=1) -> 'typing.Any': - """ - Advances the progress bar control's current position by the increment - -specified - -Args: - - nPos(typing.Any):Amount to advance the position. - -Returns: - - typing.Any - - """ - pass - - - def SetStep(self,nStep:'typing.Any'=1) -> 'typing.Any': - """ - Specifies the step increment for a progress bar control. - -Args: - - nStep(typing.Any):New step increment. - -Returns: - - typing.Any - - """ - pass - - - def StepIt(self,) -> 'typing.Any': - """ - Advances the current position for a progress bar control by the step increment. - -Returns previous position. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyCPropertyPage(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CancelToClose(self,) -> 'None': - """ - Changes the Cancel button to Close. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnCancel(self,) -> 'None': - """ - Calls the default MFC OnCancel handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnOK(self,) -> 'None': - """ - Calls the default MFC OnOK handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnApply(self,) -> 'None': - """ - Calls the default MFC OnApply handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnReset(self,) -> 'None': - """ - Calls the default MFC OnReset handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnQueryCancel(self,) -> 'None': - """ - Calls the default MFC OnQueryCancel handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnWizardBack(self,) -> 'None': - """ - Calls the default MFC OnWizardBack handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnWizardNext(self,) -> 'None': - """ - Calls the default MFC OnWizardNext handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnWizardFinish(self,) -> 'None': - """ - Calls the default MFC OnWizardFinish handler. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnSetActive(self,) -> 'typing.Any': - """ - Calls the default MFC OnSetActive handler. - -Args: - - - -Returns: - - typing.Any:PyCPropertyPage.OnSetActive virtual method -Return ValueThe result is true if the page should be made active. - -Typically this result should be passed to the original OnSetActive handler. - - - """ - pass - - - def OnKillActive(self,) -> 'typing.Any': - """ - Calls the default MFC OnKillActive handler. - -Args: - - - -Returns: - - typing.Any:PyCPropertyPage.OnKillActive virtual method -Return ValueThe result is true if the page should be deselected. - -Typically this result should be passed to the original OnSetActive handler. - - - """ - pass - - - def SetModified(self,bChanged:'typing.Any'=1) -> 'None': - """ - Sets the modified flag. - -Args: - - bChanged(typing.Any):A flag to indicate the new modified state. - -Returns: - - None - - """ - pass - - - def SetPSPBit(self,bitMask:'typing.Any',bitValue:'typing.Any') -> 'None': - """ - Sets or clears a bit in m_psp.dwFlags - -Args: - - bitMask(typing.Any):The PSP_* bit mask constant - bitValue(typing.Any):1 to set, 0 to clear - -Returns: - - None - - """ - pass - - -class PyCPropertySheet(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddPage(self,page:'PyCPropertyPage') -> 'None': - """ - Adds the supplied page with the rightmost tab in the property sheet. - -Args: - - page(PyCPropertyPage):The page to be added.CommentsAdd pages to the property sheet in the left-to-right order you want them to appear.MFC References - -Returns: - - None - - """ - pass - - - def CreateWindow(self,style:'typing.Any',exStyle:'typing.Any',parent:'PyCWnd'=None) -> 'None': - """ - Displays the property sheet as a modeless dialog. - -Args: - - style(typing.Any):The style for the window. - exStyle(typing.Any):The extended style for the window. - parent(PyCWnd):The parent of the dialog. - -Returns: - - None - - """ - pass - - - def DoModal(self,) -> 'typing.Any': - """ - Displays the property sheet as a modal dialog. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def EnableStackedTabs(self,stacked:'typing.Any') -> 'PyCPropertyPage': - """ - Enables or disables stacked tabs. - -Args: - - stacked(typing.Any):A boolean flag - -Returns: - - PyCPropertyPage - - """ - pass - - - def EndDialog(self,result:'typing.Any') -> 'None': - """ - Closes the dialog, with the specified result. - -Args: - - result(typing.Any):The result to be returned by DoModal. - -Returns: - - None - - """ - pass - - - def GetActiveIndex(self,) -> 'typing.Any': - """ - Retrieves the index of the active page of the property sheet. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetActivePage(self,) -> 'PyCPropertyPage': - """ - Returns the currently active property page. - -Args: - - - -Returns: - - PyCPropertyPage - - """ - pass - - - def GetPage(self,pageNo:'typing.Any') -> 'PyCPropertyPage': - """ - Returns the specified property page. - -Args: - - pageNo(typing.Any):The index of the page toretrieve.MFC References - -Returns: - - PyCPropertyPage - - """ - pass - - - def GetPageIndex(self,page:'PyCPropertyPage') -> 'typing.Any': - """ - Retrieves the index of the specified page of the property sheet. - -Args: - - page(PyCPropertyPage):The page. - -Returns: - - typing.Any - - """ - pass - - - def GetPageCount(self,) -> 'typing.Any': - """ - Returns the number of pages. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetTabCtrl(self,) -> 'PyCTabCtrl': - """ - Returns the tab control used by the sheet. - -Args: - - - -Returns: - - PyCTabCtrl - - """ - pass - - - def OnInitDialog(self,) -> 'typing.Any': - """ - Calls the default MFC OnInitDialog handler. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def PressButton(self,button:'typing.Any') -> 'None': - """ - Simulates the choice of the specified button in a property sheet. - -Args: - - button(typing.Any):The button to press - -Returns: - - None - - """ - pass - - - def RemovePage(self,offset:'typing.Any',page:'typing.Any') -> 'None': - """ - Removes the specified page from the sheet. - -Args: - - offset(typing.Any):The page number to removeAlternative Parameters - page(typing.Any):The page to remove - -Returns: - - None - - """ - pass - - - def SetActivePage(self,page:'PyCPropertyPage') -> 'None': - """ - Programmatically sets the active page object. - -Args: - - page(PyCPropertyPage):The page. - -Returns: - - None - - """ - pass - - - def SetTitle(self,title:'str') -> 'None': - """ - Sets the caption for the property sheet. - -Args: - - title(str):The new caption - -Returns: - - None - - """ - pass - - - def SetFinishText(self,text:'str') -> 'None': - """ - Sets the text for the Finish button - -Args: - - text(str):The next for the button - -Returns: - - None - - """ - pass - - - def SetWizardMode(self,) -> 'None': - """ - Enables the wizard mode - -Args: - - - -Returns: - - None - - """ - pass - - - def SetWizardButtons(self,flags:'typing.Any') -> 'None': - """ - Enables the wizard buttons - -Args: - - flags(typing.Any):The wizard flags - -Returns: - - None - - """ - pass - - - def SetPSHBit(self,bitMask:'typing.Any',bitValue:'typing.Any') -> 'None': - """ - Sets or clears a bit in m_psh.dwFlags - -Args: - - bitMask(typing.Any):The PSH_* bit mask constant - bitValue(typing.Any):1 to set, 0 to clear - -Returns: - - None - - """ - pass - - -class PyCRect(object): - """A Python interface the the MFC CRect class.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCRgn(object): - """An object encapsulating an MFC PyCRgn class.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCRichEditCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def Clear(self,) -> 'typing.Any': - """ - Clears all text in an edit control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def Copy(self,) -> 'None': - """ - Copys the current selection to the clipboard. - -Args: - - - -Returns: - - None - - """ - pass - - - def CreateWindow(self,style:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',parent:'PyCWnd',_id:'typing.Any') -> 'None': - """ - Creates a rich edit control window. - -Args: - - style(typing.Any):The control style - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The position of the control - parent(PyCWnd):The parent window. Must not be None - _id(typing.Any):The control ID - -Returns: - - None - - """ - pass - - - def Cut(self,) -> 'None': - """ - Cuts the current selection to the clipboard. - -Args: - - - -Returns: - - None - - """ - pass - - - def FindText(self,charPos:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': - """ - Finds text in the control - -Args: - - charPos(typing.Any):The character position - -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 - -by charPos. - -Args: - - charPos(typing.Any):The character positionReturn ValueThe return value is a win32ui::CHARFORMAT tuple - -Returns: - - typing.Any:The character positionReturn ValueThe return value is a win32ui::CHARFORMAT tuple - - - - """ - pass - - - def GetDefaultCharFormat(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any:CRichEditCtrl::GetDefaultCharFormat -Return ValueThe return value is a win32ui::CHARFORMAT tuple - - - - """ - pass - - - def GetEventMask(self,) -> 'typing.Any': - """ - Returns the current event mask. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetSelectionCharFormat(self,) -> 'typing.Any': - """ - Returns the character formatting of the selection. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetFirstVisibleLine(self,) -> 'typing.Any': - """ - Returns zero-based index of the topmost visible line. - -Args: - - - -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 - - - def GetParaFormat(self,) -> 'typing.Any': - """ - Returns the current paragraph formatting attributes. - -Args: - - - -Returns: - - typing.Any:CRichEditCtrl::GetParaFormat -Return ValueThe return value is a win32ui::PARAFORMAT tuple - - - - """ - pass - - - def GetSel(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Returns the start and end of the current selection. - -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 - -end of the current selection) - - - """ - pass - - - def GetSelText(self,) -> 'str': - """ - Returns the currently selected text - -Args: - - - -Returns: - - str - - """ - pass - - - def GetTextLength(self,) -> 'typing.Any': - """ - Returns the length of the text in the control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetLine(self,lineNo:'typing.Any') -> 'typing.Any': - """ - Returns the text in a specified line. - -Args: - - lineNo(typing.Any):Contains the zero-based index value for the desired line.CommentsThis function is not an MFC wrapper. - -Returns: - - typing.Any - - """ - pass - - - def GetModify(self,) -> 'typing.Any': - """ - Nonzero if the text in this control has been modified; otherwise 0. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetLineCount(self,) -> 'typing.Any': - """ - Gets the number of lines in an edit control. - -Args: - - - -Returns: - - typing.Any:CRichEditCtrl::GetLineCount -Return ValueThe number of lines in the buffer. If the control is empty, the return value is 1. - - - """ - pass - - - def LimitText(self,nChars:'typing.Any'=0) -> 'None': - """ - Sets max length of text that user can enter - -Args: - - nChars(typing.Any):Specifies the length (in bytes) of the text that the user can enter. If this parameter is 0, the text length is set to UINT_MAX bytes. This is the default behavior.MFC References - -Returns: - - None - - """ - pass - - - def LineFromChar(self,charNo:'typing.Any'=-1) -> 'typing.Any': - """ - Returns the line number of the specified character. - -Args: - - charNo(typing.Any):Contains the zero-based index value for the desired character in the text of the edit control, or -1. If -1, then it specifies the current line.MFC References - -Returns: - - typing.Any:CRichEditCtrl::LineFromChar -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 there is no selection, the current line number is returned. - - - """ - pass - - - def LineIndex(self,lineNo:'typing.Any'=-1) -> 'typing.Any': - """ - Retrieves the character index of a line within a multiple-line edit control. - -Args: - - lineNo(typing.Any):Contains the index value for the desired line in the text of the edit control, or contains -1. If -1, then it specifies the current line.CommentsThis method only works on multi-linr edit controls.MFC References - -Returns: - - typing.Any:CRichEditCtrl::LineIndex -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 edit control. - - - """ - pass - - - def LineScroll(self,nLines:'typing.Any',nChars:'typing.Any'=0) -> 'typing.Any': - """ - Scroll the control vertically and horizontally - -Args: - - nLines(typing.Any):Specifies the number of lines to scroll vertically. - nChars(typing.Any):Specifies the number of character positions to scroll horizontally. This value is ignored if the edit control has either the ES_RIGHT or ES_CENTER style.CommentsThis method only works on multi-linr edit controls.MFC References - -Returns: - - typing.Any - - """ - pass - - - def Paste(self,) -> 'None': - """ - Pastes the contents of the clipboard into the control. - -Args: - - - -Returns: - - None - - """ - pass - - - def ReplaceSel(self,text:'str') -> 'None': - """ - Replaces the selection with the specified text. - -Args: - - text(str):The text to replace the selection with.MFC References - -Returns: - - None - - """ - pass - - - def SetBackgroundColor(self,bSysColor:'typing.Any',cr:'typing.Any'=0) -> 'typing.Any': - """ - Sets the background color for the control. - -Args: - - bSysColor(typing.Any):Indicates if the background color should be set to the system value. If this value is TRUE, cr is ignored. - cr(typing.Any):The requested background color. Used only if bSysColor is FALSE.MFC References - -Returns: - - typing.Any:CRichEditCtrl::SetEventMask -Return ValueThe return value is the previous background color. - - - """ - pass - - - def SetDefaultCharFormat(self,charFormat:'typing.Any') -> 'None': - """ - None - -Args: - - charFormat(typing.Any):A charformat tuple. See win32ui::CHARFORMAT tuple for details.MFC References - -Returns: - - None - - """ - pass - - - def SetEventMask(self,eventMask:'typing.Any') -> 'typing.Any': - """ - Sets the event motification mask. - -Args: - - eventMask(typing.Any):The new event mask. Must be one of the win32con.ENM_* flags.MFC References - -Returns: - - typing.Any:CRichEditCtrl::SetEventMask -Return ValueThe return value is the previous event mask. - - - """ - pass - - - def SetSelectionCharFormat(self,charFormat:'typing.Any') -> 'None': - """ - Sets the current selections character formatting attributes. - -Args: - - charFormat(typing.Any):A charformat tuple. See win32ui::CHARFORMAT tuple for details.MFC References - -Returns: - - None - - """ - pass - - - def SetModify(self,modified:'typing.Any'=1) -> 'None': - """ - Sets the modified flag for this control - -Args: - - modified(typing.Any):Indicates the new value for the modified flag.MFC References - -Returns: - - None - - """ - pass - - - def SetOptions(self,op:'typing.Any',flags:'typing.Any') -> 'None': - """ - Sets options for the control. - -Args: - - op(typing.Any):Indicates the operation. Must be one of the win32con.ECOOP_* flags. - flags(typing.Any):Indicates the options. Must be one a combination of win32con.ECO_* flags.MFC References - -Returns: - - None - - """ - pass - - - def SetParaFormat(self,paraFormat:'typing.Any') -> 'typing.Any': - """ - Sets the paragraph formatting - -Args: - - paraFormat(typing.Any):A charformat tuple. See win32ui::PARAFORMAT tuple for details.MFC References - -Returns: - - typing.Any:CRichEditCtrl::SetParaFormat -Return ValueThis function seems to return occasionally return failure, but - -the formatting is applied. Therefore an exception is not raised on failure, - -but the BOOL return code is passed back. - - - """ - pass - - - def SetReadOnly(self,bReadOnly:'typing.Any'=1) -> 'None': - """ - Sets or clears the read-only status of the listbox. - -Args: - - bReadOnly(typing.Any):The read-only state to set.MFC References - -Returns: - - None - - """ - pass - - - def SetSel(self,start:'typing.Any',end:'typing.Any',arg:'typing.Any') -> 'None': - """ - Sets the selection in the edit control. - -Args: - - start(typing.Any):Specifies the starting position. If start is 0 and end is -1, all the text in the edit control is selected. If start is -1, any current selection is removed. - end(typing.Any):Specifies the ending position.Alternative Parameters - arg(typing.Any):As for normal start, end args.MFC References - -Returns: - - None - - """ - pass - - - def SetSelAndCharFormat(self,charFormat:'typing.Any') -> 'None': - """ - Sets the selection and char format. - -Args: - - charFormat(typing.Any):A charformat tuple. See win32ui::CHARFORMAT tuple for details.CommentsHighly optimised for speed for color editors.MFC References - -Returns: - - None - - """ - pass - - - def SetTargetDevice(self,dc:'PyCDC',lineWidth:'typing.Any') -> 'None': - """ - Sets the target device for the control - -Args: - - dc(PyCDC):The new DC - may be None - lineWidth(typing.Any):Line width to use for formatting.MFC References - -Returns: - - None - - """ - pass - - - def StreamIn(self,_format:'typing.Any',method:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Invokes a callback to stream data into the control. - -Args: - - _format(typing.Any):The format. One of the win32con.SF_* flags (SF_TEXT,SF_RTF) - method(typing.Any):A callable object (eg, a method or function) This method is called with a single integer param, which is the maximum number of bytes to fetch. The method should return a zero length string, or None to finish the operation, and a string otherwise.MFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any]:CRichEditCtrl::StreamIn -Return ValueThe return value is a tuple of (no bytes written, error code) - - - """ - pass - - - def StreamOut(self,_format:'typing.Any',method:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Invokes a callback to stream data into the control. - -Args: - - _format(typing.Any):The format. One of the win32con.SF_* flags (SF_TEXT,SF_RTF) and may also combine SFF_SELECTION. - method(typing.Any):A callable object (eg, a method or function) This method is called with a string parameter. It should return an integer, zero to abort, non zero otherwise.MFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any]:CRichEditCtrl::StreamOut -Return ValueThe return value is a tuple of (no bytes written, error code) - - - """ - pass - - -class PyCRichEditDoc(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def OnCloseDocument(self,) -> 'None': - """ - Call the MFC OnCloseDocument handler. - -This routine is provided so a document object which overrides this method - -can call the original MFC version if required. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCRichEditDocTemplate(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def DoCreateRichEditDoc(self,fileName:'str'=None) -> 'PyCRichEditDoc': - """ - Creates an underlying document object. - -Args: - - fileName(str):The name of the file to load. - -Returns: - - PyCRichEditDoc - - """ - pass - - -class PyCRichEditView(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetRichEditCtrl(self,) -> 'PyCRichEditCtrl': - """ - Returns the underlying rich edit control object. - -Args: - - - -Returns: - - PyCRichEditCtrl - - """ - pass - - - def SetWordWrap(self,wordWrap:'typing.Any') -> 'typing.Any': - """ - Sets the wordwrap state for the control. - -Args: - - wordWrap(typing.Any):The new word-wrap state.MFC References - -Returns: - - typing.Any - - """ - pass - - - def WrapChanged(self,) -> 'typing.Any': - """ - Calls the underlying WrapChanged method. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SaveTextFile(self,FileName:'typing.Any') -> 'typing.Any': - """ - Saves the contents of the control as a test file - -Args: - - FileName(typing.Any):Name of file to saveCommentsTheere is no equivilent MFC method. This is implemented in this module for performance reasons. - -Returns: - - typing.Any - - """ - pass - - -class PyCScrollView(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetDeviceScrollPosition(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Returns the positon of the scroll bars in device units. - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def GetDC(self,) -> 'PyCDC': - """ - Gets the view's current DC. - -Args: - - - -Returns: - - PyCDC - - """ - pass - - - def GetScrollPosition(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Returns the current position of the scroll bars (in logical units). - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def GetTotalSize(self,) -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Returns the total size of the view in logical units. - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def OnCommand(self,wparam:'typing.Any',lparam:'typing.Any') -> 'None': - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(typing.Any): - lparam(typing.Any):See Also - -Returns: - - None - - """ - pass - - - def ResizeParentToFit(self,bShrinkOnly:'typing.Any'=1) -> 'typing.Any': - """ - Lets the size of a view dictate the size of its frame window. - -Args: - - bShrinkOnly(typing.Any):The kind of resizing to perform. The default value, TRUE, shrinks the frame window if appropriate.CommentsThis is recommended only for views in MDI child frame windows. Use ResizeParentToFit in the OnInitialUpdate handler function of your View class. You must ensure the parent's PyCFrameWnd::RecalcLayout is called before using this method. - -Returns: - - typing.Any - - """ - pass - - - def SetScaleToFitSize(self,size:'typing.Tuple[typing.Any, typing.Any]') -> 'None': - """ - Scales the viewport size to the current window size automatically. - -Args: - - size(typing.Tuple[typing.Any, typing.Any]):The horizontal and vertical sizes to which the view is to be scaled. The scroll view's size is measured in logical units. - -Returns: - - None - - """ - pass - - - def ScrollToPosition(self,position:'typing.Tuple[typing.Any, typing.Any]') -> 'None': - """ - Scrolls to a given point in the view. - -Args: - - position(typing.Tuple[typing.Any, typing.Any]):The position to scroll to. - -Returns: - - None - - """ - pass - - - def SetScrollSizes(self,mapMode:'typing.Any',sizeTotal:'typing.Tuple[typing.Any, typing.Any]',arg:'typing.Tuple[typing.Any, typing.Any]',arg1:'typing.Tuple[typing.Any, typing.Any]') -> 'None': - """ - Sets the sizes of the scroll bars - -Args: - - mapMode(typing.Any):The mapping mode for this view. - sizeTotal(typing.Tuple[typing.Any, typing.Any]):The total size of the view. Sizes are in logical units. Both x and y must be greater than zero. - arg(typing.Tuple[typing.Any, typing.Any]):The number of untils to scroll in response to a page-down command. - arg1(typing.Tuple[typing.Any, typing.Any]):The number of untils to scroll in response to a line-down command. - -Returns: - - None - - """ - pass - - - def UpdateBars(self,) -> 'None': - """ - Update the scroll bars state - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCSliderCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,style:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',parent:'PyCWnd',_id:'typing.Any') -> 'None': - """ - Creates the actual control. - -Args: - - style(typing.Any):The style for the control. - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The size and position of the control. - parent(PyCWnd):The parent window of the control. Usually a PyCDialog. - _id(typing.Any):The control's ID. - -Returns: - - None - - """ - pass - - - def GetLineSize(self,) -> 'typing.Any': - """ - Get the control's position - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetLineSize(self,nLineSize:'typing.Any'=1) -> 'typing.Any': - """ - Set the control's line size. Returns the previous line size. - -Args: - - nLineSize(typing.Any):New line size of the Slider bar control - -Returns: - - typing.Any - - """ - pass - - - def GetPageSize(self,) -> 'typing.Any': - """ - Get the control's position - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetPageSize(self,nPageSize:'typing.Any'=1) -> 'typing.Any': - """ - Set the control's page size Returns the previous page size. - -Args: - - nPageSize(typing.Any):New page size of the Slider bar control. - -Returns: - - typing.Any - - """ - pass - - - def GetRangeMax(self,) -> 'typing.Any': - """ - Get the control's Maximum - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetRangeMin(self,) -> 'typing.Any': - """ - Get the control's Minimum - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetRange(self,) -> 'typing.Any': - """ - Get the control's min and max - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetRange(self,nRangeMin:'typing.Any'=1,nRangeMax:'typing.Any'=1,bRedraw:'typing.Any'=1) -> 'typing.Any': - """ - Set the control's min and max - -Args: - - nRangeMin(typing.Any):New minimum of the Slider bar control. - nRangeMax(typing.Any):New maximum of the Slider bar control. - bRedraw(typing.Any):Should slider be redrawn? - -Returns: - - typing.Any - - """ - pass - - - def GetSelection(self,) -> 'typing.Any': - """ - Get the control's selection start and end positions - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetSelection(self,nRangeMin:'typing.Any'=1,nRangeMax:'typing.Any'=1) -> 'typing.Any': - """ - Set the control's selection start and end positions - -Args: - - nRangeMin(typing.Any):New start of the Slider's selection. - nRangeMax(typing.Any):New end of the Slider's selection. - -Returns: - - typing.Any - - """ - pass - - - def GetChannelRect(self,) -> 'typing.Any': - """ - Get the control's channel rectangle - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetThumbRect(self,) -> 'typing.Any': - """ - Get the control's thumb rectangle - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetPos(self,) -> 'typing.Any': - """ - Get the control's position - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetPos(self,nPos:'typing.Any'=1) -> 'typing.Any': - """ - Set the control's position - -Args: - - nPos(typing.Any):New position of the Slider bar control. - -Returns: - - typing.Any - - """ - pass - - - def GetNumTics(self,) -> 'typing.Any': - """ - Get number of tics in the slider - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetTicArray(self,) -> 'typing.Any': - """ - Get a tuple of slider tic positions - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetTic(self,nTic:'typing.Any'=1) -> 'typing.Any': - """ - Get the position of the specified tic number - -Args: - - nTic(typing.Any):Zero based index of the tic mark - -Returns: - - typing.Any - - """ - pass - - - def GetTicPos(self,nTic:'typing.Any'=1) -> 'typing.Any': - """ - Get the position of the specified tic number in client coordinates - -Args: - - nTic(typing.Any):Zero based index of the tic mark - -Returns: - - typing.Any - - """ - pass - - - def SetTic(self,nTic:'typing.Any'=1) -> 'typing.Any': - """ - Set a tic at the specified position - -Args: - - nTic(typing.Any):Position of the desired tic mark - -Returns: - - typing.Any - - """ - pass - - - def SetTicFreq(self,nFreq:'typing.Any'=1) -> 'typing.Any': - """ - Set the tic frequency - -Args: - - nFreq(typing.Any):Frequency of tic marks - -Returns: - - typing.Any - - """ - pass - - - def ClearSel(self,bRedraw:'typing.Any'=1) -> 'typing.Any': - """ - Clear the selection - -Args: - - bRedraw(typing.Any):Redraw the control? - -Returns: - - typing.Any - - """ - pass - - - def VerifyPos(self,) -> 'typing.Any': - """ - Verify the position is between configured min and max - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def ClearTics(self,bRedraw:'typing.Any'=1) -> 'typing.Any': - """ - Clear the control's tic marks - -Args: - - bRedraw(typing.Any):Redraw the control? - -Returns: - - typing.Any - - """ - pass - - -class PyCSpinButtonCtrl(object): - """A windows spin button control. Encapsulates an MFC CSpinButtonCtrl object.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPos(self,) -> 'typing.Any': - """ - Obtains the current position for a spin button control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetPos(self,pos:'typing.Any') -> 'typing.Any': - """ - Sets the current position for a spin button control. - -Args: - - pos(typing.Any):The new position.Return ValueThe result is the previous position. - -Returns: - - typing.Any:The new position.Return ValueThe result is the previous position. - - - """ - pass - - - def SetRange(self,) -> 'typing.Any': - """ - Sets the upper and lower limits (range) for a spin button control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetRange32(self,) -> 'typing.Any': - """ - Sets the 32 bit upper and lower limits (range) for a spin button control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyCSplitterWnd(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetPane(self,row:'typing.Any',col:'typing.Any') -> 'PyCWnd': - """ - None - -Args: - - row(typing.Any):The row in the splitter. - col(typing.Any):The column in the splitter.CommentsTheoretically the return value can be a PyCWnd object, but currently it will always be a PyCView or derived object. - -Returns: - - PyCWnd - - """ - pass - - - def CreateView(self,view:'PyCView',row:'typing.Any',col:'typing.Any',arg:'typing.Tuple[typing.Any, typing.Any]') -> 'None': - """ - Creates a view in a splitter window - -Args: - - view(PyCView):The view to place in the splitter pane. - row(typing.Any):The row in the splitter to place the view. - col(typing.Any):The column in the splitter to place the view. - arg(typing.Tuple[typing.Any, typing.Any]):The initial size of the new view.MFC References - -Returns: - - None - - """ - pass - - - def CreateStatic(self,parent:'typing.Any',rows:'typing.Any',cols:'typing.Any',style:'typing.Any',_id:'typing.Any') -> 'None': - """ - Creates a static splitter window. - -Args: - - parent(typing.Any):The parent window. - rows(typing.Any):The number of rows in the splitter. - cols(typing.Any):The number of columns in the splitter. - style(typing.Any):Specifies the window style - _id(typing.Any):The child window ID of the window. The ID can be AFX_IDW_PANE_FIRST unless the splitter window is nested inside another splitter window.CommentsA static splitter window is a splitter where the number of panes are fixed at window creation time. Currently this is the only splitter window supported by win32ui.MFC References - -Returns: - - None - - """ - pass - - - def SetColumnInfo(self,column:'typing.Any',ideal:'typing.Any',_min:'typing.Any') -> 'None': - """ - Sets a new minimum height and ideal height for a column - -Args: - - column(typing.Any):The column in the splitter. - ideal(typing.Any):Specifies an ideal height for the splitter window column in pixels. - _min(typing.Any):Specifies a minimum height for the splitter window column in pixels. - -Returns: - - None - - """ - pass - - - def SetRowInfo(self,row:'typing.Any',ideal:'typing.Any',_min:'typing.Any') -> 'None': - """ - Sets a new minimum height and ideal height for a row. - -Args: - - row(typing.Any):The row in the splitter. - ideal(typing.Any):Specifies an ideal height for the splitter window row in pixels. - _min(typing.Any):Specifies a minimum height for the splitter window row in pixels. - -Returns: - - None - - """ - pass - - - def IdFromRowCol(self,row:'typing.Any',col:'typing.Any') -> 'None': - """ - Gets the child window ID for the specified child. - -Args: - - row(typing.Any):The row in the splitter. - col(typing.Any):The col in the splitter - -Returns: - - None - - """ - pass - - - def DoKeyboardSplit(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyCStatusBar(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - 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 - -location specified by index. - -Args: - - index(typing.Any):Index of the pane whose information is to be retrieved.MFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any] - - """ - pass - - - def GetStatusBarCtrl(self,) -> 'PyCStatusBarCtrl': - """ - Gets the statusbar control object for the statusbar. - -Args: - - - -Returns: - - PyCStatusBarCtrl - - """ - pass - - - def SetIndicators(self,indicators:'typing.Any') -> 'None': - """ - Sets each indicator's ID. - -Args: - - indicators(typing.Any):A tuple containing the ID's of the indicators. - -Returns: - - None - - """ - pass - - - def SetPaneInfo(self,index:'typing.Any',_id:'typing.Any',style:'typing.Any',width:'typing.Any') -> 'None': - """ - Sets the specified indicator pane to a new ID, style, and width. - -Args: - - index(typing.Any):Index of the indicator pane whose style is to be set. - _id(typing.Any):New ID for the indicator pane. - style(typing.Any):New style for the indicator pane.The following indicator styles are supported:afxres.SBPS_NOBORDERS - No 3-D border around the pane.afxres.SBPS_POPOUT - Reverse border so that text "pops out."afxres.SBPS_DISABLED - Do not draw text.afxres.SBPS_STRETCH - Stretch pane to fill unused space. Only one pane per status bar can have this style.afxres.SBPS_NORMAL - No stretch, borders, or pop-out. - width(typing.Any):New width for the indicator pane.MFC References - -Returns: - - None - - """ - pass - - -class PyCStatusBarCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,style:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',parent:'PyCWnd',_id:'typing.Any') -> 'None': - """ - Creates the actual control. - -Args: - - style(typing.Any):The style for the control. - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The size and position of the control. - parent(PyCWnd):The parent window of the control. Usually a PyCDialog. - _id(typing.Any):The control's ID. - -Returns: - - None - - """ - pass - - - def GetBorders(self,) -> 'typing.Tuple[typing.Any, typing.Any, typing.Any]': - """ - Retrieve the status bar control's current widths of - -the horizontal and vertical borders and of the space between rectangles. - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any] - - """ - pass - - - def GetParts(self,nParts:'typing.Any') -> 'typing.Any': - """ - Retrieve coordinates of the parts in a status bar control. - -Args: - - nParts(typing.Any):The number of coordinates to retrieveCommentsThis function, as designed in MFC, returns both the *number* of parts, and, through an OUT parameter, an array of ints giving the coordinates of the parts. There is also an IN parameter saying how many coordinates to give back. Here, we're explicitly changing the semantics a bit.GetParts() -> Tuple of all coordinates GetParts(n) -> Tuple of the first n coordinates (or all coordinates, if fewer than n)So, in Python, you can't simultaneously find out how many coordinates there are, and retrieve a subset of them. In a reasonable universe, there would have been GetParts() -> int, and GetCoords() -> List. This means that I need to call the MFC method twice; once to find out how many there are, and another time to get them. - -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 - -bar control. - -Args: - - nPane(typing.Any):Zero-based index of the part whose bounding rectangle is to be retrieved. - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - - """ - pass - - - def GetText(self,nPane:'typing.Any') -> 'typing.Any': - """ - Retrieve the text from the given part of a status bar control. - -Args: - - nPane(typing.Any):Zero-based index of the part whose text is to be retrieved. - -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 - -control. - -Args: - - nPane(typing.Any):Zero-based index of the part whose text is to be retrieved. - -Returns: - - typing.Any - - """ - pass - - - def GetTextLength(self,nPane:'typing.Any') -> 'typing.Any': - """ - Retrieve the length the text in the given part of a status bar control. - -Args: - - nPane(typing.Any):Zero-based index of the part whose text is to be retrieved. - -Returns: - - typing.Any - - """ - pass - - - def SetMinHeight(self,nHeight:'typing.Any') -> 'None': - """ - Set the minimum height of a status bar control's drawing area. - -Args: - - nHeight(typing.Any):Minimum height - -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 - -edge of each part. - -Args: - - coord(typing.Any):Coordinates of each part - -Returns: - - None - - """ - pass - - - def SetText(self,text:'str',nPane:'typing.Any',nType:'typing.Any') -> 'None': - """ - Set the text in the given part of a status bar control. - -Args: - - text(str):The text to display - nPane(typing.Any):Zero-based index of the part to set. - nType(typing.Any):Type of drawing operation.CommentsThe drawing type can be set to one of:~ 0 - The text is drawn with a border to appear lower than the plane of the status bar.~ win32con.SBT_NOBORDERS - The text is drawn without borders.~ win32con.SBT_OWNERDRAW - The text is drawn by the parent window.~ win32con.SBT_POPOUT - The text is drawn with a border to appear higher than the plane of the status bar. - -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 - -been created with the afxres.SBT_TOOLTIPS control style to enable ToolTips. - -Args: - - nPane(typing.Any):The zero-based index of status bar pane to receive the tooltip text. - text(str):The string containing the tooltip text.CommentsPay attention, this tooltip text is ONLY displayed in two situations: 1. When the corresponding pane in the status bar contains only an icon. 2. When the corresponding pane in the status bar contains text that is truncated due to the size of the pane. To make the tooltip appear even if the text is not truncated, you could add additional spaces to the end of the pane text.MFC References - -Returns: - - None - - """ - pass - - -class PyCTabCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetCurSel(self,) -> 'typing.Any': - """ - Gets the current selection of a tab control. - -Args: - - - -Returns: - - typing.Any:PyCTabCtrl.GetCurSel - -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 - - - def GetItemCountl(self,) -> 'typing.Any': - """ - Returns the number of tabs in the control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetCurSel(self,index:'typing.Any') -> 'typing.Any': - """ - Sets the current selection of a tab control. - -Args: - - index(typing.Any):The index of the tab to set current.Return ValueThe zero-based index of the previously selected item. - -Returns: - - typing.Any:The index of the tab to set current.Return ValueThe zero-based index of the previously selected item. - - - """ - pass - - -class PyCToolBar(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetButtonStyle(self,index:'typing.Any') -> 'None': - """ - Retrieves the style for a button. - -Args: - - index(typing.Any):Index of the item whose style is to be retrieved. - -Returns: - - None - - """ - pass - - - def GetButtonText(self,index:'typing.Any') -> 'str': - """ - Gets the text for a button. - -Args: - - index(typing.Any):Index of the item whose text is to be retrieved. - -Returns: - - str - - """ - pass - - - def GetItemID(self,index:'typing.Any') -> 'None': - """ - Returns the command ID of a button or separator at the given index. - -Args: - - index(typing.Any):Index of the item whose ID is to be retrieved. - -Returns: - - None - - """ - pass - - - def SetButtonInfo(self,index:'typing.Any',ID:'typing.Any',style:'typing.Any',imageIx:'typing.Any') -> 'None': - """ - Sets the button's command ID, style, and image number. - -Args: - - index(typing.Any):Index of the button or separator whose information is to be set. - ID(typing.Any):The value to which the button's command ID is set. - style(typing.Any):The new button style - imageIx(typing.Any):New index for the button's image within the bitmap - -Returns: - - None - - """ - pass - - - def GetToolBarCtrl(self,) -> 'PyCToolBarCtrl': - """ - Gets the toolbar control object for the toolbar - -Args: - - - -Returns: - - PyCToolBarCtrl - - """ - pass - - - def LoadBitmap(self,_id:'PyResourceId') -> 'None': - """ - Loads the bitmap containing bitmap-button images. - -Args: - - _id(PyResourceId):Name or id of the resource that contains the bitmap.CommentsThe bitmap should contain one image for each toolbar button. If the images are not of the standard size (16 pixels wide and 15 pixels high), call PyCToolBar::SetSizes to set the button sizes and their images. - -Returns: - - None - - """ - pass - - - def LoadToolBar(self,_id:'PyResourceId') -> 'None': - """ - Loads a toolbar from a toolbar resource. - -Args: - - _id(PyResourceId):Name or resource id of the resourceCommentsThe bitmap should contain one image for each toolbar button. If the images are not of the standard size (16 pixels wide and 15 pixels high), call PyCToolBar::SetSizes to set the button sizes and their images. - -Returns: - - None - - """ - pass - - - def SetBarStyle(self,style:'typing.Any') -> 'None': - """ - Sets the toolbar part of style - -Args: - - style(typing.Any):The toolbar style to set. - -Returns: - - None - - """ - pass - - - def SetBitmap(self,hBitmap:'typing.Any') -> 'None': - """ - Sets a bitmapped image. - -Args: - - hBitmap(typing.Any):The handle to a bitmap resource.CommentsCall this method to set the bitmap image for the toolbar. For example, call SetBitmap to change the bitmapped image after the user takes an action on a document that changes the action of a button. - -Returns: - - None - - """ - pass - - - def SetButtons(self,buttons:'typing.Any',numButtons:'typing.Any') -> 'None': - """ - Sets button styles and an index of button images within the bitmap. - -Args: - - buttons(typing.Any):A tuple containing the ID's of the buttons.Alternative Parameters - numButtons(typing.Any):The number of buttons to pre-allocate. If this option is used, then PyCToolBar::PySetButtonInfo must be used. - -Returns: - - None - - """ - pass - - - def SetButtonStyle(self,index:'typing.Any',style:'typing.Any') -> 'None': - """ - Sets the style for a button. - -Args: - - index(typing.Any):Index of the item whose style is to be set - style(typing.Any):The new style - -Returns: - - None - - """ - pass - - - def SetHeight(self,height:'typing.Any') -> 'None': - """ - Sets the height of the toolbar. - -Args: - - height(typing.Any):The height in pixels of the toolbar. - -Returns: - - None - - """ - pass - - - def SetSizes(self,sizeButton:'typing.Tuple[typing.Any, typing.Any]',sizeButton1:'typing.Tuple[typing.Any, typing.Any]') -> 'None': - """ - Sets the size of each button. - -Args: - - sizeButton(typing.Tuple[typing.Any, typing.Any]):The size of each button. - sizeButton1(typing.Tuple[typing.Any, typing.Any]):The size of each bitmap. - -Returns: - - None - - """ - pass - - -class PyCToolBarCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddBitmap(self,numButtons:'typing.Any',bitmap:'typing.Any') -> 'typing.Any': - """ - Add one or more button images to the list of button images - -Args: - - numButtons(typing.Any):Number of button images in the bitmap. - bitmap(typing.Any):Bitmap containing button or buttons to be addedMFC References - -Returns: - - typing.Any - - """ - pass - - - def AddButtons(self,) -> 'typing.Any': - """ - Add one or more buttons to the toolbar - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def AddStrings(self,strings:'typing.Any') -> 'typing.Any': - """ - Add one or more strings to the toolbar - -Args: - - strings(typing.Any):Strings to add. Can give more than one string. - -Returns: - - typing.Any - - """ - pass - - - def AutoSize(self,) -> 'None': - """ - Resize the entire toolbar control - -Args: - - - -Returns: - - None - - """ - pass - - - def CheckButton(self,nID:'typing.Any',bCheck:'typing.Any'=1) -> 'typing.Any': - """ - Check or clear a given button in a toolbar control - -Args: - - nID(typing.Any):Command identifier of the button to check or clear. - bCheck(typing.Any):1 to check, 0 to clear the buttonMFC References - -Returns: - - typing.Any - - """ - pass - - - def CommandToIndex(self,nID:'typing.Any') -> 'typing.Any': - """ - Retrieve the zero-based index for the button associated with the - -specified command identifier. - -Args: - - nID(typing.Any):Command identifier of the button you want to find.MFC References - -Returns: - - typing.Any - - """ - pass - - - def CreateWindow(self,style:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',parent:'PyCWnd',_id:'typing.Any') -> 'None': - """ - Creates the window for a new toolbar object - -Args: - - style(typing.Any):The style for the button. Use any of the win32con.BS_* constants. - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The size and position of the button. - parent(PyCWnd):The parent window of the button. Usually a PyCDialog. - _id(typing.Any):The buttons control ID.MFC References - -Returns: - - None - - """ - pass - - - def Customize(self,) -> 'None': - """ - Display the Customize Toolbar dialog box. - -Args: - - - -Returns: - - None - - """ - pass - - - def DeleteButton(self,nID:'typing.Any') -> 'None': - """ - Delete a button from the toolbar control. - -Args: - - nID(typing.Any):ID of the button to delete.MFC References - -Returns: - - None - - """ - pass - - - def EnableButton(self,nID:'typing.Any',bEnable:'typing.Any'=1) -> 'None': - """ - Enable or disable a toolbar control button. - -Args: - - nID(typing.Any):ID of the button to enable or disable. - bEnable(typing.Any):1 to enable, 0 to disableMFC References - -Returns: - - None - - """ - pass - - - def GetBitmapFlags(self,) -> 'typing.Any': - """ - retrieve the bitmap flags from the toolbar. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetButton(self,nID:'typing.Any') -> 'typing.Any': - """ - Retrieve information about the specified button in a - -toolbar control. - -Args: - - nID(typing.Any):ID of the button to retrieve.MFC References - -Returns: - - typing.Any - - """ - pass - - - def GetButtonCount(self,) -> 'typing.Any': - """ - Retrieve a count of the buttons currently in the toolbar control. - -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 - -toolbar control. - -Args: - - nID(typing.Any):ID of the button.MFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - - """ - pass - - - def GetRows(self,) -> 'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': - """ - Retrieve the number of rows of buttons currently displayed - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - - """ - pass - - - def HideButton(self,nID:'typing.Any',bEnable:'typing.Any'=1) -> 'None': - """ - Hide or show the specified button in a toolbar control. - -Args: - - nID(typing.Any):ID of the button to hide. - bEnable(typing.Any):1 to hide, 0 to show.MFC References - -Returns: - - None - - """ - pass - - - def Indeterminate(self,nID:'typing.Any',bEnable:'typing.Any'=1) -> 'None': - """ - Mark or unmark the specified button as indeterminate - -Args: - - nID(typing.Any):ID of the button to mark. - bEnable(typing.Any):1 to hide, 0 to show.MFC References - -Returns: - - None - - """ - pass - - - def InsertButton(self,nID:'typing.Any',button:'PyCToolBarCtrl') -> 'typing.Any': - """ - Insert a button in a toolbar control. - -Args: - - nID(typing.Any):Zero-based index of a button. This function inserts the new button to the left of this button. - button(PyCToolBarCtrl):Bitmap containing button to be insertedCommentsThe image and/or string whose index you provide must have previously been added to the toolbar control's list using PyCToolBarCtrl::AddBitmap, PyCToolBarCtrl::AddString, and/or PyCToolBarCtrl::AddStrings.MFC References - -Returns: - - typing.Any - - """ - pass - - - def IsButtonChecked(self,nID:'typing.Any') -> 'typing.Any': - """ - Determine whether the specified button in a toolbar control is checked. - -Args: - - nID(typing.Any):ID of the button to check.MFC References - -Returns: - - typing.Any - - """ - pass - - - def IsButtonEnabled(self,nID:'typing.Any') -> 'typing.Any': - """ - Determine whether the specified button in a toolbar control is enabled. - -Args: - - nID(typing.Any):ID of the button to check.MFC References - -Returns: - - typing.Any - - """ - pass - - - def IsButtonHidden(self,nID:'typing.Any') -> 'typing.Any': - """ - Determine whether the specified button in a toolbar control is hidden. - -Args: - - nID(typing.Any):ID of the button to check.MFC References - -Returns: - - typing.Any - - """ - pass - - - def IsButtonIndeterminate(self,nID:'typing.Any') -> 'typing.Any': - """ - Determine whether the specified button in a toolbar control is - -indeterminate. - -Args: - - nID(typing.Any):ID of the button to check.MFC References - -Returns: - - typing.Any - - """ - pass - - - def IsButtonPressed(self,nID:'typing.Any') -> 'typing.Any': - """ - Determine whether the specified button in a toolbar control is pressed. - -Args: - - nID(typing.Any):ID of the button to check.MFC References - -Returns: - - typing.Any - - """ - pass - - - def PressButton(self,nID:'typing.Any',bEnable:'typing.Any'=1) -> 'None': - """ - Mark or unmark the specified button as pressed. - -Args: - - nID(typing.Any):ID of the button to mark. - bEnable(typing.Any):1 to mark, 0 to unmark.MFC References - -Returns: - - None - - """ - pass - - - def SetBitmapSize(self,width1:'typing.Any',height1:'typing.Any',width:'typing.Any'=16,height:'typing.Any'=15) -> 'None': - """ - Set the size of the actual bitmapped images to be added to a toolbar control. - -Args: - - width1(typing.Any):Width of bitmap images. - height1(typing.Any):Height of bitmap images.MFC References - width(typing.Any):Width of bitmap images. - height(typing.Any):Height of bitmap images.Alternative Parameters - -Returns: - - None - - """ - pass - - - def SetButtonSize(self,width1:'typing.Any',height1:'typing.Any',width:'typing.Any'=16,height:'typing.Any'=15) -> 'None': - """ - Set the size of the buttons to be added to a toolbar control. - -Args: - - width1(typing.Any):Width of bitmap images. - height1(typing.Any):Height of bitmap images.MFC References - width(typing.Any):Width of buttons - height(typing.Any):Height of buttonsAlternative Parameters - -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 - -specified button is pressed. - -Args: - - nIndex(typing.Any):The zero-based index of the button whose command ID is to be set. - nID(typing.Any):The command ID to set the selected button to.MFC References - -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 - -number of rows. - -Args: - - nRows(typing.Any):Requested number of rows. - bLarger(typing.Any):Tells whether to use more rows or fewer rows if the toolbar cannot be resized to the requested number of rows.MFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - - """ - pass - - -class PyCToolTipCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,parent:'PyCWnd',style:'typing.Any') -> 'None': - """ - Creates the actual control. - -Args: - - parent(PyCWnd):The parent window of the control. - style(typing.Any):The style for the control. - -Returns: - - None - - """ - pass - - - def UpdateTipText(self,text:'str',wnd:'PyCWnd',_id:'typing.Any') -> 'None': - """ - Update the tool tip text for a control's tools - -Args: - - text(str):The text for the tool. - wnd(PyCWnd):The window of the tool. - _id(typing.Any):The id of the tool - -Returns: - - None - - """ - pass - - - def AddTool(self,wnd:'PyCWnd',text:'str',_id:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]'=None) -> 'None': - """ - Adds a tool to tooltip control. - -Args: - - wnd(PyCWnd):The window of the tool. - text(str):The text for the tool. - _id(typing.Any):The id of the tool - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The default rectangle - -Returns: - - None - - """ - pass - - - def SetMaxTipWidth(self,width:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - width(typing.Any):The new width - -Returns: - - typing.Any - - """ - pass - - -class PyCTreeCtrl(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,style:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',PyCWnd:'typing.Any',_id:'typing.Any') -> 'None': - """ - Creates the actual window for the object. - -Args: - - style(typing.Any):The window style - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The default rectangle - PyCWnd(typing.Any):The parent window - _id(typing.Any):The control IDMFC References - -Returns: - - None - - """ - pass - - - def GetCount(self,) -> 'typing.Any': - """ - Retrieves the number of tree items associated with a tree view control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetIndent(self,) -> 'typing.Any': - """ - Retrieves the offset (in pixels) of a tree view item from its parent. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetIndent(self,indent:'typing.Any') -> 'None': - """ - Sets the offset (in pixels) of a tree view item from its parent. - -Args: - - indent(typing.Any):The new indent. - -Returns: - - None - - """ - pass - - - def GetImageList(self,nImageList:'typing.Any') -> 'PyCImageList': - """ - Retrieves the current image list. - -Args: - - nImageList(typing.Any):Value specifying which image list to retrieve. It can be one of: - commctrl.LVSIL_NORMAL Image list with large icons. - commctrl.LVSIL_SMALL Image list with small icons. - commctrl.LVSIL_STATE Image list with state images. - -Returns: - - PyCImageList - - """ - pass - - - def SetImageList(self,imageList:'PyCImageList',imageType:'typing.Any') -> 'typing.Any': - """ - Assigns an image list to a list view control. - -Args: - - imageList(PyCImageList):The Image List to use. - imageType(typing.Any):Type of image list. It can be one of (COMMCTRL.) LVSIL_NORMAL, LVSIL_SMALL or LVSIL_STATE - -Returns: - - typing.Any - - """ - pass - - - def GetNextItem(self,item:'typing.Any',code:'typing.Any') -> 'typing.Any': - """ - Retrieves the next item. - -Args: - - item(typing.Any):The specified item - code(typing.Any):Specifies the relationship of the item to fetch. - -Returns: - - typing.Any - - """ - pass - - - def ItemHasChildren(self,item:'typing.Any') -> 'typing.Any': - """ - Returns nonzero if the specified item has child items. - -Args: - - item(typing.Any):The specified item - -Returns: - - typing.Any - - """ - pass - - - def GetChildItem(self,item:'typing.Any') -> 'typing.Any': - """ - Retrieves the first child item. - -Args: - - item(typing.Any):The specified item - -Returns: - - typing.Any - - """ - pass - - - def GetNextSiblingItem(self,item:'typing.Any') -> 'typing.Any': - """ - Retrieves the next sibling of the specified tree view item. - -Args: - - item(typing.Any):The specified item - -Returns: - - typing.Any - - """ - pass - - - def GetPrevSiblingItem(self,item:'typing.Any') -> 'typing.Any': - """ - Retrieves the previous sibling of the specified tree view item. - -Args: - - item(typing.Any):The specified item - -Returns: - - typing.Any - - """ - pass - - - def GetParentItem(self,item:'typing.Any') -> 'typing.Any': - """ - Retrieves the parent item of the specified tree view item. - -Args: - - item(typing.Any):The specified item - -Returns: - - typing.Any - - """ - pass - - - def GetFirstVisibleItem(self,) -> 'typing.Any': - """ - Retrieves the first visible item of the tree view control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetNextVisibleItem(self,item:'typing.Any') -> 'typing.Any': - """ - Retrieves the next visible item of the specified tree view item. - -Args: - - item(typing.Any):The specified item - -Returns: - - typing.Any - - """ - pass - - - def GetSelectedItem(self,) -> 'typing.Any': - """ - Retrieves the currently selected tree view item. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetDropHilightItem(self,) -> 'typing.Any': - """ - Retrieves the target of a drag-and-drop operation. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetRootItem(self,) -> 'typing.Any': - """ - Retrieves the root of the specified tree view item. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetToolTips(self,) -> 'typing.Any': - """ - Returns the tooltip control - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetItem(self,item:'typing.Any',arg:'typing.Any') -> 'TV_ITEM': - """ - Retrieves the details of an items attributes. - -Args: - - item(typing.Any):The item whose attributes are to be retrieved. - arg(typing.Any):The requested attributes. - -Returns: - - TV_ITEM - - """ - pass - - - def SetItem(self,item:'TV_ITEM') -> 'typing.Any': - """ - Sets some of all of an items attributes. - -Args: - - item(TV_ITEM):A tuple describing the new item. - -Returns: - - typing.Any - - """ - pass - - - def GetItemState(self,item:'typing.Any',stateMask:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Retrieves the state and mask of an item. - -Args: - - item(typing.Any):The specified item - stateMask(typing.Any):The mask for the result. - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def SetItemState(self,item:'typing.Any',state:'typing.Any',stateMask:'typing.Any') -> 'None': - """ - Sets the state of item. - -Args: - - item(typing.Any):The specified item - state(typing.Any):The new state - stateMask(typing.Any):The mask for the new state - -Returns: - - None - - """ - pass - - - def GetItemImage(self,item:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Retrieves the index of an items images. - -Args: - - item(typing.Any):The specified item - -Returns: - - typing.Tuple[typing.Any, typing.Any] - - """ - pass - - - def SetItemImage(self,item:'typing.Any',iImage:'typing.Any',iSelectedImage:'typing.Any') -> 'None': - """ - Sets the index of an items images. - -Args: - - item(typing.Any):The specified item - iImage(typing.Any):The offset of the image. - iSelectedImage(typing.Any):The offset of the selected image. - -Returns: - - None - - """ - pass - - - def SetItemText(self,item:'typing.Any',text:'str') -> 'typing.Any': - """ - Changes the text of a list view item or subitem. - -Args: - - item(typing.Any):The item whose text is to be retrieved. - text(str):String that contains the new item text. - -Returns: - - typing.Any - - """ - pass - - - def GetItemText(self,item:'typing.Any') -> 'typing.Any': - """ - Retrieves the text of a list view item or subitem. - -Args: - - item(typing.Any):The item whose text is to be retrieved. - -Returns: - - typing.Any - - """ - pass - - - def GetItemData(self,item:'typing.Any') -> 'typing.Any': - """ - Retrieves the application-specific value associated with an item. - -Args: - - item(typing.Any):The index of the item whose data is to be retrieved. - -Returns: - - typing.Any - - """ - pass - - - def SetItemData(self,item:'typing.Any',Data:'typing.Any') -> 'typing.Any': - """ - Sets the item's application-specific value. - -Args: - - item(typing.Any):The item whose Data is to be set. - Data(typing.Any):New value for the data.CommentsNote that a reference count is not added to the object. This it is your responsibility to make sure the object remains alive while in the list. - -Returns: - - typing.Any - - """ - pass - - - def GetItemRect(self,item:'typing.Any',bTextOnly:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]': - """ - Retrieves the bounding rectangle of a tree view item. - -Args: - - item(typing.Any):The item whose Data is to be set. - bTextOnly(typing.Any):f this parameter is nonzero, the bounding rectangle includes only the text of the item. Otherwise it includes the entire line that the item occupies in the tree view control. - -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 - -tree view item. - -Args: - - - -Returns: - - PyCEdit - - """ - pass - - - def GetVisibleCount(self,) -> 'typing.Any': - """ - Retrieves the number of visible tree items associated with a tree view - -control. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def InsertItem(self,hParent:'typing.Any',hInsertAfter:'typing.Any',item:'TV_ITEM',mask:'typing.Any',text:'typing.Any',image:'typing.Any',selectedImage:'typing.Any',state:'typing.Any',stateMask:'typing.Any',lParam:'typing.Any',parent:'typing.Any',parent1:'typing.Any',text1:'typing.Any',image1:'typing.Any',selectedImage1:'typing.Any',parent2:'typing.Any',insertAfter:'typing.Any',text2:'typing.Any',parent3:'typing.Any',parent4:'typing.Any') -> 'typing.Any': - """ - Inserts an item into the list. - -Args: - - hParent(typing.Any):The parent item. If commctrl.TVI_ROOT or 0, it is added to the root. - hInsertAfter(typing.Any):The item to insert after. Can be an item or TVI_FIRST, TVI_LAST or TVI_SORT - item(TV_ITEM):A tuple describing the new item.Alternative Parameters - mask(typing.Any):Integer specifying which attributes to set - text(typing.Any):The text of the item. - image(typing.Any):The index of the image to use. - selectedImage(typing.Any):The index of the items selected image. - state(typing.Any):The initial state of the item. - stateMask(typing.Any):Specifies which bits of the state are valid. - lParam(typing.Any):A user defined object for the item. - parent(typing.Any):The parent of the item. - parent1(typing.Any):The parent of the item.Alternative Parameters - text1(typing.Any):The text for the item. - image1(typing.Any):The index of the image to use. - selectedImage1(typing.Any):The index of the items selected image. - parent2(typing.Any):The parent of the item. - insertAfter(typing.Any):The item to insert the new item after, or TVI_FIRST, TVI_LAST or TVI_SORTAlternative Parameters - text2(typing.Any):The text for the item. - parent3(typing.Any):The parent of the item. - parent4(typing.Any):The parent of the item. - -Returns: - - typing.Any - - """ - pass - - - def DeleteItem(self,item:'typing.Any') -> 'None': - """ - Deletes the specified item. - -Args: - - item(typing.Any):The specified item - -Returns: - - None - - """ - pass - - - def DeleteAllItems(self,) -> 'typing.Any': - """ - Deletes all items in the control - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def Expand(self,item:'typing.Any',code:'typing.Any') -> 'None': - """ - Expands, or collapses, the child items of the specified tree view item. - -Args: - - item(typing.Any):The specified item - code(typing.Any):The action to take - -Returns: - - None - - """ - pass - - - def Select(self,item:'typing.Any',code:'typing.Any') -> 'None': - """ - Selects, scrolls into view, or redraws a specified tree view item. - -Args: - - item(typing.Any):The specified item - code(typing.Any):The action to take - -Returns: - - None - - """ - pass - - - def SelectItem(self,item:'typing.Any') -> 'None': - """ - Selects a specified tree view item. - -Args: - - item(typing.Any):The specified item - -Returns: - - None - - """ - pass - - - def SelectDropTarget(self,item:'typing.Any') -> 'None': - """ - Redraws the tree item as the target of a drag-and-drop operation. - -Args: - - item(typing.Any):The specified item - -Returns: - - None - - """ - pass - - - def SelectSetFirstVisible(self,item:'typing.Any') -> 'None': - """ - Selects a specified tree view item as the first visible item. - -Args: - - item(typing.Any):The specified item - -Returns: - - None - - """ - pass - - - def EditLabel(self,item:'typing.Any') -> 'PyCEdit': - """ - Edits a specified tree view item in-place. - -Args: - - item(typing.Any):The item to edit. - -Returns: - - PyCEdit - - """ - pass - - - def CreateDragImage(self,item:'typing.Any') -> 'PyCImageList': - """ - Creates a dragging bitmap for the specified tree view item. - -Args: - - item(typing.Any):The item to edit. - -Returns: - - PyCImageList - - """ - pass - - - def SortChildren(self,item:'typing.Any') -> 'None': - """ - Sorts the children of a given parent item. - -Args: - - item(typing.Any):The specified parent item - -Returns: - - None - - """ - pass - - - def EnsureVisible(self,item:'typing.Any') -> 'typing.Any': - """ - Ensures that a tree view item is visible in its tree view control. - -Args: - - item(typing.Any):The item to edit. - -Returns: - - typing.Any - - """ - pass - - - def HitTest(self,arg:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Determines which tree view item, if any, is at a specified position. - -Args: - - arg(typing.Any):The point to test.Return ValueThe result is a tuple of (flags, hItem). flags may be a combination of the following values:ValueDescriptioncommctrl.TVHT_ABOVEAbove the client area.commctrl.TVHT_BELOWBelow the client area.commctrl.TVHT_NOWHEREIn the client area, but below the last item.commctrl.TVHT_ONITEMOn the bitmap or label associated with an item.commctrl.TVHT_ONITEMBUTTONOn the button associated with an item.commctrl.TVHT_ONITEMICONOn the bitmap associated with an item.commctrl.TVHT_ONITEMINDENTIn the indentation associated with an item.commctrl.TVHT_ONITEMLABELOn the label (string) associated with an item.commctrl.TVHT_ONITEMRIGHTIn the area to the right of an item.commctrl.TVHT_ONITEMSTATEICONOn the state icon for a tree view item that is in a user-defined state.commctrl.TVHT_TOLEFTTo the left of the client area.commctrl.TVHT_TORIGHTTo the right of the client area. - -Returns: - - 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: - - - -Value - - -Description - - - -commctrl.TVHT_ABOVEAbove the client area. -commctrl.TVHT_BELOWBelow the client area. -commctrl.TVHT_NOWHEREIn the client area, but below the last item. -commctrl.TVHT_ONITEMOn the bitmap or label associated with an item. -commctrl.TVHT_ONITEMBUTTONOn the button associated with an item. -commctrl.TVHT_ONITEMICONOn the bitmap associated with an item. -commctrl.TVHT_ONITEMINDENTIn the indentation associated with an item. -commctrl.TVHT_ONITEMLABELOn the label (string) associated with an item. -commctrl.TVHT_ONITEMRIGHTIn the area to the right of an item. -commctrl.TVHT_ONITEMSTATEICONOn the state icon for a tree view item that is in a user-defined state. -commctrl.TVHT_TOLEFTTo the left of the client area. -commctrl.TVHT_TORIGHTTo the right of the client area. - - - """ - pass - - -class PyCTreeView(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def PreCreateWindow(self,createStruct:'typing.Any') -> 'typing.Any': - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(typing.Any):A tuple representing a CREATESTRUCT structure. - -Returns: - - typing.Any - - """ - pass - - - def GetTreeCtrl(self,) -> 'PyCTreeCtrl': - """ - Returns the underlying tree control object. - -Args: - - - -Returns: - - PyCTreeCtrl - - """ - pass - - - def OnCommand(self,wparam:'typing.Any',lparam:'typing.Any') -> 'None': - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(typing.Any): - lparam(typing.Any):See Also - -Returns: - - None - - """ - pass - - -class PyCView(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateWindow(self,parent:'PyCWnd',arg:'typing.Any',arg1:'typing.Any',arg2:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]') -> 'None': - """ - Creates the window for a view. - -Args: - - parent(PyCWnd):The parent window (usually a frame) - arg(typing.Any):The child ID for the view - arg1(typing.Any):The style for the view - arg2(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The default position of the window. - -Returns: - - None - - """ - pass - - - def GetDocument(self,) -> 'PyCDocument': - """ - Returns the document for a view. - -Args: - - - -Returns: - - PyCDocument - - """ - pass - - - def OnActivateView(self,activate:'typing.Any',activateView:'PyCView',DeactivateView:'PyCView') -> 'typing.Any': - """ - Calls the underlying MFC OnActivateView method. - -Args: - - activate(typing.Any):Indicates whether the view is being activated or deactivated. - activateView(PyCView):The view object that is being activated. - DeactivateView(PyCView):The view object that is being deactivated.See Also - -Returns: - - typing.Any - - """ - pass - - - def OnInitialUpdate(self,) -> 'None': - """ - Calls the underlying MFC OnInitialUpdate method. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnMouseActivate(self,wnd:'PyCWnd',hittest:'typing.Any',message:'typing.Any') -> 'typing.Any': - """ - Calls the base MFC OnMouseActivate function. - -Args: - - wnd(PyCWnd): - hittest(typing.Any): - message(typing.Any):See Also - -Returns: - - typing.Any - - """ - pass - - - def PreCreateWindow(self,createStruct:'typing.Any') -> 'typing.Any': - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(typing.Any):A tuple representing a CREATESTRUCT structure.See Also - -Returns: - - typing.Any - - """ - pass - - - def OnFilePrint(self,) -> 'None': - """ - Calls the underlying MFC OnFilePrint method. - -Args: - - - -Returns: - - None - - """ - pass - - - def DoPreparePrinting(self,) -> 'typing.Any': - """ - Invoke the Print dialog box and create a printer device context. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def OnBeginPrinting(self,) -> 'None': - """ - Calls the underlying MFC OnBeginPrinting method. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnEndPrinting(self,) -> 'None': - """ - Calls the underlying MFC OnEndPrinting method. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyCWinApp(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddDocTemplate(self,template:'PyCDocTemplate') -> 'None': - """ - Adds a template to the application list. - -Args: - - template(PyCDocTemplate):The template to be added. - -Returns: - - None - - """ - pass - - - def FindOpenDocument(self,fileName:'str') -> 'PyCDocument': - """ - Returns an existing document with the specified file name. - -Args: - - fileName(str):The fully qualified filename to search for. - -Returns: - - PyCDocument - - """ - pass - - - def GetDocTemplateList(self,) -> 'typing.List[typing.Any]': - """ - Returns a list of all document templates. - -Args: - - - -Returns: - - typing.List[typing.Any] - - """ - pass - - - def InitDlgInstance(self,dialog:'PyCDialog') -> 'None': - """ - Calls critical InitInstance processing for a dialog based application. - -Args: - - dialog(PyCDialog):The dialog object to be used as the main window for the application. - -Returns: - - None - - """ - pass - - - def LoadCursor(self,cursorId:'PyResourceId') -> 'typing.Any': - """ - Loads a cursor. - -Args: - - cursorId(PyResourceId):The resource id or name of the cursor to load. - -Returns: - - typing.Any - - """ - pass - - - def LoadStandardCursor(self,cursorId:'PyResourceId') -> 'typing.Any': - """ - Loads a standard cursor. - -Args: - - cursorId(PyResourceId):The resource ID or name of the cursor to load. - -Returns: - - typing.Any - - """ - pass - - - def LoadOEMCursor(self,cursorId:'typing.Any') -> 'typing.Any': - """ - Loads an OEM cursor. - -Args: - - cursorId(typing.Any):The ID of the cursor to load. - -Returns: - - typing.Any - - """ - pass - - - def LoadIcon(self,idResource:'typing.Any') -> 'typing.Any': - """ - Loads an icon resource. - -Args: - - idResource(typing.Any):The ID of the icon to load. - -Returns: - - typing.Any - - """ - pass - - - def LoadStandardIcon(self,resourceName:'PyResourceId') -> 'typing.Any': - """ - Loads an icon resource. - -Args: - - resourceName(PyResourceId):The resource name or id of the standard icon to load. - -Returns: - - typing.Any - - """ - pass - - - def OpenDocumentFile(self,fileName:'str') -> 'None': - """ - Opens a document file by name. - -Args: - - fileName(str):The name of the document to open. - -Returns: - - None - - """ - pass - - - def OnFileNew(self,) -> 'None': - """ - Calls the underlying OnFileNew MFC method. - -Args: - - - -Returns: - - None - - """ - pass - - - def OnFileOpen(self,) -> 'None': - """ - Calls the underlying OnFileOpen MFC method. - -Args: - - - -Returns: - - None - - """ - pass - - - def RemoveDocTemplate(self,template:'PyCDocTemplate') -> 'None': - """ - Removes a template to the application list. - -Args: - - template(PyCDocTemplate):The template to be removed. Must have previously been added by PyCWinApp::AddDocTemplate.CommentsNote that MFC does not provide an equivilent function. - -Returns: - - None - - """ - pass - - - def Run(self,) -> 'typing.Any': - """ - Starts the message pump. Advanced users only - -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 - -EXE. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - -class PyCWinThread(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def CreateThread(self,) -> 'None': - """ - Creates the actual thread behind the thread object. - -Args: - - - -Returns: - - None - - """ - pass - - - def PumpIdle(self,) -> 'None': - """ - Pumps all idle messages. - -Args: - - - -Returns: - - None - - """ - pass - - - def PumpMessages(self,) -> 'None': - """ - Pumps all messages to the application until a WM_QUIT message is received. - -Args: - - - -Returns: - - None - - """ - pass - - - def Run(self,) -> 'typing.Any': - """ - Starts the message pump. Advanced users only - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetMainFrame(self,mainFrame:'PyCWnd') -> 'None': - """ - Sets the threads main frame - -Args: - - mainFrame(PyCWnd):The applications main frame.CommentsYou can pass None to this function to reset the main frame. Should I free this? I dont think so! - -Returns: - - None - - """ - pass - - - def SetThreadPriority(self,priority:'PyCWnd') -> 'None': - """ - Sets the threads priority. Returns TRUE if successful. - -Args: - - priority(PyCWnd):The threads priority. - -Returns: - - None - - """ - pass - - -class PyCWnd(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ActivateFrame(self,cmdShow:'typing.Any') -> 'None': - """ - Searches upwards for a parent window which has - -a frame, and activates it. - -Args: - - cmdShow(typing.Any):The param passed to CFrameWnd::ShowWindow. See also PyCWnd::ShowWindow.MFC References - -Returns: - - None - - """ - pass - - - def BringWindowToTop(self,) -> 'None': - """ - Brings the window to the top of a stack of overlapping windows. - -Args: - - - -Returns: - - None - - """ - pass - - - def BeginPaint(self,) -> 'typing.Tuple[PyCDC, typing.Any]': - """ - Prepares a window for painting - -Args: - - - -Returns: - - typing.Tuple[PyCDC, typing.Any]:PyCWnd.BeginPaint -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 - -rectangle size. The resulting size can then be used as the initial - -size for the window object. - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The size to calculate from - nAdjustType(typing.Any):An enumerated type used for in-place editing. It can have the following values: CWnd::adjustBorder = 0, which means that scrollbar sizes are ignored in calculation; and CWnd::adjustOutside = 1, which means that they are added into the final measurements of the rectangle.MFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - - """ - pass - - - def CenterWindow(self,altwin:'PyCWnd'=None) -> 'None': - """ - Centers a window relative to its parent. - -Args: - - altwin(PyCWnd):alternate window relative to which it will be centered (other than the parent window).MFC References - -Returns: - - None - - """ - pass - - - def CheckRadioButton(self,idFirst:'typing.Any',idLast:'typing.Any',idCheck:'typing.Any') -> 'None': - """ - Selects the specified radio button, and clears - -all others in the group. - -Args: - - idFirst(typing.Any):The identifier of the first radio button in the group. - idLast(typing.Any):The identifier of the last radio button in the group. - idCheck(typing.Any):The identifier of the radio button to be checked.MFC References - -Returns: - - None - - """ - pass - - - def ChildWindowFromPoint(self,x:'typing.Any',y:'typing.Any',flag:'typing.Any'=0) -> 'PyCWnd': - """ - Returns the child window that contains the point - -Args: - - x(typing.Any):x coordinate of point - y(typing.Any):y coordinate of point - flag(typing.Any):Specifies which child windows to skipMFC References - -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 - -to screen coordinates. - -Args: - - point(typing.Tuple[typing.Any, typing.Any]):The client coordinates.Alternative Parameters - rect(typing.Any):The client coordinates.CommentsThe new screen coordinates are relative to the upper-left corner of the system display. This function assumes that the given pointis in client coordinates.MFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any, typing.Any] - - """ - pass - - - def CreateWindow(self,classId:'str',windowName:'str',style:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',parent:'PyCWnd',_id:'typing.Any',context:'typing.Any'=None) -> 'None': - """ - Creates the actual window - -Args: - - classId(str):The class ID for the window, or None - windowName(str):The title for the window, or None - style(typing.Any):The style for the window. - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The size and position of the window. - parent(PyCWnd):The parent window of the new window.. - _id(typing.Any):The control's ID. - context(typing.Any):A CreateContext object.MFC References - -Returns: - - None - - """ - pass - - - def CreateWindowEx(self,styleEx:'typing.Any',classId:'str',windowName:'str',style:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',parent:'PyCWnd',_id:'typing.Any',createStruct1:'typing.Any',createStruct:'CREATESTRUCT'=None) -> 'None': - """ - Creates the actual window using extended capabilities. - -Args: - - styleEx(typing.Any):The extended style of the window being created. - classId(str):The class ID for the window. May not be None. - windowName(str):The title for the window, or None - style(typing.Any):The style for the window. - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The size and position of the window. - parent(PyCWnd):The parent window of the new window.. - _id(typing.Any):The control's ID. - createStruct1(typing.Any):A tuple representing a CREATESTRUCT structure.MFC References - createStruct(CREATESTRUCT):A CreateStruct object (ie, a tuple) - -Returns: - - None - - """ - pass - - - def DefWindowProc(self,message:'typing.Any',idLast:'typing.Any',idCheck:'typing.Any') -> 'typing.Any': - """ - Calls the default message handler. - -Args: - - message(typing.Any):The Windows message. - idLast(typing.Any):The lParam for the message. - idCheck(typing.Any):The wParam for the message.MFC References - -Returns: - - typing.Any - - """ - pass - - - def DestroyWindow(self,) -> 'None': - """ - Destroy the window attached to the object. - -Args: - - - -Returns: - - None - - """ - pass - - - def DlgDirList(self,defPath:'str',idListbox:'typing.Any',idStaticPath:'typing.Any',fileType:'typing.Any') -> 'None': - """ - Fill a list box with a file or directory listing. - -Args: - - defPath(str):The file spec to fill the list box with - idListbox(typing.Any):The Id of the listbox control to fill. - idStaticPath(typing.Any):The Id of the static control used to display the current drive and directory. If idStaticPath is 0, it is assumed that no such control exists. - fileType(typing.Any):Specifies the attributes of the files to be displayed. It can be any combination of DDL_READWRITE, DDL_READONLY, DDL_HIDDEN, DDL_SYSTEM, DDL_DIRECTORY, DDL_ARCHIVE, DDL_POSTMSGS, DDL_DRIVES or DDL_EXCLUSIVEMFC References - -Returns: - - None - - """ - pass - - - def DlgDirListComboBox(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def DlgDirSelect(self,idListbox:'typing.Any') -> 'str': - """ - None - -Args: - - idListbox(typing.Any):The Id of the listbox.MFC References - -Returns: - - str - - """ - pass - - - def DlgDirSelectComboBox(self,idListbox:'typing.Any') -> 'str': - """ - None - -Args: - - idListbox(typing.Any):The Id of the combobox.MFC References - -Returns: - - str - - """ - pass - - - def DragAcceptFiles(self,bAccept:'typing.Any'=1) -> 'None': - """ - Indicates that the window and children supports files dropped from file manager - -Args: - - bAccept(typing.Any):A flag indicating if files are accepted.MFC References - -Returns: - - None - - """ - pass - - - def DrawMenuBar(self,) -> 'None': - """ - Redraws the menu bar. Can be called if the menu changes. - -Args: - - - -Returns: - - None - - """ - pass - - - def EnableWindow(self,bEnable:'typing.Any'=1) -> 'typing.Any': - """ - Enables or disables the window. Typically used for dialog controls. - -Args: - - bEnable(typing.Any):A flag indicating if the window is to be enabled or disabled.MFC References - -Returns: - - typing.Any:CWnd::EnableWindow -Return ValueReturns the state before the EnableWindow member function was called - - - """ - pass - - - def EndModalLoop(self,result:'typing.Any') -> 'None': - """ - Ends a modal loop. - -Args: - - result(typing.Any):The result as returned to RunModalLoop - -Returns: - - None - - """ - pass - - - def EndPaint(self,paintStruct:'typing.Any') -> 'None': - """ - Ends painting - -Args: - - paintStruct(typing.Any):The object returned from PyCWnd::BeginPaint - -Returns: - - None - - """ - pass - - - def GetCheckedRadioButton(self,idFirst:'typing.Any',idLast:'typing.Any') -> 'typing.Any': - """ - Returns the ID of the checked radio button, or 0 if none is selected. - -Args: - - idFirst(typing.Any):The Id of the first radio button in the group. - idLast(typing.Any):The Id of the last radio button in the group.MFC References - -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 - -will be zero. - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - - """ - pass - - - def GetDC(self,) -> 'PyCDC': - """ - Gets the windows current DC object. - -Args: - - - -Returns: - - PyCDC:PyCWnd.GetDC -PyCDC = GetDC()Gets the windows current DC object. -Return ValueThe result is a PyCDC, or a win32ui.error exception is raised. - - - """ - pass - - - def GetDCEx(self,) -> 'PyCDC': - """ - Gets the windows current DC object with extended caps. - -Args: - - - -Returns: - - PyCDC - - """ - pass - - - def GetDlgCtrlID(self,) -> 'typing.Any': - """ - Returns the ID of this child window. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetDlgItem(self,idControl:'typing.Any') -> 'PyCWnd': - """ - None - -Args: - - idControl(typing.Any):The Id of the control to be retrieved.MFC References - -Returns: - - PyCWnd:CWnd::GetDlgItem -Return ValueThe result is a PyCWnd (or derived) object, or a win32ui.error exception is raised. - - - """ - pass - - - def GetDlgItemInt(self,idControl:'typing.Any',bUnsigned:'typing.Any'=1) -> 'typing.Any': - """ - Returns the integer value of a child window or control with the specified ID. - -Args: - - idControl(typing.Any):The Id of the control to be retrieved. - bUnsigned(typing.Any):Should the function check for a minus signMFC References - -Returns: - - typing.Any:CWnd::GetDlgItemInt -Return ValueIf the value can not be converted, a ValueError is raised. - - - """ - pass - - - def GetDlgItemText(self,idControl:'typing.Any') -> 'str': - """ - Returns the text of child window or control with the specified ID. - -Args: - - idControl(typing.Any):The Id of the control to be retrieved.MFC References - -Returns: - - str - - """ - pass - - - def GetLastActivePopup(self,) -> 'PyCWnd': - """ - Returns the last active popup Window, or the Window itself. - -Args: - - - -Returns: - - PyCWnd:CWnd::GetLastActivePopup -Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - - """ - pass - - - def GetMenu(self,) -> 'PyCMenu': - """ - Returns the menu object for the window's menu. - -Args: - - - -Returns: - - PyCMenu:CWnd::GetMenu -Return ValueThe result is a PyMenu - - object, or an exception is thrown. - - - """ - pass - - - def GetParent(self,) -> 'PyCWnd': - """ - Returns the window's parent. - -Args: - - - -Returns: - - PyCWnd:CWnd::GetParent -Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - - """ - pass - - - def GetParentFrame(self,) -> 'PyCWnd': - """ - Returns the window's frame. - -Args: - - - -Returns: - - PyCWnd:CWnd::GetParentFrame -Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - - """ - pass - - - def GetSafeHwnd(self,) -> 'typing.Any': - """ - Returns the HWnd of this window. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetScrollInfo(self,nBar:'typing.Any',mask:'typing.Any') -> 'typing.Any': - """ - Returns information about a scroll bar - -Args: - - nBar(typing.Any):The scroll bar to examine. Can be one of win32con.SB_BOTH, win32con.SB_VERT or win32con.SB_HORZ - mask(typing.Any):The mask for attributes to retrieve. - -Returns: - - typing.Any - - """ - pass - - - def GetScrollPos(self,nBar:'typing.Any') -> 'typing.Any': - """ - Retrieves the current position of the scroll box of a scroll bar. - -Args: - - nBar(typing.Any):The scroll bar to examine. Can be one of win32con.SB_VERT or win32con.SB_HORZ - -Returns: - - typing.Any - - """ - pass - - - def GetStyle(self,) -> 'typing.Any': - """ - Retrieves the window style - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetExStyle(self,) -> 'typing.Any': - """ - Retrieves the window's extended style - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def GetSystemMenu(self,) -> 'PyCMenu': - """ - Returns the menu object for the window's system menu. - -Args: - - - -Returns: - - PyCMenu - - """ - pass - - - def GetTopLevelFrame(self,) -> 'PyCWnd': - """ - Returns the top-level frame of the window. - -Args: - - - -Returns: - - PyCWnd:CWnd::GetTopLevelFrame -Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - - """ - pass - - - def GetTopLevelOwner(self,) -> 'PyCWnd': - """ - Returns the top-level owner of the window. - -Args: - - - -Returns: - - PyCWnd:CWnd::GetTopLevelOwner -Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - - """ - pass - - - def GetTopLevelParent(self,) -> 'PyCWnd': - """ - Returns the top-level parent of the window. - -Args: - - - -Returns: - - PyCWnd:CWnd::GetTopLevelParent -Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - - """ - pass - - - def GetTopWindow(self,) -> 'PyCWnd': - """ - Identifies the top-level child window in a linked list of child windows. - -Args: - - - -Returns: - - PyCWnd:CWnd::GetTopWindow -Return ValueIf no child windows exist, the value is None. - - - """ - pass - - - def GetWindow(self,_type:'typing.Any') -> 'PyCWnd': - """ - Returns a window, with the specified relationship to this window. - -Args: - - _type(typing.Any):Specifies the relationship between the current and the returned window. It can take one of the following values: GW_CHILD, GW_HWNDFIRST, GW_HWNDLAST, GW_HWNDNEXT, GW_HWNDPREV or GW_OWNERMFC References - -Returns: - - PyCWnd:CWnd::GetWindow -Return ValueThe result is a PyCWnd or None if no Window can be found. - - - """ - pass - - - def GetWindowDC(self,) -> 'PyCDC': - """ - Gets the windows current DC object. - -Args: - - - -Returns: - - PyCDC - - """ - pass - - - def GetWindowPlacement(self,) -> 'typing.Any': - """ - Returns placement information about the current window. - -Args: - - - -Returns: - - typing.Any:CWnd::GetWindowPlacement -Return ValueThe result is a tuple of - -(flags, showCmd, (minposX, minposY), (maxposX, maxposY), (normalposX, normalposY)) - - - -Item - - -Description - - - -flagsOne of the WPF_* constants -showCmdCurrent state - one of the SW_* constants. -minposSpecifies the coordinates of the window's upper-left corner when the window is minimized. -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 - -corner - -Args: - - - -Returns: - - typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any] - - """ - pass - - - def GetWindowText(self,) -> 'str': - """ - Returns the windows text. - -Args: - - - -Returns: - - str - - """ - pass - - - def HideCaret(self,) -> 'None': - """ - Hides the caret - -Args: - - - -Returns: - - None - - """ - pass - - - def HookAllKeyStrokes(self,obHandler:'typing.Any') -> 'None': - """ - Hook a key stroke handler for all key strokes. - -Args: - - obHandler(typing.Any):The handler for the keystrokes. This must be a callable object.CommentsThe handler object passed will be called as the application receives WM_CHAR messages. The handler will be called with 2 arguments The handler object (as per all hook functions). The keystroke being handled. If the handler returns TRUE, then the keystroke will be passed on to the default handler, otherwise it will be consumed. Note: This handler will prevent any PyCWnd::HookKeyStroke hooks from being called. - -Returns: - - None - - """ - pass - - - def HookKeyStroke(self,obHandler:'typing.Any',ch:'typing.Any') -> 'typing.Any': - """ - Hook a key stroke handler - -Args: - - obHandler(typing.Any):The handler of the keystroke. This must be a callable object. - ch(typing.Any):The ID for the keystroke to be handled. This may be an ascii code, or a virtual key code.CommentsThe 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 The handler object (as per all hook functions) The keystroke being handled. If the handler returns TRUE, then the keystroke will be passed on to the 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. - -Returns: - - 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 - -character code. The handler will be called with 2 arguments - -The handler object (as per all hook functions) - -The keystroke being handled. - -If the handler returns TRUE, then the keystroke will be passed on to the - -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 - - - def HookMessage(self,obHandler:'typing.Any',message:'typing.Any') -> 'typing.Any': - """ - Hook a message notification handler - -Args: - - obHandler(typing.Any):The handler for the message notification. This must be a callable object. - message(typing.Any):The ID of the message to be handled.CommentsThe 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. The handler will be called with 2 arguments The handler object (as per all hook functions). A tuple representing the message. The message tuple is in the following format:Items[0] int : hwndThe hwnd of the window.[1] int : messageThe message.[2] int : wParamThe wParam sent with the message.[3] int : lParamThe lParam sent with the message.[4] int : timeThe time the message was posted.[5] int, int : pointThe point where the mouse was when the message was posted.Return ValueThe return value is the previous handler, or None. - -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. - -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 object (as per all hook functions). - -A tuple representing the message. - -The message tuple is in the following format: -Items[0] int : hwnd -The hwnd of the window. -[1] int : message -The message. -[2] int : wParam -The wParam sent with the message. -[3] int : lParam -The lParam sent with the message. -[4] int : time -The time the message was posted. -[5] int, int : point -The point where the mouse was when the message was posted. -Return ValueThe return value is the previous handler, or None. - - - """ - pass - - - def InvalidateRect(self,arg:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',bErase:'typing.Any'=1) -> 'None': - """ - Invalidates an area of a window. - -Args: - - arg(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):Rectangle to be updated. If default param is used, the entire window is invalidated. - bErase(typing.Any):Specifies whether the background within the update region is to be erased.MFC References - -Returns: - - None - - """ - pass - - - def InvalidateRgn(self,region:'PyCRgn',bErase:'typing.Any'=1) -> 'None': - """ - Invalidates a region of the window - -Args: - - region(PyCRgn):The region to erase. - bErase(typing.Any):Indicates if the region should be erased. - -Returns: - - None - - """ - pass - - - def IsChild(self,obWnd:'PyCWnd') -> 'typing.Any': - """ - Determines if a given window is a child of this window. - -Args: - - obWnd(PyCWnd):The window to be checkedMFC References - -Returns: - - typing.Any - - """ - pass - - - def IsDlgButtonChecked(self,idCtl:'typing.Any') -> 'typing.Any': - """ - Determines if a dialog button is checked. - -Args: - - idCtl(typing.Any):The ID of the button to check.MFC References - -Returns: - - typing.Any - - """ - pass - - - def IsIconic(self,) -> 'typing.Any': - """ - Determines if the window is currently displayed as an icon. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def IsZoomed(self,) -> 'typing.Any': - """ - Determines if the window is currently maximised. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def IsWindow(self,) -> 'typing.Any': - """ - determines whether the specified window handle identifies an existing window - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def IsWindowVisible(self,) -> 'typing.Any': - """ - Determines if the window is currently visible. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def KillTimer(self,) -> 'typing.Any': - """ - Kills a system timer - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def LockWindowUpdate(self,) -> 'None': - """ - Disables drawing in the given window - -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 - -coordinate space of another window. - -Args: - - wnd(PyCWnd): - points(typing.List[typing.Tuple[typing.Any, typing.Any]]):The points to mapReturn ValueA list of the mapped points from the coordinate space of the CWnd to the coordinate space of another window. - -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 - -window. - - - """ - pass - - - def MouseCaptured(self,) -> 'typing.Any': - """ - Returns 1 if the window has the mouse capture, else 0 - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def MessageBox(self,message:'str',arg:'typing.Any',title:'typing.Union[str, typing.Any]'=None) -> 'None': - """ - Display a message box. - -Args: - - message(str):The message to be displayed in the message box. - arg(typing.Any):The style of the message box.MFC References - title(typing.Union[str, typing.Any]):The title for the message box. If None, the applications title will be used. - -Returns: - - None:CWnd::MessageBox -Return ValueAn integer identifying the button pressed to dismiss the dialog. - - - """ - pass - - - def ModifyStyle(self,remove:'typing.Any',add:'typing.Any',flags:'typing.Any'=0) -> 'typing.Any': - """ - Modifies the style of a window. - -Args: - - remove(typing.Any):Specifies window styles to be removed during style modification. - add(typing.Any):Specifies window styles to be added during style modification. - flags(typing.Any):Flags to be passed to SetWindowPos, or zero if SetWindowPos should not be called. The default is zero.CommentsIf nFlags is nonzero, ModifyStyle calls the Windows API function ::SetWindowPos and redraws the window by combining nFlags with the following four preset flags: * SWP_NOSIZE Retains the current size. * SWP_NOMOVE Retains the current position. * SWP_NOZORDER Retains the current Z order. * SWP_NOACTIVATE Does not activate the window. See also PyCWnd::ModifyStyleExMFC References - -Returns: - - typing.Any:CWnd::ModifyStyle -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 - - - def ModifyStyleEx(self,remove:'typing.Any',add:'typing.Any',flags:'typing.Any'=0) -> 'typing.Any': - """ - Modifies the extended style of a window. - -Args: - - remove(typing.Any):Specifies extended window styles to be removed during style modification. - add(typing.Any):Specifies extended extended window styles to be added during style modification. - flags(typing.Any):Flags to be passed to SetWindowPos, or zero if SetWindowPos should not be called. The default is zero.CommentsIf nFlags is nonzero, ModifyStyleEx calls the Windows API function ::SetWindowPos and redraws the window by combining nFlags with the following four preset flags: * SWP_NOSIZE Retains the current size. * SWP_NOMOVE Retains the current position. * SWP_NOZORDER Retains the current Z order. * SWP_NOACTIVATE Does not activate the window. See also PyCWnd::ModifyStyleMFC References - -Returns: - - typing.Any:CWnd::ModifyStyleEx -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 - - - def MoveWindow(self,rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',bRepaint:'typing.Any'=1) -> 'None': - """ - Move a window to a new location. - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The new location of the window, relative to the parent. - bRepaint(typing.Any):Indicates if the window should be repainted after the move.MFC References - -Returns: - - None - - """ - pass - - - def OnClose(self,) -> 'typing.Any': - """ - Calls the default MFC OnClose handler. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def OnCtlColor(self,dc:'PyCDC',control:'typing.Any',_type:'typing.Any') -> 'typing.Any': - """ - Calls the default MFC OnCtlColor handler. - -Args: - - dc(PyCDC):The dc - control(typing.Any):The control that want's it's color changed - _type(typing.Any):Type of controlSee Also - -Returns: - - typing.Any - - """ - pass - - - def OnEraseBkgnd(self,dc:'PyCDC') -> 'typing.Any': - """ - Calls the default MFC OnEraseBkgnd handler. - -Args: - - dc(PyCDC):The dcSee Also - -Returns: - - typing.Any - - """ - pass - - - def OnNcHitTest(self,arg:'typing.Tuple[typing.Any, typing.Any]') -> 'typing.Any': - """ - Calls the base MFC OnNcHitTest function. - -Args: - - arg(typing.Tuple[typing.Any, typing.Any]):The pointSee Also - -Returns: - - typing.Any - - """ - pass - - - def OnPaint(self,) -> 'typing.Any': - """ - Calls the default MFC OnPaint handler. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def OnQueryDragIcon(self,) -> 'typing.Any': - """ - Calls the default MFC OnQueryDragIcon handler. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def OnQueryNewPalette(self,) -> 'typing.Any': - """ - Calls the underlying MFC OnQueryNewPalette method. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def OnSetCursor(self,wnd:'PyCWnd',hittest:'typing.Any',message:'typing.Any') -> 'typing.Any': - """ - Calls the base MFC OnSetCursor function. - -Args: - - wnd(PyCWnd): - hittest(typing.Any): - message(typing.Any):See Also - -Returns: - - typing.Any - - """ - pass - - - def OnMouseActivate(self,wnd:'PyCWnd',hittest:'typing.Any',message:'typing.Any') -> 'typing.Any': - """ - Calls the base MFC OnMouseActivate function. - -Args: - - wnd(PyCWnd): - hittest(typing.Any): - message(typing.Any):See Also - -Returns: - - typing.Any - - """ - pass - - - def OnWndMsg(self,msg:'typing.Any',wParam:'typing.Any',lParam:'typing.Any') -> 'typing.Tuple[typing.Any, typing.Any]': - """ - Calls the default MFC Window Message handler. - -Args: - - msg(typing.Any):The message - wParam(typing.Any):The wParam for the message - lParam(typing.Any):The lParam for the messageMFC References - -Returns: - - typing.Tuple[typing.Any, typing.Any]:CWnd::OnWndMsg -Return ValueThe return value is a tuple of (int, int), being the - -return value from the MFC function call, and the value of the - -lResult param. Please see the MFC documentation for more details. - - - """ - pass - - - def PreCreateWindow(self,createStruct:'typing.Any') -> 'typing.Any': - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(typing.Any):A tuple representing a CREATESTRUCT structure.See Also - -Returns: - - typing.Any - - """ - pass - - - def PumpWaitingMessages(self,firstMsg:'typing.Any',lastMsg:'typing.Any') -> 'None': - """ - Pump messages associate with a window. - -Args: - - firstMsg(typing.Any):First message ID to process - lastMsg(typing.Any):First message ID to processMFC References - -Returns: - - None - - """ - pass - - - def RedrawWindow(self,_object:'PyCRgn',flags:'typing.Any',rect:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]'=None) -> 'None': - """ - Updates the specified rectangle or region in the given window's client area. - -Args: - - _object(PyCRgn):A region - flags(typing.Any):MFC References - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):A rect, or None - -Returns: - - None - - """ - pass - - - def ReleaseCapture(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def ReleaseDC(self,dc:'PyCDC') -> 'None': - """ - Releases a device context, freeing it for use by other applications. - -Args: - - dc(PyCDC):The DC to be released. - -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 - -nIDLeftOver, UINT nFlag = CWnd::reposDefault, LPRECT lpRectParam = NULL, LPCRECT lpRectClient = NULL, BOOL bStretch = - -TRUE ); - -Args: - - idFirst(typing.Any):The ID of the first control to reposition. - idLast(typing.Any):The ID of the last control to reposition. - idLeftOver(typing.Any): - -Returns: - - None - - """ - pass - - - def RunModalLoop(self,flags:'typing.Any') -> 'typing.Any': - """ - Begins a modal loop for the window. - -Args: - - flags(typing.Any): - -Returns: - - typing.Any - - """ - pass - - - def PostMessage(self,idMessage:'typing.Any',wParam:'typing.Any'=0,lParam:'typing.Any'=0) -> 'None': - """ - Post a message to the window. - -Args: - - idMessage(typing.Any):The ID of the message to post. - wParam(typing.Any):The wParam for the message - lParam(typing.Any):The lParam for the messageMFC References - -Returns: - - None - - """ - pass - - - def SendMessageToDescendants(self,idMessage:'typing.Any',wParam:'typing.Any'=0,lParam:'typing.Any'=0,bDeep:'typing.Any'=1) -> 'None': - """ - Send a message to all descendant windows. - -Args: - - idMessage(typing.Any):The ID of the message to send. - wParam(typing.Any):The wParam for the message - lParam(typing.Any):The lParam for the message - bDeep(typing.Any):Indicates if the message should be recursively sent to all childrenMFC References - -Returns: - - None - - """ - pass - - - def SendMessage(self,idMessage:'typing.Any',idMessage1:'typing.Any',ob:'typing.Any',wParam:'typing.Any'=0,lParam:'typing.Any'=0) -> 'None': - """ - Send a message to the window. - -Args: - - idMessage(typing.Any):The ID of the message to send. - idMessage1(typing.Any):The ID of the message to send. - ob(typing.Any):A buffer whose size is passed in wParam, and address is passed in lParamMFC References - wParam(typing.Any):The wParam for the message - lParam(typing.Any):The lParam for the messageAlternative Parameters - -Returns: - - None - - """ - pass - - - def SetActiveWindow(self,) -> 'PyCWnd': - """ - Sets the window active. Returns the previously active window, or None. - -Args: - - - -Returns: - - PyCWnd:PyCWnd.SetActiveWindow -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 - - - def SetForegroundWindow(self,) -> 'None': - """ - Puts the window into the foreground and activates the window. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetWindowPos(self,hWndInsertAfter:'typing.Any',position:'typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]',flags:'typing.Any') -> 'None': - """ - Sets the windows position information - -Args: - - hWndInsertAfter(typing.Any):A hwnd, else one of the win32con.HWND_* constants. - position(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any]):The new position of the window. - flags(typing.Any):Window positioning flags.MFC References - -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 - -or rectangle on the display to client coordinates. - -Args: - - rect(typing.Tuple[typing.Any, typing.Any, typing.Any, typing.Any, typing.Any]):The coordinates to convert.Alternative Parameters - pnt(typing.Any):The coordinates to convert.MFC References - -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 - -position of the cursor. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetDlgItemText(self,idControl:'typing.Any',text:'str') -> 'None': - """ - Sets the text for the child window or control with the specified ID. - -Args: - - idControl(typing.Any):The Id of the control - text(str):The new textMFC References - -Returns: - - None - - """ - pass - - - def SetFocus(self,) -> 'None': - """ - Claims the input focus. The object that previously had the focus loses it. - -Args: - - - -Returns: - - None - - """ - pass - - - def SetFont(self,font:'PyCFont',bRedraw:'typing.Any'=1) -> 'None': - """ - Sets the window's current font to the specified font. - -Args: - - font(PyCFont):The new font to use. - bRedraw(typing.Any):If TRUE, redraw the window. - -Returns: - - None - - """ - pass - - - def SetIcon(self,) -> 'typing.Any': - """ - Calls the underlying MFC SetIcon method. - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def SetMenu(self,menuObj:'PyCMenu') -> 'None': - """ - Sets the menu for a window. - -Args: - - menuObj(PyCMenu):The menu object to set, or None to remove the window. - -Returns: - - None - - """ - pass - - - def SetRedraw(self,bState:'typing.Any'=1) -> 'None': - """ - Allows changes to be redrawn or to prevent changes from being redrawn. - -Args: - - bState(typing.Any):Specifies the state of the redraw flag.MFC References - -Returns: - - None - - """ - pass - - - def SetScrollPos(self,nBar:'typing.Any',nPos:'typing.Any',redraw:'typing.Any'=1) -> 'typing.Any': - """ - Sets the current position of the scroll box of a scroll bar. - -Args: - - nBar(typing.Any):The scroll bar to set. Can be one of win32con.SB_VERT or win32con.SB_HORZ - nPos(typing.Any):The new position - redraw(typing.Any):A flag indicating if the scrollbar should be redrawn. - -Returns: - - typing.Any - - """ - pass - - - def SetScrollInfo(self,nBar:'typing.Any',ScrollInfo:'typing.Any',redraw:'typing.Any'=1) -> 'typing.Any': - """ - Set information about a scroll bar - -Args: - - nBar(typing.Any):The scroll bar to examine. Can be one of win32con.SB_BOTH, win32con.SB_VERT or win32con.SB_HORZ - ScrollInfo(typing.Any):The information to set - redraw(typing.Any):A flag indicating if the scrollbar should be re-drawn. - -Returns: - - typing.Any - - """ - pass - - - def SetTimer(self,idEvent:'typing.Any',elapse:'typing.Any') -> 'typing.Any': - """ - Installs a system timer - -Args: - - idEvent(typing.Any):The ID of the event - elapse(typing.Any):How often the timer should fire.MFC References - -Returns: - - typing.Any - - """ - pass - - - def SetWindowPlacement(self,placement:'typing.Any') -> 'None': - """ - Sets the windows placement - -Args: - - placement(typing.Any):A tuple representing the WINDOWPLACEMENT structure.MFC References - -Returns: - - None - - """ - pass - - - def SetWindowText(self,text:'str') -> 'None': - """ - Sets the window's text. - -Args: - - text(str):The windows text.MFC References - -Returns: - - None - - """ - pass - - - def ShowCaret(self,) -> 'None': - """ - Shows the caret - -Args: - - - -Returns: - - None - - """ - pass - - - def ShowScrollBar(self,nBar:'typing.Any',bShow:'typing.Any'=1) -> 'None': - """ - Shows or hides a scroll bar. - -An application should not call ShowScrollBar to hide a scroll bar while processing a scroll-bar notification message. - -Args: - - nBar(typing.Any):Specifies whether the scroll bar is a control or part of a window's nonclient area. If it is part of the nonclient area, nBar also indicates whether the scroll bar is positioned horizontally, vertically, or both. It must be one of win32con.SB_BOTH, win32con.SB_HORZ or win32con.SB_VERT. - bShow(typing.Any):Indicates if the scroll bar should be shown or hidden.MFC References - -Returns: - - None - - """ - pass - - - def ShowWindow(self,arg:'typing.Any') -> 'typing.Any': - """ - Sets the visibility state of the window. - -Args: - - arg(typing.Any):Specifies how the window is to be shown. It must be one of win32con.SW_HIDE, win32con.SW_MINIMIZE, win32con.SW_RESTORE, win32con.SW_SHOW, win32con.SW_SHOWMAXIMIZED win32con.SW_SHOWMINIMIZED, win32con.SW_SHOWMINNOACTIVE, win32con.SW_SHOWNA, win32con.SW_SHOWNOACTIVATE, or win32con.SW_SHOWNORMALMFC References - -Returns: - - typing.Any:CWnd::ShowWindow -Return ValueReturns TRUE is the window was previously visible. - - - """ - pass - - - def UnLockWindowUpdate(self,) -> 'None': - """ - Unlocks a window that was locked with LockWindowUpdate - -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. - -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. - -Args: - - bSaveAndValidate(typing.Any):Flag that indicates whether dialog box is being initialized (FALSE) or data is being retrieved (TRUE).MFC References - -Returns: - - typing.Any - - """ - pass - - - def UpdateDialogControls(self,pTarget:'PyCCmdTarget',disableIfNoHandler:'typing.Any') -> 'typing.Any': - """ - None - -Args: - - pTarget(PyCCmdTarget):The main frame window of the application, and is used for routing update messages. - disableIfNoHandler(typing.Any):Flag that indicates whether a control that has no update handler should be automatically displayed as disabled. - -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 - -of the window is marked as invalid. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyDDEConv(object): - """A DDE topic.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def ConnectTo(self,service:'str',topic:'str') -> 'None': - """ - Connects to a server - -Args: - - service(str):The service to connect to - topic(str):The topic to connect to - -Returns: - - None - - """ - pass - - - def Connected(self,) -> 'None': - """ - Determines if the conversation is connected. - -Args: - - - -Returns: - - None - - """ - pass - - - def Exec(self,Cmd:'str') -> 'None': - """ - Executes a command. - -Args: - - Cmd(str):The Python statement to execute - -Returns: - - None - - """ - pass - - - def Request(self,) -> 'None': - """ - Sends a request. - -Args: - - - -Returns: - - None - - """ - pass - - - def Poke(self,) -> 'None': - """ - Sends a poke. - -Args: - - - -Returns: - - None - - """ - pass - - -class PyDDEServer(object): - """A DDE server.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddTopic(self,topic:'PyDDETopic') -> 'None': - """ - None - -Args: - - topic(PyDDETopic):The topic to add. - -Returns: - - None - - """ - pass - - - def Create(self,name:'str',filterFlags:'typing.Any'=0) -> 'None': - """ - Create a server - -Args: - - name(str):Name of the server to start. - filterFlags(typing.Any):Filter flags.CommentsNote there can only be one server per application. - -Returns: - - None - - """ - pass - - - def Destroy(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def GetLastError(self,) -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def Shutdown(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - -class PyDDEStringItem(object): - """A DDE string item.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def SetData(self,data:'str') -> 'None': - """ - Sets an items data, and causes any underlying notification. - -Args: - - data(str):The data to set. - -Returns: - - None - - """ - pass - - -class PyDDETopic(object): - """A DDE topic.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def AddItem(self,item:'typing.Any') -> 'None': - """ - Add an item to the topic. - -Args: - - item(typing.Any):The item to add - -Returns: - - None - - """ - pass - - - def Destroy(self,) -> 'None': - """ - Destroys an item - -Args: - - - -Returns: - - None - - """ - pass - - -class PyDLL(object): - """A DLL object. A general utility object, and not associated with an MFC object.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetFileName(self,) -> 'str': - """ - Returns the name of the module associated with the DLL. - -Args: - - - -Returns: - - str - - """ - pass - - - def AttachToMFC(self,) -> 'None': - """ - Attaches the DLL object to the MFC list of DLL's. - -Args: - - - -Returns: - - None - - """ - pass - - -class SCROLLINFO(object): - """Tuple representing a SCROLLINFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class TV_ITEM(object): - """""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class EXTENSION_CONTROL_BLOCK(object): - """A python representation of an ISAPI - -EXTENSION_CONTROL_BLOCK.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Version(self)->'int': - """Version info of this spec (read-only)""" - pass - - - @property - def TotalBytes(self)->'typing.Any': - """Total bytes indicated from client""" - pass - - - @property - def AvailableBytes(self)->'typing.Any': - """Available number of bytes""" - pass - - - @property - def HttpStatusCode(self)->'typing.Any': - """The status of the current transaction when the request is completed.""" - pass - - - @property - def Method(self)->'typing.Any': - """REQUEST_METHOD""" - pass - - - @property - def ConnID(self)->'typing.Any': - """Context number (read-only)""" - pass - - - @property - def QueryString(self)->'typing.Any': - """QUERY_STRING""" - pass - - - @property - def PathInfo(self)->'typing.Any': - """PATH_INFO""" - pass - - - @property - def PathTranslated(self)->'typing.Any': - """PATH_TRANSLATED""" - pass - - - @property - def AvailableData(self)->'typing.Any': - """Pointer to cbAvailable bytes""" - pass - - - @property - def ContentType(self)->'typing.Any': - """Content type of client data""" - pass - - - @property - def LogData(self)->'typing.Any': - """log data string""" - pass - - - def WriteClient(self,data:'typing.Union[str, typing.Any]',reserved:'typing.Any'=0) -> 'typing.Any': - """ - None - -Args: - - data(typing.Union[str, typing.Any]):The data to write - reserved(typing.Any):Return Valuethe result is the number of bytes written. - -Returns: - - typing.Any: -Return Valuethe result is the number of bytes written. - - - """ - pass - - - def GetServerVariable(self,variable:'str',default:'typing.Any') -> 'str': - """ - None - -Args: - - variable(str): - default(typing.Any):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 begins with 'UNICODE_', in which case it is a unicode object - see the ISAPI docs for more details. - -Returns: - - 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 - -begins with 'UNICODE_', in which case it is a unicode object - see the - -ISAPI docs for more details. - - - """ - pass - - - def ReadClient(self,nbytes:'typing.Any') -> 'str': - """ - None - -Args: - - nbytes(typing.Any):Default is to read all available data. - -Returns: - - str - - """ - pass - - - def SendResponseHeaders(self,reply:'str',headers:'str',keepAlive:'typing.Any'=False) -> 'None': - """ - Calls ServerSupportFunction with - -HSE_REQ_SEND_RESPONSE_HEADER_EX - -Args: - - reply(str): - headers(str): - keepAlive(typing.Any): - -Returns: - - None - - """ - pass - - - def SetFlushFlag(self,flag:'typing.Any') -> 'None': - """ - Calls ServerSupportFunction with HSE_REQ_SET_FLUSH_FLAG. - -Args: - - flag(typing.Any): - -Returns: - - None - - """ - pass - - - def TransmitFile(self,callback:'typing.Any',param:'typing.Any',hFile:'typing.Any',statusCode:'str',BytesToWrite:'typing.Any',Offset:'typing.Any',head:'str',tail:'str',flags:'typing.Any') -> 'typing.Any': - """ - Calls ServerSupportFunction with HSE_REQ_TRANSMIT_FILE - -Args: - - callback(typing.Any): - param(typing.Any):Any object - passed as 2nd arg to callback. - hFile(typing.Any): - statusCode(str): - BytesToWrite(typing.Any): - Offset(typing.Any): - head(str): - tail(str): - flags(typing.Any):CommentsThe callback is called with 4 args - (PyECB, param, cbIO, dwErrCode) - -Returns: - - typing.Any - - """ - pass - - - def MapURLToPath(self,) -> 'None': - """ - Calls ServerSupportFunction with HSE_REQ_MAP_URL_TO_PATH - -Args: - - - -Returns: - - None - - """ - pass - - - def DoneWithSession(self,status:'typing.Any') -> 'None': - """ - Calls ServerSupportFunction with HSE_REQ_DONE_WITH_SESSION - -Args: - - status(typing.Any):An optional status. HSE_STATUS_SUCCESS_AND_KEEP_CONN is supported by IIS to keep the connection alive. - -Returns: - - None - - """ - pass - - - def Redirect(self,url:'str') -> 'None': - """ - Calls ServerSupportFunction with HSE_REQ_SEND_URL_REDIRECT_RESP - -Args: - - url(str):The URL to redirect to - -Returns: - - None - - """ - pass - - - def IsKeepAlive(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - - def GetAnonymousToken(self,metabase_path:'typing.Union[str, typing.Any]') -> 'typing.Any': - """ - Calls ServerSupportFunction with HSE_REQ_GET_ANONYMOUS_TOKEN - -or HSE_REQ_GET_UNICODE_ANONYMOUS_TOKEN - -Args: - - metabase_path(typing.Union[str, typing.Any]): - -Returns: - - typing.Any - - """ - pass - - - def GetImpersonationToken(self,) -> 'typing.Any': - """ - Calls ServerSupportFunction with - -HSE_REQ_GET_IMPERSONATION_TOKEN - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def IsKeepConn(self,) -> 'typing.Any': - """ - Calls ServerSupportFunction with HSE_REQ_IS_KEEP_CONN - -Args: - - - -Returns: - - typing.Any - - """ - pass - - - def ExecURL(self,url:'str',method:'str',clientHeaders:'str',info:'typing.Any',entity:'typing.Any',flags:'typing.Any') -> 'typing.Any': - """ - Calls ServerSupportFunction with HSE_REQ_EXEC_URL - -Args: - - url(str): - method(str): - clientHeaders(str): - info(typing.Any):Must be None - entity(typing.Any):Must be None - flags(typing.Any):CommentsThis function is only available in IIS6 and later. - -Returns: - - typing.Any - - """ - pass - - - def GetExecURLStatus(self,) -> 'typing.Any': - """ - Calls ServerSupportFunction with HSE_REQ_GET_EXEC_URL_STATUS - -Args: - - - -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 - -operations. - -Args: - - func(typing.Any):The function to call, as described by the EXTENSION_CONTROL_BLOCK::IOCallback method. - arg(typing.Any):Any object which will be supplied as an argument to the callback function.CommentsIf you call this multiple times, the previous callback will be discarded.A reference to the callback and args are held until EXTENSION_CONTROL_BLOCK::DoneWithSession is called. If the callback function fails, DoneWithSession(HSE_STATUS_ERROR) will automatically be called and no further callbacks for the ECB will be made. - -Returns: - - typing.Any - - """ - pass - - - def ReportUnhealthy(self,reason:'str'=None) -> 'typing.Any': - """ - Calls ServerSupportFunction with HSE_REQ_REPORT_UNHEALTHY - -Args: - - reason(str):An optional reason to be written to the log. - -Returns: - - typing.Any - - """ - pass - - - def IOCallback(self,ecb:'EXTENSION_CONTROL_BLOCK',arg:'typing.Any',cbIO:'typing.Any',dwError:'typing.Any') -> 'typing.Any': - """ - A placeholder for a user-supplied callback function. - -Args: - - ecb(EXTENSION_CONTROL_BLOCK):The extension control block that is associated with the current, active request. - arg(typing.Any):The user-supplied argument supplied to the EXTENSION_CONTROL_BLOCK::IOCompletion function. - cbIO(typing.Any):An integer that contains the number of bytes of I/O in the last call. - dwError(typing.Any):The error code returned.CommentsThis is not a function you can call, it describes the signature of the callback function supplied to the EXTENSION_CONTROL_BLOCK::IOCompletion function.Return ValueThe result of this function is ignored. - -Returns: - - typing.Any:The error code returned.Comments - -This is not a function you can call, it describes the signature of - -the callback function supplied to the EXTENSION_CONTROL_BLOCK::IOCompletion - -function. -Return ValueThe result of this function is ignored. - - - """ - pass - - -class HSE_VERSION_INFO(object): - """An object used by ISAPI GetExtensionVersion""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ExtensionDesc(self)->'str': - """The description of the extension.""" - pass - - -class HTTP_FILTER_AUTHENT(object): - """A Python representation of an ISAPI - -HTTP_FILTER_AUTHENT structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def User(self)->'str': - """""" - pass - - - @property - def Password(self)->'str': - """""" - pass - - -class HTTP_FILTER_CONTEXT(object): - """A Python representation of an ISAPI - -HTTP_FILTER_CONTEXT structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def Revision(self)->'typing.Any': - """(read-only)""" - pass - - - @property - def fIsSecurePort(self)->'typing.Any': - """(read-only)""" - pass - - - @property - def NotificationType(self)->'typing.Any': - """(read-only)""" - pass - - - @property - def FilterContext(self)->'typing.Any': - """Any object you wish to associate with the request.""" - pass - - - def GetData(self,) -> 'typing.Any': - """ - Obtains the data passed to - -The HttpFilterProc function. This is not techinally part of the - -HTTP_FILTER_CONTEXT structure, but packaged here for convenience. - -Args: - - - -Returns: - - typing.Any:HTTP_FILTER_CONTEXT.GetData - -object = GetData()Obtains the data passed to - -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 - - - - -NotificationType - - -Result type - - - -SF_NOTIFY_URL_MAPHTTP_FILTER_URL_MAP -SF_NOTIFY_PREPROC_HEADERSHTTP_FILTER_PREPROC_HEADERS -SF_NOTIFY_LOGHTTP_FILTER_LOG -SF_NOTIFY_SEND_RAW_DATAHTTP_FILTER_RAW_DATA -SF_NOTIFY_READ_RAW_DATAHTTP_FILTER_RAW_DATA -SF_NOTIFY_AUTHENTICATIONHTTP_FILTER_AUTHENT - - - """ - pass - - - def GetServerVariable(self,variable:'str',default:'typing.Any') -> 'str': - """ - None - -Args: - - variable(str): - default(typing.Any):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 begins with 'UNICODE_', in which case it is a unicode object - see the ISAPI docs for more details. - -Returns: - - 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 - -begins with 'UNICODE_', in which case it is a unicode object - see the - -ISAPI docs for more details. - - - """ - pass - - - def WriteClient(self,data:'str',reserverd:'typing.Any'=0) -> 'None': - """ - None - -Args: - - data(str): - reserverd(typing.Any): - -Returns: - - None - - """ - pass - - - def AddResponseHeaders(self,data:'str',reserverd:'typing.Any'=0) -> 'None': - """ - None - -Args: - - data(str): - reserverd(typing.Any): - -Returns: - - None - - """ - pass - - - def SendResponseHeader(self,status:'str',header:'str') -> 'None': - """ - None - -Args: - - status(str): - header(str): - -Returns: - - None - - """ - pass - - - def DisableNotifications(self,flags:'typing.Any') -> 'None': - """ - None - -Args: - - flags(typing.Any): - -Returns: - - None - - """ - pass - - -class HTTP_FILTER_LOG(object): - """A Python representation of an ISAPI - -HTTP_FILTER_LOG structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ClientHostName(self)->'str': - """""" - pass - - - @property - def ClientUserName(self)->'str': - """""" - pass - - - @property - def ServerName(self)->'str': - """""" - pass - - - @property - def Operation(self)->'str': - """""" - pass - - - @property - def Target(self)->'str': - """""" - pass - - - @property - def Parameters(self)->'str': - """""" - pass - - - @property - def HttpStatus(self)->'typing.Any': - """""" - pass - - -class HTTP_FILTER_PREPROC_HEADERS(object): - """A Python representation of an ISAPI - -HTTP_FILTER_PREPROC_HEADERS structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - def GetHeader(self,header:'str',default:'typing.Any') -> 'str': - """ - None - -Args: - - header(str): - default(typing.Any):If specified, this will be returned on error. - -Returns: - - str - - """ - pass - - - def SetHeader(self,name:'str',val:'str') -> 'None': - """ - None - -Args: - - name(str): - val(str): - -Returns: - - None - - """ - pass - - - def AddHeader(self,) -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - pass - - -class HTTP_FILTER_RAW_DATA(object): - """A Python representation of an ISAPI - -HTTP_FILTER_RAW_DATA structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def InData(self)->'str': - """""" - pass - - -class HTTP_FILTER_URL_MAP(object): - """A Python representation of an ISAPI - -HTTP_FILTER_URL_MAP structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def URL(self)->'str': - """""" - pass - - - @property - def PhysicalPath(self)->'str': - """""" - pass - - -class HTTP_FILTER_VERSION(object): - """A Python interface to the ISAPI HTTP_FILTER_VERSION - -structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - - @property - def ServerFilterVersion(self)->'typing.Any': - """(read-only)""" - pass - - - @property - def FilterVersion(self)->'typing.Any': - """""" - pass - - - @property - def Flags(self)->'typing.Any': - """""" - pass - - - @property - def FilterDesc(self)->'str': - """""" - pass From 834ad369ec9bc78a0466d3be9f55de8b4e41c7b8 Mon Sep 17 00:00:00 2001 From: Avasam Date: Mon, 4 Apr 2022 23:40:11 -0400 Subject: [PATCH 030/137] WIP camera capture --- src/AutoSplit.py | 7 ++-- src/capture_method.py | 85 +++++++++++++++++++++++++++++------------- src/capture_windows.py | 27 ++++++++++---- src/menu_bar.py | 75 +++++++++++++++++++++++++++++-------- src/screen_region.py | 8 +++- src/user_profile.py | 10 ++--- 6 files changed, 154 insertions(+), 58 deletions(-) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 062d9cb7..40bf13b5 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -123,6 +123,7 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): reset_image: Optional[AutoSplitImage] = None split_images: list[AutoSplitImage] = [] split_image: AutoSplitImage + camera: Optional[cv2.VideoCapture] = None def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-many-statements super().__init__(parent) @@ -246,9 +247,9 @@ def __live_image_function(self): self.live_image.clear() return # Set live image in UI - if self.hwnd: - capture = capture_region(self) - set_ui_image(self.live_image, capture, False) + # if self.hwnd: + capture = capture_region(self) + set_ui_image(self.live_image, capture, False) def __load_start_image(self, started_by_button: bool = False, wait_for_delay: bool = True): """ diff --git a/src/capture_method.py b/src/capture_method.py index 59553d31..384d9581 100644 --- a/src/capture_method.py +++ b/src/capture_method.py @@ -1,20 +1,36 @@ -from typing import TypedDict +import cv2 +from dataclasses import dataclass from platform import version from collections import OrderedDict -from enum import Enum, unique +from enum import Enum, EnumMeta, unique + + # https://docs.microsoft.com/en-us/uwp/api/windows.graphics.capture.graphicscapturepicker#applies-to -WCG_MIN_BUILD = 17134 +WCG_MIN_BUILD = 999999 # TODO: Change to 17134 once implemented -class CaptureMethodInfo(TypedDict): +@dataclass +class DisplayCaptureMethodInfo(): name: str short_description: str description: str +class DisplayCaptureMethodMeta(EnumMeta): + # Allow checking if simple string is enum + def __contains__(cls, other: str): # noqa:N805 + try: + # pyright: reportGeneralTypeIssues=false + cls(other) # pylint: disable=no-value-for-parameter + except ValueError: + return False + else: + return True + + @unique -class CaptureMethod(Enum): +class DisplayCaptureMethod(Enum, metaclass=DisplayCaptureMethodMeta): # Allow TOML to save as a simple string def __repr__(self): return self.value @@ -34,8 +50,13 @@ def __hash__(self): DESKTOP_DUPLICATION = "DESKTOP_DUPLICATION" -CAPTURE_METHODS = OrderedDict({ - CaptureMethod.BITBLT: CaptureMethodInfo( +class DisplayCaptureMethodDict(OrderedDict[DisplayCaptureMethod, DisplayCaptureMethodInfo]): + def get_method_by_index(self, index: int): + return list(self.keys())[index] + + +DISPLAY_CAPTURE_METHODS = DisplayCaptureMethodDict({ + DisplayCaptureMethod.BITBLT: DisplayCaptureMethodInfo( name="BitBlt", short_description="fast, issues with Hardware Acceleration and OpenGL", description=( @@ -44,7 +65,7 @@ def __hash__(self): "\nbut it cannot properly record OpenGL or Hardware Accelerated Windows. " ), ), - CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: CaptureMethodInfo( + DisplayCaptureMethod.WINDOWS_GRAPHICS_CAPTURE: DisplayCaptureMethodInfo( name="Windows Graphics Capture", short_description=f"Windows 10 {WCG_MIN_BUILD} and up, most compatible if available", description=( @@ -53,7 +74,7 @@ def __hash__(self): "\nAdds a yellow border around the recorded window. " ), ), - CaptureMethod.DESKTOP_DUPLICATION: CaptureMethodInfo( + DisplayCaptureMethod.DESKTOP_DUPLICATION: DisplayCaptureMethodInfo( name="Direct3D Desktop Duplication", short_description="very slow, bound to display, supports OpenGL and DirectX 11/12 exclusive fullscreen", description=( @@ -63,7 +84,7 @@ def __hash__(self): "\noverlapping windows will show up and can't record across displays. " ), ), - CaptureMethod.PRINTWINDOW_RENDERFULLCONTENT: CaptureMethodInfo( + DisplayCaptureMethod.PRINTWINDOW_RENDERFULLCONTENT: DisplayCaptureMethodInfo( name="Force Full Content Rendering", short_description="very slow, can affect rendering pipeline", description=( @@ -76,20 +97,34 @@ def __hash__(self): }) -def get_capture_method_index(capture_method: CaptureMethod): - """ - Returns 0 if the capture_method is invalid or unsupported - """ - try: - return list(CAPTURE_METHODS.keys()).index(capture_method) - except ValueError: - return 0 - - -def get_capture_method_by_index(index: int): - return list(CAPTURE_METHODS.keys())[index] +# Detect and remove unsupported capture methods +if int(version().split(".")[2]) < WCG_MIN_BUILD: + DISPLAY_CAPTURE_METHODS.pop(DisplayCaptureMethod.WINDOWS_GRAPHICS_CAPTURE) -# Detect and remove unsupported capture methods -if int(version().split(".")[2]) < WCG_MIN_BUILD or True: # TODO: Not yet implemented - CAPTURE_METHODS.pop(CaptureMethod.WINDOWS_GRAPHICS_CAPTURE) +@dataclass +class CameraInfo(): + id: int + name: str + occupied: str + + +def get_all_cameras(): + index = 0 + video_captures: list[CameraInfo] = [] + while index < 8: + video_capture = cv2.VideoCapture(index) + video_capture.setExceptionMode(True) + try: + # https://docs.opencv.org/3.4/d4/d15/group__videoio__flags__base.html#ga023786be1ee68a9105bf2e48c700294d + print(video_capture.getBackendName()) + video_capture.grab() + except cv2.error as error: + if error.code == cv2.Error.STS_ERROR: + video_captures.append(CameraInfo(index, f"Camera {index}", False)) + else: + video_captures.append(CameraInfo(index, f"Camera {index}", True)) + + video_capture.release() + index += 1 + return video_captures diff --git a/src/capture_windows.py b/src/capture_windows.py index d49e0b9c..77bb3b1d 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -18,9 +18,8 @@ import win32ui import pywintypes from win32 import win32gui -from win32typing import PyCBitmap, PyCDC -from capture_method import CaptureMethod +from capture_method import DisplayCaptureMethod # This is an undocumented nFlag value for PrintWindow @@ -41,14 +40,14 @@ def __bit_blt_capture(hwnd: int, selection: Region, render_full_content: bool = # If the window closes while it's being manipulated, it could cause a crash try: window_dc: int = win32gui.GetWindowDC(hwnd) - dc_object: PyCDC = win32ui.CreateDCFromHandle(window_dc) + dc_object = win32ui.CreateDCFromHandle(window_dc) # Causes a 10-15x performance drop. But allows recording hardware accelerated windows if render_full_content: ctypes.windll.user32.PrintWindow(hwnd, dc_object.GetSafeHdc(), PW_RENDERFULLCONTENT) compatible_dc = dc_object.CreateCompatibleDC() - bitmap: PyCBitmap = win32ui.CreateBitmap() + bitmap = win32ui.CreateBitmap() bitmap.CreateCompatibleBitmap(dc_object, selection["width"], selection["height"]) compatible_dc.SelectObject(bitmap) compatible_dc.BitBlt( @@ -100,6 +99,17 @@ def __d3d_capture(hwnd: int, selection: Region): # picker.pick_single_item_async() +def __camera_capture(camera: Optional[cv2.VideoCapture], selection: Region): + if not camera: + return None + result, image = camera.read() + if not result: + return None + image = image[selection["x"]:selection["width"] + selection["x"], + selection["y"]:selection["width"] + selection["y"]] + return cv2.cvtColor(image, cv2.COLOR_BGR2BGRA) + + def capture_region(autosplit: AutoSplit): """ Captures an image of the region for a window matching the given @@ -113,13 +123,16 @@ def capture_region(autosplit: AutoSplit): selection = autosplit.settings_dict["capture_region"] capture_method = autosplit.settings_dict["capture_method"] - # if capture_method == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + if capture_method not in DisplayCaptureMethod: + return __camera_capture(autosplit.camera, selection) + + # if capture_method == DisplayCaptureMethod.WINDOWS_GRAPHICS_CAPTURE: # return __windows_graphics_capture(hwnd, selection, autosplit.effectiveWinId().__int__()) - if capture_method == CaptureMethod.DESKTOP_DUPLICATION: + if capture_method == DisplayCaptureMethod.DESKTOP_DUPLICATION: return __d3d_capture(hwnd, selection) - return __bit_blt_capture(hwnd, selection, capture_method == CaptureMethod.PRINTWINDOW_RENDERFULLCONTENT) + return __bit_blt_capture(hwnd, selection, capture_method == DisplayCaptureMethod.PRINTWINDOW_RENDERFULLCONTENT) def set_ui_image(qlabel: QLabel, image: Optional[cv2.ndarray], transparency: bool): diff --git a/src/menu_bar.py b/src/menu_bar.py index 56dea750..c0913704 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -1,5 +1,7 @@ from __future__ import annotations -from typing import TYPE_CHECKING, Any +from typing import TYPE_CHECKING, Any, Union, cast + +import cv2 if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -14,7 +16,7 @@ import error_messages import user_profile -from capture_method import CAPTURE_METHODS, get_capture_method_by_index, get_capture_method_index +from capture_method import DISPLAY_CAPTURE_METHODS, CameraInfo, DisplayCaptureMethod, get_all_cameras from gen import about, design, resources_rc, settings as settings_ui, update_checker # noqa: F401 from hotkeys import set_hotkey @@ -98,6 +100,12 @@ def check_for_updates(autosplit: AutoSplit, check_on_open: bool = False): class __SettingsWidget(QtWidgets.QDialog, settings_ui.Ui_DialogSettings): + __camera_capture_methods: list[CameraInfo] + """ + Used to temporarily store the existing cameras, + we don't want to call `get_all_cameras` agains and possibly have a different result + """ + def __update_default_threshold(self, value: Any): self.__set_value("default_similarity_threshold", value) self.autosplit.table_current_image_threshold_label.setText( @@ -112,27 +120,63 @@ def __update_default_threshold(self, value: Any): def __set_value(self, key: str, value: Any): self.autosplit.settings_dict[key] = value + def get_capture_method_by_current_index(self): + current_index = self.capture_method_combobox.currentIndex() + display_capture_methods_len = len(DISPLAY_CAPTURE_METHODS) + return self.__camera_capture_methods[current_index - display_capture_methods_len].name \ + if current_index >= display_capture_methods_len \ + else DISPLAY_CAPTURE_METHODS.get_method_by_index(current_index) + + def get_capture_method_index(self, capture_method: Union[str, DisplayCaptureMethod]): + """ + Returns 0 if the capture_method is invalid or unsupported + """ + item_count = self.capture_method_combobox.count() + display_capture_methods_len = len(DISPLAY_CAPTURE_METHODS) + try: + return [camera.name for camera in self.__camera_capture_methods].index(cast(str, capture_method)) \ + if item_count >= display_capture_methods_len \ + else list(DISPLAY_CAPTURE_METHODS.keys()).index(cast(DisplayCaptureMethod, capture_method)) + except ValueError: + return 0 + + def __capture_method_changed(self): + capture_method = self.get_capture_method_by_current_index() + if self.autosplit.camera: + self.autosplit.camera.release() + self.autosplit.camera = None + if capture_method not in DisplayCaptureMethod: + camera_index = self.capture_method_combobox.currentIndex() - len(DISPLAY_CAPTURE_METHODS) + camera_id = self.__camera_capture_methods[camera_index].id + self.autosplit.settings_dict["captured_window_title"] = cast(str, capture_method) + self.autosplit.camera = cv2.VideoCapture(camera_id) + return capture_method + def __init__(self, autosplit: AutoSplit): super().__init__() self.setupUi(self) self.autosplit = autosplit - # Build the Capture method combobox - capture_methods = [ - f"- {method['name']} ({method['short_description']})" - for method in CAPTURE_METHODS.values()] +# region Build the Capture method combobox + display_capture_methods = DISPLAY_CAPTURE_METHODS.values() + self.__camera_capture_methods = get_all_cameras() + capture_list_items = [ + f"- {method.name} ({method.short_description})" + for method in display_capture_methods + ] + [f"* {camera.name}{'' if camera.occupied else ' (occupied)'}" for camera in self.__camera_capture_methods] list_view = QtWidgets.QListView() list_view.setWordWrap(True) # HACK: The first time the dropdown is rendered, it does not have the right height # Assuming all options take 2 lines (except D3D which has 3). And all lines (with separator) takes 17 pixels - lines = (2 * len(capture_methods)) + 1 + lines = (2 * len(display_capture_methods)) + 1 + len(self.__camera_capture_methods) list_view.setMinimumHeight((17 * lines) - 1) list_view.setVerticalScrollBarPolicy(QtCore.Qt.ScrollBarPolicy.ScrollBarAlwaysOff) self.capture_method_combobox.setView(list_view) - self.capture_method_combobox.addItems(capture_methods) + self.capture_method_combobox.addItems(capture_list_items) self.capture_method_combobox.setToolTip("\n\n".join([ - f"{method['name']} :\n{method['description']}" - for method in CAPTURE_METHODS.values()])) + f"{method.name} :\n{method.description}" + for method in display_capture_methods])) +# endregion # region Set initial values # Hotkeys @@ -146,7 +190,7 @@ def __init__(self, autosplit: AutoSplit): self.fps_limit_spinbox.setValue(autosplit.settings_dict["fps_limit"]) self.live_capture_region_checkbox.setChecked(autosplit.settings_dict["live_capture_region"]) self.capture_method_combobox.setCurrentIndex( - get_capture_method_index(autosplit.settings_dict["capture_method"])) + self.get_capture_method_index(autosplit.settings_dict["capture_method"])) # Image Settings self.default_comparison_method.setCurrentIndex(autosplit.settings_dict["default_comparison_method"]) @@ -172,7 +216,7 @@ def __init__(self, autosplit: AutoSplit): self.live_capture_region_checkbox.isChecked())) self.capture_method_combobox.currentIndexChanged.connect(lambda: self.__set_value( "capture_method", - get_capture_method_by_index(self.capture_method_combobox.currentIndex()))) + self.__capture_method_changed())) # Image Settings self.default_comparison_method.currentIndexChanged.connect(lambda: self.__set_value( @@ -210,13 +254,13 @@ def get_default_settings_from_ui(autosplit: AutoSplit): "pause_hotkey": default_settings_dialog.pause_input.text(), "fps_limit": default_settings_dialog.fps_limit_spinbox.value(), "live_capture_region": default_settings_dialog.live_capture_region_checkbox.isChecked(), - "capture_method": get_capture_method_by_index(default_settings_dialog.capture_method_combobox.currentIndex()), + "capture_method": DISPLAY_CAPTURE_METHODS.get_method_by_index( + default_settings_dialog.capture_method_combobox.currentIndex()), "default_comparison_method": default_settings_dialog.default_comparison_method.currentIndex(), "default_similarity_threshold": default_settings_dialog.default_similarity_threshold_spinbox.value(), "default_delay_time": default_settings_dialog.default_delay_time_spinbox.value(), "default_pause_time": default_settings_dialog.default_pause_time_spinbox.value(), "loop_splits": default_settings_dialog.loop_splits_checkbox.isChecked(), - "split_image_directory": autosplit.split_image_folder_input.text(), "captured_window_title": "", "capture_region": { @@ -224,7 +268,6 @@ def get_default_settings_from_ui(autosplit: AutoSplit): "y": autosplit.y_spinbox.value(), "width": autosplit.width_spinbox.value(), "height": autosplit.height_spinbox.value(), - } - } + }} del temp_dialog return default_settings diff --git a/src/screen_region.py b/src/screen_region.py index 3370e887..40aa0962 100644 --- a/src/screen_region.py +++ b/src/screen_region.py @@ -125,7 +125,7 @@ def __get_window_from_point(x: int, y: int): def align_region(autosplit: AutoSplit): # Check to see if a region has been set - if autosplit.hwnd <= 0 or not win32gui.GetWindowText(autosplit.hwnd): + if not check_selected_region_exists(autosplit): error_messages.region() return # This is the image used for aligning the capture region to the best fit for the user. @@ -231,13 +231,17 @@ def validate_before_parsing(autosplit: AutoSplit, show_error: bool = True, check error = error_messages.split_image_directory_not_found elif check_empty_directory and not os.listdir(autosplit.settings_dict["split_image_directory"]): error = error_messages.split_image_directory_empty - elif autosplit.hwnd <= 0 or not win32gui.GetWindowText(autosplit.hwnd): + elif not check_selected_region_exists(autosplit): error = error_messages.region if error and show_error: error() return not error +def check_selected_region_exists(autosplit: AutoSplit): + return autosplit.camera or (autosplit.hwnd > 0 and win32gui.GetWindowText(autosplit.hwnd)) + + class BaseSelectWidget(QtWidgets.QWidget): _x = 0 _y = 0 diff --git a/src/user_profile.py b/src/user_profile.py index 38a32d1d..7b78c609 100644 --- a/src/user_profile.py +++ b/src/user_profile.py @@ -1,5 +1,5 @@ from __future__ import annotations -from typing import TYPE_CHECKING, TypedDict, cast +from typing import TYPE_CHECKING, TypedDict, Union, cast if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -12,8 +12,8 @@ from PyQt6 import QtCore, QtWidgets import error_messages -from capture_method import get_capture_method_by_index -from capture_windows import CaptureMethod, Region +from capture_method import DISPLAY_CAPTURE_METHODS, DisplayCaptureMethod +from capture_windows import Region from gen import design from hotkeys import set_hotkey @@ -31,7 +31,7 @@ class UserProfileDict(TypedDict): pause_hotkey: str fps_limit: int live_capture_region: bool - capture_method: CaptureMethod + capture_method: Union[str, DisplayCaptureMethod] default_comparison_method: int default_similarity_threshold: float default_delay_time: int @@ -51,7 +51,7 @@ class UserProfileDict(TypedDict): pause_hotkey="", fps_limit=60, live_capture_region=True, - capture_method=get_capture_method_by_index(0), + capture_method=DISPLAY_CAPTURE_METHODS.get_method_by_index(0), default_comparison_method=0, default_similarity_threshold=0.95, default_delay_time=0, From d29a450658a5bd8e3ec4936e620132b80d8bb389 Mon Sep 17 00:00:00 2001 From: Avasam Date: Thu, 7 Apr 2022 00:14:50 -0400 Subject: [PATCH 031/137] wip WindowsGraphicsCapture, missing bindings --- src/capture_method.py | 4 ++-- src/capture_windows.py | 22 ++++++++++++++-------- src/menu_bar.py | 10 ++++++++-- src/screen_region.py | 21 ++++++++++++++++++++- 4 files changed, 44 insertions(+), 13 deletions(-) diff --git a/src/capture_method.py b/src/capture_method.py index 59553d31..7d820245 100644 --- a/src/capture_method.py +++ b/src/capture_method.py @@ -46,7 +46,7 @@ def __hash__(self): ), CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: CaptureMethodInfo( name="Windows Graphics Capture", - short_description=f"Windows 10 {WCG_MIN_BUILD} and up, most compatible if available", + short_description=f"Windows 10.0.{WCG_MIN_BUILD} and up, most compatible if available", description=( "\nOnly available in recent Windows updates. Allows recording UWP apps " "\n(hardware accelerated and fullscreen exclusives? To be tested). " @@ -91,5 +91,5 @@ def get_capture_method_by_index(index: int): # Detect and remove unsupported capture methods -if int(version().split(".")[2]) < WCG_MIN_BUILD or True: # TODO: Not yet implemented +if int(version().split(".")[2]) < WCG_MIN_BUILD: CAPTURE_METHODS.pop(CaptureMethod.WINDOWS_GRAPHICS_CAPTURE) diff --git a/src/capture_windows.py b/src/capture_windows.py index d49e0b9c..de5f82eb 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -6,8 +6,6 @@ import ctypes import ctypes.wintypes import d3dshot -# from winsdk.windows.graphics.capture import GraphicsCapturePicker -# from winsdk._winrt import initialize_with_window from PyQt6 import QtCore, QtGui from PyQt6.QtWidgets import QLabel @@ -19,6 +17,8 @@ import pywintypes from win32 import win32gui from win32typing import PyCBitmap, PyCDC +from winsdk.windows.graphics.capture import Direct3D11CaptureFramePool, GraphicsCaptureItem +from winsdk.windows.graphics.directx import DirectXPixelFormat from capture_method import CaptureMethod @@ -94,10 +94,16 @@ def __d3d_capture(hwnd: int, selection: Region): return cv2.cvtColor(screenshot, cv2.COLOR_RGB2BGRA) -# def __windows_graphics_capture(hwnd: int, selection: Region, autosplit_hwnd: int): -# picker = GraphicsCapturePicker() -# initialize_with_window(picker, autosplit_hwnd) -# picker.pick_single_item_async() +def __windows_graphics_capture(capture_item: GraphicsCaptureItem, selection: Region): + device = ctypes.windll.d3d11.D3D11CreateDevice() + # sharpDxD3dDevice = Direct3D11Helpers.CreateSharpDXDevice(device) + frame_pool = Direct3D11CaptureFramePool.CreateFreeThreaded( + device, + DirectXPixelFormat.B8_G8_R8_A8_UINT_NORMALIZED, + 1, + capture_item.Size) + session = frame_pool.CreateCaptureSession(capture_item) + session.StartCapture() def capture_region(autosplit: AutoSplit): @@ -113,8 +119,8 @@ def capture_region(autosplit: AutoSplit): selection = autosplit.settings_dict["capture_region"] capture_method = autosplit.settings_dict["capture_method"] - # if capture_method == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: - # return __windows_graphics_capture(hwnd, selection, autosplit.effectiveWinId().__int__()) + if capture_method == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + return __windows_graphics_capture(autosplit.graphics_capture_item, selection) if capture_method == CaptureMethod.DESKTOP_DUPLICATION: return __d3d_capture(hwnd, selection) diff --git a/src/menu_bar.py b/src/menu_bar.py index 8b62e8f4..d246670d 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -14,7 +14,7 @@ import error_messages import user_profile -from capture_method import CAPTURE_METHODS, get_capture_method_by_index, get_capture_method_index +from capture_method import CAPTURE_METHODS, CaptureMethod, get_capture_method_by_index, get_capture_method_index from gen import about, design, resources_rc, settings as settings_ui, update_checker # noqa: F401 from hotkeys import set_hotkey @@ -112,6 +112,12 @@ def __update_default_threshold(self, value: Any): def __set_value(self, key: str, value: Any): self.autosplit.settings_dict[key] = value + def __capture_method_changed(self): + selected_capture_method = get_capture_method_by_index(self.capture_method_combobox.currentIndex()) + self.autosplit.select_region_button.setDisabled( + selected_capture_method == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE) + return selected_capture_method + def __init__(self, autosplit: AutoSplit): super().__init__() self.setupUi(self) @@ -172,7 +178,7 @@ def __init__(self, autosplit: AutoSplit): self.live_capture_region_checkbox.isChecked())) self.capture_method_combobox.currentIndexChanged.connect(lambda: self.__set_value( "capture_method", - get_capture_method_by_index(self.capture_method_combobox.currentIndex()))) + self.__capture_method_changed())) # Image Settings self.default_comparison_method.currentIndexChanged.connect(lambda: self.__set_value( diff --git a/src/screen_region.py b/src/screen_region.py index 3370e887..4f8ded5b 100644 --- a/src/screen_region.py +++ b/src/screen_region.py @@ -1,20 +1,25 @@ from __future__ import annotations from typing import cast, TYPE_CHECKING + if TYPE_CHECKING: from AutoSplit import AutoSplit import os +import asyncio + import ctypes import ctypes.wintypes import cv2 - import numpy as np from PyQt6 import QtCore, QtGui, QtTest, QtWidgets from win32 import win32gui from win32con import GA_ROOT, MAXBYTE, SM_XVIRTUALSCREEN, SM_YVIRTUALSCREEN, SM_CXVIRTUALSCREEN, SM_CYVIRTUALSCREEN +from winsdk.windows.graphics.capture import GraphicsCapturePicker, GraphicsCaptureItem +from winsdk._winrt import initialize_with_window import capture_windows import error_messages +from capture_method import CaptureMethod SUPPORTED_IMREAD_FORMATS = [ ("Windows bitmaps", "*.bmp *.dib"), @@ -72,7 +77,21 @@ def select_region(autosplit: AutoSplit): height=height) +async def select_graphics_item(autosplit: AutoSplit): + async def do_async(): + picker = GraphicsCapturePicker() + initialize_with_window(picker, autosplit.effectiveWinId().__int__()) + async_operation = picker.pick_single_item_async() + graphics_capture_item: GraphicsCaptureItem = async_operation.get_results() + autosplit.graphics_capture_item = graphics_capture_item + print(graphics_capture_item) + asyncio.create_task(do_async()) + + def select_window(autosplit: AutoSplit): + if autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + asyncio.run(select_graphics_item(autosplit)) + return # Create a screen selector widget selector = SelectWindowWidget() From 784a9fec115a67ee87d8d4b737ca12b836836aae Mon Sep 17 00:00:00 2001 From: Avasam Date: Thu, 7 Apr 2022 15:22:41 -0400 Subject: [PATCH 032/137] Working WindowsGraphicsCapture picker --- src/AutoSplit.py | 10 +++++++--- src/capture_windows.py | 22 ++++++++++++---------- src/screen_region.py | 36 +++++++++++++++++++++++------------- src/user_profile.py | 8 +++++++- 4 files changed, 49 insertions(+), 27 deletions(-) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 062d9cb7..b8dbdcc3 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -23,11 +23,13 @@ from PyQt6 import QtCore, QtGui, QtTest from PyQt6.QtWidgets import QApplication, QFileDialog, QMainWindow, QMessageBox, QWidget from win32 import win32gui -from AutoSplitImage import COMPARISON_RESIZE, AutoSplitImage, ImageType +from winsdk.windows.graphics.capture import GraphicsCaptureItem +from capture_method import CaptureMethod import error_messages import user_profile from AutoControlledWorker import AutoControlledWorker +from AutoSplitImage import COMPARISON_RESIZE, AutoSplitImage, ImageType from capture_windows import capture_region, set_ui_image from gen import about, design, settings, update_checker from hotkeys import send_command, after_setting_hotkey @@ -99,6 +101,7 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): # Initialize a few attributes hwnd = 0 """Window Handle used for Capture Region""" + graphics_capture_item: Optional[GraphicsCaptureItem] = None last_saved_settings = DEFAULT_PROFILE similarity = 0.0 split_image_number = 0 @@ -246,7 +249,7 @@ def __live_image_function(self): self.live_image.clear() return # Set live image in UI - if self.hwnd: + if self.hwnd or self.graphics_capture_item: capture = capture_region(self) set_ui_image(self.live_image, capture, False) @@ -750,7 +753,8 @@ def __get_capture_for_comparison(self): capture = capture_region(self) # This most likely means we lost capture (ie the captured window was closed, crashed, etc.) - if capture is None: + # We can't recover by name (yet) with WindowsGraphicsCapture + if capture is None and self.settings_dict["capture_method"] != CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: # Try to recover by using the window name self.live_image.setText("Trying to recover window...") hwnd = win32gui.FindWindow(None, self.settings_dict["captured_window_title"]) diff --git a/src/capture_windows.py b/src/capture_windows.py index de5f82eb..119df299 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -94,16 +94,18 @@ def __d3d_capture(hwnd: int, selection: Region): return cv2.cvtColor(screenshot, cv2.COLOR_RGB2BGRA) -def __windows_graphics_capture(capture_item: GraphicsCaptureItem, selection: Region): - device = ctypes.windll.d3d11.D3D11CreateDevice() - # sharpDxD3dDevice = Direct3D11Helpers.CreateSharpDXDevice(device) - frame_pool = Direct3D11CaptureFramePool.CreateFreeThreaded( - device, - DirectXPixelFormat.B8_G8_R8_A8_UINT_NORMALIZED, - 1, - capture_item.Size) - session = frame_pool.CreateCaptureSession(capture_item) - session.StartCapture() +def __windows_graphics_capture(capture_item: Optional[GraphicsCaptureItem], selection: Region): + if not capture_item: + return None + # device = ctypes.windll.d3d11.D3D11CreateDevice() + # # sharpDxD3dDevice = Direct3D11Helpers.CreateSharpDXDevice(device) + # frame_pool = Direct3D11CaptureFramePool.CreateFreeThreaded( # pyright: ignore + # device, + # DirectXPixelFormat.B8_G8_R8_A8_UINT_NORMALIZED, + # 1, + # capture_item.size) + # session = frame_pool.CreateCaptureSession(capture_item) # pyright: ignore + # session.StartCapture() def capture_region(autosplit: AutoSplit): diff --git a/src/screen_region.py b/src/screen_region.py index 4f8ded5b..ec9087aa 100644 --- a/src/screen_region.py +++ b/src/screen_region.py @@ -5,7 +5,6 @@ from AutoSplit import AutoSplit import os -import asyncio import ctypes import ctypes.wintypes @@ -15,6 +14,7 @@ from win32 import win32gui from win32con import GA_ROOT, MAXBYTE, SM_XVIRTUALSCREEN, SM_YVIRTUALSCREEN, SM_CXVIRTUALSCREEN, SM_CYVIRTUALSCREEN from winsdk.windows.graphics.capture import GraphicsCapturePicker, GraphicsCaptureItem +from winsdk.windows.foundation import IAsyncOperation, AsyncStatus from winsdk._winrt import initialize_with_window import capture_windows @@ -77,20 +77,26 @@ def select_region(autosplit: AutoSplit): height=height) -async def select_graphics_item(autosplit: AutoSplit): - async def do_async(): - picker = GraphicsCapturePicker() - initialize_with_window(picker, autosplit.effectiveWinId().__int__()) - async_operation = picker.pick_single_item_async() - graphics_capture_item: GraphicsCaptureItem = async_operation.get_results() - autosplit.graphics_capture_item = graphics_capture_item - print(graphics_capture_item) - asyncio.create_task(do_async()) +def select_graphics_item(autosplit: AutoSplit): + def callback(async_operation: IAsyncOperation[GraphicsCaptureItem], async_status: AsyncStatus): + if async_status != AsyncStatus.COMPLETED: + return + autosplit.graphics_capture_item = async_operation.get_results() + autosplit.settings_dict["captured_window_title"] = autosplit.graphics_capture_item.display_name + # __set_region_values(autosplit, + # left=0, + # top=0, + # width=cast(int, autosplit.graphics_capture_item.size.width), + # height=cast(int, autosplit.graphics_capture_item.size.height)) + + picker = GraphicsCapturePicker() + initialize_with_window(picker, autosplit.effectiveWinId().__int__()) + picker.pick_single_item_async().completed = callback def select_window(autosplit: AutoSplit): if autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: - asyncio.run(select_graphics_item(autosplit)) + select_graphics_item(autosplit) return # Create a screen selector widget selector = SelectWindowWidget() @@ -144,7 +150,7 @@ def __get_window_from_point(x: int, y: int): def align_region(autosplit: AutoSplit): # Check to see if a region has been set - if autosplit.hwnd <= 0 or not win32gui.GetWindowText(autosplit.hwnd): + if not check_selected_region_exists(autosplit): error_messages.region() return # This is the image used for aligning the capture region to the best fit for the user. @@ -250,13 +256,17 @@ def validate_before_parsing(autosplit: AutoSplit, show_error: bool = True, check error = error_messages.split_image_directory_not_found elif check_empty_directory and not os.listdir(autosplit.settings_dict["split_image_directory"]): error = error_messages.split_image_directory_empty - elif autosplit.hwnd <= 0 or not win32gui.GetWindowText(autosplit.hwnd): + elif not check_selected_region_exists(autosplit): error = error_messages.region if error and show_error: error() return not error +def check_selected_region_exists(autosplit: AutoSplit): + return autosplit.graphics_capture_item or (autosplit.hwnd > 0 and win32gui.GetWindowText(autosplit.hwnd)) + + class BaseSelectWidget(QtWidgets.QWidget): _x = 0 _y = 0 diff --git a/src/user_profile.py b/src/user_profile.py index 38a32d1d..284ecaba 100644 --- a/src/user_profile.py +++ b/src/user_profile.py @@ -128,6 +128,8 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str autosplit.show_error_signal.emit(error_messages.invalid_settings) return False + autosplit.select_region_button.setDisabled( + autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE) autosplit.split_image_folder_input.setText(autosplit.settings_dict["split_image_directory"]) keyboard.unhook_all() if not autosplit.is_auto_controlled: @@ -142,7 +144,11 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str if autosplit.settings_dict["pause_hotkey"]: set_hotkey(autosplit, "pause", autosplit.settings_dict["pause_hotkey"]) - if autosplit.settings_dict["captured_window_title"]: + if ( + autosplit.settings_dict["captured_window_title"] + # We can't recover by name (yet) with WindowsGraphicsCapture + and autosplit.settings_dict["capture_method"] != CaptureMethod.WINDOWS_GRAPHICS_CAPTURE + ): hwnd = win32gui.FindWindow(None, autosplit.settings_dict["captured_window_title"]) if hwnd: autosplit.hwnd = hwnd From 274cef145b0b40f288af8bf5684ad359f5155a79 Mon Sep 17 00:00:00 2001 From: Avasam Date: Thu, 7 Apr 2022 21:45:15 -0400 Subject: [PATCH 033/137] Completed WindowsGraphicsApi support --- src/AutoSplit.py | 7 +++--- src/capture_method.py | 12 ++++++---- src/capture_windows.py | 51 +++++++++++++++++++++++++----------------- src/menu_bar.py | 20 ++++++++++++----- src/screen_region.py | 47 +++++++++++++++++++++++++++++--------- 5 files changed, 92 insertions(+), 45 deletions(-) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index b8dbdcc3..68b596e2 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -23,7 +23,6 @@ from PyQt6 import QtCore, QtGui, QtTest from PyQt6.QtWidgets import QApplication, QFileDialog, QMainWindow, QMessageBox, QWidget from win32 import win32gui -from winsdk.windows.graphics.capture import GraphicsCaptureItem from capture_method import CaptureMethod import error_messages @@ -35,7 +34,7 @@ from hotkeys import send_command, after_setting_hotkey from menu_bar import get_default_settings_from_ui, open_about, VERSION, open_settings, view_help, check_for_updates, \ open_update_checker -from screen_region import select_region, select_window, align_region, validate_before_parsing +from screen_region import WindowsGraphicsCapture, select_region, select_window, align_region, validate_before_parsing from user_profile import DEFAULT_PROFILE, FROZEN from split_parser import BELOW_FLAG, DUMMY_FLAG, PAUSE_FLAG, parse_and_validate_images @@ -101,7 +100,7 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): # Initialize a few attributes hwnd = 0 """Window Handle used for Capture Region""" - graphics_capture_item: Optional[GraphicsCaptureItem] = None + windows_graphics_capture: Optional[WindowsGraphicsCapture] = None last_saved_settings = DEFAULT_PROFILE similarity = 0.0 split_image_number = 0 @@ -249,7 +248,7 @@ def __live_image_function(self): self.live_image.clear() return # Set live image in UI - if self.hwnd or self.graphics_capture_item: + if self.hwnd or self.windows_graphics_capture: capture = capture_region(self) set_ui_image(self.live_image, capture, False) diff --git a/src/capture_method.py b/src/capture_method.py index 7d820245..1b262e8b 100644 --- a/src/capture_method.py +++ b/src/capture_method.py @@ -46,16 +46,20 @@ def __hash__(self): ), CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: CaptureMethodInfo( name="Windows Graphics Capture", - short_description=f"Windows 10.0.{WCG_MIN_BUILD} and up, most compatible if available", + short_description="fastest, most compatible but less features", description=( - "\nOnly available in recent Windows updates. Allows recording UWP apps " - "\n(hardware accelerated and fullscreen exclusives? To be tested). " + f"\nOnly available in Windows 10.0.{WCG_MIN_BUILD} and up. " + "\nAllows recording UWP apps, hardware accelerated and fullscreen exclusive windows. " "\nAdds a yellow border around the recorded window. " + "\nDoes not support automatically recovering closed Windows, manual cropping only, " + "\nand you have to reselect the window everytime you open AutoSplit. " + "\nSee https://github.com/pywinrt/python-winsdk/issues/5 " + "\nfor more details about those restrictions." ), ), CaptureMethod.DESKTOP_DUPLICATION: CaptureMethodInfo( name="Direct3D Desktop Duplication", - short_description="very slow, bound to display, supports OpenGL and DirectX 11/12 exclusive fullscreen", + short_description="very slow, bound to display", description=( "\nDuplicates the desktop using Direct3D. " "\nIt can record OpenGL and Hardware Accelerated windows. " diff --git a/src/capture_windows.py b/src/capture_windows.py index 119df299..3b6c531e 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -1,27 +1,27 @@ from __future__ import annotations from typing import Optional, TypedDict, cast, TYPE_CHECKING + if TYPE_CHECKING: from AutoSplit import AutoSplit +import asyncio + import ctypes import ctypes.wintypes import d3dshot - -from PyQt6 import QtCore, QtGui -from PyQt6.QtWidgets import QLabel - import cv2 import numpy as np import win32con import win32ui import pywintypes +from PyQt6 import QtCore, QtGui +from PyQt6.QtWidgets import QLabel from win32 import win32gui from win32typing import PyCBitmap, PyCDC -from winsdk.windows.graphics.capture import Direct3D11CaptureFramePool, GraphicsCaptureItem -from winsdk.windows.graphics.directx import DirectXPixelFormat +from winsdk.windows.graphics.imaging import SoftwareBitmap, BitmapBufferAccessMode from capture_method import CaptureMethod - +from screen_region import WindowsGraphicsCapture # This is an undocumented nFlag value for PrintWindow PW_RENDERFULLCONTENT = 0x00000002 @@ -57,7 +57,7 @@ def __bit_blt_capture(hwnd: int, selection: Region, render_full_content: bool = dc_object, (selection["x"], selection["y"]), win32con.SRCCOPY) - image = np.frombuffer(cast(bytes, bitmap.GetBitmapBits(True)), dtype="uint8") + image = np.frombuffer(cast(bytes, bitmap.GetBitmapBits(True)), dtype=np.uint8) image.shape = (selection["height"], selection["width"], 4) # https://github.com/kaluluosi/pywin32-stubs/issues/5 # pylint: disable=no-member @@ -91,21 +91,30 @@ def __d3d_capture(hwnd: int, selection: Region): selection["y"] + offset_y, selection["width"] + selection["x"] + offset_x, selection["height"] + selection["y"] + offset_y)) - return cv2.cvtColor(screenshot, cv2.COLOR_RGB2BGRA) + return cv2.cvtColor(screenshot, cv2.COLOR_) -def __windows_graphics_capture(capture_item: Optional[GraphicsCaptureItem], selection: Region): - if not capture_item: +def __windows_graphics_capture(windows_graphics_capture: Optional[WindowsGraphicsCapture], selection: Region): + if not windows_graphics_capture or not windows_graphics_capture.frame_pool: return None - # device = ctypes.windll.d3d11.D3D11CreateDevice() - # # sharpDxD3dDevice = Direct3D11Helpers.CreateSharpDXDevice(device) - # frame_pool = Direct3D11CaptureFramePool.CreateFreeThreaded( # pyright: ignore - # device, - # DirectXPixelFormat.B8_G8_R8_A8_UINT_NORMALIZED, - # 1, - # capture_item.size) - # session = frame_pool.CreateCaptureSession(capture_item) # pyright: ignore - # session.StartCapture() + + frame = windows_graphics_capture.frame_pool.try_get_next_frame() + if not frame: + return windows_graphics_capture.last_captured_frame + + async def coroutine(): + return await SoftwareBitmap.create_copy_from_surface_async(frame.surface) # pyright: ignore + + software_bitmap = asyncio.run(coroutine()) + reference = software_bitmap.lock_buffer(BitmapBufferAccessMode.READ_WRITE).create_reference() + image = np.frombuffer(cast(bytes, reference), dtype=np.uint8) + image.shape = (windows_graphics_capture.size.height, windows_graphics_capture.size.width, 4) + image = image[ + selection["y"]:selection["y"] + selection["height"], + selection["x"]:selection["x"] + selection["width"], + ] + windows_graphics_capture.last_captured_frame = image + return image def capture_region(autosplit: AutoSplit): @@ -122,7 +131,7 @@ def capture_region(autosplit: AutoSplit): capture_method = autosplit.settings_dict["capture_method"] if capture_method == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: - return __windows_graphics_capture(autosplit.graphics_capture_item, selection) + return __windows_graphics_capture(autosplit.windows_graphics_capture, selection) if capture_method == CaptureMethod.DESKTOP_DUPLICATION: return __d3d_capture(hwnd, selection) diff --git a/src/menu_bar.py b/src/menu_bar.py index d246670d..dc1e1e28 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -11,6 +11,7 @@ from packaging import version from PyQt6 import QtWidgets, QtCore from requests.exceptions import RequestException +from win32 import win32gui import error_messages import user_profile @@ -114,8 +115,15 @@ def __set_value(self, key: str, value: Any): def __capture_method_changed(self): selected_capture_method = get_capture_method_by_index(self.capture_method_combobox.currentIndex()) - self.autosplit.select_region_button.setDisabled( - selected_capture_method == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE) + if selected_capture_method == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + self.autosplit.select_region_button.setDisabled(True) + else: + self.autosplit.select_region_button.setDisabled(False) + self.autosplit.windows_graphics_capture = None + # Recover window from name + hwnd = win32gui.FindWindow(None, self.autosplit.settings_dict["captured_window_title"]) + if hwnd: + self.autosplit.hwnd = hwnd return selected_capture_method def __init__(self, autosplit: AutoSplit): @@ -123,22 +131,22 @@ def __init__(self, autosplit: AutoSplit): self.setupUi(self) self.autosplit = autosplit - # Build the Capture method combobox +# region Build the Capture method combobox capture_methods = [ f"- {method['name']} ({method['short_description']})" for method in CAPTURE_METHODS.values()] list_view = QtWidgets.QListView() list_view.setWordWrap(True) # HACK: The first time the dropdown is rendered, it does not have the right height - # Assuming all options take 2 lines (except D3D which has 3). And all lines (with separator) takes 17 pixels - lines = (2 * len(capture_methods)) + 1 - list_view.setMinimumHeight((17 * lines) - 1) + # Assuming all options take 2 lines. And all lines (with separator) takes 17 pixels + list_view.setMinimumHeight(17 * 2 * len(capture_methods)) list_view.setVerticalScrollBarPolicy(QtCore.Qt.ScrollBarPolicy.ScrollBarAlwaysOff) self.capture_method_combobox.setView(list_view) self.capture_method_combobox.addItems(capture_methods) self.capture_method_combobox.setToolTip("\n\n".join([ f"{method['name']} :\n{method['description']}" for method in CAPTURE_METHODS.values()])) +# endregion # region Set initial values # Hotkeys diff --git a/src/screen_region.py b/src/screen_region.py index ec9087aa..3b051f8d 100644 --- a/src/screen_region.py +++ b/src/screen_region.py @@ -1,5 +1,6 @@ from __future__ import annotations -from typing import cast, TYPE_CHECKING +from dataclasses import dataclass +from typing import Optional, cast, TYPE_CHECKING if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -13,9 +14,13 @@ from PyQt6 import QtCore, QtGui, QtTest, QtWidgets from win32 import win32gui from win32con import GA_ROOT, MAXBYTE, SM_XVIRTUALSCREEN, SM_YVIRTUALSCREEN, SM_CXVIRTUALSCREEN, SM_CYVIRTUALSCREEN -from winsdk.windows.graphics.capture import GraphicsCapturePicker, GraphicsCaptureItem +from winsdk.windows.graphics.capture import Direct3D11CaptureFramePool, GraphicsCapturePicker, GraphicsCaptureItem, \ + GraphicsCaptureSession from winsdk.windows.foundation import IAsyncOperation, AsyncStatus from winsdk._winrt import initialize_with_window +from winsdk.windows.media.capture import MediaCapture +from winsdk.windows.graphics.directx import DirectXPixelFormat +from winsdk.windows.graphics import SizeInt32 import capture_windows import error_messages @@ -77,17 +82,36 @@ def select_region(autosplit: AutoSplit): height=height) +media_capture = MediaCapture() +media_capture.initialize_async() + + +@dataclass +class WindowsGraphicsCapture: + size: SizeInt32 + frame_pool: Direct3D11CaptureFramePool + # Prevent session from being garbage collected + session: GraphicsCaptureSession + last_captured_frame: Optional[cv2.ndarray] + + def select_graphics_item(autosplit: AutoSplit): def callback(async_operation: IAsyncOperation[GraphicsCaptureItem], async_status: AsyncStatus): if async_status != AsyncStatus.COMPLETED: return - autosplit.graphics_capture_item = async_operation.get_results() - autosplit.settings_dict["captured_window_title"] = autosplit.graphics_capture_item.display_name - # __set_region_values(autosplit, - # left=0, - # top=0, - # width=cast(int, autosplit.graphics_capture_item.size.width), - # height=cast(int, autosplit.graphics_capture_item.size.height)) + item = async_operation.get_results() + autosplit.settings_dict["captured_window_title"] = item.display_name + device = media_capture.media_capture_settings.direct3_d11_device + frame_pool = Direct3D11CaptureFramePool.create_free_threaded( + device, + DirectXPixelFormat.B8_G8_R8_A8_UINT_NORMALIZED, + 1, + item.size) + session = frame_pool.create_capture_session(item) + session.is_cursor_capture_enabled = False + session.start_capture() + autosplit.windows_graphics_capture = WindowsGraphicsCapture( + item.size, frame_pool, session, None) # pyright: ignore picker = GraphicsCapturePicker() initialize_with_window(picker, autosplit.effectiveWinId().__int__()) @@ -264,7 +288,10 @@ def validate_before_parsing(autosplit: AutoSplit, show_error: bool = True, check def check_selected_region_exists(autosplit: AutoSplit): - return autosplit.graphics_capture_item or (autosplit.hwnd > 0 and win32gui.GetWindowText(autosplit.hwnd)) + return ( + autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE + and autosplit.windows_graphics_capture) \ + or (autosplit.hwnd > 0 and win32gui.GetWindowText(autosplit.hwnd)) class BaseSelectWidget(QtWidgets.QWidget): From 1f50eb11febd92484ddb55e46494dd0b17303fcc Mon Sep 17 00:00:00 2001 From: Avasam Date: Fri, 8 Apr 2022 20:56:54 -0400 Subject: [PATCH 034/137] Cleaner capture device selection --- .vscode/settings.json | 1 + pyproject.toml | 4 ++ res/settings.ui | 39 ++++++++++++-- src/AutoSplit.py | 30 +++++------ src/capture_method.py | 44 +++++++++------- src/capture_windows.py | 28 +++++----- src/menu_bar.py | 116 +++++++++++++++++++++++++---------------- src/screen_region.py | 40 +++++++------- src/user_profile.py | 21 ++++---- 9 files changed, 195 insertions(+), 128 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index fc7a0eeb..062aea44 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -14,6 +14,7 @@ "editor.codeActionsOnSave": { "source.fixAll": true, "source.fixAll.markdownlint": true, + "source.organizeImports": true, }, "files.insertFinalNewline": true, "trailing-spaces.includeEmptyLines": true, diff --git a/pyproject.toml b/pyproject.toml index 7c3495a6..f4bd5455 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -120,3 +120,7 @@ disable = [ [tool.pylint.TYPECHECK] generated-members = "cv2" + +[tool.isort] +line_length = 120 +combine_as_imports = true diff --git a/res/settings.ui b/res/settings.ui index bd86a6b9..7c49dcb1 100644 --- a/res/settings.ui +++ b/res/settings.ui @@ -7,7 +7,7 @@ 0 0 289 - 572 + 621 @@ -19,13 +19,13 @@ 289 - 572 + 621 289 - 572 + 621 @@ -46,7 +46,7 @@ 10 180 271 - 131 + 181 @@ -138,12 +138,41 @@ Capture method: + + + + 6 + 126 + 151 + 16 + + + + Capture device: + + + + + false + + + + 6 + 148 + 251 + 22 + + + + Scanning for existing devices... + + 10 - 320 + 370 271 241 diff --git a/src/AutoSplit.py b/src/AutoSplit.py index b09acc97..3a27dd7b 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -7,36 +7,36 @@ # - Externals # - Internals from __future__ import annotations -from collections.abc import Callable -from types import FunctionType, TracebackType -from typing import Optional -import sys -import os import ctypes +import os import signal +import sys import traceback +from collections.abc import Callable from time import time +from types import FunctionType, TracebackType +from typing import Optional import certifi import cv2 from PyQt6 import QtCore, QtGui, QtTest from PyQt6.QtWidgets import QApplication, QFileDialog, QMainWindow, QMessageBox, QWidget from win32 import win32gui -from capture_method import DisplayCaptureMethod import error_messages import user_profile from AutoControlledWorker import AutoControlledWorker from AutoSplitImage import COMPARISON_RESIZE, AutoSplitImage, ImageType +from capture_method import CaptureMethod from capture_windows import capture_region, set_ui_image from gen import about, design, settings, update_checker -from hotkeys import send_command, after_setting_hotkey -from menu_bar import get_default_settings_from_ui, open_about, VERSION, open_settings, view_help, check_for_updates, \ - open_update_checker -from screen_region import WindowsGraphicsCapture, select_region, select_window, align_region, validate_before_parsing -from user_profile import DEFAULT_PROFILE, FROZEN +from hotkeys import after_setting_hotkey, send_command +from menu_bar import (AUTOSPLIT_VERSION, check_for_updates, get_default_settings_from_ui, open_about, open_settings, + open_update_checker, view_help) +from screen_region import WindowsGraphicsCapture, align_region, select_region, select_window, validate_before_parsing from split_parser import BELOW_FLAG, DUMMY_FLAG, PAUSE_FLAG, parse_and_validate_images +from user_profile import DEFAULT_PROFILE, FROZEN CREATE_NEW_ISSUE_MESSAGE = ( "Please create a New Issue at " @@ -61,7 +61,7 @@ def excepthook(exception_type: type[BaseException], exception: BaseException, _t class AutoSplit(QMainWindow, design.Ui_MainWindow): - myappid = f"Toufool.AutoSplit.v{VERSION}" + myappid = f"Toufool.AutoSplit.v{AUTOSPLIT_VERSION}" ctypes.windll.shell32.SetCurrentProcessExplicitAppUserModelID(myappid) # Parse command line args @@ -125,7 +125,7 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): reset_image: Optional[AutoSplitImage] = None split_images: list[AutoSplitImage] = [] split_image: AutoSplitImage - camera: Optional[cv2.VideoCapture] = None + capture_device: Optional[cv2.VideoCapture] = None def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-many-statements super().__init__(parent) @@ -161,7 +161,7 @@ def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-man # Send version and process ID to stdout # THIS HAS TO BE THE FIRST TWO LINES SENT - print(f"{VERSION}\n{os.getpid()}", flush=True) + print(f"{AUTOSPLIT_VERSION}\n{os.getpid()}", flush=True) # Use and Start the thread that checks for updates from LiveSplit self.update_auto_control = QtCore.QThread() @@ -754,7 +754,7 @@ def __get_capture_for_comparison(self): # This most likely means we lost capture (ie the captured window was closed, crashed, etc.) # We can't recover by name (yet) with WindowsGraphicsCapture - if capture is None and self.settings_dict["capture_method"] != DisplayCaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + if capture is None and self.settings_dict["capture_method"] != CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: # Try to recover by using the window name self.live_image.setText("Trying to recover window...") hwnd = win32gui.FindWindow(None, self.settings_dict["captured_window_title"]) diff --git a/src/capture_method.py b/src/capture_method.py index 991f96b4..8b137944 100644 --- a/src/capture_method.py +++ b/src/capture_method.py @@ -1,13 +1,12 @@ -from dataclasses import dataclass -from platform import version from collections import OrderedDict +from dataclasses import dataclass from enum import Enum, EnumMeta, unique +from platform import version import cv2 - # https://docs.microsoft.com/en-us/uwp/api/windows.graphics.capture.graphicscapturepicker#applies-to -WCG_MIN_BUILD = 999999 # TODO: Change to 17134 once implemented +WCG_MIN_BUILD = 17134 @dataclass @@ -17,7 +16,7 @@ class DisplayCaptureMethodInfo(): description: str -class DisplayCaptureMethodMeta(EnumMeta): +class CaptureMethodMeta(EnumMeta): # Allow checking if simple string is enum def __contains__(cls, other: str): # noqa:N805 try: @@ -30,7 +29,7 @@ def __contains__(cls, other: str): # noqa:N805 @unique -class DisplayCaptureMethod(Enum, metaclass=DisplayCaptureMethodMeta): +class CaptureMethod(Enum, metaclass=CaptureMethodMeta): # Allow TOML to save as a simple string def __repr__(self): return self.value @@ -48,15 +47,16 @@ def __hash__(self): WINDOWS_GRAPHICS_CAPTURE = "WINDOWS_GRAPHICS_CAPTURE" PRINTWINDOW_RENDERFULLCONTENT = "PRINTWINDOW_RENDERFULLCONTENT" DESKTOP_DUPLICATION = "DESKTOP_DUPLICATION" + VIDEO_CAPTURE_DEVICE = "VIDEO_CAPTURE_DEVICE" -class DisplayCaptureMethodDict(OrderedDict[DisplayCaptureMethod, DisplayCaptureMethodInfo]): +class DisplayCaptureMethodDict(OrderedDict[CaptureMethod, DisplayCaptureMethodInfo]): def get_method_by_index(self, index: int): return list(self.keys())[index] -DISPLAY_CAPTURE_METHODS = DisplayCaptureMethodDict({ - DisplayCaptureMethod.BITBLT: DisplayCaptureMethodInfo( +CAPTURE_METHODS = DisplayCaptureMethodDict({ + CaptureMethod.BITBLT: DisplayCaptureMethodInfo( name="BitBlt", short_description="fast, issues with Hardware Acceleration and OpenGL", description=( @@ -65,7 +65,7 @@ def get_method_by_index(self, index: int): "\nbut it cannot properly record OpenGL or Hardware Accelerated Windows. " ), ), - DisplayCaptureMethod.WINDOWS_GRAPHICS_CAPTURE: DisplayCaptureMethodInfo( + CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: DisplayCaptureMethodInfo( name="Windows Graphics Capture", short_description="fastest, most compatible but less features", description=( @@ -78,7 +78,7 @@ def get_method_by_index(self, index: int): "\nfor more details about those restrictions." ), ), - DisplayCaptureMethod.DESKTOP_DUPLICATION: DisplayCaptureMethodInfo( + CaptureMethod.DESKTOP_DUPLICATION: DisplayCaptureMethodInfo( name="Direct3D Desktop Duplication", short_description="very slow, bound to display", description=( @@ -88,7 +88,7 @@ def get_method_by_index(self, index: int): "\noverlapping windows will show up and can't record across displays. " ), ), - DisplayCaptureMethod.PRINTWINDOW_RENDERFULLCONTENT: DisplayCaptureMethodInfo( + CaptureMethod.PRINTWINDOW_RENDERFULLCONTENT: DisplayCaptureMethodInfo( name="Force Full Content Rendering", short_description="very slow, can affect rendering pipeline", description=( @@ -98,22 +98,31 @@ def get_method_by_index(self, index: int): "\nand can mess up some applications' rendering pipelines. " ), ), + CaptureMethod.VIDEO_CAPTURE_DEVICE: DisplayCaptureMethodInfo( + name="Video Capture Device", + short_description="select below", + description=( + "\nUses a Video Capture Device, like a webcam, virtual cam, or capture card. " + "\nYou can select one below. " + "\nIt is not yet possible for us to display the device name" + ), + ), }) # Detect and remove unsupported capture methods if int(version().split(".")[2]) < WCG_MIN_BUILD: - DISPLAY_CAPTURE_METHODS.pop(DisplayCaptureMethod.WINDOWS_GRAPHICS_CAPTURE) + CAPTURE_METHODS.pop(CaptureMethod.WINDOWS_GRAPHICS_CAPTURE) @dataclass class CameraInfo(): id: int name: str - occupied: str + occupied: bool -def get_all_cameras(): +def get_all_video_capture_devices(): index = 0 video_captures: list[CameraInfo] = [] while index < 8: @@ -132,8 +141,3 @@ def get_all_cameras(): video_capture.release() index += 1 return video_captures - - -# Detect and remove unsupported capture methods -if int(version().split(".")[2]) < WCG_MIN_BUILD: - DISPLAY_CAPTURE_METHODS.pop(DisplayCaptureMethod.WINDOWS_GRAPHICS_CAPTURE) diff --git a/src/capture_windows.py b/src/capture_windows.py index 40815b39..3869c944 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -1,27 +1,27 @@ from __future__ import annotations -from typing import Optional, TypedDict, cast, TYPE_CHECKING - -if TYPE_CHECKING: - from AutoSplit import AutoSplit import asyncio - import ctypes import ctypes.wintypes -import d3dshot +from typing import TYPE_CHECKING, Optional, TypedDict, cast + import cv2 +import d3dshot import numpy as np +import pywintypes import win32con import win32ui -import pywintypes from PyQt6 import QtCore, QtGui from PyQt6.QtWidgets import QLabel from win32 import win32gui -from winsdk.windows.graphics.imaging import SoftwareBitmap, BitmapBufferAccessMode +from winsdk.windows.graphics.imaging import BitmapBufferAccessMode, SoftwareBitmap -from capture_method import DisplayCaptureMethod +from capture_method import CaptureMethod from screen_region import WindowsGraphicsCapture +if TYPE_CHECKING: + from AutoSplit import AutoSplit + # This is an undocumented nFlag value for PrintWindow PW_RENDERFULLCONTENT = 0x00000002 @@ -140,16 +140,16 @@ def capture_region(autosplit: AutoSplit): selection = autosplit.settings_dict["capture_region"] capture_method = autosplit.settings_dict["capture_method"] - if capture_method not in DisplayCaptureMethod: - return __camera_capture(autosplit.camera, selection) + if capture_method == CaptureMethod.VIDEO_CAPTURE_DEVICE: + return __camera_capture(autosplit.capture_device, selection) - if capture_method == DisplayCaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + if capture_method == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: return __windows_graphics_capture(autosplit.windows_graphics_capture, selection) - if capture_method == DisplayCaptureMethod.DESKTOP_DUPLICATION: + if capture_method == CaptureMethod.DESKTOP_DUPLICATION: return __d3d_capture(hwnd, selection) - return __bit_blt_capture(hwnd, selection, capture_method == DisplayCaptureMethod.PRINTWINDOW_RENDERFULLCONTENT) + return __bit_blt_capture(hwnd, selection, capture_method == CaptureMethod.PRINTWINDOW_RENDERFULLCONTENT) def set_ui_image(qlabel: QLabel, image: Optional[cv2.ndarray], transparency: bool): diff --git a/src/menu_bar.py b/src/menu_bar.py index 30d913aa..0ae24f7a 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -1,28 +1,28 @@ from __future__ import annotations -from typing import TYPE_CHECKING, Any, Union, cast - - -if TYPE_CHECKING: - from AutoSplit import AutoSplit +import threading import webbrowser +from typing import TYPE_CHECKING, Any, Optional, Union, cast import cv2 import requests -from simplejson.errors import JSONDecodeError from packaging import version -from PyQt6 import QtWidgets, QtCore +from PyQt6 import QtCore, QtWidgets from requests.exceptions import RequestException +from simplejson.errors import JSONDecodeError from win32 import win32gui import error_messages import user_profile -from capture_method import DISPLAY_CAPTURE_METHODS, DisplayCaptureMethod, CameraInfo, get_all_cameras +from capture_method import CAPTURE_METHODS, CameraInfo, CaptureMethod, get_all_video_capture_devices from gen import about, design, resources_rc, settings as settings_ui, update_checker # noqa: F401 from hotkeys import set_hotkey +if TYPE_CHECKING: + from AutoSplit import AutoSplit + # AutoSplit Version number -VERSION = "1.6.1" +AUTOSPLIT_VERSION = "2.0.0-alpha" # About Window @@ -33,7 +33,7 @@ def __init__(self): self.setupUi(self) self.created_by_label.setOpenExternalLinks(True) self.donate_button_label.setOpenExternalLinks(True) - self.version_label.setText(f"Version: {VERSION}") + self.version_label.setText(f"Version: {AUTOSPLIT_VERSION}") self.show() @@ -45,12 +45,12 @@ class __UpdateCheckerWidget(QtWidgets.QWidget, update_checker.Ui_UpdateChecker): def __init__(self, latest_version: str, design_window: design.Ui_MainWindow, check_on_open: bool = False): super().__init__() self.setupUi(self) - self.current_version_number_label.setText(VERSION) + self.current_version_number_label.setText(AUTOSPLIT_VERSION) self.latest_version_number_label.setText(latest_version) self.left_button.clicked.connect(self.open_update) self.do_not_ask_again_checkbox.stateChanged.connect(self.do_not_ask_me_again_state_changed) self.design_window = design_window - if version.parse(latest_version) > version.parse(VERSION): + if version.parse(latest_version) > version.parse(AUTOSPLIT_VERSION): self.do_not_ask_again_checkbox.setVisible(check_on_open) self.show() elif not check_on_open: @@ -101,10 +101,10 @@ def check_for_updates(autosplit: AutoSplit, check_on_open: bool = False): class __SettingsWidget(QtWidgets.QDialog, settings_ui.Ui_DialogSettings): - __camera_capture_methods: list[CameraInfo] + __video_capture_devices: list[CameraInfo] """ Used to temporarily store the existing cameras, - we don't want to call `get_all_cameras` agains and possibly have a different result + we don't want to call `get_all_video_capture_devices` agains and possibly have a different result """ def __update_default_threshold(self, value: Any): @@ -121,40 +121,36 @@ def __update_default_threshold(self, value: Any): def __set_value(self, key: str, value: Any): self.autosplit.settings_dict[key] = value - def get_capture_method_by_current_index(self): - current_index = self.capture_method_combobox.currentIndex() - display_DISPLAY_CAPTURE_METHODS_len = len(DISPLAY_CAPTURE_METHODS) - return self.__camera_capture_methods[current_index - display_DISPLAY_CAPTURE_METHODS_len].name \ - if current_index >= display_DISPLAY_CAPTURE_METHODS_len \ - else DISPLAY_CAPTURE_METHODS.get_method_by_index(current_index) - - def get_capture_method_index(self, capture_method: Union[str, DisplayCaptureMethod]): + def get_capture_method_index(self, capture_method: Union[str, CaptureMethod]): """ Returns 0 if the capture_method is invalid or unsupported """ - item_count = self.capture_method_combobox.count() - display_DISPLAY_CAPTURE_METHODS_len = len(DISPLAY_CAPTURE_METHODS) try: - return [camera.name for camera in self.__camera_capture_methods].index(cast(str, capture_method)) \ - if item_count >= display_DISPLAY_CAPTURE_METHODS_len \ - else list(DISPLAY_CAPTURE_METHODS.keys()).index(cast(DisplayCaptureMethod, capture_method)) + return list(CAPTURE_METHODS.keys()).index(cast(CaptureMethod, capture_method)) + except ValueError: + return 0 + + def get_capture_device_index(self, capture_device_id: int): + """ + Returns 0 if the capture_device_id is invalid + """ + try: + return [device.id for device in self.__video_capture_devices].index(capture_device_id) except ValueError: return 0 def __capture_method_changed(self): - capture_method = self.get_capture_method_by_current_index() - if self.autosplit.camera: - self.autosplit.camera.release() - self.autosplit.camera = None - if capture_method not in DisplayCaptureMethod: - camera_index = self.capture_method_combobox.currentIndex() - len(DISPLAY_CAPTURE_METHODS) - camera_id = self.__camera_capture_methods[camera_index].id - self.autosplit.settings_dict["captured_window_title"] = cast(str, capture_method) - self.autosplit.camera = cv2.VideoCapture(camera_id) - elif capture_method == DisplayCaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + capture_method = CAPTURE_METHODS.get_method_by_index(self.capture_method_combobox.currentIndex()) + # Release or start video capture device + self.__capture_device_changed(capture_method) + if capture_method == CaptureMethod.VIDEO_CAPTURE_DEVICE: + self.autosplit.select_region_button.setDisabled(True) + self.autosplit.select_window_button.setDisabled(True) + elif capture_method == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: self.autosplit.select_region_button.setDisabled(True) else: self.autosplit.select_region_button.setDisabled(False) + self.autosplit.select_window_button.setDisabled(False) self.autosplit.windows_graphics_capture = None # Recover window from name hwnd = win32gui.FindWindow(None, self.autosplit.settings_dict["captured_window_title"]) @@ -162,30 +158,56 @@ def __capture_method_changed(self): self.autosplit.hwnd = hwnd return capture_method + def __capture_device_changed(self, current_capture_method: Optional[Union[CaptureMethod, str]] = None): + current_capture_method = current_capture_method or self.autosplit.settings_dict["capture_method"] + # Always release the previous capture device + if self.autosplit.capture_device: + self.autosplit.capture_device.release() + self.autosplit.capture_device = None + device_index = self.capture_device_combobox.currentIndex() + capture_device = self.__video_capture_devices[device_index] + if current_capture_method == CaptureMethod.VIDEO_CAPTURE_DEVICE: + self.autosplit.settings_dict["captured_window_title"] = capture_device.name + self.autosplit.capture_device = cv2.VideoCapture(capture_device.id) + return capture_device.id + + def __set_all_capture_devices_async(self): + self.__video_capture_devices = get_all_video_capture_devices() + if len(self.__video_capture_devices) > 0: + for i in range(self.capture_device_combobox.count()): + self.capture_device_combobox.removeItem(i) + self.capture_device_combobox.addItems([ + f"* {device.name}{'' if device.occupied else ' (occupied)'}" + for device in self.__video_capture_devices]) + self.capture_device_combobox.setEnabled(True) + self.capture_device_combobox.setCurrentIndex( + self.get_capture_device_index(self.autosplit.settings_dict["capture_device_id"])) + else: + self.capture_device_combobox.setPlaceholderText("No device found.") + def __init__(self, autosplit: AutoSplit): super().__init__() self.setupUi(self) self.autosplit = autosplit # region Build the Capture method combobox - display_DISPLAY_CAPTURE_METHODS = DISPLAY_CAPTURE_METHODS.values() - self.__camera_capture_methods = get_all_cameras() + capture_method_values = CAPTURE_METHODS.values() + threading.Thread(target=self.__set_all_capture_devices_async).start() capture_list_items = [ f"- {method.name} ({method.short_description})" - for method in display_DISPLAY_CAPTURE_METHODS - ] + [f"* {camera.name}{'' if camera.occupied else ' (occupied)'}" for camera in self.__camera_capture_methods] + for method in capture_method_values + ] list_view = QtWidgets.QListView() list_view.setWordWrap(True) # HACK: The first time the dropdown is rendered, it does not have the right height # Assuming all options take 2 lines (except D3D which has 3). And all lines (with separator) takes 17 pixels - list_view.setMinimumHeight(17 * (2 * len(display_DISPLAY_CAPTURE_METHODS) - + len(self.__camera_capture_methods))) + list_view.setMinimumHeight(17 * (2 * len(capture_method_values))) list_view.setVerticalScrollBarPolicy(QtCore.Qt.ScrollBarPolicy.ScrollBarAlwaysOff) self.capture_method_combobox.setView(list_view) self.capture_method_combobox.addItems(capture_list_items) self.capture_method_combobox.setToolTip("\n\n".join([ f"{method.name} :\n{method.description}" - for method in display_DISPLAY_CAPTURE_METHODS])) + for method in capture_method_values])) # endregion # region Set initial values @@ -227,6 +249,9 @@ def __init__(self, autosplit: AutoSplit): self.capture_method_combobox.currentIndexChanged.connect(lambda: self.__set_value( "capture_method", self.__capture_method_changed())) + self.capture_device_combobox.currentIndexChanged.connect(lambda: self.__set_value( + "capture_device_id", + self.__capture_device_changed())) # Image Settings self.default_comparison_method.currentIndexChanged.connect(lambda: self.__set_value( @@ -264,8 +289,9 @@ def get_default_settings_from_ui(autosplit: AutoSplit): "pause_hotkey": default_settings_dialog.pause_input.text(), "fps_limit": default_settings_dialog.fps_limit_spinbox.value(), "live_capture_region": default_settings_dialog.live_capture_region_checkbox.isChecked(), - "capture_method": DISPLAY_CAPTURE_METHODS.get_method_by_index( + "capture_method": CAPTURE_METHODS.get_method_by_index( default_settings_dialog.capture_method_combobox.currentIndex()), + "capture_device_id": default_settings_dialog.capture_device_combobox.currentIndex(), "default_comparison_method": default_settings_dialog.default_comparison_method.currentIndex(), "default_similarity_threshold": default_settings_dialog.default_similarity_threshold_spinbox.value(), "default_delay_time": default_settings_dialog.default_delay_time_spinbox.value(), diff --git a/src/screen_region.py b/src/screen_region.py index 90d11141..8c95c26d 100644 --- a/src/screen_region.py +++ b/src/screen_region.py @@ -1,30 +1,30 @@ from __future__ import annotations -from dataclasses import dataclass -from typing import Optional, cast, TYPE_CHECKING - -if TYPE_CHECKING: - from AutoSplit import AutoSplit - -import os import ctypes import ctypes.wintypes +import os +from dataclasses import dataclass +from typing import TYPE_CHECKING, Optional, cast + import cv2 import numpy as np from PyQt6 import QtCore, QtGui, QtTest, QtWidgets from win32 import win32gui -from win32con import GA_ROOT, MAXBYTE, SM_XVIRTUALSCREEN, SM_YVIRTUALSCREEN, SM_CXVIRTUALSCREEN, SM_CYVIRTUALSCREEN -from winsdk.windows.graphics.capture import Direct3D11CaptureFramePool, GraphicsCapturePicker, GraphicsCaptureItem, \ - GraphicsCaptureSession -from winsdk.windows.foundation import IAsyncOperation, AsyncStatus +from win32con import GA_ROOT, MAXBYTE, SM_CXVIRTUALSCREEN, SM_CYVIRTUALSCREEN, SM_XVIRTUALSCREEN, SM_YVIRTUALSCREEN from winsdk._winrt import initialize_with_window -from winsdk.windows.media.capture import MediaCapture -from winsdk.windows.graphics.directx import DirectXPixelFormat +from winsdk.windows.foundation import AsyncStatus, IAsyncOperation from winsdk.windows.graphics import SizeInt32 +from winsdk.windows.graphics.capture import (Direct3D11CaptureFramePool, GraphicsCaptureItem, GraphicsCapturePicker, + GraphicsCaptureSession) +from winsdk.windows.graphics.directx import DirectXPixelFormat +from winsdk.windows.media.capture import MediaCapture import capture_windows import error_messages -from capture_method import DisplayCaptureMethod +from capture_method import CaptureMethod + +if TYPE_CHECKING: + from AutoSplit import AutoSplit SUPPORTED_IMREAD_FORMATS = [ ("Windows bitmaps", "*.bmp *.dib"), @@ -119,7 +119,7 @@ def callback(async_operation: IAsyncOperation[GraphicsCaptureItem], async_status def select_window(autosplit: AutoSplit): - if autosplit.settings_dict["capture_method"] == DisplayCaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + if autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: select_graphics_item(autosplit) return # Create a screen selector widget @@ -288,11 +288,11 @@ def validate_before_parsing(autosplit: AutoSplit, show_error: bool = True, check def check_selected_region_exists(autosplit: AutoSplit): - if autosplit.settings_dict["capture_method"] == DisplayCaptureMethod.WINDOWS_GRAPHICS_CAPTURE: - return autosplit.windows_graphics_capture - if autosplit.settings_dict["capture_method"] in DisplayCaptureMethod: - return autosplit.hwnd > 0 and win32gui.GetWindowText(autosplit.hwnd) - return autosplit.camera + if autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + return bool(autosplit.windows_graphics_capture) + if autosplit.settings_dict["capture_method"] == CaptureMethod.VIDEO_CAPTURE_DEVICE: + return bool(autosplit.capture_device) + return bool(autosplit.hwnd > 0 and win32gui.GetWindowText(autosplit.hwnd)) class BaseSelectWidget(QtWidgets.QWidget): diff --git a/src/user_profile.py b/src/user_profile.py index 6d994862..a24d35a3 100644 --- a/src/user_profile.py +++ b/src/user_profile.py @@ -1,22 +1,23 @@ from __future__ import annotations -from typing import TYPE_CHECKING, TypedDict, Union, cast -if TYPE_CHECKING: - from AutoSplit import AutoSplit import os import sys +from typing import TYPE_CHECKING, TypedDict, Union, cast import keyboard # https://github.com/boppreh/keyboard/issues/505 import toml -from win32 import win32gui from PyQt6 import QtCore, QtWidgets +from win32 import win32gui import error_messages -from capture_method import DISPLAY_CAPTURE_METHODS, DisplayCaptureMethod +from capture_method import CAPTURE_METHODS, CaptureMethod from capture_windows import Region from gen import design from hotkeys import set_hotkey +if TYPE_CHECKING: + from AutoSplit import AutoSplit + # Keyword "frozen" is for setting basedir while in onefile mode in pyinstaller FROZEN = hasattr(sys, "frozen") # Get the directory of either AutoSplit.exe or AutoSplit.py @@ -31,7 +32,8 @@ class UserProfileDict(TypedDict): pause_hotkey: str fps_limit: int live_capture_region: bool - capture_method: Union[str, DisplayCaptureMethod] + capture_method: Union[str, CaptureMethod] + capture_device_id: int default_comparison_method: int default_similarity_threshold: float default_delay_time: int @@ -51,7 +53,8 @@ class UserProfileDict(TypedDict): pause_hotkey="", fps_limit=60, live_capture_region=True, - capture_method=DISPLAY_CAPTURE_METHODS.get_method_by_index(0), + capture_method=CAPTURE_METHODS.get_method_by_index(0), + capture_device_id=0, default_comparison_method=0, default_similarity_threshold=0.95, default_delay_time=0, @@ -129,7 +132,7 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str return False autosplit.select_region_button.setDisabled( - autosplit.settings_dict["capture_method"] == DisplayCaptureMethod.WINDOWS_GRAPHICS_CAPTURE) + autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE) autosplit.split_image_folder_input.setText(autosplit.settings_dict["split_image_directory"]) keyboard.unhook_all() if not autosplit.is_auto_controlled: @@ -147,7 +150,7 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str if ( autosplit.settings_dict["captured_window_title"] # We can't recover by name (yet) with WindowsGraphicsCapture - and autosplit.settings_dict["capture_method"] != DisplayCaptureMethod.WINDOWS_GRAPHICS_CAPTURE + and autosplit.settings_dict["capture_method"] != CaptureMethod.WINDOWS_GRAPHICS_CAPTURE ): hwnd = win32gui.FindWindow(None, autosplit.settings_dict["captured_window_title"]) if hwnd: From 6df5975b99f0e0872e1f56a5157a2948ad50536f Mon Sep 17 00:00:00 2001 From: Avasam Date: Fri, 8 Apr 2022 23:43:41 -0400 Subject: [PATCH 035/137] Specify OBS' Virtualcam plugin and pickup cam on load --- src/capture_method.py | 10 ++++++---- src/capture_windows.py | 6 ++++-- src/menu_bar.py | 4 ++-- src/user_profile.py | 10 ++++++++-- 4 files changed, 20 insertions(+), 10 deletions(-) diff --git a/src/capture_method.py b/src/capture_method.py index 8b137944..d17de395 100644 --- a/src/capture_method.py +++ b/src/capture_method.py @@ -92,9 +92,9 @@ def get_method_by_index(self, index: int): name="Force Full Content Rendering", short_description="very slow, can affect rendering pipeline", description=( - "\nUses BitBlt behind the scene, but passes a special flag " - "\nto PrintWindow to force rendering the entire desktop window. " - "\nAbout 10-15x slower than BitBlt based on window size " + "\nUses BitBlt behind the scene, but passes a special flag to PrintWindow " + "\nto force rendering the entire desktop area. " + "\nAbout 10-15x slower than BitBlt based on captured window size " "\nand can mess up some applications' rendering pipelines. " ), ), @@ -104,7 +104,9 @@ def get_method_by_index(self, index: int): description=( "\nUses a Video Capture Device, like a webcam, virtual cam, or capture card. " "\nYou can select one below. " - "\nIt is not yet possible for us to display the device name" + "\nIt is not yet possible for us to display the device name. " + "\nIf you want to use this with OBS' Virtual Camera, use the Virtualcam plugin instead " + "\nhttps://obsproject.com/forum/resources/obs-virtualcam.949/" ), ), }) diff --git a/src/capture_windows.py b/src/capture_windows.py index 3869c944..26e3d66f 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -122,8 +122,10 @@ def __camera_capture(camera: Optional[cv2.VideoCapture], selection: Region): result, image = camera.read() if not result: return None - image = image[selection["x"]:selection["width"] + selection["x"], - selection["y"]:selection["width"] + selection["y"]] + image = image[ + selection["y"]:selection["height"] + selection["y"], + selection["x"]:selection["width"] + selection["x"], + ] return cv2.cvtColor(image, cv2.COLOR_BGR2BGRA) diff --git a/src/menu_bar.py b/src/menu_bar.py index 0ae24f7a..771b6721 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -200,8 +200,8 @@ def __init__(self, autosplit: AutoSplit): list_view = QtWidgets.QListView() list_view.setWordWrap(True) # HACK: The first time the dropdown is rendered, it does not have the right height - # Assuming all options take 2 lines (except D3D which has 3). And all lines (with separator) takes 17 pixels - list_view.setMinimumHeight(17 * (2 * len(capture_method_values))) + # Assuming all options take 2 lines (except camera which has 1). And all lines (with separator) takes 17 pixels + list_view.setMinimumHeight(17 * (2 * len(capture_method_values) - 1) + 1) list_view.setVerticalScrollBarPolicy(QtCore.Qt.ScrollBarPolicy.ScrollBarAlwaysOff) self.capture_method_combobox.setView(list_view) self.capture_method_combobox.addItems(capture_list_items) diff --git a/src/user_profile.py b/src/user_profile.py index a24d35a3..4c78ddb9 100644 --- a/src/user_profile.py +++ b/src/user_profile.py @@ -4,6 +4,7 @@ import sys from typing import TYPE_CHECKING, TypedDict, Union, cast +import cv2 import keyboard # https://github.com/boppreh/keyboard/issues/505 import toml from PyQt6 import QtCore, QtWidgets @@ -131,8 +132,13 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str autosplit.show_error_signal.emit(error_messages.invalid_settings) return False - autosplit.select_region_button.setDisabled( - autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE) + if autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + autosplit.select_region_button.setDisabled(True) + elif autosplit.settings_dict["capture_method"] == CaptureMethod.VIDEO_CAPTURE_DEVICE: + autosplit.select_region_button.setDisabled(True) + autosplit.select_window_button.setDisabled(True) + autosplit.capture_device = cv2.VideoCapture(autosplit.settings_dict["capture_device_id"]) + autosplit.split_image_folder_input.setText(autosplit.settings_dict["split_image_directory"]) keyboard.unhook_all() if not autosplit.is_auto_controlled: From 993e0776254b7a1d5fd469acb2a405cd536b2cc0 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 9 Apr 2022 00:12:17 -0400 Subject: [PATCH 036/137] Fixed WindowsGraphicsCapture max FPS detection --- src/AutoSplit.py | 22 ++++++++++++---------- src/capture_method.py | 17 +++++++++-------- src/capture_windows.py | 14 +++++++------- src/screen_region.py | 2 +- 4 files changed, 29 insertions(+), 26 deletions(-) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 68b596e2..5dd2d67e 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -249,7 +249,7 @@ def __live_image_function(self): return # Set live image in UI if self.hwnd or self.windows_graphics_capture: - capture = capture_region(self) + capture, _ = capture_region(self) set_ui_image(self.live_image, capture, False) def __load_start_image(self, started_by_button: bool = False, wait_for_delay: bool = True): @@ -303,7 +303,7 @@ def __start_image_function(self): self.start_image_status_value_label.setText("ready") self.__update_split_image(self.start_image) - capture = self.__get_capture_for_comparison() + capture, _ = self.__get_capture_for_comparison() start_image_threshold = self.start_image.get_similarity_threshold(self) start_image_similarity = self.start_image.compare_with_capture(self, capture) self.table_current_image_threshold_label.setText(f"{start_image_threshold:.2f}") @@ -383,7 +383,7 @@ def __take_screenshot(self): screenshot_index += 1 # Grab screenshot of capture region - capture = capture_region(self) + capture, _ = capture_region(self) if capture is None: error_messages.region() return @@ -408,9 +408,10 @@ def __check_fps(self): for image in images: count = 0 while count < CHECK_FPS_ITERATIONS: - capture = self.__get_capture_for_comparison() + capture, is_old_image = self.__get_capture_for_comparison() _ = image.compare_with_capture(self, capture) - count += 1 + if not is_old_image: + count += 1 # calculate FPS t1 = time() @@ -604,7 +605,7 @@ def __similarity_threshold_loop(self, number_of_split_images: int, dummy_splits_ """ start = time() while True: - capture = self.__get_capture_for_comparison() + capture, _ = self.__get_capture_for_comparison() if self.__reset_if_should(capture): return True @@ -672,7 +673,7 @@ def __pause_loop(self, stop_time: float, message: str): pause_split_image_number = self.split_image_number while True: # Calculate similarity for reset image - if self.__reset_if_should(self.__get_capture_for_comparison()): + if self.__reset_if_should(self.__get_capture_for_comparison()[0]): return True time_delta = time() - start_time @@ -749,7 +750,7 @@ def __get_capture_for_comparison(self): """ Grab capture region and resize for comparison """ - capture = capture_region(self) + capture, is_old_image = capture_region(self) # This most likely means we lost capture (ie the captured window was closed, crashed, etc.) # We can't recover by name (yet) with WindowsGraphicsCapture @@ -760,8 +761,9 @@ def __get_capture_for_comparison(self): # Don't fallback to desktop if hwnd: self.hwnd = hwnd - capture = capture_region(self) - return None if capture is None else cv2.resize(capture, COMPARISON_RESIZE, interpolation=cv2.INTER_NEAREST) + capture, _ = capture_region(self) + return None if capture is None else cv2.resize( + capture, COMPARISON_RESIZE, interpolation=cv2.INTER_NEAREST), is_old_image def __reset_if_should(self, capture: Optional[cv2.ndarray]): """ diff --git a/src/capture_method.py b/src/capture_method.py index 1b262e8b..1c5ee986 100644 --- a/src/capture_method.py +++ b/src/capture_method.py @@ -37,20 +37,21 @@ def __hash__(self): CAPTURE_METHODS = OrderedDict({ CaptureMethod.BITBLT: CaptureMethodInfo( name="BitBlt", - short_description="fast, issues with Hardware Acceleration and OpenGL", + short_description="fastest, least compatible", description=( - "\nA good default fast option. Allows recording background windows " - "\n(as long as they still decide to render in the background), " + "\nA good default fast option. Also allows recording background windows " + "\n(as long as they still actually render when in the background), " "\nbut it cannot properly record OpenGL or Hardware Accelerated Windows. " + "\nThe smaller the window, the more efficient it is. " ), ), CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: CaptureMethodInfo( name="Windows Graphics Capture", - short_description="fastest, most compatible but less features", + short_description="fast, most compatible but less features", description=( f"\nOnly available in Windows 10.0.{WCG_MIN_BUILD} and up. " "\nAllows recording UWP apps, hardware accelerated and fullscreen exclusive windows. " - "\nAdds a yellow border around the recorded window. " + "\nCaps at around 60 FPS and adds a yellow border around the recorded window. " "\nDoes not support automatically recovering closed Windows, manual cropping only, " "\nand you have to reselect the window everytime you open AutoSplit. " "\nSee https://github.com/pywinrt/python-winsdk/issues/5 " @@ -59,11 +60,11 @@ def __hash__(self): ), CaptureMethod.DESKTOP_DUPLICATION: CaptureMethodInfo( name="Direct3D Desktop Duplication", - short_description="very slow, bound to display", + short_description="slower, bound to display", description=( "\nDuplicates the desktop using Direct3D. " "\nIt can record OpenGL and Hardware Accelerated windows. " - "\nBut it's about 10-15x slower than BitBlt, " + "\nAbout 10-15x slower than BitBlt. Not affected by window size. " "\noverlapping windows will show up and can't record across displays. " ), ), @@ -73,7 +74,7 @@ def __hash__(self): description=( "\nUses BitBlt behind the scene, but passes a special flag " "\nto PrintWindow to force rendering the entire desktop window. " - "\nAbout 10-15x slower than BitBlt based on window size " + "\nAbout 10-15x slower than BitBlt based on original window size " "\nand can mess up some applications' rendering pipelines. " ), ), diff --git a/src/capture_windows.py b/src/capture_windows.py index 3b6c531e..8e88f59b 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -91,16 +91,16 @@ def __d3d_capture(hwnd: int, selection: Region): selection["y"] + offset_y, selection["width"] + selection["x"] + offset_x, selection["height"] + selection["y"] + offset_y)) - return cv2.cvtColor(screenshot, cv2.COLOR_) + return cv2.cvtColor(screenshot, cv2.COLOR_RGBA2BGRA) def __windows_graphics_capture(windows_graphics_capture: Optional[WindowsGraphicsCapture], selection: Region): if not windows_graphics_capture or not windows_graphics_capture.frame_pool: - return None + return None, False frame = windows_graphics_capture.frame_pool.try_get_next_frame() if not frame: - return windows_graphics_capture.last_captured_frame + return windows_graphics_capture.last_captured_frame, True async def coroutine(): return await SoftwareBitmap.create_copy_from_surface_async(frame.surface) # pyright: ignore @@ -114,10 +114,10 @@ async def coroutine(): selection["x"]:selection["x"] + selection["width"], ] windows_graphics_capture.last_captured_frame = image - return image + return image, False -def capture_region(autosplit: AutoSplit): +def capture_region(autosplit: AutoSplit) -> tuple[Optional[cv2.ndarray], bool]: """ Captures an image of the region for a window matching the given parameters of the bounding box @@ -134,9 +134,9 @@ def capture_region(autosplit: AutoSplit): return __windows_graphics_capture(autosplit.windows_graphics_capture, selection) if capture_method == CaptureMethod.DESKTOP_DUPLICATION: - return __d3d_capture(hwnd, selection) + return __d3d_capture(hwnd, selection), False - return __bit_blt_capture(hwnd, selection, capture_method == CaptureMethod.PRINTWINDOW_RENDERFULLCONTENT) + return __bit_blt_capture(hwnd, selection, capture_method == CaptureMethod.PRINTWINDOW_RENDERFULLCONTENT), False def set_ui_image(qlabel: QLabel, image: Optional[cv2.ndarray], transparency: bool): diff --git a/src/screen_region.py b/src/screen_region.py index 3b051f8d..d00b902e 100644 --- a/src/screen_region.py +++ b/src/screen_region.py @@ -198,7 +198,7 @@ def align_region(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) + capture, _ = capture_windows.capture_region(autosplit) if capture is None: error_messages.region() From 3a8e9e34d6f278dc2da87f20c7a78b8d927ee970 Mon Sep 17 00:00:00 2001 From: Avasam Date: Mon, 4 Apr 2022 16:20:38 -0400 Subject: [PATCH 037/137] Massively sped up Flake tests Removed 400+kb of type stubs --- .flake8 | 27 +- .vscode/settings.json | 4 +- pyproject.toml | 18 +- scripts/requirements.txt | 4 +- src/AutoSplit.py | 29 +- src/capture_windows.py | 3 +- src/menu_bar.py | 2 +- typings/PyInstaller/utils/hooks/__init__.pyi | 9 +- typings/imagehash/__init__.pyi | 5 +- typings/keyboard/__init__.pyi | 87 +- typings/keyboard/_keyboard_event.pyi | 24 +- typings/pyautogui/__init__.pyi | 51 +- typings/win32-stubs/win32gui.pyi | 6952 --- typings/win32con/__init__.pyi | 5069 -- typings/win32helper/__init__.pyi | 0 typings/win32helper/ntsecuritycon.pyi | 690 - typings/win32helper/sspicon.pyi | 483 - typings/win32helper/win32cryptcon.pyi | 1916 - typings/win32helper/win32inetcon.pyi | 1107 - typings/win32helper/win32netcon.pyi | 658 - typings/win32helper/winioctlcon.pyi | 751 - typings/win32typing/__init__.pyi | 48527 ----------------- 22 files changed, 123 insertions(+), 66293 deletions(-) delete mode 100644 typings/win32-stubs/win32gui.pyi delete mode 100644 typings/win32con/__init__.pyi delete mode 100644 typings/win32helper/__init__.pyi delete mode 100644 typings/win32helper/ntsecuritycon.pyi delete mode 100644 typings/win32helper/sspicon.pyi delete mode 100644 typings/win32helper/win32cryptcon.pyi delete mode 100644 typings/win32helper/win32inetcon.pyi delete mode 100644 typings/win32helper/win32netcon.pyi delete mode 100644 typings/win32helper/winioctlcon.pyi delete mode 100644 typings/win32typing/__init__.pyi diff --git a/.flake8 b/.flake8 index 13ad4a4c..2616ddc5 100644 --- a/.flake8 +++ b/.flake8 @@ -2,34 +2,23 @@ color=always max-line-length=120 ; Auto generated -exclude=src/gen/ -; Linebreak before binary operator -; Allow default value other than "..." -; Allow imports at the bottom of file -ignore=W503,Y015,E402 +exclude=src/gen/, typings/cv2-stubs/__init__.pyi +ignore= + W503, ; Linebreak before binary operator + Y015, ; Allow default value other than "..." + E402, ; Allow imports at the bottom of file + Y026, ; Not using typing_extensions per-file-ignores= - ; Function bodys contain other than just ... (eg: raise) - ; Default values for typed arguments - typings/win32typing/__init__.pyi: Q000,E704,E501,N8, Y021,Y020, Y010,Y011 - typings/win32-stubs/win32gui.pyi: Q000,E704,E501,N8, Y021,Y020, Y010,Y011 - - ; Docstrings in type stubs - ; Quoted annotations - ; TypeAlias - typings/win32*/*: Q000,E704,E501,N8, Y021,Y020,Y026 - ; Docstrings in type stubs ; Function bodys contain other than just ... (eg: raise) - ; TypeAlias ; Single quote docstrings - typings/cv2-stubs/__init__.pyi: Q000,E704,E501,N8, Y021,Y010,Y026, Q002 + typings/cv2-stubs/__init__.pyi: Q000,N8, E704,E501, Y021,Y010,Q002 ; Quotes ; Allow ... on same line as def ; Line too long - ; Naming stuff + ; Naming conventions can't be controlled for external libraries typings/**: Q000,E704,E501,N8 - ; PyQt methods ignore-names=closeEvent,paintEvent,keyPressEvent,mousePressEvent,mouseMoveEvent,mouseReleaseEvent ; McCabe max-complexity is also taken care of by Pylint and doesn't fail the build there diff --git a/.vscode/settings.json b/.vscode/settings.json index e205e2ea..067b9726 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -13,7 +13,7 @@ "editor.formatOnSave": true, "editor.codeActionsOnSave": { "source.fixAll": true, - "source.fixAll.markdownlint": true, + "source.organizeImports": true, }, "files.insertFinalNewline": true, "trailing-spaces.includeEmptyLines": true, @@ -66,6 +66,8 @@ "python.linting.flake8CategorySeverity.F": "Warning", // PEP8 Naming convention "python.linting.flake8CategorySeverity.N": "Warning", + // PYI + "python.linting.flake8CategorySeverity.Y": "Warning", // PyRight obsoletes mypy "python.linting.mypyEnabled": false, // Is already wrapped by Flake8, prospector and pylama diff --git a/pyproject.toml b/pyproject.toml index fcd43d26..b6203e6b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -16,17 +16,21 @@ aggressive = 3 pythonPlatform = "Windows" typeCheckingMode = "strict" # Extra strict -reportPropertyTypeMismatch=true -reportUninitializedInstanceVariable=true -reportCallInDefaultInitializer=true -reportImplicitStringConcatenation=true +reportImplicitStringConcatenation="error" +reportCallInDefaultInitializer="error" +reportMissingSuperCall="none" # False positives on base classes +reportPropertyTypeMismatch="error" +reportUninitializedInstanceVariable="error" +reportUnnecessaryTypeIgnoreComment="error" +reportUnusedCallResult="none" ignore = [ # Auto generated "src/gen/", # We expect stub files to be incomplete or contain useless statements "typings/", ] -reportMissingTypeStubs = "information" +# Type stubs may not be completable +reportMissingTypeStubs = "warning" # False positives with TYPE_CHECKING reportImportCycles = "information" # False positives with PyQt .connect. pylint(no-member) works instead @@ -116,3 +120,7 @@ disable = [ [tool.pylint.TYPECHECK] generated-members = "cv2" + +[tool.isort] +line_length = 120 +combine_as_imports = true diff --git a/scripts/requirements.txt b/scripts/requirements.txt index 0dafddd0..8e05c0a2 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -29,8 +29,8 @@ bandit flake8 flake8-pyi flake8-quotes -pylint -pywin32-stubs +pylint>=2.13 +git+https://github.com/Avasam/pywin32-stubs.git#egg=pywin32-stubs # https://github.com/kaluluosi/pywin32-stubs/pull/4 simplejson types-simplejson>=3.17.2 types-requests diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 53be2fe0..f72b0eaf 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -7,35 +7,35 @@ # - Externals # - Internals from __future__ import annotations -from collections.abc import Callable -from types import FunctionType, TracebackType -from typing import Optional -import sys -import os import ctypes +import os import signal +import sys import traceback +from collections.abc import Callable from time import time +from types import FunctionType, TracebackType +from typing import Optional import certifi import cv2 from PyQt6 import QtCore, QtGui, QtTest from PyQt6.QtWidgets import QApplication, QFileDialog, QMainWindow, QMessageBox, QWidget from win32 import win32gui -from AutoSplitImage import COMPARISON_RESIZE, AutoSplitImage, ImageType import error_messages import user_profile from AutoControlledWorker import AutoControlledWorker +from AutoSplitImage import COMPARISON_RESIZE, AutoSplitImage, ImageType from capture_windows import capture_region, set_ui_image from gen import about, design, settings, update_checker -from hotkeys import send_command, after_setting_hotkey -from menu_bar import get_default_settings_from_ui, open_about, VERSION, open_settings, view_help, check_for_updates, \ - open_update_checker -from screen_region import select_region, select_window, align_region, validate_before_parsing -from user_profile import DEFAULT_PROFILE, FROZEN +from hotkeys import after_setting_hotkey, send_command +from menu_bar import (VERSION, check_for_updates, get_default_settings_from_ui, open_about, open_settings, + open_update_checker, view_help) +from screen_region import align_region, select_region, select_window, validate_before_parsing from split_parser import BELOW_FLAG, DUMMY_FLAG, PAUSE_FLAG, parse_and_validate_images +from user_profile import DEFAULT_PROFILE, FROZEN CREATE_NEW_ISSUE_MESSAGE = ( "Please create a New Issue at " @@ -59,7 +59,7 @@ def excepthook(exception_type: type[BaseException], exception: BaseException, _t return excepthook -class AutoSplit(QMainWindow, design.Ui_MainWindow): +class AutoSplit(QMainWindow, design.Ui_main_window): myappid = f"Toufool.AutoSplit.v{VERSION}" ctypes.windll.shell32.SetCurrentProcessExplicitAppUserModelID(myappid) @@ -220,7 +220,7 @@ def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-man self.show() - # Needs to be after Ui_MainWindow.show() to be shown overtop + # Needs to be after Ui_main_window.show() to be shown overtop if self.action_check_for_updates_on_open.isChecked(): check_for_updates(self, check_on_open=True) @@ -758,8 +758,7 @@ def __get_capture_for_comparison(self): if capture is None: # Try to recover by using the window name self.live_image.setText("Trying to recover window...") - # https://github.com/kaluluosi/pywin32-stubs/issues/7 - hwnd = win32gui.FindWindow(None, self.settings_dict["captured_window_title"]) # type: ignore + hwnd = win32gui.FindWindow(None, self.settings_dict["captured_window_title"]) # Don't fallback to desktop if hwnd: self.hwnd = hwnd diff --git a/src/capture_windows.py b/src/capture_windows.py index d2ff8b49..de68ad32 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -45,8 +45,7 @@ def capture_region(hwnd: int, selection: Region, print_window: bool): # If the window closes while it's being manipulated, it could cause a crash try: window_dc: int = win32gui.GetWindowDC(hwnd) - # https://github.com/kaluluosi/pywin32-stubs/issues/6 - dc_object: PyCDC = win32ui.CreateDCFromHandle(window_dc) # type: ignore + dc_object: PyCDC = win32ui.CreateDCFromHandle(window_dc) # Causes a 10-15x performance drop. But allows recording hardware accelerated windows if print_window: diff --git a/src/menu_bar.py b/src/menu_bar.py index 22c16caf..6402ffe2 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -38,7 +38,7 @@ def open_about(autosplit: AutoSplit): class __UpdateCheckerWidget(QtWidgets.QWidget, update_checker.Ui_UpdateChecker): - def __init__(self, latest_version: str, design_window: design.Ui_MainWindow, check_on_open: bool = False): + def __init__(self, latest_version: str, design_window: design.Ui_main_window, check_on_open: bool = False): super().__init__() self.setupUi(self) self.current_version_number_label.setText(VERSION) diff --git a/typings/PyInstaller/utils/hooks/__init__.pyi b/typings/PyInstaller/utils/hooks/__init__.pyi index ba3aef20..af43cf89 100644 --- a/typings/PyInstaller/utils/hooks/__init__.pyi +++ b/typings/PyInstaller/utils/hooks/__init__.pyi @@ -1,8 +1,7 @@ -""" # noqa: Y021 +""" # noqa: Y021 This type stub file was generated by pyright. """ -from typing import Any, Literal, Optional, Union -from collections.abc import Callable +from typing import Any, Callable, Literal, Optional, Union logger = ... PY_IGNORE_EXTENSIONS: set @@ -85,7 +84,11 @@ def is_module_or_submodule(name, mod_or_submod): ... +<< << << < HEAD PY_DYLIB_PATTERNS = ... +== == == = +PY_DYLIB_PATTERNS: str +>>>>>> > 8885768 (Massively sped up Flake tests) def collect_dynamic_libs(package: str, destdir: Optional[str] = ...) -> list[tuple[str, str]]: diff --git a/typings/imagehash/__init__.pyi b/typings/imagehash/__init__.pyi index 91a1d2d7..5e7ee80c 100644 --- a/typings/imagehash/__init__.pyi +++ b/typings/imagehash/__init__.pyi @@ -1,9 +1,10 @@ -""" # noqa: Y021 +""" # noqa: Y021 This type stub file was generated by pyright. https://github.com/JohannesBuchner/imagehash/issues/151 """ -from __future__ import absolute_import, division, print_function, annotations +from __future__ import absolute_import, annotations, division, print_function + from PIL import Image __version__: str diff --git a/typings/keyboard/__init__.pyi b/typings/keyboard/__init__.pyi index a454d39e..2ca50a5a 100644 --- a/typings/keyboard/__init__.pyi +++ b/typings/keyboard/__init__.pyi @@ -1,28 +1,14 @@ -""" # noqa: Y021 +""" # noqa: Y021 This type stub file was generated by pyright. """ from __future__ import print_function as _print_function -from typing import Any, Optional, Union + from collections.abc import Callable from threading import Lock as _Lock -from typing_extensions import TypeAlias - -from ._keyboard_event import KEY_DOWN, KEY_UP, KeyboardEvent -from ._generic import GenericListener as _GenericListener -from ._canonical_names import all_modifiers, normalize_name, sided_modifiers -__all__ = ["all_modifiers", - "normalize_name", - "sided_modifiers", - "KEY_DOWN", - "KEY_UP", - "KeyboardEvent", - "KEY_DOWN", - "KEY_UP", - "KeyboardEvent", - "_GenericListener", - "all_modifiers", - "normalize_name", - "sided_modifiers"] +from typing import Any, Optional, Union + +from keyboard._generic import GenericListener as _GenericListener +from keyboard._keyboard_event import KEY_DOWN, KEY_UP, KeyboardEvent try: # Python2 @@ -33,12 +19,11 @@ except NameError: import queue as _queue from threading import Event as _UninterruptibleEvent - -Callback: TypeAlias = Callable[[KeyboardEvent], None] +Callback = Callable[[KeyboardEvent], None] version: str -_is_str: Callable[[Any], bool] -_is_number: Callable[[Any], bool] +_is_str = Callable[[Any], bool] +_is_number = Callable[[Any], bool] _is_list: Callable[[Any], bool] @@ -65,7 +50,36 @@ _logically_pressed_keys: dict class _KeyboardListener(_GenericListener): - transition_table = ... + transition_table = { + ('free', KEY_UP, 'modifier'): (False, True, 'free'), # noqa: Y020 + ('free', KEY_DOWN, 'modifier'): (False, False, 'pending'), # noqa: Y020 + ('pending', KEY_UP, 'modifier'): (True, True, 'free'), # noqa: Y020 + ('pending', KEY_DOWN, 'modifier'): (False, True, 'allowed'), # noqa: Y020 + ('suppressed', KEY_UP, 'modifier'): (False, False, 'free'), # noqa: Y020 + ('suppressed', KEY_DOWN, 'modifier'): (False, False, 'suppressed'), # noqa: Y020 + ('allowed', KEY_UP, 'modifier'): (False, True, 'free'), # noqa: Y020 + ('allowed', KEY_DOWN, 'modifier'): (False, True, 'allowed'), # noqa: Y020 + + ('free', KEY_UP, 'hotkey'): (False, None, 'free'), # noqa: Y020 + ('free', KEY_DOWN, 'hotkey'): (False, None, 'free'), # noqa: Y020 + ('pending', KEY_UP, 'hotkey'): (False, None, 'suppressed'), # noqa: Y020 + ('pending', KEY_DOWN, 'hotkey'): (False, None, 'suppressed'), # noqa: Y020 + ('suppressed', KEY_UP, 'hotkey'): (False, None, 'suppressed'), # noqa: Y020 + ('suppressed', KEY_DOWN, 'hotkey'): (False, None, 'suppressed'), # noqa: Y020 + ('allowed', KEY_UP, 'hotkey'): (False, None, 'allowed'), # noqa: Y020 + ('allowed', KEY_DOWN, 'hotkey'): (False, None, 'allowed'), # noqa: Y020 + + ('free', KEY_UP, 'other'): (False, True, 'free'), # noqa: Y020 + ('free', KEY_DOWN, 'other'): (False, True, 'free'), # noqa: Y020 + ('pending', KEY_UP, 'other'): (True, True, 'allowed'), # noqa: Y020 + ('pending', KEY_DOWN, 'other'): (True, True, 'allowed'), # noqa: Y020 + # Necessary when hotkeys are removed after beign triggered, such as + # TestKeyboard.test_add_hotkey_multistep_suppress_modifier. + ('suppressed', KEY_UP, 'other'): (False, False, 'allowed'), # noqa: Y020 + ('suppressed', KEY_DOWN, 'other'): (True, True, 'allowed'), # noqa: Y020 + ('allowed', KEY_UP, 'other'): (False, True, 'allowed'), # noqa: Y020 + ('allowed', KEY_DOWN, 'other'): (False, True, 'allowed'), # noqa: Y020 + } def init(self) -> None: ... @@ -183,7 +197,7 @@ _hotkeys: dict def add_hotkey( hotkey, - callback: Callable, + callback: Callback, args=..., suppress=..., timeout=..., @@ -199,17 +213,17 @@ def remove_hotkey(hotkey_or_callback) -> None: ... -unregister_hotkey = ... -clear_hotkey = ... +unregister_hotkey = remove_hotkey +clear_hotkey = remove_hotkey def unhook_all_hotkeys() -> None: ... -unregister_all_hotkeys = ... -remove_all_hotkeys = ... -clear_all_hotkeys = ... +unregister_all_hotkeys = unhook_all_hotkeys +remove_all_hotkeys = unhook_all_hotkeys +clear_all_hotkeys = unhook_all_hotkeys def remap_hotkey(src, dst, suppress=..., trigger_on_release=...) -> Callable[[], None]: @@ -266,11 +280,11 @@ def start_recording(recorded_events_queue=...) -> tuple[_queue.Queue, Callable[[ ... -def stop_recording() -> list[Any]: +def stop_recording() -> list: ... -def record(until=..., suppress=..., trigger_on_release=...) -> list[Any]: +def record(until=..., suppress=..., trigger_on_release=...) -> list: ... @@ -296,12 +310,7 @@ def remove_word_listener(word_or_handler) -> None: ... -def add_abbreviation( - source_text, - replacement_text, - match_suffix=..., - timeout=... -) -> Callable[[], None]: +def add_abbreviation(source_text, replacement_text, match_suffix=..., timeout=...) -> Callable[[], None]: ... diff --git a/typings/keyboard/_keyboard_event.pyi b/typings/keyboard/_keyboard_event.pyi index 28401869..2aede451 100644 --- a/typings/keyboard/_keyboard_event.pyi +++ b/typings/keyboard/_keyboard_event.pyi @@ -1,9 +1,13 @@ -""" # noqa: Y021 +""" # noqa: Y021 This type stub file was generated by pyright. """ from __future__ import annotations + from typing import Literal, Optional +KEY_DOWN: Literal["down"] +KEY_UP: Literal["up"] + class KeyboardEvent: event_type: Optional[Literal['down', 'up']] = ... @@ -14,15 +18,15 @@ class KeyboardEvent: modifiers: Optional[tuple] = ... is_keypad: Optional[bool] = ... - def __init__(self, - event_type: event_type, - scan_code, - name: name = ..., - time: time = ..., - device: device = ..., - modifiers: modifiers = ..., - is_keypad: is_keypad = ... - ) -> None: + def __init__( + self, + event_type: Optional[Literal['down', 'up']], + scan_code: Optional[int], + name: Optional[str] = ..., + time: Optional[float] = ..., + device: Optional = ..., + modifiers: Optional[tuple] = ..., + is_keypad: Optional[bool] = ...) -> None: ... def to_json(self, ensure_ascii: bool = ...) -> str: diff --git a/typings/pyautogui/__init__.pyi b/typings/pyautogui/__init__.pyi index c5382357..9bb8bd99 100644 --- a/typings/pyautogui/__init__.pyi +++ b/typings/pyautogui/__init__.pyi @@ -1,14 +1,14 @@ -""" # noqa: Y021 +"""# noqa: Y021 This type stub file was generated by pyright. """ - from __future__ import absolute_import, division, print_function + +import collections import sys -import datetime -from collections.abc import Callable +from collections.abc import Callable, Sequence from contextlib import contextmanager -from typing import Union, Literal -from typing_extensions import TypeAlias +from datetime import datetime +from typing import Literal, Union __version__: str @@ -25,16 +25,10 @@ class ImageNotFoundException(PyAutoGUIException): ... -if sys.version_info[0] == 2 or sys.version_info[0:2] in ((3, 1), (3, 2)): # noqa: Y003,Y006 - # Python 2 and 3.1 and 3.2 uses collections.Sequence - import collections - - collectionsSequence: TypeAlias = collections.Sequence +if sys.version_info[0] == 2 or sys.version_info[0: 2] in ((3, 1), (3, 2)): # noqa: Y003 + collectionsSequence = collections.Sequence else: - # Python 3.3+ uses collections.abc.Sequence - import collections.abc - - collectionsSequence: TypeAlias = collections.abc.Sequence # type: ignore + collectionsSequence = Sequence def raisePyAutoGUIImageNotFoundException(wrappedFunction) -> Callable: @@ -73,7 +67,7 @@ Point = ... Size = ... -def getPointOnLine(x1, y1, x2, y2, n) -> tuple: +def getPointOnLine(x1: int, y1: int, x2: int, y2: int, n: float) -> tuple[int, int]: ... @@ -93,21 +87,14 @@ def onScreen(x, y=...) -> bool: ... -def _genericPyAutoGUIChecks(wrappedFunction): - ... - - -@_genericPyAutoGUIChecks def mouseDown(x=..., y=..., button=..., duration=..., tween=..., logScreenshot=..., _pause=...) -> None: ... -@_genericPyAutoGUIChecks def mouseUp(x=..., y=..., button=..., duration=..., tween=..., logScreenshot=..., _pause=...) -> None: ... -@_genericPyAutoGUIChecks def click( x=..., y=..., @@ -121,52 +108,42 @@ def click( ... -@_genericPyAutoGUIChecks def leftClick(x=..., y=..., interval=..., duration=..., tween=..., logScreenshot=..., _pause=...) -> None: ... -@_genericPyAutoGUIChecks def rightClick(x=..., y=..., interval=..., duration=..., tween=..., logScreenshot=..., _pause=...) -> None: ... -@_genericPyAutoGUIChecks def middleClick(x=..., y=..., interval=..., duration=..., tween=..., logScreenshot=..., _pause=...) -> None: ... -@_genericPyAutoGUIChecks def doubleClick(x=..., y=..., interval=..., button=..., duration=..., tween=..., logScreenshot=..., _pause=...) -> None: ... -@_genericPyAutoGUIChecks def tripleClick(x=..., y=..., interval=..., button=..., duration=..., tween=..., logScreenshot=..., _pause=...) -> None: ... -@_genericPyAutoGUIChecks def scroll(clicks, x=..., y=..., logScreenshot=..., _pause=...) -> None: ... -@_genericPyAutoGUIChecks def hscroll(clicks, x=..., y=..., logScreenshot=..., _pause=...) -> None: ... -@_genericPyAutoGUIChecks def vscroll(clicks, x=..., y=..., logScreenshot=..., _pause=...) -> None: ... -@_genericPyAutoGUIChecks def moveTo(x=..., y=..., duration=..., tween=..., logScreenshot=..., _pause=...) -> None: ... -@_genericPyAutoGUIChecks def moveRel(xOffset=..., yOffset=..., duration=..., tween=..., logScreenshot=..., _pause=...) -> None: ... @@ -174,12 +151,10 @@ def moveRel(xOffset=..., yOffset=..., duration=..., tween=..., logScreenshot=... move = ... -@_genericPyAutoGUIChecks def dragTo(x=..., y=..., duration=..., tween=..., button=..., logScreenshot=..., _pause=..., mouseDownUp=...) -> None: ... -@_genericPyAutoGUIChecks def dragRel( xOffset=..., yOffset=..., @@ -199,28 +174,23 @@ def isValidKey(key) -> bool: ... -@_genericPyAutoGUIChecks def keyDown(key, logScreenshot=..., _pause=...) -> None: ... -@_genericPyAutoGUIChecks def keyUp(key, logScreenshot=..., _pause=...) -> None: ... -@_genericPyAutoGUIChecks def press(keys, presses=..., interval=..., logScreenshot=..., _pause=...): ... @contextmanager -@_genericPyAutoGUIChecks def hold(keys, logScreenshot=..., _pause=...): ... -@_genericPyAutoGUIChecks def typewrite(message, interval=..., logScreenshot=..., _pause=...) -> None: ... @@ -228,7 +198,6 @@ def typewrite(message, interval=..., logScreenshot=..., _pause=...) -> None: write = ... -@_genericPyAutoGUIChecks def hotkey(*args: str, **kwargs: Union[int, bool, None]) -> None: ... diff --git a/typings/win32-stubs/win32gui.pyi b/typings/win32-stubs/win32gui.pyi deleted file mode 100644 index 1d07ecb4..00000000 --- a/typings/win32-stubs/win32gui.pyi +++ /dev/null @@ -1,6952 +0,0 @@ -__all__ = [ - 'EnumFontFamilies', - 'set_logger', - 'LOGFONT', - 'CreateFontIndirect', - 'GetObject', - 'GetObjectType', - 'PyGetMemory', - 'PyGetString', - 'PySetString', - 'PySetMemory', - 'PyGetArraySignedLong', - 'PyGetBufferAddressAndLen', - 'FlashWindow', - 'FlashWindowEx', - 'GetWindowLong', - 'GetClassLong', - 'SetWindowLong', - 'CallWindowProc', - 'SendMessage', - 'SendMessageTimeout', - 'PostMessage', - 'PostThreadMessage', - 'ReplyMessage', - 'RegisterWindowMessage', - 'DefWindowProc', - 'EnumWindows', - 'EnumThreadWindows', - 'EnumChildWindows', - 'DialogBox', - 'DialogBoxParam', - 'DialogBoxIndirect', - 'DialogBoxIndirectParam', - 'CreateDialogIndirect', - 'DialogBoxIndirectParam', - 'EndDialog', - 'GetDlgItem', - 'GetDlgItemInt', - 'SetDlgItemInt', - 'GetDlgCtrlID', - 'GetDlgItemText', - 'SetDlgItemText', - 'GetNextDlgTabItem', - 'GetNextDlgGroupItem', - 'SetWindowText', - 'GetWindowText', - 'InitCommonControls', - 'InitCommonControlsEx', - 'LoadCursor', - 'SetCursor', - 'GetCursor', - 'GetCursorInfo', - 'CreateAcceleratorTable', - 'DestroyAccleratorTable', - 'LoadMenu', - 'DestroyMenu', - 'SetMenu', - 'GetMenu', - 'LoadIcon', - 'CopyIcon', - 'DrawIcon', - 'DrawIconEx', - 'CreateIconIndirect', - 'CreateIconFromResource', - 'LoadImage', - 'DeleteObject', - 'BitBlt', - 'StretchBlt', - 'PatBlt', - 'SetStretchBltMode', - 'GetStretchBltMode', - 'TransparentBlt', - 'MaskBlt', - 'AlphaBlend', - 'ImageList_Add', - 'ImageList_Create', - 'ImageList_Destroy', - 'ImageList_Draw', - 'ImageList_DrawEx', - 'ImageList_GetIcon', - 'ImageList_GetImageCount', - 'ImageList_LoadImage', - 'ImageList_LoadBitmap', - 'ImageList_Remove', - 'ImageList_Replace', - 'ImageList_ReplaceIcon', - 'ImageList_SetBkColor', - 'ImageList_SetOverlayImage', - 'MessageBox', - 'MessageBeep', - 'CreateWindow', - 'DestroyWindow', - 'EnableWindow', - 'FindWindow', - 'FindWindowEx', - 'DragAcceptFiles', - 'DragDetect', - 'SetDoubleClickTime', - 'GetDoubleClickTime', - 'HideCaret', - 'SetCaretPos', - 'GetCaretPos', - 'ShowCaret', - 'ShowWindow', - 'IsWindowVisible', - 'IsWindowEnabled', - 'SetFocus', - 'GetFocus', - 'UpdateWindow', - 'BringWindowToTop', - 'SetActiveWindow', - 'GetActiveWindow', - 'SetForegroundWindow', - 'GetForegroundWindow', - 'GetClientRect', - 'GetDC', - 'SaveDC', - 'RestoreDC', - 'DeleteDC', - 'CreateCompatibleDC', - 'CreateCompatibleBitmap', - 'CreateBitmap', - 'SelectObject', - 'GetCurrentObject', - 'GetWindowRect', - 'GetStockObject', - 'PostQuitMessage', - 'WaitMessage', - 'SetWindowPos', - 'GetWindowPlacement', - 'SetWindowPlacement', - 'RegisterClass', - 'UnregisterClass', - 'PumpMessages', - 'PumpWaitingMessages', - 'GetMessage', - 'TranslateMessage', - 'DispatchMessage', - 'TranslateAccelerator', - 'PeekMessage', - 'Shell_NotifyIcon', - 'GetSystemMenu', - 'DrawMenuBar', - 'MoveWindow', - 'CloseWindow', - 'DeleteMenu', - 'RemoveMenu', - 'CreateMenu', - 'CreatePopupMenu', - 'TrackPopupMenu', - 'CommDlgExtendedError', - 'ExtractIcon', - 'ExtractIconEx', - 'DestroyIcon', - 'GetIconInfo', - 'ScreenToClient', - 'ClientToScreen', - 'PaintDesktop', - 'RedrawWindow', - 'GetTextExtentPoint32', - 'GetTextMetrics', - 'GetTextCharacterExtra', - 'SetTextCharacterExtra', - 'GetTextAlign', - 'SetTextAlign', - 'GetTextFace', - 'GetMapMode', - 'SetMapMode', - 'GetGraphicsMode', - 'SetGraphicsMode', - 'GetLayout', - 'SetLayout', - 'GetPolyFillMode', - 'SetPolyFillMode', - 'GetWorldTransform', - 'SetWorldTransform', - 'ModifyWorldTransform', - 'CombineTransform', - 'GetWindowOrgEx', - 'SetWindowOrgEx', - 'GetViewportOrgEx', - 'SetViewportOrgEx', - 'GetWindowExtEx', - 'SetWindowExtEx', - 'GetViewportExtEx', - 'SetViewportExtEx', - 'GradientFill', - 'GetOpenFileName', - 'InsertMenuItem', - 'SetMenuItemInfo', - 'GetMenuItemInfo', - 'GetMenuItemCount', - 'GetMenuItemRect', - 'GetMenuState', - 'SetMenuDefaultItem', - 'GetMenuDefaultItem', - 'AppendMenu', - 'InsertMenu', - 'EnableMenuItem', - 'CheckMenuItem', - 'GetSubMenu', - 'ModifyMenu', - 'GetMenuItemID', - 'SetMenuItemBitmaps', - 'CheckMenuRadioItem', - 'SetMenuInfo', - 'GetMenuInfo', - 'DrawFocusRect', - 'DrawText', - 'LineTo', - 'Ellipse', - 'Pie', - 'Arc', - 'ArcTo', - 'AngleArc', - 'Chord', - 'ExtFloodFill', - 'SetPixel', - 'GetPixel', - 'GetROP2', - 'SetROP2', - 'SetPixelV', - 'MoveToEx', - 'GetCurrentPositionEx', - 'GetArcDirection', - 'SetArcDirection', - 'Polygon', - 'Polyline', - 'PolylineTo', - 'PolyBezier', - 'PolyBezierTo', - 'PlgBlt', - 'CreatePolygonRgn', - 'ExtTextOut', - 'GetTextColor', - 'SetTextColor', - 'GetBkMode', - 'SetBkMode', - 'GetBkColor', - 'SetBkColor', - 'DrawEdge', - 'FillRect', - 'FillRgn', - 'PaintRgn', - 'FrameRgn', - 'InvertRgn', - 'EqualRgn', - 'PtInRegion', - 'PtInRect', - 'RectInRegion', - 'SetRectRgn', - 'CombineRgn', - 'DrawAnimatedRects', - 'CreateSolidBrush', - 'CreatePatternBrush', - 'CreateHatchBrush', - 'CreatePen', - 'GetSysColor', - 'GetSysColorBrush', - 'InvalidateRect', - 'FrameRect', - 'InvertRect', - 'WindowFromDC', - 'GetUpdateRgn', - 'GetWindowRgn', - 'SetWindowRgn', - 'GetWindowRgnBox', - 'ValidateRgn', - 'InvalidateRgn', - 'GetRgnBox', - 'OffsetRgn', - 'Rectangle', - 'RoundRect', - 'BeginPaint', - 'EndPaint', - 'BeginPath', - 'EndPath', - 'AbortPath', - 'CloseFigure', - 'FlattenPath', - 'FillPath', - 'WidenPath', - 'StrokePath', - 'StrokeAndFillPath', - 'GetMiterLimit', - 'SetMiterLimit', - 'PathToRegion', - 'GetPath', - 'CreateRoundRectRgn', - 'CreateRectRgnIndirect', - 'CreateEllipticRgnIndirect', - 'CreateWindowEx', - 'GetParent', - 'SetParent', - 'GetCursorPos', - 'GetDesktopWindow', - 'GetWindow', - 'GetWindowDC', - 'IsIconic', - 'IsWindow', - 'IsChild', - 'ReleaseCapture', - 'GetCapture', - 'SetCapture', - '_TrackMouseEvent', - 'ReleaseDC', - 'CreateCaret', - 'DestroyCaret', - 'ScrollWindowEx', - 'SetScrollInfo', - 'GetScrollInfo', - 'GetClassName', - 'WindowFromPoint', - 'ChildWindowFromPoint', - 'ChildWindowFromPoint', - 'ListView_SortItems', - 'ListView_SortItemsEx', - 'CreateDC', - 'GetSaveFileNameW', - 'GetOpenFileNameW', - 'SystemParametersInfo', - 'SetLayeredWindowAttributes', - 'GetLayeredWindowAttributes', - 'UpdateLayeredWindow', - 'AnimateWindow', - 'CreateBrushIndirect', - 'ExtCreatePen', - 'DrawTextW', - 'EnumPropsEx', - 'RegisterDeviceNotification', - 'UnregisterDeviceNotification', - 'RegisterHotKey', - 'CLR_NONE', - 'ILC_COLOR', - 'ILC_COLOR16', - 'ILC_COLOR24', - 'ILC_COLOR32', - 'ILC_COLOR4', - 'ILC_COLOR8', - 'ILC_COLORDDB', - 'ILC_MASK', - 'ILD_BLEND', - 'ILD_BLEND25', - 'ILD_BLEND50', - 'ILD_FOCUS', - 'ILD_MASK', - 'ILD_NORMAL', - 'ILD_SELECTED', - 'ILD_TRANSPARENT', - 'IMAGE_BITMAP', - 'IMAGE_CURSOR', - 'IMAGE_ICON', - 'LR_CREATEDIBSECTION', - 'LR_DEFAULTCOLOR', - 'LR_DEFAULTSIZE', - 'LR_LOADFROMFILE', - 'LR_LOADMAP3DCOLORS', - 'LR_LOADTRANSPARENT', - 'LR_MONOCHROME', - 'LR_SHARED', - 'LR_VGACOLOR', - 'NIF_ICON', - 'NIF_INFO', - 'NIF_MESSAGE', - 'NIF_STATE', - 'NIF_TIP', - 'NIIF_ERROR', - 'NIIF_ICON_MASK', - 'NIIF_INFO', - 'NIIF_NONE', - 'NIIF_NOSOUND', - 'NIIF_WARNING', - 'NIM_ADD', - 'NIM_DELETE', - 'NIM_MODIFY', - 'NIM_SETFOCUS', - 'NIM_SETVERSION', - 'TPM_BOTTOMALIGN', - 'TPM_CENTERALIGN', - 'TPM_LEFTALIGN', - 'TPM_LEFTBUTTON', - 'TPM_NONOTIFY', - 'TPM_RETURNCMD', - 'TPM_RIGHTALIGN', - 'TPM_RIGHTBUTTON', - 'TPM_TOPALIGN', - 'TPM_VCENTERALIGN'] -import typing -import win32typing -"""""" - - -def EnumFontFamilies( - hdc: 'int', - Family: 'typing.Union[str]', - EnumFontFamProc: 'typing.Any', - Param: 'typing.Any') -> 'typing.Any': - """ - Enumerates the available font families. - -Args: - - hdc(int):Handle to a device context for which to enumerate available fonts - Family(typing.Union[str]):Family of fonts to enumerate. If none, first member of each font family will be returned. - EnumFontFamProc(typing.Any):The Python function called with each font family. This function is called with 4 arguments. - Param(typing.Any):An arbitrary object to be passed to the callback functionCommentsThe parameters that the callback function will receive are as follows:PyLOGFONT - contains the font parameters None - Placeholder for a TEXTMETRIC structure, not supported yet int - Font type, combination of DEVICE_FONTTYPE, RASTER_FONTTYPE, TRUETYPE_FONTTYPE object - The Param originally passed in to EnumFontFamilies - -Returns: - - typing.Any - - """ - ... - - -def set_logger(logger: 'typing.Any') -> 'None': - """ - Sets a logger object for exceptions and error information - -Args: - - logger(typing.Any):A logger object, generally from the standard logger package.CommentsOnce a logger has been set for the module, unhandled exceptions, such as from a window's WNDPROC, will be written (via logger.exception()) to the log instead of to stderr. Note that using this with the Python 2.3 logging package will prevent the traceback from being written to the log. However, it is possible to use the Python 2.4 logging package directly with Python 2.3 - -Returns: - - None - - """ - ... - - -def LOGFONT() -> 'win32typing.PyLOGFONT': - """ - Creates a LOGFONT object. - -Args: - - - -Returns: - - win32typing.PyLOGFONT - - """ - ... - - -def CreateFontIndirect(lplf: 'win32typing.PyLOGFONT') -> 'typing.Any': - """ - function creates a logical font that has the specified characteristics. - -The font can subsequently be selected as the current font for any device context. - -Args: - - lplf(win32typing.PyLOGFONT):A LOGFONT object as returned by win32gui::LOGFONT - -Returns: - - typing.Any - - """ - ... - - -def GetObject(handle: 'int') -> 'typing.Any': - """ - Returns a struct containing the parameters used to create a GDI object - -Args: - - handle(int):Handle to the object.CommentsThe result depends on the type of the handle.Object type as determined by win32gui::GetObjectTypeReturned objectOBJ_FONTPyLOGFONTOBJ_BITMAPPyBITMAPOBJ_PENDict representing a LOGPEN struct - -Returns: - - typing.Any - - """ - ... - - -def GetObjectType(h: 'int') -> 'typing.Any': - """ - Returns the type (OBJ_* constant) of a GDI handle - -Args: - - h(int):A handle to a GDI object - -Returns: - - typing.Any - - """ - ... - - -def PyGetMemory(addr: 'typing.Any', _len: 'typing.Any') -> 'typing.Any': - """ - Returns a buffer object from and address and length - -Args: - - addr(typing.Any):Address of the memory to reference. - _len(typing.Any):Number of bytes to return.CommentsIf zero is passed a ValueError will be raised. - -Returns: - - typing.Any - - """ - ... - - -def PyGetString(addr: 'typing.Any', _len: 'typing.Any') -> 'str': - """ - Returns a string from an address. - -Args: - - addr(typing.Any):Address of the memory to reference - _len(typing.Any):Number of characters to read. If not specified, the string must be NULL terminated.Return ValueIf win32gui.UNICODE is True, this will return a unicode object. - -Returns: - - str:Number of characters to read. If not specified, the - -string must be NULL terminated.Return ValueIf win32gui.UNICODE is True, this will return a unicode object. - - - """ - ... - - -def PySetString(addr: 'typing.Any', String: 'typing.Any', maxLen: 'typing.Any') -> 'typing.Any': - """ - None - -Args: - - addr(typing.Any):Address of the memory to reference - String(typing.Any):The string to copy - maxLen(typing.Any):Maximum number of chars to copy (optional) - -Returns: - - typing.Any - - """ - ... - - -def PySetMemory(addr: 'typing.Any', String: 'typing.Any') -> 'typing.Any': - """ - Copies bytes to an address. - -Args: - - addr(typing.Any):Address of the memory to reference - String(typing.Any):The string to copy - -Returns: - - typing.Any - - """ - ... - - -def PyGetArraySignedLong(array: 'typing.Any', index: 'typing.Any') -> 'typing.Any': - """ - Returns a signed long from an array object at specified index - -Args: - - array(typing.Any):array object to use - index(typing.Any):index of offset - -Returns: - - typing.Any - - """ - ... - - -def PyGetBufferAddressAndLen(obj: 'typing.Any') -> 'typing.Any': - """ - Returns a buffer object address and len - -Args: - - obj(typing.Any):the buffer object - -Returns: - - typing.Any - - """ - ... - - -def FlashWindow(hwnd: 'int', bInvert: 'typing.Any') -> 'typing.Any': - """ - The FlashWindow function flashes the specified window one time. It does not change the active state of the window. - -Args: - - hwnd(int):Handle to a window - bInvert(typing.Any):Indicates if window should toggle between active and inactive - -Returns: - - typing.Any - - """ - ... - - -def FlashWindowEx(hwnd: 'int', dwFlags: 'typing.Any', uCount: 'typing.Any', dwTimeout: 'typing.Any') -> 'typing.Any': - """ - The FlashWindowEx function flashes the specified window a specified number of times. - -Args: - - hwnd(int):Handle to a window - dwFlags(typing.Any):Combination of win32con.FLASHW_* flags - uCount(typing.Any):Nbr of times to flash - dwTimeout(typing.Any):Elapsed time between flashes, in milliseconds - -Returns: - - typing.Any - - """ - ... - - -def GetWindowLong(hwnd: 'int', index: 'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hwnd(typing.Any): - index(typing.Any): - -Returns: - - typing.Any - - """ - ... - - -def GetClassLong(hwnd: 'int', index: 'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hwnd(typing.Any): - index(typing.Any): - -Returns: - - typing.Any - - """ - ... - - -def SetWindowLong(hwnd: 'int', index: 'typing.Any', value: 'typing.Any') -> 'typing.Any': - """ - Places a long value at the specified offset into the extra window memory of the given window. - -Args: - - hwnd(int):The handle to the window - index(typing.Any):The index of the item to set. - value(typing.Any):The value to set.CommentsThis function calls the SetWindowLongPtr Api functionIf index is GWLP_WNDPROC, then the value parameter must be a callable object (or a dictionary) to use as the new window procedure. - -Returns: - - typing.Any - - """ - ... - - -def CallWindowProc( - wndproc: 'typing.Any', - hwnd: 'int', - msg: 'typing.Any', - wparam: 'typing.Union[typing.Any]', - lparam: 'typing.Union[typing.Any]') -> 'typing.Any': - """ - None - -Args: - - wndproc(typing.Any):The wndproc to call - this is generally the return value of SetWindowLong(GWL_WNDPROC) - hwnd(int):Handle to the window - msg(typing.Any):A window message - wparam(typing.Union[typing.Any]):Type is dependent on the message - lparam(typing.Union[typing.Any]):Type is dependent on the message - -Returns: - - typing.Any - - """ - ... - - -def SendMessage( - hwnd: 'int', - message: 'typing.Any', - wparam: 'typing.Union[typing.Any]' = None, - lparam: 'typing.Union[typing.Any]' = None) -> 'typing.Any': - """ - Sends a message to the window. - -Args: - - hwnd(typing.Any):The handle to the Window - message(typing.Any):The ID of the message to post - wparam(typing.Union[typing.Any]):Type depends on the message - lparam(typing.Union[typing.Any]):Type depends on the message - -Returns: - - typing.Any - - """ - ... - - -def SendMessageTimeout( - hwnd: 'int', - message: 'typing.Any', - wparam: 'typing.Any', - lparam: 'typing.Any', - flags: 'typing.Any', - timeout: 'typing.Any') -> 'tuple[typing.Any, typing.Any]': - """ - Sends a message to the window. - -Args: - - hwnd(typing.Any):The handle to the Window - message(typing.Any):The ID of the message to post - wparam(typing.Any):An integer whose value depends on the message - lparam(typing.Any):An integer whose value depends on the message - flags(typing.Any):Send options - timeout(typing.Any):Timeout duration in milliseconds.Return ValueThe result is the result of the SendMessageTimeout call, plus the last 'result' param. If the timeout period expires, a pywintypes.error exception will be thrown, with zero as the error code. See the Microsoft documentation for more information. - -Returns: - - tuple[typing.Any, typing.Any]:Timeout duration in milliseconds.Return ValueThe result is the result of the SendMessageTimeout call, plus the last 'result' param. - -If the timeout period expires, a pywintypes.error exception will be thrown, - -with zero as the error code. See the Microsoft documentation for more information. - - - """ - ... - - -def PostMessage(hwnd: 'int', message: 'typing.Any', wparam: 'typing.Any' = 0, lparam: 'typing.Any' = 0) -> 'None': - """ - None - -Args: - - hwnd(typing.Any):The handle to the Window - message(typing.Any):The ID of the message to post - wparam(typing.Any):An integer whose value depends on the message - lparam(typing.Any):An integer whose value depends on the message - -Returns: - - None - - """ - ... - - -def PostThreadMessage( - threadId: 'typing.Any', - message: 'typing.Any', - wparam: 'typing.Any', - lparam: 'typing.Any') -> 'None': - """ - None - -Args: - - threadId(typing.Any):The ID of the thread to post the message to. - message(typing.Any):The ID of the message to post - wparam(typing.Any):An integer whose value depends on the message - lparam(typing.Any):An integer whose value depends on the message - -Returns: - - None - - """ - ... - - -def ReplyMessage(result: 'typing.Any') -> 'typing.Any': - """ - Used to reply to a message sent through the SendMessage function without returning control to the function that called SendMessage. - -Args: - - result(typing.Any):Specifies the result of the message processing. The possible values are based on the message sent. - -Returns: - - typing.Any - - """ - ... - - -def RegisterWindowMessage(name: 'typing.Union[str, typing.Any]') -> 'typing.Any': - """ - Defines a new window message that is guaranteed to be unique throughout the system. The message value can be used when sending or posting messages. - -Args: - - name(typing.Union[str, typing.Any]):The string - -Returns: - - typing.Any - - """ - ... - - -def DefWindowProc(hwnd: 'int', message: 'typing.Any', wparam: 'typing.Any', lparam: 'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hwnd(typing.Any):The handle to the Window - message(typing.Any):The ID of the message to send - wparam(typing.Any):An integer whose value depends on the message - lparam(typing.Any):An integer whose value depends on the message - -Returns: - - typing.Any - - """ - ... - - -def EnumWindows(callback: 'typing.Any', extra: 'typing.Any') -> 'None': - """ - Enumerates all top-level windows on the screen by passing the handle to each window, in turn, to an application-defined callback function. - -Args: - - callback(typing.Any):A Python function to be used as the callback. Function can return False to stop enumeration, or raise an exception. - extra(typing.Any):Any python object - this is passed to the callback function as the second param (first is the hwnd). - -Returns: - - None - - """ - ... - - -def EnumThreadWindows(dwThreadId: 'typing.Any', callback: 'typing.Any', extra: 'typing.Any') -> 'None': - """ - Enumerates all top-level windows associated with a thread on the screen by passing the handle to each window, in turn, to an application-defined callback function. EnumThreadWindows continues until the last top-level window associated with the thread is enumerated or the callback function returns FALSE - -Args: - - dwThreadId(typing.Any):The id of the thread for which the windows need to be enumerated. - callback(typing.Any):A Python function to be used as the callback. - extra(typing.Any):Any python object - this is passed to the callback function as the second param (first is the hwnd). - -Returns: - - None - - """ - ... - - -def EnumChildWindows(hwnd: 'int', callback: 'typing.Any', extra: 'typing.Any') -> 'None': - """ - Enumerates the child windows that belong to the specified parent window by passing the handle to each child window, in turn, to an application-defined callback function. EnumChildWindows continues until the last child window is enumerated or the callback function returns FALSE. - -Args: - - hwnd(int):The handle to the window to enumerate. - callback(typing.Any):A Python function to be used as the callback. - extra(typing.Any):Any python object - this is passed to the callback function as the second param (first is the hwnd). - -Returns: - - None - - """ - ... - - -def DialogBox( - hInstance: 'int', - TemplateName: 'win32typing.PyResourceId', - hWndParent: 'int', - DialogFunc: 'typing.Any', - InitParam: 'typing.Any' = 0) -> 'typing.Any': - """ - Creates a modal dialog box. - -Args: - - hInstance(int):Handle to module that contains the dialog template - TemplateName(win32typing.PyResourceId):Name or resource id of the dialog resource - hWndParent(int):Handle to dialog's parent window - DialogFunc(typing.Any):Dialog box procedure to process messages - InitParam(typing.Any):Initialization data to be passed to above procedure during WM_INITDIALOG processing - -Returns: - - typing.Any - - """ - ... - - -def DialogBoxParam() -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - ... - - -def DialogBoxIndirect( - hInstance: 'int', - controlList: 'win32typing.PyDialogTemplate', - hWndParent: 'int', - DialogFunc: 'typing.Any', - InitParam: 'typing.Any' = 0) -> 'typing.Any': - """ - None - -Args: - - hInstance(int):Handle to module creating the dialog box - controlList(win32typing.PyDialogTemplate):Sequence of items defining the dialog box and subcontrols - hWndParent(int):Handle to dialog's parent window - DialogFunc(typing.Any):Dialog box procedure to process messages - InitParam(typing.Any):Initialization data to be passed to above procedure during WM_INITDIALOG processing - -Returns: - - typing.Any - - """ - ... - - -def DialogBoxIndirectParam() -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - ... - - -def CreateDialogIndirect( - hInstance: 'int', - controlList: 'win32typing.PyDialogTemplate', - hWndParent: 'int', - DialogFunc: 'typing.Any', - InitParam: 'typing.Any' = 0) -> 'typing.Any': - """ - None - -Args: - - hInstance(int):Handle to module creating the dialog box - controlList(win32typing.PyDialogTemplate):Sequence containing a PyDLGTEMPLATE, followed by variable number of PyDLGITEMTEMPLATEs - hWndParent(int):Handle to dialog's parent window - DialogFunc(typing.Any):Dialog box procedure to process messages - InitParam(typing.Any):Initialization data to be passed to above procedure during WM_INITDIALOG processing - -Returns: - - typing.Any - - """ - ... - - -def EndDialog(hwnd: 'int', result: 'typing.Any') -> 'None': - """ - Ends a dialog box. - -Args: - - hwnd(typing.Any):Handle to the window. - result(typing.Any):result - -Returns: - - None - - """ - ... - - -def GetDlgItem(hDlg: 'int', IDDlgItem: 'typing.Any') -> 'typing.Any': - """ - Retrieves the handle to a control in the specified dialog box. - -Args: - - hDlg(int):Handle to a dialog window - IDDlgItem(typing.Any):Identifier of one of the dialog's controls - -Returns: - - typing.Any - - """ - ... - - -def GetDlgItemInt(hDlg: 'int', IDDlgItem: 'typing.Any', Signed: 'typing.Any') -> 'None': - """ - Returns the integer value of a dialog control - -Args: - - hDlg(int):Handle to a dialog window - IDDlgItem(typing.Any):Identifier of one of the dialog's controls - Signed(typing.Any):Indicates whether control value should be interpreted as signed - -Returns: - - None - - """ - ... - - -def SetDlgItemInt(hDlg: 'int', IDDlgItem: 'typing.Any', Value: 'typing.Any', Signed: 'typing.Any') -> 'None': - """ - Places an integer value in a dialog control - -Args: - - hDlg(int):Handle to a dialog window - IDDlgItem(typing.Any):Identifier of one of the dialog's controls - Value(typing.Any):Value to placed in the control - Signed(typing.Any):Indicates if the input value is signed - -Returns: - - None - - """ - ... - - -def GetDlgCtrlID(hwnd: 'int') -> 'typing.Any': - """ - Retrieves the identifier of the specified control. - -Args: - - hwnd(typing.Any):The handle to the control - -Returns: - - typing.Any - - """ - ... - - -def GetDlgItemText(hDlg: 'int', IDDlgItem: 'typing.Any') -> 'str': - """ - Returns the text of a dialog control - -Args: - - hDlg(int):Handle to a dialog window - IDDlgItem(typing.Any):The Id of a control within the dialog - -Returns: - - str - - """ - ... - - -def SetDlgItemText(hDlg: 'int', IDDlgItem: 'typing.Any', String: 'typing.Union[typing.Any]') -> 'None': - """ - Sets the text for a window or control - -Args: - - hDlg(int):Handle to a dialog window - IDDlgItem(typing.Any):The Id of a control within the dialog - String(typing.Union[typing.Any]):The text to put in the control - -Returns: - - None - - """ - ... - - -def GetNextDlgTabItem(hDlg: 'typing.Any', hCtl: 'typing.Any', bPrevious: 'typing.Any') -> 'typing.Any': - """ - Retrieves a handle to the first control that has the WS_TABSTOP style that precedes (or follows) the specified control. - -Args: - - hDlg(typing.Any):handle to dialog box - hCtl(typing.Any):handle to known control - bPrevious(typing.Any):direction flag - -Returns: - - typing.Any - - """ - ... - - -def GetNextDlgGroupItem(hDlg: 'typing.Any', hCtl: 'typing.Any', bPrevious: 'typing.Any') -> 'typing.Any': - """ - Retrieves a handle to the first control in a group of controls that precedes (or follows) the specified control in a dialog box. - -Args: - - hDlg(typing.Any):handle to dialog box - hCtl(typing.Any):handle to known control - bPrevious(typing.Any):direction flag - -Returns: - - typing.Any - - """ - ... - - -def SetWindowText() -> 'None': - """ - Sets the window text. - -Args: - - - -Returns: - - None - - """ - ... - - -def GetWindowText(hwnd: 'int') -> 'str': - """ - Get the window text. - -Args: - - hwnd(int):The handle to the windowCommentsNote that previous versions of PyWin32 returned a (empty) Unicode object when the string was empty, or an MBCS encoded string value otherwise. A String is now returned in all cases. - -Returns: - - str - - """ - ... - - -def InitCommonControls() -> 'None': - """ - Initializes the common controls. - -Args: - - - -Returns: - - None - - """ - ... - - -def InitCommonControlsEx(flag: 'typing.Any') -> 'None': - """ - Initializes specific common controls. - -Args: - - flag(typing.Any):One of the ICC_ constants - -Returns: - - None - - """ - ... - - -def LoadCursor(hinstance: 'typing.Any', resid: 'typing.Any') -> 'typing.Any': - """ - Loads a cursor. - -Args: - - hinstance(typing.Any):The module to load from - resid(typing.Any):The resource ID - -Returns: - - typing.Any - - """ - ... - - -def SetCursor(hcursor: 'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hcursor(typing.Any): - -Returns: - - typing.Any - - """ - ... - - -def GetCursor() -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - ... - - -def GetCursorInfo() -> 'tuple[int, int, int, int]': - """ - Retrieves information about the global cursor. - -Args: - - - -Returns: - - tuple[int, int, int, int] - - """ - ... - - -def CreateAcceleratorTable(accels: 'tuple[tuple[typing.Any, typing.Any, typing.Any], ...]') -> 'typing.Any': - """ - Creates an accelerator table - -Args: - - accels(tuple[tuple[typing.Any, typing.Any, typing.Any], ...]):A sequence of (fVirt, key, cmd), as per the Win32 ACCEL structure. - -Returns: - - typing.Any - - """ - ... - - -def DestroyAccleratorTable(haccel: 'typing.Any') -> 'None': - """ - Destroys an accelerator table - -Args: - - haccel(typing.Any): - -Returns: - - None - - """ - ... - - -def LoadMenu(hinstance: 'typing.Any', resource_id: 'typing.Union[str, typing.Any]') -> 'typing.Any': - """ - Loads a menu - -Args: - - hinstance(typing.Any): - resource_id(typing.Union[str, typing.Any]): - -Returns: - - typing.Any - - """ - ... - - -def DestroyMenu() -> 'None': - """ - Destroys a previously loaded menu. - -Args: - - - -Returns: - - None - - """ - ... - - -def SetMenu(hwnd: 'int', hmenu: 'typing.Any') -> 'None': - """ - Sets the menu for the specified window. - -Args: - - hwnd(typing.Any): - hmenu(typing.Any): - -Returns: - - None - - """ - ... - - -def GetMenu() -> 'None': - """ - Gets the menu for the specified window. - -Args: - - - -Returns: - - None - - """ - ... - - -def LoadIcon(hinstance: 'typing.Any', resource_id: 'typing.Union[str, typing.Any]') -> 'typing.Any': - """ - Loads an icon - -Args: - - hinstance(typing.Any): - resource_id(typing.Union[str, typing.Any]): - -Returns: - - typing.Any - - """ - ... - - -def CopyIcon(hicon: 'typing.Any') -> 'typing.Any': - """ - Copies an icon - -Args: - - hicon(typing.Any):Existing icon - -Returns: - - typing.Any - - """ - ... - - -def DrawIcon(hDC: 'typing.Any', X: 'typing.Any', Y: 'typing.Any', hicon: 'typing.Any') -> 'None': - """ - None - -Args: - - hDC(typing.Any):handle to DC - X(typing.Any):x-coordinate of upper-left corner - Y(typing.Any):y-coordinate of upper-left corner - hicon(typing.Any):handle to icon - -Returns: - - None - - """ - ... - - -def DrawIconEx( - hDC: 'typing.Any', - xLeft: 'typing.Any', - yTop: 'typing.Any', - hIcon: 'typing.Any', - cxWidth: 'typing.Any', - cyWidth: 'typing.Any', - istepIfAniCur: 'typing.Any', - hbrFlickerFreeDraw: 'win32typing.PyGdiHANDLE', - diFlags: 'typing.Any') -> 'None': - """ - Draws an icon or cursor into the specified device context, - -performing the specified raster operations, and stretching or compressing the - -icon or cursor as specified. - -Args: - - hDC(typing.Any):handle to device context - xLeft(typing.Any):x-coord of upper left corner - yTop(typing.Any):y-coord of upper left corner - hIcon(typing.Any):handle to icon - cxWidth(typing.Any):icon width - cyWidth(typing.Any):icon height - istepIfAniCur(typing.Any):frame index, animated cursor - hbrFlickerFreeDraw(win32typing.PyGdiHANDLE):handle to background brush, can be None - diFlags(typing.Any):icon-drawing flags (win32con.DI_*) - -Returns: - - None - - """ - ... - - -def CreateIconIndirect(iconinfo: 'win32typing.PyICONINFO') -> 'typing.Any': - """ - Creates an icon or cursor from an ICONINFO structure. - -Args: - - iconinfo(win32typing.PyICONINFO):Tuple defining the icon parameters - -Returns: - - typing.Any - - """ - ... - - -def CreateIconFromResource(bits: 'str', fIcon: 'typing.Any', ver: 'typing.Any' = 0x00030000) -> 'int': - """ - Creates an icon or cursor from resource bits describing the icon. - -Args: - - bits(str):The bits - fIcon(typing.Any):True if an icon, False if a cursor. - ver(typing.Any):Specifies the version number of the icon or cursor format for the resource bits pointed to by the presbits parameter. This parameter can be 0x00030000. - -Returns: - - int - - """ - ... - - -def LoadImage( - hinst: 'typing.Any', - name: 'typing.Union[str, typing.Any]', - _type: 'typing.Any', - cxDesired: 'typing.Any', - cyDesired: 'typing.Any', - fuLoad: 'typing.Any') -> 'typing.Any': - """ - Loads a bitmap, cursor or icon - -Args: - - hinst(typing.Any):Handle to an instance of the module that contains the image to be loaded. To load an OEM image, set this parameter to zero. - name(typing.Union[str, typing.Any]):Specifies the image to load. If the hInst parameter is non-zero and the fuLoad parameter omits LR_LOADFROMFILE, name specifies the image resource in the hInst module. If the image resource is to be loaded by name, the name parameter is a string that contains the name of the image resource. - _type(typing.Any):Specifies the type of image to be loaded. - cxDesired(typing.Any):Specifies the width, in pixels, of the icon or cursor. If this parameter is zero and the fuLoad parameter is LR_DEFAULTSIZE, the function uses the SM_CXICON or SM_CXCURSOR system metric value to set the width. If this parameter is zero and LR_DEFAULTSIZE is not used, the function uses the actual resource width. - cyDesired(typing.Any):Specifies the height, in pixels, of the icon or cursor. If this parameter is zero and the fuLoad parameter is LR_DEFAULTSIZE, the function uses the SM_CYICON or SM_CYCURSOR system metric value to set the height. If this parameter is zero and LR_DEFAULTSIZE is not used, the function uses the actual resource height. - fuLoad(typing.Any): - -Returns: - - typing.Any - - """ - ... - - -def DeleteObject(handle: 'win32typing.PyGdiHANDLE') -> 'None': - """ - Deletes a logical pen, brush, font, bitmap, region, or palette, freeing all system resources associated with the object. After the object is deleted, the specified handle is no longer valid. - -Args: - - handle(win32typing.PyGdiHANDLE):handle to the object to delete. - -Returns: - - None - - """ - ... - - -def BitBlt( - hdcDest: 'typing.Any', - x: 'typing.Any', - y: 'typing.Any', - width: 'typing.Any', - height: 'typing.Any', - hdcSrc: 'typing.Any', - nXSrc: 'typing.Any', - nYSrc: 'typing.Any', - dwRop: 'typing.Any') -> 'None': - """ - Performs a bit-block transfer of the color data corresponding - -to a rectangle of pixels from the specified source device context into a - -destination device context. - -Args: - - hdcDest(typing.Any):handle to destination DC - x(typing.Any):x-coord of destination upper-left corner - y(typing.Any):y-coord of destination upper-left corner - width(typing.Any):width of destination rectangle - height(typing.Any):height of destination rectangle - hdcSrc(typing.Any):handle to source DC - nXSrc(typing.Any):x-coordinate of source upper-left corner - nYSrc(typing.Any):y-coordinate of source upper-left corner - dwRop(typing.Any):raster operation code - -Returns: - - None - - """ - ... - - -def StretchBlt( - hdcDest: 'typing.Any', - x: 'typing.Any', - y: 'typing.Any', - width: 'typing.Any', - height: 'typing.Any', - hdcSrc: 'typing.Any', - nXSrc: 'typing.Any', - nYSrc: 'typing.Any', - nWidthSrc: 'typing.Any', - nHeightSrc: 'typing.Any', - dwRop: 'typing.Any') -> 'None': - """ - Copies a bitmap from a source rectangle into a destination - -rectangle, stretching or compressing the bitmap to fit the dimensions of the - -destination rectangle, if necessary - -Args: - - hdcDest(typing.Any):handle to destination DC - x(typing.Any):x-coord of destination upper-left corner - y(typing.Any):y-coord of destination upper-left corner - width(typing.Any):width of destination rectangle - height(typing.Any):height of destination rectangle - hdcSrc(typing.Any):handle to source DC - nXSrc(typing.Any):x-coord of source upper-left corner - nYSrc(typing.Any):y-coord of source upper-left corner - nWidthSrc(typing.Any):width of source rectangle - nHeightSrc(typing.Any):height of source rectangle - dwRop(typing.Any):raster operation code - -Returns: - - None - - """ - ... - - -def PatBlt( - hdc: 'int', - XLeft: 'typing.Any', - YLeft: 'typing.Any', - Width: 'typing.Any', - Height: 'typing.Any', - Rop: 'typing.Any') -> 'None': - """ - Paints a rectangle by combining the current brush with existing colors - -Args: - - hdc(int):Handle to a device context - XLeft(typing.Any):Horizontal pos - YLeft(typing.Any):Vertical pos - Width(typing.Any):Width of rectangular area - Height(typing.Any):Height of rectangular area - Rop(typing.Any):Raster operation, one of PATCOPY,PATINVERT,DSTINVERT,BLACKNESS,WHITENESS - -Returns: - - None - - """ - ... - - -def SetStretchBltMode(hdc: 'int', StretchMode: 'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hdc(int):Handle to a device context - StretchMode(typing.Any):One of BLACKONWHITE,COLORONCOLOR,HALFTONE,STRETCH_ANDSCANS,STRETCH_DELETESCANS,STRETCH_HALFTONE,STRETCH_ORSCANS, or WHITEONBLACK (from win32con)Return ValueIf the function succeeds, the return value is the previous stretching mode. If the function fails, the return value is zero. - -Returns: - - typing.Any:One of BLACKONWHITE,COLORONCOLOR,HALFTONE,STRETCH_ANDSCANS,STRETCH_DELETESCANS,STRETCH_HALFTONE,STRETCH_ORSCANS, or WHITEONBLACK (from win32con)Return ValueIf the function succeeds, the return value is the previous stretching mode. - -If the function fails, the return value is zero. - - - """ - ... - - -def GetStretchBltMode(hdc: 'int') -> 'typing.Any': - """ - None - -Args: - - hdc(int):Handle to a device contextReturn ValueReturns one of BLACKONWHITE,COLORONCOLOR,HALFTONE,STRETCH_ANDSCANS,STRETCH_DELETESCANS,STRETCH_HALFTONE,STRETCH_ORSCANS,WHITEONBLACK, or 0 on error. - -Returns: - - typing.Any:Handle to a device contextReturn ValueReturns one of BLACKONWHITE,COLORONCOLOR,HALFTONE,STRETCH_ANDSCANS,STRETCH_DELETESCANS,STRETCH_HALFTONE,STRETCH_ORSCANS,WHITEONBLACK, or 0 on error. - - - """ - ... - - -def TransparentBlt( - Dest: 'int', - XOriginDest: 'typing.Any', - YOriginDest: 'typing.Any', - WidthDest: 'typing.Any', - HeightDest: 'typing.Any', - Src: 'int', - XOriginSrc: 'typing.Any', - YOriginSrc: 'typing.Any', - WidthSrc: 'typing.Any', - HeightSrc: 'typing.Any', - Transparent: 'typing.Any') -> 'None': - """ - Transfers color from one DC to another, with one color treated as transparent - -Args: - - Dest(int):Destination device context handle - XOriginDest(typing.Any):X pos of dest rect - YOriginDest(typing.Any):Y pos of dest rect - WidthDest(typing.Any):Width of dest rect - HeightDest(typing.Any):Height of dest rect - Src(int):Source DC handle - XOriginSrc(typing.Any):X pos of src rect - YOriginSrc(typing.Any):Y pos of src rect - WidthSrc(typing.Any):Width of src rect - HeightSrc(typing.Any):Height of src rect - Transparent(typing.Any):RGB color value that will be transparent - -Returns: - - None - - """ - ... - - -def MaskBlt( - Dest: 'int', - XDest: 'typing.Any', - YDest: 'typing.Any', - Width: 'typing.Any', - Height: 'typing.Any', - Src: 'int', - XSrc: 'typing.Any', - YSrc: 'typing.Any', - Mask: 'win32typing.PyGdiHANDLE', - xMask: 'typing.Any', - yMask: 'typing.Any', - Rop: 'typing.Any') -> 'None': - """ - Combines the color data for the source and destination - -bitmaps using the specified mask and raster operation. - -Args: - - Dest(int):Destination device context handle - XDest(typing.Any):X pos of dest rect - YDest(typing.Any):Y pos of dest rect - Width(typing.Any):Width of rect to be copied - Height(typing.Any):Height of rect to be copied - Src(int):Source DC handle - XSrc(typing.Any):X pos of src rect - YSrc(typing.Any):Y pos of src rect - Mask(win32typing.PyGdiHANDLE):Handle to monochrome bitmap used to mask color - xMask(typing.Any):X pos in mask - yMask(typing.Any):Y pos in mask - Rop(typing.Any):Foreground and background raster operations. See MSDN docs for how to construct this value.CommentsThis function is not supported on Win9x.Win32 API References - -Returns: - - None - - """ - ... - - -def AlphaBlend( - Dest: 'int', - XOriginDest: 'typing.Any', - YOriginDest: 'typing.Any', - WidthDest: 'typing.Any', - HeightDest: 'typing.Any', - Src: 'int', - XOriginSrc: 'typing.Any', - YOriginSrc: 'typing.Any', - WidthSrc: 'typing.Any', - HeightSrc: 'typing.Any', - blendFunction: 'win32typing.PyBLENDFUNCTION') -> 'None': - """ - Transfers color information using alpha blending - -Args: - - Dest(int):Destination device context handle - XOriginDest(typing.Any):X pos of dest rect - YOriginDest(typing.Any):Y pos of dest rect - WidthDest(typing.Any):Width of dest rect - HeightDest(typing.Any):Height of dest rect - Src(int):Source DC handle - XOriginSrc(typing.Any):X pos of src rect - YOriginSrc(typing.Any):Y pos of src rect - WidthSrc(typing.Any):Width of src rect - HeightSrc(typing.Any):Height of src rect - blendFunction(win32typing.PyBLENDFUNCTION):Alpha blending parameters - -Returns: - - None - - """ - ... - - -def ImageList_Add(himl: 'typing.Any', hbmImage: 'win32typing.PyGdiHANDLE', - hbmMask: 'win32typing.PyGdiHANDLE') -> 'typing.Any': - """ - Adds an image or images to an image list. - -Args: - - himl(typing.Any):Handle to the image list. - hbmImage(win32typing.PyGdiHANDLE):Handle to the bitmap that contains the image or images. The number of images is inferred from the width of the bitmap. - hbmMask(win32typing.PyGdiHANDLE):Handle to the bitmap that contains the mask. If no mask is used with the image list, this parameter is ignoredReturn ValueReturns the index of the first new image if successful, or -1 otherwise. - -Returns: - - typing.Any:Handle to the bitmap that contains the mask. If no mask is used with the image list, this parameter is ignoredReturn ValueReturns the index of the first new image if successful, or -1 otherwise. - - - """ - ... - - -def ImageList_Create() -> 'typing.Any': - """ - Create an image list - -Args: - - - -Returns: - - typing.Any - - """ - ... - - -def ImageList_Destroy() -> 'typing.Any': - """ - Destroy an imagelist - -Args: - - - -Returns: - - typing.Any - - """ - ... - - -def ImageList_Draw() -> 'typing.Any': - """ - Draw an image on an HDC - -Args: - - - -Returns: - - typing.Any - - """ - ... - - -def ImageList_DrawEx() -> 'typing.Any': - """ - Draw an image on an HDC - -Args: - - - -Returns: - - typing.Any - - """ - ... - - -def ImageList_GetIcon() -> 'typing.Any': - """ - Extract an icon from an imagelist - -Args: - - - -Returns: - - typing.Any - - """ - ... - - -def ImageList_GetImageCount() -> 'typing.Any': - """ - Return count of images in imagelist - -Args: - - - -Returns: - - typing.Any - - """ - ... - - -def ImageList_LoadImage() -> 'typing.Any': - """ - Loads bitmaps, cursors or icons, creates imagelist - -Args: - - - -Returns: - - typing.Any - - """ - ... - - -def ImageList_LoadBitmap() -> 'typing.Any': - """ - Creates an image list from the specified bitmap resource. - -Args: - - - -Returns: - - typing.Any - - """ - ... - - -def ImageList_Remove() -> 'typing.Any': - """ - Remove an image from an imagelist - -Args: - - - -Returns: - - typing.Any - - """ - ... - - -def ImageList_Replace() -> 'typing.Any': - """ - Replace an image in an imagelist with a bitmap image - -Args: - - - -Returns: - - typing.Any - - """ - ... - - -def ImageList_ReplaceIcon() -> 'typing.Any': - """ - Replace an image in an imagelist with an icon image - -Args: - - - -Returns: - - typing.Any - - """ - ... - - -def ImageList_SetBkColor() -> 'typing.Any': - """ - Set the background color for the imagelist - -Args: - - - -Returns: - - typing.Any - - """ - ... - - -def ImageList_SetOverlayImage(hImageList: 'typing.Any', iImage: 'typing.Any', iOverlay: 'typing.Any') -> 'None': - """ - Adds a specified image to the list of images to be used as overlay masks. An image list can have up to four overlay masks in version 4.70 and earlier and up to 15 in version 4.71. The function assigns an overlay mask index to the specified image. - -Args: - - hImageList(typing.Any): - iImage(typing.Any): - iOverlay(typing.Any): - -Returns: - - None - - """ - ... - - -def MessageBox( - parent: 'typing.Any', - text: 'typing.Union[str]', - caption: 'typing.Union[str]', - flags: 'typing.Any') -> 'typing.Any': - """ - Displays a message box - -Args: - - parent(typing.Any):The parent window - text(typing.Union[str]):The text for the message box - caption(typing.Union[str]):The caption for the message box - flags(typing.Any): - -Returns: - - typing.Any - - """ - ... - - -def MessageBeep(_type: 'typing.Any') -> 'None': - """ - Plays a waveform sound. - -Args: - - _type(typing.Any):The type of the beep - -Returns: - - None - - """ - ... - - -def CreateWindow( - className: 'typing.Union[str, typing.Any]', - windowTitle: 'str', - style: 'typing.Any', - x: 'typing.Any', - y: 'typing.Any', - width: 'typing.Any', - height: 'typing.Any', - parent: 'typing.Any', - menu: 'typing.Any', - hinstance: 'typing.Any', - reserved: 'typing.Any') -> 'typing.Any': - """ - Creates a new window. - -Args: - - className(typing.Union[str, typing.Any]): - windowTitle(str): - style(typing.Any):The style for the window. - x(typing.Any): - y(typing.Any): - width(typing.Any): - height(typing.Any): - parent(typing.Any):Handle to the parent window. - menu(typing.Any):Handle to the menu to use for this window. - hinstance(typing.Any): - reserved(typing.Any):Must be None - -Returns: - - typing.Any - - """ - ... - - -def DestroyWindow(hwnd: 'int') -> 'None': - """ - None - -Args: - - hwnd(typing.Any):The handle to the window - -Returns: - - None - - """ - ... - - -def EnableWindow(hWnd: 'int', bEnable: 'typing.Any') -> 'typing.Any': - """ - Enables and disables keyboard and mouse input to a window - -Args: - - hWnd(int):Handle to window - bEnable(typing.Any):True to enable input to the window, False to disable inputReturn ValueReturns True if window was already disabled when call was made, False otherwise - -Returns: - - typing.Any:True to enable input to the window, False to disable inputReturn ValueReturns True if window was already disabled when call was made, False otherwise - - - """ - ... - - -def FindWindow(ClassName: 'win32typing.PyResourceId', WindowName: 'str') -> 'int': - """ - Retrieves a handle to the top-level window whose class name and window name match the specified strings. - -Args: - - ClassName(win32typing.PyResourceId):Name or atom of window class to find, can be None - WindowName(str):Title of window to find, can be None - -Returns: - - int - - """ - ... - - -def FindWindowEx(Parent: 'int', ChildAfter: 'int', ClassName: 'win32typing.PyResourceId', WindowName: 'str') -> 'int': - """ - Retrieves a handle to the top-level window whose class name and window name match the specified strings. - -Args: - - Parent(int):Window whose child windows will be searched. If 0, desktop window is assumed. - ChildAfter(int):Child window after which to search in Z-order, can be 0 to search all - ClassName(win32typing.PyResourceId):Name or atom of window class to find, can be None - WindowName(str):Title of window to find, can be None - -Returns: - - int - - """ - ... - - -def DragAcceptFiles(hwnd: 'int', fAccept: 'typing.Any') -> 'None': - """ - Registers whether a window accepts dropped files. - -Args: - - hwnd(typing.Any):Handle to the Window - fAccept(typing.Any):Value that indicates if the window identified by the hWnd parameter accepts dropped files. This value is True to accept dropped files or False to discontinue accepting dropped files. - -Returns: - - None - - """ - ... - - -def DragDetect(hwnd: 'int', point: 'tuple[typing.Any, typing.Any]') -> 'None': - """ - captures the mouse and tracks its movement until the user releases the left button, presses the ESC key, or moves the mouse outside the drag rectangle around the specified point. - -Args: - - hwnd(typing.Any):Handle to the Window - point(tuple[typing.Any, typing.Any]):Initial position of the mouse, in screen coordinates. The function determines the coordinates of the drag rectangle by using this point.Return ValueIf the user moved the mouse outside of the drag rectangle while holding down the left button , the return value is nonzero. If the user did not move the mouse outside of the drag rectangle while holding down the left button , the return value is zero. - -Returns: - - None:Initial position of the mouse, in screen coordinates. The function determines the coordinates of the drag rectangle by using this point.Return ValueIf the user moved the mouse outside of the drag rectangle while holding down the left button , the return value is nonzero. - -If the user did not move the mouse outside of the drag rectangle while holding down the left button , the return value is zero. - - - """ - ... - - -def SetDoubleClickTime(newVal: 'typing.Any') -> 'None': - """ - None - -Args: - - newVal(typing.Any): - -Returns: - - None - - """ - ... - - -def GetDoubleClickTime() -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - ... - - -def HideCaret(hWnd: 'int') -> 'None': - """ - Hides the caret - -Args: - - hWnd(int):Window that owns the caret, can be 0. - -Returns: - - None - - """ - ... - - -def SetCaretPos(x: 'typing.Any', y: 'typing.Any') -> 'None': - """ - Changes the position of the caret - -Args: - - x(typing.Any):horizontal position - y(typing.Any):vertical position - -Returns: - - None - - """ - ... - - -def GetCaretPos() -> 'tuple[typing.Any, typing.Any]': - """ - Returns the current caret position - -Args: - - - -Returns: - - tuple[typing.Any, typing.Any] - - """ - ... - - -def ShowCaret(hWnd: 'int') -> 'None': - """ - Shows the caret at its current position - -Args: - - hWnd(int):Window that owns the caret, can be 0. - -Returns: - - None - - """ - ... - - -def ShowWindow(hWnd: 'typing.Any', cmdShow: 'typing.Any') -> 'typing.Any': - """ - Shows or hides a window and changes its state - -Args: - - hWnd(typing.Any):The handle to the window - cmdShow(typing.Any):Combination of win32con.SW_* flags - -Returns: - - typing.Any - - """ - ... - - -def IsWindowVisible(hwnd: 'int') -> 'typing.Any': - """ - Indicates if the window has the WS_VISIBLE style. - -Args: - - hwnd(typing.Any):The handle to the window - -Returns: - - typing.Any - - """ - ... - - -def IsWindowEnabled(hwnd: 'int') -> 'typing.Any': - """ - Indicates if the window is enabled. - -Args: - - hwnd(typing.Any):The handle to the window - -Returns: - - typing.Any - - """ - ... - - -def SetFocus(hwnd: 'int') -> 'None': - """ - Sets focus to the specified window. - -Args: - - hwnd(typing.Any):The handle to the window - -Returns: - - None - - """ - ... - - -def GetFocus() -> 'None': - """ - Returns the HWND of the window with focus. - -Args: - - - -Returns: - - None - - """ - ... - - -def UpdateWindow(hwnd: 'int') -> 'None': - """ - None - -Args: - - hwnd(typing.Any):The handle to the window - -Returns: - - None - - """ - ... - - -def BringWindowToTop(hwnd: 'int') -> 'None': - """ - None - -Args: - - hwnd(typing.Any):The handle to the window - -Returns: - - None - - """ - ... - - -def SetActiveWindow(hwnd: 'int') -> 'typing.Any': - """ - None - -Args: - - hwnd(typing.Any):The handle to the window - -Returns: - - typing.Any - - """ - ... - - -def GetActiveWindow() -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - ... - - -def SetForegroundWindow(hwnd: 'int') -> 'typing.Any': - """ - None - -Args: - - hwnd(typing.Any):The handle to the window - -Returns: - - typing.Any - - """ - ... - - -def GetForegroundWindow() -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - ... - - -def GetClientRect(hwnd: 'int') -> 'tuple[int, int, int, int]': - """ - Returns the rectangle of the client area of a window, in client coordinates - -Args: - - hwnd(typing.Any):The handle to the window - -Returns: - - tuple[int, int, int, int] - - """ - ... - - -def GetDC(hwnd: 'int') -> 'typing.Any': - """ - Gets the device context for the window. - -Args: - - hwnd(typing.Any):The handle to the window - -Returns: - - typing.Any - - """ - ... - - -def SaveDC(hdc: 'int') -> 'typing.Any': - """ - Save the state of a device context - -Args: - - hdc(int):Handle to device contextReturn ValueReturns a value identifying the state that can be passed to win32gui::RestoreDC. On error, returns 0. - -Returns: - - typing.Any:Handle to device contextReturn ValueReturns a value identifying the state that can be passed to win32gui::RestoreDC. On error, returns 0. - - - """ - ... - - -def RestoreDC(hdc: 'int', SavedDC: 'typing.Any') -> 'None': - """ - Restores a device context state - -Args: - - hdc(int):Handle to a device context - SavedDC(typing.Any):Identifier of state to be restored, as returned by win32gui::SaveDC. - -Returns: - - None - - """ - ... - - -def DeleteDC(hdc: 'typing.Any') -> 'None': - """ - Deletes a DC - -Args: - - hdc(typing.Any):The source DC - -Returns: - - None - - """ - ... - - -def CreateCompatibleDC(dc: 'typing.Any') -> 'typing.Any': - """ - Creates a memory device context (DC) compatible with the specified device. - -Args: - - dc(typing.Any):handle to DC - -Returns: - - typing.Any - - """ - ... - - -def CreateCompatibleBitmap(hdc: 'typing.Any', width: 'typing.Any', height: 'typing.Any') -> 'win32typing.PyGdiHANDLE': - """ - Creates a bitmap compatible with the device that is associated with the specified device context. - -Args: - - hdc(typing.Any):handle to DC - width(typing.Any):width of bitmap, in pixels - height(typing.Any):height of bitmap, in pixels - -Returns: - - win32typing.PyGdiHANDLE - - """ - ... - - -def CreateBitmap( - width: 'typing.Any', - height: 'typing.Any', - cPlanes: 'typing.Any', - cBitsPerPixel: 'typing.Any', - bitmap_bits: 'typing.Any') -> 'win32typing.PyGdiHANDLE': - """ - Creates a bitmap - -Args: - - width(typing.Any):bitmap width, in pixels - height(typing.Any):bitmap height, in pixels - cPlanes(typing.Any):number of color planes - cBitsPerPixel(typing.Any):number of bits to identify color - bitmap_bits(typing.Any):Must be None - -Returns: - - win32typing.PyGdiHANDLE - - """ - ... - - -def SelectObject(hdc: 'typing.Any', _object: 'typing.Any') -> 'typing.Any': - """ - Selects an object into the specified device context (DC). The new object replaces the previous object of the same type. - -Args: - - hdc(typing.Any):handle to DC - _object(typing.Any):The GDI object - -Returns: - - typing.Any - - """ - ... - - -def GetCurrentObject(hdc: 'int', ObjectType: 'typing.Any') -> 'int': - """ - Retrieves currently selected object from a DC - -Args: - - hdc(int):Handle to a device context - ObjectType(typing.Any):Type of object to retrieve, one of win32con.OBJ_*; - -Returns: - - int - - """ - ... - - -def GetWindowRect(hwnd: 'int') -> 'tuple[int, int, int, int]': - """ - Returns the rectangle for a window in screen coordinates - -Args: - - hwnd(typing.Any):The handle to the window - -Returns: - - tuple[int, int, int, int] - - """ - ... - - -def GetStockObject(Object: 'typing.Any') -> 'int': - """ - Creates a handle to one of the standard system Gdi objects - -Args: - - Object(typing.Any):One of *_BRUSH, *_PEN, *_FONT, or *_PALLETTE constants - -Returns: - - int - - """ - ... - - -def PostQuitMessage(rc: 'typing.Any') -> 'None': - """ - None - -Args: - - rc(typing.Any): - -Returns: - - None - - """ - ... - - -def WaitMessage() -> 'None': - """ - Waits for a message - -Args: - - - -Returns: - - None - - """ - ... - - -def SetWindowPos( - hWnd: 'int', - InsertAfter: 'int', - X: 'typing.Any', - Y: 'typing.Any', - cx: 'typing.Any', - cy: 'typing.Any', - Flags: 'typing.Any') -> 'None': - """ - Sets the position and size of a window - -Args: - - hWnd(int):Handle to the window - InsertAfter(int):Window that hWnd will be placed below. Can be a window handle or one of HWND_BOTTOM,HWND_NOTOPMOST,HWND_TOP, or HWND_TOPMOST - X(typing.Any):New X coord - Y(typing.Any):New Y coord - cx(typing.Any):New width of window - cy(typing.Any):New height of window - Flags(typing.Any):Combination of win32con.SWP_* flags - -Returns: - - None - - """ - ... - - -def GetWindowPlacement() -> 'typing.Any': - """ - Returns placement information about the current window. - -Args: - - - -Returns: - - typing.Any:win32gui.GetWindowPlacement - -tuple = GetWindowPlacement()Returns placement information about the current window. -Return ValueThe result is a tuple of - -(flags, showCmd, (minposX, minposY), (maxposX, maxposY), (normalposX, normalposY)) - - - -Item - - -Description - - - -flagsOne of the WPF_* constants -showCmdCurrent state - one of the SW_* constants. -minposSpecifies the coordinates of the window's upper-left corner when the window is minimized. -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. - - - """ - ... - - -def SetWindowPlacement(hWnd: 'int', placement: 'typing.Any') -> 'None': - """ - Sets the windows placement - -Args: - - hWnd(int):Handle to a window - placement(typing.Any):A tuple representing the WINDOWPLACEMENT structure. - -Returns: - - None - - """ - ... - - -def RegisterClass(wndClass: 'win32typing.PyWNDCLASS') -> 'typing.Any': - """ - Registers a window class. - -Args: - - wndClass(win32typing.PyWNDCLASS):An object describing the window class. - -Returns: - - typing.Any - - """ - ... - - -def UnregisterClass(atom: 'win32typing.PyResourceId', hinst: 'int') -> 'None': - """ - None - -Args: - - atom(win32typing.PyResourceId):The atom or classname identifying the class previously registered. - hinst(int):The handle to the instance unregistering the class, can be None - -Returns: - - None - - """ - ... - - -def PumpMessages() -> 'None': - """ - Runs a message loop until a WM_QUIT message is received. - -Args: - - - -Returns: - - None:win32gui::PumpWaitingMessages -Return ValueReturns exit code from PostQuitMessage when a WM_QUIT message is received - - - """ - ... - - -def PumpWaitingMessages() -> 'typing.Any': - """ - Pumps all waiting messages for the current thread. - -Args: - - - -Returns: - - typing.Any:Search for PeekMessage and DispatchMessage at msdn, google or google groups. -Return ValueReturns non-zero (exit code from PostQuitMessage) if a WM_QUIT message was received, else 0 - - - """ - ... - - -def GetMessage(hwnd: 'int', _min: 'typing.Any', _max: 'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hwnd(typing.Any): - _min(typing.Any): - _max(typing.Any): - -Returns: - - typing.Any - - """ - ... - - -def TranslateMessage(msg: 'typing.Any') -> 'typing.Any': - """ - None - -Args: - - msg(typing.Any): - -Returns: - - typing.Any - - """ - ... - - -def DispatchMessage(msg: 'typing.Any') -> 'typing.Any': - """ - None - -Args: - - msg(typing.Any): - -Returns: - - typing.Any - - """ - ... - - -def TranslateAccelerator(hwnd: 'int', haccel: 'typing.Any', msg: 'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hwnd(typing.Any): - haccel(typing.Any): - msg(typing.Any): - -Returns: - - typing.Any - - """ - ... - - -def PeekMessage( - hwnd: 'int', - filterMin: 'typing.Any', - filterMax: 'typing.Any', - removalOptions: 'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hwnd(typing.Any): - filterMin(typing.Any): - filterMax(typing.Any): - removalOptions(typing.Any): - -Returns: - - typing.Any - - """ - ... - - -def Shell_NotifyIcon(Message: 'typing.Any', nid: 'win32typing.PyNOTIFYICONDATA') -> 'None': - """ - Adds, removes or modifies a taskbar icon. - -Args: - - Message(typing.Any):One of win32gui.NIM_* flags - nid(win32typing.PyNOTIFYICONDATA):Tuple containing NOTIFYICONDATA info - -Returns: - - None - - """ - ... - - -def GetSystemMenu(hwnd: 'int', bRevert: 'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hwnd(typing.Any):The handle to the window - bRevert(typing.Any):Return ValueThe result is a HMENU to the menu. - -Returns: - - typing.Any:Return ValueThe result is a HMENU to the menu. - - - """ - ... - - -def DrawMenuBar(hwnd: 'int') -> 'None': - """ - None - -Args: - - hwnd(typing.Any):The handle to the window - -Returns: - - None - - """ - ... - - -def MoveWindow( - hwnd: 'int', - x: 'typing.Any', - y: 'typing.Any', - width: 'typing.Any', - height: 'typing.Any', - bRepaint: 'typing.Any') -> 'None': - """ - None - -Args: - - hwnd(typing.Any):The handle to the window - x(typing.Any): - y(typing.Any): - width(typing.Any): - height(typing.Any): - bRepaint(typing.Any): - -Returns: - - None - - """ - ... - - -def CloseWindow() -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - ... - - -def DeleteMenu(hmenu: 'typing.Any', position: 'typing.Any', flags: 'typing.Any') -> 'None': - """ - None - -Args: - - hmenu(typing.Any):The handle to the menu - position(typing.Any):The position to delete. - flags(typing.Any): - -Returns: - - None - - """ - ... - - -def RemoveMenu(hmenu: 'typing.Any', position: 'typing.Any', flags: 'typing.Any') -> 'None': - """ - None - -Args: - - hmenu(typing.Any):The handle to the menu - position(typing.Any):The position to delete. - flags(typing.Any): - -Returns: - - None - - """ - ... - - -def CreateMenu() -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any:win32gui.CreateMenu - -int = CreateMenu() -Return ValueThe result is a HMENU to the new menu. - - - """ - ... - - -def CreatePopupMenu() -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any:win32gui.CreatePopupMenu - -int = CreatePopupMenu() -Return ValueThe result is a HMENU to the new menu. - - - """ - ... - - -def TrackPopupMenu( - hmenu: 'typing.Any', - flags: 'typing.Any', - x: 'typing.Any', - y: 'typing.Any', - reserved: 'typing.Any', - hwnd: 'int', - prcRect: 'win32typing.PyRECT') -> 'typing.Any': - """ - Display popup shortcut menu - -Args: - - hmenu(typing.Any):The handle to the menu - flags(typing.Any):flags - x(typing.Any):x pos - y(typing.Any):y pos - reserved(typing.Any):reserved - hwnd(typing.Any):owner window - prcRect(win32typing.PyRECT):Pointer to rec (can be None) - -Returns: - - typing.Any - - """ - ... - - -def CommDlgExtendedError() -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - ... - - -def ExtractIcon(hinstance: 'typing.Any', moduleName: 'typing.Union[str]', index: 'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hinstance(typing.Any): - moduleName(typing.Union[str]): - index(typing.Any):CommentsYou must destroy the icon handle returned by calling the win32gui::DestroyIcon function.Return ValueThe result is a HICON. - -Returns: - - typing.Any:Comments - -You must destroy the icon handle returned by calling the win32gui::DestroyIcon function. -Return ValueThe result is a HICON. - - - """ - ... - - -def ExtractIconEx(moduleName: 'str', index: 'typing.Any', numIcons: 'typing.Any' = 1) -> 'typing.Any': - """ - None - -Args: - - moduleName(str): - index(typing.Any): - numIcons(typing.Any):CommentsYou must destroy each icon handle returned by calling the win32gui::DestroyIcon function.Return ValueIf index==-1, the result is an integer with the number of icons in the file, otherwise it is 2 arrays of icon handles. - -Returns: - - typing.Any: -Comments - -You must destroy each icon handle returned by calling the win32gui::DestroyIcon function. -Return ValueIf index==-1, the result is an integer with the number of icons in - -the file, otherwise it is 2 arrays of icon handles. - - - """ - ... - - -def DestroyIcon(hicon: 'typing.Any') -> 'None': - """ - None - -Args: - - hicon(typing.Any):The icon to destroy. - -Returns: - - None - - """ - ... - - -def GetIconInfo(hicon: 'int') -> 'win32typing.PyICONINFO': - """ - Returns parameters for an icon or cursor - -Args: - - hicon(int):The icon to queryReturn ValueThe result is a tuple of (fIcon, xHotspot, yHotspot, hbmMask, hbmColor) The hbmMask and hbmColor items are bitmaps created for the caller, so must be freed. - -Returns: - - win32typing.PyICONINFO:The icon to queryReturn ValueThe result is a tuple of (fIcon, xHotspot, yHotspot, hbmMask, hbmColor) - -The hbmMask and hbmColor items are bitmaps created for the caller, so must be freed. - - - """ - ... - - -def ScreenToClient(hWnd: 'int', Point: 'tuple[typing.Any, typing.Any]') -> 'tuple[typing.Any, typing.Any]': - """ - Convert screen coordinates to client coords - -Args: - - hWnd(int):Handle to a window - Point(tuple[typing.Any, typing.Any]):Screen coordinates to be converted - -Returns: - - tuple[typing.Any, typing.Any] - - """ - ... - - -def ClientToScreen(hWnd: 'int', Point: 'tuple[typing.Any, typing.Any]') -> 'tuple[typing.Any, typing.Any]': - """ - Convert client coordinates to screen coords - -Args: - - hWnd(int):Handle to a window - Point(tuple[typing.Any, typing.Any]):Client coordinates to be converted - -Returns: - - tuple[typing.Any, typing.Any] - - """ - ... - - -def PaintDesktop(hdc: 'int') -> 'None': - """ - Fills a DC with the destop background - -Args: - - hdc(int):Handle to a device context - -Returns: - - None - - """ - ... - - -def RedrawWindow( - hWnd: 'int', - rcUpdate: 'tuple[int, int, int, int]', - hrgnUpdate: 'win32typing.PyGdiHANDLE', - flags: 'typing.Any') -> 'None': - """ - Causes a portion of a window to be redrawn - -Args: - - hWnd(int):Handle to window to be redrawn - rcUpdate(tuple[int, int, int, int]):Rectangle (left, top, right, bottom) identifying part of window to be redrawn, can be None - hrgnUpdate(win32typing.PyGdiHANDLE):Handle to region to be redrawn, can be None to indicate entire client area - flags(typing.Any):Combination of win32con.RDW_* flags - -Returns: - - None - - """ - ... - - -def GetTextExtentPoint32(hdc: 'int', _str: 'str') -> 'tuple[typing.Any, typing.Any]': - """ - Computes the width and height of the specified string of text. - -Args: - - hdc(int):The device context - _str(str):The string to measure. - -Returns: - - tuple[typing.Any, typing.Any] - - """ - ... - - -def GetTextMetrics() -> 'typing.Any': - """ - Returns info for the font selected into a DC - -Args: - - - -Returns: - - typing.Any - - """ - ... - - -def GetTextCharacterExtra(hdc: 'int') -> 'typing.Any': - """ - Returns the space between characters - -Args: - - hdc(int):Handle to a device context - -Returns: - - typing.Any - - """ - ... - - -def SetTextCharacterExtra(hdc: 'int', CharExtra: 'typing.Any') -> 'typing.Any': - """ - Sets the spacing between characters - -Args: - - hdc(int):Handle to a device context - CharExtra(typing.Any):Space between adjacent chars, in logical unitsReturn ValueReturns the previous spacing - -Returns: - - typing.Any:Space between adjacent chars, in logical unitsReturn ValueReturns the previous spacing - - - """ - ... - - -def GetTextAlign(hdc: 'int') -> 'typing.Any': - """ - Returns horizontal and vertical alignment for text in a device context - -Args: - - hdc(int):Handle to a device contextReturn ValueReturns combination of win32con.TA_* flags - -Returns: - - typing.Any:Handle to a device contextReturn ValueReturns combination of win32con.TA_* flags - - - """ - ... - - -def SetTextAlign(hdc: 'int', Mode: 'typing.Any') -> 'typing.Any': - """ - Sets horizontal and vertical alignment for text in a device context - -Args: - - hdc(int):Handle to a device context - Mode(typing.Any):Combination of win32con.TA_* constantsReturn ValueReturns the previous alignment flags - -Returns: - - typing.Any:Combination of win32con.TA_* constantsReturn ValueReturns the previous alignment flags - - - """ - ... - - -def GetTextFace(hdc: 'int') -> 'str': - """ - Retrieves the name of the font currently selected in a DC - -Args: - - hdc(int):Handle to a device contextCommentsCalls unicode api function (GetTextFaceW) - -Returns: - - str - - """ - ... - - -def GetMapMode(hdc: 'int') -> 'typing.Any': - """ - Returns the method a device context uses to translate logical units to physical units - -Args: - - hdc(int):Handle to a device contextReturn ValueReturns one of win32con.MM_* values - -Returns: - - typing.Any:Handle to a device contextReturn ValueReturns one of win32con.MM_* values - - - """ - ... - - -def SetMapMode(hdc: 'int', MapMode: 'typing.Any') -> 'typing.Any': - """ - Sets the method used for translating logical units to device units - -Args: - - hdc(int):Handle to a device context - MapMode(typing.Any):The new mapping mode (win32con.MM_*)Return ValueReturns the previous mapping mode, one of win32con.MM_* constants - -Returns: - - typing.Any:The new mapping mode (win32con.MM_*)Return ValueReturns the previous mapping mode, one of win32con.MM_* constants - - - """ - ... - - -def GetGraphicsMode(hdc: 'int') -> 'typing.Any': - """ - Determines if advanced GDI features are enabled for a device context - -Args: - - hdc(int):Handle to a device contextReturn ValueReturns GM_COMPATIBLE or GM_ADVANCED - -Returns: - - typing.Any:Handle to a device contextReturn ValueReturns GM_COMPATIBLE or GM_ADVANCED - - - """ - ... - - -def SetGraphicsMode(hdc: 'int', Mode: 'typing.Any') -> 'typing.Any': - """ - Enables or disables advanced graphics features for a DC - -Args: - - hdc(int):Handle to a device context - Mode(typing.Any):GM_COMPATIBLE or GM_ADVANCED (from win32con)Return ValueReturns the previous mode, one of win32con.GM_COMPATIBLE or win32con.GM_ADVANCED - -Returns: - - typing.Any:GM_COMPATIBLE or GM_ADVANCED (from win32con)Return ValueReturns the previous mode, one of win32con.GM_COMPATIBLE or win32con.GM_ADVANCED - - - """ - ... - - -def GetLayout(hdc: 'int') -> 'typing.Any': - """ - Retrieves the layout mode of a device context - -Args: - - hdc(int):Handle to a device contextReturn ValueReturns one of win32con.LAYOUT_* - -Returns: - - typing.Any:Handle to a device contextReturn ValueReturns one of win32con.LAYOUT_* - - - """ - ... - - -def SetLayout(hdc: 'int', Layout: 'typing.Any') -> 'typing.Any': - """ - Sets the layout for a device context - -Args: - - hdc(int):Handle to a device context - Layout(typing.Any):One of win32con.LAYOUT_* constantsReturn ValueReturns the previous layout mode - -Returns: - - typing.Any:One of win32con.LAYOUT_* constantsReturn ValueReturns the previous layout mode - - - """ - ... - - -def GetPolyFillMode(hdc: 'int') -> 'typing.Any': - """ - Returns the polygon filling mode for a device context - -Args: - - hdc(int):Handle to a device contextReturn ValueReturns win32con.ALTERNATE or win32con.WINDING - -Returns: - - typing.Any:Handle to a device contextReturn ValueReturns win32con.ALTERNATE or win32con.WINDING - - - """ - ... - - -def SetPolyFillMode(hdc: 'int', PolyFillMode: 'typing.Any') -> 'typing.Any': - """ - Sets the polygon filling mode for a device context - -Args: - - hdc(int):Handle to a device context - PolyFillMode(typing.Any):One of ALTERNATE or WINDINGReturn ValueReturns the previous mode, one of win32con.ALTERNATE or win32con.WINDING - -Returns: - - typing.Any:One of ALTERNATE or WINDINGReturn ValueReturns the previous mode, one of win32con.ALTERNATE or win32con.WINDING - - - """ - ... - - -def GetWorldTransform(hdc: 'int') -> 'win32typing.PyXFORM': - """ - Retrieves a device context's coordinate space translation matrix - -Args: - - hdc(int):Handle to a device contextCommentsDC's mode must be set to GM_ADVANCED. See win32gui::SetGraphicsMode. - -Returns: - - win32typing.PyXFORM - - """ - ... - - -def SetWorldTransform(hdc: 'int', Xform: 'win32typing.PyXFORM') -> 'None': - """ - Transforms a device context's coordinate space - -Args: - - hdc(int):Handle to a device context - Xform(win32typing.PyXFORM):Matrix defining the transformationCommentsDC's mode must be set to GM_ADVANCED. See win32gui::SetGraphicsMode. - -Returns: - - None - - """ - ... - - -def ModifyWorldTransform(hdc: 'int', Xform: 'win32typing.PyXFORM', Mode: 'typing.Any') -> 'None': - """ - Combines a coordinate tranformation with device context's current transformation - -Args: - - hdc(int):Handle to a device context - Xform(win32typing.PyXFORM):Transformation to be applied. Ignored if Mode is MWT_IDENTITY. - Mode(typing.Any):One of win32con.MWT_* values specifying how transformations will be combinedCommentsDC's mode must be set to GM_ADVANCED. See win32gui::SetGraphicsMode. - -Returns: - - None - - """ - ... - - -def CombineTransform(xform1: 'win32typing.PyXFORM', xform2: 'win32typing.PyXFORM') -> 'win32typing.PyXFORM': - """ - Combines two coordinate space transformations - -Args: - - xform1(win32typing.PyXFORM):First transformation - xform2(win32typing.PyXFORM):Second transformation - -Returns: - - win32typing.PyXFORM - - """ - ... - - -def GetWindowOrgEx(hdc: 'int') -> 'tuple[typing.Any, typing.Any]': - """ - Retrievs the window origin for a DC - -Args: - - hdc(int):Handle to a device context - -Returns: - - tuple[typing.Any, typing.Any] - - """ - ... - - -def SetWindowOrgEx(hdc: 'int', X: 'typing.Any', Y: 'typing.Any') -> 'tuple[typing.Any, typing.Any]': - """ - Changes the window origin for a DC - -Args: - - hdc(int):Handle to a device context - X(typing.Any):New X coord in logical units - Y(typing.Any):New Y coord in logical unitsReturn ValueReturns the previous origin - -Returns: - - tuple[typing.Any, typing.Any]:New Y coord in logical unitsReturn ValueReturns the previous origin - - - """ - ... - - -def GetViewportOrgEx(hdc: 'int') -> 'tuple[typing.Any, typing.Any]': - """ - Retrievs the origin for a DC's viewport - -Args: - - hdc(int):Handle to a device context - -Returns: - - tuple[typing.Any, typing.Any] - - """ - ... - - -def SetViewportOrgEx(hdc: 'int', X: 'typing.Any', Y: 'typing.Any') -> 'tuple[typing.Any, typing.Any]': - """ - Changes the viewport origin for a DC - -Args: - - hdc(int):Handle to a device context - X(typing.Any):New X coord in logical units - Y(typing.Any):New Y coord in logical unitsReturn ValueReturns the previous origin as (x,y) - -Returns: - - tuple[typing.Any, typing.Any]:New Y coord in logical unitsReturn ValueReturns the previous origin as (x,y) - - - """ - ... - - -def GetWindowExtEx(hdc: 'int') -> 'tuple[typing.Any, typing.Any]': - """ - Retrieves the window extents for a DC - -Args: - - hdc(int):Handle to a device contextReturn ValueReturns the extents as (x,y) in logical units - -Returns: - - tuple[typing.Any, typing.Any]:Handle to a device contextReturn ValueReturns the extents as (x,y) in logical units - - - """ - ... - - -def SetWindowExtEx(hdc: 'int', XExtent: 'typing.Any', YExtent: 'typing.Any') -> 'tuple[typing.Any, typing.Any]': - """ - Changes the window extents for a DC - -Args: - - hdc(int):Handle to a device context - XExtent(typing.Any):New X extent in logical units - YExtent(typing.Any):New Y extent in logical unitsReturn ValueReturns the previous extents - -Returns: - - tuple[typing.Any, typing.Any]:New Y extent in logical unitsReturn ValueReturns the previous extents - - - """ - ... - - -def GetViewportExtEx(hdc: 'int') -> 'tuple[typing.Any, typing.Any]': - """ - Retrieves the viewport extents for a DC - -Args: - - hdc(int):Handle to a device contextReturn ValueReturns the extents as (x,y) in logical units - -Returns: - - tuple[typing.Any, typing.Any]:Handle to a device contextReturn ValueReturns the extents as (x,y) in logical units - - - """ - ... - - -def SetViewportExtEx(hdc: 'int', XExtent: 'typing.Any', YExtent: 'typing.Any') -> 'tuple[typing.Any, typing.Any]': - """ - Changes the viewport extents for a DC - -Args: - - hdc(int):Handle to a device context - XExtent(typing.Any):New X extent in logical units - YExtent(typing.Any):New Y extent in logical unitsReturn ValueReturns the previous extents as (x,y) in logical units - -Returns: - - tuple[typing.Any, typing.Any]:New Y extent in logical unitsReturn ValueReturns the previous extents as (x,y) in logical units - - - """ - ... - - -def GradientFill( - hdc: 'typing.Any', - Vertex: 'tuple[win32typing.PyTRIVERTEX, ...]', - Mesh: 'typing.Any', - Mode: 'typing.Any') -> 'None': - """ - Shades triangles or rectangles by interpolating between vertex colors - -Args: - - hdc(typing.Any):Handle to device context - Vertex(tuple[win32typing.PyTRIVERTEX, ...]):Sequence of TRIVERTEX dicts defining color info - Mesh(typing.Any):Sequence of tuples containing either 2 or 3 ints that index into the trivertex array to define either triangles or rectangles - Mode(typing.Any):win32con.GRADIENT_FILL_* value defining whether to fill by triangle or by rectangle - -Returns: - - None - - """ - ... - - -def GetOpenFileName(OPENFILENAME: 'typing.Union[str, typing.Any]') -> 'typing.Any': - """ - Creates an Open dialog box that lets the user specify the drive, directory, and the name of a file or set of files to open. - -Args: - - OPENFILENAME(typing.Union[str, typing.Any]):A string packed into an OPENFILENAME structure, probably via the struct module.CommentsThe win32gui::GetOpenFileNameW function is far more convenient to use.Return ValueIf the user presses OK, the function returns TRUE. Otherwise, use CommDlgExtendedError for error details (ie, a win32gui.error is raised). If the user cancels the dialog, the winerror attribute of the exception will be zero. - -Returns: - - typing.Any:A string packed into an OPENFILENAME structure, probably via the struct module.Comments - -The win32gui::GetOpenFileNameW function is far more convenient to use. -Return ValueIf the user presses OK, the function returns TRUE. Otherwise, use CommDlgExtendedError for error details - -(ie, a win32gui.error is raised). If the user cancels the dialog, the winerror attribute of the exception will be zero. - - - """ - ... - - -def InsertMenuItem( - hMenu: 'typing.Any', - uItem: 'typing.Any', - fByPosition: 'typing.Any', - menuItem: 'typing.Any') -> 'None': - """ - Inserts a menu item - -Args: - - hMenu(typing.Any):Handle to the menu - uItem(typing.Any):The menu item identifier or the menu item position. - fByPosition(typing.Any):Boolean value of True if uItem is set to a menu item position. This parameter is set to False if uItem is set to a menu item identifier. - menuItem(typing.Any):A string or buffer in the format of a MENUITEMINFO structure. - -Returns: - - None - - """ - ... - - -def SetMenuItemInfo( - hMenu: 'typing.Any', - uItem: 'typing.Any', - fByPosition: 'typing.Any', - menuItem: 'typing.Any') -> 'None': - """ - Sets menu information - -Args: - - hMenu(typing.Any):Handle to the menu - uItem(typing.Any):The menu item identifier or the menu item position. - fByPosition(typing.Any):Boolean value of True if uItem is set to a menu item position. This parameter is set to False if uItem is set to a menu item identifier. - menuItem(typing.Any):A string or buffer in the format of a MENUITEMINFO structure. - -Returns: - - None - - """ - ... - - -def GetMenuItemInfo( - hMenu: 'typing.Any', - uItem: 'typing.Any', - fByPosition: 'typing.Any', - menuItem: 'typing.Any') -> 'None': - """ - Gets menu information - -Args: - - hMenu(typing.Any):Handle to the menu - uItem(typing.Any):The menu item identifier or the menu item position. - fByPosition(typing.Any):Boolean value of True if uItem is set to a menu item position. This parameter is set to False if uItem is set to a menu item identifier. - menuItem(typing.Any):A string or buffer in the format of a MENUITEMINFO structure. - -Returns: - - None - - """ - ... - - -def GetMenuItemCount(hMenu: 'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hMenu(typing.Any):Handle to the menu - -Returns: - - typing.Any - - """ - ... - - -def GetMenuItemRect(hWnd: 'typing.Any', hMenu: 'typing.Any', uItem: 'typing.Any') -> 'tuple[int, int, int, int]': - """ - None - -Args: - - hWnd(typing.Any): - hMenu(typing.Any):Handle to the menu - uItem(typing.Any): - -Returns: - - tuple[int, int, int, int] - - """ - ... - - -def GetMenuState(hMenu: 'typing.Any', uID: 'typing.Any', flags: 'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hMenu(typing.Any):Handle to the menu - uID(typing.Any): - flags(typing.Any): - -Returns: - - typing.Any - - """ - ... - - -def SetMenuDefaultItem(hMenu: 'typing.Any', uItem: 'typing.Any', fByPos: 'typing.Any') -> 'None': - """ - None - -Args: - - hMenu(typing.Any):Handle to the menu - uItem(typing.Any): - fByPos(typing.Any): - -Returns: - - None - - """ - ... - - -def GetMenuDefaultItem(hMenu: 'typing.Any', fByPos: 'typing.Any', flags: 'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hMenu(typing.Any):Handle to the menu - fByPos(typing.Any): - flags(typing.Any): - -Returns: - - typing.Any - - """ - ... - - -def AppendMenu() -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - ... - - -def InsertMenu() -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - ... - - -def EnableMenuItem() -> 'None': - """ - None - -Args: - - - -Returns: - - None - - """ - ... - - -def CheckMenuItem() -> 'typing.Any': - """ - None - -Args: - - - -Returns: - - typing.Any - - """ - ... - - -def GetSubMenu(hMenu: 'typing.Any', nPos: 'typing.Any') -> 'typing.Any': - """ - None - -Args: - - hMenu(typing.Any):Handle to the menu - nPos(typing.Any): - -Returns: - - typing.Any - - """ - ... - - -def ModifyMenu( - hMnu: 'typing.Any', - uPosition: 'typing.Any', - uFlags: 'typing.Any', - uIDNewItem: 'typing.Any', - newItem: 'str') -> 'None': - """ - Changes an existing menu item. This function is used to specify the content, appearance, and behavior of the menu item. - -Args: - - hMnu(typing.Any):handle to menu - uPosition(typing.Any):menu item to modify - uFlags(typing.Any):options - uIDNewItem(typing.Any):identifier, menu, or submenu - newItem(str):menu item content - -Returns: - - None - - """ - ... - - -def GetMenuItemID(hMenu: 'typing.Any', nPos: 'typing.Any') -> 'typing.Any': - """ - Retrieves the menu item identifier of a menu item located at the specified position in a menu. - -Args: - - hMenu(typing.Any):handle to menu - nPos(typing.Any):position of menu item - -Returns: - - typing.Any - - """ - ... - - -def SetMenuItemBitmaps( - hMenu: 'typing.Any', - uPosition: 'typing.Any', - uFlags: 'typing.Any', - hBitmapUnchecked: 'win32typing.PyGdiHANDLE', - hBitmapChecked: 'win32typing.PyGdiHANDLE') -> 'None': - """ - Associates the specified bitmap with a menu item. Whether the menu item is selected or clear, the system displays the appropriate bitmap next to the menu item. - -Args: - - hMenu(typing.Any):handle to menu - uPosition(typing.Any):menu item - uFlags(typing.Any):options - hBitmapUnchecked(win32typing.PyGdiHANDLE):handle to unchecked bitmap, can be None - hBitmapChecked(win32typing.PyGdiHANDLE):handle to checked bitmap, can be None - -Returns: - - None - - """ - ... - - -def CheckMenuRadioItem( - hMenu: 'typing.Any', - idFirst: 'typing.Any', - idLast: 'typing.Any', - idCheck: 'typing.Any', - uFlags: 'typing.Any') -> 'None': - """ - Checks a specified menu item and makes it a - -radio item. At the same time, the function clears all other menu items in - -the associated group and clears the radio-item type flag for those items. - -Args: - - hMenu(typing.Any):handle to menu - idFirst(typing.Any):identifier or position of first item - idLast(typing.Any):identifier or position of last item - idCheck(typing.Any):identifier or position of item to check - uFlags(typing.Any):options - -Returns: - - None - - """ - ... - - -def SetMenuInfo(hmenu: 'typing.Any', info: 'typing.Any') -> 'None': - """ - Sets information for a specified menu. - -Args: - - hmenu(typing.Any):handle to menu - info(typing.Any):menu information in the format of a buffer.CommentsSee win32gui_struct for helper functions.This function will raise NotImplementedError on early platforms (eg, Windows NT.) - -Returns: - - None - - """ - ... - - -def GetMenuInfo(hmenu: 'typing.Any', info: 'typing.Any') -> 'None': - """ - Gets information about a specified menu. - -Args: - - hmenu(typing.Any):handle to menu - info(typing.Any):A buffer to fill with the information.CommentsSee win32gui_struct for helper functions.This function will raise NotImplementedError on early platforms (eg, Windows NT.) - -Returns: - - None - - """ - ... - - -def DrawFocusRect(hDC: 'int', rc: 'tuple[int, int, int, int]') -> 'None': - """ - Draws a standard focus outline around a rectangle - -Args: - - hDC(int):Handle to a device context - rc(tuple[int, int, int, int]):Tuple of (left,top,right,bottom) defining the rectangle - -Returns: - - None - - """ - ... - - -def DrawText( - hDC: 'typing.Union[typing.Any, int]', - String: 'typing.Any', - nCount: 'typing.Any', - Rect: 'win32typing.PyRECT', - Format: 'typing.Any') -> 'tuple[typing.Any, win32typing.PyRECT]': - """ - Draws formatted text on a device context - -Args: - - hDC(typing.Union[typing.Any, int]):The device context on which to draw - String(typing.Any):The text to be drawn - nCount(typing.Any):The number of characters, use -1 for simple null-terminated string - Rect(win32typing.PyRECT):Tuple of 4 ints specifying the position (left, top, right, bottom) - Format(typing.Any):Formatting flags, combination of win32con.DT_* valuesReturn ValueReturns the height of the drawn text, and the rectangle coordinates - -Returns: - - tuple[typing.Any, win32typing.PyRECT]:Formatting flags, combination of win32con.DT_* valuesReturn ValueReturns the height of the drawn text, and the rectangle coordinates - - - """ - ... - - -def LineTo(hdc: 'int', XEnd: 'typing.Any', YEnd: 'typing.Any') -> 'None': - """ - Draw a line from current position to specified point - -Args: - - hdc(int):Handle to a device context - XEnd(typing.Any):Horizontal position in logical units - YEnd(typing.Any):Vertical position in logical units - -Returns: - - None - - """ - ... - - -def Ellipse( - hdc: 'int', - LeftRect: 'typing.Any', - TopRect: 'typing.Any', - RightRect: 'typing.Any', - BottomRect: 'typing.Any') -> 'None': - """ - Draws a filled ellipse on a device context - -Args: - - hdc(int):Device context on which to draw - LeftRect(typing.Any):Left limit of ellipse - TopRect(typing.Any):Top limit of ellipse - RightRect(typing.Any):Right limit of ellipse - BottomRect(typing.Any):Bottom limit of ellipse - -Returns: - - None - - """ - ... - - -def Pie( - hdc: 'int', - LeftRect: 'typing.Any', - TopRect: 'typing.Any', - RightRect: 'typing.Any', - BottomRect: 'typing.Any', - XRadial1: 'typing.Any', - YRadial1: 'typing.Any', - XRadial2: 'typing.Any', - YRadial2: 'typing.Any') -> 'None': - """ - Draws a section of an ellipse cut by 2 radials - -Args: - - hdc(int):Device context on which to draw - LeftRect(typing.Any):Left limit of ellipse - TopRect(typing.Any):Top limit of ellipse - RightRect(typing.Any):Right limit of ellipse - BottomRect(typing.Any):Bottom limit of ellipse - XRadial1(typing.Any):Horizontal pos of Radial1 endpoint - YRadial1(typing.Any):Vertical pos of Radial1 endpoint - XRadial2(typing.Any):Horizontal pos of Radial2 endpoint - YRadial2(typing.Any):Vertical pos of Radial2 endpoint - -Returns: - - None - - """ - ... - - -def Arc( - hdc: 'int', - LeftRect: 'typing.Any', - TopRect: 'typing.Any', - RightRect: 'typing.Any', - BottomRect: 'typing.Any', - XRadial1: 'typing.Any', - YRadial1: 'typing.Any', - XRadial2: 'typing.Any', - YRadial2: 'typing.Any') -> 'None': - """ - Draws an arc defined by an ellipse and 2 radials - -Args: - - hdc(int):Device context on which to draw - LeftRect(typing.Any):Left limit of ellipse - TopRect(typing.Any):Top limit of ellipse - RightRect(typing.Any):Right limit of ellipse - BottomRect(typing.Any):Bottom limit of ellipse - XRadial1(typing.Any):Horizontal pos of Radial1 endpoint - YRadial1(typing.Any):Vertical pos of Radial1 endpoint - XRadial2(typing.Any):Horizontal pos of Radial2 endpoint - YRadial2(typing.Any):Vertical pos of Radial2 endpoint - -Returns: - - None - - """ - ... - - -def ArcTo( - hdc: 'int', - LeftRect: 'typing.Any', - TopRect: 'typing.Any', - RightRect: 'typing.Any', - BottomRect: 'typing.Any', - XRadial1: 'typing.Any', - YRadial1: 'typing.Any', - XRadial2: 'typing.Any', - YRadial2: 'typing.Any') -> 'None': - """ - Draws an arc defined by an ellipse and 2 radials - -Args: - - hdc(int):Device context on which to draw - LeftRect(typing.Any):Left limit of ellipse - TopRect(typing.Any):Top limit of ellipse - RightRect(typing.Any):Right limit of ellipse - BottomRect(typing.Any):Bottom limit of ellipse - XRadial1(typing.Any):Horizontal pos of Radial1 endpoint - YRadial1(typing.Any):Vertical pos of Radial1 endpoint - XRadial2(typing.Any):Horizontal pos of Radial2 endpoint - YRadial2(typing.Any):Vertical pos of Radial2 endpointCommentsDraws exactly as win32gui::Arc, but changes current drawing position - -Returns: - - None - - """ - ... - - -def AngleArc( - hdc: 'int', - Y: 'typing.Any', - Y1: 'typing.Any', - Radius: 'typing.Any', - StartAngle: 'float', - SweepAngle: 'float') -> 'None': - """ - Draws a line from current pos and a section of a circle's arc - -Args: - - hdc(int):Handle to a device context - Y(typing.Any):x pos of circle - Y1(typing.Any):y pos of circle - Radius(typing.Any):Radius of circle - StartAngle(float):Angle where arc starts, in degrees - SweepAngle(float):Angle that arc covers, in degrees - -Returns: - - None - - """ - ... - - -def Chord( - hdc: 'int', - LeftRect: 'typing.Any', - TopRect: 'typing.Any', - RightRect: 'typing.Any', - BottomRect: 'typing.Any', - XRadial1: 'typing.Any', - YRadial1: 'typing.Any', - XRadial2: 'typing.Any', - YRadial2: 'typing.Any') -> 'None': - """ - Draws a chord defined by an ellipse and 2 radials - -Args: - - hdc(int):Device context on which to draw - LeftRect(typing.Any):Left limit of ellipse - TopRect(typing.Any):Top limit of ellipse - RightRect(typing.Any):Right limit of ellipse - BottomRect(typing.Any):Bottom limit of ellipse - XRadial1(typing.Any):Horizontal pos of Radial1 endpoint - YRadial1(typing.Any):Vertical pos of Radial1 endpoint - XRadial2(typing.Any):Horizontal pos of Radial2 endpoint - YRadial2(typing.Any):Vertical pos of Radial2 endpoint - -Returns: - - None - - """ - ... - - -def ExtFloodFill( - arg: 'int', - XStart: 'typing.Any', - YStart: 'typing.Any', - Color: 'typing.Any', - FillType: 'typing.Any') -> 'None': - """ - Fills an area with current brush - -Args: - - arg(int):Handle to a device context - XStart(typing.Any):Horizontal starting pos - YStart(typing.Any):Vertical starting pos - Color(typing.Any):RGB color value. See win32api::RGB. - FillType(typing.Any):One of win32con.FLOODFILL* values - -Returns: - - None - - """ - ... - - -def SetPixel(hdc: 'int', X: 'typing.Any', Y: 'typing.Any', Color: 'typing.Any') -> 'typing.Any': - """ - Set the color of a single pixel - -Args: - - hdc(int):Handle to a device context - X(typing.Any):Horizontal pos - Y(typing.Any):Vertical pos - Color(typing.Any):RGB color to be set.Return ValueReturns the RGB color actually set, which may be different from the one passed in - -Returns: - - typing.Any:RGB color to be set.Return ValueReturns the RGB color actually set, which may be different from the one passed in - - - """ - ... - - -def GetPixel(hdc: 'int', XPos: 'typing.Any', YPos: 'typing.Any') -> 'typing.Any': - """ - Returns the RGB color of a single pixel - -Args: - - hdc(int):Handle to a device context - XPos(typing.Any):Horizontal pos - YPos(typing.Any):Vertical pos - -Returns: - - typing.Any - - """ - ... - - -def GetROP2(hdc: 'int') -> 'typing.Any': - """ - Returns the foreground mixing mode of a DC - -Args: - - hdc(int):Handle to a device contextReturn ValueReturns one of win32con.R2_* values - -Returns: - - typing.Any:Handle to a device contextReturn ValueReturns one of win32con.R2_* values - - - """ - ... - - -def SetROP2(hdc: 'int', DrawMode: 'typing.Any') -> 'typing.Any': - """ - Sets the foreground mixing mode of a DC - -Args: - - hdc(int):Handle to a device context - DrawMode(typing.Any):Mixing mode, one of win32con.R2_*.Return ValueReturns previous mode - -Returns: - - typing.Any:Mixing mode, one of win32con.R2_*.Return ValueReturns previous mode - - - """ - ... - - -def SetPixelV(hdc: 'int', X: 'typing.Any', Y: 'typing.Any', Color: 'typing.Any') -> 'None': - """ - Sets the color of a single pixel to an approximation of specified color - -Args: - - hdc(int):Handle to a device context - X(typing.Any):Horizontal pos - Y(typing.Any):Vertical pos - Color(typing.Any):RGB color to be set. - -Returns: - - None - - """ - ... - - -def MoveToEx(hdc: 'int', X: 'typing.Any', Y: 'typing.Any') -> 'tuple[typing.Any, typing.Any]': - """ - Changes the current drawing position - -Args: - - hdc(int):Device context handle - X(typing.Any):Horizontal pos in logical units - Y(typing.Any):Vertical pos in logical unitsReturn ValueReturns the previous position as (X, Y) - -Returns: - - tuple[typing.Any, typing.Any]:Vertical pos in logical unitsReturn ValueReturns the previous position as (X, Y) - - - """ - ... - - -def GetCurrentPositionEx(hdc: 'int') -> 'tuple[typing.Any, typing.Any]': - """ - Returns a device context's current drawing position - -Args: - - hdc(int):Device context - -Returns: - - tuple[typing.Any, typing.Any] - - """ - ... - - -def GetArcDirection(hdc: 'int') -> 'typing.Any': - """ - Returns the direction in which rectangles and arcs are drawn - -Args: - - hdc(int):Handle to a device contextReturn ValueRecturns one of win32con.AD_* values - -Returns: - - typing.Any:Handle to a device contextReturn ValueRecturns one of win32con.AD_* values - - - """ - ... - - -def SetArcDirection(hdc: 'int', ArcDirection: 'typing.Any') -> 'typing.Any': - """ - Sets the drawing direction for arcs and rectangles - -Args: - - hdc(int):Handle to a device context - ArcDirection(typing.Any):One of win32con.AD_* constantsReturn ValueReturns the previous direction, or 0 on error. - -Returns: - - typing.Any:One of win32con.AD_* constantsReturn ValueReturns the previous direction, or 0 on error. - - - """ - ... - - -def Polygon(hdc: 'int', Points: 'typing.List[tuple[typing.Any, typing.Any]]') -> 'None': - """ - Draws a closed filled polygon defined by a sequence of points - -Args: - - hdc(int):Handle to a device context - Points(typing.List[tuple[typing.Any, typing.Any]]):Sequence of POINT tuples: ((x,y),...) - -Returns: - - None - - """ - ... - - -def Polyline(hdc: 'int', Points: 'typing.List[tuple[typing.Any, typing.Any]]') -> 'None': - """ - Connects a sequence of points using currently selected pen - -Args: - - hdc(int):Handle to a device context - Points(typing.List[tuple[typing.Any, typing.Any]]):Sequence of POINT tuples: ((x,y),...) - -Returns: - - None - - """ - ... - - -def PolylineTo(hdc: 'int', Points: 'typing.List[tuple[typing.Any, typing.Any]]') -> 'None': - """ - Draws a series of lines starting from current position. Updates current position with end point. - -Args: - - hdc(int):Handle to a device context - Points(typing.List[tuple[typing.Any, typing.Any]]):Sequence of POINT tuples: ((x,y),...) - -Returns: - - None - - """ - ... - - -def PolyBezier(hdc: 'int', Points: 'typing.List[tuple[typing.Any, typing.Any]]') -> 'None': - """ - Draws a series of Bezier curves starting from first point specified. - -Args: - - hdc(int):Handle to a device context - Points(typing.List[tuple[typing.Any, typing.Any]]):Sequence of POINT tuples: ((x,y),...).CommentsNumber of points must be a multiple of 3 plus 1. - -Returns: - - None - - """ - ... - - -def PolyBezierTo(hdc: 'int', Points: 'typing.List[tuple[typing.Any, typing.Any]]') -> 'None': - """ - Draws a series of Bezier curves starting from current drawing position. - -Args: - - hdc(int):Handle to a device context - Points(typing.List[tuple[typing.Any, typing.Any]]):Sequence of POINT tuples: ((x,y),...).CommentsPoints must contain 3 points for each curve. Current position is updated with last endpoint. - -Returns: - - None - - """ - ... - - -def PlgBlt( - Dest: 'int', - Point: 'typing.Any', - Src: 'int', - XSrc: 'typing.Any', - YSrc: 'typing.Any', - Width: 'typing.Any', - Height: 'typing.Any', - Mask: 'win32typing.PyGdiHANDLE' = None, - xMask: 'typing.Any' = 0, - yMask: 'typing.Any' = 0) -> 'None': - """ - Copies color from a rectangle into a parallelogram - -Args: - - Dest(int):Destination DC - Point(typing.Any):Sequence of 3 POINT tuples (x,y) describing a paralellogram - Src(int):Source device context - XSrc(typing.Any):Left edge of source rectangle - YSrc(typing.Any):Top of source rectangle - Width(typing.Any):Width of source rectangle - Height(typing.Any):Height of source rectangle - Mask(win32typing.PyGdiHANDLE):Handle to monochrome bitmap to mask source, can be None - xMask(typing.Any):x pos in mask - yMask(typing.Any):y pos in mask - -Returns: - - None - - """ - ... - - -def CreatePolygonRgn(Points: 'typing.List[tuple[typing.Any, typing.Any]]', - PolyFillMode: 'typing.Any') -> 'win32typing.PyGdiHANDLE': - """ - Creates a region from a sequence of vertices - -Args: - - Points(typing.List[tuple[typing.Any, typing.Any]]):Sequence of POINT tuples: ((x,y),...). - PolyFillMode(typing.Any):Filling mode, one of ALTERNATE, WINDING - -Returns: - - win32typing.PyGdiHANDLE - - """ - ... - - -def ExtTextOut( - hdc: 'int', - _int: 'typing.Any', - _int1: 'typing.Any', - _int2: 'typing.Any', - rect: 'win32typing.PyRECT', - string: 'typing.Any', - _tuple: 'tuple[tuple[typing.Any, typing.Any], ...]') -> 'typing.Any': - """ - Writes text to a DC. - -Args: - - hdc(int):Handle to a device context - _int(typing.Any):The x coordinate to write the text to. - _int1(typing.Any):The y coordinate to write the text to. - _int2(typing.Any):Specifies the rectangle type. This parameter can be one, both, or neither of ETO_CLIPPED and ETO_OPAQUE - rect(win32typing.PyRECT):Specifies the text's bounding rectangle. (Can be None.) - string(typing.Any):The text to write. - _tuple(tuple[tuple[typing.Any, typing.Any], ...]):Optional array of values that indicate distance between origins of character cells.Win32 API References - -Returns: - - typing.Any:Search for ExtTextOut at msdn, google or google groups. -Return ValueAlways none. If the function fails, an exception is raised. - - - """ - ... - - -def GetTextColor(hdc: 'typing.Any') -> 'typing.Any': - """ - Returns the text color for a DC - -Args: - - hdc(typing.Any):Handle to a device contextReturn ValueReturns an RGB color. On error, returns CLR_INVALID - -Returns: - - typing.Any:Handle to a device contextReturn ValueReturns an RGB color. On error, returns CLR_INVALID - - - """ - ... - - -def SetTextColor(hdc: 'typing.Any', color: 'typing.Any') -> 'typing.Any': - """ - Changes the text color for a device context - -Args: - - hdc(typing.Any):Handle to a device context - color(typing.Any):The RGB color value - see win32api::RGBReturn ValueReturns the previous color, or CLR_INVALID on failure - -Returns: - - typing.Any:The RGB color value - see win32api::RGBReturn ValueReturns the previous color, or CLR_INVALID on failure - - - """ - ... - - -def GetBkMode(hdc: 'int') -> 'typing.Any': - """ - Returns the background mode for a device context - -Args: - - hdc(int):Handle to a device contextReturn ValueReturns OPAQUE, TRANSPARENT, or 0 on failure - -Returns: - - typing.Any:Handle to a device contextReturn ValueReturns OPAQUE, TRANSPARENT, or 0 on failure - - - """ - ... - - -def SetBkMode(hdc: 'typing.Union[typing.Any, int]', BkMode: 'typing.Any') -> 'typing.Any': - """ - Sets the background mode for a device context - -Args: - - hdc(typing.Union[typing.Any, int]):Handle to a device context - BkMode(typing.Any):OPAQUE or TRANSPARENTReturn ValueReturns the previous mode, or 0 on failure - -Returns: - - typing.Any:OPAQUE or TRANSPARENTReturn ValueReturns the previous mode, or 0 on failure - - - """ - ... - - -def GetBkColor(hdc: 'int') -> 'typing.Any': - """ - Returns the background color for a device context - -Args: - - hdc(int):Handle to a device contextReturn ValueReturns an RGB color value. On error, returns CLR_INVALID. - -Returns: - - typing.Any:Handle to a device contextReturn ValueReturns an RGB color value. On error, returns CLR_INVALID. - - - """ - ... - - -def SetBkColor(hdc: 'typing.Union[typing.Any, int]', color: 'typing.Any') -> 'typing.Any': - """ - Sets the background color for a device context - -Args: - - hdc(typing.Union[typing.Any, int]):Handle to a device context - color(typing.Any):Return ValueReturns the previous color, or CLR_INVALID on failure - -Returns: - - typing.Any:Return ValueReturns the previous color, or CLR_INVALID on failure - - - """ - ... - - -def DrawEdge(hdc: 'int', rc: 'win32typing.PyRECT', edge: 'typing.Any', Flags: 'typing.Any') -> 'win32typing.PyRECT': - """ - Draws edge(s) of a rectangle - -Args: - - hdc(int):Handle to a device context - rc(win32typing.PyRECT):Rectangle whose edge(s) will be drawn - edge(typing.Any):Combination of win32con.BDR_* flags, or one of win32con.EDGE_* flags - Flags(typing.Any):Combination of win32con.BF_* flagsReturn ValueBF_ADJUST flag causes input rectange to be shrunk by size of border.. Rectangle is always returned. - -Returns: - - win32typing.PyRECT:Combination of win32con.BF_* flagsReturn ValueBF_ADJUST flag causes input rectange to be shrunk by size of border.. Rectangle is always returned. - - - """ - ... - - -def FillRect(hDC: 'int', rc: 'win32typing.PyRECT', hbr: 'win32typing.PyGdiHANDLE') -> 'None': - """ - Fills a rectangular area with specified brush - -Args: - - hDC(int):Handle to a device context - rc(win32typing.PyRECT):Rectangle to be filled - hbr(win32typing.PyGdiHANDLE):Handle to brush to be used to fill area - -Returns: - - None - - """ - ... - - -def FillRgn(hdc: 'int', hrgn: 'win32typing.PyGdiHANDLE', hbr: 'win32typing.PyGdiHANDLE') -> 'None': - """ - Fills a region with specified brush - -Args: - - hdc(int):Handle to the device context - hrgn(win32typing.PyGdiHANDLE):Handle to the region - hbr(win32typing.PyGdiHANDLE):Brush to be used - -Returns: - - None - - """ - ... - - -def PaintRgn(hdc: 'int', hrgn: 'win32typing.PyGdiHANDLE') -> 'None': - """ - Paints a region with current brush - -Args: - - hdc(int):Handle to the device context - hrgn(win32typing.PyGdiHANDLE):Handle to the region - -Returns: - - None - - """ - ... - - -def FrameRgn(hdc: 'int', hrgn: 'typing.Any', hbr: 'typing.Any', Width: 'typing.Any', Height: 'typing.Any') -> 'None': - """ - Draws a frame around a region - -Args: - - hdc(int):Handle to the device context - hrgn(typing.Any):Handle to the region - hbr(typing.Any):Handle to brush to be used - Width(typing.Any):Frame width - Height(typing.Any):Frame height - -Returns: - - None - - """ - ... - - -def InvertRgn(hdc: 'int', hrgn: 'typing.Any') -> 'None': - """ - Inverts the colors in a region - -Args: - - hdc(int):Handle to the device context - hrgn(typing.Any):Handle to the region - -Returns: - - None - - """ - ... - - -def EqualRgn(SrcRgn1: 'typing.Any', SrcRgn2: 'typing.Any') -> 'typing.Any': - """ - Determines if 2 regions are equal - -Args: - - SrcRgn1(typing.Any):Handle to a region - SrcRgn2(typing.Any):Handle to a region - -Returns: - - typing.Any - - """ - ... - - -def PtInRegion(hrgn: 'typing.Any', X: 'typing.Any', Y: 'typing.Any') -> 'typing.Any': - """ - Determines if a region contains a point - -Args: - - hrgn(typing.Any):Handle to a region - X(typing.Any):X coord - Y(typing.Any):Y coord - -Returns: - - typing.Any - - """ - ... - - -def PtInRect(rect: 'tuple[int, int, int, int]', point: 'tuple[typing.Any, typing.Any]') -> 'typing.Any': - """ - Determines if a rectangle contains a point - -Args: - - rect(tuple[int, int, int, int]):The rect to check - point(tuple[typing.Any, typing.Any]):The point - -Returns: - - typing.Any - - """ - ... - - -def RectInRegion(hrgn: 'typing.Any', rc: 'win32typing.PyRECT') -> 'typing.Any': - """ - Determines if a region and rectangle overlap at any point - -Args: - - hrgn(typing.Any):Handle to a region - rc(win32typing.PyRECT):Rectangle coordinates in logical units - -Returns: - - typing.Any - - """ - ... - - -def SetRectRgn( - hrgn: 'typing.Any', - LeftRect: 'typing.Any', - TopRect: 'typing.Any', - RightRect: 'typing.Any', - BottomRect: 'typing.Any') -> 'None': - """ - Makes an existing region rectangular - -Args: - - hrgn(typing.Any):Handle to a region - LeftRect(typing.Any):Left edge in logical units - TopRect(typing.Any):Top edge in logical units - RightRect(typing.Any):Right edge in logical units - BottomRect(typing.Any):Bottom edge in logical units - -Returns: - - None - - """ - ... - - -def CombineRgn(Dest: 'typing.Any', Src1: 'typing.Any', Src2: 'typing.Any', CombineMode: 'typing.Any') -> 'typing.Any': - """ - Combines two regions - -Args: - - Dest(typing.Any):Handle to existing region that will receive combined region - Src1(typing.Any):Handle to first region - Src2(typing.Any):Handle to second region - CombineMode(typing.Any):One of RGN_AND,RGN_COPY,RGN_DIFF,RGN_OR,RGN_XORReturn ValueReturns the type of region created, one of NULLREGION, SIMPLEREGION, COMPLEXREGION - -Returns: - - typing.Any:One of RGN_AND,RGN_COPY,RGN_DIFF,RGN_OR,RGN_XORReturn ValueReturns the type of region created, one of NULLREGION, SIMPLEREGION, COMPLEXREGION - - - """ - ... - - -def DrawAnimatedRects( - hwnd: 'int', - idAni: 'typing.Any', - minCoords: 'win32typing.PyRECT', - restCoords: 'win32typing.PyRECT') -> 'None': - """ - Animates a rectangle in the manner of minimizing, mazimizing, or opening - -Args: - - hwnd(typing.Any):handle to clipping window - idAni(typing.Any):type of animation, win32con.IDANI_* - minCoords(win32typing.PyRECT):rectangle coordinates (minimized) - restCoords(win32typing.PyRECT):rectangle coordinates (restored) - -Returns: - - None - - """ - ... - - -def CreateSolidBrush(Color: 'typing.Any') -> 'win32typing.PyGdiHANDLE': - """ - Creates a solid brush of specified color - -Args: - - Color(typing.Any):RGB color value. See win32api::RGB. - -Returns: - - win32typing.PyGdiHANDLE - - """ - ... - - -def CreatePatternBrush(hbmp: 'win32typing.PyGdiHANDLE') -> 'win32typing.PyGdiHANDLE': - """ - Creates a brush using a bitmap as a pattern - -Args: - - hbmp(win32typing.PyGdiHANDLE):Handle to a bitmap - -Returns: - - win32typing.PyGdiHANDLE - - """ - ... - - -def CreateHatchBrush(Style: 'typing.Any', clrref: 'typing.Any') -> 'win32typing.PyGdiHANDLE': - """ - Creates a hatch brush with specified style and color - -Args: - - Style(typing.Any):Hatch style, one of win32con.HS_* constants - clrref(typing.Any):Rgb color value. See win32api::RGB. - -Returns: - - win32typing.PyGdiHANDLE - - """ - ... - - -def CreatePen(PenStyle: 'typing.Any', Width: 'typing.Any', Color: 'typing.Any') -> 'win32typing.PyGdiHANDLE': - """ - Create a GDI pen - -Args: - - PenStyle(typing.Any):One of win32con.PS_* pen styles - Width(typing.Any):Drawing width in logical units. Use zero for single pixel. - Color(typing.Any):RGB color value. See win32api::RGB. - -Returns: - - win32typing.PyGdiHANDLE - - """ - ... - - -def GetSysColor(Index: 'typing.Any') -> 'typing.Any': - """ - Returns the color of a window element - -Args: - - Index(typing.Any):One of win32con.COLOR_* values - -Returns: - - typing.Any - - """ - ... - - -def GetSysColorBrush(Index: 'typing.Any') -> 'win32typing.PyGdiHANDLE': - """ - Creates a handle to a system color brush - -Args: - - Index(typing.Any):Index of a window element color (win32con.COLOR_*) - -Returns: - - win32typing.PyGdiHANDLE - - """ - ... - - -def InvalidateRect(hWnd: 'int', Rect: 'win32typing.PyRECT', Erase: 'typing.Any') -> 'None': - """ - Invalidates a rectangular area of a window and adds it to the window's update region - -Args: - - hWnd(int):Handle to the window - Rect(win32typing.PyRECT):Client coordinates defining area to be redrawn. Use None for entire client area. - Erase(typing.Any):Indicates if background should be erased - -Returns: - - None - - """ - ... - - -def FrameRect(hDC: 'int', rc: 'win32typing.PyRECT', hbr: 'win32typing.PyGdiHANDLE') -> 'None': - """ - Draws an outline around a rectangle - -Args: - - hDC(int):Handle to a device context - rc(win32typing.PyRECT):Rectangle around which to draw - hbr(win32typing.PyGdiHANDLE):Handle to brush created using CreateHatchBrush, CreatePatternBrush, CreateSolidBrush, or GetStockObject - -Returns: - - None - - """ - ... - - -def InvertRect(hDC: 'int', rc: 'win32typing.PyRECT') -> 'None': - """ - Inverts the colors in a regtangular region - -Args: - - hDC(int):Handle to a device context - rc(win32typing.PyRECT):Coordinates of rectangle to invert - -Returns: - - None - - """ - ... - - -def WindowFromDC(hDC: 'int') -> 'int': - """ - Finds the window associated with a device context - -Args: - - hDC(int):Handle to a device contextReturn ValueReturns a handle to the window, or 0 if the DC is not associated with a window - -Returns: - - int:Handle to a device contextReturn ValueReturns a handle to the window, or 0 if the DC is not associated with a window - - - """ - ... - - -def GetUpdateRgn(hWnd: 'int', hRgn: 'win32typing.PyGdiHANDLE', Erase: 'typing.Any') -> 'typing.Any': - """ - Copies the update region of a window into an existing region - -Args: - - hWnd(int):Handle to a window - hRgn(win32typing.PyGdiHANDLE):Handle to an existing region to receive update area - Erase(typing.Any):Indicates if window background is to be erasedReturn ValueReturns type of region, one of COMPLEXREGION, NULLREGION, or SIMPLEREGION - -Returns: - - typing.Any:Indicates if window background is to be erasedReturn ValueReturns type of region, one of COMPLEXREGION, NULLREGION, or SIMPLEREGION - - - """ - ... - - -def GetWindowRgn(hWnd: 'int', hRgn: 'win32typing.PyGdiHANDLE') -> 'typing.Any': - """ - Copies the window region of a window into an existing region - -Args: - - hWnd(int):Handle to a window - hRgn(win32typing.PyGdiHANDLE):Handle to an existing region that receives window regionReturn ValueReturns type of region, one of COMPLEXREGION, NULLREGION, or SIMPLEREGION - -Returns: - - typing.Any:Handle to an existing region that receives window regionReturn ValueReturns type of region, one of COMPLEXREGION, NULLREGION, or SIMPLEREGION - - - """ - ... - - -def SetWindowRgn(hWnd: 'int', hRgn: 'win32typing.PyGdiHANDLE', Redraw: 'typing.Any') -> 'None': - """ - Sets the visible region of a window - -Args: - - hWnd(int):Handle to a window - hRgn(win32typing.PyGdiHANDLE):Handle to region to be set, can be None - Redraw(typing.Any):Indicates if window should be completely redrawnCommentsOn success, the system assumes ownership of the region so you should call the handle's Detach() method to prevent it from being automatically closed. - -Returns: - - None - - """ - ... - - -def GetWindowRgnBox(hWnd: 'int') -> 'tuple[typing.Any, win32typing.PyRECT]': - """ - Returns the bounding box for a window's region - -Args: - - hWnd(int):Handle to a window that has a window region. (see win32gui::SetWindowRgn)CommentsOnly available in winxpguiReturn ValueReturns type of region and rectangle coordinates in device units - -Returns: - - tuple[typing.Any, win32typing.PyRECT]:Handle to a window that has a window region. (see win32gui::SetWindowRgn)Comments - -Only available in winxpgui -Return ValueReturns type of region and rectangle coordinates in device units - - - """ - ... - - -def ValidateRgn(hWnd: 'int', hRgn: 'win32typing.PyGdiHANDLE') -> 'None': - """ - Removes a region from a window's update region - -Args: - - hWnd(int):Handle to the window - hRgn(win32typing.PyGdiHANDLE):Region to be validated - -Returns: - - None - - """ - ... - - -def InvalidateRgn(hWnd: 'int', hRgn: 'win32typing.PyGdiHANDLE', Erase: 'typing.Any') -> 'None': - """ - Adds a region to a window's update region - -Args: - - hWnd(int):Handle to the window - hRgn(win32typing.PyGdiHANDLE):Region to be redrawn - Erase(typing.Any):Indidates if background should be erased - -Returns: - - None - - """ - ... - - -def GetRgnBox(hrgn: 'win32typing.PyGdiHANDLE') -> 'tuple[typing.Any, win32typing.PyRECT]': - """ - Calculates the bounding box of a region - -Args: - - hrgn(win32typing.PyGdiHANDLE):Handle to a regionReturn ValueReturns type of region (COMPLEXREGION, NULLREGION, or SIMPLEREGION) and rectangle in logical units - -Returns: - - tuple[typing.Any, win32typing.PyRECT]:Handle to a regionReturn ValueReturns type of region (COMPLEXREGION, NULLREGION, or SIMPLEREGION) and rectangle in logical units - - - """ - ... - - -def OffsetRgn(hrgn: 'win32typing.PyGdiHANDLE', XOffset: 'typing.Any', YOffset: 'typing.Any') -> 'typing.Any': - """ - Relocates a region - -Args: - - hrgn(win32typing.PyGdiHANDLE):Handle to a region - XOffset(typing.Any):Horizontal offset - YOffset(typing.Any):Vertical offsetReturn ValueReturns type of region (COMPLEXREGION, NULLREGION, or SIMPLEREGION) - -Returns: - - typing.Any:Vertical offsetReturn ValueReturns type of region (COMPLEXREGION, NULLREGION, or SIMPLEREGION) - - - """ - ... - - -def Rectangle( - hdc: 'int', - LeftRect: 'typing.Any', - TopRect: 'typing.Any', - RightRect: 'typing.Any', - BottomRect: 'typing.Any') -> 'None': - """ - Creates a solid rectangle using currently selected pen and brush - -Args: - - hdc(int):Handle to device context - LeftRect(typing.Any):Position of left edge of rectangle - TopRect(typing.Any):Position of top edge of rectangle - RightRect(typing.Any):Position of right edge of rectangle - BottomRect(typing.Any):Position of bottom edge of rectangle - -Returns: - - None - - """ - ... - - -def RoundRect( - hdc: 'int', - LeftRect: 'typing.Any', - TopRect: 'typing.Any', - RightRect: 'typing.Any', - BottomRect: 'typing.Any', - Width: 'typing.Any', - Height: 'typing.Any') -> 'None': - """ - Draws a rectangle with elliptically rounded corners, filled using using current brush - -Args: - - hdc(int):Handle to device context - LeftRect(typing.Any):Position of left edge of rectangle - TopRect(typing.Any):Position of top edge of rectangle - RightRect(typing.Any):Position of right edge of rectangle - BottomRect(typing.Any):Position of bottom edge of rectangle - Width(typing.Any):Width of ellipse - Height(typing.Any):Height of ellipse - -Returns: - - None - - """ - ... - - -def BeginPaint() -> 'tuple[typing.Any, typing.Any]': - """ - None - -Args: - - - -Returns: - - tuple[typing.Any, typing.Any] - - """ - ... - - -def EndPaint(hwnd: 'int', ps: 'typing.Any') -> 'None': - """ - None - -Args: - - hwnd(typing.Any): - ps(typing.Any):As returned from win32gui::BeginPaint - -Returns: - - None - - """ - ... - - -def BeginPath(hdc: 'int') -> 'None': - """ - Initializes a path in a DC - -Args: - - hdc(int):Handle to a device context - -Returns: - - None - - """ - ... - - -def EndPath(hdc: 'int') -> 'None': - """ - None - -Args: - - hdc(int):Handle to a device context - -Returns: - - None - - """ - ... - - -def AbortPath(hdc: 'int') -> 'None': - """ - None - -Args: - - hdc(int):Handle to a device context - -Returns: - - None - - """ - ... - - -def CloseFigure(hdc: 'int') -> 'None': - """ - Closes a section of a path by connecting the beginning pos with the current pos - -Args: - - hdc(int):Handle to a device context that contains an open path. See win32gui::BeginPath. - -Returns: - - None - - """ - ... - - -def FlattenPath(hdc: 'int') -> 'None': - """ - Flattens any curves in current path into a series of lines - -Args: - - hdc(int):Handle to a device context that contains a closed path. See win32gui::EndPath. - -Returns: - - None - - """ - ... - - -def FillPath(hdc: 'int') -> 'None': - """ - Fills a path with currently selected brush - -Args: - - hdc(int):Handle to a device context that contains a finalized path. See win32gui::EndPath.CommentsAny open figures are closed and path is deselected from the DC. - -Returns: - - None - - """ - ... - - -def WidenPath(hdc: 'int') -> 'None': - """ - Widens current path by amount it would increase by if drawn with currently selected pen - -Args: - - hdc(int):Handle to a device context that contains a closed path. See win32gui::EndPath. - -Returns: - - None - - """ - ... - - -def StrokePath(hdc: 'int') -> 'None': - """ - Draws current path with currently selected pen - -Args: - - hdc(int):Handle to a device context that contains a closed path. See win32gui::EndPath. - -Returns: - - None - - """ - ... - - -def StrokeAndFillPath(hdc: 'int') -> 'None': - """ - Combines operations of StrokePath and FillPath with no overlap - -Args: - - hdc(int):Handle to a device context that contains a closed path. See win32gui::EndPath. - -Returns: - - None - - """ - ... - - -def GetMiterLimit(hdc: 'int') -> 'float': - """ - Retrieves the limit of miter joins for a DC - -Args: - - hdc(int):Handle to a device context - -Returns: - - float - - """ - ... - - -def SetMiterLimit(hdc: 'int', NewLimit: 'float') -> 'float': - """ - Set the limit of miter joins for a DC - -Args: - - hdc(int):Handle to a device context - NewLimit(float):New limit to be setReturn ValueReturns the previous limit - -Returns: - - float:New limit to be setReturn ValueReturns the previous limit - - - """ - ... - - -def PathToRegion(hdc: 'int') -> 'win32typing.PyGdiHANDLE': - """ - Converts a closed path in a DC to a region - -Args: - - hdc(int):Handle to a device context that contains a closed path. See win32gui::EndPath.CommentsOn success, the path is deselected from the DC - -Returns: - - win32typing.PyGdiHANDLE - - """ - ... - - -def GetPath(hdc: 'int') -> 'tuple[typing.Any, typing.Any]': - """ - Returns a sequence of points that describe the current path - -Args: - - hdc(int):Handle to a device context containing a finalized path. See win32gui::EndPathReturn ValueReturns a sequence of POINT tuples, and a sequence of ints designating each point's function (combination of win32con.PT_* values) - -Returns: - - tuple[typing.Any, typing.Any]:Handle to a device context containing a finalized path. See win32gui::EndPathReturn ValueReturns a sequence of POINT tuples, and a sequence of ints designating each point's function (combination of win32con.PT_* values) - - - """ - ... - - -def CreateRoundRectRgn( - LeftRect: 'typing.Any', - TopRect: 'typing.Any', - RightRect: 'typing.Any', - BottomRect: 'typing.Any', - WidthEllipse: 'typing.Any', - HeightEllipse: 'typing.Any') -> 'typing.Any': - """ - Create a rectangular region with elliptically rounded corners, - -Args: - - LeftRect(typing.Any):Position of left edge of rectangle - TopRect(typing.Any):Position of top edge of rectangle - RightRect(typing.Any):Position of right edge of rectangle - BottomRect(typing.Any):Position of bottom edge of rectangle - WidthEllipse(typing.Any):Width of ellipse - HeightEllipse(typing.Any):Height of ellipse - -Returns: - - typing.Any - - """ - ... - - -def CreateRectRgnIndirect(rc: 'win32typing.PyRECT') -> 'typing.Any': - """ - Creates a rectangular region, - -Args: - - rc(win32typing.PyRECT):Coordinates of rectangle - -Returns: - - typing.Any - - """ - ... - - -def CreateEllipticRgnIndirect(rc: 'win32typing.PyRECT') -> 'typing.Any': - """ - Creates an ellipse region, - -Args: - - rc(win32typing.PyRECT):Coordinates of bounding rectangle in logical units - -Returns: - - typing.Any - - """ - ... - - -def CreateWindowEx( - dwExStyle: 'typing.Any', - className: 'typing.Union[str, typing.Any]', - windowTitle: 'str', - style: 'typing.Any', - x: 'typing.Any', - y: 'typing.Any', - width: 'typing.Any', - height: 'typing.Any', - parent: 'typing.Any', - menu: 'typing.Any', - hinstance: 'typing.Any', - reserved: 'typing.Any') -> 'typing.Any': - """ - Creates a new window with Extended Style. - -Args: - - dwExStyle(typing.Any):extended window style - className(typing.Union[str, typing.Any]): - windowTitle(str): - style(typing.Any):The style for the window. - x(typing.Any): - y(typing.Any): - width(typing.Any): - height(typing.Any): - parent(typing.Any):Handle to the parent window. - menu(typing.Any):Handle to the menu to use for this window. - hinstance(typing.Any): - reserved(typing.Any):Must be None - -Returns: - - typing.Any - - """ - ... - - -def GetParent(child: 'typing.Any') -> 'typing.Any': - """ - Retrieves a handle to the specified child window's parent window. - -Args: - - child(typing.Any):handle to child window - -Returns: - - typing.Any - - """ - ... - - -def SetParent(child: 'typing.Any', child1: 'typing.Any') -> 'typing.Any': - """ - changes the parent window of the specified child window. - -Args: - - child(typing.Any):handle to window whose parent is changing - child1(typing.Any):handle to new parent window - -Returns: - - typing.Any - - """ - ... - - -def GetCursorPos() -> 'tuple[typing.Any, typing.Any]': - """ - retrieves the cursor's position, in screen coordinates. - -Args: - - - -Returns: - - tuple[typing.Any, typing.Any] - - """ - ... - - -def GetDesktopWindow() -> 'typing.Any': - """ - returns the desktop window - -Args: - - - -Returns: - - typing.Any - - """ - ... - - -def GetWindow(hWnd: 'typing.Any', uCmd: 'typing.Any') -> 'typing.Any': - """ - returns a window that has the specified relationship (Z order or owner) to the specified window. - -Args: - - hWnd(typing.Any):handle to original window - uCmd(typing.Any):relationship flag - -Returns: - - typing.Any - - """ - ... - - -def GetWindowDC(hWnd: 'typing.Any') -> 'typing.Any': - """ - returns the device context (DC) for the entire window, including title bar, menus, and scroll bars. - -Args: - - hWnd(typing.Any):handle of window - -Returns: - - typing.Any - - """ - ... - - -def IsIconic(hWnd: 'typing.Any') -> 'None': - """ - determines whether the specified window is minimized (iconic). - -Args: - - hWnd(typing.Any):handle to window - -Returns: - - None - - """ - ... - - -def IsWindow(hWnd: 'typing.Any') -> 'None': - """ - determines whether the specified window handle identifies an existing window. - -Args: - - hWnd(typing.Any):handle to window - -Returns: - - None - - """ - ... - - -def IsChild(hWndParent: 'typing.Any', hWnd: 'typing.Any') -> 'None': - """ - Tests whether a window is a child window or descendant window of a specified parent window - -Args: - - hWndParent(typing.Any):handle to parent window - hWnd(typing.Any):handle to window to test - -Returns: - - None - - """ - ... - - -def ReleaseCapture() -> 'None': - """ - Releases the moust capture for a window. - -Args: - - - -Returns: - - None - - """ - ... - - -def GetCapture() -> 'typing.Any': - """ - Returns the window with the mouse capture. - -Args: - - - -Returns: - - typing.Any - - """ - ... - - -def SetCapture() -> 'None': - """ - Captures the mouse for the specified window. - -Args: - - - -Returns: - - None - - """ - ... - - -def _TrackMouseEvent(tme: 'win32typing.TRACKMOUSEEVENT') -> 'None': - """ - Posts messages when the mouse pointer leaves a window or hovers over a window for a specified amount of time. - -Args: - - tme(win32typing.TRACKMOUSEEVENT): - -Returns: - - None - - """ - ... - - -def ReleaseDC(hWnd: 'typing.Any', hDC: 'typing.Any') -> 'typing.Any': - """ - Releases a device context. - -Args: - - hWnd(typing.Any):handle to window - hDC(typing.Any):handle to device context - -Returns: - - typing.Any - - """ - ... - - -def CreateCaret( - hWnd: 'typing.Any', - hBitmap: 'win32typing.PyGdiHANDLE', - nWidth: 'typing.Any', - nHeight: 'typing.Any') -> 'None': - """ - Creates a new caret for a window - -Args: - - hWnd(typing.Any):handle to owner window - hBitmap(win32typing.PyGdiHANDLE):handle to bitmap for caret shape - nWidth(typing.Any):caret width - nHeight(typing.Any):caret height - -Returns: - - None - - """ - ... - - -def DestroyCaret() -> 'None': - """ - Destroys caret for current task - -Args: - - - -Returns: - - None - - """ - ... - - -def ScrollWindowEx( - hWnd: 'typing.Any', - dx: 'typing.Any', - dy: 'typing.Any', - rcScroll: 'win32typing.PyRECT', - rcClip: 'win32typing.PyRECT', - hrgnUpdate: 'typing.Any', - flags: 'typing.Any') -> 'tuple[typing.Any, win32typing.PyRECT]': - """ - scrolls the content of the specified window's client area. - -Args: - - hWnd(typing.Any):handle to window to scroll - dx(typing.Any):Amount of horizontal scrolling, in device units - dy(typing.Any):Amount of vertical scrolling, in device units - rcScroll(win32typing.PyRECT):Scroll rectangle, can be None for entire client area - rcClip(win32typing.PyRECT):Clipping rectangle, can be None - hrgnUpdate(typing.Any):Handle to region which will be updated with area invalidated by scroll operation, can be None - flags(typing.Any):Scrolling flags, combination of SW_ERASE,SW_INVALIDATE,SW_SCROLLCHILDREN,SW_SMOOTHSCROLL. If SW_SMOOTHSCROLL is specified, use upper 16 bits to specify time in milliseconds.Return ValueReturns the type of region invalidated by scrolling, and a rectangle defining the affected area. - -Returns: - - tuple[typing.Any, win32typing.PyRECT]:Scrolling flags, combination of SW_ERASE,SW_INVALIDATE,SW_SCROLLCHILDREN,SW_SMOOTHSCROLL. - -If SW_SMOOTHSCROLL is specified, use upper 16 bits to specify time in milliseconds.Return ValueReturns the type of region invalidated by scrolling, and a rectangle defining the affected area. - - - """ - ... - - -def SetScrollInfo( - hwnd: 'int', - nBar: 'typing.Any', - scollInfo: 'win32typing.PySCROLLINFO', - bRedraw: 'typing.Any' = 1) -> 'None': - """ - Sets information about a scroll-bar - -Args: - - hwnd(typing.Any):The handle to the window. - nBar(typing.Any):Identifies the bar. - scollInfo(win32typing.PySCROLLINFO):Scollbar info. - bRedraw(typing.Any):Should the bar be redrawn?Return ValueReturns an int with the current position of the scroll box. - -Returns: - - None:Should the bar be redrawn? -Return ValueReturns an int with the current position of the scroll box. - - - """ - ... - - -def GetScrollInfo(hwnd: 'int', nBar: 'typing.Any', mask: 'typing.Any') -> 'win32typing.PySCROLLINFO': - """ - Returns information about a scroll bar - -Args: - - hwnd(typing.Any):The handle to the window. - nBar(typing.Any):The scroll bar to examine. Can be one of win32con.SB_CTL, win32con.SB_VERT or win32con.SB_HORZ - mask(typing.Any):The mask for attributes to retrieve. - -Returns: - - win32typing.PySCROLLINFO - - """ - ... - - -def GetClassName(hwnd: 'int') -> 'str': - """ - Retrieves the name of the class to which the specified window belongs. - -Args: - - hwnd(int):The handle to the window - -Returns: - - str - - """ - ... - - -def WindowFromPoint(point: 'tuple[typing.Any, typing.Any]') -> 'typing.Any': - """ - Retrieves a handle to the window that contains the specified point. - -Args: - - point(tuple[typing.Any, typing.Any]):The point. - -Returns: - - typing.Any - - """ - ... - - -def ChildWindowFromPoint(hwndParent: 'typing.Any', point: 'tuple[typing.Any, typing.Any]') -> 'typing.Any': - """ - Determines which, if any, of the child windows belonging to a parent window contains the specified point. - -Args: - - hwndParent(typing.Any):The parent. - point(tuple[typing.Any, typing.Any]):The point. - -Returns: - - typing.Any - - """ - ... - - -def ListView_SortItems(hwnd: 'int', callback: 'typing.Any', param: 'typing.Any' = None) -> 'None': - """ - Uses an application-defined comparison function to sort the items of a list view control. - -Args: - - hwnd(typing.Any):The handle to the window - callback(typing.Any):A callback object, taking 3 params. - param(typing.Any):The third param to the callback function. - -Returns: - - None - - """ - ... - - -def ListView_SortItemsEx(hwnd: 'int', callback: 'typing.Any', param: 'typing.Any' = None) -> 'None': - """ - Uses an application-defined comparison function to sort the items of a list view control. - -Args: - - hwnd(typing.Any):The handle to the window - callback(typing.Any):A callback object, taking 3 params. - param(typing.Any):The third param to the callback function. - -Returns: - - None - - """ - ... - - -def CreateDC(Driver: 'str', Device: 'str', InitData: 'win32typing.PyDEVMODE') -> 'typing.Any': - """ - Creates a device context for a printer or display device - -Args: - - Driver(str):Name of display or print provider, usually DISPLAY or WINSPOOL - Device(str):Name of specific device, eg printer name returned from GetDefaultPrinter - InitData(win32typing.PyDEVMODE):A PyDEVMODE that specifies printing parameters, use None for printer defaults - -Returns: - - typing.Any - - """ - ... - - -def GetSaveFileNameW( - hwndOwner: 'int' = None, - hInstance: 'int' = None, - Filter: 'typing.Any' = None, - CustomFilter: 'typing.Any' = None, - FilterIndex: 'typing.Any' = 0, - File: 'typing.Any' = None, - MaxFile: 'typing.Any' = 1024, - InitialDir: 'typing.Any' = None, - Title: 'typing.Any' = None, - Flags: 'typing.Any' = 0, - DefExt: 'typing.Any' = None, - TemplateName: 'win32typing.PyResourceId' = None) -> 'tuple[typing.Any, typing.Any, typing.Any]': - """ - Creates a dialog for user to specify location to save a file or files - -Args: - - hwndOwner(int):Handle to window that owns dialog - hInstance(int):Handle to module that contains dialog template - Filter(typing.Any):Contains pairs of descriptions and filespecs separated by NULLS, with a final trailing NULL. Example: 'Python Scripts\\0*.py;*.pyw;*.pys\\0Text files\\0*.txt\\0' - CustomFilter(typing.Any):Description to be used for filter that user selected or typed, can also contain a filespec as above - FilterIndex(typing.Any):Specifies which of the filters is initially selected, use 0 for CustomFilter - File(typing.Any):The file name initially displayed - MaxFile(typing.Any):Number of characters to allocate for selected filename(s), override if large number of files expected - InitialDir(typing.Any):The starting directory - Title(typing.Any):The title of the dialog box - Flags(typing.Any):Combination of win32con.OFN_* constants - DefExt(typing.Any):The default extension to use - TemplateName(win32typing.PyResourceId):Name or resource id of dialog box templateCommentsAccepts keyword arguments, all arguments optionalReturn ValueReturns a tuple of 3 values (PyUNICODE, PyUNICODE, int): First is the selected file(s). If multiple files are selected, returned string will be the directory followed by files names separated by nulls, otherwise it will be the full path. In other words, if you use the OFN_ALLOWMULTISELECT flag you should split this value on \\0 characters and if the length of the result list is 1, it will be the full path, otherwise element 0 will be the directory and the rest of the elements will be filenames in this directory. Second is a unicode string containing user-selected filter, will be None if CustomFilter was not specified Third item contains flags pertaining to users input, such as OFN_READONLY and OFN_EXTENSIONDIFFERENT If the user presses cancel or an error occurs, a win32gui.error is raised. If the user pressed cancel, the error number (ie, the winerror attribute of the exception) will be zero. - -Returns: - - tuple[typing.Any, typing.Any, typing.Any]:Name or resource id of dialog box template -Comments - -Accepts keyword arguments, all arguments optional -Return ValueReturns a tuple of 3 values (PyUNICODE, PyUNICODE, int): - -First is the selected file(s). If multiple files are selected, returned string will be the directory followed by files names - -separated by nulls, otherwise it will be the full path. In other words, if you use the OFN_ALLOWMULTISELECT flag - -you should split this value on \\0 characters and if the length of the result list is 1, it will be - -the full path, otherwise element 0 will be the directory and the rest of the elements will be filenames in - -this directory. - -Second is a unicode string containing user-selected filter, will be None if CustomFilter was not specified - -Third item contains flags pertaining to users input, such as OFN_READONLY and OFN_EXTENSIONDIFFERENT - -If the user presses cancel or an error occurs, a - -win32gui.error is raised. If the user pressed cancel, the error number (ie, the winerror attribute of the exception) will be zero. - - - """ - ... - - -def GetOpenFileNameW( - hwndOwner: 'int' = None, - hInstance: 'int' = None, - Filter: 'typing.Any' = None, - CustomFilter: 'typing.Any' = None, - FilterIndex: 'typing.Any' = 0, - File: 'typing.Any' = None, - MaxFile: 'typing.Any' = 1024, - InitialDir: 'typing.Any' = None, - Title: 'typing.Any' = None, - Flags: 'typing.Any' = 0, - DefExt: 'typing.Any' = None, - TemplateName: 'win32typing.PyResourceId' = None) -> 'tuple[typing.Any, typing.Any, typing.Any]': - """ - Creates a dialog to allow user to select file(s) to open - -Args: - - hwndOwner(int):Handle to window that owns dialog - hInstance(int):Handle to module that contains dialog template - Filter(typing.Any):Contains pairs of descriptions and filespecs separated by NULLS, with a final trailing NULL. Example: 'Python Scripts\\0*.py;*.pyw;*.pys\\0Text files\\0*.txt\\0' - CustomFilter(typing.Any):Description to be used for filter that user selected or typed, can also contain a filespec as above - FilterIndex(typing.Any):Specifies which of the filters is initially selected, use 0 for CustomFilter - File(typing.Any):The file name initially displayed - MaxFile(typing.Any):Number of characters to allocate for selected filename, override if large number of files expected - InitialDir(typing.Any):The starting directory - Title(typing.Any):The title of the dialog box - Flags(typing.Any):Combination of win32con.OFN_* constants - DefExt(typing.Any):The default extension to use - TemplateName(win32typing.PyResourceId):Name or resource id of dialog box templateCommentsAccepts keyword arguments, all arguments optional Input parameters and return values are identical to win32gui::GetSaveFileNameW - -Returns: - - tuple[typing.Any, typing.Any, typing.Any] - - """ - ... - - -def SystemParametersInfo(Action: 'typing.Any', Param: 'typing.Any' = None, WinIni: 'typing.Any' = 0) -> 'None': - """ - Queries or sets system-wide parameters. This function can also update the user profile while setting a parameter. - -Args: - - Action(typing.Any):System parameter to query or set, one of the SPI_GET* or SPI_SET* constants - Param(typing.Any):depends on action to be taken - WinIni(typing.Any):Flags specifying whether change should be permanent, and if all windows should be notified of change. Combination of SPIF_UPDATEINIFILE, SPIF_SENDCHANGE, SPIF_SENDWININICHANGEActionInput/return typeSPI_GETDESKWALLPAPERReturns the path to the bmp used as wallpaperSPI_SETDESKWALLPAPERParam should be a string specifying a .bmp fileSPI_GETDROPSHADOWReturns a booleanSPI_GETFLATMENUReturns a booleanSPI_GETFONTSMOOTHINGReturns a booleanSPI_GETICONTITLEWRAPReturns a booleanSPI_GETSNAPTODEFBUTTONReturns a booleanSPI_GETBEEPReturns a booleanSPI_GETBLOCKSENDINPUTRESETSReturns a booleanSPI_GETMENUUNDERLINESReturns a booleanSPI_GETKEYBOARDCUESReturns a booleanSPI_GETKEYBOARDPREFReturns a booleanSPI_GETSCREENSAVEACTIVEReturns a booleanSPI_GETSCREENSAVERRUNNINGReturns a booleanSPI_GETMENUDROPALIGNMENTReturns a boolean (True indicates left aligned, False right aligned)SPI_GETMENUFADEReturns a booleanSPI_GETLOWPOWERACTIVEReturns a booleanSPI_GETPOWEROFFACTIVEReturns a booleanSPI_GETCOMBOBOXANIMATIONReturns a booleanSPI_GETCURSORSHADOWReturns a booleanSPI_GETGRADIENTCAPTIONSReturns a booleanSPI_GETHOTTRACKINGReturns a booleanSPI_GETLISTBOXSMOOTHSCROLLINGReturns a booleanSPI_GETMENUANIMATIONReturns a booleanSPI_GETSELECTIONFADEReturns a booleanSPI_GETTOOLTIPANIMATIONReturns a booleanSPI_GETTOOLTIPFADEReturns a boolean (TRUE=fade, False=slide)SPI_GETUIEFFECTSReturns a booleanSPI_GETACTIVEWINDOWTRACKINGReturns a booleanSPI_GETACTIVEWNDTRKZORDERReturns a booleanSPI_GETDRAGFULLWINDOWSReturns a booleanSPI_GETSHOWIMEUIReturns a booleanSPI_GETMOUSECLICKLOCKReturns a booleanSPI_GETMOUSESONARReturns a booleanSPI_GETMOUSEVANISHReturns a booleanSPI_GETSCREENREADERReturns a booleanSPI_GETSHOWSOUNDSReturns a booleanSPI_SETDROPSHADOWParam must be a booleanSPI_SETDROPSHADOWParam must be a booleanSPI_SETMENUUNDERLINESParam must be a booleanSPI_SETKEYBOARDCUESParam must be a booleanSPI_SETMENUFADEParam must be a booleanSPI_SETCOMBOBOXANIMATIONParam must be a booleanSPI_SETCURSORSHADOWParam must be a booleanSPI_SETGRADIENTCAPTIONSParam must be a booleanSPI_SETHOTTRACKINGParam must be a booleanSPI_SETLISTBOXSMOOTHSCROLLINGParam must be a booleanSPI_SETMENUANIMATIONParam must be a booleanSPI_SETSELECTIONFADEParam must be a booleanSPI_SETTOOLTIPANIMATIONParam must be a booleanSPI_SETTOOLTIPFADEParam must be a booleanSPI_SETUIEFFECTSParam must be a booleanSPI_SETACTIVEWINDOWTRACKINGParam must be a booleanSPI_SETACTIVEWNDTRKZORDERParam must be a booleanSPI_SETMOUSESONARParam must be a booleanSPI_SETMOUSEVANISHParam must be a booleanSPI_SETMOUSECLICKLOCKParam must be a booleanSPI_SETFONTSMOOTHINGParam should specify a booleanSPI_SETICONTITLEWRAPParam should specify a booleanSPI_SETSNAPTODEFBUTTONParam is a booleanSPI_SETBEEPParam is a booleanSPI_SETBLOCKSENDINPUTRESETSParam is a booleanSPI_SETKEYBOARDPREFParam is a booleanSPI_SETMOUSEBUTTONSWAPParam is a booleanSPI_SETSCREENSAVEACTIVEParam is a booleanSPI_SETMENUDROPALIGNMENTParam is a boolean (True=left aligned, False=right aligned)SPI_SETLOWPOWERACTIVEParam is a booleanSPI_SETPOWEROFFACTIVEParam is a booleanSPI_SETDRAGFULLWINDOWSParam is a booleanSPI_SETSHOWIMEUIParam is a booleanSPI_SETSCREENREADERParam is a booleanSPI_SETSHOWSOUNDSParam is a booleanSPI_SETMOUSETRAILSParam should be an int specifying the nbr of cursors in the trail (0 or 1 means disabled)SPI_SETWHEELSCROLLLINESParam is an int specifying nbr of linesSPI_SETKEYBOARDDELAYParam is an int in the range 0 - 3SPI_SETKEYBOARDSPEEDParam is an int in the range 0 - 31SPI_SETDOUBLECLICKTIMEParam is an int (in milliseconds), Use win32gui::GetDoubleClickTime to retrieve the value.SPI_SETDOUBLECLKWIDTHParam is an int. Use win32api.GetSystemMetrics(SM_CXDOUBLECLK) to retrieve the value.SPI_SETDOUBLECLKHEIGHTParam is an int, Use win32api.GetSystemMetrics(SM_CYDOUBLECLK) to retrieve the value.SPI_SETMOUSEHOVERHEIGHTParam is an intSPI_SETMOUSEHOVERWIDTHParam is an intSPI_SETMOUSEHOVERTIMEParam is an intSPI_SETSCREENSAVETIMEOUTParam is an int specifying the timeout in secondsSPI_SETMENUSHOWDELAYParam is an int specifying the shortcut menu delay in millisecondsSPI_SETLOWPOWERTIMEOUTParam is an int (in seconds)SPI_SETPOWEROFFTIMEOUTParam is an int (in seconds)SPI_SETDRAGHEIGHTParam is an int. Use win32api.GetSystemMetrics(SM_CYDRAG) to retrieve the value.SPI_SETDRAGWIDTHParam is an int. Use win32api.GetSystemMetrics(SM_CXDRAG) to retrieve the value.SPI_SETBORDERParam is an intSPI_GETFONTSMOOTHINGCONTRASTReturns an intSPI_GETFONTSMOOTHINGTYPEReturns an intSPI_GETMOUSETRAILSReturns an int specifying the nbr of cursor images in the trail, 0 or 1 indicates disabledSPI_GETWHEELSCROLLLINESReturns the nbr of lines to scroll for the mouse wheelSPI_GETKEYBOARDDELAYReturns an intSPI_GETKEYBOARDSPEEDReturns an intSPI_GETMOUSESPEEDReturns an intSPI_GETMOUSEHOVERHEIGHTReturns an intSPI_GETMOUSEHOVERWIDTHReturns an intSPI_GETMOUSEHOVERTIMEReturns an intSPI_GETSCREENSAVETIMEOUTReturns an int (idle time in seconds)SPI_GETMENUSHOWDELAYReturns an int (shortcut delay in milliseconds)SPI_GETLOWPOWERTIMEOUTReturns an int (in seconds)SPI_GETPOWEROFFTIMEOUTReturns an int (in seconds)SPI_GETACTIVEWNDTRKTIMEOUTReturns an int (milliseconds)SPI_GETBORDERReturns an intSPI_GETCARETWIDTHReturns an intSPI_GETFOREGROUNDFLASHCOUNTReturns an intSPI_GETFOREGROUNDLOCKTIMEOUTReturns an intSPI_GETFOCUSBORDERHEIGHTReturns an intSPI_GETFOCUSBORDERWIDTHReturns an intSPI_GETMOUSECLICKLOCKTIMEReturns an int (in milliseconds)SPI_SETFONTSMOOTHINGCONTRASTParam should be an int in the range 1000 to 2200SPI_SETFONTSMOOTHINGTYPEParam should be one of the FE_FONTSMOOTHING* constantsSPI_SETMOUSESPEEDParam should be an int in the range 1 - 20SPI_SETACTIVEWNDTRKTIMEOUTParam is an int (in milliseconds)SPI_SETCARETWIDTHParam is an int (in pixels)SPI_SETFOREGROUNDFLASHCOUNTParam is an intSPI_SETFOREGROUNDLOCKTIMEOUTParam is an int (in milliseconds)SPI_SETFOCUSBORDERHEIGHTReturns an intSPI_SETFOCUSBORDERWIDTHReturns an intSPI_SETMOUSECLICKLOCKTIMEParam is an int (in milliseconds)SPI_GETICONTITLELOGFONTReturns a PyLOGFONT,SPI_SETICONTITLELOGFONTParam must be a PyLOGFONT,SPI_SETLANGTOGGLEParam is ignored. Sets the language toggle hotkey from registry key HKCU\\keyboard layout\\toggleSPI_SETICONSReloads the system icons. Param is not usedSPI_GETMOUSEReturns a tuple of 3 ints containing the x and y mouse thresholds and the acceleration factor.SPI_SETMOUSEParam should be a sequence of 3 intsSPI_GETDEFAULTINPUTLANGReturns an int (locale id for default language)SPI_SETDEFAULTINPUTLANGParam is an int containing a locale idSPI_GETANIMATIONReturns an intSPI_SETANIMATIONParam is an intSPI_ICONHORIZONTALSPACINGFunctions as both a get and set operation. If Param is None, functions as a get operation, otherwise Param is an int to be set as the new valueSPI_ICONVERTICALSPACINGFunctions as both a get and set operation. If Param is None, functions as a get operation, otherwise Param is an int to be set as the new valueSPI_GETNONCLIENTMETRICSParam must be None. The result is a dict.SPI_SETNONCLIENTMETRICSParam is a dict in the form of a NONCLIENTMETRICS struct, as returned by SPI_GETNONCLIENTMETRICS operationSPI_GETMINIMIZEDMETRICSReturns a dict representing a MINIMIZEDMETRICS struct. Param is not used.SPI_SETMINIMIZEDMETRICSParam should be a MINIMIZEDMETRICS dict as returned by SPI_GETMINIMIZEDMETRICS actionSPI_SETDESKPATTERNUnsupported (obsolete)SPI_GETFASTTASKSWITCHUnsupported (obsolete)SPI_SETFASTTASKSWITCHUnsupported (obsolete)SPI_SETSCREENSAVERRUNNINGUnsupported (documented as internal use only)SPI_SCREENSAVERRUNNINGSame as SPI_SETSCREENSAVERRUNNINGSPI_SETPENWINDOWSUnsupported (only relevant for win95)SPI_GETWINDOWSEXTENSIONUnsupported (only relevant for win95)SPI_GETGRIDGRANULARITYUnsupported (obsolete)SPI_SETGRIDGRANULARITYUnsupported (obsolete)SPI_LANGDRIVERUnsupported (use is not documented)SPI_GETFONTSMOOTHINGORIENTATIONUnsupported (use is not documented)SPI_SETFONTSMOOTHINGORIENTATIONUnsupported (use is not documented)SPI_SETHANDHELDUnsupported (use is not documented)SPI_GETICONMETRICSNot implemented yetSPI_SETICONMETRICSNot implemented yetSPI_GETWORKAREANot implemented yetSPI_SETWORKAREANot implemented yetSPI_GETSERIALKEYSNot implemented yetSPI_SETSERIALKEYSNot implemented yetSPI_SETMOUSEKEYSNot implemented yetSPI_GETMOUSEKEYSNot implemented yetSPI_GETHIGHCONTRASTNot implemented yetSPI_SETHIGHCONTRASTNot implemented yetSPI_GETSOUNDSENTRYNot implemented yetSPI_SETSOUNDSENTRYNot implemented yetSPI_GETSTICKYKEYSNot implemented yetSPI_SETSTICKYKEYSNot implemented yetSPI_GETTOGGLEKEYSNot implemented yetSPI_SETTOGGLEKEYSNot implemented yetSPI_GETACCESSTIMEOUTNot implemented yetSPI_SETACCESSTIMEOUTNot implemented yetSPI_GETFILTERKEYSNot implemented yetSPI_SETFILTERKEYSNot implemented yetCommentsParam and WinIni are not used with any of the SPI_GET operations Boolean parameters can be any object that can be evaluated as True or FalseReturn ValueSPI_SET functions all return None on success. Types returned by SPI_GET functions are dependent on the operation - -Returns: - - None:Flags specifying whether change should be permanent, and if all windows should be notified of change. Combination of SPIF_UPDATEINIFILE, SPIF_SENDCHANGE, SPIF_SENDWININICHANGE - - - -Action - - -Input/return type - - - -SPI_GETDESKWALLPAPERReturns the path to the bmp used as wallpaper -SPI_SETDESKWALLPAPERParam should be a string specifying a .bmp file -SPI_GETDROPSHADOWReturns a boolean -SPI_GETFLATMENUReturns a boolean -SPI_GETFONTSMOOTHINGReturns a boolean -SPI_GETICONTITLEWRAPReturns a boolean -SPI_GETSNAPTODEFBUTTONReturns a boolean -SPI_GETBEEPReturns a boolean -SPI_GETBLOCKSENDINPUTRESETSReturns a boolean -SPI_GETMENUUNDERLINESReturns a boolean -SPI_GETKEYBOARDCUESReturns a boolean -SPI_GETKEYBOARDPREFReturns a boolean -SPI_GETSCREENSAVEACTIVEReturns a boolean -SPI_GETSCREENSAVERRUNNINGReturns a boolean -SPI_GETMENUDROPALIGNMENTReturns a boolean (True indicates left aligned, False right aligned) -SPI_GETMENUFADEReturns a boolean -SPI_GETLOWPOWERACTIVEReturns a boolean -SPI_GETPOWEROFFACTIVEReturns a boolean -SPI_GETCOMBOBOXANIMATIONReturns a boolean -SPI_GETCURSORSHADOWReturns a boolean -SPI_GETGRADIENTCAPTIONSReturns a boolean -SPI_GETHOTTRACKINGReturns a boolean -SPI_GETLISTBOXSMOOTHSCROLLINGReturns a boolean -SPI_GETMENUANIMATIONReturns a boolean -SPI_GETSELECTIONFADEReturns a boolean -SPI_GETTOOLTIPANIMATIONReturns a boolean -SPI_GETTOOLTIPFADEReturns a boolean (TRUE=fade, False=slide) -SPI_GETUIEFFECTSReturns a boolean -SPI_GETACTIVEWINDOWTRACKINGReturns a boolean -SPI_GETACTIVEWNDTRKZORDERReturns a boolean -SPI_GETDRAGFULLWINDOWSReturns a boolean -SPI_GETSHOWIMEUIReturns a boolean -SPI_GETMOUSECLICKLOCKReturns a boolean -SPI_GETMOUSESONARReturns a boolean -SPI_GETMOUSEVANISHReturns a boolean -SPI_GETSCREENREADERReturns a boolean -SPI_GETSHOWSOUNDSReturns a boolean -SPI_SETDROPSHADOWParam must be a boolean -SPI_SETDROPSHADOWParam must be a boolean -SPI_SETMENUUNDERLINESParam must be a boolean -SPI_SETKEYBOARDCUESParam must be a boolean -SPI_SETMENUFADEParam must be a boolean -SPI_SETCOMBOBOXANIMATIONParam must be a boolean -SPI_SETCURSORSHADOWParam must be a boolean -SPI_SETGRADIENTCAPTIONSParam must be a boolean -SPI_SETHOTTRACKINGParam must be a boolean -SPI_SETLISTBOXSMOOTHSCROLLINGParam must be a boolean -SPI_SETMENUANIMATIONParam must be a boolean -SPI_SETSELECTIONFADEParam must be a boolean -SPI_SETTOOLTIPANIMATIONParam must be a boolean -SPI_SETTOOLTIPFADEParam must be a boolean -SPI_SETUIEFFECTSParam must be a boolean -SPI_SETACTIVEWINDOWTRACKINGParam must be a boolean -SPI_SETACTIVEWNDTRKZORDERParam must be a boolean -SPI_SETMOUSESONARParam must be a boolean -SPI_SETMOUSEVANISHParam must be a boolean -SPI_SETMOUSECLICKLOCKParam must be a boolean -SPI_SETFONTSMOOTHINGParam should specify a boolean -SPI_SETICONTITLEWRAPParam should specify a boolean -SPI_SETSNAPTODEFBUTTONParam is a boolean -SPI_SETBEEPParam is a boolean -SPI_SETBLOCKSENDINPUTRESETSParam is a boolean -SPI_SETKEYBOARDPREFParam is a boolean -SPI_SETMOUSEBUTTONSWAPParam is a boolean -SPI_SETSCREENSAVEACTIVEParam is a boolean -SPI_SETMENUDROPALIGNMENTParam is a boolean (True=left aligned, False=right aligned) -SPI_SETLOWPOWERACTIVEParam is a boolean -SPI_SETPOWEROFFACTIVEParam is a boolean -SPI_SETDRAGFULLWINDOWSParam is a boolean -SPI_SETSHOWIMEUIParam is a boolean -SPI_SETSCREENREADERParam is a boolean -SPI_SETSHOWSOUNDSParam is a boolean -SPI_SETMOUSETRAILSParam should be an int specifying the nbr of cursors in the trail (0 or 1 means disabled) -SPI_SETWHEELSCROLLLINESParam is an int specifying nbr of lines -SPI_SETKEYBOARDDELAYParam is an int in the range 0 - 3 -SPI_SETKEYBOARDSPEEDParam is an int in the range 0 - 31 -SPI_SETDOUBLECLICKTIMEParam is an int (in milliseconds), Use win32gui::GetDoubleClickTime to retrieve the value. -SPI_SETDOUBLECLKWIDTHParam is an int. Use win32api.GetSystemMetrics(SM_CXDOUBLECLK) to retrieve the value. -SPI_SETDOUBLECLKHEIGHTParam is an int, Use win32api.GetSystemMetrics(SM_CYDOUBLECLK) to retrieve the value. -SPI_SETMOUSEHOVERHEIGHTParam is an int -SPI_SETMOUSEHOVERWIDTHParam is an int -SPI_SETMOUSEHOVERTIMEParam is an int -SPI_SETSCREENSAVETIMEOUTParam is an int specifying the timeout in seconds -SPI_SETMENUSHOWDELAYParam is an int specifying the shortcut menu delay in milliseconds -SPI_SETLOWPOWERTIMEOUTParam is an int (in seconds) -SPI_SETPOWEROFFTIMEOUTParam is an int (in seconds) -SPI_SETDRAGHEIGHTParam is an int. Use win32api.GetSystemMetrics(SM_CYDRAG) to retrieve the value. -SPI_SETDRAGWIDTHParam is an int. Use win32api.GetSystemMetrics(SM_CXDRAG) to retrieve the value. -SPI_SETBORDERParam is an int -SPI_GETFONTSMOOTHINGCONTRASTReturns an int -SPI_GETFONTSMOOTHINGTYPEReturns an int -SPI_GETMOUSETRAILSReturns an int specifying the nbr of cursor images in the trail, 0 or 1 indicates disabled -SPI_GETWHEELSCROLLLINESReturns the nbr of lines to scroll for the mouse wheel -SPI_GETKEYBOARDDELAYReturns an int -SPI_GETKEYBOARDSPEEDReturns an int -SPI_GETMOUSESPEEDReturns an int -SPI_GETMOUSEHOVERHEIGHTReturns an int -SPI_GETMOUSEHOVERWIDTHReturns an int -SPI_GETMOUSEHOVERTIMEReturns an int -SPI_GETSCREENSAVETIMEOUTReturns an int (idle time in seconds) -SPI_GETMENUSHOWDELAYReturns an int (shortcut delay in milliseconds) -SPI_GETLOWPOWERTIMEOUTReturns an int (in seconds) -SPI_GETPOWEROFFTIMEOUTReturns an int (in seconds) -SPI_GETACTIVEWNDTRKTIMEOUTReturns an int (milliseconds) -SPI_GETBORDERReturns an int -SPI_GETCARETWIDTHReturns an int -SPI_GETFOREGROUNDFLASHCOUNTReturns an int -SPI_GETFOREGROUNDLOCKTIMEOUTReturns an int -SPI_GETFOCUSBORDERHEIGHTReturns an int -SPI_GETFOCUSBORDERWIDTHReturns an int -SPI_GETMOUSECLICKLOCKTIMEReturns an int (in milliseconds) -SPI_SETFONTSMOOTHINGCONTRASTParam should be an int in the range 1000 to 2200 -SPI_SETFONTSMOOTHINGTYPEParam should be one of the FE_FONTSMOOTHING* constants -SPI_SETMOUSESPEEDParam should be an int in the range 1 - 20 -SPI_SETACTIVEWNDTRKTIMEOUTParam is an int (in milliseconds) -SPI_SETCARETWIDTHParam is an int (in pixels) -SPI_SETFOREGROUNDFLASHCOUNTParam is an int -SPI_SETFOREGROUNDLOCKTIMEOUTParam is an int (in milliseconds) -SPI_SETFOCUSBORDERHEIGHTReturns an int -SPI_SETFOCUSBORDERWIDTHReturns an int -SPI_SETMOUSECLICKLOCKTIMEParam is an int (in milliseconds) -SPI_GETICONTITLELOGFONTReturns a PyLOGFONT, -SPI_SETICONTITLELOGFONTParam must be a PyLOGFONT, -SPI_SETLANGTOGGLEParam is ignored. Sets the language toggle hotkey from registry key HKCU\\keyboard layout\\toggle -SPI_SETICONSReloads the system icons. Param is not used -SPI_GETMOUSEReturns a tuple of 3 ints containing the x and y mouse thresholds and the acceleration factor. -SPI_SETMOUSEParam should be a sequence of 3 ints -SPI_GETDEFAULTINPUTLANGReturns an int (locale id for default language) -SPI_SETDEFAULTINPUTLANGParam is an int containing a locale id -SPI_GETANIMATIONReturns an int -SPI_SETANIMATIONParam is an int -SPI_ICONHORIZONTALSPACINGFunctions as both a get and set operation. If Param is None, functions as a get operation, otherwise Param is an int to be set as the new value -SPI_ICONVERTICALSPACINGFunctions as both a get and set operation. If Param is None, functions as a get operation, otherwise Param is an int to be set as the new value -SPI_GETNONCLIENTMETRICSParam must be None. The result is a dict. -SPI_SETNONCLIENTMETRICSParam is a dict in the form of a NONCLIENTMETRICS struct, as returned by SPI_GETNONCLIENTMETRICS operation -SPI_GETMINIMIZEDMETRICSReturns a dict representing a MINIMIZEDMETRICS struct. Param is not used. -SPI_SETMINIMIZEDMETRICSParam should be a MINIMIZEDMETRICS dict as returned by SPI_GETMINIMIZEDMETRICS action -SPI_SETDESKPATTERNUnsupported (obsolete) -SPI_GETFASTTASKSWITCHUnsupported (obsolete) -SPI_SETFASTTASKSWITCHUnsupported (obsolete) -SPI_SETSCREENSAVERRUNNINGUnsupported (documented as internal use only) -SPI_SCREENSAVERRUNNINGSame as SPI_SETSCREENSAVERRUNNING -SPI_SETPENWINDOWSUnsupported (only relevant for win95) -SPI_GETWINDOWSEXTENSIONUnsupported (only relevant for win95) -SPI_GETGRIDGRANULARITYUnsupported (obsolete) -SPI_SETGRIDGRANULARITYUnsupported (obsolete) -SPI_LANGDRIVERUnsupported (use is not documented) -SPI_GETFONTSMOOTHINGORIENTATIONUnsupported (use is not documented) -SPI_SETFONTSMOOTHINGORIENTATIONUnsupported (use is not documented) -SPI_SETHANDHELDUnsupported (use is not documented) -SPI_GETICONMETRICSNot implemented yet -SPI_SETICONMETRICSNot implemented yet -SPI_GETWORKAREANot implemented yet -SPI_SETWORKAREANot implemented yet -SPI_GETSERIALKEYSNot implemented yet -SPI_SETSERIALKEYSNot implemented yet -SPI_SETMOUSEKEYSNot implemented yet -SPI_GETMOUSEKEYSNot implemented yet -SPI_GETHIGHCONTRASTNot implemented yet -SPI_SETHIGHCONTRASTNot implemented yet -SPI_GETSOUNDSENTRYNot implemented yet -SPI_SETSOUNDSENTRYNot implemented yet -SPI_GETSTICKYKEYSNot implemented yet -SPI_SETSTICKYKEYSNot implemented yet -SPI_GETTOGGLEKEYSNot implemented yet -SPI_SETTOGGLEKEYSNot implemented yet -SPI_GETACCESSTIMEOUTNot implemented yet -SPI_SETACCESSTIMEOUTNot implemented yet -SPI_GETFILTERKEYSNot implemented yet -SPI_SETFILTERKEYSNot implemented yet -Comments - -Param and WinIni are not used with any of the SPI_GET operations - -Boolean parameters can be any object that can be evaluated as True or False -Return ValueSPI_SET functions all return None on success. Types returned by SPI_GET functions are dependent on the operation - - - """ - ... - - -def SetLayeredWindowAttributes(hwnd: 'int', Key: 'typing.Any', Alpha: 'typing.Any', Flags: 'typing.Any') -> 'None': - """ - Sets the opacity and transparency color key of a layered window. - -Args: - - hwnd(int):handle to the layered window - Key(typing.Any):Specifies the color key. Use win32api::RGB to generate value. - Alpha(typing.Any):Opacity, in the range 0-255 - Flags(typing.Any):Combination of win32con.LWA_* valuesCommentsThis function only exists on Win2k and laterAccepts keyword arguments - -Returns: - - None - - """ - ... - - -def GetLayeredWindowAttributes(hwnd: 'int') -> 'tuple[typing.Any, typing.Any, typing.Any]': - """ - Retrieves the layering parameters of a window with the WS_EX_LAYERED extended style - -Args: - - hwnd(int):Handle to a layered windowCommentsThis function only exists on WinXP and later.Accepts keyword arguments.Return ValueReturns a tuple of (color key, alpha, flags) - -Returns: - - tuple[typing.Any, typing.Any, typing.Any]:Handle to a layered windowComments - -This function only exists on WinXP and later. - -Accepts keyword arguments. -Return ValueReturns a tuple of (color key, alpha, flags) - - - """ - ... - - -def UpdateLayeredWindow( - hwnd: 'int', - arg: 'tuple[int, int, int, int]', - hdcDst: 'int' = None, - ptDst: 'tuple[typing.Any, typing.Any]' = None, - size: 'tuple[typing.Any, typing.Any]' = None, - hdcSrc: 'typing.Any' = None, - ptSrc: 'tuple[typing.Any, typing.Any]' = None, - Key: 'typing.Any' = 0, - Flags: 'typing.Any' = 0) -> 'None': - """ - Updates the position, size, shape, content, and translucency of a layered window. - -Args: - - hwnd(int):handle to layered window - arg(tuple[int, int, int, int]):PyBLENDFUNCTION specifying alpha blending parameters - hdcDst(int):handle to screen DC, can be None. *Must* be None if hdcSrc is None - ptDst(tuple[typing.Any, typing.Any]):New screen position, can be None. - size(tuple[typing.Any, typing.Any]):New size of the layered window, can be None. *Must* be None if hdcSrc is None. - hdcSrc(typing.Any):handle to surface DC for the window, can be None - ptSrc(tuple[typing.Any, typing.Any]):layer position, can be None. *Must* be None if hdcSrc is None. - Key(typing.Any):Color key, generate using win32api::RGB - Flags(typing.Any):One of the win32con.ULW_* values. Use 0 if hdcSrc is None.CommentsThis function is only available on Windows 2000 and laterAccepts keyword arguments. - -Returns: - - None - - """ - ... - - -def AnimateWindow(hwnd: 'int', Time: 'typing.Any', Flags: 'typing.Any') -> 'None': - """ - Enables you to produce special effects when showing or hiding windows. There are three types of animation: roll, slide, and alpha-blended fade. - -Args: - - hwnd(int):handle to window - Time(typing.Any):Duration of animation in ms - Flags(typing.Any):Animation type, combination of win32con.AW_* flagsCommentsThis function is available on Win2k and laterAccepts keyword args - -Returns: - - None - - """ - ... - - -def CreateBrushIndirect(lb: 'win32typing.PyLOGBRUSH') -> 'win32typing.PyGdiHANDLE': - """ - Creates a GDI brush from a LOGBRUSH struct - -Args: - - lb(win32typing.PyLOGBRUSH):Dict containing brush creation parameters - -Returns: - - win32typing.PyGdiHANDLE - - """ - ... - - -def ExtCreatePen( - PenStyle: 'typing.Any', - Width: 'typing.Any', - lb: 'win32typing.PyLOGBRUSH', - Style: 'tuple[typing.Any, ...]' = None) -> 'int': - """ - Creates a GDI pen object - -Args: - - PenStyle(typing.Any):Combination of win32con.PS_*. Must contain either PS_GEOMETRIC or PS_COSMETIC. - Width(typing.Any):Width of pen in logical units. Must be 1 for PS_COSMETIC. - lb(win32typing.PyLOGBRUSH):Dict containing brush creation parameters - Style(tuple[typing.Any, ...]):Sequence containing lengths of dashes and spaces Used only with PS_USERSTYLE, otherwise must be None. - -Returns: - - int - - """ - ... - - -def DrawTextW(hDC: 'int', String: 'str', Count: 'typing.Any', Rect: 'win32typing.PyRECT', - Format: 'typing.Any') -> 'tuple[typing.Any, win32typing.PyRECT]': - """ - Draws Unicode text on a device context. - -Args: - - hDC(int):Handle to a device context - String(str):Text to be drawn - Count(typing.Any):Number of characters to draw, use -1 for entire null terminated string - Rect(win32typing.PyRECT):Rectangle in which to draw text - Format(typing.Any):Formatting flags, combination of win32con.DT_* valuesCommentsAccepts keyword args.Return ValueReturns the height of the drawn text, and the rectangle coordinates - -Returns: - - tuple[typing.Any, win32typing.PyRECT]:Formatting flags, combination of win32con.DT_* valuesComments - -Accepts keyword args. -Return ValueReturns the height of the drawn text, and the rectangle coordinates - - - """ - ... - - -def EnumPropsEx(hWnd: 'int', EnumFunc: 'typing.Any', Param: 'typing.Any') -> 'None': - """ - None - -Args: - - hWnd(int):Handle to a window - EnumFunc(typing.Any):Callback function - Param(typing.Any):Arbitrary object to be passed to callback function - -Returns: - - None - - """ - ... - - -def RegisterDeviceNotification(handle: 'int', _filter: 'typing.Any', flags: 'typing.Any') -> 'win32typing.PyHDEVNOTIFY': - """ - Registers the device or type of device for which a window will receive notifications. - -Args: - - handle(int):The handle to a window or a service - _filter(typing.Any):A buffer laid out like one of the DEV_BROADCAST_* structures, generally built by one of the win32gui_struct helpers. - flags(typing.Any):Win32 API References - -Returns: - - win32typing.PyHDEVNOTIFY - - """ - ... - - -def UnregisterDeviceNotification() -> 'None': - """ - Unregisters a Device Notification handle. - -It is generally not necessary to call this function manually, but in some cases, - -handle values may be extracted via the struct module and need to be closed explicitly. - -Args: - - - -Returns: - - None - - """ - ... - - -def RegisterHotKey(hWnd: 'int', _id: 'typing.Any', Modifiers: 'typing.Any', vk: 'typing.Any') -> 'None': - """ - Registers a hotkey for a window - -Args: - - hWnd(int):Handle to window that will receive WM_HOTKEY messages - _id(typing.Any):Unique id to be used for the hot key - Modifiers(typing.Any):Control keys, combination of win32con.MOD_* - vk(typing.Any):Virtual key codeWin32 API References - -Returns: - - None - - """ - ... - - -CLR_NONE = ... -ILC_COLOR = ... -ILC_COLOR16 = ... -ILC_COLOR24 = ... -ILC_COLOR32 = ... -ILC_COLOR4 = ... -ILC_COLOR8 = ... -ILC_COLORDDB = ... -ILC_MASK = ... -ILD_BLEND = ... -ILD_BLEND25 = ... -ILD_BLEND50 = ... -ILD_FOCUS = ... -ILD_MASK = ... -ILD_NORMAL = ... -ILD_SELECTED = ... -ILD_TRANSPARENT = ... -IMAGE_BITMAP = ... -IMAGE_CURSOR = ... -IMAGE_ICON = ... -LR_CREATEDIBSECTION = ... -LR_DEFAULTCOLOR = ... -LR_DEFAULTSIZE = ... -LR_LOADFROMFILE = ... -LR_LOADMAP3DCOLORS = ... -LR_LOADTRANSPARENT = ... -LR_MONOCHROME = ... -LR_SHARED = ... -LR_VGACOLOR = ... -NIF_ICON = ... -NIF_INFO = ... -NIF_MESSAGE = ... -NIF_STATE = ... -NIF_TIP = ... -NIIF_ERROR = ... -NIIF_ICON_MASK = ... -NIIF_INFO = ... -NIIF_NONE = ... -NIIF_NOSOUND = ... -NIIF_WARNING = ... -NIM_ADD = ... -NIM_DELETE = ... -NIM_MODIFY = ... -NIM_SETFOCUS = ... -NIM_SETVERSION = ... -TPM_BOTTOMALIGN = ... -TPM_CENTERALIGN = ... -TPM_LEFTALIGN = ... -TPM_LEFTBUTTON = ... -TPM_NONOTIFY = ... -TPM_RETURNCMD = ... -TPM_RIGHTALIGN = ... -TPM_RIGHTBUTTON = ... -TPM_TOPALIGN = ... -TPM_VCENTERALIGN = ... diff --git a/typings/win32con/__init__.pyi b/typings/win32con/__init__.pyi deleted file mode 100644 index cddea27f..00000000 --- a/typings/win32con/__init__.pyi +++ /dev/null @@ -1,5069 +0,0 @@ -""" # noqa: Y021 -This type stub file was generated by pyright. -""" - -# Generated by h2py from commdlg.h (plus modifications 4jan98) -WINVER = 1280 -WM_USER = 1024 -PY_0U = 0 -OFN_READONLY = 1 -OFN_OVERWRITEPROMPT = 2 -OFN_HIDEREADONLY = 4 -OFN_NOCHANGEDIR = 8 -OFN_SHOWHELP = 16 -OFN_ENABLEHOOK = 32 -OFN_ENABLETEMPLATE = 64 -OFN_ENABLETEMPLATEHANDLE = 128 -OFN_NOVALIDATE = 256 -OFN_ALLOWMULTISELECT = 512 -OFN_EXTENSIONDIFFERENT = 1024 -OFN_PATHMUSTEXIST = 2048 -OFN_FILEMUSTEXIST = 4096 -OFN_CREATEPROMPT = 8192 -OFN_SHAREAWARE = 16384 -OFN_NOREADONLYRETURN = 32768 -OFN_NOTESTFILECREATE = 65536 -OFN_NONETWORKBUTTON = 131072 -OFN_NOLONGNAMES = 262144 -OFN_EXPLORER = 524288 # new look commdlg -OFN_NODEREFERENCELINKS = 1048576 -OFN_LONGNAMES = 2097152 # force long names for 3.x modules -OFN_ENABLEINCLUDENOTIFY = 4194304 # send include message to callback -OFN_ENABLESIZING = 8388608 -OFN_DONTADDTORECENT = 33554432 -OFN_FORCESHOWHIDDEN = 268435456 # Show All files including System and hidden files -OFN_EX_NOPLACESBAR = 1 -OFN_SHAREFALLTHROUGH = 2 -OFN_SHARENOWARN = 1 -OFN_SHAREWARN = 0 -CDN_FIRST = (PY_0U - 601) -CDN_LAST = (PY_0U - 699) -CDN_INITDONE = (CDN_FIRST - 0) -CDN_SELCHANGE = (CDN_FIRST - 1) -CDN_FOLDERCHANGE = (CDN_FIRST - 2) -CDN_SHAREVIOLATION = (CDN_FIRST - 3) -CDN_HELP = (CDN_FIRST - 4) -CDN_FILEOK = (CDN_FIRST - 5) -CDN_TYPECHANGE = (CDN_FIRST - 6) -CDN_INCLUDEITEM = (CDN_FIRST - 7) -CDM_FIRST = (WM_USER + 100) -CDM_LAST = (WM_USER + 200) -CDM_GETSPEC = (CDM_FIRST + 0) -CDM_GETFILEPATH = (CDM_FIRST + 1) -CDM_GETFOLDERPATH = (CDM_FIRST + 2) -CDM_GETFOLDERIDLIST = (CDM_FIRST + 3) -CDM_SETCONTROLTEXT = (CDM_FIRST + 4) -CDM_HIDECONTROL = (CDM_FIRST + 5) -CDM_SETDEFEXT = (CDM_FIRST + 6) -CC_RGBINIT = 1 -CC_FULLOPEN = 2 -CC_PREVENTFULLOPEN = 4 -CC_SHOWHELP = 8 -CC_ENABLEHOOK = 16 -CC_ENABLETEMPLATE = 32 -CC_ENABLETEMPLATEHANDLE = 64 -CC_SOLIDCOLOR = 128 -CC_ANYCOLOR = 256 -FR_DOWN = 1 -FR_WHOLEWORD = 2 -FR_MATCHCASE = 4 -FR_FINDNEXT = 8 -FR_REPLACE = 16 -FR_REPLACEALL = 32 -FR_DIALOGTERM = 64 -FR_SHOWHELP = 128 -FR_ENABLEHOOK = 256 -FR_ENABLETEMPLATE = 512 -FR_NOUPDOWN = 1024 -FR_NOMATCHCASE = 2048 -FR_NOWHOLEWORD = 4096 -FR_ENABLETEMPLATEHANDLE = 8192 -FR_HIDEUPDOWN = 16384 -FR_HIDEMATCHCASE = 32768 -FR_HIDEWHOLEWORD = 65536 -CF_SCREENFONTS = 1 -CF_PRINTERFONTS = 2 -CF_BOTH = (CF_SCREENFONTS | CF_PRINTERFONTS) -CF_SHOWHELP = 4 -CF_ENABLEHOOK = 8 -CF_ENABLETEMPLATE = 16 -CF_ENABLETEMPLATEHANDLE = 32 -CF_INITTOLOGFONTSTRUCT = 64 -CF_USESTYLE = 128 -CF_EFFECTS = 256 -CF_APPLY = 512 -CF_ANSIONLY = 1024 -CF_SCRIPTSONLY = CF_ANSIONLY -CF_NOVECTORFONTS = 2048 -CF_NOOEMFONTS = CF_NOVECTORFONTS -CF_NOSIMULATIONS = 4096 -CF_LIMITSIZE = 8192 -CF_FIXEDPITCHONLY = 16384 -CF_WYSIWYG = 32768 # must also have CF_SCREENFONTS & CF_PRINTERFONTS -CF_FORCEFONTEXIST = 65536 -CF_SCALABLEONLY = 131072 -CF_TTONLY = 262144 -CF_NOFACESEL = 524288 -CF_NOSTYLESEL = 1048576 -CF_NOSIZESEL = 2097152 -CF_SELECTSCRIPT = 4194304 -CF_NOSCRIPTSEL = 8388608 -CF_NOVERTFONTS = 16777216 -SIMULATED_FONTTYPE = 32768 -PRINTER_FONTTYPE = 16384 -SCREEN_FONTTYPE = 8192 -BOLD_FONTTYPE = 256 -ITALIC_FONTTYPE = 512 -REGULAR_FONTTYPE = 1024 -OPENTYPE_FONTTYPE = 65536 -TYPE1_FONTTYPE = 131072 -DSIG_FONTTYPE = 262144 -WM_CHOOSEFONT_GETLOGFONT = (WM_USER + 1) -WM_CHOOSEFONT_SETLOGFONT = (WM_USER + 101) -WM_CHOOSEFONT_SETFLAGS = (WM_USER + 102) -LBSELCHSTRINGA = "commdlg_LBSelChangedNotify" -SHAREVISTRINGA = "commdlg_ShareViolation" -FILEOKSTRINGA = "commdlg_FileNameOK" -COLOROKSTRINGA = "commdlg_ColorOK" -SETRGBSTRINGA = "commdlg_SetRGBColor" -HELPMSGSTRINGA = "commdlg_help" -FINDMSGSTRINGA = "commdlg_FindReplace" -LBSELCHSTRING = LBSELCHSTRINGA -SHAREVISTRING = SHAREVISTRINGA -FILEOKSTRING = FILEOKSTRINGA -COLOROKSTRING = COLOROKSTRINGA -SETRGBSTRING = SETRGBSTRINGA -HELPMSGSTRING = HELPMSGSTRINGA -FINDMSGSTRING = FINDMSGSTRINGA -CD_LBSELNOITEMS = -1 -CD_LBSELCHANGE = 0 -CD_LBSELSUB = 1 -CD_LBSELADD = 2 -PD_ALLPAGES = 0 -PD_SELECTION = 1 -PD_PAGENUMS = 2 -PD_NOSELECTION = 4 -PD_NOPAGENUMS = 8 -PD_COLLATE = 16 -PD_PRINTTOFILE = 32 -PD_PRINTSETUP = 64 -PD_NOWARNING = 128 -PD_RETURNDC = 256 -PD_RETURNIC = 512 -PD_RETURNDEFAULT = 1024 -PD_SHOWHELP = 2048 -PD_ENABLEPRINTHOOK = 4096 -PD_ENABLESETUPHOOK = 8192 -PD_ENABLEPRINTTEMPLATE = 16384 -PD_ENABLESETUPTEMPLATE = 32768 -PD_ENABLEPRINTTEMPLATEHANDLE = 65536 -PD_ENABLESETUPTEMPLATEHANDLE = 131072 -PD_USEDEVMODECOPIES = 262144 -PD_DISABLEPRINTTOFILE = 524288 -PD_HIDEPRINTTOFILE = 1048576 -PD_NONETWORKBUTTON = 2097152 -DN_DEFAULTPRN = 1 -WM_PSD_PAGESETUPDLG = (WM_USER) -WM_PSD_FULLPAGERECT = (WM_USER + 1) -WM_PSD_MINMARGINRECT = (WM_USER + 2) -WM_PSD_MARGINRECT = (WM_USER + 3) -WM_PSD_GREEKTEXTRECT = (WM_USER + 4) -WM_PSD_ENVSTAMPRECT = (WM_USER + 5) -WM_PSD_YAFULLPAGERECT = (WM_USER + 6) -PSD_DEFAULTMINMARGINS = 0 # default (printer's) -PSD_INWININIINTLMEASURE = 0 # 1st of 4 possible -PSD_MINMARGINS = 1 # use caller's -PSD_MARGINS = 2 # use caller's -PSD_INTHOUSANDTHSOFINCHES = 4 # 2nd of 4 possible -PSD_INHUNDREDTHSOFMILLIMETERS = 8 # 3rd of 4 possible -PSD_DISABLEMARGINS = 16 -PSD_DISABLEPRINTER = 32 -PSD_NOWARNING = 128 # must be same as PD_* -PSD_DISABLEORIENTATION = 256 -PSD_RETURNDEFAULT = 1024 # must be same as PD_* -PSD_DISABLEPAPER = 512 -PSD_SHOWHELP = 2048 # must be same as PD_* -PSD_ENABLEPAGESETUPHOOK = 8192 # must be same as PD_* -PSD_ENABLEPAGESETUPTEMPLATE = 32768 # must be same as PD_* -PSD_ENABLEPAGESETUPTEMPLATEHANDLE = 131072 # must be same as PD_* -PSD_ENABLEPAGEPAINTHOOK = 262144 -PSD_DISABLEPAGEPAINTING = 524288 -PSD_NONETWORKBUTTON = 2097152 # must be same as PD_* - -# Generated by h2py from winreg.h -HKEY_CLASSES_ROOT = -2147483648 -HKEY_CURRENT_USER = -2147483647 -HKEY_LOCAL_MACHINE = -2147483646 -HKEY_USERS = -2147483645 -HKEY_PERFORMANCE_DATA = -2147483644 -HKEY_CURRENT_CONFIG = -2147483643 -HKEY_DYN_DATA = -2147483642 -HKEY_PERFORMANCE_TEXT = -2147483568 # ?? 4Jan98 -HKEY_PERFORMANCE_NLSTEXT = -2147483552 # ?? 4Jan98 - -# Generated by h2py from winuser.h -HWND_BROADCAST = 65535 -HWND_DESKTOP = 0 -HWND_TOP = 0 -HWND_BOTTOM = 1 -HWND_TOPMOST = -1 -HWND_NOTOPMOST = -2 -HWND_MESSAGE = -3 - -# winuser.h line 4601 -SM_CXSCREEN = 0 -SM_CYSCREEN = 1 -SM_CXVSCROLL = 2 -SM_CYHSCROLL = 3 -SM_CYCAPTION = 4 -SM_CXBORDER = 5 -SM_CYBORDER = 6 -SM_CXDLGFRAME = 7 -SM_CYDLGFRAME = 8 -SM_CYVTHUMB = 9 -SM_CXHTHUMB = 10 -SM_CXICON = 11 -SM_CYICON = 12 -SM_CXCURSOR = 13 -SM_CYCURSOR = 14 -SM_CYMENU = 15 -SM_CXFULLSCREEN = 16 -SM_CYFULLSCREEN = 17 -SM_CYKANJIWINDOW = 18 -SM_MOUSEPRESENT = 19 -SM_CYVSCROLL = 20 -SM_CXHSCROLL = 21 -SM_DEBUG = 22 -SM_SWAPBUTTON = 23 -SM_RESERVED1 = 24 -SM_RESERVED2 = 25 -SM_RESERVED3 = 26 -SM_RESERVED4 = 27 -SM_CXMIN = 28 -SM_CYMIN = 29 -SM_CXSIZE = 30 -SM_CYSIZE = 31 -SM_CXFRAME = 32 -SM_CYFRAME = 33 -SM_CXMINTRACK = 34 -SM_CYMINTRACK = 35 -SM_CXDOUBLECLK = 36 -SM_CYDOUBLECLK = 37 -SM_CXICONSPACING = 38 -SM_CYICONSPACING = 39 -SM_MENUDROPALIGNMENT = 40 -SM_PENWINDOWS = 41 -SM_DBCSENABLED = 42 -SM_CMOUSEBUTTONS = 43 -SM_CXFIXEDFRAME = SM_CXDLGFRAME -SM_CYFIXEDFRAME = SM_CYDLGFRAME -SM_CXSIZEFRAME = SM_CXFRAME -SM_CYSIZEFRAME = SM_CYFRAME -SM_SECURE = 44 -SM_CXEDGE = 45 -SM_CYEDGE = 46 -SM_CXMINSPACING = 47 -SM_CYMINSPACING = 48 -SM_CXSMICON = 49 -SM_CYSMICON = 50 -SM_CYSMCAPTION = 51 -SM_CXSMSIZE = 52 -SM_CYSMSIZE = 53 -SM_CXMENUSIZE = 54 -SM_CYMENUSIZE = 55 -SM_ARRANGE = 56 -SM_CXMINIMIZED = 57 -SM_CYMINIMIZED = 58 -SM_CXMAXTRACK = 59 -SM_CYMAXTRACK = 60 -SM_CXMAXIMIZED = 61 -SM_CYMAXIMIZED = 62 -SM_NETWORK = 63 -SM_CLEANBOOT = 67 -SM_CXDRAG = 68 -SM_CYDRAG = 69 -SM_SHOWSOUNDS = 70 -SM_CXMENUCHECK = 71 -SM_CYMENUCHECK = 72 -SM_SLOWMACHINE = 73 -SM_MIDEASTENABLED = 74 -SM_MOUSEWHEELPRESENT = 75 -SM_XVIRTUALSCREEN = 76 -SM_YVIRTUALSCREEN = 77 -SM_CXVIRTUALSCREEN = 78 -SM_CYVIRTUALSCREEN = 79 -SM_CMONITORS = 80 -SM_SAMEDISPLAYFORMAT = 81 -SM_CMETRICS = 83 -MNC_IGNORE = 0 -MNC_CLOSE = 1 -MNC_EXECUTE = 2 -MNC_SELECT = 3 -MNS_NOCHECK = -2147483648 -MNS_MODELESS = 1073741824 -MNS_DRAGDROP = 536870912 -MNS_AUTODISMISS = 268435456 -MNS_NOTIFYBYPOS = 134217728 -MNS_CHECKORBMP = 67108864 -MIM_MAXHEIGHT = 1 -MIM_BACKGROUND = 2 -MIM_HELPID = 4 -MIM_MENUDATA = 8 -MIM_STYLE = 16 -MIM_APPLYTOSUBMENUS = -2147483648 -MND_CONTINUE = 0 -MND_ENDMENU = 1 -MNGOF_GAP = 3 -MNGO_NOINTERFACE = 0 -MNGO_NOERROR = 1 -MIIM_STATE = 1 -MIIM_ID = 2 -MIIM_SUBMENU = 4 -MIIM_CHECKMARKS = 8 -MIIM_TYPE = 16 -MIIM_DATA = 32 -MIIM_STRING = 64 -MIIM_BITMAP = 128 -MIIM_FTYPE = 256 -HBMMENU_CALLBACK = -1 -HBMMENU_SYSTEM = 1 -HBMMENU_MBAR_RESTORE = 2 -HBMMENU_MBAR_MINIMIZE = 3 -HBMMENU_MBAR_CLOSE = 5 -HBMMENU_MBAR_CLOSE_D = 6 -HBMMENU_MBAR_MINIMIZE_D = 7 -HBMMENU_POPUP_CLOSE = 8 -HBMMENU_POPUP_RESTORE = 9 -HBMMENU_POPUP_MAXIMIZE = 10 -HBMMENU_POPUP_MINIMIZE = 11 -GMDI_USEDISABLED = 1 -GMDI_GOINTOPOPUPS = 2 -TPM_LEFTBUTTON = 0 -TPM_RIGHTBUTTON = 2 -TPM_LEFTALIGN = 0 -TPM_CENTERALIGN = 4 -TPM_RIGHTALIGN = 8 -TPM_TOPALIGN = 0 -TPM_VCENTERALIGN = 16 -TPM_BOTTOMALIGN = 32 -TPM_HORIZONTAL = 0 -TPM_VERTICAL = 64 -TPM_NONOTIFY = 128 -TPM_RETURNCMD = 256 -TPM_RECURSE = 1 -DOF_EXECUTABLE = 32769 -DOF_DOCUMENT = 32770 -DOF_DIRECTORY = 32771 -DOF_MULTIPLE = 32772 -DOF_PROGMAN = 1 -DOF_SHELLDATA = 2 -DO_DROPFILE = 1162627398 -DO_PRINTFILE = 1414419024 -DT_TOP = 0 -DT_LEFT = 0 -DT_CENTER = 1 -DT_RIGHT = 2 -DT_VCENTER = 4 -DT_BOTTOM = 8 -DT_WORDBREAK = 16 -DT_SINGLELINE = 32 -DT_EXPANDTABS = 64 -DT_TABSTOP = 128 -DT_NOCLIP = 256 -DT_EXTERNALLEADING = 512 -DT_CALCRECT = 1024 -DT_NOPREFIX = 2048 -DT_INTERNAL = 4096 -DT_EDITCONTROL = 8192 -DT_PATH_ELLIPSIS = 16384 -DT_END_ELLIPSIS = 32768 -DT_MODIFYSTRING = 65536 -DT_RTLREADING = 131072 -DT_WORD_ELLIPSIS = 262144 -DST_COMPLEX = 0 -DST_TEXT = 1 -DST_PREFIXTEXT = 2 -DST_ICON = 3 -DST_BITMAP = 4 -DSS_NORMAL = 0 -DSS_UNION = 16 -DSS_DISABLED = 32 -DSS_MONO = 128 -DSS_RIGHT = 32768 -DCX_WINDOW = 1 -DCX_CACHE = 2 -DCX_NORESETATTRS = 4 -DCX_CLIPCHILDREN = 8 -DCX_CLIPSIBLINGS = 16 -DCX_PARENTCLIP = 32 -DCX_EXCLUDERGN = 64 -DCX_INTERSECTRGN = 128 -DCX_EXCLUDEUPDATE = 256 -DCX_INTERSECTUPDATE = 512 -DCX_LOCKWINDOWUPDATE = 1024 -DCX_VALIDATE = 2097152 -CUDR_NORMAL = 0 -CUDR_NOSNAPTOGRID = 1 -CUDR_NORESOLVEPOSITIONS = 2 -CUDR_NOCLOSEGAPS = 4 -CUDR_NEGATIVECOORDS = 8 -CUDR_NOPRIMARY = 16 -RDW_INVALIDATE = 1 -RDW_INTERNALPAINT = 2 -RDW_ERASE = 4 -RDW_VALIDATE = 8 -RDW_NOINTERNALPAINT = 16 -RDW_NOERASE = 32 -RDW_NOCHILDREN = 64 -RDW_ALLCHILDREN = 128 -RDW_UPDATENOW = 256 -RDW_ERASENOW = 512 -RDW_FRAME = 1024 -RDW_NOFRAME = 2048 -SW_SCROLLCHILDREN = 1 -SW_INVALIDATE = 2 -SW_ERASE = 4 -SW_SMOOTHSCROLL = 16 # Use smooth scrolling -ESB_ENABLE_BOTH = 0 -ESB_DISABLE_BOTH = 3 -ESB_DISABLE_LEFT = 1 -ESB_DISABLE_RIGHT = 2 -ESB_DISABLE_UP = 1 -ESB_DISABLE_DOWN = 2 -ESB_DISABLE_LTUP = ESB_DISABLE_LEFT -ESB_DISABLE_RTDN = ESB_DISABLE_RIGHT -HELPINFO_WINDOW = 1 -HELPINFO_MENUITEM = 2 -MB_OK = 0 -MB_OKCANCEL = 1 -MB_ABORTRETRYIGNORE = 2 -MB_YESNOCANCEL = 3 -MB_YESNO = 4 -MB_RETRYCANCEL = 5 -MB_ICONHAND = 16 -MB_ICONQUESTION = 32 -MB_ICONEXCLAMATION = 48 -MB_ICONASTERISK = 64 -MB_ICONWARNING = MB_ICONEXCLAMATION -MB_ICONERROR = MB_ICONHAND -MB_ICONINFORMATION = MB_ICONASTERISK -MB_ICONSTOP = MB_ICONHAND -MB_DEFBUTTON1 = 0 -MB_DEFBUTTON2 = 256 -MB_DEFBUTTON3 = 512 -MB_DEFBUTTON4 = 768 -MB_APPLMODAL = 0 -MB_SYSTEMMODAL = 4096 -MB_TASKMODAL = 8192 -MB_HELP = 16384 -MB_NOFOCUS = 32768 -MB_SETFOREGROUND = 65536 -MB_DEFAULT_DESKTOP_ONLY = 131072 -MB_TOPMOST = 262144 -MB_RIGHT = 524288 -MB_RTLREADING = 1048576 -MB_SERVICE_NOTIFICATION = 2097152 -MB_TYPEMASK = 15 -MB_USERICON = 128 -MB_ICONMASK = 240 -MB_DEFMASK = 3840 -MB_MODEMASK = 12288 -MB_MISCMASK = 49152 -# winuser.h line 6373 -CWP_ALL = 0 -CWP_SKIPINVISIBLE = 1 -CWP_SKIPDISABLED = 2 -CWP_SKIPTRANSPARENT = 4 -CTLCOLOR_MSGBOX = 0 -CTLCOLOR_EDIT = 1 -CTLCOLOR_LISTBOX = 2 -CTLCOLOR_BTN = 3 -CTLCOLOR_DLG = 4 -CTLCOLOR_SCROLLBAR = 5 -CTLCOLOR_STATIC = 6 -CTLCOLOR_MAX = 7 -COLOR_SCROLLBAR = 0 -COLOR_BACKGROUND = 1 -COLOR_ACTIVECAPTION = 2 -COLOR_INACTIVECAPTION = 3 -COLOR_MENU = 4 -COLOR_WINDOW = 5 -COLOR_WINDOWFRAME = 6 -COLOR_MENUTEXT = 7 -COLOR_WINDOWTEXT = 8 -COLOR_CAPTIONTEXT = 9 -COLOR_ACTIVEBORDER = 10 -COLOR_INACTIVEBORDER = 11 -COLOR_APPWORKSPACE = 12 -COLOR_HIGHLIGHT = 13 -COLOR_HIGHLIGHTTEXT = 14 -COLOR_BTNFACE = 15 -COLOR_BTNSHADOW = 16 -COLOR_GRAYTEXT = 17 -COLOR_BTNTEXT = 18 -COLOR_INACTIVECAPTIONTEXT = 19 -COLOR_BTNHIGHLIGHT = 20 -COLOR_3DDKSHADOW = 21 -COLOR_3DLIGHT = 22 -COLOR_INFOTEXT = 23 -COLOR_INFOBK = 24 -COLOR_HOTLIGHT = 26 -COLOR_GRADIENTACTIVECAPTION = 27 -COLOR_GRADIENTINACTIVECAPTION = 28 -COLOR_DESKTOP = COLOR_BACKGROUND -COLOR_3DFACE = COLOR_BTNFACE -COLOR_3DSHADOW = COLOR_BTNSHADOW -COLOR_3DHIGHLIGHT = COLOR_BTNHIGHLIGHT -COLOR_3DHILIGHT = COLOR_BTNHIGHLIGHT -COLOR_BTNHILIGHT = COLOR_BTNHIGHLIGHT -GW_HWNDFIRST = 0 -GW_HWNDLAST = 1 -GW_HWNDNEXT = 2 -GW_HWNDPREV = 3 -GW_OWNER = 4 -GW_CHILD = 5 -GW_ENABLEDPOPUP = 6 -GW_MAX = 6 -MF_INSERT = 0 -MF_CHANGE = 128 -MF_APPEND = 256 -MF_DELETE = 512 -MF_REMOVE = 4096 -MF_BYCOMMAND = 0 -MF_BYPOSITION = 1024 -MF_SEPARATOR = 2048 -MF_ENABLED = 0 -MF_GRAYED = 1 -MF_DISABLED = 2 -MF_UNCHECKED = 0 -MF_CHECKED = 8 -MF_USECHECKBITMAPS = 512 -MF_STRING = 0 -MF_BITMAP = 4 -MF_OWNERDRAW = 256 -MF_POPUP = 16 -MF_MENUBARBREAK = 32 -MF_MENUBREAK = 64 -MF_UNHILITE = 0 -MF_HILITE = 128 -MF_DEFAULT = 4096 -MF_SYSMENU = 8192 -MF_HELP = 16384 -MF_RIGHTJUSTIFY = 16384 -MF_MOUSESELECT = 32768 -MF_END = 128 -MFT_STRING = MF_STRING -MFT_BITMAP = MF_BITMAP -MFT_MENUBARBREAK = MF_MENUBARBREAK -MFT_MENUBREAK = MF_MENUBREAK -MFT_OWNERDRAW = MF_OWNERDRAW -MFT_RADIOCHECK = 512 -MFT_SEPARATOR = MF_SEPARATOR -MFT_RIGHTORDER = 8192 -MFT_RIGHTJUSTIFY = MF_RIGHTJUSTIFY -MFS_GRAYED = 3 -MFS_DISABLED = MFS_GRAYED -MFS_CHECKED = MF_CHECKED -MFS_HILITE = MF_HILITE -MFS_ENABLED = MF_ENABLED -MFS_UNCHECKED = MF_UNCHECKED -MFS_UNHILITE = MF_UNHILITE -MFS_DEFAULT = MF_DEFAULT -MFS_MASK = 4235 -MFS_HOTTRACKDRAWN = 268435456 -MFS_CACHEDBMP = 536870912 -MFS_BOTTOMGAPDROP = 1073741824 -MFS_TOPGAPDROP = -2147483648 -MFS_GAPDROP = -1073741824 -SC_SIZE = 61440 -SC_MOVE = 61456 -SC_MINIMIZE = 61472 -SC_MAXIMIZE = 61488 -SC_NEXTWINDOW = 61504 -SC_PREVWINDOW = 61520 -SC_CLOSE = 61536 -SC_VSCROLL = 61552 -SC_HSCROLL = 61568 -SC_MOUSEMENU = 61584 -SC_KEYMENU = 61696 -SC_ARRANGE = 61712 -SC_RESTORE = 61728 -SC_TASKLIST = 61744 -SC_SCREENSAVE = 61760 -SC_HOTKEY = 61776 -SC_DEFAULT = 61792 -SC_MONITORPOWER = 61808 -SC_CONTEXTHELP = 61824 -SC_SEPARATOR = 61455 -SC_ICON = SC_MINIMIZE -SC_ZOOM = SC_MAXIMIZE -IDC_ARROW = 32512 -IDC_IBEAM = 32513 -IDC_WAIT = 32514 -IDC_CROSS = 32515 -IDC_UPARROW = 32516 -IDC_SIZE = 32640 # OBSOLETE: use IDC_SIZEALL -IDC_ICON = 32641 # OBSOLETE: use IDC_ARROW -IDC_SIZENWSE = 32642 -IDC_SIZENESW = 32643 -IDC_SIZEWE = 32644 -IDC_SIZENS = 32645 -IDC_SIZEALL = 32646 -IDC_NO = 32648 -IDC_HAND = 32649 -IDC_APPSTARTING = 32650 -IDC_HELP = 32651 -IMAGE_BITMAP = 0 -IMAGE_ICON = 1 -IMAGE_CURSOR = 2 -IMAGE_ENHMETAFILE = 3 -LR_DEFAULTCOLOR = 0 -LR_MONOCHROME = 1 -LR_COLOR = 2 -LR_COPYRETURNORG = 4 -LR_COPYDELETEORG = 8 -LR_LOADFROMFILE = 16 -LR_LOADTRANSPARENT = 32 -LR_DEFAULTSIZE = 64 -LR_LOADREALSIZE = 128 -LR_LOADMAP3DCOLORS = 4096 -LR_CREATEDIBSECTION = 8192 -LR_COPYFROMRESOURCE = 16384 -LR_SHARED = 32768 -DI_MASK = 1 -DI_IMAGE = 2 -DI_NORMAL = 3 -DI_COMPAT = 4 -DI_DEFAULTSIZE = 8 -RES_ICON = 1 -RES_CURSOR = 2 -OBM_CLOSE = 32754 -OBM_UPARROW = 32753 -OBM_DNARROW = 32752 -OBM_RGARROW = 32751 -OBM_LFARROW = 32750 -OBM_REDUCE = 32749 -OBM_ZOOM = 32748 -OBM_RESTORE = 32747 -OBM_REDUCED = 32746 -OBM_ZOOMD = 32745 -OBM_RESTORED = 32744 -OBM_UPARROWD = 32743 -OBM_DNARROWD = 32742 -OBM_RGARROWD = 32741 -OBM_LFARROWD = 32740 -OBM_MNARROW = 32739 -OBM_COMBO = 32738 -OBM_UPARROWI = 32737 -OBM_DNARROWI = 32736 -OBM_RGARROWI = 32735 -OBM_LFARROWI = 32734 -OBM_OLD_CLOSE = 32767 -OBM_SIZE = 32766 -OBM_OLD_UPARROW = 32765 -OBM_OLD_DNARROW = 32764 -OBM_OLD_RGARROW = 32763 -OBM_OLD_LFARROW = 32762 -OBM_BTSIZE = 32761 -OBM_CHECK = 32760 -OBM_CHECKBOXES = 32759 -OBM_BTNCORNERS = 32758 -OBM_OLD_REDUCE = 32757 -OBM_OLD_ZOOM = 32756 -OBM_OLD_RESTORE = 32755 -OCR_NORMAL = 32512 -OCR_IBEAM = 32513 -OCR_WAIT = 32514 -OCR_CROSS = 32515 -OCR_UP = 32516 -OCR_SIZE = 32640 -OCR_ICON = 32641 -OCR_SIZENWSE = 32642 -OCR_SIZENESW = 32643 -OCR_SIZEWE = 32644 -OCR_SIZENS = 32645 -OCR_SIZEALL = 32646 -OCR_ICOCUR = 32647 -OCR_NO = 32648 -OCR_HAND = 32649 -OCR_APPSTARTING = 32650 -# winuser.h line 7455 -OIC_SAMPLE = 32512 -OIC_HAND = 32513 -OIC_QUES = 32514 -OIC_BANG = 32515 -OIC_NOTE = 32516 -OIC_WINLOGO = 32517 -OIC_WARNING = OIC_BANG -OIC_ERROR = OIC_HAND -OIC_INFORMATION = OIC_NOTE -ORD_LANGDRIVER = 1 -IDI_APPLICATION = 32512 -IDI_HAND = 32513 -IDI_QUESTION = 32514 -IDI_EXCLAMATION = 32515 -IDI_ASTERISK = 32516 -IDI_WINLOGO = 32517 -IDI_WARNING = IDI_EXCLAMATION -IDI_ERROR = IDI_HAND -IDI_INFORMATION = IDI_ASTERISK -IDOK = 1 -IDCANCEL = 2 -IDABORT = 3 -IDRETRY = 4 -IDIGNORE = 5 -IDYES = 6 -IDNO = 7 -IDCLOSE = 8 -IDHELP = 9 -ES_LEFT = 0 -ES_CENTER = 1 -ES_RIGHT = 2 -ES_MULTILINE = 4 -ES_UPPERCASE = 8 -ES_LOWERCASE = 16 -ES_PASSWORD = 32 -ES_AUTOVSCROLL = 64 -ES_AUTOHSCROLL = 128 -ES_NOHIDESEL = 256 -ES_OEMCONVERT = 1024 -ES_READONLY = 2048 -ES_WANTRETURN = 4096 -ES_NUMBER = 8192 -EN_SETFOCUS = 256 -EN_KILLFOCUS = 512 -EN_CHANGE = 768 -EN_UPDATE = 1024 -EN_ERRSPACE = 1280 -EN_MAXTEXT = 1281 -EN_HSCROLL = 1537 -EN_VSCROLL = 1538 -EC_LEFTMARGIN = 1 -EC_RIGHTMARGIN = 2 -EC_USEFONTINFO = 65535 -EMSIS_COMPOSITIONSTRING = 1 -EIMES_GETCOMPSTRATONCE = 1 -EIMES_CANCELCOMPSTRINFOCUS = 2 -EIMES_COMPLETECOMPSTRKILLFOCUS = 4 -EM_GETSEL = 176 -EM_SETSEL = 177 -EM_GETRECT = 178 -EM_SETRECT = 179 -EM_SETRECTNP = 180 -EM_SCROLL = 181 -EM_LINESCROLL = 182 -EM_SCROLLCARET = 183 -EM_GETMODIFY = 184 -EM_SETMODIFY = 185 -EM_GETLINECOUNT = 186 -EM_LINEINDEX = 187 -EM_SETHANDLE = 188 -EM_GETHANDLE = 189 -EM_GETTHUMB = 190 -EM_LINELENGTH = 193 -EM_REPLACESEL = 194 -EM_GETLINE = 196 -EM_LIMITTEXT = 197 -EM_CANUNDO = 198 -EM_UNDO = 199 -EM_FMTLINES = 200 -EM_LINEFROMCHAR = 201 -EM_SETTABSTOPS = 203 -EM_SETPASSWORDCHAR = 204 -EM_EMPTYUNDOBUFFER = 205 -EM_GETFIRSTVISIBLELINE = 206 -EM_SETREADONLY = 207 -EM_SETWORDBREAKPROC = 208 -EM_GETWORDBREAKPROC = 209 -EM_GETPASSWORDCHAR = 210 -EM_SETMARGINS = 211 -EM_GETMARGINS = 212 -EM_SETLIMITTEXT = EM_LIMITTEXT -EM_GETLIMITTEXT = 213 -EM_POSFROMCHAR = 214 -EM_CHARFROMPOS = 215 -EM_SETIMESTATUS = 216 -EM_GETIMESTATUS = 217 -WB_LEFT = 0 -WB_RIGHT = 1 -WB_ISDELIMITER = 2 -BS_PUSHBUTTON = 0 -BS_DEFPUSHBUTTON = 1 -BS_CHECKBOX = 2 -BS_AUTOCHECKBOX = 3 -BS_RADIOBUTTON = 4 -BS_3STATE = 5 -BS_AUTO3STATE = 6 -BS_GROUPBOX = 7 -BS_USERBUTTON = 8 -BS_AUTORADIOBUTTON = 9 -BS_OWNERDRAW = 11 -BS_LEFTTEXT = 32 -BS_TEXT = 0 -BS_ICON = 64 -BS_BITMAP = 128 -BS_LEFT = 256 -BS_RIGHT = 512 -BS_CENTER = 768 -BS_TOP = 1024 -BS_BOTTOM = 2048 -BS_VCENTER = 3072 -BS_PUSHLIKE = 4096 -BS_MULTILINE = 8192 -BS_NOTIFY = 16384 -BS_FLAT = 32768 -BS_RIGHTBUTTON = BS_LEFTTEXT -BN_CLICKED = 0 -BN_PAINT = 1 -BN_HILITE = 2 -BN_UNHILITE = 3 -BN_DISABLE = 4 -BN_DOUBLECLICKED = 5 -BN_PUSHED = BN_HILITE -BN_UNPUSHED = BN_UNHILITE -BN_DBLCLK = BN_DOUBLECLICKED -BN_SETFOCUS = 6 -BN_KILLFOCUS = 7 -BM_GETCHECK = 240 -BM_SETCHECK = 241 -BM_GETSTATE = 242 -BM_SETSTATE = 243 -BM_SETSTYLE = 244 -BM_CLICK = 245 -BM_GETIMAGE = 246 -BM_SETIMAGE = 247 -BST_UNCHECKED = 0 -BST_CHECKED = 1 -BST_INDETERMINATE = 2 -BST_PUSHED = 4 -BST_FOCUS = 8 -SS_LEFT = 0 -SS_CENTER = 1 -SS_RIGHT = 2 -SS_ICON = 3 -SS_BLACKRECT = 4 -SS_GRAYRECT = 5 -SS_WHITERECT = 6 -SS_BLACKFRAME = 7 -SS_GRAYFRAME = 8 -SS_WHITEFRAME = 9 -SS_USERITEM = 10 -SS_SIMPLE = 11 -SS_LEFTNOWORDWRAP = 12 -SS_BITMAP = 14 -SS_OWNERDRAW = 13 -SS_ENHMETAFILE = 15 -SS_ETCHEDHORZ = 16 -SS_ETCHEDVERT = 17 -SS_ETCHEDFRAME = 18 -SS_TYPEMASK = 31 -SS_NOPREFIX = 128 -SS_NOTIFY = 256 -SS_CENTERIMAGE = 512 -SS_RIGHTJUST = 1024 -SS_REALSIZEIMAGE = 2048 -SS_SUNKEN = 4096 -SS_ENDELLIPSIS = 16384 -SS_PATHELLIPSIS = 32768 -SS_WORDELLIPSIS = 49152 -SS_ELLIPSISMASK = 49152 -STM_SETICON = 368 -STM_GETICON = 369 -STM_SETIMAGE = 370 -STM_GETIMAGE = 371 -STN_CLICKED = 0 -STN_DBLCLK = 1 -STN_ENABLE = 2 -STN_DISABLE = 3 -STM_MSGMAX = 372 -DWL_MSGRESULT = 0 -DWL_DLGPROC = 4 -DWL_USER = 8 -DDL_READWRITE = 0 -DDL_READONLY = 1 -DDL_HIDDEN = 2 -DDL_SYSTEM = 4 -DDL_DIRECTORY = 16 -DDL_ARCHIVE = 32 -DDL_POSTMSGS = 8192 -DDL_DRIVES = 16384 -DDL_EXCLUSIVE = 32768 - -# from winuser.h line 153 -RT_CURSOR = 1 -RT_BITMAP = 2 -RT_ICON = 3 -RT_MENU = 4 -RT_DIALOG = 5 -RT_STRING = 6 -RT_FONTDIR = 7 -RT_FONT = 8 -RT_ACCELERATOR = 9 -RT_RCDATA = 10 -RT_MESSAGETABLE = 11 -DIFFERENCE = 11 -RT_GROUP_CURSOR = (RT_CURSOR + DIFFERENCE) -RT_GROUP_ICON = (RT_ICON + DIFFERENCE) -RT_VERSION = 16 -RT_DLGINCLUDE = 17 -RT_PLUGPLAY = 19 -RT_VXD = 20 -RT_ANICURSOR = 21 -RT_ANIICON = 22 -RT_HTML = 23 -# from winuser.h line 218 -SB_HORZ = 0 -SB_VERT = 1 -SB_CTL = 2 -SB_BOTH = 3 -SB_LINEUP = 0 -SB_LINELEFT = 0 -SB_LINEDOWN = 1 -SB_LINERIGHT = 1 -SB_PAGEUP = 2 -SB_PAGELEFT = 2 -SB_PAGEDOWN = 3 -SB_PAGERIGHT = 3 -SB_THUMBPOSITION = 4 -SB_THUMBTRACK = 5 -SB_TOP = 6 -SB_LEFT = 6 -SB_BOTTOM = 7 -SB_RIGHT = 7 -SB_ENDSCROLL = 8 -SW_HIDE = 0 -SW_SHOWNORMAL = 1 -SW_NORMAL = 1 -SW_SHOWMINIMIZED = 2 -SW_SHOWMAXIMIZED = 3 -SW_MAXIMIZE = 3 -SW_SHOWNOACTIVATE = 4 -SW_SHOW = 5 -SW_MINIMIZE = 6 -SW_SHOWMINNOACTIVE = 7 -SW_SHOWNA = 8 -SW_RESTORE = 9 -SW_SHOWDEFAULT = 10 -SW_FORCEMINIMIZE = 11 -SW_MAX = 11 -HIDE_WINDOW = 0 -SHOW_OPENWINDOW = 1 -SHOW_ICONWINDOW = 2 -SHOW_FULLSCREEN = 3 -SHOW_OPENNOACTIVATE = 4 -SW_PARENTCLOSING = 1 -SW_OTHERZOOM = 2 -SW_PARENTOPENING = 3 -SW_OTHERUNZOOM = 4 -AW_HOR_POSITIVE = 1 -AW_HOR_NEGATIVE = 2 -AW_VER_POSITIVE = 4 -AW_VER_NEGATIVE = 8 -AW_CENTER = 16 -AW_HIDE = 65536 -AW_ACTIVATE = 131072 -AW_SLIDE = 262144 -AW_BLEND = 524288 -KF_EXTENDED = 256 -KF_DLGMODE = 2048 -KF_MENUMODE = 4096 -KF_ALTDOWN = 8192 -KF_REPEAT = 16384 -KF_UP = 32768 -VK_LBUTTON = 1 -VK_RBUTTON = 2 -VK_CANCEL = 3 -VK_MBUTTON = 4 -VK_BACK = 8 -VK_TAB = 9 -VK_CLEAR = 12 -VK_RETURN = 13 -VK_SHIFT = 16 -VK_CONTROL = 17 -VK_MENU = 18 -VK_PAUSE = 19 -VK_CAPITAL = 20 -VK_KANA = 21 -VK_HANGEUL = 21 # old name - should be here for compatibility -VK_HANGUL = 21 -VK_JUNJA = 23 -VK_FINAL = 24 -VK_HANJA = 25 -VK_KANJI = 25 -VK_ESCAPE = 27 -VK_CONVERT = 28 -VK_NONCONVERT = 29 -VK_ACCEPT = 30 -VK_MODECHANGE = 31 -VK_SPACE = 32 -VK_PRIOR = 33 -VK_NEXT = 34 -VK_END = 35 -VK_HOME = 36 -VK_LEFT = 37 -VK_UP = 38 -VK_RIGHT = 39 -VK_DOWN = 40 -VK_SELECT = 41 -VK_PRINT = 42 -VK_EXECUTE = 43 -VK_SNAPSHOT = 44 -VK_INSERT = 45 -VK_DELETE = 46 -VK_HELP = 47 -VK_LWIN = 91 -VK_RWIN = 92 -VK_APPS = 93 -VK_NUMPAD0 = 96 -VK_NUMPAD1 = 97 -VK_NUMPAD2 = 98 -VK_NUMPAD3 = 99 -VK_NUMPAD4 = 100 -VK_NUMPAD5 = 101 -VK_NUMPAD6 = 102 -VK_NUMPAD7 = 103 -VK_NUMPAD8 = 104 -VK_NUMPAD9 = 105 -VK_MULTIPLY = 106 -VK_ADD = 107 -VK_SEPARATOR = 108 -VK_SUBTRACT = 109 -VK_DECIMAL = 110 -VK_DIVIDE = 111 -VK_F1 = 112 -VK_F2 = 113 -VK_F3 = 114 -VK_F4 = 115 -VK_F5 = 116 -VK_F6 = 117 -VK_F7 = 118 -VK_F8 = 119 -VK_F9 = 120 -VK_F10 = 121 -VK_F11 = 122 -VK_F12 = 123 -VK_F13 = 124 -VK_F14 = 125 -VK_F15 = 126 -VK_F16 = 127 -VK_F17 = 128 -VK_F18 = 129 -VK_F19 = 130 -VK_F20 = 131 -VK_F21 = 132 -VK_F22 = 133 -VK_F23 = 134 -VK_F24 = 135 -VK_NUMLOCK = 144 -VK_SCROLL = 145 -VK_LSHIFT = 160 -VK_RSHIFT = 161 -VK_LCONTROL = 162 -VK_RCONTROL = 163 -VK_LMENU = 164 -VK_RMENU = 165 -VK_PROCESSKEY = 229 -VK_ATTN = 246 -VK_CRSEL = 247 -VK_EXSEL = 248 -VK_EREOF = 249 -VK_PLAY = 250 -VK_ZOOM = 251 -VK_NONAME = 252 -VK_PA1 = 253 -VK_OEM_CLEAR = 254 -# multi-media related "keys" -MOUSEEVENTF_XDOWN = 0x0080 -MOUSEEVENTF_XUP = 0x0100 -MOUSEEVENTF_WHEEL = 0x0800 -VK_XBUTTON1 = 0x05 -VK_XBUTTON2 = 0x06 -VK_VOLUME_MUTE = 0xAD -VK_VOLUME_DOWN = 0xAE -VK_VOLUME_UP = 0xAF -VK_MEDIA_NEXT_TRACK = 0xB0 -VK_MEDIA_PREV_TRACK = 0xB1 -VK_MEDIA_PLAY_PAUSE = 0xB3 -VK_BROWSER_BACK = 0xA6 -VK_BROWSER_FORWARD = 0xA7 -WH_MIN = (-1) -WH_MSGFILTER = (-1) -WH_JOURNALRECORD = 0 -WH_JOURNALPLAYBACK = 1 -WH_KEYBOARD = 2 -WH_GETMESSAGE = 3 -WH_CALLWNDPROC = 4 -WH_CBT = 5 -WH_SYSMSGFILTER = 6 -WH_MOUSE = 7 -WH_HARDWARE = 8 -WH_DEBUG = 9 -WH_SHELL = 10 -WH_FOREGROUNDIDLE = 11 -WH_CALLWNDPROCRET = 12 -WH_KEYBOARD_LL = 13 -WH_MOUSE_LL = 14 -WH_MAX = 14 -WH_MINHOOK = WH_MIN -WH_MAXHOOK = WH_MAX -HC_ACTION = 0 -HC_GETNEXT = 1 -HC_SKIP = 2 -HC_NOREMOVE = 3 -HC_NOREM = HC_NOREMOVE -HC_SYSMODALON = 4 -HC_SYSMODALOFF = 5 -HCBT_MOVESIZE = 0 -HCBT_MINMAX = 1 -HCBT_QS = 2 -HCBT_CREATEWND = 3 -HCBT_DESTROYWND = 4 -HCBT_ACTIVATE = 5 -HCBT_CLICKSKIPPED = 6 -HCBT_KEYSKIPPED = 7 -HCBT_SYSCOMMAND = 8 -HCBT_SETFOCUS = 9 -MSGF_DIALOGBOX = 0 -MSGF_MESSAGEBOX = 1 -MSGF_MENU = 2 -# MSGF_MOVE = 3 -# MSGF_SIZE = 4 -MSGF_SCROLLBAR = 5 -MSGF_NEXTWINDOW = 6 -# MSGF_MAINLOOP = 8 -MSGF_MAX = 8 -MSGF_USER = 4096 -HSHELL_WINDOWCREATED = 1 -HSHELL_WINDOWDESTROYED = 2 -HSHELL_ACTIVATESHELLWINDOW = 3 -HSHELL_WINDOWACTIVATED = 4 -HSHELL_GETMINRECT = 5 -HSHELL_REDRAW = 6 -HSHELL_TASKMAN = 7 -HSHELL_LANGUAGE = 8 -HSHELL_ACCESSIBILITYSTATE = 11 -ACCESS_STICKYKEYS = 1 -ACCESS_FILTERKEYS = 2 -ACCESS_MOUSEKEYS = 3 -# winuser.h line 624 -LLKHF_EXTENDED = 1 -LLKHF_INJECTED = 16 -LLKHF_ALTDOWN = 32 -LLKHF_UP = 128 -LLKHF_LOWER_IL_INJECTED = 2 -LLMHF_INJECTED = 1 -LLMHF_LOWER_IL_INJECTED = 2 -# line 692 -HKL_PREV = 0 -HKL_NEXT = 1 -KLF_ACTIVATE = 1 -KLF_SUBSTITUTE_OK = 2 -KLF_UNLOADPREVIOUS = 4 -KLF_REORDER = 8 -KLF_REPLACELANG = 16 -KLF_NOTELLSHELL = 128 -KLF_SETFORPROCESS = 256 -KL_NAMELENGTH = 9 -DESKTOP_READOBJECTS = 1 -DESKTOP_CREATEWINDOW = 2 -DESKTOP_CREATEMENU = 4 -DESKTOP_HOOKCONTROL = 8 -DESKTOP_JOURNALRECORD = 16 -DESKTOP_JOURNALPLAYBACK = 32 -DESKTOP_ENUMERATE = 64 -DESKTOP_WRITEOBJECTS = 128 -DESKTOP_SWITCHDESKTOP = 256 -DF_ALLOWOTHERACCOUNTHOOK = 1 -WINSTA_ENUMDESKTOPS = 1 -WINSTA_READATTRIBUTES = 2 -WINSTA_ACCESSCLIPBOARD = 4 -WINSTA_CREATEDESKTOP = 8 -WINSTA_WRITEATTRIBUTES = 16 -WINSTA_ACCESSGLOBALATOMS = 32 -WINSTA_EXITWINDOWS = 64 -WINSTA_ENUMERATE = 256 -WINSTA_READSCREEN = 512 -WSF_VISIBLE = 1 -UOI_FLAGS = 1 -UOI_NAME = 2 -UOI_TYPE = 3 -UOI_USER_SID = 4 -GWL_WNDPROC = (-4) -GWL_HINSTANCE = (-6) -GWL_HWNDPARENT = (-8) -GWL_STYLE = (-16) -GWL_EXSTYLE = (-20) -GWL_USERDATA = (-21) -GWL_ID = (-12) -GCL_MENUNAME = (-8) -GCL_HBRBACKGROUND = (-10) -GCL_HCURSOR = (-12) -GCL_HICON = (-14) -GCL_HMODULE = (-16) -GCL_CBWNDEXTRA = (-18) -GCL_CBCLSEXTRA = (-20) -GCL_WNDPROC = (-24) -GCL_STYLE = (-26) -GCW_ATOM = (-32) -GCL_HICONSM = (-34) -# line 1291 -WM_NULL = 0 -WM_CREATE = 1 -WM_DESTROY = 2 -WM_MOVE = 3 -WM_SIZE = 5 -WM_ACTIVATE = 6 -WA_INACTIVE = 0 -WA_ACTIVE = 1 -WA_CLICKACTIVE = 2 -WM_SETFOCUS = 7 -WM_KILLFOCUS = 8 -WM_ENABLE = 10 -WM_SETREDRAW = 11 -WM_SETTEXT = 12 -WM_GETTEXT = 13 -WM_GETTEXTLENGTH = 14 -WM_PAINT = 15 -WM_CLOSE = 16 -WM_QUERYENDSESSION = 17 -WM_QUIT = 18 -WM_QUERYOPEN = 19 -WM_ERASEBKGND = 20 -WM_SYSCOLORCHANGE = 21 -WM_ENDSESSION = 22 -WM_SHOWWINDOW = 24 -WM_WININICHANGE = 26 -WM_SETTINGCHANGE = WM_WININICHANGE -WM_DEVMODECHANGE = 27 -WM_ACTIVATEAPP = 28 -WM_FONTCHANGE = 29 -WM_TIMECHANGE = 30 -WM_CANCELMODE = 31 -WM_SETCURSOR = 32 -WM_MOUSEACTIVATE = 33 -WM_CHILDACTIVATE = 34 -WM_QUEUESYNC = 35 -WM_GETMINMAXINFO = 36 -WM_PAINTICON = 38 -WM_ICONERASEBKGND = 39 -WM_NEXTDLGCTL = 40 -WM_SPOOLERSTATUS = 42 -WM_DRAWITEM = 43 -WM_MEASUREITEM = 44 -WM_DELETEITEM = 45 -WM_VKEYTOITEM = 46 -WM_CHARTOITEM = 47 -WM_SETFONT = 48 -WM_GETFONT = 49 -WM_SETHOTKEY = 50 -WM_GETHOTKEY = 51 -WM_QUERYDRAGICON = 55 -WM_COMPAREITEM = 57 -WM_GETOBJECT = 61 -WM_COMPACTING = 65 -WM_COMMNOTIFY = 68 -WM_WINDOWPOSCHANGING = 70 -WM_WINDOWPOSCHANGED = 71 -WM_POWER = 72 -PWR_OK = 1 -PWR_FAIL = (-1) -PWR_SUSPENDREQUEST = 1 -PWR_SUSPENDRESUME = 2 -PWR_CRITICALRESUME = 3 -WM_COPYDATA = 74 -WM_CANCELJOURNAL = 75 -WM_NOTIFY = 78 -WM_INPUTLANGCHANGEREQUEST = 80 -WM_INPUTLANGCHANGE = 81 -WM_TCARD = 82 -WM_HELP = 83 -WM_USERCHANGED = 84 -WM_NOTIFYFORMAT = 85 -NFR_ANSI = 1 -NFR_UNICODE = 2 -NF_QUERY = 3 -NF_REQUERY = 4 -WM_CONTEXTMENU = 123 -WM_STYLECHANGING = 124 -WM_STYLECHANGED = 125 -WM_DISPLAYCHANGE = 126 -WM_GETICON = 127 -WM_SETICON = 128 -WM_NCCREATE = 129 -WM_NCDESTROY = 130 -WM_NCCALCSIZE = 131 -WM_NCHITTEST = 132 -WM_NCPAINT = 133 -WM_NCACTIVATE = 134 -WM_GETDLGCODE = 135 -WM_SYNCPAINT = 136 -WM_NCMOUSEMOVE = 160 -WM_NCLBUTTONDOWN = 161 -WM_NCLBUTTONUP = 162 -WM_NCLBUTTONDBLCLK = 163 -WM_NCRBUTTONDOWN = 164 -WM_NCRBUTTONUP = 165 -WM_NCRBUTTONDBLCLK = 166 -WM_NCMBUTTONDOWN = 167 -WM_NCMBUTTONUP = 168 -WM_NCMBUTTONDBLCLK = 169 -WM_KEYFIRST = 256 -WM_KEYDOWN = 256 -WM_KEYUP = 257 -WM_CHAR = 258 -WM_DEADCHAR = 259 -WM_SYSKEYDOWN = 260 -WM_SYSKEYUP = 261 -WM_SYSCHAR = 262 -WM_SYSDEADCHAR = 263 -WM_KEYLAST = 264 -WM_IME_STARTCOMPOSITION = 269 -WM_IME_ENDCOMPOSITION = 270 -WM_IME_COMPOSITION = 271 -WM_IME_KEYLAST = 271 -WM_INITDIALOG = 272 -WM_COMMAND = 273 -WM_SYSCOMMAND = 274 -WM_TIMER = 275 -WM_HSCROLL = 276 -WM_VSCROLL = 277 -WM_INITMENU = 278 -WM_INITMENUPOPUP = 279 -WM_MENUSELECT = 287 -WM_MENUCHAR = 288 -WM_ENTERIDLE = 289 -WM_MENURBUTTONUP = 290 -WM_MENUDRAG = 291 -WM_MENUGETOBJECT = 292 -WM_UNINITMENUPOPUP = 293 -WM_MENUCOMMAND = 294 -WM_CTLCOLORMSGBOX = 306 -WM_CTLCOLOREDIT = 307 -WM_CTLCOLORLISTBOX = 308 -WM_CTLCOLORBTN = 309 -WM_CTLCOLORDLG = 310 -WM_CTLCOLORSCROLLBAR = 311 -WM_CTLCOLORSTATIC = 312 -WM_MOUSEFIRST = 512 -WM_MOUSEMOVE = 512 -WM_LBUTTONDOWN = 513 -WM_LBUTTONUP = 514 -WM_LBUTTONDBLCLK = 515 -WM_RBUTTONDOWN = 516 -WM_RBUTTONUP = 517 -WM_RBUTTONDBLCLK = 518 -WM_MBUTTONDOWN = 519 -WM_MBUTTONUP = 520 -WM_MBUTTONDBLCLK = 521 -WM_MOUSEWHEEL = 522 -WM_MOUSELAST = 522 -WHEEL_DELTA = 120 # Value for rolling one detent -WHEEL_PAGESCROLL = -1 # Scroll one page -WM_PARENTNOTIFY = 528 -MENULOOP_WINDOW = 0 -MENULOOP_POPUP = 1 -WM_ENTERMENULOOP = 529 -WM_EXITMENULOOP = 530 -WM_NEXTMENU = 531 -WM_SIZING = 532 -WM_CAPTURECHANGED = 533 -WM_MOVING = 534 -WM_POWERBROADCAST = 536 -PBT_APMQUERYSUSPEND = 0 -PBT_APMQUERYSTANDBY = 1 -PBT_APMQUERYSUSPENDFAILED = 2 -PBT_APMQUERYSTANDBYFAILED = 3 -PBT_APMSUSPEND = 4 -PBT_APMSTANDBY = 5 -PBT_APMRESUMECRITICAL = 6 -PBT_APMRESUMESUSPEND = 7 -PBT_APMRESUMESTANDBY = 8 -PBTF_APMRESUMEFROMFAILURE = 1 -PBT_APMBATTERYLOW = 9 -PBT_APMPOWERSTATUSCHANGE = 10 -PBT_APMOEMEVENT = 11 -PBT_APMRESUMEAUTOMATIC = 18 -WM_DEVICECHANGE = 537 -WM_MDICREATE = 544 -WM_MDIDESTROY = 545 -WM_MDIACTIVATE = 546 -WM_MDIRESTORE = 547 -WM_MDINEXT = 548 -WM_MDIMAXIMIZE = 549 -WM_MDITILE = 550 -WM_MDICASCADE = 551 -WM_MDIICONARRANGE = 552 -WM_MDIGETACTIVE = 553 -WM_MDISETMENU = 560 -WM_ENTERSIZEMOVE = 561 -WM_EXITSIZEMOVE = 562 -WM_DROPFILES = 563 -WM_MDIREFRESHMENU = 564 -WM_IME_SETCONTEXT = 641 -WM_IME_NOTIFY = 642 -WM_IME_CONTROL = 643 -WM_IME_COMPOSITIONFULL = 644 -WM_IME_SELECT = 645 -WM_IME_CHAR = 646 -WM_IME_REQUEST = 648 -WM_IME_KEYDOWN = 656 -WM_IME_KEYUP = 657 -WM_MOUSEHOVER = 673 -WM_MOUSELEAVE = 675 -WM_CUT = 768 -WM_COPY = 769 -WM_PASTE = 770 -WM_CLEAR = 771 -WM_UNDO = 772 -WM_RENDERFORMAT = 773 -WM_RENDERALLFORMATS = 774 -WM_DESTROYCLIPBOARD = 775 -WM_DRAWCLIPBOARD = 776 -WM_PAINTCLIPBOARD = 777 -WM_VSCROLLCLIPBOARD = 778 -WM_SIZECLIPBOARD = 779 -WM_ASKCBFORMATNAME = 780 -WM_CHANGECBCHAIN = 781 -WM_HSCROLLCLIPBOARD = 782 -WM_QUERYNEWPALETTE = 783 -WM_PALETTEISCHANGING = 784 -WM_PALETTECHANGED = 785 -WM_HOTKEY = 786 -WM_PRINT = 791 -WM_PRINTCLIENT = 792 -WM_HANDHELDFIRST = 856 -WM_HANDHELDLAST = 863 -WM_AFXFIRST = 864 -WM_AFXLAST = 895 -WM_PENWINFIRST = 896 -WM_PENWINLAST = 911 -WM_APP = 32768 -WMSZ_LEFT = 1 -WMSZ_RIGHT = 2 -WMSZ_TOP = 3 -WMSZ_TOPLEFT = 4 -WMSZ_TOPRIGHT = 5 -WMSZ_BOTTOM = 6 -WMSZ_BOTTOMLEFT = 7 -WMSZ_BOTTOMRIGHT = 8 -# ST_BEGINSWP = 0 -# ST_ENDSWP = 1 -HTERROR = (-2) -HTTRANSPARENT = (-1) -HTNOWHERE = 0 -HTCLIENT = 1 -HTCAPTION = 2 -HTSYSMENU = 3 -HTGROWBOX = 4 -HTSIZE = HTGROWBOX -HTMENU = 5 -HTHSCROLL = 6 -HTVSCROLL = 7 -HTMINBUTTON = 8 -HTMAXBUTTON = 9 -HTLEFT = 10 -HTRIGHT = 11 -HTTOP = 12 -HTTOPLEFT = 13 -HTTOPRIGHT = 14 -HTBOTTOM = 15 -HTBOTTOMLEFT = 16 -HTBOTTOMRIGHT = 17 -HTBORDER = 18 -HTREDUCE = HTMINBUTTON -HTZOOM = HTMAXBUTTON -HTSIZEFIRST = HTLEFT -HTSIZELAST = HTBOTTOMRIGHT -HTOBJECT = 19 -HTCLOSE = 20 -HTHELP = 21 -SMTO_NORMAL = 0 -SMTO_BLOCK = 1 -SMTO_ABORTIFHUNG = 2 -SMTO_NOTIMEOUTIFNOTHUNG = 8 -MA_ACTIVATE = 1 -MA_ACTIVATEANDEAT = 2 -MA_NOACTIVATE = 3 -MA_NOACTIVATEANDEAT = 4 -ICON_SMALL = 0 -ICON_BIG = 1 -SIZE_RESTORED = 0 -SIZE_MINIMIZED = 1 -SIZE_MAXIMIZED = 2 -SIZE_MAXSHOW = 3 -SIZE_MAXHIDE = 4 -SIZENORMAL = SIZE_RESTORED -SIZEICONIC = SIZE_MINIMIZED -SIZEFULLSCREEN = SIZE_MAXIMIZED -SIZEZOOMSHOW = SIZE_MAXSHOW -SIZEZOOMHIDE = SIZE_MAXHIDE -WVR_ALIGNTOP = 16 -WVR_ALIGNLEFT = 32 -WVR_ALIGNBOTTOM = 64 -WVR_ALIGNRIGHT = 128 -WVR_HREDRAW = 256 -WVR_VREDRAW = 512 -WVR_REDRAW = (WVR_HREDRAW | WVR_VREDRAW) -WVR_VALIDRECTS = 1024 -MK_LBUTTON = 1 -MK_RBUTTON = 2 -MK_SHIFT = 4 -MK_CONTROL = 8 -MK_MBUTTON = 16 -TME_HOVER = 1 -TME_LEAVE = 2 -TME_QUERY = 1073741824 -TME_CANCEL = -2147483648 -HOVER_DEFAULT = -1 -WS_OVERLAPPED = 0 -WS_POPUP = -2147483648 -WS_CHILD = 1073741824 -WS_MINIMIZE = 536870912 -WS_VISIBLE = 268435456 -WS_DISABLED = 134217728 -WS_CLIPSIBLINGS = 67108864 -WS_CLIPCHILDREN = 33554432 -WS_MAXIMIZE = 16777216 -WS_CAPTION = 12582912 -WS_BORDER = 8388608 -WS_DLGFRAME = 4194304 -WS_VSCROLL = 2097152 -WS_HSCROLL = 1048576 -WS_SYSMENU = 524288 -WS_THICKFRAME = 262144 -WS_GROUP = 131072 -WS_TABSTOP = 65536 -WS_MINIMIZEBOX = 131072 -WS_MAXIMIZEBOX = 65536 -WS_TILED = WS_OVERLAPPED -WS_ICONIC = WS_MINIMIZE -WS_SIZEBOX = WS_THICKFRAME -WS_OVERLAPPEDWINDOW = (WS_OVERLAPPED - | WS_CAPTION - | WS_SYSMENU - | WS_THICKFRAME - | WS_MINIMIZEBOX - | WS_MAXIMIZEBOX) -WS_POPUPWINDOW = (WS_POPUP - | WS_BORDER - | WS_SYSMENU) -WS_CHILDWINDOW = (WS_CHILD) -WS_TILEDWINDOW = WS_OVERLAPPEDWINDOW -WS_EX_DLGMODALFRAME = 1 -WS_EX_NOPARENTNOTIFY = 4 -WS_EX_TOPMOST = 8 -WS_EX_ACCEPTFILES = 16 -WS_EX_TRANSPARENT = 32 -WS_EX_MDICHILD = 64 -WS_EX_TOOLWINDOW = 128 -WS_EX_WINDOWEDGE = 256 -WS_EX_CLIENTEDGE = 512 -WS_EX_CONTEXTHELP = 1024 -WS_EX_RIGHT = 4096 -WS_EX_LEFT = 0 -WS_EX_RTLREADING = 8192 -WS_EX_LTRREADING = 0 -WS_EX_LEFTSCROLLBAR = 16384 -WS_EX_RIGHTSCROLLBAR = 0 -WS_EX_CONTROLPARENT = 65536 -WS_EX_STATICEDGE = 131072 -WS_EX_APPWINDOW = 262144 -WS_EX_OVERLAPPEDWINDOW = (WS_EX_WINDOWEDGE | WS_EX_CLIENTEDGE) -WS_EX_PALETTEWINDOW = (WS_EX_WINDOWEDGE | WS_EX_TOOLWINDOW | WS_EX_TOPMOST) -WS_EX_LAYERED = 0x00080000 -WS_EX_NOINHERITLAYOUT = 0x00100000 -WS_EX_LAYOUTRTL = 0x00400000 -WS_EX_COMPOSITED = 0x02000000 -WS_EX_NOACTIVATE = 0x08000000 - -CS_VREDRAW = 1 -CS_HREDRAW = 2 -# CS_KEYCVTWINDOW = 0x0004 -CS_DBLCLKS = 8 -CS_OWNDC = 32 -CS_CLASSDC = 64 -CS_PARENTDC = 128 -# CS_NOKEYCVT = 0x0100 -CS_NOCLOSE = 512 -CS_SAVEBITS = 2048 -CS_BYTEALIGNCLIENT = 4096 -CS_BYTEALIGNWINDOW = 8192 -CS_GLOBALCLASS = 16384 -CS_IME = 65536 -PRF_CHECKVISIBLE = 1 -PRF_NONCLIENT = 2 -PRF_CLIENT = 4 -PRF_ERASEBKGND = 8 -PRF_CHILDREN = 16 -PRF_OWNED = 32 -BDR_RAISEDOUTER = 1 -BDR_SUNKENOUTER = 2 -BDR_RAISEDINNER = 4 -BDR_SUNKENINNER = 8 -BDR_OUTER = 3 -BDR_INNER = 12 -# BDR_RAISED = 0x0005 -# BDR_SUNKEN = 0x000a -EDGE_RAISED = (BDR_RAISEDOUTER | BDR_RAISEDINNER) -EDGE_SUNKEN = (BDR_SUNKENOUTER | BDR_SUNKENINNER) -EDGE_ETCHED = (BDR_SUNKENOUTER | BDR_RAISEDINNER) -EDGE_BUMP = (BDR_RAISEDOUTER | BDR_SUNKENINNER) - -# winuser.h line 2879 -ISMEX_NOSEND = 0 -ISMEX_SEND = 1 -ISMEX_NOTIFY = 2 -ISMEX_CALLBACK = 4 -ISMEX_REPLIED = 8 -CW_USEDEFAULT = -2147483648 -FLASHW_STOP = 0 -FLASHW_CAPTION = 1 -FLASHW_TRAY = 2 -FLASHW_ALL = (FLASHW_CAPTION | FLASHW_TRAY) -FLASHW_TIMER = 4 -FLASHW_TIMERNOFG = 12 - -# winuser.h line 7963 -DS_ABSALIGN = 1 -DS_SYSMODAL = 2 -DS_LOCALEDIT = 32 -DS_SETFONT = 64 -DS_MODALFRAME = 128 -DS_NOIDLEMSG = 256 -DS_SETFOREGROUND = 512 -DS_3DLOOK = 4 -DS_FIXEDSYS = 8 -DS_NOFAILCREATE = 16 -DS_CONTROL = 1024 -DS_CENTER = 2048 -DS_CENTERMOUSE = 4096 -DS_CONTEXTHELP = 8192 -DM_GETDEFID = (WM_USER + 0) -DM_SETDEFID = (WM_USER + 1) -DM_REPOSITION = (WM_USER + 2) -# PSM_PAGEINFO = (WM_USER+100) -# PSM_SHEETINFO = (WM_USER+101) -# PSI_SETACTIVE = 0x0001 -# PSI_KILLACTIVE = 0x0002 -# PSI_APPLY = 0x0003 -# PSI_RESET = 0x0004 -# PSI_HASHELP = 0x0005 -# PSI_HELP = 0x0006 -# PSI_CHANGED = 0x0001 -# PSI_GUISTART = 0x0002 -# PSI_REBOOT = 0x0003 -# PSI_GETSIBLINGS = 0x0004 -DC_HASDEFID = 21323 -DLGC_WANTARROWS = 1 -DLGC_WANTTAB = 2 -DLGC_WANTALLKEYS = 4 -DLGC_WANTMESSAGE = 4 -DLGC_HASSETSEL = 8 -DLGC_DEFPUSHBUTTON = 16 -DLGC_UNDEFPUSHBUTTON = 32 -DLGC_RADIOBUTTON = 64 -DLGC_WANTCHARS = 128 -DLGC_STATIC = 256 -DLGC_BUTTON = 8192 -LB_CTLCODE = 0 -LB_OKAY = 0 -LB_ERR = (-1) -LB_ERRSPACE = (-2) -LBN_ERRSPACE = (-2) -LBN_SELCHANGE = 1 -LBN_DBLCLK = 2 -LBN_SELCANCEL = 3 -LBN_SETFOCUS = 4 -LBN_KILLFOCUS = 5 -LB_ADDSTRING = 384 -LB_INSERTSTRING = 385 -LB_DELETESTRING = 386 -LB_SELITEMRANGEEX = 387 -LB_RESETCONTENT = 388 -LB_SETSEL = 389 -LB_SETCURSEL = 390 -LB_GETSEL = 391 -LB_GETCURSEL = 392 -LB_GETTEXT = 393 -LB_GETTEXTLEN = 394 -LB_GETCOUNT = 395 -LB_SELECTSTRING = 396 -LB_DIR = 397 -LB_GETTOPINDEX = 398 -LB_FINDSTRING = 399 -LB_GETSELCOUNT = 400 -LB_GETSELITEMS = 401 -LB_SETTABSTOPS = 402 -LB_GETHORIZONTALEXTENT = 403 -LB_SETHORIZONTALEXTENT = 404 -LB_SETCOLUMNWIDTH = 405 -LB_ADDFILE = 406 -LB_SETTOPINDEX = 407 -LB_GETITEMRECT = 408 -LB_GETITEMDATA = 409 -LB_SETITEMDATA = 410 -LB_SELITEMRANGE = 411 -LB_SETANCHORINDEX = 412 -LB_GETANCHORINDEX = 413 -LB_SETCARETINDEX = 414 -LB_GETCARETINDEX = 415 -LB_SETITEMHEIGHT = 416 -LB_GETITEMHEIGHT = 417 -LB_FINDSTRINGEXACT = 418 -LB_SETLOCALE = 421 -LB_GETLOCALE = 422 -LB_SETCOUNT = 423 -LB_INITSTORAGE = 424 -LB_ITEMFROMPOINT = 425 -LB_MSGMAX = 432 -LBS_NOTIFY = 1 -LBS_SORT = 2 -LBS_NOREDRAW = 4 -LBS_MULTIPLESEL = 8 -LBS_OWNERDRAWFIXED = 16 -LBS_OWNERDRAWVARIABLE = 32 -LBS_HASSTRINGS = 64 -LBS_USETABSTOPS = 128 -LBS_NOINTEGRALHEIGHT = 256 -LBS_MULTICOLUMN = 512 -LBS_WANTKEYBOARDINPUT = 1024 -LBS_EXTENDEDSEL = 2048 -LBS_DISABLENOSCROLL = 4096 -LBS_NODATA = 8192 -LBS_NOSEL = 16384 -LBS_STANDARD = (LBS_NOTIFY | LBS_SORT | WS_VSCROLL | WS_BORDER) -CB_OKAY = 0 -CB_ERR = (-1) -CB_ERRSPACE = (-2) -CBN_ERRSPACE = (-1) -CBN_SELCHANGE = 1 -CBN_DBLCLK = 2 -CBN_SETFOCUS = 3 -CBN_KILLFOCUS = 4 -CBN_EDITCHANGE = 5 -CBN_EDITUPDATE = 6 -CBN_DROPDOWN = 7 -CBN_CLOSEUP = 8 -CBN_SELENDOK = 9 -CBN_SELENDCANCEL = 10 -CBS_SIMPLE = 1 -CBS_DROPDOWN = 2 -CBS_DROPDOWNLIST = 3 -CBS_OWNERDRAWFIXED = 16 -CBS_OWNERDRAWVARIABLE = 32 -CBS_AUTOHSCROLL = 64 -CBS_OEMCONVERT = 128 -CBS_SORT = 256 -CBS_HASSTRINGS = 512 -CBS_NOINTEGRALHEIGHT = 1024 -CBS_DISABLENOSCROLL = 2048 -CBS_UPPERCASE = 8192 -CBS_LOWERCASE = 16384 -CB_GETEDITSEL = 320 -CB_LIMITTEXT = 321 -CB_SETEDITSEL = 322 -CB_ADDSTRING = 323 -CB_DELETESTRING = 324 -CB_DIR = 325 -CB_GETCOUNT = 326 -CB_GETCURSEL = 327 -CB_GETLBTEXT = 328 -CB_GETLBTEXTLEN = 329 -CB_INSERTSTRING = 330 -CB_RESETCONTENT = 331 -CB_FINDSTRING = 332 -CB_SELECTSTRING = 333 -CB_SETCURSEL = 334 -CB_SHOWDROPDOWN = 335 -CB_GETITEMDATA = 336 -CB_SETITEMDATA = 337 -CB_GETDROPPEDCONTROLRECT = 338 -CB_SETITEMHEIGHT = 339 -CB_GETITEMHEIGHT = 340 -CB_SETEXTENDEDUI = 341 -CB_GETEXTENDEDUI = 342 -CB_GETDROPPEDSTATE = 343 -CB_FINDSTRINGEXACT = 344 -CB_SETLOCALE = 345 -CB_GETLOCALE = 346 -CB_GETTOPINDEX = 347 -CB_SETTOPINDEX = 348 -CB_GETHORIZONTALEXTENT = 349 -CB_SETHORIZONTALEXTENT = 350 -CB_GETDROPPEDWIDTH = 351 -CB_SETDROPPEDWIDTH = 352 -CB_INITSTORAGE = 353 -CB_MSGMAX = 354 -SBS_HORZ = 0 -SBS_VERT = 1 -SBS_TOPALIGN = 2 -SBS_LEFTALIGN = 2 -SBS_BOTTOMALIGN = 4 -SBS_RIGHTALIGN = 4 -SBS_SIZEBOXTOPLEFTALIGN = 2 -SBS_SIZEBOXBOTTOMRIGHTALIGN = 4 -SBS_SIZEBOX = 8 -SBS_SIZEGRIP = 16 -SBM_SETPOS = 224 -SBM_GETPOS = 225 -SBM_SETRANGE = 226 -SBM_SETRANGEREDRAW = 230 -SBM_GETRANGE = 227 -SBM_ENABLE_ARROWS = 228 -SBM_SETSCROLLINFO = 233 -SBM_GETSCROLLINFO = 234 -SIF_RANGE = 1 -SIF_PAGE = 2 -SIF_POS = 4 -SIF_DISABLENOSCROLL = 8 -SIF_TRACKPOS = 16 -SIF_ALL = (SIF_RANGE | SIF_PAGE | SIF_POS | SIF_TRACKPOS) -MDIS_ALLCHILDSTYLES = 1 -MDITILE_VERTICAL = 0 -MDITILE_HORIZONTAL = 1 -MDITILE_SKIPDISABLED = 2 - -IMC_GETCANDIDATEPOS = 7 -IMC_SETCANDIDATEPOS = 8 -IMC_GETCOMPOSITIONFONT = 9 -IMC_SETCOMPOSITIONFONT = 10 -IMC_GETCOMPOSITIONWINDOW = 11 -IMC_SETCOMPOSITIONWINDOW = 12 -IMC_GETSTATUSWINDOWPOS = 15 -IMC_SETSTATUSWINDOWPOS = 16 -IMC_CLOSESTATUSWINDOW = 33 -IMC_OPENSTATUSWINDOW = 34 -# Generated by h2py from \msvc20\include\winnt.h -# hacked and split by mhammond. -DELETE = (65536) -READ_CONTROL = (131072) -WRITE_DAC = (262144) -WRITE_OWNER = (524288) -SYNCHRONIZE = (1048576) -STANDARD_RIGHTS_REQUIRED = (983040) -STANDARD_RIGHTS_READ = (READ_CONTROL) -STANDARD_RIGHTS_WRITE = (READ_CONTROL) -STANDARD_RIGHTS_EXECUTE = (READ_CONTROL) -STANDARD_RIGHTS_ALL = (2031616) -SPECIFIC_RIGHTS_ALL = (65535) -ACCESS_SYSTEM_SECURITY = (16777216) -MAXIMUM_ALLOWED = (33554432) -GENERIC_READ = (-2147483648) -GENERIC_WRITE = (1073741824) -GENERIC_EXECUTE = (536870912) -GENERIC_ALL = (268435456) - -SERVICE_KERNEL_DRIVER = 1 -SERVICE_FILE_SYSTEM_DRIVER = 2 -SERVICE_ADAPTER = 4 -SERVICE_RECOGNIZER_DRIVER = 8 -SERVICE_DRIVER = (SERVICE_KERNEL_DRIVER - | SERVICE_FILE_SYSTEM_DRIVER - | SERVICE_RECOGNIZER_DRIVER) -SERVICE_WIN32_OWN_PROCESS = 16 -SERVICE_WIN32_SHARE_PROCESS = 32 -SERVICE_WIN32 = (SERVICE_WIN32_OWN_PROCESS - | SERVICE_WIN32_SHARE_PROCESS) -SERVICE_INTERACTIVE_PROCESS = 256 -SERVICE_TYPE_ALL = (SERVICE_WIN32 - | SERVICE_ADAPTER - | SERVICE_DRIVER - | SERVICE_INTERACTIVE_PROCESS) -SERVICE_BOOT_START = 0 -SERVICE_SYSTEM_START = 1 -SERVICE_AUTO_START = 2 -SERVICE_DEMAND_START = 3 -SERVICE_DISABLED = 4 -SERVICE_ERROR_IGNORE = 0 -SERVICE_ERROR_NORMAL = 1 -SERVICE_ERROR_SEVERE = 2 -SERVICE_ERROR_CRITICAL = 3 -TAPE_ERASE_SHORT = 0 -TAPE_ERASE_LONG = 1 -TAPE_LOAD = 0 -TAPE_UNLOAD = 1 -TAPE_TENSION = 2 -TAPE_LOCK = 3 -TAPE_UNLOCK = 4 -TAPE_FORMAT = 5 -TAPE_SETMARKS = 0 -TAPE_FILEMARKS = 1 -TAPE_SHORT_FILEMARKS = 2 -TAPE_LONG_FILEMARKS = 3 -TAPE_ABSOLUTE_POSITION = 0 -TAPE_LOGICAL_POSITION = 1 -TAPE_PSEUDO_LOGICAL_POSITION = 2 -TAPE_REWIND = 0 -TAPE_ABSOLUTE_BLOCK = 1 -TAPE_LOGICAL_BLOCK = 2 -TAPE_PSEUDO_LOGICAL_BLOCK = 3 -TAPE_SPACE_END_OF_DATA = 4 -TAPE_SPACE_RELATIVE_BLOCKS = 5 -TAPE_SPACE_FILEMARKS = 6 -TAPE_SPACE_SEQUENTIAL_FMKS = 7 -TAPE_SPACE_SETMARKS = 8 -TAPE_SPACE_SEQUENTIAL_SMKS = 9 -TAPE_DRIVE_FIXED = 1 -TAPE_DRIVE_SELECT = 2 -TAPE_DRIVE_INITIATOR = 4 -TAPE_DRIVE_ERASE_SHORT = 16 -TAPE_DRIVE_ERASE_LONG = 32 -TAPE_DRIVE_ERASE_BOP_ONLY = 64 -TAPE_DRIVE_ERASE_IMMEDIATE = 128 -TAPE_DRIVE_TAPE_CAPACITY = 256 -TAPE_DRIVE_TAPE_REMAINING = 512 -TAPE_DRIVE_FIXED_BLOCK = 1024 -TAPE_DRIVE_VARIABLE_BLOCK = 2048 -TAPE_DRIVE_WRITE_PROTECT = 4096 -TAPE_DRIVE_EOT_WZ_SIZE = 8192 -TAPE_DRIVE_ECC = 65536 -TAPE_DRIVE_COMPRESSION = 131072 -TAPE_DRIVE_PADDING = 262144 -TAPE_DRIVE_REPORT_SMKS = 524288 -TAPE_DRIVE_GET_ABSOLUTE_BLK = 1048576 -TAPE_DRIVE_GET_LOGICAL_BLK = 2097152 -TAPE_DRIVE_SET_EOT_WZ_SIZE = 4194304 -TAPE_DRIVE_LOAD_UNLOAD = -2147483647 -TAPE_DRIVE_TENSION = -2147483646 -TAPE_DRIVE_LOCK_UNLOCK = -2147483644 -TAPE_DRIVE_REWIND_IMMEDIATE = -2147483640 -TAPE_DRIVE_SET_BLOCK_SIZE = -2147483632 -TAPE_DRIVE_LOAD_UNLD_IMMED = -2147483616 -TAPE_DRIVE_TENSION_IMMED = -2147483584 -TAPE_DRIVE_LOCK_UNLK_IMMED = -2147483520 -TAPE_DRIVE_SET_ECC = -2147483392 -TAPE_DRIVE_SET_COMPRESSION = -2147483136 -TAPE_DRIVE_SET_PADDING = -2147482624 -TAPE_DRIVE_SET_REPORT_SMKS = -2147481600 -TAPE_DRIVE_ABSOLUTE_BLK = -2147479552 -TAPE_DRIVE_ABS_BLK_IMMED = -2147475456 -TAPE_DRIVE_LOGICAL_BLK = -2147467264 -TAPE_DRIVE_LOG_BLK_IMMED = -2147450880 -TAPE_DRIVE_END_OF_DATA = -2147418112 -TAPE_DRIVE_RELATIVE_BLKS = -2147352576 -TAPE_DRIVE_FILEMARKS = -2147221504 -TAPE_DRIVE_SEQUENTIAL_FMKS = -2146959360 -TAPE_DRIVE_SETMARKS = -2146435072 -TAPE_DRIVE_SEQUENTIAL_SMKS = -2145386496 -TAPE_DRIVE_REVERSE_POSITION = -2143289344 -TAPE_DRIVE_SPACE_IMMEDIATE = -2139095040 -TAPE_DRIVE_WRITE_SETMARKS = -2130706432 -TAPE_DRIVE_WRITE_FILEMARKS = -2113929216 -TAPE_DRIVE_WRITE_SHORT_FMKS = -2080374784 -TAPE_DRIVE_WRITE_LONG_FMKS = -2013265920 -TAPE_DRIVE_WRITE_MARK_IMMED = -1879048192 -TAPE_DRIVE_FORMAT = -1610612736 -TAPE_DRIVE_FORMAT_IMMEDIATE = -1073741824 -TAPE_FIXED_PARTITIONS = 0 -TAPE_SELECT_PARTITIONS = 1 -TAPE_INITIATOR_PARTITIONS = 2 -# Generated by h2py from \msvc20\include\winnt.h -# hacked and split by mhammond. - -APPLICATION_ERROR_MASK = 536870912 -ERROR_SEVERITY_SUCCESS = 0 -ERROR_SEVERITY_INFORMATIONAL = 1073741824 -ERROR_SEVERITY_WARNING = -2147483648 -ERROR_SEVERITY_ERROR = -1073741824 -MINCHAR = 128 -MAXCHAR = 127 -MINSHORT = 32768 -MAXSHORT = 32767 -MINLONG = -2147483648 -MAXLONG = 2147483647 -MAXBYTE = 255 -MAXWORD = 65535 -MAXDWORD = -1 -LANG_NEUTRAL = 0 -LANG_BULGARIAN = 2 -LANG_CHINESE = 4 -LANG_CROATIAN = 26 -LANG_CZECH = 5 -LANG_DANISH = 6 -LANG_DUTCH = 19 -LANG_ENGLISH = 9 -LANG_FINNISH = 11 -LANG_FRENCH = 12 -LANG_GERMAN = 7 -LANG_GREEK = 8 -LANG_HUNGARIAN = 14 -LANG_ICELANDIC = 15 -LANG_ITALIAN = 16 -LANG_JAPANESE = 17 -LANG_KOREAN = 18 -LANG_NORWEGIAN = 20 -LANG_POLISH = 21 -LANG_PORTUGUESE = 22 -LANG_ROMANIAN = 24 -LANG_RUSSIAN = 25 -LANG_SLOVAK = 27 -LANG_SLOVENIAN = 36 -LANG_SPANISH = 10 -LANG_SWEDISH = 29 -LANG_TURKISH = 31 -SUBLANG_NEUTRAL = 0 -SUBLANG_DEFAULT = 1 -SUBLANG_SYS_DEFAULT = 2 -SUBLANG_CHINESE_TRADITIONAL = 1 -SUBLANG_CHINESE_SIMPLIFIED = 2 -SUBLANG_CHINESE_HONGKONG = 3 -SUBLANG_CHINESE_SINGAPORE = 4 -SUBLANG_DUTCH = 1 -SUBLANG_DUTCH_BELGIAN = 2 -SUBLANG_ENGLISH_US = 1 -SUBLANG_ENGLISH_UK = 2 -SUBLANG_ENGLISH_AUS = 3 -SUBLANG_ENGLISH_CAN = 4 -SUBLANG_ENGLISH_NZ = 5 -SUBLANG_ENGLISH_EIRE = 6 -SUBLANG_FRENCH = 1 -SUBLANG_FRENCH_BELGIAN = 2 -SUBLANG_FRENCH_CANADIAN = 3 -SUBLANG_FRENCH_SWISS = 4 -SUBLANG_GERMAN = 1 -SUBLANG_GERMAN_SWISS = 2 -SUBLANG_GERMAN_AUSTRIAN = 3 -SUBLANG_ITALIAN = 1 -SUBLANG_ITALIAN_SWISS = 2 -SUBLANG_NORWEGIAN_BOKMAL = 1 -SUBLANG_NORWEGIAN_NYNORSK = 2 -SUBLANG_PORTUGUESE = 2 -SUBLANG_PORTUGUESE_BRAZILIAN = 1 -SUBLANG_SPANISH = 1 -SUBLANG_SPANISH_MEXICAN = 2 -SUBLANG_SPANISH_MODERN = 3 -SORT_DEFAULT = 0 -SORT_JAPANESE_XJIS = 0 -SORT_JAPANESE_UNICODE = 1 -SORT_CHINESE_BIG5 = 0 -SORT_CHINESE_UNICODE = 1 -SORT_KOREAN_KSC = 0 -SORT_KOREAN_UNICODE = 1 - - -def PRIMARYLANGID(lgid) -> int: - ... - - -def SUBLANGID(lgid) -> int: - ... - - -NLS_VALID_LOCALE_MASK = 1048575 -CONTEXT_PORTABLE_32BIT = 1048576 -CONTEXT_ALPHA = 131072 -CONTEXT_CONTROL = (CONTEXT_ALPHA | 1) -CONTEXT_FLOATING_POINT = (CONTEXT_ALPHA | 2) -CONTEXT_INTEGER = (CONTEXT_ALPHA | 4) -CONTEXT_FULL = (CONTEXT_CONTROL | CONTEXT_FLOATING_POINT | CONTEXT_INTEGER) -SIZE_OF_80387_REGISTERS = 80 -CONTEXT_FULL = (CONTEXT_CONTROL | CONTEXT_FLOATING_POINT | CONTEXT_INTEGER) -CONTEXT_CONTROL = 1 -CONTEXT_FLOATING_POINT = 2 -CONTEXT_INTEGER = 4 -CONTEXT_FULL = (CONTEXT_CONTROL | CONTEXT_FLOATING_POINT | CONTEXT_INTEGER) -PROCESS_TERMINATE = (1) -PROCESS_CREATE_THREAD = (2) -PROCESS_VM_OPERATION = (8) -PROCESS_VM_READ = (16) -PROCESS_VM_WRITE = (32) -PROCESS_DUP_HANDLE = (64) -PROCESS_CREATE_PROCESS = (128) -PROCESS_SET_QUOTA = (256) -PROCESS_SET_INFORMATION = (512) -PROCESS_QUERY_INFORMATION = (1024) -PROCESS_SUSPEND_RESUME = (2048) -PROCESS_QUERY_LIMITED_INFORMATION = (4096) -PROCESS_SET_LIMITED_INFORMATION = (8192) -PROCESS_ALL_ACCESS = (STANDARD_RIGHTS_REQUIRED | SYNCHRONIZE | 4095) -THREAD_TERMINATE = (1) -THREAD_SUSPEND_RESUME = (2) -THREAD_GET_CONTEXT = (8) -THREAD_SET_CONTEXT = (16) -THREAD_SET_INFORMATION = (32) -THREAD_QUERY_INFORMATION = (64) -THREAD_SET_THREAD_TOKEN = (128) -THREAD_IMPERSONATE = (256) -THREAD_DIRECT_IMPERSONATION = (512) -THREAD_SET_LIMITED_INFORMATION = (1024) -THREAD_QUERY_LIMITED_INFORMATION = (2048) -THREAD_RESUME = (4096) -TLS_MINIMUM_AVAILABLE = 64 -EVENT_MODIFY_STATE = 2 -MUTANT_QUERY_STATE = 1 -SEMAPHORE_MODIFY_STATE = 2 -TIME_ZONE_ID_UNKNOWN = 0 -TIME_ZONE_ID_STANDARD = 1 -TIME_ZONE_ID_DAYLIGHT = 2 -PROCESSOR_INTEL_386 = 386 -PROCESSOR_INTEL_486 = 486 -PROCESSOR_INTEL_PENTIUM = 586 -PROCESSOR_INTEL_860 = 860 -PROCESSOR_MIPS_R2000 = 2000 -PROCESSOR_MIPS_R3000 = 3000 -PROCESSOR_MIPS_R4000 = 4000 -PROCESSOR_ALPHA_21064 = 21064 -PROCESSOR_PPC_601 = 601 -PROCESSOR_PPC_603 = 603 -PROCESSOR_PPC_604 = 604 -PROCESSOR_PPC_620 = 620 -SECTION_QUERY = 1 -SECTION_MAP_WRITE = 2 -SECTION_MAP_READ = 4 -SECTION_MAP_EXECUTE = 8 -SECTION_EXTEND_SIZE = 16 -PAGE_NOACCESS = 1 -PAGE_READONLY = 2 -PAGE_READWRITE = 4 -PAGE_WRITECOPY = 8 -PAGE_EXECUTE = 16 -PAGE_EXECUTE_READ = 32 -PAGE_EXECUTE_READWRITE = 64 -PAGE_EXECUTE_WRITECOPY = 128 -PAGE_GUARD = 256 -PAGE_NOCACHE = 512 -MEM_COMMIT = 4096 -MEM_RESERVE = 8192 -MEM_DECOMMIT = 16384 -MEM_RELEASE = 32768 -MEM_FREE = 65536 -MEM_PRIVATE = 131072 -MEM_MAPPED = 262144 -MEM_TOP_DOWN = 1048576 - -# Generated by h2py from \msvc20\include\winnt.h -# hacked and split by mhammond. -SEC_FILE = 8388608 -SEC_IMAGE = 16777216 -SEC_RESERVE = 67108864 -SEC_COMMIT = 134217728 -SEC_NOCACHE = 268435456 -MEM_IMAGE = SEC_IMAGE -FILE_SHARE_READ = 1 -FILE_SHARE_WRITE = 2 -FILE_SHARE_DELETE = 4 -FILE_ATTRIBUTE_READONLY = 1 -FILE_ATTRIBUTE_HIDDEN = 2 -FILE_ATTRIBUTE_SYSTEM = 4 -FILE_ATTRIBUTE_DIRECTORY = 16 -FILE_ATTRIBUTE_ARCHIVE = 32 -FILE_ATTRIBUTE_DEVICE = 64 -FILE_ATTRIBUTE_NORMAL = 128 -FILE_ATTRIBUTE_TEMPORARY = 256 -FILE_ATTRIBUTE_SPARSE_FILE = 512 -FILE_ATTRIBUTE_REPARSE_POINT = 1024 -FILE_ATTRIBUTE_COMPRESSED = 2048 -FILE_ATTRIBUTE_OFFLINE = 4096 -FILE_ATTRIBUTE_NOT_CONTENT_INDEXED = 8192 -FILE_ATTRIBUTE_ENCRYPTED = 16384 -FILE_ATTRIBUTE_VIRTUAL = 65536 -# These FILE_ATTRIBUTE_* flags are apparently old definitions from Windows 95 -# and conflict with current values above - but they live on for b/w compat... -FILE_ATTRIBUTE_ATOMIC_WRITE = 512 -FILE_ATTRIBUTE_XACTION_WRITE = 1024 - -FILE_NOTIFY_CHANGE_FILE_NAME = 1 -FILE_NOTIFY_CHANGE_DIR_NAME = 2 -FILE_NOTIFY_CHANGE_ATTRIBUTES = 4 -FILE_NOTIFY_CHANGE_SIZE = 8 -FILE_NOTIFY_CHANGE_LAST_WRITE = 16 -FILE_NOTIFY_CHANGE_SECURITY = 256 -FILE_CASE_SENSITIVE_SEARCH = 1 -FILE_CASE_PRESERVED_NAMES = 2 -FILE_UNICODE_ON_DISK = 4 -FILE_PERSISTENT_ACLS = 8 -FILE_FILE_COMPRESSION = 16 -FILE_VOLUME_IS_COMPRESSED = 32768 -IO_COMPLETION_MODIFY_STATE = 2 -DUPLICATE_CLOSE_SOURCE = 1 -DUPLICATE_SAME_ACCESS = 2 -SID_MAX_SUB_AUTHORITIES = (15) -SECURITY_NULL_RID = (0) -SECURITY_WORLD_RID = (0) -SECURITY_LOCAL_RID = (0X00000000) -SECURITY_CREATOR_OWNER_RID = (0) -SECURITY_CREATOR_GROUP_RID = (1) -SECURITY_DIALUP_RID = (1) -SECURITY_NETWORK_RID = (2) -SECURITY_BATCH_RID = (3) -SECURITY_INTERACTIVE_RID = (4) -SECURITY_SERVICE_RID = (6) -SECURITY_ANONYMOUS_LOGON_RID = (7) -SECURITY_LOGON_IDS_RID = (5) -SECURITY_LOGON_IDS_RID_COUNT = (3) -SECURITY_LOCAL_SYSTEM_RID = (18) -SECURITY_NT_NON_UNIQUE = (21) -SECURITY_BUILTIN_DOMAIN_RID = (32) -DOMAIN_USER_RID_ADMIN = (500) -DOMAIN_USER_RID_GUEST = (501) -DOMAIN_GROUP_RID_ADMINS = (512) -DOMAIN_GROUP_RID_USERS = (513) -DOMAIN_GROUP_RID_GUESTS = (514) -DOMAIN_ALIAS_RID_ADMINS = (544) -DOMAIN_ALIAS_RID_USERS = (545) -DOMAIN_ALIAS_RID_GUESTS = (546) -DOMAIN_ALIAS_RID_POWER_USERS = (547) -DOMAIN_ALIAS_RID_ACCOUNT_OPS = (548) -DOMAIN_ALIAS_RID_SYSTEM_OPS = (549) -DOMAIN_ALIAS_RID_PRINT_OPS = (550) -DOMAIN_ALIAS_RID_BACKUP_OPS = (551) -DOMAIN_ALIAS_RID_REPLICATOR = (552) -SE_GROUP_MANDATORY = (1) -SE_GROUP_ENABLED_BY_DEFAULT = (2) -SE_GROUP_ENABLED = (4) -SE_GROUP_OWNER = (8) -SE_GROUP_LOGON_ID = (-1073741824) -ACL_REVISION = (2) -ACL_REVISION1 = (1) -ACL_REVISION2 = (2) -ACCESS_ALLOWED_ACE_TYPE = (0) -ACCESS_DENIED_ACE_TYPE = (1) -SYSTEM_AUDIT_ACE_TYPE = (2) -SYSTEM_ALARM_ACE_TYPE = (3) -OBJECT_INHERIT_ACE = (1) -CONTAINER_INHERIT_ACE = (2) -NO_PROPAGATE_INHERIT_ACE = (4) -INHERIT_ONLY_ACE = (8) -VALID_INHERIT_FLAGS = (15) -SUCCESSFUL_ACCESS_ACE_FLAG = (64) -FAILED_ACCESS_ACE_FLAG = (128) -SECURITY_DESCRIPTOR_REVISION = (1) -SECURITY_DESCRIPTOR_REVISION1 = (1) -SECURITY_DESCRIPTOR_MIN_LENGTH = (20) -SE_OWNER_DEFAULTED = (1) -SE_GROUP_DEFAULTED = (2) -SE_DACL_PRESENT = (4) -SE_DACL_DEFAULTED = (8) -SE_SACL_PRESENT = (16) -SE_SACL_DEFAULTED = (32) -SE_SELF_RELATIVE = (32768) -SE_PRIVILEGE_ENABLED_BY_DEFAULT = (1) -SE_PRIVILEGE_ENABLED = (2) -SE_PRIVILEGE_USED_FOR_ACCESS = (-2147483648) -PRIVILEGE_SET_ALL_NECESSARY = (1) -SE_CREATE_TOKEN_NAME = "SeCreateTokenPrivilege" -SE_ASSIGNPRIMARYTOKEN_NAME = "SeAssignPrimaryTokenPrivilege" -SE_LOCK_MEMORY_NAME = "SeLockMemoryPrivilege" -SE_INCREASE_QUOTA_NAME = "SeIncreaseQuotaPrivilege" -SE_UNSOLICITED_INPUT_NAME = "SeUnsolicitedInputPrivilege" -SE_MACHINE_ACCOUNT_NAME = "SeMachineAccountPrivilege" -SE_TCB_NAME = "SeTcbPrivilege" -SE_SECURITY_NAME = "SeSecurityPrivilege" -SE_TAKE_OWNERSHIP_NAME = "SeTakeOwnershipPrivilege" -SE_LOAD_DRIVER_NAME = "SeLoadDriverPrivilege" -SE_SYSTEM_PROFILE_NAME = "SeSystemProfilePrivilege" -SE_SYSTEMTIME_NAME = "SeSystemtimePrivilege" -SE_PROF_SINGLE_PROCESS_NAME = "SeProfileSingleProcessPrivilege" -SE_INC_BASE_PRIORITY_NAME = "SeIncreaseBasePriorityPrivilege" -SE_CREATE_PAGEFILE_NAME = "SeCreatePagefilePrivilege" -SE_CREATE_PERMANENT_NAME = "SeCreatePermanentPrivilege" -SE_BACKUP_NAME = "SeBackupPrivilege" -SE_RESTORE_NAME = "SeRestorePrivilege" -SE_SHUTDOWN_NAME = "SeShutdownPrivilege" -SE_DEBUG_NAME = "SeDebugPrivilege" -SE_AUDIT_NAME = "SeAuditPrivilege" -SE_SYSTEM_ENVIRONMENT_NAME = "SeSystemEnvironmentPrivilege" -SE_CHANGE_NOTIFY_NAME = "SeChangeNotifyPrivilege" -SE_REMOTE_SHUTDOWN_NAME = "SeRemoteShutdownPrivilege" - -TOKEN_ASSIGN_PRIMARY = (1) -TOKEN_DUPLICATE = (2) -TOKEN_IMPERSONATE = (4) -TOKEN_QUERY = (8) -TOKEN_QUERY_SOURCE = (16) -TOKEN_ADJUST_PRIVILEGES = (32) -TOKEN_ADJUST_GROUPS = (64) -TOKEN_ADJUST_DEFAULT = (128) -TOKEN_ALL_ACCESS = (STANDARD_RIGHTS_REQUIRED - | TOKEN_ASSIGN_PRIMARY - | TOKEN_DUPLICATE - | TOKEN_IMPERSONATE - | TOKEN_QUERY - | TOKEN_QUERY_SOURCE - | TOKEN_ADJUST_PRIVILEGES - | TOKEN_ADJUST_GROUPS - | TOKEN_ADJUST_DEFAULT) -TOKEN_READ = (STANDARD_RIGHTS_READ - | TOKEN_QUERY) -TOKEN_WRITE = (STANDARD_RIGHTS_WRITE - | TOKEN_ADJUST_PRIVILEGES - | TOKEN_ADJUST_GROUPS - | TOKEN_ADJUST_DEFAULT) -TOKEN_EXECUTE = (STANDARD_RIGHTS_EXECUTE) -TOKEN_SOURCE_LENGTH = 8 - -KEY_QUERY_VALUE = (1) -KEY_SET_VALUE = (2) -KEY_CREATE_SUB_KEY = (4) -KEY_ENUMERATE_SUB_KEYS = (8) -KEY_NOTIFY = (16) -KEY_CREATE_LINK = (32) -KEY_WOW64_32KEY = 512 -KEY_WOW64_64KEY = 256 -KEY_WOW64_RES = 768 -KEY_READ = ((STANDARD_RIGHTS_READ - | KEY_QUERY_VALUE - | KEY_ENUMERATE_SUB_KEYS - | KEY_NOTIFY) - - & (~SYNCHRONIZE)) -KEY_WRITE = ((STANDARD_RIGHTS_WRITE - | KEY_SET_VALUE - | KEY_CREATE_SUB_KEY) - - & (~SYNCHRONIZE)) -KEY_EXECUTE = ((KEY_READ) - - & (~SYNCHRONIZE)) -KEY_ALL_ACCESS = ((STANDARD_RIGHTS_ALL - | KEY_QUERY_VALUE - | KEY_SET_VALUE - | KEY_CREATE_SUB_KEY - | KEY_ENUMERATE_SUB_KEYS - | KEY_NOTIFY - | KEY_CREATE_LINK) - - & (~SYNCHRONIZE)) -REG_NOTIFY_CHANGE_ATTRIBUTES = (2) -REG_NOTIFY_CHANGE_SECURITY = (8) -REG_RESOURCE_REQUIREMENTS_LIST = (10) -REG_NONE = (0) # No value type -REG_SZ = (1) # Unicode nul terminated string -REG_EXPAND_SZ = (2) # Unicode nul terminated string -# (with environment variable references) -REG_BINARY = (3) # Free form binary -REG_DWORD = (4) # 32-bit number -REG_DWORD_LITTLE_ENDIAN = (4) # 32-bit number (same as REG_DWORD) -REG_DWORD_BIG_ENDIAN = (5) # 32-bit number -REG_LINK = (6) # Symbolic Link (unicode) -REG_MULTI_SZ = (7) # Multiple Unicode strings -REG_RESOURCE_LIST = (8) # Resource list in the resource map -REG_FULL_RESOURCE_DESCRIPTOR = (9) # Resource list in the hardware description -REG_RESOURCE_REQUIREMENTS_LIST = (10) -REG_QWORD = (11) # 64-bit number -REG_QWORD_LITTLE_ENDIAN = (11) # 64-bit number (same as REG_QWORD) - - -# Generated by h2py from \msvc20\include\winnt.h -# hacked and split by mhammond. -# Included from string.h -_NLSCMPERROR = 2147483647 -NULL = 0 -HEAP_NO_SERIALIZE = 1 -HEAP_GROWABLE = 2 -HEAP_GENERATE_EXCEPTIONS = 4 -HEAP_ZERO_MEMORY = 8 -HEAP_REALLOC_IN_PLACE_ONLY = 16 -HEAP_TAIL_CHECKING_ENABLED = 32 -HEAP_FREE_CHECKING_ENABLED = 64 -HEAP_DISABLE_COALESCE_ON_FREE = 128 -IS_TEXT_UNICODE_ASCII16 = 1 -IS_TEXT_UNICODE_REVERSE_ASCII16 = 16 -IS_TEXT_UNICODE_STATISTICS = 2 -IS_TEXT_UNICODE_REVERSE_STATISTICS = 32 -IS_TEXT_UNICODE_CONTROLS = 4 -IS_TEXT_UNICODE_REVERSE_CONTROLS = 64 -IS_TEXT_UNICODE_SIGNATURE = 8 -IS_TEXT_UNICODE_REVERSE_SIGNATURE = 128 -IS_TEXT_UNICODE_ILLEGAL_CHARS = 256 -IS_TEXT_UNICODE_ODD_LENGTH = 512 -IS_TEXT_UNICODE_DBCS_LEADBYTE = 1024 -IS_TEXT_UNICODE_NULL_BYTES = 4096 -IS_TEXT_UNICODE_UNICODE_MASK = 15 -IS_TEXT_UNICODE_REVERSE_MASK = 240 -IS_TEXT_UNICODE_NOT_UNICODE_MASK = 3840 -IS_TEXT_UNICODE_NOT_ASCII_MASK = 61440 -COMPRESSION_FORMAT_NONE = (0) -COMPRESSION_FORMAT_DEFAULT = (1) -COMPRESSION_FORMAT_LZNT1 = (2) -COMPRESSION_ENGINE_STANDARD = (0) -COMPRESSION_ENGINE_MAXIMUM = (256) -MESSAGE_RESOURCE_UNICODE = 1 -RTL_CRITSECT_TYPE = 0 -RTL_RESOURCE_TYPE = 1 -DLL_PROCESS_ATTACH = 1 -DLL_THREAD_ATTACH = 2 -DLL_THREAD_DETACH = 3 -DLL_PROCESS_DETACH = 0 -EVENTLOG_SEQUENTIAL_READ = 0X0001 -EVENTLOG_SEEK_READ = 0X0002 -EVENTLOG_FORWARDS_READ = 0X0004 -EVENTLOG_BACKWARDS_READ = 0X0008 -EVENTLOG_SUCCESS = 0X0000 -EVENTLOG_ERROR_TYPE = 1 -EVENTLOG_WARNING_TYPE = 2 -EVENTLOG_INFORMATION_TYPE = 4 -EVENTLOG_AUDIT_SUCCESS = 8 -EVENTLOG_AUDIT_FAILURE = 16 -EVENTLOG_START_PAIRED_EVENT = 1 -EVENTLOG_END_PAIRED_EVENT = 2 -EVENTLOG_END_ALL_PAIRED_EVENTS = 4 -EVENTLOG_PAIRED_EVENT_ACTIVE = 8 -EVENTLOG_PAIRED_EVENT_INACTIVE = 16 -# Generated by h2py from \msvc20\include\winnt.h -# hacked and split by mhammond. -OWNER_SECURITY_INFORMATION = (0X00000001) -GROUP_SECURITY_INFORMATION = (0X00000002) -DACL_SECURITY_INFORMATION = (0X00000004) -SACL_SECURITY_INFORMATION = (0X00000008) -IMAGE_SIZEOF_FILE_HEADER = 20 -IMAGE_FILE_MACHINE_UNKNOWN = 0 -IMAGE_NUMBEROF_DIRECTORY_ENTRIES = 16 -IMAGE_SIZEOF_ROM_OPTIONAL_HEADER = 56 -IMAGE_SIZEOF_STD_OPTIONAL_HEADER = 28 -IMAGE_SIZEOF_NT_OPTIONAL_HEADER = 224 -IMAGE_NT_OPTIONAL_HDR_MAGIC = 267 -IMAGE_ROM_OPTIONAL_HDR_MAGIC = 263 -IMAGE_SIZEOF_SHORT_NAME = 8 -IMAGE_SIZEOF_SECTION_HEADER = 40 -IMAGE_SIZEOF_SYMBOL = 18 -IMAGE_SYM_CLASS_NULL = 0 -IMAGE_SYM_CLASS_AUTOMATIC = 1 -IMAGE_SYM_CLASS_EXTERNAL = 2 -IMAGE_SYM_CLASS_STATIC = 3 -IMAGE_SYM_CLASS_REGISTER = 4 -IMAGE_SYM_CLASS_EXTERNAL_DEF = 5 -IMAGE_SYM_CLASS_LABEL = 6 -IMAGE_SYM_CLASS_UNDEFINED_LABEL = 7 -IMAGE_SYM_CLASS_MEMBER_OF_STRUCT = 8 -IMAGE_SYM_CLASS_ARGUMENT = 9 -IMAGE_SYM_CLASS_STRUCT_TAG = 10 -IMAGE_SYM_CLASS_MEMBER_OF_UNION = 11 -IMAGE_SYM_CLASS_UNION_TAG = 12 -IMAGE_SYM_CLASS_TYPE_DEFINITION = 13 -IMAGE_SYM_CLASS_UNDEFINED_STATIC = 14 -IMAGE_SYM_CLASS_ENUM_TAG = 15 -IMAGE_SYM_CLASS_MEMBER_OF_ENUM = 16 -IMAGE_SYM_CLASS_REGISTER_PARAM = 17 -IMAGE_SYM_CLASS_BIT_FIELD = 18 -IMAGE_SYM_CLASS_BLOCK = 100 -IMAGE_SYM_CLASS_FUNCTION = 101 -IMAGE_SYM_CLASS_END_OF_STRUCT = 102 -IMAGE_SYM_CLASS_FILE = 103 -IMAGE_SYM_CLASS_SECTION = 104 -IMAGE_SYM_CLASS_WEAK_EXTERNAL = 105 -N_BTMASK = 15 -N_TMASK = 48 -N_TMASK1 = 192 -N_TMASK2 = 240 -N_BTSHFT = 4 -N_TSHIFT = 2 -IMAGE_SIZEOF_AUX_SYMBOL = 18 -IMAGE_COMDAT_SELECT_NODUPLICATES = 1 -IMAGE_COMDAT_SELECT_ANY = 2 -IMAGE_COMDAT_SELECT_SAME_SIZE = 3 -IMAGE_COMDAT_SELECT_EXACT_MATCH = 4 -IMAGE_COMDAT_SELECT_ASSOCIATIVE = 5 -IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY = 1 -IMAGE_WEAK_EXTERN_SEARCH_LIBRARY = 2 -IMAGE_WEAK_EXTERN_SEARCH_ALIAS = 3 -IMAGE_SIZEOF_RELOCATION = 10 -IMAGE_REL_I386_SECTION = 10 -IMAGE_REL_I386_SECREL = 11 -IMAGE_REL_MIPS_REFHALF = 1 -IMAGE_REL_MIPS_REFWORD = 2 -IMAGE_REL_MIPS_JMPADDR = 3 -IMAGE_REL_MIPS_REFHI = 4 -IMAGE_REL_MIPS_REFLO = 5 -IMAGE_REL_MIPS_GPREL = 6 -IMAGE_REL_MIPS_LITERAL = 7 -IMAGE_REL_MIPS_SECTION = 10 -IMAGE_REL_MIPS_SECREL = 11 -IMAGE_REL_MIPS_REFWORDNB = 34 -IMAGE_REL_MIPS_PAIR = 37 -IMAGE_REL_ALPHA_ABSOLUTE = 0 -IMAGE_REL_ALPHA_REFLONG = 1 -IMAGE_REL_ALPHA_REFQUAD = 2 -IMAGE_REL_ALPHA_GPREL32 = 3 -IMAGE_REL_ALPHA_LITERAL = 4 -IMAGE_REL_ALPHA_LITUSE = 5 -IMAGE_REL_ALPHA_GPDISP = 6 -IMAGE_REL_ALPHA_BRADDR = 7 -IMAGE_REL_ALPHA_HINT = 8 -IMAGE_REL_ALPHA_INLINE_REFLONG = 9 -IMAGE_REL_ALPHA_REFHI = 10 -IMAGE_REL_ALPHA_REFLO = 11 -IMAGE_REL_ALPHA_PAIR = 12 -IMAGE_REL_ALPHA_MATCH = 13 -IMAGE_REL_ALPHA_SECTION = 14 -IMAGE_REL_ALPHA_SECREL = 15 -IMAGE_REL_ALPHA_REFLONGNB = 16 -IMAGE_SIZEOF_BASE_RELOCATION = 8 -IMAGE_REL_BASED_ABSOLUTE = 0 -IMAGE_REL_BASED_HIGH = 1 -IMAGE_REL_BASED_LOW = 2 -IMAGE_REL_BASED_HIGHLOW = 3 -IMAGE_REL_BASED_HIGHADJ = 4 -IMAGE_REL_BASED_MIPS_JMPADDR = 5 -IMAGE_SIZEOF_LINENUMBER = 6 -IMAGE_ARCHIVE_START_SIZE = 8 -IMAGE_ARCHIVE_START = "!\n" -IMAGE_ARCHIVE_END = "`\n" -IMAGE_ARCHIVE_PAD = "\n" -IMAGE_ARCHIVE_LINKER_MEMBER = "/ " -IMAGE_ARCHIVE_LONGNAMES_MEMBER = "// " -IMAGE_SIZEOF_ARCHIVE_MEMBER_HDR = 60 -IMAGE_ORDINAL_FLAG = -2147483648 - - -def IMAGE_SNAP_BY_ORDINAL(Ordinal) -> bool: - ... - - -def IMAGE_ORDINAL(Ordinal) -> int: - ... - - -IMAGE_RESOURCE_NAME_IS_STRING = -2147483648 -IMAGE_RESOURCE_DATA_IS_DIRECTORY = -2147483648 -IMAGE_DEBUG_TYPE_UNKNOWN = 0 -IMAGE_DEBUG_TYPE_COFF = 1 -IMAGE_DEBUG_TYPE_CODEVIEW = 2 -IMAGE_DEBUG_TYPE_FPO = 3 -IMAGE_DEBUG_TYPE_MISC = 4 -IMAGE_DEBUG_TYPE_EXCEPTION = 5 -IMAGE_DEBUG_TYPE_FIXUP = 6 -IMAGE_DEBUG_TYPE_OMAP_TO_SRC = 7 -IMAGE_DEBUG_TYPE_OMAP_FROM_SRC = 8 -FRAME_FPO = 0 -FRAME_TRAP = 1 -FRAME_TSS = 2 -SIZEOF_RFPO_DATA = 16 -IMAGE_DEBUG_MISC_EXENAME = 1 -IMAGE_SEPARATE_DEBUG_SIGNATURE = 18756 -# Generated by h2py from \msvcnt\include\wingdi.h -# hacked and split manually by mhammond. -NEWFRAME = 1 -ABORTDOC = 2 -NEXTBAND = 3 -SETCOLORTABLE = 4 -GETCOLORTABLE = 5 -FLUSHOUTPUT = 6 -DRAFTMODE = 7 -QUERYESCSUPPORT = 8 -SETABORTPROC = 9 -STARTDOC = 10 -ENDDOC = 11 -GETPHYSPAGESIZE = 12 -GETPRINTINGOFFSET = 13 -GETSCALINGFACTOR = 14 -MFCOMMENT = 15 -GETPENWIDTH = 16 -SETCOPYCOUNT = 17 -SELECTPAPERSOURCE = 18 -DEVICEDATA = 19 -PASSTHROUGH = 19 -GETTECHNOLGY = 20 -GETTECHNOLOGY = 20 -SETLINECAP = 21 -SETLINEJOIN = 22 -SETMITERLIMIT = 23 -BANDINFO = 24 -DRAWPATTERNRECT = 25 -GETVECTORPENSIZE = 26 -GETVECTORBRUSHSIZE = 27 -ENABLEDUPLEX = 28 -GETSETPAPERBINS = 29 -GETSETPRINTORIENT = 30 -ENUMPAPERBINS = 31 -SETDIBSCALING = 32 -EPSPRINTING = 33 -ENUMPAPERMETRICS = 34 -GETSETPAPERMETRICS = 35 -POSTSCRIPT_DATA = 37 -POSTSCRIPT_IGNORE = 38 -MOUSETRAILS = 39 -GETDEVICEUNITS = 42 -GETEXTENDEDTEXTMETRICS = 256 -GETEXTENTTABLE = 257 -GETPAIRKERNTABLE = 258 -GETTRACKKERNTABLE = 259 -EXTTEXTOUT = 512 -GETFACENAME = 513 -DOWNLOADFACE = 514 -ENABLERELATIVEWIDTHS = 768 -ENABLEPAIRKERNING = 769 -SETKERNTRACK = 770 -SETALLJUSTVALUES = 771 -SETCHARSET = 772 -STRETCHBLT = 2048 -GETSETSCREENPARAMS = 3072 -BEGIN_PATH = 4096 -CLIP_TO_PATH = 4097 -END_PATH = 4098 -EXT_DEVICE_CAPS = 4099 -RESTORE_CTM = 4100 -SAVE_CTM = 4101 -SET_ARC_DIRECTION = 4102 -SET_BACKGROUND_COLOR = 4103 -SET_POLY_MODE = 4104 -SET_SCREEN_ANGLE = 4105 -SET_SPREAD = 4106 -TRANSFORM_CTM = 4107 -SET_CLIP_BOX = 4108 -SET_BOUNDS = 4109 -SET_MIRROR_MODE = 4110 -OPENCHANNEL = 4110 -DOWNLOADHEADER = 4111 -CLOSECHANNEL = 4112 -POSTSCRIPT_PASSTHROUGH = 4115 -ENCAPSULATED_POSTSCRIPT = 4116 -SP_NOTREPORTED = 16384 -SP_ERROR = (-1) -SP_APPABORT = (-2) -SP_USERABORT = (-3) -SP_OUTOFDISK = (-4) -SP_OUTOFMEMORY = (-5) -PR_JOBSTATUS = 0 - -# GDI object types -OBJ_PEN = 1 -OBJ_BRUSH = 2 -OBJ_DC = 3 -OBJ_METADC = 4 -OBJ_PAL = 5 -OBJ_FONT = 6 -OBJ_BITMAP = 7 -OBJ_REGION = 8 -OBJ_METAFILE = 9 -OBJ_MEMDC = 10 -OBJ_EXTPEN = 11 -OBJ_ENHMETADC = 12 -OBJ_ENHMETAFILE = 13 -OBJ_COLORSPACE = 14 - -MWT_IDENTITY = 1 -MWT_LEFTMULTIPLY = 2 -MWT_RIGHTMULTIPLY = 3 -MWT_MIN = MWT_IDENTITY -MWT_MAX = MWT_RIGHTMULTIPLY -BI_RGB = 0 -BI_RLE8 = 1 -BI_RLE4 = 2 -BI_BITFIELDS = 3 -TMPF_FIXED_PITCH = 1 -TMPF_VECTOR = 2 -TMPF_DEVICE = 8 -TMPF_TRUETYPE = 4 -NTM_REGULAR = 64 -NTM_BOLD = 32 -NTM_ITALIC = 1 -LF_FACESIZE = 32 -LF_FULLFACESIZE = 64 -OUT_DEFAULT_PRECIS = 0 -OUT_STRING_PRECIS = 1 -OUT_CHARACTER_PRECIS = 2 -OUT_STROKE_PRECIS = 3 -OUT_TT_PRECIS = 4 -OUT_DEVICE_PRECIS = 5 -OUT_RASTER_PRECIS = 6 -OUT_TT_ONLY_PRECIS = 7 -OUT_OUTLINE_PRECIS = 8 -CLIP_DEFAULT_PRECIS = 0 -CLIP_CHARACTER_PRECIS = 1 -CLIP_STROKE_PRECIS = 2 -CLIP_MASK = 15 -CLIP_LH_ANGLES = (1 << 4) -CLIP_TT_ALWAYS = (2 << 4) -CLIP_EMBEDDED = (8 << 4) -DEFAULT_QUALITY = 0 -DRAFT_QUALITY = 1 -PROOF_QUALITY = 2 -NONANTIALIASED_QUALITY = 3 -ANTIALIASED_QUALITY = 4 -CLEARTYPE_QUALITY = 5 -CLEARTYPE_NATURAL_QUALITY = 6 -DEFAULT_PITCH = 0 -FIXED_PITCH = 1 -VARIABLE_PITCH = 2 -ANSI_CHARSET = 0 -DEFAULT_CHARSET = 1 -SYMBOL_CHARSET = 2 -SHIFTJIS_CHARSET = 128 -HANGEUL_CHARSET = 129 -CHINESEBIG5_CHARSET = 136 -OEM_CHARSET = 255 -JOHAB_CHARSET = 130 -HEBREW_CHARSET = 177 -ARABIC_CHARSET = 178 -GREEK_CHARSET = 161 -TURKISH_CHARSET = 162 -VIETNAMESE_CHARSET = 163 -THAI_CHARSET = 222 -EASTEUROPE_CHARSET = 238 -RUSSIAN_CHARSET = 204 -MAC_CHARSET = 77 -BALTIC_CHARSET = 186 -FF_DONTCARE = (0 << 4) -FF_ROMAN = (1 << 4) -FF_SWISS = (2 << 4) -FF_MODERN = (3 << 4) -FF_SCRIPT = (4 << 4) -FF_DECORATIVE = (5 << 4) -FW_DONTCARE = 0 -FW_THIN = 100 -FW_EXTRALIGHT = 200 -FW_LIGHT = 300 -FW_NORMAL = 400 -FW_MEDIUM = 500 -FW_SEMIBOLD = 600 -FW_BOLD = 700 -FW_EXTRABOLD = 800 -FW_HEAVY = 900 -FW_ULTRALIGHT = FW_EXTRALIGHT -FW_REGULAR = FW_NORMAL -FW_DEMIBOLD = FW_SEMIBOLD -FW_ULTRABOLD = FW_EXTRABOLD -FW_BLACK = FW_HEAVY -# Generated by h2py from \msvcnt\include\wingdi.h -# hacked and split manually by mhammond. -BS_SOLID = 0 -BS_NULL = 1 -BS_HOLLOW = BS_NULL -BS_HATCHED = 2 -BS_PATTERN = 3 -BS_INDEXED = 4 -BS_DIBPATTERN = 5 -BS_DIBPATTERNPT = 6 -BS_PATTERN8X8 = 7 -BS_DIBPATTERN8X8 = 8 -HS_HORIZONTAL = 0 -HS_VERTICAL = 1 -HS_FDIAGONAL = 2 -HS_BDIAGONAL = 3 -HS_CROSS = 4 -HS_DIAGCROSS = 5 -HS_FDIAGONAL1 = 6 -HS_BDIAGONAL1 = 7 -HS_SOLID = 8 -HS_DENSE1 = 9 -HS_DENSE2 = 10 -HS_DENSE3 = 11 -HS_DENSE4 = 12 -HS_DENSE5 = 13 -HS_DENSE6 = 14 -HS_DENSE7 = 15 -HS_DENSE8 = 16 -HS_NOSHADE = 17 -HS_HALFTONE = 18 -HS_SOLIDCLR = 19 -HS_DITHEREDCLR = 20 -HS_SOLIDTEXTCLR = 21 -HS_DITHEREDTEXTCLR = 22 -HS_SOLIDBKCLR = 23 -HS_DITHEREDBKCLR = 24 -HS_API_MAX = 25 -PS_SOLID = 0 -PS_DASH = 1 -PS_DOT = 2 -PS_DASHDOT = 3 -PS_DASHDOTDOT = 4 -PS_NULL = 5 -PS_INSIDEFRAME = 6 -PS_USERSTYLE = 7 -PS_ALTERNATE = 8 -PS_STYLE_MASK = 15 -PS_ENDCAP_ROUND = 0 -PS_ENDCAP_SQUARE = 256 -PS_ENDCAP_FLAT = 512 -PS_ENDCAP_MASK = 3840 -PS_JOIN_ROUND = 0 -PS_JOIN_BEVEL = 4096 -PS_JOIN_MITER = 8192 -PS_JOIN_MASK = 61440 -PS_COSMETIC = 0 -PS_GEOMETRIC = 65536 -PS_TYPE_MASK = 983040 -AD_COUNTERCLOCKWISE = 1 -AD_CLOCKWISE = 2 -DRIVERVERSION = 0 -TECHNOLOGY = 2 -HORZSIZE = 4 -VERTSIZE = 6 -HORZRES = 8 -VERTRES = 10 -BITSPIXEL = 12 -PLANES = 14 -NUMBRUSHES = 16 -NUMPENS = 18 -NUMMARKERS = 20 -NUMFONTS = 22 -NUMCOLORS = 24 -PDEVICESIZE = 26 -CURVECAPS = 28 -LINECAPS = 30 -POLYGONALCAPS = 32 -TEXTCAPS = 34 -CLIPCAPS = 36 -RASTERCAPS = 38 -ASPECTX = 40 -ASPECTY = 42 -ASPECTXY = 44 -LOGPIXELSX = 88 -LOGPIXELSY = 90 -SIZEPALETTE = 104 -NUMRESERVED = 106 -COLORRES = 108 - -PHYSICALWIDTH = 110 -PHYSICALHEIGHT = 111 -PHYSICALOFFSETX = 112 -PHYSICALOFFSETY = 113 -SCALINGFACTORX = 114 -SCALINGFACTORY = 115 -VREFRESH = 116 -DESKTOPVERTRES = 117 -DESKTOPHORZRES = 118 -BLTALIGNMENT = 119 -SHADEBLENDCAPS = 120 -COLORMGMTCAPS = 121 - -DT_PLOTTER = 0 -DT_RASDISPLAY = 1 -DT_RASPRINTER = 2 -DT_RASCAMERA = 3 -DT_CHARSTREAM = 4 -DT_METAFILE = 5 -DT_DISPFILE = 6 -CC_NONE = 0 -CC_CIRCLES = 1 -CC_PIE = 2 -CC_CHORD = 4 -CC_ELLIPSES = 8 -CC_WIDE = 16 -CC_STYLED = 32 -CC_WIDESTYLED = 64 -CC_INTERIORS = 128 -CC_ROUNDRECT = 256 -LC_NONE = 0 -LC_POLYLINE = 2 -LC_MARKER = 4 -LC_POLYMARKER = 8 -LC_WIDE = 16 -LC_STYLED = 32 -LC_WIDESTYLED = 64 -LC_INTERIORS = 128 -PC_NONE = 0 -PC_POLYGON = 1 -PC_RECTANGLE = 2 -PC_WINDPOLYGON = 4 -PC_TRAPEZOID = 4 -PC_SCANLINE = 8 -PC_WIDE = 16 -PC_STYLED = 32 -PC_WIDESTYLED = 64 -PC_INTERIORS = 128 -CP_NONE = 0 -CP_RECTANGLE = 1 -CP_REGION = 2 -TC_OP_CHARACTER = 1 -TC_OP_STROKE = 2 -TC_CP_STROKE = 4 -TC_CR_90 = 8 -TC_CR_ANY = 16 -TC_SF_X_YINDEP = 32 -TC_SA_DOUBLE = 64 -TC_SA_INTEGER = 128 -TC_SA_CONTIN = 256 -TC_EA_DOUBLE = 512 -TC_IA_ABLE = 1024 -TC_UA_ABLE = 2048 -TC_SO_ABLE = 4096 -TC_RA_ABLE = 8192 -TC_VA_ABLE = 16384 -TC_RESERVED = 32768 -TC_SCROLLBLT = 65536 -RC_BITBLT = 1 -RC_BANDING = 2 -RC_SCALING = 4 -RC_BITMAP64 = 8 -RC_GDI20_OUTPUT = 16 -RC_GDI20_STATE = 32 -RC_SAVEBITMAP = 64 -RC_DI_BITMAP = 128 -RC_PALETTE = 256 -RC_DIBTODEV = 512 -RC_BIGFONT = 1024 -RC_STRETCHBLT = 2048 -RC_FLOODFILL = 4096 -RC_STRETCHDIB = 8192 -RC_OP_DX_OUTPUT = 16384 -RC_DEVBITS = 32768 -DIB_RGB_COLORS = 0 -DIB_PAL_COLORS = 1 -DIB_PAL_INDICES = 2 -DIB_PAL_PHYSINDICES = 2 -DIB_PAL_LOGINDICES = 4 -SYSPAL_ERROR = 0 -SYSPAL_STATIC = 1 -SYSPAL_NOSTATIC = 2 -CBM_CREATEDIB = 2 -CBM_INIT = 4 -FLOODFILLBORDER = 0 -FLOODFILLSURFACE = 1 -CCHDEVICENAME = 32 -CCHFORMNAME = 32 -# Generated by h2py from \msvcnt\include\wingdi.h -# hacked and split manually by mhammond. - -# DEVMODE.dmFields -DM_SPECVERSION = 800 -DM_ORIENTATION = 1 -DM_PAPERSIZE = 2 -DM_PAPERLENGTH = 4 -DM_PAPERWIDTH = 8 -DM_SCALE = 16 -DM_POSITION = 32 -DM_NUP = 64 -DM_DISPLAYORIENTATION = 128 -DM_COPIES = 256 -DM_DEFAULTSOURCE = 512 -DM_PRINTQUALITY = 1024 -DM_COLOR = 2048 -DM_DUPLEX = 4096 -DM_YRESOLUTION = 8192 -DM_TTOPTION = 16384 -DM_COLLATE = 32768 -DM_FORMNAME = 65536 -DM_LOGPIXELS = 131072 -DM_BITSPERPEL = 262144 -DM_PELSWIDTH = 524288 -DM_PELSHEIGHT = 1048576 -DM_DISPLAYFLAGS = 2097152 -DM_DISPLAYFREQUENCY = 4194304 -DM_ICMMETHOD = 8388608 -DM_ICMINTENT = 16777216 -DM_MEDIATYPE = 33554432 -DM_DITHERTYPE = 67108864 -DM_PANNINGWIDTH = 134217728 -DM_PANNINGHEIGHT = 268435456 -DM_DISPLAYFIXEDOUTPUT = 536870912 - -# DEVMODE.dmOrientation -DMORIENT_PORTRAIT = 1 -DMORIENT_LANDSCAPE = 2 - -# DEVMODE.dmDisplayOrientation -DMDO_DEFAULT = 0 -DMDO_90 = 1 -DMDO_180 = 2 -DMDO_270 = 3 - -# DEVMODE.dmDisplayFixedOutput -DMDFO_DEFAULT = 0 -DMDFO_STRETCH = 1 -DMDFO_CENTER = 2 - -# DEVMODE.dmPaperSize -DMPAPER_LETTER = 1 -DMPAPER_LETTERSMALL = 2 -DMPAPER_TABLOID = 3 -DMPAPER_LEDGER = 4 -DMPAPER_LEGAL = 5 -DMPAPER_STATEMENT = 6 -DMPAPER_EXECUTIVE = 7 -DMPAPER_A3 = 8 -DMPAPER_A4 = 9 -DMPAPER_A4SMALL = 10 -DMPAPER_A5 = 11 -DMPAPER_B4 = 12 -DMPAPER_B5 = 13 -DMPAPER_FOLIO = 14 -DMPAPER_QUARTO = 15 -DMPAPER_10X14 = 16 -DMPAPER_11X17 = 17 -DMPAPER_NOTE = 18 -DMPAPER_ENV_9 = 19 -DMPAPER_ENV_10 = 20 -DMPAPER_ENV_11 = 21 -DMPAPER_ENV_12 = 22 -DMPAPER_ENV_14 = 23 -DMPAPER_CSHEET = 24 -DMPAPER_DSHEET = 25 -DMPAPER_ESHEET = 26 -DMPAPER_ENV_DL = 27 -DMPAPER_ENV_C5 = 28 -DMPAPER_ENV_C3 = 29 -DMPAPER_ENV_C4 = 30 -DMPAPER_ENV_C6 = 31 -DMPAPER_ENV_C65 = 32 -DMPAPER_ENV_B4 = 33 -DMPAPER_ENV_B5 = 34 -DMPAPER_ENV_B6 = 35 -DMPAPER_ENV_ITALY = 36 -DMPAPER_ENV_MONARCH = 37 -DMPAPER_ENV_PERSONAL = 38 -DMPAPER_FANFOLD_US = 39 -DMPAPER_FANFOLD_STD_GERMAN = 40 -DMPAPER_FANFOLD_LGL_GERMAN = 41 -DMPAPER_ISO_B4 = 42 -DMPAPER_JAPANESE_POSTCARD = 43 -DMPAPER_9X11 = 44 -DMPAPER_10X11 = 45 -DMPAPER_15X11 = 46 -DMPAPER_ENV_INVITE = 47 -DMPAPER_RESERVED_48 = 48 -DMPAPER_RESERVED_49 = 49 -DMPAPER_LETTER_EXTRA = 50 -DMPAPER_LEGAL_EXTRA = 51 -DMPAPER_TABLOID_EXTRA = 52 -DMPAPER_A4_EXTRA = 53 -DMPAPER_LETTER_TRANSVERSE = 54 -DMPAPER_A4_TRANSVERSE = 55 -DMPAPER_LETTER_EXTRA_TRANSVERSE = 56 -DMPAPER_A_PLUS = 57 -DMPAPER_B_PLUS = 58 -DMPAPER_LETTER_PLUS = 59 -DMPAPER_A4_PLUS = 60 -DMPAPER_A5_TRANSVERSE = 61 -DMPAPER_B5_TRANSVERSE = 62 -DMPAPER_A3_EXTRA = 63 -DMPAPER_A5_EXTRA = 64 -DMPAPER_B5_EXTRA = 65 -DMPAPER_A2 = 66 -DMPAPER_A3_TRANSVERSE = 67 -DMPAPER_A3_EXTRA_TRANSVERSE = 68 -DMPAPER_DBL_JAPANESE_POSTCARD = 69 -DMPAPER_A6 = 70 -DMPAPER_JENV_KAKU2 = 71 -DMPAPER_JENV_KAKU3 = 72 -DMPAPER_JENV_CHOU3 = 73 -DMPAPER_JENV_CHOU4 = 74 -DMPAPER_LETTER_ROTATED = 75 -DMPAPER_A3_ROTATED = 76 -DMPAPER_A4_ROTATED = 77 -DMPAPER_A5_ROTATED = 78 -DMPAPER_B4_JIS_ROTATED = 79 -DMPAPER_B5_JIS_ROTATED = 80 -DMPAPER_JAPANESE_POSTCARD_ROTATED = 81 -DMPAPER_DBL_JAPANESE_POSTCARD_ROTATED = 82 -DMPAPER_A6_ROTATED = 83 -DMPAPER_JENV_KAKU2_ROTATED = 84 -DMPAPER_JENV_KAKU3_ROTATED = 85 -DMPAPER_JENV_CHOU3_ROTATED = 86 -DMPAPER_JENV_CHOU4_ROTATED = 87 -DMPAPER_B6_JIS = 88 -DMPAPER_B6_JIS_ROTATED = 89 -DMPAPER_12X11 = 90 -DMPAPER_JENV_YOU4 = 91 -DMPAPER_JENV_YOU4_ROTATED = 92 -DMPAPER_P16K = 93 -DMPAPER_P32K = 94 -DMPAPER_P32KBIG = 95 -DMPAPER_PENV_1 = 96 -DMPAPER_PENV_2 = 97 -DMPAPER_PENV_3 = 98 -DMPAPER_PENV_4 = 99 -DMPAPER_PENV_5 = 100 -DMPAPER_PENV_6 = 101 -DMPAPER_PENV_7 = 102 -DMPAPER_PENV_8 = 103 -DMPAPER_PENV_9 = 104 -DMPAPER_PENV_10 = 105 -DMPAPER_P16K_ROTATED = 106 -DMPAPER_P32K_ROTATED = 107 -DMPAPER_P32KBIG_ROTATED = 108 -DMPAPER_PENV_1_ROTATED = 109 -DMPAPER_PENV_2_ROTATED = 110 -DMPAPER_PENV_3_ROTATED = 111 -DMPAPER_PENV_4_ROTATED = 112 -DMPAPER_PENV_5_ROTATED = 113 -DMPAPER_PENV_6_ROTATED = 114 -DMPAPER_PENV_7_ROTATED = 115 -DMPAPER_PENV_8_ROTATED = 116 -DMPAPER_PENV_9_ROTATED = 117 -DMPAPER_PENV_10_ROTATED = 118 -DMPAPER_LAST = DMPAPER_PENV_10_ROTATED -DMPAPER_USER = 256 - -# DEVMODE.dmDefaultSource -DMBIN_UPPER = 1 -DMBIN_ONLYONE = 1 -DMBIN_LOWER = 2 -DMBIN_MIDDLE = 3 -DMBIN_MANUAL = 4 -DMBIN_ENVELOPE = 5 -DMBIN_ENVMANUAL = 6 -DMBIN_AUTO = 7 -DMBIN_TRACTOR = 8 -DMBIN_SMALLFMT = 9 -DMBIN_LARGEFMT = 10 -DMBIN_LARGECAPACITY = 11 -DMBIN_CASSETTE = 14 -DMBIN_FORMSOURCE = 15 -DMBIN_LAST = DMBIN_FORMSOURCE -DMBIN_USER = 256 - -# DEVMODE.dmPrintQuality -DMRES_DRAFT = (-1) -DMRES_LOW = (-2) -DMRES_MEDIUM = (-3) -DMRES_HIGH = (-4) - -# DEVMODE.dmColor -DMCOLOR_MONOCHROME = 1 -DMCOLOR_COLOR = 2 - -# DEVMODE.dmDuplex -DMDUP_SIMPLEX = 1 -DMDUP_VERTICAL = 2 -DMDUP_HORIZONTAL = 3 - -# DEVMODE.dmTTOption -DMTT_BITMAP = 1 -DMTT_DOWNLOAD = 2 -DMTT_SUBDEV = 3 -DMTT_DOWNLOAD_OUTLINE = 4 - -# DEVMODE.dmCollate -DMCOLLATE_FALSE = 0 -DMCOLLATE_TRUE = 1 - -# DEVMODE.dmDisplayFlags -DM_GRAYSCALE = 1 -DM_INTERLACED = 2 - -# DEVMODE.dmICMMethod -DMICMMETHOD_NONE = 1 -DMICMMETHOD_SYSTEM = 2 -DMICMMETHOD_DRIVER = 3 -DMICMMETHOD_DEVICE = 4 -DMICMMETHOD_USER = 256 - -# DEVMODE.dmICMIntent -DMICM_SATURATE = 1 -DMICM_CONTRAST = 2 -DMICM_COLORIMETRIC = 3 -DMICM_ABS_COLORIMETRIC = 4 -DMICM_USER = 256 - -# DEVMODE.dmMediaType -DMMEDIA_STANDARD = 1 -DMMEDIA_TRANSPARENCY = 2 -DMMEDIA_GLOSSY = 3 -DMMEDIA_USER = 256 - -# DEVMODE.dmDitherType -DMDITHER_NONE = 1 -DMDITHER_COARSE = 2 -DMDITHER_FINE = 3 -DMDITHER_LINEART = 4 -DMDITHER_ERRORDIFFUSION = 5 -DMDITHER_RESERVED6 = 6 -DMDITHER_RESERVED7 = 7 -DMDITHER_RESERVED8 = 8 -DMDITHER_RESERVED9 = 9 -DMDITHER_GRAYSCALE = 10 -DMDITHER_USER = 256 - -# DEVMODE.dmNup -DMNUP_SYSTEM = 1 -DMNUP_ONEUP = 2 - -# used with ExtEscape -FEATURESETTING_NUP = 0 -FEATURESETTING_OUTPUT = 1 -FEATURESETTING_PSLEVEL = 2 -FEATURESETTING_CUSTPAPER = 3 -FEATURESETTING_MIRROR = 4 -FEATURESETTING_NEGATIVE = 5 -FEATURESETTING_PROTOCOL = 6 -FEATURESETTING_PRIVATE_BEGIN = 0x1000 -FEATURESETTING_PRIVATE_END = 0x1FFF - -RDH_RECTANGLES = 1 -GGO_METRICS = 0 -GGO_BITMAP = 1 -GGO_NATIVE = 2 -TT_POLYGON_TYPE = 24 -TT_PRIM_LINE = 1 -TT_PRIM_QSPLINE = 2 -TT_AVAILABLE = 1 -TT_ENABLED = 2 -DM_UPDATE = 1 -DM_COPY = 2 -DM_PROMPT = 4 -DM_MODIFY = 8 -DM_IN_BUFFER = DM_MODIFY -DM_IN_PROMPT = DM_PROMPT -DM_OUT_BUFFER = DM_COPY -DM_OUT_DEFAULT = DM_UPDATE - -# DISPLAY_DEVICE.StateFlags -DISPLAY_DEVICE_ATTACHED_TO_DESKTOP = 1 -DISPLAY_DEVICE_MULTI_DRIVER = 2 -DISPLAY_DEVICE_PRIMARY_DEVICE = 4 -DISPLAY_DEVICE_MIRRORING_DRIVER = 8 -DISPLAY_DEVICE_VGA_COMPATIBLE = 16 -DISPLAY_DEVICE_REMOVABLE = 32 -DISPLAY_DEVICE_MODESPRUNED = 134217728 -DISPLAY_DEVICE_REMOTE = 67108864 -DISPLAY_DEVICE_DISCONNECT = 33554432 - -# DeviceCapabilities types -DC_FIELDS = 1 -DC_PAPERS = 2 -DC_PAPERSIZE = 3 -DC_MINEXTENT = 4 -DC_MAXEXTENT = 5 -DC_BINS = 6 -DC_DUPLEX = 7 -DC_SIZE = 8 -DC_EXTRA = 9 -DC_VERSION = 10 -DC_DRIVER = 11 -DC_BINNAMES = 12 -DC_ENUMRESOLUTIONS = 13 -DC_FILEDEPENDENCIES = 14 -DC_TRUETYPE = 15 -DC_PAPERNAMES = 16 -DC_ORIENTATION = 17 -DC_COPIES = 18 -DC_BINADJUST = 19 -DC_EMF_COMPLIANT = 20 -DC_DATATYPE_PRODUCED = 21 -DC_COLLATE = 22 -DC_MANUFACTURER = 23 -DC_MODEL = 24 -DC_PERSONALITY = 25 -DC_PRINTRATE = 26 -DC_PRINTRATEUNIT = 27 -DC_PRINTERMEM = 28 -DC_MEDIAREADY = 29 -DC_STAPLE = 30 -DC_PRINTRATEPPM = 31 -DC_COLORDEVICE = 32 -DC_NUP = 33 -DC_MEDIATYPENAMES = 34 -DC_MEDIATYPES = 35 - -PRINTRATEUNIT_PPM = 1 -PRINTRATEUNIT_CPS = 2 -PRINTRATEUNIT_LPM = 3 -PRINTRATEUNIT_IPM = 4 - -# TrueType constants -DCTT_BITMAP = 1 -DCTT_DOWNLOAD = 2 -DCTT_SUBDEV = 4 -DCTT_DOWNLOAD_OUTLINE = 8 - -DCBA_FACEUPNONE = 0 -DCBA_FACEUPCENTER = 1 -DCBA_FACEUPLEFT = 2 -DCBA_FACEUPRIGHT = 3 -DCBA_FACEDOWNNONE = 256 -DCBA_FACEDOWNCENTER = 257 -DCBA_FACEDOWNLEFT = 258 -DCBA_FACEDOWNRIGHT = 259 - -CA_NEGATIVE = 1 -CA_LOG_FILTER = 2 -ILLUMINANT_DEVICE_DEFAULT = 0 -ILLUMINANT_A = 1 -ILLUMINANT_B = 2 -ILLUMINANT_C = 3 -ILLUMINANT_D50 = 4 -ILLUMINANT_D55 = 5 -ILLUMINANT_D65 = 6 -ILLUMINANT_D75 = 7 -ILLUMINANT_F2 = 8 -ILLUMINANT_MAX_INDEX = ILLUMINANT_F2 -ILLUMINANT_TUNGSTEN = ILLUMINANT_A -ILLUMINANT_DAYLIGHT = ILLUMINANT_C -ILLUMINANT_FLUORESCENT = ILLUMINANT_F2 -ILLUMINANT_NTSC = ILLUMINANT_C - -# Generated by h2py from \msvcnt\include\wingdi.h -# hacked and split manually by mhammond. -FONTMAPPER_MAX = 10 -ENHMETA_SIGNATURE = 1179469088 -ENHMETA_STOCK_OBJECT = -2147483648 -EMR_HEADER = 1 -EMR_POLYBEZIER = 2 -EMR_POLYGON = 3 -EMR_POLYLINE = 4 -EMR_POLYBEZIERTO = 5 -EMR_POLYLINETO = 6 -EMR_POLYPOLYLINE = 7 -EMR_POLYPOLYGON = 8 -EMR_SETWINDOWEXTEX = 9 -EMR_SETWINDOWORGEX = 10 -EMR_SETVIEWPORTEXTEX = 11 -EMR_SETVIEWPORTORGEX = 12 -EMR_SETBRUSHORGEX = 13 -EMR_EOF = 14 -EMR_SETPIXELV = 15 -EMR_SETMAPPERFLAGS = 16 -EMR_SETMAPMODE = 17 -EMR_SETBKMODE = 18 -EMR_SETPOLYFILLMODE = 19 -EMR_SETROP2 = 20 -EMR_SETSTRETCHBLTMODE = 21 -EMR_SETTEXTALIGN = 22 -EMR_SETCOLORADJUSTMENT = 23 -EMR_SETTEXTCOLOR = 24 -EMR_SETBKCOLOR = 25 -EMR_OFFSETCLIPRGN = 26 -EMR_MOVETOEX = 27 -EMR_SETMETARGN = 28 -EMR_EXCLUDECLIPRECT = 29 -EMR_INTERSECTCLIPRECT = 30 -EMR_SCALEVIEWPORTEXTEX = 31 -EMR_SCALEWINDOWEXTEX = 32 -EMR_SAVEDC = 33 -EMR_RESTOREDC = 34 -EMR_SETWORLDTRANSFORM = 35 -EMR_MODIFYWORLDTRANSFORM = 36 -EMR_SELECTOBJECT = 37 -EMR_CREATEPEN = 38 -EMR_CREATEBRUSHINDIRECT = 39 -EMR_DELETEOBJECT = 40 -EMR_ANGLEARC = 41 -EMR_ELLIPSE = 42 -EMR_RECTANGLE = 43 -EMR_ROUNDRECT = 44 -EMR_ARC = 45 -EMR_CHORD = 46 -EMR_PIE = 47 -EMR_SELECTPALETTE = 48 -EMR_CREATEPALETTE = 49 -EMR_SETPALETTEENTRIES = 50 -EMR_RESIZEPALETTE = 51 -EMR_REALIZEPALETTE = 52 -EMR_EXTFLOODFILL = 53 -EMR_LINETO = 54 -EMR_ARCTO = 55 -EMR_POLYDRAW = 56 -EMR_SETARCDIRECTION = 57 -EMR_SETMITERLIMIT = 58 -EMR_BEGINPATH = 59 -EMR_ENDPATH = 60 -EMR_CLOSEFIGURE = 61 -EMR_FILLPATH = 62 -EMR_STROKEANDFILLPATH = 63 -EMR_STROKEPATH = 64 -EMR_FLATTENPATH = 65 -EMR_WIDENPATH = 66 -EMR_SELECTCLIPPATH = 67 -EMR_ABORTPATH = 68 -EMR_GDICOMMENT = 70 -EMR_FILLRGN = 71 -EMR_FRAMERGN = 72 -EMR_INVERTRGN = 73 -EMR_PAINTRGN = 74 -EMR_EXTSELECTCLIPRGN = 75 -EMR_BITBLT = 76 -EMR_STRETCHBLT = 77 -EMR_MASKBLT = 78 -EMR_PLGBLT = 79 -EMR_SETDIBITSTODEVICE = 80 -EMR_STRETCHDIBITS = 81 -EMR_EXTCREATEFONTINDIRECTW = 82 -EMR_EXTTEXTOUTA = 83 -EMR_EXTTEXTOUTW = 84 -EMR_POLYBEZIER16 = 85 -EMR_POLYGON16 = 86 -EMR_POLYLINE16 = 87 -EMR_POLYBEZIERTO16 = 88 -EMR_POLYLINETO16 = 89 -EMR_POLYPOLYLINE16 = 90 -EMR_POLYPOLYGON16 = 91 -EMR_POLYDRAW16 = 92 -EMR_CREATEMONOBRUSH = 93 -EMR_CREATEDIBPATTERNBRUSHPT = 94 -EMR_EXTCREATEPEN = 95 -EMR_POLYTEXTOUTA = 96 -EMR_POLYTEXTOUTW = 97 -EMR_MIN = 1 -EMR_MAX = 97 -# Generated by h2py from \msvcnt\include\wingdi.h -# hacked and split manually by mhammond. -PANOSE_COUNT = 10 -PAN_FAMILYTYPE_INDEX = 0 -PAN_SERIFSTYLE_INDEX = 1 -PAN_WEIGHT_INDEX = 2 -PAN_PROPORTION_INDEX = 3 -PAN_CONTRAST_INDEX = 4 -PAN_STROKEVARIATION_INDEX = 5 -PAN_ARMSTYLE_INDEX = 6 -PAN_LETTERFORM_INDEX = 7 -PAN_MIDLINE_INDEX = 8 -PAN_XHEIGHT_INDEX = 9 -PAN_CULTURE_LATIN = 0 -PAN_ANY = 0 -PAN_NO_FIT = 1 -PAN_FAMILY_TEXT_DISPLAY = 2 -PAN_FAMILY_SCRIPT = 3 -PAN_FAMILY_DECORATIVE = 4 -PAN_FAMILY_PICTORIAL = 5 -PAN_SERIF_COVE = 2 -PAN_SERIF_OBTUSE_COVE = 3 -PAN_SERIF_SQUARE_COVE = 4 -PAN_SERIF_OBTUSE_SQUARE_COVE = 5 -PAN_SERIF_SQUARE = 6 -PAN_SERIF_THIN = 7 -PAN_SERIF_BONE = 8 -PAN_SERIF_EXAGGERATED = 9 -PAN_SERIF_TRIANGLE = 10 -PAN_SERIF_NORMAL_SANS = 11 -PAN_SERIF_OBTUSE_SANS = 12 -PAN_SERIF_PERP_SANS = 13 -PAN_SERIF_FLARED = 14 -PAN_SERIF_ROUNDED = 15 -PAN_WEIGHT_VERY_LIGHT = 2 -PAN_WEIGHT_LIGHT = 3 -PAN_WEIGHT_THIN = 4 -PAN_WEIGHT_BOOK = 5 -PAN_WEIGHT_MEDIUM = 6 -PAN_WEIGHT_DEMI = 7 -PAN_WEIGHT_BOLD = 8 -PAN_WEIGHT_HEAVY = 9 -PAN_WEIGHT_BLACK = 10 -PAN_WEIGHT_NORD = 11 -PAN_PROP_OLD_STYLE = 2 -PAN_PROP_MODERN = 3 -PAN_PROP_EVEN_WIDTH = 4 -PAN_PROP_EXPANDED = 5 -PAN_PROP_CONDENSED = 6 -PAN_PROP_VERY_EXPANDED = 7 -PAN_PROP_VERY_CONDENSED = 8 -PAN_PROP_MONOSPACED = 9 -PAN_CONTRAST_NONE = 2 -PAN_CONTRAST_VERY_LOW = 3 -PAN_CONTRAST_LOW = 4 -PAN_CONTRAST_MEDIUM_LOW = 5 -PAN_CONTRAST_MEDIUM = 6 -PAN_CONTRAST_MEDIUM_HIGH = 7 -PAN_CONTRAST_HIGH = 8 -PAN_CONTRAST_VERY_HIGH = 9 -PAN_STROKE_GRADUAL_DIAG = 2 -PAN_STROKE_GRADUAL_TRAN = 3 -PAN_STROKE_GRADUAL_VERT = 4 -PAN_STROKE_GRADUAL_HORZ = 5 -PAN_STROKE_RAPID_VERT = 6 -PAN_STROKE_RAPID_HORZ = 7 -PAN_STROKE_INSTANT_VERT = 8 -PAN_STRAIGHT_ARMS_HORZ = 2 -PAN_STRAIGHT_ARMS_WEDGE = 3 -PAN_STRAIGHT_ARMS_VERT = 4 -PAN_STRAIGHT_ARMS_SINGLE_SERIF = 5 -PAN_STRAIGHT_ARMS_DOUBLE_SERIF = 6 -PAN_BENT_ARMS_HORZ = 7 -PAN_BENT_ARMS_WEDGE = 8 -PAN_BENT_ARMS_VERT = 9 -PAN_BENT_ARMS_SINGLE_SERIF = 10 -PAN_BENT_ARMS_DOUBLE_SERIF = 11 -PAN_LETT_NORMAL_CONTACT = 2 -PAN_LETT_NORMAL_WEIGHTED = 3 -PAN_LETT_NORMAL_BOXED = 4 -PAN_LETT_NORMAL_FLATTENED = 5 -PAN_LETT_NORMAL_ROUNDED = 6 -PAN_LETT_NORMAL_OFF_CENTER = 7 -PAN_LETT_NORMAL_SQUARE = 8 -PAN_LETT_OBLIQUE_CONTACT = 9 -PAN_LETT_OBLIQUE_WEIGHTED = 10 -PAN_LETT_OBLIQUE_BOXED = 11 -PAN_LETT_OBLIQUE_FLATTENED = 12 -PAN_LETT_OBLIQUE_ROUNDED = 13 -PAN_LETT_OBLIQUE_OFF_CENTER = 14 -PAN_LETT_OBLIQUE_SQUARE = 15 -PAN_MIDLINE_STANDARD_TRIMMED = 2 -PAN_MIDLINE_STANDARD_POINTED = 3 -PAN_MIDLINE_STANDARD_SERIFED = 4 -PAN_MIDLINE_HIGH_TRIMMED = 5 -PAN_MIDLINE_HIGH_POINTED = 6 -PAN_MIDLINE_HIGH_SERIFED = 7 -PAN_MIDLINE_CONSTANT_TRIMMED = 8 -PAN_MIDLINE_CONSTANT_POINTED = 9 -PAN_MIDLINE_CONSTANT_SERIFED = 10 -PAN_MIDLINE_LOW_TRIMMED = 11 -PAN_MIDLINE_LOW_POINTED = 12 -PAN_MIDLINE_LOW_SERIFED = 13 -PAN_XHEIGHT_CONSTANT_SMALL = 2 -PAN_XHEIGHT_CONSTANT_STD = 3 -PAN_XHEIGHT_CONSTANT_LARGE = 4 -PAN_XHEIGHT_DUCKING_SMALL = 5 -PAN_XHEIGHT_DUCKING_STD = 6 -PAN_XHEIGHT_DUCKING_LARGE = 7 -ELF_VENDOR_SIZE = 4 -ELF_VERSION = 0 -ELF_CULTURE_LATIN = 0 -RASTER_FONTTYPE = 1 -DEVICE_FONTTYPE = 2 -TRUETYPE_FONTTYPE = 4 - - -def PALETTEINDEX(i) -> int: - ... - - -PC_RESERVED = 1 -PC_EXPLICIT = 2 -PC_NOCOLLAPSE = 4 - - -def GetRValue(rgb) -> int: - ... - - -def GetGValue(rgb) -> int: - ... - - -def GetBValue(rgb) -> int: - ... - - -TRANSPARENT = 1 -OPAQUE = 2 -BKMODE_LAST = 2 -GM_COMPATIBLE = 1 -GM_ADVANCED = 2 -GM_LAST = 2 -PT_CLOSEFIGURE = 1 -PT_LINETO = 2 -PT_BEZIERTO = 4 -PT_MOVETO = 6 -MM_TEXT = 1 -MM_LOMETRIC = 2 -MM_HIMETRIC = 3 -MM_LOENGLISH = 4 -MM_HIENGLISH = 5 -MM_TWIPS = 6 -MM_ISOTROPIC = 7 -MM_ANISOTROPIC = 8 -MM_MIN = MM_TEXT -MM_MAX = MM_ANISOTROPIC -MM_MAX_FIXEDSCALE = MM_TWIPS -ABSOLUTE = 1 -RELATIVE = 2 -WHITE_BRUSH = 0 -LTGRAY_BRUSH = 1 -GRAY_BRUSH = 2 -DKGRAY_BRUSH = 3 -BLACK_BRUSH = 4 -NULL_BRUSH = 5 -HOLLOW_BRUSH = NULL_BRUSH -WHITE_PEN = 6 -BLACK_PEN = 7 -NULL_PEN = 8 -OEM_FIXED_FONT = 10 -ANSI_FIXED_FONT = 11 -ANSI_VAR_FONT = 12 -SYSTEM_FONT = 13 -DEVICE_DEFAULT_FONT = 14 -DEFAULT_PALETTE = 15 -SYSTEM_FIXED_FONT = 16 -STOCK_LAST = 16 -CLR_INVALID = -1 - -DC_BRUSH = 18 -DC_PEN = 19 - -# Exception/Status codes from winuser.h and winnt.h -STATUS_WAIT_0 = 0 -STATUS_ABANDONED_WAIT_0 = 128 -STATUS_USER_APC = 192 -STATUS_TIMEOUT = 258 -STATUS_PENDING = 259 -STATUS_SEGMENT_NOTIFICATION = 1073741829 -STATUS_GUARD_PAGE_VIOLATION = -2147483647 -STATUS_DATATYPE_MISALIGNMENT = -2147483646 -STATUS_BREAKPOINT = -2147483645 -STATUS_SINGLE_STEP = -2147483644 -STATUS_ACCESS_VIOLATION = -1073741819 -STATUS_IN_PAGE_ERROR = -1073741818 -STATUS_INVALID_HANDLE = -1073741816 -STATUS_NO_MEMORY = -1073741801 -STATUS_ILLEGAL_INSTRUCTION = -1073741795 -STATUS_NONCONTINUABLE_EXCEPTION = -1073741787 -STATUS_INVALID_DISPOSITION = -1073741786 -STATUS_ARRAY_BOUNDS_EXCEEDED = -1073741684 -STATUS_FLOAT_DENORMAL_OPERAND = -1073741683 -STATUS_FLOAT_DIVIDE_BY_ZERO = -1073741682 -STATUS_FLOAT_INEXACT_RESULT = -1073741681 -STATUS_FLOAT_INVALID_OPERATION = -1073741680 -STATUS_FLOAT_OVERFLOW = -1073741679 -STATUS_FLOAT_STACK_CHECK = -1073741678 -STATUS_FLOAT_UNDERFLOW = -1073741677 -STATUS_INTEGER_DIVIDE_BY_ZERO = -1073741676 -STATUS_INTEGER_OVERFLOW = -1073741675 -STATUS_PRIVILEGED_INSTRUCTION = -1073741674 -STATUS_STACK_OVERFLOW = -1073741571 -STATUS_CONTROL_C_EXIT = -1073741510 - - -WAIT_FAILED = -1 -WAIT_OBJECT_0 = STATUS_WAIT_0 + 0 - -WAIT_ABANDONED = STATUS_ABANDONED_WAIT_0 + 0 -WAIT_ABANDONED_0 = STATUS_ABANDONED_WAIT_0 + 0 - -WAIT_TIMEOUT = STATUS_TIMEOUT -WAIT_IO_COMPLETION = STATUS_USER_APC -STILL_ACTIVE = STATUS_PENDING -EXCEPTION_ACCESS_VIOLATION = STATUS_ACCESS_VIOLATION -EXCEPTION_DATATYPE_MISALIGNMENT = STATUS_DATATYPE_MISALIGNMENT -EXCEPTION_BREAKPOINT = STATUS_BREAKPOINT -EXCEPTION_SINGLE_STEP = STATUS_SINGLE_STEP -EXCEPTION_ARRAY_BOUNDS_EXCEEDED = STATUS_ARRAY_BOUNDS_EXCEEDED -EXCEPTION_FLT_DENORMAL_OPERAND = STATUS_FLOAT_DENORMAL_OPERAND -EXCEPTION_FLT_DIVIDE_BY_ZERO = STATUS_FLOAT_DIVIDE_BY_ZERO -EXCEPTION_FLT_INEXACT_RESULT = STATUS_FLOAT_INEXACT_RESULT -EXCEPTION_FLT_INVALID_OPERATION = STATUS_FLOAT_INVALID_OPERATION -EXCEPTION_FLT_OVERFLOW = STATUS_FLOAT_OVERFLOW -EXCEPTION_FLT_STACK_CHECK = STATUS_FLOAT_STACK_CHECK -EXCEPTION_FLT_UNDERFLOW = STATUS_FLOAT_UNDERFLOW -EXCEPTION_INT_DIVIDE_BY_ZERO = STATUS_INTEGER_DIVIDE_BY_ZERO -EXCEPTION_INT_OVERFLOW = STATUS_INTEGER_OVERFLOW -EXCEPTION_PRIV_INSTRUCTION = STATUS_PRIVILEGED_INSTRUCTION -EXCEPTION_IN_PAGE_ERROR = STATUS_IN_PAGE_ERROR -EXCEPTION_ILLEGAL_INSTRUCTION = STATUS_ILLEGAL_INSTRUCTION -EXCEPTION_NONCONTINUABLE_EXCEPTION = STATUS_NONCONTINUABLE_EXCEPTION -EXCEPTION_STACK_OVERFLOW = STATUS_STACK_OVERFLOW -EXCEPTION_INVALID_DISPOSITION = STATUS_INVALID_DISPOSITION -EXCEPTION_GUARD_PAGE = STATUS_GUARD_PAGE_VIOLATION -EXCEPTION_INVALID_HANDLE = STATUS_INVALID_HANDLE -CONTROL_C_EXIT = STATUS_CONTROL_C_EXIT - -# winuser.h line 8594 -# constants used with SystemParametersInfo -SPI_GETBEEP = 1 -SPI_SETBEEP = 2 -SPI_GETMOUSE = 3 -SPI_SETMOUSE = 4 -SPI_GETBORDER = 5 -SPI_SETBORDER = 6 -SPI_GETKEYBOARDSPEED = 10 -SPI_SETKEYBOARDSPEED = 11 -SPI_LANGDRIVER = 12 -SPI_ICONHORIZONTALSPACING = 13 -SPI_GETSCREENSAVETIMEOUT = 14 -SPI_SETSCREENSAVETIMEOUT = 15 -SPI_GETSCREENSAVEACTIVE = 16 -SPI_SETSCREENSAVEACTIVE = 17 -SPI_GETGRIDGRANULARITY = 18 -SPI_SETGRIDGRANULARITY = 19 -SPI_SETDESKWALLPAPER = 20 -SPI_SETDESKPATTERN = 21 -SPI_GETKEYBOARDDELAY = 22 -SPI_SETKEYBOARDDELAY = 23 -SPI_ICONVERTICALSPACING = 24 -SPI_GETICONTITLEWRAP = 25 -SPI_SETICONTITLEWRAP = 26 -SPI_GETMENUDROPALIGNMENT = 27 -SPI_SETMENUDROPALIGNMENT = 28 -SPI_SETDOUBLECLKWIDTH = 29 -SPI_SETDOUBLECLKHEIGHT = 30 -SPI_GETICONTITLELOGFONT = 31 -SPI_SETDOUBLECLICKTIME = 32 -SPI_SETMOUSEBUTTONSWAP = 33 -SPI_SETICONTITLELOGFONT = 34 -SPI_GETFASTTASKSWITCH = 35 -SPI_SETFASTTASKSWITCH = 36 -SPI_SETDRAGFULLWINDOWS = 37 -SPI_GETDRAGFULLWINDOWS = 38 -SPI_GETNONCLIENTMETRICS = 41 -SPI_SETNONCLIENTMETRICS = 42 -SPI_GETMINIMIZEDMETRICS = 43 -SPI_SETMINIMIZEDMETRICS = 44 -SPI_GETICONMETRICS = 45 -SPI_SETICONMETRICS = 46 -SPI_SETWORKAREA = 47 -SPI_GETWORKAREA = 48 -SPI_SETPENWINDOWS = 49 -SPI_GETFILTERKEYS = 50 -SPI_SETFILTERKEYS = 51 -SPI_GETTOGGLEKEYS = 52 -SPI_SETTOGGLEKEYS = 53 -SPI_GETMOUSEKEYS = 54 -SPI_SETMOUSEKEYS = 55 -SPI_GETSHOWSOUNDS = 56 -SPI_SETSHOWSOUNDS = 57 -SPI_GETSTICKYKEYS = 58 -SPI_SETSTICKYKEYS = 59 -SPI_GETACCESSTIMEOUT = 60 -SPI_SETACCESSTIMEOUT = 61 -SPI_GETSERIALKEYS = 62 -SPI_SETSERIALKEYS = 63 -SPI_GETSOUNDSENTRY = 64 -SPI_SETSOUNDSENTRY = 65 -SPI_GETHIGHCONTRAST = 66 -SPI_SETHIGHCONTRAST = 67 -SPI_GETKEYBOARDPREF = 68 -SPI_SETKEYBOARDPREF = 69 -SPI_GETSCREENREADER = 70 -SPI_SETSCREENREADER = 71 -SPI_GETANIMATION = 72 -SPI_SETANIMATION = 73 -SPI_GETFONTSMOOTHING = 74 -SPI_SETFONTSMOOTHING = 75 -SPI_SETDRAGWIDTH = 76 -SPI_SETDRAGHEIGHT = 77 -SPI_SETHANDHELD = 78 -SPI_GETLOWPOWERTIMEOUT = 79 -SPI_GETPOWEROFFTIMEOUT = 80 -SPI_SETLOWPOWERTIMEOUT = 81 -SPI_SETPOWEROFFTIMEOUT = 82 -SPI_GETLOWPOWERACTIVE = 83 -SPI_GETPOWEROFFACTIVE = 84 -SPI_SETLOWPOWERACTIVE = 85 -SPI_SETPOWEROFFACTIVE = 86 -SPI_SETCURSORS = 87 -SPI_SETICONS = 88 -SPI_GETDEFAULTINPUTLANG = 89 -SPI_SETDEFAULTINPUTLANG = 90 -SPI_SETLANGTOGGLE = 91 -SPI_GETWINDOWSEXTENSION = 92 -SPI_SETMOUSETRAILS = 93 -SPI_GETMOUSETRAILS = 94 -SPI_GETSNAPTODEFBUTTON = 95 -SPI_SETSNAPTODEFBUTTON = 96 -SPI_SETSCREENSAVERRUNNING = 97 -SPI_SCREENSAVERRUNNING = SPI_SETSCREENSAVERRUNNING -SPI_GETMOUSEHOVERWIDTH = 98 -SPI_SETMOUSEHOVERWIDTH = 99 -SPI_GETMOUSEHOVERHEIGHT = 100 -SPI_SETMOUSEHOVERHEIGHT = 101 -SPI_GETMOUSEHOVERTIME = 102 -SPI_SETMOUSEHOVERTIME = 103 -SPI_GETWHEELSCROLLLINES = 104 -SPI_SETWHEELSCROLLLINES = 105 -SPI_GETMENUSHOWDELAY = 106 -SPI_SETMENUSHOWDELAY = 107 - -SPI_GETSHOWIMEUI = 110 -SPI_SETSHOWIMEUI = 111 -SPI_GETMOUSESPEED = 112 -SPI_SETMOUSESPEED = 113 -SPI_GETSCREENSAVERRUNNING = 114 -SPI_GETDESKWALLPAPER = 115 - -SPI_GETACTIVEWINDOWTRACKING = 4096 -SPI_SETACTIVEWINDOWTRACKING = 4097 -SPI_GETMENUANIMATION = 4098 -SPI_SETMENUANIMATION = 4099 -SPI_GETCOMBOBOXANIMATION = 4100 -SPI_SETCOMBOBOXANIMATION = 4101 -SPI_GETLISTBOXSMOOTHSCROLLING = 4102 -SPI_SETLISTBOXSMOOTHSCROLLING = 4103 -SPI_GETGRADIENTCAPTIONS = 4104 -SPI_SETGRADIENTCAPTIONS = 4105 -SPI_GETKEYBOARDCUES = 4106 -SPI_SETKEYBOARDCUES = 4107 -SPI_GETMENUUNDERLINES = 4106 -SPI_SETMENUUNDERLINES = 4107 -SPI_GETACTIVEWNDTRKZORDER = 4108 -SPI_SETACTIVEWNDTRKZORDER = 4109 -SPI_GETHOTTRACKING = 4110 -SPI_SETHOTTRACKING = 4111 - -SPI_GETMENUFADE = 4114 -SPI_SETMENUFADE = 4115 -SPI_GETSELECTIONFADE = 4116 -SPI_SETSELECTIONFADE = 4117 -SPI_GETTOOLTIPANIMATION = 4118 -SPI_SETTOOLTIPANIMATION = 4119 -SPI_GETTOOLTIPFADE = 4120 -SPI_SETTOOLTIPFADE = 4121 -SPI_GETCURSORSHADOW = 4122 -SPI_SETCURSORSHADOW = 4123 -SPI_GETMOUSESONAR = 4124 -SPI_SETMOUSESONAR = 4125 -SPI_GETMOUSECLICKLOCK = 4126 -SPI_SETMOUSECLICKLOCK = 4127 -SPI_GETMOUSEVANISH = 4128 -SPI_SETMOUSEVANISH = 4129 -SPI_GETFLATMENU = 4130 -SPI_SETFLATMENU = 4131 -SPI_GETDROPSHADOW = 4132 -SPI_SETDROPSHADOW = 4133 -SPI_GETBLOCKSENDINPUTRESETS = 4134 -SPI_SETBLOCKSENDINPUTRESETS = 4135 -SPI_GETUIEFFECTS = 4158 -SPI_SETUIEFFECTS = 4159 - -SPI_GETFOREGROUNDLOCKTIMEOUT = 8192 -SPI_SETFOREGROUNDLOCKTIMEOUT = 8193 -SPI_GETACTIVEWNDTRKTIMEOUT = 8194 -SPI_SETACTIVEWNDTRKTIMEOUT = 8195 -SPI_GETFOREGROUNDFLASHCOUNT = 8196 -SPI_SETFOREGROUNDFLASHCOUNT = 8197 -SPI_GETCARETWIDTH = 8198 -SPI_SETCARETWIDTH = 8199 -SPI_GETMOUSECLICKLOCKTIME = 8200 -SPI_SETMOUSECLICKLOCKTIME = 8201 -SPI_GETFONTSMOOTHINGTYPE = 8202 -SPI_SETFONTSMOOTHINGTYPE = 8203 -SPI_GETFONTSMOOTHINGCONTRAST = 8204 -SPI_SETFONTSMOOTHINGCONTRAST = 8205 -SPI_GETFOCUSBORDERWIDTH = 8206 -SPI_SETFOCUSBORDERWIDTH = 8207 -SPI_GETFOCUSBORDERHEIGHT = 8208 -SPI_SETFOCUSBORDERHEIGHT = 8209 -SPI_GETFONTSMOOTHINGORIENTATION = 8210 -SPI_SETFONTSMOOTHINGORIENTATION = 8211 - -# fWinIni flags for SystemParametersInfo -SPIF_UPDATEINIFILE = 1 -SPIF_SENDWININICHANGE = 2 -SPIF_SENDCHANGE = SPIF_SENDWININICHANGE - -# used with SystemParametersInfo and SPI_GETFONTSMOOTHINGTYPE/SPI_SETFONTSMOOTHINGTYPE -FE_FONTSMOOTHINGSTANDARD = 1 -FE_FONTSMOOTHINGCLEARTYPE = 2 -FE_FONTSMOOTHINGDOCKING = 32768 - -METRICS_USEDEFAULT = -1 -ARW_BOTTOMLEFT = 0 -ARW_BOTTOMRIGHT = 1 -ARW_TOPLEFT = 2 -ARW_TOPRIGHT = 3 -ARW_STARTMASK = 3 -ARW_STARTRIGHT = 1 -ARW_STARTTOP = 2 -ARW_LEFT = 0 -ARW_RIGHT = 0 -ARW_UP = 4 -ARW_DOWN = 4 -ARW_HIDE = 8 -# ARW_VALID = 0x000F -SERKF_SERIALKEYSON = 1 -SERKF_AVAILABLE = 2 -SERKF_INDICATOR = 4 -HCF_HIGHCONTRASTON = 1 -HCF_AVAILABLE = 2 -HCF_HOTKEYACTIVE = 4 -HCF_CONFIRMHOTKEY = 8 -HCF_HOTKEYSOUND = 16 -HCF_INDICATOR = 32 -HCF_HOTKEYAVAILABLE = 64 -CDS_UPDATEREGISTRY = 1 -CDS_TEST = 2 -CDS_FULLSCREEN = 4 -CDS_GLOBAL = 8 -CDS_SET_PRIMARY = 16 -CDS_RESET = 1073741824 -CDS_SETRECT = 536870912 -CDS_NORESET = 268435456 - -# return values from ChangeDisplaySettings and ChangeDisplaySettingsEx -DISP_CHANGE_SUCCESSFUL = 0 -DISP_CHANGE_RESTART = 1 -DISP_CHANGE_FAILED = -1 -DISP_CHANGE_BADMODE = -2 -DISP_CHANGE_NOTUPDATED = -3 -DISP_CHANGE_BADFLAGS = -4 -DISP_CHANGE_BADPARAM = -5 -DISP_CHANGE_BADDUALVIEW = -6 - -ENUM_CURRENT_SETTINGS = -1 -ENUM_REGISTRY_SETTINGS = -2 -FKF_FILTERKEYSON = 1 -FKF_AVAILABLE = 2 -FKF_HOTKEYACTIVE = 4 -FKF_CONFIRMHOTKEY = 8 -FKF_HOTKEYSOUND = 16 -FKF_INDICATOR = 32 -FKF_CLICKON = 64 -SKF_STICKYKEYSON = 1 -SKF_AVAILABLE = 2 -SKF_HOTKEYACTIVE = 4 -SKF_CONFIRMHOTKEY = 8 -SKF_HOTKEYSOUND = 16 -SKF_INDICATOR = 32 -SKF_AUDIBLEFEEDBACK = 64 -SKF_TRISTATE = 128 -SKF_TWOKEYSOFF = 256 -SKF_LALTLATCHED = 268435456 -SKF_LCTLLATCHED = 67108864 -SKF_LSHIFTLATCHED = 16777216 -SKF_RALTLATCHED = 536870912 -SKF_RCTLLATCHED = 134217728 -SKF_RSHIFTLATCHED = 33554432 -SKF_LWINLATCHED = 1073741824 -SKF_RWINLATCHED = -2147483648 -SKF_LALTLOCKED = 1048576 -SKF_LCTLLOCKED = 262144 -SKF_LSHIFTLOCKED = 65536 -SKF_RALTLOCKED = 2097152 -SKF_RCTLLOCKED = 524288 -SKF_RSHIFTLOCKED = 131072 -SKF_LWINLOCKED = 4194304 -SKF_RWINLOCKED = 8388608 -MKF_MOUSEKEYSON = 1 -MKF_AVAILABLE = 2 -MKF_HOTKEYACTIVE = 4 -MKF_CONFIRMHOTKEY = 8 -MKF_HOTKEYSOUND = 16 -MKF_INDICATOR = 32 -MKF_MODIFIERS = 64 -MKF_REPLACENUMBERS = 128 -MKF_LEFTBUTTONSEL = 268435456 -MKF_RIGHTBUTTONSEL = 536870912 -MKF_LEFTBUTTONDOWN = 16777216 -MKF_RIGHTBUTTONDOWN = 33554432 -MKF_MOUSEMODE = -2147483648 -ATF_TIMEOUTON = 1 -ATF_ONOFFFEEDBACK = 2 -SSGF_NONE = 0 -SSGF_DISPLAY = 3 -SSTF_NONE = 0 -SSTF_CHARS = 1 -SSTF_BORDER = 2 -SSTF_DISPLAY = 3 -SSWF_NONE = 0 -SSWF_TITLE = 1 -SSWF_WINDOW = 2 -SSWF_DISPLAY = 3 -SSWF_CUSTOM = 4 -SSF_SOUNDSENTRYON = 1 -SSF_AVAILABLE = 2 -SSF_INDICATOR = 4 -TKF_TOGGLEKEYSON = 1 -TKF_AVAILABLE = 2 -TKF_HOTKEYACTIVE = 4 -TKF_CONFIRMHOTKEY = 8 -TKF_HOTKEYSOUND = 16 -TKF_INDICATOR = 32 -SLE_ERROR = 1 -SLE_MINORERROR = 2 -SLE_WARNING = 3 -MONITOR_DEFAULTTONULL = 0 -MONITOR_DEFAULTTOPRIMARY = 1 -MONITOR_DEFAULTTONEAREST = 2 -MONITORINFOF_PRIMARY = 1 -CCHDEVICENAME = 32 -CHILDID_SELF = 0 -INDEXID_OBJECT = 0 -INDEXID_CONTAINER = 0 -OBJID_WINDOW = 0 -OBJID_SYSMENU = -1 -OBJID_TITLEBAR = -2 -OBJID_MENU = -3 -OBJID_CLIENT = -4 -OBJID_VSCROLL = -5 -OBJID_HSCROLL = -6 -OBJID_SIZEGRIP = -7 -OBJID_CARET = -8 -OBJID_CURSOR = -9 -OBJID_ALERT = -10 -OBJID_SOUND = -11 -EVENT_MIN = 1 -EVENT_MAX = 2147483647 -EVENT_SYSTEM_SOUND = 1 -EVENT_SYSTEM_ALERT = 2 -EVENT_SYSTEM_FOREGROUND = 3 -EVENT_SYSTEM_MENUSTART = 4 -EVENT_SYSTEM_MENUEND = 5 -EVENT_SYSTEM_MENUPOPUPSTART = 6 -EVENT_SYSTEM_MENUPOPUPEND = 7 -EVENT_SYSTEM_CAPTURESTART = 8 -EVENT_SYSTEM_CAPTUREEND = 9 -EVENT_SYSTEM_MOVESIZESTART = 10 -EVENT_SYSTEM_MOVESIZEEND = 11 -EVENT_SYSTEM_CONTEXTHELPSTART = 12 -EVENT_SYSTEM_CONTEXTHELPEND = 13 -EVENT_SYSTEM_DRAGDROPSTART = 14 -EVENT_SYSTEM_DRAGDROPEND = 15 -EVENT_SYSTEM_DIALOGSTART = 16 -EVENT_SYSTEM_DIALOGEND = 17 -EVENT_SYSTEM_SCROLLINGSTART = 18 -EVENT_SYSTEM_SCROLLINGEND = 19 -EVENT_SYSTEM_SWITCHSTART = 20 -EVENT_SYSTEM_SWITCHEND = 21 -EVENT_SYSTEM_MINIMIZESTART = 22 -EVENT_SYSTEM_MINIMIZEEND = 23 -EVENT_OBJECT_CREATE = 32768 -EVENT_OBJECT_DESTROY = 32769 -EVENT_OBJECT_SHOW = 32770 -EVENT_OBJECT_HIDE = 32771 -EVENT_OBJECT_REORDER = 32772 -EVENT_OBJECT_FOCUS = 32773 -EVENT_OBJECT_SELECTION = 32774 -EVENT_OBJECT_SELECTIONADD = 32775 -EVENT_OBJECT_SELECTIONREMOVE = 32776 -EVENT_OBJECT_SELECTIONWITHIN = 32777 -EVENT_OBJECT_STATECHANGE = 32778 -EVENT_OBJECT_LOCATIONCHANGE = 32779 -EVENT_OBJECT_NAMECHANGE = 32780 -EVENT_OBJECT_DESCRIPTIONCHANGE = 32781 -EVENT_OBJECT_VALUECHANGE = 32782 -EVENT_OBJECT_PARENTCHANGE = 32783 -EVENT_OBJECT_HELPCHANGE = 32784 -EVENT_OBJECT_DEFACTIONCHANGE = 32785 -EVENT_OBJECT_ACCELERATORCHANGE = 32786 -SOUND_SYSTEM_STARTUP = 1 -SOUND_SYSTEM_SHUTDOWN = 2 -SOUND_SYSTEM_BEEP = 3 -SOUND_SYSTEM_ERROR = 4 -SOUND_SYSTEM_QUESTION = 5 -SOUND_SYSTEM_WARNING = 6 -SOUND_SYSTEM_INFORMATION = 7 -SOUND_SYSTEM_MAXIMIZE = 8 -SOUND_SYSTEM_MINIMIZE = 9 -SOUND_SYSTEM_RESTOREUP = 10 -SOUND_SYSTEM_RESTOREDOWN = 11 -SOUND_SYSTEM_APPSTART = 12 -SOUND_SYSTEM_FAULT = 13 -SOUND_SYSTEM_APPEND = 14 -SOUND_SYSTEM_MENUCOMMAND = 15 -SOUND_SYSTEM_MENUPOPUP = 16 -CSOUND_SYSTEM = 16 -ALERT_SYSTEM_INFORMATIONAL = 1 -ALERT_SYSTEM_WARNING = 2 -ALERT_SYSTEM_ERROR = 3 -ALERT_SYSTEM_QUERY = 4 -ALERT_SYSTEM_CRITICAL = 5 -CALERT_SYSTEM = 6 -WINEVENT_OUTOFCONTEXT = 0 -WINEVENT_SKIPOWNTHREAD = 1 -WINEVENT_SKIPOWNPROCESS = 2 -WINEVENT_INCONTEXT = 4 -GUI_CARETBLINKING = 1 -GUI_INMOVESIZE = 2 -GUI_INMENUMODE = 4 -GUI_SYSTEMMENUMODE = 8 -GUI_POPUPMENUMODE = 16 -STATE_SYSTEM_UNAVAILABLE = 1 -STATE_SYSTEM_SELECTED = 2 -STATE_SYSTEM_FOCUSED = 4 -STATE_SYSTEM_PRESSED = 8 -STATE_SYSTEM_CHECKED = 16 -STATE_SYSTEM_MIXED = 32 -STATE_SYSTEM_READONLY = 64 -STATE_SYSTEM_HOTTRACKED = 128 -STATE_SYSTEM_DEFAULT = 256 -STATE_SYSTEM_EXPANDED = 512 -STATE_SYSTEM_COLLAPSED = 1024 -STATE_SYSTEM_BUSY = 2048 -STATE_SYSTEM_FLOATING = 4096 -STATE_SYSTEM_MARQUEED = 8192 -STATE_SYSTEM_ANIMATED = 16384 -STATE_SYSTEM_INVISIBLE = 32768 -STATE_SYSTEM_OFFSCREEN = 65536 -STATE_SYSTEM_SIZEABLE = 131072 -STATE_SYSTEM_MOVEABLE = 262144 -STATE_SYSTEM_SELFVOICING = 524288 -STATE_SYSTEM_FOCUSABLE = 1048576 -STATE_SYSTEM_SELECTABLE = 2097152 -STATE_SYSTEM_LINKED = 4194304 -STATE_SYSTEM_TRAVERSED = 8388608 -STATE_SYSTEM_MULTISELECTABLE = 16777216 -STATE_SYSTEM_EXTSELECTABLE = 33554432 -STATE_SYSTEM_ALERT_LOW = 67108864 -STATE_SYSTEM_ALERT_MEDIUM = 134217728 -STATE_SYSTEM_ALERT_HIGH = 268435456 -STATE_SYSTEM_VALID = 536870911 -CCHILDREN_TITLEBAR = 5 -CCHILDREN_SCROLLBAR = 5 -CURSOR_SHOWING = 1 -WS_ACTIVECAPTION = 1 -GA_MIC = 1 -GA_PARENT = 1 -GA_ROOT = 2 -GA_ROOTOWNER = 3 -GA_MAC = 4 - -# winuser.h line 1979 -BF_LEFT = 1 -BF_TOP = 2 -BF_RIGHT = 4 -BF_BOTTOM = 8 -BF_TOPLEFT = (BF_TOP | BF_LEFT) -BF_TOPRIGHT = (BF_TOP | BF_RIGHT) -BF_BOTTOMLEFT = (BF_BOTTOM | BF_LEFT) -BF_BOTTOMRIGHT = (BF_BOTTOM | BF_RIGHT) -BF_RECT = (BF_LEFT | BF_TOP | BF_RIGHT | BF_BOTTOM) -BF_DIAGONAL = 16 -BF_DIAGONAL_ENDTOPRIGHT = (BF_DIAGONAL | BF_TOP | BF_RIGHT) -BF_DIAGONAL_ENDTOPLEFT = (BF_DIAGONAL | BF_TOP | BF_LEFT) -BF_DIAGONAL_ENDBOTTOMLEFT = (BF_DIAGONAL | BF_BOTTOM | BF_LEFT) -BF_DIAGONAL_ENDBOTTOMRIGHT = (BF_DIAGONAL | BF_BOTTOM | BF_RIGHT) -BF_MIDDLE = 2048 -BF_SOFT = 4096 -BF_ADJUST = 8192 -BF_FLAT = 16384 -BF_MONO = 32768 -DFC_CAPTION = 1 -DFC_MENU = 2 -DFC_SCROLL = 3 -DFC_BUTTON = 4 -DFC_POPUPMENU = 5 -DFCS_CAPTIONCLOSE = 0 -DFCS_CAPTIONMIN = 1 -DFCS_CAPTIONMAX = 2 -DFCS_CAPTIONRESTORE = 3 -DFCS_CAPTIONHELP = 4 -DFCS_MENUARROW = 0 -DFCS_MENUCHECK = 1 -DFCS_MENUBULLET = 2 -DFCS_MENUARROWRIGHT = 4 -DFCS_SCROLLUP = 0 -DFCS_SCROLLDOWN = 1 -DFCS_SCROLLLEFT = 2 -DFCS_SCROLLRIGHT = 3 -DFCS_SCROLLCOMBOBOX = 5 -DFCS_SCROLLSIZEGRIP = 8 -DFCS_SCROLLSIZEGRIPRIGHT = 16 -DFCS_BUTTONCHECK = 0 -DFCS_BUTTONRADIOIMAGE = 1 -DFCS_BUTTONRADIOMASK = 2 -DFCS_BUTTONRADIO = 4 -DFCS_BUTTON3STATE = 8 -DFCS_BUTTONPUSH = 16 -DFCS_INACTIVE = 256 -DFCS_PUSHED = 512 -DFCS_CHECKED = 1024 -DFCS_TRANSPARENT = 2048 -DFCS_HOT = 4096 -DFCS_ADJUSTRECT = 8192 -DFCS_FLAT = 16384 -DFCS_MONO = 32768 -DC_ACTIVE = 1 -DC_SMALLCAP = 2 -DC_ICON = 4 -DC_TEXT = 8 -DC_INBUTTON = 16 -DC_GRADIENT = 32 -IDANI_OPEN = 1 -IDANI_CLOSE = 2 -IDANI_CAPTION = 3 -CF_TEXT = 1 -CF_BITMAP = 2 -CF_METAFILEPICT = 3 -CF_SYLK = 4 -CF_DIF = 5 -CF_TIFF = 6 -CF_OEMTEXT = 7 -CF_DIB = 8 -CF_PALETTE = 9 -CF_PENDATA = 10 -CF_RIFF = 11 -CF_WAVE = 12 -CF_UNICODETEXT = 13 -CF_ENHMETAFILE = 14 -CF_HDROP = 15 -CF_LOCALE = 16 -CF_DIBV5 = 17 -CF_MAX = 18 -CF_OWNERDISPLAY = 128 -CF_DSPTEXT = 129 -CF_DSPBITMAP = 130 -CF_DSPMETAFILEPICT = 131 -CF_DSPENHMETAFILE = 142 -CF_PRIVATEFIRST = 512 -CF_PRIVATELAST = 767 -CF_GDIOBJFIRST = 768 -CF_GDIOBJLAST = 1023 -FVIRTKEY = 1 -FNOINVERT = 2 -FSHIFT = 4 -FCONTROL = 8 -FALT = 16 -WPF_SETMINPOSITION = 1 -WPF_RESTORETOMAXIMIZED = 2 -ODT_MENU = 1 -ODT_LISTBOX = 2 -ODT_COMBOBOX = 3 -ODT_BUTTON = 4 -ODT_STATIC = 5 -ODA_DRAWENTIRE = 1 -ODA_SELECT = 2 -ODA_FOCUS = 4 -ODS_SELECTED = 1 -ODS_GRAYED = 2 -ODS_DISABLED = 4 -ODS_CHECKED = 8 -ODS_FOCUS = 16 -ODS_DEFAULT = 32 -ODS_COMBOBOXEDIT = 4096 -ODS_HOTLIGHT = 64 -ODS_INACTIVE = 128 -PM_NOREMOVE = 0 -PM_REMOVE = 1 -PM_NOYIELD = 2 -MOD_ALT = 1 -MOD_CONTROL = 2 -MOD_SHIFT = 4 -MOD_WIN = 8 -IDHOT_SNAPWINDOW = (-1) -IDHOT_SNAPDESKTOP = (-2) -# EW_RESTARTWINDOWS = 0x0042 -# EW_REBOOTSYSTEM = 0x0043 -# EW_EXITANDEXECAPP = 0x0044 -ENDSESSION_LOGOFF = -2147483648 -EWX_LOGOFF = 0 -EWX_SHUTDOWN = 1 -EWX_REBOOT = 2 -EWX_FORCE = 4 -EWX_POWEROFF = 8 -EWX_FORCEIFHUNG = 16 -BSM_ALLCOMPONENTS = 0 -BSM_VXDS = 1 -BSM_NETDRIVER = 2 -BSM_INSTALLABLEDRIVERS = 4 -BSM_APPLICATIONS = 8 -BSM_ALLDESKTOPS = 16 -BSF_QUERY = 1 -BSF_IGNORECURRENTTASK = 2 -BSF_FLUSHDISK = 4 -BSF_NOHANG = 8 -BSF_POSTMESSAGE = 16 -BSF_FORCEIFHUNG = 32 -BSF_NOTIMEOUTIFNOTHUNG = 64 -BROADCAST_QUERY_DENY = 1112363332 # Return this value to deny a query. - -DBWF_LPARAMPOINTER = 32768 - -# winuser.h line 3232 -SWP_NOSIZE = 1 -SWP_NOMOVE = 2 -SWP_NOZORDER = 4 -SWP_NOREDRAW = 8 -SWP_NOACTIVATE = 16 -SWP_FRAMECHANGED = 32 -SWP_SHOWWINDOW = 64 -SWP_HIDEWINDOW = 128 -SWP_NOCOPYBITS = 256 -SWP_NOOWNERZORDER = 512 -SWP_NOSENDCHANGING = 1024 -SWP_DRAWFRAME = SWP_FRAMECHANGED -SWP_NOREPOSITION = SWP_NOOWNERZORDER -SWP_DEFERERASE = 8192 -SWP_ASYNCWINDOWPOS = 16384 - -DLGWINDOWEXTRA = 30 -# winuser.h line 4249 -KEYEVENTF_EXTENDEDKEY = 1 -KEYEVENTF_KEYUP = 2 -MOUSEEVENTF_MOVE = 1 -MOUSEEVENTF_LEFTDOWN = 2 -MOUSEEVENTF_LEFTUP = 4 -MOUSEEVENTF_RIGHTDOWN = 8 -MOUSEEVENTF_RIGHTUP = 16 -MOUSEEVENTF_MIDDLEDOWN = 32 -MOUSEEVENTF_MIDDLEUP = 64 -MOUSEEVENTF_ABSOLUTE = 32768 -INPUT_MOUSE = 0 -INPUT_KEYBOARD = 1 -INPUT_HARDWARE = 2 -MWMO_WAITALL = 1 -MWMO_ALERTABLE = 2 -MWMO_INPUTAVAILABLE = 4 -QS_KEY = 1 -QS_MOUSEMOVE = 2 -QS_MOUSEBUTTON = 4 -QS_POSTMESSAGE = 8 -QS_TIMER = 16 -QS_PAINT = 32 -QS_SENDMESSAGE = 64 -QS_HOTKEY = 128 -QS_MOUSE = (QS_MOUSEMOVE - | QS_MOUSEBUTTON) -QS_INPUT = (QS_MOUSE - | QS_KEY) -QS_ALLEVENTS = (QS_INPUT - | QS_POSTMESSAGE - | QS_TIMER - | QS_PAINT - | QS_HOTKEY) -QS_ALLINPUT = (QS_INPUT - | QS_POSTMESSAGE - | QS_TIMER - | QS_PAINT - | QS_HOTKEY - | QS_SENDMESSAGE) - - -IMN_CLOSESTATUSWINDOW = 1 -IMN_OPENSTATUSWINDOW = 2 -IMN_CHANGECANDIDATE = 3 -IMN_CLOSECANDIDATE = 4 -IMN_OPENCANDIDATE = 5 -IMN_SETCONVERSIONMODE = 6 -IMN_SETSENTENCEMODE = 7 -IMN_SETOPENSTATUS = 8 -IMN_SETCANDIDATEPOS = 9 -IMN_SETCOMPOSITIONFONT = 10 -IMN_SETCOMPOSITIONWINDOW = 11 -IMN_SETSTATUSWINDOWPOS = 12 -IMN_GUIDELINE = 13 -IMN_PRIVATE = 14 - -# winuser.h line 8518 -HELP_CONTEXT = 1 -HELP_QUIT = 2 -HELP_INDEX = 3 -HELP_CONTENTS = 3 -HELP_HELPONHELP = 4 -HELP_SETINDEX = 5 -HELP_SETCONTENTS = 5 -HELP_CONTEXTPOPUP = 8 -HELP_FORCEFILE = 9 -HELP_KEY = 257 -HELP_COMMAND = 258 -HELP_PARTIALKEY = 261 -HELP_MULTIKEY = 513 -HELP_SETWINPOS = 515 -HELP_CONTEXTMENU = 10 -HELP_FINDER = 11 -HELP_WM_HELP = 12 -HELP_SETPOPUP_POS = 13 -HELP_TCARD = 32768 -HELP_TCARD_DATA = 16 -HELP_TCARD_OTHER_CALLER = 17 -IDH_NO_HELP = 28440 -IDH_MISSING_CONTEXT = 28441 # Control doesn't have matching help context -IDH_GENERIC_HELP_BUTTON = 28442 # Property sheet help button -IDH_OK = 28443 -IDH_CANCEL = 28444 -IDH_HELP = 28445 -GR_GDIOBJECTS = 0 # Count of GDI objects -GR_USEROBJECTS = 1 # Count of USER objects -# Generated by h2py from \msvcnt\include\wingdi.h -# manually added (missed by generation some how! -SRCCOPY = 13369376 # dest = source -SRCPAINT = 15597702 # dest = source OR dest -SRCAND = 8913094 # dest = source AND dest -SRCINVERT = 6684742 # dest = source XOR dest -SRCERASE = 4457256 # dest = source AND (NOT dest ) -NOTSRCCOPY = 3342344 # dest = (NOT source) -NOTSRCERASE = 1114278 # dest = (NOT src) AND (NOT dest) -MERGECOPY = 12583114 # dest = (source AND pattern) -MERGEPAINT = 12255782 # dest = (NOT source) OR dest -PATCOPY = 15728673 # dest = pattern -PATPAINT = 16452105 # dest = DPSnoo -PATINVERT = 5898313 # dest = pattern XOR dest -DSTINVERT = 5570569 # dest = (NOT dest) -BLACKNESS = 66 # dest = BLACK -WHITENESS = 16711778 # dest = WHITE - -# hacked and split manually by mhammond. -R2_BLACK = 1 -R2_NOTMERGEPEN = 2 -R2_MASKNOTPEN = 3 -R2_NOTCOPYPEN = 4 -R2_MASKPENNOT = 5 -R2_NOT = 6 -R2_XORPEN = 7 -R2_NOTMASKPEN = 8 -R2_MASKPEN = 9 -R2_NOTXORPEN = 10 -R2_NOP = 11 -R2_MERGENOTPEN = 12 -R2_COPYPEN = 13 -R2_MERGEPENNOT = 14 -R2_MERGEPEN = 15 -R2_WHITE = 16 -R2_LAST = 16 -GDI_ERROR = (-1) -ERROR = 0 -NULLREGION = 1 -SIMPLEREGION = 2 -COMPLEXREGION = 3 -RGN_ERROR = ERROR -RGN_AND = 1 -RGN_OR = 2 -RGN_XOR = 3 -RGN_DIFF = 4 -RGN_COPY = 5 -RGN_MIN = RGN_AND -RGN_MAX = RGN_COPY - -# Stretching modes used with Get/SetStretchBltMode -BLACKONWHITE = 1 -WHITEONBLACK = 2 -COLORONCOLOR = 3 -HALFTONE = 4 -MAXSTRETCHBLTMODE = 4 -STRETCH_ANDSCANS = BLACKONWHITE -STRETCH_ORSCANS = WHITEONBLACK -STRETCH_DELETESCANS = COLORONCOLOR -STRETCH_HALFTONE = HALFTONE - -ALTERNATE = 1 -WINDING = 2 -POLYFILL_LAST = 2 - -# flags used with SetLayout -LAYOUT_RTL = 1 -LAYOUT_BTT = 2 -LAYOUT_VBH = 4 -LAYOUT_ORIENTATIONMASK = LAYOUT_RTL | LAYOUT_BTT | LAYOUT_VBH -LAYOUT_BITMAPORIENTATIONPRESERVED = 8 - -TA_NOUPDATECP = 0 -TA_UPDATECP = 1 -TA_LEFT = 0 -TA_RIGHT = 2 -TA_CENTER = 6 -TA_TOP = 0 -TA_BOTTOM = 8 -TA_BASELINE = 24 -TA_MASK = (TA_BASELINE + TA_CENTER + TA_UPDATECP) -VTA_BASELINE = TA_BASELINE -VTA_LEFT = TA_BOTTOM -VTA_RIGHT = TA_TOP -VTA_CENTER = TA_CENTER -VTA_BOTTOM = TA_RIGHT -VTA_TOP = TA_LEFT -ETO_GRAYED = 1 -ETO_OPAQUE = 2 -ETO_CLIPPED = 4 -ASPECT_FILTERING = 1 -DCB_RESET = 1 -DCB_ACCUMULATE = 2 -DCB_DIRTY = DCB_ACCUMULATE -DCB_SET = (DCB_RESET | DCB_ACCUMULATE) -DCB_ENABLE = 4 -DCB_DISABLE = 8 -META_SETBKCOLOR = 513 -META_SETBKMODE = 258 -META_SETMAPMODE = 259 -META_SETROP2 = 260 -META_SETRELABS = 261 -META_SETPOLYFILLMODE = 262 -META_SETSTRETCHBLTMODE = 263 -META_SETTEXTCHAREXTRA = 264 -META_SETTEXTCOLOR = 521 -META_SETTEXTJUSTIFICATION = 522 -META_SETWINDOWORG = 523 -META_SETWINDOWEXT = 524 -META_SETVIEWPORTORG = 525 -META_SETVIEWPORTEXT = 526 -META_OFFSETWINDOWORG = 527 -META_SCALEWINDOWEXT = 1040 -META_OFFSETVIEWPORTORG = 529 -META_SCALEVIEWPORTEXT = 1042 -META_LINETO = 531 -META_MOVETO = 532 -META_EXCLUDECLIPRECT = 1045 -META_INTERSECTCLIPRECT = 1046 -META_ARC = 2071 -META_ELLIPSE = 1048 -META_FLOODFILL = 1049 -META_PIE = 2074 -META_RECTANGLE = 1051 -META_ROUNDRECT = 1564 -META_PATBLT = 1565 -META_SAVEDC = 30 -META_SETPIXEL = 1055 -META_OFFSETCLIPRGN = 544 -META_TEXTOUT = 1313 -META_BITBLT = 2338 -META_STRETCHBLT = 2851 -META_POLYGON = 804 -META_POLYLINE = 805 -META_ESCAPE = 1574 -META_RESTOREDC = 295 -META_FILLREGION = 552 -META_FRAMEREGION = 1065 -META_INVERTREGION = 298 -META_PAINTREGION = 299 -META_SELECTCLIPREGION = 300 -META_SELECTOBJECT = 301 -META_SETTEXTALIGN = 302 -META_CHORD = 2096 -META_SETMAPPERFLAGS = 561 -META_EXTTEXTOUT = 2610 -META_SETDIBTODEV = 3379 -META_SELECTPALETTE = 564 -META_REALIZEPALETTE = 53 -META_ANIMATEPALETTE = 1078 -META_SETPALENTRIES = 55 -META_POLYPOLYGON = 1336 -META_RESIZEPALETTE = 313 -META_DIBBITBLT = 2368 -META_DIBSTRETCHBLT = 2881 -META_DIBCREATEPATTERNBRUSH = 322 -META_STRETCHDIB = 3907 -META_EXTFLOODFILL = 1352 -META_DELETEOBJECT = 496 -META_CREATEPALETTE = 247 -META_CREATEPATTERNBRUSH = 505 -META_CREATEPENINDIRECT = 762 -META_CREATEFONTINDIRECT = 763 -META_CREATEBRUSHINDIRECT = 764 -META_CREATEREGION = 1791 -FILE_BEGIN = 0 -FILE_CURRENT = 1 -FILE_END = 2 -FILE_FLAG_WRITE_THROUGH = -2147483648 -FILE_FLAG_OVERLAPPED = 1073741824 -FILE_FLAG_NO_BUFFERING = 536870912 -FILE_FLAG_RANDOM_ACCESS = 268435456 -FILE_FLAG_SEQUENTIAL_SCAN = 134217728 -FILE_FLAG_DELETE_ON_CLOSE = 67108864 -FILE_FLAG_BACKUP_SEMANTICS = 33554432 -FILE_FLAG_POSIX_SEMANTICS = 16777216 -CREATE_NEW = 1 -CREATE_ALWAYS = 2 -OPEN_EXISTING = 3 -OPEN_ALWAYS = 4 -TRUNCATE_EXISTING = 5 -PIPE_ACCESS_INBOUND = 1 -PIPE_ACCESS_OUTBOUND = 2 -PIPE_ACCESS_DUPLEX = 3 -PIPE_CLIENT_END = 0 -PIPE_SERVER_END = 1 -PIPE_WAIT = 0 -PIPE_NOWAIT = 1 -PIPE_READMODE_BYTE = 0 -PIPE_READMODE_MESSAGE = 2 -PIPE_TYPE_BYTE = 0 -PIPE_TYPE_MESSAGE = 4 -PIPE_UNLIMITED_INSTANCES = 255 -SECURITY_CONTEXT_TRACKING = 262144 -SECURITY_EFFECTIVE_ONLY = 524288 -SECURITY_SQOS_PRESENT = 1048576 -SECURITY_VALID_SQOS_FLAGS = 2031616 -DTR_CONTROL_DISABLE = 0 -DTR_CONTROL_ENABLE = 1 -DTR_CONTROL_HANDSHAKE = 2 -RTS_CONTROL_DISABLE = 0 -RTS_CONTROL_ENABLE = 1 -RTS_CONTROL_HANDSHAKE = 2 -RTS_CONTROL_TOGGLE = 3 -GMEM_FIXED = 0 -GMEM_MOVEABLE = 2 -GMEM_NOCOMPACT = 16 -GMEM_NODISCARD = 32 -GMEM_ZEROINIT = 64 -GMEM_MODIFY = 128 -GMEM_DISCARDABLE = 256 -GMEM_NOT_BANKED = 4096 -GMEM_SHARE = 8192 -GMEM_DDESHARE = 8192 -GMEM_NOTIFY = 16384 -GMEM_LOWER = GMEM_NOT_BANKED -GMEM_VALID_FLAGS = 32626 -GMEM_INVALID_HANDLE = 32768 -GHND = (GMEM_MOVEABLE | GMEM_ZEROINIT) -GPTR = (GMEM_FIXED | GMEM_ZEROINIT) -GMEM_DISCARDED = 16384 -GMEM_LOCKCOUNT = 255 -LMEM_FIXED = 0 -LMEM_MOVEABLE = 2 -LMEM_NOCOMPACT = 16 -LMEM_NODISCARD = 32 -LMEM_ZEROINIT = 64 -LMEM_MODIFY = 128 -LMEM_DISCARDABLE = 3840 -LMEM_VALID_FLAGS = 3954 -LMEM_INVALID_HANDLE = 32768 -LHND = (LMEM_MOVEABLE | LMEM_ZEROINIT) -LPTR = (LMEM_FIXED | LMEM_ZEROINIT) -NONZEROLHND = (LMEM_MOVEABLE) -NONZEROLPTR = (LMEM_FIXED) -LMEM_DISCARDED = 16384 -LMEM_LOCKCOUNT = 255 -DEBUG_PROCESS = 1 -DEBUG_ONLY_THIS_PROCESS = 2 -CREATE_SUSPENDED = 4 -DETACHED_PROCESS = 8 -CREATE_NEW_CONSOLE = 16 -NORMAL_PRIORITY_CLASS = 32 -IDLE_PRIORITY_CLASS = 64 -HIGH_PRIORITY_CLASS = 128 -REALTIME_PRIORITY_CLASS = 256 -CREATE_NEW_PROCESS_GROUP = 512 -CREATE_UNICODE_ENVIRONMENT = 1024 -CREATE_SEPARATE_WOW_VDM = 2048 -CREATE_SHARED_WOW_VDM = 4096 -CREATE_DEFAULT_ERROR_MODE = 67108864 -CREATE_NO_WINDOW = 134217728 -PROFILE_USER = 268435456 -PROFILE_KERNEL = 536870912 -PROFILE_SERVER = 1073741824 -THREAD_BASE_PRIORITY_LOWRT = 15 -THREAD_BASE_PRIORITY_MAX = 2 -THREAD_BASE_PRIORITY_MIN = -2 -THREAD_BASE_PRIORITY_IDLE = -15 -THREAD_PRIORITY_LOWEST = THREAD_BASE_PRIORITY_MIN -THREAD_PRIORITY_BELOW_NORMAL = THREAD_PRIORITY_LOWEST + 1 -THREAD_PRIORITY_HIGHEST = THREAD_BASE_PRIORITY_MAX -THREAD_PRIORITY_ABOVE_NORMAL = THREAD_PRIORITY_HIGHEST - 1 -THREAD_PRIORITY_ERROR_RETURN = MAXLONG -THREAD_PRIORITY_TIME_CRITICAL = THREAD_BASE_PRIORITY_LOWRT -THREAD_PRIORITY_IDLE = THREAD_BASE_PRIORITY_IDLE -THREAD_PRIORITY_NORMAL = 0 -THREAD_MODE_BACKGROUND_BEGIN = 0x00010000 -THREAD_MODE_BACKGROUND_END = 0x00020000 - -EXCEPTION_DEBUG_EVENT = 1 -CREATE_THREAD_DEBUG_EVENT = 2 -CREATE_PROCESS_DEBUG_EVENT = 3 -EXIT_THREAD_DEBUG_EVENT = 4 -EXIT_PROCESS_DEBUG_EVENT = 5 -LOAD_DLL_DEBUG_EVENT = 6 -UNLOAD_DLL_DEBUG_EVENT = 7 -OUTPUT_DEBUG_STRING_EVENT = 8 -RIP_EVENT = 9 -DRIVE_UNKNOWN = 0 -DRIVE_NO_ROOT_DIR = 1 -DRIVE_REMOVABLE = 2 -DRIVE_FIXED = 3 -DRIVE_REMOTE = 4 -DRIVE_CDROM = 5 -DRIVE_RAMDISK = 6 -FILE_TYPE_UNKNOWN = 0 -FILE_TYPE_DISK = 1 -FILE_TYPE_CHAR = 2 -FILE_TYPE_PIPE = 3 -FILE_TYPE_REMOTE = 32768 -NOPARITY = 0 -ODDPARITY = 1 -EVENPARITY = 2 -MARKPARITY = 3 -SPACEPARITY = 4 -ONESTOPBIT = 0 -ONE5STOPBITS = 1 -TWOSTOPBITS = 2 -CBR_110 = 110 -CBR_300 = 300 -CBR_600 = 600 -CBR_1200 = 1200 -CBR_2400 = 2400 -CBR_4800 = 4800 -CBR_9600 = 9600 -CBR_14400 = 14400 -CBR_19200 = 19200 -CBR_38400 = 38400 -CBR_56000 = 56000 -CBR_57600 = 57600 -CBR_115200 = 115200 -CBR_128000 = 128000 -CBR_256000 = 256000 -S_QUEUEEMPTY = 0 -S_THRESHOLD = 1 -S_ALLTHRESHOLD = 2 -S_NORMAL = 0 -S_LEGATO = 1 -S_STACCATO = 2 -NMPWAIT_WAIT_FOREVER = -1 -NMPWAIT_NOWAIT = 1 -NMPWAIT_USE_DEFAULT_WAIT = 0 -OF_READ = 0 -OF_WRITE = 1 -OF_READWRITE = 2 -OF_SHARE_COMPAT = 0 -OF_SHARE_EXCLUSIVE = 16 -OF_SHARE_DENY_WRITE = 32 -OF_SHARE_DENY_READ = 48 -OF_SHARE_DENY_NONE = 64 -OF_PARSE = 256 -OF_DELETE = 512 -OF_VERIFY = 1024 -OF_CANCEL = 2048 -OF_CREATE = 4096 -OF_PROMPT = 8192 -OF_EXIST = 16384 -OF_REOPEN = 32768 -OFS_MAXPATHNAME = 128 -MAXINTATOM = 49152 - -# winbase.h -PROCESS_HEAP_REGION = 1 -PROCESS_HEAP_UNCOMMITTED_RANGE = 2 -PROCESS_HEAP_ENTRY_BUSY = 4 -PROCESS_HEAP_ENTRY_MOVEABLE = 16 -PROCESS_HEAP_ENTRY_DDESHARE = 32 -SCS_32BIT_BINARY = 0 -SCS_DOS_BINARY = 1 -SCS_WOW_BINARY = 2 -SCS_PIF_BINARY = 3 -SCS_POSIX_BINARY = 4 -SCS_OS216_BINARY = 5 -SEM_FAILCRITICALERRORS = 1 -SEM_NOGPFAULTERRORBOX = 2 -SEM_NOALIGNMENTFAULTEXCEPT = 4 -SEM_NOOPENFILEERRORBOX = 32768 -LOCKFILE_FAIL_IMMEDIATELY = 1 -LOCKFILE_EXCLUSIVE_LOCK = 2 -HANDLE_FLAG_INHERIT = 1 -HANDLE_FLAG_PROTECT_FROM_CLOSE = 2 -HINSTANCE_ERROR = 32 -GET_TAPE_MEDIA_INFORMATION = 0 -GET_TAPE_DRIVE_INFORMATION = 1 -SET_TAPE_MEDIA_INFORMATION = 0 -SET_TAPE_DRIVE_INFORMATION = 1 -FORMAT_MESSAGE_ALLOCATE_BUFFER = 256 -FORMAT_MESSAGE_IGNORE_INSERTS = 512 -FORMAT_MESSAGE_FROM_STRING = 1024 -FORMAT_MESSAGE_FROM_HMODULE = 2048 -FORMAT_MESSAGE_FROM_SYSTEM = 4096 -FORMAT_MESSAGE_ARGUMENT_ARRAY = 8192 -FORMAT_MESSAGE_MAX_WIDTH_MASK = 255 -BACKUP_INVALID = 0 -BACKUP_DATA = 1 -BACKUP_EA_DATA = 2 -BACKUP_SECURITY_DATA = 3 -BACKUP_ALTERNATE_DATA = 4 -BACKUP_LINK = 5 -BACKUP_PROPERTY_DATA = 6 -BACKUP_OBJECT_ID = 7 -BACKUP_REPARSE_DATA = 8 -BACKUP_SPARSE_BLOCK = 9 - -STREAM_NORMAL_ATTRIBUTE = 0 -STREAM_MODIFIED_WHEN_READ = 1 -STREAM_CONTAINS_SECURITY = 2 -STREAM_CONTAINS_PROPERTIES = 4 -STARTF_USESHOWWINDOW = 1 -STARTF_USESIZE = 2 -STARTF_USEPOSITION = 4 -STARTF_USECOUNTCHARS = 8 -STARTF_USEFILLATTRIBUTE = 16 -STARTF_FORCEONFEEDBACK = 64 -STARTF_FORCEOFFFEEDBACK = 128 -STARTF_USESTDHANDLES = 256 -STARTF_USEHOTKEY = 512 -SHUTDOWN_NORETRY = 1 -DONT_RESOLVE_DLL_REFERENCES = 1 -LOAD_LIBRARY_AS_DATAFILE = 2 -LOAD_WITH_ALTERED_SEARCH_PATH = 8 -DDD_RAW_TARGET_PATH = 1 -DDD_REMOVE_DEFINITION = 2 -DDD_EXACT_MATCH_ON_REMOVE = 4 -MOVEFILE_REPLACE_EXISTING = 1 -MOVEFILE_COPY_ALLOWED = 2 -MOVEFILE_DELAY_UNTIL_REBOOT = 4 -MAX_COMPUTERNAME_LENGTH = 15 -LOGON32_LOGON_INTERACTIVE = 2 -LOGON32_LOGON_NETWORK = 3 -LOGON32_LOGON_BATCH = 4 -LOGON32_LOGON_SERVICE = 5 -LOGON32_LOGON_UNLOCK = 7 -LOGON32_LOGON_NETWORK_CLEARTEXT = 8 -LOGON32_LOGON_NEW_CREDENTIALS = 9 -LOGON32_PROVIDER_DEFAULT = 0 -LOGON32_PROVIDER_WINNT35 = 1 -LOGON32_PROVIDER_WINNT40 = 2 -LOGON32_PROVIDER_WINNT50 = 3 -VER_PLATFORM_WIN32s = 0 -VER_PLATFORM_WIN32_WINDOWS = 1 -VER_PLATFORM_WIN32_NT = 2 -TC_NORMAL = 0 -TC_HARDERR = 1 -TC_GP_TRAP = 2 -TC_SIGNAL = 3 -AC_LINE_OFFLINE = 0 -AC_LINE_ONLINE = 1 -AC_LINE_BACKUP_POWER = 2 -AC_LINE_UNKNOWN = 255 -BATTERY_FLAG_HIGH = 1 -BATTERY_FLAG_LOW = 2 -BATTERY_FLAG_CRITICAL = 4 -BATTERY_FLAG_CHARGING = 8 -BATTERY_FLAG_NO_BATTERY = 128 -BATTERY_FLAG_UNKNOWN = 255 -BATTERY_PERCENTAGE_UNKNOWN = 255 -BATTERY_LIFE_UNKNOWN = -1 - -# Generated by h2py from d:\msdev\include\richedit.h -cchTextLimitDefault = 32767 -WM_CONTEXTMENU = 123 -WM_PRINTCLIENT = 792 -EN_MSGFILTER = 1792 -EN_REQUESTRESIZE = 1793 -EN_SELCHANGE = 1794 -EN_DROPFILES = 1795 -EN_PROTECTED = 1796 -EN_CORRECTTEXT = 1797 -EN_STOPNOUNDO = 1798 -EN_IMECHANGE = 1799 -EN_SAVECLIPBOARD = 1800 -EN_OLEOPFAILED = 1801 -ENM_NONE = 0 -ENM_CHANGE = 1 -ENM_UPDATE = 2 -ENM_SCROLL = 4 -ENM_KEYEVENTS = 65536 -ENM_MOUSEEVENTS = 131072 -ENM_REQUESTRESIZE = 262144 -ENM_SELCHANGE = 524288 -ENM_DROPFILES = 1048576 -ENM_PROTECTED = 2097152 -ENM_CORRECTTEXT = 4194304 -ENM_IMECHANGE = 8388608 -ES_SAVESEL = 32768 -ES_SUNKEN = 16384 -ES_DISABLENOSCROLL = 8192 -ES_SELECTIONBAR = 16777216 -ES_EX_NOCALLOLEINIT = 16777216 -ES_VERTICAL = 4194304 -ES_NOIME = 524288 -ES_SELFIME = 262144 -ECO_AUTOWORDSELECTION = 1 -ECO_AUTOVSCROLL = 64 -ECO_AUTOHSCROLL = 128 -ECO_NOHIDESEL = 256 -ECO_READONLY = 2048 -ECO_WANTRETURN = 4096 -ECO_SAVESEL = 32768 -ECO_SELECTIONBAR = 16777216 -ECO_VERTICAL = 4194304 -ECOOP_SET = 1 -ECOOP_OR = 2 -ECOOP_AND = 3 -ECOOP_XOR = 4 -WB_CLASSIFY = 3 -WB_MOVEWORDLEFT = 4 -WB_MOVEWORDRIGHT = 5 -WB_LEFTBREAK = 6 -WB_RIGHTBREAK = 7 -WB_MOVEWORDPREV = 4 -WB_MOVEWORDNEXT = 5 -WB_PREVBREAK = 6 -WB_NEXTBREAK = 7 -PC_FOLLOWING = 1 -PC_LEADING = 2 -PC_OVERFLOW = 3 -PC_DELIMITER = 4 -WBF_WORDWRAP = 16 -WBF_WORDBREAK = 32 -WBF_OVERFLOW = 64 -WBF_LEVEL1 = 128 -WBF_LEVEL2 = 256 -WBF_CUSTOM = 512 -CFM_BOLD = 1 -CFM_ITALIC = 2 -CFM_UNDERLINE = 4 -CFM_STRIKEOUT = 8 -CFM_PROTECTED = 16 -CFM_SIZE = -2147483648 -CFM_COLOR = 1073741824 -CFM_FACE = 536870912 -CFM_OFFSET = 268435456 -CFM_CHARSET = 134217728 -CFE_BOLD = 1 -CFE_ITALIC = 2 -CFE_UNDERLINE = 4 -CFE_STRIKEOUT = 8 -CFE_PROTECTED = 16 -CFE_AUTOCOLOR = 1073741824 -yHeightCharPtsMost = 1638 -SCF_SELECTION = 1 -SCF_WORD = 2 -SF_TEXT = 1 -SF_RTF = 2 -SF_RTFNOOBJS = 3 -SF_TEXTIZED = 4 -SFF_SELECTION = 32768 -SFF_PLAINRTF = 16384 -MAX_TAB_STOPS = 32 -lDefaultTab = 720 -PFM_STARTINDENT = 1 -PFM_RIGHTINDENT = 2 -PFM_OFFSET = 4 -PFM_ALIGNMENT = 8 -PFM_TABSTOPS = 16 -PFM_NUMBERING = 32 -PFM_OFFSETINDENT = -2147483648 -PFN_BULLET = 1 -PFA_LEFT = 1 -PFA_RIGHT = 2 -PFA_CENTER = 3 -WM_NOTIFY = 78 -SEL_EMPTY = 0 -SEL_TEXT = 1 -SEL_OBJECT = 2 -SEL_MULTICHAR = 4 -SEL_MULTIOBJECT = 8 -OLEOP_DOVERB = 1 -CF_RTF = "Rich Text Format" -CF_RTFNOOBJS = "Rich Text Format Without Objects" -CF_RETEXTOBJ = "RichEdit Text and Objects" - -# From wincon.h -RIGHT_ALT_PRESSED = 1 # the right alt key is pressed. -LEFT_ALT_PRESSED = 2 # the left alt key is pressed. -RIGHT_CTRL_PRESSED = 4 # the right ctrl key is pressed. -LEFT_CTRL_PRESSED = 8 # the left ctrl key is pressed. -SHIFT_PRESSED = 16 # the shift key is pressed. -NUMLOCK_ON = 32 # the numlock light is on. -SCROLLLOCK_ON = 64 # the scrolllock light is on. -CAPSLOCK_ON = 128 # the capslock light is on. -ENHANCED_KEY = 256 # the key is enhanced. -NLS_DBCSCHAR = 65536 # DBCS for JPN: SBCS/DBCS mode. -NLS_ALPHANUMERIC = 0 # DBCS for JPN: Alphanumeric mode. -NLS_KATAKANA = 131072 # DBCS for JPN: Katakana mode. -NLS_HIRAGANA = 262144 # DBCS for JPN: Hiragana mode. -NLS_ROMAN = 4194304 # DBCS for JPN: Roman/Noroman mode. -NLS_IME_CONVERSION = 8388608 # DBCS for JPN: IME conversion. -NLS_IME_DISABLE = 536870912 # DBCS for JPN: IME enable/disable. - -FROM_LEFT_1ST_BUTTON_PRESSED = 1 -RIGHTMOST_BUTTON_PRESSED = 2 -FROM_LEFT_2ND_BUTTON_PRESSED = 4 -FROM_LEFT_3RD_BUTTON_PRESSED = 8 -FROM_LEFT_4TH_BUTTON_PRESSED = 16 - -CTRL_C_EVENT = 0 -CTRL_BREAK_EVENT = 1 -CTRL_CLOSE_EVENT = 2 -CTRL_LOGOFF_EVENT = 5 -CTRL_SHUTDOWN_EVENT = 6 - -MOUSE_MOVED = 1 -DOUBLE_CLICK = 2 -MOUSE_WHEELED = 4 - -# property sheet window messages from prsht.h -PSM_SETCURSEL = (WM_USER + 101) -PSM_REMOVEPAGE = (WM_USER + 102) -PSM_ADDPAGE = (WM_USER + 103) -PSM_CHANGED = (WM_USER + 104) -PSM_RESTARTWINDOWS = (WM_USER + 105) -PSM_REBOOTSYSTEM = (WM_USER + 106) -PSM_CANCELTOCLOSE = (WM_USER + 107) -PSM_QUERYSIBLINGS = (WM_USER + 108) -PSM_UNCHANGED = (WM_USER + 109) -PSM_APPLY = (WM_USER + 110) -PSM_SETTITLEA = (WM_USER + 111) -PSM_SETTITLEW = (WM_USER + 120) -PSM_SETWIZBUTTONS = (WM_USER + 112) -PSM_PRESSBUTTON = (WM_USER + 113) -PSM_SETCURSELID = (WM_USER + 114) -PSM_SETFINISHTEXTA = (WM_USER + 115) -PSM_SETFINISHTEXTW = (WM_USER + 121) -PSM_GETTABCONTROL = (WM_USER + 116) -PSM_ISDIALOGMESSAGE = (WM_USER + 117) -PSM_GETCURRENTPAGEHWND = (WM_USER + 118) -PSM_INSERTPAGE = (WM_USER + 119) -PSM_SETHEADERTITLEA = (WM_USER + 125) -PSM_SETHEADERTITLEW = (WM_USER + 126) -PSM_SETHEADERSUBTITLEA = (WM_USER + 127) -PSM_SETHEADERSUBTITLEW = (WM_USER + 128) -PSM_HWNDTOINDEX = (WM_USER + 129) -PSM_INDEXTOHWND = (WM_USER + 130) -PSM_PAGETOINDEX = (WM_USER + 131) -PSM_INDEXTOPAGE = (WM_USER + 132) -PSM_IDTOINDEX = (WM_USER + 133) -PSM_INDEXTOID = (WM_USER + 134) -PSM_GETRESULT = (WM_USER + 135) -PSM_RECALCPAGESIZES = (WM_USER + 136) - -# GetUserNameEx/GetComputerNameEx -NameUnknown = 0 -NameFullyQualifiedDN = 1 -NameSamCompatible = 2 -NameDisplay = 3 -NameUniqueId = 6 -NameCanonical = 7 -NameUserPrincipal = 8 -NameCanonicalEx = 9 -NameServicePrincipal = 10 -NameDnsDomain = 12 - -ComputerNameNetBIOS = 0 -ComputerNameDnsHostname = 1 -ComputerNameDnsDomain = 2 -ComputerNameDnsFullyQualified = 3 -ComputerNamePhysicalNetBIOS = 4 -ComputerNamePhysicalDnsHostname = 5 -ComputerNamePhysicalDnsDomain = 6 -ComputerNamePhysicalDnsFullyQualified = 7 - -LWA_COLORKEY = 0x00000001 -LWA_ALPHA = 0x00000002 -ULW_COLORKEY = 0x00000001 -ULW_ALPHA = 0x00000002 -ULW_OPAQUE = 0x00000004 - -# WinDef.h -TRUE = 1 -FALSE = 0 -MAX_PATH = 260 -# WinGDI.h -AC_SRC_OVER = 0 -AC_SRC_ALPHA = 1 -GRADIENT_FILL_RECT_H = 0 -GRADIENT_FILL_RECT_V = 1 -GRADIENT_FILL_TRIANGLE = 2 -GRADIENT_FILL_OP_FLAG = 255 - -# flags used with Get/SetSystemFileCacheSize -MM_WORKING_SET_MAX_HARD_ENABLE = 1 -MM_WORKING_SET_MAX_HARD_DISABLE = 2 -MM_WORKING_SET_MIN_HARD_ENABLE = 4 -MM_WORKING_SET_MIN_HARD_DISABLE = 8 - -# Flags for GetFinalPathNameByHandle -VOLUME_NAME_DOS = 0 -VOLUME_NAME_GUID = 1 -VOLUME_NAME_NT = 2 -VOLUME_NAME_NONE = 4 -FILE_NAME_NORMALIZED = 0 -FILE_NAME_OPENED = 8 - -DEVICE_NOTIFY_WINDOW_HANDLE = 0x00000000 -DEVICE_NOTIFY_SERVICE_HANDLE = 0x00000001 - -# From Dbt.h -# Generated by h2py from Dbt.h -WM_DEVICECHANGE = 0x0219 -BSF_QUERY = 0x00000001 -BSF_IGNORECURRENTTASK = 0x00000002 -BSF_FLUSHDISK = 0x00000004 -BSF_NOHANG = 0x00000008 -BSF_POSTMESSAGE = 0x00000010 -BSF_FORCEIFHUNG = 0x00000020 -BSF_NOTIMEOUTIFNOTHUNG = 0x00000040 -BSF_MSGSRV32ISOK = (-2147483648) -BSF_MSGSRV32ISOK_BIT = 31 -BSM_ALLCOMPONENTS = 0x00000000 -BSM_VXDS = 0x00000001 -BSM_NETDRIVER = 0x00000002 -BSM_INSTALLABLEDRIVERS = 0x00000004 -BSM_APPLICATIONS = 0x00000008 -DBT_APPYBEGIN = 0x0000 -DBT_APPYEND = 0x0001 -DBT_DEVNODES_CHANGED = 0x0007 -DBT_QUERYCHANGECONFIG = 0x0017 -DBT_CONFIGCHANGED = 0x0018 -DBT_CONFIGCHANGECANCELED = 0x0019 -DBT_MONITORCHANGE = 0x001B -DBT_SHELLLOGGEDON = 0x0020 -DBT_CONFIGMGAPI32 = 0x0022 -DBT_VXDINITCOMPLETE = 0x0023 -DBT_VOLLOCKQUERYLOCK = 0x8041 -DBT_VOLLOCKLOCKTAKEN = 0x8042 -DBT_VOLLOCKLOCKFAILED = 0x8043 -DBT_VOLLOCKQUERYUNLOCK = 0x8044 -DBT_VOLLOCKLOCKRELEASED = 0x8045 -DBT_VOLLOCKUNLOCKFAILED = 0x8046 -LOCKP_ALLOW_WRITES = 0x01 -LOCKP_FAIL_WRITES = 0x00 -LOCKP_FAIL_MEM_MAPPING = 0x02 -LOCKP_ALLOW_MEM_MAPPING = 0x00 -LOCKP_USER_MASK = 0x03 -LOCKP_LOCK_FOR_FORMAT = 0x04 -LOCKF_LOGICAL_LOCK = 0x00 -LOCKF_PHYSICAL_LOCK = 0x01 -DBT_NO_DISK_SPACE = 0x0047 -DBT_LOW_DISK_SPACE = 0x0048 -DBT_CONFIGMGPRIVATE = 0x7FFF -DBT_DEVICEARRIVAL = 0x8000 -DBT_DEVICEQUERYREMOVE = 0x8001 -DBT_DEVICEQUERYREMOVEFAILED = 0x8002 -DBT_DEVICEREMOVEPENDING = 0x8003 -DBT_DEVICEREMOVECOMPLETE = 0x8004 -DBT_DEVICETYPESPECIFIC = 0x8005 -DBT_CUSTOMEVENT = 0x8006 -DBT_DEVTYP_OEM = 0x00000000 -DBT_DEVTYP_DEVNODE = 0x00000001 -DBT_DEVTYP_VOLUME = 0x00000002 -DBT_DEVTYP_PORT = 0x00000003 -DBT_DEVTYP_NET = 0x00000004 -DBT_DEVTYP_DEVICEINTERFACE = 0x00000005 -DBT_DEVTYP_HANDLE = 0x00000006 -DBTF_MEDIA = 0x0001 -DBTF_NET = 0x0002 -DBTF_RESOURCE = 0x00000001 -DBTF_XPORT = 0x00000002 -DBTF_SLOWNET = 0x00000004 -DBT_VPOWERDAPI = 0x8100 -DBT_USERDEFINED = 0xFFFF diff --git a/typings/win32helper/__init__.pyi b/typings/win32helper/__init__.pyi deleted file mode 100644 index e69de29b..00000000 diff --git a/typings/win32helper/ntsecuritycon.pyi b/typings/win32helper/ntsecuritycon.pyi deleted file mode 100644 index 8d6eeb2b..00000000 --- a/typings/win32helper/ntsecuritycon.pyi +++ /dev/null @@ -1,690 +0,0 @@ -# Hacked from winnt.h - -DELETE = (65536) -READ_CONTROL = (131072) -WRITE_DAC = (262144) -WRITE_OWNER = (524288) -SYNCHRONIZE = (1048576) -STANDARD_RIGHTS_REQUIRED = (983040) -STANDARD_RIGHTS_READ = (READ_CONTROL) -STANDARD_RIGHTS_WRITE = (READ_CONTROL) -STANDARD_RIGHTS_EXECUTE = (READ_CONTROL) -STANDARD_RIGHTS_ALL = (2031616) -SPECIFIC_RIGHTS_ALL = (65535) -ACCESS_SYSTEM_SECURITY = (16777216) -MAXIMUM_ALLOWED = (33554432) -GENERIC_READ = (-2147483648) -GENERIC_WRITE = (1073741824) -GENERIC_EXECUTE = (536870912) -GENERIC_ALL = (268435456) - -# file security permissions -FILE_READ_DATA = (1) -FILE_LIST_DIRECTORY = (1) -FILE_WRITE_DATA = (2) -FILE_ADD_FILE = (2) -FILE_APPEND_DATA = (4) -FILE_ADD_SUBDIRECTORY = (4) -FILE_CREATE_PIPE_INSTANCE = (4) -FILE_READ_EA = (8) -FILE_WRITE_EA = (16) -FILE_EXECUTE = (32) -FILE_TRAVERSE = (32) -FILE_DELETE_CHILD = (64) -FILE_READ_ATTRIBUTES = (128) -FILE_WRITE_ATTRIBUTES = (256) -FILE_ALL_ACCESS = (STANDARD_RIGHTS_REQUIRED | SYNCHRONIZE | 511) -FILE_GENERIC_READ = (STANDARD_RIGHTS_READ | FILE_READ_DATA | FILE_READ_ATTRIBUTES | FILE_READ_EA | SYNCHRONIZE) -FILE_GENERIC_WRITE = (STANDARD_RIGHTS_WRITE | FILE_WRITE_DATA | FILE_WRITE_ATTRIBUTES - | FILE_WRITE_EA | FILE_APPEND_DATA | SYNCHRONIZE) -FILE_GENERIC_EXECUTE = (STANDARD_RIGHTS_EXECUTE | FILE_READ_ATTRIBUTES | FILE_EXECUTE | SYNCHRONIZE) - - -SECURITY_NULL_SID_AUTHORITY = (0, 0, 0, 0, 0, 0) -SECURITY_WORLD_SID_AUTHORITY = (0, 0, 0, 0, 0, 1) -SECURITY_LOCAL_SID_AUTHORITY = (0, 0, 0, 0, 0, 2) -SECURITY_CREATOR_SID_AUTHORITY = (0, 0, 0, 0, 0, 3) -SECURITY_NON_UNIQUE_AUTHORITY = (0, 0, 0, 0, 0, 4) -SECURITY_RESOURCE_MANAGER_AUTHORITY = (0, 0, 0, 0, 0, 9) - -SECURITY_NULL_RID = 0 -SECURITY_WORLD_RID = 0 -SECURITY_LOCAL_RID = 0X00000000 - -SECURITY_CREATOR_OWNER_RID = 0 -SECURITY_CREATOR_GROUP_RID = 1 - -SECURITY_CREATOR_OWNER_SERVER_RID = 2 -SECURITY_CREATOR_GROUP_SERVER_RID = 3 -SECURITY_CREATOR_OWNER_RIGHTS_RID = 4 - -# NT well-known SIDs -SECURITY_NT_AUTHORITY = (0, 0, 0, 0, 0, 5) - -SECURITY_DIALUP_RID = 1 -SECURITY_NETWORK_RID = 2 -SECURITY_BATCH_RID = 3 -SECURITY_INTERACTIVE_RID = 4 -SECURITY_SERVICE_RID = 6 -SECURITY_ANONYMOUS_LOGON_RID = 7 -SECURITY_PROXY_RID = 8 -SECURITY_SERVER_LOGON_RID = 9 - -SECURITY_LOGON_IDS_RID = 5 -SECURITY_LOGON_IDS_RID_COUNT = 3 - -SECURITY_LOCAL_SYSTEM_RID = 18 - -SECURITY_NT_NON_UNIQUE = 21 - -SECURITY_BUILTIN_DOMAIN_RID = 32 - -# well-known domain relative sub-authority values (RIDs)... -DOMAIN_USER_RID_ADMIN = 500 -DOMAIN_USER_RID_GUEST = 501 -DOMAIN_USER_RID_KRBTGT = 502 -DOMAIN_USER_RID_MAX = 999 - -# well-known groups ... -DOMAIN_GROUP_RID_ADMINS = 512 -DOMAIN_GROUP_RID_USERS = 513 -DOMAIN_GROUP_RID_GUESTS = 514 -DOMAIN_GROUP_RID_COMPUTERS = 515 -DOMAIN_GROUP_RID_CONTROLLERS = 516 -DOMAIN_GROUP_RID_CERT_ADMINS = 517 -DOMAIN_GROUP_RID_SCHEMA_ADMINS = 518 -DOMAIN_GROUP_RID_ENTERPRISE_ADMINS = 519 -DOMAIN_GROUP_RID_POLICY_ADMINS = 520 -DOMAIN_GROUP_RID_READONLY_CONTROLLERS = 521 - -# well-known aliases ... -DOMAIN_ALIAS_RID_ADMINS = 544 -DOMAIN_ALIAS_RID_USERS = 545 -DOMAIN_ALIAS_RID_GUESTS = 546 -DOMAIN_ALIAS_RID_POWER_USERS = 547 -DOMAIN_ALIAS_RID_ACCOUNT_OPS = 548 -DOMAIN_ALIAS_RID_SYSTEM_OPS = 549 -DOMAIN_ALIAS_RID_PRINT_OPS = 550 -DOMAIN_ALIAS_RID_BACKUP_OPS = 551 -DOMAIN_ALIAS_RID_REPLICATOR = 552 -DOMAIN_ALIAS_RID_RAS_SERVERS = 553 -DOMAIN_ALIAS_RID_PREW2KCOMPACCESS = 554 -DOMAIN_ALIAS_RID_REMOTE_DESKTOP_USERS = 555 -DOMAIN_ALIAS_RID_NETWORK_CONFIGURATION_OPS = 556 -DOMAIN_ALIAS_RID_INCOMING_FOREST_TRUST_BUILDERS = 557 -DOMAIN_ALIAS_RID_MONITORING_USERS = 558 -DOMAIN_ALIAS_RID_LOGGING_USERS = 559 -DOMAIN_ALIAS_RID_AUTHORIZATIONACCESS = 560 -DOMAIN_ALIAS_RID_TS_LICENSE_SERVERS = 561 -DOMAIN_ALIAS_RID_DCOM_USERS = 562 -DOMAIN_ALIAS_RID_IUSERS = 568 -DOMAIN_ALIAS_RID_CRYPTO_OPERATORS = 569 -DOMAIN_ALIAS_RID_CACHEABLE_PRINCIPALS_GROUP = 571 -DOMAIN_ALIAS_RID_NON_CACHEABLE_PRINCIPALS_GROUP = 572 -DOMAIN_ALIAS_RID_EVENT_LOG_READERS_GROUP = 573 - -SECURITY_MANDATORY_LABEL_AUTHORITY = (0, 0, 0, 0, 0, 16) -SECURITY_MANDATORY_UNTRUSTED_RID = 0x00000000 -SECURITY_MANDATORY_LOW_RID = 0x00001000 -SECURITY_MANDATORY_MEDIUM_RID = 0x00002000 -SECURITY_MANDATORY_HIGH_RID = 0x00003000 -SECURITY_MANDATORY_SYSTEM_RID = 0x00004000 -SECURITY_MANDATORY_PROTECTED_PROCESS_RID = 0x00005000 -SECURITY_MANDATORY_MAXIMUM_USER_RID = SECURITY_MANDATORY_SYSTEM_RID - -SYSTEM_LUID = (999, 0) -ANONYMOUS_LOGON_LUID = (998, 0) -LOCALSERVICE_LUID = (997, 0) -NETWORKSERVICE_LUID = (996, 0) -IUSER_LUID = (995, 0) - -# Group attributes - -SE_GROUP_MANDATORY = 1 -SE_GROUP_ENABLED_BY_DEFAULT = 2 -SE_GROUP_ENABLED = 4 -SE_GROUP_OWNER = 8 -SE_GROUP_USE_FOR_DENY_ONLY = 16 -SE_GROUP_INTEGRITY = 32 -SE_GROUP_INTEGRITY_ENABLED = 64 -SE_GROUP_RESOURCE = 536870912 -SE_GROUP_LOGON_ID = -1073741824 - - -# User attributes -# (None yet defined.) - -# ACE types -ACCESS_MIN_MS_ACE_TYPE = (0) -ACCESS_ALLOWED_ACE_TYPE = (0) -ACCESS_DENIED_ACE_TYPE = (1) -SYSTEM_AUDIT_ACE_TYPE = (2) -SYSTEM_ALARM_ACE_TYPE = (3) -ACCESS_MAX_MS_V2_ACE_TYPE = (3) -ACCESS_ALLOWED_COMPOUND_ACE_TYPE = (4) -ACCESS_MAX_MS_V3_ACE_TYPE = (4) -ACCESS_MIN_MS_OBJECT_ACE_TYPE = (5) -ACCESS_ALLOWED_OBJECT_ACE_TYPE = (5) -ACCESS_DENIED_OBJECT_ACE_TYPE = (6) -SYSTEM_AUDIT_OBJECT_ACE_TYPE = (7) -SYSTEM_ALARM_OBJECT_ACE_TYPE = (8) -ACCESS_MAX_MS_OBJECT_ACE_TYPE = (8) -ACCESS_MAX_MS_V4_ACE_TYPE = (8) -ACCESS_MAX_MS_ACE_TYPE = (8) -ACCESS_ALLOWED_CALLBACK_ACE_TYPE = 9 -ACCESS_DENIED_CALLBACK_ACE_TYPE = 10 -ACCESS_ALLOWED_CALLBACK_OBJECT_ACE_TYPE = 11 -ACCESS_DENIED_CALLBACK_OBJECT_ACE_TYPE = 12 -SYSTEM_AUDIT_CALLBACK_ACE_TYPE = 13 -SYSTEM_ALARM_CALLBACK_ACE_TYPE = 14 -SYSTEM_AUDIT_CALLBACK_OBJECT_ACE_TYPE = 15 -SYSTEM_ALARM_CALLBACK_OBJECT_ACE_TYPE = 16 -SYSTEM_MANDATORY_LABEL_ACE_TYPE = 17 -ACCESS_MAX_MS_V5_ACE_TYPE = 17 - -# The following are the inherit flags that go into the AceFlags field -# of an Ace header. - -OBJECT_INHERIT_ACE = 1 -CONTAINER_INHERIT_ACE = 2 -NO_PROPAGATE_INHERIT_ACE = 4 -INHERIT_ONLY_ACE = 8 -VALID_INHERIT_FLAGS = 15 - - -SUCCESSFUL_ACCESS_ACE_FLAG = 64 -FAILED_ACCESS_ACE_FLAG = 128 - -SE_OWNER_DEFAULTED = 1 -SE_GROUP_DEFAULTED = 2 -SE_DACL_PRESENT = 4 -SE_DACL_DEFAULTED = 8 -SE_SACL_PRESENT = 16 -SE_SACL_DEFAULTED = 32 -SE_SELF_RELATIVE = 32768 - - -SE_PRIVILEGE_ENABLED_BY_DEFAULT = 1 -SE_PRIVILEGE_ENABLED = 2 -SE_PRIVILEGE_USED_FOR_ACCESS = -2147483648 - -PRIVILEGE_SET_ALL_NECESSARY = 1 - -# NT Defined Privileges - -SE_CREATE_TOKEN_NAME = "SeCreateTokenPrivilege" -SE_ASSIGNPRIMARYTOKEN_NAME = "SeAssignPrimaryTokenPrivilege" -SE_LOCK_MEMORY_NAME = "SeLockMemoryPrivilege" -SE_INCREASE_QUOTA_NAME = "SeIncreaseQuotaPrivilege" -SE_UNSOLICITED_INPUT_NAME = "SeUnsolicitedInputPrivilege" -SE_MACHINE_ACCOUNT_NAME = "SeMachineAccountPrivilege" -SE_TCB_NAME = "SeTcbPrivilege" -SE_SECURITY_NAME = "SeSecurityPrivilege" -SE_TAKE_OWNERSHIP_NAME = "SeTakeOwnershipPrivilege" -SE_LOAD_DRIVER_NAME = "SeLoadDriverPrivilege" -SE_SYSTEM_PROFILE_NAME = "SeSystemProfilePrivilege" -SE_SYSTEMTIME_NAME = "SeSystemtimePrivilege" -SE_PROF_SINGLE_PROCESS_NAME = "SeProfileSingleProcessPrivilege" -SE_INC_BASE_PRIORITY_NAME = "SeIncreaseBasePriorityPrivilege" -SE_CREATE_PAGEFILE_NAME = "SeCreatePagefilePrivilege" -SE_CREATE_PERMANENT_NAME = "SeCreatePermanentPrivilege" -SE_BACKUP_NAME = "SeBackupPrivilege" -SE_RESTORE_NAME = "SeRestorePrivilege" -SE_SHUTDOWN_NAME = "SeShutdownPrivilege" -SE_DEBUG_NAME = "SeDebugPrivilege" -SE_AUDIT_NAME = "SeAuditPrivilege" -SE_SYSTEM_ENVIRONMENT_NAME = "SeSystemEnvironmentPrivilege" -SE_CHANGE_NOTIFY_NAME = "SeChangeNotifyPrivilege" -SE_REMOTE_SHUTDOWN_NAME = "SeRemoteShutdownPrivilege" - - -# Enum SECURITY_IMPERSONATION_LEVEL: -SecurityAnonymous = 0 -SecurityIdentification = 1 -SecurityImpersonation = 2 -SecurityDelegation = 3 - -SECURITY_MAX_IMPERSONATION_LEVEL = SecurityDelegation - -DEFAULT_IMPERSONATION_LEVEL = SecurityImpersonation - -TOKEN_ASSIGN_PRIMARY = 1 -TOKEN_DUPLICATE = 2 -TOKEN_IMPERSONATE = 4 -TOKEN_QUERY = 8 -TOKEN_QUERY_SOURCE = 16 -TOKEN_ADJUST_PRIVILEGES = 32 -TOKEN_ADJUST_GROUPS = 64 -TOKEN_ADJUST_DEFAULT = 128 - -TOKEN_ALL_ACCESS = (STANDARD_RIGHTS_REQUIRED - | TOKEN_ASSIGN_PRIMARY - | TOKEN_DUPLICATE - | TOKEN_IMPERSONATE - | TOKEN_QUERY - | TOKEN_QUERY_SOURCE - | TOKEN_ADJUST_PRIVILEGES - | TOKEN_ADJUST_GROUPS - | TOKEN_ADJUST_DEFAULT) - - -TOKEN_READ = (STANDARD_RIGHTS_READ - | TOKEN_QUERY) - - -TOKEN_WRITE = (STANDARD_RIGHTS_WRITE - | TOKEN_ADJUST_PRIVILEGES - | TOKEN_ADJUST_GROUPS - | TOKEN_ADJUST_DEFAULT) - -TOKEN_EXECUTE = (STANDARD_RIGHTS_EXECUTE) - -SidTypeUser = 1 -SidTypeGroup = 2 -SidTypeDomain = 3 -SidTypeAlias = 4 -SidTypeWellKnownGroup = 5 -SidTypeDeletedAccount = 6 -SidTypeInvalid = 7 -SidTypeUnknown = 8 -SidTypeComputer = 9 -SidTypeLabel = 10 - -# Token types -TokenPrimary = 1 -TokenImpersonation = 2 - -# TOKEN_INFORMATION_CLASS, used with Get/SetTokenInformation -TokenUser = 1 -TokenGroups = 2 -TokenPrivileges = 3 -TokenOwner = 4 -TokenPrimaryGroup = 5 -TokenDefaultDacl = 6 -TokenSource = 7 -TokenType = 8 -TokenImpersonationLevel = 9 -TokenStatistics = 10 -TokenRestrictedSids = 11 -TokenSessionId = 12 -TokenGroupsAndPrivileges = 13 -TokenSessionReference = 14 -TokenSandBoxInert = 15 -TokenAuditPolicy = 16 -TokenOrigin = 17 -TokenElevationType = 18 -TokenLinkedToken = 19 -TokenElevation = 20 -TokenHasRestrictions = 21 -TokenAccessInformation = 22 -TokenVirtualizationAllowed = 23 -TokenVirtualizationEnabled = 24 -TokenIntegrityLevel = 25 -TokenUIAccess = 26 -TokenMandatoryPolicy = 27 -TokenLogonSid = 28 - -# DirectoryService related constants. -# Generated by h2py from NtDsAPI.h -DS_BEHAVIOR_WIN2000 = 0 -DS_BEHAVIOR_WIN2003_WITH_MIXED_DOMAINS = 1 -DS_BEHAVIOR_WIN2003 = 2 -DS_SYNCED_EVENT_NAME = "NTDSInitialSyncsCompleted" -ACTRL_DS_OPEN = 0x00000000 -ACTRL_DS_CREATE_CHILD = 0x00000001 -ACTRL_DS_DELETE_CHILD = 0x00000002 -ACTRL_DS_LIST = 0x00000004 -ACTRL_DS_SELF = 0x00000008 -ACTRL_DS_READ_PROP = 0x00000010 -ACTRL_DS_WRITE_PROP = 0x00000020 -ACTRL_DS_DELETE_TREE = 0x00000040 -ACTRL_DS_LIST_OBJECT = 0x00000080 -ACTRL_DS_CONTROL_ACCESS = 0x00000100 -NTDSAPI_BIND_ALLOW_DELEGATION = (0x00000001) -DS_REPSYNC_ASYNCHRONOUS_OPERATION = 0x00000001 -DS_REPSYNC_WRITEABLE = 0x00000002 -DS_REPSYNC_PERIODIC = 0x00000004 -DS_REPSYNC_INTERSITE_MESSAGING = 0x00000008 -DS_REPSYNC_ALL_SOURCES = 0x00000010 -DS_REPSYNC_FULL = 0x00000020 -DS_REPSYNC_URGENT = 0x00000040 -DS_REPSYNC_NO_DISCARD = 0x00000080 -DS_REPSYNC_FORCE = 0x00000100 -DS_REPSYNC_ADD_REFERENCE = 0x00000200 -DS_REPSYNC_NEVER_COMPLETED = 0x00000400 -DS_REPSYNC_TWO_WAY = 0x00000800 -DS_REPSYNC_NEVER_NOTIFY = 0x00001000 -DS_REPSYNC_INITIAL = 0x00002000 -DS_REPSYNC_USE_COMPRESSION = 0x00004000 -DS_REPSYNC_ABANDONED = 0x00008000 -DS_REPSYNC_INITIAL_IN_PROGRESS = 0x00010000 -DS_REPSYNC_PARTIAL_ATTRIBUTE_SET = 0x00020000 -DS_REPSYNC_REQUEUE = 0x00040000 -DS_REPSYNC_NOTIFICATION = 0x00080000 -DS_REPSYNC_ASYNCHRONOUS_REPLICA = 0x00100000 -DS_REPSYNC_CRITICAL = 0x00200000 -DS_REPSYNC_FULL_IN_PROGRESS = 0x00400000 -DS_REPSYNC_PREEMPTED = 0x00800000 -DS_REPADD_ASYNCHRONOUS_OPERATION = 0x00000001 -DS_REPADD_WRITEABLE = 0x00000002 -DS_REPADD_INITIAL = 0x00000004 -DS_REPADD_PERIODIC = 0x00000008 -DS_REPADD_INTERSITE_MESSAGING = 0x00000010 -DS_REPADD_ASYNCHRONOUS_REPLICA = 0x00000020 -DS_REPADD_DISABLE_NOTIFICATION = 0x00000040 -DS_REPADD_DISABLE_PERIODIC = 0x00000080 -DS_REPADD_USE_COMPRESSION = 0x00000100 -DS_REPADD_NEVER_NOTIFY = 0x00000200 -DS_REPADD_TWO_WAY = 0x00000400 -DS_REPADD_CRITICAL = 0x00000800 -DS_REPDEL_ASYNCHRONOUS_OPERATION = 0x00000001 -DS_REPDEL_WRITEABLE = 0x00000002 -DS_REPDEL_INTERSITE_MESSAGING = 0x00000004 -DS_REPDEL_IGNORE_ERRORS = 0x00000008 -DS_REPDEL_LOCAL_ONLY = 0x00000010 -DS_REPDEL_NO_SOURCE = 0x00000020 -DS_REPDEL_REF_OK = 0x00000040 -DS_REPMOD_ASYNCHRONOUS_OPERATION = 0x00000001 -DS_REPMOD_WRITEABLE = 0x00000002 -DS_REPMOD_UPDATE_FLAGS = 0x00000001 -DS_REPMOD_UPDATE_ADDRESS = 0x00000002 -DS_REPMOD_UPDATE_SCHEDULE = 0x00000004 -DS_REPMOD_UPDATE_RESULT = 0x00000008 -DS_REPMOD_UPDATE_TRANSPORT = 0x00000010 -DS_REPUPD_ASYNCHRONOUS_OPERATION = 0x00000001 -DS_REPUPD_WRITEABLE = 0x00000002 -DS_REPUPD_ADD_REFERENCE = 0x00000004 -DS_REPUPD_DELETE_REFERENCE = 0x00000008 -DS_INSTANCETYPE_IS_NC_HEAD = 0x00000001 -DS_INSTANCETYPE_NC_IS_WRITEABLE = 0x00000004 -DS_INSTANCETYPE_NC_COMING = 0x00000010 -DS_INSTANCETYPE_NC_GOING = 0x00000020 -NTDSDSA_OPT_IS_GC = (1 << 0) -NTDSDSA_OPT_DISABLE_INBOUND_REPL = (1 << 1) -NTDSDSA_OPT_DISABLE_OUTBOUND_REPL = (1 << 2) -NTDSDSA_OPT_DISABLE_NTDSCONN_XLATE = (1 << 3) -NTDSCONN_OPT_IS_GENERATED = (1 << 0) -NTDSCONN_OPT_TWOWAY_SYNC = (1 << 1) -NTDSCONN_OPT_OVERRIDE_NOTIFY_DEFAULT = (1 << 2) -NTDSCONN_OPT_USE_NOTIFY = (1 << 3) -NTDSCONN_OPT_DISABLE_INTERSITE_COMPRESSION = (1 << 4) -NTDSCONN_OPT_USER_OWNED_SCHEDULE = (1 << 5) -NTDSCONN_KCC_NO_REASON = (0) -NTDSCONN_KCC_GC_TOPOLOGY = (1 << 0) -NTDSCONN_KCC_RING_TOPOLOGY = (1 << 1) -NTDSCONN_KCC_MINIMIZE_HOPS_TOPOLOGY = (1 << 2) -NTDSCONN_KCC_STALE_SERVERS_TOPOLOGY = (1 << 3) -NTDSCONN_KCC_OSCILLATING_CONNECTION_TOPOLOGY = (1 << 4) -NTDSCONN_KCC_INTERSITE_GC_TOPOLOGY = (1 << 5) -NTDSCONN_KCC_INTERSITE_TOPOLOGY = (1 << 6) -NTDSCONN_KCC_SERVER_FAILOVER_TOPOLOGY = (1 << 7) -NTDSCONN_KCC_SITE_FAILOVER_TOPOLOGY = (1 << 8) -NTDSCONN_KCC_REDUNDANT_SERVER_TOPOLOGY = (1 << 9) -FRSCONN_PRIORITY_MASK = 0x70000000 -FRSCONN_MAX_PRIORITY = 0x8 -NTDSCONN_OPT_IGNORE_SCHEDULE_MASK = (-2147483648) - -NTDSSETTINGS_OPT_IS_AUTO_TOPOLOGY_DISABLED = (1 << 0) -NTDSSETTINGS_OPT_IS_TOPL_CLEANUP_DISABLED = (1 << 1) -NTDSSETTINGS_OPT_IS_TOPL_MIN_HOPS_DISABLED = (1 << 2) -NTDSSETTINGS_OPT_IS_TOPL_DETECT_STALE_DISABLED = (1 << 3) -NTDSSETTINGS_OPT_IS_INTER_SITE_AUTO_TOPOLOGY_DISABLED = (1 << 4) -NTDSSETTINGS_OPT_IS_GROUP_CACHING_ENABLED = (1 << 5) -NTDSSETTINGS_OPT_FORCE_KCC_WHISTLER_BEHAVIOR = (1 << 6) -NTDSSETTINGS_OPT_FORCE_KCC_W2K_ELECTION = (1 << 7) -NTDSSETTINGS_OPT_IS_RAND_BH_SELECTION_DISABLED = (1 << 8) -NTDSSETTINGS_OPT_IS_SCHEDULE_HASHING_ENABLED = (1 << 9) -NTDSSETTINGS_OPT_IS_REDUNDANT_SERVER_TOPOLOGY_ENABLED = (1 << 10) -NTDSSETTINGS_DEFAULT_SERVER_REDUNDANCY = 2 -NTDSTRANSPORT_OPT_IGNORE_SCHEDULES = (1 << 0) -NTDSTRANSPORT_OPT_BRIDGES_REQUIRED = (1 << 1) -NTDSSITECONN_OPT_USE_NOTIFY = (1 << 0) -NTDSSITECONN_OPT_TWOWAY_SYNC = (1 << 1) -NTDSSITECONN_OPT_DISABLE_COMPRESSION = (1 << 2) -NTDSSITELINK_OPT_USE_NOTIFY = (1 << 0) -NTDSSITELINK_OPT_TWOWAY_SYNC = (1 << 1) -NTDSSITELINK_OPT_DISABLE_COMPRESSION = (1 << 2) -GUID_USERS_CONTAINER_A = "a9d1ca15768811d1aded00c04fd8d5cd" -GUID_COMPUTRS_CONTAINER_A = "aa312825768811d1aded00c04fd8d5cd" -GUID_SYSTEMS_CONTAINER_A = "ab1d30f3768811d1aded00c04fd8d5cd" -GUID_DOMAIN_CONTROLLERS_CONTAINER_A = "a361b2ffffd211d1aa4b00c04fd7d83a" -GUID_INFRASTRUCTURE_CONTAINER_A = "2fbac1870ade11d297c400c04fd8d5cd" -GUID_DELETED_OBJECTS_CONTAINER_A = "18e2ea80684f11d2b9aa00c04f79f805" -GUID_LOSTANDFOUND_CONTAINER_A = "ab8153b7768811d1aded00c04fd8d5cd" -GUID_FOREIGNSECURITYPRINCIPALS_CONTAINER_A = "22b70c67d56e4efb91e9300fca3dc1aa" -GUID_PROGRAM_DATA_CONTAINER_A = "09460c08ae1e4a4ea0f64aee7daa1e5a" -GUID_MICROSOFT_PROGRAM_DATA_CONTAINER_A = "f4be92a4c777485e878e9421d53087db" -GUID_NTDS_QUOTAS_CONTAINER_A = "6227f0af1fc2410d8e3bb10615bb5b0f" -GUID_USERS_CONTAINER_BYTE = "\xa9\xd1\xca\x15\x76\x88\x11\xd1\xad\xed\x00\xc0\x4f\xd8\xd5\xcd" -GUID_COMPUTRS_CONTAINER_BYTE = "\xaa\x31\x28\x25\x76\x88\x11\xd1\xad\xed\x00\xc0\x4f\xd8\xd5\xcd" -GUID_SYSTEMS_CONTAINER_BYTE = "\xab\x1d\x30\xf3\x76\x88\x11\xd1\xad\xed\x00\xc0\x4f\xd8\xd5\xcd" -GUID_DOMAIN_CONTROLLERS_CONTAINER_BYTE = "\xa3\x61\xb2\xff\xff\xd2\x11\xd1\xaa\x4b\x00\xc0\x4f\xd7\xd8\x3a" -GUID_INFRASTRUCTURE_CONTAINER_BYTE = "\x2f\xba\xc1\x87\x0a\xde\x11\xd2\x97\xc4\x00\xc0\x4f\xd8\xd5\xcd" -GUID_DELETED_OBJECTS_CONTAINER_BYTE = "\x18\xe2\xea\x80\x68\x4f\x11\xd2\xb9\xaa\x00\xc0\x4f\x79\xf8\x05" -GUID_LOSTANDFOUND_CONTAINER_BYTE = "\xab\x81\x53\xb7\x76\x88\x11\xd1\xad\xed\x00\xc0\x4f\xd8\xd5\xcd" -GUID_FOREIGNSECURITYPRINCIPALS_CONTAINER_BYTE = "\x22\xb7\x0c\x67\xd5\x6e\x4e\xfb\x91\xe9\x30\x0f\xca\x3d\xc1\xaa" -GUID_PROGRAM_DATA_CONTAINER_BYTE = "\x09\x46\x0c\x08\xae\x1e\x4a\x4e\xa0\xf6\x4a\xee\x7d\xaa\x1e\x5a" -GUID_MICROSOFT_PROGRAM_DATA_CONTAINER_BYTE = "\xf4\xbe\x92\xa4\xc7\x77\x48\x5e\x87\x8e\x94\x21\xd5\x30\x87\xdb" -GUID_NTDS_QUOTAS_CONTAINER_BYTE = "\x62\x27\xf0\xaf\x1f\xc2\x41\x0d\x8e\x3b\xb1\x06\x15\xbb\x5b\x0f" -DS_REPSYNCALL_NO_OPTIONS = 0x00000000 -DS_REPSYNCALL_ABORT_IF_SERVER_UNAVAILABLE = 0x00000001 -DS_REPSYNCALL_SYNC_ADJACENT_SERVERS_ONLY = 0x00000002 -DS_REPSYNCALL_ID_SERVERS_BY_DN = 0x00000004 -DS_REPSYNCALL_DO_NOT_SYNC = 0x00000008 -DS_REPSYNCALL_SKIP_INITIAL_CHECK = 0x00000010 -DS_REPSYNCALL_PUSH_CHANGES_OUTWARD = 0x00000020 -DS_REPSYNCALL_CROSS_SITE_BOUNDARIES = 0x00000040 -DS_LIST_DSA_OBJECT_FOR_SERVER = 0 -DS_LIST_DNS_HOST_NAME_FOR_SERVER = 1 -DS_LIST_ACCOUNT_OBJECT_FOR_SERVER = 2 -DS_ROLE_SCHEMA_OWNER = 0 -DS_ROLE_DOMAIN_OWNER = 1 -DS_ROLE_PDC_OWNER = 2 -DS_ROLE_RID_OWNER = 3 -DS_ROLE_INFRASTRUCTURE_OWNER = 4 -DS_SCHEMA_GUID_NOT_FOUND = 0 -DS_SCHEMA_GUID_ATTR = 1 -DS_SCHEMA_GUID_ATTR_SET = 2 -DS_SCHEMA_GUID_CLASS = 3 -DS_SCHEMA_GUID_CONTROL_RIGHT = 4 -DS_KCC_FLAG_ASYNC_OP = (1 << 0) -DS_KCC_FLAG_DAMPED = (1 << 1) -DS_EXIST_ADVISORY_MODE = (0x1) -DS_REPL_INFO_FLAG_IMPROVE_LINKED_ATTRS = (0x00000001) -DS_REPL_NBR_WRITEABLE = (0x00000010) -DS_REPL_NBR_SYNC_ON_STARTUP = (0x00000020) -DS_REPL_NBR_DO_SCHEDULED_SYNCS = (0x00000040) -DS_REPL_NBR_USE_ASYNC_INTERSITE_TRANSPORT = (0x00000080) -DS_REPL_NBR_TWO_WAY_SYNC = (0x00000200) -DS_REPL_NBR_RETURN_OBJECT_PARENTS = (0x00000800) -DS_REPL_NBR_FULL_SYNC_IN_PROGRESS = (0x00010000) -DS_REPL_NBR_FULL_SYNC_NEXT_PACKET = (0x00020000) -DS_REPL_NBR_NEVER_SYNCED = (0x00200000) -DS_REPL_NBR_PREEMPTED = (0x01000000) -DS_REPL_NBR_IGNORE_CHANGE_NOTIFICATIONS = (0x04000000) -DS_REPL_NBR_DISABLE_SCHEDULED_SYNC = (0x08000000) -DS_REPL_NBR_COMPRESS_CHANGES = (0x10000000) -DS_REPL_NBR_NO_CHANGE_NOTIFICATIONS = (0x20000000) -DS_REPL_NBR_PARTIAL_ATTRIBUTE_SET = (0x40000000) -DS_REPL_NBR_MODIFIABLE_MASK = \ - ( - DS_REPL_NBR_SYNC_ON_STARTUP - | DS_REPL_NBR_DO_SCHEDULED_SYNCS - | DS_REPL_NBR_TWO_WAY_SYNC - | DS_REPL_NBR_IGNORE_CHANGE_NOTIFICATIONS - | DS_REPL_NBR_DISABLE_SCHEDULED_SYNC - | DS_REPL_NBR_COMPRESS_CHANGES - | DS_REPL_NBR_NO_CHANGE_NOTIFICATIONS - ) - -# from enum DS_NAME_FORMAT -DS_UNKNOWN_NAME = 0 -DS_FQDN_1779_NAME = 1 -DS_NT4_ACCOUNT_NAME = 2 -DS_DISPLAY_NAME = 3 -DS_UNIQUE_ID_NAME = 6 -DS_CANONICAL_NAME = 7 -DS_USER_PRINCIPAL_NAME = 8 -DS_CANONICAL_NAME_EX = 9 -DS_SERVICE_PRINCIPAL_NAME = 10 -DS_SID_OR_SID_HISTORY_NAME = 11 -DS_DNS_DOMAIN_NAME = 12 - -DS_DOMAIN_SIMPLE_NAME = DS_USER_PRINCIPAL_NAME -DS_ENTERPRISE_SIMPLE_NAME = DS_USER_PRINCIPAL_NAME - -# from enum DS_NAME_FLAGS -DS_NAME_NO_FLAGS = 0x0 -DS_NAME_FLAG_SYNTACTICAL_ONLY = 0x1 -DS_NAME_FLAG_EVAL_AT_DC = 0x2 -DS_NAME_FLAG_GCVERIFY = 0x4 -DS_NAME_FLAG_TRUST_REFERRAL = 0x8 - -# from enum DS_NAME_ERROR -DS_NAME_NO_ERROR = 0 -DS_NAME_ERROR_RESOLVING = 1 -DS_NAME_ERROR_NOT_FOUND = 2 -DS_NAME_ERROR_NOT_UNIQUE = 3 -DS_NAME_ERROR_NO_MAPPING = 4 -DS_NAME_ERROR_DOMAIN_ONLY = 5 -DS_NAME_ERROR_NO_SYNTACTICAL_MAPPING = 6 -DS_NAME_ERROR_TRUST_REFERRAL = 7 - - -# from enum DS_SPN_NAME_TYPE -DS_SPN_DNS_HOST = 0 -DS_SPN_DN_HOST = 1 -DS_SPN_NB_HOST = 2 -DS_SPN_DOMAIN = 3 -DS_SPN_NB_DOMAIN = 4 -DS_SPN_SERVICE = 5 - -# from enum DS_SPN_WRITE_OP -DS_SPN_ADD_SPN_OP = 0 -DS_SPN_REPLACE_SPN_OP = 1 -DS_SPN_DELETE_SPN_OP = 2 - -# Generated by h2py from DsGetDC.h -DS_FORCE_REDISCOVERY = 0x00000001 -DS_DIRECTORY_SERVICE_REQUIRED = 0x00000010 -DS_DIRECTORY_SERVICE_PREFERRED = 0x00000020 -DS_GC_SERVER_REQUIRED = 0x00000040 -DS_PDC_REQUIRED = 0x00000080 -DS_BACKGROUND_ONLY = 0x00000100 -DS_IP_REQUIRED = 0x00000200 -DS_KDC_REQUIRED = 0x00000400 -DS_TIMESERV_REQUIRED = 0x00000800 -DS_WRITABLE_REQUIRED = 0x00001000 -DS_GOOD_TIMESERV_PREFERRED = 0x00002000 -DS_AVOID_SELF = 0x00004000 -DS_ONLY_LDAP_NEEDED = 0x00008000 -DS_IS_FLAT_NAME = 0x00010000 -DS_IS_DNS_NAME = 0x00020000 -DS_RETURN_DNS_NAME = 0x40000000 -DS_RETURN_FLAT_NAME = (-2147483648) -DSGETDC_VALID_FLAGS = ( - DS_FORCE_REDISCOVERY - | DS_DIRECTORY_SERVICE_REQUIRED - | DS_DIRECTORY_SERVICE_PREFERRED - | DS_GC_SERVER_REQUIRED - | DS_PDC_REQUIRED - | DS_BACKGROUND_ONLY - | DS_IP_REQUIRED - | DS_KDC_REQUIRED - | DS_TIMESERV_REQUIRED - | DS_WRITABLE_REQUIRED - | DS_GOOD_TIMESERV_PREFERRED - | DS_AVOID_SELF - | DS_ONLY_LDAP_NEEDED - | DS_IS_FLAT_NAME - | DS_IS_DNS_NAME - | DS_RETURN_FLAT_NAME - | DS_RETURN_DNS_NAME) -DS_INET_ADDRESS = 1 -DS_NETBIOS_ADDRESS = 2 -DS_PDC_FLAG = 0x00000001 -DS_GC_FLAG = 0x00000004 -DS_LDAP_FLAG = 0x00000008 -DS_DS_FLAG = 0x00000010 -DS_KDC_FLAG = 0x00000020 -DS_TIMESERV_FLAG = 0x00000040 -DS_CLOSEST_FLAG = 0x00000080 -DS_WRITABLE_FLAG = 0x00000100 -DS_GOOD_TIMESERV_FLAG = 0x00000200 -DS_NDNC_FLAG = 0x00000400 -DS_PING_FLAGS = 0x0000FFFF -DS_DNS_CONTROLLER_FLAG = 0x20000000 -DS_DNS_DOMAIN_FLAG = 0x40000000 -DS_DNS_FOREST_FLAG = (-2147483648) -DS_DOMAIN_IN_FOREST = 0x0001 -DS_DOMAIN_DIRECT_OUTBOUND = 0x0002 -DS_DOMAIN_TREE_ROOT = 0x0004 -DS_DOMAIN_PRIMARY = 0x0008 -DS_DOMAIN_NATIVE_MODE = 0x0010 -DS_DOMAIN_DIRECT_INBOUND = 0x0020 -DS_DOMAIN_VALID_FLAGS = ( - DS_DOMAIN_IN_FOREST - | DS_DOMAIN_DIRECT_OUTBOUND - | DS_DOMAIN_TREE_ROOT - | DS_DOMAIN_PRIMARY - | DS_DOMAIN_NATIVE_MODE - | DS_DOMAIN_DIRECT_INBOUND) -DS_GFTI_UPDATE_TDO = 0x1 -DS_GFTI_VALID_FLAGS = 0x1 -DS_ONLY_DO_SITE_NAME = 0x01 -DS_NOTIFY_AFTER_SITE_RECORDS = 0x02 -DS_OPEN_VALID_OPTION_FLAGS = (DS_ONLY_DO_SITE_NAME | DS_NOTIFY_AFTER_SITE_RECORDS) -DS_OPEN_VALID_FLAGS = ( - DS_FORCE_REDISCOVERY - | DS_ONLY_LDAP_NEEDED - | DS_KDC_REQUIRED - | DS_PDC_REQUIRED - | DS_GC_SERVER_REQUIRED - | DS_WRITABLE_REQUIRED) - -# from aclui.h -# SI_OBJECT_INFO.dwFlags -SI_EDIT_PERMS = 0x00000000 -SI_EDIT_OWNER = 0x00000001 -SI_EDIT_AUDITS = 0x00000002 -SI_CONTAINER = 0x00000004 -SI_READONLY = 0x00000008 -SI_ADVANCED = 0x00000010 -SI_RESET = 0x00000020 -SI_OWNER_READONLY = 0x00000040 -SI_EDIT_PROPERTIES = 0x00000080 -SI_OWNER_RECURSE = 0x00000100 -SI_NO_ACL_PROTECT = 0x00000200 -SI_NO_TREE_APPLY = 0x00000400 -SI_PAGE_TITLE = 0x00000800 -SI_SERVER_IS_DC = 0x00001000 -SI_RESET_DACL_TREE = 0x00004000 -SI_RESET_SACL_TREE = 0x00008000 -SI_OBJECT_GUID = 0x00010000 -SI_EDIT_EFFECTIVE = 0x00020000 -SI_RESET_DACL = 0x00040000 -SI_RESET_SACL = 0x00080000 -SI_RESET_OWNER = 0x00100000 -SI_NO_ADDITIONAL_PERMISSION = 0x00200000 -SI_MAY_WRITE = 0x10000000 -SI_EDIT_ALL = (SI_EDIT_PERMS | SI_EDIT_OWNER | SI_EDIT_AUDITS) -SI_AUDITS_ELEVATION_REQUIRED = 0x02000000 -SI_VIEW_ONLY = 0x00400000 -SI_OWNER_ELEVATION_REQUIRED = 0x04000000 -SI_PERMS_ELEVATION_REQUIRED = 0x01000000 - -# SI_ACCESS.dwFlags -SI_ACCESS_SPECIFIC = 0x00010000 -SI_ACCESS_GENERAL = 0x00020000 -SI_ACCESS_CONTAINER = 0x00040000 -SI_ACCESS_PROPERTY = 0x00080000 - -# SI_PAGE_TYPE enum -SI_PAGE_PERM = 0 -SI_PAGE_ADVPERM = 1 -SI_PAGE_AUDIT = 2 -SI_PAGE_OWNER = 3 -SI_PAGE_EFFECTIVE = 4 - -CFSTR_ACLUI_SID_INFO_LIST = "CFSTR_ACLUI_SID_INFO_LIST" -PSPCB_SI_INITDIALOG = 1025 # WM_USER+1 diff --git a/typings/win32helper/sspicon.pyi b/typings/win32helper/sspicon.pyi deleted file mode 100644 index cb1a9bd1..00000000 --- a/typings/win32helper/sspicon.pyi +++ /dev/null @@ -1,483 +0,0 @@ -# Generated by h2py from c:\microsoft sdk\include\sspi.h -ISSP_LEVEL = 32 -ISSP_MODE = 1 -ISSP_LEVEL = 32 -ISSP_MODE = 0 -ISSP_LEVEL = 32 -ISSP_MODE = 1 - - -def SEC_SUCCESS(Status) -> bool: - ... - - -SECPKG_FLAG_INTEGRITY = 1 -SECPKG_FLAG_PRIVACY = 2 -SECPKG_FLAG_TOKEN_ONLY = 4 -SECPKG_FLAG_DATAGRAM = 8 -SECPKG_FLAG_CONNECTION = 16 -SECPKG_FLAG_MULTI_REQUIRED = 32 -SECPKG_FLAG_CLIENT_ONLY = 64 -SECPKG_FLAG_EXTENDED_ERROR = 128 -SECPKG_FLAG_IMPERSONATION = 256 -SECPKG_FLAG_ACCEPT_WIN32_NAME = 512 -SECPKG_FLAG_STREAM = 1024 -SECPKG_FLAG_NEGOTIABLE = 2048 -SECPKG_FLAG_GSS_COMPATIBLE = 4096 -SECPKG_FLAG_LOGON = 8192 -SECPKG_FLAG_ASCII_BUFFERS = 16384 -SECPKG_FLAG_FRAGMENT = 32768 -SECPKG_FLAG_MUTUAL_AUTH = 65536 -SECPKG_FLAG_DELEGATION = 131072 -SECPKG_FLAG_READONLY_WITH_CHECKSUM = 262144 -SECPKG_ID_NONE = 65535 - -SECBUFFER_VERSION = 0 -SECBUFFER_EMPTY = 0 -SECBUFFER_DATA = 1 -SECBUFFER_TOKEN = 2 -SECBUFFER_PKG_PARAMS = 3 -SECBUFFER_MISSING = 4 -SECBUFFER_EXTRA = 5 -SECBUFFER_STREAM_TRAILER = 6 -SECBUFFER_STREAM_HEADER = 7 -SECBUFFER_NEGOTIATION_INFO = 8 -SECBUFFER_PADDING = 9 -SECBUFFER_STREAM = 10 -SECBUFFER_MECHLIST = 11 -SECBUFFER_MECHLIST_SIGNATURE = 12 -SECBUFFER_TARGET = 13 -SECBUFFER_CHANNEL_BINDINGS = 14 -SECBUFFER_ATTRMASK = (-268435456) -SECBUFFER_READONLY = (-2147483648) -SECBUFFER_READONLY_WITH_CHECKSUM = 268435456 -SECBUFFER_RESERVED = 1610612736 - -SECURITY_NATIVE_DREP = 16 -SECURITY_NETWORK_DREP = 0 - -SECPKG_CRED_INBOUND = 1 -SECPKG_CRED_OUTBOUND = 2 -SECPKG_CRED_BOTH = 3 -SECPKG_CRED_DEFAULT = 4 -SECPKG_CRED_RESERVED = -268435456 - -ISC_REQ_DELEGATE = 1 -ISC_REQ_MUTUAL_AUTH = 2 -ISC_REQ_REPLAY_DETECT = 4 -ISC_REQ_SEQUENCE_DETECT = 8 -ISC_REQ_CONFIDENTIALITY = 16 -ISC_REQ_USE_SESSION_KEY = 32 -ISC_REQ_PROMPT_FOR_CREDS = 64 -ISC_REQ_USE_SUPPLIED_CREDS = 128 -ISC_REQ_ALLOCATE_MEMORY = 256 -ISC_REQ_USE_DCE_STYLE = 512 -ISC_REQ_DATAGRAM = 1024 -ISC_REQ_CONNECTION = 2048 -ISC_REQ_CALL_LEVEL = 4096 -ISC_REQ_FRAGMENT_SUPPLIED = 8192 -ISC_REQ_EXTENDED_ERROR = 16384 -ISC_REQ_STREAM = 32768 -ISC_REQ_INTEGRITY = 65536 -ISC_REQ_IDENTIFY = 131072 -ISC_REQ_NULL_SESSION = 262144 -ISC_REQ_MANUAL_CRED_VALIDATION = 524288 -ISC_REQ_RESERVED1 = 1048576 -ISC_REQ_FRAGMENT_TO_FIT = 2097152 -ISC_REQ_HTTP = 0x10000000 -ISC_RET_DELEGATE = 1 -ISC_RET_MUTUAL_AUTH = 2 -ISC_RET_REPLAY_DETECT = 4 -ISC_RET_SEQUENCE_DETECT = 8 -ISC_RET_CONFIDENTIALITY = 16 -ISC_RET_USE_SESSION_KEY = 32 -ISC_RET_USED_COLLECTED_CREDS = 64 -ISC_RET_USED_SUPPLIED_CREDS = 128 -ISC_RET_ALLOCATED_MEMORY = 256 -ISC_RET_USED_DCE_STYLE = 512 -ISC_RET_DATAGRAM = 1024 -ISC_RET_CONNECTION = 2048 -ISC_RET_INTERMEDIATE_RETURN = 4096 -ISC_RET_CALL_LEVEL = 8192 -ISC_RET_EXTENDED_ERROR = 16384 -ISC_RET_STREAM = 32768 -ISC_RET_INTEGRITY = 65536 -ISC_RET_IDENTIFY = 131072 -ISC_RET_NULL_SESSION = 262144 -ISC_RET_MANUAL_CRED_VALIDATION = 524288 -ISC_RET_RESERVED1 = 1048576 -ISC_RET_FRAGMENT_ONLY = 2097152 - -ASC_REQ_DELEGATE = 1 -ASC_REQ_MUTUAL_AUTH = 2 -ASC_REQ_REPLAY_DETECT = 4 -ASC_REQ_SEQUENCE_DETECT = 8 -ASC_REQ_CONFIDENTIALITY = 16 -ASC_REQ_USE_SESSION_KEY = 32 -ASC_REQ_ALLOCATE_MEMORY = 256 -ASC_REQ_USE_DCE_STYLE = 512 -ASC_REQ_DATAGRAM = 1024 -ASC_REQ_CONNECTION = 2048 -ASC_REQ_CALL_LEVEL = 4096 -ASC_REQ_EXTENDED_ERROR = 32768 -ASC_REQ_STREAM = 65536 -ASC_REQ_INTEGRITY = 131072 -ASC_REQ_LICENSING = 262144 -ASC_REQ_IDENTIFY = 524288 -ASC_REQ_ALLOW_NULL_SESSION = 1048576 -ASC_REQ_ALLOW_NON_USER_LOGONS = 2097152 -ASC_REQ_ALLOW_CONTEXT_REPLAY = 4194304 -ASC_REQ_FRAGMENT_TO_FIT = 8388608 -ASC_REQ_FRAGMENT_SUPPLIED = 8192 -ASC_REQ_NO_TOKEN = 16777216 -ASC_RET_DELEGATE = 1 -ASC_RET_MUTUAL_AUTH = 2 -ASC_RET_REPLAY_DETECT = 4 -ASC_RET_SEQUENCE_DETECT = 8 -ASC_RET_CONFIDENTIALITY = 16 -ASC_RET_USE_SESSION_KEY = 32 -ASC_RET_ALLOCATED_MEMORY = 256 -ASC_RET_USED_DCE_STYLE = 512 -ASC_RET_DATAGRAM = 1024 -ASC_RET_CONNECTION = 2048 -ASC_RET_CALL_LEVEL = 8192 -ASC_RET_THIRD_LEG_FAILED = 16384 -ASC_RET_EXTENDED_ERROR = 32768 -ASC_RET_STREAM = 65536 -ASC_RET_INTEGRITY = 131072 -ASC_RET_LICENSING = 262144 -ASC_RET_IDENTIFY = 524288 -ASC_RET_NULL_SESSION = 1048576 -ASC_RET_ALLOW_NON_USER_LOGONS = 2097152 -ASC_RET_ALLOW_CONTEXT_REPLAY = 4194304 -ASC_RET_FRAGMENT_ONLY = 8388608 - -SECPKG_CRED_ATTR_NAMES = 1 -SECPKG_ATTR_SIZES = 0 -SECPKG_ATTR_NAMES = 1 -SECPKG_ATTR_LIFESPAN = 2 -SECPKG_ATTR_DCE_INFO = 3 -SECPKG_ATTR_STREAM_SIZES = 4 -SECPKG_ATTR_KEY_INFO = 5 -SECPKG_ATTR_AUTHORITY = 6 -SECPKG_ATTR_PROTO_INFO = 7 -SECPKG_ATTR_PASSWORD_EXPIRY = 8 -SECPKG_ATTR_SESSION_KEY = 9 -SECPKG_ATTR_PACKAGE_INFO = 10 -SECPKG_ATTR_USER_FLAGS = 11 -SECPKG_ATTR_NEGOTIATION_INFO = 12 -SECPKG_ATTR_NATIVE_NAMES = 13 -SECPKG_ATTR_FLAGS = 14 -SECPKG_ATTR_USE_VALIDATED = 15 -SECPKG_ATTR_CREDENTIAL_NAME = 16 -SECPKG_ATTR_TARGET_INFORMATION = 17 -SECPKG_ATTR_ACCESS_TOKEN = 18 -SECPKG_ATTR_TARGET = 19 -SECPKG_ATTR_AUTHENTICATION_ID = 20 - -# attributes from schannel.h -SECPKG_ATTR_REMOTE_CERT_CONTEXT = 83 -SECPKG_ATTR_LOCAL_CERT_CONTEXT = 84 -SECPKG_ATTR_ROOT_STORE = 85 -SECPKG_ATTR_SUPPORTED_ALGS = 86 -SECPKG_ATTR_CIPHER_STRENGTHS = 87 -SECPKG_ATTR_SUPPORTED_PROTOCOLS = 88 -SECPKG_ATTR_ISSUER_LIST_EX = 89 -SECPKG_ATTR_CONNECTION_INFO = 90 -SECPKG_ATTR_EAP_KEY_BLOCK = 91 -SECPKG_ATTR_MAPPED_CRED_ATTR = 92 -SECPKG_ATTR_SESSION_INFO = 93 -SECPKG_ATTR_APP_DATA = 94 - -SECPKG_NEGOTIATION_COMPLETE = 0 -SECPKG_NEGOTIATION_OPTIMISTIC = 1 -SECPKG_NEGOTIATION_IN_PROGRESS = 2 -SECPKG_NEGOTIATION_DIRECT = 3 -SECPKG_NEGOTIATION_TRY_MULTICRED = 4 -SECPKG_CONTEXT_EXPORT_RESET_NEW = 1 -SECPKG_CONTEXT_EXPORT_DELETE_OLD = 2 -SECQOP_WRAP_NO_ENCRYPT = (-2147483647) -SECURITY_ENTRYPOINT_ANSIW = "InitSecurityInterfaceW" -SECURITY_ENTRYPOINT_ANSIA = "InitSecurityInterfaceA" -SECURITY_ENTRYPOINT16 = "INITSECURITYINTERFACEA" -SECURITY_ENTRYPOINT_ANSI = SECURITY_ENTRYPOINT_ANSIW -SECURITY_ENTRYPOINT_ANSI = SECURITY_ENTRYPOINT_ANSIA -SECURITY_ENTRYPOINT = SECURITY_ENTRYPOINT16 -SECURITY_ENTRYPOINT_ANSI = SECURITY_ENTRYPOINT16 -SECURITY_SUPPORT_PROVIDER_INTERFACE_VERSION = 1 -SECURITY_SUPPORT_PROVIDER_INTERFACE_VERSION_2 = 2 -SASL_OPTION_SEND_SIZE = 1 -SASL_OPTION_RECV_SIZE = 2 -SASL_OPTION_AUTHZ_STRING = 3 -SASL_OPTION_AUTHZ_PROCESSING = 4 -SEC_WINNT_AUTH_IDENTITY_ANSI = 1 -SEC_WINNT_AUTH_IDENTITY_UNICODE = 2 -SEC_WINNT_AUTH_IDENTITY_VERSION = 512 -SEC_WINNT_AUTH_IDENTITY_MARSHALLED = 4 -SEC_WINNT_AUTH_IDENTITY_ONLY = 8 -SECPKG_OPTIONS_TYPE_UNKNOWN = 0 -SECPKG_OPTIONS_TYPE_LSA = 1 -SECPKG_OPTIONS_TYPE_SSPI = 2 -SECPKG_OPTIONS_PERMANENT = 1 - -SEC_E_INSUFFICIENT_MEMORY = -2146893056 -SEC_E_INVALID_HANDLE = -2146893055 -SEC_E_UNSUPPORTED_FUNCTION = -2146893054 -SEC_E_TARGET_UNKNOWN = -2146893053 -SEC_E_INTERNAL_ERROR = -2146893052 -SEC_E_SECPKG_NOT_FOUND = -2146893051 -SEC_E_NOT_OWNER = -2146893050 -SEC_E_CANNOT_INSTALL = -2146893049 -SEC_E_INVALID_TOKEN = -2146893048 -SEC_E_CANNOT_PACK = -2146893047 -SEC_E_QOP_NOT_SUPPORTED = -2146893046 -SEC_E_NO_IMPERSONATION = -2146893045 -SEC_E_LOGON_DENIED = -2146893044 -SEC_E_UNKNOWN_CREDENTIALS = -2146893043 -SEC_E_NO_CREDENTIALS = -2146893042 -SEC_E_MESSAGE_ALTERED = -2146893041 -SEC_E_OUT_OF_SEQUENCE = -2146893040 -SEC_E_NO_AUTHENTICATING_AUTHORITY = -2146893039 -SEC_I_CONTINUE_NEEDED = 590610 -SEC_I_COMPLETE_NEEDED = 590611 -SEC_I_COMPLETE_AND_CONTINUE = 590612 -SEC_I_LOCAL_LOGON = 590613 -SEC_E_BAD_PKGID = -2146893034 -SEC_E_CONTEXT_EXPIRED = -2146893033 -SEC_I_CONTEXT_EXPIRED = 590615 -SEC_E_INCOMPLETE_MESSAGE = -2146893032 -SEC_E_INCOMPLETE_CREDENTIALS = -2146893024 -SEC_E_BUFFER_TOO_SMALL = -2146893023 -SEC_I_INCOMPLETE_CREDENTIALS = 590624 -SEC_I_RENEGOTIATE = 590625 -SEC_E_WRONG_PRINCIPAL = -2146893022 -SEC_I_NO_LSA_CONTEXT = 590627 -SEC_E_TIME_SKEW = -2146893020 -SEC_E_UNTRUSTED_ROOT = -2146893019 -SEC_E_ILLEGAL_MESSAGE = -2146893018 -SEC_E_CERT_UNKNOWN = -2146893017 -SEC_E_CERT_EXPIRED = -2146893016 -SEC_E_ENCRYPT_FAILURE = -2146893015 -SEC_E_DECRYPT_FAILURE = -2146893008 -SEC_E_ALGORITHM_MISMATCH = -2146893007 -SEC_E_SECURITY_QOS_FAILED = -2146893006 -SEC_E_UNFINISHED_CONTEXT_DELETED = -2146893005 -SEC_E_NO_TGT_REPLY = -2146893004 -SEC_E_NO_IP_ADDRESSES = -2146893003 -SEC_E_WRONG_CREDENTIAL_HANDLE = -2146893002 -SEC_E_CRYPTO_SYSTEM_INVALID = -2146893001 -SEC_E_MAX_REFERRALS_EXCEEDED = -2146893000 -SEC_E_MUST_BE_KDC = -2146892999 -SEC_E_STRONG_CRYPTO_NOT_SUPPORTED = -2146892998 -SEC_E_TOO_MANY_PRINCIPALS = -2146892997 -SEC_E_NO_PA_DATA = -2146892996 -SEC_E_PKINIT_NAME_MISMATCH = -2146892995 -SEC_E_SMARTCARD_LOGON_REQUIRED = -2146892994 -SEC_E_SHUTDOWN_IN_PROGRESS = -2146892993 -SEC_E_KDC_INVALID_REQUEST = -2146892992 -SEC_E_KDC_UNABLE_TO_REFER = -2146892991 -SEC_E_KDC_UNKNOWN_ETYPE = -2146892990 -SEC_E_UNSUPPORTED_PREAUTH = -2146892989 -SEC_E_DELEGATION_REQUIRED = -2146892987 -SEC_E_BAD_BINDINGS = -2146892986 -SEC_E_MULTIPLE_ACCOUNTS = -2146892985 -SEC_E_NO_KERB_KEY = -2146892984 - -ERROR_IPSEC_QM_POLICY_EXISTS = 13000 -ERROR_IPSEC_QM_POLICY_NOT_FOUND = 13001 -ERROR_IPSEC_QM_POLICY_IN_USE = 13002 -ERROR_IPSEC_MM_POLICY_EXISTS = 13003 -ERROR_IPSEC_MM_POLICY_NOT_FOUND = 13004 -ERROR_IPSEC_MM_POLICY_IN_USE = 13005 -ERROR_IPSEC_MM_FILTER_EXISTS = 13006 -ERROR_IPSEC_MM_FILTER_NOT_FOUND = 13007 -ERROR_IPSEC_TRANSPORT_FILTER_EXISTS = 13008 -ERROR_IPSEC_TRANSPORT_FILTER_NOT_FOUND = 13009 -ERROR_IPSEC_MM_AUTH_EXISTS = 13010 -ERROR_IPSEC_MM_AUTH_NOT_FOUND = 13011 -ERROR_IPSEC_MM_AUTH_IN_USE = 13012 -ERROR_IPSEC_DEFAULT_MM_POLICY_NOT_FOUND = 13013 -ERROR_IPSEC_DEFAULT_MM_AUTH_NOT_FOUND = 13014 -ERROR_IPSEC_DEFAULT_QM_POLICY_NOT_FOUND = 13015 -ERROR_IPSEC_TUNNEL_FILTER_EXISTS = 13016 -ERROR_IPSEC_TUNNEL_FILTER_NOT_FOUND = 13017 -ERROR_IPSEC_MM_FILTER_PENDING_DELETION = 13018 -ERROR_IPSEC_TRANSPORT_FILTER_PENDING_DELETION = 13019 -ERROR_IPSEC_TUNNEL_FILTER_PENDING_DELETION = 13020 -ERROR_IPSEC_MM_POLICY_PENDING_DELETION = 13021 -ERROR_IPSEC_MM_AUTH_PENDING_DELETION = 13022 -ERROR_IPSEC_QM_POLICY_PENDING_DELETION = 13023 -WARNING_IPSEC_MM_POLICY_PRUNED = 13024 -WARNING_IPSEC_QM_POLICY_PRUNED = 13025 -ERROR_IPSEC_IKE_NEG_STATUS_BEGIN = 13800 -ERROR_IPSEC_IKE_AUTH_FAIL = 13801 -ERROR_IPSEC_IKE_ATTRIB_FAIL = 13802 -ERROR_IPSEC_IKE_NEGOTIATION_PENDING = 13803 -ERROR_IPSEC_IKE_GENERAL_PROCESSING_ERROR = 13804 -ERROR_IPSEC_IKE_TIMED_OUT = 13805 -ERROR_IPSEC_IKE_NO_CERT = 13806 -ERROR_IPSEC_IKE_SA_DELETED = 13807 -ERROR_IPSEC_IKE_SA_REAPED = 13808 -ERROR_IPSEC_IKE_MM_ACQUIRE_DROP = 13809 -ERROR_IPSEC_IKE_QM_ACQUIRE_DROP = 13810 -ERROR_IPSEC_IKE_QUEUE_DROP_MM = 13811 -ERROR_IPSEC_IKE_QUEUE_DROP_NO_MM = 13812 -ERROR_IPSEC_IKE_DROP_NO_RESPONSE = 13813 -ERROR_IPSEC_IKE_MM_DELAY_DROP = 13814 -ERROR_IPSEC_IKE_QM_DELAY_DROP = 13815 -ERROR_IPSEC_IKE_ERROR = 13816 -ERROR_IPSEC_IKE_CRL_FAILED = 13817 -ERROR_IPSEC_IKE_INVALID_KEY_USAGE = 13818 -ERROR_IPSEC_IKE_INVALID_CERT_TYPE = 13819 -ERROR_IPSEC_IKE_NO_PRIVATE_KEY = 13820 -ERROR_IPSEC_IKE_DH_FAIL = 13822 -ERROR_IPSEC_IKE_INVALID_HEADER = 13824 -ERROR_IPSEC_IKE_NO_POLICY = 13825 -ERROR_IPSEC_IKE_INVALID_SIGNATURE = 13826 -ERROR_IPSEC_IKE_KERBEROS_ERROR = 13827 -ERROR_IPSEC_IKE_NO_PUBLIC_KEY = 13828 -ERROR_IPSEC_IKE_PROCESS_ERR = 13829 -ERROR_IPSEC_IKE_PROCESS_ERR_SA = 13830 -ERROR_IPSEC_IKE_PROCESS_ERR_PROP = 13831 -ERROR_IPSEC_IKE_PROCESS_ERR_TRANS = 13832 -ERROR_IPSEC_IKE_PROCESS_ERR_KE = 13833 -ERROR_IPSEC_IKE_PROCESS_ERR_ID = 13834 -ERROR_IPSEC_IKE_PROCESS_ERR_CERT = 13835 -ERROR_IPSEC_IKE_PROCESS_ERR_CERT_REQ = 13836 -ERROR_IPSEC_IKE_PROCESS_ERR_HASH = 13837 -ERROR_IPSEC_IKE_PROCESS_ERR_SIG = 13838 -ERROR_IPSEC_IKE_PROCESS_ERR_NONCE = 13839 -ERROR_IPSEC_IKE_PROCESS_ERR_NOTIFY = 13840 -ERROR_IPSEC_IKE_PROCESS_ERR_DELETE = 13841 -ERROR_IPSEC_IKE_PROCESS_ERR_VENDOR = 13842 -ERROR_IPSEC_IKE_INVALID_PAYLOAD = 13843 -ERROR_IPSEC_IKE_LOAD_SOFT_SA = 13844 -ERROR_IPSEC_IKE_SOFT_SA_TORN_DOWN = 13845 -ERROR_IPSEC_IKE_INVALID_COOKIE = 13846 -ERROR_IPSEC_IKE_NO_PEER_CERT = 13847 -ERROR_IPSEC_IKE_PEER_CRL_FAILED = 13848 -ERROR_IPSEC_IKE_POLICY_CHANGE = 13849 -ERROR_IPSEC_IKE_NO_MM_POLICY = 13850 -ERROR_IPSEC_IKE_NOTCBPRIV = 13851 -ERROR_IPSEC_IKE_SECLOADFAIL = 13852 -ERROR_IPSEC_IKE_FAILSSPINIT = 13853 -ERROR_IPSEC_IKE_FAILQUERYSSP = 13854 -ERROR_IPSEC_IKE_SRVACQFAIL = 13855 -ERROR_IPSEC_IKE_SRVQUERYCRED = 13856 -ERROR_IPSEC_IKE_GETSPIFAIL = 13857 -ERROR_IPSEC_IKE_INVALID_FILTER = 13858 -ERROR_IPSEC_IKE_OUT_OF_MEMORY = 13859 -ERROR_IPSEC_IKE_ADD_UPDATE_KEY_FAILED = 13860 -ERROR_IPSEC_IKE_INVALID_POLICY = 13861 -ERROR_IPSEC_IKE_UNKNOWN_DOI = 13862 -ERROR_IPSEC_IKE_INVALID_SITUATION = 13863 -ERROR_IPSEC_IKE_DH_FAILURE = 13864 -ERROR_IPSEC_IKE_INVALID_GROUP = 13865 -ERROR_IPSEC_IKE_ENCRYPT = 13866 -ERROR_IPSEC_IKE_DECRYPT = 13867 -ERROR_IPSEC_IKE_POLICY_MATCH = 13868 -ERROR_IPSEC_IKE_UNSUPPORTED_ID = 13869 -ERROR_IPSEC_IKE_INVALID_HASH = 13870 -ERROR_IPSEC_IKE_INVALID_HASH_ALG = 13871 -ERROR_IPSEC_IKE_INVALID_HASH_SIZE = 13872 -ERROR_IPSEC_IKE_INVALID_ENCRYPT_ALG = 13873 -ERROR_IPSEC_IKE_INVALID_AUTH_ALG = 13874 -ERROR_IPSEC_IKE_INVALID_SIG = 13875 -ERROR_IPSEC_IKE_LOAD_FAILED = 13876 -ERROR_IPSEC_IKE_RPC_DELETE = 13877 -ERROR_IPSEC_IKE_BENIGN_REINIT = 13878 -ERROR_IPSEC_IKE_INVALID_RESPONDER_LIFETIME_NOTIFY = 13879 -ERROR_IPSEC_IKE_INVALID_CERT_KEYLEN = 13881 -ERROR_IPSEC_IKE_MM_LIMIT = 13882 -ERROR_IPSEC_IKE_NEGOTIATION_DISABLED = 13883 -ERROR_IPSEC_IKE_NEG_STATUS_END = 13884 -CRYPT_E_MSG_ERROR = -2146889727 -CRYPT_E_UNKNOWN_ALGO = -2146889726 -CRYPT_E_OID_FORMAT = -2146889725 -CRYPT_E_INVALID_MSG_TYPE = -2146889724 -CRYPT_E_UNEXPECTED_ENCODING = -2146889723 -CRYPT_E_AUTH_ATTR_MISSING = -2146889722 -CRYPT_E_HASH_VALUE = -2146889721 -CRYPT_E_INVALID_INDEX = -2146889720 -CRYPT_E_ALREADY_DECRYPTED = -2146889719 -CRYPT_E_NOT_DECRYPTED = -2146889718 -CRYPT_E_RECIPIENT_NOT_FOUND = -2146889717 -CRYPT_E_CONTROL_TYPE = -2146889716 -CRYPT_E_ISSUER_SERIALNUMBER = -2146889715 -CRYPT_E_SIGNER_NOT_FOUND = -2146889714 -CRYPT_E_ATTRIBUTES_MISSING = -2146889713 -CRYPT_E_STREAM_MSG_NOT_READY = -2146889712 -CRYPT_E_STREAM_INSUFFICIENT_DATA = -2146889711 -CRYPT_I_NEW_PROTECTION_REQUIRED = (593938) -CRYPT_E_BAD_LEN = -2146885631 -CRYPT_E_BAD_ENCODE = -2146885630 -CRYPT_E_FILE_ERROR = -2146885629 -CRYPT_E_NOT_FOUND = -2146885628 -CRYPT_E_EXISTS = -2146885627 -CRYPT_E_NO_PROVIDER = -2146885626 -CRYPT_E_SELF_SIGNED = -2146885625 -CRYPT_E_DELETED_PREV = -2146885624 -CRYPT_E_NO_MATCH = -2146885623 -CRYPT_E_UNEXPECTED_MSG_TYPE = -2146885622 -CRYPT_E_NO_KEY_PROPERTY = -2146885621 -CRYPT_E_NO_DECRYPT_CERT = -2146885620 -CRYPT_E_BAD_MSG = -2146885619 -CRYPT_E_NO_SIGNER = -2146885618 -CRYPT_E_PENDING_CLOSE = -2146885617 -CRYPT_E_REVOKED = -2146885616 -CRYPT_E_NO_REVOCATION_DLL = -2146885615 -CRYPT_E_NO_REVOCATION_CHECK = -2146885614 -CRYPT_E_REVOCATION_OFFLINE = -2146885613 -CRYPT_E_NOT_IN_REVOCATION_DATABASE = -2146885612 -CRYPT_E_INVALID_NUMERIC_STRING = -2146885600 -CRYPT_E_INVALID_PRINTABLE_STRING = -2146885599 -CRYPT_E_INVALID_IA5_STRING = -2146885598 -CRYPT_E_INVALID_X500_STRING = -2146885597 -CRYPT_E_NOT_CHAR_STRING = -2146885596 -CRYPT_E_FILERESIZED = -2146885595 -CRYPT_E_SECURITY_SETTINGS = -2146885594 -CRYPT_E_NO_VERIFY_USAGE_DLL = -2146885593 -CRYPT_E_NO_VERIFY_USAGE_CHECK = -2146885592 -CRYPT_E_VERIFY_USAGE_OFFLINE = -2146885591 -CRYPT_E_NOT_IN_CTL = -2146885590 -CRYPT_E_NO_TRUSTED_SIGNER = -2146885589 -CRYPT_E_MISSING_PUBKEY_PARA = -2146885588 -CRYPT_E_OSS_ERROR = -2146881536 - -# Kerberos message types for LsaCallAuthenticationPackage (from ntsecapi.h) -KerbDebugRequestMessage = 0 -KerbQueryTicketCacheMessage = 1 -KerbChangeMachinePasswordMessage = 2 -KerbVerifyPacMessage = 3 -KerbRetrieveTicketMessage = 4 -KerbUpdateAddressesMessage = 5 -KerbPurgeTicketCacheMessage = 6 -KerbChangePasswordMessage = 7 -KerbRetrieveEncodedTicketMessage = 8 -KerbDecryptDataMessage = 9 -KerbAddBindingCacheEntryMessage = 10 -KerbSetPasswordMessage = 11 -KerbSetPasswordExMessage = 12 -KerbVerifyCredentialsMessage = 13 -KerbQueryTicketCacheExMessage = 14 -KerbPurgeTicketCacheExMessage = 15 -KerbRefreshSmartcardCredentialsMessage = 16 -KerbAddExtraCredentialsMessage = 17 -KerbQuerySupplementalCredentialsMessage = 18 - -# messages used with msv1_0 from ntsecapi.h -MsV1_0Lm20ChallengeRequest = 0 -MsV1_0Lm20GetChallengeResponse = 1 -MsV1_0EnumerateUsers = 2 -MsV1_0GetUserInfo = 3 -MsV1_0ReLogonUsers = 4 -MsV1_0ChangePassword = 5 -MsV1_0ChangeCachedPassword = 6 -MsV1_0GenericPassthrough = 7 -MsV1_0CacheLogon = 8 -MsV1_0SubAuth = 9 -MsV1_0DeriveCredential = 10 -MsV1_0CacheLookup = 11 -MsV1_0SetProcessOption = 12 - -SEC_E_OK = 0 diff --git a/typings/win32helper/win32cryptcon.pyi b/typings/win32helper/win32cryptcon.pyi deleted file mode 100644 index a6fe178b..00000000 --- a/typings/win32helper/win32cryptcon.pyi +++ /dev/null @@ -1,1916 +0,0 @@ -# Generated by h2py from WinCrypt.h -def GET_ALG_CLASS(x) -> int: ... - - -def GET_ALG_TYPE(x) -> int: ... - - -def GET_ALG_SID(x) -> int: ... - - -ALG_CLASS_ANY = (0) -ALG_CLASS_SIGNATURE = (1 << 13) -ALG_CLASS_MSG_ENCRYPT = (2 << 13) -ALG_CLASS_DATA_ENCRYPT = (3 << 13) -ALG_CLASS_HASH = (4 << 13) -ALG_CLASS_KEY_EXCHANGE = (5 << 13) -ALG_CLASS_ALL = (7 << 13) -ALG_TYPE_ANY = (0) -ALG_TYPE_DSS = (1 << 9) -ALG_TYPE_RSA = (2 << 9) -ALG_TYPE_BLOCK = (3 << 9) -ALG_TYPE_STREAM = (4 << 9) -ALG_TYPE_DH = (5 << 9) -ALG_TYPE_SECURECHANNEL = (6 << 9) -ALG_SID_ANY = (0) -ALG_SID_RSA_ANY = 0 -ALG_SID_RSA_PKCS = 1 -ALG_SID_RSA_MSATWORK = 2 -ALG_SID_RSA_ENTRUST = 3 -ALG_SID_RSA_PGP = 4 -ALG_SID_DSS_ANY = 0 -ALG_SID_DSS_PKCS = 1 -ALG_SID_DSS_DMS = 2 -ALG_SID_DES = 1 -ALG_SID_3DES = 3 -ALG_SID_DESX = 4 -ALG_SID_IDEA = 5 -ALG_SID_CAST = 6 -ALG_SID_SAFERSK64 = 7 -ALG_SID_SAFERSK128 = 8 -ALG_SID_3DES_112 = 9 -ALG_SID_CYLINK_MEK = 12 -ALG_SID_RC5 = 13 -ALG_SID_AES_128 = 14 -ALG_SID_AES_192 = 15 -ALG_SID_AES_256 = 16 -ALG_SID_AES = 17 -ALG_SID_SKIPJACK = 10 -ALG_SID_TEK = 11 -CRYPT_MODE_CBCI = 6 -CRYPT_MODE_CFBP = 7 -CRYPT_MODE_OFBP = 8 -CRYPT_MODE_CBCOFM = 9 -CRYPT_MODE_CBCOFMI = 10 -ALG_SID_RC2 = 2 -ALG_SID_RC4 = 1 -ALG_SID_SEAL = 2 -ALG_SID_DH_SANDF = 1 -ALG_SID_DH_EPHEM = 2 -ALG_SID_AGREED_KEY_ANY = 3 -ALG_SID_KEA = 4 -ALG_SID_MD2 = 1 -ALG_SID_MD4 = 2 -ALG_SID_MD5 = 3 -ALG_SID_SHA = 4 -ALG_SID_SHA1 = 4 -ALG_SID_MAC = 5 -ALG_SID_RIPEMD = 6 -ALG_SID_RIPEMD160 = 7 -ALG_SID_SSL3SHAMD5 = 8 -ALG_SID_HMAC = 9 -ALG_SID_TLS1PRF = 10 -ALG_SID_HASH_REPLACE_OWF = 11 -ALG_SID_SHA_256 = 12 -ALG_SID_SHA_384 = 13 -ALG_SID_SHA_512 = 14 -ALG_SID_SSL3_MASTER = 1 -ALG_SID_SCHANNEL_MASTER_HASH = 2 -ALG_SID_SCHANNEL_MAC_KEY = 3 -ALG_SID_PCT1_MASTER = 4 -ALG_SID_SSL2_MASTER = 5 -ALG_SID_TLS1_MASTER = 6 -ALG_SID_SCHANNEL_ENC_KEY = 7 -ALG_SID_EXAMPLE = 80 -CALG_MD2 = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_MD2) -CALG_MD4 = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_MD4) -CALG_MD5 = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_MD5) -CALG_SHA = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_SHA) -CALG_SHA1 = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_SHA1) -CALG_MAC = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_MAC) -CALG_RSA_SIGN = (ALG_CLASS_SIGNATURE | ALG_TYPE_RSA | ALG_SID_RSA_ANY) -CALG_DSS_SIGN = (ALG_CLASS_SIGNATURE | ALG_TYPE_DSS | ALG_SID_DSS_ANY) -CALG_NO_SIGN = (ALG_CLASS_SIGNATURE | ALG_TYPE_ANY | ALG_SID_ANY) -CALG_RSA_KEYX = (ALG_CLASS_KEY_EXCHANGE | ALG_TYPE_RSA | ALG_SID_RSA_ANY) -CALG_DES = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_BLOCK | ALG_SID_DES) -CALG_3DES_112 = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_BLOCK | ALG_SID_3DES_112) -CALG_3DES = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_BLOCK | ALG_SID_3DES) -CALG_DESX = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_BLOCK | ALG_SID_DESX) -CALG_RC2 = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_BLOCK | ALG_SID_RC2) -CALG_RC4 = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_STREAM | ALG_SID_RC4) -CALG_SEAL = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_STREAM | ALG_SID_SEAL) -CALG_DH_SF = (ALG_CLASS_KEY_EXCHANGE | ALG_TYPE_DH | ALG_SID_DH_SANDF) -CALG_DH_EPHEM = (ALG_CLASS_KEY_EXCHANGE | ALG_TYPE_DH | ALG_SID_DH_EPHEM) -CALG_AGREEDKEY_ANY = (ALG_CLASS_KEY_EXCHANGE | ALG_TYPE_DH | ALG_SID_AGREED_KEY_ANY) -CALG_KEA_KEYX = (ALG_CLASS_KEY_EXCHANGE | ALG_TYPE_DH | ALG_SID_KEA) -CALG_HUGHES_MD5 = (ALG_CLASS_KEY_EXCHANGE | ALG_TYPE_ANY | ALG_SID_MD5) -CALG_SKIPJACK = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_BLOCK | ALG_SID_SKIPJACK) -CALG_TEK = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_BLOCK | ALG_SID_TEK) -CALG_CYLINK_MEK = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_BLOCK | ALG_SID_CYLINK_MEK) -CALG_SSL3_SHAMD5 = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_SSL3SHAMD5) -CALG_SSL3_MASTER = (ALG_CLASS_MSG_ENCRYPT | ALG_TYPE_SECURECHANNEL | ALG_SID_SSL3_MASTER) -CALG_SCHANNEL_MASTER_HASH = (ALG_CLASS_MSG_ENCRYPT | ALG_TYPE_SECURECHANNEL | ALG_SID_SCHANNEL_MASTER_HASH) -CALG_SCHANNEL_MAC_KEY = (ALG_CLASS_MSG_ENCRYPT | ALG_TYPE_SECURECHANNEL | ALG_SID_SCHANNEL_MAC_KEY) -CALG_SCHANNEL_ENC_KEY = (ALG_CLASS_MSG_ENCRYPT | ALG_TYPE_SECURECHANNEL | ALG_SID_SCHANNEL_ENC_KEY) -CALG_PCT1_MASTER = (ALG_CLASS_MSG_ENCRYPT | ALG_TYPE_SECURECHANNEL | ALG_SID_PCT1_MASTER) -CALG_SSL2_MASTER = (ALG_CLASS_MSG_ENCRYPT | ALG_TYPE_SECURECHANNEL | ALG_SID_SSL2_MASTER) -CALG_TLS1_MASTER = (ALG_CLASS_MSG_ENCRYPT | ALG_TYPE_SECURECHANNEL | ALG_SID_TLS1_MASTER) -CALG_RC5 = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_BLOCK | ALG_SID_RC5) -CALG_HMAC = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_HMAC) -CALG_TLS1PRF = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_TLS1PRF) -CALG_HASH_REPLACE_OWF = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_HASH_REPLACE_OWF) -CALG_AES_128 = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_BLOCK | ALG_SID_AES_128) -CALG_AES_192 = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_BLOCK | ALG_SID_AES_192) -CALG_AES_256 = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_BLOCK | ALG_SID_AES_256) -CALG_AES = (ALG_CLASS_DATA_ENCRYPT | ALG_TYPE_BLOCK | ALG_SID_AES) -CALG_SHA_256 = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_SHA_256) -CALG_SHA_384 = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_SHA_384) -CALG_SHA_512 = (ALG_CLASS_HASH | ALG_TYPE_ANY | ALG_SID_SHA_512) -CRYPT_VERIFYCONTEXT = (-268435456) -CRYPT_NEWKEYSET = 0x00000008 -CRYPT_DELETEKEYSET = 0x00000010 -CRYPT_MACHINE_KEYSET = 0x00000020 -CRYPT_SILENT = 0x00000040 -CRYPT_EXPORTABLE = 0x00000001 -CRYPT_USER_PROTECTED = 0x00000002 -CRYPT_CREATE_SALT = 0x00000004 -CRYPT_UPDATE_KEY = 0x00000008 -CRYPT_NO_SALT = 0x00000010 -CRYPT_PREGEN = 0x00000040 -CRYPT_RECIPIENT = 0x00000010 -CRYPT_INITIATOR = 0x00000040 -CRYPT_ONLINE = 0x00000080 -CRYPT_SF = 0x00000100 -CRYPT_CREATE_IV = 0x00000200 -CRYPT_KEK = 0x00000400 -CRYPT_DATA_KEY = 0x00000800 -CRYPT_VOLATILE = 0x00001000 -CRYPT_SGCKEY = 0x00002000 -CRYPT_ARCHIVABLE = 0x00004000 -RSA1024BIT_KEY = 0x04000000 -CRYPT_SERVER = 0x00000400 -KEY_LENGTH_MASK = (-65536) -CRYPT_Y_ONLY = 0x00000001 -CRYPT_SSL2_FALLBACK = 0x00000002 -CRYPT_DESTROYKEY = 0x00000004 -CRYPT_OAEP = 0x00000040 -CRYPT_BLOB_VER3 = 0x00000080 -CRYPT_IPSEC_HMAC_KEY = 0x00000100 -CRYPT_DECRYPT_RSA_NO_PADDING_CHECK = 0x00000020 -CRYPT_SECRETDIGEST = 0x00000001 -CRYPT_OWF_REPL_LM_HASH = 0x00000001 -CRYPT_LITTLE_ENDIAN = 0x00000001 -CRYPT_NOHASHOID = 0x00000001 -CRYPT_TYPE2_FORMAT = 0x00000002 -CRYPT_X931_FORMAT = 0x00000004 -CRYPT_MACHINE_DEFAULT = 0x00000001 -CRYPT_USER_DEFAULT = 0x00000002 -CRYPT_DELETE_DEFAULT = 0x00000004 -SIMPLEBLOB = 0x1 -PUBLICKEYBLOB = 0x6 -PRIVATEKEYBLOB = 0x7 -PLAINTEXTKEYBLOB = 0x8 -OPAQUEKEYBLOB = 0x9 -PUBLICKEYBLOBEX = 0xA -SYMMETRICWRAPKEYBLOB = 0xB -AT_KEYEXCHANGE = 1 -AT_SIGNATURE = 2 -CRYPT_USERDATA = 1 -KP_IV = 1 -KP_SALT = 2 -KP_PADDING = 3 -KP_MODE = 4 -KP_MODE_BITS = 5 -KP_PERMISSIONS = 6 -KP_ALGID = 7 -KP_BLOCKLEN = 8 -KP_KEYLEN = 9 -KP_SALT_EX = 10 -KP_P = 11 -KP_G = 12 -KP_Q = 13 -KP_X = 14 -KP_Y = 15 -KP_RA = 16 -KP_RB = 17 -KP_INFO = 18 -KP_EFFECTIVE_KEYLEN = 19 -KP_SCHANNEL_ALG = 20 -KP_CLIENT_RANDOM = 21 -KP_SERVER_RANDOM = 22 -KP_RP = 23 -KP_PRECOMP_MD5 = 24 -KP_PRECOMP_SHA = 25 -KP_CERTIFICATE = 26 -KP_CLEAR_KEY = 27 -KP_PUB_EX_LEN = 28 -KP_PUB_EX_VAL = 29 -KP_KEYVAL = 30 -KP_ADMIN_PIN = 31 -KP_KEYEXCHANGE_PIN = 32 -KP_SIGNATURE_PIN = 33 -KP_PREHASH = 34 -KP_ROUNDS = 35 -KP_OAEP_PARAMS = 36 -KP_CMS_KEY_INFO = 37 -KP_CMS_DH_KEY_INFO = 38 -KP_PUB_PARAMS = 39 -KP_VERIFY_PARAMS = 40 -KP_HIGHEST_VERSION = 41 -KP_GET_USE_COUNT = 42 -PKCS5_PADDING = 1 -RANDOM_PADDING = 2 -ZERO_PADDING = 3 -CRYPT_MODE_CBC = 1 -CRYPT_MODE_ECB = 2 -CRYPT_MODE_OFB = 3 -CRYPT_MODE_CFB = 4 -CRYPT_MODE_CTS = 5 -CRYPT_ENCRYPT = 0x0001 -CRYPT_DECRYPT = 0x0002 -CRYPT_EXPORT = 0x0004 -CRYPT_READ = 0x0008 -CRYPT_WRITE = 0x0010 -CRYPT_MAC = 0x0020 -CRYPT_EXPORT_KEY = 0x0040 -CRYPT_IMPORT_KEY = 0x0080 -CRYPT_ARCHIVE = 0x0100 -HP_ALGID = 0x0001 -HP_HASHVAL = 0x0002 -HP_HASHSIZE = 0x0004 -HP_HMAC_INFO = 0x0005 -HP_TLS1PRF_LABEL = 0x0006 -HP_TLS1PRF_SEED = 0x0007 - -CRYPT_FAILED = 0 -CRYPT_SUCCEED = 1 - - -def RCRYPT_SUCCEEDED(rt) -> bool: - ... - - -def RCRYPT_FAILED(rt) -> bool: - ... - - -PP_ENUMALGS = 1 -PP_ENUMCONTAINERS = 2 -PP_IMPTYPE = 3 -PP_NAME = 4 -PP_VERSION = 5 -PP_CONTAINER = 6 -PP_CHANGE_PASSWORD = 7 -PP_KEYSET_SEC_DESCR = 8 -PP_CERTCHAIN = 9 -PP_KEY_TYPE_SUBTYPE = 10 -PP_PROVTYPE = 16 -PP_KEYSTORAGE = 17 -PP_APPLI_CERT = 18 -PP_SYM_KEYSIZE = 19 -PP_SESSION_KEYSIZE = 20 -PP_UI_PROMPT = 21 -PP_ENUMALGS_EX = 22 -PP_ENUMMANDROOTS = 25 -PP_ENUMELECTROOTS = 26 -PP_KEYSET_TYPE = 27 -PP_ADMIN_PIN = 31 -PP_KEYEXCHANGE_PIN = 32 -PP_SIGNATURE_PIN = 33 -PP_SIG_KEYSIZE_INC = 34 -PP_KEYX_KEYSIZE_INC = 35 -PP_UNIQUE_CONTAINER = 36 -PP_SGC_INFO = 37 -PP_USE_HARDWARE_RNG = 38 -PP_KEYSPEC = 39 -PP_ENUMEX_SIGNING_PROT = 40 -PP_CRYPT_COUNT_KEY_USE = 41 -CRYPT_FIRST = 1 -CRYPT_NEXT = 2 -CRYPT_SGC_ENUM = 4 -CRYPT_IMPL_HARDWARE = 1 -CRYPT_IMPL_SOFTWARE = 2 -CRYPT_IMPL_MIXED = 3 -CRYPT_IMPL_UNKNOWN = 4 -CRYPT_IMPL_REMOVABLE = 8 -CRYPT_SEC_DESCR = 0x00000001 -CRYPT_PSTORE = 0x00000002 -CRYPT_UI_PROMPT = 0x00000004 -CRYPT_FLAG_PCT1 = 0x0001 -CRYPT_FLAG_SSL2 = 0x0002 -CRYPT_FLAG_SSL3 = 0x0004 -CRYPT_FLAG_TLS1 = 0x0008 -CRYPT_FLAG_IPSEC = 0x0010 -CRYPT_FLAG_SIGNING = 0x0020 -CRYPT_SGC = 0x0001 -CRYPT_FASTSGC = 0x0002 -PP_CLIENT_HWND = 1 -PP_CONTEXT_INFO = 11 -PP_KEYEXCHANGE_KEYSIZE = 12 -PP_SIGNATURE_KEYSIZE = 13 -PP_KEYEXCHANGE_ALG = 14 -PP_SIGNATURE_ALG = 15 -PP_DELETEKEY = 24 -PROV_RSA_FULL = 1 -PROV_RSA_SIG = 2 -PROV_DSS = 3 -PROV_FORTEZZA = 4 -PROV_MS_EXCHANGE = 5 -PROV_SSL = 6 -PROV_RSA_SCHANNEL = 12 -PROV_DSS_DH = 13 -PROV_EC_ECDSA_SIG = 14 -PROV_EC_ECNRA_SIG = 15 -PROV_EC_ECDSA_FULL = 16 -PROV_EC_ECNRA_FULL = 17 -PROV_DH_SCHANNEL = 18 -PROV_SPYRUS_LYNKS = 20 -PROV_RNG = 21 -PROV_INTEL_SEC = 22 -PROV_REPLACE_OWF = 23 -PROV_RSA_AES = 24 -MS_DEF_PROV_A = "Microsoft Base Cryptographic Provider v1.0" -MS_DEF_PROV = MS_DEF_PROV_A -MS_ENHANCED_PROV_A = "Microsoft Enhanced Cryptographic Provider v1.0" -MS_ENHANCED_PROV = MS_ENHANCED_PROV_A -MS_STRONG_PROV_A = "Microsoft Strong Cryptographic Provider" -MS_STRONG_PROV = MS_STRONG_PROV_A -MS_DEF_RSA_SIG_PROV_A = "Microsoft RSA Signature Cryptographic Provider" -MS_DEF_RSA_SIG_PROV = MS_DEF_RSA_SIG_PROV_A -MS_DEF_RSA_SCHANNEL_PROV_A = "Microsoft RSA SChannel Cryptographic Provider" -MS_DEF_RSA_SCHANNEL_PROV = MS_DEF_RSA_SCHANNEL_PROV_A -MS_DEF_DSS_PROV_A = "Microsoft Base DSS Cryptographic Provider" -MS_DEF_DSS_PROV = MS_DEF_DSS_PROV_A -MS_DEF_DSS_DH_PROV_A = "Microsoft Base DSS and Diffie-Hellman Cryptographic Provider" -MS_DEF_DSS_DH_PROV = MS_DEF_DSS_DH_PROV_A -MS_ENH_DSS_DH_PROV_A = "Microsoft Enhanced DSS and Diffie-Hellman Cryptographic Provider" -MS_ENH_DSS_DH_PROV = MS_ENH_DSS_DH_PROV_A -MS_DEF_DH_SCHANNEL_PROV_A = "Microsoft DH SChannel Cryptographic Provider" -MS_DEF_DH_SCHANNEL_PROV = MS_DEF_DH_SCHANNEL_PROV_A -MS_SCARD_PROV_A = "Microsoft Base Smart Card Crypto Provider" -MS_SCARD_PROV = MS_SCARD_PROV_A -MS_ENH_RSA_AES_PROV_A = "Microsoft Enhanced RSA and AES Cryptographic Provider" -MS_ENH_RSA_AES_PROV = MS_ENH_RSA_AES_PROV_A -MAXUIDLEN = 64 -EXPO_OFFLOAD_REG_VALUE = "ExpoOffload" -EXPO_OFFLOAD_FUNC_NAME = "OffloadModExpo" -szKEY_CRYPTOAPI_PRIVATE_KEY_OPTIONS = \ - "Software\\Policies\\Microsoft\\Cryptography" -szFORCE_KEY_PROTECTION = "ForceKeyProtection" -dwFORCE_KEY_PROTECTION_DISABLED = 0x0 -dwFORCE_KEY_PROTECTION_USER_SELECT = 0x1 -dwFORCE_KEY_PROTECTION_HIGH = 0x2 -szKEY_CACHE_ENABLED = "CachePrivateKeys" -szKEY_CACHE_SECONDS = "PrivateKeyLifetimeSeconds" -CUR_BLOB_VERSION = 2 -SCHANNEL_MAC_KEY = 0x00000000 -SCHANNEL_ENC_KEY = 0x00000001 -INTERNATIONAL_USAGE = 0x00000001 -szOID_RSA = "1.2.840.113549" -szOID_PKCS = "1.2.840.113549.1" -szOID_RSA_HASH = "1.2.840.113549.2" -szOID_RSA_ENCRYPT = "1.2.840.113549.3" -szOID_PKCS_1 = "1.2.840.113549.1.1" -szOID_PKCS_2 = "1.2.840.113549.1.2" -szOID_PKCS_3 = "1.2.840.113549.1.3" -szOID_PKCS_4 = "1.2.840.113549.1.4" -szOID_PKCS_5 = "1.2.840.113549.1.5" -szOID_PKCS_6 = "1.2.840.113549.1.6" -szOID_PKCS_7 = "1.2.840.113549.1.7" -szOID_PKCS_8 = "1.2.840.113549.1.8" -szOID_PKCS_9 = "1.2.840.113549.1.9" -szOID_PKCS_10 = "1.2.840.113549.1.10" -szOID_PKCS_12 = "1.2.840.113549.1.12" -szOID_RSA_RSA = "1.2.840.113549.1.1.1" -szOID_RSA_MD2RSA = "1.2.840.113549.1.1.2" -szOID_RSA_MD4RSA = "1.2.840.113549.1.1.3" -szOID_RSA_MD5RSA = "1.2.840.113549.1.1.4" -szOID_RSA_SHA1RSA = "1.2.840.113549.1.1.5" -szOID_RSA_SETOAEP_RSA = "1.2.840.113549.1.1.6" -szOID_RSA_DH = "1.2.840.113549.1.3.1" -szOID_RSA_data = "1.2.840.113549.1.7.1" -szOID_RSA_signedData = "1.2.840.113549.1.7.2" -szOID_RSA_envelopedData = "1.2.840.113549.1.7.3" -szOID_RSA_signEnvData = "1.2.840.113549.1.7.4" -szOID_RSA_digestedData = "1.2.840.113549.1.7.5" -szOID_RSA_hashedData = "1.2.840.113549.1.7.5" -szOID_RSA_encryptedData = "1.2.840.113549.1.7.6" -szOID_RSA_emailAddr = "1.2.840.113549.1.9.1" -szOID_RSA_unstructName = "1.2.840.113549.1.9.2" -szOID_RSA_contentType = "1.2.840.113549.1.9.3" -szOID_RSA_messageDigest = "1.2.840.113549.1.9.4" -szOID_RSA_signingTime = "1.2.840.113549.1.9.5" -szOID_RSA_counterSign = "1.2.840.113549.1.9.6" -szOID_RSA_challengePwd = "1.2.840.113549.1.9.7" -szOID_RSA_unstructAddr = "1.2.840.113549.1.9.8" -szOID_RSA_extCertAttrs = "1.2.840.113549.1.9.9" -szOID_RSA_certExtensions = "1.2.840.113549.1.9.14" -szOID_RSA_SMIMECapabilities = "1.2.840.113549.1.9.15" -szOID_RSA_preferSignedData = "1.2.840.113549.1.9.15.1" -szOID_RSA_SMIMEalg = "1.2.840.113549.1.9.16.3" -szOID_RSA_SMIMEalgESDH = "1.2.840.113549.1.9.16.3.5" -szOID_RSA_SMIMEalgCMS3DESwrap = "1.2.840.113549.1.9.16.3.6" -szOID_RSA_SMIMEalgCMSRC2wrap = "1.2.840.113549.1.9.16.3.7" -szOID_RSA_MD2 = "1.2.840.113549.2.2" -szOID_RSA_MD4 = "1.2.840.113549.2.4" -szOID_RSA_MD5 = "1.2.840.113549.2.5" -szOID_RSA_RC2CBC = "1.2.840.113549.3.2" -szOID_RSA_RC4 = "1.2.840.113549.3.4" -szOID_RSA_DES_EDE3_CBC = "1.2.840.113549.3.7" -szOID_RSA_RC5_CBCPad = "1.2.840.113549.3.9" -szOID_ANSI_X942 = "1.2.840.10046" -szOID_ANSI_X942_DH = "1.2.840.10046.2.1" -szOID_X957 = "1.2.840.10040" -szOID_X957_DSA = "1.2.840.10040.4.1" -szOID_X957_SHA1DSA = "1.2.840.10040.4.3" -szOID_DS = "2.5" -szOID_DSALG = "2.5.8" -szOID_DSALG_CRPT = "2.5.8.1" -szOID_DSALG_HASH = "2.5.8.2" -szOID_DSALG_SIGN = "2.5.8.3" -szOID_DSALG_RSA = "2.5.8.1.1" -szOID_OIW = "1.3.14" -szOID_OIWSEC = "1.3.14.3.2" -szOID_OIWSEC_md4RSA = "1.3.14.3.2.2" -szOID_OIWSEC_md5RSA = "1.3.14.3.2.3" -szOID_OIWSEC_md4RSA2 = "1.3.14.3.2.4" -szOID_OIWSEC_desECB = "1.3.14.3.2.6" -szOID_OIWSEC_desCBC = "1.3.14.3.2.7" -szOID_OIWSEC_desOFB = "1.3.14.3.2.8" -szOID_OIWSEC_desCFB = "1.3.14.3.2.9" -szOID_OIWSEC_desMAC = "1.3.14.3.2.10" -szOID_OIWSEC_rsaSign = "1.3.14.3.2.11" -szOID_OIWSEC_dsa = "1.3.14.3.2.12" -szOID_OIWSEC_shaDSA = "1.3.14.3.2.13" -szOID_OIWSEC_mdc2RSA = "1.3.14.3.2.14" -szOID_OIWSEC_shaRSA = "1.3.14.3.2.15" -szOID_OIWSEC_dhCommMod = "1.3.14.3.2.16" -szOID_OIWSEC_desEDE = "1.3.14.3.2.17" -szOID_OIWSEC_sha = "1.3.14.3.2.18" -szOID_OIWSEC_mdc2 = "1.3.14.3.2.19" -szOID_OIWSEC_dsaComm = "1.3.14.3.2.20" -szOID_OIWSEC_dsaCommSHA = "1.3.14.3.2.21" -szOID_OIWSEC_rsaXchg = "1.3.14.3.2.22" -szOID_OIWSEC_keyHashSeal = "1.3.14.3.2.23" -szOID_OIWSEC_md2RSASign = "1.3.14.3.2.24" -szOID_OIWSEC_md5RSASign = "1.3.14.3.2.25" -szOID_OIWSEC_sha1 = "1.3.14.3.2.26" -szOID_OIWSEC_dsaSHA1 = "1.3.14.3.2.27" -szOID_OIWSEC_dsaCommSHA1 = "1.3.14.3.2.28" -szOID_OIWSEC_sha1RSASign = "1.3.14.3.2.29" -szOID_OIWDIR = "1.3.14.7.2" -szOID_OIWDIR_CRPT = "1.3.14.7.2.1" -szOID_OIWDIR_HASH = "1.3.14.7.2.2" -szOID_OIWDIR_SIGN = "1.3.14.7.2.3" -szOID_OIWDIR_md2 = "1.3.14.7.2.2.1" -szOID_OIWDIR_md2RSA = "1.3.14.7.2.3.1" -szOID_INFOSEC = "2.16.840.1.101.2.1" -szOID_INFOSEC_sdnsSignature = "2.16.840.1.101.2.1.1.1" -szOID_INFOSEC_mosaicSignature = "2.16.840.1.101.2.1.1.2" -szOID_INFOSEC_sdnsConfidentiality = "2.16.840.1.101.2.1.1.3" -szOID_INFOSEC_mosaicConfidentiality = "2.16.840.1.101.2.1.1.4" -szOID_INFOSEC_sdnsIntegrity = "2.16.840.1.101.2.1.1.5" -szOID_INFOSEC_mosaicIntegrity = "2.16.840.1.101.2.1.1.6" -szOID_INFOSEC_sdnsTokenProtection = "2.16.840.1.101.2.1.1.7" -szOID_INFOSEC_mosaicTokenProtection = "2.16.840.1.101.2.1.1.8" -szOID_INFOSEC_sdnsKeyManagement = "2.16.840.1.101.2.1.1.9" -szOID_INFOSEC_mosaicKeyManagement = "2.16.840.1.101.2.1.1.10" -szOID_INFOSEC_sdnsKMandSig = "2.16.840.1.101.2.1.1.11" -szOID_INFOSEC_mosaicKMandSig = "2.16.840.1.101.2.1.1.12" -szOID_INFOSEC_SuiteASignature = "2.16.840.1.101.2.1.1.13" -szOID_INFOSEC_SuiteAConfidentiality = "2.16.840.1.101.2.1.1.14" -szOID_INFOSEC_SuiteAIntegrity = "2.16.840.1.101.2.1.1.15" -szOID_INFOSEC_SuiteATokenProtection = "2.16.840.1.101.2.1.1.16" -szOID_INFOSEC_SuiteAKeyManagement = "2.16.840.1.101.2.1.1.17" -szOID_INFOSEC_SuiteAKMandSig = "2.16.840.1.101.2.1.1.18" -szOID_INFOSEC_mosaicUpdatedSig = "2.16.840.1.101.2.1.1.19" -szOID_INFOSEC_mosaicKMandUpdSig = "2.16.840.1.101.2.1.1.20" -szOID_INFOSEC_mosaicUpdatedInteg = "2.16.840.1.101.2.1.1.21" -szOID_COMMON_NAME = "2.5.4.3" -szOID_SUR_NAME = "2.5.4.4" -szOID_DEVICE_SERIAL_NUMBER = "2.5.4.5" -szOID_COUNTRY_NAME = "2.5.4.6" -szOID_LOCALITY_NAME = "2.5.4.7" -szOID_STATE_OR_PROVINCE_NAME = "2.5.4.8" -szOID_STREET_ADDRESS = "2.5.4.9" -szOID_ORGANIZATION_NAME = "2.5.4.10" -szOID_ORGANIZATIONAL_UNIT_NAME = "2.5.4.11" -szOID_TITLE = "2.5.4.12" -szOID_DESCRIPTION = "2.5.4.13" -szOID_SEARCH_GUIDE = "2.5.4.14" -szOID_BUSINESS_CATEGORY = "2.5.4.15" -szOID_POSTAL_ADDRESS = "2.5.4.16" -szOID_POSTAL_CODE = "2.5.4.17" -szOID_POST_OFFICE_BOX = "2.5.4.18" -szOID_PHYSICAL_DELIVERY_OFFICE_NAME = "2.5.4.19" -szOID_TELEPHONE_NUMBER = "2.5.4.20" -szOID_TELEX_NUMBER = "2.5.4.21" -szOID_TELETEXT_TERMINAL_IDENTIFIER = "2.5.4.22" -szOID_FACSIMILE_TELEPHONE_NUMBER = "2.5.4.23" -szOID_X21_ADDRESS = "2.5.4.24" -szOID_INTERNATIONAL_ISDN_NUMBER = "2.5.4.25" -szOID_REGISTERED_ADDRESS = "2.5.4.26" -szOID_DESTINATION_INDICATOR = "2.5.4.27" -szOID_PREFERRED_DELIVERY_METHOD = "2.5.4.28" -szOID_PRESENTATION_ADDRESS = "2.5.4.29" -szOID_SUPPORTED_APPLICATION_CONTEXT = "2.5.4.30" -szOID_MEMBER = "2.5.4.31" -szOID_OWNER = "2.5.4.32" -szOID_ROLE_OCCUPANT = "2.5.4.33" -szOID_SEE_ALSO = "2.5.4.34" -szOID_USER_PASSWORD = "2.5.4.35" -szOID_USER_CERTIFICATE = "2.5.4.36" -szOID_CA_CERTIFICATE = "2.5.4.37" -szOID_AUTHORITY_REVOCATION_LIST = "2.5.4.38" -szOID_CERTIFICATE_REVOCATION_LIST = "2.5.4.39" -szOID_CROSS_CERTIFICATE_PAIR = "2.5.4.40" -szOID_GIVEN_NAME = "2.5.4.42" -szOID_INITIALS = "2.5.4.43" -szOID_DN_QUALIFIER = "2.5.4.46" -szOID_DOMAIN_COMPONENT = "0.9.2342.19200300.100.1.25" -szOID_PKCS_12_FRIENDLY_NAME_ATTR = "1.2.840.113549.1.9.20" -szOID_PKCS_12_LOCAL_KEY_ID = "1.2.840.113549.1.9.21" -szOID_PKCS_12_KEY_PROVIDER_NAME_ATTR = "1.3.6.1.4.1.311.17.1" -szOID_LOCAL_MACHINE_KEYSET = "1.3.6.1.4.1.311.17.2" -szOID_KEYID_RDN = "1.3.6.1.4.1.311.10.7.1" -CERT_RDN_ANY_TYPE = 0 -CERT_RDN_ENCODED_BLOB = 1 -CERT_RDN_OCTET_STRING = 2 -CERT_RDN_NUMERIC_STRING = 3 -CERT_RDN_PRINTABLE_STRING = 4 -CERT_RDN_TELETEX_STRING = 5 -CERT_RDN_T61_STRING = 5 -CERT_RDN_VIDEOTEX_STRING = 6 -CERT_RDN_IA5_STRING = 7 -CERT_RDN_GRAPHIC_STRING = 8 -CERT_RDN_VISIBLE_STRING = 9 -CERT_RDN_ISO646_STRING = 9 -CERT_RDN_GENERAL_STRING = 10 -CERT_RDN_UNIVERSAL_STRING = 11 -CERT_RDN_INT4_STRING = 11 -CERT_RDN_BMP_STRING = 12 -CERT_RDN_UNICODE_STRING = 12 -CERT_RDN_UTF8_STRING = 13 -CERT_RDN_TYPE_MASK = 0x000000FF -CERT_RDN_FLAGS_MASK = (-16777216) -CERT_RDN_ENABLE_T61_UNICODE_FLAG = (-2147483648) -CERT_RDN_ENABLE_UTF8_UNICODE_FLAG = 0x20000000 -CERT_RDN_DISABLE_CHECK_TYPE_FLAG = 0x40000000 -CERT_RDN_DISABLE_IE4_UTF8_FLAG = 0x01000000 -CERT_RSA_PUBLIC_KEY_OBJID = szOID_RSA_RSA -CERT_DEFAULT_OID_PUBLIC_KEY_SIGN = szOID_RSA_RSA -CERT_DEFAULT_OID_PUBLIC_KEY_XCHG = szOID_RSA_RSA -CERT_V1 = 0 -CERT_V2 = 1 -CERT_V3 = 2 -CERT_INFO_VERSION_FLAG = 1 -CERT_INFO_SERIAL_NUMBER_FLAG = 2 -CERT_INFO_SIGNATURE_ALGORITHM_FLAG = 3 -CERT_INFO_ISSUER_FLAG = 4 -CERT_INFO_NOT_BEFORE_FLAG = 5 -CERT_INFO_NOT_AFTER_FLAG = 6 -CERT_INFO_SUBJECT_FLAG = 7 -CERT_INFO_SUBJECT_PUBLIC_KEY_INFO_FLAG = 8 -CERT_INFO_ISSUER_UNIQUE_ID_FLAG = 9 -CERT_INFO_SUBJECT_UNIQUE_ID_FLAG = 10 -CERT_INFO_EXTENSION_FLAG = 11 -CRL_V1 = 0 -CRL_V2 = 1 -CERT_REQUEST_V1 = 0 -CERT_KEYGEN_REQUEST_V1 = 0 -CTL_V1 = 0 -CERT_ENCODING_TYPE_MASK = 0x0000FFFF -CMSG_ENCODING_TYPE_MASK = (-65536) - - -def GET_CERT_ENCODING_TYPE(X) -> int: - ... - - -def GET_CMSG_ENCODING_TYPE(X) -> int: - ... - - -CRYPT_ASN_ENCODING = 0x00000001 -CRYPT_NDR_ENCODING = 0x00000002 -X509_ASN_ENCODING = 0x00000001 -X509_NDR_ENCODING = 0x00000002 -PKCS_7_ASN_ENCODING = 0x00010000 -PKCS_7_NDR_ENCODING = 0x00020000 -CRYPT_FORMAT_STR_MULTI_LINE = 0x0001 -CRYPT_FORMAT_STR_NO_HEX = 0x0010 -CRYPT_FORMAT_SIMPLE = 0x0001 -CRYPT_FORMAT_X509 = 0x0002 -CRYPT_FORMAT_OID = 0x0004 -CRYPT_FORMAT_RDN_SEMICOLON = 0x0100 -CRYPT_FORMAT_RDN_CRLF = 0x0200 -CRYPT_FORMAT_RDN_UNQUOTE = 0x0400 -CRYPT_FORMAT_RDN_REVERSE = 0x0800 -CRYPT_FORMAT_COMMA = 0x1000 -CRYPT_FORMAT_SEMICOLON = CRYPT_FORMAT_RDN_SEMICOLON -CRYPT_FORMAT_CRLF = CRYPT_FORMAT_RDN_CRLF -CRYPT_ENCODE_NO_SIGNATURE_BYTE_REVERSAL_FLAG = 0x8 -CRYPT_ENCODE_ALLOC_FLAG = 0x8000 -CRYPT_UNICODE_NAME_ENCODE_ENABLE_T61_UNICODE_FLAG = \ - CERT_RDN_ENABLE_T61_UNICODE_FLAG -CRYPT_UNICODE_NAME_ENCODE_ENABLE_UTF8_UNICODE_FLAG = \ - CERT_RDN_ENABLE_UTF8_UNICODE_FLAG -CRYPT_UNICODE_NAME_ENCODE_DISABLE_CHECK_TYPE_FLAG = \ - CERT_RDN_DISABLE_CHECK_TYPE_FLAG -CRYPT_SORTED_CTL_ENCODE_HASHED_SUBJECT_IDENTIFIER_FLAG = 0x10000 -CRYPT_DECODE_NOCOPY_FLAG = 0x1 -CRYPT_DECODE_TO_BE_SIGNED_FLAG = 0x2 -CRYPT_DECODE_SHARE_OID_STRING_FLAG = 0x4 -CRYPT_DECODE_NO_SIGNATURE_BYTE_REVERSAL_FLAG = 0x8 -CRYPT_DECODE_ALLOC_FLAG = 0x8000 -CRYPT_UNICODE_NAME_DECODE_DISABLE_IE4_UTF8_FLAG = \ - CERT_RDN_DISABLE_IE4_UTF8_FLAG - -CRYPT_ENCODE_DECODE_NONE = 0 -X509_CERT = 1 -X509_CERT_TO_BE_SIGNED = 2 -X509_CERT_CRL_TO_BE_SIGNED = 3 -X509_CERT_REQUEST_TO_BE_SIGNED = 4 -X509_EXTENSIONS = 5 -X509_NAME_VALUE = 6 -X509_NAME = 7 -X509_PUBLIC_KEY_INFO = 8 -X509_AUTHORITY_KEY_ID = 9 -X509_KEY_ATTRIBUTES = 10 -X509_KEY_USAGE_RESTRICTION = 11 -X509_ALTERNATE_NAME = 12 -X509_BASIC_CONSTRAINTS = 13 -X509_KEY_USAGE = 14 -X509_BASIC_CONSTRAINTS2 = 15 -X509_CERT_POLICIES = 16 -PKCS_UTC_TIME = 17 -PKCS_TIME_REQUEST = 18 -RSA_CSP_PUBLICKEYBLOB = 19 -X509_UNICODE_NAME = 20 -X509_KEYGEN_REQUEST_TO_BE_SIGNED = 21 -PKCS_ATTRIBUTE = 22 -PKCS_CONTENT_INFO_SEQUENCE_OF_ANY = 23 -X509_UNICODE_NAME_VALUE = 24 -X509_ANY_STRING = X509_NAME_VALUE -X509_UNICODE_ANY_STRING = X509_UNICODE_NAME_VALUE -X509_OCTET_STRING = 25 -X509_BITS = 26 -X509_INTEGER = 27 -X509_MULTI_BYTE_INTEGER = 28 -X509_ENUMERATED = 29 -X509_CHOICE_OF_TIME = 30 -X509_AUTHORITY_KEY_ID2 = 31 -X509_AUTHORITY_INFO_ACCESS = 32 -X509_SUBJECT_INFO_ACCESS = X509_AUTHORITY_INFO_ACCESS -X509_CRL_REASON_CODE = X509_ENUMERATED -PKCS_CONTENT_INFO = 33 -X509_SEQUENCE_OF_ANY = 34 -X509_CRL_DIST_POINTS = 35 -X509_ENHANCED_KEY_USAGE = 36 -PKCS_CTL = 37 -X509_MULTI_BYTE_UINT = 38 -X509_DSS_PUBLICKEY = X509_MULTI_BYTE_UINT -X509_DSS_PARAMETERS = 39 -X509_DSS_SIGNATURE = 40 -PKCS_RC2_CBC_PARAMETERS = 41 -PKCS_SMIME_CAPABILITIES = 42 -X509_QC_STATEMENTS_EXT = 42 -PKCS_RSA_PRIVATE_KEY = 43 -PKCS_PRIVATE_KEY_INFO = 44 -PKCS_ENCRYPTED_PRIVATE_KEY_INFO = 45 -X509_PKIX_POLICY_QUALIFIER_USERNOTICE = 46 -X509_DH_PUBLICKEY = X509_MULTI_BYTE_UINT -X509_DH_PARAMETERS = 47 -PKCS_ATTRIBUTES = 48 -PKCS_SORTED_CTL = 49 -X509_ECC_SIGNATURE = 47 -X942_DH_PARAMETERS = 50 -X509_BITS_WITHOUT_TRAILING_ZEROES = 51 -X942_OTHER_INFO = 52 -X509_CERT_PAIR = 53 -X509_ISSUING_DIST_POINT = 54 -X509_NAME_CONSTRAINTS = 55 -X509_POLICY_MAPPINGS = 56 -X509_POLICY_CONSTRAINTS = 57 -X509_CROSS_CERT_DIST_POINTS = 58 -CMC_DATA = 59 -CMC_RESPONSE = 60 -CMC_STATUS = 61 -CMC_ADD_EXTENSIONS = 62 -CMC_ADD_ATTRIBUTES = 63 -X509_CERTIFICATE_TEMPLATE = 64 -OCSP_SIGNED_REQUEST = 65 -OCSP_REQUEST = 66 -OCSP_RESPONSE = 67 -OCSP_BASIC_SIGNED_RESPONSE = 68 -OCSP_BASIC_RESPONSE = 69 -X509_LOGOTYPE_EXT = 70 -X509_BIOMETRIC_EXT = 71 -CNG_RSA_PUBLIC_KEY_BLOB = 72 -X509_OBJECT_IDENTIFIER = 73 -X509_ALGORITHM_IDENTIFIER = 74 -PKCS_RSA_SSA_PSS_PARAMETERS = 75 -PKCS_RSAES_OAEP_PARAMETERS = 76 -ECC_CMS_SHARED_INFO = 77 -TIMESTAMP_REQUEST = 78 -TIMESTAMP_RESPONSE = 79 -TIMESTAMP_INFO = 80 -X509_CERT_BUNDLE = 81 -PKCS7_SIGNER_INFO = 500 -CMS_SIGNER_INFO = 501 - -szOID_AUTHORITY_KEY_IDENTIFIER = "2.5.29.1" -szOID_KEY_ATTRIBUTES = "2.5.29.2" -szOID_CERT_POLICIES_95 = "2.5.29.3" -szOID_KEY_USAGE_RESTRICTION = "2.5.29.4" -szOID_SUBJECT_ALT_NAME = "2.5.29.7" -szOID_ISSUER_ALT_NAME = "2.5.29.8" -szOID_BASIC_CONSTRAINTS = "2.5.29.10" -szOID_KEY_USAGE = "2.5.29.15" -szOID_PRIVATEKEY_USAGE_PERIOD = "2.5.29.16" -szOID_BASIC_CONSTRAINTS2 = "2.5.29.19" -szOID_CERT_POLICIES = "2.5.29.32" -szOID_ANY_CERT_POLICY = "2.5.29.32.0" -szOID_AUTHORITY_KEY_IDENTIFIER2 = "2.5.29.35" -szOID_SUBJECT_KEY_IDENTIFIER = "2.5.29.14" -szOID_SUBJECT_ALT_NAME2 = "2.5.29.17" -szOID_ISSUER_ALT_NAME2 = "2.5.29.18" -szOID_CRL_REASON_CODE = "2.5.29.21" -szOID_REASON_CODE_HOLD = "2.5.29.23" -szOID_CRL_DIST_POINTS = "2.5.29.31" -szOID_ENHANCED_KEY_USAGE = "2.5.29.37" -szOID_CRL_NUMBER = "2.5.29.20" -szOID_DELTA_CRL_INDICATOR = "2.5.29.27" -szOID_ISSUING_DIST_POINT = "2.5.29.28" -szOID_FRESHEST_CRL = "2.5.29.46" -szOID_NAME_CONSTRAINTS = "2.5.29.30" -szOID_POLICY_MAPPINGS = "2.5.29.33" -szOID_LEGACY_POLICY_MAPPINGS = "2.5.29.5" -szOID_POLICY_CONSTRAINTS = "2.5.29.36" -szOID_RENEWAL_CERTIFICATE = "1.3.6.1.4.1.311.13.1" -szOID_ENROLLMENT_NAME_VALUE_PAIR = "1.3.6.1.4.1.311.13.2.1" -szOID_ENROLLMENT_CSP_PROVIDER = "1.3.6.1.4.1.311.13.2.2" -szOID_OS_VERSION = "1.3.6.1.4.1.311.13.2.3" -szOID_ENROLLMENT_AGENT = "1.3.6.1.4.1.311.20.2.1" -szOID_PKIX = "1.3.6.1.5.5.7" -szOID_PKIX_PE = "1.3.6.1.5.5.7.1" -szOID_AUTHORITY_INFO_ACCESS = "1.3.6.1.5.5.7.1.1" -szOID_CERT_EXTENSIONS = "1.3.6.1.4.1.311.2.1.14" -szOID_NEXT_UPDATE_LOCATION = "1.3.6.1.4.1.311.10.2" -szOID_REMOVE_CERTIFICATE = "1.3.6.1.4.1.311.10.8.1" -szOID_CROSS_CERT_DIST_POINTS = "1.3.6.1.4.1.311.10.9.1" -szOID_CTL = "1.3.6.1.4.1.311.10.1" -szOID_SORTED_CTL = "1.3.6.1.4.1.311.10.1.1" -szOID_SERIALIZED = "1.3.6.1.4.1.311.10.3.3.1" -szOID_NT_PRINCIPAL_NAME = "1.3.6.1.4.1.311.20.2.3" -szOID_PRODUCT_UPDATE = "1.3.6.1.4.1.311.31.1" -szOID_ANY_APPLICATION_POLICY = "1.3.6.1.4.1.311.10.12.1" -szOID_AUTO_ENROLL_CTL_USAGE = "1.3.6.1.4.1.311.20.1" -szOID_ENROLL_CERTTYPE_EXTENSION = "1.3.6.1.4.1.311.20.2" -szOID_CERT_MANIFOLD = "1.3.6.1.4.1.311.20.3" -szOID_CERTSRV_CA_VERSION = "1.3.6.1.4.1.311.21.1" -szOID_CERTSRV_PREVIOUS_CERT_HASH = "1.3.6.1.4.1.311.21.2" -szOID_CRL_VIRTUAL_BASE = "1.3.6.1.4.1.311.21.3" -szOID_CRL_NEXT_PUBLISH = "1.3.6.1.4.1.311.21.4" -szOID_KP_CA_EXCHANGE = "1.3.6.1.4.1.311.21.5" -szOID_KP_KEY_RECOVERY_AGENT = "1.3.6.1.4.1.311.21.6" -szOID_CERTIFICATE_TEMPLATE = "1.3.6.1.4.1.311.21.7" -szOID_ENTERPRISE_OID_ROOT = "1.3.6.1.4.1.311.21.8" -szOID_RDN_DUMMY_SIGNER = "1.3.6.1.4.1.311.21.9" -szOID_APPLICATION_CERT_POLICIES = "1.3.6.1.4.1.311.21.10" -szOID_APPLICATION_POLICY_MAPPINGS = "1.3.6.1.4.1.311.21.11" -szOID_APPLICATION_POLICY_CONSTRAINTS = "1.3.6.1.4.1.311.21.12" -szOID_ARCHIVED_KEY_ATTR = "1.3.6.1.4.1.311.21.13" -szOID_CRL_SELF_CDP = "1.3.6.1.4.1.311.21.14" -szOID_REQUIRE_CERT_CHAIN_POLICY = "1.3.6.1.4.1.311.21.15" -szOID_ARCHIVED_KEY_CERT_HASH = "1.3.6.1.4.1.311.21.16" -szOID_ISSUED_CERT_HASH = "1.3.6.1.4.1.311.21.17" -szOID_DS_EMAIL_REPLICATION = "1.3.6.1.4.1.311.21.19" -szOID_REQUEST_CLIENT_INFO = "1.3.6.1.4.1.311.21.20" -szOID_ENCRYPTED_KEY_HASH = "1.3.6.1.4.1.311.21.21" -szOID_CERTSRV_CROSSCA_VERSION = "1.3.6.1.4.1.311.21.22" -szOID_NTDS_REPLICATION = "1.3.6.1.4.1.311.25.1" -szOID_SUBJECT_DIR_ATTRS = "2.5.29.9" -szOID_PKIX_KP = "1.3.6.1.5.5.7.3" -szOID_PKIX_KP_SERVER_AUTH = "1.3.6.1.5.5.7.3.1" -szOID_PKIX_KP_CLIENT_AUTH = "1.3.6.1.5.5.7.3.2" -szOID_PKIX_KP_CODE_SIGNING = "1.3.6.1.5.5.7.3.3" -szOID_PKIX_KP_EMAIL_PROTECTION = "1.3.6.1.5.5.7.3.4" -szOID_PKIX_KP_IPSEC_END_SYSTEM = "1.3.6.1.5.5.7.3.5" -szOID_PKIX_KP_IPSEC_TUNNEL = "1.3.6.1.5.5.7.3.6" -szOID_PKIX_KP_IPSEC_USER = "1.3.6.1.5.5.7.3.7" -szOID_PKIX_KP_TIMESTAMP_SIGNING = "1.3.6.1.5.5.7.3.8" -szOID_IPSEC_KP_IKE_INTERMEDIATE = "1.3.6.1.5.5.8.2.2" -szOID_KP_CTL_USAGE_SIGNING = "1.3.6.1.4.1.311.10.3.1" -szOID_KP_TIME_STAMP_SIGNING = "1.3.6.1.4.1.311.10.3.2" -szOID_SERVER_GATED_CRYPTO = "1.3.6.1.4.1.311.10.3.3" -szOID_SGC_NETSCAPE = "2.16.840.1.113730.4.1" -szOID_KP_EFS = "1.3.6.1.4.1.311.10.3.4" -szOID_EFS_RECOVERY = "1.3.6.1.4.1.311.10.3.4.1" -szOID_WHQL_CRYPTO = "1.3.6.1.4.1.311.10.3.5" -szOID_NT5_CRYPTO = "1.3.6.1.4.1.311.10.3.6" -szOID_OEM_WHQL_CRYPTO = "1.3.6.1.4.1.311.10.3.7" -szOID_EMBEDDED_NT_CRYPTO = "1.3.6.1.4.1.311.10.3.8" -szOID_ROOT_LIST_SIGNER = "1.3.6.1.4.1.311.10.3.9" -szOID_KP_QUALIFIED_SUBORDINATION = "1.3.6.1.4.1.311.10.3.10" -szOID_KP_KEY_RECOVERY = "1.3.6.1.4.1.311.10.3.11" -szOID_KP_DOCUMENT_SIGNING = "1.3.6.1.4.1.311.10.3.12" -szOID_KP_LIFETIME_SIGNING = "1.3.6.1.4.1.311.10.3.13" -szOID_KP_MOBILE_DEVICE_SOFTWARE = "1.3.6.1.4.1.311.10.3.14" -szOID_DRM = "1.3.6.1.4.1.311.10.5.1" -szOID_DRM_INDIVIDUALIZATION = "1.3.6.1.4.1.311.10.5.2" -szOID_LICENSES = "1.3.6.1.4.1.311.10.6.1" -szOID_LICENSE_SERVER = "1.3.6.1.4.1.311.10.6.2" -szOID_KP_SMARTCARD_LOGON = "1.3.6.1.4.1.311.20.2.2" -szOID_YESNO_TRUST_ATTR = "1.3.6.1.4.1.311.10.4.1" -szOID_PKIX_POLICY_QUALIFIER_CPS = "1.3.6.1.5.5.7.2.1" -szOID_PKIX_POLICY_QUALIFIER_USERNOTICE = "1.3.6.1.5.5.7.2.2" -szOID_CERT_POLICIES_95_QUALIFIER1 = "2.16.840.1.113733.1.7.1.1" -CERT_UNICODE_RDN_ERR_INDEX_MASK = 0x3FF -CERT_UNICODE_RDN_ERR_INDEX_SHIFT = 22 -CERT_UNICODE_ATTR_ERR_INDEX_MASK = 0x003F -CERT_UNICODE_ATTR_ERR_INDEX_SHIFT = 16 -CERT_UNICODE_VALUE_ERR_INDEX_MASK = 0x0000FFFF -CERT_UNICODE_VALUE_ERR_INDEX_SHIFT = 0 -CERT_DIGITAL_SIGNATURE_KEY_USAGE = 0x80 -CERT_NON_REPUDIATION_KEY_USAGE = 0x40 -CERT_KEY_ENCIPHERMENT_KEY_USAGE = 0x20 -CERT_DATA_ENCIPHERMENT_KEY_USAGE = 0x10 -CERT_KEY_AGREEMENT_KEY_USAGE = 0x08 -CERT_KEY_CERT_SIGN_KEY_USAGE = 0x04 -CERT_OFFLINE_CRL_SIGN_KEY_USAGE = 0x02 -CERT_CRL_SIGN_KEY_USAGE = 0x02 -CERT_ENCIPHER_ONLY_KEY_USAGE = 0x01 -CERT_DECIPHER_ONLY_KEY_USAGE = 0x80 -CERT_ALT_NAME_OTHER_NAME = 1 -CERT_ALT_NAME_RFC822_NAME = 2 -CERT_ALT_NAME_DNS_NAME = 3 -CERT_ALT_NAME_X400_ADDRESS = 4 -CERT_ALT_NAME_DIRECTORY_NAME = 5 -CERT_ALT_NAME_EDI_PARTY_NAME = 6 -CERT_ALT_NAME_URL = 7 -CERT_ALT_NAME_IP_ADDRESS = 8 -CERT_ALT_NAME_REGISTERED_ID = 9 -CERT_ALT_NAME_ENTRY_ERR_INDEX_MASK = 0xFF -CERT_ALT_NAME_ENTRY_ERR_INDEX_SHIFT = 16 -CERT_ALT_NAME_VALUE_ERR_INDEX_MASK = 0x0000FFFF -CERT_ALT_NAME_VALUE_ERR_INDEX_SHIFT = 0 -CERT_CA_SUBJECT_FLAG = 0x80 -CERT_END_ENTITY_SUBJECT_FLAG = 0x40 -szOID_PKIX_ACC_DESCR = "1.3.6.1.5.5.7.48" -szOID_PKIX_OCSP = "1.3.6.1.5.5.7.48.1" -szOID_PKIX_CA_ISSUERS = "1.3.6.1.5.5.7.48.2" -CRL_REASON_UNSPECIFIED = 0 -CRL_REASON_KEY_COMPROMISE = 1 -CRL_REASON_CA_COMPROMISE = 2 -CRL_REASON_AFFILIATION_CHANGED = 3 -CRL_REASON_SUPERSEDED = 4 -CRL_REASON_CESSATION_OF_OPERATION = 5 -CRL_REASON_CERTIFICATE_HOLD = 6 -CRL_REASON_REMOVE_FROM_CRL = 8 -CRL_DIST_POINT_NO_NAME = 0 -CRL_DIST_POINT_FULL_NAME = 1 -CRL_DIST_POINT_ISSUER_RDN_NAME = 2 -CRL_REASON_UNUSED_FLAG = 0x80 -CRL_REASON_KEY_COMPROMISE_FLAG = 0x40 -CRL_REASON_CA_COMPROMISE_FLAG = 0x20 -CRL_REASON_AFFILIATION_CHANGED_FLAG = 0x10 -CRL_REASON_SUPERSEDED_FLAG = 0x08 -CRL_REASON_CESSATION_OF_OPERATION_FLAG = 0x04 -CRL_REASON_CERTIFICATE_HOLD_FLAG = 0x02 -CRL_DIST_POINT_ERR_INDEX_MASK = 0x7F -CRL_DIST_POINT_ERR_INDEX_SHIFT = 24 - -CRL_DIST_POINT_ERR_CRL_ISSUER_BIT = (-2147483648) - -CROSS_CERT_DIST_POINT_ERR_INDEX_MASK = 0xFF -CROSS_CERT_DIST_POINT_ERR_INDEX_SHIFT = 24 - -CERT_EXCLUDED_SUBTREE_BIT = (-2147483648) - -SORTED_CTL_EXT_FLAGS_OFFSET = (0 * 4) -SORTED_CTL_EXT_COUNT_OFFSET = (1 * 4) -SORTED_CTL_EXT_MAX_COLLISION_OFFSET = (2 * 4) -SORTED_CTL_EXT_HASH_BUCKET_OFFSET = (3 * 4) -SORTED_CTL_EXT_HASHED_SUBJECT_IDENTIFIER_FLAG = 0x1 -CERT_DSS_R_LEN = 20 -CERT_DSS_S_LEN = 20 -CERT_DSS_SIGNATURE_LEN = (CERT_DSS_R_LEN + CERT_DSS_S_LEN) -CERT_MAX_ASN_ENCODED_DSS_SIGNATURE_LEN = (2 + 2 * (2 + 20 + 1)) -CRYPT_X942_COUNTER_BYTE_LENGTH = 4 -CRYPT_X942_KEY_LENGTH_BYTE_LENGTH = 4 -CRYPT_X942_PUB_INFO_BYTE_LENGTH = (512 / 8) -CRYPT_RC2_40BIT_VERSION = 160 -CRYPT_RC2_56BIT_VERSION = 52 -CRYPT_RC2_64BIT_VERSION = 120 -CRYPT_RC2_128BIT_VERSION = 58 -szOID_VERISIGN_PRIVATE_6_9 = "2.16.840.1.113733.1.6.9" -szOID_VERISIGN_ONSITE_JURISDICTION_HASH = "2.16.840.1.113733.1.6.11" -szOID_VERISIGN_BITSTRING_6_13 = "2.16.840.1.113733.1.6.13" -szOID_VERISIGN_ISS_STRONG_CRYPTO = "2.16.840.1.113733.1.8.1" -szOID_NETSCAPE = "2.16.840.1.113730" -szOID_NETSCAPE_CERT_EXTENSION = "2.16.840.1.113730.1" -szOID_NETSCAPE_CERT_TYPE = "2.16.840.1.113730.1.1" -szOID_NETSCAPE_BASE_URL = "2.16.840.1.113730.1.2" -szOID_NETSCAPE_REVOCATION_URL = "2.16.840.1.113730.1.3" -szOID_NETSCAPE_CA_REVOCATION_URL = "2.16.840.1.113730.1.4" -szOID_NETSCAPE_CERT_RENEWAL_URL = "2.16.840.1.113730.1.7" -szOID_NETSCAPE_CA_POLICY_URL = "2.16.840.1.113730.1.8" -szOID_NETSCAPE_SSL_SERVER_NAME = "2.16.840.1.113730.1.12" -szOID_NETSCAPE_COMMENT = "2.16.840.1.113730.1.13" -szOID_NETSCAPE_DATA_TYPE = "2.16.840.1.113730.2" -szOID_NETSCAPE_CERT_SEQUENCE = "2.16.840.1.113730.2.5" -NETSCAPE_SSL_CLIENT_AUTH_CERT_TYPE = 0x80 -NETSCAPE_SSL_SERVER_AUTH_CERT_TYPE = 0x40 -NETSCAPE_SMIME_CERT_TYPE = 0x20 -NETSCAPE_SIGN_CERT_TYPE = 0x10 -NETSCAPE_SSL_CA_CERT_TYPE = 0x04 -NETSCAPE_SMIME_CA_CERT_TYPE = 0x02 -NETSCAPE_SIGN_CA_CERT_TYPE = 0x01 -szOID_CT_PKI_DATA = "1.3.6.1.5.5.7.12.2" -szOID_CT_PKI_RESPONSE = "1.3.6.1.5.5.7.12.3" -szOID_PKIX_NO_SIGNATURE = "1.3.6.1.5.5.7.6.2" -szOID_CMC = "1.3.6.1.5.5.7.7" -szOID_CMC_STATUS_INFO = "1.3.6.1.5.5.7.7.1" -szOID_CMC_IDENTIFICATION = "1.3.6.1.5.5.7.7.2" -szOID_CMC_IDENTITY_PROOF = "1.3.6.1.5.5.7.7.3" -szOID_CMC_DATA_RETURN = "1.3.6.1.5.5.7.7.4" -szOID_CMC_TRANSACTION_ID = "1.3.6.1.5.5.7.7.5" -szOID_CMC_SENDER_NONCE = "1.3.6.1.5.5.7.7.6" -szOID_CMC_RECIPIENT_NONCE = "1.3.6.1.5.5.7.7.7" -szOID_CMC_ADD_EXTENSIONS = "1.3.6.1.5.5.7.7.8" -szOID_CMC_ENCRYPTED_POP = "1.3.6.1.5.5.7.7.9" -szOID_CMC_DECRYPTED_POP = "1.3.6.1.5.5.7.7.10" -szOID_CMC_LRA_POP_WITNESS = "1.3.6.1.5.5.7.7.11" -szOID_CMC_GET_CERT = "1.3.6.1.5.5.7.7.15" -szOID_CMC_GET_CRL = "1.3.6.1.5.5.7.7.16" -szOID_CMC_REVOKE_REQUEST = "1.3.6.1.5.5.7.7.17" -szOID_CMC_REG_INFO = "1.3.6.1.5.5.7.7.18" -szOID_CMC_RESPONSE_INFO = "1.3.6.1.5.5.7.7.19" -szOID_CMC_QUERY_PENDING = "1.3.6.1.5.5.7.7.21" -szOID_CMC_ID_POP_LINK_RANDOM = "1.3.6.1.5.5.7.7.22" -szOID_CMC_ID_POP_LINK_WITNESS = "1.3.6.1.5.5.7.7.23" -szOID_CMC_ID_CONFIRM_CERT_ACCEPTANCE = "1.3.6.1.5.5.7.7.24" -szOID_CMC_ADD_ATTRIBUTES = "1.3.6.1.4.1.311.10.10.1" -CMC_TAGGED_CERT_REQUEST_CHOICE = 1 -CMC_OTHER_INFO_NO_CHOICE = 0 -CMC_OTHER_INFO_FAIL_CHOICE = 1 -CMC_OTHER_INFO_PEND_CHOICE = 2 -CMC_STATUS_SUCCESS = 0 -CMC_STATUS_FAILED = 2 -CMC_STATUS_PENDING = 3 -CMC_STATUS_NO_SUPPORT = 4 -CMC_STATUS_CONFIRM_REQUIRED = 5 -CMC_FAIL_BAD_ALG = 0 -CMC_FAIL_BAD_MESSAGE_CHECK = 1 -CMC_FAIL_BAD_REQUEST = 2 -CMC_FAIL_BAD_TIME = 3 -CMC_FAIL_BAD_CERT_ID = 4 -CMC_FAIL_UNSUPORTED_EXT = 5 -CMC_FAIL_MUST_ARCHIVE_KEYS = 6 -CMC_FAIL_BAD_IDENTITY = 7 -CMC_FAIL_POP_REQUIRED = 8 -CMC_FAIL_POP_FAILED = 9 -CMC_FAIL_NO_KEY_REUSE = 10 -CMC_FAIL_INTERNAL_CA_ERROR = 11 -CMC_FAIL_TRY_LATER = 12 -CRYPT_OID_ENCODE_OBJECT_FUNC = "CryptDllEncodeObject" -CRYPT_OID_DECODE_OBJECT_FUNC = "CryptDllDecodeObject" -CRYPT_OID_ENCODE_OBJECT_EX_FUNC = "CryptDllEncodeObjectEx" -CRYPT_OID_DECODE_OBJECT_EX_FUNC = "CryptDllDecodeObjectEx" -CRYPT_OID_CREATE_COM_OBJECT_FUNC = "CryptDllCreateCOMObject" -CRYPT_OID_VERIFY_REVOCATION_FUNC = "CertDllVerifyRevocation" -CRYPT_OID_VERIFY_CTL_USAGE_FUNC = "CertDllVerifyCTLUsage" -CRYPT_OID_FORMAT_OBJECT_FUNC = "CryptDllFormatObject" -CRYPT_OID_FIND_OID_INFO_FUNC = "CryptDllFindOIDInfo" -CRYPT_OID_FIND_LOCALIZED_NAME_FUNC = "CryptDllFindLocalizedName" - -CRYPT_OID_REGPATH = "Software\\Microsoft\\Cryptography\\OID" -CRYPT_OID_REG_ENCODING_TYPE_PREFIX = "EncodingType " -CRYPT_OID_REG_DLL_VALUE_NAME = "Dll" -CRYPT_OID_REG_FUNC_NAME_VALUE_NAME = "FuncName" -CRYPT_OID_REG_FUNC_NAME_VALUE_NAME_A = "FuncName" -CRYPT_OID_REG_FLAGS_VALUE_NAME = "CryptFlags" -CRYPT_DEFAULT_OID = "DEFAULT" -CRYPT_INSTALL_OID_FUNC_BEFORE_FLAG = 1 -CRYPT_GET_INSTALLED_OID_FUNC_FLAG = 0x1 -CRYPT_REGISTER_FIRST_INDEX = 0 -CRYPT_REGISTER_LAST_INDEX = (-1) -CRYPT_MATCH_ANY_ENCODING_TYPE = (-1) -CRYPT_HASH_ALG_OID_GROUP_ID = 1 -CRYPT_ENCRYPT_ALG_OID_GROUP_ID = 2 -CRYPT_PUBKEY_ALG_OID_GROUP_ID = 3 -CRYPT_SIGN_ALG_OID_GROUP_ID = 4 -CRYPT_RDN_ATTR_OID_GROUP_ID = 5 -CRYPT_EXT_OR_ATTR_OID_GROUP_ID = 6 -CRYPT_ENHKEY_USAGE_OID_GROUP_ID = 7 -CRYPT_POLICY_OID_GROUP_ID = 8 -CRYPT_TEMPLATE_OID_GROUP_ID = 9 -CRYPT_LAST_OID_GROUP_ID = 9 -CRYPT_FIRST_ALG_OID_GROUP_ID = CRYPT_HASH_ALG_OID_GROUP_ID -CRYPT_LAST_ALG_OID_GROUP_ID = CRYPT_SIGN_ALG_OID_GROUP_ID -CRYPT_OID_INHIBIT_SIGNATURE_FORMAT_FLAG = 0x1 -CRYPT_OID_USE_PUBKEY_PARA_FOR_PKCS7_FLAG = 0x2 -CRYPT_OID_NO_NULL_ALGORITHM_PARA_FLAG = 0x4 -CRYPT_OID_INFO_OID_KEY = 1 -CRYPT_OID_INFO_NAME_KEY = 2 -CRYPT_OID_INFO_ALGID_KEY = 3 -CRYPT_OID_INFO_SIGN_KEY = 4 -CRYPT_INSTALL_OID_INFO_BEFORE_FLAG = 1 -CRYPT_LOCALIZED_NAME_ENCODING_TYPE = 0 -CRYPT_LOCALIZED_NAME_OID = "LocalizedNames" -szOID_PKCS_7_DATA = "1.2.840.113549.1.7.1" -szOID_PKCS_7_SIGNED = "1.2.840.113549.1.7.2" -szOID_PKCS_7_ENVELOPED = "1.2.840.113549.1.7.3" -szOID_PKCS_7_SIGNEDANDENVELOPED = "1.2.840.113549.1.7.4" -szOID_PKCS_7_DIGESTED = "1.2.840.113549.1.7.5" -szOID_PKCS_7_ENCRYPTED = "1.2.840.113549.1.7.6" -szOID_PKCS_9_CONTENT_TYPE = "1.2.840.113549.1.9.3" -szOID_PKCS_9_MESSAGE_DIGEST = "1.2.840.113549.1.9.4" -CMSG_DATA = 1 -CMSG_SIGNED = 2 -CMSG_ENVELOPED = 3 -CMSG_SIGNED_AND_ENVELOPED = 4 -CMSG_HASHED = 5 -CMSG_ENCRYPTED = 6 - -CMSG_ALL_FLAGS = -1 -CMSG_DATA_FLAG = (1 << CMSG_DATA) -CMSG_SIGNED_FLAG = (1 << CMSG_SIGNED) -CMSG_ENVELOPED_FLAG = (1 << CMSG_ENVELOPED) -CMSG_SIGNED_AND_ENVELOPED_FLAG = (1 << CMSG_SIGNED_AND_ENVELOPED) -CMSG_HASHED_FLAG = (1 << CMSG_HASHED) -CMSG_ENCRYPTED_FLAG = (1 << CMSG_ENCRYPTED) -CERT_ID_ISSUER_SERIAL_NUMBER = 1 -CERT_ID_KEY_IDENTIFIER = 2 -CERT_ID_SHA1_HASH = 3 -CMSG_KEY_AGREE_EPHEMERAL_KEY_CHOICE = 1 -CMSG_KEY_AGREE_STATIC_KEY_CHOICE = 2 -CMSG_MAIL_LIST_HANDLE_KEY_CHOICE = 1 -CMSG_KEY_TRANS_RECIPIENT = 1 -CMSG_KEY_AGREE_RECIPIENT = 2 -CMSG_MAIL_LIST_RECIPIENT = 3 -CMSG_SP3_COMPATIBLE_ENCRYPT_FLAG = (-2147483648) -CMSG_RC4_NO_SALT_FLAG = 0x40000000 -CMSG_INDEFINITE_LENGTH = ((-1)) -CMSG_BARE_CONTENT_FLAG = 0x00000001 -CMSG_LENGTH_ONLY_FLAG = 0x00000002 -CMSG_DETACHED_FLAG = 0x00000004 -CMSG_AUTHENTICATED_ATTRIBUTES_FLAG = 0x00000008 -CMSG_CONTENTS_OCTETS_FLAG = 0x00000010 -CMSG_MAX_LENGTH_FLAG = 0x00000020 -CMSG_CMS_ENCAPSULATED_CONTENT_FLAG = 0x00000040 -CMSG_CRYPT_RELEASE_CONTEXT_FLAG = 0x00008000 -CMSG_TYPE_PARAM = 1 -CMSG_CONTENT_PARAM = 2 -CMSG_BARE_CONTENT_PARAM = 3 -CMSG_INNER_CONTENT_TYPE_PARAM = 4 -CMSG_SIGNER_COUNT_PARAM = 5 -CMSG_SIGNER_INFO_PARAM = 6 -CMSG_SIGNER_CERT_INFO_PARAM = 7 -CMSG_SIGNER_HASH_ALGORITHM_PARAM = 8 -CMSG_SIGNER_AUTH_ATTR_PARAM = 9 -CMSG_SIGNER_UNAUTH_ATTR_PARAM = 10 -CMSG_CERT_COUNT_PARAM = 11 -CMSG_CERT_PARAM = 12 -CMSG_CRL_COUNT_PARAM = 13 -CMSG_CRL_PARAM = 14 -CMSG_ENVELOPE_ALGORITHM_PARAM = 15 -CMSG_RECIPIENT_COUNT_PARAM = 17 -CMSG_RECIPIENT_INDEX_PARAM = 18 -CMSG_RECIPIENT_INFO_PARAM = 19 -CMSG_HASH_ALGORITHM_PARAM = 20 -CMSG_HASH_DATA_PARAM = 21 -CMSG_COMPUTED_HASH_PARAM = 22 -CMSG_ENCRYPT_PARAM = 26 -CMSG_ENCRYPTED_DIGEST = 27 -CMSG_ENCODED_SIGNER = 28 -CMSG_ENCODED_MESSAGE = 29 -CMSG_VERSION_PARAM = 30 -CMSG_ATTR_CERT_COUNT_PARAM = 31 -CMSG_ATTR_CERT_PARAM = 32 -CMSG_CMS_RECIPIENT_COUNT_PARAM = 33 -CMSG_CMS_RECIPIENT_INDEX_PARAM = 34 -CMSG_CMS_RECIPIENT_ENCRYPTED_KEY_INDEX_PARAM = 35 -CMSG_CMS_RECIPIENT_INFO_PARAM = 36 -CMSG_UNPROTECTED_ATTR_PARAM = 37 -CMSG_SIGNER_CERT_ID_PARAM = 38 -CMSG_CMS_SIGNER_INFO_PARAM = 39 -CMSG_SIGNED_DATA_V1 = 1 -CMSG_SIGNED_DATA_V3 = 3 -CMSG_SIGNED_DATA_PKCS_1_5_VERSION = CMSG_SIGNED_DATA_V1 -CMSG_SIGNED_DATA_CMS_VERSION = CMSG_SIGNED_DATA_V3 -CMSG_SIGNER_INFO_V1 = 1 -CMSG_SIGNER_INFO_V3 = 3 -CMSG_SIGNER_INFO_PKCS_1_5_VERSION = CMSG_SIGNER_INFO_V1 -CMSG_SIGNER_INFO_CMS_VERSION = CMSG_SIGNER_INFO_V3 -CMSG_HASHED_DATA_V0 = 0 -CMSG_HASHED_DATA_V2 = 2 -CMSG_HASHED_DATA_PKCS_1_5_VERSION = CMSG_HASHED_DATA_V0 -CMSG_HASHED_DATA_CMS_VERSION = CMSG_HASHED_DATA_V2 -CMSG_ENVELOPED_DATA_V0 = 0 -CMSG_ENVELOPED_DATA_V2 = 2 -CMSG_ENVELOPED_DATA_PKCS_1_5_VERSION = CMSG_ENVELOPED_DATA_V0 -CMSG_ENVELOPED_DATA_CMS_VERSION = CMSG_ENVELOPED_DATA_V2 -CMSG_KEY_AGREE_ORIGINATOR_CERT = 1 -CMSG_KEY_AGREE_ORIGINATOR_PUBLIC_KEY = 2 -CMSG_ENVELOPED_RECIPIENT_V0 = 0 -CMSG_ENVELOPED_RECIPIENT_V2 = 2 -CMSG_ENVELOPED_RECIPIENT_V3 = 3 -CMSG_ENVELOPED_RECIPIENT_V4 = 4 -CMSG_KEY_TRANS_PKCS_1_5_VERSION = CMSG_ENVELOPED_RECIPIENT_V0 -CMSG_KEY_TRANS_CMS_VERSION = CMSG_ENVELOPED_RECIPIENT_V2 -CMSG_KEY_AGREE_VERSION = CMSG_ENVELOPED_RECIPIENT_V3 -CMSG_MAIL_LIST_VERSION = CMSG_ENVELOPED_RECIPIENT_V4 -CMSG_CTRL_VERIFY_SIGNATURE = 1 -CMSG_CTRL_DECRYPT = 2 -CMSG_CTRL_VERIFY_HASH = 5 -CMSG_CTRL_ADD_SIGNER = 6 -CMSG_CTRL_DEL_SIGNER = 7 -CMSG_CTRL_ADD_SIGNER_UNAUTH_ATTR = 8 -CMSG_CTRL_DEL_SIGNER_UNAUTH_ATTR = 9 -CMSG_CTRL_ADD_CERT = 10 -CMSG_CTRL_DEL_CERT = 11 -CMSG_CTRL_ADD_CRL = 12 -CMSG_CTRL_DEL_CRL = 13 -CMSG_CTRL_ADD_ATTR_CERT = 14 -CMSG_CTRL_DEL_ATTR_CERT = 15 -CMSG_CTRL_KEY_TRANS_DECRYPT = 16 -CMSG_CTRL_KEY_AGREE_DECRYPT = 17 -CMSG_CTRL_MAIL_LIST_DECRYPT = 18 -CMSG_CTRL_VERIFY_SIGNATURE_EX = 19 -CMSG_CTRL_ADD_CMS_SIGNER_INFO = 20 -CMSG_VERIFY_SIGNER_PUBKEY = 1 -CMSG_VERIFY_SIGNER_CERT = 2 -CMSG_VERIFY_SIGNER_CHAIN = 3 -CMSG_VERIFY_SIGNER_NULL = 4 -CMSG_OID_GEN_ENCRYPT_KEY_FUNC = "CryptMsgDllGenEncryptKey" -CMSG_OID_EXPORT_ENCRYPT_KEY_FUNC = "CryptMsgDllExportEncryptKey" -CMSG_OID_IMPORT_ENCRYPT_KEY_FUNC = "CryptMsgDllImportEncryptKey" -CMSG_CONTENT_ENCRYPT_PAD_ENCODED_LEN_FLAG = 0x00000001 -CMSG_DEFAULT_INSTALLABLE_FUNC_OID = 1 -CMSG_CONTENT_ENCRYPT_FREE_PARA_FLAG = 0x00000001 -CMSG_CONTENT_ENCRYPT_RELEASE_CONTEXT_FLAG = 0x00008000 -CMSG_OID_GEN_CONTENT_ENCRYPT_KEY_FUNC = "CryptMsgDllGenContentEncryptKey" -CMSG_KEY_TRANS_ENCRYPT_FREE_PARA_FLAG = 0x00000001 -CMSG_OID_EXPORT_KEY_TRANS_FUNC = "CryptMsgDllExportKeyTrans" -CMSG_KEY_AGREE_ENCRYPT_FREE_PARA_FLAG = 0x00000001 -CMSG_KEY_AGREE_ENCRYPT_FREE_MATERIAL_FLAG = 0x00000002 -CMSG_KEY_AGREE_ENCRYPT_FREE_PUBKEY_ALG_FLAG = 0x00000004 -CMSG_KEY_AGREE_ENCRYPT_FREE_PUBKEY_PARA_FLAG = 0x00000008 -CMSG_KEY_AGREE_ENCRYPT_FREE_PUBKEY_BITS_FLAG = 0x00000010 -CMSG_OID_EXPORT_KEY_AGREE_FUNC = "CryptMsgDllExportKeyAgree" -CMSG_MAIL_LIST_ENCRYPT_FREE_PARA_FLAG = 0x00000001 -CMSG_OID_EXPORT_MAIL_LIST_FUNC = "CryptMsgDllExportMailList" -CMSG_OID_IMPORT_KEY_TRANS_FUNC = "CryptMsgDllImportKeyTrans" -CMSG_OID_IMPORT_KEY_AGREE_FUNC = "CryptMsgDllImportKeyAgree" -CMSG_OID_IMPORT_MAIL_LIST_FUNC = "CryptMsgDllImportMailList" - -# Certificate property id's used with CertGetCertificateContextProperty -CERT_KEY_PROV_HANDLE_PROP_ID = 1 -CERT_KEY_PROV_INFO_PROP_ID = 2 -CERT_SHA1_HASH_PROP_ID = 3 -CERT_MD5_HASH_PROP_ID = 4 -CERT_HASH_PROP_ID = CERT_SHA1_HASH_PROP_ID -CERT_KEY_CONTEXT_PROP_ID = 5 -CERT_KEY_SPEC_PROP_ID = 6 -CERT_IE30_RESERVED_PROP_ID = 7 -CERT_PUBKEY_HASH_RESERVED_PROP_ID = 8 -CERT_ENHKEY_USAGE_PROP_ID = 9 -CERT_CTL_USAGE_PROP_ID = CERT_ENHKEY_USAGE_PROP_ID -CERT_NEXT_UPDATE_LOCATION_PROP_ID = 10 -CERT_FRIENDLY_NAME_PROP_ID = 11 -CERT_PVK_FILE_PROP_ID = 12 -CERT_DESCRIPTION_PROP_ID = 13 -CERT_ACCESS_STATE_PROP_ID = 14 -CERT_SIGNATURE_HASH_PROP_ID = 15 -CERT_SMART_CARD_DATA_PROP_ID = 16 -CERT_EFS_PROP_ID = 17 -CERT_FORTEZZA_DATA_PROP_ID = 18 -CERT_ARCHIVED_PROP_ID = 19 -CERT_KEY_IDENTIFIER_PROP_ID = 20 -CERT_AUTO_ENROLL_PROP_ID = 21 -CERT_PUBKEY_ALG_PARA_PROP_ID = 22 -CERT_CROSS_CERT_DIST_POINTS_PROP_ID = 23 -CERT_ISSUER_PUBLIC_KEY_MD5_HASH_PROP_ID = 24 -CERT_SUBJECT_PUBLIC_KEY_MD5_HASH_PROP_ID = 25 -CERT_ENROLLMENT_PROP_ID = 26 -CERT_DATE_STAMP_PROP_ID = 27 -CERT_ISSUER_SERIAL_NUMBER_MD5_HASH_PROP_ID = 28 -CERT_SUBJECT_NAME_MD5_HASH_PROP_ID = 29 -CERT_EXTENDED_ERROR_INFO_PROP_ID = 30 -CERT_RENEWAL_PROP_ID = 64 -CERT_ARCHIVED_KEY_HASH_PROP_ID = 65 -CERT_AUTO_ENROLL_RETRY_PROP_ID = 66 -CERT_AIA_URL_RETRIEVED_PROP_ID = 67 -CERT_AUTHORITY_INFO_ACCESS_PROP_ID = 68 -CERT_BACKED_UP_PROP_ID = 69 -CERT_OCSP_RESPONSE_PROP_ID = 70 -CERT_REQUEST_ORIGINATOR_PROP_ID = 71 -CERT_SOURCE_LOCATION_PROP_ID = 72 -CERT_SOURCE_URL_PROP_ID = 73 -CERT_NEW_KEY_PROP_ID = 74 -CERT_OCSP_CACHE_PREFIX_PROP_ID = 75 -CERT_SMART_CARD_ROOT_INFO_PROP_ID = 76 -CERT_NO_AUTO_EXPIRE_CHECK_PROP_ID = 77 -CERT_NCRYPT_KEY_HANDLE_PROP_ID = 78 -CERT_HCRYPTPROV_OR_NCRYPT_KEY_HANDLE_PROP_ID = 79 -CERT_SUBJECT_INFO_ACCESS_PROP_ID = 80 -CERT_CA_OCSP_AUTHORITY_INFO_ACCESS_PROP_ID = 81 -CERT_CA_DISABLE_CRL_PROP_ID = 82 -CERT_ROOT_PROGRAM_CERT_POLICIES_PROP_ID = 83 -CERT_ROOT_PROGRAM_NAME_CONSTRAINTS_PROP_ID = 84 -CERT_SUBJECT_OCSP_AUTHORITY_INFO_ACCESS_PROP_ID = 85 -CERT_SUBJECT_DISABLE_CRL_PROP_ID = 86 -CERT_CEP_PROP_ID = 87 -CERT_SIGN_HASH_CNG_ALG_PROP_ID = 89 -CERT_SCARD_PIN_ID_PROP_ID = 90 -CERT_SCARD_PIN_INFO_PROP_ID = 91 -CERT_FIRST_RESERVED_PROP_ID = 92 -CERT_LAST_RESERVED_PROP_ID = 0x00007FFF -CERT_FIRST_USER_PROP_ID = 0x00008000 -CERT_LAST_USER_PROP_ID = 0x0000FFFF - -szOID_CERT_PROP_ID_PREFIX = "1.3.6.1.4.1.311.10.11." -szOID_CERT_KEY_IDENTIFIER_PROP_ID = "1.3.6.1.4.1.311.10.11.20" -szOID_CERT_ISSUER_SERIAL_NUMBER_MD5_HASH_PROP_ID = \ - "1.3.6.1.4.1.311.10.11.28" -szOID_CERT_SUBJECT_NAME_MD5_HASH_PROP_ID = \ - "1.3.6.1.4.1.311.10.11.29" -CERT_ACCESS_STATE_WRITE_PERSIST_FLAG = 0x1 -CERT_ACCESS_STATE_SYSTEM_STORE_FLAG = 0x2 -CERT_ACCESS_STATE_LM_SYSTEM_STORE_FLAG = 0x4 -CERT_SET_KEY_PROV_HANDLE_PROP_ID = 0x00000001 -CERT_SET_KEY_CONTEXT_PROP_ID = 0x00000001 -sz_CERT_STORE_PROV_MEMORY = "Memory" -sz_CERT_STORE_PROV_FILENAME_W = "File" -sz_CERT_STORE_PROV_FILENAME = sz_CERT_STORE_PROV_FILENAME_W -sz_CERT_STORE_PROV_SYSTEM_W = "System" -sz_CERT_STORE_PROV_SYSTEM = sz_CERT_STORE_PROV_SYSTEM_W -sz_CERT_STORE_PROV_PKCS7 = "PKCS7" -sz_CERT_STORE_PROV_SERIALIZED = "Serialized" -sz_CERT_STORE_PROV_COLLECTION = "Collection" -sz_CERT_STORE_PROV_SYSTEM_REGISTRY_W = "SystemRegistry" -sz_CERT_STORE_PROV_SYSTEM_REGISTRY = sz_CERT_STORE_PROV_SYSTEM_REGISTRY_W -sz_CERT_STORE_PROV_PHYSICAL_W = "Physical" -sz_CERT_STORE_PROV_PHYSICAL = sz_CERT_STORE_PROV_PHYSICAL_W -sz_CERT_STORE_PROV_SMART_CARD_W = "SmartCard" -sz_CERT_STORE_PROV_SMART_CARD = sz_CERT_STORE_PROV_SMART_CARD_W -sz_CERT_STORE_PROV_LDAP_W = "Ldap" -sz_CERT_STORE_PROV_LDAP = sz_CERT_STORE_PROV_LDAP_W -CERT_STORE_SIGNATURE_FLAG = 0x00000001 -CERT_STORE_TIME_VALIDITY_FLAG = 0x00000002 -CERT_STORE_REVOCATION_FLAG = 0x00000004 -CERT_STORE_NO_CRL_FLAG = 0x00010000 -CERT_STORE_NO_ISSUER_FLAG = 0x00020000 -CERT_STORE_BASE_CRL_FLAG = 0x00000100 -CERT_STORE_DELTA_CRL_FLAG = 0x00000200 -CERT_STORE_NO_CRYPT_RELEASE_FLAG = 0x00000001 -CERT_STORE_SET_LOCALIZED_NAME_FLAG = 0x00000002 -CERT_STORE_DEFER_CLOSE_UNTIL_LAST_FREE_FLAG = 0x00000004 -CERT_STORE_DELETE_FLAG = 0x00000010 -CERT_STORE_UNSAFE_PHYSICAL_FLAG = 0x00000020 -CERT_STORE_SHARE_STORE_FLAG = 0x00000040 -CERT_STORE_SHARE_CONTEXT_FLAG = 0x00000080 -CERT_STORE_MANIFOLD_FLAG = 0x00000100 -CERT_STORE_ENUM_ARCHIVED_FLAG = 0x00000200 -CERT_STORE_UPDATE_KEYID_FLAG = 0x00000400 -CERT_STORE_BACKUP_RESTORE_FLAG = 0x00000800 -CERT_STORE_READONLY_FLAG = 0x00008000 -CERT_STORE_OPEN_EXISTING_FLAG = 0x00004000 -CERT_STORE_CREATE_NEW_FLAG = 0x00002000 -CERT_STORE_MAXIMUM_ALLOWED_FLAG = 0x00001000 -CERT_SYSTEM_STORE_MASK = (-65536) -CERT_SYSTEM_STORE_RELOCATE_FLAG = (-2147483648) -CERT_SYSTEM_STORE_UNPROTECTED_FLAG = 0x40000000 -CERT_SYSTEM_STORE_LOCATION_MASK = 0x00FF0000 -CERT_SYSTEM_STORE_LOCATION_SHIFT = 16 -CERT_SYSTEM_STORE_CURRENT_USER_ID = 1 -CERT_SYSTEM_STORE_LOCAL_MACHINE_ID = 2 -CERT_SYSTEM_STORE_CURRENT_SERVICE_ID = 4 -CERT_SYSTEM_STORE_SERVICES_ID = 5 -CERT_SYSTEM_STORE_USERS_ID = 6 -CERT_SYSTEM_STORE_CURRENT_USER_GROUP_POLICY_ID = 7 -CERT_SYSTEM_STORE_LOCAL_MACHINE_GROUP_POLICY_ID = 8 -CERT_SYSTEM_STORE_LOCAL_MACHINE_ENTERPRISE_ID = 9 -CERT_SYSTEM_STORE_CURRENT_USER = \ - (CERT_SYSTEM_STORE_CURRENT_USER_ID << CERT_SYSTEM_STORE_LOCATION_SHIFT) -CERT_SYSTEM_STORE_LOCAL_MACHINE = \ - (CERT_SYSTEM_STORE_LOCAL_MACHINE_ID << CERT_SYSTEM_STORE_LOCATION_SHIFT) -CERT_SYSTEM_STORE_CURRENT_SERVICE = \ - (CERT_SYSTEM_STORE_CURRENT_SERVICE_ID << CERT_SYSTEM_STORE_LOCATION_SHIFT) -CERT_SYSTEM_STORE_SERVICES = \ - (CERT_SYSTEM_STORE_SERVICES_ID << CERT_SYSTEM_STORE_LOCATION_SHIFT) -CERT_SYSTEM_STORE_USERS = \ - (CERT_SYSTEM_STORE_USERS_ID << CERT_SYSTEM_STORE_LOCATION_SHIFT) -CERT_SYSTEM_STORE_CURRENT_USER_GROUP_POLICY = \ - (CERT_SYSTEM_STORE_CURRENT_USER_GROUP_POLICY_ID - << CERT_SYSTEM_STORE_LOCATION_SHIFT) -CERT_SYSTEM_STORE_LOCAL_MACHINE_GROUP_POLICY = \ - (CERT_SYSTEM_STORE_LOCAL_MACHINE_GROUP_POLICY_ID - << CERT_SYSTEM_STORE_LOCATION_SHIFT) -CERT_SYSTEM_STORE_LOCAL_MACHINE_ENTERPRISE = \ - (CERT_SYSTEM_STORE_LOCAL_MACHINE_ENTERPRISE_ID - << CERT_SYSTEM_STORE_LOCATION_SHIFT) -CERT_PROT_ROOT_DISABLE_CURRENT_USER_FLAG = 0x1 -CERT_PROT_ROOT_INHIBIT_ADD_AT_INIT_FLAG = 0x2 -CERT_PROT_ROOT_INHIBIT_PURGE_LM_FLAG = 0x4 -CERT_PROT_ROOT_DISABLE_LM_AUTH_FLAG = 0x8 -CERT_PROT_ROOT_ONLY_LM_GPT_FLAG = 0x8 -CERT_PROT_ROOT_DISABLE_NT_AUTH_REQUIRED_FLAG = 0x10 -CERT_PROT_ROOT_DISABLE_NOT_DEFINED_NAME_CONSTRAINT_FLAG = 0x20 -CERT_TRUST_PUB_ALLOW_TRUST_MASK = 0x00000003 -CERT_TRUST_PUB_ALLOW_END_USER_TRUST = 0x00000000 -CERT_TRUST_PUB_ALLOW_MACHINE_ADMIN_TRUST = 0x00000001 -CERT_TRUST_PUB_ALLOW_ENTERPRISE_ADMIN_TRUST = 0x00000002 -CERT_TRUST_PUB_CHECK_PUBLISHER_REV_FLAG = 0x00000100 -CERT_TRUST_PUB_CHECK_TIMESTAMP_REV_FLAG = 0x00000200 - -CERT_AUTH_ROOT_AUTO_UPDATE_LOCAL_MACHINE_REGPATH = r"Software\Microsoft\SystemCertificates\AuthRoot\AutoUpdate" -CERT_AUTH_ROOT_AUTO_UPDATE_DISABLE_UNTRUSTED_ROOT_LOGGING_FLAG = 0x1 -CERT_AUTH_ROOT_AUTO_UPDATE_DISABLE_PARTIAL_CHAIN_LOGGING_FLAG = 0x2 -CERT_AUTH_ROOT_AUTO_UPDATE_ROOT_DIR_URL_VALUE_NAME = "RootDirUrl" -CERT_AUTH_ROOT_AUTO_UPDATE_SYNC_DELTA_TIME_VALUE_NAME = "SyncDeltaTime" -CERT_AUTH_ROOT_AUTO_UPDATE_FLAGS_VALUE_NAME = "Flags" -CERT_AUTH_ROOT_CTL_FILENAME = "authroot.stl" -CERT_AUTH_ROOT_CTL_FILENAME_A = "authroot.stl" -CERT_AUTH_ROOT_CAB_FILENAME = "authrootstl.cab" -CERT_AUTH_ROOT_SEQ_FILENAME = "authrootseq.txt" -CERT_AUTH_ROOT_CERT_EXT = ".crt" - -CERT_GROUP_POLICY_SYSTEM_STORE_REGPATH = r"Software\Policies\Microsoft\SystemCertificates" -CERT_EFSBLOB_REGPATH = CERT_GROUP_POLICY_SYSTEM_STORE_REGPATH + r"\EFS" -CERT_EFSBLOB_VALUE_NAME = "EFSBlob" -CERT_PROT_ROOT_FLAGS_REGPATH = CERT_GROUP_POLICY_SYSTEM_STORE_REGPATH + r"\Root\ProtectedRoots" -CERT_PROT_ROOT_FLAGS_VALUE_NAME = "Flags" -CERT_TRUST_PUB_SAFER_GROUP_POLICY_REGPATH = CERT_GROUP_POLICY_SYSTEM_STORE_REGPATH + r"\TrustedPublisher\Safer" -CERT_LOCAL_MACHINE_SYSTEM_STORE_REGPATH = r"Software\Microsoft\SystemCertificates" -CERT_TRUST_PUB_SAFER_LOCAL_MACHINE_REGPATH = CERT_LOCAL_MACHINE_SYSTEM_STORE_REGPATH + r"\TrustedPublisher\Safer" -CERT_TRUST_PUB_AUTHENTICODE_FLAGS_VALUE_NAME = "AuthenticodeFlags" -CERT_OCM_SUBCOMPONENTS_LOCAL_MACHINE_REGPATH = r"SOFTWARE\Microsoft\Windows\CurrentVersion\Setup\OC Manager\Subcomponents" -CERT_OCM_SUBCOMPONENTS_ROOT_AUTO_UPDATE_VALUE_NAME = r"RootAutoUpdate" -CERT_DISABLE_ROOT_AUTO_UPDATE_REGPATH = CERT_GROUP_POLICY_SYSTEM_STORE_REGPATH + r"\AuthRoot" -CERT_DISABLE_ROOT_AUTO_UPDATE_VALUE_NAME = "DisableRootAutoUpdate" -CERT_AUTH_ROOT_AUTO_UPDATE_LOCAL_MACHINE_REGPATH = CERT_LOCAL_MACHINE_SYSTEM_STORE_REGPATH + r"\AuthRoot\AutoUpdate" - -CERT_REGISTRY_STORE_REMOTE_FLAG = 0x10000 -CERT_REGISTRY_STORE_SERIALIZED_FLAG = 0x20000 -CERT_REGISTRY_STORE_CLIENT_GPT_FLAG = (-2147483648) -CERT_REGISTRY_STORE_LM_GPT_FLAG = 0x01000000 -CERT_REGISTRY_STORE_ROAMING_FLAG = 0x40000 -CERT_REGISTRY_STORE_MY_IE_DIRTY_FLAG = 0x80000 -CERT_IE_DIRTY_FLAGS_REGPATH = r"Software\Microsoft\Cryptography\IEDirtyFlags" - -CERT_FILE_STORE_COMMIT_ENABLE_FLAG = 0x10000 -CERT_LDAP_STORE_SIGN_FLAG = 0x10000 -CERT_LDAP_STORE_AREC_EXCLUSIVE_FLAG = 0x20000 -CERT_LDAP_STORE_OPENED_FLAG = 0x40000 -CERT_LDAP_STORE_UNBIND_FLAG = 0x80000 -CRYPT_OID_OPEN_STORE_PROV_FUNC = "CertDllOpenStoreProv" - -CERT_STORE_PROV_EXTERNAL_FLAG = 0x1 -CERT_STORE_PROV_DELETED_FLAG = 0x2 -CERT_STORE_PROV_NO_PERSIST_FLAG = 0x4 -CERT_STORE_PROV_SYSTEM_STORE_FLAG = 0x8 -CERT_STORE_PROV_LM_SYSTEM_STORE_FLAG = 0x10 -CERT_STORE_PROV_CLOSE_FUNC = 0 -CERT_STORE_PROV_READ_CERT_FUNC = 1 -CERT_STORE_PROV_WRITE_CERT_FUNC = 2 -CERT_STORE_PROV_DELETE_CERT_FUNC = 3 -CERT_STORE_PROV_SET_CERT_PROPERTY_FUNC = 4 -CERT_STORE_PROV_READ_CRL_FUNC = 5 -CERT_STORE_PROV_WRITE_CRL_FUNC = 6 -CERT_STORE_PROV_DELETE_CRL_FUNC = 7 -CERT_STORE_PROV_SET_CRL_PROPERTY_FUNC = 8 -CERT_STORE_PROV_READ_CTL_FUNC = 9 -CERT_STORE_PROV_WRITE_CTL_FUNC = 10 -CERT_STORE_PROV_DELETE_CTL_FUNC = 11 -CERT_STORE_PROV_SET_CTL_PROPERTY_FUNC = 12 -CERT_STORE_PROV_CONTROL_FUNC = 13 -CERT_STORE_PROV_FIND_CERT_FUNC = 14 -CERT_STORE_PROV_FREE_FIND_CERT_FUNC = 15 -CERT_STORE_PROV_GET_CERT_PROPERTY_FUNC = 16 -CERT_STORE_PROV_FIND_CRL_FUNC = 17 -CERT_STORE_PROV_FREE_FIND_CRL_FUNC = 18 -CERT_STORE_PROV_GET_CRL_PROPERTY_FUNC = 19 -CERT_STORE_PROV_FIND_CTL_FUNC = 20 -CERT_STORE_PROV_FREE_FIND_CTL_FUNC = 21 -CERT_STORE_PROV_GET_CTL_PROPERTY_FUNC = 22 -CERT_STORE_PROV_WRITE_ADD_FLAG = 0x1 -CERT_STORE_SAVE_AS_STORE = 1 -CERT_STORE_SAVE_AS_PKCS7 = 2 -CERT_STORE_SAVE_TO_FILE = 1 -CERT_STORE_SAVE_TO_MEMORY = 2 -CERT_STORE_SAVE_TO_FILENAME_A = 3 -CERT_STORE_SAVE_TO_FILENAME_W = 4 -CERT_STORE_SAVE_TO_FILENAME = CERT_STORE_SAVE_TO_FILENAME_W -CERT_CLOSE_STORE_FORCE_FLAG = 0x00000001 -CERT_CLOSE_STORE_CHECK_FLAG = 0x00000002 -CERT_COMPARE_MASK = 0xFFFF -CERT_COMPARE_SHIFT = 16 -CERT_COMPARE_ANY = 0 -CERT_COMPARE_SHA1_HASH = 1 -CERT_COMPARE_NAME = 2 -CERT_COMPARE_ATTR = 3 -CERT_COMPARE_MD5_HASH = 4 -CERT_COMPARE_PROPERTY = 5 -CERT_COMPARE_PUBLIC_KEY = 6 -CERT_COMPARE_HASH = CERT_COMPARE_SHA1_HASH -CERT_COMPARE_NAME_STR_A = 7 -CERT_COMPARE_NAME_STR_W = 8 -CERT_COMPARE_KEY_SPEC = 9 -CERT_COMPARE_ENHKEY_USAGE = 10 -CERT_COMPARE_CTL_USAGE = CERT_COMPARE_ENHKEY_USAGE -CERT_COMPARE_SUBJECT_CERT = 11 -CERT_COMPARE_ISSUER_OF = 12 -CERT_COMPARE_EXISTING = 13 -CERT_COMPARE_SIGNATURE_HASH = 14 -CERT_COMPARE_KEY_IDENTIFIER = 15 -CERT_COMPARE_CERT_ID = 16 -CERT_COMPARE_CROSS_CERT_DIST_POINTS = 17 -CERT_COMPARE_PUBKEY_MD5_HASH = 18 -CERT_FIND_ANY = (CERT_COMPARE_ANY << CERT_COMPARE_SHIFT) -CERT_FIND_SHA1_HASH = (CERT_COMPARE_SHA1_HASH << CERT_COMPARE_SHIFT) -CERT_FIND_MD5_HASH = (CERT_COMPARE_MD5_HASH << CERT_COMPARE_SHIFT) -CERT_FIND_SIGNATURE_HASH = (CERT_COMPARE_SIGNATURE_HASH << CERT_COMPARE_SHIFT) -CERT_FIND_KEY_IDENTIFIER = (CERT_COMPARE_KEY_IDENTIFIER << CERT_COMPARE_SHIFT) -CERT_FIND_HASH = CERT_FIND_SHA1_HASH -CERT_FIND_PROPERTY = (CERT_COMPARE_PROPERTY << CERT_COMPARE_SHIFT) -CERT_FIND_PUBLIC_KEY = (CERT_COMPARE_PUBLIC_KEY << CERT_COMPARE_SHIFT) -CERT_FIND_SUBJECT_NAME = (CERT_COMPARE_NAME << CERT_COMPARE_SHIFT - | CERT_INFO_SUBJECT_FLAG) -CERT_FIND_SUBJECT_ATTR = (CERT_COMPARE_ATTR << CERT_COMPARE_SHIFT - | CERT_INFO_SUBJECT_FLAG) -CERT_FIND_ISSUER_NAME = (CERT_COMPARE_NAME << CERT_COMPARE_SHIFT - | CERT_INFO_ISSUER_FLAG) -CERT_FIND_ISSUER_ATTR = (CERT_COMPARE_ATTR << CERT_COMPARE_SHIFT - | CERT_INFO_ISSUER_FLAG) -CERT_FIND_SUBJECT_STR_A = (CERT_COMPARE_NAME_STR_A << CERT_COMPARE_SHIFT - | CERT_INFO_SUBJECT_FLAG) -CERT_FIND_SUBJECT_STR_W = (CERT_COMPARE_NAME_STR_W << CERT_COMPARE_SHIFT - | CERT_INFO_SUBJECT_FLAG) -CERT_FIND_SUBJECT_STR = CERT_FIND_SUBJECT_STR_W -CERT_FIND_ISSUER_STR_A = (CERT_COMPARE_NAME_STR_A << CERT_COMPARE_SHIFT - | CERT_INFO_ISSUER_FLAG) -CERT_FIND_ISSUER_STR_W = (CERT_COMPARE_NAME_STR_W << CERT_COMPARE_SHIFT - | CERT_INFO_ISSUER_FLAG) -CERT_FIND_ISSUER_STR = CERT_FIND_ISSUER_STR_W -CERT_FIND_KEY_SPEC = (CERT_COMPARE_KEY_SPEC << CERT_COMPARE_SHIFT) -CERT_FIND_ENHKEY_USAGE = (CERT_COMPARE_ENHKEY_USAGE << CERT_COMPARE_SHIFT) -CERT_FIND_CTL_USAGE = CERT_FIND_ENHKEY_USAGE -CERT_FIND_SUBJECT_CERT = (CERT_COMPARE_SUBJECT_CERT << CERT_COMPARE_SHIFT) -CERT_FIND_ISSUER_OF = (CERT_COMPARE_ISSUER_OF << CERT_COMPARE_SHIFT) -CERT_FIND_EXISTING = (CERT_COMPARE_EXISTING << CERT_COMPARE_SHIFT) -CERT_FIND_CERT_ID = (CERT_COMPARE_CERT_ID << CERT_COMPARE_SHIFT) -CERT_FIND_CROSS_CERT_DIST_POINTS = \ - (CERT_COMPARE_CROSS_CERT_DIST_POINTS << CERT_COMPARE_SHIFT) -CERT_FIND_PUBKEY_MD5_HASH = \ - (CERT_COMPARE_PUBKEY_MD5_HASH << CERT_COMPARE_SHIFT) -CERT_FIND_OPTIONAL_ENHKEY_USAGE_FLAG = 0x1 -CERT_FIND_EXT_ONLY_ENHKEY_USAGE_FLAG = 0x2 -CERT_FIND_PROP_ONLY_ENHKEY_USAGE_FLAG = 0x4 -CERT_FIND_NO_ENHKEY_USAGE_FLAG = 0x8 -CERT_FIND_OR_ENHKEY_USAGE_FLAG = 0x10 -CERT_FIND_VALID_ENHKEY_USAGE_FLAG = 0x20 -CERT_FIND_OPTIONAL_CTL_USAGE_FLAG = CERT_FIND_OPTIONAL_ENHKEY_USAGE_FLAG -CERT_FIND_EXT_ONLY_CTL_USAGE_FLAG = \ - CERT_FIND_EXT_ONLY_ENHKEY_USAGE_FLAG -CERT_FIND_PROP_ONLY_CTL_USAGE_FLAG = \ - CERT_FIND_PROP_ONLY_ENHKEY_USAGE_FLAG -CERT_FIND_NO_CTL_USAGE_FLAG = CERT_FIND_NO_ENHKEY_USAGE_FLAG -CERT_FIND_OR_CTL_USAGE_FLAG = CERT_FIND_OR_ENHKEY_USAGE_FLAG -CERT_FIND_VALID_CTL_USAGE_FLAG = CERT_FIND_VALID_ENHKEY_USAGE_FLAG -CERT_SET_PROPERTY_IGNORE_PERSIST_ERROR_FLAG = (-2147483648) -CERT_SET_PROPERTY_INHIBIT_PERSIST_FLAG = 0x40000000 -CTL_ENTRY_FROM_PROP_CHAIN_FLAG = 0x1 -CRL_FIND_ANY = 0 -CRL_FIND_ISSUED_BY = 1 -CRL_FIND_EXISTING = 2 -CRL_FIND_ISSUED_FOR = 3 -CRL_FIND_ISSUED_BY_AKI_FLAG = 0x1 -CRL_FIND_ISSUED_BY_SIGNATURE_FLAG = 0x2 -CRL_FIND_ISSUED_BY_DELTA_FLAG = 0x4 -CRL_FIND_ISSUED_BY_BASE_FLAG = 0x8 -CERT_STORE_ADD_NEW = 1 -CERT_STORE_ADD_USE_EXISTING = 2 -CERT_STORE_ADD_REPLACE_EXISTING = 3 -CERT_STORE_ADD_ALWAYS = 4 -CERT_STORE_ADD_REPLACE_EXISTING_INHERIT_PROPERTIES = 5 -CERT_STORE_ADD_NEWER = 6 -CERT_STORE_ADD_NEWER_INHERIT_PROPERTIES = 7 -CERT_STORE_CERTIFICATE_CONTEXT = 1 -CERT_STORE_CRL_CONTEXT = 2 -CERT_STORE_CTL_CONTEXT = 3 - -CERT_STORE_ALL_CONTEXT_FLAG = -1 -CERT_STORE_CERTIFICATE_CONTEXT_FLAG = \ - (1 << CERT_STORE_CERTIFICATE_CONTEXT) -CERT_STORE_CRL_CONTEXT_FLAG = \ - (1 << CERT_STORE_CRL_CONTEXT) -CERT_STORE_CTL_CONTEXT_FLAG = \ - (1 << CERT_STORE_CTL_CONTEXT) -CTL_ANY_SUBJECT_TYPE = 1 -CTL_CERT_SUBJECT_TYPE = 2 -CTL_FIND_ANY = 0 -CTL_FIND_SHA1_HASH = 1 -CTL_FIND_MD5_HASH = 2 -CTL_FIND_USAGE = 3 -CTL_FIND_SUBJECT = 4 -CTL_FIND_EXISTING = 5 -CTL_FIND_NO_LIST_ID_CBDATA = (-1) -CTL_FIND_SAME_USAGE_FLAG = 0x1 -CERT_STORE_CTRL_RESYNC = 1 -CERT_STORE_CTRL_NOTIFY_CHANGE = 2 -CERT_STORE_CTRL_COMMIT = 3 -CERT_STORE_CTRL_AUTO_RESYNC = 4 -CERT_STORE_CTRL_CANCEL_NOTIFY = 5 -CERT_STORE_CTRL_INHIBIT_DUPLICATE_HANDLE_FLAG = 0x1 -CERT_STORE_CTRL_COMMIT_FORCE_FLAG = 0x1 -CERT_STORE_CTRL_COMMIT_CLEAR_FLAG = 0x2 -CERT_STORE_LOCALIZED_NAME_PROP_ID = 0x1000 -CERT_CREATE_CONTEXT_NOCOPY_FLAG = 0x1 -CERT_CREATE_CONTEXT_SORTED_FLAG = 0x2 -CERT_CREATE_CONTEXT_NO_HCRYPTMSG_FLAG = 0x4 -CERT_CREATE_CONTEXT_NO_ENTRY_FLAG = 0x8 - -CERT_PHYSICAL_STORE_ADD_ENABLE_FLAG = 0x1 -CERT_PHYSICAL_STORE_OPEN_DISABLE_FLAG = 0x2 -CERT_PHYSICAL_STORE_REMOTE_OPEN_DISABLE_FLAG = 0x4 -CERT_PHYSICAL_STORE_INSERT_COMPUTER_NAME_ENABLE_FLAG = 0x8 -CERT_PHYSICAL_STORE_PREDEFINED_ENUM_FLAG = 0x1 - -# Names of physical cert stores -CERT_PHYSICAL_STORE_DEFAULT_NAME = ".Default" -CERT_PHYSICAL_STORE_GROUP_POLICY_NAME = ".GroupPolicy" -CERT_PHYSICAL_STORE_LOCAL_MACHINE_NAME = ".LocalMachine" -CERT_PHYSICAL_STORE_DS_USER_CERTIFICATE_NAME = ".UserCertificate" -CERT_PHYSICAL_STORE_LOCAL_MACHINE_GROUP_POLICY_NAME = ".LocalMachineGroupPolicy" -CERT_PHYSICAL_STORE_ENTERPRISE_NAME = ".Enterprise" -CERT_PHYSICAL_STORE_AUTH_ROOT_NAME = ".AuthRoot" -CERT_PHYSICAL_STORE_SMART_CARD_NAME = ".SmartCard" - -CRYPT_OID_OPEN_SYSTEM_STORE_PROV_FUNC = "CertDllOpenSystemStoreProv" -CRYPT_OID_REGISTER_SYSTEM_STORE_FUNC = "CertDllRegisterSystemStore" -CRYPT_OID_UNREGISTER_SYSTEM_STORE_FUNC = "CertDllUnregisterSystemStore" -CRYPT_OID_ENUM_SYSTEM_STORE_FUNC = "CertDllEnumSystemStore" -CRYPT_OID_REGISTER_PHYSICAL_STORE_FUNC = "CertDllRegisterPhysicalStore" -CRYPT_OID_UNREGISTER_PHYSICAL_STORE_FUNC = "CertDllUnregisterPhysicalStore" -CRYPT_OID_ENUM_PHYSICAL_STORE_FUNC = "CertDllEnumPhysicalStore" -CRYPT_OID_SYSTEM_STORE_LOCATION_VALUE_NAME = "SystemStoreLocation" - -CMSG_TRUSTED_SIGNER_FLAG = 0x1 -CMSG_SIGNER_ONLY_FLAG = 0x2 -CMSG_USE_SIGNER_INDEX_FLAG = 0x4 -CMSG_CMS_ENCAPSULATED_CTL_FLAG = 0x00008000 -CMSG_ENCODE_SORTED_CTL_FLAG = 0x1 -CMSG_ENCODE_HASHED_SUBJECT_IDENTIFIER_FLAG = 0x2 -CERT_VERIFY_INHIBIT_CTL_UPDATE_FLAG = 0x1 -CERT_VERIFY_TRUSTED_SIGNERS_FLAG = 0x2 -CERT_VERIFY_NO_TIME_CHECK_FLAG = 0x4 -CERT_VERIFY_ALLOW_MORE_USAGE_FLAG = 0x8 -CERT_VERIFY_UPDATED_CTL_FLAG = 0x1 -CERT_CONTEXT_REVOCATION_TYPE = 1 -CERT_VERIFY_REV_CHAIN_FLAG = 0x00000001 -CERT_VERIFY_CACHE_ONLY_BASED_REVOCATION = 0x00000002 -CERT_VERIFY_REV_ACCUMULATIVE_TIMEOUT_FLAG = 0x00000004 -CERT_UNICODE_IS_RDN_ATTRS_FLAG = 0x1 -CERT_CASE_INSENSITIVE_IS_RDN_ATTRS_FLAG = 0x2 -CRYPT_VERIFY_CERT_SIGN_SUBJECT_BLOB = 1 -CRYPT_VERIFY_CERT_SIGN_SUBJECT_CERT = 2 -CRYPT_VERIFY_CERT_SIGN_SUBJECT_CRL = 3 -CRYPT_VERIFY_CERT_SIGN_ISSUER_PUBKEY = 1 -CRYPT_VERIFY_CERT_SIGN_ISSUER_CERT = 2 -CRYPT_VERIFY_CERT_SIGN_ISSUER_CHAIN = 3 -CRYPT_VERIFY_CERT_SIGN_ISSUER_NULL = 4 -CRYPT_DEFAULT_CONTEXT_AUTO_RELEASE_FLAG = 0x00000001 -CRYPT_DEFAULT_CONTEXT_PROCESS_FLAG = 0x00000002 -CRYPT_DEFAULT_CONTEXT_CERT_SIGN_OID = 1 -CRYPT_DEFAULT_CONTEXT_MULTI_CERT_SIGN_OID = 2 -CRYPT_OID_EXPORT_PUBLIC_KEY_INFO_FUNC = "CryptDllExportPublicKeyInfoEx" -CRYPT_OID_IMPORT_PUBLIC_KEY_INFO_FUNC = "CryptDllImportPublicKeyInfoEx" -CRYPT_ACQUIRE_CACHE_FLAG = 0x00000001 -CRYPT_ACQUIRE_USE_PROV_INFO_FLAG = 0x00000002 -CRYPT_ACQUIRE_COMPARE_KEY_FLAG = 0x00000004 -CRYPT_ACQUIRE_SILENT_FLAG = 0x00000040 -CRYPT_FIND_USER_KEYSET_FLAG = 0x00000001 -CRYPT_FIND_MACHINE_KEYSET_FLAG = 0x00000002 -CRYPT_FIND_SILENT_KEYSET_FLAG = 0x00000040 -CRYPT_OID_IMPORT_PRIVATE_KEY_INFO_FUNC = "CryptDllImportPrivateKeyInfoEx" -CRYPT_OID_EXPORT_PRIVATE_KEY_INFO_FUNC = "CryptDllExportPrivateKeyInfoEx" -CRYPT_DELETE_KEYSET = CRYPT_DELETEKEYSET -CERT_SIMPLE_NAME_STR = 1 -CERT_OID_NAME_STR = 2 -CERT_X500_NAME_STR = 3 -CERT_NAME_STR_SEMICOLON_FLAG = 0x40000000 -CERT_NAME_STR_NO_PLUS_FLAG = 0x20000000 -CERT_NAME_STR_NO_QUOTING_FLAG = 0x10000000 -CERT_NAME_STR_CRLF_FLAG = 0x08000000 -CERT_NAME_STR_COMMA_FLAG = 0x04000000 -CERT_NAME_STR_REVERSE_FLAG = 0x02000000 -CERT_NAME_STR_DISABLE_IE4_UTF8_FLAG = 0x00010000 -CERT_NAME_STR_ENABLE_T61_UNICODE_FLAG = 0x00020000 -CERT_NAME_STR_ENABLE_UTF8_UNICODE_FLAG = 0x00040000 -CERT_NAME_EMAIL_TYPE = 1 -CERT_NAME_RDN_TYPE = 2 -CERT_NAME_ATTR_TYPE = 3 -CERT_NAME_SIMPLE_DISPLAY_TYPE = 4 -CERT_NAME_FRIENDLY_DISPLAY_TYPE = 5 -CERT_NAME_DNS_TYPE = 6 -CERT_NAME_URL_TYPE = 7 -CERT_NAME_UPN_TYPE = 8 -CERT_NAME_ISSUER_FLAG = 0x1 -CERT_NAME_DISABLE_IE4_UTF8_FLAG = 0x00010000 -CRYPT_MESSAGE_BARE_CONTENT_OUT_FLAG = 0x00000001 -CRYPT_MESSAGE_ENCAPSULATED_CONTENT_OUT_FLAG = 0x00000002 -CRYPT_MESSAGE_KEYID_SIGNER_FLAG = 0x00000004 -CRYPT_MESSAGE_SILENT_KEYSET_FLAG = 0x00000040 -CRYPT_MESSAGE_KEYID_RECIPIENT_FLAG = 0x4 -CERT_QUERY_OBJECT_FILE = 0x00000001 -CERT_QUERY_OBJECT_BLOB = 0x00000002 -CERT_QUERY_CONTENT_CERT = 1 -CERT_QUERY_CONTENT_CTL = 2 -CERT_QUERY_CONTENT_CRL = 3 -CERT_QUERY_CONTENT_SERIALIZED_STORE = 4 -CERT_QUERY_CONTENT_SERIALIZED_CERT = 5 -CERT_QUERY_CONTENT_SERIALIZED_CTL = 6 -CERT_QUERY_CONTENT_SERIALIZED_CRL = 7 -CERT_QUERY_CONTENT_PKCS7_SIGNED = 8 -CERT_QUERY_CONTENT_PKCS7_UNSIGNED = 9 -CERT_QUERY_CONTENT_PKCS7_SIGNED_EMBED = 10 -CERT_QUERY_CONTENT_PKCS10 = 11 -CERT_QUERY_CONTENT_PFX = 12 -CERT_QUERY_CONTENT_CERT_PAIR = 13 -CERT_QUERY_CONTENT_FLAG_CERT = \ - (1 << CERT_QUERY_CONTENT_CERT) -CERT_QUERY_CONTENT_FLAG_CTL = \ - (1 << CERT_QUERY_CONTENT_CTL) -CERT_QUERY_CONTENT_FLAG_CRL = \ - (1 << CERT_QUERY_CONTENT_CRL) -CERT_QUERY_CONTENT_FLAG_SERIALIZED_STORE = \ - (1 << CERT_QUERY_CONTENT_SERIALIZED_STORE) -CERT_QUERY_CONTENT_FLAG_SERIALIZED_CERT = \ - (1 << CERT_QUERY_CONTENT_SERIALIZED_CERT) -CERT_QUERY_CONTENT_FLAG_SERIALIZED_CTL = \ - (1 << CERT_QUERY_CONTENT_SERIALIZED_CTL) -CERT_QUERY_CONTENT_FLAG_SERIALIZED_CRL = \ - (1 << CERT_QUERY_CONTENT_SERIALIZED_CRL) -CERT_QUERY_CONTENT_FLAG_PKCS7_SIGNED = \ - (1 << CERT_QUERY_CONTENT_PKCS7_SIGNED) -CERT_QUERY_CONTENT_FLAG_PKCS7_UNSIGNED = \ - (1 << CERT_QUERY_CONTENT_PKCS7_UNSIGNED) -CERT_QUERY_CONTENT_FLAG_PKCS7_SIGNED_EMBED = \ - (1 << CERT_QUERY_CONTENT_PKCS7_SIGNED_EMBED) -CERT_QUERY_CONTENT_FLAG_PKCS10 = \ - (1 << CERT_QUERY_CONTENT_PKCS10) -CERT_QUERY_CONTENT_FLAG_PFX = \ - (1 << CERT_QUERY_CONTENT_PFX) -CERT_QUERY_CONTENT_FLAG_CERT_PAIR = \ - (1 << CERT_QUERY_CONTENT_CERT_PAIR) -CERT_QUERY_CONTENT_FLAG_ALL = \ - CERT_QUERY_CONTENT_FLAG_CERT | \ - CERT_QUERY_CONTENT_FLAG_CTL | \ - CERT_QUERY_CONTENT_FLAG_CRL | \ - CERT_QUERY_CONTENT_FLAG_SERIALIZED_STORE | \ - CERT_QUERY_CONTENT_FLAG_SERIALIZED_CERT | \ - CERT_QUERY_CONTENT_FLAG_SERIALIZED_CTL | \ - CERT_QUERY_CONTENT_FLAG_SERIALIZED_CRL | \ - CERT_QUERY_CONTENT_FLAG_PKCS7_SIGNED | \ - CERT_QUERY_CONTENT_FLAG_PKCS7_UNSIGNED | \ - CERT_QUERY_CONTENT_FLAG_PKCS7_SIGNED_EMBED | \ - CERT_QUERY_CONTENT_FLAG_PKCS10 | \ - CERT_QUERY_CONTENT_FLAG_PFX | \ - CERT_QUERY_CONTENT_FLAG_CERT_PAIR -CERT_QUERY_FORMAT_BINARY = 1 -CERT_QUERY_FORMAT_BASE64_ENCODED = 2 -CERT_QUERY_FORMAT_ASN_ASCII_HEX_ENCODED = 3 -CERT_QUERY_FORMAT_FLAG_BINARY = \ - (1 << CERT_QUERY_FORMAT_BINARY) -CERT_QUERY_FORMAT_FLAG_BASE64_ENCODED = \ - (1 << CERT_QUERY_FORMAT_BASE64_ENCODED) -CERT_QUERY_FORMAT_FLAG_ASN_ASCII_HEX_ENCODED = \ - (1 << CERT_QUERY_FORMAT_ASN_ASCII_HEX_ENCODED) -CERT_QUERY_FORMAT_FLAG_ALL = \ - CERT_QUERY_FORMAT_FLAG_BINARY | \ - CERT_QUERY_FORMAT_FLAG_BASE64_ENCODED | \ - CERT_QUERY_FORMAT_FLAG_ASN_ASCII_HEX_ENCODED - -CREDENTIAL_OID_PASSWORD_CREDENTIALS_A = 1 -CREDENTIAL_OID_PASSWORD_CREDENTIALS_W = 2 -CREDENTIAL_OID_PASSWORD_CREDENTIALS = CREDENTIAL_OID_PASSWORD_CREDENTIALS_W - -SCHEME_OID_RETRIEVE_ENCODED_OBJECT_FUNC = "SchemeDllRetrieveEncodedObject" -SCHEME_OID_RETRIEVE_ENCODED_OBJECTW_FUNC = "SchemeDllRetrieveEncodedObjectW" -CONTEXT_OID_CREATE_OBJECT_CONTEXT_FUNC = "ContextDllCreateObjectContext" -CONTEXT_OID_CERTIFICATE = 1 -CONTEXT_OID_CRL = 2 -CONTEXT_OID_CTL = 3 -CONTEXT_OID_PKCS7 = 4 -CONTEXT_OID_CAPI2_ANY = 5 -CONTEXT_OID_OCSP_RESP = 6 - -CRYPT_RETRIEVE_MULTIPLE_OBJECTS = 0x00000001 -CRYPT_CACHE_ONLY_RETRIEVAL = 0x00000002 -CRYPT_WIRE_ONLY_RETRIEVAL = 0x00000004 -CRYPT_DONT_CACHE_RESULT = 0x00000008 -CRYPT_ASYNC_RETRIEVAL = 0x00000010 -CRYPT_STICKY_CACHE_RETRIEVAL = 0x00001000 -CRYPT_LDAP_SCOPE_BASE_ONLY_RETRIEVAL = 0x00002000 -CRYPT_OFFLINE_CHECK_RETRIEVAL = 0x00004000 -CRYPT_LDAP_INSERT_ENTRY_ATTRIBUTE = 0x00008000 -CRYPT_LDAP_SIGN_RETRIEVAL = 0x00010000 -CRYPT_NO_AUTH_RETRIEVAL = 0x00020000 -CRYPT_LDAP_AREC_EXCLUSIVE_RETRIEVAL = 0x00040000 -CRYPT_AIA_RETRIEVAL = 0x00080000 -CRYPT_VERIFY_CONTEXT_SIGNATURE = 0x00000020 -CRYPT_VERIFY_DATA_HASH = 0x00000040 -CRYPT_KEEP_TIME_VALID = 0x00000080 -CRYPT_DONT_VERIFY_SIGNATURE = 0x00000100 -CRYPT_DONT_CHECK_TIME_VALIDITY = 0x00000200 -CRYPT_CHECK_FRESHNESS_TIME_VALIDITY = 0x00000400 -CRYPT_ACCUMULATIVE_TIMEOUT = 0x00000800 -CRYPT_PARAM_ASYNC_RETRIEVAL_COMPLETION = 1 -CRYPT_PARAM_CANCEL_ASYNC_RETRIEVAL = 2 -CRYPT_GET_URL_FROM_PROPERTY = 0x00000001 -CRYPT_GET_URL_FROM_EXTENSION = 0x00000002 -CRYPT_GET_URL_FROM_UNAUTH_ATTRIBUTE = 0x00000004 -CRYPT_GET_URL_FROM_AUTH_ATTRIBUTE = 0x00000008 -URL_OID_GET_OBJECT_URL_FUNC = "UrlDllGetObjectUrl" -TIME_VALID_OID_GET_OBJECT_FUNC = "TimeValidDllGetObject" -TIME_VALID_OID_FLUSH_OBJECT_FUNC = "TimeValidDllFlushObject" - -TIME_VALID_OID_GET_CTL = 1 -TIME_VALID_OID_GET_CRL = 2 -TIME_VALID_OID_GET_CRL_FROM_CERT = 3 -TIME_VALID_OID_GET_FRESHEST_CRL_FROM_CERT = 4 -TIME_VALID_OID_GET_FRESHEST_CRL_FROM_CRL = 5 - -TIME_VALID_OID_FLUSH_CTL = 1 -TIME_VALID_OID_FLUSH_CRL = 2 -TIME_VALID_OID_FLUSH_CRL_FROM_CERT = 3 -TIME_VALID_OID_FLUSH_FRESHEST_CRL_FROM_CERT = 4 -TIME_VALID_OID_FLUSH_FRESHEST_CRL_FROM_CRL = 5 - -CRYPTPROTECT_PROMPT_ON_UNPROTECT = 0x1 -CRYPTPROTECT_PROMPT_ON_PROTECT = 0x2 -CRYPTPROTECT_PROMPT_RESERVED = 0x04 -CRYPTPROTECT_PROMPT_STRONG = 0x08 -CRYPTPROTECT_PROMPT_REQUIRE_STRONG = 0x10 -CRYPTPROTECT_UI_FORBIDDEN = 0x1 -CRYPTPROTECT_LOCAL_MACHINE = 0x4 -CRYPTPROTECT_CRED_SYNC = 0x8 -CRYPTPROTECT_AUDIT = 0x10 -CRYPTPROTECT_NO_RECOVERY = 0x20 -CRYPTPROTECT_VERIFY_PROTECTION = 0x40 -CRYPTPROTECT_CRED_REGENERATE = 0x80 -CRYPTPROTECT_FIRST_RESERVED_FLAGVAL = 0x0FFFFFFF -CRYPTPROTECT_LAST_RESERVED_FLAGVAL = (-1) -CRYPTPROTECTMEMORY_BLOCK_SIZE = 16 -CRYPTPROTECTMEMORY_SAME_PROCESS = 0x00 -CRYPTPROTECTMEMORY_CROSS_PROCESS = 0x01 -CRYPTPROTECTMEMORY_SAME_LOGON = 0x02 -CERT_CREATE_SELFSIGN_NO_SIGN = 1 -CERT_CREATE_SELFSIGN_NO_KEY_INFO = 2 -CRYPT_KEYID_MACHINE_FLAG = 0x00000020 -CRYPT_KEYID_ALLOC_FLAG = 0x00008000 -CRYPT_KEYID_DELETE_FLAG = 0x00000010 -CRYPT_KEYID_SET_NEW_FLAG = 0x00002000 -CERT_CHAIN_MAX_AIA_URL_COUNT_IN_CERT_DEFAULT = 5 -CERT_CHAIN_MAX_AIA_URL_RETRIEVAL_COUNT_PER_CHAIN_DEFAULT = 10 -CERT_CHAIN_MAX_AIA_URL_RETRIEVAL_BYTE_COUNT_DEFAULT = 100000 -CERT_CHAIN_MAX_AIA_URL_RETRIEVAL_CERT_COUNT_DEFAULT = 10 -CERT_CHAIN_CACHE_END_CERT = 0x00000001 -CERT_CHAIN_THREAD_STORE_SYNC = 0x00000002 -CERT_CHAIN_CACHE_ONLY_URL_RETRIEVAL = 0x00000004 -CERT_CHAIN_USE_LOCAL_MACHINE_STORE = 0x00000008 -CERT_CHAIN_ENABLE_CACHE_AUTO_UPDATE = 0x00000010 -CERT_CHAIN_ENABLE_SHARE_STORE = 0x00000020 -CERT_TRUST_NO_ERROR = 0x00000000 -CERT_TRUST_IS_NOT_TIME_VALID = 0x00000001 -CERT_TRUST_IS_NOT_TIME_NESTED = 0x00000002 -CERT_TRUST_IS_REVOKED = 0x00000004 -CERT_TRUST_IS_NOT_SIGNATURE_VALID = 0x00000008 -CERT_TRUST_IS_NOT_VALID_FOR_USAGE = 0x00000010 -CERT_TRUST_IS_UNTRUSTED_ROOT = 0x00000020 -CERT_TRUST_REVOCATION_STATUS_UNKNOWN = 0x00000040 -CERT_TRUST_IS_CYCLIC = 0x00000080 -CERT_TRUST_INVALID_EXTENSION = 0x00000100 -CERT_TRUST_INVALID_POLICY_CONSTRAINTS = 0x00000200 -CERT_TRUST_INVALID_BASIC_CONSTRAINTS = 0x00000400 -CERT_TRUST_INVALID_NAME_CONSTRAINTS = 0x00000800 -CERT_TRUST_HAS_NOT_SUPPORTED_NAME_CONSTRAINT = 0x00001000 -CERT_TRUST_HAS_NOT_DEFINED_NAME_CONSTRAINT = 0x00002000 -CERT_TRUST_HAS_NOT_PERMITTED_NAME_CONSTRAINT = 0x00004000 -CERT_TRUST_HAS_EXCLUDED_NAME_CONSTRAINT = 0x00008000 -CERT_TRUST_IS_OFFLINE_REVOCATION = 0x01000000 -CERT_TRUST_NO_ISSUANCE_CHAIN_POLICY = 0x02000000 -CERT_TRUST_IS_PARTIAL_CHAIN = 0x00010000 -CERT_TRUST_CTL_IS_NOT_TIME_VALID = 0x00020000 -CERT_TRUST_CTL_IS_NOT_SIGNATURE_VALID = 0x00040000 -CERT_TRUST_CTL_IS_NOT_VALID_FOR_USAGE = 0x00080000 -CERT_TRUST_HAS_EXACT_MATCH_ISSUER = 0x00000001 -CERT_TRUST_HAS_KEY_MATCH_ISSUER = 0x00000002 -CERT_TRUST_HAS_NAME_MATCH_ISSUER = 0x00000004 -CERT_TRUST_IS_SELF_SIGNED = 0x00000008 -CERT_TRUST_HAS_PREFERRED_ISSUER = 0x00000100 -CERT_TRUST_HAS_ISSUANCE_CHAIN_POLICY = 0x00000200 -CERT_TRUST_HAS_VALID_NAME_CONSTRAINTS = 0x00000400 -CERT_TRUST_IS_COMPLEX_CHAIN = 0x00010000 -USAGE_MATCH_TYPE_AND = 0x00000000 -USAGE_MATCH_TYPE_OR = 0x00000001 -CERT_CHAIN_REVOCATION_CHECK_END_CERT = 0x10000000 -CERT_CHAIN_REVOCATION_CHECK_CHAIN = 0x20000000 -CERT_CHAIN_REVOCATION_CHECK_CHAIN_EXCLUDE_ROOT = 0x40000000 -CERT_CHAIN_REVOCATION_CHECK_CACHE_ONLY = (-2147483648) -CERT_CHAIN_REVOCATION_ACCUMULATIVE_TIMEOUT = 0x08000000 -CERT_CHAIN_DISABLE_PASS1_QUALITY_FILTERING = 0x00000040 -CERT_CHAIN_RETURN_LOWER_QUALITY_CONTEXTS = 0x00000080 -CERT_CHAIN_DISABLE_AUTH_ROOT_AUTO_UPDATE = 0x00000100 -CERT_CHAIN_TIMESTAMP_TIME = 0x00000200 -REVOCATION_OID_CRL_REVOCATION = 1 -CERT_CHAIN_FIND_BY_ISSUER = 1 -CERT_CHAIN_FIND_BY_ISSUER_COMPARE_KEY_FLAG = 0x0001 -CERT_CHAIN_FIND_BY_ISSUER_COMPLEX_CHAIN_FLAG = 0x0002 -CERT_CHAIN_FIND_BY_ISSUER_CACHE_ONLY_URL_FLAG = 0x0004 -CERT_CHAIN_FIND_BY_ISSUER_LOCAL_MACHINE_FLAG = 0x0008 -CERT_CHAIN_FIND_BY_ISSUER_NO_KEY_FLAG = 0x4000 -CERT_CHAIN_FIND_BY_ISSUER_CACHE_ONLY_FLAG = 0x8000 -CERT_CHAIN_POLICY_IGNORE_NOT_TIME_VALID_FLAG = 0x00000001 -CERT_CHAIN_POLICY_IGNORE_CTL_NOT_TIME_VALID_FLAG = 0x00000002 -CERT_CHAIN_POLICY_IGNORE_NOT_TIME_NESTED_FLAG = 0x00000004 -CERT_CHAIN_POLICY_IGNORE_INVALID_BASIC_CONSTRAINTS_FLAG = 0x00000008 -CERT_CHAIN_POLICY_IGNORE_ALL_NOT_TIME_VALID_FLAGS = ( - CERT_CHAIN_POLICY_IGNORE_NOT_TIME_VALID_FLAG - | CERT_CHAIN_POLICY_IGNORE_CTL_NOT_TIME_VALID_FLAG - | CERT_CHAIN_POLICY_IGNORE_NOT_TIME_NESTED_FLAG -) -CERT_CHAIN_POLICY_ALLOW_UNKNOWN_CA_FLAG = 0x00000010 -CERT_CHAIN_POLICY_IGNORE_WRONG_USAGE_FLAG = 0x00000020 -CERT_CHAIN_POLICY_IGNORE_INVALID_NAME_FLAG = 0x00000040 -CERT_CHAIN_POLICY_IGNORE_INVALID_POLICY_FLAG = 0x00000080 -CERT_CHAIN_POLICY_IGNORE_END_REV_UNKNOWN_FLAG = 0x00000100 -CERT_CHAIN_POLICY_IGNORE_CTL_SIGNER_REV_UNKNOWN_FLAG = 0x00000200 -CERT_CHAIN_POLICY_IGNORE_CA_REV_UNKNOWN_FLAG = 0x00000400 -CERT_CHAIN_POLICY_IGNORE_ROOT_REV_UNKNOWN_FLAG = 0x00000800 -CERT_CHAIN_POLICY_IGNORE_ALL_REV_UNKNOWN_FLAGS = ( - CERT_CHAIN_POLICY_IGNORE_END_REV_UNKNOWN_FLAG - | CERT_CHAIN_POLICY_IGNORE_CTL_SIGNER_REV_UNKNOWN_FLAG - | CERT_CHAIN_POLICY_IGNORE_CA_REV_UNKNOWN_FLAG - | CERT_CHAIN_POLICY_IGNORE_ROOT_REV_UNKNOWN_FLAG -) -CERT_CHAIN_POLICY_ALLOW_TESTROOT_FLAG = 0x00008000 -CERT_CHAIN_POLICY_TRUST_TESTROOT_FLAG = 0x00004000 -CRYPT_OID_VERIFY_CERTIFICATE_CHAIN_POLICY_FUNC = \ - "CertDllVerifyCertificateChainPolicy" -AUTHTYPE_CLIENT = 1 -AUTHTYPE_SERVER = 2 -BASIC_CONSTRAINTS_CERT_CHAIN_POLICY_CA_FLAG = (-2147483648) -BASIC_CONSTRAINTS_CERT_CHAIN_POLICY_END_ENTITY_FLAG = 0x40000000 -MICROSOFT_ROOT_CERT_CHAIN_POLICY_ENABLE_TEST_ROOT_FLAG = 0x00010000 -CRYPT_STRING_BASE64HEADER = 0x00000000 -CRYPT_STRING_BASE64 = 0x00000001 -CRYPT_STRING_BINARY = 0x00000002 -CRYPT_STRING_BASE64REQUESTHEADER = 0x00000003 -CRYPT_STRING_HEX = 0x00000004 -CRYPT_STRING_HEXASCII = 0x00000005 -CRYPT_STRING_BASE64_ANY = 0x00000006 -CRYPT_STRING_ANY = 0x00000007 -CRYPT_STRING_HEX_ANY = 0x00000008 -CRYPT_STRING_BASE64X509CRLHEADER = 0x00000009 -CRYPT_STRING_HEXADDR = 0x0000000a -CRYPT_STRING_HEXASCIIADDR = 0x0000000b -CRYPT_STRING_NOCR = (-2147483648) -CRYPT_USER_KEYSET = 0x00001000 -PKCS12_IMPORT_RESERVED_MASK = (-65536) -REPORT_NO_PRIVATE_KEY = 0x0001 -REPORT_NOT_ABLE_TO_EXPORT_PRIVATE_KEY = 0x0002 -EXPORT_PRIVATE_KEYS = 0x0004 -PKCS12_EXPORT_RESERVED_MASK = (-65536) - -# Certificate store provider types used with CertOpenStore -CERT_STORE_PROV_MSG = 1 -CERT_STORE_PROV_MEMORY = 2 -CERT_STORE_PROV_FILE = 3 -CERT_STORE_PROV_REG = 4 -CERT_STORE_PROV_PKCS7 = 5 -CERT_STORE_PROV_SERIALIZED = 6 -CERT_STORE_PROV_FILENAME = 8 -CERT_STORE_PROV_SYSTEM = 10 -CERT_STORE_PROV_COLLECTION = 11 -CERT_STORE_PROV_SYSTEM_REGISTRY = 13 -CERT_STORE_PROV_PHYSICAL = 14 -CERT_STORE_PROV_SMART_CARD = 15 -CERT_STORE_PROV_LDAP = 16 - -URL_OID_CERTIFICATE_ISSUER = 1 -URL_OID_CERTIFICATE_CRL_DIST_POINT = 2 -URL_OID_CTL_ISSUER = 3 -URL_OID_CTL_NEXT_UPDATE = 4 -URL_OID_CRL_ISSUER = 5 -URL_OID_CERTIFICATE_FRESHEST_CRL = 6 -URL_OID_CRL_FRESHEST_CRL = 7 -URL_OID_CROSS_CERT_DIST_POINT = 8 -URL_OID_CERTIFICATE_OCSP = 9 -URL_OID_CERTIFICATE_OCSP_AND_CRL_DIST_POINT = 10 -URL_OID_CERTIFICATE_CRL_DIST_POINT_AND_OCSP = 11 -URL_OID_CROSS_CERT_SUBJECT_INFO_ACCESS = 12 -URL_OID_CERTIFICATE_ONLY_OCSP = 13 diff --git a/typings/win32helper/win32inetcon.pyi b/typings/win32helper/win32inetcon.pyi deleted file mode 100644 index 1f505c22..00000000 --- a/typings/win32helper/win32inetcon.pyi +++ /dev/null @@ -1,1107 +0,0 @@ -# Generated by h2py from \mssdk\include\WinInet.h - -INTERNET_INVALID_PORT_NUMBER = 0 -INTERNET_DEFAULT_FTP_PORT = 21 -INTERNET_DEFAULT_GOPHER_PORT = 70 -INTERNET_DEFAULT_HTTP_PORT = 80 -INTERNET_DEFAULT_HTTPS_PORT = 443 -INTERNET_DEFAULT_SOCKS_PORT = 1080 -INTERNET_MAX_HOST_NAME_LENGTH = 256 -INTERNET_MAX_USER_NAME_LENGTH = 128 -INTERNET_MAX_PASSWORD_LENGTH = 128 -INTERNET_MAX_PORT_NUMBER_LENGTH = 5 -INTERNET_MAX_PORT_NUMBER_VALUE = 65535 -INTERNET_MAX_PATH_LENGTH = 2048 -INTERNET_MAX_SCHEME_LENGTH = 32 -INTERNET_KEEP_ALIVE_ENABLED = 1 -INTERNET_KEEP_ALIVE_DISABLED = 0 -INTERNET_REQFLAG_FROM_CACHE = 0x00000001 -INTERNET_REQFLAG_ASYNC = 0x00000002 -INTERNET_REQFLAG_VIA_PROXY = 0x00000004 -INTERNET_REQFLAG_NO_HEADERS = 0x00000008 -INTERNET_REQFLAG_PASSIVE = 0x00000010 -INTERNET_REQFLAG_CACHE_WRITE_DISABLED = 0x00000040 -INTERNET_REQFLAG_NET_TIMEOUT = 0x00000080 -INTERNET_FLAG_RELOAD = (-2147483648) -INTERNET_FLAG_RAW_DATA = 0x40000000 -INTERNET_FLAG_EXISTING_CONNECT = 0x20000000 -INTERNET_FLAG_ASYNC = 0x10000000 -INTERNET_FLAG_PASSIVE = 0x08000000 -INTERNET_FLAG_NO_CACHE_WRITE = 0x04000000 -INTERNET_FLAG_DONT_CACHE = INTERNET_FLAG_NO_CACHE_WRITE -INTERNET_FLAG_MAKE_PERSISTENT = 0x02000000 -INTERNET_FLAG_FROM_CACHE = 0x01000000 -INTERNET_FLAG_OFFLINE = INTERNET_FLAG_FROM_CACHE -INTERNET_FLAG_SECURE = 0x00800000 -INTERNET_FLAG_KEEP_CONNECTION = 0x00400000 -INTERNET_FLAG_NO_AUTO_REDIRECT = 0x00200000 -INTERNET_FLAG_READ_PREFETCH = 0x00100000 -INTERNET_FLAG_NO_COOKIES = 0x00080000 -INTERNET_FLAG_NO_AUTH = 0x00040000 -INTERNET_FLAG_RESTRICTED_ZONE = 0x00020000 -INTERNET_FLAG_CACHE_IF_NET_FAIL = 0x00010000 -INTERNET_FLAG_IGNORE_REDIRECT_TO_HTTP = 0x00008000 -INTERNET_FLAG_IGNORE_REDIRECT_TO_HTTPS = 0x00004000 -INTERNET_FLAG_IGNORE_CERT_DATE_INVALID = 0x00002000 -INTERNET_FLAG_IGNORE_CERT_CN_INVALID = 0x00001000 -INTERNET_FLAG_RESYNCHRONIZE = 0x00000800 -INTERNET_FLAG_HYPERLINK = 0x00000400 -INTERNET_FLAG_NO_UI = 0x00000200 -INTERNET_FLAG_PRAGMA_NOCACHE = 0x00000100 -INTERNET_FLAG_CACHE_ASYNC = 0x00000080 -INTERNET_FLAG_FORMS_SUBMIT = 0x00000040 -INTERNET_FLAG_FWD_BACK = 0x00000020 -INTERNET_FLAG_NEED_FILE = 0x00000010 -INTERNET_FLAG_MUST_CACHE_REQUEST = INTERNET_FLAG_NEED_FILE -SECURITY_INTERNET_MASK = (INTERNET_FLAG_IGNORE_CERT_CN_INVALID - | INTERNET_FLAG_IGNORE_CERT_DATE_INVALID - | INTERNET_FLAG_IGNORE_REDIRECT_TO_HTTPS - | INTERNET_FLAG_IGNORE_REDIRECT_TO_HTTP) -INTERNET_ERROR_MASK_INSERT_CDROM = 0x1 -INTERNET_ERROR_MASK_COMBINED_SEC_CERT = 0x2 -INTERNET_ERROR_MASK_NEED_MSN_SSPI_PKG = 0X4 -INTERNET_ERROR_MASK_LOGIN_FAILURE_DISPLAY_ENTITY_BODY = 0x8 -WININET_API_FLAG_ASYNC = 0x00000001 -WININET_API_FLAG_SYNC = 0x00000004 -WININET_API_FLAG_USE_CONTEXT = 0x00000008 -INTERNET_NO_CALLBACK = 0 -IDSI_FLAG_KEEP_ALIVE = 0x00000001 -IDSI_FLAG_SECURE = 0x00000002 -IDSI_FLAG_PROXY = 0x00000004 -IDSI_FLAG_TUNNEL = 0x00000008 -INTERNET_PER_CONN_FLAGS = 1 -INTERNET_PER_CONN_PROXY_SERVER = 2 -INTERNET_PER_CONN_PROXY_BYPASS = 3 -INTERNET_PER_CONN_AUTOCONFIG_URL = 4 -INTERNET_PER_CONN_AUTODISCOVERY_FLAGS = 5 -INTERNET_PER_CONN_AUTOCONFIG_SECONDARY_URL = 6 -INTERNET_PER_CONN_AUTOCONFIG_RELOAD_DELAY_MINS = 7 -INTERNET_PER_CONN_AUTOCONFIG_LAST_DETECT_TIME = 8 -INTERNET_PER_CONN_AUTOCONFIG_LAST_DETECT_URL = 9 -PROXY_TYPE_DIRECT = 0x00000001 -PROXY_TYPE_PROXY = 0x00000002 -PROXY_TYPE_AUTO_PROXY_URL = 0x00000004 -PROXY_TYPE_AUTO_DETECT = 0x00000008 -AUTO_PROXY_FLAG_USER_SET = 0x00000001 -AUTO_PROXY_FLAG_ALWAYS_DETECT = 0x00000002 -AUTO_PROXY_FLAG_DETECTION_RUN = 0x00000004 -AUTO_PROXY_FLAG_MIGRATED = 0x00000008 -AUTO_PROXY_FLAG_DONT_CACHE_PROXY_RESULT = 0x00000010 -AUTO_PROXY_FLAG_CACHE_INIT_RUN = 0x00000020 -AUTO_PROXY_FLAG_DETECTION_SUSPECT = 0x00000040 -ISO_FORCE_DISCONNECTED = 0x00000001 -INTERNET_RFC1123_FORMAT = 0 -INTERNET_RFC1123_BUFSIZE = 30 -ICU_ESCAPE = (-2147483648) -ICU_USERNAME = 0x40000000 -ICU_NO_ENCODE = 0x20000000 -ICU_DECODE = 0x10000000 -ICU_NO_META = 0x08000000 -ICU_ENCODE_SPACES_ONLY = 0x04000000 -ICU_BROWSER_MODE = 0x02000000 -ICU_ENCODE_PERCENT = 0x00001000 -INTERNET_OPEN_TYPE_PRECONFIG = 0 -INTERNET_OPEN_TYPE_DIRECT = 1 -INTERNET_OPEN_TYPE_PROXY = 3 -INTERNET_OPEN_TYPE_PRECONFIG_WITH_NO_AUTOPROXY = 4 -PRE_CONFIG_INTERNET_ACCESS = INTERNET_OPEN_TYPE_PRECONFIG -LOCAL_INTERNET_ACCESS = INTERNET_OPEN_TYPE_DIRECT -CERN_PROXY_INTERNET_ACCESS = INTERNET_OPEN_TYPE_PROXY -INTERNET_SERVICE_FTP = 1 -INTERNET_SERVICE_GOPHER = 2 -INTERNET_SERVICE_HTTP = 3 -IRF_ASYNC = WININET_API_FLAG_ASYNC -IRF_SYNC = WININET_API_FLAG_SYNC -IRF_USE_CONTEXT = WININET_API_FLAG_USE_CONTEXT -IRF_NO_WAIT = 0x00000008 -ISO_GLOBAL = 0x00000001 -ISO_REGISTRY = 0x00000002 -ISO_VALID_FLAGS = (ISO_GLOBAL | ISO_REGISTRY) -INTERNET_OPTION_CALLBACK = 1 -INTERNET_OPTION_CONNECT_TIMEOUT = 2 -INTERNET_OPTION_CONNECT_RETRIES = 3 -INTERNET_OPTION_CONNECT_BACKOFF = 4 -INTERNET_OPTION_SEND_TIMEOUT = 5 -INTERNET_OPTION_CONTROL_SEND_TIMEOUT = INTERNET_OPTION_SEND_TIMEOUT -INTERNET_OPTION_RECEIVE_TIMEOUT = 6 -INTERNET_OPTION_CONTROL_RECEIVE_TIMEOUT = INTERNET_OPTION_RECEIVE_TIMEOUT -INTERNET_OPTION_DATA_SEND_TIMEOUT = 7 -INTERNET_OPTION_DATA_RECEIVE_TIMEOUT = 8 -INTERNET_OPTION_HANDLE_TYPE = 9 -INTERNET_OPTION_LISTEN_TIMEOUT = 11 -INTERNET_OPTION_READ_BUFFER_SIZE = 12 -INTERNET_OPTION_WRITE_BUFFER_SIZE = 13 -INTERNET_OPTION_ASYNC_ID = 15 -INTERNET_OPTION_ASYNC_PRIORITY = 16 -INTERNET_OPTION_PARENT_HANDLE = 21 -INTERNET_OPTION_KEEP_CONNECTION = 22 -INTERNET_OPTION_REQUEST_FLAGS = 23 -INTERNET_OPTION_EXTENDED_ERROR = 24 -INTERNET_OPTION_OFFLINE_MODE = 26 -INTERNET_OPTION_CACHE_STREAM_HANDLE = 27 -INTERNET_OPTION_USERNAME = 28 -INTERNET_OPTION_PASSWORD = 29 -INTERNET_OPTION_ASYNC = 30 -INTERNET_OPTION_SECURITY_FLAGS = 31 -INTERNET_OPTION_SECURITY_CERTIFICATE_STRUCT = 32 -INTERNET_OPTION_DATAFILE_NAME = 33 -INTERNET_OPTION_URL = 34 -INTERNET_OPTION_SECURITY_CERTIFICATE = 35 -INTERNET_OPTION_SECURITY_KEY_BITNESS = 36 -INTERNET_OPTION_REFRESH = 37 -INTERNET_OPTION_PROXY = 38 -INTERNET_OPTION_SETTINGS_CHANGED = 39 -INTERNET_OPTION_VERSION = 40 -INTERNET_OPTION_USER_AGENT = 41 -INTERNET_OPTION_END_BROWSER_SESSION = 42 -INTERNET_OPTION_PROXY_USERNAME = 43 -INTERNET_OPTION_PROXY_PASSWORD = 44 -INTERNET_OPTION_CONTEXT_VALUE = 45 -INTERNET_OPTION_CONNECT_LIMIT = 46 -INTERNET_OPTION_SECURITY_SELECT_CLIENT_CERT = 47 -INTERNET_OPTION_POLICY = 48 -INTERNET_OPTION_DISCONNECTED_TIMEOUT = 49 -INTERNET_OPTION_CONNECTED_STATE = 50 -INTERNET_OPTION_IDLE_STATE = 51 -INTERNET_OPTION_OFFLINE_SEMANTICS = 52 -INTERNET_OPTION_SECONDARY_CACHE_KEY = 53 -INTERNET_OPTION_CALLBACK_FILTER = 54 -INTERNET_OPTION_CONNECT_TIME = 55 -INTERNET_OPTION_SEND_THROUGHPUT = 56 -INTERNET_OPTION_RECEIVE_THROUGHPUT = 57 -INTERNET_OPTION_REQUEST_PRIORITY = 58 -INTERNET_OPTION_HTTP_VERSION = 59 -INTERNET_OPTION_RESET_URLCACHE_SESSION = 60 -INTERNET_OPTION_ERROR_MASK = 62 -INTERNET_OPTION_FROM_CACHE_TIMEOUT = 63 -INTERNET_OPTION_BYPASS_EDITED_ENTRY = 64 -INTERNET_OPTION_DIAGNOSTIC_SOCKET_INFO = 67 -INTERNET_OPTION_CODEPAGE = 68 -INTERNET_OPTION_CACHE_TIMESTAMPS = 69 -INTERNET_OPTION_DISABLE_AUTODIAL = 70 -INTERNET_OPTION_MAX_CONNS_PER_SERVER = 73 -INTERNET_OPTION_MAX_CONNS_PER_1_0_SERVER = 74 -INTERNET_OPTION_PER_CONNECTION_OPTION = 75 -INTERNET_OPTION_DIGEST_AUTH_UNLOAD = 76 -INTERNET_OPTION_IGNORE_OFFLINE = 77 -INTERNET_OPTION_IDENTITY = 78 -INTERNET_OPTION_REMOVE_IDENTITY = 79 -INTERNET_OPTION_ALTER_IDENTITY = 80 -INTERNET_OPTION_SUPPRESS_BEHAVIOR = 81 -INTERNET_OPTION_AUTODIAL_MODE = 82 -INTERNET_OPTION_AUTODIAL_CONNECTION = 83 -INTERNET_OPTION_CLIENT_CERT_CONTEXT = 84 -INTERNET_OPTION_AUTH_FLAGS = 85 -INTERNET_OPTION_COOKIES_3RD_PARTY = 86 -INTERNET_OPTION_DISABLE_PASSPORT_AUTH = 87 -INTERNET_OPTION_SEND_UTF8_SERVERNAME_TO_PROXY = 88 -INTERNET_OPTION_EXEMPT_CONNECTION_LIMIT = 89 -INTERNET_OPTION_ENABLE_PASSPORT_AUTH = 90 -INTERNET_OPTION_HIBERNATE_INACTIVE_WORKER_THREADS = 91 -INTERNET_OPTION_ACTIVATE_WORKER_THREADS = 92 -INTERNET_OPTION_RESTORE_WORKER_THREAD_DEFAULTS = 93 -INTERNET_OPTION_SOCKET_SEND_BUFFER_LENGTH = 94 -INTERNET_OPTION_PROXY_SETTINGS_CHANGED = 95 -INTERNET_FIRST_OPTION = INTERNET_OPTION_CALLBACK -INTERNET_LAST_OPTION = INTERNET_OPTION_PROXY_SETTINGS_CHANGED -INTERNET_PRIORITY_FOREGROUND = 1000 -INTERNET_HANDLE_TYPE_INTERNET = 1 -INTERNET_HANDLE_TYPE_CONNECT_FTP = 2 -INTERNET_HANDLE_TYPE_CONNECT_GOPHER = 3 -INTERNET_HANDLE_TYPE_CONNECT_HTTP = 4 -INTERNET_HANDLE_TYPE_FTP_FIND = 5 -INTERNET_HANDLE_TYPE_FTP_FIND_HTML = 6 -INTERNET_HANDLE_TYPE_FTP_FILE = 7 -INTERNET_HANDLE_TYPE_FTP_FILE_HTML = 8 -INTERNET_HANDLE_TYPE_GOPHER_FIND = 9 -INTERNET_HANDLE_TYPE_GOPHER_FIND_HTML = 10 -INTERNET_HANDLE_TYPE_GOPHER_FILE = 11 -INTERNET_HANDLE_TYPE_GOPHER_FILE_HTML = 12 -INTERNET_HANDLE_TYPE_HTTP_REQUEST = 13 -INTERNET_HANDLE_TYPE_FILE_REQUEST = 14 -AUTH_FLAG_DISABLE_NEGOTIATE = 0x00000001 -AUTH_FLAG_ENABLE_NEGOTIATE = 0x00000002 -SECURITY_FLAG_SECURE = 0x00000001 -SECURITY_FLAG_STRENGTH_WEAK = 0x10000000 -SECURITY_FLAG_STRENGTH_MEDIUM = 0x40000000 -SECURITY_FLAG_STRENGTH_STRONG = 0x20000000 -SECURITY_FLAG_UNKNOWNBIT = (-2147483648) -SECURITY_FLAG_FORTEZZA = 0x08000000 -SECURITY_FLAG_NORMALBITNESS = SECURITY_FLAG_STRENGTH_WEAK -SECURITY_FLAG_SSL = 0x00000002 -SECURITY_FLAG_SSL3 = 0x00000004 -SECURITY_FLAG_PCT = 0x00000008 -SECURITY_FLAG_PCT4 = 0x00000010 -SECURITY_FLAG_IETFSSL4 = 0x00000020 -SECURITY_FLAG_40BIT = SECURITY_FLAG_STRENGTH_WEAK -SECURITY_FLAG_128BIT = SECURITY_FLAG_STRENGTH_STRONG -SECURITY_FLAG_56BIT = SECURITY_FLAG_STRENGTH_MEDIUM -SECURITY_FLAG_IGNORE_REVOCATION = 0x00000080 -SECURITY_FLAG_IGNORE_UNKNOWN_CA = 0x00000100 -SECURITY_FLAG_IGNORE_WRONG_USAGE = 0x00000200 -SECURITY_FLAG_IGNORE_CERT_CN_INVALID = INTERNET_FLAG_IGNORE_CERT_CN_INVALID -SECURITY_FLAG_IGNORE_CERT_DATE_INVALID = INTERNET_FLAG_IGNORE_CERT_DATE_INVALID -SECURITY_FLAG_IGNORE_REDIRECT_TO_HTTPS = INTERNET_FLAG_IGNORE_REDIRECT_TO_HTTPS -SECURITY_FLAG_IGNORE_REDIRECT_TO_HTTP = INTERNET_FLAG_IGNORE_REDIRECT_TO_HTTP -SECURITY_SET_MASK = (SECURITY_FLAG_IGNORE_REVOCATION - | SECURITY_FLAG_IGNORE_UNKNOWN_CA - | SECURITY_FLAG_IGNORE_CERT_CN_INVALID - | SECURITY_FLAG_IGNORE_CERT_DATE_INVALID - | SECURITY_FLAG_IGNORE_WRONG_USAGE) -AUTODIAL_MODE_NEVER = 1 -AUTODIAL_MODE_ALWAYS = 2 -AUTODIAL_MODE_NO_NETWORK_PRESENT = 4 -INTERNET_STATUS_RESOLVING_NAME = 10 -INTERNET_STATUS_NAME_RESOLVED = 11 -INTERNET_STATUS_CONNECTING_TO_SERVER = 20 -INTERNET_STATUS_CONNECTED_TO_SERVER = 21 -INTERNET_STATUS_SENDING_REQUEST = 30 -INTERNET_STATUS_REQUEST_SENT = 31 -INTERNET_STATUS_RECEIVING_RESPONSE = 40 -INTERNET_STATUS_RESPONSE_RECEIVED = 41 -INTERNET_STATUS_CTL_RESPONSE_RECEIVED = 42 -INTERNET_STATUS_PREFETCH = 43 -INTERNET_STATUS_CLOSING_CONNECTION = 50 -INTERNET_STATUS_CONNECTION_CLOSED = 51 -INTERNET_STATUS_HANDLE_CREATED = 60 -INTERNET_STATUS_HANDLE_CLOSING = 70 -INTERNET_STATUS_DETECTING_PROXY = 80 -INTERNET_STATUS_REQUEST_COMPLETE = 100 -INTERNET_STATUS_REDIRECT = 110 -INTERNET_STATUS_INTERMEDIATE_RESPONSE = 120 -INTERNET_STATUS_USER_INPUT_REQUIRED = 140 -INTERNET_STATUS_STATE_CHANGE = 200 -INTERNET_STATUS_COOKIE_SENT = 320 -INTERNET_STATUS_COOKIE_RECEIVED = 321 -INTERNET_STATUS_PRIVACY_IMPACTED = 324 -INTERNET_STATUS_P3P_HEADER = 325 -INTERNET_STATUS_P3P_POLICYREF = 326 -INTERNET_STATUS_COOKIE_HISTORY = 327 -INTERNET_STATE_CONNECTED = 0x00000001 -INTERNET_STATE_DISCONNECTED = 0x00000002 -INTERNET_STATE_DISCONNECTED_BY_USER = 0x00000010 -INTERNET_STATE_IDLE = 0x00000100 -INTERNET_STATE_BUSY = 0x00000200 -FTP_TRANSFER_TYPE_UNKNOWN = 0x00000000 -FTP_TRANSFER_TYPE_ASCII = 0x00000001 -FTP_TRANSFER_TYPE_BINARY = 0x00000002 -FTP_TRANSFER_TYPE_MASK = (FTP_TRANSFER_TYPE_ASCII | FTP_TRANSFER_TYPE_BINARY) -MAX_GOPHER_DISPLAY_TEXT = 128 -MAX_GOPHER_SELECTOR_TEXT = 256 -MAX_GOPHER_HOST_NAME = INTERNET_MAX_HOST_NAME_LENGTH -MAX_GOPHER_LOCATOR_LENGTH = (1 - + MAX_GOPHER_DISPLAY_TEXT - + 1 - + MAX_GOPHER_SELECTOR_TEXT - + 1 - + MAX_GOPHER_HOST_NAME - + 1 - + INTERNET_MAX_PORT_NUMBER_LENGTH - + 1 - + 1 - + 2 - ) -GOPHER_TYPE_TEXT_FILE = 0x00000001 -GOPHER_TYPE_DIRECTORY = 0x00000002 -GOPHER_TYPE_CSO = 0x00000004 -GOPHER_TYPE_ERROR = 0x00000008 -GOPHER_TYPE_MAC_BINHEX = 0x00000010 -GOPHER_TYPE_DOS_ARCHIVE = 0x00000020 -GOPHER_TYPE_UNIX_UUENCODED = 0x00000040 -GOPHER_TYPE_INDEX_SERVER = 0x00000080 -GOPHER_TYPE_TELNET = 0x00000100 -GOPHER_TYPE_BINARY = 0x00000200 -GOPHER_TYPE_REDUNDANT = 0x00000400 -GOPHER_TYPE_TN3270 = 0x00000800 -GOPHER_TYPE_GIF = 0x00001000 -GOPHER_TYPE_IMAGE = 0x00002000 -GOPHER_TYPE_BITMAP = 0x00004000 -GOPHER_TYPE_MOVIE = 0x00008000 -GOPHER_TYPE_SOUND = 0x00010000 -GOPHER_TYPE_HTML = 0x00020000 -GOPHER_TYPE_PDF = 0x00040000 -GOPHER_TYPE_CALENDAR = 0x00080000 -GOPHER_TYPE_INLINE = 0x00100000 -GOPHER_TYPE_UNKNOWN = 0x20000000 -GOPHER_TYPE_ASK = 0x40000000 -GOPHER_TYPE_GOPHER_PLUS = (-2147483648) -GOPHER_TYPE_FILE_MASK = (GOPHER_TYPE_TEXT_FILE - | GOPHER_TYPE_MAC_BINHEX - | GOPHER_TYPE_DOS_ARCHIVE - | GOPHER_TYPE_UNIX_UUENCODED - | GOPHER_TYPE_BINARY - | GOPHER_TYPE_GIF - | GOPHER_TYPE_IMAGE - | GOPHER_TYPE_BITMAP - | GOPHER_TYPE_MOVIE - | GOPHER_TYPE_SOUND - | GOPHER_TYPE_HTML - | GOPHER_TYPE_PDF - | GOPHER_TYPE_CALENDAR - | GOPHER_TYPE_INLINE - ) -MAX_GOPHER_CATEGORY_NAME = 128 -MAX_GOPHER_ATTRIBUTE_NAME = 128 -MIN_GOPHER_ATTRIBUTE_LENGTH = 256 -GOPHER_ATTRIBUTE_ID_BASE = (-1412641792) -GOPHER_CATEGORY_ID_ALL = (GOPHER_ATTRIBUTE_ID_BASE + 1) -GOPHER_CATEGORY_ID_INFO = (GOPHER_ATTRIBUTE_ID_BASE + 2) -GOPHER_CATEGORY_ID_ADMIN = (GOPHER_ATTRIBUTE_ID_BASE + 3) -GOPHER_CATEGORY_ID_VIEWS = (GOPHER_ATTRIBUTE_ID_BASE + 4) -GOPHER_CATEGORY_ID_ABSTRACT = (GOPHER_ATTRIBUTE_ID_BASE + 5) -GOPHER_CATEGORY_ID_VERONICA = (GOPHER_ATTRIBUTE_ID_BASE + 6) -GOPHER_CATEGORY_ID_ASK = (GOPHER_ATTRIBUTE_ID_BASE + 7) -GOPHER_CATEGORY_ID_UNKNOWN = (GOPHER_ATTRIBUTE_ID_BASE + 8) -GOPHER_ATTRIBUTE_ID_ALL = (GOPHER_ATTRIBUTE_ID_BASE + 9) -GOPHER_ATTRIBUTE_ID_ADMIN = (GOPHER_ATTRIBUTE_ID_BASE + 10) -GOPHER_ATTRIBUTE_ID_MOD_DATE = (GOPHER_ATTRIBUTE_ID_BASE + 11) -GOPHER_ATTRIBUTE_ID_TTL = (GOPHER_ATTRIBUTE_ID_BASE + 12) -GOPHER_ATTRIBUTE_ID_SCORE = (GOPHER_ATTRIBUTE_ID_BASE + 13) -GOPHER_ATTRIBUTE_ID_RANGE = (GOPHER_ATTRIBUTE_ID_BASE + 14) -GOPHER_ATTRIBUTE_ID_SITE = (GOPHER_ATTRIBUTE_ID_BASE + 15) -GOPHER_ATTRIBUTE_ID_ORG = (GOPHER_ATTRIBUTE_ID_BASE + 16) -GOPHER_ATTRIBUTE_ID_LOCATION = (GOPHER_ATTRIBUTE_ID_BASE + 17) -GOPHER_ATTRIBUTE_ID_GEOG = (GOPHER_ATTRIBUTE_ID_BASE + 18) -GOPHER_ATTRIBUTE_ID_TIMEZONE = (GOPHER_ATTRIBUTE_ID_BASE + 19) -GOPHER_ATTRIBUTE_ID_PROVIDER = (GOPHER_ATTRIBUTE_ID_BASE + 20) -GOPHER_ATTRIBUTE_ID_VERSION = (GOPHER_ATTRIBUTE_ID_BASE + 21) -GOPHER_ATTRIBUTE_ID_ABSTRACT = (GOPHER_ATTRIBUTE_ID_BASE + 22) -GOPHER_ATTRIBUTE_ID_VIEW = (GOPHER_ATTRIBUTE_ID_BASE + 23) -GOPHER_ATTRIBUTE_ID_TREEWALK = (GOPHER_ATTRIBUTE_ID_BASE + 24) -GOPHER_ATTRIBUTE_ID_UNKNOWN = (GOPHER_ATTRIBUTE_ID_BASE + 25) -HTTP_MAJOR_VERSION = 1 -HTTP_MINOR_VERSION = 0 -HTTP_VERSIONA = "HTTP/1.0" -HTTP_VERSION = HTTP_VERSIONA -HTTP_QUERY_MIME_VERSION = 0 -HTTP_QUERY_CONTENT_TYPE = 1 -HTTP_QUERY_CONTENT_TRANSFER_ENCODING = 2 -HTTP_QUERY_CONTENT_ID = 3 -HTTP_QUERY_CONTENT_DESCRIPTION = 4 -HTTP_QUERY_CONTENT_LENGTH = 5 -HTTP_QUERY_CONTENT_LANGUAGE = 6 -HTTP_QUERY_ALLOW = 7 -HTTP_QUERY_PUBLIC = 8 -HTTP_QUERY_DATE = 9 -HTTP_QUERY_EXPIRES = 10 -HTTP_QUERY_LAST_MODIFIED = 11 -HTTP_QUERY_MESSAGE_ID = 12 -HTTP_QUERY_URI = 13 -HTTP_QUERY_DERIVED_FROM = 14 -HTTP_QUERY_COST = 15 -HTTP_QUERY_LINK = 16 -HTTP_QUERY_PRAGMA = 17 -HTTP_QUERY_VERSION = 18 -HTTP_QUERY_STATUS_CODE = 19 -HTTP_QUERY_STATUS_TEXT = 20 -HTTP_QUERY_RAW_HEADERS = 21 -HTTP_QUERY_RAW_HEADERS_CRLF = 22 -HTTP_QUERY_CONNECTION = 23 -HTTP_QUERY_ACCEPT = 24 -HTTP_QUERY_ACCEPT_CHARSET = 25 -HTTP_QUERY_ACCEPT_ENCODING = 26 -HTTP_QUERY_ACCEPT_LANGUAGE = 27 -HTTP_QUERY_AUTHORIZATION = 28 -HTTP_QUERY_CONTENT_ENCODING = 29 -HTTP_QUERY_FORWARDED = 30 -HTTP_QUERY_FROM = 31 -HTTP_QUERY_IF_MODIFIED_SINCE = 32 -HTTP_QUERY_LOCATION = 33 -HTTP_QUERY_ORIG_URI = 34 -HTTP_QUERY_REFERER = 35 -HTTP_QUERY_RETRY_AFTER = 36 -HTTP_QUERY_SERVER = 37 -HTTP_QUERY_TITLE = 38 -HTTP_QUERY_USER_AGENT = 39 -HTTP_QUERY_WWW_AUTHENTICATE = 40 -HTTP_QUERY_PROXY_AUTHENTICATE = 41 -HTTP_QUERY_ACCEPT_RANGES = 42 -HTTP_QUERY_SET_COOKIE = 43 -HTTP_QUERY_COOKIE = 44 -HTTP_QUERY_REQUEST_METHOD = 45 -HTTP_QUERY_REFRESH = 46 -HTTP_QUERY_CONTENT_DISPOSITION = 47 -HTTP_QUERY_AGE = 48 -HTTP_QUERY_CACHE_CONTROL = 49 -HTTP_QUERY_CONTENT_BASE = 50 -HTTP_QUERY_CONTENT_LOCATION = 51 -HTTP_QUERY_CONTENT_MD5 = 52 -HTTP_QUERY_CONTENT_RANGE = 53 -HTTP_QUERY_ETAG = 54 -HTTP_QUERY_HOST = 55 -HTTP_QUERY_IF_MATCH = 56 -HTTP_QUERY_IF_NONE_MATCH = 57 -HTTP_QUERY_IF_RANGE = 58 -HTTP_QUERY_IF_UNMODIFIED_SINCE = 59 -HTTP_QUERY_MAX_FORWARDS = 60 -HTTP_QUERY_PROXY_AUTHORIZATION = 61 -HTTP_QUERY_RANGE = 62 -HTTP_QUERY_TRANSFER_ENCODING = 63 -HTTP_QUERY_UPGRADE = 64 -HTTP_QUERY_VARY = 65 -HTTP_QUERY_VIA = 66 -HTTP_QUERY_WARNING = 67 -HTTP_QUERY_EXPECT = 68 -HTTP_QUERY_PROXY_CONNECTION = 69 -HTTP_QUERY_UNLESS_MODIFIED_SINCE = 70 -HTTP_QUERY_ECHO_REQUEST = 71 -HTTP_QUERY_ECHO_REPLY = 72 -HTTP_QUERY_ECHO_HEADERS = 73 -HTTP_QUERY_ECHO_HEADERS_CRLF = 74 -HTTP_QUERY_PROXY_SUPPORT = 75 -HTTP_QUERY_AUTHENTICATION_INFO = 76 -HTTP_QUERY_PASSPORT_URLS = 77 -HTTP_QUERY_PASSPORT_CONFIG = 78 -HTTP_QUERY_MAX = 78 -HTTP_QUERY_CUSTOM = 65535 -HTTP_QUERY_FLAG_REQUEST_HEADERS = (-2147483648) -HTTP_QUERY_FLAG_SYSTEMTIME = 0x40000000 -HTTP_QUERY_FLAG_NUMBER = 0x20000000 -HTTP_QUERY_FLAG_COALESCE = 0x10000000 -HTTP_QUERY_MODIFIER_FLAGS_MASK = (HTTP_QUERY_FLAG_REQUEST_HEADERS - | HTTP_QUERY_FLAG_SYSTEMTIME - | HTTP_QUERY_FLAG_NUMBER - | HTTP_QUERY_FLAG_COALESCE - ) -HTTP_QUERY_HEADER_MASK = (~HTTP_QUERY_MODIFIER_FLAGS_MASK) -HTTP_STATUS_CONTINUE = 100 -HTTP_STATUS_SWITCH_PROTOCOLS = 101 -HTTP_STATUS_OK = 200 -HTTP_STATUS_CREATED = 201 -HTTP_STATUS_ACCEPTED = 202 -HTTP_STATUS_PARTIAL = 203 -HTTP_STATUS_NO_CONTENT = 204 -HTTP_STATUS_RESET_CONTENT = 205 -HTTP_STATUS_PARTIAL_CONTENT = 206 -HTTP_STATUS_AMBIGUOUS = 300 -HTTP_STATUS_MOVED = 301 -HTTP_STATUS_REDIRECT = 302 -HTTP_STATUS_REDIRECT_METHOD = 303 -HTTP_STATUS_NOT_MODIFIED = 304 -HTTP_STATUS_USE_PROXY = 305 -HTTP_STATUS_REDIRECT_KEEP_VERB = 307 -HTTP_STATUS_BAD_REQUEST = 400 -HTTP_STATUS_DENIED = 401 -HTTP_STATUS_PAYMENT_REQ = 402 -HTTP_STATUS_FORBIDDEN = 403 -HTTP_STATUS_NOT_FOUND = 404 -HTTP_STATUS_BAD_METHOD = 405 -HTTP_STATUS_NONE_ACCEPTABLE = 406 -HTTP_STATUS_PROXY_AUTH_REQ = 407 -HTTP_STATUS_REQUEST_TIMEOUT = 408 -HTTP_STATUS_CONFLICT = 409 -HTTP_STATUS_GONE = 410 -HTTP_STATUS_LENGTH_REQUIRED = 411 -HTTP_STATUS_PRECOND_FAILED = 412 -HTTP_STATUS_REQUEST_TOO_LARGE = 413 -HTTP_STATUS_URI_TOO_LONG = 414 -HTTP_STATUS_UNSUPPORTED_MEDIA = 415 -HTTP_STATUS_RETRY_WITH = 449 -HTTP_STATUS_SERVER_ERROR = 500 -HTTP_STATUS_NOT_SUPPORTED = 501 -HTTP_STATUS_BAD_GATEWAY = 502 -HTTP_STATUS_SERVICE_UNAVAIL = 503 -HTTP_STATUS_GATEWAY_TIMEOUT = 504 -HTTP_STATUS_VERSION_NOT_SUP = 505 -HTTP_STATUS_FIRST = HTTP_STATUS_CONTINUE -HTTP_STATUS_LAST = HTTP_STATUS_VERSION_NOT_SUP -HTTP_ADDREQ_INDEX_MASK = 0x0000FFFF -HTTP_ADDREQ_FLAGS_MASK = (-65536) -HTTP_ADDREQ_FLAG_ADD_IF_NEW = 0x10000000 -HTTP_ADDREQ_FLAG_ADD = 0x20000000 -HTTP_ADDREQ_FLAG_COALESCE_WITH_COMMA = 0x40000000 -HTTP_ADDREQ_FLAG_COALESCE_WITH_SEMICOLON = 0x01000000 -HTTP_ADDREQ_FLAG_COALESCE = HTTP_ADDREQ_FLAG_COALESCE_WITH_COMMA -HTTP_ADDREQ_FLAG_REPLACE = (-2147483648) -HSR_ASYNC = WININET_API_FLAG_ASYNC -HSR_SYNC = WININET_API_FLAG_SYNC -HSR_USE_CONTEXT = WININET_API_FLAG_USE_CONTEXT -HSR_INITIATE = 0x00000008 -HSR_DOWNLOAD = 0x00000010 -HSR_CHUNKED = 0x00000020 -INTERNET_COOKIE_IS_SECURE = 0x01 -INTERNET_COOKIE_IS_SESSION = 0x02 -INTERNET_COOKIE_THIRD_PARTY = 0x10 -INTERNET_COOKIE_PROMPT_REQUIRED = 0x20 -INTERNET_COOKIE_EVALUATE_P3P = 0x40 -INTERNET_COOKIE_APPLY_P3P = 0x80 -INTERNET_COOKIE_P3P_ENABLED = 0x100 -INTERNET_COOKIE_IS_RESTRICTED = 0x200 -INTERNET_COOKIE_IE6 = 0x400 -INTERNET_COOKIE_IS_LEGACY = 0x800 -FLAG_ICC_FORCE_CONNECTION = 0x00000001 -FLAGS_ERROR_UI_FILTER_FOR_ERRORS = 0x01 -FLAGS_ERROR_UI_FLAGS_CHANGE_OPTIONS = 0x02 -FLAGS_ERROR_UI_FLAGS_GENERATE_DATA = 0x04 -FLAGS_ERROR_UI_FLAGS_NO_UI = 0x08 -FLAGS_ERROR_UI_SERIALIZE_DIALOGS = 0x10 -INTERNET_ERROR_BASE = 12000 -ERROR_INTERNET_OUT_OF_HANDLES = (INTERNET_ERROR_BASE + 1) -ERROR_INTERNET_TIMEOUT = (INTERNET_ERROR_BASE + 2) -ERROR_INTERNET_EXTENDED_ERROR = (INTERNET_ERROR_BASE + 3) -ERROR_INTERNET_INTERNAL_ERROR = (INTERNET_ERROR_BASE + 4) -ERROR_INTERNET_INVALID_URL = (INTERNET_ERROR_BASE + 5) -ERROR_INTERNET_UNRECOGNIZED_SCHEME = (INTERNET_ERROR_BASE + 6) -ERROR_INTERNET_NAME_NOT_RESOLVED = (INTERNET_ERROR_BASE + 7) -ERROR_INTERNET_PROTOCOL_NOT_FOUND = (INTERNET_ERROR_BASE + 8) -ERROR_INTERNET_INVALID_OPTION = (INTERNET_ERROR_BASE + 9) -ERROR_INTERNET_BAD_OPTION_LENGTH = (INTERNET_ERROR_BASE + 10) -ERROR_INTERNET_OPTION_NOT_SETTABLE = (INTERNET_ERROR_BASE + 11) -ERROR_INTERNET_SHUTDOWN = (INTERNET_ERROR_BASE + 12) -ERROR_INTERNET_INCORRECT_USER_NAME = (INTERNET_ERROR_BASE + 13) -ERROR_INTERNET_INCORRECT_PASSWORD = (INTERNET_ERROR_BASE + 14) -ERROR_INTERNET_LOGIN_FAILURE = (INTERNET_ERROR_BASE + 15) -ERROR_INTERNET_INVALID_OPERATION = (INTERNET_ERROR_BASE + 16) -ERROR_INTERNET_OPERATION_CANCELLED = (INTERNET_ERROR_BASE + 17) -ERROR_INTERNET_INCORRECT_HANDLE_TYPE = (INTERNET_ERROR_BASE + 18) -ERROR_INTERNET_INCORRECT_HANDLE_STATE = (INTERNET_ERROR_BASE + 19) -ERROR_INTERNET_NOT_PROXY_REQUEST = (INTERNET_ERROR_BASE + 20) -ERROR_INTERNET_REGISTRY_VALUE_NOT_FOUND = (INTERNET_ERROR_BASE + 21) -ERROR_INTERNET_BAD_REGISTRY_PARAMETER = (INTERNET_ERROR_BASE + 22) -ERROR_INTERNET_NO_DIRECT_ACCESS = (INTERNET_ERROR_BASE + 23) -ERROR_INTERNET_NO_CONTEXT = (INTERNET_ERROR_BASE + 24) -ERROR_INTERNET_NO_CALLBACK = (INTERNET_ERROR_BASE + 25) -ERROR_INTERNET_REQUEST_PENDING = (INTERNET_ERROR_BASE + 26) -ERROR_INTERNET_INCORRECT_FORMAT = (INTERNET_ERROR_BASE + 27) -ERROR_INTERNET_ITEM_NOT_FOUND = (INTERNET_ERROR_BASE + 28) -ERROR_INTERNET_CANNOT_CONNECT = (INTERNET_ERROR_BASE + 29) -ERROR_INTERNET_CONNECTION_ABORTED = (INTERNET_ERROR_BASE + 30) -ERROR_INTERNET_CONNECTION_RESET = (INTERNET_ERROR_BASE + 31) -ERROR_INTERNET_FORCE_RETRY = (INTERNET_ERROR_BASE + 32) -ERROR_INTERNET_INVALID_PROXY_REQUEST = (INTERNET_ERROR_BASE + 33) -ERROR_INTERNET_NEED_UI = (INTERNET_ERROR_BASE + 34) -ERROR_INTERNET_HANDLE_EXISTS = (INTERNET_ERROR_BASE + 36) -ERROR_INTERNET_SEC_CERT_DATE_INVALID = (INTERNET_ERROR_BASE + 37) -ERROR_INTERNET_SEC_CERT_CN_INVALID = (INTERNET_ERROR_BASE + 38) -ERROR_INTERNET_HTTP_TO_HTTPS_ON_REDIR = (INTERNET_ERROR_BASE + 39) -ERROR_INTERNET_HTTPS_TO_HTTP_ON_REDIR = (INTERNET_ERROR_BASE + 40) -ERROR_INTERNET_MIXED_SECURITY = (INTERNET_ERROR_BASE + 41) -ERROR_INTERNET_CHG_POST_IS_NON_SECURE = (INTERNET_ERROR_BASE + 42) -ERROR_INTERNET_POST_IS_NON_SECURE = (INTERNET_ERROR_BASE + 43) -ERROR_INTERNET_CLIENT_AUTH_CERT_NEEDED = (INTERNET_ERROR_BASE + 44) -ERROR_INTERNET_INVALID_CA = (INTERNET_ERROR_BASE + 45) -ERROR_INTERNET_CLIENT_AUTH_NOT_SETUP = (INTERNET_ERROR_BASE + 46) -ERROR_INTERNET_ASYNC_THREAD_FAILED = (INTERNET_ERROR_BASE + 47) -ERROR_INTERNET_REDIRECT_SCHEME_CHANGE = (INTERNET_ERROR_BASE + 48) -ERROR_INTERNET_DIALOG_PENDING = (INTERNET_ERROR_BASE + 49) -ERROR_INTERNET_RETRY_DIALOG = (INTERNET_ERROR_BASE + 50) -ERROR_INTERNET_HTTPS_HTTP_SUBMIT_REDIR = (INTERNET_ERROR_BASE + 52) -ERROR_INTERNET_INSERT_CDROM = (INTERNET_ERROR_BASE + 53) -ERROR_INTERNET_FORTEZZA_LOGIN_NEEDED = (INTERNET_ERROR_BASE + 54) -ERROR_INTERNET_SEC_CERT_ERRORS = (INTERNET_ERROR_BASE + 55) -ERROR_INTERNET_SEC_CERT_NO_REV = (INTERNET_ERROR_BASE + 56) -ERROR_INTERNET_SEC_CERT_REV_FAILED = (INTERNET_ERROR_BASE + 57) -ERROR_FTP_TRANSFER_IN_PROGRESS = (INTERNET_ERROR_BASE + 110) -ERROR_FTP_DROPPED = (INTERNET_ERROR_BASE + 111) -ERROR_FTP_NO_PASSIVE_MODE = (INTERNET_ERROR_BASE + 112) -ERROR_GOPHER_PROTOCOL_ERROR = (INTERNET_ERROR_BASE + 130) -ERROR_GOPHER_NOT_FILE = (INTERNET_ERROR_BASE + 131) -ERROR_GOPHER_DATA_ERROR = (INTERNET_ERROR_BASE + 132) -ERROR_GOPHER_END_OF_DATA = (INTERNET_ERROR_BASE + 133) -ERROR_GOPHER_INVALID_LOCATOR = (INTERNET_ERROR_BASE + 134) -ERROR_GOPHER_INCORRECT_LOCATOR_TYPE = (INTERNET_ERROR_BASE + 135) -ERROR_GOPHER_NOT_GOPHER_PLUS = (INTERNET_ERROR_BASE + 136) -ERROR_GOPHER_ATTRIBUTE_NOT_FOUND = (INTERNET_ERROR_BASE + 137) -ERROR_GOPHER_UNKNOWN_LOCATOR = (INTERNET_ERROR_BASE + 138) -ERROR_HTTP_HEADER_NOT_FOUND = (INTERNET_ERROR_BASE + 150) -ERROR_HTTP_DOWNLEVEL_SERVER = (INTERNET_ERROR_BASE + 151) -ERROR_HTTP_INVALID_SERVER_RESPONSE = (INTERNET_ERROR_BASE + 152) -ERROR_HTTP_INVALID_HEADER = (INTERNET_ERROR_BASE + 153) -ERROR_HTTP_INVALID_QUERY_REQUEST = (INTERNET_ERROR_BASE + 154) -ERROR_HTTP_HEADER_ALREADY_EXISTS = (INTERNET_ERROR_BASE + 155) -ERROR_HTTP_REDIRECT_FAILED = (INTERNET_ERROR_BASE + 156) -ERROR_HTTP_NOT_REDIRECTED = (INTERNET_ERROR_BASE + 160) -ERROR_HTTP_COOKIE_NEEDS_CONFIRMATION = (INTERNET_ERROR_BASE + 161) -ERROR_HTTP_COOKIE_DECLINED = (INTERNET_ERROR_BASE + 162) -ERROR_HTTP_REDIRECT_NEEDS_CONFIRMATION = (INTERNET_ERROR_BASE + 168) -ERROR_INTERNET_SECURITY_CHANNEL_ERROR = (INTERNET_ERROR_BASE + 157) -ERROR_INTERNET_UNABLE_TO_CACHE_FILE = (INTERNET_ERROR_BASE + 158) -ERROR_INTERNET_TCPIP_NOT_INSTALLED = (INTERNET_ERROR_BASE + 159) -ERROR_INTERNET_DISCONNECTED = (INTERNET_ERROR_BASE + 163) -ERROR_INTERNET_SERVER_UNREACHABLE = (INTERNET_ERROR_BASE + 164) -ERROR_INTERNET_PROXY_SERVER_UNREACHABLE = (INTERNET_ERROR_BASE + 165) -ERROR_INTERNET_BAD_AUTO_PROXY_SCRIPT = (INTERNET_ERROR_BASE + 166) -ERROR_INTERNET_UNABLE_TO_DOWNLOAD_SCRIPT = (INTERNET_ERROR_BASE + 167) -ERROR_INTERNET_SEC_INVALID_CERT = (INTERNET_ERROR_BASE + 169) -ERROR_INTERNET_SEC_CERT_REVOKED = (INTERNET_ERROR_BASE + 170) -ERROR_INTERNET_FAILED_DUETOSECURITYCHECK = (INTERNET_ERROR_BASE + 171) -ERROR_INTERNET_NOT_INITIALIZED = (INTERNET_ERROR_BASE + 172) -ERROR_INTERNET_NEED_MSN_SSPI_PKG = (INTERNET_ERROR_BASE + 173) -ERROR_INTERNET_LOGIN_FAILURE_DISPLAY_ENTITY_BODY = (INTERNET_ERROR_BASE + 174) -INTERNET_ERROR_LAST = ERROR_INTERNET_LOGIN_FAILURE_DISPLAY_ENTITY_BODY -NORMAL_CACHE_ENTRY = 0x00000001 -STICKY_CACHE_ENTRY = 0x00000004 -EDITED_CACHE_ENTRY = 0x00000008 -TRACK_OFFLINE_CACHE_ENTRY = 0x00000010 -TRACK_ONLINE_CACHE_ENTRY = 0x00000020 -SPARSE_CACHE_ENTRY = 0x00010000 -COOKIE_CACHE_ENTRY = 0x00100000 -URLHISTORY_CACHE_ENTRY = 0x00200000 -URLCACHE_FIND_DEFAULT_FILTER = NORMAL_CACHE_ENTRY \ - | COOKIE_CACHE_ENTRY \ - | URLHISTORY_CACHE_ENTRY \ - | TRACK_OFFLINE_CACHE_ENTRY \ - | TRACK_ONLINE_CACHE_ENTRY \ - | STICKY_CACHE_ENTRY -CACHEGROUP_ATTRIBUTE_GET_ALL = (-1) -CACHEGROUP_ATTRIBUTE_BASIC = 0x00000001 -CACHEGROUP_ATTRIBUTE_FLAG = 0x00000002 -CACHEGROUP_ATTRIBUTE_TYPE = 0x00000004 -CACHEGROUP_ATTRIBUTE_QUOTA = 0x00000008 -CACHEGROUP_ATTRIBUTE_GROUPNAME = 0x00000010 -CACHEGROUP_ATTRIBUTE_STORAGE = 0x00000020 -CACHEGROUP_FLAG_NONPURGEABLE = 0x00000001 -CACHEGROUP_FLAG_GIDONLY = 0x00000004 -CACHEGROUP_FLAG_FLUSHURL_ONDELETE = 0x00000002 -CACHEGROUP_SEARCH_ALL = 0x00000000 -CACHEGROUP_SEARCH_BYURL = 0x00000001 -CACHEGROUP_TYPE_INVALID = 0x00000001 -CACHEGROUP_READWRITE_MASK = \ - CACHEGROUP_ATTRIBUTE_TYPE \ - | CACHEGROUP_ATTRIBUTE_QUOTA \ - | CACHEGROUP_ATTRIBUTE_GROUPNAME \ - | CACHEGROUP_ATTRIBUTE_STORAGE -GROUPNAME_MAX_LENGTH = 120 -GROUP_OWNER_STORAGE_SIZE = 4 -CACHE_ENTRY_ATTRIBUTE_FC = 0x00000004 -CACHE_ENTRY_HITRATE_FC = 0x00000010 -CACHE_ENTRY_MODTIME_FC = 0x00000040 -CACHE_ENTRY_EXPTIME_FC = 0x00000080 -CACHE_ENTRY_ACCTIME_FC = 0x00000100 -CACHE_ENTRY_SYNCTIME_FC = 0x00000200 -CACHE_ENTRY_HEADERINFO_FC = 0x00000400 -CACHE_ENTRY_EXEMPT_DELTA_FC = 0x00000800 -INTERNET_CACHE_GROUP_ADD = 0 -INTERNET_CACHE_GROUP_REMOVE = 1 -INTERNET_DIAL_FORCE_PROMPT = 0x2000 -INTERNET_DIAL_SHOW_OFFLINE = 0x4000 -INTERNET_DIAL_UNATTENDED = 0x8000 -INTERENT_GOONLINE_REFRESH = 0x00000001 -INTERENT_GOONLINE_MASK = 0x00000001 -INTERNET_AUTODIAL_FORCE_ONLINE = 1 -INTERNET_AUTODIAL_FORCE_UNATTENDED = 2 -INTERNET_AUTODIAL_FAILIFSECURITYCHECK = 4 -INTERNET_AUTODIAL_OVERRIDE_NET_PRESENT = 8 -INTERNET_AUTODIAL_FLAGS_MASK = (INTERNET_AUTODIAL_FORCE_ONLINE | INTERNET_AUTODIAL_FORCE_UNATTENDED - | INTERNET_AUTODIAL_FAILIFSECURITYCHECK | INTERNET_AUTODIAL_OVERRIDE_NET_PRESENT) -PROXY_AUTO_DETECT_TYPE_DHCP = 1 -PROXY_AUTO_DETECT_TYPE_DNS_A = 2 -INTERNET_CONNECTION_MODEM = 0x01 -INTERNET_CONNECTION_LAN = 0x02 -INTERNET_CONNECTION_PROXY = 0x04 -INTERNET_CONNECTION_MODEM_BUSY = 0x08 -INTERNET_RAS_INSTALLED = 0x10 -INTERNET_CONNECTION_OFFLINE = 0x20 -INTERNET_CONNECTION_CONFIGURED = 0x40 -INTERNET_CUSTOMDIAL_CONNECT = 0 -INTERNET_CUSTOMDIAL_UNATTENDED = 1 -INTERNET_CUSTOMDIAL_DISCONNECT = 2 -INTERNET_CUSTOMDIAL_SHOWOFFLINE = 4 -INTERNET_CUSTOMDIAL_SAFE_FOR_UNATTENDED = 1 -INTERNET_CUSTOMDIAL_WILL_SUPPLY_STATE = 2 -INTERNET_CUSTOMDIAL_CAN_HANGUP = 4 -INTERNET_DIALSTATE_DISCONNECTED = 1 -INTERNET_IDENTITY_FLAG_PRIVATE_CACHE = 0x01 -INTERNET_IDENTITY_FLAG_SHARED_CACHE = 0x02 -INTERNET_IDENTITY_FLAG_CLEAR_DATA = 0x04 -INTERNET_IDENTITY_FLAG_CLEAR_COOKIES = 0x08 -INTERNET_IDENTITY_FLAG_CLEAR_HISTORY = 0x10 -INTERNET_IDENTITY_FLAG_CLEAR_CONTENT = 0x20 -INTERNET_SUPPRESS_RESET_ALL = 0x00 -INTERNET_SUPPRESS_COOKIE_POLICY = 0x01 -INTERNET_SUPPRESS_COOKIE_POLICY_RESET = 0x02 -PRIVACY_TEMPLATE_NO_COOKIES = 0 -PRIVACY_TEMPLATE_HIGH = 1 -PRIVACY_TEMPLATE_MEDIUM_HIGH = 2 -PRIVACY_TEMPLATE_MEDIUM = 3 -PRIVACY_TEMPLATE_MEDIUM_LOW = 4 -PRIVACY_TEMPLATE_LOW = 5 -PRIVACY_TEMPLATE_CUSTOM = 100 -PRIVACY_TEMPLATE_ADVANCED = 101 -PRIVACY_TEMPLATE_MAX = PRIVACY_TEMPLATE_LOW -PRIVACY_TYPE_FIRST_PARTY = 0 -PRIVACY_TYPE_THIRD_PARTY = 1 - -# Generated by h2py from winhttp.h -INTERNET_DEFAULT_PORT = 0 -INTERNET_DEFAULT_HTTP_PORT = 80 -INTERNET_DEFAULT_HTTPS_PORT = 443 -WINHTTP_FLAG_ASYNC = 0x10000000 -WINHTTP_FLAG_SECURE = 0x00800000 -WINHTTP_FLAG_ESCAPE_PERCENT = 0x00000004 -WINHTTP_FLAG_NULL_CODEPAGE = 0x00000008 -WINHTTP_FLAG_BYPASS_PROXY_CACHE = 0x00000100 -WINHTTP_FLAG_REFRESH = WINHTTP_FLAG_BYPASS_PROXY_CACHE -WINHTTP_FLAG_ESCAPE_DISABLE = 0x00000040 -WINHTTP_FLAG_ESCAPE_DISABLE_QUERY = 0x00000080 -SECURITY_FLAG_IGNORE_UNKNOWN_CA = 0x00000100 -SECURITY_FLAG_IGNORE_CERT_DATE_INVALID = 0x00002000 -SECURITY_FLAG_IGNORE_CERT_CN_INVALID = 0x00001000 -SECURITY_FLAG_IGNORE_CERT_WRONG_USAGE = 0x00000200 -INTERNET_SCHEME_HTTP = (1) -INTERNET_SCHEME_HTTPS = (2) -WINHTTP_AUTOPROXY_AUTO_DETECT = 0x00000001 -WINHTTP_AUTOPROXY_CONFIG_URL = 0x00000002 -WINHTTP_AUTOPROXY_RUN_INPROCESS = 0x00010000 -WINHTTP_AUTOPROXY_RUN_OUTPROCESS_ONLY = 0x00020000 -WINHTTP_AUTO_DETECT_TYPE_DHCP = 0x00000001 -WINHTTP_AUTO_DETECT_TYPE_DNS_A = 0x00000002 -WINHTTP_TIME_FORMAT_BUFSIZE = 62 -ICU_NO_ENCODE = 0x20000000 -ICU_DECODE = 0x10000000 -ICU_NO_META = 0x08000000 -ICU_ENCODE_SPACES_ONLY = 0x04000000 -ICU_BROWSER_MODE = 0x02000000 -ICU_ENCODE_PERCENT = 0x00001000 -ICU_ESCAPE = (-2147483648) -ICU_ESCAPE_AUTHORITY = 0x00002000 -ICU_REJECT_USERPWD = 0x00004000 -WINHTTP_ACCESS_TYPE_DEFAULT_PROXY = 0 -WINHTTP_ACCESS_TYPE_NO_PROXY = 1 -WINHTTP_ACCESS_TYPE_NAMED_PROXY = 3 -WINHTTP_OPTION_CALLBACK = 1 -WINHTTP_OPTION_RESOLVE_TIMEOUT = 2 -WINHTTP_OPTION_CONNECT_TIMEOUT = 3 -WINHTTP_OPTION_CONNECT_RETRIES = 4 -WINHTTP_OPTION_SEND_TIMEOUT = 5 -WINHTTP_OPTION_RECEIVE_TIMEOUT = 6 -WINHTTP_OPTION_RECEIVE_RESPONSE_TIMEOUT = 7 -WINHTTP_OPTION_HANDLE_TYPE = 9 -WINHTTP_OPTION_READ_BUFFER_SIZE = 12 -WINHTTP_OPTION_WRITE_BUFFER_SIZE = 13 -WINHTTP_OPTION_PARENT_HANDLE = 21 -WINHTTP_OPTION_EXTENDED_ERROR = 24 -WINHTTP_OPTION_SECURITY_FLAGS = 31 -WINHTTP_OPTION_SECURITY_CERTIFICATE_STRUCT = 32 -WINHTTP_OPTION_URL = 34 -WINHTTP_OPTION_SECURITY_KEY_BITNESS = 36 -WINHTTP_OPTION_PROXY = 38 -WINHTTP_OPTION_USER_AGENT = 41 -WINHTTP_OPTION_CONTEXT_VALUE = 45 -WINHTTP_OPTION_CLIENT_CERT_CONTEXT = 47 -WINHTTP_OPTION_REQUEST_PRIORITY = 58 -WINHTTP_OPTION_HTTP_VERSION = 59 -WINHTTP_OPTION_DISABLE_FEATURE = 63 -WINHTTP_OPTION_CODEPAGE = 68 -WINHTTP_OPTION_MAX_CONNS_PER_SERVER = 73 -WINHTTP_OPTION_MAX_CONNS_PER_1_0_SERVER = 74 -WINHTTP_OPTION_AUTOLOGON_POLICY = 77 -WINHTTP_OPTION_SERVER_CERT_CONTEXT = 78 -WINHTTP_OPTION_ENABLE_FEATURE = 79 -WINHTTP_OPTION_WORKER_THREAD_COUNT = 80 -WINHTTP_OPTION_PASSPORT_COBRANDING_TEXT = 81 -WINHTTP_OPTION_PASSPORT_COBRANDING_URL = 82 -WINHTTP_OPTION_CONFIGURE_PASSPORT_AUTH = 83 -WINHTTP_OPTION_SECURE_PROTOCOLS = 84 -WINHTTP_OPTION_ENABLETRACING = 85 -WINHTTP_OPTION_PASSPORT_SIGN_OUT = 86 -WINHTTP_OPTION_PASSPORT_RETURN_URL = 87 -WINHTTP_OPTION_REDIRECT_POLICY = 88 -WINHTTP_OPTION_MAX_HTTP_AUTOMATIC_REDIRECTS = 89 -WINHTTP_OPTION_MAX_HTTP_STATUS_CONTINUE = 90 -WINHTTP_OPTION_MAX_RESPONSE_HEADER_SIZE = 91 -WINHTTP_OPTION_MAX_RESPONSE_DRAIN_SIZE = 92 -WINHTTP_OPTION_CONNECTION_INFO = 93 -WINHTTP_OPTION_CLIENT_CERT_ISSUER_LIST = 94 -WINHTTP_OPTION_SPN = 96 -WINHTTP_OPTION_GLOBAL_PROXY_CREDS = 97 -WINHTTP_OPTION_GLOBAL_SERVER_CREDS = 98 -WINHTTP_OPTION_UNLOAD_NOTIFY_EVENT = 99 -WINHTTP_OPTION_REJECT_USERPWD_IN_URL = 100 -WINHTTP_OPTION_USE_GLOBAL_SERVER_CREDENTIALS = 101 -WINHTTP_LAST_OPTION = WINHTTP_OPTION_USE_GLOBAL_SERVER_CREDENTIALS -WINHTTP_OPTION_USERNAME = 0x1000 -WINHTTP_OPTION_PASSWORD = 0x1001 -WINHTTP_OPTION_PROXY_USERNAME = 0x1002 -WINHTTP_OPTION_PROXY_PASSWORD = 0x1003 -WINHTTP_CONNS_PER_SERVER_UNLIMITED = (-1) -WINHTTP_AUTOLOGON_SECURITY_LEVEL_MEDIUM = 0 -WINHTTP_AUTOLOGON_SECURITY_LEVEL_LOW = 1 -WINHTTP_AUTOLOGON_SECURITY_LEVEL_HIGH = 2 -WINHTTP_AUTOLOGON_SECURITY_LEVEL_DEFAULT = WINHTTP_AUTOLOGON_SECURITY_LEVEL_MEDIUM -WINHTTP_OPTION_REDIRECT_POLICY_NEVER = 0 -WINHTTP_OPTION_REDIRECT_POLICY_DISALLOW_HTTPS_TO_HTTP = 1 -WINHTTP_OPTION_REDIRECT_POLICY_ALWAYS = 2 -WINHTTP_OPTION_REDIRECT_POLICY_LAST = WINHTTP_OPTION_REDIRECT_POLICY_ALWAYS -WINHTTP_OPTION_REDIRECT_POLICY_DEFAULT = WINHTTP_OPTION_REDIRECT_POLICY_DISALLOW_HTTPS_TO_HTTP -WINHTTP_DISABLE_PASSPORT_AUTH = 0x00000000 -WINHTTP_ENABLE_PASSPORT_AUTH = 0x10000000 -WINHTTP_DISABLE_PASSPORT_KEYRING = 0x20000000 -WINHTTP_ENABLE_PASSPORT_KEYRING = 0x40000000 -WINHTTP_DISABLE_COOKIES = 0x00000001 -WINHTTP_DISABLE_REDIRECTS = 0x00000002 -WINHTTP_DISABLE_AUTHENTICATION = 0x00000004 -WINHTTP_DISABLE_KEEP_ALIVE = 0x00000008 -WINHTTP_ENABLE_SSL_REVOCATION = 0x00000001 -WINHTTP_ENABLE_SSL_REVERT_IMPERSONATION = 0x00000002 -WINHTTP_DISABLE_SPN_SERVER_PORT = 0x00000000 -WINHTTP_ENABLE_SPN_SERVER_PORT = 0x00000001 -WINHTTP_OPTION_SPN_MASK = WINHTTP_ENABLE_SPN_SERVER_PORT -WINHTTP_HANDLE_TYPE_SESSION = 1 -WINHTTP_HANDLE_TYPE_CONNECT = 2 -WINHTTP_HANDLE_TYPE_REQUEST = 3 -WINHTTP_AUTH_SCHEME_BASIC = 0x00000001 -WINHTTP_AUTH_SCHEME_NTLM = 0x00000002 -WINHTTP_AUTH_SCHEME_PASSPORT = 0x00000004 -WINHTTP_AUTH_SCHEME_DIGEST = 0x00000008 -WINHTTP_AUTH_SCHEME_NEGOTIATE = 0x00000010 -WINHTTP_AUTH_TARGET_SERVER = 0x00000000 -WINHTTP_AUTH_TARGET_PROXY = 0x00000001 -SECURITY_FLAG_SECURE = 0x00000001 -SECURITY_FLAG_STRENGTH_WEAK = 0x10000000 -SECURITY_FLAG_STRENGTH_MEDIUM = 0x40000000 -SECURITY_FLAG_STRENGTH_STRONG = 0x20000000 -WINHTTP_CALLBACK_STATUS_FLAG_CERT_REV_FAILED = 0x00000001 -WINHTTP_CALLBACK_STATUS_FLAG_INVALID_CERT = 0x00000002 -WINHTTP_CALLBACK_STATUS_FLAG_CERT_REVOKED = 0x00000004 -WINHTTP_CALLBACK_STATUS_FLAG_INVALID_CA = 0x00000008 -WINHTTP_CALLBACK_STATUS_FLAG_CERT_CN_INVALID = 0x00000010 -WINHTTP_CALLBACK_STATUS_FLAG_CERT_DATE_INVALID = 0x00000020 -WINHTTP_CALLBACK_STATUS_FLAG_CERT_WRONG_USAGE = 0x00000040 -WINHTTP_CALLBACK_STATUS_FLAG_SECURITY_CHANNEL_ERROR = (-2147483648) -WINHTTP_FLAG_SECURE_PROTOCOL_SSL2 = 0x00000008 -WINHTTP_FLAG_SECURE_PROTOCOL_SSL3 = 0x00000020 -WINHTTP_FLAG_SECURE_PROTOCOL_TLS1 = 0x00000080 -WINHTTP_FLAG_SECURE_PROTOCOL_ALL = (WINHTTP_FLAG_SECURE_PROTOCOL_SSL2 - | WINHTTP_FLAG_SECURE_PROTOCOL_SSL3 - | WINHTTP_FLAG_SECURE_PROTOCOL_TLS1) -WINHTTP_CALLBACK_STATUS_RESOLVING_NAME = 0x00000001 -WINHTTP_CALLBACK_STATUS_NAME_RESOLVED = 0x00000002 -WINHTTP_CALLBACK_STATUS_CONNECTING_TO_SERVER = 0x00000004 -WINHTTP_CALLBACK_STATUS_CONNECTED_TO_SERVER = 0x00000008 -WINHTTP_CALLBACK_STATUS_SENDING_REQUEST = 0x00000010 -WINHTTP_CALLBACK_STATUS_REQUEST_SENT = 0x00000020 -WINHTTP_CALLBACK_STATUS_RECEIVING_RESPONSE = 0x00000040 -WINHTTP_CALLBACK_STATUS_RESPONSE_RECEIVED = 0x00000080 -WINHTTP_CALLBACK_STATUS_CLOSING_CONNECTION = 0x00000100 -WINHTTP_CALLBACK_STATUS_CONNECTION_CLOSED = 0x00000200 -WINHTTP_CALLBACK_STATUS_HANDLE_CREATED = 0x00000400 -WINHTTP_CALLBACK_STATUS_HANDLE_CLOSING = 0x00000800 -WINHTTP_CALLBACK_STATUS_DETECTING_PROXY = 0x00001000 -WINHTTP_CALLBACK_STATUS_REDIRECT = 0x00004000 -WINHTTP_CALLBACK_STATUS_INTERMEDIATE_RESPONSE = 0x00008000 -WINHTTP_CALLBACK_STATUS_SECURE_FAILURE = 0x00010000 -WINHTTP_CALLBACK_STATUS_HEADERS_AVAILABLE = 0x00020000 -WINHTTP_CALLBACK_STATUS_DATA_AVAILABLE = 0x00040000 -WINHTTP_CALLBACK_STATUS_READ_COMPLETE = 0x00080000 -WINHTTP_CALLBACK_STATUS_WRITE_COMPLETE = 0x00100000 -WINHTTP_CALLBACK_STATUS_REQUEST_ERROR = 0x00200000 -WINHTTP_CALLBACK_STATUS_SENDREQUEST_COMPLETE = 0x00400000 -API_RECEIVE_RESPONSE = (1) -API_QUERY_DATA_AVAILABLE = (2) -API_READ_DATA = (3) -API_WRITE_DATA = (4) -API_SEND_REQUEST = (5) -WINHTTP_CALLBACK_FLAG_RESOLVE_NAME = (WINHTTP_CALLBACK_STATUS_RESOLVING_NAME | WINHTTP_CALLBACK_STATUS_NAME_RESOLVED) -WINHTTP_CALLBACK_FLAG_CONNECT_TO_SERVER = ( - WINHTTP_CALLBACK_STATUS_CONNECTING_TO_SERVER | WINHTTP_CALLBACK_STATUS_CONNECTED_TO_SERVER) -WINHTTP_CALLBACK_FLAG_SEND_REQUEST = (WINHTTP_CALLBACK_STATUS_SENDING_REQUEST | WINHTTP_CALLBACK_STATUS_REQUEST_SENT) -WINHTTP_CALLBACK_FLAG_RECEIVE_RESPONSE = ( - WINHTTP_CALLBACK_STATUS_RECEIVING_RESPONSE | WINHTTP_CALLBACK_STATUS_RESPONSE_RECEIVED) -WINHTTP_CALLBACK_FLAG_CLOSE_CONNECTION = ( - WINHTTP_CALLBACK_STATUS_CLOSING_CONNECTION | WINHTTP_CALLBACK_STATUS_CONNECTION_CLOSED) -WINHTTP_CALLBACK_FLAG_HANDLES = (WINHTTP_CALLBACK_STATUS_HANDLE_CREATED | WINHTTP_CALLBACK_STATUS_HANDLE_CLOSING) -WINHTTP_CALLBACK_FLAG_DETECTING_PROXY = WINHTTP_CALLBACK_STATUS_DETECTING_PROXY -WINHTTP_CALLBACK_FLAG_REDIRECT = WINHTTP_CALLBACK_STATUS_REDIRECT -WINHTTP_CALLBACK_FLAG_INTERMEDIATE_RESPONSE = WINHTTP_CALLBACK_STATUS_INTERMEDIATE_RESPONSE -WINHTTP_CALLBACK_FLAG_SECURE_FAILURE = WINHTTP_CALLBACK_STATUS_SECURE_FAILURE -WINHTTP_CALLBACK_FLAG_SENDREQUEST_COMPLETE = WINHTTP_CALLBACK_STATUS_SENDREQUEST_COMPLETE -WINHTTP_CALLBACK_FLAG_HEADERS_AVAILABLE = WINHTTP_CALLBACK_STATUS_HEADERS_AVAILABLE -WINHTTP_CALLBACK_FLAG_DATA_AVAILABLE = WINHTTP_CALLBACK_STATUS_DATA_AVAILABLE -WINHTTP_CALLBACK_FLAG_READ_COMPLETE = WINHTTP_CALLBACK_STATUS_READ_COMPLETE -WINHTTP_CALLBACK_FLAG_WRITE_COMPLETE = WINHTTP_CALLBACK_STATUS_WRITE_COMPLETE -WINHTTP_CALLBACK_FLAG_REQUEST_ERROR = WINHTTP_CALLBACK_STATUS_REQUEST_ERROR -WINHTTP_CALLBACK_FLAG_ALL_COMPLETIONS = (WINHTTP_CALLBACK_STATUS_SENDREQUEST_COMPLETE - | WINHTTP_CALLBACK_STATUS_HEADERS_AVAILABLE - | WINHTTP_CALLBACK_STATUS_DATA_AVAILABLE - | WINHTTP_CALLBACK_STATUS_READ_COMPLETE - | WINHTTP_CALLBACK_STATUS_WRITE_COMPLETE - | WINHTTP_CALLBACK_STATUS_REQUEST_ERROR) -WINHTTP_CALLBACK_FLAG_ALL_NOTIFICATIONS = (-1) -WINHTTP_QUERY_MIME_VERSION = 0 -WINHTTP_QUERY_CONTENT_TYPE = 1 -WINHTTP_QUERY_CONTENT_TRANSFER_ENCODING = 2 -WINHTTP_QUERY_CONTENT_ID = 3 -WINHTTP_QUERY_CONTENT_DESCRIPTION = 4 -WINHTTP_QUERY_CONTENT_LENGTH = 5 -WINHTTP_QUERY_CONTENT_LANGUAGE = 6 -WINHTTP_QUERY_ALLOW = 7 -WINHTTP_QUERY_PUBLIC = 8 -WINHTTP_QUERY_DATE = 9 -WINHTTP_QUERY_EXPIRES = 10 -WINHTTP_QUERY_LAST_MODIFIED = 11 -WINHTTP_QUERY_MESSAGE_ID = 12 -WINHTTP_QUERY_URI = 13 -WINHTTP_QUERY_DERIVED_FROM = 14 -WINHTTP_QUERY_COST = 15 -WINHTTP_QUERY_LINK = 16 -WINHTTP_QUERY_PRAGMA = 17 -WINHTTP_QUERY_VERSION = 18 -WINHTTP_QUERY_STATUS_CODE = 19 -WINHTTP_QUERY_STATUS_TEXT = 20 -WINHTTP_QUERY_RAW_HEADERS = 21 -WINHTTP_QUERY_RAW_HEADERS_CRLF = 22 -WINHTTP_QUERY_CONNECTION = 23 -WINHTTP_QUERY_ACCEPT = 24 -WINHTTP_QUERY_ACCEPT_CHARSET = 25 -WINHTTP_QUERY_ACCEPT_ENCODING = 26 -WINHTTP_QUERY_ACCEPT_LANGUAGE = 27 -WINHTTP_QUERY_AUTHORIZATION = 28 -WINHTTP_QUERY_CONTENT_ENCODING = 29 -WINHTTP_QUERY_FORWARDED = 30 -WINHTTP_QUERY_FROM = 31 -WINHTTP_QUERY_IF_MODIFIED_SINCE = 32 -WINHTTP_QUERY_LOCATION = 33 -WINHTTP_QUERY_ORIG_URI = 34 -WINHTTP_QUERY_REFERER = 35 -WINHTTP_QUERY_RETRY_AFTER = 36 -WINHTTP_QUERY_SERVER = 37 -WINHTTP_QUERY_TITLE = 38 -WINHTTP_QUERY_USER_AGENT = 39 -WINHTTP_QUERY_WWW_AUTHENTICATE = 40 -WINHTTP_QUERY_PROXY_AUTHENTICATE = 41 -WINHTTP_QUERY_ACCEPT_RANGES = 42 -WINHTTP_QUERY_SET_COOKIE = 43 -WINHTTP_QUERY_COOKIE = 44 -WINHTTP_QUERY_REQUEST_METHOD = 45 -WINHTTP_QUERY_REFRESH = 46 -WINHTTP_QUERY_CONTENT_DISPOSITION = 47 -WINHTTP_QUERY_AGE = 48 -WINHTTP_QUERY_CACHE_CONTROL = 49 -WINHTTP_QUERY_CONTENT_BASE = 50 -WINHTTP_QUERY_CONTENT_LOCATION = 51 -WINHTTP_QUERY_CONTENT_MD5 = 52 -WINHTTP_QUERY_CONTENT_RANGE = 53 -WINHTTP_QUERY_ETAG = 54 -WINHTTP_QUERY_HOST = 55 -WINHTTP_QUERY_IF_MATCH = 56 -WINHTTP_QUERY_IF_NONE_MATCH = 57 -WINHTTP_QUERY_IF_RANGE = 58 -WINHTTP_QUERY_IF_UNMODIFIED_SINCE = 59 -WINHTTP_QUERY_MAX_FORWARDS = 60 -WINHTTP_QUERY_PROXY_AUTHORIZATION = 61 -WINHTTP_QUERY_RANGE = 62 -WINHTTP_QUERY_TRANSFER_ENCODING = 63 -WINHTTP_QUERY_UPGRADE = 64 -WINHTTP_QUERY_VARY = 65 -WINHTTP_QUERY_VIA = 66 -WINHTTP_QUERY_WARNING = 67 -WINHTTP_QUERY_EXPECT = 68 -WINHTTP_QUERY_PROXY_CONNECTION = 69 -WINHTTP_QUERY_UNLESS_MODIFIED_SINCE = 70 -WINHTTP_QUERY_PROXY_SUPPORT = 75 -WINHTTP_QUERY_AUTHENTICATION_INFO = 76 -WINHTTP_QUERY_PASSPORT_URLS = 77 -WINHTTP_QUERY_PASSPORT_CONFIG = 78 -WINHTTP_QUERY_MAX = 78 -WINHTTP_QUERY_CUSTOM = 65535 -WINHTTP_QUERY_FLAG_REQUEST_HEADERS = (-2147483648) -WINHTTP_QUERY_FLAG_SYSTEMTIME = 0x40000000 -WINHTTP_QUERY_FLAG_NUMBER = 0x20000000 -HTTP_STATUS_CONTINUE = 100 -HTTP_STATUS_SWITCH_PROTOCOLS = 101 -HTTP_STATUS_OK = 200 -HTTP_STATUS_CREATED = 201 -HTTP_STATUS_ACCEPTED = 202 -HTTP_STATUS_PARTIAL = 203 -HTTP_STATUS_NO_CONTENT = 204 -HTTP_STATUS_RESET_CONTENT = 205 -HTTP_STATUS_PARTIAL_CONTENT = 206 -HTTP_STATUS_WEBDAV_MULTI_STATUS = 207 -HTTP_STATUS_AMBIGUOUS = 300 -HTTP_STATUS_MOVED = 301 -HTTP_STATUS_REDIRECT = 302 -HTTP_STATUS_REDIRECT_METHOD = 303 -HTTP_STATUS_NOT_MODIFIED = 304 -HTTP_STATUS_USE_PROXY = 305 -HTTP_STATUS_REDIRECT_KEEP_VERB = 307 -HTTP_STATUS_BAD_REQUEST = 400 -HTTP_STATUS_DENIED = 401 -HTTP_STATUS_PAYMENT_REQ = 402 -HTTP_STATUS_FORBIDDEN = 403 -HTTP_STATUS_NOT_FOUND = 404 -HTTP_STATUS_BAD_METHOD = 405 -HTTP_STATUS_NONE_ACCEPTABLE = 406 -HTTP_STATUS_PROXY_AUTH_REQ = 407 -HTTP_STATUS_REQUEST_TIMEOUT = 408 -HTTP_STATUS_CONFLICT = 409 -HTTP_STATUS_GONE = 410 -HTTP_STATUS_LENGTH_REQUIRED = 411 -HTTP_STATUS_PRECOND_FAILED = 412 -HTTP_STATUS_REQUEST_TOO_LARGE = 413 -HTTP_STATUS_URI_TOO_LONG = 414 -HTTP_STATUS_UNSUPPORTED_MEDIA = 415 -HTTP_STATUS_RETRY_WITH = 449 -HTTP_STATUS_SERVER_ERROR = 500 -HTTP_STATUS_NOT_SUPPORTED = 501 -HTTP_STATUS_BAD_GATEWAY = 502 -HTTP_STATUS_SERVICE_UNAVAIL = 503 -HTTP_STATUS_GATEWAY_TIMEOUT = 504 -HTTP_STATUS_VERSION_NOT_SUP = 505 -HTTP_STATUS_FIRST = HTTP_STATUS_CONTINUE -HTTP_STATUS_LAST = HTTP_STATUS_VERSION_NOT_SUP -WINHTTP_ADDREQ_INDEX_MASK = 0x0000FFFF -WINHTTP_ADDREQ_FLAGS_MASK = (-65536) -WINHTTP_ADDREQ_FLAG_ADD_IF_NEW = 0x10000000 -WINHTTP_ADDREQ_FLAG_ADD = 0x20000000 -WINHTTP_ADDREQ_FLAG_COALESCE_WITH_COMMA = 0x40000000 -WINHTTP_ADDREQ_FLAG_COALESCE_WITH_SEMICOLON = 0x01000000 -WINHTTP_ADDREQ_FLAG_COALESCE = WINHTTP_ADDREQ_FLAG_COALESCE_WITH_COMMA -WINHTTP_ADDREQ_FLAG_REPLACE = (-2147483648) -WINHTTP_IGNORE_REQUEST_TOTAL_LENGTH = 0 -WINHTTP_ERROR_BASE = 12000 -ERROR_WINHTTP_OUT_OF_HANDLES = (WINHTTP_ERROR_BASE + 1) -ERROR_WINHTTP_TIMEOUT = (WINHTTP_ERROR_BASE + 2) -ERROR_WINHTTP_INTERNAL_ERROR = (WINHTTP_ERROR_BASE + 4) -ERROR_WINHTTP_INVALID_URL = (WINHTTP_ERROR_BASE + 5) -ERROR_WINHTTP_UNRECOGNIZED_SCHEME = (WINHTTP_ERROR_BASE + 6) -ERROR_WINHTTP_NAME_NOT_RESOLVED = (WINHTTP_ERROR_BASE + 7) -ERROR_WINHTTP_INVALID_OPTION = (WINHTTP_ERROR_BASE + 9) -ERROR_WINHTTP_OPTION_NOT_SETTABLE = (WINHTTP_ERROR_BASE + 11) -ERROR_WINHTTP_SHUTDOWN = (WINHTTP_ERROR_BASE + 12) -ERROR_WINHTTP_LOGIN_FAILURE = (WINHTTP_ERROR_BASE + 15) -ERROR_WINHTTP_OPERATION_CANCELLED = (WINHTTP_ERROR_BASE + 17) -ERROR_WINHTTP_INCORRECT_HANDLE_TYPE = (WINHTTP_ERROR_BASE + 18) -ERROR_WINHTTP_INCORRECT_HANDLE_STATE = (WINHTTP_ERROR_BASE + 19) -ERROR_WINHTTP_CANNOT_CONNECT = (WINHTTP_ERROR_BASE + 29) -ERROR_WINHTTP_CONNECTION_ERROR = (WINHTTP_ERROR_BASE + 30) -ERROR_WINHTTP_RESEND_REQUEST = (WINHTTP_ERROR_BASE + 32) -ERROR_WINHTTP_CLIENT_AUTH_CERT_NEEDED = (WINHTTP_ERROR_BASE + 44) -ERROR_WINHTTP_CANNOT_CALL_BEFORE_OPEN = (WINHTTP_ERROR_BASE + 100) -ERROR_WINHTTP_CANNOT_CALL_BEFORE_SEND = (WINHTTP_ERROR_BASE + 101) -ERROR_WINHTTP_CANNOT_CALL_AFTER_SEND = (WINHTTP_ERROR_BASE + 102) -ERROR_WINHTTP_CANNOT_CALL_AFTER_OPEN = (WINHTTP_ERROR_BASE + 103) -ERROR_WINHTTP_HEADER_NOT_FOUND = (WINHTTP_ERROR_BASE + 150) -ERROR_WINHTTP_INVALID_SERVER_RESPONSE = (WINHTTP_ERROR_BASE + 152) -ERROR_WINHTTP_INVALID_HEADER = (WINHTTP_ERROR_BASE + 153) -ERROR_WINHTTP_INVALID_QUERY_REQUEST = (WINHTTP_ERROR_BASE + 154) -ERROR_WINHTTP_HEADER_ALREADY_EXISTS = (WINHTTP_ERROR_BASE + 155) -ERROR_WINHTTP_REDIRECT_FAILED = (WINHTTP_ERROR_BASE + 156) -ERROR_WINHTTP_AUTO_PROXY_SERVICE_ERROR = (WINHTTP_ERROR_BASE + 178) -ERROR_WINHTTP_BAD_AUTO_PROXY_SCRIPT = (WINHTTP_ERROR_BASE + 166) -ERROR_WINHTTP_UNABLE_TO_DOWNLOAD_SCRIPT = (WINHTTP_ERROR_BASE + 167) -ERROR_WINHTTP_NOT_INITIALIZED = (WINHTTP_ERROR_BASE + 172) -ERROR_WINHTTP_SECURE_FAILURE = (WINHTTP_ERROR_BASE + 175) -ERROR_WINHTTP_SECURE_CERT_DATE_INVALID = (WINHTTP_ERROR_BASE + 37) -ERROR_WINHTTP_SECURE_CERT_CN_INVALID = (WINHTTP_ERROR_BASE + 38) -ERROR_WINHTTP_SECURE_INVALID_CA = (WINHTTP_ERROR_BASE + 45) -ERROR_WINHTTP_SECURE_CERT_REV_FAILED = (WINHTTP_ERROR_BASE + 57) -ERROR_WINHTTP_SECURE_CHANNEL_ERROR = (WINHTTP_ERROR_BASE + 157) -ERROR_WINHTTP_SECURE_INVALID_CERT = (WINHTTP_ERROR_BASE + 169) -ERROR_WINHTTP_SECURE_CERT_REVOKED = (WINHTTP_ERROR_BASE + 170) -ERROR_WINHTTP_SECURE_CERT_WRONG_USAGE = (WINHTTP_ERROR_BASE + 179) -ERROR_WINHTTP_AUTODETECTION_FAILED = (WINHTTP_ERROR_BASE + 180) -ERROR_WINHTTP_HEADER_COUNT_EXCEEDED = (WINHTTP_ERROR_BASE + 181) -ERROR_WINHTTP_HEADER_SIZE_OVERFLOW = (WINHTTP_ERROR_BASE + 182) -ERROR_WINHTTP_CHUNKED_ENCODING_HEADER_SIZE_OVERFLOW = (WINHTTP_ERROR_BASE + 183) -ERROR_WINHTTP_RESPONSE_DRAIN_OVERFLOW = (WINHTTP_ERROR_BASE + 184) -ERROR_WINHTTP_CLIENT_CERT_NO_PRIVATE_KEY = (WINHTTP_ERROR_BASE + 185) -ERROR_WINHTTP_CLIENT_CERT_NO_ACCESS_PRIVATE_KEY = (WINHTTP_ERROR_BASE + 186) -WINHTTP_ERROR_LAST = (WINHTTP_ERROR_BASE + 186) - -WINHTTP_NO_PROXY_NAME = None -WINHTTP_NO_PROXY_BYPASS = None -WINHTTP_NO_REFERER = None -WINHTTP_DEFAULT_ACCEPT_TYPES = None -WINHTTP_NO_ADDITIONAL_HEADERS = None -WINHTTP_NO_REQUEST_DATA = None diff --git a/typings/win32helper/win32netcon.pyi b/typings/win32helper/win32netcon.pyi deleted file mode 100644 index c3fe218e..00000000 --- a/typings/win32helper/win32netcon.pyi +++ /dev/null @@ -1,658 +0,0 @@ -# Generated by h2py from lmaccess.h - -# Included from lmcons.h -CNLEN = 15 -LM20_CNLEN = 15 -DNLEN = CNLEN -LM20_DNLEN = LM20_CNLEN -UNCLEN = (CNLEN + 2) -LM20_UNCLEN = (LM20_CNLEN + 2) -NNLEN = 80 -LM20_NNLEN = 12 -RMLEN = (UNCLEN + 1 + NNLEN) -LM20_RMLEN = (LM20_UNCLEN + 1 + LM20_NNLEN) -SNLEN = 80 -LM20_SNLEN = 15 -STXTLEN = 256 -LM20_STXTLEN = 63 -PATHLEN = 256 -LM20_PATHLEN = 256 -DEVLEN = 80 -LM20_DEVLEN = 8 -EVLEN = 16 -UNLEN = 256 -LM20_UNLEN = 20 -GNLEN = UNLEN -LM20_GNLEN = LM20_UNLEN -PWLEN = 256 -LM20_PWLEN = 14 -SHPWLEN = 8 -CLTYPE_LEN = 12 -MAXCOMMENTSZ = 256 -LM20_MAXCOMMENTSZ = 48 -QNLEN = NNLEN -LM20_QNLEN = LM20_NNLEN -ALERTSZ = 128 -NETBIOS_NAME_LEN = 16 -CRYPT_KEY_LEN = 7 -CRYPT_TXT_LEN = 8 -ENCRYPTED_PWLEN = 16 -SESSION_PWLEN = 24 -SESSION_CRYPT_KLEN = 21 -PARMNUM_ALL = 0 -PARM_ERROR_NONE = 0 -PARMNUM_BASE_INFOLEVEL = 1000 -NULL = 0 -PLATFORM_ID_DOS = 300 -PLATFORM_ID_OS2 = 400 -PLATFORM_ID_NT = 500 -PLATFORM_ID_OSF = 600 -PLATFORM_ID_VMS = 700 -MAX_LANMAN_MESSAGE_ID = 5799 -UF_SCRIPT = 1 -UF_ACCOUNTDISABLE = 2 -UF_HOMEDIR_REQUIRED = 8 -UF_LOCKOUT = 16 -UF_PASSWD_NOTREQD = 32 -UF_PASSWD_CANT_CHANGE = 64 -UF_TEMP_DUPLICATE_ACCOUNT = 256 -UF_NORMAL_ACCOUNT = 512 -UF_INTERDOMAIN_TRUST_ACCOUNT = 2048 -UF_WORKSTATION_TRUST_ACCOUNT = 4096 -UF_SERVER_TRUST_ACCOUNT = 8192 -UF_MACHINE_ACCOUNT_MASK = (UF_INTERDOMAIN_TRUST_ACCOUNT - | UF_WORKSTATION_TRUST_ACCOUNT - | UF_SERVER_TRUST_ACCOUNT) -UF_ACCOUNT_TYPE_MASK = ( - UF_TEMP_DUPLICATE_ACCOUNT - | UF_NORMAL_ACCOUNT - | UF_INTERDOMAIN_TRUST_ACCOUNT - | UF_WORKSTATION_TRUST_ACCOUNT - | UF_SERVER_TRUST_ACCOUNT -) -UF_DONT_EXPIRE_PASSWD = 65536 -UF_MNS_LOGON_ACCOUNT = 131072 -UF_SETTABLE_BITS = ( - UF_SCRIPT - | UF_ACCOUNTDISABLE - | UF_LOCKOUT - | UF_HOMEDIR_REQUIRED - | UF_PASSWD_NOTREQD - | UF_PASSWD_CANT_CHANGE - | UF_ACCOUNT_TYPE_MASK - | UF_DONT_EXPIRE_PASSWD - | UF_MNS_LOGON_ACCOUNT -) -FILTER_TEMP_DUPLICATE_ACCOUNT = (1) -FILTER_NORMAL_ACCOUNT = (2) -FILTER_INTERDOMAIN_TRUST_ACCOUNT = (8) -FILTER_WORKSTATION_TRUST_ACCOUNT = (16) -FILTER_SERVER_TRUST_ACCOUNT = (32) -LG_INCLUDE_INDIRECT = (1) -AF_OP_PRINT = 1 -AF_OP_COMM = 2 -AF_OP_SERVER = 4 -AF_OP_ACCOUNTS = 8 -AF_SETTABLE_BITS = (AF_OP_PRINT | AF_OP_COMM - | AF_OP_SERVER | AF_OP_ACCOUNTS) -UAS_ROLE_STANDALONE = 0 -UAS_ROLE_MEMBER = 1 -UAS_ROLE_BACKUP = 2 -UAS_ROLE_PRIMARY = 3 -USER_NAME_PARMNUM = 1 -USER_PASSWORD_PARMNUM = 3 -USER_PASSWORD_AGE_PARMNUM = 4 -USER_PRIV_PARMNUM = 5 -USER_HOME_DIR_PARMNUM = 6 -USER_COMMENT_PARMNUM = 7 -USER_FLAGS_PARMNUM = 8 -USER_SCRIPT_PATH_PARMNUM = 9 -USER_AUTH_FLAGS_PARMNUM = 10 -USER_FULL_NAME_PARMNUM = 11 -USER_USR_COMMENT_PARMNUM = 12 -USER_PARMS_PARMNUM = 13 -USER_WORKSTATIONS_PARMNUM = 14 -USER_LAST_LOGON_PARMNUM = 15 -USER_LAST_LOGOFF_PARMNUM = 16 -USER_ACCT_EXPIRES_PARMNUM = 17 -USER_MAX_STORAGE_PARMNUM = 18 -USER_UNITS_PER_WEEK_PARMNUM = 19 -USER_LOGON_HOURS_PARMNUM = 20 -USER_PAD_PW_COUNT_PARMNUM = 21 -USER_NUM_LOGONS_PARMNUM = 22 -USER_LOGON_SERVER_PARMNUM = 23 -USER_COUNTRY_CODE_PARMNUM = 24 -USER_CODE_PAGE_PARMNUM = 25 -USER_PRIMARY_GROUP_PARMNUM = 51 -USER_PROFILE = 52 -USER_PROFILE_PARMNUM = 52 -USER_HOME_DIR_DRIVE_PARMNUM = 53 -USER_NAME_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_NAME_PARMNUM) -USER_PASSWORD_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_PASSWORD_PARMNUM) -USER_PASSWORD_AGE_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_PASSWORD_AGE_PARMNUM) -USER_PRIV_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_PRIV_PARMNUM) -USER_HOME_DIR_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_HOME_DIR_PARMNUM) -USER_COMMENT_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_COMMENT_PARMNUM) -USER_FLAGS_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_FLAGS_PARMNUM) -USER_SCRIPT_PATH_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_SCRIPT_PATH_PARMNUM) -USER_AUTH_FLAGS_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_AUTH_FLAGS_PARMNUM) -USER_FULL_NAME_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_FULL_NAME_PARMNUM) -USER_USR_COMMENT_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_USR_COMMENT_PARMNUM) -USER_PARMS_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_PARMS_PARMNUM) -USER_WORKSTATIONS_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_WORKSTATIONS_PARMNUM) -USER_LAST_LOGON_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_LAST_LOGON_PARMNUM) -USER_LAST_LOGOFF_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_LAST_LOGOFF_PARMNUM) -USER_ACCT_EXPIRES_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_ACCT_EXPIRES_PARMNUM) -USER_MAX_STORAGE_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_MAX_STORAGE_PARMNUM) -USER_UNITS_PER_WEEK_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_UNITS_PER_WEEK_PARMNUM) -USER_LOGON_HOURS_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_LOGON_HOURS_PARMNUM) -USER_PAD_PW_COUNT_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_PAD_PW_COUNT_PARMNUM) -USER_NUM_LOGONS_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_NUM_LOGONS_PARMNUM) -USER_LOGON_SERVER_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_LOGON_SERVER_PARMNUM) -USER_COUNTRY_CODE_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_COUNTRY_CODE_PARMNUM) -USER_CODE_PAGE_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_CODE_PAGE_PARMNUM) -USER_PRIMARY_GROUP_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_PRIMARY_GROUP_PARMNUM) -USER_HOME_DIR_DRIVE_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + USER_HOME_DIR_DRIVE_PARMNUM) -NULL_USERSETINFO_PASSWD = " " -UNITS_PER_DAY = 24 -UNITS_PER_WEEK = UNITS_PER_DAY * 7 -USER_PRIV_MASK = 3 -USER_PRIV_GUEST = 0 -USER_PRIV_USER = 1 -USER_PRIV_ADMIN = 2 -MAX_PASSWD_LEN = PWLEN -DEF_MIN_PWLEN = 6 -DEF_PWUNIQUENESS = 5 -DEF_MAX_PWHIST = 8 -DEF_MAX_BADPW = 0 -VALIDATED_LOGON = 0 -PASSWORD_EXPIRED = 2 -NON_VALIDATED_LOGON = 3 -VALID_LOGOFF = 1 -MODALS_MIN_PASSWD_LEN_PARMNUM = 1 -MODALS_MAX_PASSWD_AGE_PARMNUM = 2 -MODALS_MIN_PASSWD_AGE_PARMNUM = 3 -MODALS_FORCE_LOGOFF_PARMNUM = 4 -MODALS_PASSWD_HIST_LEN_PARMNUM = 5 -MODALS_ROLE_PARMNUM = 6 -MODALS_PRIMARY_PARMNUM = 7 -MODALS_DOMAIN_NAME_PARMNUM = 8 -MODALS_DOMAIN_ID_PARMNUM = 9 -MODALS_LOCKOUT_DURATION_PARMNUM = 10 -MODALS_LOCKOUT_OBSERVATION_WINDOW_PARMNUM = 11 -MODALS_LOCKOUT_THRESHOLD_PARMNUM = 12 -MODALS_MIN_PASSWD_LEN_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_MIN_PASSWD_LEN_PARMNUM) -MODALS_MAX_PASSWD_AGE_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_MAX_PASSWD_AGE_PARMNUM) -MODALS_MIN_PASSWD_AGE_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_MIN_PASSWD_AGE_PARMNUM) -MODALS_FORCE_LOGOFF_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_FORCE_LOGOFF_PARMNUM) -MODALS_PASSWD_HIST_LEN_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_PASSWD_HIST_LEN_PARMNUM) -MODALS_ROLE_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_ROLE_PARMNUM) -MODALS_PRIMARY_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_PRIMARY_PARMNUM) -MODALS_DOMAIN_NAME_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_DOMAIN_NAME_PARMNUM) -MODALS_DOMAIN_ID_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + MODALS_DOMAIN_ID_PARMNUM) -GROUPIDMASK = 32768 -GROUP_ALL_PARMNUM = 0 -GROUP_NAME_PARMNUM = 1 -GROUP_COMMENT_PARMNUM = 2 -GROUP_ATTRIBUTES_PARMNUM = 3 -GROUP_ALL_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + GROUP_ALL_PARMNUM) -GROUP_NAME_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + GROUP_NAME_PARMNUM) -GROUP_COMMENT_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + GROUP_COMMENT_PARMNUM) -GROUP_ATTRIBUTES_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + GROUP_ATTRIBUTES_PARMNUM) -LOCALGROUP_NAME_PARMNUM = 1 -LOCALGROUP_COMMENT_PARMNUM = 2 -MAXPERMENTRIES = 64 -ACCESS_NONE = 0 -ACCESS_READ = 1 -ACCESS_WRITE = 2 -ACCESS_CREATE = 4 -ACCESS_EXEC = 8 -ACCESS_DELETE = 16 -ACCESS_ATRIB = 32 -ACCESS_PERM = 64 -ACCESS_GROUP = 32768 -ACCESS_AUDIT = 1 -ACCESS_SUCCESS_OPEN = 16 -ACCESS_SUCCESS_WRITE = 32 -ACCESS_SUCCESS_DELETE = 64 -ACCESS_SUCCESS_ACL = 128 -ACCESS_SUCCESS_MASK = 240 -ACCESS_FAIL_OPEN = 256 -ACCESS_FAIL_WRITE = 512 -ACCESS_FAIL_DELETE = 1024 -ACCESS_FAIL_ACL = 2048 -ACCESS_FAIL_MASK = 3840 -ACCESS_FAIL_SHIFT = 4 -ACCESS_RESOURCE_NAME_PARMNUM = 1 -ACCESS_ATTR_PARMNUM = 2 -ACCESS_COUNT_PARMNUM = 3 -ACCESS_ACCESS_LIST_PARMNUM = 4 -ACCESS_RESOURCE_NAME_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + ACCESS_RESOURCE_NAME_PARMNUM) -ACCESS_ATTR_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + ACCESS_ATTR_PARMNUM) -ACCESS_COUNT_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + ACCESS_COUNT_PARMNUM) -ACCESS_ACCESS_LIST_INFOLEVEL = \ - (PARMNUM_BASE_INFOLEVEL + ACCESS_ACCESS_LIST_PARMNUM) -ACCESS_LETTERS = "RWCXDAP " -NETLOGON_CONTROL_QUERY = 1 -NETLOGON_CONTROL_REPLICATE = 2 -NETLOGON_CONTROL_SYNCHRONIZE = 3 -NETLOGON_CONTROL_PDC_REPLICATE = 4 -NETLOGON_CONTROL_REDISCOVER = 5 -NETLOGON_CONTROL_TC_QUERY = 6 -NETLOGON_CONTROL_TRANSPORT_NOTIFY = 7 -NETLOGON_CONTROL_FIND_USER = 8 -NETLOGON_CONTROL_UNLOAD_NETLOGON_DLL = 65531 -NETLOGON_CONTROL_BACKUP_CHANGE_LOG = 65532 -NETLOGON_CONTROL_TRUNCATE_LOG = 65533 -NETLOGON_CONTROL_SET_DBFLAG = 65534 -NETLOGON_CONTROL_BREAKPOINT = 65535 -NETLOGON_REPLICATION_NEEDED = 1 -NETLOGON_REPLICATION_IN_PROGRESS = 2 -NETLOGON_FULL_SYNC_REPLICATION = 4 -NETLOGON_REDO_NEEDED = 8 - -###################### -# Manual stuff - - -def TEXT(x): - ... - - -MAX_PREFERRED_LENGTH = -1 -PARM_ERROR_UNKNOWN = -1 -MESSAGE_FILENAME = TEXT("NETMSG") -OS2MSG_FILENAME = TEXT("BASE") -HELP_MSG_FILENAME = TEXT("NETH") -BACKUP_MSG_FILENAME = TEXT("BAK.MSG") -TIMEQ_FOREVER = -1 -USER_MAXSTORAGE_UNLIMITED = -1 -USER_NO_LOGOFF = -1 -DEF_MAX_PWAGE = TIMEQ_FOREVER -DEF_MIN_PWAGE = 0 -DEF_FORCE_LOGOFF = -1 -ONE_DAY = 1 * 24 * 3600 -GROUP_SPECIALGRP_USERS = "USERS" -GROUP_SPECIALGRP_ADMINS = "ADMINS" -GROUP_SPECIALGRP_GUESTS = "GUESTS" -GROUP_SPECIALGRP_LOCAL = "LOCAL" -ACCESS_ALL = (ACCESS_READ | ACCESS_WRITE | ACCESS_CREATE | ACCESS_EXEC | ACCESS_DELETE | ACCESS_ATRIB | ACCESS_PERM) - -# From lmserver.h -SV_PLATFORM_ID_OS2 = 400 -SV_PLATFORM_ID_NT = 500 -MAJOR_VERSION_MASK = 15 -SV_TYPE_WORKSTATION = 1 -SV_TYPE_SERVER = 2 -SV_TYPE_SQLSERVER = 4 -SV_TYPE_DOMAIN_CTRL = 8 -SV_TYPE_DOMAIN_BAKCTRL = 16 -SV_TYPE_TIME_SOURCE = 32 -SV_TYPE_AFP = 64 -SV_TYPE_NOVELL = 128 -SV_TYPE_DOMAIN_MEMBER = 256 -SV_TYPE_PRINTQ_SERVER = 512 -SV_TYPE_DIALIN_SERVER = 1024 -SV_TYPE_XENIX_SERVER = 2048 -SV_TYPE_SERVER_UNIX = SV_TYPE_XENIX_SERVER -SV_TYPE_NT = 4096 -SV_TYPE_WFW = 8192 -SV_TYPE_SERVER_MFPN = 16384 -SV_TYPE_SERVER_NT = 32768 -SV_TYPE_POTENTIAL_BROWSER = 65536 -SV_TYPE_BACKUP_BROWSER = 131072 -SV_TYPE_MASTER_BROWSER = 262144 -SV_TYPE_DOMAIN_MASTER = 524288 -SV_TYPE_SERVER_OSF = 1048576 -SV_TYPE_SERVER_VMS = 2097152 -SV_TYPE_WINDOWS = 4194304 -SV_TYPE_DFS = 8388608 -SV_TYPE_CLUSTER_NT = 16777216 -SV_TYPE_DCE = 268435456 -SV_TYPE_ALTERNATE_XPORT = 536870912 -SV_TYPE_LOCAL_LIST_ONLY = 1073741824 -SV_TYPE_DOMAIN_ENUM = -2147483648 -SV_TYPE_ALL = -1 -SV_NODISC = -1 -SV_USERSECURITY = 1 -SV_SHARESECURITY = 0 -SV_HIDDEN = 1 -SV_VISIBLE = 0 -SV_PLATFORM_ID_PARMNUM = 101 -SV_NAME_PARMNUM = 102 -SV_VERSION_MAJOR_PARMNUM = 103 -SV_VERSION_MINOR_PARMNUM = 104 -SV_TYPE_PARMNUM = 105 -SV_COMMENT_PARMNUM = 5 -SV_USERS_PARMNUM = 107 -SV_DISC_PARMNUM = 10 -SV_HIDDEN_PARMNUM = 16 -SV_ANNOUNCE_PARMNUM = 17 -SV_ANNDELTA_PARMNUM = 18 -SV_USERPATH_PARMNUM = 112 -SV_ULIST_MTIME_PARMNUM = 401 -SV_GLIST_MTIME_PARMNUM = 402 -SV_ALIST_MTIME_PARMNUM = 403 -SV_ALERTS_PARMNUM = 11 -SV_SECURITY_PARMNUM = 405 -SV_NUMADMIN_PARMNUM = 406 -SV_LANMASK_PARMNUM = 407 -SV_GUESTACC_PARMNUM = 408 -SV_CHDEVQ_PARMNUM = 410 -SV_CHDEVJOBS_PARMNUM = 411 -SV_CONNECTIONS_PARMNUM = 412 -SV_SHARES_PARMNUM = 413 -SV_OPENFILES_PARMNUM = 414 -SV_SESSREQS_PARMNUM = 417 -SV_ACTIVELOCKS_PARMNUM = 419 -SV_NUMREQBUF_PARMNUM = 420 -SV_NUMBIGBUF_PARMNUM = 422 -SV_NUMFILETASKS_PARMNUM = 423 -SV_ALERTSCHED_PARMNUM = 37 -SV_ERRORALERT_PARMNUM = 38 -SV_LOGONALERT_PARMNUM = 39 -SV_ACCESSALERT_PARMNUM = 40 -SV_DISKALERT_PARMNUM = 41 -SV_NETIOALERT_PARMNUM = 42 -SV_MAXAUDITSZ_PARMNUM = 43 -SV_SRVHEURISTICS_PARMNUM = 431 -SV_SESSOPENS_PARMNUM = 501 -SV_SESSVCS_PARMNUM = 502 -SV_OPENSEARCH_PARMNUM = 503 -SV_SIZREQBUF_PARMNUM = 504 -SV_INITWORKITEMS_PARMNUM = 505 -SV_MAXWORKITEMS_PARMNUM = 506 -SV_RAWWORKITEMS_PARMNUM = 507 -SV_IRPSTACKSIZE_PARMNUM = 508 -SV_MAXRAWBUFLEN_PARMNUM = 509 -SV_SESSUSERS_PARMNUM = 510 -SV_SESSCONNS_PARMNUM = 511 -SV_MAXNONPAGEDMEMORYUSAGE_PARMNUM = 512 -SV_MAXPAGEDMEMORYUSAGE_PARMNUM = 513 -SV_ENABLESOFTCOMPAT_PARMNUM = 514 -SV_ENABLEFORCEDLOGOFF_PARMNUM = 515 -SV_TIMESOURCE_PARMNUM = 516 -SV_ACCEPTDOWNLEVELAPIS_PARMNUM = 517 -SV_LMANNOUNCE_PARMNUM = 518 -SV_DOMAIN_PARMNUM = 519 -SV_MAXCOPYREADLEN_PARMNUM = 520 -SV_MAXCOPYWRITELEN_PARMNUM = 521 -SV_MINKEEPSEARCH_PARMNUM = 522 -SV_MAXKEEPSEARCH_PARMNUM = 523 -SV_MINKEEPCOMPLSEARCH_PARMNUM = 524 -SV_MAXKEEPCOMPLSEARCH_PARMNUM = 525 -SV_THREADCOUNTADD_PARMNUM = 526 -SV_NUMBLOCKTHREADS_PARMNUM = 527 -SV_SCAVTIMEOUT_PARMNUM = 528 -SV_MINRCVQUEUE_PARMNUM = 529 -SV_MINFREEWORKITEMS_PARMNUM = 530 -SV_XACTMEMSIZE_PARMNUM = 531 -SV_THREADPRIORITY_PARMNUM = 532 -SV_MAXMPXCT_PARMNUM = 533 -SV_OPLOCKBREAKWAIT_PARMNUM = 534 -SV_OPLOCKBREAKRESPONSEWAIT_PARMNUM = 535 -SV_ENABLEOPLOCKS_PARMNUM = 536 -SV_ENABLEOPLOCKFORCECLOSE_PARMNUM = 537 -SV_ENABLEFCBOPENS_PARMNUM = 538 -SV_ENABLERAW_PARMNUM = 539 -SV_ENABLESHAREDNETDRIVES_PARMNUM = 540 -SV_MINFREECONNECTIONS_PARMNUM = 541 -SV_MAXFREECONNECTIONS_PARMNUM = 542 -SV_INITSESSTABLE_PARMNUM = 543 -SV_INITCONNTABLE_PARMNUM = 544 -SV_INITFILETABLE_PARMNUM = 545 -SV_INITSEARCHTABLE_PARMNUM = 546 -SV_ALERTSCHEDULE_PARMNUM = 547 -SV_ERRORTHRESHOLD_PARMNUM = 548 -SV_NETWORKERRORTHRESHOLD_PARMNUM = 549 -SV_DISKSPACETHRESHOLD_PARMNUM = 550 -SV_MAXLINKDELAY_PARMNUM = 552 -SV_MINLINKTHROUGHPUT_PARMNUM = 553 -SV_LINKINFOVALIDTIME_PARMNUM = 554 -SV_SCAVQOSINFOUPDATETIME_PARMNUM = 555 -SV_MAXWORKITEMIDLETIME_PARMNUM = 556 -SV_MAXRAWWORKITEMS_PARMNUM = 557 -SV_PRODUCTTYPE_PARMNUM = 560 -SV_SERVERSIZE_PARMNUM = 561 -SV_CONNECTIONLESSAUTODISC_PARMNUM = 562 -SV_SHARINGVIOLATIONRETRIES_PARMNUM = 563 -SV_SHARINGVIOLATIONDELAY_PARMNUM = 564 -SV_MAXGLOBALOPENSEARCH_PARMNUM = 565 -SV_REMOVEDUPLICATESEARCHES_PARMNUM = 566 -SV_LOCKVIOLATIONRETRIES_PARMNUM = 567 -SV_LOCKVIOLATIONOFFSET_PARMNUM = 568 -SV_LOCKVIOLATIONDELAY_PARMNUM = 569 -SV_MDLREADSWITCHOVER_PARMNUM = 570 -SV_CACHEDOPENLIMIT_PARMNUM = 571 -SV_CRITICALTHREADS_PARMNUM = 572 -SV_RESTRICTNULLSESSACCESS_PARMNUM = 573 -SV_ENABLEWFW311DIRECTIPX_PARMNUM = 574 -SV_OTHERQUEUEAFFINITY_PARMNUM = 575 -SV_QUEUESAMPLESECS_PARMNUM = 576 -SV_BALANCECOUNT_PARMNUM = 577 -SV_PREFERREDAFFINITY_PARMNUM = 578 -SV_MAXFREERFCBS_PARMNUM = 579 -SV_MAXFREEMFCBS_PARMNUM = 580 -SV_MAXFREELFCBS_PARMNUM = 581 -SV_MAXFREEPAGEDPOOLCHUNKS_PARMNUM = 582 -SV_MINPAGEDPOOLCHUNKSIZE_PARMNUM = 583 -SV_MAXPAGEDPOOLCHUNKSIZE_PARMNUM = 584 -SV_SENDSFROMPREFERREDPROCESSOR_PARMNUM = 585 -SV_MAXTHREADSPERQUEUE_PARMNUM = 586 -SV_CACHEDDIRECTORYLIMIT_PARMNUM = 587 -SV_MAXCOPYLENGTH_PARMNUM = 588 -SV_ENABLEBULKTRANSFER_PARMNUM = 589 -SV_ENABLECOMPRESSION_PARMNUM = 590 -SV_AUTOSHAREWKS_PARMNUM = 591 -SV_AUTOSHARESERVER_PARMNUM = 592 -SV_ENABLESECURITYSIGNATURE_PARMNUM = 593 -SV_REQUIRESECURITYSIGNATURE_PARMNUM = 594 -SV_MINCLIENTBUFFERSIZE_PARMNUM = 595 -SV_CONNECTIONNOSESSIONSTIMEOUT_PARMNUM = 596 -SVI1_NUM_ELEMENTS = 5 -SVI2_NUM_ELEMENTS = 40 -SVI3_NUM_ELEMENTS = 44 -SW_AUTOPROF_LOAD_MASK = 1 -SW_AUTOPROF_SAVE_MASK = 2 -SV_MAX_SRV_HEUR_LEN = 32 -SV_USERS_PER_LICENSE = 5 -SVTI2_REMAP_PIPE_NAMES = 2 - -# Generated by h2py from lmshare.h -SHARE_NETNAME_PARMNUM = 1 -SHARE_TYPE_PARMNUM = 3 -SHARE_REMARK_PARMNUM = 4 -SHARE_PERMISSIONS_PARMNUM = 5 -SHARE_MAX_USES_PARMNUM = 6 -SHARE_CURRENT_USES_PARMNUM = 7 -SHARE_PATH_PARMNUM = 8 -SHARE_PASSWD_PARMNUM = 9 -SHARE_FILE_SD_PARMNUM = 501 -SHI1_NUM_ELEMENTS = 4 -SHI2_NUM_ELEMENTS = 10 -STYPE_DISKTREE = 0 -STYPE_PRINTQ = 1 -STYPE_DEVICE = 2 -STYPE_IPC = 3 -STYPE_SPECIAL = -2147483648 -SHI1005_FLAGS_DFS = 1 -SHI1005_FLAGS_DFS_ROOT = 2 -COW_PERMACHINE = 4 -COW_PERUSER = 8 -CSC_CACHEABLE = 16 -CSC_NOFLOWOPS = 32 -CSC_AUTO_INWARD = 64 -CSC_AUTO_OUTWARD = 128 -SHI1005_VALID_FLAGS_SET = (CSC_CACHEABLE - | CSC_NOFLOWOPS - | CSC_AUTO_INWARD - | CSC_AUTO_OUTWARD - | COW_PERMACHINE - | COW_PERUSER) -SHI1007_VALID_FLAGS_SET = SHI1005_VALID_FLAGS_SET -SESS_GUEST = 1 -SESS_NOENCRYPTION = 2 -SESI1_NUM_ELEMENTS = 8 -SESI2_NUM_ELEMENTS = 9 -PERM_FILE_READ = 1 -PERM_FILE_WRITE = 2 -PERM_FILE_CREATE = 4 - -# Generated by h2py from d:\mssdk\include\winnetwk.h -WNNC_NET_MSNET = 65536 -WNNC_NET_LANMAN = 131072 -WNNC_NET_NETWARE = 196608 -WNNC_NET_VINES = 262144 -WNNC_NET_10NET = 327680 -WNNC_NET_LOCUS = 393216 -WNNC_NET_SUN_PC_NFS = 458752 -WNNC_NET_LANSTEP = 524288 -WNNC_NET_9TILES = 589824 -WNNC_NET_LANTASTIC = 655360 -WNNC_NET_AS400 = 720896 -WNNC_NET_FTP_NFS = 786432 -WNNC_NET_PATHWORKS = 851968 -WNNC_NET_LIFENET = 917504 -WNNC_NET_POWERLAN = 983040 -WNNC_NET_BWNFS = 1048576 -WNNC_NET_COGENT = 1114112 -WNNC_NET_FARALLON = 1179648 -WNNC_NET_APPLETALK = 1245184 -WNNC_NET_INTERGRAPH = 1310720 -WNNC_NET_SYMFONET = 1376256 -WNNC_NET_CLEARCASE = 1441792 -WNNC_NET_FRONTIER = 1507328 -WNNC_NET_BMC = 1572864 -WNNC_NET_DCE = 1638400 -WNNC_NET_DECORB = 2097152 -WNNC_NET_PROTSTOR = 2162688 -WNNC_NET_FJ_REDIR = 2228224 -WNNC_NET_DISTINCT = 2293760 -WNNC_NET_TWINS = 2359296 -WNNC_NET_RDR2SAMPLE = 2424832 -RESOURCE_CONNECTED = 1 -RESOURCE_GLOBALNET = 2 -RESOURCE_REMEMBERED = 3 -RESOURCE_RECENT = 4 -RESOURCE_CONTEXT = 5 -RESOURCETYPE_ANY = 0 -RESOURCETYPE_DISK = 1 -RESOURCETYPE_PRINT = 2 -RESOURCETYPE_RESERVED = 8 -RESOURCETYPE_UNKNOWN = -1 -RESOURCEUSAGE_CONNECTABLE = 1 -RESOURCEUSAGE_CONTAINER = 2 -RESOURCEUSAGE_NOLOCALDEVICE = 4 -RESOURCEUSAGE_SIBLING = 8 -RESOURCEUSAGE_ATTACHED = 16 -RESOURCEUSAGE_ALL = (RESOURCEUSAGE_CONNECTABLE | RESOURCEUSAGE_CONTAINER | RESOURCEUSAGE_ATTACHED) -RESOURCEUSAGE_RESERVED = -2147483648 -RESOURCEDISPLAYTYPE_GENERIC = 0 -RESOURCEDISPLAYTYPE_DOMAIN = 1 -RESOURCEDISPLAYTYPE_SERVER = 2 -RESOURCEDISPLAYTYPE_SHARE = 3 -RESOURCEDISPLAYTYPE_FILE = 4 -RESOURCEDISPLAYTYPE_GROUP = 5 -RESOURCEDISPLAYTYPE_NETWORK = 6 -RESOURCEDISPLAYTYPE_ROOT = 7 -RESOURCEDISPLAYTYPE_SHAREADMIN = 8 -RESOURCEDISPLAYTYPE_DIRECTORY = 9 -RESOURCEDISPLAYTYPE_TREE = 10 -RESOURCEDISPLAYTYPE_NDSCONTAINER = 11 -NETPROPERTY_PERSISTENT = 1 -CONNECT_UPDATE_PROFILE = 1 -CONNECT_UPDATE_RECENT = 2 -CONNECT_TEMPORARY = 4 -CONNECT_INTERACTIVE = 8 -CONNECT_PROMPT = 16 -CONNECT_NEED_DRIVE = 32 -CONNECT_REFCOUNT = 64 -CONNECT_REDIRECT = 128 -CONNECT_LOCALDRIVE = 256 -CONNECT_CURRENT_MEDIA = 512 -CONNECT_DEFERRED = 1024 -CONNECT_RESERVED = -16777216 -CONNDLG_RO_PATH = 1 -CONNDLG_CONN_POINT = 2 -CONNDLG_USE_MRU = 4 -CONNDLG_HIDE_BOX = 8 -CONNDLG_PERSIST = 16 -CONNDLG_NOT_PERSIST = 32 -DISC_UPDATE_PROFILE = 1 -DISC_NO_FORCE = 64 -UNIVERSAL_NAME_INFO_LEVEL = 1 -REMOTE_NAME_INFO_LEVEL = 2 -WNFMT_MULTILINE = 1 -WNFMT_ABBREVIATED = 2 -WNFMT_INENUM = 16 -WNFMT_CONNECTION = 32 -NETINFO_DLL16 = 1 -NETINFO_DISKRED = 4 -NETINFO_PRINTERRED = 8 -RP_LOGON = 1 -RP_INIFILE = 2 -PP_DISPLAYERRORS = 1 -WNCON_FORNETCARD = 1 -WNCON_NOTROUTED = 2 -WNCON_SLOWLINK = 4 -WNCON_DYNAMIC = 8 - -# NETSETUP_NAME_TYPE, used with NetValidateName -NetSetupUnknown = 0 -NetSetupMachine = 1 -NetSetupWorkgroup = 2 -NetSetupDomain = 3 -NetSetupNonExistentDomain = 4 -NetSetupDnsMachine = 5 - -# NETSETUP_JOIN_STATUS, use with NetGetJoinInformation -NetSetupUnknownStatus = 0 -NetSetupUnjoined = 1 -NetSetupWorkgroupName = 2 -NetSetupDomainName = 3 - -NetValidateAuthentication = 1 -NetValidatePasswordChange = 2 -NetValidatePasswordReset = 3 diff --git a/typings/win32helper/winioctlcon.pyi b/typings/win32helper/winioctlcon.pyi deleted file mode 100644 index 0caf7167..00000000 --- a/typings/win32helper/winioctlcon.pyi +++ /dev/null @@ -1,751 +0,0 @@ -# flags, enums, guids used with DeviceIoControl from WinIoCtl.h - -import pywintypes -from ntsecuritycon import FILE_READ_DATA, FILE_WRITE_DATA - - -def CTL_CODE(DeviceType, Function, Method, Access): - ... - - -def DEVICE_TYPE_FROM_CTL_CODE(ctrlCode) -> int: - ... - - -FILE_DEVICE_BEEP = 0x00000001 -FILE_DEVICE_CD_ROM = 0x00000002 -FILE_DEVICE_CD_ROM_FILE_SYSTEM = 0x00000003 -FILE_DEVICE_CONTROLLER = 0x00000004 -FILE_DEVICE_DATALINK = 0x00000005 -FILE_DEVICE_DFS = 0x00000006 -FILE_DEVICE_DISK = 0x00000007 -FILE_DEVICE_DISK_FILE_SYSTEM = 0x00000008 -FILE_DEVICE_FILE_SYSTEM = 0x00000009 -FILE_DEVICE_INPORT_PORT = 0x0000000a -FILE_DEVICE_KEYBOARD = 0x0000000b -FILE_DEVICE_MAILSLOT = 0x0000000c -FILE_DEVICE_MIDI_IN = 0x0000000d -FILE_DEVICE_MIDI_OUT = 0x0000000e -FILE_DEVICE_MOUSE = 0x0000000f -FILE_DEVICE_MULTI_UNC_PROVIDER = 0x00000010 -FILE_DEVICE_NAMED_PIPE = 0x00000011 -FILE_DEVICE_NETWORK = 0x00000012 -FILE_DEVICE_NETWORK_BROWSER = 0x00000013 -FILE_DEVICE_NETWORK_FILE_SYSTEM = 0x00000014 -FILE_DEVICE_NULL = 0x00000015 -FILE_DEVICE_PARALLEL_PORT = 0x00000016 -FILE_DEVICE_PHYSICAL_NETCARD = 0x00000017 -FILE_DEVICE_PRINTER = 0x00000018 -FILE_DEVICE_SCANNER = 0x00000019 -FILE_DEVICE_SERIAL_MOUSE_PORT = 0x0000001a -FILE_DEVICE_SERIAL_PORT = 0x0000001b -FILE_DEVICE_SCREEN = 0x0000001c -FILE_DEVICE_SOUND = 0x0000001d -FILE_DEVICE_STREAMS = 0x0000001e -FILE_DEVICE_TAPE = 0x0000001f -FILE_DEVICE_TAPE_FILE_SYSTEM = 0x00000020 -FILE_DEVICE_TRANSPORT = 0x00000021 -FILE_DEVICE_UNKNOWN = 0x00000022 -FILE_DEVICE_VIDEO = 0x00000023 -FILE_DEVICE_VIRTUAL_DISK = 0x00000024 -FILE_DEVICE_WAVE_IN = 0x00000025 -FILE_DEVICE_WAVE_OUT = 0x00000026 -FILE_DEVICE_8042_PORT = 0x00000027 -FILE_DEVICE_NETWORK_REDIRECTOR = 0x00000028 -FILE_DEVICE_BATTERY = 0x00000029 -FILE_DEVICE_BUS_EXTENDER = 0x0000002a -FILE_DEVICE_MODEM = 0x0000002b -FILE_DEVICE_VDM = 0x0000002c -FILE_DEVICE_MASS_STORAGE = 0x0000002d -FILE_DEVICE_SMB = 0x0000002e -FILE_DEVICE_KS = 0x0000002f -FILE_DEVICE_CHANGER = 0x00000030 -FILE_DEVICE_SMARTCARD = 0x00000031 -FILE_DEVICE_ACPI = 0x00000032 -FILE_DEVICE_DVD = 0x00000033 -FILE_DEVICE_FULLSCREEN_VIDEO = 0x00000034 -FILE_DEVICE_DFS_FILE_SYSTEM = 0x00000035 -FILE_DEVICE_DFS_VOLUME = 0x00000036 -FILE_DEVICE_SERENUM = 0x00000037 -FILE_DEVICE_TERMSRV = 0x00000038 -FILE_DEVICE_KSEC = 0x00000039 -FILE_DEVICE_FIPS = 0x0000003A -FILE_DEVICE_INFINIBAND = 0x0000003B - -METHOD_BUFFERED = 0 -METHOD_IN_DIRECT = 1 -METHOD_OUT_DIRECT = 2 -METHOD_NEITHER = 3 -METHOD_DIRECT_TO_HARDWARE = METHOD_IN_DIRECT -METHOD_DIRECT_FROM_HARDWARE = METHOD_OUT_DIRECT -FILE_ANY_ACCESS = 0 -FILE_SPECIAL_ACCESS = FILE_ANY_ACCESS -FILE_READ_ACCESS = 0x0001 -FILE_WRITE_ACCESS = 0x0002 -IOCTL_STORAGE_BASE = FILE_DEVICE_MASS_STORAGE -RECOVERED_WRITES_VALID = 0x00000001 -UNRECOVERED_WRITES_VALID = 0x00000002 -RECOVERED_READS_VALID = 0x00000004 -UNRECOVERED_READS_VALID = 0x00000008 -WRITE_COMPRESSION_INFO_VALID = 0x00000010 -READ_COMPRESSION_INFO_VALID = 0x00000020 -TAPE_RETURN_STATISTICS = 0 -TAPE_RETURN_ENV_INFO = 1 -TAPE_RESET_STATISTICS = 2 -MEDIA_ERASEABLE = 0x00000001 -MEDIA_WRITE_ONCE = 0x00000002 -MEDIA_READ_ONLY = 0x00000004 -MEDIA_READ_WRITE = 0x00000008 -MEDIA_WRITE_PROTECTED = 0x00000100 -MEDIA_CURRENTLY_MOUNTED = 0x80000000 -IOCTL_DISK_BASE = FILE_DEVICE_DISK -PARTITION_ENTRY_UNUSED = 0x00 -PARTITION_FAT_12 = 0x01 -PARTITION_XENIX_1 = 0x02 -PARTITION_XENIX_2 = 0x03 -PARTITION_FAT_16 = 0x04 -PARTITION_EXTENDED = 0x05 -PARTITION_HUGE = 0x06 -PARTITION_IFS = 0x07 -PARTITION_OS2BOOTMGR = 0x0A -PARTITION_FAT32 = 0x0B -PARTITION_FAT32_XINT13 = 0x0C -PARTITION_XINT13 = 0x0E -PARTITION_XINT13_EXTENDED = 0x0F -PARTITION_PREP = 0x41 -PARTITION_LDM = 0x42 -PARTITION_UNIX = 0x63 -VALID_NTFT = 0xC0 -PARTITION_NTFT = 0x80 - -GPT_ATTRIBUTE_PLATFORM_REQUIRED = 0x0000000000000001 -GPT_BASIC_DATA_ATTRIBUTE_NO_DRIVE_LETTER = 0x8000000000000000 -GPT_BASIC_DATA_ATTRIBUTE_HIDDEN = 0x4000000000000000 -GPT_BASIC_DATA_ATTRIBUTE_SHADOW_COPY = 0x2000000000000000 -GPT_BASIC_DATA_ATTRIBUTE_READ_ONLY = 0x1000000000000000 - -HIST_NO_OF_BUCKETS = 24 -DISK_LOGGING_START = 0 -DISK_LOGGING_STOP = 1 -DISK_LOGGING_DUMP = 2 -DISK_BINNING = 3 -CAP_ATA_ID_CMD = 1 -CAP_ATAPI_ID_CMD = 2 -CAP_SMART_CMD = 4 -ATAPI_ID_CMD = 0xA1 -ID_CMD = 0xEC -SMART_CMD = 0xB0 -SMART_CYL_LOW = 0x4F -SMART_CYL_HI = 0xC2 -SMART_NO_ERROR = 0 -SMART_IDE_ERROR = 1 -SMART_INVALID_FLAG = 2 -SMART_INVALID_COMMAND = 3 -SMART_INVALID_BUFFER = 4 -SMART_INVALID_DRIVE = 5 -SMART_INVALID_IOCTL = 6 -SMART_ERROR_NO_MEM = 7 -SMART_INVALID_REGISTER = 8 -SMART_NOT_SUPPORTED = 9 -SMART_NO_IDE_DEVICE = 10 -SMART_OFFLINE_ROUTINE_OFFLINE = 0 -SMART_SHORT_SELFTEST_OFFLINE = 1 -SMART_EXTENDED_SELFTEST_OFFLINE = 2 -SMART_ABORT_OFFLINE_SELFTEST = 127 -SMART_SHORT_SELFTEST_CAPTIVE = 129 -SMART_EXTENDED_SELFTEST_CAPTIVE = 130 -READ_ATTRIBUTE_BUFFER_SIZE = 512 -IDENTIFY_BUFFER_SIZE = 512 -READ_THRESHOLD_BUFFER_SIZE = 512 -SMART_LOG_SECTOR_SIZE = 512 -READ_ATTRIBUTES = 0xD0 -READ_THRESHOLDS = 0xD1 -ENABLE_DISABLE_AUTOSAVE = 0xD2 -SAVE_ATTRIBUTE_VALUES = 0xD3 -EXECUTE_OFFLINE_DIAGS = 0xD4 -SMART_READ_LOG = 0xD5 -SMART_WRITE_LOG = 0xd6 -ENABLE_SMART = 0xD8 -DISABLE_SMART = 0xD9 -RETURN_SMART_STATUS = 0xDA -ENABLE_DISABLE_AUTO_OFFLINE = 0xDB -IOCTL_CHANGER_BASE = FILE_DEVICE_CHANGER -MAX_VOLUME_ID_SIZE = 36 -MAX_VOLUME_TEMPLATE_SIZE = 40 -VENDOR_ID_LENGTH = 8 -PRODUCT_ID_LENGTH = 16 -REVISION_LENGTH = 4 -SERIAL_NUMBER_LENGTH = 32 -CHANGER_BAR_CODE_SCANNER_INSTALLED = 0x00000001 -CHANGER_INIT_ELEM_STAT_WITH_RANGE = 0x00000002 -CHANGER_CLOSE_IEPORT = 0x00000004 -CHANGER_OPEN_IEPORT = 0x00000008 -CHANGER_STATUS_NON_VOLATILE = 0x00000010 -CHANGER_EXCHANGE_MEDIA = 0x00000020 -CHANGER_CLEANER_SLOT = 0x00000040 -CHANGER_LOCK_UNLOCK = 0x00000080 -CHANGER_CARTRIDGE_MAGAZINE = 0x00000100 -CHANGER_MEDIUM_FLIP = 0x00000200 -CHANGER_POSITION_TO_ELEMENT = 0x00000400 -CHANGER_REPORT_IEPORT_STATE = 0x00000800 -CHANGER_STORAGE_DRIVE = 0x00001000 -CHANGER_STORAGE_IEPORT = 0x00002000 -CHANGER_STORAGE_SLOT = 0x00004000 -CHANGER_STORAGE_TRANSPORT = 0x00008000 -CHANGER_DRIVE_CLEANING_REQUIRED = 0x00010000 -CHANGER_PREDISMOUNT_EJECT_REQUIRED = 0x00020000 -CHANGER_CLEANER_ACCESS_NOT_VALID = 0x00040000 -CHANGER_PREMOUNT_EJECT_REQUIRED = 0x00080000 -CHANGER_VOLUME_IDENTIFICATION = 0x00100000 -CHANGER_VOLUME_SEARCH = 0x00200000 -CHANGER_VOLUME_ASSERT = 0x00400000 -CHANGER_VOLUME_REPLACE = 0x00800000 -CHANGER_VOLUME_UNDEFINE = 0x01000000 -CHANGER_SERIAL_NUMBER_VALID = 0x04000000 -CHANGER_DEVICE_REINITIALIZE_CAPABLE = 0x08000000 -CHANGER_KEYPAD_ENABLE_DISABLE = 0x10000000 -CHANGER_DRIVE_EMPTY_ON_DOOR_ACCESS = 0x20000000 - -CHANGER_RESERVED_BIT = 0x80000000 -CHANGER_PREDISMOUNT_ALIGN_TO_SLOT = 0x80000001 -CHANGER_PREDISMOUNT_ALIGN_TO_DRIVE = 0x80000002 -CHANGER_CLEANER_AUTODISMOUNT = 0x80000004 -CHANGER_TRUE_EXCHANGE_CAPABLE = 0x80000008 -CHANGER_SLOTS_USE_TRAYS = 0x80000010 -CHANGER_RTN_MEDIA_TO_ORIGINAL_ADDR = 0x80000020 -CHANGER_CLEANER_OPS_NOT_SUPPORTED = 0x80000040 -CHANGER_IEPORT_USER_CONTROL_OPEN = 0x80000080 -CHANGER_IEPORT_USER_CONTROL_CLOSE = 0x80000100 -CHANGER_MOVE_EXTENDS_IEPORT = 0x80000200 -CHANGER_MOVE_RETRACTS_IEPORT = 0x80000400 - - -CHANGER_TO_TRANSPORT = 0x01 -CHANGER_TO_SLOT = 0x02 -CHANGER_TO_IEPORT = 0x04 -CHANGER_TO_DRIVE = 0x08 -LOCK_UNLOCK_IEPORT = 0x01 -LOCK_UNLOCK_DOOR = 0x02 -LOCK_UNLOCK_KEYPAD = 0x04 -LOCK_ELEMENT = 0 -UNLOCK_ELEMENT = 1 -EXTEND_IEPORT = 2 -RETRACT_IEPORT = 3 -ELEMENT_STATUS_FULL = 0x00000001 -ELEMENT_STATUS_IMPEXP = 0x00000002 -ELEMENT_STATUS_EXCEPT = 0x00000004 -ELEMENT_STATUS_ACCESS = 0x00000008 -ELEMENT_STATUS_EXENAB = 0x00000010 -ELEMENT_STATUS_INENAB = 0x00000020 -ELEMENT_STATUS_PRODUCT_DATA = 0x00000040 -ELEMENT_STATUS_LUN_VALID = 0x00001000 -ELEMENT_STATUS_ID_VALID = 0x00002000 -ELEMENT_STATUS_NOT_BUS = 0x00008000 -ELEMENT_STATUS_INVERT = 0x00400000 -ELEMENT_STATUS_SVALID = 0x00800000 -ELEMENT_STATUS_PVOLTAG = 0x10000000 -ELEMENT_STATUS_AVOLTAG = 0x20000000 -ERROR_LABEL_UNREADABLE = 0x00000001 -ERROR_LABEL_QUESTIONABLE = 0x00000002 -ERROR_SLOT_NOT_PRESENT = 0x00000004 -ERROR_DRIVE_NOT_INSTALLED = 0x00000008 -ERROR_TRAY_MALFUNCTION = 0x00000010 -ERROR_INIT_STATUS_NEEDED = 0x00000011 -ERROR_UNHANDLED_ERROR = 0xFFFFFFFF -SEARCH_ALL = 0x0 -SEARCH_PRIMARY = 0x1 -SEARCH_ALTERNATE = 0x2 -SEARCH_ALL_NO_SEQ = 0x4 -SEARCH_PRI_NO_SEQ = 0x5 -SEARCH_ALT_NO_SEQ = 0x6 -ASSERT_PRIMARY = 0x8 -ASSERT_ALTERNATE = 0x9 -REPLACE_PRIMARY = 0xA -REPLACE_ALTERNATE = 0xB -UNDEFINE_PRIMARY = 0xC -UNDEFINE_ALTERNATE = 0xD -USN_PAGE_SIZE = 0x1000 -USN_REASON_DATA_OVERWRITE = 0x00000001 -USN_REASON_DATA_EXTEND = 0x00000002 -USN_REASON_DATA_TRUNCATION = 0x00000004 -USN_REASON_NAMED_DATA_OVERWRITE = 0x00000010 -USN_REASON_NAMED_DATA_EXTEND = 0x00000020 -USN_REASON_NAMED_DATA_TRUNCATION = 0x00000040 -USN_REASON_FILE_CREATE = 0x00000100 -USN_REASON_FILE_DELETE = 0x00000200 -USN_REASON_EA_CHANGE = 0x00000400 -USN_REASON_SECURITY_CHANGE = 0x00000800 -USN_REASON_RENAME_OLD_NAME = 0x00001000 -USN_REASON_RENAME_NEW_NAME = 0x00002000 -USN_REASON_INDEXABLE_CHANGE = 0x00004000 -USN_REASON_BASIC_INFO_CHANGE = 0x00008000 -USN_REASON_HARD_LINK_CHANGE = 0x00010000 -USN_REASON_COMPRESSION_CHANGE = 0x00020000 -USN_REASON_ENCRYPTION_CHANGE = 0x00040000 -USN_REASON_OBJECT_ID_CHANGE = 0x00080000 -USN_REASON_REPARSE_POINT_CHANGE = 0x00100000 -USN_REASON_STREAM_CHANGE = 0x00200000 -USN_REASON_TRANSACTED_CHANGE = 0x00400000 -USN_REASON_CLOSE = 0x80000000 -USN_DELETE_FLAG_DELETE = 0x00000001 -USN_DELETE_FLAG_NOTIFY = 0x00000002 -USN_DELETE_VALID_FLAGS = 0x00000003 -USN_SOURCE_DATA_MANAGEMENT = 0x00000001 -USN_SOURCE_AUXILIARY_DATA = 0x00000002 -USN_SOURCE_REPLICATION_MANAGEMENT = 0x00000004 - -MARK_HANDLE_PROTECT_CLUSTERS = 1 -MARK_HANDLE_TXF_SYSTEM_LOG = 4 -MARK_HANDLE_NOT_TXF_SYSTEM_LOG = 8 - -VOLUME_IS_DIRTY = 0x00000001 -VOLUME_UPGRADE_SCHEDULED = 0x00000002 -VOLUME_SESSION_OPEN = 4 - -FILE_PREFETCH_TYPE_FOR_CREATE = 1 -FILE_PREFETCH_TYPE_FOR_DIRENUM = 2 -FILE_PREFETCH_TYPE_FOR_CREATE_EX = 3 -FILE_PREFETCH_TYPE_FOR_DIRENUM_EX = 4 -FILE_PREFETCH_TYPE_MAX = 4 - -FILESYSTEM_STATISTICS_TYPE_NTFS = 1 -FILESYSTEM_STATISTICS_TYPE_FAT = 2 -FILE_SET_ENCRYPTION = 0x00000001 -FILE_CLEAR_ENCRYPTION = 0x00000002 -STREAM_SET_ENCRYPTION = 0x00000003 -STREAM_CLEAR_ENCRYPTION = 0x00000004 -MAXIMUM_ENCRYPTION_VALUE = 0x00000004 -ENCRYPTION_FORMAT_DEFAULT = 0x01 -COMPRESSION_FORMAT_SPARSE = 0x4000 -COPYFILE_SIS_LINK = 0x0001 -COPYFILE_SIS_REPLACE = 0x0002 -COPYFILE_SIS_FLAGS = 0x0003 - -WMI_DISK_GEOMETRY_GUID = pywintypes.IID("{25007F51-57C2-11D1-A528-00A0C9062910}") -GUID_DEVINTERFACE_CDROM = pywintypes.IID("{53F56308-B6BF-11D0-94F2-00A0C91EFB8B}") -GUID_DEVINTERFACE_FLOPPY = pywintypes.IID("{53F56311-B6BF-11D0-94F2-00A0C91EFB8B}") -GUID_DEVINTERFACE_SERENUM_BUS_ENUMERATOR = pywintypes.IID("{4D36E978-E325-11CE-BFC1-08002BE10318}") -GUID_DEVINTERFACE_COMPORT = pywintypes.IID("{86E0D1E0-8089-11D0-9CE4-08003E301F73}") -GUID_DEVINTERFACE_DISK = pywintypes.IID("{53F56307-B6BF-11D0-94F2-00A0C91EFB8B}") -GUID_DEVINTERFACE_STORAGEPORT = pywintypes.IID("{2ACCFE60-C130-11D2-B082-00A0C91EFB8B}") -GUID_DEVINTERFACE_CDCHANGER = pywintypes.IID("{53F56312-B6BF-11D0-94F2-00A0C91EFB8B}") -GUID_DEVINTERFACE_PARTITION = pywintypes.IID("{53F5630A-B6BF-11D0-94F2-00A0C91EFB8B}") -GUID_DEVINTERFACE_VOLUME = pywintypes.IID("{53F5630D-B6BF-11D0-94F2-00A0C91EFB8B}") -GUID_DEVINTERFACE_WRITEONCEDISK = pywintypes.IID("{53F5630C-B6BF-11D0-94F2-00A0C91EFB8B}") -GUID_DEVINTERFACE_TAPE = pywintypes.IID("{53F5630B-B6BF-11D0-94F2-00A0C91EFB8B}") -GUID_DEVINTERFACE_MEDIUMCHANGER = pywintypes.IID("{53F56310-B6BF-11D0-94F2-00A0C91EFB8B}") -GUID_SERENUM_BUS_ENUMERATOR = GUID_DEVINTERFACE_SERENUM_BUS_ENUMERATOR -GUID_CLASS_COMPORT = GUID_DEVINTERFACE_COMPORT - -DiskClassGuid = GUID_DEVINTERFACE_DISK -CdRomClassGuid = GUID_DEVINTERFACE_CDROM -PartitionClassGuid = GUID_DEVINTERFACE_PARTITION -TapeClassGuid = GUID_DEVINTERFACE_TAPE -WriteOnceDiskClassGuid = GUID_DEVINTERFACE_WRITEONCEDISK -VolumeClassGuid = GUID_DEVINTERFACE_VOLUME -MediumChangerClassGuid = GUID_DEVINTERFACE_MEDIUMCHANGER -FloppyClassGuid = GUID_DEVINTERFACE_FLOPPY -CdChangerClassGuid = GUID_DEVINTERFACE_CDCHANGER -StoragePortClassGuid = GUID_DEVINTERFACE_STORAGEPORT - - -IOCTL_STORAGE_CHECK_VERIFY = CTL_CODE(IOCTL_STORAGE_BASE, 0x0200, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_STORAGE_CHECK_VERIFY2 = CTL_CODE(IOCTL_STORAGE_BASE, 0x0200, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_STORAGE_MEDIA_REMOVAL = CTL_CODE(IOCTL_STORAGE_BASE, 0x0201, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_STORAGE_EJECT_MEDIA = CTL_CODE(IOCTL_STORAGE_BASE, 0x0202, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_STORAGE_LOAD_MEDIA = CTL_CODE(IOCTL_STORAGE_BASE, 0x0203, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_STORAGE_LOAD_MEDIA2 = CTL_CODE(IOCTL_STORAGE_BASE, 0x0203, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_STORAGE_RESERVE = CTL_CODE(IOCTL_STORAGE_BASE, 0x0204, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_STORAGE_RELEASE = CTL_CODE(IOCTL_STORAGE_BASE, 0x0205, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_STORAGE_FIND_NEW_DEVICES = CTL_CODE(IOCTL_STORAGE_BASE, 0x0206, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_STORAGE_EJECTION_CONTROL = CTL_CODE(IOCTL_STORAGE_BASE, 0x0250, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_STORAGE_MCN_CONTROL = CTL_CODE(IOCTL_STORAGE_BASE, 0x0251, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_STORAGE_GET_MEDIA_TYPES = CTL_CODE(IOCTL_STORAGE_BASE, 0x0300, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_STORAGE_GET_MEDIA_TYPES_EX = CTL_CODE(IOCTL_STORAGE_BASE, 0x0301, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_STORAGE_GET_MEDIA_SERIAL_NUMBER = CTL_CODE(IOCTL_STORAGE_BASE, 0x0304, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_STORAGE_GET_HOTPLUG_INFO = CTL_CODE(IOCTL_STORAGE_BASE, 0x0305, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_STORAGE_SET_HOTPLUG_INFO = CTL_CODE( - IOCTL_STORAGE_BASE, - 0x0306, - METHOD_BUFFERED, - FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_STORAGE_RESET_BUS = CTL_CODE(IOCTL_STORAGE_BASE, 0x0400, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_STORAGE_RESET_DEVICE = CTL_CODE(IOCTL_STORAGE_BASE, 0x0401, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_STORAGE_BREAK_RESERVATION = CTL_CODE(IOCTL_STORAGE_BASE, 0x0405, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_STORAGE_GET_DEVICE_NUMBER = CTL_CODE(IOCTL_STORAGE_BASE, 0x0420, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_STORAGE_PREDICT_FAILURE = CTL_CODE(IOCTL_STORAGE_BASE, 0x0440, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_GET_DRIVE_GEOMETRY = CTL_CODE(IOCTL_DISK_BASE, 0x0000, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_GET_PARTITION_INFO = CTL_CODE(IOCTL_DISK_BASE, 0x0001, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_DISK_SET_PARTITION_INFO = CTL_CODE(IOCTL_DISK_BASE, 0x0002, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_DISK_GET_DRIVE_LAYOUT = CTL_CODE(IOCTL_DISK_BASE, 0x0003, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_DISK_SET_DRIVE_LAYOUT = CTL_CODE(IOCTL_DISK_BASE, 0x0004, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_DISK_VERIFY = CTL_CODE(IOCTL_DISK_BASE, 0x0005, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_FORMAT_TRACKS = CTL_CODE(IOCTL_DISK_BASE, 0x0006, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_DISK_REASSIGN_BLOCKS = CTL_CODE(IOCTL_DISK_BASE, 0x0007, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_DISK_PERFORMANCE = CTL_CODE(IOCTL_DISK_BASE, 0x0008, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_IS_WRITABLE = CTL_CODE(IOCTL_DISK_BASE, 0x0009, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_LOGGING = CTL_CODE(IOCTL_DISK_BASE, 0x000a, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_FORMAT_TRACKS_EX = CTL_CODE(IOCTL_DISK_BASE, 0x000b, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_DISK_HISTOGRAM_STRUCTURE = CTL_CODE(IOCTL_DISK_BASE, 0x000c, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_HISTOGRAM_DATA = CTL_CODE(IOCTL_DISK_BASE, 0x000d, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_HISTOGRAM_RESET = CTL_CODE(IOCTL_DISK_BASE, 0x000e, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_REQUEST_STRUCTURE = CTL_CODE(IOCTL_DISK_BASE, 0x000f, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_REQUEST_DATA = CTL_CODE(IOCTL_DISK_BASE, 0x0010, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_PERFORMANCE_OFF = CTL_CODE(IOCTL_DISK_BASE, 0x0018, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_CONTROLLER_NUMBER = CTL_CODE(IOCTL_DISK_BASE, 0x0011, METHOD_BUFFERED, FILE_ANY_ACCESS) -SMART_GET_VERSION = CTL_CODE(IOCTL_DISK_BASE, 0x0020, METHOD_BUFFERED, FILE_READ_ACCESS) -SMART_SEND_DRIVE_COMMAND = CTL_CODE(IOCTL_DISK_BASE, 0x0021, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -SMART_RCV_DRIVE_DATA = CTL_CODE(IOCTL_DISK_BASE, 0x0022, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_DISK_GET_PARTITION_INFO_EX = CTL_CODE(IOCTL_DISK_BASE, 0x0012, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_SET_PARTITION_INFO_EX = CTL_CODE( - IOCTL_DISK_BASE, - 0x0013, - METHOD_BUFFERED, - FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_DISK_GET_DRIVE_LAYOUT_EX = CTL_CODE(IOCTL_DISK_BASE, 0x0014, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_SET_DRIVE_LAYOUT_EX = CTL_CODE( - IOCTL_DISK_BASE, - 0x0015, - METHOD_BUFFERED, - FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_DISK_CREATE_DISK = CTL_CODE(IOCTL_DISK_BASE, 0x0016, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_DISK_GET_LENGTH_INFO = CTL_CODE(IOCTL_DISK_BASE, 0x0017, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_DISK_GET_DRIVE_GEOMETRY_EX = CTL_CODE(IOCTL_DISK_BASE, 0x0028, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_REASSIGN_BLOCKS_EX = CTL_CODE(IOCTL_DISK_BASE, 0x0029, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) - -IOCTL_DISK_UPDATE_DRIVE_SIZE = CTL_CODE(IOCTL_DISK_BASE, 0x0032, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_DISK_GROW_PARTITION = CTL_CODE(IOCTL_DISK_BASE, 0x0034, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_DISK_GET_CACHE_INFORMATION = CTL_CODE(IOCTL_DISK_BASE, 0x0035, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_DISK_SET_CACHE_INFORMATION = CTL_CODE( - IOCTL_DISK_BASE, - 0x0036, - METHOD_BUFFERED, - FILE_READ_ACCESS | FILE_WRITE_ACCESS) - -OBSOLETE_IOCTL_STORAGE_RESET_BUS = CTL_CODE( - IOCTL_STORAGE_BASE, - 0x0400, - METHOD_BUFFERED, - FILE_READ_ACCESS | FILE_WRITE_ACCESS) -OBSOLETE_IOCTL_STORAGE_RESET_DEVICE = CTL_CODE( - IOCTL_STORAGE_BASE, - 0x0401, - METHOD_BUFFERED, - FILE_READ_ACCESS | FILE_WRITE_ACCESS) -# the original define no longer exists in winioctl.h -OBSOLETE_DISK_GET_WRITE_CACHE_STATE = CTL_CODE(IOCTL_DISK_BASE, 0x0037, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_DISK_GET_WRITE_CACHE_STATE = OBSOLETE_DISK_GET_WRITE_CACHE_STATE - - -IOCTL_DISK_DELETE_DRIVE_LAYOUT = CTL_CODE( - IOCTL_DISK_BASE, - 0x0040, - METHOD_BUFFERED, - FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_DISK_UPDATE_PROPERTIES = CTL_CODE(IOCTL_DISK_BASE, 0x0050, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_FORMAT_DRIVE = CTL_CODE(IOCTL_DISK_BASE, 0x00f3, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_DISK_SENSE_DEVICE = CTL_CODE(IOCTL_DISK_BASE, 0x00f8, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_DISK_CHECK_VERIFY = CTL_CODE(IOCTL_DISK_BASE, 0x0200, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_DISK_MEDIA_REMOVAL = CTL_CODE(IOCTL_DISK_BASE, 0x0201, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_DISK_EJECT_MEDIA = CTL_CODE(IOCTL_DISK_BASE, 0x0202, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_DISK_LOAD_MEDIA = CTL_CODE(IOCTL_DISK_BASE, 0x0203, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_DISK_RESERVE = CTL_CODE(IOCTL_DISK_BASE, 0x0204, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_DISK_RELEASE = CTL_CODE(IOCTL_DISK_BASE, 0x0205, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_DISK_FIND_NEW_DEVICES = CTL_CODE(IOCTL_DISK_BASE, 0x0206, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_DISK_GET_MEDIA_TYPES = CTL_CODE(IOCTL_DISK_BASE, 0x0300, METHOD_BUFFERED, FILE_ANY_ACCESS) - -DISK_HISTOGRAM_SIZE = 72 -HISTOGRAM_BUCKET_SIZE = 8 - -IOCTL_CHANGER_GET_PARAMETERS = CTL_CODE(IOCTL_CHANGER_BASE, 0x0000, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_CHANGER_GET_STATUS = CTL_CODE(IOCTL_CHANGER_BASE, 0x0001, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_CHANGER_GET_PRODUCT_DATA = CTL_CODE(IOCTL_CHANGER_BASE, 0x0002, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_CHANGER_SET_ACCESS = CTL_CODE(IOCTL_CHANGER_BASE, 0x0004, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_CHANGER_GET_ELEMENT_STATUS = CTL_CODE( - IOCTL_CHANGER_BASE, - 0x0005, - METHOD_BUFFERED, - FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_CHANGER_INITIALIZE_ELEMENT_STATUS = CTL_CODE(IOCTL_CHANGER_BASE, 0x0006, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_CHANGER_SET_POSITION = CTL_CODE(IOCTL_CHANGER_BASE, 0x0007, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_CHANGER_EXCHANGE_MEDIUM = CTL_CODE(IOCTL_CHANGER_BASE, 0x0008, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_CHANGER_MOVE_MEDIUM = CTL_CODE(IOCTL_CHANGER_BASE, 0x0009, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_CHANGER_REINITIALIZE_TRANSPORT = CTL_CODE(IOCTL_CHANGER_BASE, 0x000A, METHOD_BUFFERED, FILE_READ_ACCESS) -IOCTL_CHANGER_QUERY_VOLUME_TAGS = CTL_CODE( - IOCTL_CHANGER_BASE, - 0x000B, - METHOD_BUFFERED, - FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_SERIAL_LSRMST_INSERT = CTL_CODE(FILE_DEVICE_SERIAL_PORT, 31, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_SERENUM_EXPOSE_HARDWARE = CTL_CODE(FILE_DEVICE_SERENUM, 128, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_SERENUM_REMOVE_HARDWARE = CTL_CODE(FILE_DEVICE_SERENUM, 129, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_SERENUM_PORT_DESC = CTL_CODE(FILE_DEVICE_SERENUM, 130, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_SERENUM_GET_PORT_NAME = CTL_CODE(FILE_DEVICE_SERENUM, 131, METHOD_BUFFERED, FILE_ANY_ACCESS) - -# ??? can't find where FILE_DEVICE_AVIO is defined ??? -# IOCTL_AVIO_ALLOCATE_STREAM = CTL_CODE(FILE_DEVICE_AVIO, 1, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -# IOCTL_AVIO_FREE_STREAM = CTL_CODE(FILE_DEVICE_AVIO, 2, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -# IOCTL_AVIO_MODIFY_STREAM = CTL_CODE(FILE_DEVICE_AVIO, 3, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) - -SERIAL_LSRMST_ESCAPE = 0x00 -SERIAL_LSRMST_LSR_DATA = 0x01 -SERIAL_LSRMST_LSR_NODATA = 0x02 -SERIAL_LSRMST_MST = 0x03 -SERIAL_IOC_FCR_FIFO_ENABLE = 0x00000001 -SERIAL_IOC_FCR_RCVR_RESET = 0x00000002 -SERIAL_IOC_FCR_XMIT_RESET = 0x00000004 -SERIAL_IOC_FCR_DMA_MODE = 0x00000008 -SERIAL_IOC_FCR_RES1 = 0x00000010 -SERIAL_IOC_FCR_RES2 = 0x00000020 -SERIAL_IOC_FCR_RCVR_TRIGGER_LSB = 0x00000040 -SERIAL_IOC_FCR_RCVR_TRIGGER_MSB = 0x00000080 -SERIAL_IOC_MCR_DTR = 0x00000001 -SERIAL_IOC_MCR_RTS = 0x00000002 -SERIAL_IOC_MCR_OUT1 = 0x00000004 -SERIAL_IOC_MCR_OUT2 = 0x00000008 -SERIAL_IOC_MCR_LOOP = 0x00000010 -FSCTL_REQUEST_OPLOCK_LEVEL_1 = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 0, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_REQUEST_OPLOCK_LEVEL_2 = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 1, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_REQUEST_BATCH_OPLOCK = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 2, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_OPLOCK_BREAK_ACKNOWLEDGE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 3, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_OPBATCH_ACK_CLOSE_PENDING = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 4, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_OPLOCK_BREAK_NOTIFY = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 5, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_LOCK_VOLUME = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 6, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_UNLOCK_VOLUME = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 7, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_DISMOUNT_VOLUME = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 8, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_IS_VOLUME_MOUNTED = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 10, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_IS_PATHNAME_VALID = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 11, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_MARK_VOLUME_DIRTY = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 12, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_QUERY_RETRIEVAL_POINTERS = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 14, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_GET_COMPRESSION = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 15, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_SET_COMPRESSION = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 16, METHOD_BUFFERED, FILE_READ_DATA | FILE_WRITE_DATA) -FSCTL_MARK_AS_SYSTEM_HIVE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 19, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_OPLOCK_BREAK_ACK_NO_2 = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 20, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_INVALIDATE_VOLUMES = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 21, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_QUERY_FAT_BPB = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 22, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_REQUEST_FILTER_OPLOCK = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 23, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_FILESYSTEM_GET_STATISTICS = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 24, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_GET_NTFS_VOLUME_DATA = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 25, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_GET_NTFS_FILE_RECORD = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 26, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_GET_VOLUME_BITMAP = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 27, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_GET_RETRIEVAL_POINTERS = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 28, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_MOVE_FILE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 29, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -FSCTL_IS_VOLUME_DIRTY = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 30, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_ALLOW_EXTENDED_DASD_IO = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 32, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_FIND_FILES_BY_SID = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 35, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_SET_OBJECT_ID = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 38, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -FSCTL_GET_OBJECT_ID = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 39, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_DELETE_OBJECT_ID = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 40, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -FSCTL_SET_REPARSE_POINT = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 41, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -FSCTL_GET_REPARSE_POINT = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 42, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_DELETE_REPARSE_POINT = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 43, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -FSCTL_ENUM_USN_DATA = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 44, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_SECURITY_ID_CHECK = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 45, METHOD_NEITHER, FILE_READ_DATA) -FSCTL_READ_USN_JOURNAL = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 46, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_SET_OBJECT_ID_EXTENDED = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 47, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -FSCTL_CREATE_OR_GET_OBJECT_ID = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 48, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_SET_SPARSE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 49, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -FSCTL_SET_ZERO_DATA = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 50, METHOD_BUFFERED, FILE_WRITE_DATA) -FSCTL_QUERY_ALLOCATED_RANGES = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 51, METHOD_NEITHER, FILE_READ_DATA) -FSCTL_SET_ENCRYPTION = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 53, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_ENCRYPTION_FSCTL_IO = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 54, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_WRITE_RAW_ENCRYPTED = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 55, METHOD_NEITHER, FILE_SPECIAL_ACCESS) -FSCTL_READ_RAW_ENCRYPTED = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 56, METHOD_NEITHER, FILE_SPECIAL_ACCESS) -FSCTL_CREATE_USN_JOURNAL = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 57, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_READ_FILE_USN_DATA = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 58, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_WRITE_USN_CLOSE_RECORD = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 59, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_EXTEND_VOLUME = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 60, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_QUERY_USN_JOURNAL = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 61, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_DELETE_USN_JOURNAL = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 62, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_MARK_HANDLE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 63, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_SIS_COPYFILE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 64, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_SIS_LINK_FILES = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 65, METHOD_BUFFERED, FILE_READ_DATA | FILE_WRITE_DATA) -FSCTL_HSM_MSG = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 66, METHOD_BUFFERED, FILE_READ_DATA | FILE_WRITE_DATA) -FSCTL_HSM_DATA = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 68, METHOD_NEITHER, FILE_READ_DATA | FILE_WRITE_DATA) -FSCTL_RECALL_FILE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 69, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_READ_FROM_PLEX = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 71, METHOD_OUT_DIRECT, FILE_READ_DATA) -FSCTL_FILE_PREFETCH = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 72, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -FSCTL_MAKE_MEDIA_COMPATIBLE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 76, METHOD_BUFFERED, FILE_WRITE_DATA) -FSCTL_SET_DEFECT_MANAGEMENT = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 77, METHOD_BUFFERED, FILE_WRITE_DATA) -FSCTL_QUERY_SPARING_INFO = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 78, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_QUERY_ON_DISK_VOLUME_INFO = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 79, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_SET_VOLUME_COMPRESSION_STATE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 80, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -FSCTL_TXFS_MODIFY_RM = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 81, METHOD_BUFFERED, FILE_WRITE_DATA) -FSCTL_TXFS_QUERY_RM_INFORMATION = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 82, METHOD_BUFFERED, FILE_READ_DATA) -FSCTL_TXFS_ROLLFORWARD_REDO = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 84, METHOD_BUFFERED, FILE_WRITE_DATA) -FSCTL_TXFS_ROLLFORWARD_UNDO = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 85, METHOD_BUFFERED, FILE_WRITE_DATA) -FSCTL_TXFS_START_RM = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 86, METHOD_BUFFERED, FILE_WRITE_DATA) -FSCTL_TXFS_SHUTDOWN_RM = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 87, METHOD_BUFFERED, FILE_WRITE_DATA) -FSCTL_TXFS_READ_BACKUP_INFORMATION = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 88, METHOD_BUFFERED, FILE_READ_DATA) -FSCTL_TXFS_WRITE_BACKUP_INFORMATION = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 89, METHOD_BUFFERED, FILE_WRITE_DATA) -FSCTL_TXFS_CREATE_SECONDARY_RM = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 90, METHOD_BUFFERED, FILE_WRITE_DATA) -FSCTL_TXFS_GET_METADATA_INFO = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 91, METHOD_BUFFERED, FILE_READ_DATA) -FSCTL_TXFS_GET_TRANSACTED_VERSION = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 92, METHOD_BUFFERED, FILE_READ_DATA) -FSCTL_TXFS_CREATE_MINIVERSION = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 95, METHOD_BUFFERED, FILE_WRITE_DATA) -FSCTL_TXFS_TRANSACTION_ACTIVE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 99, METHOD_BUFFERED, FILE_READ_DATA) -FSCTL_SET_ZERO_ON_DEALLOCATION = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 101, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -FSCTL_SET_REPAIR = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 102, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_GET_REPAIR = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 103, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_WAIT_FOR_REPAIR = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 104, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_INITIATE_REPAIR = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 106, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_CSC_INTERNAL = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 107, METHOD_NEITHER, FILE_ANY_ACCESS) -FSCTL_SHRINK_VOLUME = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 108, METHOD_BUFFERED, FILE_SPECIAL_ACCESS) -FSCTL_SET_SHORT_NAME_BEHAVIOR = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 109, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_DFSR_SET_GHOST_HANDLE_STATE = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 110, METHOD_BUFFERED, FILE_ANY_ACCESS) -FSCTL_TXFS_LIST_TRANSACTION_LOCKED_FILES = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 120, METHOD_BUFFERED, FILE_READ_DATA) -FSCTL_TXFS_LIST_TRANSACTIONS = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 121, METHOD_BUFFERED, FILE_READ_DATA) -FSCTL_QUERY_PAGEFILE_ENCRYPTION = CTL_CODE(FILE_DEVICE_FILE_SYSTEM, 122, METHOD_BUFFERED, FILE_ANY_ACCESS) - -IOCTL_VOLUME_BASE = ord('V') -IOCTL_VOLUME_GET_VOLUME_DISK_EXTENTS = CTL_CODE(IOCTL_VOLUME_BASE, 0, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_VOLUME_ONLINE = CTL_CODE(IOCTL_VOLUME_BASE, 2, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_VOLUME_OFFLINE = CTL_CODE(IOCTL_VOLUME_BASE, 3, METHOD_BUFFERED, FILE_READ_ACCESS | FILE_WRITE_ACCESS) -IOCTL_VOLUME_IS_CLUSTERED = CTL_CODE(IOCTL_VOLUME_BASE, 12, METHOD_BUFFERED, FILE_ANY_ACCESS) -IOCTL_VOLUME_GET_GPT_ATTRIBUTES = CTL_CODE(IOCTL_VOLUME_BASE, 14, METHOD_BUFFERED, FILE_ANY_ACCESS) - -# enums -# STORAGE_MEDIA_TYPE -DDS_4mm = 32 -MiniQic = 33 -Travan = 34 -QIC = 35 -MP_8mm = 36 -AME_8mm = 37 -AIT1_8mm = 38 -DLT = 39 -NCTP = 40 -IBM_3480 = 41 -IBM_3490E = 42 -IBM_Magstar_3590 = 43 -IBM_Magstar_MP = 44 -STK_DATA_D3 = 45 -SONY_DTF = 46 -DV_6mm = 47 -DMI = 48 -SONY_D2 = 49 -CLEANER_CARTRIDGE = 50 -CD_ROM = 51 -CD_R = 52 -CD_RW = 53 -DVD_ROM = 54 -DVD_R = 55 -DVD_RW = 56 -MO_3_RW = 57 -MO_5_WO = 58 -MO_5_RW = 59 -MO_5_LIMDOW = 60 -PC_5_WO = 61 -PC_5_RW = 62 -PD_5_RW = 63 -ABL_5_WO = 64 -PINNACLE_APEX_5_RW = 65 -SONY_12_WO = 66 -PHILIPS_12_WO = 67 -HITACHI_12_WO = 68 -CYGNET_12_WO = 69 -KODAK_14_WO = 70 -MO_NFR_525 = 71 -NIKON_12_RW = 72 -IOMEGA_ZIP = 73 -IOMEGA_JAZ = 74 -SYQUEST_EZ135 = 75 -SYQUEST_EZFLYER = 76 -SYQUEST_SYJET = 77 -AVATAR_F2 = 78 -MP2_8mm = 79 -DST_S = 80 -DST_M = 81 -DST_L = 82 -VXATape_1 = 83 -VXATape_2 = 84 -STK_9840 = 85 -LTO_Ultrium = 86 -LTO_Accelis = 87 -DVD_RAM = 88 -AIT_8mm = 89 -ADR_1 = 90 -ADR_2 = 91 -STK_9940 = 92 - -# STORAGE_BUS_TYPE -BusTypeUnknown = 0 -BusTypeScsi = 1 -BusTypeAtapi = 2 -BusTypeAta = 3 -BusType1394 = 4 -BusTypeSsa = 5 -BusTypeFibre = 6 -BusTypeUsb = 7 -BusTypeRAID = 8 -BusTypeiScsi = 9 -BusTypeSas = 10 -BusTypeSata = 11 -BusTypeMaxReserved = 127 - -# MEDIA_TYPE -Unknown = 0 -F5_1Pt2_512 = 1 -F3_1Pt44_512 = 2 -F3_2Pt88_512 = 3 -F3_20Pt8_512 = 4 -F3_720_512 = 5 -F5_360_512 = 6 -F5_320_512 = 7 -F5_320_1024 = 8 -F5_180_512 = 9 -F5_160_512 = 10 -RemovableMedia = 11 -FixedMedia = 12 -F3_120M_512 = 13 -F3_640_512 = 14 -F5_640_512 = 15 -F5_720_512 = 16 -F3_1Pt2_512 = 17 -F3_1Pt23_1024 = 18 -F5_1Pt23_1024 = 19 -F3_128Mb_512 = 20 -F3_230Mb_512 = 21 -F8_256_128 = 22 -F3_200Mb_512 = 23 -F3_240M_512 = 24 -F3_32M_512 = 25 - -# PARTITION_STYLE -PARTITION_STYLE_MBR = 0 -PARTITION_STYLE_GPT = 1 -PARTITION_STYLE_RAW = 2 - -# DETECTION_TYPE -DetectNone = 0 -DetectInt13 = 1 -DetectExInt13 = 2 - -# DISK_CACHE_RETENTION_PRIORITY -EqualPriority = 0 -KeepPrefetchedData = 1 -KeepReadData = 2 - -# DISK_WRITE_CACHE_STATE - ?????? this enum has disappeared from winioctl.h in windows 2003 SP1 sdk ?????? -DiskWriteCacheNormal = 0 -DiskWriteCacheForceDisable = 1 -DiskWriteCacheDisableNotSupported = 2 - -# BIN_TYPES -RequestSize = 0 -RequestLocation = 1 - -# CHANGER_DEVICE_PROBLEM_TYPE -DeviceProblemNone = 0 -DeviceProblemHardware = 1 -DeviceProblemCHMError = 2 -DeviceProblemDoorOpen = 3 -DeviceProblemCalibrationError = 4 -DeviceProblemTargetFailure = 5 -DeviceProblemCHMMoveError = 6 -DeviceProblemCHMZeroError = 7 -DeviceProblemCartridgeInsertError = 8 -DeviceProblemPositionError = 9 -DeviceProblemSensorError = 10 -DeviceProblemCartridgeEjectError = 11 -DeviceProblemGripperError = 12 -DeviceProblemDriveError = 13 diff --git a/typings/win32typing/__init__.pyi b/typings/win32typing/__init__.pyi deleted file mode 100644 index d182f30f..00000000 --- a/typings/win32typing/__init__.pyi +++ /dev/null @@ -1,48527 +0,0 @@ -__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'] -from typing import Any, Union - - -class COMMTIMEOUTS: - """A tuple representing a COMMTIMEOUTS structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class CopyProgressRoutine: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class DOCINFO: - """A tuple of information representing a DOCINFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def DocName(self) -> str: - """Name of document""" - ... - - @property - def Output(self) -> str: - """Name of output file when printing to file. Use None for normal printing.""" - ... - - @property - def DataType(self) -> str: - """Type of data to be sent to printer, eg RAW, EMF, TEXT. Use None for printer default.""" - ... - - @property - def Type(self) -> Any: - """Flag specifying mode of operation. Can be DI_APPBANDING, DI_ROPS_READ_DESTINATION, or 0""" - ... - - -class ExportCallback: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class FORM_INFO_1: - """A dictionary containing FORM_INFO_1W data""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def Flags(self) -> Any: - """FORM_USER, FORM_BUILTIN, or FORM_PRINTER""" - ... - - @property - def Name(self) -> str: - """Name of form""" - ... - - @property - def Size(self) -> Any: - """A dictionary representing a SIZEL structure {'cx':int,'cy':int}""" - ... - - @property - def ImageableArea(self) -> Any: - """A dictionary representing a RECTL structure {'left':int, 'top':int, 'right':int, 'bottom':int}""" - ... - - -class ImportCallback: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class LARGE_INTEGER: - """A Python object used wherever a COM LARGE_INTEGER is used.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class NCB: - """A Python object that encapsulates a Win32 NCB structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def Command(self) -> Any: - ... - - @property - def Retcode(self) -> Any: - ... - - @property - def Lsn(self) -> Any: - ... - - @property - def Num(self) -> Any: - ... - - @property - def Bufflen(self) -> Any: - """read-only""" - ... - - @property - def Callname(self) -> str: - """- The strings need to be space padded to 16 chars exactly""" - ... - - @property - def Name(self) -> str: - """- The strings need to be space padded to 16 chars exactly""" - ... - - @property - def Rto(self) -> str: - """- The strings need to be space padded to 16 chars exactly""" - ... - - @property - def Sto(self) -> str: - """- The strings need to be space padded to 16 chars exactly""" - ... - - @property - def Lana_num(self) -> Any: - ... - - @property - def Cmd_cplt(self) -> Any: - ... - - @property - def Event(self) -> Any: - ... - - @property - def Post(self) -> Any: - ... - - -class PRINTER_DEFAULTS: - """A dictionary representing a PRINTER_DEFAULTS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def pDatatype(self) -> str: - """Data type to be used for print jobs, see win32print::EnumPrintProcessorDatatypes, optional, can be None""" - ... - - @property - def pDevMode(self) -> PyDEVMODE: - """A PyDEVMODE that specifies default printer parameters, optional, can be None""" - ... - - @property - def DesiredAccess(self) -> Any: - """An ACCESS_MASK specifying what level of access is needed, eg PRINTER_ACCESS_ADMINISTER, PRINTER_ACCESS_USE""" - ... - - -class PyACL: - """A Python object, representing a ACL structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Initialize(self) -> None: - """ - Initialize the ACL. - -Args: - - - -Returns: - - None - - """ - ... - - def IsValid(self) -> None: - """ - Determines if the ACL is valid (IsValidAcl) - -Args: - - - -Returns: - - None - - """ - ... - - def AddAccessAllowedAce(self, revision: Any, access: Any, sid: PySID, access1: Any, sid1: Any) -> None: - """ - Adds an access-allowed ACE to an DACL object. The access is granted to a - -specified SID. - -Args: - - revision(Any):Pre-win2k, must be ACL_REVISION, otherwise also may be ACL_REVISION_DS. - access(Any):Specifies the mask of access rights to be denied to the specified SID. - sid(PySID):A SID object representing a user, group, or logon account being denied access.Alternative Parameters - access1(Any):Specifies the mask of access rights to be denied to the specified SID. - sid1(Any):A SID object representing a user, group, or logon account being denied access.CommentsNote that early versions of this function supported only two arguments. This has been deprecated in preference of the three argument version, which reflects the win32 API and the new functions in this module. - -Returns: - - None - - """ - ... - - def AddAccessAllowedAceEx(self, revision: Any, aceflags: Any, access: Any, sid: PySID) -> None: - """ - Add access allowed ACE to an ACL with ACE flags (Requires Win2k or higher) - -Args: - - revision(Any):Must be at least ACL_REVISION_DS - aceflags(Any):Combination of ACE inheritance flags (CONTAINER_INHERIT_ACE,INHERIT_ONLY_ACE,INHERITED_ACE,NO_PROPAGATE_INHERIT_ACE, and OBJECT_INHERIT_ACE) - access(Any):Specifies the mask of access rights to be granted to the specified SID. - sid(PySID):A SID object representing a user, group, or logon account being granted access. - -Returns: - - None - - """ - ... - - def AddAccessAllowedObjectAce( - self, - AceRevision: Any, - AceFlags: Any, - AccessMask: Any, - ObjectTypeGuid: PyIID, - InheritedObjectTypeGuid: PyIID, - sid: PySID) -> None: - """ - Adds an ACCESS_ALLOWED_OBJECT_ACE to the ACL - -Args: - - AceRevision(Any):Must be at least ACL_REVISION_DS - AceFlags(Any):Combination of ACE inheritance flags (CONTAINER_INHERIT_ACE,INHERIT_ONLY_ACE,INHERITED_ACE,NO_PROPAGATE_INHERIT_ACE, and OBJECT_INHERIT_ACE) - AccessMask(Any):Specifies the mask of access rights to be granted to the specified SID - ObjectTypeGuid(PyIID):GUID of object type or property set to which ace applies, can be None - InheritedObjectTypeGuid(PyIID):GUID of object type or property that will inherit ACE, can be None - sid(PySID):A SID object representing a user, group, or logon account being granted access. - -Returns: - - None - - """ - ... - - def AddAccessDeniedAce(self, revision: Any, access: Any, sid: PySID, access1: Any, sid1: Any) -> None: - """ - Adds an access-denied ACE to an ACL object. The access is denied to a specified - -SID. - -Args: - - revision(Any):Pre-win2k, must be ACL_REVISION, otherwise also may be ACL_REVISION_DS. - access(Any):Specifies the mask of access rights to be denied to the specified SID. - sid(PySID):A SID object representing a user, group, or logon account being denied access.Alternative Parameters - access1(Any):Specifies the mask of access rights to be denied to the specified SID. - sid1(Any):A SID object representing a user, group, or logon account being denied access.CommentsNote that early versions of this function supported only two arguments. This has been deprecated in preference of the three argument version, which reflects the win32 API and the new functions in this module. - -Returns: - - None - - """ - ... - - def AddAccessDeniedAceEx(self, revision: Any, aceflags: Any, access: Any, sid: PySID) -> None: - """ - Add access denied ACE to an ACL with ACE flags (Requires Win2k or higher) - -Args: - - revision(Any):Must be at least ACL_REVISION_DS - aceflags(Any):Combination of ACE inheritance flags (CONTAINER_INHERIT_ACE,INHERIT_ONLY_ACE,INHERITED_ACE,NO_PROPAGATE_INHERIT_ACE, and OBJECT_INHERIT_ACE) - access(Any):Specifies the mask of access rights to be denied to the specified SID. - sid(PySID):A SID object representing a user, group, or logon account being denied access. - -Returns: - - None - - """ - ... - - def AddMandatoryAce(self, AceRevision: Any, AceFlags: Any, MandatoryPolicy: Any, LabelSid: PySID) -> None: - """ - Adds a mandatory integrity level ACE to a SACL - -Args: - - AceRevision(Any):ACL_REVISION or ACL_REVISION_DS - AceFlags(Any):Combination of ACE inheritance flags (CONTAINER_INHERIT_ACE,INHERIT_ONLY_ACE,INHERITED_ACE,NO_PROPAGATE_INHERIT_ACE, and OBJECT_INHERIT_ACE) - MandatoryPolicy(Any):Access policy for processes with lower integrity level, combination of SYSTEM_MANDATORY_LABEL_* flags - LabelSid(PySID):Integrity level SID. This can be created using CreateWellKnownSid with Win*LabelSid. Also can be constructed manually using SECURITY_MANDATORY_LABEL_AUTHORITY and a SECURITY_MANDATORY_*_RID - -Returns: - - None - - """ - ... - - def AddAuditAccessAce( - self, - dwAceRevision: Any, - dwAccessMask: Any, - sid: PySID, - bAuditSuccess: Any, - bAuditFailure: Any) -> None: - """ - Adds an audit ACE to a Sacl - -Args: - - dwAceRevision(Any):Revision of ACL: Pre-Win2k, must be ACL_REVISION. Win2K on up, can also be ACL_REVISION_DS - dwAccessMask(Any):Bitmask of access types to be audited - sid(PySID):SID for whom system audit messages will be generated - bAuditSuccess(Any):Set to 1 if access success should be audited, else 0 - bAuditFailure(Any):Set to 1 if access failure should be audited, else 0 - -Returns: - - None - - """ - ... - - def AddAuditAccessAceEx( - self, - dwAceRevision: Any, - AceFlags: Any, - dwAccessMask: Any, - sid: PySID, - bAuditSuccess: Any, - bAuditFailure: Any) -> None: - """ - Adds an audit ACE to an Sacl, includes ace flags - -Args: - - dwAceRevision(Any):Revision of ACL: Must be at least ACL_REVISION_DS - AceFlags(Any):Combination of FAILED_ACCESS_ACE_FLAG,SUCCESSFUL_ACCESS_ACE_FLAG,CONTAINER_INHERIT_ACE,INHERIT_ONLY_ACE,INHERITED_ACE,NO_PROPAGATE_INHERIT_ACE and OBJECT_INHERIT_ACE - dwAccessMask(Any):Bitmask of access types to be audited - sid(PySID):SID for whom system audit messages will be generated - bAuditSuccess(Any):Set to 1 if access success should be audited, else 0 - bAuditFailure(Any):Set to 1 if access failure should be audited, else 0 - -Returns: - - None - - """ - ... - - def AddAuditAccessObjectAce( - self, - dwAceRevision: Any, - AceFlags: Any, - dwAccessMask: Any, - ObjectTypeGuid: PyIID, - InheritedObjectTypeGuid: PyIID, - sid: PySID, - bAuditSuccess: Any, - bAuditFailure: Any) -> None: - """ - Adds an audit ACE for an object type identified by GUID - -Args: - - dwAceRevision(Any):Revision of ACL: Must be at least ACL_REVISION_DS - AceFlags(Any):Combination of FAILED_ACCESS_ACE_FLAG,SUCCESSFUL_ACCESS_ACE_FLAG,CONTAINER_INHERIT_ACE,INHERIT_ONLY_ACE,INHERITED_ACE,NO_PROPAGATE_INHERIT_ACE and OBJECT_INHERIT_ACE - dwAccessMask(Any):Bitmask of access types to be audited - ObjectTypeGuid(PyIID):GUID of object type or property set to which ace applies, can be None - InheritedObjectTypeGuid(PyIID):GUID of object type or property that will inherit ACE, can be None - sid(PySID):SID for whom system audit messages will be generated - bAuditSuccess(Any):Set to 1 if access success should be audited, else 0 - bAuditFailure(Any):Set to 1 if access failure should be audited, else 0 - -Returns: - - None - - """ - ... - - def GetAclSize(self) -> Any: - """ - Returns the storage size of the ACL. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetAclRevision(self) -> Any: - """ - Returns revision of the ACL. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetAceCount(self) -> Any: - """ - Returns the number of ACEs in the ACL. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetAce(self, index: Any) -> Any: - """ - Gets an Ace from the ACL - -Args: - - index(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[1] int : Mask[2] PySID : sidObject 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[1] int : mask[2] PyIID : ObjectType[3] PyIID : InheritedObjectType[4] PySID : sidFor details see the API documentation. - -Returns: - - 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 - -[1] int : Mask - -[2] PySID : sid -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 - -[1] int : mask - -[2] PyIID : ObjectType - -[3] PyIID : InheritedObjectType - -[4] PySID : sid -For details see the API documentation. - - - """ - ... - - def DeleteAce(self, index: Any) -> None: - """ - Deletes specified Ace from an ACL. - -Args: - - index(Any):Zero-based index of the ACE to delete. - -Returns: - - None - - """ - ... - - def GetEffectiveRightsFromAcl(self, trustee: PyTRUSTEE) -> Any: - """ - Return access rights (ACCESS_MASK) that the ACL grants to - -specified trustee - -Args: - - trustee(PyTRUSTEE):Dictionary representing a TRUSTEE structure - -Returns: - - Any - - """ - ... - - def GetAuditedPermissionsFromAcl(self, trustee: PyTRUSTEE) -> tuple[Any, Any]: - """ - Return types of access for - -which ACL will generate an audit event for specified trustee - -Args: - - trustee(PyTRUSTEE):Dictionary representing a TRUSTEE structureCommentsThis function is known to return the success and failure access masks in the the wrong order on Windows 2000 service pack 4. Problem has been reported to Microsoft. - -Returns: - - tuple[Any, Any] - - """ - ... - - -class PyBITMAP: - """A Python object, representing an PyBITMAP structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def bmType(self) -> int: - ... - - @property - def bmWidth(self) -> int: - ... - - @property - def bmHeight(self) -> int: - ... - - @property - def bmWidthBytes(self) -> int: - ... - - @property - def bmPlanes(self) -> int: - ... - - -class PyBLENDFUNCTION: - """tuple of four small ints used to fill a BLENDFUNCTION struct - -Each int must fit in a byte (0-255).""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCEHANDLE: - """A Python object, representing a remote Windows CE handle""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCERTSTORE: - """Handle to a certificate store""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def HCERTSTORE(self) -> Any: - """Integer handle""" - ... - - def CertCloseStore(self, Flags: Any = 0) -> None: - """ - Closes the certificate store - -Args: - - Flags(Any):Combination of CERT_CLOSE_*_FLAG flags - -Returns: - - None - - """ - ... - - def CertControlStore(self, Flags: Any, CtrlType: Any, CtrlPara: int) -> None: - """ - Controls sychronization of the certificate store - -Args: - - Flags(Any):One of the CERT_STORE_CTRL_*_FLAG flags - CtrlType(Any):One of the CERT_STORE_CTRL_* flags - CtrlPara(int):Event handle, can be None (not used with CERT_STORE_CTRL_COMMIT) - -Returns: - - None - - """ - ... - - def CertEnumCertificatesInStore(self) -> list[PyCERT_CONTEXT]: - """ - Lists all certificates in the store - -Args: - - - -Returns: - - list[PyCERT_CONTEXT] - - """ - ... - - def CertEnumCTLsInStore(self) -> list[PyCTL_CONTEXT]: - """ - Finds all Certificate Trust Lists in store - -Args: - - - -Returns: - - list[PyCTL_CONTEXT] - - """ - ... - - def CertSaveStore( - self, - MsgAndCertEncodingType: Any, - SaveAs: Any, - SaveTo: Any, - SaveToPara: Union[str, int], - Flags: Any = 0) -> None: - """ - Serializes the store to memory or a file - -Args: - - MsgAndCertEncodingType(Any):Only used when saveas is CERT_STORE_SAVE_AS_PKCS7 - usually X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING - SaveAs(Any):One of the CERT_STORE_SAVE_AS_* constants - SaveTo(Any):One of the CERT_STORE_SAVE_TO_* constants (CERT_STORE_SAVE_TO_MEMORY not supported yet) - SaveToPara(Union[str, int]):File name or open file handle depending on SaveTo parm - Flags(Any):Reserved, use 0 - -Returns: - - None - - """ - ... - - def CertAddEncodedCertificateToStore( - self, - CertEncodingType: Any, - CertEncoded: Any, - AddDisposition: Any) -> PyCERT_CONTEXT: - """ - Imports an encoded certificate into the - -store - -Args: - - CertEncodingType(Any):Usually X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING - CertEncoded(Any):Data containing a serialized certificate - AddDisposition(Any):Combination of CERT_STORE_ADD_* flags - -Returns: - - PyCERT_CONTEXT - - """ - ... - - def CertAddCertificateContextToStore(self, CertContext: PyCERT_CONTEXT, - AddDisposition: Any) -> PyCERT_CONTEXT: - """ - Adds a certificate context to the store - -Args: - - CertContext(PyCERT_CONTEXT):Certificate context to be added - AddDisposition(Any):CERT_STORE_ADD_* constant - -Returns: - - PyCERT_CONTEXT - - """ - ... - - def CertAddCertificateLinkToStore(self, CertContext: PyCERT_CONTEXT, AddDisposition: Any) -> PyCERT_CONTEXT: - """ - Adds a link to a cert in another store - -Args: - - CertContext(PyCERT_CONTEXT):Certificate context to be linked - AddDisposition(Any):One of the CERT_STORE_ADD_* values - -Returns: - - PyCERT_CONTEXT - - """ - ... - - def CertAddCTLContextToStore(self, CtlContext: PyCTL_CONTEXT, AddDisposition: Any) -> PyCTL_CONTEXT: - """ - Adds a certificate trust list to the store - -Args: - - CtlContext(PyCTL_CONTEXT):CTL to be added - AddDisposition(Any):CERT_STORE_ADD_* constant - -Returns: - - PyCTL_CONTEXT - - """ - ... - - def CertAddCTLLinkToStore(self, CtlContext: PyCTL_CONTEXT, AddDisposition: Any) -> PyCTL_CONTEXT: - """ - Adds a link to a CTL in another store - -Args: - - CtlContext(PyCTL_CONTEXT):CTL to be linked - AddDisposition(Any):One of the CERT_STORE_ADD_* values - -Returns: - - PyCTL_CONTEXT - - """ - ... - - def CertAddStoreToCollection( - self, - SiblingStore: PyCERTSTORE, - UpdateFlag: Any = 0, - Priority: Any = 0) -> None: - """ - Adds a sibling store to a store collection - -Args: - - SiblingStore(PyCERTSTORE):Store to be added to the collection - UpdateFlag(Any):Can be CERT_PHYSICAL_STORE_ADD_ENABLE_FLAG to enable changes to persist - Priority(Any):Determines order in which store are searched and updatedCommentsA collection store is created by using cryptoapi::CertOpenStore with CERT_STORE_PROV_COLLECTION - -Returns: - - None - - """ - ... - - def CertRemoveStoreFromCollection(self, SiblingStore: PyCERTSTORE) -> None: - """ - Removes a sibling store from a collection - -Args: - - SiblingStore(PyCERTSTORE):Store to be removed from the collection - -Returns: - - None - - """ - ... - - def PFXExportCertStoreEx(self, Flags: Any, password: Any = None) -> Any: - """ - Exports certificates and associated private keys in PKCS#12 format - -Args: - - Flags(Any):Options to be used while exporting - password(Any):passphrase to be used to encrypt the output - -Returns: - - Any - - """ - ... - - -class PyCERT_ALT_NAME_ENTRY: - """Represented as a 2-tuple""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCERT_ALT_NAME_INFO: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCERT_AUTHORITY_KEY_ID_INFO: - """Dict containing the identity of a CA""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def KeyId(self) -> Any: - """Unique identifier of private key, usually a hash""" - ... - - @property - def CertIssuer(self) -> Any: - """Encoded DN of the Certificate Authority. Decode using X509_UNICODE_NAME""" - ... - - @property - def CertSerialNumber(self) -> Any: - """Serial nbr of the CA's signing certificate""" - ... - - -class PyCERT_BASIC_CONSTRAINTS2_INFO: - """Dict representing a CERT_BASIC_CONSTRAINTS2_INFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def fCA(self) -> Any: - """Indicates if cert represents a certificate authority""" - ... - - @property - def fPathLenConstraint(self) -> Any: - """Indicates if PathLenConstraint member is used""" - ... - - @property - def PathLenConstraint(self) -> Any: - """Limits number of intermediate CA's between root CA and end user""" - ... - - -class PyCERT_BASIC_CONSTRAINTS_INFO: - """Dict representing a CERT_BASIC_CONSTRAINTS_INFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def SubjectType(self) -> PyCRYPT_BIT_BLOB: - """Contains a combination of CERT_CA_SUBJECT_FLAG,CERT_END_ENTITY_SUBJECT_FLAG""" - ... - - @property - def fPathLenConstraint(self) -> Any: - """Indicates if PathLenConstraint member is used""" - ... - - @property - def PathLenConstraint(self) -> Any: - """Limits number of intermediate CA's between root CA and end user""" - ... - - @property - def SubtreesConstraint(self) -> Any: - """Sequence of encoded name blobs""" - ... - - -class PyCERT_CONTEXT: - """Handle to a certificate context""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def HANDLE(self) -> Any: - """Pointer to CERT_CONTEXT struct""" - ... - - @property - def CertStore(self) -> PyCERTSTORE: - """Handle to the certificate store that contains this certificate""" - ... - - @property - def CertEncoded(self) -> Any: - """Content of the certificate as encoded bytes""" - ... - - @property - def CertEncodingType(self) -> Any: - """Method used to encode the certifcate, usually X509_ASN_ENCODING or PKCS_7_ASN_ENCODING""" - ... - - @property - def Version(self) -> Any: - """One of the CERT_V* values""" - ... - - @property - def Subject(self) -> str: - """Encoded CERT_NAME_INFO struct containing the subject name. Can be decoded using cryptoapi::CryptDecodeObjectEx with X509_UNICODE_NAME, or formatted using cryptoapi::CertNameToStr""" - ... - - @property - def Issuer(self) -> str: - """Certificate Authority that issued certificate as encoded CERT_NAME_INFO. Use cryptoapi::CryptDecodeObjectEx to decode into individual components, or cryptoapi::CertNameToStr to return a single formatted string""" - ... - - @property - def NotBefore(self) -> PyTime: - """Beginning of certificate's period of validity""" - ... - - @property - def NotAfter(self) -> PyTime: - """End of certificate's period of validity""" - ... - - @property - def SignatureAlgorithm(self) -> Any: - """Object id of the certifcate's signature algorithm""" - ... - - @property - def Extension(self) -> tuple[PyCERT_EXTENSION, ...]: - """Sequence of CERT_EXTENSION dicts containing certificate's extensions""" - ... - - @property - def SubjectPublicKeyInfo(self) -> PyCERT_PUBLIC_KEY_INFO: - """Encoded public key of certificate""" - ... - - @property - def SerialNumber(self) -> Any: - """Serial number assigned by the issuer""" - ... - - def CertFreeCertificateContext(self) -> None: - """ - Frees the certificate context - -Args: - - - -Returns: - - None - - """ - ... - - def CertEnumCertificateContextProperties(self) -> list[Any]: - """ - Lists property ids for the certificate - -Args: - - - -Returns: - - list[Any] - - """ - ... - - def CryptAcquireCertificatePrivateKey(self, Flags: Any = 0) -> tuple[Any, PyCRYPTPROV]: - """ - Retrieves the private key associated - -with the certificate - -Args: - - Flags(Any):Combination of CRYPT_ACQUIRE_*_FLAG constantsCommentsOnly the owner of the certificate can use this methodReturn ValueReturns the KeySpec (AT_KEYEXCHANGE or AT_SIGNATURE) and a CSP handle to the key - -Returns: - - tuple[Any, PyCRYPTPROV]:Combination of CRYPT_ACQUIRE_*_FLAG constants -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 - - - """ - ... - - def CertGetIntendedKeyUsage(self) -> Any: - """ - Returns the intended key usage from the certificate extensions - -(szOID_KEY_USAGE or szOID_KEY_ATTRIBUTES) - -Args: - - - -Returns: - - Any:PyCERT_CONTEXT.CertGetIntendedKeyUsage - -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 - - - """ - ... - - def CertGetEnhancedKeyUsage(self, Flags: Any = 0) -> Any: - """ - Finds the enhanced key usage property and/or extension for the - -certificate - -Args: - - Flags(Any):CERT_FIND_EXT_ONLY_ENHKEY_USAGE_FLAG, CERT_FIND_PROP_ONLY_ENHKEY_USAGE_FLAG, or 0Return ValueReturns a sequence of usage OIDs - -Returns: - - Any:CERT_FIND_EXT_ONLY_ENHKEY_USAGE_FLAG, - -CERT_FIND_PROP_ONLY_ENHKEY_USAGE_FLAG, or 0 -Return ValueReturns a sequence of usage OIDs - - - """ - ... - - def CertSerializeCertificateStoreElement(self, Flags: Any = 0) -> str: - """ - Serializes the certificate and its properties - -Args: - - Flags(Any):Reserved, use only 0 if passed in - -Returns: - - str - - """ - ... - - def CertVerifySubjectCertificateContext(self, Issuer: PyCERT_CONTEXT, Flags: Any) -> Any: - """ - Checks the validity of the certificate - -Args: - - Issuer(PyCERT_CONTEXT):Certificate of authority that issued the certificate - Flags(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. - -Returns: - - 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. - - - """ - ... - - def CertDeleteCertificateFromStore(self) -> None: - """ - Removes the certificate from its store - -Args: - - - -Returns: - - None - - """ - ... - - def CertGetCertificateContextProperty(self, PropId: Any) -> Any: - """ - Retrieves the specified property from the - -certificate - -Args: - - PropId(Any):One of the CERT_*_PROP_ID constantsPropIdReturned valueCERT_ARCHIVED_PROP_IDBooleanCERT_DATE_STAMP_PROP_IDPyTimeCERT_ACCESS_STATE_PROP_IDintCERT_KEY_SPEC_PROP_IDintCERT_DESCRIPTION_PROP_IDUnicodeCERT_FRIENDLY_NAME_PROP_IDUnicodeCERT_PVK_FILE_PROP_IDUnicodeCERT_AUTO_ENROLL_PROP_IDUnicodeCERT_HASH_PROP_IDString containing a hashCERT_SHA1_HASH_PROP_IDString containing a hashCERT_MD5_HASH_PROP_IDString containing a hashCERT_SIGNATURE_HASH_PROP_IDString containing a hashCERT_KEY_IDENTIFIER_PROP_IDString containing a hashCERT_SUBJECT_NAME_MD5_HASH_PROP_IDString containing a hashCERT_KEY_PROV_HANDLE_PROP_IDPyCRYPTPROVCERT_SUBJECT_PUBLIC_KEY_MD5_HASH_PROP_IDString containing a hashCERT_ISSUER_PUBLIC_KEY_MD5_HASH_PROP_IDString containing a hashCERT_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_USAGECERT_KEY_PROV_INFO_PROP_IDCRYPT_KEY_PROV_INFO dictCERT_KEY_CONTEXT_PROP_IDDict representing CERT_KEY_CONTEXT structCERT_NEXT_UPDATE_LOCATION_PROP_IDEncoded CERT_ALT_NAME_INFO, decode using cryptoapi::CryptDecodeObjectEx with szOID_NEXT_UPDATE_LOCATIONReturn ValueType of object returned is dependent on the property id requested. - -Returns: - - Any:One of the CERT_*_PROP_ID constants - - -PropId - - -Returned value - - - -CERT_ARCHIVED_PROP_IDBoolean -CERT_DATE_STAMP_PROP_IDPyTime -CERT_ACCESS_STATE_PROP_IDint -CERT_KEY_SPEC_PROP_IDint -CERT_DESCRIPTION_PROP_IDUnicode -CERT_FRIENDLY_NAME_PROP_IDUnicode -CERT_PVK_FILE_PROP_IDUnicode -CERT_AUTO_ENROLL_PROP_IDUnicode -CERT_HASH_PROP_IDString containing a hash -CERT_SHA1_HASH_PROP_IDString containing a hash -CERT_MD5_HASH_PROP_IDString containing a hash -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 - -containing a hash -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_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 -CERT_KEY_CONTEXT_PROP_IDDict representing CERT_KEY_CONTEXT struct -CERT_NEXT_UPDATE_LOCATION_PROP_IDEncoded CERT_ALT_NAME_INFO, decode using cryptoapi::CryptDecodeObjectEx - - - - with szOID_NEXT_UPDATE_LOCATION -Return ValueType of object returned is dependent on the property id requested. - - - """ - ... - - def CertSetCertificateContextProperty(self, PropId: Any, Data: Any, Flags: Any = 0) -> None: - """ - Sets a property for a certificate - -Args: - - PropId(Any):Id of property to be set, CERT_*_PROP_ID - Data(Any):The value to be set for the property. Type is dependent on PropId. Use None to delete a property. - Flags(Any):Combination of CERT_SET_* flagsPropIdType of inputCERT_ARCHIVED_PROP_IDNone causes Archived flag to be cleared, any other causes it to be set no actual data, non-NULL pvData indicates presence of flagCERT_DATE_STAMP_PROP_IDPyTime specifying when cert was added to storeCERT_DESCRIPTION_PROP_IDUnicode stringCERT_FRIENDLY_NAME_PROP_IDUnicode stringCERT_PVK_FILE_PROP_IDUnicode stringCERT_AUTO_ENROLL_PROP_IDUnicode stringCERT_KEY_SPEC_PROP_IDInt, usually AT_KEYEXCHANGE or AT_SIGNATURECERT_HASH_PROP_IDString containing the hashCERT_SHA1_HASH_PROP_IDString containing the hashCERT_MD5_HASH_PROP_IDString containingg the hashCERT_SIGNATURE_HASH_PROP_IDString containing the hashCERT_KEY_IDENTIFIER_PROP_IDString containing the key idCERT_SUBJECT_PUBLIC_KEY_MD5_HASH_PROP_IDString containing the hashCERT_ISSUER_PUBLIC_KEY_MD5_HASH_PROP_IDString containing the hashCERT_SUBJECT_NAME_MD5_HASH_PROP_IDString containing the hashCERT_RENEWAL_PROP_IDString containing the hashCERT_ENHKEY_USAGE_PROP_IDString containing an encoded PyCTL_USAGE. Use cryptoapi::CryptEncodeObjectEx with X509_ENHANCED_KEY_USAGE.CERT_CTL_USAGE_PROP_IDSame as CERT_ENHKEY_USAGE_PROP_ID - -Returns: - - None - - """ - ... - - -class PyCERT_EXTENSION: - """Dict containing a certificate extension""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def ObjId(self) -> Any: - """The OID identifying the type of extension""" - ... - - @property - def Critical(self) -> Any: - """If true, any contraints or limits contained in the extension should be considered absolute""" - ... - - @property - def Value(self) -> Any: - """Binary string containing ASN encoded data. To interpret or display extension data, see cryptoapi::CryptDecodeObjectEx and cryptoapi::CryptFormatObject.""" - ... - - -class PyCERT_KEY_ATTRIBUTES_INFO: - """Dict representing a CERT_KEY_ATTRIBUTES_INFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def KeyId(self) -> Any: - """Usually a hash that uniquely identifies the key""" - ... - - @property - def IntendedKeyUsage(self) -> PyCRYPT_BIT_BLOB: - """Contains a byte with CERT_*_KEY_USAGE flags""" - ... - - @property - def PrivateKeyUsagePeriod(self) -> Any: - """Private key's begin and end effective dates, may be None""" - ... - - -class PyCERT_NAME_INFO: - """Sequence of CERT_RDN's""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCERT_NAME_VALUE: - """Dict containing type (CERT_RDN_*) and a unicode string""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCERT_OTHER_NAME: - """Dict containing {ObjId, Value}. - -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 - -using X509_UNICODE_NAME_VALUE to return the actual unicode string""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCERT_POLICY_INFO: - """Dict containing a certificate policy""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def PolicyIdentifier(self) -> Any: - """OID identifying the policy""" - ... - - @property - def PolicyQualifier(self) -> Any: - """Sequence of CERT_POLICY_QUALIFIER dicts""" - ... - - -class PyCERT_PUBLIC_KEY_INFO: - """Dict containing an exported public key""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def Algorithm(self) -> PyCRYPT_ALGORITHM_IDENTIFIER: - """Dict containing OID of the public key algorithm""" - ... - - @property - def PublicKey(self) -> PyCRYPT_BIT_BLOB: - """Dict containing the encoded public key""" - ... - - -class PyCOMSTAT: - """A Python object, representing an COMSTAT structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def cbInQue(self) -> int: - """Specifies the number of bytes received by the serial provider but not yet read by a win32file::ReadFile operation""" - ... - - @property - def cbOutQue(self) -> int: - """Specifies the number of bytes of user data remaining to be transmitted for all write operations. This value will be zero for a nonoverlapped write.""" - ... - - @property - def fCtsHold(self) -> int: - """Specifies whether transmission is waiting for the CTS (clear-to-send) signal to be sent. If this member is TRUE, transmission is waiting.""" - ... - - @property - def fDsrHold(self) -> int: - """Specifies whether transmission is waiting for the DSR (data-set-ready) signal to be sent. If this member is TRUE, transmission is waiting.""" - ... - - @property - def fRlsdHold(self) -> int: - """Specifies whether transmission is waiting for the RLSD (receive-line-signal-detect) signal to be sent. If this member is TRUE, transmission is waiting.""" - ... - - @property - def fXoffHold(self) -> int: - """Specifies whether transmission is waiting because the XOFF character was received. If this member is TRUE, transmission is waiting.""" - ... - - @property - def fXoffSent(self) -> int: - """Specifies whether transmission is waiting because the XOFF character was transmitted. If this member is TRUE, transmission is waiting. Transmission halts when the XOFF character is transmitted to a system that takes the next character as XON, regardless of the actual character.""" - ... - - @property - def fEof(self) -> int: - """Specifies whether the end-of-file (EOF) character has been received. If this member is TRUE, the EOF character has been received.""" - ... - - @property - def fTxim(self) -> int: - """If this member is TRUE, there is a character queued for transmission that has come to the communications device by way of the TransmitCommChar function. The communications device transmits such a character ahead of other characters in the device's output buffer.""" - ... - - @property - def fReserved(self) -> int: - """Reserved; do not use.""" - ... - - -class PyCOORD: - """Wrapper for a COORD struct. Create using PyCOORDType(X,Y)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def X(self) -> Any: - """Horizontal coordinate""" - ... - - @property - def Y(self) -> Any: - """Vertical coordinate""" - ... - - -class PyCREDENTIAL: - """A dictionary containing information for a CREDENTIAL struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def Flags(self) -> Any: - """Combination of CRED_FLAGS_PROMPT_NOW, CRED_FLAGS_USERNAME_TARGET""" - ... - - @property - def Type(self) -> Any: - """Type of credential, one of CRED_TYPE_* values""" - ... - - @property - def TargetName(self) -> str: - """Target of credential, can end with * for wildcard matching""" - ... - - @property - def Comment(self) -> str: - """Descriptive text""" - ... - - @property - def LastWritten(self) -> PyTime: - """Modification time, ignored on input""" - ... - - @property - def CredentialBlob(self) -> str: - """Contains password for username credential, or PIN for certificate credential. This member is write-only.""" - ... - - @property - def Persist(self) -> Any: - """Specifies scope of persistence, one of CRED_PERSIST_* values""" - ... - - @property - def Attributes(self) -> Any: - """tuple of PyCREDENTIAL_ATTRIBUTE dicts containing application-specific data, can be None""" - ... - - @property - def TargetAlias(self) -> str: - """Alias for TargetName, only valid with CRED_TYPE_GENERIC""" - ... - - @property - def UserName(self) -> str: - """User to be authenticated by target. Can be of the form username@domain or domain\\username. For CRED_TYPE_DOMAIN_CERTIFICATE, use win32cred::CredMarshalCredential to marshal the SHA1 hash of user's certficate""" - ... - - -class PyCREDENTIAL_ATTRIBUTE: - """A dictionary containing information for a CREDENTIAL_ATTRIBUTE struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def Keyword(self) -> str: - """Attribute name, at most CRED_MAX_STRING_LENGTH chars""" - ... - - @property - def Flags(self) -> Any: - """Reserved, use only 0""" - ... - - @property - def Value(self) -> Any: - """Attribute value, at most CRED_MAX_VALUE_SIZE bytes. Unicode objects are treated as raw bytes.""" - ... - - -class PyCREDENTIAL_TARGET_INFORMATION: - """A dictionary representing a CREDENTIAL_TARGET_INFORMATION struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def TargetName(self) -> str: - """Target of credentials""" - ... - - @property - def NetbiosServerName(self) -> str: - ... - - @property - def DnsServerName(self) -> str: - ... - - @property - def NetbiosDomainName(self) -> str: - ... - - @property - def DnsDomainName(self) -> str: - ... - - @property - def DnsTreeName(self) -> str: - ... - - @property - def PackageName(self) -> str: - """Name of security package which mapped TargetName""" - ... - - @property - def Flags(self) -> Any: - """CRED_TI_* flags""" - ... - - @property - def CredTypes(self) -> tuple[Any, ...]: - """tuple of CRED_TYPE_* values indicating which types of credentials are acceptable to target""" - ... - - -class PyCREDUI_INFO: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def Parent(self) -> int: - """Handle to parent window, can be None""" - ... - - @property - def MessageText(self) -> str: - """Message to appear in dialog""" - ... - - @property - def CaptionText(self) -> str: - """Title of the dialog window""" - ... - - @property - def Banner(self) -> int: - """Handle to a bitmap to be displayed""" - ... - - -class PyCRYPTHASH: - """Handle to a cryptographic hash""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CryptDestroyHash(self) -> None: - """ - Frees the hash object - -Args: - - - -Returns: - - None - - """ - ... - - def CryptDuplicateHash(self, Flags: Any = 0) -> PyCRYPTHASH: - """ - Clones the hash object - -Args: - - Flags(Any):Reserved, use 0 if passed - -Returns: - - PyCRYPTHASH - - """ - ... - - def CryptHashData(self, Data: str, Flags: Any = 0) -> None: - """ - Adds data to the hash - -Args: - - Data(str):Data to be hashed - Flags(Any):CRYPT_USERDATA or 0CommentsIf Flags is CRYPT_USERDATA, provider is expected to prompt user to enter data. MSDN says that MS CSPs ignore this flag - -Returns: - - None - - """ - ... - - def CryptHashSessionKey(self, Key: PyCRYPTKEY, Flags: Any = 0) -> None: - """ - Hashes a session key - -Args: - - Key(PyCRYPTKEY):The session key to be hashed - Flags(Any):CRYPT_LITTLE_ENDIAN or 0 - -Returns: - - None - - """ - ... - - def CryptSignHash(self, KeySpec: Any, Flags: Any = 0) -> str: - """ - Signs the hash - -Args: - - KeySpec(Any):The key to be used to sign the hash, AT_KEYEXCHANGE,AT_SIGNATURE - Flags(Any):CRYPT_NOHASHOID,CRYPT_X931_FORMAT or 0CommentsThis methods signs only the hash, not the data that the hash represents - -Returns: - - str - - """ - ... - - def CryptVerifySignature(self, Signature: str, PubKey: PyCRYPTKEY, Flags: Any = 0) -> None: - """ - Verifies that a signature matches hashed data - -Args: - - Signature(str):Signature data to verify - PubKey(PyCRYPTKEY):Public key of signer - Flags(Any):CRYPT_NOHASHOID,CRYPT_X931_FORMAT or 0 - -Returns: - - None - - """ - ... - - def CryptGetHashParam(self, Param: Any, Flags: Any = 0) -> Any: - """ - Retrieves the specified attribute of the hash - -Args: - - Param(Any):The parameter to retrieve: HP_ALGID, HP_HASHSIZE, or HP_HASHVAL - Flags(Any):Reserved, use 0 if passed inCommentsAfter this method has been called, no more data can be hashedReturn ValueType of returned object is dependent on the Param passed in - -Returns: - - Any:Reserved, use 0 if passed in -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 - - - """ - ... - - -class PyCRYPTKEY: - """Handle to a cryptographic key""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def HCRYPTPROV(self) -> Any: - """CSP used by the key""" - ... - - @property - def HCRYPTKEY(self) -> Any: - """Plain integer handle to the key""" - ... - - def CryptDestroyKey(self) -> None: - """ - Releases the handle to the key (does not delete permanent keys) - -Args: - - - -Returns: - - None - - """ - ... - - def CryptExportKey(self, ExpKey: PyCRYPTKEY, BlobType: Any, Flags: Any = 0) -> Any: - """ - Exports key or key pair as an encrypted blob - -Args: - - ExpKey(PyCRYPTKEY):Public key or session key of destination user. Use None if exporting a PUBLICKEYBLOB - BlobType(Any):One of OPAQUEKEYBLOB,PRIVATEKEYBLOB,PUBLICKEYBLOB,SIMPLEBLOB,PLAINTEXTKEYBLOB,SYMMETRICWRAPKEYBLOB - Flags(Any):Combination of CRYPT_DESTROYKEY,CRYPT_SSL2_FALLBACK,CRYPT_OAEP or 0Return ValueReturns a binary blob that can be imported via PyCRYPTPROV::CryptImportKey - -Returns: - - Any:Combination of CRYPT_DESTROYKEY,CRYPT_SSL2_FALLBACK,CRYPT_OAEP or 0 -Return ValueReturns a binary blob that can be imported via PyCRYPTPROV::CryptImportKey - - - """ - ... - - def CryptGetKeyParam(self, Param: Any, Flags: Any = 0) -> Any: - """ - Retrieves key parameters - -Args: - - Param(Any):One of the KP_* constants - Flags(Any):Reserved, use only 0Return ValueType of returned object is dependent on the requested attribute - -Returns: - - Any:Reserved, use only 0 -Return ValueType of returned object is dependent on the requested attribute - - - """ - ... - - def CryptDuplicateKey(self, Reserved: Any = 0, Flags: Any = 0) -> PyCRYPTKEY: - """ - Creates an independent copy of the key - -Args: - - Reserved(Any):Use 0 if passed in - Flags(Any):Also reserved, use 0 - -Returns: - - PyCRYPTKEY - - """ - ... - - def CryptEncrypt(self, Final: Any, Data: Any, Hash: PyCRYPTHASH = None, Flags: Any = 0) -> Any: - """ - Encrypts and optionally hashes data - -Args: - - Final(Any):Boolean, use True if this is final encryption operation - Data(Any):Data to be encrypted - Hash(PyCRYPTHASH):Hash to be updated with data passed in, can be None - Flags(Any):Reserved, use 0 if passed in - -Returns: - - Any - - """ - ... - - def CryptDecrypt(self, Final: Any, Data: Any, Hash: PyCRYPTHASH = None, Flags: Any = 0) -> Any: - """ - Decrypts data - -Args: - - Final(Any):Boolean, use True is this is last (or only) operation - Data(Any):Data to be decrypted - Hash(PyCRYPTHASH):Hash to be used in signature verification, can be None - Flags(Any):Reserved, use only 0 - -Returns: - - Any - - """ - ... - - -class PyCRYPTMSG: - """Wrapper for a cryptographic message handle""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def HCRYPTMSG(self) -> Any: - """Raw message handle""" - ... - - def CryptMsgClose(self) -> None: - """ - Closes the message handle - -Args: - - - -Returns: - - None - - """ - ... - - -class PyCRYPTPROTECT_PROMPTSTRUCT: - """A tuple representing a CRYPTPROTECT_PROMPTSTRUCT structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCRYPTPROV: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CryptReleaseContext(self, Flags: Any = 0) -> None: - """ - Releases the CSP handle - -Args: - - Flags(Any):Reserved, use 0 if passed in - -Returns: - - None - - """ - ... - - def CryptGenKey(self, Algid: Any, Flags: Any, KeyLen: Any = 0) -> PyCRYPTKEY: - """ - Generates a key pair or a session key - -Args: - - Algid(Any):Algorithm identifier, one of the CALG_* values, or AT_KEYEXCHANGE/AT_SIGNATURE - Flags(Any):Combination of CRYPT_CREATE_SALT,CRYPT_EXPORTABLE,CRYPT_NO_SALT,CRYPT_PREGEN,CRYPT_USER_PROTECTED,CRYPT_ARCHIVABLE - KeyLen(Any):Length of key to generate, can be 0 to use provider's default key lengthCommentsDiffers from Api call in that the length is passed in separately - -Returns: - - PyCRYPTKEY - - """ - ... - - def CryptGetProvParam(self, Param: Any, Flags: Any = 0) -> None: - """ - Retrieves specified attribute of provider - -Args: - - Param(Any):One of the PP_* values - Flags(Any):If param if PP_KEYSET_SEC_DESCR, can be a combination of OWNER_SECURITY_INFORMATION,GROUP_SECURITY_INFORMATION,DACL_SECURITY_INFORMATION,SACL_SECURITY_INFORMATIONReturn ValueType of returned object is dependent on the attribute requested - -Returns: - - 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 - - - """ - ... - - def CryptGetUserKey(self, KeySpec: Any) -> PyCRYPTKEY: - """ - Returns a handle to one of user's key pairs - -Args: - - KeySpec(Any):AT_KEYEXCHANGE or AT_SIGNATURE (some providers may implement extra key specs) - -Returns: - - PyCRYPTKEY - - """ - ... - - def CryptGenRandom(self, Len: Any, SeedData: str = None) -> str: - """ - Generates random data of specified length - -Args: - - Len(Any):Number of bytes to generate - SeedData(str):Random seed data - -Returns: - - str - - """ - ... - - def CryptCreateHash(self, Algid: Any, Key: PyCRYPTKEY = None, Flags: Any = 0) -> PyCRYPTHASH: - """ - Creates a hash object for hashing large amounts of data - -Args: - - Algid(Any):An algorithm identifier, CALG_*. - Key(PyCRYPTKEY):Used only for keyed hashes (MAC or HMAC), use None otherwise - Flags(Any):Reserved, use 0 if passed in - -Returns: - - PyCRYPTHASH - - """ - ... - - def CryptImportKey(self, Data: Any, PubKey: PyCRYPTKEY = None, Flags: Any = 0) -> PyCRYPTKEY: - """ - None - -Args: - - Data(Any):The key blob to be imported - PubKey(PyCRYPTKEY):Key to be used to decrypt the blob, not used for importing public keys - Flags(Any):Combination of CRYPT_EXPORTABLE, CRYPT_OAEP, CRYPT_NO_SALT, CRYPT_USER_PROTECTED - -Returns: - - PyCRYPTKEY - - """ - ... - - def CryptExportPublicKeyInfo(self, KeySpec: Any, CertEncodingType: Any) -> PyCERT_PUBLIC_KEY_INFO: - """ - Exports a public key to send to other users - -Returned dict can be serialized for sending to another python application using pickle.dump - -Args: - - KeySpec(Any):AT_KEYEXCHANGE or AT_SIGNATURE - CertEncodingType(Any):Specifies encoding for exported key info - -Returns: - - PyCERT_PUBLIC_KEY_INFO - - """ - ... - - def CryptImportPublicKeyInfo(self, Info: Any, CertEncodingType: Any) -> PyCRYPTKEY: - """ - Imports another user's public key - -Args: - - Info(Any):PyCERT_PUBLIC_KEY_INFO dictionary as returned by PyCRYPTPROV::CryptExportPublicKeyInfo - CertEncodingType(Any):Specifies encoding for exported key info - -Returns: - - PyCRYPTKEY - - """ - ... - - -class PyCRYPT_ALGORITHM_IDENTIFIER: - """Dictionary containing information that identifies an encryption - -algorithm and any extra parameters it requires""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def ObjId(self) -> Any: - """An szOID_* string identifying the algorithm""" - ... - - @property - def Parameters(self) -> Any: - """Blob of binary data containing encoded parameters""" - ... - - -class PyCRYPT_ATTRIBUTE: - """Dict representing a CRYPT_ATTRIBUTE struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def ObjId(self) -> Any: - """An szOID_* string identifying the attribute""" - ... - - @property - def Value(self) -> tuple[Any, ...]: - """A sequence of buffers containing the attribute values""" - ... - - -class PyCRYPT_BIT_BLOB: - """Dict containing raw data of a certain bit length""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def Data(self) -> Any: - """Binary data""" - ... - - @property - def UnusedBits(self) -> Any: - """Nbr of bits of last byte that are unused""" - ... - - -class PyCRYPT_DECRYPT_MESSAGE_PARA: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def CertStores(self) -> tuple[Any, ...]: - """Sequence of certificate stores to be searched for a certificate with a private key that can be used to decrypt the message""" - ... - - @property - def MsgAndCertEncodingType(self) -> Any: - """Encoding types, optional. Defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" - ... - - @property - def Flags(self) -> Any: - """Optional. CRYPT_MESSAGE_SILENT_KEYSET_FLAG can be used to suppress any dialogs that might be triggered by accessing a key container, such as a request for a PIN.""" - ... - - -class PyCRYPT_ENCRYPT_MESSAGE_PARA: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def ContentEncryptionAlgorithm(self) -> PyCRYPT_ALGORITHM_IDENTIFIER: - """Identifies the algorithm to be used""" - ... - - @property - def CryptProv(self) -> PyCRYPTPROV: - """Optional. Handle to provider that will perform encryption, can be None for default provider""" - ... - - @property - def EncryptionAuxInfo(self) -> Any: - """Optional. Extra info required by some CSP's. Not supported yet, use only None""" - ... - - @property - def Flags(self) -> Any: - """Optional. Combination of CRYPT_MESSAGE_*_FLAG constants""" - ... - - @property - def InnerContentType(self) -> Any: - """Optional. Only used if message to be encrypted is already encoded""" - ... - - @property - def MsgEncodingType(self) -> Any: - """Optional. Defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" - ... - - -class PyCRYPT_SIGN_MESSAGE_PARA: - """Dict of parms defining how a message will be signed""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def SigningCert(self) -> PyCERT_CONTEXT: - """Certficate to be used to sign message""" - ... - - @property - def HashAlgorithm(self) -> PyCRYPT_ALGORITHM_IDENTIFIER: - """Algorithm to be used for signed hash""" - ... - - @property - def HashAuxInfo(self) -> Any: - """Optional. Param is reserved, use only None.""" - ... - - @property - def MsgCert(self) -> tuple[PyCERT_CONTEXT, ...]: - """Optional sequence of certificate to be included in the message.""" - ... - - @property - def MsgCrl(self) -> tuple[Any, ...]: - """Optional. Sequence of certificate revocation lists. Not yet supported, use only None.""" - ... - - @property - def AuthAttr(self) -> tuple[PyCRYPT_ATTRIBUTE, ...]: - """Sequence of canonical attributes to be added to the message""" - ... - - @property - def UnauthAttr(self) -> tuple[PyCRYPT_ATTRIBUTE, ...]: - """Sequence of arbitrary attributes""" - ... - - @property - def Flags(self) -> Any: - """Optional CRYPT_MESSAGE_*_FLAG that indicates content type if output is to be further encoded.""" - ... - - @property - def InnerContentType(self) -> Any: - """Optional, one of the CMSG_* content types if message is already encoded, .""" - ... - - @property - def MsgEncodingType(self) -> Any: - """Encoding types, optional. Defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" - ... - - -class PyCRYPT_VERIFY_MESSAGE_PARA: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def MsgAndCertEncodingType(self) -> Any: - """Encoding types, defaults to X509_ASN_ENCODING combined with PKCS_7_ASN_ENCODING""" - ... - - @property - def CryptProv(self) -> PyCRYPTPROV: - """CSP to be used to verify signature. Use None for default provider.""" - ... - - @property - def PyGetSignerCertificate(self) -> Any: - """Callback function that locates signer's certificate.""" - ... - - @property - def GetArg(self) -> Any: - """Argument to be passed to above function, can be any object.""" - ... - - -class PyCTL_CONTEXT: - """Object containing a Certificate Trust list""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def HCTL_CONTEXT(self) -> Any: - """Raw message handle""" - ... - - def CertFreeCTLContext(self) -> None: - """ - Closes the CTL handle - -Args: - - - -Returns: - - None - - """ - ... - - def CertEnumCTLContextProperties(self) -> tuple[Any, ...]: - """ - Lists property id's for the context - -Args: - - - -Returns: - - tuple[Any, ...] - - """ - ... - - def CertEnumSubjectInSortedCTL(self) -> tuple[tuple[Any, Any], ...]: - """ - Retrieves trusted subjects contained in CRL - -Args: - - - -Returns: - - tuple[tuple[Any, Any], ...]:PyCTL_CONTEXT.CertEnumSubjectInSortedCTL - -((str,str),...) = CertEnumSubjectInSortedCTL()Retrieves trusted subjects contained in CRL -Return ValueReturns a sequence of tuples containing two strings (SubjectIdentifier, EncodedAttributes) - - - """ - ... - - def CertDeleteCTLFromStore(self) -> None: - """ - Removes the CTL from the store that it is contained in - -Args: - - - -Returns: - - None - - """ - ... - - def CertSerializeCTLStoreElement(self, Flags: Any = 0) -> str: - """ - Serializes the CTL and its properties - -Args: - - Flags(Any):Reserved, use only 0 if passed in - -Returns: - - str - - """ - ... - - -class PyCTL_USAGE: - """Sequence of string OIDs (szOID_*). This struct is identical to CERT_ENHKEY_USAGE.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyConsoleScreenBuffer: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def SetConsoleActiveScreenBuffer(self) -> None: - """ - Sets this handle as the currently displayed screen - -buffer - -Args: - - - -Returns: - - None - - """ - ... - - def GetConsoleCursorInfo(self) -> tuple[Any, Any]: - """ - Retrieves size and visibility of console's - -cursor - -Args: - - - -Returns: - - tuple[Any, Any]:PyConsoleScreenBuffer.GetConsoleCursorInfo - -(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 - -if cursor is visible - - - """ - ... - - def SetConsoleCursorInfo(self, Size: Any, Visible: Any) -> None: - """ - Sets the size and visibility of console's cursor - -Args: - - Size(Any):Percentage of character size that cursor will occupy - Visible(Any):Determines if cursor is visible - -Returns: - - None - - """ - ... - - def GetConsoleMode(self) -> Any: - """ - Returns the input or output mode of the console buffer - -Args: - - - -Returns: - - Any:PyConsoleScreenBuffer.GetConsoleMode - -int = GetConsoleMode()Returns the input or output mode of the console buffer -Return ValueReturns a combination of ENABLE_*_INPUT or ENABLE_*_OUTPUT constants - - - """ - ... - - def SetConsoleMode(self, Mode: Any) -> None: - """ - Sets the input or output mode of the console buffer - -Args: - - Mode(Any):Combination of ENABLE_*_INPUT or ENABLE_*_OUTPUT constants - -Returns: - - None - - """ - ... - - def ReadConsole(self, NumberOfCharsToRead: Any) -> Any: - """ - Reads characters from the console input buffer - -Args: - - NumberOfCharsToRead(Any):Characters to read - -Returns: - - Any - - """ - ... - - def WriteConsole(self, Buffer: Any) -> Any: - """ - Writes characters at current cursor position - -Args: - - Buffer(Any):String or Unicode to be written to consoleReturn ValueReturns the number of characters written - -Returns: - - Any:String or Unicode to be written to consoleReturn ValueReturns the number of characters written - - - """ - ... - - def FlushConsoleInputBuffer(self) -> None: - """ - Flush input buffer - -Args: - - - -Returns: - - None - - """ - ... - - def SetConsoleTextAttribute(self, Attributes: Any) -> None: - """ - Sets character attributes for subsequent write operations - -Args: - - Attributes(Any):Attributes to be set, combination of FOREGROUND_*, BACKGROUND_*, and COMMON_LVB_* constants - -Returns: - - None - - """ - ... - - def SetConsoleCursorPosition(self, CursorPosition: PyCOORD) -> None: - """ - Sets the console screen buffer's cursor position - -Args: - - CursorPosition(PyCOORD):A PyCOORD containing the new cursor position - -Returns: - - None - - """ - ... - - def SetConsoleScreenBufferSize(self, Size: PyCOORD) -> None: - """ - Sets the size of the console screen buffer - -Args: - - Size(PyCOORD):COORD object containing the new dimensions - -Returns: - - None - - """ - ... - - def SetConsoleWindowInfo(self, Absolute: Any, ConsoleWindow: PySMALL_RECT) -> None: - """ - Changes size and position of a console's window - -Args: - - Absolute(Any):If False, coordinates are relative to current position - ConsoleWindow(PySMALL_RECT):A SMALL_RECT containing the new window coordinates - -Returns: - - None - - """ - ... - - def GetConsoleScreenBufferInfo(self) -> Any: - """ - Returns the state of the screen buffer - -Args: - - - -Returns: - - Any - - """ - ... - - def GetLargestConsoleWindowSize(self) -> PyCOORD: - """ - Returns the largest possible size for the - -console's window - -Args: - - - -Returns: - - PyCOORD - - """ - ... - - def FillConsoleOutputAttribute(self, Attribute: Any, Length: Any, WriteCoord: PyCOORD) -> Any: - """ - Set text attributes for a consecutive series of - -characters - -Args: - - Attribute(Any):Text attributes to be set, combination of FOREGROUND_*, BACKGROUND_*, and COMMON_LVB_* constants - Length(Any):The number of characters to set - WriteCoord(PyCOORD):The screen position to begin atReturn ValueReturns the number of character cells whose attributes were set - -Returns: - - Any:The screen position to begin atReturn ValueReturns the number of character cells whose attributes were set - - - """ - ... - - def FillConsoleOutputCharacter(self, Character: Any, Length: Any, WriteCoord: PyCOORD) -> Any: - """ - Sets consecutive character positions to a specified - -character - -Args: - - Character(Any):A single character to be used to fill the specified range - Length(Any):The number of characters positions to fill - WriteCoord(PyCOORD):The screen position to begin atReturn ValueReturns the number of characters actually written - -Returns: - - Any:The screen position to begin atReturn ValueReturns the number of characters actually written - - - """ - ... - - def ReadConsoleOutputCharacter(self, Length: Any, ReadCoord: PyCOORD) -> str: - """ - Reads consecutive characters from a starting - -position - -Args: - - Length(Any):The number of characters positions to read - ReadCoord(PyCOORD):The screen position start reading from - -Returns: - - str - - """ - ... - - def ReadConsoleOutputAttribute(self, Length: Any, ReadCoord: PyCOORD) -> tuple[Any, ...]: - """ - Retrieves attributes from consecutive character - -cells - -Args: - - Length(Any):The number of attributes to read - ReadCoord(PyCOORD):The screen position from which to start readingReturn ValueReturns a sequence of ints containing the attributes of a range of characters - -Returns: - - tuple[Any, ...]:The screen position from which to start readingReturn ValueReturns a sequence of ints containing the attributes of a range of characters - - - """ - ... - - def WriteConsoleOutputCharacter(self, Characters: Any, WriteCoord: PyCOORD) -> Any: - """ - Writes a string of characters at a specified position - -Args: - - Characters(Any):Characters to be written - WriteCoord(PyCOORD):The screen position at which to start writingReturn ValueReturns the number of characters actually written - -Returns: - - Any:The screen position at which to start writingReturn ValueReturns the number of characters actually written - - - """ - ... - - def WriteConsoleOutputAttribute(self, Attributes: tuple[Any, ...], WriteCoord: PyCOORD) -> Any: - """ - Sets the attributes of a range of character cells - -Args: - - Attributes(tuple[Any, ...]):A sequence of ints containing the attributes to be set - WriteCoord(PyCOORD):The screen position at which to start writingReturn ValueReturns the number of attributes set - -Returns: - - Any:The screen position at which to start writingReturn ValueReturns the number of attributes set - - - """ - ... - - def ScrollConsoleScreenBuffer( - self, - ScrollRectangle: PySMALL_RECT, - ClipRectangle: PySMALL_RECT, - DestinationOrigin: PyCOORD, - FillCharacter: Any, - FillAttribute: Any) -> None: - """ - Scrolls a region of the display - -Args: - - ScrollRectangle(PySMALL_RECT):The region to be scrolled - ClipRectangle(PySMALL_RECT):Rectangle that limits display area affected, can be None - DestinationOrigin(PyCOORD):The position to which ScrollRectangle will be moved - FillCharacter(Any):Character to fill in the area left blank by scrolling operation - FillAttribute(Any):Text attributes to apply to FillCharacter - -Returns: - - None - - """ - ... - - def GetCurrentConsoleFont(self, MaximumWindow: Any = False) -> tuple[Any, PyCOORD]: - """ - Returns currently displayed font - -Args: - - MaximumWindow(Any):If True, retrieves font size for maximum window sizeCommentsOnly exists on XP or later. 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 - -Returns: - - tuple[Any, PyCOORD]:If True, retrieves font size for maximum window size -Comments - -Only exists on XP or later. - -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 - - - """ - ... - - def GetConsoleFontSize(self, Font: Any) -> PyCOORD: - """ - Returns size of specified font for the console - -Args: - - Font(Any):Index of font as returned by GetCurrentConsoleFontCommentsOnly exists on XP or later. - -Returns: - - PyCOORD - - """ - ... - - def SetConsoleFont(self, Font: Any) -> None: - """ - Changes the font used by the screen buffer - -Args: - - Font(Any):The number of the font to be setCommentsFunction is not documented on MSDN - -Returns: - - None - - """ - ... - - def SetStdHandle(self, StdHandle: Any) -> None: - """ - Replaces one of calling process's standard handles with this handle - -Args: - - StdHandle(Any):Specifies handle to be replaced - STD_INPUT_HANDLE, STD_OUTPUT_HANDLE, or STD_ERROR_HANDLE - -Returns: - - None - - """ - ... - - def SetConsoleDisplayMode(self, Flags: Any, NewScreenBufferDimensions: PyCOORD) -> None: - """ - Sets the display mode of the console buffer - -Args: - - Flags(Any):CONSOLE_FULLSCREEN_MODE or CONSOLE_WINDOWED_MODE - NewScreenBufferDimensions(PyCOORD):New size of the screen buffer in characters - -Returns: - - None - - """ - ... - - def WriteConsoleInput(self, Buffer: tuple[PyINPUT_RECORD, ...]) -> Any: - """ - Places input records in the console's input queue - -Args: - - Buffer(tuple[PyINPUT_RECORD, ...]):A sequence of PyINPUT_RECORD objectsReturn ValueReturns the number of records written - -Returns: - - Any:A sequence of PyINPUT_RECORD objectsReturn ValueReturns the number of records written - - - """ - ... - - def ReadConsoleInput(self, Length: Any) -> tuple[PyINPUT_RECORD, ...]: - """ - Reads input records and removes them from - -the input queue - -Args: - - Length(Any):The number of input records to readCommentsThis functions blocks until at least one record is read. The number of records returned may be less than the nbr requestedReturn ValueReturns a sequence of PyINPUT_RECORD objects - -Returns: - - tuple[PyINPUT_RECORD, ...]:The number of input records to readComments - -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 - - - """ - ... - - def PeekConsoleInput(self, Length: Any) -> tuple[PyINPUT_RECORD, ...]: - """ - Returns pending input records without - -removing them from the input queue - -Args: - - Length(Any):The number of input records to readCommentsThis function does not block as ReadConsoleInput does. The number of records returned may be less than the nbr requestedReturn ValueReturns a sequence of PyINPUT_RECORD objects - -Returns: - - tuple[PyINPUT_RECORD, ...]:The number of input records to readComments - -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 - - - """ - ... - - def GetNumberOfConsoleInputEvents(self) -> Any: - """ - Returns the number of unread records in the input - -queue - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyCredHandle: - """Handle to a set of logon credentials, used with sspi authentication functions""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Detach(self) -> Any: - """ - Disassociates object from handle and returns integer value of handle, - -Args: - - - -Returns: - - Any - - """ - ... - - def FreeCredentialsHandle(self) -> None: - """ - Releases the credentials handle and makes object unusable - -Args: - - - -Returns: - - None - - """ - ... - - def QueryCredentialsAttributes(self, Attribute: Any) -> None: - """ - Returns information about the credentials - -Args: - - Attribute(Any):SECPKG_* constant specifying which type of information to returnCommentsOnly SECPKG_CRED_ATTR_NAMES currently supportedAttributeReturn typeSECPKG_CRED_ATTR_NAMESPyUnicode - returns username that credentials representSECPKG_ATTR_SUPPORTED_ALGSNot supported yet SecPkgCred_SupportedAlgs:SECPKG_ATTR_CIPHER_STRENGTHSNot supported yet SecPkgCred_CipherStrengths:SECPKG_ATTR_SUPPORTED_PROTOCOLSNot supported yet SecPkgCred_SupportedProtocols:Return ValueType of returned values is dependent on Attribute - -Returns: - - None:SECPKG_* constant specifying which type of information to returnComments - -Only SECPKG_CRED_ATTR_NAMES currently supported - - - -Attribute - - -Return type - - - -SECPKG_CRED_ATTR_NAMESPyUnicode - returns username that credentials represent -SECPKG_ATTR_SUPPORTED_ALGSNot supported yet - -SecPkgCred_SupportedAlgs: -SECPKG_ATTR_CIPHER_STRENGTHSNot supported yet - -SecPkgCred_CipherStrengths: -SECPKG_ATTR_SUPPORTED_PROTOCOLSNot supported yet - -SecPkgCred_SupportedProtocols: -Return ValueType of returned values is dependent on Attribute - - - """ - ... - - -class PyCtxtHandle: - """Security context handle, as used with sspi functions""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Detach(self) -> Any: - """ - Disassociates object from handle and returns integer value of handle - -Args: - - - -Returns: - - Any - - """ - ... - - def CompleteAuthToken(self, Token: PySecBufferDesc) -> None: - """ - Completes the authentication token - -Args: - - Token(PySecBufferDesc):The buffer that contains the token buffer used when the context was initializedCommentsThis method should be invoked on a context handle if the InitializeSecurityContext call that created it returned SEC_I_COMPLETE_NEEDED or SEC_I_COMPLETE_AND_CONTINUE - -Returns: - - None - - """ - ... - - def QueryContextAttributes(self, Attribute: Any) -> None: - """ - Retrieves info about a security context - -Args: - - Attribute(Any):SECPKG_ATTR_* constantCommentsNot all attributes are available for every security packageAttributeReturn typeSECPKG_ATTR_ACCESS_TOKENPyHANDLE - returns a handle to the context's access tokenSECPKG_ATTR_AUTHORITYPyUnicode - returns the name of the authenticating entitySECPKG_ATTR_CIPHER_STRENGTHS(int,int) - returns the mininum and maximum cipher strengths allowedSECPKG_ATTR_CONNECTION_INFOReturns a dictionary of connection info representing a SecPkgContext_ConnectionInfo structSECPKG_ATTR_SESSION_KEYstring - returns the session key for the contextSECPKG_ATTR_ISSUER_LIST_EX(int, string) - Returns names of trusted certificate issuersSECPKG_ATTR_FLAGSint - returns flags negotiated when context was establishedSECPKG_ATTR_PACKAGE_INFOdict - returns dictionary containing info for context's security packageSECPKG_ATTR_NEGOTIATION_INFO(int, dict) - returns state of negotiation (SECPKG_NEGOTIATION_COMPLETE, SECPKG_NEGOTIATION_OPTIMISTIC,SECPKG_NEGOTIATION_IN_PROGRESS) and info for negotiated packageSECPKG_ATTR_NAMESPyUnicode - returns the user name for the contextSECPKG_ATTR_SIZESdict containing buffer sizes to be used with the contextSECPKG_ATTR_PASSWORD_EXPIRYPyTime - returns time password expiresSECPKG_ATTR_LIFESPAN(PyTime,PyTime) - returns time period during which context is validSECPKG_ATTR_NATIVE_NAMES(PyUnicode,PyUnicode) - returns client and server namesSECPKG_ATTR_TARGET_INFORMATIONstring - returns the target for the contextSECPKG_ATTR_STREAM_SIZESdict (see SecPkgContext_StreamSizes) containing message buffer sizesSECPKG_ATTR_KEY_INFOdict (see SecPkgContext_KeyInfo) containing encryption key parametersSECPKG_ATTR_DCE_INFOnot supported yet SecPkgContext_DceInfoSECPKG_ATTR_LOCAL_CERT_CONTEXTnot supported yet PCCERT_CONTEXTSECPKG_ATTR_REMOTE_CERT_CONTEXTnot supported yet PCCERT_CONTEXTSECPKG_ATTR_ROOT_STOREnot supported yet HCERTCONTEXTSECPKG_ATTR_SUPPORTED_ALGSnot supported yet SecPkgCred_SupportedAlgsSECPKG_ATTR_SUPPORTED_PROTOCOLSnot supported yet SecPkgCred_SupportedProtocols - -Returns: - - None - - """ - ... - - def DeleteSecurityContext(self) -> None: - """ - Frees the security context and invalidates the handle - -Args: - - - -Returns: - - None - - """ - ... - - def QuerySecurityContextToken(self) -> Any: - """ - Returns the access token for a security context - -Args: - - - -Returns: - - Any - - """ - ... - - def MakeSignature(self, fqop: Any, Message: PySecBufferDesc, MessageSeqNo: Any) -> None: - """ - Creates a crytographic hash of a message using session key of the security - -context - -Args: - - fqop(Any):Flags that indicate quality of protection desired, specific to each security package - Message(PySecBufferDesc):Buffer set that includes buffers for input data and output signature - MessageSeqNo(Any):A sequential number used by some packages to verify that no extraneous messages have been receivedCommentsThe 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_TOKENReturn ValueReturns None on success, and output buffer in Message will contain the signature - -Returns: - - 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 - -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 - - - """ - ... - - def VerifySignature(self, Message: PySecBufferDesc, MessageSeqNo: Any) -> None: - """ - None - -Args: - - Message(PySecBufferDesc):SecBufferDesc that contains data buffer and signature buffer - MessageSeqNo(Any):A sequential number used by some packages to verify that no extraneous messages have been receivedCommentsThe buffer configuration is dependent on the security package. Usually there is a data buffer of type SECBUFFER_DATA and a signature buffer of type SECBUFFER_TOKENReturn ValueReturns quality of protection flags used to create signature - -Returns: - - 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 - -SECBUFFER_DATA - -and a signature buffer of type SECBUFFER_TOKEN -Return ValueReturns quality of protection flags used to create signature - - - """ - ... - - def EncryptMessage(self, fqop: Any, Message: PySecBufferDesc, MessageSeqNo: Any) -> None: - """ - Encrypts data with session key of security context - -Args: - - fqop(Any):Flags that indicate quality of protection desired, specific to each security package - Message(PySecBufferDesc):PySecBufferDesc that contains data buffer(s) to be encrypted - MessageSeqNo(Any):A sequential number used by some packages to verify that no extraneous messages have been receivedCommentsThe 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 SECBUFFER_TOKEN to receive signature or padding dataReturn ValueReturns None on success, and buffer(s) will contain encrypted data - -Returns: - - 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 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 - - - """ - ... - - def DecryptMessage(self, Message: PySecBufferDesc, MessageSeqNo: Any) -> None: - """ - None - -Args: - - Message(PySecBufferDesc):PySecBufferDesc containing data buffers to be decrypted - MessageSeqNo(Any):A sequential number used by some packages to verify that no extraneous messages have been receivedCommentsThe 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 SECBUFFER_PADDING containing signature, padding, or other extra data from encryption process that doesn't fit in first bufferReturn ValueReturns flags specfic to security package indicating quality of protection - -Returns: - - 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 - -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 - -in first buffer -Return ValueReturns flags specfic to security package indicating quality of protection - - - """ - ... - - def ImpersonateSecurityContext(self) -> None: - """ - Impersonates a client security context - -Args: - - - -Returns: - - None - - """ - ... - - def RevertSecurityContext(self) -> None: - """ - None - -Args: - - - -Returns: - - None - - """ - ... - - -class PyDCB: - """A Python object, representing an DCB structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def BaudRate(self) -> int: - """current baud rate""" - ... - - @property - def wReserved(self) -> int: - """not currently used""" - ... - - @property - def XonLim(self) -> int: - """transmit XON threshold""" - ... - - @property - def XoffLim(self) -> int: - """transmit XOFF threshold""" - ... - - @property - def ByteSize(self) -> int: - """number of bits/byte, 4-8""" - ... - - @property - def Parity(self) -> int: - """0-4=no,odd,even,mark,space""" - ... - - @property - def StopBits(self) -> int: - """0,1,2 = 1, 1.5, 2""" - ... - - @property - def XonChar(self) -> str: - """Tx and Rx XON character""" - ... - - @property - def XoffChar(self) -> str: - """Tx and Rx XOFF character""" - ... - - @property - def ErrorChar(self) -> str: - """error replacement character""" - ... - - @property - def EofChar(self) -> str: - """end of input character""" - ... - - @property - def EvtChar(self) -> str: - """received event character""" - ... - - @property - def wReserved1(self) -> int: - """reserved; do not use""" - ... - - @property - def fBinary(self) -> int: - """binary mode, no EOF check""" - ... - - @property - def fParity(self) -> int: - """enable parity checking""" - ... - - @property - def fOutxCtsFlow(self) -> int: - """CTS output flow control""" - ... - - @property - def fOutxDsrFlow(self) -> int: - """DSR output flow control""" - ... - - @property - def fDtrControl(self) -> int: - """DTR flow control type""" - ... - - @property - def fDsrSensitivity(self) -> int: - """DSR sensitivity""" - ... - - @property - def fTXContinueOnXoff(self) -> int: - """XOFF continues Tx""" - ... - - @property - def fOutX(self) -> int: - """XON/XOFF out flow control""" - ... - - @property - def fInX(self) -> int: - """XON/XOFF in flow control""" - ... - - @property - def fErrorChar(self) -> int: - """enable error replacement""" - ... - - @property - def fNull(self) -> int: - """enable null stripping""" - ... - - @property - def fRtsControl(self) -> int: - """RTS flow control""" - ... - - @property - def fAbortOnError(self) -> int: - """abort on error""" - ... - - @property - def fDummy2(self) -> int: - """reserved""" - ... - - -class PyDEVMODE: - """Python object wrapping a DEVMODE structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def SpecVersion(self) -> Any: - """Should always be set to DM_SPECVERSION""" - ... - - @property - def DriverVersion(self) -> Any: - """Version nbr assigned to printer driver by vendor""" - ... - - @property - def Size(self) -> Any: - """Size of structure""" - ... - - @property - def DriverExtra(self) -> Any: - """Number of extra bytes allocated for driver data, can only be set when new object is created""" - ... - - @property - def Fields(self) -> Any: - """Bitmask of win32con.DM_* constants indicating which members are set""" - ... - - @property - def Orientation(self) -> Any: - """Only applies to printers, DMORIENT_PORTRAIT or DMORIENT_LANDSCAPE""" - ... - - @property - def PaperSize(self) -> Any: - """Use 0 if PaperWidth and PaperLength are set, otherwise win32con.DMPAPER_* constant""" - ... - - @property - def PaperLength(self) -> Any: - """Specified in 1/10 millimeters""" - ... - - @property - def PaperWidth(self) -> Any: - """Specified in 1/10 millimeters""" - ... - - @property - def Position_x(self) -> Any: - """Position of display relative to desktop""" - ... - - @property - def Position_y(self) -> Any: - """Position of display relative to desktop""" - ... - - @property - def DisplayOrientation(self) -> Any: - """Display rotation: DMDO_DEFAULT,DMDO_90, DMDO_180, DMDO_270""" - ... - - @property - def DisplayFixedOutput(self) -> Any: - """DMDFO_DEFAULT, DMDFO_CENTER, DMDFO_STRETCH""" - ... - - @property - def Scale(self) -> Any: - """Specified as percentage, eg 50 means half size of original""" - ... - - @property - def Copies(self) -> Any: - """Nbr of copies to print""" - ... - - @property - def DefaultSource(self) -> Any: - """DMBIN_* constant, or can be a printer-specific value""" - ... - - @property - def PrintQuality(self) -> Any: - """DMRES_* constant, interpreted as DPI if positive""" - ... - - @property - def Color(self) -> Any: - """DMCOLOR_COLOR or DMCOLOR_MONOCHROME""" - ... - - @property - def Duplex(self) -> Any: - """For printers that do two-sided printing: DMDUP_SIMPLEX, DMDUP_HORIZONTAL, DMDUP_VERTICAL""" - ... - - @property - def YResolution(self) -> Any: - """Vertical printer resolution in DPI - if this is set, PrintQuality indicates horizontal DPI""" - ... - - @property - def TTOption(self) -> Any: - """TrueType options: DMTT_BITMAP, DMTT_DOWNLOAD, DMTT_DOWNLOAD_OUTLINE, DMTT_SUBDEV""" - ... - - @property - def Collate(self) -> Any: - """DMCOLLATE_TRUE or DMCOLLATE_FALSE""" - ... - - @property - def LogPixels(self) -> Any: - """Pixels per inch (only for display devices""" - ... - - @property - def BitsPerPel(self) -> Any: - """Color resolution in bits per pixel""" - ... - - @property - def PelsWidth(self) -> Any: - """Pixel width of display""" - ... - - @property - def PelsHeight(self) -> Any: - """Pixel height of display""" - ... - - @property - def DisplayFlags(self) -> Any: - """Combination of DM_GRAYSCALE and DM_INTERLACED""" - ... - - @property - def DisplayFrequency(self) -> Any: - """Refresh rate""" - ... - - @property - def ICMMethod(self) -> Any: - """Indicates where ICM is performed, one of win32con.DMICMMETHOD_* values""" - ... - - @property - def ICMIntent(self) -> Any: - """Intent of ICM, one of win32con.DMICM_* values""" - ... - - @property - def MediaType(self) -> Any: - """win32con.DMMEDIA_*, can also be a printer-specific value greater then DMMEDIA_USER""" - ... - - @property - def DitherType(self) -> Any: - """Dithering option, win32con.DMDITHER_*""" - ... - - @property - def Reserved1(self) -> Any: - """Reserved, use only 0""" - ... - - @property - def Reserved2(self) -> Any: - """Reserved, use only 0""" - ... - - @property - def Nup(self) -> Any: - """Controls printing of multiple logical pages per physical page, DMNUP_SYSTEM or DMNUP_ONEUP""" - ... - - @property - def PanningWidth(self) -> Any: - """Not used, leave as 0""" - ... - - @property - def PanningHeight(self) -> Any: - """Not used, leave as 0""" - ... - - @property - def DeviceName(self) -> Any: - """String of at most 32 chars""" - ... - - @property - def FormName(self) -> Any: - """Name of form as returned by win32print::EnumForms, at most 32 chars""" - ... - - @property - def DriverData(self) -> Any: - """Driver data appended to end of structure""" - ... - - def Clear(self) -> None: - """ - Resets all members of the structure - -Args: - - - -Returns: - - None - - """ - ... - - -class PyDEVMODEW: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def SpecVersion(self) -> Any: - """Should always be set to DM_SPECVERSION""" - ... - - @property - def DriverVersion(self) -> Any: - """Version nbr assigned to printer driver by vendor""" - ... - - @property - def Size(self) -> Any: - """Size of structure""" - ... - - @property - def DriverExtra(self) -> Any: - """Number of extra bytes allocated for driver data, can only be set when new object is created""" - ... - - @property - def Fields(self) -> Any: - """Bitmask of win32con.DM_* constants indicating which members are set""" - ... - - @property - def Orientation(self) -> Any: - """Only applies to printers, DMORIENT_PORTRAIT or DMORIENT_LANDSCAPE""" - ... - - @property - def PaperSize(self) -> Any: - """Use 0 if PaperWidth and PaperLength are set, otherwise win32con.DMPAPER_* constant""" - ... - - @property - def PaperLength(self) -> Any: - """Specified in 1/10 millimeters""" - ... - - @property - def PaperWidth(self) -> Any: - """Specified in 1/10 millimeters""" - ... - - @property - def Position_x(self) -> Any: - """Position of display relative to desktop""" - ... - - @property - def Position_y(self) -> Any: - """Position of display relative to desktop""" - ... - - @property - def DisplayOrientation(self) -> Any: - """Display rotation: DMDO_DEFAULT,DMDO_90, DMDO_180, DMDO_270""" - ... - - @property - def DisplayFixedOutput(self) -> Any: - """DMDFO_DEFAULT, DMDFO_CENTER, DMDFO_STRETCH""" - ... - - @property - def Scale(self) -> Any: - """Specified as percentage, eg 50 means half size of original""" - ... - - @property - def Copies(self) -> Any: - """Nbr of copies to print""" - ... - - @property - def DefaultSource(self) -> Any: - """DMBIN_* constant, or can be a printer-specific value""" - ... - - @property - def PrintQuality(self) -> Any: - """DMRES_* constant, interpreted as DPI if positive""" - ... - - @property - def Color(self) -> Any: - """DMCOLOR_COLOR or DMCOLOR_MONOCHROME""" - ... - - @property - def Duplex(self) -> Any: - """For printers that do two-sided printing: DMDUP_SIMPLEX, DMDUP_HORIZONTAL, DMDUP_VERTICAL""" - ... - - @property - def YResolution(self) -> Any: - """Vertical printer resolution in DPI - if this is set, PrintQuality indicates horizontal DPI""" - ... - - @property - def TTOption(self) -> Any: - """TrueType options: DMTT_BITMAP, DMTT_DOWNLOAD, DMTT_DOWNLOAD_OUTLINE, DMTT_SUBDEV""" - ... - - @property - def Collate(self) -> Any: - """DMCOLLATE_TRUE or DMCOLLATE_FALSE""" - ... - - @property - def LogPixels(self) -> Any: - """Pixels per inch (only for display devices""" - ... - - @property - def BitsPerPel(self) -> Any: - """Color resolution in bits per pixel""" - ... - - @property - def PelsWidth(self) -> Any: - """Pixel width of display""" - ... - - @property - def PelsHeight(self) -> Any: - """Pixel height of display""" - ... - - @property - def DisplayFlags(self) -> Any: - """Combination of DM_GRAYSCALE and DM_INTERLACED""" - ... - - @property - def DisplayFrequency(self) -> Any: - """Refresh rate""" - ... - - @property - def ICMMethod(self) -> Any: - """Indicates where ICM is performed, one of win32con.DMICMMETHOD_* values""" - ... - - @property - def ICMIntent(self) -> Any: - """Intent of ICM, one of win32con.DMICM_* values""" - ... - - @property - def MediaType(self) -> Any: - """win32con.DMMEDIA_*, can also be a printer-specific value greater then DMMEDIA_USER""" - ... - - @property - def DitherType(self) -> Any: - """Dithering option, win32con.DMDITHER_*""" - ... - - @property - def Reserved1(self) -> Any: - """Reserved, use only 0""" - ... - - @property - def Reserved2(self) -> Any: - """Reserved, use only 0""" - ... - - @property - def Nup(self) -> Any: - """Controls printing of multiple logical pages per physical page, DMNUP_SYSTEM or DMNUP_ONEUP""" - ... - - @property - def PanningWidth(self) -> Any: - """Not used, leave as 0""" - ... - - @property - def PanningHeight(self) -> Any: - """Not used, leave as 0""" - ... - - @property - def DeviceName(self) -> str: - """String of at most 32 chars""" - ... - - @property - def FormName(self) -> Any: - """Name of form as returned by win32print::EnumForms, at most 32 chars""" - ... - - @property - def DriverData(self) -> Any: - """Driver data appended to end of structure""" - ... - - -class PyDISPLAY_DEVICE: - """Python object wrapping a DISPLAY_DEVICE structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def Size(self) -> Any: - """Size of structure""" - ... - - @property - def DeviceName(self) -> Any: - """String of at most 32 chars""" - ... - - @property - def DeviceString(self) -> Any: - """String of at most 128 chars""" - ... - - @property - def StateFlags(self) -> Any: - """Bitmask of win32con.DISPLAY_DEVICE_* constants indicating current device status""" - ... - - @property - def DeviceID(self) -> Any: - """String of at most 128 chars""" - ... - - @property - def DeviceKey(self) -> Any: - """String of at most 128 chars""" - ... - - def Clear(self) -> None: - """ - Resets all members of the structure - -Args: - - - -Returns: - - None - - """ - ... - - -class PyDLGITEMTEMPLATE: - """A tuple describing a control in a dialog box.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyDLGTEMPLATE: - """A tuple of items describing a dialog box, that can be used to create the dialog.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyDS_HANDLE: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyDS_NAME_RESULT_ITEM: - """A tuple representing a DS_NAME_RESULT_ITEM""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyDateTime: - """A Python object, representing an instant in time.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Format(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyDialogTemplate: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyEVTLOG_HANDLE: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyEVT_HANDLE: - """Handle to an event log, session, query, or any other object used with - -the Evt* event log functions on Vista and later. - -When the object is destroyed, EvtClose is called.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyEVT_RPC_LOGIN: - """tuple containing login credentials for a remote Event Log connection""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyEventLogRecord: - """An object containing the data in an EVENTLOGRECORD.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def Reserved(self) -> int: - ... - - @property - def RecordNumber(self) -> int: - ... - - @property - def TimeGenerated(self) -> PyTime: - ... - - @property - def TimeWritten(self) -> PyTime: - ... - - @property - def EventID(self) -> int: - ... - - @property - def EventType(self) -> int: - ... - - @property - def EventCategory(self) -> int: - ... - - @property - def ReservedFlags(self) -> int: - ... - - @property - def ClosingRecordNumber(self) -> int: - ... - - @property - def SourceName(self) -> str: - ... - - @property - def StringInserts(self) -> tuple[str, ...]: - ... - - @property - def Sid(self) -> PySID: - ... - - @property - def Data(self) -> str: - ... - - @property - def ComputerName(self) -> str: - ... - - -class PyGROUP_INFO_0: - """A dictionary holding the information in a Win32 GROUP_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def name(self) -> str: - """Name of the group""" - ... - - -class PyGROUP_INFO_1: - """A dictionary holding the information in a Win32 GROUP_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def name(self) -> str: - """Name of the group""" - ... - - @property - def comment(self) -> str: - """The group's comment.""" - ... - - -class PyGROUP_INFO_1002: - """A dictionary holding the information in a Win32 GROUP_INFO_1002 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def comment(self) -> str: - ... - - -class PyGROUP_INFO_1005: - """A dictionary holding the information in a Win32 GROUP_INFO_1005 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def attributes(self) -> Any: - ... - - -class PyGROUP_INFO_2: - """A dictionary holding the information in a Win32 GROUP_INFO_2 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def name(self) -> str: - """Name of the group""" - ... - - @property - def comment(self) -> str: - """The group's comment.""" - ... - - @property - def group_id(self) -> Any: - ... - - @property - def attributes(self) -> Any: - ... - - -class PyGROUP_USERS_INFO_0: - """A dictionary holding the information in a Win32 GROUP_USERS_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def name(self) -> str: - """Name of the group or user""" - ... - - -class PyGROUP_USERS_INFO_1: - """A dictionary holding the information in a Win32 GROUP_USERS_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def name(self) -> str: - """Name of the group or user""" - ... - - @property - def attributes(self) -> Any: - ... - - -class PyGdiHANDLE: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyGetSignerCertificate: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyHANDLE: - """A Python object, representing a win32 HANDLE.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def handle(self) -> Any: - """Integer value of the handleMethodsCloseCloses the handle closeSynonym for PyHANDLE::Close DetachDetaches the Win32 handle from the handle object. __nonzero__Used for detecting true/false. is nb_bool in Python 3.0 __int__Used when an integer representation of the handle object is required. __print__Used when the object is printed. tp_print __hash__Used when the hash value of an object is required tp_hash __str__Used when a string representation is required tp_str """ - ... - - def Close(self) -> None: - """ - Closes the underlying Win32 handle. - -Args: - - - -Returns: - - None - - """ - ... - - def close(self) -> None: - """ - Closes the underlying Win32 handle. - -Args: - - - -Returns: - - None - - """ - ... - - def Detach(self) -> Any: - """ - Detaches the Win32 handle from the handle object. - -Args: - - - -Returns: - - Any:PyHANDLE.Detach - -int = Detach()Detaches the Win32 handle from the handle object. -Comments - -After calling this function, the handle is effectively invalidated, - -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 - -handle object. -Return ValueThe result is the value of the handle before it is detached. If the - -handle is already detached, this will return zero. - - - """ - ... - - -class PyHDESK: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def SetThreadDesktop(self) -> None: - """ - Assigns this desktop to the calling thread - -Args: - - - -Returns: - - None - - """ - ... - - def EnumDesktopWindows(self) -> tuple[int, ...]: - """ - Returns a list of handles to all top-level windows on desktop - -Args: - - - -Returns: - - tuple[int, ...] - - """ - ... - - def SwitchDesktop(self) -> None: - """ - Activates the desktop - -Args: - - - -Returns: - - None - - """ - ... - - def CloseDesktop(self) -> None: - """ - Closes the desktop handle - -Args: - - - -Returns: - - None - - """ - ... - - -class PyHDEVNOTIFY: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyHHNTRACK: - """A Python object, representing an HHNTRACK - -structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def action(self) -> Any: - """Specifies the action the user is about to take. This is an HHACT_ constant.""" - ... - - @property - def hdr(self) -> Any: - """Standard WM_NOTIFY header(win32help::NMHDR).""" - ... - - @property - def curUrl(self) -> str: - """A multi-byte, zero-terminated string that specifies the topic navigated to, or the name of the help window being created.""" - ... - - @property - def winType(self) -> Any: - """A pointer to the current HH_WINTYPE structure (win32help::HH_WINTYPE).""" - ... - - -class PyHHN_NOTIFY: - """A Python object, representing an HHN_NOTIFY - -structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def hdr(self) -> Any: - """Standard WM_NOTIFY header.(win32help::NMHDR)""" - ... - - @property - def url(self) -> str: - """A multi-byte, zero-terminated string that specifies the topic navigated to, or the name of the help window being created.""" - ... - - -class PyHH_AKLINK: - """A Python object, representing an HH_AKLINK structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def indexOnFail(self) -> Any: - """Specifies whether to display the keyword in the Index tab of the HTML Help Viewer if the lookup fails. The value of window specifies the Help Viewer.""" - ... - - @property - def keywords(self) -> str: - """Specifies one or more ALink names or KLink keywords to look up. Multiple entries are delimited by a semicolon.""" - ... - - @property - def url(self) -> str: - """Specifies the topic file to navigate to if the lookup fails. url refers to a valid topic within the specified compiled help (.chm) file and does not support Internet protocols that point to an HTML file.""" - ... - - @property - def msgText(self) -> str: - """Specifies the text to display in a message box if the lookup fails and indexOnFail is FALSE and url is NULL.""" - ... - - @property - def msgTitle(self) -> str: - """Specifies the caption of the message box in which the msgText parameter appears.""" - ... - - @property - def window(self) -> str: - """Specifies the name of the window type in which to display one of the following: The selected topic, if the lookup yields one or more matching topics. The topic specified in url, if the lookup fails and a topic is specified in url. The Index tab, if the lookup fails and indexOnFail is specified as TRUE.""" - ... - - -class PyHH_FTS_QUERY: - """A Python object, representing an HH_FTS_QUERY - -structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def uniCodeStrings(self) -> Any: - """TRUE if all strings are Unicode.""" - ... - - @property - def proximity(self) -> Any: - """Word proximity.""" - ... - - @property - def stemmedSearch(self) -> Any: - """TRUE for StemmedSearch only.""" - ... - - @property - def titleOnly(self) -> Any: - """TRUE for Title search only.""" - ... - - @property - def execute(self) -> Any: - """TRUE to initiate the search.""" - ... - - @property - def searchQuery(self) -> str: - """String containing the search query.""" - ... - - -class PyHH_POPUP: - """A Python object, representing an HH_POPUP structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def hinst(self) -> Any: - """Instance handle of the program or DLL to retrieve the string resource from. Ignored if idString is zero.""" - ... - - @property - def idString(self) -> Any: - """Specifies zero, or a resource ID in the program or DLL specified in hinst.""" - ... - - @property - def clrForeground(self) -> Any: - """Specifies the RGB value to use for the foreground color of the pop-up window. To use the system color for the window text, specify -1.""" - ... - - @property - def clrBackground(self) -> Any: - """Specifies the RGB value to use for the background color of the pop-up window. To use the system color for the window background, specify -1.""" - ... - - @property - def text(self) -> str: - """Specifies the text to display if idString is zero.""" - ... - - @property - def font(self) -> str: - """Specifies the font attributes to use for the text in the pop-up window. Use the following format to specify font family, point size, character set, and font format: facename[, point size[, charset[ BOLD ITALIC UNDERLINE]]] To omit an attribute, enter a comma. For example, to specify bold, 10-pt, MS Sans Serif font, font would be: MS Sans Serif, 10, , BOLD""" - ... - - @property - def pt(self) -> Any: - """(x,y). Specifies (in pixels) where the top center of the pop-up window should be located.""" - ... - - @property - def margins(self) -> Any: - """(left,top,right,bottom). Specifies (in pixels) the margins to use on the left, top, right, and bottom sides of the pop-up window. The default for all rectangle members is -1.""" - ... - - -class PyHH_WINTYPE: - """A Python object, representing an HH_WINTYPE structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def uniCodeStrings(self) -> Any: - """Specifies whether the strings used in this structure are UNICODE.""" - ... - - @property - def validMembers(self) -> Any: - """Specifies which members in the structure are valid.""" - ... - - @property - def winProperties(self) -> Any: - """Specifies the properties of the window, such as whether it is the standard HTML Help Viewer or whether it includes a Search tab.""" - ... - - @property - def styles(self) -> Any: - """Specifies the styles used to create the window. These styles can be ignored, combined with extended styles, or used exclusively depending on the value of the validMembers and winProperties parameters.""" - ... - - @property - def exStyles(self) -> Any: - """Specifies the extended styles used to create the window. These styles can be ignored, combined with default styles, or used exclusively depending on the value of the validMembers and winProperties parameters.""" - ... - - @property - def showState(self) -> Any: - """Specifies the initial display state of the window. Valid values are the same as those for the Win32 API ShowWindow function.""" - ... - - @property - def hwndHelp(self) -> Any: - """Specifies the handle of the window if the window has been created.""" - ... - - @property - def hwndCaller(self) -> Any: - """Specifies the window that will receive HTML Help notification messages. Notification messages are sent via Windows WM_NOTIFY messages.""" - ... - - @property - def hwndToolBar(self) -> Any: - """Specifies the handle of the toolbar.""" - ... - - @property - def hwndNavigation(self) -> Any: - """Specifies the handle of the Navigation pane.""" - ... - - @property - def hwndHTML(self) -> Any: - """Specifies the handle of the Topic pane, which hosts Shdocvw.dll.""" - ... - - @property - def navWidth(self) -> Any: - """Specifies the width of the Navigation pane when the Help Viewer is expanded.""" - ... - - @property - def toolBarFlags(self) -> Any: - """Specifies which buttons to include on the toolbar.""" - ... - - @property - def notExpanded(self) -> Any: - """Specifies that the Help Viewer open with the Navigation pane closed.""" - ... - - @property - def curNavType(self) -> Any: - """Specifies the default tab to display on the Navigation pane.""" - ... - - @property - def idNotify(self) -> Any: - """Specifies a non-zero ID for enabling HTML Help notification messages. This ID is passed as the wParam value of Windows WM_NOTIFY messages.""" - ... - - @property - def typeName(self) -> str: - """A null-terminated string that specifies the name of the window type.""" - ... - - @property - def caption(self) -> str: - """A null-terminated string that specifies the caption to display in the title bar of the window.""" - ... - - @property - def windowPos(self) -> Any: - """(left,top,right,bottom). Specifies the coordinates of the window in pixels.""" - ... - - @property - def HTMLPos(self) -> Any: - """(left,top,right,bottom). Specifies the coordinates of the Topic pane.""" - ... - - @property - def toc(self) -> str: - """Specifies the contents (.hhc) file to display in the Navigation pane.""" - ... - - @property - def index(self) -> str: - """Specifies the index (.hhk) file to display in the Navigation pane.""" - ... - - @property - def file(self) -> str: - """Specifies the default HTML file to display in the Topic pane.""" - ... - - @property - def home(self) -> str: - """Specifies the file or URL to display in the Topic pane when the Home button is clicked.""" - ... - - @property - def jump1(self) -> str: - """Specifies the text to display underneath the Jump1 button.""" - ... - - @property - def jump2(self) -> str: - """Specifies the text to display underneath the Jump2 button.""" - ... - - @property - def urlJump1(self) -> str: - """Specifies the URL to jump to when the Jump1 button is clicked.""" - ... - - @property - def urlJump2(self) -> str: - """Specifies the URL to jump to when the Jump2 button is clicked.""" - ... - - -class PyHINTERNET: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyHKEY: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyHTHEME: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyHWINSTA: - """Wrapper for a handle to a window station - returned by CreateWindowStation, OpenWindowStation, or GetProcessWindowStation""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def EnumDesktops(self) -> tuple[Any, ...]: - """ - Lists names of desktops in the window station - -Args: - - - -Returns: - - tuple[Any, ...] - - """ - ... - - def SetProcessWindowStation(self) -> None: - """ - Associates the calling process with the window station - -Args: - - - -Returns: - - None - - """ - ... - - def CloseWindowStation(self) -> None: - """ - Closes the window station handle - -Args: - - - -Returns: - - None - - """ - ... - - -class PyICONINFO: - """tuple describing an icon or cursor""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIID: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyINPUT_RECORD: - """Interface to the INPUT_RECORD struct used with console IO functions. Create using - -PyINPUT_RECORDType(EventType)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def EventType(self) -> Any: - """One of KEY_EVENT, MOUSE_EVENT, WINDOW_BUFFER_SIZE_EVENT, MENU_EVENT, FOCUS_EVENT. Cannot be changed after object is created""" - ... - - @property - def KeyDown(self) -> Any: - """True for a key press, False for key release""" - ... - - @property - def RepeatCount(self) -> Any: - """Nbr of repeats generated (key was held down if >1)""" - ... - - @property - def VirtualKeyCode(self) -> Any: - """Device-independent key code, win32con.VK_*""" - ... - - @property - def VirtualScanCode(self) -> Any: - """Device-dependent scan code generated by keyboard""" - ... - - @property - def Char(self) -> str: - """Single unicode character generated by the keypress""" - ... - - @property - def ControlKeyState(self) -> Any: - """State of modifier keys, combination of CAPSLOCK_ON, ENHANCED_KEY, LEFT_ALT_PRESSED, LEFT_CTRL_PRESSED, NUMLOCK_ON, RIGHT_ALT_PRESSED, RIGHT_CTRL_PRESSED, SCROLLLOCK_ON, SHIFT_PRESSED""" - ... - - @property - def ButtonState(self) -> Any: - """Bitmask representing which mouse buttons were pressed.""" - ... - - @property - def EventFlags(self) -> Any: - """DOUBLE_CLICK, MOUSE_MOVED or MOUSE_WHEELED, or 0. If 0, indicates a mouse button press""" - ... - - @property - def MousePosition(self) -> PyCOORD: - """Position in character coordinates""" - ... - - @property - def Size(self) -> PyCOORD: - """New size of screen buffer in character rows/columns""" - ... - - @property - def SetFocus(self) -> Any: - """Reserved - Used only with type FOCUS_EVENT. This event is Reserved, and should be ignored.""" - ... - - @property - def CommandId(self) -> Any: - """Used only with event type MENU_EVENT, which is reserved and should not be used""" - ... - - -class PyLOCALGROUP_INFO_0: - """A dictionary holding the information in a Win32 LOCALGROUP_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def name(self) -> str: - """Name of the group""" - ... - - -class PyLOCALGROUP_INFO_1: - """A dictionary holding the information in a Win32 LOCALGROUP_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def name(self) -> str: - """Name of the group""" - ... - - @property - def comment(self) -> str: - """The group's comment.""" - ... - - -class PyLOCALGROUP_INFO_1002: - """A dictionary holding the information in a Win32 LOCALGROUP_INFO_1002 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def comment(self) -> str: - ... - - -class PyLOCALGROUP_MEMBERS_INFO_0: - """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_0 - -structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def sid(self) -> PySID: - ... - - -class PyLOCALGROUP_MEMBERS_INFO_1: - """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_1 - -structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def sid(self) -> PySID: - ... - - @property - def sidusage(self) -> Any: - ... - - @property - def name(self) -> str: - ... - - -class PyLOCALGROUP_MEMBERS_INFO_2: - """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_2 - -structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def sid(self) -> PySID: - ... - - @property - def sidusage(self) -> Any: - ... - - @property - def domainandname(self) -> str: - """string containing the name of the member prefixed by the domain name and the "\\" separator character""" - ... - - -class PyLOCALGROUP_MEMBERS_INFO_3: - """A dictionary holding the information in a Win32 LOCALGROUP_MEMBERS_INFO_3 - -structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def domainandname(self) -> str: - """string containing the name of the member prefixed by the domain name and the "\\" separator character""" - ... - - -class PyLOGBRUSH: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def Style(self) -> Any: - """Brush style, one of win32con.BS_* values""" - ... - - @property - def Color(self) -> Any: - """RGB color value. Can also be DIB_PAL_COLORS or DIB_RGB_COLORS if Style is BS_DIBPATTERN or BS_DIBPATTERNPT=""" - ... - - @property - def Hatch(self) -> Union[Any, int]: - """For BS_HATCH style, one of win32con.HS_*. Not used For BS_SOLID or BS_HOLLOW. For a pattern brush, this should be a handle to a bitmap""" - ... - - -class PyLOGFONT: - """A Python object, representing an PyLOGFONT structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def lfHeight(self) -> int: - ... - - @property - def lfWidth(self) -> int: - ... - - @property - def lfEscapement(self) -> int: - ... - - @property - def lfOrientation(self) -> int: - ... - - @property - def lfWeight(self) -> int: - ... - - @property - def lfItalic(self) -> int: - ... - - @property - def lfUnderline(self) -> int: - ... - - @property - def lfStrikeOut(self) -> int: - ... - - @property - def lfCharSet(self) -> int: - ... - - @property - def lfOutPrecision(self) -> int: - ... - - @property - def lfClipPrecision(self) -> int: - ... - - @property - def lfQuality(self) -> int: - ... - - @property - def lfPitchAndFamily(self) -> int: - ... - - @property - def lfFaceName(self) -> str: - """Name of the typeface, at most 31 characters""" - ... - - -class PyLSA_HANDLE: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyLUID_AND_ATTRIBUTES: - """A sequence containing (LUID,Attributes) representing an LUID_AND_ATTRIBUTES structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyLsaLogon_HANDLE: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyMSG: - """A tuple representing a win32 MSG structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyNETRESOURCE: - """A Python object that encapsulates a Win32 NETRESOURCE structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def dwScope(self) -> int: - ... - - @property - def dwType(self) -> int: - ... - - @property - def dwDisplayType(self) -> int: - ... - - @property - def dwUsage(self) -> int: - ... - - @property - def localName(self) -> str: - ... - - @property - def remoteName(self) -> str: - ... - - @property - def comment(self) -> str: - ... - - @property - def provider(self) -> str: - ... - - -class PyNET_VALIDATE_AUTHENTICATION_INPUT_ARG: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyNET_VALIDATE_PASSWORD_CHANGE_INPUT_ARG: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyNET_VALIDATE_PERSISTED_FIELDS: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyNMHDR: - """A Python object, representing an NMHDR - -structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def hwndFrom(self) -> Any: - """Window handle to the control sending a message. ??? 64-bit problem here ???""" - ... - - @property - def idFrom(self) -> Any: - """Identifier of the control sending a message.""" - ... - - @property - def code(self) -> Any: - """Notification code. This member can be a control-specific notification code or it can be one of the common notification codes.""" - ... - - -class PyNOTIFYICONDATA: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyOVERLAPPED: - """A Python object, representing an overlapped structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def Offset(self) -> int: - """Specifies a file position at which to start the transfer. The file position is a byte offset from the start of the file. The calling process sets this member before calling the ReadFile or WriteFile function. This member is ignored when reading from or writing to named pipes and communications devices.""" - ... - - @property - def OffsetHigh(self) -> int: - """Specifies the high word of the byte offset at which to start the transfer.""" - ... - - @property - def object(self) -> Any: - """Any python object that you want to attach to your overlapped I/O request.""" - ... - - @property - def dword(self) -> Any: - """An integer buffer that may be used by overlapped functions (eg, win32file::WaitCommEvent)""" - ... - - @property - def hEvent(self) -> int: - """Identifies an event set to the signaled state when the transfer has been completed. The calling process sets this member before calling the win32file::ReadFile, win32file::WriteFile, win32pipe::ConnectNamedPipe, or win32pipe::TransactNamedPipe function.""" - ... - - @property - def Internal(self) -> int: - """Reserved for operating system use. (pointer-sized value)""" - ... - - @property - def InternalHigh(self) -> int: - """Reserved for operating system use. (pointer-sized value)""" - ... - - -class PyOVERLAPPEDReadBuffer: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyPERF_COUNTER_DEFINITION: - """An object encapsulating a Windows NT Performance Monitor counter definition - -(PERF_COUNTER_DEFINITION).""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def DefaultScale(self) -> int: - """The default scale of the counter.""" - ... - - @property - def DetailLevel(self) -> int: - """The detail level of the counter.""" - ... - - @property - def CounterType(self) -> int: - """The counter type.""" - ... - - @property - def CounterNameTitleIndex(self) -> int: - ... - - @property - def CounterHelpTitleIndex(self) -> int: - """Sentinel""" - ... - - def Increment(self) -> None: - """ - Increments the value of the performance counter - -Args: - - - -Returns: - - None - - """ - ... - - def Decrement(self) -> None: - """ - Decrements the value of the performance counter - -Args: - - - -Returns: - - None - - """ - ... - - def Set(self) -> None: - """ - Sets the counter to a specific value - -Args: - - - -Returns: - - None - - """ - ... - - def Get(self) -> None: - """ - Gets the current value of the counter - -Args: - - - -Returns: - - None - - """ - ... - - -class PyPERF_OBJECT_TYPE: - """A Python object, representing a PERF_OBJECT_TYPE structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def ObjectNameTitleIndex(self) -> int: - ... - - @property - def ObjectHelpTitleIndex(self) -> int: - ... - - @property - def DefaultCounterIndex(self) -> int: - ... - - def Close(self) -> None: - """ - Closes the object. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyPOINT: - """tuple of two ints (x,y) representing a POINT struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyPROFILEINFO: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def UserName(self) -> str: - """Name of user for which to load profile""" - ... - - @property - def Flags(self) -> Any: - """Combination of PI_* flags""" - ... - - @property - def ProfilePath(self) -> str: - """Path to roaming profile, can be None. Use win32net::NetUserGetInfo to retrieve user's profile path""" - ... - - @property - def DefaultPath(self) -> str: - """Path to Default user profile, can be None""" - ... - - @property - def ServerName(self) -> str: - """Domain controller, can be None""" - ... - - @property - def PolicyPath(self) -> str: - """Location of policy file, can be None""" - ... - - @property - def Profile(self) -> PyHKEY: - """Handle to root of user's registry key. This member is output.""" - ... - - -class PyPerfMonManager: - """A Python object""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Close(self) -> None: - """ - Closes the performance monitor manager. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyPrinterHANDLE: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyRECT: - """tuple of 4 ints defining a rectangle: (left, top, right, bottom)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyResourceId: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySCROLLINFO: - """A tuple representing a SCROLLINFO structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySC_HANDLE: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySECURITY_ATTRIBUTES: - """A Python object, representing a SECURITY_ATTRIBUTES structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def bInheritHandle(self) -> Any: - """Specifies whether the returned handle is inherited when a new process is created. If this member is TRUE, the new process inherits the handle.""" - ... - - @property - def SECURITY_DESCRIPTOR(self) -> PySECURITY_DESCRIPTOR: - """A PySECURITY_DESCRIPTOR, or None""" - ... - - -class PySECURITY_DESCRIPTOR: - """A Python object, representing a SECURITY_DESCRIPTOR structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Initialize(self) -> None: - """ - Initialize the SD. - -Args: - - - -Returns: - - None - - """ - ... - - def GetSecurityDescriptorOwner(self) -> PySID: - """ - Return the owner of the security descriptor. - -Args: - - - -Returns: - - PySID - - """ - ... - - def GetSecurityDescriptorDacl(self) -> PyACL: - """ - Return the discretionary ACL of the security - -descriptor. - -Args: - - - -Returns: - - PyACL - - """ - ... - - def GetSecurityDescriptorSacl(self) -> PyACL: - """ - Return system access control list (SACL) of SD - -Args: - - - -Returns: - - PyACL - - """ - ... - - def GetSecurityDescriptorControl(self) -> tuple[Any, Any]: - """ - Returns tuple of Control bit flags and - -revision of SD. - -Args: - - - -Returns: - - tuple[Any, Any] - - """ - ... - - def SetSecurityDescriptorOwner(self, sid: PySID, bOwnerDefaulted: Any) -> None: - """ - Set owner SID. - -Args: - - sid(PySID):The sid to be set as owner in the security descriptor. - bOwnerDefaulted(Any):Normally set to false since this explicitely set the owner. - -Returns: - - None - - """ - ... - - def SetSecurityDescriptorGroup(self, sid: PySID, bOwnerDefaulted: Any) -> Any: - """ - Set group SID. - -Args: - - sid(PySID):The group sid to be set in the security descriptor. - bOwnerDefaulted(Any):Normally set to false since this explicitely set the owner. - -Returns: - - Any - - """ - ... - - def SetSecurityDescriptorSacl(self, bSaclPresent: Any, SACL: PyACL, bSaclDefaulted: Any) -> None: - """ - Replaces system access control list (SACL) in the security - -descriptor. - -Args: - - bSaclPresent(Any):A flag indicating if SACL is to be used. If false, last 2 parms are ignored. - SACL(PyACL):The SACL to set in the security descriptor - bSaclDefaulted(Any):Flag, set to false if user has specifically set the SACL. - -Returns: - - None - - """ - ... - - def IsValid(self) -> None: - """ - Determines if the security descriptor is valid. - -Args: - - - -Returns: - - None - - """ - ... - - def GetLength(self) -> None: - """ - return length of security descriptor (GetSecurityDescriptorLenght). - -Args: - - - -Returns: - - None - - """ - ... - - def IsSelfRelative(self) -> None: - """ - Returns 1 if security descriptor is self relative, 0 if absolute - -Args: - - - -Returns: - - None - - """ - ... - - def SetSecurityDescriptorControl(self, ControlBitsOfInterest: Any, ControlBitsToSet: Any) -> None: - """ - Sets the control bit flags related to inheritance for a - -security descriptor - -Args: - - ControlBitsOfInterest(Any):Bitmask of flags to be modified - ControlBitsToSet(Any):Bitmask containing flag values to setCommentsOnly exists on Windows 2000 or later - -Returns: - - None - - """ - ... - - -class PySERVER_INFO_100: - """A dictionary holding the information in a Win32 SERVER_INFO_100 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def platform_id(self) -> Any: - ... - - @property - def name(self) -> str: - ... - - -class PySERVER_INFO_101: - """A dictionary holding the information in a Win32 SERVER_INFO_101 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def platform_id(self) -> Any: - ... - - @property - def name(self) -> str: - ... - - @property - def version_major(self) -> Any: - ... - - @property - def version_minor(self) -> Any: - ... - - @property - def type(self) -> Any: - """one of the SV_TYPE_* constants""" - ... - - @property - def comment(self) -> str: - ... - - -class PySERVER_INFO_102: - """A dictionary holding the information in a Win32 SERVER_INFO_102 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def platform_id(self) -> Any: - ... - - @property - def name(self) -> str: - ... - - @property - def version_major(self) -> Any: - ... - - @property - def version_minor(self) -> Any: - ... - - @property - def type(self) -> Any: - """one of the SV_TYPE_* constants""" - ... - - @property - def comment(self) -> str: - ... - - @property - def users(self) -> Any: - ... - - @property - def disc(self) -> Any: - ... - - @property - def hidden(self) -> Any: - ... - - @property - def announce(self) -> Any: - ... - - @property - def anndelta(self) -> Any: - ... - - @property - def userpath(self) -> str: - ... - - -class PySERVER_INFO_402: - """A dictionary holding the information in a Win32 SERVER_INFO_402 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def ulist_mtime(self) -> Any: - ... - - @property - def glist_mtime(self) -> Any: - ... - - @property - def alist_mtime(self) -> Any: - ... - - @property - def security(self) -> Any: - ... - - @property - def numadmin(self) -> Any: - ... - - @property - def lanmask(self) -> Any: - ... - - @property - def guestacct(self) -> str: - ... - - @property - def chdevs(self) -> Any: - ... - - @property - def chdevq(self) -> Any: - ... - - @property - def chdevjobs(self) -> Any: - ... - - @property - def connections(self) -> Any: - ... - - @property - def shares(self) -> Any: - ... - - @property - def openfiles(self) -> Any: - ... - - @property - def sessopens(self) -> Any: - ... - - @property - def sessvcs(self) -> Any: - ... - - @property - def sessreqs(self) -> Any: - ... - - @property - def opensearch(self) -> Any: - ... - - @property - def activelocks(self) -> Any: - ... - - @property - def numreqbuf(self) -> Any: - ... - - @property - def sizreqbuf(self) -> Any: - ... - - @property - def numbigbuf(self) -> Any: - ... - - @property - def numfiletasks(self) -> Any: - ... - - @property - def alertsched(self) -> Any: - ... - - @property - def erroralert(self) -> Any: - ... - - @property - def logonalert(self) -> Any: - ... - - @property - def accessalert(self) -> Any: - ... - - @property - def diskalert(self) -> Any: - ... - - @property - def netioalert(self) -> Any: - ... - - @property - def maxauditsz(self) -> Any: - ... - - @property - def srvheuristics(self) -> str: - ... - - -class PySERVER_INFO_403: - """A dictionary holding the information in a Win32 SERVER_INFO_403 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def ulist_mtime(self) -> Any: - ... - - @property - def glist_mtime(self) -> Any: - ... - - @property - def alist_mtime(self) -> Any: - ... - - @property - def security(self) -> Any: - ... - - @property - def numadmin(self) -> Any: - ... - - @property - def lanmask(self) -> Any: - ... - - @property - def guestacct(self) -> str: - ... - - @property - def chdevs(self) -> Any: - ... - - @property - def chdevq(self) -> Any: - ... - - @property - def chdevjobs(self) -> Any: - ... - - @property - def connections(self) -> Any: - ... - - @property - def shares(self) -> Any: - ... - - @property - def openfiles(self) -> Any: - ... - - @property - def sessopens(self) -> Any: - ... - - @property - def sessvcs(self) -> Any: - ... - - @property - def sessreqs(self) -> Any: - ... - - @property - def opensearch(self) -> Any: - ... - - @property - def activelocks(self) -> Any: - ... - - @property - def numreqbuf(self) -> Any: - ... - - @property - def sizreqbuf(self) -> Any: - ... - - @property - def numbigbuf(self) -> Any: - ... - - @property - def numfiletasks(self) -> Any: - ... - - @property - def alertsched(self) -> Any: - ... - - @property - def erroralert(self) -> Any: - ... - - @property - def logonalert(self) -> Any: - ... - - @property - def accessalert(self) -> Any: - ... - - @property - def diskalert(self) -> Any: - ... - - @property - def netioalert(self) -> Any: - ... - - @property - def maxauditsz(self) -> Any: - ... - - @property - def srvheuristics(self) -> str: - ... - - @property - def auditedevents(self) -> Any: - ... - - @property - def autoprofile(self) -> Any: - ... - - @property - def autopath(self) -> str: - ... - - -class PySERVER_INFO_502: - """A dictionary holding the information in a Win32 SERVER_INFO_502 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def sessopens(self) -> Any: - ... - - @property - def sessvcs(self) -> Any: - ... - - @property - def opensearch(self) -> Any: - ... - - @property - def sizreqbuf(self) -> Any: - ... - - @property - def initworkitems(self) -> Any: - ... - - @property - def maxworkitems(self) -> Any: - ... - - @property - def rawworkitems(self) -> Any: - ... - - @property - def irpstacksize(self) -> Any: - ... - - @property - def maxrawbuflen(self) -> Any: - ... - - @property - def sessusers(self) -> Any: - ... - - @property - def sessconns(self) -> Any: - ... - - @property - def maxpagedmemoryusage(self) -> Any: - ... - - @property - def maxnonpagedmemoryusage(self) -> Any: - ... - - @property - def enableforcedlogoff(self) -> Any: - ... - - @property - def timesource(self) -> Any: - ... - - @property - def acceptdownlevelapis(self) -> Any: - ... - - @property - def lmannounce(self) -> Any: - ... - - -class PySERVER_INFO_503: - """A dictionary holding the information in a Win32 SERVER_INFO_503 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def sessopens(self) -> Any: - ... - - @property - def sessvcs(self) -> Any: - ... - - @property - def opensearch(self) -> Any: - ... - - @property - def sizreqbuf(self) -> Any: - ... - - @property - def initworkitems(self) -> Any: - ... - - @property - def maxworkitems(self) -> Any: - ... - - @property - def rawworkitems(self) -> Any: - ... - - @property - def irpstacksize(self) -> Any: - ... - - @property - def maxrawbuflen(self) -> Any: - ... - - @property - def sessusers(self) -> Any: - ... - - @property - def sessconns(self) -> Any: - ... - - @property - def maxpagedmemoryusage(self) -> Any: - ... - - @property - def maxnonpagedmemoryusage(self) -> Any: - ... - - @property - def enableforcedlogoff(self) -> Any: - ... - - @property - def timesource(self) -> Any: - ... - - @property - def acceptdownlevelapis(self) -> Any: - ... - - @property - def lmannounce(self) -> Any: - ... - - @property - def domain(self) -> str: - ... - - @property - def maxkeepsearch(self) -> Any: - ... - - @property - def scavtimeout(self) -> Any: - ... - - @property - def minrcvqueue(self) -> Any: - ... - - @property - def minfreeworkitems(self) -> Any: - ... - - @property - def xactmemsize(self) -> Any: - ... - - @property - def threadpriority(self) -> Any: - ... - - @property - def maxmpxct(self) -> Any: - ... - - @property - def oplockbreakwait(self) -> Any: - ... - - @property - def oplockbreakresponsewait(self) -> Any: - ... - - @property - def enableoplocks(self) -> Any: - ... - - @property - def enablefcbopens(self) -> Any: - ... - - @property - def enableraw(self) -> Any: - ... - - @property - def enablesharednetdrives(self) -> Any: - ... - - @property - def minfreeconnections(self) -> Any: - ... - - @property - def maxfreeconnections(self) -> Any: - ... - - -class PySHARE_INFO_0: - """A dictionary holding the infomation in a Win32 SHARE_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def netname(self) -> str: - ... - - -class PySHARE_INFO_1: - """A dictionary holding the infomation in a Win32 SHARE_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def netname(self) -> str: - ... - - @property - def type(self) -> Any: - ... - - @property - def remark(self) -> str: - ... - - -class PySHARE_INFO_2: - """A dictionary holding the infomation in a Win32 SHARE_INFO_2 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def netname(self) -> str: - ... - - @property - def type(self) -> Any: - ... - - @property - def remark(self) -> str: - ... - - @property - def permissions(self) -> Any: - ... - - @property - def max_uses(self) -> Any: - ... - - @property - def current_uses(self) -> Any: - ... - - @property - def path(self) -> str: - ... - - @property - def passwd(self) -> str: - ... - - -class PySHARE_INFO_501: - """A dictionary holding the infomation in a Win32 SHARE_INFO_501 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def netname(self) -> str: - ... - - @property - def type(self) -> Any: - ... - - @property - def remark(self) -> str: - ... - - @property - def flags(self) -> Any: - ... - - -class PySHARE_INFO_502: - """A dictionary holding the infomation in a Win32 SHARE_INFO_502 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def netname(self) -> str: - ... - - @property - def type(self) -> Any: - ... - - @property - def remark(self) -> str: - ... - - @property - def permissions(self) -> Any: - ... - - @property - def max_uses(self) -> Any: - ... - - @property - def current_uses(self) -> Any: - ... - - @property - def path(self) -> str: - ... - - @property - def passwd(self) -> str: - ... - - @property - def reserved(self) -> Any: - ... - - @property - def security_descriptor(self) -> PySECURITY_DESCRIPTOR: - ... - - -class PySID: - """A Python object, representing a SID structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Initialize(self, idAuthority: Any, numSubauthorities: Any) -> None: - """ - Initialize the SID. - -Args: - - idAuthority(Any):The identifier authority. - numSubauthorities(Any):The number of sub authorities to allocate. - -Returns: - - None - - """ - ... - - def IsValid(self) -> None: - """ - Determines if the SID is valid. - -Args: - - - -Returns: - - None - - """ - ... - - def SetSubAuthority(self, index: Any, val: Any) -> None: - """ - Sets a SID SubAuthority - -Args: - - index(Any):The index of the sub authority to set - val(Any):The value for the sub authorityCommentsSee the function SetSidSubAuthority - -Returns: - - None - - """ - ... - - def GetLength(self) -> Any: - """ - return length of SID (GetLengthSid). - -Args: - - - -Returns: - - Any - - """ - ... - - def GetSubAuthorityCount(self) -> Any: - """ - return nbr of subauthorities from SID - -Args: - - - -Returns: - - Any - - """ - ... - - def GetSubAuthority(self) -> Any: - """ - Returns specified subauthority from SID - -Args: - - - -Returns: - - Any - - """ - ... - - def GetSidIdentifierAuthority(self) -> tuple[Any, Any, Any, Any, Any, Any]: - """ - Returns a tuple of 6 SID_IDENTIFIER_AUTHORITY - -constants - -Args: - - - -Returns: - - tuple[Any, Any, Any, Any, Any, Any] - - """ - ... - - -class PySID_AND_ATTRIBUTES: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySIZE: - """tuple of two ints (cx,cy) representing a SIZE struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySMALL_RECT: - """Wrapper for a SMALL_RECT struct - -Create using PySMALL_RECTType(Left, Top, Right, Bottom). All params optional, defaulting to 0""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def Left(self) -> Any: - """Left side of rectangle""" - ... - - @property - def Top(self) -> Any: - """Top edge of rectangle""" - ... - - @property - def Right(self) -> Any: - """Right edge of rectangle""" - ... - - @property - def Bottom(self) -> Any: - """Bottome edge of rectangle""" - ... - - -class PySTARTUPINFO: - """A Python object, representing an STARTUPINFO structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def dwX(self) -> int: - """Specifies the x offset, in pixels, of the upper left corner of a window if a new window is created. The offset is from the upper left corner of the screen.""" - ... - - @property - def dwY(self) -> int: - """Specifies the y offset, in pixels, of the upper left corner of a window if a new window is created. The offset is from the upper left corner of the screen.""" - ... - - @property - def dwXSize(self) -> int: - """Specifies the width, in pixels, of the window if a new window is created.""" - ... - - @property - def dwYSize(self) -> int: - """Specifies the height, in pixels, of the window if a new window is created.""" - ... - - @property - def dwXCountChars(self) -> int: - """For console processes, if a new console window is created, specifies the screen buffer width in character columns. This value is ignored in a GUI process.""" - ... - - @property - def dwYCountChars(self) -> int: - """For console processes, if a new console window is created, specifies the screen buffer height in character rows.""" - ... - - @property - def dwFillAttribute(self) -> int: - """Specifies the initial text and background colors if a new console window is created in a console application. These values are ignored in GUI applications""" - ... - - @property - def dwFlags(self) -> int: - """This is a bit field that determines whether certain STARTUPINFO attributes are used when the process creates a window. To use many of the additional attributes, you typically must set the appropriate mask in this attribute, and also set the attributes themselves. Any combination of the win32con.STARTF_* flags can be specified.""" - ... - - @property - def wShowWindow(self) -> int: - """Can be any of the SW_ constants defined in win32con. For GUI processes, this specifies the default value the first time ShowWindow is called.""" - ... - - @property - def hStdInput(self) -> int: - ... - - @property - def hStdOutput(self) -> int: - ... - - @property - def hStdError(self) -> int: - ... - - @property - def lpDesktop(self) -> Union[Any, str]: - ... - - @property - def lpTitle(self) -> Union[Any, str]: - ... - - -class PySecBuffer: - """Python object wrapping a SecBuffer structure - -Created using win32security.PySecBufferType(type,size) where type is a SECBUFFER_* constant""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def BufferType(self) -> Any: - ... - - @property - def Buffer(self) -> str: - ... - - @property - def BufferSize(self) -> Any: - ... - - @property - def MaxBufferSize(self) -> Any: - ... - - def Clear(self) -> None: - """ - Resets the buffer to all NULL's, and set the current size to maximum - -Args: - - - -Returns: - - None - - """ - ... - - -class PySecBufferDesc: - """Sequence-like object that contains a group of buffers to be used with SSPI functions.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def append(self, buffer: Any) -> None: - """ - None - -Args: - - buffer(Any):PySecBuffer object to be attached to the group of buffers - -Returns: - - None - - """ - ... - - -class PyTOKEN_GROUPS: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyTOKEN_PRIVILEGES: - """An object representing Win32 token privileges.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyTRIVERTEX: - """Dict representing a TRIVERTEX struct containing color information at a point""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def x(self) -> Any: - """X coord in logical units""" - ... - - @property - def y(self) -> Any: - """Y coord in logical units""" - ... - - @property - def Red(self) -> Any: - """Red component""" - ... - - @property - def Green(self) -> Any: - """Green component""" - ... - - @property - def Blue(self) -> Any: - """Blue component""" - ... - - @property - def Alpha(self) -> Any: - """Transparency value""" - ... - - -class PyTRUSTEE: - """A dictionary representing a TRUSTEE structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def TrusteeForm(self) -> Any: - ... - - @property - def TrusteeType(self) -> Any: - ... - - @property - def Identifier(self) -> Any: - """Depends on the value of TrusteeForm (string or sid)""" - ... - - @property - def MultipleTrustee(self) -> Any: - """default is None""" - ... - - @property - def MultipleTrusteeOperation(self) -> Any: - """default is None""" - ... - - -class PyTS_HANDLE: - """Handle to a Terminal Server""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyTime: - """A Python object, representing an instant in time.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def year(self) -> Any: - ... - - @property - def month(self) -> Any: - ... - - @property - def weekday(self) -> Any: - ... - - @property - def day(self) -> Any: - ... - - @property - def hour(self) -> Any: - ... - - @property - def minute(self) -> Any: - ... - - @property - def second(self) -> Any: - ... - - @property - def msec(self) -> Any: - ... - - def Format(self, _format: str) -> str: - """ - Formats the time value. - -Args: - - _format(str):The format. See the comments section for a description of the supported flags.CommentsThe following format characters are supported.CharacterDescription%aAbbreviated weekday name%AFull weekday name%bAbbreviated month name%BFull month name%cDate and time representation appropriate for locale%dDay of month as decimal number (01 - 31)%HHour in 24-hour format (00 - 23)%IHour in 12-hour format (01 - 12)%jDay of year as decimal number (001 - 366)%mMonth as decimal number (01 - 12)%MMinute as decimal number (00 - 59)%pCurrent locale's A.M./P.M. indicator for 12-hour clock%SSecond as decimal number (00 - 59)%UWeek of year as decimal number, with Sunday as first day of week (00 - 51)%wWeekday as decimal number (0 - 6; Sunday is 0)%WWeek of year as decimal number, with Monday as first day of week (00 - 51)%xDate representation for current locale%XTime representation for current locale%yYear without century, as decimal number (00 - 99)%YYear with century, as decimal number%z, %ZTime-zone name or abbreviation; no characters if time zone is unknown%%Percent signAs in the printf function, the # flag may prefix any formatting code. In that case, the meaning of the format code is changed as follows.Format CodeMeaning%#a, %#A, %#b, %#B, %#p, %#X, %#z, %#Z, %#%# flag is ignored.%#cLong date and time representation, appropriate for current locale. For example: "Tuesday, March 14, 1995, 12:41:29".%#xLong date representation, appropriate to current locale. For example: "Tuesday, March 14, 1995".%#d, %#H, %#I, %#j, %#m, %#M, %#S, %#U, %#w, %#W, %#y, %#YRemove leading zeros (if any). - -Returns: - - str - - """ - ... - - -class PyUSER_INFO_0: - """A dictionary holding the information in a Win32 USER_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def name(self) -> str: - ... - - -class PyUSER_INFO_1: - """A dictionary holding the information in a Win32 USER_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def name(self) -> str: - ... - - @property - def password(self) -> str: - ... - - @property - def password_age(self) -> Any: - ... - - @property - def priv(self) -> Any: - ... - - @property - def home_dir(self) -> str: - ... - - @property - def comment(self) -> str: - ... - - @property - def flags(self) -> Any: - ... - - @property - def script_path(self) -> str: - ... - - -class PyUSER_INFO_10: - """A dictionary holding the information in a Win32 USER_INFO_10 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def name(self) -> str: - ... - - @property - def comment(self) -> str: - ... - - @property - def usr_comment(self) -> str: - ... - - @property - def full_name(self) -> str: - ... - - -class PyUSER_INFO_1003: - """A dictionary holding the information in a Win32 USER_INFO_1003 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def password(self) -> str: - ... - - -class PyUSER_INFO_1005: - """A dictionary holding the information in a Win32 USER_INFO_1005 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def priv(self) -> Any: - ... - - -class PyUSER_INFO_1006: - """A dictionary holding the information in a Win32 USER_INFO_1006 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def home_dir(self) -> str: - ... - - -class PyUSER_INFO_1007: - """A dictionary holding the information in a Win32 USER_INFO_1007 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def comment(self) -> str: - ... - - -class PyUSER_INFO_1008: - """A dictionary holding the information in a Win32 USER_INFO_1008 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def flags(self) -> Any: - ... - - -class PyUSER_INFO_1009: - """A dictionary holding the information in a Win32 USER_INFO_1009 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def script_path(self) -> str: - ... - - -class PyUSER_INFO_1010: - """A dictionary holding the information in a Win32 USER_INFO_1010 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def auth_flags(self) -> Any: - ... - - -class PyUSER_INFO_1011: - """A dictionary holding the information in a Win32 USER_INFO_1011 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def full_name(self) -> str: - ... - - -class PyUSER_INFO_11: - """A dictionary holding the information in a Win32 USER_INFO_11 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def name(self) -> str: - ... - - @property - def comment(self) -> str: - ... - - @property - def usr_comment(self) -> str: - ... - - @property - def full_name(self) -> str: - ... - - @property - def priv(self) -> Any: - ... - - @property - def auth_flags(self) -> Any: - ... - - @property - def password_age(self) -> Any: - ... - - @property - def home_dir(self) -> str: - ... - - @property - def parms(self) -> str: - ... - - @property - def last_logon(self) -> Any: - ... - - @property - def last_logoff(self) -> Any: - ... - - @property - def bad_pw_count(self) -> Any: - ... - - @property - def num_logons(self) -> Any: - ... - - @property - def logon_server(self) -> str: - ... - - @property - def country_code(self) -> Any: - ... - - @property - def workstations(self) -> str: - ... - - @property - def max_storage(self) -> Any: - ... - - @property - def units_per_week(self) -> Any: - ... - - @property - def logon_hours(self) -> str: - ... - - @property - def code_page(self) -> Any: - ... - - -class PyUSER_INFO_2: - """A dictionary holding the information in a Win32 USER_INFO_2 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def name(self) -> str: - ... - - @property - def password(self) -> str: - ... - - @property - def password_age(self) -> Any: - ... - - @property - def priv(self) -> Any: - ... - - @property - def home_dir(self) -> str: - ... - - @property - def comment(self) -> str: - ... - - @property - def flags(self) -> Any: - ... - - @property - def script_path(self) -> str: - ... - - @property - def auth_flags(self) -> Any: - ... - - @property - def full_name(self) -> str: - ... - - @property - def usr_comment(self) -> str: - ... - - @property - def parms(self) -> str: - ... - - @property - def workstations(self) -> str: - ... - - @property - def last_logon(self) -> Any: - ... - - @property - def last_logoff(self) -> Any: - ... - - @property - def acct_expires(self) -> Any: - ... - - @property - def max_storage(self) -> Any: - ... - - @property - def units_per_week(self) -> Any: - ... - - @property - def logon_hours(self) -> str: - ... - - @property - def bad_pw_count(self) -> Any: - ... - - @property - def num_logons(self) -> Any: - ... - - @property - def logon_server(self) -> str: - ... - - @property - def country_code(self) -> Any: - ... - - @property - def code_page(self) -> Any: - ... - - -class PyUSER_INFO_20: - """A dictionary holding the information in a Win32 USER_INFO_20 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def name(self) -> str: - ... - - @property - def full_name(self) -> str: - ... - - @property - def comment(self) -> str: - ... - - @property - def flags(self) -> Any: - ... - - @property - def user_id(self) -> Any: - ... - - -class PyUSER_INFO_3: - """A dictionary holding the information in a Win32 USER_INFO_3 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def name(self) -> str: - ... - - @property - def password(self) -> str: - ... - - @property - def password_age(self) -> Any: - ... - - @property - def priv(self) -> Any: - ... - - @property - def home_dir(self) -> str: - ... - - @property - def comment(self) -> str: - ... - - @property - def flags(self) -> Any: - ... - - @property - def script_path(self) -> str: - ... - - @property - def auth_flags(self) -> Any: - ... - - @property - def full_name(self) -> str: - ... - - @property - def usr_comment(self) -> str: - ... - - @property - def parms(self) -> str: - ... - - @property - def workstations(self) -> str: - ... - - @property - def last_logon(self) -> Any: - ... - - @property - def last_logoff(self) -> Any: - ... - - @property - def acct_expires(self) -> Any: - ... - - @property - def max_storage(self) -> Any: - ... - - @property - def units_per_week(self) -> Any: - ... - - @property - def logon_hours(self) -> str: - ... - - @property - def bad_pw_count(self) -> Any: - ... - - @property - def num_logons(self) -> Any: - ... - - @property - def logon_server(self) -> str: - ... - - @property - def country_code(self) -> Any: - ... - - @property - def code_page(self) -> Any: - ... - - @property - def user_id(self) -> Any: - ... - - @property - def primary_group_id(self) -> Any: - ... - - @property - def profile(self) -> str: - ... - - @property - def home_dir_drive(self) -> str: - ... - - @property - def password_expired(self) -> Any: - ... - - -class PyUSER_INFO_4: - """A dictionary holding the information in a Win32 USER_INFO_4 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def name(self) -> str: - ... - - @property - def password(self) -> str: - ... - - @property - def password_age(self) -> Any: - ... - - @property - def priv(self) -> Any: - ... - - @property - def home_dir(self) -> str: - ... - - @property - def comment(self) -> str: - ... - - @property - def flags(self) -> Any: - ... - - @property - def script_path(self) -> str: - ... - - @property - def auth_flags(self) -> Any: - ... - - @property - def full_name(self) -> str: - ... - - @property - def usr_comment(self) -> str: - ... - - @property - def parms(self) -> str: - ... - - @property - def workstations(self) -> str: - ... - - @property - def last_logon(self) -> Any: - ... - - @property - def last_logoff(self) -> Any: - ... - - @property - def acct_expires(self) -> Any: - ... - - @property - def max_storage(self) -> Any: - ... - - @property - def units_per_week(self) -> Any: - ... - - @property - def logon_hours(self) -> str: - ... - - @property - def bad_pw_count(self) -> Any: - ... - - @property - def num_logons(self) -> Any: - ... - - @property - def logon_server(self) -> str: - ... - - @property - def country_code(self) -> Any: - ... - - @property - def code_page(self) -> Any: - ... - - @property - def user_sid(self) -> PySID: - ... - - @property - def primary_group_id(self) -> Any: - ... - - @property - def profile(self) -> str: - ... - - @property - def home_dir_drive(self) -> str: - ... - - @property - def password_expired(self) -> Any: - ... - - -class PyUSER_MODALS_INFO_0: - """A dictionary holding the information in a Win32 USER_MODALS_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def min_passwd_len(self) -> Any: - ... - - @property - def max_passwd_age(self) -> Any: - ... - - @property - def min_passwd_age(self) -> Any: - ... - - @property - def force_logoff(self) -> Any: - ... - - @property - def password_hist_len(self) -> Any: - ... - - -class PyUSER_MODALS_INFO_1: - """A dictionary holding the information in a Win32 USER_MODALS_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def role(self) -> Any: - ... - - @property - def primary(self) -> str: - ... - - -class PyUSER_MODALS_INFO_2: - """A dictionary holding the information in a Win32 USER_MODALS_INFO_2 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def domain_name(self) -> str: - ... - - @property - def domain_id(self) -> PySID: - ... - - -class PyUSER_MODALS_INFO_3: - """A dictionary holding the information in a Win32 USER_MODALS_INFO_3 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def lockout_duration(self) -> Any: - ... - - @property - def lockout_observation_window(self) -> Any: - ... - - @property - def usrmod3_lockout_threshold(self) -> Any: - ... - - -class PyUSE_INFO_0: - """A dictionary holding the infomation in a Win32 USE_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def local(self) -> str: - ... - - @property - def remote(self) -> str: - ... - - -class PyUSE_INFO_1: - """A dictionary holding the infomation in a Win32 USE_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def local(self) -> str: - ... - - @property - def remote(self) -> str: - ... - - @property - def password(self) -> Union[Any, str]: - ... - - @property - def status(self) -> Any: - ... - - @property - def asg_type(self) -> Any: - ... - - @property - def refcount(self) -> Any: - ... - - @property - def usecount(self) -> Any: - ... - - -class PyUSE_INFO_2: - """A dictionary holding the infomation in a Win32 USE_INFO_2 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def local(self) -> str: - ... - - @property - def remote(self) -> str: - ... - - @property - def password(self) -> Union[Any, str]: - ... - - @property - def status(self) -> Any: - ... - - @property - def asg_type(self) -> Any: - ... - - @property - def refcount(self) -> Any: - ... - - @property - def usecount(self) -> Any: - ... - - @property - def username(self) -> str: - ... - - @property - def domainname(self) -> str: - ... - - -class PyUSE_INFO_3: - """A dictionary holding the infomation in a Win32 USE_INFO_3 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def local(self) -> str: - ... - - @property - def remote(self) -> str: - ... - - @property - def password(self) -> Union[Any, str]: - ... - - @property - def status(self) -> Any: - ... - - @property - def asg_type(self) -> Any: - ... - - @property - def refcount(self) -> Any: - ... - - @property - def usecount(self) -> Any: - ... - - @property - def username(self) -> str: - ... - - @property - def domainname(self) -> str: - ... - - @property - def flags(self) -> Any: - ... - - -class PyUnicode: - """A Python object, representing a Unicode string.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyUrlCacheHANDLE: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyWAVEFORMATEX: - """A Python object, representing a WAVEFORMATEX structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def wFormatTag(self) -> int: - """Waveform-audio format type. pywintypes only defines WAVE_FORMAT_PCM as a constant. Other values must be looked up in the mmsystem.h header file.""" - ... - - @property - def nChannels(self) -> int: - """Number of channels. 1 for Mono, 2 for Stereo, anything, but never 5.1.""" - ... - - @property - def nSamplesPerSec(self) -> int: - """Sample rate, in samples per second (hertz), that each channel should be played or recorded. If wFormatTag is WAVE_FORMAT_PCM, then common values for nSamplesPerSec are 8000, 11025, 22050, and 44100 Hz""" - ... - - @property - def nAvgBytesPerSec(self) -> int: - """Required average data-transfer rate, in bytes per second, for the format tag. If wFormatTag is WAVE_FORMAT_PCM, nAvgBytesPerSec should be equal to the product of nSamplesPerSec and nBlockAlign.""" - ... - - @property - def nBlockAlign(self) -> int: - """Block alignment, in bytes. The block alignment is the minimum atomic unit of data for the wFormatTag format type. If wFormatTag is WAVE_FORMAT_PCM, nBlockAlign should be equal to the product of nChannels and wBitsPerSample divided by 8 (bits per byte). For non-PCM formats, this member must be computed according to the manufacturer’s specification of the format tag.""" - ... - - @property - def wBitsPerSample(self) -> int: - """Bits per sample for the wFormatTag format type. If wFormatTag is WAVE_FORMAT_PCM, then wBitsPerSample should be equal to 8 or 16. Sentinel""" - ... - - -class PyWINHTTP_AUTOPROXY_OPTIONS: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyWINHTTP_PROXY_INFO: - """A tuple representing a WINHTTP_PROXY_INFO structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyWKSTA_INFO_100: - """A dictionary holding the infomation in a Win32 WKSTA_INFO_100 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def platform_id(self) -> Any: - """Indicates platform level to use to retrieve platform specific information""" - ... - - @property - def computername(self) -> str: - """Name of the local computer""" - ... - - @property - def langroup(self) -> str: - """Name of the domain to which computer belongs""" - ... - - @property - def ver_major(self) -> Any: - """Major version number of operating system running on the computer""" - ... - - @property - def ver_minor(self) -> Any: - """Minor version number of operating system running on the computer""" - ... - - -class PyWKSTA_INFO_101: - """A dictionary holding the infomation in a Win32 WKSTA_INFO_101 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def platform_id(self) -> Any: - """Indicates platform level to use to retrieve platform specific information""" - ... - - @property - def computername(self) -> str: - """Name of the local computer""" - ... - - @property - def langroup(self) -> str: - """Name of the domain to which computer belongs""" - ... - - @property - def ver_major(self) -> Any: - """Major version number of operating system running on the computer""" - ... - - @property - def ver_minor(self) -> Any: - """Minor version number of operating system running on the computer""" - ... - - @property - def lanroot(self) -> str: - """Path to the LANMAN directory""" - ... - - -class PyWKSTA_INFO_102: - """A dictionary holding the infomation in a Win32 WKSTA_INFO_102 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def platform_id(self) -> Any: - """Indicate platform level to use to retrieve platform specific information""" - ... - - @property - def computername(self) -> str: - """Name of the local computer""" - ... - - @property - def langroup(self) -> str: - """Name of the domain to which computer belongs""" - ... - - @property - def ver_major(self) -> Any: - """Major version number of operating system running on the computer""" - ... - - @property - def ver_minor(self) -> Any: - """Minor version number of operating system running on the computer""" - ... - - @property - def lanroot(self) -> str: - """Path to the LANMAN directory""" - ... - - @property - def logged_on_users(self) -> Any: - """Number of users who are logged on to the local computer""" - ... - - -class PyWKSTA_INFO_302: - """A dictionary holding the infomation in a Win32 WKSTA_INFO_302 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def char_wait(self) -> Any: - """number of seconds the computer will wait for a remote resource to become available""" - ... - - @property - def collection_time(self) -> Any: - """number of milliseconds the computer will collect data before sending the data to a character device resource. The workstation waits the specified time or collects the number of characters specified by wki302_maximum_collection_count, whichever comes first.""" - ... - - @property - def maximum_collection_count(self) -> Any: - """Specifies the number of bytes of information the computer will collect before sending the data to a character device resource. The workstation collects the specified number of bytes or waits the time specified by wki302_collection_time, whichever comes first.""" - ... - - @property - def keep_conn(self) -> Any: - """Specifies the number of seconds the server will maintain an inactive connection to a resource.""" - ... - - @property - def keep_search(self) -> Any: - """Defines the number of seconds an inactive search will continue.""" - ... - - @property - def max_cmds(self) -> Any: - """Specifies the number of simultaneous network device driver commands that can be sent to the network.""" - ... - - @property - def num_work_buf(self) -> Any: - """Specifies the number of internal buffers the computer has.""" - ... - - @property - def siz_work_buf(self) -> Any: - """Specifies the size, in bytes, of each internal buffer.""" - ... - - @property - def max_wrk_cache(self) -> Any: - """Specifies the maximum size, in bytes, of an internal cache buffer.""" - ... - - @property - def siz_error(self) -> Any: - """Specifies the size, in bytes, of an internal error buffer.""" - ... - - @property - def num_alerts(self) -> Any: - """Specifies the maximum number of clients that can receive alert messages. (This member is not supported under MS-DOS.) The Alerter service registers at least three clients when it begins to run.""" - ... - - @property - def num_services(self) -> Any: - """Specifies the number of services that can be installed on the computer at any time.""" - ... - - @property - def errlog_sz(self) -> Any: - """Specifies the maximum size, in kilobytes, of the client's error log file.""" - ... - - @property - def print_buf_time(self) -> Any: - """Specifies the number of seconds the server waits before closing inactive compatibility-mode print jobs.""" - ... - - @property - def num_char_buf(self) -> Any: - """Specifies the number of character pipe buffers and device buffers the client can have.""" - ... - - @property - def siz_char_buf(self) -> Any: - """Specifies the maximum size, in bytes, of a character pipe buffer and device buffer.""" - ... - - @property - def wrk_heuristics(self) -> str: - """Pointer to a Unicode string of flags used to control a client's operation.""" - ... - - @property - def mailslots(self) -> Any: - """Specifies the maximum number of mailslots allowed.""" - ... - - @property - def num_dgram_buf(self) -> Any: - """Specifies the number of buffers to allocate for receiving datagrams.""" - ... - - -class PyWKSTA_INFO_402: - """A dictionary holding the infomation in a Win32 WKSTA_INFO_402 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def char_wait(self) -> Any: - """number of seconds the computer will wait for a remote resource to become available""" - ... - - @property - def collection_time(self) -> Any: - """number of milliseconds the computer will collect data before sending the data to a character device resource. The workstation waits the specified time or collects the number of characters specified by wki402_maximum_collection_count, whichever comes first.""" - ... - - @property - def maximum_collection_count(self) -> str: - """Name of the domain to which computer belongs""" - ... - - @property - def keep_conn(self) -> Any: - """Major version number of operating system running on the computer""" - ... - - @property - def keep_search(self) -> Any: - """Minor version number of operating system running on the computer""" - ... - - @property - def max_cmds(self) -> Any: - """..""" - ... - - @property - def num_work_buf(self) -> Any: - """Number of users who are logged on to the local computer""" - ... - - @property - def siz_work_buf(self) -> Any: - """Number of users who are logged on to the local computer""" - ... - - @property - def max_wrk_cache(self) -> Any: - """..""" - ... - - @property - def sess_timeout(self) -> Any: - """..""" - ... - - @property - def siz_error(self) -> Any: - """..""" - ... - - @property - def num_alerts(self) -> Any: - """..""" - ... - - @property - def num_services(self) -> Any: - """..""" - ... - - @property - def errlog_sz(self) -> Any: - """..""" - ... - - @property - def print_buf_time(self) -> Any: - """..""" - ... - - @property - def num_char_buf(self) -> Any: - """..""" - ... - - @property - def siz_char_buf(self) -> Any: - """Specifies the maximum size, in bytes, of a character pipe buffer and device buffer.""" - ... - - @property - def mailslots(self) -> Any: - """..""" - ... - - @property - def num_dgram_buf(self) -> Any: - """..""" - ... - - @property - def max_threads(self) -> Any: - """Number of threads the computer can dedicate to the network""" - ... - - -class PyWKSTA_INFO_502: - """A dictionary holding the infomation in a Win32 WKSTA_INFO_502 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def char_wait(self) -> Any: - """number of seconds the computer will wait for a remote resource to become available""" - ... - - @property - def collection_time(self) -> Any: - """number of milliseconds the computer will collect data before sending the data to a character device resource. The workstation waits the specified time or collects the number of characters specified by wki502_maximum_collection_count, whichever comes first.""" - ... - - @property - def maximum_collection_count(self) -> Any: - """Specifies the number of bytes of information the computer will collect before sending the data to a character device resource. The workstation collects the specified number of bytes or waits the time specified by wki302_collection_time, whichever comes first.""" - ... - - @property - def keep_conn(self) -> Any: - """Specifies the number of seconds the server will maintain an inactive connection to a resource.""" - ... - - @property - def max_cmds(self) -> Any: - """Specifies the number of simultaneous network device driver commands that can be sent to the network.""" - ... - - @property - def max_wrk_cache(self) -> Any: - """Indicates the number of seconds the server waits before disconnecting an inactive session.""" - ... - - @property - def siz_char_buf(self) -> Any: - """Specifies the maximum size, in bytes, of a character pipe buffer and device buffer.""" - ... - - @property - def lock_quota(self) -> Any: - """TODO""" - ... - - @property - def lock_increment(self) -> Any: - """TODO""" - ... - - @property - def lock_maximum(self) -> Any: - """TODO""" - ... - - @property - def pipe_increment(self) -> Any: - """TODO""" - ... - - @property - def pipe_maximum(self) -> Any: - """TODO""" - ... - - @property - def cache_file_timeout(self) -> Any: - """TODO""" - ... - - @property - def dormant_file_limit(self) -> Any: - """TODO""" - ... - - @property - def read_ahead_throughput(self) -> Any: - """TODO""" - ... - - @property - def num_mailslot_buffers(self) -> Any: - """TODO""" - ... - - @property - def num_srv_announce_buffers(self) -> Any: - """TODO""" - ... - - @property - def max_illegal_datagram_events(self) -> Any: - """TODO""" - ... - - @property - def illegal_datagram_event_reset_frequency(self) -> Any: - """TODO""" - ... - - @property - def log_election_packets(self) -> Any: - """TODO""" - ... - - @property - def use_opportunistic_locking(self) -> Any: - """TODO""" - ... - - @property - def use_unlock_behind(self) -> Any: - """TODO""" - ... - - @property - def use_close_behind(self) -> Any: - """TODO""" - ... - - @property - def buf_named_pipes(self) -> Any: - """TODO""" - ... - - @property - def use_lock_read_unlock(self) -> Any: - """TODO""" - ... - - @property - def utilize_nt_caching(self) -> Any: - """TODO""" - ... - - @property - def use_raw_read(self) -> Any: - """TODO""" - ... - - @property - def use_raw_write(self) -> Any: - """TODO""" - ... - - @property - def use_write_raw_data(self) -> Any: - """TODO""" - ... - - @property - def use_encryption(self) -> Any: - """TODO""" - ... - - @property - def buf_files_deny_write(self) -> Any: - """TODO""" - ... - - @property - def buf_read_only_files(self) -> Any: - """TODO""" - ... - - @property - def force_core_create_mode(self) -> Any: - """TODO""" - ... - - @property - def use_512_byte_max_transfer(self) -> Any: - """TODO""" - ... - - -class PyWKSTA_TRANSPORT_INFO_0: - """A dictionary holding the infomation in a Win32 WKSTA_TRANSPORT_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def quality_of_service(self) -> Any: - """Supplies a value that specifies the search order of the transport protocol with respect to other transport protocols. The highest value is searched first.""" - ... - - @property - def number_of_vcs(self) -> Any: - """Specifies the number of clients communicating with the server using this transport protocol.""" - ... - - @property - def transport_name(self) -> str: - """Specifies the device name of the transport protocol.""" - ... - - @property - def transport_address(self) -> str: - """Specifies the address of the server on this transport protocol.""" - ... - - @property - def wan_ish(self) -> Any: - """This member is ignored by the NetWkstaTransportAdd function. For the NetWkstaTransportEnum function, this member indicates that this transport protocol is a WAN transport protocol. This member is set TRUE for NetBIOS/TCIP; it is set FALSE for NetBEUI and NetBIOS/IPX.""" - ... - - -class PyWKSTA_USER_INFO_0: - """A dictionary holding the infomation in a Win32 WKSTA_USER_INFO_0 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def username(self) -> str: - """Name of user currently logged on to the workstation""" - ... - - -class PyWKSTA_USER_INFO_1: - """A dictionary holding the infomation in a Win32 WKSTA_USER_INFO_1 structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def username(self) -> str: - """Name of user currently logged on to the workstation""" - ... - - @property - def logon_domain(self) -> str: - """Returns the domain name of the user account of the user currently logged on to the workstation.""" - ... - - @property - def oth_domains(self) -> str: - """Returns the list of other operating system domains browsed by the workstation. The domain names are separated by blanks.""" - ... - - @property - def logon_server(self) -> str: - """Returns the name of the computer that authenticated the server.""" - ... - - -class PyWNDCLASS: - """A Python object, representing an WNDCLASS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def style(self) -> int: - ... - - @property - def cbWndExtra(self) -> int: - ... - - @property - def hInstance(self) -> int: - ... - - @property - def hIcon(self) -> int: - ... - - @property - def hCursor(self) -> int: - ... - - @property - def hbrBackground(self) -> int: - """These 3 handled manually in PyWNDCLASS::getattro/setattro. The pymeth below is used as an end tag, so these props will be lost if below it""" - ... - - @property - def lpszMenuName(self) -> str: - ... - - @property - def lpszClassName(self) -> str: - ... - - @property - def lpfnWndProc(self) -> Any: - """MethodsSetDialogProcSets the WNDCLASS to be for a dialog box. """ - ... - - def SetDialogProc(self) -> None: - """ - Sets the WNDCLASS to be for a dialog box - -Args: - - - -Returns: - - None - - """ - ... - - -class PyXFORM: - """Dict representing an XFORM struct used as a world transformation matrix - -All members are optional, defaulting to 0.0.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def M11(self) -> float: - """Usage is dependent on operation performed, see MSDN docs""" - ... - - @property - def M12(self) -> float: - """Usage is dependent on operation performed, see MSDN docs""" - ... - - @property - def M21(self) -> float: - """Usage is dependent on operation performed, see MSDN docs""" - ... - - @property - def M22(self) -> float: - """Usage is dependent on operation performed, see MSDN docs""" - ... - - @property - def Dx(self) -> float: - """Horizontal offset in logical units""" - ... - - @property - def Dy(self) -> float: - """Vertical offset in logical units""" - ... - - -class Pymmapfile: - """Object that provides access to memory-mapped file operations.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def close(self) -> None: - """ - Closes the file mapping handle and releases mapped view - -Args: - - - -Returns: - - None - - """ - ... - - def find(self, needle: Any, start: Any) -> Any: - """ - Finds a string in the buffer. - -Args: - - needle(Any):String to be located - start(Any):Pos at which to start search, current pos assumed if not specifiedReturn ValueReturns pos of string, or -1 if not found - -Returns: - - Any:Pos at which to start search, current pos assumed if not specifiedReturn ValueReturns pos of string, or -1 if not found - - - """ - ... - - def flush(self, offset: Any = 0, size: Any = 0) -> None: - """ - Flushes memory buffer to disk - -Args: - - offset(Any):Position in buffer at which to flush - size(Any):Number of bytes to flush, 0 to flush remainder of buffer past the offset - -Returns: - - None - - """ - ... - - def move(self, dest: Any, src: Any, count: Any) -> None: - """ - Moves data from one place in buffer to another - -Args: - - dest(Any):Destination position in buffer - src(Any):Source position in buffer - count(Any):Number of bytes to move - -Returns: - - None - - """ - ... - - def read(self, num_bytes: Any) -> Any: - """ - Returns specified number of bytes from buffer, and advances current position - -Args: - - num_bytes(Any):Number of bytes to read - -Returns: - - Any - - """ - ... - - def read_byte(self) -> Any: - """ - Reads a single character from current pos - -Args: - - - -Returns: - - Any - - """ - ... - - def read_line(self) -> Any: - """ - Reads data from current pos up to next EOL. - -Args: - - - -Returns: - - Any - - """ - ... - - def resize(self, MaximumSize: Any, FileOffset: Any = 0, NumberOfBytesToMap: Any = 0) -> None: - """ - Resizes the file mapping and view. - -Args: - - MaximumSize(Any):New size for file mapping. Use a multiple of system page size (see win32api::GetSystemInfo) - FileOffset(Any):Offset into file mapping. Must be multiple of allocation granularity. - NumberOfBytesToMap(Any):New view size. Specify a multiple of system page size.CommentsIf MaximumSize is 0, only the mapped view will be affected.Accepts keyword args. - -Returns: - - None - - """ - ... - - def seek(self, dist: Any, how: Any = 0) -> None: - """ - Changes current position - -Args: - - dist(Any):Distance to seek - how(Any):Pos from which to seekhowmeaning0Seek from start of buffer1Seek from current position2Seek backwards from end of buffer - -Returns: - - None - - """ - ... - - def size(self) -> Any: - """ - Returns size of current view - -Args: - - - -Returns: - - Any - - """ - ... - - def tell(self) -> Any: - """ - Returns current position in buffer - -Args: - - - -Returns: - - Any - - """ - ... - - def write(self, data: Any) -> None: - """ - Places data at current pos in buffer. - -Args: - - data(Any):Data to be written - -Returns: - - None - - """ - ... - - def write_byte(self, char: Any) -> None: - """ - Writes a single character of data - -Args: - - char(Any):Single byte to be placed in buffer - -Returns: - - None - - """ - ... - - -class RASDIALEXTENSIONS: - """An object that describes a Win32 RASDIALEXTENSIONS structure - -TRUE*/)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def dwfOptions(self) -> int: - """(fOptions may also be used)""" - ... - - @property - def hwndParent(self) -> int: - ... - - @property - def reserved(self) -> int: - ... - - @property - def reserved1(self) -> int: - ... - - @property - def RasEapInfo(self) -> Any: - ... - - -class RASDIALPARAMS: - """A tuple that describes a Win32 RASDIALPARAMS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SC_ACTION: - """tuple of 2 ints (Type,Delay) used to represent an SC_ACTION structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def Type(self) -> Any: - """One of SC_ACTION_NONE, SC_ACTION_REBOOT, SC_ACTION_RESTART, SC_ACTION_RUN_COMMAND""" - ... - - @property - def Delay(self) -> Any: - """Time delay before specified action is taken (in milliseconds)""" - ... - - -class SERVICE_FAILURE_ACTIONS: - """A dictionary representing a SERVICE_FAILURE_ACTIONS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def ResetPeriod(self) -> Any: - """Indicates how many seconds to wait to reset the failure count, can be INFINITE""" - ... - - @property - def RebootMsg(self) -> Union[Any, str]: - """Message displayed when reboot action is taken""" - ... - - @property - def Command(self) -> Union[Any, str]: - """Command line to execute for SC_ACTION_RUN_COMMAND""" - ... - - @property - def Actions(self) -> Any: - """A tuple of SC_ACTION tuples""" - ... - - -class SERVICE_STATUS: - """A Win32 service status object is represented by a tuple:""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class TRACKMOUSEEVENT: - """A tuple of (dwFlags, hwndTrack, dwHoverTime)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class ULARGE_INTEGER: - """A Python object used wherever a COM ULARGE_INTEGER is used.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class WIN32_FIND_DATA: - """A tuple representing a WIN32_FIND_DATA structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class com_error: - """An exception raised when a COM exception occurs.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class connection: - """An object representing an ODBC connection""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def setautocommit(self, c: Any) -> None: - """ - Sets the autocommit mode. - -Args: - - c(Any):The boolean autocommit mode. - -Returns: - - None - - """ - ... - - def commit(self) -> None: - """ - Commits a transaction. - -Args: - - - -Returns: - - None - - """ - ... - - def rollback(self) -> None: - """ - Rollsback a transaction. - -Args: - - - -Returns: - - None - - """ - ... - - def cursor(self) -> None: - """ - None - -Args: - - - -Returns: - - None - - """ - ... - - def close(self) -> None: - """ - Closes the connection. - -Args: - - - -Returns: - - None - - """ - ... - - -class cursor: - """An object representing an ODBC cursor.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def close(self) -> None: - """ - Closes the cursor - -Args: - - - -Returns: - - None - - """ - ... - - def execute(self, sql: str, arg: Any) -> Any: - """ - Execute some SQL - -Args: - - sql(str):The SQL to execute - arg(Any):Input variables. - -Returns: - - Any - - """ - ... - - def fetchone(self) -> Any: - """ - Fetch one row of data - -Args: - - - -Returns: - - Any - - """ - ... - - def fetchmany(self) -> list[Any]: - """ - Fetch many rows of data - -Args: - - - -Returns: - - list[Any] - - """ - ... - - def fetchall(self) -> list[Any]: - """ - Fetch all rows of data - -Args: - - - -Returns: - - list[Any] - - """ - ... - - def setinputsizes(self) -> None: - """ - None - -Args: - - - -Returns: - - None - - """ - ... - - def setoutputsize(self) -> None: - """ - None - -Args: - - - -Returns: - - None - - """ - ... - - -class error: - """An exception raised when a win32 error occurs""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class COMPONENT: - """A dictionary containing data to fill a COMPPOS struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def ID(self) -> Any: - """Id of component, ignored when adding a new component""" - ... - - @property - def ComponentType(self) -> Any: - """One of shellcon.COMP_TYPE_* values""" - ... - - @property - def Checked(self) -> Any: - """True indicates item is currently displayed""" - ... - - @property - def fDirty(self) -> Any: - """Indicates if unsaved changes exist""" - ... - - @property - def NoScroll(self) -> Any: - """True disables scrolling""" - ... - - @property - def Pos(self) -> Any: - """COMPPOS dictionary determining window size and placement""" - ... - - @property - def FriendlyName(self) -> Any: - """String of at most MAX_PATH-1 characters, truncated if longer""" - ... - - @property - def Source(self) -> Any: - """String of at most INTERNET_MAX_URL_LENGTH-1 characters""" - ... - - @property - def SubscribedURL(self) -> Any: - """String of at most INTERNET_MAX_URL_LENGTH-1 characters""" - ... - - @property - def CurItemState(self) -> Any: - """One of shellcon.IS_* flags""" - ... - - @property - def Original(self) -> Any: - """COMPSTATEINFO dictionary""" - ... - - @property - def Restored(self) -> Any: - """COMPSTATEINFO dictionary""" - ... - - @property - def Size(self) -> Any: - """Size of structure, ignored on input""" - ... - - -class COMPONENTSOPT: - """A dictionary containing data to fill a COMPONENTSOPT struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def EnableComponents(self) -> Any: - """True if components are enabled""" - ... - - @property - def ActiveDesktop(self) -> Any: - """True if Active Desktop is enabled""" - ... - - @property - def Size(self) -> Any: - """Size of structure, ignored on input""" - ... - - -class COMPPOS: - """A dictionary containing data to fill a COMPPOS struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def Left(self) -> Any: - ... - - @property - def Top(self) -> Any: - ... - - @property - def Width(self) -> Any: - ... - - @property - def Height(self) -> Any: - ... - - @property - def Index(self) -> Any: - ... - - @property - def CanResize(self) -> Any: - ... - - @property - def CanResizeX(self) -> Any: - ... - - @property - def CanResizeY(self) -> Any: - ... - - @property - def PreferredLeftPercent(self) -> Any: - ... - - @property - def PreferredTopPercent(self) -> Any: - ... - - @property - def Size(self) -> Any: - """Size of structure, ignored on input""" - ... - - -class COMPSTATEINFO: - """A dictionary containing data to fill a COMPSTATEINFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def Left(self) -> Any: - """Specified as screen coordinates""" - ... - - @property - def Top(self) -> Any: - """Specified as screen coordinates""" - ... - - @property - def Width(self) -> Any: - """Measured in pixels""" - ... - - @property - def Height(self) -> Any: - """Measured in pixels""" - ... - - @property - def dwItemState(self) -> Any: - """One of IS_NORMAL, IS_FULLSCREEN IS_SPLIT""" - ... - - @property - def Size(self) -> Any: - """Size of structure, ignored on input""" - ... - - -class DEFCONTENTMENU: - """A tuple representing a DEFCONTEXTMENU structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class ELEMDESC: - """An ELEMDESC is respresented as a tuple of""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class EXP_DARWIN_LINK: - """Dictionary containing information for a EXP_DARWIN_LINK struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def Signature(self) -> Any: - """The type of data block, one of shellcon.*_SIG values""" - ... - - @property - def DarwinID(self) -> Any: - """The Windows Installer id for the link""" - ... - - @property - def wDarwinID(self) -> Any: - """The installer id as Unicode""" - ... - - @property - def Size(self) -> Any: - """Size of structure, ignored on input""" - ... - - -class EXP_SPECIAL_FOLDER: - """Dictionary containing information for a EXP_SPECIAL_FOLDER struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def Signature(self) -> Any: - """The type of data block, one of shellcon.*_SIG values""" - ... - - @property - def idSpecialFolder(self) -> Any: - """The special folder id of the target (shellcon.CSIDL_*)""" - ... - - @property - def Offset(self) -> Any: - """Offset into the link's PIDL""" - ... - - @property - def Size(self) -> Any: - """Size of structure, ignored on input""" - ... - - -class EXP_SZ_LINK: - """Dictionary containing information for an EXP_SZ_LINK or EXP_SZ_ICON struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def Signature(self) -> Any: - """The type of data block, one of shellcon.*_SIG values""" - ... - - @property - def Target(self) -> Any: - """The link's target or icon location""" - ... - - @property - def wTarget(self) -> Any: - """The target in Unicode form""" - ... - - @property - def Size(self) -> Any: - """Size of structure, ignored on input""" - ... - - -class FUNCDESC: - """A FUNCDESC object represents a COM TYPEATTR structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def memid(self) -> int: - ... - - @property - def scodeArray(self) -> tuple[Any, ...]: - ... - - @property - def args(self) -> tuple[Any, ...]: - ... - - @property - def funckind(self) -> Any: - ... - - @property - def invkind(self) -> Any: - ... - - @property - def callconv(self) -> Any: - ... - - @property - def cParamsOpt(self) -> Any: - ... - - @property - def oVft(self) -> Any: - ... - - @property - def rettype(self) -> Any: - ... - - @property - def wFuncFlags(self) -> Any: - ... - - -class IDLDESC: - """An IDLDESC is respresented as""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class MAPIINIT_0: - """A MAPIINIT_0 is represented as a tuple of:""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class NT_CONSOLE_PROPS: - """Dictionary containing information for a NT_CONSOLE_PROPS struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def Signature(self) -> Any: - """The type of data block, one of shellcon.*_SIG values""" - ... - - @property - def FillAttribute(self) -> Any: - """Character attributes for fill operations""" - ... - - @property - def PopupFillAttribute(self) -> Any: - """Fill attributes for popups""" - ... - - @property - def ScreenBufferSize(self) -> tuple[Any, Any]: - """Size of console screen buffer, in character cells""" - ... - - @property - def WindowSize(self) -> tuple[Any, Any]: - """Size of console window in character cells""" - ... - - @property - def WindowOrigin(self) -> tuple[Any, Any]: - """Window position, in screen coordinates""" - ... - - @property - def nFont(self) -> Any: - """Number of font to be displayed. See win32console::GetNumberOfConsoleFonts""" - ... - - @property - def InputBufferSize(self) -> Any: - """Size of console's input buffer""" - ... - - @property - def FontSize(self) -> tuple[Any, Any]: - """Size of font""" - ... - - @property - def FontFamily(self) -> Any: - """Font family""" - ... - - @property - def FontWeight(self) -> Any: - """Controls thickness of displayed font""" - ... - - @property - def FaceName(self) -> Any: - """Name of font face, 31 characters at most""" - ... - - @property - def CursorSize(self) -> Any: - """Relative size of cursor, expressed as percent of character size""" - ... - - @property - def FullScreen(self) -> Any: - """Causes console to run in full screen mode""" - ... - - @property - def QuickEdit(self) -> Any: - ... - - @property - def InsertMode(self) -> Any: - ... - - @property - def AutoPosition(self) -> Any: - """Lets system determine window placement""" - ... - - @property - def HistoryBufferSize(self) -> Any: - """Size of command line history buffer""" - ... - - @property - def NumberOfHistoryBuffers(self) -> Any: - ... - - @property - def HistoryNoDup(self) -> Any: - ... - - @property - def ColorTable(self) -> Any: - """tuple of 16 ints containing console's color attributes""" - ... - - @property - def Size(self) -> Any: - """Size of structure, ignored on input""" - ... - - -class NT_FE_CONSOLE_PROPS: - """Dictionary containing information for a NT_FE_CONSOLE_PROPS struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def Signature(self) -> Any: - """The type of data block, one of shellcon.*_SIG values""" - ... - - @property - def CodePage(self) -> Any: - """The codepage to be used for console text""" - ... - - @property - def Size(self) -> Any: - """Size of structure, ignored on input""" - ... - - -class PROPSPEC: - """Identifies a property. Can be either an int property id, or a str/unicode property name.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyADSVALUE: - """A tuple:""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyADS_ATTR_INFO: - """Represents a ADS_ATTR_INFO structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def AttrName(self) -> Any: - """The name""" - ... - - @property - def ControlCode(self) -> int: - ... - - @property - def ADsType(self) -> int: - ... - - @property - def Values(self) -> list[Any]: - ... - - -class PyADS_OBJECT_INFO: - """Represents a ADS_OBJECT_INFO structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def RDN(self) -> Any: - """The name""" - ... - - @property - def ObjectDN(self) -> Any: - ... - - @property - def ParentDN(self) -> Any: - ... - - @property - def ClassName(self) -> Any: - ... - - -class PyADS_SEARCHPREF_INFO: - """A tuple of:""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyBIND_OPTS: - """Dictionary representation of a BIND_OPTS struct - -May eventually be extended to include BIND_OPTS2 members""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def Flags(self) -> Any: - """Value from BIND_FLAGS enum: BIND_MAYBOTHERUSER, BIND_JUSTTESTEXISTENCE or 0""" - ... - - @property - def Mode(self) -> Any: - """Combination of storagecon.STGM_* values""" - ... - - @property - def TickCountDeadline(self) -> Any: - """Operation timeout in milliseconds""" - ... - - @property - def cbStruct(self) -> Any: - """Size of struct, ignored on input""" - ... - - -class PyCMINVOKECOMMANDINFO: - """A tuple of parameters to be converted to a CMINVOKECOMMANDINFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyDSBCAPS: - """A Python object, representing a DSBCAPS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def dwFlags(self) -> int: - """Flags that specify buffer-object capabilities.FlagDescriptionDSBCAPS_PRIMARYBUFFERIndicates that the buffer is a primary sound buffer. If this value is not specified, a secondary sound buffer will be created.DSBCAPS_STATICIndicates that the buffer will be used for static sound data. Typically, these buffers are loaded once and played many times. These buffers are candidates for hardware memory.DSBCAPS_LOCHARDWAREThe buffer is in hardware memory and uses hardware mixing.DSBCAPS_LOCSOFTWAREThe buffer is in software memory and uses software mixing.DSBCAPS_CTRL3DThe buffer is either a primary buffer or a secondary buffer that uses 3-D control. To create a primary buffer, the dwFlags member of the DSBUFFERDESC structure should include the DSBCAPS_PRIMARYBUFFER flag.DSBCAPS_CTRLFREQUENCYThe buffer must have frequency control capability.DSBCAPS_CTRLPANThe buffer must have pan control capability.DSBCAPS_CTRLVOLUMEThe buffer must have volume control capability.DSBCAPS_CTRLPOSITIONNOTIFYThe buffer must have control position notify capability.DSBCAPS_STICKYFOCUSChanges the focus behavior of the sound buffer. This flag can be specified in an IDirectSound::CreateSoundBuffer call. With this flag set, an application using DirectSound can continue to play its sticky focus buffers if the user switches to another application not using DirectSound. In this situation, the application's normal buffers are muted, but the sticky focus buffers are still audible. This is useful for nongame applications, such as movie playback (DirectShow™), when the user wants to hear the soundtrack while typing in Microsoft Word or Microsoft® Excel, for example. However, if the user switches to another DirectSound application, all sound buffers, both normal and sticky focus, in the previous application are muted.DSBCAPS_GLOBALFOCUSThe buffer is a global sound buffer. With this flag set, an application using DirectSound can continue to play its buffers if the user switches focus to another application, even if the new application uses DirectSound. The one exception is if you switch focus to a DirectSound application that uses the DSSCL_EXCLUSIVE or DSSCL_WRITEPRIMARY flag for its cooperative level. In this case, the global sounds from other applications will not be audible.DSBCAPS_GETCURRENTPOSITION2Indicates that IDirectSoundBuffer::GetCurrentPosition should use the new behavior of the play cursor. In DirectSound in DirectX 1, the play cursor was significantly ahead of the actual playing sound on emulated sound cards; it was directly behind the write cursor. Now, if the DSBCAPS_GETCURRENTPOSITION2 flag is specified, the application can get a more accurate play position. If this flag is not specified, the old behavior is preserved for compatibility. Note that this flag affects only emulated sound cards; if a DirectSound driver is present, the play cursor is accurate for DirectSound in all versions of DirectX.DSBCAPS_MUTE3DATMAXDISTANCEThe sound is reduced to silence at the maximum distance. The buffer will stop playing when the maximum distance is exceeded, so that processor time is not wasted.""" - ... - - @property - def nChannels(self) -> int: - """Size of the buffer, in bytes.""" - ... - - @property - def dwUnlockTransferRate(self) -> int: - """Specifies the rate, in kilobytes per second, at which data is transferred to the buffer memory when IDirectSoundBuffer::Unlock is called. High-performance applications can use this value to determine the time required for IDirectSoundBuffer::Unlock to execute. For software buffers located in system memory, the rate will be very high because no processing is required. For hardware buffers, the rate might be slower because the buffer might have to be downloaded to the sound card, which might have a limited transfer rate.""" - ... - - @property - def nAvgBytesPerSec(self) -> int: - """Specifies whether the returned handle is inherited when a new process is created. If this member is TRUE, the new process inherits the handle. Sentinel""" - ... - - -class PyDSBUFFERDESC: - """A Python object, representing a DSBUFFERDESC structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def dwFlags(self) -> int: - """Identifies the capabilities to include when creating a new DirectSoundBuffer object. Specify one or more of the following:FlagDescriptionDSBCAPS_PRIMARYBUFFERIndicates that the buffer is a primary sound buffer. If this value is not specified, a secondary sound buffer will be created.DSBCAPS_STATICIndicates that the buffer will be used for static sound data. Typically, these buffers are loaded once and played many times. These buffers are candidates for hardware memory.DSBCAPS_LOCHARDWAREThe buffer is in hardware memory and uses hardware mixing.DSBCAPS_LOCSOFTWAREThe buffer is in software memory and uses software mixing.DSBCAPS_CTRL3DThe buffer is either a primary buffer or a secondary buffer that uses 3-D control. To create a primary buffer, the dwFlags member of the DSBUFFERDESC structure should include the DSBCAPS_PRIMARYBUFFER flag.DSBCAPS_CTRLFREQUENCYThe buffer must have frequency control capability.DSBCAPS_CTRLPANThe buffer must have pan control capability.DSBCAPS_CTRLVOLUMEThe buffer must have volume control capability.DSBCAPS_CTRLPOSITIONNOTIFYThe buffer must have control position notify capability.DSBCAPS_STICKYFOCUSChanges the focus behavior of the sound buffer. This flag can be specified in an IDirectSound::CreateSoundBuffer call. With this flag set, an application using DirectSound can continue to play its sticky focus buffers if the user switches to another application not using DirectSound. In this situation, the application's normal buffers are muted, but the sticky focus buffers are still audible. This is useful for nongame applications, such as movie playback (DirectShow™), when the user wants to hear the soundtrack while typing in Microsoft Word or Microsoft® Excel, for example. However, if the user switches to another DirectSound application, all sound buffers, both normal and sticky focus, in the previous application are muted.DSBCAPS_GLOBALFOCUSThe buffer is a global sound buffer. With this flag set, an application using DirectSound can continue to play its buffers if the user switches focus to another application, even if the new application uses DirectSound. The one exception is if you switch focus to a DirectSound application that uses the DSSCL_EXCLUSIVE or DSSCL_WRITEPRIMARY flag for its cooperative level. In this case, the global sounds from other applications will not be audible.DSBCAPS_GETCURRENTPOSITION2Indicates that IDirectSoundBuffer::GetCurrentPosition should use the new behavior of the play cursor. In DirectSound in DirectX 1, the play cursor was significantly ahead of the actual playing sound on emulated sound cards; it was directly behind the write cursor. Now, if the DSBCAPS_GETCURRENTPOSITION2 flag is specified, the application can get a more accurate play position. If this flag is not specified, the old behavior is preserved for compatibility. Note that this flag affects only emulated sound cards; if a DirectSound driver is present, the play cursor is accurate for DirectSound in all versions of DirectX.DSBCAPS_MUTE3DATMAXDISTANCEThe sound is reduced to silence at the maximum distance. The buffer will stop playing when the maximum distance is exceeded, so that processor time is not wasted.""" - ... - - @property - def dwBufferBytes(self) -> int: - """Size of the new buffer, in bytes. This value must be 0 when creating primary buffers. For secondary buffers, the minimum and maximum sizes allowed are specified by DSBSIZE_MIN and DSBSIZE_MAX.""" - ... - - @property - def lpwfxFormat(self) -> Any: - """Structure specifying the waveform format for the buffer. This value must be None for primary buffers. The application can use IDirectSoundBuffer::SetFormat to set the format of the primary buffer. Sentinel""" - ... - - -class PyDSCAPS: - """A Python object, representing a DSCAPS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def dwFlags(self) -> int: - """Specifies device capabilities. Can be one or more of the following:FlagDescriptionDSCAPS_PRIMARYMONOThe device supports monophonic primary buffers.DSCAPS_PRIMARYSTEREOThe device supports stereo primary buffers.DSCAPS_PRIMARY8BITThe device supports hardware-mixed secondary buffers with 8-bit samples.DSCAPS_PRIMARY16BITThe device supports primary sound buffers with 16-bit samples.DSCAPS_CONTINUOUSRATEThe device supports all sample rates between the dwMinSecondarySampleRate and dwMaxSecondarySampleRate member values. Typically, this means that the actual output rate will be within +/- 10 hertz (Hz) of the requested frequency.DSCAPS_EMULDRIVERThe device does not have a DirectSound driver installed, so it is being emulated through the waveform-audio functions. Performance degradation should be expected.DSCAPS_CERTIFIEDThis driver has been tested and certified by Microsoft.DSCAPS_SECONDARYMONOThe device supports hardware-mixed monophonic secondary buffers.DSCAPS_SECONDARYSTEREOThe device supports hardware-mixed stereo secondary buffers.DSCAPS_SECONDARY8BITThe device supports hardware-mixed secondary buffers with 8-bit samples.DSCAPS_SECONDARY16BITThe device supports hardware-mixed secondary sound buffers with 16-bit samples.""" - ... - - @property - def dwMinSecondarySampleRate(self) -> int: - """Minimum sample rate supported by this device's hardware secondary sound buffers.""" - ... - - @property - def dwMaxSecondarySampleRate(self) -> int: - """Maximum sample rate supported by this device's hardware secondary sound buffers.""" - ... - - @property - def dwPrimaryBuffers(self) -> int: - """Number of primary buffers supported. This value will always be 1.""" - ... - - @property - def dwMaxHwMixingAllBuffers(self) -> int: - """Specifies the total number of buffers that can be mixed in hardware. This member can be less than the sum of dwMaxHwMixingStaticBuffers and dwMaxHwMixingStreamingBuffers. Resource tradeoffs frequently occur.""" - ... - - @property - def dwMaxHwMixingStaticBuffers(self) -> int: - """Specifies the maximum number of static sound buffers.""" - ... - - @property - def dwMaxHwMixingStreamingBuffers(self) -> int: - """Specifies the maximum number of streaming sound buffers.""" - ... - - @property - def dwFreeHwMixingAllBuffers(self) -> int: - """Description of the free hardware mixing capabilities of the device. An application can use this value to determine whether hardware resources are available for allocation to a secondary sound buffer. Also, by comparing these values to the members that specify maximum mixing capabilities, the resources that are already allocated can be determined.""" - ... - - @property - def dwFreeHwMixingStaticBuffers(self) -> int: - """Description of the free hardware mixing capabilities of the device. An application can use this value to determine whether hardware resources are available for allocation to a secondary sound buffer. Also, by comparing these values to the members that specify maximum mixing capabilities, the resources that are already allocated can be determined.""" - ... - - @property - def dwFreeHwMixingStreamingBuffers(self) -> int: - """Description of the free hardware mixing capabilities of the device. An application can use this value to determine whether hardware resources are available for allocation to a secondary sound buffer. Also, by comparing these values to the members that specify maximum mixing capabilities, the resources that are already allocated can be determined.""" - ... - - @property - def dwMaxHw3DAllBuffers(self) -> int: - """Description of the hardware 3-D positional capabilities of the device.""" - ... - - @property - def dwMaxHw3DStaticBuffers(self) -> int: - """Description of the hardware 3-D positional capabilities of the device.""" - ... - - @property - def dwMaxHw3DStreamingBuffers(self) -> int: - """Description of the hardware 3-D positional capabilities of the device.""" - ... - - @property - def dwFreeHw3DAllBuffers(self) -> int: - """Description of the free, or unallocated, hardware 3-D positional capabilities of the device.""" - ... - - @property - def dwFreeHw3DStaticBuffers(self) -> int: - """Description of the free, or unallocated, hardware 3-D positional capabilities of the device.""" - ... - - @property - def dwFreeHw3DStreamingBuffers(self) -> int: - """Description of the free, or unallocated, hardware 3-D positional capabilities of the device.""" - ... - - @property - def dwTotalHwMemBytes(self) -> int: - """Size, in bytes, of the amount of memory on the sound card that stores static sound buffers.""" - ... - - @property - def dwFreeHwMemBytes(self) -> int: - """Size, in bytes, of the free memory on the sound card.""" - ... - - @property - def dwMaxContigFreeHwMemBytes(self) -> int: - """Size, in bytes, of the largest contiguous block of free memory on the sound card.""" - ... - - @property - def dwUnlockTransferRateHwBuffers(self) -> int: - """Description of the rate, in kilobytes per second, at which data can be transferred to hardware static sound buffers. This and the number of bytes transferred determines the duration of a call to the IDirectSoundBuffer::Update method.""" - ... - - @property - def dwPlayCpuOverheadSwBuffers(self) -> int: - """Description of the processing overhead, as a percentage of the central processing unit, needed to mix software buffers (those located in main system memory). This varies according to the bus type, the processor type, and the clock speed. The unlock transfer rate for software buffers is 0 because the data need not be transferred anywhere. Similarly, the play processing overhead for hardware buffers is 0 because the mixing is done by the sound device.""" - ... - - -class PyDSCBCAPS: - """A Python object, representing a DSCBCAPS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def dwFlags(self) -> int: - """Specifies device capabilities. Can be 0 or DSCBCAPS_EMULDRIVER (indicates that no DirectSound Device is available and standard wave audio functions are being used).""" - ... - - @property - def dwBufferBytes(self) -> int: - """The size, in bytes, of the capture buffer.""" - ... - - -class PyDSCBUFFERDESC: - """A Python object, representing a DSCBUFFERDESC structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def dwFlags(self) -> int: - """Identifies the capabilities to include when creating a new DirectSoundBuffer object. Can be zero or the following flag:FlagDescriptionDSCBCAPS_WAVEMAPPEDThe Win32 wave mapper will be used for formats not supported by the device.""" - ... - - @property - def dwBufferBytes(self) -> int: - """Size of the new buffer, in bytes. This value must be 0 when creating primary buffers. For secondary buffers, the minimum and maximum sizes allowed are specified by DSBSIZE_MIN and DSBSIZE_MAX.""" - ... - - @property - def lpwfxFormat(self) -> Any: - """Structure specifying the waveform format for the buffer. This value must be None for primary buffers. The application can use IDirectSoundBuffer::SetFormat to set the format of the primary buffer. Sentinel""" - ... - - -class PyDSCCAPS: - """A Python object, representing a DSCCAPS structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def dwFlags(self) -> int: - """Specifies device capabilities. Can be zero or the following flag:FlagDescriptionDSCCAPS_EMULDRIVERIndicates that no DirectSound Device is available and standard wave audio functions are being used.""" - ... - - @property - def dwFormats(self) -> int: - """Bitset of supported WAVE_FORMAT formats.""" - ... - - @property - def dwChannels(self) -> int: - """Number of channels supported by the device.""" - ... - - -class PyDSOP_FILTER_FLAGS: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def uplevel(self) -> Any: - ... - - @property - def downlevel(self) -> Any: - ... - - -class PyDSOP_SCOPE_INIT_INFO: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def type(self) -> Any: - ... - - @property - def scope(self) -> Any: - ... - - @property - def hr(self) -> Any: - ... - - @property - def dcName(self) -> str: - ... - - @property - def filterFlags(self) -> Any: - ... - - -class PyDSOP_SCOPE_INIT_INFOs: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyDSOP_UPLEVEL_FILTER_FLAGS: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def bothModes(self) -> Any: - ... - - @property - def mixedModeOnly(self) -> Any: - ... - - @property - def nativeModeOnly(self) -> Any: - ... - - -class PyFORMATETC: - """tuple representing a FORMATETC struct describing an OLE data format""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyGFileOperationProgressSink: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def StartOperations(self) -> None: - """ - Called as operation begins, before any modifications are done - -Args: - - - -Returns: - - None - - """ - ... - - def FinishOperations(self, Result: Any) -> None: - """ - Called after all actions have been performed - -Args: - - Result(Any):HRESULT of last operation performed - -Returns: - - None - - """ - ... - - def PreRenameItem(self, Flags: Any, Item: Any, NewName: Any) -> None: - """ - Called before each file rename - -Args: - - Flags(Any):Flags specifying copy behaviour, combination of shellcon.TSF_* flags - Item(Any):Shell interface of the copied item - NewName(Any):New display name of the item - -Returns: - - None - - """ - ... - - def PostRenameItem(self, Flags: Any, Item: Any, NewName: Any, hrRename: Any, NewlyCreated: Any) -> None: - """ - Called after each file rename - -Args: - - Flags(Any):Flags specifying rename behaviour, combination of shellcon.TSF_* flags - Item(Any):Shell interface of item before rename - NewName(Any):The new name of the item, may be mangled to resolve filename conflicts - hrRename(Any):HRESULT of the rename operation - NewlyCreated(Any):Shell interface of the item after rename - -Returns: - - None - - """ - ... - - def PreMoveItem(self, Flags: Any, Item: Any, DestinationFolder: Any, NewName: Any) -> None: - """ - Called before each move operation - -Args: - - Flags(Any):Flags specifying move behaviour, combination of shellcon.TSF_* flags - Item(Any):The item to be moved - DestinationFolder(Any):The folder into which it will be moved - NewName(Any):Name of moved item, may be None if not to be changed - -Returns: - - None - - """ - ... - - def PostMoveItem( - self, - Flags: Any, - Item: Any, - DestinationFolder: Any, - NewName: Any, - hrMove: Any, - NewlyCreated: Any) -> None: - """ - Called after each move operation - -Args: - - Flags(Any):Flags specifying move behaviour, combination of shellcon.TSF_* flags - Item(Any):Interface of the item before it was moved - DestinationFolder(Any):The folder into which it was moved - NewName(Any):Name of item in its new location, may be mangled in case of conflict - hrMove(Any):HRESULT of the move operation - NewlyCreated(Any):Shell interface of the item in its new location - -Returns: - - None - - """ - ... - - def PreCopyItem(self, Flags: Any, Item: Any, DestinationFolder: Any, NewName: Any) -> None: - """ - Called before each copy operation - -Args: - - Flags(Any):Flags specifying copy behaviour, combination of shellcon.TSF_* flags - Item(Any):The item to be copied - DestinationFolder(Any):Folder into which it will be copied - NewName(Any):Name to be given to the copy, will be None if keeping original name - -Returns: - - None - - """ - ... - - def PostCopyItem( - self, - Flags: Any, - Item: Any, - DestinationFolder: Any, - NewName: Any, - hrCopy: Any, - NewlyCreated: Any) -> None: - """ - Called after each copy operation - -Args: - - Flags(Any):Flags specifying copy behaviour, combination of shellcon.TSF_* flags - Item(Any):The original item - DestinationFolder(Any):Folder into which it was copied - NewName(Any):Name of item after copy, may be mangled in case of name conflict - hrCopy(Any):HRESULT of the copy operation - NewlyCreated(Any):Shell interface of the copy - -Returns: - - None - - """ - ... - - def PreDeleteItem(self, Flags: Any, Item: Any) -> None: - """ - Called before each delete operation - -Args: - - Flags(Any):Flags specifying delete behaviour, combination of shellcon.TSF_* flags - Item(Any):Item to be deleted - -Returns: - - None - - """ - ... - - def PostDeleteItem(self, Flags: Any, Item: Any, hrDelete: Any, NewlyCreated: Any) -> None: - """ - Called after each delete operation - -Args: - - Flags(Any):Flags specifying delete behaviour, combination of shellcon.TSF_* flags - Item(Any):Item that was deleted - hrDelete(Any):HRESULT of the delete operation - NewlyCreated(Any):Item in the recycle bin, or None if deleted without recycling - -Returns: - - None - - """ - ... - - def PreNewItem(self, Flags: Any, DestinationFolder: Any, NewName: Any) -> None: - """ - Called before each new file is created - -Args: - - Flags(Any):Flags specifying creation behaviour, combination of shellcon.TSF_* flags - DestinationFolder(Any):Folder where item will be created - NewName(Any):Name of item to be created - -Returns: - - None - - """ - ... - - def PostNewItem( - self, - Flags: Any, - DestinationFolder: Any, - NewName: Any, - TemplateName: Any, - FileAttributes: Any, - hrNew: Any, - NewItem: Any) -> None: - """ - Called after each new file is created - -Args: - - Flags(Any):Flags specifying creation behaviour, combination of shellcon.TSF_* flags - DestinationFolder(Any):Folder in which item was created - NewName(Any):Name of created item, may be mangled if file name conflicts occurred - TemplateName(Any):Template file used to initialize new item - FileAttributes(Any):File attributes of new item - hrNew(Any):HRESULT of the create operation - NewItem(Any):Shell interface of created item - -Returns: - - None - - """ - ... - - def UpdateProgress(self, WorkTotal: Any, WorkSoFar: Any) -> None: - """ - Gives an estimate of total work completed - -Args: - - WorkTotal(Any):Undimensioned number representing total amount of work - WorkSoFar(Any):Undimensioned number representing amount already completed - -Returns: - - None - - """ - ... - - def ResetTimer(self) -> None: - """ - Not implemented, according to MSDN - -Args: - - - -Returns: - - None - - """ - ... - - def PauseTimer(self) -> None: - """ - Not implemented, according to MSDN - -Args: - - - -Returns: - - None - - """ - ... - - def ResumeTimer(self) -> None: - """ - Not implemented, according to MSDN - -Args: - - - -Returns: - - None - - """ - ... - - -class PyGSecurityInformation: - """Gateway wrapper for the implement-only ISecurityInformation interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetObjectInformation(self) -> Any: - """ - Returns information identifying the object - -whose security is to be editted, and which pages are to appear in the property sheet - -Args: - - - -Returns: - - Any:PyGSecurityInformation.GetObjectInformation -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, - -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 - - - """ - ... - - def GetSecurity(self, RequestedInformation: Any, Default: Any) -> PySECURITY_DESCRIPTOR: - """ - Retrieves the object's current security - -settings - -Args: - - RequestedInformation(Any):Combination of SECURITY_INFORMATION flags indicating which components of the object's security descriptor you should return - default(Any):If true, return a default security descriptor rather than current security. (invoked when 'Reset' button is clicked) - -Returns: - - PySECURITY_DESCRIPTOR - - """ - ... - - def SetSecurity(self, SecurityInformation: Any, SecurityDescriptor: PySECURITY_DESCRIPTOR) -> None: - """ - Applies the modified security to the object - -Args: - - SecurityInformation(Any):SECURITY_INFORMATION flags specifying which types of security information are to be applied - SecurityDescriptor(PySECURITY_DESCRIPTOR):The security information to be applied to the objectReturn ValueAny returned value is ignored - -Returns: - - None:The security information to be applied to the objectReturn ValueAny returned value is ignored - - - """ - ... - - def GetAccessRights(self, ObjectType: PyIID, Flags: Any) -> tuple[Any, Any]: - """ - Retrieves permission that can be set - -Args: - - ObjectType(PyIID):GUID representing type of object, may be None - Flags(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, and a zero-based index indicating which of them is the default - -Returns: - - tuple[Any, 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, - -and a zero-based index indicating which of them is the default - - - """ - ... - - def MapGeneric(self, ObjectType: PyIID, AceFlags: Any, Mask: Any) -> Any: - """ - Translates generic access rights to specific equivalents - -Args: - - ObjectType(PyIID):Type of object that permissions apply to, None or GUID_NULL indicates object itself - AceFlags(Any):Flags from the ACE that contains the permissions - Mask(Any):Bitmask containing access rightsCommentsSee win32security::MapGenericMaskReturn ValueThis method should return the input bitmask will all generic rights mapped to specific rights - -Returns: - - Any:Bitmask containing access rightsComments - -See win32security::MapGenericMask -Return ValueThis method should return the input bitmask will all generic rights mapped to specific rights - - - """ - ... - - def GetInheritTypes(self) -> tuple[Any, ...]: - """ - Requests types of inheritance that your - -implementation supports - -Args: - - - -Returns: - - tuple[Any, ...]:PyGSecurityInformation.GetInheritTypes - -(SI_INHERIT_TYPE,...) = GetInheritTypes()Requests types of inheritance that your - -implementation supports -Return ValueReturns a sequence of SI_INHERIT_TYPE tuples - - - """ - ... - - def PropertySheetPageCallback(self, hwnd: Any, Msg: Any, Page: Any) -> None: - """ - Called by each page as it is created and destroyed - -Args: - - hwnd(Any):Handle to the window for the page - Msg(Any):Flag indicating type of event, one of PSPCB_CREATE,PSPCB_RELEASE,PSPCB_SI_INITDIALOG - Page(Any):SI_PAGE_TYPE value indicating which page is making the call (ntsecuritycon.SI_PAGE_*)Return ValueAny returned value will be ignored - -Returns: - - None:SI_PAGE_TYPE value indicating which page is making the call (ntsecuritycon.SI_PAGE_*)Return ValueAny returned value will be ignored - - - """ - ... - - -class PyIADesktopP2: - """An interface to the ActiveDesktop""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def UpdateAllDesktopSubscriptions(self) -> None: - """ - Updates webpage subscriptions on the desktop - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIADs: - """An object representing the IADs interface. - -In most cases you can achieve the same result via IDispatch - however, this - -interface allows you get get and set properties without the IDispatch - -overhead.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def ADsPath(self) -> str: - ... - - @property - def AdsPath(self) -> str: - """Synonym for ADsPath""" - ... - - @property - def Class(self) -> str: - ... - - @property - def GUID(self) -> str: - """Like the IADs method, this returns a string rather than a GUID object.""" - ... - - @property - def Name(self) -> str: - ... - - @property - def Parent(self) -> str: - ... - - @property - def Schema(self) -> str: - ... - - def GetInfo(self) -> None: - """ - Description of GetInfo. - -Args: - - - -Returns: - - None - - """ - ... - - def SetInfo(self) -> None: - """ - Description of SetInfo. - -Args: - - - -Returns: - - None - - """ - ... - - def Get(self, prop: str) -> Any: - """ - Description of Get. - -Args: - - prop(str):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. - -Returns: - - 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. - - - """ - ... - - def Put(self, _property: str, val: Any) -> None: - """ - Description of Put. - -Args: - - _property(str):The property name to set - val(Any):The value to set. - -Returns: - - None - - """ - ... - - def get(self, prop: str) -> Any: - """ - Description of Get. - -Args: - - prop(str):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. - -Returns: - - 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. - - - """ - ... - - def put(self, _property: str, val: Any) -> None: - """ - Description of Put. - -Args: - - _property(str):The property name to set - val(Any):The value to set. - -Returns: - - None - - """ - ... - - -class PyIADsContainer: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetObject(self, _class: str, relativeName: str) -> Any: - """ - None - -Args: - - _class(str):Specifies the name of the object class as known in the underlying directory and identical to the one retrieved through the get_Class property method. If the class name is None, the provider returns the first item found in the container. - relativeName(str):Specifies the name of the object as known in the underlying directory and identical to the one retrieved through the get_Name property method. - -Returns: - - Any - - """ - ... - - def get_Count(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def get_Filter(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def put_Filter(self, val: Any) -> None: - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - ... - - def get_Hints(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def put_Hints(self, val: Any) -> None: - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - ... - - -class PyIADsUser: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def get_AccountDisabled(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def put_AccountDisabled(self, val: Any) -> None: - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - ... - - def get_AccountExpirationDate(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def put_AccountExpirationDate(self, val: PyTime) -> None: - """ - None - -Args: - - val(PyTime): - -Returns: - - None - - """ - ... - - def get_BadLoginAddress(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def get_BadLoginCount(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def get_Department(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def put_Department(self, val: Any) -> None: - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - ... - - def get_Description(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def put_Description(self, val: Any) -> None: - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - ... - - def get_Division(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def put_Division(self, val: Any) -> None: - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - ... - - def get_EmailAddress(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def put_EmailAddress(self, val: Any) -> None: - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - ... - - def get_EmployeeID(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def put_EmployeeID(self, val: Any) -> None: - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - ... - - def get_FirstName(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def put_FirstName(self, val: Any) -> None: - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - ... - - def get_FullName(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def put_FullName(self, val: Any) -> None: - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - ... - - def get_HomeDirectory(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def put_HomeDirectory(self, val: Any) -> None: - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - ... - - def get_HomePage(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def put_HomePage(self, val: Any) -> None: - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - ... - - def get_LoginScript(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def put_LoginScript(self, val: Any) -> None: - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - ... - - def Setpassword(self, val: Any) -> None: - """ - None - -Args: - - val(Any): - -Returns: - - None - - """ - ... - - def Changepassword(self, oldval: Any, newval: Any) -> None: - """ - None - -Args: - - oldval(Any): - newval(Any): - -Returns: - - None - - """ - ... - - -class PyIActiveDesktop: - """An interface to the ActiveDesktop""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def ApplyChanges(self, Flags: Any) -> None: - """ - Applies changes to ActiveDesktop settings and persists them to the registry. - -Args: - - Flags(Any):Combination of shellcon.AD_APPLY_* flags - -Returns: - - None - - """ - ... - - def GetWallpaper(self, cchWallpaper: Any, Reserved: Any = 0) -> Any: - """ - Returns the current wallpaper - -Args: - - cchWallpaper(Any):Number of characters to allocate for buffer - Reserved(Any):Use 0 if passed in - -Returns: - - Any - - """ - ... - - def SetWallpaper(self, Wallpaper: Any, Reserved: Any = 0) -> None: - """ - Sets the desktop wallpaper - -Args: - - Wallpaper(Any):File to be used as new wallpaper - Reserved(Any):Reserved, use 0 if passed in - -Returns: - - None - - """ - ... - - def GetWallpaperOptions(self, Reserved: Any = 0) -> Any: - """ - Returns wallpaper style - -Args: - - Reserved(Any):Use 0 if passed inReturn ValueReturns one of the WPSTYLE_* values - -Returns: - - Any:Use 0 if passed in -Return ValueReturns one of the WPSTYLE_* values - - - """ - ... - - def SetWallpaperOptions(self, Style: Any, Reserved: Any = 0) -> None: - """ - Sets wallpaper style - -Args: - - Style(Any):The wallpaper style, one of the WPSTYLE_* constants - Reserved(Any):Reserved, use 0 if passed in - -Returns: - - None - - """ - ... - - def GetPattern(self, cchPattern: Any = 1024, Reserved: Any = 0) -> None: - """ - Returns the wallpaper pattern - -Args: - - cchPattern(Any):Number of characters to allocate for buffer - Reserved(Any):Use 0 if passed inReturn ValueReturns a unicode string containing decimal values representing the pattern - -Returns: - - None:Use 0 if passed in -Return ValueReturns a unicode string containing decimal values representing the pattern - - - """ - ... - - def SetPattern(self, Pattern: Any, Reserved: Any = 0) -> None: - """ - Sets the wallpaper pattern - -Args: - - Pattern(Any):String of decimal numbers representing a picture - Reserved(Any):Use 0 if passed in - -Returns: - - None - - """ - ... - - def GetDesktopItemOptions(self) -> Any: - """ - Returns options for Active Desktop. - -Args: - - - -Returns: - - Any:PyIActiveDesktop.GetDesktopItemOptions - -dict = GetDesktopItemOptions()Returns options for Active Desktop. -Return ValueReturns a COMPONENTSOPT dictionary - - - """ - ... - - def SetDesktopItemOptions(self, comp: Any, Reserved: Any = 0) -> None: - """ - Sets Active Desktop options - -Args: - - comp(Any):COMPONENTSOPT dictionary - Reserved(Any):Use 0 if passed in - -Returns: - - None - - """ - ... - - def AddDesktopItem(self, comp: Any, Reserved: Any = 0) -> None: - """ - Creates a new item to display on the desktop - -Args: - - comp(Any):COMPONENT dictionary - Reserved(Any):Use 0 if passed in - -Returns: - - None - - """ - ... - - def AddDesktopItemWithUI(self, hwnd: int, comp: Any, Flags: Any) -> None: - """ - Adds a desktop item, allowing user interaction - -Args: - - hwnd(int):Handle to parent window - comp(Any):COMPONENT dictionary - Flags(Any):One of shellcon.DTI_ADDUI_* flags - -Returns: - - None - - """ - ... - - def ModifyDesktopItem(self, comp: Any, Flags: Any) -> None: - """ - Changes parameters for a desktop item - -Args: - - comp(Any):COMPONENT dictionary - Flags(Any):Combination of shellcon.COMP_ELEM_* flags - -Returns: - - None - - """ - ... - - def RemoveDesktopItem(self, comp: Any, Reserved: Any = 0) -> None: - """ - Removes an item from the Active Desktop - -Args: - - comp(Any):COMPONENT dictionary specifying which component to remove - Reserved(Any):Use 0 if passed in - -Returns: - - None - - """ - ... - - def GetDesktopItemCount(self) -> None: - """ - Returns number of defined desktop items. - -Args: - - - -Returns: - - None - - """ - ... - - def GetDesktopItem(self, Component: Any, Reserved: Any = 0) -> Any: - """ - Returns desktop item parameters by index - -Args: - - Component(Any):The zero-based index of the component to get - Reserved(Any):Use 0 if passed inReturn ValueReturns a COMPONENT dictionary describing the item - -Returns: - - Any:Use 0 if passed in -Return ValueReturns a COMPONENT dictionary describing the item - - - """ - ... - - def GetDesktopItemByID(self, ID: Any, reserved: Any = 0) -> Any: - """ - Returns desktop item parameters by Id - -Args: - - ID(Any):The Id of the desktop item - reserved(Any):Use 0 if passed inReturn ValueReturns a COMPONENT dictionary - -Returns: - - Any:Use 0 if passed in -Return ValueReturns a COMPONENT dictionary - - - """ - ... - - def GenerateDesktopItemHtml(self, FileName: Any, comp: Any, Reserved: Any = 0) -> None: - """ - Creates an HTML page for the desktop item - -Args: - - FileName(Any):Name of file to be created - comp(Any):COMPONENT dictionary specifying the desktop item - Reserved(Any):Use 0 if passed in - -Returns: - - None - - """ - ... - - def AddUrl(self, hwnd: int, Source: Any, comp: Any, Flags: Any) -> None: - """ - Adds a web page to desktop, allowing user interaction - -Args: - - hwnd(int):Parent windows for any user interactive - Source(Any):Source URL - comp(Any):COMPONENT dictionary - Flags(Any):ADDURL_SILENT, or 0 - -Returns: - - None - - """ - ... - - def GetDesktopItemBySource(self, Source: Any, Reserved: Any = 0) -> Any: - """ - Returns desktop item parameters by URL - -Args: - - Source(Any):The URL address of the item to retrieve - Reserved(Any):Use 0 if passed inReturn ValueReturns a COMPONENT dictionary - -Returns: - - Any:Use 0 if passed in -Return ValueReturns a COMPONENT dictionary - - - """ - ... - - -class PyIActiveDesktopP: - """An interface to the ActiveDesktop""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def SetSafeMode(self, Flags: Any) -> None: - """ - Changes Active Desktop to safe mode - -Args: - - Flags(Any):One of shellcon.SSM_* flags - -Returns: - - None - - """ - ... - - -class PyIActiveScriptDebug: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetScriptTextAttributes(self, pstrCode: str, pstrDelimiter: str, dwFlags: Any) -> tuple[Any, ...]: - """ - Returns the text attributes for an arbitrary block - -of script text. - -Args: - - pstrCode(str):The script block text. - pstrDelimiter(str):See PyIActiveScriptParse::ParseScriptText for a description of this argument. - dwFlags(Any):See PyIActiveScriptParse::ParseScriptText for a description of this argument.CommentsSmart hosts use this call to delegate GetText calls made on their axscript::PyIDebugDocumentText - -Returns: - - tuple[Any, ...] - - """ - ... - - def GetScriptletTextAttributes(self, pstrCode: str, pstrDelimiter: str, dwFlags: Any) -> None: - """ - Description of GetScriptletTextAttributes. - -Args: - - pstrCode(str):The script block text. - pstrDelimiter(str):See PyIActiveScriptParse::ParseScriptText for a description of this argument. - dwFlags(Any):See PyIActiveScriptParse::ParseScriptText for a description of this argument. - -Returns: - - None - - """ - ... - - def EnumCodeContextsOfPosition(self, dwSourceContext: Any, uCharacterOffset: Any, uNumChars: Any) -> None: - """ - Description of EnumCodeContextsOfPosition. - -Args: - - dwSourceContext(Any):Description for dwSourceContext - uCharacterOffset(Any):Description for uCharacterOffset - uNumChars(Any):Description for uNumChars - -Returns: - - None - - """ - ... - - -class PyIActiveScriptError: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetExceptionInfo(self) -> None: - """ - Description of GetExceptionInfo. - -Args: - - - -Returns: - - None - - """ - ... - - def GetSourcePosition(self) -> None: - """ - Description of GetSourcePosition. - -Args: - - - -Returns: - - None - - """ - ... - - def GetSourceLineText(self) -> None: - """ - Description of GetSourceLineText. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIActiveScriptErrorDebug: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetDocumentContext(self) -> None: - """ - Description of GetDocumentContext. - -Args: - - - -Returns: - - None - - """ - ... - - def GetStackFrame(self) -> None: - """ - Description of GetStackFrame. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIActiveScriptParseProcedure: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def ParseProcedureText( - self, - pstrCode: Any, - pstrFormalParams: Any, - pstrProcedureName: Any, - pstrItemName: Any, - punkContext: Any, - pstrDelimiter: Any, - dwSourceContextCookie: Any, - ulStartingLineNumber: Any, - dwFlags: Any) -> None: - """ - Description of ParseProcedureText. - -Args: - - pstrCode(Any):Description for pstrCode - pstrFormalParams(Any):Description for pstrFormalParams - pstrProcedureName(Any):Description for pstrProcedureName - pstrItemName(Any):Description for pstrItemName - punkContext(Any):Description for punkContext - pstrDelimiter(Any):Description for pstrDelimiter - dwSourceContextCookie(Any):Description for dwSourceContextCookie - ulStartingLineNumber(Any):Description for ulStartingLineNumber - dwFlags(Any):Description for dwFlags - -Returns: - - None - - """ - ... - - -class PyIActiveScriptSite: - """An object providing the IActiveScriptSite interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetLCID(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def GetItemInfo(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def GetDocVersionString(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def OnStateChange(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def OnEnterScript(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def OnLeaveScript(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def OnScriptError(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def OnScriptTerminate(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIActiveScriptSiteDebug: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetDocumentContextFromPosition( - self, - dwSourceContext: Any, - uCharacterOffset: Any, - uNumChars: Any) -> None: - """ - Description of GetDocumentContextFromPosition. - -Args: - - dwSourceContext(Any):Description for dwSourceContext - uCharacterOffset(Any):Description for uCharacterOffset - uNumChars(Any):Description for uNumChars - -Returns: - - None - - """ - ... - - def GetApplication(self) -> None: - """ - Description of GetApplication. - -Args: - - - -Returns: - - None - - """ - ... - - def GetRootApplicationNode(self) -> None: - """ - Description of GetRootApplicationNode. - -Args: - - - -Returns: - - None - - """ - ... - - def OnScriptErrorDebug(self) -> tuple[Any, Any]: - """ - Allows a smart host to control the handling of runtime - -errors - -Args: - - - -Returns: - - tuple[Any, Any]:PyIActiveScriptSiteDebug.OnScriptErrorDebug - -int, int = OnScriptErrorDebug()Allows a smart host to control the handling of runtime - -errors -Return ValueThe result is a tuple of (bCallDebugger, bCallOnScriptErrorWhenContinuing) - - - """ - ... - - -class PyIAddrBook: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def ResolveName(self, uiParm: Any, flags: Any, entryTitle: str, ADRLIST: Any) -> None: - """ - Performs name resolution, assigning entry identifiers to recipients in a recipient list. - -Args: - - uiParm(Any):hwnd of a dialogs parent. - flags(Any):Bitmask of flags that controls whether a dialog box can be displayed. - entryTitle(str): - ADRLIST(Any):Partial addresses to resolve. - -Returns: - - None - - """ - ... - - def OpenEntry(self, entryId: str, iid: PyIID, flags: Any) -> Any: - """ - Opens a folder or message and returns an interface object for further access. - -Args: - - entryId(str):The entryID of the object - iid(PyIID):The IID of the object to return, or None for the default IID - flags(Any):Bitmask of flags that controls how the object is opened. - -Returns: - - Any - - """ - ... - - def CompareEntryIDs(self, entryId: str, entryId1: str, flags: Any = 0) -> Any: - """ - Compares two entry identifiers belonging to a particular address book provider to determine if they refer to the same address book object - -Args: - - entryId(str):The first entry ID to be compared - entryId1(str):The second entry ID to be compared - flags(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. - -Returns: - - 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. - - - """ - ... - - -class PyIApplicationDebugger: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def QueryAlive(self) -> None: - """ - Returns true if alive, else false. - -Args: - - - -Returns: - - None - - """ - ... - - def CreateInstanceAtDebugger(self, rclsid: PyIID, pUnkOuter: Any, dwClsContext: Any, riid: PyIID) -> None: - """ - Create objects in the application process address space. - -Args: - - rclsid(PyIID):Description for rclsid - pUnkOuter(Any):Description for pUnkOuter - dwClsContext(Any):Description for dwClsContext - riid(PyIID):Description for riidCommentsProvides a mechanism for the debugger IDE, running out-of-process to the application, to create objects in the application process. This method simply delegates to CoCreateInstance. - -Returns: - - None - - """ - ... - - def onDebugOutput(self, pstr: Any) -> None: - """ - None - -Args: - - pstr(Any):Description for pstrCommentsThe debugger can use this to display the string in an output window. - -Returns: - - None - - """ - ... - - def onHandleBreakPoint(self, prpt: Any, br: Any, pError: Any) -> None: - """ - Called when a breakpoint is hit. - -Args: - - prpt(Any):Description for prpt - br(Any):Description for br - pError(Any):Description for pErrorCommentsThe application will remain suspended until the debugger IDE calls PyIDebugApplication::ResumeFromBreakPoint. - -Returns: - - None - - """ - ... - - def onClose(self) -> None: - """ - None - -Args: - - - -Returns: - - None - - """ - ... - - def onDebuggerEvent(self, guid: PyIID, uUnknown: Any) -> None: - """ - Description of onDebuggerEvent. - -Args: - - guid(PyIID): - uUnknown(Any):CommentsThe semantics of guid and unknown are entirely application/debugger defined This method may return E_NOTIMPL. - -Returns: - - None - - """ - ... - - -class PyIApplicationDestinations: - """Allows an application to removed items from its jump lists""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def SetAppID(self, AppID: Any) -> None: - """ - Specifies the application whose jump list is to be accessed - -Args: - - AppID(Any):Taskbar identifier for the applicationCommentsThis method is only needed if the application sets its own taskbar identifier - -Returns: - - None - - """ - ... - - def RemoveDestination(self, punk: Any) -> None: - """ - Removes a single entry from the jump lists - -Args: - - punk(Any):IShellItem or IShellLink representing an item in the application's jump listCommentsDoes not remove pinned items - -Returns: - - None - - """ - ... - - def RemoveAllDestinations(self) -> None: - """ - Removes all Recent and Frequent jump list entries - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIApplicationDocumentLists: - """Interface used to retrieve the jump lists for an application""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def SetAppID(self, AppID: Any) -> None: - """ - Specifies the application whose jump list is to be accessed - -Args: - - AppID(Any):Taskbar identifier for the applicationCommentsThis method is only needed if the application sets its own taskbar identifier - -Returns: - - None - - """ - ... - - def GetList(self, ListType: Any, riid: PyIID, ItemsDesired: Any = 0) -> Any: - """ - Retrieves a list of items in a jump list - -Args: - - ListType(Any):Type of document list to return, shellcon.ADLT_RECENT or ADLT_FREQUENT - riid(PyIID):The interface to return, IID_IEnumObjects or IID_IObjectArray - ItemsDesired(Any):Number of items to return, use 0 for all available - -Returns: - - Any - - """ - ... - - -class PyIAsyncOperation: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def SetAsyncMode(self, fDoOpAsync: Any) -> None: - """ - Description of SetAsyncMode. - -Args: - - fDoOpAsync(Any):Description for fDoOpAsync - -Returns: - - None - - """ - ... - - def GetAsyncMode(self) -> Any: - """ - Description of GetAsyncMode. - -Args: - - - -Returns: - - Any - - """ - ... - - def StartOperation(self, pbcReserved: Any) -> None: - """ - Description of StartOperation. - -Args: - - pbcReserved(Any):Description for pbcReserved - -Returns: - - None - - """ - ... - - def InOperation(self) -> None: - """ - Description of InOperation. - -Args: - - - -Returns: - - None - - """ - ... - - def EndOperation(self, hResult: Any, pbcReserved: Any, dwEffects: Any) -> None: - """ - Description of EndOperation. - -Args: - - hResult(Any):Description for hResult - pbcReserved(Any):Description for pbcReserved - dwEffects(Any):Description for dwEffects - -Returns: - - None - - """ - ... - - -class PyIAttach: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetLastError(self, hr: Any, flags: Any) -> Any: - """ - Returns the last error code for the object. - -Args: - - hr(Any):Contains the error code generated in the previous method call. - flags(Any):Indicates for format for the output. - -Returns: - - Any - - """ - ... - - -class PyIBindCtx: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetRunningObjectTable(self) -> Any: - """ - Retrieves an object interfacing to the Running - -Object Table. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetBindOptions(self) -> Any: - """ - Retrieves the bind options for the bind context - -Args: - - - -Returns: - - Any - - """ - ... - - def SetBindOptions(self, bindopts: Any) -> None: - """ - Sets the bind options for the context - -Args: - - bindopts(Any):PyBIND_OPTS dictionary containing the binding options - -Returns: - - None - - """ - ... - - def RegisterObjectParam(self, Key: str, punk: Any) -> None: - """ - Adds an object to the context's keyed table of associated objects - -Args: - - Key(str):The string key for the object to be registered - punk(Any):COM object to be registered with the bind context - -Returns: - - None - - """ - ... - - def RevokeObjectParam(self, Key: str) -> None: - """ - Removes one of the bind context's registered objects - -Args: - - Key(str):The string key for the object to be removed - -Returns: - - None - - """ - ... - - def GetObjectParam(self, Key: str) -> Any: - """ - Returns one of the bind context's associated objects - -Args: - - Key(str):The string key for the object to be returned - -Returns: - - Any - - """ - ... - - def EnumObjectParam(self) -> Any: - """ - Creates an enumerator to list context's string keys - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIBrowserFrameOptions: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetFrameOptions(self, dwMask: Any) -> None: - """ - Description of GetFrameOptions. - -Args: - - dwMask(Any):Description for dwMask - -Returns: - - None - - """ - ... - - -class PyICancelMethodCalls: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Cancel(self, Seconds: Any) -> None: - """ - Cancels a pending call - -Args: - - Seconds(Any):Wait timeout in seconds - -Returns: - - None - - """ - ... - - def TestCancel(self) -> Any: - """ - Checks if a request has been made to cancel a call - -Args: - - - -Returns: - - Any:PyICancelMethodCalls.TestCancel - -int = TestCancel()Checks if a request has been made to cancel a call -Return ValueCan return RPC_S_CALLPENDING or RPC_E_CALL_CANCELED - - - """ - ... - - -class PyICatInformation: - """A Python interface to ICatInformation""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def EnumCategories(self, lcid: Any = 0) -> Any: - """ - Returns an enumerator for the component categories - -registered on the system. - -Args: - - lcid(Any):lcid - -Returns: - - Any - - """ - ... - - def GetCategoryDesc(self, lcid: Any = 0) -> str: - """ - Retrieves the localized description string for a specific category - -ID. - -Args: - - lcid(Any):lcidCommentsThe return type is a unicode object. - -Returns: - - str - - """ - ... - - def EnumClassesOfCategories(self, listIIdImplemented: list[PyIID] = None, listIIdRequired: Any = None) -> Any: - """ - Returns an enumerator over the classes that - -implement one or more interfaces. - -Args: - - listIIdImplemented(list[PyIID]):A sequence of PyIID objects, or None. - listIIdRequired(Any):A sequence of PyIID objects, or None. - -Returns: - - Any - - """ - ... - - -class PyICatRegister: - """An interface to a COM ICatRegister interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def RegisterCategories(self, arg: list[Any]) -> None: - """ - Registers one or more component categories. Each component category - -consists of a CATID and a list of locale-dependent description strings. - -Args: - - arg(list[Any]):A sequence of category descriptions. - -Returns: - - None - - """ - ... - - def UnRegisterCategories(self, arg: list[PyIID]) -> None: - """ - Unregister one or more previously registered categories. - -Args: - - arg(list[PyIID]):The list of category IDs to be unregistered. - -Returns: - - None - - """ - ... - - def RegisterClassImplCategories(self, clsid: PyIID, arg: list[PyIID]) -> None: - """ - Registers the class as implementing one or more component - -categories. - -Args: - - clsid(PyIID):Class ID of the relevent class - arg(list[PyIID]):A sequence of category IDs to be associated with the class. - -Returns: - - None - - """ - ... - - def UnRegisterClassImplCategories(self, clsid: PyIID, arg: list[PyIID]) -> None: - """ - Unregisters the class as implementing one or more component - -categories. - -Args: - - clsid(PyIID):Class ID of the relevent class - arg(list[PyIID]):A sequence of category IDs to be unregistered from the class. - -Returns: - - None - - """ - ... - - def RegisterClassReqCategories(self, clsid: PyIID, arg: list[PyIID]) -> None: - """ - Registers the class as requiring one or more component - -categories. - -Args: - - clsid(PyIID):Class ID of the relevent class - arg(list[PyIID]):A sequence of category IDs to be associated with the class. - -Returns: - - None - - """ - ... - - def UnRegisterClassReqCategories(self, clsid: PyIID, arg: list[PyIID]) -> None: - """ - Unregisters the class as requiring one or more component - -categories. - -Args: - - clsid(PyIID):Class ID of the relevent class - arg(list[PyIID]):A sequence of category IDs to be unregistered for the class. - -Returns: - - None - - """ - ... - - -class PyICategoryProvider: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CanCategorizeOnSCID(self, pscid: Any) -> None: - """ - Description of CanCategorizeOnSCID. - -Args: - - pscid(Any):Description for pscid - -Returns: - - None - - """ - ... - - def GetDefaultCategory(self) -> None: - """ - Description of GetDefaultCategory. - -Args: - - - -Returns: - - None - - """ - ... - - def GetCategoryForSCID(self, pscid: Any) -> None: - """ - Description of GetCategoryForSCID. - -Args: - - pscid(Any):Description for pscid - -Returns: - - None - - """ - ... - - def EnumCategories(self) -> None: - """ - Description of EnumCategories. - -Args: - - - -Returns: - - None - - """ - ... - - def GetCategoryName(self, guid: PyIID) -> None: - """ - Description of GetCategoryName. - -Args: - - guid(PyIID):Description for pguidCommentsThe buffer is always 1024 chars long - -Returns: - - None - - """ - ... - - def CreateCategory(self, guid: PyIID, riid: PyIID) -> None: - """ - Description of CreateCategory. - -Args: - - guid(PyIID):Description for pguid - riid(PyIID):Description for riid - -Returns: - - None - - """ - ... - - -class PyIClassFactory: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CreateInstance(self, outerUnknown: Any, iid: PyIID) -> Any: - """ - Creates an uninitialized object. - -Args: - - outerUnknown(Any):Usually None, otherwise the outer unknown if the object is being created as part of an aggregate. - iid(PyIID):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. - -Returns: - - Any: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. - - - """ - ... - - def LockServer(self, bInc: Any) -> None: - """ - Called by the client of a class object to keep a server open in memory, - -allowing instances to be created more quickly. - -Args: - - bInc(Any):1 of the server should be locked, 0 if the server should be unlocked. - -Returns: - - None - - """ - ... - - -class PyIClientSecurity: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def QueryBlanket(self, Proxy: Any) -> Any: - """ - Retrieves the authentication settings for an interface - -Args: - - Proxy(Any):An interface created through a proxy - -Returns: - - Any - - """ - ... - - def SetBlanket( - self, - Proxy: Any, - AuthnSvc: Any, - AuthzSvc: Any, - ServerPrincipalName: str, - AuthnLevel: Any, - ImpLevel: Any, - AuthInfo: Any, - Capabilities: Any) -> None: - """ - Changes the authentication options used with an interface - -Args: - - Proxy(Any):The proxy interface for which to set security options - AuthnSvc(Any):Authentication service identifier, pythoncom.RPC_C_AUTHN_* (but not RPC_C_AUTHN_LEVEL_*) - AuthzSvc(Any):Authorization service identifier, pythoncom.RPC_C_AUTHZ_* - ServerPrincipalName(str):SPN that identifies the server, can be None - AuthnLevel(Any):Authentication level, pythoncom.RPC_C_AUTHN_LEVEL_* - ImpLevel(Any):Impersonation level, pythoncom.RPC_C_IMP_LEVEL_* - AuthInfo(Any):Not supported yet, use only None - Capabilities(Any):Combination of pythoncom.EOAC_* flags. Must be a subset of the capabilities of the specified authentication service. - -Returns: - - None - - """ - ... - - def CopyProxy(self, Proxy: Any) -> Any: - """ - Makes a private copy of a proxy interface - -Args: - - Proxy(Any):The remote interface to be copied - -Returns: - - Any - - """ - ... - - -class PyIColumnProvider: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Initialize(self, psci: Any) -> None: - """ - Description of Initialize. - -Args: - - psci(Any):Description for psci - -Returns: - - None - - """ - ... - - def GetColumnInfo(self, dwIndex: Any) -> None: - """ - Description of GetColumnInfo. - -Args: - - dwIndex(Any):Description for dwIndex - -Returns: - - None - - """ - ... - - def GetItemData(self, pscid: Any, pscd: Any) -> None: - """ - Description of GetItemData. - -Args: - - pscid(Any):Description for pscid - pscd(Any):Description for pscd - -Returns: - - None - - """ - ... - - -class PyIConnectionPoint: - """A Python wrapper of a COM IConnectionPoint interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetConnectionInterface(self) -> PyIID: - """ - Retrieves the IID of the interface represented by the - -connection point. - -Args: - - - -Returns: - - PyIID - - """ - ... - - def GetConnectionPointContainer(self) -> Any: - """ - Gets the connection point - -container for the object. - -Args: - - - -Returns: - - Any - - """ - ... - - def Advise(self, unk: Any) -> Any: - """ - Establishes a connection between the connection point object and the client's - -sink. - -Args: - - unk(Any):The client's advise sinkReturn ValueThe result is the connection point identifier used by PyIConnectionPoint::Unadvise - -Returns: - - Any:The client's advise sinkReturn ValueThe result is the connection point identifier used by PyIConnectionPoint::Unadvise - - - """ - ... - - def Unadvise(self, cookie: Any) -> None: - """ - Terminates an advisory connection previously established through - -IConnectionPoint::Advise. The dwCookie parameter identifies the connection to terminate. - -Args: - - cookie(Any):The connection token - -Returns: - - None - - """ - ... - - def EnumConnections(self) -> Any: - """ - Creates an enumerator to iterate through the - -connections for the connection point - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIConnectionPointContainer: - """A Python wrapper of a COM IConnectionPointContainer interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def EnumConnectionPoints(self) -> Any: - """ - Creates an enumerator object - -to iterate through all the connection points supported in the connectable object, one connection point per outgoing - -IID. - -Args: - - - -Returns: - - Any - - """ - ... - - def FindConnectionPoint(self, iid: PyIID) -> Any: - """ - Finds a connection point for the - -given IID - -Args: - - iid(PyIID):The IID of the requested connection. - -Returns: - - Any - - """ - ... - - -class PyIContext: - """Allows access to properties defined for the current context (Requires win2k or later)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def SetProperty(self, rpolicyId: PyIID, flags: Any, pUnk: Any) -> None: - """ - Sets a property on the context - -Args: - - rpolicyId(PyIID):GUID identifying the property to be set - flags(Any):Reserved, use only 0 - pUnk(Any):The property value - -Returns: - - None - - """ - ... - - def RemoveProperty(self, rPolicyId: PyIID) -> None: - """ - Removes a property from the context - -Args: - - rPolicyId(PyIID):GUID that identifies a context property - -Returns: - - None - - """ - ... - - def GetProperty(self, rGuid: PyIID) -> tuple[Any, Any]: - """ - Retrieves a context property - -Args: - - rGuid(PyIID):GUID that identifies a context propertyReturn ValueReturns flags (CPFLAGS is reserved, no defined values) and the IUnknown interface set for the property - -Returns: - - tuple[Any, Any]:GUID that identifies a context propertyReturn ValueReturns flags (CPFLAGS is reserved, no defined values) and the IUnknown interface set for the property - - - """ - ... - - def EnumContextProps(self) -> Any: - """ - Returns an enumerator for the context properties - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIContextMenu: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def QueryContextMenu( - self, - hmenu: int, - indexMenu: Any, - idCmdFirst: Any, - idCmdLast: Any, - uFlags: Any) -> Any: - """ - Adds options to a context menu - -Args: - - hmenu(int):Handle to menu to which items should be added - indexMenu(Any):Zero-based index at which to add first item - idCmdFirst(Any):Minimum menu item Id - idCmdLast(Any):Max menu item Id - uFlags(Any):Combination of shellcon.CMF_* flags, can be 0 - -Returns: - - Any - - """ - ... - - def InvokeCommand(self, pici: Any) -> None: - """ - Executes a context menu option - -Args: - - pici(Any):tuple of parameters representing a CMINVOKECOMMANDINFO struct - -Returns: - - None - - """ - ... - - def GetCommandString(self, idCmd: Any, uType: Any, cchMax: Any = 2048) -> Any: - """ - Retrieves verb or help text for a context menu option - -Args: - - idCmd(Any):Id of the command - uType(Any):One of the shellcon.GCS_* constants - cchMax(Any):Size of buffer to create for returned string - -Returns: - - Any - - """ - ... - - -class PyICopyHookA: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CopyCallback( - self, - hwnd: Any, - wFunc: Any, - wFlags: Any, - srcFile: Union[Any, str], - srcAttribs: Any, - destFile: Union[Any, str], - destAttribs: Any) -> None: - """ - Description of CopyCallback. - -Args: - - hwnd(Any):Description for hwnd - wFunc(Any):Description for wFunc - wFlags(Any):Description for wFlags - srcFile(Union[Any, str]):Description for srcFile - srcAttribs(Any):Description for srcAttribs - destFile(Union[Any, str]):Description for destFile - destAttribs(Any):Description for destAttribs - -Returns: - - None - - """ - ... - - -class PyICopyHookW: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CopyCallback( - self, - hwnd: Any, - wFunc: Any, - wFlags: Any, - srcFile: Union[Any, str], - srcAttribs: Any, - destFile: Union[Any, str], - destAttribs: Any) -> None: - """ - Description of CopyCallback. - -Args: - - hwnd(Any):Description for hwnd - wFunc(Any):Description for wFunc - wFlags(Any):Description for wFlags - srcFile(Union[Any, str]):Description for srcFile - srcAttribs(Any):Description for srcAttribs - destFile(Union[Any, str]):Description for destFile - destAttribs(Any):Description for destAttribs - -Returns: - - None - - """ - ... - - -class PyICreateTypeInfo: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def SetGuid(self, guid: PyIID) -> None: - """ - Description of SetGuid. - -Args: - - guid(PyIID):Description for guid - -Returns: - - None - - """ - ... - - def SetTypeFlags(self, uTypeFlags: Any) -> None: - """ - Description of SetTypeFlags. - -Args: - - uTypeFlags(Any):Description for uTypeFlags - -Returns: - - None - - """ - ... - - def SetDocString(self, pStrDoc: Any) -> None: - """ - Description of SetDocString. - -Args: - - pStrDoc(Any):Description for pStrDoc - -Returns: - - None - - """ - ... - - def SetHelpContext(self, dwHelpContext: Any) -> None: - """ - Description of SetHelpContext. - -Args: - - dwHelpContext(Any):Description for dwHelpContext - -Returns: - - None - - """ - ... - - def SetVersion(self, wMajorVerNum: Any, wMinorVerNum: Any) -> None: - """ - Description of SetVersion. - -Args: - - wMajorVerNum(Any):Description for wMajorVerNum - wMinorVerNum(Any):Description for wMinorVerNum - -Returns: - - None - - """ - ... - - def AddRefTypeInfo(self, pTInfo: Any) -> None: - """ - Description of AddRefTypeInfo. - -Args: - - pTInfo(Any):Description for pTInfo - -Returns: - - None - - """ - ... - - def AddFuncDesc(self, index: Any) -> None: - """ - Description of AddFuncDesc. - -Args: - - index(Any):Description for index - -Returns: - - None - - """ - ... - - def AddImplType(self, index: Any, hRefType: Any) -> None: - """ - Description of AddImplType. - -Args: - - index(Any):Description for index - hRefType(Any):A hRefType - -Returns: - - None - - """ - ... - - def SetImplTypeFlags(self, index: Any, implTypeFlags: Any) -> None: - """ - Description of SetImplTypeFlags. - -Args: - - index(Any):Description for index - implTypeFlags(Any):Description for implTypeFlags - -Returns: - - None - - """ - ... - - def SetAlignment(self, cbAlignment: Any) -> None: - """ - Description of SetAlignment. - -Args: - - cbAlignment(Any):Description for cbAlignment - -Returns: - - None - - """ - ... - - def SetSchema(self, pStrSchema: Any) -> None: - """ - Description of SetSchema. - -Args: - - pStrSchema(Any):Description for pStrSchema - -Returns: - - None - - """ - ... - - def AddVarDesc(self, index: Any) -> None: - """ - Description of AddVarDesc. - -Args: - - index(Any):Description for index - -Returns: - - None - - """ - ... - - def SetFuncAndParamNames(self, index: Any, rgszNames: tuple[Any, ...]) -> None: - """ - Description of SetFuncAndParamNames. - -Args: - - index(Any):Index of the item to set. - rgszNames(tuple[Any, ...]):A sequence of unicode or String objects. - -Returns: - - None - - """ - ... - - def SetVarName(self, index: Any, szName: Any) -> None: - """ - Description of SetVarName. - -Args: - - index(Any):Description for index - szName(Any):Description for szName - -Returns: - - None - - """ - ... - - def SetTypeDescAlias(self) -> None: - """ - Description of SetTypeDescAlias. - -Args: - - - -Returns: - - None - - """ - ... - - def DefineFuncAsDllEntry(self, index: Any, szDllName: Any, szProcName: Any) -> None: - """ - Description of DefineFuncAsDllEntry. - -Args: - - index(Any):Description for index - szDllName(Any):Description for szDllName - szProcName(Any):Description for szProcName - -Returns: - - None - - """ - ... - - def SetFuncDocString(self, index: Any, szDocString: Any) -> None: - """ - Description of SetFuncDocString. - -Args: - - index(Any):Description for index - szDocString(Any):Description for szDocString - -Returns: - - None - - """ - ... - - def SetVarDocString(self, index: Any, szDocString: Any) -> None: - """ - Description of SetVarDocString. - -Args: - - index(Any):Description for index - szDocString(Any):Description for szDocString - -Returns: - - None - - """ - ... - - def SetFuncHelpContext(self, index: Any, dwHelpContext: Any) -> None: - """ - Description of SetFuncHelpContext. - -Args: - - index(Any):Description for index - dwHelpContext(Any):Description for dwHelpContext - -Returns: - - None - - """ - ... - - def SetVarHelpContext(self, index: Any, dwHelpContext: Any) -> None: - """ - Description of SetVarHelpContext. - -Args: - - index(Any):Description for index - dwHelpContext(Any):Description for dwHelpContext - -Returns: - - None - - """ - ... - - def SetMops(self, index: Any, bstrMops: Any) -> None: - """ - Description of SetMops. - -Args: - - index(Any):Description for index - bstrMops(Any):Description for bstrMops - -Returns: - - None - - """ - ... - - def LayOut(self) -> None: - """ - Description of LayOut. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyICreateTypeLib: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CreateTypeInfo(self, szName: Any) -> None: - """ - Description of CreateTypeInfo. - -Args: - - szName(Any):Description for szName - -Returns: - - None - - """ - ... - - def SetName(self, szName: Any) -> None: - """ - Description of SetName. - -Args: - - szName(Any):Description for szName - -Returns: - - None - - """ - ... - - def SetVersion(self, wMajorVerNum: Any, wMinorVerNum: Any) -> None: - """ - Description of SetVersion. - -Args: - - wMajorVerNum(Any):Description for wMajorVerNum - wMinorVerNum(Any):Description for wMinorVerNum - -Returns: - - None - - """ - ... - - def SetGuid(self, guid: PyIID) -> None: - """ - Description of SetGuid. - -Args: - - guid(PyIID):Description for guid - -Returns: - - None - - """ - ... - - def SetDocString(self, szDoc: Any) -> None: - """ - Description of SetDocString. - -Args: - - szDoc(Any):Description for szDoc - -Returns: - - None - - """ - ... - - def SetHelpFileName(self, szHelpFileName: Any) -> None: - """ - Description of SetHelpFileName. - -Args: - - szHelpFileName(Any):Description for szHelpFileName - -Returns: - - None - - """ - ... - - def SetHelpContext(self, dwHelpContext: Any) -> None: - """ - Description of SetHelpContext. - -Args: - - dwHelpContext(Any):Description for dwHelpContext - -Returns: - - None - - """ - ... - - def SetLcid(self) -> None: - """ - Description of SetLcid. - -Args: - - - -Returns: - - None - - """ - ... - - def SetLibFlags(self, uLibFlags: Any) -> None: - """ - Description of SetLibFlags. - -Args: - - uLibFlags(Any):Description for uLibFlags - -Returns: - - None - - """ - ... - - def SaveAllChanges(self) -> None: - """ - Description of SaveAllChanges. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyICreateTypeLib2: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CreateTypeInfo(self, szName: Any) -> None: - """ - Description of CreateTypeInfo. - -Args: - - szName(Any):Description for szName - -Returns: - - None - - """ - ... - - def SetName(self, szName: Any) -> None: - """ - Description of SetName. - -Args: - - szName(Any):Description for szName - -Returns: - - None - - """ - ... - - def SetVersion(self, wMajorVerNum: Any, wMinorVerNum: Any) -> None: - """ - Description of SetVersion. - -Args: - - wMajorVerNum(Any):Description for wMajorVerNum - wMinorVerNum(Any):Description for wMinorVerNum - -Returns: - - None - - """ - ... - - def SetGuid(self, guid: PyIID) -> None: - """ - Description of SetGuid. - -Args: - - guid(PyIID):Description for guid - -Returns: - - None - - """ - ... - - def SetDocString(self, szDoc: Any) -> None: - """ - Description of SetDocString. - -Args: - - szDoc(Any):Description for szDoc - -Returns: - - None - - """ - ... - - def SetHelpFileName(self, szHelpFileName: Any) -> None: - """ - Description of SetHelpFileName. - -Args: - - szHelpFileName(Any):Description for szHelpFileName - -Returns: - - None - - """ - ... - - def SetHelpContext(self, dwHelpContext: Any) -> None: - """ - Description of SetHelpContext. - -Args: - - dwHelpContext(Any):Description for dwHelpContext - -Returns: - - None - - """ - ... - - def SetLcid(self) -> None: - """ - Description of SetLcid. - -Args: - - - -Returns: - - None - - """ - ... - - def SetLibFlags(self, uLibFlags: Any) -> None: - """ - Description of SetLibFlags. - -Args: - - uLibFlags(Any):Description for uLibFlags - -Returns: - - None - - """ - ... - - def SaveAllChanges(self) -> None: - """ - Description of SaveAllChanges. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyICurrentItem: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyICustomDestinationList: - """Interface used to customize an application's jump list""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def SetAppID(self, AppID: Any) -> None: - """ - Specifies the taskbar identifier for the jump list - -Args: - - AppID(Any):The taskbar identifier of the applicationCommentsOnly needed if the calling app doesn't use the system-assigned default - -Returns: - - None - - """ - ... - - def BeginList(self, riid: PyIID) -> tuple[Any, Any]: - """ - Clears the jump list and prepares it to be - -repopulated - -Args: - - riid(PyIID):The interface to returnReturn ValueReturns the number of slots and a collection of all destinations removed from the jump list - -Returns: - - tuple[Any, Any]:The interface to return -Return ValueReturns the number of slots and a collection of all destinations removed from the jump list - - - """ - ... - - def AppendCategory(self, Category: Any, Items: Any) -> None: - """ - Adds a custom category to the jump list - -Args: - - Category(Any):Display name of the category, can also be a dll and resource id for localization - Items(Any):Collection of IShellItem and/or IShellLink interfaces - -Returns: - - None - - """ - ... - - def AppendKnownCategory(self, Category: Any) -> None: - """ - Adds one of the predefined categories to the custom list - -Args: - - Category(Any):shellcon.KDC_RECENT or KDC_FREQUENT - -Returns: - - None - - """ - ... - - def AddUserTasks(self, Items: Any) -> None: - """ - Sets the entries shown in the Tasks category - -Args: - - Items(Any):Collection of PyIShellItem and/or PyIShellLink interfaces - -Returns: - - None - - """ - ... - - def CommitList(self) -> None: - """ - Finalizes changes. - -Args: - - - -Returns: - - None - - """ - ... - - def GetRemovedDestinations(self, riid: PyIID) -> Any: - """ - Returns all the items removed from the - -jump list - -Args: - - riid(PyIID):The interface to return - -Returns: - - Any - - """ - ... - - def DeleteList(self, AppID: Any = None) -> None: - """ - Removes any customization, leaving only the system-maintained Recent - -and Frequent lists - -Args: - - AppID(Any):The taskbar identifier of the application - -Returns: - - None - - """ - ... - - def AbortList(self) -> None: - """ - Discards all changes - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIDL: - """A Python representation of an IDL. Implemented as a sequence of Python strings. - -FALSE*/, UINT *pcb /* = NULL */)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIDataObject: - """Used to transfer data in various formats throughout the shell""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetData(self, pformatetcIn: Any) -> Any: - """ - Retrieves data from the object in specified format - -Args: - - pformatetcIn(Any):tuple representing a FORMATETC struct describing how the data should be returned - -Returns: - - Any - - """ - ... - - def GetDataHere(self, pformatetcIn: Any) -> Any: - """ - Retunrs a copy of the object's data in specified format - -Args: - - pformatetcIn(Any):tuple representing a FORMATETC struct describing how the data should be returned - -Returns: - - Any - - """ - ... - - def QueryGetData(self, pformatetc: Any) -> None: - """ - Checks if the objects supports returning data in a particular format. - -Args: - - pformatetc(Any):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. - -Returns: - - 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. - - - """ - ... - - def GetCanonicalFormatEtc(self, pformatectIn: Any) -> Any: - """ - Transforms a FORMATECT data description into a general - -format that the object supports - -Args: - - pformatectIn(Any):tuple representing a FORMATETC struct describing how the data should be returned - -Returns: - - Any - - """ - ... - - def SetData(self, pformatetc: Any, pmedium: Any, fRelease: Any) -> None: - """ - Sets the data that the object will return. - -Args: - - pformatetc(Any):tuple representing a FORMATETC struct describing the type of data to be set - pmedium(Any):The data to be placed in the object - fRelease(Any):If True, transfers ownership of the data to the object. If False, caller is responsible for releasing the STGMEDIUM. - -Returns: - - None - - """ - ... - - def EnumFormatEtc(self, dwDirection: Any) -> Any: - """ - Returns an enumerator to list the data formats that the - -object supports. - -Args: - - dwDirection(Any):Indicates whether to return formats that can be queried or set (pythoncom.DATADIR_GET or DATADIR_SET) - -Returns: - - Any - - """ - ... - - def DAdvise(self, pformatetc: Any, advf: Any, pAdvSink: Any) -> Any: - """ - Connects the object to an interface that will receive notifications when its data - -changes - -Args: - - pformatetc(Any):Defines the type of data for which the sink will receive notifications. - advf(Any):Combination of values from ADVF enum. (which currently do not appear in any of the constants modules!) - pAdvSink(Any):Currently this interface is not wrapped.Return ValueReturns a unique number that is used to identify the connection - -Returns: - - Any:Currently this interface is not wrapped.Return ValueReturns a unique number that is used to identify the connection - - - """ - ... - - def DUnadvise(self, dwConnection: Any) -> None: - """ - Disconnects a notification sink. - -Args: - - dwConnection(Any):Identifier of the connection as returned by DAdvise. - -Returns: - - None - - """ - ... - - def EnumDAdvise(self) -> Any: - """ - Creates an enumerator to list connected notification sinks. - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIDebugApplication: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def SetName(self, pstrName: Any) -> None: - """ - Sets the name of the application. - -Args: - - pstrName(Any):The name of the application.CommentsThe provided name will be returned in subsequent calls to >om PyIRemoteDebugApplication.GetName>. - -Returns: - - None - - """ - ... - - def StepOutComplete(self) -> None: - """ - Called by language engines, in single step mode, just before they - -return to their caller. - -Args: - - - -Returns: - - None - - """ - ... - - def DebugOutput(self, pstr: Any) -> None: - """ - Causes the given string to be displayed by the debugger IDE, normally in - -an output window. - -Args: - - pstr(Any):Description for pstrCommentsThis mechanism provides the means for a language engine to implement language specific debugging output support. Example: Debug.writeln("Help") in JavaScript. - -Returns: - - None - - """ - ... - - def StartDebugSession(self) -> None: - """ - Causes a default debugger IDE to be started and a debug session to - -be attached to this application if one does not already exist. - -Args: - - - -Returns: - - None - - """ - ... - - def HandleBreakPoint(self, br: Any) -> Any: - """ - Called by the language engine in the context of a thread that has - -hit a breakpoint. - -Args: - - br(Any):Break reason - one of the BREAKREASON_* constants.CommentsThis 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 method returns with the action to be taken.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. - -Returns: - - Any:Break reason - one of the BREAKREASON_* constants.Comments - -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 - -method returns with the action to be taken. - -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. - - - """ - ... - - def Close(self) -> None: - """ - Causes this application to release all references and enter a zombie state. - -Args: - - - -Returns: - - None - - """ - ... - - def GetBreakFlags(self) -> Any: - """ - Returns the current break flags for the application. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetCurrentThread(self) -> Any: - """ - Returns the application thread object - -associated with the currently running thread. - -Args: - - - -Returns: - - Any - - """ - ... - - def CreateAsyncDebugOperation(self, psdo: Any) -> None: - """ - None - -Args: - - psdo(Any):Description for psdoCommentsThis provides a mechanism for language engines to implement asynchronous expression and evaluation, etc. without having to know the details of synchronization with the debugger thread. See the descriptions for PyIDebugSyncOperation and PyIDebugAsyncOperation for more details. - -Returns: - - None - - """ - ... - - def AddStackFrameSniffer(self, pdsfs: Any) -> Any: - """ - Adds a stack frame sniffer to this application. - -Args: - - pdsfs(Any):Description for pdsfsCommentsGenerally called by a language engine 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 - -Returns: - - Any:Description for pdsfsComments - -Generally called by a language engine - -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 - - - """ - ... - - def RemoveStackFrameSniffer(self, dwCookie: Any) -> None: - """ - Removes a stack frame sniffer from this application. - -Args: - - dwCookie(Any):A cookie obtained from PyIDebugApplication::AddStackFrameSniffer - -Returns: - - None - - """ - ... - - def QueryCurrentThreadIsDebuggerThread(self) -> None: - """ - Determines if the current running thread is the - -debugger thread. - -Args: - - - -Returns: - - None:PyIDebugApplication.QueryCurrentThreadIsDebuggerThread -QueryCurrentThreadIsDebuggerThread()Determines 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. - - - """ - ... - - def SynchronousCallInDebuggerThread(self, pptc: Any, dwParam1: Any, dwParam2: Any, dwParam3: Any) -> None: - """ - Provides a mechanism for the caller to run code in the - -debugger thread. - -Args: - - pptc(Any):Description for pptc - dwParam1(Any):Description for dwParam1 - dwParam2(Any):Description for dwParam2 - dwParam3(Any):Description for dwParam3CommentsThis is generally used so that language engines and hosts can implement free threaded objects on top of their single threaded implementations. - -Returns: - - None - - """ - ... - - def CreateApplicationNode(self) -> Any: - """ - Creates a new application node which - -is associated with a specific document provider. - -Args: - - - -Returns: - - Any - - """ - ... - - def FireDebuggerEvent(self, guid: Any, unknown: Any) -> None: - """ - Fire a generic event to the IApplicationDebugger (if any) - -Args: - - guid(Any):A GUID. - unknown(Any):An unknown object. - -Returns: - - None - - """ - ... - - def HandleRuntimeError(self, pErrorDebug: Any, pScriptSite: Any) -> None: - """ - Description of HandleRuntimeError. - -Args: - - pErrorDebug(Any):Description for pErrorDebug - pScriptSite(Any):Description for pScriptSite - -Returns: - - None - - """ - ... - - def FCanJitDebug(self) -> None: - """ - Description of FCanJitDebug. - -Args: - - - -Returns: - - None - - """ - ... - - def FIsAutoJitDebugEnabled(self) -> None: - """ - Description of FIsAutoJitDebugEnabled. - -Args: - - - -Returns: - - None - - """ - ... - - def AddGlobalExpressionContextProvider(self, pdsfs: Any) -> None: - """ - Description of AddGlobalExpressionContextProvider. - -Args: - - pdsfs(Any):Description for pdsfs - -Returns: - - None - - """ - ... - - def RemoveGlobalExpressionContextProvider(self, dwCookie: Any) -> None: - """ - Description of - -RemoveGlobalExpressionContextProvider. - -Args: - - dwCookie(Any):Description for dwCookie - -Returns: - - None - - """ - ... - - -class PyIDebugApplicationNode: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def EnumChildren(self) -> None: - """ - Description of EnumChildren. - -Args: - - - -Returns: - - None - - """ - ... - - def GetParent(self) -> Any: - """ - Returns the parent node. - -Args: - - - -Returns: - - Any - - """ - ... - - def SetDocumentProvider(self, pddp: Any) -> None: - """ - Description of SetDocumentProvider. - -Args: - - pddp(Any):Description for pddp - -Returns: - - None - - """ - ... - - def Close(self) -> None: - """ - Description of Close. - -Args: - - - -Returns: - - None - - """ - ... - - def Attach(self, pdanParent: Any) -> None: - """ - Attach a node to its parent. - -Args: - - pdanParent(Any):The parent node. None is not acceptable. - -Returns: - - None - - """ - ... - - def Detach(self) -> None: - """ - Detach a node from its parent. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIDebugApplicationNodeEvents: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def onAddChild(self, prddpChild: Any) -> None: - """ - Description of onAddChild. - -Args: - - prddpChild(Any):Description for prddpChild - -Returns: - - None - - """ - ... - - def onRemoveChild(self, prddpChild: Any) -> None: - """ - Description of onRemoveChild. - -Args: - - prddpChild(Any):Description for prddpChild - -Returns: - - None - - """ - ... - - def onDetach(self) -> None: - """ - Description of onDetach. - -Args: - - - -Returns: - - None - - """ - ... - - def onAttach(self, prddpParent: Any) -> None: - """ - Description of onAttach. - -Args: - - prddpParent(Any):Description for prddpParent - -Returns: - - None - - """ - ... - - -class PyIDebugApplicationThread: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def SynchronousCallIntoThread(self, pstcb: Any, dwParam1: Any, dwParam2: Any, dwParam3: Any) -> None: - """ - Description of SynchronousCallIntoThread. - -Args: - - pstcb(Any):Description for pstcb - dwParam1(Any):Description for dwParam1 - dwParam2(Any):Description for dwParam2 - dwParam3(Any):Description for dwParam3 - -Returns: - - None - - """ - ... - - def QueryIsCurrentThread(self) -> None: - """ - Description of QueryIsCurrentThread. - -Args: - - - -Returns: - - None - - """ - ... - - def QueryIsDebuggerThread(self) -> None: - """ - Description of QueryIsDebuggerThread. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIDebugCodeContext: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetDocumentContext(self) -> None: - """ - Description of GetDocumentContext. - -Args: - - - -Returns: - - None - - """ - ... - - def SetBreakPoint(self, bps: Any) -> None: - """ - Description of SetBreakPoint. - -Args: - - bps(Any):Description for bps - -Returns: - - None - - """ - ... - - -class PyIDebugDocument: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIDebugDocumentContext: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetDocument(self) -> None: - """ - Description of GetDocument. - -Args: - - - -Returns: - - None - - """ - ... - - def EnumCodeContexts(self) -> None: - """ - Description of EnumCodeContexts. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIDebugDocumentHelper: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Init(self, pda: Any, pszShortName: Any, pszLongName: Any, docAttr: Any) -> None: - """ - Description of Init. - -Args: - - pda(Any):Description for pda - pszShortName(Any):Description for pszShortName - pszLongName(Any):Description for pszLongName - docAttr(Any):Description for docAttr - -Returns: - - None - - """ - ... - - def Attach(self, pddhParent: Any) -> None: - """ - Add the document to the doc tree - -Args: - - pddhParent(Any):Parent item. If none, this item is top level. - -Returns: - - None - - """ - ... - - def Detach(self) -> None: - """ - Description of Detach. - -Args: - - - -Returns: - - None - - """ - ... - - def AddUnicodeText(self, pszText: Any) -> None: - """ - Description of AddUnicodeText. - -Args: - - pszText(Any):Description for pszText - -Returns: - - None - - """ - ... - - def AddDBCSText(self) -> None: - """ - Description of AddDBCSText. - -Args: - - - -Returns: - - None - - """ - ... - - def SetDebugDocumentHost(self, pddh: Any) -> None: - """ - Description of SetDebugDocumentHost. - -Args: - - pddh(Any):Description for pddh - -Returns: - - None - - """ - ... - - def AddDeferredText(self, cChars: Any, dwTextStartCookie: Any) -> None: - """ - Description of AddDeferredText. - -Args: - - cChars(Any):Description for cChars - dwTextStartCookie(Any):Description for dwTextStartCookie - -Returns: - - None - - """ - ... - - def DefineScriptBlock(self, ulCharOffset: Any, cChars: Any, pas: Any, fScriptlet: Any) -> None: - """ - Description of DefineScriptBlock. - -Args: - - ulCharOffset(Any):Description for ulCharOffset - cChars(Any):Description for cChars - pas(Any):Description for pas - fScriptlet(Any):Description for fScriptlet - -Returns: - - None - - """ - ... - - def SetDefaultTextAttr(self, staTextAttr: Any) -> None: - """ - Description of SetDefaultTextAttr. - -Args: - - staTextAttr(Any):Description for staTextAttr - -Returns: - - None - - """ - ... - - def SetTextAttributes(self, ulCharOffset: Any, obAttr: Any) -> None: - """ - Description of SetTextAttributes. - -Args: - - ulCharOffset(Any):Description for ulCharOffset - obAttr(Any):A sequence of attributes. - -Returns: - - None - - """ - ... - - def SetLongName(self, pszLongName: Any) -> None: - """ - Description of SetLongName. - -Args: - - pszLongName(Any):Description for pszLongName - -Returns: - - None - - """ - ... - - def SetShortName(self, pszShortName: Any) -> None: - """ - Description of SetShortName. - -Args: - - pszShortName(Any):Description for pszShortName - -Returns: - - None - - """ - ... - - def SetDocumentAttr(self, pszAttributes: Any) -> None: - """ - Description of SetDocumentAttr. - -Args: - - pszAttributes(Any):Description for pszAttributes - -Returns: - - None - - """ - ... - - def GetDebugApplicationNode(self) -> None: - """ - Description of GetDebugApplicationNode. - -Args: - - - -Returns: - - None - - """ - ... - - def GetScriptBlockInfo(self, dwSourceContext: Any) -> None: - """ - Description of GetScriptBlockInfo. - -Args: - - dwSourceContext(Any):Description for dwSourceContext - -Returns: - - None - - """ - ... - - def CreateDebugDocumentContext(self, iCharPos: Any, cChars: Any) -> None: - """ - Description of CreateDebugDocumentContext. - -Args: - - iCharPos(Any):Description for iCharPos - cChars(Any):Description for cChars - -Returns: - - None - - """ - ... - - def BringDocumentToTop(self) -> None: - """ - Description of BringDocumentToTop. - -Args: - - - -Returns: - - None - - """ - ... - - def BringDocumentContextToTop(self, pddc: Any) -> None: - """ - Description of BringDocumentContextToTop. - -Args: - - pddc(Any):Description for pddc - -Returns: - - None - - """ - ... - - -class PyIDebugDocumentHost: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetDeferredText(self, dwTextStartCookie: Any, cMaxChars: Any) -> None: - """ - Description of GetDeferredText. - -Args: - - dwTextStartCookie(Any):Description for dwTextStartCookie - cMaxChars(Any):Description for cMaxChars - -Returns: - - None - - """ - ... - - def GetScriptTextAttributes(self, pstrCode: Any, pstrDelimiter: Any, dwFlags: Any) -> None: - """ - Description of GetScriptTextAttributes. - -Args: - - pstrCode(Any):Description for pstrCode - pstrDelimiter(Any):Description for pstrDelimiter - dwFlags(Any):Description for dwFlags - -Returns: - - None - - """ - ... - - def OnCreateDocumentContext(self) -> None: - """ - Description of OnCreateDocumentContext. - -Args: - - - -Returns: - - None - - """ - ... - - def GetPathName(self) -> None: - """ - Description of GetPathName. - -Args: - - - -Returns: - - None - - """ - ... - - def GetFileName(self) -> None: - """ - Description of GetFileName. - -Args: - - - -Returns: - - None - - """ - ... - - def NotifyChanged(self) -> None: - """ - Description of NotifyChanged. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIDebugDocumentInfo: - """Provides information on a document, which may or may not be instantiated.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetName(self) -> None: - """ - Returns the specified name for the document. - -Args: - - - -Returns: - - None - - """ - ... - - def GetDocumentClassId(self) -> PyIID: - """ - Returns a CLSID describing the document type. - -Args: - - - -Returns: - - PyIID - - """ - ... - - -class PyIDebugDocumentProvider: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetDocument(self) -> Any: - """ - Causes the document to be instantiated if it does - -not already exist. - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIDebugDocumentText: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetDocumentAttributes(self) -> None: - """ - Description of GetDocumentAttributes. - -Args: - - - -Returns: - - None - - """ - ... - - def GetSize(self) -> None: - """ - Description of GetSize. - -Args: - - - -Returns: - - None - - """ - ... - - def GetPositionOfLine(self, cLineNumber: Any) -> None: - """ - Description of GetPositionOfLine. - -Args: - - cLineNumber(Any):Description for cLineNumber - -Returns: - - None - - """ - ... - - def GetLineOfPosition(self, cCharacterPosition: Any) -> None: - """ - Description of GetLineOfPosition. - -Args: - - cCharacterPosition(Any):Description for cCharacterPosition - -Returns: - - None - - """ - ... - - def GetText(self, cCharacterPosition: Any, cMaxChars: Any, bWantAttr: Any = 1) -> None: - """ - Description of GetText. - -Args: - - cCharacterPosition(Any): - cMaxChars(Any):Max chars to return - bWantAttr(Any):Should the attributes be returned? - -Returns: - - None - - """ - ... - - def GetPositionOfContext(self, psc: Any) -> None: - """ - Description of GetPositionOfContext. - -Args: - - psc(Any):Description for psc - -Returns: - - None - - """ - ... - - def GetContextOfPosition(self, cCharacterPosition: Any, cNumChars: Any) -> None: - """ - Description of GetContextOfPosition. - -Args: - - cCharacterPosition(Any):Description for cCharacterPosition - cNumChars(Any):Description for cNumChars - -Returns: - - None - - """ - ... - - -class PyIDebugDocumentTextAuthor: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def InsertText(self, cCharacterPosition: Any, cNumToInsert: Any, pcharText: Any) -> None: - """ - Description of InsertText. - -Args: - - cCharacterPosition(Any):Description for cCharacterPosition - cNumToInsert(Any):Description for cNumToInsert - pcharText(Any):Description for pcharText - -Returns: - - None - - """ - ... - - def RemoveText(self, cCharacterPosition: Any, cNumToRemove: Any) -> None: - """ - Description of RemoveText. - -Args: - - cCharacterPosition(Any):Description for cCharacterPosition - cNumToRemove(Any):Description for cNumToRemove - -Returns: - - None - - """ - ... - - def ReplaceText(self, cCharacterPosition: Any, cNumToReplace: Any, pcharText: Any) -> None: - """ - Description of ReplaceText. - -Args: - - cCharacterPosition(Any):Description for cCharacterPosition - cNumToReplace(Any):Description for cNumToReplace - pcharText(Any):Description for pcharText - -Returns: - - None - - """ - ... - - -class PyIDebugDocumentTextEvents: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def onDestroy(self) -> None: - """ - Description of onDestroy. - -Args: - - - -Returns: - - None - - """ - ... - - def onInsertText(self, cCharacterPosition: Any, cNumToInsert: Any) -> None: - """ - Description of onInsertText. - -Args: - - cCharacterPosition(Any):Description for cCharacterPosition - cNumToInsert(Any):Description for cNumToInsert - -Returns: - - None - - """ - ... - - def onRemoveText(self, cCharacterPosition: Any, cNumToRemove: Any) -> None: - """ - Description of onRemoveText. - -Args: - - cCharacterPosition(Any):Description for cCharacterPosition - cNumToRemove(Any):Description for cNumToRemove - -Returns: - - None - - """ - ... - - def onReplaceText(self, cCharacterPosition: Any, cNumToReplace: Any) -> None: - """ - Description of onReplaceText. - -Args: - - cCharacterPosition(Any):Description for cCharacterPosition - cNumToReplace(Any):Description for cNumToReplace - -Returns: - - None - - """ - ... - - def onUpdateTextAttributes(self, cCharacterPosition: Any, cNumToUpdate: Any) -> None: - """ - Description of onUpdateTextAttributes. - -Args: - - cCharacterPosition(Any):Description for cCharacterPosition - cNumToUpdate(Any):Description for cNumToUpdate - -Returns: - - None - - """ - ... - - def onUpdateDocumentAttributes(self, textdocattr: Any) -> None: - """ - Description of onUpdateDocumentAttributes. - -Args: - - textdocattr(Any):Description for textdocattr - -Returns: - - None - - """ - ... - - -class PyIDebugDocumentTextExternalAuthor: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetPathName(self) -> None: - """ - Description of GetPathName. - -Args: - - - -Returns: - - None - - """ - ... - - def GetFileName(self) -> None: - """ - Description of GetFileName. - -Args: - - - -Returns: - - None - - """ - ... - - def NotifyChanged(self) -> None: - """ - Description of NotifyChanged. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIDebugExpression: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Start(self, pdecb: Any) -> None: - """ - Description of Start. - -Args: - - pdecb(Any):Description for pdecb - -Returns: - - None - - """ - ... - - def Abort(self) -> None: - """ - Description of Abort. - -Args: - - - -Returns: - - None - - """ - ... - - def QueryIsComplete(self) -> None: - """ - Description of QueryIsComplete. - -Args: - - - -Returns: - - None - - """ - ... - - def GetResultAsString(self) -> None: - """ - Description of GetResultAsString. - -Args: - - - -Returns: - - None - - """ - ... - - def GetResultAsDebugProperties(self) -> None: - """ - Description of GetResultAsDebugProperty. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIDebugExpressionCallBack: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def onComplete(self) -> None: - """ - Description of onComplete. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIDebugExpressionContext: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def ParseLanguageText(self, pstrCode: Any, nRadix: Any, pstrDelimiter: Any, dwFlags: Any) -> None: - """ - Description of ParseLanguageText. - -Args: - - pstrCode(Any):Description for pstrCode - nRadix(Any):Description for nRadix - pstrDelimiter(Any):Description for pstrDelimiter - dwFlags(Any):Description for dwFlags - -Returns: - - None - - """ - ... - - def GetLanguageInfo(self) -> None: - """ - Description of GetLanguageInfo. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIDebugProperty: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetPropertyInfo(self, dwFieldSpec: Any, nRadix: Any) -> None: - """ - Description of GetPropertyInfo. - -Args: - - dwFieldSpec(Any):Description for dwFieldSpec - nRadix(Any):Description for nRadix - -Returns: - - None - - """ - ... - - def GetExtendedInfo(self) -> None: - """ - Description of GetExtendedInfo. - -Args: - - - -Returns: - - None - - """ - ... - - def SetValueAsString(self, pszValue: Any, nRadix: Any) -> None: - """ - Description of SetValueAsString. - -Args: - - pszValue(Any):Description for pszValue - nRadix(Any):Description for nRadix - -Returns: - - None - - """ - ... - - def EnumMembers(self, dwFieldSpec: Any, nRadix: Any, refiid: PyIID) -> None: - """ - Description of EnumMembers. - -Args: - - dwFieldSpec(Any):Description for dwFieldSpec - nRadix(Any):Description for nRadix - refiid(PyIID):Description for refiid - -Returns: - - None - - """ - ... - - def GetParent(self) -> None: - """ - Description of GetParent. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIDebugSessionProvider: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def StartDebugSession(self, pda: Any) -> None: - """ - Description of StartDebugSession. - -Args: - - pda(Any):Description for pda - -Returns: - - None - - """ - ... - - -class PyIDebugStackFrame: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetCodeContext(self) -> None: - """ - Returns the current code context associated with the stack frame. - -Args: - - - -Returns: - - None - - """ - ... - - def GetDescriptionString(self, fLong: Any) -> Any: - """ - Returns a short or long textual description of the - -stack frame. - -Args: - - fLong(Any):If false, provide only the name of the function associated with the stack frame. When true it may also provide the parameter(s) to the function or whatever else is relevant. - -Returns: - - Any - - """ - ... - - def GetLanguageString(self, fLong: Any) -> Any: - """ - Returns a short or long textual description of the - -language. - -Args: - - fLong(Any):If False, just the language name should be provided, eg, "Python". If True a full product description may be provided (eg, "Python 1.4 ActiveX Debugging Host") - -Returns: - - Any - - """ - ... - - def GetThread(self) -> Any: - """ - Returns the thread associated with this stack - -frame. - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIDebugStackFrameSniffer: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def EnumStackFrames(self) -> None: - """ - Description of EnumStackFrames. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIDebugStackFrameSnifferEx: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def EnumStackFramesEx(self) -> None: - """ - Description of EnumStackFrames. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIDebugSyncOperation: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetTargetThread(self) -> None: - """ - Description of GetTargetThread. - -Args: - - - -Returns: - - None - - """ - ... - - def Execute(self) -> None: - """ - Description of Execute. - -Args: - - - -Returns: - - None - - """ - ... - - def InProgressAbort(self) -> None: - """ - Description of InProgressAbort. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIDefaultExtractIconInit: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def SetFlags(self, uFlags: Any) -> None: - """ - Description of SetFlags. - -Args: - - uFlags(Any):Description for uFlags - -Returns: - - None - - """ - ... - - def SetKey(self, hkey: PyHKEY) -> None: - """ - Description of SetKey. - -Args: - - hkey(PyHKEY):Description for hkey - -Returns: - - None - - """ - ... - - def SetNormalIcon(self, pszFile: Any, iIcon: Any) -> None: - """ - Description of SetNormalIcon. - -Args: - - pszFile(Any):Description for pszFile - iIcon(Any):Description for iIcon - -Returns: - - None - - """ - ... - - def SetOpenIcon(self, pszFile: Any, iIcon: Any) -> None: - """ - Description of SetOpenIcon. - -Args: - - pszFile(Any):Description for pszFile - iIcon(Any):Description for iIcon - -Returns: - - None - - """ - ... - - def SetShortcutIcon(self, pszFile: Any, iIcon: Any) -> None: - """ - Description of SetShortcutIcon. - -Args: - - pszFile(Any):Description for pszFile - iIcon(Any):Description for iIcon - -Returns: - - None - - """ - ... - - def SetDefaultIcon(self, pszFile: Any, iIcon: Any) -> None: - """ - Description of SetDefaultIcon. - -Args: - - pszFile(Any):Description for pszFile - iIcon(Any):Description for iIcon - -Returns: - - None - - """ - ... - - -class PyIDirectSound: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Initialize(self, guid: PyIID) -> None: - """ - Description of Initialize. - -Args: - - guid(PyIID):Globally unique identifier (GUID) specifying the sound driver to which this DirectSound object binds. ... None to select the primary sound driver. - -Returns: - - None - - """ - ... - - def SetCooperativeLevel(self, hwnd: Any, level: Any) -> None: - """ - The IDirectSound::SetCooperativeLevel method sets the cooperative level - -of the application for this sound device. - -Args: - - hwnd(Any):Window handle to the application or None. - level(Any):Requested priority level. Specify one of the following values:LevelDescriptionDSSCL_NORMALSets the application to a fully cooperative status. Most applications should use this level, because it has the smoothest multitasking and resource-sharing behavior.DSSCL_PRIORITYSets the application to the priority level. Applications with this cooperative level can call the DirectSoundBuffer.setFormat and DirectSound.compact methods.DSSCL_EXCLUSIVESets the application to the exclusive level. When it has the input focus, the application will be the only one audible (sounds from applications with the DSBCAPS_GLOBALFOCUS flag set will be muted). With this level, it also has all the privileges of the DSSCL_PRIORITY level. DirectSound will restore the hardware format, as specified by the most recent call to the DirectSoundBuffer.setFormat method, once the application gains the input focus. (Note that DirectSound will always restore the wave format, no matter what priority level is set.)DSSCL_WRITEPRIMARYThis is the highest priority level. The application has write access to the primary sound buffers. No secondary sound buffers in any application can be played. - -Returns: - - None - - """ - ... - - def CreateSoundBuffer(self, lpDSCBufferDesc: Any, unk: Any = None) -> None: - """ - The IDirectSound::CreateSoundBuffer method creates a DirectSoundBuffer - -object to hold a sequence of audio samples. - -Args: - - lpDSCBufferDesc(Any):a DSBUFFERDESC structure containing values for the sound buffer being created. - unk(Any):The IUnknown for COM aggregation. - -Returns: - - None - - """ - ... - - def GetCaps(self) -> None: - """ - None - -Args: - - - -Returns: - - None - - """ - ... - - def Compact(self) -> None: - """ - 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. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIDirectSoundBuffer: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Initialize(self) -> None: - """ - Description of Initialize. - -Args: - - - -Returns: - - None - - """ - ... - - def GetStatus(self) -> None: - """ - Retrieves the current status of the sound buffer. - -Args: - - - -Returns: - - None - - """ - ... - - def GetCaps(self) -> None: - """ - Retrieves the capabilities of the DirectSoundBuffer object as a DSBCAPS - -object. - -Args: - - - -Returns: - - None - - """ - ... - - def Restore(self) -> None: - """ - Restores the memory allocation for a lost sound buffer for the specified - -DirectSoundBuffer object. - -Args: - - - -Returns: - - None - - """ - ... - - def GetCurrentPosition(self) -> None: - """ - Description of GetCurrentPosition. - -Args: - - - -Returns: - - None - - """ - ... - - def Play(self) -> None: - """ - Description of Play. - -Args: - - - -Returns: - - None - - """ - ... - - def SetCurrentPosition(self) -> None: - """ - Description of SetCurrentPosition. - -Args: - - - -Returns: - - None - - """ - ... - - def Stop(self) -> None: - """ - Description of Stop. - -Args: - - - -Returns: - - None - - """ - ... - - def GetFrequency(self) -> None: - """ - Description of GetFrequency. - -Args: - - - -Returns: - - None - - """ - ... - - def GetPan(self) -> None: - """ - Description of GetPan. - -Args: - - - -Returns: - - None - - """ - ... - - def GetVolume(self) -> None: - """ - Description of GetVolume. - -Args: - - - -Returns: - - None - - """ - ... - - def SetFrequency(self) -> None: - """ - Description of SetFrequency. - -Args: - - - -Returns: - - None - - """ - ... - - def SetPan(self) -> None: - """ - Description of SetPan. - -Args: - - - -Returns: - - None - - """ - ... - - def SetVolume(self) -> None: - """ - Description of SetVolume. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIDirectSoundCapture: - """The methods of the IDirectSoundCapture interface are used to create sound capture - -buffers.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Initialize(self) -> None: - """ - Not normally called directly. Use DirectSoundCaptureCreate instead. - -Args: - - - -Returns: - - None - - """ - ... - - def GetCaps(self) -> None: - """ - None - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIDirectSoundCaptureBuffer: - """The methods of the IDirectSoundCaptureBuffer interface are used to manipulate - -sound capture buffers.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Initialize(self) -> None: - """ - Not normally used. Used IDirectSoundCapture.CreateCaptureBuffer - -instead. - -Args: - - - -Returns: - - None - - """ - ... - - def GetStatus(self) -> None: - """ - Retrieves the current status of the sound capture buffer. - -Args: - - - -Returns: - - None - - """ - ... - - def GetCurrentPosition(self) -> None: - """ - 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 - -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. - -Args: - - - -Returns: - - None - - """ - ... - - def Stop(self) -> None: - """ - 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 - -effect. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIDirectSoundNotify: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIDirectoryObject: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetObjectInformation(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def GetObjectAttributes(self, names: tuple[str, ...]) -> tuple[Any, ...]: - """ - None - -Args: - - names(tuple[str, ...]): - -Returns: - - tuple[Any, ...] - - """ - ... - - def SetObjectAttributes(self, attrs: tuple[Any, ...]) -> Any: - """ - None - -Args: - - attrs(tuple[Any, ...]):The attributes to set - -Returns: - - Any - - """ - ... - - def CreateDSObject(self, rdn: str, attrs: tuple[Any, ...]) -> Any: - """ - None - -Args: - - rdn(str):The relative distinguished name (relative path) of the object to be created. - attrs(tuple[Any, ...]):The attributes to set. - -Returns: - - Any - - """ - ... - - def DeleteDSObject(self, rdn: str) -> None: - """ - Deletes a leaf object in a directory tree - -Args: - - rdn(str):The relative distinguished name (relative path) of the object to be deleted. - -Returns: - - None - - """ - ... - - -class PyIDirectorySearch: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def SetSearchPreference(self, prefs: Any) -> tuple[Any, Any, Any]: - """ - None - -Args: - - prefs(Any):Return ValueThe result is the hresult of the call, and a list of integer status codes for each of the preferences set. - -Returns: - - tuple[Any, Any, Any]:Return ValueThe result is the hresult of the call, and a list of integer status - -codes for each of the preferences set. - - - """ - ... - - def ExecuteSearch(self, _filter: str, attrNames: list[str]) -> Any: - """ - None - -Args: - - _filter(str): - attrNames(list[str]):Return ValueThe result is an integer search handle. PyIDirectorySearch::CloseSearchHandle should be called to close the handle. - -Returns: - - Any:Return ValueThe result is an integer search handle. PyIDirectorySearch::CloseSearchHandle - -should be called to close the handle. - - - """ - ... - - def GetNextRow(self, handle: Any) -> Any: - """ - None - -Args: - - handle(Any):Return ValueThe result is the HRESULT from the call - no exceptions are thrown - -Returns: - - Any:Return ValueThe result is the HRESULT from the call - no exceptions are thrown - - - """ - ... - - def GetFirstRow(self, handle: Any) -> Any: - """ - None - -Args: - - handle(Any):Return ValueThe result is the HRESULT from the call - no exceptions are thrown - -Returns: - - Any:Return ValueThe result is the HRESULT from the call - no exceptions are thrown - - - """ - ... - - def GetPreviousRow(self, handle: Any) -> Any: - """ - None - -Args: - - handle(Any):Return ValueThe result is the HRESULT from the call - no exceptions are thrown - -Returns: - - Any:Return ValueThe result is the HRESULT from the call - no exceptions are thrown - - - """ - ... - - def CloseSearchHandle(self, handle: Any) -> None: - """ - Closes a previously opened search handle. - -Args: - - handle(Any): - -Returns: - - None - - """ - ... - - def AdandonSearch(self, handle: Any) -> None: - """ - None - -Args: - - handle(Any): - -Returns: - - None - - """ - ... - - def GetColumn(self, handle: Any, name: str) -> tuple[Any, Any, Any]: - """ - None - -Args: - - handle(Any):Handle to a search - name(str):The column name to fetch - -Returns: - - tuple[Any, Any, Any] - - """ - ... - - def GetNextColumnName(self) -> None: - """ - None - -Args: - - - -Returns: - - None:PyIDirectorySearch.GetNextColumnName -GetNextColumnName() -Return ValueReturns None when the underlying ADSI function return S_ADS_NOMORE_COLUMNS. - - - """ - ... - - -class PyIDispatch: - """A OLE automation client object.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Invoke(self, dispid: Any, lcid: Any, flags: Any, bResultWanted: Any, arg: tuple[Any, ...]) -> Any: - """ - Invokes a DISPID, using the passed arguments. - -Args: - - dispid(Any):The dispid to use. Typically this value will come from PyIDispatch::GetIDsOfNames or from a type library. - lcid(Any):The locale id to use. - flags(Any):The flags for the call. The following flags can be used.FlagDescriptionDISPATCH_METHODThe member is invoked as a method. If a property has the same name, both this and the DISPATCH_PROPERTYGET flag may be set.DISPATCH_PROPERTYGETThe member is retrieved as a property or data member.DISPATCH_PROPERTYPUTThe member is changed as a property or data member.DISPATCH_PROPERTYPUTREFThe member is changed by a reference assignment, rather than a value assignment. This flag is valid only when the property accepts a reference to an object. - bResultWanted(Any):Indicates if the result of the call should be requested. - arg(tuple[Any, ...]):The parameters to ....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) - -Returns: - - Any:The parameters to ....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) - - - """ - ... - - def InvokeTypes( - self, - dispid: Any, - lcid: Any, - wFlags: Any, - resultTypeDesc: Any, - typeDescs: tuple[Any, ...], - args: tuple[Any, ...]) -> Any: - """ - Invokes a DISPID, using the passed arguments and type descriptions. - -Args: - - dispid(Any):The dispid to use. Please see PyIDispatch::Invoke. - lcid(Any):The locale ID. Please see PyIDispatch::Invoke. - wFlags(Any):Flags for the call. Please see PyIDispatch::Invoke. - resultTypeDesc(Any):A tuple describing the type of the result. See the comments for more information. - typeDescs(tuple[Any, ...]):A sequence of tuples describing the types of the parameters for the function. See the comments for more information. - args(tuple[Any, ...]):The args to the function.CommentsThe Microsoft documentation for IDispatch should be used for all params except 'resultTypeDesc' and 'typeDescs'. 'resultTypeDesc' describes the return value of the function, and is a tuple of (type_id, flags). 'typeDescs' describes the type of each parameters, and is a list of the same (type_id, flags) tuple.itemDescriptiontype_idA valid "variant type" constant (eg, VT_I4 | VT_ARRAY, VT_DATE, etc - see VARIANT at MSDN).flagsOne of the PARAMFLAG constants (eg, PARAMFLAG_FIN, PARAMFLAG_FOUT etc - see PARAMFLAG at MSDN).ExampleAn example from the makepy generated file for Wordclass Cells(DispatchBaseClass):... def SetWidth(self, ColumnWidth=..., RulerStyle=...): return self._oleobj_.InvokeTypes(202, LCID, 1, (24, 0), ((4, 1), (3, 1)),...)The interesting bits areresultTypeDesc: (24, 0) - (VT_VOID, <no flags>)typeDescs: ((4, 1), (3, 1)) - ((VT_R4, PARAMFLAG_FIN), (VT_I4, PARAMFLAG_FIN))So, in this example, the function returns no value and takes 2 "in" params - ColumnWidth is a float, and RulerStule is an int. - -Returns: - - Any - - """ - ... - - def GetIDsOfNames(self, name: str, arg: Any) -> tuple[Any, Any]: - """ - Get the DISPID for the passed names. - -Args: - - name(str):A name to query forAlternative Parameters - arg(Any):A sequence of string names to queryCommentsCurrently 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 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. - -Returns: - - tuple[Any, Any]:A sequence of string names to query -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 - -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. - - - """ - ... - - def GetTypeInfo(self, locale: Any, index: Any = 0) -> Any: - """ - Get type information for the object. - -Args: - - locale(Any):The locale to use. - index(Any):The index of the typelibrary to fetch. Note that these params are reversed from the win32 call. - -Returns: - - Any - - """ - ... - - def GetTypeInfoCount(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIDispatchEx: - """A OLE automation client object that uses the IDispatchEx scripting interface..""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetDispID(self, name: str, fdex: Any) -> Any: - """ - Returns the member id for a name - -Args: - - name(str):passed in name to be mapped - fdex(Any):Determines the options for obtaining the member identifier. This can be a combination of the fdex* constants: - -Returns: - - Any - - """ - ... - - def InvokeEx( - self, - dispid: Any, - lcid: Any, - flags: Any, - args: list[Any], - types: list[Any] = None, - returnDesc: Any = 1, - serviceProvider: Any = None) -> Any: - """ - None - -Args: - - dispid(Any): - lcid(Any): - flags(Any): - args(list[Any]):The arguments. - types(list[Any]):A tuple of type description object, or None if type descriptions are not available. - returnDesc(Any):If types==None, should be a BOOL indicating if the result is needed. If types is a tuple, then should a be type description. - serviceProvider(Any):A service provider object supplied by the caller which allows the object to obtain services from the caller. Can be None. - -Returns: - - Any - - """ - ... - - def DeleteMemberByName(self, name: str, fdex: Any) -> None: - """ - None - -Args: - - name(str):passed in name to be mapped - fdex(Any):Determines the options - -Returns: - - None - - """ - ... - - def DeleteMemberByDispID(self, dispid: Any) -> None: - """ - None - -Args: - - dispid(Any): - -Returns: - - None - - """ - ... - - def GetMemberProperties(self, dispid: Any, fdex: Any) -> Any: - """ - Returns mask of fdex* flags describing a member - -Args: - - dispid(Any):The member id - fdex(Any):fdex* flags specifying which properties to return - -Returns: - - Any - - """ - ... - - def GetMemberName(self, dispid: Any) -> Any: - """ - Returns the name associated with a member id - -Args: - - dispid(Any):The member id - -Returns: - - Any - - """ - ... - - def GetNextDispID(self, fdex: Any, dispid: Any) -> Any: - """ - Enumerates member ids. - -Args: - - fdex(Any):Determines the options - dispid(Any):Current member, or DISPID_STARTENUM to begin enumeration. GetNextDispID will retrieve the item in the enumeration after this one. - -Returns: - - Any - - """ - ... - - -class PyIDisplayItem: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIDocHostUIHandler: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def ShowContextMenu(self, dwID: Any, pt: tuple[Any, Any], pcmdtReserved: Any, pdispReserved: Any) -> None: - """ - Description of ShowContextMenu. - -Args: - - dwID(Any):Description for dwID - pt(tuple[Any, Any]):Description for ppt - pcmdtReserved(Any):Description for pcmdtReserved - pdispReserved(Any):Description for pdispReserved - -Returns: - - None - - """ - ... - - def GetHostInfo(self) -> None: - """ - Description of GetHostInfo. - -Args: - - - -Returns: - - None - - """ - ... - - def ShowUI(self, dwID: Any, pActiveObject: Any, pCommandTarget: Any, pFrame: Any, pDoc: Any) -> None: - """ - Description of ShowUI. - -Args: - - dwID(Any):Description for dwID - pActiveObject(Any):Description for pActiveObject - pCommandTarget(Any):Description for pCommandTarget - pFrame(Any):Description for pFrame - pDoc(Any):Description for pDoc - -Returns: - - None - - """ - ... - - def HideUI(self) -> None: - """ - Description of HideUI. - -Args: - - - -Returns: - - None - - """ - ... - - def UpdateUI(self) -> None: - """ - Description of UpdateUI. - -Args: - - - -Returns: - - None - - """ - ... - - def EnableModeless(self, fEnable: Any) -> None: - """ - Description of EnableModeless. - -Args: - - fEnable(Any):Description for fEnable - -Returns: - - None - - """ - ... - - def OnDocWindowActivate(self, fActivate: Any) -> None: - """ - Description of OnDocWindowActivate. - -Args: - - fActivate(Any):Description for fActivate - -Returns: - - None - - """ - ... - - def OnFrameWindowActivate(self, fActivate: Any) -> None: - """ - Description of OnFrameWindowActivate. - -Args: - - fActivate(Any):Description for fActivate - -Returns: - - None - - """ - ... - - def ResizeBorder(self, prcBorder: tuple[Any, Any, Any, Any], pUIWindow: Any, fRameWindow: Any) -> None: - """ - Description of ResizeBorder. - -Args: - - prcBorder(tuple[Any, Any, Any, Any]):Description for prcBorder - pUIWindow(Any):Description for pUIWindow - fRameWindow(Any):Description for fRameWindow - -Returns: - - None - - """ - ... - - def TranslateAccelerator(self, lpMsg: Any, pguidCmdGroup: PyIID, nCmdID: Any) -> None: - """ - Description of TranslateAccelerator. - -Args: - - lpMsg(Any):Description for lpMsg - pguidCmdGroup(PyIID):Description for pguidCmdGroup - nCmdID(Any):Description for nCmdID - -Returns: - - None - - """ - ... - - def GetOptionKeyPath(self, dw: Any) -> None: - """ - Description of GetOptionKeyPath. - -Args: - - dw(Any):Description for dw - -Returns: - - None - - """ - ... - - def GetDropTarget(self, pDropTarget: Any) -> None: - """ - Description of GetDropTarget. - -Args: - - pDropTarget(Any):Description for pDropTarget - -Returns: - - None - - """ - ... - - def GetExternal(self) -> None: - """ - Description of GetExternal. - -Args: - - - -Returns: - - None - - """ - ... - - def TranslateUrl(self, dwTranslate: Any, pchURLIn: Any) -> None: - """ - Description of TranslateUrl. - -Args: - - dwTranslate(Any):Description for dwTranslate - pchURLIn(Any):Description for pchURLIn - -Returns: - - None - - """ - ... - - def FilterDataObject(self, pDO: Any) -> None: - """ - Description of FilterDataObject. - -Args: - - pDO(Any):Description for pDO - -Returns: - - None - - """ - ... - - -class PyIDropSource: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def QueryContinueDrag(self, fEscapePressed: Any, grfKeyState: Any) -> None: - """ - Description of QueryContinueDrag. - -Args: - - fEscapePressed(Any):Description for fEscapePressed - grfKeyState(Any):Description for grfKeyState - -Returns: - - None - - """ - ... - - def GiveFeedback(self, dwEffect: Any) -> None: - """ - Description of GiveFeedback. - -Args: - - dwEffect(Any):Description for dwEffect - -Returns: - - None - - """ - ... - - -class PyIDropTarget: - """Interface that acts as a target of OLE drag and drop operations""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def DragEnter(self, pDataObj: Any, grfKeyState: Any, pt: tuple[Any, Any], pdwEffect: Any) -> Any: - """ - Called when an object is initially dragged into a window - -Args: - - pDataObj(Any):IDataObject interface that contains the object being dragged - grfKeyState(Any):Combination of win32con.MK_* flags containing keyboard modifier state - pt(tuple[Any, Any]):(x,y) Screen coordinates of cursor - pdwEffect(Any):shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return a shellcon.DROPEFFECT_* value indicating if the object can be accepted - -Returns: - - Any:shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return a shellcon.DROPEFFECT_* value indicating if the object can - -be accepted - - - """ - ... - - def DragOver(self, grfKeyState: Any, pt: tuple[Any, Any], pdwEffect: Any) -> Any: - """ - Called as the dragged object moves over the window - -Args: - - grfKeyState(Any):Combination of win32con.MK_* flags containing keyboard modifier state - pt(tuple[Any, Any]):(x,y) Screen coordinates of cursor - pdwEffect(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 - -Returns: - - 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 - - - """ - ... - - def DragLeave(self) -> None: - """ - Called as the object is dragged back out of the window - -Args: - - - -Returns: - - None - - """ - ... - - def Drop(self, pDataObj: Any, grfKeyState: Any, pt: tuple[Any, Any], dwEffect: Any) -> Any: - """ - Called when the object is dropped onto the window - -Args: - - pDataObj(Any):IDataObject interface containing the dropped object - grfKeyState(Any):Combination of win32con.MK_* flags containing keyboard modifier state - pt(tuple[Any, Any]):(x,y) Screen coordinates of cursor - dwEffect(Any):shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return one of the shellcon.DROPEFFECT_* values - -Returns: - - Any:shellcon.DROPEFFECT_* valueReturn ValueYour implementation of this function should return one of the shellcon.DROPEFFECT_* values - - - """ - ... - - -class PyIDropTargetHelper: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def DragEnter(self, hwnd: int, pDataObj: Any, pt: tuple[Any, Any], dwEffect: Any) -> None: - """ - Description of DragEnter. - -Args: - - hwnd(int):Handle to target window - pDataObj(Any):Object that is dragged onto the window - pt(tuple[Any, Any]):Coordinates where drag operation entered the window - dwEffect(Any):One of shellcon.DROPEFFECT_* values - -Returns: - - None - - """ - ... - - def DragOver(self, hwnd: Any, pt: tuple[Any, Any], pdwEffect: Any) -> None: - """ - Description of DragOver. - -Args: - - hwnd(Any): - pt(tuple[Any, Any]):Description for pt - pdwEffect(Any):Description for pdwEffect - -Returns: - - None - - """ - ... - - def DragLeave(self) -> None: - """ - Description of DragLeave. - -Args: - - - -Returns: - - None - - """ - ... - - def Drop(self, pDataObj: Any, pt: tuple[Any, Any], dwEffect: Any) -> None: - """ - Description of Drop. - -Args: - - pDataObj(Any):Description for pDataObj - pt(tuple[Any, Any]):Description for pt - dwEffect(Any):Description for dwEffect - -Returns: - - None - - """ - ... - - -class PyIDsObjectPicker: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Initialize( - self, - targetComputer: str, - scopeInfos: Any, - options: Any = 0, - attrNames: list[str] = None) -> None: - """ - Initializes the IDsObjectPicker interface with information about the scopes, filters, and options used by the object picker dialog box. - -Args: - - targetComputer(str): - scopeInfos(Any): - options(Any): - attrNames(list[str]): - -Returns: - - None - - """ - ... - - def InvokeDialog(self, hwnd: Any) -> Any: - """ - Displays a modal object picker dialog box and returns the user's selections. - -Args: - - hwnd(Any): - -Returns: - - Any - - """ - ... - - -class PyIEmptyVolumeCache: - """Used for cleaning up temporary file ("disk cleanup")""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIEmptyVolumeCache2: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIEmptyVolumeCacheCallBack: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def ScanProgress(self, dwlSpaceUsed: Any, dwFlags: Any, pcwszStatus: Any) -> None: - """ - Description of ScanProgress. - -Args: - - dwlSpaceUsed(Any):Description for dwlSpaceUsed - dwFlags(Any):Description for dwFlags - pcwszStatus(Any):Description for pcwszStatus - -Returns: - - None - - """ - ... - - def PurgeProgress( - self, - dwlSpaceFreed: Any, - spaceFreed: Any, - spaceToFree: Any, - flags: Any, - status: Any) -> None: - """ - Description of PurgeProgress. - -Args: - - dwlSpaceFreed(Any):Description for dwlSpaceFreed - spaceFreed(Any): - spaceToFree(Any): - flags(Any): - status(Any): - -Returns: - - None - - """ - ... - - -class PyIEnumCATEGORYINFO: - """A Python interface to IEnumCATEGORYINFO""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Next(self, num: Any = 1) -> tuple[tuple[PyIID, Any, str], ...]: - """ - Retrieves a specified number of items in the - -enumeration sequence. - -Args: - - num(Any):Number of items to retrieve.Return ValueThe result is a tuple of (IID object, LCID, string description) tuples, one for each element returned. - -Returns: - - tuple[tuple[PyIID, Any, str], ...]:Number of items to retrieve. -Return ValueThe result is a tuple of (IID object, LCID, string description) tuples, - -one for each element returned. - - - """ - ... - - def Skip(self, num: Any) -> None: - """ - Skips over the next specified elementes. - -Args: - - num(Any):The number of elements being requested. - -Returns: - - None - - """ - ... - - def Reset(self) -> None: - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - ... - - def Clone(self) -> Any: - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIEnumConnectionPoints: - """A Python interface to IEnumConnectionPoints""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Next(self, num: Any = 1) -> tuple[Any, ...]: - """ - Retrieves a specified number of items in the - -enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - tuple[Any, ...] - - """ - ... - - def Skip(self) -> None: - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - ... - - def Reset(self) -> None: - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - ... - - def Clone(self) -> Any: - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIEnumConnections: - """A Python interface to IEnumConnections""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Next(self, num: Any = 1) -> Any: - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - ... - - def Skip(self) -> None: - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - ... - - def Reset(self) -> None: - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - ... - - def Clone(self) -> Any: - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIEnumContextProps: - """A Python interface to IEnumContextProps""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Next(self, num: Any = 1) -> tuple[tuple[PyIID, Any, Any], ...]: - """ - Retrieves a specified number of items in - -the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve.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 property value - -Returns: - - tuple[tuple[PyIID, Any, Any], ...]:Number of items to retrieve. -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 - -property value - - - """ - ... - - def Skip(self) -> None: - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - ... - - def Reset(self) -> None: - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - ... - - def Clone(self) -> Any: - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIEnumDebugApplicationNodes: - """A Python interface to IEnumDebugApplicationNodes""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Next(self, num: Any = 1) -> Any: - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - ... - - def Skip(self) -> None: - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - ... - - def Reset(self) -> None: - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - ... - - def Clone(self) -> Any: - """ - Creates another enumerator that - -contains the same enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIEnumDebugCodeContexts: - """A Python interface to IEnumDebugCodeContexts""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Next(self, num: Any = 1) -> Any: - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - ... - - def Skip(self) -> None: - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - ... - - def Reset(self) -> None: - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - ... - - def Clone(self) -> Any: - """ - Creates another enumerator that contains the - -same enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIEnumDebugExpressionContexts: - """A Python interface to IEnumDebugExpressionContexts""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Next(self, num: Any = 1) -> Any: - """ - Retrieves a specified number of items in the enumeration - -sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - ... - - def Skip(self) -> None: - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - ... - - def Reset(self) -> None: - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - ... - - def Clone(self) -> Any: - """ - Creates another enumerator that - -contains the same enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIEnumDebugPropertyInfo: - """A Python interface to IEnumDebugPropertyInfo""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Next(self, num: Any = 1) -> Any: - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - ... - - def Skip(self) -> None: - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - ... - - def Reset(self) -> None: - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - ... - - def Clone(self) -> Any: - """ - Creates another enumerator that contains the - -same enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - ... - - def GetCount(self) -> Any: - """ - Obtains the number of items - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIEnumDebugStackFrames: - """A Python interface to IEnumDebugStackFrames""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Next(self, num: Any = 1) -> Any: - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - ... - - def Skip(self) -> None: - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - ... - - def Reset(self) -> None: - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - ... - - def Clone(self) -> Any: - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIEnumExplorerCommand: - """A Python interface to IEnumExplorerCommand""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Next(self, num: Any = 1) -> Any: - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - ... - - def Skip(self) -> None: - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - ... - - def Reset(self) -> None: - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - ... - - def Clone(self) -> Any: - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIEnumFORMATETC: - """A Python interface to IEnumFORMATETC""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Next(self, num: Any = 1) -> Any: - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - ... - - def Skip(self) -> None: - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - ... - - def Reset(self) -> None: - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - ... - - def Clone(self) -> Any: - """ - Creates another enumerator that contains the same enumeration - -state as the current one - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIEnumGUID: - """A Python interface to IEnumGUID""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Next(self, num: Any = 1) -> tuple[PyIID, ...]: - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve.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 an error condition - an empty tuple is simply returned. - -Returns: - - tuple[PyIID, ...]:Number of items to retrieve. -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 - -an error condition - an empty tuple is simply returned. - - - """ - ... - - def Skip(self, num: Any) -> None: - """ - Skips over the next specified elementes. - -Args: - - num(Any):The number of elements being requested. - -Returns: - - None - - """ - ... - - def Reset(self) -> None: - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - ... - - def Clone(self) -> Any: - """ - Creates another enumerator that contains the same enumeration state as - -the current one - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIEnumIDList: - """A Python interface to IEnumIDList""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Next(self, num: Any = 1) -> Any: - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - ... - - def Skip(self) -> None: - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - ... - - def Reset(self) -> None: - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - ... - - def Clone(self) -> Any: - """ - Creates another enumerator that contains the same enumeration state - -as the current one - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIEnumMoniker: - """A Python interface to IEnumMoniker""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Next(self, num: Any = 1) -> Any: - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve.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 an error condition - an empty tuple is simply returned. - -Returns: - - Any:Number of items to retrieve. -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 - -an error condition - an empty tuple is simply returned. - - - """ - ... - - def Skip(self, num: Any) -> None: - """ - Skips over the next specified elementes. - -Args: - - num(Any):The number of elements being requested. - -Returns: - - None - - """ - ... - - def Reset(self) -> None: - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - ... - - def Clone(self) -> Any: - """ - Creates another enumerator that contains the same enumeration state - -as the current one - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIEnumObjects: - """Iterates through a number of arbitrary interfaces""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Next(self, riid: PyIID, num: Any = 1) -> tuple[Any, ...]: - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - riid(PyIID):The interfaces to return - num(Any):Number of items to retrieve. - -Returns: - - tuple[Any, ...] - - """ - ... - - def Skip(self) -> None: - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - ... - - def Reset(self) -> None: - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - ... - - def Clone(self) -> Any: - """ - Creates another enumerator that contains the same enumeration state - -as the current one - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIEnumRemoteDebugApplicationThreads: - """A Python interface to IEnumRemoteDebugApplicationThreads""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Next(self, num: Any = 1) -> Any: - """ - Retrieves a specified number of items in the enumeration - -sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - ... - - def Skip(self) -> None: - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - ... - - def Reset(self) -> None: - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - ... - - def Clone(self) -> Any: - """ - Creates another - -enumerator that contains the same enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIEnumRemoteDebugApplications: - """A Python interface to IEnumRemoteDebugApplications""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Next(self, num: Any = 1) -> Any: - """ - Retrieves a specified number of items in the enumeration - -sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - ... - - def Skip(self) -> None: - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - ... - - def Reset(self) -> None: - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - ... - - def Clone(self) -> Any: - """ - Creates another enumerator that - -contains the same enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIEnumResources: - """A Python interface to IEnumResources""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Next(self, num: Any = 1) -> Any: - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - ... - - def Skip(self) -> None: - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - ... - - def Reset(self) -> None: - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - ... - - def Clone(self) -> Any: - """ - Creates another enumerator that contains the same enumeration - -state as the current one - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIEnumSTATPROPSETSTG: - """A Python interface to IEnumSTATPROPSETSTG""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Next(self, num: Any = 1) -> Any: - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - ... - - def Skip(self) -> None: - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - ... - - def Reset(self) -> None: - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - ... - - def Clone(self) -> Any: - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIEnumSTATPROPSTG: - """A Python interface to IEnumSTATPROPSTG""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Next(self, num: Any = 1) -> Any: - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - Any - - """ - ... - - def Skip(self) -> None: - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - ... - - def Reset(self) -> None: - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - ... - - def Clone(self) -> Any: - """ - Creates another enumerator that contains the same - -enumeration state as the current one - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIEnumSTATSTG: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Next(self, num: Any = 1) -> tuple[Any, ...]: - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - tuple[Any, ...] - - """ - ... - - def Skip(self) -> None: - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - ... - - def Reset(self) -> None: - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - ... - - def Clone(self) -> Any: - """ - Creates another enumerator that contains the same enumeration state - -as the current one - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIEnumShellItems: - """A Python interface to IEnumShellItems""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Next(self, num: Any = 1) -> tuple[Any, ...]: - """ - Retrieves a specified number of items in the enumeration - -sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - tuple[Any, ...] - - """ - ... - - def Skip(self) -> None: - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - ... - - def Reset(self) -> None: - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - ... - - def Clone(self) -> Any: - """ - Creates another enumerator that contains the same enumeration - -state as the current one - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIEnumString: - """An enumerator interface to list strings""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Next(self, num: Any = 1) -> tuple[str, ...]: - """ - Retrieves a specified number of items in the enumeration sequence. - -Args: - - num(Any):Number of items to retrieve. - -Returns: - - tuple[str, ...] - - """ - ... - - def Skip(self) -> None: - """ - Skips over the next specified elementes. - -Args: - - - -Returns: - - None - - """ - ... - - def Reset(self) -> None: - """ - Resets the enumeration sequence to the beginning. - -Args: - - - -Returns: - - None - - """ - ... - - def Clone(self) -> Any: - """ - Creates another enumerator that contains the same enumeration state - -as the current one - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIErrorLog: - """A Python wrapper for a COM IErrorLog interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def AddError(self, propName: str, excepInfo: Any = None) -> None: - """ - Adds an error to the error log. - -Args: - - propName(str):The name of the error - excepInfo(Any):A COM exception. Must be a complete COM exception (ie, pythoncom.com_error, or win32com.server.exceptions.COMException()) - -Returns: - - None - - """ - ... - - -class PyIExplorerBrowser: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Initialize(self, hwndParent: Any, prc: PyRECT, pfs: Any) -> None: - """ - Description of Initialize. - -Args: - - hwndParent(Any):Description for hwndParent - prc(PyRECT):Description for prc - pfs(Any):Description for pfs - -Returns: - - None - - """ - ... - - def Destroy(self) -> None: - """ - Description of Destroy. - -Args: - - - -Returns: - - None - - """ - ... - - def SetRect(self, hdwp: Any, rcBrowser: PyRECT) -> int: - """ - Description of SetRect. - -Args: - - hdwp(Any):Description for phdwp - rcBrowser(PyRECT):Description for rcBrowser - -Returns: - - int - - """ - ... - - def SetPropertyBag(self, PropertyBag: Any) -> None: - """ - Description of SetPropertyBag. - -Args: - - PropertyBag(Any):Description for pszPropertyBag - -Returns: - - None - - """ - ... - - def SetEmptyText(self, EmptyText: Any) -> None: - """ - Description of SetEmptyText. - -Args: - - EmptyText(Any):Description for pszEmptyText - -Returns: - - None - - """ - ... - - def SetFolderSettings(self, pfs: Any) -> None: - """ - Description of SetFolderSettings. - -Args: - - pfs(Any):Description for pfs - -Returns: - - None - - """ - ... - - def Advise(self, psbe: Any) -> Any: - """ - Description of Advise. - -Args: - - psbe(Any):Description for psbe - -Returns: - - Any - - """ - ... - - def Unadvise(self, dwCookie: Any) -> None: - """ - Description of Unadvise. - -Args: - - dwCookie(Any):Description for dwCookie - -Returns: - - None - - """ - ... - - def SetOptions(self, dwFlag: Any) -> None: - """ - Description of SetOptions. - -Args: - - dwFlag(Any):Description for dwFlag - -Returns: - - None - - """ - ... - - def GetOptions(self) -> Any: - """ - Description of GetOptions. - -Args: - - - -Returns: - - Any - - """ - ... - - def BrowseToIDList(self, pidl: Any, uFlags: Any) -> None: - """ - Description of BrowseToIDList. - -Args: - - pidl(Any):Description for pidl - uFlags(Any):Description for uFlags - -Returns: - - None - - """ - ... - - def BrowseToObject(self, punk: Any, uFlags: Any) -> None: - """ - Description of BrowseToObject. - -Args: - - punk(Any):Description for punk - uFlags(Any):Description for uFlags - -Returns: - - None - - """ - ... - - def FillFromObject(self, punk: Any, dwFlags: Any) -> None: - """ - Description of FillFromObject. - -Args: - - punk(Any):Description for punk - dwFlags(Any):Description for dwFlags - -Returns: - - None - - """ - ... - - def RemoveAll(self) -> None: - """ - Description of RemoveAll. - -Args: - - - -Returns: - - None - - """ - ... - - def GetCurrentView(self, riid: PyIID) -> Any: - """ - Description of GetCurrentView. - -Args: - - riid(PyIID):Description for riid - -Returns: - - Any - - """ - ... - - -class PyIExplorerBrowserEvents: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def OnNavigationPending(self, pidlFolder: Any) -> None: - """ - Description of OnNavigationPending. - -Args: - - pidlFolder(Any):Description for pidlFolder - -Returns: - - None - - """ - ... - - def OnViewCreated(self, psv: Any) -> None: - """ - Description of OnViewCreated. - -Args: - - psv(Any):Description for psv - -Returns: - - None - - """ - ... - - def OnNavigationComplete(self, pidlFolder: Any) -> None: - """ - Description of OnNavigationComplete. - -Args: - - pidlFolder(Any):Description for pidlFolder - -Returns: - - None - - """ - ... - - def OnNavigationFailed(self, pidlFolder: Any) -> None: - """ - Description of OnNavigationFailed. - -Args: - - pidlFolder(Any):Description for pidlFolder - -Returns: - - None - - """ - ... - - -class PyIExplorerCommand: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetTitle(self, psiItemArray: Any) -> Any: - """ - Description of GetTitle. - -Args: - - psiItemArray(Any):Description for psiItemArray - -Returns: - - Any - - """ - ... - - def GetIcon(self, psiItemArray: Any) -> Any: - """ - Description of GetIcon. - -Args: - - psiItemArray(Any):Description for psiItemArray - -Returns: - - Any - - """ - ... - - def GetToolTip(self, psiItemArray: Any) -> Any: - """ - Description of GetToolTip. - -Args: - - psiItemArray(Any):Description for psiItemArray - -Returns: - - Any - - """ - ... - - def GetCanonicalName(self) -> PyIID: - """ - Description of GetCanonicalName. - -Args: - - - -Returns: - - PyIID - - """ - ... - - def GetState(self, psiItemArray: Any, fOkToBeSlow: Any) -> Any: - """ - Description of GetState. - -Args: - - psiItemArray(Any):Description for psiItemArray - fOkToBeSlow(Any):Description for fOkToBeSlow - -Returns: - - Any - - """ - ... - - def Invoke(self, psiItemArray: Any, pbc: Any) -> None: - """ - Description of Invoke. - -Args: - - psiItemArray(Any):Description for psiItemArray - pbc(Any):Description for pbc - -Returns: - - None - - """ - ... - - def GetFlags(self) -> Any: - """ - Description of GetFlags. - -Args: - - - -Returns: - - Any - - """ - ... - - def EnumSubCommands(self) -> Any: - """ - Description of EnumSubCommands. - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIExplorerCommandProvider: - """This is a gateway only interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIExplorerPaneVisibility: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIExternalConnection: - """A Python wrapper for a COM IExternalConnection interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def AddConnection(self, extconn: Any, reserved: Any = 0) -> Any: - """ - Increments an object's count of its strong external connections - -(links). - -Args: - - extconn(Any):Type of external connection to the object. The only type of external connection currently supported by this interface is strong, which means that the object must remain alive as long as this external connection exists. Strong external connections are represented by the value EXTCONN_STRONG = 0x0001, which is defined in the enumeration EXTCON - reserved(Any):A reserved parameterReturn ValueThe result is the number of reference counts on the object; used for debugging purposes only. - -Returns: - - Any:A reserved parameter -Return ValueThe result is the number of reference counts on the object; used for debugging purposes only. - - - """ - ... - - def ReleaseConnection(self, extconn: Any, reserved: Any, fLastReleaseCloses: Any) -> Any: - """ - Decrements an object's count of its strong external connections - -(references). - -Args: - - extconn(Any):Type of external connection - reserved(Any):A reserved parameter. - fLastReleaseCloses(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 or another process.Return ValueThe result is the number of reference counts on the object; used for debugging purposes only. - -Returns: - - 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 - -or another process.Return ValueThe result is the number of reference counts on the object; used for debugging purposes only. - - - """ - ... - - -class PyIExtractIcon: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Extract(self, pszFile: Any, nIconIndex: Any, nIconSize: Any) -> None: - """ - Description of Extract. - -Args: - - pszFile(Any):Description for pszFile - nIconIndex(Any):Description for nIconIndex - nIconSize(Any):Description for nIconIndexReturn ValueThe result is (hicon_large, hicon_small), or (None,None) if the underlying function returns S_FALSE, indicating the calling application should extract it. - -Returns: - - None:Description for nIconIndexReturn ValueThe result is (hicon_large, hicon_small), or - -(None,None) if the underlying function returns S_FALSE, indicating - -the calling application should extract it. - - - """ - ... - - def GetIconLocation(self, uFlags: Any, cchMax: Any) -> None: - """ - Description of GetIconLocation. - -Args: - - uFlags(Any):Description for uFlags - cchMax(Any):Buffer size to allocate for file name - -Returns: - - None - - """ - ... - - -class PyIExtractIconW: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Extract(self, pszFile: Any, nIconIndex: Any, nIconSize: Any) -> None: - """ - Description of Extract. - -Args: - - pszFile(Any):Description for pszFile - nIconIndex(Any):Description for nIconIndex - nIconSize(Any):Description for nIconIndexReturn ValueThe result is (hicon_large, hicon_small), or (None,None) if the underlying function returns S_FALSE, indicating the calling application should extract it. - -Returns: - - None:Description for nIconIndexReturn ValueThe result is (hicon_large, hicon_small), or - -(None,None) if the underlying function returns S_FALSE, indicating - -the calling application should extract it. - - - """ - ... - - def GetIconLocation(self, uFlags: Any, cchMax: Any) -> None: - """ - Description of GetIconLocation. - -Args: - - uFlags(Any):Description for uFlags - cchMax(Any):Buffer size to allocate for file name - -Returns: - - None - - """ - ... - - -class PyIExtractImage: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetLocation(self, dwPriority: Any, size: tuple[Any, Any], dwRecClrDepth: Any, pdwFlags: Any) -> None: - """ - Description of GetLocation. - -Args: - - dwPriority(Any):Description for dwPriority - size(tuple[Any, Any]):Description for prgSize - dwRecClrDepth(Any):Description for dwRecClrDepth - pdwFlags(Any):Description for pdwFlags - -Returns: - - None - - """ - ... - - def Extract(self) -> None: - """ - Description of Extract. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIFileOperation: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Advise(self, Sink: Any) -> Any: - """ - Connects an event sink to receive updates - -Args: - - Sink(Any):Interface that receives progress updatesReturn ValueReturns a cookie to be passed to PyIFileOperation::Unadvise to disconnect - -Returns: - - Any:Interface that receives progress updatesReturn ValueReturns a cookie to be passed to PyIFileOperation::Unadvise to disconnect - - - """ - ... - - def Unadvise(self, Cookie: Any) -> None: - """ - Disconnects a progress sink - -Args: - - Cookie(Any):Identifies the sink to disconnect, as returned by PyIFileOperation::Advise - -Returns: - - None - - """ - ... - - def SetOperationFlags(self, OperationFlags: Any) -> None: - """ - Sets option flags for the operation - -Args: - - OperationFlags(Any):Combination of shellcon.FOF_* and FOFX_* flags - -Returns: - - None - - """ - ... - - def SetProgressMessage(self, Message: Any) -> None: - """ - Not implemented. - -Args: - - Message(Any):Description for Message - -Returns: - - None - - """ - ... - - def SetProgressDialog(self, popd: Any) -> None: - """ - Provides an interface used to display a progress dialog - -Args: - - popd(Any):Progress dialog interfaceCommentsIOperationsProgressDialog is not yet supported - -Returns: - - None - - """ - ... - - def SetProperties(self, proparray: Any) -> None: - """ - Specifies a set of properties to be changed. - -Args: - - proparray(Any):Sequence of property changes to be performed (see propsys::PSCreatePropertyChangeArray)CommentsNote that these properties will be set for *any* files created by the operation, not just items passed to ApplyPropertiesToItem(s). New items created as the result of a rename, copy, or move must have a property handler, or the operation fails with the vague com_error: (-2147467259, 'Unspecified error, None, None) (E_FAIL, or 0x80004005 in hex) even though the given file operation was actually performed. - -Returns: - - None - - """ - ... - - def SetOwnerWindow(self, Owner: int) -> None: - """ - Sets the parent window for any UI displayed. - -Args: - - Owner(int):Handle to parent window - -Returns: - - None - - """ - ... - - def ApplyPropertiesToItem(self, Item: Any) -> None: - """ - Specifies the item that will receive property changes - -Args: - - Item(Any):The item to which property changes will be applied - -Returns: - - None - - """ - ... - - def ApplyPropertiesToItems(self, Items: Any) -> None: - """ - Specifies multiple items that will receive property changes - -Args: - - Items(Any):PyIShellItemArray, PyIDataObject, or PyIEnumShellItems containing the target items - -Returns: - - None - - """ - ... - - def RenameItem(self, Item: Any, NewName: Any, Sink: Any = None) -> None: - """ - Adds a rename to the operation sequence - -Args: - - Item(Any):The item to be renamed - NewName(Any):The new name - Sink(Any):Progress sink for this operation only. - -Returns: - - None - - """ - ... - - def RenameItems(self, pUnkItems: Any, NewName: Any) -> None: - """ - Adds multiple renames to the operation sequence - -Args: - - pUnkItems(Any):PyIShellItemArray, PyIDataObject, or PyIEnumShellItems containing items to be renamed - NewName(Any):New name for all items. Collisions handled automatically. - -Returns: - - None - - """ - ... - - def MoveItem(self, Item: Any, DestinationFolder: Any, pszNewName: Any = None, Sink: Any = None) -> None: - """ - Adds a move operation to the configuration - -Args: - - Item(Any):The item to be moved - DestinationFolder(Any):The folder into which it will be moved - pszNewName(Any):Name to be given to moved item, use None to keep original name - Sink(Any):Progress sink to receive notification for just this operation - -Returns: - - None - - """ - ... - - def MoveItems(self, Items: Any, DestinationFolder: Any) -> None: - """ - Adds multiple move operations to the configuration - -Args: - - Items(Any):PyIShellItemArray, PyIDataObject, or PyIEnumShellItems containing the items to be moved - DestinationFolder(Any):Folder into which all items will be moved - -Returns: - - None - - """ - ... - - def CopyItem(self, Item: Any, DestinationFolder: Any, CopyName: Any = None, Sink: Any = None) -> None: - """ - Adds a copy operation to the configuration - -Args: - - Item(Any):Item to be copied - DestinationFolder(Any):Folder into which it will be copied - CopyName(Any):New name for the copied file, use None to keep original name - Sink(Any):Progress sink for just this operation - -Returns: - - None - - """ - ... - - def CopyItems(self, Items: Any, DestinationFolder: Any) -> None: - """ - Adds multiple copy operations to the configuration - -Args: - - Items(Any):PyIShellItemArray, PyIDataObject, or PyIEnumShellItems containing items to be copied - DestinationFolder(Any):Folder into which they will be copied - -Returns: - - None - - """ - ... - - def DeleteItem(self, Item: Any, Sink: Any = None) -> None: - """ - Adds a delete operation to the configuration - -Args: - - Item(Any):Description for psiItem - Sink(Any):Progress sink for just this operation - -Returns: - - None - - """ - ... - - def DeleteItems(self, Items: Any) -> None: - """ - Adds multiple delete operations to the configuration - -Args: - - Items(Any):PyIShellItemArray, PyIDataObject, or PyIEnumShellItems containing the items to be deleted - -Returns: - - None - - """ - ... - - def NewItem( - self, - DestinationFolder: Any, - FileAttributes: Any, - Name: Any, - TemplateName: Any = None, - Sink: Any = None) -> None: - """ - Creates a new file as part of the operation - -Args: - - DestinationFolder(Any):Folder in which to create the file - FileAttributes(Any):Combination of win32con.FILE_ATTRIBUTE_* flags - Name(Any):Name of the new file - TemplateName(Any):Template file used to initialize the new file - Sink(Any):Progress sink for just this operation - -Returns: - - None - - """ - ... - - def PerformOperations(self) -> None: - """ - Effects all configured file system modifications - -Args: - - - -Returns: - - None - - """ - ... - - def GetAnyOperationsAborted(self) -> Any: - """ - Determines if any operations were terminated - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIIdentityName: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyIInitializeWithFile: - """Initializes a property handler that requires a file path instead of a stream""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Initialize(self, FilePath: Any, Mode: Any) -> None: - """ - ...es a file path to a property handler on startup - -Args: - - FilePath(Any):Full path to the file whose properties are to be accessed - Mode(Any):Indicates if properties can be written, STGM_READ or STGM_READWRITE - -Returns: - - None - - """ - ... - - -class PyIInitializeWithStream: - """Interface that initializes a handler capable of reading properties from a stream""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Initialize(self, Stream: Any, Mode: Any) -> None: - """ - Initializes a property handler with a stream - -Args: - - Stream(Any):Stream containing the contents from which to extract properties - Mode(Any):Indicates if stream is writable, STGM_READ or STGM_READWRITE - -Returns: - - None - - """ - ... - - -class PyIInputObject: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def TranslateAccelerator(self, pmsg: Any) -> None: - """ - Description of TranslateAccelerator. - -Args: - - pmsg(Any):Description for pmsg - -Returns: - - None - - """ - ... - - def UIActivate(self, uState: Any) -> None: - """ - Description of UIActivate. - -Args: - - uState(Any):Description for uState - -Returns: - - None - - """ - ... - - def HasFocusIO(self) -> None: - """ - Description of Refresh. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIInternetBindInfo: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetBindInfo(self) -> None: - """ - Description of GetBindInfo. - -Args: - - - -Returns: - - None - - """ - ... - - def GetBindString(self) -> None: - """ - Description of GetBindString. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIInternetPriority: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def SetPriority(self, nPriority: Any) -> None: - """ - Description of SetPriority. - -Args: - - nPriority(Any):Description for nPriority - -Returns: - - None - - """ - ... - - def GetPriority(self) -> None: - """ - Description of GetPriority. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIInternetProtocol: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Read(self, cb: Any) -> None: - """ - Description of Read. - -Args: - - cb(Any):Description for cb - -Returns: - - None - - """ - ... - - def Seek(self, dlibMove: LARGE_INTEGER, dwOrigin: Any) -> None: - """ - Description of Seek. - -Args: - - dlibMove(LARGE_INTEGER):Description for dlibMove - dwOrigin(Any):Description for dwOrigin - -Returns: - - None - - """ - ... - - def LockRequest(self, dwOptions: Any) -> None: - """ - Description of LockRequest. - -Args: - - dwOptions(Any):Description for dwOptions - -Returns: - - None - - """ - ... - - def UnlockRequest(self) -> None: - """ - Description of UnlockRequest. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIInternetProtocolInfo: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def ParseUrl( - self, - pwzUrl: Any, - ParseAction: Any, - dwParseFlags: Any, - cchResult: Any, - dwReserved: Any) -> None: - """ - Description of ParseUrl. - -Args: - - pwzUrl(Any):Description for pwzUrl - ParseAction(Any):Description for ParseAction - dwParseFlags(Any):Description for dwParseFlags - cchResult(Any):Description for cchResult - dwReserved(Any):Description for dwReserved - -Returns: - - None - - """ - ... - - def CombineUrl( - self, - pwzBaseUrl: Any, - pwzRelativeUrl: Any, - dwCombineFlags: Any, - cchResult: Any, - dwReserved: Any) -> None: - """ - Description of CombineUrl. - -Args: - - pwzBaseUrl(Any):Description for pwzBaseUrl - pwzRelativeUrl(Any):Description for pwzRelativeUrl - dwCombineFlags(Any):Description for dwCombineFlags - cchResult(Any):Description for cchResult - dwReserved(Any):Description for dwReserved - -Returns: - - None - - """ - ... - - def CompareUrl(self, pwzUrl1: Any, pwzUrl2: Any, dwCompareFlags: Any) -> None: - """ - Description of CompareUrl. - -Args: - - pwzUrl1(Any):Description for pwzUrl1 - pwzUrl2(Any):Description for pwzUrl2 - dwCompareFlags(Any):Description for dwCompareFlags - -Returns: - - None - - """ - ... - - def QueryInfo( - self, - pwzUrl: Any, - OueryOption: Any, - dwQueryFlags: Any, - cbBuffer: Any, - dwReserved: Any) -> Any: - """ - Description of QueryInfo. - -Args: - - pwzUrl(Any):Description for pwzUrl - OueryOption(Any):Description for OueryOption - dwQueryFlags(Any):Description for dwQueryFlags - cbBuffer(Any):Description for cbBuffer - dwReserved(Any):Description for dwReservedCommentsIf the buffer size is the size of an integer, an integer will be returned, otherwise a string. - -Returns: - - Any - - """ - ... - - -class PyIInternetProtocolRoot: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Start(self, szUrl: Any, pOIProtSink: Any, pOIBindInfo: Any, grfPI: Any, dwReserved: Any) -> None: - """ - Description of Start. - -Args: - - szUrl(Any):Description for szUrl - pOIProtSink(Any):Description for pOIProtSink - pOIBindInfo(Any):Description for pOIBindInfo - grfPI(Any):Description for grfPI - dwReserved(Any):Description for dwReserved - -Returns: - - None - - """ - ... - - def Continue(self) -> None: - """ - Description of Continue. - -Args: - - - -Returns: - - None - - """ - ... - - def Abort(self, hrReason: Any, dwOptions: Any) -> None: - """ - Description of Abort. - -Args: - - hrReason(Any):Description for hrReason - dwOptions(Any):Description for dwOptions - -Returns: - - None - - """ - ... - - def Terminate(self, dwOptions: Any) -> None: - """ - Description of Terminate. - -Args: - - dwOptions(Any):Description for dwOptions - -Returns: - - None - - """ - ... - - def Suspend(self) -> None: - """ - Description of Suspend. - -Args: - - - -Returns: - - None - - """ - ... - - def Resume(self) -> None: - """ - Description of Resume. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIInternetProtocolSink: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Switch(self) -> None: - """ - Description of Switch. - -Args: - - - -Returns: - - None - - """ - ... - - def ReportProgress(self, ulStatusCode: Any, szStatusText: Any) -> None: - """ - Description of ReportProgress. - -Args: - - ulStatusCode(Any):Description for ulStatusCode - szStatusText(Any):Description for szStatusText - -Returns: - - None - - """ - ... - - def ReportData(self, grfBSCF: Any, ulProgress: Any, ulProgressMax: Any) -> None: - """ - Description of ReportData. - -Args: - - grfBSCF(Any):Description for grfBSCF - ulProgress(Any):Description for ulProgress - ulProgressMax(Any):Description for ulProgressMax - -Returns: - - None - - """ - ... - - def ReportResult(self, hrResult: Any, dwError: Any, szResult: Any) -> None: - """ - Description of ReportResult. - -Args: - - hrResult(Any):Description for hrResult - dwError(Any):Description for dwError - szResult(Any):Description for szResult - -Returns: - - None - - """ - ... - - -class PyIInternetSecurityManager: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def SetSecuritySite(self, pSite: Any) -> None: - """ - Description of SetSecuritySite. - -Args: - - pSite(Any):Description for pSite - -Returns: - - None - - """ - ... - - def GetSecuritySite(self) -> None: - """ - Description of GetSecuritySite. - -Args: - - - -Returns: - - None - - """ - ... - - def MapUrlToZone(self, pwszUrl: Any, dwFlags: Any) -> None: - """ - Description of MapUrlToZone. - -Args: - - pwszUrl(Any):Description for pwszUrl - dwFlags(Any):Description for dwFlags - -Returns: - - None - - """ - ... - - def GetSecurityId(self, pwszUrl: Any, pcbSecurityId: Any) -> None: - """ - Description of GetSecurityId. - -Args: - - pwszUrl(Any):Description for pwszUrl - pcbSecurityId(Any):Description for pcbSecurityId - -Returns: - - None - - """ - ... - - def ProcessUrlAction(self, pwszUrl: Any, dwAction: Any, context: Any, dwFlags: Any) -> None: - """ - Description of ProcessUrlAction. - -Args: - - pwszUrl(Any):Description for pwszUrl - dwAction(Any):Description for dwAction - context(Any): - dwFlags(Any):Description for dwFlags - -Returns: - - None - - """ - ... - - def SetZoneMapping(self, dwZone: Any, lpszPattern: Any, dwFlags: Any) -> None: - """ - Description of SetZoneMapping. - -Args: - - dwZone(Any):Description for dwZone - lpszPattern(Any):Description for lpszPattern - dwFlags(Any):Description for dwFlags - -Returns: - - None - - """ - ... - - def GetZoneMappings(self, dwZone: Any, dwFlags: Any) -> None: - """ - Description of GetZoneMappings. - -Args: - - dwZone(Any):Description for dwZone - dwFlags(Any):Description for dwFlags - -Returns: - - None - - """ - ... - - -class PyIKnownFolder: - """Interface representing a known folder that serves - -as a replacement for the numeric CSIDL definitions and API functions. - -Requires Vista or later.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetId(self) -> PyIID: - """ - Returns the id of the folder - -Args: - - - -Returns: - - PyIID - - """ - ... - - def GetCategory(self) -> Any: - """ - Returns the category for a folder (shellcon.KF_CATEGORY_*) - -Args: - - - -Returns: - - Any - - """ - ... - - def GetShellItem(self, riid: PyIID, Flags: Any = 0) -> Any: - """ - Returns a shell interface for the folder - -Args: - - riid(PyIID):The interface to return (IShellItem or IShellItem2) - Flags(Any):Combination of shellcon.KF_FLAG_* values - -Returns: - - Any - - """ - ... - - def GetPath(self, Flags: Any = 0) -> Any: - """ - Returns the path to the folder - -Args: - - Flags(Any):Combination of shellcon.KF_FLAG_* flags controlling how the path is returned - -Returns: - - Any - - """ - ... - - def SetPath(self, Flags: Any, Path: Any) -> None: - """ - Changes the location of the folder - -Args: - - Flags(Any):KF_FLAG_DONT_UNEXPAND, or 0 - Path(Any):New path for known folder - -Returns: - - None - - """ - ... - - def GetIDList(self, Flags: Any) -> Any: - """ - Returns the folder's location as an item id list. - -Args: - - Flags(Any):Combination of shellcon.KF_FLAG_* values that affect how the operation is performed - -Returns: - - Any - - """ - ... - - def GetFolderType(self) -> PyIID: - """ - Returns the type of the folder - -Args: - - - -Returns: - - PyIID:PyIKnownFolder.GetFolderType -PyIID = GetFolderType()Returns the type of the folder -Return ValueReturns a folder type guid (shell.FOLDERTYPEID_*) - - - """ - ... - - def GetRedirectionCapabilities(self) -> Any: - """ - Returns flags indicating how the folder can be redirected - -Args: - - - -Returns: - - Any:PyIKnownFolder.GetRedirectionCapabilities - -int = GetRedirectionCapabilities()Returns flags indicating how the folder can be redirected -Return ValueCombination of shellcon.KF_REDIRECTION_CAPABILITIES_* flags - - - """ - ... - - def GetFolderDefinition(self) -> Any: - """ - Retrieves detailed information about a known folder - -Args: - - - -Returns: - - Any:PyIKnownFolder.GetFolderDefinition - -dict = GetFolderDefinition()Retrieves detailed information about a known folder -Return ValueReturns a dict containing info from a KNOWNFOLDER_DEFINITION struct - - - """ - ... - - -class PyIKnownFolderManager: - """Interface used to manage known folder definitions.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def FolderIdFromCsidl(self, Csidl: Any) -> PyIID: - """ - Returns the folder id that corresponds to a CSIDL - -Args: - - Csidl(Any):The legacy CSIDL identifying a folder - -Returns: - - PyIID - - """ - ... - - def FolderIdToCsidl(self, _id: PyIID) -> Any: - """ - Returns the CSIDL equivalent of a known folder - -Args: - - _id(PyIID):A known folder id (shell.FOLDERID_*) - -Returns: - - Any - - """ - ... - - def GetFolderIds(self) -> tuple[PyIID, ...]: - """ - Retrieves all known folder ids. - -Args: - - - -Returns: - - tuple[PyIID, ...] - - """ - ... - - def GetFolder(self, _id: PyIID) -> Any: - """ - Returns a folder by its id. - -Args: - - _id(PyIID):A known folder id (shell.FOLDERID_*) - -Returns: - - Any - - """ - ... - - def GetFolderByName(self, Name: Any) -> Any: - """ - Returns a folder by canonical name - -Args: - - Name(Any):The nonlocalized name of a known folder - -Returns: - - Any - - """ - ... - - def RegisterFolder(self, _id: PyIID, Definition: Any) -> None: - """ - defines a new known folder - -Args: - - _id(PyIID):GUID used to identify the new known folder - definition(Any):Dictionary containing info to be placed in a KNOWNFOLDER_DEFINITION structCommentsPyIKnownFolder::GetFolderDefinition can be used to get a template dictionary - -Returns: - - None - - """ - ... - - def UnregisterFolder(self, _id: PyIID) -> None: - """ - Removes the definition of a known folder - -Args: - - _id(PyIID):GUID of a known folder to be unregistered - -Returns: - - None - - """ - ... - - def FindFolderFromPath(self, Path: Any, Mode: Any) -> Any: - """ - Retrieves a known folder by path - -Args: - - Path(Any):Path of a folder - Mode(Any):FFFP_EXACTMATCH or FFFP_NEARESTPARENTMATCH - -Returns: - - Any - - """ - ... - - def FindFolderFromIDList(self, pidl: Any) -> Any: - """ - Retrieves a known folder using its item id - -list. - -Args: - - pidl(Any):Item id list of the folder - -Returns: - - Any - - """ - ... - - def Redirect( - self, - _id: PyIID, - hwnd: int, - flags: Any, - TargetPath: Any, - Exclusion: tuple[PyIID, ...]) -> None: - """ - Redirects a known folder to an alternate location - -Args: - - _id(PyIID):Id of the known folder to be redirected - hwnd(int):Handle of window to be used for user interaction - flags(Any):Combination of KF_REDIRECT_* flags - TargetPath(Any):Path to which the known folder will be redirected - Exclusion(tuple[PyIID, ...]):Sequence of known folder ids of subfolders to be excluded from redirection - -Returns: - - None - - """ - ... - - -class PyILockBytes: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def ReadAt(self, ulOffset: ULARGE_INTEGER, cb: Any) -> str: - """ - Reads a specified number of bytes starting at a specified offset from the - -beginning of the byte array object. - -Args: - - ulOffset(ULARGE_INTEGER):Offset to start reading - cb(Any):Number of bytes to readCommentsThe result is a binary buffer returned in a string. - -Returns: - - str - - """ - ... - - def WriteAt(self, ulOffset: ULARGE_INTEGER, data: str) -> Any: - """ - Writes the specified number of bytes starting at a specified offset from the - -beginning of the byte array. - -Args: - - ulOffset(ULARGE_INTEGER):Offset to write at. - data(str):Data to writeReturn ValueThe result is the number of bytes actually written. - -Returns: - - Any:Data to writeReturn ValueThe result is the number of bytes actually written. - - - """ - ... - - def Flush(self) -> None: - """ - Ensures that any internal buffers maintained by the byte array object are written out - -to the backing storage. - -Args: - - - -Returns: - - None - - """ - ... - - def SetSize(self, cb: ULARGE_INTEGER) -> None: - """ - Changes the size of the byte array. - -Args: - - cb(ULARGE_INTEGER):The new size. - -Returns: - - None - - """ - ... - - def LockRegion(self, libOffset: ULARGE_INTEGER, cb: ULARGE_INTEGER, dwLockType: Any) -> None: - """ - Restricts access to a specified range of bytes in the byte array. - -Args: - - libOffset(ULARGE_INTEGER):The beginning of the region to lock. - cb(ULARGE_INTEGER):The number of bytes to lock. - dwLockType(Any):Specifies the restrictions being requested on accessing the range. - -Returns: - - None - - """ - ... - - def UnlockRegion(self, libOffset: ULARGE_INTEGER, cb: ULARGE_INTEGER, dwLockType: Any) -> None: - """ - None - -Args: - - libOffset(ULARGE_INTEGER):The beginning of the region to unlock. - cb(ULARGE_INTEGER):The number of bytes to lock. - dwLockType(Any):Specifies the restrictions being requested on accessing the range. - -Returns: - - None - - """ - ... - - def Stat(self, grfStatFlag: Any) -> Any: - """ - None - -Args: - - grfStatFlag(Any):Specifies that this method does not return some of the fields in the STATSTG structure, thus saving a memory allocation operation. Values are taken from the STATFLAG enumerationg - -Returns: - - Any - - """ - ... - - -class PyIMAPIContainer: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def OpenEntry(self, entryId: str, iid: PyIID, flags: Any) -> Any: - """ - Opens an object and returns an interface object for further access. - -Args: - - entryId(str):The EntryID to open. - iid(PyIID):The IID of the returned interface, or None for the default interface. - flags(Any):Flags for the call. May include MAPI_BEST_ACCESS, MAPI_DEFERRED_ERRORS, MAPI_MODIFY and possibly others (see the MAPI documentation) - -Returns: - - Any - - """ - ... - - def GetContentsTable(self, flags: Any) -> Any: - """ - Returns an object representing the container's contents table. - -Args: - - flags(Any):The flags to use. - -Returns: - - Any - - """ - ... - - def GetHierarchyTable(self, flags: Any) -> Any: - """ - Returns an object representing the container's hierarchy table. - -Args: - - flags(Any):The flags to use. - -Returns: - - Any - - """ - ... - - -class PyIMAPIFolder: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetLastError(self, hr: Any, flags: Any) -> Any: - """ - Returns the last error code for the object. - -Args: - - hr(Any):Contains the error code generated in the previous method call. - flags(Any):Indicates for format for the output. - -Returns: - - Any - - """ - ... - - def CreateFolder( - self, - folderType: Any, - folderName: str, - folderComment: str = None, - iid: PyIID = None, - flags: Any = 0) -> Any: - """ - Creates a folder object. - -Args: - - folderType(Any):The type of folder to create - folderName(str):The name of the folder. - folderComment(str):A comment for the folder or None - iid(PyIID):The IID of the object to return. Should usually be None. - flags(Any): - -Returns: - - Any - - """ - ... - - def CreateMessage(self, iid: PyIID, flags: Any) -> Any: - """ - Creates a message in a folder - -Args: - - iid(PyIID):The IID of the object to return. Should usually be None. - flags(Any): - -Returns: - - Any - - """ - ... - - def CopyMessages( - self, - msgs: Any, - iid: PyIID, - folder: Any, - ulUIParam: Any, - progress: Any, - flags: Any) -> Any: - """ - Copies the specified messages - -Args: - - msgs(Any): - iid(PyIID):IID representing the interface to be used to access the destination folder. Should usually be None. - folder(Any):The destination folder - ulUIParam(Any):Handle of the parent window for any dialog boxes or windows this method displays. - progress(Any):A progress object, or None - flags(Any):A bitmask ofMaskDescriptionMAPI_DECLINE_OKInforms the message store provider to immediately return MAPI_E_DECLINE_COPY if it implements CopyMessage by calling the support object's IMAPISupport::DoCopyTo or IMAPISupport::DoCopyProps method.MESSAGE_DIALOGDisplays a progress indicator as the operation proceeds.MESSAGE_MOVEThe message or messages are to be moved rather than copied. If MESSAGE_MOVE is not set, the messages are copied. - -Returns: - - Any - - """ - ... - - def DeleteFolder(self, entryId: str, uiParam: Any, progress: Any) -> None: - """ - Deletes a subfolder. - -Args: - - entryId(str):The EntryID of the subfolder to delete. - uiParam(Any):Handle of the parent window of the progress indicator. - progress(Any):A progress object, or None - -Returns: - - None - - """ - ... - - def DeleteMessages(self, msgs: Any, uiParam: Any, progress: Any, flags: Any) -> Any: - """ - Deletes the specified messages. - -Args: - - msgs(Any): - uiParam(Any):A HWND for the progress - progress(Any):A progress object, or None - flags(Any): - -Returns: - - Any - - """ - ... - - def EmptyFolder(self, uiParam: Any, progress: Any, flags: Any) -> Any: - """ - deletes all messages and subfolders from a folder without deleting the folder itself. - -Args: - - uiParam(Any):A HWND for the progress - progress(Any):A progress object, or None - flags(Any): - -Returns: - - Any - - """ - ... - - def SetReadFlags(self, msgs: Any, uiParam: Any, progress: Any, flag: Any) -> None: - """ - Sets or clears the MSGFLAG_READ flag in the PR_MESSAGE_FLAGS (PidTagMessageFlags) property of one or more of the folder's messages, and manages the sending of read reports. - -Args: - - msgs(Any): - uiParam(Any):A HWND for the progress - progress(Any):A progress object, or None - flag(Any):Bitmask of flags that controls the setting of a message's read flag - that is, the message's MSGFLAG_READ flag in its PR_MESSAGE_FLAGS property and the processing of read reports. - -Returns: - - None - - """ - ... - - -class PyIMAPIProp: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetProps(self, propList: Any, flags: Any = 0) -> tuple[Any, Any, Any]: - """ - Returns a list of property values. - -Args: - - propList(Any):The list of properties - flags(Any): - -Returns: - - tuple[Any, Any, Any] - - """ - ... - - def DeleteProps(self, propList: Any, wantProblems: Any = False) -> tuple[Any, Any, Any]: - """ - Deletes a set of properties. - -Args: - - propList(Any):The list of properties - wantProblems(Any):Return detailed error information - -Returns: - - tuple[Any, Any, Any] - - """ - ... - - def SetProps(self, propList: tuple[Any, Any], wantProblems: Any = False) -> tuple[Any, Any, Any]: - """ - Sets a set of properties. - -Args: - - propList(tuple[Any, Any]):The list of properties - wantProblems(Any):Return detailed error information - -Returns: - - tuple[Any, Any, Any] - - """ - ... - - def CopyTo( - self, - IIDExcludeList: tuple[Any, Any], - propTags: Any, - uiParam: Any, - progress: Any, - resultIID: PyIID, - dest: Any, - flags: Any, - wantProblems: Any = False) -> tuple[Any, Any, Any]: - """ - Copies an object to another - -Args: - - IIDExcludeList(tuple[Any, Any]):A sequence of IIDs to exclude. - propTags(Any):The property tags to exclude. - uiParam(Any):Handle to the parent window of the progress object - progress(Any):Reserved - must ... None - resultIID(PyIID):IID of the destination object - dest(Any):The destination object - flags(Any):flags - wantProblems(Any):Return detailed error information - -Returns: - - tuple[Any, Any, Any] - - """ - ... - - def CopyProps(self, propTags: Any, uiParam: Any, progress: Any, resultIID: PyIID, - dest: Any, flags: Any, wantProblems: Any = False) -> tuple[Any, Any, Any]: - """ - Copies a set of properties to another object - -Args: - - propTags(Any):The property tags to copy - uiParam(Any):Handle to the parent window of the progress object - progress(Any):Reserved - must ... None - resultIID(PyIID):IID of the destination object - dest(Any):The destination object - flags(Any):flags - wantProblems(Any):Return detailed error information - -Returns: - - tuple[Any, Any, Any] - - """ - ... - - def OpenProperty(self, propTag: Any, iid: PyIID, interfaceOptions: Any, flags: Any) -> Any: - """ - Returns an interface object to be used to access a property. - -Args: - - propTag(Any):The property tag to open - iid(PyIID):The IID of the resulting interface. - interfaceOptions(Any):Data that relates to the interface identified by the lpiid parameter. - flags(Any):flags - -Returns: - - Any - - """ - ... - - def GetIDsFromNames(self, nameIds: Any, flags: Any = 0) -> Any: - """ - Determines property IDs - -Args: - - nameIds(Any):Sequence of name ids - flags(Any): - -Returns: - - Any - - """ - ... - - def GetNamesFromIDs(self, propTags: Any, propSetGuid: PyIID = None, flags: Any = 0) -> tuple[Any, Any, Any]: - """ - Determines property names - -Args: - - propTags(Any):Sequence of property tags, or None - propSetGuid(PyIID):a globally unique identifier, identifying a property set, or None - flags(Any): - -Returns: - - tuple[Any, Any, Any] - - """ - ... - - def GetLastError(self, hr: Any, flags: Any) -> Any: - """ - Returns the last error code for the object. - -Args: - - hr(Any):Contains the error code generated in the previous method call. - flags(Any):Indicates for format for the output. - -Returns: - - Any - - """ - ... - - def SaveChanges(self, flags: Any) -> None: - """ - Saves pending changes to the object - -Args: - - flags(Any):flags - -Returns: - - None - - """ - ... - - def GetPropList(self, flags: Any) -> Any: - """ - Gets a list of properties - -Args: - - flags(Any):flags - -Returns: - - Any - - """ - ... - - -class PyIMAPISession: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def OpenEntry(self, entryId: str, iid: PyIID, flags: Any) -> Any: - """ - Opens an object and returns an interface object for further access. - -Args: - - entryId(str):The EntryID to open. - iid(PyIID):The IID of the returned interface, or None for the default interface. - flags(Any):Flags for the call. May include MAPI_BEST_ACCESS, MAPI_DEFERRED_ERRORS, MAPI_MODIFY and possibly others (see the MAPI documentation) - -Returns: - - Any - - """ - ... - - def OpenMsgStore(self, uiParam: Any, entryId: str, iid: PyIID, flags: Any) -> Any: - """ - Opens a message store. - -Args: - - uiParam(Any):Handle to the parent window for dialogs. - entryId(str):The entry ID of the message store to open. - iid(PyIID):The IID of the interface returned, or None - flags(Any):Options for the call.CommentsThe result is the interface specified by the IID, or IID_IMsgStore if None is used. - -Returns: - - Any - - """ - ... - - def QueryIdentity(self) -> str: - """ - Returns the entry identifier of the object that provides the primary identity for the session. - -Args: - - - -Returns: - - str - - """ - ... - - def Advise(self, entryId: str, mask: Any, sink: Any) -> Any: - """ - None - -Args: - - entryId(str):The entryID of the object - mask(Any): - sink(Any):Return ValueThe result is an integer which should be passed to PyIMAPISession::Unadvise - -Returns: - - Any:Return ValueThe result is an integer which should be passed to - -PyIMAPISession::Unadvise - - - """ - ... - - def Unadvise(self, connection: Any) -> None: - """ - None - -Args: - - connection(Any):Value returned from PyIMAPISession::Advise - -Returns: - - None - - """ - ... - - def CompareEntryIDs(self, entryId: str, entryId1: str, flags: Any = 0) -> Any: - """ - Compares two entry identifiers belonging to a particular address book provider to determine if they refer to the same address book object - -Args: - - entryId(str):The first entry ID to be compared - entryId1(str):The second entry ID to be compared - flags(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. - -Returns: - - 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. - - - """ - ... - - def GetLastError(self, hr: Any, flags: Any) -> Any: - """ - Returns the last error code for the object. - -Args: - - hr(Any):Contains the error code generated in the previous method call. - flags(Any):Indicates for format for the output. - -Returns: - - Any - - """ - ... - - def GetMsgStoresTable(self, flags: Any) -> Any: - """ - Provides access to the message store table - a table with information about all of the message stores in the session profile. - -Args: - - flags(Any):Flags that control the opening. - -Returns: - - Any - - """ - ... - - def GetStatusTable(self, flags: Any) -> Any: - """ - Provides access to the status table - a table with information about all of the MAPI resources in the session. - -Args: - - flags(Any):Flags that control the opening. - -Returns: - - Any - - """ - ... - - def Logoff(self, uiParm: Any, flags: Any, reserved: Any) -> None: - """ - Ends a MAPI session. - -Args: - - uiParm(Any):hwnd of a dialog is to be displayed. - flags(Any):Bitmask of flags that control the logoff operation. - reserved(Any):Reserved; must be zero. - -Returns: - - None - - """ - ... - - def OpenAddressBook(self, uiParm: Any, iid: PyIID, flags: Any) -> Any: - """ - Opens the integrated address book. - -Args: - - uiParm(Any):hwnd of a dialog is to be displayed. - iid(PyIID):The IID of the interface, or None. - flags(Any):Flags that control the opening - AB_NO_DIALOG. - -Returns: - - Any - - """ - ... - - def OpenProfileSection(self, iidSection: PyIID, iid: PyIID, flags: Any) -> Any: - """ - Opens a section of the current profile and returns an object for futher access - -Args: - - iidSection(PyIID):The MAPIIID of the profile section - iid(PyIID):The IID of the interface, or None. - flags(Any):Flags that control the opening. - -Returns: - - Any - - """ - ... - - def AdminServices(self, flags: Any = 0) -> Any: - """ - Provides access to a message service administration object for making changes to the message services. - -Args: - - flags(Any):reserved; must be zero. - -Returns: - - Any - - """ - ... - - -class PyIMAPIStatus: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Changepassword(self, oldpassword: Any, newpassword: Any, ulFlags: Any) -> None: - """ - None - -Args: - - oldpassword(Any): - newpassword(Any): - ulFlags(Any): - -Returns: - - None - - """ - ... - - def SettingsDialog(self, ulUIParam: Any, ulFlags: Any) -> None: - """ - None - -Args: - - ulUIParam(Any): - ulFlags(Any): - -Returns: - - None - - """ - ... - - def ValidateState(self, ulUIParam: Any, ulFlags: Any) -> None: - """ - None - -Args: - - ulUIParam(Any): - ulFlags(Any): - -Returns: - - None - - """ - ... - - def FlushQueues(self, ulUIParam: Any, transport: str, ulFlags: Any) -> None: - """ - None - -Args: - - ulUIParam(Any): - transport(str):Blob of data - ulFlags(Any): - -Returns: - - None - - """ - ... - - -class PyIMAPITable: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetLastError(self, hr: Any, flags: Any) -> Any: - """ - Returns the last error code for the object. - -Args: - - hr(Any):Contains the error code generated in the previous method call. - flags(Any):Indicates for format for the output. - -Returns: - - Any - - """ - ... - - def Advise(self, eventMask: Any, adviseSink: Any) -> Any: - """ - Registers to receive notification of specified events affecting the table. - -Args: - - eventMask(Any): - adviseSink(Any): - -Returns: - - Any - - """ - ... - - def SeekRow(self, bookmark: Any, rowCount: Any) -> Any: - """ - Moves the cursor to a specific position in the table. - -Args: - - bookmark(Any):The bookmark. - rowCount(Any):Return ValueThe result is the number of rows processed. - -Returns: - - Any:Return ValueThe result is the number of rows processed. - - - """ - ... - - def SeekRowApprox(self, numerator: Any, denominator: Any) -> None: - """ - Moves the cursor to an approximate fractional position in the table. - -Args: - - numerator(Any):The numerator of the fraction representing the table position - denominator(Any):The denominator of the fraction representing the table position. This must not be zero. - -Returns: - - None - - """ - ... - - def GetRowCount(self, flags: Any) -> Any: - """ - Returns the total number of rows in the table. - -Args: - - flags(Any):Reserved - must be zero - -Returns: - - Any - - """ - ... - - def QueryRows(self, rowCount: Any, flags: Any) -> Any: - """ - Returns one or more rows from a table, beginning at the current cursor position. - -Args: - - rowCount(Any):Number of rows to retrieve - flags(Any):Flags. - -Returns: - - Any - - """ - ... - - def SetColumns(self, propTags: Any, flags: Any) -> None: - """ - defines the particular properties and order of properties to appear as columns in the table. - -Args: - - propTags(Any):Sequence of property tags identifying properties to be included as columns in the table. - flags(Any): - -Returns: - - None - - """ - ... - - def GetStatus(self) -> None: - """ - Returns the table's status and type. - -Args: - - - -Returns: - - None:PyIMAPITable.GetStatus -GetStatus()Returns the table's status and type. -Return ValueResult is a tuple of (tableStatus, tableType) - - - """ - ... - - def QueryPosition(self) -> None: - """ - Retrieves the current table row position of the cursor, based on a fractional value. - -Args: - - - -Returns: - - None:PyIMAPITable.QueryPosition -QueryPosition()Retrieves the current table row position of the cursor, based on a fractional value. -Return ValueResult is a tuple of (row, numerator, denominator) - - - """ - ... - - def QueryColumns(self, flags: Any) -> Any: - """ - Returns a list of columns for the table. - -Args: - - flags(Any): - -Returns: - - Any - - """ - ... - - def Abort(self) -> None: - """ - Stops any asynchronous operations currently in progress for the table. - -Args: - - - -Returns: - - None - - """ - ... - - def FreeBookmark(self, bookmark: Any) -> None: - """ - Releases the memory associated with a bookmark. - -Args: - - bookmark(Any): - -Returns: - - None - - """ - ... - - def CreateBookmark(self) -> Any: - """ - Marks the table's current position. - -Args: - - - -Returns: - - Any - - """ - ... - - def Restrict(self, restriction: Any, flags: Any) -> None: - """ - Applies a filter to a table, reducing the row set to only those rows matching the specified criteria. - -Args: - - restriction(Any): - flags(Any): - -Returns: - - None - - """ - ... - - def FindRow(self, restriction: Any, bookmarkOrigin: Any, flags: Any) -> None: - """ - Finds the next row in a table that matches specific search criteria. - -Args: - - restriction(Any): - bookmarkOrigin(Any): - flags(Any): - -Returns: - - None - - """ - ... - - def SortTable(self, sortOrderSet: Any, flags: Any) -> None: - """ - Orders the rows of the table based on sort criteria. - -Args: - - sortOrderSet(Any): - flags(Any): - -Returns: - - None - - """ - ... - - def Unadvise(self, handle: Any) -> None: - """ - Cancels the sending of notifications previously set up with a call to the IMAPITable::Advise method. - -Args: - - handle(Any):Handle returned from PyIMAPITable::Advise - -Returns: - - None - - """ - ... - - -class PyIMachineDebugManager: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def AddApplication(self, pda: Any) -> None: - """ - Description of AddApplication. - -Args: - - pda(Any):Description for pda - -Returns: - - None - - """ - ... - - def RemoveApplication(self, dwAppCookie: Any) -> None: - """ - Description of RemoveApplication. - -Args: - - dwAppCookie(Any):Description for dwAppCookie - -Returns: - - None - - """ - ... - - def EnumApplications(self) -> None: - """ - Description of EnumApplications. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIMachineDebugManagerEvents: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def onAddApplication(self, pda: Any, dwAppCookie: Any) -> None: - """ - Description of onAddApplication. - -Args: - - pda(Any):Description for pda - dwAppCookie(Any):Description for dwAppCookie - -Returns: - - None - - """ - ... - - def onRemoveApplication(self, pda: Any, dwAppCookie: Any) -> None: - """ - Description of onRemoveApplication. - -Args: - - pda(Any):Description for pda - dwAppCookie(Any):Description for dwAppCookie - -Returns: - - None - - """ - ... - - -class PyIMessage: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def SetReadFlag(self, flag: Any) -> None: - """ - Sets the read flags for a message - -Args: - - flag(Any):Bitmask of flags that controls the setting of a message's read flag - that is, the message's MSGFLAG_READ flag in its PR_MESSAGE_FLAGS property and the processing of read reports. - -Returns: - - None - - """ - ... - - def GetAttachmentTable(self, flags: Any) -> Any: - """ - Returns the message's attachment table. - -Args: - - flags(Any):Bitmask of flags that relate to the creation of the table. - -Returns: - - Any - - """ - ... - - def OpenAttach(self, attachmentNum: Any, interface: PyIID, flags: Any) -> Any: - """ - Opens an attachment - -Args: - - attachmentNum(Any): - interface(PyIID):The interface to use, or None - flags(Any):Bitmask of flags that controls how the attachment is opened. - -Returns: - - Any - - """ - ... - - def CreateAttach(self, interface: PyIID, flags: Any) -> tuple[Any, Any]: - """ - Creates an attachment - -Args: - - interface(PyIID):The interface to use, or None - flags(Any):Bitmask of flags that controls how the attachment is created.Return ValueThe result is a tuple of (attachmentNum, attachmentObject) - -Returns: - - tuple[Any, Any]:Bitmask of flags that controls how the attachment is created.Return ValueThe result is a tuple of (attachmentNum, attachmentObject) - - - """ - ... - - def DeleteAttach(self, attachmentNum: Any, ulUIParam: Any, interface: Any, flags: Any) -> None: - """ - Deletes an attachment - -Args: - - attachmentNum(Any): - ulUIParam(Any): - interface(Any):The interface to use, or None - flags(Any):Bitmask of flags that controls the display of a user interface. - -Returns: - - None - - """ - ... - - def ModifyRecipients(self, flags: Any, mods: Any) -> None: - """ - adds, deletes, or modifies message recipients. - -Args: - - flags(Any):Bitmask of flags that controls the recipient changes. If zero is passed for the ulFlags parameter, ModifyRecipients replaces all existing recipients with the recipient list in the mods parameter. - mods(Any):The list of recipients. - -Returns: - - None - - """ - ... - - def GetRecipientTable(self, flags: Any) -> Any: - """ - Returns the message's recipient table. - -Args: - - flags(Any):Bitmask of flags that relate to the creation of the table. - -Returns: - - Any - - """ - ... - - def SubmitMessage(self, flags: Any) -> None: - """ - Saves all of the message's properties and marks the message as ready to be sent. - -Args: - - flags(Any):Flags which specify how the message is submitted. - -Returns: - - None - - """ - ... - - -class PyIMoniker: - """A Python interface to IMoniker""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def BindToObject(self, bindCtx: Any, moniker: Any, iidResult: Any) -> Any: - """ - Uses the moniker to bind to the object it identifies. - -Args: - - bindCtx(Any):bind context object to be used. - moniker(Any):If the moniker is part of a composite moniker, otherwise None - iidResult(Any):IID of the result object. - -Returns: - - Any - - """ - ... - - def BindToStorage(self, bindCtx: Any, moniker: Any, iidResult: Any) -> Any: - """ - Retrieves an interface object to the storage that contains the - -object identified by the moniker. - -Args: - - bindCtx(Any):bind context object to be used. - moniker(Any):If the moniker is part of a composite moniker, otherwise None - iidResult(Any):IID of the result object. - -Returns: - - Any - - """ - ... - - def GetDisplayName(self, bindCtx: Any, moniker: Any) -> str: - """ - Gets the display name , which is a user-readable representation of this - -moniker. - -Args: - - bindCtx(Any):bind context object to be used. - moniker(Any):If the moniker is part of a composite moniker, otherwise None - -Returns: - - str - - """ - ... - - def ComposeWith(self, mkRight: Any, fOnlyIfNotGeneric: Any) -> Any: - """ - Combines the current moniker with another moniker, creating a new - -composite moniker. - -Args: - - mkRight(Any):The IMoniker interface on the moniker to compose onto the end of this moniker. - fOnlyIfNotGeneric(Any):If TRUE, the caller requires a non-generic composition, so the operation should proceed only if pmkRight is a moniker class that this moniker can compose with in some way other than forming a generic composite. If FALSE, the method can create a generic composite if necessary. - -Returns: - - Any - - """ - ... - - def Enum(self, fForward: Any = True) -> Any: - """ - Supplies an enumerator that can enumerate the components of a composite - -moniker. - -Args: - - fForward(Any):If TRUE, enumerates the monikers from left to right. If FALSE, enumerates from right to left. - -Returns: - - Any - - """ - ... - - def IsEqual(self, other: Any) -> Any: - """ - Compares this moniker with a specified moniker and indicates whether they are - -identical. - -Args: - - other(Any):The moniker to compare - -Returns: - - Any - - """ - ... - - def IsSystemMoniker(self) -> Any: - """ - Indicates whether this moniker is of one of the system-supplied moniker - -classes. - -Args: - - - -Returns: - - Any - - """ - ... - - def Hash(self) -> Any: - """ - Calculates a 32-bit integer using the internal state of the moniker. - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIMsgServiceAdmin: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetLastError(self, hr: Any, flags: Any) -> Any: - """ - Returns the last error code for the object. - -Args: - - hr(Any):Contains the error code generated in the previous method call. - flags(Any):Indicates for format for the output. - -Returns: - - Any - - """ - ... - - def CreateMsgService(self, serviceName: str, displayName: str, flags: Any, uiParam: Any = 0) -> None: - """ - Creates a message service. - -Args: - - serviceName(str):The name of the service. - displayName(str):Display name of the service, or None - flags(Any):A bitmask of flags that controls how the message service is installed. - uiParam(Any):A handle of the parent window for any dialog boxes or windows that this method displays. - -Returns: - - None - - """ - ... - - def ConfigureMsgService(self, iid: PyIID, ulUIParam: Any, ulFlags: Any, arg: list[Any]) -> None: - """ - Reconfigures a message service. - -Args: - - iid(PyIID):The unique identifier for the message service to configure. - ulUIParam(Any):Handle of the parent window for the configuration property sheet. - ulFlags(Any):Bitmask of flags that controls the display of the property sheet. - arg(list[Any]):Property values describing the properties to display in the property sheet. Should not be None if the service is to be configured without a message service. - -Returns: - - None - - """ - ... - - def GetMsgServiceTable(self, flags: Any) -> Any: - """ - Retrieves a table of services. - -Args: - - flags(Any): - -Returns: - - Any - - """ - ... - - def GetProviderTable(self, flags: Any) -> Any: - """ - Retrieves a table of service providers. - -Args: - - flags(Any): - -Returns: - - Any - - """ - ... - - def DeleteMsgService(self, uuid: PyIID) -> None: - """ - Deletes the specified service - -Args: - - uuid(PyIID):The ID of the service - -Returns: - - None - - """ - ... - - def RenameMsgService(self, uuid: PyIID, flags: Any, newName: str) -> None: - """ - Renames the specified service - -Args: - - uuid(PyIID):The ID of the service - flags(Any): - newName(str):The new name for the service.CommentsThis is deprecated, and there is no replacement referenced to use instead. - -Returns: - - None - - """ - ... - - def OpenProfileSection(self, uuid: PyIID, iid: PyIID, flags: Any) -> Any: - """ - Opens a profile section - -Args: - - uuid(PyIID):The ID of the service - iid(PyIID):The IID of the resulting object, or None for the default - flags(Any): - -Returns: - - Any - - """ - ... - - def AdminProviders(self, uuid: PyIID, flags: Any) -> Any: - """ - Returns an object providing access - -to a provider administration object. - -Args: - - uuid(PyIID):The ID of the service - flags(Any): - -Returns: - - Any - - """ - ... - - -class PyIMsgStore: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def OpenEntry(self, entryId: str, iid: PyIID, flags: Any) -> Any: - """ - Opens a folder or message and returns an interface object for further access. - -Args: - - entryId(str):The entryID of the object - iid(PyIID):The IID of the object to return, or None for the default IID - flags(Any):Bitmask of flags that controls how the object is opened. - -Returns: - - Any - - """ - ... - - def GetReceiveFolder(self, messageClass: str = None, flags: Any = 0) -> tuple[PyIID, str]: - """ - Obtains the folder that was established as the destination for incoming messages of a specified message class or the default receive folder for the message store. - -Args: - - messageClass(str):Message class that is associated with a receive folder. If this parameter is set to None or an empty string, GetReceiveFolder returns the default receive folder for the message store. - flags(Any): - -Returns: - - tuple[PyIID, str] - - """ - ... - - def GetReceiveFolderTable(self, flags: Any) -> Any: - """ - provides access to the receive folder table, a table that includes information about all of the receive folders for the message store. - -Args: - - flags(Any):Bitmask of flags that controls table access - -Returns: - - Any - - """ - ... - - def CompareEntryIDs(self, entryId: str, entryId1: str, flags: Any = 0) -> Any: - """ - Compares two entry identifiers belonging to a particular address book provider to determine if they refer to the same address book object - -Args: - - entryId(str):The first entry ID to be compared - entryId1(str):The second entry ID to be compared - flags(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. - -Returns: - - 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. - - - """ - ... - - def GetLastError(self, hr: Any, flags: Any) -> Any: - """ - Returns the last error code for the object. - -Args: - - hr(Any):Contains the error code generated in the previous method call. - flags(Any):Indicates for format for the output. - -Returns: - - Any - - """ - ... - - def AbortSubmit(self, entryId: str, flags: Any = 0) -> Any: - """ - Attempts to remove a message from the outgoing queue. - -Args: - - entryId(str):The entry ID of the item to be aborted. - flags(Any):Reserved - must be zero. - -Returns: - - Any - - """ - ... - - def Advise(self, entryId: str, eventMask: Any, adviseSink: Any) -> None: - """ - Registers to receive notification of specified events that affect the message store. - -Args: - - entryId(str):entry identifier of the folder or message about which notifications should be generated, or None - eventMask(Any):A mask of values that indicate the types of notification events. - adviseSink(Any):An advise sink. - -Returns: - - None - - """ - ... - - def Unadvise(self, connection: Any) -> None: - """ - Cancels the sending of notifications previously set up with a call to the IMsgStore::Advise method. - -Args: - - connection(Any):Connection number returned from PyIMsgStore::Advise - -Returns: - - None - - """ - ... - - -class PyINameSpaceTreeControl: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Initialize(self, hwndParent: Any, prc: tuple[Any, Any, Any, Any], nsctsFlags: Any) -> None: - """ - Description of Initialize. - -Args: - - hwndParent(Any):Description for hwndParent - prc(tuple[Any, Any, Any, Any]):Description for prc - nsctsFlags(Any):Description for nsctsFlags - -Returns: - - None - - """ - ... - - def TreeAdvise(self, punk: Any) -> None: - """ - Description of TreeAdvise. - -Args: - - punk(Any):Description for punk - -Returns: - - None - - """ - ... - - def TreeUnadvise(self, dwCookie: Any) -> None: - """ - Description of TreeUnadvise. - -Args: - - dwCookie(Any):Description for dwCookie - -Returns: - - None - - """ - ... - - def AppendRoot(self, psiRoot: Any, grfEnumFlags: Any, grfRootStyle: Any, pif: Any) -> None: - """ - Description of AppendRoot. - -Args: - - psiRoot(Any):Description for psiRoot - grfEnumFlags(Any):Description for grfEnumFlags - grfRootStyle(Any):Description for grfRootStyle - pif(Any):Description for pif - -Returns: - - None - - """ - ... - - def InsertRoot(self, iIndex: Any, psiRoot: Any, grfEnumFlags: Any, grfRootStyle: Any, pif: Any) -> None: - """ - Description of InsertRoot. - -Args: - - iIndex(Any):Description for iIndex - psiRoot(Any):Description for psiRoot - grfEnumFlags(Any):Description for grfEnumFlags - grfRootStyle(Any):Description for grfRootStyle - pif(Any):Description for pif - -Returns: - - None - - """ - ... - - def RemoveRoot(self, psiRoot: Any) -> None: - """ - Description of RemoveRoot. - -Args: - - psiRoot(Any):Description for psiRoot - -Returns: - - None - - """ - ... - - def RemoveAllRoots(self) -> None: - """ - Description of RemoveAllRoots. - -Args: - - - -Returns: - - None - - """ - ... - - def GetRootItems(self) -> None: - """ - Description of GetRootItems. - -Args: - - - -Returns: - - None - - """ - ... - - def SetItemState(self, psi: Any, nstcisMask: Any, nstcisFlags: Any) -> None: - """ - Description of SetItemState. - -Args: - - psi(Any):Description for psi - nstcisMask(Any):Description for nstcisMask - nstcisFlags(Any):Description for nstcisFlags - -Returns: - - None - - """ - ... - - def GetItemState(self, psi: Any, nstcisMask: Any) -> None: - """ - Description of GetItemState. - -Args: - - psi(Any):Description for psi - nstcisMask(Any):Description for nstcisMask - -Returns: - - None - - """ - ... - - def GetSelectedItems(self) -> None: - """ - Description of GetSelectedItems. - -Args: - - - -Returns: - - None - - """ - ... - - def GetItemCustomState(self, psi: Any) -> None: - """ - Description of GetItemCustomState. - -Args: - - psi(Any):Description for psi - -Returns: - - None - - """ - ... - - def SetItemCustomState(self, psi: Any, iStateNumber: Any) -> None: - """ - Description of SetItemCustomState. - -Args: - - psi(Any):Description for psi - iStateNumber(Any):Description for iStateNumber - -Returns: - - None - - """ - ... - - def EnsureItemVisible(self, psi: Any) -> None: - """ - Description of EnsureItemVisible. - -Args: - - psi(Any):Description for psi - -Returns: - - None - - """ - ... - - def SetTheme(self, pszTheme: Any) -> None: - """ - Description of SetTheme. - -Args: - - pszTheme(Any):Description for pszTheme - -Returns: - - None - - """ - ... - - def GetNextItem(self, psi: Any, nstcgi: Any) -> None: - """ - Description of GetNextItem. - -Args: - - psi(Any):Description for psi - nstcgi(Any):Description for nstcgi - -Returns: - - None - - """ - ... - - def HitTest(self, pt: tuple[Any, Any]) -> None: - """ - Description of HitTest. - -Args: - - pt(tuple[Any, Any]):Description for ppt - -Returns: - - None - - """ - ... - - def GetItemRect(self) -> None: - """ - Description of GetItemRect. - -Args: - - - -Returns: - - None - - """ - ... - - def CollapseAll(self) -> None: - """ - Description of CollapseAll. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyINamedPropertyStore: - """Contains a collection of properties indentified by name""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetNamedValue(self, Name: Any) -> Any: - """ - Retrieves a property value by name - -Args: - - Name(Any):Name of the property - -Returns: - - Any - - """ - ... - - def SetNamedValue(self, propvar: Any) -> None: - """ - Sets the value of a property - -Args: - - propvar(Any):Description for propvar - -Returns: - - None - - """ - ... - - def GetNameCount(self) -> Any: - """ - Retrieves the number of named properties in the store - -Args: - - - -Returns: - - Any - - """ - ... - - def GetNameAt(self, Index: Any) -> Any: - """ - Retrieves a property name by zero-based index - -Args: - - Index(Any):Index of the property name - -Returns: - - Any - - """ - ... - - -class PyIObjectArray: - """Holds a collection of interface objects""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetCount(self) -> Any: - """ - Returns number of objects in collection - -Args: - - - -Returns: - - Any - - """ - ... - - def GetAt(self, Index: Any, riid: PyIID) -> Any: - """ - Retrieves an item by zero-based index - -Args: - - Index(Any):Index of item to retrieve - riid(PyIID):The interface to return - -Returns: - - Any - - """ - ... - - -class PyIObjectCollection: - """Modifiable container for a number of IUnknown objects""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def AddObject(self, punk: Any) -> None: - """ - Adds a single object to the collection - -Args: - - punk(Any):Object to be added - -Returns: - - None - - """ - ... - - def AddFromArray(self, Source: Any) -> None: - """ - None - -Args: - - Source(Any):Objects to be added to the collection - -Returns: - - None - - """ - ... - - def RemoveObjectAt(self, Index: Any) -> None: - """ - Removes a single object from the collection - -Args: - - Index(Any):Zero-based index of item to remove - -Returns: - - None - - """ - ... - - def Clear(self) -> None: - """ - Empties the container. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIObjectWithPropertyKey: - """Interface implemented by objects that have an associated property id""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def SetPropertyKey(self, key: Any) -> None: - """ - Sets the property id - -Args: - - key(Any):The identifier of the property - -Returns: - - None - - """ - ... - - def GetPropertyKey(self) -> Any: - """ - Returns the property id - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIObjectWithSite: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def SetSite(self, pUnkSite: Any) -> None: - """ - Description of SetSite. - -Args: - - pUnkSite(Any):Description for pUnkSite - -Returns: - - None - - """ - ... - - def GetSite(self, riid: PyIID) -> None: - """ - Description of GetSite. - -Args: - - riid(PyIID):Description for riid - -Returns: - - None - - """ - ... - - -class PyIOleClientSite: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def SaveObject(self) -> None: - """ - Description of SaveObject. - -Args: - - - -Returns: - - None - - """ - ... - - def GetMoniker(self, dwAssign: Any, dwWhichMoniker: Any) -> None: - """ - Description of GetMoniker. - -Args: - - dwAssign(Any):Description for dwAssign - dwWhichMoniker(Any):Description for dwWhichMoniker - -Returns: - - None - - """ - ... - - def GetContainer(self) -> None: - """ - Description of GetContainer. - -Args: - - - -Returns: - - None - - """ - ... - - def ShowObject(self) -> None: - """ - Description of ShowObject. - -Args: - - - -Returns: - - None - - """ - ... - - def OnShowWindow(self, fShow: Any) -> None: - """ - Description of OnShowWindow. - -Args: - - fShow(Any):Description for fShow - -Returns: - - None - - """ - ... - - def RequestNewObjectLayout(self) -> None: - """ - Description of RequestNewObjectLayout. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIOleCommandTarget: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def QueryStatus(self) -> None: - """ - Description of QueryStatus. - -Args: - - - -Returns: - - None - - """ - ... - - def Exec(self) -> None: - """ - Description of Exec. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIOleControl: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetControlInfo(self) -> None: - """ - Description of GetControlInfo. - -Args: - - - -Returns: - - None - - """ - ... - - def OnMnemonic(self, msg: Any) -> None: - """ - Description of OnMnemonic. - -Args: - - msg(Any):A tuple representing a MSG structure. - -Returns: - - None - - """ - ... - - def OnAmbientPropertyChange(self, dispID: Any) -> None: - """ - Description of OnAmbientPropertyChange. - -Args: - - dispID(Any):Description for dispID - -Returns: - - None - - """ - ... - - def FreezeEvents(self, bFreeze: Any) -> None: - """ - Description of FreezeEvents. - -Args: - - bFreeze(Any):Description for bFreeze - -Returns: - - None - - """ - ... - - -class PyIOleControlSite: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def OnControlInfoChanged(self) -> None: - """ - Description of OnControlInfoChanged. - -Args: - - - -Returns: - - None - - """ - ... - - def LockInPlaceActive(self, fLock: Any) -> None: - """ - Description of LockInPlaceActive. - -Args: - - fLock(Any):Description for fLock - -Returns: - - None - - """ - ... - - def GetExtendedControl(self) -> None: - """ - Description of GetExtendedControl. - -Args: - - - -Returns: - - None - - """ - ... - - def TransformCoords( - self, - PtlHimetric: tuple[Any, Any], - pPtfContainer: tuple[float, float], - dwFlags: Any) -> None: - """ - Description of TransformCoords. - -Args: - - PtlHimetric(tuple[Any, Any]):Description for pPtlHimetric - pPtfContainer(tuple[float, float]):Description for pPtfContainer - dwFlags(Any):Description for dwFlagsReturn ValueThe result is a tuple of the transformed input points - ie, a tuple of ((int, int), (float, float)) - -Returns: - - None:Description for dwFlagsReturn ValueThe result is a tuple of the transformed input points - ie, - -a tuple of ((int, int), (float, float)) - - - """ - ... - - def TranslateAccelerator(self, pMsg: PyMSG, grfModifiers: Any) -> None: - """ - Description of TranslateAccelerator. - -Args: - - pMsg(PyMSG):Description for pMsg - grfModifiers(Any):Description for grfModifiers - -Returns: - - None - - """ - ... - - def OnFocus(self, fGotFocus: Any) -> None: - """ - Description of OnFocus. - -Args: - - fGotFocus(Any):Description for fGotFocus - -Returns: - - None - - """ - ... - - def ShowPropertyFrame(self) -> None: - """ - Description of ShowPropertyFrame. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIOleInPlaceActiveObject: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def TranslateAccelerator(self, lpmsg: PyMSG) -> None: - """ - Description of TranslateAccelerator. - -Args: - - lpmsg(PyMSG):Description for lpmsg - -Returns: - - None - - """ - ... - - def OnFrameWindowActivate(self, fActivate: Any) -> None: - """ - Description of OnFrameWindowActivate. - -Args: - - fActivate(Any):Description for fActivate - -Returns: - - None - - """ - ... - - def OnDocWindowActivate(self, fActivate: Any) -> None: - """ - Description of OnDocWindowActivate. - -Args: - - fActivate(Any):Description for fActivate - -Returns: - - None - - """ - ... - - def ResizeBorder(self, rcBorder: tuple[Any, Any, Any, Any], pUIWindow: Any, fFrameWindow: Any) -> None: - """ - Description of ResizeBorder. - -Args: - - rcBorder(tuple[Any, Any, Any, Any]):Description for prcBorder - pUIWindow(Any):Description for pUIWindow - fFrameWindow(Any):Description for fFrameWindow - -Returns: - - None - - """ - ... - - def EnableModeless(self, fEnable: Any) -> None: - """ - Description of EnableModeless. - -Args: - - fEnable(Any):Description for fEnable - -Returns: - - None - - """ - ... - - -class PyIOleInPlaceFrame: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def InsertMenus(self, hmenuShared: Any, menuWidths: Any) -> None: - """ - Description of InsertMenus. - -Args: - - hmenuShared(Any):Description for hmenuShared - menuWidths(Any): - -Returns: - - None - - """ - ... - - def SetMenu(self, hmenuShared: Any, holemenu: Any, hwndActiveObject: Any) -> None: - """ - Description of SetMenu. - -Args: - - hmenuShared(Any):Description for hmenuShared - holemenu(Any):Description for holemenu - hwndActiveObject(Any):Description for hwndActiveObject - -Returns: - - None - - """ - ... - - def RemoveMenus(self, hmenuShared: Any) -> None: - """ - Description of RemoveMenus. - -Args: - - hmenuShared(Any):Description for hmenuShared - -Returns: - - None - - """ - ... - - def SetStatusText(self, pszStatusText: Any) -> None: - """ - Description of SetStatusText. - -Args: - - pszStatusText(Any):Description for pszStatusText - -Returns: - - None - - """ - ... - - def EnableModeless(self, fEnable: Any) -> None: - """ - Description of EnableModeless. - -Args: - - fEnable(Any):Description for fEnable - -Returns: - - None - - """ - ... - - def TranslateAccelerator(self, lpmsg: PyMSG, wID: Any) -> None: - """ - Description of TranslateAccelerator. - -Args: - - lpmsg(PyMSG):Description for lpmsg - wID(Any):Description for wID - -Returns: - - None - - """ - ... - - -class PyIOleInPlaceObject: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def InPlaceDeactivate(self) -> None: - """ - Description of InPlaceDeactivate. - -Args: - - - -Returns: - - None - - """ - ... - - def UIDeactivate(self) -> None: - """ - Description of UIDeactivate. - -Args: - - - -Returns: - - None - - """ - ... - - def SetObjectRects(self) -> None: - """ - Description of SetObjectRects. - -Args: - - - -Returns: - - None - - """ - ... - - def ReactivateAndUndo(self) -> None: - """ - Description of ReactivateAndUndo. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIOleInPlaceSite: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CanInPlaceActivate(self) -> None: - """ - Description of CanInPlaceActivate. - -Args: - - - -Returns: - - None - - """ - ... - - def OnInPlaceActivate(self) -> None: - """ - Description of OnInPlaceActivate. - -Args: - - - -Returns: - - None - - """ - ... - - def OnUIActivate(self) -> None: - """ - Description of OnUIActivate. - -Args: - - - -Returns: - - None - - """ - ... - - def GetWindowContext(self) -> None: - """ - Description of GetWindowContext. - -Args: - - - -Returns: - - None - - """ - ... - - def Scroll(self) -> None: - """ - Description of Scroll. - -Args: - - - -Returns: - - None - - """ - ... - - def OnUIDeactivate(self, fUndoable: Any) -> None: - """ - Description of OnUIDeactivate. - -Args: - - fUndoable(Any):Description for fUndoable - -Returns: - - None - - """ - ... - - def OnInPlaceDeactivate(self) -> None: - """ - Description of OnInPlaceDeactivate. - -Args: - - - -Returns: - - None - - """ - ... - - def DiscardUndoState(self) -> None: - """ - Description of DiscardUndoState. - -Args: - - - -Returns: - - None - - """ - ... - - def DeactivateAndUndo(self) -> None: - """ - Description of DeactivateAndUndo. - -Args: - - - -Returns: - - None - - """ - ... - - def OnPosRectChange(self) -> None: - """ - Description of OnPosRectChange. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIOleInPlaceSiteEx: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def OnInPlaceActivateEx(self, dwFlags: Any) -> None: - """ - Description of OnInPlaceActivateEx. - -Args: - - dwFlags(Any):Description for dwFlags - -Returns: - - None - - """ - ... - - def OnInPlaceDeactivateEx(self, fNoRedraw: Any) -> None: - """ - Description of OnInPlaceDeactivateEx. - -Args: - - fNoRedraw(Any):Description for fNoRedraw - -Returns: - - None - - """ - ... - - def RequestUIActivate(self) -> None: - """ - Description of RequestUIActivate. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIOleInPlaceSiteWindowless: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CanWindowlessActivate(self) -> None: - """ - Description of CanWindowlessActivate. - -Args: - - - -Returns: - - None - - """ - ... - - def GetCapture(self) -> None: - """ - Description of GetCapture. - -Args: - - - -Returns: - - None - - """ - ... - - def SetCapture(self, fCapture: Any) -> None: - """ - Description of SetCapture. - -Args: - - fCapture(Any):Description for fCapture - -Returns: - - None - - """ - ... - - def GetFocus(self) -> None: - """ - Description of GetFocus. - -Args: - - - -Returns: - - None - - """ - ... - - def SetFocus(self, fFocus: Any) -> None: - """ - Description of SetFocus. - -Args: - - fFocus(Any):Description for fFocus - -Returns: - - None - - """ - ... - - def GetDC(self, grfFlags: Any, rect: tuple[Any, Any, Any, Any]) -> None: - """ - Description of GetDC. - -Args: - - grfFlags(Any):Description for grfFlags - rect(tuple[Any, Any, Any, Any]): - -Returns: - - None - - """ - ... - - def ReleaseDC(self, hDC: Any) -> None: - """ - Description of ReleaseDC. - -Args: - - hDC(Any):Description for hDC - -Returns: - - None - - """ - ... - - def InvalidateRect(self, rect: tuple[Any, Any, Any, Any], fErase: Any) -> None: - """ - Description of InvalidateRect. - -Args: - - rect(tuple[Any, Any, Any, Any]): - fErase(Any):Description for fErase - -Returns: - - None - - """ - ... - - def InvalidateRgn(self, hRgn: Any, fErase: Any) -> None: - """ - Description of InvalidateRgn. - -Args: - - hRgn(Any):Handle to a region - fErase(Any):Description for fErase - -Returns: - - None - - """ - ... - - def ScrollRect(self, dx: Any, dy: Any) -> None: - """ - Description of ScrollRect. - -Args: - - dx(Any):Description for dx - dy(Any):Description for dy - -Returns: - - None - - """ - ... - - def AdjustRect(self) -> None: - """ - Description of AdjustRect. - -Args: - - - -Returns: - - None - - """ - ... - - def OnDefWindowMessage(self, msg: Any, wParam: Any, lParam: Any) -> None: - """ - Description of OnDefWindowMessage. - -Args: - - msg(Any):Description for msg - wParam(Any):Description for wParam - lParam(Any):Description for lParam - -Returns: - - None - - """ - ... - - -class PyIOleInPlaceUIWindow: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetBorder(self) -> None: - """ - Description of GetBorder. - -Args: - - - -Returns: - - None - - """ - ... - - def RequestBorderSpace(self, borderwidths: tuple[Any, Any, Any, Any]) -> None: - """ - Description of RequestBorderSpace. - -Args: - - borderwidths(tuple[Any, Any, Any, Any]):Description for pborderwidths - -Returns: - - None - - """ - ... - - def SetBorderSpace(self, borderwidths: tuple[Any, Any, Any, Any]) -> None: - """ - Description of SetBorderSpace. - -Args: - - borderwidths(tuple[Any, Any, Any, Any]):Description for pborderwidths - -Returns: - - None - - """ - ... - - def SetActiveObject(self, pActiveObject: Any, pszObjName: Any) -> None: - """ - Description of SetActiveObject. - -Args: - - pActiveObject(Any):Description for pActiveObject - pszObjName(Any):Description for pszObjName - -Returns: - - None - - """ - ... - - -class PyIOleObject: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def SetClientSite(self, pClientSite: Any) -> None: - """ - Description of SetClientSite. - -Args: - - pClientSite(Any):Description for pClientSite - -Returns: - - None - - """ - ... - - def GetClientSite(self) -> None: - """ - Description of GetClientSite. - -Args: - - - -Returns: - - None - - """ - ... - - def SetHostNames(self, szContainerApp: Any, szContainerObj: Any) -> None: - """ - Description of SetHostNames. - -Args: - - szContainerApp(Any):Description for szContainerApp - szContainerObj(Any):Description for szContainerObj - -Returns: - - None - - """ - ... - - def Close(self, dwSaveOption: Any) -> None: - """ - Description of Close. - -Args: - - dwSaveOption(Any):Description for dwSaveOption - -Returns: - - None - - """ - ... - - def SetMoniker(self, dwWhichMoniker: Any, pmk: Any) -> None: - """ - Description of SetMoniker. - -Args: - - dwWhichMoniker(Any):Description for dwWhichMoniker - pmk(Any):Description for pmk - -Returns: - - None - - """ - ... - - def GetMoniker(self, dwAssign: Any, dwWhichMoniker: Any) -> None: - """ - Description of GetMoniker. - -Args: - - dwAssign(Any):Description for dwAssign - dwWhichMoniker(Any):Description for dwWhichMoniker - -Returns: - - None - - """ - ... - - def InitFromData(self, pDataObject: Any, fCreation: Any, dwReserved: Any) -> None: - """ - Description of InitFromData. - -Args: - - pDataObject(Any):Description for pDataObject - fCreation(Any):Description for fCreation - dwReserved(Any):Description for dwReserved - -Returns: - - None - - """ - ... - - def GetClipboardData(self, dwReserved: Any) -> None: - """ - Description of GetClipboardData. - -Args: - - dwReserved(Any):Description for dwReserved - -Returns: - - None - - """ - ... - - def DoVerb(self, iVerb: Any, msg: PyMSG, pActiveSite: Any, lindex: Any, - hwndParent: Any, rect: tuple[Any, Any, Any, Any]) -> None: - """ - Description of DoVerb. - -Args: - - iVerb(Any):Description for iVerb - msg(PyMSG):MSG tuple, a-la win32gui etc. - pActiveSite(Any):Description for pActiveSite - lindex(Any):Description for lindex - hwndParent(Any):Description for hwndParent - rect(tuple[Any, Any, Any, Any]): - -Returns: - - None - - """ - ... - - def EnumVerbs(self) -> None: - """ - Description of EnumVerbs. - -Args: - - - -Returns: - - None - - """ - ... - - def Update(self) -> None: - """ - Description of Update. - -Args: - - - -Returns: - - None - - """ - ... - - def IsUpToDate(self) -> None: - """ - Description of IsUpToDate. - -Args: - - - -Returns: - - None - - """ - ... - - def GetUserClassID(self) -> None: - """ - Description of GetUserClassID. - -Args: - - - -Returns: - - None - - """ - ... - - def GetUserType(self, dwFormOfType: Any) -> None: - """ - Description of GetUserType. - -Args: - - dwFormOfType(Any):Description for dwFormOfType - -Returns: - - None - - """ - ... - - def SetExtent(self, dwDrawAspect: Any, size: tuple[Any, Any]) -> None: - """ - Description of SetExtent. - -Args: - - dwDrawAspect(Any):Description for dwDrawAspect - size(tuple[Any, Any]):Size limit for the object. - -Returns: - - None - - """ - ... - - def GetExtent(self, dwDrawAspect: Any, size: tuple[Any, Any]) -> None: - """ - Description of GetExtent. - -Args: - - dwDrawAspect(Any):Description for dwDrawAspect - size(tuple[Any, Any]):Size limit for the object. - -Returns: - - None - - """ - ... - - def Advise(self, pAdvSink: Any) -> None: - """ - Description of Advise. - -Args: - - pAdvSink(Any):Description for pAdvSink - -Returns: - - None - - """ - ... - - def Unadvise(self, dwConnection: Any) -> None: - """ - Description of Unadvise. - -Args: - - dwConnection(Any):Description for dwConnection - -Returns: - - None - - """ - ... - - def EnumAdvise(self) -> None: - """ - Description of EnumAdvise. - -Args: - - - -Returns: - - None - - """ - ... - - def GetMiscStatus(self, dwAspect: Any) -> None: - """ - Description of GetMiscStatus. - -Args: - - dwAspect(Any):Description for dwAspect - -Returns: - - None - - """ - ... - - def SetColorScheme(self) -> None: - """ - Description of SetColorScheme. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIOleWindow: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetWindow(self) -> None: - """ - Description of GetWindow. - -Args: - - - -Returns: - - None - - """ - ... - - def ContextSensitiveHelp(self, fEnterMode: Any) -> None: - """ - Description of ContextSensitiveHelp. - -Args: - - fEnterMode(Any):Description for fEnterMode - -Returns: - - None - - """ - ... - - -class PyIPersist: - """A Python interface to IPersist""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetClassID(self) -> PyIID: - """ - Returns the class identifier (CLSID) for the component object. - -Args: - - - -Returns: - - PyIID - - """ - ... - - -class PyIPersistFile: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def IsDirty(self) -> None: - """ - Checks an object for changes since it was last saved to its current file. - -Args: - - - -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. - -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. - - - """ - ... - - def Load(self, FileName: Any, Mode: Any) -> None: - """ - Opens the specified file and initializes an object from the file contents. - -Args: - - FileName(Any):Absolute path of the file to open - Mode(Any):Specifies the access mode from the STGM enumeration. - -Returns: - - None - - """ - ... - - def Save(self, FileName: Any, fRemember: Any) -> None: - """ - Saves the object into the specified file. - -Args: - - FileName(Any):absolute path of the file where the object is saved. - fRemember(Any):Specifies whether the file is to be the current working file or not. - -Returns: - - None - - """ - ... - - def SaveCompleted(self, FileName: Any) -> None: - """ - Notifies the object that it can revert from NoScribble mode to Normal mode. - -Args: - - FileName(Any):Absolute path of the file where the object was saved. - -Returns: - - None - - """ - ... - - def GetCurFile(self) -> Any: - """ - Gets the current name of the file associated with the object. - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIPersistFolder: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Initialize(self, pidl: Any) -> None: - """ - Description of Initialize. - -Args: - - pidl(Any):Description for pidl - -Returns: - - None - - """ - ... - - -class PyIPersistFolder2: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetCurFolder(self) -> None: - """ - Description of GetCurFolder. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIPersistPropertyBag: - """A Python wrapper for a COM IPersistPropertyBag interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def InitNew(self) -> None: - """ - Called by the container when the control is initialized to initialize the - -property bag. - -Args: - - - -Returns: - - None - - """ - ... - - def Load(self, bag: Any, log: Any = None) -> None: - """ - Called by the container to load the control's properties. - -Args: - - bag(Any):the caller's property bag. - log(Any):the caller's error log, or None - -Returns: - - None - - """ - ... - - def Save(self, bag: Any, clearDirty: Any, saveProperties: Any) -> None: - """ - Called by the container to save the object's properties. - -Args: - - bag(Any):the caller's property bag. - clearDirty(Any):Specifies whether to clear the dirty flag. - saveProperties(Any):Specifies whether to save all properties or just those that have changed - -Returns: - - None - - """ - ... - - -class PyIPersistSerializedPropStorage: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def SetFlags(self, flags: Any) -> None: - """ - Sets flags for the store - -Args: - - flags(Any):Combination of pscon.FPSPS_* values - -Returns: - - None - - """ - ... - - def SetPropertyStorage(self, ps: Any) -> None: - """ - Initializes the store with a serialized buffer - -Args: - - ps(Any):Bytes or buffer object containing a serialized property store - -Returns: - - None - - """ - ... - - def GetPropertyStorage(self) -> Any: - """ - Retrieves the current contents of the property - -store - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIPersistStorage: - """A Python wrapper of a COM IPersistStorage interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def IsDirty(self) -> Any: - """ - Checks the object for changes since it was last saved. - -Args: - - - -Returns: - - Any - - """ - ... - - def InitNew(self, PyIStorage: Any) -> None: - """ - Initializes a new object, providing a storage object to be used for the object. - -Args: - - PyIStorage(Any):PyIStorage for the new storage object to be initialized. The container creates a nested storage object in its storage object (see PyIStorage::CreateStorage). Then, the container calls the PyIPersistStorage::WriteClassStg function to initialize the new storage object with the object class identifier (CLSID). - -Returns: - - None - - """ - ... - - def Load(self, storage: Any) -> None: - """ - Loads an object from its existing storage. - -Args: - - storage(Any):Existing storage for the object. - -Returns: - - None - - """ - ... - - def Save(self, PyIStorage: Any, _int: Any) -> None: - """ - None - -Args: - - PyIStorage(Any):Storage for the object - _int(Any):Indicates whether the specified storage object is the current one. This parameter is set to FALSE when performing a Save As or Save A Copy To operation or when performing a full save. In the latter case, this method saves to a temporary file, deletes the original file, and renames the temporary file. This parameter is set to TRUE to perform a full save in a low-memory situation or to perform a fast incremental save in which only the dirty components are saved. - -Returns: - - None - - """ - ... - - def SaveCompleted(self, PyIStorage: Any) -> None: - """ - None - -Args: - - PyIStorage(Any):The current storage object - -Returns: - - None - - """ - ... - - def HandsOffStorage(self) -> None: - """ - 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 - -operation that works is a close operation. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIPersistStream: - """A Python interface to IPersistStream""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def IsDirty(self) -> Any: - """ - Checks the object for changes since it was last saved. - -Args: - - - -Returns: - - Any - - """ - ... - - def Load(self, stream: Any) -> None: - """ - Initializes an object from the stream where it was previously saved. - -Args: - - stream(Any):Stream object to load from.CommentsThis method loads an object from its associated stream. The seek pointer is set as it was in the most recent PyIPersistStream::Save method. This method can seek and read from the stream, but cannot write to it.On exit, the seek pointer must be in the same position it was in on entry, immediately past the end of the data. - -Returns: - - None - - """ - ... - - def Save(self, stream: Any, bClearDirty: Any) -> None: - """ - Saves an object to the specified stream. - -Args: - - stream(Any):The stream to save to. - bClearDirty(Any):Indicates whether to clear the dirty flag after the save is complete - -Returns: - - None - - """ - ... - - def GetSizeMax(self) -> ULARGE_INTEGER: - """ - Returns the size in bytes of the stream needed to save the - -object. - -Args: - - - -Returns: - - ULARGE_INTEGER - - """ - ... - - -class PyIPersistStreamInit: - """A Python interface to IPersistStreamInit""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def InitNew(self) -> None: - """ - Initializes the object to a default state. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIProcessDebugManager: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CreateApplication(self) -> None: - """ - Description of CreateApplication. - -Args: - - - -Returns: - - None - - """ - ... - - def GetDefaultApplication(self) -> None: - """ - Description of GetDefaultApplication. - -Args: - - - -Returns: - - None - - """ - ... - - def AddApplication(self, pda: Any) -> None: - """ - Description of AddApplication. - -Args: - - pda(Any):Description for pda - -Returns: - - None - - """ - ... - - def RemoveApplication(self, dwAppCookie: Any) -> None: - """ - Description of RemoveApplication. - -Args: - - dwAppCookie(Any):Description for dwAppCookie - -Returns: - - None - - """ - ... - - def CreateDebugDocumentHelper(self, unkOuter: Any) -> None: - """ - Description of CreateDebugDocumentHelper. - -Args: - - unkOuter(Any):The outer object for aggregation, or (usually!) None - -Returns: - - None - - """ - ... - - -class PyIProfAdmin: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetLastError(self, hr: Any, flags: Any) -> Any: - """ - Returns the last error code for the object. - -Args: - - hr(Any):Contains the error code generated in the previous method call. - flags(Any):Indicates for format for the output. - -Returns: - - Any - - """ - ... - - def CreateProfile(self, oldProfileName: str, password: str, uiParam: Any = 0, flags: Any = 0) -> None: - """ - Creates a new profile. - -Args: - - oldProfileName(str):The name of the new profile. - password(str):Must be None - uiParam(Any):A handle of the parent window for any dialog boxes or windows that this method displays. - flags(Any): - -Returns: - - None - - """ - ... - - def DeleteProfile(self, oldProfileName: str, flags: Any = 0) -> None: - """ - Deletes a profile. - -Args: - - oldProfileName(str):The name of the profile to be deleted. - flags(Any): - -Returns: - - None - - """ - ... - - def CopyProfile( - self, - oldProfileName: str, - password: str, - newProfileName: str, - uiParam: Any = 0, - flags: Any = 0) -> None: - """ - Copies a profile. - -Args: - - oldProfileName(str):The name of the profile to copy. - password(str):Must be None - newProfileName(str):The new name of the copied profile. - uiParam(Any):A handle of the parent window for any dialog boxes or windows that this method displays. - flags(Any): - -Returns: - - None - - """ - ... - - def RenameProfile( - self, - oldProfileName: str, - password: str, - newProfileName: str, - uiParam: Any = 0, - flags: Any = 0) -> None: - """ - Assigns a new name to a profile. - -Args: - - oldProfileName(str):The current name of the profile to rename. - password(str):Must be None - newProfileName(str):The new name of the profile to rename. - uiParam(Any):A handle of the parent window for any dialog boxes or windows that this method displays. - flags(Any): - -Returns: - - None - - """ - ... - - def SetDefaultProfile(self, profileName: str, flags: Any = 0) -> None: - """ - Sets or clears a client's default profile. - -Args: - - profileName(str):The name of the profile that will become the default, or None. Setting profileName to None indicates that SetDefaultProfile should remove the existing default profile, leaving the client without a default. - flags(Any): - -Returns: - - None - - """ - ... - - def AdminServices(self, profileName: str, password: str = None, uiParam: Any = 0, flags: Any = 0) -> Any: - """ - Provides access to a message service administration object for making changes to the message services in a profile. - -Args: - - profileName(str):The name of the profile to be modified. - password(str): - uiParam(Any):A handle of the parent window for any dialog boxes or windows that this method displays. - flags(Any): - -Returns: - - Any - - """ - ... - - -class PyIPropertyBag: - """A Python wrapper for a COM IPropertyBag interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Read(self, propName: Any, propType: Any, errorLog: Any = None) -> Any: - """ - Called by the control to read a property from the storage provided by the - -container. - -Args: - - propName(Any):Name of the property to read. - propType(Any):The type of the object to read. Must be a VT_* Variant Type constant. - errorLog(Any):The caller's PyIErrorLog object in which the property bag stores any errors that occur during reads. Can be None in which case the caller is not interested in errors.CommentsThe result is a Python object, mapped from a COM VARIANT of type as specified in the propType parameter. - -Returns: - - Any - - """ - ... - - def Write(self, propName: Any, value: Any) -> None: - """ - Called by the control to write each property in turn to the storage provided by the - -container. - -Args: - - propName(Any):Name of the property to read. - value(Any):The value for the property. The value must be able to be converted to a COM VARIANT. - -Returns: - - None - - """ - ... - - -class PyIPropertyChange: - """Interface used to specify a change to a property""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def ApplyToPropVariant(self, OrigVal: Any) -> Any: - """ - Applies the change to a variant value - -Args: - - OrigVal(Any):The value to be modified - -Returns: - - Any - - """ - ... - - -class PyIPropertyChangeArray: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetCount(self) -> Any: - """ - Returns the number of changes in the array - -Args: - - - -Returns: - - Any - - """ - ... - - def GetAt(self, Index: Any, riid: PyIID) -> Any: - """ - Retrieves a change by zero-based index - -Args: - - Index(Any):Index of the change to retrieve - riid(PyIID):The interface to return - -Returns: - - Any - - """ - ... - - def InsertAt(self, Index: Any, PropChange: Any) -> None: - """ - Inserts a change at a specific position - -Args: - - Index(Any):Position at which to place the change - PropChange(Any):The change to be added - -Returns: - - None - - """ - ... - - def Append(self, PropChange: Any) -> None: - """ - Adds a change to the end of the array - -Args: - - PropChange(Any):The change to be added - -Returns: - - None - - """ - ... - - def AppendOrReplace(self, PropChange: Any) -> None: - """ - Adds a change, or replaces if an identical property key is already - -in container - -Args: - - PropChange(Any):The change to be added or replaced - -Returns: - - None - - """ - ... - - def RemoveAt(self, Index: Any) -> None: - """ - Removes a change from the array - -Args: - - Index(Any):Index of change to be removed - -Returns: - - None - - """ - ... - - def IsKeyInArray(self, key: Any) -> Any: - """ - Checks if array contains a change to a property - -Args: - - key(Any):Property key to look for - -Returns: - - Any - - """ - ... - - -class PyIPropertyDescription: - """Gives access to the details of a property definition""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetPropertyKey(self) -> Any: - """ - Returns the unique identifier for a property - -Args: - - - -Returns: - - Any - - """ - ... - - def GetCanonicalName(self) -> Any: - """ - Returns the name of the property - -Args: - - - -Returns: - - Any - - """ - ... - - def GetPropertyType(self) -> Any: - """ - Returns the variant type of the property (VT_*) - -Args: - - - -Returns: - - Any - - """ - ... - - def GetDisplayName(self) -> Any: - """ - Returns the property name as shown in the UI - -Args: - - - -Returns: - - Any - - """ - ... - - def GetEditInvitation(self) -> Any: - """ - Returns the input prompt used in edit controls - -Args: - - - -Returns: - - Any - - """ - ... - - def GetTypeFlags(self, mask: Any) -> Any: - """ - Returns type flags for the property - -Args: - - mask(Any):Specifies which flags to retrieve (PDTF_*) - -Returns: - - Any - - """ - ... - - def GetViewFlags(self) -> Any: - """ - Returns the view flags that control how the property is displayed - -(PDVF_*) - -Args: - - - -Returns: - - Any - - """ - ... - - def GetDefaultColumnWidth(self) -> Any: - """ - Returns the default width in characters - -Args: - - - -Returns: - - Any - - """ - ... - - def GetDisplayType(self) -> Any: - """ - Returns the display type (PDDT_*) - -Args: - - - -Returns: - - Any - - """ - ... - - def GetColumnState(self) -> Any: - """ - Returns flags that control how property is displayed in column - -(SHCOLSTATE_*) - -Args: - - - -Returns: - - Any - - """ - ... - - def GetGroupingRange(self) -> Any: - """ - Returns property's grouping attributes (PDGR_*) - -Args: - - - -Returns: - - Any - - """ - ... - - def GetRelativeDescriptionType(self) -> Any: - """ - Returns the relative description type (PDRDT_*) - -Args: - - - -Returns: - - Any - - """ - ... - - def GetRelativeDescription(self, var1: Any, var2: Any) -> tuple[Any, Any]: - """ - Compares two values - -Args: - - var1(Any):The first value - var2(Any):The second value - -Returns: - - tuple[Any, Any] - - """ - ... - - def GetSortDescription(self) -> Any: - """ - Returns value that determines how sorting options are - -displayed (PDSD_*) - -Args: - - - -Returns: - - Any - - """ - ... - - def GetSortDescriptionLabel(self, Descending: Any) -> Any: - """ - Returns description of current sort order - -Args: - - Descending(Any):Indicates if order is reversed - -Returns: - - Any - - """ - ... - - def GetAggregationType(self) -> Any: - """ - Describes how properties for multiple items are displayed - -(PDAT_*) - -Args: - - - -Returns: - - Any - - """ - ... - - def GetConditionType(self) -> tuple[Any, Any]: - """ - Returns options that determine how the property is used - -to build a search query - -Args: - - - -Returns: - - tuple[Any, Any]:PyIPropertyDescription.GetConditionType - -(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_*) - - - """ - ... - - def GetEnumTypeList(self, riid: PyIID) -> Any: - """ - Returns an interface used for querying - -valid property range - -Args: - - riid(PyIID):IID of the requested interface - -Returns: - - Any - - """ - ... - - def CoerceToCanonicalValue(self, Value: Any) -> Any: - """ - Converts a variant value to the exact type expected by - -the property - -Args: - - Value(Any):The property value to be convertedCommentsThis method mutates the PyPROPVARIANT in place. It may be cleared on failure.Return ValueReturns the HRESULT from the operation on success. - -Returns: - - Any:The property value to be convertedComments - -This method mutates the PyPROPVARIANT in place. It may be cleared on failure. -Return ValueReturns the HRESULT from the operation on success. - - - """ - ... - - def FormatForDisplay(self, Value: Any, Flags: Any) -> Any: - """ - Converts a value to its string representation - -Args: - - Value(Any):The value to be formatted - Flags(Any):Combination of PROPDESC_FORMAT_FLAGS (PDFF_*) - -Returns: - - Any - - """ - ... - - def IsValueCanonical(self, Value: Any) -> Any: - """ - Determines if a value exactly matches the specification for - -the property - -Args: - - Value(Any):The value to check - -Returns: - - Any - - """ - ... - - -class PyIPropertyDescriptionAliasInfo: - """Interface that gives access to the sorting columns for a property""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetSortByAlias(self, riid: PyIID) -> Any: - """ - Returns the primary column used - -for sorting - -Args: - - riid(PyIID):The interface to return - -Returns: - - Any - - """ - ... - - def GetAdditionalSortByAliases(self, riid: PyIID) -> Any: - """ - Returns secondary - -sorting columns - -Args: - - riid(PyIID):The interface to return - -Returns: - - Any - - """ - ... - - -class PyIPropertyDescriptionList: - """Container for a number of property descriptions""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetCount(self) -> Any: - """ - Gets the number of properties in the list - -Args: - - - -Returns: - - Any - - """ - ... - - def GetAt(self, Elem: Any, riid: PyIID) -> Any: - """ - Retrieves a description from the list - -Args: - - Elem(Any):Index of the element to return - riid(PyIID):The interface to return - -Returns: - - Any - - """ - ... - - -class PyIPropertyDescriptionSearchInfo: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetSearchInfoFlags(self) -> Any: - """ - Returns flags controlling how property is indexed - -Args: - - - -Returns: - - Any:PyIPropertyDescriptionSearchInfo.GetSearchInfoFlags - -int = GetSearchInfoFlags()Returns flags controlling how property is indexed -Return ValueReturns a combination of PROPDESC_SEARCHINFO_FLAGS values - - - """ - ... - - def GetColumnIndexType(self) -> Any: - """ - Returns flags indicating type of property - -Args: - - - -Returns: - - Any:PyIPropertyDescriptionSearchInfo.GetColumnIndexType - -int = GetColumnIndexType()Returns flags indicating type of property -Return ValueReturns a value from the PROPDESC_COLUMNINDEX_TYPE enum - - - """ - ... - - def GetProjectionString(self) -> Any: - """ - Returns the canonical name of the property - -Args: - - - -Returns: - - Any - - """ - ... - - def GetMaxSize(self) -> Any: - """ - Returns the maximum size specified in search options - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIPropertyEnumType: - """Contains information about an allowable value or range for a property""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetEnumType(self) -> Any: - """ - Retrieves the type (PROPENUMTYPE) - -Args: - - - -Returns: - - Any:PyIPropertyEnumType.GetEnumType - -int = GetEnumType()Retrieves the type (PROPENUMTYPE) -Return Valuepscon.PET_* - - - """ - ... - - def GetValue(self) -> Any: - """ - Retrieves the defined value - -Args: - - - -Returns: - - Any - - """ - ... - - def GetRangeMinValue(self) -> Any: - """ - Returns the minimum allowed value for the property - -Args: - - - -Returns: - - Any - - """ - ... - - def GetRangeSetValue(self) -> Any: - """ - Returns a fixed value defined for the property - -Args: - - - -Returns: - - Any - - """ - ... - - def GetDisplayText(self) -> None: - """ - Returns the display text for the enumerated type - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIPropertyEnumTypeList: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetCount(self) -> Any: - """ - Returns the number of objects in the list - -Args: - - - -Returns: - - Any - - """ - ... - - def GetAt(self, itype: Any, riid: PyIID) -> Any: - """ - Retrieves an item by index - -Args: - - itype(Any):Zero based index of type to return - riid(PyIID):The interface to return - -Returns: - - Any - - """ - ... - - def FindMatchingIndex(self, Cmp: Any) -> Any: - """ - Attempts to match the specified value to one of the allowable - -values for the property - -Args: - - Cmp(Any):A value to match against the defined values of the property - -Returns: - - Any - - """ - ... - - -class PyIPropertySetStorage: - """Container for a collection of property sets. - -Can be iterated over to enumerate property sets.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Create(self, fmtid: PyIID, clsid: PyIID, Flags: Any, Mode: Any) -> Any: - """ - Creates a new property set in the storage object - -Args: - - fmtid(PyIID):GUID identifying a property set, pythoncom.FMTID_* - clsid(PyIID):CLSID of property set handler, usually same as fmtid - Flags(Any):Specifies behaviour of property set, storagecon.PROPSETFLAG_* - Mode(Any):Access mode, combination of storagecon.STGM_* flags - -Returns: - - Any - - """ - ... - - def Open(self, fmtid: PyIID, Mode: Any) -> Any: - """ - Opens an existing property set - -Args: - - fmtid(PyIID):GUID of a property set, pythoncom.FMTID_* - Mode(Any):Access mode, combination of storagecon.STGM_* flags - -Returns: - - Any - - """ - ... - - def Delete(self, fmtid: PyIID) -> None: - """ - Removes a property set from this storage object - -Args: - - fmtid(PyIID):GUID of a property set, pythoncom.FMTID_* - -Returns: - - None - - """ - ... - - def Enum(self) -> Any: - """ - Creates an iterator to enumerate contained property - -sets - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIPropertyStorage: - """Structured storage object that contains a set of properties. - -Supports iteration to list properties.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def ReadMultiple(self, props: tuple[Any, ...]) -> tuple[Any, ...]: - """ - Reads specified properties from the current property set. - -Args: - - props(tuple[Any, ...]):Sequence of property IDs or names.Return ValueReturned values are automatically converted to an appropriate python type - -Returns: - - tuple[Any, ...]:Sequence of property IDs or names.Return ValueReturned values are automatically converted to an appropriate python type - - - """ - ... - - def WriteMultiple(self, props: tuple[Any, ...], values: tuple[Any, ...], propidNameFirst: Any = 2) -> None: - """ - Creates or modifies properties in the property set - -Args: - - props(tuple[Any, ...]):Sequence containing names or integer ids of properties to write - values(tuple[Any, ...]):The values for the properties. - propidNameFirst(Any):Minimum property id to be assigned to new properties specified by name - -Returns: - - None - - """ - ... - - def DeleteMultiple(self, props: tuple[Any, ...]) -> None: - """ - Deletes properties from the property set - -Args: - - props(tuple[Any, ...]):Sequence containing names or IDs of properties to be deleted - -Returns: - - None - - """ - ... - - def ReadPropertyNames(self, props: tuple[Any, ...]) -> tuple[Any, ...]: - """ - Retrieves any existing string names for the specified - -property identifiers. - -Args: - - props(tuple[Any, ...]):Sequence of ints containing property IDs. - -Returns: - - tuple[Any, ...] - - """ - ... - - def WritePropertyNames(self, props: tuple[Any, ...], names: tuple[str, ...]) -> None: - """ - Assigns string names to a specified array of property IDs in the - -current property set. - -Args: - - props(tuple[Any, ...]):Sequence containing the property IDs. - names(tuple[str, ...]):Equal length sequence of property names. - -Returns: - - None - - """ - ... - - def DeletePropertyNames(self, props: tuple[Any, ...]) -> None: - """ - Removes property names from specified properties. - -Args: - - props(tuple[Any, ...]):Sequence of ints containing property IDs. - -Returns: - - None - - """ - ... - - def Commit(self, CommitFlags: Any) -> None: - """ - Persists the property set to its base storage - -Args: - - CommitFlags(Any):Combination of storagecon.STGC_* flags - -Returns: - - None - - """ - ... - - def Revert(self) -> None: - """ - Discards any changes that have been made - -Args: - - - -Returns: - - None - - """ - ... - - def Enum(self) -> Any: - """ - Creates an enumerator for properties in the property set - -Args: - - - -Returns: - - Any - - """ - ... - - def SetTimes(self, ctime: PyTime, atime: PyTime, mtime: PyTime) -> None: - """ - Sets the creation, last access, and modification time - -Args: - - ctime(PyTime):Creation time, or None for no change - atime(PyTime):Last access time, or None for no change - mtime(PyTime):Modification time, or None for no changeCommentsSome property sets do not support these times. - -Returns: - - None - - """ - ... - - def SetClass(self, clsid: PyIID) -> None: - """ - Sets the GUID for the property set - -Args: - - clsid(PyIID):Description for clsid - -Returns: - - None - - """ - ... - - def Stat(self) -> Any: - """ - Returns various infomation about the property set - -Args: - - - -Returns: - - Any:PyIPropertyStorage.Stat - -tuple = Stat()Returns various infomation about the property set -Return ValueReturns a tuple representing a STATPROPSETSTG struct. - - - """ - ... - - -class PyIPropertyStore: - """Contains a collection of properties""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetCount(self) -> Any: - """ - Returns the number of properties in the store - -Args: - - - -Returns: - - Any - - """ - ... - - def GetAt(self, iProp: Any) -> Any: - """ - Returns the property key for the specified property - -Args: - - iProp(Any):Zero-based index of property - -Returns: - - Any - - """ - ... - - def GetValue(self, Key: Any) -> Any: - """ - Retrieves the value of a property - -Args: - - Key(Any):Property key as returned by PyIPropertyStore::GetAt - -Returns: - - Any - - """ - ... - - def SetValue(self, Key: Any, Value: Any) -> None: - """ - Sets the value of a property - -Args: - - Key(Any):Property key (see PyIPropertyStore::GetAt) - Value(Any):Variant value which can be converted to the appropriate variant type for the property ... a VT_EMPTY variant to indicate that the property should be removed. - -Returns: - - None - - """ - ... - - def Commit(self) -> None: - """ - Commits property changes - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIPropertyStoreCache: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetState(self, key: Any) -> Any: - """ - Retrieves the current state of a property - -Args: - - key(Any):Property identifierReturn ValueA value from the PSC_STATE enum (PSC_NORMAL, PSC_NOTINSOURCE. PSC_DIRTY) - -Returns: - - Any:Property identifierReturn ValueA value from the PSC_STATE enum (PSC_NORMAL, PSC_NOTINSOURCE. PSC_DIRTY) - - - """ - ... - - def GetValueAndState(self, key: Any) -> tuple[Any, Any]: - """ - Retrieves the current value and state of a - -property - -Args: - - key(Any):Property identifier - -Returns: - - tuple[Any, Any] - - """ - ... - - def SetState(self, key: Any, state: Any) -> None: - """ - Sets the state of a property - -Args: - - key(Any):Property identifier - state(Any):Value from the PSC_STATE enum (pscon.PSC_*) - -Returns: - - None - - """ - ... - - def SetValueAndState(self, key: Any, value: Any, state: Any) -> None: - """ - Sets the value and state of a property - -Args: - - key(Any):Property identifier - value(Any):The new value - state(Any):The new state (pscon.PSC_*) - -Returns: - - None - - """ - ... - - -class PyIPropertyStoreCapabilities: - """Property providers use this interface to indicate whether properties are - -writeable.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def IsPropertyWritable(self, key: Any) -> Any: - """ - Asks provider if a property can be editted. - -Args: - - key(Any):Property identifier - -Returns: - - Any - - """ - ... - - -class PyIPropertySystem: - """Wraps the IPropertySystem interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetPropertyDescription(self, Key: Any, riid: PyIID) -> Any: - """ - Returns an interface used to describe a - -property - -Args: - - Key(Any):Fmtid and propertyid that uniquely identifies a property - riid(PyIID):The interface to return - -Returns: - - Any - - """ - ... - - def GetPropertyDescriptionByName(self, CanonicalName: Any, riid: PyIID) -> Any: - """ - Returns an interface used to - -describe a property - -Args: - - CanonicalName(Any):Registered name of the property - riid(PyIID):The interface to return - -Returns: - - Any - - """ - ... - - def GetPropertyDescriptionListFromString(self, PropList: Any, riid: PyIID) -> Any: - """ - Retrieves property - -descriptions from a string of property names - -Args: - - PropList(Any):String containing a list of properties and flags - riid(PyIID):The interface to return - -Returns: - - Any - - """ - ... - - def EnumeratePropertyDescriptions(self, Filter: Any, riid: PyIID) -> Any: - """ - Returns an interface used to - -list defined properties - -Args: - - Filter(Any):Value from PROPDESC_ENUMFILTER (pscon.PDEF_*) that limits what types of properties are listed - riid(PyIID):The interface to return - -Returns: - - Any - - """ - ... - - def FormatForDisplay(self, Key: Any, Value: Any, Flags: Any) -> Any: - """ - Formats a property into a string - -Args: - - Key(Any):Fmtid and property id that identifies the property - Value(Any):The value to format - Flags(Any):Combination of PROPDESC_FORMAT_FLAGS (pscon.PDFF_*) indicating formatting options - -Returns: - - Any - - """ - ... - - def RegisterPropertySchema(self, Path: Any) -> None: - """ - Registers a set of properties defined in a .propdesc file - -Args: - - Path(Any):Path to a property schema XML file (.propdesc) - -Returns: - - None - - """ - ... - - def UnregisterPropertySchema(self, Path: Any) -> None: - """ - Removes a set of registered properties - -Args: - - Path(Any):Path to a property schema XML file (.propdesc) - -Returns: - - None - - """ - ... - - def RefreshPropertySchema(self) -> None: - """ - Not currently implemented by the OS - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIProvideClassInfo: - """A Python interface to IProvideClassInfo""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetClassInfo(self) -> Any: - """ - Gets information about the CO_CLASS. - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIProvideClassInfo2: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetGUID(self, flags: Any) -> PyIID: - """ - Gets the GUID for the object. - -Args: - - flags(Any):The flags for the GUID. - -Returns: - - PyIID - - """ - ... - - -class PyIProvideExpressionContexts: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def EnumExpressionContexts(self) -> None: - """ - Description of EnumStackFrames. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIProvideTaskPage: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetPage(self, tpType: Any, PersistChanges: Any) -> None: - """ - Return a property sheet page handle for the spedified type - -(TASKPAGE_TASK,TASKPAGE_SCHEDULE,TASKPAGE_SETTINGS) - -Args: - - tpType(Any):Type of page to retreive (TASKPAGE_TASK,TASKPAGE_SCHEDULE,TASKPAGE_SETTINGS) - PersistChanges(Any):Indicates if changes should be saved automaticallyCommentsThere's not yet anything useful that can be done with this handle - return type subject to change - -Returns: - - None - - """ - ... - - -class PyIQueryAssociations: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Init(self, flags: Any, assoc: str, hkeyProgId: PyHKEY = None, hwnd: int = None) -> None: - """ - Initializes the IQueryAssociations interface and sets the root key to the - -appropriate ProgID. - -Args: - - flags(Any):One of shellcon.ASSOCF_* flags - assoc(str):The string data (ie, extension, prog-id, etc) - hkeyProgId(PyHKEY):Root registry key, can be None - hwnd(int):Reserved, must be 0 or None - -Returns: - - None - - """ - ... - - def GetKey(self, flags: Any, assocKey: Any, arg: str) -> Any: - """ - Searches for and retrieves a file association-related key from the - -registry. - -Args: - - flags(Any):Used to control the search. - assocKey(Any):Specifies the type of key that is to be returned. - arg(str):Optional string with information about the location of the key. It is normally set to a shell verb such as 'open'. Set this parameter to None if it is not used. - -Returns: - - Any - - """ - ... - - def GetString(self, flags: Any, assocStr: Any, arg: str) -> Any: - """ - Searches for and retrieves a file association-related string from the - -registry. - -Args: - - flags(Any):Used to control the search. - assocStr(Any):Specifies the type of string that is to be returned. - arg(str):Optional string with information about the location of the key. It is normally set to a shell verb such as 'open'. Set this parameter to None if it is not used.CommentsNote that ASSOCF_NOTRUNCATE semantics are currently not supported - the buffer passed is 2048 bytes long, and will be truncated by the shell if too small. - -Returns: - - Any - - """ - ... - - -class PyIRelatedItem: - """Interface used as the base for objects that have a related shell item - -(eg ITransferMediumItem, IDisplayItem, etc). Should not be used directly.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetItemIDList(self) -> Any: - """ - Returns the ID list of the related item - -Args: - - - -Returns: - - Any - - """ - ... - - def GetItem(self) -> Any: - """ - Returns the related item - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIRemoteDebugApplication: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def ResumeFromBreakPoint(self, prptFocus: Any, bra: Any, era: Any) -> None: - """ - Continue an application which is currently in a breakpoint. - -Args: - - prptFocus(Any):Description for prptFocus - bra(Any):Break resume action - era(Any):Error resume action - -Returns: - - None - - """ - ... - - def CauseBreak(self) -> None: - """ - Causes the application to break into the debugger at the earliest - -opportunity. - -Args: - - - -Returns: - - None - - """ - ... - - def ConnectDebugger(self, pad: Any) -> None: - """ - Connects a debugger to the application. - -Args: - - pad(Any):Description for padCommentsOnly one debugger may be connected at a time; this method fails if there is already a debugger connected. - -Returns: - - None - - """ - ... - - def DisconnectDebugger(self) -> None: - """ - Disconnects the current debugger from the application. - -Args: - - - -Returns: - - None - - """ - ... - - def GetDebugger(self) -> Any: - """ - Returns the current debugger connected to - -the application. - -Args: - - - -Returns: - - Any - - """ - ... - - def CreateInstanceAtApplication( - self, - rclsid: PyIID, - pUnkOuter: Any, - dwClsContext: Any, - riid: PyIID) -> Any: - """ - Create objects in the application - -process address space. - -Args: - - rclsid(PyIID):Description for rclsid - pUnkOuter(Any):Description for pUnkOuter - dwClsContext(Any):Description for dwClsContext - riid(PyIID):Description for riidCommentsProvides a mechanism for the debugger IDE, running out-of-process to the application, to create objects in the application process. This method simply delegates to CoCreateInstance. - -Returns: - - Any - - """ - ... - - def QueryAlive(self) -> None: - """ - Returns True if alive, else False. - -Args: - - - -Returns: - - None - - """ - ... - - def EnumThreads(self) -> Any: - """ - Enumerates all threads known - -to be associated with the application. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetName(self) -> None: - """ - Description of GetName. - -Args: - - - -Returns: - - None - - """ - ... - - def GetRootNode(self) -> Any: - """ - Returns the application node under which - -all nodes associated with the application are added. - -Args: - - - -Returns: - - Any - - """ - ... - - def EnumGlobalExpressionContexts(self) -> Any: - """ - Enumerates all - -global expression contexts - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIRemoteDebugApplicationEvents: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def OnConnectDebugger(self, pad: Any) -> None: - """ - Description of OnConnectDebugger. - -Args: - - pad(Any):Description for pad - -Returns: - - None - - """ - ... - - def OnDisconnectDebugger(self) -> None: - """ - Description of OnDisconnectDebugger. - -Args: - - - -Returns: - - None - - """ - ... - - def OnSetName(self, pstrName: Any) -> None: - """ - Description of OnSetName. - -Args: - - pstrName(Any):Description for pstrName - -Returns: - - None - - """ - ... - - def OnDebugOutput(self, pstr: Any) -> None: - """ - Description of OnDebugOutput. - -Args: - - pstr(Any):Description for pstr - -Returns: - - None - - """ - ... - - def OnClose(self) -> None: - """ - Description of OnClose. - -Args: - - - -Returns: - - None - - """ - ... - - def OnEnterBreakPoint(self, prdat: Any) -> None: - """ - Description of OnEnterBreakPoint. - -Args: - - prdat(Any):Description for prdat - -Returns: - - None - - """ - ... - - def OnLeaveBreakPoint(self, prdat: Any) -> None: - """ - Description of OnLeaveBreakPoint. - -Args: - - prdat(Any):Description for prdat - -Returns: - - None - - """ - ... - - def OnCreateThread(self, prdat: Any) -> None: - """ - Description of OnCreateThread. - -Args: - - prdat(Any):Description for prdat - -Returns: - - None - - """ - ... - - def OnDestroyThread(self, prdat: Any) -> None: - """ - Description of OnDestroyThread. - -Args: - - prdat(Any):Description for prdat - -Returns: - - None - - """ - ... - - def OnBreakFlagChange(self, abf: Any, prdatSteppingThread: Any) -> None: - """ - Description of OnBreakFlagChange. - -Args: - - abf(Any):Description for abf - prdatSteppingThread(Any):Description for prdatSteppingThread - -Returns: - - None - - """ - ... - - -class PyIRemoteDebugApplicationThread: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetSystemThreadId(self) -> None: - """ - Description of GetSystemThreadId. - -Args: - - - -Returns: - - None - - """ - ... - - def GetApplication(self) -> None: - """ - Description of GetApplication. - -Args: - - - -Returns: - - None - - """ - ... - - def EnumStackFrames(self) -> None: - """ - Description of EnumStackFrames. - -Args: - - - -Returns: - - None - - """ - ... - - def GetDescription(self) -> None: - """ - Description of GetDescription. - -Args: - - - -Returns: - - None - - """ - ... - - def SetNextStatement(self, pStackFrame: Any, pCodeContext: Any) -> None: - """ - Description of SetNextStatement. - -Args: - - pStackFrame(Any):Description for pStackFrame - pCodeContext(Any):Description for pCodeContext - -Returns: - - None - - """ - ... - - def GetState(self) -> None: - """ - Description of GetState. - -Args: - - - -Returns: - - None - - """ - ... - - def Suspend(self) -> None: - """ - Description of Suspend. - -Args: - - - -Returns: - - None - - """ - ... - - def Resume(self) -> None: - """ - Description of Resume. - -Args: - - - -Returns: - - None - - """ - ... - - def GetSuspendCount(self) -> None: - """ - Description of GetSuspendCount. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIRunningObjectTable: - """A Python interface to IRunningObjectTable""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Register(self) -> Any: - """ - Registers an object and its identifying moniker in the Running Object - -Table (ROT). - -Args: - - - -Returns: - - Any - - """ - ... - - def Revoke(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def IsRunning(self, objectName: Any) -> Any: - """ - Checks whether an object is running. - -Args: - - objectName(Any):The PyIMoniker interface on the moniker to search for in the Running Object Table.Return ValueDescriptionS_OK (ie, 0)The object identified by objectName is running.S_FALSE (ie, 1)There is no entry for objectName in the ROT, or that the object it identifies is no longer running (in which case, the entry is revoked). - -Returns: - - Any - - """ - ... - - def GetObject(self, objectName: Any) -> Any: - """ - Checks whether an object is running. - -Args: - - objectName(Any):The PyIMoniker interface on the moniker to search for in the Running Object Table. - -Returns: - - Any - - """ - ... - - def EnumRunning(self) -> Any: - """ - Creates an enumerator that can list the monikers of - -all the objects currently registered in the Running Object Table (ROT). - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIScheduledWorkItem: - """Python object that encapsulates the IScheduledWorkItem interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CreateTrigger(self) -> tuple[Any, Any]: - """ - Creates a new trigger for a task, returns index and - -new ITaskTrigger interface - -Args: - - - -Returns: - - tuple[Any, Any] - - """ - ... - - def DeleteTrigger(self, Trigger: Any) -> None: - """ - Deletes specified trigger - -Args: - - Trigger(Any):Index of trigger to delete - -Returns: - - None - - """ - ... - - def GetTriggerCount(self) -> Any: - """ - Returns number of triggers defined for the task - -Args: - - - -Returns: - - Any - - """ - ... - - def GetTrigger(self, iTrigger: Any) -> Any: - """ - Retrieves ITaskTrigger interface for specified trigger - -index - -Args: - - iTrigger(Any):Index of trigger to retrieve - -Returns: - - Any - - """ - ... - - def GetTriggerString(self) -> Any: - """ - Creates a human-readable summary of specified trigger - -Args: - - - -Returns: - - Any - - """ - ... - - def GetRunTimes(self, Count: Any, Begin: PyTime, End: PyTime) -> tuple[PyTime, Any, Any, Any]: - """ - Return specified number of run times within given time - -frame - -Args: - - Count(Any):Number of run times to retrieve - Begin(PyTime):Start time, defaults to current time if not passed or None - End(PyTime):End time, defaults to unlimited if not passed or None - -Returns: - - tuple[PyTime, Any, Any, Any] - - """ - ... - - def GetNextRunTime(self) -> PyTime: - """ - Returns next time that task is scheduled to run - -Args: - - - -Returns: - - PyTime - - """ - ... - - def SetIdleWait(self, wIdleMinutes: Any, wDeadlineMinutes: Any) -> None: - """ - Sets idle parms for task with trigger of type TASK_EVENT_TRIGGER_ON_IDLE - -Args: - - wIdleMinutes(Any):Nbr of minutes computer must be idle before task fires - wDeadlineMinutes(Any):Maximum nbr of minutes task will wait for computer to become idle - -Returns: - - None - - """ - ... - - def GetIdleWait(self) -> tuple[Any, Any]: - """ - Gets IdleMinutes and DeadlineMinutes parms for task with trigger - -of type TASK_EVENT_TRIGGER_ON_IDLE - -Args: - - - -Returns: - - tuple[Any, Any] - - """ - ... - - def Run(self) -> None: - """ - Starts task - -Args: - - - -Returns: - - None - - """ - ... - - def Terminate(self) -> None: - """ - Terminate process if task is running - -Args: - - - -Returns: - - None - - """ - ... - - def EditWorkItem(self, hParent: int, dwReserved: Any) -> None: - """ - Brings up standard Scheduled Task dialog - -Args: - - hParent(int):Reserved, use 0 or None if passed - dwReserved(Any):Reserved, use 0 if passed - -Returns: - - None - - """ - ... - - def GetMostRecentRunTime(self) -> PyTime: - """ - Returns last time task ran - -Args: - - - -Returns: - - PyTime - - """ - ... - - def GetStatus(self) -> Any: - """ - Returns status (SCHED_S_TASK... constants) - -Args: - - - -Returns: - - Any - - """ - ... - - def GetExitCode(self) -> tuple[Any, Any]: - """ - Returns tuple of task's exit code and error returned to Task - -Scheduler if process could not start - -Args: - - - -Returns: - - tuple[Any, Any] - - """ - ... - - def SetComment(self, Comment: Any) -> None: - """ - Set comment string for task - -Args: - - Comment(Any):Freeform comment string - -Returns: - - None - - """ - ... - - def GetComment(self) -> str: - """ - Return comment string associated with task. - -Args: - - - -Returns: - - str - - """ - ... - - def SetCreator(self, Creator: Any) -> None: - """ - Specify who (or what) created task, can be any string - -Args: - - Creator(Any):Originator of task, does not have to be valid username - -Returns: - - None - - """ - ... - - def GetCreator(self) -> None: - """ - Returns creator info, can be any string data - -Args: - - - -Returns: - - None - - """ - ... - - def SetWorkItemData(self, Data: str) -> None: - """ - Set data associated with task (treated as uninterpreted bytes) - -Args: - - Data(str):Character data, treated as uninterpreted bytes - -Returns: - - None - - """ - ... - - def GetWorkItemData(self) -> str: - """ - Retrieve data associated with task - -Args: - - - -Returns: - - str - - """ - ... - - def SetErrorRetryCount(self, wRetryCount: Any) -> None: - """ - Specify nbr of times to attempt to run task if it can't start (not - -currently implemented) - -Args: - - wRetryCount(Any):Nbr of attemps to start task - -Returns: - - None - - """ - ... - - def GetErrorRetryCount(self) -> None: - """ - Return nbr of times Task scheduler should try to run task (not - -currently implemented) - -Args: - - - -Returns: - - None - - """ - ... - - def SetErrorRetryInterval(self, RetryInterval: Any) -> None: - """ - Interval in minutes between attempts to run task. Not - -implemented according to SDK - -Args: - - RetryInterval(Any):Interval in minutes - -Returns: - - None - - """ - ... - - def GetErrorRetryInterval(self) -> None: - """ - Returns nbr of minutes between attempts to run task. Not - -implemented according to SDK - -Args: - - - -Returns: - - None - - """ - ... - - def SetFlags(self, dwFlags: Any) -> None: - """ - Set flags for task - -Args: - - dwFlags(Any):Combination of TASK_FLAG_* constants - -Returns: - - None - - """ - ... - - def GetFlags(self) -> Any: - """ - Returns flags for task (TASK_FLAG_* constants) - -Args: - - - -Returns: - - Any - - """ - ... - - def SetAccountInformation(self, AccountName: Any, password: Any) -> None: - """ - Set username and password under which task will run - -Args: - - AccountName(Any):AccountName, use "" for local system account (can only be used by Administrators) - password(Any):password - Can be None for local System account, or if TASK_FLAG_RUN_ONLY_IF_LOGGED_ON is setCommentsOn some systems, username and password are verified at the time the task is saved, on others when the task tries to run - -Returns: - - None - - """ - ... - - def GetAccountInformation(self) -> Any: - """ - Returns username that task will run under - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIServerSecurity: - """Interface used to access client security settings and perform impersonation""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def QueryBlanket(self, Capabilities: Any = 0) -> Any: - """ - Retrieves security settings specified by the client - -Args: - - Capabilities(Any):Can be EOAC_MAKE_FULLSIC for SChannel provider - -Returns: - - Any - - """ - ... - - def ImpersonateClient(self) -> None: - """ - Initiates impersonation of client - -Args: - - - -Returns: - - None - - """ - ... - - def RevertToSelf(self) -> None: - """ - Ends impersonation of client - -Args: - - - -Returns: - - None - - """ - ... - - def IsImpersonating(self) -> Any: - """ - Determines if server is currently impersonating a client - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIServiceProvider: - """A Python interface to IServiceProvider""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def QueryService(self, clsid: PyIID, iid: PyIID) -> Any: - """ - Creates or accesses the specified service and returns an - -interface object to the specified interface for the service. - -Args: - - clsid(PyIID):Unique identifier for the requested service. - iid(PyIID):Unique identifier for the requested interface on the service. - -Returns: - - Any - - """ - ... - - -class PyIShellBrowser: - """Exposed by Windows Explorer and the Open File common dialog box to provide services for - -namespace extensions.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def InsertMenusSB(self, hmenuShared: int, lpMenuWidths: Any) -> Any: - """ - Updates a composite menu with container's options - -Args: - - hmenuShared(int):Newly created menu that contains no items - lpMenuWidths(Any):tuple of 6 ints. Items 0,2,and 4 are updated when the tuple is returned. - -Returns: - - Any - - """ - ... - - def SetMenuSB(self, hmenuShared: int, holemenuRes: int, hwndActiveObject: int) -> None: - """ - Attaches a shared menu to a shell view window - -Args: - - hmenuShared(int):Handle to the shared menu - holemenuRes(int):Reserved, use only None (or 0) - hwndActiveObject(int):Handle to the shell window - -Returns: - - None - - """ - ... - - def RemoveMenusSB(self, hmenuShared: int) -> None: - """ - Asks container to remove any items it added to a composite menu - -Args: - - hmenuShared(int):Handle to the composite menu - -Returns: - - None - - """ - ... - - def SetStatusTextSB(self, pszStatusText: Any) -> None: - """ - Sets the status text in view's status bar - -Args: - - pszStatusText(Any):New status to be displayed - -Returns: - - None - - """ - ... - - def EnableModelessSB(self, fEnable: Any) -> None: - """ - Enables or disables modeless dialogs - -Args: - - fEnable(Any):Use True to enable or False to disable modeless dialog boxes - -Returns: - - None - - """ - ... - - def TranslateAcceleratorSB(self, pmsg: PyMSG, wID: Any) -> None: - """ - Translates keystrokes used as menu item activators - -Args: - - pmsg(PyMSG):Keystroke message to be translated - wID(Any):Menu command id for the keystroke - -Returns: - - None - - """ - ... - - def BrowseObject(self, pidl: Any, wFlags: Any) -> None: - """ - Navigates to a different location - -Args: - - pidl(Any):Item id list that specifies the new browse location, can be None - wFlags(Any):Combination of shellcon.SBSP_* flags - -Returns: - - None - - """ - ... - - def GetViewStateStream(self, grfMode: Any) -> Any: - """ - Returns a stream that can be used to access view state - -information - -Args: - - grfMode(Any):Read/write mode, one of STGM_READ,STGM_WRITE,STGM_READWRITE - -Returns: - - Any - - """ - ... - - def GetControlWindow(self, _id: Any) -> None: - """ - Returns a handle to one of the browser's control elements - -Args: - - _id(Any):One of shellcon.FCW_* values - -Returns: - - None - - """ - ... - - def SendControlMsg(self, _id: Any, uMsg: Any, wParam: Any, lParam: Any) -> Any: - """ - Sends a control msg to browser's toolbar or status bar - -Args: - - _id(Any):shellcon.FCW_TOOLBAR or FCW_STATUS - uMsg(Any):The message to send - wParam(Any):Value is dependent on the message - lParam(Any):Value is dependent on the message - -Returns: - - Any - - """ - ... - - def QueryActiveShellView(self) -> Any: - """ - Returns the currently displayed view - -Args: - - - -Returns: - - Any - - """ - ... - - def OnViewWindowActive(self, pshv: Any) -> None: - """ - Callback triggered when a view window is activated - -Args: - - pshv(Any):The activated view object - -Returns: - - None - - """ - ... - - def SetToolbarItems(self, lpButtons: Any, uFlags: Any) -> None: - """ - Adds toolbar buttons to the browser's toolbar - -Args: - - lpButtons(Any):Sequence of tuples describing the buttons to be added - uFlags(Any):Indicates button positions, combination of shellcon.FCT_* - -Returns: - - None - - """ - ... - - -class PyIShellExtInit: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Initialize(self, pFolder: Any, pDataObject: Any, hkey: int) -> None: - """ - Description of Initialize. - -Args: - - pFolder(Any):Description for pFolder - pDataObject(Any):Description for pDataObject - hkey(int):Description for hkey - -Returns: - - None - - """ - ... - - -class PyIShellFolder: - """Interface that represents an Explorer folder""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def ParseDisplayName(self, hwndOwner: int, pbc: Any, DisplayName: Any, Attributes: Any = 0) -> Any: - """ - Returns the PIDL of an item in a shell folder - -Args: - - hwndOwner(int):Window in which to display any dialogs or message boxes, can be 0 - pbc(Any):Bind context that affects how parsing is performed, can be None - DisplayName(Any):Display name to parse, format is dependent on the shell folder. Desktop folder will accept a file path, as well as guids of the form ::{guid} Example: ::%s\\::%s' %(shell.CLSID_MyComputer,shell.CLSID_ControlPanel) - Attributes(Any):Combination of shellcon.SFGAO_* constants specifying which attributes should be returnedReturn ValueThe result is a tuple of cchEaten, pidl, attrItems[0] int : cchEatenthe number of characters of the input name that were parsed[1] PyIDL : pidlspecifies the relative path from the parsing folder to the object[2] int : Attributesreturns any requested attributes - -Returns: - - Any:Combination of shellcon.SFGAO_* constants specifying which attributes should be returned -Return ValueThe result is a tuple of cchEaten, pidl, attr -Items[0] int : cchEaten -the number of characters of the input name that were parsed -[1] PyIDL : pidl -specifies the relative path from the parsing folder to the object -[2] int : Attributes -returns any requested attributes - - - """ - ... - - def EnumObjects(self, grfFlags: Any, hwndOwner: int = None) -> Any: - """ - Creates an enumerator to list the contents of the shell folder - -Args: - - grfFlags(Any):Combination of shellcon.SHCONTF_* constants - hwndOwner(int):Window to use if any user interaction is required - -Returns: - - Any - - """ - ... - - def BindToObject(self, pidl: Any, pbc: Any, riid: PyIID) -> Any: - """ - Returns an IShellFolder interface for a subfolder - -Args: - - pidl(Any):Relative item id list that identifies the subfolder, can be multi-level - pbc(Any):Bind context to be used, can be None - riid(PyIID):IID of the desired interface, usually IID_IShellFolder - -Returns: - - Any - - """ - ... - - def BindToStorage(self, pidl: Any, pbc: Any, riid: PyIID) -> Any: - """ - Returns an interface to a storage object in a shell folder - -Args: - - pidl(Any):Relative pidl for the folder item, must be a single item id - pbc(Any):Bind context that affects how binding is performed, can be None - riid(PyIID):IID of the desired interface, one of IID_IStream, IID_IStorage, IID_IPropertySetStorageReturn ValueReturns PyIStream, PyIStorage or PyIPropertySetStorage depending on the riid passed in - -Returns: - - 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 - - - """ - ... - - def CompareIDs(self, lparam: Any, pidl1: Any, pidl2: Any) -> Any: - """ - Determines the sorting order of 2 items in shell folder - -Args: - - lparam(Any):Lower 16 bits specify folder-dependent sorting rules, 0 means to sort by display name. System folder view uses these as a column number. Upper sixteen bits is used for flags SHCIDS_ALLFIELDS or SHCIDS_CANONICALONLY - pidl1(Any):Item id list that idenfies an object relative to the folder - pidl2(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 - -Returns: - - 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 - - - """ - ... - - def CreateViewObject(self, hwndOwner: Any, riid: PyIID) -> Any: - """ - Creates a view object for a shell folder. - -Args: - - hwndOwner(Any):Parent window for a custom folder view, or 0 - riid(PyIID):IID of the desired interface, usually IID_IShellView - -Returns: - - Any - - """ - ... - - def GetAttributesOf(self, pidl: tuple[Any, ...], rgfInOut: Any) -> Any: - """ - Queries attributes of items within the shell folder - -Args: - - pidl(tuple[Any, ...]):A sequence of single-level pidls identifying items directly contained by the folder - rgfInOut(Any):Combination of shellcon.SFGAO_* constantsReturn ValueThe requested attributes are only returned if they are common to all of the specified items - -Returns: - - Any:Combination of shellcon.SFGAO_* constantsReturn ValueThe requested attributes are only returned if they are common to all of the specified items - - - """ - ... - - def GetUIObjectOf( - self, - hwndOwner: int, - pidl: tuple[Any, ...], - riid: PyIID, - iidout: PyIID, - Reserved: Any = 0) -> tuple[Any, Any]: - """ - Creates an interface to one or more items in a shell - -folder - -Args: - - hwndOwner(int):Specifies a window in which to display any required dialogs or errors, can be 0 - pidl(tuple[Any, ...]):A sequence of single-level pidls identifying items in the folder - riid(PyIID):The interface to create, one of IID_IContextMenu, IID_IContextMenu2, IID_IDataObject, IID_IDropTarget, IID_IExtractIcon, IID_IQueryInfo - iidout(PyIID):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 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 - Reserved(Any):Reserved, use 0 if passed in - -Returns: - - tuple[Any, Any]: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 - -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 - - - """ - ... - - def GetDisplayNameOf(self, pidl: Any, uFlags: Any) -> Any: - """ - Returns the display name of an item within this shell folder - -Args: - - pidl(Any):PIDL that identifies the item relative to the parent folder - uFlags(Any):Combination of shellcon.SHGDN_* flags - -Returns: - - Any - - """ - ... - - def SetNameOf(self, hwndOwner: Any, pidl: Any, Name: Any, Flags: Any) -> Any: - """ - Sets the display name of an item and changes its PIDL - -Args: - - hwndOwner(Any):Window in which to display any message boxes or dialogs, can be 0 - pidl(Any):PIDL that identifies the item relative to the parent folder - Name(Any):New name for the item - Flags(Any):Combination of shellcon.SHGDM_* valuesReturn ValueReturns the new PIDL for item - -Returns: - - Any:Combination of shellcon.SHGDM_* valuesReturn ValueReturns the new PIDL for item - - - """ - ... - - -class PyIShellFolder2: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetDefaultSearchGUID(self, pguid: PyIID) -> PyIID: - """ - Retrieves the default search for the folder - -Args: - - pguid(PyIID):Description for pguid - -Returns: - - PyIID - - """ - ... - - def EnumSearches(self) -> Any: - """ - Returns an interface that lists searches defined for - -the folder - -Args: - - - -Returns: - - Any - - """ - ... - - def GetDefaultColumn(self) -> tuple[Any, Any]: - """ - Returns the columns used for sorting and display - -Args: - - - -Returns: - - tuple[Any, Any] - - """ - ... - - def GetDefaultColumnState(self, iColumn: Any) -> Any: - """ - Returns flags indicating the default behaviour of the column - -Args: - - iColumn(Any):Zero-based index of the columnReturn ValueReturns a combination of shellcon.SHCOLSTATE_* flags - -Returns: - - Any:Zero-based index of the columnReturn ValueReturns a combination of shellcon.SHCOLSTATE_* flags - - - """ - ... - - def GetDetailsEx(self, pidl: Any, pscid: Any) -> Any: - """ - Returns the details of an item by Column ID - -Args: - - pidl(Any):Relative id list of an item in the folder - pscid(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 - -Returns: - - 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 - - - """ - ... - - def GetDetailsOf(self, pidl: Any, iColumn: Any) -> tuple[Any, Any, Any]: - """ - Returns the value or title of a column in the folder's Details - -view. - -Args: - - pidl(Any):The relative idl of an item in the folder. Use None to retrieve column title. - iColumn(Any):Zero based index of columnReturn ValueReturns a tuple representing a SHELLDETAILS struct, containing the formst (LVCFMT_*), column width in characters, and string representation of the requested value - -Returns: - - tuple[Any, Any, Any]:Zero based index of columnReturn ValueReturns a tuple representing a SHELLDETAILS struct, containing the formst (LVCFMT_*), column width in - -characters, - -and string representation of the requested value - - - """ - ... - - def MapColumnToSCID(self, Column: Any) -> Any: - """ - Returns the unique identifier (FMTID, pid) of a column - -Args: - - Column(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. - -Returns: - - 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. - - - """ - ... - - -class PyIShellIcon: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetIconOf(self, pidl: Any) -> None: - """ - Description of GetIconOf. - -Args: - - pidl(Any):Description for pidl - -Returns: - - None - - """ - ... - - -class PyIShellIconOverlay: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetOverlayIndex(self, pidl: Any) -> None: - """ - Description of GetOverlayIndex. - -Args: - - pidl(Any):Description for pidl - -Returns: - - None - - """ - ... - - def GetOverlayIconIndex(self, pidl: Any) -> None: - """ - Description of GetOverlayIconIndex. - -Args: - - pidl(Any):Description for pidl - -Returns: - - None - - """ - ... - - -class PyIShellIconOverlayIdentifier: - """Interface that supplies icon overlay information to the shell""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def IsMemberOf(self, path: str, attrib: Any) -> Any: - """ - Determines if a shell object should have an icon overlay - -Args: - - path(str):Fully qualified path of the shell object - attrib(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. 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. - -Returns: - - 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. - -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. - - - """ - ... - - def GetOverlayInfo(self) -> tuple[str, Any, Any]: - """ - Retrieves the path to the overlay - -icon - -Args: - - - -Returns: - - tuple[str, Any, Any]:PyIShellIconOverlayIdentifier.GetOverlayInfo - -(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 - -combination of shellcon.ISIOI_ICON* flags - - - """ - ... - - def GetPriority(self) -> Any: - """ - Retrieves the relative priority of the overlay - -Args: - - - -Returns: - - Any:PyIShellIconOverlayIdentifier.GetPriority - -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) - - - """ - ... - - -class PyIShellIconOverlayManager: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetFileOverlayInfo(self, path: Any, attrib: Any, flags: Any) -> Any: - """ - Returns an index into the system image list for the icon - -image or overlay image - -Args: - - path(Any):Full path to the file - attrib(Any):File attributes (win32com.FILE_ATTRIBUTE_*) - flags(Any):SIOM_OVERLAYINDEX (1) or SIOM_ICONINDEX (2) - -Returns: - - Any - - """ - ... - - def GetReservedOverlayInfo(self, path: Any, attrib: Any, flags: Any, ireservedID: Any) -> None: - """ - Description of GetReservedOverlayInfo. - -Args: - - path(Any):Description for path - attrib(Any):Description for attrib - flags(Any):Description for flags - ireservedID(Any):Description for ireservedID - -Returns: - - None - - """ - ... - - def RefreshOverlayImages(self, flags: Any) -> None: - """ - Description of RefreshOverlayImages. - -Args: - - flags(Any):Description for flags - -Returns: - - None - - """ - ... - - def LoadNonloadedOverlayIdentifiers(self) -> None: - """ - Description of LoadNonloadedOverlayIdentifiers. - -Args: - - - -Returns: - - None - - """ - ... - - def OverlayIndexFromImageIndex(self, iImage: Any, fAdd: Any) -> None: - """ - Description of OverlayIndexFromImageIndex. - -Args: - - iImage(Any):Description for iImage - fAdd(Any):Description for fAdd - -Returns: - - None - - """ - ... - - -class PyIShellItem: - """Interface that represents an item in the Explorer shell""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def BindToHandler(self, pbc: Any, bhid: PyIID, riid: PyIID) -> Any: - """ - Creates an instance of one of the item's handlers - -Args: - - pbc(Any):Used to ... parameters that influence the binding operation, can be None - bhid(PyIID):GUID that identifies a handler (shell.BHID_*) - riid(PyIID):The interface to return - -Returns: - - Any - - """ - ... - - def GetParent(self) -> Any: - """ - Retrieves the parent of this item - -Args: - - - -Returns: - - Any - - """ - ... - - def GetDisplayName(self, sigdnName: Any) -> Any: - """ - Returns the display name of the item in the specified format - -Args: - - sigdnName(Any):Format of name to return, shellcon.SIGDN_* - -Returns: - - Any - - """ - ... - - def GetAttributes(self, Mask: Any) -> Any: - """ - Returns shell attributes of the item - -Args: - - Mask(Any):Combination of shellcon.SFGAO_* values indicating the flags to returnReturn ValueReturns a combination of shellcon.SFGAO_* values - -Returns: - - Any:Combination of shellcon.SFGAO_* values indicating the flags to returnReturn ValueReturns a combination of shellcon.SFGAO_* values - - - """ - ... - - def Compare(self, psi: Any, hint: Any) -> Any: - """ - Compares another shell item with this item - -Args: - - psi(Any):A shell item to be compared with this item - hint(Any):shellcon.SICHINT_* value indicating how the comparison is to be performedReturn ValueReturns 0 if items compare as equal, nonzero otherwise - -Returns: - - Any:shellcon.SICHINT_* value indicating how the comparison is to be performedReturn ValueReturns 0 if items compare as equal, nonzero otherwise - - - """ - ... - - -class PyIShellItem2: - """Extends the IShellItem interface, giving access to an item's properties""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetPropertyStore(self, Flags: Any, riid: PyIID) -> Any: - """ - Returns a collection of the item's properties - -Args: - - Flags(Any):Combination of GETPROPERTYSTOREFLAGS values (shellcon.GPS_*) - riid(PyIID):The interface to return - -Returns: - - Any - - """ - ... - - def GetPropertyStoreForKeys(self, Keys: tuple[Any, ...], Flags: Any, riid: PyIID) -> Any: - """ - Creates a property store containing just the - -specified properties of the item - -Args: - - Keys(tuple[Any, ...]):A sequence of property identifiers - Flags(Any):Combination of GETPROPERTYSTOREFLAGS values (shellcon.GPS_*) - riid(PyIID):The interface to return - -Returns: - - Any - - """ - ... - - def GetPropertyStoreWithCreateObject(self, Flags: Any, CreateObject: Any, riid: PyIID) -> Any: - """ - Returns the property store for the - -item, with alternate handler instantiation - -Args: - - Flags(Any):Combination of GETPROPERTYSTOREFLAGS values (shellcon.GPS_*) - CreateObject(Any):An interface that implements ICreateObject, used to create the property handler - riid(PyIID):The interface to be createdCommentsPrimarily used to create a handler in a separate process with reduced privileges - -Returns: - - Any - - """ - ... - - def GetPropertyDescriptionList(self, Type: Any, riid: PyIID) -> Any: - """ - Retrieves descriptions of - -properties in a particular group - -Args: - - Type(Any):Property list identifier (pscon.PKEY_PropList_*) - riid(PyIID):The interface to return - -Returns: - - Any - - """ - ... - - def Update(self, BindCtx: Any = None) -> None: - """ - Refreshes properties that have been modified since interface was created - -Args: - - BindCtx(Any):Bind context used when requesting the interface, or None - -Returns: - - None - - """ - ... - - def GetProperty(self, key: Any) -> Any: - """ - Retrieves the value of a property, converted to an appropriate python type - -Args: - - key(Any):The id of the property to retrieveReturn ValueType of returned object is determined by the variant type of the property - -Returns: - - Any:The id of the property to retrieveReturn ValueType of returned object is determined by the variant type of the property - - - """ - ... - - def GetCLSID(self, key: Any) -> PyIID: - """ - Retrieves the value of a property as a CLSID (VT_CLSID) - -Args: - - key(Any):The id of the property to retrieve - -Returns: - - PyIID - - """ - ... - - def GetFileTime(self, key: Any) -> PyTime: - """ - Retrieves the value of a property as a FILETIME - -Args: - - key(Any):The id of the property to retrieve - -Returns: - - PyTime - - """ - ... - - def GetInt32(self, key: Any) -> Any: - """ - Retrieves the value of a property as a 32 bit int. - -Args: - - key(Any):The id of the property to retrieve - -Returns: - - Any - - """ - ... - - def GetString(self, key: Any) -> Any: - """ - Retrieves the value of a property as a string - -Args: - - key(Any):The id of the property to retrieve - -Returns: - - Any - - """ - ... - - def GetUInt32(self, key: Any) -> Any: - """ - Returns the value of a property as a 32 bit unsigned int - -Args: - - key(Any):The id of the property to retrieve - -Returns: - - Any - - """ - ... - - def GetUInt64(self, key: Any) -> Any: - """ - Returns the value of a property as an unsigned 64-bit int - -Args: - - key(Any):The id of the property to retrieve - -Returns: - - Any - - """ - ... - - def GetBool(self, key: Any) -> Any: - """ - Returns the value of a property as a boolean - -Args: - - key(Any):The id of the property to retrieve - -Returns: - - Any - - """ - ... - - -class PyIShellItemArray: - """Container for a number of shell items""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def BindToHandler(self, pbc: Any, rbhid: PyIID, riid: PyIID) -> Any: - """ - Creates an instance of a handler for the items in the container - -Args: - - pbc(Any):Bind context, can be None - rbhid(PyIID):Bind handler GUID (shell.BHID_*) - riid(PyIID):The interface to return - -Returns: - - Any - - """ - ... - - def GetPropertyStore(self, flags: Any, riid: PyIID) -> Any: - """ - Retrieves a store containing consolidated - -properties of items in container - -Args: - - flags(Any):Flags indicating how the properties are retrieved (shellcon.GPS_*) - riid(PyIID):The interface to return, IID_IPropertyStore or related interface - -Returns: - - Any - - """ - ... - - def GetPropertyDescriptionList(self, Type: Any, riid: PyIID) -> Any: - """ - Retrieves descriptions for a - -defined group of properties - -Args: - - Type(Any):Property list identifier (pscon.PKEY_PropList_*) - riid(PyIID):The interface to return - -Returns: - - Any - - """ - ... - - def GetAttributes(self, AttribFlags: Any, Mask: Any) -> Any: - """ - Retrieves shell attributes of contained items - -Args: - - AttribFlags(Any):SIATTRIBFLAGS value (shellcon.SIATTRIBFLAGS_*) specifying how to combine attributes of multiple items - Mask(Any):Combination of SFGAOF flags (shellcon.SFGAO_*) specifying which attributes to return - -Returns: - - Any - - """ - ... - - def GetCount(self) -> Any: - """ - Returns the number of items in the container - -Args: - - - -Returns: - - Any - - """ - ... - - def GetItemAt(self, dwIndex: Any) -> Any: - """ - Retrieves an item by index - -Args: - - dwIndex(Any):Zero-based index of item to retrieve - -Returns: - - Any - - """ - ... - - def EnumItems(self) -> Any: - """ - Returns an enumeration interface to list contained items - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyIShellItemResources: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetAttributes(self) -> None: - """ - Description of GetAttributes. - -Args: - - - -Returns: - - None - - """ - ... - - def GetSize(self) -> Any: - """ - Description of GetSize. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetTimes(self) -> None: - """ - Description of GetTimes. - -Args: - - - -Returns: - - None - - """ - ... - - def SetTimes(self, pftCreation: PyTime, pftWrite: PyTime, pftAccess: PyTime) -> None: - """ - Description of SetTimes. - -Args: - - pftCreation(PyTime):Description for pftCreation - pftWrite(PyTime):Description for pftWrite - pftAccess(PyTime):Description for pftAccess - -Returns: - - None - - """ - ... - - def GetResourceDescription(self, pcsir: Any) -> None: - """ - Description of GetResourceDescription. - -Args: - - pcsir(Any):Description for pcsir - -Returns: - - None - - """ - ... - - def EnumResources(self) -> Any: - """ - Description of EnumResources. - -Args: - - - -Returns: - - Any - - """ - ... - - def SupportsResource(self, pcsir: Any) -> Any: - """ - Description of SupportsResource. - -Args: - - pcsir(Any):Description for pcsir - -Returns: - - Any - - """ - ... - - def OpenResource(self, pcsir: Any, riid: PyIID) -> Any: - """ - Description of OpenResource. - -Args: - - pcsir(Any):Description for pcsir - riid(PyIID):The interface to return - -Returns: - - Any - - """ - ... - - def CreateResource(self, sir: Any, riid: PyIID) -> Any: - """ - Description of CreateResource. - -Args: - - sir(Any):Resource identifier - riid(PyIID):The interface to return - -Returns: - - Any - - """ - ... - - def MarkForDelete(self) -> None: - """ - Description of MarkForDelete. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIShellLibrary: - """Interface used to access Libraries""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def LoadLibraryFromItem(self, Library: Any, Mode: Any) -> None: - """ - Loads an existing library file - -Args: - - Library(Any):Shell item interface representing the library file - Mode(Any):Access mode, combination of storagecon.STGM_* flags - -Returns: - - None - - """ - ... - - def LoadLibraryFromKnownFolder(self, Library: PyIID, Mode: Any) -> None: - """ - Initializes library from a known folder - -Args: - - Library(PyIID):Known folder id, shell.FOLDERID_* - Mode(Any):Access mode, combination of storagecon.STGM_* flags - -Returns: - - None - - """ - ... - - def AddFolder(self, Location: Any) -> None: - """ - Includes a folder - -Args: - - Location(Any):Shell item interface representing the folder - -Returns: - - None - - """ - ... - - def RemoveFolder(self, Location: Any) -> None: - """ - Removes a folder - -Args: - - Location(Any):Shell item interface representing the folder - -Returns: - - None - - """ - ... - - def GetFolders(self, Filter: Any, riid: PyIID) -> Any: - """ - Retrieves a collection of folders in the library - -Args: - - Filter(Any):Specifies what types of folder to return (shellcon.LFF_*) - riid(PyIID):The interface to return, IObjectCollection and IObjectArray also accepted. - -Returns: - - Any - - """ - ... - - def ResolveFolder(self, FolderToResolve: Any, Timeout: Any, riid: PyIID) -> Any: - """ - Attempts to locate a folder that has been moved or renamed - -Args: - - FolderToResolve(Any):Library item whose location has changed - Timeout(Any):Max search time, specified in milliseconds - riid(PyIID):The interface to return - -Returns: - - Any - - """ - ... - - def GetDefaultSaveFolder(self, Type: Any, riid: PyIID) -> Any: - """ - Returns the default folder in which new items are - -saved - -Args: - - Type(Any):Specifies whether to return public or private save location, shellcon.DSFT_* - riid(PyIID):The interface to return - -Returns: - - Any - - """ - ... - - def SetDefaultSaveFolder(self, Type: Any, SaveFolder: Any) -> None: - """ - Sets the default save location - -Args: - - Type(Any):Specifies public or private save location, shellcon.DSFT_* - SaveFolder(Any):New default location, must be in the library - -Returns: - - None - - """ - ... - - def GetOptions(self) -> Any: - """ - Retrieves library option flags - -Args: - - - -Returns: - - Any:PyIShellLibrary.GetOptions - -int = GetOptions()Retrieves library option flags -Return ValueReturns a combination of shellcon.LOF_* flags - - - """ - ... - - def SetOptions(self, Mask: Any, Options: Any) -> None: - """ - Sets library option flags - -Args: - - Mask(Any):Bitmask of flags to be changed, combination of shellcon.LOF_* values - Options(Any):New options, combination of shellcon.LOF_* values - -Returns: - - None - - """ - ... - - def GetFolderType(self) -> PyIID: - """ - Returns the library type, shell.FOLDERTYPEID_* - -Args: - - - -Returns: - - PyIID - - """ - ... - - def SetFolderType(self, Type: PyIID) -> None: - """ - Sets the folder type for the library - -Args: - - Type(PyIID):New type, shell.FOLDERTYPEID_* - -Returns: - - None - - """ - ... - - def GetIcon(self) -> Any: - """ - Returns the location of the library's icon - -Args: - - - -Returns: - - Any:PyIShellLibrary.GetIcon - -str = GetIcon()Returns the location of the library's icon -Return ValueUses "module,resource" format - - - """ - ... - - def SetIcon(self, Icon: Any) -> None: - """ - Sets the library icon - -Args: - - Icon(Any):Icon location in "module,resource" syntax - -Returns: - - None - - """ - ... - - def Commit(self) -> None: - """ - Saves changes (only if loaded from an existing library) - -Args: - - - -Returns: - - None - - """ - ... - - def Save(self, FolderToSaveIn: Any, LibraryName: Any, Flags: Any) -> Any: - """ - Saves the library to a specific location - -Args: - - FolderToSaveIn(Any):The destination folder, use None to save in current user's Libraries folder - LibraryName(Any):Filename for the new library, without file extension - Flags(Any):Determines behaviour if file already exists, shellcon.LSF_*Return ValueReturns a shell item for the saved file. - -Returns: - - Any:Determines behaviour if file already exists, shellcon.LSF_*Return ValueReturns a shell item for the saved file. - - - """ - ... - - def SaveInKnownFolder(self, FolderToSaveIn: PyIID, LibraryName: Any, Flags: Any) -> Any: - """ - Saves the library in a known folder - -Args: - - FolderToSaveIn(PyIID):The destination folder, shell.FOLDERID_* - LibraryName(Any):Filename for the new library, without file extension - Flags(Any):Determines behaviour if file already exists, shellcon.LSF_* - -Returns: - - Any - - """ - ... - - -class PyIShellLink: - """Interface used to access the properties of a shell link file (*.lnk)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetPath(self, fFlags: Any, cchMaxPath: Any) -> tuple[Any, WIN32_FIND_DATA]: - """ - Retrieves the target path and file name of a shell link - -object - -Args: - - fFlags(Any):One of the following values:ValueDescriptionSLGP_SHORTPATHRetrieves the standard short (8.3 format) file name.SLGP_UNCPRIORITYRetrieves the Universal Naming Convention (UNC) path name of the file.SLGP_RAWPATHRetrieves the raw path name. A raw path is something that might not exist and may include environment variables that need to be expanded. - cchMaxPath(Any):Number of characters to allocate for returned filenameCommentsThe AlternateFileName (8.3) member of WIN32_FIND_DATA does not return information - -Returns: - - tuple[Any, WIN32_FIND_DATA] - - """ - ... - - def GetIDList(self) -> Any: - """ - Retrieves the item id list that identifies the target of the shell link. - -Args: - - - -Returns: - - Any - - """ - ... - - def SetIDList(self, pidl: Any) -> None: - """ - Sets the target of the link using an item id list - -Args: - - pidl(Any):Absolute item id list that identifies the target - -Returns: - - None - - """ - ... - - def GetDescription(self, cchMaxName: Any = 1024) -> Any: - """ - Retrieves the description of the link (displays as Comment in the UI) - -Args: - - cchMaxName(Any):Number of character to allocate for the retrieved text - -Returns: - - Any - - """ - ... - - def SetDescription(self, Name: Any) -> None: - """ - Sets the description of the link (displays as Comment in the UI) - -Args: - - Name(Any):The description for the link - -Returns: - - None - - """ - ... - - def GetWorkingDirectory(self, cchMaxName: Any = 1024) -> Any: - """ - Retrieves the working directory for the link - -Args: - - cchMaxName(Any):Number of characters to allocate for returned text - -Returns: - - Any - - """ - ... - - def SetWorkingDirectory(self, Dir: Any) -> None: - """ - Sets the working directory for the link. - -Args: - - Dir(Any):The working directory for the link - -Returns: - - None - - """ - ... - - def GetArguments(self, cchMaxName: Any = 1024) -> Any: - """ - Retrieves the command-line arguments associated with a shell link object. - -Args: - - cchMaxName(Any):Number of characters to fetch. - -Returns: - - Any - - """ - ... - - def SetArguments(self, args: Any) -> None: - """ - Sets the command-line arguments associated with a shell link object. - -Args: - - args(Any):The new arguments. - -Returns: - - None - - """ - ... - - def GetHotkey(self) -> Any: - """ - Retrieves the hot key for a shell link object. - -Args: - - - -Returns: - - Any - - """ - ... - - def SetHotkey(self, wHotkey: Any) -> None: - """ - Sets the hot key for a shell link object. - -Args: - - wHotkey(Any):The virtual key code is in the low-order byte, and the modifier flags are in the high-order byte. The modifier flags can be a combination of the values specified in the description of the PyIShellLink::GetHotkey method. - -Returns: - - None - - """ - ... - - def GetShowCmd(self) -> Any: - """ - Retrieves the show (SW_) command for a shell link object. - -Args: - - - -Returns: - - Any - - """ - ... - - def SetShowCmd(self, iShowCmd: Any) -> None: - """ - Sets the show (SW_) command for a shell link object. - -Args: - - iShowCmd(Any):The new show command value. - -Returns: - - None - - """ - ... - - def GetIconLocation(self, cchMaxPath: Any) -> Any: - """ - Retrieves the location (path and index) of the icon for a shell link - -object. - -Args: - - cchMaxPath(Any):Number of characters to allocate for the result string. - -Returns: - - Any - - """ - ... - - def SetIconLocation(self, iconPath: str, iIcon: Any) -> None: - """ - Sets the location (path and index) of the icon for a shell link object. - -Args: - - iconPath(str):Path to the file with the icon. - iIcon(Any):Index of the icon. - -Returns: - - None - - """ - ... - - def SetRelativePath(self, relPath: str, reserved: Any = 0) -> None: - """ - Sets the relative path for a shell link object. - -Args: - - relPath(str):The relative path. - reserved(Any):Reserved - must be zero.CommentsThis mechanism allows for moved link files to reestablish connection with relative files through similar-prefix comparisons - -Returns: - - None - - """ - ... - - def Resolve(self, hwnd: Any, fFlags: Any) -> None: - """ - Resolves a shell link by searching for the shell link object and updating the - -shell link path and its list of identifiers (if necessary) - -Args: - - hwnd(Any):The parent window of a dialog which will pop up if resolution fails. - fFlags(Any):One of the following constants:ValueDescriptionSLR_INVOKE_MSICall the Microsoft Windows Installer.SLR_NOLINKINFODisable distributed link tracking. By default, distributed link tracking tracks removable media across multiple devices based on the volume name. It also uses the UNC path to track remote file systems whose drive letter has changed. Setting SLR_NOLINKINFO disables both types of tracking.SLR_NO_UIDo not display a dialog box if the link cannot be resolved. When SLR_NO_UI is set, the high-order word of fFlags can be set to a time-out value that specifies the maximum amount of time to be spent resolving the link. The function returns if the link cannot be resolved within the time-out duration. If the high-order word is set to zero, the time-out duration will be set to the default value of 3,000 milliseconds (3 seconds). To specify a value, set the high word of fFlags to the desired time-out duration, in milliseconds.SLR_NOUPDATEDo not update the link information.SLR_NOSEARCHDo not execute the search heuristics.SLR_NOTRACKDo not use distributed link tracking.SLR_UPDATEIf the link object has changed, update its path and list of identifiers. If SLR_UPDATE is set, you do not need to call IPersistFile::IsDirty to determine whether or not the link object has changed. - -Returns: - - None - - """ - ... - - def SetPath(self, path: str) -> None: - """ - Sets the path and file name of a shell link object. - -Args: - - path(str):The path and filename of the link. - -Returns: - - None - - """ - ... - - -class PyIShellLinkDataList: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def AddDataBlock(self, DataBlock: Any) -> None: - """ - Inserts a data block into the link - -Args: - - DataBlock(Any):Contents are dependent on type of data block being addedCommentsInput should be one of NT_CONSOLE_PROPS, NT_FE_CONSOLE_PROPS, EXP_SPECIAL_FOLDER, EXP_DARWIN_LINK, or EXP_SZ_LINK. Expected form is indicated by the Signature member. - -Returns: - - None - - """ - ... - - def CopyDataBlock(self, Sig: Any) -> Any: - """ - Retrieves the specified data block from the link - -Args: - - Sig(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 - -Returns: - - 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 - - - """ - ... - - def GetFlags(self) -> Any: - """ - Retrieves the link's flags - -Args: - - - -Returns: - - Any:PyIShellLinkDataList.GetFlags - -int = GetFlags()Retrieves the link's flags -Return ValueReturns combination of shellcon.SLDF_* flags - - - """ - ... - - def RemoveDataBlock(self, Sig: Any) -> None: - """ - Deletes one of the link's data blocks - -Args: - - Sig(Any):Identifies which block is to be removed, one of shellcon.*_SIG constants - -Returns: - - None - - """ - ... - - def SetFlags(self, Flags: Any) -> None: - """ - Sets the flags indicating which data blocks are present - -Args: - - Flags(Any):Combination of shellcon.SLDF_* flags - -Returns: - - None - - """ - ... - - -class PyIShellView: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def TranslateAccelerator(self, pmsg: Any) -> Any: - """ - Description of TranslateAccelerator. - -Args: - - pmsg(Any):Description for pmsgReturn ValueThe result is the HRESULT from the underlying TranslateAccelerator call - -Returns: - - Any:Description for pmsgReturn ValueThe result is the HRESULT from the underlying TranslateAccelerator call - - - """ - ... - - def EnableModeless(self, fEnable: Any) -> None: - """ - Description of EnableModeless. - -Args: - - fEnable(Any):Description for fEnable - -Returns: - - None - - """ - ... - - def UIActivate(self, uState: Any) -> None: - """ - Description of UIActivate. - -Args: - - uState(Any):Description for uState - -Returns: - - None - - """ - ... - - def Refresh(self) -> None: - """ - Description of Refresh. - -Args: - - - -Returns: - - None - - """ - ... - - def CreateViewWindow( - self, - psvPrevious: Any, - pfs: tuple[Any, Any], - psb: Any, - prcView: tuple[Any, Any, Any, Any]) -> Any: - """ - Description of CreateViewWindow. - -Args: - - psvPrevious(Any):Description for psvPrevious - pfs(tuple[Any, Any]):Description for pfs - psb(Any):Description for psb - prcView(tuple[Any, Any, Any, Any]):Description for prcViewReturn ValueThe result is an integer handle to the new window. - -Returns: - - Any:Description for prcViewReturn ValueThe result is an integer handle to the new window. - - - """ - ... - - def DestroyViewWindow(self) -> None: - """ - Description of DestroyViewWindow. - -Args: - - - -Returns: - - None - - """ - ... - - def GetCurrentInfo(self) -> Any: - """ - Description of GetCurrentInfo. - -Args: - - - -Returns: - - Any - - """ - ... - - def SaveViewState(self) -> None: - """ - Description of SaveViewState. - -Args: - - - -Returns: - - None - - """ - ... - - def SelectItem(self, pidlItem: Any, uFlags: Any) -> None: - """ - Description of SelectItem. - -Args: - - pidlItem(Any):Description for pidlItem - uFlags(Any):Description for uFlags - -Returns: - - None - - """ - ... - - def GetItemObject(self, uItem: Any, riid: PyIID) -> Any: - """ - Description of GetItemObject. - -Args: - - uItem(Any):Description for uItem - riid(PyIID):Description for riid - -Returns: - - Any - - """ - ... - - -class PyISpecifyPropertyPages: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetPages(self) -> None: - """ - Description of GetPages. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIStorage: - """Structured storage compound storage object""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CreateStream(self, Name: Any, Mode: Any, reserved1: Any = 0, reserved2: Any = 0) -> Any: - """ - 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 - -the same name space. - -Args: - - Name(Any):Name of the new stream - Mode(Any):Access mode, storagecon.STGM_* - reserved1(Any):Reserved - must be zero. - reserved2(Any):Reserved - must be zero. - -Returns: - - Any - - """ - ... - - def OpenStream(self, Name: Any, reserved1: Any, Mode: Any, reserved2: Any = 0) -> Any: - """ - Opens an existing stream object within this storage object in the - -specified access mode. - -Args: - - Name(Any):Name of stream to be opened - reserved1(Any):A reserved param. Always ... None. NULL is always passed to the COM function - Mode(Any):Access mode, storagecon.STGM_* - reserved2(Any):Reserved - must be zero. - -Returns: - - Any - - """ - ... - - def CreateStorage(self, Name: Any, Mode: Any, StgFmt: Any, reserved2: Any = 0) -> Any: - """ - Creates and opens a new storage object nested within this storage - -object. - -Args: - - Name(Any):The name of the newly created stream. - Mode(Any):Access mode - combination of storagecon.STGM_* flags - StgFmt(Any):Documented as "reserved"! - reserved2(Any):Description for reserved2 - -Returns: - - Any - - """ - ... - - def OpenStorage(self, Name: Any, Priority: Any, Mode: Any, snbExclude: Any, reserved: Any = 0) -> Any: - """ - Opens an existing storage object with the specified name in the - -specified access mode. - -Args: - - Name(Any):Name of the storage, or None. - Priority(Any):If the pstgPriority parameter is not None, it is a PyIStorage object to a previous opening of an element of the storage object, usually one that was opened in priority mode. The storage object should be closed and re-opened according to grfMode. When the PyIStorage::OpenStorage method returns, pstgPriority is no longer valid - use the result value. If the pstgPriority parameter is None, it is ignored. - Mode(Any):Access mode - combination of storagecon.STGM_* flags (must include STGM_SHARE_EXCLUSIVE) - snbExclude(Any):Reserved for later - Must be None - reserved(Any):Reserved integer param. - -Returns: - - Any - - """ - ... - - def CopyTo(self, rgiidExclude: tuple[Any, Any], snbExclude: Any, stgDest: Any) -> None: - """ - Copies the entire contents of an open storage object to another storage object. - -Args: - - rgiidExclude(tuple[Any, Any]):list of IID's to be excluded. Use empty seq to exclude all objects, or None to indicate no excludes. - snbExclude(Any):Reserved for later - Must be None - stgDest(Any):The open storage object into which this storage object is to be copied. The destination storage object can be a different implementation of the PyIStorage interface from the source storage object. Thus, IStorage::CopyTo can only use publicly available methods of the destination storage object. If stgDest is open in transacted mode, it can be reverted by calling its PyIStorage::Revert method. - -Returns: - - None - - """ - ... - - def MoveElementTo(self, Name: Any, stgDest: Any, NewName: Any, Flags: Any) -> None: - """ - Copies or moves a substorage or stream from this storage object to another - -storage object. - -Args: - - Name(Any):A string that contains the name of the element in this storage object to be moved or copied. - stgDest(Any):PyIStorage for the destination storage object. - NewName(Any):A string that contains the new name for the element in its new storage object. - Flags(Any):Specifies whether to move or copy (storagecon.STGMOVE_MOVE or STGMOVE_COPY) - -Returns: - - None - - """ - ... - - def Commit(self, grfCommitFlags: Any) -> None: - """ - 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. - -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. - -Args: - - grfCommitFlags(Any):Controls how the changes are committed to the storage object. See the STGC enumeration for a definition of these values. - -Returns: - - None - - """ - ... - - def Revert(self) -> None: - """ - Discards all changes that have been made to the storage object since the last commit. - -Args: - - - -Returns: - - None - - """ - ... - - def EnumElements(self, reserved1: Any = 0, reserved2: Any = None, reserved3: Any = 0) -> Any: - """ - Retrieves an enumerator object that can be used to enumerate the - -storage and stream objects contained within this storage object. - -Args: - - reserved1(Any):Reserved - must be zero. - reserved2(Any):A reserved param. Always ... None. NULL is always passed to the COM function - reserved3(Any):Reserved - must be zero. - -Returns: - - Any - - """ - ... - - def DestroyElement(self, name: str) -> None: - """ - Removes the specified storage or stream from this storage object. - -Args: - - name(str):The name of the element to be removed. - -Returns: - - None - - """ - ... - - def RenameElement(self, OldName: Any, NewName: Any) -> None: - """ - Renames the specified substorage or stream in this storage object. - -Args: - - OldName(Any):The name of the substorage or stream to be changed. - NewName(Any):The new name for the specified sustorage or stream. - -Returns: - - None - - """ - ... - - def SetElementTimes(self, name: Any, ctime: PyTime, atime: PyTime, mtime: PyTime) -> None: - """ - Sets the modification, access, and creation times of the specified storage - -element, if supported by the underlying file system. - -Args: - - name(Any):The name of the storage object element whose times are to be modified. If NULL, the time is set on the root storage rather than one of its elements. - ctime(PyTime):Either the new creation time for the element or None if the creation time is not to be modified. - atime(PyTime):Either the new access time for the element or None if the access time is not to be modified. - mtime(PyTime):Either the new modification time for the element or None if the modification time is not to be modified. - -Returns: - - None - - """ - ... - - def SetClass(self, clsid: PyIID) -> None: - """ - Assigns the specified CLSID to this storage object. - -Args: - - clsid(PyIID):The class identifier (CLSID) that is to be associated with the storage object. - -Returns: - - None - - """ - ... - - def SetStateBits(self, grfStateBits: Any, grfMask: Any) -> None: - """ - Stores up to 32 bits of state information in this storage object. - -Args: - - grfStateBits(Any):Specifies the new values of the bits to set. No legal values are defined for these bits; they are all reserved for future use and must not be used by applications. - grfMask(Any):A binary mask indicating which bits in grfStateBits are significant in this call. - -Returns: - - None - - """ - ... - - def Stat(self, grfStatFlag: Any) -> Any: - """ - Retrieves the STATSTG structure for this open storage object. - -Args: - - grfStatFlag(Any):Specifies that some of the fields in the STATSTG structure are not returned, thus saving a memory allocation operation. Values are taken from the STATFLAG enumeration. - -Returns: - - Any - - """ - ... - - -class PyIStream: - """A Python interface to IStream""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Read(self, numBytes: Any) -> str: - """ - Read the specified number of bytes from the string. - -Args: - - numBytes(Any):The number of bytes to read from the stream. Must not be zero.Return ValueThe result is a string containing binary data. - -Returns: - - str:The number of bytes to read from the stream. Must not be zero.Return ValueThe result is a string containing binary data. - - - """ - ... - - def read(self, numBytes: Any) -> str: - """ - Read the specified number of bytes from the string. - -Args: - - numBytes(Any):The number of bytes to read from the stream. Must not be zero.Return ValueThe result is a string containing binary data. - -Returns: - - str:The number of bytes to read from the stream. Must not be zero.Return ValueThe result is a string containing binary data. - - - """ - ... - - def Write(self, data: str) -> None: - """ - Write data to a stream - -Args: - - data(str):The binary data to write. - -Returns: - - None - - """ - ... - - def write(self, data: str) -> None: - """ - Write data to a stream - -Args: - - data(str):The binary data to write. - -Returns: - - None - - """ - ... - - def Seek(self, offset: Any, origin: Any) -> ULARGE_INTEGER: - """ - Changes the seek pointer to a new location. - -Args: - - offset(Any):The new location - origin(Any):Relative to where? - -Returns: - - ULARGE_INTEGER - - """ - ... - - def SetSize(self, newSize: ULARGE_INTEGER) -> None: - """ - Changes the size of the stream object. - -Args: - - newSize(ULARGE_INTEGER):The new size - -Returns: - - None - - """ - ... - - def CopyTo(self, stream: Any, cb: ULARGE_INTEGER) -> ULARGE_INTEGER: - """ - Copies a specified number of bytes from the current seek pointer in the - -stream to the current seek pointer in another stream. - -Args: - - stream(Any):The stream to write to. - cb(ULARGE_INTEGER):The number of bytes to write.Return ValueThe return value is the number of bytes actually written. - -Returns: - - ULARGE_INTEGER:The number of bytes to write.Return ValueThe return value is the number of bytes actually written. - - - """ - ... - - def Commit(self, flags: Any) -> None: - """ - Ensures that any changes made to a stream object open in transacted mode are reflected in - -the parent storage. - -Args: - - flags(Any):Controls how changes are performed. - -Returns: - - None - - """ - ... - - def Revert(self) -> None: - """ - None - -Args: - - - -Returns: - - None - - """ - ... - - def LockRegion(self, offset: ULARGE_INTEGER, cb: ULARGE_INTEGER, lockType: Any) -> None: - """ - Restricts access to a specified range of bytes in the stream. - -Args: - - offset(ULARGE_INTEGER):Integer that specifies the byte offset for the beginning of the range. - cb(ULARGE_INTEGER):The number of bytes to restrict. - lockType(Any):Restrictions requested. - -Returns: - - None - - """ - ... - - def UnLockRegion(self, offset: ULARGE_INTEGER, cb: ULARGE_INTEGER, lockType: Any) -> None: - """ - None - -Args: - - offset(ULARGE_INTEGER):Integer that specifies the byte offset for the beginning of the range. - cb(ULARGE_INTEGER):The number of bytes to restrict. - lockType(Any):Restrictions requested. - -Returns: - - None - - """ - ... - - def Clone(self) -> Any: - """ - Creates a new stream object with its own seek pointer that references the - -same bytes as the original stream. - -Args: - - - -Returns: - - Any - - """ - ... - - def Stat(self, grfStatFlag: Any = 0) -> Any: - """ - Returns information about the stream - -Args: - - grfStatFlag(Any):Flags. - -Returns: - - Any - - """ - ... - - -class PyITask: - """Python object that encapsulates the ITask interface, inherits all the methods of PyIScheduledWorkItem""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def SetApplicationName(self, ApplicationName: Any) -> None: - """ - Specify which program the task will run - -Args: - - ApplicationName(Any):Program to execute - -Returns: - - None - - """ - ... - - def GetApplicationName(self) -> Any: - """ - Retrieve name of program that task will run - -Args: - - - -Returns: - - Any - - """ - ... - - def SetParameters(self, Parameters: Any) -> None: - """ - Sets command line parameters - -Args: - - Parameters(Any):String containing command line parameters - -Returns: - - None - - """ - ... - - def GetParameters(self) -> Any: - """ - Returns command line parameters for task - -Args: - - - -Returns: - - Any - - """ - ... - - def SetWorkingDirectory(self, WorkingDirectory: Any) -> None: - """ - Sets initial working directory for task - -Args: - - WorkingDirectory(Any):Initial working directory - -Returns: - - None - - """ - ... - - def GetWorkingDirectory(self) -> Any: - """ - Return working directory that the task will start out in - -Args: - - - -Returns: - - Any - - """ - ... - - def SetPriority(self, Priority: Any) -> None: - """ - Sets priority for task - -Args: - - Priority(Any):One of REALTIME_PRIORITY_CLASS, HIGH_PRIORITY_CLASS, NORMAL_PRIORITY_CLASS, IDLE_PRIORITY_CLASS - -Returns: - - None - - """ - ... - - def GetPriority(self) -> Any: - """ - Gets priority that will be assigned to process when task starts - -Args: - - - -Returns: - - Any - - """ - ... - - def SetTaskFlags(self, dwFlags: Any) -> None: - """ - Sets flag for task. - -Args: - - dwFlags(Any):None currently defined - -Returns: - - None - - """ - ... - - def GetTaskFlags(self) -> Any: - """ - Retrieve task flags (None currently defined) - -Args: - - - -Returns: - - Any - - """ - ... - - def SetMaxRunTime(self, MaxRunTimeMS: Any) -> None: - """ - Sets maximun run time for task, use -1 to disable - -Args: - - MaxRunTimeMS(Any):Specified in milliseconds (use -1 to disable, not 0) - -Returns: - - None - - """ - ... - - def GetMaxRunTime(self) -> Any: - """ - Returns maximun run time for task - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyITaskScheduler: - """Interface to the Windows Task Scheduler""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def SetTargetComputer(self, Computer: Any) -> None: - """ - Connect to another machine to manage its tasks - -Args: - - Computer(Any):Name of system to connect toCommentsLeading backslashes are required. Call will succeed without them, but no other methods will work. - -Returns: - - None - - """ - ... - - def GetTargetComputer(self) -> Any: - """ - Returns name of computer that the Task Scheduler is - -connected to - -Args: - - - -Returns: - - Any - - """ - ... - - def Enum(self) -> tuple[str, ...]: - """ - Retrieve list of task names - -Args: - - - -Returns: - - tuple[str, ...] - - """ - ... - - def Activate(self, Name: Any, riid: PyIID) -> Any: - """ - Opens the specified task and returns an ITask interface for it - -Args: - - Name(Any):Name of task to retreive - riid(PyIID):IID to return, currently only IID_ITask accepted - -Returns: - - Any - - """ - ... - - def Delete(self, TaskName: Any) -> None: - """ - Delete task by name - -Args: - - TaskName(Any):Name of task to delete - -Returns: - - None - - """ - ... - - def NewWorkItem(self, TaskName: Any, rclsid: PyIID, riid: PyIID) -> Any: - """ - Creates a new task - -Args: - - TaskName(Any):Name of new task - rclsid(PyIID):Class id of work item, currently only CLSID_CTask (defaults if not passed in) - riid(PyIID):Interface IID to return, currently only IID_ITask (defaults if not passed in) - -Returns: - - Any - - """ - ... - - def AddWorkItem(self, TaskName: Any, WorkItem: Any) -> None: - """ - Create a new scheduled task from PyITask object - -Args: - - TaskName(Any):Name of task to be created - WorkItem(Any):Existing PyITask objectCommentsThe PyItask passed in is modified in place and on success is associated with the new task, not the old one - -Returns: - - None - - """ - ... - - def IsOfType(self, Name: Any, riid: PyIID) -> None: - """ - Check if named object supports specified interface - -Args: - - Name(Any):Name of object - riid(PyIID):Named object is checked that it supports the interface of this IID - -Returns: - - None - - """ - ... - - -class PyITaskTrigger: - """Python object that encapsulates the ITaskTrigger interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def SetTrigger(self, Trigger: Any) -> None: - """ - Set trigger parameters from a PyTASK_TRIGGER object - -Args: - - Trigger(Any):Python object representing a TASK_TRIGGER struct - -Returns: - - None - - """ - ... - - def GetTrigger(self) -> Any: - """ - Retrieves trigger parms as a PyTASK_TRIGGER object - -Args: - - - -Returns: - - Any - - """ - ... - - def GetTriggerString(self) -> str: - """ - Build text summary of trigger - -Args: - - - -Returns: - - str - - """ - ... - - -class PyITaskbarList: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def HrInit(self) -> None: - """ - Intializes the interface before use - -Args: - - - -Returns: - - None - - """ - ... - - def AddTab(self, hwnd: int) -> None: - """ - Places a window on the taskbar - -Args: - - hwnd(int):Handle to window, should have WS_CAPTION style - -Returns: - - None - - """ - ... - - def DeleteTab(self, hwnd: int) -> None: - """ - Removes a window from the taskbar - -Args: - - hwnd(int):Handle to window, should have WS_CAPTION style - -Returns: - - None - - """ - ... - - def ActivateTab(self, hwnd: int) -> None: - """ - Marks a window as the active tab on the taskbar - -Args: - - hwnd(int):Handle to window, should have WS_CAPTION style - -Returns: - - None - - """ - ... - - def SetActiveAlt(self, hwnd: int) -> None: - """ - Sets the window as the active tab, without displaying it as pressed on the - -taskbar - -Args: - - hwnd(int):Handle to window, should have WS_CAPTION style - -Returns: - - None - - """ - ... - - -class PyITransferAdviseSink: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def UpdateProgress( - self, - SizeCurrent: Any, - SizeTotal: Any, - FilesCurrent: Any, - FilesTotal: Any, - FoldersCurrent: Any, - FoldersTotal: Any) -> None: - """ - Gives an estimate of amount of work completed - -Args: - - SizeCurrent(Any):Bytes transferred so far - SizeTotal(Any):Total number of bytes - FilesCurrent(Any):Number of files processed already - FilesTotal(Any):Total number of files - FoldersCurrent(Any):Number of folders processed already - FoldersTotal(Any):Total number of folder - -Returns: - - None - - """ - ... - - def UpdateTransferState(self, State: Any) -> None: - """ - Notifies client of current operation state - -Args: - - State(Any):A TRANSFER_ADVISE_STATE value (shellcon.TS_*) - -Returns: - - None - - """ - ... - - def ConfirmOverwrite(self, Source: Any, DestParent: Any, Name: Any) -> Any: - """ - Asks user for permission to overwrite an existing item - -Args: - - Source(Any):The item that will replace existing item - DestParent(Any):Folder into which item will be placed - Name(Any):New name for item, or None if item is to keep original name - -Returns: - - Any - - """ - ... - - def ConfirmEncryptionLoss(self, Source: Any) -> Any: - """ - Notifies user when an item can't be encrypted at - -destination - -Args: - - Source(Any):Item that failed to be encrypted - -Returns: - - Any - - """ - ... - - def FileFailure(self, Item: Any, ItemName: Any, Error: Any) -> tuple[Any, Any]: - """ - Notifies user of failure, and queries how to proceed - -Args: - - Item(Any):The shell item that caused the failure - ItemName(Any):Name of item if different than above, can be None - Error(Any):HRESULT error code from operationReturn ValueReturns the HRESULT and new file name if renaming resolved the failure - -Returns: - - tuple[Any, Any]:HRESULT error code from operationReturn ValueReturns the HRESULT and new file name if renaming resolved the failure - - - """ - ... - - def SubStreamFailure(self, Item: Any, StreamName: Any, Error: Any) -> Any: - """ - Notifies user of failure on a substream, and queries how to - -proceed - -Args: - - Item(Any):The item whose stream couldn't be created - StreamName(Any):Name of the failed stream - Error(Any):HRESULT failure code from operationReturn ValueReturns COPYENGINE_S_* if operation is to continue, or COPYENGINE_E_* HRESULT if cancelled - -Returns: - - Any:HRESULT failure code from operationReturn ValueReturns COPYENGINE_S_* if operation is to continue, or COPYENGINE_E_* HRESULT if cancelled - - - """ - ... - - def PropertyFailure(self, Item: Any, key: Any, Error: Any) -> Any: - """ - Notifies user of failure to set an item's properties - -Args: - - Item(Any):The item whose property could not be set - key(Any):Identifies the property that caused the error, or None if all properties failed - Error(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 - -Returns: - - 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 - - - """ - ... - - -class PyITransferDestination: - """Implemented by shell extensions that act as targets for item copy or move operations""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Advise(self, Sink: Any) -> Any: - """ - Connects an advise sink - -Args: - - Sink(Any):Event sink to receive notificationsReturn ValueReturns an id for the connection, to be passed to PyITransferDestination::Unadvise - -Returns: - - Any:Event sink to receive notificationsReturn ValueReturns an id for the connection, to be passed to PyITransferDestination::Unadvise - - - """ - ... - - def Unadvise(self, Cookie: Any) -> None: - """ - Disconnects an advise sink - -Args: - - Cookie(Any):Connection identifier as returned by PyITransferDestination::Advise - -Returns: - - None - - """ - ... - - def CreateItem(self, Name: Any, Attributes: Any, Size: Any, Flags: Any, - riidItem: PyIID, riidResources: PyIID) -> tuple[Any, Any, Any]: - """ - Requests that a new item be created - -Args: - - Name(Any):Filename to be created - Attributes(Any):File attributes - Size(Any):Size of file - Flags(Any):Combination of shellcon.TSF_* flags - riidItem(PyIID):Item interface to return - riidResources(PyIID):Resource interface to returnReturn ValueReturns the HRESULT and requested interfaces. Interfaces may be None if function returns one of the informational codes (shellcon.COPYENGINE_S_*) - -Returns: - - tuple[Any, Any, Any]:Resource interface to return -Return ValueReturns the HRESULT and requested interfaces. Interfaces may be None if - -function returns one of the informational codes (shellcon.COPYENGINE_S_*) - - - """ - ... - - -class PyITransferMediumItem: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyITransferSource: - """Implemented by shell folders that can act as the source of shell item operations""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Advise(self, Sink: Any) -> Any: - """ - Connects an advise sink to receive notifications - -Args: - - Sink(Any):Event sink to respond to notifications - -Returns: - - Any - - """ - ... - - def Unadvise(self, Cookie: Any) -> None: - """ - Disconnects an event sink - -Args: - - Cookie(Any):Connection id as returned by PyITransferSource::Advise - -Returns: - - None - - """ - ... - - def SetProperties(self, proparray: Any) -> None: - """ - Specifies changes to be applied to items' properties - -Args: - - proparray(Any):Property changes to be applied by PyITransferSource::ApplyPropertiesToItem - -Returns: - - None - - """ - ... - - def OpenItem(self, Item: Any, flags: Any, riid: PyIID) -> tuple[Any, Any]: - """ - Initiates the copying of an item - -Args: - - Item(Any):The item to be copied. - flags(Any):Combination of shellcon.TSF_* flags - riid(PyIID):The interface to return - -Returns: - - tuple[Any, Any] - - """ - ... - - def MoveItem(self, Item: Any, ParentDst: Any, NameDst: Any, flags: Any) -> tuple[Any, Any]: - """ - Moves a shell item into another folder - -Args: - - Item(Any):Item to be moved - ParentDst(Any):The folder into which it will be moved - NameDst(Any):New name for item after move, None to keep same name - flags(Any):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 of expected actions for specific error codes. - -Returns: - - tuple[Any, Any]: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 - -of expected actions for specific error codes. - - - """ - ... - - def RecycleItem(self, Source: Any, ParentDest: Any, flags: Any) -> tuple[Any, Any]: - """ - Moves an item to the recycle bin - -Args: - - Source(Any):The item to be recycled - ParentDest(Any):Shell item representing the recycle bin - flags(Any):Combination of shellcon.TSF_* flags - -Returns: - - tuple[Any, Any] - - """ - ... - - def RemoveItem(self, Source: Any, flags: Any) -> Any: - """ - Deletes an item without recycling - -Args: - - Source(Any):The item to be deleted - flags(Any):Combination of shellcon.TSF_* flagsReturn ValueReturns the HRESULT of the operation - -Returns: - - Any:Combination of shellcon.TSF_* flagsReturn ValueReturns the HRESULT of the operation - - - """ - ... - - def RenameItem(self, Source: Any, NewName: Any, flags: Any) -> tuple[Any, Any]: - """ - Renames a shell item - -Args: - - Source(Any):Item to be renamed - NewName(Any):The name to be given to the item - flags(Any):Combination of shellcon.TSF_* flags - -Returns: - - tuple[Any, Any] - - """ - ... - - def LinkItem(self, Source: Any, ParentDest: Any, NewName: Any, flags: Any) -> tuple[Any, Any]: - """ - Not implemented, according to MSDN - -Args: - - Source(Any):Description for psiSource - ParentDest(Any):Description for psiParentDest - NewName(Any):Description for NewName - flags(Any):Combination of shellcon.TSF_* flags - -Returns: - - tuple[Any, Any] - - """ - ... - - def ApplyPropertiesToItem(self, Source: Any) -> Any: - """ - None - -Args: - - Source(Any):Item whose properties are to be changed - -Returns: - - Any - - """ - ... - - def GetDefaultDestinationName(self, Source: Any, ParentDest: Any) -> Any: - """ - Determines the name of an item as it would appear in a - -given folder - -Args: - - Source(Any):The item whose name is wanted - ParentDest(Any):The destination folder - -Returns: - - Any - - """ - ... - - def EnterFolder(self, ChildFolderDest: Any) -> Any: - """ - Informs the copy engine that a folder will be the target of a file - -operation - -Args: - - ChildFolderDest(Any):The destination folder for the operation - -Returns: - - Any - - """ - ... - - def LeaveFolder(self, ChildFolderDest: Any) -> Any: - """ - Informs the copy engine that the operation on a destination folder is - -finished - -Args: - - ChildFolderDest(Any):Destination folder - -Returns: - - Any - - """ - ... - - -class PyITypeComp: - """An object that implements the ITypeComp interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Bind(self, szName: str, wflags: Any = 0) -> Any: - """ - binds to a variable/type - -Args: - - szName(str):The name to bind to - wflags(Any):the bind flags - -Returns: - - Any - - """ - ... - - def BindType(self, szName: str) -> Any: - """ - binds to a type - -Args: - - szName(str):The name to bind to - -Returns: - - Any - - """ - ... - - -class PyITypeInfo: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetContainingTypeLib(self) -> tuple[Any, Any]: - """ - Retrieves the containing type library and the index of - -the type description within that type library. - -Args: - - - -Returns: - - tuple[Any, Any] - - """ - ... - - def GetDocumentation(self, memberId: Any) -> tuple[Any, Any, Any, Any]: - """ - Retrieves the documentation string, - -the complete Help file name and path, and the context ID for the Help topic for a specified type description. - -Args: - - memberId(Any): - -Returns: - - tuple[Any, Any, Any, Any] - - """ - ... - - def GetFuncDesc(self, memberId: Any) -> Any: - """ - None - -Args: - - memberId(Any): - -Returns: - - Any - - """ - ... - - def GetImplTypeFlags(self, index: Any) -> Any: - """ - Retrieves the IMPLTYPEFLAGS enumeration for one implemented interface or - -base interface in a type description. - -Args: - - index(Any): - -Returns: - - Any - - """ - ... - - def GetIDsOfNames(self) -> Any: - """ - Maps between member names and member IDs, and parameter names and parameter - -IDs. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetNames(self, memberId: Any) -> Any: - """ - 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. - -Args: - - memberId(Any): - -Returns: - - Any - - """ - ... - - def GetTypeAttr(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def GetRefTypeInfo(self, hRefType: Any) -> Any: - """ - If a type description references other type descriptions, it - -retrieves the referenced type descriptions. - -Args: - - hRefType(Any): - -Returns: - - Any - - """ - ... - - def GetRefTypeOfImplType(self, hRefType: Any) -> Any: - """ - Retrieves the type description of the implemented interface types. - -Args: - - hRefType(Any):CommentsIf a type description describes a COM class, it retrieves the type description of the implemented interface types. For an interface, GetRefTypeOfImplType returns the type information for inherited interfaces, if any exist. - -Returns: - - Any - - """ - ... - - def GetVarDesc(self, memberId: Any) -> Any: - """ - None - -Args: - - memberId(Any): - -Returns: - - Any - - """ - ... - - def GetTypeComp(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyITypeLib: - """An object that implements the ITypeLib interface.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetDocumentation(self, index: Any) -> Any: - """ - Retrieves documentation information about the library. - -Args: - - index(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) - -Returns: - - 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) - - - """ - ... - - def GetLibAttr(self) -> Any: - """ - Retrieves the libraries attributes - -Args: - - - -Returns: - - Any - - """ - ... - - def GetTypeComp(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def GetTypeInfo(self, index: Any) -> Any: - """ - Retrieves the specified type description in the library. - -Args: - - index(Any):The index of the type description within the library - -Returns: - - Any - - """ - ... - - def GetTypeInfoCount(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def GetTypeInfoOfGuid(self, iid: PyIID) -> Any: - """ - Retrieves the type info of the specified GUID. - -Args: - - iid(PyIID):GUID of the type description. - -Returns: - - Any - - """ - ... - - def GetTypeInfoType(self, index: Any) -> Any: - """ - Retrieves the type of a type description. - -Args: - - index(Any):The index of the type description within the library - -Returns: - - Any - - """ - ... - - -class PyIUniformResourceLocator: - """Interface to an internet shortcut""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetURL(self) -> Any: - """ - Returns the URL for the shortcut - -Args: - - - -Returns: - - Any - - """ - ... - - def SetURL(self, URL: Any, InFlags: Any = 0) -> None: - """ - Sets the URL for the shortcut - -Args: - - URL(Any):The url to be set - InFlags(Any):One of the shellcon.IURL_SETURL* flags - -Returns: - - None - - """ - ... - - def InvokeCommand(self, Verb: Any, Flags: Any = 0, hwndParent: int = 0) -> Any: - """ - Performs one of the object's predefined actions - -Args: - - Verb(Any):The verb to be invoked - Flags(Any):Combination of shellcon.IURL_INVOKECOMMAND_* flags - hwndParent(int):Handle to parent window - -Returns: - - Any - - """ - ... - - -class PyIUnknown: - """The base object for all PythonCOM objects. Wraps a COM IUnknown object.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def QueryInterface(self, iid: Any, useIID: Any = None) -> Any: - """ - Queries an object for a specific interface. - -Args: - - iid(Any):The IID requested. - useIID(Any):If provided and not None, will return an 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.CommentsThe useIID parameter is a very dangerous option, and should only be used when you are sure you need it! 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 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. For example, this option can be used to obtain a PyIUnknown object if pythoncom does not natively support the interface. Another example might be to return an unsupported persistence interface as a PyIPersist instance. 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. Any error (including E_NOINTERFACE) will generate a com_error exception. - -Returns: - - Any:If provided and not None, will return an - -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 - -be used when you are sure you need it! - -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 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. - -For example, this option can be used to obtain a PyIUnknown object if - -pythoncom does not natively support the interface. - -Another example might be to return an unsupported persistence interface as a - -PyIPersist instance. - -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. - -Any error (including E_NOINTERFACE) will generate a com_error exception. - - - """ - ... - - -class PyIViewObject: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Draw( - self, - dwDrawAspect: Any, - lindex: Any, - aspectFlags: Any, - hdcTargetDev: Any, - hdcDraw: Any, - arg: tuple[Any, Any, Any, Any], - arg1: tuple[Any, Any, Any, Any], - funcContinue: Any, - obContinue: Any) -> None: - """ - Description of Draw. - -Args: - - dwDrawAspect(Any):Description for dwDrawAspect - lindex(Any):Description for lindex - aspectFlags(Any):Integer value for the dwFlags item of the DVASPECTINFO structure. - hdcTargetDev(Any):Description for hdcTargetDev - hdcDraw(Any):Description for hdcDraw - arg(tuple[Any, Any, Any, Any]):Bounds rectangle. - arg1(tuple[Any, Any, Any, Any]):WBounds rectangle. - funcContinue(Any):A continue function. - obContinue(Any):Value passed to the function. - -Returns: - - None - - """ - ... - - def GetColorSet(self, dwDrawAspect: Any, lindex: Any, aspectFlags: Any, hicTargetDev: Any) -> None: - """ - Description of GetColorSet. - -Args: - - dwDrawAspect(Any):Description for dwDrawAspect - lindex(Any):Description for lindex - aspectFlags(Any):Integer value for the dwFlags item of the DVASPECTINFO structure. - hicTargetDev(Any):Description for hicTargetDev - -Returns: - - None - - """ - ... - - def Freeze(self, dwDrawAspect: Any, lindex: Any, aspectFlags: Any) -> None: - """ - Description of Freeze. - -Args: - - dwDrawAspect(Any):Description for dwDrawAspect - lindex(Any):Description for lindex - aspectFlags(Any):Integer value for the dwFlags item of the DVASPECTINFO structure. - -Returns: - - None - - """ - ... - - def Unfreeze(self, dwFreeze: Any) -> None: - """ - Description of Unfreeze. - -Args: - - dwFreeze(Any):Description for dwFreeze - -Returns: - - None - - """ - ... - - def SetAdvise(self, aspects: Any, advf: Any, pAdvSink: Any) -> None: - """ - Description of SetAdvise. - -Args: - - aspects(Any):Description for aspects - advf(Any):Description for advf - pAdvSink(Any):Description for pAdvSink - -Returns: - - None - - """ - ... - - def GetAdvise(self) -> None: - """ - Description of GetAdvise. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyIViewObject2: - """Description of the interface""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetExtent(self, dwDrawAspect: Any, lindex: Any, targetDevice: Any) -> None: - """ - Description of GetExtent. - -Args: - - dwDrawAspect(Any):Description for dwDrawAspect - lindex(Any):Description for lindex - targetDevice(Any):Description for lindex - -Returns: - - None - - """ - ... - - -class PyMAPINAMEIDArray: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyOLEMENUGROUPWIDTHS: - """tuple containing 6 ints indicating nbr of options in each menu group""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyPROPERTYKEY: - """A tuple of a fmtid and property id (IID, int) that uniquely identifies a property""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyPROPVARIANT: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def vt(self) -> Any: - """The variant type, a combination of VARENUM values including flags. (read only)MethodsGetValueReturns an object representing the variant value ToStringReturns the value as a string ChangeTypeCoerce to a different variant type """ - ... - - def GetValue(self) -> Any: - """ - Returns an object representing the variant value - -Args: - - - -Returns: - - Any - - """ - ... - - def ToString(self) -> Any: - """ - Returns the value as a string - -Args: - - - -Returns: - - Any - - """ - ... - - def ChangeType(self, Type: Any, Flags: Any = 0) -> Any: - """ - Coerce to a different variant type - -Args: - - Type(Any):New variant type, combination of pythoncom.VT_* values - Flags(Any):Reserved (PROPVAR_CHANGE_FLAGS)Win32 API References - -Returns: - - Any - - """ - ... - - -class PySAndRestriction: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySBinaryArray: - """A sequence of strings containing binary data.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySBitMaskRestriction: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySContentRestriction: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySExistRestriction: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySHELL_ITEM_RESOURCE: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySNotRestriction: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySOrRestriction: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySPropTagArray: - """A sequence of integers""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySPropValue: - """A MAPI property value. Property values can either be passed from - -python into MAPI functions, or returned from MAPI functions to Python.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySPropValueArray: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySPropertyRestriction: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySRestriction: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySRow: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySRowSet: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySSortOrderItem: - """An item in a SortOrderSet.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySSortOrderSet: - """An object describing a SortOrderSet.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PySTGMEDIUM: - """A STGMEDIUM object represents a COM STGMEDIUM structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def tymed(self) -> Any: - """An integer indicating the type of data in the stgmedium""" - ... - - @property - def data(self) -> Any: - """The data in the stgmedium. The result depends on the value of the 'tymed' property of the PySTGMEDIUM object.tymedResult TypeTYMED_GDIAn integer GDI handleTYMED_MFPICTAn integer METAFILE handleTYMED_ENHMFAn integer ENHMETAFILE handleTYMED_HGLOBALA string with the bytes of the global memory object.TYMED_FILEA string/unicode filenameTYMED_ISTREAMA PyIStream objectTYMED_ISTORAGEA PyIStorage object""" - ... - - @property - def data_handle(self) -> Any: - """The raw 'integer' representation of the data. For TYMED_HGLOBAL, this is the handle rather than the string data. For the string and interface types, this is an integer holding the pointer.""" - ... - - def set(self, tymed: Any, data: Any) -> None: - """ - Sets the type and data of the object. - -Args: - - tymed(Any):The type of the data - data(Any): - -Returns: - - None - - """ - ... - - -class PyTASK_TRIGGER: - """Python object representing a TASK_TRIGGER structure via the structmember Api""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class RTF_WCSINFO: - """A tuple representing a RTF_WCSINFO structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SHFILEINFO: - """A tuple representing a SHFILEINFO structure - -Represented as a tuple of (hIcon, iIcon, dwAttributes, displayName, typeName)""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SHFILEOPSTRUCT: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SI_ACCESS: - """tuple of 4 items representing SI_ACCESS struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SI_INHERIT_TYPE: - """tuple of 3 items describing a method of inheritance""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class SI_OBJECT_INFO: - """Six-tuple representing SI_OBJECT_INFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class STATSTG: - """A tuple representing a STATSTG structure""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class TLIBATTR: - """Type library attributes are represented as a tuple of:""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class TYPEATTR: - """A TYPEATTR object represents a COM TYPEATTR structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def iid(self) -> PyIID: - """The IID""" - ... - - @property - def lcid(self) -> Any: - """The lcid""" - ... - - @property - def memidConstructor(self) -> Any: - """ID of constructor""" - ... - - @property - def memidDestructor(self) -> Any: - """ID of destructor""" - ... - - @property - def cbSizeInstance(self) -> Any: - """The size of an instance of this type""" - ... - - @property - def typekind(self) -> Any: - """The kind of type this information describes. One of the win32con.TKIND_* constants.""" - ... - - @property - def cFuncs(self) -> Any: - """Number of functions.""" - ... - - @property - def cVars(self) -> Any: - """Number of variables/data members.""" - ... - - @property - def cImplTypes(self) -> Any: - """Number of implemented interfaces.""" - ... - - @property - def cbSizeVft(self) -> Any: - """The size of this type's VTBL""" - ... - - @property - def cbAlignment(self) -> Any: - """Byte alignment for an instance of this type.""" - ... - - @property - def wTypeFlags(self) -> Any: - """One of the pythoncom TYPEFLAG_""" - ... - - @property - def wMajorVerNum(self) -> Any: - """Major version number.""" - ... - - @property - def wMinorVerNum(self) -> Any: - """Minor version number.""" - ... - - @property - def tdescAlias(self) -> Any: - """If TypeKind == pythoncom.TKIND_ALIAS, specifies the type for which this type is an alias.""" - ... - - @property - def idldeskType(self) -> Any: - """IDL attributes of the described type.""" - ... - - -class TYPEDESC: - """A typedesc is a complicated, recursive 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 ...""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class VARDESC: - """A VARDESC object represents a COM VARDESC structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def memid(self) -> Any: - """The dispid of the member""" - ... - - @property - def value(self) -> Any: - """A value for the variant. If PERINSTANCE then an offset into the instance, otherwise a variant converted to a Python object.""" - ... - - @property - def elemdescVar(self) -> Any: - """Object describing the member.""" - ... - - @property - def varFlags(self) -> Any: - """Variable flags""" - ... - - @property - def varkind(self) -> Any: - """Kind flags.""" - ... - - -class CHARFORMAT: - """Describes a CHARFORMAT tuple""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class CREATESTRUCT: - """A representation of a Windows CREATESTRUCT structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class LV_COLUMN: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class LV_ITEM: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PARAFORMAT: - """Describes a PARAFORMAT tuple""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyAssocCObject: - """An internal class.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyAssocObject: - """An internal class.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def AttachObject(self) -> None: - """ - Attaches a Python object for lookup of "virtual" functions. - -Args: - - - -Returns: - - None - - """ - ... - - def GetAttachedObject(self) -> Any: - """ - Returned the attached Python object, or None. - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyCBitmap: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CreateCompatibleBitmap(self, dc: Any, width: Any, height: Any) -> None: - """ - Creates a bitmap compatible with the specified device context. - -Args: - - dc(Any):Specifies the device context. - width(Any):The width (in bits) of the bitmap - height(Any):The height (in bits) of the bitmap. - -Returns: - - None - - """ - ... - - def GetSize(self) -> tuple[Any, Any]: - """ - Returns the size of the bitmap object. - -Args: - - - -Returns: - - tuple[Any, Any] - - """ - ... - - def GetHandle(self) -> Any: - """ - Returns the HBITMAP for a bitmap object - -Args: - - - -Returns: - - Any - - """ - ... - - def LoadBitmap(self, idRes: Any, obDLL: Any = None) -> None: - """ - Loads a bitmap from a DLL object. - -Args: - - idRes(Any):The resource ID of the bitmap - obDLL(Any):The DLL object to load from. - -Returns: - - None - - """ - ... - - def LoadBitmapFile(self, fileObject: Any) -> None: - """ - Loads a bitmap (.BMP) format - -from a file object. - -Args: - - fileObject(Any):The file object to load the .BMP format file from. - -Returns: - - None - - """ - ... - - def LoadPPMFile(self, fileObject: Any, cols: Any, rows: Any) -> None: - """ - Loads a bitmap in Portable Pix Map (PPM) format - -from a file object. - -Args: - - fileObject(Any):The file object to load the PPM format file from. - cols(Any):The number of columns in the bitmap. - rows(Any):The number of rows in the bitmap. - -Returns: - - None - - """ - ... - - def Paint(self, dcObject: Any, arg: tuple[Any, Any, Any, Any], arg1: tuple[Any, Any, Any, Any]) -> None: - """ - Paint a bitmap. - -Args: - - dcObject(Any):The DC object to paint the bitmap to. - arg(tuple[Any, Any, Any, Any]):The destination rectangle to paint to. - arg1(tuple[Any, Any, Any, Any]):The source rectangle to paint from. - -Returns: - - None - - """ - ... - - def GetInfo(self) -> Any: - """ - Returns the BITMAP structure info - -Args: - - - -Returns: - - Any:PyCBitmap.GetInfo - -dict = GetInfo()Returns the BITMAP structure info -Return ValueA dictionary of integers, keyed by the following strings: - -bmType - -bmWidth - -bmHeight - -bmWidthBytes - -bmPlanes - -bmBitsPixel - - - """ - ... - - def GetBitmapBits(self, asString: Any = 0) -> Union[Any, str]: - """ - Returns the bitmap bits. - -Args: - - asString(Any):If False, the result is a tuple of integers, if True, the result is a Python string - -Returns: - - Union[Any, str] - - """ - ... - - def SaveBitmapFile(self, dcObject: Any, Filename: str) -> Any: - """ - Saves a bitmap to a file. - -Args: - - dcObject(Any):The DC object that has rendered the bitmap. - Filename(str):The file to save the bitmap to - -Returns: - - Any - - """ - ... - - -class PyCBrush: - """An object encapsulating an MFC PyCBrush class.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CreateSolidBrush(self) -> None: - """ - Initializes a brush with a specified solid color. - -Args: - - - -Returns: - - None - - """ - ... - - def GetSafeHandle(self) -> Any: - """ - Retrieves the HBRUSH for the brush as an integer - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyCButton: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CreateWindow( - self, - caption: str, - style: Any, - rect: tuple[Any, Any, Any, Any], - parent: Any, - _id: Any) -> None: - """ - Creates the window for a new button object. - -Args: - - caption(str):The caption (text) for the button. - style(Any):The style for the button. Use any of the win32con.BS_* constants. - rect(tuple[Any, Any, Any, Any]):The size and position of the button. - parent(Any):The parent window of the button. Usually a PyCDialog. - _id(Any):The buttons control ID. - -Returns: - - None - - """ - ... - - def GetBitmap(self) -> Any: - """ - Get the button's bitmap - -Args: - - - -Returns: - - Any - - """ - ... - - def SetBitmap(self, hBitmap: Any = 1) -> Any: - """ - Set the button's bitmap - -Args: - - hBitmap(Any):Handle of the new bitmap - -Returns: - - Any - - """ - ... - - def GetCheck(self) -> Any: - """ - Retrieves the check state of a radio button or check box. - -Args: - - - -Returns: - - Any - - """ - ... - - def SetCheck(self, idCheck: Any) -> None: - """ - Sets or resets the state of a radio button or check box. - -Args: - - idCheck(Any):The ID of the button. - -Returns: - - None - - """ - ... - - def GetState(self) -> Any: - """ - Returns the state of the button. - -Args: - - - -Returns: - - Any - - """ - ... - - def SetState(self, bHighlight: Any) -> Any: - """ - Sets the state of the button. - -Args: - - bHighlight(Any):The new state for the button.CommentsHighlighting affects the exterior of a button control. It has no effect on the check state of a radio button or check box. - -Returns: - - Any - - """ - ... - - def GetButtonStyle(self) -> Any: - """ - Gets the style of the button. - -Args: - - - -Returns: - - Any - - """ - ... - - def SetButtonStyle(self, style: Any, bRedraw: Any = 1) -> Any: - """ - Sets the style of the button. - -Args: - - style(Any):The new style for the button. - bRedraw(Any):Should the button be redrawn? - -Returns: - - Any - - """ - ... - - -class PyCCmdTarget: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def BeginWaitCursor(self) -> None: - """ - None - -Args: - - - -Returns: - - None - - """ - ... - - def EndWaitCursor(self) -> None: - """ - None - -Args: - - - -Returns: - - None - - """ - ... - - def HookCommand(self, obHandler: Any, _id: Any) -> Any: - """ - Hook a windows command handler. - -Args: - - obHandler(Any):The handler for the command message. This must be a callable object. - _id(Any):The ID of the command to be handled, or zero to handle all command messages.CommentsobHandler 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. When updating a user interface element, Pythonwin will first check if a handler has been installed via PyCCmdTarget::HookCommandUpdate. If so, this alone 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 The handler will be called with 2 arguments * The command id being handled. * The command notification code. If the handler returns TRUE, then the command will be passed on to the default handler, otherwise the message will be consumed. This method is best suited to handling messages from user interface elements, such as menus, toolbars, etc. To handle notification messages from a control, you should use PyCCmdTarget::HookNotifyReturn ValueThe return value is the previous handler, or None. - -Returns: - - 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. - -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 - -handler has been installed via PyCCmdTarget::HookCommandUpdate. If so, this alone - -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 - -The handler will be called with 2 arguments - -* The command id being handled. - -* The command notification code. - -If the handler returns TRUE, then the command will be passed on to the - -default handler, otherwise the message will be consumed. - -This method is best suited to handling messages from user interface - -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. - - - """ - ... - - def HookCommandUpdate(self, obHandler: Any, _id: Any) -> Any: - """ - Hook a windows command update handler. - -Args: - - obHandler(Any):The handler for the command message. This must be a callable object. - _id(Any):The ID of the command to be handled.CommentsThe handler object passed will be called as the application updates user interface elements with the specified ID. 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. - -Returns: - - Any:The ID of the command to be handled.Comments - -The handler object passed will be called as - -the application updates user interface elements - -with the specified ID. - -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. - - - """ - ... - - def HookOleEvent(self) -> Any: - """ - Hook an OLE Event. - -Args: - - - -Returns: - - Any:PyCCmdTarget.HookOleEvent - -object = HookOleEvent()Hook an OLE Event. -Return ValueThe return value is the previous handler, or None. - - - """ - ... - - def HookNotify(self, obHandler: Any, _id: Any) -> Any: - """ - Hook a windows command handler. - -Args: - - obHandler(Any):The handler for the command message. This must be a callable object. - _id(Any):The ID of the command to be handled, or zero to handle all command messages.CommentsobHandler will be called as the application receives control notification messages. 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 A tuple describing standard notification information. 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, otherwise the message will be consumed.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 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 can install certain knowledge about handlers, but this has not been implemented.)Return ValueThe return value is the previous handler, or None. - -Returns: - - 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. - -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 - -A tuple describing standard notification information. - -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, - -otherwise the message will be consumed. - -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 - -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 - -can install certain knowledge about handlers, but this has not been implemented.) -Return ValueThe return value is the previous handler, or None. - - - """ - ... - - def RestoreWaitCursor(self) -> None: - """ - Restores the appropriate hourglass cursor after the system cursor has - -changed. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyCCmdUI: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def m_nIndex(self) -> Any: - ... - - @property - def m_nID(self) -> Any: - ... - - @property - def m_pMenu(self) -> Any: - ... - - @property - def m_pSubMenu(self) -> Any: - ... - - def Enable(self, bEnable: Any = 1) -> None: - """ - Enables or disables the user-interface item for this command. - -Args: - - bEnable(Any):TRUE if the item should be enabled, false otherwise. - -Returns: - - None - - """ - ... - - def SetCheck(self, state: Any = 1) -> None: - """ - Sets the check state of the user-interface item for this command. - -Args: - - state(Any):0 for unchecked, 1 for checked, or 2 for indeterminate. - -Returns: - - None - - """ - ... - - def SetRadio(self, bOn: Any = 1) -> None: - """ - Like the SetCheck member function, but operates on radio groups. - -Args: - - bOn(Any):TRUE if the item should be enabled, false otherwise. - -Returns: - - None - - """ - ... - - def SetText(self, text: str) -> None: - """ - Sets the text for the user-interface item for this command. - -Args: - - text(str):The text for the interface element. - -Returns: - - None - - """ - ... - - def ContinueRouting(self) -> None: - """ - Tells the command-routing mechanism to continue routing the current message down - -the chain of handlers. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyCColorDialog: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetColor(self) -> Any: - """ - Determines the selected color. - -Args: - - - -Returns: - - Any - - """ - ... - - def DoModal(self) -> Any: - """ - Displays a dialog and allows the user to make a selection. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetSavedCustomColors(self) -> Any: - """ - Returns the saved custom colors. - -Args: - - - -Returns: - - Any - - """ - ... - - def SetCurrentColor(self, color: Any) -> None: - """ - Sets the currently selected color. - -Args: - - color(Any):The color to set.MFC References - -Returns: - - None - - """ - ... - - def SetCustomColors(self) -> None: - """ - Sets one or more custom colors - -Args: - - - -Returns: - - None - - """ - ... - - def GetCustomColors(self) -> tuple[Any, ...]: - """ - Gets the 16 currently defined custom colors - -Args: - - - -Returns: - - tuple[Any, ...] - - """ - ... - - -class PyCComboBox: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def AddString(self, _object: Any) -> Any: - """ - Adds a string to a combobox. - -Args: - - _object(Any):Any object. If not a string, __str__, __repr__ or a default repr() will be usedMFC References - -Returns: - - Any:CComboBox::AddString -Return ValueThe zero based index of the new string. - - - """ - ... - - def DeleteString(self, pos: Any) -> Any: - """ - Deletes an item from a combobox. - -Args: - - pos(Any):The zero based index of the item to delete.MFC References - -Returns: - - Any:CComboBox::DeleteString -Return ValueThe count of the items remaining in the list. - - - """ - ... - - def Dir(self, attr: Any, wild: str) -> Any: - """ - Fills the list portion of a combobox with a directory listing. - -Args: - - attr(Any):The attributes of the files to locate - wild(str):A file specification string - eg, *.*MFC References - -Returns: - - Any:CComboBox::Dir -Return ValueThe index of the last file name added to the list. - - - """ - ... - - def GetCount(self) -> Any: - """ - Returns the count of items in the combobox. - -Args: - - - -Returns: - - Any:CListBox::GetCount -Return ValueReturns the number of items currently in the combobox. - - - """ - ... - - def GetCurSel(self) -> Any: - """ - Returns the index of the currently selected item. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetEditSel(self) -> Any: - """ - Returns the selection of the edit control portion of a combo box. - -Args: - - - -Returns: - - Any:CComboBox::GetEditSel -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 selection in the high-order word. If this function is used on a combo box - -without an edit control, an exception is raised. - - - """ - ... - - def GetExtendedUI(self) -> Any: - """ - Indicates if the combo has the extended interface. - -Args: - - - -Returns: - - Any:CComboBox::GetExtendedUI -Return ValueNonzero if the combo box has the extended user interface; otherwise 0. - - - """ - ... - - def GetItemData(self, item: Any) -> Any: - """ - Retrieves the application-specific object associated with an item. - -Args: - - item(Any):The index of the item whose data is to be retrieved. - -Returns: - - Any - - """ - ... - - def GetItemValue(self, item: Any) -> Any: - """ - Retrieves the application-specific value associated with an item. - -Args: - - item(Any):The index of the item whose data is to be retrieved. - -Returns: - - Any - - """ - ... - - def GetLBText(self, index: Any) -> str: - """ - Gets the string from the list of a combo box. - -Args: - - index(Any):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. - -Returns: - - 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. - - - """ - ... - - def GetLBTextLen(self, index: Any) -> Any: - """ - Returns the length of a string in the list of a combobox. - -Args: - - index(Any):The index of the item to return the length of.MFC References - -Returns: - - Any - - """ - ... - - def InsertString(self, pos: Any, _object: Any) -> Any: - """ - Insert a string into a combobox. - -Args: - - pos(Any):The zero based index in the combobox to insert the new string - _object(Any):The object to be added to the comboboxMFC References - -Returns: - - Any:CComboBox::InsertString -Return ValueThe zero based index of the new string added. - - - """ - ... - - def LimitText(self, _max: Any) -> Any: - """ - Limits the amount of text the edit portion of a combo box can hold. - -Args: - - _max(Any):The maximum number of characters the user can enter. If zero, the size is set to (virtually) unlimited.MFC References - -Returns: - - Any - - """ - ... - - def ResetContent(self) -> None: - """ - Clear all the items from a combobox. - -Args: - - - -Returns: - - None - - """ - ... - - def SelectString(self, after: Any, string: str) -> None: - """ - Searches for a combobox item that matches the specified string, and selects it. - -Args: - - after(Any):Contains the zero-based index of the item before the first item to be searched, or -1 for the entire combobox. - string(str):The string to search for.MFC References - -Returns: - - None:CComboBoxBox::SelectString -Return ValueThe return value is always None - an exception is raised if the string can not be located. - - - """ - ... - - def SetCurSel(self, index: Any) -> None: - """ - Selects an item in a combobox. - -Args: - - index(Any):The zero based index of the item to select.MFC References - -Returns: - - None - - """ - ... - - def SetEditSel(self, start: Any, end: Any) -> None: - """ - Sets the selection in the edit control portion of a combo box. - -Args: - - start(Any):Specifies the starting position. If the starting position is set to -1, then any existing selection is removed. - end(Any):Specifies the ending position. If the ending position is set to -1, then all text from the starting position to the last character in the edit control is selected.MFC References - -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 - -have an edit control. - - - """ - ... - - def SetExtendedUI(self, bExtended: Any = 1) -> None: - """ - Selects the Extended UI mode for a combo box. - -Args: - - bExtended(Any):Indicates if the combo should have the extended user interface.CommentsA combo box with the Extended UI flag set can be identified in the following ways:~ Clicking the static control displays the list box only for combo boxes with the CBS_DROPDOWNLIST style.~ Pressing the DOWN ARROW key displays the list box (F4 is disabled).~ Scrolling in the static control is disabled when the item list is not visible (the arrow keys are disabled).MFC References - -Returns: - - None - - """ - ... - - def SetItemData(self, item: Any, Data: Any) -> Any: - """ - Sets the item's application-specific object value. - -Args: - - item(Any):Index of the item whose Data is to be set. - Data(Any):New value for the data.CommentsNote that a reference count is not added to the object. This it is your responsibility to make sure the object remains alive while in the list. - -Returns: - - Any - - """ - ... - - def SetItemValue(self, item: Any, data: Any) -> Any: - """ - Sets the item's application-specific value. - -Args: - - item(Any):Index of the item whose Data is to be set. - data(Any):New value for the data. - -Returns: - - Any - - """ - ... - - def ShowDropDown(self, bShowIt: Any = 1) -> None: - """ - Shows or hides the listbox portion of a combo box. - -Args: - - bShowIt(Any):Indicates if the listbox should be shown or hidden. - -Returns: - - None - - """ - ... - - -class PyCCommonDialog: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCControl: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCControlBar: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def dockSite(self) -> Any: - """Current dock site, if dockable""" - ... - - @property - def dockBar(self) -> Any: - """Current dock bar, if dockable""" - ... - - @property - def dockContext(self) -> Any: - """Used during dragging""" - ... - - @property - def dwStyle(self) -> Any: - """creation style (used for layout)""" - ... - - @property - def dwDockStyle(self) -> Any: - """indicates how bar can be docked""" - ... - - def CalcDynamicLayout(self, length: Any, dwMode: Any) -> Any: - """ - The framework calls this member function to calculate the dimensions of - -a dynamic toolbar. - -Args: - - length(Any):The requested dimension of the control bar, either horizontal or vertical, depending on dwMode. - dwMode(Any):A combination of flags. - -Returns: - - Any - - """ - ... - - def CalcFixedLayout(self, bStretch: Any, bHorz: Any) -> Any: - """ - Calculates the horizontal size of a control bar - -Args: - - bStretch(Any):Indicates whether the bar should be stretched to the size of the frame. The bStretch parameter is nonzero when the bar is not a docking bar (not available for docking) and is 0 when it is docked or floating (available for docking). - bHorz(Any):Indicates that the bar is horizontally or vertically oriented. - -Returns: - - Any - - """ - ... - - def EnableDocking(self, style: Any) -> None: - """ - pecifies whether the control bar supports docking and the sides of its parent - -window. - -Args: - - style(Any):Enables a control bar to be docked. - -Returns: - - None - - """ - ... - - def EraseNonClient(self) -> None: - """ - None - -Args: - - - -Returns: - - None - - """ - ... - - def GetBarStyle(self) -> Any: - """ - Retrieves the control bar style settings. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetCount(self) -> Any: - """ - Returns the number of non-HWND elements in the control bar. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetDockingFrame(self) -> Any: - """ - Returns the frame window to which a control bar is docked. - -Args: - - - -Returns: - - Any - - """ - ... - - def IsFloating(self) -> Any: - """ - Returns a nonzero value if the control bar in question is a floating control - -bar. - -Args: - - - -Returns: - - Any - - """ - ... - - def SetBarStyle(self, style: Any) -> None: - """ - Modifies the control bar style settings. - -Args: - - style(Any):The new style - -Returns: - - None - - """ - ... - - def ShowWindow(self) -> Any: - """ - Shows the toolbar, and recalculates the button layout. - -Args: - - - -Returns: - - Any:PyCControlBar.ShowWindow - -int = ShowWindow()Shows the toolbar, and recalculates the button layout. -Comments - -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 - - - """ - ... - - -class PyCCtrlView: - """A class which implementes a CCtrlView (ie, a view based on a dialog resource.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def OnCommand(self, wparam: Any, lparam: Any) -> None: - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(Any): - lparam(Any):See Also - -Returns: - - None - - """ - ... - - -class PyCDC: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def AbortDoc(self) -> None: - """ - Aborts a print job - -Args: - - - -Returns: - - None - - """ - ... - - def Arc( - self, - rect: tuple[Any, Any, Any, Any], - pointStart: tuple[Any, Any], - pointEnd: tuple[Any, Any]) -> None: - """ - Draws an eliptical arc. - -Args: - - rect(tuple[Any, Any, Any, Any]):Specifies the ellipse's bounding rectangle - pointStart(tuple[Any, Any]):Specifies the x- and y-coordinates of the point that defines the arc's starting point (in logical units). This point does not have to lie exactly on the arc. - pointEnd(tuple[Any, Any]):Specifies the x- and y-coordinates of the point that defines the arc's ending point (in logical units). This point does not have to lie exactly on the arc.CommentsThe arc drawn by using the function is a segment of the ellipse defined by the specified bounding rectangle. The actual starting point of the arc is the point at which a ray drawn from the center of the bounding rectangle through the specified starting point intersects the ellipse. The actual ending point of the arc is the point at which a ray drawn from the center of the bounding rectangle through the specified ending point intersects the ellipse. The arc is drawn in a counterclockwise direction. Since an arc is not a closed figure, it is not filled. Both the width and height of the rectangle must be greater than 2 units and less than 32,767 units.MFC References - -Returns: - - None:CDC::Arc -Return ValueAlways none. If the function fails, an exception is raised. - - - """ - ... - - def BeginPath(self) -> None: - """ - Opens a path bracket in the device context - -Args: - - - -Returns: - - None - - """ - ... - - def BitBlt( - self, - destPos: tuple[Any, Any], - size: tuple[Any, Any], - dc: Any, - srcPos: tuple[Any, Any], - rop: Any) -> None: - """ - Copies a bitmap from the source device context to this device context. - -Args: - - destPos(tuple[Any, Any]):The logical x,y coordinates of the upper-left corner of the destination rectangle. - size(tuple[Any, Any]):Specifies the width and height (in logical units) of the destination rectangle and source bitmap. - dc(Any):Specifies the PyCDC object from which the bitmap will be copied. It must be None if rop specifies a raster operation that does not include a source. - srcPos(tuple[Any, Any]):Specifies the logical x,y coordinates of the upper-left corner of the source bitmap. - rop(Any):Specifies the raster operation to be performed. See the win32 api documentation for details.MFC References - -Returns: - - None - - """ - ... - - def Chord( - self, - rect: tuple[Any, Any, Any, Any], - pointStart: tuple[Any, Any], - pointEnd: tuple[Any, Any]) -> None: - """ - Draws a chord. - -Args: - - rect(tuple[Any, Any, Any, Any]):Specifies the ellipse's bounding rectangle - pointStart(tuple[Any, Any]):Specifies the x- and y-coordinates of the point that defines the arc's starting point (in logical units). This point does not have to lie exactly on the arc. - pointEnd(tuple[Any, Any]):Specifies the x- and y-coordinates of the point that defines the arc's ending point (in logical units). This point does not have to lie exactly on the arc.CommentsDraws a chord (a closed figure bounded by the intersection of an ellipse and a line segment). The rect parameter specify the upper-left and lower-right corners, respectively, of a rectangle bounding the ellipse that is part of the chord. The pointStart and pointEnd parameters specify the endpoints of a line that intersects the ellipse. The chord is drawn by using the selected pen and filled by using the selected brush.MFC References - -Returns: - - None:CDC::Chord -Return ValueAlways none. If the function fails, an exception is raised. - - - """ - ... - - def CreateCompatibleDC(self, dcFrom: Any = None) -> PyCDC: - """ - Creates a memory device context that is compatible with this DC. - -Args: - - dcFrom(Any):The source DC, or None to make a screen compatible DC.CommentsNote that unlike the MFC version, this function calls the global CreateCompatibleDC function and returns a new PyCDC object.MFC References - -Returns: - - None - - """ - ... - - def CreatePrinterDC(self, printerName: str = None) -> None: - """ - Creates a device context for a specific printer - -Args: - - printerName(str):The printer name, or None for the default printerMFC References - -Returns: - - None - - """ - ... - - def DeleteDC(self) -> None: - """ - Deletes all resources associated with a device context. - -Args: - - - -Returns: - - None - - """ - ... - - def DPtoLP(self, point: tuple[Any, Any], x: Any, y: Any) -> tuple[Any, Any]: - """ - Converts device units into logical units. - -Args: - - point(tuple[Any, Any]):The point to convertAlternative Parameters - x(Any):The x coordinate to convert. - y(Any):The y coordinate to convert.MFC References - -Returns: - - tuple[Any, Any]:CDC::DPtoLP - To Do Should really handle list of (x,y) points -Return ValueThe converted coordinates. - - - """ - ... - - def Draw3dRect(self, rect: tuple[Any, Any, Any, Any], colorTopLeft: Any, colorBotRight: Any) -> None: - """ - Draws a three-dimensional rectangle. - -Args: - - rect(tuple[Any, Any, Any, Any]):Specifies the bounding rectangle, in logical units. - colorTopLeft(Any):Specifies the color of the top and left sides of the three-dimensional rectangle. - colorBotRight(Any):Specifies the color of the bottom and right sides of the three-dimensional rectangle.MFC References - -Returns: - - None - - """ - ... - - def DrawFocusRect(self, rect: tuple[Any, Any, Any, Any]) -> None: - """ - Draws a rectangle in the style used to - -indicate the rectangle has focus - -Args: - - rect(tuple[Any, Any, Any, Any]):The coordinates of the rectangleMFC References - -Returns: - - None - - """ - ... - - def DrawFrameControl(self, rect: tuple[Any, Any, Any, Any], typ: Any, state: Any) -> None: - """ - Draws a frame control of the specified type and style. - -Args: - - rect(tuple[Any, Any, Any, Any]):Specifies the bounding rectangle, in logical units. - typ(Any): - state(Any):MFC References - -Returns: - - None - - """ - ... - - def DrawIcon(self, point: tuple[Any, Any], hIcon: int) -> None: - """ - Draws an icon on the DC. - -Args: - - point(tuple[Any, Any]):The point coordinate to draw to. - hIcon(int):The handle of the icon to draw.MFC References - -Returns: - - None - - """ - ... - - def DrawText(self, s: str, _tuple: tuple[Any, Any, Any, Any], _format: Any) -> tuple[Any, Any, Any]: - """ - Formats text in the given rectangle - -Args: - - s(str):The desired output string - _tuple(tuple[Any, Any, Any, Any]):The bounding rectangle in the form: (left, top, right, bottom) expressed in logical units (depending on selected coordinate system - see PyCDC::SetMapMode) - _format(Any):Specifies one or more bit-or'd format values, such as DT_BOTTOM, DT_CENTERDT_RIGHT, DT_VCENTER. For a complete list, see the Microsoft Win32 API documentation.ExampleExampleimport win32ui<nl> import win32con<nl> INCH = 1440 # twips - 1440 per inch allows fine res<nl> def drawtext_test():<nl> dc = win32ui.CreateDC()<nl> dc.CreatePrinterDC() # ties to default printer<nl> dc.StartDoc('My Python Document')<nl> dc.StartPage()<nl> <nl> # note: upper left is 0,0 with x increasing to the right,<nl> # and y decreasing (negative) moving down<nl> dc.SetMapMode(win32con.MM_TWIPS)<nl> <nl> # Centers "TEST" about an inch down on page<nl> dc.DrawText('TEST, (0,INCH*-1,INCH*8,INCH*-2), win32con.DT_CENTER )<nl> dc.EndPage()<nl> dc.EndDoc()<nl> del dc<nl>Return ValueHeight of text in pixelsThe return value is the height of the text, in logical units. If DT_VCENTER or DT_BOTTOM is specified, the return value is the 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) - -Returns: - - tuple[Any, Any, Any]:Specifies one or more bit-or'd format values, such as - -DT_BOTTOM, DT_CENTERDT_RIGHT, DT_VCENTER. For a complete list, see - -the Microsoft Win32 API documentation.ExampleExample -import win32ui<nl> - - import win32con<nl> - - INCH = 1440 # twips - 1440 per inch allows fine res<nl> - - def drawtext_test():<nl> - - dc = win32ui.CreateDC()<nl> - - dc.CreatePrinterDC() # ties to default printer<nl> - - dc.StartDoc('My Python Document')<nl> - - dc.StartPage()<nl> - - <nl> - - # note: upper left is 0,0 with x increasing to the right,<nl> - - # and y decreasing (negative) moving down<nl> - - dc.SetMapMode(win32con.MM_TWIPS)<nl> - - <nl> - - # Centers "TEST" about an inch down on page<nl> - - dc.DrawText('TEST, (0,INCH*-1,INCH*8,INCH*-2), win32con.DT_CENTER )<nl> - - dc.EndPage()<nl> - - dc.EndDoc()<nl> - - del dc<nl> - - -Return ValueHeight of text in pixels - - - -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 - -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) - - - """ - ... - - def Ellipse(self, rect: tuple[Any, Any, Any, Any]) -> None: - """ - Draws an Ellipse. - -Args: - - rect(tuple[Any, Any, Any, Any]):Specifies the ellipse's bounding rectangleCommentsThe center of the ellipse is the center of the bounding rectangle specified by rect. The ellipse is drawn with the current pen, and its interior is filled with the current brush.MFC References - -Returns: - - None:CDC::Ellipse -Return ValueAlways none. If the function fails, an exception is raised. - - - """ - ... - - def EndDoc(self) -> None: - """ - Finishes spooling the document and starts printing it - -Args: - - - -Returns: - - None - - """ - ... - - def EndPage(self) -> None: - """ - Finishes a page on a printer DC - -Args: - - - -Returns: - - None - - """ - ... - - def EndPath(self) -> None: - """ - Closes a path bracket and selects the path defined by the bracket into the specified device - -context - -Args: - - - -Returns: - - None - - """ - ... - - def ExtTextOut( - self, - _int: Any, - _int1: Any, - _int2: Any, - rect: tuple[Any, Any, Any, Any], - string: Any, - _tuple: tuple[tuple[Any, Any], ...]) -> None: - """ - Writes text to the DC. - -Args: - - _int(Any):The x coordinate to write the text to. - _int1(Any):The y coordinate to write the text to. - _int2(Any):Specifies the rectangle type. This parameter can be one, both, or neither of ETO_CLIPPED and ETO_OPAQUE - rect(tuple[Any, Any, Any, Any]):Specifies the text's bounding rectangle. (Can be None.) - string(Any):The text to write. - _tuple(tuple[tuple[Any, Any], ...]):Optional array of values that indicate distance between origins of character cells.MFC References - -Returns: - - None:CDC::ExtTextOut -Return ValueAlways none. If the function fails, an exception is raised. - - - """ - ... - - def FillPath(self) -> None: - """ - 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. - -Args: - - - -Returns: - - None - - """ - ... - - def FillRect(self, rect: tuple[Any, Any, Any, Any], brush: Any) -> None: - """ - Fills a given rectangle with the specified brush - -Args: - - rect(tuple[Any, Any, Any, Any]):Specifies the bounding rectangle, in logical units. - brush(Any):Specifies the brush to use.MFC References - -Returns: - - None - - """ - ... - - def FillSolidRect(self, rect: tuple[Any, Any, Any, Any], color: Any) -> None: - """ - Fills the given rectangle with the specified solid color. - -Args: - - rect(tuple[Any, Any, Any, Any]):Specifies the bounding rectangle, in logical units. - color(Any):Specifies the color to use.MFC References - -Returns: - - None - - """ - ... - - def FrameRect(self, rect: tuple[Any, Any, Any, Any], brush: Any) -> None: - """ - Draws a border around the rectangle specified by rect - -Args: - - rect(tuple[Any, Any, Any, Any]):Specifies the bounding rectangle, in logical units. - brush(Any):Specifies the brush to use.MFC References - -Returns: - - None - - """ - ... - - def GetBrushOrg(self) -> tuple[Any, Any]: - """ - Retrieves the origin (in device units) of the brush currently selected for the - -device context. - -Args: - - - -Returns: - - tuple[Any, Any] - - """ - ... - - def GetClipBox(self) -> tuple[Any, Any, Any, Any]: - """ - Retrieves the dimensions of the smallest bounding rectangle - -around the current clipping boundary. - -Args: - - - -Returns: - - tuple[Any, Any, Any, Any]:CDC::GetClipBox -Return ValueA tuple of integers specifying the rectangle. - - - """ - ... - - def GetCurrentPosition(self) -> tuple[Any, Any]: - """ - Retrieves the current position (in logical coordinates). - -Args: - - - -Returns: - - tuple[Any, Any] - - """ - ... - - def GetDeviceCaps(self, index: Any) -> Any: - """ - Retrieves a capability of the device context. - -Args: - - index(Any):The information requested. See the win32api documentation for details.MFC References - -Returns: - - Any:CDC::GetDeviceCaps -Return ValueThe value of the requested capability - - - """ - ... - - def GetHandleAttrib(self) -> Any: - """ - Retrieves the handle of the attribute device context. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetHandleOutput(self) -> Any: - """ - Retrieves the handle of the output device context. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetMapMode(self) -> Any: - """ - Gets the mapping mode for the device context. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetNearestColor(self, color: Any) -> Any: - """ - Returns the closest color a device can map. - -Args: - - color(Any):Specifies the color to be matched. - -Returns: - - Any - - """ - ... - - def GetPixel(self, x: Any, y: Any) -> None: - """ - Gets a pixel at a local in a device context - -Args: - - x(Any):Horizontal coordinate. - y(Any):Vertical coordinate. - -Returns: - - None - - """ - ... - - def GetSafeHdc(self) -> Any: - """ - Returns the HDC of this DC object. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetTextExtent(self, text: str) -> tuple[Any, Any]: - """ - Calculates the width and height of a line of text using the current font to - -determine the dimensions. - -Args: - - text(str):The text to calculate for.MFC References - -Returns: - - tuple[Any, Any]:CFC::GetTextExtent -Return ValueA tuple of integers with the size of the string, in logical units. - - - """ - ... - - def GetTextExtentPoint(self, text: str) -> tuple[Any, Any]: - """ - None - -Args: - - text(str):The text to calculate for.Return ValueA tuple of integers with the size of the string, in logical units. - -Returns: - - tuple[Any, Any]:The text to calculate for.Return ValueA tuple of integers with the size of the string, in logical units. - - - """ - ... - - def GetTextFace(self) -> str: - """ - Returns typeface name of the current font. - -Args: - - - -Returns: - - str - - """ - ... - - def GetTextMetrics(self) -> Any: - """ - Retrieves the metrics for the current font in this device context. - -Args: - - - -Returns: - - Any:CDC::GetTextMetrics -Return ValueA dictionary of integers, keyed by the following strings: - -tmHeight - -tmAscent - -tmDescent - -tmInternalLeading - -tmExternalLeading - -tmAveCharWidth - -tmMaxCharWidth - -tmWeight - -tmItalic - -tmUnderlined - -tmStruckOut - -tmFirstChar - -tmLastChar - -tmDefaultChar - -tmBreakChar - -tmPitchAndFamily - -tmCharSet - -tmOverhang - -tmDigitizedAspectX - -tmDigitizedAspectY - - - """ - ... - - def GetViewportExt(self) -> tuple[Any, Any]: - """ - Gets the viewport extent of the device context - -Args: - - - -Returns: - - tuple[Any, Any] - - """ - ... - - def GetViewportOrg(self) -> tuple[Any, Any]: - """ - Gets the viewport origin of the device context - -Args: - - - -Returns: - - tuple[Any, Any] - - """ - ... - - def GetWindowExt(self) -> tuple[Any, Any]: - """ - Gets the window extent of the device context - -Args: - - - -Returns: - - tuple[Any, Any] - - """ - ... - - def GetWindowOrg(self) -> tuple[Any, Any]: - """ - Retrieves the x- and y-coordinates of the origin of the window associated with the - -device context. - -Args: - - - -Returns: - - tuple[Any, Any] - - """ - ... - - def IntersectClipRect(self, rect: tuple[Any, Any, Any, Any]) -> None: - """ - Creates a new clipping region by forming the intersection of the current region - -and the rectangle specified - -Args: - - rect(tuple[Any, Any, Any, Any]):Specifies the bounding rectangle, in logical units.MFC References - -Returns: - - None:CDC::IntersectClipRect -Return Valueregion type as integer - - - """ - ... - - def IsPrinting(self) -> Any: - """ - Returns 1 if the DC is currently printing, else 0 - -Args: - - - -Returns: - - Any - - """ - ... - - def LineTo(self, point: tuple[Any, Any], x: Any, y: Any) -> None: - """ - Draws a line to a specified point, using the currently selected pen. - -Args: - - point(tuple[Any, Any]):The point coordinate to draw to.Alternative Parameters - x(Any):The x coordinate to draw to. - y(Any):The y coordinate to draw to.MFC References - -Returns: - - None - - """ - ... - - def LPtoDP(self, point: tuple[Any, Any], x: Any, y: Any) -> tuple[Any, Any]: - """ - Converts logical units into device units. - -Args: - - point(tuple[Any, Any]):The point coordinate to convert.Alternative Parameters - x(Any):The x coordinate to convert. - y(Any):The y coordinate to convert.MFC References - -Returns: - - tuple[Any, Any]:CDC::LPtoDP -Return ValueThe converted coordinates. - - - """ - ... - - def MoveTo(self, point: tuple[Any, Any], x: Any, y: Any) -> tuple[Any, Any]: - """ - Moves the current position to a specified point. - -Args: - - point(tuple[Any, Any]):The point coordinate to move to.Alternative Parameters - x(Any):The x coordinate to move to. - y(Any):The y coordinate to move to.MFC References - -Returns: - - tuple[Any, Any]:CDC::MoveTo -Return ValueThe previous position. - - - """ - ... - - def OffsetWindowOrg(self, arg: tuple[Any, Any]) -> tuple[Any, Any]: - """ - Modifies the coordinates of the window origin relative to the coordinates of the - -current window origin. - -Args: - - arg(tuple[Any, Any]):The new origin offset.Return ValueThe previous origin as a tuple (x,y) - -Returns: - - tuple[Any, Any]:The new origin offset.Return ValueThe previous origin as a tuple (x,y) - - - """ - ... - - def OffsetViewportOrg(self, arg: tuple[Any, Any]) -> tuple[Any, Any]: - """ - Modifies the coordinates of the viewport origin relative to the coordinates of - -the current viewport origin - -Args: - - arg(tuple[Any, Any]):The new origin offset.Return ValueThe previous viewport origin as a tuple (x,y) - -Returns: - - tuple[Any, Any]:The new origin offset.Return ValueThe previous viewport origin as a tuple (x,y) - - - """ - ... - - def PatBlt(self, destPos: tuple[Any, Any], size: tuple[Any, Any], rop: Any) -> None: - """ - Creates a bit pattern on the device. - -Args: - - destPos(tuple[Any, Any]):The logical x,y coordinates of the upper-left corner of the destination rectangle. - size(tuple[Any, Any]):Specifies the width and height (in logical units) of the destination rectangle and source bitmap. - rop(Any):Specifies the raster operation to be performed. See the win32 api documentation for details.MFC References - -Returns: - - None - - """ - ... - - def Pie(self, x1: Any, y1: Any, x2: Any, y2: Any, x3: Any, y3: Any, x4: Any, y4: Any) -> None: - """ - Draws a pie slice in a device context - -Args: - - x1(Any):X coordinate of upper left corner - y1(Any):Y coordinate of upper left corner - x2(Any):X coordinate of lower right corner - y2(Any):Y coordinate of lower right corner - x3(Any):X coordinate of starting point of arc - y3(Any):Y coordinate of starting point of arc - x4(Any):X coordinate of ending point of arc - y4(Any):Y coordinate of ending point of arc - -Returns: - - None - - """ - ... - - def PolyBezier(self) -> None: - """ - Draws one or more Bezier splines. - -Args: - - - -Returns: - - None - - """ - ... - - def Polygon(self) -> None: - """ - Draws an Polygon. - -Args: - - - -Returns: - - None - - """ - ... - - def Polyline(self, points: list[Any]) -> None: - """ - Draws a Polyline. - -Args: - - points(list[Any]):A sequence of points - -Returns: - - None - - """ - ... - - def RealizePalette(self) -> Any: - """ - Maps palette entries in the current logical palette to the system palette. - -Args: - - - -Returns: - - 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 - -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 - -was last realized. - - - """ - ... - - def Rectangle(self) -> Any: - """ - Draws a rectangle using the current pen. The interior of the rectangle is filled using - -the current brush. - -Args: - - - -Returns: - - Any - - """ - ... - - def RectVisible(self, rect: tuple[Any, Any, Any, Any]) -> Any: - """ - Determines whether any part of the given rectangle lies within the clipping region of - -the display context. - -Args: - - rect(tuple[Any, Any, Any, Any]):The coordinates of the reactangle to be checked.MFC References - -Returns: - - Any:CDC::RectVisible -Return ValueNon zero if any part of the rectangle lies within the clipping region, else zero. - - - """ - ... - - def RestoreDC(self, saved: Any) -> None: - """ - Restores the state of the device context. - -Args: - - saved(Any):The id of a previously saved device context. See PyCDC::SaveDCMFC References - -Returns: - - None - - """ - ... - - def SaveDC(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any:CDC::SaveDC -Return ValueAn integer identifying the context, which can be used by PyCDC::RestoreDC. - -An exception is raised if this function fails. - - - """ - ... - - def ScaleWindowExt(self) -> tuple[Any, Any]: - """ - Modifies the window extents relative to the current values. - -Args: - - - -Returns: - - tuple[Any, Any] - - """ - ... - - def ScaleViewportExt(self) -> tuple[Any, Any]: - """ - Modifies the viewport extents relative to the current values. - -Args: - - - -Returns: - - tuple[Any, Any] - - """ - ... - - def SelectClipRgn(self) -> Any: - """ - Selects the given region as the current clipping region for the device context - -Args: - - - -Returns: - - Any:PyCDC.SelectClipRgn - -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) - - - """ - ... - - def SelectObject(self, ob: Any) -> Any: - """ - None - -Args: - - ob(Any):The object to select.MFC References - -Returns: - - Any:CDC::SelectObject -Return ValueThe previously selected object. This will be the same type as the object parameter. - - - """ - ... - - def SetBkColor(self, color: Any) -> Any: - """ - Sets the current background color to the specified color. - -Args: - - color(Any):A windows color specification. See the win32api documentation for details.CommentsIf the background mode is OPAQUE, the system uses the background color to fill the gaps in styled lines, the gaps between hatched lines in brushes, and the background in character cells. The system also uses the background color when converting bitmaps between color and monochrome device contexts.MFC References - -Returns: - - Any:CDC::SetBkColor -Return ValueThe return value is the previous background color. - - - """ - ... - - def SetBkMode(self, mode: Any) -> Any: - """ - Sets the current background mode to the specified mode. - -Args: - - mode(Any):A background mode. May be either TRANSPARENT or OPAQUE.CommentsSpecifies the mode to be set. This parameter can be either OPAQUE or TRANSPARENTMFC References - -Returns: - - Any:CDC::SetBkMode -Return ValueThe return value is the previous background mode. - - - """ - ... - - def SetBrushOrg(self, point: tuple[Any, Any]) -> tuple[Any, Any]: - """ - Specifies the origin that GDI will assign to the next brush that the - -application selects into the device context. - -Args: - - point(tuple[Any, Any]):The new origin in device units.MFC References - -Returns: - - tuple[Any, Any]:CDC::SetBrushOrg -Return ValueThe previous origin in device units. - - - """ - ... - - def SetGraphicsMode(self, mode: Any) -> Any: - """ - Sets the graphics mode for the specified device context - -Args: - - mode(Any):The new mode. - -Returns: - - Any - - """ - ... - - def SetMapMode(self, newMode: Any) -> Any: - """ - Sets the mapping mode for the device context. - -Args: - - newMode(Any):The new mode. Can be one of MM_ANISOTROPIC, MM_HIENGLISH, MM_HIMETRIC, MM_ISOTROPIC, MM_LOENGLISH, MM_LOMETRIC, MM_TEXT, MM_TWIPSMFC References - -Returns: - - Any:CDC::SetMapMode -Return ValueThe previous mapping mode. - - - """ - ... - - def SetPixel(self, x: Any, y: Any, color: Any) -> None: - """ - Sets a pixel in a device context - -Args: - - x(Any):Horizontal coordinate. - y(Any):Vertical coordinate. - color(Any):The brush color. - -Returns: - - None - - """ - ... - - def SetPolyFillMode(self, point: tuple[Any, Any]) -> Any: - """ - Sets the polygon-filling mode. - -Args: - - point(tuple[Any, Any]):The new origin in device units.MFC References - -Returns: - - Any:CDC::SetPolyFillMode -Return ValueThe previous PolyFillMode as integer - - - -The previous PolyFillMode. - - - """ - ... - - def SetROP2(self, mode: Any) -> Any: - """ - Sets the current drawing mode. - -Args: - - mode(Any):The new drawing mode.MFC References - -Returns: - - Any - - """ - ... - - def SetTextAlign(self, newFlags: Any) -> Any: - """ - Sets the text-alignment flags. - -Args: - - newFlags(Any):The new alignment flags. Can be a combination of (TA_CENTER, TA_LEFT, TA_RIGHT), (TA_BASELINE, TA_BOTTOM, TA_TOP) and (TA_NOUPDATECP, TA_UPDATECP) The default is TA_LEFT|TA_TOP|TA_NOUPDATECPMFC References - -Returns: - - Any:CDC::SetTextAlign -Return ValueThe old alignment flags. - - - """ - ... - - def SetTextColor(self, color: Any) -> Any: - """ - Sets the text color to the specified color. - -Args: - - color(Any):A windows color specification. See the win32api documentation for details.CommentsThis text color is used when writing text to this device context and also when converting bitmaps between color and monochrome device contexts. If the device cannot represent the specified color, the system sets the text color to the nearest physical color. The background color for a character is specified by the SetBkColor and SetBkMode member functions.MFC References - -Returns: - - Any:CDC::SetTextColor -Return ValueThe return value is the previous text color. - - - """ - ... - - def SetWindowExt(self, size: tuple[Any, Any]) -> tuple[Any, Any]: - """ - Sets the x,y extents of the window associated with the device context. - -Args: - - size(tuple[Any, Any]):The new size.MFC References - -Returns: - - tuple[Any, Any]:CDC::SetWindowExt -Return ValueThe previous extents of the window (in logical units). - - - """ - ... - - def SetWindowOrg(self, arg: tuple[Any, Any]) -> tuple[Any, Any]: - """ - Sets the window origin of the device context - -Args: - - arg(tuple[Any, Any]):The new origin. - -Returns: - - tuple[Any, Any] - - """ - ... - - def SetViewportExt(self, size: tuple[Any, Any]) -> tuple[Any, Any]: - """ - Sets the x,y extents of the viewport of the device context. - -Args: - - size(tuple[Any, Any]):The new size.MFC References - -Returns: - - tuple[Any, Any]:CDC::SetViewportExt -Return ValueThe previous extents of the viewport (in logical units). - - - """ - ... - - def SetViewportOrg(self, arg: tuple[Any, Any]) -> tuple[Any, Any]: - """ - Sets the viewport origin of the device context - -Args: - - arg(tuple[Any, Any]):The new origin. - -Returns: - - tuple[Any, Any] - - """ - ... - - def SetWorldTransform(self) -> Any: - """ - 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 - -output. - -Args: - - - -Returns: - - Any - - """ - ... - - def StartDoc(self, docName: str, outputFile: str) -> None: - """ - Starts spooling a document to a printer DC - -Args: - - docName(str):The document name - outputFile(str):The output file name. Use this to spool to a file. Omit to send to the printer. - -Returns: - - None - - """ - ... - - def StartPage(self) -> None: - """ - Starts a new page on a printer DC - -Args: - - - -Returns: - - None - - """ - ... - - def StretchBlt( - self, - destPos: tuple[Any, Any], - size: tuple[Any, Any], - dc: Any, - srcPos: tuple[Any, Any], - size1: tuple[Any, Any], - rop: Any) -> None: - """ - Copies a bitmap from the source device context to this device context. - -Args: - - destPos(tuple[Any, Any]):The logical x,y coordinates of the upper-left corner of the destination rectangle. - size(tuple[Any, Any]):Specifies the width and height (in logical units) of the destination rectangle and source bitmap. - dc(Any):Specifies the PyCDC object from which the bitmap will be copied. It must be None if rop specifies a raster operation that does not include a source. - srcPos(tuple[Any, Any]):Specifies the logical x,y coordinates of the upper-left corner of the source bitmap. - size1(tuple[Any, Any]):Specifies the width and height (in logical units) of the destination rectangle and source bitmap. - rop(Any):Specifies the raster operation to be performed. See the win32 api documentation for details.MFC References - -Returns: - - None - - """ - ... - - def StrokeAndFillPath(self) -> None: - """ - 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. - -Args: - - - -Returns: - - None - - """ - ... - - def StrokePath(self) -> None: - """ - Renders the specified path by using the current pen. - -Args: - - - -Returns: - - None - - """ - ... - - def TextOut(self, _int: Any, _int1: Any, string: Any) -> None: - """ - Outputs text to the display context, using the currently selected font. - -Args: - - _int(Any):The x coordinate to write the text to. - _int1(Any):The y coordinate to write the text to. - string(Any):The text to write.MFC References - -Returns: - - None:CDC::TextOut -Return ValueAlways none. If the function fails, an exception is raised. - - - """ - ... - - -class PyCDialog: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CreateWindow(self, obParent: Any = None) -> None: - """ - Create a modeless window for the dialog box. - -Args: - - obParent(Any):The parent window for the new windowMFC References - -Returns: - - None - - """ - ... - - def DoModal(self) -> Any: - """ - Create a modal window for the dialog box. - -Args: - - - -Returns: - - Any:CDialog::DoModal -Return ValueThe return value from the dialog. This is the value passed to PyCDialog::EndDialog. - - - """ - ... - - def EndDialog(self, result: Any) -> None: - """ - Ends a modal dialog box. - -Args: - - result(Any):The value to be returned by the PyCDialog::DoModal method.MFC References - -Returns: - - None - - """ - ... - - def GotoDlgCtrl(self, control: Any) -> None: - """ - Moves the focus to the specified control in the dialog box. - -Args: - - control(Any):The control to get the focus. - -Returns: - - None - - """ - ... - - def MapDialogRect(self, rect: tuple[Any, Any, Any, Any]) -> tuple[Any, Any, Any, Any]: - """ - Converts the dialog-box units of a rectangle to screen - -units. - -Args: - - rect(tuple[Any, Any, Any, Any]):The rect to be converted - -Returns: - - tuple[Any, Any, Any, Any] - - """ - ... - - def OnCancel(self) -> None: - """ - Calls the default MFC OnCancel handler. - -Args: - - - -Returns: - - None - - """ - ... - - def OnOK(self) -> None: - """ - Calls the default MFC OnOK handler. - -Args: - - - -Returns: - - None - - """ - ... - - def OnInitDialog(self) -> Any: - """ - Calls the default MFC OnInitDialog handler. - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyCDialogBar: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CreateWindow(self, parent: Any, template: PyResourceId, style: Any, _id: Any) -> None: - """ - None - -Args: - - parent(Any):The parent window - template(PyResourceId):Template name or integer resource id - style(Any):The style for the window - _id(Any):The ID of the window - -Returns: - - None - - """ - ... - - -class PyCDocTemplate: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def DoCreateDoc(self, fileName: str = None) -> Any: - """ - Creates an underlying document object. - -Args: - - fileName(str):The name of the file to load. - -Returns: - - Any - - """ - ... - - def FindOpenDocument(self, fileName: str) -> Any: - """ - Returns an existing document with the specified file name. - -Args: - - fileName(str):The fully qualified filename to search for. - -Returns: - - Any - - """ - ... - - def GetDocString(self, docIndex: Any) -> str: - """ - Retrieves a specific substring describing the document type. - -Args: - - docIndex(Any):The document index. Must be one of the win32ui.CDocTemplate_* constants.CommentsFor more information on the doc strings, please see PyCDocTemplate::SetDocStrings - -Returns: - - str - - """ - ... - - def GetDocumentList(self) -> Any: - """ - Return a list of all open documents. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetResourceID(self) -> None: - """ - Returns the resource ID in use. - -Args: - - - -Returns: - - None - - """ - ... - - def GetSharedMenu(self) -> Any: - """ - Returns the shared menu object for all frames using this template. - -Args: - - - -Returns: - - Any - - """ - ... - - def InitialUpdateFrame(self, frame: Any = None, doc: Any = None, bMakeVisible: Any = 1) -> None: - """ - Calls the default OnInitialFrame handler. - -Args: - - frame(Any):The frame window. - doc(Any):A document for the frame. - bMakeVisible(Any):Indicates of the frame should be shown.See Also - -Returns: - - None - - """ - ... - - def SetContainerInfo(self, _id: Any) -> None: - """ - Sets the resources to be used when an OLE 2 object is in-place activated. - -Args: - - _id(Any):The resource ID. - -Returns: - - None - - """ - ... - - def SetDocStrings(self, docStrings: str) -> None: - """ - Assigns the document strings for the template. - -Args: - - docStrings(str):The document strings.CommentsThe string must be a \\n seperated list of docstrings. The elements are:elementNameDescriptionwindowTitleTitle used for the window (only for SDI applications)docNameRoot for the default document name.fileNewNameName of the document type, as displayed in the "File/New" dialogfilterNameDescription of the document type and a wildcard spec for the file open dialog.filterExtExtension for documents of this file type.regFileTypeIdInternal Id of the document as registered in the registry. Used to associate the extension with the file type.regFileTypeNameName of the document, as stored in the reigstry. This is the name presented to the user. - -Returns: - - None - - """ - ... - - def OpenDocumentFile(self, filename: str, bMakeVisible: Any = 1) -> None: - """ - Opens a document file, creating a view and frame. - -Args: - - filename(str):Name of file to open, or None - bMakeVisible(Any):Indicates if the document should be created visible. - -Returns: - - None - - """ - ... - - -class PyCDockContext: - """A class which encapsulates an MFC CDockContext object""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def ptLast(self) -> tuple[Any, Any]: - ... - - @property - def rectLast(self) -> tuple[Any, Any, Any, Any]: - ... - - @property - def sizeLast(self) -> tuple[Any, Any]: - ... - - @property - def bDitherLast(self) -> Any: - ... - - @property - def rectDragHorz(self) -> tuple[Any, Any, Any, Any]: - ... - - @property - def rectDragVert(self) -> tuple[Any, Any, Any, Any]: - ... - - @property - def rectFrameDragHorz(self) -> tuple[Any, Any, Any, Any]: - ... - - @property - def rectFrameDragVert(self) -> tuple[Any, Any, Any, Any]: - ... - - @property - def dwDockStyle(self) -> Any: - """allowable dock styles for bar""" - ... - - @property - def dwOverDockStyle(self) -> Any: - """style of dock that rect is over""" - ... - - @property - def dwStyle(self) -> Any: - """style of control bar""" - ... - - @property - def bFlip(self) -> Any: - """if shift key is down""" - ... - - @property - def bForceFrame(self) -> Any: - """if ctrl key is down CDC* m_pDC; // where to draw during drag""" - ... - - @property - def bDragging(self) -> Any: - ... - - @property - def nHitTest(self) -> Any: - ... - - @property - def uMRUDockID(self) -> Any: - ... - - @property - def rectMRUDockPos(self) -> tuple[Any, Any, Any, Any]: - ... - - @property - def dwMRUFloatStyle(self) -> Any: - ... - - @property - def ptMRUFloatPos(self) -> tuple[Any, Any]: - """Sentinel""" - ... - - def EndDrag(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def StartDrag(self, pt: tuple[Any, Any]) -> Any: - """ - None - -Args: - - pt(tuple[Any, Any]): - -Returns: - - Any - - """ - ... - - def EndResize(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def StartResize(self, hittest: Any, pt: tuple[Any, Any]) -> Any: - """ - None - -Args: - - hittest(Any): - pt(tuple[Any, Any]): - -Returns: - - Any - - """ - ... - - def ToggleDocking(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyCDocument: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def DeleteContents(self) -> None: - """ - Call the MFC DeleteContents method. - -This routine is provided so a document object which overrides this method - -can call the original MFC version if required. - -Args: - - - -Returns: - - None - - """ - ... - - def DoSave(self, fileName: str, bReplace: Any = 1) -> None: - """ - Calls the underlying MFC DoSave method. - -Args: - - fileName(str):The name of the file to save to. - bReplace(Any):Should an existing file be silently replaced?.CommentsIf invalid or no filename, will prompt for a name, else will perform the actual saving of the document.See Also - -Returns: - - None - - """ - ... - - def DoFileSave(self) -> None: - """ - Checks the file attributes. - -If the file is read only, a new name is prompted, else the - -file is saved (by calling DoSave) - -Args: - - - -Returns: - - None - - """ - ... - - def GetDocTemplate(self) -> Any: - """ - Returns the template for the document. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetAllViews(self) -> list[Any]: - """ - Returns a list of all views for the current document. - -Args: - - - -Returns: - - list[Any] - - """ - ... - - def GetFirstView(self) -> Any: - """ - Returns the first view object attached to this document. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetPathName(self) -> str: - """ - Returns the full path name of the current document. - -The string will be empty if no path name has been set. - -Args: - - - -Returns: - - str - - """ - ... - - def GetTitle(self) -> str: - """ - Returns the title of the current document. - -This will often be the file name portion of the path name. - -Args: - - - -Returns: - - str - - """ - ... - - def IsModified(self) -> Any: - """ - Return a flag indicating if the document has been modified. - -Args: - - - -Returns: - - Any - - """ - ... - - def OnChangedViewList(self) -> None: - """ - Informs the document when a view is added or removed. - -Args: - - - -Returns: - - None - - """ - ... - - def OnCloseDocument(self) -> None: - """ - Call the MFC OnCloseDocument handler. - -This routine is provided so a document object which overrides this method - -can call the original MFC version if required. - -Args: - - - -Returns: - - None - - """ - ... - - def OnNewDocument(self) -> None: - """ - Call the MFC OnNewDocument handler. - -This routine is provided so a document object which overrides this method - -can call the original MFC version if required. - -Args: - - - -Returns: - - None - - """ - ... - - def OnOpenDocument(self, pathName: str) -> None: - """ - Call the MFC OnOpenDocument handler. - -This routine is provided so a document object which overrides this method - -can call the original MFC version if required. - -Args: - - pathName(str):The full path of the file to open.MFC References - -Returns: - - None - - """ - ... - - def OnSaveDocument(self, pathName: str) -> None: - """ - Call the MFC OnSaveDocument handler. - -This routine is provided so a document object which overrides this method - -can call the original MFC version if required. - -Args: - - pathName(str):The full path of the file to save.MFC References - -Returns: - - None - - """ - ... - - def SetModifiedFlag(self, bModified: Any = 1) -> None: - """ - Set the "dirty" flag for the document. - -Args: - - bModified(Any):Set dirty flagMFC References - -Returns: - - None - - """ - ... - - def SaveModified(self) -> Any: - """ - Call the underlying MFC method. - -Args: - - - -Returns: - - Any:CDocument::SaveModified -Return ValueNonzero if it is safe to continue and close the document; 0 if the document should not be closed. - - - """ - ... - - def SetPathName(self, path: str) -> None: - """ - Set the full path name for the document. - -Args: - - path(str):The full path of the file.MFC References - -Returns: - - None - - """ - ... - - def SetTitle(self, title: str) -> None: - """ - Set the title of the document (ie, the name - -to appear in the window caption for the document. - -Args: - - title(str):The new title.MFC References - -Returns: - - None - - """ - ... - - def UpdateAllViews(self, sender: Any, hint: Any = None) -> None: - """ - Informs each view when a document changes. - -Args: - - sender(Any):The view who initiated the update - hint(Any):A hint for the update.MFC References - -Returns: - - None - - """ - ... - - -class PyCEdit: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CreateWindow(self, style: Any, rect: tuple[Any, Any, Any, Any], parent: Any, _id: Any) -> None: - """ - Creates the window for a new Edit object. - -Args: - - style(Any):The style for the Edit. Use any of the win32con.BS_* constants. - rect(tuple[Any, Any, Any, Any]):The size and position of the Edit. - parent(Any):The parent window of the Edit. Usually a PyCDialog. - _id(Any):The Edits control ID. - -Returns: - - None - - """ - ... - - def Clear(self) -> Any: - """ - Clears all text in an edit control. - -Args: - - - -Returns: - - Any - - """ - ... - - def Copy(self) -> None: - """ - Copys the current selection to the clipboard. - -Args: - - - -Returns: - - None - - """ - ... - - def Cut(self) -> None: - """ - Cuts the current selection to the clipboard. - -Args: - - - -Returns: - - None - - """ - ... - - def FmtLines(self, bAddEOL: Any) -> Any: - """ - Sets the formatting options for the control. - -Args: - - bAddEOL(Any):Specifies whether soft line-break characters are to be inserted. A value of TRUE inserts the characters; a value of FALSE removes them.MFC References - -Returns: - - Any:CEdit::FmtLines -Return ValueNonzero if any formatting occurs; otherwise 0. - - - """ - ... - - def GetFirstVisibleLine(self) -> Any: - """ - Returns zero-based index of the topmost visible line. - -Args: - - - -Returns: - - Any:CEdit::GetFirstVisibleLine -Return ValueThe zero-based index of the topmost visible line. For single-line edit controls, the return value is 0. - - - """ - ... - - def GetSel(self) -> tuple[Any, Any]: - """ - Returns the start and end of the current selection. - -Args: - - - -Returns: - - tuple[Any, Any]:CEdit::GetSel -Return ValueThe return tuple is (the first character in the current selection, first nonselected character past the - -end of the current selection) - - - """ - ... - - def GetLine(self, lineNo: Any) -> Any: - """ - Returns the text in a specified line. - -Args: - - lineNo(Any):Contains the zero-based index value for the desired line.CommentsThis function is not an MFC wrapper. - -Returns: - - Any - - """ - ... - - def GetLineCount(self) -> Any: - """ - Gets the number of lines in an edit control. - -Args: - - - -Returns: - - Any:CEdit::GetLineCount -Return ValueThe number of lines in the buffer. If the control is empty, the return value is 1. - - - """ - ... - - def LimitText(self, nChars: Any = 0) -> None: - """ - Sets max length of text that user can enter - -Args: - - nChars(Any):Specifies the length (in bytes) of the text that the user can enter. If this parameter is 0, the text length is set to UINT_MAX bytes. This is the default behavior.MFC References - -Returns: - - None - - """ - ... - - def LineFromChar(self, charNo: Any = -1) -> Any: - """ - Returns the line number of the specified character. - -Args: - - charNo(Any):Contains the zero-based index value for the desired character in the text of the edit control, or -1. If -1, then it specifies the current line.MFC References - -Returns: - - Any:CEdit::LineFromChar -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 there is no selection, the current line number is returned. - - - """ - ... - - def LineIndex(self, lineNo: Any = -1) -> Any: - """ - Retrieves the character index of a line within a multiple-line edit control. - -Args: - - lineNo(Any):Contains the index value for the desired line in the text of the edit control, or contains -1. If -1, then it specifies the current line.CommentsThis method only works on multi-linr edit controls.MFC References - -Returns: - - Any:CEdit::LineIndex -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 edit control. - - - """ - ... - - def LineScroll(self, nLines: Any, nChars: Any = 0) -> Any: - """ - Scroll the control vertically and horizontally - -Args: - - nLines(Any):Specifies the number of lines to scroll vertically. - nChars(Any):Specifies the number of character positions to scroll horizontally. This value is ignored if the edit control has either the ES_RIGHT or ES_CENTER style.CommentsThis method only works on multi-linr edit controls.MFC References - -Returns: - - Any - - """ - ... - - def Paste(self) -> None: - """ - Pastes the contents of the clipboard into the control. - -Args: - - - -Returns: - - None - - """ - ... - - def ReplaceSel(self, text: str) -> None: - """ - Replaces the selection with the specified text. - -Args: - - text(str):The text to replace the selection with.MFC References - -Returns: - - None - - """ - ... - - def SetReadOnly(self, bReadOnly: Any = 1) -> None: - """ - Sets or clears the read-only status of the listbox. - -Args: - - bReadOnly(Any):The read-only state to set.MFC References - -Returns: - - None - - """ - ... - - def SetSel(self, start: Any, end: Any, arg: Any, bNoScroll1: Any, bNoScroll: Any = 0) -> None: - """ - Sets the selection in the edit control. - -Args: - - start(Any):Specifies the starting position. If start is 0 and end is -1, all the text in the edit control is selected. If start is -1, any current selection is removed. - end(Any):Specifies the ending position. - arg(Any):As for normal start, end args. - bNoScroll1(Any):Indicates whether the caret should be scrolled into view. If 0, the caret is scrolled into view. If 1, the caret is not scrolled into view.MFC References - bNoScroll(Any):Indicates whether the caret should be scrolled into view. If 0, the caret is scrolled into view. If 1, the caret is not scrolled into view.Alternative Parameters - -Returns: - - None - - """ - ... - - -class PyCEditView: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def IsModified(self) -> Any: - """ - Indicates if the view's document has the modified flag set. - -Args: - - - -Returns: - - Any - - """ - ... - - def LoadFile(self, fileName: str) -> None: - """ - Loads a file into the view. - -Args: - - fileName(str):The name of the file to be loaded. - -Returns: - - None - - """ - ... - - def SetModifiedFlag(self, bModified: Any = 1) -> None: - """ - Sets the modified flag for the view's document. - -Args: - - bModified(Any):The modified state to set. - -Returns: - - None - - """ - ... - - def GetEditCtrl(self) -> Any: - """ - returns the underlying edit control object. - -Args: - - - -Returns: - - Any - - """ - ... - - def PreCreateWindow(self, createStruct: Any) -> Any: - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(Any):A tuple representing a CREATESTRUCT structure. - -Returns: - - Any - - """ - ... - - def SaveFile(self, fileName: str) -> None: - """ - Saves the view to a file. - -Args: - - fileName(str):The name of the file to be written. - -Returns: - - None - - """ - ... - - def OnCommand(self, wparam: Any, lparam: Any) -> None: - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(Any): - lparam(Any):See Also - -Returns: - - None - - """ - ... - - -class PyCFileDialog: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetPathName(self) -> str: - """ - Retrives the path name from the file dialog. - -Args: - - - -Returns: - - str - - """ - ... - - def GetFileName(self) -> str: - """ - Retrives the file name from the file dialog. - -Args: - - - -Returns: - - str - - """ - ... - - def GetFileExt(self) -> str: - """ - Retrives the file extension from the file dialog. - -Args: - - - -Returns: - - str - - """ - ... - - def GetFileTitle(self) -> str: - """ - Retrives the file title from the file dialog. - -Args: - - - -Returns: - - str - - """ - ... - - def GetPathNames(self) -> str: - """ - Retrieves the list of path names from the file dialog. - -Args: - - - -Returns: - - str - - """ - ... - - def GetReadOnlyPref(self) -> Any: - """ - Retrives the value of the "Read Only" checkbox on the file dialog. - -Args: - - - -Returns: - - Any - - """ - ... - - def SetOFNTitle(self, title: str) -> None: - """ - Sets the Title for the dialog. - -Args: - - title(str):The title for the dialog box. May be None. - -Returns: - - None - - """ - ... - - def SetOFNInitialDir(self, title: str) -> None: - """ - Sets the initial directory for the dialog. - -Args: - - title(str):The initial directory for the dialog box. May be None. - -Returns: - - None - - """ - ... - - -class PyCFont: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetSafeHandle(self) -> Any: - """ - Retrieves the HFONT for the font as an integer - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyCFontDialog: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def DoModal(self) -> Any: - """ - Displays a dialog and allows the user to make a selection. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetCurrentFont(self) -> Any: - """ - Returns a dictionary describing the current font. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetCharFormat(self) -> Any: - """ - Returns the font selection in a CHARFORMAT tuple. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetColor(self) -> Any: - """ - Determines the color of the selected font. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetFaceName(self) -> str: - """ - Returns the face name of the selected font. - -Args: - - - -Returns: - - str - - """ - ... - - def GetStyleName(self) -> str: - """ - Returns the style name of the selected font. - -Args: - - - -Returns: - - str - - """ - ... - - def GetSize(self) -> Any: - """ - Returns he font's size, in tenths of a point. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetWeight(self) -> Any: - """ - Returns the font's weight. - -Args: - - - -Returns: - - Any - - """ - ... - - def IsStrikeOut(self) -> Any: - """ - Determines whether the font is displayed with strikeout. - -Args: - - - -Returns: - - Any - - """ - ... - - def IsUnderline(self) -> Any: - """ - Determines whether the font is displayed with underline. - -Args: - - - -Returns: - - Any - - """ - ... - - def IsBold(self) -> Any: - """ - Determines whether the font is displayed bold. - -Args: - - - -Returns: - - Any - - """ - ... - - def IsItalic(self) -> Any: - """ - Determines whether the font is displayed with italic. - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyCFormView: - """A class which implementes a CFormView (ie, a view based on a dialog resource.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def OnCommand(self, wparam: Any, lparam: Any) -> None: - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(Any): - lparam(Any):See Also - -Returns: - - None - - """ - ... - - -class PyCFrameWnd: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def BeginModalState(self) -> None: - """ - Sets the frame window to modal. - -Args: - - - -Returns: - - None - - """ - ... - - def CreateWindow( - self, - wndClass: str, - title: str, - style: Any, - PyCWnd: Any, - menuId: Any, - styleEx: Any, - rect: tuple[Any, Any, Any, Any] = None, - createContext: Any = None) -> Any: - """ - Creates the actual window for the PyCFrameWnd object. - -Args: - - wndClass(str):The window class name, or None - title(str):The window title - style(Any):The window style - PyCWnd(Any):The parent window - menuId(Any):The string or integer id for the menu. - styleEx(Any):The extended style of the window being created.MFC References - rect(tuple[Any, Any, Any, Any]):The default rectangle - createContext(Any):A tuple representing a CREATECONTEXT structure. - -Returns: - - Any - - """ - ... - - def EndModalState(self) -> None: - """ - None - -Args: - - - -Returns: - - None - - """ - ... - - def DockControlBar(self, controlBar: Any, arg: tuple[Any, Any, Any, Any], dockBarId: Any = 0) -> None: - """ - Docks a control bar. - -Args: - - controlBar(Any):The control bar to dock. - arg(tuple[Any, Any, Any, Any]):Determines, in screen coordinates, where the control bar will be docked in the nonclient area of the destination frame window.MFC References - dockBarId(Any):Determines which sides of the frame window to consider for docking. - -Returns: - - None - - """ - ... - - def EnableDocking(self, style: Any) -> None: - """ - Enable dockable control bars in a frame window - -Args: - - style(Any):Specifies which sides of the frame window can serve as docking sites for control bars.CommentsBy default, control bars will be docked to a side of the frame window in the following order: top, bottom, left, right. - -Returns: - - None - - """ - ... - - def FloatControlBar(self, controlBar: Any, arg: tuple[Any, Any], style: Any) -> None: - """ - Floats a control bar. - -Args: - - controlBar(Any):The control bar to dock. - arg(tuple[Any, Any]):The location, in screen coordinates, where the top left corner of the control bar will be placed. - style(Any):Determines which sides of the frame window to consider for docking.MFC References - -Returns: - - None - - """ - ... - - def GetActiveDocument(self) -> Any: - """ - Gets the currently active document, else None - -Args: - - - -Returns: - - Any - - """ - ... - - def GetControlBar(self, _id: Any) -> Any: - """ - Retrieves the specified control bar. - -Args: - - _id(Any):The ID of the toolbar to be retrieved - -Returns: - - Any - - """ - ... - - def GetMessageString(self, _id: Any) -> str: - """ - Retrieves message corresponding to a command ID. - -Args: - - _id(Any):The ID to be retrievedSee Also - -Returns: - - str - - """ - ... - - def GetMessageBar(self) -> Any: - """ - Retrieves the message bar for the frame. - -Args: - - - -Returns: - - Any - - """ - ... - - def IsTracking(self) -> Any: - """ - Determines if splitter bar is currently being moved. - -Args: - - - -Returns: - - Any - - """ - ... - - def InModalState(self) -> Any: - """ - Returns a value indicating whether or not a frame window is in a modal state. - -Args: - - - -Returns: - - Any - - """ - ... - - def LoadAccelTable(self, _id: PyResourceId) -> None: - """ - Loads an accelerator table. - -Args: - - _id(PyResourceId):Name or id of the resource that contains the table - -Returns: - - None - - """ - ... - - def LoadFrame(self, idResource: Any, style: Any = -1, wndParent: Any = None, context: Any = None) -> None: - """ - Loads a Windows frame window and associated resources - -Args: - - idResource(Any):The Id of the resources (menu, icon, etc) for this window - style(Any):The window style. Note -1 implies win32con.WS_OVERLAPPEDWINDOW|win32con.FWS_ADDTOTITLE - wndParent(Any):The parent of the window, or None. - context(Any):An object passed to the OnCreateClient for the frame,MFC References - -Returns: - - None - - """ - ... - - def LoadBarState(self, profileName: str) -> None: - """ - Loads a control bars settings - -Args: - - profileName(str):Name of a section in the initialization file or a key in the Windows registry where state information is stored.MFC References - -Returns: - - None - - """ - ... - - def PreCreateWindow(self, createStruct: Any) -> Any: - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(Any):A tuple representing a CREATESTRUCT structure.See Also - -Returns: - - Any - - """ - ... - - def SaveBarState(self, profileName: str) -> None: - """ - Saves a control bars settings - -Args: - - profileName(str):Name of a section in the initialization file or a key in the Windows registry where state information is stored.MFC References - -Returns: - - None - - """ - ... - - def ShowControlBar(self, controlBar: Any, bShow: Any, bDelay: Any) -> None: - """ - Shows a control bar. - -Args: - - controlBar(Any):The control bar to dock. - bShow(Any):Show or hide flag. - bDelay(Any):If TRUE, delay showing the control bar. If FALSE, show the control bar immediately.MFC References - -Returns: - - None - - """ - ... - - def RecalcLayout(self, bNotify: Any = 1) -> None: - """ - Called by the framework when the standard control bars are toggled on or off or - -when the frame window is resized. - -Args: - - bNotify(Any):Notify flagMFC References - -Returns: - - None - - """ - ... - - def GetActiveView(self) -> Any: - """ - Retrieves the active view. - -Args: - - - -Returns: - - Any - - """ - ... - - def OnBarCheck(self, _id: Any) -> Any: - """ - Changes the state of the specified controlbar. - -Args: - - _id(Any):The control ID of the control bar. - -Returns: - - Any - - """ - ... - - def OnUpdateControlBarMenu(self, cmdUI: Any) -> Any: - """ - Checks the state of a menu item - -Args: - - cmdUI(Any):A cmdui object - -Returns: - - Any - - """ - ... - - def SetActiveView(self, view: Any, bNotify: Any = 1) -> None: - """ - Sets the active view for a frame. - -Args: - - view(Any):The view to set active. - bNotify(Any):Specifies whether the view is to be notified of activation. If TRUE, OnActivateView is called for the new view; if FALSE, it is not. - -Returns: - - None - - """ - ... - - -class PyCGdiObject: - """A class which encapsulates an MFC CGdiObject.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCImageList: - """A Python type encapsulating an MFC CImageList class.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Add(self, arg: tuple[Any, Any], bitmap: Any, color: Any, hIcon: Any) -> Any: - """ - Adds an image to the list. - -Args: - - arg(tuple[Any, Any]):2 Bitmaps to use (primary and mask)Alternative Parameters - bitmap(Any):Bitmap to use - color(Any):Color to use for the mask.Alternative Parameters - hIcon(Any):Handle of an icon to add.Return ValueZero-based index of the first new image. - -Returns: - - Any:Handle of an icon to add. -Return ValueZero-based index of the first new image. - - - """ - ... - - def Destroy(self) -> None: - """ - Destroys the underlying CImageList - -Args: - - - -Returns: - - None - - """ - ... - - def DeleteImageList(self) -> None: - """ - Deletes an image list. - -Args: - - - -Returns: - - None - - """ - ... - - def GetBkColor(self) -> Any: - """ - Retrieves the background color of an Image list. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetSafeHandle(self) -> Any: - """ - Retrieves the HIMAGELIST for the object - -Args: - - - -Returns: - - Any - - """ - ... - - def GetImageCount(self) -> Any: - """ - Retrieves the number of images in an image list. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetImageInfo(self, index: Any) -> Any: - """ - Retrieves information about an image. - -Args: - - index(Any):Index of image.Return ValueThe return info is a tuple describing an IMAGELIST structure. - -Returns: - - Any:Index of image.Return ValueThe return info is a tuple describing an IMAGELIST structure. - - - """ - ... - - def SetBkColor(self, color: Any) -> None: - """ - Sets the background color for an Image list. - -Args: - - color(Any):The new background color. - -Returns: - - None - - """ - ... - - -class PyCListBox: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def AddString(self, _object: Any) -> Any: - """ - Adds a string to a listbox. - -Args: - - _object(Any):Any object. If not a string, __str__, __repr__ or a default repr() will be usedMFC References - -Returns: - - Any:CListBox::AddString -Return ValueThe zero based index of the new string. - - - """ - ... - - def DeleteString(self, pos: Any) -> Any: - """ - Deletes an item from a listbox. - -Args: - - pos(Any):The zero based index of the item to delete.MFC References - -Returns: - - Any:CListBox::DeleteString -Return ValueThe count of the items remaining in the list. - - - """ - ... - - def Dir(self, attr: Any, wild: str) -> Any: - """ - Fills a listbox with a directory listing. - -Args: - - attr(Any):The attributes of the files to locate - wild(str):A file specification string - eg, *.*MFC References - -Returns: - - Any:CListBox::Dir -Return ValueThe index of the last file name added to the list. - - - """ - ... - - def GetCaretIndex(self) -> Any: - """ - Returns the index of the item which has focus. - -Args: - - - -Returns: - - 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. - -If the list box is a single-selection list box, the return value is the index of the item that is selected, if - -any. - - - """ - ... - - def GetCount(self) -> Any: - """ - Returns the count of items in the listbox. - -Args: - - - -Returns: - - Any:CListBox::GetCount -Return ValueReturns the number of items currently in the listbox. - - - """ - ... - - def GetCurSel(self) -> Any: - """ - Returns the index of the currently selected item. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetItemData(self, item: Any) -> Any: - """ - Retrieves the application-specific object associated with an item. - -Args: - - item(Any):The index of the item whose data is to be retrieved. - -Returns: - - Any - - """ - ... - - def GetItemValue(self, item: Any) -> Any: - """ - Retrieves the application-specific value associated with an item. - -Args: - - item(Any):The index of the item whose data is to be retrieved. - -Returns: - - Any - - """ - ... - - def GetSel(self, index: Any) -> Any: - """ - Returns the selection state of a specified item. - -Args: - - index(Any):The index of the item to return the state for.MFC References - -Returns: - - Any:CListBox::GetSel -Return ValueA +ve number if the item is selected, else zero. - - - """ - ... - - def GetSelCount(self) -> Any: - """ - Returns the number of selected items in a multiple selection listbox. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetSelItems(self) -> Any: - """ - Returns a list of the indexes of the currently selected items in a multiple - -selection listbox. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetSelTextItems(self) -> Any: - """ - Returns a list of the strings of the currently selected items in a multiple - -selection listbox. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetTopIndex(self) -> Any: - """ - Returns the index of the top most visible item. - -Args: - - - -Returns: - - Any:CListBox::GetTopIndex -Return ValueThe zero based index of the top most visible item. - - - """ - ... - - def GetText(self, index: Any) -> str: - """ - Returns the string for a specified item. - -Args: - - index(Any):The index of the item to retrieve the text of - -Returns: - - str - - """ - ... - - def GetTextLen(self, index: Any) -> Any: - """ - Returns the length of the string for a specified item. - -Args: - - index(Any):The index of the item to retrieve the length of the text.MFC References - -Returns: - - Any - - """ - ... - - def InsertString(self, pos: Any, _object: Any) -> Any: - """ - Insert a string into a listbox. - -Args: - - pos(Any):The zero based index in the listbox to insert the new string - _object(Any):The object to be added to the listboxMFC References - -Returns: - - Any:CListBox::InsertString -Return ValueThe zero based index of the new string added. - - - """ - ... - - def ResetContent(self) -> None: - """ - Clear all the items from a listbox. - -Args: - - - -Returns: - - None - - """ - ... - - def SetCaretIndex(self, index: Any, bScroll: Any = 1) -> None: - """ - Sets the focus rectange to a specified item. - -Args: - - index(Any):The zero based index of the item. - bScroll(Any):Should the listbox scroll to the item?MFC References - -Returns: - - None - - """ - ... - - def SelectString(self, after: Any, string: str) -> None: - """ - Searches for a list-box item that matches the specified string, and selects it. - -Args: - - after(Any):Contains the zero-based index of the item before the first item to be searched, or -1 for the entire listbox. - string(str):The string to search for.MFC References - -Returns: - - None:CListBox::SelectString -Return ValueThe return value is always None - an exception is raised if the string can not be located. - - - """ - ... - - def SelItemRange(self, bSel: Any, start: Any, end: Any) -> None: - """ - Selects an item range. - -Args: - - bSel(Any):Should the selection specified be set or cleared? - start(Any):The zero based index of the first item to select. - end(Any):The zero based index of the last item to select. - -Returns: - - None - - """ - ... - - def SetCurSel(self, index: Any) -> None: - """ - Selects an item in a single selection listbox. - -Args: - - index(Any):The zero based index of the item to select.MFC References - -Returns: - - None - - """ - ... - - def SetItemData(self, item: Any, Data: Any) -> Any: - """ - Sets the item's application-specific object value. - -Args: - - item(Any):Index of the item whose Data is to be set. - Data(Any):New value for the data.CommentsNote that a reference count is not added to the object. This it is your responsibility to make sure the object remains alive while in the list. - -Returns: - - Any - - """ - ... - - def SetItemValue(self, item: Any, data: Any) -> Any: - """ - Sets the item's application-specific value. - -Args: - - item(Any):Index of the item whose Data is to be set. - data(Any):New value for the data. - -Returns: - - Any - - """ - ... - - def SetSel(self, index: Any, bSel: Any = 1) -> None: - """ - Selects an item in a multiple selection listbox. - -Args: - - index(Any):The zero based index of the item to select. - bSel(Any):Should the item be selected or deselected?MFC References - -Returns: - - None - - """ - ... - - def SetTabStops(self, eachTabStop: Any, tabStops: Any) -> None: - """ - Sets the tab stops for a listbox. - -Args: - - eachTabStop(Any):The position for each tab stop.Alternative Parameters - tabStops(Any):Each individual tab stop. - -Returns: - - None - - """ - ... - - def SetTopIndex(self, index: Any) -> None: - """ - Sets the top index (top most visible item) of the listbox. - -Args: - - index(Any):The zero based index of the item to place at the top of the list.MFC References - -Returns: - - None - - """ - ... - - -class PyCListCtrl: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Arrange(self, code: Any) -> None: - """ - Aligns items on a grid. - -Args: - - code(Any):Specifies the alignment style for the items - -Returns: - - None - - """ - ... - - def CreateWindow(self, style: Any, rect: tuple[Any, Any, Any, Any], PyCWnd: Any, _id: Any) -> None: - """ - Creates the actual window for the object. - -Args: - - style(Any):The window style - rect(tuple[Any, Any, Any, Any]):The default rectangle - PyCWnd(Any):The parent window - _id(Any):The control IDMFC References - -Returns: - - None - - """ - ... - - def DeleteAllItems(self) -> None: - """ - Deletes all items from the list. - -Args: - - - -Returns: - - None - - """ - ... - - def DeleteItem(self, item: Any) -> None: - """ - Deletes the specified item. - -Args: - - item(Any):The item to delete. - -Returns: - - None - - """ - ... - - def GetTextColor(self) -> Any: - """ - Retrieves the text color of a list view control. - -Args: - - - -Returns: - - Any - - """ - ... - - def SetTextColor(self, color: Any) -> None: - """ - Sets the text color of a list view control. - -Args: - - color(Any):The new color. - -Returns: - - None - - """ - ... - - def GetBkColor(self) -> Any: - """ - Retrieves the background color of the control. - -Args: - - - -Returns: - - Any - - """ - ... - - def SetBkColor(self, color: Any) -> None: - """ - Sets the background color of the control. - -Args: - - color(Any):The new background color. - -Returns: - - None - - """ - ... - - def GetItem(self, item: Any, sub: Any) -> Any: - """ - Retrieves the details of an items attributes. - -Args: - - item(Any):The index of the item whose attributes are to be retrieved. - sub(Any):Specifies the subitem whose text is to be retrieved. - -Returns: - - Any - - """ - ... - - def GetItemCount(self) -> Any: - """ - Retrieves the number of items in a list view control. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetItemRect(self, item: Any, bTextOnly: Any) -> tuple[Any, Any, Any, Any]: - """ - Retrieves the bounding rectangle of a list view item. - -Args: - - item(Any):Index of the item whose Data is to be set. - bTextOnly(Any):f this parameter is nonzero, the bounding rectangle includes only the text of the item. Otherwise it includes the entire line that the item occupies in the list view control. - -Returns: - - tuple[Any, Any, Any, Any] - - """ - ... - - def GetEditControl(self) -> Any: - """ - Retrieves the handle of the edit control used to edit the specified - -list view item. - -Args: - - - -Returns: - - Any - - """ - ... - - def EditLabel(self, item: Any) -> Any: - """ - Edits a specified list view item in-place. - -Args: - - item(Any):The index of item to edit. - -Returns: - - Any - - """ - ... - - def EnsureVisible(self, item: Any, bPartialOK: Any) -> Any: - """ - Ensures that a list view item is visible in its list view control. - -Args: - - item(Any):The index of item to edit. - bPartialOK(Any):Specifies whether partial visibility is acceptable. - -Returns: - - Any - - """ - ... - - def CreateDragImage(self, item: Any) -> tuple[Any, Any, Any]: - """ - Creates a dragging bitmap for the specified list view - -item. - -Args: - - item(Any):The index of the item to edit. - -Returns: - - tuple[Any, Any, Any] - - """ - ... - - def GetImageList(self, nImageList: Any) -> Any: - """ - Retrieves the current image list. - -Args: - - nImageList(Any):Value specifying which image list to retrieve. It can be one of: - commctrl.LVSIL_NORMAL Image list with large icons. - commctrl.LVSIL_SMALL Image list with small icons. - commctrl.LVSIL_STATE Image list with state images. - -Returns: - - Any - - """ - ... - - def GetNextItem(self, item: Any, flags: Any) -> Any: - """ - Searches for a list view item with specified properties and with specified - -relationship to a given item. - -Args: - - item(Any):Index of the item to begin the searching with, or -1 to find the first item that matches the specified flags. The specified item itself is excluded from the search. - flags(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: LVNI_ABOVELVNI_ALLLVNI_BELOWLVNI_TOLEFTLVNI_TORIGHT The state can be zero, or it can be one or more of these values: LVNI_DROPHILITEDLVNI_FOCUSEDLVNI_HIDDENLVNI_MARKEDLVNI_SELECTED 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. - -Returns: - - 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: - -LVNI_ABOVELVNI_ALLLVNI_BELOWLVNI_TOLEFTLVNI_TORIGHT - -The state can be zero, or it can be one or more of these values: - -LVNI_DROPHILITEDLVNI_FOCUSEDLVNI_HIDDENLVNI_MARKEDLVNI_SELECTED - -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. - - - """ - ... - - def InsertColumn(self, colNo: Any, item: Any) -> Any: - """ - Inserts a column into a list control when in report view. - -Args: - - colNo(Any):The new column number - item(Any):A tuple describing the new column. - -Returns: - - Any - - """ - ... - - def InsertItem(self, item: Any, item1: Any, text: Any, image: Any, item2: Any, text1: Any) -> Any: - """ - Inserts an item into the list. - -Args: - - item(Any):A tuple describing the new item.Alternative Parameters - item1(Any):The index of the item. - text(Any):The text of the item. - image(Any):The index of the image to use.Alternative Parameters - item2(Any):The index of the item. - text1(Any):The text of the item. - -Returns: - - Any - - """ - ... - - def SetImageList(self, imageList: Any, imageType: Any) -> Any: - """ - Assigns an image list to a list view control. - -Args: - - imageList(Any):The Image list to use. - imageType(Any):Type of image list. It can be one of (COMMCTRL.) LVSIL_NORMAL, LVSIL_SMALL or LVSIL_STATE - -Returns: - - Any - - """ - ... - - def GetColumn(self, column: Any) -> Any: - """ - Retrieves the details of a column in the control. - -Args: - - column(Any):The index of the column whose attributes are to be retrieved. - -Returns: - - Any - - """ - ... - - def GetTextBkColor(self) -> Any: - """ - Retrieves the text background color of a list view control. - -Args: - - - -Returns: - - Any - - """ - ... - - def SetTextBkColor(self, color: Any) -> None: - """ - Sets the text background color of a list view control. - -Args: - - color(Any):The new background color. - -Returns: - - None - - """ - ... - - def GetTopIndex(self) -> Any: - """ - Retrieves the index of the topmost visible item. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetCountPerPage(self) -> Any: - """ - Calculates the number of items that can fit vertically in a list view - -control. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetSelectedCount(self) -> Any: - """ - Retrieves the number of selected items in the list view control. - -Args: - - - -Returns: - - Any - - """ - ... - - def SetItem(self, item: Any) -> Any: - """ - Sets some of all of an items attributes. - -Args: - - item(Any):A tuple describing the new item. - -Returns: - - Any - - """ - ... - - def SetItemState(self, item: Any, state: Any, mask: Any) -> Any: - """ - Changes the state of an item in a list view control. - -Args: - - item(Any):Index of the item whose state is to be set. - state(Any):New values for the state bits. - mask(Any):Mask specifying which state bits to change. - -Returns: - - Any - - """ - ... - - def GetItemState(self, item: Any, mask: Any) -> Any: - """ - Retrieves the state of a list view item. - -Args: - - item(Any):The index of the item whose position is to be retrieved. - mask(Any):Mask specifying which of the item's state flags to return. - -Returns: - - Any - - """ - ... - - def SetItemData(self, item: Any, Data: Any) -> Any: - """ - Sets the item's application-specific value. - -Args: - - item(Any):Index of the item whose Data is to be set. - Data(Any):New value for the data.CommentsNote that a reference count is not added to the object. This it is your responsibility to make sure the object remains alive while in the list. - -Returns: - - Any - - """ - ... - - def GetItemData(self, item: Any) -> Any: - """ - Retrieves the application-specific value associated with an item. - -Args: - - item(Any):The index of the item whose data is to be retrieved. - -Returns: - - Any - - """ - ... - - def SetItemCount(self, count: Any) -> None: - """ - Prepares a list view control for adding a large number of items. - -Args: - - count(Any):Number of items that the control will ultimately contain.CommentsBy calling this function before adding a large number of items, you enable a list view control to reallocate its internal data structures only once rather than every time you add an item. - -Returns: - - None - - """ - ... - - def SetItemText(self, item: Any, sub: Any, text: str) -> Any: - """ - Changes the text of a list view item or subitem. - -Args: - - item(Any):Index of the item whose text is to be set. - sub(Any):Index of the subitem, or zero to set the item label. - text(str):String that contains the new item text. - -Returns: - - Any - - """ - ... - - def GetItemText(self, item: Any, sub: Any) -> Any: - """ - Retrieves the text of a list view item or subitem. - -Args: - - item(Any):The index of the item whose text is to be retrieved. - sub(Any):Specifies the subitem whose text is to be retrieved. - -Returns: - - Any - - """ - ... - - def RedrawItems(self, first: Any, first1: Any) -> Any: - """ - Forces a listview to repaint a range of items. - -Args: - - first(Any):Index of the first item to be repainted. - first1(Any):Index of the last item to be repainted.CommentsThe specified items are not actually repainted until the list view window receives a WM_PAINT message. To repaint immediately, call the Windows UpdateWindow function after using this function. - -Returns: - - Any - - """ - ... - - def Update(self, item: Any) -> None: - """ - Forces the control to repaint a specified item. - -Args: - - item(Any):The new color. - -Returns: - - None - - """ - ... - - def SetColumn(self, colNo: Any, item: Any) -> Any: - """ - Changes column state in a list control when in report view. - -Args: - - colNo(Any):The to be modified column number - item(Any):A tuple describing the modified column. - -Returns: - - Any - - """ - ... - - def DeleteColumn(self, first: Any) -> Any: - """ - Deletes the specified column from the list control. - -Args: - - first(Any):Index of the column to be removed. - -Returns: - - Any - - """ - ... - - def GetColumnWidth(self, first: Any) -> Any: - """ - Gets the width of the specified column in the list control. - -Args: - - first(Any):Index of the column whose width is to be retrieved. - -Returns: - - Any - - """ - ... - - def SetColumnWidth(self, first: Any, first1: Any) -> Any: - """ - Sets the width of the specified column in the list control. - -Args: - - first(Any):Index of the column to be changed. - first1(Any):New width of the column. - -Returns: - - Any - - """ - ... - - def GetStringWidth(self, first: Any) -> Any: - """ - Gets the necessary column width to fully display this text in a column. - -Args: - - first(Any):String that contains the text whose width is to be determined.CommentsDoesn't take the size of an included Image in account, only the size of the text is determined. - -Returns: - - Any - - """ - ... - - def HitTest(self, arg: Any) -> tuple[Any, Any, Any]: - """ - Determines which list view item, if any, is at a specified position. - -Args: - - arg(Any):The point to test.Return ValueThe result is a tuple of (flags, item, subItem). flags may be a combination of the following values:ValueDescriptioncommctrl.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 list item.commctrl.LVHT_ONITEMICONThe position is over a list view item's icon.commctrl.LVHT_ONITEMLABELThe position is over a list view item's text.commctrl.LVHT_ONITEMSTATEICONThe position is over the state image of a list view item.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. - -Returns: - - tuple[Any, Any, Any]:The point to test.Return ValueThe result is a tuple of (flags, item, subItem). - -flags may be a combination of the following values: - - - -Value - - -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 - -list item. -commctrl.LVHT_ONITEMICONThe position is over a list view item's icon. -commctrl.LVHT_ONITEMLABELThe position is over a list view item's text. -commctrl.LVHT_ONITEMSTATEICONThe position is over the state image of a list view item. -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. - - - """ - ... - - def GetItemPosition(self, item: Any) -> tuple[Any, Any]: - """ - Determines the position of the specified item. - -Args: - - item(Any):The item to determine the position for. - -Returns: - - tuple[Any, Any] - - """ - ... - - -class PyCListView: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def PreCreateWindow(self, createStruct: Any) -> Any: - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(Any):A tuple representing a CREATESTRUCT structure. - -Returns: - - Any - - """ - ... - - def GetListCtrl(self) -> Any: - """ - Returns the underlying list control object. - -Args: - - - -Returns: - - Any - - """ - ... - - def OnCommand(self, wparam: Any, lparam: Any) -> None: - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(Any): - lparam(Any):See Also - -Returns: - - None - - """ - ... - - -class PyCMDIChildWnd: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def ActivateFrame(self, cmdShow: Any = -1) -> None: - """ - Calls the underlying MFC ActivateFrame method. - -Args: - - cmdShow(Any):The status of the window.See Also - -Returns: - - None - - """ - ... - - def CreateWindow( - self, - wndClass: str, - title: str, - style: Any, - PyCWnd: Any, - rect: tuple[Any, Any, Any, Any] = None, - createContext: Any = None) -> Any: - """ - Creates the actual window for the PyCWnd object. - -Args: - - wndClass(str):The window class name, or None - title(str):The window title - style(Any):The window style - PyCWnd(Any):The parent window - rect(tuple[Any, Any, Any, Any]):The default rectangle - createContext(Any):A tuple representing a CREATECONTEXT structure.CommentsYou do not need to call this method if you use the MFC Document/View framework. - -Returns: - - Any - - """ - ... - - def GetMDIFrame(self) -> None: - """ - Returns the MDI parent frame - -Args: - - - -Returns: - - None - - """ - ... - - def MDIActivate(self, cmdShow: Any = -1) -> None: - """ - Activates the MDI frame independent of the main frame. - -Args: - - cmdShow(Any):The status of the window.See Also - -Returns: - - None - - """ - ... - - def PreCreateWindow(self, createStruct: Any) -> Any: - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(Any):A tuple representing a CREATESTRUCT structure.See Also - -Returns: - - Any - - """ - ... - - def PreTranslateMessage(self) -> None: - """ - Calls the base PreTranslateMessage handler - -Args: - - - -Returns: - - None - - """ - ... - - def OnCommand(self, wparam: Any, lparam: Any) -> None: - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(Any): - lparam(Any):See Also - -Returns: - - None - - """ - ... - - def OnClose(self) -> None: - """ - Calls the standard Python framework OnClose handler - -Args: - - - -Returns: - - None - - """ - ... - - -class PyCMDIFrameWnd: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetMDIClient(self) -> Any: - """ - Returns the MDI client window - -Args: - - - -Returns: - - Any - - """ - ... - - def MDIGetActive(self) -> tuple[Any, Any]: - """ - Retrieves the current active MDI child window, along - -with a flag indicating whether the child window is maximized. - -Args: - - - -Returns: - - tuple[Any, Any] - - """ - ... - - def MDIActivate(self, window: Any) -> Any: - """ - Activate an MDI child window - -Args: - - window(Any):The window to activate. - -Returns: - - Any - - """ - ... - - def MDINext(self, fNext: Any = 0) -> None: - """ - Activates the next MDI window - -Args: - - fNext(Any):Indicates if the next (0) or previous (non-zero) window is requested.CommentsUnlike MFC, this version supports the fNext param in the WM_MDINEXT message. - -Returns: - - None - - """ - ... - - def PreCreateWindow(self, createStruct: Any) -> Any: - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(Any):A tuple representing a CREATESTRUCT structure.See Also - -Returns: - - Any - - """ - ... - - def PreTranslateMessage(self) -> None: - """ - Calls the base PreTranslateMessage handler - -Args: - - - -Returns: - - None - - """ - ... - - def OnCommand(self, wparam: Any, lparam: Any) -> None: - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(Any): - lparam(Any):See Also - -Returns: - - None - - """ - ... - - def OnContextHelp(self) -> Any: - """ - Calls the underlying MFC OnContextHelp method. - -Args: - - - -Returns: - - Any - - """ - ... - - def OnClose(self) -> None: - """ - Calls the standard Python framework OnClose handler - -Args: - - - -Returns: - - None - - """ - ... - - -class PyCMenu: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def AppendMenu(self, flags: Any, _id: Any = 0, value: Union[Any, str] = None) -> None: - """ - Appends a new item to the end of a menu. Python can specify the state of the menu item - -by setting values in nFlags. - -Args: - - flags(Any):Specifies information about the state of the new menu item when it is added to the menu. May be a combination of the win32con.MF_* values. - _id(Any):Specifies either the command ID of the new menu item. - value(Union[Any, str]):Specifies the content of the new menu item. If used, flags must contain win32con.MF_STRING. - -Returns: - - None - - """ - ... - - def DeleteMenu(self, _id: Any, flags: Any) -> str: - """ - Deletes the specified menu item. - -Args: - - _id(Any):The id of the item being deleted. - flags(Any):Specifies how the id parameter is interpreted. It must be one of win32con.MF_BYCOMMAND or win32con.MF_BYPOSITION. - -Returns: - - str - - """ - ... - - def EnableMenuItem(self, _id: Any, flags: Any) -> Any: - """ - Enables, disables, or dims a menu item. - -Args: - - _id(Any):Specifies the command ID of the menu item. This parameter can specify pop-up menu items as well as standard menu items. - flags(Any):Specifies the action to take. It can be a combination of MF_DISABLED, MF_ENABLED, or MF_GRAYED, with MF_BYCOMMAND or MF_BYPOSITIONCommentsThe PyCMenu::CreateMenu, PyCMenu::InsertMenu, PyCMenu::ModifyMenu, and PyCMenu::LoadMenuIndirect member functions can also set the state (enabled, disabled, or dimmed) of a menu item. - -Returns: - - Any - - """ - ... - - def GetHandle(self) -> Any: - """ - Returns the menu object's underlying hMenu. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetMenuItemCount(self) -> Any: - """ - Determines the number of items in a menu. - -Args: - - - -Returns: - - Any:PyCMenu.GetMenuItemCount - -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. - - - """ - ... - - def GetMenuItemID(self, pos: Any) -> Any: - """ - Returns the item ID for the specified item in a pop-up menu. - -Args: - - pos(Any):The position (zero-based) of the menu item whose ID is being retrieved.CommentsIf the specified item is a pop-up menu (as opposed to an item within the pop-up menu), the return value is -1. If nPos corresponds to a SEPARATOR menu item, the return value is 0. - -Returns: - - Any - - """ - ... - - def GetMenuString(self, _id: Any, arg: Any) -> str: - """ - Returns the string for a specified menu item. - -Args: - - _id(Any):The id of the item being requested. - arg(Any):Specifies how the id parameter is interpreted. It must be one of win32con.MF_BYCOMMAND or win32con.MF_BYPOSITION. - -Returns: - - str - - """ - ... - - def GetSubMenu(self, pos: Any) -> Any: - """ - Returns a submenu. - -Args: - - pos(Any):The position (zero-based) of the menu item being retrieved. - -Returns: - - Any - - """ - ... - - def InsertMenu(self, pos: Any, flags: Any, _id: Any = 0, value: Union[Any, str] = None) -> None: - """ - Inserts an item into a menu. - -Args: - - pos(Any):The position (zero-based) the item should be inserted. - flags(Any):Flags for the new item. - _id(Any):The ID for a new menu item, or handle to a submenu - value(Union[Any, str]):A string for the menu item. - -Returns: - - None - - """ - ... - - def ModifyMenu(self, pos: Any, flags: Any, _id: Any = 0, value: Union[Any, str] = None) -> None: - """ - Modify an item in a menu. - -Args: - - pos(Any):The position (zero-based) the item to be changed. - flags(Any):Flags for the item. - _id(Any):The ID for the item. - value(Union[Any, str]):A string for the menu item. - -Returns: - - None - - """ - ... - - def TrackPopupMenu(self, arg: tuple[Any, Any], arg1: Any, arg2: Any) -> None: - """ - Creates a popup menu anywhere on the screen. - -Args: - - arg(tuple[Any, Any]):The position for the menu.. - arg1(Any):Flags for the menu. - arg2(Any):The owner of the menu.CommentsThe TrackPopupMenu function displays a floating pop-up menu at the 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 returned instead of the normal exception. - -Returns: - - None:The owner of the menu. -Comments - -The TrackPopupMenu function displays a floating pop-up menu at the - -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 - -returned instead of the normal exception. - - - """ - ... - - -class PyCOleClientItem: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CreateNewItem(self) -> None: - """ - Creates an embedded item. - -Args: - - - -Returns: - - None - - """ - ... - - def Close(self) -> None: - """ - Closes the item - -Args: - - - -Returns: - - None - - """ - ... - - def DoVerb(self) -> None: - """ - Executes the specified verb. - -Args: - - - -Returns: - - None - - """ - ... - - def Draw(self) -> None: - """ - Draws the OLE item into the specified bounding rectangle using the specified device - -context. - -Args: - - - -Returns: - - None - - """ - ... - - def GetActiveView(self) -> Any: - """ - Obtains the active view for the item - -Args: - - - -Returns: - - Any - - """ - ... - - def GetDocument(self) -> Any: - """ - Obtains the current document for the item - -Args: - - - -Returns: - - Any - - """ - ... - - def GetInPlaceWindow(self) -> Any: - """ - Obtains the window in which the item has been opened for - -in-place editing. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetItemState(self) -> None: - """ - Obtains the OLE item's current state - -Args: - - - -Returns: - - None - - """ - ... - - def GetObject(self) -> Any: - """ - Returns the COM object to the item. This is the m_lpObject - -variable in MFC. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetStorage(self) -> None: - """ - Returns the COM object used for storage - -Args: - - - -Returns: - - None - - """ - ... - - def OnActivate(self) -> None: - """ - Calls the underlying MFC method. - -Args: - - - -Returns: - - None - - """ - ... - - def OnChange(self) -> None: - """ - Calls the underlying MFC method. - -Args: - - - -Returns: - - None - - """ - ... - - def OnChangeItemPosition(self) -> Any: - """ - Calls the underlying MFC method. - -Args: - - - -Returns: - - Any:PyCOleClientItem.OnChangeItemPosition - -int = OnChangeItemPosition()Calls the underlying MFC method. -Return ValueThe result is a BOOL indicating if the function succeeded. No exception is thrown. - - - """ - ... - - def OnDeactivateUI(self) -> Any: - """ - Calls the underlying MFC method. - -Args: - - - -Returns: - - Any - - """ - ... - - def Run(self) -> None: - """ - Runs the application associated with this item. - -Args: - - - -Returns: - - None - - """ - ... - - def SetItemRects(self) -> None: - """ - Sets the bounding rectangle or the visible rectangle of the OLE item. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyCOleDialog: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCOleDocument: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def EnableCompoundFile(self, bEnable: Any = 1) -> None: - """ - Call this function if you want to store the document using the - -compound-file format. - -Args: - - bEnable(Any):Specifies whether compound file support is enabled or disabled. - -Returns: - - None - - """ - ... - - def GetStartPosition(self) -> Any: - """ - Obtains the position of the first item in the document. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetNextItem(self, pos: Any) -> tuple[Any, Any]: - """ - Call this function repeatedly to access each of - -the items in your document. - -Args: - - pos(Any):The position to iterate from. - -Returns: - - tuple[Any, Any] - - """ - ... - - def GetInPlaceActiveItem(self, wnd: Any) -> Any: - """ - Obtains the OLE item that is currently activated - -in place in the frame window containing the view identified by obWnd. - -Args: - - wnd(Any):The window. - -Returns: - - Any - - """ - ... - - -class PyCOleInsertDialog: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetClassID(self) -> Any: - """ - Returns the CLSID associated with the selected item - -Args: - - - -Returns: - - Any - - """ - ... - - def GetSelectionType(self) -> Any: - """ - Returns the type of selection made - -Args: - - - -Returns: - - Any - - """ - ... - - def GetPathName(self) -> Any: - """ - Returns the full path to the file selected in the dialog box - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyCPrintDialog: - """An object which encapsulates an MFC CPrintDialog object.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCPrintInfo: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def DocObject(self) -> None: - """ - Return true if the document being printed is a DocObject. - -Args: - - - -Returns: - - None - - """ - ... - - def GetDwFlags(self) -> None: - """ - A flags specifying DocObject printing operations. Valid only if data member - -m_bDocObject is TRUE. - -Args: - - - -Returns: - - None - - """ - ... - - def SetDwFlags(self) -> None: - """ - Set a flag specifying DocObject printing operations. Valid only if data member - -m_bDocObject is TRUE. - -Args: - - - -Returns: - - None - - """ - ... - - def GetDocOffsetPage(self) -> None: - """ - Get the number of pages preceding the first page of a particular DocObject - -in a combined DocObject print job. - -Args: - - - -Returns: - - None - - """ - ... - - def SetDocOffsetPage(self) -> None: - """ - Set the number of pages preceding the first page of a particular DocObject - -in a combined DocObject print job. - -Args: - - - -Returns: - - None - - """ - ... - - def SetPrintDialog(self) -> None: - """ - Set a pointer to the CPrintDialog object used to display the Print dialog box - -for the print job. - -Args: - - - -Returns: - - None - - """ - ... - - def GetDirect(self) -> None: - """ - TRUE if the Print dialog box will be bypassed for direct printing; FALSE otherwise. - -Args: - - - -Returns: - - None - - """ - ... - - def SetDirect(self) -> None: - """ - Sets to TRUE if the Print dialog box will be bypassed for direct printing; FALSE - -otherwise. - -Args: - - - -Returns: - - None - - """ - ... - - def GetPreview(self) -> None: - """ - A flag indicating whether the document is being previewed. - -Args: - - - -Returns: - - None - - """ - ... - - def SetPreview(self) -> None: - """ - Set whether the document is being previewed. - -Args: - - - -Returns: - - None - - """ - ... - - def GetContinuePrinting(self) -> None: - """ - A flag indicating whether the framework should continue the print loop. - -Args: - - - -Returns: - - None - - """ - ... - - def SetContinuePrinting(self) -> None: - """ - Set whether the framework should continue the print loop. - -Args: - - - -Returns: - - None - - """ - ... - - def GetCurPage(self) -> None: - """ - Get the number of the current page. - -Args: - - - -Returns: - - None - - """ - ... - - def SetCurPage(self) -> None: - """ - Set the number of the current page. - -Args: - - - -Returns: - - None - - """ - ... - - def GetNumPreviewPages(self) -> None: - """ - Get the number of pages displayed in preview mode. - -Args: - - - -Returns: - - None - - """ - ... - - def SetNumPreviewPages(self) -> None: - """ - Set the number of pages displayed in preview mode. - -Args: - - - -Returns: - - None - - """ - ... - - def GetUserData(self) -> None: - """ - Get a user-created structure. - -Args: - - - -Returns: - - None - - """ - ... - - def SetUserData(self) -> None: - """ - Set a user-created structure. - -Args: - - - -Returns: - - None - - """ - ... - - def GetDraw(self) -> None: - """ - Get the usable drawing area of the page in logical coordinates. - -Args: - - - -Returns: - - None - - """ - ... - - def SetDraw(self) -> None: - """ - Set the usable drawing area of the page in logical coordinates. - -Args: - - - -Returns: - - None - - """ - ... - - def GetPageDesc(self) -> None: - """ - Get the format string used to display the page numbers during print preview - -Args: - - - -Returns: - - None - - """ - ... - - def SetPageDesc(self) -> None: - """ - Set the format string used to display the page numbers during print preview - -Args: - - - -Returns: - - None - - """ - ... - - def GetMinPage(self) -> None: - """ - Get the number of the first page of the document. - -Args: - - - -Returns: - - None - - """ - ... - - def SetMinPage(self) -> None: - """ - Set the number of the first page of the document. - -Args: - - - -Returns: - - None - - """ - ... - - def GetMaxPage(self) -> None: - """ - Get the number of the last page of the document. - -Args: - - - -Returns: - - None - - """ - ... - - def SetMaxPage(self) -> None: - """ - Set the number of the last page of the document. - -Args: - - - -Returns: - - None - - """ - ... - - def GetOffsetPage(self) -> None: - """ - 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 - -pInfo->GetOffsetPage(), the link fails to find its definition. Allways returns 0. - -Args: - - - -Returns: - - None - - """ - ... - - def GetFromPage(self) -> None: - """ - The number of the first page to be printed. - -Args: - - - -Returns: - - None - - """ - ... - - def GetToPage(self) -> None: - """ - The number of the last page to be printed. - -Args: - - - -Returns: - - None - - """ - ... - - def SetHDC(self, hdc: Any) -> None: - """ - Sets the printer DC compatible with the users choices, call after the print dialog - -DoModal finishes. - -Args: - - hdc(Any):The DC.MFC References - -Returns: - - None - - """ - ... - - def CreatePrinterDC(self) -> None: - """ - Handle to the newly created printer device context, call only after DoModal - -finishes. - -Args: - - - -Returns: - - None - - """ - ... - - def DoModal(self) -> None: - """ - Call DoModal on the dialog. - -Args: - - - -Returns: - - None - - """ - ... - - def GetCopies(self) -> None: - """ - The number of copies requested, call only after DoModal finishes. - -Args: - - - -Returns: - - None - - """ - ... - - def GetDefaults(self) -> None: - """ - 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 - -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 - -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) - -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. - -Args: - - - -Returns: - - None - - """ - ... - - def FreeDefaults(self) -> None: - """ - 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. - -Args: - - - -Returns: - - None - - """ - ... - - def GetDeviceName(self) -> None: - """ - The name of the currently selected printer, call only after DoModal finishes. - -Args: - - - -Returns: - - None - - """ - ... - - def GetDriverName(self) -> None: - """ - The name of the currently selected printer device driver, call only after - -DoModal finishes. - -Args: - - - -Returns: - - None - - """ - ... - - def GetDlgFromPage(self) -> None: - """ - Retrieves the starting page of the print range. - -Args: - - - -Returns: - - None - - """ - ... - - def GetDlgToPage(self) -> None: - """ - Retrieves the ending page of the print range. - -Args: - - - -Returns: - - None - - """ - ... - - def GetPortName(self) -> None: - """ - The name of the currently selected printer port, call only after DoModal - -finishes. - -Args: - - - -Returns: - - None - - """ - ... - - def GetPrinterDC(self) -> None: - """ - 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 - -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. - -Args: - - - -Returns: - - None - - """ - ... - - def PrintAll(self) -> None: - """ - Nonzero if all pages in the document are to be printed; otherwise 0, call only after - -DoModal finishes. - -Args: - - - -Returns: - - None - - """ - ... - - def PrintCollate(self) -> None: - """ - Nonzero if the user selects the collate check box in the dialog box; otherwise - -0, call only after DoModal finishes. - -Args: - - - -Returns: - - None - - """ - ... - - def PrintRange(self) -> None: - """ - Nonzero if only a range of pages in the document are to be printed; otherwise 0, - -call only after DoModal finishes. - -Args: - - - -Returns: - - None - - """ - ... - - def PrintSelection(self) -> None: - """ - Nonzero if only the selected items are to be printed; otherwise 0., call only - -after DoModal finishes - -Args: - - - -Returns: - - None - - """ - ... - - def GetHDC(self) -> None: - """ - 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 - -undefined. If both flags are specified, PD_RETURNDC has priority. - -Args: - - - -Returns: - - None - - """ - ... - - def GetFlags(self) -> None: - """ - 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 - -following flags: PD_ALLPAGES, PD_COLLATE, PD_DISABLEPRINTTOFILE, PD_ENABLEPRINTHOOK, PD_ENABLEPRINTTEMPLATE, - -PD_ENABLEPRINTTEMPLATEHANDLE, PD_ENABLESETUPHOOK, PD_ENABLESETUPTEMPLATE, PD_ENABLESETUPTEMPLATEHANDLE, - -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_USEDEVMODECOPIESANDCOLLATE. - -Args: - - - -Returns: - - None - - """ - ... - - def SetFlags(self) -> None: - """ - 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 - -following flags: PD_ALLPAGES, PD_COLLATE, PD_DISABLEPRINTTOFILE, PD_ENABLEPRINTHOOK, PD_ENABLEPRINTTEMPLATE, - -PD_ENABLEPRINTTEMPLATEHANDLE, PD_ENABLESETUPHOOK, PD_ENABLESETUPTEMPLATE, PD_ENABLESETUPTEMPLATEHANDLE, - -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_USEDEVMODECOPIESANDCOLLATE. - -Args: - - - -Returns: - - None - - """ - ... - - def SetFromPage(self) -> None: - """ - The number of the first page to be printed. - -Args: - - - -Returns: - - None - - """ - ... - - def SetToPage(self) -> None: - """ - The number of the last page to be printed. - -Args: - - - -Returns: - - None - - """ - ... - - def GetPRINTDLGMinPage(self) -> None: - """ - 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 - -disabled. - -Args: - - - -Returns: - - None - - """ - ... - - def SetPRINTDLGMinPage(self) -> None: - """ - 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 - -disabled. - -Args: - - - -Returns: - - None - - """ - ... - - def GetPRINTDLGCopies(self) -> None: - """ - 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, - -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 - -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 - -information, see the description of the PD_USEDEVMODECOPIESANDCOLLATE flag. - -Args: - - - -Returns: - - None - - """ - ... - - def SetPRINTDLGCopies(self) -> None: - """ - 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, - -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 - -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 - -information, see the description of the PD_USEDEVMODECOPIESANDCOLLATE flag. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyCProgressCtrl: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CreateWindow(self, style: Any, rect: tuple[Any, Any, Any, Any], parent: Any, _id: Any) -> None: - """ - Creates the actual control. - -Args: - - style(Any):The style for the control. - rect(tuple[Any, Any, Any, Any]):The size and position of the control. - parent(Any):The parent window of the control. Usually a PyCDialog. - _id(Any):The control's ID. - -Returns: - - None - - """ - ... - - def SetRange(self, nLower: Any = 1, nUpper: Any = 1) -> None: - """ - Set the control's bounds - -Args: - - nLower(Any):Specifies the lower limit of the range (default is zero). - nUpper(Any):Specifies the upper limit of the range (default is 100). - -Returns: - - None - - """ - ... - - def SetPos(self, nPos: Any = 1) -> Any: - """ - Set the control's position - -Args: - - nPos(Any):New position of the progress bar control. - -Returns: - - Any - - """ - ... - - def OffsetPos(self, nPos: Any = 1) -> Any: - """ - Advances the progress bar control's current position by the increment - -specified - -Args: - - nPos(Any):Amount to advance the position. - -Returns: - - Any - - """ - ... - - def SetStep(self, nStep: Any = 1) -> Any: - """ - Specifies the step increment for a progress bar control. - -Args: - - nStep(Any):New step increment. - -Returns: - - Any - - """ - ... - - def StepIt(self) -> Any: - """ - Advances the current position for a progress bar control by the step increment. - -Returns previous position. - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyCPropertyPage: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CancelToClose(self) -> None: - """ - Changes the Cancel button to Close. - -Args: - - - -Returns: - - None - - """ - ... - - def OnCancel(self) -> None: - """ - Calls the default MFC OnCancel handler. - -Args: - - - -Returns: - - None - - """ - ... - - def OnOK(self) -> None: - """ - Calls the default MFC OnOK handler. - -Args: - - - -Returns: - - None - - """ - ... - - def OnApply(self) -> None: - """ - Calls the default MFC OnApply handler. - -Args: - - - -Returns: - - None - - """ - ... - - def OnReset(self) -> None: - """ - Calls the default MFC OnReset handler. - -Args: - - - -Returns: - - None - - """ - ... - - def OnQueryCancel(self) -> None: - """ - Calls the default MFC OnQueryCancel handler. - -Args: - - - -Returns: - - None - - """ - ... - - def OnWizardBack(self) -> None: - """ - Calls the default MFC OnWizardBack handler. - -Args: - - - -Returns: - - None - - """ - ... - - def OnWizardNext(self) -> None: - """ - Calls the default MFC OnWizardNext handler. - -Args: - - - -Returns: - - None - - """ - ... - - def OnWizardFinish(self) -> None: - """ - Calls the default MFC OnWizardFinish handler. - -Args: - - - -Returns: - - None - - """ - ... - - def OnSetActive(self) -> Any: - """ - Calls the default MFC OnSetActive handler. - -Args: - - - -Returns: - - Any:PyCPropertyPage.OnSetActive virtual method -Return ValueThe result is true if the page should be made active. - -Typically this result should be passed to the original OnSetActive handler. - - - """ - ... - - def OnKillActive(self) -> Any: - """ - Calls the default MFC OnKillActive handler. - -Args: - - - -Returns: - - Any:PyCPropertyPage.OnKillActive virtual method -Return ValueThe result is true if the page should be deselected. - -Typically this result should be passed to the original OnSetActive handler. - - - """ - ... - - def SetModified(self, bChanged: Any = 1) -> None: - """ - Sets the modified flag. - -Args: - - bChanged(Any):A flag to indicate the new modified state. - -Returns: - - None - - """ - ... - - def SetPSPBit(self, bitMask: Any, bitValue: Any) -> None: - """ - Sets or clears a bit in m_psp.dwFlags - -Args: - - bitMask(Any):The PSP_* bit mask constant - bitValue(Any):1 to set, 0 to clear - -Returns: - - None - - """ - ... - - -class PyCPropertySheet: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def AddPage(self, page: Any) -> None: - """ - Adds the supplied page with the rightmost tab in the property sheet. - -Args: - - page(Any):The page to be added.CommentsAdd pages to the property sheet in the left-to-right order you want them to appear.MFC References - -Returns: - - None - - """ - ... - - def CreateWindow(self, style: Any, exStyle: Any, parent: Any = None) -> None: - """ - Displays the property sheet as a modeless dialog. - -Args: - - style(Any):The style for the window. - exStyle(Any):The extended style for the window. - parent(Any):The parent of the dialog. - -Returns: - - None - - """ - ... - - def DoModal(self) -> Any: - """ - Displays the property sheet as a modal dialog. - -Args: - - - -Returns: - - Any - - """ - ... - - def EnableStackedTabs(self, stacked: Any) -> Any: - """ - Enables or disables stacked tabs. - -Args: - - stacked(Any):A boolean flag - -Returns: - - Any - - """ - ... - - def EndDialog(self, result: Any) -> None: - """ - Closes the dialog, with the specified result. - -Args: - - result(Any):The result to be returned by DoModal. - -Returns: - - None - - """ - ... - - def GetActiveIndex(self) -> Any: - """ - Retrieves the index of the active page of the property sheet. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetActivePage(self) -> Any: - """ - Returns the currently active property page. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetPage(self, pageNo: Any) -> Any: - """ - Returns the specified property page. - -Args: - - pageNo(Any):The index of the page toretrieve.MFC References - -Returns: - - Any - - """ - ... - - def GetPageIndex(self, page: Any) -> Any: - """ - Retrieves the index of the specified page of the property sheet. - -Args: - - page(Any):The page. - -Returns: - - Any - - """ - ... - - def GetPageCount(self) -> Any: - """ - Returns the number of pages. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetTabCtrl(self) -> Any: - """ - Returns the tab control used by the sheet. - -Args: - - - -Returns: - - Any - - """ - ... - - def OnInitDialog(self) -> Any: - """ - Calls the default MFC OnInitDialog handler. - -Args: - - - -Returns: - - Any - - """ - ... - - def PressButton(self, button: Any) -> None: - """ - Simulates the choice of the specified button in a property sheet. - -Args: - - button(Any):The button to press - -Returns: - - None - - """ - ... - - def RemovePage(self, offset: Any, page: Any) -> None: - """ - Removes the specified page from the sheet. - -Args: - - offset(Any):The page number to removeAlternative Parameters - page(Any):The page to remove - -Returns: - - None - - """ - ... - - def SetActivePage(self, page: Any) -> None: - """ - Programmatically sets the active page object. - -Args: - - page(Any):The page. - -Returns: - - None - - """ - ... - - def SetTitle(self, title: str) -> None: - """ - Sets the caption for the property sheet. - -Args: - - title(str):The new caption - -Returns: - - None - - """ - ... - - def SetFinishText(self, text: str) -> None: - """ - Sets the text for the Finish button - -Args: - - text(str):The next for the button - -Returns: - - None - - """ - ... - - def SetWizardMode(self) -> None: - """ - Enables the wizard mode - -Args: - - - -Returns: - - None - - """ - ... - - def SetWizardButtons(self, flags: Any) -> None: - """ - Enables the wizard buttons - -Args: - - flags(Any):The wizard flags - -Returns: - - None - - """ - ... - - def SetPSHBit(self, bitMask: Any, bitValue: Any) -> None: - """ - Sets or clears a bit in m_psh.dwFlags - -Args: - - bitMask(Any):The PSH_* bit mask constant - bitValue(Any):1 to set, 0 to clear - -Returns: - - None - - """ - ... - - -class PyCRect: - """A Python interface the the MFC CRect class.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCRgn: - """An object encapsulating an MFC PyCRgn class.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class PyCRichEditCtrl: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def Clear(self) -> Any: - """ - Clears all text in an edit control. - -Args: - - - -Returns: - - Any - - """ - ... - - def Copy(self) -> None: - """ - Copys the current selection to the clipboard. - -Args: - - - -Returns: - - None - - """ - ... - - def CreateWindow(self, style: Any, rect: tuple[Any, Any, Any, Any], parent: Any, _id: Any) -> None: - """ - Creates a rich edit control window. - -Args: - - style(Any):The control style - rect(tuple[Any, Any, Any, Any]):The position of the control - parent(Any):The parent window. Must not be None - _id(Any):The control ID - -Returns: - - None - - """ - ... - - def Cut(self) -> None: - """ - Cuts the current selection to the clipboard. - -Args: - - - -Returns: - - None - - """ - ... - - def FindText(self, charPos: Any) -> tuple[Any, Any, Any]: - """ - Finds text in the control - -Args: - - charPos(Any):The character position - -Returns: - - tuple[Any, Any, Any] - - """ - ... - - def GetCharPos(self, charPos: Any) -> Any: - """ - Returns the location of the top-left corner of the character specified - -by charPos. - -Args: - - charPos(Any):The character positionReturn ValueThe return value is a win32ui::CHARFORMAT tuple - -Returns: - - Any:The character positionReturn ValueThe return value is a win32ui::CHARFORMAT tuple - - - - """ - ... - - def GetDefaultCharFormat(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any:CRichEditCtrl::GetDefaultCharFormat -Return ValueThe return value is a win32ui::CHARFORMAT tuple - - - - """ - ... - - def GetEventMask(self) -> Any: - """ - Returns the current event mask. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetSelectionCharFormat(self) -> Any: - """ - Returns the character formatting of the selection. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetFirstVisibleLine(self) -> Any: - """ - Returns zero-based index of the topmost visible line. - -Args: - - - -Returns: - - Any:CRichEditCtrl::GetFirstVisibleLine -Return ValueThe zero-based index of the topmost visible line. For single-line edit controls, the return value is 0. - - - """ - ... - - def GetParaFormat(self) -> Any: - """ - Returns the current paragraph formatting attributes. - -Args: - - - -Returns: - - Any:CRichEditCtrl::GetParaFormat -Return ValueThe return value is a win32ui::PARAFORMAT tuple - - - - """ - ... - - def GetSel(self) -> tuple[Any, Any]: - """ - Returns the start and end of the current selection. - -Args: - - - -Returns: - - tuple[Any, Any]:CRichEditCtrl::GetSel -Return ValueThe return tuple is (the first character in the current selection, first nonselected character past the - -end of the current selection) - - - """ - ... - - def GetSelText(self) -> str: - """ - Returns the currently selected text - -Args: - - - -Returns: - - str - - """ - ... - - def GetTextLength(self) -> Any: - """ - Returns the length of the text in the control. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetLine(self, lineNo: Any) -> Any: - """ - Returns the text in a specified line. - -Args: - - lineNo(Any):Contains the zero-based index value for the desired line.CommentsThis function is not an MFC wrapper. - -Returns: - - Any - - """ - ... - - def GetModify(self) -> Any: - """ - Nonzero if the text in this control has been modified; otherwise 0. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetLineCount(self) -> Any: - """ - Gets the number of lines in an edit control. - -Args: - - - -Returns: - - Any:CRichEditCtrl::GetLineCount -Return ValueThe number of lines in the buffer. If the control is empty, the return value is 1. - - - """ - ... - - def LimitText(self, nChars: Any = 0) -> None: - """ - Sets max length of text that user can enter - -Args: - - nChars(Any):Specifies the length (in bytes) of the text that the user can enter. If this parameter is 0, the text length is set to UINT_MAX bytes. This is the default behavior.MFC References - -Returns: - - None - - """ - ... - - def LineFromChar(self, charNo: Any = -1) -> Any: - """ - Returns the line number of the specified character. - -Args: - - charNo(Any):Contains the zero-based index value for the desired character in the text of the edit control, or -1. If -1, then it specifies the current line.MFC References - -Returns: - - Any:CRichEditCtrl::LineFromChar -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 there is no selection, the current line number is returned. - - - """ - ... - - def LineIndex(self, lineNo: Any = -1) -> Any: - """ - Retrieves the character index of a line within a multiple-line edit control. - -Args: - - lineNo(Any):Contains the index value for the desired line in the text of the edit control, or contains -1. If -1, then it specifies the current line.CommentsThis method only works on multi-linr edit controls.MFC References - -Returns: - - Any:CRichEditCtrl::LineIndex -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 edit control. - - - """ - ... - - def LineScroll(self, nLines: Any, nChars: Any = 0) -> Any: - """ - Scroll the control vertically and horizontally - -Args: - - nLines(Any):Specifies the number of lines to scroll vertically. - nChars(Any):Specifies the number of character positions to scroll horizontally. This value is ignored if the edit control has either the ES_RIGHT or ES_CENTER style.CommentsThis method only works on multi-linr edit controls.MFC References - -Returns: - - Any - - """ - ... - - def Paste(self) -> None: - """ - Pastes the contents of the clipboard into the control. - -Args: - - - -Returns: - - None - - """ - ... - - def ReplaceSel(self, text: str) -> None: - """ - Replaces the selection with the specified text. - -Args: - - text(str):The text to replace the selection with.MFC References - -Returns: - - None - - """ - ... - - def SetBackgroundColor(self, bSysColor: Any, cr: Any = 0) -> Any: - """ - Sets the background color for the control. - -Args: - - bSysColor(Any):Indicates if the background color should be set to the system value. If this value is TRUE, cr is ignored. - cr(Any):The requested background color. Used only if bSysColor is FALSE.MFC References - -Returns: - - Any:CRichEditCtrl::SetEventMask -Return ValueThe return value is the previous background color. - - - """ - ... - - def SetDefaultCharFormat(self, charFormat: Any) -> None: - """ - None - -Args: - - charFormat(Any):A charformat tuple. See win32ui::CHARFORMAT tuple for details.MFC References - -Returns: - - None - - """ - ... - - def SetEventMask(self, eventMask: Any) -> Any: - """ - Sets the event motification mask. - -Args: - - eventMask(Any):The new event mask. Must be one of the win32con.ENM_* flags.MFC References - -Returns: - - Any:CRichEditCtrl::SetEventMask -Return ValueThe return value is the previous event mask. - - - """ - ... - - def SetSelectionCharFormat(self, charFormat: Any) -> None: - """ - Sets the current selections character formatting attributes. - -Args: - - charFormat(Any):A charformat tuple. See win32ui::CHARFORMAT tuple for details.MFC References - -Returns: - - None - - """ - ... - - def SetModify(self, modified: Any = 1) -> None: - """ - Sets the modified flag for this control - -Args: - - modified(Any):Indicates the new value for the modified flag.MFC References - -Returns: - - None - - """ - ... - - def SetOptions(self, op: Any, flags: Any) -> None: - """ - Sets options for the control. - -Args: - - op(Any):Indicates the operation. Must be one of the win32con.ECOOP_* flags. - flags(Any):Indicates the options. Must be one a combination of win32con.ECO_* flags.MFC References - -Returns: - - None - - """ - ... - - def SetParaFormat(self, paraFormat: Any) -> Any: - """ - Sets the paragraph formatting - -Args: - - paraFormat(Any):A charformat tuple. See win32ui::PARAFORMAT tuple for details.MFC References - -Returns: - - Any:CRichEditCtrl::SetParaFormat -Return ValueThis function seems to return occasionally return failure, but - -the formatting is applied. Therefore an exception is not raised on failure, - -but the BOOL return code is passed back. - - - """ - ... - - def SetReadOnly(self, bReadOnly: Any = 1) -> None: - """ - Sets or clears the read-only status of the listbox. - -Args: - - bReadOnly(Any):The read-only state to set.MFC References - -Returns: - - None - - """ - ... - - def SetSel(self, start: Any, end: Any, arg: Any) -> None: - """ - Sets the selection in the edit control. - -Args: - - start(Any):Specifies the starting position. If start is 0 and end is -1, all the text in the edit control is selected. If start is -1, any current selection is removed. - end(Any):Specifies the ending position.Alternative Parameters - arg(Any):As for normal start, end args.MFC References - -Returns: - - None - - """ - ... - - def SetSelAndCharFormat(self, charFormat: Any) -> None: - """ - Sets the selection and char format. - -Args: - - charFormat(Any):A charformat tuple. See win32ui::CHARFORMAT tuple for details.CommentsHighly optimised for speed for color editors.MFC References - -Returns: - - None - - """ - ... - - def SetTargetDevice(self, dc: Any, lineWidth: Any) -> None: - """ - Sets the target device for the control - -Args: - - dc(Any):The new DC - may be None - lineWidth(Any):Line width to use for formatting.MFC References - -Returns: - - None - - """ - ... - - def StreamIn(self, _format: Any, method: Any) -> tuple[Any, Any]: - """ - Invokes a callback to stream data into the control. - -Args: - - _format(Any):The format. One of the win32con.SF_* flags (SF_TEXT,SF_RTF) - method(Any):A callable object (eg, a method or function) This method is called with a single integer param, which is the maximum number of bytes to fetch. The method should return a zero length string, or None to finish the operation, and a string otherwise.MFC References - -Returns: - - tuple[Any, Any]:CRichEditCtrl::StreamIn -Return ValueThe return value is a tuple of (no bytes written, error code) - - - """ - ... - - def StreamOut(self, _format: Any, method: Any) -> tuple[Any, Any]: - """ - Invokes a callback to stream data into the control. - -Args: - - _format(Any):The format. One of the win32con.SF_* flags (SF_TEXT,SF_RTF) and may also combine SFF_SELECTION. - method(Any):A callable object (eg, a method or function) This method is called with a string parameter. It should return an integer, zero to abort, non zero otherwise.MFC References - -Returns: - - tuple[Any, Any]:CRichEditCtrl::StreamOut -Return ValueThe return value is a tuple of (no bytes written, error code) - - - """ - ... - - -class PyCRichEditDoc: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def OnCloseDocument(self) -> None: - """ - Call the MFC OnCloseDocument handler. - -This routine is provided so a document object which overrides this method - -can call the original MFC version if required. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyCRichEditDocTemplate: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def DoCreateRichEditDoc(self, fileName: str = None) -> Any: - """ - Creates an underlying document object. - -Args: - - fileName(str):The name of the file to load. - -Returns: - - Any - - """ - ... - - -class PyCRichEditView: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetRichEditCtrl(self) -> Any: - """ - Returns the underlying rich edit control object. - -Args: - - - -Returns: - - Any - - """ - ... - - def SetWordWrap(self, wordWrap: Any) -> Any: - """ - Sets the wordwrap state for the control. - -Args: - - wordWrap(Any):The new word-wrap state.MFC References - -Returns: - - Any - - """ - ... - - def WrapChanged(self) -> Any: - """ - Calls the underlying WrapChanged method. - -Args: - - - -Returns: - - Any - - """ - ... - - def SaveTextFile(self, FileName: Any) -> Any: - """ - Saves the contents of the control as a test file - -Args: - - FileName(Any):Name of file to saveCommentsTheere is no equivilent MFC method. This is implemented in this module for performance reasons. - -Returns: - - Any - - """ - ... - - -class PyCScrollView: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetDeviceScrollPosition(self) -> tuple[Any, Any]: - """ - Returns the positon of the scroll bars in device units. - -Args: - - - -Returns: - - tuple[Any, Any] - - """ - ... - - def GetDC(self) -> Any: - """ - Gets the view's current DC. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetScrollPosition(self) -> tuple[Any, Any]: - """ - Returns the current position of the scroll bars (in logical units). - -Args: - - - -Returns: - - tuple[Any, Any] - - """ - ... - - def GetTotalSize(self) -> tuple[Any, Any]: - """ - Returns the total size of the view in logical units. - -Args: - - - -Returns: - - tuple[Any, Any] - - """ - ... - - def OnCommand(self, wparam: Any, lparam: Any) -> None: - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(Any): - lparam(Any):See Also - -Returns: - - None - - """ - ... - - def ResizeParentToFit(self, bShrinkOnly: Any = 1) -> Any: - """ - Lets the size of a view dictate the size of its frame window. - -Args: - - bShrinkOnly(Any):The kind of resizing to perform. The default value, TRUE, shrinks the frame window if appropriate.CommentsThis is recommended only for views in MDI child frame windows. Use ResizeParentToFit in the OnInitialUpdate handler function of your View class. You must ensure the parent's PyCFrameWnd::RecalcLayout is called before using this method. - -Returns: - - Any - - """ - ... - - def SetScaleToFitSize(self, size: tuple[Any, Any]) -> None: - """ - Scales the viewport size to the current window size automatically. - -Args: - - size(tuple[Any, Any]):The horizontal and vertical sizes to which the view is to be scaled. The scroll view's size is measured in logical units. - -Returns: - - None - - """ - ... - - def ScrollToPosition(self, position: tuple[Any, Any]) -> None: - """ - Scrolls to a given point in the view. - -Args: - - position(tuple[Any, Any]):The position to scroll to. - -Returns: - - None - - """ - ... - - def SetScrollSizes( - self, - mapMode: Any, - sizeTotal: tuple[Any, Any], - arg: tuple[Any, Any], - arg1: tuple[Any, Any]) -> None: - """ - Sets the sizes of the scroll bars - -Args: - - mapMode(Any):The mapping mode for this view. - sizeTotal(tuple[Any, Any]):The total size of the view. Sizes are in logical units. Both x and y must be greater than zero. - arg(tuple[Any, Any]):The number of untils to scroll in response to a page-down command. - arg1(tuple[Any, Any]):The number of untils to scroll in response to a line-down command. - -Returns: - - None - - """ - ... - - def UpdateBars(self) -> None: - """ - Update the scroll bars state - -Args: - - - -Returns: - - None - - """ - ... - - -class PyCSliderCtrl: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CreateWindow(self, style: Any, rect: tuple[Any, Any, Any, Any], parent: Any, _id: Any) -> None: - """ - Creates the actual control. - -Args: - - style(Any):The style for the control. - rect(tuple[Any, Any, Any, Any]):The size and position of the control. - parent(Any):The parent window of the control. Usually a PyCDialog. - _id(Any):The control's ID. - -Returns: - - None - - """ - ... - - def GetLineSize(self) -> Any: - """ - Get the control's position - -Args: - - - -Returns: - - Any - - """ - ... - - def SetLineSize(self, nLineSize: Any = 1) -> Any: - """ - Set the control's line size. Returns the previous line size. - -Args: - - nLineSize(Any):New line size of the Slider bar control - -Returns: - - Any - - """ - ... - - def GetPageSize(self) -> Any: - """ - Get the control's position - -Args: - - - -Returns: - - Any - - """ - ... - - def SetPageSize(self, nPageSize: Any = 1) -> Any: - """ - Set the control's page size Returns the previous page size. - -Args: - - nPageSize(Any):New page size of the Slider bar control. - -Returns: - - Any - - """ - ... - - def GetRangeMax(self) -> Any: - """ - Get the control's Maximum - -Args: - - - -Returns: - - Any - - """ - ... - - def GetRangeMin(self) -> Any: - """ - Get the control's Minimum - -Args: - - - -Returns: - - Any - - """ - ... - - def GetRange(self) -> Any: - """ - Get the control's min and max - -Args: - - - -Returns: - - Any - - """ - ... - - def SetRange(self, nRangeMin: Any = 1, nRangeMax: Any = 1, bRedraw: Any = 1) -> Any: - """ - Set the control's min and max - -Args: - - nRangeMin(Any):New minimum of the Slider bar control. - nRangeMax(Any):New maximum of the Slider bar control. - bRedraw(Any):Should slider be redrawn? - -Returns: - - Any - - """ - ... - - def GetSelection(self) -> Any: - """ - Get the control's selection start and end positions - -Args: - - - -Returns: - - Any - - """ - ... - - def SetSelection(self, nRangeMin: Any = 1, nRangeMax: Any = 1) -> Any: - """ - Set the control's selection start and end positions - -Args: - - nRangeMin(Any):New start of the Slider's selection. - nRangeMax(Any):New end of the Slider's selection. - -Returns: - - Any - - """ - ... - - def GetChannelRect(self) -> Any: - """ - Get the control's channel rectangle - -Args: - - - -Returns: - - Any - - """ - ... - - def GetThumbRect(self) -> Any: - """ - Get the control's thumb rectangle - -Args: - - - -Returns: - - Any - - """ - ... - - def GetPos(self) -> Any: - """ - Get the control's position - -Args: - - - -Returns: - - Any - - """ - ... - - def SetPos(self, nPos: Any = 1) -> Any: - """ - Set the control's position - -Args: - - nPos(Any):New position of the Slider bar control. - -Returns: - - Any - - """ - ... - - def GetNumTics(self) -> Any: - """ - Get number of tics in the slider - -Args: - - - -Returns: - - Any - - """ - ... - - def GetTicArray(self) -> Any: - """ - Get a tuple of slider tic positions - -Args: - - - -Returns: - - Any - - """ - ... - - def GetTic(self, nTic: Any = 1) -> Any: - """ - Get the position of the specified tic number - -Args: - - nTic(Any):Zero based index of the tic mark - -Returns: - - Any - - """ - ... - - def GetTicPos(self, nTic: Any = 1) -> Any: - """ - Get the position of the specified tic number in client coordinates - -Args: - - nTic(Any):Zero based index of the tic mark - -Returns: - - Any - - """ - ... - - def SetTic(self, nTic: Any = 1) -> Any: - """ - Set a tic at the specified position - -Args: - - nTic(Any):Position of the desired tic mark - -Returns: - - Any - - """ - ... - - def SetTicFreq(self, nFreq: Any = 1) -> Any: - """ - Set the tic frequency - -Args: - - nFreq(Any):Frequency of tic marks - -Returns: - - Any - - """ - ... - - def ClearSel(self, bRedraw: Any = 1) -> Any: - """ - Clear the selection - -Args: - - bRedraw(Any):Redraw the control? - -Returns: - - Any - - """ - ... - - def VerifyPos(self) -> Any: - """ - Verify the position is between configured min and max - -Args: - - - -Returns: - - Any - - """ - ... - - def ClearTics(self, bRedraw: Any = 1) -> Any: - """ - Clear the control's tic marks - -Args: - - bRedraw(Any):Redraw the control? - -Returns: - - Any - - """ - ... - - -class PyCSpinButtonCtrl: - """A windows spin button control. Encapsulates an MFC CSpinButtonCtrl object.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetPos(self) -> Any: - """ - Obtains the current position for a spin button control. - -Args: - - - -Returns: - - Any - - """ - ... - - def SetPos(self, pos: Any) -> Any: - """ - Sets the current position for a spin button control. - -Args: - - pos(Any):The new position.Return ValueThe result is the previous position. - -Returns: - - Any:The new position.Return ValueThe result is the previous position. - - - """ - ... - - def SetRange(self) -> Any: - """ - Sets the upper and lower limits (range) for a spin button control. - -Args: - - - -Returns: - - Any - - """ - ... - - def SetRange32(self) -> Any: - """ - Sets the 32 bit upper and lower limits (range) for a spin button control. - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyCSplitterWnd: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetPane(self, row: Any, col: Any) -> Any: - """ - None - -Args: - - row(Any):The row in the splitter. - col(Any):The column in the splitter.CommentsTheoretically the return value can be a PyCWnd object, but currently it will always be a PyCView or derived object. - -Returns: - - Any - - """ - ... - - def CreateView(self, view: Any, row: Any, col: Any, arg: tuple[Any, Any]) -> None: - """ - Creates a view in a splitter window - -Args: - - view(Any):The view to place in the splitter pane. - row(Any):The row in the splitter to place the view. - col(Any):The column in the splitter to place the view. - arg(tuple[Any, Any]):The initial size of the new view.MFC References - -Returns: - - None - - """ - ... - - def CreateStatic(self, parent: Any, rows: Any, cols: Any, style: Any, _id: Any) -> None: - """ - Creates a static splitter window. - -Args: - - parent(Any):The parent window. - rows(Any):The number of rows in the splitter. - cols(Any):The number of columns in the splitter. - style(Any):Specifies the window style - _id(Any):The child window ID of the window. The ID can be AFX_IDW_PANE_FIRST unless the splitter window is nested inside another splitter window.CommentsA static splitter window is a splitter where the number of panes are fixed at window creation time. Currently this is the only splitter window supported by win32ui.MFC References - -Returns: - - None - - """ - ... - - def SetColumnInfo(self, column: Any, ideal: Any, _min: Any) -> None: - """ - Sets a new minimum height and ideal height for a column - -Args: - - column(Any):The column in the splitter. - ideal(Any):Specifies an ideal height for the splitter window column in pixels. - _min(Any):Specifies a minimum height for the splitter window column in pixels. - -Returns: - - None - - """ - ... - - def SetRowInfo(self, row: Any, ideal: Any, _min: Any) -> None: - """ - Sets a new minimum height and ideal height for a row. - -Args: - - row(Any):The row in the splitter. - ideal(Any):Specifies an ideal height for the splitter window row in pixels. - _min(Any):Specifies a minimum height for the splitter window row in pixels. - -Returns: - - None - - """ - ... - - def IdFromRowCol(self, row: Any, col: Any) -> None: - """ - Gets the child window ID for the specified child. - -Args: - - row(Any):The row in the splitter. - col(Any):The col in the splitter - -Returns: - - None - - """ - ... - - def DoKeyboardSplit(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyCStatusBar: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetPaneInfo(self, index: Any) -> tuple[Any, Any, Any]: - """ - Returns the id, style, and width of the indicator pane at the - -location specified by index. - -Args: - - index(Any):Index of the pane whose information is to be retrieved.MFC References - -Returns: - - tuple[Any, Any, Any] - - """ - ... - - def GetStatusBarCtrl(self) -> Any: - """ - Gets the statusbar control object for the statusbar. - -Args: - - - -Returns: - - Any - - """ - ... - - def SetIndicators(self, indicators: Any) -> None: - """ - Sets each indicator's ID. - -Args: - - indicators(Any):A tuple containing the ID's of the indicators. - -Returns: - - None - - """ - ... - - def SetPaneInfo(self, index: Any, _id: Any, style: Any, width: Any) -> None: - """ - Sets the specified indicator pane to a new ID, style, and width. - -Args: - - index(Any):Index of the indicator pane whose style is to be set. - _id(Any):New ID for the indicator pane. - style(Any):New style for the indicator pane.The following indicator styles are supported:afxres.SBPS_NOBORDERS - No 3-D border around the pane.afxres.SBPS_POPOUT - Reverse border so that text "pops out."afxres.SBPS_DISABLED - Do not draw text.afxres.SBPS_STRETCH - Stretch pane to fill unused space. Only one pane per status bar can have this style.afxres.SBPS_NORMAL - No stretch, borders, or pop-out. - width(Any):New width for the indicator pane.MFC References - -Returns: - - None - - """ - ... - - -class PyCStatusBarCtrl: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CreateWindow(self, style: Any, rect: tuple[Any, Any, Any, Any], parent: Any, _id: Any) -> None: - """ - Creates the actual control. - -Args: - - style(Any):The style for the control. - rect(tuple[Any, Any, Any, Any]):The size and position of the control. - parent(Any):The parent window of the control. Usually a PyCDialog. - _id(Any):The control's ID. - -Returns: - - None - - """ - ... - - def GetBorders(self) -> tuple[Any, Any, Any]: - """ - Retrieve the status bar control's current widths of - -the horizontal and vertical borders and of the space between rectangles. - -Args: - - - -Returns: - - tuple[Any, Any, Any] - - """ - ... - - def GetParts(self, nParts: Any) -> Any: - """ - Retrieve coordinates of the parts in a status bar control. - -Args: - - nParts(Any):The number of coordinates to retrieveCommentsThis function, as designed in MFC, returns both the *number* of parts, and, through an OUT parameter, an array of ints giving the coordinates of the parts. There is also an IN parameter saying how many coordinates to give back. Here, we're explicitly changing the semantics a bit.GetParts() -> tuple of all coordinates GetParts(n) -> tuple of the first n coordinates (or all coordinates, if fewer than n)So, in Python, you can't simultaneously find out how many coordinates there are, and retrieve a subset of them. In a reasonable universe, there would have been GetParts() -> int, and GetCoords() -> list. This means that I need to call the MFC method twice; once to find out how many there are, and another time to get them. - -Returns: - - Any - - """ - ... - - def GetRect(self, nPane: Any) -> tuple[Any, Any, Any, Any]: - """ - Retrieves the bounding rectangle of a part in a status - -bar control. - -Args: - - nPane(Any):Zero-based index of the part whose bounding rectangle is to be retrieved. - -Returns: - - tuple[Any, Any, Any, Any] - - """ - ... - - def GetText(self, nPane: Any) -> Any: - """ - Retrieve the text from the given part of a status bar control. - -Args: - - nPane(Any):Zero-based index of the part whose text is to be retrieved. - -Returns: - - Any - - """ - ... - - def GetTextAttr(self, nPane: Any) -> Any: - """ - Retrieve the attributes of the text in the given part of a status bar - -control. - -Args: - - nPane(Any):Zero-based index of the part whose text is to be retrieved. - -Returns: - - Any - - """ - ... - - def GetTextLength(self, nPane: Any) -> Any: - """ - Retrieve the length the text in the given part of a status bar control. - -Args: - - nPane(Any):Zero-based index of the part whose text is to be retrieved. - -Returns: - - Any - - """ - ... - - def SetMinHeight(self, nHeight: Any) -> None: - """ - Set the minimum height of a status bar control's drawing area. - -Args: - - nHeight(Any):Minimum height - -Returns: - - None - - """ - ... - - def SetParts(self, coord: Any) -> None: - """ - Sets the number of parts in a status bar control and the coordinate of the right - -edge of each part. - -Args: - - coord(Any):Coordinates of each part - -Returns: - - None - - """ - ... - - def SetText(self, text: str, nPane: Any, nType: Any) -> None: - """ - Set the text in the given part of a status bar control. - -Args: - - text(str):The text to display - nPane(Any):Zero-based index of the part to set. - nType(Any):Type of drawing operation.CommentsThe drawing type can be set to one of:~ 0 - The text is drawn with a border to appear lower than the plane of the status bar.~ win32con.SBT_NOBORDERS - The text is drawn without borders.~ win32con.SBT_OWNERDRAW - The text is drawn by the parent window.~ win32con.SBT_POPOUT - The text is drawn with a border to appear higher than the plane of the status bar. - -Returns: - - None - - """ - ... - - def SetTipText(self, nPane: Any, text: str) -> None: - """ - 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. - -Args: - - nPane(Any):The zero-based index of status bar pane to receive the tooltip text. - text(str):The string containing the tooltip text.CommentsPay attention, this tooltip text is ONLY displayed in two situations: 1. When the corresponding pane in the status bar contains only an icon. 2. When the corresponding pane in the status bar contains text that is truncated due to the size of the pane. To make the tooltip appear even if the text is not truncated, you could add additional spaces to the end of the pane text.MFC References - -Returns: - - None - - """ - ... - - -class PyCTabCtrl: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetCurSel(self) -> Any: - """ - Gets the current selection of a tab control. - -Args: - - - -Returns: - - Any:PyCTabCtrl.GetCurSel - -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. - - - """ - ... - - def GetItemCountl(self) -> Any: - """ - Returns the number of tabs in the control. - -Args: - - - -Returns: - - Any - - """ - ... - - def SetCurSel(self, index: Any) -> Any: - """ - Sets the current selection of a tab control. - -Args: - - index(Any):The index of the tab to set current.Return ValueThe zero-based index of the previously selected item. - -Returns: - - Any:The index of the tab to set current.Return ValueThe zero-based index of the previously selected item. - - - """ - ... - - -class PyCToolBar: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetButtonStyle(self, index: Any) -> None: - """ - Retrieves the style for a button. - -Args: - - index(Any):Index of the item whose style is to be retrieved. - -Returns: - - None - - """ - ... - - def GetButtonText(self, index: Any) -> str: - """ - Gets the text for a button. - -Args: - - index(Any):Index of the item whose text is to be retrieved. - -Returns: - - str - - """ - ... - - def GetItemID(self, index: Any) -> None: - """ - Returns the command ID of a button or separator at the given index. - -Args: - - index(Any):Index of the item whose ID is to be retrieved. - -Returns: - - None - - """ - ... - - def SetButtonInfo(self, index: Any, ID: Any, style: Any, imageIx: Any) -> None: - """ - Sets the button's command ID, style, and image number. - -Args: - - index(Any):Index of the button or separator whose information is to be set. - ID(Any):The value to which the button's command ID is set. - style(Any):The new button style - imageIx(Any):New index for the button's image within the bitmap - -Returns: - - None - - """ - ... - - def GetToolBarCtrl(self) -> Any: - """ - Gets the toolbar control object for the toolbar - -Args: - - - -Returns: - - Any - - """ - ... - - def LoadBitmap(self, _id: PyResourceId) -> None: - """ - Loads the bitmap containing bitmap-button images. - -Args: - - _id(PyResourceId):Name or id of the resource that contains the bitmap.CommentsThe bitmap should contain one image for each toolbar button. If the images are not of the standard size (16 pixels wide and 15 pixels high), call PyCToolBar::SetSizes to set the button sizes and their images. - -Returns: - - None - - """ - ... - - def LoadToolBar(self, _id: PyResourceId) -> None: - """ - Loads a toolbar from a toolbar resource. - -Args: - - _id(PyResourceId):Name or resource id of the resourceCommentsThe bitmap should contain one image for each toolbar button. If the images are not of the standard size (16 pixels wide and 15 pixels high), call PyCToolBar::SetSizes to set the button sizes and their images. - -Returns: - - None - - """ - ... - - def SetBarStyle(self, style: Any) -> None: - """ - Sets the toolbar part of style - -Args: - - style(Any):The toolbar style to set. - -Returns: - - None - - """ - ... - - def SetBitmap(self, hBitmap: Any) -> None: - """ - Sets a bitmapped image. - -Args: - - hBitmap(Any):The handle to a bitmap resource.CommentsCall this method to set the bitmap image for the toolbar. For example, call SetBitmap to change the bitmapped image after the user takes an action on a document that changes the action of a button. - -Returns: - - None - - """ - ... - - def SetButtons(self, buttons: Any, numButtons: Any) -> None: - """ - Sets button styles and an index of button images within the bitmap. - -Args: - - buttons(Any):A tuple containing the ID's of the buttons.Alternative Parameters - numButtons(Any):The number of buttons to pre-allocate. If this option is used, then PyCToolBar::PySetButtonInfo must be used. - -Returns: - - None - - """ - ... - - def SetButtonStyle(self, index: Any, style: Any) -> None: - """ - Sets the style for a button. - -Args: - - index(Any):Index of the item whose style is to be set - style(Any):The new style - -Returns: - - None - - """ - ... - - def SetHeight(self, height: Any) -> None: - """ - Sets the height of the toolbar. - -Args: - - height(Any):The height in pixels of the toolbar. - -Returns: - - None - - """ - ... - - def SetSizes(self, sizeButton: tuple[Any, Any], sizeButton1: tuple[Any, Any]) -> None: - """ - Sets the size of each button. - -Args: - - sizeButton(tuple[Any, Any]):The size of each button. - sizeButton1(tuple[Any, Any]):The size of each bitmap. - -Returns: - - None - - """ - ... - - -class PyCToolBarCtrl: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def AddBitmap(self, numButtons: Any, bitmap: Any) -> Any: - """ - Add one or more button images to the list of button images - -Args: - - numButtons(Any):Number of button images in the bitmap. - bitmap(Any):Bitmap containing button or buttons to be addedMFC References - -Returns: - - Any - - """ - ... - - def AddButtons(self) -> Any: - """ - Add one or more buttons to the toolbar - -Args: - - - -Returns: - - Any - - """ - ... - - def AddStrings(self, strings: Any) -> Any: - """ - Add one or more strings to the toolbar - -Args: - - strings(Any):Strings to add. Can give more than one string. - -Returns: - - Any - - """ - ... - - def AutoSize(self) -> None: - """ - Resize the entire toolbar control - -Args: - - - -Returns: - - None - - """ - ... - - def CheckButton(self, nID: Any, bCheck: Any = 1) -> Any: - """ - Check or clear a given button in a toolbar control - -Args: - - nID(Any):Command identifier of the button to check or clear. - bCheck(Any):1 to check, 0 to clear the buttonMFC References - -Returns: - - Any - - """ - ... - - def CommandToIndex(self, nID: Any) -> Any: - """ - Retrieve the zero-based index for the button associated with the - -specified command identifier. - -Args: - - nID(Any):Command identifier of the button you want to find.MFC References - -Returns: - - Any - - """ - ... - - def CreateWindow(self, style: Any, rect: tuple[Any, Any, Any, Any], parent: Any, _id: Any) -> None: - """ - Creates the window for a new toolbar object - -Args: - - style(Any):The style for the button. Use any of the win32con.BS_* constants. - rect(tuple[Any, Any, Any, Any]):The size and position of the button. - parent(Any):The parent window of the button. Usually a PyCDialog. - _id(Any):The buttons control ID.MFC References - -Returns: - - None - - """ - ... - - def Customize(self) -> None: - """ - Display the Customize Toolbar dialog box. - -Args: - - - -Returns: - - None - - """ - ... - - def DeleteButton(self, nID: Any) -> None: - """ - Delete a button from the toolbar control. - -Args: - - nID(Any):ID of the button to delete.MFC References - -Returns: - - None - - """ - ... - - def EnableButton(self, nID: Any, bEnable: Any = 1) -> None: - """ - Enable or disable a toolbar control button. - -Args: - - nID(Any):ID of the button to enable or disable. - bEnable(Any):1 to enable, 0 to disableMFC References - -Returns: - - None - - """ - ... - - def GetBitmapFlags(self) -> Any: - """ - retrieve the bitmap flags from the toolbar. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetButton(self, nID: Any) -> Any: - """ - Retrieve information about the specified button in a - -toolbar control. - -Args: - - nID(Any):ID of the button to retrieve.MFC References - -Returns: - - Any - - """ - ... - - def GetButtonCount(self) -> Any: - """ - Retrieve a count of the buttons currently in the toolbar control. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetItemRect(self, nID: Any) -> tuple[Any, Any, Any, Any]: - """ - Retrieve the bounding rectangle of a button in a - -toolbar control. - -Args: - - nID(Any):ID of the button.MFC References - -Returns: - - tuple[Any, Any, Any, Any] - - """ - ... - - def GetRows(self) -> tuple[Any, Any, Any, Any]: - """ - Retrieve the number of rows of buttons currently displayed - -Args: - - - -Returns: - - tuple[Any, Any, Any, Any] - - """ - ... - - def HideButton(self, nID: Any, bEnable: Any = 1) -> None: - """ - Hide or show the specified button in a toolbar control. - -Args: - - nID(Any):ID of the button to hide. - bEnable(Any):1 to hide, 0 to show.MFC References - -Returns: - - None - - """ - ... - - def Indeterminate(self, nID: Any, bEnable: Any = 1) -> None: - """ - Mark or unmark the specified button as indeterminate - -Args: - - nID(Any):ID of the button to mark. - bEnable(Any):1 to hide, 0 to show.MFC References - -Returns: - - None - - """ - ... - - def InsertButton(self, nID: Any, button: Any) -> Any: - """ - Insert a button in a toolbar control. - -Args: - - nID(Any):Zero-based index of a button. This function inserts the new button to the left of this button. - button(Any):Bitmap containing button to be insertedCommentsThe image and/or string whose index you provide must have previously been added to the toolbar control's list using PyCToolBarCtrl::AddBitmap, PyCToolBarCtrl::AddString, and/or PyCToolBarCtrl::AddStrings.MFC References - -Returns: - - Any - - """ - ... - - def IsButtonChecked(self, nID: Any) -> Any: - """ - Determine whether the specified button in a toolbar control is checked. - -Args: - - nID(Any):ID of the button to check.MFC References - -Returns: - - Any - - """ - ... - - def IsButtonEnabled(self, nID: Any) -> Any: - """ - Determine whether the specified button in a toolbar control is enabled. - -Args: - - nID(Any):ID of the button to check.MFC References - -Returns: - - Any - - """ - ... - - def IsButtonHidden(self, nID: Any) -> Any: - """ - Determine whether the specified button in a toolbar control is hidden. - -Args: - - nID(Any):ID of the button to check.MFC References - -Returns: - - Any - - """ - ... - - def IsButtonIndeterminate(self, nID: Any) -> Any: - """ - Determine whether the specified button in a toolbar control is - -indeterminate. - -Args: - - nID(Any):ID of the button to check.MFC References - -Returns: - - Any - - """ - ... - - def IsButtonPressed(self, nID: Any) -> Any: - """ - Determine whether the specified button in a toolbar control is pressed. - -Args: - - nID(Any):ID of the button to check.MFC References - -Returns: - - Any - - """ - ... - - def PressButton(self, nID: Any, bEnable: Any = 1) -> None: - """ - Mark or unmark the specified button as pressed. - -Args: - - nID(Any):ID of the button to mark. - bEnable(Any):1 to mark, 0 to unmark.MFC References - -Returns: - - None - - """ - ... - - def SetBitmapSize(self, width1: Any, height1: Any, width: Any = 16, height: Any = 15) -> None: - """ - Set the size of the actual bitmapped images to be added to a toolbar control. - -Args: - - width1(Any):Width of bitmap images. - height1(Any):Height of bitmap images.MFC References - width(Any):Width of bitmap images. - height(Any):Height of bitmap images.Alternative Parameters - -Returns: - - None - - """ - ... - - def SetButtonSize(self, width1: Any, height1: Any, width: Any = 16, height: Any = 15) -> None: - """ - Set the size of the buttons to be added to a toolbar control. - -Args: - - width1(Any):Width of bitmap images. - height1(Any):Height of bitmap images.MFC References - width(Any):Width of buttons - height(Any):Height of buttonsAlternative Parameters - -Returns: - - None - - """ - ... - - def SetCmdID(self, nIndex: Any, nID: Any) -> None: - """ - Set the command identifier which will be sent to the owner window when the - -specified button is pressed. - -Args: - - nIndex(Any):The zero-based index of the button whose command ID is to be set. - nID(Any):The command ID to set the selected button to.MFC References - -Returns: - - None - - """ - ... - - def SetRows(self, nRows: Any, bLarger: Any) -> tuple[Any, Any, Any, Any]: - """ - Ask the toolbar control to resize itself to the requested - -number of rows. - -Args: - - nRows(Any):Requested number of rows. - bLarger(Any):Tells whether to use more rows or fewer rows if the toolbar cannot be resized to the requested number of rows.MFC References - -Returns: - - tuple[Any, Any, Any, Any] - - """ - ... - - -class PyCToolTipCtrl: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CreateWindow(self, parent: Any, style: Any) -> None: - """ - Creates the actual control. - -Args: - - parent(Any):The parent window of the control. - style(Any):The style for the control. - -Returns: - - None - - """ - ... - - def UpdateTipText(self, text: str, wnd: Any, _id: Any) -> None: - """ - Update the tool tip text for a control's tools - -Args: - - text(str):The text for the tool. - wnd(Any):The window of the tool. - _id(Any):The id of the tool - -Returns: - - None - - """ - ... - - def AddTool(self, wnd: Any, text: str, _id: Any, rect: tuple[Any, Any, Any, Any] = None) -> None: - """ - Adds a tool to tooltip control. - -Args: - - wnd(Any):The window of the tool. - text(str):The text for the tool. - _id(Any):The id of the tool - rect(tuple[Any, Any, Any, Any]):The default rectangle - -Returns: - - None - - """ - ... - - def SetMaxTipWidth(self, width: Any) -> Any: - """ - None - -Args: - - width(Any):The new width - -Returns: - - Any - - """ - ... - - -class PyCTreeCtrl: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CreateWindow(self, style: Any, rect: tuple[Any, Any, Any, Any], PyCWnd: Any, _id: Any) -> None: - """ - Creates the actual window for the object. - -Args: - - style(Any):The window style - rect(tuple[Any, Any, Any, Any]):The default rectangle - PyCWnd(Any):The parent window - _id(Any):The control IDMFC References - -Returns: - - None - - """ - ... - - def GetCount(self) -> Any: - """ - Retrieves the number of tree items associated with a tree view control. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetIndent(self) -> Any: - """ - Retrieves the offset (in pixels) of a tree view item from its parent. - -Args: - - - -Returns: - - Any - - """ - ... - - def SetIndent(self, indent: Any) -> None: - """ - Sets the offset (in pixels) of a tree view item from its parent. - -Args: - - indent(Any):The new indent. - -Returns: - - None - - """ - ... - - def GetImageList(self, nImageList: Any) -> Any: - """ - Retrieves the current image list. - -Args: - - nImageList(Any):Value specifying which image list to retrieve. It can be one of: - commctrl.LVSIL_NORMAL Image list with large icons. - commctrl.LVSIL_SMALL Image list with small icons. - commctrl.LVSIL_STATE Image list with state images. - -Returns: - - Any - - """ - ... - - def SetImageList(self, imageList: Any, imageType: Any) -> Any: - """ - Assigns an image list to a list view control. - -Args: - - imageList(Any):The Image list to use. - imageType(Any):Type of image list. It can be one of (COMMCTRL.) LVSIL_NORMAL, LVSIL_SMALL or LVSIL_STATE - -Returns: - - Any - - """ - ... - - def GetNextItem(self, item: Any, code: Any) -> Any: - """ - Retrieves the next item. - -Args: - - item(Any):The specified item - code(Any):Specifies the relationship of the item to fetch. - -Returns: - - Any - - """ - ... - - def ItemHasChildren(self, item: Any) -> Any: - """ - Returns nonzero if the specified item has child items. - -Args: - - item(Any):The specified item - -Returns: - - Any - - """ - ... - - def GetChildItem(self, item: Any) -> Any: - """ - Retrieves the first child item. - -Args: - - item(Any):The specified item - -Returns: - - Any - - """ - ... - - def GetNextSiblingItem(self, item: Any) -> Any: - """ - Retrieves the next sibling of the specified tree view item. - -Args: - - item(Any):The specified item - -Returns: - - Any - - """ - ... - - def GetPrevSiblingItem(self, item: Any) -> Any: - """ - Retrieves the previous sibling of the specified tree view item. - -Args: - - item(Any):The specified item - -Returns: - - Any - - """ - ... - - def GetParentItem(self, item: Any) -> Any: - """ - Retrieves the parent item of the specified tree view item. - -Args: - - item(Any):The specified item - -Returns: - - Any - - """ - ... - - def GetFirstVisibleItem(self) -> Any: - """ - Retrieves the first visible item of the tree view control. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetNextVisibleItem(self, item: Any) -> Any: - """ - Retrieves the next visible item of the specified tree view item. - -Args: - - item(Any):The specified item - -Returns: - - Any - - """ - ... - - def GetSelectedItem(self) -> Any: - """ - Retrieves the currently selected tree view item. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetDropHilightItem(self) -> Any: - """ - Retrieves the target of a drag-and-drop operation. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetRootItem(self) -> Any: - """ - Retrieves the root of the specified tree view item. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetToolTips(self) -> Any: - """ - Returns the tooltip control - -Args: - - - -Returns: - - Any - - """ - ... - - def GetItem(self, item: Any, arg: Any) -> Any: - """ - Retrieves the details of an items attributes. - -Args: - - item(Any):The item whose attributes are to be retrieved. - arg(Any):The requested attributes. - -Returns: - - Any - - """ - ... - - def SetItem(self, item: Any) -> Any: - """ - Sets some of all of an items attributes. - -Args: - - item(Any):A tuple describing the new item. - -Returns: - - Any - - """ - ... - - def GetItemState(self, item: Any, stateMask: Any) -> tuple[Any, Any]: - """ - Retrieves the state and mask of an item. - -Args: - - item(Any):The specified item - stateMask(Any):The mask for the result. - -Returns: - - tuple[Any, Any] - - """ - ... - - def SetItemState(self, item: Any, state: Any, stateMask: Any) -> None: - """ - Sets the state of item. - -Args: - - item(Any):The specified item - state(Any):The new state - stateMask(Any):The mask for the new state - -Returns: - - None - - """ - ... - - def GetItemImage(self, item: Any) -> tuple[Any, Any]: - """ - Retrieves the index of an items images. - -Args: - - item(Any):The specified item - -Returns: - - tuple[Any, Any] - - """ - ... - - def SetItemImage(self, item: Any, iImage: Any, iSelectedImage: Any) -> None: - """ - Sets the index of an items images. - -Args: - - item(Any):The specified item - iImage(Any):The offset of the image. - iSelectedImage(Any):The offset of the selected image. - -Returns: - - None - - """ - ... - - def SetItemText(self, item: Any, text: str) -> Any: - """ - Changes the text of a list view item or subitem. - -Args: - - item(Any):The item whose text is to be retrieved. - text(str):String that contains the new item text. - -Returns: - - Any - - """ - ... - - def GetItemText(self, item: Any) -> Any: - """ - Retrieves the text of a list view item or subitem. - -Args: - - item(Any):The item whose text is to be retrieved. - -Returns: - - Any - - """ - ... - - def GetItemData(self, item: Any) -> Any: - """ - Retrieves the application-specific value associated with an item. - -Args: - - item(Any):The index of the item whose data is to be retrieved. - -Returns: - - Any - - """ - ... - - def SetItemData(self, item: Any, Data: Any) -> Any: - """ - Sets the item's application-specific value. - -Args: - - item(Any):The item whose Data is to be set. - Data(Any):New value for the data.CommentsNote that a reference count is not added to the object. This it is your responsibility to make sure the object remains alive while in the list. - -Returns: - - Any - - """ - ... - - def GetItemRect(self, item: Any, bTextOnly: Any) -> tuple[Any, Any, Any, Any]: - """ - Retrieves the bounding rectangle of a tree view item. - -Args: - - item(Any):The item whose Data is to be set. - bTextOnly(Any):f this parameter is nonzero, the bounding rectangle includes only the text of the item. Otherwise it includes the entire line that the item occupies in the tree view control. - -Returns: - - tuple[Any, Any, Any, Any] - - """ - ... - - def GetEditControl(self) -> Any: - """ - Retrieves the handle of the edit control used to edit the specified - -tree view item. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetVisibleCount(self) -> Any: - """ - Retrieves the number of visible tree items associated with a tree view - -control. - -Args: - - - -Returns: - - Any - - """ - ... - - def InsertItem( - self, - hParent: Any, - hInsertAfter: Any, - item: Any, - mask: Any, - text: Any, - image: Any, - selectedImage: Any, - state: Any, - stateMask: Any, - lParam: Any, - parent: Any, - parent1: Any, - text1: Any, - image1: Any, - selectedImage1: Any, - parent2: Any, - insertAfter: Any, - text2: Any, - parent3: Any, - parent4: Any) -> Any: - """ - Inserts an item into the list. - -Args: - - hParent(Any):The parent item. If commctrl.TVI_ROOT or 0, it is added to the root. - hInsertAfter(Any):The item to insert after. Can be an item or TVI_FIRST, TVI_LAST or TVI_SORT - item(Any):A tuple describing the new item.Alternative Parameters - mask(Any):Integer specifying which attributes to set - text(Any):The text of the item. - image(Any):The index of the image to use. - selectedImage(Any):The index of the items selected image. - state(Any):The initial state of the item. - stateMask(Any):Specifies which bits of the state are valid. - lParam(Any):A user defined object for the item. - parent(Any):The parent of the item. - parent1(Any):The parent of the item.Alternative Parameters - text1(Any):The text for the item. - image1(Any):The index of the image to use. - selectedImage1(Any):The index of the items selected image. - parent2(Any):The parent of the item. - insertAfter(Any):The item to insert the new item after, or TVI_FIRST, TVI_LAST or TVI_SORTAlternative Parameters - text2(Any):The text for the item. - parent3(Any):The parent of the item. - parent4(Any):The parent of the item. - -Returns: - - Any - - """ - ... - - def DeleteItem(self, item: Any) -> None: - """ - Deletes the specified item. - -Args: - - item(Any):The specified item - -Returns: - - None - - """ - ... - - def DeleteAllItems(self) -> Any: - """ - Deletes all items in the control - -Args: - - - -Returns: - - Any - - """ - ... - - def Expand(self, item: Any, code: Any) -> None: - """ - Expands, or collapses, the child items of the specified tree view item. - -Args: - - item(Any):The specified item - code(Any):The action to take - -Returns: - - None - - """ - ... - - def Select(self, item: Any, code: Any) -> None: - """ - Selects, scrolls into view, or redraws a specified tree view item. - -Args: - - item(Any):The specified item - code(Any):The action to take - -Returns: - - None - - """ - ... - - def SelectItem(self, item: Any) -> None: - """ - Selects a specified tree view item. - -Args: - - item(Any):The specified item - -Returns: - - None - - """ - ... - - def SelectDropTarget(self, item: Any) -> None: - """ - Redraws the tree item as the target of a drag-and-drop operation. - -Args: - - item(Any):The specified item - -Returns: - - None - - """ - ... - - def SelectSetFirstVisible(self, item: Any) -> None: - """ - Selects a specified tree view item as the first visible item. - -Args: - - item(Any):The specified item - -Returns: - - None - - """ - ... - - def EditLabel(self, item: Any) -> Any: - """ - Edits a specified tree view item in-place. - -Args: - - item(Any):The item to edit. - -Returns: - - Any - - """ - ... - - def CreateDragImage(self, item: Any) -> Any: - """ - Creates a dragging bitmap for the specified tree view item. - -Args: - - item(Any):The item to edit. - -Returns: - - Any - - """ - ... - - def SortChildren(self, item: Any) -> None: - """ - Sorts the children of a given parent item. - -Args: - - item(Any):The specified parent item - -Returns: - - None - - """ - ... - - def EnsureVisible(self, item: Any) -> Any: - """ - Ensures that a tree view item is visible in its tree view control. - -Args: - - item(Any):The item to edit. - -Returns: - - Any - - """ - ... - - def HitTest(self, arg: Any) -> tuple[Any, Any]: - """ - Determines which tree view item, if any, is at a specified position. - -Args: - - arg(Any):The point to test.Return ValueThe result is a tuple of (flags, hItem). flags may be a combination of the following values:ValueDescriptioncommctrl.TVHT_ABOVEAbove the client area.commctrl.TVHT_BELOWBelow the client area.commctrl.TVHT_NOWHEREIn the client area, but below the last item.commctrl.TVHT_ONITEMOn the bitmap or label associated with an item.commctrl.TVHT_ONITEMBUTTONOn the button associated with an item.commctrl.TVHT_ONITEMICONOn the bitmap associated with an item.commctrl.TVHT_ONITEMINDENTIn the indentation associated with an item.commctrl.TVHT_ONITEMLABELOn the label (string) associated with an item.commctrl.TVHT_ONITEMRIGHTIn the area to the right of an item.commctrl.TVHT_ONITEMSTATEICONOn the state icon for a tree view item that is in a user-defined state.commctrl.TVHT_TOLEFTTo the left of the client area.commctrl.TVHT_TORIGHTTo the right of the client area. - -Returns: - - tuple[Any, Any]:The point to test.Return ValueThe result is a tuple of (flags, hItem). - -flags may be a combination of the following values: - - - -Value - - -Description - - - -commctrl.TVHT_ABOVEAbove the client area. -commctrl.TVHT_BELOWBelow the client area. -commctrl.TVHT_NOWHEREIn the client area, but below the last item. -commctrl.TVHT_ONITEMOn the bitmap or label associated with an item. -commctrl.TVHT_ONITEMBUTTONOn the button associated with an item. -commctrl.TVHT_ONITEMICONOn the bitmap associated with an item. -commctrl.TVHT_ONITEMINDENTIn the indentation associated with an item. -commctrl.TVHT_ONITEMLABELOn the label (string) associated with an item. -commctrl.TVHT_ONITEMRIGHTIn the area to the right of an item. -commctrl.TVHT_ONITEMSTATEICONOn the state icon for a tree view item that is in a user-defined state. -commctrl.TVHT_TOLEFTTo the left of the client area. -commctrl.TVHT_TORIGHTTo the right of the client area. - - - """ - ... - - -class PyCTreeView: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def PreCreateWindow(self, createStruct: Any) -> Any: - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(Any):A tuple representing a CREATESTRUCT structure. - -Returns: - - Any - - """ - ... - - def GetTreeCtrl(self) -> Any: - """ - Returns the underlying tree control object. - -Args: - - - -Returns: - - Any - - """ - ... - - def OnCommand(self, wparam: Any, lparam: Any) -> None: - """ - Calls the standard Python framework OnCommand handler - -Args: - - wparam(Any): - lparam(Any):See Also - -Returns: - - None - - """ - ... - - -class PyCView: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CreateWindow(self, parent: Any, arg: Any, arg1: Any, arg2: tuple[Any, Any, Any, Any]) -> None: - """ - Creates the window for a view. - -Args: - - parent(Any):The parent window (usually a frame) - arg(Any):The child ID for the view - arg1(Any):The style for the view - arg2(tuple[Any, Any, Any, Any]):The default position of the window. - -Returns: - - None - - """ - ... - - def GetDocument(self) -> Any: - """ - Returns the document for a view. - -Args: - - - -Returns: - - Any - - """ - ... - - def OnActivateView(self, activate: Any, activateView: Any, DeactivateView: Any) -> Any: - """ - Calls the underlying MFC OnActivateView method. - -Args: - - activate(Any):Indicates whether the view is being activated or deactivated. - activateView(Any):The view object that is being activated. - DeactivateView(Any):The view object that is being deactivated.See Also - -Returns: - - Any - - """ - ... - - def OnInitialUpdate(self) -> None: - """ - Calls the underlying MFC OnInitialUpdate method. - -Args: - - - -Returns: - - None - - """ - ... - - def OnMouseActivate(self, wnd: Any, hittest: Any, message: Any) -> Any: - """ - Calls the base MFC OnMouseActivate function. - -Args: - - wnd(Any): - hittest(Any): - message(Any):See Also - -Returns: - - Any - - """ - ... - - def PreCreateWindow(self, createStruct: Any) -> Any: - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(Any):A tuple representing a CREATESTRUCT structure.See Also - -Returns: - - Any - - """ - ... - - def OnFilePrint(self) -> None: - """ - Calls the underlying MFC OnFilePrint method. - -Args: - - - -Returns: - - None - - """ - ... - - def DoPreparePrinting(self) -> Any: - """ - Invoke the Print dialog box and create a printer device context. - -Args: - - - -Returns: - - Any - - """ - ... - - def OnBeginPrinting(self) -> None: - """ - Calls the underlying MFC OnBeginPrinting method. - -Args: - - - -Returns: - - None - - """ - ... - - def OnEndPrinting(self) -> None: - """ - Calls the underlying MFC OnEndPrinting method. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyCWinApp: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def AddDocTemplate(self, template: Any) -> None: - """ - Adds a template to the application list. - -Args: - - template(Any):The template to be added. - -Returns: - - None - - """ - ... - - def FindOpenDocument(self, fileName: str) -> Any: - """ - Returns an existing document with the specified file name. - -Args: - - fileName(str):The fully qualified filename to search for. - -Returns: - - Any - - """ - ... - - def GetDocTemplateList(self) -> list[Any]: - """ - Returns a list of all document templates. - -Args: - - - -Returns: - - list[Any] - - """ - ... - - def InitDlgInstance(self, dialog: Any) -> None: - """ - Calls critical InitInstance processing for a dialog based application. - -Args: - - dialog(Any):The dialog object to be used as the main window for the application. - -Returns: - - None - - """ - ... - - def LoadCursor(self, cursorId: PyResourceId) -> Any: - """ - Loads a cursor. - -Args: - - cursorId(PyResourceId):The resource id or name of the cursor to load. - -Returns: - - Any - - """ - ... - - def LoadStandardCursor(self, cursorId: PyResourceId) -> Any: - """ - Loads a standard cursor. - -Args: - - cursorId(PyResourceId):The resource ID or name of the cursor to load. - -Returns: - - Any - - """ - ... - - def LoadOEMCursor(self, cursorId: Any) -> Any: - """ - Loads an OEM cursor. - -Args: - - cursorId(Any):The ID of the cursor to load. - -Returns: - - Any - - """ - ... - - def LoadIcon(self, idResource: Any) -> Any: - """ - Loads an icon resource. - -Args: - - idResource(Any):The ID of the icon to load. - -Returns: - - Any - - """ - ... - - def LoadStandardIcon(self, resourceName: PyResourceId) -> Any: - """ - Loads an icon resource. - -Args: - - resourceName(PyResourceId):The resource name or id of the standard icon to load. - -Returns: - - Any - - """ - ... - - def OpenDocumentFile(self, fileName: str) -> None: - """ - Opens a document file by name. - -Args: - - fileName(str):The name of the document to open. - -Returns: - - None - - """ - ... - - def OnFileNew(self) -> None: - """ - Calls the underlying OnFileNew MFC method. - -Args: - - - -Returns: - - None - - """ - ... - - def OnFileOpen(self) -> None: - """ - Calls the underlying OnFileOpen MFC method. - -Args: - - - -Returns: - - None - - """ - ... - - def RemoveDocTemplate(self, template: Any) -> None: - """ - Removes a template to the application list. - -Args: - - template(Any):The template to be removed. Must have previously been added by PyCWinApp::AddDocTemplate.CommentsNote that MFC does not provide an equivilent function. - -Returns: - - None - - """ - ... - - def Run(self) -> Any: - """ - Starts the message pump. Advanced users only - -Args: - - - -Returns: - - Any - - """ - ... - - def IsInproc(self) -> Any: - """ - Returns a flag to indicate if the created CWinApp was in the DLL, or an external - -EXE. - -Args: - - - -Returns: - - Any - - """ - ... - - -class PyCWinThread: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def CreateThread(self) -> None: - """ - Creates the actual thread behind the thread object. - -Args: - - - -Returns: - - None - - """ - ... - - def PumpIdle(self) -> None: - """ - Pumps all idle messages. - -Args: - - - -Returns: - - None - - """ - ... - - def PumpMessages(self) -> None: - """ - Pumps all messages to the application until a WM_QUIT message is received. - -Args: - - - -Returns: - - None - - """ - ... - - def Run(self) -> Any: - """ - Starts the message pump. Advanced users only - -Args: - - - -Returns: - - Any - - """ - ... - - def SetMainFrame(self, mainFrame: Any) -> None: - """ - Sets the threads main frame - -Args: - - mainFrame(Any):The applications main frame.CommentsYou can ... None to this function to reset the main frame. Should I free this? I dont think so! - -Returns: - - None - - """ - ... - - def SetThreadPriority(self, priority: Any) -> None: - """ - Sets the threads priority. Returns TRUE if successful. - -Args: - - priority(Any):The threads priority. - -Returns: - - None - - """ - ... - - -class PyCWnd: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def ActivateFrame(self, cmdShow: Any) -> None: - """ - Searches upwards for a parent window which has - -a frame, and activates it. - -Args: - - cmdShow(Any):The param passed to CFrameWnd::ShowWindow. See also PyCWnd::ShowWindow.MFC References - -Returns: - - None - - """ - ... - - def BringWindowToTop(self) -> None: - """ - Brings the window to the top of a stack of overlapping windows. - -Args: - - - -Returns: - - None - - """ - ... - - def BeginPaint(self) -> tuple[Any, Any]: - """ - Prepares a window for painting - -Args: - - - -Returns: - - tuple[Any, Any]:PyCWnd.BeginPaint -PyCDC, PAINTSTRUCT - - = BeginPaint()Prepares a window for painting -Return ValueYou must ... the PAINTSTRUCT param to the PyCWnd::EndPaint method. - - - """ - ... - - def CalcWindowRect(self, rect: tuple[Any, Any, Any, Any], nAdjustType: Any) -> tuple[Any, Any, Any, Any]: - """ - Computes the size of the window rectangle based on the desired client - -rectangle size. The resulting size can then be used as the initial - -size for the window object. - -Args: - - rect(tuple[Any, Any, Any, Any]):The size to calculate from - nAdjustType(Any):An enumerated type used for in-place editing. It can have the following values: CWnd::adjustBorder = 0, which means that scrollbar sizes are ignored in calculation; and CWnd::adjustOutside = 1, which means that they are added into the final measurements of the rectangle.MFC References - -Returns: - - tuple[Any, Any, Any, Any] - - """ - ... - - def CenterWindow(self, altwin: Any = None) -> None: - """ - Centers a window relative to its parent. - -Args: - - altwin(Any):alternate window relative to which it will be centered (other than the parent window).MFC References - -Returns: - - None - - """ - ... - - def CheckRadioButton(self, idFirst: Any, idLast: Any, idCheck: Any) -> None: - """ - Selects the specified radio button, and clears - -all others in the group. - -Args: - - idFirst(Any):The identifier of the first radio button in the group. - idLast(Any):The identifier of the last radio button in the group. - idCheck(Any):The identifier of the radio button to be checked.MFC References - -Returns: - - None - - """ - ... - - def ChildWindowFromPoint(self, x: Any, y: Any, flag: Any = 0) -> Any: - """ - Returns the child window that contains the point - -Args: - - x(Any):x coordinate of point - y(Any):y coordinate of point - flag(Any):Specifies which child windows to skipMFC References - -Returns: - - Any - - """ - ... - - def ClientToScreen(self, point: tuple[Any, Any], rect: Any) -> tuple[Any, Any, Any, Any, Any]: - """ - Converts the client coordinates of a given point on the display - -to screen coordinates. - -Args: - - point(tuple[Any, Any]):The client coordinates.Alternative Parameters - rect(Any):The client coordinates.CommentsThe new screen coordinates are relative to the upper-left corner of the system display. This function assumes that the given pointis in client coordinates.MFC References - -Returns: - - tuple[Any, Any, Any, Any, Any] - - """ - ... - - def CreateWindow( - self, - classId: str, - windowName: str, - style: Any, - rect: tuple[Any, Any, Any, Any], - parent: Any, - _id: Any, - context: Any = None) -> None: - """ - Creates the actual window - -Args: - - classId(str):The class ID for the window, or None - windowName(str):The title for the window, or None - style(Any):The style for the window. - rect(tuple[Any, Any, Any, Any]):The size and position of the window. - parent(Any):The parent window of the new window.. - _id(Any):The control's ID. - context(Any):A CreateContext object.MFC References - -Returns: - - None - - """ - ... - - def CreateWindowEx( - self, - styleEx: Any, - classId: str, - windowName: str, - style: Any, - rect: tuple[Any, Any, Any, Any], - parent: Any, - _id: Any, - createStruct1: Any, - createStruct: Any = None) -> None: - """ - Creates the actual window using extended capabilities. - -Args: - - styleEx(Any):The extended style of the window being created. - classId(str):The class ID for the window. May not be None. - windowName(str):The title for the window, or None - style(Any):The style for the window. - rect(tuple[Any, Any, Any, Any]):The size and position of the window. - parent(Any):The parent window of the new window.. - _id(Any):The control's ID. - createStruct1(Any):A tuple representing a CREATESTRUCT structure.MFC References - createStruct(Any):A CreateStruct object (ie, a tuple) - -Returns: - - None - - """ - ... - - def DefWindowProc(self, message: Any, idLast: Any, idCheck: Any) -> Any: - """ - Calls the default message handler. - -Args: - - message(Any):The Windows message. - idLast(Any):The lParam for the message. - idCheck(Any):The wParam for the message.MFC References - -Returns: - - Any - - """ - ... - - def DestroyWindow(self) -> None: - """ - Destroy the window attached to the object. - -Args: - - - -Returns: - - None - - """ - ... - - def DlgDirList(self, defPath: str, idListbox: Any, idStaticPath: Any, fileType: Any) -> None: - """ - Fill a list box with a file or directory listing. - -Args: - - defPath(str):The file spec to fill the list box with - idListbox(Any):The Id of the listbox control to fill. - idStaticPath(Any):The Id of the static control used to display the current drive and directory. If idStaticPath is 0, it is assumed that no such control exists. - fileType(Any):Specifies the attributes of the files to be displayed. It can be any combination of DDL_READWRITE, DDL_READONLY, DDL_HIDDEN, DDL_SYSTEM, DDL_DIRECTORY, DDL_ARCHIVE, DDL_POSTMSGS, DDL_DRIVES or DDL_EXCLUSIVEMFC References - -Returns: - - None - - """ - ... - - def DlgDirListComboBox(self) -> None: - """ - None - -Args: - - - -Returns: - - None - - """ - ... - - def DlgDirSelect(self, idListbox: Any) -> str: - """ - None - -Args: - - idListbox(Any):The Id of the listbox.MFC References - -Returns: - - str - - """ - ... - - def DlgDirSelectComboBox(self, idListbox: Any) -> str: - """ - None - -Args: - - idListbox(Any):The Id of the combobox.MFC References - -Returns: - - str - - """ - ... - - def DragAcceptFiles(self, bAccept: Any = 1) -> None: - """ - Indicates that the window and children supports files dropped from file manager - -Args: - - bAccept(Any):A flag indicating if files are accepted.MFC References - -Returns: - - None - - """ - ... - - def DrawMenuBar(self) -> None: - """ - Redraws the menu bar. Can be called if the menu changes. - -Args: - - - -Returns: - - None - - """ - ... - - def EnableWindow(self, bEnable: Any = 1) -> Any: - """ - Enables or disables the window. Typically used for dialog controls. - -Args: - - bEnable(Any):A flag indicating if the window is to be enabled or disabled.MFC References - -Returns: - - Any:CWnd::EnableWindow -Return ValueReturns the state before the EnableWindow member function was called - - - """ - ... - - def EndModalLoop(self, result: Any) -> None: - """ - Ends a modal loop. - -Args: - - result(Any):The result as returned to RunModalLoop - -Returns: - - None - - """ - ... - - def EndPaint(self, paintStruct: Any) -> None: - """ - Ends painting - -Args: - - paintStruct(Any):The object returned from PyCWnd::BeginPaint - -Returns: - - None - - """ - ... - - def GetCheckedRadioButton(self, idFirst: Any, idLast: Any) -> Any: - """ - Returns the ID of the checked radio button, or 0 if none is selected. - -Args: - - idFirst(Any):The Id of the first radio button in the group. - idLast(Any):The Id of the last radio button in the group.MFC References - -Returns: - - Any - - """ - ... - - def GetClientRect(self) -> tuple[Any, Any, Any, Any]: - """ - Returns the client coordinates of the window. left and top - -will be zero. - -Args: - - - -Returns: - - tuple[Any, Any, Any, Any] - - """ - ... - - def GetDC(self) -> Any: - """ - Gets the windows current DC object. - -Args: - - - -Returns: - - Any:PyCWnd.GetDC -PyCDC = GetDC()Gets the windows current DC object. -Return ValueThe result is a PyCDC, or a win32ui.error exception is raised. - - - """ - ... - - def GetDCEx(self) -> Any: - """ - Gets the windows current DC object with extended caps. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetDlgCtrlID(self) -> Any: - """ - Returns the ID of this child window. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetDlgItem(self, idControl: Any) -> Any: - """ - None - -Args: - - idControl(Any):The Id of the control to be retrieved.MFC References - -Returns: - - Any:CWnd::GetDlgItem -Return ValueThe result is a PyCWnd (or derived) object, or a win32ui.error exception is raised. - - - """ - ... - - def GetDlgItemInt(self, idControl: Any, bUnsigned: Any = 1) -> Any: - """ - Returns the integer value of a child window or control with the specified ID. - -Args: - - idControl(Any):The Id of the control to be retrieved. - bUnsigned(Any):Should the function check for a minus signMFC References - -Returns: - - Any:CWnd::GetDlgItemInt -Return ValueIf the value can not be converted, a ValueError is raised. - - - """ - ... - - def GetDlgItemText(self, idControl: Any) -> str: - """ - Returns the text of child window or control with the specified ID. - -Args: - - idControl(Any):The Id of the control to be retrieved.MFC References - -Returns: - - str - - """ - ... - - def GetLastActivePopup(self) -> Any: - """ - Returns the last active popup Window, or the Window itself. - -Args: - - - -Returns: - - Any:CWnd::GetLastActivePopup -Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - - """ - ... - - def GetMenu(self) -> Any: - """ - Returns the menu object for the window's menu. - -Args: - - - -Returns: - - Any:CWnd::GetMenu -Return ValueThe result is a PyMenu - - object, or an exception is thrown. - - - """ - ... - - def GetParent(self) -> Any: - """ - Returns the window's parent. - -Args: - - - -Returns: - - Any:CWnd::GetParent -Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - - """ - ... - - def GetParentFrame(self) -> Any: - """ - Returns the window's frame. - -Args: - - - -Returns: - - Any:CWnd::GetParentFrame -Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - - """ - ... - - def GetSafeHwnd(self) -> Any: - """ - Returns the HWnd of this window. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetScrollInfo(self, nBar: Any, mask: Any) -> Any: - """ - Returns information about a scroll bar - -Args: - - nBar(Any):The scroll bar to examine. Can be one of win32con.SB_BOTH, win32con.SB_VERT or win32con.SB_HORZ - mask(Any):The mask for attributes to retrieve. - -Returns: - - Any - - """ - ... - - def GetScrollPos(self, nBar: Any) -> Any: - """ - Retrieves the current position of the scroll box of a scroll bar. - -Args: - - nBar(Any):The scroll bar to examine. Can be one of win32con.SB_VERT or win32con.SB_HORZ - -Returns: - - Any - - """ - ... - - def GetStyle(self) -> Any: - """ - Retrieves the window style - -Args: - - - -Returns: - - Any - - """ - ... - - def GetExStyle(self) -> Any: - """ - Retrieves the window's extended style - -Args: - - - -Returns: - - Any - - """ - ... - - def GetSystemMenu(self) -> Any: - """ - Returns the menu object for the window's system menu. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetTopLevelFrame(self) -> Any: - """ - Returns the top-level frame of the window. - -Args: - - - -Returns: - - Any:CWnd::GetTopLevelFrame -Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - - """ - ... - - def GetTopLevelOwner(self) -> Any: - """ - Returns the top-level owner of the window. - -Args: - - - -Returns: - - Any:CWnd::GetTopLevelOwner -Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - - """ - ... - - def GetTopLevelParent(self) -> Any: - """ - Returns the top-level parent of the window. - -Args: - - - -Returns: - - Any:CWnd::GetTopLevelParent -Return ValueThe result is a PyCWnd object, or None if no Window can be found. - - - """ - ... - - def GetTopWindow(self) -> Any: - """ - Identifies the top-level child window in a linked list of child windows. - -Args: - - - -Returns: - - Any:CWnd::GetTopWindow -Return ValueIf no child windows exist, the value is None. - - - """ - ... - - def GetWindow(self, _type: Any) -> Any: - """ - Returns a window, with the specified relationship to this window. - -Args: - - _type(Any):Specifies the relationship between the current and the returned window. It can take one of the following values: GW_CHILD, GW_HWNDFIRST, GW_HWNDLAST, GW_HWNDNEXT, GW_HWNDPREV or GW_OWNERMFC References - -Returns: - - Any:CWnd::GetWindow -Return ValueThe result is a PyCWnd or None if no Window can be found. - - - """ - ... - - def GetWindowDC(self) -> Any: - """ - Gets the windows current DC object. - -Args: - - - -Returns: - - Any - - """ - ... - - def GetWindowPlacement(self) -> Any: - """ - Returns placement information about the current window. - -Args: - - - -Returns: - - Any:CWnd::GetWindowPlacement -Return ValueThe result is a tuple of - -(flags, showCmd, (minposX, minposY), (maxposX, maxposY), (normalposX, normalposY)) - - - -Item - - -Description - - - -flagsOne of the WPF_* constants -showCmdCurrent state - one of the SW_* constants. -minposSpecifies the coordinates of the window's upper-left corner when the window is minimized. -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. - - - """ - ... - - def GetWindowRect(self) -> tuple[Any, Any, Any, Any]: - """ - Returns the screen coordinates of the windows upper left - -corner - -Args: - - - -Returns: - - tuple[Any, Any, Any, Any] - - """ - ... - - def GetWindowText(self) -> str: - """ - Returns the windows text. - -Args: - - - -Returns: - - str - - """ - ... - - def HideCaret(self) -> None: - """ - Hides the caret - -Args: - - - -Returns: - - None - - """ - ... - - def HookAllKeyStrokes(self, obHandler: Any) -> None: - """ - Hook a key stroke handler for all key strokes. - -Args: - - obHandler(Any):The handler for the keystrokes. This must be a callable object.CommentsThe handler object passed will be called as the application receives WM_CHAR messages. The handler will be called with 2 arguments The handler object (as per all hook functions). The keystroke being handled. If the handler returns TRUE, then the keystroke will be passed on to the default handler, otherwise it will be consumed. Note: This handler will prevent any PyCWnd::HookKeyStroke hooks from being called. - -Returns: - - None - - """ - ... - - def HookKeyStroke(self, obHandler: Any, ch: Any) -> Any: - """ - Hook a key stroke handler - -Args: - - obHandler(Any):The handler of the keystroke. This must be a callable object. - ch(Any):The ID for the keystroke to be handled. This may be an ascii code, or a virtual key code.CommentsThe 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 The handler object (as per all hook functions) The keystroke being handled. If the handler returns TRUE, then the keystroke will be passed on to the 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. - -Returns: - - 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 - -character code. The handler will be called with 2 arguments - -The handler object (as per all hook functions) - -The keystroke being handled. - -If the handler returns TRUE, then the keystroke will be passed on to the - -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. - - - """ - ... - - def HookMessage(self, obHandler: Any, message: Any) -> Any: - """ - Hook a message notification handler - -Args: - - obHandler(Any):The handler for the message notification. This must be a callable object. - message(Any):The ID of the message to be handled.CommentsThe 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. The handler will be called with 2 arguments The handler object (as per all hook functions). A tuple representing the message. The message tuple is in the following format:Items[0] int : hwndThe hwnd of the window.[1] int : messageThe message.[2] int : wParamThe wParam sent with the message.[3] int : lParamThe lParam sent with the message.[4] int : timeThe time the message was posted.[5] int, int : pointThe point where the mouse was when the message was posted.Return ValueThe return value is the previous handler, or None. - -Returns: - - 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. - -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 object (as per all hook functions). - -A tuple representing the message. - -The message tuple is in the following format: -Items[0] int : hwnd -The hwnd of the window. -[1] int : message -The message. -[2] int : wParam -The wParam sent with the message. -[3] int : lParam -The lParam sent with the message. -[4] int : time -The time the message was posted. -[5] int, int : point -The point where the mouse was when the message was posted. -Return ValueThe return value is the previous handler, or None. - - - """ - ... - - def InvalidateRect(self, arg: tuple[Any, Any, Any, Any], bErase: Any = 1) -> None: - """ - Invalidates an area of a window. - -Args: - - arg(tuple[Any, Any, Any, Any]):Rectangle to be updated. If default param is used, the entire window is invalidated. - bErase(Any):Specifies whether the background within the update region is to be erased.MFC References - -Returns: - - None - - """ - ... - - def InvalidateRgn(self, region: Any, bErase: Any = 1) -> None: - """ - Invalidates a region of the window - -Args: - - region(Any):The region to erase. - bErase(Any):Indicates if the region should be erased. - -Returns: - - None - - """ - ... - - def IsChild(self, obWnd: Any) -> Any: - """ - Determines if a given window is a child of this window. - -Args: - - obWnd(Any):The window to be checkedMFC References - -Returns: - - Any - - """ - ... - - def IsDlgButtonChecked(self, idCtl: Any) -> Any: - """ - Determines if a dialog button is checked. - -Args: - - idCtl(Any):The ID of the button to check.MFC References - -Returns: - - Any - - """ - ... - - def IsIconic(self) -> Any: - """ - Determines if the window is currently displayed as an icon. - -Args: - - - -Returns: - - Any - - """ - ... - - def IsZoomed(self) -> Any: - """ - Determines if the window is currently maximised. - -Args: - - - -Returns: - - Any - - """ - ... - - def IsWindow(self) -> Any: - """ - determines whether the specified window handle identifies an existing window - -Args: - - - -Returns: - - Any - - """ - ... - - def IsWindowVisible(self) -> Any: - """ - Determines if the window is currently visible. - -Args: - - - -Returns: - - Any - - """ - ... - - def KillTimer(self) -> Any: - """ - Kills a system timer - -Args: - - - -Returns: - - Any - - """ - ... - - def LockWindowUpdate(self) -> None: - """ - Disables drawing in the given window - -Args: - - - -Returns: - - None - - """ - ... - - def MapWindowPoints(self, wnd: Any, points: list[Any]) -> None: - """ - Converts (maps) a set of points from the coordinate space of a window to the - -coordinate space of another window. - -Args: - - wnd(Any): - points(list[Any]):The points to mapReturn ValueA list of the mapped points from the coordinate space of the CWnd to the coordinate space of another window. - -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 - -window. - - - """ - ... - - def MouseCaptured(self) -> Any: - """ - Returns 1 if the window has the mouse capture, else 0 - -Args: - - - -Returns: - - Any - - """ - ... - - def MessageBox(self, message: str, arg: Any, title: Union[Any, str] = None) -> None: - """ - Display a message box. - -Args: - - message(str):The message to be displayed in the message box. - arg(Any):The style of the message box.MFC References - title(Union[Any, str]):The title for the message box. If None, the applications title will be used. - -Returns: - - None:CWnd::MessageBox -Return ValueAn integer identifying the button pressed to dismiss the dialog. - - - """ - ... - - def ModifyStyle(self, remove: Any, add: Any, flags: Any = 0) -> Any: - """ - Modifies the style of a window. - -Args: - - remove(Any):Specifies window styles to be removed during style modification. - add(Any):Specifies window styles to be added during style modification. - flags(Any):Flags to be passed to SetWindowPos, or zero if SetWindowPos should not be called. The default is zero.CommentsIf nFlags is nonzero, ModifyStyle calls the Windows API function ::SetWindowPos and redraws the window by combining nFlags with the following four preset flags: * SWP_NOSIZE Retains the current size. * SWP_NOMOVE Retains the current position. * SWP_NOZORDER Retains the current Z order. * SWP_NOACTIVATE Does not activate the window. See also PyCWnd::ModifyStyleExMFC References - -Returns: - - Any:CWnd::ModifyStyle -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. - - - """ - ... - - def ModifyStyleEx(self, remove: Any, add: Any, flags: Any = 0) -> Any: - """ - Modifies the extended style of a window. - -Args: - - remove(Any):Specifies extended window styles to be removed during style modification. - add(Any):Specifies extended extended window styles to be added during style modification. - flags(Any):Flags to be passed to SetWindowPos, or zero if SetWindowPos should not be called. The default is zero.CommentsIf nFlags is nonzero, ModifyStyleEx calls the Windows API function ::SetWindowPos and redraws the window by combining nFlags with the following four preset flags: * SWP_NOSIZE Retains the current size. * SWP_NOMOVE Retains the current position. * SWP_NOZORDER Retains the current Z order. * SWP_NOACTIVATE Does not activate the window. See also PyCWnd::ModifyStyleMFC References - -Returns: - - Any:CWnd::ModifyStyleEx -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. - - - """ - ... - - def MoveWindow(self, rect: tuple[Any, Any, Any, Any], bRepaint: Any = 1) -> None: - """ - Move a window to a new location. - -Args: - - rect(tuple[Any, Any, Any, Any]):The new location of the window, relative to the parent. - bRepaint(Any):Indicates if the window should be repainted after the move.MFC References - -Returns: - - None - - """ - ... - - def OnClose(self) -> Any: - """ - Calls the default MFC OnClose handler. - -Args: - - - -Returns: - - Any - - """ - ... - - def OnCtlColor(self, dc: Any, control: Any, _type: Any) -> Any: - """ - Calls the default MFC OnCtlColor handler. - -Args: - - dc(Any):The dc - control(Any):The control that want's it's color changed - _type(Any):Type of controlSee Also - -Returns: - - Any - - """ - ... - - def OnEraseBkgnd(self, dc: Any) -> Any: - """ - Calls the default MFC OnEraseBkgnd handler. - -Args: - - dc(Any):The dcSee Also - -Returns: - - Any - - """ - ... - - def OnNcHitTest(self, arg: tuple[Any, Any]) -> Any: - """ - Calls the base MFC OnNcHitTest function. - -Args: - - arg(tuple[Any, Any]):The pointSee Also - -Returns: - - Any - - """ - ... - - def OnPaint(self) -> Any: - """ - Calls the default MFC OnPaint handler. - -Args: - - - -Returns: - - Any - - """ - ... - - def OnQueryDragIcon(self) -> Any: - """ - Calls the default MFC OnQueryDragIcon handler. - -Args: - - - -Returns: - - Any - - """ - ... - - def OnQueryNewPalette(self) -> Any: - """ - Calls the underlying MFC OnQueryNewPalette method. - -Args: - - - -Returns: - - Any - - """ - ... - - def OnSetCursor(self, wnd: Any, hittest: Any, message: Any) -> Any: - """ - Calls the base MFC OnSetCursor function. - -Args: - - wnd(Any): - hittest(Any): - message(Any):See Also - -Returns: - - Any - - """ - ... - - def OnMouseActivate(self, wnd: Any, hittest: Any, message: Any) -> Any: - """ - Calls the base MFC OnMouseActivate function. - -Args: - - wnd(Any): - hittest(Any): - message(Any):See Also - -Returns: - - Any - - """ - ... - - def OnWndMsg(self, msg: Any, wParam: Any, lParam: Any) -> tuple[Any, Any]: - """ - Calls the default MFC Window Message handler. - -Args: - - msg(Any):The message - wParam(Any):The wParam for the message - lParam(Any):The lParam for the messageMFC References - -Returns: - - tuple[Any, Any]:CWnd::OnWndMsg -Return ValueThe return value is a tuple of (int, int), being the - -return value from the MFC function call, and the value of the - -lResult param. Please see the MFC documentation for more details. - - - """ - ... - - def PreCreateWindow(self, createStruct: Any) -> Any: - """ - Calls the underlying MFC PreCreateWindow method. - -Args: - - createStruct(Any):A tuple representing a CREATESTRUCT structure.See Also - -Returns: - - Any - - """ - ... - - def PumpWaitingMessages(self, firstMsg: Any, lastMsg: Any) -> None: - """ - Pump messages associate with a window. - -Args: - - firstMsg(Any):First message ID to process - lastMsg(Any):First message ID to processMFC References - -Returns: - - None - - """ - ... - - def RedrawWindow(self, _object: Any, flags: Any, rect: tuple[Any, Any, Any, Any] = None) -> None: - """ - Updates the specified rectangle or region in the given window's client area. - -Args: - - _object(Any):A region - flags(Any):MFC References - rect(tuple[Any, Any, Any, Any]):A rect, or None - -Returns: - - None - - """ - ... - - def ReleaseCapture(self) -> None: - """ - None - -Args: - - - -Returns: - - None - - """ - ... - - def ReleaseDC(self, dc: Any) -> None: - """ - Releases a device context, freeing it for use by other applications. - -Args: - - dc(Any):The DC to be released. - -Returns: - - None - - """ - ... - - def RepositionBars(self, idFirst: Any, idLast: Any, idLeftOver: Any) -> None: - """ - Repositions the windows control bars.( UINT nIDFirst, UINT nIDLast, UINT - -nIDLeftOver, UINT nFlag = CWnd::reposDefault, LPRECT lpRectParam = NULL, LPCRECT lpRectClient = NULL, BOOL bStretch = - -TRUE ); - -Args: - - idFirst(Any):The ID of the first control to reposition. - idLast(Any):The ID of the last control to reposition. - idLeftOver(Any): - -Returns: - - None - - """ - ... - - def RunModalLoop(self, flags: Any) -> Any: - """ - Begins a modal loop for the window. - -Args: - - flags(Any): - -Returns: - - Any - - """ - ... - - def PostMessage(self, idMessage: Any, wParam: Any = 0, lParam: Any = 0) -> None: - """ - Post a message to the window. - -Args: - - idMessage(Any):The ID of the message to post. - wParam(Any):The wParam for the message - lParam(Any):The lParam for the messageMFC References - -Returns: - - None - - """ - ... - - def SendMessageToDescendants( - self, - idMessage: Any, - wParam: Any = 0, - lParam: Any = 0, - bDeep: Any = 1) -> None: - """ - Send a message to all descendant windows. - -Args: - - idMessage(Any):The ID of the message to send. - wParam(Any):The wParam for the message - lParam(Any):The lParam for the message - bDeep(Any):Indicates if the message should be recursively sent to all childrenMFC References - -Returns: - - None - - """ - ... - - def SendMessage( - self, - idMessage: Any, - idMessage1: Any, - ob: Any, - wParam: Any = 0, - lParam: Any = 0) -> None: - """ - Send a message to the window. - -Args: - - idMessage(Any):The ID of the message to send. - idMessage1(Any):The ID of the message to send. - ob(Any):A buffer whose size is passed in wParam, and address is passed in lParamMFC References - wParam(Any):The wParam for the message - lParam(Any):The lParam for the messageAlternative Parameters - -Returns: - - None - - """ - ... - - def SetActiveWindow(self) -> Any: - """ - Sets the window active. Returns the previously active window, or None. - -Args: - - - -Returns: - - Any:PyCWnd.SetActiveWindow -PyCWnd = SetActiveWindow()Sets the window active. Returns the previously active window, or None. -Return ValueThe result is the previous window with focus, or None. - - - """ - ... - - def SetForegroundWindow(self) -> None: - """ - Puts the window into the foreground and activates the window. - -Args: - - - -Returns: - - None - - """ - ... - - def SetWindowPos(self, hWndInsertAfter: Any, position: tuple[Any, Any, Any, Any], flags: Any) -> None: - """ - Sets the windows position information - -Args: - - hWndInsertAfter(Any):A hwnd, else one of the win32con.HWND_* constants. - position(tuple[Any, Any, Any, Any]):The new position of the window. - flags(Any):Window positioning flags.MFC References - -Returns: - - None - - """ - ... - - def ScreenToClient(self, rect: tuple[Any, Any, Any, Any, Any], pnt: Any) -> tuple[Any, Any, Any, Any, Any]: - """ - Converts the screen coordinates of a given point - -or rectangle on the display to client coordinates. - -Args: - - rect(tuple[Any, Any, Any, Any, Any]):The coordinates to convert.Alternative Parameters - pnt(Any):The coordinates to convert.MFC References - -Returns: - - tuple[Any, Any, Any, Any, Any]:CWnd::ScreenToClient -Return ValueThe result is the same size as the input argument. - - - """ - ... - - def SetCapture(self) -> None: - """ - Causes all subsequent mouse input to be sent to the window object regardless of the - -position of the cursor. - -Args: - - - -Returns: - - None - - """ - ... - - def SetDlgItemText(self, idControl: Any, text: str) -> None: - """ - Sets the text for the child window or control with the specified ID. - -Args: - - idControl(Any):The Id of the control - text(str):The new textMFC References - -Returns: - - None - - """ - ... - - def SetFocus(self) -> None: - """ - Claims the input focus. The object that previously had the focus loses it. - -Args: - - - -Returns: - - None - - """ - ... - - def SetFont(self, font: Any, bRedraw: Any = 1) -> None: - """ - Sets the window's current font to the specified font. - -Args: - - font(Any):The new font to use. - bRedraw(Any):If TRUE, redraw the window. - -Returns: - - None - - """ - ... - - def SetIcon(self) -> Any: - """ - Calls the underlying MFC SetIcon method. - -Args: - - - -Returns: - - Any - - """ - ... - - def SetMenu(self, menuObj: Any) -> None: - """ - Sets the menu for a window. - -Args: - - menuObj(Any):The menu object to set, or None to remove the window. - -Returns: - - None - - """ - ... - - def SetRedraw(self, bState: Any = 1) -> None: - """ - Allows changes to be redrawn or to prevent changes from being redrawn. - -Args: - - bState(Any):Specifies the state of the redraw flag.MFC References - -Returns: - - None - - """ - ... - - def SetScrollPos(self, nBar: Any, nPos: Any, redraw: Any = 1) -> Any: - """ - Sets the current position of the scroll box of a scroll bar. - -Args: - - nBar(Any):The scroll bar to set. Can be one of win32con.SB_VERT or win32con.SB_HORZ - nPos(Any):The new position - redraw(Any):A flag indicating if the scrollbar should be redrawn. - -Returns: - - Any - - """ - ... - - def SetScrollInfo(self, nBar: Any, ScrollInfo: Any, redraw: Any = 1) -> Any: - """ - Set information about a scroll bar - -Args: - - nBar(Any):The scroll bar to examine. Can be one of win32con.SB_BOTH, win32con.SB_VERT or win32con.SB_HORZ - ScrollInfo(Any):The information to set - redraw(Any):A flag indicating if the scrollbar should be re-drawn. - -Returns: - - Any - - """ - ... - - def SetTimer(self, idEvent: Any, elapse: Any) -> Any: - """ - Installs a system timer - -Args: - - idEvent(Any):The ID of the event - elapse(Any):How often the timer should fire.MFC References - -Returns: - - Any - - """ - ... - - def SetWindowPlacement(self, placement: Any) -> None: - """ - Sets the windows placement - -Args: - - placement(Any):A tuple representing the WINDOWPLACEMENT structure.MFC References - -Returns: - - None - - """ - ... - - def SetWindowText(self, text: str) -> None: - """ - Sets the window's text. - -Args: - - text(str):The windows text.MFC References - -Returns: - - None - - """ - ... - - def ShowCaret(self) -> None: - """ - Shows the caret - -Args: - - - -Returns: - - None - - """ - ... - - def ShowScrollBar(self, nBar: Any, bShow: Any = 1) -> None: - """ - Shows or hides a scroll bar. - -An application should not call ShowScrollBar to hide a scroll bar while processing a scroll-bar notification message. - -Args: - - nBar(Any):Specifies whether the scroll bar is a control or part of a window's nonclient area. If it is part of the nonclient area, nBar also indicates whether the scroll bar is positioned horizontally, vertically, or both. It must be one of win32con.SB_BOTH, win32con.SB_HORZ or win32con.SB_VERT. - bShow(Any):Indicates if the scroll bar should be shown or hidden.MFC References - -Returns: - - None - - """ - ... - - def ShowWindow(self, arg: Any) -> Any: - """ - Sets the visibility state of the window. - -Args: - - arg(Any):Specifies how the window is to be shown. It must be one of win32con.SW_HIDE, win32con.SW_MINIMIZE, win32con.SW_RESTORE, win32con.SW_SHOW, win32con.SW_SHOWMAXIMIZED win32con.SW_SHOWMINIMIZED, win32con.SW_SHOWMINNOACTIVE, win32con.SW_SHOWNA, win32con.SW_SHOWNOACTIVATE, or win32con.SW_SHOWNORMALMFC References - -Returns: - - Any:CWnd::ShowWindow -Return ValueReturns TRUE is the window was previously visible. - - - """ - ... - - def UnLockWindowUpdate(self) -> None: - """ - Unlocks a window that was locked with LockWindowUpdate - -Args: - - - -Returns: - - None - - """ - ... - - def UpdateData(self, bSaveAndValidate: Any = 1) -> Any: - """ - 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 - -nonzero means that the data is successfully validated. - -Args: - - bSaveAndValidate(Any):Flag that indicates whether dialog box is being initialized (FALSE) or data is being retrieved (TRUE).MFC References - -Returns: - - Any - - """ - ... - - def UpdateDialogControls(self, pTarget: Any, disableIfNoHandler: Any) -> Any: - """ - None - -Args: - - pTarget(Any):The main frame window of the application, and is used for routing update messages. - disableIfNoHandler(Any):Flag that indicates whether a control that has no update handler should be automatically displayed as disabled. - -Returns: - - Any - - """ - ... - - def UpdateWindow(self) -> None: - """ - Updates a window. This forces a paint message to be sent to the window, if any part - -of the window is marked as invalid. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyDDEConv: - """A DDE topic.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def ConnectTo(self, service: str, topic: str) -> None: - """ - Connects to a server - -Args: - - service(str):The service to connect to - topic(str):The topic to connect to - -Returns: - - None - - """ - ... - - def Connected(self) -> None: - """ - Determines if the conversation is connected. - -Args: - - - -Returns: - - None - - """ - ... - - def Exec(self, Cmd: str) -> None: - """ - Executes a command. - -Args: - - Cmd(str):The Python statement to execute - -Returns: - - None - - """ - ... - - def Request(self) -> None: - """ - Sends a request. - -Args: - - - -Returns: - - None - - """ - ... - - def Poke(self) -> None: - """ - Sends a poke. - -Args: - - - -Returns: - - None - - """ - ... - - -class PyDDEServer: - """A DDE server.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def AddTopic(self, topic: Any) -> None: - """ - None - -Args: - - topic(Any):The topic to add. - -Returns: - - None - - """ - ... - - def Create(self, name: str, filterFlags: Any = 0) -> None: - """ - Create a server - -Args: - - name(str):Name of the server to start. - filterFlags(Any):Filter flags.CommentsNote there can only be one server per application. - -Returns: - - None - - """ - ... - - def Destroy(self) -> None: - """ - None - -Args: - - - -Returns: - - None - - """ - ... - - def GetLastError(self) -> Any: - """ - None - -Args: - - - -Returns: - - Any - - """ - ... - - def Shutdown(self) -> None: - """ - None - -Args: - - - -Returns: - - None - - """ - ... - - -class PyDDEStringItem: - """A DDE string item.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def SetData(self, data: str) -> None: - """ - Sets an items data, and causes any underlying notification. - -Args: - - data(str):The data to set. - -Returns: - - None - - """ - ... - - -class PyDDETopic: - """A DDE topic.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def AddItem(self, item: Any) -> None: - """ - Add an item to the topic. - -Args: - - item(Any):The item to add - -Returns: - - None - - """ - ... - - def Destroy(self) -> None: - """ - Destroys an item - -Args: - - - -Returns: - - None - - """ - ... - - -class PyDLL: - """A DLL object. A general utility object, and not associated with an MFC object.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetFileName(self) -> str: - """ - Returns the name of the module associated with the DLL. - -Args: - - - -Returns: - - str - - """ - ... - - def AttachToMFC(self) -> None: - """ - Attaches the DLL object to the MFC list of DLL's. - -Args: - - - -Returns: - - None - - """ - ... - - -class SCROLLINFO: - """tuple representing a SCROLLINFO struct""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class TV_ITEM: - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - -class EXTENSION_CONTROL_BLOCK: - """A python representation of an ISAPI - -EXTENSION_CONTROL_BLOCK.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def Version(self) -> int: - """Version info of this spec (read-only)""" - ... - - @property - def TotalBytes(self) -> Any: - """Total bytes indicated from client""" - ... - - @property - def AvailableBytes(self) -> Any: - """Available number of bytes""" - ... - - @property - def HttpStatusCode(self) -> Any: - """The status of the current transaction when the request is completed.""" - ... - - @property - def Method(self) -> Any: - """REQUEST_METHOD""" - ... - - @property - def ConnID(self) -> Any: - """Context number (read-only)""" - ... - - @property - def QueryString(self) -> Any: - """QUERY_STRING""" - ... - - @property - def PathInfo(self) -> Any: - """PATH_INFO""" - ... - - @property - def PathTranslated(self) -> Any: - """PATH_TRANSLATED""" - ... - - @property - def AvailableData(self) -> Any: - """Pointer to cbAvailable bytes""" - ... - - @property - def ContentType(self) -> Any: - """Content type of client data""" - ... - - @property - def LogData(self) -> Any: - """log data string""" - ... - - def WriteClient(self, data: Union[Any, str], reserved: Any = 0) -> Any: - """ - None - -Args: - - data(Union[Any, str]):The data to write - reserved(Any):Return Valuethe result is the number of bytes written. - -Returns: - - Any: -Return Valuethe result is the number of bytes written. - - - """ - ... - - def GetServerVariable(self, variable: str, default: Any) -> str: - """ - None - -Args: - - variable(str): - default(Any):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 begins with 'UNICODE_, in which case it is a unicode object - see the ISAPI docs for more details. - -Returns: - - 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 - -begins with 'UNICODE_, in which case it is a unicode object - see the - -ISAPI docs for more details. - - - """ - ... - - def ReadClient(self, nbytes: Any) -> str: - """ - None - -Args: - - nbytes(Any):Default is to read all available data. - -Returns: - - str - - """ - ... - - def SendResponseHeaders(self, reply: str, headers: str, keepAlive: Any = False) -> None: - """ - Calls ServerSupportFunction with - -HSE_REQ_SEND_RESPONSE_HEADER_EX - -Args: - - reply(str): - headers(str): - keepAlive(Any): - -Returns: - - None - - """ - ... - - def SetFlushFlag(self, flag: Any) -> None: - """ - Calls ServerSupportFunction with HSE_REQ_SET_FLUSH_FLAG. - -Args: - - flag(Any): - -Returns: - - None - - """ - ... - - def TransmitFile( - self, - callback: Any, - param: Any, - hFile: Any, - statusCode: str, - BytesToWrite: Any, - Offset: Any, - head: str, - tail: str, - flags: Any) -> Any: - """ - Calls ServerSupportFunction with HSE_REQ_TRANSMIT_FILE - -Args: - - callback(Any): - param(Any):Any object - passed as 2nd arg to callback. - hFile(Any): - statusCode(str): - BytesToWrite(Any): - Offset(Any): - head(str): - tail(str): - flags(Any):CommentsThe callback is called with 4 args - (PyECB, param, cbIO, dwErrCode) - -Returns: - - Any - - """ - ... - - def MapURLToPath(self) -> None: - """ - Calls ServerSupportFunction with HSE_REQ_MAP_URL_TO_PATH - -Args: - - - -Returns: - - None - - """ - ... - - def DoneWithSession(self, status: Any) -> None: - """ - Calls ServerSupportFunction with HSE_REQ_DONE_WITH_SESSION - -Args: - - status(Any):An optional status. HSE_STATUS_SUCCESS_AND_KEEP_CONN is supported by IIS to keep the connection alive. - -Returns: - - None - - """ - ... - - def Redirect(self, url: str) -> None: - """ - Calls ServerSupportFunction with HSE_REQ_SEND_URL_REDIRECT_RESP - -Args: - - url(str):The URL to redirect to - -Returns: - - None - - """ - ... - - def IsKeepAlive(self) -> None: - """ - None - -Args: - - - -Returns: - - None - - """ - ... - - def GetAnonymousToken(self, metabase_path: Union[Any, str]) -> Any: - """ - Calls ServerSupportFunction with HSE_REQ_GET_ANONYMOUS_TOKEN - -or HSE_REQ_GET_UNICODE_ANONYMOUS_TOKEN - -Args: - - metabase_path(Union[Any, str]): - -Returns: - - Any - - """ - ... - - def GetImpersonationToken(self) -> Any: - """ - Calls ServerSupportFunction with - -HSE_REQ_GET_IMPERSONATION_TOKEN - -Args: - - - -Returns: - - Any - - """ - ... - - def IsKeepConn(self) -> Any: - """ - Calls ServerSupportFunction with HSE_REQ_IS_KEEP_CONN - -Args: - - - -Returns: - - Any - - """ - ... - - def ExecURL( - self, - url: str, - method: str, - clientHeaders: str, - info: Any, - entity: Any, - flags: Any) -> Any: - """ - Calls ServerSupportFunction with HSE_REQ_EXEC_URL - -Args: - - url(str): - method(str): - clientHeaders(str): - info(Any):Must be None - entity(Any):Must be None - flags(Any):CommentsThis function is only available in IIS6 and later. - -Returns: - - Any - - """ - ... - - def GetExecURLStatus(self) -> Any: - """ - Calls ServerSupportFunction with HSE_REQ_GET_EXEC_URL_STATUS - -Args: - - - -Returns: - - 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) - - - """ - ... - - def IOCompletion(self, func: Any, arg: Any = None) -> Any: - """ - Set a callback that will be used for handling asynchronous I/O - -operations. - -Args: - - func(Any):The function to call, as described by the EXTENSION_CONTROL_BLOCK::IOCallback method. - arg(Any):Any object which will be supplied as an argument to the callback function.CommentsIf you call this multiple times, the previous callback will be discarded.A reference to the callback and args are held until EXTENSION_CONTROL_BLOCK::DoneWithSession is called. If the callback function fails, DoneWithSession(HSE_STATUS_ERROR) will automatically be called and no further callbacks for the ECB will be made. - -Returns: - - Any - - """ - ... - - def ReportUnhealthy(self, reason: str = None) -> Any: - """ - Calls ServerSupportFunction with HSE_REQ_REPORT_UNHEALTHY - -Args: - - reason(str):An optional reason to be written to the log. - -Returns: - - Any - - """ - ... - - def IOCallback(self, ecb: Any, arg: Any, cbIO: Any, dwError: Any) -> Any: - """ - A placeholder for a user-supplied callback function. - -Args: - - ecb(Any):The extension control block that is associated with the current, active request. - arg(Any):The user-supplied argument supplied to the EXTENSION_CONTROL_BLOCK::IOCompletion function. - cbIO(Any):An integer that contains the number of bytes of I/O in the last call. - dwError(Any):The error code returned.CommentsThis is not a function you can call, it describes the signature of the callback function supplied to the EXTENSION_CONTROL_BLOCK::IOCompletion function.Return ValueThe result of this function is ignored. - -Returns: - - Any:The error code returned.Comments - -This is not a function you can call, it describes the signature of - -the callback function supplied to the EXTENSION_CONTROL_BLOCK::IOCompletion - -function. -Return ValueThe result of this function is ignored. - - - """ - ... - - -class HSE_VERSION_INFO: - """An object used by ISAPI GetExtensionVersion""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def ExtensionDesc(self) -> str: - """The description of the extension.""" - ... - - -class HTTP_FILTER_AUTHENT: - """A Python representation of an ISAPI - -HTTP_FILTER_AUTHENT structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def User(self) -> str: - ... - - @property - def password(self) -> str: - ... - - -class HTTP_FILTER_CONTEXT: - """A Python representation of an ISAPI - -HTTP_FILTER_CONTEXT structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def Revision(self) -> Any: - """(read-only)""" - ... - - @property - def fIsSecurePort(self) -> Any: - """(read-only)""" - ... - - @property - def NotificationType(self) -> Any: - """(read-only)""" - ... - - @property - def FilterContext(self) -> Any: - """Any object you wish to associate with the request.""" - ... - - def GetData(self) -> Any: - """ - Obtains the data passed to - -The HttpFilterProc function. This is not techinally part of the - -HTTP_FILTER_CONTEXT structure, but packaged here for convenience. - -Args: - - - -Returns: - - Any:HTTP_FILTER_CONTEXT.GetData - -object = GetData()Obtains the data passed to - -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 - - - - -NotificationType - - -Result type - - - -SF_NOTIFY_URL_MAPHTTP_FILTER_URL_MAP -SF_NOTIFY_PREPROC_HEADERSHTTP_FILTER_PREPROC_HEADERS -SF_NOTIFY_LOGHTTP_FILTER_LOG -SF_NOTIFY_SEND_RAW_DATAHTTP_FILTER_RAW_DATA -SF_NOTIFY_READ_RAW_DATAHTTP_FILTER_RAW_DATA -SF_NOTIFY_AUTHENTICATIONHTTP_FILTER_AUTHENT - - - """ - ... - - def GetServerVariable(self, variable: str, default: Any) -> str: - """ - None - -Args: - - variable(str): - default(Any):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 begins with 'UNICODE_, in which case it is a unicode object - see the ISAPI docs for more details. - -Returns: - - 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 - -begins with 'UNICODE_, in which case it is a unicode object - see the - -ISAPI docs for more details. - - - """ - ... - - def WriteClient(self, data: str, reserverd: Any = 0) -> None: - """ - None - -Args: - - data(str): - reserverd(Any): - -Returns: - - None - - """ - ... - - def AddResponseHeaders(self, data: str, reserverd: Any = 0) -> None: - """ - None - -Args: - - data(str): - reserverd(Any): - -Returns: - - None - - """ - ... - - def SendResponseHeader(self, status: str, header: str) -> None: - """ - None - -Args: - - status(str): - header(str): - -Returns: - - None - - """ - ... - - def DisableNotifications(self, flags: Any) -> None: - """ - None - -Args: - - flags(Any): - -Returns: - - None - - """ - ... - - -class HTTP_FILTER_LOG: - """A Python representation of an ISAPI - -HTTP_FILTER_LOG structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def ClientHostName(self) -> str: - ... - - @property - def ClientUserName(self) -> str: - ... - - @property - def ServerName(self) -> str: - ... - - @property - def Operation(self) -> str: - ... - - @property - def Target(self) -> str: - ... - - @property - def Parameters(self) -> str: - ... - - @property - def HttpStatus(self) -> Any: - ... - - -class HTTP_FILTER_PREPROC_HEADERS: - """A Python representation of an ISAPI - -HTTP_FILTER_PREPROC_HEADERS structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - def GetHeader(self, header: str, default: Any) -> str: - """ - None - -Args: - - header(str): - default(Any):If specified, this will be returned on error. - -Returns: - - str - - """ - ... - - def SetHeader(self, name: str, val: str) -> None: - """ - None - -Args: - - name(str): - val(str): - -Returns: - - None - - """ - ... - - def AddHeader(self) -> None: - """ - None - -Args: - - - -Returns: - - None - - """ - ... - - -class HTTP_FILTER_RAW_DATA: - """A Python representation of an ISAPI - -HTTP_FILTER_RAW_DATA structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def InData(self) -> str: - ... - - -class HTTP_FILTER_URL_MAP: - """A Python representation of an ISAPI - -HTTP_FILTER_URL_MAP structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def URL(self) -> str: - ... - - @property - def PhysicalPath(self) -> str: - ... - - -class HTTP_FILTER_VERSION: - """A Python interface to the ISAPI HTTP_FILTER_VERSION - -structure.""" - - def __new__(cls): - raise Exception('This class just for typing, can not be instanced!') - - @property - def ServerFilterVersion(self) -> Any: - """(read-only)""" - ... - - @property - def FilterVersion(self) -> Any: - ... - - @property - def Flags(self) -> Any: - ... - - @property - def FilterDesc(self) -> str: - ... From 4f20ef11e217cbad45453bb3d9b48cd48eb183b9 Mon Sep 17 00:00:00 2001 From: Avasam Date: Wed, 29 Dec 2021 18:17:15 -0500 Subject: [PATCH 038/137] Turn off pyright(reportFunctionMemberAccess) in favor of pylint(no-member) --- src/capture_windows.py | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/src/capture_windows.py b/src/capture_windows.py index de68ad32..586c9b34 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -1,18 +1,17 @@ from __future__ import annotations -from typing import Optional, TypedDict, cast import ctypes import ctypes.wintypes -from PyQt6 import QtCore, QtGui -from PyQt6.QtWidgets import QLabel +from typing import Optional, TypedDict, cast import cv2 import numpy as np +import pywintypes import win32con import win32ui -import pywintypes +from PyQt6 import QtCore, QtGui +from PyQt6.QtWidgets import QLabel from win32 import win32gui -from win32typing import PyCBitmap, PyCDC # This is an undocumented nFlag value for PrintWindow PW_RENDERFULLCONTENT = 0x00000002 @@ -44,15 +43,15 @@ def capture_region(hwnd: int, selection: Region, print_window: bool): # If the window closes while it's being manipulated, it could cause a crash try: - window_dc: int = win32gui.GetWindowDC(hwnd) - dc_object: PyCDC = win32ui.CreateDCFromHandle(window_dc) + window_dc = win32gui.GetWindowDC(hwnd) + dc_object = win32ui.CreateDCFromHandle(window_dc) # Causes a 10-15x performance drop. But allows recording hardware accelerated windows if print_window: ctypes.windll.user32.PrintWindow(hwnd, dc_object.GetSafeHdc(), PW_RENDERFULLCONTENT) compatible_dc = dc_object.CreateCompatibleDC() - bitmap: PyCBitmap = win32ui.CreateBitmap() + bitmap = win32ui.CreateBitmap() bitmap.CreateCompatibleBitmap(dc_object, selection["width"], selection["height"]) compatible_dc.SelectObject(bitmap) compatible_dc.BitBlt( From 00037711abf6b33692790517ee29a74d5d17f7f1 Mon Sep 17 00:00:00 2001 From: Avasam Date: Fri, 8 Apr 2022 12:21:14 -0400 Subject: [PATCH 039/137] Centralized qWait typing fix --- src/AutoSplit.py | 22 +++++++++------------- src/menu_bar.py | 2 +- src/screen_region.py | 9 ++++----- typings/PyQt6/QtTest.pyi | 11 +++++++++++ 4 files changed, 25 insertions(+), 19 deletions(-) create mode 100644 typings/PyQt6/QtTest.pyi diff --git a/src/AutoSplit.py b/src/AutoSplit.py index f72b0eaf..1b061bb3 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -20,7 +20,8 @@ import certifi import cv2 -from PyQt6 import QtCore, QtGui, QtTest +from PyQt6 import QtCore, QtGui +from PyQt6.QtTest import QTest from PyQt6.QtWidgets import QApplication, QFileDialog, QMainWindow, QMessageBox, QWidget from win32 import win32gui @@ -59,7 +60,7 @@ def excepthook(exception_type: type[BaseException], exception: BaseException, _t return excepthook -class AutoSplit(QMainWindow, design.Ui_main_window): +class AutoSplit(QMainWindow, design.Ui_MainWindow): myappid = f"Toufool.AutoSplit.v{VERSION}" ctypes.windll.shell32.SetCurrentProcessExplicitAppUserModelID(myappid) @@ -220,7 +221,7 @@ def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-man self.show() - # Needs to be after Ui_main_window.show() to be shown overtop + # Needs to be after Ui_MainWindow.show() to be shown overtop if self.action_check_for_updates_on_open.isChecked(): check_for_updates(self, check_on_open=True) @@ -344,13 +345,11 @@ def __start_image_function(self): delay_time_left = start_delay - (time() - delay_start_time) self.current_split_image.setText( f"Delayed Before Starting:\n {seconds_remaining_text(delay_time_left)}") - # Email sent to pyqt@riverbankcomputing.com - QtTest.QTest.qWait(1) # type: ignore + QTest.qWait(1) self.start_image_status_value_label.setText("started") send_command(self, "start") - # Email sent to pyqt@riverbankcomputing.com - QtTest.QTest.qWait(int(1 / self.settings_dict["fps_limit"])) # type: ignore + QTest.qWait(int(1 / self.settings_dict["fps_limit"])) self.start_auto_splitter() # update x, y, width, height when spinbox values are changed @@ -647,8 +646,7 @@ def __similarity_threshold_loop(self, number_of_split_images: int, dummy_splits_ break if not self.split_below_threshold: self.split_below_threshold = True - # Email sent to pyqt@riverbankcomputing.com - QtTest.QTest.qWait(wait_delta) # type: ignore + QTest.qWait(wait_delta) continue elif ( # pylint: disable=confusing-consecutive-elif @@ -656,8 +654,7 @@ def __similarity_threshold_loop(self, number_of_split_images: int, dummy_splits_ self.split_below_threshold = False break - # Email sent to pyqt@riverbankcomputing.com - QtTest.QTest.qWait(wait_delta) # type: ignore + QTest.qWait(wait_delta) def __pause_loop(self, stop_time: float, message: str): """ @@ -688,8 +685,7 @@ def __pause_loop(self, stop_time: float, message: str): self.current_split_image.setText(f"{message} {seconds_remaining_text(stop_time - time_delta)}") - # Email sent to pyqt@riverbankcomputing.com - QtTest.QTest.qWait(1) # type: ignore + QTest.qWait(1) return False def gui_changes_on_start(self): diff --git a/src/menu_bar.py b/src/menu_bar.py index 6402ffe2..22c16caf 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -38,7 +38,7 @@ def open_about(autosplit: AutoSplit): class __UpdateCheckerWidget(QtWidgets.QWidget, update_checker.Ui_UpdateChecker): - def __init__(self, latest_version: str, design_window: design.Ui_main_window, check_on_open: bool = False): + def __init__(self, latest_version: str, design_window: design.Ui_MainWindow, check_on_open: bool = False): super().__init__() self.setupUi(self) self.current_version_number_label.setText(VERSION) diff --git a/src/screen_region.py b/src/screen_region.py index a3c348a3..911a870c 100644 --- a/src/screen_region.py +++ b/src/screen_region.py @@ -9,7 +9,8 @@ import cv2 import numpy as np -from PyQt6 import QtCore, QtGui, QtTest, QtWidgets +from PyQt6 import QtCore, QtGui, QtWidgets +from PyQt6.QtTest import QTest from win32 import win32gui from win32con import GA_ROOT, MAXBYTE, SM_XVIRTUALSCREEN, SM_YVIRTUALSCREEN, SM_CXVIRTUALSCREEN, SM_CYVIRTUALSCREEN @@ -35,8 +36,7 @@ def select_region(autosplit: AutoSplit): y = selector.y() if width > 0 and height > 0: break - # Email sent to pyqt@riverbankcomputing.com - QtTest.QTest.qWait(1) # type: ignore + QTest.qWait(1) del selector hwnd, window_text = __get_window_from_point(x, y) @@ -66,8 +66,7 @@ def select_window(autosplit: AutoSplit): y = selector.y() if x and y: break - # Email sent to pyqt@riverbankcomputing.com - QtTest.QTest.qWait(1) # type: ignore + QTest.qWait(1) del selector hwnd, window_text = __get_window_from_point(x, y) diff --git a/typings/PyQt6/QtTest.pyi b/typings/PyQt6/QtTest.pyi new file mode 100644 index 00000000..4602e9be --- /dev/null +++ b/typings/PyQt6/QtTest.pyi @@ -0,0 +1,11 @@ +import typing +import PyQt6.sip + + +class QTest(PyQt6.sip.simplewrapper): + # Email sent to pyqt@riverbankcomputing.com + @typing.overload + @staticmethod + def qWait(ms: int) -> None: ... + @typing.overload + def qWait(self, ms: int) -> None: ... From 74b58e81851018cbd3f78dff4139b54ebb9db315 Mon Sep 17 00:00:00 2001 From: Avasam Date: Fri, 8 Apr 2022 12:47:06 -0400 Subject: [PATCH 040/137] Autosort imports --- .flake8 | 3 +- PyInstaller/hooks/hook-cv2.py | 2 +- scripts/requirements.txt | 4 +- src/AutoControlledWorker.py | 7 +- src/AutoSplitImage.py | 15 +- src/capture_windows.py | 7 - src/compare.py | 6 +- src/error_messages.py | 2 +- src/hotkeys.py | 11 +- src/menu_bar.py | 10 +- src/screen_region.py | 12 +- src/split_parser.py | 6 +- typings/PyQt6/QtTest.pyi | 4 +- typings/cv2-stubs/__init__.pyi | 810 ++++----------------------------- typings/keyboard/__init__.pyi | 6 +- typings/keyboard/_generic.pyi | 3 +- 16 files changed, 129 insertions(+), 779 deletions(-) diff --git a/.flake8 b/.flake8 index 2616ddc5..3d314775 100644 --- a/.flake8 +++ b/.flake8 @@ -5,14 +5,13 @@ max-line-length=120 exclude=src/gen/, typings/cv2-stubs/__init__.pyi ignore= W503, ; Linebreak before binary operator - Y015, ; Allow default value other than "..." E402, ; Allow imports at the bottom of file Y026, ; Not using typing_extensions per-file-ignores= ; Docstrings in type stubs ; Function bodys contain other than just ... (eg: raise) ; Single quote docstrings - typings/cv2-stubs/__init__.pyi: Q000,N8, E704,E501, Y021,Y010,Q002 + typings/cv2-stubs/__init__.pyi: Q000,E704,E501,N8, Y021,Y010,Q002 ; Quotes ; Allow ... on same line as def diff --git a/PyInstaller/hooks/hook-cv2.py b/PyInstaller/hooks/hook-cv2.py index 7293494f..620319d3 100644 --- a/PyInstaller/hooks/hook-cv2.py +++ b/PyInstaller/hooks/hook-cv2.py @@ -12,7 +12,7 @@ https://github.com/pyinstaller/pyinstaller-hooks-contrib/blob/master/src/_pyinstaller_hooks_contrib/hooks/stdhooks/hook-cv2.py """ -from PyInstaller.utils.hooks import collect_dynamic_libs, collect_data_files +from PyInstaller.utils.hooks import collect_data_files, collect_dynamic_libs hiddenimports = ["numpy"] diff --git a/scripts/requirements.txt b/scripts/requirements.txt index 8e05c0a2..16e030d0 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -24,11 +24,13 @@ requests certifi toml # -# Linting and Types +# Linting, formatters and Types bandit +isort flake8 flake8-pyi flake8-quotes +flake8-isort pylint>=2.13 git+https://github.com/Avasam/pywin32-stubs.git#egg=pywin32-stubs # https://github.com/kaluluosi/pywin32-stubs/pull/4 simplejson diff --git a/src/AutoControlledWorker.py b/src/AutoControlledWorker.py index 16f85b96..5b3238c1 100644 --- a/src/AutoControlledWorker.py +++ b/src/AutoControlledWorker.py @@ -1,12 +1,15 @@ from __future__ import annotations + from typing import TYPE_CHECKING -if TYPE_CHECKING: - from AutoSplit import AutoSplit + from PyQt6 import QtCore import error_messages import user_profile +if TYPE_CHECKING: + from AutoSplit import AutoSplit + class AutoControlledWorker(QtCore.QObject): def __init__(self, autosplit: AutoSplit): diff --git a/src/AutoSplitImage.py b/src/AutoSplitImage.py index d441e2f1..712ef65b 100644 --- a/src/AutoSplitImage.py +++ b/src/AutoSplitImage.py @@ -1,17 +1,20 @@ from __future__ import annotations -from enum import Enum import os -from typing import Optional, Union, TYPE_CHECKING -if TYPE_CHECKING: - from AutoSplit import AutoSplit +from enum import Enum +from typing import TYPE_CHECKING, Optional, Union import cv2 import numpy as np from win32con import MAXBYTE + import error_messages from compare import check_if_image_has_transparency, compare_histograms, compare_l2_norm, compare_phash +from split_parser import (comparison_method_from_filename, delay_time_from_filename, flags_from_filename, + loop_from_filename, pause_from_filename, threshold_from_filename) +if TYPE_CHECKING: + from AutoSplit import AutoSplit # Resize to these width and height so that FPS performance increases COMPARISON_RESIZE_WIDTH = 320 @@ -138,7 +141,3 @@ def compare_with_capture( if comparison_method == 2: return compare_phash(self.bytes, capture, self.mask) return 0.0 - - -from split_parser import comparison_method_from_filename, delay_time_from_filename, flags_from_filename, \ - loop_from_filename, pause_from_filename, threshold_from_filename diff --git a/src/capture_windows.py b/src/capture_windows.py index 586c9b34..7aba513b 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -17,13 +17,6 @@ PW_RENDERFULLCONTENT = 0x00000002 -# @dataclass -# class Region(): -# def __init__(self, x: int, y: int, width: int, height: int): -# self.x = x -# self.y = y -# self.width = width -# self.height = height class Region(TypedDict): x: int y: int diff --git a/src/compare.py b/src/compare.py index a5d0ca53..b9b31ed3 100644 --- a/src/compare.py +++ b/src/compare.py @@ -1,10 +1,12 @@ from __future__ import annotations + from typing import Optional -from PIL import Image -from win32con import MAXBYTE + import cv2 import imagehash # https://github.com/JohannesBuchner/imagehash/issues/151 import numpy as np +from PIL import Image +from win32con import MAXBYTE MAXRANGE = MAXBYTE + 1 channels = [0, 1, 2] diff --git a/src/error_messages.py b/src/error_messages.py index 4eb424b0..2eac0fcc 100644 --- a/src/error_messages.py +++ b/src/error_messages.py @@ -1,5 +1,5 @@ -# Error messages import traceback + from PyQt6 import QtCore, QtWidgets diff --git a/src/hotkeys.py b/src/hotkeys.py index 9d7c5731..7d1a0e38 100644 --- a/src/hotkeys.py +++ b/src/hotkeys.py @@ -1,14 +1,15 @@ from __future__ import annotations -from typing import Literal, Optional, TYPE_CHECKING, Union -from collections.abc import Callable - -if TYPE_CHECKING: - from AutoSplit import AutoSplit import threading +from collections.abc import Callable +from typing import TYPE_CHECKING, Literal, Optional, Union import keyboard # https://github.com/boppreh/keyboard/issues/505 import pyautogui # https://github.com/asweigart/pyautogui/issues/645 + +if TYPE_CHECKING: + from AutoSplit import AutoSplit + # While not usually recommended, we don't manipulate the mouse, and we don't want the extra delay pyautogui.FAILSAFE = False diff --git a/src/menu_bar.py b/src/menu_bar.py index 22c16caf..5a72b052 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -1,23 +1,23 @@ from __future__ import annotations -from typing import TYPE_CHECKING, Any - -if TYPE_CHECKING: - from AutoSplit import AutoSplit import webbrowser +from typing import TYPE_CHECKING, Any import requests -from simplejson.errors import JSONDecodeError from packaging import version from PyQt6 import QtWidgets from PyQt6.QtCore import QThread from requests.exceptions import RequestException +from simplejson.errors import JSONDecodeError import error_messages import user_profile from gen import about, design, resources_rc, settings as settings_ui, update_checker # noqa: F401 from hotkeys import set_hotkey +if TYPE_CHECKING: + from AutoSplit import AutoSplit + # AutoSplit Version number VERSION = "1.6.1" diff --git a/src/screen_region.py b/src/screen_region.py index 911a870c..bbfb8410 100644 --- a/src/screen_region.py +++ b/src/screen_region.py @@ -1,22 +1,22 @@ from __future__ import annotations -from typing import cast, TYPE_CHECKING -if TYPE_CHECKING: - from AutoSplit import AutoSplit -import os import ctypes import ctypes.wintypes -import cv2 +import os +from typing import TYPE_CHECKING, cast +import cv2 import numpy as np from PyQt6 import QtCore, QtGui, QtWidgets from PyQt6.QtTest import QTest from win32 import win32gui -from win32con import GA_ROOT, MAXBYTE, SM_XVIRTUALSCREEN, SM_YVIRTUALSCREEN, SM_CXVIRTUALSCREEN, SM_CYVIRTUALSCREEN +from win32con import GA_ROOT, MAXBYTE, SM_CXVIRTUALSCREEN, SM_CYVIRTUALSCREEN, SM_XVIRTUALSCREEN, SM_YVIRTUALSCREEN import capture_windows import error_messages +if TYPE_CHECKING: + from AutoSplit import AutoSplit WINDOWS_SHADOW_SIZE = 8 WINDOWS_TOPBAR_SIZE = 24 diff --git a/src/split_parser.py b/src/split_parser.py index afe44fcf..f46fe48f 100644 --- a/src/split_parser.py +++ b/src/split_parser.py @@ -1,13 +1,13 @@ from __future__ import annotations -from typing import TYPE_CHECKING, TypeVar -if TYPE_CHECKING: - from AutoSplit import AutoSplit import os +from typing import TYPE_CHECKING, TypeVar import error_messages from AutoSplitImage import AutoSplitImage, ImageType +if TYPE_CHECKING: + from AutoSplit import AutoSplit [DUMMY_FLAG, BELOW_FLAG, diff --git a/typings/PyQt6/QtTest.pyi b/typings/PyQt6/QtTest.pyi index 4602e9be..83a6c435 100644 --- a/typings/PyQt6/QtTest.pyi +++ b/typings/PyQt6/QtTest.pyi @@ -1,9 +1,11 @@ import typing + import PyQt6.sip +# Email sent to pyqt@riverbankcomputing.com + class QTest(PyQt6.sip.simplewrapper): - # Email sent to pyqt@riverbankcomputing.com @typing.overload @staticmethod def qWait(ms: int) -> None: ... diff --git a/typings/cv2-stubs/__init__.pyi b/typings/cv2-stubs/__init__.pyi index a44e3cc6..1a6f16a2 100644 --- a/typings/cv2-stubs/__init__.pyi +++ b/typings/cv2-stubs/__init__.pyi @@ -28,14 +28,7 @@ AKAZE_DESCRIPTOR_MLDB: int AKAZE_DESCRIPTOR_MLDB_UPRIGHT: int -def AKAZE_create( - descriptor_type=..., - descriptor_size=..., - descriptor_channels=..., - threshold=..., - nOctaves=..., - nOctaveLayers=..., - diffusivity=... +def AKAZE_create(descriptor_type=..., descriptor_size=..., descriptor_channels=..., threshold=..., nOctaves=..., nOctaveLayers=..., diffusivity=... ) -> typing.Any: 'AKAZE_create([, descriptor_type[, descriptor_size[, descriptor_channels[, threshold[, nOctaves[, nOctaveLayers[, diffusivity]]]]]]]) -> retval\n. @brief The AKAZE constructor\n. \n. @param descriptor_type Type of the extracted descriptor: DESCRIPTOR_KAZE,\n. DESCRIPTOR_KAZE_UPRIGHT, DESCRIPTOR_MLDB or DESCRIPTOR_MLDB_UPRIGHT.\n. @param descriptor_size Size of the descriptor in bits. 0 -\\> Full size\n. @param descriptor_channels Number of channels in the descriptor (1, 2, 3)\n. @param threshold Detector response threshold to accept point\n. @param nOctaves Maximum octave evolution of the image\n. @param nOctaveLayers Default number of sublevels per scale level\n. @param diffusivity Diffusivity type. DIFF_PM_G1, DIFF_PM_G2, DIFF_WEICKERT or\n. DIFF_CHARBONNIER' ... @@ -1016,15 +1009,7 @@ FORMATTER_FMT_PYTHON: int FarnebackOpticalFlow = _mod_cv2.FarnebackOpticalFlow -def FarnebackOpticalFlow_create( - numLevels=..., - pyrScale=..., - fastPyramids=..., - winSize=..., - numIters=..., - polyN=..., - polySigma=..., - flags: int = ...) -> typing.Any: +def FarnebackOpticalFlow_create(numLevels=..., pyrScale=..., fastPyramids=..., winSize=..., numIters=..., polyN=..., polySigma=..., flags: int = ...) -> typing.Any: 'FarnebackOpticalFlow_create([, numLevels[, pyrScale[, fastPyramids[, winSize[, numIters[, polyN[, polySigma[, flags]]]]]]]]) -> retval\n.' ... @@ -1102,13 +1087,7 @@ GEMM_3_T: int GFTTDetector = _mod_cv2.GFTTDetector -def GFTTDetector_create( - maxCorners=..., - qualityLevel=..., - minDistance=..., - blockSize=..., - useHarrisDetector=..., - k=...) -> typing.Any: +def GFTTDetector_create(maxCorners=..., qualityLevel=..., minDistance=..., blockSize=..., useHarrisDetector=..., k=...) -> typing.Any: 'GFTTDetector_create([, maxCorners[, qualityLevel[, minDistance[, blockSize[, useHarrisDetector[, k]]]]]]) -> retval\n. \n\n\n\nGFTTDetector_create(maxCorners, qualityLevel, minDistance, blockSize, gradiantSize[, useHarrisDetector[, k]]) -> retval\n.' ... @@ -1156,30 +1135,12 @@ HOUGH_PROBABILISTIC: int HOUGH_STANDARD: int -def HoughCircles( - image: ndarray, - method: int, - dp, - minDist, - circles=..., - param1=..., - param2=..., - minRadius=..., - maxRadius=...) -> typing.Any: +def HoughCircles(image: ndarray, method: int, dp, minDist, circles=..., param1=..., param2=..., minRadius=..., maxRadius=...) -> typing.Any: 'HoughCircles(image, method, dp, minDist[, circles[, param1[, param2[, minRadius[, maxRadius]]]]]) -> circles\n. @brief Finds circles in a grayscale image using the Hough transform.\n. \n. The function finds circles in a grayscale image using a modification of the Hough transform.\n. \n. Example: :\n. @include snippets/imgproc_HoughLinesCircles.cpp\n. \n. @note Usually the function detects the centers of circles well. However, it may fail to find correct\n. radii. You can assist to the function by specifying the radius range ( minRadius and maxRadius ) if\n. you know it. Or, in the case of #HOUGH_GRADIENT method you may set maxRadius to a negative number\n. to return centers only without radius search, and find the correct radius using an additional procedure.\n. \n. It also helps to smooth image a bit unless it\'s already soft. For example,\n. GaussianBlur() with 7x7 kernel and 1.5x1.5 sigma or similar blurring may help.\n. \n. @param image 8-bit, single-channel, grayscale input image.\n. @param circles Output vector of found circles. Each vector is encoded as 3 or 4 element\n. floating-point vector \\f$(x, y, radius)\\f$ or \\f$(x, y, radius, votes)\\f$ .\n. @param method Detection method, see #HoughModes. The available methods are #HOUGH_GRADIENT and #HOUGH_GRADIENT_ALT.\n. @param dp Inverse ratio of the accumulator resolution to the image resolution. For example, if\n. dp=1 , the accumulator has the same resolution as the input image. If dp=2 , the accumulator has\n. half as big width and height. For #HOUGH_GRADIENT_ALT the recommended value is dp=1.5,\n. unless some small very circles need to be detected.\n. @param minDist Minimum distance between the centers of the detected circles. If the parameter is\n. too small, multiple neighbor circles may be falsely detected in addition to a true one. If it is\n. too large, some circles may be missed.\n. @param param1 First method-specific parameter. In case of #HOUGH_GRADIENT and #HOUGH_GRADIENT_ALT,\n. it is the higher threshold of the two passed to the Canny edge detector (the lower one is twice smaller).\n. Note that #HOUGH_GRADIENT_ALT uses #Scharr algorithm to compute image derivatives, so the threshold value\n. shough normally be higher, such as 300 or normally exposed and contrasty images.\n. @param param2 Second method-specific parameter. In case of #HOUGH_GRADIENT, it is the\n. accumulator threshold for the circle centers at the detection stage. The smaller it is, the more\n. false circles may be detected. Circles, corresponding to the larger accumulator values, will be\n. returned first. In the case of #HOUGH_GRADIENT_ALT algorithm, this is the circle "perfectness" measure.\n. The closer it to 1, the better shaped circles algorithm selects. In most cases 0.9 should be fine.\n. If you want get better detection of small circles, you may decrease it to 0.85, 0.8 or even less.\n. But then also try to limit the search range [minRadius, maxRadius] to avoid many false circles.\n. @param minRadius Minimum circle radius.\n. @param maxRadius Maximum circle radius. If <= 0, uses the maximum image dimension. If < 0, #HOUGH_GRADIENT returns\n. centers without finding the radius. #HOUGH_GRADIENT_ALT always computes circle radiuses.\n. \n. @sa fitEllipse, minEnclosingCircle' ... -def HoughLines( - image: ndarray, - rho, - theta, - threshold, - lines=..., - srn=..., - stn=..., - min_theta=..., - max_theta=...) -> typing.Any: +def HoughLines(image: ndarray, rho, theta, threshold, lines=..., srn=..., stn=..., min_theta=..., max_theta=...) -> typing.Any: 'HoughLines(image, rho, theta, threshold[, lines[, srn[, stn[, min_theta[, max_theta]]]]]) -> lines\n. @brief Finds lines in a binary image using the standard Hough transform.\n. \n. The function implements the standard or standard multi-scale Hough transform algorithm for line\n. detection. See for a good explanation of Hough\n. transform.\n. \n. @param image 8-bit, single-channel binary source image. The image may be modified by the function.\n. @param lines Output vector of lines. Each line is represented by a 2 or 3 element vector\n. \\f$(\\rho, \\theta)\\f$ or \\f$(\\rho, \\theta, \\textrm{votes})\\f$ . \\f$\\rho\\f$ is the distance from the coordinate origin \\f$(0,0)\\f$ (top-left corner of\n. the image). \\f$\\theta\\f$ is the line rotation angle in radians (\n. \\f$0 \\sim \\textrm{vertical line}, \\pi/2 \\sim \\textrm{horizontal line}\\f$ ).\n. \\f$\\textrm{votes}\\f$ is the value of accumulator.\n. @param rho Distance resolution of the accumulator in pixels.\n. @param theta Angle resolution of the accumulator in radians.\n. @param threshold Accumulator threshold parameter. Only those lines are returned that get enough\n. votes ( \\f$>\\texttt{threshold}\\f$ ).\n. @param srn For the multi-scale Hough transform, it is a divisor for the distance resolution rho .\n. The coarse accumulator distance resolution is rho and the accurate accumulator resolution is\n. rho/srn . If both srn=0 and stn=0 , the classical Hough transform is used. Otherwise, both these\n. parameters should be positive.\n. @param stn For the multi-scale Hough transform, it is a divisor for the distance resolution theta.\n. @param min_theta For standard and multi-scale Hough transform, minimum angle to check for lines.\n. Must fall between 0 and max_theta.\n. @param max_theta For standard and multi-scale Hough transform, maximum angle to check for lines.\n. Must fall between min_theta and CV_PI.' ... @@ -1189,17 +1150,7 @@ def HoughLinesP(image: ndarray, rho, theta, threshold, lines=..., minLineLength= ... -def HoughLinesPointSet( - _point, - lines_max, - threshold, - min_rho, - max_rho, - rho_step, - min_theta, - max_theta, - theta_step, - _lines=...) -> typing.Any: +def HoughLinesPointSet(_point, lines_max, threshold, min_rho, max_rho, rho_step, min_theta, max_theta, theta_step, _lines=...) -> typing.Any: "HoughLinesPointSet(_point, lines_max, threshold, min_rho, max_rho, rho_step, min_theta, max_theta, theta_step[, _lines]) -> _lines\n. @brief Finds lines in a set of points using the standard Hough transform.\n. \n. The function finds lines in a set of points using a modification of the Hough transform.\n. @include snippets/imgproc_HoughLinesPointSet.cpp\n. @param _point Input vector of points. Each vector must be encoded as a Point vector \\f$(x,y)\\f$. Type must be CV_32FC2 or CV_32SC2.\n. @param _lines Output vector of found lines. Each vector is encoded as a vector \\f$(votes, rho, theta)\\f$.\n. The larger the value of 'votes', the higher the reliability of the Hough line.\n. @param lines_max Max count of hough lines.\n. @param threshold Accumulator threshold parameter. Only those lines are returned that get enough\n. votes ( \\f$>\\texttt{threshold}\\f$ )\n. @param min_rho Minimum Distance value of the accumulator in pixels.\n. @param max_rho Maximum Distance value of the accumulator in pixels.\n. @param rho_step Distance resolution of the accumulator in pixels.\n. @param min_theta Minimum angle value of the accumulator in radians.\n. @param max_theta Maximum angle value of the accumulator in radians.\n. @param theta_step Angle resolution of the accumulator in radians." ... @@ -1276,13 +1227,7 @@ KAZE_DIFF_PM_G2: int KAZE_DIFF_WEICKERT: int -def KAZE_create( - extended=..., - upright=..., - threshold=..., - nOctaves=..., - nOctaveLayers=..., - diffusivity=...) -> typing.Any: +def KAZE_create(extended=..., upright=..., threshold=..., nOctaves=..., nOctaveLayers=..., diffusivity=...) -> typing.Any: 'KAZE_create([, extended[, upright[, threshold[, nOctaves[, nOctaveLayers[, diffusivity]]]]]]) -> retval\n. @brief The KAZE constructor\n. \n. @param extended Set to enable extraction of extended (128-byte) descriptor.\n. @param upright Set to enable use of upright descriptors (non rotation-invariant).\n. @param threshold Detector response threshold to accept point\n. @param nOctaves Maximum octave evolution of the image\n. @param nOctaveLayers Default number of sublevels per scale level\n. @param diffusivity Diffusivity type. DIFF_PM_G1, DIFF_PM_G2, DIFF_WEICKERT or\n. DIFF_CHARBONNIER' ... @@ -1359,16 +1304,7 @@ MOTION_TRANSLATION: int MSER = _mod_cv2.MSER -def MSER_create( - _delta=..., - _min_area=..., - _max_area=..., - _max_variation=..., - _min_diversity=..., - _max_evolution=..., - _area_threshold=..., - _min_margin=..., - _edge_blur_size=...) -> typing.Any: +def MSER_create(_delta=..., _min_area=..., _max_area=..., _max_variation=..., _min_diversity=..., _max_evolution=..., _area_threshold=..., _min_margin=..., _edge_blur_size=...) -> typing.Any: 'MSER_create([, _delta[, _min_area[, _max_area[, _max_variation[, _min_diversity[, _max_evolution[, _area_threshold[, _min_margin[, _edge_blur_size]]]]]]]]]) -> retval\n. @brief Full constructor for %MSER detector\n. \n. @param _delta it compares \\f$(size_{i}-size_{i-delta})/size_{i-delta}\\f$\n. @param _min_area prune the area which smaller than minArea\n. @param _max_area prune the area which bigger than maxArea\n. @param _max_variation prune the area have similar size to its children\n. @param _min_diversity for color image, trace back to cut off mser with diversity less than min_diversity\n. @param _max_evolution for color image, the evolution steps\n. @param _area_threshold for color image, the area threshold to cause re-initialize\n. @param _min_margin for color image, ignore too small margin\n. @param _edge_blur_size for color image, the aperture size for edge blur' ... @@ -1408,16 +1344,7 @@ ORB_FAST_SCORE: int ORB_HARRIS_SCORE: int -def ORB_create( - nfeatures=..., - scaleFactor=..., - nlevels=..., - edgeThreshold=..., - firstLevel=..., - WTA_K=..., - scoreType=..., - patchSize=..., - fastThreshold=...) -> typing.Any: +def ORB_create(nfeatures=..., scaleFactor=..., nlevels=..., edgeThreshold=..., firstLevel=..., WTA_K=..., scoreType=..., patchSize=..., fastThreshold=...) -> typing.Any: 'ORB_create([, nfeatures[, scaleFactor[, nlevels[, edgeThreshold[, firstLevel[, WTA_K[, scoreType[, patchSize[, fastThreshold]]]]]]]]]) -> retval\n. @brief The ORB constructor\n. \n. @param nfeatures The maximum number of features to retain.\n. @param scaleFactor Pyramid decimation ratio, greater than 1. scaleFactor==2 means the classical\n. pyramid, where each next level has 4x less pixels than the previous, but such a big scale factor\n. will degrade feature matching scores dramatically. On the other hand, too close to 1 scale factor\n. will mean that to cover certain scale range you will need more pyramid levels and so the speed\n. will suffer.\n. @param nlevels The number of pyramid levels. The smallest level will have linear size equal to\n. input_image_linear_size/pow(scaleFactor, nlevels - firstLevel).\n. @param edgeThreshold This is size of the border where the features are not detected. It should\n. roughly match the patchSize parameter.\n. @param firstLevel The level of pyramid to put source image to. Previous layers are filled\n. with upscaled source image.\n. @param WTA_K The number of points that produce each element of the oriented BRIEF descriptor. The\n. default value 2 means the BRIEF where we take a random point pair and compare their brightnesses,\n. so we get 0/1 response. Other possible values are 3 and 4. For example, 3 means that we take 3\n. random points (of course, those point coordinates are random, but they are generated from the\n. pre-defined seed, so each element of BRIEF descriptor is computed deterministically from the pixel\n. rectangle), find point of maximum brightness and output index of the winner (0, 1 or 2). Such\n. output will occupy 2 bits, and therefore it will need a special variant of Hamming distance,\n. denoted as NORM_HAMMING2 (2 bits per bin). When WTA_K=4, we take 4 random points to compute each\n. bin (that will also occupy 2 bits with possible values 0, 1, 2 or 3).\n. @param scoreType The default HARRIS_SCORE means that Harris algorithm is used to rank features\n. (the score is written to KeyPoint::score and is used to retain best nfeatures features);\n. FAST_SCORE is alternative value of the parameter that produces slightly less stable keypoints,\n. but it is a little faster to compute.\n. @param patchSize size of the patch used by the oriented BRIEF descriptor. Of course, on smaller\n. pyramid layers the perceived image area covered by a feature will be larger.\n. @param fastThreshold the fast threshold' ... @@ -1610,16 +1537,7 @@ def SimpleBlobDetector_create(parameters=...) -> typing.Any: ... -def Sobel( - src: ndarray, - ddepth, - dx, - dy, - dts: ndarray = ..., - ksize=..., - scale=..., - delta=..., - borderType=...) -> typing.Any: +def Sobel(src: ndarray, ddepth, dx, dy, dts: ndarray = ..., ksize=..., scale=..., delta=..., borderType=...) -> typing.Any: 'Sobel(src, ddepth, dx, dy[, dst[, ksize[, scale[, delta[, borderType]]]]]) -> dst\n. @brief Calculates the first, second, third, or mixed image derivatives using an extended Sobel operator.\n. \n. In all cases except one, the \\f$\\texttt{ksize} \\times \\texttt{ksize}\\f$ separable kernel is used to\n. calculate the derivative. When \\f$\\texttt{ksize = 1}\\f$, the \\f$3 \\times 1\\f$ or \\f$1 \\times 3\\f$\n. kernel is used (that is, no Gaussian smoothing is done). `ksize = 1` can only be used for the first\n. or the second x- or y- derivatives.\n. \n. There is also the special value `ksize = #FILTER_SCHARR (-1)` that corresponds to the \\f$3\\times3\\f$ Scharr\n. filter that may give more accurate results than the \\f$3\\times3\\f$ Sobel. The Scharr aperture is\n. \n. \\f[\\vecthreethree{-3}{0}{3}{-10}{0}{10}{-3}{0}{3}\\f]\n. \n. for the x-derivative, or transposed for the y-derivative.\n. \n. The function calculates an image derivative by convolving the image with the appropriate kernel:\n. \n. \\f[\\texttt{dst} = \\frac{\\partial^{xorder+yorder} \\texttt{src}}{\\partial x^{xorder} \\partial y^{yorder}}\\f]\n. \n. The Sobel operators combine Gaussian smoothing and differentiation, so the result is more or less\n. resistant to the noise. Most often, the function is called with ( xorder = 1, yorder = 0, ksize = 3)\n. or ( xorder = 0, yorder = 1, ksize = 3) to calculate the first x- or y- image derivative. The first\n. case corresponds to a kernel of:\n. \n. \\f[\\vecthreethree{-1}{0}{1}{-2}{0}{2}{-1}{0}{1}\\f]\n. \n. The second case corresponds to a kernel of:\n. \n. \\f[\\vecthreethree{-1}{-2}{-1}{0}{0}{0}{1}{2}{1}\\f]\n. \n. @param src input image.\n. @param dst output image of the same size and the same number of channels as src .\n. @param ddepth output image depth, see @ref filter_depths "combinations"; in the case of\n. 8-bit input images it will result in truncated derivatives.\n. @param dx order of the derivative x.\n. @param dy order of the derivative y.\n. @param ksize size of the extended Sobel kernel; it must be 1, 3, 5, or 7.\n. @param scale optional scale factor for the computed derivative values; by default, no scaling is\n. applied (see #getDerivKernels for details).\n. @param delta optional delta value that is added to the results prior to storing them in dst.\n. @param borderType pixel extrapolation method, see #BorderTypes. #BORDER_WRAP is not supported.\n. @sa Scharr, Laplacian, sepFilter2D, filter2D, GaussianBlur, cartToPolar' ... @@ -1632,12 +1550,7 @@ SparseOpticalFlow = _mod_cv2.SparseOpticalFlow SparsePyrLKOpticalFlow = _mod_cv2.SparsePyrLKOpticalFlow -def SparsePyrLKOpticalFlow_create( - winSize=..., - maxLevel=..., - crit=..., - flags: int = ..., - minEigThreshold=...) -> typing.Any: +def SparsePyrLKOpticalFlow_create(winSize=..., maxLevel=..., crit=..., flags: int = ..., minEigThreshold=...) -> typing.Any: 'SparsePyrLKOpticalFlow_create([, winSize[, maxLevel[, crit[, flags[, minEigThreshold]]]]]) -> retval\n.' ... @@ -1662,18 +1575,7 @@ StereoSGBM_MODE_SGBM: int StereoSGBM_MODE_SGBM_3WAY: int -def StereoSGBM_create( - minDisparity=..., - numDisparities=..., - blockSize=..., - P1=..., - P2=..., - disp12MaxDiff=..., - preFilterCap=..., - uniquenessRatio=..., - speckleWindowSize=..., - speckleRange=..., - mode=...) -> typing.Any: +def StereoSGBM_create(minDisparity=..., numDisparities=..., blockSize=..., P1=..., P2=..., disp12MaxDiff=..., preFilterCap=..., uniquenessRatio=..., speckleWindowSize=..., speckleRange=..., mode=...) -> typing.Any: 'StereoSGBM_create([, minDisparity[, numDisparities[, blockSize[, P1[, P2[, disp12MaxDiff[, preFilterCap[, uniquenessRatio[, speckleWindowSize[, speckleRange[, mode]]]]]]]]]]]) -> retval\n. @brief Creates StereoSGBM object\n. \n. @param minDisparity Minimum possible disparity value. Normally, it is zero but sometimes\n. rectification algorithms can shift images, so this parameter needs to be adjusted accordingly.\n. @param numDisparities Maximum disparity minus minimum disparity. The value is always greater than\n. zero. In the current implementation, this parameter must be divisible by 16.\n. @param blockSize Matched block size. It must be an odd number \\>=1 . Normally, it should be\n. somewhere in the 3..11 range.\n. @param P1 The first parameter controlling the disparity smoothness. See below.\n. @param P2 The second parameter controlling the disparity smoothness. The larger the values are,\n. the smoother the disparity is. P1 is the penalty on the disparity change by plus or minus 1\n. between neighbor pixels. P2 is the penalty on the disparity change by more than 1 between neighbor\n. pixels. The algorithm requires P2 \\> P1 . See stereo_match.cpp sample where some reasonably good\n. P1 and P2 values are shown (like 8\\*number_of_image_channels\\*blockSize\\*blockSize and\n. 32\\*number_of_image_channels\\*blockSize\\*blockSize , respectively).\n. @param disp12MaxDiff Maximum allowed difference (in integer pixel units) in the left-right\n. disparity check. Set it to a non-positive value to disable the check.\n. @param preFilterCap Truncation value for the prefiltered image pixels. The algorithm first\n. computes x-derivative at each pixel and clips its value by [-preFilterCap, preFilterCap] interval.\n. The result values are passed to the Birchfield-Tomasi pixel cost function.\n. @param uniquenessRatio Margin in percentage by which the best (minimum) computed cost function\n. value should "win" the second best value to consider the found match correct. Normally, a value\n. within the 5-15 range is good enough.\n. @param speckleWindowSize Maximum size of smooth disparity regions to consider their noise speckles\n. and invalidate. Set it to 0 to disable speckle filtering. Otherwise, set it somewhere in the\n. 50-200 range.\n. @param speckleRange Maximum disparity variation within each connected component. If you do speckle\n. filtering, set the parameter to a positive value, it will be implicitly multiplied by 16.\n. Normally, 1 or 2 is good enough.\n. @param mode Set it to StereoSGBM::MODE_HH to run the full-scale two-pass dynamic programming\n. algorithm. It will consume O(W\\*H\\*numDisparities) bytes, which is large for 640x480 stereo and\n. huge for HD-size pictures. By default, it is set to false .\n. \n. The first constructor initializes StereoSGBM with all the default parameters. So, you only have to\n. set StereoSGBM::numDisparities at minimum. The second constructor enables you to set each parameter\n. to a custom value.' ... @@ -1915,14 +1817,7 @@ def accumulateWeighted(src: ndarray, dts: ndarray, alpha, mask: ndarray = ...) - ... -def adaptiveThreshold( - src: ndarray, - maxValue, - adaptiveMethod, - thresholdType, - blockSize, - C, - dts: ndarray = ...) -> typing.Any: +def adaptiveThreshold(src: ndarray, maxValue, adaptiveMethod, thresholdType, blockSize, C, dts: ndarray = ...) -> typing.Any: 'adaptiveThreshold(src, maxValue, adaptiveMethod, thresholdType, blockSize, C[, dst]) -> dst\n. @brief Applies an adaptive threshold to an array.\n. \n. The function transforms a grayscale image to a binary image according to the formulae:\n. - **THRESH_BINARY**\n. \\f[dst(x,y) = \\fork{\\texttt{maxValue}}{if \\(src(x,y) > T(x,y)\\)}{0}{otherwise}\\f]\n. - **THRESH_BINARY_INV**\n. \\f[dst(x,y) = \\fork{0}{if \\(src(x,y) > T(x,y)\\)}{\\texttt{maxValue}}{otherwise}\\f]\n. where \\f$T(x,y)\\f$ is a threshold calculated individually for each pixel (see adaptiveMethod parameter).\n. \n. The function can process the image in-place.\n. \n. @param src Source 8-bit single-channel image.\n. @param dst Destination image of the same size and the same type as src.\n. @param maxValue Non-zero value assigned to the pixels for which the condition is satisfied\n. @param adaptiveMethod Adaptive thresholding algorithm to use, see #AdaptiveThresholdTypes.\n. The #BORDER_REPLICATE | #BORDER_ISOLATED is used to process boundaries.\n. @param thresholdType Thresholding type that must be either #THRESH_BINARY or #THRESH_BINARY_INV,\n. see #ThresholdTypes.\n. @param blockSize Size of a pixel neighborhood that is used to calculate a threshold value for the\n. pixel: 3, 5, 7, and so on.\n. @param C Constant subtracted from the mean or weighted mean (see the details below). Normally, it\n. is positive but may be zero or negative as well.\n. \n. @sa threshold, blur, GaussianBlur' ... @@ -1932,16 +1827,7 @@ def add(src1: ndarray, src2: ndarray, dts: ndarray = ..., mask: ndarray = ..., d ... -def addText( - img: ndarray, - text, - org, - nameFont, - pointSize=..., - color=..., - weight=..., - style=..., - spacing=...) -> typing.Any: +def addText(img: ndarray, text, org, nameFont, pointSize=..., color=..., weight=..., style=..., spacing=...) -> typing.Any: 'addText(img, text, org, nameFont[, pointSize[, color[, weight[, style[, spacing]]]]]) -> None\n. @brief Draws a text on the image.\n. \n. @param img 8-bit 3-channel image where the text should be drawn.\n. @param text Text to write on an image.\n. @param org Point(x,y) where the text should start on an image.\n. @param nameFont Name of the font. The name should match the name of a system font (such as\n. *Times*). If the font is not found, a default one is used.\n. @param pointSize Size of the font. If not specified, equal zero or negative, the point size of the\n. font is set to a system-dependent default value. Generally, this is 12 points.\n. @param color Color of the font in BGRA where A = 255 is fully transparent.\n. @param weight Font weight. Available operation flags are : cv::QtFontWeights You can also specify a positive integer for better control.\n. @param style Font style. Available operation flags are : cv::QtFontStyles\n. @param spacing Spacing between characters. It can be negative or positive.' ... @@ -1971,17 +1857,7 @@ def arrowedLine(img: ndarray, pt1, pt2, color, thickness=..., line_type=..., shi ... -def batchDistance( - src1: ndarray, - src2: ndarray, - dtype, - dist=..., - nidx=..., - normType: int = ..., - K=..., - mask: ndarray = ..., - update=..., - crosscheck=...) -> typing.Any: +def batchDistance(src1: ndarray, src2: ndarray, dtype, dist=..., nidx=..., normType: int = ..., K=..., mask: ndarray = ..., update=..., crosscheck=...) -> typing.Any: 'batchDistance(src1, src2, dtype[, dist[, nidx[, normType[, K[, mask[, update[, crosscheck]]]]]]]) -> dist, nidx\n. @brief naive nearest neighbor finder\n. \n. see http://en.wikipedia.org/wiki/Nearest_neighbor_search\n. @todo document' ... @@ -2036,26 +1912,12 @@ def boxPoints(box, points=...) -> typing.Any: ... -def buildOpticalFlowPyramid( - img: ndarray, - winSize, - maxLevel, - pyramid=..., - withDerivatives=..., - pyrBorder=..., - derivBorder=..., - tryReuseInputImage=...) -> typing.Any: +def buildOpticalFlowPyramid(img: ndarray, winSize, maxLevel, pyramid=..., withDerivatives=..., pyrBorder=..., derivBorder=..., tryReuseInputImage=...) -> typing.Any: 'buildOpticalFlowPyramid(img, winSize, maxLevel[, pyramid[, withDerivatives[, pyrBorder[, derivBorder[, tryReuseInputImage]]]]]) -> retval, pyramid\n. @brief Constructs the image pyramid which can be passed to calcOpticalFlowPyrLK.\n. \n. @param img 8-bit input image.\n. @param pyramid output pyramid.\n. @param winSize window size of optical flow algorithm. Must be not less than winSize argument of\n. calcOpticalFlowPyrLK. It is needed to calculate required padding for pyramid levels.\n. @param maxLevel 0-based maximal pyramid level number.\n. @param withDerivatives set to precompute gradients for the every pyramid level. If pyramid is\n. constructed without the gradients then calcOpticalFlowPyrLK will calculate them internally.\n. @param pyrBorder the border mode for pyramid layers.\n. @param derivBorder the border mode for gradients.\n. @param tryReuseInputImage put ROI of input image into the pyramid if possible. You can pass false\n. to force data copying.\n. @return number of levels in constructed pyramid. Can be less than maxLevel.' ... -def calcBackProject( - images: list[ndarray], - channels: list[int], - hist, - ranges: list[int], - scale, - dts: ndarray = ...) -> typing.Any: +def calcBackProject(images: list[ndarray], channels: list[int], hist, ranges: list[int], scale, dts: ndarray = ...) -> typing.Any: 'calcBackProject(images, channels, hist, ranges, scale[, dst]) -> dst\n. @overload' ... @@ -2065,124 +1927,42 @@ def calcCovarMatrix(samples, mean, flags: int, covar=..., ctype=...) -> typing.A ... -def calcHist( - images: list[ndarray], - channels: list[int], - mask: typing.Optional[ndarray], - histSize: list[int], - ranges: list[int], - hist=..., - accumulate=...) -> ndarray: +def calcHist(images: list[ndarray], channels: list[int], mask: typing.Optional[ndarray], histSize: list[int], ranges: list[int], hist=..., accumulate=...) -> ndarray: 'calcHist(images, channels, mask, histSize, ranges[, hist[, accumulate]]) -> hist\n. @overload' ... -def calcOpticalFlowFarneback( - prev, - next, - flow, - pyr_scale, - levels, - winsize, - iterations, - poly_n, - poly_sigma, - flags: int) -> typing.Any: +def calcOpticalFlowFarneback(prev, next, flow, pyr_scale, levels, winsize, iterations, poly_n, poly_sigma, flags: int) -> typing.Any: "calcOpticalFlowFarneback(prev, next, flow, pyr_scale, levels, winsize, iterations, poly_n, poly_sigma, flags) -> flow\n. @brief Computes a dense optical flow using the Gunnar Farneback's algorithm.\n. \n. @param prev first 8-bit single-channel input image.\n. @param next second input image of the same size and the same type as prev.\n. @param flow computed flow image that has the same size as prev and type CV_32FC2.\n. @param pyr_scale parameter, specifying the image scale (\\<1) to build pyramids for each image;\n. pyr_scale=0.5 means a classical pyramid, where each next layer is twice smaller than the previous\n. one.\n. @param levels number of pyramid layers including the initial image; levels=1 means that no extra\n. layers are created and only the original images are used.\n. @param winsize averaging window size; larger values increase the algorithm robustness to image\n. noise and give more chances for fast motion detection, but yield more blurred motion field.\n. @param iterations number of iterations the algorithm does at each pyramid level.\n. @param poly_n size of the pixel neighborhood used to find polynomial expansion in each pixel;\n. larger values mean that the image will be approximated with smoother surfaces, yielding more\n. robust algorithm and more blurred motion field, typically poly_n =5 or 7.\n. @param poly_sigma standard deviation of the Gaussian that is used to smooth derivatives used as a\n. basis for the polynomial expansion; for poly_n=5, you can set poly_sigma=1.1, for poly_n=7, a\n. good value would be poly_sigma=1.5.\n. @param flags operation flags that can be a combination of the following:\n. - **OPTFLOW_USE_INITIAL_FLOW** uses the input flow as an initial flow approximation.\n. - **OPTFLOW_FARNEBACK_GAUSSIAN** uses the Gaussian \\f$\\texttt{winsize}\\times\\texttt{winsize}\\f$\n. filter instead of a box filter of the same size for optical flow estimation; usually, this\n. option gives z more accurate flow than with a box filter, at the cost of lower speed;\n. normally, winsize for a Gaussian window should be set to a larger value to achieve the same\n. level of robustness.\n. \n. The function finds an optical flow for each prev pixel using the @cite Farneback2003 algorithm so that\n. \n. \\f[\\texttt{prev} (y,x) \\sim \\texttt{next} ( y + \\texttt{flow} (y,x)[1], x + \\texttt{flow} (y,x)[0])\\f]\n. \n. @note\n. \n. - An example using the optical flow algorithm described by Gunnar Farneback can be found at\n. opencv_source_code/samples/cpp/fback.cpp\n. - (Python) An example using the optical flow algorithm described by Gunnar Farneback can be\n. found at opencv_source_code/samples/python/opt_flow.py" ... -def calcOpticalFlowPyrLK( - prevImg, - nextImg, - prevPts, - nextPts, - status=..., - err=..., - winSize=..., - maxLevel=..., - criteria=..., - flags: int = ..., - minEigThreshold=...) -> typing.Any: +def calcOpticalFlowPyrLK(prevImg, nextImg, prevPts, nextPts, status=..., err=..., winSize=..., maxLevel=..., criteria=..., flags: int = ..., minEigThreshold=...) -> typing.Any: "calcOpticalFlowPyrLK(prevImg, nextImg, prevPts, nextPts[, status[, err[, winSize[, maxLevel[, criteria[, flags[, minEigThreshold]]]]]]]) -> nextPts, status, err\n. @brief Calculates an optical flow for a sparse feature set using the iterative Lucas-Kanade method with\n. pyramids.\n. \n. @param prevImg first 8-bit input image or pyramid constructed by buildOpticalFlowPyramid.\n. @param nextImg second input image or pyramid of the same size and the same type as prevImg.\n. @param prevPts vector of 2D points for which the flow needs to be found; point coordinates must be\n. single-precision floating-point numbers.\n. @param nextPts output vector of 2D points (with single-precision floating-point coordinates)\n. containing the calculated new positions of input features in the second image; when\n. OPTFLOW_USE_INITIAL_FLOW flag is passed, the vector must have the same size as in the input.\n. @param status output status vector (of unsigned chars); each element of the vector is set to 1 if\n. the flow for the corresponding features has been found, otherwise, it is set to 0.\n. @param err output vector of errors; each element of the vector is set to an error for the\n. corresponding feature, type of the error measure can be set in flags parameter; if the flow wasn't\n. found then the error is not defined (use the status parameter to find such cases).\n. @param winSize size of the search window at each pyramid level.\n. @param maxLevel 0-based maximal pyramid level number; if set to 0, pyramids are not used (single\n. level), if set to 1, two levels are used, and so on; if pyramids are passed to input then\n. algorithm will use as many levels as pyramids have but no more than maxLevel.\n. @param criteria parameter, specifying the termination criteria of the iterative search algorithm\n. (after the specified maximum number of iterations criteria.maxCount or when the search window\n. moves by less than criteria.epsilon.\n. @param flags operation flags:\n. - **OPTFLOW_USE_INITIAL_FLOW** uses initial estimations, stored in nextPts; if the flag is\n. not set, then prevPts is copied to nextPts and is considered the initial estimate.\n. - **OPTFLOW_LK_GET_MIN_EIGENVALS** use minimum eigen values as an error measure (see\n. minEigThreshold description); if the flag is not set, then L1 distance between patches\n. around the original and a moved point, divided by number of pixels in a window, is used as a\n. error measure.\n. @param minEigThreshold the algorithm calculates the minimum eigen value of a 2x2 normal matrix of\n. optical flow equations (this matrix is called a spatial gradient matrix in @cite Bouguet00), divided\n. by number of pixels in a window; if this value is less than minEigThreshold, then a corresponding\n. feature is filtered out and its flow is not processed, so it allows to remove bad points and get a\n. performance boost.\n. \n. The function implements a sparse iterative version of the Lucas-Kanade optical flow in pyramids. See\n. @cite Bouguet00 . The function is parallelized with the TBB library.\n. \n. @note\n. \n. - An example using the Lucas-Kanade optical flow algorithm can be found at\n. opencv_source_code/samples/cpp/lkdemo.cpp\n. - (Python) An example using the Lucas-Kanade optical flow algorithm can be found at\n. opencv_source_code/samples/python/lk_track.py\n. - (Python) An example using the Lucas-Kanade tracker for homography matching can be found at\n. opencv_source_code/samples/python/lk_homography.py" ... -def calibrateCamera( - objectPoints, - imagePoints, - imageSize, - cameraMatrix, - distCoeffs, - rvecs=..., - tvecs=..., - flags: int = ..., - criteria=...) -> typing.Any: +def calibrateCamera(objectPoints, imagePoints, imageSize, cameraMatrix, distCoeffs, rvecs=..., tvecs=..., flags: int = ..., criteria=...) -> typing.Any: 'calibrateCamera(objectPoints, imagePoints, imageSize, cameraMatrix, distCoeffs[, rvecs[, tvecs[, flags[, criteria]]]]) -> retval, cameraMatrix, distCoeffs, rvecs, tvecs\n. @overload' ... -def calibrateCameraExtended( - objectPoints, - imagePoints, - imageSize, - cameraMatrix, - distCoeffs, - rvecs=..., - tvecs=..., - stdDeviationsIntrinsics=..., - stdDeviationsExtrinsics=..., - perViewErrors=..., - flags: int = ..., - criteria=...) -> typing.Any: +def calibrateCameraExtended(objectPoints, imagePoints, imageSize, cameraMatrix, distCoeffs, rvecs=..., tvecs=..., stdDeviationsIntrinsics=..., stdDeviationsExtrinsics=..., perViewErrors=..., flags: int = ..., criteria=...) -> typing.Any: "calibrateCameraExtended(objectPoints, imagePoints, imageSize, cameraMatrix, distCoeffs[, rvecs[, tvecs[, stdDeviationsIntrinsics[, stdDeviationsExtrinsics[, perViewErrors[, flags[, criteria]]]]]]]) -> retval, cameraMatrix, distCoeffs, rvecs, tvecs, stdDeviationsIntrinsics, stdDeviationsExtrinsics, perViewErrors\n. @brief Finds the camera intrinsic and extrinsic parameters from several views of a calibration\n. pattern.\n. \n. @param objectPoints In the new interface it is a vector of vectors of calibration pattern points in\n. the calibration pattern coordinate space (e.g. std::vector>). The outer\n. vector contains as many elements as the number of pattern views. If the same calibration pattern\n. is shown in each view and it is fully visible, all the vectors will be the same. Although, it is\n. possible to use partially occluded patterns or even different patterns in different views. Then,\n. the vectors will be different. Although the points are 3D, they all lie in the calibration pattern's\n. XY coordinate plane (thus 0 in the Z-coordinate), if the used calibration pattern is a planar rig.\n. In the old interface all the vectors of object points from different views are concatenated\n. together.\n. @param imagePoints In the new interface it is a vector of vectors of the projections of calibration\n. pattern points (e.g. std::vector>). imagePoints.size() and\n. objectPoints.size(), and imagePoints[i].size() and objectPoints[i].size() for each i, must be equal,\n. respectively. In the old interface all the vectors of object points from different views are\n. concatenated together.\n. @param imageSize Size of the image used only to initialize the intrinsic camera matrix.\n. @param cameraMatrix Input/output 3x3 floating-point camera matrix\n. \\f$A = \\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\\f$ . If CV\\_CALIB\\_USE\\_INTRINSIC\\_GUESS\n. and/or CALIB_FIX_ASPECT_RATIO are specified, some or all of fx, fy, cx, cy must be\n. initialized before calling the function.\n. @param distCoeffs Input/output vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$ of\n. 4, 5, 8, 12 or 14 elements.\n. @param rvecs Output vector of rotation vectors (@ref Rodrigues ) estimated for each pattern view\n. (e.g. std::vector>). That is, each i-th rotation vector together with the corresponding\n. i-th translation vector (see the next output parameter description) brings the calibration pattern\n. from the object coordinate space (in which object points are specified) to the camera coordinate\n. space. In more technical terms, the tuple of the i-th rotation and translation vector performs\n. a change of basis from object coordinate space to camera coordinate space. Due to its duality, this\n. tuple is equivalent to the position of the calibration pattern with respect to the camera coordinate\n. space.\n. @param tvecs Output vector of translation vectors estimated for each pattern view, see parameter\n. describtion above.\n. @param stdDeviationsIntrinsics Output vector of standard deviations estimated for intrinsic\n. parameters. Order of deviations values:\n. \\f$(f_x, f_y, c_x, c_y, k_1, k_2, p_1, p_2, k_3, k_4, k_5, k_6 , s_1, s_2, s_3,\n. s_4, \\tau_x, \\tau_y)\\f$ If one of parameters is not estimated, it's deviation is equals to zero.\n. @param stdDeviationsExtrinsics Output vector of standard deviations estimated for extrinsic\n. parameters. Order of deviations values: \\f$(R_0, T_0, \\dotsc , R_{M - 1}, T_{M - 1})\\f$ where M is\n. the number of pattern views. \\f$R_i, T_i\\f$ are concatenated 1x3 vectors.\n. @param perViewErrors Output vector of the RMS re-projection error estimated for each pattern view.\n. @param flags Different flags that may be zero or a combination of the following values:\n. - **CALIB_USE_INTRINSIC_GUESS** cameraMatrix contains valid initial values of\n. fx, fy, cx, cy that are optimized further. Otherwise, (cx, cy) is initially set to the image\n. center ( imageSize is used), and focal distances are computed in a least-squares fashion.\n. Note, that if intrinsic parameters are known, there is no need to use this function just to\n. estimate extrinsic parameters. Use solvePnP instead.\n. - **CALIB_FIX_PRINCIPAL_POINT** The principal point is not changed during the global\n. optimization. It stays at the center or at a different location specified when\n. CALIB_USE_INTRINSIC_GUESS is set too.\n. - **CALIB_FIX_ASPECT_RATIO** The functions consider only fy as a free parameter. The\n. ratio fx/fy stays the same as in the input cameraMatrix . When\n. CALIB_USE_INTRINSIC_GUESS is not set, the actual input values of fx and fy are\n. ignored, only their ratio is computed and used further.\n. - **CALIB_ZERO_TANGENT_DIST** Tangential distortion coefficients \\f$(p_1, p_2)\\f$ are set\n. to zeros and stay zero.\n. - **CALIB_FIX_K1,...,CALIB_FIX_K6** The corresponding radial distortion\n. coefficient is not changed during the optimization. If CALIB_USE_INTRINSIC_GUESS is\n. set, the coefficient from the supplied distCoeffs matrix is used. Otherwise, it is set to 0.\n. - **CALIB_RATIONAL_MODEL** Coefficients k4, k5, and k6 are enabled. To provide the\n. backward compatibility, this extra flag should be explicitly specified to make the\n. calibration function use the rational model and return 8 coefficients. If the flag is not\n. set, the function computes and returns only 5 distortion coefficients.\n. - **CALIB_THIN_PRISM_MODEL** Coefficients s1, s2, s3 and s4 are enabled. To provide the\n. backward compatibility, this extra flag should be explicitly specified to make the\n. calibration function use the thin prism model and return 12 coefficients. If the flag is not\n. set, the function computes and returns only 5 distortion coefficients.\n. - **CALIB_FIX_S1_S2_S3_S4** The thin prism distortion coefficients are not changed during\n. the optimization. If CALIB_USE_INTRINSIC_GUESS is set, the coefficient from the\n. supplied distCoeffs matrix is used. Otherwise, it is set to 0.\n. - **CALIB_TILTED_MODEL** Coefficients tauX and tauY are enabled. To provide the\n. backward compatibility, this extra flag should be explicitly specified to make the\n. calibration function use the tilted sensor model and return 14 coefficients. If the flag is not\n. set, the function computes and returns only 5 distortion coefficients.\n. - **CALIB_FIX_TAUX_TAUY** The coefficients of the tilted sensor model are not changed during\n. the optimization. If CALIB_USE_INTRINSIC_GUESS is set, the coefficient from the\n. supplied distCoeffs matrix is used. Otherwise, it is set to 0.\n. @param criteria Termination criteria for the iterative optimization algorithm.\n. \n. @return the overall RMS re-projection error.\n. \n. The function estimates the intrinsic camera parameters and extrinsic parameters for each of the\n. views. The algorithm is based on @cite Zhang2000 and @cite BouguetMCT . The coordinates of 3D object\n. points and their corresponding 2D projections in each view must be specified. That may be achieved\n. by using an object with known geometry and easily detectable feature points. Such an object is\n. called a calibration rig or calibration pattern, and OpenCV has built-in support for a chessboard as\n. a calibration rig (see @ref findChessboardCorners). Currently, initialization of intrinsic\n. parameters (when CALIB_USE_INTRINSIC_GUESS is not set) is only implemented for planar calibration\n. patterns (where Z-coordinates of the object points must be all zeros). 3D calibration rigs can also\n. be used as long as initial cameraMatrix is provided.\n. \n. The algorithm performs the following steps:\n. \n. - Compute the initial intrinsic parameters (the option only available for planar calibration\n. patterns) or read them from the input parameters. The distortion coefficients are all set to\n. zeros initially unless some of CALIB_FIX_K? are specified.\n. \n. - Estimate the initial camera pose as if the intrinsic parameters have been already known. This is\n. done using solvePnP .\n. \n. - Run the global Levenberg-Marquardt optimization algorithm to minimize the reprojection error,\n. that is, the total sum of squared distances between the observed feature points imagePoints and\n. the projected (using the current estimates for camera parameters and the poses) object points\n. objectPoints. See projectPoints for details.\n. \n. @note\n. If you use a non-square (i.e. non-N-by-N) grid and @ref findChessboardCorners for calibration,\n. and @ref calibrateCamera returns bad values (zero distortion coefficients, \\f$c_x\\f$ and\n. \\f$c_y\\f$ very far from the image center, and/or large differences between \\f$f_x\\f$ and\n. \\f$f_y\\f$ (ratios of 10:1 or more)), then you are probably using patternSize=cvSize(rows,cols)\n. instead of using patternSize=cvSize(cols,rows) in @ref findChessboardCorners.\n. \n. @sa\n. calibrateCameraRO, findChessboardCorners, solvePnP, initCameraMatrix2D, stereoCalibrate,\n. undistort" ... -def calibrateCameraRO( - objectPoints, - imagePoints, - imageSize, - iFixedPoint, - cameraMatrix, - distCoeffs, - rvecs=..., - tvecs=..., - newObjPoints=..., - flags: int = ..., - criteria=...) -> typing.Any: +def calibrateCameraRO(objectPoints, imagePoints, imageSize, iFixedPoint, cameraMatrix, distCoeffs, rvecs=..., tvecs=..., newObjPoints=..., flags: int = ..., criteria=...) -> typing.Any: 'calibrateCameraRO(objectPoints, imagePoints, imageSize, iFixedPoint, cameraMatrix, distCoeffs[, rvecs[, tvecs[, newObjPoints[, flags[, criteria]]]]]) -> retval, cameraMatrix, distCoeffs, rvecs, tvecs, newObjPoints\n. @overload' ... -def calibrateCameraROExtended( - objectPoints, - imagePoints, - imageSize, - iFixedPoint, - cameraMatrix, - distCoeffs, - rvecs=..., - tvecs=..., - newObjPoints=..., - stdDeviationsIntrinsics=..., - stdDeviationsExtrinsics=..., - stdDeviationsObjPoints=..., - perViewErrors=..., - flags: int = ..., - criteria=...) -> typing.Any: +def calibrateCameraROExtended(objectPoints, imagePoints, imageSize, iFixedPoint, cameraMatrix, distCoeffs, rvecs=..., tvecs=..., newObjPoints=..., stdDeviationsIntrinsics=..., stdDeviationsExtrinsics=..., stdDeviationsObjPoints=..., perViewErrors=..., flags: int = ..., criteria=...) -> typing.Any: 'calibrateCameraROExtended(objectPoints, imagePoints, imageSize, iFixedPoint, cameraMatrix, distCoeffs[, rvecs[, tvecs[, newObjPoints[, stdDeviationsIntrinsics[, stdDeviationsExtrinsics[, stdDeviationsObjPoints[, perViewErrors[, flags[, criteria]]]]]]]]]) -> retval, cameraMatrix, distCoeffs, rvecs, tvecs, newObjPoints, stdDeviationsIntrinsics, stdDeviationsExtrinsics, stdDeviationsObjPoints, perViewErrors\n. @brief Finds the camera intrinsic and extrinsic parameters from several views of a calibration pattern.\n. \n. This function is an extension of calibrateCamera() with the method of releasing object which was\n. proposed in @cite strobl2011iccv. In many common cases with inaccurate, unmeasured, roughly planar\n. targets (calibration plates), this method can dramatically improve the precision of the estimated\n. camera parameters. Both the object-releasing method and standard method are supported by this\n. function. Use the parameter **iFixedPoint** for method selection. In the internal implementation,\n. calibrateCamera() is a wrapper for this function.\n. \n. @param objectPoints Vector of vectors of calibration pattern points in the calibration pattern\n. coordinate space. See calibrateCamera() for details. If the method of releasing object to be used,\n. the identical calibration board must be used in each view and it must be fully visible, and all\n. objectPoints[i] must be the same and all points should be roughly close to a plane. **The calibration\n. target has to be rigid, or at least static if the camera (rather than the calibration target) is\n. shifted for grabbing images.**\n. @param imagePoints Vector of vectors of the projections of calibration pattern points. See\n. calibrateCamera() for details.\n. @param imageSize Size of the image used only to initialize the intrinsic camera matrix.\n. @param iFixedPoint The index of the 3D object point in objectPoints[0] to be fixed. It also acts as\n. a switch for calibration method selection. If object-releasing method to be used, pass in the\n. parameter in the range of [1, objectPoints[0].size()-2], otherwise a value out of this range will\n. make standard calibration method selected. Usually the top-right corner point of the calibration\n. board grid is recommended to be fixed when object-releasing method being utilized. According to\n. \\cite strobl2011iccv, two other points are also fixed. In this implementation, objectPoints[0].front\n. and objectPoints[0].back.z are used. With object-releasing method, accurate rvecs, tvecs and\n. newObjPoints are only possible if coordinates of these three fixed points are accurate enough.\n. @param cameraMatrix Output 3x3 floating-point camera matrix. See calibrateCamera() for details.\n. @param distCoeffs Output vector of distortion coefficients. See calibrateCamera() for details.\n. @param rvecs Output vector of rotation vectors estimated for each pattern view. See calibrateCamera()\n. for details.\n. @param tvecs Output vector of translation vectors estimated for each pattern view.\n. @param newObjPoints The updated output vector of calibration pattern points. The coordinates might\n. be scaled based on three fixed points. The returned coordinates are accurate only if the above\n. mentioned three fixed points are accurate. If not needed, noArray() can be passed in. This parameter\n. is ignored with standard calibration method.\n. @param stdDeviationsIntrinsics Output vector of standard deviations estimated for intrinsic parameters.\n. See calibrateCamera() for details.\n. @param stdDeviationsExtrinsics Output vector of standard deviations estimated for extrinsic parameters.\n. See calibrateCamera() for details.\n. @param stdDeviationsObjPoints Output vector of standard deviations estimated for refined coordinates\n. of calibration pattern points. It has the same size and order as objectPoints[0] vector. This\n. parameter is ignored with standard calibration method.\n. @param perViewErrors Output vector of the RMS re-projection error estimated for each pattern view.\n. @param flags Different flags that may be zero or a combination of some predefined values. See\n. calibrateCamera() for details. If the method of releasing object is used, the calibration time may\n. be much longer. CALIB_USE_QR or CALIB_USE_LU could be used for faster calibration with potentially\n. less precise and less stable in some rare cases.\n. @param criteria Termination criteria for the iterative optimization algorithm.\n. \n. @return the overall RMS re-projection error.\n. \n. The function estimates the intrinsic camera parameters and extrinsic parameters for each of the\n. views. The algorithm is based on @cite Zhang2000, @cite BouguetMCT and @cite strobl2011iccv. See\n. calibrateCamera() for other detailed explanations.\n. @sa\n. calibrateCamera, findChessboardCorners, solvePnP, initCameraMatrix2D, stereoCalibrate, undistort' ... -def calibrateHandEye( - R_gripper2base, - t_gripper2base, - R_target2cam, - t_target2cam, - R_cam2gripper=..., - t_cam2gripper=..., - method: int = ...) -> typing.Any: +def calibrateHandEye(R_gripper2base, t_gripper2base, R_target2cam, t_target2cam, R_cam2gripper=..., t_cam2gripper=..., method: int = ...) -> typing.Any: 'calibrateHandEye(R_gripper2base, t_gripper2base, R_target2cam, t_target2cam[, R_cam2gripper[, t_cam2gripper[, method]]]) -> R_cam2gripper, t_cam2gripper\n. @brief Computes Hand-Eye calibration: \\f$_{}^{g}\\textrm{T}_c\\f$\n. \n. @param[in] R_gripper2base Rotation part extracted from the homogeneous matrix that transforms a point\n. expressed in the gripper frame to the robot base frame (\\f$_{}^{b}\\textrm{T}_g\\f$).\n. This is a vector (`vector`) that contains the rotation matrices for all the transformations\n. from gripper frame to robot base frame.\n. @param[in] t_gripper2base Translation part extracted from the homogeneous matrix that transforms a point\n. expressed in the gripper frame to the robot base frame (\\f$_{}^{b}\\textrm{T}_g\\f$).\n. This is a vector (`vector`) that contains the translation vectors for all the transformations\n. from gripper frame to robot base frame.\n. @param[in] R_target2cam Rotation part extracted from the homogeneous matrix that transforms a point\n. expressed in the target frame to the camera frame (\\f$_{}^{c}\\textrm{T}_t\\f$).\n. This is a vector (`vector`) that contains the rotation matrices for all the transformations\n. from calibration target frame to camera frame.\n. @param[in] t_target2cam Rotation part extracted from the homogeneous matrix that transforms a point\n. expressed in the target frame to the camera frame (\\f$_{}^{c}\\textrm{T}_t\\f$).\n. This is a vector (`vector`) that contains the translation vectors for all the transformations\n. from calibration target frame to camera frame.\n. @param[out] R_cam2gripper Estimated rotation part extracted from the homogeneous matrix that transforms a point\n. expressed in the camera frame to the gripper frame (\\f$_{}^{g}\\textrm{T}_c\\f$).\n. @param[out] t_cam2gripper Estimated translation part extracted from the homogeneous matrix that transforms a point\n. expressed in the camera frame to the gripper frame (\\f$_{}^{g}\\textrm{T}_c\\f$).\n. @param[in] method One of the implemented Hand-Eye calibration method, see cv::HandEyeCalibrationMethod\n. \n. The function performs the Hand-Eye calibration using various methods. One approach consists in estimating the\n. rotation then the translation (separable solutions) and the following methods are implemented:\n. - R. Tsai, R. Lenz A New Technique for Fully Autonomous and Efficient 3D Robotics Hand/EyeCalibration \\cite Tsai89\n. - F. Park, B. Martin Robot Sensor Calibration: Solving AX = XB on the Euclidean Group \\cite Park94\n. - R. Horaud, F. Dornaika Hand-Eye Calibration \\cite Horaud95\n. \n. Another approach consists in estimating simultaneously the rotation and the translation (simultaneous solutions),\n. with the following implemented method:\n. - N. Andreff, R. Horaud, B. Espiau On-line Hand-Eye Calibration \\cite Andreff99\n. - K. Daniilidis Hand-Eye Calibration Using Dual Quaternions \\cite Daniilidis98\n. \n. The following picture describes the Hand-Eye calibration problem where the transformation between a camera ("eye")\n. mounted on a robot gripper ("hand") has to be estimated.\n. \n. ![](pics/hand-eye_figure.png)\n. \n. The calibration procedure is the following:\n. - a static calibration pattern is used to estimate the transformation between the target frame\n. and the camera frame\n. - the robot gripper is moved in order to acquire several poses\n. - for each pose, the homogeneous transformation between the gripper frame and the robot base frame is recorded using for\n. instance the robot kinematics\n. \\f[\n. \\begin{bmatrix}\n. X_b\\\\\n. Y_b\\\\\n. Z_b\\\\\n. 1\n. \\end{bmatrix}\n. =\n. \\begin{bmatrix}\n. _{}^{b}\\textrm{R}_g & _{}^{b}\\textrm{t}_g \\\\\n. 0_{1 \\times 3} & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X_g\\\\\n. Y_g\\\\\n. Z_g\\\\\n. 1\n. \\end{bmatrix}\n. \\f]\n. - for each pose, the homogeneous transformation between the calibration target frame and the camera frame is recorded using\n. for instance a pose estimation method (PnP) from 2D-3D point correspondences\n. \\f[\n. \\begin{bmatrix}\n. X_c\\\\\n. Y_c\\\\\n. Z_c\\\\\n. 1\n. \\end{bmatrix}\n. =\n. \\begin{bmatrix}\n. _{}^{c}\\textrm{R}_t & _{}^{c}\\textrm{t}_t \\\\\n. 0_{1 \\times 3} & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X_t\\\\\n. Y_t\\\\\n. Z_t\\\\\n. 1\n. \\end{bmatrix}\n. \\f]\n. \n. The Hand-Eye calibration procedure returns the following homogeneous transformation\n. \\f[\n. \\begin{bmatrix}\n. X_g\\\\\n. Y_g\\\\\n. Z_g\\\\\n. 1\n. \\end{bmatrix}\n. =\n. \\begin{bmatrix}\n. _{}^{g}\\textrm{R}_c & _{}^{g}\\textrm{t}_c \\\\\n. 0_{1 \\times 3} & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X_c\\\\\n. Y_c\\\\\n. Z_c\\\\\n. 1\n. \\end{bmatrix}\n. \\f]\n. \n. This problem is also known as solving the \\f$\\mathbf{A}\\mathbf{X}=\\mathbf{X}\\mathbf{B}\\f$ equation:\n. \\f[\n. \\begin{align*}\n. ^{b}{\\textrm{T}_g}^{(1)} \\hspace{0.2em} ^{g}\\textrm{T}_c \\hspace{0.2em} ^{c}{\\textrm{T}_t}^{(1)} &=\n. \\hspace{0.1em} ^{b}{\\textrm{T}_g}^{(2)} \\hspace{0.2em} ^{g}\\textrm{T}_c \\hspace{0.2em} ^{c}{\\textrm{T}_t}^{(2)} \\\\\n. \n. (^{b}{\\textrm{T}_g}^{(2)})^{-1} \\hspace{0.2em} ^{b}{\\textrm{T}_g}^{(1)} \\hspace{0.2em} ^{g}\\textrm{T}_c &=\n. \\hspace{0.1em} ^{g}\\textrm{T}_c \\hspace{0.2em} ^{c}{\\textrm{T}_t}^{(2)} (^{c}{\\textrm{T}_t}^{(1)})^{-1} \\\\\n. \n. \\textrm{A}_i \\textrm{X} &= \\textrm{X} \\textrm{B}_i \\\\\n. \\end{align*}\n. \\f]\n. \n. \\note\n. Additional information can be found on this [website](http://campar.in.tum.de/Chair/HandEyeCalibration).\n. \\note\n. A minimum of 2 motions with non parallel rotation axes are necessary to determine the hand-eye transformation.\n. So at least 3 different poses are required, but it is strongly recommended to use many more poses.' ... @@ -2222,13 +2002,7 @@ def clipLine(imgRect, pt1, pt2) -> typing.Any: ... -def colorChange( - src: ndarray, - mask: ndarray, - dts: ndarray = ..., - red_mul=..., - green_mul=..., - blue_mul=...) -> typing.Any: +def colorChange(src: ndarray, mask: ndarray, dts: ndarray = ..., red_mul=..., green_mul=..., blue_mul=...) -> typing.Any: 'colorChange(src, mask[, dst[, red_mul[, green_mul[, blue_mul]]]]) -> dst\n. @brief Given an original color image, two differently colored versions of this image can be mixed\n. seamlessly.\n. \n. @param src Input 8-bit 3-channel image.\n. @param mask Input 8-bit 1 or 3-channel image.\n. @param dst Output image with the same size and type as src .\n. @param red_mul R-channel multiply factor.\n. @param green_mul G-channel multiply factor.\n. @param blue_mul B-channel multiply factor.\n. \n. Multiplication factor is between .5 to 2.5.' ... @@ -2248,21 +2022,7 @@ def completeSymm(m, lowerToUpper=...) -> typing.Any: ... -def composeRT( - rvec1, - tvec1, - rvec2, - tvec2, - rvec3=..., - tvec3=..., - dr3dr1=..., - dr3dt1=..., - dr3dr2=..., - dr3dt2=..., - dt3dr1=..., - dt3dt1=..., - dt3dr2=..., - dt3dt2=...) -> typing.Any: +def composeRT(rvec1, tvec1, rvec2, tvec2, rvec3=..., tvec3=..., dr3dr1=..., dr3dt1=..., dr3dr2=..., dr3dt2=..., dt3dr1=..., dt3dt1=..., dt3dr2=..., dt3dt2=...) -> typing.Any: 'composeRT(rvec1, tvec1, rvec2, tvec2[, rvec3[, tvec3[, dr3dr1[, dr3dt1[, dr3dr2[, dr3dt2[, dt3dr1[, dt3dt1[, dt3dr2[, dt3dt2]]]]]]]]]]) -> rvec3, tvec3, dr3dr1, dr3dt1, dr3dr2, dr3dt2, dt3dr1, dt3dt1, dt3dr2, dt3dt2\n. @brief Combines two rotation-and-shift transformations.\n. \n. @param rvec1 First rotation vector.\n. @param tvec1 First translation vector.\n. @param rvec2 Second rotation vector.\n. @param tvec2 Second translation vector.\n. @param rvec3 Output rotation vector of the superposition.\n. @param tvec3 Output translation vector of the superposition.\n. @param dr3dr1 Optional output derivative of rvec3 with regard to rvec1\n. @param dr3dt1 Optional output derivative of rvec3 with regard to tvec1\n. @param dr3dr2 Optional output derivative of rvec3 with regard to rvec2\n. @param dr3dt2 Optional output derivative of rvec3 with regard to tvec2\n. @param dt3dr1 Optional output derivative of tvec3 with regard to rvec1\n. @param dt3dt1 Optional output derivative of tvec3 with regard to tvec1\n. @param dt3dr2 Optional output derivative of tvec3 with regard to rvec2\n. @param dt3dt2 Optional output derivative of tvec3 with regard to tvec2\n. \n. The functions compute:\n. \n. \\f[\\begin{array}{l} \\texttt{rvec3} = \\mathrm{rodrigues} ^{-1} \\left ( \\mathrm{rodrigues} ( \\texttt{rvec2} ) \\cdot \\mathrm{rodrigues} ( \\texttt{rvec1} ) \\right ) \\\\ \\texttt{tvec3} = \\mathrm{rodrigues} ( \\texttt{rvec2} ) \\cdot \\texttt{tvec1} + \\texttt{tvec2} \\end{array} ,\\f]\n. \n. where \\f$\\mathrm{rodrigues}\\f$ denotes a rotation vector to a rotation matrix transformation, and\n. \\f$\\mathrm{rodrigues}^{-1}\\f$ denotes the inverse transformation. See Rodrigues for details.\n. \n. Also, the functions can compute the derivatives of the output vectors with regards to the input\n. vectors (see matMulDeriv ). The functions are used inside stereoCalibrate but can also be used in\n. your own code where Levenberg-Marquardt or another gradient-based solver is used to optimize a\n. function that contains a matrix multiplication.' ... @@ -2287,25 +2047,12 @@ def connectedComponentsWithAlgorithm(image: ndarray, connectivity, ltype, ccltyp ... -def connectedComponentsWithStats( - image: ndarray, - labels=..., - stats=..., - centroids=..., - connectivity=..., - ltype=...) -> typing.Any: +def connectedComponentsWithStats(image: ndarray, labels=..., stats=..., centroids=..., connectivity=..., ltype=...) -> typing.Any: 'connectedComponentsWithStats(image[, labels[, stats[, centroids[, connectivity[, ltype]]]]]) -> retval, labels, stats, centroids\n. @overload\n. @param image the 8-bit single-channel image to be labeled\n. @param labels destination labeled image\n. @param stats statistics output for each label, including the background label.\n. Statistics are accessed via stats(label, COLUMN) where COLUMN is one of\n. #ConnectedComponentsTypes, selecting the statistic. The data type is CV_32S.\n. @param centroids centroid output for each label, including the background label. Centroids are\n. accessed via centroids(label, 0) for x and centroids(label, 1) for y. The data type CV_64F.\n. @param connectivity 8 or 4 for 8-way or 4-way connectivity respectively\n. @param ltype output image label type. Currently CV_32S and CV_16U are supported.' ... -def connectedComponentsWithStatsWithAlgorithm( - image: ndarray, - connectivity, - ltype, - ccltype, - labels=..., - stats=..., - centroids=...) -> typing.Any: +def connectedComponentsWithStatsWithAlgorithm(image: ndarray, connectivity, ltype, ccltype, labels=..., stats=..., centroids=...) -> typing.Any: "connectedComponentsWithStatsWithAlgorithm(image, connectivity, ltype, ccltype[, labels[, stats[, centroids]]]) -> retval, labels, stats, centroids\n. @brief computes the connected components labeled image of boolean image and also produces a statistics output for each label\n. \n. image with 4 or 8 way connectivity - returns N, the total number of labels [0, N-1] where 0\n. represents the background label. ltype specifies the output label image type, an important\n. consideration based on the total number of labels or alternatively the total number of pixels in\n. the source image. ccltype specifies the connected components labeling algorithm to use, currently\n. Grana's (BBDT) and Wu's (SAUF) algorithms are supported, see the #ConnectedComponentsAlgorithmsTypes\n. for details. Note that SAUF algorithm forces a row major ordering of labels while BBDT does not.\n. This function uses parallel version of both Grana and Wu's algorithms (statistics included) if at least one allowed\n. parallel framework is enabled and if the rows of the image are at least twice the number returned by #getNumberOfCPUs.\n. \n. @param image the 8-bit single-channel image to be labeled\n. @param labels destination labeled image\n. @param stats statistics output for each label, including the background label.\n. Statistics are accessed via stats(label, COLUMN) where COLUMN is one of\n. #ConnectedComponentsTypes, selecting the statistic. The data type is CV_32S.\n. @param centroids centroid output for each label, including the background label. Centroids are\n. accessed via centroids(label, 0) for x and centroids(label, 1) for y. The data type CV_64F.\n. @param connectivity 8 or 4 for 8-way or 4-way connectivity respectively\n. @param ltype output image label type. Currently CV_32S and CV_16U are supported.\n. @param ccltype connected components algorithm type (see #ConnectedComponentsAlgorithmsTypes)." ... @@ -2440,15 +2187,7 @@ def createHanningWindow(winSize, type, dts: ndarray = ...) -> typing.Any: ... -def createLineSegmentDetector( - _refine=..., - _scale=..., - _sigma_scale=..., - _quant=..., - _ang_th=..., - _log_eps=..., - _density_th=..., - _n_bins=...) -> typing.Any: +def createLineSegmentDetector(_refine=..., _scale=..., _sigma_scale=..., _quant=..., _ang_th=..., _log_eps=..., _density_th=..., _n_bins=...) -> typing.Any: 'createLineSegmentDetector([, _refine[, _scale[, _sigma_scale[, _quant[, _ang_th[, _log_eps[, _density_th[, _n_bins]]]]]]]]) -> retval\n. @brief Creates a smart pointer to a LineSegmentDetector object and initializes it.\n. \n. The LineSegmentDetector algorithm is defined using the standard values. Only advanced users may want\n. to edit those, as to tailor it for their own application.\n. \n. @param _refine The way found lines will be refined, see #LineSegmentDetectorModes\n. @param _scale The scale of the image that will be used to find the lines. Range (0..1].\n. @param _sigma_scale Sigma for Gaussian filter. It is computed as sigma = _sigma_scale/_scale.\n. @param _quant Bound to the quantization error on the gradient norm.\n. @param _ang_th Gradient angle tolerance in degrees.\n. @param _log_eps Detection threshold: -log10(NFA) \\> log_eps. Used only when advance refinement\n. is chosen.\n. @param _density_th Minimal density of aligned region points in the enclosing rectangle.\n. @param _n_bins Number of bins in pseudo-ordering of gradient modulus.\n. \n. @note Implementation has been removed due original code license conflict' ... @@ -2538,15 +2277,7 @@ def decomposeHomographyMat(H, K, rotations=..., translations=..., normals=...) - ... -def decomposeProjectionMatrix( - projMatrix, - cameraMatrix=..., - rotMatrix=..., - transVect=..., - rotMatrixX=..., - rotMatrixY=..., - rotMatrixZ=..., - eulerAngles=...) -> typing.Any: +def decomposeProjectionMatrix(projMatrix, cameraMatrix=..., rotMatrix=..., transVect=..., rotMatrixX=..., rotMatrixY=..., rotMatrixZ=..., eulerAngles=...) -> typing.Any: 'decomposeProjectionMatrix(projMatrix[, cameraMatrix[, rotMatrix[, transVect[, rotMatrixX[, rotMatrixY[, rotMatrixZ[, eulerAngles]]]]]]]) -> cameraMatrix, rotMatrix, transVect, rotMatrixX, rotMatrixY, rotMatrixZ, eulerAngles\n. @brief Decomposes a projection matrix into a rotation matrix and a camera matrix.\n. \n. @param projMatrix 3x4 input projection matrix P.\n. @param cameraMatrix Output 3x3 camera matrix K.\n. @param rotMatrix Output 3x3 external rotation matrix R.\n. @param transVect Output 4x1 translation vector T.\n. @param rotMatrixX Optional 3x3 rotation matrix around x-axis.\n. @param rotMatrixY Optional 3x3 rotation matrix around y-axis.\n. @param rotMatrixZ Optional 3x3 rotation matrix around z-axis.\n. @param eulerAngles Optional three-element vector containing three Euler angles of rotation in\n. degrees.\n. \n. The function computes a decomposition of a projection matrix into a calibration and a rotation\n. matrix and the position of a camera.\n. \n. It optionally returns three rotation matrices, one for each axis, and three Euler angles that could\n. be used in OpenGL. Note, there is always more than one sequence of rotations about the three\n. principal axes that results in the same orientation of an object, e.g. see @cite Slabaugh . Returned\n. tree rotation matrices and corresponding three Euler angles are only one of the possible solutions.\n. \n. The function is based on RQDecomp3x3 .' ... @@ -2624,14 +2355,7 @@ def dft(src: ndarray, dts: ndarray = ..., flags: int = ..., nonzeroRows=...) -> ... -def dilate( - src: ndarray, - kernel, - dts: ndarray = ..., - anchor=..., - iterations=..., - borderType=..., - borderValue=...) -> typing.Any: +def dilate(src: ndarray, kernel, dts: ndarray = ..., anchor=..., iterations=..., borderType=..., borderValue=...) -> typing.Any: "dilate(src, kernel[, dst[, anchor[, iterations[, borderType[, borderValue]]]]]) -> dst\n. @brief Dilates an image by using a specific structuring element.\n. \n. The function dilates the source image using the specified structuring element that determines the\n. shape of a pixel neighborhood over which the maximum is taken:\n. \\f[\\texttt{dst} (x,y) = \\max _{(x',y'): \\, \\texttt{element} (x',y') \\ne0 } \\texttt{src} (x+x',y+y')\\f]\n. \n. The function supports the in-place mode. Dilation can be applied several ( iterations ) times. In\n. case of multi-channel images, each channel is processed independently.\n. \n. @param src input image; the number of channels can be arbitrary, but the depth should be one of\n. CV_8U, CV_16U, CV_16S, CV_32F or CV_64F.\n. @param dst output image of the same size and type as src.\n. @param kernel structuring element used for dilation; if elemenat=Mat(), a 3 x 3 rectangular\n. structuring element is used. Kernel can be created using #getStructuringElement\n. @param anchor position of the anchor within the element; default value (-1, -1) means that the\n. anchor is at the element center.\n. @param iterations number of times dilation is applied.\n. @param borderType pixel extrapolation method, see #BorderTypes. #BORDER_WRAP is not suported.\n. @param borderValue border value in case of a constant border\n. @sa erode, morphologyEx, getStructuringElement" ... @@ -2651,13 +2375,7 @@ def distanceTransform(src: ndarray, distanceType, maskSize, dts: ndarray = ..., ... -def distanceTransformWithLabels( - src: ndarray, - distanceType, - maskSize, - dts: ndarray = ..., - labels=..., - labelType=...) -> typing.Any: +def distanceTransformWithLabels(src: ndarray, distanceType, maskSize, dts: ndarray = ..., labels=..., labelType=...) -> typing.Any: "distanceTransformWithLabels(src, distanceType, maskSize[, dst[, labels[, labelType]]]) -> dst, labels\n. @brief Calculates the distance to the closest zero pixel for each pixel of the source image.\n. \n. The function cv::distanceTransform calculates the approximate or precise distance from every binary\n. image pixel to the nearest zero pixel. For zero image pixels, the distance will obviously be zero.\n. \n. When maskSize == #DIST_MASK_PRECISE and distanceType == #DIST_L2 , the function runs the\n. algorithm described in @cite Felzenszwalb04 . This algorithm is parallelized with the TBB library.\n. \n. In other cases, the algorithm @cite Borgefors86 is used. This means that for a pixel the function\n. finds the shortest path to the nearest zero pixel consisting of basic shifts: horizontal, vertical,\n. diagonal, or knight's move (the latest is available for a \\f$5\\times 5\\f$ mask). The overall\n. distance is calculated as a sum of these basic distances. Since the distance function should be\n. symmetric, all of the horizontal and vertical shifts must have the same cost (denoted as a ), all\n. the diagonal shifts must have the same cost (denoted as `b`), and all knight's moves must have the\n. same cost (denoted as `c`). For the #DIST_C and #DIST_L1 types, the distance is calculated\n. precisely, whereas for #DIST_L2 (Euclidean distance) the distance can be calculated only with a\n. relative error (a \\f$5\\times 5\\f$ mask gives more accurate results). For `a`,`b`, and `c`, OpenCV\n. uses the values suggested in the original paper:\n. - DIST_L1: `a = 1, b = 2`\n. - DIST_L2:\n. - `3 x 3`: `a=0.955, b=1.3693`\n. - `5 x 5`: `a=1, b=1.4, c=2.1969`\n. - DIST_C: `a = 1, b = 1`\n. \n. Typically, for a fast, coarse distance estimation #DIST_L2, a \\f$3\\times 3\\f$ mask is used. For a\n. more accurate distance estimation #DIST_L2, a \\f$5\\times 5\\f$ mask or the precise algorithm is used.\n. Note that both the precise and the approximate algorithms are linear on the number of pixels.\n. \n. This variant of the function does not only compute the minimum distance for each pixel \\f$(x, y)\\f$\n. but also identifies the nearest connected component consisting of zero pixels\n. (labelType==#DIST_LABEL_CCOMP) or the nearest zero pixel (labelType==#DIST_LABEL_PIXEL). Index of the\n. component/pixel is stored in `labels(x, y)`. When labelType==#DIST_LABEL_CCOMP, the function\n. automatically finds connected components of zero pixels in the input image and marks them with\n. distinct labels. When labelType==#DIST_LABEL_CCOMP, the function scans through the input image and\n. marks all the zero pixels with distinct labels.\n. \n. In this mode, the complexity is still linear. That is, the function provides a very fast way to\n. compute the Voronoi diagram for a binary image. Currently, the second variant can use only the\n. approximate distance transform algorithm, i.e. maskSize=#DIST_MASK_PRECISE is not supported\n. yet.\n. \n. @param src 8-bit, single-channel (binary) source image.\n. @param dst Output image with calculated distances. It is a 8-bit or 32-bit floating-point,\n. single-channel image of the same size as src.\n. @param labels Output 2D array of labels (the discrete Voronoi diagram). It has the type\n. CV_32SC1 and the same size as src.\n. @param distanceType Type of distance, see #DistanceTypes\n. @param maskSize Size of the distance transform mask, see #DistanceTransformMasks.\n. #DIST_MASK_PRECISE is not supported by this variant. In case of the #DIST_L1 or #DIST_C distance type,\n. the parameter is forced to 3 because a \\f$3\\times 3\\f$ mask gives the same result as \\f$5\\times\n. 5\\f$ or any larger aperture.\n. @param labelType Type of the label array to build, see #DistanceTransformLabelTypes." ... @@ -2692,16 +2410,7 @@ def drawChessboardCorners(image: ndarray, patternSize, corners, patternWasFound) ... -def drawContours( - image: ndarray, - contours, - contourIdx, - color, - thickness=..., - lineType=..., - hierarchy=..., - maxLevel=..., - offset=...) -> typing.Any: +def drawContours(image: ndarray, contours, contourIdx, color, thickness=..., lineType=..., hierarchy=..., maxLevel=..., offset=...) -> typing.Any: 'drawContours(image, contours, contourIdx, color[, thickness[, lineType[, hierarchy[, maxLevel[, offset]]]]]) -> image\n. @brief Draws contours outlines or filled contours.\n. \n. The function draws contour outlines in the image if \\f$\\texttt{thickness} \\ge 0\\f$ or fills the area\n. bounded by the contours if \\f$\\texttt{thickness}<0\\f$ . The example below shows how to retrieve\n. connected components from the binary image and label them: :\n. @include snippets/imgproc_drawContours.cpp\n. \n. @param image Destination image.\n. @param contours All the input contours. Each contour is stored as a point vector.\n. @param contourIdx Parameter indicating a contour to draw. If it is negative, all the contours are drawn.\n. @param color Color of the contours.\n. @param thickness Thickness of lines the contours are drawn with. If it is negative (for example,\n. thickness=#FILLED ), the contour interiors are drawn.\n. @param lineType Line connectivity. See #LineTypes\n. @param hierarchy Optional information about hierarchy. It is only needed if you want to draw only\n. some of the contours (see maxLevel ).\n. @param maxLevel Maximal level for drawn contours. If it is 0, only the specified contour is drawn.\n. If it is 1, the function draws the contour(s) and all the nested contours. If it is 2, the function\n. draws the contours, all the nested contours, all the nested-to-nested contours, and so on. This\n. parameter is only taken into account when there is hierarchy available.\n. @param offset Optional contour shift parameter. Shift all the drawn contours by the specified\n. \\f$\\texttt{offset}=(dx,dy)\\f$ .\n. @note When thickness=#FILLED, the function is designed to handle connected components with holes correctly\n. even when no hierarchy date is provided. This is done by analyzing all the outlines together\n. using even-odd rule. This may give incorrect results if you have a joint collection of separately retrieved\n. contours. In order to solve this problem, you need to call #drawContours separately for each sub-group\n. of contours, or iterate over the collection using contourIdx parameter.' ... @@ -2716,44 +2425,17 @@ def drawKeypoints(image: ndarray, keypoints, outImage, color=..., flags: int = . ... -def drawMarker( - img: ndarray, - position, - color, - markerType=..., - markerSize=..., - thickness=..., - line_type=...) -> typing.Any: +def drawMarker(img: ndarray, position, color, markerType=..., markerSize=..., thickness=..., line_type=...) -> typing.Any: 'drawMarker(img, position, color[, markerType[, markerSize[, thickness[, line_type]]]]) -> img\n. @brief Draws a marker on a predefined position in an image.\n. \n. The function cv::drawMarker draws a marker on a given position in the image. For the moment several\n. marker types are supported, see #MarkerTypes for more information.\n. \n. @param img Image.\n. @param position The point where the crosshair is positioned.\n. @param color Line color.\n. @param markerType The specific type of marker you want to use, see #MarkerTypes\n. @param thickness Line thickness.\n. @param line_type Type of the line, See #LineTypes\n. @param markerSize The length of the marker axis [default = 20 pixels]' ... -def drawMatches( - img1, - keypoints1, - img2, - keypoints2, - matches1to2, - outImg, - matchColor=..., - singlePointColor=..., - matchesMask=..., - flags: int = ...) -> typing.Any: +def drawMatches(img1, keypoints1, img2, keypoints2, matches1to2, outImg, matchColor=..., singlePointColor=..., matchesMask=..., flags: int = ...) -> typing.Any: 'drawMatches(img1, keypoints1, img2, keypoints2, matches1to2, outImg[, matchColor[, singlePointColor[, matchesMask[, flags]]]]) -> outImg\n. @brief Draws the found matches of keypoints from two images.\n. \n. @param img1 First source image.\n. @param keypoints1 Keypoints from the first source image.\n. @param img2 Second source image.\n. @param keypoints2 Keypoints from the second source image.\n. @param matches1to2 Matches from the first image to the second one, which means that keypoints1[i]\n. has a corresponding point in keypoints2[matches[i]] .\n. @param outImg Output image. Its content depends on the flags value defining what is drawn in the\n. output image. See possible flags bit values below.\n. @param matchColor Color of matches (lines and connected keypoints). If matchColor==Scalar::all(-1)\n. , the color is generated randomly.\n. @param singlePointColor Color of single keypoints (circles), which means that keypoints do not\n. have the matches. If singlePointColor==Scalar::all(-1) , the color is generated randomly.\n. @param matchesMask Mask determining which matches are drawn. If the mask is empty, all matches are\n. drawn.\n. @param flags Flags setting drawing features. Possible flags bit values are defined by\n. DrawMatchesFlags.\n. \n. This function draws matches of keypoints from two images in the output image. Match is a line\n. connecting two keypoints (circles). See cv::DrawMatchesFlags.' ... -def drawMatchesKnn( - img1, - keypoints1, - img2, - keypoints2, - matches1to2, - outImg, - matchColor=..., - singlePointColor=..., - matchesMask=..., - flags: int = ...) -> typing.Any: +def drawMatchesKnn(img1, keypoints1, img2, keypoints2, matches1to2, outImg, matchColor=..., singlePointColor=..., matchesMask=..., flags: int = ...) -> typing.Any: 'drawMatchesKnn(img1, keypoints1, img2, keypoints2, matches1to2, outImg[, matchColor[, singlePointColor[, matchesMask[, flags]]]]) -> outImg\n. @overload' ... @@ -2773,17 +2455,7 @@ def eigenNonSymmetric(src: ndarray, eigenvalues=..., eigenvectors=...) -> typing ... -def ellipse( - img: ndarray, - center, - axes, - angle, - startAngle, - endAngle, - color, - thickness=..., - lineType=..., - shift=...) -> typing.Any: +def ellipse(img: ndarray, center, axes, angle, startAngle, endAngle, color, thickness=..., lineType=..., shift=...) -> typing.Any: 'ellipse(img, center, axes, angle, startAngle, endAngle, color[, thickness[, lineType[, shift]]]) -> img\n. @brief Draws a simple or thick elliptic arc or fills an ellipse sector.\n. \n. The function cv::ellipse with more parameters draws an ellipse outline, a filled ellipse, an elliptic\n. arc, or a filled ellipse sector. The drawing code uses general parametric form.\n. A piecewise-linear curve is used to approximate the elliptic arc\n. boundary. If you need more control of the ellipse rendering, you can retrieve the curve using\n. #ellipse2Poly and then render it with #polylines or fill it with #fillPoly. If you use the first\n. variant of the function and want to draw the whole ellipse, not an arc, pass `startAngle=0` and\n. `endAngle=360`. If `startAngle` is greater than `endAngle`, they are swapped. The figure below explains\n. the meaning of the parameters to draw the blue arc.\n. \n. ![Parameters of Elliptic Arc](pics/ellipse.svg)\n. \n. @param img Image.\n. @param center Center of the ellipse.\n. @param axes Half of the size of the ellipse main axes.\n. @param angle Ellipse rotation angle in degrees.\n. @param startAngle Starting angle of the elliptic arc in degrees.\n. @param endAngle Ending angle of the elliptic arc in degrees.\n. @param color Ellipse color.\n. @param thickness Thickness of the ellipse arc outline, if positive. Otherwise, this indicates that\n. a filled ellipse sector is to be drawn.\n. @param lineType Type of the ellipse boundary. See #LineTypes\n. @param shift Number of fractional bits in the coordinates of the center and values of axes.\n\n\n\nellipse(img, box, color[, thickness[, lineType]]) -> img\n. @overload\n. @param img Image.\n. @param box Alternative ellipse representation via RotatedRect. This means that the function draws\n. an ellipse inscribed in the rotated rectangle.\n. @param color Ellipse color.\n. @param thickness Thickness of the ellipse arc outline, if positive. Otherwise, this indicates that\n. a filled ellipse sector is to be drawn.\n. @param lineType Type of the ellipse boundary. See #LineTypes' ... @@ -2798,14 +2470,7 @@ def equalizeHist(src: ndarray, dts: ndarray = ...) -> typing.Any: ... -def erode( - src: ndarray, - kernel, - dts: ndarray = ..., - anchor=..., - iterations=..., - borderType=..., - borderValue=...) -> typing.Any: +def erode(src: ndarray, kernel, dts: ndarray = ..., anchor=..., iterations=..., borderType=..., borderValue=...) -> typing.Any: "erode(src, kernel[, dst[, anchor[, iterations[, borderType[, borderValue]]]]]) -> dst\n. @brief Erodes an image by using a specific structuring element.\n. \n. The function erodes the source image using the specified structuring element that determines the\n. shape of a pixel neighborhood over which the minimum is taken:\n. \n. \\f[\\texttt{dst} (x,y) = \\min _{(x',y'): \\, \\texttt{element} (x',y') \\ne0 } \\texttt{src} (x+x',y+y')\\f]\n. \n. The function supports the in-place mode. Erosion can be applied several ( iterations ) times. In\n. case of multi-channel images, each channel is processed independently.\n. \n. @param src input image; the number of channels can be arbitrary, but the depth should be one of\n. CV_8U, CV_16U, CV_16S, CV_32F or CV_64F.\n. @param dst output image of the same size and type as src.\n. @param kernel structuring element used for erosion; if `element=Mat()`, a `3 x 3` rectangular\n. structuring element is used. Kernel can be created using #getStructuringElement.\n. @param anchor position of the anchor within the element; default value (-1, -1) means that the\n. anchor is at the element center.\n. @param iterations number of times erosion is applied.\n. @param borderType pixel extrapolation method, see #BorderTypes. #BORDER_WRAP is not supported.\n. @param borderValue border value in case of a constant border\n. @sa dilate, morphologyEx, getStructuringElement" ... @@ -2813,61 +2478,27 @@ def erode( error = _mod_cv2.error -def estimateAffine2D( - from_, - to, - inliers=..., - method: int = ..., - ransacReprojThreshold=..., - maxIters=..., - confidence=..., - refineIters=...) -> typing.Any: +def estimateAffine2D(from_, to, inliers=..., method: int = ..., ransacReprojThreshold=..., maxIters=..., confidence=..., refineIters=...) -> typing.Any: 'estimateAffine2D(from, to[, inliers[, method[, ransacReprojThreshold[, maxIters[, confidence[, refineIters]]]]]]) -> retval, inliers\n. @brief Computes an optimal affine transformation between two 2D point sets.\n. \n. It computes\n. \\f[\n. \\begin{bmatrix}\n. x\\\\\n. y\\\\\n. \\end{bmatrix}\n. =\n. \\begin{bmatrix}\n. a_{11} & a_{12}\\\\\n. a_{21} & a_{22}\\\\\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X\\\\\n. Y\\\\\n. \\end{bmatrix}\n. +\n. \\begin{bmatrix}\n. b_1\\\\\n. b_2\\\\\n. \\end{bmatrix}\n. \\f]\n. \n. @param from First input 2D point set containing \\f$(X,Y)\\f$.\n. @param to Second input 2D point set containing \\f$(x,y)\\f$.\n. @param inliers Output vector indicating which points are inliers (1-inlier, 0-outlier).\n. @param method Robust method used to compute transformation. The following methods are possible:\n. - cv::RANSAC - RANSAC-based robust method\n. - cv::LMEDS - Least-Median robust method\n. RANSAC is the default method.\n. @param ransacReprojThreshold Maximum reprojection error in the RANSAC algorithm to consider\n. a point as an inlier. Applies only to RANSAC.\n. @param maxIters The maximum number of robust method iterations.\n. @param confidence Confidence level, between 0 and 1, for the estimated transformation. Anything\n. between 0.95 and 0.99 is usually good enough. Values too close to 1 can slow down the estimation\n. significantly. Values lower than 0.8-0.9 can result in an incorrectly estimated transformation.\n. @param refineIters Maximum number of iterations of refining algorithm (Levenberg-Marquardt).\n. Passing 0 will disable refining, so the output matrix will be output of robust method.\n. \n. @return Output 2D affine transformation matrix \\f$2 \\times 3\\f$ or empty matrix if transformation\n. could not be estimated. The returned matrix has the following form:\n. \\f[\n. \\begin{bmatrix}\n. a_{11} & a_{12} & b_1\\\\\n. a_{21} & a_{22} & b_2\\\\\n. \\end{bmatrix}\n. \\f]\n. \n. The function estimates an optimal 2D affine transformation between two 2D point sets using the\n. selected robust algorithm.\n. \n. The computed transformation is then refined further (using only inliers) with the\n. Levenberg-Marquardt method to reduce the re-projection error even more.\n. \n. @note\n. The RANSAC method can handle practically any ratio of outliers but needs a threshold to\n. distinguish inliers from outliers. The method LMeDS does not need any threshold but it works\n. correctly only when there are more than 50% of inliers.\n. \n. @sa estimateAffinePartial2D, getAffineTransform' ... -def estimateAffine3D( - src: ndarray, - dts: ndarray, - out=..., - inliers=..., - ransacThreshold=..., - confidence=...) -> typing.Any: +def estimateAffine3D(src: ndarray, dts: ndarray, out=..., inliers=..., ransacThreshold=..., confidence=...) -> typing.Any: 'estimateAffine3D(src, dst[, out[, inliers[, ransacThreshold[, confidence]]]]) -> retval, out, inliers\n. @brief Computes an optimal affine transformation between two 3D point sets.\n. \n. It computes\n. \\f[\n. \\begin{bmatrix}\n. x\\\\\n. y\\\\\n. z\\\\\n. \\end{bmatrix}\n. =\n. \\begin{bmatrix}\n. a_{11} & a_{12} & a_{13}\\\\\n. a_{21} & a_{22} & a_{23}\\\\\n. a_{31} & a_{32} & a_{33}\\\\\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X\\\\\n. Y\\\\\n. Z\\\\\n. \\end{bmatrix}\n. +\n. \\begin{bmatrix}\n. b_1\\\\\n. b_2\\\\\n. b_3\\\\\n. \\end{bmatrix}\n. \\f]\n. \n. @param src First input 3D point set containing \\f$(X,Y,Z)\\f$.\n. @param dst Second input 3D point set containing \\f$(x,y,z)\\f$.\n. @param out Output 3D affine transformation matrix \\f$3 \\times 4\\f$ of the form\n. \\f[\n. \\begin{bmatrix}\n. a_{11} & a_{12} & a_{13} & b_1\\\\\n. a_{21} & a_{22} & a_{23} & b_2\\\\\n. a_{31} & a_{32} & a_{33} & b_3\\\\\n. \\end{bmatrix}\n. \\f]\n. @param inliers Output vector indicating which points are inliers (1-inlier, 0-outlier).\n. @param ransacThreshold Maximum reprojection error in the RANSAC algorithm to consider a point as\n. an inlier.\n. @param confidence Confidence level, between 0 and 1, for the estimated transformation. Anything\n. between 0.95 and 0.99 is usually good enough. Values too close to 1 can slow down the estimation\n. significantly. Values lower than 0.8-0.9 can result in an incorrectly estimated transformation.\n. \n. The function estimates an optimal 3D affine transformation between two 3D point sets using the\n. RANSAC algorithm.' ... -def estimateAffinePartial2D( - from_, - to, - inliers=..., - method: int = ..., - ransacReprojThreshold=..., - maxIters=..., - confidence=..., - refineIters=...) -> typing.Any: +def estimateAffinePartial2D(from_, to, inliers=..., method: int = ..., ransacReprojThreshold=..., maxIters=..., confidence=..., refineIters=...) -> typing.Any: 'estimateAffinePartial2D(from, to[, inliers[, method[, ransacReprojThreshold[, maxIters[, confidence[, refineIters]]]]]]) -> retval, inliers\n. @brief Computes an optimal limited affine transformation with 4 degrees of freedom between\n. two 2D point sets.\n. \n. @param from First input 2D point set.\n. @param to Second input 2D point set.\n. @param inliers Output vector indicating which points are inliers.\n. @param method Robust method used to compute transformation. The following methods are possible:\n. - cv::RANSAC - RANSAC-based robust method\n. - cv::LMEDS - Least-Median robust method\n. RANSAC is the default method.\n. @param ransacReprojThreshold Maximum reprojection error in the RANSAC algorithm to consider\n. a point as an inlier. Applies only to RANSAC.\n. @param maxIters The maximum number of robust method iterations.\n. @param confidence Confidence level, between 0 and 1, for the estimated transformation. Anything\n. between 0.95 and 0.99 is usually good enough. Values too close to 1 can slow down the estimation\n. significantly. Values lower than 0.8-0.9 can result in an incorrectly estimated transformation.\n. @param refineIters Maximum number of iterations of refining algorithm (Levenberg-Marquardt).\n. Passing 0 will disable refining, so the output matrix will be output of robust method.\n. \n. @return Output 2D affine transformation (4 degrees of freedom) matrix \\f$2 \\times 3\\f$ or\n. empty matrix if transformation could not be estimated.\n. \n. The function estimates an optimal 2D affine transformation with 4 degrees of freedom limited to\n. combinations of translation, rotation, and uniform scaling. Uses the selected algorithm for robust\n. estimation.\n. \n. The computed transformation is then refined further (using only inliers) with the\n. Levenberg-Marquardt method to reduce the re-projection error even more.\n. \n. Estimated transformation matrix is:\n. \\f[ \\begin{bmatrix} \\cos(\\theta) \\cdot s & -\\sin(\\theta) \\cdot s & t_x \\\\\n. \\sin(\\theta) \\cdot s & \\cos(\\theta) \\cdot s & t_y\n. \\end{bmatrix} \\f]\n. Where \\f$ \\theta \\f$ is the rotation angle, \\f$ s \\f$ the scaling factor and \\f$ t_x, t_y \\f$ are\n. translations in \\f$ x, y \\f$ axes respectively.\n. \n. @note\n. The RANSAC method can handle practically any ratio of outliers but need a threshold to\n. distinguish inliers from outliers. The method LMeDS does not need any threshold but it works\n. correctly only when there are more than 50% of inliers.\n. \n. @sa estimateAffine2D, getAffineTransform' ... -def estimateChessboardSharpness( - image: ndarray, - patternSize, - corners, - rise_distance=..., - vertical=..., - sharpness=...) -> typing.Any: +def estimateChessboardSharpness(image: ndarray, patternSize, corners, rise_distance=..., vertical=..., sharpness=...) -> typing.Any: 'estimateChessboardSharpness(image, patternSize, corners[, rise_distance[, vertical[, sharpness]]]) -> retval, sharpness\n. @brief Estimates the sharpness of a detected chessboard.\n. \n. Image sharpness, as well as brightness, are a critical parameter for accuracte\n. camera calibration. For accessing these parameters for filtering out\n. problematic calibraiton images, this method calculates edge profiles by traveling from\n. black to white chessboard cell centers. Based on this, the number of pixels is\n. calculated required to transit from black to white. This width of the\n. transition area is a good indication of how sharp the chessboard is imaged\n. and should be below ~3.0 pixels.\n. \n. @param image Gray image used to find chessboard corners\n. @param patternSize Size of a found chessboard pattern\n. @param corners Corners found by findChessboardCorners(SB)\n. @param rise_distance Rise distance 0.8 means 10% ... 90% of the final signal strength\n. @param vertical By default edge responses for horizontal lines are calculated\n. @param sharpness Optional output array with a sharpness value for calculated edge responses (see description)\n. \n. The optional sharpness array is of type CV_32FC1 and has for each calculated\n. profile one row with the following five entries:\n. * 0 = x coordinate of the underlying edge in the image\n. * 1 = y coordinate of the underlying edge in the image\n. * 2 = width of the transition area (sharpness)\n. * 3 = signal strength in the black cell (min brightness)\n. * 4 = signal strength in the white cell (max brightness)\n. \n. @return Scalar(average sharpness, average min brightness, average max brightness,0)' ... -def estimateTranslation3D( - src: ndarray, - dts: ndarray, - out=..., - inliers=..., - ransacThreshold=..., - confidence=...) -> typing.Any: +def estimateTranslation3D(src: ndarray, dts: ndarray, out=..., inliers=..., ransacThreshold=..., confidence=...) -> typing.Any: 'estimateTranslation3D(src, dst[, out[, inliers[, ransacThreshold[, confidence]]]]) -> retval, out, inliers\n. @brief Computes an optimal translation between two 3D point sets.\n. *\n. * It computes\n. * \\f[\n. * \\begin{bmatrix}\n. * x\\\\\n. * y\\\\\n. * z\\\\\n. * \\end{bmatrix}\n. * =\n. * \\begin{bmatrix}\n. * X\\\\\n. * Y\\\\\n. * Z\\\\\n. * \\end{bmatrix}\n. * +\n. * \\begin{bmatrix}\n. * b_1\\\\\n. * b_2\\\\\n. * b_3\\\\\n. * \\end{bmatrix}\n. * \\f]\n. *\n. * @param src First input 3D point set containing \\f$(X,Y,Z)\\f$.\n. * @param dst Second input 3D point set containing \\f$(x,y,z)\\f$.\n. * @param out Output 3D translation vector \\f$3 \\times 1\\f$ of the form\n. * \\f[\n. * \\begin{bmatrix}\n. * b_1 \\\\\n. * b_2 \\\\\n. * b_3 \\\\\n. * \\end{bmatrix}\n. * \\f]\n. * @param inliers Output vector indicating which points are inliers (1-inlier, 0-outlier).\n. * @param ransacThreshold Maximum reprojection error in the RANSAC algorithm to consider a point as\n. * an inlier.\n. * @param confidence Confidence level, between 0 and 1, for the estimated transformation. Anything\n. * between 0.95 and 0.99 is usually good enough. Values too close to 1 can slow down the estimation\n. * significantly. Values lower than 0.8-0.9 can result in an incorrectly estimated transformation.\n. *\n. * The function estimates an optimal 3D translation between two 3D point sets using the\n. * RANSAC algorithm.\n. *' ... @@ -2887,48 +2518,22 @@ def fastAtan2(y, x) -> typing.Any: ... -def fastNlMeansDenoising( - src: ndarray, - dts: ndarray = ..., - h=..., - templateWindowSize=..., - searchWindowSize=...) -> typing.Any: +def fastNlMeansDenoising(src: ndarray, dts: ndarray = ..., h=..., templateWindowSize=..., searchWindowSize=...) -> typing.Any: 'fastNlMeansDenoising(src[, dst[, h[, templateWindowSize[, searchWindowSize]]]]) -> dst\n. @brief Perform image denoising using Non-local Means Denoising algorithm\n. with several computational\n. optimizations. Noise expected to be a gaussian white noise\n. \n. @param src Input 8-bit 1-channel, 2-channel, 3-channel or 4-channel image.\n. @param dst Output image with the same size and type as src .\n. @param templateWindowSize Size in pixels of the template patch that is used to compute weights.\n. Should be odd. Recommended value 7 pixels\n. @param searchWindowSize Size in pixels of the window that is used to compute weighted average for\n. given pixel. Should be odd. Affect performance linearly: greater searchWindowsSize - greater\n. denoising time. Recommended value 21 pixels\n. @param h Parameter regulating filter strength. Big h value perfectly removes noise but also\n. removes image details, smaller h value preserves details but also preserves some noise\n. \n. This function expected to be applied to grayscale images. For colored images look at\n. fastNlMeansDenoisingColored. Advanced usage of this functions can be manual denoising of colored\n. image in different colorspaces. Such approach is used in fastNlMeansDenoisingColored by converting\n. image to CIELAB colorspace and then separately denoise L and AB components with different h\n. parameter.\n\n\n\nfastNlMeansDenoising(src, h[, dst[, templateWindowSize[, searchWindowSize[, normType]]]]) -> dst\n. @brief Perform image denoising using Non-local Means Denoising algorithm\n. with several computational\n. optimizations. Noise expected to be a gaussian white noise\n. \n. @param src Input 8-bit or 16-bit (only with NORM_L1) 1-channel,\n. 2-channel, 3-channel or 4-channel image.\n. @param dst Output image with the same size and type as src .\n. @param templateWindowSize Size in pixels of the template patch that is used to compute weights.\n. Should be odd. Recommended value 7 pixels\n. @param searchWindowSize Size in pixels of the window that is used to compute weighted average for\n. given pixel. Should be odd. Affect performance linearly: greater searchWindowsSize - greater\n. denoising time. Recommended value 21 pixels\n. @param h Array of parameters regulating filter strength, either one\n. parameter applied to all channels or one per channel in dst. Big h value\n. perfectly removes noise but also removes image details, smaller h\n. value preserves details but also preserves some noise\n. @param normType Type of norm used for weight calculation. Can be either NORM_L2 or NORM_L1\n. \n. This function expected to be applied to grayscale images. For colored images look at\n. fastNlMeansDenoisingColored. Advanced usage of this functions can be manual denoising of colored\n. image in different colorspaces. Such approach is used in fastNlMeansDenoisingColored by converting\n. image to CIELAB colorspace and then separately denoise L and AB components with different h\n. parameter.' ... -def fastNlMeansDenoisingColored( - src: ndarray, - dts: ndarray = ..., - h=..., - hColor=..., - templateWindowSize=..., - searchWindowSize=...) -> typing.Any: +def fastNlMeansDenoisingColored(src: ndarray, dts: ndarray = ..., h=..., hColor=..., templateWindowSize=..., searchWindowSize=...) -> typing.Any: 'fastNlMeansDenoisingColored(src[, dst[, h[, hColor[, templateWindowSize[, searchWindowSize]]]]]) -> dst\n. @brief Modification of fastNlMeansDenoising function for colored images\n. \n. @param src Input 8-bit 3-channel image.\n. @param dst Output image with the same size and type as src .\n. @param templateWindowSize Size in pixels of the template patch that is used to compute weights.\n. Should be odd. Recommended value 7 pixels\n. @param searchWindowSize Size in pixels of the window that is used to compute weighted average for\n. given pixel. Should be odd. Affect performance linearly: greater searchWindowsSize - greater\n. denoising time. Recommended value 21 pixels\n. @param h Parameter regulating filter strength for luminance component. Bigger h value perfectly\n. removes noise but also removes image details, smaller h value preserves details but also preserves\n. some noise\n. @param hColor The same as h but for color components. For most images value equals 10\n. will be enough to remove colored noise and do not distort colors\n. \n. The function converts image to CIELAB colorspace and then separately denoise L and AB components\n. with given h parameters using fastNlMeansDenoising function.' ... -def fastNlMeansDenoisingColoredMulti( - srcImgs, - imgToDenoiseIndex, - temporalWindowSize, - dts: ndarray = ..., - h=..., - hColor=..., - templateWindowSize=..., - searchWindowSize=...) -> typing.Any: +def fastNlMeansDenoisingColoredMulti(srcImgs, imgToDenoiseIndex, temporalWindowSize, dts: ndarray = ..., h=..., hColor=..., templateWindowSize=..., searchWindowSize=...) -> typing.Any: 'fastNlMeansDenoisingColoredMulti(srcImgs, imgToDenoiseIndex, temporalWindowSize[, dst[, h[, hColor[, templateWindowSize[, searchWindowSize]]]]]) -> dst\n. @brief Modification of fastNlMeansDenoisingMulti function for colored images sequences\n. \n. @param srcImgs Input 8-bit 3-channel images sequence. All images should have the same type and\n. size.\n. @param imgToDenoiseIndex Target image to denoise index in srcImgs sequence\n. @param temporalWindowSize Number of surrounding images to use for target image denoising. Should\n. be odd. Images from imgToDenoiseIndex - temporalWindowSize / 2 to\n. imgToDenoiseIndex - temporalWindowSize / 2 from srcImgs will be used to denoise\n. srcImgs[imgToDenoiseIndex] image.\n. @param dst Output image with the same size and type as srcImgs images.\n. @param templateWindowSize Size in pixels of the template patch that is used to compute weights.\n. Should be odd. Recommended value 7 pixels\n. @param searchWindowSize Size in pixels of the window that is used to compute weighted average for\n. given pixel. Should be odd. Affect performance linearly: greater searchWindowsSize - greater\n. denoising time. Recommended value 21 pixels\n. @param h Parameter regulating filter strength for luminance component. Bigger h value perfectly\n. removes noise but also removes image details, smaller h value preserves details but also preserves\n. some noise.\n. @param hColor The same as h but for color components.\n. \n. The function converts images to CIELAB colorspace and then separately denoise L and AB components\n. with given h parameters using fastNlMeansDenoisingMulti function.' ... -def fastNlMeansDenoisingMulti( - srcImgs, - imgToDenoiseIndex, - temporalWindowSize, - dts: ndarray = ..., - h=..., - templateWindowSize=..., - searchWindowSize=...) -> typing.Any: +def fastNlMeansDenoisingMulti(srcImgs, imgToDenoiseIndex, temporalWindowSize, dts: ndarray = ..., h=..., templateWindowSize=..., searchWindowSize=...) -> typing.Any: 'fastNlMeansDenoisingMulti(srcImgs, imgToDenoiseIndex, temporalWindowSize[, dst[, h[, templateWindowSize[, searchWindowSize]]]]) -> dst\n. @brief Modification of fastNlMeansDenoising function for images sequence where consecutive images have been\n. captured in small period of time. For example video. This version of the function is for grayscale\n. images or for manual manipulation with colorspaces. For more details see\n. \n. \n. @param srcImgs Input 8-bit 1-channel, 2-channel, 3-channel or\n. 4-channel images sequence. All images should have the same type and\n. size.\n. @param imgToDenoiseIndex Target image to denoise index in srcImgs sequence\n. @param temporalWindowSize Number of surrounding images to use for target image denoising. Should\n. be odd. Images from imgToDenoiseIndex - temporalWindowSize / 2 to\n. imgToDenoiseIndex - temporalWindowSize / 2 from srcImgs will be used to denoise\n. srcImgs[imgToDenoiseIndex] image.\n. @param dst Output image with the same size and type as srcImgs images.\n. @param templateWindowSize Size in pixels of the template patch that is used to compute weights.\n. Should be odd. Recommended value 7 pixels\n. @param searchWindowSize Size in pixels of the window that is used to compute weighted average for\n. given pixel. Should be odd. Affect performance linearly: greater searchWindowsSize - greater\n. denoising time. Recommended value 21 pixels\n. @param h Parameter regulating filter strength. Bigger h value\n. perfectly removes noise but also removes image details, smaller h\n. value preserves details but also preserves some noise\n\n\n\nfastNlMeansDenoisingMulti(srcImgs, imgToDenoiseIndex, temporalWindowSize, h[, dst[, templateWindowSize[, searchWindowSize[, normType]]]]) -> dst\n. @brief Modification of fastNlMeansDenoising function for images sequence where consecutive images have been\n. captured in small period of time. For example video. This version of the function is for grayscale\n. images or for manual manipulation with colorspaces. For more details see\n. \n. \n. @param srcImgs Input 8-bit or 16-bit (only with NORM_L1) 1-channel,\n. 2-channel, 3-channel or 4-channel images sequence. All images should\n. have the same type and size.\n. @param imgToDenoiseIndex Target image to denoise index in srcImgs sequence\n. @param temporalWindowSize Number of surrounding images to use for target image denoising. Should\n. be odd. Images from imgToDenoiseIndex - temporalWindowSize / 2 to\n. imgToDenoiseIndex - temporalWindowSize / 2 from srcImgs will be used to denoise\n. srcImgs[imgToDenoiseIndex] image.\n. @param dst Output image with the same size and type as srcImgs images.\n. @param templateWindowSize Size in pixels of the template patch that is used to compute weights.\n. Should be odd. Recommended value 7 pixels\n. @param searchWindowSize Size in pixels of the window that is used to compute weighted average for\n. given pixel. Should be odd. Affect performance linearly: greater searchWindowsSize - greater\n. denoising time. Recommended value 21 pixels\n. @param h Array of parameters regulating filter strength, either one\n. parameter applied to all channels or one per channel in dst. Big h value\n. perfectly removes noise but also removes image details, smaller h\n. value preserves details but also preserves some noise\n. @param normType Type of norm used for weight calculation. Can be either NORM_L2 or NORM_L1' ... @@ -2948,13 +2553,7 @@ def filter2D(src: ndarray, ddepth, kernel, dts: ndarray = ..., anchor=..., delta ... -def filterHomographyDecompByVisibleRefpoints( - rotations, - normals, - beforePoints, - afterPoints, - possibleSolutions=..., - pointsMask=...) -> typing.Any: +def filterHomographyDecompByVisibleRefpoints(rotations, normals, beforePoints, afterPoints, possibleSolutions=..., pointsMask=...) -> typing.Any: 'filterHomographyDecompByVisibleRefpoints(rotations, normals, beforePoints, afterPoints[, possibleSolutions[, pointsMask]]) -> possibleSolutions\n. @brief Filters homography decompositions based on additional information.\n. \n. @param rotations Vector of rotation matrices.\n. @param normals Vector of plane normal matrices.\n. @param beforePoints Vector of (rectified) visible reference points before the homography is applied\n. @param afterPoints Vector of (rectified) visible reference points after the homography is applied\n. @param possibleSolutions Vector of int indices representing the viable solution set after filtering\n. @param pointsMask optional Mat/Vector of 8u type representing the mask for the inliers as given by the findHomography function\n. \n. This function is intended to filter the output of the decomposeHomographyMat based on additional\n. information as described in @cite Malis . The summary of the method: the decomposeHomographyMat function\n. returns 2 unique solutions and their "opposites" for a total of 4 solutions. If we have access to the\n. sets of points visible in the camera frame before and after the homography transformation is applied,\n. we can determine which are the true potential solutions and which are the opposites by verifying which\n. homographies are consistent with all visible reference points being in front of the camera. The inputs\n. are left unchanged; the filtered solution set is returned as indices into the existing one.' ... @@ -2994,38 +2593,17 @@ def findContours(image: ndarray, mode, method: int, contours=..., hierarchy=..., ... -def findEssentialMat( - points1, - points2, - cameraMatrix, - method: int = ..., - prob=..., - threshold=..., - mask: ndarray = ...) -> typing.Any: +def findEssentialMat(points1, points2, cameraMatrix, method: int = ..., prob=..., threshold=..., mask: ndarray = ...) -> typing.Any: 'findEssentialMat(points1, points2, cameraMatrix[, method[, prob[, threshold[, mask]]]]) -> retval, mask\n. @brief Calculates an essential matrix from the corresponding points in two images.\n. \n. @param points1 Array of N (N \\>= 5) 2D points from the first image. The point coordinates should\n. be floating-point (single or double precision).\n. @param points2 Array of the second image points of the same size and format as points1 .\n. @param cameraMatrix Camera matrix \\f$K = \\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\\f$ .\n. Note that this function assumes that points1 and points2 are feature points from cameras with the\n. same camera matrix. If this assumption does not hold for your use case, use\n. `undistortPoints()` with `P = cv::NoArray()` for both cameras to transform image points\n. to normalized image coordinates, which are valid for the identity camera matrix. When\n. passing these coordinates, pass the identity matrix for this parameter.\n. @param method Method for computing an essential matrix.\n. - **RANSAC** for the RANSAC algorithm.\n. - **LMEDS** for the LMedS algorithm.\n. @param prob Parameter used for the RANSAC or LMedS methods only. It specifies a desirable level of\n. confidence (probability) that the estimated matrix is correct.\n. @param threshold Parameter used for RANSAC. It is the maximum distance from a point to an epipolar\n. line in pixels, beyond which the point is considered an outlier and is not used for computing the\n. final fundamental matrix. It can be set to something like 1-3, depending on the accuracy of the\n. point localization, image resolution, and the image noise.\n. @param mask Output array of N elements, every element of which is set to 0 for outliers and to 1\n. for the other points. The array is computed only in the RANSAC and LMedS methods.\n. \n. This function estimates essential matrix based on the five-point algorithm solver in @cite Nister03 .\n. @cite SteweniusCFS is also a related. The epipolar geometry is described by the following equation:\n. \n. \\f[[p_2; 1]^T K^{-T} E K^{-1} [p_1; 1] = 0\\f]\n. \n. where \\f$E\\f$ is an essential matrix, \\f$p_1\\f$ and \\f$p_2\\f$ are corresponding points in the first and the\n. second images, respectively. The result of this function may be passed further to\n. decomposeEssentialMat or recoverPose to recover the relative pose between cameras.\n\n\n\nfindEssentialMat(points1, points2[, focal[, pp[, method[, prob[, threshold[, mask]]]]]]) -> retval, mask\n. @overload\n. @param points1 Array of N (N \\>= 5) 2D points from the first image. The point coordinates should\n. be floating-point (single or double precision).\n. @param points2 Array of the second image points of the same size and format as points1 .\n. @param focal focal length of the camera. Note that this function assumes that points1 and points2\n. are feature points from cameras with same focal length and principal point.\n. @param pp principal point of the camera.\n. @param method Method for computing a fundamental matrix.\n. - **RANSAC** for the RANSAC algorithm.\n. - **LMEDS** for the LMedS algorithm.\n. @param threshold Parameter used for RANSAC. It is the maximum distance from a point to an epipolar\n. line in pixels, beyond which the point is considered an outlier and is not used for computing the\n. final fundamental matrix. It can be set to something like 1-3, depending on the accuracy of the\n. point localization, image resolution, and the image noise.\n. @param prob Parameter used for the RANSAC or LMedS methods only. It specifies a desirable level of\n. confidence (probability) that the estimated matrix is correct.\n. @param mask Output array of N elements, every element of which is set to 0 for outliers and to 1\n. for the other points. The array is computed only in the RANSAC and LMedS methods.\n. \n. This function differs from the one above that it computes camera matrix from focal length and\n. principal point:\n. \n. \\f[K =\n. \\begin{bmatrix}\n. f & 0 & x_{pp} \\\\\n. 0 & f & y_{pp} \\\\\n. 0 & 0 & 1\n. \\end{bmatrix}\\f]' ... -def findFundamentalMat( - points1, - points2, - method: int, - ransacReprojThreshold, - confidence, - maxIters, - mask: ndarray = ...) -> typing.Any: +def findFundamentalMat(points1, points2, method: int, ransacReprojThreshold, confidence, maxIters, mask: ndarray = ...) -> typing.Any: 'findFundamentalMat(points1, points2, method, ransacReprojThreshold, confidence, maxIters[, mask]) -> retval, mask\n. @brief Calculates a fundamental matrix from the corresponding points in two images.\n. \n. @param points1 Array of N points from the first image. The point coordinates should be\n. floating-point (single or double precision).\n. @param points2 Array of the second image points of the same size and format as points1 .\n. @param method Method for computing a fundamental matrix.\n. - **CV_FM_7POINT** for a 7-point algorithm. \\f$N = 7\\f$\n. - **CV_FM_8POINT** for an 8-point algorithm. \\f$N \\ge 8\\f$\n. - **CV_FM_RANSAC** for the RANSAC algorithm. \\f$N \\ge 8\\f$\n. - **CV_FM_LMEDS** for the LMedS algorithm. \\f$N \\ge 8\\f$\n. @param ransacReprojThreshold Parameter used only for RANSAC. It is the maximum distance from a point to an epipolar\n. line in pixels, beyond which the point is considered an outlier and is not used for computing the\n. final fundamental matrix. It can be set to something like 1-3, depending on the accuracy of the\n. point localization, image resolution, and the image noise.\n. @param confidence Parameter used for the RANSAC and LMedS methods only. It specifies a desirable level\n. of confidence (probability) that the estimated matrix is correct.\n. @param mask\n. @param maxIters The maximum number of robust method iterations.\n. \n. The epipolar geometry is described by the following equation:\n. \n. \\f[[p_2; 1]^T F [p_1; 1] = 0\\f]\n. \n. where \\f$F\\f$ is a fundamental matrix, \\f$p_1\\f$ and \\f$p_2\\f$ are corresponding points in the first and the\n. second images, respectively.\n. \n. The function calculates the fundamental matrix using one of four methods listed above and returns\n. the found fundamental matrix. Normally just one matrix is found. But in case of the 7-point\n. algorithm, the function may return up to 3 solutions ( \\f$9 \\times 3\\f$ matrix that stores all 3\n. matrices sequentially).\n. \n. The calculated fundamental matrix may be passed further to computeCorrespondEpilines that finds the\n. epipolar lines corresponding to the specified points. It can also be passed to\n. stereoRectifyUncalibrated to compute the rectification transformation. :\n. @code\n. // Example. Estimation of fundamental matrix using the RANSAC algorithm\n. int point_count = 100;\n. vector points1(point_count);\n. vector points2(point_count);\n. \n. // initialize the points here ...\n. for( int i = 0; i < point_count; i++ )\n. {\n. points1[i] = ...;\n. points2[i] = ...;\n. }\n. \n. Mat fundamental_matrix =\n. findFundamentalMat(points1, points2, FM_RANSAC, 3, 0.99);\n. @endcode\n\n\n\nfindFundamentalMat(points1, points2[, method[, ransacReprojThreshold[, confidence[, mask]]]]) -> retval, mask\n. @overload' ... -def findHomography( - srcPoints, - dstPoints, - method: int = ..., - ransacReprojThreshold=..., - mask: ndarray = ..., - maxIters=..., - confidence=...) -> typing.Any: +def findHomography(srcPoints, dstPoints, method: int = ..., ransacReprojThreshold=..., mask: ndarray = ..., maxIters=..., confidence=...) -> typing.Any: "findHomography(srcPoints, dstPoints[, method[, ransacReprojThreshold[, mask[, maxIters[, confidence]]]]]) -> retval, mask\n. @brief Finds a perspective transformation between two planes.\n. \n. @param srcPoints Coordinates of the points in the original plane, a matrix of the type CV_32FC2\n. or vector\\ .\n. @param dstPoints Coordinates of the points in the target plane, a matrix of the type CV_32FC2 or\n. a vector\\ .\n. @param method Method used to compute a homography matrix. The following methods are possible:\n. - **0** - a regular method using all the points, i.e., the least squares method\n. - **RANSAC** - RANSAC-based robust method\n. - **LMEDS** - Least-Median robust method\n. - **RHO** - PROSAC-based robust method\n. @param ransacReprojThreshold Maximum allowed reprojection error to treat a point pair as an inlier\n. (used in the RANSAC and RHO methods only). That is, if\n. \\f[\\| \\texttt{dstPoints} _i - \\texttt{convertPointsHomogeneous} ( \\texttt{H} * \\texttt{srcPoints} _i) \\|_2 > \\texttt{ransacReprojThreshold}\\f]\n. then the point \\f$i\\f$ is considered as an outlier. If srcPoints and dstPoints are measured in pixels,\n. it usually makes sense to set this parameter somewhere in the range of 1 to 10.\n. @param mask Optional output mask set by a robust method ( RANSAC or LMEDS ). Note that the input\n. mask values are ignored.\n. @param maxIters The maximum number of RANSAC iterations.\n. @param confidence Confidence level, between 0 and 1.\n. \n. The function finds and returns the perspective transformation \\f$H\\f$ between the source and the\n. destination planes:\n. \n. \\f[s_i \\vecthree{x'_i}{y'_i}{1} \\sim H \\vecthree{x_i}{y_i}{1}\\f]\n. \n. so that the back-projection error\n. \n. \\f[\\sum _i \\left ( x'_i- \\frac{h_{11} x_i + h_{12} y_i + h_{13}}{h_{31} x_i + h_{32} y_i + h_{33}} \\right )^2+ \\left ( y'_i- \\frac{h_{21} x_i + h_{22} y_i + h_{23}}{h_{31} x_i + h_{32} y_i + h_{33}} \\right )^2\\f]\n. \n. is minimized. If the parameter method is set to the default value 0, the function uses all the point\n. pairs to compute an initial homography estimate with a simple least-squares scheme.\n. \n. However, if not all of the point pairs ( \\f$srcPoints_i\\f$, \\f$dstPoints_i\\f$ ) fit the rigid perspective\n. transformation (that is, there are some outliers), this initial estimate will be poor. In this case,\n. you can use one of the three robust methods. The methods RANSAC, LMeDS and RHO try many different\n. random subsets of the corresponding point pairs (of four pairs each, collinear pairs are discarded), estimate the homography matrix\n. using this subset and a simple least-squares algorithm, and then compute the quality/goodness of the\n. computed homography (which is the number of inliers for RANSAC or the least median re-projection error for\n. LMeDS). The best subset is then used to produce the initial estimate of the homography matrix and\n. the mask of inliers/outliers.\n. \n. Regardless of the method, robust or not, the computed homography matrix is refined further (using\n. inliers only in case of a robust method) with the Levenberg-Marquardt method to reduce the\n. re-projection error even more.\n. \n. The methods RANSAC and RHO can handle practically any ratio of outliers but need a threshold to\n. distinguish inliers from outliers. The method LMeDS does not need any threshold but it works\n. correctly only when there are more than 50% of inliers. Finally, if there are no outliers and the\n. noise is rather small, use the default method (method=0).\n. \n. The function is used to find initial intrinsic and extrinsic matrices. Homography matrix is\n. determined up to a scale. Thus, it is normalized so that \\f$h_{33}=1\\f$. Note that whenever an \\f$H\\f$ matrix\n. cannot be estimated, an empty one will be returned.\n. \n. @sa\n. getAffineTransform, estimateAffine2D, estimateAffinePartial2D, getPerspectiveTransform, warpPerspective,\n. perspectiveTransform" ... @@ -3035,14 +2613,7 @@ def findNonZero(src: ndarray, idx=...) -> typing.Any: ... -def findTransformECC( - templateImage, - inputImage, - warpMatrix, - motionType, - criteria, - inputMask, - gaussFiltSize) -> typing.Any: +def findTransformECC(templateImage, inputImage, warpMatrix, motionType, criteria, inputMask, gaussFiltSize) -> typing.Any: "findTransformECC(templateImage, inputImage, warpMatrix, motionType, criteria, inputMask, gaussFiltSize) -> retval, warpMatrix\n. @brief Finds the geometric transform (warp) between two images in terms of the ECC criterion @cite EP08 .\n. \n. @param templateImage single-channel template image; CV_8U or CV_32F array.\n. @param inputImage single-channel input image which should be warped with the final warpMatrix in\n. order to provide an image similar to templateImage, same type as templateImage.\n. @param warpMatrix floating-point \\f$2\\times 3\\f$ or \\f$3\\times 3\\f$ mapping matrix (warp).\n. @param motionType parameter, specifying the type of motion:\n. - **MOTION_TRANSLATION** sets a translational motion model; warpMatrix is \\f$2\\times 3\\f$ with\n. the first \\f$2\\times 2\\f$ part being the unity matrix and the rest two parameters being\n. estimated.\n. - **MOTION_EUCLIDEAN** sets a Euclidean (rigid) transformation as motion model; three\n. parameters are estimated; warpMatrix is \\f$2\\times 3\\f$.\n. - **MOTION_AFFINE** sets an affine motion model (DEFAULT); six parameters are estimated;\n. warpMatrix is \\f$2\\times 3\\f$.\n. - **MOTION_HOMOGRAPHY** sets a homography as a motion model; eight parameters are\n. estimated;\\`warpMatrix\\` is \\f$3\\times 3\\f$.\n. @param criteria parameter, specifying the termination criteria of the ECC algorithm;\n. criteria.epsilon defines the threshold of the increment in the correlation coefficient between two\n. iterations (a negative criteria.epsilon makes criteria.maxcount the only termination criterion).\n. Default values are shown in the declaration above.\n. @param inputMask An optional mask to indicate valid values of inputImage.\n. @param gaussFiltSize An optional value indicating size of gaussian blur filter; (DEFAULT: 5)\n. \n. The function estimates the optimum transformation (warpMatrix) with respect to ECC criterion\n. (@cite EP08), that is\n. \n. \\f[\\texttt{warpMatrix} = \\arg\\max_{W} \\texttt{ECC}(\\texttt{templateImage}(x,y),\\texttt{inputImage}(x',y'))\\f]\n. \n. where\n. \n. \\f[\\begin{bmatrix} x' \\\\ y' \\end{bmatrix} = W \\cdot \\begin{bmatrix} x \\\\ y \\\\ 1 \\end{bmatrix}\\f]\n. \n. (the equation holds with homogeneous coordinates for homography). It returns the final enhanced\n. correlation coefficient, that is the correlation coefficient between the template image and the\n. final warped input image. When a \\f$3\\times 3\\f$ matrix is given with motionType =0, 1 or 2, the third\n. row is ignored.\n. \n. Unlike findHomography and estimateRigidTransform, the function findTransformECC implements an\n. area-based alignment that builds on intensity similarities. In essence, the function updates the\n. initial transformation that roughly aligns the images. If this information is missing, the identity\n. warp (unity matrix) is used as an initialization. Note that if images undergo strong\n. displacements/rotations, an initial transformation that roughly aligns the images is necessary\n. (e.g., a simple euclidean/similarity transform that allows for the images showing the same image\n. content approximately). Use inverse warping in the second image to take an image close to the first\n. one, i.e. use the flag WARP_INVERSE_MAP with warpAffine or warpPerspective. See also the OpenCV\n. sample image_alignment.cpp that demonstrates the use of the function. Note that the function throws\n. an exception if algorithm does not converges.\n. \n. @sa\n. computeECC, estimateAffine2D, estimateAffinePartial2D, findHomography" ... @@ -3075,14 +2646,7 @@ def flip(src: ndarray, flipCode, dts: ndarray = ...) -> typing.Any: ... -def floodFill( - image: ndarray, - mask: typing.Optional[ndarray], - seedPoint, - newVal, - loDiff=..., - upDiff=..., - flags: int = ...) -> typing.Any: +def floodFill(image: ndarray, mask: typing.Optional[ndarray], seedPoint, newVal, loDiff=..., upDiff=..., flags: int = ...) -> typing.Any: "floodFill(image, mask, seedPoint, newVal[, loDiff[, upDiff[, flags]]]) -> retval, image, mask, rect\n. @brief Fills a connected component with the given color.\n. \n. The function cv::floodFill fills a connected component starting from the seed point with the specified\n. color. The connectivity is determined by the color/brightness closeness of the neighbor pixels. The\n. pixel at \\f$(x,y)\\f$ is considered to belong to the repainted domain if:\n. \n. - in case of a grayscale image and floating range\n. \\f[\\texttt{src} (x',y')- \\texttt{loDiff} \\leq \\texttt{src} (x,y) \\leq \\texttt{src} (x',y')+ \\texttt{upDiff}\\f]\n. \n. \n. - in case of a grayscale image and fixed range\n. \\f[\\texttt{src} ( \\texttt{seedPoint} .x, \\texttt{seedPoint} .y)- \\texttt{loDiff} \\leq \\texttt{src} (x,y) \\leq \\texttt{src} ( \\texttt{seedPoint} .x, \\texttt{seedPoint} .y)+ \\texttt{upDiff}\\f]\n. \n. \n. - in case of a color image and floating range\n. \\f[\\texttt{src} (x',y')_r- \\texttt{loDiff} _r \\leq \\texttt{src} (x,y)_r \\leq \\texttt{src} (x',y')_r+ \\texttt{upDiff} _r,\\f]\n. \\f[\\texttt{src} (x',y')_g- \\texttt{loDiff} _g \\leq \\texttt{src} (x,y)_g \\leq \\texttt{src} (x',y')_g+ \\texttt{upDiff} _g\\f]\n. and\n. \\f[\\texttt{src} (x',y')_b- \\texttt{loDiff} _b \\leq \\texttt{src} (x,y)_b \\leq \\texttt{src} (x',y')_b+ \\texttt{upDiff} _b\\f]\n. \n. \n. - in case of a color image and fixed range\n. \\f[\\texttt{src} ( \\texttt{seedPoint} .x, \\texttt{seedPoint} .y)_r- \\texttt{loDiff} _r \\leq \\texttt{src} (x,y)_r \\leq \\texttt{src} ( \\texttt{seedPoint} .x, \\texttt{seedPoint} .y)_r+ \\texttt{upDiff} _r,\\f]\n. \\f[\\texttt{src} ( \\texttt{seedPoint} .x, \\texttt{seedPoint} .y)_g- \\texttt{loDiff} _g \\leq \\texttt{src} (x,y)_g \\leq \\texttt{src} ( \\texttt{seedPoint} .x, \\texttt{seedPoint} .y)_g+ \\texttt{upDiff} _g\\f]\n. and\n. \\f[\\texttt{src} ( \\texttt{seedPoint} .x, \\texttt{seedPoint} .y)_b- \\texttt{loDiff} _b \\leq \\texttt{src} (x,y)_b \\leq \\texttt{src} ( \\texttt{seedPoint} .x, \\texttt{seedPoint} .y)_b+ \\texttt{upDiff} _b\\f]\n. \n. \n. where \\f$src(x',y')\\f$ is the value of one of pixel neighbors that is already known to belong to the\n. component. That is, to be added to the connected component, a color/brightness of the pixel should\n. be close enough to:\n. - Color/brightness of one of its neighbors that already belong to the connected component in case\n. of a floating range.\n. - Color/brightness of the seed point in case of a fixed range.\n. \n. Use these functions to either mark a connected component with the specified color in-place, or build\n. a mask and then extract the contour, or copy the region to another image, and so on.\n. \n. @param image Input/output 1- or 3-channel, 8-bit, or floating-point image. It is modified by the\n. function unless the #FLOODFILL_MASK_ONLY flag is set in the second variant of the function. See\n. the details below.\n. @param mask Operation mask that should be a single-channel 8-bit image, 2 pixels wider and 2 pixels\n. taller than image. Since this is both an input and output parameter, you must take responsibility\n. of initializing it. Flood-filling cannot go across non-zero pixels in the input mask. For example,\n. an edge detector output can be used as a mask to stop filling at edges. On output, pixels in the\n. mask corresponding to filled pixels in the image are set to 1 or to the a value specified in flags\n. as described below. Additionally, the function fills the border of the mask with ones to simplify\n. internal processing. It is therefore possible to use the same mask in multiple calls to the function\n. to make sure the filled areas do not overlap.\n. @param seedPoint Starting point.\n. @param newVal New value of the repainted domain pixels.\n. @param loDiff Maximal lower brightness/color difference between the currently observed pixel and\n. one of its neighbors belonging to the component, or a seed pixel being added to the component.\n. @param upDiff Maximal upper brightness/color difference between the currently observed pixel and\n. one of its neighbors belonging to the component, or a seed pixel being added to the component.\n. @param rect Optional output parameter set by the function to the minimum bounding rectangle of the\n. repainted domain.\n. @param flags Operation flags. The first 8 bits contain a connectivity value. The default value of\n. 4 means that only the four nearest neighbor pixels (those that share an edge) are considered. A\n. connectivity value of 8 means that the eight nearest neighbor pixels (those that share a corner)\n. will be considered. The next 8 bits (8-16) contain a value between 1 and 255 with which to fill\n. the mask (the default value is 1). For example, 4 | ( 255 \\<\\< 8 ) will consider 4 nearest\n. neighbours and fill the mask with a value of 255. The following additional options occupy higher\n. bits and therefore may be further combined with the connectivity and mask fill values using\n. bit-wise or (|), see #FloodFillFlags.\n. \n. @note Since the mask is larger than the filled image, a pixel \\f$(x, y)\\f$ in image corresponds to the\n. pixel \\f$(x+1, y+1)\\f$ in the mask .\n. \n. @sa findContours" ... @@ -3157,13 +2721,7 @@ def getOptimalDFTSize(vecsize) -> typing.Any: ... -def getOptimalNewCameraMatrix( - cameraMatrix, - distCoeffs, - imageSize, - alpha, - newImgSize=..., - centerPrincipalPoint=...) -> typing.Any: +def getOptimalNewCameraMatrix(cameraMatrix, distCoeffs, imageSize, alpha, newImgSize=..., centerPrincipalPoint=...) -> typing.Any: 'getOptimalNewCameraMatrix(cameraMatrix, distCoeffs, imageSize, alpha[, newImgSize[, centerPrincipalPoint]]) -> retval, validPixROI\n. @brief Returns the new camera matrix based on the free scaling parameter.\n. \n. @param cameraMatrix Input camera matrix.\n. @param distCoeffs Input vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$ of\n. 4, 5, 8, 12 or 14 elements. If the vector is NULL/empty, the zero distortion coefficients are\n. assumed.\n. @param imageSize Original image size.\n. @param alpha Free scaling parameter between 0 (when all the pixels in the undistorted image are\n. valid) and 1 (when all the source image pixels are retained in the undistorted image). See\n. stereoRectify for details.\n. @param newImgSize Image size after rectification. By default, it is set to imageSize .\n. @param validPixROI Optional output rectangle that outlines all-good-pixels region in the\n. undistorted image. See roi1, roi2 description in stereoRectify .\n. @param centerPrincipalPoint Optional flag that indicates whether in the new camera matrix the\n. principal point should be at the image center or not. By default, the principal point is chosen to\n. best fit a subset of the source image (determined by alpha) to the corrected image.\n. @return new_camera_matrix Output new camera matrix.\n. \n. The function computes and returns the optimal new camera matrix based on the free scaling parameter.\n. By varying this parameter, you may retrieve only sensible pixels alpha=0 , keep all the original\n. image pixels if there is valuable information in the corners alpha=1 , or get something in between.\n. When alpha\\>0 , the undistorted result is likely to have some black pixels corresponding to\n. "virtual" pixels outside of the captured distorted image. The original camera matrix, distortion\n. coefficients, the computed new camera matrix, and newImageSize should be passed to\n. initUndistortRectifyMap to produce the maps for remap .' ... @@ -3248,16 +2806,7 @@ def getWindowProperty(winname, prop_id) -> typing.Any: ... -def goodFeaturesToTrack( - image: ndarray, - maxCorners, - qualityLevel, - minDistance, - corners=..., - mask: ndarray = ..., - blockSize=..., - useHarrisDetector=..., - k=...) -> typing.Any: +def goodFeaturesToTrack(image: ndarray, maxCorners, qualityLevel, minDistance, corners=..., mask: ndarray = ..., blockSize=..., useHarrisDetector=..., k=...) -> typing.Any: 'goodFeaturesToTrack(image, maxCorners, qualityLevel, minDistance[, corners[, mask[, blockSize[, useHarrisDetector[, k]]]]]) -> corners\n. @brief Determines strong corners on an image.\n. \n. The function finds the most prominent corners in the image or in the specified image region, as\n. described in @cite Shi94\n. \n. - Function calculates the corner quality measure at every source image pixel using the\n. #cornerMinEigenVal or #cornerHarris .\n. - Function performs a non-maximum suppression (the local maximums in *3 x 3* neighborhood are\n. retained).\n. - The corners with the minimal eigenvalue less than\n. \\f$\\texttt{qualityLevel} \\cdot \\max_{x,y} qualityMeasureMap(x,y)\\f$ are rejected.\n. - The remaining corners are sorted by the quality measure in the descending order.\n. - Function throws away each corner for which there is a stronger corner at a distance less than\n. maxDistance.\n. \n. The function can be used to initialize a point-based tracker of an object.\n. \n. @note If the function is called with different values A and B of the parameter qualityLevel , and\n. A \\> B, the vector of returned corners with qualityLevel=A will be the prefix of the output vector\n. with qualityLevel=B .\n. \n. @param image Input 8-bit or floating-point 32-bit, single-channel image.\n. @param corners Output vector of detected corners.\n. @param maxCorners Maximum number of corners to return. If there are more corners than are found,\n. the strongest of them is returned. `maxCorners <= 0` implies that no limit on the maximum is set\n. and all detected corners are returned.\n. @param qualityLevel Parameter characterizing the minimal accepted quality of image corners. The\n. parameter value is multiplied by the best corner quality measure, which is the minimal eigenvalue\n. (see #cornerMinEigenVal ) or the Harris function response (see #cornerHarris ). The corners with the\n. quality measure less than the product are rejected. For example, if the best corner has the\n. quality measure = 1500, and the qualityLevel=0.01 , then all the corners with the quality measure\n. less than 15 are rejected.\n. @param minDistance Minimum possible Euclidean distance between the returned corners.\n. @param mask Optional region of interest. If the image is not empty (it needs to have the type\n. CV_8UC1 and the same size as image ), it specifies the region in which the corners are detected.\n. @param blockSize Size of an average block for computing a derivative covariation matrix over each\n. pixel neighborhood. See cornerEigenValsAndVecs .\n. @param useHarrisDetector Parameter indicating whether to use a Harris detector (see #cornerHarris)\n. or #cornerMinEigenVal.\n. @param k Free parameter of the Harris detector.\n. \n. @sa cornerMinEigenVal, cornerHarris, calcOpticalFlowPyrLK, estimateRigidTransform,\n\n\n\ngoodFeaturesToTrack(image, maxCorners, qualityLevel, minDistance, mask, blockSize, gradientSize[, corners[, useHarrisDetector[, k]]]) -> corners\n.' ... @@ -3347,15 +2896,7 @@ def initCameraMatrix2D(objectPoints, imagePoints, imageSize, aspectRatio=...) -> ... -def initUndistortRectifyMap( - cameraMatrix, - distCoeffs, - R, - newCameraMatrix, - size, - m1type, - map1=..., - map2=...) -> typing.Any: +def initUndistortRectifyMap(cameraMatrix, distCoeffs, R, newCameraMatrix, size, m1type, map1=..., map2=...) -> typing.Any: "initUndistortRectifyMap(cameraMatrix, distCoeffs, R, newCameraMatrix, size, m1type[, map1[, map2]]) -> map1, map2\n. @brief Computes the undistortion and rectification transformation map.\n. \n. The function computes the joint undistortion and rectification transformation and represents the\n. result in the form of maps for remap. The undistorted image looks like original, as if it is\n. captured with a camera using the camera matrix =newCameraMatrix and zero distortion. In case of a\n. monocular camera, newCameraMatrix is usually equal to cameraMatrix, or it can be computed by\n. #getOptimalNewCameraMatrix for a better control over scaling. In case of a stereo camera,\n. newCameraMatrix is normally set to P1 or P2 computed by #stereoRectify .\n. \n. Also, this new camera is oriented differently in the coordinate space, according to R. That, for\n. example, helps to align two heads of a stereo camera so that the epipolar lines on both images\n. become horizontal and have the same y- coordinate (in case of a horizontally aligned stereo camera).\n. \n. The function actually builds the maps for the inverse mapping algorithm that is used by remap. That\n. is, for each pixel \\f$(u, v)\\f$ in the destination (corrected and rectified) image, the function\n. computes the corresponding coordinates in the source image (that is, in the original image from\n. camera). The following process is applied:\n. \\f[\n. \\begin{array}{l}\n. x \\leftarrow (u - {c'}_x)/{f'}_x \\\\\n. y \\leftarrow (v - {c'}_y)/{f'}_y \\\\\n. {[X\\,Y\\,W]} ^T \\leftarrow R^{-1}*[x \\, y \\, 1]^T \\\\\n. x' \\leftarrow X/W \\\\\n. y' \\leftarrow Y/W \\\\\n. r^2 \\leftarrow x'^2 + y'^2 \\\\\n. x'' \\leftarrow x' \\frac{1 + k_1 r^2 + k_2 r^4 + k_3 r^6}{1 + k_4 r^2 + k_5 r^4 + k_6 r^6}\n. + 2p_1 x' y' + p_2(r^2 + 2 x'^2) + s_1 r^2 + s_2 r^4\\\\\n. y'' \\leftarrow y' \\frac{1 + k_1 r^2 + k_2 r^4 + k_3 r^6}{1 + k_4 r^2 + k_5 r^4 + k_6 r^6}\n. + p_1 (r^2 + 2 y'^2) + 2 p_2 x' y' + s_3 r^2 + s_4 r^4 \\\\\n. s\\vecthree{x'''}{y'''}{1} =\n. \\vecthreethree{R_{33}(\\tau_x, \\tau_y)}{0}{-R_{13}((\\tau_x, \\tau_y)}\n. {0}{R_{33}(\\tau_x, \\tau_y)}{-R_{23}(\\tau_x, \\tau_y)}\n. {0}{0}{1} R(\\tau_x, \\tau_y) \\vecthree{x''}{y''}{1}\\\\\n. map_x(u,v) \\leftarrow x''' f_x + c_x \\\\\n. map_y(u,v) \\leftarrow y''' f_y + c_y\n. \\end{array}\n. \\f]\n. where \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6[, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$\n. are the distortion coefficients.\n. \n. In case of a stereo camera, this function is called twice: once for each camera head, after\n. stereoRectify, which in its turn is called after #stereoCalibrate. But if the stereo camera\n. was not calibrated, it is still possible to compute the rectification transformations directly from\n. the fundamental matrix using #stereoRectifyUncalibrated. For each camera, the function computes\n. homography H as the rectification transformation in a pixel domain, not a rotation matrix R in 3D\n. space. R can be computed from H as\n. \\f[\\texttt{R} = \\texttt{cameraMatrix} ^{-1} \\cdot \\texttt{H} \\cdot \\texttt{cameraMatrix}\\f]\n. where cameraMatrix can be chosen arbitrarily.\n. \n. @param cameraMatrix Input camera matrix \\f$A=\\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\\f$ .\n. @param distCoeffs Input vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6[, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$\n. of 4, 5, 8, 12 or 14 elements. If the vector is NULL/empty, the zero distortion coefficients are assumed.\n. @param R Optional rectification transformation in the object space (3x3 matrix). R1 or R2 ,\n. computed by #stereoRectify can be passed here. If the matrix is empty, the identity transformation\n. is assumed. In cvInitUndistortMap R assumed to be an identity matrix.\n. @param newCameraMatrix New camera matrix \\f$A'=\\vecthreethree{f_x'}{0}{c_x'}{0}{f_y'}{c_y'}{0}{0}{1}\\f$.\n. @param size Undistorted image size.\n. @param m1type Type of the first output map that can be CV_32FC1, CV_32FC2 or CV_16SC2, see #convertMaps\n. @param map1 The first output map.\n. @param map2 The second output map." ... @@ -3445,12 +2986,7 @@ def matchShapes(contour1, contour2, method: int, parameter) -> typing.Any: ... -def matchTemplate( - image: ndarray, - templ: ndarray, - method: int, - result: ndarray = ..., - mask: typing.Optional[ndarray] = ...) -> ndarray: +def matchTemplate(image: ndarray, templ: ndarray, method: int, result: ndarray = ..., mask: typing.Optional[ndarray] = ...) -> ndarray: "matchTemplate(image, templ, method[, result[, mask]]) -> result\n. @brief Compares a template against overlapped image regions.\n. \n. The function slides through image , compares the overlapped patches of size \\f$w \\times h\\f$ against\n. templ using the specified method and stores the comparison results in result . #TemplateMatchModes\n. describes the formulae for the available comparison methods ( \\f$I\\f$ denotes image, \\f$T\\f$\n. template, \\f$R\\f$ result, \\f$M\\f$ the optional mask ). The summation is done over template and/or\n. the image patch: \\f$x' = 0...w-1, y' = 0...h-1\\f$\n. \n. After the function finishes the comparison, the best matches can be found as global minimums (when\n. #TM_SQDIFF was used) or maximums (when #TM_CCORR or #TM_CCOEFF was used) using the\n. #minMaxLoc function. In case of a color image, template summation in the numerator and each sum in\n. the denominator is done over all of the channels and separate mean values are used for each channel.\n. That is, the function can take a color template and a color image. The result will still be a\n. single-channel image, which is easier to analyze.\n. \n. @param image Image where the search is running. It must be 8-bit or 32-bit floating-point.\n. @param templ Searched template. It must be not greater than the source image and have the same\n. data type.\n. @param result Map of comparison results. It must be single-channel 32-bit floating-point. If image\n. is \\f$W \\times H\\f$ and templ is \\f$w \\times h\\f$ , then result is \\f$(W-w+1) \\times (H-h+1)\\f$ .\n. @param method Parameter specifying the comparison method, see #TemplateMatchModes\n. @param mask Optional mask. It must have the same size as templ. It must either have the same number\n. of channels as template or only one channel, which is then used for all template and\n. image channels. If the data type is #CV_8U, the mask is interpreted as a binary mask,\n. meaning only elements where mask is nonzero are used and are kept unchanged independent\n. of the actual mask value (weight equals 1). For data tpye #CV_32F, the mask values are\n. used as weights. The exact formulas are documented in #TemplateMatchModes." ... @@ -3535,15 +3071,7 @@ def moments(array, binaryImage=...) -> typing.Any: ... -def morphologyEx( - src: ndarray, - op, - kernel, - dts: ndarray = ..., - anchor=..., - iterations=..., - borderType=..., - borderValue=...) -> typing.Any: +def morphologyEx(src: ndarray, op, kernel, dts: ndarray = ..., anchor=..., iterations=..., borderType=..., borderValue=...) -> typing.Any: 'morphologyEx(src, op, kernel[, dst[, anchor[, iterations[, borderType[, borderValue]]]]]) -> dst\n. @brief Performs advanced morphological transformations.\n. \n. The function cv::morphologyEx can perform advanced morphological transformations using an erosion and dilation as\n. basic operations.\n. \n. Any of the operations can be done in-place. In case of multi-channel images, each channel is\n. processed independently.\n. \n. @param src Source image. The number of channels can be arbitrary. The depth should be one of\n. CV_8U, CV_16U, CV_16S, CV_32F or CV_64F.\n. @param dst Destination image of the same size and type as source image.\n. @param op Type of a morphological operation, see #MorphTypes\n. @param kernel Structuring element. It can be created using #getStructuringElement.\n. @param anchor Anchor position with the kernel. Negative values mean that the anchor is at the\n. kernel center.\n. @param iterations Number of times erosion and dilation are applied.\n. @param borderType Pixel extrapolation method, see #BorderTypes. #BORDER_WRAP is not supported.\n. @param borderValue Border value in case of a constant border. The default value has a special\n. meaning.\n. @sa dilate, erode, getStructuringElement\n. @note The number of iterations is the number of times erosion or dilatation operation will be applied.\n. For instance, an opening operation (#MORPH_OPEN) with two iterations is equivalent to apply\n. successively: erode -> erode -> dilate -> dilate (and not erode -> dilate -> erode -> dilate).' ... @@ -3578,14 +3106,7 @@ def norm(src1: ndarray, src2: ndarray, normType: int = ..., mask: ndarray = ...) ... -def normalize( - src: ndarray, - dts: ndarray, - alpha=..., - beta=..., - normType: int = ..., - dtype=..., - mask: ndarray = ...) -> ndarray: +def normalize(src: ndarray, dts: ndarray, alpha=..., beta=..., normType: int = ..., dtype=..., mask: ndarray = ...) -> ndarray: 'normalize(src, dst[, alpha[, beta[, normType[, dtype[, mask]]]]]) -> dst\n. @brief Normalizes the norm or value range of an array.\n. \n. The function cv::normalize normalizes scale and shift the input array elements so that\n. \\f[\\| \\texttt{dst} \\| _{L_p}= \\texttt{alpha}\\f]\n. (where p=Inf, 1 or 2) when normType=NORM_INF, NORM_L1, or NORM_L2, respectively; or so that\n. \\f[\\min _I \\texttt{dst} (I)= \\texttt{alpha} , \\, \\, \\max _I \\texttt{dst} (I)= \\texttt{beta}\\f]\n. \n. when normType=NORM_MINMAX (for dense arrays only). The optional mask specifies a sub-array to be\n. normalized. This means that the norm or min-n-max are calculated over the sub-array, and then this\n. sub-array is modified to be normalized. If you want to only use the mask to calculate the norm or\n. min-max but modify the whole array, you can use norm and Mat::convertTo.\n. \n. In case of sparse matrices, only the non-zero values are analyzed and transformed. Because of this,\n. the range transformation for sparse matrices is not allowed since it can shift the zero level.\n. \n. Possible usage with some positive example data:\n. @code{.cpp}\n. vector positiveData = { 2.0, 8.0, 10.0 };\n. vector normalizedData_l1, normalizedData_l2, normalizedData_inf, normalizedData_minmax;\n. \n. // Norm to probability (total count)\n. // sum(numbers) = 20.0\n. // 2.0 0.1 (2.0/20.0)\n. // 8.0 0.4 (8.0/20.0)\n. // 10.0 0.5 (10.0/20.0)\n. normalize(positiveData, normalizedData_l1, 1.0, 0.0, NORM_L1);\n. \n. // Norm to unit vector: ||positiveData|| = 1.0\n. // 2.0 0.15\n. // 8.0 0.62\n. // 10.0 0.77\n. normalize(positiveData, normalizedData_l2, 1.0, 0.0, NORM_L2);\n. \n. // Norm to max element\n. // 2.0 0.2 (2.0/10.0)\n. // 8.0 0.8 (8.0/10.0)\n. // 10.0 1.0 (10.0/10.0)\n. normalize(positiveData, normalizedData_inf, 1.0, 0.0, NORM_INF);\n. \n. // Norm to range [0.0;1.0]\n. // 2.0 0.0 (shift to left border)\n. // 8.0 0.75 (6.0/8.0)\n. // 10.0 1.0 (shift to right border)\n. normalize(positiveData, normalizedData_minmax, 1.0, 0.0, NORM_MINMAX);\n. @endcode\n. \n. @param src input array.\n. @param dst output array of the same size as src .\n. @param alpha norm value to normalize to or the lower range boundary in case of the range\n. normalization.\n. @param beta upper range boundary in case of the range normalization; it is not used for the norm\n. normalization.\n. @param normType normalization type (see cv::NormTypes).\n. @param dtype when negative, the output array has the same type as src; otherwise, it has the same\n. number of channels as src and the depth =CV_MAT_DEPTH(dtype).\n. @param mask optional operation mask.\n. @sa norm, Mat::convertTo, SparseMat::convertTo' ... @@ -3598,13 +3119,7 @@ def patchNaNs(a, val=...) -> typing.Any: ... -def pencilSketch( - src: ndarray, - dts1: ndarray = ..., - dts2: ndarray = ..., - sigma_s=..., - sigma_r=..., - shade_factor=...) -> typing.Any: +def pencilSketch(src: ndarray, dts1: ndarray = ..., dts2: ndarray = ..., sigma_s=..., sigma_r=..., shade_factor=...) -> typing.Any: 'pencilSketch(src[, dst1[, dst2[, sigma_s[, sigma_r[, shade_factor]]]]]) -> dst1, dst2\n. @brief Pencil-like non-photorealistic line drawing\n. \n. @param src Input 8-bit 3-channel image.\n. @param dst1 Output 8-bit 1-channel image.\n. @param dst2 Output image with the same size and type as src.\n. @param sigma_s %Range between 0 to 200.\n. @param sigma_r %Range between 0 to 1.\n. @param shade_factor %Range between 0 to 0.1.' ... @@ -3649,29 +3164,12 @@ def preCornerDetect(src: ndarray, ksize, dts: ndarray = ..., borderType=...) -> ... -def projectPoints( - objectPoints, - rvec, - tvec, - cameraMatrix, - distCoeffs, - imagePoints=..., - jacobian=..., - aspectRatio=...) -> typing.Any: +def projectPoints(objectPoints, rvec, tvec, cameraMatrix, distCoeffs, imagePoints=..., jacobian=..., aspectRatio=...) -> typing.Any: 'projectPoints(objectPoints, rvec, tvec, cameraMatrix, distCoeffs[, imagePoints[, jacobian[, aspectRatio]]]) -> imagePoints, jacobian\n. @brief Projects 3D points to an image plane.\n. \n. @param objectPoints Array of object points expressed wrt. the world coordinate frame. A 3xN/Nx3\n. 1-channel or 1xN/Nx1 3-channel (or vector\\ ), where N is the number of points in the view.\n. @param rvec The rotation vector (@ref Rodrigues) that, together with tvec, performs a change of\n. basis from world to camera coordinate system, see @ref calibrateCamera for details.\n. @param tvec The translation vector, see parameter description above.\n. @param cameraMatrix Camera matrix \\f$A = \\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{_1}\\f$ .\n. @param distCoeffs Input vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$ of\n. 4, 5, 8, 12 or 14 elements. If the vector is empty, the zero distortion coefficients are assumed.\n. @param imagePoints Output array of image points, 1xN/Nx1 2-channel, or\n. vector\\ .\n. @param jacobian Optional output 2Nx(10+\\) jacobian matrix of derivatives of image\n. points with respect to components of the rotation vector, translation vector, focal lengths,\n. coordinates of the principal point and the distortion coefficients. In the old interface different\n. components of the jacobian are returned via different output parameters.\n. @param aspectRatio Optional "fixed aspect ratio" parameter. If the parameter is not 0, the\n. function assumes that the aspect ratio (\\f$f_x / f_y\\f$) is fixed and correspondingly adjusts the\n. jacobian matrix.\n. \n. The function computes the 2D projections of 3D points to the image plane, given intrinsic and\n. extrinsic camera parameters. Optionally, the function computes Jacobians -matrices of partial\n. derivatives of image points coordinates (as functions of all the input parameters) with respect to\n. the particular parameters, intrinsic and/or extrinsic. The Jacobians are used during the global\n. optimization in @ref calibrateCamera, @ref solvePnP, and @ref stereoCalibrate. The function itself\n. can also be used to compute a re-projection error, given the current intrinsic and extrinsic\n. parameters.\n. \n. @note By setting rvec = tvec = \\f$[0, 0, 0]\\f$, or by setting cameraMatrix to a 3x3 identity matrix,\n. or by passing zero distortion coefficients, one can get various useful partial cases of the\n. function. This means, one can compute the distorted coordinates for a sparse set of points or apply\n. a perspective transformation (and also compute the derivatives) in the ideal zero-distortion setup.' ... -def putText( - img: ndarray, - text, - org, - fontFace, - fontScale, - color, - thickness=..., - lineType=..., - bottomLeftOrigin=...) -> typing.Any: +def putText(img: ndarray, text, org, fontFace, fontScale, color, thickness=..., lineType=..., bottomLeftOrigin=...) -> typing.Any: 'putText(img, text, org, fontFace, fontScale, color[, thickness[, lineType[, bottomLeftOrigin]]]) -> img\n. @brief Draws a text string.\n. \n. The function cv::putText renders the specified text string in the image. Symbols that cannot be rendered\n. using the specified font are replaced by question marks. See #getTextSize for a text rendering code\n. example.\n. \n. @param img Image.\n. @param text Text string to be drawn.\n. @param org Bottom-left corner of the text string in the image.\n. @param fontFace Font type, see #HersheyFonts.\n. @param fontScale Font scale factor that is multiplied by the font-specific base size.\n. @param color Text color.\n. @param thickness Thickness of the lines used to draw a text.\n. @param lineType Line type. See #LineTypes\n. @param bottomLeftOrigin When true, the image data origin is at the bottom-left corner. Otherwise,\n. it is at the top-left corner.' ... @@ -3721,30 +3219,7 @@ def rectangle(img: ndarray, pt1, pt2, color, thickness=..., lineType=..., shift= ... -def rectify3Collinear( - cameraMatrix1, - distCoeffs1, - cameraMatrix2, - distCoeffs2, - cameraMatrix3, - distCoeffs3, - imgpt1, - imgpt3, - imageSize, - R12, - T12, - R13, - T13, - alpha, - newImgSize, - flags: int, - R1=..., - R2=..., - R3=..., - P1=..., - P2=..., - P3=..., - Q=...) -> typing.Any: +def rectify3Collinear(cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, cameraMatrix3, distCoeffs3, imgpt1, imgpt3, imageSize, R12, T12, R13, T13, alpha, newImgSize, flags: int, R1=..., R2=..., R3=..., P1=..., P2=..., P3=..., Q=...) -> typing.Any: 'rectify3Collinear(cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, cameraMatrix3, distCoeffs3, imgpt1, imgpt3, imageSize, R12, T12, R13, T13, alpha, newImgSize, flags[, R1[, R2[, R3[, P1[, P2[, P3[, Q]]]]]]]) -> retval, R1, R2, R3, P1, P2, P3, Q, roi1, roi2\n.' ... @@ -3759,14 +3234,7 @@ def reduce(src: ndarray, dim, rtype, dts: ndarray = ..., dtype=...) -> typing.An ... -def remap( - src: ndarray, - map1, - map2, - interpolation: int, - dts: ndarray = ..., - borderMode=..., - borderValue=...) -> typing.Any: +def remap(src: ndarray, map1, map2, interpolation: int, dts: ndarray = ..., borderMode=..., borderValue=...) -> typing.Any: 'remap(src, map1, map2, interpolation[, dst[, borderMode[, borderValue]]]) -> dst\n. @brief Applies a generic geometrical transformation to an image.\n. \n. The function remap transforms the source image using the specified map:\n. \n. \\f[\\texttt{dst} (x,y) = \\texttt{src} (map_x(x,y),map_y(x,y))\\f]\n. \n. where values of pixels with non-integer coordinates are computed using one of available\n. interpolation methods. \\f$map_x\\f$ and \\f$map_y\\f$ can be encoded as separate floating-point maps\n. in \\f$map_1\\f$ and \\f$map_2\\f$ respectively, or interleaved floating-point maps of \\f$(x,y)\\f$ in\n. \\f$map_1\\f$, or fixed-point maps created by using convertMaps. The reason you might want to\n. convert from floating to fixed-point representations of a map is that they can yield much faster\n. (\\~2x) remapping operations. In the converted case, \\f$map_1\\f$ contains pairs (cvFloor(x),\n. cvFloor(y)) and \\f$map_2\\f$ contains indices in a table of interpolation coefficients.\n. \n. This function cannot operate in-place.\n. \n. @param src Source image.\n. @param dst Destination image. It has the same size as map1 and the same type as src .\n. @param map1 The first map of either (x,y) points or just x values having the type CV_16SC2 ,\n. CV_32FC1, or CV_32FC2. See convertMaps for details on converting a floating point\n. representation to fixed-point for speed.\n. @param map2 The second map of y values having the type CV_16UC1, CV_32FC1, or none (empty map\n. if map1 is (x,y) points), respectively.\n. @param interpolation Interpolation method (see #InterpolationFlags). The method #INTER_AREA is\n. not supported by this function.\n. @param borderMode Pixel extrapolation method (see #BorderTypes). When\n. borderMode=#BORDER_TRANSPARENT, it means that the pixels in the destination image that\n. corresponds to the "outliers" in the source image are not modified by the function.\n. @param borderValue Value used in case of a constant border. By default, it is 0.\n. @note\n. Due to current implementation limitations the size of an input and output images should be less than 32767x32767.' ... @@ -3781,8 +3249,7 @@ def reprojectImageTo3D(disparity, Q, _3dImage=..., handleMissingValues=..., ddep ... -def resize(src: ndarray, dsize: tuple[int, int], dts: ndarray = ..., - fx: int = ..., fy: int = ..., interpolation: int = ...) -> ndarray: +def resize(src: ndarray, dsize: tuple[int, int], dts: ndarray = ..., fx: int = ..., fy: int = ..., interpolation: int = ...) -> ndarray: 'resize(src, dsize[, dst[, fx[, fy[, interpolation]]]]) -> dst\n. @brief Resizes an image.\n. \n. The function resize resizes the image src down to or up to the specified size. Note that the\n. initial dst type or size are not taken into account. Instead, the size and type are derived from\n. the `src`,`dsize`,`fx`, and `fy`. If you want to resize src so that it fits the pre-created dst,\n. you may call the function as follows:\n. @code\n. // explicitly specify dsize=dst.size(); fx and fy will be computed from that.\n. resize(src, dst, dst.size(), 0, 0, interpolation);\n. @endcode\n. If you want to decimate the image by factor of 2 in each direction, you can call the function this\n. way:\n. @code\n. // specify fx and fy and let the function compute the destination image size.\n. resize(src, dst, Size(), 0.5, 0.5, interpolation);\n. @endcode\n. To shrink an image, it will generally look best with #INTER_AREA interpolation, whereas to\n. enlarge an image, it will generally look best with c#INTER_CUBIC (slow) or #INTER_LINEAR\n. (faster but still looks OK).\n. \n. @param src input image.\n. @param dst output image; it has the size dsize (when it is non-zero) or the size computed from\n. src.size(), fx, and fy; the type of dst is the same as of src.\n. @param dsize output image size; if it equals zero, it is computed as:\n. \\f[\\texttt{dsize = Size(round(fx*src.cols), round(fy*src.rows))}\\f]\n. Either dsize or both fx and fy must be non-zero.\n. @param fx scale factor along the horizontal axis; when it equals 0, it is computed as\n. \\f[\\texttt{(double)dsize.width/src.cols}\\f]\n. @param fy scale factor along the vertical axis; when it equals 0, it is computed as\n. \\f[\\texttt{(double)dsize.height/src.rows}\\f]\n. @param interpolation interpolation method, see #InterpolationFlags\n. \n. @sa warpAffine, warpPerspective, remap' ... @@ -3827,15 +3294,7 @@ def selectROIs(windowName, img: ndarray, showCrosshair=..., fromCenter=...) -> t ... -def sepFilter2D( - src: ndarray, - ddepth, - kernelX, - kernelY, - dts: ndarray = ..., - anchor=..., - delta=..., - borderType=...) -> typing.Any: +def sepFilter2D(src: ndarray, ddepth, kernelX, kernelY, dts: ndarray = ..., anchor=..., delta=..., borderType=...) -> typing.Any: 'sepFilter2D(src, ddepth, kernelX, kernelY[, dst[, anchor[, delta[, borderType]]]]) -> dst\n. @brief Applies a separable linear filter to an image.\n. \n. The function applies a separable linear filter to the image. That is, first, every row of src is\n. filtered with the 1D kernel kernelX. Then, every column of the result is filtered with the 1D\n. kernel kernelY. The final result shifted by delta is stored in dst .\n. \n. @param src Source image.\n. @param dst Destination image of the same size and the same number of channels as src .\n. @param ddepth Destination image depth, see @ref filter_depths "combinations"\n. @param kernelX Coefficients for filtering each row.\n. @param kernelY Coefficients for filtering each column.\n. @param anchor Anchor position within the kernel. The default value \\f$(-1,-1)\\f$ means that the anchor\n. is at the kernel center.\n. @param delta Value added to the filtered results before storing them.\n. @param borderType Pixel extrapolation method, see #BorderTypes. #BORDER_WRAP is not supported.\n. @sa filter2D, Sobel, GaussianBlur, boxFilter, blur' ... @@ -3915,48 +3374,17 @@ def solveP3P(objectPoints, imagePoints, cameraMatrix, distCoeffs, flags: int, rv ... -def solvePnP( - objectPoints, - imagePoints, - cameraMatrix, - distCoeffs, - rvec=..., - tvec=..., - useExtrinsicGuess=..., - flags: int = ...) -> typing.Any: +def solvePnP(objectPoints, imagePoints, cameraMatrix, distCoeffs, rvec=..., tvec=..., useExtrinsicGuess=..., flags: int = ...) -> typing.Any: 'solvePnP(objectPoints, imagePoints, cameraMatrix, distCoeffs[, rvec[, tvec[, useExtrinsicGuess[, flags]]]]) -> retval, rvec, tvec\n. @brief Finds an object pose from 3D-2D point correspondences.\n. This function returns the rotation and the translation vectors that transform a 3D point expressed in the object\n. coordinate frame to the camera coordinate frame, using different methods:\n. - P3P methods (@ref SOLVEPNP_P3P, @ref SOLVEPNP_AP3P): need 4 input points to return a unique solution.\n. - @ref SOLVEPNP_IPPE Input points must be >= 4 and object points must be coplanar.\n. - @ref SOLVEPNP_IPPE_SQUARE Special case suitable for marker pose estimation.\n. Number of input points must be 4. Object points must be defined in the following order:\n. - point 0: [-squareLength / 2, squareLength / 2, 0]\n. - point 1: [ squareLength / 2, squareLength / 2, 0]\n. - point 2: [ squareLength / 2, -squareLength / 2, 0]\n. - point 3: [-squareLength / 2, -squareLength / 2, 0]\n. - for all the other flags, number of input points must be >= 4 and object points can be in any configuration.\n. \n. @param objectPoints Array of object points in the object coordinate space, Nx3 1-channel or\n. 1xN/Nx1 3-channel, where N is the number of points. vector\\ can be also passed here.\n. @param imagePoints Array of corresponding image points, Nx2 1-channel or 1xN/Nx1 2-channel,\n. where N is the number of points. vector\\ can be also passed here.\n. @param cameraMatrix Input camera matrix \\f$A = \\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\\f$ .\n. @param distCoeffs Input vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$ of\n. 4, 5, 8, 12 or 14 elements. If the vector is NULL/empty, the zero distortion coefficients are\n. assumed.\n. @param rvec Output rotation vector (see @ref Rodrigues ) that, together with tvec, brings points from\n. the model coordinate system to the camera coordinate system.\n. @param tvec Output translation vector.\n. @param useExtrinsicGuess Parameter used for #SOLVEPNP_ITERATIVE. If true (1), the function uses\n. the provided rvec and tvec values as initial approximations of the rotation and translation\n. vectors, respectively, and further optimizes them.\n. @param flags Method for solving a PnP problem:\n. - **SOLVEPNP_ITERATIVE** Iterative method is based on a Levenberg-Marquardt optimization. In\n. this case the function finds such a pose that minimizes reprojection error, that is the sum\n. of squared distances between the observed projections imagePoints and the projected (using\n. projectPoints ) objectPoints .\n. - **SOLVEPNP_P3P** Method is based on the paper of X.S. Gao, X.-R. Hou, J. Tang, H.-F. Chang\n. "Complete Solution Classification for the Perspective-Three-Point Problem" (@cite gao2003complete).\n. In this case the function requires exactly four object and image points.\n. - **SOLVEPNP_AP3P** Method is based on the paper of T. Ke, S. Roumeliotis\n. "An Efficient Algebraic Solution to the Perspective-Three-Point Problem" (@cite Ke17).\n. In this case the function requires exactly four object and image points.\n. - **SOLVEPNP_EPNP** Method has been introduced by F. Moreno-Noguer, V. Lepetit and P. Fua in the\n. paper "EPnP: Efficient Perspective-n-Point Camera Pose Estimation" (@cite lepetit2009epnp).\n. - **SOLVEPNP_DLS** Method is based on the paper of J. Hesch and S. Roumeliotis.\n. "A Direct Least-Squares (DLS) Method for PnP" (@cite hesch2011direct).\n. - **SOLVEPNP_UPNP** Method is based on the paper of A. Penate-Sanchez, J. Andrade-Cetto,\n. F. Moreno-Noguer. "Exhaustive Linearization for Robust Camera Pose and Focal Length\n. Estimation" (@cite penate2013exhaustive). In this case the function also estimates the parameters \\f$f_x\\f$ and \\f$f_y\\f$\n. assuming that both have the same value. Then the cameraMatrix is updated with the estimated\n. focal length.\n. - **SOLVEPNP_IPPE** Method is based on the paper of T. Collins and A. Bartoli.\n. "Infinitesimal Plane-Based Pose Estimation" (@cite Collins14). This method requires coplanar object points.\n. - **SOLVEPNP_IPPE_SQUARE** Method is based on the paper of Toby Collins and Adrien Bartoli.\n. "Infinitesimal Plane-Based Pose Estimation" (@cite Collins14). This method is suitable for marker pose estimation.\n. It requires 4 coplanar object points defined in the following order:\n. - point 0: [-squareLength / 2, squareLength / 2, 0]\n. - point 1: [ squareLength / 2, squareLength / 2, 0]\n. - point 2: [ squareLength / 2, -squareLength / 2, 0]\n. - point 3: [-squareLength / 2, -squareLength / 2, 0]\n. \n. The function estimates the object pose given a set of object points, their corresponding image\n. projections, as well as the camera matrix and the distortion coefficients, see the figure below\n. (more precisely, the X-axis of the camera frame is pointing to the right, the Y-axis downward\n. and the Z-axis forward).\n. \n. ![](pnp.jpg)\n. \n. Points expressed in the world frame \\f$ \\bf{X}_w \\f$ are projected into the image plane \\f$ \\left[ u, v \\right] \\f$\n. using the perspective projection model \\f$ \\Pi \\f$ and the camera intrinsic parameters matrix \\f$ \\bf{A} \\f$:\n. \n. \\f[\n. \\begin{align*}\n. \\begin{bmatrix}\n. u \\\\\n. v \\\\\n. 1\n. \\end{bmatrix} &=\n. \\bf{A} \\hspace{0.1em} \\Pi \\hspace{0.2em} ^{c}\\bf{T}_w\n. \\begin{bmatrix}\n. X_{w} \\\\\n. Y_{w} \\\\\n. Z_{w} \\\\\n. 1\n. \\end{bmatrix} \\\\\n. \\begin{bmatrix}\n. u \\\\\n. v \\\\\n. 1\n. \\end{bmatrix} &=\n. \\begin{bmatrix}\n. f_x & 0 & c_x \\\\\n. 0 & f_y & c_y \\\\\n. 0 & 0 & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. 1 & 0 & 0 & 0 \\\\\n. 0 & 1 & 0 & 0 \\\\\n. 0 & 0 & 1 & 0\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. r_{11} & r_{12} & r_{13} & t_x \\\\\n. r_{21} & r_{22} & r_{23} & t_y \\\\\n. r_{31} & r_{32} & r_{33} & t_z \\\\\n. 0 & 0 & 0 & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X_{w} \\\\\n. Y_{w} \\\\\n. Z_{w} \\\\\n. 1\n. \\end{bmatrix}\n. \\end{align*}\n. \\f]\n. \n. The estimated pose is thus the rotation (`rvec`) and the translation (`tvec`) vectors that allow transforming\n. a 3D point expressed in the world frame into the camera frame:\n. \n. \\f[\n. \\begin{align*}\n. \\begin{bmatrix}\n. X_c \\\\\n. Y_c \\\\\n. Z_c \\\\\n. 1\n. \\end{bmatrix} &=\n. \\hspace{0.2em} ^{c}\\bf{T}_w\n. \\begin{bmatrix}\n. X_{w} \\\\\n. Y_{w} \\\\\n. Z_{w} \\\\\n. 1\n. \\end{bmatrix} \\\\\n. \\begin{bmatrix}\n. X_c \\\\\n. Y_c \\\\\n. Z_c \\\\\n. 1\n. \\end{bmatrix} &=\n. \\begin{bmatrix}\n. r_{11} & r_{12} & r_{13} & t_x \\\\\n. r_{21} & r_{22} & r_{23} & t_y \\\\\n. r_{31} & r_{32} & r_{33} & t_z \\\\\n. 0 & 0 & 0 & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X_{w} \\\\\n. Y_{w} \\\\\n. Z_{w} \\\\\n. 1\n. \\end{bmatrix}\n. \\end{align*}\n. \\f]\n. \n. @note\n. - An example of how to use solvePnP for planar augmented reality can be found at\n. opencv_source_code/samples/python/plane_ar.py\n. - If you are using Python:\n. - Numpy array slices won\'t work as input because solvePnP requires contiguous\n. arrays (enforced by the assertion using cv::Mat::checkVector() around line 55 of\n. modules/calib3d/src/solvepnp.cpp version 2.4.9)\n. - The P3P algorithm requires image points to be in an array of shape (N,1,2) due\n. to its calling of cv::undistortPoints (around line 75 of modules/calib3d/src/solvepnp.cpp version 2.4.9)\n. which requires 2-channel information.\n. - Thus, given some data D = np.array(...) where D.shape = (N,M), in order to use a subset of\n. it as, e.g., imagePoints, one must effectively copy it into a new array: imagePoints =\n. np.ascontiguousarray(D[:,:2]).reshape((N,1,2))\n. - The methods **SOLVEPNP_DLS** and **SOLVEPNP_UPNP** cannot be used as the current implementations are\n. unstable and sometimes give completely wrong results. If you pass one of these two\n. flags, **SOLVEPNP_EPNP** method will be used instead.\n. - The minimum number of points is 4 in the general case. In the case of **SOLVEPNP_P3P** and **SOLVEPNP_AP3P**\n. methods, it is required to use exactly 4 points (the first 3 points are used to estimate all the solutions\n. of the P3P problem, the last one is used to retain the best solution that minimizes the reprojection error).\n. - With **SOLVEPNP_ITERATIVE** method and `useExtrinsicGuess=true`, the minimum number of points is 3 (3 points\n. are sufficient to compute a pose but there are up to 4 solutions). The initial solution should be close to the\n. global solution to converge.\n. - With **SOLVEPNP_IPPE** input points must be >= 4 and object points must be coplanar.\n. - With **SOLVEPNP_IPPE_SQUARE** this is a special case suitable for marker pose estimation.\n. Number of input points must be 4. Object points must be defined in the following order:\n. - point 0: [-squareLength / 2, squareLength / 2, 0]\n. - point 1: [ squareLength / 2, squareLength / 2, 0]\n. - point 2: [ squareLength / 2, -squareLength / 2, 0]\n. - point 3: [-squareLength / 2, -squareLength / 2, 0]' ... -def solvePnPGeneric( - objectPoints, - imagePoints, - cameraMatrix, - distCoeffs, - rvecs=..., - tvecs=..., - useExtrinsicGuess=..., - flags: int = ..., - rvec=..., - tvec=..., - reprojectionError=...) -> typing.Any: +def solvePnPGeneric(objectPoints, imagePoints, cameraMatrix, distCoeffs, rvecs=..., tvecs=..., useExtrinsicGuess=..., flags: int = ..., rvec=..., tvec=..., reprojectionError=...) -> typing.Any: 'solvePnPGeneric(objectPoints, imagePoints, cameraMatrix, distCoeffs[, rvecs[, tvecs[, useExtrinsicGuess[, flags[, rvec[, tvec[, reprojectionError]]]]]]]) -> retval, rvecs, tvecs, reprojectionError\n. @brief Finds an object pose from 3D-2D point correspondences.\n. This function returns a list of all the possible solutions (a solution is a \n. couple), depending on the number of input points and the chosen method:\n. - P3P methods (@ref SOLVEPNP_P3P, @ref SOLVEPNP_AP3P): 3 or 4 input points. Number of returned solutions can be between 0 and 4 with 3 input points.\n. - @ref SOLVEPNP_IPPE Input points must be >= 4 and object points must be coplanar. Returns 2 solutions.\n. - @ref SOLVEPNP_IPPE_SQUARE Special case suitable for marker pose estimation.\n. Number of input points must be 4 and 2 solutions are returned. Object points must be defined in the following order:\n. - point 0: [-squareLength / 2, squareLength / 2, 0]\n. - point 1: [ squareLength / 2, squareLength / 2, 0]\n. - point 2: [ squareLength / 2, -squareLength / 2, 0]\n. - point 3: [-squareLength / 2, -squareLength / 2, 0]\n. - for all the other flags, number of input points must be >= 4 and object points can be in any configuration.\n. Only 1 solution is returned.\n. \n. @param objectPoints Array of object points in the object coordinate space, Nx3 1-channel or\n. 1xN/Nx1 3-channel, where N is the number of points. vector\\ can be also passed here.\n. @param imagePoints Array of corresponding image points, Nx2 1-channel or 1xN/Nx1 2-channel,\n. where N is the number of points. vector\\ can be also passed here.\n. @param cameraMatrix Input camera matrix \\f$A = \\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\\f$ .\n. @param distCoeffs Input vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$ of\n. 4, 5, 8, 12 or 14 elements. If the vector is NULL/empty, the zero distortion coefficients are\n. assumed.\n. @param rvecs Vector of output rotation vectors (see @ref Rodrigues ) that, together with tvecs, brings points from\n. the model coordinate system to the camera coordinate system.\n. @param tvecs Vector of output translation vectors.\n. @param useExtrinsicGuess Parameter used for #SOLVEPNP_ITERATIVE. If true (1), the function uses\n. the provided rvec and tvec values as initial approximations of the rotation and translation\n. vectors, respectively, and further optimizes them.\n. @param flags Method for solving a PnP problem:\n. - **SOLVEPNP_ITERATIVE** Iterative method is based on a Levenberg-Marquardt optimization. In\n. this case the function finds such a pose that minimizes reprojection error, that is the sum\n. of squared distances between the observed projections imagePoints and the projected (using\n. projectPoints ) objectPoints .\n. - **SOLVEPNP_P3P** Method is based on the paper of X.S. Gao, X.-R. Hou, J. Tang, H.-F. Chang\n. "Complete Solution Classification for the Perspective-Three-Point Problem" (@cite gao2003complete).\n. In this case the function requires exactly four object and image points.\n. - **SOLVEPNP_AP3P** Method is based on the paper of T. Ke, S. Roumeliotis\n. "An Efficient Algebraic Solution to the Perspective-Three-Point Problem" (@cite Ke17).\n. In this case the function requires exactly four object and image points.\n. - **SOLVEPNP_EPNP** Method has been introduced by F.Moreno-Noguer, V.Lepetit and P.Fua in the\n. paper "EPnP: Efficient Perspective-n-Point Camera Pose Estimation" (@cite lepetit2009epnp).\n. - **SOLVEPNP_DLS** Method is based on the paper of Joel A. Hesch and Stergios I. Roumeliotis.\n. "A Direct Least-Squares (DLS) Method for PnP" (@cite hesch2011direct).\n. - **SOLVEPNP_UPNP** Method is based on the paper of A.Penate-Sanchez, J.Andrade-Cetto,\n. F.Moreno-Noguer. "Exhaustive Linearization for Robust Camera Pose and Focal Length\n. Estimation" (@cite penate2013exhaustive). In this case the function also estimates the parameters \\f$f_x\\f$ and \\f$f_y\\f$\n. assuming that both have the same value. Then the cameraMatrix is updated with the estimated\n. focal length.\n. - **SOLVEPNP_IPPE** Method is based on the paper of T. Collins and A. Bartoli.\n. "Infinitesimal Plane-Based Pose Estimation" (@cite Collins14). This method requires coplanar object points.\n. - **SOLVEPNP_IPPE_SQUARE** Method is based on the paper of Toby Collins and Adrien Bartoli.\n. "Infinitesimal Plane-Based Pose Estimation" (@cite Collins14). This method is suitable for marker pose estimation.\n. It requires 4 coplanar object points defined in the following order:\n. - point 0: [-squareLength / 2, squareLength / 2, 0]\n. - point 1: [ squareLength / 2, squareLength / 2, 0]\n. - point 2: [ squareLength / 2, -squareLength / 2, 0]\n. - point 3: [-squareLength / 2, -squareLength / 2, 0]\n. @param rvec Rotation vector used to initialize an iterative PnP refinement algorithm, when flag is SOLVEPNP_ITERATIVE\n. and useExtrinsicGuess is set to true.\n. @param tvec Translation vector used to initialize an iterative PnP refinement algorithm, when flag is SOLVEPNP_ITERATIVE\n. and useExtrinsicGuess is set to true.\n. @param reprojectionError Optional vector of reprojection error, that is the RMS error\n. (\\f$ \\text{RMSE} = \\sqrt{\\frac{\\sum_{i}^{N} \\left ( \\hat{y_i} - y_i \\right )^2}{N}} \\f$) between the input image points\n. and the 3D object points projected with the estimated pose.\n. \n. The function estimates the object pose given a set of object points, their corresponding image\n. projections, as well as the camera matrix and the distortion coefficients, see the figure below\n. (more precisely, the X-axis of the camera frame is pointing to the right, the Y-axis downward\n. and the Z-axis forward).\n. \n. ![](pnp.jpg)\n. \n. Points expressed in the world frame \\f$ \\bf{X}_w \\f$ are projected into the image plane \\f$ \\left[ u, v \\right] \\f$\n. using the perspective projection model \\f$ \\Pi \\f$ and the camera intrinsic parameters matrix \\f$ \\bf{A} \\f$:\n. \n. \\f[\n. \\begin{align*}\n. \\begin{bmatrix}\n. u \\\\\n. v \\\\\n. 1\n. \\end{bmatrix} &=\n. \\bf{A} \\hspace{0.1em} \\Pi \\hspace{0.2em} ^{c}\\bf{T}_w\n. \\begin{bmatrix}\n. X_{w} \\\\\n. Y_{w} \\\\\n. Z_{w} \\\\\n. 1\n. \\end{bmatrix} \\\\\n. \\begin{bmatrix}\n. u \\\\\n. v \\\\\n. 1\n. \\end{bmatrix} &=\n. \\begin{bmatrix}\n. f_x & 0 & c_x \\\\\n. 0 & f_y & c_y \\\\\n. 0 & 0 & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. 1 & 0 & 0 & 0 \\\\\n. 0 & 1 & 0 & 0 \\\\\n. 0 & 0 & 1 & 0\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. r_{11} & r_{12} & r_{13} & t_x \\\\\n. r_{21} & r_{22} & r_{23} & t_y \\\\\n. r_{31} & r_{32} & r_{33} & t_z \\\\\n. 0 & 0 & 0 & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X_{w} \\\\\n. Y_{w} \\\\\n. Z_{w} \\\\\n. 1\n. \\end{bmatrix}\n. \\end{align*}\n. \\f]\n. \n. The estimated pose is thus the rotation (`rvec`) and the translation (`tvec`) vectors that allow transforming\n. a 3D point expressed in the world frame into the camera frame:\n. \n. \\f[\n. \\begin{align*}\n. \\begin{bmatrix}\n. X_c \\\\\n. Y_c \\\\\n. Z_c \\\\\n. 1\n. \\end{bmatrix} &=\n. \\hspace{0.2em} ^{c}\\bf{T}_w\n. \\begin{bmatrix}\n. X_{w} \\\\\n. Y_{w} \\\\\n. Z_{w} \\\\\n. 1\n. \\end{bmatrix} \\\\\n. \\begin{bmatrix}\n. X_c \\\\\n. Y_c \\\\\n. Z_c \\\\\n. 1\n. \\end{bmatrix} &=\n. \\begin{bmatrix}\n. r_{11} & r_{12} & r_{13} & t_x \\\\\n. r_{21} & r_{22} & r_{23} & t_y \\\\\n. r_{31} & r_{32} & r_{33} & t_z \\\\\n. 0 & 0 & 0 & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X_{w} \\\\\n. Y_{w} \\\\\n. Z_{w} \\\\\n. 1\n. \\end{bmatrix}\n. \\end{align*}\n. \\f]\n. \n. @note\n. - An example of how to use solvePnP for planar augmented reality can be found at\n. opencv_source_code/samples/python/plane_ar.py\n. - If you are using Python:\n. - Numpy array slices won\'t work as input because solvePnP requires contiguous\n. arrays (enforced by the assertion using cv::Mat::checkVector() around line 55 of\n. modules/calib3d/src/solvepnp.cpp version 2.4.9)\n. - The P3P algorithm requires image points to be in an array of shape (N,1,2) due\n. to its calling of cv::undistortPoints (around line 75 of modules/calib3d/src/solvepnp.cpp version 2.4.9)\n. which requires 2-channel information.\n. - Thus, given some data D = np.array(...) where D.shape = (N,M), in order to use a subset of\n. it as, e.g., imagePoints, one must effectively copy it into a new array: imagePoints =\n. np.ascontiguousarray(D[:,:2]).reshape((N,1,2))\n. - The methods **SOLVEPNP_DLS** and **SOLVEPNP_UPNP** cannot be used as the current implementations are\n. unstable and sometimes give completely wrong results. If you pass one of these two\n. flags, **SOLVEPNP_EPNP** method will be used instead.\n. - The minimum number of points is 4 in the general case. In the case of **SOLVEPNP_P3P** and **SOLVEPNP_AP3P**\n. methods, it is required to use exactly 4 points (the first 3 points are used to estimate all the solutions\n. of the P3P problem, the last one is used to retain the best solution that minimizes the reprojection error).\n. - With **SOLVEPNP_ITERATIVE** method and `useExtrinsicGuess=true`, the minimum number of points is 3 (3 points\n. are sufficient to compute a pose but there are up to 4 solutions). The initial solution should be close to the\n. global solution to converge.\n. - With **SOLVEPNP_IPPE** input points must be >= 4 and object points must be coplanar.\n. - With **SOLVEPNP_IPPE_SQUARE** this is a special case suitable for marker pose estimation.\n. Number of input points must be 4. Object points must be defined in the following order:\n. - point 0: [-squareLength / 2, squareLength / 2, 0]\n. - point 1: [ squareLength / 2, squareLength / 2, 0]\n. - point 2: [ squareLength / 2, -squareLength / 2, 0]\n. - point 3: [-squareLength / 2, -squareLength / 2, 0]' ... -def solvePnPRansac( - objectPoints, - imagePoints, - cameraMatrix, - distCoeffs, - rvec=..., - tvec=..., - useExtrinsicGuess=..., - iterationsCount=..., - reprojectionError=..., - confidence=..., - inliers=..., - flags: int = ...) -> typing.Any: +def solvePnPRansac(objectPoints, imagePoints, cameraMatrix, distCoeffs, rvec=..., tvec=..., useExtrinsicGuess=..., iterationsCount=..., reprojectionError=..., confidence=..., inliers=..., flags: int = ...) -> typing.Any: 'solvePnPRansac(objectPoints, imagePoints, cameraMatrix, distCoeffs[, rvec[, tvec[, useExtrinsicGuess[, iterationsCount[, reprojectionError[, confidence[, inliers[, flags]]]]]]]]) -> retval, rvec, tvec, inliers\n. @brief Finds an object pose from 3D-2D point correspondences using the RANSAC scheme.\n. \n. @param objectPoints Array of object points in the object coordinate space, Nx3 1-channel or\n. 1xN/Nx1 3-channel, where N is the number of points. vector\\ can be also passed here.\n. @param imagePoints Array of corresponding image points, Nx2 1-channel or 1xN/Nx1 2-channel,\n. where N is the number of points. vector\\ can be also passed here.\n. @param cameraMatrix Input camera matrix \\f$A = \\vecthreethree{fx}{0}{cx}{0}{fy}{cy}{0}{0}{1}\\f$ .\n. @param distCoeffs Input vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$ of\n. 4, 5, 8, 12 or 14 elements. If the vector is NULL/empty, the zero distortion coefficients are\n. assumed.\n. @param rvec Output rotation vector (see @ref Rodrigues ) that, together with tvec, brings points from\n. the model coordinate system to the camera coordinate system.\n. @param tvec Output translation vector.\n. @param useExtrinsicGuess Parameter used for @ref SOLVEPNP_ITERATIVE. If true (1), the function uses\n. the provided rvec and tvec values as initial approximations of the rotation and translation\n. vectors, respectively, and further optimizes them.\n. @param iterationsCount Number of iterations.\n. @param reprojectionError Inlier threshold value used by the RANSAC procedure. The parameter value\n. is the maximum allowed distance between the observed and computed point projections to consider it\n. an inlier.\n. @param confidence The probability that the algorithm produces a useful result.\n. @param inliers Output vector that contains indices of inliers in objectPoints and imagePoints .\n. @param flags Method for solving a PnP problem (see @ref solvePnP ).\n. \n. The function estimates an object pose given a set of object points, their corresponding image\n. projections, as well as the camera matrix and the distortion coefficients. This function finds such\n. a pose that minimizes reprojection error, that is, the sum of squared distances between the observed\n. projections imagePoints and the projected (using @ref projectPoints ) objectPoints. The use of RANSAC\n. makes the function resistant to outliers.\n. \n. @note\n. - An example of how to use solvePNPRansac for object detection can be found at\n. opencv_source_code/samples/cpp/tutorial_code/calib3d/real_time_pose_estimation/\n. - The default method used to estimate the camera pose for the Minimal Sample Sets step\n. is #SOLVEPNP_EPNP. Exceptions are:\n. - if you choose #SOLVEPNP_P3P or #SOLVEPNP_AP3P, these methods will be used.\n. - if the number of input points is equal to 4, #SOLVEPNP_P3P is used.\n. - The method used to estimate the camera pose using all the inliers is defined by the\n. flags parameters unless it is equal to #SOLVEPNP_P3P or #SOLVEPNP_AP3P. In this case,\n. the method #SOLVEPNP_EPNP will be used instead.' ... @@ -3966,15 +3394,7 @@ def solvePnPRefineLM(objectPoints, imagePoints, cameraMatrix, distCoeffs, rvec, ... -def solvePnPRefineVVS( - objectPoints, - imagePoints, - cameraMatrix, - distCoeffs, - rvec, - tvec, - criteria=..., - VVSlambda=...) -> typing.Any: +def solvePnPRefineVVS(objectPoints, imagePoints, cameraMatrix, distCoeffs, rvec, tvec, criteria=..., VVSlambda=...) -> typing.Any: 'solvePnPRefineVVS(objectPoints, imagePoints, cameraMatrix, distCoeffs, rvec, tvec[, criteria[, VVSlambda]]) -> rvec, tvec\n. @brief Refine a pose (the translation and the rotation that transform a 3D point expressed in the object coordinate frame\n. to the camera coordinate frame) from a 3D-2D point correspondences and starting from an initial solution.\n. \n. @param objectPoints Array of object points in the object coordinate space, Nx3 1-channel or 1xN/Nx1 3-channel,\n. where N is the number of points. vector\\ can also be passed here.\n. @param imagePoints Array of corresponding image points, Nx2 1-channel or 1xN/Nx1 2-channel,\n. where N is the number of points. vector\\ can also be passed here.\n. @param cameraMatrix Input camera matrix \\f$A = \\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\\f$ .\n. @param distCoeffs Input vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$ of\n. 4, 5, 8, 12 or 14 elements. If the vector is NULL/empty, the zero distortion coefficients are\n. assumed.\n. @param rvec Input/Output rotation vector (see @ref Rodrigues ) that, together with tvec, brings points from\n. the model coordinate system to the camera coordinate system. Input values are used as an initial solution.\n. @param tvec Input/Output translation vector. Input values are used as an initial solution.\n. @param criteria Criteria when to stop the Levenberg-Marquard iterative algorithm.\n. @param VVSlambda Gain for the virtual visual servoing control law, equivalent to the \\f$\\alpha\\f$\n. gain in the Damped Gauss-Newton formulation.\n. \n. The function refines the object pose given at least 3 object points, their corresponding image\n. projections, an initial solution for the rotation and translation vector,\n. as well as the camera matrix and the distortion coefficients.\n. The function minimizes the projection error with respect to the rotation and the translation vectors, using a\n. virtual visual servoing (VVS) @cite Chaumette06 @cite Marchand16 scheme.' ... @@ -4004,14 +3424,7 @@ def split(m, mv=...) -> typing.Any: ... -def sqrBoxFilter( - src: ndarray, - ddepth, - ksize, - dts: ndarray = ..., - anchor=..., - normalize=..., - borderType=...) -> typing.Any: +def sqrBoxFilter(src: ndarray, ddepth, ksize, dts: ndarray = ..., anchor=..., normalize=..., borderType=...) -> typing.Any: "sqrBoxFilter(src, ddepth, ksize[, dst[, anchor[, normalize[, borderType]]]]) -> dst\n. @brief Calculates the normalized sum of squares of the pixel values overlapping the filter.\n. \n. For every pixel \\f$ (x, y) \\f$ in the source image, the function calculates the sum of squares of those neighboring\n. pixel values which overlap the filter placed over the pixel \\f$ (x, y) \\f$.\n. \n. The unnormalized square box filter can be useful in computing local image statistics such as the the local\n. variance and standard deviation around the neighborhood of a pixel.\n. \n. @param src input image\n. @param dst output image of the same size and type as _src\n. @param ddepth the output image depth (-1 to use src.depth())\n. @param ksize kernel size\n. @param anchor kernel anchor point. The default value of Point(-1, -1) denotes that the anchor is at the kernel\n. center.\n. @param normalize flag, specifying whether the kernel is to be normalized by it's area or not.\n. @param borderType border mode used to extrapolate pixels outside of the image, see #BorderTypes. #BORDER_WRAP is not supported.\n. @sa boxFilter" ... @@ -4026,61 +3439,17 @@ def startWindowThread() -> typing.Any: ... -def stereoCalibrate( - objectPoints, - imagePoints1, - imagePoints2, - cameraMatrix1, - distCoeffs1, - cameraMatrix2, - distCoeffs2, - imageSize, - R=..., - T=..., - E=..., - F=..., - flags: int = ..., - criteria=...) -> typing.Any: +def stereoCalibrate(objectPoints, imagePoints1, imagePoints2, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, imageSize, R=..., T=..., E=..., F=..., flags: int = ..., criteria=...) -> typing.Any: 'stereoCalibrate(objectPoints, imagePoints1, imagePoints2, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, imageSize[, R[, T[, E[, F[, flags[, criteria]]]]]]) -> retval, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, R, T, E, F\n.' ... -def stereoCalibrateExtended( - objectPoints, - imagePoints1, - imagePoints2, - cameraMatrix1, - distCoeffs1, - cameraMatrix2, - distCoeffs2, - imageSize, - R, - T, - E=..., - F=..., - perViewErrors=..., - flags: int = ..., - criteria=...) -> typing.Any: +def stereoCalibrateExtended(objectPoints, imagePoints1, imagePoints2, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, imageSize, R, T, E=..., F=..., perViewErrors=..., flags: int = ..., criteria=...) -> typing.Any: "stereoCalibrateExtended(objectPoints, imagePoints1, imagePoints2, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, imageSize, R, T[, E[, F[, perViewErrors[, flags[, criteria]]]]]) -> retval, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, R, T, E, F, perViewErrors\n. @brief Calibrates a stereo camera set up. This function finds the intrinsic parameters\n. for each of the two cameras and the extrinsic parameters between the two cameras.\n. \n. @param objectPoints Vector of vectors of the calibration pattern points. The same structure as\n. in @ref calibrateCamera. For each pattern view, both cameras need to see the same object\n. points. Therefore, objectPoints.size(), imagePoints1.size(), and imagePoints2.size() need to be\n. equal as well as objectPoints[i].size(), imagePoints1[i].size(), and imagePoints2[i].size() need to\n. be equal for each i.\n. @param imagePoints1 Vector of vectors of the projections of the calibration pattern points,\n. observed by the first camera. The same structure as in @ref calibrateCamera.\n. @param imagePoints2 Vector of vectors of the projections of the calibration pattern points,\n. observed by the second camera. The same structure as in @ref calibrateCamera.\n. @param cameraMatrix1 Input/output camera matrix for the first camera, the same as in\n. @ref calibrateCamera. Furthermore, for the stereo case, additional flags may be used, see below.\n. @param distCoeffs1 Input/output vector of distortion coefficients, the same as in\n. @ref calibrateCamera.\n. @param cameraMatrix2 Input/output second camera matrix for the second camera. See description for\n. cameraMatrix1.\n. @param distCoeffs2 Input/output lens distortion coefficients for the second camera. See\n. description for distCoeffs1.\n. @param imageSize Size of the image used only to initialize the intrinsic camera matrices.\n. @param R Output rotation matrix. Together with the translation vector T, this matrix brings\n. points given in the first camera's coordinate system to points in the second camera's\n. coordinate system. In more technical terms, the tuple of R and T performs a change of basis\n. from the first camera's coordinate system to the second camera's coordinate system. Due to its\n. duality, this tuple is equivalent to the position of the first camera with respect to the\n. second camera coordinate system.\n. @param T Output translation vector, see description above.\n. @param E Output essential matrix.\n. @param F Output fundamental matrix.\n. @param perViewErrors Output vector of the RMS re-projection error estimated for each pattern view.\n. @param flags Different flags that may be zero or a combination of the following values:\n. - **CALIB_FIX_INTRINSIC** Fix cameraMatrix? and distCoeffs? so that only R, T, E, and F\n. matrices are estimated.\n. - **CALIB_USE_INTRINSIC_GUESS** Optimize some or all of the intrinsic parameters\n. according to the specified flags. Initial values are provided by the user.\n. - **CALIB_USE_EXTRINSIC_GUESS** R and T contain valid initial values that are optimized further.\n. Otherwise R and T are initialized to the median value of the pattern views (each dimension separately).\n. - **CALIB_FIX_PRINCIPAL_POINT** Fix the principal points during the optimization.\n. - **CALIB_FIX_FOCAL_LENGTH** Fix \\f$f^{(j)}_x\\f$ and \\f$f^{(j)}_y\\f$ .\n. - **CALIB_FIX_ASPECT_RATIO** Optimize \\f$f^{(j)}_y\\f$ . Fix the ratio \\f$f^{(j)}_x/f^{(j)}_y\\f$\n. .\n. - **CALIB_SAME_FOCAL_LENGTH** Enforce \\f$f^{(0)}_x=f^{(1)}_x\\f$ and \\f$f^{(0)}_y=f^{(1)}_y\\f$ .\n. - **CALIB_ZERO_TANGENT_DIST** Set tangential distortion coefficients for each camera to\n. zeros and fix there.\n. - **CALIB_FIX_K1,...,CALIB_FIX_K6** Do not change the corresponding radial\n. distortion coefficient during the optimization. If CALIB_USE_INTRINSIC_GUESS is set,\n. the coefficient from the supplied distCoeffs matrix is used. Otherwise, it is set to 0.\n. - **CALIB_RATIONAL_MODEL** Enable coefficients k4, k5, and k6. To provide the backward\n. compatibility, this extra flag should be explicitly specified to make the calibration\n. function use the rational model and return 8 coefficients. If the flag is not set, the\n. function computes and returns only 5 distortion coefficients.\n. - **CALIB_THIN_PRISM_MODEL** Coefficients s1, s2, s3 and s4 are enabled. To provide the\n. backward compatibility, this extra flag should be explicitly specified to make the\n. calibration function use the thin prism model and return 12 coefficients. If the flag is not\n. set, the function computes and returns only 5 distortion coefficients.\n. - **CALIB_FIX_S1_S2_S3_S4** The thin prism distortion coefficients are not changed during\n. the optimization. If CALIB_USE_INTRINSIC_GUESS is set, the coefficient from the\n. supplied distCoeffs matrix is used. Otherwise, it is set to 0.\n. - **CALIB_TILTED_MODEL** Coefficients tauX and tauY are enabled. To provide the\n. backward compatibility, this extra flag should be explicitly specified to make the\n. calibration function use the tilted sensor model and return 14 coefficients. If the flag is not\n. set, the function computes and returns only 5 distortion coefficients.\n. - **CALIB_FIX_TAUX_TAUY** The coefficients of the tilted sensor model are not changed during\n. the optimization. If CALIB_USE_INTRINSIC_GUESS is set, the coefficient from the\n. supplied distCoeffs matrix is used. Otherwise, it is set to 0.\n. @param criteria Termination criteria for the iterative optimization algorithm.\n. \n. The function estimates the transformation between two cameras making a stereo pair. If one computes\n. the poses of an object relative to the first camera and to the second camera,\n. ( \\f$R_1\\f$,\\f$T_1\\f$ ) and (\\f$R_2\\f$,\\f$T_2\\f$), respectively, for a stereo camera where the\n. relative position and orientation between the two cameras are fixed, then those poses definitely\n. relate to each other. This means, if the relative position and orientation (\\f$R\\f$,\\f$T\\f$) of the\n. two cameras is known, it is possible to compute (\\f$R_2\\f$,\\f$T_2\\f$) when (\\f$R_1\\f$,\\f$T_1\\f$) is\n. given. This is what the described function does. It computes (\\f$R\\f$,\\f$T\\f$) such that:\n. \n. \\f[R_2=R R_1\\f]\n. \\f[T_2=R T_1 + T.\\f]\n. \n. Therefore, one can compute the coordinate representation of a 3D point for the second camera's\n. coordinate system when given the point's coordinate representation in the first camera's coordinate\n. system:\n. \n. \\f[\\begin{bmatrix}\n. X_2 \\\\\n. Y_2 \\\\\n. Z_2 \\\\\n. 1\n. \\end{bmatrix} = \\begin{bmatrix}\n. R & T \\\\\n. 0 & 1\n. \\end{bmatrix} \\begin{bmatrix}\n. X_1 \\\\\n. Y_1 \\\\\n. Z_1 \\\\\n. 1\n. \\end{bmatrix}.\\f]\n. \n. \n. Optionally, it computes the essential matrix E:\n. \n. \\f[E= \\vecthreethree{0}{-T_2}{T_1}{T_2}{0}{-T_0}{-T_1}{T_0}{0} R\\f]\n. \n. where \\f$T_i\\f$ are components of the translation vector \\f$T\\f$ : \\f$T=[T_0, T_1, T_2]^T\\f$ .\n. And the function can also compute the fundamental matrix F:\n. \n. \\f[F = cameraMatrix2^{-T}\\cdot E \\cdot cameraMatrix1^{-1}\\f]\n. \n. Besides the stereo-related information, the function can also perform a full calibration of each of\n. the two cameras. However, due to the high dimensionality of the parameter space and noise in the\n. input data, the function can diverge from the correct solution. If the intrinsic parameters can be\n. estimated with high accuracy for each of the cameras individually (for example, using\n. calibrateCamera ), you are recommended to do so and then pass CALIB_FIX_INTRINSIC flag to the\n. function along with the computed intrinsic parameters. Otherwise, if all the parameters are\n. estimated at once, it makes sense to restrict some parameters, for example, pass\n. CALIB_SAME_FOCAL_LENGTH and CALIB_ZERO_TANGENT_DIST flags, which is usually a\n. reasonable assumption.\n. \n. Similarly to calibrateCamera, the function minimizes the total re-projection error for all the\n. points in all the available views from both cameras. The function returns the final value of the\n. re-projection error." ... -def stereoRectify( - cameraMatrix1, - distCoeffs1, - cameraMatrix2, - distCoeffs2, - imageSize, - R, - T, - R1=..., - R2=..., - P1=..., - P2=..., - Q=..., - flags: int = ..., - alpha=..., - newImageSize=...) -> typing.Any: +def stereoRectify(cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, imageSize, R, T, R1=..., R2=..., P1=..., P2=..., Q=..., flags: int = ..., alpha=..., newImageSize=...) -> typing.Any: 'stereoRectify(cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, imageSize, R, T[, R1[, R2[, P1[, P2[, Q[, flags[, alpha[, newImageSize]]]]]]]]) -> R1, R2, P1, P2, Q, validPixROI1, validPixROI2\n. @brief Computes rectification transforms for each head of a calibrated stereo camera.\n. \n. @param cameraMatrix1 First camera matrix.\n. @param distCoeffs1 First camera distortion parameters.\n. @param cameraMatrix2 Second camera matrix.\n. @param distCoeffs2 Second camera distortion parameters.\n. @param imageSize Size of the image used for stereo calibration.\n. @param R Rotation matrix from the coordinate system of the first camera to the second camera,\n. see @ref stereoCalibrate.\n. @param T Translation vector from the coordinate system of the first camera to the second camera,\n. see @ref stereoCalibrate.\n. @param R1 Output 3x3 rectification transform (rotation matrix) for the first camera. This matrix\n. brings points given in the unrectified first camera\'s coordinate system to points in the rectified\n. first camera\'s coordinate system. In more technical terms, it performs a change of basis from the\n. unrectified first camera\'s coordinate system to the rectified first camera\'s coordinate system.\n. @param R2 Output 3x3 rectification transform (rotation matrix) for the second camera. This matrix\n. brings points given in the unrectified second camera\'s coordinate system to points in the rectified\n. second camera\'s coordinate system. In more technical terms, it performs a change of basis from the\n. unrectified second camera\'s coordinate system to the rectified second camera\'s coordinate system.\n. @param P1 Output 3x4 projection matrix in the new (rectified) coordinate systems for the first\n. camera, i.e. it projects points given in the rectified first camera coordinate system into the\n. rectified first camera\'s image.\n. @param P2 Output 3x4 projection matrix in the new (rectified) coordinate systems for the second\n. camera, i.e. it projects points given in the rectified first camera coordinate system into the\n. rectified second camera\'s image.\n. @param Q Output \\f$4 \\times 4\\f$ disparity-to-depth mapping matrix (see @ref reprojectImageTo3D).\n. @param flags Operation flags that may be zero or CALIB_ZERO_DISPARITY . If the flag is set,\n. the function makes the principal points of each camera have the same pixel coordinates in the\n. rectified views. And if the flag is not set, the function may still shift the images in the\n. horizontal or vertical direction (depending on the orientation of epipolar lines) to maximize the\n. useful image area.\n. @param alpha Free scaling parameter. If it is -1 or absent, the function performs the default\n. scaling. Otherwise, the parameter should be between 0 and 1. alpha=0 means that the rectified\n. images are zoomed and shifted so that only valid pixels are visible (no black areas after\n. rectification). alpha=1 means that the rectified image is decimated and shifted so that all the\n. pixels from the original images from the cameras are retained in the rectified images (no source\n. image pixels are lost). Any intermediate value yields an intermediate result between\n. those two extreme cases.\n. @param newImageSize New image resolution after rectification. The same size should be passed to\n. initUndistortRectifyMap (see the stereo_calib.cpp sample in OpenCV samples directory). When (0,0)\n. is passed (default), it is set to the original imageSize . Setting it to a larger value can help you\n. preserve details in the original image, especially when there is a big radial distortion.\n. @param validPixROI1 Optional output rectangles inside the rectified images where all the pixels\n. are valid. If alpha=0 , the ROIs cover the whole images. Otherwise, they are likely to be smaller\n. (see the picture below).\n. @param validPixROI2 Optional output rectangles inside the rectified images where all the pixels\n. are valid. If alpha=0 , the ROIs cover the whole images. Otherwise, they are likely to be smaller\n. (see the picture below).\n. \n. The function computes the rotation matrices for each camera that (virtually) make both camera image\n. planes the same plane. Consequently, this makes all the epipolar lines parallel and thus simplifies\n. the dense stereo correspondence problem. The function takes the matrices computed by stereoCalibrate\n. as input. As output, it provides two rotation matrices and also two projection matrices in the new\n. coordinates. The function distinguishes the following two cases:\n. \n. - **Horizontal stereo**: the first and the second camera views are shifted relative to each other\n. mainly along the x-axis (with possible small vertical shift). In the rectified images, the\n. corresponding epipolar lines in the left and right cameras are horizontal and have the same\n. y-coordinate. P1 and P2 look like:\n. \n. \\f[\\texttt{P1} = \\begin{bmatrix}\n. f & 0 & cx_1 & 0 \\\\\n. 0 & f & cy & 0 \\\\\n. 0 & 0 & 1 & 0\n. \\end{bmatrix}\\f]\n. \n. \\f[\\texttt{P2} = \\begin{bmatrix}\n. f & 0 & cx_2 & T_x*f \\\\\n. 0 & f & cy & 0 \\\\\n. 0 & 0 & 1 & 0\n. \\end{bmatrix} ,\\f]\n. \n. where \\f$T_x\\f$ is a horizontal shift between the cameras and \\f$cx_1=cx_2\\f$ if\n. CALIB_ZERO_DISPARITY is set.\n. \n. - **Vertical stereo**: the first and the second camera views are shifted relative to each other\n. mainly in the vertical direction (and probably a bit in the horizontal direction too). The epipolar\n. lines in the rectified images are vertical and have the same x-coordinate. P1 and P2 look like:\n. \n. \\f[\\texttt{P1} = \\begin{bmatrix}\n. f & 0 & cx & 0 \\\\\n. 0 & f & cy_1 & 0 \\\\\n. 0 & 0 & 1 & 0\n. \\end{bmatrix}\\f]\n. \n. \\f[\\texttt{P2} = \\begin{bmatrix}\n. f & 0 & cx & 0 \\\\\n. 0 & f & cy_2 & T_y*f \\\\\n. 0 & 0 & 1 & 0\n. \\end{bmatrix},\\f]\n. \n. where \\f$T_y\\f$ is a vertical shift between the cameras and \\f$cy_1=cy_2\\f$ if\n. CALIB_ZERO_DISPARITY is set.\n. \n. As you can see, the first three columns of P1 and P2 will effectively be the new "rectified" camera\n. matrices. The matrices, together with R1 and R2 , can then be passed to initUndistortRectifyMap to\n. initialize the rectification map for each camera.\n. \n. See below the screenshot from the stereo_calib.cpp sample. Some red horizontal lines pass through\n. the corresponding image regions. This means that the images are well rectified, which is what most\n. stereo correspondence algorithms rely on. The green rectangles are roi1 and roi2 . You see that\n. their interiors are all valid pixels.\n. \n. ![image](pics/stereo_undistort.jpg)' ... @@ -4105,13 +3474,7 @@ def sumElems(src) -> typing.Any: ... -def textureFlattening( - src: ndarray, - mask: ndarray, - dts: ndarray = ..., - low_threshold=..., - high_threshold=..., - kernel_size=...) -> typing.Any: +def textureFlattening(src: ndarray, mask: ndarray, dts: ndarray = ..., low_threshold=..., high_threshold=..., kernel_size=...) -> typing.Any: "textureFlattening(src, mask[, dst[, low_threshold[, high_threshold[, kernel_size]]]]) -> dst\n. @brief By retaining only the gradients at edge locations, before integrating with the Poisson solver, one\n. washes out the texture of the selected region, giving its contents a flat aspect. Here Canny Edge %Detector is used.\n. \n. @param src Input 8-bit 3-channel image.\n. @param mask Input 8-bit 1 or 3-channel image.\n. @param dst Output image with the same size and type as src.\n. @param low_threshold %Range from 0 to 100.\n. @param high_threshold Value \\> 100.\n. @param kernel_size The size of the Sobel kernel to be used.\n. \n. @note\n. The algorithm assumes that the color of the source image is close to that of the destination. This\n. assumption means that when the colors don't match, the source image color gets tinted toward the\n. color of the destination image." ... @@ -4186,32 +3549,17 @@ def waitKeyEx(delay=...) -> typing.Any: ... -def warpAffine(src: ndarray, - M, - dsize: tuple[int, - int], - dts: ndarray = ..., - flags: int = ..., - borderMode=..., - borderValue=...) -> typing.Any: +def warpAffine(src: ndarray, M, dsize: tuple[int, int], dts: ndarray = ..., flags: int = ..., borderMode=..., borderValue=...) -> typing.Any: 'warpAffine(src, M, dsize[, dst[, flags[, borderMode[, borderValue]]]]) -> dst\n. @brief Applies an affine transformation to an image.\n. \n. The function warpAffine transforms the source image using the specified matrix:\n. \n. \\f[\\texttt{dst} (x,y) = \\texttt{src} ( \\texttt{M} _{11} x + \\texttt{M} _{12} y + \\texttt{M} _{13}, \\texttt{M} _{21} x + \\texttt{M} _{22} y + \\texttt{M} _{23})\\f]\n. \n. when the flag #WARP_INVERSE_MAP is set. Otherwise, the transformation is first inverted\n. with #invertAffineTransform and then put in the formula above instead of M. The function cannot\n. operate in-place.\n. \n. @param src input image.\n. @param dst output image that has the size dsize and the same type as src .\n. @param M \\f$2\\times 3\\f$ transformation matrix.\n. @param dsize size of the output image.\n. @param flags combination of interpolation methods (see #InterpolationFlags) and the optional\n. flag #WARP_INVERSE_MAP that means that M is the inverse transformation (\n. \\f$\\texttt{dst}\\rightarrow\\texttt{src}\\f$ ).\n. @param borderMode pixel extrapolation method (see #BorderTypes); when\n. borderMode=#BORDER_TRANSPARENT, it means that the pixels in the destination image corresponding to\n. the "outliers" in the source image are not modified by the function.\n. @param borderValue value used in case of a constant border; by default, it is 0.\n. \n. @sa warpPerspective, resize, remap, getRectSubPix, transform' ... -def warpPerspective(src: ndarray, - M, - dsize: tuple[int, - int], - dts: ndarray = ..., - flags: int = ..., - borderMode=..., - borderValue=...) -> typing.Any: +def warpPerspective(src: ndarray, M, dsize: tuple[int, int], dts: ndarray = ..., flags: int = ..., borderMode=..., borderValue=...) -> typing.Any: 'warpPerspective(src, M, dsize[, dst[, flags[, borderMode[, borderValue]]]]) -> dst\n. @brief Applies a perspective transformation to an image.\n. \n. The function warpPerspective transforms the source image using the specified matrix:\n. \n. \\f[\\texttt{dst} (x,y) = \\texttt{src} \\left ( \\frac{M_{11} x + M_{12} y + M_{13}}{M_{31} x + M_{32} y + M_{33}} ,\n. \\frac{M_{21} x + M_{22} y + M_{23}}{M_{31} x + M_{32} y + M_{33}} \\right )\\f]\n. \n. when the flag #WARP_INVERSE_MAP is set. Otherwise, the transformation is first inverted with invert\n. and then put in the formula above instead of M. The function cannot operate in-place.\n. \n. @param src input image.\n. @param dst output image that has the size dsize and the same type as src .\n. @param M \\f$3\\times 3\\f$ transformation matrix.\n. @param dsize size of the output image.\n. @param flags combination of interpolation methods (#INTER_LINEAR or #INTER_NEAREST) and the\n. optional flag #WARP_INVERSE_MAP, that sets M as the inverse transformation (\n. \\f$\\texttt{dst}\\rightarrow\\texttt{src}\\f$ ).\n. @param borderMode pixel extrapolation method (#BORDER_CONSTANT or #BORDER_REPLICATE).\n. @param borderValue value used in case of a constant border; by default, it equals 0.\n. \n. @sa warpAffine, resize, remap, getRectSubPix, perspectiveTransform' ... -def warpPolar(src: ndarray, dsize: tuple[int, int], center, - maxRadius, flags: int, dts: ndarray = ...) -> typing.Any: +def warpPolar(src: ndarray, dsize: tuple[int, int], center, maxRadius, flags: int, dts: ndarray = ...) -> typing.Any: 'warpPolar(src, dsize: tuple[int, int], center, maxRadius, flags[, dst]) -> dst\n. \\brief Remaps an image to polar or semilog-polar coordinates space\n. \n. @anchor polar_remaps_reference_image\n. ![Polar remaps reference](pics/polar_remap_doc.png)\n. \n. Transform the source image using the following transformation:\n. \\f[\n. dst(\\rho , \\phi ) = src(x,y)\n. \\f]\n. \n. where\n. \\f[\n. \\begin{array}{l}\n. \\vec{I} = (x - center.x, \\;y - center.y) \\\\\n. \\phi = Kangle \\cdot \\texttt{angle} (\\vec{I}) \\\\\n. \\rho = \\left\\{\\begin{matrix}\n. Klin \\cdot \\texttt{magnitude} (\\vec{I}) & default \\\\\n. Klog \\cdot log_e(\\texttt{magnitude} (\\vec{I})) & if \\; semilog \\\\\n. \\end{matrix}\\right.\n. \\end{array}\n. \\f]\n. \n. and\n. \\f[\n. \\begin{array}{l}\n. Kangle = dsize.height / 2\\Pi \\\\\n. Klin = dsize.width / maxRadius \\\\\n. Klog = dsize.width / log_e(maxRadius) \\\\\n. \\end{array}\n. \\f]\n. \n. \n. \\par Linear vs semilog mapping\n. \n. Polar mapping can be linear or semi-log. Add one of #WarpPolarMode to `flags` to specify the polar mapping mode.\n. \n. Linear is the default mode.\n. \n. The semilog mapping emulates the human "foveal" vision that permit very high acuity on the line of sight (central vision)\n. in contrast to peripheral vision where acuity is minor.\n. \n. \\par Option on `dsize`:\n. \n. - if both values in `dsize <=0 ` (default),\n. the destination image will have (almost) same area of source bounding circle:\n. \\f[\\begin{array}{l}\n. dsize.area \\leftarrow (maxRadius^2 \\cdot \\Pi) \\\\\n. dsize.width = \\texttt{cvRound}(maxRadius) \\\\\n. dsize.height = \\texttt{cvRound}(maxRadius \\cdot \\Pi) \\\\\n. \\end{array}\\f]\n. \n. \n. - if only `dsize.height <= 0`,\n. the destination image area will be proportional to the bounding circle area but scaled by `Kx * Kx`:\n. \\f[\\begin{array}{l}\n. dsize.height = \\texttt{cvRound}(dsize.width \\cdot \\Pi) \\\\\n. \\end{array}\n. \\f]\n. \n. - if both values in `dsize > 0 `,\n. the destination image will have the given size therefore the area of the bounding circle will be scaled to `dsize`.\n. \n. \n. \\par Reverse mapping\n. \n. You can get reverse mapping adding #WARP_INVERSE_MAP to `flags`\n. \\snippet polar_transforms.cpp InverseMap\n. \n. In addiction, to calculate the original coordinate from a polar mapped coordinate \\f$(rho, phi)->(x, y)\\f$:\n. \\snippet polar_transforms.cpp InverseCoordinate\n. \n. @param src Source image.\n. @param dst Destination image. It will have same type as src.\n. @param dsize The destination image size (see description for valid options).\n. @param center The transformation center.\n. @param maxRadius The radius of the bounding circle to transform. It determines the inverse magnitude scale parameter too.\n. @param flags A combination of interpolation methods, #InterpolationFlags + #WarpPolarMode.\n. - Add #WARP_POLAR_LINEAR to select linear polar mapping (default)\n. - Add #WARP_POLAR_LOG to select semilog polar mapping\n. - Add #WARP_INVERSE_MAP for reverse mapping.\n. @note\n. - The function can not operate in-place.\n. - To calculate magnitude and angle in degrees #cartToPolar is used internally thus angles are measured from 0 to 360 with accuracy about 0.3 degrees.\n. - This function uses #remap. Due to current implementation limitations the size of an input and output images should be less than 32767x32767.\n. \n. @sa cv::remap' ... diff --git a/typings/keyboard/__init__.pyi b/typings/keyboard/__init__.pyi index 2ca50a5a..f17c2b0b 100644 --- a/typings/keyboard/__init__.pyi +++ b/typings/keyboard/__init__.pyi @@ -3,6 +3,7 @@ This type stub file was generated by pyright. """ from __future__ import print_function as _print_function +import queue as _queue from collections.abc import Callable from threading import Lock as _Lock from typing import Any, Optional, Union @@ -16,14 +17,13 @@ try: from threading import _Event as _UninterruptibleEvent # type: ignore except NameError: # Python3 - import queue as _queue from threading import Event as _UninterruptibleEvent Callback = Callable[[KeyboardEvent], None] version: str -_is_str = Callable[[Any], bool] -_is_number = Callable[[Any], bool] +_is_str: Callable[[Any], bool] +_is_number: Callable[[Any], bool] _is_list: Callable[[Any], bool] diff --git a/typings/keyboard/_generic.pyi b/typings/keyboard/_generic.pyi index 57d423b2..c83498f7 100644 --- a/typings/keyboard/_generic.pyi +++ b/typings/keyboard/_generic.pyi @@ -2,8 +2,9 @@ This type stub file was generated by pyright. """ -from typing import NoReturn from threading import Lock +from typing import NoReturn + try: from queue import Queue except ImportError: From 3f9254b6e7f33b0bbcf3b06aec8602f84f8bab55 Mon Sep 17 00:00:00 2001 From: Avasam Date: Mon, 11 Apr 2022 14:19:29 -0400 Subject: [PATCH 041/137] Resynced settings --- .flake8 | 3 ++- .vscode/settings.json | 14 +------------- pyproject.toml | 12 +++++++----- scripts/install.bat | 6 +++--- 4 files changed, 13 insertions(+), 22 deletions(-) diff --git a/.flake8 b/.flake8 index 3d314775..11b14651 100644 --- a/.flake8 +++ b/.flake8 @@ -17,7 +17,8 @@ per-file-ignores= ; Allow ... on same line as def ; Line too long ; Naming conventions can't be controlled for external libraries - typings/**: Q000,E704,E501,N8 + typings/**: Q000,E704,E501,N8 + ; PyQt methods ignore-names=closeEvent,paintEvent,keyPressEvent,mousePressEvent,mouseMoveEvent,mouseReleaseEvent ; McCabe max-complexity is also taken care of by Pylint and doesn't fail the build there diff --git a/.vscode/settings.json b/.vscode/settings.json index 067b9726..d4a29239 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -60,7 +60,7 @@ "python.linting.pylintCategorySeverity.convention": "Warning", "python.linting.pylintCategorySeverity.refactor": "Warning", "python.linting.flake8Enabled": true, - // Errors + // pycodestyles "python.linting.flake8CategorySeverity.E": "Warning", // Pyflakes "python.linting.flake8CategorySeverity.F": "Warning", @@ -77,16 +77,4 @@ // Just another wrapper, use Flake8 OR this "python.linting.pylamaEnabled": false, "python.linting.banditEnabled": true, - // Copy those over to your user settings - "sonarlint.rules": { - "python:S1192": { - "level": "off" - }, - "python:S3776": { - "level": "off" - }, - "python:S107": { - "level": "off" - }, - }, } diff --git a/pyproject.toml b/pyproject.toml index b6203e6b..5d611bb1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -80,8 +80,6 @@ ignore-paths = [ # We expect stub files to be incomplete or contain useless statements "^.*\\.pyi$", ] -# No need to mention the fixmes -disable = ["fixme"] extension-pkg-allow-list = ["PyQt6", "win32ui"] [tool.pylint.FORMAT] @@ -91,8 +89,8 @@ max-line-length = 120 # Same as SonarLint max-args = 7 # Arbitrary to 2 bytes -max-attributes = 16 -max-locals = 16 +max-attributes = 15 +max-locals = 15 [tool.pylint.'MESSAGES CONTROL'] # Same as SonarLint @@ -107,8 +105,10 @@ good-names = [ # PyQt methods "closeEvent", "paintEvent", "keyPressEvent", "mousePressEvent", "mouseMoveEvent", "mouseReleaseEvent", # https://github.com/PyCQA/pylint/issues/2018 - "x", "y", "a0", "i", "t0", "t1"] + "id", "x", "y", "a0", "i", "t0", "t1"] disable = [ + # No need to mention the fixmes + "fixme", "missing-docstring", # We group imports "wrong-import-position", @@ -116,6 +116,8 @@ disable = [ "unused-argument", # Already taken care of by Flake8 "unused-import", + # Similar lines in 2 files, doesn't really work + "R0801", ] [tool.pylint.TYPECHECK] diff --git a/scripts/install.bat b/scripts/install.bat index b32ff99e..1b61fb02 100644 --- a/scripts/install.bat +++ b/scripts/install.bat @@ -1,4 +1,4 @@ -py -3.9 -m pip install wheel -py -3.9 -m pip install -r "%~p0requirements.txt" -npm install -g pyright +py -3.9 -m pip install wheel --upgrade +py -3.9 -m pip install -r "%~p0requirements.txt" --upgrade +npm install -g pyright@latest CALL "%~p0compile_resources.bat" From 724149e56858ac74dfeae1e217ec78fad5c2040c Mon Sep 17 00:00:00 2001 From: Avasam Date: Mon, 11 Apr 2022 15:25:24 -0400 Subject: [PATCH 042/137] post-merge fix linting --- pyproject.toml | 2 +- src/hotkeys.py | 4 ++-- src/user_profile.py | 13 ++++++------- typings/PyInstaller/utils/hooks/__init__.pyi | 4 ---- typings/keyboard/__init__.pyi | 11 +++++++++++ typings/keyboard/_canonical_names.pyi | 1 + typings/keyboard/_generic.pyi | 1 + typings/keyboard/_keyboard_event.pyi | 1 + typings/pyautogui/__init__.pyi | 1 + 9 files changed, 24 insertions(+), 14 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 5d611bb1..c779b207 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -23,7 +23,7 @@ reportPropertyTypeMismatch="error" reportUninitializedInstanceVariable="error" reportUnnecessaryTypeIgnoreComment="error" reportUnusedCallResult="none" -ignore = [ +exclude = [ # Auto generated "src/gen/", # We expect stub files to be incomplete or contain useless statements diff --git a/src/hotkeys.py b/src/hotkeys.py index 7d1a0e38..3ddf02a1 100644 --- a/src/hotkeys.py +++ b/src/hotkeys.py @@ -4,8 +4,8 @@ from collections.abc import Callable from typing import TYPE_CHECKING, Literal, Optional, Union -import keyboard # https://github.com/boppreh/keyboard/issues/505 -import pyautogui # https://github.com/asweigart/pyautogui/issues/645 +import keyboard +import pyautogui if TYPE_CHECKING: from AutoSplit import AutoSplit diff --git a/src/user_profile.py b/src/user_profile.py index 804ef3d4..f44ddca1 100644 --- a/src/user_profile.py +++ b/src/user_profile.py @@ -1,21 +1,21 @@ from __future__ import annotations -from typing import TYPE_CHECKING, TypedDict, cast -if TYPE_CHECKING: - from AutoSplit import AutoSplit import os import sys +from typing import TYPE_CHECKING, TypedDict, cast -import keyboard # https://github.com/boppreh/keyboard/issues/505 +import keyboard import toml -from win32 import win32gui from PyQt6 import QtCore, QtWidgets +from win32 import win32gui import error_messages from capture_windows import Region from gen import design from hotkeys import set_hotkey +if TYPE_CHECKING: + from AutoSplit import AutoSplit # Keyword "frozen" is for setting basedir while in onefile mode in pyinstaller FROZEN = hasattr(sys, "frozen") # Get the directory of either AutoSplit.exe or AutoSplit.py @@ -145,8 +145,7 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str set_hotkey(autosplit, "pause", autosplit.settings_dict["pause_hotkey"]) if autosplit.settings_dict["captured_window_title"]: - # https://github.com/kaluluosi/pywin32-stubs/issues/7 - hwnd = win32gui.FindWindow(None, autosplit.settings_dict["captured_window_title"]) # type: ignore + hwnd = win32gui.FindWindow(None, autosplit.settings_dict["captured_window_title"]) if hwnd: autosplit.hwnd = hwnd else: diff --git a/typings/PyInstaller/utils/hooks/__init__.pyi b/typings/PyInstaller/utils/hooks/__init__.pyi index af43cf89..2e09bc15 100644 --- a/typings/PyInstaller/utils/hooks/__init__.pyi +++ b/typings/PyInstaller/utils/hooks/__init__.pyi @@ -84,11 +84,7 @@ def is_module_or_submodule(name, mod_or_submod): ... -<< << << < HEAD -PY_DYLIB_PATTERNS = ... -== == == = PY_DYLIB_PATTERNS: str ->>>>>> > 8885768 (Massively sped up Flake tests) def collect_dynamic_libs(package: str, destdir: Optional[str] = ...) -> list[tuple[str, str]]: diff --git a/typings/keyboard/__init__.pyi b/typings/keyboard/__init__.pyi index f17c2b0b..1b433450 100644 --- a/typings/keyboard/__init__.pyi +++ b/typings/keyboard/__init__.pyi @@ -1,5 +1,6 @@ """ # noqa: Y021 This type stub file was generated by pyright. +https://github.com/boppreh/keyboard/issues/505 """ from __future__ import print_function as _print_function @@ -8,9 +9,19 @@ from collections.abc import Callable from threading import Lock as _Lock from typing import Any, Optional, Union +from keyboard._canonical_names import all_modifiers, normalize_name, sided_modifiers from keyboard._generic import GenericListener as _GenericListener from keyboard._keyboard_event import KEY_DOWN, KEY_UP, KeyboardEvent +__all__ = [ + "KEY_DOWN", + "KEY_UP", + "KeyboardEvent", + "_GenericListener", + "all_modifiers", + "normalize_name", + "sided_modifiers"] + try: # Python2 # threading.Event is a function in Python2 wrappin _Event (?!). diff --git a/typings/keyboard/_canonical_names.pyi b/typings/keyboard/_canonical_names.pyi index 2c8ad6d3..d72e4735 100644 --- a/typings/keyboard/_canonical_names.pyi +++ b/typings/keyboard/_canonical_names.pyi @@ -1,5 +1,6 @@ """ # noqa: Y021 This type stub file was generated by pyright. +https://github.com/boppreh/keyboard/issues/505 """ canonical_names: dict[str, str] diff --git a/typings/keyboard/_generic.pyi b/typings/keyboard/_generic.pyi index c83498f7..dad8f9a0 100644 --- a/typings/keyboard/_generic.pyi +++ b/typings/keyboard/_generic.pyi @@ -1,5 +1,6 @@ """ # noqa: Y021 This type stub file was generated by pyright. +https://github.com/boppreh/keyboard/issues/505 """ from threading import Lock diff --git a/typings/keyboard/_keyboard_event.pyi b/typings/keyboard/_keyboard_event.pyi index 2aede451..1f31611d 100644 --- a/typings/keyboard/_keyboard_event.pyi +++ b/typings/keyboard/_keyboard_event.pyi @@ -1,5 +1,6 @@ """ # noqa: Y021 This type stub file was generated by pyright. +https://github.com/boppreh/keyboard/issues/505 """ from __future__ import annotations diff --git a/typings/pyautogui/__init__.pyi b/typings/pyautogui/__init__.pyi index 9bb8bd99..9f96fb2b 100644 --- a/typings/pyautogui/__init__.pyi +++ b/typings/pyautogui/__init__.pyi @@ -1,5 +1,6 @@ """# noqa: Y021 This type stub file was generated by pyright. +https://github.com/asweigart/pyautogui/issues/645 """ from __future__ import absolute_import, division, print_function From 24df1a38385615d35b3f291647d968a2bec9bf33 Mon Sep 17 00:00:00 2001 From: Avasam Date: Mon, 11 Apr 2022 15:49:24 -0400 Subject: [PATCH 043/137] post-merge linting fixes --- src/capture_method.py | 6 +++--- src/capture_windows.py | 10 ++++++++-- src/screen_region.py | 17 ++++++++++++----- typings/d3dshot/capture_output.pyi | 7 +++++-- .../capture_outputs/numpy_capture_output.pyi | 4 +++- .../numpy_float_capture_output.pyi | 5 ++++- .../capture_outputs/pil_capture_output.pyi | 4 +++- .../capture_outputs/pytorch_capture_output.pyi | 4 +++- .../pytorch_float_capture_output.pyi | 4 +++- .../pytorch_float_gpu_capture_output.pyi | 4 +++- .../pytorch_gpu_capture_output.pyi | 4 +++- typings/d3dshot/d3dshot.pyi | 10 ++++++---- typings/d3dshot/display.pyi | 4 +++- typings/d3dshot/dll/d3d.pyi | 3 +++ typings/d3dshot/dll/dxgi.pyi | 5 ++++- typings/d3dshot/dll/user32.pyi | 4 +++- 16 files changed, 69 insertions(+), 26 deletions(-) diff --git a/src/capture_method.py b/src/capture_method.py index 1c5ee986..d173c67f 100644 --- a/src/capture_method.py +++ b/src/capture_method.py @@ -1,8 +1,8 @@ -from typing import TypedDict - -from platform import version from collections import OrderedDict from enum import Enum, unique +from platform import version +from typing import TypedDict + # https://docs.microsoft.com/en-us/uwp/api/windows.graphics.capture.graphicscapturepicker#applies-to WCG_MIN_BUILD = 17134 diff --git a/src/capture_windows.py b/src/capture_windows.py index f05f93ea..1995cbef 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -102,10 +102,16 @@ def __windows_graphics_capture(windows_graphics_capture: Optional[WindowsGraphic return windows_graphics_capture.last_captured_frame, True async def coroutine(): - return await SoftwareBitmap.create_copy_from_surface_async(frame.surface) + async_operation = SoftwareBitmap.create_copy_from_surface_async(frame.surface) # pyright: ignore + return await async_operation if async_operation else None software_bitmap = asyncio.run(coroutine()) - reference = software_bitmap.lock_buffer(BitmapBufferAccessMode.READ_WRITE).create_reference() + if not software_bitmap: + raise ValueError("Unable to convert Direct3D11CaptureFrame to SoftwareBitmap.") + bitmap_buffer = software_bitmap.lock_buffer(BitmapBufferAccessMode.READ_WRITE) + if not bitmap_buffer: + raise ValueError("Unable to obtain the BitmapBuffer from SoftwareBitmap.") + reference = bitmap_buffer.create_reference() image = np.frombuffer(cast(bytes, reference), dtype=np.uint8) image.shape = (windows_graphics_capture.size.height, windows_graphics_capture.size.width, 4) image = image[ diff --git a/src/screen_region.py b/src/screen_region.py index ff5dab77..f9a9fd6e 100644 --- a/src/screen_region.py +++ b/src/screen_region.py @@ -46,10 +46,6 @@ + ");;"\ + ";;".join([f"{format} ({extensions})" for format, extensions in SUPPORTED_IMREAD_FORMATS]) - -if TYPE_CHECKING: - from AutoSplit import AutoSplit - WINDOWS_SHADOW_SIZE = 8 WINDOWS_TOPBAR_SIZE = 24 user32 = ctypes.windll.user32 @@ -105,14 +101,22 @@ def callback(async_operation: IAsyncOperation[GraphicsCaptureItem], async_status if async_status != AsyncStatus.COMPLETED: return item = async_operation.get_results() + if not item: + return autosplit.settings_dict["captured_window_title"] = item.display_name + if not media_capture.media_capture_settings: + raise OSError("Unable to initialize a Direct3D Device.") device = media_capture.media_capture_settings.direct3_d11_device frame_pool = Direct3D11CaptureFramePool.create_free_threaded( device, DirectXPixelFormat.B8_G8_R8_A8_UINT_NORMALIZED, 1, item.size) + if not frame_pool: + raise OSError("Unable to create a frame pool for a capture session.") session = frame_pool.create_capture_session(item) + if not session: + raise OSError("Unable to create a capture session.") session.is_cursor_capture_enabled = False session.start_capture() autosplit.windows_graphics_capture = WindowsGraphicsCapture( @@ -120,7 +124,10 @@ def callback(async_operation: IAsyncOperation[GraphicsCaptureItem], async_status picker = GraphicsCapturePicker() initialize_with_window(picker, autosplit.effectiveWinId().__int__()) - picker.pick_single_item_async().completed = callback + async_operation = picker.pick_single_item_async() # pyright: ignore + # None if the selection is canceled + if async_operation: + async_operation.completed = callback def select_window(autosplit: AutoSplit): diff --git a/typings/d3dshot/capture_output.pyi b/typings/d3dshot/capture_output.pyi index 2ee804e0..5478d8d7 100644 --- a/typings/d3dshot/capture_output.pyi +++ b/typings/d3dshot/capture_output.pyi @@ -3,9 +3,12 @@ This type stub file was generated by pyright. """ import enum from typing import Any -from PIL import Image -from numpy.typing import NDArray + from numpy import uint8 +from numpy.typing import NDArray +from PIL import Image + +# class CaptureOutputs(enum.Enum): diff --git a/typings/d3dshot/capture_outputs/numpy_capture_output.pyi b/typings/d3dshot/capture_outputs/numpy_capture_output.pyi index 66c473a3..b6d79b6d 100644 --- a/typings/d3dshot/capture_outputs/numpy_capture_output.pyi +++ b/typings/d3dshot/capture_outputs/numpy_capture_output.pyi @@ -2,10 +2,12 @@ This type stub file was generated by pyright. """ +from d3dshot.capture_output import CaptureOutput from numpy import uint8 from numpy.typing import NDArray from PIL import Image -from d3dshot.capture_output import CaptureOutput + +# class NumpyCaptureOutput(CaptureOutput): diff --git a/typings/d3dshot/capture_outputs/numpy_float_capture_output.pyi b/typings/d3dshot/capture_outputs/numpy_float_capture_output.pyi index d1fd482a..287d0cd0 100644 --- a/typings/d3dshot/capture_outputs/numpy_float_capture_output.pyi +++ b/typings/d3dshot/capture_outputs/numpy_float_capture_output.pyi @@ -3,8 +3,11 @@ This type stub file was generated by pyright. """ from typing import Any -from PIL import Image + from d3dshot.capture_outputs.numpy_capture_output import NumpyCaptureOutput +from PIL import Image + +# class NumpyFloatCaptureOutput(NumpyCaptureOutput): diff --git a/typings/d3dshot/capture_outputs/pil_capture_output.pyi b/typings/d3dshot/capture_outputs/pil_capture_output.pyi index 53a91a11..218b2037 100644 --- a/typings/d3dshot/capture_outputs/pil_capture_output.pyi +++ b/typings/d3dshot/capture_outputs/pil_capture_output.pyi @@ -2,8 +2,10 @@ This type stub file was generated by pyright. """ -from PIL import Image from d3dshot.capture_output import CaptureOutput +from PIL import Image + +# class PILCaptureOutput(CaptureOutput): diff --git a/typings/d3dshot/capture_outputs/pytorch_capture_output.pyi b/typings/d3dshot/capture_outputs/pytorch_capture_output.pyi index 5c301c91..ac5cd879 100644 --- a/typings/d3dshot/capture_outputs/pytorch_capture_output.pyi +++ b/typings/d3dshot/capture_outputs/pytorch_capture_output.pyi @@ -2,8 +2,10 @@ This type stub file was generated by pyright. """ -from PIL import Image from d3dshot.capture_output import CaptureOutput +from PIL import Image + +# class PytorchCaptureOutput(CaptureOutput): diff --git a/typings/d3dshot/capture_outputs/pytorch_float_capture_output.pyi b/typings/d3dshot/capture_outputs/pytorch_float_capture_output.pyi index 01387617..6024505c 100644 --- a/typings/d3dshot/capture_outputs/pytorch_float_capture_output.pyi +++ b/typings/d3dshot/capture_outputs/pytorch_float_capture_output.pyi @@ -2,8 +2,10 @@ This type stub file was generated by pyright. """ -from PIL import Image from d3dshot.capture_outputs.pytorch_capture_output import PytorchCaptureOutput +from PIL import Image + +# class PytorchFloatCaptureOutput(PytorchCaptureOutput): diff --git a/typings/d3dshot/capture_outputs/pytorch_float_gpu_capture_output.pyi b/typings/d3dshot/capture_outputs/pytorch_float_gpu_capture_output.pyi index 0fe4245b..681feac0 100644 --- a/typings/d3dshot/capture_outputs/pytorch_float_gpu_capture_output.pyi +++ b/typings/d3dshot/capture_outputs/pytorch_float_gpu_capture_output.pyi @@ -2,8 +2,10 @@ This type stub file was generated by pyright. """ -from PIL import Image from d3dshot.capture_outputs.pytorch_gpu_capture_output import PytorchGPUCaptureOutput +from PIL import Image + +# class PytorchFloatGPUCaptureOutput(PytorchGPUCaptureOutput): diff --git a/typings/d3dshot/capture_outputs/pytorch_gpu_capture_output.pyi b/typings/d3dshot/capture_outputs/pytorch_gpu_capture_output.pyi index ad2339ba..e7fd83fc 100644 --- a/typings/d3dshot/capture_outputs/pytorch_gpu_capture_output.pyi +++ b/typings/d3dshot/capture_outputs/pytorch_gpu_capture_output.pyi @@ -2,8 +2,10 @@ This type stub file was generated by pyright. """ -from PIL import Image from d3dshot.capture_outputs.pytorch_capture_output import PytorchCaptureOutput +from PIL import Image + +# class PytorchGPUCaptureOutput(PytorchCaptureOutput): diff --git a/typings/d3dshot/d3dshot.pyi b/typings/d3dshot/d3dshot.pyi index f5e60832..53d043ae 100644 --- a/typings/d3dshot/d3dshot.pyi +++ b/typings/d3dshot/d3dshot.pyi @@ -1,13 +1,15 @@ """ # noqa: Y021 This type stub file was generated by pyright. """ -from typing import Optional from collections import deque -from numpy.typing import NDArray -from d3dshot.display import Display -from d3dshot.capture_output import CaptureOutput +from typing import Optional import cv2 +from d3dshot.capture_output import CaptureOutput +from d3dshot.display import Display +from numpy.typing import NDArray + +# class Singleton(type): diff --git a/typings/d3dshot/display.pyi b/typings/d3dshot/display.pyi index 05277a4a..4991efd0 100644 --- a/typings/d3dshot/display.pyi +++ b/typings/d3dshot/display.pyi @@ -3,8 +3,10 @@ This type stub file was generated by pyright. """ -from typing import Literal, Optional import ctypes +from typing import Literal, Optional + +# class Display: diff --git a/typings/d3dshot/dll/d3d.pyi b/typings/d3dshot/dll/d3d.pyi index a904e68a..0540758f 100644 --- a/typings/d3dshot/dll/d3d.pyi +++ b/typings/d3dshot/dll/d3d.pyi @@ -3,8 +3,11 @@ This type stub file was generated by pyright. """ import ctypes + import comtypes +# + class DXGI_SAMPLE_DESC(ctypes.Structure): _fields_ = ... diff --git a/typings/d3dshot/dll/dxgi.pyi b/typings/d3dshot/dll/dxgi.pyi index acf927e9..2e5e1c38 100644 --- a/typings/d3dshot/dll/dxgi.pyi +++ b/typings/d3dshot/dll/dxgi.pyi @@ -2,10 +2,13 @@ This type stub file was generated by pyright. """ -from typing import Any, Union import ctypes +from typing import Any, Union + import comtypes +# + class LUID(ctypes.Structure): _fields_ = ... diff --git a/typings/d3dshot/dll/user32.pyi b/typings/d3dshot/dll/user32.pyi index a4d9f20f..8b423731 100644 --- a/typings/d3dshot/dll/user32.pyi +++ b/typings/d3dshot/dll/user32.pyi @@ -2,8 +2,10 @@ This type stub file was generated by pyright. """ -from typing import Any import ctypes +from typing import Any + +# class DISPLAY_DEVICE(ctypes.Structure): From 23694d9cf1480e7443af078ed503f867522ef87f Mon Sep 17 00:00:00 2001 From: Avasam Date: Wed, 13 Apr 2022 16:51:09 -0400 Subject: [PATCH 044/137] Re-introduced region selection for WGC API. Fixed a few possible comparison issues. Fixed the hacky window shadow removal --- .vscode/settings.json | 2 +- src/AutoSplit.py | 35 +++++------------------- src/AutoSplitImage.py | 11 +++++--- src/capture_windows.py | 12 +++++++-- src/compare.py | 6 ++--- src/error_messages.py | 39 +++++++++++++++++++++++++++ src/menu_bar.py | 5 +--- src/screen_region.py | 61 ++++++++++++++++++++++++++++-------------- src/split_parser.py | 2 +- src/user_profile.py | 19 ++++--------- 10 files changed, 115 insertions(+), 77 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index d4a29239..a4a19fd0 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -40,9 +40,9 @@ "**/__pycache__": true, }, "search.exclude": { - "**/node_modules": true, "**/bower_components": true, "**/*.code-search": true, + "*.lock": true, "typings": true, }, "[python]": { diff --git a/src/AutoSplit.py b/src/AutoSplit.py index dcf14b6c..3ae9b123 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -39,9 +39,6 @@ from split_parser import BELOW_FLAG, DUMMY_FLAG, PAUSE_FLAG, parse_and_validate_images from user_profile import DEFAULT_PROFILE, FROZEN -CREATE_NEW_ISSUE_MESSAGE = ( - "Please create a New Issue at " - + "github.com/Toufool/Auto-Split/issues, describe what happened, and copy & paste the error message below") START_AUTO_SPLITTER_TEXT = "Start Auto Splitter" CHECK_FPS_ITERATIONS = 10 @@ -49,18 +46,6 @@ os.environ["REQUESTS_CA_BUNDLE"] = certifi.where() -def make_excepthook(autosplit: AutoSplit): - def excepthook(exception_type: type[BaseException], exception: BaseException, _traceback: Optional[TracebackType]): - # Catch Keyboard Interrupts for a clean close - if exception_type is KeyboardInterrupt or isinstance(exception, KeyboardInterrupt): - sys.exit(0) - autosplit.show_error_signal.emit(lambda: error_messages.exception_traceback( - "AutoSplit encountered an unhandled exception and will try to recover, " - + f"however, there is no guarantee it will keep working properly. {CREATE_NEW_ISSUE_MESSAGE}", - exception)) - return excepthook - - class AutoSplit(QMainWindow, design.Ui_MainWindow): myappid = f"Toufool.AutoSplit.v{VERSION}" ctypes.windll.shell32.SetCurrentProcessExplicitAppUserModelID(myappid) @@ -132,8 +117,7 @@ def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-man # Setup global error handling self.show_error_signal.connect(lambda errorMessageBox: errorMessageBox()) - # Whithin LiveSplit excepthook needs to use MainWindow's signals to show errors - sys.excepthook = make_excepthook(self) + sys.excepthook = error_messages.make_excepthook(self) self.setupUi(self) @@ -383,7 +367,7 @@ def __take_screenshot(self): # Grab screenshot of capture region capture, _ = capture_region(self) - if capture is None: + if capture is None or not capture.size: error_messages.region() return @@ -750,7 +734,8 @@ def __get_capture_for_comparison(self): # This most likely means we lost capture (ie the captured window was closed, crashed, etc.) # We can't recover by name (yet) with WindowsGraphicsCapture - if capture is None and self.settings_dict["capture_method"] != CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + if ( + capture is None or not capture.size) and self.settings_dict["capture_method"] != CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: # Try to recover by using the window name self.live_image.setText("Trying to recover window...") hwnd = win32gui.FindWindow(None, self.settings_dict["captured_window_title"]) @@ -758,7 +743,7 @@ def __get_capture_for_comparison(self): if hwnd: self.hwnd = hwnd capture, _ = capture_region(self) - return None if capture is None else cv2.resize( + return None if capture is None or not capture.size else cv2.resize( capture, COMPARISON_RESIZE, interpolation=cv2.INTER_NEAREST), is_old_image def __reset_if_should(self, capture: Optional[cv2.ndarray]): @@ -795,7 +780,7 @@ def __update_split_image(self, specific_image: Optional[AutoSplitImage] = None): # Get split image self.split_image = specific_image or self.split_images_and_loop_number[0 + self.split_image_number][0] - if self.split_image.bytes is not None: + if self.split_image.bytes is not None and self.split_image.bytes.size: set_ui_image(self.current_split_image, self.split_image.bytes, True) self.current_image_file_label.setText(self.split_image.filename) @@ -878,13 +863,7 @@ def main(): exit_code = app.exec() except Exception as exception: # pylint: disable=broad-except # We really want to catch everything here - message = f"AutoSplit encountered an unrecoverable exception and will now close. {CREATE_NEW_ISSUE_MESSAGE}" - # Print error to console if not running in executable - if FROZEN: - error_messages.exception_traceback(message, exception) - else: - traceback.print_exception(type(exception), exception, exception.__traceback__) - sys.exit(1) + error_messages.handle_top_level_exceptions(exception) # Catch Keyboard Interrupts for a clean close signal.signal(signal.SIGINT, lambda code, _: sys.exit(code)) diff --git a/src/AutoSplitImage.py b/src/AutoSplitImage.py index 712ef65b..6c3274e0 100644 --- a/src/AutoSplitImage.py +++ b/src/AutoSplitImage.py @@ -10,8 +10,6 @@ import error_messages from compare import check_if_image_has_transparency, compare_histograms, compare_l2_norm, compare_phash -from split_parser import (comparison_method_from_filename, delay_time_from_filename, flags_from_filename, - loop_from_filename, pause_from_filename, threshold_from_filename) if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -100,7 +98,7 @@ def __init__(self, path: str): def __read_image_bytes(self, path: str): image = cv2.imread(path, cv2.IMREAD_UNCHANGED) - if image is None: + if image is None or not image.size: self.bytes = None error_messages.image_type(path) return @@ -131,7 +129,7 @@ def compare_with_capture( Compare image with capture using image's comparison method. Falls back to combobox """ - if self.bytes is None or capture is None: + if self.bytes is None or not self.bytes.size or capture is None or not self.bytes.size: return 0.0 comparison_method = self.__get_comparison_method(default) if comparison_method == 0: @@ -141,3 +139,8 @@ def compare_with_capture( if comparison_method == 2: return compare_phash(self.bytes, capture, self.mask) return 0.0 + + +if True: # pylint: disable=using-constant-test + from split_parser import (comparison_method_from_filename, delay_time_from_filename, flags_from_filename, + loop_from_filename, pause_from_filename, threshold_from_filename) diff --git a/src/capture_windows.py b/src/capture_windows.py index 1995cbef..e2291aac 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -104,9 +104,17 @@ def __windows_graphics_capture(windows_graphics_capture: Optional[WindowsGraphic async def coroutine(): async_operation = SoftwareBitmap.create_copy_from_surface_async(frame.surface) # pyright: ignore return await async_operation if async_operation else None + try: + software_bitmap = asyncio.run(coroutine()) + except SystemError as exception: + # HACK: can happen when closing the GraphicsCapturePicker + if str(exception).endswith("returned a result with an error set"): + return windows_graphics_capture.last_captured_frame, True + raise - software_bitmap = asyncio.run(coroutine()) if not software_bitmap: + # HACK: Can happen when starting the region selector + return windows_graphics_capture.last_captured_frame, True raise ValueError("Unable to convert Direct3D11CaptureFrame to SoftwareBitmap.") bitmap_buffer = software_bitmap.lock_buffer(BitmapBufferAccessMode.READ_WRITE) if not bitmap_buffer: @@ -145,7 +153,7 @@ def capture_region(autosplit: AutoSplit) -> tuple[Optional[cv2.ndarray], bool]: def set_ui_image(qlabel: QLabel, image: Optional[cv2.ndarray], transparency: bool): - if image is None: + if image is None or not image.size: # Clear current pixmap if image is None. But don't clear text if not qlabel.text(): qlabel.clear() diff --git a/src/compare.py b/src/compare.py index b9b31ed3..b46720e7 100644 --- a/src/compare.py +++ b/src/compare.py @@ -48,7 +48,7 @@ def compare_l2_norm(source: cv2.ndarray, capture: cv2.ndarray, mask: Optional[cv # The L2 Error is summed across all pixels, so this normalizes max_error = (source.size ** 0.5) * MAXBYTE \ - if mask is None \ + if mask is None or not mask.size\ else (3 * np.count_nonzero(mask) * MAXBYTE * MAXBYTE) ** 0.5 if not max_error: @@ -74,7 +74,7 @@ def compare_template(source: cv2.ndarray, capture: cv2.ndarray, mask: Optional[c # matchTemplate returns the sum of square differences, this is the max # that the value can be. Used for normalizing from 0 to 1. max_error = source.size * MAXBYTE * MAXBYTE \ - if mask is None \ + if mask is None or not mask.size \ else np.count_nonzero(mask) return 1 - (min_val / max_error) @@ -95,7 +95,7 @@ def compare_phash(source: cv2.ndarray, capture: cv2.ndarray, mask: Optional[cv2. # each of the images. As a result of this, this function is not going to be very # helpful for large masks as the images when shrinked down to 8x8 will mostly be # the same - if mask is not None: + if mask is not None and mask.size: source = cv2.bitwise_and(source, source, mask=mask) capture = cv2.bitwise_and(capture, capture, mask=mask) diff --git a/src/error_messages.py b/src/error_messages.py index ecda5dc0..f1a66fdd 100644 --- a/src/error_messages.py +++ b/src/error_messages.py @@ -3,9 +3,14 @@ import signal import sys import traceback +from types import TracebackType +from typing import Optional from PyQt6 import QtCore, QtWidgets +from AutoSplit import AutoSplit +from user_profile import FROZEN + def __exit_program(): # stop main thread (which is probably blocked reading input) via an interrupt signal @@ -117,3 +122,37 @@ def exception_traceback(message: str, exception: BaseException): set_text_message( message, "\n".join(traceback.format_exception(None, exception, exception.__traceback__))) + + +CREATE_NEW_ISSUE_MESSAGE = ( + "Please create a New Issue at " + + "github.com/Toufool/Auto-Split/issues, describe what happened, and copy & paste the error message below") + + +def make_excepthook(autosplit: AutoSplit): + def excepthook(exception_type: type[BaseException], exception: BaseException, _traceback: Optional[TracebackType]): + # Catch Keyboard Interrupts for a clean close + if exception_type is KeyboardInterrupt or isinstance(exception, KeyboardInterrupt): + sys.exit(0) + # HACK: Can happen when starting the region selector while capturing with WindowsGraphicsCapture + if ( + exception_type is SystemError + and str(exception) == " returned a result with an error set" + ): + return + # Whithin LiveSplit excepthook needs to use MainWindow's signals to show errors + autosplit.show_error_signal.emit(lambda: exception_traceback( + "AutoSplit encountered an unhandled exception and will try to recover, " + + f"however, there is no guarantee it will keep working properly. {CREATE_NEW_ISSUE_MESSAGE}", + exception)) + return excepthook + + +def handle_top_level_exceptions(exception: Exception): + message = f"AutoSplit encountered an unrecoverable exception and will now close. {CREATE_NEW_ISSUE_MESSAGE}" + # Print error to console if not running in executable + if FROZEN: + exception_traceback(message, exception) + else: + traceback.print_exception(type(exception), exception, exception.__traceback__) + sys.exit(1) diff --git a/src/menu_bar.py b/src/menu_bar.py index 0b9d3611..4f61f0d3 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -115,10 +115,7 @@ def __set_value(self, key: str, value: Any): def __capture_method_changed(self): selected_capture_method = get_capture_method_by_index(self.capture_method_combobox.currentIndex()) - if selected_capture_method == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: - self.autosplit.select_region_button.setDisabled(True) - else: - self.autosplit.select_region_button.setDisabled(False) + if selected_capture_method != CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: self.autosplit.windows_graphics_capture = None # Recover window from name hwnd = win32gui.FindWindow(None, self.autosplit.settings_dict["captured_window_title"]) diff --git a/src/screen_region.py b/src/screen_region.py index f9a9fd6e..2afa2b08 100644 --- a/src/screen_region.py +++ b/src/screen_region.py @@ -4,6 +4,7 @@ import ctypes.wintypes import os from dataclasses import dataclass +from math import ceil from typing import TYPE_CHECKING, Optional, cast import cv2 @@ -46,8 +47,7 @@ + ");;"\ + ";;".join([f"{format} ({extensions})" for format, extensions in SUPPORTED_IMREAD_FORMATS]) -WINDOWS_SHADOW_SIZE = 8 -WINDOWS_TOPBAR_SIZE = 24 +DWMWA_EXTENDED_FRAME_BOUNDS = 9 user32 = ctypes.windll.user32 @@ -72,10 +72,11 @@ def select_region(autosplit: AutoSplit): if not hwnd or not window_text: error_messages.region() return - autosplit.hwnd = hwnd - autosplit.settings_dict["captured_window_title"] = window_text + if autosplit.settings_dict["capture_method"] != CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + autosplit.hwnd = hwnd + autosplit.settings_dict["captured_window_title"] = window_text - offset_x, offset_y, *_ = win32gui.GetWindowRect(autosplit.hwnd) + offset_x, offset_y, *_ = win32gui.GetWindowRect(hwnd) __set_region_values(autosplit, left=x - offset_x, top=y - offset_y, @@ -98,17 +99,22 @@ class WindowsGraphicsCapture: def select_graphics_item(autosplit: AutoSplit): def callback(async_operation: IAsyncOperation[GraphicsCaptureItem], async_status: AsyncStatus): - if async_status != AsyncStatus.COMPLETED: - return + try: + if async_status != AsyncStatus.COMPLETED: + return + except SystemError as exception: + # HACK: can happen when closing the GraphicsCapturePicker + if str(exception).endswith("returned a result with an error set"): + return + raise item = async_operation.get_results() if not item: return autosplit.settings_dict["captured_window_title"] = item.display_name if not media_capture.media_capture_settings: raise OSError("Unable to initialize a Direct3D Device.") - device = media_capture.media_capture_settings.direct3_d11_device frame_pool = Direct3D11CaptureFramePool.create_free_threaded( - device, + media_capture.media_capture_settings.direct3_d11_device, DirectXPixelFormat.B8_G8_R8_A8_UINT_NORMALIZED, 1, item.size) @@ -118,6 +124,7 @@ def callback(async_operation: IAsyncOperation[GraphicsCaptureItem], async_status if not session: raise OSError("Unable to create a capture session.") session.is_cursor_capture_enabled = False + # TODO: Consider GraphicsCaptureSession.IsBorderRequired = False session.start_capture() autosplit.windows_graphics_capture = WindowsGraphicsCapture( item.size, frame_pool, session, None) # pyright: ignore @@ -156,16 +163,30 @@ def select_window(autosplit: AutoSplit): autosplit.settings_dict["captured_window_title"] = window_text # Getting window bounds - # On Windows there is a shadow around the windows that we need to account for - # The top bar with the window name is also not accounted for - # HACK: This isn't an ideal solution because it assumes every window will have a top bar and shadows of default size - # FIXME: Which results in cutting *into* windows which don't have shadows or have a smaller top bar - _, __, width, height = win32gui.GetClientRect(autosplit.hwnd) + # On Windows there is a shadow around the windows that we need to account for. + # We also account for the borders and titlebar to only get the client area. + extended_frame_bounds = ctypes.wintypes.RECT() + ctypes.windll.dwmapi.DwmGetWindowAttribute( + hwnd, + DWMWA_EXTENDED_FRAME_BOUNDS, + ctypes.byref(extended_frame_bounds), + ctypes.sizeof(extended_frame_bounds)) + + window_rect = win32gui.GetWindowRect(hwnd) + _, __, client_width, client_height = win32gui.GetClientRect(hwnd) + + window_width = cast(int, extended_frame_bounds.right) - cast(int, extended_frame_bounds.left) + window_height = cast(int, extended_frame_bounds.bottom) - cast(int, extended_frame_bounds.top) + border_width = ceil((window_width - client_width) / 2) + titlebar_height = window_height - client_height - border_width * 2 + client_left = cast(int, extended_frame_bounds.left) - window_rect[0] + border_width + client_top = cast(int, extended_frame_bounds.top) - window_rect[1] + titlebar_height + __set_region_values(autosplit, - left=WINDOWS_SHADOW_SIZE, - top=WINDOWS_SHADOW_SIZE + WINDOWS_TOPBAR_SIZE, - width=width, - height=height - WINDOWS_TOPBAR_SIZE) + left=client_left, + top=client_top, + width=client_width, + height=client_height) def __get_window_from_point(x: int, y: int): @@ -203,7 +224,7 @@ def align_region(autosplit: AutoSplit): template = cv2.imread(template_filename, cv2.IMREAD_COLOR) # Validate template is a valid image file - if template is None: + if template is None or not template.size: error_messages.align_region_image_type() return @@ -211,7 +232,7 @@ def align_region(autosplit: AutoSplit): # subregion being searched for to align the image. capture, _ = capture_windows.capture_region(autosplit) - if capture is None: + if capture is None or not capture.size: error_messages.region() return diff --git a/src/split_parser.py b/src/split_parser.py index f46fe48f..d365c93a 100644 --- a/src/split_parser.py +++ b/src/split_parser.py @@ -187,7 +187,7 @@ def parse_and_validate_images(autosplit: AutoSplit): # according to all of the settings selected by the user. for image in autosplit.split_images: # Test for image without transparency - if image.bytes is None: + if image.bytes is None or not image.bytes.size: autosplit.gui_changes_on_reset() return False diff --git a/src/user_profile.py b/src/user_profile.py index 5dabf359..f6ea27e7 100644 --- a/src/user_profile.py +++ b/src/user_profile.py @@ -124,25 +124,16 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str autosplit.y_spinbox.setValue(autosplit.settings_dict["capture_region"]["y"]) autosplit.width_spinbox.setValue(autosplit.settings_dict["capture_region"]["width"]) autosplit.height_spinbox.setValue(autosplit.settings_dict["capture_region"]["height"]) + autosplit.split_image_folder_input.setText(autosplit.settings_dict["split_image_directory"]) except (FileNotFoundError, MemoryError, TypeError, toml.TomlDecodeError): autosplit.show_error_signal.emit(error_messages.invalid_settings) return False - autosplit.select_region_button.setDisabled( - autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE) - autosplit.split_image_folder_input.setText(autosplit.settings_dict["split_image_directory"]) keyboard.unhook_all() if not autosplit.is_auto_controlled: - if autosplit.settings_dict["split_hotkey"]: - set_hotkey(autosplit, "split", autosplit.settings_dict["split_hotkey"]) - if autosplit.settings_dict["reset_hotkey"]: - set_hotkey(autosplit, "reset", autosplit.settings_dict["reset_hotkey"]) - if autosplit.settings_dict["skip_split_hotkey"]: - set_hotkey(autosplit, "skip_split", autosplit.settings_dict["skip_split_hotkey"]) - if autosplit.settings_dict["undo_split_hotkey"]: - set_hotkey(autosplit, "undo_split", autosplit.settings_dict["undo_split_hotkey"]) - if autosplit.settings_dict["pause_hotkey"]: - set_hotkey(autosplit, "pause", autosplit.settings_dict["pause_hotkey"]) + for hotkey in ["split_hotkey", "reset_hotkey", "skip_split_hotkey", "undo_split_hotkey", "pause_hotkey"]: + if autosplit.settings_dict[hotkey]: + set_hotkey(autosplit, "split", cast(str, autosplit.settings_dict[hotkey])) if ( autosplit.settings_dict["captured_window_title"] @@ -181,7 +172,7 @@ def load_settings_on_open(autosplit: AutoSplit): in os.listdir(auto_split_directory) if file.endswith(".toml")] - # find all .tomls in AutoSplit folder, error if there is none or more than 1 + # Find all .tomls in AutoSplit folder, error if there is not exactly 1 if len(settings_files) < 1: error_messages.no_settings_file_on_open() return From 74edfc2c6c03cd83dfe89709fb4e76eab839acc3 Mon Sep 17 00:00:00 2001 From: Avasam Date: Wed, 13 Apr 2022 17:14:45 -0400 Subject: [PATCH 045/137] Fixed linting with updated pyright --- src/AutoSplit.py | 7 ++++--- src/capture_windows.py | 2 +- src/screen_region.py | 5 ++--- typings/PyInstaller/utils/hooks/__init__.pyi | 3 ++- 4 files changed, 9 insertions(+), 8 deletions(-) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 3ae9b123..8d7c84d6 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -12,10 +12,9 @@ import os import signal import sys -import traceback from collections.abc import Callable from time import time -from types import FunctionType, TracebackType +from types import FunctionType from typing import Optional import certifi @@ -735,7 +734,9 @@ def __get_capture_for_comparison(self): # This most likely means we lost capture (ie the captured window was closed, crashed, etc.) # We can't recover by name (yet) with WindowsGraphicsCapture if ( - capture is None or not capture.size) and self.settings_dict["capture_method"] != CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + (capture is None or not capture.size) + and self.settings_dict["capture_method"] != CaptureMethod.WINDOWS_GRAPHICS_CAPTURE + ): # Try to recover by using the window name self.live_image.setText("Trying to recover window...") hwnd = win32gui.FindWindow(None, self.settings_dict["captured_window_title"]) diff --git a/src/capture_windows.py b/src/capture_windows.py index e2291aac..c30dbc5a 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -102,7 +102,7 @@ def __windows_graphics_capture(windows_graphics_capture: Optional[WindowsGraphic return windows_graphics_capture.last_captured_frame, True async def coroutine(): - async_operation = SoftwareBitmap.create_copy_from_surface_async(frame.surface) # pyright: ignore + async_operation = SoftwareBitmap.create_copy_from_surface_async(frame.surface) return await async_operation if async_operation else None try: software_bitmap = asyncio.run(coroutine()) diff --git a/src/screen_region.py b/src/screen_region.py index 2afa2b08..daafdcc5 100644 --- a/src/screen_region.py +++ b/src/screen_region.py @@ -126,12 +126,11 @@ def callback(async_operation: IAsyncOperation[GraphicsCaptureItem], async_status session.is_cursor_capture_enabled = False # TODO: Consider GraphicsCaptureSession.IsBorderRequired = False session.start_capture() - autosplit.windows_graphics_capture = WindowsGraphicsCapture( - item.size, frame_pool, session, None) # pyright: ignore + autosplit.windows_graphics_capture = WindowsGraphicsCapture(item.size, frame_pool, session, None) picker = GraphicsCapturePicker() initialize_with_window(picker, autosplit.effectiveWinId().__int__()) - async_operation = picker.pick_single_item_async() # pyright: ignore + async_operation = picker.pick_single_item_async() # None if the selection is canceled if async_operation: async_operation.completed = callback diff --git a/typings/PyInstaller/utils/hooks/__init__.pyi b/typings/PyInstaller/utils/hooks/__init__.pyi index 2e09bc15..66f36bd4 100644 --- a/typings/PyInstaller/utils/hooks/__init__.pyi +++ b/typings/PyInstaller/utils/hooks/__init__.pyi @@ -91,7 +91,8 @@ def collect_dynamic_libs(package: str, destdir: Optional[str] = ...) -> list[tup ... -def collect_data_files(package, include_py_files=..., subdir=..., excludes=..., includes=...) -> list[tuple[str, str]]: +def collect_data_files(package: str, include_py_files: bool = ..., subdir: str = ..., + excludes: list[str] = ..., includes: list[str] = ...) -> list[tuple[str, str]]: ... From fece8e73b4ca4c1d1167ff48712e62a1a66fcefa Mon Sep 17 00:00:00 2001 From: Avasam Date: Wed, 13 Apr 2022 17:14:45 -0400 Subject: [PATCH 046/137] Fixed linting with updated pyright --- src/AutoSplit.py | 8 ++++---- src/capture_windows.py | 2 +- src/error_messages.py | 3 ++- src/screen_region.py | 5 ++--- typings/PyInstaller/utils/hooks/__init__.pyi | 3 ++- 5 files changed, 11 insertions(+), 10 deletions(-) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 3ae9b123..497740e6 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -12,10 +12,9 @@ import os import signal import sys -import traceback from collections.abc import Callable from time import time -from types import FunctionType, TracebackType +from types import FunctionType from typing import Optional import certifi @@ -735,7 +734,9 @@ def __get_capture_for_comparison(self): # This most likely means we lost capture (ie the captured window was closed, crashed, etc.) # We can't recover by name (yet) with WindowsGraphicsCapture if ( - capture is None or not capture.size) and self.settings_dict["capture_method"] != CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + (capture is None or not capture.size) + and self.settings_dict["capture_method"] != CaptureMethod.WINDOWS_GRAPHICS_CAPTURE + ): # Try to recover by using the window name self.live_image.setText("Trying to recover window...") hwnd = win32gui.FindWindow(None, self.settings_dict["captured_window_title"]) @@ -808,7 +809,6 @@ def exit_program(): if self.is_auto_controlled: self.update_auto_control.terminate() # stop main thread (which is probably blocked reading input) via an interrupt signal - # only available for windows in version 3.2 or higher os.kill(os.getpid(), signal.SIGINT) sys.exit() diff --git a/src/capture_windows.py b/src/capture_windows.py index e2291aac..c30dbc5a 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -102,7 +102,7 @@ def __windows_graphics_capture(windows_graphics_capture: Optional[WindowsGraphic return windows_graphics_capture.last_captured_frame, True async def coroutine(): - async_operation = SoftwareBitmap.create_copy_from_surface_async(frame.surface) # pyright: ignore + async_operation = SoftwareBitmap.create_copy_from_surface_async(frame.surface) return await async_operation if async_operation else None try: software_bitmap = asyncio.run(coroutine()) diff --git a/src/error_messages.py b/src/error_messages.py index f1a66fdd..b3103eac 100644 --- a/src/error_messages.py +++ b/src/error_messages.py @@ -1,4 +1,6 @@ """Error messages""" +from __future__ import annotations + import os import signal import sys @@ -14,7 +16,6 @@ def __exit_program(): # stop main thread (which is probably blocked reading input) via an interrupt signal - # only available for windows in version 3.2 or higher os.kill(os.getpid(), signal.SIGINT) sys.exit(1) diff --git a/src/screen_region.py b/src/screen_region.py index 2afa2b08..daafdcc5 100644 --- a/src/screen_region.py +++ b/src/screen_region.py @@ -126,12 +126,11 @@ def callback(async_operation: IAsyncOperation[GraphicsCaptureItem], async_status session.is_cursor_capture_enabled = False # TODO: Consider GraphicsCaptureSession.IsBorderRequired = False session.start_capture() - autosplit.windows_graphics_capture = WindowsGraphicsCapture( - item.size, frame_pool, session, None) # pyright: ignore + autosplit.windows_graphics_capture = WindowsGraphicsCapture(item.size, frame_pool, session, None) picker = GraphicsCapturePicker() initialize_with_window(picker, autosplit.effectiveWinId().__int__()) - async_operation = picker.pick_single_item_async() # pyright: ignore + async_operation = picker.pick_single_item_async() # None if the selection is canceled if async_operation: async_operation.completed = callback diff --git a/typings/PyInstaller/utils/hooks/__init__.pyi b/typings/PyInstaller/utils/hooks/__init__.pyi index 2e09bc15..66f36bd4 100644 --- a/typings/PyInstaller/utils/hooks/__init__.pyi +++ b/typings/PyInstaller/utils/hooks/__init__.pyi @@ -91,7 +91,8 @@ def collect_dynamic_libs(package: str, destdir: Optional[str] = ...) -> list[tup ... -def collect_data_files(package, include_py_files=..., subdir=..., excludes=..., includes=...) -> list[tuple[str, str]]: +def collect_data_files(package: str, include_py_files: bool = ..., subdir: str = ..., + excludes: list[str] = ..., includes: list[str] = ...) -> list[tuple[str, str]]: ... From 87c7ac6489854872758a8d98ad31f47a15479e40 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sun, 1 May 2022 16:29:14 -0400 Subject: [PATCH 047/137] Restored all functionalities for CaptureMethod.WINDOWS_GRAPHICS_CAPTURE --- pyproject.toml | 2 + scripts/install.bat | 4 +- scripts/requirements.txt | 10 ++-- src/AutoSplit.py | 12 ++--- src/capture_method.py | 16 +++---- src/capture_windows.py | 5 +- src/menu_bar.py | 16 ++++--- src/screen_region.py | 98 +++++++++++++++++++++++++--------------- src/user_profile.py | 11 +++-- 9 files changed, 102 insertions(+), 72 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index c779b207..eb9de738 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -118,6 +118,8 @@ disable = [ "unused-import", # Similar lines in 2 files, doesn't really work "R0801", + # False positives with PyQt .connect + "no-value-for-parameter", ] [tool.pylint.TYPECHECK] diff --git a/scripts/install.bat b/scripts/install.bat index 1b61fb02..6af8691b 100644 --- a/scripts/install.bat +++ b/scripts/install.bat @@ -1,4 +1,4 @@ -py -3.9 -m pip install wheel --upgrade -py -3.9 -m pip install -r "%~p0requirements.txt" --upgrade +py -m pip install wheel --upgrade +py -m pip install -r "%~p0requirements.txt" --upgrade npm install -g pyright@latest CALL "%~p0compile_resources.bat" diff --git a/scripts/requirements.txt b/scripts/requirements.txt index 0baba779..5bd3833f 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -23,7 +23,7 @@ pywin32 requests certifi toml -winsdk +winsdk>=v1.0.0b4 git+https://github.com/ranchen421/D3DShot.git#egg=D3DShot # https://github.com/SerpentAI/D3DShot/issues/44 # # Linting, formatters and Types @@ -39,9 +39,9 @@ simplejson types-simplejson>=3.17.2 types-requests # -# Not compatible with python 3.10 yet, used to design the UI. Can be downloaded externally -# Uncomment this if you want to run `designer.bat` to quickly open the bundled PyQt Designer -# PyQt6-tools +# You can comment this out if you don't want to run `designer.bat` to quickly open the bundled PyQt Designer. +# Can also be downloaded externally as a non-python package +qt6-applications # -# Comment this out if you don't want to build AutoSplit.exe: +# You can comment this out if you don't want to build AutoSplit.exe: PyInstaller diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 497740e6..5d008a9c 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -23,6 +23,7 @@ from PyQt6.QtTest import QTest from PyQt6.QtWidgets import QApplication, QFileDialog, QMainWindow, QMessageBox, QWidget from win32 import win32gui +from winsdk.windows.graphics.capture.interop import create_for_window import error_messages import user_profile @@ -34,7 +35,8 @@ from hotkeys import after_setting_hotkey, send_command from menu_bar import (VERSION, check_for_updates, get_default_settings_from_ui, open_about, open_settings, open_update_checker, view_help) -from screen_region import WindowsGraphicsCapture, align_region, select_region, select_window, validate_before_parsing +from screen_region import (WindowsGraphicsCapture, align_region, create_windows_graphics_capture, select_region, + select_window, validate_before_parsing) from split_parser import BELOW_FLAG, DUMMY_FLAG, PAUSE_FLAG, parse_and_validate_images from user_profile import DEFAULT_PROFILE, FROZEN @@ -732,17 +734,15 @@ def __get_capture_for_comparison(self): capture, is_old_image = capture_region(self) # This most likely means we lost capture (ie the captured window was closed, crashed, etc.) - # We can't recover by name (yet) with WindowsGraphicsCapture - if ( - (capture is None or not capture.size) - and self.settings_dict["capture_method"] != CaptureMethod.WINDOWS_GRAPHICS_CAPTURE - ): + if capture is None or not capture.size: # Try to recover by using the window name self.live_image.setText("Trying to recover window...") hwnd = win32gui.FindWindow(None, self.settings_dict["captured_window_title"]) # Don't fallback to desktop if hwnd: self.hwnd = hwnd + if self.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + self.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) capture, _ = capture_region(self) return None if capture is None or not capture.size else cv2.resize( capture, COMPARISON_RESIZE, interpolation=cv2.INTER_NEAREST), is_old_image diff --git a/src/capture_method.py b/src/capture_method.py index d173c67f..460bce1a 100644 --- a/src/capture_method.py +++ b/src/capture_method.py @@ -40,9 +40,9 @@ def __hash__(self): short_description="fastest, least compatible", description=( "\nA good default fast option. Also allows recording background windows " - "\n(as long as they still actually render when in the background), " - "\nbut it cannot properly record OpenGL or Hardware Accelerated Windows. " - "\nThe smaller the window, the more efficient it is. " + "\n(as long as they still actually render when in the background), but it " + "\ncannot properly record OpenGL, Hardware Accelerated or Exclusive Fullscreen windows. " + "\nThe smaller the region, the more efficient it is. " ), ), CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: CaptureMethodInfo( @@ -50,12 +50,8 @@ def __hash__(self): short_description="fast, most compatible but less features", description=( f"\nOnly available in Windows 10.0.{WCG_MIN_BUILD} and up. " - "\nAllows recording UWP apps, hardware accelerated and fullscreen exclusive windows. " - "\nCaps at around 60 FPS and adds a yellow border around the recorded window. " - "\nDoes not support automatically recovering closed Windows, manual cropping only, " - "\nand you have to reselect the window everytime you open AutoSplit. " - "\nSee https://github.com/pywinrt/python-winsdk/issues/5 " - "\nfor more details about those restrictions." + "\nAllows recording UWP apps, Hardware Accelerated and Exclusive Fullscreen windows. " + "\nCaps at around 60 FPS. " ), ), CaptureMethod.DESKTOP_DUPLICATION: CaptureMethodInfo( @@ -73,7 +69,7 @@ def __hash__(self): short_description="very slow, can affect rendering pipeline", description=( "\nUses BitBlt behind the scene, but passes a special flag " - "\nto PrintWindow to force rendering the entire desktop window. " + "\nto PrintWindow to force rendering the entire desktop. " "\nAbout 10-15x slower than BitBlt based on original window size " "\nand can mess up some applications' rendering pipelines. " ), diff --git a/src/capture_windows.py b/src/capture_windows.py index c30dbc5a..35ac12f8 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -144,7 +144,10 @@ def capture_region(autosplit: AutoSplit) -> tuple[Optional[cv2.ndarray], bool]: capture_method = autosplit.settings_dict["capture_method"] if capture_method == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: - return __windows_graphics_capture(autosplit.windows_graphics_capture, selection) + image, is_old_image = __windows_graphics_capture(autosplit.windows_graphics_capture, selection) + return (None, False) \ + if is_old_image and not win32gui.IsWindow(hwnd) \ + else (image, is_old_image) if capture_method == CaptureMethod.DESKTOP_DUPLICATION: return __d3d_capture(hwnd, selection), False diff --git a/src/menu_bar.py b/src/menu_bar.py index 4f61f0d3..36b07627 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -9,12 +9,14 @@ from requests.exceptions import RequestException from simplejson.errors import JSONDecodeError from win32 import win32gui +from winsdk.windows.graphics.capture.interop import create_for_window import error_messages import user_profile from capture_method import CAPTURE_METHODS, CaptureMethod, get_capture_method_by_index, get_capture_method_index from gen import about, design, resources_rc, settings as settings_ui, update_checker # noqa: F401 from hotkeys import set_hotkey +from screen_region import create_windows_graphics_capture if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -115,12 +117,14 @@ def __set_value(self, key: str, value: Any): def __capture_method_changed(self): selected_capture_method = get_capture_method_by_index(self.capture_method_combobox.currentIndex()) - if selected_capture_method != CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: - self.autosplit.windows_graphics_capture = None - # Recover window from name - hwnd = win32gui.FindWindow(None, self.autosplit.settings_dict["captured_window_title"]) - if hwnd: - self.autosplit.hwnd = hwnd + self.autosplit.windows_graphics_capture = None + # Recover window from name + hwnd = win32gui.FindWindow(None, self.autosplit.settings_dict["captured_window_title"]) + # Don't fallback to desktop + if hwnd: + self.autosplit.hwnd = hwnd + if self.autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + self.autosplit.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) return selected_capture_method def __init__(self, autosplit: AutoSplit): diff --git a/src/screen_region.py b/src/screen_region.py index daafdcc5..e041e2bb 100644 --- a/src/screen_region.py +++ b/src/screen_region.py @@ -1,5 +1,6 @@ from __future__ import annotations +import asyncio import ctypes import ctypes.wintypes import os @@ -18,6 +19,7 @@ from winsdk.windows.graphics import SizeInt32 from winsdk.windows.graphics.capture import (Direct3D11CaptureFramePool, GraphicsCaptureItem, GraphicsCapturePicker, GraphicsCaptureSession) +from winsdk.windows.graphics.capture.interop import create_for_window from winsdk.windows.graphics.directx import DirectXPixelFormat from winsdk.windows.media.capture import MediaCapture @@ -72,9 +74,11 @@ def select_region(autosplit: AutoSplit): if not hwnd or not window_text: error_messages.region() return - if autosplit.settings_dict["capture_method"] != CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: - autosplit.hwnd = hwnd - autosplit.settings_dict["captured_window_title"] = window_text + + autosplit.hwnd = hwnd + autosplit.settings_dict["captured_window_title"] = window_text + if autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + autosplit.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) offset_x, offset_y, *_ = win32gui.GetWindowRect(hwnd) __set_region_values(autosplit, @@ -84,10 +88,6 @@ def select_region(autosplit: AutoSplit): height=height) -media_capture = MediaCapture() -media_capture.initialize_async() - - @dataclass class WindowsGraphicsCapture: size: SizeInt32 @@ -97,7 +97,39 @@ class WindowsGraphicsCapture: last_captured_frame: Optional[cv2.ndarray] -def select_graphics_item(autosplit: AutoSplit): +def create_windows_graphics_capture(item: GraphicsCaptureItem): + # Note: Must create in the same thread (can't use a global) otherwise when ran from LiveSplit it will raise: + # OSError: The application called an interface that was marshalled for a different thread + media_capture = MediaCapture() + + async def coroutine(): + async_action = media_capture.initialize_async() + if async_action: + await async_action + asyncio.run(coroutine()) + + if not media_capture.media_capture_settings: + raise OSError("Unable to initialize a Direct3D Device.") + frame_pool = Direct3D11CaptureFramePool.create_free_threaded( + media_capture.media_capture_settings.direct3_d11_device, + DirectXPixelFormat.B8_G8_R8_A8_UINT_NORMALIZED, + 1, + item.size) + if not frame_pool: + raise OSError("Unable to create a frame pool for a capture session.") + session = frame_pool.create_capture_session(item) + if not session: + raise OSError("Unable to create a capture session.") + session.is_cursor_capture_enabled = False + # TODO: Consider session.is_border_required = False + session.start_capture() + return WindowsGraphicsCapture(item.size, frame_pool, session, None) + + +def __select_graphics_item(autosplit: AutoSplit): # pyright: ignore # For later as a different picker option + """ + Uses the built-in GraphicsCapturePicker to select the Window + """ def callback(async_operation: IAsyncOperation[GraphicsCaptureItem], async_status: AsyncStatus): try: if async_status != AsyncStatus.COMPLETED: @@ -111,22 +143,7 @@ def callback(async_operation: IAsyncOperation[GraphicsCaptureItem], async_status if not item: return autosplit.settings_dict["captured_window_title"] = item.display_name - if not media_capture.media_capture_settings: - raise OSError("Unable to initialize a Direct3D Device.") - frame_pool = Direct3D11CaptureFramePool.create_free_threaded( - media_capture.media_capture_settings.direct3_d11_device, - DirectXPixelFormat.B8_G8_R8_A8_UINT_NORMALIZED, - 1, - item.size) - if not frame_pool: - raise OSError("Unable to create a frame pool for a capture session.") - session = frame_pool.create_capture_session(item) - if not session: - raise OSError("Unable to create a capture session.") - session.is_cursor_capture_enabled = False - # TODO: Consider GraphicsCaptureSession.IsBorderRequired = False - session.start_capture() - autosplit.windows_graphics_capture = WindowsGraphicsCapture(item.size, frame_pool, session, None) + autosplit.windows_graphics_capture = create_windows_graphics_capture(item) picker = GraphicsCapturePicker() initialize_with_window(picker, autosplit.effectiveWinId().__int__()) @@ -137,9 +154,6 @@ def callback(async_operation: IAsyncOperation[GraphicsCaptureItem], async_status def select_window(autosplit: AutoSplit): - if autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: - select_graphics_item(autosplit) - return # Create a screen selector widget selector = SelectWindowWidget() @@ -158,8 +172,11 @@ def select_window(autosplit: AutoSplit): if not hwnd or not window_text: error_messages.region() return + autosplit.hwnd = hwnd autosplit.settings_dict["captured_window_title"] = window_text + if autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + autosplit.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) # Getting window bounds # On Windows there is a shadow around the windows that we need to account for. @@ -263,13 +280,15 @@ def __set_region_values(autosplit: AutoSplit, left: int, top: int, width: int, h autosplit.height_spinbox.setValue(height) -def __test_alignment(capture: cv2.ndarray, template: cv2.ndarray): - # Obtain the best matching point for the template within the - # capture. This assumes that the template is actually smaller - # than the dimensions of the capture. Since we are using SQDIFF - # the best match will be the min_val which is located at min_loc. - # The best match found in the image, set everything to 0 by default - # so that way the first match will overwrite these values +def __test_alignment(capture: cv2.ndarray, template: cv2.ndarray): # pylint: disable=too-many-locals + """ + Obtain the best matching point for the template within the + capture. This assumes that the template is actually smaller + than the dimensions of the capture. Since we are using SQDIFF + the best match will be the min_val which is located at min_loc. + The best match found in the image, set everything to 0 by default + so that way the first match will overwrite these values + """ best_match = 0.0 best_height = 0 best_width = 0 @@ -354,17 +373,22 @@ def keyPressEvent(self, a0: QtGui.QKeyEvent): self.close() -# Widget to select a window and obtain its bounds class SelectWindowWidget(BaseSelectWidget): + """ + Widget to select a window and obtain its bounds + """ + def mouseReleaseEvent(self, a0: QtGui.QMouseEvent): self._x = int(a0.position().x()) + self.geometry().x() self._y = int(a0.position().y()) + self.geometry().y() self.close() -# Widget for dragging screen region -# https://github.com/harupy/snipping-tool class SelectRegionWidget(BaseSelectWidget): + """ + Widget for dragging screen region + https://github.com/harupy/snipping-tool + """ _right: int = 0 _bottom: int = 0 __begin = QtCore.QPoint() diff --git a/src/user_profile.py b/src/user_profile.py index f6ea27e7..9b53ea10 100644 --- a/src/user_profile.py +++ b/src/user_profile.py @@ -8,12 +8,14 @@ import toml from PyQt6 import QtCore, QtWidgets from win32 import win32gui +from winsdk.windows.graphics.capture.interop import create_for_window import error_messages from capture_method import get_capture_method_by_index from capture_windows import CaptureMethod, Region from gen import design from hotkeys import set_hotkey +from screen_region import create_windows_graphics_capture if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -135,14 +137,13 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str if autosplit.settings_dict[hotkey]: set_hotkey(autosplit, "split", cast(str, autosplit.settings_dict[hotkey])) - if ( - autosplit.settings_dict["captured_window_title"] - # We can't recover by name (yet) with WindowsGraphicsCapture - and autosplit.settings_dict["capture_method"] != CaptureMethod.WINDOWS_GRAPHICS_CAPTURE - ): + if autosplit.settings_dict["captured_window_title"]: hwnd = win32gui.FindWindow(None, autosplit.settings_dict["captured_window_title"]) + # Don't fallback to desktop if hwnd: autosplit.hwnd = hwnd + if autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + autosplit.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) else: autosplit.live_image.setText("Reload settings after opening" + f'\n"{autosplit.settings_dict["captured_window_title"]}"' From 17afb4fadb1f78c9478579ea7c658eadd6eef4eb Mon Sep 17 00:00:00 2001 From: Avasam Date: Sun, 1 May 2022 17:19:25 -0400 Subject: [PATCH 048/137] Updated pyi linting --- typings/PyInstaller/utils/hooks/__init__.pyi | 17 +++++----- typings/d3dshot/d3dshot.pyi | 10 +++--- typings/d3dshot/display.pyi | 12 +++---- typings/d3dshot/dll/dxgi.pyi | 4 +-- typings/keyboard/__init__.pyi | 20 ++++++------ typings/keyboard/_keyboard_event.pyi | 33 +++++++++++--------- typings/pyautogui/__init__.pyi | 4 +-- 7 files changed, 52 insertions(+), 48 deletions(-) diff --git a/typings/PyInstaller/utils/hooks/__init__.pyi b/typings/PyInstaller/utils/hooks/__init__.pyi index 66f36bd4..c89940ed 100644 --- a/typings/PyInstaller/utils/hooks/__init__.pyi +++ b/typings/PyInstaller/utils/hooks/__init__.pyi @@ -1,7 +1,8 @@ """ # noqa: Y021 This type stub file was generated by pyright. """ -from typing import Any, Callable, Literal, Optional, Union +from collections.abc import Callable +from typing import Any, Literal logger = ... PY_IGNORE_EXTENSIONS: set @@ -24,19 +25,19 @@ def exec_script_rc(script_filename, *args, env=...): ... -def eval_statement(statement) -> Union[Any, Literal[""]]: +def eval_statement(statement) -> Any | Literal[""]: ... -def eval_script(scriptfilename, *args, env=...) -> Union[Any, Literal[""]]: +def eval_script(scriptfilename, *args, env=...) -> Any | Literal[""]: ... -def get_pyextension_imports(modname) -> Union[Any, list]: +def get_pyextension_imports(modname) -> Any | list: ... -def get_homebrew_path(formula=...) -> Optional[str]: +def get_homebrew_path(formula=...) -> str | None: ... @@ -76,7 +77,7 @@ def get_package_paths(package) -> tuple[str, str]: ... -def collect_submodules(package: str, filter: Optional[Callable[[str], bool]] = ...) -> list[str]: +def collect_submodules(package: str, filter: Callable[[str], bool] | None = ...) -> list[str]: ... @@ -87,7 +88,7 @@ def is_module_or_submodule(name, mod_or_submod): PY_DYLIB_PATTERNS: str -def collect_dynamic_libs(package: str, destdir: Optional[str] = ...) -> list[tuple[str, str]]: +def collect_dynamic_libs(package: str, destdir: str | None = ...) -> list[tuple[str, str]]: ... @@ -104,7 +105,7 @@ def copy_metadata(package_name, recursive=...) -> list: ... -def get_installer(module) -> Optional[str]: +def get_installer(module) -> str | None: ... diff --git a/typings/d3dshot/d3dshot.pyi b/typings/d3dshot/d3dshot.pyi index 53d043ae..2223a070 100644 --- a/typings/d3dshot/d3dshot.pyi +++ b/typings/d3dshot/d3dshot.pyi @@ -2,14 +2,14 @@ This type stub file was generated by pyright. """ from collections import deque -from typing import Optional +from typing import Any import cv2 from d3dshot.capture_output import CaptureOutput from d3dshot.display import Display from numpy.typing import NDArray -# +Unknown = Any class Singleton(type): @@ -35,13 +35,13 @@ class D3DShot(metaclass=Singleton): capture_output: CaptureOutput frame_buffer_size: int frame_buffer: deque - previous_screenshot: Optional - region: Optional + previous_screenshot: Unknown | None + region: Unknown | None _pil_is_available: bool _numpy_is_available: bool _pytorch_is_available: bool _pytorch_gpu_is_available: bool - _capture_thread: Optional + _capture_thread: Unknown | None _is_capturing: bool @property diff --git a/typings/d3dshot/display.pyi b/typings/d3dshot/display.pyi index 4991efd0..56299537 100644 --- a/typings/d3dshot/display.pyi +++ b/typings/d3dshot/display.pyi @@ -4,9 +4,9 @@ This type stub file was generated by pyright. import ctypes -from typing import Literal, Optional +from typing import Any, Literal -# +Unknown = Any class Display: @@ -18,10 +18,10 @@ class Display: scale_factor: int is_primary: bool hmonitor: int - dxgi_output: Optional = ... - dxgi_adapter: Optional = ... - d3d_device: Optional = ... - d3d_device_context: Optional = ... + dxgi_output: Unknown | None = ... + dxgi_adapter: Unknown | None = ... + d3d_device: Unknown | None = ... + d3d_device_context: Unknown | None = ... dxgi_output_duplication: ctypes.pointer def __init__( diff --git a/typings/d3dshot/dll/dxgi.pyi b/typings/d3dshot/dll/dxgi.pyi index 2e5e1c38..274abda7 100644 --- a/typings/d3dshot/dll/dxgi.pyi +++ b/typings/d3dshot/dll/dxgi.pyi @@ -3,7 +3,7 @@ This type stub file was generated by pyright. """ import ctypes -from typing import Any, Union +from typing import Any import comtypes @@ -105,7 +105,7 @@ def discover_dxgi_outputs(dxgi_adapter) -> list: ... -def describe_dxgi_output(dxgi_output) -> dict[str, Union[Any, dict[str, Any], tuple[Any, Any], int, bool]]: +def describe_dxgi_output(dxgi_output) -> dict[str, Any | dict[str, Any] | tuple[Any, Any] | int | bool]: ... diff --git a/typings/keyboard/__init__.pyi b/typings/keyboard/__init__.pyi index 1b433450..3b3d7e72 100644 --- a/typings/keyboard/__init__.pyi +++ b/typings/keyboard/__init__.pyi @@ -7,7 +7,7 @@ from __future__ import print_function as _print_function import queue as _queue from collections.abc import Callable from threading import Lock as _Lock -from typing import Any, Optional, Union +from typing import Any from keyboard._canonical_names import all_modifiers, normalize_name, sided_modifiers from keyboard._generic import GenericListener as _GenericListener @@ -108,19 +108,19 @@ class _KeyboardListener(_GenericListener): _listener: _KeyboardListener -def key_to_scan_codes(key: Union[int, str, list[Union[int, str]]], error_if_missing: bool = ...) -> list[int]: +def key_to_scan_codes(key: int | str | list[int | str], error_if_missing: bool = ...) -> list[int]: ... -def parse_hotkey(hotkey) -> tuple[Union[ - tuple[Union[tuple[int], int, tuple[()], tuple[int, ...]]], - tuple[tuple[Union[tuple[int], int, tuple[()], tuple[int, ...]], ...]], - tuple[int, ...] -]]: +def parse_hotkey(hotkey) -> tuple[ + tuple[tuple[int] | int | tuple[()] | tuple[int, ...]] + | tuple[tuple[tuple[int] | int | tuple[()] | tuple[int, ...], ...]] + | tuple[int, ...] +]: ... -def send(hotkey: Union[str, int], do_press: bool = ..., do_release: bool = ...) -> None: +def send(hotkey: str | int, do_press: bool = ..., do_release: bool = ...) -> None: ... @@ -159,7 +159,7 @@ def on_release(callback: Callback, suppress=...) -> Callable[[], None]: def hook_key( - key: Union[int, str, list[Union[int, str]]], + key: int | str | list[int | str], callback: Callback, suppress: bool = ... ) -> Callable[[], None]: @@ -284,7 +284,7 @@ def get_typed_strings(events, allow_backspace=...): ... -_recording: Optional[tuple[_queue.Queue, Callable[[], None]]] +_recording: tuple[_queue.Queue, Callable[[], None]] | None def start_recording(recorded_events_queue=...) -> tuple[_queue.Queue, Callable[[], None]]: diff --git a/typings/keyboard/_keyboard_event.pyi b/typings/keyboard/_keyboard_event.pyi index 1f31611d..b5725f33 100644 --- a/typings/keyboard/_keyboard_event.pyi +++ b/typings/keyboard/_keyboard_event.pyi @@ -4,30 +4,33 @@ https://github.com/boppreh/keyboard/issues/505 """ from __future__ import annotations -from typing import Literal, Optional +from typing import Any, Literal + +Unknown = Any + KEY_DOWN: Literal["down"] KEY_UP: Literal["up"] class KeyboardEvent: - event_type: Optional[Literal['down', 'up']] = ... - scan_code: Optional[int] = ... - name: Optional[str] = ... - time: Optional[float] = ... - device: Optional = ... - modifiers: Optional[tuple] = ... - is_keypad: Optional[bool] = ... + event_type: None | Literal['down', 'up'] = ... + scan_code: None | int = ... + name: None | str = ... + time: None | float = ... + device: Unknown | None = ... + modifiers: None | tuple = ... + is_keypad: None | bool = ... def __init__( self, - event_type: Optional[Literal['down', 'up']], - scan_code: Optional[int], - name: Optional[str] = ..., - time: Optional[float] = ..., - device: Optional = ..., - modifiers: Optional[tuple] = ..., - is_keypad: Optional[bool] = ...) -> None: + event_type: None | Literal['down', 'up'], + scan_code: None | int, + name: None | str = ..., + time: None | float = ..., + device: Unknown | None = ..., + modifiers: None | tuple = ..., + is_keypad: None | bool = ...) -> None: ... def to_json(self, ensure_ascii: bool = ...) -> str: diff --git a/typings/pyautogui/__init__.pyi b/typings/pyautogui/__init__.pyi index 9f96fb2b..41f99455 100644 --- a/typings/pyautogui/__init__.pyi +++ b/typings/pyautogui/__init__.pyi @@ -9,7 +9,7 @@ import sys from collections.abc import Callable, Sequence from contextlib import contextmanager from datetime import datetime -from typing import Literal, Union +from typing import Literal __version__: str @@ -199,7 +199,7 @@ def typewrite(message, interval=..., logScreenshot=..., _pause=...) -> None: write = ... -def hotkey(*args: str, **kwargs: Union[int, bool, None]) -> None: +def hotkey(*args: str, **kwargs: int | bool | None) -> None: ... From 063595fea1cf80db0ffa6a367dafcfad1722984e Mon Sep 17 00:00:00 2001 From: Avasam Date: Sun, 1 May 2022 17:34:26 -0400 Subject: [PATCH 049/137] Include backend in camera name --- src/capture_method.py | 8 +++++--- src/menu_bar.py | 2 +- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/src/capture_method.py b/src/capture_method.py index e78ffc6f..f15ef20d 100644 --- a/src/capture_method.py +++ b/src/capture_method.py @@ -119,6 +119,7 @@ class CameraInfo(): id: int name: str occupied: bool + backend: str def get_all_video_capture_devices(): @@ -127,15 +128,16 @@ def get_all_video_capture_devices(): while index < 8: video_capture = cv2.VideoCapture(index) # pyright: ignore video_capture.setExceptionMode(True) + backend = None try: # https://docs.opencv.org/3.4/d4/d15/group__videoio__flags__base.html#ga023786be1ee68a9105bf2e48c700294d - print(video_capture.getBackendName()) # pyright: ignore + backend: str = video_capture.getBackendName() video_capture.grab() except cv2.error as error: # pyright: ignore if error.code == cv2.Error.STS_ERROR: - video_captures.append(CameraInfo(index, f"Camera {index}", False)) + video_captures.append(CameraInfo(index, f"Camera {index}", False, backend)) else: - video_captures.append(CameraInfo(index, f"Camera {index}", True)) + video_captures.append(CameraInfo(index, f"Camera {index}", True, backend)) video_capture.release() index += 1 diff --git a/src/menu_bar.py b/src/menu_bar.py index 0468ac1c..dae71a25 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -181,7 +181,7 @@ def __set_all_capture_devices_async(self): for i in range(self.capture_device_combobox.count()): self.capture_device_combobox.removeItem(i) self.capture_device_combobox.addItems([ - f"* {device.name}{'' if device.occupied else ' (occupied)'}" + f"* {device.name} [{device.backend}]{'' if device.occupied else ' (occupied)'}" for device in self.__video_capture_devices]) self.capture_device_combobox.setEnabled(True) self.capture_device_combobox.setCurrentIndex( From 53004fda76e3806d85157fd723ae95daa123fc23 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sun, 1 May 2022 16:29:14 -0400 Subject: [PATCH 050/137] Restored all functionalities for CaptureMethod.WINDOWS_GRAPHICS_CAPTURE --- pyproject.toml | 2 + scripts/install.bat | 4 +- scripts/requirements.txt | 10 ++-- src/AutoSplit.py | 12 ++--- src/capture_method.py | 16 +++---- src/capture_windows.py | 5 +- src/menu_bar.py | 16 ++++--- src/screen_region.py | 98 +++++++++++++++++++++++++--------------- src/user_profile.py | 11 +++-- 9 files changed, 102 insertions(+), 72 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index c779b207..eb9de738 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -118,6 +118,8 @@ disable = [ "unused-import", # Similar lines in 2 files, doesn't really work "R0801", + # False positives with PyQt .connect + "no-value-for-parameter", ] [tool.pylint.TYPECHECK] diff --git a/scripts/install.bat b/scripts/install.bat index 1b61fb02..6af8691b 100644 --- a/scripts/install.bat +++ b/scripts/install.bat @@ -1,4 +1,4 @@ -py -3.9 -m pip install wheel --upgrade -py -3.9 -m pip install -r "%~p0requirements.txt" --upgrade +py -m pip install wheel --upgrade +py -m pip install -r "%~p0requirements.txt" --upgrade npm install -g pyright@latest CALL "%~p0compile_resources.bat" diff --git a/scripts/requirements.txt b/scripts/requirements.txt index 0baba779..5bd3833f 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -23,7 +23,7 @@ pywin32 requests certifi toml -winsdk +winsdk>=v1.0.0b4 git+https://github.com/ranchen421/D3DShot.git#egg=D3DShot # https://github.com/SerpentAI/D3DShot/issues/44 # # Linting, formatters and Types @@ -39,9 +39,9 @@ simplejson types-simplejson>=3.17.2 types-requests # -# Not compatible with python 3.10 yet, used to design the UI. Can be downloaded externally -# Uncomment this if you want to run `designer.bat` to quickly open the bundled PyQt Designer -# PyQt6-tools +# You can comment this out if you don't want to run `designer.bat` to quickly open the bundled PyQt Designer. +# Can also be downloaded externally as a non-python package +qt6-applications # -# Comment this out if you don't want to build AutoSplit.exe: +# You can comment this out if you don't want to build AutoSplit.exe: PyInstaller diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 497740e6..5d008a9c 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -23,6 +23,7 @@ from PyQt6.QtTest import QTest from PyQt6.QtWidgets import QApplication, QFileDialog, QMainWindow, QMessageBox, QWidget from win32 import win32gui +from winsdk.windows.graphics.capture.interop import create_for_window import error_messages import user_profile @@ -34,7 +35,8 @@ from hotkeys import after_setting_hotkey, send_command from menu_bar import (VERSION, check_for_updates, get_default_settings_from_ui, open_about, open_settings, open_update_checker, view_help) -from screen_region import WindowsGraphicsCapture, align_region, select_region, select_window, validate_before_parsing +from screen_region import (WindowsGraphicsCapture, align_region, create_windows_graphics_capture, select_region, + select_window, validate_before_parsing) from split_parser import BELOW_FLAG, DUMMY_FLAG, PAUSE_FLAG, parse_and_validate_images from user_profile import DEFAULT_PROFILE, FROZEN @@ -732,17 +734,15 @@ def __get_capture_for_comparison(self): capture, is_old_image = capture_region(self) # This most likely means we lost capture (ie the captured window was closed, crashed, etc.) - # We can't recover by name (yet) with WindowsGraphicsCapture - if ( - (capture is None or not capture.size) - and self.settings_dict["capture_method"] != CaptureMethod.WINDOWS_GRAPHICS_CAPTURE - ): + if capture is None or not capture.size: # Try to recover by using the window name self.live_image.setText("Trying to recover window...") hwnd = win32gui.FindWindow(None, self.settings_dict["captured_window_title"]) # Don't fallback to desktop if hwnd: self.hwnd = hwnd + if self.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + self.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) capture, _ = capture_region(self) return None if capture is None or not capture.size else cv2.resize( capture, COMPARISON_RESIZE, interpolation=cv2.INTER_NEAREST), is_old_image diff --git a/src/capture_method.py b/src/capture_method.py index d173c67f..460bce1a 100644 --- a/src/capture_method.py +++ b/src/capture_method.py @@ -40,9 +40,9 @@ def __hash__(self): short_description="fastest, least compatible", description=( "\nA good default fast option. Also allows recording background windows " - "\n(as long as they still actually render when in the background), " - "\nbut it cannot properly record OpenGL or Hardware Accelerated Windows. " - "\nThe smaller the window, the more efficient it is. " + "\n(as long as they still actually render when in the background), but it " + "\ncannot properly record OpenGL, Hardware Accelerated or Exclusive Fullscreen windows. " + "\nThe smaller the region, the more efficient it is. " ), ), CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: CaptureMethodInfo( @@ -50,12 +50,8 @@ def __hash__(self): short_description="fast, most compatible but less features", description=( f"\nOnly available in Windows 10.0.{WCG_MIN_BUILD} and up. " - "\nAllows recording UWP apps, hardware accelerated and fullscreen exclusive windows. " - "\nCaps at around 60 FPS and adds a yellow border around the recorded window. " - "\nDoes not support automatically recovering closed Windows, manual cropping only, " - "\nand you have to reselect the window everytime you open AutoSplit. " - "\nSee https://github.com/pywinrt/python-winsdk/issues/5 " - "\nfor more details about those restrictions." + "\nAllows recording UWP apps, Hardware Accelerated and Exclusive Fullscreen windows. " + "\nCaps at around 60 FPS. " ), ), CaptureMethod.DESKTOP_DUPLICATION: CaptureMethodInfo( @@ -73,7 +69,7 @@ def __hash__(self): short_description="very slow, can affect rendering pipeline", description=( "\nUses BitBlt behind the scene, but passes a special flag " - "\nto PrintWindow to force rendering the entire desktop window. " + "\nto PrintWindow to force rendering the entire desktop. " "\nAbout 10-15x slower than BitBlt based on original window size " "\nand can mess up some applications' rendering pipelines. " ), diff --git a/src/capture_windows.py b/src/capture_windows.py index c30dbc5a..35ac12f8 100644 --- a/src/capture_windows.py +++ b/src/capture_windows.py @@ -144,7 +144,10 @@ def capture_region(autosplit: AutoSplit) -> tuple[Optional[cv2.ndarray], bool]: capture_method = autosplit.settings_dict["capture_method"] if capture_method == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: - return __windows_graphics_capture(autosplit.windows_graphics_capture, selection) + image, is_old_image = __windows_graphics_capture(autosplit.windows_graphics_capture, selection) + return (None, False) \ + if is_old_image and not win32gui.IsWindow(hwnd) \ + else (image, is_old_image) if capture_method == CaptureMethod.DESKTOP_DUPLICATION: return __d3d_capture(hwnd, selection), False diff --git a/src/menu_bar.py b/src/menu_bar.py index 4f61f0d3..99501e38 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -9,12 +9,14 @@ from requests.exceptions import RequestException from simplejson.errors import JSONDecodeError from win32 import win32gui +from winsdk.windows.graphics.capture.interop import create_for_window import error_messages import user_profile from capture_method import CAPTURE_METHODS, CaptureMethod, get_capture_method_by_index, get_capture_method_index from gen import about, design, resources_rc, settings as settings_ui, update_checker # noqa: F401 from hotkeys import set_hotkey +from screen_region import create_windows_graphics_capture if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -115,12 +117,14 @@ def __set_value(self, key: str, value: Any): def __capture_method_changed(self): selected_capture_method = get_capture_method_by_index(self.capture_method_combobox.currentIndex()) - if selected_capture_method != CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: - self.autosplit.windows_graphics_capture = None - # Recover window from name - hwnd = win32gui.FindWindow(None, self.autosplit.settings_dict["captured_window_title"]) - if hwnd: - self.autosplit.hwnd = hwnd + self.autosplit.windows_graphics_capture = None + # Recover window from name + hwnd = win32gui.FindWindow(None, self.autosplit.settings_dict["captured_window_title"]) + # Don't fallback to desktop + if hwnd: + self.autosplit.hwnd = hwnd + if selected_capture_method == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + self.autosplit.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) return selected_capture_method def __init__(self, autosplit: AutoSplit): diff --git a/src/screen_region.py b/src/screen_region.py index daafdcc5..e041e2bb 100644 --- a/src/screen_region.py +++ b/src/screen_region.py @@ -1,5 +1,6 @@ from __future__ import annotations +import asyncio import ctypes import ctypes.wintypes import os @@ -18,6 +19,7 @@ from winsdk.windows.graphics import SizeInt32 from winsdk.windows.graphics.capture import (Direct3D11CaptureFramePool, GraphicsCaptureItem, GraphicsCapturePicker, GraphicsCaptureSession) +from winsdk.windows.graphics.capture.interop import create_for_window from winsdk.windows.graphics.directx import DirectXPixelFormat from winsdk.windows.media.capture import MediaCapture @@ -72,9 +74,11 @@ def select_region(autosplit: AutoSplit): if not hwnd or not window_text: error_messages.region() return - if autosplit.settings_dict["capture_method"] != CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: - autosplit.hwnd = hwnd - autosplit.settings_dict["captured_window_title"] = window_text + + autosplit.hwnd = hwnd + autosplit.settings_dict["captured_window_title"] = window_text + if autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + autosplit.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) offset_x, offset_y, *_ = win32gui.GetWindowRect(hwnd) __set_region_values(autosplit, @@ -84,10 +88,6 @@ def select_region(autosplit: AutoSplit): height=height) -media_capture = MediaCapture() -media_capture.initialize_async() - - @dataclass class WindowsGraphicsCapture: size: SizeInt32 @@ -97,7 +97,39 @@ class WindowsGraphicsCapture: last_captured_frame: Optional[cv2.ndarray] -def select_graphics_item(autosplit: AutoSplit): +def create_windows_graphics_capture(item: GraphicsCaptureItem): + # Note: Must create in the same thread (can't use a global) otherwise when ran from LiveSplit it will raise: + # OSError: The application called an interface that was marshalled for a different thread + media_capture = MediaCapture() + + async def coroutine(): + async_action = media_capture.initialize_async() + if async_action: + await async_action + asyncio.run(coroutine()) + + if not media_capture.media_capture_settings: + raise OSError("Unable to initialize a Direct3D Device.") + frame_pool = Direct3D11CaptureFramePool.create_free_threaded( + media_capture.media_capture_settings.direct3_d11_device, + DirectXPixelFormat.B8_G8_R8_A8_UINT_NORMALIZED, + 1, + item.size) + if not frame_pool: + raise OSError("Unable to create a frame pool for a capture session.") + session = frame_pool.create_capture_session(item) + if not session: + raise OSError("Unable to create a capture session.") + session.is_cursor_capture_enabled = False + # TODO: Consider session.is_border_required = False + session.start_capture() + return WindowsGraphicsCapture(item.size, frame_pool, session, None) + + +def __select_graphics_item(autosplit: AutoSplit): # pyright: ignore # For later as a different picker option + """ + Uses the built-in GraphicsCapturePicker to select the Window + """ def callback(async_operation: IAsyncOperation[GraphicsCaptureItem], async_status: AsyncStatus): try: if async_status != AsyncStatus.COMPLETED: @@ -111,22 +143,7 @@ def callback(async_operation: IAsyncOperation[GraphicsCaptureItem], async_status if not item: return autosplit.settings_dict["captured_window_title"] = item.display_name - if not media_capture.media_capture_settings: - raise OSError("Unable to initialize a Direct3D Device.") - frame_pool = Direct3D11CaptureFramePool.create_free_threaded( - media_capture.media_capture_settings.direct3_d11_device, - DirectXPixelFormat.B8_G8_R8_A8_UINT_NORMALIZED, - 1, - item.size) - if not frame_pool: - raise OSError("Unable to create a frame pool for a capture session.") - session = frame_pool.create_capture_session(item) - if not session: - raise OSError("Unable to create a capture session.") - session.is_cursor_capture_enabled = False - # TODO: Consider GraphicsCaptureSession.IsBorderRequired = False - session.start_capture() - autosplit.windows_graphics_capture = WindowsGraphicsCapture(item.size, frame_pool, session, None) + autosplit.windows_graphics_capture = create_windows_graphics_capture(item) picker = GraphicsCapturePicker() initialize_with_window(picker, autosplit.effectiveWinId().__int__()) @@ -137,9 +154,6 @@ def callback(async_operation: IAsyncOperation[GraphicsCaptureItem], async_status def select_window(autosplit: AutoSplit): - if autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: - select_graphics_item(autosplit) - return # Create a screen selector widget selector = SelectWindowWidget() @@ -158,8 +172,11 @@ def select_window(autosplit: AutoSplit): if not hwnd or not window_text: error_messages.region() return + autosplit.hwnd = hwnd autosplit.settings_dict["captured_window_title"] = window_text + if autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + autosplit.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) # Getting window bounds # On Windows there is a shadow around the windows that we need to account for. @@ -263,13 +280,15 @@ def __set_region_values(autosplit: AutoSplit, left: int, top: int, width: int, h autosplit.height_spinbox.setValue(height) -def __test_alignment(capture: cv2.ndarray, template: cv2.ndarray): - # Obtain the best matching point for the template within the - # capture. This assumes that the template is actually smaller - # than the dimensions of the capture. Since we are using SQDIFF - # the best match will be the min_val which is located at min_loc. - # The best match found in the image, set everything to 0 by default - # so that way the first match will overwrite these values +def __test_alignment(capture: cv2.ndarray, template: cv2.ndarray): # pylint: disable=too-many-locals + """ + Obtain the best matching point for the template within the + capture. This assumes that the template is actually smaller + than the dimensions of the capture. Since we are using SQDIFF + the best match will be the min_val which is located at min_loc. + The best match found in the image, set everything to 0 by default + so that way the first match will overwrite these values + """ best_match = 0.0 best_height = 0 best_width = 0 @@ -354,17 +373,22 @@ def keyPressEvent(self, a0: QtGui.QKeyEvent): self.close() -# Widget to select a window and obtain its bounds class SelectWindowWidget(BaseSelectWidget): + """ + Widget to select a window and obtain its bounds + """ + def mouseReleaseEvent(self, a0: QtGui.QMouseEvent): self._x = int(a0.position().x()) + self.geometry().x() self._y = int(a0.position().y()) + self.geometry().y() self.close() -# Widget for dragging screen region -# https://github.com/harupy/snipping-tool class SelectRegionWidget(BaseSelectWidget): + """ + Widget for dragging screen region + https://github.com/harupy/snipping-tool + """ _right: int = 0 _bottom: int = 0 __begin = QtCore.QPoint() diff --git a/src/user_profile.py b/src/user_profile.py index f6ea27e7..9b53ea10 100644 --- a/src/user_profile.py +++ b/src/user_profile.py @@ -8,12 +8,14 @@ import toml from PyQt6 import QtCore, QtWidgets from win32 import win32gui +from winsdk.windows.graphics.capture.interop import create_for_window import error_messages from capture_method import get_capture_method_by_index from capture_windows import CaptureMethod, Region from gen import design from hotkeys import set_hotkey +from screen_region import create_windows_graphics_capture if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -135,14 +137,13 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str if autosplit.settings_dict[hotkey]: set_hotkey(autosplit, "split", cast(str, autosplit.settings_dict[hotkey])) - if ( - autosplit.settings_dict["captured_window_title"] - # We can't recover by name (yet) with WindowsGraphicsCapture - and autosplit.settings_dict["capture_method"] != CaptureMethod.WINDOWS_GRAPHICS_CAPTURE - ): + if autosplit.settings_dict["captured_window_title"]: hwnd = win32gui.FindWindow(None, autosplit.settings_dict["captured_window_title"]) + # Don't fallback to desktop if hwnd: autosplit.hwnd = hwnd + if autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + autosplit.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) else: autosplit.live_image.setText("Reload settings after opening" + f'\n"{autosplit.settings_dict["captured_window_title"]}"' From a8f89cbab1b856da3360e7a090f9a5896218790c Mon Sep 17 00:00:00 2001 From: Avasam Date: Sun, 1 May 2022 17:19:25 -0400 Subject: [PATCH 051/137] Updated pyi linting --- typings/PyInstaller/utils/hooks/__init__.pyi | 17 +++++----- typings/d3dshot/d3dshot.pyi | 10 +++--- typings/d3dshot/display.pyi | 12 +++---- typings/d3dshot/dll/dxgi.pyi | 4 +-- typings/keyboard/__init__.pyi | 20 ++++++------ typings/keyboard/_keyboard_event.pyi | 33 +++++++++++--------- typings/pyautogui/__init__.pyi | 4 +-- 7 files changed, 52 insertions(+), 48 deletions(-) diff --git a/typings/PyInstaller/utils/hooks/__init__.pyi b/typings/PyInstaller/utils/hooks/__init__.pyi index 66f36bd4..c89940ed 100644 --- a/typings/PyInstaller/utils/hooks/__init__.pyi +++ b/typings/PyInstaller/utils/hooks/__init__.pyi @@ -1,7 +1,8 @@ """ # noqa: Y021 This type stub file was generated by pyright. """ -from typing import Any, Callable, Literal, Optional, Union +from collections.abc import Callable +from typing import Any, Literal logger = ... PY_IGNORE_EXTENSIONS: set @@ -24,19 +25,19 @@ def exec_script_rc(script_filename, *args, env=...): ... -def eval_statement(statement) -> Union[Any, Literal[""]]: +def eval_statement(statement) -> Any | Literal[""]: ... -def eval_script(scriptfilename, *args, env=...) -> Union[Any, Literal[""]]: +def eval_script(scriptfilename, *args, env=...) -> Any | Literal[""]: ... -def get_pyextension_imports(modname) -> Union[Any, list]: +def get_pyextension_imports(modname) -> Any | list: ... -def get_homebrew_path(formula=...) -> Optional[str]: +def get_homebrew_path(formula=...) -> str | None: ... @@ -76,7 +77,7 @@ def get_package_paths(package) -> tuple[str, str]: ... -def collect_submodules(package: str, filter: Optional[Callable[[str], bool]] = ...) -> list[str]: +def collect_submodules(package: str, filter: Callable[[str], bool] | None = ...) -> list[str]: ... @@ -87,7 +88,7 @@ def is_module_or_submodule(name, mod_or_submod): PY_DYLIB_PATTERNS: str -def collect_dynamic_libs(package: str, destdir: Optional[str] = ...) -> list[tuple[str, str]]: +def collect_dynamic_libs(package: str, destdir: str | None = ...) -> list[tuple[str, str]]: ... @@ -104,7 +105,7 @@ def copy_metadata(package_name, recursive=...) -> list: ... -def get_installer(module) -> Optional[str]: +def get_installer(module) -> str | None: ... diff --git a/typings/d3dshot/d3dshot.pyi b/typings/d3dshot/d3dshot.pyi index 53d043ae..2223a070 100644 --- a/typings/d3dshot/d3dshot.pyi +++ b/typings/d3dshot/d3dshot.pyi @@ -2,14 +2,14 @@ This type stub file was generated by pyright. """ from collections import deque -from typing import Optional +from typing import Any import cv2 from d3dshot.capture_output import CaptureOutput from d3dshot.display import Display from numpy.typing import NDArray -# +Unknown = Any class Singleton(type): @@ -35,13 +35,13 @@ class D3DShot(metaclass=Singleton): capture_output: CaptureOutput frame_buffer_size: int frame_buffer: deque - previous_screenshot: Optional - region: Optional + previous_screenshot: Unknown | None + region: Unknown | None _pil_is_available: bool _numpy_is_available: bool _pytorch_is_available: bool _pytorch_gpu_is_available: bool - _capture_thread: Optional + _capture_thread: Unknown | None _is_capturing: bool @property diff --git a/typings/d3dshot/display.pyi b/typings/d3dshot/display.pyi index 4991efd0..56299537 100644 --- a/typings/d3dshot/display.pyi +++ b/typings/d3dshot/display.pyi @@ -4,9 +4,9 @@ This type stub file was generated by pyright. import ctypes -from typing import Literal, Optional +from typing import Any, Literal -# +Unknown = Any class Display: @@ -18,10 +18,10 @@ class Display: scale_factor: int is_primary: bool hmonitor: int - dxgi_output: Optional = ... - dxgi_adapter: Optional = ... - d3d_device: Optional = ... - d3d_device_context: Optional = ... + dxgi_output: Unknown | None = ... + dxgi_adapter: Unknown | None = ... + d3d_device: Unknown | None = ... + d3d_device_context: Unknown | None = ... dxgi_output_duplication: ctypes.pointer def __init__( diff --git a/typings/d3dshot/dll/dxgi.pyi b/typings/d3dshot/dll/dxgi.pyi index 2e5e1c38..274abda7 100644 --- a/typings/d3dshot/dll/dxgi.pyi +++ b/typings/d3dshot/dll/dxgi.pyi @@ -3,7 +3,7 @@ This type stub file was generated by pyright. """ import ctypes -from typing import Any, Union +from typing import Any import comtypes @@ -105,7 +105,7 @@ def discover_dxgi_outputs(dxgi_adapter) -> list: ... -def describe_dxgi_output(dxgi_output) -> dict[str, Union[Any, dict[str, Any], tuple[Any, Any], int, bool]]: +def describe_dxgi_output(dxgi_output) -> dict[str, Any | dict[str, Any] | tuple[Any, Any] | int | bool]: ... diff --git a/typings/keyboard/__init__.pyi b/typings/keyboard/__init__.pyi index 1b433450..3b3d7e72 100644 --- a/typings/keyboard/__init__.pyi +++ b/typings/keyboard/__init__.pyi @@ -7,7 +7,7 @@ from __future__ import print_function as _print_function import queue as _queue from collections.abc import Callable from threading import Lock as _Lock -from typing import Any, Optional, Union +from typing import Any from keyboard._canonical_names import all_modifiers, normalize_name, sided_modifiers from keyboard._generic import GenericListener as _GenericListener @@ -108,19 +108,19 @@ class _KeyboardListener(_GenericListener): _listener: _KeyboardListener -def key_to_scan_codes(key: Union[int, str, list[Union[int, str]]], error_if_missing: bool = ...) -> list[int]: +def key_to_scan_codes(key: int | str | list[int | str], error_if_missing: bool = ...) -> list[int]: ... -def parse_hotkey(hotkey) -> tuple[Union[ - tuple[Union[tuple[int], int, tuple[()], tuple[int, ...]]], - tuple[tuple[Union[tuple[int], int, tuple[()], tuple[int, ...]], ...]], - tuple[int, ...] -]]: +def parse_hotkey(hotkey) -> tuple[ + tuple[tuple[int] | int | tuple[()] | tuple[int, ...]] + | tuple[tuple[tuple[int] | int | tuple[()] | tuple[int, ...], ...]] + | tuple[int, ...] +]: ... -def send(hotkey: Union[str, int], do_press: bool = ..., do_release: bool = ...) -> None: +def send(hotkey: str | int, do_press: bool = ..., do_release: bool = ...) -> None: ... @@ -159,7 +159,7 @@ def on_release(callback: Callback, suppress=...) -> Callable[[], None]: def hook_key( - key: Union[int, str, list[Union[int, str]]], + key: int | str | list[int | str], callback: Callback, suppress: bool = ... ) -> Callable[[], None]: @@ -284,7 +284,7 @@ def get_typed_strings(events, allow_backspace=...): ... -_recording: Optional[tuple[_queue.Queue, Callable[[], None]]] +_recording: tuple[_queue.Queue, Callable[[], None]] | None def start_recording(recorded_events_queue=...) -> tuple[_queue.Queue, Callable[[], None]]: diff --git a/typings/keyboard/_keyboard_event.pyi b/typings/keyboard/_keyboard_event.pyi index 1f31611d..b5725f33 100644 --- a/typings/keyboard/_keyboard_event.pyi +++ b/typings/keyboard/_keyboard_event.pyi @@ -4,30 +4,33 @@ https://github.com/boppreh/keyboard/issues/505 """ from __future__ import annotations -from typing import Literal, Optional +from typing import Any, Literal + +Unknown = Any + KEY_DOWN: Literal["down"] KEY_UP: Literal["up"] class KeyboardEvent: - event_type: Optional[Literal['down', 'up']] = ... - scan_code: Optional[int] = ... - name: Optional[str] = ... - time: Optional[float] = ... - device: Optional = ... - modifiers: Optional[tuple] = ... - is_keypad: Optional[bool] = ... + event_type: None | Literal['down', 'up'] = ... + scan_code: None | int = ... + name: None | str = ... + time: None | float = ... + device: Unknown | None = ... + modifiers: None | tuple = ... + is_keypad: None | bool = ... def __init__( self, - event_type: Optional[Literal['down', 'up']], - scan_code: Optional[int], - name: Optional[str] = ..., - time: Optional[float] = ..., - device: Optional = ..., - modifiers: Optional[tuple] = ..., - is_keypad: Optional[bool] = ...) -> None: + event_type: None | Literal['down', 'up'], + scan_code: None | int, + name: None | str = ..., + time: None | float = ..., + device: Unknown | None = ..., + modifiers: None | tuple = ..., + is_keypad: None | bool = ...) -> None: ... def to_json(self, ensure_ascii: bool = ...) -> str: diff --git a/typings/pyautogui/__init__.pyi b/typings/pyautogui/__init__.pyi index 9f96fb2b..41f99455 100644 --- a/typings/pyautogui/__init__.pyi +++ b/typings/pyautogui/__init__.pyi @@ -9,7 +9,7 @@ import sys from collections.abc import Callable, Sequence from contextlib import contextmanager from datetime import datetime -from typing import Literal, Union +from typing import Literal __version__: str @@ -199,7 +199,7 @@ def typewrite(message, interval=..., logScreenshot=..., _pause=...) -> None: write = ... -def hotkey(*args: str, **kwargs: Union[int, bool, None]) -> None: +def hotkey(*args: str, **kwargs: int | bool | None) -> None: ... From 4cc5d7a2468fdcd052f693fb533a95601a298aa3 Mon Sep 17 00:00:00 2001 From: Avasam Date: Mon, 2 May 2022 20:41:59 -0400 Subject: [PATCH 052/137] Fixed an error when changing similarity while the comparison is not running --- src/AutoSplit.py | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 5d008a9c..c3cbb893 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -111,7 +111,7 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): start_image: Optional[AutoSplitImage] = None reset_image: Optional[AutoSplitImage] = None split_images: list[AutoSplitImage] = [] - split_image: AutoSplitImage + split_image: Optional[AutoSplitImage] = None def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-many-statements super().__init__(parent) @@ -527,7 +527,7 @@ def __auto_splitter(self): dummy_splits_array = [image_loop[0].check_flag(DUMMY_FLAG) for image_loop in self.split_images_and_loop_number] self.run_start_time = time() - # First while loop: stays in this loop until all of the split images have been split + # First loop: stays in this loop until all of the split images have been split while self.split_image_number < number_of_split_images: # Check if we are not waiting for the split delay to send the key press @@ -539,7 +539,11 @@ def __auto_splitter(self): self.__update_split_image() - # Second while loop: stays in this loop until similarity threshold is met + # Type checking + if not self.split_image: + return + + # Second loop: stays in this loop until similarity threshold is met if self.__similarity_threshold_loop(number_of_split_images, dummy_splits_array): return @@ -587,6 +591,10 @@ def __similarity_threshold_loop(self, number_of_split_images: int, dummy_splits_ Returns True if the loop was interrupted by a reset. """ + # Type checking + if not self.split_image: + return False + start = time() while True: capture, _ = self.__get_capture_for_comparison() From 68128c5d9f78f342bb6a3d60540e00385f2196ca Mon Sep 17 00:00:00 2001 From: Avasam Date: Tue, 3 May 2022 19:14:38 -0400 Subject: [PATCH 053/137] More constants for image comparison --- src/AutoSplitImage.py | 6 +++--- src/compare.py | 16 +++++++++------- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/src/AutoSplitImage.py b/src/AutoSplitImage.py index 6c3274e0..9c538152 100644 --- a/src/AutoSplitImage.py +++ b/src/AutoSplitImage.py @@ -18,6 +18,8 @@ COMPARISON_RESIZE_WIDTH = 320 COMPARISON_RESIZE_HEIGHT = 240 COMPARISON_RESIZE = (COMPARISON_RESIZE_WIDTH, COMPARISON_RESIZE_HEIGHT) +LOWER_BOUND = np.array([0, 0, 0, 1], dtype="uint8") +UPPER_BOUND = np.array([MAXBYTE, MAXBYTE, MAXBYTE, MAXBYTE], dtype="uint8") class ImageType(Enum): @@ -108,9 +110,7 @@ def __read_image_bytes(self, path: str): # If image has transparency, create a mask if self._has_transparency: # Create mask based on resized, nearest neighbor interpolated split image - lower = np.array([0, 0, 0, 1], dtype="uint8") - upper = np.array([MAXBYTE, MAXBYTE, MAXBYTE, MAXBYTE], dtype="uint8") - self.mask = cv2.inRange(image, lower, upper) + self.mask = cv2.inRange(image, LOWER_BOUND, UPPER_BOUND) # Add Alpha channel if missing elif image.shape[2] == 3: image = cv2.cvtColor(image, cv2.COLOR_BGR2BGRA) diff --git a/src/compare.py b/src/compare.py index b46720e7..95f09df8 100644 --- a/src/compare.py +++ b/src/compare.py @@ -1,5 +1,6 @@ from __future__ import annotations +from math import sqrt from typing import Optional import cv2 @@ -9,9 +10,10 @@ from win32con import MAXBYTE MAXRANGE = MAXBYTE + 1 -channels = [0, 1, 2] -histogram_size = [8, 8, 8] -ranges = [0, MAXRANGE, 0, MAXRANGE, 0, MAXRANGE] +CHANNELS = [0, 1, 2] +HISTOGRAM_SIZE = [8, 8, 8] +RANGES = [0, MAXRANGE, 0, MAXRANGE, 0, MAXRANGE] +MASK_SIZE_MULTIPLIER = 3 * MAXBYTE * MAXBYTE def compare_histograms(source: cv2.ndarray, capture: cv2.ndarray, mask: Optional[cv2.ndarray] = None): @@ -25,8 +27,8 @@ def compare_histograms(source: cv2.ndarray, capture: cv2.ndarray, mask: Optional @return: The similarity between the histograms as a number 0 to 1. """ - source_hist = cv2.calcHist([source], channels, mask, histogram_size, ranges) - capture_hist = cv2.calcHist([capture], channels, mask, histogram_size, ranges) + source_hist = cv2.calcHist([source], CHANNELS, mask, HISTOGRAM_SIZE, RANGES) + capture_hist = cv2.calcHist([capture], CHANNELS, mask, HISTOGRAM_SIZE, RANGES) cv2.normalize(source_hist, source_hist) cv2.normalize(capture_hist, capture_hist) @@ -47,9 +49,9 @@ def compare_l2_norm(source: cv2.ndarray, capture: cv2.ndarray, mask: Optional[cv error = cv2.norm(source, capture, cv2.NORM_L2, mask) # type: ignore # The L2 Error is summed across all pixels, so this normalizes - max_error = (source.size ** 0.5) * MAXBYTE \ + max_error = sqrt(source.size) * MAXBYTE \ if mask is None or not mask.size\ - else (3 * np.count_nonzero(mask) * MAXBYTE * MAXBYTE) ** 0.5 + else sqrt(np.count_nonzero(mask) * MASK_SIZE_MULTIPLIER) if not max_error: return 0.0 From d91ce2fab4778e6013a407d01191492946c8d1e6 Mon Sep 17 00:00:00 2001 From: Avasam Date: Wed, 4 May 2022 14:20:38 -0400 Subject: [PATCH 054/137] Parallel device scan and attempt at adding some names --- src/capture_method.py | 35 ++++++++++++++++++++++------------- src/menu_bar.py | 36 +++++++++++++++++++----------------- 2 files changed, 41 insertions(+), 30 deletions(-) diff --git a/src/capture_method.py b/src/capture_method.py index f15ef20d..09c7fcbf 100644 --- a/src/capture_method.py +++ b/src/capture_method.py @@ -1,9 +1,11 @@ +import asyncio from collections import OrderedDict from dataclasses import dataclass from enum import Enum, EnumMeta, unique from platform import version import cv2 +from PyQt6.QtMultimedia import QMediaDevices # https://docs.microsoft.com/en-us/uwp/api/windows.graphics.capture.graphicscapturepicker#applies-to WCG_MIN_BUILD = 17134 @@ -116,29 +118,36 @@ def get_method_by_index(self, index: int): @dataclass class CameraInfo(): - id: int + device_id: int name: str occupied: bool backend: str -def get_all_video_capture_devices(): - index = 0 - video_captures: list[CameraInfo] = [] - while index < 8: +async def get_all_video_capture_devices(): + named_video_inputs = [x.description() for x in QMediaDevices.videoInputs()] + + async def get_camera_info(index: int): video_capture = cv2.VideoCapture(index) # pyright: ignore video_capture.setExceptionMode(True) backend = None + device_name = named_video_inputs[index] if index < len(named_video_inputs) else f"Camera {index}" try: # https://docs.opencv.org/3.4/d4/d15/group__videoio__flags__base.html#ga023786be1ee68a9105bf2e48c700294d backend: str = video_capture.getBackendName() video_capture.grab() except cv2.error as error: # pyright: ignore - if error.code == cv2.Error.STS_ERROR: - video_captures.append(CameraInfo(index, f"Camera {index}", False, backend)) - else: - video_captures.append(CameraInfo(index, f"Camera {index}", True, backend)) - - video_capture.release() - index += 1 - return video_captures + if error.code != cv2.Error.STS_ERROR: + return None + finally: + video_capture.release() + return CameraInfo(index, device_name, True, backend) + # Enough to ensure we catch "OBS-Camera" (Virtualcam plugin) and "" + results: list[CameraInfo] = [ + camera_info for camera_info + in await asyncio.gather(*[ + get_camera_info(index) for index + in range(len(named_video_inputs) + 5) + ]) + if camera_info is not None] + return results diff --git a/src/menu_bar.py b/src/menu_bar.py index dae71a25..8fe2e37b 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -1,5 +1,6 @@ from __future__ import annotations +import asyncio import threading import webbrowser from typing import TYPE_CHECKING, Any, Optional, Union, cast @@ -102,8 +103,18 @@ def check_for_updates(autosplit: AutoSplit, check_on_open: bool = False): autosplit.CheckForUpdatesThread.start() +def get_capture_method_index(capture_method: Union[str, CaptureMethod]): + """ + Returns 0 if the capture_method is invalid or unsupported + """ + try: + return list(CAPTURE_METHODS.keys()).index(cast(CaptureMethod, capture_method)) + except ValueError: + return 0 + + class __SettingsWidget(QtWidgets.QDialog, settings_ui.Ui_DialogSettings): - __video_capture_devices: list[CameraInfo] + __video_capture_devices: list[CameraInfo] = [] """ Used to temporarily store the existing cameras, we don't want to call `get_all_video_capture_devices` agains and possibly have a different result @@ -123,21 +134,12 @@ def __update_default_threshold(self, value: Any): def __set_value(self, key: str, value: Any): self.autosplit.settings_dict[key] = value - def get_capture_method_index(self, capture_method: Union[str, CaptureMethod]): - """ - Returns 0 if the capture_method is invalid or unsupported - """ - try: - return list(CAPTURE_METHODS.keys()).index(cast(CaptureMethod, capture_method)) - except ValueError: - return 0 - def get_capture_device_index(self, capture_device_id: int): """ Returns 0 if the capture_device_id is invalid """ try: - return [device.id for device in self.__video_capture_devices].index(capture_device_id) + return [device.device_id for device in self.__video_capture_devices].index(capture_device_id) except ValueError: return 0 @@ -172,11 +174,11 @@ def __capture_device_changed(self, current_capture_method: Optional[Union[Captur capture_device = self.__video_capture_devices[device_index] if current_capture_method == CaptureMethod.VIDEO_CAPTURE_DEVICE: self.autosplit.settings_dict["captured_window_title"] = capture_device.name - self.autosplit.capture_device = cv2.VideoCapture(capture_device.id) - return capture_device.id + self.autosplit.capture_device = cv2.VideoCapture(capture_device.device_id) + return capture_device.device_id - def __set_all_capture_devices_async(self): - self.__video_capture_devices = get_all_video_capture_devices() + async def __set_all_capture_devices(self): + self.__video_capture_devices = await get_all_video_capture_devices() if len(self.__video_capture_devices) > 0: for i in range(self.capture_device_combobox.count()): self.capture_device_combobox.removeItem(i) @@ -196,7 +198,7 @@ def __init__(self, autosplit: AutoSplit): # region Build the Capture method combobox capture_method_values = CAPTURE_METHODS.values() - threading.Thread(target=self.__set_all_capture_devices_async).start() + threading.Thread(target=lambda: asyncio.run(self.__set_all_capture_devices())).start() capture_list_items = [ f"- {method.name} ({method.short_description})" for method in capture_method_values @@ -226,7 +228,7 @@ def __init__(self, autosplit: AutoSplit): self.fps_limit_spinbox.setValue(autosplit.settings_dict["fps_limit"]) self.live_capture_region_checkbox.setChecked(autosplit.settings_dict["live_capture_region"]) self.capture_method_combobox.setCurrentIndex( - self.get_capture_method_index(autosplit.settings_dict["capture_method"])) + get_capture_method_index(autosplit.settings_dict["capture_method"])) # Image Settings self.default_comparison_method.setCurrentIndex(autosplit.settings_dict["default_comparison_method"]) From 9710e61f63c251a5a3e62e13c6ee978b3791f69a Mon Sep 17 00:00:00 2001 From: Avasam Date: Wed, 4 May 2022 17:00:05 -0400 Subject: [PATCH 055/137] Fixed error when CaptureDevices haven't loaded yet --- .github/workflows/lint-and-build.yml | 10 +++++----- scripts/requirements.txt | 2 +- src/menu_bar.py | 5 ++++- 3 files changed, 10 insertions(+), 7 deletions(-) diff --git a/.github/workflows/lint-and-build.yml b/.github/workflows/lint-and-build.yml index efec46de..71964c9e 100644 --- a/.github/workflows/lint-and-build.yml +++ b/.github/workflows/lint-and-build.yml @@ -26,7 +26,7 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.8", "3.9", "3.10"] + python-version: ["3.9", "3.10"] steps: - name: Checkout ${{ github.repository }}/${{ github.ref }} uses: actions/checkout@v2 @@ -50,7 +50,7 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.8", "3.9", "3.10"] + python-version: ["3.9", "3.10"] steps: - name: Checkout ${{ github.repository }}/${{ github.ref }} uses: actions/checkout@v2 @@ -71,7 +71,7 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.8", "3.9", "3.10"] + python-version: ["3.9", "3.10"] steps: - name: Checkout ${{ github.repository }}/${{ github.ref }} uses: actions/checkout@v2 @@ -92,7 +92,7 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.8", "3.9", "3.10"] + python-version: ["3.9", "3.10"] steps: - name: Checkout ${{ github.repository }}/${{ github.ref }} uses: actions/checkout@v2 @@ -113,7 +113,7 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.8", "3.9", "3.10"] + python-version: ["3.9", "3.10"] steps: - name: Checkout ${{ github.repository }}/${{ github.ref }} uses: actions/checkout@v2 diff --git a/scripts/requirements.txt b/scripts/requirements.txt index 5bd3833f..6862c70b 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -1,6 +1,6 @@ # Requirements file for AutoSplit # -# Python: CPython 3.8+ +# Python: CPython 3.9+ # # Usage: .\scripts\install.bat # diff --git a/src/menu_bar.py b/src/menu_bar.py index fe6885d8..4559433a 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -169,7 +169,10 @@ def __capture_device_changed(self, current_capture_method: Optional[Union[Captur if self.autosplit.capture_device: self.autosplit.capture_device.release() self.autosplit.capture_device = None - capture_device = self.__video_capture_devices[self.capture_device_combobox.currentIndex()] + device_index = self.capture_device_combobox.currentIndex() + if device_index == -1: + return None + capture_device = self.__video_capture_devices[device_index] if current_capture_method == CaptureMethod.VIDEO_CAPTURE_DEVICE: self.autosplit.settings_dict["captured_window_title"] = capture_device.name self.autosplit.capture_device = cv2.VideoCapture(capture_device.device_id) From 0c5c107d07b26386fc6ee9d295963ce916edd9dc Mon Sep 17 00:00:00 2001 From: Avasam Date: Wed, 4 May 2022 17:02:32 -0400 Subject: [PATCH 056/137] Constants and more specific ignores --- src/AutoSplit.py | 4 ++-- src/AutoSplitImage.py | 6 ++++-- src/capture_method.py | 4 ++-- src/screen_region.py | 3 ++- src/split_parser.py | 6 +++--- 5 files changed, 13 insertions(+), 10 deletions(-) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 3dbcd9c2..8ad72022 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -28,7 +28,7 @@ import error_messages import user_profile from AutoControlledWorker import AutoControlledWorker -from AutoSplitImage import COMPARISON_RESIZE, AutoSplitImage, ImageType +from AutoSplitImage import COMPARISON_RESIZE, START_KEYWORD, AutoSplitImage, ImageType from capture_method import CaptureMethod from capture_windows import capture_region, set_ui_image from gen import about, design, settings, update_checker @@ -261,7 +261,7 @@ def __load_start_image(self, started_by_button: bool = False, wait_for_delay: bo if self.start_image is None: if started_by_button: - error_messages.no_keyword_image("start_auto_splitter") + error_messages.no_keyword_image(START_KEYWORD) QApplication.processEvents() return diff --git a/src/AutoSplitImage.py b/src/AutoSplitImage.py index 9c538152..ba00fc79 100644 --- a/src/AutoSplitImage.py +++ b/src/AutoSplitImage.py @@ -20,6 +20,8 @@ COMPARISON_RESIZE = (COMPARISON_RESIZE_WIDTH, COMPARISON_RESIZE_HEIGHT) LOWER_BOUND = np.array([0, 0, 0, 1], dtype="uint8") UPPER_BOUND = np.array([MAXBYTE, MAXBYTE, MAXBYTE, MAXBYTE], dtype="uint8") +START_KEYWORD = "start_auto_splitter" +RESET_KEYWORD = "RESET" class ImageType(Enum): @@ -91,9 +93,9 @@ def __init__(self, path: str): self.__similarity_threshold = threshold_from_filename(self.filename) self.__read_image_bytes(path) - if "start_auto_splitter" in self.filename: + if START_KEYWORD in self.filename: self.image_type = ImageType.START - elif "reset" in self.filename: + elif RESET_KEYWORD in self.filename: self.image_type = ImageType.RESET else: self.image_type = ImageType.SPLIT diff --git a/src/capture_method.py b/src/capture_method.py index 09c7fcbf..0a8d6885 100644 --- a/src/capture_method.py +++ b/src/capture_method.py @@ -128,7 +128,7 @@ async def get_all_video_capture_devices(): named_video_inputs = [x.description() for x in QMediaDevices.videoInputs()] async def get_camera_info(index: int): - video_capture = cv2.VideoCapture(index) # pyright: ignore + video_capture = cv2.VideoCapture(index) # pyright: reportUnknownVariableType=false video_capture.setExceptionMode(True) backend = None device_name = named_video_inputs[index] if index < len(named_video_inputs) else f"Camera {index}" @@ -136,7 +136,7 @@ async def get_camera_info(index: int): # https://docs.opencv.org/3.4/d4/d15/group__videoio__flags__base.html#ga023786be1ee68a9105bf2e48c700294d backend: str = video_capture.getBackendName() video_capture.grab() - except cv2.error as error: # pyright: ignore + except cv2.error as error: # pyright: reportGeneralTypeIssues=false if error.code != cv2.Error.STS_ERROR: return None finally: diff --git a/src/screen_region.py b/src/screen_region.py index 6115555c..84ed695f 100644 --- a/src/screen_region.py +++ b/src/screen_region.py @@ -126,7 +126,8 @@ async def coroutine(): return WindowsGraphicsCapture(item.size, frame_pool, session, None) -def __select_graphics_item(autosplit: AutoSplit): # pyright: ignore # For later as a different picker option +def __select_graphics_item(autosplit: AutoSplit): # pyright: reportUnusedFunction=false + # TODO: For later as a different picker option """ Uses the built-in GraphicsCapturePicker to select the Window """ diff --git a/src/split_parser.py b/src/split_parser.py index d365c93a..705282de 100644 --- a/src/split_parser.py +++ b/src/split_parser.py @@ -4,7 +4,7 @@ from typing import TYPE_CHECKING, TypeVar import error_messages -from AutoSplitImage import AutoSplitImage, ImageType +from AutoSplitImage import RESET_KEYWORD, START_KEYWORD, AutoSplitImage, ImageType if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -207,12 +207,12 @@ def parse_and_validate_images(autosplit: AutoSplit): error_messages.reset_hotkey() return False autosplit.gui_changes_on_reset() - error_messages.multiple_keyword_images("reset") + error_messages.multiple_keyword_images(RESET_KEYWORD) return False # Check that there's only one start image if image.image_type == ImageType.START: autosplit.gui_changes_on_reset() - error_messages.multiple_keyword_images("start_auto_splitter") + error_messages.multiple_keyword_images(START_KEYWORD) return False return True From 7bfd2f7de492defb9a3cd6eb537b31defeb5de61 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 7 May 2022 17:06:23 -0400 Subject: [PATCH 057/137] More accurate filename --- src/AutoSplit.py | 8 ++++---- src/{capture_method.py => CaptureMethod.py} | 0 src/menu_bar.py | 4 ++-- src/{capture_windows.py => region_capture.py} | 4 ++-- src/{screen_region.py => region_selection.py} | 6 +++--- src/user_profile.py | 6 +++--- 6 files changed, 14 insertions(+), 14 deletions(-) rename src/{capture_method.py => CaptureMethod.py} (100%) rename src/{capture_windows.py => region_capture.py} (98%) rename src/{screen_region.py => region_selection.py} (99%) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 8ad72022..5cf97a29 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -29,14 +29,14 @@ import user_profile from AutoControlledWorker import AutoControlledWorker from AutoSplitImage import COMPARISON_RESIZE, START_KEYWORD, AutoSplitImage, ImageType -from capture_method import CaptureMethod -from capture_windows import capture_region, set_ui_image +from CaptureMethod import CaptureMethod +from region_capture import capture_region, set_ui_image from gen import about, design, settings, update_checker from hotkeys import after_setting_hotkey, send_command from menu_bar import (AUTOSPLIT_VERSION, check_for_updates, get_default_settings_from_ui, open_about, open_settings, open_update_checker, view_help) -from screen_region import (WindowsGraphicsCapture, align_region, create_windows_graphics_capture, select_region, - select_window, validate_before_parsing) +from region_selection import (WindowsGraphicsCapture, align_region, create_windows_graphics_capture, select_region, + select_window, validate_before_parsing) from split_parser import BELOW_FLAG, DUMMY_FLAG, PAUSE_FLAG, parse_and_validate_images from user_profile import DEFAULT_PROFILE, FROZEN diff --git a/src/capture_method.py b/src/CaptureMethod.py similarity index 100% rename from src/capture_method.py rename to src/CaptureMethod.py diff --git a/src/menu_bar.py b/src/menu_bar.py index 4559433a..9ed419ab 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -16,10 +16,10 @@ import error_messages import user_profile -from capture_method import CAPTURE_METHODS, CameraInfo, CaptureMethod, get_all_video_capture_devices +from CaptureMethod import CAPTURE_METHODS, CameraInfo, CaptureMethod, get_all_video_capture_devices from gen import about, design, resources_rc, settings as settings_ui, update_checker # noqa: F401 from hotkeys import set_hotkey -from screen_region import create_windows_graphics_capture +from region_selection import create_windows_graphics_capture if TYPE_CHECKING: from AutoSplit import AutoSplit diff --git a/src/capture_windows.py b/src/region_capture.py similarity index 98% rename from src/capture_windows.py rename to src/region_capture.py index 13dae135..41be9329 100644 --- a/src/capture_windows.py +++ b/src/region_capture.py @@ -16,8 +16,8 @@ from win32 import win32gui from winsdk.windows.graphics.imaging import BitmapBufferAccessMode, SoftwareBitmap -from capture_method import CaptureMethod -from screen_region import WindowsGraphicsCapture +from CaptureMethod import CaptureMethod +from region_selection import WindowsGraphicsCapture if TYPE_CHECKING: from AutoSplit import AutoSplit diff --git a/src/screen_region.py b/src/region_selection.py similarity index 99% rename from src/screen_region.py rename to src/region_selection.py index 84ed695f..d9c623a2 100644 --- a/src/screen_region.py +++ b/src/region_selection.py @@ -23,9 +23,9 @@ from winsdk.windows.graphics.directx import DirectXPixelFormat from winsdk.windows.media.capture import MediaCapture -import capture_windows +import region_capture import error_messages -from capture_method import CaptureMethod +from CaptureMethod import CaptureMethod if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -247,7 +247,7 @@ def align_region(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) + capture, _ = region_capture.capture_region(autosplit) if capture is None or not capture.size: error_messages.region() diff --git a/src/user_profile.py b/src/user_profile.py index b6b0fd3b..b449cd4b 100644 --- a/src/user_profile.py +++ b/src/user_profile.py @@ -12,11 +12,11 @@ from winsdk.windows.graphics.capture.interop import create_for_window import error_messages -from capture_method import CAPTURE_METHODS, CaptureMethod -from capture_windows import Region +from CaptureMethod import CAPTURE_METHODS, CaptureMethod from gen import design from hotkeys import set_hotkey -from screen_region import create_windows_graphics_capture +from region_capture import Region +from region_selection import create_windows_graphics_capture if TYPE_CHECKING: from AutoSplit import AutoSplit From 2bc112b1fa3219217c11202520d9cc8a153e246e Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 7 May 2022 18:08:45 -0400 Subject: [PATCH 058/137] Test for MediaCapture and simplified coroutine --- src/CaptureMethod.py | 18 ++++++++++++++++-- src/region_capture.py | 3 +-- src/region_selection.py | 6 ++---- 3 files changed, 19 insertions(+), 8 deletions(-) diff --git a/src/CaptureMethod.py b/src/CaptureMethod.py index 0a8d6885..df1c11e9 100644 --- a/src/CaptureMethod.py +++ b/src/CaptureMethod.py @@ -6,11 +6,21 @@ import cv2 from PyQt6.QtMultimedia import QMediaDevices +from winsdk.windows.media.capture import MediaCapture # https://docs.microsoft.com/en-us/uwp/api/windows.graphics.capture.graphicscapturepicker#applies-to WCG_MIN_BUILD = 17134 +def test_for_media_capture(): + async def coroutine(): + return await (MediaCapture().initialize_async() or asyncio.sleep(0)) + try: + return bool(asyncio.run(coroutine())) + except OSError: + return False + + @dataclass class DisplayCaptureMethodInfo(): name: str @@ -112,11 +122,15 @@ def get_method_by_index(self, index: int): # Detect and remove unsupported capture methods -if int(version().split(".")[2]) < WCG_MIN_BUILD: +if ( # Windows Graphics Capture requires a minimum Windows Build + int(version().split(".")[2]) < WCG_MIN_BUILD + # Our current implementation of Windows Graphics Capture requires at least one CaptureDevice + or not test_for_media_capture() +): CAPTURE_METHODS.pop(CaptureMethod.WINDOWS_GRAPHICS_CAPTURE) -@dataclass +@ dataclass class CameraInfo(): device_id: int name: str diff --git a/src/region_capture.py b/src/region_capture.py index 41be9329..6478a90f 100644 --- a/src/region_capture.py +++ b/src/region_capture.py @@ -102,8 +102,7 @@ def __windows_graphics_capture(windows_graphics_capture: Optional[WindowsGraphic return windows_graphics_capture.last_captured_frame, True async def coroutine(): - async_operation = SoftwareBitmap.create_copy_from_surface_async(frame.surface) - return await async_operation if async_operation else None + return await (SoftwareBitmap.create_copy_from_surface_async(frame.surface) or asyncio.sleep(0, None)) try: software_bitmap = asyncio.run(coroutine()) except SystemError as exception: diff --git a/src/region_selection.py b/src/region_selection.py index d9c623a2..942f4363 100644 --- a/src/region_selection.py +++ b/src/region_selection.py @@ -23,8 +23,8 @@ from winsdk.windows.graphics.directx import DirectXPixelFormat from winsdk.windows.media.capture import MediaCapture -import region_capture import error_messages +import region_capture from CaptureMethod import CaptureMethod if TYPE_CHECKING: @@ -103,9 +103,7 @@ def create_windows_graphics_capture(item: GraphicsCaptureItem): media_capture = MediaCapture() async def coroutine(): - async_action = media_capture.initialize_async() - if async_action: - await async_action + await (media_capture.initialize_async() or asyncio.sleep(0)) asyncio.run(coroutine()) if not media_capture.media_capture_settings: From 0e53b5953953af7dd012a35d49736b13f451aaa4 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 7 May 2022 18:09:31 -0400 Subject: [PATCH 059/137] Updated README and some messages --- README.md | 127 +++++++++++++++++++++++++----------------- src/AutoSplit.py | 2 +- src/CaptureMethod.py | 9 ++- src/error_messages.py | 3 +- 4 files changed, 85 insertions(+), 56 deletions(-) diff --git a/README.md b/README.md index b2983070..a72a0f58 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@ [![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) [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=Avasam_Auto-Split&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=Avasam_Auto-Split) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Avasam_Auto-Split&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Avasam_Auto-Split) @@ -31,6 +30,7 @@ This program can be used to automatically start, split, and reset your preferred (This is not required for normal use) +- Python 3.8 - 3.10 - Microsoft Visual C++ 14.0 or greater may be required to build the executable. Get it with [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/) - Node is optional, but required for complete linting (using Pyright). - Read [requirements.txt](/scripts/requirements.txt) for more information on how to install, run and build the python code @@ -39,7 +39,9 @@ This program can be used to automatically start, split, and reset your preferred - Run `.\scripts\build.bat` to build an executable - Recompile resources after modifications by running `.\scripts\compile_resources.bat` -## Split Image Folder +## OPTIONS + +#### Split Image Folder - Supported image file types: .png, .jpg, .jpeg, .bmp, and [more](https://docs.opencv.org/3.0-beta/modules/imgcodecs/doc/reading_and_writing_images.html#imread). - Images can be any size. @@ -48,7 +50,7 @@ This program can be used to automatically start, split, and reset your preferred - Custom split image settings are handled in the filename. See how [here](#custom-split-image-settings). - To create split images, it is recommended to use AutoSplit's Take Screenshot button for accuracy. However, images can be created using any method including Print Screen and [Snipping Tool](https://support.microsoft.com/en-us/help/4027213/windows-10-open-snipping-tool-and-take-a-screenshot). -## Capture Region +#### Capture Region - This is the region that your split images are compared to. Usually, this is going to be the full game screen. - Click "Select Region" @@ -59,51 +61,95 @@ This program can be used to automatically start, split, and reset your preferred - Once you are happy with your capture region, you may unselect Live Capture Region to decrease CPU usage if you wish. - You can save a screenshot of the capture region to your split image folder using the Take Screenshot button. -## Avg. FPS +#### Avg. FPS - Calculates the average comparison rate of the capture region to split images. This value will likely be much higher than needed (unless you [Force Full-Content-Rendering](#Full-Content-Rendering)), so it is highly recommended to limit your FPS depending on the frame rate of the game you are capturing. -## OPTIONS +### Settings -### Comparison Method +#### Comparison Method - There are three comparison methods to choose from: L2 Norm, Histograms, and Perceptual Hash (or pHash). - L2 Norm: This method should be fine to use for most cases. it finds the difference between each pixel, squares it, and sums it over the entire image and takes the square root. This is very fast but is a problem if your image is high frequency. Any translational movement or rotation can cause similarity to be very different. - Histograms: An explanation on Histograms comparison can be found [here](https://mpatacchiola.github.io/blog/2016/11/12/the-simplest-classifier-histogram-intersection.html). This is a great method to use if you are using several masked images. - Perceptual Hash: An explanation on pHash comparison can be found [here](http://www.hackerfactor.com/blog/index.php?/archives/432-Looks-Like-It.html). It is highly recommended to NOT use pHash if you use masked images. It is very inaccurate. -### Full Content Rendering - -- Certain windows (namely hardware accelerated ones) won't always render their content. To work around this, you can "Force Full Content Rendering". This option is not recommended unless you really need it. It will cause a 10-15x performance drop based on the size of the complete window that's being captured (not the selected region, but rather the actual window size). It can also mess with some applications' rendering pipeline. - -### Show Live Similarity +#### Capture Method & Capture Device + +- **BitBlt** (fastest, least compatible) + A good default fast option. Also allows recording background windows (as long as they still actually render when in the background), but it cannot properly record OpenGL, Hardware Accelerated or Exclusive Fullscreen windows. + The smaller the region, the more efficient it is. +- **Windows Graphics Capture** (fast, most compatible but less features) + Only available in Windows 10.0.17134 and up. + Due to current technical limitations, it requires having at least one audio or video Capture Device connected and enabled. Even if it won't be used. + Allows recording UWP apps, Hardware Accelerated and Exclusive Fullscreen windows. + Caps at around 60 FPS. +- **Direct3D Desktop Duplication** (slower, bound to display) + Duplicates the desktop using Direct3D. + It can record OpenGL and Hardware Accelerated windows. + About 10-15x slower than BitBlt. Not affected by window size. + overlapping windows will show up and can't record across displays. +- **Force Full Content Rendering** (very slow, can affect rendering pipeline) + Uses BitBlt behind the scene, but passes a special flag to PrintWindow to force rendering the entire desktop. + About 10-15x slower than BitBlt based on original window size and can mess up some applications' rendering pipelines. +- **Video Capture Device** (see below) + Uses a Video Capture Device, like a webcam, virtual cam, or capture card. + It is not yet possible for us to display the device name. + If you want to use this with OBS' Virtual Camera, use the [Virtualcam plugin](https://obsproject.com/forum/resources/obs-virtualcam.949/) instead. + +#### Show Live Similarity - Displays the live similarity between the capture region and the current split image. This number is between 0 and 1, with 1 being a perfect match. -### Show Highest Similarity +#### Show Highest Similarity - Shows the highest similarity between the capture region and current split image. -### Current Similarity Threshold +#### Current Similarity Threshold - When the live similarity goes above this value, the program hits your split hotkey and moves to the next split image. -### Default Similarity Threshold +#### Default Similarity Threshold - This value will be set as the threshold for an image if there is no custom threshold set for that image. -### Pause Time +#### Pause Time - Time in seconds that the program stops comparison after a split. Useful for if you have two of the same split images in a row and want to avoid double-splitting. Also useful for reducing CPU usage. -### Default Pause Time +#### Default Pause Time - This value will be set as the Pause Time for an image if there is no custom Pause Time set for that image. -### Delay Time +#### Delay Time - Time in milliseconds that the program waits before hitting the split hotkey for that specific split. +#### Dummy splits when undoing / skipping + +AutoSplit will group dummy splits together with a real split when undoing/skipping. This basically allows you to tie one or more dummy splits to a real split to keep it as in sync as possible with the real splits in LiveSplit/wsplit. If they are out of sync, you can always use "Previous Image" and "Next Image". + +Examples: +Given these splits: 1 dummy, 2 normal, 3 dummy, 4 dummy, 5 normal, 6 normal. + +In this situation you would have only 3 splits in LiveSplit/wsplit (even though there are 6 split images, only 3 are "real" splits). This basically results in 3 groups of splits: 1st split is images 1 and 2. 2nd split is images 3, 4 and 5. 3rd split is image 6. + +- If you are in the 1st or 2nd image and press the skip key, it will end up on the 3rd image +- If you are in the 3rd, 4th or 5th image and press the undo key, it will end up on the 2nd image +- If you are in the 3rd, 4th or 5th image and press the skip key, it will end up on the 6th image +- If you are in the 6th image and press the undo key, it will end up on the 5th image + +#### Loop Split Images + +If this option is enabled, when the last split meets the threshold and splits, AutoSplit will loop back to the first split image and continue comparisons. +If this option is disabled, when the last split meets the threshold and splits, AutoSplit will stop running comparisons. +This option does not loop single, specific images. See the Custom Split Image Settings section above for this feature. + +#### Auto Start On Reset + +If this option is enabled, when the reset hotkey is hit, the reset button is pressed, or the reset split image meets its threshold, AutoSplit will reset and automatically start again back at the first split image. +If this option is disabled, when the reset hotkey is hit, the reset button is pressed, or the reset split image meets its threshold, AutoSplit will stop running comparisons. + ### Custom Split Image Settings - Each split image can have different thresholds, pause times, delay split times, loop amounts, and can be flagged. @@ -122,6 +168,8 @@ This program can be used to automatically start, split, and reset your preferred - `003_SplitName_(0.85)_[20]_#3500#.png` is the third split image with a threshold of 0.85, pause time of 20 and has a delay split time of 3.5 seconds. - `004_SplitName_(0.9)_[10]_#3500#_@3@_{b}.png` is the fourth split image with a threshold of 0.9, pause time of 10 seconds, delay split time of 3.5 seconds, will loop 3 times, and will split when similarity is below the threshold rather than above. +## Special images + ### How to Create a Masked Image Masked images are very useful if only a certain part of the capture region is consistent (for example, consistent text on the screen, but the background is always different). Histogram or L2 norm comparison is recommended if you use any masked images. It is highly recommended that you do NOT use pHash comparison if you use any masked images, as it is very inaccurate. @@ -138,38 +186,6 @@ You can have one (and only one) image with the keyword `reset` in its name. Auto The start image is similar to the reset image. You can only have one start image with the keyword `start_auto_splitter`.You can reload the image using the "`Reload Start Image`" button. The pause time is the amount of seconds AutoSplit will wait before checking for the start image once a run ends/is reset. Delay times will be used to delay starting your timer after the threshold is met. If you need to pause comparison for any amount of time after the Start Image, the best option right now is to use a dummy split image `{d}` with a similarity threshold of `(0.00)` and a pause threshold `[]` of however long you need to pause comparison as your first split image. This will trigger the pause immediately after your timer is started. -### Timer Global Hotkeys - -- Click "Set Hotkey" on each hotkey to set the hotkeys to AutoSplit. The Start / Split hotkey and Pause hotkey must be the same as the one used in your preferred timer program in order for the splitting/pausing to work properly. -- Make sure that Global Hotkeys are enabled in your speedrun timer. -- All of these actions can also be handled by their corresponding buttons. -- Note that pressing your Pause Hotkey does not serve any function in AutoSplit itself and is strictly used for the Pause flag. - -### Dummy splits when undoing / skipping - -AutoSplit will group dummy splits together with a real split when undoing/skipping. This basically allows you to tie one or more dummy splits to a real split to keep it as in sync as possible with the real splits in LiveSplit/wsplit. If they are out of sync, you can always use "Previous Image" and "Next Image". - -Examples: -Given these splits: 1 dummy, 2 normal, 3 dummy, 4 dummy, 5 normal, 6 normal. - -In this situation you would have only 3 splits in LiveSplit/wsplit (even though there are 6 split images, only 3 are "real" splits). This basically results in 3 groups of splits: 1st split is images 1 and 2. 2nd split is images 3, 4 and 5. 3rd split is image 6. - -- If you are in the 1st or 2nd image and press the skip key, it will end up on the 3rd image -- If you are in the 3rd, 4th or 5th image and press the undo key, it will end up on the 2nd image -- If you are in the 3rd, 4th or 5th image and press the skip key, it will end up on the 6th image -- If you are in the 6th image and press the undo key, it will end up on the 5th image - -### Loop Split Images - -If this option is enabled, when the last split meets the threshold and splits, AutoSplit will loop back to the first split image and continue comparisons. -If this option is disabled, when the last split meets the threshold and splits, AutoSplit will stop running comparisons. -This option does not loop single, specific images. See the Custom Split Image Settings section above for this feature. - -### Auto Start On Reset - -If this option is enabled, when the reset hotkey is hit, the reset button is pressed, or the reset split image meets its threshold, AutoSplit will reset and automatically start again back at the first split image. -If this option is disabled, when the reset hotkey is hit, the reset button is pressed, or the reset split image meets its threshold, AutoSplit will stop running comparisons. - ### Profiles - Profiles are saved under `%appdata%\AutoSplit\profiles` and use the extension `.toml`. Profiles can be saved and loaded by using File -> Save Profile As... and File -> Load Profile. @@ -177,14 +193,23 @@ If this option is disabled, when the reset hotkey is hit, the reset button is pr - You can save multiple profiles, which is useful if you speedrun multiple games. - If you change your display setup (like using a new monitor, or upgrading to Windows 11), you may need to readjust or reselect your Capture Region. -## LiveSplit Integration +## Timer Integration + +### Timer Global Hotkeys + +- Click "Set Hotkey" on each hotkey to set the hotkeys to AutoSplit. The Start / Split hotkey and Pause hotkey must be the same as the one used in your preferred timer program in order for the splitting/pausing to work properly. +- Make sure that Global Hotkeys are enabled in your speedrun timer. +- All of these actions can also be handled by their corresponding buttons. +- Note that pressing your Pause Hotkey does not serve any function in AutoSplit itself and is strictly used for the Pause flag. + +### LiveSplit Integration The AutoSplit LiveSplit Component will directly connect AutoSplit with LiveSplit. LiveSplit integration is only supported in AutoSplit v1.6.0 or higher. This integration will allow you to: - Use hotkeys directly from LiveSplit to control AutoSplit and LiveSplit together - Load AutoSplit and any AutoSplit profile automatically when opening a LiveSplit layout. -### LiveSplit Integration Tutorial +#### LiveSplit Integration Tutorial - Click [here](https://github.com/Toufool/LiveSplit.AutoSplitIntegration/raw/main/update/Components/LiveSplit.AutoSplitIntegration.dll) to download the latest component. - Place the .dll file into your `[...]\LiveSplit\Components` folder. diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 5cf97a29..1b6fa0ad 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -30,11 +30,11 @@ from AutoControlledWorker import AutoControlledWorker from AutoSplitImage import COMPARISON_RESIZE, START_KEYWORD, AutoSplitImage, ImageType from CaptureMethod import CaptureMethod -from region_capture import capture_region, set_ui_image from gen import about, design, settings, update_checker from hotkeys import after_setting_hotkey, send_command from menu_bar import (AUTOSPLIT_VERSION, check_for_updates, get_default_settings_from_ui, open_about, open_settings, open_update_checker, view_help) +from region_capture import capture_region, set_ui_image from region_selection import (WindowsGraphicsCapture, align_region, create_windows_graphics_capture, select_region, select_window, validate_before_parsing) from split_parser import BELOW_FLAG, DUMMY_FLAG, PAUSE_FLAG, parse_and_validate_images diff --git a/src/CaptureMethod.py b/src/CaptureMethod.py index df1c11e9..9f1dcbb8 100644 --- a/src/CaptureMethod.py +++ b/src/CaptureMethod.py @@ -16,7 +16,8 @@ def test_for_media_capture(): async def coroutine(): return await (MediaCapture().initialize_async() or asyncio.sleep(0)) try: - return bool(asyncio.run(coroutine())) + asyncio.run(coroutine()) + return True except OSError: return False @@ -83,6 +84,8 @@ def get_method_by_index(self, index: int): short_description="fast, most compatible but less features", description=( f"\nOnly available in Windows 10.0.{WCG_MIN_BUILD} and up. " + "\nDue to current technical limitations, it requires having at least one " + "\naudio or video Capture Device connected and enabled. Even if it won't be used. " "\nAllows recording UWP apps, Hardware Accelerated and Exclusive Fullscreen windows. " "\nCaps at around 60 FPS. " ), @@ -109,13 +112,13 @@ def get_method_by_index(self, index: int): ), CaptureMethod.VIDEO_CAPTURE_DEVICE: DisplayCaptureMethodInfo( name="Video Capture Device", - short_description="select below", + short_description="see below", description=( "\nUses a Video Capture Device, like a webcam, virtual cam, or capture card. " "\nYou can select one below. " "\nIt is not yet possible for us to display the device name. " "\nIf you want to use this with OBS' Virtual Camera, use the Virtualcam plugin instead " - "\nhttps://obsproject.com/forum/resources/obs-virtualcam.949/" + "\nhttps://obsproject.com/forum/resources/obs-virtualcam.949/." ), ), }) diff --git a/src/error_messages.py b/src/error_messages.py index b3103eac..af791c7d 100644 --- a/src/error_messages.py +++ b/src/error_messages.py @@ -127,7 +127,8 @@ def exception_traceback(message: str, exception: BaseException): CREATE_NEW_ISSUE_MESSAGE = ( "Please create a New Issue at " - + "github.com/Toufool/Auto-Split/issues, describe what happened, and copy & paste the error message below") + + "github.com/Toufool/Auto-Split/issues, describe what happened, " + + "and copy & paste the entire error message below") def make_excepthook(autosplit: AutoSplit): From 27383dbc77d2977595bba9bf8fbaa1814642c8fe Mon Sep 17 00:00:00 2001 From: Austin <37423484+Toufool@users.noreply.github.com> Date: Sat, 28 May 2022 14:20:28 -0400 Subject: [PATCH 060/137] update credits --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4f9397a4..51b07aef 100644 --- a/README.md +++ b/README.md @@ -203,7 +203,7 @@ Still need help? - Created by [Toufool](https://twitter.com/Toufool) and [Faschz](https://twitter.com/faschz). - [Harutaka Kawamura](https://github.com/harupy/) for the snipping tool code that I used to integrate into the autosplitter. - [amaringos](https://twitter.com/amaringos) for the icon. -- [ZanasoBayncuh](https://twitter.com/ZanasoBayncuh) for motivating me to start this project back up and for all of the time spent testing and suggesting improvements. +- [Zanaa_G](https://www.twitch.tv/zana_g) for motivating me to start this project back up and for all of the time spent testing and suggesting improvements. - [Avasam](https://twitter.com/Avasam06) for their continued work on making an incredible amount of improvements and changes to AutoSplit while I have not had the time/motivation to do so. - [KaDiWa](https://github.com/KaDiWa4) for the LiveSplit integration. - [Tyron18](https://twitter.com/Tyron18_) for assisting with Windows 11 testing. From f8e72cc2005396a440a5a60b0e89ad416ce92c72 Mon Sep 17 00:00:00 2001 From: Austin <37423484+Toufool@users.noreply.github.com> Date: Sat, 28 May 2022 14:20:55 -0400 Subject: [PATCH 061/137] oops --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 51b07aef..4d021064 100644 --- a/README.md +++ b/README.md @@ -203,7 +203,7 @@ Still need help? - Created by [Toufool](https://twitter.com/Toufool) and [Faschz](https://twitter.com/faschz). - [Harutaka Kawamura](https://github.com/harupy/) for the snipping tool code that I used to integrate into the autosplitter. - [amaringos](https://twitter.com/amaringos) for the icon. -- [Zanaa_G](https://www.twitch.tv/zana_g) for motivating me to start this project back up and for all of the time spent testing and suggesting improvements. +- [Zana_G](https://www.twitch.tv/zana_g) for motivating me to start this project back up and for all of the time spent testing and suggesting improvements. - [Avasam](https://twitter.com/Avasam06) for their continued work on making an incredible amount of improvements and changes to AutoSplit while I have not had the time/motivation to do so. - [KaDiWa](https://github.com/KaDiWa4) for the LiveSplit integration. - [Tyron18](https://twitter.com/Tyron18_) for assisting with Windows 11 testing. From 0f63e69e99f9e6c63546324d4e2c79c8f25687b7 Mon Sep 17 00:00:00 2001 From: Avasam Date: Wed, 1 Jun 2022 23:06:21 -0400 Subject: [PATCH 062/137] Fixed a few issues with the video capture device implementation --- src/AutoSplit.py | 38 +++++++++++++++++++++++--------------- src/CaptureMethod.py | 24 ++++++++++++++---------- src/menu_bar.py | 7 ++++--- src/region_capture.py | 7 +++++-- src/user_profile.py | 2 ++ 5 files changed, 48 insertions(+), 30 deletions(-) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 1b6fa0ad..1feedf4d 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -104,10 +104,10 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): reset_highest_similarity = 0.0 # Define all other attributes - start_image_split_below_threshold: bool - waiting_for_split_delay: bool - split_below_threshold: bool - run_start_time: float + start_image_split_below_threshold = False + waiting_for_split_delay = False + split_below_threshold = False + run_start_time = 0.0 start_image: Optional[AutoSplitImage] = None reset_image: Optional[AutoSplitImage] = None split_images: list[AutoSplitImage] = [] @@ -122,6 +122,7 @@ def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-man sys.excepthook = error_messages.make_excepthook(self) self.setupUi(self) + self.setWindowTitle(f"AutoSplit v{AUTOSPLIT_VERSION}") # Get default values defined in SettingsDialog self.settings_dict = get_default_settings_from_ui(self) @@ -230,8 +231,11 @@ def __browse(self): self.load_start_image_signal.emit() def __live_image_function(self): - self.capture_region_window_label.setText(self.settings_dict["captured_window_title"]) - if not (self.settings_dict["live_capture_region"] and self.settings_dict["captured_window_title"]): + capture_region_window_label = self.settings_dict["capture_device_name"] \ + if self.settings_dict["capture_method"] == CaptureMethod.VIDEO_CAPTURE_DEVICE \ + else self.settings_dict["captured_window_title"] + self.capture_region_window_label.setText(capture_region_window_label) + if not (self.settings_dict["live_capture_region"] and capture_region_window_label): self.live_image.clear() return # Set live image in UI @@ -742,17 +746,21 @@ def __get_capture_for_comparison(self): """ capture, is_old_image = capture_region(self) - # This most likely means we lost capture (ie the captured window was closed, crashed, etc.) + # This most likely means we lost capture + # (ie the captured window was closed, crashed, lost capture device, etc.) if capture is None or not capture.size: # Try to recover by using the window name - self.live_image.setText("Trying to recover window...") - hwnd = win32gui.FindWindow(None, self.settings_dict["captured_window_title"]) - # Don't fallback to desktop - if hwnd: - self.hwnd = hwnd - if self.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: - self.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) - capture, _ = capture_region(self) + if self.settings_dict["capture_method"] == CaptureMethod.VIDEO_CAPTURE_DEVICE: + self.live_image.setText("Waiting for capture device...") + else: + self.live_image.setText("Trying to recover window...") + hwnd = win32gui.FindWindow(None, self.settings_dict["captured_window_title"]) + # Don't fallback to desktop + if hwnd: + self.hwnd = hwnd + if self.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + self.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) + capture, _ = capture_region(self) return None if capture is None or not capture.size else cv2.resize( capture, COMPARISON_RESIZE, interpolation=cv2.INTER_NEAREST), is_old_image diff --git a/src/CaptureMethod.py b/src/CaptureMethod.py index 9f1dcbb8..2adda9c8 100644 --- a/src/CaptureMethod.py +++ b/src/CaptureMethod.py @@ -143,6 +143,8 @@ class CameraInfo(): async def get_all_video_capture_devices(): named_video_inputs = [x.description() for x in QMediaDevices.videoInputs()] + # Enough to ensure we catch "OBS-Camera" 1-4 (Virtualcam plugin) and "OBS Virtual Camera" + device_range_to_test = range(len(named_video_inputs) + 5) async def get_camera_info(index: int): video_capture = cv2.VideoCapture(index) # pyright: reportUnknownVariableType=false @@ -154,17 +156,19 @@ async def get_camera_info(index: int): backend: str = video_capture.getBackendName() video_capture.grab() except cv2.error as error: # pyright: reportGeneralTypeIssues=false - if error.code != cv2.Error.STS_ERROR: - return None + return CameraInfo(index, device_name, True, backend) \ + if error.code == cv2.Error.STS_ERROR \ + else None finally: video_capture.release() - return CameraInfo(index, device_name, True, backend) - # Enough to ensure we catch "OBS-Camera" (Virtualcam plugin) and "" - results: list[CameraInfo] = [ + return CameraInfo(index, device_name, False, backend) + + future = asyncio.gather(*[ + get_camera_info(index) for index + in device_range_to_test + ]) + + return [ camera_info for camera_info - in await asyncio.gather(*[ - get_camera_info(index) for index - in range(len(named_video_inputs) + 5) - ]) + in await future if camera_info is not None] - return results diff --git a/src/menu_bar.py b/src/menu_bar.py index 9ed419ab..7169d3e8 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -25,7 +25,7 @@ from AutoSplit import AutoSplit # AutoSplit Version number -AUTOSPLIT_VERSION = "2.0.0-alpha" +AUTOSPLIT_VERSION = "2.0.0-alpha2" # About Window @@ -174,7 +174,7 @@ def __capture_device_changed(self, current_capture_method: Optional[Union[Captur return None capture_device = self.__video_capture_devices[device_index] if current_capture_method == CaptureMethod.VIDEO_CAPTURE_DEVICE: - self.autosplit.settings_dict["captured_window_title"] = capture_device.name + self.autosplit.settings_dict["capture_device_name"] = capture_device.name self.autosplit.capture_device = cv2.VideoCapture(capture_device.device_id) return capture_device.device_id @@ -184,7 +184,7 @@ async def __set_all_capture_devices(self): for i in range(self.capture_device_combobox.count()): self.capture_device_combobox.removeItem(i) self.capture_device_combobox.addItems([ - f"* {device.name} [{device.backend}]{'' if device.occupied else ' (occupied)'}" + f"* {device.name} [{device.backend}]{' (occupied)' if device.occupied else ''}" for device in self.__video_capture_devices]) self.capture_device_combobox.setEnabled(True) self.capture_device_combobox.setCurrentIndex( @@ -302,6 +302,7 @@ def get_default_settings_from_ui(autosplit: AutoSplit): "capture_method": CAPTURE_METHODS.get_method_by_index( default_settings_dialog.capture_method_combobox.currentIndex()), "capture_device_id": default_settings_dialog.capture_device_combobox.currentIndex(), + "capture_device_name": "", "default_comparison_method": default_settings_dialog.default_comparison_method.currentIndex(), "default_similarity_threshold": default_settings_dialog.default_similarity_threshold_spinbox.value(), "default_delay_time": default_settings_dialog.default_delay_time_spinbox.value(), diff --git a/src/region_capture.py b/src/region_capture.py index 6478a90f..9069171a 100644 --- a/src/region_capture.py +++ b/src/region_capture.py @@ -135,9 +135,12 @@ def __camera_capture(capture_device: Optional[cv2.VideoCapture], selection: Regi result, image = capture_device.read() if not result: return None + # Ensure we can't go OOB of the image + y = min(selection["y"], image.shape[0] - 1) + x = min(selection["x"], image.shape[1] - 1) image = image[ - selection["y"]:selection["height"] + selection["y"], - selection["x"]:selection["width"] + selection["x"], + y:selection["height"] + y, + x:selection["width"] + x, ] return cv2.cvtColor(image, cv2.COLOR_BGR2BGRA) diff --git a/src/user_profile.py b/src/user_profile.py index b449cd4b..ffe7a5af 100644 --- a/src/user_profile.py +++ b/src/user_profile.py @@ -36,6 +36,7 @@ class UserProfileDict(TypedDict): live_capture_region: bool capture_method: Union[str, CaptureMethod] capture_device_id: int + capture_device_name: str default_comparison_method: int default_similarity_threshold: float default_delay_time: int @@ -57,6 +58,7 @@ class UserProfileDict(TypedDict): live_capture_region=True, capture_method=CAPTURE_METHODS.get_method_by_index(0), capture_device_id=0, + capture_device_name="", default_comparison_method=0, default_similarity_threshold=0.95, default_delay_time=0, From 2ecfa851a8e85f69aa2c0d82324c3b2dee88fd66 Mon Sep 17 00:00:00 2001 From: Avasam Date: Fri, 3 Jun 2022 10:51:58 -0400 Subject: [PATCH 063/137] Updated some text --- README.md | 3 ++- src/CaptureMethod.py | 3 ++- src/menu_bar.py | 2 +- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a72a0f58..8571c5cb 100644 --- a/README.md +++ b/README.md @@ -92,8 +92,9 @@ This program can be used to automatically start, split, and reset your preferred - **Force Full Content Rendering** (very slow, can affect rendering pipeline) Uses BitBlt behind the scene, but passes a special flag to PrintWindow to force rendering the entire desktop. About 10-15x slower than BitBlt based on original window size and can mess up some applications' rendering pipelines. -- **Video Capture Device** (see below) +- **Video Capture Device** (very slow, see below) Uses a Video Capture Device, like a webcam, virtual cam, or capture card. + There are currently performance issues, but it might be more convenient. It is not yet possible for us to display the device name. If you want to use this with OBS' Virtual Camera, use the [Virtualcam plugin](https://obsproject.com/forum/resources/obs-virtualcam.949/) instead. diff --git a/src/CaptureMethod.py b/src/CaptureMethod.py index 2adda9c8..fa3017c8 100644 --- a/src/CaptureMethod.py +++ b/src/CaptureMethod.py @@ -112,10 +112,11 @@ def get_method_by_index(self, index: int): ), CaptureMethod.VIDEO_CAPTURE_DEVICE: DisplayCaptureMethodInfo( name="Video Capture Device", - short_description="see below", + short_description="very slow, see below", description=( "\nUses a Video Capture Device, like a webcam, virtual cam, or capture card. " "\nYou can select one below. " + "\nThere are currently performance issues, but it might be more convenient. " "\nIt is not yet possible for us to display the device name. " "\nIf you want to use this with OBS' Virtual Camera, use the Virtualcam plugin instead " "\nhttps://obsproject.com/forum/resources/obs-virtualcam.949/." diff --git a/src/menu_bar.py b/src/menu_bar.py index 7169d3e8..16dd2b19 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -25,7 +25,7 @@ from AutoSplit import AutoSplit # AutoSplit Version number -AUTOSPLIT_VERSION = "2.0.0-alpha2" +AUTOSPLIT_VERSION = "2.0.0-alpha.2" # About Window From 59f7dd0b1eecdb63c735cb472839771d40481f92 Mon Sep 17 00:00:00 2001 From: Avasam Date: Mon, 6 Jun 2022 10:50:47 -0400 Subject: [PATCH 064/137] Fixed start images threshold --- src/AutoSplit.py | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 1feedf4d..e54a12d4 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -297,16 +297,13 @@ def __start_image_function(self): capture, _ = self.__get_capture_for_comparison() start_image_threshold = self.start_image.get_similarity_threshold(self) start_image_similarity = self.start_image.compare_with_capture(self, capture) - self.table_current_image_threshold_label.setText(f"{start_image_threshold:.2f}") - - # Show live similarity if the checkbox is checked - self.table_current_image_live_label.setText(f"{start_image_similarity:.2f}") # If the similarity becomes higher than highest similarity, set it as such. if start_image_similarity > self.highest_similarity: self.highest_similarity = start_image_similarity - # Show live highest similarity if the checkbox is checked + self.table_current_image_threshold_label.setText(f"{start_image_threshold:.2f}") + self.table_current_image_live_label.setText(f"{start_image_similarity:.2f}") self.table_current_image_highest_label.setText(f"{self.highest_similarity:.2f}") # If the {b} flag is set, let similarity go above threshold first, then split on similarity below threshold @@ -314,7 +311,7 @@ def __start_image_function(self): below_flag = self.start_image.check_flag(BELOW_FLAG) # Negative means belove threshold, positive means above - similarity_diff = start_image_threshold - start_image_similarity + similarity_diff = start_image_similarity - start_image_threshold if below_flag \ and not self.start_image_split_below_threshold \ and similarity_diff >= 0: From a91323c67dcdac02ebb56e5e676fef594fd31a47 Mon Sep 17 00:00:00 2001 From: Avasam Date: Mon, 6 Jun 2022 13:57:14 -0400 Subject: [PATCH 065/137] Updated typings - Updated CV2-stubs - Fixed a Callable argument in keyboard - Updated "disable/ignore" comments --- pyproject.toml | 9 +- scripts/install.bat | 1 + scripts/requirements.txt | 2 +- src/AutoSplit.py | 2 +- src/AutoSplitImage.py | 8 +- src/CaptureMethod.py | 11 +- src/compare.py | 13 +- src/region_capture.py | 17 +- src/region_selection.py | 8 +- typings/cv2-stubs/__init__.pyi | 861 ++++++++------------------------- typings/d3dshot/d3dshot.pyi | 2 +- typings/keyboard/__init__.pyi | 4 +- 12 files changed, 232 insertions(+), 706 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index eb9de738..36cb52e1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -45,8 +45,8 @@ 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. warning and conventions are worth more -evaluation = "10.0 - error - ((float((warning + convention) * 10 + refactor ) / statement) * 10)" +# Just like default but any error, warning or convention will make drop to 9 or less. refactor are worth more +evaluation = "10.0 - error - warning - convention - ((10 * refactor) / statement) * 10" [tool.pylint.MASTER] fail-under = 9.0 # https://pylint.pycqa.org/en/latest/technical_reference/extensions.html @@ -97,6 +97,9 @@ max-locals = 15 max-complexity = 15 # At least same as max-complexity max-branches = 15 +# https://github.com/PyCQA/pep8-naming/issues/164 +# OR doesn't fit CaptureMethodMeta +valid-classmethod-first-arg = "self" # https://pylint.pycqa.org/en/latest/user_guide/options.html#naming-styles module-naming-style = "any" # Can't make private class with PascalCase @@ -120,6 +123,8 @@ disable = [ "R0801", # False positives with PyQt .connect "no-value-for-parameter", + # Not as long as we support Python 3.9 + "consider-alternative-union-syntax", ] [tool.pylint.TYPECHECK] diff --git a/scripts/install.bat b/scripts/install.bat index 6af8691b..1c47701e 100644 --- a/scripts/install.bat +++ b/scripts/install.bat @@ -1,4 +1,5 @@ py -m pip install wheel --upgrade py -m pip install -r "%~p0requirements.txt" --upgrade npm install -g pyright@latest +npm list -g pyright CALL "%~p0compile_resources.bat" diff --git a/scripts/requirements.txt b/scripts/requirements.txt index 6862c70b..2c0bed48 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -34,7 +34,7 @@ flake8-pyi flake8-quotes flake8-isort pylint>=2.13 -git+https://github.com/Avasam/pywin32-stubs.git#egg=pywin32-stubs # https://github.com/kaluluosi/pywin32-stubs/pull/4 +pywin32-stubs>=0.1.6 simplejson types-simplejson>=3.17.2 types-requests diff --git a/src/AutoSplit.py b/src/AutoSplit.py index e54a12d4..a5171ff4 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -761,7 +761,7 @@ def __get_capture_for_comparison(self): return None if capture is None or not capture.size else cv2.resize( capture, COMPARISON_RESIZE, interpolation=cv2.INTER_NEAREST), is_old_image - def __reset_if_should(self, capture: Optional[cv2.ndarray]): + def __reset_if_should(self, capture: Optional[cv2.Mat]): """ Check if we should reset, resets if it's the case, and returns the result """ diff --git a/src/AutoSplitImage.py b/src/AutoSplitImage.py index ba00fc79..ab323e36 100644 --- a/src/AutoSplitImage.py +++ b/src/AutoSplitImage.py @@ -36,10 +36,10 @@ class AutoSplitImage(): flags: int loops: int image_type: ImageType - bytes: Optional[cv2.ndarray] = None - mask: Optional[cv2.ndarray] = None + bytes: Optional[cv2.Mat] = None + mask: Optional[cv2.Mat] = None # This value is internal, check for mask instead - _has_transparency: bool + _has_transparency = False # These values should be overriden by Defaults if None. Use getters instead __delay_time: Optional[float] = None __comparison_method: Optional[int] = None @@ -125,7 +125,7 @@ def check_flag(self, flag: int): def compare_with_capture( self, default: Union[AutoSplit, int], - capture: Optional[cv2.ndarray] + capture: Optional[cv2.Mat] ): """ Compare image with capture using image's comparison method. Falls back to combobox diff --git a/src/CaptureMethod.py b/src/CaptureMethod.py index fa3017c8..7b506c62 100644 --- a/src/CaptureMethod.py +++ b/src/CaptureMethod.py @@ -31,10 +31,9 @@ class DisplayCaptureMethodInfo(): class CaptureMethodMeta(EnumMeta): # Allow checking if simple string is enum - def __contains__(cls, other: str): # noqa:N805 + def __contains__(self, other: str): try: - # pyright: reportGeneralTypeIssues=false - cls(other) # pylint: disable=no-value-for-parameter + self(other) # pyright: ignore [reportGeneralTypeIssues] except ValueError: return False else: @@ -148,15 +147,15 @@ async def get_all_video_capture_devices(): device_range_to_test = range(len(named_video_inputs) + 5) async def get_camera_info(index: int): - video_capture = cv2.VideoCapture(index) # pyright: reportUnknownVariableType=false + video_capture = cv2.VideoCapture(index) # pyright: ignore [reportUnknownVariableType] video_capture.setExceptionMode(True) - backend = None + backend = "" device_name = named_video_inputs[index] if index < len(named_video_inputs) else f"Camera {index}" try: # https://docs.opencv.org/3.4/d4/d15/group__videoio__flags__base.html#ga023786be1ee68a9105bf2e48c700294d backend: str = video_capture.getBackendName() video_capture.grab() - except cv2.error as error: # pyright: reportGeneralTypeIssues=false + except cv2.error as error: # pyright: ignore [reportUnknownVariableType] return CameraInfo(index, device_name, True, backend) \ if error.code == cv2.Error.STS_ERROR \ else None diff --git a/src/compare.py b/src/compare.py index 95f09df8..af2d94e6 100644 --- a/src/compare.py +++ b/src/compare.py @@ -16,7 +16,7 @@ MASK_SIZE_MULTIPLIER = 3 * MAXBYTE * MAXBYTE -def compare_histograms(source: cv2.ndarray, capture: cv2.ndarray, mask: Optional[cv2.ndarray] = None): +def compare_histograms(source: cv2.Mat, capture: cv2.Mat, mask: Optional[cv2.Mat] = None): """ Compares two images by calculating their histograms, normalizing them, and then comparing them using Bhattacharyya distance. @@ -36,7 +36,7 @@ def compare_histograms(source: cv2.ndarray, capture: cv2.ndarray, mask: Optional return 1 - cv2.compareHist(source_hist, capture_hist, cv2.HISTCMP_BHATTACHARYYA) -def compare_l2_norm(source: cv2.ndarray, capture: cv2.ndarray, mask: Optional[cv2.ndarray] = None): +def compare_l2_norm(source: cv2.Mat, capture: cv2.Mat, mask: Optional[cv2.Mat] = None): """ Compares two images by calculating the L2 Error (square-root of sum of squared error) @param source: Image of any given shape @@ -45,8 +45,7 @@ def compare_l2_norm(source: cv2.ndarray, capture: cv2.ndarray, mask: Optional[cv @return: The similarity between the images as a number 0 to 1. """ - # https://github.com/microsoft/pylance-release/issues/2089 - error = cv2.norm(source, capture, cv2.NORM_L2, mask) # type: ignore + error = cv2.norm(source, capture, cv2.NORM_L2, mask) # The L2 Error is summed across all pixels, so this normalizes max_error = sqrt(source.size) * MAXBYTE \ @@ -58,7 +57,7 @@ def compare_l2_norm(source: cv2.ndarray, capture: cv2.ndarray, mask: Optional[cv return 1 - (error / max_error) -def compare_template(source: cv2.ndarray, capture: cv2.ndarray, mask: Optional[cv2.ndarray] = None): +def compare_template(source: cv2.Mat, capture: cv2.Mat, mask: Optional[cv2.Mat] = None): """ Checks if the source is located within the capture by using the sum of square differences. The mask is used to search for non-rectangular images within the capture @@ -82,7 +81,7 @@ def compare_template(source: cv2.ndarray, capture: cv2.ndarray, mask: Optional[c return 1 - (min_val / max_error) -def compare_phash(source: cv2.ndarray, capture: cv2.ndarray, mask: Optional[cv2.ndarray] = None): +def compare_phash(source: cv2.Mat, capture: cv2.Mat, mask: Optional[cv2.Mat] = None): """ Compares the Perceptual Hash of the two given images and returns the similarity between the two. @@ -109,7 +108,7 @@ def compare_phash(source: cv2.ndarray, capture: cv2.ndarray, mask: Optional[cv2. return 1 - (hash_diff / 64.0) -def check_if_image_has_transparency(image: cv2.ndarray): +def check_if_image_has_transparency(image: cv2.Mat): # 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/region_capture.py b/src/region_capture.py index 9069171a..d8052fa5 100644 --- a/src/region_capture.py +++ b/src/region_capture.py @@ -36,7 +36,7 @@ class Region(TypedDict): def __bit_blt_capture(hwnd: int, selection: Region, render_full_content: bool = False): - image: Optional[cv2.ndarray] = None + image: Optional[cv2.Mat] = None # If the window closes while it's being manipulated, it could cause a crash try: window_dc = win32gui.GetWindowDC(hwnd) @@ -59,8 +59,7 @@ def __bit_blt_capture(hwnd: int, selection: Region, render_full_content: bool = image = np.frombuffer(cast(bytes, bitmap.GetBitmapBits(True)), dtype=np.uint8) image.shape = (selection["height"], selection["width"], 4) # https://github.com/kaluluosi/pywin32-stubs/issues/5 - # pylint: disable=no-member - except (win32ui.error, pywintypes.error): # type: ignore + except (win32ui.error, pywintypes.error): # pyright: ignore [reportGeneralTypeIssues] pylint: disable=no-member return None # We already obtained the image, so we can ignore errors during cleanup try: @@ -69,7 +68,7 @@ def __bit_blt_capture(hwnd: int, selection: Region, render_full_content: bool = win32gui.ReleaseDC(hwnd, window_dc) win32gui.DeleteObject(bitmap.GetHandle()) # https://github.com/kaluluosi/pywin32-stubs/issues/5 - except win32ui.error: # type: ignore + except win32ui.error: # pyright: ignore [reportGeneralTypeIssues] pass return image @@ -114,7 +113,7 @@ async def coroutine(): if not software_bitmap: # HACK: Can happen when starting the region selector return windows_graphics_capture.last_captured_frame, True - raise ValueError("Unable to convert Direct3D11CaptureFrame to SoftwareBitmap.") + # raise ValueError("Unable to convert Direct3D11CaptureFrame to SoftwareBitmap.") bitmap_buffer = software_bitmap.lock_buffer(BitmapBufferAccessMode.READ_WRITE) if not bitmap_buffer: raise ValueError("Unable to obtain the BitmapBuffer from SoftwareBitmap.") @@ -136,8 +135,8 @@ def __camera_capture(capture_device: Optional[cv2.VideoCapture], selection: Regi if not result: return None # Ensure we can't go OOB of the image - y = min(selection["y"], image.shape[0] - 1) - x = min(selection["x"], image.shape[1] - 1) + y = min(selection["y"], image.shape[0] - 1) # pyright: ignore [reportUnusedVariable] + x = min(selection["x"], image.shape[1] - 1) # pyright: ignore [reportUnusedVariable] image = image[ y:selection["height"] + y, x:selection["width"] + x, @@ -145,7 +144,7 @@ def __camera_capture(capture_device: Optional[cv2.VideoCapture], selection: Regi return cv2.cvtColor(image, cv2.COLOR_BGR2BGRA) -def capture_region(autosplit: AutoSplit) -> tuple[Optional[cv2.ndarray], bool]: +def capture_region(autosplit: AutoSplit) -> tuple[Optional[cv2.Mat], bool]: """ Captures an image of the region for a window matching the given parameters of the bounding box @@ -173,7 +172,7 @@ def capture_region(autosplit: AutoSplit) -> tuple[Optional[cv2.ndarray], bool]: return __bit_blt_capture(hwnd, selection, capture_method == CaptureMethod.PRINTWINDOW_RENDERFULLCONTENT), False -def set_ui_image(qlabel: QLabel, image: Optional[cv2.ndarray], transparency: bool): +def set_ui_image(qlabel: QLabel, image: Optional[cv2.Mat], transparency: bool): if image is None or not image.size: # Clear current pixmap if image is None. But don't clear text if not qlabel.text(): diff --git a/src/region_selection.py b/src/region_selection.py index 942f4363..0cbabbcb 100644 --- a/src/region_selection.py +++ b/src/region_selection.py @@ -94,7 +94,7 @@ class WindowsGraphicsCapture: frame_pool: Direct3D11CaptureFramePool # Prevent session from being garbage collected session: GraphicsCaptureSession - last_captured_frame: Optional[cv2.ndarray] + last_captured_frame: Optional[cv2.Mat] def create_windows_graphics_capture(item: GraphicsCaptureItem): @@ -124,7 +124,7 @@ async def coroutine(): return WindowsGraphicsCapture(item.size, frame_pool, session, None) -def __select_graphics_item(autosplit: AutoSplit): # pyright: reportUnusedFunction=false +def __select_graphics_item(autosplit: AutoSplit): # pyright: ignore [reportUnusedFunction] # TODO: For later as a different picker option """ Uses the built-in GraphicsCapturePicker to select the Window @@ -145,7 +145,7 @@ def callback(async_operation: IAsyncOperation[GraphicsCaptureItem], async_status autosplit.windows_graphics_capture = create_windows_graphics_capture(item) picker = GraphicsCapturePicker() - initialize_with_window(picker, autosplit.effectiveWinId().__int__()) + initialize_with_window(picker, int(autosplit.effectiveWinId())) async_operation = picker.pick_single_item_async() # None if the selection is canceled if async_operation: @@ -279,7 +279,7 @@ def __set_region_values(autosplit: AutoSplit, left: int, top: int, width: int, h autosplit.height_spinbox.setValue(height) -def __test_alignment(capture: cv2.ndarray, template: cv2.ndarray): # pylint: disable=too-many-locals +def __test_alignment(capture: cv2.Mat, template: cv2.Mat): # pylint: disable=too-many-locals """ Obtain the best matching point for the template within the capture. This assumes that the template is actually smaller diff --git a/typings/cv2-stubs/__init__.pyi b/typings/cv2-stubs/__init__.pyi index 1a6f16a2..1243f931 100644 --- a/typings/cv2-stubs/__init__.pyi +++ b/typings/cv2-stubs/__init__.pyi @@ -1,12 +1,12 @@ # Python: 3.8.0 (tags/v3.8.0:fa919fd, Oct 14 2019, 19:37:50) [MSC v.1916 64 bit (AMD64)] # Library: cv2, version: 4.4.0 # Module: cv2.cv2, version: 4.4.0 -# https://github.com/microsoft/python-type-stubs/pull/112 import typing +import builtins as _mod_builtins import cv2 as _mod_cv2 -import numpy +import numpy as np -ndarray = numpy.ndarray[int, numpy.dtype[typing.Any]] +Mat = np.ndarray[int, np.dtype[np.generic]] ACCESS_FAST: int ACCESS_MASK: int @@ -26,14 +26,10 @@ AKAZE_DESCRIPTOR_KAZE: int AKAZE_DESCRIPTOR_KAZE_UPRIGHT: int AKAZE_DESCRIPTOR_MLDB: int AKAZE_DESCRIPTOR_MLDB_UPRIGHT: int - - -def AKAZE_create(descriptor_type=..., descriptor_size=..., descriptor_channels=..., threshold=..., nOctaves=..., nOctaveLayers=..., diffusivity=... -) -> typing.Any: +def AKAZE_create(descriptor_type=..., descriptor_size=..., descriptor_channels=..., threshold=..., nOctaves=..., nOctaveLayers=..., diffusivity=...) -> typing.Any: 'AKAZE_create([, descriptor_type[, descriptor_size[, descriptor_channels[, threshold[, nOctaves[, nOctaveLayers[, diffusivity]]]]]]]) -> retval\n. @brief The AKAZE constructor\n. \n. @param descriptor_type Type of the extracted descriptor: DESCRIPTOR_KAZE,\n. DESCRIPTOR_KAZE_UPRIGHT, DESCRIPTOR_MLDB or DESCRIPTOR_MLDB_UPRIGHT.\n. @param descriptor_size Size of the descriptor in bits. 0 -\\> Full size\n. @param descriptor_channels Number of channels in the descriptor (1, 2, 3)\n. @param threshold Detector response threshold to accept point\n. @param nOctaves Maximum octave evolution of the image\n. @param nOctaveLayers Default number of sublevels per scale level\n. @param diffusivity Diffusivity type. DIFF_PM_G1, DIFF_PM_G2, DIFF_WEICKERT or\n. DIFF_CHARBONNIER' ... - AgastFeatureDetector = _mod_cv2.AgastFeatureDetector AgastFeatureDetector_AGAST_5_8: int AgastFeatureDetector_AGAST_7_12d: int @@ -41,25 +37,19 @@ AgastFeatureDetector_AGAST_7_12s: int AgastFeatureDetector_NONMAX_SUPPRESSION: int AgastFeatureDetector_OAST_9_16: int AgastFeatureDetector_THRESHOLD: int - - def AgastFeatureDetector_create(threshold=..., nonmaxSuppression=..., type=...) -> typing.Any: 'AgastFeatureDetector_create([, threshold[, nonmaxSuppression[, type]]]) -> retval\n.' ... - Algorithm = _mod_cv2.Algorithm AlignExposures = _mod_cv2.AlignExposures AlignMTB = _mod_cv2.AlignMTB AsyncArray = _mod_cv2.AsyncArray BFMatcher = _mod_cv2.BFMatcher - - def BFMatcher_create(normType: int = ..., crossCheck=...) -> typing.Any: "BFMatcher_create([, normType[, crossCheck]]) -> retval\n. @brief Brute-force matcher create method.\n. @param normType One of NORM_L1, NORM_L2, NORM_HAMMING, NORM_HAMMING2. L1 and L2 norms are\n. preferable choices for SIFT and SURF descriptors, NORM_HAMMING should be used with ORB, BRISK and\n. BRIEF, NORM_HAMMING2 should be used with ORB when WTA_K==3 or 4 (see ORB::ORB constructor\n. description).\n. @param crossCheck If it is false, this is will be default BFMatcher behaviour when it finds the k\n. nearest neighbors for each query descriptor. If crossCheck==true, then the knnMatch() method with\n. k=1 will only return pairs (i,j) such that for i-th query descriptor the j-th descriptor in the\n. matcher's collection is the nearest and vice versa, i.e. the BFMatcher will only return consistent\n. pairs. Such technique usually produces best results with minimal number of outliers when there are\n. enough matches. This is alternative to the ratio test, used by D. Lowe in SIFT paper." ... - BORDER_CONSTANT: int BORDER_DEFAULT: int BORDER_ISOLATED: int @@ -73,13 +63,10 @@ BOWImgDescriptorExtractor = _mod_cv2.BOWImgDescriptorExtractor BOWKMeansTrainer = _mod_cv2.BOWKMeansTrainer BOWTrainer = _mod_cv2.BOWTrainer BRISK = _mod_cv2.BRISK - - def BRISK_create(thresh=..., octaves=..., patternScale=...) -> typing.Any: 'BRISK_create([, thresh[, octaves[, patternScale]]]) -> retval\n. @brief The BRISK constructor\n. \n. @param thresh AGAST detection threshold score.\n. @param octaves detection octaves. Use 0 to do single scale.\n. @param patternScale apply this scale to the pattern used for sampling the neighbourhood of a\n. keypoint.\n\n\n\nBRISK_create(radiusList, numberList[, dMax[, dMin[, indexChange]]]) -> retval\n. @brief The BRISK constructor for a custom pattern\n. \n. @param radiusList defines the radii (in pixels) where the samples around a keypoint are taken (for\n. keypoint scale 1).\n. @param numberList defines the number of sampling points on the sampling circle. Must be the same\n. size as radiusList..\n. @param dMax threshold for the short pairings used for descriptor formation (in pixels for keypoint\n. scale 1).\n. @param dMin threshold for the long pairings used for orientation determination (in pixels for\n. keypoint scale 1).\n. @param indexChange index remapping of the bits.\n\n\n\nBRISK_create(thresh, octaves, radiusList, numberList[, dMax[, dMin[, indexChange]]]) -> retval\n. @brief The BRISK constructor for a custom pattern, detection threshold and octaves\n. \n. @param thresh AGAST detection threshold score.\n. @param octaves detection octaves. Use 0 to do single scale.\n. @param radiusList defines the radii (in pixels) where the samples around a keypoint are taken (for\n. keypoint scale 1).\n. @param numberList defines the number of sampling points on the sampling circle. Must be the same\n. size as radiusList..\n. @param dMax threshold for the short pairings used for descriptor formation (in pixels for keypoint\n. scale 1).\n. @param dMin threshold for the long pairings used for orientation determination (in pixels for\n. keypoint scale 1).\n. @param indexChange index remapping of the bits.' ... - BackgroundSubtractor = _mod_cv2.BackgroundSubtractor BackgroundSubtractorKNN = _mod_cv2.BackgroundSubtractorKNN BackgroundSubtractorMOG2 = _mod_cv2.BackgroundSubtractorMOG2 @@ -830,26 +817,19 @@ CV_8UC4: int CalibrateCRF = _mod_cv2.CalibrateCRF CalibrateDebevec = _mod_cv2.CalibrateDebevec CalibrateRobertson = _mod_cv2.CalibrateRobertson - - def CamShift(probImage, window, criteria) -> typing.Any: 'CamShift(probImage, window, criteria) -> retval, window\n. @brief Finds an object center, size, and orientation.\n. \n. @param probImage Back projection of the object histogram. See calcBackProject.\n. @param window Initial search window.\n. @param criteria Stop criteria for the underlying meanShift.\n. returns\n. (in old interfaces) Number of iterations CAMSHIFT took to converge\n. The function implements the CAMSHIFT object tracking algorithm @cite Bradski98 . First, it finds an\n. object center using meanShift and then adjusts the window size and finds the optimal rotation. The\n. function returns the rotated rectangle structure that includes the object position, size, and\n. orientation. The next position of the search window can be obtained with RotatedRect::boundingRect()\n. \n. See the OpenCV sample camshiftdemo.c that tracks colored objects.\n. \n. @note\n. - (Python) A sample explaining the camshift tracking algorithm can be found at\n. opencv_source_code/samples/python/camshift.py' ... - -def Canny(image: ndarray, threshold1, threshold2, edges=..., apertureSize=..., L2gradient=...) -> typing.Any: +def Canny(image: Mat, threshold1, threshold2, edges=..., apertureSize=..., L2gradient=...) -> typing.Any: 'Canny(image, threshold1, threshold2[, edges[, apertureSize[, L2gradient]]]) -> edges\n. @brief Finds edges in an image using the Canny algorithm @cite Canny86 .\n. \n. The function finds edges in the input image and marks them in the output map edges using the\n. Canny algorithm. The smallest value between threshold1 and threshold2 is used for edge linking. The\n. largest value is used to find initial segments of strong edges. See\n. \n. \n. @param image 8-bit input image.\n. @param edges output edge map; single channels 8-bit image, which has the same size as image .\n. @param threshold1 first threshold for the hysteresis procedure.\n. @param threshold2 second threshold for the hysteresis procedure.\n. @param apertureSize aperture size for the Sobel operator.\n. @param L2gradient a flag, indicating whether a more accurate \\f$L_2\\f$ norm\n. \\f$=\\sqrt{(dI/dx)^2 + (dI/dy)^2}\\f$ should be used to calculate the image gradient magnitude (\n. L2gradient=true ), or whether the default \\f$L_1\\f$ norm \\f$=|dI/dx|+|dI/dy|\\f$ is enough (\n. L2gradient=false ).\n\n\n\nCanny(dx, dy, threshold1, threshold2[, edges[, L2gradient]]) -> edges\n. \\overload\n. \n. Finds edges in an image using the Canny algorithm with custom image gradient.\n. \n. @param dx 16-bit x derivative of input image (CV_16SC1 or CV_16SC3).\n. @param dy 16-bit y derivative of input image (same type as dx).\n. @param edges output edge map; single channels 8-bit image, which has the same size as image .\n. @param threshold1 first threshold for the hysteresis procedure.\n. @param threshold2 second threshold for the hysteresis procedure.\n. @param L2gradient a flag, indicating whether a more accurate \\f$L_2\\f$ norm\n. \\f$=\\sqrt{(dI/dx)^2 + (dI/dy)^2}\\f$ should be used to calculate the image gradient magnitude (\n. L2gradient=true ), or whether the default \\f$L_1\\f$ norm \\f$=|dI/dx|+|dI/dy|\\f$ is enough (\n. L2gradient=false ).' ... - CascadeClassifier = _mod_cv2.CascadeClassifier - - def CascadeClassifier_convert(oldcascade, newcascade) -> typing.Any: 'CascadeClassifier_convert(oldcascade, newcascade) -> retval\n.' ... - CirclesGridFinderParameters = _mod_cv2.CirclesGridFinderParameters CirclesGridFinderParameters_ASYMMETRIC_GRID: int CirclesGridFinderParameters_SYMMETRIC_GRID: int @@ -880,13 +860,10 @@ DISOpticalFlow = _mod_cv2.DISOpticalFlow DISOpticalFlow_PRESET_FAST: int DISOpticalFlow_PRESET_MEDIUM: int DISOpticalFlow_PRESET_ULTRAFAST: int - - def DISOpticalFlow_create(preset=...) -> typing.Any: 'DISOpticalFlow_create([, preset]) -> retval\n. @brief Creates an instance of DISOpticalFlow\n. \n. @param preset one of PRESET_ULTRAFAST, PRESET_FAST and PRESET_MEDIUM' ... - DIST_C: int DIST_FAIR: int DIST_HUBER: int @@ -913,24 +890,18 @@ DescriptorMatcher_BRUTEFORCE_HAMMINGLUT: int DescriptorMatcher_BRUTEFORCE_L1: int DescriptorMatcher_BRUTEFORCE_SL2: int DescriptorMatcher_FLANNBASED: int - - def DescriptorMatcher_create(descriptorMatcherType) -> typing.Any: 'DescriptorMatcher_create(descriptorMatcherType) -> retval\n. @brief Creates a descriptor matcher of a given type with the default parameters (using default\n. constructor).\n. \n. @param descriptorMatcherType Descriptor matcher type. Now the following matcher types are\n. supported:\n. - `BruteForce` (it uses L2 )\n. - `BruteForce-L1`\n. - `BruteForce-Hamming`\n. - `BruteForce-Hamming(2)`\n. - `FlannBased`\n\n\n\nDescriptorMatcher_create(matcherType) -> retval\n.' ... - DrawMatchesFlags_DEFAULT: int DrawMatchesFlags_DRAW_OVER_OUTIMG: int DrawMatchesFlags_DRAW_RICH_KEYPOINTS: int DrawMatchesFlags_NOT_DRAW_SINGLE_POINTS: int - - def EMD(signature1, signature2, distType, cost=..., lowerBound=..., flow=...) -> typing.Any: 'EMD(signature1, signature2, distType[, cost[, lowerBound[, flow]]]) -> retval, lowerBound, flow\n. @brief Computes the "minimal work" distance between two weighted point configurations.\n. \n. The function computes the earth mover distance and/or a lower boundary of the distance between the\n. two weighted point configurations. One of the applications described in @cite RubnerSept98,\n. @cite Rubner2000 is multi-dimensional histogram comparison for image retrieval. EMD is a transportation\n. problem that is solved using some modification of a simplex algorithm, thus the complexity is\n. exponential in the worst case, though, on average it is much faster. In the case of a real metric\n. the lower boundary can be calculated even faster (using linear-time algorithm) and it can be used\n. to determine roughly whether the two signatures are far enough so that they cannot relate to the\n. same object.\n. \n. @param signature1 First signature, a \\f$\\texttt{size1}\\times \\texttt{dims}+1\\f$ floating-point matrix.\n. Each row stores the point weight followed by the point coordinates. The matrix is allowed to have\n. a single column (weights only) if the user-defined cost matrix is used. The weights must be\n. non-negative and have at least one non-zero value.\n. @param signature2 Second signature of the same format as signature1 , though the number of rows\n. may be different. The total weights may be different. In this case an extra "dummy" point is added\n. to either signature1 or signature2. The weights must be non-negative and have at least one non-zero\n. value.\n. @param distType Used metric. See #DistanceTypes.\n. @param cost User-defined \\f$\\texttt{size1}\\times \\texttt{size2}\\f$ cost matrix. Also, if a cost matrix\n. is used, lower boundary lowerBound cannot be calculated because it needs a metric function.\n. @param lowerBound Optional input/output parameter: lower boundary of a distance between the two\n. signatures that is a distance between mass centers. The lower boundary may not be calculated if\n. the user-defined cost matrix is used, the total weights of point configurations are not equal, or\n. if the signatures consist of weights only (the signature matrices have a single column). You\n. **must** initialize \\*lowerBound . If the calculated distance between mass centers is greater or\n. equal to \\*lowerBound (it means that the signatures are far enough), the function does not\n. calculate EMD. In any case \\*lowerBound is set to the calculated distance between mass centers on\n. return. Thus, if you want to calculate both distance between mass centers and EMD, \\*lowerBound\n. should be set to 0.\n. @param flow Resultant \\f$\\texttt{size1} \\times \\texttt{size2}\\f$ flow matrix: \\f$\\texttt{flow}_{i,j}\\f$ is\n. a flow from \\f$i\\f$ -th point of signature1 to \\f$j\\f$ -th point of signature2 .' ... - EVENT_FLAG_ALTKEY: int EVENT_FLAG_CTRLKEY: int EVENT_FLAG_LBUTTON: int @@ -1007,13 +978,10 @@ FORMATTER_FMT_MATLAB: int FORMATTER_FMT_NUMPY: int FORMATTER_FMT_PYTHON: int FarnebackOpticalFlow = _mod_cv2.FarnebackOpticalFlow - - def FarnebackOpticalFlow_create(numLevels=..., pyrScale=..., fastPyramids=..., winSize=..., numIters=..., polyN=..., polySigma=..., flags: int = ...) -> typing.Any: 'FarnebackOpticalFlow_create([, numLevels[, pyrScale[, fastPyramids[, winSize[, numIters[, polyN[, polySigma[, flags]]]]]]]]) -> retval\n.' ... - FastFeatureDetector = _mod_cv2.FastFeatureDetector FastFeatureDetector_FAST_N: int FastFeatureDetector_NONMAX_SUPPRESSION: int @@ -1021,13 +989,10 @@ FastFeatureDetector_THRESHOLD: int FastFeatureDetector_TYPE_5_8: int FastFeatureDetector_TYPE_7_12: int FastFeatureDetector_TYPE_9_16: int - - def FastFeatureDetector_create(threshold=..., nonmaxSuppression=..., type=...) -> typing.Any: 'FastFeatureDetector_create([, threshold[, nonmaxSuppression[, type]]]) -> retval\n.' ... - Feature2D = _mod_cv2.Feature2D FileNode = _mod_cv2.FileNode FileNode_EMPTY: int @@ -1060,13 +1025,10 @@ FileStorage_VALUE_EXPECTED: int FileStorage_WRITE: int FileStorage_WRITE_BASE64: int FlannBasedMatcher = _mod_cv2.FlannBasedMatcher - - def FlannBasedMatcher_create() -> typing.Any: 'FlannBasedMatcher_create() -> retval\n.' ... - Formatter_FMT_C: int Formatter_FMT_CSV: int Formatter_FMT_DEFAULT: int @@ -1085,18 +1047,14 @@ GEMM_1_T: int GEMM_2_T: int GEMM_3_T: int GFTTDetector = _mod_cv2.GFTTDetector - - def GFTTDetector_create(maxCorners=..., qualityLevel=..., minDistance=..., blockSize=..., useHarrisDetector=..., k=...) -> typing.Any: 'GFTTDetector_create([, maxCorners[, qualityLevel[, minDistance[, blockSize[, useHarrisDetector[, k]]]]]]) -> retval\n. \n\n\n\nGFTTDetector_create(maxCorners, qualityLevel, minDistance, blockSize, gradiantSize[, useHarrisDetector[, k]]) -> retval\n.' ... - -def GaussianBlur(src: ndarray, ksize, sigmaX, dts: ndarray = ..., sigmaY=..., borderType=...) -> typing.Any: +def GaussianBlur(src: Mat, ksize, sigmaX, dts: Mat = ..., sigmaY=..., borderType=...) -> typing.Any: "GaussianBlur(src, ksize, sigmaX[, dst[, sigmaY[, borderType]]]) -> dst\n. @brief Blurs an image using a Gaussian filter.\n. \n. The function convolves the source image with the specified Gaussian kernel. In-place filtering is\n. supported.\n. \n. @param src input image; the image can have any number of channels, which are processed\n. independently, but the depth should be CV_8U, CV_16U, CV_16S, CV_32F or CV_64F.\n. @param dst output image of the same size and type as src.\n. @param ksize Gaussian kernel size. ksize.width and ksize.height can differ but they both must be\n. positive and odd. Or, they can be zero's and then they are computed from sigma.\n. @param sigmaX Gaussian kernel standard deviation in X direction.\n. @param sigmaY Gaussian kernel standard deviation in Y direction; if sigmaY is zero, it is set to be\n. equal to sigmaX, if both sigmas are zeros, they are computed from ksize.width and ksize.height,\n. respectively (see #getGaussianKernel for details); to fully control the result regardless of\n. possible future modifications of all this semantics, it is recommended to specify all of ksize,\n. sigmaX, and sigmaY.\n. @param borderType pixel extrapolation method, see #BorderTypes. #BORDER_WRAP is not supported.\n. \n. @sa sepFilter2D, filter2D, blur, boxFilter, bilateralFilter, medianBlur" ... - GeneralizedHough = _mod_cv2.GeneralizedHough GeneralizedHoughBallard = _mod_cv2.GeneralizedHoughBallard GeneralizedHoughGuil = _mod_cv2.GeneralizedHoughGuil @@ -1116,50 +1074,39 @@ HOGDescriptor_DEFAULT_NLEVELS: int HOGDescriptor_DESCR_FORMAT_COL_BY_COL: int HOGDescriptor_DESCR_FORMAT_ROW_BY_ROW: int HOGDescriptor_L2Hys: int - - def HOGDescriptor_getDaimlerPeopleDetector() -> typing.Any: 'HOGDescriptor_getDaimlerPeopleDetector() -> retval\n. @brief Returns coefficients of the classifier trained for people detection (for 48x96 windows).' ... - def HOGDescriptor_getDefaultPeopleDetector() -> typing.Any: 'HOGDescriptor_getDefaultPeopleDetector() -> retval\n. @brief Returns coefficients of the classifier trained for people detection (for 64x128 windows).' ... - HOUGH_GRADIENT: int HOUGH_GRADIENT_ALT: int HOUGH_MULTI_SCALE: int HOUGH_PROBABILISTIC: int HOUGH_STANDARD: int - - -def HoughCircles(image: ndarray, method: int, dp, minDist, circles=..., param1=..., param2=..., minRadius=..., maxRadius=...) -> typing.Any: +def HoughCircles(image: Mat, method: int, dp, minDist, circles=..., param1=..., param2=..., minRadius=..., maxRadius=...) -> typing.Any: 'HoughCircles(image, method, dp, minDist[, circles[, param1[, param2[, minRadius[, maxRadius]]]]]) -> circles\n. @brief Finds circles in a grayscale image using the Hough transform.\n. \n. The function finds circles in a grayscale image using a modification of the Hough transform.\n. \n. Example: :\n. @include snippets/imgproc_HoughLinesCircles.cpp\n. \n. @note Usually the function detects the centers of circles well. However, it may fail to find correct\n. radii. You can assist to the function by specifying the radius range ( minRadius and maxRadius ) if\n. you know it. Or, in the case of #HOUGH_GRADIENT method you may set maxRadius to a negative number\n. to return centers only without radius search, and find the correct radius using an additional procedure.\n. \n. It also helps to smooth image a bit unless it\'s already soft. For example,\n. GaussianBlur() with 7x7 kernel and 1.5x1.5 sigma or similar blurring may help.\n. \n. @param image 8-bit, single-channel, grayscale input image.\n. @param circles Output vector of found circles. Each vector is encoded as 3 or 4 element\n. floating-point vector \\f$(x, y, radius)\\f$ or \\f$(x, y, radius, votes)\\f$ .\n. @param method Detection method, see #HoughModes. The available methods are #HOUGH_GRADIENT and #HOUGH_GRADIENT_ALT.\n. @param dp Inverse ratio of the accumulator resolution to the image resolution. For example, if\n. dp=1 , the accumulator has the same resolution as the input image. If dp=2 , the accumulator has\n. half as big width and height. For #HOUGH_GRADIENT_ALT the recommended value is dp=1.5,\n. unless some small very circles need to be detected.\n. @param minDist Minimum distance between the centers of the detected circles. If the parameter is\n. too small, multiple neighbor circles may be falsely detected in addition to a true one. If it is\n. too large, some circles may be missed.\n. @param param1 First method-specific parameter. In case of #HOUGH_GRADIENT and #HOUGH_GRADIENT_ALT,\n. it is the higher threshold of the two passed to the Canny edge detector (the lower one is twice smaller).\n. Note that #HOUGH_GRADIENT_ALT uses #Scharr algorithm to compute image derivatives, so the threshold value\n. shough normally be higher, such as 300 or normally exposed and contrasty images.\n. @param param2 Second method-specific parameter. In case of #HOUGH_GRADIENT, it is the\n. accumulator threshold for the circle centers at the detection stage. The smaller it is, the more\n. false circles may be detected. Circles, corresponding to the larger accumulator values, will be\n. returned first. In the case of #HOUGH_GRADIENT_ALT algorithm, this is the circle "perfectness" measure.\n. The closer it to 1, the better shaped circles algorithm selects. In most cases 0.9 should be fine.\n. If you want get better detection of small circles, you may decrease it to 0.85, 0.8 or even less.\n. But then also try to limit the search range [minRadius, maxRadius] to avoid many false circles.\n. @param minRadius Minimum circle radius.\n. @param maxRadius Maximum circle radius. If <= 0, uses the maximum image dimension. If < 0, #HOUGH_GRADIENT returns\n. centers without finding the radius. #HOUGH_GRADIENT_ALT always computes circle radiuses.\n. \n. @sa fitEllipse, minEnclosingCircle' ... - -def HoughLines(image: ndarray, rho, theta, threshold, lines=..., srn=..., stn=..., min_theta=..., max_theta=...) -> typing.Any: +def HoughLines(image: Mat, rho, theta, threshold, lines=..., srn=..., stn=..., min_theta=..., max_theta=...) -> typing.Any: 'HoughLines(image, rho, theta, threshold[, lines[, srn[, stn[, min_theta[, max_theta]]]]]) -> lines\n. @brief Finds lines in a binary image using the standard Hough transform.\n. \n. The function implements the standard or standard multi-scale Hough transform algorithm for line\n. detection. See for a good explanation of Hough\n. transform.\n. \n. @param image 8-bit, single-channel binary source image. The image may be modified by the function.\n. @param lines Output vector of lines. Each line is represented by a 2 or 3 element vector\n. \\f$(\\rho, \\theta)\\f$ or \\f$(\\rho, \\theta, \\textrm{votes})\\f$ . \\f$\\rho\\f$ is the distance from the coordinate origin \\f$(0,0)\\f$ (top-left corner of\n. the image). \\f$\\theta\\f$ is the line rotation angle in radians (\n. \\f$0 \\sim \\textrm{vertical line}, \\pi/2 \\sim \\textrm{horizontal line}\\f$ ).\n. \\f$\\textrm{votes}\\f$ is the value of accumulator.\n. @param rho Distance resolution of the accumulator in pixels.\n. @param theta Angle resolution of the accumulator in radians.\n. @param threshold Accumulator threshold parameter. Only those lines are returned that get enough\n. votes ( \\f$>\\texttt{threshold}\\f$ ).\n. @param srn For the multi-scale Hough transform, it is a divisor for the distance resolution rho .\n. The coarse accumulator distance resolution is rho and the accurate accumulator resolution is\n. rho/srn . If both srn=0 and stn=0 , the classical Hough transform is used. Otherwise, both these\n. parameters should be positive.\n. @param stn For the multi-scale Hough transform, it is a divisor for the distance resolution theta.\n. @param min_theta For standard and multi-scale Hough transform, minimum angle to check for lines.\n. Must fall between 0 and max_theta.\n. @param max_theta For standard and multi-scale Hough transform, maximum angle to check for lines.\n. Must fall between min_theta and CV_PI.' ... - -def HoughLinesP(image: ndarray, rho, theta, threshold, lines=..., minLineLength=..., maxLineGap=...) -> typing.Any: +def HoughLinesP(image: Mat, rho, theta, threshold, lines=..., minLineLength=..., maxLineGap=...) -> typing.Any: 'HoughLinesP(image, rho, theta, threshold[, lines[, minLineLength[, maxLineGap]]]) -> lines\n. @brief Finds line segments in a binary image using the probabilistic Hough transform.\n. \n. The function implements the probabilistic Hough transform algorithm for line detection, described\n. in @cite Matas00\n. \n. See the line detection example below:\n. @include snippets/imgproc_HoughLinesP.cpp\n. This is a sample picture the function parameters have been tuned for:\n. \n. ![image](pics/building.jpg)\n. \n. And this is the output of the above program in case of the probabilistic Hough transform:\n. \n. ![image](pics/houghp.png)\n. \n. @param image 8-bit, single-channel binary source image. The image may be modified by the function.\n. @param lines Output vector of lines. Each line is represented by a 4-element vector\n. \\f$(x_1, y_1, x_2, y_2)\\f$ , where \\f$(x_1,y_1)\\f$ and \\f$(x_2, y_2)\\f$ are the ending points of each detected\n. line segment.\n. @param rho Distance resolution of the accumulator in pixels.\n. @param theta Angle resolution of the accumulator in radians.\n. @param threshold Accumulator threshold parameter. Only those lines are returned that get enough\n. votes ( \\f$>\\texttt{threshold}\\f$ ).\n. @param minLineLength Minimum line length. Line segments shorter than that are rejected.\n. @param maxLineGap Maximum allowed gap between points on the same line to link them.\n. \n. @sa LineSegmentDetector' ... - def HoughLinesPointSet(_point, lines_max, threshold, min_rho, max_rho, rho_step, min_theta, max_theta, theta_step, _lines=...) -> typing.Any: "HoughLinesPointSet(_point, lines_max, threshold, min_rho, max_rho, rho_step, min_theta, max_theta, theta_step[, _lines]) -> _lines\n. @brief Finds lines in a set of points using the standard Hough transform.\n. \n. The function finds lines in a set of points using a modification of the Hough transform.\n. @include snippets/imgproc_HoughLinesPointSet.cpp\n. @param _point Input vector of points. Each vector must be encoded as a Point vector \\f$(x,y)\\f$. Type must be CV_32FC2 or CV_32SC2.\n. @param _lines Output vector of found lines. Each vector is encoded as a vector \\f$(votes, rho, theta)\\f$.\n. The larger the value of 'votes', the higher the reliability of the Hough line.\n. @param lines_max Max count of hough lines.\n. @param threshold Accumulator threshold parameter. Only those lines are returned that get enough\n. votes ( \\f$>\\texttt{threshold}\\f$ )\n. @param min_rho Minimum Distance value of the accumulator in pixels.\n. @param max_rho Maximum Distance value of the accumulator in pixels.\n. @param rho_step Distance resolution of the accumulator in pixels.\n. @param min_theta Minimum angle value of the accumulator in radians.\n. @param max_theta Maximum angle value of the accumulator in radians.\n. @param theta_step Angle resolution of the accumulator in radians." ... - def HuMoments(m, hu=...) -> typing.Any: 'HuMoments(m[, hu]) -> hu\n. @overload' ... - IMREAD_ANYCOLOR: int IMREAD_ANYDEPTH: int IMREAD_COLOR: int @@ -1225,30 +1172,23 @@ KAZE_DIFF_CHARBONNIER: int KAZE_DIFF_PM_G1: int KAZE_DIFF_PM_G2: int KAZE_DIFF_WEICKERT: int - - def KAZE_create(extended=..., upright=..., threshold=..., nOctaves=..., nOctaveLayers=..., diffusivity=...) -> typing.Any: 'KAZE_create([, extended[, upright[, threshold[, nOctaves[, nOctaveLayers[, diffusivity]]]]]]) -> retval\n. @brief The KAZE constructor\n. \n. @param extended Set to enable extraction of extended (128-byte) descriptor.\n. @param upright Set to enable use of upright descriptors (non rotation-invariant).\n. @param threshold Detector response threshold to accept point\n. @param nOctaves Maximum octave evolution of the image\n. @param nOctaveLayers Default number of sublevels per scale level\n. @param diffusivity Diffusivity type. DIFF_PM_G1, DIFF_PM_G2, DIFF_WEICKERT or\n. DIFF_CHARBONNIER' ... - KMEANS_PP_CENTERS: int KMEANS_RANDOM_CENTERS: int KMEANS_USE_INITIAL_LABELS: int KalmanFilter = _mod_cv2.KalmanFilter KeyPoint = _mod_cv2.KeyPoint - - def KeyPoint_convert(keypoints, keypointIndexes=...) -> typing.Any: 'KeyPoint_convert(keypoints[, keypointIndexes]) -> points2f\n. This method converts vector of keypoints to vector of points or the reverse, where each keypoint is\n. assigned the same size and the same orientation.\n. \n. @param keypoints Keypoints obtained from any feature detection algorithm like SIFT/SURF/ORB\n. @param points2f Array of (x,y) coordinates of each keypoint\n. @param keypointIndexes Array of indexes of keypoints to be converted to points. (Acts like a mask to\n. convert only specified keypoints)\n\n\n\nKeyPoint_convert(points2f[, size[, response[, octave[, class_id]]]]) -> keypoints\n. @overload\n. @param points2f Array of (x,y) coordinates of each keypoint\n. @param keypoints Keypoints obtained from any feature detection algorithm like SIFT/SURF/ORB\n. @param size keypoint diameter\n. @param response keypoint detector response on the keypoint (that is, strength of the keypoint)\n. @param octave pyramid octave in which the keypoint has been detected\n. @param class_id object id' ... - def KeyPoint_overlap(kp1, kp2) -> typing.Any: "KeyPoint_overlap(kp1, kp2) -> retval\n. This method computes overlap for pair of keypoints. Overlap is the ratio between area of keypoint\n. regions' intersection and area of keypoint regions' union (considering keypoint region as circle).\n. If they don't overlap, we get zero. If they coincide at same location with same size, we get 1.\n. @param kp1 First keypoint\n. @param kp2 Second keypoint" ... - LDR_SIZE: int LINE_4: int LINE_8: int @@ -1257,18 +1197,14 @@ LMEDS: int LSD_REFINE_ADV: int LSD_REFINE_NONE: int LSD_REFINE_STD: int - - -def LUT(src: ndarray, lut, dts: ndarray = ...) -> typing.Any: +def LUT(src: Mat, lut, dts: Mat = ...) -> typing.Any: 'LUT(src, lut[, dst]) -> dst\n. @brief Performs a look-up table transform of an array.\n. \n. The function LUT fills the output array with values from the look-up table. Indices of the entries\n. are taken from the input array. That is, the function processes each element of src as follows:\n. \\f[\\texttt{dst} (I) \\leftarrow \\texttt{lut(src(I) + d)}\\f]\n. where\n. \\f[d = \\fork{0}{if \\(\\texttt{src}\\) has depth \\(\\texttt{CV_8U}\\)}{128}{if \\(\\texttt{src}\\) has depth \\(\\texttt{CV_8S}\\)}\\f]\n. @param src input array of 8-bit elements.\n. @param lut look-up table of 256 elements; in case of multi-channel input array, the table should\n. either have a single channel (in this case the same table is used for all channels) or the same\n. number of channels as in the input array.\n. @param dst output array of the same size and number of channels as src, and the same depth as lut.\n. @sa convertScaleAbs, Mat::convertTo' ... - -def Laplacian(src: ndarray, ddepth, dts: ndarray = ..., ksize=..., scale=..., delta=..., borderType=...) -> typing.Any: +def Laplacian(src: Mat, ddepth, dts: Mat = ..., ksize=..., scale=..., delta=..., borderType=...) -> typing.Any: 'Laplacian(src, ddepth[, dst[, ksize[, scale[, delta[, borderType]]]]]) -> dst\n. @brief Calculates the Laplacian of an image.\n. \n. The function calculates the Laplacian of the source image by adding up the second x and y\n. derivatives calculated using the Sobel operator:\n. \n. \\f[\\texttt{dst} = \\Delta \\texttt{src} = \\frac{\\partial^2 \\texttt{src}}{\\partial x^2} + \\frac{\\partial^2 \\texttt{src}}{\\partial y^2}\\f]\n. \n. This is done when `ksize > 1`. When `ksize == 1`, the Laplacian is computed by filtering the image\n. with the following \\f$3 \\times 3\\f$ aperture:\n. \n. \\f[\\vecthreethree {0}{1}{0}{1}{-4}{1}{0}{1}{0}\\f]\n. \n. @param src Source image.\n. @param dst Destination image of the same size and the same number of channels as src .\n. @param ddepth Desired depth of the destination image.\n. @param ksize Aperture size used to compute the second-derivative filters. See #getDerivKernels for\n. details. The size must be positive and odd.\n. @param scale Optional scale factor for the computed Laplacian values. By default, no scaling is\n. applied. See #getDerivKernels for details.\n. @param delta Optional delta value that is added to the results prior to storing them in dst .\n. @param borderType Pixel extrapolation method, see #BorderTypes. #BORDER_WRAP is not supported.\n. @sa Sobel, Scharr' ... - LineSegmentDetector = _mod_cv2.LineSegmentDetector MARKER_CROSS: int MARKER_DIAMOND: int @@ -1302,18 +1238,14 @@ MOTION_EUCLIDEAN: int MOTION_HOMOGRAPHY: int MOTION_TRANSLATION: int MSER = _mod_cv2.MSER - - def MSER_create(_delta=..., _min_area=..., _max_area=..., _max_variation=..., _min_diversity=..., _max_evolution=..., _area_threshold=..., _min_margin=..., _edge_blur_size=...) -> typing.Any: 'MSER_create([, _delta[, _min_area[, _max_area[, _max_variation[, _min_diversity[, _max_evolution[, _area_threshold[, _min_margin[, _edge_blur_size]]]]]]]]]) -> retval\n. @brief Full constructor for %MSER detector\n. \n. @param _delta it compares \\f$(size_{i}-size_{i-delta})/size_{i-delta}\\f$\n. @param _min_area prune the area which smaller than minArea\n. @param _max_area prune the area which bigger than maxArea\n. @param _max_variation prune the area have similar size to its children\n. @param _min_diversity for color image, trace back to cut off mser with diversity less than min_diversity\n. @param _max_evolution for color image, the evolution steps\n. @param _area_threshold for color image, the area threshold to cause re-initialize\n. @param _min_margin for color image, ignore too small margin\n. @param _edge_blur_size for color image, the aperture size for edge blur' ... - def Mahalanobis(v1, v2, icovar) -> typing.Any: 'Mahalanobis(v1, v2, icovar) -> retval\n. @brief Calculates the Mahalanobis distance between two vectors.\n. \n. The function cv::Mahalanobis calculates and returns the weighted distance between two vectors:\n. \\f[d( \\texttt{vec1} , \\texttt{vec2} )= \\sqrt{\\sum_{i,j}{\\texttt{icovar(i,j)}\\cdot(\\texttt{vec1}(I)-\\texttt{vec2}(I))\\cdot(\\texttt{vec1(j)}-\\texttt{vec2(j)})} }\\f]\n. The covariance matrix may be calculated using the #calcCovarMatrix function and then inverted using\n. the invert function (preferably using the #DECOMP_SVD method, as the most accurate).\n. @param v1 first 1D input vector.\n. @param v2 second 1D input vector.\n. @param icovar inverse covariance matrix.' ... - Mat_AUTO_STEP: int Mat_CONTINUOUS_FLAG: int Mat_DEPTH_MASK: int @@ -1342,13 +1274,10 @@ OPTFLOW_USE_INITIAL_FLOW: int ORB = _mod_cv2.ORB ORB_FAST_SCORE: int ORB_HARRIS_SCORE: int - - def ORB_create(nfeatures=..., scaleFactor=..., nlevels=..., edgeThreshold=..., firstLevel=..., WTA_K=..., scoreType=..., patchSize=..., fastThreshold=...) -> typing.Any: 'ORB_create([, nfeatures[, scaleFactor[, nlevels[, edgeThreshold[, firstLevel[, WTA_K[, scoreType[, patchSize[, fastThreshold]]]]]]]]]) -> retval\n. @brief The ORB constructor\n. \n. @param nfeatures The maximum number of features to retain.\n. @param scaleFactor Pyramid decimation ratio, greater than 1. scaleFactor==2 means the classical\n. pyramid, where each next level has 4x less pixels than the previous, but such a big scale factor\n. will degrade feature matching scores dramatically. On the other hand, too close to 1 scale factor\n. will mean that to cover certain scale range you will need more pyramid levels and so the speed\n. will suffer.\n. @param nlevels The number of pyramid levels. The smallest level will have linear size equal to\n. input_image_linear_size/pow(scaleFactor, nlevels - firstLevel).\n. @param edgeThreshold This is size of the border where the features are not detected. It should\n. roughly match the patchSize parameter.\n. @param firstLevel The level of pyramid to put source image to. Previous layers are filled\n. with upscaled source image.\n. @param WTA_K The number of points that produce each element of the oriented BRIEF descriptor. The\n. default value 2 means the BRIEF where we take a random point pair and compare their brightnesses,\n. so we get 0/1 response. Other possible values are 3 and 4. For example, 3 means that we take 3\n. random points (of course, those point coordinates are random, but they are generated from the\n. pre-defined seed, so each element of BRIEF descriptor is computed deterministically from the pixel\n. rectangle), find point of maximum brightness and output index of the winner (0, 1 or 2). Such\n. output will occupy 2 bits, and therefore it will need a special variant of Hamming distance,\n. denoted as NORM_HAMMING2 (2 bits per bin). When WTA_K=4, we take 4 random points to compute each\n. bin (that will also occupy 2 bits with possible values 0, 1, 2 or 3).\n. @param scoreType The default HARRIS_SCORE means that Harris algorithm is used to rank features\n. (the score is written to KeyPoint::score and is used to retain best nfeatures features);\n. FAST_SCORE is alternative value of the parameter that produces slightly less stable keypoints,\n. but it is a little faster to compute.\n. @param patchSize size of the patch used by the oriented BRIEF descriptor. Of course, on smaller\n. pyramid layers the perceived image area covered by a feature will be larger.\n. @param fastThreshold the fast threshold' ... - PARAM_ALGORITHM: int PARAM_BOOLEAN: int PARAM_FLOAT: int @@ -1361,40 +1290,31 @@ PARAM_STRING: int PARAM_UCHAR: int PARAM_UINT64: int PARAM_UNSIGNED_INT: int - - def PCABackProject(data, mean, eigenvectors, result=...) -> typing.Any: 'PCABackProject(data, mean, eigenvectors[, result]) -> result\n. wrap PCA::backProject' ... - def PCACompute(data, mean, eigenvectors=..., maxComponents=...) -> typing.Any: 'PCACompute(data, mean[, eigenvectors[, maxComponents]]) -> mean, eigenvectors\n. wrap PCA::operator()\n\n\n\nPCACompute(data, mean, retainedVariance[, eigenvectors]) -> mean, eigenvectors\n. wrap PCA::operator()' ... - def PCACompute2(data, mean, eigenvectors=..., eigenvalues=..., maxComponents=...) -> typing.Any: 'PCACompute2(data, mean[, eigenvectors[, eigenvalues[, maxComponents]]]) -> mean, eigenvectors, eigenvalues\n. wrap PCA::operator() and add eigenvalues output parameter\n\n\n\nPCACompute2(data, mean, retainedVariance[, eigenvectors[, eigenvalues]]) -> mean, eigenvectors, eigenvalues\n. wrap PCA::operator() and add eigenvalues output parameter' ... - def PCAProject(data, mean, eigenvectors, result=...) -> typing.Any: 'PCAProject(data, mean, eigenvectors[, result]) -> result\n. wrap PCA::project' ... - PCA_DATA_AS_COL: int PCA_DATA_AS_ROW: int PCA_USE_AVG: int PROJ_SPHERICAL_EQRECT: int PROJ_SPHERICAL_ORTHO: int - - -def PSNR(src1: ndarray, src2: ndarray, R=...) -> typing.Any: +def PSNR(src1: Mat, src2: Mat, R=...) -> typing.Any: 'PSNR(src1, src2[, R]) -> retval\n. @brief Computes the Peak Signal-to-Noise Ratio (PSNR) image quality metric.\n. \n. This function calculates the Peak Signal-to-Noise Ratio (PSNR) image quality metric in decibels (dB),\n. between two input arrays src1 and src2. The arrays must have the same type.\n. \n. The PSNR is calculated as follows:\n. \n. \\f[\n. \\texttt{PSNR} = 10 \\cdot \\log_{10}{\\left( \\frac{R^2}{MSE} \\right) }\n. \\f]\n. \n. where R is the maximum integer value of depth (e.g. 255 in the case of CV_8U data)\n. and MSE is the mean squared error between the two arrays.\n. \n. @param src1 first input array.\n. @param src2 second input array of the same size as src1.\n. @param R the maximum pixel value (255 by default)' ... - Param_ALGORITHM: int Param_BOOLEAN: int Param_FLOAT: int @@ -1438,26 +1358,19 @@ RNG_UNIFORM: int ROTATE_180: int ROTATE_90_CLOCKWISE: int ROTATE_90_COUNTERCLOCKWISE: int - - -def RQDecomp3x3(src: ndarray, mtxR=..., mtxQ=..., Qx=..., Qy=..., Qz=...) -> typing.Any: +def RQDecomp3x3(src: Mat, mtxR=..., mtxQ=..., Qx=..., Qy=..., Qz=...) -> typing.Any: 'RQDecomp3x3(src[, mtxR[, mtxQ[, Qx[, Qy[, Qz]]]]]) -> retval, mtxR, mtxQ, Qx, Qy, Qz\n. @brief Computes an RQ decomposition of 3x3 matrices.\n. \n. @param src 3x3 input matrix.\n. @param mtxR Output 3x3 upper-triangular matrix.\n. @param mtxQ Output 3x3 orthogonal matrix.\n. @param Qx Optional output 3x3 rotation matrix around x-axis.\n. @param Qy Optional output 3x3 rotation matrix around y-axis.\n. @param Qz Optional output 3x3 rotation matrix around z-axis.\n. \n. The function computes a RQ decomposition using the given rotations. This function is used in\n. decomposeProjectionMatrix to decompose the left 3x3 submatrix of a projection matrix into a camera\n. and a rotation matrix.\n. \n. It optionally returns three rotation matrices, one for each axis, and the three Euler angles in\n. degrees (as the return value) that could be used in OpenGL. Note, there is always more than one\n. sequence of rotations about the three principal axes that results in the same orientation of an\n. object, e.g. see @cite Slabaugh . Returned tree rotation matrices and corresponding three Euler angles\n. are only one of the possible solutions.' ... - -def Rodrigues(src: ndarray, dts: ndarray = ..., jacobian=...) -> typing.Any: +def Rodrigues(src: Mat, dts: Mat = ..., jacobian=...) -> typing.Any: 'Rodrigues(src[, dst[, jacobian]]) -> dst, jacobian\n. @brief Converts a rotation matrix to a rotation vector or vice versa.\n. \n. @param src Input rotation vector (3x1 or 1x3) or rotation matrix (3x3).\n. @param dst Output rotation matrix (3x3) or rotation vector (3x1 or 1x3), respectively.\n. @param jacobian Optional output Jacobian matrix, 3x9 or 9x3, which is a matrix of partial\n. derivatives of the output array components with respect to the input array components.\n. \n. \\f[\\begin{array}{l} \\theta \\leftarrow norm(r) \\\\ r \\leftarrow r/ \\theta \\\\ R = \\cos(\\theta) I + (1- \\cos{\\theta} ) r r^T + \\sin(\\theta) \\vecthreethree{0}{-r_z}{r_y}{r_z}{0}{-r_x}{-r_y}{r_x}{0} \\end{array}\\f]\n. \n. Inverse transformation can be also done easily, since\n. \n. \\f[\\sin ( \\theta ) \\vecthreethree{0}{-r_z}{r_y}{r_z}{0}{-r_x}{-r_y}{r_x}{0} = \\frac{R - R^T}{2}\\f]\n. \n. A rotation vector is a convenient and most compact representation of a rotation matrix (since any\n. rotation matrix has just 3 degrees of freedom). The representation is used in the global 3D geometry\n. optimization procedures like @ref calibrateCamera, @ref stereoCalibrate, or @ref solvePnP .\n. \n. @note More information about the computation of the derivative of a 3D rotation matrix with respect to its exponential coordinate\n. can be found in:\n. - A Compact Formula for the Derivative of a 3-D Rotation in Exponential Coordinates, Guillermo Gallego, Anthony J. Yezzi @cite Gallego2014ACF\n. \n. @note Useful information on SE(3) and Lie Groups can be found in:\n. - A tutorial on SE(3) transformation parameterizations and on-manifold optimization, Jose-Luis Blanco @cite blanco2010tutorial\n. - Lie Groups for 2D and 3D Transformation, Ethan Eade @cite Eade17\n. - A micro Lie theory for state estimation in robotics, Joan Solà, Jérémie Deray, Dinesh Atchuthan @cite Sol2018AML' ... - SIFT = _mod_cv2.SIFT - - def SIFT_create(nfeatures=..., nOctaveLayers=..., contrastThreshold=..., edgeThreshold=..., sigma=...) -> typing.Any: 'SIFT_create([, nfeatures[, nOctaveLayers[, contrastThreshold[, edgeThreshold[, sigma]]]]]) -> retval\n. @param nfeatures The number of best features to retain. The features are ranked by their scores\n. (measured in SIFT algorithm as the local contrast)\n. \n. @param nOctaveLayers The number of layers in each octave. 3 is the value used in D. Lowe paper. The\n. number of octaves is computed automatically from the image resolution.\n. \n. @param contrastThreshold The contrast threshold used to filter out weak features in semi-uniform\n. (low-contrast) regions. The larger the threshold, the less features are produced by the detector.\n. \n. @note The contrast threshold will be divided by nOctaveLayers when the filtering is applied. When\n. nOctaveLayers is set to default and if you want to use the value used in D. Lowe paper, 0.03, set\n. this argument to 0.09.\n. \n. @param edgeThreshold The threshold used to filter out edge-like features. Note that the its meaning\n. is different from the contrastThreshold, i.e. the larger the edgeThreshold, the less features are\n. filtered out (more features are retained).\n. \n. @param sigma The sigma of the Gaussian applied to the input image at the octave \\#0. If your image\n. is captured with a weak camera with soft lenses, you might want to reduce the number.' ... - SOLVELP_MULTI: int SOLVELP_SINGLE: int SOLVELP_UNBOUNDED: int @@ -1506,65 +1419,48 @@ SUBDIV2D_PTLOC_INSIDE: int SUBDIV2D_PTLOC_ON_EDGE: int SUBDIV2D_PTLOC_OUTSIDE_RECT: int SUBDIV2D_PTLOC_VERTEX: int - - -def SVBackSubst(w, u, vt, rhs, dts: ndarray = ...) -> typing.Any: +def SVBackSubst(w, u, vt, rhs, dts: Mat = ...) -> typing.Any: 'SVBackSubst(w, u, vt, rhs[, dst]) -> dst\n. wrap SVD::backSubst' ... - SVD_FULL_UV: int SVD_MODIFY_A: int SVD_NO_UV: int - - -def SVDecomp(src: ndarray, w=..., u=..., vt=..., flags: int = ...) -> typing.Any: +def SVDecomp(src: Mat, w=..., u=..., vt=..., flags: int = ...) -> typing.Any: 'SVDecomp(src[, w[, u[, vt[, flags]]]]) -> w, u, vt\n. wrap SVD::compute' ... - -def Scharr(src: ndarray, ddepth, dx, dy, dts: ndarray = ..., scale=..., delta=..., borderType=...) -> typing.Any: +def Scharr(src: Mat, ddepth, dx, dy, dts: Mat = ..., scale=..., delta=..., borderType=...) -> typing.Any: 'Scharr(src, ddepth, dx, dy[, dst[, scale[, delta[, borderType]]]]) -> dst\n. @brief Calculates the first x- or y- image derivative using Scharr operator.\n. \n. The function computes the first x- or y- spatial image derivative using the Scharr operator. The\n. call\n. \n. \\f[\\texttt{Scharr(src, dst, ddepth, dx, dy, scale, delta, borderType)}\\f]\n. \n. is equivalent to\n. \n. \\f[\\texttt{Sobel(src, dst, ddepth, dx, dy, FILTER_SCHARR, scale, delta, borderType)} .\\f]\n. \n. @param src input image.\n. @param dst output image of the same size and the same number of channels as src.\n. @param ddepth output image depth, see @ref filter_depths "combinations"\n. @param dx order of the derivative x.\n. @param dy order of the derivative y.\n. @param scale optional scale factor for the computed derivative values; by default, no scaling is\n. applied (see #getDerivKernels for details).\n. @param delta optional delta value that is added to the results prior to storing them in dst.\n. @param borderType pixel extrapolation method, see #BorderTypes. #BORDER_WRAP is not supported.\n. @sa cartToPolar' ... - SimpleBlobDetector = _mod_cv2.SimpleBlobDetector SimpleBlobDetector_Params = _mod_cv2.SimpleBlobDetector_Params - - def SimpleBlobDetector_create(parameters=...) -> typing.Any: 'SimpleBlobDetector_create([, parameters]) -> retval\n.' ... - -def Sobel(src: ndarray, ddepth, dx, dy, dts: ndarray = ..., ksize=..., scale=..., delta=..., borderType=...) -> typing.Any: +def Sobel(src: Mat, ddepth, dx, dy, dts: Mat = ..., ksize=..., scale=..., delta=..., borderType=...) -> typing.Any: 'Sobel(src, ddepth, dx, dy[, dst[, ksize[, scale[, delta[, borderType]]]]]) -> dst\n. @brief Calculates the first, second, third, or mixed image derivatives using an extended Sobel operator.\n. \n. In all cases except one, the \\f$\\texttt{ksize} \\times \\texttt{ksize}\\f$ separable kernel is used to\n. calculate the derivative. When \\f$\\texttt{ksize = 1}\\f$, the \\f$3 \\times 1\\f$ or \\f$1 \\times 3\\f$\n. kernel is used (that is, no Gaussian smoothing is done). `ksize = 1` can only be used for the first\n. or the second x- or y- derivatives.\n. \n. There is also the special value `ksize = #FILTER_SCHARR (-1)` that corresponds to the \\f$3\\times3\\f$ Scharr\n. filter that may give more accurate results than the \\f$3\\times3\\f$ Sobel. The Scharr aperture is\n. \n. \\f[\\vecthreethree{-3}{0}{3}{-10}{0}{10}{-3}{0}{3}\\f]\n. \n. for the x-derivative, or transposed for the y-derivative.\n. \n. The function calculates an image derivative by convolving the image with the appropriate kernel:\n. \n. \\f[\\texttt{dst} = \\frac{\\partial^{xorder+yorder} \\texttt{src}}{\\partial x^{xorder} \\partial y^{yorder}}\\f]\n. \n. The Sobel operators combine Gaussian smoothing and differentiation, so the result is more or less\n. resistant to the noise. Most often, the function is called with ( xorder = 1, yorder = 0, ksize = 3)\n. or ( xorder = 0, yorder = 1, ksize = 3) to calculate the first x- or y- image derivative. The first\n. case corresponds to a kernel of:\n. \n. \\f[\\vecthreethree{-1}{0}{1}{-2}{0}{2}{-1}{0}{1}\\f]\n. \n. The second case corresponds to a kernel of:\n. \n. \\f[\\vecthreethree{-1}{-2}{-1}{0}{0}{0}{1}{2}{1}\\f]\n. \n. @param src input image.\n. @param dst output image of the same size and the same number of channels as src .\n. @param ddepth output image depth, see @ref filter_depths "combinations"; in the case of\n. 8-bit input images it will result in truncated derivatives.\n. @param dx order of the derivative x.\n. @param dy order of the derivative y.\n. @param ksize size of the extended Sobel kernel; it must be 1, 3, 5, or 7.\n. @param scale optional scale factor for the computed derivative values; by default, no scaling is\n. applied (see #getDerivKernels for details).\n. @param delta optional delta value that is added to the results prior to storing them in dst.\n. @param borderType pixel extrapolation method, see #BorderTypes. #BORDER_WRAP is not supported.\n. @sa Scharr, Laplacian, sepFilter2D, filter2D, GaussianBlur, cartToPolar' ... - SparseMat_HASH_BIT: int SparseMat_HASH_SCALE: int SparseMat_MAGIC_VAL: int SparseMat_MAX_DIM: int SparseOpticalFlow = _mod_cv2.SparseOpticalFlow SparsePyrLKOpticalFlow = _mod_cv2.SparsePyrLKOpticalFlow - - def SparsePyrLKOpticalFlow_create(winSize=..., maxLevel=..., crit=..., flags: int = ..., minEigThreshold=...) -> typing.Any: 'SparsePyrLKOpticalFlow_create([, winSize[, maxLevel[, crit[, flags[, minEigThreshold]]]]]) -> retval\n.' ... - StereoBM = _mod_cv2.StereoBM StereoBM_PREFILTER_NORMALIZED_RESPONSE: int StereoBM_PREFILTER_XSOBEL: int - - def StereoBM_create(numDisparities=..., blockSize=...) -> typing.Any: 'StereoBM_create([, numDisparities[, blockSize]]) -> retval\n. @brief Creates StereoBM object\n. \n. @param numDisparities the disparity search range. For each pixel algorithm will find the best\n. disparity from 0 (default minimum disparity) to numDisparities. The search range can then be\n. shifted by changing the minimum disparity.\n. @param blockSize the linear size of the blocks compared by the algorithm. The size should be odd\n. (as the block is centered at the current pixel). Larger block size implies smoother, though less\n. accurate disparity map. Smaller block size gives more detailed disparity map, but there is higher\n. chance for algorithm to find a wrong correspondence.\n. \n. The function create StereoBM object. You can then call StereoBM::compute() to compute disparity for\n. a specific stereo pair.' ... - StereoMatcher = _mod_cv2.StereoMatcher StereoMatcher_DISP_SCALE: int StereoMatcher_DISP_SHIFT: int @@ -1573,13 +1469,10 @@ StereoSGBM_MODE_HH: int StereoSGBM_MODE_HH4: int StereoSGBM_MODE_SGBM: int StereoSGBM_MODE_SGBM_3WAY: int - - def StereoSGBM_create(minDisparity=..., numDisparities=..., blockSize=..., P1=..., P2=..., disp12MaxDiff=..., preFilterCap=..., uniquenessRatio=..., speckleWindowSize=..., speckleRange=..., mode=...) -> typing.Any: 'StereoSGBM_create([, minDisparity[, numDisparities[, blockSize[, P1[, P2[, disp12MaxDiff[, preFilterCap[, uniquenessRatio[, speckleWindowSize[, speckleRange[, mode]]]]]]]]]]]) -> retval\n. @brief Creates StereoSGBM object\n. \n. @param minDisparity Minimum possible disparity value. Normally, it is zero but sometimes\n. rectification algorithms can shift images, so this parameter needs to be adjusted accordingly.\n. @param numDisparities Maximum disparity minus minimum disparity. The value is always greater than\n. zero. In the current implementation, this parameter must be divisible by 16.\n. @param blockSize Matched block size. It must be an odd number \\>=1 . Normally, it should be\n. somewhere in the 3..11 range.\n. @param P1 The first parameter controlling the disparity smoothness. See below.\n. @param P2 The second parameter controlling the disparity smoothness. The larger the values are,\n. the smoother the disparity is. P1 is the penalty on the disparity change by plus or minus 1\n. between neighbor pixels. P2 is the penalty on the disparity change by more than 1 between neighbor\n. pixels. The algorithm requires P2 \\> P1 . See stereo_match.cpp sample where some reasonably good\n. P1 and P2 values are shown (like 8\\*number_of_image_channels\\*blockSize\\*blockSize and\n. 32\\*number_of_image_channels\\*blockSize\\*blockSize , respectively).\n. @param disp12MaxDiff Maximum allowed difference (in integer pixel units) in the left-right\n. disparity check. Set it to a non-positive value to disable the check.\n. @param preFilterCap Truncation value for the prefiltered image pixels. The algorithm first\n. computes x-derivative at each pixel and clips its value by [-preFilterCap, preFilterCap] interval.\n. The result values are passed to the Birchfield-Tomasi pixel cost function.\n. @param uniquenessRatio Margin in percentage by which the best (minimum) computed cost function\n. value should "win" the second best value to consider the found match correct. Normally, a value\n. within the 5-15 range is good enough.\n. @param speckleWindowSize Maximum size of smooth disparity regions to consider their noise speckles\n. and invalidate. Set it to 0 to disable speckle filtering. Otherwise, set it somewhere in the\n. 50-200 range.\n. @param speckleRange Maximum disparity variation within each connected component. If you do speckle\n. filtering, set the parameter to a positive value, it will be implicitly multiplied by 16.\n. Normally, 1 or 2 is good enough.\n. @param mode Set it to StereoSGBM::MODE_HH to run the full-scale two-pass dynamic programming\n. algorithm. It will consume O(W\\*H\\*numDisparities) bytes, which is large for 640x480 stereo and\n. huge for HD-size pictures. By default, it is set to false .\n. \n. The first constructor initializes StereoSGBM with all the default parameters. So, you only have to\n. set StereoSGBM::numDisparities at minimum. The second constructor enables you to set each parameter\n. to a custom value.' ... - Stitcher = _mod_cv2.Stitcher Stitcher_ERR_CAMERA_PARAMS_ADJUST_FAIL: int Stitcher_ERR_HOMOGRAPHY_EST_FAIL: int @@ -1587,13 +1480,10 @@ Stitcher_ERR_NEED_MORE_IMGS: int Stitcher_OK: int Stitcher_PANORAMA: int Stitcher_SCANS: int - - def Stitcher_create(mode=...) -> typing.Any: 'Stitcher_create([, mode]) -> retval\n. @brief Creates a Stitcher configured in one of the stitching modes.\n. \n. @param mode Scenario for stitcher operation. This is usually determined by source of images\n. to stitch and their transformation. Default parameters will be chosen for operation in given\n. scenario.\n. @return Stitcher class instance.' ... - Subdiv2D = _mod_cv2.Subdiv2D Subdiv2D_NEXT_AROUND_DST: int Subdiv2D_NEXT_AROUND_LEFT: int @@ -1664,18 +1554,14 @@ UMat_MAGIC_MASK: int UMat_MAGIC_VAL: int UMat_SUBMATRIX_FLAG: int UMat_TYPE_MASK: int - - def UMat_context() -> typing.Any: 'UMat_context() -> retval\n.' ... - def UMat_queue() -> typing.Any: 'UMat_queue() -> retval\n.' ... - USAGE_ALLOCATE_DEVICE_MEMORY: int USAGE_ALLOCATE_HOST_MEMORY: int USAGE_ALLOCATE_SHARED_MEMORY: int @@ -1685,22 +1571,16 @@ VIDEOWRITER_PROP_IS_COLOR: int VIDEOWRITER_PROP_NSTRIPES: int VIDEOWRITER_PROP_QUALITY: int VariationalRefinement = _mod_cv2.VariationalRefinement - - def VariationalRefinement_create() -> typing.Any: 'VariationalRefinement_create() -> retval\n. @brief Creates an instance of VariationalRefinement' ... - VideoCapture = _mod_cv2.VideoCapture VideoWriter = _mod_cv2.VideoWriter - - def VideoWriter_fourcc(c1, c2, c3, c4) -> typing.Any: 'VideoWriter_fourcc(c1, c2, c3, c4) -> retval\n. @brief Concatenates 4 chars to a fourcc code\n. \n. @return a fourcc code\n. \n. This static method constructs the fourcc code of the codec to be used in the constructor\n. VideoWriter::VideoWriter or VideoWriter::open.' ... - WARP_FILL_OUTLIERS: int WARP_INVERSE_MAP: int WARP_POLAR_LINEAR: int @@ -1790,453 +1670,362 @@ __file__: str __name__: str __package__: str __version__: str - - -def absdiff(src1: ndarray, src2: ndarray, dts: ndarray = ...) -> typing.Any: +def absdiff(src1: Mat, src2: Mat, dts: Mat = ...) -> typing.Any: 'absdiff(src1, src2[, dst]) -> dst\n. @brief Calculates the per-element absolute difference between two arrays or between an array and a scalar.\n. \n. The function cv::absdiff calculates:\n. * Absolute difference between two arrays when they have the same\n. size and type:\n. \\f[\\texttt{dst}(I) = \\texttt{saturate} (| \\texttt{src1}(I) - \\texttt{src2}(I)|)\\f]\n. * Absolute difference between an array and a scalar when the second\n. array is constructed from Scalar or has as many elements as the\n. number of channels in `src1`:\n. \\f[\\texttt{dst}(I) = \\texttt{saturate} (| \\texttt{src1}(I) - \\texttt{src2} |)\\f]\n. * Absolute difference between a scalar and an array when the first\n. array is constructed from Scalar or has as many elements as the\n. number of channels in `src2`:\n. \\f[\\texttt{dst}(I) = \\texttt{saturate} (| \\texttt{src1} - \\texttt{src2}(I) |)\\f]\n. where I is a multi-dimensional index of array elements. In case of\n. multi-channel arrays, each channel is processed independently.\n. @note Saturation is not applied when the arrays have the depth CV_32S.\n. You may even get a negative value in the case of overflow.\n. @param src1 first input array or a scalar.\n. @param src2 second input array or a scalar.\n. @param dst output array that has the same size and type as input arrays.\n. @sa cv::abs(const Mat&)' ... - -def accumulate(src: ndarray, dts: ndarray, mask: ndarray = ...) -> typing.Any: +def accumulate(src: Mat, dts: Mat, mask: Mat = ...) -> typing.Any: 'accumulate(src, dst[, mask]) -> dst\n. @brief Adds an image to the accumulator image.\n. \n. The function adds src or some of its elements to dst :\n. \n. \\f[\\texttt{dst} (x,y) \\leftarrow \\texttt{dst} (x,y) + \\texttt{src} (x,y) \\quad \\text{if} \\quad \\texttt{mask} (x,y) \\ne 0\\f]\n. \n. The function supports multi-channel images. Each channel is processed independently.\n. \n. The function cv::accumulate can be used, for example, to collect statistics of a scene background\n. viewed by a still camera and for the further foreground-background segmentation.\n. \n. @param src Input image of type CV_8UC(n), CV_16UC(n), CV_32FC(n) or CV_64FC(n), where n is a positive integer.\n. @param dst %Accumulator image with the same number of channels as input image, and a depth of CV_32F or CV_64F.\n. @param mask Optional operation mask.\n. \n. @sa accumulateSquare, accumulateProduct, accumulateWeighted' ... - -def accumulateProduct(src1: ndarray, src2: ndarray, dts: ndarray, mask: ndarray = ...) -> typing.Any: +def accumulateProduct(src1: Mat, src2: Mat, dts: Mat, mask: Mat = ...) -> typing.Any: 'accumulateProduct(src1, src2, dst[, mask]) -> dst\n. @brief Adds the per-element product of two input images to the accumulator image.\n. \n. The function adds the product of two images or their selected regions to the accumulator dst :\n. \n. \\f[\\texttt{dst} (x,y) \\leftarrow \\texttt{dst} (x,y) + \\texttt{src1} (x,y) \\cdot \\texttt{src2} (x,y) \\quad \\text{if} \\quad \\texttt{mask} (x,y) \\ne 0\\f]\n. \n. The function supports multi-channel images. Each channel is processed independently.\n. \n. @param src1 First input image, 1- or 3-channel, 8-bit or 32-bit floating point.\n. @param src2 Second input image of the same type and the same size as src1 .\n. @param dst %Accumulator image with the same number of channels as input images, 32-bit or 64-bit\n. floating-point.\n. @param mask Optional operation mask.\n. \n. @sa accumulate, accumulateSquare, accumulateWeighted' ... - -def accumulateSquare(src: ndarray, dts: ndarray, mask: ndarray = ...) -> typing.Any: +def accumulateSquare(src: Mat, dts: Mat, mask: Mat = ...) -> typing.Any: 'accumulateSquare(src, dst[, mask]) -> dst\n. @brief Adds the square of a source image to the accumulator image.\n. \n. The function adds the input image src or its selected region, raised to a power of 2, to the\n. accumulator dst :\n. \n. \\f[\\texttt{dst} (x,y) \\leftarrow \\texttt{dst} (x,y) + \\texttt{src} (x,y)^2 \\quad \\text{if} \\quad \\texttt{mask} (x,y) \\ne 0\\f]\n. \n. The function supports multi-channel images. Each channel is processed independently.\n. \n. @param src Input image as 1- or 3-channel, 8-bit or 32-bit floating point.\n. @param dst %Accumulator image with the same number of channels as input image, 32-bit or 64-bit\n. floating-point.\n. @param mask Optional operation mask.\n. \n. @sa accumulateSquare, accumulateProduct, accumulateWeighted' ... - -def accumulateWeighted(src: ndarray, dts: ndarray, alpha, mask: ndarray = ...) -> typing.Any: +def accumulateWeighted(src: Mat, dts: Mat, alpha, mask: Mat = ...) -> typing.Any: 'accumulateWeighted(src, dst, alpha[, mask]) -> dst\n. @brief Updates a running average.\n. \n. The function calculates the weighted sum of the input image src and the accumulator dst so that dst\n. becomes a running average of a frame sequence:\n. \n. \\f[\\texttt{dst} (x,y) \\leftarrow (1- \\texttt{alpha} ) \\cdot \\texttt{dst} (x,y) + \\texttt{alpha} \\cdot \\texttt{src} (x,y) \\quad \\text{if} \\quad \\texttt{mask} (x,y) \\ne 0\\f]\n. \n. That is, alpha regulates the update speed (how fast the accumulator "forgets" about earlier images).\n. The function supports multi-channel images. Each channel is processed independently.\n. \n. @param src Input image as 1- or 3-channel, 8-bit or 32-bit floating point.\n. @param dst %Accumulator image with the same number of channels as input image, 32-bit or 64-bit\n. floating-point.\n. @param alpha Weight of the input image.\n. @param mask Optional operation mask.\n. \n. @sa accumulate, accumulateSquare, accumulateProduct' ... - -def adaptiveThreshold(src: ndarray, maxValue, adaptiveMethod, thresholdType, blockSize, C, dts: ndarray = ...) -> typing.Any: +def adaptiveThreshold(src: Mat, maxValue, adaptiveMethod, thresholdType, blockSize, C, dts: Mat = ...) -> typing.Any: 'adaptiveThreshold(src, maxValue, adaptiveMethod, thresholdType, blockSize, C[, dst]) -> dst\n. @brief Applies an adaptive threshold to an array.\n. \n. The function transforms a grayscale image to a binary image according to the formulae:\n. - **THRESH_BINARY**\n. \\f[dst(x,y) = \\fork{\\texttt{maxValue}}{if \\(src(x,y) > T(x,y)\\)}{0}{otherwise}\\f]\n. - **THRESH_BINARY_INV**\n. \\f[dst(x,y) = \\fork{0}{if \\(src(x,y) > T(x,y)\\)}{\\texttt{maxValue}}{otherwise}\\f]\n. where \\f$T(x,y)\\f$ is a threshold calculated individually for each pixel (see adaptiveMethod parameter).\n. \n. The function can process the image in-place.\n. \n. @param src Source 8-bit single-channel image.\n. @param dst Destination image of the same size and the same type as src.\n. @param maxValue Non-zero value assigned to the pixels for which the condition is satisfied\n. @param adaptiveMethod Adaptive thresholding algorithm to use, see #AdaptiveThresholdTypes.\n. The #BORDER_REPLICATE | #BORDER_ISOLATED is used to process boundaries.\n. @param thresholdType Thresholding type that must be either #THRESH_BINARY or #THRESH_BINARY_INV,\n. see #ThresholdTypes.\n. @param blockSize Size of a pixel neighborhood that is used to calculate a threshold value for the\n. pixel: 3, 5, 7, and so on.\n. @param C Constant subtracted from the mean or weighted mean (see the details below). Normally, it\n. is positive but may be zero or negative as well.\n. \n. @sa threshold, blur, GaussianBlur' ... - -def add(src1: ndarray, src2: ndarray, dts: ndarray = ..., mask: ndarray = ..., dtype=...) -> typing.Any: +def add(src1: Mat, src2: Mat, dts: Mat = ..., mask: Mat = ..., dtype=...) -> typing.Any: 'add(src1, src2[, dst[, mask[, dtype]]]) -> dst\n. @brief Calculates the per-element sum of two arrays or an array and a scalar.\n. \n. The function add calculates:\n. - Sum of two arrays when both input arrays have the same size and the same number of channels:\n. \\f[\\texttt{dst}(I) = \\texttt{saturate} ( \\texttt{src1}(I) + \\texttt{src2}(I)) \\quad \\texttt{if mask}(I) \\ne0\\f]\n. - Sum of an array and a scalar when src2 is constructed from Scalar or has the same number of\n. elements as `src1.channels()`:\n. \\f[\\texttt{dst}(I) = \\texttt{saturate} ( \\texttt{src1}(I) + \\texttt{src2} ) \\quad \\texttt{if mask}(I) \\ne0\\f]\n. - Sum of a scalar and an array when src1 is constructed from Scalar or has the same number of\n. elements as `src2.channels()`:\n. \\f[\\texttt{dst}(I) = \\texttt{saturate} ( \\texttt{src1} + \\texttt{src2}(I) ) \\quad \\texttt{if mask}(I) \\ne0\\f]\n. where `I` is a multi-dimensional index of array elements. In case of multi-channel arrays, each\n. channel is processed independently.\n. \n. The first function in the list above can be replaced with matrix expressions:\n. @code{.cpp}\n. dst = src1 + src2;\n. dst += src1; // equivalent to add(dst, src1, dst);\n. @endcode\n. The input arrays and the output array can all have the same or different depths. For example, you\n. can add a 16-bit unsigned array to a 8-bit signed array and store the sum as a 32-bit\n. floating-point array. Depth of the output array is determined by the dtype parameter. In the second\n. and third cases above, as well as in the first case, when src1.depth() == src2.depth(), dtype can\n. be set to the default -1. In this case, the output array will have the same depth as the input\n. array, be it src1, src2 or both.\n. @note Saturation is not applied when the output array has the depth CV_32S. You may even get\n. result of an incorrect sign in the case of overflow.\n. @param src1 first input array or a scalar.\n. @param src2 second input array or a scalar.\n. @param dst output array that has the same size and number of channels as the input array(s); the\n. depth is defined by dtype or src1/src2.\n. @param mask optional operation mask - 8-bit single channel array, that specifies elements of the\n. output array to be changed.\n. @param dtype optional depth of the output array (see the discussion below).\n. @sa subtract, addWeighted, scaleAdd, Mat::convertTo' ... - -def addText(img: ndarray, text, org, nameFont, pointSize=..., color=..., weight=..., style=..., spacing=...) -> typing.Any: +def addText(img: Mat, text, org, nameFont, pointSize=..., color=..., weight=..., style=..., spacing=...) -> typing.Any: 'addText(img, text, org, nameFont[, pointSize[, color[, weight[, style[, spacing]]]]]) -> None\n. @brief Draws a text on the image.\n. \n. @param img 8-bit 3-channel image where the text should be drawn.\n. @param text Text to write on an image.\n. @param org Point(x,y) where the text should start on an image.\n. @param nameFont Name of the font. The name should match the name of a system font (such as\n. *Times*). If the font is not found, a default one is used.\n. @param pointSize Size of the font. If not specified, equal zero or negative, the point size of the\n. font is set to a system-dependent default value. Generally, this is 12 points.\n. @param color Color of the font in BGRA where A = 255 is fully transparent.\n. @param weight Font weight. Available operation flags are : cv::QtFontWeights You can also specify a positive integer for better control.\n. @param style Font style. Available operation flags are : cv::QtFontStyles\n. @param spacing Spacing between characters. It can be negative or positive.' ... - -def addWeighted(src1: ndarray, alpha, src2: ndarray, beta, gamma, dts: ndarray = ..., dtype=...) -> typing.Any: +def addWeighted(src1: Mat, alpha, src2: Mat, beta, gamma, dts: Mat = ..., dtype=...) -> typing.Any: 'addWeighted(src1, alpha, src2, beta, gamma[, dst[, dtype]]) -> dst\n. @brief Calculates the weighted sum of two arrays.\n. \n. The function addWeighted calculates the weighted sum of two arrays as follows:\n. \\f[\\texttt{dst} (I)= \\texttt{saturate} ( \\texttt{src1} (I)* \\texttt{alpha} + \\texttt{src2} (I)* \\texttt{beta} + \\texttt{gamma} )\\f]\n. where I is a multi-dimensional index of array elements. In case of multi-channel arrays, each\n. channel is processed independently.\n. The function can be replaced with a matrix expression:\n. @code{.cpp}\n. dst = src1*alpha + src2*beta + gamma;\n. @endcode\n. @note Saturation is not applied when the output array has the depth CV_32S. You may even get\n. result of an incorrect sign in the case of overflow.\n. @param src1 first input array.\n. @param alpha weight of the first array elements.\n. @param src2 second input array of the same size and channel number as src1.\n. @param beta weight of the second array elements.\n. @param gamma scalar added to each sum.\n. @param dst output array that has the same size and number of channels as the input arrays.\n. @param dtype optional depth of the output array; when both input arrays have the same depth, dtype\n. can be set to -1, which will be equivalent to src1.depth().\n. @sa add, subtract, scaleAdd, Mat::convertTo' ... - -def applyColorMap(src: ndarray, colormap, dts: ndarray = ...) -> typing.Any: +def applyColorMap(src: Mat, colormap, dts: Mat = ...) -> typing.Any: 'applyColorMap(src, colormap[, dst]) -> dst\n. @brief Applies a GNU Octave/MATLAB equivalent colormap on a given image.\n. \n. @param src The source image, grayscale or colored of type CV_8UC1 or CV_8UC3.\n. @param dst The result is the colormapped source image. Note: Mat::create is called on dst.\n. @param colormap The colormap to apply, see #ColormapTypes\n\n\n\napplyColorMap(src, userColor[, dst]) -> dst\n. @brief Applies a user colormap on a given image.\n. \n. @param src The source image, grayscale or colored of type CV_8UC1 or CV_8UC3.\n. @param dst The result is the colormapped source image. Note: Mat::create is called on dst.\n. @param userColor The colormap to apply of type CV_8UC1 or CV_8UC3 and size 256' ... - def approxPolyDP(curve, epsilon, closed, approxCurve=...) -> typing.Any: 'approxPolyDP(curve, epsilon, closed[, approxCurve]) -> approxCurve\n. @brief Approximates a polygonal curve(s) with the specified precision.\n. \n. The function cv::approxPolyDP approximates a curve or a polygon with another curve/polygon with less\n. vertices so that the distance between them is less or equal to the specified precision. It uses the\n. Douglas-Peucker algorithm \n. \n. @param curve Input vector of a 2D point stored in std::vector or Mat\n. @param approxCurve Result of the approximation. The type should match the type of the input curve.\n. @param epsilon Parameter specifying the approximation accuracy. This is the maximum distance\n. between the original curve and its approximation.\n. @param closed If true, the approximated curve is closed (its first and last vertices are\n. connected). Otherwise, it is not closed.' ... - def arcLength(curve, closed) -> typing.Any: 'arcLength(curve, closed) -> retval\n. @brief Calculates a contour perimeter or a curve length.\n. \n. The function computes a curve length or a closed contour perimeter.\n. \n. @param curve Input vector of 2D points, stored in std::vector or Mat.\n. @param closed Flag indicating whether the curve is closed or not.' ... - -def arrowedLine(img: ndarray, pt1, pt2, color, thickness=..., line_type=..., shift=..., tipLength=...) -> typing.Any: +def arrowedLine(img: Mat, pt1, pt2, color, thickness=..., line_type=..., shift=..., tipLength=...) -> typing.Any: 'arrowedLine(img, pt1, pt2, color[, thickness[, line_type[, shift[, tipLength]]]]) -> img\n. @brief Draws a arrow segment pointing from the first point to the second one.\n. \n. The function cv::arrowedLine draws an arrow between pt1 and pt2 points in the image. See also #line.\n. \n. @param img Image.\n. @param pt1 The point the arrow starts from.\n. @param pt2 The point the arrow points to.\n. @param color Line color.\n. @param thickness Line thickness.\n. @param line_type Type of the line. See #LineTypes\n. @param shift Number of fractional bits in the point coordinates.\n. @param tipLength The length of the arrow tip in relation to the arrow length' ... - -def batchDistance(src1: ndarray, src2: ndarray, dtype, dist=..., nidx=..., normType: int = ..., K=..., mask: ndarray = ..., update=..., crosscheck=...) -> typing.Any: +def batchDistance(src1: Mat, src2: Mat, dtype, dist=..., nidx=..., normType: int = ..., K=..., mask: Mat = ..., update=..., crosscheck=...) -> typing.Any: 'batchDistance(src1, src2, dtype[, dist[, nidx[, normType[, K[, mask[, update[, crosscheck]]]]]]]) -> dist, nidx\n. @brief naive nearest neighbor finder\n. \n. see http://en.wikipedia.org/wiki/Nearest_neighbor_search\n. @todo document' ... - -def bilateralFilter(src: ndarray, d, sigmaColor, sigmaSpace, dts: ndarray = ..., borderType=...) -> typing.Any: +def bilateralFilter(src: Mat, d, sigmaColor, sigmaSpace, dts: Mat = ..., borderType=...) -> typing.Any: 'bilateralFilter(src, d, sigmaColor, sigmaSpace[, dst[, borderType]]) -> dst\n. @brief Applies the bilateral filter to an image.\n. \n. The function applies bilateral filtering to the input image, as described in\n. http://www.dai.ed.ac.uk/CVonline/LOCAL_COPIES/MANDUCHI1/Bilateral_Filtering.html\n. bilateralFilter can reduce unwanted noise very well while keeping edges fairly sharp. However, it is\n. very slow compared to most filters.\n. \n. _Sigma values_: For simplicity, you can set the 2 sigma values to be the same. If they are small (\\<\n. 10), the filter will not have much effect, whereas if they are large (\\> 150), they will have a very\n. strong effect, making the image look "cartoonish".\n. \n. _Filter size_: Large filters (d \\> 5) are very slow, so it is recommended to use d=5 for real-time\n. applications, and perhaps d=9 for offline applications that need heavy noise filtering.\n. \n. This filter does not work inplace.\n. @param src Source 8-bit or floating-point, 1-channel or 3-channel image.\n. @param dst Destination image of the same size and type as src .\n. @param d Diameter of each pixel neighborhood that is used during filtering. If it is non-positive,\n. it is computed from sigmaSpace.\n. @param sigmaColor Filter sigma in the color space. A larger value of the parameter means that\n. farther colors within the pixel neighborhood (see sigmaSpace) will be mixed together, resulting\n. in larger areas of semi-equal color.\n. @param sigmaSpace Filter sigma in the coordinate space. A larger value of the parameter means that\n. farther pixels will influence each other as long as their colors are close enough (see sigmaColor\n. ). When d\\>0, it specifies the neighborhood size regardless of sigmaSpace. Otherwise, d is\n. proportional to sigmaSpace.\n. @param borderType border mode used to extrapolate pixels outside of the image, see #BorderTypes' ... - -def bitwise_and(src1: ndarray, src2: ndarray, dts: ndarray = ..., mask: ndarray = ...) -> typing.Any: +def bitwise_and(src1: Mat, src2: Mat, dts: Mat = ..., mask: Mat = ...) -> typing.Any: 'bitwise_and(src1, src2[, dst[, mask]]) -> dst\n. @brief computes bitwise conjunction of the two arrays (dst = src1 & src2)\n. Calculates the per-element bit-wise conjunction of two arrays or an\n. array and a scalar.\n. \n. The function cv::bitwise_and calculates the per-element bit-wise logical conjunction for:\n. * Two arrays when src1 and src2 have the same size:\n. \\f[\\texttt{dst} (I) = \\texttt{src1} (I) \\wedge \\texttt{src2} (I) \\quad \\texttt{if mask} (I) \\ne0\\f]\n. * An array and a scalar when src2 is constructed from Scalar or has\n. the same number of elements as `src1.channels()`:\n. \\f[\\texttt{dst} (I) = \\texttt{src1} (I) \\wedge \\texttt{src2} \\quad \\texttt{if mask} (I) \\ne0\\f]\n. * A scalar and an array when src1 is constructed from Scalar or has\n. the same number of elements as `src2.channels()`:\n. \\f[\\texttt{dst} (I) = \\texttt{src1} \\wedge \\texttt{src2} (I) \\quad \\texttt{if mask} (I) \\ne0\\f]\n. In case of floating-point arrays, their machine-specific bit\n. representations (usually IEEE754-compliant) are used for the operation.\n. In case of multi-channel arrays, each channel is processed\n. independently. In the second and third cases above, the scalar is first\n. converted to the array type.\n. @param src1 first input array or a scalar.\n. @param src2 second input array or a scalar.\n. @param dst output array that has the same size and type as the input\n. arrays.\n. @param mask optional operation mask, 8-bit single channel array, that\n. specifies elements of the output array to be changed.' ... - -def bitwise_not(src: ndarray, dts: ndarray = ..., mask: ndarray = ...) -> typing.Any: +def bitwise_not(src: Mat, dts: Mat = ..., mask: Mat = ...) -> typing.Any: 'bitwise_not(src[, dst[, mask]]) -> dst\n. @brief Inverts every bit of an array.\n. \n. The function cv::bitwise_not calculates per-element bit-wise inversion of the input\n. array:\n. \\f[\\texttt{dst} (I) = \\neg \\texttt{src} (I)\\f]\n. In case of a floating-point input array, its machine-specific bit\n. representation (usually IEEE754-compliant) is used for the operation. In\n. case of multi-channel arrays, each channel is processed independently.\n. @param src input array.\n. @param dst output array that has the same size and type as the input\n. array.\n. @param mask optional operation mask, 8-bit single channel array, that\n. specifies elements of the output array to be changed.' ... - -def bitwise_or(src1: ndarray, src2: ndarray, dts: ndarray = ..., mask: ndarray = ...) -> typing.Any: +def bitwise_or(src1: Mat, src2: Mat, dts: Mat = ..., mask: Mat = ...) -> typing.Any: 'bitwise_or(src1, src2[, dst[, mask]]) -> dst\n. @brief Calculates the per-element bit-wise disjunction of two arrays or an\n. array and a scalar.\n. \n. The function cv::bitwise_or calculates the per-element bit-wise logical disjunction for:\n. * Two arrays when src1 and src2 have the same size:\n. \\f[\\texttt{dst} (I) = \\texttt{src1} (I) \\vee \\texttt{src2} (I) \\quad \\texttt{if mask} (I) \\ne0\\f]\n. * An array and a scalar when src2 is constructed from Scalar or has\n. the same number of elements as `src1.channels()`:\n. \\f[\\texttt{dst} (I) = \\texttt{src1} (I) \\vee \\texttt{src2} \\quad \\texttt{if mask} (I) \\ne0\\f]\n. * A scalar and an array when src1 is constructed from Scalar or has\n. the same number of elements as `src2.channels()`:\n. \\f[\\texttt{dst} (I) = \\texttt{src1} \\vee \\texttt{src2} (I) \\quad \\texttt{if mask} (I) \\ne0\\f]\n. In case of floating-point arrays, their machine-specific bit\n. representations (usually IEEE754-compliant) are used for the operation.\n. In case of multi-channel arrays, each channel is processed\n. independently. In the second and third cases above, the scalar is first\n. converted to the array type.\n. @param src1 first input array or a scalar.\n. @param src2 second input array or a scalar.\n. @param dst output array that has the same size and type as the input\n. arrays.\n. @param mask optional operation mask, 8-bit single channel array, that\n. specifies elements of the output array to be changed.' ... - -def bitwise_xor(src1: ndarray, src2: ndarray, dts: ndarray = ..., mask: ndarray = ...) -> typing.Any: +def bitwise_xor(src1: Mat, src2: Mat, dts: Mat = ..., mask: Mat = ...) -> typing.Any: 'bitwise_xor(src1, src2[, dst[, mask]]) -> dst\n. @brief Calculates the per-element bit-wise "exclusive or" operation on two\n. arrays or an array and a scalar.\n. \n. The function cv::bitwise_xor calculates the per-element bit-wise logical "exclusive-or"\n. operation for:\n. * Two arrays when src1 and src2 have the same size:\n. \\f[\\texttt{dst} (I) = \\texttt{src1} (I) \\oplus \\texttt{src2} (I) \\quad \\texttt{if mask} (I) \\ne0\\f]\n. * An array and a scalar when src2 is constructed from Scalar or has\n. the same number of elements as `src1.channels()`:\n. \\f[\\texttt{dst} (I) = \\texttt{src1} (I) \\oplus \\texttt{src2} \\quad \\texttt{if mask} (I) \\ne0\\f]\n. * A scalar and an array when src1 is constructed from Scalar or has\n. the same number of elements as `src2.channels()`:\n. \\f[\\texttt{dst} (I) = \\texttt{src1} \\oplus \\texttt{src2} (I) \\quad \\texttt{if mask} (I) \\ne0\\f]\n. In case of floating-point arrays, their machine-specific bit\n. representations (usually IEEE754-compliant) are used for the operation.\n. In case of multi-channel arrays, each channel is processed\n. independently. In the 2nd and 3rd cases above, the scalar is first\n. converted to the array type.\n. @param src1 first input array or a scalar.\n. @param src2 second input array or a scalar.\n. @param dst output array that has the same size and type as the input\n. arrays.\n. @param mask optional operation mask, 8-bit single channel array, that\n. specifies elements of the output array to be changed.' ... - -def blur(src: ndarray, ksize, dts: ndarray = ..., anchor=..., borderType=...) -> typing.Any: +def blur(src: Mat, ksize, dts: Mat = ..., anchor=..., borderType=...) -> typing.Any: 'blur(src, ksize[, dst[, anchor[, borderType]]]) -> dst\n. @brief Blurs an image using the normalized box filter.\n. \n. The function smooths an image using the kernel:\n. \n. \\f[\\texttt{K} = \\frac{1}{\\texttt{ksize.width*ksize.height}} \\begin{bmatrix} 1 & 1 & 1 & \\cdots & 1 & 1 \\\\ 1 & 1 & 1 & \\cdots & 1 & 1 \\\\ \\hdotsfor{6} \\\\ 1 & 1 & 1 & \\cdots & 1 & 1 \\\\ \\end{bmatrix}\\f]\n. \n. The call `blur(src, dst, ksize, anchor, borderType)` is equivalent to `boxFilter(src, dst, src.type(), ksize,\n. anchor, true, borderType)`.\n. \n. @param src input image; it can have any number of channels, which are processed independently, but\n. the depth should be CV_8U, CV_16U, CV_16S, CV_32F or CV_64F.\n. @param dst output image of the same size and type as src.\n. @param ksize blurring kernel size.\n. @param anchor anchor point; default value Point(-1,-1) means that the anchor is at the kernel\n. center.\n. @param borderType border mode used to extrapolate pixels outside of the image, see #BorderTypes. #BORDER_WRAP is not supported.\n. @sa boxFilter, bilateralFilter, GaussianBlur, medianBlur' ... - def borderInterpolate(p, len, borderType) -> typing.Any: 'borderInterpolate(p, len, borderType) -> retval\n. @brief Computes the source location of an extrapolated pixel.\n. \n. The function computes and returns the coordinate of a donor pixel corresponding to the specified\n. extrapolated pixel when using the specified extrapolation border mode. For example, if you use\n. cv::BORDER_WRAP mode in the horizontal direction, cv::BORDER_REFLECT_101 in the vertical direction and\n. want to compute value of the "virtual" pixel Point(-5, 100) in a floating-point image img , it\n. looks like:\n. @code{.cpp}\n. float val = img.at(borderInterpolate(100, img.rows, cv::BORDER_REFLECT_101),\n. borderInterpolate(-5, img.cols, cv::BORDER_WRAP));\n. @endcode\n. Normally, the function is not called directly. It is used inside filtering functions and also in\n. copyMakeBorder.\n. @param p 0-based coordinate of the extrapolated pixel along one of the axes, likely \\<0 or \\>= len\n. @param len Length of the array along the corresponding axis.\n. @param borderType Border type, one of the #BorderTypes, except for #BORDER_TRANSPARENT and\n. #BORDER_ISOLATED . When borderType==#BORDER_CONSTANT , the function always returns -1, regardless\n. of p and len.\n. \n. @sa copyMakeBorder' ... - def boundingRect(array) -> typing.Any: 'boundingRect(array) -> retval\n. @brief Calculates the up-right bounding rectangle of a point set or non-zero pixels of gray-scale image.\n. \n. The function calculates and returns the minimal up-right bounding rectangle for the specified point set or\n. non-zero pixels of gray-scale image.\n. \n. @param array Input gray-scale image or 2D point set, stored in std::vector or Mat.' ... - -def boxFilter(src: ndarray, ddepth, ksize, dts: ndarray = ..., anchor=..., normalize=..., borderType=...) -> typing.Any: +def boxFilter(src: Mat, ddepth, ksize, dts: Mat = ..., anchor=..., normalize=..., borderType=...) -> typing.Any: 'boxFilter(src, ddepth, ksize[, dst[, anchor[, normalize[, borderType]]]]) -> dst\n. @brief Blurs an image using the box filter.\n. \n. The function smooths an image using the kernel:\n. \n. \\f[\\texttt{K} = \\alpha \\begin{bmatrix} 1 & 1 & 1 & \\cdots & 1 & 1 \\\\ 1 & 1 & 1 & \\cdots & 1 & 1 \\\\ \\hdotsfor{6} \\\\ 1 & 1 & 1 & \\cdots & 1 & 1 \\end{bmatrix}\\f]\n. \n. where\n. \n. \\f[\\alpha = \\begin{cases} \\frac{1}{\\texttt{ksize.width*ksize.height}} & \\texttt{when } \\texttt{normalize=true} \\\\1 & \\texttt{otherwise}\\end{cases}\\f]\n. \n. Unnormalized box filter is useful for computing various integral characteristics over each pixel\n. neighborhood, such as covariance matrices of image derivatives (used in dense optical flow\n. algorithms, and so on). If you need to compute pixel sums over variable-size windows, use #integral.\n. \n. @param src input image.\n. @param dst output image of the same size and type as src.\n. @param ddepth the output image depth (-1 to use src.depth()).\n. @param ksize blurring kernel size.\n. @param anchor anchor point; default value Point(-1,-1) means that the anchor is at the kernel\n. center.\n. @param normalize flag, specifying whether the kernel is normalized by its area or not.\n. @param borderType border mode used to extrapolate pixels outside of the image, see #BorderTypes. #BORDER_WRAP is not supported.\n. @sa blur, bilateralFilter, GaussianBlur, medianBlur, integral' ... - def boxPoints(box, points=...) -> typing.Any: 'boxPoints(box[, points]) -> points\n. @brief Finds the four vertices of a rotated rect. Useful to draw the rotated rectangle.\n. \n. The function finds the four vertices of a rotated rectangle. This function is useful to draw the\n. rectangle. In C++, instead of using this function, you can directly use RotatedRect::points method. Please\n. visit the @ref tutorial_bounding_rotated_ellipses "tutorial on Creating Bounding rotated boxes and ellipses for contours" for more information.\n. \n. @param box The input rotated rectangle. It may be the output of\n. @param points The output array of four vertices of rectangles.' ... - -def buildOpticalFlowPyramid(img: ndarray, winSize, maxLevel, pyramid=..., withDerivatives=..., pyrBorder=..., derivBorder=..., tryReuseInputImage=...) -> typing.Any: +def buildOpticalFlowPyramid(img: Mat, winSize, maxLevel, pyramid=..., withDerivatives=..., pyrBorder=..., derivBorder=..., tryReuseInputImage=...) -> typing.Any: 'buildOpticalFlowPyramid(img, winSize, maxLevel[, pyramid[, withDerivatives[, pyrBorder[, derivBorder[, tryReuseInputImage]]]]]) -> retval, pyramid\n. @brief Constructs the image pyramid which can be passed to calcOpticalFlowPyrLK.\n. \n. @param img 8-bit input image.\n. @param pyramid output pyramid.\n. @param winSize window size of optical flow algorithm. Must be not less than winSize argument of\n. calcOpticalFlowPyrLK. It is needed to calculate required padding for pyramid levels.\n. @param maxLevel 0-based maximal pyramid level number.\n. @param withDerivatives set to precompute gradients for the every pyramid level. If pyramid is\n. constructed without the gradients then calcOpticalFlowPyrLK will calculate them internally.\n. @param pyrBorder the border mode for pyramid layers.\n. @param derivBorder the border mode for gradients.\n. @param tryReuseInputImage put ROI of input image into the pyramid if possible. You can pass false\n. to force data copying.\n. @return number of levels in constructed pyramid. Can be less than maxLevel.' ... - -def calcBackProject(images: list[ndarray], channels: list[int], hist, ranges: list[int], scale, dts: ndarray = ...) -> typing.Any: +def calcBackProject(images: typing.List[Mat], channels: typing.List[int], hist, ranges: typing.List[int], scale, dts: Mat = ...) -> typing.Any: 'calcBackProject(images, channels, hist, ranges, scale[, dst]) -> dst\n. @overload' ... - def calcCovarMatrix(samples, mean, flags: int, covar=..., ctype=...) -> typing.Any: "calcCovarMatrix(samples, mean, flags[, covar[, ctype]]) -> covar, mean\n. @overload\n. @note use #COVAR_ROWS or #COVAR_COLS flag\n. @param samples samples stored as rows/columns of a single matrix.\n. @param covar output covariance matrix of the type ctype and square size.\n. @param mean input or output (depending on the flags) array as the average value of the input vectors.\n. @param flags operation flags as a combination of #CovarFlags\n. @param ctype type of the matrixl; it equals 'CV_64F' by default." ... - -def calcHist(images: list[ndarray], channels: list[int], mask: typing.Optional[ndarray], histSize: list[int], ranges: list[int], hist=..., accumulate=...) -> ndarray: +def calcHist(images: typing.List[Mat], channels: typing.List[int], mask: typing.Optional[Mat], histSize: typing.List[int], ranges: typing.List[int], hist=..., accumulate=...) -> Mat: 'calcHist(images, channels, mask, histSize, ranges[, hist[, accumulate]]) -> hist\n. @overload' ... - def calcOpticalFlowFarneback(prev, next, flow, pyr_scale, levels, winsize, iterations, poly_n, poly_sigma, flags: int) -> typing.Any: "calcOpticalFlowFarneback(prev, next, flow, pyr_scale, levels, winsize, iterations, poly_n, poly_sigma, flags) -> flow\n. @brief Computes a dense optical flow using the Gunnar Farneback's algorithm.\n. \n. @param prev first 8-bit single-channel input image.\n. @param next second input image of the same size and the same type as prev.\n. @param flow computed flow image that has the same size as prev and type CV_32FC2.\n. @param pyr_scale parameter, specifying the image scale (\\<1) to build pyramids for each image;\n. pyr_scale=0.5 means a classical pyramid, where each next layer is twice smaller than the previous\n. one.\n. @param levels number of pyramid layers including the initial image; levels=1 means that no extra\n. layers are created and only the original images are used.\n. @param winsize averaging window size; larger values increase the algorithm robustness to image\n. noise and give more chances for fast motion detection, but yield more blurred motion field.\n. @param iterations number of iterations the algorithm does at each pyramid level.\n. @param poly_n size of the pixel neighborhood used to find polynomial expansion in each pixel;\n. larger values mean that the image will be approximated with smoother surfaces, yielding more\n. robust algorithm and more blurred motion field, typically poly_n =5 or 7.\n. @param poly_sigma standard deviation of the Gaussian that is used to smooth derivatives used as a\n. basis for the polynomial expansion; for poly_n=5, you can set poly_sigma=1.1, for poly_n=7, a\n. good value would be poly_sigma=1.5.\n. @param flags operation flags that can be a combination of the following:\n. - **OPTFLOW_USE_INITIAL_FLOW** uses the input flow as an initial flow approximation.\n. - **OPTFLOW_FARNEBACK_GAUSSIAN** uses the Gaussian \\f$\\texttt{winsize}\\times\\texttt{winsize}\\f$\n. filter instead of a box filter of the same size for optical flow estimation; usually, this\n. option gives z more accurate flow than with a box filter, at the cost of lower speed;\n. normally, winsize for a Gaussian window should be set to a larger value to achieve the same\n. level of robustness.\n. \n. The function finds an optical flow for each prev pixel using the @cite Farneback2003 algorithm so that\n. \n. \\f[\\texttt{prev} (y,x) \\sim \\texttt{next} ( y + \\texttt{flow} (y,x)[1], x + \\texttt{flow} (y,x)[0])\\f]\n. \n. @note\n. \n. - An example using the optical flow algorithm described by Gunnar Farneback can be found at\n. opencv_source_code/samples/cpp/fback.cpp\n. - (Python) An example using the optical flow algorithm described by Gunnar Farneback can be\n. found at opencv_source_code/samples/python/opt_flow.py" ... - def calcOpticalFlowPyrLK(prevImg, nextImg, prevPts, nextPts, status=..., err=..., winSize=..., maxLevel=..., criteria=..., flags: int = ..., minEigThreshold=...) -> typing.Any: "calcOpticalFlowPyrLK(prevImg, nextImg, prevPts, nextPts[, status[, err[, winSize[, maxLevel[, criteria[, flags[, minEigThreshold]]]]]]]) -> nextPts, status, err\n. @brief Calculates an optical flow for a sparse feature set using the iterative Lucas-Kanade method with\n. pyramids.\n. \n. @param prevImg first 8-bit input image or pyramid constructed by buildOpticalFlowPyramid.\n. @param nextImg second input image or pyramid of the same size and the same type as prevImg.\n. @param prevPts vector of 2D points for which the flow needs to be found; point coordinates must be\n. single-precision floating-point numbers.\n. @param nextPts output vector of 2D points (with single-precision floating-point coordinates)\n. containing the calculated new positions of input features in the second image; when\n. OPTFLOW_USE_INITIAL_FLOW flag is passed, the vector must have the same size as in the input.\n. @param status output status vector (of unsigned chars); each element of the vector is set to 1 if\n. the flow for the corresponding features has been found, otherwise, it is set to 0.\n. @param err output vector of errors; each element of the vector is set to an error for the\n. corresponding feature, type of the error measure can be set in flags parameter; if the flow wasn't\n. found then the error is not defined (use the status parameter to find such cases).\n. @param winSize size of the search window at each pyramid level.\n. @param maxLevel 0-based maximal pyramid level number; if set to 0, pyramids are not used (single\n. level), if set to 1, two levels are used, and so on; if pyramids are passed to input then\n. algorithm will use as many levels as pyramids have but no more than maxLevel.\n. @param criteria parameter, specifying the termination criteria of the iterative search algorithm\n. (after the specified maximum number of iterations criteria.maxCount or when the search window\n. moves by less than criteria.epsilon.\n. @param flags operation flags:\n. - **OPTFLOW_USE_INITIAL_FLOW** uses initial estimations, stored in nextPts; if the flag is\n. not set, then prevPts is copied to nextPts and is considered the initial estimate.\n. - **OPTFLOW_LK_GET_MIN_EIGENVALS** use minimum eigen values as an error measure (see\n. minEigThreshold description); if the flag is not set, then L1 distance between patches\n. around the original and a moved point, divided by number of pixels in a window, is used as a\n. error measure.\n. @param minEigThreshold the algorithm calculates the minimum eigen value of a 2x2 normal matrix of\n. optical flow equations (this matrix is called a spatial gradient matrix in @cite Bouguet00), divided\n. by number of pixels in a window; if this value is less than minEigThreshold, then a corresponding\n. feature is filtered out and its flow is not processed, so it allows to remove bad points and get a\n. performance boost.\n. \n. The function implements a sparse iterative version of the Lucas-Kanade optical flow in pyramids. See\n. @cite Bouguet00 . The function is parallelized with the TBB library.\n. \n. @note\n. \n. - An example using the Lucas-Kanade optical flow algorithm can be found at\n. opencv_source_code/samples/cpp/lkdemo.cpp\n. - (Python) An example using the Lucas-Kanade optical flow algorithm can be found at\n. opencv_source_code/samples/python/lk_track.py\n. - (Python) An example using the Lucas-Kanade tracker for homography matching can be found at\n. opencv_source_code/samples/python/lk_homography.py" ... - def calibrateCamera(objectPoints, imagePoints, imageSize, cameraMatrix, distCoeffs, rvecs=..., tvecs=..., flags: int = ..., criteria=...) -> typing.Any: 'calibrateCamera(objectPoints, imagePoints, imageSize, cameraMatrix, distCoeffs[, rvecs[, tvecs[, flags[, criteria]]]]) -> retval, cameraMatrix, distCoeffs, rvecs, tvecs\n. @overload' ... - def calibrateCameraExtended(objectPoints, imagePoints, imageSize, cameraMatrix, distCoeffs, rvecs=..., tvecs=..., stdDeviationsIntrinsics=..., stdDeviationsExtrinsics=..., perViewErrors=..., flags: int = ..., criteria=...) -> typing.Any: "calibrateCameraExtended(objectPoints, imagePoints, imageSize, cameraMatrix, distCoeffs[, rvecs[, tvecs[, stdDeviationsIntrinsics[, stdDeviationsExtrinsics[, perViewErrors[, flags[, criteria]]]]]]]) -> retval, cameraMatrix, distCoeffs, rvecs, tvecs, stdDeviationsIntrinsics, stdDeviationsExtrinsics, perViewErrors\n. @brief Finds the camera intrinsic and extrinsic parameters from several views of a calibration\n. pattern.\n. \n. @param objectPoints In the new interface it is a vector of vectors of calibration pattern points in\n. the calibration pattern coordinate space (e.g. std::vector>). The outer\n. vector contains as many elements as the number of pattern views. If the same calibration pattern\n. is shown in each view and it is fully visible, all the vectors will be the same. Although, it is\n. possible to use partially occluded patterns or even different patterns in different views. Then,\n. the vectors will be different. Although the points are 3D, they all lie in the calibration pattern's\n. XY coordinate plane (thus 0 in the Z-coordinate), if the used calibration pattern is a planar rig.\n. In the old interface all the vectors of object points from different views are concatenated\n. together.\n. @param imagePoints In the new interface it is a vector of vectors of the projections of calibration\n. pattern points (e.g. std::vector>). imagePoints.size() and\n. objectPoints.size(), and imagePoints[i].size() and objectPoints[i].size() for each i, must be equal,\n. respectively. In the old interface all the vectors of object points from different views are\n. concatenated together.\n. @param imageSize Size of the image used only to initialize the intrinsic camera matrix.\n. @param cameraMatrix Input/output 3x3 floating-point camera matrix\n. \\f$A = \\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\\f$ . If CV\\_CALIB\\_USE\\_INTRINSIC\\_GUESS\n. and/or CALIB_FIX_ASPECT_RATIO are specified, some or all of fx, fy, cx, cy must be\n. initialized before calling the function.\n. @param distCoeffs Input/output vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$ of\n. 4, 5, 8, 12 or 14 elements.\n. @param rvecs Output vector of rotation vectors (@ref Rodrigues ) estimated for each pattern view\n. (e.g. std::vector>). That is, each i-th rotation vector together with the corresponding\n. i-th translation vector (see the next output parameter description) brings the calibration pattern\n. from the object coordinate space (in which object points are specified) to the camera coordinate\n. space. In more technical terms, the tuple of the i-th rotation and translation vector performs\n. a change of basis from object coordinate space to camera coordinate space. Due to its duality, this\n. tuple is equivalent to the position of the calibration pattern with respect to the camera coordinate\n. space.\n. @param tvecs Output vector of translation vectors estimated for each pattern view, see parameter\n. describtion above.\n. @param stdDeviationsIntrinsics Output vector of standard deviations estimated for intrinsic\n. parameters. Order of deviations values:\n. \\f$(f_x, f_y, c_x, c_y, k_1, k_2, p_1, p_2, k_3, k_4, k_5, k_6 , s_1, s_2, s_3,\n. s_4, \\tau_x, \\tau_y)\\f$ If one of parameters is not estimated, it's deviation is equals to zero.\n. @param stdDeviationsExtrinsics Output vector of standard deviations estimated for extrinsic\n. parameters. Order of deviations values: \\f$(R_0, T_0, \\dotsc , R_{M - 1}, T_{M - 1})\\f$ where M is\n. the number of pattern views. \\f$R_i, T_i\\f$ are concatenated 1x3 vectors.\n. @param perViewErrors Output vector of the RMS re-projection error estimated for each pattern view.\n. @param flags Different flags that may be zero or a combination of the following values:\n. - **CALIB_USE_INTRINSIC_GUESS** cameraMatrix contains valid initial values of\n. fx, fy, cx, cy that are optimized further. Otherwise, (cx, cy) is initially set to the image\n. center ( imageSize is used), and focal distances are computed in a least-squares fashion.\n. Note, that if intrinsic parameters are known, there is no need to use this function just to\n. estimate extrinsic parameters. Use solvePnP instead.\n. - **CALIB_FIX_PRINCIPAL_POINT** The principal point is not changed during the global\n. optimization. It stays at the center or at a different location specified when\n. CALIB_USE_INTRINSIC_GUESS is set too.\n. - **CALIB_FIX_ASPECT_RATIO** The functions consider only fy as a free parameter. The\n. ratio fx/fy stays the same as in the input cameraMatrix . When\n. CALIB_USE_INTRINSIC_GUESS is not set, the actual input values of fx and fy are\n. ignored, only their ratio is computed and used further.\n. - **CALIB_ZERO_TANGENT_DIST** Tangential distortion coefficients \\f$(p_1, p_2)\\f$ are set\n. to zeros and stay zero.\n. - **CALIB_FIX_K1,...,CALIB_FIX_K6** The corresponding radial distortion\n. coefficient is not changed during the optimization. If CALIB_USE_INTRINSIC_GUESS is\n. set, the coefficient from the supplied distCoeffs matrix is used. Otherwise, it is set to 0.\n. - **CALIB_RATIONAL_MODEL** Coefficients k4, k5, and k6 are enabled. To provide the\n. backward compatibility, this extra flag should be explicitly specified to make the\n. calibration function use the rational model and return 8 coefficients. If the flag is not\n. set, the function computes and returns only 5 distortion coefficients.\n. - **CALIB_THIN_PRISM_MODEL** Coefficients s1, s2, s3 and s4 are enabled. To provide the\n. backward compatibility, this extra flag should be explicitly specified to make the\n. calibration function use the thin prism model and return 12 coefficients. If the flag is not\n. set, the function computes and returns only 5 distortion coefficients.\n. - **CALIB_FIX_S1_S2_S3_S4** The thin prism distortion coefficients are not changed during\n. the optimization. If CALIB_USE_INTRINSIC_GUESS is set, the coefficient from the\n. supplied distCoeffs matrix is used. Otherwise, it is set to 0.\n. - **CALIB_TILTED_MODEL** Coefficients tauX and tauY are enabled. To provide the\n. backward compatibility, this extra flag should be explicitly specified to make the\n. calibration function use the tilted sensor model and return 14 coefficients. If the flag is not\n. set, the function computes and returns only 5 distortion coefficients.\n. - **CALIB_FIX_TAUX_TAUY** The coefficients of the tilted sensor model are not changed during\n. the optimization. If CALIB_USE_INTRINSIC_GUESS is set, the coefficient from the\n. supplied distCoeffs matrix is used. Otherwise, it is set to 0.\n. @param criteria Termination criteria for the iterative optimization algorithm.\n. \n. @return the overall RMS re-projection error.\n. \n. The function estimates the intrinsic camera parameters and extrinsic parameters for each of the\n. views. The algorithm is based on @cite Zhang2000 and @cite BouguetMCT . The coordinates of 3D object\n. points and their corresponding 2D projections in each view must be specified. That may be achieved\n. by using an object with known geometry and easily detectable feature points. Such an object is\n. called a calibration rig or calibration pattern, and OpenCV has built-in support for a chessboard as\n. a calibration rig (see @ref findChessboardCorners). Currently, initialization of intrinsic\n. parameters (when CALIB_USE_INTRINSIC_GUESS is not set) is only implemented for planar calibration\n. patterns (where Z-coordinates of the object points must be all zeros). 3D calibration rigs can also\n. be used as long as initial cameraMatrix is provided.\n. \n. The algorithm performs the following steps:\n. \n. - Compute the initial intrinsic parameters (the option only available for planar calibration\n. patterns) or read them from the input parameters. The distortion coefficients are all set to\n. zeros initially unless some of CALIB_FIX_K? are specified.\n. \n. - Estimate the initial camera pose as if the intrinsic parameters have been already known. This is\n. done using solvePnP .\n. \n. - Run the global Levenberg-Marquardt optimization algorithm to minimize the reprojection error,\n. that is, the total sum of squared distances between the observed feature points imagePoints and\n. the projected (using the current estimates for camera parameters and the poses) object points\n. objectPoints. See projectPoints for details.\n. \n. @note\n. If you use a non-square (i.e. non-N-by-N) grid and @ref findChessboardCorners for calibration,\n. and @ref calibrateCamera returns bad values (zero distortion coefficients, \\f$c_x\\f$ and\n. \\f$c_y\\f$ very far from the image center, and/or large differences between \\f$f_x\\f$ and\n. \\f$f_y\\f$ (ratios of 10:1 or more)), then you are probably using patternSize=cvSize(rows,cols)\n. instead of using patternSize=cvSize(cols,rows) in @ref findChessboardCorners.\n. \n. @sa\n. calibrateCameraRO, findChessboardCorners, solvePnP, initCameraMatrix2D, stereoCalibrate,\n. undistort" ... - def calibrateCameraRO(objectPoints, imagePoints, imageSize, iFixedPoint, cameraMatrix, distCoeffs, rvecs=..., tvecs=..., newObjPoints=..., flags: int = ..., criteria=...) -> typing.Any: 'calibrateCameraRO(objectPoints, imagePoints, imageSize, iFixedPoint, cameraMatrix, distCoeffs[, rvecs[, tvecs[, newObjPoints[, flags[, criteria]]]]]) -> retval, cameraMatrix, distCoeffs, rvecs, tvecs, newObjPoints\n. @overload' ... - def calibrateCameraROExtended(objectPoints, imagePoints, imageSize, iFixedPoint, cameraMatrix, distCoeffs, rvecs=..., tvecs=..., newObjPoints=..., stdDeviationsIntrinsics=..., stdDeviationsExtrinsics=..., stdDeviationsObjPoints=..., perViewErrors=..., flags: int = ..., criteria=...) -> typing.Any: 'calibrateCameraROExtended(objectPoints, imagePoints, imageSize, iFixedPoint, cameraMatrix, distCoeffs[, rvecs[, tvecs[, newObjPoints[, stdDeviationsIntrinsics[, stdDeviationsExtrinsics[, stdDeviationsObjPoints[, perViewErrors[, flags[, criteria]]]]]]]]]) -> retval, cameraMatrix, distCoeffs, rvecs, tvecs, newObjPoints, stdDeviationsIntrinsics, stdDeviationsExtrinsics, stdDeviationsObjPoints, perViewErrors\n. @brief Finds the camera intrinsic and extrinsic parameters from several views of a calibration pattern.\n. \n. This function is an extension of calibrateCamera() with the method of releasing object which was\n. proposed in @cite strobl2011iccv. In many common cases with inaccurate, unmeasured, roughly planar\n. targets (calibration plates), this method can dramatically improve the precision of the estimated\n. camera parameters. Both the object-releasing method and standard method are supported by this\n. function. Use the parameter **iFixedPoint** for method selection. In the internal implementation,\n. calibrateCamera() is a wrapper for this function.\n. \n. @param objectPoints Vector of vectors of calibration pattern points in the calibration pattern\n. coordinate space. See calibrateCamera() for details. If the method of releasing object to be used,\n. the identical calibration board must be used in each view and it must be fully visible, and all\n. objectPoints[i] must be the same and all points should be roughly close to a plane. **The calibration\n. target has to be rigid, or at least static if the camera (rather than the calibration target) is\n. shifted for grabbing images.**\n. @param imagePoints Vector of vectors of the projections of calibration pattern points. See\n. calibrateCamera() for details.\n. @param imageSize Size of the image used only to initialize the intrinsic camera matrix.\n. @param iFixedPoint The index of the 3D object point in objectPoints[0] to be fixed. It also acts as\n. a switch for calibration method selection. If object-releasing method to be used, pass in the\n. parameter in the range of [1, objectPoints[0].size()-2], otherwise a value out of this range will\n. make standard calibration method selected. Usually the top-right corner point of the calibration\n. board grid is recommended to be fixed when object-releasing method being utilized. According to\n. \\cite strobl2011iccv, two other points are also fixed. In this implementation, objectPoints[0].front\n. and objectPoints[0].back.z are used. With object-releasing method, accurate rvecs, tvecs and\n. newObjPoints are only possible if coordinates of these three fixed points are accurate enough.\n. @param cameraMatrix Output 3x3 floating-point camera matrix. See calibrateCamera() for details.\n. @param distCoeffs Output vector of distortion coefficients. See calibrateCamera() for details.\n. @param rvecs Output vector of rotation vectors estimated for each pattern view. See calibrateCamera()\n. for details.\n. @param tvecs Output vector of translation vectors estimated for each pattern view.\n. @param newObjPoints The updated output vector of calibration pattern points. The coordinates might\n. be scaled based on three fixed points. The returned coordinates are accurate only if the above\n. mentioned three fixed points are accurate. If not needed, noArray() can be passed in. This parameter\n. is ignored with standard calibration method.\n. @param stdDeviationsIntrinsics Output vector of standard deviations estimated for intrinsic parameters.\n. See calibrateCamera() for details.\n. @param stdDeviationsExtrinsics Output vector of standard deviations estimated for extrinsic parameters.\n. See calibrateCamera() for details.\n. @param stdDeviationsObjPoints Output vector of standard deviations estimated for refined coordinates\n. of calibration pattern points. It has the same size and order as objectPoints[0] vector. This\n. parameter is ignored with standard calibration method.\n. @param perViewErrors Output vector of the RMS re-projection error estimated for each pattern view.\n. @param flags Different flags that may be zero or a combination of some predefined values. See\n. calibrateCamera() for details. If the method of releasing object is used, the calibration time may\n. be much longer. CALIB_USE_QR or CALIB_USE_LU could be used for faster calibration with potentially\n. less precise and less stable in some rare cases.\n. @param criteria Termination criteria for the iterative optimization algorithm.\n. \n. @return the overall RMS re-projection error.\n. \n. The function estimates the intrinsic camera parameters and extrinsic parameters for each of the\n. views. The algorithm is based on @cite Zhang2000, @cite BouguetMCT and @cite strobl2011iccv. See\n. calibrateCamera() for other detailed explanations.\n. @sa\n. calibrateCamera, findChessboardCorners, solvePnP, initCameraMatrix2D, stereoCalibrate, undistort' ... - def calibrateHandEye(R_gripper2base, t_gripper2base, R_target2cam, t_target2cam, R_cam2gripper=..., t_cam2gripper=..., method: int = ...) -> typing.Any: 'calibrateHandEye(R_gripper2base, t_gripper2base, R_target2cam, t_target2cam[, R_cam2gripper[, t_cam2gripper[, method]]]) -> R_cam2gripper, t_cam2gripper\n. @brief Computes Hand-Eye calibration: \\f$_{}^{g}\\textrm{T}_c\\f$\n. \n. @param[in] R_gripper2base Rotation part extracted from the homogeneous matrix that transforms a point\n. expressed in the gripper frame to the robot base frame (\\f$_{}^{b}\\textrm{T}_g\\f$).\n. This is a vector (`vector`) that contains the rotation matrices for all the transformations\n. from gripper frame to robot base frame.\n. @param[in] t_gripper2base Translation part extracted from the homogeneous matrix that transforms a point\n. expressed in the gripper frame to the robot base frame (\\f$_{}^{b}\\textrm{T}_g\\f$).\n. This is a vector (`vector`) that contains the translation vectors for all the transformations\n. from gripper frame to robot base frame.\n. @param[in] R_target2cam Rotation part extracted from the homogeneous matrix that transforms a point\n. expressed in the target frame to the camera frame (\\f$_{}^{c}\\textrm{T}_t\\f$).\n. This is a vector (`vector`) that contains the rotation matrices for all the transformations\n. from calibration target frame to camera frame.\n. @param[in] t_target2cam Rotation part extracted from the homogeneous matrix that transforms a point\n. expressed in the target frame to the camera frame (\\f$_{}^{c}\\textrm{T}_t\\f$).\n. This is a vector (`vector`) that contains the translation vectors for all the transformations\n. from calibration target frame to camera frame.\n. @param[out] R_cam2gripper Estimated rotation part extracted from the homogeneous matrix that transforms a point\n. expressed in the camera frame to the gripper frame (\\f$_{}^{g}\\textrm{T}_c\\f$).\n. @param[out] t_cam2gripper Estimated translation part extracted from the homogeneous matrix that transforms a point\n. expressed in the camera frame to the gripper frame (\\f$_{}^{g}\\textrm{T}_c\\f$).\n. @param[in] method One of the implemented Hand-Eye calibration method, see cv::HandEyeCalibrationMethod\n. \n. The function performs the Hand-Eye calibration using various methods. One approach consists in estimating the\n. rotation then the translation (separable solutions) and the following methods are implemented:\n. - R. Tsai, R. Lenz A New Technique for Fully Autonomous and Efficient 3D Robotics Hand/EyeCalibration \\cite Tsai89\n. - F. Park, B. Martin Robot Sensor Calibration: Solving AX = XB on the Euclidean Group \\cite Park94\n. - R. Horaud, F. Dornaika Hand-Eye Calibration \\cite Horaud95\n. \n. Another approach consists in estimating simultaneously the rotation and the translation (simultaneous solutions),\n. with the following implemented method:\n. - N. Andreff, R. Horaud, B. Espiau On-line Hand-Eye Calibration \\cite Andreff99\n. - K. Daniilidis Hand-Eye Calibration Using Dual Quaternions \\cite Daniilidis98\n. \n. The following picture describes the Hand-Eye calibration problem where the transformation between a camera ("eye")\n. mounted on a robot gripper ("hand") has to be estimated.\n. \n. ![](pics/hand-eye_figure.png)\n. \n. The calibration procedure is the following:\n. - a static calibration pattern is used to estimate the transformation between the target frame\n. and the camera frame\n. - the robot gripper is moved in order to acquire several poses\n. - for each pose, the homogeneous transformation between the gripper frame and the robot base frame is recorded using for\n. instance the robot kinematics\n. \\f[\n. \\begin{bmatrix}\n. X_b\\\\\n. Y_b\\\\\n. Z_b\\\\\n. 1\n. \\end{bmatrix}\n. =\n. \\begin{bmatrix}\n. _{}^{b}\\textrm{R}_g & _{}^{b}\\textrm{t}_g \\\\\n. 0_{1 \\times 3} & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X_g\\\\\n. Y_g\\\\\n. Z_g\\\\\n. 1\n. \\end{bmatrix}\n. \\f]\n. - for each pose, the homogeneous transformation between the calibration target frame and the camera frame is recorded using\n. for instance a pose estimation method (PnP) from 2D-3D point correspondences\n. \\f[\n. \\begin{bmatrix}\n. X_c\\\\\n. Y_c\\\\\n. Z_c\\\\\n. 1\n. \\end{bmatrix}\n. =\n. \\begin{bmatrix}\n. _{}^{c}\\textrm{R}_t & _{}^{c}\\textrm{t}_t \\\\\n. 0_{1 \\times 3} & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X_t\\\\\n. Y_t\\\\\n. Z_t\\\\\n. 1\n. \\end{bmatrix}\n. \\f]\n. \n. The Hand-Eye calibration procedure returns the following homogeneous transformation\n. \\f[\n. \\begin{bmatrix}\n. X_g\\\\\n. Y_g\\\\\n. Z_g\\\\\n. 1\n. \\end{bmatrix}\n. =\n. \\begin{bmatrix}\n. _{}^{g}\\textrm{R}_c & _{}^{g}\\textrm{t}_c \\\\\n. 0_{1 \\times 3} & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X_c\\\\\n. Y_c\\\\\n. Z_c\\\\\n. 1\n. \\end{bmatrix}\n. \\f]\n. \n. This problem is also known as solving the \\f$\\mathbf{A}\\mathbf{X}=\\mathbf{X}\\mathbf{B}\\f$ equation:\n. \\f[\n. \\begin{align*}\n. ^{b}{\\textrm{T}_g}^{(1)} \\hspace{0.2em} ^{g}\\textrm{T}_c \\hspace{0.2em} ^{c}{\\textrm{T}_t}^{(1)} &=\n. \\hspace{0.1em} ^{b}{\\textrm{T}_g}^{(2)} \\hspace{0.2em} ^{g}\\textrm{T}_c \\hspace{0.2em} ^{c}{\\textrm{T}_t}^{(2)} \\\\\n. \n. (^{b}{\\textrm{T}_g}^{(2)})^{-1} \\hspace{0.2em} ^{b}{\\textrm{T}_g}^{(1)} \\hspace{0.2em} ^{g}\\textrm{T}_c &=\n. \\hspace{0.1em} ^{g}\\textrm{T}_c \\hspace{0.2em} ^{c}{\\textrm{T}_t}^{(2)} (^{c}{\\textrm{T}_t}^{(1)})^{-1} \\\\\n. \n. \\textrm{A}_i \\textrm{X} &= \\textrm{X} \\textrm{B}_i \\\\\n. \\end{align*}\n. \\f]\n. \n. \\note\n. Additional information can be found on this [website](http://campar.in.tum.de/Chair/HandEyeCalibration).\n. \\note\n. A minimum of 2 motions with non parallel rotation axes are necessary to determine the hand-eye transformation.\n. So at least 3 different poses are required, but it is strongly recommended to use many more poses.' ... - def calibrationMatrixValues(cameraMatrix, imageSize, apertureWidth, apertureHeight) -> typing.Any: "calibrationMatrixValues(cameraMatrix, imageSize, apertureWidth, apertureHeight) -> fovx, fovy, focalLength, principalPoint, aspectRatio\n. @brief Computes useful camera characteristics from the camera matrix.\n. \n. @param cameraMatrix Input camera matrix that can be estimated by calibrateCamera or\n. stereoCalibrate .\n. @param imageSize Input image size in pixels.\n. @param apertureWidth Physical width in mm of the sensor.\n. @param apertureHeight Physical height in mm of the sensor.\n. @param fovx Output field of view in degrees along the horizontal sensor axis.\n. @param fovy Output field of view in degrees along the vertical sensor axis.\n. @param focalLength Focal length of the lens in mm.\n. @param principalPoint Principal point in mm.\n. @param aspectRatio \\f$f_y/f_x\\f$\n. \n. The function computes various useful camera characteristics from the previously estimated camera\n. matrix.\n. \n. @note\n. Do keep in mind that the unity measure 'mm' stands for whatever unit of measure one chooses for\n. the chessboard pitch (it can thus be any value)." ... - def cartToPolar(x, y, magnitude=..., angle=..., angleInDegrees=...) -> typing.Any: 'cartToPolar(x, y[, magnitude[, angle[, angleInDegrees]]]) -> magnitude, angle\n. @brief Calculates the magnitude and angle of 2D vectors.\n. \n. The function cv::cartToPolar calculates either the magnitude, angle, or both\n. for every 2D vector (x(I),y(I)):\n. \\f[\\begin{array}{l} \\texttt{magnitude} (I)= \\sqrt{\\texttt{x}(I)^2+\\texttt{y}(I)^2} , \\\\ \\texttt{angle} (I)= \\texttt{atan2} ( \\texttt{y} (I), \\texttt{x} (I))[ \\cdot180 / \\pi ] \\end{array}\\f]\n. \n. The angles are calculated with accuracy about 0.3 degrees. For the point\n. (0,0), the angle is set to 0.\n. @param x array of x-coordinates; this must be a single-precision or\n. double-precision floating-point array.\n. @param y array of y-coordinates, that must have the same size and same type as x.\n. @param magnitude output array of magnitudes of the same size and type as x.\n. @param angle output array of angles that has the same size and type as\n. x; the angles are measured in radians (from 0 to 2\\*Pi) or in degrees (0 to 360 degrees).\n. @param angleInDegrees a flag, indicating whether the angles are measured\n. in radians (which is by default), or in degrees.\n. @sa Sobel, Scharr' ... - -def checkChessboard(img: ndarray, size) -> typing.Any: +def checkChessboard(img: Mat, size) -> typing.Any: 'checkChessboard(img, size) -> retval\n.' ... - def checkHardwareSupport(feature) -> typing.Any: 'checkHardwareSupport(feature) -> retval\n. @brief Returns true if the specified feature is supported by the host hardware.\n. \n. The function returns true if the host hardware supports the specified feature. When user calls\n. setUseOptimized(false), the subsequent calls to checkHardwareSupport() will return false until\n. setUseOptimized(true) is called. This way user can dynamically switch on and off the optimized code\n. in OpenCV.\n. @param feature The feature of interest, one of cv::CpuFeatures' ... - def checkRange(a, quiet=..., minVal=..., maxVal=...) -> typing.Any: 'checkRange(a[, quiet[, minVal[, maxVal]]]) -> retval, pos\n. @brief Checks every element of an input array for invalid values.\n. \n. The function cv::checkRange checks that every array element is neither NaN nor infinite. When minVal \\>\n. -DBL_MAX and maxVal \\< DBL_MAX, the function also checks that each value is between minVal and\n. maxVal. In case of multi-channel arrays, each channel is processed independently. If some values\n. are out of range, position of the first outlier is stored in pos (when pos != NULL). Then, the\n. function either returns false (when quiet=true) or throws an exception.\n. @param a input array.\n. @param quiet a flag, indicating whether the functions quietly return false when the array elements\n. are out of range or they throw an exception.\n. @param pos optional output parameter, when not NULL, must be a pointer to array of src.dims\n. elements.\n. @param minVal inclusive lower boundary of valid values range.\n. @param maxVal exclusive upper boundary of valid values range.' ... - -def circle(img: ndarray, center, radius, color, thickness=..., lineType=..., shift=...) -> typing.Any: +def circle(img: Mat, center, radius, color, thickness=..., lineType=..., shift=...) -> typing.Any: 'circle(img, center, radius, color[, thickness[, lineType[, shift]]]) -> img\n. @brief Draws a circle.\n. \n. The function cv::circle draws a simple or filled circle with a given center and radius.\n. @param img Image where the circle is drawn.\n. @param center Center of the circle.\n. @param radius Radius of the circle.\n. @param color Circle color.\n. @param thickness Thickness of the circle outline, if positive. Negative values, like #FILLED,\n. mean that a filled circle is to be drawn.\n. @param lineType Type of the circle boundary. See #LineTypes\n. @param shift Number of fractional bits in the coordinates of the center and in the radius value.' ... - def clipLine(imgRect, pt1, pt2) -> typing.Any: 'clipLine(imgRect, pt1, pt2) -> retval, pt1, pt2\n. @overload\n. @param imgRect Image rectangle.\n. @param pt1 First line point.\n. @param pt2 Second line point.' ... - -def colorChange(src: ndarray, mask: ndarray, dts: ndarray = ..., red_mul=..., green_mul=..., blue_mul=...) -> typing.Any: +def colorChange(src: Mat, mask: Mat, dts: Mat = ..., red_mul=..., green_mul=..., blue_mul=...) -> typing.Any: 'colorChange(src, mask[, dst[, red_mul[, green_mul[, blue_mul]]]]) -> dst\n. @brief Given an original color image, two differently colored versions of this image can be mixed\n. seamlessly.\n. \n. @param src Input 8-bit 3-channel image.\n. @param mask Input 8-bit 1 or 3-channel image.\n. @param dst Output image with the same size and type as src .\n. @param red_mul R-channel multiply factor.\n. @param green_mul G-channel multiply factor.\n. @param blue_mul B-channel multiply factor.\n. \n. Multiplication factor is between .5 to 2.5.' ... - -def compare(src1: ndarray, src2: ndarray, cmpop, dts: ndarray = ...) -> typing.Any: +def compare(src1: Mat, src2: Mat, cmpop, dts: Mat = ...) -> typing.Any: 'compare(src1, src2, cmpop[, dst]) -> dst\n. @brief Performs the per-element comparison of two arrays or an array and scalar value.\n. \n. The function compares:\n. * Elements of two arrays when src1 and src2 have the same size:\n. \\f[\\texttt{dst} (I) = \\texttt{src1} (I) \\,\\texttt{cmpop}\\, \\texttt{src2} (I)\\f]\n. * Elements of src1 with a scalar src2 when src2 is constructed from\n. Scalar or has a single element:\n. \\f[\\texttt{dst} (I) = \\texttt{src1}(I) \\,\\texttt{cmpop}\\, \\texttt{src2}\\f]\n. * src1 with elements of src2 when src1 is constructed from Scalar or\n. has a single element:\n. \\f[\\texttt{dst} (I) = \\texttt{src1} \\,\\texttt{cmpop}\\, \\texttt{src2} (I)\\f]\n. When the comparison result is true, the corresponding element of output\n. array is set to 255. The comparison operations can be replaced with the\n. equivalent matrix expressions:\n. @code{.cpp}\n. Mat dst1 = src1 >= src2;\n. Mat dst2 = src1 < 8;\n. ...\n. @endcode\n. @param src1 first input array or a scalar; when it is an array, it must have a single channel.\n. @param src2 second input array or a scalar; when it is an array, it must have a single channel.\n. @param dst output array of type ref CV_8U that has the same size and the same number of channels as\n. the input arrays.\n. @param cmpop a flag, that specifies correspondence between the arrays (cv::CmpTypes)\n. @sa checkRange, min, max, threshold' ... - -def compareHist(H1: ndarray, H2: ndarray, method: int) -> float: +def compareHist(H1: Mat, H2: Mat, method: int) -> float: 'compareHist(H1, H2, method) -> retval\n. @brief Compares two histograms.\n. \n. The function cv::compareHist compares two dense or two sparse histograms using the specified method.\n. \n. The function returns \\f$d(H_1, H_2)\\f$ .\n. \n. While the function works well with 1-, 2-, 3-dimensional dense histograms, it may not be suitable\n. for high-dimensional sparse histograms. In such histograms, because of aliasing and sampling\n. problems, the coordinates of non-zero histogram bins can slightly shift. To compare such histograms\n. or more general sparse configurations of weighted points, consider using the #EMD function.\n. \n. @param H1 First compared histogram.\n. @param H2 Second compared histogram of the same size as H1 .\n. @param method Comparison method, see #HistCompMethods' ... - def completeSymm(m, lowerToUpper=...) -> typing.Any: 'completeSymm(m[, lowerToUpper]) -> m\n. @brief Copies the lower or the upper half of a square matrix to its another half.\n. \n. The function cv::completeSymm copies the lower or the upper half of a square matrix to\n. its another half. The matrix diagonal remains unchanged:\n. - \\f$\\texttt{m}_{ij}=\\texttt{m}_{ji}\\f$ for \\f$i > j\\f$ if\n. lowerToUpper=false\n. - \\f$\\texttt{m}_{ij}=\\texttt{m}_{ji}\\f$ for \\f$i < j\\f$ if\n. lowerToUpper=true\n. \n. @param m input-output floating-point square matrix.\n. @param lowerToUpper operation flag; if true, the lower half is copied to\n. the upper half. Otherwise, the upper half is copied to the lower half.\n. @sa flip, transpose' ... - def composeRT(rvec1, tvec1, rvec2, tvec2, rvec3=..., tvec3=..., dr3dr1=..., dr3dt1=..., dr3dr2=..., dr3dt2=..., dt3dr1=..., dt3dt1=..., dt3dr2=..., dt3dt2=...) -> typing.Any: 'composeRT(rvec1, tvec1, rvec2, tvec2[, rvec3[, tvec3[, dr3dr1[, dr3dt1[, dr3dr2[, dr3dt2[, dt3dr1[, dt3dt1[, dt3dr2[, dt3dt2]]]]]]]]]]) -> rvec3, tvec3, dr3dr1, dr3dt1, dr3dr2, dr3dt2, dt3dr1, dt3dt1, dt3dr2, dt3dt2\n. @brief Combines two rotation-and-shift transformations.\n. \n. @param rvec1 First rotation vector.\n. @param tvec1 First translation vector.\n. @param rvec2 Second rotation vector.\n. @param tvec2 Second translation vector.\n. @param rvec3 Output rotation vector of the superposition.\n. @param tvec3 Output translation vector of the superposition.\n. @param dr3dr1 Optional output derivative of rvec3 with regard to rvec1\n. @param dr3dt1 Optional output derivative of rvec3 with regard to tvec1\n. @param dr3dr2 Optional output derivative of rvec3 with regard to rvec2\n. @param dr3dt2 Optional output derivative of rvec3 with regard to tvec2\n. @param dt3dr1 Optional output derivative of tvec3 with regard to rvec1\n. @param dt3dt1 Optional output derivative of tvec3 with regard to tvec1\n. @param dt3dr2 Optional output derivative of tvec3 with regard to rvec2\n. @param dt3dt2 Optional output derivative of tvec3 with regard to tvec2\n. \n. The functions compute:\n. \n. \\f[\\begin{array}{l} \\texttt{rvec3} = \\mathrm{rodrigues} ^{-1} \\left ( \\mathrm{rodrigues} ( \\texttt{rvec2} ) \\cdot \\mathrm{rodrigues} ( \\texttt{rvec1} ) \\right ) \\\\ \\texttt{tvec3} = \\mathrm{rodrigues} ( \\texttt{rvec2} ) \\cdot \\texttt{tvec1} + \\texttt{tvec2} \\end{array} ,\\f]\n. \n. where \\f$\\mathrm{rodrigues}\\f$ denotes a rotation vector to a rotation matrix transformation, and\n. \\f$\\mathrm{rodrigues}^{-1}\\f$ denotes the inverse transformation. See Rodrigues for details.\n. \n. Also, the functions can compute the derivatives of the output vectors with regards to the input\n. vectors (see matMulDeriv ). The functions are used inside stereoCalibrate but can also be used in\n. your own code where Levenberg-Marquardt or another gradient-based solver is used to optimize a\n. function that contains a matrix multiplication.' ... - def computeCorrespondEpilines(points, whichImage, F, lines=...) -> typing.Any: 'computeCorrespondEpilines(points, whichImage, F[, lines]) -> lines\n. @brief For points in an image of a stereo pair, computes the corresponding epilines in the other image.\n. \n. @param points Input points. \\f$N \\times 1\\f$ or \\f$1 \\times N\\f$ matrix of type CV_32FC2 or\n. vector\\ .\n. @param whichImage Index of the image (1 or 2) that contains the points .\n. @param F Fundamental matrix that can be estimated using findFundamentalMat or stereoRectify .\n. @param lines Output vector of the epipolar lines corresponding to the points in the other image.\n. Each line \\f$ax + by + c=0\\f$ is encoded by 3 numbers \\f$(a, b, c)\\f$ .\n. \n. For every point in one of the two images of a stereo pair, the function finds the equation of the\n. corresponding epipolar line in the other image.\n. \n. From the fundamental matrix definition (see findFundamentalMat ), line \\f$l^{(2)}_i\\f$ in the second\n. image for the point \\f$p^{(1)}_i\\f$ in the first image (when whichImage=1 ) is computed as:\n. \n. \\f[l^{(2)}_i = F p^{(1)}_i\\f]\n. \n. And vice versa, when whichImage=2, \\f$l^{(1)}_i\\f$ is computed from \\f$p^{(2)}_i\\f$ as:\n. \n. \\f[l^{(1)}_i = F^T p^{(2)}_i\\f]\n. \n. Line coefficients are defined up to a scale. They are normalized so that \\f$a_i^2+b_i^2=1\\f$ .' ... - def computeECC(templateImage, inputImage, inputMask=...) -> typing.Any: 'computeECC(templateImage, inputImage[, inputMask]) -> retval\n. @brief Computes the Enhanced Correlation Coefficient value between two images @cite EP08 .\n. \n. @param templateImage single-channel template image; CV_8U or CV_32F array.\n. @param inputImage single-channel input image to be warped to provide an image similar to\n. templateImage, same type as templateImage.\n. @param inputMask An optional mask to indicate valid values of inputImage.\n. \n. @sa\n. findTransformECC' ... - -def connectedComponents(image: ndarray, labels=..., connectivity=..., ltype=...) -> typing.Any: +def connectedComponents(image: Mat, labels=..., connectivity=..., ltype=...) -> typing.Any: 'connectedComponents(image[, labels[, connectivity[, ltype]]]) -> retval, labels\n. @overload\n. \n. @param image the 8-bit single-channel image to be labeled\n. @param labels destination labeled image\n. @param connectivity 8 or 4 for 8-way or 4-way connectivity respectively\n. @param ltype output image label type. Currently CV_32S and CV_16U are supported.' ... - -def connectedComponentsWithAlgorithm(image: ndarray, connectivity, ltype, ccltype, labels=...) -> typing.Any: +def connectedComponentsWithAlgorithm(image: Mat, connectivity, ltype, ccltype, labels=...) -> typing.Any: "connectedComponentsWithAlgorithm(image, connectivity, ltype, ccltype[, labels]) -> retval, labels\n. @brief computes the connected components labeled image of boolean image\n. \n. image with 4 or 8 way connectivity - returns N, the total number of labels [0, N-1] where 0\n. represents the background label. ltype specifies the output label image type, an important\n. consideration based on the total number of labels or alternatively the total number of pixels in\n. the source image. ccltype specifies the connected components labeling algorithm to use, currently\n. Grana (BBDT) and Wu's (SAUF) algorithms are supported, see the #ConnectedComponentsAlgorithmsTypes\n. for details. Note that SAUF algorithm forces a row major ordering of labels while BBDT does not.\n. This function uses parallel version of both Grana and Wu's algorithms if at least one allowed\n. parallel framework is enabled and if the rows of the image are at least twice the number returned by #getNumberOfCPUs.\n. \n. @param image the 8-bit single-channel image to be labeled\n. @param labels destination labeled image\n. @param connectivity 8 or 4 for 8-way or 4-way connectivity respectively\n. @param ltype output image label type. Currently CV_32S and CV_16U are supported.\n. @param ccltype connected components algorithm type (see the #ConnectedComponentsAlgorithmsTypes)." ... - -def connectedComponentsWithStats(image: ndarray, labels=..., stats=..., centroids=..., connectivity=..., ltype=...) -> typing.Any: +def connectedComponentsWithStats(image: Mat, labels=..., stats=..., centroids=..., connectivity=..., ltype=...) -> typing.Any: 'connectedComponentsWithStats(image[, labels[, stats[, centroids[, connectivity[, ltype]]]]]) -> retval, labels, stats, centroids\n. @overload\n. @param image the 8-bit single-channel image to be labeled\n. @param labels destination labeled image\n. @param stats statistics output for each label, including the background label.\n. Statistics are accessed via stats(label, COLUMN) where COLUMN is one of\n. #ConnectedComponentsTypes, selecting the statistic. The data type is CV_32S.\n. @param centroids centroid output for each label, including the background label. Centroids are\n. accessed via centroids(label, 0) for x and centroids(label, 1) for y. The data type CV_64F.\n. @param connectivity 8 or 4 for 8-way or 4-way connectivity respectively\n. @param ltype output image label type. Currently CV_32S and CV_16U are supported.' ... - -def connectedComponentsWithStatsWithAlgorithm(image: ndarray, connectivity, ltype, ccltype, labels=..., stats=..., centroids=...) -> typing.Any: +def connectedComponentsWithStatsWithAlgorithm(image: Mat, connectivity, ltype, ccltype, labels=..., stats=..., centroids=...) -> typing.Any: "connectedComponentsWithStatsWithAlgorithm(image, connectivity, ltype, ccltype[, labels[, stats[, centroids]]]) -> retval, labels, stats, centroids\n. @brief computes the connected components labeled image of boolean image and also produces a statistics output for each label\n. \n. image with 4 or 8 way connectivity - returns N, the total number of labels [0, N-1] where 0\n. represents the background label. ltype specifies the output label image type, an important\n. consideration based on the total number of labels or alternatively the total number of pixels in\n. the source image. ccltype specifies the connected components labeling algorithm to use, currently\n. Grana's (BBDT) and Wu's (SAUF) algorithms are supported, see the #ConnectedComponentsAlgorithmsTypes\n. for details. Note that SAUF algorithm forces a row major ordering of labels while BBDT does not.\n. This function uses parallel version of both Grana and Wu's algorithms (statistics included) if at least one allowed\n. parallel framework is enabled and if the rows of the image are at least twice the number returned by #getNumberOfCPUs.\n. \n. @param image the 8-bit single-channel image to be labeled\n. @param labels destination labeled image\n. @param stats statistics output for each label, including the background label.\n. Statistics are accessed via stats(label, COLUMN) where COLUMN is one of\n. #ConnectedComponentsTypes, selecting the statistic. The data type is CV_32S.\n. @param centroids centroid output for each label, including the background label. Centroids are\n. accessed via centroids(label, 0) for x and centroids(label, 1) for y. The data type CV_64F.\n. @param connectivity 8 or 4 for 8-way or 4-way connectivity respectively\n. @param ltype output image label type. Currently CV_32S and CV_16U are supported.\n. @param ccltype connected components algorithm type (see #ConnectedComponentsAlgorithmsTypes)." ... - def contourArea(contour, oriented=...) -> typing.Any: 'contourArea(contour[, oriented]) -> retval\n. @brief Calculates a contour area.\n. \n. The function computes a contour area. Similarly to moments , the area is computed using the Green\n. formula. Thus, the returned area and the number of non-zero pixels, if you draw the contour using\n. #drawContours or #fillPoly , can be different. Also, the function will most certainly give a wrong\n. results for contours with self-intersections.\n. \n. Example:\n. @code\n. vector contour;\n. contour.push_back(Point2f(0, 0));\n. contour.push_back(Point2f(10, 0));\n. contour.push_back(Point2f(10, 10));\n. contour.push_back(Point2f(5, 4));\n. \n. double area0 = contourArea(contour);\n. vector approx;\n. approxPolyDP(contour, approx, 5, true);\n. double area1 = contourArea(approx);\n. \n. cout << "area0 =" << area0 << endl <<\n. "area1 =" << area1 << endl <<\n. "approx poly vertices" << approx.size() << endl;\n. @endcode\n. @param contour Input vector of 2D points (contour vertices), stored in std::vector or Mat.\n. @param oriented Oriented area flag. If it is true, the function returns a signed area value,\n. depending on the contour orientation (clockwise or counter-clockwise). Using this feature you can\n. determine orientation of a contour by taking the sign of an area. By default, the parameter is\n. false, which means that the absolute value is returned.' ... - -def convertFp16(src: ndarray, dts: ndarray = ...) -> typing.Any: +def convertFp16(src: Mat, dts: Mat = ...) -> typing.Any: 'convertFp16(src[, dst]) -> dst\n. @brief Converts an array to half precision floating number.\n. \n. This function converts FP32 (single precision floating point) from/to FP16 (half precision floating point). CV_16S format is used to represent FP16 data.\n. There are two use modes (src -> dst): CV_32F -> CV_16S and CV_16S -> CV_32F. The input array has to have type of CV_32F or\n. CV_16S to represent the bit depth. If the input array is neither of them, the function will raise an error.\n. The format of half precision floating point is defined in IEEE 754-2008.\n. \n. @param src input array.\n. @param dst output array.' ... - def convertMaps(map1, map2, dstmap1type, dstmap1=..., dstmap2=..., nninterpolation=...) -> typing.Any: 'convertMaps(map1, map2, dstmap1type[, dstmap1[, dstmap2[, nninterpolation]]]) -> dstmap1, dstmap2\n. @brief Converts image transformation maps from one representation to another.\n. \n. The function converts a pair of maps for remap from one representation to another. The following\n. options ( (map1.type(), map2.type()) \\f$\\rightarrow\\f$ (dstmap1.type(), dstmap2.type()) ) are\n. supported:\n. \n. - \\f$\\texttt{(CV_32FC1, CV_32FC1)} \\rightarrow \\texttt{(CV_16SC2, CV_16UC1)}\\f$. This is the\n. most frequently used conversion operation, in which the original floating-point maps (see remap )\n. are converted to a more compact and much faster fixed-point representation. The first output array\n. contains the rounded coordinates and the second array (created only when nninterpolation=false )\n. contains indices in the interpolation tables.\n. \n. - \\f$\\texttt{(CV_32FC2)} \\rightarrow \\texttt{(CV_16SC2, CV_16UC1)}\\f$. The same as above but\n. the original maps are stored in one 2-channel matrix.\n. \n. - Reverse conversion. Obviously, the reconstructed floating-point maps will not be exactly the same\n. as the originals.\n. \n. @param map1 The first input map of type CV_16SC2, CV_32FC1, or CV_32FC2 .\n. @param map2 The second input map of type CV_16UC1, CV_32FC1, or none (empty matrix),\n. respectively.\n. @param dstmap1 The first output map that has the type dstmap1type and the same size as src .\n. @param dstmap2 The second output map.\n. @param dstmap1type Type of the first output map that should be CV_16SC2, CV_32FC1, or\n. CV_32FC2 .\n. @param nninterpolation Flag indicating whether the fixed-point maps are used for the\n. nearest-neighbor or for a more complex interpolation.\n. \n. @sa remap, undistort, initUndistortRectifyMap' ... - -def convertPointsFromHomogeneous(src: ndarray, dts: ndarray = ...) -> typing.Any: +def convertPointsFromHomogeneous(src: Mat, dts: Mat = ...) -> typing.Any: 'convertPointsFromHomogeneous(src[, dst]) -> dst\n. @brief Converts points from homogeneous to Euclidean space.\n. \n. @param src Input vector of N-dimensional points.\n. @param dst Output vector of N-1-dimensional points.\n. \n. The function converts points homogeneous to Euclidean space using perspective projection. That is,\n. each point (x1, x2, ... x(n-1), xn) is converted to (x1/xn, x2/xn, ..., x(n-1)/xn). When xn=0, the\n. output point coordinates will be (0,0,0,...).' ... - -def convertPointsToHomogeneous(src: ndarray, dts: ndarray = ...) -> typing.Any: +def convertPointsToHomogeneous(src: Mat, dts: Mat = ...) -> typing.Any: "convertPointsToHomogeneous(src[, dst]) -> dst\n. @brief Converts points from Euclidean to homogeneous space.\n. \n. @param src Input vector of N-dimensional points.\n. @param dst Output vector of N+1-dimensional points.\n. \n. The function converts points from Euclidean to homogeneous space by appending 1's to the tuple of\n. point coordinates. That is, each point (x1, x2, ..., xn) is converted to (x1, x2, ..., xn, 1)." ... - -def convertScaleAbs(src: ndarray, dts: ndarray = ..., alpha=..., beta=...) -> typing.Any: +def convertScaleAbs(src: Mat, dts: Mat = ..., alpha=..., beta=...) -> typing.Any: 'convertScaleAbs(src[, dst[, alpha[, beta]]]) -> dst\n. @brief Scales, calculates absolute values, and converts the result to 8-bit.\n. \n. On each element of the input array, the function convertScaleAbs\n. performs three operations sequentially: scaling, taking an absolute\n. value, conversion to an unsigned 8-bit type:\n. \\f[\\texttt{dst} (I)= \\texttt{saturate\\_cast} (| \\texttt{src} (I)* \\texttt{alpha} + \\texttt{beta} |)\\f]\n. In case of multi-channel arrays, the function processes each channel\n. independently. When the output is not 8-bit, the operation can be\n. emulated by calling the Mat::convertTo method (or by using matrix\n. expressions) and then by calculating an absolute value of the result.\n. For example:\n. @code{.cpp}\n. Mat_ A(30,30);\n. randu(A, Scalar(-100), Scalar(100));\n. Mat_ B = A*5 + 3;\n. B = abs(B);\n. // Mat_ B = abs(A*5+3) will also do the job,\n. // but it will allocate a temporary matrix\n. @endcode\n. @param src input array.\n. @param dst output array.\n. @param alpha optional scale factor.\n. @param beta optional delta added to the scaled values.\n. @sa Mat::convertTo, cv::abs(const Mat&)' ... - def convexHull(points, hull=..., clockwise=..., returnPoints=...) -> typing.Any: 'convexHull(points[, hull[, clockwise[, returnPoints]]]) -> hull\n. @brief Finds the convex hull of a point set.\n. \n. The function cv::convexHull finds the convex hull of a 2D point set using the Sklansky\'s algorithm @cite Sklansky82\n. that has *O(N logN)* complexity in the current implementation.\n. \n. @param points Input 2D point set, stored in std::vector or Mat.\n. @param hull Output convex hull. It is either an integer vector of indices or vector of points. In\n. the first case, the hull elements are 0-based indices of the convex hull points in the original\n. array (since the set of convex hull points is a subset of the original point set). In the second\n. case, hull elements are the convex hull points themselves.\n. @param clockwise Orientation flag. If it is true, the output convex hull is oriented clockwise.\n. Otherwise, it is oriented counter-clockwise. The assumed coordinate system has its X axis pointing\n. to the right, and its Y axis pointing upwards.\n. @param returnPoints Operation flag. In case of a matrix, when the flag is true, the function\n. returns convex hull points. Otherwise, it returns indices of the convex hull points. When the\n. output array is std::vector, the flag is ignored, and the output depends on the type of the\n. vector: std::vector\\ implies returnPoints=false, std::vector\\ implies\n. returnPoints=true.\n. \n. @note `points` and `hull` should be different arrays, inplace processing isn\'t supported.\n. \n. Check @ref tutorial_hull "the corresponding tutorial" for more details.\n. \n. useful links:\n. \n. https://www.learnopencv.com/convex-hull-using-opencv-in-python-and-c/' ... - def convexityDefects(contour, convexhull, convexityDefects=...) -> typing.Any: 'convexityDefects(contour, convexhull[, convexityDefects]) -> convexityDefects\n. @brief Finds the convexity defects of a contour.\n. \n. The figure below displays convexity defects of a hand contour:\n. \n. ![image](pics/defects.png)\n. \n. @param contour Input contour.\n. @param convexhull Convex hull obtained using convexHull that should contain indices of the contour\n. points that make the hull.\n. @param convexityDefects The output vector of convexity defects. In C++ and the new Python/Java\n. interface each convexity defect is represented as 4-element integer vector (a.k.a. #Vec4i):\n. (start_index, end_index, farthest_pt_index, fixpt_depth), where indices are 0-based indices\n. in the original contour of the convexity defect beginning, end and the farthest point, and\n. fixpt_depth is fixed-point approximation (with 8 fractional bits) of the distance between the\n. farthest contour point and the hull. That is, to get the floating-point value of the depth will be\n. fixpt_depth/256.0.' ... - -def copyMakeBorder(src: ndarray, top, bottom, left, right, borderType, dts: ndarray = ..., value=...) -> typing.Any: +def copyMakeBorder(src: Mat, top, bottom, left, right, borderType, dts: Mat = ..., value=...) -> typing.Any: 'copyMakeBorder(src, top, bottom, left, right, borderType[, dst[, value]]) -> dst\n. @brief Forms a border around an image.\n. \n. The function copies the source image into the middle of the destination image. The areas to the\n. left, to the right, above and below the copied source image will be filled with extrapolated\n. pixels. This is not what filtering functions based on it do (they extrapolate pixels on-fly), but\n. what other more complex functions, including your own, may do to simplify image boundary handling.\n. \n. The function supports the mode when src is already in the middle of dst . In this case, the\n. function does not copy src itself but simply constructs the border, for example:\n. \n. @code{.cpp}\n. // let border be the same in all directions\n. int border=2;\n. // constructs a larger image to fit both the image and the border\n. Mat gray_buf(rgb.rows + border*2, rgb.cols + border*2, rgb.depth());\n. // select the middle part of it w/o copying data\n. Mat gray(gray_canvas, Rect(border, border, rgb.cols, rgb.rows));\n. // convert image from RGB to grayscale\n. cvtColor(rgb, gray, COLOR_RGB2GRAY);\n. // form a border in-place\n. copyMakeBorder(gray, gray_buf, border, border,\n. border, border, BORDER_REPLICATE);\n. // now do some custom filtering ...\n. ...\n. @endcode\n. @note When the source image is a part (ROI) of a bigger image, the function will try to use the\n. pixels outside of the ROI to form a border. To disable this feature and always do extrapolation, as\n. if src was not a ROI, use borderType | #BORDER_ISOLATED.\n. \n. @param src Source image.\n. @param dst Destination image of the same type as src and the size Size(src.cols+left+right,\n. src.rows+top+bottom) .\n. @param top the top pixels\n. @param bottom the bottom pixels\n. @param left the left pixels\n. @param right Parameter specifying how many pixels in each direction from the source image rectangle\n. to extrapolate. For example, top=1, bottom=1, left=1, right=1 mean that 1 pixel-wide border needs\n. to be built.\n. @param borderType Border type. See borderInterpolate for details.\n. @param value Border value if borderType==BORDER_CONSTANT .\n. \n. @sa borderInterpolate' ... - -def copyTo(src: ndarray, mask: ndarray, dts: ndarray = ...) -> typing.Any: +def copyTo(src: Mat, mask: Mat, dts: Mat = ...) -> typing.Any: 'copyTo(src, mask[, dst]) -> dst\n. @brief This is an overloaded member function, provided for convenience (python)\n. Copies the matrix to another one.\n. When the operation mask is specified, if the Mat::create call shown above reallocates the matrix, the newly allocated matrix is initialized with all zeros before copying the data.\n. @param src source matrix.\n. @param dst Destination matrix. If it does not have a proper size or type before the operation, it is\n. reallocated.\n. @param mask Operation mask of the same size as \\*this. Its non-zero elements indicate which matrix\n. elements need to be copied. The mask has to be of type CV_8U and can have 1 or multiple channels.' ... - -def cornerEigenValsAndVecs(src: ndarray, blockSize, ksize, dts: ndarray = ..., borderType=...) -> typing.Any: +def cornerEigenValsAndVecs(src: Mat, blockSize, ksize, dts: Mat = ..., borderType=...) -> typing.Any: 'cornerEigenValsAndVecs(src, blockSize, ksize[, dst[, borderType]]) -> dst\n. @brief Calculates eigenvalues and eigenvectors of image blocks for corner detection.\n. \n. For every pixel \\f$p\\f$ , the function cornerEigenValsAndVecs considers a blockSize \\f$\\times\\f$ blockSize\n. neighborhood \\f$S(p)\\f$ . It calculates the covariation matrix of derivatives over the neighborhood as:\n. \n. \\f[M = \\begin{bmatrix} \\sum _{S(p)}(dI/dx)^2 & \\sum _{S(p)}dI/dx dI/dy \\\\ \\sum _{S(p)}dI/dx dI/dy & \\sum _{S(p)}(dI/dy)^2 \\end{bmatrix}\\f]\n. \n. where the derivatives are computed using the Sobel operator.\n. \n. After that, it finds eigenvectors and eigenvalues of \\f$M\\f$ and stores them in the destination image as\n. \\f$(\\lambda_1, \\lambda_2, x_1, y_1, x_2, y_2)\\f$ where\n. \n. - \\f$\\lambda_1, \\lambda_2\\f$ are the non-sorted eigenvalues of \\f$M\\f$\n. - \\f$x_1, y_1\\f$ are the eigenvectors corresponding to \\f$\\lambda_1\\f$\n. - \\f$x_2, y_2\\f$ are the eigenvectors corresponding to \\f$\\lambda_2\\f$\n. \n. The output of the function can be used for robust edge or corner detection.\n. \n. @param src Input single-channel 8-bit or floating-point image.\n. @param dst Image to store the results. It has the same size as src and the type CV_32FC(6) .\n. @param blockSize Neighborhood size (see details below).\n. @param ksize Aperture parameter for the Sobel operator.\n. @param borderType Pixel extrapolation method. See #BorderTypes. #BORDER_WRAP is not supported.\n. \n. @sa cornerMinEigenVal, cornerHarris, preCornerDetect' ... - -def cornerHarris(src: ndarray, blockSize, ksize, k, dts: ndarray = ..., borderType=...) -> typing.Any: +def cornerHarris(src: Mat, blockSize, ksize, k, dts: Mat = ..., borderType=...) -> typing.Any: 'cornerHarris(src, blockSize, ksize, k[, dst[, borderType]]) -> dst\n. @brief Harris corner detector.\n. \n. The function runs the Harris corner detector on the image. Similarly to cornerMinEigenVal and\n. cornerEigenValsAndVecs , for each pixel \\f$(x, y)\\f$ it calculates a \\f$2\\times2\\f$ gradient covariance\n. matrix \\f$M^{(x,y)}\\f$ over a \\f$\\texttt{blockSize} \\times \\texttt{blockSize}\\f$ neighborhood. Then, it\n. computes the following characteristic:\n. \n. \\f[\\texttt{dst} (x,y) = \\mathrm{det} M^{(x,y)} - k \\cdot \\left ( \\mathrm{tr} M^{(x,y)} \\right )^2\\f]\n. \n. Corners in the image can be found as the local maxima of this response map.\n. \n. @param src Input single-channel 8-bit or floating-point image.\n. @param dst Image to store the Harris detector responses. It has the type CV_32FC1 and the same\n. size as src .\n. @param blockSize Neighborhood size (see the details on #cornerEigenValsAndVecs ).\n. @param ksize Aperture parameter for the Sobel operator.\n. @param k Harris detector free parameter. See the formula above.\n. @param borderType Pixel extrapolation method. See #BorderTypes. #BORDER_WRAP is not supported.' ... - -def cornerMinEigenVal(src: ndarray, blockSize, dts: ndarray = ..., ksize=..., borderType=...) -> typing.Any: +def cornerMinEigenVal(src: Mat, blockSize, dts: Mat = ..., ksize=..., borderType=...) -> typing.Any: 'cornerMinEigenVal(src, blockSize[, dst[, ksize[, borderType]]]) -> dst\n. @brief Calculates the minimal eigenvalue of gradient matrices for corner detection.\n. \n. The function is similar to cornerEigenValsAndVecs but it calculates and stores only the minimal\n. eigenvalue of the covariance matrix of derivatives, that is, \\f$\\min(\\lambda_1, \\lambda_2)\\f$ in terms\n. of the formulae in the cornerEigenValsAndVecs description.\n. \n. @param src Input single-channel 8-bit or floating-point image.\n. @param dst Image to store the minimal eigenvalues. It has the type CV_32FC1 and the same size as\n. src .\n. @param blockSize Neighborhood size (see the details on #cornerEigenValsAndVecs ).\n. @param ksize Aperture parameter for the Sobel operator.\n. @param borderType Pixel extrapolation method. See #BorderTypes. #BORDER_WRAP is not supported.' ... - -def cornerSubPix(image: ndarray, corners, winSize, zeroZone, criteria) -> typing.Any: +def cornerSubPix(image: Mat, corners, winSize, zeroZone, criteria) -> typing.Any: 'cornerSubPix(image, corners, winSize, zeroZone, criteria) -> corners\n. @brief Refines the corner locations.\n. \n. The function iterates to find the sub-pixel accurate location of corners or radial saddle points, as\n. shown on the figure below.\n. \n. ![image](pics/cornersubpix.png)\n. \n. Sub-pixel accurate corner locator is based on the observation that every vector from the center \\f$q\\f$\n. to a point \\f$p\\f$ located within a neighborhood of \\f$q\\f$ is orthogonal to the image gradient at \\f$p\\f$\n. subject to image and measurement noise. Consider the expression:\n. \n. \\f[\\epsilon _i = {DI_{p_i}}^T \\cdot (q - p_i)\\f]\n. \n. where \\f${DI_{p_i}}\\f$ is an image gradient at one of the points \\f$p_i\\f$ in a neighborhood of \\f$q\\f$ . The\n. value of \\f$q\\f$ is to be found so that \\f$\\epsilon_i\\f$ is minimized. A system of equations may be set up\n. with \\f$\\epsilon_i\\f$ set to zero:\n. \n. \\f[\\sum _i(DI_{p_i} \\cdot {DI_{p_i}}^T) \\cdot q - \\sum _i(DI_{p_i} \\cdot {DI_{p_i}}^T \\cdot p_i)\\f]\n. \n. where the gradients are summed within a neighborhood ("search window") of \\f$q\\f$ . Calling the first\n. gradient term \\f$G\\f$ and the second gradient term \\f$b\\f$ gives:\n. \n. \\f[q = G^{-1} \\cdot b\\f]\n. \n. The algorithm sets the center of the neighborhood window at this new center \\f$q\\f$ and then iterates\n. until the center stays within a set threshold.\n. \n. @param image Input single-channel, 8-bit or float image.\n. @param corners Initial coordinates of the input corners and refined coordinates provided for\n. output.\n. @param winSize Half of the side length of the search window. For example, if winSize=Size(5,5) ,\n. then a \\f$(5*2+1) \\times (5*2+1) = 11 \\times 11\\f$ search window is used.\n. @param zeroZone Half of the size of the dead region in the middle of the search zone over which\n. the summation in the formula below is not done. It is used sometimes to avoid possible\n. singularities of the autocorrelation matrix. The value of (-1,-1) indicates that there is no such\n. a size.\n. @param criteria Criteria for termination of the iterative process of corner refinement. That is,\n. the process of corner position refinement stops either after criteria.maxCount iterations or when\n. the corner position moves by less than criteria.epsilon on some iteration.' ... - def correctMatches(F, points1, points2, newPoints1=..., newPoints2=...) -> typing.Any: 'correctMatches(F, points1, points2[, newPoints1[, newPoints2]]) -> newPoints1, newPoints2\n. @brief Refines coordinates of corresponding points.\n. \n. @param F 3x3 fundamental matrix.\n. @param points1 1xN array containing the first set of points.\n. @param points2 1xN array containing the second set of points.\n. @param newPoints1 The optimized points1.\n. @param newPoints2 The optimized points2.\n. \n. The function implements the Optimal Triangulation Method (see Multiple View Geometry for details).\n. For each given point correspondence points1[i] \\<-\\> points2[i], and a fundamental matrix F, it\n. computes the corrected correspondences newPoints1[i] \\<-\\> newPoints2[i] that minimize the geometric\n. error \\f$d(points1[i], newPoints1[i])^2 + d(points2[i],newPoints2[i])^2\\f$ (where \\f$d(a,b)\\f$ is the\n. geometric distance between points \\f$a\\f$ and \\f$b\\f$ ) subject to the epipolar constraint\n. \\f$newPoints2^T * F * newPoints1 = 0\\f$ .' ... - def countNonZero(src) -> typing.Any: 'countNonZero(src) -> retval\n. @brief Counts non-zero array elements.\n. \n. The function returns the number of non-zero elements in src :\n. \\f[\\sum _{I: \\; \\texttt{src} (I) \\ne0 } 1\\f]\n. @param src single-channel array.\n. @sa mean, meanStdDev, norm, minMaxLoc, calcCovarMatrix' ... - def createAlignMTB(max_bits=..., exclude_range=..., cut=...) -> typing.Any: 'createAlignMTB([, max_bits[, exclude_range[, cut]]]) -> retval\n. @brief Creates AlignMTB object\n. \n. @param max_bits logarithm to the base 2 of maximal shift in each dimension. Values of 5 and 6 are\n. usually good enough (31 and 63 pixels shift respectively).\n. @param exclude_range range for exclusion bitmap that is constructed to suppress noise around the\n. median value.\n. @param cut if true cuts images, otherwise fills the new regions with zeros.' ... - def createBackgroundSubtractorKNN(history=..., dist2Threshold=..., detectShadows=...) -> typing.Any: 'createBackgroundSubtractorKNN([, history[, dist2Threshold[, detectShadows]]]) -> retval\n. @brief Creates KNN Background Subtractor\n. \n. @param history Length of the history.\n. @param dist2Threshold Threshold on the squared distance between the pixel and the sample to decide\n. whether a pixel is close to that sample. This parameter does not affect the background update.\n. @param detectShadows If true, the algorithm will detect shadows and mark them. It decreases the\n. speed a bit, so if you do not need this feature, set the parameter to false.' ... - def createBackgroundSubtractorMOG2(history=..., varThreshold=..., detectShadows=...) -> typing.Any: 'createBackgroundSubtractorMOG2([, history[, varThreshold[, detectShadows]]]) -> retval\n. @brief Creates MOG2 Background Subtractor\n. \n. @param history Length of the history.\n. @param varThreshold Threshold on the squared Mahalanobis distance between the pixel and the model\n. to decide whether a pixel is well described by the background model. This parameter does not\n. affect the background update.\n. @param detectShadows If true, the algorithm will detect shadows and mark them. It decreases the\n. speed a bit, so if you do not need this feature, set the parameter to false.' ... - def createButton(buttonName, onChange, userData=..., buttonType=..., initialButtonState=...) -> typing.Any: 'createButton(buttonName, onChange [, userData, buttonType, initialButtonState]) -> None' ... - def createCLAHE(clipLimit=..., tileGridSize=...) -> typing.Any: 'createCLAHE([, clipLimit[, tileGridSize]]) -> retval\n. @brief Creates a smart pointer to a cv::CLAHE class and initializes it.\n. \n. @param clipLimit Threshold for contrast limiting.\n. @param tileGridSize Size of grid for histogram equalization. Input image will be divided into\n. equally sized rectangular tiles. tileGridSize defines the number of tiles in row and column.' ... - def createCalibrateDebevec(samples=..., lambda_=..., random=...) -> typing.Any: 'createCalibrateDebevec([, samples[, lambda[, random]]]) -> retval\n. @brief Creates CalibrateDebevec object\n. \n. @param samples number of pixel locations to use\n. @param lambda smoothness term weight. Greater values produce smoother results, but can alter the\n. response.\n. @param random if true sample pixel locations are chosen at random, otherwise they form a\n. rectangular grid.' ... - def createCalibrateRobertson(max_iter=..., threshold=...) -> typing.Any: 'createCalibrateRobertson([, max_iter[, threshold]]) -> retval\n. @brief Creates CalibrateRobertson object\n. \n. @param max_iter maximal number of Gauss-Seidel solver iterations.\n. @param threshold target difference between results of two successive steps of the minimization.' ... - def createGeneralizedHoughBallard() -> typing.Any: 'createGeneralizedHoughBallard() -> retval\n. @brief Creates a smart pointer to a cv::GeneralizedHoughBallard class and initializes it.' ... - def createGeneralizedHoughGuil() -> typing.Any: 'createGeneralizedHoughGuil() -> retval\n. @brief Creates a smart pointer to a cv::GeneralizedHoughGuil class and initializes it.' ... - -def createHanningWindow(winSize, type, dts: ndarray = ...) -> typing.Any: +def createHanningWindow(winSize, type, dts: Mat = ...) -> typing.Any: 'createHanningWindow(winSize, type[, dst]) -> dst\n. @brief This function computes a Hanning window coefficients in two dimensions.\n. \n. See (http://en.wikipedia.org/wiki/Hann_function) and (http://en.wikipedia.org/wiki/Window_function)\n. for more information.\n. \n. An example is shown below:\n. @code\n. // create hanning window of size 100x100 and type CV_32F\n. Mat hann;\n. createHanningWindow(hann, Size(100, 100), CV_32F);\n. @endcode\n. @param dst Destination array to place Hann coefficients in\n. @param winSize The window size specifications (both width and height must be > 1)\n. @param type Created array type' ... - def createLineSegmentDetector(_refine=..., _scale=..., _sigma_scale=..., _quant=..., _ang_th=..., _log_eps=..., _density_th=..., _n_bins=...) -> typing.Any: 'createLineSegmentDetector([, _refine[, _scale[, _sigma_scale[, _quant[, _ang_th[, _log_eps[, _density_th[, _n_bins]]]]]]]]) -> retval\n. @brief Creates a smart pointer to a LineSegmentDetector object and initializes it.\n. \n. The LineSegmentDetector algorithm is defined using the standard values. Only advanced users may want\n. to edit those, as to tailor it for their own application.\n. \n. @param _refine The way found lines will be refined, see #LineSegmentDetectorModes\n. @param _scale The scale of the image that will be used to find the lines. Range (0..1].\n. @param _sigma_scale Sigma for Gaussian filter. It is computed as sigma = _sigma_scale/_scale.\n. @param _quant Bound to the quantization error on the gradient norm.\n. @param _ang_th Gradient angle tolerance in degrees.\n. @param _log_eps Detection threshold: -log10(NFA) \\> log_eps. Used only when advance refinement\n. is chosen.\n. @param _density_th Minimal density of aligned region points in the enclosing rectangle.\n. @param _n_bins Number of bins in pseudo-ordering of gradient modulus.\n. \n. @note Implementation has been removed due original code license conflict' ... - def createMergeDebevec() -> typing.Any: 'createMergeDebevec() -> retval\n. @brief Creates MergeDebevec object' ... - def createMergeMertens(contrast_weight=..., saturation_weight=..., exposure_weight=...) -> typing.Any: 'createMergeMertens([, contrast_weight[, saturation_weight[, exposure_weight]]]) -> retval\n. @brief Creates MergeMertens object\n. \n. @param contrast_weight contrast measure weight. See MergeMertens.\n. @param saturation_weight saturation measure weight\n. @param exposure_weight well-exposedness measure weight' ... - def createMergeRobertson() -> typing.Any: 'createMergeRobertson() -> retval\n. @brief Creates MergeRobertson object' ... - def createTonemap(gamma=...) -> typing.Any: 'createTonemap([, gamma]) -> retval\n. @brief Creates simple linear mapper with gamma correction\n. \n. @param gamma positive value for gamma correction. Gamma value of 1.0 implies no correction, gamma\n. equal to 2.2f is suitable for most displays.\n. Generally gamma \\> 1 brightens the image and gamma \\< 1 darkens it.' ... - def createTonemapDrago(gamma=..., saturation=..., bias=...) -> typing.Any: 'createTonemapDrago([, gamma[, saturation[, bias]]]) -> retval\n. @brief Creates TonemapDrago object\n. \n. @param gamma gamma value for gamma correction. See createTonemap\n. @param saturation positive saturation enhancement value. 1.0 preserves saturation, values greater\n. than 1 increase saturation and values less than 1 decrease it.\n. @param bias value for bias function in [0, 1] range. Values from 0.7 to 0.9 usually give best\n. results, default value is 0.85.' ... - def createTonemapMantiuk(gamma=..., scale=..., saturation=...) -> typing.Any: 'createTonemapMantiuk([, gamma[, scale[, saturation]]]) -> retval\n. @brief Creates TonemapMantiuk object\n. \n. @param gamma gamma value for gamma correction. See createTonemap\n. @param scale contrast scale factor. HVS response is multiplied by this parameter, thus compressing\n. dynamic range. Values from 0.6 to 0.9 produce best results.\n. @param saturation saturation enhancement value. See createTonemapDrago' ... - def createTonemapReinhard(gamma=..., intensity=..., light_adapt=..., color_adapt=...) -> typing.Any: "createTonemapReinhard([, gamma[, intensity[, light_adapt[, color_adapt]]]]) -> retval\n. @brief Creates TonemapReinhard object\n. \n. @param gamma gamma value for gamma correction. See createTonemap\n. @param intensity result intensity in [-8, 8] range. Greater intensity produces brighter results.\n. @param light_adapt light adaptation in [0, 1] range. If 1 adaptation is based only on pixel\n. value, if 0 it's global, otherwise it's a weighted mean of this two cases.\n. @param color_adapt chromatic adaptation in [0, 1] range. If 1 channels are treated independently,\n. if 0 adaptation level is the same for each channel." ... - def createTrackbar(trackbarName, windowName, value, count, onChange) -> typing.Any: 'createTrackbar(trackbarName, windowName, value, count, onChange) -> None' ... - def cubeRoot(val) -> typing.Any: 'cubeRoot(val) -> retval\n. @brief Computes the cube root of an argument.\n. \n. The function cubeRoot computes \\f$\\sqrt[3]{\\texttt{val}}\\f$. Negative arguments are handled correctly.\n. NaN and Inf are not handled. The accuracy approaches the maximum possible accuracy for\n. single-precision data.\n. @param val A function argument.' ... - cuda_BufferPool = _mod_cv2.cuda_BufferPool cuda_DeviceInfo = _mod_cv2.cuda_DeviceInfo cuda_Event = _mod_cv2.cuda_Event @@ -2245,68 +2034,54 @@ cuda_GpuMat_Allocator = _mod_cv2.cuda_GpuMat_Allocator cuda_HostMem = _mod_cv2.cuda_HostMem cuda_Stream = _mod_cv2.cuda_Stream cuda_TargetArchs = _mod_cv2.cuda_TargetArchs - - -def cvtColor(src: ndarray, code: int, dts: ndarray = ..., dstCn: int = ...) -> ndarray: +def cvtColor(src: Mat, code: int, dts: Mat = ..., dstCn: int = ...) -> Mat: 'cvtColor(src, code[, dst[, dstCn]]) -> dst\n. @brief Converts an image from one color space to another.\n. \n. The function converts an input image from one color space to another. In case of a transformation\n. to-from RGB color space, the order of the channels should be specified explicitly (RGB or BGR). Note\n. that the default color format in OpenCV is often referred to as RGB but it is actually BGR (the\n. bytes are reversed). So the first byte in a standard (24-bit) color image will be an 8-bit Blue\n. component, the second byte will be Green, and the third byte will be Red. The fourth, fifth, and\n. sixth bytes would then be the second pixel (Blue, then Green, then Red), and so on.\n. \n. The conventional ranges for R, G, and B channel values are:\n. - 0 to 255 for CV_8U images\n. - 0 to 65535 for CV_16U images\n. - 0 to 1 for CV_32F images\n. \n. In case of linear transformations, the range does not matter. But in case of a non-linear\n. transformation, an input RGB image should be normalized to the proper value range to get the correct\n. results, for example, for RGB \\f$\\rightarrow\\f$ L\\*u\\*v\\* transformation. For example, if you have a\n. 32-bit floating-point image directly converted from an 8-bit image without any scaling, then it will\n. have the 0..255 value range instead of 0..1 assumed by the function. So, before calling #cvtColor ,\n. you need first to scale the image down:\n. @code\n. img *= 1./255;\n. cvtColor(img, img, COLOR_BGR2Luv);\n. @endcode\n. If you use #cvtColor with 8-bit images, the conversion will have some information lost. For many\n. applications, this will not be noticeable but it is recommended to use 32-bit images in applications\n. that need the full range of colors or that convert an image before an operation and then convert\n. back.\n. \n. If conversion adds the alpha channel, its value will set to the maximum of corresponding channel\n. range: 255 for CV_8U, 65535 for CV_16U, 1 for CV_32F.\n. \n. @param src input image: 8-bit unsigned, 16-bit unsigned ( CV_16UC... ), or single-precision\n. floating-point.\n. @param dst output image of the same size and depth as src.\n. @param code color space conversion code (see #ColorConversionCodes).\n. @param dstCn number of channels in the destination image; if the parameter is 0, the number of the\n. channels is derived automatically from src and code.\n. \n. @see @ref imgproc_color_conversions' ... - -def cvtColorTwoPlane(src1: ndarray, src2: ndarray, code: int, dts: ndarray = ...) -> typing.Any: +def cvtColorTwoPlane(src1: Mat, src2: Mat, code: int, dts: Mat = ...) -> typing.Any: 'cvtColorTwoPlane(src1, src2, code[, dst]) -> dst\n. @brief Converts an image from one color space to another where the source image is\n. stored in two planes.\n. \n. This function only supports YUV420 to RGB conversion as of now.\n. \n. @param src1: 8-bit image (#CV_8U) of the Y plane.\n. @param src2: image containing interleaved U/V plane.\n. @param dst: output image.\n. @param code: Specifies the type of conversion. It can take any of the following values:\n. - #COLOR_YUV2BGR_NV12\n. - #COLOR_YUV2RGB_NV12\n. - #COLOR_YUV2BGRA_NV12\n. - #COLOR_YUV2RGBA_NV12\n. - #COLOR_YUV2BGR_NV21\n. - #COLOR_YUV2RGB_NV21\n. - #COLOR_YUV2BGRA_NV21\n. - #COLOR_YUV2RGBA_NV21' ... - -def dct(src: ndarray, dts: ndarray = ..., flags: int = ...) -> typing.Any: +def dct(src: Mat, dts: Mat = ..., flags: int = ...) -> typing.Any: 'dct(src[, dst[, flags]]) -> dst\n. @brief Performs a forward or inverse discrete Cosine transform of 1D or 2D array.\n. \n. The function cv::dct performs a forward or inverse discrete Cosine transform (DCT) of a 1D or 2D\n. floating-point array:\n. - Forward Cosine transform of a 1D vector of N elements:\n. \\f[Y = C^{(N)} \\cdot X\\f]\n. where\n. \\f[C^{(N)}_{jk}= \\sqrt{\\alpha_j/N} \\cos \\left ( \\frac{\\pi(2k+1)j}{2N} \\right )\\f]\n. and\n. \\f$\\alpha_0=1\\f$, \\f$\\alpha_j=2\\f$ for *j \\> 0*.\n. - Inverse Cosine transform of a 1D vector of N elements:\n. \\f[X = \\left (C^{(N)} \\right )^{-1} \\cdot Y = \\left (C^{(N)} \\right )^T \\cdot Y\\f]\n. (since \\f$C^{(N)}\\f$ is an orthogonal matrix, \\f$C^{(N)} \\cdot \\left(C^{(N)}\\right)^T = I\\f$ )\n. - Forward 2D Cosine transform of M x N matrix:\n. \\f[Y = C^{(N)} \\cdot X \\cdot \\left (C^{(N)} \\right )^T\\f]\n. - Inverse 2D Cosine transform of M x N matrix:\n. \\f[X = \\left (C^{(N)} \\right )^T \\cdot X \\cdot C^{(N)}\\f]\n. \n. The function chooses the mode of operation by looking at the flags and size of the input array:\n. - If (flags & #DCT_INVERSE) == 0 , the function does a forward 1D or 2D transform. Otherwise, it\n. is an inverse 1D or 2D transform.\n. - If (flags & #DCT_ROWS) != 0 , the function performs a 1D transform of each row.\n. - If the array is a single column or a single row, the function performs a 1D transform.\n. - If none of the above is true, the function performs a 2D transform.\n. \n. @note Currently dct supports even-size arrays (2, 4, 6 ...). For data analysis and approximation, you\n. can pad the array when necessary.\n. Also, the function performance depends very much, and not monotonically, on the array size (see\n. getOptimalDFTSize ). In the current implementation DCT of a vector of size N is calculated via DFT\n. of a vector of size N/2 . Thus, the optimal DCT size N1 \\>= N can be calculated as:\n. @code\n. size_t getOptimalDCTSize(size_t N) { return 2*getOptimalDFTSize((N+1)/2); }\n. N1 = getOptimalDCTSize(N);\n. @endcode\n. @param src input floating-point array.\n. @param dst output array of the same size and type as src .\n. @param flags transformation flags as a combination of cv::DftFlags (DCT_*)\n. @sa dft , getOptimalDFTSize , idct' ... - -def decolor(src: ndarray, grayscale=..., color_boost=...) -> typing.Any: +def decolor(src: Mat, grayscale=..., color_boost=...) -> typing.Any: 'decolor(src[, grayscale[, color_boost]]) -> grayscale, color_boost\n. @brief Transforms a color image to a grayscale image. It is a basic tool in digital printing, stylized\n. black-and-white photograph rendering, and in many single channel image processing applications\n. @cite CL12 .\n. \n. @param src Input 8-bit 3-channel image.\n. @param grayscale Output 8-bit 1-channel image.\n. @param color_boost Output 8-bit 3-channel image.\n. \n. This function is to be applied on color images.' ... - def decomposeEssentialMat(E, R1=..., R2=..., t=...) -> typing.Any: "decomposeEssentialMat(E[, R1[, R2[, t]]]) -> R1, R2, t\n. @brief Decompose an essential matrix to possible rotations and translation.\n. \n. @param E The input essential matrix.\n. @param R1 One possible rotation matrix.\n. @param R2 Another possible rotation matrix.\n. @param t One possible translation.\n. \n. This function decomposes the essential matrix E using svd decomposition @cite HartleyZ00. In\n. general, four possible poses exist for the decomposition of E. They are \\f$[R_1, t]\\f$,\n. \\f$[R_1, -t]\\f$, \\f$[R_2, t]\\f$, \\f$[R_2, -t]\\f$.\n. \n. If E gives the epipolar constraint \\f$[p_2; 1]^T A^{-T} E A^{-1} [p_1; 1] = 0\\f$ between the image\n. points \\f$p_1\\f$ in the first image and \\f$p_2\\f$ in second image, then any of the tuples\n. \\f$[R_1, t]\\f$, \\f$[R_1, -t]\\f$, \\f$[R_2, t]\\f$, \\f$[R_2, -t]\\f$ is a change of basis from the first\n. camera's coordinate system to the second camera's coordinate system. However, by decomposing E, one\n. can only get the direction of the translation. For this reason, the translation t is returned with\n. unit length." ... - def decomposeHomographyMat(H, K, rotations=..., translations=..., normals=...) -> typing.Any: "decomposeHomographyMat(H, K[, rotations[, translations[, normals]]]) -> retval, rotations, translations, normals\n. @brief Decompose a homography matrix to rotation(s), translation(s) and plane normal(s).\n. \n. @param H The input homography matrix between two images.\n. @param K The input intrinsic camera calibration matrix.\n. @param rotations Array of rotation matrices.\n. @param translations Array of translation matrices.\n. @param normals Array of plane normal matrices.\n. \n. This function extracts relative camera motion between two views of a planar object and returns up to\n. four mathematical solution tuples of rotation, translation, and plane normal. The decomposition of\n. the homography matrix H is described in detail in @cite Malis.\n. \n. If the homography H, induced by the plane, gives the constraint\n. \\f[s_i \\vecthree{x'_i}{y'_i}{1} \\sim H \\vecthree{x_i}{y_i}{1}\\f] on the source image points\n. \\f$p_i\\f$ and the destination image points \\f$p'_i\\f$, then the tuple of rotations[k] and\n. translations[k] is a change of basis from the source camera's coordinate system to the destination\n. camera's coordinate system. However, by decomposing H, one can only get the translation normalized\n. by the (typically unknown) depth of the scene, i.e. its direction but with normalized length.\n. \n. If point correspondences are available, at least two solutions may further be invalidated, by\n. applying positive depth constraint, i.e. all points must be in front of the camera." ... - def decomposeProjectionMatrix(projMatrix, cameraMatrix=..., rotMatrix=..., transVect=..., rotMatrixX=..., rotMatrixY=..., rotMatrixZ=..., eulerAngles=...) -> typing.Any: 'decomposeProjectionMatrix(projMatrix[, cameraMatrix[, rotMatrix[, transVect[, rotMatrixX[, rotMatrixY[, rotMatrixZ[, eulerAngles]]]]]]]) -> cameraMatrix, rotMatrix, transVect, rotMatrixX, rotMatrixY, rotMatrixZ, eulerAngles\n. @brief Decomposes a projection matrix into a rotation matrix and a camera matrix.\n. \n. @param projMatrix 3x4 input projection matrix P.\n. @param cameraMatrix Output 3x3 camera matrix K.\n. @param rotMatrix Output 3x3 external rotation matrix R.\n. @param transVect Output 4x1 translation vector T.\n. @param rotMatrixX Optional 3x3 rotation matrix around x-axis.\n. @param rotMatrixY Optional 3x3 rotation matrix around y-axis.\n. @param rotMatrixZ Optional 3x3 rotation matrix around z-axis.\n. @param eulerAngles Optional three-element vector containing three Euler angles of rotation in\n. degrees.\n. \n. The function computes a decomposition of a projection matrix into a calibration and a rotation\n. matrix and the position of a camera.\n. \n. It optionally returns three rotation matrices, one for each axis, and three Euler angles that could\n. be used in OpenGL. Note, there is always more than one sequence of rotations about the three\n. principal axes that results in the same orientation of an object, e.g. see @cite Slabaugh . Returned\n. tree rotation matrices and corresponding three Euler angles are only one of the possible solutions.\n. \n. The function is based on RQDecomp3x3 .' ... - -def demosaicing(src: ndarray, code: int, dts: ndarray = ..., dstCn: int = ...) -> typing.Any: +def demosaicing(src: Mat, code: int, dts: Mat = ..., dstCn: int = ...) -> typing.Any: 'demosaicing(src, code[, dst[, dstCn]]) -> dst\n. @brief main function for all demosaicing processes\n. \n. @param src input image: 8-bit unsigned or 16-bit unsigned.\n. @param dst output image of the same size and depth as src.\n. @param code Color space conversion code (see the description below).\n. @param dstCn number of channels in the destination image; if the parameter is 0, the number of the\n. channels is derived automatically from src and code.\n. \n. The function can do the following transformations:\n. \n. - Demosaicing using bilinear interpolation\n. \n. #COLOR_BayerBG2BGR , #COLOR_BayerGB2BGR , #COLOR_BayerRG2BGR , #COLOR_BayerGR2BGR\n. \n. #COLOR_BayerBG2GRAY , #COLOR_BayerGB2GRAY , #COLOR_BayerRG2GRAY , #COLOR_BayerGR2GRAY\n. \n. - Demosaicing using Variable Number of Gradients.\n. \n. #COLOR_BayerBG2BGR_VNG , #COLOR_BayerGB2BGR_VNG , #COLOR_BayerRG2BGR_VNG , #COLOR_BayerGR2BGR_VNG\n. \n. - Edge-Aware Demosaicing.\n. \n. #COLOR_BayerBG2BGR_EA , #COLOR_BayerGB2BGR_EA , #COLOR_BayerRG2BGR_EA , #COLOR_BayerGR2BGR_EA\n. \n. - Demosaicing with alpha channel\n. \n. #COLOR_BayerBG2BGRA , #COLOR_BayerGB2BGRA , #COLOR_BayerRG2BGRA , #COLOR_BayerGR2BGRA\n. \n. @sa cvtColor' ... - def denoise_TVL1(observations, result, lambda_=..., niters=...) -> typing.Any: "denoise_TVL1(observations, result[, lambda[, niters]]) -> None\n. @brief Primal-dual algorithm is an algorithm for solving special types of variational problems (that is,\n. finding a function to minimize some functional). As the image denoising, in particular, may be seen\n. as the variational problem, primal-dual algorithm then can be used to perform denoising and this is\n. exactly what is implemented.\n. \n. It should be noted, that this implementation was taken from the July 2013 blog entry\n. @cite MA13 , which also contained (slightly more general) ready-to-use source code on Python.\n. Subsequently, that code was rewritten on C++ with the usage of openCV by Vadim Pisarevsky at the end\n. of July 2013 and finally it was slightly adapted by later authors.\n. \n. Although the thorough discussion and justification of the algorithm involved may be found in\n. @cite ChambolleEtAl, it might make sense to skim over it here, following @cite MA13 . To begin\n. with, we consider the 1-byte gray-level images as the functions from the rectangular domain of\n. pixels (it may be seen as set\n. \\f$\\left\\{(x,y)\\in\\mathbb{N}\\times\\mathbb{N}\\mid 1\\leq x\\leq n,\\;1\\leq y\\leq m\\right\\}\\f$ for some\n. \\f$m,\\;n\\in\\mathbb{N}\\f$) into \\f$\\{0,1,\\dots,255\\}\\f$. We shall denote the noised images as \\f$f_i\\f$ and with\n. this view, given some image \\f$x\\f$ of the same size, we may measure how bad it is by the formula\n. \n. \\f[\\left\\|\\left\\|\\nabla x\\right\\|\\right\\| + \\lambda\\sum_i\\left\\|\\left\\|x-f_i\\right\\|\\right\\|\\f]\n. \n. \\f$\\|\\|\\cdot\\|\\|\\f$ here denotes \\f$L_2\\f$-norm and as you see, the first addend states that we want our\n. image to be smooth (ideally, having zero gradient, thus being constant) and the second states that\n. we want our result to be close to the observations we've got. If we treat \\f$x\\f$ as a function, this is\n. exactly the functional what we seek to minimize and here the Primal-Dual algorithm comes into play.\n. \n. @param observations This array should contain one or more noised versions of the image that is to\n. be restored.\n. @param result Here the denoised image will be stored. There is no need to do pre-allocation of\n. storage space, as it will be automatically allocated, if necessary.\n. @param lambda Corresponds to \\f$\\lambda\\f$ in the formulas above. As it is enlarged, the smooth\n. (blurred) images are treated more favorably than detailed (but maybe more noised) ones. Roughly\n. speaking, as it becomes smaller, the result will be more blur but more sever outliers will be\n. removed.\n. @param niters Number of iterations that the algorithm will run. Of course, as more iterations as\n. better, but it is hard to quantitatively refine this statement, so just use the default and\n. increase it if the results are poor." ... - def destroyAllWindows() -> typing.Any: 'destroyAllWindows() -> None\n. @brief Destroys all of the HighGUI windows.\n. \n. The function destroyAllWindows destroys all of the opened HighGUI windows.' ... - def destroyWindow(winname) -> typing.Any: 'destroyWindow(winname) -> None\n. @brief Destroys the specified window.\n. \n. The function destroyWindow destroys the window with the given name.\n. \n. @param winname Name of the window to be destroyed.' ... - -def detailEnhance(src: ndarray, dts: ndarray = ..., sigma_s=..., sigma_r=...) -> typing.Any: +def detailEnhance(src: Mat, dts: Mat = ..., sigma_s=..., sigma_r=...) -> typing.Any: 'detailEnhance(src[, dst[, sigma_s[, sigma_r]]]) -> dst\n. @brief This filter enhances the details of a particular image.\n. \n. @param src Input 8-bit 3-channel image.\n. @param dst Output image with the same size and type as src.\n. @param sigma_s %Range between 0 to 200.\n. @param sigma_r %Range between 0 to 1.' ... - detail_AffineBasedEstimator = _mod_cv2.detail_AffineBasedEstimator detail_AffineBestOf2NearestMatcher = _mod_cv2.detail_AffineBestOf2NearestMatcher detail_BestOf2NearestMatcher = _mod_cv2.detail_BestOf2NearestMatcher @@ -2343,48 +2118,38 @@ detail_SphericalProjector = _mod_cv2.detail_SphericalProjector detail_Timelapser = _mod_cv2.detail_Timelapser detail_TimelapserCrop = _mod_cv2.detail_TimelapserCrop detail_VoronoiSeamFinder = _mod_cv2.detail_VoronoiSeamFinder - - def determinant(mtx) -> typing.Any: 'determinant(mtx) -> retval\n. @brief Returns the determinant of a square floating-point matrix.\n. \n. The function cv::determinant calculates and returns the determinant of the\n. specified matrix. For small matrices ( mtx.cols=mtx.rows\\<=3 ), the\n. direct method is used. For larger matrices, the function uses LU\n. factorization with partial pivoting.\n. \n. For symmetric positively-determined matrices, it is also possible to use\n. eigen decomposition to calculate the determinant.\n. @param mtx input matrix that must have CV_32FC1 or CV_64FC1 type and\n. square size.\n. @sa trace, invert, solve, eigen, @ref MatrixExpressions' ... - -def dft(src: ndarray, dts: ndarray = ..., flags: int = ..., nonzeroRows=...) -> typing.Any: +def dft(src: Mat, dts: Mat = ..., flags: int = ..., nonzeroRows=...) -> typing.Any: 'dft(src[, dst[, flags[, nonzeroRows]]]) -> dst\n. @brief Performs a forward or inverse Discrete Fourier transform of a 1D or 2D floating-point array.\n. \n. The function cv::dft performs one of the following:\n. - Forward the Fourier transform of a 1D vector of N elements:\n. \\f[Y = F^{(N)} \\cdot X,\\f]\n. where \\f$F^{(N)}_{jk}=\\exp(-2\\pi i j k/N)\\f$ and \\f$i=\\sqrt{-1}\\f$\n. - Inverse the Fourier transform of a 1D vector of N elements:\n. \\f[\\begin{array}{l} X\'= \\left (F^{(N)} \\right )^{-1} \\cdot Y = \\left (F^{(N)} \\right )^* \\cdot y \\\\ X = (1/N) \\cdot X, \\end{array}\\f]\n. where \\f$F^*=\\left(\\textrm{Re}(F^{(N)})-\\textrm{Im}(F^{(N)})\\right)^T\\f$\n. - Forward the 2D Fourier transform of a M x N matrix:\n. \\f[Y = F^{(M)} \\cdot X \\cdot F^{(N)}\\f]\n. - Inverse the 2D Fourier transform of a M x N matrix:\n. \\f[\\begin{array}{l} X\'= \\left (F^{(M)} \\right )^* \\cdot Y \\cdot \\left (F^{(N)} \\right )^* \\\\ X = \\frac{1}{M \\cdot N} \\cdot X\' \\end{array}\\f]\n. \n. In case of real (single-channel) data, the output spectrum of the forward Fourier transform or input\n. spectrum of the inverse Fourier transform can be represented in a packed format called *CCS*\n. (complex-conjugate-symmetrical). It was borrowed from IPL (Intel\\* Image Processing Library). Here\n. is how 2D *CCS* spectrum looks:\n. \\f[\\begin{bmatrix} Re Y_{0,0} & Re Y_{0,1} & Im Y_{0,1} & Re Y_{0,2} & Im Y_{0,2} & \\cdots & Re Y_{0,N/2-1} & Im Y_{0,N/2-1} & Re Y_{0,N/2} \\\\ Re Y_{1,0} & Re Y_{1,1} & Im Y_{1,1} & Re Y_{1,2} & Im Y_{1,2} & \\cdots & Re Y_{1,N/2-1} & Im Y_{1,N/2-1} & Re Y_{1,N/2} \\\\ Im Y_{1,0} & Re Y_{2,1} & Im Y_{2,1} & Re Y_{2,2} & Im Y_{2,2} & \\cdots & Re Y_{2,N/2-1} & Im Y_{2,N/2-1} & Im Y_{1,N/2} \\\\ \\hdotsfor{9} \\\\ Re Y_{M/2-1,0} & Re Y_{M-3,1} & Im Y_{M-3,1} & \\hdotsfor{3} & Re Y_{M-3,N/2-1} & Im Y_{M-3,N/2-1}& Re Y_{M/2-1,N/2} \\\\ Im Y_{M/2-1,0} & Re Y_{M-2,1} & Im Y_{M-2,1} & \\hdotsfor{3} & Re Y_{M-2,N/2-1} & Im Y_{M-2,N/2-1}& Im Y_{M/2-1,N/2} \\\\ Re Y_{M/2,0} & Re Y_{M-1,1} & Im Y_{M-1,1} & \\hdotsfor{3} & Re Y_{M-1,N/2-1} & Im Y_{M-1,N/2-1}& Re Y_{M/2,N/2} \\end{bmatrix}\\f]\n. \n. In case of 1D transform of a real vector, the output looks like the first row of the matrix above.\n. \n. So, the function chooses an operation mode depending on the flags and size of the input array:\n. - If #DFT_ROWS is set or the input array has a single row or single column, the function\n. performs a 1D forward or inverse transform of each row of a matrix when #DFT_ROWS is set.\n. Otherwise, it performs a 2D transform.\n. - If the input array is real and #DFT_INVERSE is not set, the function performs a forward 1D or\n. 2D transform:\n. - When #DFT_COMPLEX_OUTPUT is set, the output is a complex matrix of the same size as\n. input.\n. - When #DFT_COMPLEX_OUTPUT is not set, the output is a real matrix of the same size as\n. input. In case of 2D transform, it uses the packed format as shown above. In case of a\n. single 1D transform, it looks like the first row of the matrix above. In case of\n. multiple 1D transforms (when using the #DFT_ROWS flag), each row of the output matrix\n. looks like the first row of the matrix above.\n. - If the input array is complex and either #DFT_INVERSE or #DFT_REAL_OUTPUT are not set, the\n. output is a complex array of the same size as input. The function performs a forward or\n. inverse 1D or 2D transform of the whole input array or each row of the input array\n. independently, depending on the flags DFT_INVERSE and DFT_ROWS.\n. - When #DFT_INVERSE is set and the input array is real, or it is complex but #DFT_REAL_OUTPUT\n. is set, the output is a real array of the same size as input. The function performs a 1D or 2D\n. inverse transformation of the whole input array or each individual row, depending on the flags\n. #DFT_INVERSE and #DFT_ROWS.\n. \n. If #DFT_SCALE is set, the scaling is done after the transformation.\n. \n. Unlike dct , the function supports arrays of arbitrary size. But only those arrays are processed\n. efficiently, whose sizes can be factorized in a product of small prime numbers (2, 3, and 5 in the\n. current implementation). Such an efficient DFT size can be calculated using the getOptimalDFTSize\n. method.\n. \n. The sample below illustrates how to calculate a DFT-based convolution of two 2D real arrays:\n. @code\n. void convolveDFT(InputArray A, InputArray B, OutputArray C)\n. {\n. // reallocate the output array if needed\n. C.create(abs(A.rows - B.rows)+1, abs(A.cols - B.cols)+1, A.type());\n. Size dftSize;\n. // calculate the size of DFT transform\n. dftSize.width = getOptimalDFTSize(A.cols + B.cols - 1);\n. dftSize.height = getOptimalDFTSize(A.rows + B.rows - 1);\n. \n. // allocate temporary buffers and initialize them with 0\'s\n. Mat tempA(dftSize, A.type(), Scalar::all(0));\n. Mat tempB(dftSize, B.type(), Scalar::all(0));\n. \n. // copy A and B to the top-left corners of tempA and tempB, respectively\n. Mat roiA(tempA, Rect(0,0,A.cols,A.rows));\n. A.copyTo(roiA);\n. Mat roiB(tempB, Rect(0,0,B.cols,B.rows));\n. B.copyTo(roiB);\n. \n. // now transform the padded A & B in-place;\n. // use "nonzeroRows" hint for faster processing\n. dft(tempA, tempA, 0, A.rows);\n. dft(tempB, tempB, 0, B.rows);\n. \n. // multiply the spectrums;\n. // the function handles packed spectrum representations well\n. mulSpectrums(tempA, tempB, tempA);\n. \n. // transform the product back from the frequency domain.\n. // Even though all the result rows will be non-zero,\n. // you need only the first C.rows of them, and thus you\n. // pass nonzeroRows == C.rows\n. dft(tempA, tempA, DFT_INVERSE + DFT_SCALE, C.rows);\n. \n. // now copy the result back to C.\n. tempA(Rect(0, 0, C.cols, C.rows)).copyTo(C);\n. \n. // all the temporary buffers will be deallocated automatically\n. }\n. @endcode\n. To optimize this sample, consider the following approaches:\n. - Since nonzeroRows != 0 is passed to the forward transform calls and since A and B are copied to\n. the top-left corners of tempA and tempB, respectively, it is not necessary to clear the whole\n. tempA and tempB. It is only necessary to clear the tempA.cols - A.cols ( tempB.cols - B.cols)\n. rightmost columns of the matrices.\n. - This DFT-based convolution does not have to be applied to the whole big arrays, especially if B\n. is significantly smaller than A or vice versa. Instead, you can calculate convolution by parts.\n. To do this, you need to split the output array C into multiple tiles. For each tile, estimate\n. which parts of A and B are required to calculate convolution in this tile. If the tiles in C are\n. too small, the speed will decrease a lot because of repeated work. In the ultimate case, when\n. each tile in C is a single pixel, the algorithm becomes equivalent to the naive convolution\n. algorithm. If the tiles are too big, the temporary arrays tempA and tempB become too big and\n. there is also a slowdown because of bad cache locality. So, there is an optimal tile size\n. somewhere in the middle.\n. - If different tiles in C can be calculated in parallel and, thus, the convolution is done by\n. parts, the loop can be threaded.\n. \n. All of the above improvements have been implemented in #matchTemplate and #filter2D . Therefore, by\n. using them, you can get the performance even better than with the above theoretically optimal\n. implementation. Though, those two functions actually calculate cross-correlation, not convolution,\n. so you need to "flip" the second convolution operand B vertically and horizontally using flip .\n. @note\n. - An example using the discrete fourier transform can be found at\n. opencv_source_code/samples/cpp/dft.cpp\n. - (Python) An example using the dft functionality to perform Wiener deconvolution can be found\n. at opencv_source/samples/python/deconvolution.py\n. - (Python) An example rearranging the quadrants of a Fourier image can be found at\n. opencv_source/samples/python/dft.py\n. @param src input array that could be real or complex.\n. @param dst output array whose size and type depends on the flags .\n. @param flags transformation flags, representing a combination of the #DftFlags\n. @param nonzeroRows when the parameter is not zero, the function assumes that only the first\n. nonzeroRows rows of the input array (#DFT_INVERSE is not set) or only the first nonzeroRows of the\n. output array (#DFT_INVERSE is set) contain non-zeros, thus, the function can handle the rest of the\n. rows more efficiently and save some time; this technique is very useful for calculating array\n. cross-correlation or convolution using DFT.\n. @sa dct , getOptimalDFTSize , mulSpectrums, filter2D , matchTemplate , flip , cartToPolar ,\n. magnitude , phase' ... - -def dilate(src: ndarray, kernel, dts: ndarray = ..., anchor=..., iterations=..., borderType=..., borderValue=...) -> typing.Any: +def dilate(src: Mat, kernel, dts: Mat = ..., anchor=..., iterations=..., borderType=..., borderValue=...) -> typing.Any: "dilate(src, kernel[, dst[, anchor[, iterations[, borderType[, borderValue]]]]]) -> dst\n. @brief Dilates an image by using a specific structuring element.\n. \n. The function dilates the source image using the specified structuring element that determines the\n. shape of a pixel neighborhood over which the maximum is taken:\n. \\f[\\texttt{dst} (x,y) = \\max _{(x',y'): \\, \\texttt{element} (x',y') \\ne0 } \\texttt{src} (x+x',y+y')\\f]\n. \n. The function supports the in-place mode. Dilation can be applied several ( iterations ) times. In\n. case of multi-channel images, each channel is processed independently.\n. \n. @param src input image; the number of channels can be arbitrary, but the depth should be one of\n. CV_8U, CV_16U, CV_16S, CV_32F or CV_64F.\n. @param dst output image of the same size and type as src.\n. @param kernel structuring element used for dilation; if elemenat=Mat(), a 3 x 3 rectangular\n. structuring element is used. Kernel can be created using #getStructuringElement\n. @param anchor position of the anchor within the element; default value (-1, -1) means that the\n. anchor is at the element center.\n. @param iterations number of times dilation is applied.\n. @param borderType pixel extrapolation method, see #BorderTypes. #BORDER_WRAP is not suported.\n. @param borderValue border value in case of a constant border\n. @sa erode, morphologyEx, getStructuringElement" ... - def displayOverlay(winname, text, delayms=...) -> typing.Any: 'displayOverlay(winname, text[, delayms]) -> None\n. @brief Displays a text on a window image as an overlay for a specified duration.\n. \n. The function displayOverlay displays useful information/tips on top of the window for a certain\n. amount of time *delayms*. The function does not modify the image, displayed in the window, that is,\n. after the specified delay the original content of the window is restored.\n. \n. @param winname Name of the window.\n. @param text Overlay text to write on a window image.\n. @param delayms The period (in milliseconds), during which the overlay text is displayed. If this\n. function is called before the previous overlay text timed out, the timer is restarted and the text\n. is updated. If this value is zero, the text never disappears.' ... - def displayStatusBar(winname, text, delayms=...) -> typing.Any: 'displayStatusBar(winname, text[, delayms]) -> None\n. @brief Displays a text on the window statusbar during the specified period of time.\n. \n. The function displayStatusBar displays useful information/tips on top of the window for a certain\n. amount of time *delayms* . This information is displayed on the window statusbar (the window must be\n. created with the CV_GUI_EXPANDED flags).\n. \n. @param winname Name of the window.\n. @param text Text to write on the window statusbar.\n. @param delayms Duration (in milliseconds) to display the text. If this function is called before\n. the previous text timed out, the timer is restarted and the text is updated. If this value is\n. zero, the text never disappears.' ... - -def distanceTransform(src: ndarray, distanceType, maskSize, dts: ndarray = ..., dstType=...) -> typing.Any: +def distanceTransform(src: Mat, distanceType, maskSize, dts: Mat = ..., dstType=...) -> typing.Any: 'distanceTransform(src, distanceType, maskSize[, dst[, dstType]]) -> dst\n. @overload\n. @param src 8-bit, single-channel (binary) source image.\n. @param dst Output image with calculated distances. It is a 8-bit or 32-bit floating-point,\n. single-channel image of the same size as src .\n. @param distanceType Type of distance, see #DistanceTypes\n. @param maskSize Size of the distance transform mask, see #DistanceTransformMasks. In case of the\n. #DIST_L1 or #DIST_C distance type, the parameter is forced to 3 because a \\f$3\\times 3\\f$ mask gives\n. the same result as \\f$5\\times 5\\f$ or any larger aperture.\n. @param dstType Type of output image. It can be CV_8U or CV_32F. Type CV_8U can be used only for\n. the first variant of the function and distanceType == #DIST_L1.' ... - -def distanceTransformWithLabels(src: ndarray, distanceType, maskSize, dts: ndarray = ..., labels=..., labelType=...) -> typing.Any: +def distanceTransformWithLabels(src: Mat, distanceType, maskSize, dts: Mat = ..., labels=..., labelType=...) -> typing.Any: "distanceTransformWithLabels(src, distanceType, maskSize[, dst[, labels[, labelType]]]) -> dst, labels\n. @brief Calculates the distance to the closest zero pixel for each pixel of the source image.\n. \n. The function cv::distanceTransform calculates the approximate or precise distance from every binary\n. image pixel to the nearest zero pixel. For zero image pixels, the distance will obviously be zero.\n. \n. When maskSize == #DIST_MASK_PRECISE and distanceType == #DIST_L2 , the function runs the\n. algorithm described in @cite Felzenszwalb04 . This algorithm is parallelized with the TBB library.\n. \n. In other cases, the algorithm @cite Borgefors86 is used. This means that for a pixel the function\n. finds the shortest path to the nearest zero pixel consisting of basic shifts: horizontal, vertical,\n. diagonal, or knight's move (the latest is available for a \\f$5\\times 5\\f$ mask). The overall\n. distance is calculated as a sum of these basic distances. Since the distance function should be\n. symmetric, all of the horizontal and vertical shifts must have the same cost (denoted as a ), all\n. the diagonal shifts must have the same cost (denoted as `b`), and all knight's moves must have the\n. same cost (denoted as `c`). For the #DIST_C and #DIST_L1 types, the distance is calculated\n. precisely, whereas for #DIST_L2 (Euclidean distance) the distance can be calculated only with a\n. relative error (a \\f$5\\times 5\\f$ mask gives more accurate results). For `a`,`b`, and `c`, OpenCV\n. uses the values suggested in the original paper:\n. - DIST_L1: `a = 1, b = 2`\n. - DIST_L2:\n. - `3 x 3`: `a=0.955, b=1.3693`\n. - `5 x 5`: `a=1, b=1.4, c=2.1969`\n. - DIST_C: `a = 1, b = 1`\n. \n. Typically, for a fast, coarse distance estimation #DIST_L2, a \\f$3\\times 3\\f$ mask is used. For a\n. more accurate distance estimation #DIST_L2, a \\f$5\\times 5\\f$ mask or the precise algorithm is used.\n. Note that both the precise and the approximate algorithms are linear on the number of pixels.\n. \n. This variant of the function does not only compute the minimum distance for each pixel \\f$(x, y)\\f$\n. but also identifies the nearest connected component consisting of zero pixels\n. (labelType==#DIST_LABEL_CCOMP) or the nearest zero pixel (labelType==#DIST_LABEL_PIXEL). Index of the\n. component/pixel is stored in `labels(x, y)`. When labelType==#DIST_LABEL_CCOMP, the function\n. automatically finds connected components of zero pixels in the input image and marks them with\n. distinct labels. When labelType==#DIST_LABEL_CCOMP, the function scans through the input image and\n. marks all the zero pixels with distinct labels.\n. \n. In this mode, the complexity is still linear. That is, the function provides a very fast way to\n. compute the Voronoi diagram for a binary image. Currently, the second variant can use only the\n. approximate distance transform algorithm, i.e. maskSize=#DIST_MASK_PRECISE is not supported\n. yet.\n. \n. @param src 8-bit, single-channel (binary) source image.\n. @param dst Output image with calculated distances. It is a 8-bit or 32-bit floating-point,\n. single-channel image of the same size as src.\n. @param labels Output 2D array of labels (the discrete Voronoi diagram). It has the type\n. CV_32SC1 and the same size as src.\n. @param distanceType Type of distance, see #DistanceTypes\n. @param maskSize Size of the distance transform mask, see #DistanceTransformMasks.\n. #DIST_MASK_PRECISE is not supported by this variant. In case of the #DIST_L1 or #DIST_C distance type,\n. the parameter is forced to 3 because a \\f$3\\times 3\\f$ mask gives the same result as \\f$5\\times\n. 5\\f$ or any larger aperture.\n. @param labelType Type of the label array to build, see #DistanceTransformLabelTypes." ... - -def divide(src1: ndarray, src2: ndarray, dts: ndarray = ..., scale=..., dtype=...) -> typing.Any: +def divide(src1: Mat, src2: Mat, dts: Mat = ..., scale=..., dtype=...) -> typing.Any: 'divide(src1, src2[, dst[, scale[, dtype]]]) -> dst\n. @brief Performs per-element division of two arrays or a scalar by an array.\n. \n. The function cv::divide divides one array by another:\n. \\f[\\texttt{dst(I) = saturate(src1(I)*scale/src2(I))}\\f]\n. or a scalar by an array when there is no src1 :\n. \\f[\\texttt{dst(I) = saturate(scale/src2(I))}\\f]\n. \n. Different channels of multi-channel arrays are processed independently.\n. \n. For integer types when src2(I) is zero, dst(I) will also be zero.\n. \n. @note In case of floating point data there is no special defined behavior for zero src2(I) values.\n. Regular floating-point division is used.\n. Expect correct IEEE-754 behaviour for floating-point data (with NaN, Inf result values).\n. \n. @note Saturation is not applied when the output array has the depth CV_32S. You may even get\n. result of an incorrect sign in the case of overflow.\n. @param src1 first input array.\n. @param src2 second input array of the same size and type as src1.\n. @param scale scalar factor.\n. @param dst output array of the same size and type as src2.\n. @param dtype optional depth of the output array; if -1, dst will have depth src2.depth(), but in\n. case of an array-by-array division, you can only pass -1 when src1.depth()==src2.depth().\n. @sa multiply, add, subtract\n\n\n\ndivide(scale, src2[, dst[, dtype]]) -> dst\n. @overload' ... - dnn_ClassificationModel = _mod_cv2.dnn_ClassificationModel dnn_DetectionModel = _mod_cv2.dnn_DetectionModel dnn_DictValue = _mod_cv2.dnn_DictValue @@ -2393,664 +2158,528 @@ dnn_Layer = _mod_cv2.dnn_Layer dnn_Model = _mod_cv2.dnn_Model dnn_Net = _mod_cv2.dnn_Net dnn_SegmentationModel = _mod_cv2.dnn_SegmentationModel - - def dnn_registerLayer() -> typing.Any: 'registerLayer(type, class) -> None' ... - def dnn_unregisterLayer() -> typing.Any: 'unregisterLayer(type) -> None' ... - -def drawChessboardCorners(image: ndarray, patternSize, corners, patternWasFound) -> typing.Any: +def drawChessboardCorners(image: Mat, patternSize, corners, patternWasFound) -> typing.Any: 'drawChessboardCorners(image, patternSize, corners, patternWasFound) -> image\n. @brief Renders the detected chessboard corners.\n. \n. @param image Destination image. It must be an 8-bit color image.\n. @param patternSize Number of inner corners per a chessboard row and column\n. (patternSize = cv::Size(points_per_row,points_per_column)).\n. @param corners Array of detected corners, the output of findChessboardCorners.\n. @param patternWasFound Parameter indicating whether the complete board was found or not. The\n. return value of findChessboardCorners should be passed here.\n. \n. The function draws individual chessboard corners detected either as red circles if the board was not\n. found, or as colored corners connected with lines if the board was found.' ... - -def drawContours(image: ndarray, contours, contourIdx, color, thickness=..., lineType=..., hierarchy=..., maxLevel=..., offset=...) -> typing.Any: +def drawContours(image: Mat, contours, contourIdx, color, thickness=..., lineType=..., hierarchy=..., maxLevel=..., offset=...) -> typing.Any: 'drawContours(image, contours, contourIdx, color[, thickness[, lineType[, hierarchy[, maxLevel[, offset]]]]]) -> image\n. @brief Draws contours outlines or filled contours.\n. \n. The function draws contour outlines in the image if \\f$\\texttt{thickness} \\ge 0\\f$ or fills the area\n. bounded by the contours if \\f$\\texttt{thickness}<0\\f$ . The example below shows how to retrieve\n. connected components from the binary image and label them: :\n. @include snippets/imgproc_drawContours.cpp\n. \n. @param image Destination image.\n. @param contours All the input contours. Each contour is stored as a point vector.\n. @param contourIdx Parameter indicating a contour to draw. If it is negative, all the contours are drawn.\n. @param color Color of the contours.\n. @param thickness Thickness of lines the contours are drawn with. If it is negative (for example,\n. thickness=#FILLED ), the contour interiors are drawn.\n. @param lineType Line connectivity. See #LineTypes\n. @param hierarchy Optional information about hierarchy. It is only needed if you want to draw only\n. some of the contours (see maxLevel ).\n. @param maxLevel Maximal level for drawn contours. If it is 0, only the specified contour is drawn.\n. If it is 1, the function draws the contour(s) and all the nested contours. If it is 2, the function\n. draws the contours, all the nested contours, all the nested-to-nested contours, and so on. This\n. parameter is only taken into account when there is hierarchy available.\n. @param offset Optional contour shift parameter. Shift all the drawn contours by the specified\n. \\f$\\texttt{offset}=(dx,dy)\\f$ .\n. @note When thickness=#FILLED, the function is designed to handle connected components with holes correctly\n. even when no hierarchy date is provided. This is done by analyzing all the outlines together\n. using even-odd rule. This may give incorrect results if you have a joint collection of separately retrieved\n. contours. In order to solve this problem, you need to call #drawContours separately for each sub-group\n. of contours, or iterate over the collection using contourIdx parameter.' ... - -def drawFrameAxes(image: ndarray, cameraMatrix, distCoeffs, rvec, tvec, length, thickness=...) -> typing.Any: +def drawFrameAxes(image: Mat, cameraMatrix, distCoeffs, rvec, tvec, length, thickness=...) -> typing.Any: 'drawFrameAxes(image, cameraMatrix, distCoeffs, rvec, tvec, length[, thickness]) -> image\n. @brief Draw axes of the world/object coordinate system from pose estimation. @sa solvePnP\n. \n. @param image Input/output image. It must have 1 or 3 channels. The number of channels is not altered.\n. @param cameraMatrix Input 3x3 floating-point matrix of camera intrinsic parameters.\n. \\f$A = \\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\\f$\n. @param distCoeffs Input vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$ of\n. 4, 5, 8, 12 or 14 elements. If the vector is empty, the zero distortion coefficients are assumed.\n. @param rvec Rotation vector (see @ref Rodrigues ) that, together with tvec, brings points from\n. the model coordinate system to the camera coordinate system.\n. @param tvec Translation vector.\n. @param length Length of the painted axes in the same unit than tvec (usually in meters).\n. @param thickness Line thickness of the painted axes.\n. \n. This function draws the axes of the world/object coordinate system w.r.t. to the camera frame.\n. OX is drawn in red, OY in green and OZ in blue.' ... - -def drawKeypoints(image: ndarray, keypoints, outImage, color=..., flags: int = ...) -> typing.Any: +def drawKeypoints(image: Mat, keypoints, outImage, color=..., flags: int = ...) -> typing.Any: 'drawKeypoints(image, keypoints, outImage[, color[, flags]]) -> outImage\n. @brief Draws keypoints.\n. \n. @param image Source image.\n. @param keypoints Keypoints from the source image.\n. @param outImage Output image. Its content depends on the flags value defining what is drawn in the\n. output image. See possible flags bit values below.\n. @param color Color of keypoints.\n. @param flags Flags setting drawing features. Possible flags bit values are defined by\n. DrawMatchesFlags. See details above in drawMatches .\n. \n. @note\n. For Python API, flags are modified as cv.DRAW_MATCHES_FLAGS_DEFAULT,\n. cv.DRAW_MATCHES_FLAGS_DRAW_RICH_KEYPOINTS, cv.DRAW_MATCHES_FLAGS_DRAW_OVER_OUTIMG,\n. cv.DRAW_MATCHES_FLAGS_NOT_DRAW_SINGLE_POINTS' ... - -def drawMarker(img: ndarray, position, color, markerType=..., markerSize=..., thickness=..., line_type=...) -> typing.Any: +def drawMarker(img: Mat, position, color, markerType=..., markerSize=..., thickness=..., line_type=...) -> typing.Any: 'drawMarker(img, position, color[, markerType[, markerSize[, thickness[, line_type]]]]) -> img\n. @brief Draws a marker on a predefined position in an image.\n. \n. The function cv::drawMarker draws a marker on a given position in the image. For the moment several\n. marker types are supported, see #MarkerTypes for more information.\n. \n. @param img Image.\n. @param position The point where the crosshair is positioned.\n. @param color Line color.\n. @param markerType The specific type of marker you want to use, see #MarkerTypes\n. @param thickness Line thickness.\n. @param line_type Type of the line, See #LineTypes\n. @param markerSize The length of the marker axis [default = 20 pixels]' ... - def drawMatches(img1, keypoints1, img2, keypoints2, matches1to2, outImg, matchColor=..., singlePointColor=..., matchesMask=..., flags: int = ...) -> typing.Any: 'drawMatches(img1, keypoints1, img2, keypoints2, matches1to2, outImg[, matchColor[, singlePointColor[, matchesMask[, flags]]]]) -> outImg\n. @brief Draws the found matches of keypoints from two images.\n. \n. @param img1 First source image.\n. @param keypoints1 Keypoints from the first source image.\n. @param img2 Second source image.\n. @param keypoints2 Keypoints from the second source image.\n. @param matches1to2 Matches from the first image to the second one, which means that keypoints1[i]\n. has a corresponding point in keypoints2[matches[i]] .\n. @param outImg Output image. Its content depends on the flags value defining what is drawn in the\n. output image. See possible flags bit values below.\n. @param matchColor Color of matches (lines and connected keypoints). If matchColor==Scalar::all(-1)\n. , the color is generated randomly.\n. @param singlePointColor Color of single keypoints (circles), which means that keypoints do not\n. have the matches. If singlePointColor==Scalar::all(-1) , the color is generated randomly.\n. @param matchesMask Mask determining which matches are drawn. If the mask is empty, all matches are\n. drawn.\n. @param flags Flags setting drawing features. Possible flags bit values are defined by\n. DrawMatchesFlags.\n. \n. This function draws matches of keypoints from two images in the output image. Match is a line\n. connecting two keypoints (circles). See cv::DrawMatchesFlags.' ... - def drawMatchesKnn(img1, keypoints1, img2, keypoints2, matches1to2, outImg, matchColor=..., singlePointColor=..., matchesMask=..., flags: int = ...) -> typing.Any: 'drawMatchesKnn(img1, keypoints1, img2, keypoints2, matches1to2, outImg[, matchColor[, singlePointColor[, matchesMask[, flags]]]]) -> outImg\n. @overload' ... - -def edgePreservingFilter(src: ndarray, dts: ndarray = ..., flags: int = ..., sigma_s=..., sigma_r=...) -> typing.Any: +def edgePreservingFilter(src: Mat, dts: Mat = ..., flags: int = ..., sigma_s=..., sigma_r=...) -> typing.Any: 'edgePreservingFilter(src[, dst[, flags[, sigma_s[, sigma_r]]]]) -> dst\n. @brief Filtering is the fundamental operation in image and video processing. Edge-preserving smoothing\n. filters are used in many different applications @cite EM11 .\n. \n. @param src Input 8-bit 3-channel image.\n. @param dst Output 8-bit 3-channel image.\n. @param flags Edge preserving filters: cv::RECURS_FILTER or cv::NORMCONV_FILTER\n. @param sigma_s %Range between 0 to 200.\n. @param sigma_r %Range between 0 to 1.' ... - -def eigen(src: ndarray, eigenvalues=..., eigenvectors=...) -> typing.Any: +def eigen(src: Mat, eigenvalues=..., eigenvectors=...) -> typing.Any: 'eigen(src[, eigenvalues[, eigenvectors]]) -> retval, eigenvalues, eigenvectors\n. @brief Calculates eigenvalues and eigenvectors of a symmetric matrix.\n. \n. The function cv::eigen calculates just eigenvalues, or eigenvalues and eigenvectors of the symmetric\n. matrix src:\n. @code\n. src*eigenvectors.row(i).t() = eigenvalues.at(i)*eigenvectors.row(i).t()\n. @endcode\n. \n. @note Use cv::eigenNonSymmetric for calculation of real eigenvalues and eigenvectors of non-symmetric matrix.\n. \n. @param src input matrix that must have CV_32FC1 or CV_64FC1 type, square size and be symmetrical\n. (src ^T^ == src).\n. @param eigenvalues output vector of eigenvalues of the same type as src; the eigenvalues are stored\n. in the descending order.\n. @param eigenvectors output matrix of eigenvectors; it has the same size and type as src; the\n. eigenvectors are stored as subsequent matrix rows, in the same order as the corresponding\n. eigenvalues.\n. @sa eigenNonSymmetric, completeSymm , PCA' ... - -def eigenNonSymmetric(src: ndarray, eigenvalues=..., eigenvectors=...) -> typing.Any: +def eigenNonSymmetric(src: Mat, eigenvalues=..., eigenvectors=...) -> typing.Any: 'eigenNonSymmetric(src[, eigenvalues[, eigenvectors]]) -> eigenvalues, eigenvectors\n. @brief Calculates eigenvalues and eigenvectors of a non-symmetric matrix (real eigenvalues only).\n. \n. @note Assumes real eigenvalues.\n. \n. The function calculates eigenvalues and eigenvectors (optional) of the square matrix src:\n. @code\n. src*eigenvectors.row(i).t() = eigenvalues.at(i)*eigenvectors.row(i).t()\n. @endcode\n. \n. @param src input matrix (CV_32FC1 or CV_64FC1 type).\n. @param eigenvalues output vector of eigenvalues (type is the same type as src).\n. @param eigenvectors output matrix of eigenvectors (type is the same type as src). The eigenvectors are stored as subsequent matrix rows, in the same order as the corresponding eigenvalues.\n. @sa eigen' ... - -def ellipse(img: ndarray, center, axes, angle, startAngle, endAngle, color, thickness=..., lineType=..., shift=...) -> typing.Any: +def ellipse(img: Mat, center, axes, angle, startAngle, endAngle, color, thickness=..., lineType=..., shift=...) -> typing.Any: 'ellipse(img, center, axes, angle, startAngle, endAngle, color[, thickness[, lineType[, shift]]]) -> img\n. @brief Draws a simple or thick elliptic arc or fills an ellipse sector.\n. \n. The function cv::ellipse with more parameters draws an ellipse outline, a filled ellipse, an elliptic\n. arc, or a filled ellipse sector. The drawing code uses general parametric form.\n. A piecewise-linear curve is used to approximate the elliptic arc\n. boundary. If you need more control of the ellipse rendering, you can retrieve the curve using\n. #ellipse2Poly and then render it with #polylines or fill it with #fillPoly. If you use the first\n. variant of the function and want to draw the whole ellipse, not an arc, pass `startAngle=0` and\n. `endAngle=360`. If `startAngle` is greater than `endAngle`, they are swapped. The figure below explains\n. the meaning of the parameters to draw the blue arc.\n. \n. ![Parameters of Elliptic Arc](pics/ellipse.svg)\n. \n. @param img Image.\n. @param center Center of the ellipse.\n. @param axes Half of the size of the ellipse main axes.\n. @param angle Ellipse rotation angle in degrees.\n. @param startAngle Starting angle of the elliptic arc in degrees.\n. @param endAngle Ending angle of the elliptic arc in degrees.\n. @param color Ellipse color.\n. @param thickness Thickness of the ellipse arc outline, if positive. Otherwise, this indicates that\n. a filled ellipse sector is to be drawn.\n. @param lineType Type of the ellipse boundary. See #LineTypes\n. @param shift Number of fractional bits in the coordinates of the center and values of axes.\n\n\n\nellipse(img, box, color[, thickness[, lineType]]) -> img\n. @overload\n. @param img Image.\n. @param box Alternative ellipse representation via RotatedRect. This means that the function draws\n. an ellipse inscribed in the rotated rectangle.\n. @param color Ellipse color.\n. @param thickness Thickness of the ellipse arc outline, if positive. Otherwise, this indicates that\n. a filled ellipse sector is to be drawn.\n. @param lineType Type of the ellipse boundary. See #LineTypes' ... - def ellipse2Poly(center, axes, angle, arcStart, arcEnd, delta) -> typing.Any: 'ellipse2Poly(center, axes, angle, arcStart, arcEnd, delta) -> pts\n. @brief Approximates an elliptic arc with a polyline.\n. \n. The function ellipse2Poly computes the vertices of a polyline that approximates the specified\n. elliptic arc. It is used by #ellipse. If `arcStart` is greater than `arcEnd`, they are swapped.\n. \n. @param center Center of the arc.\n. @param axes Half of the size of the ellipse main axes. See #ellipse for details.\n. @param angle Rotation angle of the ellipse in degrees. See #ellipse for details.\n. @param arcStart Starting angle of the elliptic arc in degrees.\n. @param arcEnd Ending angle of the elliptic arc in degrees.\n. @param delta Angle between the subsequent polyline vertices. It defines the approximation\n. accuracy.\n. @param pts Output vector of polyline vertices.' ... - -def equalizeHist(src: ndarray, dts: ndarray = ...) -> typing.Any: +def equalizeHist(src: Mat, dts: Mat = ...) -> typing.Any: "equalizeHist(src[, dst]) -> dst\n. @brief Equalizes the histogram of a grayscale image.\n. \n. The function equalizes the histogram of the input image using the following algorithm:\n. \n. - Calculate the histogram \\f$H\\f$ for src .\n. - Normalize the histogram so that the sum of histogram bins is 255.\n. - Compute the integral of the histogram:\n. \\f[H'_i = \\sum _{0 \\le j < i} H(j)\\f]\n. - Transform the image using \\f$H'\\f$ as a look-up table: \\f$\\texttt{dst}(x,y) = H'(\\texttt{src}(x,y))\\f$\n. \n. The algorithm normalizes the brightness and increases the contrast of the image.\n. \n. @param src Source 8-bit single channel image.\n. @param dst Destination image of the same size and type as src ." ... - -def erode(src: ndarray, kernel, dts: ndarray = ..., anchor=..., iterations=..., borderType=..., borderValue=...) -> typing.Any: +def erode(src: Mat, kernel, dts: Mat = ..., anchor=..., iterations=..., borderType=..., borderValue=...) -> typing.Any: "erode(src, kernel[, dst[, anchor[, iterations[, borderType[, borderValue]]]]]) -> dst\n. @brief Erodes an image by using a specific structuring element.\n. \n. The function erodes the source image using the specified structuring element that determines the\n. shape of a pixel neighborhood over which the minimum is taken:\n. \n. \\f[\\texttt{dst} (x,y) = \\min _{(x',y'): \\, \\texttt{element} (x',y') \\ne0 } \\texttt{src} (x+x',y+y')\\f]\n. \n. The function supports the in-place mode. Erosion can be applied several ( iterations ) times. In\n. case of multi-channel images, each channel is processed independently.\n. \n. @param src input image; the number of channels can be arbitrary, but the depth should be one of\n. CV_8U, CV_16U, CV_16S, CV_32F or CV_64F.\n. @param dst output image of the same size and type as src.\n. @param kernel structuring element used for erosion; if `element=Mat()`, a `3 x 3` rectangular\n. structuring element is used. Kernel can be created using #getStructuringElement.\n. @param anchor position of the anchor within the element; default value (-1, -1) means that the\n. anchor is at the element center.\n. @param iterations number of times erosion is applied.\n. @param borderType pixel extrapolation method, see #BorderTypes. #BORDER_WRAP is not supported.\n. @param borderValue border value in case of a constant border\n. @sa dilate, morphologyEx, getStructuringElement" ... - error = _mod_cv2.error - - def estimateAffine2D(from_, to, inliers=..., method: int = ..., ransacReprojThreshold=..., maxIters=..., confidence=..., refineIters=...) -> typing.Any: 'estimateAffine2D(from, to[, inliers[, method[, ransacReprojThreshold[, maxIters[, confidence[, refineIters]]]]]]) -> retval, inliers\n. @brief Computes an optimal affine transformation between two 2D point sets.\n. \n. It computes\n. \\f[\n. \\begin{bmatrix}\n. x\\\\\n. y\\\\\n. \\end{bmatrix}\n. =\n. \\begin{bmatrix}\n. a_{11} & a_{12}\\\\\n. a_{21} & a_{22}\\\\\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X\\\\\n. Y\\\\\n. \\end{bmatrix}\n. +\n. \\begin{bmatrix}\n. b_1\\\\\n. b_2\\\\\n. \\end{bmatrix}\n. \\f]\n. \n. @param from First input 2D point set containing \\f$(X,Y)\\f$.\n. @param to Second input 2D point set containing \\f$(x,y)\\f$.\n. @param inliers Output vector indicating which points are inliers (1-inlier, 0-outlier).\n. @param method Robust method used to compute transformation. The following methods are possible:\n. - cv::RANSAC - RANSAC-based robust method\n. - cv::LMEDS - Least-Median robust method\n. RANSAC is the default method.\n. @param ransacReprojThreshold Maximum reprojection error in the RANSAC algorithm to consider\n. a point as an inlier. Applies only to RANSAC.\n. @param maxIters The maximum number of robust method iterations.\n. @param confidence Confidence level, between 0 and 1, for the estimated transformation. Anything\n. between 0.95 and 0.99 is usually good enough. Values too close to 1 can slow down the estimation\n. significantly. Values lower than 0.8-0.9 can result in an incorrectly estimated transformation.\n. @param refineIters Maximum number of iterations of refining algorithm (Levenberg-Marquardt).\n. Passing 0 will disable refining, so the output matrix will be output of robust method.\n. \n. @return Output 2D affine transformation matrix \\f$2 \\times 3\\f$ or empty matrix if transformation\n. could not be estimated. The returned matrix has the following form:\n. \\f[\n. \\begin{bmatrix}\n. a_{11} & a_{12} & b_1\\\\\n. a_{21} & a_{22} & b_2\\\\\n. \\end{bmatrix}\n. \\f]\n. \n. The function estimates an optimal 2D affine transformation between two 2D point sets using the\n. selected robust algorithm.\n. \n. The computed transformation is then refined further (using only inliers) with the\n. Levenberg-Marquardt method to reduce the re-projection error even more.\n. \n. @note\n. The RANSAC method can handle practically any ratio of outliers but needs a threshold to\n. distinguish inliers from outliers. The method LMeDS does not need any threshold but it works\n. correctly only when there are more than 50% of inliers.\n. \n. @sa estimateAffinePartial2D, getAffineTransform' ... - -def estimateAffine3D(src: ndarray, dts: ndarray, out=..., inliers=..., ransacThreshold=..., confidence=...) -> typing.Any: +def estimateAffine3D(src: Mat, dts: Mat, out=..., inliers=..., ransacThreshold=..., confidence=...) -> typing.Any: 'estimateAffine3D(src, dst[, out[, inliers[, ransacThreshold[, confidence]]]]) -> retval, out, inliers\n. @brief Computes an optimal affine transformation between two 3D point sets.\n. \n. It computes\n. \\f[\n. \\begin{bmatrix}\n. x\\\\\n. y\\\\\n. z\\\\\n. \\end{bmatrix}\n. =\n. \\begin{bmatrix}\n. a_{11} & a_{12} & a_{13}\\\\\n. a_{21} & a_{22} & a_{23}\\\\\n. a_{31} & a_{32} & a_{33}\\\\\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X\\\\\n. Y\\\\\n. Z\\\\\n. \\end{bmatrix}\n. +\n. \\begin{bmatrix}\n. b_1\\\\\n. b_2\\\\\n. b_3\\\\\n. \\end{bmatrix}\n. \\f]\n. \n. @param src First input 3D point set containing \\f$(X,Y,Z)\\f$.\n. @param dst Second input 3D point set containing \\f$(x,y,z)\\f$.\n. @param out Output 3D affine transformation matrix \\f$3 \\times 4\\f$ of the form\n. \\f[\n. \\begin{bmatrix}\n. a_{11} & a_{12} & a_{13} & b_1\\\\\n. a_{21} & a_{22} & a_{23} & b_2\\\\\n. a_{31} & a_{32} & a_{33} & b_3\\\\\n. \\end{bmatrix}\n. \\f]\n. @param inliers Output vector indicating which points are inliers (1-inlier, 0-outlier).\n. @param ransacThreshold Maximum reprojection error in the RANSAC algorithm to consider a point as\n. an inlier.\n. @param confidence Confidence level, between 0 and 1, for the estimated transformation. Anything\n. between 0.95 and 0.99 is usually good enough. Values too close to 1 can slow down the estimation\n. significantly. Values lower than 0.8-0.9 can result in an incorrectly estimated transformation.\n. \n. The function estimates an optimal 3D affine transformation between two 3D point sets using the\n. RANSAC algorithm.' ... - def estimateAffinePartial2D(from_, to, inliers=..., method: int = ..., ransacReprojThreshold=..., maxIters=..., confidence=..., refineIters=...) -> typing.Any: 'estimateAffinePartial2D(from, to[, inliers[, method[, ransacReprojThreshold[, maxIters[, confidence[, refineIters]]]]]]) -> retval, inliers\n. @brief Computes an optimal limited affine transformation with 4 degrees of freedom between\n. two 2D point sets.\n. \n. @param from First input 2D point set.\n. @param to Second input 2D point set.\n. @param inliers Output vector indicating which points are inliers.\n. @param method Robust method used to compute transformation. The following methods are possible:\n. - cv::RANSAC - RANSAC-based robust method\n. - cv::LMEDS - Least-Median robust method\n. RANSAC is the default method.\n. @param ransacReprojThreshold Maximum reprojection error in the RANSAC algorithm to consider\n. a point as an inlier. Applies only to RANSAC.\n. @param maxIters The maximum number of robust method iterations.\n. @param confidence Confidence level, between 0 and 1, for the estimated transformation. Anything\n. between 0.95 and 0.99 is usually good enough. Values too close to 1 can slow down the estimation\n. significantly. Values lower than 0.8-0.9 can result in an incorrectly estimated transformation.\n. @param refineIters Maximum number of iterations of refining algorithm (Levenberg-Marquardt).\n. Passing 0 will disable refining, so the output matrix will be output of robust method.\n. \n. @return Output 2D affine transformation (4 degrees of freedom) matrix \\f$2 \\times 3\\f$ or\n. empty matrix if transformation could not be estimated.\n. \n. The function estimates an optimal 2D affine transformation with 4 degrees of freedom limited to\n. combinations of translation, rotation, and uniform scaling. Uses the selected algorithm for robust\n. estimation.\n. \n. The computed transformation is then refined further (using only inliers) with the\n. Levenberg-Marquardt method to reduce the re-projection error even more.\n. \n. Estimated transformation matrix is:\n. \\f[ \\begin{bmatrix} \\cos(\\theta) \\cdot s & -\\sin(\\theta) \\cdot s & t_x \\\\\n. \\sin(\\theta) \\cdot s & \\cos(\\theta) \\cdot s & t_y\n. \\end{bmatrix} \\f]\n. Where \\f$ \\theta \\f$ is the rotation angle, \\f$ s \\f$ the scaling factor and \\f$ t_x, t_y \\f$ are\n. translations in \\f$ x, y \\f$ axes respectively.\n. \n. @note\n. The RANSAC method can handle practically any ratio of outliers but need a threshold to\n. distinguish inliers from outliers. The method LMeDS does not need any threshold but it works\n. correctly only when there are more than 50% of inliers.\n. \n. @sa estimateAffine2D, getAffineTransform' ... - -def estimateChessboardSharpness(image: ndarray, patternSize, corners, rise_distance=..., vertical=..., sharpness=...) -> typing.Any: +def estimateChessboardSharpness(image: Mat, patternSize, corners, rise_distance=..., vertical=..., sharpness=...) -> typing.Any: 'estimateChessboardSharpness(image, patternSize, corners[, rise_distance[, vertical[, sharpness]]]) -> retval, sharpness\n. @brief Estimates the sharpness of a detected chessboard.\n. \n. Image sharpness, as well as brightness, are a critical parameter for accuracte\n. camera calibration. For accessing these parameters for filtering out\n. problematic calibraiton images, this method calculates edge profiles by traveling from\n. black to white chessboard cell centers. Based on this, the number of pixels is\n. calculated required to transit from black to white. This width of the\n. transition area is a good indication of how sharp the chessboard is imaged\n. and should be below ~3.0 pixels.\n. \n. @param image Gray image used to find chessboard corners\n. @param patternSize Size of a found chessboard pattern\n. @param corners Corners found by findChessboardCorners(SB)\n. @param rise_distance Rise distance 0.8 means 10% ... 90% of the final signal strength\n. @param vertical By default edge responses for horizontal lines are calculated\n. @param sharpness Optional output array with a sharpness value for calculated edge responses (see description)\n. \n. The optional sharpness array is of type CV_32FC1 and has for each calculated\n. profile one row with the following five entries:\n. * 0 = x coordinate of the underlying edge in the image\n. * 1 = y coordinate of the underlying edge in the image\n. * 2 = width of the transition area (sharpness)\n. * 3 = signal strength in the black cell (min brightness)\n. * 4 = signal strength in the white cell (max brightness)\n. \n. @return Scalar(average sharpness, average min brightness, average max brightness,0)' ... - -def estimateTranslation3D(src: ndarray, dts: ndarray, out=..., inliers=..., ransacThreshold=..., confidence=...) -> typing.Any: +def estimateTranslation3D(src: Mat, dts: Mat, out=..., inliers=..., ransacThreshold=..., confidence=...) -> typing.Any: 'estimateTranslation3D(src, dst[, out[, inliers[, ransacThreshold[, confidence]]]]) -> retval, out, inliers\n. @brief Computes an optimal translation between two 3D point sets.\n. *\n. * It computes\n. * \\f[\n. * \\begin{bmatrix}\n. * x\\\\\n. * y\\\\\n. * z\\\\\n. * \\end{bmatrix}\n. * =\n. * \\begin{bmatrix}\n. * X\\\\\n. * Y\\\\\n. * Z\\\\\n. * \\end{bmatrix}\n. * +\n. * \\begin{bmatrix}\n. * b_1\\\\\n. * b_2\\\\\n. * b_3\\\\\n. * \\end{bmatrix}\n. * \\f]\n. *\n. * @param src First input 3D point set containing \\f$(X,Y,Z)\\f$.\n. * @param dst Second input 3D point set containing \\f$(x,y,z)\\f$.\n. * @param out Output 3D translation vector \\f$3 \\times 1\\f$ of the form\n. * \\f[\n. * \\begin{bmatrix}\n. * b_1 \\\\\n. * b_2 \\\\\n. * b_3 \\\\\n. * \\end{bmatrix}\n. * \\f]\n. * @param inliers Output vector indicating which points are inliers (1-inlier, 0-outlier).\n. * @param ransacThreshold Maximum reprojection error in the RANSAC algorithm to consider a point as\n. * an inlier.\n. * @param confidence Confidence level, between 0 and 1, for the estimated transformation. Anything\n. * between 0.95 and 0.99 is usually good enough. Values too close to 1 can slow down the estimation\n. * significantly. Values lower than 0.8-0.9 can result in an incorrectly estimated transformation.\n. *\n. * The function estimates an optimal 3D translation between two 3D point sets using the\n. * RANSAC algorithm.\n. *' ... - -def exp(src: ndarray, dts: ndarray = ...) -> typing.Any: +def exp(src: Mat, dts: Mat = ...) -> typing.Any: 'exp(src[, dst]) -> dst\n. @brief Calculates the exponent of every array element.\n. \n. The function cv::exp calculates the exponent of every element of the input\n. array:\n. \\f[\\texttt{dst} [I] = e^{ src(I) }\\f]\n. \n. The maximum relative error is about 7e-6 for single-precision input and\n. less than 1e-10 for double-precision input. Currently, the function\n. converts denormalized values to zeros on output. Special values (NaN,\n. Inf) are not handled.\n. @param src input array.\n. @param dst output array of the same size and type as src.\n. @sa log , cartToPolar , polarToCart , phase , pow , sqrt , magnitude' ... - -def extractChannel(src: ndarray, coi, dts: ndarray = ...) -> typing.Any: +def extractChannel(src: Mat, coi, dts: Mat = ...) -> typing.Any: 'extractChannel(src, coi[, dst]) -> dst\n. @brief Extracts a single channel from src (coi is 0-based index)\n. @param src input array\n. @param dst output array\n. @param coi index of channel to extract\n. @sa mixChannels, split' ... - def fastAtan2(y, x) -> typing.Any: 'fastAtan2(y, x) -> retval\n. @brief Calculates the angle of a 2D vector in degrees.\n. \n. The function fastAtan2 calculates the full-range angle of an input 2D vector. The angle is measured\n. in degrees and varies from 0 to 360 degrees. The accuracy is about 0.3 degrees.\n. @param x x-coordinate of the vector.\n. @param y y-coordinate of the vector.' ... - -def fastNlMeansDenoising(src: ndarray, dts: ndarray = ..., h=..., templateWindowSize=..., searchWindowSize=...) -> typing.Any: +def fastNlMeansDenoising(src: Mat, dts: Mat = ..., h=..., templateWindowSize=..., searchWindowSize=...) -> typing.Any: 'fastNlMeansDenoising(src[, dst[, h[, templateWindowSize[, searchWindowSize]]]]) -> dst\n. @brief Perform image denoising using Non-local Means Denoising algorithm\n. with several computational\n. optimizations. Noise expected to be a gaussian white noise\n. \n. @param src Input 8-bit 1-channel, 2-channel, 3-channel or 4-channel image.\n. @param dst Output image with the same size and type as src .\n. @param templateWindowSize Size in pixels of the template patch that is used to compute weights.\n. Should be odd. Recommended value 7 pixels\n. @param searchWindowSize Size in pixels of the window that is used to compute weighted average for\n. given pixel. Should be odd. Affect performance linearly: greater searchWindowsSize - greater\n. denoising time. Recommended value 21 pixels\n. @param h Parameter regulating filter strength. Big h value perfectly removes noise but also\n. removes image details, smaller h value preserves details but also preserves some noise\n. \n. This function expected to be applied to grayscale images. For colored images look at\n. fastNlMeansDenoisingColored. Advanced usage of this functions can be manual denoising of colored\n. image in different colorspaces. Such approach is used in fastNlMeansDenoisingColored by converting\n. image to CIELAB colorspace and then separately denoise L and AB components with different h\n. parameter.\n\n\n\nfastNlMeansDenoising(src, h[, dst[, templateWindowSize[, searchWindowSize[, normType]]]]) -> dst\n. @brief Perform image denoising using Non-local Means Denoising algorithm\n. with several computational\n. optimizations. Noise expected to be a gaussian white noise\n. \n. @param src Input 8-bit or 16-bit (only with NORM_L1) 1-channel,\n. 2-channel, 3-channel or 4-channel image.\n. @param dst Output image with the same size and type as src .\n. @param templateWindowSize Size in pixels of the template patch that is used to compute weights.\n. Should be odd. Recommended value 7 pixels\n. @param searchWindowSize Size in pixels of the window that is used to compute weighted average for\n. given pixel. Should be odd. Affect performance linearly: greater searchWindowsSize - greater\n. denoising time. Recommended value 21 pixels\n. @param h Array of parameters regulating filter strength, either one\n. parameter applied to all channels or one per channel in dst. Big h value\n. perfectly removes noise but also removes image details, smaller h\n. value preserves details but also preserves some noise\n. @param normType Type of norm used for weight calculation. Can be either NORM_L2 or NORM_L1\n. \n. This function expected to be applied to grayscale images. For colored images look at\n. fastNlMeansDenoisingColored. Advanced usage of this functions can be manual denoising of colored\n. image in different colorspaces. Such approach is used in fastNlMeansDenoisingColored by converting\n. image to CIELAB colorspace and then separately denoise L and AB components with different h\n. parameter.' ... - -def fastNlMeansDenoisingColored(src: ndarray, dts: ndarray = ..., h=..., hColor=..., templateWindowSize=..., searchWindowSize=...) -> typing.Any: +def fastNlMeansDenoisingColored(src: Mat, dts: Mat = ..., h=..., hColor=..., templateWindowSize=..., searchWindowSize=...) -> typing.Any: 'fastNlMeansDenoisingColored(src[, dst[, h[, hColor[, templateWindowSize[, searchWindowSize]]]]]) -> dst\n. @brief Modification of fastNlMeansDenoising function for colored images\n. \n. @param src Input 8-bit 3-channel image.\n. @param dst Output image with the same size and type as src .\n. @param templateWindowSize Size in pixels of the template patch that is used to compute weights.\n. Should be odd. Recommended value 7 pixels\n. @param searchWindowSize Size in pixels of the window that is used to compute weighted average for\n. given pixel. Should be odd. Affect performance linearly: greater searchWindowsSize - greater\n. denoising time. Recommended value 21 pixels\n. @param h Parameter regulating filter strength for luminance component. Bigger h value perfectly\n. removes noise but also removes image details, smaller h value preserves details but also preserves\n. some noise\n. @param hColor The same as h but for color components. For most images value equals 10\n. will be enough to remove colored noise and do not distort colors\n. \n. The function converts image to CIELAB colorspace and then separately denoise L and AB components\n. with given h parameters using fastNlMeansDenoising function.' ... - -def fastNlMeansDenoisingColoredMulti(srcImgs, imgToDenoiseIndex, temporalWindowSize, dts: ndarray = ..., h=..., hColor=..., templateWindowSize=..., searchWindowSize=...) -> typing.Any: +def fastNlMeansDenoisingColoredMulti(srcImgs, imgToDenoiseIndex, temporalWindowSize, dts: Mat = ..., h=..., hColor=..., templateWindowSize=..., searchWindowSize=...) -> typing.Any: 'fastNlMeansDenoisingColoredMulti(srcImgs, imgToDenoiseIndex, temporalWindowSize[, dst[, h[, hColor[, templateWindowSize[, searchWindowSize]]]]]) -> dst\n. @brief Modification of fastNlMeansDenoisingMulti function for colored images sequences\n. \n. @param srcImgs Input 8-bit 3-channel images sequence. All images should have the same type and\n. size.\n. @param imgToDenoiseIndex Target image to denoise index in srcImgs sequence\n. @param temporalWindowSize Number of surrounding images to use for target image denoising. Should\n. be odd. Images from imgToDenoiseIndex - temporalWindowSize / 2 to\n. imgToDenoiseIndex - temporalWindowSize / 2 from srcImgs will be used to denoise\n. srcImgs[imgToDenoiseIndex] image.\n. @param dst Output image with the same size and type as srcImgs images.\n. @param templateWindowSize Size in pixels of the template patch that is used to compute weights.\n. Should be odd. Recommended value 7 pixels\n. @param searchWindowSize Size in pixels of the window that is used to compute weighted average for\n. given pixel. Should be odd. Affect performance linearly: greater searchWindowsSize - greater\n. denoising time. Recommended value 21 pixels\n. @param h Parameter regulating filter strength for luminance component. Bigger h value perfectly\n. removes noise but also removes image details, smaller h value preserves details but also preserves\n. some noise.\n. @param hColor The same as h but for color components.\n. \n. The function converts images to CIELAB colorspace and then separately denoise L and AB components\n. with given h parameters using fastNlMeansDenoisingMulti function.' ... - -def fastNlMeansDenoisingMulti(srcImgs, imgToDenoiseIndex, temporalWindowSize, dts: ndarray = ..., h=..., templateWindowSize=..., searchWindowSize=...) -> typing.Any: +def fastNlMeansDenoisingMulti(srcImgs, imgToDenoiseIndex, temporalWindowSize, dts: Mat = ..., h=..., templateWindowSize=..., searchWindowSize=...) -> typing.Any: 'fastNlMeansDenoisingMulti(srcImgs, imgToDenoiseIndex, temporalWindowSize[, dst[, h[, templateWindowSize[, searchWindowSize]]]]) -> dst\n. @brief Modification of fastNlMeansDenoising function for images sequence where consecutive images have been\n. captured in small period of time. For example video. This version of the function is for grayscale\n. images or for manual manipulation with colorspaces. For more details see\n. \n. \n. @param srcImgs Input 8-bit 1-channel, 2-channel, 3-channel or\n. 4-channel images sequence. All images should have the same type and\n. size.\n. @param imgToDenoiseIndex Target image to denoise index in srcImgs sequence\n. @param temporalWindowSize Number of surrounding images to use for target image denoising. Should\n. be odd. Images from imgToDenoiseIndex - temporalWindowSize / 2 to\n. imgToDenoiseIndex - temporalWindowSize / 2 from srcImgs will be used to denoise\n. srcImgs[imgToDenoiseIndex] image.\n. @param dst Output image with the same size and type as srcImgs images.\n. @param templateWindowSize Size in pixels of the template patch that is used to compute weights.\n. Should be odd. Recommended value 7 pixels\n. @param searchWindowSize Size in pixels of the window that is used to compute weighted average for\n. given pixel. Should be odd. Affect performance linearly: greater searchWindowsSize - greater\n. denoising time. Recommended value 21 pixels\n. @param h Parameter regulating filter strength. Bigger h value\n. perfectly removes noise but also removes image details, smaller h\n. value preserves details but also preserves some noise\n\n\n\nfastNlMeansDenoisingMulti(srcImgs, imgToDenoiseIndex, temporalWindowSize, h[, dst[, templateWindowSize[, searchWindowSize[, normType]]]]) -> dst\n. @brief Modification of fastNlMeansDenoising function for images sequence where consecutive images have been\n. captured in small period of time. For example video. This version of the function is for grayscale\n. images or for manual manipulation with colorspaces. For more details see\n. \n. \n. @param srcImgs Input 8-bit or 16-bit (only with NORM_L1) 1-channel,\n. 2-channel, 3-channel or 4-channel images sequence. All images should\n. have the same type and size.\n. @param imgToDenoiseIndex Target image to denoise index in srcImgs sequence\n. @param temporalWindowSize Number of surrounding images to use for target image denoising. Should\n. be odd. Images from imgToDenoiseIndex - temporalWindowSize / 2 to\n. imgToDenoiseIndex - temporalWindowSize / 2 from srcImgs will be used to denoise\n. srcImgs[imgToDenoiseIndex] image.\n. @param dst Output image with the same size and type as srcImgs images.\n. @param templateWindowSize Size in pixels of the template patch that is used to compute weights.\n. Should be odd. Recommended value 7 pixels\n. @param searchWindowSize Size in pixels of the window that is used to compute weighted average for\n. given pixel. Should be odd. Affect performance linearly: greater searchWindowsSize - greater\n. denoising time. Recommended value 21 pixels\n. @param h Array of parameters regulating filter strength, either one\n. parameter applied to all channels or one per channel in dst. Big h value\n. perfectly removes noise but also removes image details, smaller h\n. value preserves details but also preserves some noise\n. @param normType Type of norm used for weight calculation. Can be either NORM_L2 or NORM_L1' ... - -def fillConvexPoly(img: ndarray, points, color, lineType=..., shift=...) -> typing.Any: +def fillConvexPoly(img: Mat, points, color, lineType=..., shift=...) -> typing.Any: 'fillConvexPoly(img, points, color[, lineType[, shift]]) -> img\n. @brief Fills a convex polygon.\n. \n. The function cv::fillConvexPoly draws a filled convex polygon. This function is much faster than the\n. function #fillPoly . It can fill not only convex polygons but any monotonic polygon without\n. self-intersections, that is, a polygon whose contour intersects every horizontal line (scan line)\n. twice at the most (though, its top-most and/or the bottom edge could be horizontal).\n. \n. @param img Image.\n. @param points Polygon vertices.\n. @param color Polygon color.\n. @param lineType Type of the polygon boundaries. See #LineTypes\n. @param shift Number of fractional bits in the vertex coordinates.' ... - -def fillPoly(img: ndarray, pts, color, lineType=..., shift=..., offset=...) -> typing.Any: +def fillPoly(img: Mat, pts, color, lineType=..., shift=..., offset=...) -> typing.Any: 'fillPoly(img, pts, color[, lineType[, shift[, offset]]]) -> img\n. @brief Fills the area bounded by one or more polygons.\n. \n. The function cv::fillPoly fills an area bounded by several polygonal contours. The function can fill\n. complex areas, for example, areas with holes, contours with self-intersections (some of their\n. parts), and so forth.\n. \n. @param img Image.\n. @param pts Array of polygons where each polygon is represented as an array of points.\n. @param color Polygon color.\n. @param lineType Type of the polygon boundaries. See #LineTypes\n. @param shift Number of fractional bits in the vertex coordinates.\n. @param offset Optional offset of all points of the contours.' ... - -def filter2D(src: ndarray, ddepth, kernel, dts: ndarray = ..., anchor=..., delta=..., borderType=...) -> typing.Any: +def filter2D(src: Mat, ddepth, kernel, dts: Mat = ..., anchor=..., delta=..., borderType=...) -> typing.Any: 'filter2D(src, ddepth, kernel[, dst[, anchor[, delta[, borderType]]]]) -> dst\n. @brief Convolves an image with the kernel.\n. \n. The function applies an arbitrary linear filter to an image. In-place operation is supported. When\n. the aperture is partially outside the image, the function interpolates outlier pixel values\n. according to the specified border mode.\n. \n. The function does actually compute correlation, not the convolution:\n. \n. \\f[\\texttt{dst} (x,y) = \\sum _{ \\substack{0\\leq x\' < \\texttt{kernel.cols}\\\\{0\\leq y\' < \\texttt{kernel.rows}}}} \\texttt{kernel} (x\',y\')* \\texttt{src} (x+x\'- \\texttt{anchor.x} ,y+y\'- \\texttt{anchor.y} )\\f]\n. \n. That is, the kernel is not mirrored around the anchor point. If you need a real convolution, flip\n. the kernel using #flip and set the new anchor to `(kernel.cols - anchor.x - 1, kernel.rows -\n. anchor.y - 1)`.\n. \n. The function uses the DFT-based algorithm in case of sufficiently large kernels (~`11 x 11` or\n. larger) and the direct algorithm for small kernels.\n. \n. @param src input image.\n. @param dst output image of the same size and the same number of channels as src.\n. @param ddepth desired depth of the destination image, see @ref filter_depths "combinations"\n. @param kernel convolution kernel (or rather a correlation kernel), a single-channel floating point\n. matrix; if you want to apply different kernels to different channels, split the image into\n. separate color planes using split and process them individually.\n. @param anchor anchor of the kernel that indicates the relative position of a filtered point within\n. the kernel; the anchor should lie within the kernel; default value (-1,-1) means that the anchor\n. is at the kernel center.\n. @param delta optional value added to the filtered pixels before storing them in dst.\n. @param borderType pixel extrapolation method, see #BorderTypes. #BORDER_WRAP is not supported.\n. @sa sepFilter2D, dft, matchTemplate' ... - def filterHomographyDecompByVisibleRefpoints(rotations, normals, beforePoints, afterPoints, possibleSolutions=..., pointsMask=...) -> typing.Any: 'filterHomographyDecompByVisibleRefpoints(rotations, normals, beforePoints, afterPoints[, possibleSolutions[, pointsMask]]) -> possibleSolutions\n. @brief Filters homography decompositions based on additional information.\n. \n. @param rotations Vector of rotation matrices.\n. @param normals Vector of plane normal matrices.\n. @param beforePoints Vector of (rectified) visible reference points before the homography is applied\n. @param afterPoints Vector of (rectified) visible reference points after the homography is applied\n. @param possibleSolutions Vector of int indices representing the viable solution set after filtering\n. @param pointsMask optional Mat/Vector of 8u type representing the mask for the inliers as given by the findHomography function\n. \n. This function is intended to filter the output of the decomposeHomographyMat based on additional\n. information as described in @cite Malis . The summary of the method: the decomposeHomographyMat function\n. returns 2 unique solutions and their "opposites" for a total of 4 solutions. If we have access to the\n. sets of points visible in the camera frame before and after the homography transformation is applied,\n. we can determine which are the true potential solutions and which are the opposites by verifying which\n. homographies are consistent with all visible reference points being in front of the camera. The inputs\n. are left unchanged; the filtered solution set is returned as indices into the existing one.' ... - -def filterSpeckles(img: ndarray, newVal, maxSpeckleSize, maxDiff, buf=...) -> typing.Any: +def filterSpeckles(img: Mat, newVal, maxSpeckleSize, maxDiff, buf=...) -> typing.Any: 'filterSpeckles(img, newVal, maxSpeckleSize, maxDiff[, buf]) -> img, buf\n. @brief Filters off small noise blobs (speckles) in the disparity map\n. \n. @param img The input 16-bit signed disparity image\n. @param newVal The disparity value used to paint-off the speckles\n. @param maxSpeckleSize The maximum speckle size to consider it a speckle. Larger blobs are not\n. affected by the algorithm\n. @param maxDiff Maximum difference between neighbor disparity pixels to put them into the same\n. blob. Note that since StereoBM, StereoSGBM and may be other algorithms return a fixed-point\n. disparity map, where disparity values are multiplied by 16, this scale factor should be taken into\n. account when specifying this parameter value.\n. @param buf The optional temporary buffer to avoid memory allocation within the function.' ... - -def find4QuadCornerSubpix(img: ndarray, corners, region_size) -> typing.Any: +def find4QuadCornerSubpix(img: Mat, corners, region_size) -> typing.Any: 'find4QuadCornerSubpix(img, corners, region_size) -> retval, corners\n.' ... - -def findChessboardCorners(image: ndarray, patternSize, corners=..., flags: int = ...) -> typing.Any: +def findChessboardCorners(image: Mat, patternSize, corners=..., flags: int = ...) -> typing.Any: 'findChessboardCorners(image, patternSize[, corners[, flags]]) -> retval, corners\n. @brief Finds the positions of internal corners of the chessboard.\n. \n. @param image Source chessboard view. It must be an 8-bit grayscale or color image.\n. @param patternSize Number of inner corners per a chessboard row and column\n. ( patternSize = cv::Size(points_per_row,points_per_colum) = cv::Size(columns,rows) ).\n. @param corners Output array of detected corners.\n. @param flags Various operation flags that can be zero or a combination of the following values:\n. - **CALIB_CB_ADAPTIVE_THRESH** Use adaptive thresholding to convert the image to black\n. and white, rather than a fixed threshold level (computed from the average image brightness).\n. - **CALIB_CB_NORMALIZE_IMAGE** Normalize the image gamma with equalizeHist before\n. applying fixed or adaptive thresholding.\n. - **CALIB_CB_FILTER_QUADS** Use additional criteria (like contour area, perimeter,\n. square-like shape) to filter out false quads extracted at the contour retrieval stage.\n. - **CALIB_CB_FAST_CHECK** Run a fast check on the image that looks for chessboard corners,\n. and shortcut the call if none is found. This can drastically speed up the call in the\n. degenerate condition when no chessboard is observed.\n. \n. The function attempts to determine whether the input image is a view of the chessboard pattern and\n. locate the internal chessboard corners. The function returns a non-zero value if all of the corners\n. are found and they are placed in a certain order (row by row, left to right in every row).\n. Otherwise, if the function fails to find all the corners or reorder them, it returns 0. For example,\n. a regular chessboard has 8 x 8 squares and 7 x 7 internal corners, that is, points where the black\n. squares touch each other. The detected coordinates are approximate, and to determine their positions\n. more accurately, the function calls cornerSubPix. You also may use the function cornerSubPix with\n. different parameters if returned coordinates are not accurate enough.\n. \n. Sample usage of detecting and drawing chessboard corners: :\n. @code\n. Size patternsize(8,6); //interior number of corners\n. Mat gray = ....; //source image\n. vector corners; //this will be filled by the detected corners\n. \n. //CALIB_CB_FAST_CHECK saves a lot of time on images\n. //that do not contain any chessboard corners\n. bool patternfound = findChessboardCorners(gray, patternsize, corners,\n. CALIB_CB_ADAPTIVE_THRESH + CALIB_CB_NORMALIZE_IMAGE\n. + CALIB_CB_FAST_CHECK);\n. \n. if(patternfound)\n. cornerSubPix(gray, corners, Size(11, 11), Size(-1, -1),\n. TermCriteria(CV_TERMCRIT_EPS + CV_TERMCRIT_ITER, 30, 0.1));\n. \n. drawChessboardCorners(img, patternsize, Mat(corners), patternfound);\n. @endcode\n. @note The function requires white space (like a square-thick border, the wider the better) around\n. the board to make the detection more robust in various environments. Otherwise, if there is no\n. border and the background is dark, the outer black squares cannot be segmented properly and so the\n. square grouping and ordering algorithm fails.' ... - -def findChessboardCornersSB(image: ndarray, patternSize, corners=..., flags: int = ...) -> typing.Any: +def findChessboardCornersSB(image: Mat, patternSize, corners=..., flags: int = ...) -> typing.Any: 'findChessboardCornersSB(image, patternSize[, corners[, flags]]) -> retval, corners\n. @overload' ... - -def findChessboardCornersSBWithMeta(image: ndarray, patternSize, flags: int, corners=..., meta=...) -> typing.Any: +def findChessboardCornersSBWithMeta(image: Mat, patternSize, flags: int, corners=..., meta=...) -> typing.Any: 'findChessboardCornersSBWithMeta(image, patternSize, flags[, corners[, meta]]) -> retval, corners, meta\n. @brief Finds the positions of internal corners of the chessboard using a sector based approach.\n. \n. @param image Source chessboard view. It must be an 8-bit grayscale or color image.\n. @param patternSize Number of inner corners per a chessboard row and column\n. ( patternSize = cv::Size(points_per_row,points_per_colum) = cv::Size(columns,rows) ).\n. @param corners Output array of detected corners.\n. @param flags Various operation flags that can be zero or a combination of the following values:\n. - **CALIB_CB_NORMALIZE_IMAGE** Normalize the image gamma with equalizeHist before detection.\n. - **CALIB_CB_EXHAUSTIVE** Run an exhaustive search to improve detection rate.\n. - **CALIB_CB_ACCURACY** Up sample input image to improve sub-pixel accuracy due to aliasing effects.\n. - **CALIB_CB_LARGER** The detected pattern is allowed to be larger than patternSize (see description).\n. - **CALIB_CB_MARKER** The detected pattern must have a marker (see description).\n. This should be used if an accurate camera calibration is required.\n. @param meta Optional output arrray of detected corners (CV_8UC1 and size = cv::Size(columns,rows)).\n. Each entry stands for one corner of the pattern and can have one of the following values:\n. - 0 = no meta data attached\n. - 1 = left-top corner of a black cell\n. - 2 = left-top corner of a white cell\n. - 3 = left-top corner of a black cell with a white marker dot\n. - 4 = left-top corner of a white cell with a black marker dot (pattern origin in case of markers otherwise first corner)\n. \n. The function is analog to findchessboardCorners but uses a localized radon\n. transformation approximated by box filters being more robust to all sort of\n. noise, faster on larger images and is able to directly return the sub-pixel\n. position of the internal chessboard corners. The Method is based on the paper\n. @cite duda2018 "Accurate Detection and Localization of Checkerboard Corners for\n. Calibration" demonstrating that the returned sub-pixel positions are more\n. accurate than the one returned by cornerSubPix allowing a precise camera\n. calibration for demanding applications.\n. \n. In the case, the flags **CALIB_CB_LARGER** or **CALIB_CB_MARKER** are given,\n. the result can be recovered from the optional meta array. Both flags are\n. helpful to use calibration patterns exceeding the field of view of the camera.\n. These oversized patterns allow more accurate calibrations as corners can be\n. utilized, which are as close as possible to the image borders. For a\n. consistent coordinate system across all images, the optional marker (see image\n. below) can be used to move the origin of the board to the location where the\n. black circle is located.\n. \n. @note The function requires a white boarder with roughly the same width as one\n. of the checkerboard fields around the whole board to improve the detection in\n. various environments. In addition, because of the localized radon\n. transformation it is beneficial to use round corners for the field corners\n. which are located on the outside of the board. The following figure illustrates\n. a sample checkerboard optimized for the detection. However, any other checkerboard\n. can be used as well.\n. ![Checkerboard](pics/checkerboard_radon.png)' ... - -def findCirclesGrid(image: ndarray, patternSize, flags: int, blobDetector, parameters, centers=...) -> typing.Any: +def findCirclesGrid(image: Mat, patternSize, flags: int, blobDetector, parameters, centers=...) -> typing.Any: 'findCirclesGrid(image, patternSize, flags, blobDetector, parameters[, centers]) -> retval, centers\n. @brief Finds centers in the grid of circles.\n. \n. @param image grid view of input circles; it must be an 8-bit grayscale or color image.\n. @param patternSize number of circles per row and column\n. ( patternSize = Size(points_per_row, points_per_colum) ).\n. @param centers output array of detected centers.\n. @param flags various operation flags that can be one of the following values:\n. - **CALIB_CB_SYMMETRIC_GRID** uses symmetric pattern of circles.\n. - **CALIB_CB_ASYMMETRIC_GRID** uses asymmetric pattern of circles.\n. - **CALIB_CB_CLUSTERING** uses a special algorithm for grid detection. It is more robust to\n. perspective distortions but much more sensitive to background clutter.\n. @param blobDetector feature detector that finds blobs like dark circles on light background.\n. @param parameters struct for finding circles in a grid pattern.\n. \n. The function attempts to determine whether the input image contains a grid of circles. If it is, the\n. function locates centers of the circles. The function returns a non-zero value if all of the centers\n. have been found and they have been placed in a certain order (row by row, left to right in every\n. row). Otherwise, if the function fails to find all the corners or reorder them, it returns 0.\n. \n. Sample usage of detecting and drawing the centers of circles: :\n. @code\n. Size patternsize(7,7); //number of centers\n. Mat gray = ....; //source image\n. vector centers; //this will be filled by the detected centers\n. \n. bool patternfound = findCirclesGrid(gray, patternsize, centers);\n. \n. drawChessboardCorners(img, patternsize, Mat(centers), patternfound);\n. @endcode\n. @note The function requires white space (like a square-thick border, the wider the better) around\n. the board to make the detection more robust in various environments.\n\n\n\nfindCirclesGrid(image, patternSize[, centers[, flags[, blobDetector]]]) -> retval, centers\n. @overload' ... - -def findContours(image: ndarray, mode, method: int, contours=..., hierarchy=..., offset=...) -> typing.Any: +def findContours(image: Mat, mode, method: int, contours=..., hierarchy=..., offset=...) -> typing.Any: "findContours(image, mode, method[, contours[, hierarchy[, offset]]]) -> contours, hierarchy\n. @brief Finds contours in a binary image.\n. \n. The function retrieves contours from the binary image using the algorithm @cite Suzuki85 . The contours\n. are a useful tool for shape analysis and object detection and recognition. See squares.cpp in the\n. OpenCV sample directory.\n. @note Since opencv 3.2 source image is not modified by this function.\n. \n. @param image Source, an 8-bit single-channel image. Non-zero pixels are treated as 1's. Zero\n. pixels remain 0's, so the image is treated as binary . You can use #compare, #inRange, #threshold ,\n. #adaptiveThreshold, #Canny, and others to create a binary image out of a grayscale or color one.\n. If mode equals to #RETR_CCOMP or #RETR_FLOODFILL, the input can also be a 32-bit integer image of labels (CV_32SC1).\n. @param contours Detected contours. Each contour is stored as a vector of points (e.g.\n. std::vector >).\n. @param hierarchy Optional output vector (e.g. std::vector), containing information about the image topology. It has\n. as many elements as the number of contours. For each i-th contour contours[i], the elements\n. hierarchy[i][0] , hierarchy[i][1] , hierarchy[i][2] , and hierarchy[i][3] are set to 0-based indices\n. in contours of the next and previous contours at the same hierarchical level, the first child\n. contour and the parent contour, respectively. If for the contour i there are no next, previous,\n. parent, or nested contours, the corresponding elements of hierarchy[i] will be negative.\n. @param mode Contour retrieval mode, see #RetrievalModes\n. @param method Contour approximation method, see #ContourApproximationModes\n. @param offset Optional offset by which every contour point is shifted. This is useful if the\n. contours are extracted from the image ROI and then they should be analyzed in the whole image\n. context." ... - -def findEssentialMat(points1, points2, cameraMatrix, method: int = ..., prob=..., threshold=..., mask: ndarray = ...) -> typing.Any: +def findEssentialMat(points1, points2, cameraMatrix, method: int = ..., prob=..., threshold=..., mask: Mat = ...) -> typing.Any: 'findEssentialMat(points1, points2, cameraMatrix[, method[, prob[, threshold[, mask]]]]) -> retval, mask\n. @brief Calculates an essential matrix from the corresponding points in two images.\n. \n. @param points1 Array of N (N \\>= 5) 2D points from the first image. The point coordinates should\n. be floating-point (single or double precision).\n. @param points2 Array of the second image points of the same size and format as points1 .\n. @param cameraMatrix Camera matrix \\f$K = \\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\\f$ .\n. Note that this function assumes that points1 and points2 are feature points from cameras with the\n. same camera matrix. If this assumption does not hold for your use case, use\n. `undistortPoints()` with `P = cv::NoArray()` for both cameras to transform image points\n. to normalized image coordinates, which are valid for the identity camera matrix. When\n. passing these coordinates, pass the identity matrix for this parameter.\n. @param method Method for computing an essential matrix.\n. - **RANSAC** for the RANSAC algorithm.\n. - **LMEDS** for the LMedS algorithm.\n. @param prob Parameter used for the RANSAC or LMedS methods only. It specifies a desirable level of\n. confidence (probability) that the estimated matrix is correct.\n. @param threshold Parameter used for RANSAC. It is the maximum distance from a point to an epipolar\n. line in pixels, beyond which the point is considered an outlier and is not used for computing the\n. final fundamental matrix. It can be set to something like 1-3, depending on the accuracy of the\n. point localization, image resolution, and the image noise.\n. @param mask Output array of N elements, every element of which is set to 0 for outliers and to 1\n. for the other points. The array is computed only in the RANSAC and LMedS methods.\n. \n. This function estimates essential matrix based on the five-point algorithm solver in @cite Nister03 .\n. @cite SteweniusCFS is also a related. The epipolar geometry is described by the following equation:\n. \n. \\f[[p_2; 1]^T K^{-T} E K^{-1} [p_1; 1] = 0\\f]\n. \n. where \\f$E\\f$ is an essential matrix, \\f$p_1\\f$ and \\f$p_2\\f$ are corresponding points in the first and the\n. second images, respectively. The result of this function may be passed further to\n. decomposeEssentialMat or recoverPose to recover the relative pose between cameras.\n\n\n\nfindEssentialMat(points1, points2[, focal[, pp[, method[, prob[, threshold[, mask]]]]]]) -> retval, mask\n. @overload\n. @param points1 Array of N (N \\>= 5) 2D points from the first image. The point coordinates should\n. be floating-point (single or double precision).\n. @param points2 Array of the second image points of the same size and format as points1 .\n. @param focal focal length of the camera. Note that this function assumes that points1 and points2\n. are feature points from cameras with same focal length and principal point.\n. @param pp principal point of the camera.\n. @param method Method for computing a fundamental matrix.\n. - **RANSAC** for the RANSAC algorithm.\n. - **LMEDS** for the LMedS algorithm.\n. @param threshold Parameter used for RANSAC. It is the maximum distance from a point to an epipolar\n. line in pixels, beyond which the point is considered an outlier and is not used for computing the\n. final fundamental matrix. It can be set to something like 1-3, depending on the accuracy of the\n. point localization, image resolution, and the image noise.\n. @param prob Parameter used for the RANSAC or LMedS methods only. It specifies a desirable level of\n. confidence (probability) that the estimated matrix is correct.\n. @param mask Output array of N elements, every element of which is set to 0 for outliers and to 1\n. for the other points. The array is computed only in the RANSAC and LMedS methods.\n. \n. This function differs from the one above that it computes camera matrix from focal length and\n. principal point:\n. \n. \\f[K =\n. \\begin{bmatrix}\n. f & 0 & x_{pp} \\\\\n. 0 & f & y_{pp} \\\\\n. 0 & 0 & 1\n. \\end{bmatrix}\\f]' ... - -def findFundamentalMat(points1, points2, method: int, ransacReprojThreshold, confidence, maxIters, mask: ndarray = ...) -> typing.Any: +def findFundamentalMat(points1, points2, method: int, ransacReprojThreshold, confidence, maxIters, mask: Mat = ...) -> typing.Any: 'findFundamentalMat(points1, points2, method, ransacReprojThreshold, confidence, maxIters[, mask]) -> retval, mask\n. @brief Calculates a fundamental matrix from the corresponding points in two images.\n. \n. @param points1 Array of N points from the first image. The point coordinates should be\n. floating-point (single or double precision).\n. @param points2 Array of the second image points of the same size and format as points1 .\n. @param method Method for computing a fundamental matrix.\n. - **CV_FM_7POINT** for a 7-point algorithm. \\f$N = 7\\f$\n. - **CV_FM_8POINT** for an 8-point algorithm. \\f$N \\ge 8\\f$\n. - **CV_FM_RANSAC** for the RANSAC algorithm. \\f$N \\ge 8\\f$\n. - **CV_FM_LMEDS** for the LMedS algorithm. \\f$N \\ge 8\\f$\n. @param ransacReprojThreshold Parameter used only for RANSAC. It is the maximum distance from a point to an epipolar\n. line in pixels, beyond which the point is considered an outlier and is not used for computing the\n. final fundamental matrix. It can be set to something like 1-3, depending on the accuracy of the\n. point localization, image resolution, and the image noise.\n. @param confidence Parameter used for the RANSAC and LMedS methods only. It specifies a desirable level\n. of confidence (probability) that the estimated matrix is correct.\n. @param mask\n. @param maxIters The maximum number of robust method iterations.\n. \n. The epipolar geometry is described by the following equation:\n. \n. \\f[[p_2; 1]^T F [p_1; 1] = 0\\f]\n. \n. where \\f$F\\f$ is a fundamental matrix, \\f$p_1\\f$ and \\f$p_2\\f$ are corresponding points in the first and the\n. second images, respectively.\n. \n. The function calculates the fundamental matrix using one of four methods listed above and returns\n. the found fundamental matrix. Normally just one matrix is found. But in case of the 7-point\n. algorithm, the function may return up to 3 solutions ( \\f$9 \\times 3\\f$ matrix that stores all 3\n. matrices sequentially).\n. \n. The calculated fundamental matrix may be passed further to computeCorrespondEpilines that finds the\n. epipolar lines corresponding to the specified points. It can also be passed to\n. stereoRectifyUncalibrated to compute the rectification transformation. :\n. @code\n. // Example. Estimation of fundamental matrix using the RANSAC algorithm\n. int point_count = 100;\n. vector points1(point_count);\n. vector points2(point_count);\n. \n. // initialize the points here ...\n. for( int i = 0; i < point_count; i++ )\n. {\n. points1[i] = ...;\n. points2[i] = ...;\n. }\n. \n. Mat fundamental_matrix =\n. findFundamentalMat(points1, points2, FM_RANSAC, 3, 0.99);\n. @endcode\n\n\n\nfindFundamentalMat(points1, points2[, method[, ransacReprojThreshold[, confidence[, mask]]]]) -> retval, mask\n. @overload' ... - -def findHomography(srcPoints, dstPoints, method: int = ..., ransacReprojThreshold=..., mask: ndarray = ..., maxIters=..., confidence=...) -> typing.Any: +def findHomography(srcPoints, dstPoints, method: int = ..., ransacReprojThreshold=..., mask: Mat = ..., maxIters=..., confidence=...) -> typing.Any: "findHomography(srcPoints, dstPoints[, method[, ransacReprojThreshold[, mask[, maxIters[, confidence]]]]]) -> retval, mask\n. @brief Finds a perspective transformation between two planes.\n. \n. @param srcPoints Coordinates of the points in the original plane, a matrix of the type CV_32FC2\n. or vector\\ .\n. @param dstPoints Coordinates of the points in the target plane, a matrix of the type CV_32FC2 or\n. a vector\\ .\n. @param method Method used to compute a homography matrix. The following methods are possible:\n. - **0** - a regular method using all the points, i.e., the least squares method\n. - **RANSAC** - RANSAC-based robust method\n. - **LMEDS** - Least-Median robust method\n. - **RHO** - PROSAC-based robust method\n. @param ransacReprojThreshold Maximum allowed reprojection error to treat a point pair as an inlier\n. (used in the RANSAC and RHO methods only). That is, if\n. \\f[\\| \\texttt{dstPoints} _i - \\texttt{convertPointsHomogeneous} ( \\texttt{H} * \\texttt{srcPoints} _i) \\|_2 > \\texttt{ransacReprojThreshold}\\f]\n. then the point \\f$i\\f$ is considered as an outlier. If srcPoints and dstPoints are measured in pixels,\n. it usually makes sense to set this parameter somewhere in the range of 1 to 10.\n. @param mask Optional output mask set by a robust method ( RANSAC or LMEDS ). Note that the input\n. mask values are ignored.\n. @param maxIters The maximum number of RANSAC iterations.\n. @param confidence Confidence level, between 0 and 1.\n. \n. The function finds and returns the perspective transformation \\f$H\\f$ between the source and the\n. destination planes:\n. \n. \\f[s_i \\vecthree{x'_i}{y'_i}{1} \\sim H \\vecthree{x_i}{y_i}{1}\\f]\n. \n. so that the back-projection error\n. \n. \\f[\\sum _i \\left ( x'_i- \\frac{h_{11} x_i + h_{12} y_i + h_{13}}{h_{31} x_i + h_{32} y_i + h_{33}} \\right )^2+ \\left ( y'_i- \\frac{h_{21} x_i + h_{22} y_i + h_{23}}{h_{31} x_i + h_{32} y_i + h_{33}} \\right )^2\\f]\n. \n. is minimized. If the parameter method is set to the default value 0, the function uses all the point\n. pairs to compute an initial homography estimate with a simple least-squares scheme.\n. \n. However, if not all of the point pairs ( \\f$srcPoints_i\\f$, \\f$dstPoints_i\\f$ ) fit the rigid perspective\n. transformation (that is, there are some outliers), this initial estimate will be poor. In this case,\n. you can use one of the three robust methods. The methods RANSAC, LMeDS and RHO try many different\n. random subsets of the corresponding point pairs (of four pairs each, collinear pairs are discarded), estimate the homography matrix\n. using this subset and a simple least-squares algorithm, and then compute the quality/goodness of the\n. computed homography (which is the number of inliers for RANSAC or the least median re-projection error for\n. LMeDS). The best subset is then used to produce the initial estimate of the homography matrix and\n. the mask of inliers/outliers.\n. \n. Regardless of the method, robust or not, the computed homography matrix is refined further (using\n. inliers only in case of a robust method) with the Levenberg-Marquardt method to reduce the\n. re-projection error even more.\n. \n. The methods RANSAC and RHO can handle practically any ratio of outliers but need a threshold to\n. distinguish inliers from outliers. The method LMeDS does not need any threshold but it works\n. correctly only when there are more than 50% of inliers. Finally, if there are no outliers and the\n. noise is rather small, use the default method (method=0).\n. \n. The function is used to find initial intrinsic and extrinsic matrices. Homography matrix is\n. determined up to a scale. Thus, it is normalized so that \\f$h_{33}=1\\f$. Note that whenever an \\f$H\\f$ matrix\n. cannot be estimated, an empty one will be returned.\n. \n. @sa\n. getAffineTransform, estimateAffine2D, estimateAffinePartial2D, getPerspectiveTransform, warpPerspective,\n. perspectiveTransform" ... - -def findNonZero(src: ndarray, idx=...) -> typing.Any: +def findNonZero(src: Mat, idx=...) -> typing.Any: 'findNonZero(src[, idx]) -> idx\n. @brief Returns the list of locations of non-zero pixels\n. \n. Given a binary matrix (likely returned from an operation such\n. as threshold(), compare(), >, ==, etc, return all of\n. the non-zero indices as a cv::Mat or std::vector (x,y)\n. For example:\n. @code{.cpp}\n. cv::Mat binaryImage; // input, binary image\n. cv::Mat locations; // output, locations of non-zero pixels\n. cv::findNonZero(binaryImage, locations);\n. \n. // access pixel coordinates\n. Point pnt = locations.at(i);\n. @endcode\n. or\n. @code{.cpp}\n. cv::Mat binaryImage; // input, binary image\n. vector locations; // output, locations of non-zero pixels\n. cv::findNonZero(binaryImage, locations);\n. \n. // access pixel coordinates\n. Point pnt = locations[i];\n. @endcode\n. @param src single-channel array\n. @param idx the output array, type of cv::Mat or std::vector, corresponding to non-zero indices in the input' ... - def findTransformECC(templateImage, inputImage, warpMatrix, motionType, criteria, inputMask, gaussFiltSize) -> typing.Any: "findTransformECC(templateImage, inputImage, warpMatrix, motionType, criteria, inputMask, gaussFiltSize) -> retval, warpMatrix\n. @brief Finds the geometric transform (warp) between two images in terms of the ECC criterion @cite EP08 .\n. \n. @param templateImage single-channel template image; CV_8U or CV_32F array.\n. @param inputImage single-channel input image which should be warped with the final warpMatrix in\n. order to provide an image similar to templateImage, same type as templateImage.\n. @param warpMatrix floating-point \\f$2\\times 3\\f$ or \\f$3\\times 3\\f$ mapping matrix (warp).\n. @param motionType parameter, specifying the type of motion:\n. - **MOTION_TRANSLATION** sets a translational motion model; warpMatrix is \\f$2\\times 3\\f$ with\n. the first \\f$2\\times 2\\f$ part being the unity matrix and the rest two parameters being\n. estimated.\n. - **MOTION_EUCLIDEAN** sets a Euclidean (rigid) transformation as motion model; three\n. parameters are estimated; warpMatrix is \\f$2\\times 3\\f$.\n. - **MOTION_AFFINE** sets an affine motion model (DEFAULT); six parameters are estimated;\n. warpMatrix is \\f$2\\times 3\\f$.\n. - **MOTION_HOMOGRAPHY** sets a homography as a motion model; eight parameters are\n. estimated;\\`warpMatrix\\` is \\f$3\\times 3\\f$.\n. @param criteria parameter, specifying the termination criteria of the ECC algorithm;\n. criteria.epsilon defines the threshold of the increment in the correlation coefficient between two\n. iterations (a negative criteria.epsilon makes criteria.maxcount the only termination criterion).\n. Default values are shown in the declaration above.\n. @param inputMask An optional mask to indicate valid values of inputImage.\n. @param gaussFiltSize An optional value indicating size of gaussian blur filter; (DEFAULT: 5)\n. \n. The function estimates the optimum transformation (warpMatrix) with respect to ECC criterion\n. (@cite EP08), that is\n. \n. \\f[\\texttt{warpMatrix} = \\arg\\max_{W} \\texttt{ECC}(\\texttt{templateImage}(x,y),\\texttt{inputImage}(x',y'))\\f]\n. \n. where\n. \n. \\f[\\begin{bmatrix} x' \\\\ y' \\end{bmatrix} = W \\cdot \\begin{bmatrix} x \\\\ y \\\\ 1 \\end{bmatrix}\\f]\n. \n. (the equation holds with homogeneous coordinates for homography). It returns the final enhanced\n. correlation coefficient, that is the correlation coefficient between the template image and the\n. final warped input image. When a \\f$3\\times 3\\f$ matrix is given with motionType =0, 1 or 2, the third\n. row is ignored.\n. \n. Unlike findHomography and estimateRigidTransform, the function findTransformECC implements an\n. area-based alignment that builds on intensity similarities. In essence, the function updates the\n. initial transformation that roughly aligns the images. If this information is missing, the identity\n. warp (unity matrix) is used as an initialization. Note that if images undergo strong\n. displacements/rotations, an initial transformation that roughly aligns the images is necessary\n. (e.g., a simple euclidean/similarity transform that allows for the images showing the same image\n. content approximately). Use inverse warping in the second image to take an image close to the first\n. one, i.e. use the flag WARP_INVERSE_MAP with warpAffine or warpPerspective. See also the OpenCV\n. sample image_alignment.cpp that demonstrates the use of the function. Note that the function throws\n. an exception if algorithm does not converges.\n. \n. @sa\n. computeECC, estimateAffine2D, estimateAffinePartial2D, findHomography" ... - def fitEllipse(points) -> typing.Any: 'fitEllipse(points) -> retval\n. @brief Fits an ellipse around a set of 2D points.\n. \n. The function calculates the ellipse that fits (in a least-squares sense) a set of 2D points best of\n. all. It returns the rotated rectangle in which the ellipse is inscribed. The first algorithm described by @cite Fitzgibbon95\n. is used. Developer should keep in mind that it is possible that the returned\n. ellipse/rotatedRect data contains negative indices, due to the data points being close to the\n. border of the containing Mat element.\n. \n. @param points Input 2D point set, stored in std::vector\\<\\> or Mat' ... - def fitEllipseAMS(points) -> typing.Any: 'fitEllipseAMS(points) -> retval\n. @brief Fits an ellipse around a set of 2D points.\n. \n. The function calculates the ellipse that fits a set of 2D points.\n. It returns the rotated rectangle in which the ellipse is inscribed.\n. The Approximate Mean Square (AMS) proposed by @cite Taubin1991 is used.\n. \n. For an ellipse, this basis set is \\f$ \\chi= \\left(x^2, x y, y^2, x, y, 1\\right) \\f$,\n. which is a set of six free coefficients \\f$ A^T=\\left\\{A_{\\text{xx}},A_{\\text{xy}},A_{\\text{yy}},A_x,A_y,A_0\\right\\} \\f$.\n. However, to specify an ellipse, all that is needed is five numbers; the major and minor axes lengths \\f$ (a,b) \\f$,\n. the position \\f$ (x_0,y_0) \\f$, and the orientation \\f$ \\theta \\f$. This is because the basis set includes lines,\n. quadratics, parabolic and hyperbolic functions as well as elliptical functions as possible fits.\n. If the fit is found to be a parabolic or hyperbolic function then the standard #fitEllipse method is used.\n. The AMS method restricts the fit to parabolic, hyperbolic and elliptical curves\n. by imposing the condition that \\f$ A^T ( D_x^T D_x + D_y^T D_y) A = 1 \\f$ where\n. the matrices \\f$ Dx \\f$ and \\f$ Dy \\f$ are the partial derivatives of the design matrix \\f$ D \\f$ with\n. respect to x and y. The matrices are formed row by row applying the following to\n. each of the points in the set:\n. \\f{align*}{\n. D(i,:)&=\\left\\{x_i^2, x_i y_i, y_i^2, x_i, y_i, 1\\right\\} &\n. D_x(i,:)&=\\left\\{2 x_i,y_i,0,1,0,0\\right\\} &\n. D_y(i,:)&=\\left\\{0,x_i,2 y_i,0,1,0\\right\\}\n. \\f}\n. The AMS method minimizes the cost function\n. \\f{equation*}{\n. \\epsilon ^2=\\frac{ A^T D^T D A }{ A^T (D_x^T D_x + D_y^T D_y) A^T }\n. \\f}\n. \n. The minimum cost is found by solving the generalized eigenvalue problem.\n. \n. \\f{equation*}{\n. D^T D A = \\lambda \\left( D_x^T D_x + D_y^T D_y\\right) A\n. \\f}\n. \n. @param points Input 2D point set, stored in std::vector\\<\\> or Mat' ... - def fitEllipseDirect(points) -> typing.Any: 'fitEllipseDirect(points) -> retval\n. @brief Fits an ellipse around a set of 2D points.\n. \n. The function calculates the ellipse that fits a set of 2D points.\n. It returns the rotated rectangle in which the ellipse is inscribed.\n. The Direct least square (Direct) method by @cite Fitzgibbon1999 is used.\n. \n. For an ellipse, this basis set is \\f$ \\chi= \\left(x^2, x y, y^2, x, y, 1\\right) \\f$,\n. which is a set of six free coefficients \\f$ A^T=\\left\\{A_{\\text{xx}},A_{\\text{xy}},A_{\\text{yy}},A_x,A_y,A_0\\right\\} \\f$.\n. However, to specify an ellipse, all that is needed is five numbers; the major and minor axes lengths \\f$ (a,b) \\f$,\n. the position \\f$ (x_0,y_0) \\f$, and the orientation \\f$ \\theta \\f$. This is because the basis set includes lines,\n. quadratics, parabolic and hyperbolic functions as well as elliptical functions as possible fits.\n. The Direct method confines the fit to ellipses by ensuring that \\f$ 4 A_{xx} A_{yy}- A_{xy}^2 > 0 \\f$.\n. The condition imposed is that \\f$ 4 A_{xx} A_{yy}- A_{xy}^2=1 \\f$ which satisfies the inequality\n. and as the coefficients can be arbitrarily scaled is not overly restrictive.\n. \n. \\f{equation*}{\n. \\epsilon ^2= A^T D^T D A \\quad \\text{with} \\quad A^T C A =1 \\quad \\text{and} \\quad C=\\left(\\begin{matrix}\n. 0 & 0 & 2 & 0 & 0 & 0 \\\\\n. 0 & -1 & 0 & 0 & 0 & 0 \\\\\n. 2 & 0 & 0 & 0 & 0 & 0 \\\\\n. 0 & 0 & 0 & 0 & 0 & 0 \\\\\n. 0 & 0 & 0 & 0 & 0 & 0 \\\\\n. 0 & 0 & 0 & 0 & 0 & 0\n. \\end{matrix} \\right)\n. \\f}\n. \n. The minimum cost is found by solving the generalized eigenvalue problem.\n. \n. \\f{equation*}{\n. D^T D A = \\lambda \\left( C\\right) A\n. \\f}\n. \n. The system produces only one positive eigenvalue \\f$ \\lambda\\f$ which is chosen as the solution\n. with its eigenvector \\f$\\mathbf{u}\\f$. These are used to find the coefficients\n. \n. \\f{equation*}{\n. A = \\sqrt{\\frac{1}{\\mathbf{u}^T C \\mathbf{u}}} \\mathbf{u}\n. \\f}\n. The scaling factor guarantees that \\f$A^T C A =1\\f$.\n. \n. @param points Input 2D point set, stored in std::vector\\<\\> or Mat' ... - def fitLine(points, distType, param, reps, aeps, line=...) -> typing.Any: 'fitLine(points, distType, param, reps, aeps[, line]) -> line\n. @brief Fits a line to a 2D or 3D point set.\n. \n. The function fitLine fits a line to a 2D or 3D point set by minimizing \\f$\\sum_i \\rho(r_i)\\f$ where\n. \\f$r_i\\f$ is a distance between the \\f$i^{th}\\f$ point, the line and \\f$\\rho(r)\\f$ is a distance function, one\n. of the following:\n. - DIST_L2\n. \\f[\\rho (r) = r^2/2 \\quad \\text{(the simplest and the fastest least-squares method)}\\f]\n. - DIST_L1\n. \\f[\\rho (r) = r\\f]\n. - DIST_L12\n. \\f[\\rho (r) = 2 \\cdot ( \\sqrt{1 + \\frac{r^2}{2}} - 1)\\f]\n. - DIST_FAIR\n. \\f[\\rho \\left (r \\right ) = C^2 \\cdot \\left ( \\frac{r}{C} - \\log{\\left(1 + \\frac{r}{C}\\right)} \\right ) \\quad \\text{where} \\quad C=1.3998\\f]\n. - DIST_WELSCH\n. \\f[\\rho \\left (r \\right ) = \\frac{C^2}{2} \\cdot \\left ( 1 - \\exp{\\left(-\\left(\\frac{r}{C}\\right)^2\\right)} \\right ) \\quad \\text{where} \\quad C=2.9846\\f]\n. - DIST_HUBER\n. \\f[\\rho (r) = \\fork{r^2/2}{if \\(r < C\\)}{C \\cdot (r-C/2)}{otherwise} \\quad \\text{where} \\quad C=1.345\\f]\n. \n. The algorithm is based on the M-estimator ( ) technique\n. that iteratively fits the line using the weighted least-squares algorithm. After each iteration the\n. weights \\f$w_i\\f$ are adjusted to be inversely proportional to \\f$\\rho(r_i)\\f$ .\n. \n. @param points Input vector of 2D or 3D points, stored in std::vector\\<\\> or Mat.\n. @param line Output line parameters. In case of 2D fitting, it should be a vector of 4 elements\n. (like Vec4f) - (vx, vy, x0, y0), where (vx, vy) is a normalized vector collinear to the line and\n. (x0, y0) is a point on the line. In case of 3D fitting, it should be a vector of 6 elements (like\n. Vec6f) - (vx, vy, vz, x0, y0, z0), where (vx, vy, vz) is a normalized vector collinear to the line\n. and (x0, y0, z0) is a point on the line.\n. @param distType Distance used by the M-estimator, see #DistanceTypes\n. @param param Numerical parameter ( C ) for some types of distances. If it is 0, an optimal value\n. is chosen.\n. @param reps Sufficient accuracy for the radius (distance between the coordinate origin and the line).\n. @param aeps Sufficient accuracy for the angle. 0.01 would be a good default value for reps and aeps.' ... - flann_Index = _mod_cv2.flann_Index - - -def flip(src: ndarray, flipCode, dts: ndarray = ...) -> typing.Any: +def flip(src: Mat, flipCode, dts: Mat = ...) -> typing.Any: 'flip(src, flipCode[, dst]) -> dst\n. @brief Flips a 2D array around vertical, horizontal, or both axes.\n. \n. The function cv::flip flips the array in one of three different ways (row\n. and column indices are 0-based):\n. \\f[\\texttt{dst} _{ij} =\n. \\left\\{\n. \\begin{array}{l l}\n. \\texttt{src} _{\\texttt{src.rows}-i-1,j} & if\\; \\texttt{flipCode} = 0 \\\\\n. \\texttt{src} _{i, \\texttt{src.cols} -j-1} & if\\; \\texttt{flipCode} > 0 \\\\\n. \\texttt{src} _{ \\texttt{src.rows} -i-1, \\texttt{src.cols} -j-1} & if\\; \\texttt{flipCode} < 0 \\\\\n. \\end{array}\n. \\right.\\f]\n. The example scenarios of using the function are the following:\n. * Vertical flipping of the image (flipCode == 0) to switch between\n. top-left and bottom-left image origin. This is a typical operation\n. in video processing on Microsoft Windows\\* OS.\n. * Horizontal flipping of the image with the subsequent horizontal\n. shift and absolute difference calculation to check for a\n. vertical-axis symmetry (flipCode \\> 0).\n. * Simultaneous horizontal and vertical flipping of the image with\n. the subsequent shift and absolute difference calculation to check\n. for a central symmetry (flipCode \\< 0).\n. * Reversing the order of point arrays (flipCode \\> 0 or\n. flipCode == 0).\n. @param src input array.\n. @param dst output array of the same size and type as src.\n. @param flipCode a flag to specify how to flip the array; 0 means\n. flipping around the x-axis and positive value (for example, 1) means\n. flipping around y-axis. Negative value (for example, -1) means flipping\n. around both axes.\n. @sa transpose , repeat , completeSymm' ... - -def floodFill(image: ndarray, mask: typing.Optional[ndarray], seedPoint, newVal, loDiff=..., upDiff=..., flags: int = ...) -> typing.Any: +def floodFill(image: Mat, mask: typing.Optional[Mat], seedPoint, newVal, loDiff=..., upDiff=..., flags: int = ...) -> typing.Any: "floodFill(image, mask, seedPoint, newVal[, loDiff[, upDiff[, flags]]]) -> retval, image, mask, rect\n. @brief Fills a connected component with the given color.\n. \n. The function cv::floodFill fills a connected component starting from the seed point with the specified\n. color. The connectivity is determined by the color/brightness closeness of the neighbor pixels. The\n. pixel at \\f$(x,y)\\f$ is considered to belong to the repainted domain if:\n. \n. - in case of a grayscale image and floating range\n. \\f[\\texttt{src} (x',y')- \\texttt{loDiff} \\leq \\texttt{src} (x,y) \\leq \\texttt{src} (x',y')+ \\texttt{upDiff}\\f]\n. \n. \n. - in case of a grayscale image and fixed range\n. \\f[\\texttt{src} ( \\texttt{seedPoint} .x, \\texttt{seedPoint} .y)- \\texttt{loDiff} \\leq \\texttt{src} (x,y) \\leq \\texttt{src} ( \\texttt{seedPoint} .x, \\texttt{seedPoint} .y)+ \\texttt{upDiff}\\f]\n. \n. \n. - in case of a color image and floating range\n. \\f[\\texttt{src} (x',y')_r- \\texttt{loDiff} _r \\leq \\texttt{src} (x,y)_r \\leq \\texttt{src} (x',y')_r+ \\texttt{upDiff} _r,\\f]\n. \\f[\\texttt{src} (x',y')_g- \\texttt{loDiff} _g \\leq \\texttt{src} (x,y)_g \\leq \\texttt{src} (x',y')_g+ \\texttt{upDiff} _g\\f]\n. and\n. \\f[\\texttt{src} (x',y')_b- \\texttt{loDiff} _b \\leq \\texttt{src} (x,y)_b \\leq \\texttt{src} (x',y')_b+ \\texttt{upDiff} _b\\f]\n. \n. \n. - in case of a color image and fixed range\n. \\f[\\texttt{src} ( \\texttt{seedPoint} .x, \\texttt{seedPoint} .y)_r- \\texttt{loDiff} _r \\leq \\texttt{src} (x,y)_r \\leq \\texttt{src} ( \\texttt{seedPoint} .x, \\texttt{seedPoint} .y)_r+ \\texttt{upDiff} _r,\\f]\n. \\f[\\texttt{src} ( \\texttt{seedPoint} .x, \\texttt{seedPoint} .y)_g- \\texttt{loDiff} _g \\leq \\texttt{src} (x,y)_g \\leq \\texttt{src} ( \\texttt{seedPoint} .x, \\texttt{seedPoint} .y)_g+ \\texttt{upDiff} _g\\f]\n. and\n. \\f[\\texttt{src} ( \\texttt{seedPoint} .x, \\texttt{seedPoint} .y)_b- \\texttt{loDiff} _b \\leq \\texttt{src} (x,y)_b \\leq \\texttt{src} ( \\texttt{seedPoint} .x, \\texttt{seedPoint} .y)_b+ \\texttt{upDiff} _b\\f]\n. \n. \n. where \\f$src(x',y')\\f$ is the value of one of pixel neighbors that is already known to belong to the\n. component. That is, to be added to the connected component, a color/brightness of the pixel should\n. be close enough to:\n. - Color/brightness of one of its neighbors that already belong to the connected component in case\n. of a floating range.\n. - Color/brightness of the seed point in case of a fixed range.\n. \n. Use these functions to either mark a connected component with the specified color in-place, or build\n. a mask and then extract the contour, or copy the region to another image, and so on.\n. \n. @param image Input/output 1- or 3-channel, 8-bit, or floating-point image. It is modified by the\n. function unless the #FLOODFILL_MASK_ONLY flag is set in the second variant of the function. See\n. the details below.\n. @param mask Operation mask that should be a single-channel 8-bit image, 2 pixels wider and 2 pixels\n. taller than image. Since this is both an input and output parameter, you must take responsibility\n. of initializing it. Flood-filling cannot go across non-zero pixels in the input mask. For example,\n. an edge detector output can be used as a mask to stop filling at edges. On output, pixels in the\n. mask corresponding to filled pixels in the image are set to 1 or to the a value specified in flags\n. as described below. Additionally, the function fills the border of the mask with ones to simplify\n. internal processing. It is therefore possible to use the same mask in multiple calls to the function\n. to make sure the filled areas do not overlap.\n. @param seedPoint Starting point.\n. @param newVal New value of the repainted domain pixels.\n. @param loDiff Maximal lower brightness/color difference between the currently observed pixel and\n. one of its neighbors belonging to the component, or a seed pixel being added to the component.\n. @param upDiff Maximal upper brightness/color difference between the currently observed pixel and\n. one of its neighbors belonging to the component, or a seed pixel being added to the component.\n. @param rect Optional output parameter set by the function to the minimum bounding rectangle of the\n. repainted domain.\n. @param flags Operation flags. The first 8 bits contain a connectivity value. The default value of\n. 4 means that only the four nearest neighbor pixels (those that share an edge) are considered. A\n. connectivity value of 8 means that the eight nearest neighbor pixels (those that share a corner)\n. will be considered. The next 8 bits (8-16) contain a value between 1 and 255 with which to fill\n. the mask (the default value is 1). For example, 4 | ( 255 \\<\\< 8 ) will consider 4 nearest\n. neighbours and fill the mask with a value of 255. The following additional options occupy higher\n. bits and therefore may be further combined with the connectivity and mask fill values using\n. bit-wise or (|), see #FloodFillFlags.\n. \n. @note Since the mask is larger than the filled image, a pixel \\f$(x, y)\\f$ in image corresponds to the\n. pixel \\f$(x+1, y+1)\\f$ in the mask .\n. \n. @sa findContours" ... - -def gemm(src1: ndarray, src2: ndarray, alpha, src3, beta, dts: ndarray = ..., flags: int = ...) -> typing.Any: +def gemm(src1: Mat, src2: Mat, alpha, src3, beta, dts: Mat = ..., flags: int = ...) -> typing.Any: 'gemm(src1, src2, alpha, src3, beta[, dst[, flags]]) -> dst\n. @brief Performs generalized matrix multiplication.\n. \n. The function cv::gemm performs generalized matrix multiplication similar to the\n. gemm functions in BLAS level 3. For example,\n. `gemm(src1, src2, alpha, src3, beta, dst, GEMM_1_T + GEMM_3_T)`\n. corresponds to\n. \\f[\\texttt{dst} = \\texttt{alpha} \\cdot \\texttt{src1} ^T \\cdot \\texttt{src2} + \\texttt{beta} \\cdot \\texttt{src3} ^T\\f]\n. \n. In case of complex (two-channel) data, performed a complex matrix\n. multiplication.\n. \n. The function can be replaced with a matrix expression. For example, the\n. above call can be replaced with:\n. @code{.cpp}\n. dst = alpha*src1.t()*src2 + beta*src3.t();\n. @endcode\n. @param src1 first multiplied input matrix that could be real(CV_32FC1,\n. CV_64FC1) or complex(CV_32FC2, CV_64FC2).\n. @param src2 second multiplied input matrix of the same type as src1.\n. @param alpha weight of the matrix product.\n. @param src3 third optional delta matrix added to the matrix product; it\n. should have the same type as src1 and src2.\n. @param beta weight of src3.\n. @param dst output matrix; it has the proper size and the same type as\n. input matrices.\n. @param flags operation flags (cv::GemmFlags)\n. @sa mulTransposed , transform' ... - -def getAffineTransform(src: ndarray, dts: ndarray) -> typing.Any: +def getAffineTransform(src: Mat, dts: Mat) -> typing.Any: 'getAffineTransform(src, dst) -> retval\n. @overload' ... - def getBuildInformation() -> typing.Any: 'getBuildInformation() -> retval\n. @brief Returns full configuration time cmake output.\n. \n. Returned value is raw cmake output including version control system revision, compiler version,\n. compiler flags, enabled modules and third party libraries, etc. Output format depends on target\n. architecture.' ... - def getCPUFeaturesLine() -> typing.Any: 'getCPUFeaturesLine() -> retval\n. @brief Returns list of CPU features enabled during compilation.\n. \n. Returned value is a string containing space separated list of CPU features with following markers:\n. \n. - no markers - baseline features\n. - prefix `*` - features enabled in dispatcher\n. - suffix `?` - features enabled but not available in HW\n. \n. Example: `SSE SSE2 SSE3 *SSE4.1 *SSE4.2 *FP16 *AVX *AVX2 *AVX512-SKX?`' ... - def getCPUTickCount() -> typing.Any: 'getCPUTickCount() -> retval\n. @brief Returns the number of CPU ticks.\n. \n. The function returns the current number of CPU ticks on some architectures (such as x86, x64,\n. PowerPC). On other platforms the function is equivalent to getTickCount. It can also be used for\n. very accurate time measurements, as well as for RNG initialization. Note that in case of multi-CPU\n. systems a thread, from which getCPUTickCount is called, can be suspended and resumed at another CPU\n. with its own counter. So, theoretically (and practically) the subsequent calls to the function do\n. not necessary return the monotonously increasing values. Also, since a modern CPU varies the CPU\n. frequency depending on the load, the number of CPU clocks spent in some code cannot be directly\n. converted to time units. Therefore, getTickCount is generally a preferable solution for measuring\n. execution time.' ... - def getDefaultNewCameraMatrix(cameraMatrix, imgsize=..., centerPrincipalPoint=...) -> typing.Any: 'getDefaultNewCameraMatrix(cameraMatrix[, imgsize[, centerPrincipalPoint]]) -> retval\n. @brief Returns the default new camera matrix.\n. \n. The function returns the camera matrix that is either an exact copy of the input cameraMatrix (when\n. centerPrinicipalPoint=false ), or the modified one (when centerPrincipalPoint=true).\n. \n. In the latter case, the new camera matrix will be:\n. \n. \\f[\\begin{bmatrix} f_x && 0 && ( \\texttt{imgSize.width} -1)*0.5 \\\\ 0 && f_y && ( \\texttt{imgSize.height} -1)*0.5 \\\\ 0 && 0 && 1 \\end{bmatrix} ,\\f]\n. \n. where \\f$f_x\\f$ and \\f$f_y\\f$ are \\f$(0,0)\\f$ and \\f$(1,1)\\f$ elements of cameraMatrix, respectively.\n. \n. By default, the undistortion functions in OpenCV (see #initUndistortRectifyMap, #undistort) do not\n. move the principal point. However, when you work with stereo, it is important to move the principal\n. points in both views to the same y-coordinate (which is required by most of stereo correspondence\n. algorithms), and may be to the same x-coordinate too. So, you can form the new camera matrix for\n. each view where the principal points are located at the center.\n. \n. @param cameraMatrix Input camera matrix.\n. @param imgsize Camera view image size in pixels.\n. @param centerPrincipalPoint Location of the principal point in the new camera matrix. The\n. parameter indicates whether this location should be at the image center or not.' ... - def getDerivKernels(dx, dy, ksize, kx=..., ky=..., normalize=..., ktype=...) -> typing.Any: 'getDerivKernels(dx, dy, ksize[, kx[, ky[, normalize[, ktype]]]]) -> kx, ky\n. @brief Returns filter coefficients for computing spatial image derivatives.\n. \n. The function computes and returns the filter coefficients for spatial image derivatives. When\n. `ksize=FILTER_SCHARR`, the Scharr \\f$3 \\times 3\\f$ kernels are generated (see #Scharr). Otherwise, Sobel\n. kernels are generated (see #Sobel). The filters are normally passed to #sepFilter2D or to\n. \n. @param kx Output matrix of row filter coefficients. It has the type ktype .\n. @param ky Output matrix of column filter coefficients. It has the type ktype .\n. @param dx Derivative order in respect of x.\n. @param dy Derivative order in respect of y.\n. @param ksize Aperture size. It can be FILTER_SCHARR, 1, 3, 5, or 7.\n. @param normalize Flag indicating whether to normalize (scale down) the filter coefficients or not.\n. Theoretically, the coefficients should have the denominator \\f$=2^{ksize*2-dx-dy-2}\\f$. If you are\n. going to filter floating-point images, you are likely to use the normalized kernels. But if you\n. compute derivatives of an 8-bit image, store the results in a 16-bit image, and wish to preserve\n. all the fractional bits, you may want to set normalize=false .\n. @param ktype Type of filter coefficients. It can be CV_32f or CV_64F .' ... - def getFontScaleFromHeight(fontFace, pixelHeight, thickness=...) -> typing.Any: 'getFontScaleFromHeight(fontFace, pixelHeight[, thickness]) -> retval\n. @brief Calculates the font-specific size to use to achieve a given height in pixels.\n. \n. @param fontFace Font to use, see cv::HersheyFonts.\n. @param pixelHeight Pixel height to compute the fontScale for\n. @param thickness Thickness of lines used to render the text.See putText for details.\n. @return The fontSize to use for cv::putText\n. \n. @see cv::putText' ... - def getGaborKernel(ksize, sigma, theta, lambd, gamma, psi=..., ktype=...) -> typing.Any: 'getGaborKernel(ksize, sigma, theta, lambd, gamma[, psi[, ktype]]) -> retval\n. @brief Returns Gabor filter coefficients.\n. \n. For more details about gabor filter equations and parameters, see: [Gabor\n. Filter](http://en.wikipedia.org/wiki/Gabor_filter).\n. \n. @param ksize Size of the filter returned.\n. @param sigma Standard deviation of the gaussian envelope.\n. @param theta Orientation of the normal to the parallel stripes of a Gabor function.\n. @param lambd Wavelength of the sinusoidal factor.\n. @param gamma Spatial aspect ratio.\n. @param psi Phase offset.\n. @param ktype Type of filter coefficients. It can be CV_32F or CV_64F .' ... - def getGaussianKernel(ksize, sigma, ktype=...) -> typing.Any: 'getGaussianKernel(ksize, sigma[, ktype]) -> retval\n. @brief Returns Gaussian filter coefficients.\n. \n. The function computes and returns the \\f$\\texttt{ksize} \\times 1\\f$ matrix of Gaussian filter\n. coefficients:\n. \n. \\f[G_i= \\alpha *e^{-(i-( \\texttt{ksize} -1)/2)^2/(2* \\texttt{sigma}^2)},\\f]\n. \n. where \\f$i=0..\\texttt{ksize}-1\\f$ and \\f$\\alpha\\f$ is the scale factor chosen so that \\f$\\sum_i G_i=1\\f$.\n. \n. Two of such generated kernels can be passed to sepFilter2D. Those functions automatically recognize\n. smoothing kernels (a symmetrical kernel with sum of weights equal to 1) and handle them accordingly.\n. You may also use the higher-level GaussianBlur.\n. @param ksize Aperture size. It should be odd ( \\f$\\texttt{ksize} \\mod 2 = 1\\f$ ) and positive.\n. @param sigma Gaussian standard deviation. If it is non-positive, it is computed from ksize as\n. `sigma = 0.3*((ksize-1)*0.5 - 1) + 0.8`.\n. @param ktype Type of filter coefficients. It can be CV_32F or CV_64F .\n. @sa sepFilter2D, getDerivKernels, getStructuringElement, GaussianBlur' ... - def getHardwareFeatureName(feature) -> typing.Any: 'getHardwareFeatureName(feature) -> retval\n. @brief Returns feature name by ID\n. \n. Returns empty string if feature is not defined' ... - def getNumThreads() -> typing.Any: 'getNumThreads() -> retval\n. @brief Returns the number of threads used by OpenCV for parallel regions.\n. \n. Always returns 1 if OpenCV is built without threading support.\n. \n. The exact meaning of return value depends on the threading framework used by OpenCV library:\n. - `TBB` - The number of threads, that OpenCV will try to use for parallel regions. If there is\n. any tbb::thread_scheduler_init in user code conflicting with OpenCV, then function returns\n. default number of threads used by TBB library.\n. - `OpenMP` - An upper bound on the number of threads that could be used to form a new team.\n. - `Concurrency` - The number of threads, that OpenCV will try to use for parallel regions.\n. - `GCD` - Unsupported; returns the GCD thread pool limit (512) for compatibility.\n. - `C=` - The number of threads, that OpenCV will try to use for parallel regions, if before\n. called setNumThreads with threads \\> 0, otherwise returns the number of logical CPUs,\n. available for the process.\n. @sa setNumThreads, getThreadNum' ... - def getNumberOfCPUs() -> typing.Any: 'getNumberOfCPUs() -> retval\n. @brief Returns the number of logical CPUs available for the process.' ... - def getOptimalDFTSize(vecsize) -> typing.Any: "getOptimalDFTSize(vecsize) -> retval\n. @brief Returns the optimal DFT size for a given vector size.\n. \n. DFT performance is not a monotonic function of a vector size. Therefore, when you calculate\n. convolution of two arrays or perform the spectral analysis of an array, it usually makes sense to\n. pad the input data with zeros to get a bit larger array that can be transformed much faster than the\n. original one. Arrays whose size is a power-of-two (2, 4, 8, 16, 32, ...) are the fastest to process.\n. Though, the arrays whose size is a product of 2's, 3's, and 5's (for example, 300 = 5\\*5\\*3\\*2\\*2)\n. are also processed quite efficiently.\n. \n. The function cv::getOptimalDFTSize returns the minimum number N that is greater than or equal to vecsize\n. so that the DFT of a vector of size N can be processed efficiently. In the current implementation N\n. = 2 ^p^ \\* 3 ^q^ \\* 5 ^r^ for some integer p, q, r.\n. \n. The function returns a negative number if vecsize is too large (very close to INT_MAX ).\n. \n. While the function cannot be used directly to estimate the optimal vector size for DCT transform\n. (since the current DCT implementation supports only even-size vectors), it can be easily processed\n. as getOptimalDFTSize((vecsize+1)/2)\\*2.\n. @param vecsize vector size.\n. @sa dft , dct , idft , idct , mulSpectrums" ... - def getOptimalNewCameraMatrix(cameraMatrix, distCoeffs, imageSize, alpha, newImgSize=..., centerPrincipalPoint=...) -> typing.Any: 'getOptimalNewCameraMatrix(cameraMatrix, distCoeffs, imageSize, alpha[, newImgSize[, centerPrincipalPoint]]) -> retval, validPixROI\n. @brief Returns the new camera matrix based on the free scaling parameter.\n. \n. @param cameraMatrix Input camera matrix.\n. @param distCoeffs Input vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$ of\n. 4, 5, 8, 12 or 14 elements. If the vector is NULL/empty, the zero distortion coefficients are\n. assumed.\n. @param imageSize Original image size.\n. @param alpha Free scaling parameter between 0 (when all the pixels in the undistorted image are\n. valid) and 1 (when all the source image pixels are retained in the undistorted image). See\n. stereoRectify for details.\n. @param newImgSize Image size after rectification. By default, it is set to imageSize .\n. @param validPixROI Optional output rectangle that outlines all-good-pixels region in the\n. undistorted image. See roi1, roi2 description in stereoRectify .\n. @param centerPrincipalPoint Optional flag that indicates whether in the new camera matrix the\n. principal point should be at the image center or not. By default, the principal point is chosen to\n. best fit a subset of the source image (determined by alpha) to the corrected image.\n. @return new_camera_matrix Output new camera matrix.\n. \n. The function computes and returns the optimal new camera matrix based on the free scaling parameter.\n. By varying this parameter, you may retrieve only sensible pixels alpha=0 , keep all the original\n. image pixels if there is valuable information in the corners alpha=1 , or get something in between.\n. When alpha\\>0 , the undistorted result is likely to have some black pixels corresponding to\n. "virtual" pixels outside of the captured distorted image. The original camera matrix, distortion\n. coefficients, the computed new camera matrix, and newImageSize should be passed to\n. initUndistortRectifyMap to produce the maps for remap .' ... - -def getPerspectiveTransform(src: ndarray, dts: ndarray, solveMethod=...) -> typing.Any: +def getPerspectiveTransform(src: Mat, dts: Mat, solveMethod=...) -> typing.Any: "getPerspectiveTransform(src, dst[, solveMethod]) -> retval\n. @brief Calculates a perspective transform from four pairs of the corresponding points.\n. \n. The function calculates the \\f$3 \\times 3\\f$ matrix of a perspective transform so that:\n. \n. \\f[\\begin{bmatrix} t_i x'_i \\\\ t_i y'_i \\\\ t_i \\end{bmatrix} = \\texttt{map_matrix} \\cdot \\begin{bmatrix} x_i \\\\ y_i \\\\ 1 \\end{bmatrix}\\f]\n. \n. where\n. \n. \\f[dst(i)=(x'_i,y'_i), src(i)=(x_i, y_i), i=0,1,2,3\\f]\n. \n. @param src Coordinates of quadrangle vertices in the source image.\n. @param dst Coordinates of the corresponding quadrangle vertices in the destination image.\n. @param solveMethod method passed to cv::solve (#DecompTypes)\n. \n. @sa findHomography, warpPerspective, perspectiveTransform" ... - -def getRectSubPix(image: ndarray, patchSize, center, patch=..., patchType=...) -> typing.Any: +def getRectSubPix(image: Mat, patchSize, center, patch=..., patchType=...) -> typing.Any: 'getRectSubPix(image, patchSize, center[, patch[, patchType]]) -> patch\n. @brief Retrieves a pixel rectangle from an image with sub-pixel accuracy.\n. \n. The function getRectSubPix extracts pixels from src:\n. \n. \\f[patch(x, y) = src(x + \\texttt{center.x} - ( \\texttt{dst.cols} -1)*0.5, y + \\texttt{center.y} - ( \\texttt{dst.rows} -1)*0.5)\\f]\n. \n. where the values of the pixels at non-integer coordinates are retrieved using bilinear\n. interpolation. Every channel of multi-channel images is processed independently. Also\n. the image should be a single channel or three channel image. While the center of the\n. rectangle must be inside the image, parts of the rectangle may be outside.\n. \n. @param image Source image.\n. @param patchSize Size of the extracted patch.\n. @param center Floating point coordinates of the center of the extracted rectangle within the\n. source image. The center must be inside the image.\n. @param patch Extracted patch that has the size patchSize and the same number of channels as src .\n. @param patchType Depth of the extracted pixels. By default, they have the same depth as src .\n. \n. @sa warpAffine, warpPerspective' ... - def getRotationMatrix2D(center, angle, scale) -> typing.Any: 'getRotationMatrix2D(center, angle, scale) -> retval\n. @brief Calculates an affine matrix of 2D rotation.\n. \n. The function calculates the following matrix:\n. \n. \\f[\\begin{bmatrix} \\alpha & \\beta & (1- \\alpha ) \\cdot \\texttt{center.x} - \\beta \\cdot \\texttt{center.y} \\\\ - \\beta & \\alpha & \\beta \\cdot \\texttt{center.x} + (1- \\alpha ) \\cdot \\texttt{center.y} \\end{bmatrix}\\f]\n. \n. where\n. \n. \\f[\\begin{array}{l} \\alpha = \\texttt{scale} \\cdot \\cos \\texttt{angle} , \\\\ \\beta = \\texttt{scale} \\cdot \\sin \\texttt{angle} \\end{array}\\f]\n. \n. The transformation maps the rotation center to itself. If this is not the target, adjust the shift.\n. \n. @param center Center of the rotation in the source image.\n. @param angle Rotation angle in degrees. Positive values mean counter-clockwise rotation (the\n. coordinate origin is assumed to be the top-left corner).\n. @param scale Isotropic scale factor.\n. \n. @sa getAffineTransform, warpAffine, transform' ... - def getStructuringElement(shape, ksize, anchor=...) -> typing.Any: 'getStructuringElement(shape, ksize[, anchor]) -> retval\n. @brief Returns a structuring element of the specified size and shape for morphological operations.\n. \n. The function constructs and returns the structuring element that can be further passed to #erode,\n. #dilate or #morphologyEx. But you can also construct an arbitrary binary mask yourself and use it as\n. the structuring element.\n. \n. @param shape Element shape that could be one of #MorphShapes\n. @param ksize Size of the structuring element.\n. @param anchor Anchor position within the element. The default value \\f$(-1, -1)\\f$ means that the\n. anchor is at the center. Note that only the shape of a cross-shaped element depends on the anchor\n. position. In other cases the anchor just regulates how much the result of the morphological\n. operation is shifted.' ... - def getTextSize(text, fontFace, fontScale, thickness) -> typing.Any: 'getTextSize(text, fontFace, fontScale, thickness) -> retval, baseLine\n. @brief Calculates the width and height of a text string.\n. \n. The function cv::getTextSize calculates and returns the size of a box that contains the specified text.\n. That is, the following code renders some text, the tight box surrounding it, and the baseline: :\n. @code\n. String text = "Funny text inside the box";\n. int fontFace = FONT_HERSHEY_SCRIPT_SIMPLEX;\n. double fontScale = 2;\n. int thickness = 3;\n. \n. Mat img(600, 800, CV_8UC3, Scalar::all(0));\n. \n. int baseline=0;\n. Size textSize = getTextSize(text, fontFace,\n. fontScale, thickness, &baseline);\n. baseline += thickness;\n. \n. // center the text\n. Point textOrg((img.cols - textSize.width)/2,\n. (img.rows + textSize.height)/2);\n. \n. // draw the box\n. rectangle(img, textOrg + Point(0, baseline),\n. textOrg + Point(textSize.width, -textSize.height),\n. Scalar(0,0,255));\n. // ... and the baseline first\n. line(img, textOrg + Point(0, thickness),\n. textOrg + Point(textSize.width, thickness),\n. Scalar(0, 0, 255));\n. \n. // then put the text itself\n. putText(img, text, textOrg, fontFace, fontScale,\n. Scalar::all(255), thickness, 8);\n. @endcode\n. \n. @param text Input text string.\n. @param fontFace Font to use, see #HersheyFonts.\n. @param fontScale Font scale factor that is multiplied by the font-specific base size.\n. @param thickness Thickness of lines used to render the text. See #putText for details.\n. @param[out] baseLine y-coordinate of the baseline relative to the bottom-most text\n. point.\n. @return The size of a box that contains the specified text.\n. \n. @see putText' ... - def getThreadNum() -> typing.Any: "getThreadNum() -> retval\n. @brief Returns the index of the currently executed thread within the current parallel region. Always\n. returns 0 if called outside of parallel region.\n. \n. @deprecated Current implementation doesn't corresponding to this documentation.\n. \n. The exact meaning of the return value depends on the threading framework used by OpenCV library:\n. - `TBB` - Unsupported with current 4.1 TBB release. Maybe will be supported in future.\n. - `OpenMP` - The thread number, within the current team, of the calling thread.\n. - `Concurrency` - An ID for the virtual processor that the current context is executing on (0\n. for master thread and unique number for others, but not necessary 1,2,3,...).\n. - `GCD` - System calling thread's ID. Never returns 0 inside parallel region.\n. - `C=` - The index of the current parallel task.\n. @sa setNumThreads, getNumThreads" ... - def getTickCount() -> typing.Any: 'getTickCount() -> retval\n. @brief Returns the number of ticks.\n. \n. The function returns the number of ticks after the certain event (for example, when the machine was\n. turned on). It can be used to initialize RNG or to measure a function execution time by reading the\n. tick count before and after the function call.\n. @sa getTickFrequency, TickMeter' ... - def getTickFrequency() -> typing.Any: 'getTickFrequency() -> retval\n. @brief Returns the number of ticks per second.\n. \n. The function returns the number of ticks per second. That is, the following code computes the\n. execution time in seconds:\n. @code\n. double t = (double)getTickCount();\n. // do something ...\n. t = ((double)getTickCount() - t)/getTickFrequency();\n. @endcode\n. @sa getTickCount, TickMeter' ... - def getTrackbarPos(trackbarname, winname) -> typing.Any: 'getTrackbarPos(trackbarname, winname) -> retval\n. @brief Returns the trackbar position.\n. \n. The function returns the current position of the specified trackbar.\n. \n. @note\n. \n. [__Qt Backend Only__] winname can be empty if the trackbar is attached to the control\n. panel.\n. \n. @param trackbarname Name of the trackbar.\n. @param winname Name of the window that is the parent of the trackbar.' ... - def getValidDisparityROI(roi1, roi2, minDisparity, numberOfDisparities, blockSize) -> typing.Any: 'getValidDisparityROI(roi1, roi2, minDisparity, numberOfDisparities, blockSize) -> retval\n.' ... - def getVersionMajor() -> typing.Any: 'getVersionMajor() -> retval\n. @brief Returns major library version' ... - def getVersionMinor() -> typing.Any: 'getVersionMinor() -> retval\n. @brief Returns minor library version' ... - def getVersionRevision() -> typing.Any: 'getVersionRevision() -> retval\n. @brief Returns revision field of the library version' ... - def getVersionString() -> typing.Any: 'getVersionString() -> retval\n. @brief Returns library version string\n. \n. For example "3.4.1-dev".\n. \n. @sa getMajorVersion, getMinorVersion, getRevisionVersion' ... - def getWindowImageRect(winname) -> typing.Any: 'getWindowImageRect(winname) -> retval\n. @brief Provides rectangle of image in the window.\n. \n. The function getWindowImageRect returns the client screen coordinates, width and height of the image rendering area.\n. \n. @param winname Name of the window.\n. \n. @sa resizeWindow moveWindow' ... - def getWindowProperty(winname, prop_id) -> typing.Any: 'getWindowProperty(winname, prop_id) -> retval\n. @brief Provides parameters of a window.\n. \n. The function getWindowProperty returns properties of a window.\n. \n. @param winname Name of the window.\n. @param prop_id Window property to retrieve. The following operation flags are available: (cv::WindowPropertyFlags)\n. \n. @sa setWindowProperty' ... - -def goodFeaturesToTrack(image: ndarray, maxCorners, qualityLevel, minDistance, corners=..., mask: ndarray = ..., blockSize=..., useHarrisDetector=..., k=...) -> typing.Any: +def goodFeaturesToTrack(image: Mat, maxCorners, qualityLevel, minDistance, corners=..., mask: Mat = ..., blockSize=..., useHarrisDetector=..., k=...) -> typing.Any: 'goodFeaturesToTrack(image, maxCorners, qualityLevel, minDistance[, corners[, mask[, blockSize[, useHarrisDetector[, k]]]]]) -> corners\n. @brief Determines strong corners on an image.\n. \n. The function finds the most prominent corners in the image or in the specified image region, as\n. described in @cite Shi94\n. \n. - Function calculates the corner quality measure at every source image pixel using the\n. #cornerMinEigenVal or #cornerHarris .\n. - Function performs a non-maximum suppression (the local maximums in *3 x 3* neighborhood are\n. retained).\n. - The corners with the minimal eigenvalue less than\n. \\f$\\texttt{qualityLevel} \\cdot \\max_{x,y} qualityMeasureMap(x,y)\\f$ are rejected.\n. - The remaining corners are sorted by the quality measure in the descending order.\n. - Function throws away each corner for which there is a stronger corner at a distance less than\n. maxDistance.\n. \n. The function can be used to initialize a point-based tracker of an object.\n. \n. @note If the function is called with different values A and B of the parameter qualityLevel , and\n. A \\> B, the vector of returned corners with qualityLevel=A will be the prefix of the output vector\n. with qualityLevel=B .\n. \n. @param image Input 8-bit or floating-point 32-bit, single-channel image.\n. @param corners Output vector of detected corners.\n. @param maxCorners Maximum number of corners to return. If there are more corners than are found,\n. the strongest of them is returned. `maxCorners <= 0` implies that no limit on the maximum is set\n. and all detected corners are returned.\n. @param qualityLevel Parameter characterizing the minimal accepted quality of image corners. The\n. parameter value is multiplied by the best corner quality measure, which is the minimal eigenvalue\n. (see #cornerMinEigenVal ) or the Harris function response (see #cornerHarris ). The corners with the\n. quality measure less than the product are rejected. For example, if the best corner has the\n. quality measure = 1500, and the qualityLevel=0.01 , then all the corners with the quality measure\n. less than 15 are rejected.\n. @param minDistance Minimum possible Euclidean distance between the returned corners.\n. @param mask Optional region of interest. If the image is not empty (it needs to have the type\n. CV_8UC1 and the same size as image ), it specifies the region in which the corners are detected.\n. @param blockSize Size of an average block for computing a derivative covariation matrix over each\n. pixel neighborhood. See cornerEigenValsAndVecs .\n. @param useHarrisDetector Parameter indicating whether to use a Harris detector (see #cornerHarris)\n. or #cornerMinEigenVal.\n. @param k Free parameter of the Harris detector.\n. \n. @sa cornerMinEigenVal, cornerHarris, calcOpticalFlowPyrLK, estimateRigidTransform,\n\n\n\ngoodFeaturesToTrack(image, maxCorners, qualityLevel, minDistance, mask, blockSize, gradientSize[, corners[, useHarrisDetector[, k]]]) -> corners\n.' ... - -def grabCut(img: ndarray, mask: typing.Optional[ndarray], rect, bgdModel, fgdModel, iterCount, mode=...) -> typing.Any: +def grabCut(img: Mat, mask: typing.Optional[Mat], rect, bgdModel, fgdModel, iterCount, mode=...) -> typing.Any: 'grabCut(img, mask, rect, bgdModel, fgdModel, iterCount[, mode]) -> mask, bgdModel, fgdModel\n. @brief Runs the GrabCut algorithm.\n. \n. The function implements the [GrabCut image segmentation algorithm](http://en.wikipedia.org/wiki/GrabCut).\n. \n. @param img Input 8-bit 3-channel image.\n. @param mask Input/output 8-bit single-channel mask. The mask is initialized by the function when\n. mode is set to #GC_INIT_WITH_RECT. Its elements may have one of the #GrabCutClasses.\n. @param rect ROI containing a segmented object. The pixels outside of the ROI are marked as\n. "obvious background". The parameter is only used when mode==#GC_INIT_WITH_RECT .\n. @param bgdModel Temporary array for the background model. Do not modify it while you are\n. processing the same image.\n. @param fgdModel Temporary arrays for the foreground model. Do not modify it while you are\n. processing the same image.\n. @param iterCount Number of iterations the algorithm should make before returning the result. Note\n. that the result can be refined with further calls with mode==#GC_INIT_WITH_MASK or\n. mode==GC_EVAL .\n. @param mode Operation mode that could be one of the #GrabCutModes' ... - def groupRectangles(rectList, groupThreshold, eps=...) -> typing.Any: 'groupRectangles(rectList, groupThreshold[, eps]) -> rectList, weights\n. @overload' ... - def haveImageReader(filename: str) -> typing.Any: 'haveImageReader(filename) -> retval\n. @brief Returns true if the specified image can be decoded by OpenCV\n. \n. @param filename File name of the image' ... - def haveImageWriter(filename: str) -> typing.Any: 'haveImageWriter(filename) -> retval\n. @brief Returns true if an image with the specified filename can be encoded by OpenCV\n. \n. @param filename File name of the image' ... - def haveOpenVX() -> typing.Any: 'haveOpenVX() -> retval\n.' ... - -def hconcat(src: ndarray, dts: ndarray = ...) -> typing.Any: +def hconcat(src: Mat, dts: Mat = ...) -> typing.Any: 'hconcat(src[, dst]) -> dst\n. @overload\n. @code{.cpp}\n. std::vector matrices = { cv::Mat(4, 1, CV_8UC1, cv::Scalar(1)),\n. cv::Mat(4, 1, CV_8UC1, cv::Scalar(2)),\n. cv::Mat(4, 1, CV_8UC1, cv::Scalar(3)),};\n. \n. cv::Mat out;\n. cv::hconcat( matrices, out );\n. //out:\n. //[1, 2, 3;\n. // 1, 2, 3;\n. // 1, 2, 3;\n. // 1, 2, 3]\n. @endcode\n. @param src input array or vector of matrices. all of the matrices must have the same number of rows and the same depth.\n. @param dst output array. It has the same number of rows and depth as the src, and the sum of cols of the src.\n. same depth.' ... - -def idct(src: ndarray, dts: ndarray = ..., flags: int = ...) -> typing.Any: +def idct(src: Mat, dts: Mat = ..., flags: int = ...) -> typing.Any: 'idct(src[, dst[, flags]]) -> dst\n. @brief Calculates the inverse Discrete Cosine Transform of a 1D or 2D array.\n. \n. idct(src, dst, flags) is equivalent to dct(src, dst, flags | DCT_INVERSE).\n. @param src input floating-point single-channel array.\n. @param dst output array of the same size and type as src.\n. @param flags operation flags.\n. @sa dct, dft, idft, getOptimalDFTSize' ... - -def idft(src: ndarray, dts: ndarray = ..., flags: int = ..., nonzeroRows=...) -> typing.Any: +def idft(src: Mat, dts: Mat = ..., flags: int = ..., nonzeroRows=...) -> typing.Any: 'idft(src[, dst[, flags[, nonzeroRows]]]) -> dst\n. @brief Calculates the inverse Discrete Fourier Transform of a 1D or 2D array.\n. \n. idft(src, dst, flags) is equivalent to dft(src, dst, flags | #DFT_INVERSE) .\n. @note None of dft and idft scales the result by default. So, you should pass #DFT_SCALE to one of\n. dft or idft explicitly to make these transforms mutually inverse.\n. @sa dft, dct, idct, mulSpectrums, getOptimalDFTSize\n. @param src input floating-point real or complex array.\n. @param dst output array whose size and type depend on the flags.\n. @param flags operation flags (see dft and #DftFlags).\n. @param nonzeroRows number of dst rows to process; the rest of the rows have undefined content (see\n. the convolution sample in dft description.' ... - -def illuminationChange(src: ndarray, mask: ndarray, dts: ndarray = ..., alpha=..., beta=...) -> typing.Any: +def illuminationChange(src: Mat, mask: Mat, dts: Mat = ..., alpha=..., beta=...) -> typing.Any: 'illuminationChange(src, mask[, dst[, alpha[, beta]]]) -> dst\n. @brief Applying an appropriate non-linear transformation to the gradient field inside the selection and\n. then integrating back with a Poisson solver, modifies locally the apparent illumination of an image.\n. \n. @param src Input 8-bit 3-channel image.\n. @param mask Input 8-bit 1 or 3-channel image.\n. @param dst Output image with the same size and type as src.\n. @param alpha Value ranges between 0-2.\n. @param beta Value ranges between 0-2.\n. \n. This is useful to highlight under-exposed foreground objects or to reduce specular reflections.' ... - def imdecode(buf, flags: int) -> typing.Any: 'imdecode(buf, flags) -> retval\n. @brief Reads an image from a buffer in memory.\n. \n. The function imdecode reads an image from the specified buffer in the memory. If the buffer is too short or\n. contains invalid data, the function returns an empty matrix ( Mat::data==NULL ).\n. \n. See cv::imread for the list of supported formats and flags description.\n. \n. @note In the case of color images, the decoded images will have the channels stored in **B G R** order.\n. @param buf Input array or vector of bytes.\n. @param flags The same flags as in cv::imread, see cv::ImreadModes.' ... - -def imencode(ext, img: ndarray, params=...) -> typing.Any: +def imencode(ext, img: Mat, params=...) -> typing.Any: 'imencode(ext, img[, params]) -> retval, buf\n. @brief Encodes an image into a memory buffer.\n. \n. The function imencode compresses the image and stores it in the memory buffer that is resized to fit the\n. result. See cv::imwrite for the list of supported formats and flags description.\n. \n. @param ext File extension that defines the output format.\n. @param img Image to be written.\n. @param buf Output buffer resized to fit the compressed image.\n. @param params Format-specific parameters. See cv::imwrite and cv::ImwriteFlags.' ... - -def imread(filename: str, flags: int = ...) -> ndarray: +def imread(filename: str, flags: int = ...) -> Mat: 'imread(filename[, flags]) -> retval\n. @brief Loads an image from a file.\n. \n. @anchor imread\n. \n. The function imread loads an image from the specified file and returns it. If the image cannot be\n. read (because of missing file, improper permissions, unsupported or invalid format), the function\n. returns an empty matrix ( Mat::data==NULL ).\n. \n. Currently, the following file formats are supported:\n. \n. - Windows bitmaps - \\*.bmp, \\*.dib (always supported)\n. - JPEG files - \\*.jpeg, \\*.jpg, \\*.jpe (see the *Note* section)\n. - JPEG 2000 files - \\*.jp2 (see the *Note* section)\n. - Portable Network Graphics - \\*.png (see the *Note* section)\n. - WebP - \\*.webp (see the *Note* section)\n. - Portable image format - \\*.pbm, \\*.pgm, \\*.ppm \\*.pxm, \\*.pnm (always supported)\n. - PFM files - \\*.pfm (see the *Note* section)\n. - Sun rasters - \\*.sr, \\*.ras (always supported)\n. - TIFF files - \\*.tiff, \\*.tif (see the *Note* section)\n. - OpenEXR Image files - \\*.exr (see the *Note* section)\n. - Radiance HDR - \\*.hdr, \\*.pic (always supported)\n. - Raster and Vector geospatial data supported by GDAL (see the *Note* section)\n. \n. @note\n. - The function determines the type of an image by the content, not by the file extension.\n. - In the case of color images, the decoded images will have the channels stored in **B G R** order.\n. - When using IMREAD_GRAYSCALE, the codec\'s internal grayscale conversion will be used, if available.\n. Results may differ to the output of cvtColor()\n. - On Microsoft Windows\\* OS and MacOSX\\*, the codecs shipped with an OpenCV image (libjpeg,\n. libpng, libtiff, and libjasper) are used by default. So, OpenCV can always read JPEGs, PNGs,\n. and TIFFs. On MacOSX, there is also an option to use native MacOSX image readers. But beware\n. that currently these native image loaders give images with different pixel values because of\n. the color management embedded into MacOSX.\n. - On Linux\\*, BSD flavors and other Unix-like open-source operating systems, OpenCV looks for\n. codecs supplied with an OS image. Install the relevant packages (do not forget the development\n. files, for example, "libjpeg-dev", in Debian\\* and Ubuntu\\*) to get the codec support or turn\n. on the OPENCV_BUILD_3RDPARTY_LIBS flag in CMake.\n. - In the case you set *WITH_GDAL* flag to true in CMake and @ref IMREAD_LOAD_GDAL to load the image,\n. then the [GDAL](http://www.gdal.org) driver will be used in order to decode the image, supporting\n. the following formats: [Raster](http://www.gdal.org/formats_list.html),\n. [Vector](http://www.gdal.org/ogr_formats.html).\n. - If EXIF information is embedded in the image file, the EXIF orientation will be taken into account\n. and thus the image will be rotated accordingly except if the flags @ref IMREAD_IGNORE_ORIENTATION\n. or @ref IMREAD_UNCHANGED are passed.\n. - Use the IMREAD_UNCHANGED flag to keep the floating point values from PFM image.\n. - By default number of pixels must be less than 2^30. Limit can be set using system\n. variable OPENCV_IO_MAX_IMAGE_PIXELS\n. \n. @param filename Name of file to be loaded.\n. @param flags Flag that can take values of cv::ImreadModes' ... - def imreadmulti(filename: str, mats=..., flags: int = ...) -> typing.Any: 'imreadmulti(filename[, mats[, flags]]) -> retval, mats\n. @brief Loads a multi-page image from a file.\n. \n. The function imreadmulti loads a multi-page image from the specified file into a vector of Mat objects.\n. @param filename Name of file to be loaded.\n. @param flags Flag that can take values of cv::ImreadModes, default with cv::IMREAD_ANYCOLOR.\n. @param mats A vector of Mat objects holding each page, if more than one.\n. @sa cv::imread' ... - def imshow(winname, mat) -> typing.Any: 'imshow(winname, mat) -> None\n. @brief Displays an image in the specified window.\n. \n. The function imshow displays an image in the specified window. If the window was created with the\n. cv::WINDOW_AUTOSIZE flag, the image is shown with its original size, however it is still limited by the screen resolution.\n. Otherwise, the image is scaled to fit the window. The function may scale the image, depending on its depth:\n. \n. - If the image is 8-bit unsigned, it is displayed as is.\n. - If the image is 16-bit unsigned or 32-bit integer, the pixels are divided by 256. That is, the\n. value range [0,255\\*256] is mapped to [0,255].\n. - If the image is 32-bit or 64-bit floating-point, the pixel values are multiplied by 255. That is, the\n. value range [0,1] is mapped to [0,255].\n. \n. If window was created with OpenGL support, cv::imshow also support ogl::Buffer , ogl::Texture2D and\n. cuda::GpuMat as input.\n. \n. If the window was not created before this function, it is assumed creating a window with cv::WINDOW_AUTOSIZE.\n. \n. If you need to show an image that is bigger than the screen resolution, you will need to call namedWindow("", WINDOW_NORMAL) before the imshow.\n. \n. @note This function should be followed by cv::waitKey function which displays the image for specified\n. milliseconds. Otherwise, it won\'t display the image. For example, **waitKey(0)** will display the window\n. infinitely until any keypress (it is suitable for image display). **waitKey(25)** will display a frame\n. for 25 ms, after which display will be automatically closed. (If you put it in a loop to read\n. videos, it will display the video frame-by-frame)\n. \n. @note\n. \n. [__Windows Backend Only__] Pressing Ctrl+C will copy the image to the clipboard.\n. \n. [__Windows Backend Only__] Pressing Ctrl+S will show a dialog to save the image.\n. \n. @param winname Name of the window.\n. @param mat Image to be shown.' ... - -def imwrite(filename: str, img: ndarray, params: list[int] = ...) -> bool: +def imwrite(filename: str, img: Mat, params: typing.List[int] = ...) -> bool: "imwrite(filename, img[, params]) -> retval\n. @brief Saves an image to a specified file.\n. \n. The function imwrite saves the image to the specified file. The image format is chosen based on the\n. filename extension (see cv::imread for the list of extensions). In general, only 8-bit\n. single-channel or 3-channel (with 'BGR' channel order) images\n. can be saved using this function, with these exceptions:\n. \n. - 16-bit unsigned (CV_16U) images can be saved in the case of PNG, JPEG 2000, and TIFF formats\n. - 32-bit float (CV_32F) images can be saved in PFM, TIFF, OpenEXR, and Radiance HDR formats;\n. 3-channel (CV_32FC3) TIFF images will be saved using the LogLuv high dynamic range encoding\n. (4 bytes per pixel)\n. - PNG images with an alpha channel can be saved using this function. To do this, create\n. 8-bit (or 16-bit) 4-channel image BGRA, where the alpha channel goes last. Fully transparent pixels\n. should have alpha set to 0, fully opaque pixels should have alpha set to 255/65535 (see the code sample below).\n. - Multiple images (vector of Mat) can be saved in TIFF format (see the code sample below).\n. \n. If the format, depth or channel order is different, use\n. Mat::convertTo and cv::cvtColor to convert it before saving. Or, use the universal FileStorage I/O\n. functions to save the image to XML or YAML format.\n. \n. The sample below shows how to create a BGRA image, how to set custom compression parameters and save it to a PNG file.\n. It also demonstrates how to save multiple images in a TIFF file:\n. @include snippets/imgcodecs_imwrite.cpp\n. @param filename Name of the file.\n. @param img (Mat or vector of Mat) Image or Images to be saved.\n. @param params Format-specific parameters encoded as pairs (paramId_1, paramValue_1, paramId_2, paramValue_2, ... .) see cv::ImwriteFlags" ... - -def inRange(src: ndarray, lowerBound: ndarray, upperbBound: ndarray, dts: ndarray = ...) -> ndarray: +def inRange(src: Mat, lowerBound: Mat, upperbBound: Mat, dts: Mat = ...) -> Mat: 'inRange(src, lowerBound, upperbBound[, dst]) -> dst\n. @brief Checks if array elements lie between the elements of two other arrays.\n. \n. The function checks the range as follows:\n. - For every element of a single-channel input array:\n. \\f[\\texttt{dst} (I)= \\texttt{lowerBound} (I)_0 \\leq \\texttt{src} (I)_0 \\leq \\texttt{upperbBound} (I)_0\\f]\n. - For two-channel arrays:\n. \\f[\\texttt{dst} (I)= \\texttt{lowerBound} (I)_0 \\leq \\texttt{src} (I)_0 \\leq \\texttt{upperbBound} (I)_0 \\land \\texttt{lowerBound} (I)_1 \\leq \\texttt{src} (I)_1 \\leq \\texttt{upperbBound} (I)_1\\f]\n. - and so forth.\n. \n. That is, dst (I) is set to 255 (all 1 -bits) if src (I) is within the\n. specified 1D, 2D, 3D, ... box and 0 otherwise.\n. \n. When the lower and/or upper boundary parameters are scalars, the indexes\n. (I) at lowerBound and upperbBound in the above formulas should be omitted.\n. @param src first input array.\n. @param lowerBound inclusive lower boundary array or a scalar.\n. @param upperbBound inclusive upper boundary array or a scalar.\n. @param dst output array of the same size as src and CV_8U type.' ... - def initCameraMatrix2D(objectPoints, imagePoints, imageSize, aspectRatio=...) -> typing.Any: 'initCameraMatrix2D(objectPoints, imagePoints, imageSize[, aspectRatio]) -> retval\n. @brief Finds an initial camera matrix from 3D-2D point correspondences.\n. \n. @param objectPoints Vector of vectors of the calibration pattern points in the calibration pattern\n. coordinate space. In the old interface all the per-view vectors are concatenated. See\n. calibrateCamera for details.\n. @param imagePoints Vector of vectors of the projections of the calibration pattern points. In the\n. old interface all the per-view vectors are concatenated.\n. @param imageSize Image size in pixels used to initialize the principal point.\n. @param aspectRatio If it is zero or negative, both \\f$f_x\\f$ and \\f$f_y\\f$ are estimated independently.\n. Otherwise, \\f$f_x = f_y * \\texttt{aspectRatio}\\f$ .\n. \n. The function estimates and returns an initial camera matrix for the camera calibration process.\n. Currently, the function only supports planar calibration patterns, which are patterns where each\n. object point has z-coordinate =0.' ... - def initUndistortRectifyMap(cameraMatrix, distCoeffs, R, newCameraMatrix, size, m1type, map1=..., map2=...) -> typing.Any: "initUndistortRectifyMap(cameraMatrix, distCoeffs, R, newCameraMatrix, size, m1type[, map1[, map2]]) -> map1, map2\n. @brief Computes the undistortion and rectification transformation map.\n. \n. The function computes the joint undistortion and rectification transformation and represents the\n. result in the form of maps for remap. The undistorted image looks like original, as if it is\n. captured with a camera using the camera matrix =newCameraMatrix and zero distortion. In case of a\n. monocular camera, newCameraMatrix is usually equal to cameraMatrix, or it can be computed by\n. #getOptimalNewCameraMatrix for a better control over scaling. In case of a stereo camera,\n. newCameraMatrix is normally set to P1 or P2 computed by #stereoRectify .\n. \n. Also, this new camera is oriented differently in the coordinate space, according to R. That, for\n. example, helps to align two heads of a stereo camera so that the epipolar lines on both images\n. become horizontal and have the same y- coordinate (in case of a horizontally aligned stereo camera).\n. \n. The function actually builds the maps for the inverse mapping algorithm that is used by remap. That\n. is, for each pixel \\f$(u, v)\\f$ in the destination (corrected and rectified) image, the function\n. computes the corresponding coordinates in the source image (that is, in the original image from\n. camera). The following process is applied:\n. \\f[\n. \\begin{array}{l}\n. x \\leftarrow (u - {c'}_x)/{f'}_x \\\\\n. y \\leftarrow (v - {c'}_y)/{f'}_y \\\\\n. {[X\\,Y\\,W]} ^T \\leftarrow R^{-1}*[x \\, y \\, 1]^T \\\\\n. x' \\leftarrow X/W \\\\\n. y' \\leftarrow Y/W \\\\\n. r^2 \\leftarrow x'^2 + y'^2 \\\\\n. x'' \\leftarrow x' \\frac{1 + k_1 r^2 + k_2 r^4 + k_3 r^6}{1 + k_4 r^2 + k_5 r^4 + k_6 r^6}\n. + 2p_1 x' y' + p_2(r^2 + 2 x'^2) + s_1 r^2 + s_2 r^4\\\\\n. y'' \\leftarrow y' \\frac{1 + k_1 r^2 + k_2 r^4 + k_3 r^6}{1 + k_4 r^2 + k_5 r^4 + k_6 r^6}\n. + p_1 (r^2 + 2 y'^2) + 2 p_2 x' y' + s_3 r^2 + s_4 r^4 \\\\\n. s\\vecthree{x'''}{y'''}{1} =\n. \\vecthreethree{R_{33}(\\tau_x, \\tau_y)}{0}{-R_{13}((\\tau_x, \\tau_y)}\n. {0}{R_{33}(\\tau_x, \\tau_y)}{-R_{23}(\\tau_x, \\tau_y)}\n. {0}{0}{1} R(\\tau_x, \\tau_y) \\vecthree{x''}{y''}{1}\\\\\n. map_x(u,v) \\leftarrow x''' f_x + c_x \\\\\n. map_y(u,v) \\leftarrow y''' f_y + c_y\n. \\end{array}\n. \\f]\n. where \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6[, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$\n. are the distortion coefficients.\n. \n. In case of a stereo camera, this function is called twice: once for each camera head, after\n. stereoRectify, which in its turn is called after #stereoCalibrate. But if the stereo camera\n. was not calibrated, it is still possible to compute the rectification transformations directly from\n. the fundamental matrix using #stereoRectifyUncalibrated. For each camera, the function computes\n. homography H as the rectification transformation in a pixel domain, not a rotation matrix R in 3D\n. space. R can be computed from H as\n. \\f[\\texttt{R} = \\texttt{cameraMatrix} ^{-1} \\cdot \\texttt{H} \\cdot \\texttt{cameraMatrix}\\f]\n. where cameraMatrix can be chosen arbitrarily.\n. \n. @param cameraMatrix Input camera matrix \\f$A=\\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\\f$ .\n. @param distCoeffs Input vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6[, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$\n. of 4, 5, 8, 12 or 14 elements. If the vector is NULL/empty, the zero distortion coefficients are assumed.\n. @param R Optional rectification transformation in the object space (3x3 matrix). R1 or R2 ,\n. computed by #stereoRectify can be passed here. If the matrix is empty, the identity transformation\n. is assumed. In cvInitUndistortMap R assumed to be an identity matrix.\n. @param newCameraMatrix New camera matrix \\f$A'=\\vecthreethree{f_x'}{0}{c_x'}{0}{f_y'}{c_y'}{0}{0}{1}\\f$.\n. @param size Undistorted image size.\n. @param m1type Type of the first output map that can be CV_32FC1, CV_32FC2 or CV_16SC2, see #convertMaps\n. @param map1 The first output map.\n. @param map2 The second output map." ... - -def inpaint(src: ndarray, inpaintMask, inpaintRadius, flags: int, dts: ndarray = ...) -> typing.Any: +def inpaint(src: Mat, inpaintMask, inpaintRadius, flags: int, dts: Mat = ...) -> typing.Any: 'inpaint(src, inpaintMask, inpaintRadius, flags[, dst]) -> dst\n. @brief Restores the selected region in an image using the region neighborhood.\n. \n. @param src Input 8-bit, 16-bit unsigned or 32-bit float 1-channel or 8-bit 3-channel image.\n. @param inpaintMask Inpainting mask, 8-bit 1-channel image. Non-zero pixels indicate the area that\n. needs to be inpainted.\n. @param dst Output image with the same size and type as src .\n. @param inpaintRadius Radius of a circular neighborhood of each point inpainted that is considered\n. by the algorithm.\n. @param flags Inpainting method that could be cv::INPAINT_NS or cv::INPAINT_TELEA\n. \n. The function reconstructs the selected image area from the pixel near the area boundary. The\n. function may be used to remove dust and scratches from a scanned photo, or to remove undesirable\n. objects from still images or video. See for more details.\n. \n. @note\n. - An example using the inpainting technique can be found at\n. opencv_source_code/samples/cpp/inpaint.cpp\n. - (Python) An example using the inpainting technique can be found at\n. opencv_source_code/samples/python/inpaint.py' ... - -def insertChannel(src: ndarray, dts: ndarray, coi) -> typing.Any: +def insertChannel(src: Mat, dts: Mat, coi) -> typing.Any: 'insertChannel(src, dst, coi) -> dst\n. @brief Inserts a single channel to dst (coi is 0-based index)\n. @param src input array\n. @param dst output array\n. @param coi index of channel for insertion\n. @sa mixChannels, merge' ... - -def integral(src: ndarray, sum=..., sdepth=...) -> typing.Any: +def integral(src: Mat, sum=..., sdepth=...) -> typing.Any: 'integral(src[, sum[, sdepth]]) -> sum\n. @overload' ... - -def integral2(src: ndarray, sum=..., sqsum=..., sdepth=..., sqdepth=...) -> typing.Any: +def integral2(src: Mat, sum=..., sqsum=..., sdepth=..., sqdepth=...) -> typing.Any: 'integral2(src[, sum[, sqsum[, sdepth[, sqdepth]]]]) -> sum, sqsum\n. @overload' ... - -def integral3(src: ndarray, sum=..., sqsum=..., tilted=..., sdepth=..., sqdepth=...) -> typing.Any: +def integral3(src: Mat, sum=..., sqsum=..., tilted=..., sdepth=..., sqdepth=...) -> typing.Any: 'integral3(src[, sum[, sqsum[, tilted[, sdepth[, sqdepth]]]]]) -> sum, sqsum, tilted\n. @brief Calculates the integral of an image.\n. \n. The function calculates one or more integral images for the source image as follows:\n. \n. \\f[\\texttt{sum} (X,Y) = \\sum _{x typing.Any: "intersectConvexConvex(_p1, _p2[, _p12[, handleNested]]) -> retval, _p12\n. @brief Finds intersection of two convex polygons\n. \n. @param _p1 First polygon\n. @param _p2 Second polygon\n. @param _p12 Output polygon describing the intersecting area\n. @param handleNested When true, an intersection is found if one of the polygons is fully enclosed in the other.\n. When false, no intersection is found. If the polygons share a side or the vertex of one polygon lies on an edge\n. of the other, they are not considered nested and an intersection will be found regardless of the value of handleNested.\n. \n. @returns Absolute value of area of intersecting polygon\n. \n. @note intersectConvexConvex doesn't confirm that both polygons are convex and will return invalid results if they aren't." ... - -def invert(src: ndarray, dts: ndarray = ..., flags: int = ...) -> typing.Any: +def invert(src: Mat, dts: Mat = ..., flags: int = ...) -> typing.Any: 'invert(src[, dst[, flags]]) -> retval, dst\n. @brief Finds the inverse or pseudo-inverse of a matrix.\n. \n. The function cv::invert inverts the matrix src and stores the result in dst\n. . When the matrix src is singular or non-square, the function calculates\n. the pseudo-inverse matrix (the dst matrix) so that norm(src\\*dst - I) is\n. minimal, where I is an identity matrix.\n. \n. In case of the #DECOMP_LU method, the function returns non-zero value if\n. the inverse has been successfully calculated and 0 if src is singular.\n. \n. In case of the #DECOMP_SVD method, the function returns the inverse\n. condition number of src (the ratio of the smallest singular value to the\n. largest singular value) and 0 if src is singular. The SVD method\n. calculates a pseudo-inverse matrix if src is singular.\n. \n. Similarly to #DECOMP_LU, the method #DECOMP_CHOLESKY works only with\n. non-singular square matrices that should also be symmetrical and\n. positively defined. In this case, the function stores the inverted\n. matrix in dst and returns non-zero. Otherwise, it returns 0.\n. \n. @param src input floating-point M x N matrix.\n. @param dst output matrix of N x M size and the same type as src.\n. @param flags inversion method (cv::DecompTypes)\n. @sa solve, SVD' ... - def invertAffineTransform(M, iM=...) -> typing.Any: 'invertAffineTransform(M[, iM]) -> iM\n. @brief Inverts an affine transformation.\n. \n. The function computes an inverse affine transformation represented by \\f$2 \\times 3\\f$ matrix M:\n. \n. \\f[\\begin{bmatrix} a_{11} & a_{12} & b_1 \\\\ a_{21} & a_{22} & b_2 \\end{bmatrix}\\f]\n. \n. The result is also a \\f$2 \\times 3\\f$ matrix of the same type as M.\n. \n. @param M Original affine transformation.\n. @param iM Output reverse affine transformation.' ... - def isContourConvex(contour) -> typing.Any: 'isContourConvex(contour) -> retval\n. @brief Tests a contour convexity.\n. \n. The function tests whether the input contour is convex or not. The contour must be simple, that is,\n. without self-intersections. Otherwise, the function output is undefined.\n. \n. @param contour Input vector of 2D points, stored in std::vector\\<\\> or Mat' ... - def kmeans(data, K, bestLabels, criteria, attempts, flags: int, centers=...) -> typing.Any: 'kmeans(data, K, bestLabels, criteria, attempts, flags[, centers]) -> retval, bestLabels, centers\n. @brief Finds centers of clusters and groups input samples around the clusters.\n. \n. The function kmeans implements a k-means algorithm that finds the centers of cluster_count clusters\n. and groups the input samples around the clusters. As an output, \\f$\\texttt{bestLabels}_i\\f$ contains a\n. 0-based cluster index for the sample stored in the \\f$i^{th}\\f$ row of the samples matrix.\n. \n. @note\n. - (Python) An example on K-means clustering can be found at\n. opencv_source_code/samples/python/kmeans.py\n. @param data Data for clustering. An array of N-Dimensional points with float coordinates is needed.\n. Examples of this array can be:\n. - Mat points(count, 2, CV_32F);\n. - Mat points(count, 1, CV_32FC2);\n. - Mat points(1, count, CV_32FC2);\n. - std::vector\\ points(sampleCount);\n. @param K Number of clusters to split the set by.\n. @param bestLabels Input/output integer array that stores the cluster indices for every sample.\n. @param criteria The algorithm termination criteria, that is, the maximum number of iterations and/or\n. the desired accuracy. The accuracy is specified as criteria.epsilon. As soon as each of the cluster\n. centers moves by less than criteria.epsilon on some iteration, the algorithm stops.\n. @param attempts Flag to specify the number of times the algorithm is executed using different\n. initial labellings. The algorithm returns the labels that yield the best compactness (see the last\n. function parameter).\n. @param flags Flag that can take values of cv::KmeansFlags\n. @param centers Output matrix of the cluster centers, one row per each cluster center.\n. @return The function returns the compactness measure that is computed as\n. \\f[\\sum _i \\| \\texttt{samples} _i - \\texttt{centers} _{ \\texttt{labels} _i} \\| ^2\\f]\n. after every attempt. The best (minimum) value is chosen and the corresponding labels and the\n. compactness value are returned by the function. Basically, you can use only the core of the\n. function, set the number of attempts to 1, initialize labels each time using a custom algorithm,\n. pass them with the ( flags = #KMEANS_USE_INITIAL_LABELS ) flag, and then choose the best\n. (most-compact) clustering.' ... - -def line(img: ndarray, pt1, pt2, color, thickness=..., lineType=..., shift=...) -> typing.Any: +def line(img: Mat, pt1, pt2, color, thickness=..., lineType=..., shift=...) -> typing.Any: 'line(img, pt1, pt2, color[, thickness[, lineType[, shift]]]) -> img\n. @brief Draws a line segment connecting two points.\n. \n. The function line draws the line segment between pt1 and pt2 points in the image. The line is\n. clipped by the image boundaries. For non-antialiased lines with integer coordinates, the 8-connected\n. or 4-connected Bresenham algorithm is used. Thick lines are drawn with rounding endings. Antialiased\n. lines are drawn using Gaussian filtering.\n. \n. @param img Image.\n. @param pt1 First point of the line segment.\n. @param pt2 Second point of the line segment.\n. @param color Line color.\n. @param thickness Line thickness.\n. @param lineType Type of the line. See #LineTypes.\n. @param shift Number of fractional bits in the point coordinates.' ... - -def linearPolar(src: ndarray, center, maxRadius, flags: int, dts: ndarray = ...) -> typing.Any: +def linearPolar(src: Mat, center, maxRadius, flags: int, dts: Mat = ...) -> typing.Any: 'linearPolar(src, center, maxRadius, flags[, dst]) -> dst\n. @brief Remaps an image to polar coordinates space.\n. \n. @deprecated This function produces same result as cv::warpPolar(src, dst, src.size(), center, maxRadius, flags)\n. \n. @internal\n. Transform the source image using the following transformation (See @ref polar_remaps_reference_image "Polar remaps reference image c)"):\n. \\f[\\begin{array}{l}\n. dst( \\rho , \\phi ) = src(x,y) \\\\\n. dst.size() \\leftarrow src.size()\n. \\end{array}\\f]\n. \n. where\n. \\f[\\begin{array}{l}\n. I = (dx,dy) = (x - center.x,y - center.y) \\\\\n. \\rho = Kmag \\cdot \\texttt{magnitude} (I) ,\\\\\n. \\phi = angle \\cdot \\texttt{angle} (I)\n. \\end{array}\\f]\n. \n. and\n. \\f[\\begin{array}{l}\n. Kx = src.cols / maxRadius \\\\\n. Ky = src.rows / 2\\Pi\n. \\end{array}\\f]\n. \n. \n. @param src Source image\n. @param dst Destination image. It will have same size and type as src.\n. @param center The transformation center;\n. @param maxRadius The radius of the bounding circle to transform. It determines the inverse magnitude scale parameter too.\n. @param flags A combination of interpolation methods, see #InterpolationFlags\n. \n. @note\n. - The function can not operate in-place.\n. - To calculate magnitude and angle in degrees #cartToPolar is used internally thus angles are measured from 0 to 360 with accuracy about 0.3 degrees.\n. \n. @sa cv::logPolar\n. @endinternal' ... - -def log(src: ndarray, dts: ndarray = ...) -> typing.Any: +def log(src: Mat, dts: Mat = ...) -> typing.Any: 'log(src[, dst]) -> dst\n. @brief Calculates the natural logarithm of every array element.\n. \n. The function cv::log calculates the natural logarithm of every element of the input array:\n. \\f[\\texttt{dst} (I) = \\log (\\texttt{src}(I)) \\f]\n. \n. Output on zero, negative and special (NaN, Inf) values is undefined.\n. \n. @param src input array.\n. @param dst output array of the same size and type as src .\n. @sa exp, cartToPolar, polarToCart, phase, pow, sqrt, magnitude' ... - -def logPolar(src: ndarray, center, M, flags: int, dts: ndarray = ...) -> typing.Any: +def logPolar(src: Mat, center, M, flags: int, dts: Mat = ...) -> typing.Any: 'logPolar(src, center, M, flags[, dst]) -> dst\n. @brief Remaps an image to semilog-polar coordinates space.\n. \n. @deprecated This function produces same result as cv::warpPolar(src, dst, src.size(), center, maxRadius, flags+WARP_POLAR_LOG);\n. \n. @internal\n. Transform the source image using the following transformation (See @ref polar_remaps_reference_image "Polar remaps reference image d)"):\n. \\f[\\begin{array}{l}\n. dst( \\rho , \\phi ) = src(x,y) \\\\\n. dst.size() \\leftarrow src.size()\n. \\end{array}\\f]\n. \n. where\n. \\f[\\begin{array}{l}\n. I = (dx,dy) = (x - center.x,y - center.y) \\\\\n. \\rho = M \\cdot log_e(\\texttt{magnitude} (I)) ,\\\\\n. \\phi = Kangle \\cdot \\texttt{angle} (I) \\\\\n. \\end{array}\\f]\n. \n. and\n. \\f[\\begin{array}{l}\n. M = src.cols / log_e(maxRadius) \\\\\n. Kangle = src.rows / 2\\Pi \\\\\n. \\end{array}\\f]\n. \n. The function emulates the human "foveal" vision and can be used for fast scale and\n. rotation-invariant template matching, for object tracking and so forth.\n. @param src Source image\n. @param dst Destination image. It will have same size and type as src.\n. @param center The transformation center; where the output precision is maximal\n. @param M Magnitude scale parameter. It determines the radius of the bounding circle to transform too.\n. @param flags A combination of interpolation methods, see #InterpolationFlags\n. \n. @note\n. - The function can not operate in-place.\n. - To calculate magnitude and angle in degrees #cartToPolar is used internally thus angles are measured from 0 to 360 with accuracy about 0.3 degrees.\n. \n. @sa cv::linearPolar\n. @endinternal' ... - def magnitude(x, y, magnitude=...) -> typing.Any: 'magnitude(x, y[, magnitude]) -> magnitude\n. @brief Calculates the magnitude of 2D vectors.\n. \n. The function cv::magnitude calculates the magnitude of 2D vectors formed\n. from the corresponding elements of x and y arrays:\n. \\f[\\texttt{dst} (I) = \\sqrt{\\texttt{x}(I)^2 + \\texttt{y}(I)^2}\\f]\n. @param x floating-point array of x-coordinates of the vectors.\n. @param y floating-point array of y-coordinates of the vectors; it must\n. have the same size as x.\n. @param magnitude output array of the same size and type as x.\n. @sa cartToPolar, polarToCart, phase, sqrt' ... - def matMulDeriv(A, B, dABdA=..., dABdB=...) -> typing.Any: 'matMulDeriv(A, B[, dABdA[, dABdB]]) -> dABdA, dABdB\n. @brief Computes partial derivatives of the matrix product for each multiplied matrix.\n. \n. @param A First multiplied matrix.\n. @param B Second multiplied matrix.\n. @param dABdA First output derivative matrix d(A\\*B)/dA of size\n. \\f$\\texttt{A.rows*B.cols} \\times {A.rows*A.cols}\\f$ .\n. @param dABdB Second output derivative matrix d(A\\*B)/dB of size\n. \\f$\\texttt{A.rows*B.cols} \\times {B.rows*B.cols}\\f$ .\n. \n. The function computes partial derivatives of the elements of the matrix product \\f$A*B\\f$ with regard to\n. the elements of each of the two input matrices. The function is used to compute the Jacobian\n. matrices in stereoCalibrate but can also be used in any other similar optimization function.' ... - def matchShapes(contour1, contour2, method: int, parameter) -> typing.Any: 'matchShapes(contour1, contour2, method, parameter) -> retval\n. @brief Compares two shapes.\n. \n. The function compares two shapes. All three implemented methods use the Hu invariants (see #HuMoments)\n. \n. @param contour1 First contour or grayscale image.\n. @param contour2 Second contour or grayscale image.\n. @param method Comparison method, see #ShapeMatchModes\n. @param parameter Method-specific parameter (not supported now).' ... - -def matchTemplate(image: ndarray, templ: ndarray, method: int, result: ndarray = ..., mask: typing.Optional[ndarray] = ...) -> ndarray: +def matchTemplate(image: Mat, templ: Mat, method: int, result: Mat = ..., mask: typing.Optional[Mat] = ...) -> Mat: "matchTemplate(image, templ, method[, result[, mask]]) -> result\n. @brief Compares a template against overlapped image regions.\n. \n. The function slides through image , compares the overlapped patches of size \\f$w \\times h\\f$ against\n. templ using the specified method and stores the comparison results in result . #TemplateMatchModes\n. describes the formulae for the available comparison methods ( \\f$I\\f$ denotes image, \\f$T\\f$\n. template, \\f$R\\f$ result, \\f$M\\f$ the optional mask ). The summation is done over template and/or\n. the image patch: \\f$x' = 0...w-1, y' = 0...h-1\\f$\n. \n. After the function finishes the comparison, the best matches can be found as global minimums (when\n. #TM_SQDIFF was used) or maximums (when #TM_CCORR or #TM_CCOEFF was used) using the\n. #minMaxLoc function. In case of a color image, template summation in the numerator and each sum in\n. the denominator is done over all of the channels and separate mean values are used for each channel.\n. That is, the function can take a color template and a color image. The result will still be a\n. single-channel image, which is easier to analyze.\n. \n. @param image Image where the search is running. It must be 8-bit or 32-bit floating-point.\n. @param templ Searched template. It must be not greater than the source image and have the same\n. data type.\n. @param result Map of comparison results. It must be single-channel 32-bit floating-point. If image\n. is \\f$W \\times H\\f$ and templ is \\f$w \\times h\\f$ , then result is \\f$(W-w+1) \\times (H-h+1)\\f$ .\n. @param method Parameter specifying the comparison method, see #TemplateMatchModes\n. @param mask Optional mask. It must have the same size as templ. It must either have the same number\n. of channels as template or only one channel, which is then used for all template and\n. image channels. If the data type is #CV_8U, the mask is interpreted as a binary mask,\n. meaning only elements where mask is nonzero are used and are kept unchanged independent\n. of the actual mask value (weight equals 1). For data tpye #CV_32F, the mask values are\n. used as weights. The exact formulas are documented in #TemplateMatchModes." ... - -def max(src1: ndarray, src2: ndarray, dts: ndarray = ...) -> typing.Any: +def max(src1: Mat, src2: Mat, dts: Mat = ...) -> typing.Any: 'max(src1, src2[, dst]) -> dst\n. @brief Calculates per-element maximum of two arrays or an array and a scalar.\n. \n. The function cv::max calculates the per-element maximum of two arrays:\n. \\f[\\texttt{dst} (I)= \\max ( \\texttt{src1} (I), \\texttt{src2} (I))\\f]\n. or array and a scalar:\n. \\f[\\texttt{dst} (I)= \\max ( \\texttt{src1} (I), \\texttt{value} )\\f]\n. @param src1 first input array.\n. @param src2 second input array of the same size and type as src1 .\n. @param dst output array of the same size and type as src1.\n. @sa min, compare, inRange, minMaxLoc, @ref MatrixExpressions' ... - -def mean(src: ndarray, mask: ndarray = ...) -> typing.Any: +def mean(src: Mat, mask: Mat = ...) -> typing.Any: "mean(src[, mask]) -> retval\n. @brief Calculates an average (mean) of array elements.\n. \n. The function cv::mean calculates the mean value M of array elements,\n. independently for each channel, and return it:\n. \\f[\\begin{array}{l} N = \\sum _{I: \\; \\texttt{mask} (I) \\ne 0} 1 \\\\ M_c = \\left ( \\sum _{I: \\; \\texttt{mask} (I) \\ne 0}{ \\texttt{mtx} (I)_c} \\right )/N \\end{array}\\f]\n. When all the mask elements are 0's, the function returns Scalar::all(0)\n. @param src input array that should have from 1 to 4 channels so that the result can be stored in\n. Scalar_ .\n. @param mask optional operation mask.\n. @sa countNonZero, meanStdDev, norm, minMaxLoc" ... - def meanShift(probImage, window, criteria) -> typing.Any: 'meanShift(probImage, window, criteria) -> retval, window\n. @brief Finds an object on a back projection image.\n. \n. @param probImage Back projection of the object histogram. See calcBackProject for details.\n. @param window Initial search window.\n. @param criteria Stop criteria for the iterative search algorithm.\n. returns\n. : Number of iterations CAMSHIFT took to converge.\n. The function implements the iterative object search algorithm. It takes the input back projection of\n. an object and the initial position. The mass center in window of the back projection image is\n. computed and the search window center shifts to the mass center. The procedure is repeated until the\n. specified number of iterations criteria.maxCount is done or until the window center shifts by less\n. than criteria.epsilon. The algorithm is used inside CamShift and, unlike CamShift , the search\n. window size or orientation do not change during the search. You can simply pass the output of\n. calcBackProject to this function. But better results can be obtained if you pre-filter the back\n. projection and remove the noise. For example, you can do this by retrieving connected components\n. with findContours , throwing away contours with small area ( contourArea ), and rendering the\n. remaining contours with drawContours.' ... - -def meanStdDev(src: ndarray, mean=..., stddev=..., mask: ndarray = ...) -> typing.Any: +def meanStdDev(src: Mat, mean=..., stddev=..., mask: Mat = ...) -> typing.Any: "meanStdDev(src[, mean[, stddev[, mask]]]) -> mean, stddev\n. Calculates a mean and standard deviation of array elements.\n. \n. The function cv::meanStdDev calculates the mean and the standard deviation M\n. of array elements independently for each channel and returns it via the\n. output parameters:\n. \\f[\\begin{array}{l} N = \\sum _{I, \\texttt{mask} (I) \\ne 0} 1 \\\\ \\texttt{mean} _c = \\frac{\\sum_{ I: \\; \\texttt{mask}(I) \\ne 0} \\texttt{src} (I)_c}{N} \\\\ \\texttt{stddev} _c = \\sqrt{\\frac{\\sum_{ I: \\; \\texttt{mask}(I) \\ne 0} \\left ( \\texttt{src} (I)_c - \\texttt{mean} _c \\right )^2}{N}} \\end{array}\\f]\n. When all the mask elements are 0's, the function returns\n. mean=stddev=Scalar::all(0).\n. @note The calculated standard deviation is only the diagonal of the\n. complete normalized covariance matrix. If the full matrix is needed, you\n. can reshape the multi-channel array M x N to the single-channel array\n. M\\*N x mtx.channels() (only possible when the matrix is continuous) and\n. then pass the matrix to calcCovarMatrix .\n. @param src input array that should have from 1 to 4 channels so that the results can be stored in\n. Scalar_ 's.\n. @param mean output parameter: calculated mean value.\n. @param stddev output parameter: calculated standard deviation.\n. @param mask optional operation mask.\n. @sa countNonZero, mean, norm, minMaxLoc, calcCovarMatrix" ... - -def medianBlur(src: ndarray, ksize, dts: ndarray = ...) -> typing.Any: +def medianBlur(src: Mat, ksize, dts: Mat = ...) -> typing.Any: 'medianBlur(src, ksize[, dst]) -> dst\n. @brief Blurs an image using the median filter.\n. \n. The function smoothes an image using the median filter with the \\f$\\texttt{ksize} \\times\n. \\texttt{ksize}\\f$ aperture. Each channel of a multi-channel image is processed independently.\n. In-place operation is supported.\n. \n. @note The median filter uses #BORDER_REPLICATE internally to cope with border pixels, see #BorderTypes\n. \n. @param src input 1-, 3-, or 4-channel image; when ksize is 3 or 5, the image depth should be\n. CV_8U, CV_16U, or CV_32F, for larger aperture sizes, it can only be CV_8U.\n. @param dst destination array of the same size and type as src.\n. @param ksize aperture linear size; it must be odd and greater than 1, for example: 3, 5, 7 ...\n. @sa bilateralFilter, blur, boxFilter, GaussianBlur' ... - -def merge(mv, dts: ndarray = ...) -> typing.Any: +def merge(mv, dts: Mat = ...) -> typing.Any: 'merge(mv[, dst]) -> dst\n. @overload\n. @param mv input vector of matrices to be merged; all the matrices in mv must have the same\n. size and the same depth.\n. @param dst output array of the same size and the same depth as mv[0]; The number of channels will\n. be the total number of channels in the matrix array.' ... - -def min(src1: ndarray, src2: ndarray, dts: ndarray = ...) -> typing.Any: +def min(src1: Mat, src2: Mat, dts: Mat = ...) -> typing.Any: 'min(src1, src2[, dst]) -> dst\n. @brief Calculates per-element minimum of two arrays or an array and a scalar.\n. \n. The function cv::min calculates the per-element minimum of two arrays:\n. \\f[\\texttt{dst} (I)= \\min ( \\texttt{src1} (I), \\texttt{src2} (I))\\f]\n. or array and a scalar:\n. \\f[\\texttt{dst} (I)= \\min ( \\texttt{src1} (I), \\texttt{value} )\\f]\n. @param src1 first input array.\n. @param src2 second input array of the same size and type as src1.\n. @param dst output array of the same size and type as src1.\n. @sa max, compare, inRange, minMaxLoc' ... - def minAreaRect(points) -> typing.Any: 'minAreaRect(points) -> retval\n. @brief Finds a rotated rectangle of the minimum area enclosing the input 2D point set.\n. \n. The function calculates and returns the minimum-area bounding rectangle (possibly rotated) for a\n. specified point set. Developer should keep in mind that the returned RotatedRect can contain negative\n. indices when data is close to the containing Mat element boundary.\n. \n. @param points Input vector of 2D points, stored in std::vector\\<\\> or Mat' ... - def minEnclosingCircle(points) -> typing.Any: 'minEnclosingCircle(points) -> center, radius\n. @brief Finds a circle of the minimum area enclosing a 2D point set.\n. \n. The function finds the minimal enclosing circle of a 2D point set using an iterative algorithm.\n. \n. @param points Input vector of 2D points, stored in std::vector\\<\\> or Mat\n. @param center Output center of the circle.\n. @param radius Output radius of the circle.' ... - def minEnclosingTriangle(points, triangle=...) -> typing.Any: "minEnclosingTriangle(points[, triangle]) -> retval, triangle\n. @brief Finds a triangle of minimum area enclosing a 2D point set and returns its area.\n. \n. The function finds a triangle of minimum area enclosing the given set of 2D points and returns its\n. area. The output for a given 2D point set is shown in the image below. 2D points are depicted in\n. *red* and the enclosing triangle in *yellow*.\n. \n. ![Sample output of the minimum enclosing triangle function](pics/minenclosingtriangle.png)\n. \n. The implementation of the algorithm is based on O'Rourke's @cite ORourke86 and Klee and Laskowski's\n. @cite KleeLaskowski85 papers. O'Rourke provides a \\f$\\theta(n)\\f$ algorithm for finding the minimal\n. enclosing triangle of a 2D convex polygon with n vertices. Since the #minEnclosingTriangle function\n. takes a 2D point set as input an additional preprocessing step of computing the convex hull of the\n. 2D point set is required. The complexity of the #convexHull function is \\f$O(n log(n))\\f$ which is higher\n. than \\f$\\theta(n)\\f$. Thus the overall complexity of the function is \\f$O(n log(n))\\f$.\n. \n. @param points Input vector of 2D points with depth CV_32S or CV_32F, stored in std::vector\\<\\> or Mat\n. @param triangle Output vector of three 2D points defining the vertices of the triangle. The depth\n. of the OutputArray must be CV_32F." ... - -def minMaxLoc(src: ndarray, mask: ndarray = ...) -> tuple[float, float, tuple[int, int], tuple[int, int]]: +def minMaxLoc(src: Mat, mask: Mat = ...) -> typing.Tuple[float, float, typing.Tuple[int, int], typing.Tuple[int, int]]: 'minMaxLoc(src[, mask]) -> minVal, maxVal, minLoc, maxLoc\n. @brief Finds the global minimum and maximum in an array.\n. \n. The function cv::minMaxLoc finds the minimum and maximum element values and their positions. The\n. extremums are searched across the whole array or, if mask is not an empty array, in the specified\n. array region.\n. \n. The function do not work with multi-channel arrays. If you need to find minimum or maximum\n. elements across all the channels, use Mat::reshape first to reinterpret the array as\n. single-channel. Or you may extract the particular channel using either extractImageCOI , or\n. mixChannels , or split .\n. @param src input single-channel array.\n. @param minVal pointer to the returned minimum value; NULL is used if not required.\n. @param maxVal pointer to the returned maximum value; NULL is used if not required.\n. @param minLoc pointer to the returned minimum location (in 2D case); NULL is used if not required.\n. @param maxLoc pointer to the returned maximum location (in 2D case); NULL is used if not required.\n. @param mask optional mask used to select a sub-array.\n. @sa max, min, compare, inRange, extractImageCOI, mixChannels, split, Mat::reshape' ... - -def mixChannels(src: ndarray, dts: ndarray, fromTo) -> typing.Any: +def mixChannels(src: Mat, dts: Mat, fromTo) -> typing.Any: 'mixChannels(src, dst, fromTo) -> dst\n. @overload\n. @param src input array or vector of matrices; all of the matrices must have the same size and the\n. same depth.\n. @param dst output array or vector of matrices; all the matrices **must be allocated**; their size and\n. depth must be the same as in src[0].\n. @param fromTo array of index pairs specifying which channels are copied and where; fromTo[k\\*2] is\n. a 0-based index of the input channel in src, fromTo[k\\*2+1] is an index of the output channel in\n. dst; the continuous channel numbering is used: the first input image channels are indexed from 0 to\n. src[0].channels()-1, the second input image channels are indexed from src[0].channels() to\n. src[0].channels() + src[1].channels()-1, and so on, the same scheme is used for the output image\n. channels; as a special case, when fromTo[k\\*2] is negative, the corresponding output channel is\n. filled with zero .' ... - ml_ANN_MLP = _mod_cv2.ml_ANN_MLP ml_Boost = _mod_cv2.ml_Boost ml_DTrees = _mod_cv2.ml_DTrees @@ -3064,515 +2693,409 @@ ml_SVM = _mod_cv2.ml_SVM ml_SVMSGD = _mod_cv2.ml_SVMSGD ml_StatModel = _mod_cv2.ml_StatModel ml_TrainData = _mod_cv2.ml_TrainData - - def moments(array, binaryImage=...) -> typing.Any: "moments(array[, binaryImage]) -> retval\n. @brief Calculates all of the moments up to the third order of a polygon or rasterized shape.\n. \n. The function computes moments, up to the 3rd order, of a vector shape or a rasterized shape. The\n. results are returned in the structure cv::Moments.\n. \n. @param array Raster image (single-channel, 8-bit or floating-point 2D array) or an array (\n. \\f$1 \\times N\\f$ or \\f$N \\times 1\\f$ ) of 2D points (Point or Point2f ).\n. @param binaryImage If it is true, all non-zero image pixels are treated as 1's. The parameter is\n. used for images only.\n. @returns moments.\n. \n. @note Only applicable to contour moments calculations from Python bindings: Note that the numpy\n. type for the input array should be either np.int32 or np.float32.\n. \n. @sa contourArea, arcLength" ... - -def morphologyEx(src: ndarray, op, kernel, dts: ndarray = ..., anchor=..., iterations=..., borderType=..., borderValue=...) -> typing.Any: +def morphologyEx(src: Mat, op, kernel, dts: Mat = ..., anchor=..., iterations=..., borderType=..., borderValue=...) -> typing.Any: 'morphologyEx(src, op, kernel[, dst[, anchor[, iterations[, borderType[, borderValue]]]]]) -> dst\n. @brief Performs advanced morphological transformations.\n. \n. The function cv::morphologyEx can perform advanced morphological transformations using an erosion and dilation as\n. basic operations.\n. \n. Any of the operations can be done in-place. In case of multi-channel images, each channel is\n. processed independently.\n. \n. @param src Source image. The number of channels can be arbitrary. The depth should be one of\n. CV_8U, CV_16U, CV_16S, CV_32F or CV_64F.\n. @param dst Destination image of the same size and type as source image.\n. @param op Type of a morphological operation, see #MorphTypes\n. @param kernel Structuring element. It can be created using #getStructuringElement.\n. @param anchor Anchor position with the kernel. Negative values mean that the anchor is at the\n. kernel center.\n. @param iterations Number of times erosion and dilation are applied.\n. @param borderType Pixel extrapolation method, see #BorderTypes. #BORDER_WRAP is not supported.\n. @param borderValue Border value in case of a constant border. The default value has a special\n. meaning.\n. @sa dilate, erode, getStructuringElement\n. @note The number of iterations is the number of times erosion or dilatation operation will be applied.\n. For instance, an opening operation (#MORPH_OPEN) with two iterations is equivalent to apply\n. successively: erode -> erode -> dilate -> dilate (and not erode -> dilate -> erode -> dilate).' ... - def moveWindow(winname, x, y) -> typing.Any: 'moveWindow(winname, x, y) -> None\n. @brief Moves window to the specified position\n. \n. @param winname Name of the window.\n. @param x The new x-coordinate of the window.\n. @param y The new y-coordinate of the window.' ... - def mulSpectrums(a, b, flags: int, c=..., conjB=...) -> typing.Any: 'mulSpectrums(a, b, flags[, c[, conjB]]) -> c\n. @brief Performs the per-element multiplication of two Fourier spectrums.\n. \n. The function cv::mulSpectrums performs the per-element multiplication of the two CCS-packed or complex\n. matrices that are results of a real or complex Fourier transform.\n. \n. The function, together with dft and idft , may be used to calculate convolution (pass conjB=false )\n. or correlation (pass conjB=true ) of two arrays rapidly. When the arrays are complex, they are\n. simply multiplied (per element) with an optional conjugation of the second-array elements. When the\n. arrays are real, they are assumed to be CCS-packed (see dft for details).\n. @param a first input array.\n. @param b second input array of the same size and type as src1 .\n. @param c output array of the same size and type as src1 .\n. @param flags operation flags; currently, the only supported flag is cv::DFT_ROWS, which indicates that\n. each row of src1 and src2 is an independent 1D Fourier spectrum. If you do not want to use this flag, then simply add a `0` as value.\n. @param conjB optional flag that conjugates the second input array before the multiplication (true)\n. or not (false).' ... - -def mulTransposed(src: ndarray, aTa, dts: ndarray = ..., delta=..., scale=..., dtype=...) -> typing.Any: +def mulTransposed(src: Mat, aTa, dts: Mat = ..., delta=..., scale=..., dtype=...) -> typing.Any: 'mulTransposed(src, aTa[, dst[, delta[, scale[, dtype]]]]) -> dst\n. @brief Calculates the product of a matrix and its transposition.\n. \n. The function cv::mulTransposed calculates the product of src and its\n. transposition:\n. \\f[\\texttt{dst} = \\texttt{scale} ( \\texttt{src} - \\texttt{delta} )^T ( \\texttt{src} - \\texttt{delta} )\\f]\n. if aTa=true , and\n. \\f[\\texttt{dst} = \\texttt{scale} ( \\texttt{src} - \\texttt{delta} ) ( \\texttt{src} - \\texttt{delta} )^T\\f]\n. otherwise. The function is used to calculate the covariance matrix. With\n. zero delta, it can be used as a faster substitute for general matrix\n. product A\\*B when B=A\'\n. @param src input single-channel matrix. Note that unlike gemm, the\n. function can multiply not only floating-point matrices.\n. @param dst output square matrix.\n. @param aTa Flag specifying the multiplication ordering. See the\n. description below.\n. @param delta Optional delta matrix subtracted from src before the\n. multiplication. When the matrix is empty ( delta=noArray() ), it is\n. assumed to be zero, that is, nothing is subtracted. If it has the same\n. size as src , it is simply subtracted. Otherwise, it is "repeated" (see\n. repeat ) to cover the full src and then subtracted. Type of the delta\n. matrix, when it is not empty, must be the same as the type of created\n. output matrix. See the dtype parameter description below.\n. @param scale Optional scale factor for the matrix product.\n. @param dtype Optional type of the output matrix. When it is negative,\n. the output matrix will have the same type as src . Otherwise, it will be\n. type=CV_MAT_DEPTH(dtype) that should be either CV_32F or CV_64F .\n. @sa calcCovarMatrix, gemm, repeat, reduce' ... - -def multiply(src1: ndarray, src2: ndarray, dts: ndarray = ..., scale=..., dtype=...) -> typing.Any: +def multiply(src1: Mat, src2: Mat, dts: Mat = ..., scale=..., dtype=...) -> typing.Any: 'multiply(src1, src2[, dst[, scale[, dtype]]]) -> dst\n. @brief Calculates the per-element scaled product of two arrays.\n. \n. The function multiply calculates the per-element product of two arrays:\n. \n. \\f[\\texttt{dst} (I)= \\texttt{saturate} ( \\texttt{scale} \\cdot \\texttt{src1} (I) \\cdot \\texttt{src2} (I))\\f]\n. \n. There is also a @ref MatrixExpressions -friendly variant of the first function. See Mat::mul .\n. \n. For a not-per-element matrix product, see gemm .\n. \n. @note Saturation is not applied when the output array has the depth\n. CV_32S. You may even get result of an incorrect sign in the case of\n. overflow.\n. @param src1 first input array.\n. @param src2 second input array of the same size and the same type as src1.\n. @param dst output array of the same size and type as src1.\n. @param scale optional scale factor.\n. @param dtype optional depth of the output array\n. @sa add, subtract, divide, scaleAdd, addWeighted, accumulate, accumulateProduct, accumulateSquare,\n. Mat::convertTo' ... - def namedWindow(winname, flags: int = ...) -> typing.Any: 'namedWindow(winname[, flags]) -> None\n. @brief Creates a window.\n. \n. The function namedWindow creates a window that can be used as a placeholder for images and\n. trackbars. Created windows are referred to by their names.\n. \n. If a window with the same name already exists, the function does nothing.\n. \n. You can call cv::destroyWindow or cv::destroyAllWindows to close the window and de-allocate any associated\n. memory usage. For a simple program, you do not really have to call these functions because all the\n. resources and windows of the application are closed automatically by the operating system upon exit.\n. \n. @note\n. \n. Qt backend supports additional flags:\n. - **WINDOW_NORMAL or WINDOW_AUTOSIZE:** WINDOW_NORMAL enables you to resize the\n. window, whereas WINDOW_AUTOSIZE adjusts automatically the window size to fit the\n. displayed image (see imshow ), and you cannot change the window size manually.\n. - **WINDOW_FREERATIO or WINDOW_KEEPRATIO:** WINDOW_FREERATIO adjusts the image\n. with no respect to its ratio, whereas WINDOW_KEEPRATIO keeps the image ratio.\n. - **WINDOW_GUI_NORMAL or WINDOW_GUI_EXPANDED:** WINDOW_GUI_NORMAL is the old way to draw the window\n. without statusbar and toolbar, whereas WINDOW_GUI_EXPANDED is a new enhanced GUI.\n. By default, flags == WINDOW_AUTOSIZE | WINDOW_KEEPRATIO | WINDOW_GUI_EXPANDED\n. \n. @param winname Name of the window in the window caption that may be used as a window identifier.\n. @param flags Flags of the window. The supported flags are: (cv::WindowFlags)' ... - -def norm(src1: ndarray, src2: ndarray, normType: int = ..., mask: ndarray = ...) -> float: +def norm(src1: Mat, src2: Mat, normType: int = ..., mask: typing.Optional[Mat] = ...) -> float: 'norm(src1, src2[, normType[, mask]]) -> retval\n. @brief Calculates the absolute norm of an array.\n. \n. This version of #norm calculates the absolute norm of src1. The type of norm to calculate is specified using #NormTypes.\n. \n. As example for one array consider the function \\f$r(x)= \\begin{pmatrix} x \\\\ 1-x \\end{pmatrix}, x \\in [-1;1]\\f$.\n. The \\f$ L_{1}, L_{2} \\f$ and \\f$ L_{\\infty} \\f$ norm for the sample value \\f$r(-1) = \\begin{pmatrix} -1 \\\\ 2 \\end{pmatrix}\\f$\n. is calculated as follows\n. \\f{align*}\n. \\| r(-1) \\|_{L_1} &= |-1| + |2| = 3 \\\\\n. \\| r(-1) \\|_{L_2} &= \\sqrt{(-1)^{2} + (2)^{2}} = \\sqrt{5} \\\\\n. \\| r(-1) \\|_{L_\\infty} &= \\max(|-1|,|2|) = 2\n. \\f}\n. and for \\f$r(0.5) = \\begin{pmatrix} 0.5 \\\\ 0.5 \\end{pmatrix}\\f$ the calculation is\n. \\f{align*}\n. \\| r(0.5) \\|_{L_1} &= |0.5| + |0.5| = 1 \\\\\n. \\| r(0.5) \\|_{L_2} &= \\sqrt{(0.5)^{2} + (0.5)^{2}} = \\sqrt{0.5} \\\\\n. \\| r(0.5) \\|_{L_\\infty} &= \\max(|0.5|,|0.5|) = 0.5.\n. \\f}\n. The following graphic shows all values for the three norm functions \\f$\\| r(x) \\|_{L_1}, \\| r(x) \\|_{L_2}\\f$ and \\f$\\| r(x) \\|_{L_\\infty}\\f$.\n. It is notable that the \\f$ L_{1} \\f$ norm forms the upper and the \\f$ L_{\\infty} \\f$ norm forms the lower border for the example function \\f$ r(x) \\f$.\n. ![Graphs for the different norm functions from the above example](pics/NormTypes_OneArray_1-2-INF.png)\n. \n. When the mask parameter is specified and it is not empty, the norm is\n. \n. If normType is not specified, #NORM_L2 is used.\n. calculated only over the region specified by the mask.\n. \n. Multi-channel input arrays are treated as single-channel arrays, that is,\n. the results for all channels are combined.\n. \n. Hamming norms can only be calculated with CV_8U depth arrays.\n. \n. @param src1 first input array.\n. @param normType type of the norm (see #NormTypes).\n. @param mask optional operation mask; it must have the same size as src1 and CV_8UC1 type.\n\n\n\nnorm(src1, src2[, normType[, mask]]) -> retval\n. @brief Calculates an absolute difference norm or a relative difference norm.\n. \n. This version of cv::norm calculates the absolute difference norm\n. or the relative difference norm of arrays src1 and src2.\n. The type of norm to calculate is specified using #NormTypes.\n. \n. @param src1 first input array.\n. @param src2 second input array of the same size and the same type as src1.\n. @param normType type of the norm (see #NormTypes).\n. @param mask optional operation mask; it must have the same size as src1 and CV_8UC1 type.' ... - -def normalize(src: ndarray, dts: ndarray, alpha=..., beta=..., normType: int = ..., dtype=..., mask: ndarray = ...) -> ndarray: +def normalize(src: Mat, dts: Mat, alpha=..., beta=..., normType: int = ..., dtype=..., mask: Mat = ...) -> Mat: 'normalize(src, dst[, alpha[, beta[, normType[, dtype[, mask]]]]]) -> dst\n. @brief Normalizes the norm or value range of an array.\n. \n. The function cv::normalize normalizes scale and shift the input array elements so that\n. \\f[\\| \\texttt{dst} \\| _{L_p}= \\texttt{alpha}\\f]\n. (where p=Inf, 1 or 2) when normType=NORM_INF, NORM_L1, or NORM_L2, respectively; or so that\n. \\f[\\min _I \\texttt{dst} (I)= \\texttt{alpha} , \\, \\, \\max _I \\texttt{dst} (I)= \\texttt{beta}\\f]\n. \n. when normType=NORM_MINMAX (for dense arrays only). The optional mask specifies a sub-array to be\n. normalized. This means that the norm or min-n-max are calculated over the sub-array, and then this\n. sub-array is modified to be normalized. If you want to only use the mask to calculate the norm or\n. min-max but modify the whole array, you can use norm and Mat::convertTo.\n. \n. In case of sparse matrices, only the non-zero values are analyzed and transformed. Because of this,\n. the range transformation for sparse matrices is not allowed since it can shift the zero level.\n. \n. Possible usage with some positive example data:\n. @code{.cpp}\n. vector positiveData = { 2.0, 8.0, 10.0 };\n. vector normalizedData_l1, normalizedData_l2, normalizedData_inf, normalizedData_minmax;\n. \n. // Norm to probability (total count)\n. // sum(numbers) = 20.0\n. // 2.0 0.1 (2.0/20.0)\n. // 8.0 0.4 (8.0/20.0)\n. // 10.0 0.5 (10.0/20.0)\n. normalize(positiveData, normalizedData_l1, 1.0, 0.0, NORM_L1);\n. \n. // Norm to unit vector: ||positiveData|| = 1.0\n. // 2.0 0.15\n. // 8.0 0.62\n. // 10.0 0.77\n. normalize(positiveData, normalizedData_l2, 1.0, 0.0, NORM_L2);\n. \n. // Norm to max element\n. // 2.0 0.2 (2.0/10.0)\n. // 8.0 0.8 (8.0/10.0)\n. // 10.0 1.0 (10.0/10.0)\n. normalize(positiveData, normalizedData_inf, 1.0, 0.0, NORM_INF);\n. \n. // Norm to range [0.0;1.0]\n. // 2.0 0.0 (shift to left border)\n. // 8.0 0.75 (6.0/8.0)\n. // 10.0 1.0 (shift to right border)\n. normalize(positiveData, normalizedData_minmax, 1.0, 0.0, NORM_MINMAX);\n. @endcode\n. \n. @param src input array.\n. @param dst output array of the same size as src .\n. @param alpha norm value to normalize to or the lower range boundary in case of the range\n. normalization.\n. @param beta upper range boundary in case of the range normalization; it is not used for the norm\n. normalization.\n. @param normType normalization type (see cv::NormTypes).\n. @param dtype when negative, the output array has the same type as src; otherwise, it has the same\n. number of channels as src and the depth =CV_MAT_DEPTH(dtype).\n. @param mask optional operation mask.\n. @sa norm, Mat::convertTo, SparseMat::convertTo' ... - ocl_Device = _mod_cv2.ocl_Device - - def patchNaNs(a, val=...) -> typing.Any: "patchNaNs(a[, val]) -> a\n. @brief converts NaN's to the given number" ... - -def pencilSketch(src: ndarray, dts1: ndarray = ..., dts2: ndarray = ..., sigma_s=..., sigma_r=..., shade_factor=...) -> typing.Any: +def pencilSketch(src: Mat, dts1: Mat = ..., dts2: Mat = ..., sigma_s=..., sigma_r=..., shade_factor=...) -> typing.Any: 'pencilSketch(src[, dst1[, dst2[, sigma_s[, sigma_r[, shade_factor]]]]]) -> dst1, dst2\n. @brief Pencil-like non-photorealistic line drawing\n. \n. @param src Input 8-bit 3-channel image.\n. @param dst1 Output 8-bit 1-channel image.\n. @param dst2 Output image with the same size and type as src.\n. @param sigma_s %Range between 0 to 200.\n. @param sigma_r %Range between 0 to 1.\n. @param shade_factor %Range between 0 to 0.1.' ... - -def perspectiveTransform(src: ndarray, m, dts: ndarray = ...) -> typing.Any: +def perspectiveTransform(src: Mat, m, dts: Mat = ...) -> typing.Any: "perspectiveTransform(src, m[, dst]) -> dst\n. @brief Performs the perspective matrix transformation of vectors.\n. \n. The function cv::perspectiveTransform transforms every element of src by\n. treating it as a 2D or 3D vector, in the following way:\n. \\f[(x, y, z) \\rightarrow (x'/w, y'/w, z'/w)\\f]\n. where\n. \\f[(x', y', z', w') = \\texttt{mat} \\cdot \\begin{bmatrix} x & y & z & 1 \\end{bmatrix}\\f]\n. and\n. \\f[w = \\fork{w'}{if \\(w' \\ne 0\\)}{\\infty}{otherwise}\\f]\n. \n. Here a 3D vector transformation is shown. In case of a 2D vector\n. transformation, the z component is omitted.\n. \n. @note The function transforms a sparse set of 2D or 3D vectors. If you\n. want to transform an image using perspective transformation, use\n. warpPerspective . If you have an inverse problem, that is, you want to\n. compute the most probable perspective transformation out of several\n. pairs of corresponding points, you can use getPerspectiveTransform or\n. findHomography .\n. @param src input two-channel or three-channel floating-point array; each\n. element is a 2D/3D vector to be transformed.\n. @param dst output array of the same size and type as src.\n. @param m 3x3 or 4x4 floating-point transformation matrix.\n. @sa transform, warpPerspective, getPerspectiveTransform, findHomography" ... - def phase(x, y, angle=..., angleInDegrees=...) -> typing.Any: 'phase(x, y[, angle[, angleInDegrees]]) -> angle\n. @brief Calculates the rotation angle of 2D vectors.\n. \n. The function cv::phase calculates the rotation angle of each 2D vector that\n. is formed from the corresponding elements of x and y :\n. \\f[\\texttt{angle} (I) = \\texttt{atan2} ( \\texttt{y} (I), \\texttt{x} (I))\\f]\n. \n. The angle estimation accuracy is about 0.3 degrees. When x(I)=y(I)=0 ,\n. the corresponding angle(I) is set to 0.\n. @param x input floating-point array of x-coordinates of 2D vectors.\n. @param y input array of y-coordinates of 2D vectors; it must have the\n. same size and the same type as x.\n. @param angle output array of vector angles; it has the same size and\n. same type as x .\n. @param angleInDegrees when true, the function calculates the angle in\n. degrees, otherwise, they are measured in radians.' ... - -def phaseCorrelate(src1: ndarray, src2: ndarray, window=...) -> typing.Any: +def phaseCorrelate(src1: Mat, src2: Mat, window=...) -> typing.Any: 'phaseCorrelate(src1, src2[, window]) -> retval, response\n. @brief The function is used to detect translational shifts that occur between two images.\n. \n. The operation takes advantage of the Fourier shift theorem for detecting the translational shift in\n. the frequency domain. It can be used for fast image registration as well as motion estimation. For\n. more information please see \n. \n. Calculates the cross-power spectrum of two supplied source arrays. The arrays are padded if needed\n. with getOptimalDFTSize.\n. \n. The function performs the following equations:\n. - First it applies a Hanning window (see ) to each\n. image to remove possible edge effects. This window is cached until the array size changes to speed\n. up processing time.\n. - Next it computes the forward DFTs of each source array:\n. \\f[\\mathbf{G}_a = \\mathcal{F}\\{src_1\\}, \\; \\mathbf{G}_b = \\mathcal{F}\\{src_2\\}\\f]\n. where \\f$\\mathcal{F}\\f$ is the forward DFT.\n. - It then computes the cross-power spectrum of each frequency domain array:\n. \\f[R = \\frac{ \\mathbf{G}_a \\mathbf{G}_b^*}{|\\mathbf{G}_a \\mathbf{G}_b^*|}\\f]\n. - Next the cross-correlation is converted back into the time domain via the inverse DFT:\n. \\f[r = \\mathcal{F}^{-1}\\{R\\}\\f]\n. - Finally, it computes the peak location and computes a 5x5 weighted centroid around the peak to\n. achieve sub-pixel accuracy.\n. \\f[(\\Delta x, \\Delta y) = \\texttt{weightedCentroid} \\{\\arg \\max_{(x, y)}\\{r\\}\\}\\f]\n. - If non-zero, the response parameter is computed as the sum of the elements of r within the 5x5\n. centroid around the peak location. It is normalized to a maximum of 1 (meaning there is a single\n. peak) and will be smaller when there are multiple peaks.\n. \n. @param src1 Source floating point array (CV_32FC1 or CV_64FC1)\n. @param src2 Source floating point array (CV_32FC1 or CV_64FC1)\n. @param window Floating point array with windowing coefficients to reduce edge effects (optional).\n. @param response Signal power within the 5x5 centroid around the peak, between 0 and 1 (optional).\n. @returns detected phase shift (sub-pixel) between the two arrays.\n. \n. @sa dft, getOptimalDFTSize, idft, mulSpectrums createHanningWindow' ... - def pointPolygonTest(contour, pt, measureDist) -> typing.Any: 'pointPolygonTest(contour, pt, measureDist) -> retval\n. @brief Performs a point-in-contour test.\n. \n. The function determines whether the point is inside a contour, outside, or lies on an edge (or\n. coincides with a vertex). It returns positive (inside), negative (outside), or zero (on an edge)\n. value, correspondingly. When measureDist=false , the return value is +1, -1, and 0, respectively.\n. Otherwise, the return value is a signed distance between the point and the nearest contour edge.\n. \n. See below a sample output of the function where each image pixel is tested against the contour:\n. \n. ![sample output](pics/pointpolygon.png)\n. \n. @param contour Input contour.\n. @param pt Point tested against the contour.\n. @param measureDist If true, the function estimates the signed distance from the point to the\n. nearest contour edge. Otherwise, the function only checks if the point is inside a contour or not.' ... - def polarToCart(magnitude, angle, x=..., y=..., angleInDegrees=...) -> typing.Any: 'polarToCart(magnitude, angle[, x[, y[, angleInDegrees]]]) -> x, y\n. @brief Calculates x and y coordinates of 2D vectors from their magnitude and angle.\n. \n. The function cv::polarToCart calculates the Cartesian coordinates of each 2D\n. vector represented by the corresponding elements of magnitude and angle:\n. \\f[\\begin{array}{l} \\texttt{x} (I) = \\texttt{magnitude} (I) \\cos ( \\texttt{angle} (I)) \\\\ \\texttt{y} (I) = \\texttt{magnitude} (I) \\sin ( \\texttt{angle} (I)) \\\\ \\end{array}\\f]\n. \n. The relative accuracy of the estimated coordinates is about 1e-6.\n. @param magnitude input floating-point array of magnitudes of 2D vectors;\n. it can be an empty matrix (=Mat()), in this case, the function assumes\n. that all the magnitudes are =1; if it is not empty, it must have the\n. same size and type as angle.\n. @param angle input floating-point array of angles of 2D vectors.\n. @param x output array of x-coordinates of 2D vectors; it has the same\n. size and type as angle.\n. @param y output array of y-coordinates of 2D vectors; it has the same\n. size and type as angle.\n. @param angleInDegrees when true, the input angles are measured in\n. degrees, otherwise, they are measured in radians.\n. @sa cartToPolar, magnitude, phase, exp, log, pow, sqrt' ... - -def polylines(img: ndarray, pts, isClosed, color, thickness=..., lineType=..., shift=...) -> typing.Any: +def polylines(img: Mat, pts, isClosed, color, thickness=..., lineType=..., shift=...) -> typing.Any: 'polylines(img, pts, isClosed, color[, thickness[, lineType[, shift]]]) -> img\n. @brief Draws several polygonal curves.\n. \n. @param img Image.\n. @param pts Array of polygonal curves.\n. @param isClosed Flag indicating whether the drawn polylines are closed or not. If they are closed,\n. the function draws a line from the last vertex of each curve to its first vertex.\n. @param color Polyline color.\n. @param thickness Thickness of the polyline edges.\n. @param lineType Type of the line segments. See #LineTypes\n. @param shift Number of fractional bits in the vertex coordinates.\n. \n. The function cv::polylines draws one or more polygonal curves.' ... - -def pow(src: ndarray, power, dts: ndarray = ...) -> typing.Any: +def pow(src: Mat, power, dts: Mat = ...) -> typing.Any: 'pow(src, power[, dst]) -> dst\n. @brief Raises every array element to a power.\n. \n. The function cv::pow raises every element of the input array to power :\n. \\f[\\texttt{dst} (I) = \\fork{\\texttt{src}(I)^{power}}{if \\(\\texttt{power}\\) is integer}{|\\texttt{src}(I)|^{power}}{otherwise}\\f]\n. \n. So, for a non-integer power exponent, the absolute values of input array\n. elements are used. However, it is possible to get true values for\n. negative values using some extra operations. In the example below,\n. computing the 5th root of array src shows:\n. @code{.cpp}\n. Mat mask = src < 0;\n. pow(src, 1./5, dst);\n. subtract(Scalar::all(0), dst, dst, mask);\n. @endcode\n. For some values of power, such as integer values, 0.5 and -0.5,\n. specialized faster algorithms are used.\n. \n. Special values (NaN, Inf) are not handled.\n. @param src input array.\n. @param power exponent of power.\n. @param dst output array of the same size and type as src.\n. @sa sqrt, exp, log, cartToPolar, polarToCart' ... - -def preCornerDetect(src: ndarray, ksize, dts: ndarray = ..., borderType=...) -> typing.Any: +def preCornerDetect(src: Mat, ksize, dts: Mat = ..., borderType=...) -> typing.Any: 'preCornerDetect(src, ksize[, dst[, borderType]]) -> dst\n. @brief Calculates a feature map for corner detection.\n. \n. The function calculates the complex spatial derivative-based function of the source image\n. \n. \\f[\\texttt{dst} = (D_x \\texttt{src} )^2 \\cdot D_{yy} \\texttt{src} + (D_y \\texttt{src} )^2 \\cdot D_{xx} \\texttt{src} - 2 D_x \\texttt{src} \\cdot D_y \\texttt{src} \\cdot D_{xy} \\texttt{src}\\f]\n. \n. where \\f$D_x\\f$,\\f$D_y\\f$ are the first image derivatives, \\f$D_{xx}\\f$,\\f$D_{yy}\\f$ are the second image\n. derivatives, and \\f$D_{xy}\\f$ is the mixed derivative.\n. \n. The corners can be found as local maximums of the functions, as shown below:\n. @code\n. Mat corners, dilated_corners;\n. preCornerDetect(image, corners, 3);\n. // dilation with 3x3 rectangular structuring element\n. dilate(corners, dilated_corners, Mat(), 1);\n. Mat corner_mask = corners == dilated_corners;\n. @endcode\n. \n. @param src Source single-channel 8-bit of floating-point image.\n. @param dst Output image that has the type CV_32F and the same size as src .\n. @param ksize %Aperture size of the Sobel .\n. @param borderType Pixel extrapolation method. See #BorderTypes. #BORDER_WRAP is not supported.' ... - def projectPoints(objectPoints, rvec, tvec, cameraMatrix, distCoeffs, imagePoints=..., jacobian=..., aspectRatio=...) -> typing.Any: 'projectPoints(objectPoints, rvec, tvec, cameraMatrix, distCoeffs[, imagePoints[, jacobian[, aspectRatio]]]) -> imagePoints, jacobian\n. @brief Projects 3D points to an image plane.\n. \n. @param objectPoints Array of object points expressed wrt. the world coordinate frame. A 3xN/Nx3\n. 1-channel or 1xN/Nx1 3-channel (or vector\\ ), where N is the number of points in the view.\n. @param rvec The rotation vector (@ref Rodrigues) that, together with tvec, performs a change of\n. basis from world to camera coordinate system, see @ref calibrateCamera for details.\n. @param tvec The translation vector, see parameter description above.\n. @param cameraMatrix Camera matrix \\f$A = \\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{_1}\\f$ .\n. @param distCoeffs Input vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$ of\n. 4, 5, 8, 12 or 14 elements. If the vector is empty, the zero distortion coefficients are assumed.\n. @param imagePoints Output array of image points, 1xN/Nx1 2-channel, or\n. vector\\ .\n. @param jacobian Optional output 2Nx(10+\\) jacobian matrix of derivatives of image\n. points with respect to components of the rotation vector, translation vector, focal lengths,\n. coordinates of the principal point and the distortion coefficients. In the old interface different\n. components of the jacobian are returned via different output parameters.\n. @param aspectRatio Optional "fixed aspect ratio" parameter. If the parameter is not 0, the\n. function assumes that the aspect ratio (\\f$f_x / f_y\\f$) is fixed and correspondingly adjusts the\n. jacobian matrix.\n. \n. The function computes the 2D projections of 3D points to the image plane, given intrinsic and\n. extrinsic camera parameters. Optionally, the function computes Jacobians -matrices of partial\n. derivatives of image points coordinates (as functions of all the input parameters) with respect to\n. the particular parameters, intrinsic and/or extrinsic. The Jacobians are used during the global\n. optimization in @ref calibrateCamera, @ref solvePnP, and @ref stereoCalibrate. The function itself\n. can also be used to compute a re-projection error, given the current intrinsic and extrinsic\n. parameters.\n. \n. @note By setting rvec = tvec = \\f$[0, 0, 0]\\f$, or by setting cameraMatrix to a 3x3 identity matrix,\n. or by passing zero distortion coefficients, one can get various useful partial cases of the\n. function. This means, one can compute the distorted coordinates for a sparse set of points or apply\n. a perspective transformation (and also compute the derivatives) in the ideal zero-distortion setup.' ... - -def putText(img: ndarray, text, org, fontFace, fontScale, color, thickness=..., lineType=..., bottomLeftOrigin=...) -> typing.Any: +def putText(img: Mat, text, org, fontFace, fontScale, color, thickness=..., lineType=..., bottomLeftOrigin=...) -> typing.Any: 'putText(img, text, org, fontFace, fontScale, color[, thickness[, lineType[, bottomLeftOrigin]]]) -> img\n. @brief Draws a text string.\n. \n. The function cv::putText renders the specified text string in the image. Symbols that cannot be rendered\n. using the specified font are replaced by question marks. See #getTextSize for a text rendering code\n. example.\n. \n. @param img Image.\n. @param text Text string to be drawn.\n. @param org Bottom-left corner of the text string in the image.\n. @param fontFace Font type, see #HersheyFonts.\n. @param fontScale Font scale factor that is multiplied by the font-specific base size.\n. @param color Text color.\n. @param thickness Thickness of the lines used to draw a text.\n. @param lineType Line type. See #LineTypes\n. @param bottomLeftOrigin When true, the image data origin is at the bottom-left corner. Otherwise,\n. it is at the top-left corner.' ... - -def pyrDown(src: ndarray, dts: ndarray = ..., dstsize=..., borderType=...) -> typing.Any: +def pyrDown(src: Mat, dts: Mat = ..., dstsize=..., borderType=...) -> typing.Any: "pyrDown(src[, dst[, dstsize[, borderType]]]) -> dst\n. @brief Blurs an image and downsamples it.\n. \n. By default, size of the output image is computed as `Size((src.cols+1)/2, (src.rows+1)/2)`, but in\n. any case, the following conditions should be satisfied:\n. \n. \\f[\\begin{array}{l} | \\texttt{dstsize.width} *2-src.cols| \\leq 2 \\\\ | \\texttt{dstsize.height} *2-src.rows| \\leq 2 \\end{array}\\f]\n. \n. The function performs the downsampling step of the Gaussian pyramid construction. First, it\n. convolves the source image with the kernel:\n. \n. \\f[\\frac{1}{256} \\begin{bmatrix} 1 & 4 & 6 & 4 & 1 \\\\ 4 & 16 & 24 & 16 & 4 \\\\ 6 & 24 & 36 & 24 & 6 \\\\ 4 & 16 & 24 & 16 & 4 \\\\ 1 & 4 & 6 & 4 & 1 \\end{bmatrix}\\f]\n. \n. Then, it downsamples the image by rejecting even rows and columns.\n. \n. @param src input image.\n. @param dst output image; it has the specified size and the same type as src.\n. @param dstsize size of the output image.\n. @param borderType Pixel extrapolation method, see #BorderTypes (#BORDER_CONSTANT isn't supported)" ... - -def pyrMeanShiftFiltering(src: ndarray, sp, sr, dts: ndarray = ..., maxLevel=..., termcrit=...) -> typing.Any: +def pyrMeanShiftFiltering(src: Mat, sp, sr, dts: Mat = ..., maxLevel=..., termcrit=...) -> typing.Any: 'pyrMeanShiftFiltering(src, sp, sr[, dst[, maxLevel[, termcrit]]]) -> dst\n. @brief Performs initial step of meanshift segmentation of an image.\n. \n. The function implements the filtering stage of meanshift segmentation, that is, the output of the\n. function is the filtered "posterized" image with color gradients and fine-grain texture flattened.\n. At every pixel (X,Y) of the input image (or down-sized input image, see below) the function executes\n. meanshift iterations, that is, the pixel (X,Y) neighborhood in the joint space-color hyperspace is\n. considered:\n. \n. \\f[(x,y): X- \\texttt{sp} \\le x \\le X+ \\texttt{sp} , Y- \\texttt{sp} \\le y \\le Y+ \\texttt{sp} , ||(R,G,B)-(r,g,b)|| \\le \\texttt{sr}\\f]\n. \n. where (R,G,B) and (r,g,b) are the vectors of color components at (X,Y) and (x,y), respectively\n. (though, the algorithm does not depend on the color space used, so any 3-component color space can\n. be used instead). Over the neighborhood the average spatial value (X\',Y\') and average color vector\n. (R\',G\',B\') are found and they act as the neighborhood center on the next iteration:\n. \n. \\f[(X,Y)~(X\',Y\'), (R,G,B)~(R\',G\',B\').\\f]\n. \n. After the iterations over, the color components of the initial pixel (that is, the pixel from where\n. the iterations started) are set to the final value (average color at the last iteration):\n. \n. \\f[I(X,Y) <- (R*,G*,B*)\\f]\n. \n. When maxLevel \\> 0, the gaussian pyramid of maxLevel+1 levels is built, and the above procedure is\n. run on the smallest layer first. After that, the results are propagated to the larger layer and the\n. iterations are run again only on those pixels where the layer colors differ by more than sr from the\n. lower-resolution layer of the pyramid. That makes boundaries of color regions sharper. Note that the\n. results will be actually different from the ones obtained by running the meanshift procedure on the\n. whole original image (i.e. when maxLevel==0).\n. \n. @param src The source 8-bit, 3-channel image.\n. @param dst The destination image of the same format and the same size as the source.\n. @param sp The spatial window radius.\n. @param sr The color window radius.\n. @param maxLevel Maximum level of the pyramid for the segmentation.\n. @param termcrit Termination criteria: when to stop meanshift iterations.' ... - -def pyrUp(src: ndarray, dts: ndarray = ..., dstsize=..., borderType=...) -> typing.Any: +def pyrUp(src: Mat, dts: Mat = ..., dstsize=..., borderType=...) -> typing.Any: 'pyrUp(src[, dst[, dstsize[, borderType]]]) -> dst\n. @brief Upsamples an image and then blurs it.\n. \n. By default, size of the output image is computed as `Size(src.cols\\*2, (src.rows\\*2)`, but in any\n. case, the following conditions should be satisfied:\n. \n. \\f[\\begin{array}{l} | \\texttt{dstsize.width} -src.cols*2| \\leq ( \\texttt{dstsize.width} \\mod 2) \\\\ | \\texttt{dstsize.height} -src.rows*2| \\leq ( \\texttt{dstsize.height} \\mod 2) \\end{array}\\f]\n. \n. The function performs the upsampling step of the Gaussian pyramid construction, though it can\n. actually be used to construct the Laplacian pyramid. First, it upsamples the source image by\n. injecting even zero rows and columns and then convolves the result with the same kernel as in\n. pyrDown multiplied by 4.\n. \n. @param src input image.\n. @param dst output image. It has the specified size and the same type as src .\n. @param dstsize size of the output image.\n. @param borderType Pixel extrapolation method, see #BorderTypes (only #BORDER_DEFAULT is supported)' ... - -def randShuffle(dts: ndarray, iterFactor=...) -> typing.Any: +def randShuffle(dts: Mat, iterFactor=...) -> typing.Any: 'randShuffle(dst[, iterFactor]) -> dst\n. @brief Shuffles the array elements randomly.\n. \n. The function cv::randShuffle shuffles the specified 1D array by randomly choosing pairs of elements and\n. swapping them. The number of such swap operations will be dst.rows\\*dst.cols\\*iterFactor .\n. @param dst input/output numerical 1D array.\n. @param iterFactor scale factor that determines the number of random swap operations (see the details\n. below).\n. @param rng optional random number generator used for shuffling; if it is zero, theRNG () is used\n. instead.\n. @sa RNG, sort' ... - -def randn(dts: ndarray, mean, stddev) -> typing.Any: +def randn(dts: Mat, mean, stddev) -> typing.Any: 'randn(dst, mean, stddev) -> dst\n. @brief Fills the array with normally distributed random numbers.\n. \n. The function cv::randn fills the matrix dst with normally distributed random numbers with the specified\n. mean vector and the standard deviation matrix. The generated random numbers are clipped to fit the\n. value range of the output array data type.\n. @param dst output array of random numbers; the array must be pre-allocated and have 1 to 4 channels.\n. @param mean mean value (expectation) of the generated random numbers.\n. @param stddev standard deviation of the generated random numbers; it can be either a vector (in\n. which case a diagonal standard deviation matrix is assumed) or a square matrix.\n. @sa RNG, randu' ... - -def randu(dts: ndarray, low, high) -> typing.Any: +def randu(dts: Mat, low, high) -> typing.Any: 'randu(dst, low, high) -> dst\n. @brief Generates a single uniformly-distributed random number or an array of random numbers.\n. \n. Non-template variant of the function fills the matrix dst with uniformly-distributed\n. random numbers from the specified range:\n. \\f[\\texttt{low} _c \\leq \\texttt{dst} (I)_c < \\texttt{high} _c\\f]\n. @param dst output array of random numbers; the array must be pre-allocated.\n. @param low inclusive lower boundary of the generated random numbers.\n. @param high exclusive upper boundary of the generated random numbers.\n. @sa RNG, randn, theRNG' ... - def readOpticalFlow(path) -> typing.Any: 'readOpticalFlow(path) -> retval\n. @brief Read a .flo file\n. \n. @param path Path to the file to be loaded\n. \n. The function readOpticalFlow loads a flow field from a file and returns it as a single matrix.\n. Resulting Mat has a type CV_32FC2 - floating-point, 2-channel. First channel corresponds to the\n. flow in the horizontal direction (u), second - vertical (v).' ... - -def recoverPose(E, points1, points2, cameraMatrix, R=..., t=..., mask: ndarray = ...) -> typing.Any: +def recoverPose(E, points1, points2, cameraMatrix, R=..., t=..., mask: Mat = ...) -> typing.Any: "recoverPose(E, points1, points2, cameraMatrix[, R[, t[, mask]]]) -> retval, R, t, mask\n. @brief Recovers the relative camera rotation and the translation from an estimated essential\n. matrix and the corresponding points in two images, using cheirality check. Returns the number of\n. inliers that pass the check.\n. \n. @param E The input essential matrix.\n. @param points1 Array of N 2D points from the first image. The point coordinates should be\n. floating-point (single or double precision).\n. @param points2 Array of the second image points of the same size and format as points1 .\n. @param cameraMatrix Camera matrix \\f$A = \\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\\f$ .\n. Note that this function assumes that points1 and points2 are feature points from cameras with the\n. same camera matrix.\n. @param R Output rotation matrix. Together with the translation vector, this matrix makes up a tuple\n. that performs a change of basis from the first camera's coordinate system to the second camera's\n. coordinate system. Note that, in general, t can not be used for this tuple, see the parameter\n. described below.\n. @param t Output translation vector. This vector is obtained by @ref decomposeEssentialMat and\n. therefore is only known up to scale, i.e. t is the direction of the translation vector and has unit\n. length.\n. @param mask Input/output mask for inliers in points1 and points2. If it is not empty, then it marks\n. inliers in points1 and points2 for then given essential matrix E. Only these inliers will be used to\n. recover pose. In the output mask only inliers which pass the cheirality check.\n. \n. This function decomposes an essential matrix using @ref decomposeEssentialMat and then verifies\n. possible pose hypotheses by doing cheirality check. The cheirality check means that the\n. triangulated 3D points should have positive depth. Some details can be found in @cite Nister03.\n. \n. This function can be used to process the output E and mask from @ref findEssentialMat. In this\n. scenario, points1 and points2 are the same input for findEssentialMat.:\n. @code\n. // Example. Estimation of fundamental matrix using the RANSAC algorithm\n. int point_count = 100;\n. vector points1(point_count);\n. vector points2(point_count);\n. \n. // initialize the points here ...\n. for( int i = 0; i < point_count; i++ )\n. {\n. points1[i] = ...;\n. points2[i] = ...;\n. }\n. \n. // cametra matrix with both focal lengths = 1, and principal point = (0, 0)\n. Mat cameraMatrix = Mat::eye(3, 3, CV_64F);\n. \n. Mat E, R, t, mask;\n. \n. E = findEssentialMat(points1, points2, cameraMatrix, RANSAC, 0.999, 1.0, mask);\n. recoverPose(E, points1, points2, cameraMatrix, R, t, mask);\n. @endcode\n\n\n\nrecoverPose(E, points1, points2[, R[, t[, focal[, pp[, mask]]]]]) -> retval, R, t, mask\n. @overload\n. @param E The input essential matrix.\n. @param points1 Array of N 2D points from the first image. The point coordinates should be\n. floating-point (single or double precision).\n. @param points2 Array of the second image points of the same size and format as points1 .\n. @param R Output rotation matrix. Together with the translation vector, this matrix makes up a tuple\n. that performs a change of basis from the first camera's coordinate system to the second camera's\n. coordinate system. Note that, in general, t can not be used for this tuple, see the parameter\n. description below.\n. @param t Output translation vector. This vector is obtained by @ref decomposeEssentialMat and\n. therefore is only known up to scale, i.e. t is the direction of the translation vector and has unit\n. length.\n. @param focal Focal length of the camera. Note that this function assumes that points1 and points2\n. are feature points from cameras with same focal length and principal point.\n. @param pp principal point of the camera.\n. @param mask Input/output mask for inliers in points1 and points2. If it is not empty, then it marks\n. inliers in points1 and points2 for then given essential matrix E. Only these inliers will be used to\n. recover pose. In the output mask only inliers which pass the cheirality check.\n. \n. This function differs from the one above that it computes camera matrix from focal length and\n. principal point:\n. \n. \\f[A =\n. \\begin{bmatrix}\n. f & 0 & x_{pp} \\\\\n. 0 & f & y_{pp} \\\\\n. 0 & 0 & 1\n. \\end{bmatrix}\\f]\n\n\n\nrecoverPose(E, points1, points2, cameraMatrix, distanceThresh[, R[, t[, mask[, triangulatedPoints]]]]) -> retval, R, t, mask, triangulatedPoints\n. @overload\n. @param E The input essential matrix.\n. @param points1 Array of N 2D points from the first image. The point coordinates should be\n. floating-point (single or double precision).\n. @param points2 Array of the second image points of the same size and format as points1.\n. @param cameraMatrix Camera matrix \\f$A = \\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\\f$ .\n. Note that this function assumes that points1 and points2 are feature points from cameras with the\n. same camera matrix.\n. @param R Output rotation matrix. Together with the translation vector, this matrix makes up a tuple\n. that performs a change of basis from the first camera's coordinate system to the second camera's\n. coordinate system. Note that, in general, t can not be used for this tuple, see the parameter\n. description below.\n. @param t Output translation vector. This vector is obtained by @ref decomposeEssentialMat and\n. therefore is only known up to scale, i.e. t is the direction of the translation vector and has unit\n. length.\n. @param distanceThresh threshold distance which is used to filter out far away points (i.e. infinite\n. points).\n. @param mask Input/output mask for inliers in points1 and points2. If it is not empty, then it marks\n. inliers in points1 and points2 for then given essential matrix E. Only these inliers will be used to\n. recover pose. In the output mask only inliers which pass the cheirality check.\n. @param triangulatedPoints 3D points which were reconstructed by triangulation.\n. \n. This function differs from the one above that it outputs the triangulated 3D point that are used for\n. the cheirality check." ... - -def rectangle(img: ndarray, pt1, pt2, color, thickness=..., lineType=..., shift=...) -> typing.Any: +def rectangle(img: Mat, pt1, pt2, color, thickness=..., lineType=..., shift=...) -> typing.Any: 'rectangle(img, pt1, pt2, color[, thickness[, lineType[, shift]]]) -> img\n. @brief Draws a simple, thick, or filled up-right rectangle.\n. \n. The function cv::rectangle draws a rectangle outline or a filled rectangle whose two opposite corners\n. are pt1 and pt2.\n. \n. @param img Image.\n. @param pt1 Vertex of the rectangle.\n. @param pt2 Vertex of the rectangle opposite to pt1 .\n. @param color Rectangle color or brightness (grayscale image).\n. @param thickness Thickness of lines that make up the rectangle. Negative values, like #FILLED,\n. mean that the function has to draw a filled rectangle.\n. @param lineType Type of the line. See #LineTypes\n. @param shift Number of fractional bits in the point coordinates.\n\n\n\nrectangle(img, rec, color[, thickness[, lineType[, shift]]]) -> img\n. @overload\n. \n. use `rec` parameter as alternative specification of the drawn rectangle: `r.tl() and\n. r.br()-Point(1,1)` are opposite corners' ... - def rectify3Collinear(cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, cameraMatrix3, distCoeffs3, imgpt1, imgpt3, imageSize, R12, T12, R13, T13, alpha, newImgSize, flags: int, R1=..., R2=..., R3=..., P1=..., P2=..., P3=..., Q=...) -> typing.Any: 'rectify3Collinear(cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, cameraMatrix3, distCoeffs3, imgpt1, imgpt3, imageSize, R12, T12, R13, T13, alpha, newImgSize, flags[, R1[, R2[, R3[, P1[, P2[, P3[, Q]]]]]]]) -> retval, R1, R2, R3, P1, P2, P3, Q, roi1, roi2\n.' ... - def redirectError(onError) -> typing.Any: 'redirectError(onError) -> None' ... - -def reduce(src: ndarray, dim, rtype, dts: ndarray = ..., dtype=...) -> typing.Any: +def reduce(src: Mat, dim, rtype, dts: Mat = ..., dtype=...) -> typing.Any: 'reduce(src, dim, rtype[, dst[, dtype]]) -> dst\n. @brief Reduces a matrix to a vector.\n. \n. The function #reduce reduces the matrix to a vector by treating the matrix rows/columns as a set of\n. 1D vectors and performing the specified operation on the vectors until a single row/column is\n. obtained. For example, the function can be used to compute horizontal and vertical projections of a\n. raster image. In case of #REDUCE_MAX and #REDUCE_MIN , the output image should have the same type as the source one.\n. In case of #REDUCE_SUM and #REDUCE_AVG , the output may have a larger element bit-depth to preserve accuracy.\n. And multi-channel arrays are also supported in these two reduction modes.\n. \n. The following code demonstrates its usage for a single channel matrix.\n. @snippet snippets/core_reduce.cpp example\n. \n. And the following code demonstrates its usage for a two-channel matrix.\n. @snippet snippets/core_reduce.cpp example2\n. \n. @param src input 2D matrix.\n. @param dst output vector. Its size and type is defined by dim and dtype parameters.\n. @param dim dimension index along which the matrix is reduced. 0 means that the matrix is reduced to\n. a single row. 1 means that the matrix is reduced to a single column.\n. @param rtype reduction operation that could be one of #ReduceTypes\n. @param dtype when negative, the output vector will have the same type as the input matrix,\n. otherwise, its type will be CV_MAKE_TYPE(CV_MAT_DEPTH(dtype), src.channels()).\n. @sa repeat' ... - -def remap(src: ndarray, map1, map2, interpolation: int, dts: ndarray = ..., borderMode=..., borderValue=...) -> typing.Any: +def remap(src: Mat, map1, map2, interpolation: int, dts: Mat = ..., borderMode=..., borderValue=...) -> typing.Any: 'remap(src, map1, map2, interpolation[, dst[, borderMode[, borderValue]]]) -> dst\n. @brief Applies a generic geometrical transformation to an image.\n. \n. The function remap transforms the source image using the specified map:\n. \n. \\f[\\texttt{dst} (x,y) = \\texttt{src} (map_x(x,y),map_y(x,y))\\f]\n. \n. where values of pixels with non-integer coordinates are computed using one of available\n. interpolation methods. \\f$map_x\\f$ and \\f$map_y\\f$ can be encoded as separate floating-point maps\n. in \\f$map_1\\f$ and \\f$map_2\\f$ respectively, or interleaved floating-point maps of \\f$(x,y)\\f$ in\n. \\f$map_1\\f$, or fixed-point maps created by using convertMaps. The reason you might want to\n. convert from floating to fixed-point representations of a map is that they can yield much faster\n. (\\~2x) remapping operations. In the converted case, \\f$map_1\\f$ contains pairs (cvFloor(x),\n. cvFloor(y)) and \\f$map_2\\f$ contains indices in a table of interpolation coefficients.\n. \n. This function cannot operate in-place.\n. \n. @param src Source image.\n. @param dst Destination image. It has the same size as map1 and the same type as src .\n. @param map1 The first map of either (x,y) points or just x values having the type CV_16SC2 ,\n. CV_32FC1, or CV_32FC2. See convertMaps for details on converting a floating point\n. representation to fixed-point for speed.\n. @param map2 The second map of y values having the type CV_16UC1, CV_32FC1, or none (empty map\n. if map1 is (x,y) points), respectively.\n. @param interpolation Interpolation method (see #InterpolationFlags). The method #INTER_AREA is\n. not supported by this function.\n. @param borderMode Pixel extrapolation method (see #BorderTypes). When\n. borderMode=#BORDER_TRANSPARENT, it means that the pixels in the destination image that\n. corresponds to the "outliers" in the source image are not modified by the function.\n. @param borderValue Value used in case of a constant border. By default, it is 0.\n. @note\n. Due to current implementation limitations the size of an input and output images should be less than 32767x32767.' ... - -def repeat(src: ndarray, ny, nx, dts: ndarray = ...) -> typing.Any: +def repeat(src: Mat, ny, nx, dts: Mat = ...) -> typing.Any: 'repeat(src, ny, nx[, dst]) -> dst\n. @brief Fills the output array with repeated copies of the input array.\n. \n. The function cv::repeat duplicates the input array one or more times along each of the two axes:\n. \\f[\\texttt{dst} _{ij}= \\texttt{src} _{i\\mod src.rows, \\; j\\mod src.cols }\\f]\n. The second variant of the function is more convenient to use with @ref MatrixExpressions.\n. @param src input array to replicate.\n. @param ny Flag to specify how many times the `src` is repeated along the\n. vertical axis.\n. @param nx Flag to specify how many times the `src` is repeated along the\n. horizontal axis.\n. @param dst output array of the same type as `src`.\n. @sa cv::reduce' ... - def reprojectImageTo3D(disparity, Q, _3dImage=..., handleMissingValues=..., ddepth=...) -> typing.Any: "reprojectImageTo3D(disparity, Q[, _3dImage[, handleMissingValues[, ddepth]]]) -> _3dImage\n. @brief Reprojects a disparity image to 3D space.\n. \n. @param disparity Input single-channel 8-bit unsigned, 16-bit signed, 32-bit signed or 32-bit\n. floating-point disparity image. The values of 8-bit / 16-bit signed formats are assumed to have no\n. fractional bits. If the disparity is 16-bit signed format, as computed by @ref StereoBM or\n. @ref StereoSGBM and maybe other algorithms, it should be divided by 16 (and scaled to float) before\n. being used here.\n. @param _3dImage Output 3-channel floating-point image of the same size as disparity. Each element of\n. _3dImage(x,y) contains 3D coordinates of the point (x,y) computed from the disparity map. If one\n. uses Q obtained by @ref stereoRectify, then the returned points are represented in the first\n. camera's rectified coordinate system.\n. @param Q \\f$4 \\times 4\\f$ perspective transformation matrix that can be obtained with\n. @ref stereoRectify.\n. @param handleMissingValues Indicates, whether the function should handle missing values (i.e.\n. points where the disparity was not computed). If handleMissingValues=true, then pixels with the\n. minimal disparity that corresponds to the outliers (see StereoMatcher::compute ) are transformed\n. to 3D points with a very large Z value (currently set to 10000).\n. @param ddepth The optional output array depth. If it is -1, the output image will have CV_32F\n. depth. ddepth can also be set to CV_16S, CV_32S or CV_32F.\n. \n. The function transforms a single-channel disparity map to a 3-channel image representing a 3D\n. surface. That is, for each pixel (x,y) and the corresponding disparity d=disparity(x,y) , it\n. computes:\n. \n. \\f[\\begin{bmatrix}\n. X \\\\\n. Y \\\\\n. Z \\\\\n. W\n. \\end{bmatrix} = Q \\begin{bmatrix}\n. x \\\\\n. y \\\\\n. \\texttt{disparity} (x,y) \\\\\n. z\n. \\end{bmatrix}.\\f]\n. \n. @sa\n. To reproject a sparse set of points {(x,y,d),...} to 3D space, use perspectiveTransform." ... - -def resize(src: ndarray, dsize: tuple[int, int], dts: ndarray = ..., fx: int = ..., fy: int = ..., interpolation: int = ...) -> ndarray: +def resize(src: Mat, dsize: typing.Tuple[int, int], dts: Mat = ..., fx: int = ..., fy: int = ..., interpolation: int = ...) -> Mat: 'resize(src, dsize[, dst[, fx[, fy[, interpolation]]]]) -> dst\n. @brief Resizes an image.\n. \n. The function resize resizes the image src down to or up to the specified size. Note that the\n. initial dst type or size are not taken into account. Instead, the size and type are derived from\n. the `src`,`dsize`,`fx`, and `fy`. If you want to resize src so that it fits the pre-created dst,\n. you may call the function as follows:\n. @code\n. // explicitly specify dsize=dst.size(); fx and fy will be computed from that.\n. resize(src, dst, dst.size(), 0, 0, interpolation);\n. @endcode\n. If you want to decimate the image by factor of 2 in each direction, you can call the function this\n. way:\n. @code\n. // specify fx and fy and let the function compute the destination image size.\n. resize(src, dst, Size(), 0.5, 0.5, interpolation);\n. @endcode\n. To shrink an image, it will generally look best with #INTER_AREA interpolation, whereas to\n. enlarge an image, it will generally look best with c#INTER_CUBIC (slow) or #INTER_LINEAR\n. (faster but still looks OK).\n. \n. @param src input image.\n. @param dst output image; it has the size dsize (when it is non-zero) or the size computed from\n. src.size(), fx, and fy; the type of dst is the same as of src.\n. @param dsize output image size; if it equals zero, it is computed as:\n. \\f[\\texttt{dsize = Size(round(fx*src.cols), round(fy*src.rows))}\\f]\n. Either dsize or both fx and fy must be non-zero.\n. @param fx scale factor along the horizontal axis; when it equals 0, it is computed as\n. \\f[\\texttt{(double)dsize.width/src.cols}\\f]\n. @param fy scale factor along the vertical axis; when it equals 0, it is computed as\n. \\f[\\texttt{(double)dsize.height/src.rows}\\f]\n. @param interpolation interpolation method, see #InterpolationFlags\n. \n. @sa warpAffine, warpPerspective, remap' ... - def resizeWindow(winname, width, height) -> typing.Any: 'resizeWindow(winname, width, height) -> None\n. @brief Resizes window to the specified size\n. \n. @note\n. \n. - The specified window size is for the image area. Toolbars are not counted.\n. - Only windows created without cv::WINDOW_AUTOSIZE flag can be resized.\n. \n. @param winname Window name.\n. @param width The new window width.\n. @param height The new window height.\n\n\n\nresizeWindow(winname, size) -> None\n. @overload\n. @param winname Window name.\n. @param size The new window size.' ... - -def rotate(src: ndarray, rotateCode, dts: ndarray = ...) -> typing.Any: +def rotate(src: Mat, rotateCode, dts: Mat = ...) -> typing.Any: 'rotate(src, rotateCode[, dst]) -> dst\n. @brief Rotates a 2D array in multiples of 90 degrees.\n. The function cv::rotate rotates the array in one of three different ways:\n. * Rotate by 90 degrees clockwise (rotateCode = ROTATE_90_CLOCKWISE).\n. * Rotate by 180 degrees clockwise (rotateCode = ROTATE_180).\n. * Rotate by 270 degrees clockwise (rotateCode = ROTATE_90_COUNTERCLOCKWISE).\n. @param src input array.\n. @param dst output array of the same type as src. The size is the same with ROTATE_180,\n. and the rows and cols are switched for ROTATE_90_CLOCKWISE and ROTATE_90_COUNTERCLOCKWISE.\n. @param rotateCode an enum to specify how to rotate the array; see the enum #RotateFlags\n. @sa transpose , repeat , completeSymm, flip, RotateFlags' ... - def rotatedRectangleIntersection(rect1, rect2, intersectingRegion=...) -> typing.Any: 'rotatedRectangleIntersection(rect1, rect2[, intersectingRegion]) -> retval, intersectingRegion\n. @brief Finds out if there is any intersection between two rotated rectangles.\n. \n. If there is then the vertices of the intersecting region are returned as well.\n. \n. Below are some examples of intersection configurations. The hatched pattern indicates the\n. intersecting region and the red vertices are returned by the function.\n. \n. ![intersection examples](pics/intersection.png)\n. \n. @param rect1 First rectangle\n. @param rect2 Second rectangle\n. @param intersectingRegion The output array of the vertices of the intersecting region. It returns\n. at most 8 vertices. Stored as std::vector\\ or cv::Mat as Mx1 of type CV_32FC2.\n. @returns One of #RectanglesIntersectTypes' ... - def sampsonDistance(pt1, pt2, F) -> typing.Any: 'sampsonDistance(pt1, pt2, F) -> retval\n. @brief Calculates the Sampson Distance between two points.\n. \n. The function cv::sampsonDistance calculates and returns the first order approximation of the geometric error as:\n. \\f[\n. sd( \\texttt{pt1} , \\texttt{pt2} )=\n. \\frac{(\\texttt{pt2}^t \\cdot \\texttt{F} \\cdot \\texttt{pt1})^2}\n. {((\\texttt{F} \\cdot \\texttt{pt1})(0))^2 +\n. ((\\texttt{F} \\cdot \\texttt{pt1})(1))^2 +\n. ((\\texttt{F}^t \\cdot \\texttt{pt2})(0))^2 +\n. ((\\texttt{F}^t \\cdot \\texttt{pt2})(1))^2}\n. \\f]\n. The fundamental matrix may be calculated using the cv::findFundamentalMat function. See @cite HartleyZ00 11.4.3 for details.\n. @param pt1 first homogeneous 2d point\n. @param pt2 second homogeneous 2d point\n. @param F fundamental matrix\n. @return The computed Sampson distance.' ... - -def scaleAdd(src1: ndarray, alpha, src2: ndarray, dts: ndarray = ...) -> typing.Any: +def scaleAdd(src1: Mat, alpha, src2: Mat, dts: Mat = ...) -> typing.Any: 'scaleAdd(src1, alpha, src2[, dst]) -> dst\n. @brief Calculates the sum of a scaled array and another array.\n. \n. The function scaleAdd is one of the classical primitive linear algebra operations, known as DAXPY\n. or SAXPY in [BLAS](http://en.wikipedia.org/wiki/Basic_Linear_Algebra_Subprograms). It calculates\n. the sum of a scaled array and another array:\n. \\f[\\texttt{dst} (I)= \\texttt{scale} \\cdot \\texttt{src1} (I) + \\texttt{src2} (I)\\f]\n. The function can also be emulated with a matrix expression, for example:\n. @code{.cpp}\n. Mat A(3, 3, CV_64F);\n. ...\n. A.row(0) = A.row(1)*2 + A.row(2);\n. @endcode\n. @param src1 first input array.\n. @param alpha scale factor for the first array.\n. @param src2 second input array of the same size and type as src1.\n. @param dst output array of the same size and type as src1.\n. @sa add, addWeighted, subtract, Mat::dot, Mat::convertTo' ... - -def seamlessClone(src: ndarray, dts: ndarray, mask: typing.Optional[ndarray], p, flags: int, blend=...) -> typing.Any: +def seamlessClone(src: Mat, dts: Mat, mask: typing.Optional[Mat], p, flags: int, blend=...) -> typing.Any: 'seamlessClone(src, dst, mask, p, flags[, blend]) -> blend\n. @brief Image editing tasks concern either global changes (color/intensity corrections, filters,\n. deformations) or local changes concerned to a selection. Here we are interested in achieving local\n. changes, ones that are restricted to a region manually selected (ROI), in a seamless and effortless\n. manner. The extent of the changes ranges from slight distortions to complete replacement by novel\n. content @cite PM03 .\n. \n. @param src Input 8-bit 3-channel image.\n. @param dst Input 8-bit 3-channel image.\n. @param mask Input 8-bit 1 or 3-channel image.\n. @param p Point in dst image where object is placed.\n. @param blend Output image with the same size and type as dst.\n. @param flags Cloning method that could be cv::NORMAL_CLONE, cv::MIXED_CLONE or cv::MONOCHROME_TRANSFER' ... - -def selectROI(windowName, img: ndarray, showCrosshair=..., fromCenter=...) -> typing.Any: +def selectROI(windowName, img: Mat, showCrosshair=..., fromCenter=...) -> typing.Any: "selectROI(windowName, img[, showCrosshair[, fromCenter]]) -> retval\n. @brief Selects ROI on the given image.\n. Function creates a window and allows user to select a ROI using mouse.\n. Controls: use `space` or `enter` to finish selection, use key `c` to cancel selection (function will return the zero cv::Rect).\n. \n. @param windowName name of the window where selection process will be shown.\n. @param img image to select a ROI.\n. @param showCrosshair if true crosshair of selection rectangle will be shown.\n. @param fromCenter if true center of selection will match initial mouse position. In opposite case a corner of\n. selection rectangle will correspont to the initial mouse position.\n. @return selected ROI or empty rect if selection canceled.\n. \n. @note The function sets it's own mouse callback for specified window using cv::setMouseCallback(windowName, ...).\n. After finish of work an empty callback will be set for the used window.\n\n\n\nselectROI(img[, showCrosshair[, fromCenter]]) -> retval\n. @overload" ... - -def selectROIs(windowName, img: ndarray, showCrosshair=..., fromCenter=...) -> typing.Any: +def selectROIs(windowName, img: Mat, showCrosshair=..., fromCenter=...) -> typing.Any: "selectROIs(windowName, img[, showCrosshair[, fromCenter]]) -> boundingBoxes\n. @brief Selects ROIs on the given image.\n. Function creates a window and allows user to select a ROIs using mouse.\n. Controls: use `space` or `enter` to finish current selection and start a new one,\n. use `esc` to terminate multiple ROI selection process.\n. \n. @param windowName name of the window where selection process will be shown.\n. @param img image to select a ROI.\n. @param boundingBoxes selected ROIs.\n. @param showCrosshair if true crosshair of selection rectangle will be shown.\n. @param fromCenter if true center of selection will match initial mouse position. In opposite case a corner of\n. selection rectangle will correspont to the initial mouse position.\n. \n. @note The function sets it's own mouse callback for specified window using cv::setMouseCallback(windowName, ...).\n. After finish of work an empty callback will be set for the used window." ... - -def sepFilter2D(src: ndarray, ddepth, kernelX, kernelY, dts: ndarray = ..., anchor=..., delta=..., borderType=...) -> typing.Any: +def sepFilter2D(src: Mat, ddepth, kernelX, kernelY, dts: Mat = ..., anchor=..., delta=..., borderType=...) -> typing.Any: 'sepFilter2D(src, ddepth, kernelX, kernelY[, dst[, anchor[, delta[, borderType]]]]) -> dst\n. @brief Applies a separable linear filter to an image.\n. \n. The function applies a separable linear filter to the image. That is, first, every row of src is\n. filtered with the 1D kernel kernelX. Then, every column of the result is filtered with the 1D\n. kernel kernelY. The final result shifted by delta is stored in dst .\n. \n. @param src Source image.\n. @param dst Destination image of the same size and the same number of channels as src .\n. @param ddepth Destination image depth, see @ref filter_depths "combinations"\n. @param kernelX Coefficients for filtering each row.\n. @param kernelY Coefficients for filtering each column.\n. @param anchor Anchor position within the kernel. The default value \\f$(-1,-1)\\f$ means that the anchor\n. is at the kernel center.\n. @param delta Value added to the filtered results before storing them.\n. @param borderType Pixel extrapolation method, see #BorderTypes. #BORDER_WRAP is not supported.\n. @sa filter2D, Sobel, GaussianBlur, boxFilter, blur' ... - def setIdentity(mtx, s=...) -> typing.Any: 'setIdentity(mtx[, s]) -> mtx\n. @brief Initializes a scaled identity matrix.\n. \n. The function cv::setIdentity initializes a scaled identity matrix:\n. \\f[\\texttt{mtx} (i,j)= \\fork{\\texttt{value}}{ if \\(i=j\\)}{0}{otherwise}\\f]\n. \n. The function can also be emulated using the matrix initializers and the\n. matrix expressions:\n. @code\n. Mat A = Mat::eye(4, 3, CV_32F)*5;\n. // A will be set to [[5, 0, 0], [0, 5, 0], [0, 0, 5], [0, 0, 0]]\n. @endcode\n. @param mtx matrix to initialize (not necessarily square).\n. @param s value to assign to diagonal elements.\n. @sa Mat::zeros, Mat::ones, Mat::setTo, Mat::operator=' ... - def setMouseCallback(windowName, onMouse, param=...) -> typing.Any: 'setMouseCallback(windowName, onMouse [, param]) -> None' ... - def setNumThreads(nthreads) -> typing.Any: "setNumThreads(nthreads) -> None\n. @brief OpenCV will try to set the number of threads for the next parallel region.\n. \n. If threads == 0, OpenCV will disable threading optimizations and run all it's functions\n. sequentially. Passing threads \\< 0 will reset threads number to system default. This function must\n. be called outside of parallel region.\n. \n. OpenCV will try to run its functions with specified threads number, but some behaviour differs from\n. framework:\n. - `TBB` - User-defined parallel constructions will run with the same threads number, if\n. another is not specified. If later on user creates his own scheduler, OpenCV will use it.\n. - `OpenMP` - No special defined behaviour.\n. - `Concurrency` - If threads == 1, OpenCV will disable threading optimizations and run its\n. functions sequentially.\n. - `GCD` - Supports only values \\<= 0.\n. - `C=` - No special defined behaviour.\n. @param nthreads Number of threads used by OpenCV.\n. @sa getNumThreads, getThreadNum" ... - def setRNGSeed(seed) -> typing.Any: 'setRNGSeed(seed) -> None\n. @brief Sets state of default random number generator.\n. \n. The function cv::setRNGSeed sets state of default random number generator to custom value.\n. @param seed new state for default random number generator\n. @sa RNG, randu, randn' ... - def setTrackbarMax(trackbarname, winname, maxval) -> typing.Any: 'setTrackbarMax(trackbarname, winname, maxval) -> None\n. @brief Sets the trackbar maximum position.\n. \n. The function sets the maximum position of the specified trackbar in the specified window.\n. \n. @note\n. \n. [__Qt Backend Only__] winname can be empty if the trackbar is attached to the control\n. panel.\n. \n. @param trackbarname Name of the trackbar.\n. @param winname Name of the window that is the parent of trackbar.\n. @param maxval New maximum position.' ... - def setTrackbarMin(trackbarname, winname, minval) -> typing.Any: 'setTrackbarMin(trackbarname, winname, minval) -> None\n. @brief Sets the trackbar minimum position.\n. \n. The function sets the minimum position of the specified trackbar in the specified window.\n. \n. @note\n. \n. [__Qt Backend Only__] winname can be empty if the trackbar is attached to the control\n. panel.\n. \n. @param trackbarname Name of the trackbar.\n. @param winname Name of the window that is the parent of trackbar.\n. @param minval New minimum position.' ... - def setTrackbarPos(trackbarname, winname, pos) -> typing.Any: 'setTrackbarPos(trackbarname, winname, pos) -> None\n. @brief Sets the trackbar position.\n. \n. The function sets the position of the specified trackbar in the specified window.\n. \n. @note\n. \n. [__Qt Backend Only__] winname can be empty if the trackbar is attached to the control\n. panel.\n. \n. @param trackbarname Name of the trackbar.\n. @param winname Name of the window that is the parent of trackbar.\n. @param pos New position.' ... - def setUseOpenVX(flag) -> typing.Any: 'setUseOpenVX(flag) -> None\n.' ... - def setUseOptimized(onoff) -> typing.Any: 'setUseOptimized(onoff) -> None\n. @brief Enables or disables the optimized code.\n. \n. The function can be used to dynamically turn on and off optimized dispatched code (code that uses SSE4.2, AVX/AVX2,\n. and other instructions on the platforms that support it). It sets a global flag that is further\n. checked by OpenCV functions. Since the flag is not checked in the inner OpenCV loops, it is only\n. safe to call the function on the very top level in your application where you can be sure that no\n. other OpenCV function is currently executed.\n. \n. By default, the optimized code is enabled unless you disable it in CMake. The current status can be\n. retrieved using useOptimized.\n. @param onoff The boolean flag specifying whether the optimized code should be used (onoff=true)\n. or not (onoff=false).' ... - def setWindowProperty(winname, prop_id, prop_value) -> typing.Any: 'setWindowProperty(winname, prop_id, prop_value) -> None\n. @brief Changes parameters of a window dynamically.\n. \n. The function setWindowProperty enables changing properties of a window.\n. \n. @param winname Name of the window.\n. @param prop_id Window property to edit. The supported operation flags are: (cv::WindowPropertyFlags)\n. @param prop_value New value of the window property. The supported flags are: (cv::WindowFlags)' ... - def setWindowTitle(winname, title) -> typing.Any: 'setWindowTitle(winname, title) -> None\n. @brief Updates window title\n. @param winname Name of the window.\n. @param title New title.' ... - -def solve(src1: ndarray, src2: ndarray, dts: ndarray = ..., flags: int = ...) -> typing.Any: +def solve(src1: Mat, src2: Mat, dts: Mat = ..., flags: int = ...) -> typing.Any: 'solve(src1, src2[, dst[, flags]]) -> retval, dst\n. @brief Solves one or more linear systems or least-squares problems.\n. \n. The function cv::solve solves a linear system or least-squares problem (the\n. latter is possible with SVD or QR methods, or by specifying the flag\n. #DECOMP_NORMAL ):\n. \\f[\\texttt{dst} = \\arg \\min _X \\| \\texttt{src1} \\cdot \\texttt{X} - \\texttt{src2} \\|\\f]\n. \n. If #DECOMP_LU or #DECOMP_CHOLESKY method is used, the function returns 1\n. if src1 (or \\f$\\texttt{src1}^T\\texttt{src1}\\f$ ) is non-singular. Otherwise,\n. it returns 0. In the latter case, dst is not valid. Other methods find a\n. pseudo-solution in case of a singular left-hand side part.\n. \n. @note If you want to find a unity-norm solution of an under-defined\n. singular system \\f$\\texttt{src1}\\cdot\\texttt{dst}=0\\f$ , the function solve\n. will not do the work. Use SVD::solveZ instead.\n. \n. @param src1 input matrix on the left-hand side of the system.\n. @param src2 input matrix on the right-hand side of the system.\n. @param dst output solution.\n. @param flags solution (matrix inversion) method (#DecompTypes)\n. @sa invert, SVD, eigen' ... - def solveCubic(coeffs, roots=...) -> typing.Any: 'solveCubic(coeffs[, roots]) -> retval, roots\n. @brief Finds the real roots of a cubic equation.\n. \n. The function solveCubic finds the real roots of a cubic equation:\n. - if coeffs is a 4-element vector:\n. \\f[\\texttt{coeffs} [0] x^3 + \\texttt{coeffs} [1] x^2 + \\texttt{coeffs} [2] x + \\texttt{coeffs} [3] = 0\\f]\n. - if coeffs is a 3-element vector:\n. \\f[x^3 + \\texttt{coeffs} [0] x^2 + \\texttt{coeffs} [1] x + \\texttt{coeffs} [2] = 0\\f]\n. \n. The roots are stored in the roots array.\n. @param coeffs equation coefficients, an array of 3 or 4 elements.\n. @param roots output array of real roots that has 1 or 3 elements.\n. @return number of real roots. It can be 0, 1 or 2.' ... - def solveLP(Func, Constr, z=...) -> typing.Any: 'solveLP(Func, Constr[, z]) -> retval, z\n. @brief Solve given (non-integer) linear programming problem using the Simplex Algorithm (Simplex Method).\n. \n. What we mean here by "linear programming problem" (or LP problem, for short) can be formulated as:\n. \n. \\f[\\mbox{Maximize } c\\cdot x\\\\\n. \\mbox{Subject to:}\\\\\n. Ax\\leq b\\\\\n. x\\geq 0\\f]\n. \n. Where \\f$c\\f$ is fixed `1`-by-`n` row-vector, \\f$A\\f$ is fixed `m`-by-`n` matrix, \\f$b\\f$ is fixed `m`-by-`1`\n. column vector and \\f$x\\f$ is an arbitrary `n`-by-`1` column vector, which satisfies the constraints.\n. \n. Simplex algorithm is one of many algorithms that are designed to handle this sort of problems\n. efficiently. Although it is not optimal in theoretical sense (there exist algorithms that can solve\n. any problem written as above in polynomial time, while simplex method degenerates to exponential\n. time for some special cases), it is well-studied, easy to implement and is shown to work well for\n. real-life purposes.\n. \n. The particular implementation is taken almost verbatim from **Introduction to Algorithms, third\n. edition** by T. H. Cormen, C. E. Leiserson, R. L. Rivest and Clifford Stein. In particular, the\n. Bland\'s rule is used to prevent cycling.\n. \n. @param Func This row-vector corresponds to \\f$c\\f$ in the LP problem formulation (see above). It should\n. contain 32- or 64-bit floating point numbers. As a convenience, column-vector may be also submitted,\n. in the latter case it is understood to correspond to \\f$c^T\\f$.\n. @param Constr `m`-by-`n+1` matrix, whose rightmost column corresponds to \\f$b\\f$ in formulation above\n. and the remaining to \\f$A\\f$. It should contain 32- or 64-bit floating point numbers.\n. @param z The solution will be returned here as a column-vector - it corresponds to \\f$c\\f$ in the\n. formulation above. It will contain 64-bit floating point numbers.\n. @return One of cv::SolveLPResult' ... - def solveP3P(objectPoints, imagePoints, cameraMatrix, distCoeffs, flags: int, rvecs=..., tvecs=...) -> typing.Any: 'solveP3P(objectPoints, imagePoints, cameraMatrix, distCoeffs, flags[, rvecs[, tvecs]]) -> retval, rvecs, tvecs\n. @brief Finds an object pose from 3 3D-2D point correspondences.\n. \n. @param objectPoints Array of object points in the object coordinate space, 3x3 1-channel or\n. 1x3/3x1 3-channel. vector\\ can be also passed here.\n. @param imagePoints Array of corresponding image points, 3x2 1-channel or 1x3/3x1 2-channel.\n. vector\\ can be also passed here.\n. @param cameraMatrix Input camera matrix \\f$A = \\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\\f$ .\n. @param distCoeffs Input vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$ of\n. 4, 5, 8, 12 or 14 elements. If the vector is NULL/empty, the zero distortion coefficients are\n. assumed.\n. @param rvecs Output rotation vectors (see @ref Rodrigues ) that, together with tvecs, brings points from\n. the model coordinate system to the camera coordinate system. A P3P problem has up to 4 solutions.\n. @param tvecs Output translation vectors.\n. @param flags Method for solving a P3P problem:\n. - **SOLVEPNP_P3P** Method is based on the paper of X.S. Gao, X.-R. Hou, J. Tang, H.-F. Chang\n. "Complete Solution Classification for the Perspective-Three-Point Problem" (@cite gao2003complete).\n. - **SOLVEPNP_AP3P** Method is based on the paper of T. Ke and S. Roumeliotis.\n. "An Efficient Algebraic Solution to the Perspective-Three-Point Problem" (@cite Ke17).\n. \n. The function estimates the object pose given 3 object points, their corresponding image\n. projections, as well as the camera matrix and the distortion coefficients.\n. \n. @note\n. The solutions are sorted by reprojection errors (lowest to highest).' ... - def solvePnP(objectPoints, imagePoints, cameraMatrix, distCoeffs, rvec=..., tvec=..., useExtrinsicGuess=..., flags: int = ...) -> typing.Any: 'solvePnP(objectPoints, imagePoints, cameraMatrix, distCoeffs[, rvec[, tvec[, useExtrinsicGuess[, flags]]]]) -> retval, rvec, tvec\n. @brief Finds an object pose from 3D-2D point correspondences.\n. This function returns the rotation and the translation vectors that transform a 3D point expressed in the object\n. coordinate frame to the camera coordinate frame, using different methods:\n. - P3P methods (@ref SOLVEPNP_P3P, @ref SOLVEPNP_AP3P): need 4 input points to return a unique solution.\n. - @ref SOLVEPNP_IPPE Input points must be >= 4 and object points must be coplanar.\n. - @ref SOLVEPNP_IPPE_SQUARE Special case suitable for marker pose estimation.\n. Number of input points must be 4. Object points must be defined in the following order:\n. - point 0: [-squareLength / 2, squareLength / 2, 0]\n. - point 1: [ squareLength / 2, squareLength / 2, 0]\n. - point 2: [ squareLength / 2, -squareLength / 2, 0]\n. - point 3: [-squareLength / 2, -squareLength / 2, 0]\n. - for all the other flags, number of input points must be >= 4 and object points can be in any configuration.\n. \n. @param objectPoints Array of object points in the object coordinate space, Nx3 1-channel or\n. 1xN/Nx1 3-channel, where N is the number of points. vector\\ can be also passed here.\n. @param imagePoints Array of corresponding image points, Nx2 1-channel or 1xN/Nx1 2-channel,\n. where N is the number of points. vector\\ can be also passed here.\n. @param cameraMatrix Input camera matrix \\f$A = \\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\\f$ .\n. @param distCoeffs Input vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$ of\n. 4, 5, 8, 12 or 14 elements. If the vector is NULL/empty, the zero distortion coefficients are\n. assumed.\n. @param rvec Output rotation vector (see @ref Rodrigues ) that, together with tvec, brings points from\n. the model coordinate system to the camera coordinate system.\n. @param tvec Output translation vector.\n. @param useExtrinsicGuess Parameter used for #SOLVEPNP_ITERATIVE. If true (1), the function uses\n. the provided rvec and tvec values as initial approximations of the rotation and translation\n. vectors, respectively, and further optimizes them.\n. @param flags Method for solving a PnP problem:\n. - **SOLVEPNP_ITERATIVE** Iterative method is based on a Levenberg-Marquardt optimization. In\n. this case the function finds such a pose that minimizes reprojection error, that is the sum\n. of squared distances between the observed projections imagePoints and the projected (using\n. projectPoints ) objectPoints .\n. - **SOLVEPNP_P3P** Method is based on the paper of X.S. Gao, X.-R. Hou, J. Tang, H.-F. Chang\n. "Complete Solution Classification for the Perspective-Three-Point Problem" (@cite gao2003complete).\n. In this case the function requires exactly four object and image points.\n. - **SOLVEPNP_AP3P** Method is based on the paper of T. Ke, S. Roumeliotis\n. "An Efficient Algebraic Solution to the Perspective-Three-Point Problem" (@cite Ke17).\n. In this case the function requires exactly four object and image points.\n. - **SOLVEPNP_EPNP** Method has been introduced by F. Moreno-Noguer, V. Lepetit and P. Fua in the\n. paper "EPnP: Efficient Perspective-n-Point Camera Pose Estimation" (@cite lepetit2009epnp).\n. - **SOLVEPNP_DLS** Method is based on the paper of J. Hesch and S. Roumeliotis.\n. "A Direct Least-Squares (DLS) Method for PnP" (@cite hesch2011direct).\n. - **SOLVEPNP_UPNP** Method is based on the paper of A. Penate-Sanchez, J. Andrade-Cetto,\n. F. Moreno-Noguer. "Exhaustive Linearization for Robust Camera Pose and Focal Length\n. Estimation" (@cite penate2013exhaustive). In this case the function also estimates the parameters \\f$f_x\\f$ and \\f$f_y\\f$\n. assuming that both have the same value. Then the cameraMatrix is updated with the estimated\n. focal length.\n. - **SOLVEPNP_IPPE** Method is based on the paper of T. Collins and A. Bartoli.\n. "Infinitesimal Plane-Based Pose Estimation" (@cite Collins14). This method requires coplanar object points.\n. - **SOLVEPNP_IPPE_SQUARE** Method is based on the paper of Toby Collins and Adrien Bartoli.\n. "Infinitesimal Plane-Based Pose Estimation" (@cite Collins14). This method is suitable for marker pose estimation.\n. It requires 4 coplanar object points defined in the following order:\n. - point 0: [-squareLength / 2, squareLength / 2, 0]\n. - point 1: [ squareLength / 2, squareLength / 2, 0]\n. - point 2: [ squareLength / 2, -squareLength / 2, 0]\n. - point 3: [-squareLength / 2, -squareLength / 2, 0]\n. \n. The function estimates the object pose given a set of object points, their corresponding image\n. projections, as well as the camera matrix and the distortion coefficients, see the figure below\n. (more precisely, the X-axis of the camera frame is pointing to the right, the Y-axis downward\n. and the Z-axis forward).\n. \n. ![](pnp.jpg)\n. \n. Points expressed in the world frame \\f$ \\bf{X}_w \\f$ are projected into the image plane \\f$ \\left[ u, v \\right] \\f$\n. using the perspective projection model \\f$ \\Pi \\f$ and the camera intrinsic parameters matrix \\f$ \\bf{A} \\f$:\n. \n. \\f[\n. \\begin{align*}\n. \\begin{bmatrix}\n. u \\\\\n. v \\\\\n. 1\n. \\end{bmatrix} &=\n. \\bf{A} \\hspace{0.1em} \\Pi \\hspace{0.2em} ^{c}\\bf{T}_w\n. \\begin{bmatrix}\n. X_{w} \\\\\n. Y_{w} \\\\\n. Z_{w} \\\\\n. 1\n. \\end{bmatrix} \\\\\n. \\begin{bmatrix}\n. u \\\\\n. v \\\\\n. 1\n. \\end{bmatrix} &=\n. \\begin{bmatrix}\n. f_x & 0 & c_x \\\\\n. 0 & f_y & c_y \\\\\n. 0 & 0 & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. 1 & 0 & 0 & 0 \\\\\n. 0 & 1 & 0 & 0 \\\\\n. 0 & 0 & 1 & 0\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. r_{11} & r_{12} & r_{13} & t_x \\\\\n. r_{21} & r_{22} & r_{23} & t_y \\\\\n. r_{31} & r_{32} & r_{33} & t_z \\\\\n. 0 & 0 & 0 & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X_{w} \\\\\n. Y_{w} \\\\\n. Z_{w} \\\\\n. 1\n. \\end{bmatrix}\n. \\end{align*}\n. \\f]\n. \n. The estimated pose is thus the rotation (`rvec`) and the translation (`tvec`) vectors that allow transforming\n. a 3D point expressed in the world frame into the camera frame:\n. \n. \\f[\n. \\begin{align*}\n. \\begin{bmatrix}\n. X_c \\\\\n. Y_c \\\\\n. Z_c \\\\\n. 1\n. \\end{bmatrix} &=\n. \\hspace{0.2em} ^{c}\\bf{T}_w\n. \\begin{bmatrix}\n. X_{w} \\\\\n. Y_{w} \\\\\n. Z_{w} \\\\\n. 1\n. \\end{bmatrix} \\\\\n. \\begin{bmatrix}\n. X_c \\\\\n. Y_c \\\\\n. Z_c \\\\\n. 1\n. \\end{bmatrix} &=\n. \\begin{bmatrix}\n. r_{11} & r_{12} & r_{13} & t_x \\\\\n. r_{21} & r_{22} & r_{23} & t_y \\\\\n. r_{31} & r_{32} & r_{33} & t_z \\\\\n. 0 & 0 & 0 & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X_{w} \\\\\n. Y_{w} \\\\\n. Z_{w} \\\\\n. 1\n. \\end{bmatrix}\n. \\end{align*}\n. \\f]\n. \n. @note\n. - An example of how to use solvePnP for planar augmented reality can be found at\n. opencv_source_code/samples/python/plane_ar.py\n. - If you are using Python:\n. - Numpy array slices won\'t work as input because solvePnP requires contiguous\n. arrays (enforced by the assertion using cv::Mat::checkVector() around line 55 of\n. modules/calib3d/src/solvepnp.cpp version 2.4.9)\n. - The P3P algorithm requires image points to be in an array of shape (N,1,2) due\n. to its calling of cv::undistortPoints (around line 75 of modules/calib3d/src/solvepnp.cpp version 2.4.9)\n. which requires 2-channel information.\n. - Thus, given some data D = np.array(...) where D.shape = (N,M), in order to use a subset of\n. it as, e.g., imagePoints, one must effectively copy it into a new array: imagePoints =\n. np.ascontiguousarray(D[:,:2]).reshape((N,1,2))\n. - The methods **SOLVEPNP_DLS** and **SOLVEPNP_UPNP** cannot be used as the current implementations are\n. unstable and sometimes give completely wrong results. If you pass one of these two\n. flags, **SOLVEPNP_EPNP** method will be used instead.\n. - The minimum number of points is 4 in the general case. In the case of **SOLVEPNP_P3P** and **SOLVEPNP_AP3P**\n. methods, it is required to use exactly 4 points (the first 3 points are used to estimate all the solutions\n. of the P3P problem, the last one is used to retain the best solution that minimizes the reprojection error).\n. - With **SOLVEPNP_ITERATIVE** method and `useExtrinsicGuess=true`, the minimum number of points is 3 (3 points\n. are sufficient to compute a pose but there are up to 4 solutions). The initial solution should be close to the\n. global solution to converge.\n. - With **SOLVEPNP_IPPE** input points must be >= 4 and object points must be coplanar.\n. - With **SOLVEPNP_IPPE_SQUARE** this is a special case suitable for marker pose estimation.\n. Number of input points must be 4. Object points must be defined in the following order:\n. - point 0: [-squareLength / 2, squareLength / 2, 0]\n. - point 1: [ squareLength / 2, squareLength / 2, 0]\n. - point 2: [ squareLength / 2, -squareLength / 2, 0]\n. - point 3: [-squareLength / 2, -squareLength / 2, 0]' ... - def solvePnPGeneric(objectPoints, imagePoints, cameraMatrix, distCoeffs, rvecs=..., tvecs=..., useExtrinsicGuess=..., flags: int = ..., rvec=..., tvec=..., reprojectionError=...) -> typing.Any: 'solvePnPGeneric(objectPoints, imagePoints, cameraMatrix, distCoeffs[, rvecs[, tvecs[, useExtrinsicGuess[, flags[, rvec[, tvec[, reprojectionError]]]]]]]) -> retval, rvecs, tvecs, reprojectionError\n. @brief Finds an object pose from 3D-2D point correspondences.\n. This function returns a list of all the possible solutions (a solution is a \n. couple), depending on the number of input points and the chosen method:\n. - P3P methods (@ref SOLVEPNP_P3P, @ref SOLVEPNP_AP3P): 3 or 4 input points. Number of returned solutions can be between 0 and 4 with 3 input points.\n. - @ref SOLVEPNP_IPPE Input points must be >= 4 and object points must be coplanar. Returns 2 solutions.\n. - @ref SOLVEPNP_IPPE_SQUARE Special case suitable for marker pose estimation.\n. Number of input points must be 4 and 2 solutions are returned. Object points must be defined in the following order:\n. - point 0: [-squareLength / 2, squareLength / 2, 0]\n. - point 1: [ squareLength / 2, squareLength / 2, 0]\n. - point 2: [ squareLength / 2, -squareLength / 2, 0]\n. - point 3: [-squareLength / 2, -squareLength / 2, 0]\n. - for all the other flags, number of input points must be >= 4 and object points can be in any configuration.\n. Only 1 solution is returned.\n. \n. @param objectPoints Array of object points in the object coordinate space, Nx3 1-channel or\n. 1xN/Nx1 3-channel, where N is the number of points. vector\\ can be also passed here.\n. @param imagePoints Array of corresponding image points, Nx2 1-channel or 1xN/Nx1 2-channel,\n. where N is the number of points. vector\\ can be also passed here.\n. @param cameraMatrix Input camera matrix \\f$A = \\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\\f$ .\n. @param distCoeffs Input vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$ of\n. 4, 5, 8, 12 or 14 elements. If the vector is NULL/empty, the zero distortion coefficients are\n. assumed.\n. @param rvecs Vector of output rotation vectors (see @ref Rodrigues ) that, together with tvecs, brings points from\n. the model coordinate system to the camera coordinate system.\n. @param tvecs Vector of output translation vectors.\n. @param useExtrinsicGuess Parameter used for #SOLVEPNP_ITERATIVE. If true (1), the function uses\n. the provided rvec and tvec values as initial approximations of the rotation and translation\n. vectors, respectively, and further optimizes them.\n. @param flags Method for solving a PnP problem:\n. - **SOLVEPNP_ITERATIVE** Iterative method is based on a Levenberg-Marquardt optimization. In\n. this case the function finds such a pose that minimizes reprojection error, that is the sum\n. of squared distances between the observed projections imagePoints and the projected (using\n. projectPoints ) objectPoints .\n. - **SOLVEPNP_P3P** Method is based on the paper of X.S. Gao, X.-R. Hou, J. Tang, H.-F. Chang\n. "Complete Solution Classification for the Perspective-Three-Point Problem" (@cite gao2003complete).\n. In this case the function requires exactly four object and image points.\n. - **SOLVEPNP_AP3P** Method is based on the paper of T. Ke, S. Roumeliotis\n. "An Efficient Algebraic Solution to the Perspective-Three-Point Problem" (@cite Ke17).\n. In this case the function requires exactly four object and image points.\n. - **SOLVEPNP_EPNP** Method has been introduced by F.Moreno-Noguer, V.Lepetit and P.Fua in the\n. paper "EPnP: Efficient Perspective-n-Point Camera Pose Estimation" (@cite lepetit2009epnp).\n. - **SOLVEPNP_DLS** Method is based on the paper of Joel A. Hesch and Stergios I. Roumeliotis.\n. "A Direct Least-Squares (DLS) Method for PnP" (@cite hesch2011direct).\n. - **SOLVEPNP_UPNP** Method is based on the paper of A.Penate-Sanchez, J.Andrade-Cetto,\n. F.Moreno-Noguer. "Exhaustive Linearization for Robust Camera Pose and Focal Length\n. Estimation" (@cite penate2013exhaustive). In this case the function also estimates the parameters \\f$f_x\\f$ and \\f$f_y\\f$\n. assuming that both have the same value. Then the cameraMatrix is updated with the estimated\n. focal length.\n. - **SOLVEPNP_IPPE** Method is based on the paper of T. Collins and A. Bartoli.\n. "Infinitesimal Plane-Based Pose Estimation" (@cite Collins14). This method requires coplanar object points.\n. - **SOLVEPNP_IPPE_SQUARE** Method is based on the paper of Toby Collins and Adrien Bartoli.\n. "Infinitesimal Plane-Based Pose Estimation" (@cite Collins14). This method is suitable for marker pose estimation.\n. It requires 4 coplanar object points defined in the following order:\n. - point 0: [-squareLength / 2, squareLength / 2, 0]\n. - point 1: [ squareLength / 2, squareLength / 2, 0]\n. - point 2: [ squareLength / 2, -squareLength / 2, 0]\n. - point 3: [-squareLength / 2, -squareLength / 2, 0]\n. @param rvec Rotation vector used to initialize an iterative PnP refinement algorithm, when flag is SOLVEPNP_ITERATIVE\n. and useExtrinsicGuess is set to true.\n. @param tvec Translation vector used to initialize an iterative PnP refinement algorithm, when flag is SOLVEPNP_ITERATIVE\n. and useExtrinsicGuess is set to true.\n. @param reprojectionError Optional vector of reprojection error, that is the RMS error\n. (\\f$ \\text{RMSE} = \\sqrt{\\frac{\\sum_{i}^{N} \\left ( \\hat{y_i} - y_i \\right )^2}{N}} \\f$) between the input image points\n. and the 3D object points projected with the estimated pose.\n. \n. The function estimates the object pose given a set of object points, their corresponding image\n. projections, as well as the camera matrix and the distortion coefficients, see the figure below\n. (more precisely, the X-axis of the camera frame is pointing to the right, the Y-axis downward\n. and the Z-axis forward).\n. \n. ![](pnp.jpg)\n. \n. Points expressed in the world frame \\f$ \\bf{X}_w \\f$ are projected into the image plane \\f$ \\left[ u, v \\right] \\f$\n. using the perspective projection model \\f$ \\Pi \\f$ and the camera intrinsic parameters matrix \\f$ \\bf{A} \\f$:\n. \n. \\f[\n. \\begin{align*}\n. \\begin{bmatrix}\n. u \\\\\n. v \\\\\n. 1\n. \\end{bmatrix} &=\n. \\bf{A} \\hspace{0.1em} \\Pi \\hspace{0.2em} ^{c}\\bf{T}_w\n. \\begin{bmatrix}\n. X_{w} \\\\\n. Y_{w} \\\\\n. Z_{w} \\\\\n. 1\n. \\end{bmatrix} \\\\\n. \\begin{bmatrix}\n. u \\\\\n. v \\\\\n. 1\n. \\end{bmatrix} &=\n. \\begin{bmatrix}\n. f_x & 0 & c_x \\\\\n. 0 & f_y & c_y \\\\\n. 0 & 0 & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. 1 & 0 & 0 & 0 \\\\\n. 0 & 1 & 0 & 0 \\\\\n. 0 & 0 & 1 & 0\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. r_{11} & r_{12} & r_{13} & t_x \\\\\n. r_{21} & r_{22} & r_{23} & t_y \\\\\n. r_{31} & r_{32} & r_{33} & t_z \\\\\n. 0 & 0 & 0 & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X_{w} \\\\\n. Y_{w} \\\\\n. Z_{w} \\\\\n. 1\n. \\end{bmatrix}\n. \\end{align*}\n. \\f]\n. \n. The estimated pose is thus the rotation (`rvec`) and the translation (`tvec`) vectors that allow transforming\n. a 3D point expressed in the world frame into the camera frame:\n. \n. \\f[\n. \\begin{align*}\n. \\begin{bmatrix}\n. X_c \\\\\n. Y_c \\\\\n. Z_c \\\\\n. 1\n. \\end{bmatrix} &=\n. \\hspace{0.2em} ^{c}\\bf{T}_w\n. \\begin{bmatrix}\n. X_{w} \\\\\n. Y_{w} \\\\\n. Z_{w} \\\\\n. 1\n. \\end{bmatrix} \\\\\n. \\begin{bmatrix}\n. X_c \\\\\n. Y_c \\\\\n. Z_c \\\\\n. 1\n. \\end{bmatrix} &=\n. \\begin{bmatrix}\n. r_{11} & r_{12} & r_{13} & t_x \\\\\n. r_{21} & r_{22} & r_{23} & t_y \\\\\n. r_{31} & r_{32} & r_{33} & t_z \\\\\n. 0 & 0 & 0 & 1\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X_{w} \\\\\n. Y_{w} \\\\\n. Z_{w} \\\\\n. 1\n. \\end{bmatrix}\n. \\end{align*}\n. \\f]\n. \n. @note\n. - An example of how to use solvePnP for planar augmented reality can be found at\n. opencv_source_code/samples/python/plane_ar.py\n. - If you are using Python:\n. - Numpy array slices won\'t work as input because solvePnP requires contiguous\n. arrays (enforced by the assertion using cv::Mat::checkVector() around line 55 of\n. modules/calib3d/src/solvepnp.cpp version 2.4.9)\n. - The P3P algorithm requires image points to be in an array of shape (N,1,2) due\n. to its calling of cv::undistortPoints (around line 75 of modules/calib3d/src/solvepnp.cpp version 2.4.9)\n. which requires 2-channel information.\n. - Thus, given some data D = np.array(...) where D.shape = (N,M), in order to use a subset of\n. it as, e.g., imagePoints, one must effectively copy it into a new array: imagePoints =\n. np.ascontiguousarray(D[:,:2]).reshape((N,1,2))\n. - The methods **SOLVEPNP_DLS** and **SOLVEPNP_UPNP** cannot be used as the current implementations are\n. unstable and sometimes give completely wrong results. If you pass one of these two\n. flags, **SOLVEPNP_EPNP** method will be used instead.\n. - The minimum number of points is 4 in the general case. In the case of **SOLVEPNP_P3P** and **SOLVEPNP_AP3P**\n. methods, it is required to use exactly 4 points (the first 3 points are used to estimate all the solutions\n. of the P3P problem, the last one is used to retain the best solution that minimizes the reprojection error).\n. - With **SOLVEPNP_ITERATIVE** method and `useExtrinsicGuess=true`, the minimum number of points is 3 (3 points\n. are sufficient to compute a pose but there are up to 4 solutions). The initial solution should be close to the\n. global solution to converge.\n. - With **SOLVEPNP_IPPE** input points must be >= 4 and object points must be coplanar.\n. - With **SOLVEPNP_IPPE_SQUARE** this is a special case suitable for marker pose estimation.\n. Number of input points must be 4. Object points must be defined in the following order:\n. - point 0: [-squareLength / 2, squareLength / 2, 0]\n. - point 1: [ squareLength / 2, squareLength / 2, 0]\n. - point 2: [ squareLength / 2, -squareLength / 2, 0]\n. - point 3: [-squareLength / 2, -squareLength / 2, 0]' ... - def solvePnPRansac(objectPoints, imagePoints, cameraMatrix, distCoeffs, rvec=..., tvec=..., useExtrinsicGuess=..., iterationsCount=..., reprojectionError=..., confidence=..., inliers=..., flags: int = ...) -> typing.Any: 'solvePnPRansac(objectPoints, imagePoints, cameraMatrix, distCoeffs[, rvec[, tvec[, useExtrinsicGuess[, iterationsCount[, reprojectionError[, confidence[, inliers[, flags]]]]]]]]) -> retval, rvec, tvec, inliers\n. @brief Finds an object pose from 3D-2D point correspondences using the RANSAC scheme.\n. \n. @param objectPoints Array of object points in the object coordinate space, Nx3 1-channel or\n. 1xN/Nx1 3-channel, where N is the number of points. vector\\ can be also passed here.\n. @param imagePoints Array of corresponding image points, Nx2 1-channel or 1xN/Nx1 2-channel,\n. where N is the number of points. vector\\ can be also passed here.\n. @param cameraMatrix Input camera matrix \\f$A = \\vecthreethree{fx}{0}{cx}{0}{fy}{cy}{0}{0}{1}\\f$ .\n. @param distCoeffs Input vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$ of\n. 4, 5, 8, 12 or 14 elements. If the vector is NULL/empty, the zero distortion coefficients are\n. assumed.\n. @param rvec Output rotation vector (see @ref Rodrigues ) that, together with tvec, brings points from\n. the model coordinate system to the camera coordinate system.\n. @param tvec Output translation vector.\n. @param useExtrinsicGuess Parameter used for @ref SOLVEPNP_ITERATIVE. If true (1), the function uses\n. the provided rvec and tvec values as initial approximations of the rotation and translation\n. vectors, respectively, and further optimizes them.\n. @param iterationsCount Number of iterations.\n. @param reprojectionError Inlier threshold value used by the RANSAC procedure. The parameter value\n. is the maximum allowed distance between the observed and computed point projections to consider it\n. an inlier.\n. @param confidence The probability that the algorithm produces a useful result.\n. @param inliers Output vector that contains indices of inliers in objectPoints and imagePoints .\n. @param flags Method for solving a PnP problem (see @ref solvePnP ).\n. \n. The function estimates an object pose given a set of object points, their corresponding image\n. projections, as well as the camera matrix and the distortion coefficients. This function finds such\n. a pose that minimizes reprojection error, that is, the sum of squared distances between the observed\n. projections imagePoints and the projected (using @ref projectPoints ) objectPoints. The use of RANSAC\n. makes the function resistant to outliers.\n. \n. @note\n. - An example of how to use solvePNPRansac for object detection can be found at\n. opencv_source_code/samples/cpp/tutorial_code/calib3d/real_time_pose_estimation/\n. - The default method used to estimate the camera pose for the Minimal Sample Sets step\n. is #SOLVEPNP_EPNP. Exceptions are:\n. - if you choose #SOLVEPNP_P3P or #SOLVEPNP_AP3P, these methods will be used.\n. - if the number of input points is equal to 4, #SOLVEPNP_P3P is used.\n. - The method used to estimate the camera pose using all the inliers is defined by the\n. flags parameters unless it is equal to #SOLVEPNP_P3P or #SOLVEPNP_AP3P. In this case,\n. the method #SOLVEPNP_EPNP will be used instead.' ... - def solvePnPRefineLM(objectPoints, imagePoints, cameraMatrix, distCoeffs, rvec, tvec, criteria=...) -> typing.Any: 'solvePnPRefineLM(objectPoints, imagePoints, cameraMatrix, distCoeffs, rvec, tvec[, criteria]) -> rvec, tvec\n. @brief Refine a pose (the translation and the rotation that transform a 3D point expressed in the object coordinate frame\n. to the camera coordinate frame) from a 3D-2D point correspondences and starting from an initial solution.\n. \n. @param objectPoints Array of object points in the object coordinate space, Nx3 1-channel or 1xN/Nx1 3-channel,\n. where N is the number of points. vector\\ can also be passed here.\n. @param imagePoints Array of corresponding image points, Nx2 1-channel or 1xN/Nx1 2-channel,\n. where N is the number of points. vector\\ can also be passed here.\n. @param cameraMatrix Input camera matrix \\f$A = \\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\\f$ .\n. @param distCoeffs Input vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$ of\n. 4, 5, 8, 12 or 14 elements. If the vector is NULL/empty, the zero distortion coefficients are\n. assumed.\n. @param rvec Input/Output rotation vector (see @ref Rodrigues ) that, together with tvec, brings points from\n. the model coordinate system to the camera coordinate system. Input values are used as an initial solution.\n. @param tvec Input/Output translation vector. Input values are used as an initial solution.\n. @param criteria Criteria when to stop the Levenberg-Marquard iterative algorithm.\n. \n. The function refines the object pose given at least 3 object points, their corresponding image\n. projections, an initial solution for the rotation and translation vector,\n. as well as the camera matrix and the distortion coefficients.\n. The function minimizes the projection error with respect to the rotation and the translation vectors, according\n. to a Levenberg-Marquardt iterative minimization @cite Madsen04 @cite Eade13 process.' ... - def solvePnPRefineVVS(objectPoints, imagePoints, cameraMatrix, distCoeffs, rvec, tvec, criteria=..., VVSlambda=...) -> typing.Any: 'solvePnPRefineVVS(objectPoints, imagePoints, cameraMatrix, distCoeffs, rvec, tvec[, criteria[, VVSlambda]]) -> rvec, tvec\n. @brief Refine a pose (the translation and the rotation that transform a 3D point expressed in the object coordinate frame\n. to the camera coordinate frame) from a 3D-2D point correspondences and starting from an initial solution.\n. \n. @param objectPoints Array of object points in the object coordinate space, Nx3 1-channel or 1xN/Nx1 3-channel,\n. where N is the number of points. vector\\ can also be passed here.\n. @param imagePoints Array of corresponding image points, Nx2 1-channel or 1xN/Nx1 2-channel,\n. where N is the number of points. vector\\ can also be passed here.\n. @param cameraMatrix Input camera matrix \\f$A = \\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\\f$ .\n. @param distCoeffs Input vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$ of\n. 4, 5, 8, 12 or 14 elements. If the vector is NULL/empty, the zero distortion coefficients are\n. assumed.\n. @param rvec Input/Output rotation vector (see @ref Rodrigues ) that, together with tvec, brings points from\n. the model coordinate system to the camera coordinate system. Input values are used as an initial solution.\n. @param tvec Input/Output translation vector. Input values are used as an initial solution.\n. @param criteria Criteria when to stop the Levenberg-Marquard iterative algorithm.\n. @param VVSlambda Gain for the virtual visual servoing control law, equivalent to the \\f$\\alpha\\f$\n. gain in the Damped Gauss-Newton formulation.\n. \n. The function refines the object pose given at least 3 object points, their corresponding image\n. projections, an initial solution for the rotation and translation vector,\n. as well as the camera matrix and the distortion coefficients.\n. The function minimizes the projection error with respect to the rotation and the translation vectors, using a\n. virtual visual servoing (VVS) @cite Chaumette06 @cite Marchand16 scheme.' ... - def solvePoly(coeffs, roots=..., maxIters=...) -> typing.Any: 'solvePoly(coeffs[, roots[, maxIters]]) -> retval, roots\n. @brief Finds the real or complex roots of a polynomial equation.\n. \n. The function cv::solvePoly finds real and complex roots of a polynomial equation:\n. \\f[\\texttt{coeffs} [n] x^{n} + \\texttt{coeffs} [n-1] x^{n-1} + ... + \\texttt{coeffs} [1] x + \\texttt{coeffs} [0] = 0\\f]\n. @param coeffs array of polynomial coefficients.\n. @param roots output (complex) array of roots.\n. @param maxIters maximum number of iterations the algorithm does.' ... - -def sort(src: ndarray, flags: int, dts: ndarray = ...) -> typing.Any: +def sort(src: Mat, flags: int, dts: Mat = ...) -> typing.Any: 'sort(src, flags[, dst]) -> dst\n. @brief Sorts each row or each column of a matrix.\n. \n. The function cv::sort sorts each matrix row or each matrix column in\n. ascending or descending order. So you should pass two operation flags to\n. get desired behaviour. If you want to sort matrix rows or columns\n. lexicographically, you can use STL std::sort generic function with the\n. proper comparison predicate.\n. \n. @param src input single-channel array.\n. @param dst output array of the same size and type as src.\n. @param flags operation flags, a combination of #SortFlags\n. @sa sortIdx, randShuffle' ... - -def sortIdx(src: ndarray, flags: int, dts: ndarray = ...) -> typing.Any: +def sortIdx(src: Mat, flags: int, dts: Mat = ...) -> typing.Any: 'sortIdx(src, flags[, dst]) -> dst\n. @brief Sorts each row or each column of a matrix.\n. \n. The function cv::sortIdx sorts each matrix row or each matrix column in the\n. ascending or descending order. So you should pass two operation flags to\n. get desired behaviour. Instead of reordering the elements themselves, it\n. stores the indices of sorted elements in the output array. For example:\n. @code\n. Mat A = Mat::eye(3,3,CV_32F), B;\n. sortIdx(A, B, SORT_EVERY_ROW + SORT_ASCENDING);\n. // B will probably contain\n. // (because of equal elements in A some permutations are possible):\n. // [[1, 2, 0], [0, 2, 1], [0, 1, 2]]\n. @endcode\n. @param src input single-channel array.\n. @param dst output integer array of the same size as src.\n. @param flags operation flags that could be a combination of cv::SortFlags\n. @sa sort, randShuffle' ... - -def spatialGradient(src: ndarray, dx=..., dy=..., ksize=..., borderType=...) -> typing.Any: +def spatialGradient(src: Mat, dx=..., dy=..., ksize=..., borderType=...) -> typing.Any: 'spatialGradient(src[, dx[, dy[, ksize[, borderType]]]]) -> dx, dy\n. @brief Calculates the first order image derivative in both x and y using a Sobel operator\n. \n. Equivalent to calling:\n. \n. @code\n. Sobel( src, dx, CV_16SC1, 1, 0, 3 );\n. Sobel( src, dy, CV_16SC1, 0, 1, 3 );\n. @endcode\n. \n. @param src input image.\n. @param dx output image with first-order derivative in x.\n. @param dy output image with first-order derivative in y.\n. @param ksize size of Sobel kernel. It must be 3.\n. @param borderType pixel extrapolation method, see #BorderTypes.\n. Only #BORDER_DEFAULT=#BORDER_REFLECT_101 and #BORDER_REPLICATE are supported.\n. \n. @sa Sobel' ... - def split(m, mv=...) -> typing.Any: 'split(m[, mv]) -> mv\n. @overload\n. @param m input multi-channel array.\n. @param mv output vector of arrays; the arrays themselves are reallocated, if needed.' ... - -def sqrBoxFilter(src: ndarray, ddepth, ksize, dts: ndarray = ..., anchor=..., normalize=..., borderType=...) -> typing.Any: +def sqrBoxFilter(src: Mat, ddepth, ksize, dts: Mat = ..., anchor=..., normalize=..., borderType=...) -> typing.Any: "sqrBoxFilter(src, ddepth, ksize[, dst[, anchor[, normalize[, borderType]]]]) -> dst\n. @brief Calculates the normalized sum of squares of the pixel values overlapping the filter.\n. \n. For every pixel \\f$ (x, y) \\f$ in the source image, the function calculates the sum of squares of those neighboring\n. pixel values which overlap the filter placed over the pixel \\f$ (x, y) \\f$.\n. \n. The unnormalized square box filter can be useful in computing local image statistics such as the the local\n. variance and standard deviation around the neighborhood of a pixel.\n. \n. @param src input image\n. @param dst output image of the same size and type as _src\n. @param ddepth the output image depth (-1 to use src.depth())\n. @param ksize kernel size\n. @param anchor kernel anchor point. The default value of Point(-1, -1) denotes that the anchor is at the kernel\n. center.\n. @param normalize flag, specifying whether the kernel is to be normalized by it's area or not.\n. @param borderType border mode used to extrapolate pixels outside of the image, see #BorderTypes. #BORDER_WRAP is not supported.\n. @sa boxFilter" ... - -def sqrt(src: ndarray, dts: ndarray = ...) -> typing.Any: +def sqrt(src: Mat, dts: Mat = ...) -> typing.Any: 'sqrt(src[, dst]) -> dst\n. @brief Calculates a square root of array elements.\n. \n. The function cv::sqrt calculates a square root of each input array element.\n. In case of multi-channel arrays, each channel is processed\n. independently. The accuracy is approximately the same as of the built-in\n. std::sqrt .\n. @param src input floating-point array.\n. @param dst output array of the same size and type as src.' ... - def startWindowThread() -> typing.Any: 'startWindowThread() -> retval\n.' ... - def stereoCalibrate(objectPoints, imagePoints1, imagePoints2, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, imageSize, R=..., T=..., E=..., F=..., flags: int = ..., criteria=...) -> typing.Any: 'stereoCalibrate(objectPoints, imagePoints1, imagePoints2, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, imageSize[, R[, T[, E[, F[, flags[, criteria]]]]]]) -> retval, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, R, T, E, F\n.' ... - def stereoCalibrateExtended(objectPoints, imagePoints1, imagePoints2, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, imageSize, R, T, E=..., F=..., perViewErrors=..., flags: int = ..., criteria=...) -> typing.Any: "stereoCalibrateExtended(objectPoints, imagePoints1, imagePoints2, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, imageSize, R, T[, E[, F[, perViewErrors[, flags[, criteria]]]]]) -> retval, cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, R, T, E, F, perViewErrors\n. @brief Calibrates a stereo camera set up. This function finds the intrinsic parameters\n. for each of the two cameras and the extrinsic parameters between the two cameras.\n. \n. @param objectPoints Vector of vectors of the calibration pattern points. The same structure as\n. in @ref calibrateCamera. For each pattern view, both cameras need to see the same object\n. points. Therefore, objectPoints.size(), imagePoints1.size(), and imagePoints2.size() need to be\n. equal as well as objectPoints[i].size(), imagePoints1[i].size(), and imagePoints2[i].size() need to\n. be equal for each i.\n. @param imagePoints1 Vector of vectors of the projections of the calibration pattern points,\n. observed by the first camera. The same structure as in @ref calibrateCamera.\n. @param imagePoints2 Vector of vectors of the projections of the calibration pattern points,\n. observed by the second camera. The same structure as in @ref calibrateCamera.\n. @param cameraMatrix1 Input/output camera matrix for the first camera, the same as in\n. @ref calibrateCamera. Furthermore, for the stereo case, additional flags may be used, see below.\n. @param distCoeffs1 Input/output vector of distortion coefficients, the same as in\n. @ref calibrateCamera.\n. @param cameraMatrix2 Input/output second camera matrix for the second camera. See description for\n. cameraMatrix1.\n. @param distCoeffs2 Input/output lens distortion coefficients for the second camera. See\n. description for distCoeffs1.\n. @param imageSize Size of the image used only to initialize the intrinsic camera matrices.\n. @param R Output rotation matrix. Together with the translation vector T, this matrix brings\n. points given in the first camera's coordinate system to points in the second camera's\n. coordinate system. In more technical terms, the tuple of R and T performs a change of basis\n. from the first camera's coordinate system to the second camera's coordinate system. Due to its\n. duality, this tuple is equivalent to the position of the first camera with respect to the\n. second camera coordinate system.\n. @param T Output translation vector, see description above.\n. @param E Output essential matrix.\n. @param F Output fundamental matrix.\n. @param perViewErrors Output vector of the RMS re-projection error estimated for each pattern view.\n. @param flags Different flags that may be zero or a combination of the following values:\n. - **CALIB_FIX_INTRINSIC** Fix cameraMatrix? and distCoeffs? so that only R, T, E, and F\n. matrices are estimated.\n. - **CALIB_USE_INTRINSIC_GUESS** Optimize some or all of the intrinsic parameters\n. according to the specified flags. Initial values are provided by the user.\n. - **CALIB_USE_EXTRINSIC_GUESS** R and T contain valid initial values that are optimized further.\n. Otherwise R and T are initialized to the median value of the pattern views (each dimension separately).\n. - **CALIB_FIX_PRINCIPAL_POINT** Fix the principal points during the optimization.\n. - **CALIB_FIX_FOCAL_LENGTH** Fix \\f$f^{(j)}_x\\f$ and \\f$f^{(j)}_y\\f$ .\n. - **CALIB_FIX_ASPECT_RATIO** Optimize \\f$f^{(j)}_y\\f$ . Fix the ratio \\f$f^{(j)}_x/f^{(j)}_y\\f$\n. .\n. - **CALIB_SAME_FOCAL_LENGTH** Enforce \\f$f^{(0)}_x=f^{(1)}_x\\f$ and \\f$f^{(0)}_y=f^{(1)}_y\\f$ .\n. - **CALIB_ZERO_TANGENT_DIST** Set tangential distortion coefficients for each camera to\n. zeros and fix there.\n. - **CALIB_FIX_K1,...,CALIB_FIX_K6** Do not change the corresponding radial\n. distortion coefficient during the optimization. If CALIB_USE_INTRINSIC_GUESS is set,\n. the coefficient from the supplied distCoeffs matrix is used. Otherwise, it is set to 0.\n. - **CALIB_RATIONAL_MODEL** Enable coefficients k4, k5, and k6. To provide the backward\n. compatibility, this extra flag should be explicitly specified to make the calibration\n. function use the rational model and return 8 coefficients. If the flag is not set, the\n. function computes and returns only 5 distortion coefficients.\n. - **CALIB_THIN_PRISM_MODEL** Coefficients s1, s2, s3 and s4 are enabled. To provide the\n. backward compatibility, this extra flag should be explicitly specified to make the\n. calibration function use the thin prism model and return 12 coefficients. If the flag is not\n. set, the function computes and returns only 5 distortion coefficients.\n. - **CALIB_FIX_S1_S2_S3_S4** The thin prism distortion coefficients are not changed during\n. the optimization. If CALIB_USE_INTRINSIC_GUESS is set, the coefficient from the\n. supplied distCoeffs matrix is used. Otherwise, it is set to 0.\n. - **CALIB_TILTED_MODEL** Coefficients tauX and tauY are enabled. To provide the\n. backward compatibility, this extra flag should be explicitly specified to make the\n. calibration function use the tilted sensor model and return 14 coefficients. If the flag is not\n. set, the function computes and returns only 5 distortion coefficients.\n. - **CALIB_FIX_TAUX_TAUY** The coefficients of the tilted sensor model are not changed during\n. the optimization. If CALIB_USE_INTRINSIC_GUESS is set, the coefficient from the\n. supplied distCoeffs matrix is used. Otherwise, it is set to 0.\n. @param criteria Termination criteria for the iterative optimization algorithm.\n. \n. The function estimates the transformation between two cameras making a stereo pair. If one computes\n. the poses of an object relative to the first camera and to the second camera,\n. ( \\f$R_1\\f$,\\f$T_1\\f$ ) and (\\f$R_2\\f$,\\f$T_2\\f$), respectively, for a stereo camera where the\n. relative position and orientation between the two cameras are fixed, then those poses definitely\n. relate to each other. This means, if the relative position and orientation (\\f$R\\f$,\\f$T\\f$) of the\n. two cameras is known, it is possible to compute (\\f$R_2\\f$,\\f$T_2\\f$) when (\\f$R_1\\f$,\\f$T_1\\f$) is\n. given. This is what the described function does. It computes (\\f$R\\f$,\\f$T\\f$) such that:\n. \n. \\f[R_2=R R_1\\f]\n. \\f[T_2=R T_1 + T.\\f]\n. \n. Therefore, one can compute the coordinate representation of a 3D point for the second camera's\n. coordinate system when given the point's coordinate representation in the first camera's coordinate\n. system:\n. \n. \\f[\\begin{bmatrix}\n. X_2 \\\\\n. Y_2 \\\\\n. Z_2 \\\\\n. 1\n. \\end{bmatrix} = \\begin{bmatrix}\n. R & T \\\\\n. 0 & 1\n. \\end{bmatrix} \\begin{bmatrix}\n. X_1 \\\\\n. Y_1 \\\\\n. Z_1 \\\\\n. 1\n. \\end{bmatrix}.\\f]\n. \n. \n. Optionally, it computes the essential matrix E:\n. \n. \\f[E= \\vecthreethree{0}{-T_2}{T_1}{T_2}{0}{-T_0}{-T_1}{T_0}{0} R\\f]\n. \n. where \\f$T_i\\f$ are components of the translation vector \\f$T\\f$ : \\f$T=[T_0, T_1, T_2]^T\\f$ .\n. And the function can also compute the fundamental matrix F:\n. \n. \\f[F = cameraMatrix2^{-T}\\cdot E \\cdot cameraMatrix1^{-1}\\f]\n. \n. Besides the stereo-related information, the function can also perform a full calibration of each of\n. the two cameras. However, due to the high dimensionality of the parameter space and noise in the\n. input data, the function can diverge from the correct solution. If the intrinsic parameters can be\n. estimated with high accuracy for each of the cameras individually (for example, using\n. calibrateCamera ), you are recommended to do so and then pass CALIB_FIX_INTRINSIC flag to the\n. function along with the computed intrinsic parameters. Otherwise, if all the parameters are\n. estimated at once, it makes sense to restrict some parameters, for example, pass\n. CALIB_SAME_FOCAL_LENGTH and CALIB_ZERO_TANGENT_DIST flags, which is usually a\n. reasonable assumption.\n. \n. Similarly to calibrateCamera, the function minimizes the total re-projection error for all the\n. points in all the available views from both cameras. The function returns the final value of the\n. re-projection error." ... - def stereoRectify(cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, imageSize, R, T, R1=..., R2=..., P1=..., P2=..., Q=..., flags: int = ..., alpha=..., newImageSize=...) -> typing.Any: 'stereoRectify(cameraMatrix1, distCoeffs1, cameraMatrix2, distCoeffs2, imageSize, R, T[, R1[, R2[, P1[, P2[, Q[, flags[, alpha[, newImageSize]]]]]]]]) -> R1, R2, P1, P2, Q, validPixROI1, validPixROI2\n. @brief Computes rectification transforms for each head of a calibrated stereo camera.\n. \n. @param cameraMatrix1 First camera matrix.\n. @param distCoeffs1 First camera distortion parameters.\n. @param cameraMatrix2 Second camera matrix.\n. @param distCoeffs2 Second camera distortion parameters.\n. @param imageSize Size of the image used for stereo calibration.\n. @param R Rotation matrix from the coordinate system of the first camera to the second camera,\n. see @ref stereoCalibrate.\n. @param T Translation vector from the coordinate system of the first camera to the second camera,\n. see @ref stereoCalibrate.\n. @param R1 Output 3x3 rectification transform (rotation matrix) for the first camera. This matrix\n. brings points given in the unrectified first camera\'s coordinate system to points in the rectified\n. first camera\'s coordinate system. In more technical terms, it performs a change of basis from the\n. unrectified first camera\'s coordinate system to the rectified first camera\'s coordinate system.\n. @param R2 Output 3x3 rectification transform (rotation matrix) for the second camera. This matrix\n. brings points given in the unrectified second camera\'s coordinate system to points in the rectified\n. second camera\'s coordinate system. In more technical terms, it performs a change of basis from the\n. unrectified second camera\'s coordinate system to the rectified second camera\'s coordinate system.\n. @param P1 Output 3x4 projection matrix in the new (rectified) coordinate systems for the first\n. camera, i.e. it projects points given in the rectified first camera coordinate system into the\n. rectified first camera\'s image.\n. @param P2 Output 3x4 projection matrix in the new (rectified) coordinate systems for the second\n. camera, i.e. it projects points given in the rectified first camera coordinate system into the\n. rectified second camera\'s image.\n. @param Q Output \\f$4 \\times 4\\f$ disparity-to-depth mapping matrix (see @ref reprojectImageTo3D).\n. @param flags Operation flags that may be zero or CALIB_ZERO_DISPARITY . If the flag is set,\n. the function makes the principal points of each camera have the same pixel coordinates in the\n. rectified views. And if the flag is not set, the function may still shift the images in the\n. horizontal or vertical direction (depending on the orientation of epipolar lines) to maximize the\n. useful image area.\n. @param alpha Free scaling parameter. If it is -1 or absent, the function performs the default\n. scaling. Otherwise, the parameter should be between 0 and 1. alpha=0 means that the rectified\n. images are zoomed and shifted so that only valid pixels are visible (no black areas after\n. rectification). alpha=1 means that the rectified image is decimated and shifted so that all the\n. pixels from the original images from the cameras are retained in the rectified images (no source\n. image pixels are lost). Any intermediate value yields an intermediate result between\n. those two extreme cases.\n. @param newImageSize New image resolution after rectification. The same size should be passed to\n. initUndistortRectifyMap (see the stereo_calib.cpp sample in OpenCV samples directory). When (0,0)\n. is passed (default), it is set to the original imageSize . Setting it to a larger value can help you\n. preserve details in the original image, especially when there is a big radial distortion.\n. @param validPixROI1 Optional output rectangles inside the rectified images where all the pixels\n. are valid. If alpha=0 , the ROIs cover the whole images. Otherwise, they are likely to be smaller\n. (see the picture below).\n. @param validPixROI2 Optional output rectangles inside the rectified images where all the pixels\n. are valid. If alpha=0 , the ROIs cover the whole images. Otherwise, they are likely to be smaller\n. (see the picture below).\n. \n. The function computes the rotation matrices for each camera that (virtually) make both camera image\n. planes the same plane. Consequently, this makes all the epipolar lines parallel and thus simplifies\n. the dense stereo correspondence problem. The function takes the matrices computed by stereoCalibrate\n. as input. As output, it provides two rotation matrices and also two projection matrices in the new\n. coordinates. The function distinguishes the following two cases:\n. \n. - **Horizontal stereo**: the first and the second camera views are shifted relative to each other\n. mainly along the x-axis (with possible small vertical shift). In the rectified images, the\n. corresponding epipolar lines in the left and right cameras are horizontal and have the same\n. y-coordinate. P1 and P2 look like:\n. \n. \\f[\\texttt{P1} = \\begin{bmatrix}\n. f & 0 & cx_1 & 0 \\\\\n. 0 & f & cy & 0 \\\\\n. 0 & 0 & 1 & 0\n. \\end{bmatrix}\\f]\n. \n. \\f[\\texttt{P2} = \\begin{bmatrix}\n. f & 0 & cx_2 & T_x*f \\\\\n. 0 & f & cy & 0 \\\\\n. 0 & 0 & 1 & 0\n. \\end{bmatrix} ,\\f]\n. \n. where \\f$T_x\\f$ is a horizontal shift between the cameras and \\f$cx_1=cx_2\\f$ if\n. CALIB_ZERO_DISPARITY is set.\n. \n. - **Vertical stereo**: the first and the second camera views are shifted relative to each other\n. mainly in the vertical direction (and probably a bit in the horizontal direction too). The epipolar\n. lines in the rectified images are vertical and have the same x-coordinate. P1 and P2 look like:\n. \n. \\f[\\texttt{P1} = \\begin{bmatrix}\n. f & 0 & cx & 0 \\\\\n. 0 & f & cy_1 & 0 \\\\\n. 0 & 0 & 1 & 0\n. \\end{bmatrix}\\f]\n. \n. \\f[\\texttt{P2} = \\begin{bmatrix}\n. f & 0 & cx & 0 \\\\\n. 0 & f & cy_2 & T_y*f \\\\\n. 0 & 0 & 1 & 0\n. \\end{bmatrix},\\f]\n. \n. where \\f$T_y\\f$ is a vertical shift between the cameras and \\f$cy_1=cy_2\\f$ if\n. CALIB_ZERO_DISPARITY is set.\n. \n. As you can see, the first three columns of P1 and P2 will effectively be the new "rectified" camera\n. matrices. The matrices, together with R1 and R2 , can then be passed to initUndistortRectifyMap to\n. initialize the rectification map for each camera.\n. \n. See below the screenshot from the stereo_calib.cpp sample. Some red horizontal lines pass through\n. the corresponding image regions. This means that the images are well rectified, which is what most\n. stereo correspondence algorithms rely on. The green rectangles are roi1 and roi2 . You see that\n. their interiors are all valid pixels.\n. \n. ![image](pics/stereo_undistort.jpg)' ... - def stereoRectifyUncalibrated(points1, points2, F, imgSize, H1=..., H2=..., threshold=...) -> typing.Any: 'stereoRectifyUncalibrated(points1, points2, F, imgSize[, H1[, H2[, threshold]]]) -> retval, H1, H2\n. @brief Computes a rectification transform for an uncalibrated stereo camera.\n. \n. @param points1 Array of feature points in the first image.\n. @param points2 The corresponding points in the second image. The same formats as in\n. findFundamentalMat are supported.\n. @param F Input fundamental matrix. It can be computed from the same set of point pairs using\n. findFundamentalMat .\n. @param imgSize Size of the image.\n. @param H1 Output rectification homography matrix for the first image.\n. @param H2 Output rectification homography matrix for the second image.\n. @param threshold Optional threshold used to filter out the outliers. If the parameter is greater\n. than zero, all the point pairs that do not comply with the epipolar geometry (that is, the points\n. for which \\f$|\\texttt{points2[i]}^T*\\texttt{F}*\\texttt{points1[i]}|>\\texttt{threshold}\\f$ ) are\n. rejected prior to computing the homographies. Otherwise, all the points are considered inliers.\n. \n. The function computes the rectification transformations without knowing intrinsic parameters of the\n. cameras and their relative position in the space, which explains the suffix "uncalibrated". Another\n. related difference from stereoRectify is that the function outputs not the rectification\n. transformations in the object (3D) space, but the planar perspective transformations encoded by the\n. homography matrices H1 and H2 . The function implements the algorithm @cite Hartley99 .\n. \n. @note\n. While the algorithm does not need to know the intrinsic parameters of the cameras, it heavily\n. depends on the epipolar geometry. Therefore, if the camera lenses have a significant distortion,\n. it would be better to correct it before computing the fundamental matrix and calling this\n. function. For example, distortion coefficients can be estimated for each head of stereo camera\n. separately by using calibrateCamera . Then, the images can be corrected using undistort , or\n. just the point coordinates can be corrected with undistortPoints .' ... - -def stylization(src: ndarray, dts: ndarray = ..., sigma_s=..., sigma_r=...) -> typing.Any: +def stylization(src: Mat, dts: Mat = ..., sigma_s=..., sigma_r=...) -> typing.Any: 'stylization(src[, dst[, sigma_s[, sigma_r]]]) -> dst\n. @brief Stylization aims to produce digital imagery with a wide variety of effects not focused on\n. photorealism. Edge-aware filters are ideal for stylization, as they can abstract regions of low\n. contrast while preserving, or enhancing, high-contrast features.\n. \n. @param src Input 8-bit 3-channel image.\n. @param dst Output image with the same size and type as src.\n. @param sigma_s %Range between 0 to 200.\n. @param sigma_r %Range between 0 to 1.' ... - -def subtract(src1: ndarray, src2: ndarray, dts: ndarray = ..., mask: ndarray = ..., dtype=...) -> typing.Any: +def subtract(src1: Mat, src2: Mat, dts: Mat = ..., mask: Mat = ..., dtype=...) -> typing.Any: 'subtract(src1, src2[, dst[, mask[, dtype]]]) -> dst\n. @brief Calculates the per-element difference between two arrays or array and a scalar.\n. \n. The function subtract calculates:\n. - Difference between two arrays, when both input arrays have the same size and the same number of\n. channels:\n. \\f[\\texttt{dst}(I) = \\texttt{saturate} ( \\texttt{src1}(I) - \\texttt{src2}(I)) \\quad \\texttt{if mask}(I) \\ne0\\f]\n. - Difference between an array and a scalar, when src2 is constructed from Scalar or has the same\n. number of elements as `src1.channels()`:\n. \\f[\\texttt{dst}(I) = \\texttt{saturate} ( \\texttt{src1}(I) - \\texttt{src2} ) \\quad \\texttt{if mask}(I) \\ne0\\f]\n. - Difference between a scalar and an array, when src1 is constructed from Scalar or has the same\n. number of elements as `src2.channels()`:\n. \\f[\\texttt{dst}(I) = \\texttt{saturate} ( \\texttt{src1} - \\texttt{src2}(I) ) \\quad \\texttt{if mask}(I) \\ne0\\f]\n. - The reverse difference between a scalar and an array in the case of `SubRS`:\n. \\f[\\texttt{dst}(I) = \\texttt{saturate} ( \\texttt{src2} - \\texttt{src1}(I) ) \\quad \\texttt{if mask}(I) \\ne0\\f]\n. where I is a multi-dimensional index of array elements. In case of multi-channel arrays, each\n. channel is processed independently.\n. \n. The first function in the list above can be replaced with matrix expressions:\n. @code{.cpp}\n. dst = src1 - src2;\n. dst -= src1; // equivalent to subtract(dst, src1, dst);\n. @endcode\n. The input arrays and the output array can all have the same or different depths. For example, you\n. can subtract to 8-bit unsigned arrays and store the difference in a 16-bit signed array. Depth of\n. the output array is determined by dtype parameter. In the second and third cases above, as well as\n. in the first case, when src1.depth() == src2.depth(), dtype can be set to the default -1. In this\n. case the output array will have the same depth as the input array, be it src1, src2 or both.\n. @note Saturation is not applied when the output array has the depth CV_32S. You may even get\n. result of an incorrect sign in the case of overflow.\n. @param src1 first input array or a scalar.\n. @param src2 second input array or a scalar.\n. @param dst output array of the same size and the same number of channels as the input array.\n. @param mask optional operation mask; this is an 8-bit single channel array that specifies elements\n. of the output array to be changed.\n. @param dtype optional depth of the output array\n. @sa add, addWeighted, scaleAdd, Mat::convertTo' ... - def sumElems(src) -> typing.Any: 'sumElems(src) -> retval\n. @brief Calculates the sum of array elements.\n. \n. The function cv::sum calculates and returns the sum of array elements,\n. independently for each channel.\n. @param src input array that must have from 1 to 4 channels.\n. @sa countNonZero, mean, meanStdDev, norm, minMaxLoc, reduce' ... - -def textureFlattening(src: ndarray, mask: ndarray, dts: ndarray = ..., low_threshold=..., high_threshold=..., kernel_size=...) -> typing.Any: +def textureFlattening(src: Mat, mask: Mat, dts: Mat = ..., low_threshold=..., high_threshold=..., kernel_size=...) -> typing.Any: "textureFlattening(src, mask[, dst[, low_threshold[, high_threshold[, kernel_size]]]]) -> dst\n. @brief By retaining only the gradients at edge locations, before integrating with the Poisson solver, one\n. washes out the texture of the selected region, giving its contents a flat aspect. Here Canny Edge %Detector is used.\n. \n. @param src Input 8-bit 3-channel image.\n. @param mask Input 8-bit 1 or 3-channel image.\n. @param dst Output image with the same size and type as src.\n. @param low_threshold %Range from 0 to 100.\n. @param high_threshold Value \\> 100.\n. @param kernel_size The size of the Sobel kernel to be used.\n. \n. @note\n. The algorithm assumes that the color of the source image is close to that of the destination. This\n. assumption means that when the colors don't match, the source image color gets tinted toward the\n. color of the destination image." ... - -def threshold(src: ndarray, thresh, maxval, type, dts: ndarray = ...) -> typing.Any: +def threshold(src: Mat, thresh, maxval, type, dts: Mat = ...) -> typing.Any: "threshold(src, thresh, maxval, type[, dst]) -> retval, dst\n. @brief Applies a fixed-level threshold to each array element.\n. \n. The function applies fixed-level thresholding to a multiple-channel array. The function is typically\n. used to get a bi-level (binary) image out of a grayscale image ( #compare could be also used for\n. this purpose) or for removing a noise, that is, filtering out pixels with too small or too large\n. values. There are several types of thresholding supported by the function. They are determined by\n. type parameter.\n. \n. Also, the special values #THRESH_OTSU or #THRESH_TRIANGLE may be combined with one of the\n. above values. In these cases, the function determines the optimal threshold value using the Otsu's\n. or Triangle algorithm and uses it instead of the specified thresh.\n. \n. @note Currently, the Otsu's and Triangle methods are implemented only for 8-bit single-channel images.\n. \n. @param src input array (multiple-channel, 8-bit or 32-bit floating point).\n. @param dst output array of the same size and type and the same number of channels as src.\n. @param thresh threshold value.\n. @param maxval maximum value to use with the #THRESH_BINARY and #THRESH_BINARY_INV thresholding\n. types.\n. @param type thresholding type (see #ThresholdTypes).\n. @return the computed threshold value if Otsu's or Triangle methods used.\n. \n. @sa adaptiveThreshold, findContours, compare, min, max" ... - def trace(mtx) -> typing.Any: 'trace(mtx) -> retval\n. @brief Returns the trace of a matrix.\n. \n. The function cv::trace returns the sum of the diagonal elements of the\n. matrix mtx .\n. \\f[\\mathrm{tr} ( \\texttt{mtx} ) = \\sum _i \\texttt{mtx} (i,i)\\f]\n. @param mtx input matrix.' ... - -def transform(src: ndarray, m, dts: ndarray = ...) -> typing.Any: +def transform(src: Mat, m, dts: Mat = ...) -> typing.Any: 'transform(src, m[, dst]) -> dst\n. @brief Performs the matrix transformation of every array element.\n. \n. The function cv::transform performs the matrix transformation of every\n. element of the array src and stores the results in dst :\n. \\f[\\texttt{dst} (I) = \\texttt{m} \\cdot \\texttt{src} (I)\\f]\n. (when m.cols=src.channels() ), or\n. \\f[\\texttt{dst} (I) = \\texttt{m} \\cdot [ \\texttt{src} (I); 1]\\f]\n. (when m.cols=src.channels()+1 )\n. \n. Every element of the N -channel array src is interpreted as N -element\n. vector that is transformed using the M x N or M x (N+1) matrix m to\n. M-element vector - the corresponding element of the output array dst .\n. \n. The function may be used for geometrical transformation of\n. N -dimensional points, arbitrary linear color space transformation (such\n. as various kinds of RGB to YUV transforms), shuffling the image\n. channels, and so forth.\n. @param src input array that must have as many channels (1 to 4) as\n. m.cols or m.cols-1.\n. @param dst output array of the same size and depth as src; it has as\n. many channels as m.rows.\n. @param m transformation 2x2 or 2x3 floating-point matrix.\n. @sa perspectiveTransform, getAffineTransform, estimateAffine2D, warpAffine, warpPerspective' ... - -def transpose(src: ndarray, dts: ndarray = ...) -> typing.Any: +def transpose(src: Mat, dts: Mat = ...) -> typing.Any: 'transpose(src[, dst]) -> dst\n. @brief Transposes a matrix.\n. \n. The function cv::transpose transposes the matrix src :\n. \\f[\\texttt{dst} (i,j) = \\texttt{src} (j,i)\\f]\n. @note No complex conjugation is done in case of a complex matrix. It\n. should be done separately if needed.\n. @param src input array.\n. @param dst output array of the same type as src.' ... - def triangulatePoints(projMatr1, projMatr2, projPoints1, projPoints2, points4D=...) -> typing.Any: "triangulatePoints(projMatr1, projMatr2, projPoints1, projPoints2[, points4D]) -> points4D\n. @brief This function reconstructs 3-dimensional points (in homogeneous coordinates) by using\n. their observations with a stereo camera.\n. \n. @param projMatr1 3x4 projection matrix of the first camera, i.e. this matrix projects 3D points\n. given in the world's coordinate system into the first image.\n. @param projMatr2 3x4 projection matrix of the second camera, i.e. this matrix projects 3D points\n. given in the world's coordinate system into the second image.\n. @param projPoints1 2xN array of feature points in the first image. In the case of the c++ version,\n. it can be also a vector of feature points or two-channel matrix of size 1xN or Nx1.\n. @param projPoints2 2xN array of corresponding points in the second image. In the case of the c++\n. version, it can be also a vector of feature points or two-channel matrix of size 1xN or Nx1.\n. @param points4D 4xN array of reconstructed points in homogeneous coordinates. These points are\n. returned in the world's coordinate system.\n. \n. @note\n. Keep in mind that all input data should be of float type in order for this function to work.\n. \n. @note\n. If the projection matrices from @ref stereoRectify are used, then the returned points are\n. represented in the first camera's rectified coordinate system.\n. \n. @sa\n. reprojectImageTo3D" ... - -def undistort(src: ndarray, cameraMatrix, distCoeffs, dts: ndarray = ..., newCameraMatrix=...) -> typing.Any: +def undistort(src: Mat, cameraMatrix, distCoeffs, dts: Mat = ..., newCameraMatrix=...) -> typing.Any: 'undistort(src, cameraMatrix, distCoeffs[, dst[, newCameraMatrix]]) -> dst\n. @brief Transforms an image to compensate for lens distortion.\n. \n. The function transforms an image to compensate radial and tangential lens distortion.\n. \n. The function is simply a combination of #initUndistortRectifyMap (with unity R ) and #remap\n. (with bilinear interpolation). See the former function for details of the transformation being\n. performed.\n. \n. Those pixels in the destination image, for which there is no correspondent pixels in the source\n. image, are filled with zeros (black color).\n. \n. A particular subset of the source image that will be visible in the corrected image can be regulated\n. by newCameraMatrix. You can use #getOptimalNewCameraMatrix to compute the appropriate\n. newCameraMatrix depending on your requirements.\n. \n. The camera matrix and the distortion parameters can be determined using #calibrateCamera. If\n. the resolution of images is different from the resolution used at the calibration stage, \\f$f_x,\n. f_y, c_x\\f$ and \\f$c_y\\f$ need to be scaled accordingly, while the distortion coefficients remain\n. the same.\n. \n. @param src Input (distorted) image.\n. @param dst Output (corrected) image that has the same size and type as src .\n. @param cameraMatrix Input camera matrix \\f$A = \\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\\f$ .\n. @param distCoeffs Input vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6[, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$\n. of 4, 5, 8, 12 or 14 elements. If the vector is NULL/empty, the zero distortion coefficients are assumed.\n. @param newCameraMatrix Camera matrix of the distorted image. By default, it is the same as\n. cameraMatrix but you may additionally scale and shift the result by using a different matrix.' ... - -def undistortPoints(src: ndarray, cameraMatrix, distCoeffs, dts: ndarray = ..., R=..., P=...) -> typing.Any: +def undistortPoints(src: Mat, cameraMatrix, distCoeffs, dts: Mat = ..., R=..., P=...) -> typing.Any: 'undistortPoints(src, cameraMatrix, distCoeffs[, dst[, R[, P]]]) -> dst\n. @brief Computes the ideal point coordinates from the observed point coordinates.\n. \n. The function is similar to #undistort and #initUndistortRectifyMap but it operates on a\n. sparse set of points instead of a raster image. Also the function performs a reverse transformation\n. to projectPoints. In case of a 3D object, it does not reconstruct its 3D coordinates, but for a\n. planar object, it does, up to a translation vector, if the proper R is specified.\n. \n. For each observed point coordinate \\f$(u, v)\\f$ the function computes:\n. \\f[\n. \\begin{array}{l}\n. x^{"} \\leftarrow (u - c_x)/f_x \\\\\n. y^{"} \\leftarrow (v - c_y)/f_y \\\\\n. (x\',y\') = undistort(x^{"},y^{"}, \\texttt{distCoeffs}) \\\\\n. {[X\\,Y\\,W]} ^T \\leftarrow R*[x\' \\, y\' \\, 1]^T \\\\\n. x \\leftarrow X/W \\\\\n. y \\leftarrow Y/W \\\\\n. \\text{only performed if P is specified:} \\\\\n. u\' \\leftarrow x {f\'}_x + {c\'}_x \\\\\n. v\' \\leftarrow y {f\'}_y + {c\'}_y\n. \\end{array}\n. \\f]\n. \n. where *undistort* is an approximate iterative algorithm that estimates the normalized original\n. point coordinates out of the normalized distorted point coordinates ("normalized" means that the\n. coordinates do not depend on the camera matrix).\n. \n. The function can be used for both a stereo camera head or a monocular camera (when R is empty).\n. @param src Observed point coordinates, 2xN/Nx2 1-channel or 1xN/Nx1 2-channel (CV_32FC2 or CV_64FC2) (or\n. vector\\ ).\n. @param dst Output ideal point coordinates (1xN/Nx1 2-channel or vector\\ ) after undistortion and reverse perspective\n. transformation. If matrix P is identity or omitted, dst will contain normalized point coordinates.\n. @param cameraMatrix Camera matrix \\f$\\vecthreethree{f_x}{0}{c_x}{0}{f_y}{c_y}{0}{0}{1}\\f$ .\n. @param distCoeffs Input vector of distortion coefficients\n. \\f$(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6[, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]])\\f$\n. of 4, 5, 8, 12 or 14 elements. If the vector is NULL/empty, the zero distortion coefficients are assumed.\n. @param R Rectification transformation in the object space (3x3 matrix). R1 or R2 computed by\n. #stereoRectify can be passed here. If the matrix is empty, the identity transformation is used.\n. @param P New camera matrix (3x3) or new projection matrix (3x4) \\f$\\begin{bmatrix} {f\'}_x & 0 & {c\'}_x & t_x \\\\ 0 & {f\'}_y & {c\'}_y & t_y \\\\ 0 & 0 & 1 & t_z \\end{bmatrix}\\f$. P1 or P2 computed by\n. #stereoRectify can be passed here. If the matrix is empty, the identity new camera matrix is used.' ... - -def undistortPointsIter(src: ndarray, cameraMatrix, distCoeffs, R, P, criteria, dts: ndarray = ...) -> typing.Any: +def undistortPointsIter(src: Mat, cameraMatrix, distCoeffs, R, P, criteria, dts: Mat = ...) -> typing.Any: 'undistortPointsIter(src, cameraMatrix, distCoeffs, R, P, criteria[, dst]) -> dst\n. @overload\n. @note Default version of #undistortPoints does 5 iterations to compute undistorted points.' ... - def useOpenVX() -> typing.Any: 'useOpenVX() -> retval\n.' ... - def useOptimized() -> typing.Any: 'useOptimized() -> retval\n. @brief Returns the status of optimized code usage.\n. \n. The function returns true if the optimized code is enabled. Otherwise, it returns false.' ... - def validateDisparity(disparity, cost, minDisparity, numberOfDisparities, disp12MaxDisp=...) -> typing.Any: 'validateDisparity(disparity, cost, minDisparity, numberOfDisparities[, disp12MaxDisp]) -> disparity\n.' ... - -def vconcat(src: ndarray, dts: ndarray = ...) -> typing.Any: +def vconcat(src: Mat, dts: Mat = ...) -> typing.Any: 'vconcat(src[, dst]) -> dst\n. @overload\n. @code{.cpp}\n. std::vector matrices = { cv::Mat(1, 4, CV_8UC1, cv::Scalar(1)),\n. cv::Mat(1, 4, CV_8UC1, cv::Scalar(2)),\n. cv::Mat(1, 4, CV_8UC1, cv::Scalar(3)),};\n. \n. cv::Mat out;\n. cv::vconcat( matrices, out );\n. //out:\n. //[1, 1, 1, 1;\n. // 2, 2, 2, 2;\n. // 3, 3, 3, 3]\n. @endcode\n. @param src input array or vector of matrices. all of the matrices must have the same number of cols and the same depth\n. @param dst output array. It has the same number of cols and depth as the src, and the sum of rows of the src.\n. same depth.' ... - def waitKey(delay=...) -> typing.Any: 'waitKey([, delay]) -> retval\n. @brief Waits for a pressed key.\n. \n. The function waitKey waits for a key event infinitely (when \\f$\\texttt{delay}\\leq 0\\f$ ) or for delay\n. milliseconds, when it is positive. Since the OS has a minimum time between switching threads, the\n. function will not wait exactly delay ms, it will wait at least delay ms, depending on what else is\n. running on your computer at that time. It returns the code of the pressed key or -1 if no key was\n. pressed before the specified time had elapsed.\n. \n. @note\n. \n. This function is the only method in HighGUI that can fetch and handle events, so it needs to be\n. called periodically for normal event processing unless HighGUI is used within an environment that\n. takes care of event processing.\n. \n. @note\n. \n. The function only works if there is at least one HighGUI window created and the window is active.\n. If there are several HighGUI windows, any of them can be active.\n. \n. @param delay Delay in milliseconds. 0 is the special value that means "forever".' ... - def waitKeyEx(delay=...) -> typing.Any: 'waitKeyEx([, delay]) -> retval\n. @brief Similar to #waitKey, but returns full key code.\n. \n. @note\n. \n. Key code is implementation specific and depends on used backend: QT/GTK/Win32/etc' ... - -def warpAffine(src: ndarray, M, dsize: tuple[int, int], dts: ndarray = ..., flags: int = ..., borderMode=..., borderValue=...) -> typing.Any: +def warpAffine(src: Mat, M, dsize: typing.Tuple[int, int], dts: Mat = ..., flags: int = ..., borderMode=..., borderValue=...) -> typing.Any: 'warpAffine(src, M, dsize[, dst[, flags[, borderMode[, borderValue]]]]) -> dst\n. @brief Applies an affine transformation to an image.\n. \n. The function warpAffine transforms the source image using the specified matrix:\n. \n. \\f[\\texttt{dst} (x,y) = \\texttt{src} ( \\texttt{M} _{11} x + \\texttt{M} _{12} y + \\texttt{M} _{13}, \\texttt{M} _{21} x + \\texttt{M} _{22} y + \\texttt{M} _{23})\\f]\n. \n. when the flag #WARP_INVERSE_MAP is set. Otherwise, the transformation is first inverted\n. with #invertAffineTransform and then put in the formula above instead of M. The function cannot\n. operate in-place.\n. \n. @param src input image.\n. @param dst output image that has the size dsize and the same type as src .\n. @param M \\f$2\\times 3\\f$ transformation matrix.\n. @param dsize size of the output image.\n. @param flags combination of interpolation methods (see #InterpolationFlags) and the optional\n. flag #WARP_INVERSE_MAP that means that M is the inverse transformation (\n. \\f$\\texttt{dst}\\rightarrow\\texttt{src}\\f$ ).\n. @param borderMode pixel extrapolation method (see #BorderTypes); when\n. borderMode=#BORDER_TRANSPARENT, it means that the pixels in the destination image corresponding to\n. the "outliers" in the source image are not modified by the function.\n. @param borderValue value used in case of a constant border; by default, it is 0.\n. \n. @sa warpPerspective, resize, remap, getRectSubPix, transform' ... - -def warpPerspective(src: ndarray, M, dsize: tuple[int, int], dts: ndarray = ..., flags: int = ..., borderMode=..., borderValue=...) -> typing.Any: +def warpPerspective(src: Mat, M, dsize: typing.Tuple[int, int], dts: Mat = ..., flags: int = ..., borderMode=..., borderValue=...) -> typing.Any: 'warpPerspective(src, M, dsize[, dst[, flags[, borderMode[, borderValue]]]]) -> dst\n. @brief Applies a perspective transformation to an image.\n. \n. The function warpPerspective transforms the source image using the specified matrix:\n. \n. \\f[\\texttt{dst} (x,y) = \\texttt{src} \\left ( \\frac{M_{11} x + M_{12} y + M_{13}}{M_{31} x + M_{32} y + M_{33}} ,\n. \\frac{M_{21} x + M_{22} y + M_{23}}{M_{31} x + M_{32} y + M_{33}} \\right )\\f]\n. \n. when the flag #WARP_INVERSE_MAP is set. Otherwise, the transformation is first inverted with invert\n. and then put in the formula above instead of M. The function cannot operate in-place.\n. \n. @param src input image.\n. @param dst output image that has the size dsize and the same type as src .\n. @param M \\f$3\\times 3\\f$ transformation matrix.\n. @param dsize size of the output image.\n. @param flags combination of interpolation methods (#INTER_LINEAR or #INTER_NEAREST) and the\n. optional flag #WARP_INVERSE_MAP, that sets M as the inverse transformation (\n. \\f$\\texttt{dst}\\rightarrow\\texttt{src}\\f$ ).\n. @param borderMode pixel extrapolation method (#BORDER_CONSTANT or #BORDER_REPLICATE).\n. @param borderValue value used in case of a constant border; by default, it equals 0.\n. \n. @sa warpAffine, resize, remap, getRectSubPix, perspectiveTransform' ... - -def warpPolar(src: ndarray, dsize: tuple[int, int], center, maxRadius, flags: int, dts: ndarray = ...) -> typing.Any: - 'warpPolar(src, dsize: tuple[int, int], center, maxRadius, flags[, dst]) -> dst\n. \\brief Remaps an image to polar or semilog-polar coordinates space\n. \n. @anchor polar_remaps_reference_image\n. ![Polar remaps reference](pics/polar_remap_doc.png)\n. \n. Transform the source image using the following transformation:\n. \\f[\n. dst(\\rho , \\phi ) = src(x,y)\n. \\f]\n. \n. where\n. \\f[\n. \\begin{array}{l}\n. \\vec{I} = (x - center.x, \\;y - center.y) \\\\\n. \\phi = Kangle \\cdot \\texttt{angle} (\\vec{I}) \\\\\n. \\rho = \\left\\{\\begin{matrix}\n. Klin \\cdot \\texttt{magnitude} (\\vec{I}) & default \\\\\n. Klog \\cdot log_e(\\texttt{magnitude} (\\vec{I})) & if \\; semilog \\\\\n. \\end{matrix}\\right.\n. \\end{array}\n. \\f]\n. \n. and\n. \\f[\n. \\begin{array}{l}\n. Kangle = dsize.height / 2\\Pi \\\\\n. Klin = dsize.width / maxRadius \\\\\n. Klog = dsize.width / log_e(maxRadius) \\\\\n. \\end{array}\n. \\f]\n. \n. \n. \\par Linear vs semilog mapping\n. \n. Polar mapping can be linear or semi-log. Add one of #WarpPolarMode to `flags` to specify the polar mapping mode.\n. \n. Linear is the default mode.\n. \n. The semilog mapping emulates the human "foveal" vision that permit very high acuity on the line of sight (central vision)\n. in contrast to peripheral vision where acuity is minor.\n. \n. \\par Option on `dsize`:\n. \n. - if both values in `dsize <=0 ` (default),\n. the destination image will have (almost) same area of source bounding circle:\n. \\f[\\begin{array}{l}\n. dsize.area \\leftarrow (maxRadius^2 \\cdot \\Pi) \\\\\n. dsize.width = \\texttt{cvRound}(maxRadius) \\\\\n. dsize.height = \\texttt{cvRound}(maxRadius \\cdot \\Pi) \\\\\n. \\end{array}\\f]\n. \n. \n. - if only `dsize.height <= 0`,\n. the destination image area will be proportional to the bounding circle area but scaled by `Kx * Kx`:\n. \\f[\\begin{array}{l}\n. dsize.height = \\texttt{cvRound}(dsize.width \\cdot \\Pi) \\\\\n. \\end{array}\n. \\f]\n. \n. - if both values in `dsize > 0 `,\n. the destination image will have the given size therefore the area of the bounding circle will be scaled to `dsize`.\n. \n. \n. \\par Reverse mapping\n. \n. You can get reverse mapping adding #WARP_INVERSE_MAP to `flags`\n. \\snippet polar_transforms.cpp InverseMap\n. \n. In addiction, to calculate the original coordinate from a polar mapped coordinate \\f$(rho, phi)->(x, y)\\f$:\n. \\snippet polar_transforms.cpp InverseCoordinate\n. \n. @param src Source image.\n. @param dst Destination image. It will have same type as src.\n. @param dsize The destination image size (see description for valid options).\n. @param center The transformation center.\n. @param maxRadius The radius of the bounding circle to transform. It determines the inverse magnitude scale parameter too.\n. @param flags A combination of interpolation methods, #InterpolationFlags + #WarpPolarMode.\n. - Add #WARP_POLAR_LINEAR to select linear polar mapping (default)\n. - Add #WARP_POLAR_LOG to select semilog polar mapping\n. - Add #WARP_INVERSE_MAP for reverse mapping.\n. @note\n. - The function can not operate in-place.\n. - To calculate magnitude and angle in degrees #cartToPolar is used internally thus angles are measured from 0 to 360 with accuracy about 0.3 degrees.\n. - This function uses #remap. Due to current implementation limitations the size of an input and output images should be less than 32767x32767.\n. \n. @sa cv::remap' +def warpPolar(src: Mat, dsize: typing.Tuple[int, int], center, maxRadius, flags: int, dts: Mat = ...) -> typing.Any: + 'warpPolar(src, dsize: typing.Tuple[int, int], center, maxRadius, flags[, dst]) -> dst\n. \\brief Remaps an image to polar or semilog-polar coordinates space\n. \n. @anchor polar_remaps_reference_image\n. ![Polar remaps reference](pics/polar_remap_doc.png)\n. \n. Transform the source image using the following transformation:\n. \\f[\n. dst(\\rho , \\phi ) = src(x,y)\n. \\f]\n. \n. where\n. \\f[\n. \\begin{array}{l}\n. \\vec{I} = (x - center.x, \\;y - center.y) \\\\\n. \\phi = Kangle \\cdot \\texttt{angle} (\\vec{I}) \\\\\n. \\rho = \\left\\{\\begin{matrix}\n. Klin \\cdot \\texttt{magnitude} (\\vec{I}) & default \\\\\n. Klog \\cdot log_e(\\texttt{magnitude} (\\vec{I})) & if \\; semilog \\\\\n. \\end{matrix}\\right.\n. \\end{array}\n. \\f]\n. \n. and\n. \\f[\n. \\begin{array}{l}\n. Kangle = dsize.height / 2\\Pi \\\\\n. Klin = dsize.width / maxRadius \\\\\n. Klog = dsize.width / log_e(maxRadius) \\\\\n. \\end{array}\n. \\f]\n. \n. \n. \\par Linear vs semilog mapping\n. \n. Polar mapping can be linear or semi-log. Add one of #WarpPolarMode to `flags` to specify the polar mapping mode.\n. \n. Linear is the default mode.\n. \n. The semilog mapping emulates the human "foveal" vision that permit very high acuity on the line of sight (central vision)\n. in contrast to peripheral vision where acuity is minor.\n. \n. \\par Option on `dsize`:\n. \n. - if both values in `dsize <=0 ` (default),\n. the destination image will have (almost) same area of source bounding circle:\n. \\f[\\begin{array}{l}\n. dsize.area \\leftarrow (maxRadius^2 \\cdot \\Pi) \\\\\n. dsize.width = \\texttt{cvRound}(maxRadius) \\\\\n. dsize.height = \\texttt{cvRound}(maxRadius \\cdot \\Pi) \\\\\n. \\end{array}\\f]\n. \n. \n. - if only `dsize.height <= 0`,\n. the destination image area will be proportional to the bounding circle area but scaled by `Kx * Kx`:\n. \\f[\\begin{array}{l}\n. dsize.height = \\texttt{cvRound}(dsize.width \\cdot \\Pi) \\\\\n. \\end{array}\n. \\f]\n. \n. - if both values in `dsize > 0 `,\n. the destination image will have the given size therefore the area of the bounding circle will be scaled to `dsize`.\n. \n. \n. \\par Reverse mapping\n. \n. You can get reverse mapping adding #WARP_INVERSE_MAP to `flags`\n. \\snippet polar_transforms.cpp InverseMap\n. \n. In addiction, to calculate the original coordinate from a polar mapped coordinate \\f$(rho, phi)->(x, y)\\f$:\n. \\snippet polar_transforms.cpp InverseCoordinate\n. \n. @param src Source image.\n. @param dst Destination image. It will have same type as src.\n. @param dsize The destination image size (see description for valid options).\n. @param center The transformation center.\n. @param maxRadius The radius of the bounding circle to transform. It determines the inverse magnitude scale parameter too.\n. @param flags A combination of interpolation methods, #InterpolationFlags + #WarpPolarMode.\n. - Add #WARP_POLAR_LINEAR to select linear polar mapping (default)\n. - Add #WARP_POLAR_LOG to select semilog polar mapping\n. - Add #WARP_INVERSE_MAP for reverse mapping.\n. @note\n. - The function can not operate in-place.\n. - To calculate magnitude and angle in degrees #cartToPolar is used internally thus angles are measured from 0 to 360 with accuracy about 0.3 degrees.\n. - This function uses #remap. Due to current implementation limitations the size of an input and output images should be less than 32767x32767.\n. \n. @sa cv::remap' ... - -def watershed(image: ndarray, markers) -> typing.Any: +def watershed(image: Mat, markers) -> typing.Any: 'watershed(image, markers) -> markers\n. @brief Performs a marker-based image segmentation using the watershed algorithm.\n. \n. The function implements one of the variants of watershed, non-parametric marker-based segmentation\n. algorithm, described in @cite Meyer92 .\n. \n. Before passing the image to the function, you have to roughly outline the desired regions in the\n. image markers with positive (\\>0) indices. So, every region is represented as one or more connected\n. components with the pixel values 1, 2, 3, and so on. Such markers can be retrieved from a binary\n. mask using #findContours and #drawContours (see the watershed.cpp demo). The markers are "seeds" of\n. the future image regions. All the other pixels in markers , whose relation to the outlined regions\n. is not known and should be defined by the algorithm, should be set to 0\'s. In the function output,\n. each pixel in markers is set to a value of the "seed" components or to -1 at boundaries between the\n. regions.\n. \n. @note Any two neighbor connected components are not necessarily separated by a watershed boundary\n. (-1\'s pixels); for example, they can touch each other in the initial marker image passed to the\n. function.\n. \n. @param image Input 8-bit 3-channel image.\n. @param markers Input/output 32-bit single-channel image (map) of markers. It should have the same\n. size as image .\n. \n. @sa findContours\n. \n. @ingroup imgproc_misc' ... - def writeOpticalFlow(path, flow) -> typing.Any: 'writeOpticalFlow(path, flow) -> retval\n. @brief Write a .flo to disk\n. \n. @param path Path to the file to be written\n. @param flow Flow field to be stored\n. \n. The function stores a flow field in a file, returns true on success, false otherwise.\n. The flow field must be a 2-channel, floating-point matrix (CV_32FC2). First channel corresponds\n. to the flow in the horizontal direction (u), second - vertical (v).' ... - -def __getattr__(name) -> typing.Any: - ... +def __getattr__(name) -> typing.Any: ... #incomplete \ No newline at end of file diff --git a/typings/d3dshot/d3dshot.pyi b/typings/d3dshot/d3dshot.pyi index 2223a070..d6fd36db 100644 --- a/typings/d3dshot/d3dshot.pyi +++ b/typings/d3dshot/d3dshot.pyi @@ -60,7 +60,7 @@ class D3DShot(metaclass=Singleton): def get_frame_stack(self, frame_indices, stack_dimension=...) -> NDArray: ... - def screenshot(self, region: tuple[int, int, int, int] = ...) -> cv2.ndarray: + def screenshot(self, region: tuple[int, int, int, int] = ...) -> cv2.Mat: ... def screenshot_to_disk(self, directory=..., file_name=..., region: tuple[int, int, int, int] = ...) -> str: diff --git a/typings/keyboard/__init__.pyi b/typings/keyboard/__init__.pyi index 3b3d7e72..db06602a 100644 --- a/typings/keyboard/__init__.pyi +++ b/typings/keyboard/__init__.pyi @@ -199,7 +199,7 @@ def remap_key(src, dst) -> Callable[[], None]: unremap_key = ... -def parse_hotkey_combinations(hotkey) -> tuple[tuple[tuple[..., ...], ...], ...]: +def parse_hotkey_combinations(hotkey) -> tuple[tuple[tuple[str, ...], ...], ...]: ... @@ -208,7 +208,7 @@ _hotkeys: dict def add_hotkey( hotkey, - callback: Callback, + callback: Callable[[], None], args=..., suppress=..., timeout=..., From 3a88ae64e289ad114ddd256c23f5e618272407ff Mon Sep 17 00:00:00 2001 From: Avasam Date: Fri, 10 Jun 2022 00:34:10 -0400 Subject: [PATCH 066/137] Fixes #22 --- src/AutoSplit.py | 4 +++- src/menu_bar.py | 2 ++ src/region_capture.py | 6 +++++- src/region_selection.py | 16 ++++++++++++++++ src/user_profile.py | 2 ++ 5 files changed, 28 insertions(+), 2 deletions(-) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index a5171ff4..1fced7fd 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -756,6 +756,8 @@ def __get_capture_for_comparison(self): if hwnd: self.hwnd = hwnd if self.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + if self.windows_graphics_capture: + self.windows_graphics_capture.close() self.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) capture, _ = capture_region(self) return None if capture is None or not capture.size else cv2.resize( @@ -763,7 +765,7 @@ def __get_capture_for_comparison(self): def __reset_if_should(self, capture: Optional[cv2.Mat]): """ - Check if we should reset, resets if it's the case, and returns the result + Checks if we should reset, resets if it's the case, and returns the result """ if self.reset_image: similarity = self.reset_image.compare_with_capture(self, capture) diff --git a/src/menu_bar.py b/src/menu_bar.py index 16dd2b19..93b79e75 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -147,6 +147,8 @@ def __capture_method_changed(self): selected_capture_method = CAPTURE_METHODS.get_method_by_index(self.capture_method_combobox.currentIndex()) # Release or start video capture device self.__capture_device_changed(selected_capture_method) + if self.autosplit.windows_graphics_capture: + self.autosplit.windows_graphics_capture.close() self.autosplit.windows_graphics_capture = None if selected_capture_method == CaptureMethod.VIDEO_CAPTURE_DEVICE: self.autosplit.select_region_button.setDisabled(True) diff --git a/src/region_capture.py b/src/region_capture.py index d8052fa5..bfd5f3ac 100644 --- a/src/region_capture.py +++ b/src/region_capture.py @@ -96,7 +96,11 @@ def __windows_graphics_capture(windows_graphics_capture: Optional[WindowsGraphic if not windows_graphics_capture or not windows_graphics_capture.frame_pool: return None, False - frame = windows_graphics_capture.frame_pool.try_get_next_frame() + try: + frame = windows_graphics_capture.frame_pool.try_get_next_frame() + # Frame pool is closed + except OSError: + return None, False if not frame: return windows_graphics_capture.last_captured_frame, True diff --git a/src/region_selection.py b/src/region_selection.py index 0cbabbcb..8f99a7e5 100644 --- a/src/region_selection.py +++ b/src/region_selection.py @@ -78,6 +78,8 @@ def select_region(autosplit: AutoSplit): autosplit.hwnd = hwnd autosplit.settings_dict["captured_window_title"] = window_text if autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + if autosplit.windows_graphics_capture: + autosplit.windows_graphics_capture.close() autosplit.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) offset_x, offset_y, *_ = win32gui.GetWindowRect(hwnd) @@ -96,6 +98,16 @@ class WindowsGraphicsCapture: session: GraphicsCaptureSession last_captured_frame: Optional[cv2.Mat] + def close(self): + self.frame_pool.close() + try: + self.session.close() + except OSError: + # OSError: The application called an interface that was marshalled for a different thread + # This still seems to close the session and prevent the following hard crash in LiveSplit + # "AutoSplit.exe " + pass + def create_windows_graphics_capture(item: GraphicsCaptureItem): # Note: Must create in the same thread (can't use a global) otherwise when ran from LiveSplit it will raise: @@ -142,6 +154,8 @@ def callback(async_operation: IAsyncOperation[GraphicsCaptureItem], async_status if not item: return autosplit.settings_dict["captured_window_title"] = item.display_name + if autosplit.windows_graphics_capture: + autosplit.windows_graphics_capture.close() autosplit.windows_graphics_capture = create_windows_graphics_capture(item) picker = GraphicsCapturePicker() @@ -175,6 +189,8 @@ def select_window(autosplit: AutoSplit): autosplit.hwnd = hwnd autosplit.settings_dict["captured_window_title"] = window_text if autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + if autosplit.windows_graphics_capture: + autosplit.windows_graphics_capture.close() autosplit.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) # Getting window bounds diff --git a/src/user_profile.py b/src/user_profile.py index ffe7a5af..1cc77de4 100644 --- a/src/user_profile.py +++ b/src/user_profile.py @@ -153,6 +153,8 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str if hwnd: autosplit.hwnd = hwnd if autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: + if autosplit.windows_graphics_capture: + autosplit.windows_graphics_capture.close() autosplit.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) else: autosplit.live_image.setText("Reload settings after opening" From 51888f3e2ed5a48299308735ba55bbd3d48265e0 Mon Sep 17 00:00:00 2001 From: Avasam Date: Fri, 10 Jun 2022 14:59:06 -0400 Subject: [PATCH 067/137] Reset image now indicates that its paused when starting a run --- src/AutoSplit.py | 17 ++++++++++------- src/AutoSplitImage.py | 2 +- 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 1fced7fd..058ff99c 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -771,16 +771,19 @@ def __reset_if_should(self, capture: Optional[cv2.Mat]): similarity = self.reset_image.compare_with_capture(self, capture) threshold = self.reset_image.get_similarity_threshold(self) - if similarity > self.reset_highest_similarity: - self.reset_highest_similarity = similarity + paused = time() - self.run_start_time <= self.reset_image.get_pause_time(self) + if paused: + should_reset = False + self.table_reset_image_live_label.setText("paused") + else: + should_reset = similarity >= threshold + if similarity > self.reset_highest_similarity: + self.reset_highest_similarity = similarity + self.table_reset_image_highest_label.setText(f"{self.reset_highest_similarity:.2f}") + self.table_reset_image_live_label.setText(f"{similarity:.2f}") - self.table_reset_image_live_label.setText(f"{similarity:.2f}") - self.table_reset_image_highest_label.setText(f"{self.reset_highest_similarity:.2f}") self.table_reset_image_threshold_label.setText(f"{threshold:.2f}") - should_reset = similarity >= threshold \ - and time() - self.run_start_time > self.reset_image.get_pause_time(self) - if should_reset: send_command(self, "reset") self.reset() diff --git a/src/AutoSplitImage.py b/src/AutoSplitImage.py index ab323e36..f2358553 100644 --- a/src/AutoSplitImage.py +++ b/src/AutoSplitImage.py @@ -21,7 +21,7 @@ LOWER_BOUND = np.array([0, 0, 0, 1], dtype="uint8") UPPER_BOUND = np.array([MAXBYTE, MAXBYTE, MAXBYTE, MAXBYTE], dtype="uint8") START_KEYWORD = "start_auto_splitter" -RESET_KEYWORD = "RESET" +RESET_KEYWORD = "reset" class ImageType(Enum): From 8027d1f46dad3f4214e929911f64809a4ace80ef Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 11 Jun 2022 13:41:08 -0400 Subject: [PATCH 068/137] Updated pyright and some scripts --- .github/workflows/lint-and-build.yml | 1 + scripts/compile_resources.bat | 4 +++- scripts/install.bat | 4 ++-- src/AutoSplit.py | 15 ++++++++++++--- src/CaptureMethod.py | 4 ++-- src/region_capture.py | 4 ++-- src/region_selection.py | 3 ++- typings/cv2-stubs/__init__.pyi | 11 ++++++++++- 8 files changed, 34 insertions(+), 12 deletions(-) diff --git a/.github/workflows/lint-and-build.yml b/.github/workflows/lint-and-build.yml index 71964c9e..564d00bf 100644 --- a/.github/workflows/lint-and-build.yml +++ b/.github/workflows/lint-and-build.yml @@ -42,6 +42,7 @@ jobs: pip install wheel pip install -r "scripts/requirements.txt" npm install -g pyright + npm list -g pyright - run: scripts/compile_resources.bat - name: Analysing the code with ${{ github.job }} run: pyright --warnings diff --git a/scripts/compile_resources.bat b/scripts/compile_resources.bat index d5ef6cf0..ba578623 100644 --- a/scripts/compile_resources.bat +++ b/scripts/compile_resources.bat @@ -1,5 +1,7 @@ cd "%~dp0.." -md .\src\gen +@ if not exist .\src\gen ( + md .\src\gen +) pyuic6 ".\res\about.ui" -o ".\src\gen\about.py" pyuic6 ".\res\design.ui" -o ".\src\gen\design.py" pyuic6 ".\res\settings.ui" -o ".\src\gen\settings.py" diff --git a/scripts/install.bat b/scripts/install.bat index 1c47701e..dc100614 100644 --- a/scripts/install.bat +++ b/scripts/install.bat @@ -1,5 +1,5 @@ py -m pip install wheel --upgrade py -m pip install -r "%~p0requirements.txt" --upgrade -npm install -g pyright@latest -npm list -g pyright CALL "%~p0compile_resources.bat" +CALL npm install -g pyright@latest +CALL npm list -g pyright diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 058ff99c..ded4697f 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -758,10 +758,19 @@ def __get_capture_for_comparison(self): if self.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: if self.windows_graphics_capture: self.windows_graphics_capture.close() - self.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) + try: + self.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) + # Unrecordable hwnd found as the game is crashing + except OSError as exception: + if str(exception).endswith("The parameter is incorrect"): + return None, is_old_image + raise capture, _ = capture_region(self) - return None if capture is None or not capture.size else cv2.resize( - capture, COMPARISON_RESIZE, interpolation=cv2.INTER_NEAREST), is_old_image + + return (None + if capture is None or not capture.size + else cv2.resize(capture, COMPARISON_RESIZE, interpolation=cv2.INTER_NEAREST), + is_old_image) def __reset_if_should(self, capture: Optional[cv2.Mat]): """ diff --git a/src/CaptureMethod.py b/src/CaptureMethod.py index 7b506c62..9d21dabc 100644 --- a/src/CaptureMethod.py +++ b/src/CaptureMethod.py @@ -147,13 +147,13 @@ async def get_all_video_capture_devices(): device_range_to_test = range(len(named_video_inputs) + 5) async def get_camera_info(index: int): - video_capture = cv2.VideoCapture(index) # pyright: ignore [reportUnknownVariableType] + video_capture = cv2.VideoCapture(index) video_capture.setExceptionMode(True) backend = "" device_name = named_video_inputs[index] if index < len(named_video_inputs) else f"Camera {index}" try: # https://docs.opencv.org/3.4/d4/d15/group__videoio__flags__base.html#ga023786be1ee68a9105bf2e48c700294d - backend: str = video_capture.getBackendName() + backend = video_capture.getBackendName() video_capture.grab() except cv2.error as error: # pyright: ignore [reportUnknownVariableType] return CameraInfo(index, device_name, True, backend) \ diff --git a/src/region_capture.py b/src/region_capture.py index bfd5f3ac..8c5b0d1f 100644 --- a/src/region_capture.py +++ b/src/region_capture.py @@ -139,8 +139,8 @@ def __camera_capture(capture_device: Optional[cv2.VideoCapture], selection: Regi if not result: return None # Ensure we can't go OOB of the image - y = min(selection["y"], image.shape[0] - 1) # pyright: ignore [reportUnusedVariable] - x = min(selection["x"], image.shape[1] - 1) # pyright: ignore [reportUnusedVariable] + y = min(selection["y"], image.shape[0] - 1) + x = min(selection["x"], image.shape[1] - 1) image = image[ y:selection["height"] + y, x:selection["width"] + x, diff --git a/src/region_selection.py b/src/region_selection.py index 8f99a7e5..3d725fa0 100644 --- a/src/region_selection.py +++ b/src/region_selection.py @@ -105,7 +105,8 @@ def close(self): except OSError: # OSError: The application called an interface that was marshalled for a different thread # This still seems to close the session and prevent the following hard crash in LiveSplit - # "AutoSplit.exe " + # pylint: disable=line-too-long + # "AutoSplit.exe " # noqa: E501 pass diff --git a/typings/cv2-stubs/__init__.pyi b/typings/cv2-stubs/__init__.pyi index 1243f931..cd2b198f 100644 --- a/typings/cv2-stubs/__init__.pyi +++ b/typings/cv2-stubs/__init__.pyi @@ -1575,7 +1575,16 @@ def VariationalRefinement_create() -> typing.Any: 'VariationalRefinement_create() -> retval\n. @brief Creates an instance of VariationalRefinement' ... -VideoCapture = _mod_cv2.VideoCapture +class VideoCapture(): + name: str + device_id: int + def __init__(self, device_id: int): ... + def grab(self): ... + def read(self) -> typing.Tuple[bool, Mat]: ... + def release(self): ... + def setExceptionMode(self, error: bool): ... + def getBackendName(self) -> str: ... + VideoWriter = _mod_cv2.VideoWriter def VideoWriter_fourcc(c1, c2, c3, c4) -> typing.Any: 'VideoWriter_fourcc(c1, c2, c3, c4) -> retval\n. @brief Concatenates 4 chars to a fourcc code\n. \n. @return a fourcc code\n. \n. This static method constructs the fourcc code of the codec to be used in the constructor\n. VideoWriter::VideoWriter or VideoWriter::open.' From fc21a2b2155aaf5de7f8cbbeae2dca05a4b4f4f9 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 11 Jun 2022 14:48:27 -0400 Subject: [PATCH 069/137] headless opencv is enough --- scripts/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/requirements.txt b/scripts/requirements.txt index 2c0bed48..a92e32e8 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -11,7 +11,7 @@ # # Dependencies: numpy>=1.22.0rc1 -opencv-python>=4.5.4 +opencv-python-headless>=4.5.4,<4.6 PyQt6>=6.2.1 PySide6 ImageHash From a4dda9dc64fbd2aade5dadc686c22e8bfaf01faf Mon Sep 17 00:00:00 2001 From: Avasam Date: Wed, 15 Jun 2022 01:39:04 -0400 Subject: [PATCH 070/137] Updated versioning --- .github/workflows/lint-and-build.yml | 24 ++++++++++++------------ scripts/install.bat | 2 +- scripts/requirements.txt | 2 +- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/.github/workflows/lint-and-build.yml b/.github/workflows/lint-and-build.yml index 564d00bf..406e9ba8 100644 --- a/.github/workflows/lint-and-build.yml +++ b/.github/workflows/lint-and-build.yml @@ -29,11 +29,11 @@ jobs: python-version: ["3.9", "3.10"] steps: - name: Checkout ${{ github.repository }}/${{ github.ref }} - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: Set up Node - uses: actions/setup-node@v2 + uses: actions/setup-node@v3 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v2 + uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} - name: Install dependencies @@ -54,9 +54,9 @@ jobs: python-version: ["3.9", "3.10"] steps: - name: Checkout ${{ github.repository }}/${{ github.ref }} - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v2 + uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} - name: Install dependencies @@ -75,9 +75,9 @@ jobs: python-version: ["3.9", "3.10"] steps: - name: Checkout ${{ github.repository }}/${{ github.ref }} - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v2 + uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} - name: Install dependencies @@ -96,9 +96,9 @@ jobs: python-version: ["3.9", "3.10"] steps: - name: Checkout ${{ github.repository }}/${{ github.ref }} - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v2 + uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} - name: Install dependencies @@ -117,9 +117,9 @@ jobs: python-version: ["3.9", "3.10"] steps: - name: Checkout ${{ github.repository }}/${{ github.ref }} - uses: actions/checkout@v2 + uses: actions/checkout@v3 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v2 + uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} - name: Install dependencies @@ -129,7 +129,7 @@ jobs: pip install -r "scripts/requirements.txt" - run: scripts/build.bat - name: Upload Build Artifact - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v3 with: name: AutoSplit (Python ${{ matrix.python-version }}) path: dist/AutoSplit.exe diff --git a/scripts/install.bat b/scripts/install.bat index dc100614..bdfaf136 100644 --- a/scripts/install.bat +++ b/scripts/install.bat @@ -1,5 +1,5 @@ py -m pip install wheel --upgrade -py -m pip install -r "%~p0requirements.txt" --upgrade +py -m pip install -r "%~p0requirements.txt" CALL "%~p0compile_resources.bat" CALL npm install -g pyright@latest CALL npm list -g pyright diff --git a/scripts/requirements.txt b/scripts/requirements.txt index a92e32e8..640adca7 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -10,7 +10,7 @@ # Creating AutoSplit.exe with PyInstaller: .\scripts\build.bat # # Dependencies: -numpy>=1.22.0rc1 +numpy>=1.22.0rc1,<1.23 opencv-python-headless>=4.5.4,<4.6 PyQt6>=6.2.1 PySide6 From 0e6ce0b29e449081932922c98deab7e66a33a3dc Mon Sep 17 00:00:00 2001 From: Avasam Date: Wed, 15 Jun 2022 03:12:12 -0400 Subject: [PATCH 071/137] Set camera size --- src/menu_bar.py | 3 +++ src/user_profile.py | 3 +++ typings/cv2-stubs/__init__.pyi | 6 ++++-- 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/src/menu_bar.py b/src/menu_bar.py index 93b79e75..f57f6990 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -16,6 +16,7 @@ import error_messages import user_profile +from AutoSplitImage import COMPARISON_RESIZE_HEIGHT, COMPARISON_RESIZE_WIDTH from CaptureMethod import CAPTURE_METHODS, CameraInfo, CaptureMethod, get_all_video_capture_devices from gen import about, design, resources_rc, settings as settings_ui, update_checker # noqa: F401 from hotkeys import set_hotkey @@ -178,6 +179,8 @@ def __capture_device_changed(self, current_capture_method: Optional[Union[Captur if current_capture_method == CaptureMethod.VIDEO_CAPTURE_DEVICE: self.autosplit.settings_dict["capture_device_name"] = capture_device.name self.autosplit.capture_device = cv2.VideoCapture(capture_device.device_id) + self.autosplit.capture_device.set(cv2.CAP_PROP_FRAME_WIDTH, COMPARISON_RESIZE_WIDTH) + self.autosplit.capture_device.set(cv2.CAP_PROP_FRAME_HEIGHT, COMPARISON_RESIZE_HEIGHT) return capture_device.device_id async def __set_all_capture_devices(self): diff --git a/src/user_profile.py b/src/user_profile.py index 1cc77de4..e0032ab6 100644 --- a/src/user_profile.py +++ b/src/user_profile.py @@ -12,6 +12,7 @@ from winsdk.windows.graphics.capture.interop import create_for_window import error_messages +from AutoSplitImage import COMPARISON_RESIZE_HEIGHT, COMPARISON_RESIZE_WIDTH from CaptureMethod import CAPTURE_METHODS, CaptureMethod from gen import design from hotkeys import set_hotkey @@ -140,6 +141,8 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str autosplit.select_region_button.setDisabled(True) autosplit.select_window_button.setDisabled(True) autosplit.capture_device = cv2.VideoCapture(autosplit.settings_dict["capture_device_id"]) + autosplit.capture_device.set(cv2.CAP_PROP_FRAME_WIDTH, COMPARISON_RESIZE_WIDTH) + autosplit.capture_device.set(cv2.CAP_PROP_FRAME_HEIGHT, COMPARISON_RESIZE_HEIGHT) keyboard.unhook_all() if not autosplit.is_auto_controlled: diff --git a/typings/cv2-stubs/__init__.pyi b/typings/cv2-stubs/__init__.pyi index cd2b198f..1638dd1c 100644 --- a/typings/cv2-stubs/__init__.pyi +++ b/typings/cv2-stubs/__init__.pyi @@ -1578,8 +1578,10 @@ def VariationalRefinement_create() -> typing.Any: class VideoCapture(): name: str device_id: int - def __init__(self, device_id: int): ... - def grab(self): ... + def __init__(self, device_id: int, backend: int | None = ...): ... + def set(self, property: int, value: int): ... + def get(self, property: int) -> int: ... + def grab(self) -> bool: ... def read(self) -> typing.Tuple[bool, Mat]: ... def release(self): ... def setExceptionMode(self, error: bool): ... From 2cb3068ce84e618539772220a75dadfc5bcf1283 Mon Sep 17 00:00:00 2001 From: Avasam Date: Wed, 15 Jun 2022 04:12:41 -0400 Subject: [PATCH 072/137] enumarate cameras using pygrabber --- scripts/requirements.txt | 1 + src/CaptureMethod.py | 13 +- typings/pygrabber/dshow_graph/__init__.pyi | 285 +++++++++++++++++++++ 3 files changed, 291 insertions(+), 8 deletions(-) create mode 100644 typings/pygrabber/dshow_graph/__init__.pyi diff --git a/scripts/requirements.txt b/scripts/requirements.txt index 640adca7..30b1846c 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -24,6 +24,7 @@ requests certifi toml winsdk>=v1.0.0b4 +pygrabber git+https://github.com/ranchen421/D3DShot.git#egg=D3DShot # https://github.com/SerpentAI/D3DShot/issues/44 # # Linting, formatters and Types diff --git a/src/CaptureMethod.py b/src/CaptureMethod.py index 9d21dabc..665e020c 100644 --- a/src/CaptureMethod.py +++ b/src/CaptureMethod.py @@ -5,7 +5,7 @@ from platform import version import cv2 -from PyQt6.QtMultimedia import QMediaDevices +from pygrabber.dshow_graph import FilterGraph from winsdk.windows.media.capture import MediaCapture # https://docs.microsoft.com/en-us/uwp/api/windows.graphics.capture.graphicscapturepicker#applies-to @@ -142,15 +142,12 @@ class CameraInfo(): async def get_all_video_capture_devices(): - named_video_inputs = [x.description() for x in QMediaDevices.videoInputs()] - # Enough to ensure we catch "OBS-Camera" 1-4 (Virtualcam plugin) and "OBS Virtual Camera" - device_range_to_test = range(len(named_video_inputs) + 5) + named_video_inputs = FilterGraph().get_input_devices() - async def get_camera_info(index: int): + async def get_camera_info(index: int, device_name: str): video_capture = cv2.VideoCapture(index) video_capture.setExceptionMode(True) backend = "" - device_name = named_video_inputs[index] if index < len(named_video_inputs) else f"Camera {index}" try: # https://docs.opencv.org/3.4/d4/d15/group__videoio__flags__base.html#ga023786be1ee68a9105bf2e48c700294d backend = video_capture.getBackendName() @@ -164,8 +161,8 @@ async def get_camera_info(index: int): return CameraInfo(index, device_name, False, backend) future = asyncio.gather(*[ - get_camera_info(index) for index - in device_range_to_test + get_camera_info(index, name) for index, name + in enumerate(named_video_inputs) ]) return [ diff --git a/typings/pygrabber/dshow_graph/__init__.pyi b/typings/pygrabber/dshow_graph/__init__.pyi new file mode 100644 index 00000000..673efd7b --- /dev/null +++ b/typings/pygrabber/dshow_graph/__init__.pyi @@ -0,0 +1,285 @@ +""" +This type stub file was generated by pyright. +""" + +from enum import Enum + +from pygrabber.dshow_core import * +from pygrabber.dshow_ids import * +from pygrabber.win_api_extra import * +from pygrabber.windows_media import * + + +class StateGraph(Enum): + Stopped = ... + Paused = ... + Running = ... + + +class RecordingFormat(Enum): + AVI = ... + ASF = ... + + +class FilterType(Enum): + video_input = ... + audio_input = ... + video_compressor = ... + audio_compressor = ... + sample_grabber = ... + render = ... + file_sink = ... + muxer = ... + smart_tee = ... + + +class Filter: + def __init__(self, instance, name, capture_builder) -> None: + ... + + def get_out(self): + ... + + def get_in(self, index=...): + ... + + def find_pin(self, direction, category=..., type=..., unconnected=...) -> None: + ... + + def reload_pins(self) -> None: + ... + + def set_properties(self) -> None: + ... + + def get_name(self): + ... + + def print_info(self) -> None: + ... + + +class VideoInput(Filter): + def __init__(self, args, capture_builder) -> None: + ... + + def get_current_format(self) -> tuple[Unknown, Unknown]: + ... + + def get_formats(self) -> list[Unknown]: + ... + + def set_format(self, format_index) -> None: + ... + + def show_format_dialog(self) -> None: + ... + + +class AudioInput(Filter): + def __init__(self, args, capture_builder) -> None: + ... + + +class VideoCompressor(Filter): + def __init__(self, args, capture_builder) -> None: + ... + + +class AudioCompressor(Filter): + def __init__(self, args, capture_builder) -> None: + ... + + +class Render(Filter): + def __init__(self, instance, capture_builder) -> None: + ... + + def configure_video_window(self, handle) -> None: + ... + + def set_window_position(self, x, y, width, height) -> None: + ... + + +class SampleGrabber(Filter): + def __init__(self, capture_builder) -> None: + ... + + def set_callback(self, callback, which_method_to_callback) -> None: + ... + + def set_media_type(self, media_type, media_subtype) -> None: + ... + + def get_resolution(self) -> tuple[Unknown, Unknown]: + ... + + def initialize_after_connection(self) -> None: + ... + + +class SmartTee(Filter): + def __init__(self, capture_builder) -> None: + ... + + +class Muxer(Filter): + def __init__(self, args, capture_builder) -> None: + ... + + +class SystemDeviceEnum: + def __init__(self) -> None: + ... + + def get_available_filters(self, category_clsid) -> list[Unknown]: + ... + + def get_filter_by_index(self, category_clsid, index) -> tuple[Unknown, Unknown]: + ... + + +class FilterFactory: + def __init__(self, system_device_enum, capture_builder) -> None: + ... + + def build_filter(self, filter_type, id): + ... + + +class MediaType: + def __init__(self, majortype_guid, subtype_guid) -> None: + ... + + +class WmProfileManager: + def __init__(self) -> None: + ... + + +class FilterGraph: + def __init__(self) -> None: + ... + + def add_video_input_device(self, index) -> None: + ... + + def add_audio_input_device(self, index) -> None: + ... + + def add_video_compressor(self, index) -> None: + ... + + def add_audio_compressor(self, index) -> None: + ... + + def add_sample_grabber(self, callback) -> None: + ... + + def add_null_render(self) -> None: + ... + + def add_default_render(self) -> None: + ... + + def add_video_mixing_render(self) -> None: + ... + + def add_file_writer_and_muxer(self, filename) -> None: + ... + + def configure_asf_compressor(self) -> None: + ... + + def prepare_preview_graph(self) -> None: + ... + + def prepare_recording_graph(self) -> None: + ... + + def configure_render(self, handle) -> None: + ... + + def update_window(self, width, height) -> None: + ... + + def run(self) -> None: + ... + + def stop(self) -> None: + ... + + def pause(self) -> None: + ... + + def get_state(self) -> StateGraph: + ... + + def get_input_devices(self) -> list[str]: + ... + + def get_audio_devices(self) -> list[Unknown]: + ... + + def get_video_compressors(self) -> list[Unknown]: + ... + + def get_audio_compressors(self) -> list[Unknown]: + ... + + def get_asf_profiles(self) -> list[Unknown]: + ... + + def grab_frame(self) -> bool: + ... + + def get_input_device(self): + ... + + def remove_filters(self) -> None: + ... + + def remove_all_filters_but_video_source(self) -> None: + ... + + def print_debug_info(self) -> None: + ... + + +class FilterGraphDebugHelper: + def __init__(self, filter_graph) -> None: + ... + + def print_graph_info(self) -> None: + ... + + def get_filter_name(self, filter): + ... + + def get_pin_info(self, pin) -> tuple[Unknown, Unknown, Unknown | None, Unknown]: + ... + + +class SampleGrabberCallback(COMObject): + _com_interfaces_ = ... + + def __init__(self, callback) -> None: + ... + + def grab_frame(self) -> None: + ... + + def SampleCB(self, this, SampleTime, pSample) -> Literal[0]: + ... + + def BufferCB(self, this, SampleTime, pBuffer, BufferLen) -> Literal[0]: + ... + + +def get_moniker_name(moniker): + ... + + +def show_properties(object) -> None: + ... From 46e5392f168e7e5a1018c9de36e4c1d085092058 Mon Sep 17 00:00:00 2001 From: Avasam Date: Wed, 15 Jun 2022 09:26:28 -0400 Subject: [PATCH 073/137] Don't pickup inexistant window on load --- .gitignore | 1 + README.md | 1 + src/region_capture.py | 13 ++- typings/pygrabber/dshow_graph/__init__.pyi | 114 ++++++++++++--------- 4 files changed, 75 insertions(+), 54 deletions(-) diff --git a/.gitignore b/.gitignore index 0aff38f5..29db603f 100644 --- a/.gitignore +++ b/.gitignore @@ -7,6 +7,7 @@ __pycache__/ env/ build/ dist/ +*.prof # Generated **/gen/*.py !**/gen/*.pyi diff --git a/README.md b/README.md index 8571c5cb..3d0d09e8 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=Avasam_Auto-Split&metric=security_rating)](https://sonarcloud.io/dashboard?id=Avasam_Auto-Split) [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=Avasam_Auto-Split&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=Avasam_Auto-Split) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Avasam_Auto-Split&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Avasam_Auto-Split) +[![SemVer](https://badgen.net/badge/SemVer/SemVer/grey?label)](https://semver.org/) Easy to use image comparison based auto splitter for speedrunning on console or PC. diff --git a/src/region_capture.py b/src/region_capture.py index 8c5b0d1f..ee414cde 100644 --- a/src/region_capture.py +++ b/src/region_capture.py @@ -157,23 +157,26 @@ def capture_region(autosplit: AutoSplit) -> tuple[Optional[cv2.Mat], bool]: @param selection: The coordinates of the region @return: The image of the region in the window in BGRA format """ - hwnd = autosplit.hwnd - selection = autosplit.settings_dict["capture_region"] capture_method = autosplit.settings_dict["capture_method"] + selection = autosplit.settings_dict["capture_region"] if capture_method == CaptureMethod.VIDEO_CAPTURE_DEVICE: return __camera_capture(autosplit.capture_device, selection), False + if not autosplit.hwnd: + return None, False + if capture_method == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: image, is_old_image = __windows_graphics_capture(autosplit.windows_graphics_capture, selection) return (None, False) \ - if is_old_image and not win32gui.IsWindow(hwnd) \ + if is_old_image and not win32gui.IsWindow(autosplit.hwnd) \ else (image, is_old_image) if capture_method == CaptureMethod.DESKTOP_DUPLICATION: - return __d3d_capture(hwnd, selection), False + return __d3d_capture(autosplit.hwnd, selection), False - return __bit_blt_capture(hwnd, selection, capture_method == CaptureMethod.PRINTWINDOW_RENDERFULLCONTENT), False + return __bit_blt_capture(autosplit.hwnd, selection, capture_method + == CaptureMethod.PRINTWINDOW_RENDERFULLCONTENT), False def set_ui_image(qlabel: QLabel, image: Optional[cv2.Mat], transparency: bool): diff --git a/typings/pygrabber/dshow_graph/__init__.pyi b/typings/pygrabber/dshow_graph/__init__.pyi index 673efd7b..08af81dc 100644 --- a/typings/pygrabber/dshow_graph/__init__.pyi +++ b/typings/pygrabber/dshow_graph/__init__.pyi @@ -1,13 +1,20 @@ -""" +""" # noqa: Y021 This type stub file was generated by pyright. """ +from collections.abc import Callable +from ctypes.wintypes import LONG from enum import Enum +from typing import Literal, TypedDict + +from comtypes._comobject import COMObject +from comtypes.gen._78530B68_61F9_11D2_8CAD_00A024580902_0_1_0 import IBaseFilter, IEnumPins, IPin +from comtypes.GUID import GUID -from pygrabber.dshow_core import * -from pygrabber.dshow_ids import * -from pygrabber.win_api_extra import * -from pygrabber.windows_media import * +# from pygrabber.dshow_core import * +# from pygrabber.dshow_ids import * +# from pygrabber.win_api_extra import * +# from pygrabber.windows_media import * class StateGraph(Enum): @@ -34,16 +41,16 @@ class FilterType(Enum): class Filter: - def __init__(self, instance, name, capture_builder) -> None: + def __init__(self, instance: IBaseFilter, name: IBaseFilter, capture_builder: IBaseFilter) -> None: ... - def get_out(self): + def get_out(self) -> IEnumPins: ... - def get_in(self, index=...): + def get_in(self, index: int = ...) -> IEnumPins: ... - def find_pin(self, direction, category=..., type=..., unconnected=...) -> None: + def find_pin(self, direction: Literal[0, 1], category: GUID | None = ..., type=..., unconnected=...) -> None: ... def reload_pins(self) -> None: @@ -52,24 +59,33 @@ class Filter: def set_properties(self) -> None: ... - def get_name(self): + def get_name(self) -> str: ... def print_info(self) -> None: ... +class GetFormats(TypedDict): + index: int + media_type_str: str + width: LONG + height: LONG + min_framerate: float + max_framerate: float + + class VideoInput(Filter): - def __init__(self, args, capture_builder) -> None: + def __init__(self, args: tuple[IBaseFilter, IBaseFilter], capture_builder: IBaseFilter) -> None: ... - def get_current_format(self) -> tuple[Unknown, Unknown]: + def get_current_format(self) -> tuple[LONG, LONG]: ... - def get_formats(self) -> list[Unknown]: + def get_formats(self) -> list[GetFormats]: ... - def set_format(self, format_index) -> None: + def set_format(self, format_index: int) -> None: ... def show_format_dialog(self) -> None: @@ -77,42 +93,42 @@ class VideoInput(Filter): class AudioInput(Filter): - def __init__(self, args, capture_builder) -> None: + def __init__(self, args: tuple[IBaseFilter, IBaseFilter], capture_builder: IBaseFilter) -> None: ... class VideoCompressor(Filter): - def __init__(self, args, capture_builder) -> None: + def __init__(self, args: tuple[IBaseFilter, IBaseFilter], capture_builder: IBaseFilter) -> None: ... class AudioCompressor(Filter): - def __init__(self, args, capture_builder) -> None: + def __init__(self, args: tuple[IBaseFilter, IBaseFilter], capture_builder: IBaseFilter) -> None: ... class Render(Filter): - def __init__(self, instance, capture_builder) -> None: + def __init__(self, instance: IBaseFilter, capture_builder: IBaseFilter) -> None: ... - def configure_video_window(self, handle) -> None: + def configure_video_window(self, handle: int) -> None: ... - def set_window_position(self, x, y, width, height) -> None: + def set_window_position(self, x: int, y: int, width: int, height: int) -> None: ... class SampleGrabber(Filter): - def __init__(self, capture_builder) -> None: + def __init__(self, capture_builder: IBaseFilter) -> None: ... - def set_callback(self, callback, which_method_to_callback) -> None: + def set_callback(self, callback: Callable, which_method_to_callback) -> None: ... - def set_media_type(self, media_type, media_subtype) -> None: + def set_media_type(self, media_type: str, media_subtype: str) -> None: ... - def get_resolution(self) -> tuple[Unknown, Unknown]: + def get_resolution(self) -> tuple[LONG, LONG]: ... def initialize_after_connection(self) -> None: @@ -120,12 +136,12 @@ class SampleGrabber(Filter): class SmartTee(Filter): - def __init__(self, capture_builder) -> None: + def __init__(self, capture_builder: IBaseFilter) -> None: ... class Muxer(Filter): - def __init__(self, args, capture_builder) -> None: + def __init__(self, args: tuple[IBaseFilter, IBaseFilter], capture_builder: IBaseFilter) -> None: ... @@ -133,23 +149,23 @@ class SystemDeviceEnum: def __init__(self) -> None: ... - def get_available_filters(self, category_clsid) -> list[Unknown]: + def get_available_filters(self, category_clsid: str) -> list[IBaseFilter]: ... - def get_filter_by_index(self, category_clsid, index) -> tuple[Unknown, Unknown]: + def get_filter_by_index(self, category_clsid: str, index: int) -> tuple[IBaseFilter, IBaseFilter]: ... class FilterFactory: - def __init__(self, system_device_enum, capture_builder) -> None: + def __init__(self, system_device_enum: SystemDeviceEnum, capture_builder: IBaseFilter) -> None: ... - def build_filter(self, filter_type, id): + def build_filter(self, filter_type: FilterType, id: int) -> Filter: ... class MediaType: - def __init__(self, majortype_guid, subtype_guid) -> None: + def __init__(self, majortype_guid: str, subtype_guid: str) -> None: ... @@ -162,19 +178,19 @@ class FilterGraph: def __init__(self) -> None: ... - def add_video_input_device(self, index) -> None: + def add_video_input_device(self, index: int) -> None: ... - def add_audio_input_device(self, index) -> None: + def add_audio_input_device(self, index: int) -> None: ... - def add_video_compressor(self, index) -> None: + def add_video_compressor(self, index: int) -> None: ... - def add_audio_compressor(self, index) -> None: + def add_audio_compressor(self, index: int) -> None: ... - def add_sample_grabber(self, callback) -> None: + def add_sample_grabber(self, callback: Callable) -> None: ... def add_null_render(self) -> None: @@ -186,7 +202,7 @@ class FilterGraph: def add_video_mixing_render(self) -> None: ... - def add_file_writer_and_muxer(self, filename) -> None: + def add_file_writer_and_muxer(self, filename: str) -> None: ... def configure_asf_compressor(self) -> None: @@ -198,10 +214,10 @@ class FilterGraph: def prepare_recording_graph(self) -> None: ... - def configure_render(self, handle) -> None: + def configure_render(self, handle: int) -> None: ... - def update_window(self, width, height) -> None: + def update_window(self, width: int, height: int) -> None: ... def run(self) -> None: @@ -219,22 +235,22 @@ class FilterGraph: def get_input_devices(self) -> list[str]: ... - def get_audio_devices(self) -> list[Unknown]: + def get_audio_devices(self) -> list[str]: ... - def get_video_compressors(self) -> list[Unknown]: + def get_video_compressors(self) -> list[str]: ... - def get_audio_compressors(self) -> list[Unknown]: + def get_audio_compressors(self) -> list[str]: ... - def get_asf_profiles(self) -> list[Unknown]: + def get_asf_profiles(self) -> list[str]: ... def grab_frame(self) -> bool: ... - def get_input_device(self): + def get_input_device(self) -> str: ... def remove_filters(self) -> None: @@ -248,23 +264,23 @@ class FilterGraph: class FilterGraphDebugHelper: - def __init__(self, filter_graph) -> None: + def __init__(self, filter_graph: FilterGraph) -> None: ... def print_graph_info(self) -> None: ... - def get_filter_name(self, filter): + def get_filter_name(self, filter: IBaseFilter) -> str: ... - def get_pin_info(self, pin) -> tuple[Unknown, Unknown, Unknown | None, Unknown]: + def get_pin_info(self, pin: IPin) -> tuple[str, str, IPin | None, IBaseFilter]: ... class SampleGrabberCallback(COMObject): _com_interfaces_ = ... - def __init__(self, callback) -> None: + def __init__(self, callback: Callable) -> None: ... def grab_frame(self) -> None: @@ -277,7 +293,7 @@ class SampleGrabberCallback(COMObject): ... -def get_moniker_name(moniker): +def get_moniker_name(moniker) -> str: ... From cbf489e46c1f8eb398405154c4cfd75ae0f30fa0 Mon Sep 17 00:00:00 2001 From: Avasam Date: Thu, 16 Jun 2022 14:37:38 -0400 Subject: [PATCH 074/137] Updated pylint, python job, and split requireemnts --- .github/workflows/lint-and-build.yml | 43 ++++++++++++---------------- pyproject.toml | 4 +-- scripts/install.bat | 2 +- scripts/lint.ps1 | 2 +- scripts/requirements-dev.txt | 19 ++++++++++++ scripts/requirements.txt | 19 +----------- 6 files changed, 43 insertions(+), 46 deletions(-) create mode 100644 scripts/requirements-dev.txt diff --git a/.github/workflows/lint-and-build.yml b/.github/workflows/lint-and-build.yml index 406e9ba8..6630a9c7 100644 --- a/.github/workflows/lint-and-build.yml +++ b/.github/workflows/lint-and-build.yml @@ -36,15 +36,15 @@ jobs: uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} + cache: 'pip' + cache-dependency-path: 'scripts/requirements-dev.txt' - name: Install dependencies run: | - python -m pip install --upgrade pip - pip install wheel - pip install -r "scripts/requirements.txt" + pip install -r "scripts/requirements-dev.txt" npm install -g pyright npm list -g pyright - run: scripts/compile_resources.bat - - name: Analysing the code with ${{ github.job }} + - name: Analysing the code with Pyright run: pyright --warnings Pylint: runs-on: windows-latest @@ -59,14 +59,13 @@ jobs: uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} + cache: 'pip' + cache-dependency-path: 'scripts/requirements-dev.txt' - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install wheel - pip install -r "scripts/requirements.txt" + run: pip install -r "scripts/requirements-dev.txt" - run: scripts/compile_resources.bat - - name: Analysing the code with ${{ github.job }} - run: pylint --reports=y --output-format=colorized $(git ls-files '**/*.py') + - name: Analysing the code with Pylint + run: pylint --reports=y --output-format=colorized src/ Flake8: runs-on: windows-latest strategy: @@ -80,13 +79,12 @@ jobs: uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} + cache: 'pip' + cache-dependency-path: 'scripts/requirements-dev.txt' - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install wheel - pip install -r "scripts/requirements.txt" + run: pip install -r "scripts/requirements-dev.txt" - run: scripts/compile_resources.bat - - name: Analysing the code with ${{ github.job }} + - name: Analysing the code with Flake8 run: flake8 Bandit: runs-on: windows-latest @@ -101,13 +99,12 @@ jobs: uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} + cache: 'pip' + cache-dependency-path: 'scripts/requirements-dev.txt' - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install wheel - pip install -r "scripts/requirements.txt" + run: pip install -r "scripts/requirements-dev.txt" - run: scripts/compile_resources.bat - - name: Analysing the code with ${{ github.job }} + - name: Analysing the code with Bandit run: bandit -n 1 --severity-level medium --recursive src Build: runs-on: windows-latest @@ -122,11 +119,9 @@ jobs: uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} + cache: 'pip' - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install wheel - pip install -r "scripts/requirements.txt" + run: pip install -r "scripts/requirements.txt" - run: scripts/build.bat - name: Upload Build Artifact uses: actions/upload-artifact@v3 diff --git a/pyproject.toml b/pyproject.toml index 36cb52e1..e35ac2b2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -78,9 +78,9 @@ ignore-paths = [ # Auto generated "^src/gen/.*$", # We expect stub files to be incomplete or contain useless statements - "^.*\\.pyi$", + "^.*.pyi$", ] -extension-pkg-allow-list = ["PyQt6", "win32ui"] +extension-pkg-allow-list = ["PyQt6", "PySide6", "win32ui"] [tool.pylint.FORMAT] max-line-length = 120 diff --git a/scripts/install.bat b/scripts/install.bat index bdfaf136..8f7f45e4 100644 --- a/scripts/install.bat +++ b/scripts/install.bat @@ -1,5 +1,5 @@ py -m pip install wheel --upgrade -py -m pip install -r "%~p0requirements.txt" +py -m pip install -r "%~p0requirements-dev.txt" CALL "%~p0compile_resources.bat" CALL npm install -g pyright@latest CALL npm list -g pyright diff --git a/scripts/lint.ps1 b/scripts/lint.ps1 index 03b3d774..e11bbd86 100644 --- a/scripts/lint.ps1 +++ b/scripts/lint.ps1 @@ -13,7 +13,7 @@ if ($LastExitCode -gt 0) { } Write-Host "`nRunning Pylint..." -pylint --score=n --output-format=colorized $(git ls-files '**/*.py') +pylint --output-format=colorized src/ $exitCodes += $LastExitCode if ($LastExitCode -gt 0) { Write-Host "`Pylint failed ($LastExitCode)" -ForegroundColor Red diff --git a/scripts/requirements-dev.txt b/scripts/requirements-dev.txt new file mode 100644 index 00000000..9ba430e3 --- /dev/null +++ b/scripts/requirements-dev.txt @@ -0,0 +1,19 @@ +# Dependencies +-r requirements.txt +# +# Linting, formatters and Types +bandit +isort +flake8 +flake8-pyi +flake8-quotes +flake8-isort +pylint>=2.13.9 +pywin32-stubs>=0.1.6 +simplejson +types-simplejson>=3.17.2 +types-requests +# +# You can comment this out if you don't want to run `designer.bat` to quickly open the bundled PyQt Designer. +# Can also be downloaded externally as a non-python package +qt6-applications diff --git a/scripts/requirements.txt b/scripts/requirements.txt index 30b1846c..42be5021 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -5,7 +5,7 @@ # Usage: .\scripts\install.bat # # If you're having issues with the libraries, you might want to first run: -# pip uninstall -r .\scripts\requirements.txt +# pip uninstall -r .\scripts\requirements-dev.txt # # Creating AutoSplit.exe with PyInstaller: .\scripts\build.bat # @@ -27,22 +27,5 @@ winsdk>=v1.0.0b4 pygrabber git+https://github.com/ranchen421/D3DShot.git#egg=D3DShot # https://github.com/SerpentAI/D3DShot/issues/44 # -# Linting, formatters and Types -bandit -isort -flake8 -flake8-pyi -flake8-quotes -flake8-isort -pylint>=2.13 -pywin32-stubs>=0.1.6 -simplejson -types-simplejson>=3.17.2 -types-requests -# -# You can comment this out if you don't want to run `designer.bat` to quickly open the bundled PyQt Designer. -# Can also be downloaded externally as a non-python package -qt6-applications -# # You can comment this out if you don't want to build AutoSplit.exe: PyInstaller From b5aa78fba54f2ede59f33ba67679a58964a15ede Mon Sep 17 00:00:00 2001 From: Avasam Date: Thu, 16 Jun 2022 18:30:25 -0400 Subject: [PATCH 075/137] Add splash screen. Closes Avasam#25 --- res/icon.ico | Bin 33490 -> 15881 bytes res/splash.png | Bin 0 -> 30994 bytes scripts/build.bat | 8 +++++++- src/AutoSplit.py | 5 +++++ 4 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 res/splash.png diff --git a/res/icon.ico b/res/icon.ico index fae0f994402385bfa8a70d6c031bce929d865d0a..485824af146c4b97f5b6bfd6cad4e8bb1194057f 100644 GIT binary patch literal 15881 zcmX9_1ymeOvz^7=oyCH?1P?9=4#C|mS=@pJ7J>wK4H_&ET!X`hy9IZ54+{i)oB!>c zIWy<%bai$0t)7~y+W-K9AOC(JfEKtG2LKZIeT0VEJ8TRJ4EQa!qJo^}zkmOoXejWD zvD*(@_yyfX!N45=FbV&iARse~41h~el#|x>UOH{}$ugPO*?(B|%XL39PAXHn)}J$9 zbVW((%|Oe@`$m@?FD8o?1aPZl7a!X7$CFanQ=k#O&Yql%CqsykMae3r^HD@obg_Md z(`dPvz`2-ettzm#sp5BjJJ8&uomf_wsC~QQ{&W1V|4~6)VOh)VS>2rT)7%mSZ_ZFx zD+F(+Ho$u34Kq3g509EO+gm&b!o(*{wT%#FW6+QF~N9PuNK%CS_^mbG*0wz{8D;!cX_wGlas@f+3pvs(Z@c- z4$wK*guMw30VDb10%`$S%^ZwxUOv{w91w+AE1)%^4as?8qK0hcxh)ic8`hCE0uQ?A4LmQ%XVG4AEw{uIW-5zhOVUN_T&38O` z2(j$cUSXkvv7~Xvj>Kdt{QAG#c)b+n(8owvh^F4m6_U}+EiKY_KnO1-Cz}BmF^X!OMq>8T_9o#tx3TE z?QMuPD$o1HE>+DMb;iXz)nO}_?z%UNf-uIE@d5@0)Rd8Mj~wJdS?CQ*>spd=yJC24 zyaQhFsZ6c90**po3|quv6HA<-B;`X95w9YWQeVt7xYCGWxPcB8+TeH+C>}ATkk6tx zlpe3xT&|^H>9t#}?Bk%zg{TJ7YlieLr0rCl;`ME!l#(Hh?@=Toc4a0|ePZfA^G*)6 z)<*L}8!}~Xwp%YrL|T2j%Xi={9Gk|_KUY}8O|QwxfY7u9Oj^mLGJ~pA`(Mlxk8IH> z6$T2HiZ9=U?x4^$mpY!bri{EDu#)l-R%^|BE2{W@)Hl`Z)rF_b#cez@LRF;Pu3}g6 z?gMj%w}2dWp|*CYwF+7zrmzNud8dN?BhGH^;^hx6GCyX@T(fB7GH+@|x?hTH&ua&d zVpn*y^tGF}%;d|6W8}%&+9B4)XpIFT8z~}rU>t?;?AU={ZlxmBYRuBiZdPV=s>TXP zXSfu?P6@)2$zVV;jWbYi=y1UNS|ZtvRP3R0(5^~vlc{KdoyzMCwUwilUK&{|;83Zc zH()_Z5cE*gqmhF;2+BL=yLywf0xP(1rjcWf%fyRD?>@_(Ft2hTon=YO9=0*|(Wb(k z9qKomTX5g*WJy8VGrQKC7A#QbR8aL zpbc$}8oS{rLhrRrsq1b{s5kzTgG*@lMtS<%|Ae9>x}r;M*nj6f)N!S#!Brr`laTus z-T^ZSBUPB&_PG`Q1`!K-U%+l-Pm8e|pr3GtRxUuM@{IQ&isC7)_r4#TqIBZD6K|Fr-&KjCD~nDd8k<9!PUK9@rkU%7PXouIdhtDH&-bKRqEkgz=hat2lnP}rV|n3 ztr6aQd+_eanX}%u+u4Q8n?*ADPf^vmX$7*CFgW~og$=DUY^buvYB|CPTQp1}^E8zkw>RDbt8yw(}(huQ3vTQP6ur%1*L*aF-FvK#4hc~=plMW(c%{fq= zg|vs?JJ(fEHG%!FZSsAIeM_rwxopQ6XTmLVq4~*NJ+=g|*LUDmuEM(&h`?=A%o82N z2TK@vw3*8{07vcF#py%@DF2Ri4*c|?RU-(xS9ME^7RMp|@fchprPMkxa|=%O_XwhAz3~`2c;G z{s?>dZe8ozYag|D^@U%=VNX87@%unaI-))MX54JQ&pS_#7*b^J{l#U|r{MI}93f4* zaa?6$zQg|rPh)zsJ4fUL&F%-Zv?&5`{BaBY9;n1Q&kC6ew zx}U;b1K~})Q)xcXDEmjo{=<+l!>U?fU*2|}c4!HT$U{QD3T|1Fk{ za-93H*k1!=XEkAdHCYHUNMf)SFdp26lz>TmovP9B@TNT3izBa0#sj zn6ynAuvagoh?h`02Pgd;cl7A9Cn)b1suk&ReE4zhYo{Iq^*hY@<1iz}gW$>$BX&(Z zn(^F&p6%^1ow;zV2hnstp0u1UCZUT6Q~#28!8pYhRg+mZu)J=m-DG}jfd{4JC_;bn;1#B|H{WTTz_=w9z$=3>|kjeU<80h zEY7GQote(cZS2~&t#f6!ALKj*(>TxgHX(&7EswNDS>76R6`T&;qg?BEjxYY`8;IF_ z(wE>Q-uFO?`@BvCk3RsO2%J)19SO18m^6{l)Chtp(FNQUK zG>W&&O0=Aa%Duzmr~NU5mgzs&+eSGu@E^(k%71@B!C)X21nn1*^GucmFZ6yJ>0vLK zj{3P@{=pB1_h&18wbtM9@l^ub<)1z_@01;C>WrDcvpBfHD0lAs|1ssx@CHWhI^_#P z1j=v3;3G>LLDV-j`Eha9t@=A_E0p?kP0g`49pd=_-D}aUA>l%EP9ZCNWv@0)+4uO0 z#T^= z`W>TDhKGn+E4|B_NzLihd&*4Z=*8>x1n5098Er*jh1?J!Ky8ohDz#nl0y&xmjU*?dZe>rvk z)h|jiv&7n_^TRi59U5cppXZ=mxnK4;>|W*K8ua91{+bUqRhEiJ?82}<=v1>55bi;v zlNKFn&c0Xw#4$l_PI-ab#i{J$SC!@MS5?cBpEdx?Af%FpkSu5J+7n%1Z{Sgla^*pSV~`oaQ{9q- z8BZ}^?E??5|3E7b)?krjFME(t*Y)wrT>6%J0m&zW5t_A&prP>c@qyG`ti0^k_PJdw z7fb`&10y{rEZ94W?E=IkA(QF-jeEb;-?dTQJp|Yw`k+-u_TwsGPNYTVa%$gwO2HSa z%Ay=KB!bYThyNv-c^~zrV)wQNOkCT!@Gmy8y3_vwT0i!F^tVZmnAS)<8L^2O@S)=$ z&o^@SU$PG{Ks)RH{=g`mj@WfW_F|GGOf3iU3)$Fj$5_{+$~XM67gkfb01ev1;x85{ zLtJy(Tt&!y0uV$1W69mX1h>0}EnuR`Nou#|`EN=d=%#KoRP{Nn;gLF(xt5w>2XMg- zTYpYw+`x_WKh_LGAXeV&X zbBSNz;O)8#l_KkjO6hUddF!oa!w`4N?XN-Q*i!$CH`gE$i#7X=D!s$iz}(exmk3>L z0(ca(fzcl)1z+4nxdQdcZOnWQrW!|sW_x+&JT)IE|%`=A2W+3$h5FUKlbL+>QHZ(o_^{DH~!TT%#Io@gu zqQn;EJD4OuCZW=QwT>4~LbV9PBZ`_8G~lw7QXFaOWZC=RhusgQ-p}8MYT)Eb#MkpFhEw*VXa>6YGgBcHMn5+?3e$x_1|3-uwt;m8F?!!in>F&Q-7TtRpZ`{v4__R&>$^erDHFYk! zScGaOeL4hN7Tkb%bBxu`slnA1*T!V|5}Sh9l_Di=WZ#$gVSQ73W>(oe zEJ@Cdp?Yar8nplJ{Q~m6;a=2!WdA}QxX&v(&8PW0{r+p!ik`sGEm4h& zld=h6gU1Ikn??OdGH&@38koq8o3NnXhFp)0g!bnFjKbg}eFCRO+bKsTmo~H0!9$~M zb^d+Z-3!N=mkY*01N&mdh^USasAz@3OTxp3rZbr~ONMKFmmNc_axbdnZhxolmMH}2h?90L zoY--1!YL2QWM%~%szOz;{zj)-ie;<}p*qH;&-uBoh9DO{-4|6mu=Gb0S;26d{;56a z5LCz6Tjrwiini*9(?J}D7^uuPqcE7d0ecKEXGE;vWd+5c4nKqvtkct1KNEkvlBxxffx3PQ zEN{_k+KrTa(c!ndSCIEz*ELUw2(@O>>r6H!>$@c05Xa=qZJXsgRPiw(M~92VQ+E|C z6yd9@MK4Gf?sQB*RE~V)Nwx_Ag?$e1+>Xui{(|I*mWJSrlt!7fX9#7{mg8J)g_)ET z?8{|S?&C~y&vIFT!zJ6Ifd4x~CKSXDn+I@Hv|y>Qt$gH9Y$OZca~!K5x=oCzlMPRjI6dIqZp4> zY-5{N+vH4HW)0nz8vk&}J0iLhf%r(z$$~OIY^&E_3pgdvR5^4FEsZ{_O&=M+AFnSO z*FRiJ;fth;*7UzXh@}3^NL8IphUGm36Y;`E%4lO{(az%=IB_$&1nO_xiZ z+kNN}3+0LoEZMc5?D~7fwbp4HIRT)j1ggV9x}mCJre6}o;fv|S*&<27#idj+9How z)%yru-w?ZOen^U~Uf!vv;13(H!fK@6lRHs4yBzoTd%k}z>cvg`+4VbFYf<|FXyMEb z{&_mfqjmmM|H~EtPlg3HrjEK+j`9MKQuIFcG?Ya%7Q2Bv_R7uXZxkzS`Jv2ul6wyK z2uZJiUpT^Q=LGiOF(>THiLU?S^n{N)qj?q2jgH8h>LRi{6d?lyl@GsCsv3pVPH);N zw%q2lmX5DkbV3aF>nVe#KO&oIZgTKH&c3vf{P4-#cdV=nT$oTvDcF{_390d7sphl; zM*Lo=hBpV;dbI1Rt7j5Deu_K0XGe6O`4B5>B3V27=Kj>L_Er<+W?70P3Aq>~Ol*DW z+pN1StIV;|00vJkJ*iD6qQ6w5+A`*oqeYzb5(2^vu|hNylyGKB!K7f z)DWyu{&%5@ofqolg%Al#Yjp9_b-CjmdcsxC5oRqF+ANxwHF+pk?C8HbiSbOX2aD<{ zrI?s75xLOk(nK0Q5(abc0WSIftln|OQ#Q}pk(A7#)GlJAjnT`$b9Uj&jd@UyR$q=8VJZrp{YAF)7hFV|tY47Y z606=UQ_4W2FQz9X_h)V>VZNgOUHz$HLJc!2ophbD1*C_Y^oq7_UPH$(`9BML@m<2g z6HHj=%ba?38+r z0pLxpgnPR#b!>fwhxiad?7yE|`a?6hUfgy9|(O>}*;i0E=^ZZ%`(}2U2Xiyk=@F z67+#nTPgL6->5*)#7%HlUWw0mv1o2UZNK)$A1tJhkSn~t>Y=!U_&}mWD{*&UaoBT@ z(q+M}^jlwpOS_<$-LLQ&VPQ-1%_4g{q?cLI6-r!PF@9qL?jbBeqIqfC3j92|Io@jW zd?V49acE7NXS{jD4Y3%o9Z7YaNz!lA;`lRq$;4>mTl&|Vkwv#z9?hw#_>()Luca4h z@3W2Rr1H6Q5Qv+6hgbVRRaPmX1k$n^XDc#8ygy1$zq_+mr^?A5XZpk_;+OgSPISUy zNCv5`0pIlAA>+wMq^S}EZAIQZ>2smiJ?j%?#IyhJMEOXzq5H4dE$hM!ao*UyzSd|aepYss^ z$k{;*flkw^O>Q*IT{LwO9tVTSR2A7enuNRJJ$y@$zOmt>3e{_TZ(=(PKh@o+*H~Ay z1@$sr!g3$KZ*fcPxa_|(mblgFTRfbtQu?zJ^4vPqgTg3QdF>7~VVSJ7ygm!v5NPpNTUb zAve!f^r;b!i{Do2AhbK$J^Pc|rFP9w%NQAr{RYu3Ss6Dc)z?6QYtfcxAH_G{*^3$S zS5rTKy;$-n)e&l-rT@e{drt1@TubxzbEm3#Qj*+$HVNxCgaKXnso&liiBmCcrF64j ziXpB0OQ*MyfTYl1tZ~llbG~*iMr?Gbnq07EF+_zbLcGN3ZJwi?fzG?OkY)%aEr6d+&qK{Y#ee5wzvzB+ibB5sAECpnli*pQOubYo`>e2={PWBbv7Vju9 z4p3j|017wP|d4SCk^KuOQ6 zDS-hXx|o)D-Jo3KP`3&f4=(W>|OYBht zt-Mkvy~x4@?;8RD-NLDNTOMhYc#=E;FX5MfVzKvj%y~4El5bin-{xmC-0K}A9rk1& zZzA?^8fQo#DIlAs(3Rc^QWd$&uX_UNzaRvMP`tMP*lT{0hDs`RJ>z%UU9Q@YLrIYG z_1$64oDO95E7d)JbUdtrP8;GmQ`V}1Dy-pcMw#N*V*JD?cn`k|N7ylRvg*_P_050a zF;n{U{cx#KgCSIk{KY+4{Xj-u|2b`qg=M6}qLX<(I2P3@L0qPo5XFNSAYpr9cmT&4 z`SG49M>4>wd__ql$@L2vjCCQoBv&okzQNym1!d#g_(Dp#Q%;-jT|RMrUpzu@B7_JYC1qTwR>OZa$6i z4u^u62cp11e4>YUgppF`wMIOVH!f(OXI_>W5kE{hDS9Uc*Q&?rBX$ zvT8kroW&+A^QqMruYv814>KCQPu*`oK-pU$}&xjsiG1$2}e0#xX)2 zXX8KOioRVXU`g9Y8w%?{h8_~4vHGOy6{a_av$Kty1>vQ*3jMy4FEa{iRWs8`d}MEa zdNB~4Em$r)tW($x(lXD*1E1JZ=lukDgvaAOe$6WS5Vbb&7)FwD%4fiyQ(LZ6yKh?=4k9T{)+M zgjSupTK&Vkl#z$bh^wzOMd2x;;%PmA$93M?j`;WMYy`>~@ZUwn=bPY0lc?_UA~mUr z(2~`>*RNrahCii0u#A3M97PxoAP(3_248kq0n&)9L`}csHP0W{^<#hdESBW=%gmTj zW<#@U%={V`1?Cr6pkpatHHTj_6e12=h2wz_-T)fZ0*5ZjOP8GlLp{TqBj;`e103Zu zhL~=&1#tboAY&0*zKuN8bwCF>C6vWSP&ugRL#Z**E+DhE0ts`fyU!B-MOz?OxGGMaU%JF<6>lren#~43DYAT5Ba^Di<0P-Xn%0+2s=w(}WJmZqirWWcQ^p33fkR`LLyvGl~K zI&>y)50pmiSxtXd%4o3zSN+H7X8i?17|wpw>+u(?+hz4E7vf zOal$H@FIW1BSBdVr^F|{U{89@E)D6DmN!yL8aT3OZ~1TmW*RAlA>G~L-3|2p%TJ^+BdD@b`$DhQr zG6O#=`?a2mqNUTxtSK->E0FaVc^`sS!#*xv4RMRs2SY}r(KfoAmgnJ0>#)V<=V9f) zKlBy>X}*Wf+5u{$YY;`z=ptW4+Qe>br9W|O6nVrRdY?ttI*fyJ*|HhBl+_ZJc}nt+?b9gag^nSY5s97{Kdb^- zl6Q?k7E`xEMq8QJxNs+wcYg8-1QWHc3z zT{t!rlotg)qXN?2Pr0jxE(};r=iAPUcJP;$250sQbzSeotkJw+1&FfnAfP&dXS>M&n)dk#QL9LnfQG-w$SHMeXifDm&jmg!@JY7LFzDklI* z@sa8+J2zruEw5_4OhLh(Z-QF{^W(09xK>+Ll_7SKH?zhsB0Iw`grC#Pvx zlKgk`@qs*Ws~OE#-I|Sx76IAQ()H{P%GE974U|}UYz(Ebp&luxtz)9n=?=&(SxujG zEM0`ocvt+tSUeOnTzUzt1+c>KJ>gpQWKb=%3l0RBB+VqG4i*-AqXWtKM10r)nsLHj zJY|9y*3>&TRzOnaZ7}EV>Cav3nmx`3tOqZOFjNjD29!>UT)t@J0GAuwQe%a)XU5}i z&$5Z$spZcCXS-wof!_Z#3YFqwRd3e({z3+wv&_dIOfRhP+Wxw`AxE(6yll_Xvd{Yb zk-`|vY%{1wEJ(J{;_3)r?F_S%Si`el<-eE~gMfqp=dVXSipl-;dg?lf3(u)fj?QMv zmdZ2o+?0KICX9eW#>!LGO^un}cEXGU+ABo_3|*1Vxfq7LBtb;HKYHrzj$h_RoTEgl zm#ck#YaS#vnH`lI2GO=e#_B>Wsy{Av`h8A)=0gAaotZLw_TzH-3?r3t2E~m5Hc;)D zWHGNxV)?*tbySR7L&C0W4zajxyy1l%f6V!=Vm76>IzPm9_^HLC1=sHAm)e%JuZ0Gu znei+w!GPkyi!b>@ibc~5DUjzl+$5I`sWaAP%6@OnF1~yt2!j*_R5Cl+rI=}Zb(3kW z4`u5L%q?jwdlBcEz_airHD>Jd*VHQRwPd;?7{@4x7mmaE-v!Gvh?iG!)AFVa@0G4B z>GEIL1{Rc|zl$G(9b2a}Pyh(J!i<6b*XRRcx?@RzXVRhK!jIE|y5VFc(eI^byciW8 zuoJ-HTg_iiH@o*Z_~+JTtR9p{T+R{12u1W8Z2>=c+RSBCjvHXk;Te3b!vUnr=%5OK z6lH=tl$fkuP?5le5krr2Ikd*C*_b6Lwe&cv0V&=U#hlZ{iMN zUATRbfI0j#ZSQ^3`V%)g@Tx&gNC8d;haFc9!RUMtA*2|u) zYj>hIG&149`r$)_A}^|W5`+0nWv%-u3gQnV+1C|$?}3Dbddm#RF2*<;R+ZR4Z!crC z>U6Vg&`!pTQ7HBmoP*Ae>Mx@L=9ZbId;n$u4!~YeIaTC1s0`}rh24n5j@>Lde#@pD z&APuqN{{F%Uq>LLnB#+JVSyX)|3|{O3!9vU3Ti0!3c+k_VgERm_5y-XfG zuj#xHG4(fvX$g)g0hsRjqsqa0w5l(|55N^1w!%FM1ojz6#CZ|u<(rCBc3_}!O~smj zz%!FFS^hsjCVL*iID)moKb6zGMyk|10Irkrh=1YqH{=Cd8`19(yT3oaoaqFP?^B~f zgq^lLeu60BHILnoevE+q-;rC8KH{<#&);GFR$WBT~rxDilxt85hdO1=FumDP}%F^VYFs(O?h z@uAR%5YMPvWPOPEmhZdjzgC$BKeK2aQbwj@i^-L35mNqQL#Mz3zBeSn9=HI(up7Mm zS<5;fpW`TkB&xT*n=JGJ$xvc^B?<2EZjUrQdB`xV$a#m`cDK8X8_cu-(Iaa z6Aj50G5l?z8*XE?-05dPIbyp@RcHquhHY7YPaYZfRItXz{d|Jx0%xz(;sQ*?7M8IG zEbX!cQtTvIkX?$ltPp(VO8Pp%MWOV6U8RfczA4oM`sv)~F6@QKJoSJ)egy|O<%VbV z8*~9ft!c$yu!|VjAYepdY;dtSJUsQae92#L50G3i_+kr z2Jkf9P5nF1Y$s8Et=Or*@=6h-sV~&`)(9gjBK)~T+d1V*J#68aIpd_cK&M@H}aB7uN>t7+j z1Q~k8Ge^-u@NhVeg4d;zC!Dm7Vhm1U{0xwSx?;ytIj!zjUs4WUl04%yO4MIG2kGbB z>W!+Vh=Bvz6ajD~LJkk>JYvY(3+q+o2Gdq<8R*7;5|OJ%7Zf<=)z1%eQjY%RKL-80@rlzzYD0%%lPBjOC+7mjE#hf zWMQ;FLcx8a(Gj)uF&pqpK9gy$E+N-RTxwr%!<#{e z{T;|rXLD{G|9Q{n5EOg2V%0h9V1^(SUMmNhVcNR3V1Gg-J6M}+D(8dtJpizMcnh@5 znV_Ca-@oLV5ZaHtHrOwGmp@lOS5(RxPYDzA+teYT7zH=$#$T0HNXUwhG)x6W z@GzC~`sBr?z4IKNYRqT0BVzpXQs+9D;nb_mEV@-6ai_AN^1{RE;xT76{Ao@A z6HP`Mj9IAC7TEmHfwIQM1og}-QRfHyr6$eS$Ru`CTFi1&Fc4j$$O`WDCly`Qknk0wQ2(!k)y>^*$kORe#a40^m{k zPI>HIcwUg&g9h^CS4Ld5lsOv{C?h$_^y1yOxF$c77#k0 zcigID1FQO0# z^B)D;5r6a^7oA?<<0mFSip{^^{;Q;VJE;H&LHPKM7{89;r}^N5o>V*VV1*J`2U!J0go0bJ&>G3`Lzr1McUYS!!@O zM<$EEkUL|i@IQ6J{Dc$AwA3EzB<^+8j=#1(`D~fmTiLaaJlPHN&rMxS2B(caPwZ-b z7M}I+v2Xd*XZarJ7JFB|d4}62xjL^#1$eDs%v~hpbr-y!Yz+^nJ#_OfOOL}d+wV7v zV=xofQv1AgZi!BT7yj5Tu*&^($_j9lp?fpn+_`9+Q_%~M;Hai}x1H_E%FdM@G~$5I z^KlOF9({6Z!*G?EpV+T{lXoR7pG&b>Lhj-vCnD+}5K}RbZLf!0tMgU3$~7XK{F0BqHu%3;J?8ahr;e^|Va|SPm!xOZV)9nS%qQP_E zlIXpvkV57UmpLG)22%e8bztmvyCn#-+`6$#R!iO?2UlOn^+iujFCE8st_iR z|9sN5PCKCbLYmVo8bRV@;zpPC75&}PBA@!+JygK?F&}^BQ}KUE*Kk6OD_Vtt8hKB) z%=FRh!@;2n8XbE1-uN6i?xu{(+*M*jxr8n2gNO)P`THqdmjmO7cg2|ERpA%=bQpIo zOQDkgDm*lIYr-2(6$ZXa-EWr7Iy}mz>(r`^TiD}9iGIB}H19iZx&qG}0~LF#G6a9F z+W+{oCCB&9U2p~FJQUc*tz){hon01brTF(;P$XHoQ^QA(XFoNw|B;j5uI7E0NmrWR z;gcT@5Hwj;wAdl*~i=4dfl3?HSlzu~R@0LNhxi0)pc-@*MM5bKs|I=DTJ1&Q_U<}_q z>VU6qO#NO|fUfTv8_`p3b-ZKEre>Hj(^A(L9tqspWz)kMQf9u-@O5+|yWEY7{+jm5 z=i=DE-*9c4q^4c)c@*9f(j6G-zqXv!ZM&(qrY|g}GwP1;+5VCF8`rJ%;GHMZ7`d(L zC=Gfyp@GOxm6$M6f^~}LcaYSFp0|Q)NyyYWtXIuRv;K?rxr0MtBjU_ui_OywlUYI4 zeW*ckwn2aGZ~#%%S4iO=y)**F_D90>w3DXzo)beKCw>mNHMhYX^>UH0VbnVSnulIt zfMd`@gC^ic%u|O=MA>PJ3_TL&uRiD67FsN1@6evjHtm_WSvz>nrGZ% zI%9Kf?=WLNpi!=1w~;2q^qRqIzw{||XHoP4t-O70v9(1mGeKK9ggS6v`l=G3x-eqL zOUZU7Vz9l2WxDtm+kWf{aYG8M^y-%u{_) zX0=$!p?^8t7ElvhY0DNC80Nl*dqeJreXClgIjPT)!VZ^`LAPa=f-y8w<*?9Jyr1Dc z|Cq7Zw0B-jgSps_woyjIYjlQrM-)!vj;H$Li$x zU6L1&s!lOR8M+ZMEBHKHzo_#67*tr>e76mi%#l=%FY@oQ+%12n_~z0sc3ybZjpSK8 zZT9MKu&frN#CM{a$krY?%Vh}|jUT$908*T^{8>~3?PUYj{v@c*8$3}!lSxM2Ps)!(`F>Or1&30VfM+iok~ ztRi<)Wns93FWm5AP$fZKjJJzajfsBX3gLUv1lu%R4t1`t8`MutTVz$qNw?NtcTUC% z!?5o0i@>8EsP41p*%JYRF%iZuglFaaVQyT9!V{v}z{$pn9pd@w0+Q-a3wHHn1xUxK z_#XU>{J|v@T<`&A*?WuUF1ZWfHt-_ey!MwLXnWs<_@VddSOm%b3syoy8@)Y`Xkb__ z#e#x#^HcuG4a=g;!=3-XWd155XnPk;eF-^FA2-ZdQSd6q;g^`G(T;VG3D0AI#k&fh zAGy2nvG?RuS5U3Nfa$7p@-BH5b2){8684?SpKr|O zmKk5_ow)LgDH zynoH-Nec5QVM}G^ABjt4q=;Ja)y(?az=TWnaLzTRjlfrEew+91fPN182|;308tVPo z5}A_dpY{d${yin-DPAm6e)_(2?4ooKHwa13Ah|k?EW?Bm@%(YMu@lavtIs1>F8&;T z*tO}vetA`)|D6-^-vPJa^N+qNg!8=cPfu`O8=c>p(Bk{aQ_U;b7Eo0YvuXY0wPCmz zgqK%X^n=4@K;xQUK>hW`hqB829kNI^3k)SFkzi@TFN8^b%zlh$)yRxj^yt_jhFb%P zz6=?-I#+hdWPW)Ql#hmdf1@m)OMmnQ)?G;Ynj9p-Icq&ZV=@=)eH6~+G25cl5Zx1b zbR>B<}(zx#Pn+X7CLo11Q5?l-UTK`czg%A87S1j8jPql9rzL_|2wyI~kC20hQD< z_;meJVggt&U%D^vVy<`|*m`KKD^K7_7t!GR*S*hTGy<7T=J%QLi|kiJpbf)xD4c@n zsCfz5r86~Lglec&{%K|)5X=jReLK0K2Dv}i&l&xGxevHd(M~@9@GII$gR@#qD2tN& z$iFlf+N+>Eiu}mk_9nXc*3}y1ld$1pTF46DCc#dY*S;fMr z&R=@qu?6puP@Ls-43tMo7t~jGVKThQxoeT5Lmm|HfnnH&m?e<#$gUJsbG_69?8J$yb)mHLy8X4N6XjhesC>7_1s2LQy5WV3UJMb-10G1LS|HKpNZ&LF)$@o;j?&1r| ziv#~TAc0e_k7)W&p?y?^#E^&39n>s@CQ`@=2llJ^tMZ^{9+aqju)OGVN4i6BvNSe-DD#x<&~Oy5emCTx&g8W(FFH4x`?!d>CrV}rno4fa4t zZ>4)k2PM&nJ!16jOq z2L|=^CnZF1M`l8IJk^4nxsx+kaJGK+fzfoeqSZuUk3N|eNr5x?aF#cm_5Ky_xaVJ+ z0DB%fhAJJd_0tp){c@(FK0fC+9k!WOJ=R=i8v71A*YZ@?rX0CQYF$gke?@>l%y_*BgNlJjas83g8%e1BR;i9*{%*kF zuaoC*ipiLw#Y{*O_>qCO>uW{$DSRuk} zNSA*&R9^0=j-SijfCFZpyX75>_h^l;ygRhprdcl>ng(&IqW4LXG`DZO9hkycpg%%! zzNyHAZZpyY8^hG~N9I@gZtk~Tu9)2m;JBQynfGIIRmMY2hEmD6eba6my!6h|G7s1L zeniymx}5zLazR$1DE4_rc84&WQ>_n#TOadmRHa8(`-22c8mszxYg=MD&jK z;}&|iE}c(ivY4Kzm{v2`1Jl7nnTV=t3`aYV4+%oZO%slXnm$;9j|!f_H+!8qVc3&a zvCEU{gXASXa03@)C*?iQASy$|rj37smsq0MSE1=z=eAg2EZBlvHY_V*`X62`3dS6R znW)-Z$3BoNSaY6kz_XYB?X`{7uL%kq3!jhPsLw;Fn>%s4Z{hgmA{`uu@ACcjRVJnk zzE==VM+e78mMDg!A6CnXV6moUx?LuJiC3c}vwpx#T|XNlc)=NQCTKV<%451bqGEHl zuh23|+aWQME}twpGFaPNW=kPL=2fT^hU?l!-}fgd75#u^dH2$e zx+8YYl-%3~rRu8vUb*eC{s`gJa9ByXjp)bsk~g%r)}&d_6V2W54Zg~H z)_-o9Gu~iR-fk*{f5-bBVvg7S6%Pw@2oGM|>ygqy8%B#nFqWdjTd>CG!87NTnlbd} za3?t;vn{tlNv}y2fuuL2`asY;6n@?ArgJ}%*9V9T{Ru#VzR-;J(!7coCt-u{;szAu L)#NH=%!B_A8|p$` literal 33490 zcmdSB1z1$w`aV1}f*{=}B}jJ&lF}lf2#SJ$q=<^rB1jFL1BePLNC=1uk`f}_A%Y;? z4bmbV`&%3JcRU{T^*zUP{?|8`+qL(enYGt_Ke?W@1_T0$Kp|vh5ujy6aL6MNY>3Y< z_}UxXR|oevz%6i!K!XFmzx$F!Ajt4PAD?d^5D)|*!2!2lZ~c)L6GDN&xZxu)FIdSi z1-zn|Qo&1@s>63NwIZ)D^+(z;4Wi@Vm<7iSIL3DG)ru5js)Qe5$^>mNuX$xL>1cAfv)7MVE;{6u;pTLhXAVOf)6cCu_%!Iq+uN3mb)E%kBG>T7Rnk6TbQ@vvw)L&Oy%JaOd;QKOd1;*2FMN*O8ynbzukU=|KIN8+b?1+0o;%Z z0*sLyQ_QcAsS(Ks<6rnKyuZUollZ4y9!mwTW3o8tFjRnthksTlzQyyq=NRxoOdcl! z^OPA6$mlH4?NUsW#M)oV_^&Yk?EPkmExo?I5oS3&>~02ny)cgo4@?KF5fE;prz_z<#0f@MBCm zI~69M`@g~gtY4TUpl4-*fxySD|0Q;K?C+&_@pw*IL9WaG(5=l#$Z;nIa)jc)9FIW@ zA78F_Vj-uk2awB35ac;+3;Fk-g@W5;f1ocv;GtP!8*mU0{31Cfhx3oBz^=WAQ(ys| zcLZ|(3;z!5_EE^c?+k>VcLtd6{{!DH&Ny)WSI1{QoVFf9ZXZ1%zrpiR@Ov51FWmPJ zuz$S=>j7*FPk@}#zh;I185O&JenA}pe4W-`+q)zb)OmbYcK?j~ukilr{dmY}J8IWf z0=w1zngiG_O9ZSjW(XvR%l{F0i~xx5g}ew%4i_hgyYGL=J&=um-)YG8lm8d_!ZQ37 zuD|;d=%pHb7FB2C*&;_)<8h{pw%- zrTwh)&g*ynN7(|1$2#EaI+TFD z`~8ox|APbPwJ?xVocuWl?<99XymrDs*WsM)w>f}g2Z$l~z=m>uF8ia9=Lc(m{p)!C zX1fCHWi$HU|NicC<01D2*Uve^zv$){|5Oj=OPL%rf5#61xg$W$LJG`jew^Qe+y;*C zyZOv-$MkRcc?{j^bA+76y#RhV|M~X4zjyAm9le`V{?tD=fx1I6zaE$?0AGIaFLeO( z^bnZK8z3+hLLQ(F@natY@;W%T`JA`?z43m=3h;N?LC#fr|3M#LpBoRkE&1%`*FV%% zI2Ke3Ct+?=V1wN7ukpiq?sH}$5buBD_as41d+I-sJv?rJf6y6neIf!mE&u0n1J;4v zyx?c^g*T$zASXVE$>sWM{I5a2^NNQb6+dW3;R_~2n zKK>IMfb|ePcMHrnev%V3Nvr@HPyxB|FY#mI7!W}22oN`QLHykO5&qydxj*3ZK@6V@ zhTQHjKrVSIU``YZIQXj1|4thZIj`N`&AopZ4`Dm55W0!!2erv$rk`@KYx{7nUwPQ$ z$NmK9KA6M)`+n~$Hh_OA9CCZW3b{oxLrx1J|Dis`fjI)OfdTEG&lPJ#;xI-C6ejiO zJ^+)-g1~5i&(w&-{z&$4?ZS8H!k0PhS1kWd3+4u^k&s&)ALQ;w3^})4{R1`-2YHWQ z{yF~oBgLS0fe+Vje)igp`*HL*zy@Ca7{4UsJ#pnfmesDVZ$?3`PembjFMP-~O&W6C z`cHF#$B@UY!;j+?oEy9mYXP|+)vxk^-5N(K3n7S=>qw`1j-9H@dPN1G#3% zLhjxKkXtxC_kGP^O}d!>6yV^O*mv<~ zf*A0El@$2E>L209iGRR2p9n@pbq}m^{>x1uv-Hn263?H zhxlPmK@AL!x4*;>CfsQu%8X=QUz z58ytmFYw&>*R?U&=il93U;d%bhw;O8k8&a3-F+(0e(m?aV*lF0^F%NorUp9jV?Vgd zujFpc;nqgPPdIoCIai+lvHu4cU0$64-vfSb?LKs?-w|@jSKFKnpQZ3+UIfQdzyrMg59(sD|94F~47pUmHt@aQgRwvQoa+G_{3-Tk33%VNpe&vkxxpv(Uf`(gY*#*XVhi*qm!@bM4qu)V`P|Fq8gbu5iyGhqLv8mRez zbu7m3Vg0RZ`1`y0KoP$wh#|jN2Zrqs_(ZTr0p8aG+b2B7h3ow8!Ib}sAI$gMVtGIv z@Mpf`AGqQC#_glWuYKKD>~Op*6?Dg7NU`93D}Um(J1>l-!vVVB1J*+~eys;!uM^0R z{J`3*+b3V>)~GAw7P9|e=Kye=f5-~vd$+%nGmQJQ?BO{Lyq^O0FP~%F4|4mjxZxJ| z_wZiC6lM~*mh~rJyS1_B%*3FMe*b54qkrNBTFK~awUIq3mh?1yvMtzY{M z=s{^jlefdk(L2R|#i={dtTaXF*^vWPcv~mmYWX0(gE@E*K2_!SZj7 z@9S9M^{KCGRPeeaj1TtX|91~u?_&N<+;G3JJysl!19g2GOfkUjL-1e2{He6X|0{lW^t&cow@ z?XO;R2XFyliugWr@QMcl96>-v5bzN{uS@){4ZtzIUi3ZiIcT77?3f@D6p;J>2=zZ6 zv+G+6`J}*nVDX=99+vZ0S;PLT31F^20@oejc>MW*&tX1bJApZA208-AYuFEd&jWnF zNn#b`Z@oazo`L5Yg7{01@g+oJ9{j)g-3KNf>m;!unIl2m3S+;8T==tQj$}^m{Q4!U&A%KjiTL;%s*h zH1q(}#)U)wYA*Db+`wFYt0%j*1GvcLf`DCjfH*D&=4`|mAE4*SwEva;?0=U-;NRf= zQ~N-DJpZ@weXkF{y8b8I0sA)Ly*KrujezSU;NvARbzmRwU(~JtE}p;p`CZ?a!$l8l z^0V*z6`nu!9;_pkhl4PX8T`A8zdPhV`gvfha7|PM_^$c?^L2j;=g<0q{YHh5Ev8fE zm-}}9DA1pD27YS=*8vU!|CI+gm;(NL{g3#8pJ9jZf8DoL@#}qCKN<2Ly^RSWM__b8 z&X>kU0&*T+;J-CM-hB)3kp%pD1K2A*@y9u76dM6K6+3v|AI0(~I>Vd*Ty!5sVD3<3 zfjTJ}7$Xnh6 zzkmP!ncrUTu1CBDdo2RU;q`bj;9GgY++7QB;sx^Emw=ODkSh;@y1f+01Hb+1A36U9 zKhhoAK_I|?5VVFs90cz`g9ro;+@irB4uD(uk?s(*1-CN0AKU%l0(?!p`|;f`l)~40 zAZWJ*Uqr*#poJUw&kTHN!PDTE``322ThQ@$?Ljaa`1P}vc=z#O0RL|LrGMg|J?G1K z4t_T-nXlvi+J3?1{uST<;Vy-T5Ag4{fR{n|8W8)Hx7`OH{0FbQ9RQx;_hH`Q7JO~D z1vKxr;O*TOG`s!5*Ms15KWgFc!}sBScU$nl-4=`p+y$pQpxp`3P(MzHM}r4GMW~{z zcp5w$oFWmpdqJab`}7j{GZJbligH?x-Lpkb(exb`1~-pRXtnh@pSfuf$(obn7?6FR zhs8ULu!$h-IHRC9$$ldpb^<5zl{zmR0zF@bh*FY%fiNtTA{+j`6O8=c2qvZgQ}gV? zW4Ra4N95S&6>M7OMB9yr7UZ>s>z-CC$a_9FyWu8%-QvoPM|x*VmbctWm}~1^A#)2| zsY;N{trUqSs4^lZaYojg%2kc>f}Y1dgt23W`s5b`8KrDjqgo9%d@FUG%jSf+vBp|KOHj~IwCTjv&7M&Zc|1RA{#n~4b5^BG3lb|%y1a)<7#Nl27RoGCmnNB$5$ z+8^cCPSelIGOEhxB=K<$Nrn69tb3%I+gm)*?Ye7Q_;PZ})!s%?VQ;kZY&1A5&k{M` zt56>koO7hO=cmD^OzD0hSPyF~({+jk;>26S8FcK9wb?`N;67x}Q>^ZMOnfSHDb!q$ zw48JJM(^4S`K(i_D{56QT8x!mUDKZ1@ZPqi;2J!eFM{X9_X?%#6H=I7iG0;IU^KIq zaNhICV_|tY)oMx0t>C-8T=YcBRnlWwIV081Aw8rHINpVe)1uTyQxsO33?+2yPW!`- zyv0EN(WzM@q2`%1LlGQ!W%*$g9wx+-RnuCo&JJbiMCV_*|4%&c!d2ju&HO%~Of&t2g!=5qvI%7lLy^ zwAiq`m?{Ln-Z(uh7-im4Y(@J>A4$OYy1$Lo;h3iCksIEwB^q>LfqID*24h)`HV5pa zr0#`hq#vuP=;UPSsiTzrFe;8FNa&Ypn43_rLux+NAj`~{C-IE(89w){lb_zwK|hxx zoq5L60Wie#=<(Uuk!AS>x7sDdm2hXo0h0;IOM)~*RGj!_-eEJSOI%U;C%INq#Ar*7 zIR&TbII#D?<2$aRYSJEo%g#5=gb?2$ZOHn(42y=jW= z0UNyhdU`TrL;Rk7nsk;CftrKYy4AXCNAconW^QTo%!C|2ugvCS6d5*SH|)By&86Oa z{TyFHh~J2#jmb3*pKT%KoN(M;r8LB8)>9}0_STZ4YB#vC2opy%XY&_D_tiDZ+v*+f zT;+&t45{(|XdSIChp{(G$kVqc^GGN6Eb){gy-)QDCxfBbF5-ch|ohBiv$`AZ|B`5EaxBbsEMJ&D8VCk*^!XkMZ6{ZE#NG`u&s9HXFe z?3nTsA0zgMUIq`m>WAX&^XnGxpW_p$shDD$ROFkP9&tIefF3Bd2~xbme&@JgpI*8%a{4So%c8`CH7U7Bafzn!c88=<&LR%`T`Cg_9Mle^EPgGl+Ql1lQ2#djWY#Hm(tJaSV1ykQ46{%e9_XG&9-UM8 zL}ScZDNjSIPtY%=&PS$I|1RzuN?AODYl~N2dxR75bA(<{TC)=hy&It<)i$_S3*JOaZS zk;KJ}@1qaT6DAbkn)8jm9eDd?M;7S;Wo+xwInh>qM1qqTUWOB{Kt9l@*WMQ`x-Gi= z2@+9=464+jG7h76<9J3!Q!J<&A0wPmCv@Tg9c%=8ET2fsbjhKm>==4vcwgO`(gFW) z*1a1Mv=!&+Z4@UO6TL#PPcYQ8Hpz0MMT=ve1UPcw)slPc3Ctl`S8N}R*QX&!MTr5| zz3x?lW#K4`^J;m&*s!X)Zcwx3g1~|XupobePyH!5Mg+vikvA+3)J3@psV1{m=w{H^ zW8Ef}!|yW~Z(tkcHSjSt=8h%2FASuG$dHQPqkg{8fB)90!)vKbGZN_Lnh$6t3L&dQ zArJi1_g55^4ye^JzgkGHC=Ci0jDANNI_2+bJ1EnLez%;@v!5RS7KQw%slDuBJaLOd zAyNK*FNT;b#INzzWJF^{kSey9nx;2l%kb_sxEK-pWNL2QnBF>4@6bH{Bz1~+-@}m7 znsW6?g-*8jOsnS`sU^yH!g8dDqEQk0)J26@>?NYqD?EZg8(pY%8Y2_LNX0T#8c$^U zW*jdI7(DerUx zxkpEBRXIadc^~Bphd=N3v2wSmDDs*enV>=KOeZNB4uV1)1bXNxkyAI#Rr#c%`vi8k zGp2D*;2M*>{&;&}Jv%L1e^cR+Dzrel zq`G>449B8%%k75kf=nyrt7x-%on?Fz2WJCiA2Au8v$gs7r|i{P=5`FyHn!^{^Q~(? zJa32{n9rk6YOPj621yL(zmu{gB-U;8se>gL1h6N)Bd(XkJCBvHkO-giuIq+hyWIkcr)!C}OQ zC-y`^+FWFnwqm;c+IxmptOocJ_EPJ+W3i^Fj)i z>)3?+xE*6(6K!s$+#Mx~1sw|O^mkj3j`VfmQ@8N^TaHs|o0H@SQ2Wla@!GTWZyU7bW#vLHd&L!OVyzyt3$= zPW=O){Ngnb2+@JVK_Xkq*B=g~s6Tn>A7r{>jd_tbS^k)Yw5hU!HwHT0H}b~!L}$8^ z`4NO1zNbWxaa7ZE*s5NGpGSi1LTBDYU|b{t1~tis;wE>owpT+1l;)VM7!exJUn_d? zwwhZscgBEo=QOrPV0`wRsOLM9-1wps`-PpP@YbHT_3m+@lB>{ll+xZS`bL8jL7tg+ z2e-GiRdMiM@0vrh{mNt475p8inin_KG@jb07QW_kXnG}eq_|{9DEGp|wa(#$YHQ*M z_wYb*`tp&1+uWYhW=|>5L{D#>l@`eKij?%B&8M~4_u9Rf^iqzQVfN!EXEc-b7wR>h zI`9-#kn}B%zGGS=T$mQ#Vv7|Zov-|OJFY5Pua>fGSwJ{_G_5fR$dT!nV__#(-#>GM_B3d++G?h&|1;)x|I!~~=8+HEDN zGB4Hi=-L-IEt;qqrdIK}&GoMyOklb!Z*kk9d2~c#m|jQP(+D}3Y1Kek*0x^)8=d4k z$ZHUAkP9O??3lUS&U6G1*S@rn$Vv6M)Kw8;+6rR}F%#aJyA`5HE1be*eXFYOj^R#& zS62o+Fe)9)mw8)oAG*B1+#fPFg4_LyEMG_=34yrOe;8jQcVYSTqW-g|_T#OO1bvUE z4sq+m2tD-4ILY`($5B%1U>T0bl*omZx6-a1-PF%tMlPaa`z;WDtEoHj+=5F@0)bXuaFZZm`4u%9l2G7OfwNtAyw^il& zLuU{B5yj{DU+1+I{^TSXA#*2?yxk~tG;k2*dk(43O^>aC>L)BL*qo>jBEQ9*S#*ec z1Ict*&d#GW-7Yp{jnHH)#t%DXf1nfMC`bxRZ;rqTP&m*BUfp&6%z(@>#6&@*MZ+ z&F?Su)k4sh)yNaBIn<0KbB(;YTRnWy@U1mDcJqCOyofdSgmovTH5RHOQgUxvb>thm zhgFM=pSrlQWX8^}g?zwjlNXu2H^vem(kz98!4A0^o2ToTj2>4ygQ8VMrrNF>rqa1R z6D!A0iPCUNEwNdo)sSg8-8|}kzQM{wy!f`fCt*C|9P5T^DJ@-SZ0ZStGYkzuj<$Tb z`*z+cZhd;?R4iP)?}(?Uz$d)8)`JKEPAn)-dl=KksdVlvG&X7^EIc0ns?=3tc*1+I z0)4>Yl+n{O1|TI8r13UVQtsDHT|B6Cnwc^S+?l#rDV{`PATxw5>>fK^lvp;((5R zN}?39{q-cf`4nUD5NrKV2RFG?y3p;KP3nwWZbN1}SDDFkji!V#adq>$4eoo!z4sT7 z4mKa1exQ)eNYcKr9MUka#nxrW@cNTZO1#O9rrrYYf6-iLyLm4e+ zueLiVMf&We*O4E1?5fszMA74zU+!V7Dw7-xF|}Y^;@Ciu*zkc(f@(Aq)mkm?A!gi{ zaip9NZzqzfK8#O1pn~Gvck;NnJw=5^k#b5i6HhGLRbIPLk*#2~X+Q-cRPa6Px;blhd{@TUnBz9*UP<3=>aMFj!VbdxWAXRL`* zSd5k^=T9Arq7Uur7Is!;zLNeN#~zC_CemsjjqkYlNej(ZgBI`WK>;RmhKtSVLjkw= zT$)7vdZq2mu&v*PpUbH1m)Be&LtJ)QN80Q9qY;Jb1-8LO}Zf1c@=kJADL){bc`vW%W^P+6(&IQ!91hUuCQr;Kg(d9+&R=9Ns^0Zv4)E#V+&Dj zb!Fr`milwb4T_qk5em{bOX6+#s5bD0=3T?6Iy^khoux-EE;lXRHM8TqSU_QGRM_|+ zq9QX1bxK4(VvmTmfrpmHqri&B_Cp0D`=XVdFLX4>QlVblUB$E1CbCLVw>3A5_HepW zfI4kUAo(2G6n$+mb&3tsN*W7=`=7#o0>zrY+}l)Ap`ku0Y<5bw8t)-}PS|W)*kjXu zIi($Btx#ysVTrR|r;pPGyIgJmSO@H>?P2~VAJyD}RL^*iC4@vm3Gz~+Nv_me{CZP@ z%AQurt>+e<=kf0!xPJJ2;KId1_W7GUCZ{cI`a1EIH4~XcEwiE5g+c>{QPpP-5E=0>VqZ(~c4^EtGkE#p zZEk&%=RlRtWt_U=g(_5Sa3QiUfx01NXr+!Sz3@uF#0io8i}vI9(AvHqSfcJV@cT&f zR}zJg)z*%b2=yh#=D6I^8|2MVxvK8_dV@#c!=#~W_+S(OrV z4!_tG^{mE*NdaQD!X(kdAC_)NM&_GlsZx5g(TWBWL5Sja%nFMG)O6b-;Ct+Qc~J?$&9iXmjer`eUN!nx(ANywbaJ z-;AGre_``1sca(oIRr`-JL-bR2cv+fh?U^A!fPF5H&2Kho+ebr&QZ~dFTaTz*jJnC zjC^noLEkYz?g{D84bgIucUer&R&R)6)(Y)w$nw-*E~JfMV-CrY1Xg05_V3(N+c{gv zL$%*VNhdg?w)={_CO24P19=q+ID>kh^<$?JEedGA1H}Iq3Z*4^&^}w4!0ZP%kgZ(9(BUu$qZJ;B&_XaL{E ztMM{Nm^gOxm5-#Q(?xjce4*y-bMu$htsY%o6zTbJjZ5jM^OPsaOZD+=UHp*1JS5Ho zOJ!@|ayl#xFFk+%dg2{^G)jx@z7~-T(TvXwr^g9S^jXn~2O%|~=h!&RlR9fq$ISBW z3d$Zu(Ta|KOh48Wnuoemu6d-5Y|x;UH^2M*No#I1dI}2-x*=@&1=IF$@mTINc!*Nn ztMZFaS~zg<4u~gpkVQV1c31Q25zSe+IB)v)oby>~BNV73sNdT6(m+xoBLC8$MQ&Ty z;bHSjHx+8{X$;;d<<6$UyQqXrE#OT5SnpzSPGXD4X0?AQ?|qkO|D0a?tFfA~Qk9`s zi`p&92z-pgyi7Xw)tK>=ymoPc{Zoss1)tvcP^gmF~=;4L`+zwB_xh5=yPh$Uv1nZ^+Q>9 zjysoAxd#m%o=W3jBgc!YI7}Zp&k>r?V!1eLDR|Uf?b`Y#MzHysp#U;KEDf&ye4OT@ zqm4)CBoF9q`h}{FQ(@hn;_wZci_gq3Yss=x6KZqro9zMSyO1-uSY>~6_%8mKU^R2B z=!dXVcy+B;(%5ehm(o0M8QQE*IFaOPn@(YE{kV~r{DtD3|t6@XX)YltFuM%@L|Cyx#rA2ev zQrnAT#RtlIT0fyqpFyOgLJfU~`1vo!Io|?CYxg9|wQHh;>^2paoF|iPGU=o)1$xHC zs)$wWmi)q4x-x?}*8{^D9cPHU3fO z0u>cjof|oO4fX||og?vl{X)gcQkKi)rreC-_^~Ux?)brui;SU}@)CrsZsm{AAGjW& zFBltK#SNjOc3C8?x;^4qRUn(*+MVun0Xwhn8i&(%!%n(iAG5TY$8d4$z4s1#y}esF zVg?46Z#QkCnXjZWivZauB@Mq05>aZMS>oqt$bRzh8lT@Y+!92&KyH>w{Af}(qM+Tt z!tq1!U_xxji|yA?^;ka+3%;7oqw-rXwySjTO+^|!`lfUseCZOj9-FRf`g}f(%fVKh%d&6sl2Bw7WM0BTa z5k7N7D4hupwBipDU^^4I&6|-#W;^|aN;Pp)HP=g>+giTEF4~bw_M(Xel-b0wGr0{U z5!R3_oi6sedGonq6Q<8yl=;jf9s$i@$9DUIJ;!BS)$q4f^0903vI2VJ*|mrL&V zF(Z>{t`jvyo_D=`h}wu_*kuPr+sVnz8h4 zpDsXr?bS@O=h|B>620}z3C2uvWfFQGEZ;xJ>u(#cVf;GGWxKO|v>dI7Wdqct!_h2e zHYv<%N-spIL7Jc zF6r)Bmzeh8KI@T(o?0%Znewa{H+N*O)Oa?h=^fLYfIOrhsfBTqL&NyVBW?91%VZ_Y z*K-r^(mCJ_QaL?APsj-w$eKLnz;dPwrB1TRFn0-4tbB7>@=U~2XEviAcJd`+XUs@t zU5WgMqsh|=uaCM|7y5AD(MF#3&^9~4HP>P+r1!~H8(wy}O@v#pPoEf zP?)7rrLqx5j2}$-cnvG|B7ae_bHa!n(vJ{-=5?Kb;KQOKC`D5vVtZs(D;Jxdxc88= z&j~hy$rO~%v#mQbH>KuInD$0e*vuFrR}O= zYm&@Z6kJ+~!}lZ-=aXz*R}tP=Opa;VCK6XxOK3Oe-!{vUQuophueoi!4YQl_bWt@i^X26rz7pQh7zA znT4d3cVFoC2N9}HUBU-E#{#IYJQE}6WM^rbTg};cf;cz3J#Q}+^XTQ~L34YN*FrR# zH}|2=`CcQ~(=MNL?UfnZrZc3S@RR^(oK|^HyF6O^F%PR@vcg8U%mYQ-1-j(gx58PF zqy>`vs8m_rK`hb$2h<9!g|WH$Oh=qM4|3+|Uad2e`){a$(Xz8dZ8$wD=0f`$1z%e$;wUqcYvj_?HmZOayk4ujfp^@K2HTNfe z;%04Z0g1-@_W7+UjufwR1kU3<;4w=ccW=DWB2LQD5L6h^bSFO3ut+|j^Uf!-ezLn{ zy<{WuAA3(9lr-O@Md3P#Gi-*(tn!;l5YOsnRx*?daH5MOud`LVEr)}d)Dx4Bb+UQ> zcZv8f^EBsebQN=;K~~V05EnB`(HTA3++_KYpD=IsVTZ)UN9Y**ru_5fmu9s2Cu4YC z7SXW8JiQ@htxv>wf38DhV;s3gn5fY^M5R)=>xhJATniryk)V3Y_X#Lbi@3Z|Dkgstu%XyF4@n3 zzqZcH9?QX|m&uBif9$z@we9;*MWX=erH z4j#E>p;Y6x?CF_xjngkchASBzMs)LKV#8O_V|hfL)5YG#W~?%J9rp7&_nh~`Nln?s6pQ1ZJ5 z*Q1xoxjp2}HLBhEI7YA^Ii7zNxP<5--JZgq48mzn8&R%$@jNW`_@rvXMNXRiLCXA>lh^>p786F51c&smavULu}ejjl35aXn$YDcCG}QE6q4nU_YD4 zTO>g-PBZ;xj+rcY4ldb!pwrrs5)7=I52lXG7xClC;9f6`$ioh)K;c(4*` z)#R ziFL$^Cg!LWFHc%?D7)XLODz$d>8bu{2Ei#O9?Wzf-9Lx*saGj>OGsWdms|9_slEdN zt9eF?hTHuu9<-%G(6p@rzm3#NLxyutb;eH00p3YP?vp-kyfL)sLW(A*5{4~Cs#+GJ$(L06lr=LT(|c~#P$NCk{4t#$hY9WFJR=*rU0}c! z5+6t4p;@ORjy$c2?%XrU3WSeRZ87G0M~@&Sw$#|80S#0kcuPvsPjz%hs%2ON4S`x7 z&dUBLHN1YI%5QG4F^*&!W^VHDpBs+N0YZLkdR{$)MV3pSbL6dVUj>EYJS94jjrEL5 z1VRldVwGW_WE$TV($S+P(wwsr;#rsJC{{DON$@(ChU-ykFhcjydGC%Jg!te(_axy? zXS&7COeMBCWsUWd4&r${Wgm+0DMM$Gt;(ZCo3DxniYT>`6j%TaAF zg=Q#HykKF-Q~H+IS8|2cvdiK=UA9!=rZe!GL`c$LJQdbwQKrb_y7hBLU60qa25F(0c28#G!t8_YHEtC# zv%XiSwpQ

|7|i;hIpJ>Jy;Zu+!&tqr^D?!4;y;*U;BUzOT9nkEl6&Z&h*;XRCAGV~a37#Q=J2AaPPg-Qg@AbRVz~PS ztU=DG%e9;o%60yC9WS0m+8aC}jo)xje1}JcS5NSs2+bH$;$^*UR@&}R_(=VlyY(sd z+ySziLpLm|3S1N#)-^A7JWoDKZ8>0WJ+_f1l6sfUi-PL(T~&TPQE#1u8%ZqQOR5VN^Urk# zfi&{BFIBwdwHYRCx0>aD(&N*4&F+Fqs+Y5`-AqT$uxe0vL^I2$;VQhi;JDo!O?Q!P~kr zN7hLvAFt-7CC8Rk3SJ*>5%VA6xWJyvcm-E0g*WXANx(?u9Hew$Ge`QgpyUB*cQ%`>tn4FTbNdmdkKtxHEm(xK&W{Xz^tr*pSU0a+y1l&#tB#8ztdcKWeJ&#)zy~ z6zN2j3$q8s*J$ckQOeGo%e`J6|M*BpM`sqPplm|U4s%@)$dCt=O-tG|~Wx6im!c&MgVw#5_Dk zzOxoOt$MsSMC1>5R*2k5l=L$?nx}@qS$#+-zA}Av(tAMMqKrl!|0ummuO2oDRC7ug zizE}(d})EWYeuw>uQJztc^*^a)^#t_P@H<$;=!7vIj{6Z;Pomw)v7A&_8M$DvGhS^pvni_1pm%@KLh8=4Kx8NQ5liTW3@G*4eR zzek;<>XE+mvc-jh5RY2u;8L0%-ep23}_#R zG(@}4L4$5z7s2-OH*YaVSEg0><1fpy7A*JfL%uyG7h#7$`1NE<8KSgKe*fx6i}+G{%Eb3paY4}S-@P9u47I&i99jZewF@Z zx3+ZHd)@mn88dY?ZZ85D)e%R?kBI3eV1`CLR##UhR<_RE_sr%ImQj>@hkto?4fWLOZgdbE2C`XD?cwGIv(Pr}9$t zBPFJ*uB?#dTb)zgmp3PJ7vITwdCWg}FnXTlmRIoJ1aS-AiNUQ9J^sm}y5OEf^#}e+ z;gZPPly7n#ZB-Say1{qb%ex(=jc?9qzfHo8JD~D*ookUEksyB6ex3+xs)ahXi$;Aa z?2HN*0-eo^V>ppMuZvrNk+pzaT}HK~fp+rX1fIKl4W;2{Bz($cg!Y!9$-qHuBXM(K zcJh;0sGwp6X02D)uL+DNq|iCmbosO6E;Ai%Vm-EGClRPgbTbXZMy<2+^o~L-1v=pJ zeShYHWDzxOCBzG5fsXot!3I+AR42LzIg3tS>z(P`tS9oQMOJX?81V+pMf6yOb-@MO%hRa7b$ueyt4E$%>Fxp%H@rOWwAnGx1( zEG{{xAwqx{9+RYk9WYPXk3OHaZ;gLo9ee~Ax0JZ*A&w_S5t#hexLtU#o~yuoLVBlz zH1vFfzKolj`;oUJQ>-YD?@-c+B1l@rKRH!tmKx9g2BpnC$Pb-qz9 zTL;+@#0Oo88{M|HiqF2)sn|!qs1fdjK$qgiTyW-WUcTl(R(cXVv(2$!DvOTg;A!9ME(zq3128eUGzeXB}>$nSLb#piXkp^QRb5*7USDJ zib&!~#Z!2bQiTy<>GAbY1p;~5bw>(4*O^`f>)T^qsa&177k4_s2x%#~kwWKm9( zUs=_4)xPe7*M50N@G`3;XMO|Ve%&F4;FH(d3HX6MA3?dfl0*->h1Zv)iMZXQojNA) ziGRlrivoepabdc)WOP@4e={!YajGENTWT64HIST?t^~toj(F3KArX@2B|U>7PoiyT zdFM8yNMZeCpyNXdYVs-{y=}MmmR)n?)p2f9kAxtGrP)z(@$==xSeh(hLb*F*Ccuns zbp{ucP->jlm}&R8d6}86<#*J~mhc5QA}mQwg%2*$*3Iw5jbq?qFyOG9)R!fxbV9!i z94nnGoSV1B9ZoA@o@mM3(WEUuvZ_~6BJbYkt}Kg8l@OX)y4@6+P^sh-Q-i9Bz>B_O zsm~urkNeX1s3cF6=vZAzLp-lkp~i`-jXi6G%}nmlTGOY2Z9i`*1o{rK^*O&S%z$z( z2d=~`wDQMNmn#bG*gC_;jD6(ppfqp6j6Td8nV>eM<4!KuJenx7)%Qkk(`uWEX?I^_ z_BK(5Z^>$u)IIwkflA`lI>@ucEN5b7vQtU9MDI$5#*0i@Biz^sqgS_K>ug;UQ(m z;Zu0Ms^fD@r=#}Ey(y>FD7{sM&O;#JvZcYh@H0IcM-*7Gc~_5)w_}I zlL@-xEXuOMpOsMZb6F4>s6L}&AhBqY!7kHuh5lpNijXFamFcQ|B!4t#Yo~050=|LN zrp$yqmi6V+XFUMycBVfm8i42%|3^ud$rl9eC#6OycPeFR?9Z>!Z|-w(E4Z` zVcokV`5Ejd`MwVHkB>mKYji9Y+f3Nl8J=T1wG-(*4bNT}nGIG@zrA~=VP~8rlu>$Q zzPOcASK?@gp>Q?y(N|wRe;oOeO5BWKo-CZAdaN>0f?QtNCB;eGBA}-AIX-%69o-c3-1!QhTgn~znvJ(&= zsELr8le_?uwzi3@yu#F(@l8yF2Fgtv3iUvToE8)$M(HuwTZuTnsZ}Ft*mI5dN;R6# zetsEzv!L5{rc!Oz>z`V?aHmr}#>HO}t>57olvD25P}oZ$OU)#1Dr{xNBM`Zg%UDS$ z9LhtnKJ$$0MKAe&u>ui>Sc&sye9TLXJq=*drK$a+WuE^@y)`CgJfpVU!2#dvJCB`+ zqQGWv)1jetlNj>-0tH13v2Vf_rb!-7=m?Wqk$a9@Nl#W|gCBH7uL8Qv`_U)v_R3Wg zo`u?1hd}R*#I*Dz>PPgY*R@0>^$MsSPB30xlpdUCbnPfnyF?+o>Wf=uO#d;rTI%GZ zh0Ni|3WpH?jnTTRAKFaCwZ{X@LQhGZZ3rI2S%_-Z9nBEg$|bp2`LgQiOX`e=KF-qR zl@{|T$2W>IRG#Kk^oIN&j|})P+VZyT|~eb%Gah zRs8sCw2BU?G8a!EWsmRcb&a&*J$|w_=&T1PyF#){heFlV6SX>#;9E2g?ulOaI)u)p zk`mA!FK#{1(5CaWNx}K{>iLFrd^v8la^eGcNWLdR)!Ul2?iO#dqpK-~8b}Y)JX;$* za~7-);GQf#d7sL&lY4Wtj%L-&x*@j@-7a2yO}K>1NE)n_9vhcJ_!ptOQ|3@&Ch`tO zP7&Hl{=rfgV5B9fykh1CJ1gYG8E6Mj#C#ys*9#bLY z&TQa!GD@o~O6KBO>rz>{k-0abiERCb8?j@QeLxn+R+uq%MmWjKH+l`N5~E25w;!tR zj=g%-QcQ0}ZNVp@64$C~Ucqb(oLFSrDR(jOek ztU^^^;_jbsNmDS5sZd%nWR%2~iDb@Zkd0L5FnR&3VYPKMUtgF}|4p$jf76!d z<_i~NX!8vUGIypT8UQG|815vA^69JI*L9>Dw$h&KE^S3fNtyvgk^t z>(_iV>T_>#CaoW(T52yox^j}&L2HlxgM;-pFWxIu0Rv+=@82}tASB^kb?4=l1VnlN z*r54^HDiPnn(q-R-pNAj@g9RjsUzY(FST=ycK)2GMnVPfKHQ7V~)=m&5sIrG;5{4S7V?Q0IVbhjfF4j zkdle`DzAhiGyX}sFLTgQ1W(orECmiqK*=#UBHNa(ANQgeNuF5txc^Kn_-6-2@H@1Y zVfhS)b;O%=z-Od0Si%nj{LXcff)hgW8>JDxt2T{N8TSNM(@h8#m1S!sV9%(})^bSM zH7hxUVWRt@MOJXmR~%pVcw*UOuH_I7kkEH&FT?U_o(z5d6Y%~)$oQ|t0Ex_{h&U(4T*)dF(BDPfnrb`iHg$PgCm4}sOg|OPvH$%ypmcvsGk5dhYr9iEWfklixh^)RTJ( zOqWAO3z~{!aHPH9;iaJzF22661@%yIrs;61>2jv!QV%7e8Em2N(h>fJpvBJ#`2P?D zgDm_o_|F8mz!TUlByTN`@-4L~)F3N?E?vPEfGaIU$1q;dOcWzFl_EyGSRuH|qJ+KV zf!>H>5NrJ2cD^Db@U@^BNfz1;3%4kwn|If5xEF75=crF9N?mD1|;(V_2RK zd*3tLeL;6h$y!Ir%2mwl3ipo-U3^h+v^E4x#rs~F9j71fD3QB+! z7IB50hOVNpHZEy4HlDH*8cARv(2{l}sfUu~K*j$LV`2C8d4Y!^dZ{{eV*dHC#ecQ% zKg5s-KMdKkS``j#6@p(V*7*0eY1}ML6zVm0^)EzRf~J*VVEGhhf;K-V;E#vJ z@^=}!XSXUGm=c1wcoqJ`$Ta0F%@Rlgd&w`j;Avm7)wouyAlCflhM~0t^)oyf`uu`` zcOnRfN%&!ipXp`ESBIPp+dNY`jJO$XAj-)GM#r`NjX6H6L;kZ6d>AmpDEu(Q3IJAm z2SVUJt$93Z^K5I`k zieD;^@v_P$#2}Rp=k%AL0rfc=euH;e%dcR0Qpmxr@LMk%LIJ=9I|TcrUUA^vY?kET^9s4Xtz7<~fdqKL4HA zRI1XJ=_N_XdWMpaqS20>94R8O^T=!KWG0{r&Z_ zp%p-vnM1Px%38iwDt@9+<>i%eyxbcY4vdZqdz$As5&8U{wfqs5QyU@6e>HLi&|&61 zvzWNaW?H~^I|Y8EG{)}I2n<_8(T2gUSpBwN=flSEJHRJ^XrsmYmm^mI7qRy}u{Qub zPfC8+E%B<#IHQFs-BXHk27oAl)*`mG$iq6|?H2x2z?`-4*th4x-z8T7Yq0k{v)$&H z3W8TDhc^}~+*ux{;FZYlT81$?p4Znr$JwyWUs}T-0AB=5ZuKuEf0eJm%%NGN0v)my z!Rs84?=RNaUmind^-z+HiZ$`pUh^DnzrjBk&F=#r1zO}*|FYx?U>(f7XC+B^KuEsJ zDR6hO#!aPB!70u3cwvg@||vx zR~M`7D2^bMmzNdy6Ki6N-(Dta*LhHf++z**0FMAB7yN4@e^sxO&cG1>56d%!j3;y+zzoI>0RcJ6HB(G5}-{O_I zwOEZyi-%!4aT-_)I*8};`E|~QZ9bzT{sPO#fTtjL^>3710rZfLB9Op#1TRyH|H~=z zwZ$5nyfQe2+$&fQI*Q$Vzd;Z*`HBwsn9=+d@Ht??T6p|*x#0JL{B`UDd;V+|<${i= z3BmJ(;@>(huW(E3D^w_Vy@FgBoX2R0+Tb@aL6fH=pU;?xzp<8&Tf7aQ=kONZU>p2aOeC`~S33oEc_pe&5gfPE zi8zE$#+umDhiwSkL_v#FkvvTgF*odYmVRrt} zEX4^3n|MO7T}YlGCC`@*&sHwCx&=17C5n#M@eb5rdI;9WRz30_gU;g}DMqo}KTQMTdw&g(`wwLh=l$xKk=_S1x;%%VxJg zRe31Ki#>#_DFtidFCE3Bwj!S>3aIOV6FTHkqq)}@?ze`+Se_o=Mf>CfaPkLpp-+-a z48FA&9to2xfb_ZPU9$vDM4?7i2&RN&Mo11y#WSSCjC9zg9LAJOO}Ti=K}e^g7-Z)Q zE`PcwYy3G}{v=V`ITX~yR=w-Wn+QyV)e$Wn(9jWQb;J`^^A)3c*c!fUEst5l8Ea?) z9D749@M+SKcaQjyhPkv40Goezmg(DI`2;S4vXD#)!L$(EBqTe8WUo|glZq`;F(wqF zQc;i!Pe>doQAnf^NFg|Xrr)ab0lPwu#aM&2@&C0oL`D-@L)&QTMzdr!^Tsk~H7Bg$ zDPuTlEhjKMZ7mC7i~6YtFcZ7s^pE8NpCv9a_-QXF=lYratyz{%!{+@s(xE5>H6a*9 zFd+ovLNW%73duN76@oH?qKHF2g+O5AgMa}aivgO}(#Eo6p^o94wVVUaS<8|&ELzL5 rHTXIp*!K#|r~fCkemNKPLFE4cA-}&xs(3vU00000NkvXXu0mjfX_wfDMW$A8^MoPN7B$SYDQDCJzrDF+6X$fhhLj;siKvp^=M3D|@>F&7K zZ(m&3D5$dXUu`zC7004lks34~a03gIi5P*h) z`1Qc0*aGnj-ATc~6#y^^fBXRfX&GbyfT3nBE32+<<>=<*V5SVQps) z0G{KST9(>c-$^8nruSu(!(q>q9W{y3Xfk6- zumEn2@F%wbh!0@Wb@Qet5b_)#y0fb%zQb05x6Fzl^}JgAErW=BpdlKEGpe2*CpAmI zA}Je@AQTKuljdykdQQ$8$d5a__YnYc;)xNX-MjGY$EoP=7mTUJG3HopM!BMY^l1Ka zaiGje8UVhz`G2}(=X!kuCWZpDzkI>C39&N5%z1niWl@bQT?6ENAJ^M+`oTs%H}37& z*y6&%s8XAZA+$%&@6xix7_N6=cj7O8esnPVevToK_hH~&$nk8;$NhT+lmiLqA&(}P zV(*^UVP2h6eWq_yeDqeIm1tgrz&S=P?dcwG0eyr_!mW13p)0ew8TKG z6VFln&=l!VnHf*t4L)}S0J{y2AHJ}lA;GMIzYTa?ZAo3+&0z#!7K#bZ0AM7?z^UEy zTB;Kb0OWE4Su1Z-?0+C*hoew_K%V@7d2S*YBE!(uB7-M`VFsggF}YP9B*PNgS4qWc z!u3U(iXX0F6`JUT!`Y%!k0arPdkRI%`oPi{hz_~kg+>Ua8xIFPiqyXugGT!N$uZpr z1qeYD18sLWkp{hTynq6aW~4T)jsn%LgbP?C?7^LP@nT&7Z_s&Y<6WL-fz=ukU$AOq z-xdqq2)XkDbI{C-y5&d>5eKFNRUQz6KzTU2AjCt47D|0vLI0k<>Zn37EhPg#{y4f2 zI#P&63p0IUvGNw2Ue`g*B&Am zx-;aUdGkAaNjks6jhl(x<7T$is3OnUY1z7-EMzXUF7Pc-EYR&5Vq`v&cFsT6nq$%I zu~8yl#9QQFL@`h0y{(g%ra4udtBo%Zdtc^dZms4kjj&=u{>Nz|eZeG($^|c9Bz?YN zMQU|q{c6SS9sX1jwQ9T7Vn=PMe1C(B2o!_Xd#!4+`5HM@#`BFGw3w#k zuRYo6Y_ZEi9|sDwF;(@A`MR?vO*4%q$A%!}h>U^Bxri#AI zQk1giA3065b!+YxMIryaw>;(#Y)g|_oCV_C?o?ua zz%9>y>z-rLv{%#eDWxCR zh4zL0Y0<%5EPa&MSPUo=Sp8(;?E=n@;#6Fn6FVBR4_l>W3!q8Rly4#NZ$F9W4d02r zgZtFFPo(f9SaK)M9a2=8+G za{5U6Or6Pn&-?7P#kKY3iq#AE3k^1F8y%k97cnT%*SY`j^_`cQFB!i!ylg1KFM6w* zs9Kiw)v~p6r?$Jcq>j9DaTH~uqSn6F4{G^{)UvLLC3{|SUR-FJciO=C zqY%8VtFBkA)iKNX$&75k%`3Aj@2gKh5sVRJi4+ldJJ1k(cI@p-*Bm1yI$?fTJ+^WC zY0lf*#J6LEUIs0Gcu8l~wI279?r1r+Kfd1@=ZU)i%GW_u=n^!l)gO!bN!Sy;P^lQF zaQz#fcv1vBK26HH&d8n0CCg2xTk@!hyy8$2V3jQ8v=JW{ddL4xs)N(Q;N!4PC?>yzN8@KM1 z*?LHUqp{ca#`h5o+gq~% ziy@2eOVb=#hB(QkDN89h4%lPkZ?I={-)tNl%1>~m^s!7d1lP*G&1)8~Z!|CJ?(Y+m z($3f3*FM!2+#H&!fsPzIeA=Y&X*}d#AD%F5Ji3tVem|iD(oq?<7&bpsJbQg4RS{A8 z{W$r|{^3hid*_W#q#>jW)SEc9BX7S9Qw>RIYsP+MTf2+XN%Q_PbIXGRTM%0(I-_Im zrjwl4!uKQenImd!(Q)^uKIPv~KhwBVSyFM?$fWJ2-AUIdz9KdW^%WHh8zynSH%cGJ75#>e95J4KdI z|I~hy*AB_m*WoM?iK(VNZ^xtdqk|ceDSsE{i~in*F%Ra=myK$T#{1G6x5s3s!iJ>` zFDFO0CIf8X9yxoTChs1hJP97Sj6aCQl|_zy9@`s=9lDk!EGZ%~C*^YS{k%waz-)ji zi}dovWp4#3377xz@Y+cKr_@imDZ43&&GxdfbEgjVFyFK}MjP`ZUHa>Vv zdQffU&ETpn_|gWjTv?q|9cT>}oh6bdCSF01QuoeH`8Xy3K#ba2Ti;Dz<({aiqdh0o z%<+*qr>DIW;vfnD;!>VYP*YoTH`+($mevju^ji(h^t9Gy67+fkD%>hgvgTIS3f?Z} zTHdPKrrx%uB4+ebk{IHiq6i1}=5A10PkTEDS5Z$1`rrJDB0m2p=Ax(lt%{qi1pVzF z4btkXsME?ix|q`na0+sm^6&}M3W;#?2#5&t^0U+Oa`Omsaf@*A@N;nUh;oaFa`Vvs z@k1|(f%qiuVrC(#DR<|O<`9wuy_K7rlPDLLhldBJ2Op=SizOG2h=>RmH!l}2F9)Iq zhpU%^8`P7-!S&|vPX6>GXYOk1V(sK+?dU-J!!Pua<6}1odioy?{q^(5xa^(&YRJL$ z4|WKOT%J%TE*?&9uK#3YX8M=lgGO=5kOsb4gxqULFn}9u8h1ZC>6V@%SS! z1w^^I|Ka5Kn%8`&IGR~oc>U>vmxEi7gGW%CM?jQESX6+UgPZ>^AOEO%-3Ma*m_gm3 z|06H|tosi?W~QPRjxP34H%V)IsHHiVlY^x=*WZQzsQFh^iOM?KIl3UaWiH7l&h?*) z|DzS+I#vDm%T!5M&AT$Rit@68JR*XE9K4)7|8(<@djIhATf~YgI=H$)9Zby?g!{jT$0IDlYs$|n%wcW@6+z6oxhV$}k)Alrpr%5Pcz7Q1iSP;h z+0Z|n{aZt7F4lRs75EkJV;1D(yEGS@%kmF1>wlll{~3bc{r|)KzqjFG zW$y5^W%|3T-)jALC$5ebZXQq<^V^n)2>G96kl(%jtJ!t;;#@!W6g%txKPJM_!QI^D z|H)J!CLD^`kIh|NB`sVW?P;M-PIlI&&>z#v$E#&*b;- zSx5ZGhAxW8Scuj0TS!SFGXB4n{oV5K_4R*b9=pfCWfmb`Zf+4CE*@^g&mX4$R9`nW z__^sn)z?k`w$yR3c9Z1&qqS?r|FHUT>iB(2)IuDP&3_E-deQaT>eim-cKUMGi2cU( zN8aQW5d6dFy5>Jx8vIwwe`x-&{C%SSaghBj+x%XNI3^=b=v;pt(f=(G{gto(cYgSL zNdG&%Ui0;ORW=X|bdf8n|YDx%dm$&-q-_{=#() z$j`-JxPH#(n)Vm2Ye0T3{=)ThKG(Fra9soPbMY6hpYyq<{e|lqke`dcaQ&RmHSI54 z*MR(7{Dtf1e6DGK;kpLo=i)D1Kj(8z`wQ1KAU_v>;rcnBYuaD9t^xVE_zTz1`CQZf z!gUSE&&6N3e$MBb_7|>eKz=U%!u4}L*R;QIT?6uS@fWV2^SP$|h3guSpNqe6{hZG= z?Jr!{fc#wiDK3n^zw~PEfcU1X2jVNO?B)j-h_A!anks0j0Dw0m0KkF);N%MN`#S(U z<_3UO695oR1prdV1mpHQ0KiA6D0f@ib9~*;`l*?L`&W-G!<+Osj|y0A`${(}R?WvZ ztbIBnn%$edfvGRr6^pv5O}oS=4f)jqXfp*B>w3}pA$A04&- z=xHHt*pO0URN7GXuJ&Wk)5VRW-T6jRWeYP4Gu_6s>8Sd<7&?!2bUO_?j~R(0`CU#ouBJhc>iW)-b*hU7CXP;#6=Q<_L z1NVO>f_>_FcKSS}-3^V~)O}~9_S;7)6d#h;NAN6f_s>cn913^N3GaK5j-C;5Q&kEN zLSZ|-m6L>U2f|SmA7KkU^h1qgd<{ygt5>eTcuY#~D~I{j zWuN%dcoT$+TZ6se!#ukyt(@1&b)Xe-SU<=L33zZCZ9jUD_rW1Qs|nRT{j&U{3C-J; z41Y;l^aGy}Iylz&@XT~5lnUwaOQIgtdKlv)Dg4wBQT$?b6B78P;RN?O{;;cEPH_i0 zOKDXhWc}uWt(2Ui8@)Oq{LNSux~Qpi2d?k&o1hD{d23?m3&Oy5Ox{e0c=}7k3@!B| zVcjJf#)3_`oF=(V-ixxa@cp(XH%l1Kk_pkalWLA$Gls-b0%E7k(|3X-dOK{nJUqXN z_zBRuvE<0Ysz-ac>`gar;GLktv+&~H#yd2L_@QSruB4)zrSkHqKwP95esna4cH(^4 zelmcjes_p_^rqC5>GDE5>imJMi6vQ;@~aI`Y_T{rqElxpu)0a_l{1CZJ|=u3fE(+O zjqBipgFfov*h?OG#fJcI5bTBPB>T1+on6cprDNRw(E&DVet1H-QTki{*$-DhB z=s}ApqNqa~1ct@Xlu-rWx2ESF;;%rTCHkt5k_c9yr;^egLkSDB`V8Sto;n>WTiMhk z;Kq53meVS1&sPNG=gSi!%knM1(Xj_nD?nDoVN9@{=uadGUpf`pE^t&Zn|f3b4XBzc z-lMVCGP&Pv4Hk~Rm}4{HRonwa@%6{lIdRa=MV}$u*Zy#SJkYEh#q=oxuA~%j3*?Bq zEtUq4s#c;w=^+SoPDA?==GTLH__4J&M5b04kip$PDq&33L5dRh`w?H{BzhT4;O7ob zx=NMIbQ@n8KzQ=7@b6nFjLj&`OfWvfWVD4e;7c$S#4{dma6Y{8OrerSc%O}cb?J0= z%XZclES$G7jbiv7{5%Av^Z6}6Y?4Bc?2B>8k|PSl#VoSBAQ}vIM>PEf#%?37t6oKRyW1$&G%tW|;qfUuBf-BqRS7LG*2`WIF zv*?x@CFj;6(`dsLAw1wyzIrGnT>BpC`^!^7S~^=y_}mhad`=NWY%u%DU^-NoJARb= z>|vr8#x`~F0P6*A2&idNM!Zpl3>9fa1kZ*6KeYmhB?c%gbz_PF=vdQGg=yz;10|xy z41563w&7R1kmk+zzF=1lH^mtD(58pgUE^x(ENe^eIu4%$2TAq{22S+bCLgJzN4=xMqHI!c!|En4nQfnm*nW<# zo(6JJLpU&q<#^>t)|;|F$>q2LciE}2k|BJ^CQ@Xt!*0T}u)cKOjGp4yU3ZU`3`HXA zz@PRDt>q_QOEj_1l7TeK_s~WF$qrmf=uC{;@0pNP08|bfR|N<)^Zdmdw?nw(*`Smf zp{Z^(fqSwt19vrQ7H2U?dTYQMP|eJ89Hi$B_w`nK3R3ekPiMs6z8tWoAB4n#1tv(u z2tkwzFR%k8R%k-V_t!gX(#`qr%`}SIzt^iG03|rqqYjNQX#Sy``W{N)w@>n7Ri( zhl*(m;b`Yg)c9swPr4zghvI>%;4EpdJGQ=Xc7LWAZ5dxBvop=Yn4mT<+P?E1TJ=^z zh6vm~p>2etVi@oCXu)L2zL|&h+C-OAmA>bWGU^2OX`<;cjQ9{ zCWOw~g~ubcAk(JwA$E$&=z`G+uAVy|*E;JE`UU^D>ALZrQo5%aJ*-hRryoGxvCLZq| zx|`DG7MY$684zgb5Bg=`#8TxP8EQ#G(f}768kD}uTe%}q8`#*VrTQzNsfXhNc#pil zAd;pyI<4}mh_rnm%yIn2y(Hu);9PLf>q{9Oz-LvLQ)=JK54tC8Nqftf7L;&!U|uTs zS+VIB2Br*R@6NrgYxF=z0MWCcS(w%@1oLA$BQ{ zZw{(|E5qyv$z!z-29?73aqtNW8(ZDykX$Ah^V0(rityGqMmabiU&bAc2pYZ(+%(O3 z%~z?Vj!%FHXi)cn$Sfz`@#Au-1`;>eA<{Tcv62FUAr@RJb;Y(EIFNtXmbc-gPqQ-WDbF`2aZ+6 zC+cQF`>;Uyg0`1uZrtVNULX}<-rFCyNI=1)aU>WdP~3T;$?&p#35#g z=Yv$8>TLG?^4F4Zc`!q~G=Y*_pd5jM+gK9g+_L#@00YWX9BeBe|yj>)Md=g%nQEV*n{d?<$ z`FQAp0vNX$P^o{iT=DBI!XA6OdNCAg8R5+{Fnebks8J~qpFY^TY zv+QLd-Df9svJ=@sxf^^XH4!&jEU*7czP@T$@G%%^P;l9S>=EqvIN_=hY zZ_#3rkhZqO>YE%*g}CFpR&&BBq+OfTz`(-6NUd^}yzl|U>EghCwZC@=qj{0&yj&EX z{Tjk4Ap5|0yXt-v)O9=&S2MPF^*(!)Hf;55`QD@U=&JP&L^r=7`dD{JDZXFcg9j2S zE`JdDMir)`g}&VrNYfOive?8nT)drFg6iu()~fbkywg~0rp4lBP`kM!P6TPr)&+5@ zsbXp<`??n({h7eizr9t>XuK0Q+i~9aCfIU#rNKsD4($Fiz_3Z66rFaaW?nF`!{+1z z*Jt75=khdC{?;^7ZttU`Pru1?GR&UX=)E`9`tXeX)EsQ34<0C3IDQ)~s5?bg4wf?! zCBiX_HdXO~YgmI*>yNgmzS~z6HJvD9`S!#5?u2mJ)o$NRx3{C7p9+DTt8WB(P>Hf> zBrhkG!EEptFO`JlRu zL_u{vTHyD<7|mpN{`H0?;GZKH;%1ND-*dFi!mqGBbe~kp*_uWu*;hD}T>$?}nzeAx z5MB*EgNZKa++c{S_jn?D7d$gZkdjVkq`&c~i6mA+oCRMRue3o|mlv6P)qoeJeE89M z*NGsfkgV_CZ7N)e*BNr~;u1R|&0KYzgrH$G5DM?5Lqyp*NhTy)Y~%x}py6n7yDaqv z19wNnBe02dUwnaaE`ghswXGyP)_A%z%64j~6yyN(>A=6&C2{#_R(^qSlN~keeSdyQ zprqRmW7`Ayug^(l86KKsLjyZ_WXX8UVP;Q>q;(EoGQhmpKJ>0pop)JamN`7=S>tC{ zQa!rSmn=@i-HYYljmZ4HxrNl`YhyDL}6gDpod-Luio zu^^Y~xmxp-PMJ2UB1u4U2E=&OZvJdU)Jd6);0sBp(r0A~jAtT{oce$gUs*9>q}nB< z^XMp!2iBp4W3O;bLxpvhS+Ig-V5Mo0B+ceGU)z`aYn1CAc42FRp3f&RVk0Zv1!T`I zu<2pdZ5IS?PRno2aS=_JwnsD9uC$;j5C|NxGMe0YgRO7gD-%SaEO~kQgygG@bBO}{ zqm16Pqq4Ce!7L+0%B$GT$k-s#j{z9L^Ym&8P7xASV>r3{oMuorr@Gx*pOwSOpy#<9(cUn5{a6wCb_ilD<~XC@A3K`oIlDi zo;}Rtjc(M=lRm-PrQjj6DKah(7WEroGG7+=m*ULl3@iK7%L6q#`w7{Ge(zR;rAuSL zu@9UGR*n;!jnQ+gnUBBi*-z^4Dr+rTjfcr1a`fFs*(_cQauj!^LF*bC$(fFWC+Cfk z5Mq#G$>#e9cUuI9ed&}*@8f~D{M&ZU0?g*r-a9Ppiu2VR1~2!>gB=K+(k^=0qcB+H zi99Q3i?CeJP)LV{PiT*}Fk}RGYK@t1!Nk?T)%%GGv)`y&C$?OD_o!lGH(lN|z+(d> zyElw(8Q0lMF zY9F;#?TMhqfto3RI;q9u!v;#nrp_Iw6gpK85i+DD3Ia-4*AA6vXxq`N$8l((bskeK zig1^}Q}CcangY7l#lc2PSS*PuAh9)2?9}2Ch1zVZ;OpKLWxE%cuyqeIdrKU>i+d~) zM!sSS5?5-vsGI&)@0XIdRwUJW8e(b)UwWr~$QfXghlD=6K~=X6G}ZzTdrk1zDOUpI zBLOUX^b?&s`vU@=h%Ljlxut|6xtQ15AV{P+w9n54IZh(00@v3wrSW2d#z}nKJX~H0 z3pFb@4*pgrLV5X%_LliXUG~E*S_QJ{8MfNfTUu{500j--=T77@u<3oHyxDQLepq_1 zWY)vOXH2mn0Qku=K!#*fL3viZt1*4~fwR>R!Fc&$Osu5D?8exqtIMTi>DQb|hf;Q_ zV5#~~fi$j@-}Rro=(it&JPOFBR)}ZK;RciKUT&&~zTuuo!`&V`aNs;U?=;BZ4x!Uh z0xF`l@By`e+6^AxZS+=;_nkZasFY$pC3Tj}%-jW#8v+r_6%l;#1BnUnpv+m<DxP8$YmOE2;L#Fl zrnA#GcMoTp+IPAoaJYoWCSvJfy~~V(Bl2`rp1SP&7i$k2oh@fw=;vH301)sp3__0lc(X|47bSY5Aa)!(&@-Q zPsE-ZA$eZj3QWs1J`A925T!AZ;@>_vi*9j8Au9^WnJN61_qrHhFnzOSydV7RR4Bi{(F1QATs$KEaw*%Ar;SH(5`7k z_&VF`(M!WEm&P-?_QN^!#*5;uCVxef$5qF#&&CdCm2DrcpE9|F^WtbTs^)a0H85a} zS73PG9La~1J0Z)u;$-Ec^54V0YnbS8P30Q_RV$r`GbhxYokzlrf%h&M>TcUdEi{`G zv0b6gTvb!d7aZVB*MAPlu9Q)LyOit>Psq}Vft9`qtz4)S)hEoX!v+wkp8w?>h2nAG zcp@wVwB_Hmb2s3__8}@|Ls8d4_VC#&4&?{U`tSQC^p<5O*N#11i*)rl;r2tGRrIUi zNQL0TM^`U!&dpR9A|uam6XJUkVNXG4_MtOZGfbEJ6e!f2yl9F835)->F?ztNDj2NoO?l_U>pXa%VKeTW z%W@BW9NF8yJy>fnL(T!{_uYEP(u8KdwQ#yN(PY;wrZ;IugP2K&cG*^2N~g+H<+L`SKIK9{puUht%`7H@X$fp%Iu3*!?& zD>A?dN8ICK&Svr%^~*OSrW!T0p~ExyhT^X{vD9S%RLp>N@GgfzU8-e@cxt)0ay$;W zs>BSq6=)$lx0GDm26>Tm|EVQOlr8<-M-Aca8pq! z{u^xJq+MgMAt{5PuGy{H%MQbvlKsTbCQv$VN!dHN9Tg zG3C(Yi1NKteVwDCbSXmoT{6QScjm#aiSq#w9Gf*tjVeC@vnvy*XnsG%cIdp?PIO6z zRbRDEN-{%L1`veOnrVdv+zL!Wjws@cQj!-UfEQSV_ub)Pg;#v$9MgUR(1)5?@2VZd z;i8*-im(n+LnnQZG57#pl6VDVy{E5iq-9H)cEXCVOg@*XMOLAxoPwg>Hvp5Bp1+Q= zK58d#zf=*swJ7s+?mGj}3C?QfG|^QbR{%(tWHKB>dPcBJWn*}cUJX11nV~n+F9eXB z8FPHf2@e(lq*5ipcm%@DOwI>E=;UZDQz(#?P1pdUFV5c;u)PMZ_&zX^u6MfooTU(^T90lFSYIneOOHBxP1PE z&Ra#Wkp3_Q{@~%<*xHNT2$d1MdQlpmq4v|mp@coeC``R{JT=A-qv;Es zBIEulSm95f<-hb)j&sF8g2V2|Fk5;}vrWDk&UTq=Oigho0dM;X>Oh<}64>P@UMY^> zm*|KrlO(r#yCB`9>mSQU3a&@o9#iyB?zjrQuij_S-c|b=ut-w{kCSXaFCx(I*oR4_ zv%5h#wW&MO1e3J%cu{E?+ppw_uI#?t^d zqu}H!jH~_@FDLwX#$>;`$8F(=CCYTa!&)VHirpH~m13AYb4PVq?W3rwH~yjcF}n(o zB_$xVzdR+WcxZNemUKxK(Ks`^=wf9%dac+t>PhiKN;uSM;uMLN;(Ze*xp*@A-y~aVS)RPX*y!Wotsu<*3e!7@9L*+i* zgHMtap*L*RHK+CpBcoqexXNF zHgdS8Snhz%&rwqyZFoZbc}E=kz%5@DbaeJ^p(3xE`J` z=M6Y$hXd8`0xEm(geTrT0vsH=mFg};%LML$I`Pn+ zWc;|;{YvTS&a|he<}mcQX3IdywTOzWDS%> zeaV=AQiRNzO=?x|x3y8wgf^hWo-%-GR}oP%b4GLE%fb1H8=3mv=^|BK2ewk_)frcE zCcsdY)I(sBsQA%fSP8(0XN942y!bfLfaCN%10FSiChntR@>ru~;T8|px$lUnWxte} zeKX>Y4PUrG@Iuu5w=}^_ zsL4YY$E4Z#qwi?B_13PQlI?7bPmkS?S43y$QV@65G0}|%S*1q2<5*@_(@tWbUA7^H znRdyb2#c3=;^e))n)on!c~S&%ctEUgm{9q&b=v<+^T7T1%tHx9^al+rmG2lVht4b^ zCKQ_1UENqMNyQKl%QVOdOQVDeK#6Q_wK_*+8LgVcjzgikq0vjq%oeep37P`RYF)FU zMe7N$k>`DQ50po@+olk(B#6+S|4!ChRLNOqFP&uJY=CeAgVV?{BXRE?M!#ztR*4|Z zBB^(lH!;86GRy397XR%o_}H>bD!hDS9ED@&WXrJ=Zr9?H+R4;aiVP+RBT?ynkhH?))1vF9JhAQ@*$;Xi!Tn=dUy2f*A z1WwNP%)5#(C?JS`sP5f_f2Mn%b34?MT6wa(=Lz*0FY9Q8X1LqFcJQM!Qpf!1_li{o zU7vdI@Ze=80K!F0SJsYak8i|&BxZZq!HmmEs09bGhDEiww1!T*X(F9nm1oaOLlP6~ zXb#F7VRWMH5xTbmpNK?I7``?*6-&S~xJ{U8PK+k)b?;%-4aC#&0rUq=FeAHHyoH;m z(ixRiq?OO$U)#s5&K{@Lbq#avcN32BH%7A7=Disj>Zb=5Pu8`g749W2T$R7MNK>uL zivzTAH9pq%y@|FoV5@e{-YBoRxSK3>R`Zo}23yt;Ys$QUOe#({Q(S@1PpkVIJQbKUAK8MnMqnl+Lwvm%GoVQ z7-*|Z0 z>HP@s5KBHimQn$xPha|ahAsQ;u9!97bl_A#>{?bWKur#WIR^7#oU~$u!GvtL7 z`fTleE#ry=aF@O-ZD8(@m(x%U(6fXlNYw?*@7XuPp=_N?P zWM-w@>H(azL|8O+_5}yyNob&;Z>~V-?QW@&p@Ajgupu05-!Gapx}{yYi~inB5i57J zC#GVeb&I2dyp8VRWFy59=%=M1_KU5HY%)!EjyEy~bmk;iH#=o3-V(r|LERw^asswn zVJMQ{S7MSS=t-nUOeIhdC#{z&h?`2K-MEKTZIM1I;aEc7b27!}t|rlGCz`R|olsc_ z?=~eJ zNAJFV3h#?9nK!pTW_K;Nm`c;#3_M79wuClT-hHG1HBFkB$Xrk&J!ImuMz`qEAWA; zYmEoiYK=QPXKA-)IA`6gDGMW9-AAA6@Qw>ZCPHZ|Dc9gA0(>hiO*@4w?;}I#WGVTaRHvIa zR}qc8e13F9wN6?Y%?`nP%#@e1(^*|znxtq;yJoG4Z1wj?OU{6BZqRZZG zZq*-D&!^WP)RS$|oaHCq75St@Aiag6|E}g+SwJxXJnRgI+RaiA`It^N0Wc(G6x4Ow z-C|K@*gmW<3_n7J{1=k-G=sACD|3diq3k`n1(Pk$HMV(>)y;7h9Hq1D6 zxF#G0X*Cq%97oP%z!qI4uHMbeVPIh*M^iUg_MjOaO#6`6Qo*sao(vxfO1`=)5;kIO^Xq>iOFlzef_xxh(P<)2l~+GD(`EXp;*maPlx$CSrR0v zgUE4Zb!zbB`3~VlilaLM+3?9wDV)k9dgtFvAN@3)W?fc{-_+nab$XoS4o8M*=R;O z9dY7YXVa4<-`pp@s>oV=NpQpV)ttSd(DMEW^^0*R;_hMsfCM-iU!1@+a^YECW@ zAKuHdR>Ez!Ct9gqYkObGpv~f))kG%2jv7ebpX376BG+F&XgAwW|ZZ$ivTeT&M1KO%OZOPVr0w`Fbx*bK9VUm4B^*t~` z!WGv_gg?7aPd@Fd-P+Kg`t1PEA2YmV?$K2X`s{2BtS(H3(NpkZvFzx^lT66x407sheckRYq%=Q$X%-dkLVd zfrH$u+HVK5U-VZ*Aw~@68a1`@;cfU_wY{93e6u_eydt?d(91G@mcj^GsmgsOZCP|| ze>?x%m{+V1AEe5g_@1~UPe_FA7C*zErf%_FXApu%*V ze9ktIT)|LOSUqOBh-NYy$Q`fF64%B^7w9JUg~DSQ;}!L1_r@uQvExLsz9CP4n1yMw z`NXR)7$(Km3MmX)&qeho5z2YBv}5f73iiweQtP?HXt6%c_&4FWVy~+`0{|13mJfoa zYL_don%`psL)@?v6?i7wz@x+;k6ySO-JA-@;U?bjJD+Bc2t%94OTJCut}TwnQy zA>Jq8I?03_Ge?XK#e|h{!5Gmc8tLDm(bUblBOxI=-K$IEk0l>&<27L|K;2bWocI`6UG;8=zb&-Oe@A5{awU%w3C9n zT0c^wQM?dJRRC}u!l_xNk8sN`r}d>28eaRPkCpL?u6V95mlsw|k!=Hm!h&3jO>IQ!k@ zIwP(Im{lf^K2B%brav38MBE(>l{&Yg-r5kstIl{!+B~Ips%UV@XrgO{-Ib$a$l6!q zvWSEt8)WE%gE;wQAs(RF(@D2}$*a%e|JuA|aD3Q$!=cWut-4Whq>FigivUPyb22Ch zV3dIce*=JS5$?J>5g)26An0%txVJ8?pBE5eb4aF`%w%lIbxunG3M<#!WRh#S}SlURs{cb)eoLc96#GxpbmLcX;o z2Mf`>^;|K;tDgM!OaXQ%TYB6}an4r;py&XAz92FBSk11K8G4QbhFu@3r$u*XHN_hE z1wI^?Ftp(zrsKvJr#e%*a_Q(N&mfmZRk0A+{-J<`)R#mcN(N97=%XW0sD({n0^CT3 zFIvEgQhdw%h4IbU7>Tg5-Ps$P*5*_@IU8*Utc`4zc?RF(qUEBT^HG5*^~HEsfS0Ip z;830D_URZajE#-tVC6nM!#&W~HGDfxA2}XOcuG!0qlXyD^n|N(o#_G0IBAOTRT9$$ z1P|4uQ0p?^c##-R#|Vdwi|b(AAb#)P@NF3XgUJYpB+vCA{op=Se5^?BWH#-L_Jh*41-i6Y*@ z$Qwy$D3#ZQl8#=vSyk8UKE1lf47wW+dj|9>nBZGg=%zrtffT?JW{QF6%~x9<1R|0Q z2(}h{q1D`?TDsD5hK2!aqYEBf5rKGX0#_V!Bm5@8FpA%E_$%~T2qS>{cf_FNuXAupE1=Moq~0Q+%mrFPT4P1V@$a(nuZ)DlsTus>YJ@Ae9p~l% zq6MB-5R4T$eGO)9YNJA}Kud5WPh44R z27!{_hW5a|5c%Uvtxs`+_IC}wCcJM*Og>7+I!C-WD~(RZq;6c8*YF?{Y8&sJ z0k=l3uK7Be!$iO8g(+Xet6eY%0C$0Pu-cQZI=p{<>qJb9zqYJ==RFfFLl)fsxe@O2 z7>B?*9k#HgnJl$!#n?rLg|a=ZmU5*Y%LG%5gWHzem?a_*c166Y@i5plO@(1$N37uj z=W{hZwzvRj0iPh>6%`m~E$8}NBJ&cZaB$6s;UrkM8H0d$b*2bi`nCd`Y?j};Oua1d z*6yhfe-W3evUhLB;s``tU4fPXt|efi|K_27diHxHc|KDY_*&hWk+D)GYujlWfKh4t z%Kpe5oh*+J5^dgtzcQD*s!y3Pazu^$Y)^^%R^XBU(y-D@Iun4*0E`V_JE=m{jg=nKg+#|`KqLWbL}7n`*eo}20+>V| zml%}e79m8>9NjyzMzdr(utZ1HVSRyCujq<7CBn)ycRITB+}xjF2>)TTe1dW07&5|j zB>rvPyNKn3pBkf!Jg-lX_z_ohA72B*_fAdSCdJ>LVw0D)15KJ7gm8Ak7Dv0*iaaUI3~a(6D5zH1=EECBx@XZu z`8jF?gz$Mwg8y z05t!Y7LkHs(w}jIeui;ma}p1{92`FZ=%}S2)1jcE*Df0(A@43Sz=!l}68FiVH}4!k z9MJDR{IUkTCID@xvW;Ka#`^O>_rYk0GEOHJxsj59+5dg^=isTTV0}=sf%$+L$RP)S zo=~$)k)*#*27WIGfIh-L{4=oStHAw#t^uzJKwB=h`b*o`zYkn`X@D3;%>rb@ir}C+ zIJ5-hfj^T6)Wg8Pz4SS-KmS$0`*#}XRV0A_KLGquEvXQtz;OTo002ovPDHLkV1kUg B0cHRI literal 0 HcmV?d00001 diff --git a/scripts/build.bat b/scripts/build.bat index bfc6d7ee..b9469fff 100644 --- a/scripts/build.bat +++ b/scripts/build.bat @@ -1,2 +1,8 @@ CALL "%~p0compile_resources.bat" -pyinstaller --windowed --onefile --additional-hooks-dir=Pyinstaller\hooks --icon=res\icon.ico "%~p0..\src\AutoSplit.py" +pyinstaller ^ + --windowed ^ + --onefile ^ + --additional-hooks-dir=Pyinstaller\hooks ^ + --icon=res\icon.ico ^ + --splash=res\splash.png ^ + "%~p0..\src\AutoSplit.py" diff --git a/src/AutoSplit.py b/src/AutoSplit.py index ded4697f..35d2dcc9 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -208,6 +208,11 @@ def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-man if not self.is_auto_controlled: user_profile.load_settings_on_open(self) + try: + import pyi_splash # type: ignore # pylint: disable=import-outside-toplevel + pyi_splash.close() + except ModuleNotFoundError: + pass self.show() # Needs to be after Ui_MainWindow.show() to be shown overtop From 74a538aa2cf4158a0ae94cf81eace901303bfbaf Mon Sep 17 00:00:00 2001 From: Avasam Date: Thu, 16 Jun 2022 18:32:04 -0400 Subject: [PATCH 076/137] Check version for is_border_required --- src/CaptureMethod.py | 6 +++--- src/menu_bar.py | 4 +++- src/region_selection.py | 7 ++++++- 3 files changed, 12 insertions(+), 5 deletions(-) diff --git a/src/CaptureMethod.py b/src/CaptureMethod.py index 665e020c..7349be3f 100644 --- a/src/CaptureMethod.py +++ b/src/CaptureMethod.py @@ -9,7 +9,7 @@ from winsdk.windows.media.capture import MediaCapture # https://docs.microsoft.com/en-us/uwp/api/windows.graphics.capture.graphicscapturepicker#applies-to -WCG_MIN_BUILD = 17134 +WGC_MIN_BUILD = 17134 def test_for_media_capture(): @@ -82,7 +82,7 @@ def get_method_by_index(self, index: int): name="Windows Graphics Capture", short_description="fast, most compatible but less features", description=( - f"\nOnly available in Windows 10.0.{WCG_MIN_BUILD} and up. " + f"\nOnly available in Windows 10.0.{WGC_MIN_BUILD} and up. " "\nDue to current technical limitations, it requires having at least one " "\naudio or video Capture Device connected and enabled. Even if it won't be used. " "\nAllows recording UWP apps, Hardware Accelerated and Exclusive Fullscreen windows. " @@ -126,7 +126,7 @@ def get_method_by_index(self, index: int): # Detect and remove unsupported capture methods if ( # Windows Graphics Capture requires a minimum Windows Build - int(version().split(".")[2]) < WCG_MIN_BUILD + int(version().split(".")[2]) < WGC_MIN_BUILD # Our current implementation of Windows Graphics Capture requires at least one CaptureDevice or not test_for_media_capture() ): diff --git a/src/menu_bar.py b/src/menu_bar.py index f57f6990..dede8a8e 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -26,7 +26,7 @@ from AutoSplit import AutoSplit # AutoSplit Version number -AUTOSPLIT_VERSION = "2.0.0-alpha.2" +AUTOSPLIT_VERSION = "2.0.0-alpha.3" # About Window @@ -97,6 +97,8 @@ def run(self): except (RequestException, KeyError, JSONDecodeError): if not self.check_on_open: self.autosplit.show_error_signal.emit(error_messages.check_for_updates) + finally: + self.terminate() def check_for_updates(autosplit: AutoSplit, check_on_open: bool = False): diff --git a/src/region_selection.py b/src/region_selection.py index 3d725fa0..8ba9fbe5 100644 --- a/src/region_selection.py +++ b/src/region_selection.py @@ -6,6 +6,7 @@ import os from dataclasses import dataclass from math import ceil +from platform import version from typing import TYPE_CHECKING, Optional, cast import cv2 @@ -30,6 +31,9 @@ if TYPE_CHECKING: from AutoSplit import AutoSplit +WGC_NO_BORDER_MIN_BUILD = 20348 + + SUPPORTED_IMREAD_FORMATS = [ ("Windows bitmaps", "*.bmp *.dib"), ("JPEG files", "*.jpeg *.jpg *.jpe"), @@ -132,7 +136,8 @@ async def coroutine(): if not session: raise OSError("Unable to create a capture session.") session.is_cursor_capture_enabled = False - # TODO: Consider session.is_border_required = False + if int(version().split(".")[2]) < WGC_NO_BORDER_MIN_BUILD: + session.is_border_required = False session.start_capture() return WindowsGraphicsCapture(item.size, frame_pool, session, None) From 391cbe40f0211f10abe5c507de1a984804e69307 Mon Sep 17 00:00:00 2001 From: Avasam Date: Thu, 16 Jun 2022 18:32:11 -0400 Subject: [PATCH 077/137] Fix a handful of Win11 high DPI scaling issues + Build task --- .vscode/tasks.json | 14 ++++++++++++ res/design.ui | 47 +++++++++++++++++++++------------------- res/settings.ui | 12 ++++++++++ scripts/requirements.txt | 10 ++++----- src/AutoSplit.py | 16 ++++++++++++-- src/menu_bar.py | 2 -- 6 files changed, 70 insertions(+), 31 deletions(-) create mode 100644 .vscode/tasks.json diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 00000000..4ac48ed7 --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,14 @@ +{ + "version": "2.0.0", + "tasks": [ + { + "label": "Build AutoSplit", + "type": "shell", + "command": "scripts/build.bat", + "group": { + "kind": "build", + "isDefault": true + } + } + ], +} diff --git a/res/design.ui b/res/design.ui index ea0037ef..27da29c8 100644 --- a/res/design.ui +++ b/res/design.ui @@ -184,8 +184,8 @@ - 119 - 68 + 120 + 67 320 240 @@ -212,8 +212,8 @@ - 450 - 68 + 449 + 67 320 240 @@ -231,7 +231,7 @@ - 451 + 449 31 318 20 @@ -289,9 +289,12 @@ 11 200 44 - 22 + 24 + + QAbstractSpinBox::CorrectToNearestValue + 1 @@ -308,9 +311,12 @@ 66 200 44 - 22 + 24 + + QAbstractSpinBox::CorrectToNearestValue + 1 @@ -324,9 +330,9 @@ - 119 + 120 31 - 319 + 318 20 @@ -340,7 +346,7 @@ - 478 + 477 49 264 20 @@ -375,15 +381,15 @@ 11 160 44 - 22 + 24 - - false - QAbstractSpinBox::UpDownArrows + + QAbstractSpinBox::CorrectToNearestValue + 0 @@ -403,14 +409,11 @@ 66 160 44 - 22 + 24 - - false - - - QAbstractSpinBox::UpDownArrows + + QAbstractSpinBox::CorrectToNearestValue 0 @@ -853,7 +856,7 @@ - 449 + 448 49 27 18 @@ -875,7 +878,7 @@ - 744 + 743 49 27 18 diff --git a/res/settings.ui b/res/settings.ui index 7c49dcb1..cb634d59 100644 --- a/res/settings.ui +++ b/res/settings.ui @@ -64,6 +64,9 @@ ArrowCursor + + QAbstractSpinBox::CorrectToNearestValue + 20 @@ -261,6 +264,9 @@ The amount of time in seconds that comparison will be paused before moving to the next image. + + QAbstractSpinBox::CorrectToNearestValue + 2 @@ -305,6 +311,9 @@ Threshold that the live similarity will need to go above to consider the image a match. + + QAbstractSpinBox::CorrectToNearestValue + 1.000000000000000 @@ -393,6 +402,9 @@ After an image is matched, this is the amount of time in millseconds that will be delayed before splitting. + + QAbstractSpinBox::CorrectToNearestValue + 999999999 diff --git a/scripts/requirements.txt b/scripts/requirements.txt index 42be5021..aab4b2c8 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -5,13 +5,13 @@ # Usage: .\scripts\install.bat # # If you're having issues with the libraries, you might want to first run: -# pip uninstall -r .\scripts\requirements-dev.txt +# pip uninstall -y -r .\scripts\requirements-dev.txt # # Creating AutoSplit.exe with PyInstaller: .\scripts\build.bat # # Dependencies: -numpy>=1.22.0rc1,<1.23 -opencv-python-headless>=4.5.4,<4.6 +numpy>=1.22.0rc1,<1.23 # Type issue +opencv-python-headless>=4.5.4,<4.6 # https://github.com/pyinstaller/pyinstaller/issues/6889 PyQt6>=6.2.1 PySide6 ImageHash @@ -19,7 +19,7 @@ keyboard packaging Pillow pyautogui -pywin32 +pywin32>=301 requests certifi toml @@ -27,5 +27,5 @@ winsdk>=v1.0.0b4 pygrabber git+https://github.com/ranchen421/D3DShot.git#egg=D3DShot # https://github.com/SerpentAI/D3DShot/issues/44 # -# You can comment this out if you don't want to build AutoSplit.exe: +# Build PyInstaller diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 35d2dcc9..83517e77 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -13,6 +13,7 @@ import signal import sys from collections.abc import Callable +from platform import version from time import time from types import FunctionType from typing import Optional @@ -42,6 +43,7 @@ START_AUTO_SPLITTER_TEXT = "Start Auto Splitter" CHECK_FPS_ITERATIONS = 10 +FIRST_WIN_11_BUILD = 22000 # Needed when compiled, along with the custom hook-requests PyInstaller hook os.environ["REQUESTS_CA_BUNDLE"] = certifi.where() @@ -103,7 +105,7 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): highest_similarity = 0.0 reset_highest_similarity = 0.0 - # Define all other attributes + # Ensure all other attributes are defined start_image_split_below_threshold = False waiting_for_split_delay = False split_below_threshold = False @@ -113,6 +115,7 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): split_images: list[AutoSplitImage] = [] split_image: Optional[AutoSplitImage] = None capture_device: Optional[cv2.VideoCapture] = None + update_auto_control: Optional[QtCore.QThread] = None def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-many-statements super().__init__(parent) @@ -123,6 +126,14 @@ def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-man self.setupUi(self) self.setWindowTitle(f"AutoSplit v{AUTOSPLIT_VERSION}") + # Spinbox frame disappears and reappears on Windows 11. It's much cleaner to just disable them. + # Most likely related: https://bugreports.qt.io/browse/QTBUG-95215?jql=labels%20%3D%20Windows11 + # Arrow buttons tend to move a lot as well + if int(version().split(".")[2]) >= FIRST_WIN_11_BUILD: + self.x_spinbox.setFrame(False) + self.y_spinbox.setFrame(False) + self.width_spinbox.setFrame(False) + self.height_spinbox.setFrame(False) # Get default values defined in SettingsDialog self.settings_dict = get_default_settings_from_ui(self) @@ -837,10 +848,11 @@ def closeEvent(self, a0: Optional[QtGui.QCloseEvent] = None): """ def exit_program(): + if self.update_auto_control: + self.update_auto_control.terminate() if a0 is not None: a0.accept() if self.is_auto_controlled: - self.update_auto_control.terminate() # stop main thread (which is probably blocked reading input) via an interrupt signal os.kill(os.getpid(), signal.SIGINT) sys.exit() diff --git a/src/menu_bar.py b/src/menu_bar.py index dede8a8e..3a2fe3b9 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -97,8 +97,6 @@ def run(self): except (RequestException, KeyError, JSONDecodeError): if not self.check_on_open: self.autosplit.show_error_signal.emit(error_messages.check_for_updates) - finally: - self.terminate() def check_for_updates(autosplit: AutoSplit, check_on_open: bool = False): From ad729170b1039351f29a1870806e092dd7cf99ec Mon Sep 17 00:00:00 2001 From: Avasam Date: Thu, 16 Jun 2022 19:11:32 -0400 Subject: [PATCH 078/137] Fix yet another issue on Windows Graphics Capture + oopsie --- src/AutoSplit.py | 13 +++++++------ src/menu_bar.py | 4 ++-- src/region_selection.py | 2 +- src/user_profile.py | 4 ++-- 4 files changed, 12 insertions(+), 11 deletions(-) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 83517e77..6eabb16e 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -216,17 +216,18 @@ def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-man # Automatic timer start self.timer_start_image.timeout.connect(self.__start_image_function) - if not self.is_auto_controlled: - user_profile.load_settings_on_open(self) + self.show() try: import pyi_splash # type: ignore # pylint: disable=import-outside-toplevel pyi_splash.close() except ModuleNotFoundError: pass - self.show() - # Needs to be after Ui_MainWindow.show() to be shown overtop + # Needs to be after Ui_MainWindow.show() to be shown on top + if not self.is_auto_controlled: + # Must also be done later to help load the saved capture window + user_profile.load_settings_on_open(self) if self.action_check_for_updates_on_open.isChecked(): check_for_updates(self, check_on_open=True) @@ -768,8 +769,8 @@ def __get_capture_for_comparison(self): else: self.live_image.setText("Trying to recover window...") hwnd = win32gui.FindWindow(None, self.settings_dict["captured_window_title"]) - # Don't fallback to desktop - if hwnd: + # Don't fallback to desktop or whatever window obtained with "" + if hwnd and self.settings_dict["captured_window_title"]: self.hwnd = hwnd if self.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: if self.windows_graphics_capture: diff --git a/src/menu_bar.py b/src/menu_bar.py index 3a2fe3b9..4ced7911 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -159,8 +159,8 @@ def __capture_method_changed(self): self.autosplit.select_window_button.setDisabled(False) # Recover window from name hwnd = win32gui.FindWindow(None, self.autosplit.settings_dict["captured_window_title"]) - # Don't fallback to desktop - if hwnd: + # Don't fallback to desktop or whatever window obtained with "" + if hwnd and self.autosplit.settings_dict["captured_window_title"]: self.autosplit.hwnd = hwnd if selected_capture_method == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: self.autosplit.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) diff --git a/src/region_selection.py b/src/region_selection.py index 8ba9fbe5..e5142dc1 100644 --- a/src/region_selection.py +++ b/src/region_selection.py @@ -136,7 +136,7 @@ async def coroutine(): if not session: raise OSError("Unable to create a capture session.") session.is_cursor_capture_enabled = False - if int(version().split(".")[2]) < WGC_NO_BORDER_MIN_BUILD: + if int(version().split(".")[2]) >= WGC_NO_BORDER_MIN_BUILD: session.is_border_required = False session.start_capture() return WindowsGraphicsCapture(item.size, frame_pool, session, None) diff --git a/src/user_profile.py b/src/user_profile.py index e0032ab6..605c2d47 100644 --- a/src/user_profile.py +++ b/src/user_profile.py @@ -152,8 +152,8 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str if autosplit.settings_dict["captured_window_title"]: hwnd = win32gui.FindWindow(None, autosplit.settings_dict["captured_window_title"]) - # Don't fallback to desktop - if hwnd: + # Don't fallback to desktop or whatever window obtained with "" + if hwnd and autosplit.settings_dict["captured_window_title"]: autosplit.hwnd = hwnd if autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: if autosplit.windows_graphics_capture: From 3ca7dbe71a0859fe2ef0a8b7a45f97e2070e6914 Mon Sep 17 00:00:00 2001 From: Avasam Date: Thu, 16 Jun 2022 21:51:50 -0400 Subject: [PATCH 079/137] bugfix: get_method_by_index should return first element with negative index --- src/CaptureMethod.py | 2 ++ src/menu_bar.py | 19 +++++++++++++++---- 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/src/CaptureMethod.py b/src/CaptureMethod.py index 7349be3f..53a3b50a 100644 --- a/src/CaptureMethod.py +++ b/src/CaptureMethod.py @@ -64,6 +64,8 @@ def __hash__(self): class DisplayCaptureMethodDict(OrderedDict[CaptureMethod, DisplayCaptureMethodInfo]): def get_method_by_index(self, index: int): + if index < 0: + return next(iter(self)) return list(self.keys())[index] diff --git a/src/menu_bar.py b/src/menu_bar.py index 4ced7911..17208c4e 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -3,11 +3,12 @@ import asyncio import threading import webbrowser +from platform import version from typing import TYPE_CHECKING, Any, Optional, Union, cast import cv2 import requests -from packaging import version +from packaging.version import parse as version_parse from PyQt6 import QtCore, QtWidgets from requests.exceptions import RequestException from simplejson.errors import JSONDecodeError @@ -25,13 +26,15 @@ if TYPE_CHECKING: from AutoSplit import AutoSplit +FIRST_WIN_11_BUILD = 22000 + # AutoSplit Version number AUTOSPLIT_VERSION = "2.0.0-alpha.3" -# About Window - class __AboutWidget(QtWidgets.QWidget, about.Ui_AboutAutoSplitWidget): + """About Window""" + def __init__(self): super().__init__() self.setupUi(self) @@ -54,7 +57,7 @@ def __init__(self, latest_version: str, design_window: design.Ui_MainWindow, che self.left_button.clicked.connect(self.open_update) self.do_not_ask_again_checkbox.stateChanged.connect(self.do_not_ask_me_again_state_changed) self.design_window = design_window - if version.parse(latest_version) > version.parse(AUTOSPLIT_VERSION): + if version_parse(latest_version) > version_parse(AUTOSPLIT_VERSION): self.do_not_ask_again_checkbox.setVisible(check_on_open) self.show() elif not check_on_open: @@ -200,6 +203,14 @@ async def __set_all_capture_devices(self): def __init__(self, autosplit: AutoSplit): super().__init__() self.setupUi(self) + # Spinbox frame disappears and reappears on Windows 11. It's much cleaner to just disable them. + # Most likely related: https://bugreports.qt.io/browse/QTBUG-95215?jql=labels%20%3D%20Windows11 + # Arrow buttons tend to move a lot as well + if int(version().split(".")[2]) >= FIRST_WIN_11_BUILD: + self.fps_limit_spinbox.setFrame(False) + self.default_similarity_threshold_spinbox.setFrame(False) + self.default_delay_time_spinbox.setFrame(False) + self.default_pause_time_spinbox.setFrame(False) self.autosplit = autosplit # region Build the Capture method combobox From dc1e9dd7a587304ebf10311b155454c13e4994a7 Mon Sep 17 00:00:00 2001 From: Avasam Date: Fri, 17 Jun 2022 00:13:57 -0400 Subject: [PATCH 080/137] Properly fix region alignement Fixes Avasam#21 Updated some doc max fps will show `...` while working --- README.md | 4 +- res/design.ui | 4 +- src/AutoSplit.py | 9 +- src/CaptureMethod.py | 12 ++- src/WindowsGraphicsCapture.py | 60 +++++++++++++ src/region_capture.py | 37 ++++++-- src/region_selection.py | 164 ++++++++++------------------------ 7 files changed, 152 insertions(+), 138 deletions(-) create mode 100644 src/WindowsGraphicsCapture.py diff --git a/README.md b/README.md index 3d0d09e8..b8ffd103 100644 --- a/README.md +++ b/README.md @@ -78,9 +78,9 @@ This program can be used to automatically start, split, and reset your preferred #### Capture Method & Capture Device - **BitBlt** (fastest, least compatible) - A good default fast option. Also allows recording background windows (as long as they still actually render when in the background), but it cannot properly record OpenGL, Hardware Accelerated or Exclusive Fullscreen windows. + A good default fast option. But it cannot properly record OpenGL, Hardware Accelerated or Exclusive Fullscreen windows. The smaller the region, the more efficient it is. -- **Windows Graphics Capture** (fast, most compatible but less features) +- **Windows Graphics Capture** (fast, most compatible, capped at 60fps) Only available in Windows 10.0.17134 and up. Due to current technical limitations, it requires having at least one audio or video Capture Device connected and enabled. Even if it won't be used. Allows recording UWP apps, Hardware Accelerated and Exclusive Fullscreen windows. diff --git a/res/design.ui b/res/design.ui index 27da29c8..b4f07175 100644 --- a/res/design.ui +++ b/res/design.ui @@ -172,7 +172,7 @@ 92 - 255 + 254 20 20 @@ -274,7 +274,7 @@ 65 - 255 + 254 26 20 diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 6eabb16e..5a0ba2b0 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -36,10 +36,11 @@ from menu_bar import (AUTOSPLIT_VERSION, check_for_updates, get_default_settings_from_ui, open_about, open_settings, open_update_checker, view_help) from region_capture import capture_region, set_ui_image -from region_selection import (WindowsGraphicsCapture, align_region, create_windows_graphics_capture, select_region, - select_window, validate_before_parsing) +from region_selection import (align_region, create_windows_graphics_capture, select_region, select_window, + validate_before_parsing) from split_parser import BELOW_FLAG, DUMMY_FLAG, PAUSE_FLAG, parse_and_validate_images from user_profile import DEFAULT_PROFILE, FROZEN +from WindowsGraphicsCapture import WindowsGraphicsCapture START_AUTO_SPLITTER_TEXT = "Start Auto Splitter" CHECK_FPS_ITERATIONS = 10 @@ -396,8 +397,10 @@ def __take_screenshot(self): os.startfile(screenshot_path) # nosec def __check_fps(self): - self.fps_value_label.clear() + self.fps_value_label.setText("...") + QApplication.processEvents() if not (validate_before_parsing(self) and parse_and_validate_images(self)): + self.fps_value_label.clear() return images = self.split_images diff --git a/src/CaptureMethod.py b/src/CaptureMethod.py index 53a3b50a..2b66c6a9 100644 --- a/src/CaptureMethod.py +++ b/src/CaptureMethod.py @@ -74,15 +74,14 @@ def get_method_by_index(self, index: int): name="BitBlt", short_description="fastest, least compatible", description=( - "\nA good default fast option. Also allows recording background windows " - "\n(as long as they still actually render when in the background), but it " - "\ncannot properly record OpenGL, Hardware Accelerated or Exclusive Fullscreen windows. " - "\nThe smaller the region, the more efficient it is. " + "\nA good default fast option. But it cannot properly record " + "\nOpenGL, Hardware Accelerated or Exclusive Fullscreen windows. " + "\nThe smaller the selected region, the more efficient it is. " ), ), CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: DisplayCaptureMethodInfo( name="Windows Graphics Capture", - short_description="fast, most compatible but less features", + short_description="fast, most compatible, capped at 60fps", description=( f"\nOnly available in Windows 10.0.{WGC_MIN_BUILD} and up. " "\nDue to current technical limitations, it requires having at least one " @@ -98,7 +97,7 @@ def get_method_by_index(self, index: int): "\nDuplicates the desktop using Direct3D. " "\nIt can record OpenGL and Hardware Accelerated windows. " "\nAbout 10-15x slower than BitBlt. Not affected by window size. " - "\noverlapping windows will show up and can't record across displays. " + "\nOverlapping windows will show up and can't record across displays. " ), ), CaptureMethod.PRINTWINDOW_RENDERFULLCONTENT: DisplayCaptureMethodInfo( @@ -118,7 +117,6 @@ def get_method_by_index(self, index: int): "\nUses a Video Capture Device, like a webcam, virtual cam, or capture card. " "\nYou can select one below. " "\nThere are currently performance issues, but it might be more convenient. " - "\nIt is not yet possible for us to display the device name. " "\nIf you want to use this with OBS' Virtual Camera, use the Virtualcam plugin instead " "\nhttps://obsproject.com/forum/resources/obs-virtualcam.949/." ), diff --git a/src/WindowsGraphicsCapture.py b/src/WindowsGraphicsCapture.py new file mode 100644 index 00000000..adc8b948 --- /dev/null +++ b/src/WindowsGraphicsCapture.py @@ -0,0 +1,60 @@ +import asyncio +from dataclasses import dataclass +from platform import version +from typing import Optional + +import cv2 +from winsdk.windows.graphics import SizeInt32 +from winsdk.windows.graphics.capture import Direct3D11CaptureFramePool, GraphicsCaptureItem, GraphicsCaptureSession +from winsdk.windows.graphics.directx import DirectXPixelFormat +from winsdk.windows.media.capture import MediaCapture + +WGC_NO_BORDER_MIN_BUILD = 20348 + + +@dataclass +class WindowsGraphicsCapture: + size: SizeInt32 + frame_pool: Direct3D11CaptureFramePool + # Prevent session from being garbage collected + session: GraphicsCaptureSession + last_captured_frame: Optional[cv2.Mat] + + def close(self): + self.frame_pool.close() + try: + self.session.close() + except OSError: + # OSError: The application called an interface that was marshalled for a different thread + # This still seems to close the session and prevent the following hard crash in LiveSplit + # pylint: disable=line-too-long + # "AutoSplit.exe " # noqa: E501 + pass + + +def create_windows_graphics_capture(item: GraphicsCaptureItem): + # Note: Must create in the same thread (can't use a global) otherwise when ran from LiveSplit it will raise: + # OSError: The application called an interface that was marshalled for a different thread + media_capture = MediaCapture() + + async def coroutine(): + await (media_capture.initialize_async() or asyncio.sleep(0)) + asyncio.run(coroutine()) + + if not media_capture.media_capture_settings: + raise OSError("Unable to initialize a Direct3D Device.") + frame_pool = Direct3D11CaptureFramePool.create_free_threaded( + media_capture.media_capture_settings.direct3_d11_device, + DirectXPixelFormat.B8_G8_R8_A8_UINT_NORMALIZED, + 1, + item.size) + if not frame_pool: + raise OSError("Unable to create a frame pool for a capture session.") + session = frame_pool.create_capture_session(item) + if not session: + raise OSError("Unable to create a capture session.") + session.is_cursor_capture_enabled = False + if int(version().split(".")[2]) >= WGC_NO_BORDER_MIN_BUILD: + session.is_border_required = False + session.start_capture() + return WindowsGraphicsCapture(item.size, frame_pool, session, None) diff --git a/src/region_capture.py b/src/region_capture.py index ee414cde..adac2dc5 100644 --- a/src/region_capture.py +++ b/src/region_capture.py @@ -17,13 +17,15 @@ from winsdk.windows.graphics.imaging import BitmapBufferAccessMode, SoftwareBitmap from CaptureMethod import CaptureMethod -from region_selection import WindowsGraphicsCapture +from WindowsGraphicsCapture import WindowsGraphicsCapture if TYPE_CHECKING: from AutoSplit import AutoSplit # This is an undocumented nFlag value for PrintWindow PW_RENDERFULLCONTENT = 0x00000002 +DWMWA_EXTENDED_FRAME_BOUNDS = 9 + desktop_duplication = d3dshot.create(capture_output="numpy") @@ -35,6 +37,22 @@ class Region(TypedDict): height: int +def get_window_bounds(hwnd: int): + extended_frame_bounds = ctypes.wintypes.RECT() + ctypes.windll.dwmapi.DwmGetWindowAttribute( + hwnd, + DWMWA_EXTENDED_FRAME_BOUNDS, + ctypes.byref(extended_frame_bounds), + ctypes.sizeof(extended_frame_bounds)) + + window_rect = win32gui.GetWindowRect(hwnd) + window_left_bounds = cast(int, extended_frame_bounds.left) - window_rect[0] + window_top_bounds = cast(int, extended_frame_bounds.top) - window_rect[1] + window_width = cast(int, extended_frame_bounds.right) - cast(int, extended_frame_bounds.left) + window_height = cast(int, extended_frame_bounds.bottom) - cast(int, extended_frame_bounds.top) + return window_left_bounds, window_top_bounds, window_width, window_height + + def __bit_blt_capture(hwnd: int, selection: Region, render_full_content: bool = False): image: Optional[cv2.Mat] = None # If the window closes while it's being manipulated, it could cause a crash @@ -46,6 +64,9 @@ def __bit_blt_capture(hwnd: int, selection: Region, render_full_content: bool = if render_full_content: ctypes.windll.user32.PrintWindow(hwnd, dc_object.GetSafeHdc(), PW_RENDERFULLCONTENT) + # On Windows there is a shadow around the windows that we need to account for. + left_bounds, top_bounds, *_ = get_window_bounds(hwnd) + compatible_dc = dc_object.CreateCompatibleDC() bitmap = win32ui.CreateBitmap() bitmap.CreateCompatibleBitmap(dc_object, selection["width"], selection["height"]) @@ -54,7 +75,7 @@ def __bit_blt_capture(hwnd: int, selection: Region, render_full_content: bool = (0, 0), (selection["width"], selection["height"]), dc_object, - (selection["x"], selection["y"]), + (selection["x"] + left_bounds, selection["y"] + top_bounds), win32con.SRCCOPY) image = np.frombuffer(cast(bytes, bitmap.GetBitmapBits(True)), dtype=np.uint8) image.shape = (selection["height"], selection["width"], 4) @@ -77,6 +98,8 @@ def __d3d_capture(hwnd: int, selection: Region): hmonitor = ctypes.windll.user32.MonitorFromWindow(hwnd, win32con.MONITOR_DEFAULTTONEAREST) if not hmonitor: return None + + left_bounds, top_bounds, *_ = get_window_bounds(hwnd) desktop_duplication.display = [ display for display in desktop_duplication.displays @@ -84,11 +107,11 @@ def __d3d_capture(hwnd: int, selection: Region): offset_x, offset_y, *_ = win32gui.GetWindowRect(hwnd) offset_x -= desktop_duplication.display.position["left"] offset_y -= desktop_duplication.display.position["top"] - screenshot = desktop_duplication.screenshot(( - selection["x"] + offset_x, - selection["y"] + offset_y, - selection["width"] + selection["x"] + offset_x, - selection["height"] + selection["y"] + offset_y)) + left = selection["x"] + offset_x + left_bounds + top = selection["y"] + offset_y + top_bounds + right = selection["width"] + left + bottom = selection["height"] + top + screenshot = desktop_duplication.screenshot((left, top, right, bottom)) return cv2.cvtColor(screenshot, cv2.COLOR_RGBA2BGRA) diff --git a/src/region_selection.py b/src/region_selection.py index e5142dc1..03d86f1f 100644 --- a/src/region_selection.py +++ b/src/region_selection.py @@ -1,13 +1,10 @@ from __future__ import annotations -import asyncio import ctypes import ctypes.wintypes import os -from dataclasses import dataclass from math import ceil -from platform import version -from typing import TYPE_CHECKING, Optional, cast +from typing import TYPE_CHECKING, cast import cv2 import numpy as np @@ -17,22 +14,17 @@ from win32con import GA_ROOT, MAXBYTE, SM_CXVIRTUALSCREEN, SM_CYVIRTUALSCREEN, SM_XVIRTUALSCREEN, SM_YVIRTUALSCREEN from winsdk._winrt import initialize_with_window from winsdk.windows.foundation import AsyncStatus, IAsyncOperation -from winsdk.windows.graphics import SizeInt32 -from winsdk.windows.graphics.capture import (Direct3D11CaptureFramePool, GraphicsCaptureItem, GraphicsCapturePicker, - GraphicsCaptureSession) +from winsdk.windows.graphics.capture import GraphicsCaptureItem, GraphicsCapturePicker from winsdk.windows.graphics.capture.interop import create_for_window -from winsdk.windows.graphics.directx import DirectXPixelFormat -from winsdk.windows.media.capture import MediaCapture import error_messages -import region_capture from CaptureMethod import CaptureMethod +from region_capture import capture_region, get_window_bounds +from WindowsGraphicsCapture import create_windows_graphics_capture if TYPE_CHECKING: from AutoSplit import AutoSplit -WGC_NO_BORDER_MIN_BUILD = 20348 - SUPPORTED_IMREAD_FORMATS = [ ("Windows bitmaps", "*.bmp *.dib"), @@ -53,16 +45,45 @@ + ");;"\ + ";;".join([f"{format} ({extensions})" for format, extensions in SUPPORTED_IMREAD_FORMATS]) -DWMWA_EXTENDED_FRAME_BOUNDS = 9 user32 = ctypes.windll.user32 +def __select_graphics_item(autosplit: AutoSplit): # pyright: ignore [reportUnusedFunction] + # TODO: For later as a different picker option + """ + Uses the built-in GraphicsCapturePicker to select the Window + """ + def callback(async_operation: IAsyncOperation[GraphicsCaptureItem], async_status: AsyncStatus): + try: + if async_status != AsyncStatus.COMPLETED: + return + except SystemError as exception: + # HACK: can happen when closing the GraphicsCapturePicker + if str(exception).endswith("returned a result with an error set"): + return + raise + item = async_operation.get_results() + if not item: + return + autosplit.settings_dict["captured_window_title"] = item.display_name + if autosplit.windows_graphics_capture: + autosplit.windows_graphics_capture.close() + autosplit.windows_graphics_capture = create_windows_graphics_capture(item) + + picker = GraphicsCapturePicker() + initialize_with_window(picker, int(autosplit.effectiveWinId())) + async_operation = picker.pick_single_item_async() + # None if the selection is canceled + if async_operation: + async_operation.completed = callback + + def select_region(autosplit: AutoSplit): # Create a screen selector widget selector = SelectRegionWidget() - # Need to wait until the user has selected a region using the widget before moving on with - # selecting the window settings + # Need to wait until the user has selected a region using the widget + # before moving on with selecting the window settings while True: width = selector.width() height = selector.height() @@ -86,92 +107,15 @@ def select_region(autosplit: AutoSplit): autosplit.windows_graphics_capture.close() autosplit.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) - offset_x, offset_y, *_ = win32gui.GetWindowRect(hwnd) + left_bounds, top_bounds, *_ = get_window_bounds(hwnd) + window_x, window_y, *_ = win32gui.GetWindowRect(hwnd) __set_region_values(autosplit, - left=x - offset_x, - top=y - offset_y, + left=x - window_x - left_bounds, + top=y - window_y - top_bounds, width=width, height=height) -@dataclass -class WindowsGraphicsCapture: - size: SizeInt32 - frame_pool: Direct3D11CaptureFramePool - # Prevent session from being garbage collected - session: GraphicsCaptureSession - last_captured_frame: Optional[cv2.Mat] - - def close(self): - self.frame_pool.close() - try: - self.session.close() - except OSError: - # OSError: The application called an interface that was marshalled for a different thread - # This still seems to close the session and prevent the following hard crash in LiveSplit - # pylint: disable=line-too-long - # "AutoSplit.exe " # noqa: E501 - pass - - -def create_windows_graphics_capture(item: GraphicsCaptureItem): - # Note: Must create in the same thread (can't use a global) otherwise when ran from LiveSplit it will raise: - # OSError: The application called an interface that was marshalled for a different thread - media_capture = MediaCapture() - - async def coroutine(): - await (media_capture.initialize_async() or asyncio.sleep(0)) - asyncio.run(coroutine()) - - if not media_capture.media_capture_settings: - raise OSError("Unable to initialize a Direct3D Device.") - frame_pool = Direct3D11CaptureFramePool.create_free_threaded( - media_capture.media_capture_settings.direct3_d11_device, - DirectXPixelFormat.B8_G8_R8_A8_UINT_NORMALIZED, - 1, - item.size) - if not frame_pool: - raise OSError("Unable to create a frame pool for a capture session.") - session = frame_pool.create_capture_session(item) - if not session: - raise OSError("Unable to create a capture session.") - session.is_cursor_capture_enabled = False - if int(version().split(".")[2]) >= WGC_NO_BORDER_MIN_BUILD: - session.is_border_required = False - session.start_capture() - return WindowsGraphicsCapture(item.size, frame_pool, session, None) - - -def __select_graphics_item(autosplit: AutoSplit): # pyright: ignore [reportUnusedFunction] - # TODO: For later as a different picker option - """ - Uses the built-in GraphicsCapturePicker to select the Window - """ - def callback(async_operation: IAsyncOperation[GraphicsCaptureItem], async_status: AsyncStatus): - try: - if async_status != AsyncStatus.COMPLETED: - return - except SystemError as exception: - # HACK: can happen when closing the GraphicsCapturePicker - if str(exception).endswith("returned a result with an error set"): - return - raise - item = async_operation.get_results() - if not item: - return - autosplit.settings_dict["captured_window_title"] = item.display_name - if autosplit.windows_graphics_capture: - autosplit.windows_graphics_capture.close() - autosplit.windows_graphics_capture = create_windows_graphics_capture(item) - - picker = GraphicsCapturePicker() - initialize_with_window(picker, int(autosplit.effectiveWinId())) - async_operation = picker.pick_single_item_async() - # None if the selection is canceled - if async_operation: - async_operation.completed = callback - - def select_window(autosplit: AutoSplit): # Create a screen selector widget selector = SelectWindowWidget() @@ -199,31 +143,17 @@ def select_window(autosplit: AutoSplit): autosplit.windows_graphics_capture.close() autosplit.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) - # Getting window bounds - # On Windows there is a shadow around the windows that we need to account for. - # We also account for the borders and titlebar to only get the client area. - extended_frame_bounds = ctypes.wintypes.RECT() - ctypes.windll.dwmapi.DwmGetWindowAttribute( - hwnd, - DWMWA_EXTENDED_FRAME_BOUNDS, - ctypes.byref(extended_frame_bounds), - ctypes.sizeof(extended_frame_bounds)) - - window_rect = win32gui.GetWindowRect(hwnd) + # Exlude the borders and titlebar from the window selection. To only get the client area. + _, __, window_width, window_height = get_window_bounds(hwnd) _, __, client_width, client_height = win32gui.GetClientRect(hwnd) - - window_width = cast(int, extended_frame_bounds.right) - cast(int, extended_frame_bounds.left) - window_height = cast(int, extended_frame_bounds.bottom) - cast(int, extended_frame_bounds.top) border_width = ceil((window_width - client_width) / 2) - titlebar_height = window_height - client_height - border_width * 2 - client_left = cast(int, extended_frame_bounds.left) - window_rect[0] + border_width - client_top = cast(int, extended_frame_bounds.top) - window_rect[1] + titlebar_height + titlebar_with_border_height = window_height - client_height - border_width __set_region_values(autosplit, - left=client_left, - top=client_top, + left=border_width, + top=titlebar_with_border_height, width=client_width, - height=client_height) + height=client_height - border_width * 2) def __get_window_from_point(x: int, y: int): @@ -267,7 +197,7 @@ def align_region(autosplit: AutoSplit): # Obtaining the capture of a region which contains the # subregion being searched for to align the image. - capture, _ = region_capture.capture_region(autosplit) + capture, _ = capture_region(autosplit) if capture is None or not capture.size: error_messages.region() From 0ad99bf4dc8ca588c840486c2781319fe7b07ee3 Mon Sep 17 00:00:00 2001 From: Avasam Date: Fri, 17 Jun 2022 00:38:38 -0400 Subject: [PATCH 081/137] Removed simplejson --- scripts/requirements-dev.txt | 2 -- src/menu_bar.py | 3 +-- 2 files changed, 1 insertion(+), 4 deletions(-) diff --git a/scripts/requirements-dev.txt b/scripts/requirements-dev.txt index 9ba430e3..9249c181 100644 --- a/scripts/requirements-dev.txt +++ b/scripts/requirements-dev.txt @@ -10,8 +10,6 @@ flake8-quotes flake8-isort pylint>=2.13.9 pywin32-stubs>=0.1.6 -simplejson -types-simplejson>=3.17.2 types-requests # # You can comment this out if you don't want to run `designer.bat` to quickly open the bundled PyQt Designer. diff --git a/src/menu_bar.py b/src/menu_bar.py index 17208c4e..1ce80a2a 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -11,7 +11,6 @@ from packaging.version import parse as version_parse from PyQt6 import QtCore, QtWidgets from requests.exceptions import RequestException -from simplejson.errors import JSONDecodeError from win32 import win32gui from winsdk.windows.graphics.capture.interop import create_for_window @@ -97,7 +96,7 @@ def run(self): response = requests.get("https://api.github.com/repos/Toufool/Auto-Split/releases/latest") latest_version = str(response.json()["name"]).split("v")[1] self.autosplit.update_checker_widget_signal.emit(latest_version, self.check_on_open) - except (RequestException, KeyError, JSONDecodeError): + except (RequestException, KeyError): if not self.check_on_open: self.autosplit.show_error_signal.emit(error_messages.check_for_updates) From 0af8ce315c29b9ae68a4372346efd80f790d004c Mon Sep 17 00:00:00 2001 From: Avasam Date: Fri, 17 Jun 2022 01:41:01 -0400 Subject: [PATCH 082/137] More capture method readme update --- README.md | 34 ++++++++++++++++------------------ res/settings.ui | 2 +- src/CaptureMethod.py | 1 + 3 files changed, 18 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index b8ffd103..a3febcb2 100644 --- a/README.md +++ b/README.md @@ -18,27 +18,25 @@ This program can be used to automatically start, split, and reset your preferred ## DOWNLOAD AND OPEN -### Compatibility - -- Windows 7, 10, and 11. +- Download the [latest version](/../../releases/latest) -### Opening the program +### Compatibility -- Download the [latest version](/../../releases/latest) -- Extract the file and open AutoSplit.exe. +- Windows 10 and 11. ### Building (This is not required for normal use) -- Python 3.8 - 3.10 -- Microsoft Visual C++ 14.0 or greater may be required to build the executable. Get it with [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/) +- Python 3.9 - 3.10. +- Microsoft Visual C++ 14.0 or greater may be required to build the executable. Get it with [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/). - Node is optional, but required for complete linting (using Pyright). -- Read [requirements.txt](/scripts/requirements.txt) for more information on how to install, run and build the python code - - Run `.\scripts\install.bat` to install all dependencies - - Run the app directly with `.\scripts\start.bat [--auto-controlled]` - - Run `.\scripts\build.bat` to build an executable -- Recompile resources after modifications by running `.\scripts\compile_resources.bat` +- Read [requirements.txt](/scripts/requirements.txt) for more information on how to install, run and build the python code. + - Run `.\scripts\install.bat` to install all dependencies. + - Run the app directly with `.\scripts\start.bat [--auto-controlled]`. + - Run `.\scripts\build.bat` to build an executable. +- Recompile resources after modifications by running `.\scripts\compile_resources.bat`. +- All configured for VSCode, including Run (F5) and Build (Ctrl+Shift+B) commands. ## OPTIONS @@ -54,10 +52,10 @@ This program can be used to automatically start, split, and reset your preferred #### Capture Region - This is the region that your split images are compared to. Usually, this is going to be the full game screen. -- Click "Select Region" +- Click "Select Region". - Click and drag to form a rectangle over the region you want to capture. - Adjust the x, y, width, and height of the capture region manually to make adjustments as needed. -- If you want to align your capture region by using a reference image, click "Align Region" +- If you want to align your capture region by using a reference image, click "Align Region". - You can freely move the window that the program is capturing, but resizing the window will cause the capture region to change. - Once you are happy with your capture region, you may unselect Live Capture Region to decrease CPU usage if you wish. - You can save a screenshot of the capture region to your split image folder using the Take Screenshot button. @@ -71,7 +69,7 @@ This program can be used to automatically start, split, and reset your preferred #### Comparison Method - There are three comparison methods to choose from: L2 Norm, Histograms, and Perceptual Hash (or pHash). - - L2 Norm: This method should be fine to use for most cases. it finds the difference between each pixel, squares it, and sums it over the entire image and takes the square root. This is very fast but is a problem if your image is high frequency. Any translational movement or rotation can cause similarity to be very different. + - L2 Norm: This method should be fine to use for most cases. it finds the difference between each pixel, squares it, sums it over the entire image and takes the square root. This is very fast but is a problem if your image is high frequency. Any translational movement or rotation can cause similarity to be very different. - Histograms: An explanation on Histograms comparison can be found [here](https://mpatacchiola.github.io/blog/2016/11/12/the-simplest-classifier-histogram-intersection.html). This is a great method to use if you are using several masked images. - Perceptual Hash: An explanation on pHash comparison can be found [here](http://www.hackerfactor.com/blog/index.php?/archives/432-Looks-Like-It.html). It is highly recommended to NOT use pHash if you use masked images. It is very inaccurate. @@ -79,11 +77,12 @@ This program can be used to automatically start, split, and reset your preferred - **BitBlt** (fastest, least compatible) A good default fast option. But it cannot properly record OpenGL, Hardware Accelerated or Exclusive Fullscreen windows. - The smaller the region, the more efficient it is. + The smaller the selected region, the more efficient it is. - **Windows Graphics Capture** (fast, most compatible, capped at 60fps) Only available in Windows 10.0.17134 and up. Due to current technical limitations, it requires having at least one audio or video Capture Device connected and enabled. Even if it won't be used. Allows recording UWP apps, Hardware Accelerated and Exclusive Fullscreen windows. + Adds a yellow border on Windows 10. Not present on Windows 11. Caps at around 60 FPS. - **Direct3D Desktop Duplication** (slower, bound to display) Duplicates the desktop using Direct3D. @@ -96,7 +95,6 @@ This program can be used to automatically start, split, and reset your preferred - **Video Capture Device** (very slow, see below) Uses a Video Capture Device, like a webcam, virtual cam, or capture card. There are currently performance issues, but it might be more convenient. - It is not yet possible for us to display the device name. If you want to use this with OBS' Virtual Camera, use the [Virtualcam plugin](https://obsproject.com/forum/resources/obs-virtualcam.949/) instead. #### Show Live Similarity diff --git a/res/settings.ui b/res/settings.ui index cb634d59..51cf6b93 100644 --- a/res/settings.ui +++ b/res/settings.ui @@ -219,7 +219,7 @@ - Perceptual Hash + pHash diff --git a/src/CaptureMethod.py b/src/CaptureMethod.py index 2b66c6a9..1d8c7f59 100644 --- a/src/CaptureMethod.py +++ b/src/CaptureMethod.py @@ -86,6 +86,7 @@ def get_method_by_index(self, index: int): f"\nOnly available in Windows 10.0.{WGC_MIN_BUILD} and up. " "\nDue to current technical limitations, it requires having at least one " "\naudio or video Capture Device connected and enabled. Even if it won't be used. " + "\nAdds a yellow border on Windows 10. Not present on Windows 11. " "\nAllows recording UWP apps, Hardware Accelerated and Exclusive Fullscreen windows. " "\nCaps at around 60 FPS. " ), From 97fbe26b9789f93de51120ec99aae8e8e47ef25f Mon Sep 17 00:00:00 2001 From: Avasam Date: Fri, 17 Jun 2022 18:10:58 -0400 Subject: [PATCH 083/137] Fix #27 --- src/AutoSplit.py | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 5a0ba2b0..6cb2636a 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -269,19 +269,19 @@ def __load_start_image(self, started_by_button: bool = False, wait_for_delay: bo self.current_image_file_label.setText("-") self.start_image_status_value_label.setText("not found") - if not self.is_auto_controlled \ - and (not self.settings_dict["split_hotkey"] - or not self.settings_dict["reset_hotkey"] - or not self.settings_dict["pause_hotkey"]): - error_messages.load_start_image() - QApplication.processEvents() - return - if not (validate_before_parsing(self, started_by_button) and parse_and_validate_images(self)): QApplication.processEvents() return - if self.start_image is None: + if self.start_image: + if not self.is_auto_controlled \ + and (not self.settings_dict["split_hotkey"] + or not self.settings_dict["reset_hotkey"] + or not self.settings_dict["pause_hotkey"]): + error_messages.load_start_image() + QApplication.processEvents() + return + else: if started_by_button: error_messages.no_keyword_image(START_KEYWORD) QApplication.processEvents() From a1c1dd9451e78502eab3550c92cbbc2086a1284b Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 18 Jun 2022 20:03:44 -0400 Subject: [PATCH 084/137] round down floats shown in UI --- src/AutoSplit.py | 25 ++++++++++--------------- src/hotkeys.py | 4 +++- src/menu_bar.py | 5 +++-- src/utils.py | 5 +++++ 4 files changed, 21 insertions(+), 18 deletions(-) create mode 100644 src/utils.py diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 6cb2636a..7373807d 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -1,11 +1,5 @@ #!/usr/bin/python3 # -*- coding: utf-8 -*- - -# Imports grouping: -# - Typings -# - Standards -# - Externals -# - Internals from __future__ import annotations import ctypes @@ -40,6 +34,7 @@ validate_before_parsing) from split_parser import BELOW_FLAG, DUMMY_FLAG, PAUSE_FLAG, parse_and_validate_images from user_profile import DEFAULT_PROFILE, FROZEN +from utils import decimal from WindowsGraphicsCapture import WindowsGraphicsCapture START_AUTO_SPLITTER_TEXT = "Start Auto Splitter" @@ -320,9 +315,9 @@ def __start_image_function(self): if start_image_similarity > self.highest_similarity: self.highest_similarity = start_image_similarity - self.table_current_image_threshold_label.setText(f"{start_image_threshold:.2f}") - self.table_current_image_live_label.setText(f"{start_image_similarity:.2f}") - self.table_current_image_highest_label.setText(f"{self.highest_similarity:.2f}") + self.table_current_image_threshold_label.setText(decimal(start_image_threshold)) + self.table_current_image_live_label.setText(decimal(start_image_similarity)) + self.table_current_image_highest_label.setText(decimal(self.highest_similarity)) # 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 @@ -627,14 +622,14 @@ def __similarity_threshold_loop(self, number_of_split_images: int, dummy_splits_ similarity = self.split_image.compare_with_capture(self, capture) # Show live similarity - self.table_current_image_live_label.setText(f"{similarity:.2f}") + self.table_current_image_live_label.setText(decimal(similarity)) # if the similarity becomes higher than highest similarity, set it as such. if similarity > self.highest_similarity: self.highest_similarity = similarity # show live highest similarity if the checkbox is checked - self.table_current_image_highest_label.setText(f"{self.highest_similarity:.2f}") + self.table_current_image_highest_label.setText(decimal(self.highest_similarity)) # If its the last split image and last loop number, disable the next image button # If its the first split image, disable the undo split and previous image buttons @@ -808,10 +803,10 @@ def __reset_if_should(self, capture: Optional[cv2.Mat]): should_reset = similarity >= threshold if similarity > self.reset_highest_similarity: self.reset_highest_similarity = similarity - self.table_reset_image_highest_label.setText(f"{self.reset_highest_similarity:.2f}") - self.table_reset_image_live_label.setText(f"{similarity:.2f}") + self.table_reset_image_highest_label.setText(decimal(self.reset_highest_similarity)) + self.table_reset_image_live_label.setText(decimal(similarity)) - self.table_reset_image_threshold_label.setText(f"{threshold:.2f}") + self.table_reset_image_threshold_label.setText(decimal(threshold)) if should_reset: send_command(self, "reset") @@ -833,7 +828,7 @@ def __update_split_image(self, specific_image: Optional[AutoSplitImage] = None): set_ui_image(self.current_split_image, self.split_image.bytes, True) self.current_image_file_label.setText(self.split_image.filename) - self.table_current_image_threshold_label.setText(f"{self.split_image.get_similarity_threshold(self):.2f}") + self.table_current_image_threshold_label.setText(decimal(self.split_image.get_similarity_threshold(self))) # Set Image Loop # if specific_image and specific_image.image_type == ImageType.START: diff --git a/src/hotkeys.py b/src/hotkeys.py index 3ddf02a1..17053260 100644 --- a/src/hotkeys.py +++ b/src/hotkeys.py @@ -15,6 +15,7 @@ SET_HOTKEY_TEXT = "Set Hotkey" PRESS_A_KEY_TEXT = "Press a key..." +START_AUTO_SPLITTER_TEXT = "Start Auto Splitter" Commands = Literal["split", "start", "pause", "reset", "skip", "undo"] Hotkeys = Literal["split", "reset", "skip_split", "undo_split", "pause"] @@ -36,7 +37,8 @@ def after_setting_hotkey(autosplit: AutoSplit): Do all of these things after you set a hotkey. A signal connects to this because changing GUI stuff is only possible in the main thread """ - autosplit.start_auto_splitter_button.setEnabled(True) + if autosplit.start_auto_splitter_button.text() == START_AUTO_SPLITTER_TEXT: + autosplit.start_auto_splitter_button.setEnabled(True) if autosplit.SettingsWidget: for hotkey in HOTKEYS: getattr(autosplit.SettingsWidget, f"set_{hotkey}_hotkey_button").setText(SET_HOTKEY_TEXT) diff --git a/src/menu_bar.py b/src/menu_bar.py index 1ce80a2a..6da7e6b7 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -21,6 +21,7 @@ from gen import about, design, resources_rc, settings as settings_ui, update_checker # noqa: F401 from hotkeys import set_hotkey from region_selection import create_windows_graphics_capture +from utils import decimal if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -126,11 +127,11 @@ class __SettingsWidget(QtWidgets.QDialog, settings_ui.Ui_DialogSettings): def __update_default_threshold(self, value: Any): self.__set_value("default_similarity_threshold", value) self.autosplit.table_current_image_threshold_label.setText( - f"{self.autosplit.split_image.get_similarity_threshold(self.autosplit):.2f}" + decimal(self.autosplit.split_image.get_similarity_threshold(self.autosplit)) if self.autosplit.split_image else "-") self.autosplit.table_reset_image_threshold_label.setText( - f"{self.autosplit.reset_image.get_similarity_threshold(self.autosplit):.2f}" + decimal(self.autosplit.reset_image.get_similarity_threshold(self.autosplit)) if self.autosplit.reset_image else "-") diff --git a/src/utils.py b/src/utils.py new file mode 100644 index 00000000..fdbf05ea --- /dev/null +++ b/src/utils.py @@ -0,0 +1,5 @@ +from typing import Union + + +def decimal(value: Union[int, float]): + return f"{int(value * 100) / 100:.2f}" From 45aab97dfd0677d9c8c5b501491acb9f06795f72 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 18 Jun 2022 21:32:33 -0400 Subject: [PATCH 085/137] disable unused hotkeys when autocontrolled --- src/menu_bar.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/menu_bar.py b/src/menu_bar.py index 6da7e6b7..ba1e932a 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -19,7 +19,7 @@ from AutoSplitImage import COMPARISON_RESIZE_HEIGHT, COMPARISON_RESIZE_WIDTH from CaptureMethod import CAPTURE_METHODS, CameraInfo, CaptureMethod, get_all_video_capture_devices from gen import about, design, resources_rc, settings as settings_ui, update_checker # noqa: F401 -from hotkeys import set_hotkey +from hotkeys import HOTKEYS, set_hotkey from region_selection import create_windows_graphics_capture from utils import decimal @@ -203,6 +203,11 @@ async def __set_all_capture_devices(self): def __init__(self, autosplit: AutoSplit): super().__init__() self.setupUi(self) + # Make it very clear that hotkeys are not used when auto-controlled + if autosplit.is_auto_controlled: + for hotkey in HOTKEYS: + getattr(self, f"set_{hotkey}_hotkey_button").setEnabled(False) + getattr(self, f"{hotkey}_input").setEnabled(False) # Spinbox frame disappears and reappears on Windows 11. It's much cleaner to just disable them. # Most likely related: https://bugreports.qt.io/browse/QTBUG-95215?jql=labels%20%3D%20Windows11 # Arrow buttons tend to move a lot as well From 920fcfd5326a4576dbb9a36552a9817d200c72ed Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 18 Jun 2022 22:52:39 -0400 Subject: [PATCH 086/137] Allow to move / set an existing hotkey and fix Avasam#28 --- src/AutoSplit.py | 17 ++++++----------- src/hotkeys.py | 16 +++++++++------- src/menu_bar.py | 35 +++++++++++++++-------------------- src/user_profile.py | 13 +++++-------- 4 files changed, 35 insertions(+), 46 deletions(-) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 7373807d..0122ce58 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -26,7 +26,7 @@ from AutoSplitImage import COMPARISON_RESIZE, START_KEYWORD, AutoSplitImage, ImageType from CaptureMethod import CaptureMethod from gen import about, design, settings, update_checker -from hotkeys import after_setting_hotkey, send_command +from hotkeys import HOTKEYS, after_setting_hotkey, send_command from menu_bar import (AUTOSPLIT_VERSION, check_for_updates, get_default_settings_from_ui, open_about, open_settings, open_update_checker, view_help) from region_capture import capture_region, set_ui_image @@ -706,11 +706,8 @@ def gui_changes_on_start(self): self.next_image_button.setEnabled(True) if self.SettingsWidget: - self.SettingsWidget.set_split_hotkey_button.setEnabled(False) - self.SettingsWidget.set_reset_hotkey_button.setEnabled(False) - self.SettingsWidget.set_skip_split_hotkey_button.setEnabled(False) - self.SettingsWidget.set_undo_split_hotkey_button.setEnabled(False) - self.SettingsWidget.set_pause_hotkey_button.setEnabled(False) + for hotkey in HOTKEYS: + getattr(self.SettingsWidget, f"set_{hotkey}_hotkey_button").setEnabled(False) if not self.is_auto_controlled: self.start_auto_splitter_button.setEnabled(False) @@ -737,11 +734,9 @@ def gui_changes_on_reset(self, safe_to_reload_start_image: bool = False): self.next_image_button.setEnabled(False) if self.SettingsWidget: - self.SettingsWidget.set_split_hotkey_button.setEnabled(True) - self.SettingsWidget.set_reset_hotkey_button.setEnabled(True) - self.SettingsWidget.set_skip_split_hotkey_button.setEnabled(True) - self.SettingsWidget.set_undo_split_hotkey_button.setEnabled(True) - self.SettingsWidget.set_pause_hotkey_button.setEnabled(True) + for hotkey in HOTKEYS: + getattr(self.SettingsWidget, f"set_{hotkey}_hotkey_button").setEnabled(True) + if not self.is_auto_controlled: self.start_auto_splitter_button.setEnabled(True) self.reset_button.setEnabled(False) diff --git a/src/hotkeys.py b/src/hotkeys.py index 17053260..f9c24645 100644 --- a/src/hotkeys.py +++ b/src/hotkeys.py @@ -195,8 +195,14 @@ def __read_hotkey(): return __get_hotkey_name(names) -def __is_key_already_set(autosplit: AutoSplit, key_name: str): - return key_name in [autosplit.settings_dict[f"{hotkey}_hotkey"] for hotkey in HOTKEYS] +def __remove_key_already_set(autosplit: AutoSplit, key_name: str): + for hotkey in HOTKEYS: + settings_key = f"{hotkey}_hotkey" + if autosplit.settings_dict[settings_key] == key_name: + _unhook(getattr(autosplit, f"{hotkey}_hotkey")) + autosplit.settings_dict[settings_key] = "" + if autosplit.SettingsWidget: + getattr(autosplit.SettingsWidget, f"{hotkey}_input").setText("") # TODO: using getattr/setattr is NOT a good way to go about this. It was only temporarily done to # reduce duplicated code. We should use a dictionary of hotkey class or something. @@ -214,11 +220,7 @@ def set_hotkey(autosplit: AutoSplit, hotkey: Hotkeys, preselected_hotkey_name: s def callback(): hotkey_name = preselected_hotkey_name if preselected_hotkey_name else __read_hotkey() - # If the key the user presses is equal to itself or another hotkey already set, - # this causes issues. so here, it catches that, and will make no changes to the hotkey. - if __is_key_already_set(autosplit, hotkey_name): - autosplit.after_setting_hotkey_signal.emit() - return + __remove_key_already_set(autosplit, hotkey_name) # We need to inspect the event to know if it comes from numpad because of _canonial_names. # See: https://github.com/boppreh/keyboard/issues/161#issuecomment-386825737 diff --git a/src/menu_bar.py b/src/menu_bar.py index ba1e932a..cccce245 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -19,7 +19,7 @@ from AutoSplitImage import COMPARISON_RESIZE_HEIGHT, COMPARISON_RESIZE_WIDTH from CaptureMethod import CAPTURE_METHODS, CameraInfo, CaptureMethod, get_all_video_capture_devices from gen import about, design, resources_rc, settings as settings_ui, update_checker # noqa: F401 -from hotkeys import HOTKEYS, set_hotkey +from hotkeys import HOTKEYS, Hotkeys, set_hotkey from region_selection import create_windows_graphics_capture from utils import decimal @@ -203,11 +203,6 @@ async def __set_all_capture_devices(self): def __init__(self, autosplit: AutoSplit): super().__init__() self.setupUi(self) - # Make it very clear that hotkeys are not used when auto-controlled - if autosplit.is_auto_controlled: - for hotkey in HOTKEYS: - getattr(self, f"set_{hotkey}_hotkey_button").setEnabled(False) - getattr(self, f"{hotkey}_input").setEnabled(False) # Spinbox frame disappears and reappears on Windows 11. It's much cleaner to just disable them. # Most likely related: https://bugreports.qt.io/browse/QTBUG-95215?jql=labels%20%3D%20Windows11 # Arrow buttons tend to move a lot as well @@ -241,14 +236,21 @@ def __init__(self, autosplit: AutoSplit): for method in capture_method_values])) # endregion -# region Set initial values - # Hotkeys - self.split_input.setText(autosplit.settings_dict["split_hotkey"]) - self.reset_input.setText(autosplit.settings_dict["reset_hotkey"]) - self.undo_split_input.setText(autosplit.settings_dict["undo_split_hotkey"]) - self.skip_split_input.setText(autosplit.settings_dict["skip_split_hotkey"]) - self.pause_input.setText(autosplit.settings_dict["pause_hotkey"]) + # Hotkeys initial values and bindings + def hotkey_connect(hotkey: Hotkeys): + return lambda: set_hotkey(self.autosplit, hotkey) + for hotkey in HOTKEYS: + hotkey_input: QtWidgets.QLineEdit = getattr(self, f"{hotkey}_input") + set_hotkey_hotkey_button: QtWidgets.QPushButton = getattr(self, f"set_{hotkey}_hotkey_button") + hotkey_input.setText(cast(str, autosplit.settings_dict[f"{hotkey}_hotkey"])) + + set_hotkey_hotkey_button.clicked.connect(hotkey_connect(hotkey)) + # Make it very clear that hotkeys are not used when auto-controlled + if autosplit.is_auto_controlled: + set_hotkey_hotkey_button.setEnabled(False) + hotkey_input.setEnabled(False) +# region Set initial values # Capture Settings self.fps_limit_spinbox.setValue(autosplit.settings_dict["fps_limit"]) self.live_capture_region_checkbox.setChecked(autosplit.settings_dict["live_capture_region"]) @@ -263,13 +265,6 @@ def __init__(self, autosplit: AutoSplit): self.loop_splits_checkbox.setChecked(autosplit.settings_dict["loop_splits"]) # endregion # region Binding - # Hotkeys - self.set_split_hotkey_button.clicked.connect(lambda: set_hotkey(self.autosplit, "split")) - self.set_reset_hotkey_button.clicked.connect(lambda: set_hotkey(self.autosplit, "reset")) - self.set_skip_split_hotkey_button.clicked.connect(lambda: set_hotkey(self.autosplit, "skip_split")) - self.set_undo_split_hotkey_button.clicked.connect(lambda: set_hotkey(self.autosplit, "undo_split")) - self.set_pause_hotkey_button.clicked.connect(lambda: set_hotkey(self.autosplit, "pause")) - # Capture Settings self.fps_limit_spinbox.valueChanged.connect(lambda: self.__set_value( "fps_limit", diff --git a/src/user_profile.py b/src/user_profile.py index 605c2d47..dd90b694 100644 --- a/src/user_profile.py +++ b/src/user_profile.py @@ -15,7 +15,7 @@ from AutoSplitImage import COMPARISON_RESIZE_HEIGHT, COMPARISON_RESIZE_WIDTH from CaptureMethod import CAPTURE_METHODS, CaptureMethod from gen import design -from hotkeys import set_hotkey +from hotkeys import HOTKEYS, set_hotkey from region_capture import Region from region_selection import create_windows_graphics_capture @@ -146,9 +146,9 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str keyboard.unhook_all() if not autosplit.is_auto_controlled: - for hotkey in ["split_hotkey", "reset_hotkey", "skip_split_hotkey", "undo_split_hotkey", "pause_hotkey"]: - if autosplit.settings_dict[hotkey]: - set_hotkey(autosplit, "split", cast(str, autosplit.settings_dict[hotkey])) + for hotkey, hotkey_name in [(hotkey, f"{hotkey}_hotkey") for hotkey in HOTKEYS]: + if autosplit.settings_dict[hotkey_name]: + set_hotkey(autosplit, hotkey, cast(str, autosplit.settings_dict[hotkey_name])) if autosplit.settings_dict["captured_window_title"]: hwnd = win32gui.FindWindow(None, autosplit.settings_dict["captured_window_title"]) @@ -166,10 +166,7 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str return True -def load_settings( - autosplit: AutoSplit, - from_path: str = "" -): +def load_settings(autosplit: AutoSplit, from_path: str = ""): load_settings_file_path = from_path or QtWidgets.QFileDialog.getOpenFileName( autosplit, "Load Profile", From 2587fd397e2e8721abfffa6b00e3bf177efe406a Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 18 Jun 2022 23:50:33 -0400 Subject: [PATCH 087/137] don't double send skip and undo splits hotkey --- src/AutoSplit.py | 20 ++++++++++---------- src/hotkeys.py | 20 +++++++++++++++----- 2 files changed, 25 insertions(+), 15 deletions(-) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 0122ce58..4f9eb4ef 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -174,10 +174,10 @@ def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-man self.start_auto_splitter_button.clicked.connect(self.__auto_splitter) self.check_fps_button.clicked.connect(self.__check_fps) self.reset_button.clicked.connect(self.reset) - self.skip_split_button.clicked.connect(self.__skip_split) - self.undo_split_button.clicked.connect(self.__undo_split) - self.next_image_button.clicked.connect(lambda: self.__skip_split(True)) - self.previous_image_button.clicked.connect(lambda: self.__undo_split(True)) + self.skip_split_button.clicked.connect(self.skip_split) + self.undo_split_button.clicked.connect(self.undo_split) + self.next_image_button.clicked.connect(lambda: self.skip_split(True)) + self.previous_image_button.clicked.connect(lambda: self.undo_split(True)) self.align_region_button.clicked.connect(lambda: align_region(self)) self.select_window_button.clicked.connect(lambda: select_window(self)) self.reload_start_image_button.clicked.connect(lambda: self.__load_start_image(True, True)) @@ -201,8 +201,8 @@ def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-man self.load_start_image_signal[bool].connect(self.__load_start_image) self.load_start_image_signal[bool, bool].connect(self.__load_start_image) self.reset_signal.connect(self.reset) - self.skip_split_signal.connect(self.__skip_split) - self.undo_split_signal.connect(self.__undo_split) + self.skip_split_signal.connect(self.skip_split) + self.undo_split_signal.connect(self.undo_split) self.pause_signal.connect(self.pause) # live image checkbox @@ -423,9 +423,9 @@ def __is_current_split_out_of_range(self): return self.split_image_number < 0 \ or self.split_image_number > len(self.split_images_and_loop_number) - 1 - def __undo_split(self, navigate_image_only: bool = False): + def undo_split(self, navigate_image_only: bool = False): """ - "Undo Split" and "Prev. Img." buttons and hotkey connect to here + "Undo Split" and "Prev. Img." buttons connect to here """ # Can't undo until timer is started # or Undoing past the first image @@ -447,9 +447,9 @@ def __undo_split(self, navigate_image_only: bool = False): if not navigate_image_only: send_command(self, "undo") - def __skip_split(self, navigate_image_only: bool = False): + def skip_split(self, navigate_image_only: bool = False): """ - "Skip Split" and "Next Img." buttons and hotkey connect to here + "Skip Split" and "Next Img." buttons connect to here """ # Can't skip or split until timer is started # or Splitting/skipping when there are no images left diff --git a/src/hotkeys.py b/src/hotkeys.py index f9c24645..a84abaf4 100644 --- a/src/hotkeys.py +++ b/src/hotkeys.py @@ -204,6 +204,16 @@ def __remove_key_already_set(autosplit: AutoSplit, key_name: str): if autosplit.SettingsWidget: getattr(autosplit.SettingsWidget, f"{hotkey}_input").setText("") + +def __get_hotkey_action(autosplit: AutoSplit, hotkey: Hotkeys): + if hotkey == "split": + return autosplit.start_auto_splitter + if hotkey == "skip_split": + return lambda: autosplit.skip_split(True) + if hotkey == "undo_split": + return lambda: autosplit.undo_split(True) + return getattr(autosplit, f"{hotkey}_signal").emit + # TODO: using getattr/setattr is NOT a good way to go about this. It was only temporarily done to # reduce duplicated code. We should use a dictionary of hotkey class or something. @@ -222,11 +232,7 @@ def callback(): __remove_key_already_set(autosplit, hotkey_name) - # We need to inspect the event to know if it comes from numpad because of _canonial_names. - # See: https://github.com/boppreh/keyboard/issues/161#issuecomment-386825737 - # The best way to achieve this is make our own hotkey handling on top of hook - # See: https://github.com/boppreh/keyboard/issues/216#issuecomment-431999553 - action = autosplit.start_auto_splitter if hotkey == "split" else getattr(autosplit, f"{hotkey}_signal").emit + action = __get_hotkey_action(autosplit, hotkey) setattr( autosplit, f"{hotkey}_hotkey", @@ -236,6 +242,10 @@ def callback(): # keyboard module allows you to hit multiple keys for a hotkey. they are joined together by +. keyboard.add_hotkey(hotkey_name, action) if "+" in hotkey_name + # We need to inspect the event to know if it comes from numpad because of _canonial_names. + # See: https://github.com/boppreh/keyboard/issues/161#issuecomment-386825737 + # The best way to achieve this is make our own hotkey handling on top of hook + # See: https://github.com/boppreh/keyboard/issues/216#issuecomment-431999553 else keyboard.hook_key( hotkey_name, lambda keyboard_event: _hotkey_action(keyboard_event, hotkey_name, action)) From c3ac3500204148d14485da3d8a3a09ffc3749ff0 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sun, 19 Jun 2022 02:12:40 -0400 Subject: [PATCH 088/137] Extract all constants and shared utils methods --- .flake8 | 1 - src/AutoSplit.py | 18 +++++++--------- src/CaptureMethod.py | 7 +++--- src/WindowsGraphicsCapture.py | 5 +++-- src/error_messages.py | 2 +- src/hotkeys.py | 16 +++----------- src/menu_bar.py | 10 ++------- src/user_profile.py | 6 +----- src/utils.py | 40 ++++++++++++++++++++++++++++++++++- 9 files changed, 61 insertions(+), 44 deletions(-) diff --git a/.flake8 b/.flake8 index 11b14651..147db040 100644 --- a/.flake8 +++ b/.flake8 @@ -18,7 +18,6 @@ per-file-ignores= ; Line too long ; Naming conventions can't be controlled for external libraries typings/**: Q000,E704,E501,N8 - ; PyQt methods ignore-names=closeEvent,paintEvent,keyPressEvent,mousePressEvent,mouseMoveEvent,mouseReleaseEvent ; McCabe max-complexity is also taken care of by Pylint and doesn't fail the build there diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 4f9eb4ef..325d66fe 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -7,7 +7,6 @@ import signal import sys from collections.abc import Callable -from platform import version from time import time from types import FunctionType from typing import Optional @@ -27,19 +26,18 @@ from CaptureMethod import CaptureMethod from gen import about, design, settings, update_checker from hotkeys import HOTKEYS, after_setting_hotkey, send_command -from menu_bar import (AUTOSPLIT_VERSION, check_for_updates, get_default_settings_from_ui, open_about, open_settings, - open_update_checker, view_help) +from menu_bar import (check_for_updates, get_default_settings_from_ui, open_about, open_settings, open_update_checker, + view_help) from region_capture import capture_region, set_ui_image from region_selection import (align_region, create_windows_graphics_capture, select_region, select_window, validate_before_parsing) from split_parser import BELOW_FLAG, DUMMY_FLAG, PAUSE_FLAG, parse_and_validate_images -from user_profile import DEFAULT_PROFILE, FROZEN -from utils import decimal +from user_profile import DEFAULT_PROFILE +from utils import (AUTOSPLIT_VERSION, FIRST_WIN_11_BUILD, FROZEN, START_AUTO_SPLITTER_TEXT, WINDOWS_BUILD_NUMBER, + auto_split_directory, decimal) from WindowsGraphicsCapture import WindowsGraphicsCapture -START_AUTO_SPLITTER_TEXT = "Start Auto Splitter" CHECK_FPS_ITERATIONS = 10 -FIRST_WIN_11_BUILD = 22000 # Needed when compiled, along with the custom hook-requests PyInstaller hook os.environ["REQUESTS_CA_BUNDLE"] = certifi.where() @@ -125,7 +123,7 @@ def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-man # Spinbox frame disappears and reappears on Windows 11. It's much cleaner to just disable them. # Most likely related: https://bugreports.qt.io/browse/QTBUG-95215?jql=labels%20%3D%20Windows11 # Arrow buttons tend to move a lot as well - if int(version().split(".")[2]) >= FIRST_WIN_11_BUILD: + if WINDOWS_BUILD_NUMBER >= FIRST_WIN_11_BUILD: self.x_spinbox.setFrame(False) self.y_spinbox.setFrame(False) self.width_spinbox.setFrame(False) @@ -234,7 +232,7 @@ def __browse(self): new_split_image_directory = QFileDialog.getExistingDirectory( self, "Select Split Image Directory", - os.path.join(self.settings_dict["split_image_directory"] or user_profile.auto_split_directory, "..")) + os.path.join(self.settings_dict["split_image_directory"] or auto_split_directory, "..")) # If the user doesn't select a folder, it defaults to "". if new_split_image_directory: @@ -733,7 +731,7 @@ def gui_changes_on_reset(self, safe_to_reload_start_image: bool = False): self.previous_image_button.setEnabled(False) self.next_image_button.setEnabled(False) - if self.SettingsWidget: + if self.SettingsWidget and not self.is_auto_controlled: for hotkey in HOTKEYS: getattr(self.SettingsWidget, f"set_{hotkey}_hotkey_button").setEnabled(True) diff --git a/src/CaptureMethod.py b/src/CaptureMethod.py index 1d8c7f59..5d4dd974 100644 --- a/src/CaptureMethod.py +++ b/src/CaptureMethod.py @@ -2,14 +2,15 @@ from collections import OrderedDict from dataclasses import dataclass from enum import Enum, EnumMeta, unique -from platform import version import cv2 from pygrabber.dshow_graph import FilterGraph from winsdk.windows.media.capture import MediaCapture -# https://docs.microsoft.com/en-us/uwp/api/windows.graphics.capture.graphicscapturepicker#applies-to +from utils import WINDOWS_BUILD_NUMBER + WGC_MIN_BUILD = 17134 +"""https://docs.microsoft.com/en-us/uwp/api/windows.graphics.capture.graphicscapturepicker#applies-to""" def test_for_media_capture(): @@ -127,7 +128,7 @@ def get_method_by_index(self, index: int): # Detect and remove unsupported capture methods if ( # Windows Graphics Capture requires a minimum Windows Build - int(version().split(".")[2]) < WGC_MIN_BUILD + WINDOWS_BUILD_NUMBER < WGC_MIN_BUILD # Our current implementation of Windows Graphics Capture requires at least one CaptureDevice or not test_for_media_capture() ): diff --git a/src/WindowsGraphicsCapture.py b/src/WindowsGraphicsCapture.py index adc8b948..0447b6b2 100644 --- a/src/WindowsGraphicsCapture.py +++ b/src/WindowsGraphicsCapture.py @@ -1,6 +1,5 @@ import asyncio from dataclasses import dataclass -from platform import version from typing import Optional import cv2 @@ -9,6 +8,8 @@ from winsdk.windows.graphics.directx import DirectXPixelFormat from winsdk.windows.media.capture import MediaCapture +from utils import WINDOWS_BUILD_NUMBER + WGC_NO_BORDER_MIN_BUILD = 20348 @@ -54,7 +55,7 @@ async def coroutine(): if not session: raise OSError("Unable to create a capture session.") session.is_cursor_capture_enabled = False - if int(version().split(".")[2]) >= WGC_NO_BORDER_MIN_BUILD: + if WINDOWS_BUILD_NUMBER >= WGC_NO_BORDER_MIN_BUILD: session.is_border_required = False session.start_capture() return WindowsGraphicsCapture(item.size, frame_pool, session, None) diff --git a/src/error_messages.py b/src/error_messages.py index af791c7d..1745d430 100644 --- a/src/error_messages.py +++ b/src/error_messages.py @@ -11,7 +11,7 @@ from PyQt6 import QtCore, QtWidgets from AutoSplit import AutoSplit -from user_profile import FROZEN +from utils import FROZEN def __exit_program(): diff --git a/src/hotkeys.py b/src/hotkeys.py index a84abaf4..154bc228 100644 --- a/src/hotkeys.py +++ b/src/hotkeys.py @@ -7,6 +7,8 @@ import keyboard import pyautogui +from utils import START_AUTO_SPLITTER_TEXT, is_digit + if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -15,7 +17,7 @@ SET_HOTKEY_TEXT = "Set Hotkey" PRESS_A_KEY_TEXT = "Press a key..." -START_AUTO_SPLITTER_TEXT = "Start Auto Splitter" + Commands = Literal["split", "start", "pause", "reset", "skip", "undo"] Hotkeys = Literal["split", "reset", "skip_split", "undo_split", "pause"] @@ -45,18 +47,6 @@ def after_setting_hotkey(autosplit: AutoSplit): getattr(autosplit.SettingsWidget, f"set_{hotkey}_hotkey_button").setEnabled(True) -def is_digit(key: Optional[str]): - """ - Checks if `key` is a single-digit string from 0-9 - """ - if key is None: - return False - try: - return 0 <= int(key) <= 9 - except ValueError: - return False - - def send_command(autosplit: AutoSplit, command: Commands): if autosplit.is_auto_controlled: print(command, flush=True) diff --git a/src/menu_bar.py b/src/menu_bar.py index cccce245..c36191a4 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -3,7 +3,6 @@ import asyncio import threading import webbrowser -from platform import version from typing import TYPE_CHECKING, Any, Optional, Union, cast import cv2 @@ -21,16 +20,11 @@ from gen import about, design, resources_rc, settings as settings_ui, update_checker # noqa: F401 from hotkeys import HOTKEYS, Hotkeys, set_hotkey from region_selection import create_windows_graphics_capture -from utils import decimal +from utils import AUTOSPLIT_VERSION, FIRST_WIN_11_BUILD, WINDOWS_BUILD_NUMBER, decimal if TYPE_CHECKING: from AutoSplit import AutoSplit -FIRST_WIN_11_BUILD = 22000 - -# AutoSplit Version number -AUTOSPLIT_VERSION = "2.0.0-alpha.3" - class __AboutWidget(QtWidgets.QWidget, about.Ui_AboutAutoSplitWidget): """About Window""" @@ -206,7 +200,7 @@ def __init__(self, autosplit: AutoSplit): # Spinbox frame disappears and reappears on Windows 11. It's much cleaner to just disable them. # Most likely related: https://bugreports.qt.io/browse/QTBUG-95215?jql=labels%20%3D%20Windows11 # Arrow buttons tend to move a lot as well - if int(version().split(".")[2]) >= FIRST_WIN_11_BUILD: + if WINDOWS_BUILD_NUMBER >= FIRST_WIN_11_BUILD: self.fps_limit_spinbox.setFrame(False) self.default_similarity_threshold_spinbox.setFrame(False) self.default_delay_time_spinbox.setFrame(False) diff --git a/src/user_profile.py b/src/user_profile.py index dd90b694..52338d36 100644 --- a/src/user_profile.py +++ b/src/user_profile.py @@ -1,7 +1,6 @@ from __future__ import annotations import os -import sys from typing import TYPE_CHECKING, TypedDict, Union, cast import cv2 @@ -18,13 +17,10 @@ from hotkeys import HOTKEYS, set_hotkey from region_capture import Region from region_selection import create_windows_graphics_capture +from utils import auto_split_directory if TYPE_CHECKING: from AutoSplit import AutoSplit -# Keyword "frozen" is for setting basedir while in onefile mode in pyinstaller -FROZEN = hasattr(sys, "frozen") -# Get the directory of either AutoSplit.exe or AutoSplit.py -auto_split_directory = os.path.dirname(sys.executable if FROZEN else os.path.abspath(__file__)) class UserProfileDict(TypedDict): diff --git a/src/utils.py b/src/utils.py index fdbf05ea..5f9ca37f 100644 --- a/src/utils.py +++ b/src/utils.py @@ -1,5 +1,43 @@ -from typing import Union +import asyncio +import os +import sys +from collections.abc import Callable +from platform import version +from typing import Any, Optional, Union def decimal(value: Union[int, float]): return f"{int(value * 100) / 100:.2f}" + + +def is_digit(value: Optional[str]): + """ + Checks if `value` is a single-digit string from 0-9 + """ + if value is None: + return False + try: + return 0 <= int(value) <= 9 + except ValueError: + return False + + +def fire_and_forget(func: Callable[..., None]): + def wrapped(*args: Any, **kwargs: Any): + return asyncio.get_event_loop().run_in_executor(None, func, *args, *kwargs) + + return wrapped + + +# Environment specifics +WINDOWS_BUILD_NUMBER = int(version().split(".")[2]) +FIRST_WIN_11_BUILD = 22000 +"""AutoSplit Version number""" +FROZEN = hasattr(sys, "frozen") +"""Running from build made by PyInstaller""" +auto_split_directory = os.path.dirname(sys.executable if FROZEN else os.path.abspath(__file__)) +"""The directory of either AutoSplit.exe or AutoSplit.py""" + +# Shared strings +AUTOSPLIT_VERSION = "2.0.0-alpha.4" +START_AUTO_SPLITTER_TEXT = "Start Auto Splitter" From 33c46d439d6ed8d8b09093c1e748daf46a270862 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 25 Jun 2022 01:34:23 -0400 Subject: [PATCH 089/137] Better guards - Use win32gui.IsWindow for hwnd checks - is_valid_image TypeGuard --- scripts/requirements.txt | 1 + src/AutoSplit.py | 15 +++++++-------- src/AutoSplitImage.py | 5 +++-- src/compare.py | 8 +++++--- src/menu_bar.py | 5 +---- src/region_capture.py | 7 ++++--- src/region_selection.py | 11 ++++++----- src/split_parser.py | 3 ++- src/user_profile.py | 5 +---- src/utils.py | 11 +++++++++-- 10 files changed, 39 insertions(+), 32 deletions(-) diff --git a/scripts/requirements.txt b/scripts/requirements.txt index aab4b2c8..263c7a8d 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -26,6 +26,7 @@ toml winsdk>=v1.0.0b4 pygrabber git+https://github.com/ranchen421/D3DShot.git#egg=D3DShot # https://github.com/SerpentAI/D3DShot/issues/44 +typing-extensions # # Build PyInstaller diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 325d66fe..01198571 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -34,7 +34,7 @@ from split_parser import BELOW_FLAG, DUMMY_FLAG, PAUSE_FLAG, parse_and_validate_images from user_profile import DEFAULT_PROFILE from utils import (AUTOSPLIT_VERSION, FIRST_WIN_11_BUILD, FROZEN, START_AUTO_SPLITTER_TEXT, WINDOWS_BUILD_NUMBER, - auto_split_directory, decimal) + auto_split_directory, decimal, is_valid_image) from WindowsGraphicsCapture import WindowsGraphicsCapture CHECK_FPS_ITERATIONS = 10 @@ -250,7 +250,6 @@ def __live_image_function(self): self.live_image.clear() return # Set live image in UI - # if self.hwnd or self.windows_graphics_capture: capture, _ = capture_region(self) set_ui_image(self.live_image, capture, False) @@ -381,7 +380,7 @@ def __take_screenshot(self): # Grab screenshot of capture region capture, _ = capture_region(self) - if capture is None or not capture.size: + if not is_valid_image(capture): error_messages.region() return @@ -753,7 +752,7 @@ def __get_capture_for_comparison(self): # This most likely means we lost capture # (ie the captured window was closed, crashed, lost capture device, etc.) - if capture is None or not capture.size: + if not is_valid_image(capture): # Try to recover by using the window name if self.settings_dict["capture_method"] == CaptureMethod.VIDEO_CAPTURE_DEVICE: self.live_image.setText("Waiting for capture device...") @@ -761,7 +760,7 @@ def __get_capture_for_comparison(self): self.live_image.setText("Trying to recover window...") hwnd = win32gui.FindWindow(None, self.settings_dict["captured_window_title"]) # Don't fallback to desktop or whatever window obtained with "" - if hwnd and self.settings_dict["captured_window_title"]: + if win32gui.IsWindow(hwnd) and self.settings_dict["captured_window_title"]: self.hwnd = hwnd if self.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: if self.windows_graphics_capture: @@ -776,7 +775,7 @@ def __get_capture_for_comparison(self): capture, _ = capture_region(self) return (None - if capture is None or not capture.size + if not is_valid_image(capture) else cv2.resize(capture, COMPARISON_RESIZE, interpolation=cv2.INTER_NEAREST), is_old_image) @@ -817,7 +816,7 @@ def __update_split_image(self, specific_image: Optional[AutoSplitImage] = None): # Get split image self.split_image = specific_image or self.split_images_and_loop_number[0 + self.split_image_number][0] - if self.split_image.bytes is not None and self.split_image.bytes.size: + if is_valid_image(self.split_image.bytes): set_ui_image(self.current_split_image, self.split_image.bytes, True) self.current_image_file_label.setText(self.split_image.filename) @@ -859,7 +858,7 @@ def exit_program(): # 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" \ - if self.last_successfully_loaded_settings_file_path is None \ + if not self.last_successfully_loaded_settings_file_path \ else os.path.basename(self.last_successfully_loaded_settings_file_path) warning = QMessageBox.warning( diff --git a/src/AutoSplitImage.py b/src/AutoSplitImage.py index f2358553..2da283fc 100644 --- a/src/AutoSplitImage.py +++ b/src/AutoSplitImage.py @@ -10,6 +10,7 @@ import error_messages from compare import check_if_image_has_transparency, compare_histograms, compare_l2_norm, compare_phash +from utils import is_valid_image if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -102,7 +103,7 @@ def __init__(self, path: str): def __read_image_bytes(self, path: str): image = cv2.imread(path, cv2.IMREAD_UNCHANGED) - if image is None or not image.size: + if not is_valid_image(image): self.bytes = None error_messages.image_type(path) return @@ -131,7 +132,7 @@ def compare_with_capture( Compare image with capture using image's comparison method. Falls back to combobox """ - if self.bytes is None or not self.bytes.size or capture is None or not self.bytes.size: + if not is_valid_image(self.bytes) or not is_valid_image(capture): return 0.0 comparison_method = self.__get_comparison_method(default) if comparison_method == 0: diff --git a/src/compare.py b/src/compare.py index af2d94e6..44739d45 100644 --- a/src/compare.py +++ b/src/compare.py @@ -9,6 +9,8 @@ from PIL import Image from win32con import MAXBYTE +from utils import is_valid_image + MAXRANGE = MAXBYTE + 1 CHANNELS = [0, 1, 2] HISTOGRAM_SIZE = [8, 8, 8] @@ -49,7 +51,7 @@ def compare_l2_norm(source: cv2.Mat, capture: cv2.Mat, mask: Optional[cv2.Mat] = # The L2 Error is summed across all pixels, so this normalizes max_error = sqrt(source.size) * MAXBYTE \ - if mask is None or not mask.size\ + if not is_valid_image(mask)\ else sqrt(np.count_nonzero(mask) * MASK_SIZE_MULTIPLIER) if not max_error: @@ -75,7 +77,7 @@ def compare_template(source: cv2.Mat, capture: cv2.Mat, mask: Optional[cv2.Mat] # matchTemplate returns the sum of square differences, this is the max # that the value can be. Used for normalizing from 0 to 1. max_error = source.size * MAXBYTE * MAXBYTE \ - if mask is None or not mask.size \ + if not is_valid_image(mask) \ else np.count_nonzero(mask) return 1 - (min_val / max_error) @@ -96,7 +98,7 @@ def compare_phash(source: cv2.Mat, capture: cv2.Mat, mask: Optional[cv2.Mat] = N # each of the images. As a result of this, this function is not going to be very # helpful for large masks as the images when shrinked down to 8x8 will mostly be # the same - if mask is not None and mask.size: + if is_valid_image(mask): source = cv2.bitwise_and(source, source, mask=mask) capture = cv2.bitwise_and(capture, capture, mask=mask) diff --git a/src/menu_bar.py b/src/menu_bar.py index c36191a4..4b0c510e 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -15,7 +15,6 @@ import error_messages import user_profile -from AutoSplitImage import COMPARISON_RESIZE_HEIGHT, COMPARISON_RESIZE_WIDTH from CaptureMethod import CAPTURE_METHODS, CameraInfo, CaptureMethod, get_all_video_capture_devices from gen import about, design, resources_rc, settings as settings_ui, update_checker # noqa: F401 from hotkeys import HOTKEYS, Hotkeys, set_hotkey @@ -157,7 +156,7 @@ def __capture_method_changed(self): # Recover window from name hwnd = win32gui.FindWindow(None, self.autosplit.settings_dict["captured_window_title"]) # Don't fallback to desktop or whatever window obtained with "" - if hwnd and self.autosplit.settings_dict["captured_window_title"]: + if win32gui.IsWindow(hwnd) and self.autosplit.settings_dict["captured_window_title"]: self.autosplit.hwnd = hwnd if selected_capture_method == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: self.autosplit.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) @@ -176,8 +175,6 @@ def __capture_device_changed(self, current_capture_method: Optional[Union[Captur if current_capture_method == CaptureMethod.VIDEO_CAPTURE_DEVICE: self.autosplit.settings_dict["capture_device_name"] = capture_device.name self.autosplit.capture_device = cv2.VideoCapture(capture_device.device_id) - self.autosplit.capture_device.set(cv2.CAP_PROP_FRAME_WIDTH, COMPARISON_RESIZE_WIDTH) - self.autosplit.capture_device.set(cv2.CAP_PROP_FRAME_HEIGHT, COMPARISON_RESIZE_HEIGHT) return capture_device.device_id async def __set_all_capture_devices(self): diff --git a/src/region_capture.py b/src/region_capture.py index adac2dc5..266ec5f4 100644 --- a/src/region_capture.py +++ b/src/region_capture.py @@ -17,6 +17,7 @@ from winsdk.windows.graphics.imaging import BitmapBufferAccessMode, SoftwareBitmap from CaptureMethod import CaptureMethod +from utils import is_valid_image from WindowsGraphicsCapture import WindowsGraphicsCapture if TYPE_CHECKING: @@ -186,7 +187,7 @@ def capture_region(autosplit: AutoSplit) -> tuple[Optional[cv2.Mat], bool]: if capture_method == CaptureMethod.VIDEO_CAPTURE_DEVICE: return __camera_capture(autosplit.capture_device, selection), False - if not autosplit.hwnd: + if not win32gui.IsWindow(autosplit.hwnd): return None, False if capture_method == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: @@ -203,8 +204,8 @@ def capture_region(autosplit: AutoSplit) -> tuple[Optional[cv2.Mat], bool]: def set_ui_image(qlabel: QLabel, image: Optional[cv2.Mat], transparency: bool): - if image is None or not image.size: - # Clear current pixmap if image is None. But don't clear text + if not is_valid_image(image): + # Clear current pixmap if no image. But don't clear text if not qlabel.text(): qlabel.clear() else: diff --git a/src/region_selection.py b/src/region_selection.py index 03d86f1f..95e49a1c 100644 --- a/src/region_selection.py +++ b/src/region_selection.py @@ -20,6 +20,7 @@ import error_messages from CaptureMethod import CaptureMethod from region_capture import capture_region, get_window_bounds +from utils import is_valid_image from WindowsGraphicsCapture import create_windows_graphics_capture if TYPE_CHECKING: @@ -96,7 +97,7 @@ def select_region(autosplit: AutoSplit): hwnd, window_text = __get_window_from_point(x, y) # Don't select desktop - if not hwnd or not window_text: + if not win32gui.IsWindow(hwnd) or not window_text: error_messages.region() return @@ -132,7 +133,7 @@ def select_window(autosplit: AutoSplit): hwnd, window_text = __get_window_from_point(x, y) # Don't select desktop - if not hwnd or not window_text: + if not win32gui.IsWindow(hwnd) or not window_text: error_messages.region() return @@ -191,7 +192,7 @@ def align_region(autosplit: AutoSplit): template = cv2.imread(template_filename, cv2.IMREAD_COLOR) # Validate template is a valid image file - if template is None or not template.size: + if not is_valid_image(template): error_messages.align_region_image_type() return @@ -199,7 +200,7 @@ def align_region(autosplit: AutoSplit): # subregion being searched for to align the image. capture, _ = capture_region(autosplit) - if capture is None or not capture.size: + if not is_valid_image(capture): error_messages.region() return @@ -293,7 +294,7 @@ def check_selected_region_exists(autosplit: AutoSplit): return bool(autosplit.windows_graphics_capture) if autosplit.settings_dict["capture_method"] == CaptureMethod.VIDEO_CAPTURE_DEVICE: return bool(autosplit.capture_device) - return bool(autosplit.hwnd > 0 and win32gui.GetWindowText(autosplit.hwnd)) + return bool(win32gui.IsWindow(autosplit.hwnd) and win32gui.GetWindowText(autosplit.hwnd)) class BaseSelectWidget(QtWidgets.QWidget): diff --git a/src/split_parser.py b/src/split_parser.py index 705282de..e98a1eb6 100644 --- a/src/split_parser.py +++ b/src/split_parser.py @@ -5,6 +5,7 @@ import error_messages from AutoSplitImage import RESET_KEYWORD, START_KEYWORD, AutoSplitImage, ImageType +from utils import is_valid_image if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -187,7 +188,7 @@ def parse_and_validate_images(autosplit: AutoSplit): # according to all of the settings selected by the user. for image in autosplit.split_images: # Test for image without transparency - if image.bytes is None or not image.bytes.size: + if not is_valid_image(image.bytes): autosplit.gui_changes_on_reset() return False diff --git a/src/user_profile.py b/src/user_profile.py index 52338d36..7adf624c 100644 --- a/src/user_profile.py +++ b/src/user_profile.py @@ -11,7 +11,6 @@ from winsdk.windows.graphics.capture.interop import create_for_window import error_messages -from AutoSplitImage import COMPARISON_RESIZE_HEIGHT, COMPARISON_RESIZE_WIDTH from CaptureMethod import CAPTURE_METHODS, CaptureMethod from gen import design from hotkeys import HOTKEYS, set_hotkey @@ -137,8 +136,6 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str autosplit.select_region_button.setDisabled(True) autosplit.select_window_button.setDisabled(True) autosplit.capture_device = cv2.VideoCapture(autosplit.settings_dict["capture_device_id"]) - autosplit.capture_device.set(cv2.CAP_PROP_FRAME_WIDTH, COMPARISON_RESIZE_WIDTH) - autosplit.capture_device.set(cv2.CAP_PROP_FRAME_HEIGHT, COMPARISON_RESIZE_HEIGHT) keyboard.unhook_all() if not autosplit.is_auto_controlled: @@ -149,7 +146,7 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str if autosplit.settings_dict["captured_window_title"]: hwnd = win32gui.FindWindow(None, autosplit.settings_dict["captured_window_title"]) # Don't fallback to desktop or whatever window obtained with "" - if hwnd and autosplit.settings_dict["captured_window_title"]: + if win32gui.IsWindow(hwnd) and autosplit.settings_dict["captured_window_title"]: autosplit.hwnd = hwnd if autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: if autosplit.windows_graphics_capture: diff --git a/src/utils.py b/src/utils.py index 5f9ca37f..5bf75eaa 100644 --- a/src/utils.py +++ b/src/utils.py @@ -5,12 +5,15 @@ from platform import version from typing import Any, Optional, Union +import cv2 +from typing_extensions import TypeGuard + def decimal(value: Union[int, float]): return f"{int(value * 100) / 100:.2f}" -def is_digit(value: Optional[str]): +def is_digit(value: Optional[Union[str, int]]): """ Checks if `value` is a single-digit string from 0-9 """ @@ -18,10 +21,14 @@ def is_digit(value: Optional[str]): return False try: return 0 <= int(value) <= 9 - except ValueError: + except (ValueError, TypeError): return False +def is_valid_image(image: Optional[cv2.Mat]) -> TypeGuard[cv2.Mat]: + return image is not None and bool(image.size) + + def fire_and_forget(func: Callable[..., None]): def wrapped(*args: Any, **kwargs: Any): return asyncio.get_event_loop().run_in_executor(None, func, *args, *kwargs) From 37f3173687a9721fa2134f92e428849580d53558 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sun, 3 Jul 2022 17:27:30 -0400 Subject: [PATCH 090/137] Windows Graphics Capture border doc update --- README.md | 2 +- src/CaptureMethod.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a3febcb2..9a79ffcf 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,7 @@ This program can be used to automatically start, split, and reset your preferred Only available in Windows 10.0.17134 and up. Due to current technical limitations, it requires having at least one audio or video Capture Device connected and enabled. Even if it won't be used. Allows recording UWP apps, Hardware Accelerated and Exclusive Fullscreen windows. - Adds a yellow border on Windows 10. Not present on Windows 11. + Adds a yellow border on Windows 10 (not on Windows 11). Caps at around 60 FPS. - **Direct3D Desktop Duplication** (slower, bound to display) Duplicates the desktop using Direct3D. diff --git a/src/CaptureMethod.py b/src/CaptureMethod.py index 5d4dd974..e9d35be6 100644 --- a/src/CaptureMethod.py +++ b/src/CaptureMethod.py @@ -87,8 +87,8 @@ def get_method_by_index(self, index: int): f"\nOnly available in Windows 10.0.{WGC_MIN_BUILD} and up. " "\nDue to current technical limitations, it requires having at least one " "\naudio or video Capture Device connected and enabled. Even if it won't be used. " - "\nAdds a yellow border on Windows 10. Not present on Windows 11. " "\nAllows recording UWP apps, Hardware Accelerated and Exclusive Fullscreen windows. " + "\nAdds a yellow border on Windows 10 (not on Windows 11)." "\nCaps at around 60 FPS. " ), ), From 1e261f2e5a84314b5f04f896b46a1162e5021d46 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sun, 3 Jul 2022 17:47:44 -0400 Subject: [PATCH 091/137] temporarily disable auto reset --- res/design.ui | 31 +++++++++++++++++++++++++++++++ src/AutoSplit.py | 4 +++- 2 files changed, 34 insertions(+), 1 deletion(-) diff --git a/res/design.ui b/res/design.ui index b4f07175..0debb0ab 100644 --- a/res/design.ui +++ b/res/design.ui @@ -894,6 +894,35 @@ > + + + + 10 + 360 + 91 + 31 + + + + + + + + + + 30 + 360 + 71 + 31 + + + + Disable auto reset image + + + true + + x_label select_region_button start_auto_splitter_button @@ -930,6 +959,8 @@ image_loop_value_label previous_image_button next_image_button + disable_auto_reset_label + disable_auto_reset_checkbox diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 01198571..e52fb3ad 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -783,7 +783,9 @@ def __reset_if_should(self, capture: Optional[cv2.Mat]): """ Checks if we should reset, resets if it's the case, and returns the result """ - if self.reset_image: + if self.disable_auto_reset_checkbox.isChecked(): + self.table_reset_image_live_label.setText("disabled") + elif self.reset_image: similarity = self.reset_image.compare_with_capture(self, capture) threshold = self.reset_image.get_similarity_threshold(self) From 1c2b3fc7bb2bf3da681bd59c6516522e098f4b36 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sun, 3 Jul 2022 18:00:03 -0400 Subject: [PATCH 092/137] Update codeql-action to v2 --- .github/workflows/codeql-analysis.yml | 6 +++--- src/CaptureMethod.py | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index f74d7190..55844c5a 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -39,7 +39,7 @@ jobs: # Initializes the CodeQL tools for scanning. - name: Initialize CodeQL - uses: github/codeql-action/init@v1 + uses: github/codeql-action/init@v2 with: languages: ${{ matrix.language }} # If you wish to specify custom queries, you can do so here or in a config file. @@ -50,7 +50,7 @@ jobs: # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). # If this step fails, then you should remove it and run the build manually (see below) - name: Autobuild - uses: github/codeql-action/autobuild@v1 + uses: github/codeql-action/autobuild@v2 # ℹī¸ Command-line programs to run using the OS shell. # 📚 https://git.io/JvXDl @@ -64,4 +64,4 @@ jobs: # make release - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v1 + uses: github/codeql-action/analyze@v2 diff --git a/src/CaptureMethod.py b/src/CaptureMethod.py index e9d35be6..e8f28ace 100644 --- a/src/CaptureMethod.py +++ b/src/CaptureMethod.py @@ -135,7 +135,7 @@ def get_method_by_index(self, index: int): CAPTURE_METHODS.pop(CaptureMethod.WINDOWS_GRAPHICS_CAPTURE) -@ dataclass +@dataclass class CameraInfo(): device_id: int name: str From 10c74d9a77fa0cbad307954a7584524d6832c62c Mon Sep 17 00:00:00 2001 From: Avasam Date: Sun, 3 Jul 2022 18:19:19 -0400 Subject: [PATCH 093/137] . --- res/design.ui | 20 ++------------------ 1 file changed, 2 insertions(+), 18 deletions(-) diff --git a/res/design.ui b/res/design.ui index 0debb0ab..18faeb78 100644 --- a/res/design.ui +++ b/res/design.ui @@ -904,23 +904,8 @@ - - - - - - - 30 - 360 - 71 - 31 - - - - Disable auto reset image - - - true + Disable auto +reset image x_label @@ -959,7 +944,6 @@ image_loop_value_label previous_image_button next_image_button - disable_auto_reset_label disable_auto_reset_checkbox From c0068268005512422c75725e3285922fa57111ff Mon Sep 17 00:00:00 2001 From: Avasam Date: Tue, 12 Jul 2022 16:09:53 -0400 Subject: [PATCH 094/137] Updated Scripts to OS agnostic powershell --- .github/workflows/lint-and-build.yml | 10 +++++----- .vscode/settings.json | 7 +++++++ .vscode/tasks.json | 2 +- README.md | 8 ++++---- scripts/build.bat | 8 -------- scripts/build.ps1 | 15 +++++++++++++++ scripts/compile_resources.bat | 9 --------- scripts/compile_resources.ps1 | 12 ++++++++++++ scripts/designer.bat | 0 scripts/install.bat | 5 ----- scripts/install.ps1 | 9 +++++++++ scripts/lint.ps1 | 20 ++++++++++++-------- scripts/requirements.txt | 13 +++++++------ scripts/start.bat | 2 -- scripts/start.ps1 | 3 +++ 15 files changed, 75 insertions(+), 48 deletions(-) delete mode 100644 scripts/build.bat create mode 100755 scripts/build.ps1 delete mode 100644 scripts/compile_resources.bat create mode 100755 scripts/compile_resources.ps1 mode change 100644 => 100755 scripts/designer.bat delete mode 100644 scripts/install.bat create mode 100755 scripts/install.ps1 mode change 100644 => 100755 scripts/lint.ps1 delete mode 100644 scripts/start.bat create mode 100755 scripts/start.ps1 diff --git a/.github/workflows/lint-and-build.yml b/.github/workflows/lint-and-build.yml index 6630a9c7..8f4f48f7 100644 --- a/.github/workflows/lint-and-build.yml +++ b/.github/workflows/lint-and-build.yml @@ -43,7 +43,7 @@ jobs: pip install -r "scripts/requirements-dev.txt" npm install -g pyright npm list -g pyright - - run: scripts/compile_resources.bat + - run: scripts/compile_resources.ps1 - name: Analysing the code with Pyright run: pyright --warnings Pylint: @@ -63,7 +63,7 @@ jobs: cache-dependency-path: 'scripts/requirements-dev.txt' - name: Install dependencies run: pip install -r "scripts/requirements-dev.txt" - - run: scripts/compile_resources.bat + - run: scripts/compile_resources.ps1 - name: Analysing the code with Pylint run: pylint --reports=y --output-format=colorized src/ Flake8: @@ -83,7 +83,7 @@ jobs: cache-dependency-path: 'scripts/requirements-dev.txt' - name: Install dependencies run: pip install -r "scripts/requirements-dev.txt" - - run: scripts/compile_resources.bat + - run: scripts/compile_resources.ps1 - name: Analysing the code with Flake8 run: flake8 Bandit: @@ -103,7 +103,7 @@ jobs: cache-dependency-path: 'scripts/requirements-dev.txt' - name: Install dependencies run: pip install -r "scripts/requirements-dev.txt" - - run: scripts/compile_resources.bat + - run: scripts/compile_resources.ps1 - name: Analysing the code with Bandit run: bandit -n 1 --severity-level medium --recursive src Build: @@ -122,7 +122,7 @@ jobs: cache: 'pip' - name: Install dependencies run: pip install -r "scripts/requirements.txt" - - run: scripts/build.bat + - run: scripts/build.ps1 - name: Upload Build Artifact uses: actions/upload-artifact@v3 with: diff --git a/.vscode/settings.json b/.vscode/settings.json index a4a19fd0..c249f12c 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -77,4 +77,11 @@ // Just another wrapper, use Flake8 OR this "python.linting.pylamaEnabled": false, "python.linting.banditEnabled": true, + "powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationForFirstPipeline", + "powershell.codeFormatting.autoCorrectAliases": true, + "powershell.codeFormatting.trimWhitespaceAroundPipe": true, + "powershell.codeFormatting.useConstantStrings": true, + "powershell.codeFormatting.useCorrectCasing": true, + "powershell.codeFormatting.whitespaceBetweenParameters": true, + "powershell.integratedConsole.showOnStartup": false, } diff --git a/.vscode/tasks.json b/.vscode/tasks.json index 4ac48ed7..26a9e03d 100644 --- a/.vscode/tasks.json +++ b/.vscode/tasks.json @@ -4,7 +4,7 @@ { "label": "Build AutoSplit", "type": "shell", - "command": "scripts/build.bat", + "command": "scripts/build.ps1", "group": { "kind": "build", "isDefault": true diff --git a/README.md b/README.md index 9a79ffcf..618fc23d 100644 --- a/README.md +++ b/README.md @@ -32,10 +32,10 @@ This program can be used to automatically start, split, and reset your preferred - Microsoft Visual C++ 14.0 or greater may be required to build the executable. Get it with [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/). - Node is optional, but required for complete linting (using Pyright). - Read [requirements.txt](/scripts/requirements.txt) for more information on how to install, run and build the python code. - - Run `.\scripts\install.bat` to install all dependencies. - - Run the app directly with `.\scripts\start.bat [--auto-controlled]`. - - Run `.\scripts\build.bat` to build an executable. -- Recompile resources after modifications by running `.\scripts\compile_resources.bat`. + - Run `./scripts/install.ps1` to install all dependencies. + - Run the app directly with `./scripts/start.ps1 [--auto-controlled]`. + - Run `./scripts/build.ps1` to build an executable. +- Recompile resources after modifications by running `./scripts/compile_resources.ps1`. - All configured for VSCode, including Run (F5) and Build (Ctrl+Shift+B) commands. ## OPTIONS diff --git a/scripts/build.bat b/scripts/build.bat deleted file mode 100644 index b9469fff..00000000 --- a/scripts/build.bat +++ /dev/null @@ -1,8 +0,0 @@ -CALL "%~p0compile_resources.bat" -pyinstaller ^ - --windowed ^ - --onefile ^ - --additional-hooks-dir=Pyinstaller\hooks ^ - --icon=res\icon.ico ^ - --splash=res\splash.png ^ - "%~p0..\src\AutoSplit.py" diff --git a/scripts/build.ps1 b/scripts/build.ps1 new file mode 100755 index 00000000..59b22626 --- /dev/null +++ b/scripts/build.ps1 @@ -0,0 +1,15 @@ +& "$PSScriptRoot/compile_resources.ps1" +pyinstaller ` + --windowed ` + --onefile ` + --additional-hooks-dir=Pyinstaller/hooks ` + --icon=res/icon.ico ` + --splash=res/splash.png ` + "$PSScriptRoot/../src/AutoSplit.py" + +If ($IsLinux) { + Move-Item $PSScriptRoot/../dist/AutoSplit $PSScriptRoot/../dist/AutoSplit.elf + If ($LastExitCode -eq 0) { + Write-Host 'Added .elf extension' + } +} diff --git a/scripts/compile_resources.bat b/scripts/compile_resources.bat deleted file mode 100644 index ba578623..00000000 --- a/scripts/compile_resources.bat +++ /dev/null @@ -1,9 +0,0 @@ -cd "%~dp0.." -@ if not exist .\src\gen ( - md .\src\gen -) -pyuic6 ".\res\about.ui" -o ".\src\gen\about.py" -pyuic6 ".\res\design.ui" -o ".\src\gen\design.py" -pyuic6 ".\res\settings.ui" -o ".\src\gen\settings.py" -pyuic6 ".\res\update_checker.ui" -o ".\src\gen\update_checker.py" -pyside6-rcc ".\res\resources.qrc" -o ".\src\gen\resources_rc.py" diff --git a/scripts/compile_resources.ps1 b/scripts/compile_resources.ps1 new file mode 100755 index 00000000..6495dd33 --- /dev/null +++ b/scripts/compile_resources.ps1 @@ -0,0 +1,12 @@ +$originalDirectory = $pwd +Set-Location "$PSScriptRoot/.." + +New-Item -Force -ItemType directory ./src/gen | Out-Null +pyuic6 './res/about.ui' -o './src/gen/about.py' +pyuic6 './res/design.ui' -o './src/gen/design.py' +pyuic6 './res/settings.ui' -o './src/gen/settings.py' +pyuic6 './res/update_checker.ui' -o './src/gen/update_checker.py' +pyside6-rcc './res/resources.qrc' -o './src/gen/resources_rc.py' +Write-Host 'Generated code from .ui files' + +Set-Location $originalDirectory diff --git a/scripts/designer.bat b/scripts/designer.bat old mode 100644 new mode 100755 diff --git a/scripts/install.bat b/scripts/install.bat deleted file mode 100644 index 8f7f45e4..00000000 --- a/scripts/install.bat +++ /dev/null @@ -1,5 +0,0 @@ -py -m pip install wheel --upgrade -py -m pip install -r "%~p0requirements-dev.txt" -CALL "%~p0compile_resources.bat" -CALL npm install -g pyright@latest -CALL npm list -g pyright diff --git a/scripts/install.ps1 b/scripts/install.ps1 new file mode 100755 index 00000000..e741c3d5 --- /dev/null +++ b/scripts/install.ps1 @@ -0,0 +1,9 @@ +If ($IsLinux) { + sudo apt-get install python3-tk +} + +python -m pip install wheel --upgrade +python -m pip install -r "$PSScriptRoot/requirements-dev.txt" +& "$PSScriptRoot/compile_resources.ps1" +npm install -g pyright@latest +npm list -g pyright diff --git a/scripts/lint.ps1 b/scripts/lint.ps1 old mode 100644 new mode 100755 index e11bbd86..29ef583c --- a/scripts/lint.ps1 +++ b/scripts/lint.ps1 @@ -1,6 +1,5 @@ $originalDirectory = $pwd -cd "$PSScriptRoot\.." -Write-Host $Script:MyInvocation.MyCommand.Path +Set-Location "$PSScriptRoot/.." $exitCodes = 0 Write-Host "`nRunning Pyright..." @@ -8,7 +7,8 @@ pyright --warnings $exitCodes += $LastExitCode if ($LastExitCode -gt 0) { Write-Host "`Pyright failed ($LastExitCode)" -ForegroundColor Red -} else { +} +else { Write-Host "`Pyright passed" -ForegroundColor Green } @@ -17,7 +17,8 @@ pylint --output-format=colorized src/ $exitCodes += $LastExitCode if ($LastExitCode -gt 0) { Write-Host "`Pylint failed ($LastExitCode)" -ForegroundColor Red -} else { +} +else { Write-Host "`Pylint passed" -ForegroundColor Green } @@ -26,7 +27,8 @@ flake8 $exitCodes += $LastExitCode if ($LastExitCode -gt 0) { Write-Host "`Flake8 failed ($LastExitCode)" -ForegroundColor Red -} else { +} +else { Write-Host "`Flake8 passed" -ForegroundColor Green } @@ -35,15 +37,17 @@ bandit -f custom --silent --recursive src # $exitCodes += $LastExitCode # Returns 1 on low if ($LastExitCode -gt 0) { Write-Host "`Bandit warning ($LastExitCode)" -ForegroundColor Yellow -} else { +} +else { Write-Host "`Bandit passed" -ForegroundColor Green } if ($exitCodes -gt 0) { Write-Host "`nLinting failed ($exitCodes)" -ForegroundColor Red -} else { +} +else { Write-Host "`nLinting passed" -ForegroundColor Green } -cd $originalDirectory +Set-Location $originalDirectory diff --git a/scripts/requirements.txt b/scripts/requirements.txt index 263c7a8d..154105c9 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -2,12 +2,12 @@ # # Python: CPython 3.9+ # -# Usage: .\scripts\install.bat +# Usage: ./scripts/install.ps1 # # If you're having issues with the libraries, you might want to first run: -# pip uninstall -y -r .\scripts\requirements-dev.txt +# pip uninstall -y -r ./scripts/requirements-dev.txt # -# Creating AutoSplit.exe with PyInstaller: .\scripts\build.bat +# Creating AutoSplit.exe with PyInstaller: ./scripts/build.ps1 # # Dependencies: numpy>=1.22.0rc1,<1.23 # Type issue @@ -19,14 +19,15 @@ keyboard packaging Pillow pyautogui -pywin32>=301 requests certifi toml -winsdk>=v1.0.0b4 pygrabber -git+https://github.com/ranchen421/D3DShot.git#egg=D3DShot # https://github.com/SerpentAI/D3DShot/issues/44 typing-extensions +# Windows-only +pywin32>=301 +winsdk>=v1.0.0b4 +git+https://github.com/ranchen421/D3DShot.git#egg=D3DShot # https://github.com/SerpentAI/D3DShot/issues/44 # # Build PyInstaller diff --git a/scripts/start.bat b/scripts/start.bat deleted file mode 100644 index cd894a28..00000000 --- a/scripts/start.bat +++ /dev/null @@ -1,2 +0,0 @@ -CALL "%~p0compile_resources.bat" -py -3.9 "%~p0..\src\AutoSplit.py" %* diff --git a/scripts/start.ps1 b/scripts/start.ps1 new file mode 100755 index 00000000..70d6fd8b --- /dev/null +++ b/scripts/start.ps1 @@ -0,0 +1,3 @@ +param ([string]$p1) +& "$PSScriptRoot/compile_resources.ps1" +python "$PSScriptRoot/../src/AutoSplit.py" $p1 From e55547915da488fc87340978d04a3ae8f8cfe415 Mon Sep 17 00:00:00 2001 From: Avasam Date: Tue, 12 Jul 2022 23:25:01 -0400 Subject: [PATCH 095/137] Abstracted all capture methods to its own module --- pyproject.toml | 2 + src/AutoSplit.py | 68 +++--- src/WindowsGraphicsCapture.py | 61 ----- src/capture_method/BitBltCaptureMethod.py | 84 +++++++ .../DesktopDuplicationCaptureMethod.py | 42 ++++ .../ForceFullContentRenderingCaptureMethod.py | 5 + .../VideoCaptureDeviceCaptureMethod.py | 41 ++++ .../WindowsGraphicsCaptureMethod.py | 139 +++++++++++ .../__init__.py} | 75 ++++-- src/capture_method/interface.py | 35 +++ src/menu_bar.py | 57 ++--- src/region_capture.py | 225 ------------------ src/region_selection.py | 34 +-- src/user_profile.py | 36 +-- src/utils.py | 23 +- typings/cv2-stubs/__init__.pyi | 6 +- 16 files changed, 500 insertions(+), 433 deletions(-) delete mode 100644 src/WindowsGraphicsCapture.py create mode 100644 src/capture_method/BitBltCaptureMethod.py create mode 100644 src/capture_method/DesktopDuplicationCaptureMethod.py create mode 100644 src/capture_method/ForceFullContentRenderingCaptureMethod.py create mode 100644 src/capture_method/VideoCaptureDeviceCaptureMethod.py create mode 100644 src/capture_method/WindowsGraphicsCaptureMethod.py rename src/{CaptureMethod.py => capture_method/__init__.py} (71%) create mode 100644 src/capture_method/interface.py delete mode 100644 src/region_capture.py diff --git a/pyproject.toml b/pyproject.toml index e35ac2b2..48643933 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -121,6 +121,8 @@ disable = [ "unused-import", # Similar lines in 2 files, doesn't really work "R0801", + # Doesn't work with local imports + "import-error", # False positives with PyQt .connect "no-value-for-parameter", # Not as long as we support Python 3.9 diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 01198571..339292cd 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -15,27 +15,22 @@ import cv2 from PyQt6 import QtCore, QtGui from PyQt6.QtTest import QTest -from PyQt6.QtWidgets import QApplication, QFileDialog, QMainWindow, QMessageBox, QWidget -from win32 import win32gui -from winsdk.windows.graphics.capture.interop import create_for_window +from PyQt6.QtWidgets import QApplication, QFileDialog, QLabel, QMainWindow, QMessageBox, QWidget import error_messages import user_profile from AutoControlledWorker import AutoControlledWorker from AutoSplitImage import COMPARISON_RESIZE, START_KEYWORD, AutoSplitImage, ImageType -from CaptureMethod import CaptureMethod +from capture_method import CaptureMethodEnum, CaptureMethodInterface from gen import about, design, settings, update_checker from hotkeys import HOTKEYS, after_setting_hotkey, send_command from menu_bar import (check_for_updates, get_default_settings_from_ui, open_about, open_settings, open_update_checker, view_help) -from region_capture import capture_region, set_ui_image -from region_selection import (align_region, create_windows_graphics_capture, select_region, select_window, - validate_before_parsing) +from region_selection import align_region, select_region, select_window, validate_before_parsing from split_parser import BELOW_FLAG, DUMMY_FLAG, PAUSE_FLAG, parse_and_validate_images from user_profile import DEFAULT_PROFILE from utils import (AUTOSPLIT_VERSION, FIRST_WIN_11_BUILD, FROZEN, START_AUTO_SPLITTER_TEXT, WINDOWS_BUILD_NUMBER, auto_split_directory, decimal, is_valid_image) -from WindowsGraphicsCapture import WindowsGraphicsCapture CHECK_FPS_ITERATIONS = 10 @@ -83,12 +78,12 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): # Initialize a few attributes hwnd = 0 """Window Handle used for Capture Region""" - windows_graphics_capture: Optional[WindowsGraphicsCapture] = None last_saved_settings = DEFAULT_PROFILE similarity = 0.0 split_image_number = 0 split_images_and_loop_number: list[tuple[AutoSplitImage, int]] = [] split_groups: list[list[int]] = [] + capture_method = CaptureMethodInterface() # Last loaded settings empty and last successful loaded settings file path to None until we try to load them last_loaded_settings = DEFAULT_PROFILE @@ -108,7 +103,6 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): reset_image: Optional[AutoSplitImage] = None split_images: list[AutoSplitImage] = [] split_image: Optional[AutoSplitImage] = None - capture_device: Optional[cv2.VideoCapture] = None update_auto_control: Optional[QtCore.QThread] = None def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-many-statements @@ -243,15 +237,15 @@ def __browse(self): def __live_image_function(self): capture_region_window_label = self.settings_dict["capture_device_name"] \ - if self.settings_dict["capture_method"] == CaptureMethod.VIDEO_CAPTURE_DEVICE \ + if self.settings_dict["capture_method"] == CaptureMethodEnum.VIDEO_CAPTURE_DEVICE \ else self.settings_dict["captured_window_title"] self.capture_region_window_label.setText(capture_region_window_label) if not (self.settings_dict["live_capture_region"] and capture_region_window_label): self.live_image.clear() return # Set live image in UI - capture, _ = capture_region(self) - set_ui_image(self.live_image, capture, False) + capture, _ = self.capture_method.get_frame(self) + set_preview_image(self.live_image, capture, False) def __load_start_image(self, started_by_button: bool = False, wait_for_delay: bool = True): """ @@ -379,7 +373,7 @@ def __take_screenshot(self): screenshot_index += 1 # Grab screenshot of capture region - capture, _ = capture_region(self) + capture, _ = self.capture_method.get_frame(self) if not is_valid_image(capture): error_messages.region() return @@ -748,31 +742,19 @@ def __get_capture_for_comparison(self): """ Grab capture region and resize for comparison """ - capture, is_old_image = capture_region(self) + capture, is_old_image = self.capture_method.get_frame(self) # This most likely means we lost capture # (ie the captured window was closed, crashed, lost capture device, etc.) if not is_valid_image(capture): # Try to recover by using the window name - if self.settings_dict["capture_method"] == CaptureMethod.VIDEO_CAPTURE_DEVICE: + if self.settings_dict["capture_method"] == CaptureMethodEnum.VIDEO_CAPTURE_DEVICE: self.live_image.setText("Waiting for capture device...") else: self.live_image.setText("Trying to recover window...") - hwnd = win32gui.FindWindow(None, self.settings_dict["captured_window_title"]) - # Don't fallback to desktop or whatever window obtained with "" - if win32gui.IsWindow(hwnd) and self.settings_dict["captured_window_title"]: - self.hwnd = hwnd - if self.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: - if self.windows_graphics_capture: - self.windows_graphics_capture.close() - try: - self.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) - # Unrecordable hwnd found as the game is crashing - except OSError as exception: - if str(exception).endswith("The parameter is incorrect"): - return None, is_old_image - raise - capture, _ = capture_region(self) + recovered = self.capture_method.recover_window(self.settings_dict["captured_window_title"], self) + if recovered: + capture, _ = self.capture_method.get_frame(self) return (None if not is_valid_image(capture) @@ -817,7 +799,7 @@ def __update_split_image(self, specific_image: Optional[AutoSplitImage] = None): # Get split image self.split_image = specific_image or self.split_images_and_loop_number[0 + self.split_image_number][0] if is_valid_image(self.split_image.bytes): - set_ui_image(self.current_split_image, self.split_image.bytes, True) + set_preview_image(self.current_split_image, self.split_image.bytes, True) self.current_image_file_label.setText(self.split_image.filename) self.table_current_image_threshold_label.setText(decimal(self.split_image.get_similarity_threshold(self))) @@ -880,6 +862,28 @@ def exit_program(): exit_program() +def set_preview_image(qlabel: QLabel, image: Optional[cv2.Mat], transparency: bool): + if not is_valid_image(image): + # Clear current pixmap if no image. But don't clear text + if not qlabel.text(): + qlabel.clear() + else: + if transparency: + color_code = cv2.COLOR_BGRA2RGBA + image_format = QtGui.QImage.Format.Format_RGBA8888 + else: + color_code = cv2.COLOR_BGRA2BGR + image_format = QtGui.QImage.Format.Format_BGR888 + + capture = cv2.cvtColor(image, color_code) + height, width, channels = capture.shape + qimage = QtGui.QImage(capture.data, width, height, width * channels, image_format) + qlabel.setPixmap(QtGui.QPixmap(qimage).scaled( + qlabel.size(), + QtCore.Qt.AspectRatioMode.IgnoreAspectRatio, + QtCore.Qt.TransformationMode.SmoothTransformation)) + + def seconds_remaining_text(seconds: float): return f"{seconds:.1f} second{'' if 0 < seconds <= 1 else 's'} remaining" diff --git a/src/WindowsGraphicsCapture.py b/src/WindowsGraphicsCapture.py deleted file mode 100644 index 0447b6b2..00000000 --- a/src/WindowsGraphicsCapture.py +++ /dev/null @@ -1,61 +0,0 @@ -import asyncio -from dataclasses import dataclass -from typing import Optional - -import cv2 -from winsdk.windows.graphics import SizeInt32 -from winsdk.windows.graphics.capture import Direct3D11CaptureFramePool, GraphicsCaptureItem, GraphicsCaptureSession -from winsdk.windows.graphics.directx import DirectXPixelFormat -from winsdk.windows.media.capture import MediaCapture - -from utils import WINDOWS_BUILD_NUMBER - -WGC_NO_BORDER_MIN_BUILD = 20348 - - -@dataclass -class WindowsGraphicsCapture: - size: SizeInt32 - frame_pool: Direct3D11CaptureFramePool - # Prevent session from being garbage collected - session: GraphicsCaptureSession - last_captured_frame: Optional[cv2.Mat] - - def close(self): - self.frame_pool.close() - try: - self.session.close() - except OSError: - # OSError: The application called an interface that was marshalled for a different thread - # This still seems to close the session and prevent the following hard crash in LiveSplit - # pylint: disable=line-too-long - # "AutoSplit.exe " # noqa: E501 - pass - - -def create_windows_graphics_capture(item: GraphicsCaptureItem): - # Note: Must create in the same thread (can't use a global) otherwise when ran from LiveSplit it will raise: - # OSError: The application called an interface that was marshalled for a different thread - media_capture = MediaCapture() - - async def coroutine(): - await (media_capture.initialize_async() or asyncio.sleep(0)) - asyncio.run(coroutine()) - - if not media_capture.media_capture_settings: - raise OSError("Unable to initialize a Direct3D Device.") - frame_pool = Direct3D11CaptureFramePool.create_free_threaded( - media_capture.media_capture_settings.direct3_d11_device, - DirectXPixelFormat.B8_G8_R8_A8_UINT_NORMALIZED, - 1, - item.size) - if not frame_pool: - raise OSError("Unable to create a frame pool for a capture session.") - session = frame_pool.create_capture_session(item) - if not session: - raise OSError("Unable to create a capture session.") - session.is_cursor_capture_enabled = False - if WINDOWS_BUILD_NUMBER >= WGC_NO_BORDER_MIN_BUILD: - session.is_border_required = False - session.start_capture() - return WindowsGraphicsCapture(item.size, frame_pool, session, None) diff --git a/src/capture_method/BitBltCaptureMethod.py b/src/capture_method/BitBltCaptureMethod.py new file mode 100644 index 00000000..b292e9e1 --- /dev/null +++ b/src/capture_method/BitBltCaptureMethod.py @@ -0,0 +1,84 @@ +from __future__ import annotations + +import ctypes +import ctypes.wintypes +from typing import TYPE_CHECKING, Optional, cast + +import cv2 +import numpy as np +import pywintypes +import win32con +import win32ui +from win32 import win32gui + +from capture_method.interface import CaptureMethodInterface +from utils import get_window_bounds + +if TYPE_CHECKING: + from AutoSplit import AutoSplit + +# This is an undocumented nFlag value for PrintWindow +PW_RENDERFULLCONTENT = 0x00000002 + + +class BitBltCaptureMethod(CaptureMethodInterface): + _render_full_content = False + + def close(self, autosplit: AutoSplit): + pass + + def get_frame(self, autosplit: AutoSplit): + selection = autosplit.settings_dict["capture_region"] + hwnd = autosplit.hwnd + image: Optional[cv2.Mat] = None + if not self.check_selected_region_exists(autosplit): + return None, False + + # If the window closes while it's being manipulated, it could cause a crash + try: + window_dc = win32gui.GetWindowDC(hwnd) + dc_object = win32ui.CreateDCFromHandle(window_dc) + + # Causes a 10-15x performance drop. But allows recording hardware accelerated windows + if self._render_full_content: + ctypes.windll.user32.PrintWindow(hwnd, dc_object.GetSafeHdc(), PW_RENDERFULLCONTENT) + + # On Windows there is a shadow around the windows that we need to account for. + left_bounds, top_bounds, *_ = get_window_bounds(hwnd) + + compatible_dc = dc_object.CreateCompatibleDC() + bitmap = win32ui.CreateBitmap() + bitmap.CreateCompatibleBitmap(dc_object, selection["width"], selection["height"]) + compatible_dc.SelectObject(bitmap) + compatible_dc.BitBlt( + (0, 0), + (selection["width"], selection["height"]), + dc_object, + (selection["x"] + left_bounds, selection["y"] + top_bounds), + win32con.SRCCOPY) + image = np.frombuffer(cast(bytes, bitmap.GetBitmapBits(True)), dtype=np.uint8) + image.shape = (selection["height"], selection["width"], 4) + # https://github.com/kaluluosi/pywin32-stubs/issues/5 + except (win32ui.error, pywintypes.error): # pyright: ignore [reportGeneralTypeIssues] pylint: disable=no-member + return None, False + # We already obtained the image, so we can ignore errors during cleanup + try: + dc_object.DeleteDC() + compatible_dc.DeleteDC() + win32gui.ReleaseDC(hwnd, window_dc) + win32gui.DeleteObject(bitmap.GetHandle()) # pyright: ignore [reportGeneralTypeIssues] + # https://github.com/kaluluosi/pywin32-stubs/issues/5 + except win32ui.error: # pyright: ignore [reportGeneralTypeIssues] + pass + return image, False + + def recover_window(self, captured_window_title: str, autosplit: AutoSplit): + hwnd = win32gui.FindWindow(None, captured_window_title) + # Don't fallback to desktop or whatever window obtained with "" + if not win32gui.IsWindow(hwnd) or not captured_window_title: + return False + autosplit.hwnd = hwnd + return self.check_selected_region_exists(autosplit) + + def check_selected_region_exists(self, autosplit: AutoSplit): + return bool(win32gui.IsWindow(autosplit.hwnd) and win32gui.GetWindowText(autosplit.hwnd)) diff --git a/src/capture_method/DesktopDuplicationCaptureMethod.py b/src/capture_method/DesktopDuplicationCaptureMethod.py new file mode 100644 index 00000000..fd216d3e --- /dev/null +++ b/src/capture_method/DesktopDuplicationCaptureMethod.py @@ -0,0 +1,42 @@ +from __future__ import annotations + +import ctypes +import ctypes.wintypes +from typing import TYPE_CHECKING + +import cv2 +import d3dshot +import win32con +from win32 import win32gui + +from capture_method.BitBltCaptureMethod import BitBltCaptureMethod +from utils import get_window_bounds + +if TYPE_CHECKING: + from AutoSplit import AutoSplit + +desktop_duplication = d3dshot.create(capture_output="numpy") + + +class DesktopDuplicationCaptureMethod(BitBltCaptureMethod): # pylint: disable=too-few-public-methods + def get_frame(self, autosplit: AutoSplit): + selection = autosplit.settings_dict["capture_region"] + hwnd = autosplit.hwnd + hmonitor = ctypes.windll.user32.MonitorFromWindow(hwnd, win32con.MONITOR_DEFAULTTONEAREST) + if not hmonitor or not win32gui.IsWindow(hwnd): + return None, False + + left_bounds, top_bounds, *_ = get_window_bounds(hwnd) + desktop_duplication.display = [ + display for display + in desktop_duplication.displays + if display.hmonitor == hmonitor][0] + offset_x, offset_y, *_ = win32gui.GetWindowRect(hwnd) + offset_x -= desktop_duplication.display.position["left"] + offset_y -= desktop_duplication.display.position["top"] + left = selection["x"] + offset_x + left_bounds + top = selection["y"] + offset_y + top_bounds + right = selection["width"] + left + bottom = selection["height"] + top + screenshot = desktop_duplication.screenshot((left, top, right, bottom)) + return cv2.cvtColor(screenshot, cv2.COLOR_RGBA2BGRA), False diff --git a/src/capture_method/ForceFullContentRenderingCaptureMethod.py b/src/capture_method/ForceFullContentRenderingCaptureMethod.py new file mode 100644 index 00000000..ea2acd76 --- /dev/null +++ b/src/capture_method/ForceFullContentRenderingCaptureMethod.py @@ -0,0 +1,5 @@ +from capture_method.BitBltCaptureMethod import BitBltCaptureMethod + + +class ForceFullContentRenderingCaptureMethod(BitBltCaptureMethod): # pylint: disable=too-few-public-methods + _render_full_content = True diff --git a/src/capture_method/VideoCaptureDeviceCaptureMethod.py b/src/capture_method/VideoCaptureDeviceCaptureMethod.py new file mode 100644 index 00000000..927ebd2c --- /dev/null +++ b/src/capture_method/VideoCaptureDeviceCaptureMethod.py @@ -0,0 +1,41 @@ +from __future__ import annotations + +from typing import TYPE_CHECKING + +import cv2 + +from capture_method.interface import CaptureMethodInterface + +if TYPE_CHECKING: + from AutoSplit import AutoSplit + + +class VideoCaptureDeviceCaptureMethod(CaptureMethodInterface): # pylint: disable=too-few-public-methods + capture_device: cv2.VideoCapture + + def __init__(self, autosplit: AutoSplit): + super().__init__() + self.capture_device = cv2.VideoCapture(autosplit.settings_dict["capture_device_id"]) + self.capture_device.setExceptionMode(True) + + def close(self, autosplit: AutoSplit): + self.capture_device.release() + + def get_frame(self, autosplit: AutoSplit): + selection = autosplit.settings_dict["capture_region"] + if not self.check_selected_region_exists(autosplit): + return None, False + result, image = self.capture_device.read() + if not result: + return None, False + # Ensure we can't go OOB of the image + y = min(selection["y"], image.shape[0] - 1) + x = min(selection["x"], image.shape[1] - 1) + image = image[ + y:y + selection["height"], + x:x + selection["width"], + ] + return cv2.cvtColor(image, cv2.COLOR_BGR2BGRA), False + + def check_selected_region_exists(self, autosplit: AutoSplit): + return bool(self.capture_device.isOpened()) diff --git a/src/capture_method/WindowsGraphicsCaptureMethod.py b/src/capture_method/WindowsGraphicsCaptureMethod.py new file mode 100644 index 00000000..5e9bbe9e --- /dev/null +++ b/src/capture_method/WindowsGraphicsCaptureMethod.py @@ -0,0 +1,139 @@ +from __future__ import annotations + +import asyncio +from typing import TYPE_CHECKING, Optional, cast + +import cv2 +import numpy as np +from win32 import win32gui +from winsdk.windows.graphics import SizeInt32 +from winsdk.windows.graphics.capture import Direct3D11CaptureFramePool, GraphicsCaptureSession +from winsdk.windows.graphics.capture.interop import create_for_window +from winsdk.windows.graphics.directx import DirectXPixelFormat +from winsdk.windows.graphics.imaging import BitmapBufferAccessMode, SoftwareBitmap +from winsdk.windows.media.capture import MediaCapture + +from capture_method.interface import CaptureMethodInterface +from utils import WINDOWS_BUILD_NUMBER + +if TYPE_CHECKING: + from AutoSplit import AutoSplit + +WGC_NO_BORDER_MIN_BUILD = 20348 + + +class WindowsGraphicsCaptureMethod(CaptureMethodInterface): + size: SizeInt32 + frame_pool: Optional[Direct3D11CaptureFramePool] = None + session: Optional[GraphicsCaptureSession] = None + """This is stored to prevent session from being garbage collected""" + last_captured_frame: Optional[cv2.Mat] = None + + def __init__(self, autosplit: AutoSplit): + super().__init__(autosplit) + if not self.check_selected_region_exists(autosplit): + return + # Note: Must create in the same thread (can't use a global) otherwise when ran from LiveSplit it will raise: + # OSError: The application called an interface that was marshalled for a different thread + media_capture = MediaCapture() + item = create_for_window(autosplit.hwnd) + + async def coroutine(): + await (media_capture.initialize_async() or asyncio.sleep(0)) + asyncio.run(coroutine()) + + if not media_capture.media_capture_settings: + raise OSError("Unable to initialize a Direct3D Device.") + frame_pool = Direct3D11CaptureFramePool.create_free_threaded( + media_capture.media_capture_settings.direct3_d11_device, + DirectXPixelFormat.B8_G8_R8_A8_UINT_NORMALIZED, + 1, + item.size) + if not frame_pool: + raise OSError("Unable to create a frame pool for a capture session.") + session = frame_pool.create_capture_session(item) + if not session: + raise OSError("Unable to create a capture session.") + session.is_cursor_capture_enabled = False + if WINDOWS_BUILD_NUMBER >= WGC_NO_BORDER_MIN_BUILD: + session.is_border_required = False + session.start_capture() + + self.session = session + self.size = item.size + self.frame_pool = frame_pool + + def close(self, autosplit: AutoSplit): + if self.frame_pool: + self.frame_pool.close() + self.frame_pool = None + if self.session: + try: + self.session.close() + except OSError: + # OSError: The application called an interface that was marshalled for a different thread + # This still seems to close the session and prevent the following hard crash in LiveSplit + # pylint: disable=line-too-long + # "AutoSplit.exe " # noqa: E501 + pass + self.session = None + + def get_frame(self, autosplit: AutoSplit) -> tuple[Optional[cv2.Mat], bool]: + selection = autosplit.settings_dict["capture_region"] + # We still need to check the hwnd because WGC will return a blank black image + if not self.check_selected_region_exists(autosplit) or not self.frame_pool or not self.session: + return None, False + + try: + frame = self.frame_pool.try_get_next_frame() + # Frame pool is closed + except OSError: + return None, False + if not frame: + return self.last_captured_frame, True + + async def coroutine(): + return await (SoftwareBitmap.create_copy_from_surface_async(frame.surface) or asyncio.sleep(0, None)) + try: + software_bitmap = asyncio.run(coroutine()) + except SystemError as exception: + # HACK: can happen when closing the GraphicsCapturePicker + if str(exception).endswith("returned a result with an error set"): + return self.last_captured_frame, True + raise + + if not software_bitmap: + # HACK: Can happen when starting the region selector + return self.last_captured_frame, True + # raise ValueError("Unable to convert Direct3D11CaptureFrame to SoftwareBitmap.") + bitmap_buffer = software_bitmap.lock_buffer(BitmapBufferAccessMode.READ_WRITE) + if not bitmap_buffer: + raise ValueError("Unable to obtain the BitmapBuffer from SoftwareBitmap.") + reference = bitmap_buffer.create_reference() + image = np.frombuffer(cast(bytes, reference), dtype=np.uint8) + image.shape = (self.size.height, self.size.width, 4) + image = image[ + selection["y"]:selection["y"] + selection["height"], + selection["x"]:selection["x"] + selection["width"], + ] + self.last_captured_frame = image + return image, False + + def recover_window(self, captured_window_title: str, autosplit: AutoSplit): + hwnd = win32gui.FindWindow(None, captured_window_title) + # Don't fallback to desktop or whatever window obtained with "" + if not win32gui.IsWindow(hwnd) or not captured_window_title: + return False + autosplit.hwnd = hwnd + self.close(autosplit) + try: + self.__init__(autosplit) # pylint: disable=unnecessary-dunder-call + # Unrecordable hwnd found as the game is crashing + except OSError as exception: + if str(exception).endswith("The parameter is incorrect"): + return False + raise + return self.check_selected_region_exists(autosplit) + + def check_selected_region_exists(self, autosplit: AutoSplit): + return bool(win32gui.IsWindow(autosplit.hwnd) and win32gui.GetWindowText(autosplit.hwnd)) diff --git a/src/CaptureMethod.py b/src/capture_method/__init__.py similarity index 71% rename from src/CaptureMethod.py rename to src/capture_method/__init__.py index e8f28ace..3b74eb99 100644 --- a/src/CaptureMethod.py +++ b/src/capture_method/__init__.py @@ -1,33 +1,43 @@ +from __future__ import annotations + import asyncio from collections import OrderedDict from dataclasses import dataclass from enum import Enum, EnumMeta, unique +from typing import TYPE_CHECKING, TypedDict import cv2 from pygrabber.dshow_graph import FilterGraph from winsdk.windows.media.capture import MediaCapture +from capture_method.BitBltCaptureMethod import BitBltCaptureMethod +from capture_method.DesktopDuplicationCaptureMethod import DesktopDuplicationCaptureMethod +from capture_method.ForceFullContentRenderingCaptureMethod import ForceFullContentRenderingCaptureMethod +from capture_method.interface import CaptureMethodInterface +from capture_method.VideoCaptureDeviceCaptureMethod import VideoCaptureDeviceCaptureMethod +from capture_method.WindowsGraphicsCaptureMethod import WindowsGraphicsCaptureMethod from utils import WINDOWS_BUILD_NUMBER +if TYPE_CHECKING: + from AutoSplit import AutoSplit + WGC_MIN_BUILD = 17134 """https://docs.microsoft.com/en-us/uwp/api/windows.graphics.capture.graphicscapturepicker#applies-to""" -def test_for_media_capture(): - async def coroutine(): - return await (MediaCapture().initialize_async() or asyncio.sleep(0)) - try: - asyncio.run(coroutine()) - return True - except OSError: - return False +class Region(TypedDict): + x: int + y: int + width: int + height: int @dataclass -class DisplayCaptureMethodInfo(): +class CaptureMethodInfo(): name: str short_description: str description: str + implementation: type[CaptureMethodInterface] class CaptureMethodMeta(EnumMeta): @@ -42,7 +52,7 @@ def __contains__(self, other: str): @unique -class CaptureMethod(Enum, metaclass=CaptureMethodMeta): +class CaptureMethodEnum(Enum, metaclass=CaptureMethodMeta): # Allow TOML to save as a simple string def __repr__(self): return self.value @@ -63,15 +73,15 @@ def __hash__(self): VIDEO_CAPTURE_DEVICE = "VIDEO_CAPTURE_DEVICE" -class DisplayCaptureMethodDict(OrderedDict[CaptureMethod, DisplayCaptureMethodInfo]): +class CaptureMethodDict(OrderedDict[CaptureMethodEnum, CaptureMethodInfo]): def get_method_by_index(self, index: int): if index < 0: return next(iter(self)) return list(self.keys())[index] -CAPTURE_METHODS = DisplayCaptureMethodDict({ - CaptureMethod.BITBLT: DisplayCaptureMethodInfo( +CAPTURE_METHODS = CaptureMethodDict({ + CaptureMethodEnum.BITBLT: CaptureMethodInfo( name="BitBlt", short_description="fastest, least compatible", description=( @@ -79,8 +89,10 @@ def get_method_by_index(self, index: int): "\nOpenGL, Hardware Accelerated or Exclusive Fullscreen windows. " "\nThe smaller the selected region, the more efficient it is. " ), + + implementation=BitBltCaptureMethod, ), - CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: DisplayCaptureMethodInfo( + CaptureMethodEnum.WINDOWS_GRAPHICS_CAPTURE: CaptureMethodInfo( name="Windows Graphics Capture", short_description="fast, most compatible, capped at 60fps", description=( @@ -91,8 +103,9 @@ def get_method_by_index(self, index: int): "\nAdds a yellow border on Windows 10 (not on Windows 11)." "\nCaps at around 60 FPS. " ), + implementation=WindowsGraphicsCaptureMethod, ), - CaptureMethod.DESKTOP_DUPLICATION: DisplayCaptureMethodInfo( + CaptureMethodEnum.DESKTOP_DUPLICATION: CaptureMethodInfo( name="Direct3D Desktop Duplication", short_description="slower, bound to display", description=( @@ -101,8 +114,9 @@ def get_method_by_index(self, index: int): "\nAbout 10-15x slower than BitBlt. Not affected by window size. " "\nOverlapping windows will show up and can't record across displays. " ), + implementation=DesktopDuplicationCaptureMethod, ), - CaptureMethod.PRINTWINDOW_RENDERFULLCONTENT: DisplayCaptureMethodInfo( + CaptureMethodEnum.PRINTWINDOW_RENDERFULLCONTENT: CaptureMethodInfo( name="Force Full Content Rendering", short_description="very slow, can affect rendering pipeline", description=( @@ -111,8 +125,9 @@ def get_method_by_index(self, index: int): "\nAbout 10-15x slower than BitBlt based on original window size " "\nand can mess up some applications' rendering pipelines. " ), + implementation=ForceFullContentRenderingCaptureMethod, ), - CaptureMethod.VIDEO_CAPTURE_DEVICE: DisplayCaptureMethodInfo( + CaptureMethodEnum.VIDEO_CAPTURE_DEVICE: CaptureMethodInfo( name="Video Capture Device", short_description="very slow, see below", description=( @@ -122,17 +137,39 @@ def get_method_by_index(self, index: int): "\nIf you want to use this with OBS' Virtual Camera, use the Virtualcam plugin instead " "\nhttps://obsproject.com/forum/resources/obs-virtualcam.949/." ), + implementation=VideoCaptureDeviceCaptureMethod, ), }) +def test_for_media_capture(): + async def coroutine(): + return await (MediaCapture().initialize_async() or asyncio.sleep(0)) + try: + asyncio.run(coroutine()) + return True + except OSError: + return False + + # Detect and remove unsupported capture methods if ( # Windows Graphics Capture requires a minimum Windows Build WINDOWS_BUILD_NUMBER < WGC_MIN_BUILD # Our current implementation of Windows Graphics Capture requires at least one CaptureDevice or not test_for_media_capture() ): - CAPTURE_METHODS.pop(CaptureMethod.WINDOWS_GRAPHICS_CAPTURE) + CAPTURE_METHODS.pop(CaptureMethodEnum.WINDOWS_GRAPHICS_CAPTURE) + + +def change_capture_method(selected_capture_method: CaptureMethodEnum, autosplit: AutoSplit): + autosplit.capture_method.close(autosplit) + autosplit.capture_method = CAPTURE_METHODS[selected_capture_method].implementation(autosplit) + if selected_capture_method == CaptureMethodEnum.VIDEO_CAPTURE_DEVICE: + autosplit.select_region_button.setDisabled(True) + autosplit.select_window_button.setDisabled(True) + else: + autosplit.select_region_button.setDisabled(False) + autosplit.select_window_button.setDisabled(False) @dataclass @@ -156,7 +193,7 @@ async def get_camera_info(index: int, device_name: str): video_capture.grab() except cv2.error as error: # pyright: ignore [reportUnknownVariableType] return CameraInfo(index, device_name, True, backend) \ - if error.code == cv2.Error.STS_ERROR \ + if error.code in (cv2.Error.STS_ERROR, cv2.Error.STS_ASSERT) \ else None finally: video_capture.release() diff --git a/src/capture_method/interface.py b/src/capture_method/interface.py new file mode 100644 index 00000000..24804129 --- /dev/null +++ b/src/capture_method/interface.py @@ -0,0 +1,35 @@ +from __future__ import annotations + +from typing import TYPE_CHECKING, Optional + +import cv2 + +if TYPE_CHECKING: + from AutoSplit import AutoSplit + + +class CaptureMethodInterface(): + def __init__(self, autosplit: Optional[AutoSplit] = None): + pass + + def reinitialize(self, autosplit: AutoSplit): + self.close(autosplit) + self.__init__(autosplit) # pylint: disable=unnecessary-dunder-call + + def close(self, autosplit: AutoSplit): + pass + + def get_frame(self, autosplit: AutoSplit) -> tuple[Optional[cv2.Mat], bool]: + """ + Captures an image of the region for a window matching the given + parameters of the bounding box + + @return: The image of the region in the window in BGRA format + """ + raise NotImplementedError() + + def recover_window(self, captured_window_title: str, autosplit: AutoSplit) -> bool: + raise NotImplementedError() + + def check_selected_region_exists(self, autosplit: AutoSplit) -> bool: + raise NotImplementedError() diff --git a/src/menu_bar.py b/src/menu_bar.py index 4b0c510e..28f3237c 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -3,22 +3,19 @@ import asyncio import threading import webbrowser -from typing import TYPE_CHECKING, Any, Optional, Union, cast +from typing import TYPE_CHECKING, Any, Union, cast -import cv2 import requests from packaging.version import parse as version_parse from PyQt6 import QtCore, QtWidgets from requests.exceptions import RequestException -from win32 import win32gui -from winsdk.windows.graphics.capture.interop import create_for_window import error_messages import user_profile -from CaptureMethod import CAPTURE_METHODS, CameraInfo, CaptureMethod, get_all_video_capture_devices +from capture_method import (CAPTURE_METHODS, CameraInfo, CaptureMethodEnum, change_capture_method, + get_all_video_capture_devices) from gen import about, design, resources_rc, settings as settings_ui, update_checker # noqa: F401 from hotkeys import HOTKEYS, Hotkeys, set_hotkey -from region_selection import create_windows_graphics_capture from utils import AUTOSPLIT_VERSION, FIRST_WIN_11_BUILD, WINDOWS_BUILD_NUMBER, decimal if TYPE_CHECKING: @@ -100,12 +97,12 @@ def check_for_updates(autosplit: AutoSplit, check_on_open: bool = False): autosplit.CheckForUpdatesThread.start() -def get_capture_method_index(capture_method: Union[str, CaptureMethod]): +def get_capture_method_index(capture_method: Union[str, CaptureMethodEnum]): """ Returns 0 if the capture_method is invalid or unsupported """ try: - return list(CAPTURE_METHODS.keys()).index(cast(CaptureMethod, capture_method)) + return list(CAPTURE_METHODS.keys()).index(cast(CaptureMethodEnum, capture_method)) except ValueError: return 0 @@ -142,40 +139,18 @@ def get_capture_device_index(self, capture_device_id: int): def __capture_method_changed(self): selected_capture_method = CAPTURE_METHODS.get_method_by_index(self.capture_method_combobox.currentIndex()) - # Release or start video capture device - self.__capture_device_changed(selected_capture_method) - if self.autosplit.windows_graphics_capture: - self.autosplit.windows_graphics_capture.close() - self.autosplit.windows_graphics_capture = None - if selected_capture_method == CaptureMethod.VIDEO_CAPTURE_DEVICE: - self.autosplit.select_region_button.setDisabled(True) - self.autosplit.select_window_button.setDisabled(True) - else: - self.autosplit.select_region_button.setDisabled(False) - self.autosplit.select_window_button.setDisabled(False) - # Recover window from name - hwnd = win32gui.FindWindow(None, self.autosplit.settings_dict["captured_window_title"]) - # Don't fallback to desktop or whatever window obtained with "" - if win32gui.IsWindow(hwnd) and self.autosplit.settings_dict["captured_window_title"]: - self.autosplit.hwnd = hwnd - if selected_capture_method == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: - self.autosplit.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) + change_capture_method(selected_capture_method, self.autosplit) return selected_capture_method - def __capture_device_changed(self, current_capture_method: Optional[Union[CaptureMethod, str]] = None): - current_capture_method = current_capture_method or self.autosplit.settings_dict["capture_method"] - # Always release the previous capture device - if self.autosplit.capture_device: - self.autosplit.capture_device.release() - self.autosplit.capture_device = None + def __capture_device_changed(self): device_index = self.capture_device_combobox.currentIndex() if device_index == -1: - return None + return capture_device = self.__video_capture_devices[device_index] - if current_capture_method == CaptureMethod.VIDEO_CAPTURE_DEVICE: - self.autosplit.settings_dict["capture_device_name"] = capture_device.name - self.autosplit.capture_device = cv2.VideoCapture(capture_device.device_id) - return capture_device.device_id + self.autosplit.settings_dict["capture_device_name"] = capture_device.name + self.autosplit.settings_dict["capture_device_id"] = capture_device.device_id + if self.autosplit.settings_dict["capture_method"] == CaptureMethodEnum.VIDEO_CAPTURE_DEVICE: + change_capture_method(CaptureMethodEnum.VIDEO_CAPTURE_DEVICE, self.autosplit) async def __set_all_capture_devices(self): self.__video_capture_devices = await get_all_video_capture_devices() @@ -183,7 +158,9 @@ async def __set_all_capture_devices(self): for i in range(self.capture_device_combobox.count()): self.capture_device_combobox.removeItem(i) self.capture_device_combobox.addItems([ - f"* {device.name} [{device.backend}]{' (occupied)' if device.occupied else ''}" + f"* {device.name}" + + (f" [{device.backend}]" if device.backend else "") + + (" (occupied)" if device.occupied else "") for device in self.__video_capture_devices]) self.capture_device_combobox.setEnabled(True) self.capture_device_combobox.setCurrentIndex( @@ -266,9 +243,7 @@ def hotkey_connect(hotkey: Hotkeys): self.capture_method_combobox.currentIndexChanged.connect(lambda: self.__set_value( "capture_method", self.__capture_method_changed())) - self.capture_device_combobox.currentIndexChanged.connect(lambda: self.__set_value( - "capture_device_id", - self.__capture_device_changed())) + self.capture_device_combobox.currentIndexChanged.connect(self.__capture_device_changed) # Image Settings self.default_comparison_method.currentIndexChanged.connect(lambda: self.__set_value( diff --git a/src/region_capture.py b/src/region_capture.py deleted file mode 100644 index 266ec5f4..00000000 --- a/src/region_capture.py +++ /dev/null @@ -1,225 +0,0 @@ -from __future__ import annotations - -import asyncio -import ctypes -import ctypes.wintypes -from typing import TYPE_CHECKING, Optional, TypedDict, cast - -import cv2 -import d3dshot -import numpy as np -import pywintypes -import win32con -import win32ui -from PyQt6 import QtCore, QtGui -from PyQt6.QtWidgets import QLabel -from win32 import win32gui -from winsdk.windows.graphics.imaging import BitmapBufferAccessMode, SoftwareBitmap - -from CaptureMethod import CaptureMethod -from utils import is_valid_image -from WindowsGraphicsCapture import WindowsGraphicsCapture - -if TYPE_CHECKING: - from AutoSplit import AutoSplit - -# This is an undocumented nFlag value for PrintWindow -PW_RENDERFULLCONTENT = 0x00000002 -DWMWA_EXTENDED_FRAME_BOUNDS = 9 - - -desktop_duplication = d3dshot.create(capture_output="numpy") - - -class Region(TypedDict): - x: int - y: int - width: int - height: int - - -def get_window_bounds(hwnd: int): - extended_frame_bounds = ctypes.wintypes.RECT() - ctypes.windll.dwmapi.DwmGetWindowAttribute( - hwnd, - DWMWA_EXTENDED_FRAME_BOUNDS, - ctypes.byref(extended_frame_bounds), - ctypes.sizeof(extended_frame_bounds)) - - window_rect = win32gui.GetWindowRect(hwnd) - window_left_bounds = cast(int, extended_frame_bounds.left) - window_rect[0] - window_top_bounds = cast(int, extended_frame_bounds.top) - window_rect[1] - window_width = cast(int, extended_frame_bounds.right) - cast(int, extended_frame_bounds.left) - window_height = cast(int, extended_frame_bounds.bottom) - cast(int, extended_frame_bounds.top) - return window_left_bounds, window_top_bounds, window_width, window_height - - -def __bit_blt_capture(hwnd: int, selection: Region, render_full_content: bool = False): - image: Optional[cv2.Mat] = None - # If the window closes while it's being manipulated, it could cause a crash - try: - window_dc = win32gui.GetWindowDC(hwnd) - dc_object = win32ui.CreateDCFromHandle(window_dc) - - # Causes a 10-15x performance drop. But allows recording hardware accelerated windows - if render_full_content: - ctypes.windll.user32.PrintWindow(hwnd, dc_object.GetSafeHdc(), PW_RENDERFULLCONTENT) - - # On Windows there is a shadow around the windows that we need to account for. - left_bounds, top_bounds, *_ = get_window_bounds(hwnd) - - compatible_dc = dc_object.CreateCompatibleDC() - bitmap = win32ui.CreateBitmap() - bitmap.CreateCompatibleBitmap(dc_object, selection["width"], selection["height"]) - compatible_dc.SelectObject(bitmap) - compatible_dc.BitBlt( - (0, 0), - (selection["width"], selection["height"]), - dc_object, - (selection["x"] + left_bounds, selection["y"] + top_bounds), - win32con.SRCCOPY) - image = np.frombuffer(cast(bytes, bitmap.GetBitmapBits(True)), dtype=np.uint8) - image.shape = (selection["height"], selection["width"], 4) - # https://github.com/kaluluosi/pywin32-stubs/issues/5 - except (win32ui.error, pywintypes.error): # pyright: ignore [reportGeneralTypeIssues] pylint: disable=no-member - return None - # We already obtained the image, so we can ignore errors during cleanup - try: - dc_object.DeleteDC() - compatible_dc.DeleteDC() - win32gui.ReleaseDC(hwnd, window_dc) - win32gui.DeleteObject(bitmap.GetHandle()) - # https://github.com/kaluluosi/pywin32-stubs/issues/5 - except win32ui.error: # pyright: ignore [reportGeneralTypeIssues] - pass - return image - - -def __d3d_capture(hwnd: int, selection: Region): - hmonitor = ctypes.windll.user32.MonitorFromWindow(hwnd, win32con.MONITOR_DEFAULTTONEAREST) - if not hmonitor: - return None - - left_bounds, top_bounds, *_ = get_window_bounds(hwnd) - desktop_duplication.display = [ - display for display - in desktop_duplication.displays - if display.hmonitor == hmonitor][0] - offset_x, offset_y, *_ = win32gui.GetWindowRect(hwnd) - offset_x -= desktop_duplication.display.position["left"] - offset_y -= desktop_duplication.display.position["top"] - left = selection["x"] + offset_x + left_bounds - top = selection["y"] + offset_y + top_bounds - right = selection["width"] + left - bottom = selection["height"] + top - screenshot = desktop_duplication.screenshot((left, top, right, bottom)) - return cv2.cvtColor(screenshot, cv2.COLOR_RGBA2BGRA) - - -def __windows_graphics_capture(windows_graphics_capture: Optional[WindowsGraphicsCapture], selection: Region): - if not windows_graphics_capture or not windows_graphics_capture.frame_pool: - return None, False - - try: - frame = windows_graphics_capture.frame_pool.try_get_next_frame() - # Frame pool is closed - except OSError: - return None, False - if not frame: - return windows_graphics_capture.last_captured_frame, True - - async def coroutine(): - return await (SoftwareBitmap.create_copy_from_surface_async(frame.surface) or asyncio.sleep(0, None)) - try: - software_bitmap = asyncio.run(coroutine()) - except SystemError as exception: - # HACK: can happen when closing the GraphicsCapturePicker - if str(exception).endswith("returned a result with an error set"): - return windows_graphics_capture.last_captured_frame, True - raise - - if not software_bitmap: - # HACK: Can happen when starting the region selector - return windows_graphics_capture.last_captured_frame, True - # raise ValueError("Unable to convert Direct3D11CaptureFrame to SoftwareBitmap.") - bitmap_buffer = software_bitmap.lock_buffer(BitmapBufferAccessMode.READ_WRITE) - if not bitmap_buffer: - raise ValueError("Unable to obtain the BitmapBuffer from SoftwareBitmap.") - reference = bitmap_buffer.create_reference() - image = np.frombuffer(cast(bytes, reference), dtype=np.uint8) - image.shape = (windows_graphics_capture.size.height, windows_graphics_capture.size.width, 4) - image = image[ - selection["y"]:selection["y"] + selection["height"], - selection["x"]:selection["x"] + selection["width"], - ] - windows_graphics_capture.last_captured_frame = image - return image, False - - -def __camera_capture(capture_device: Optional[cv2.VideoCapture], selection: Region): - if not capture_device: - return None - result, image = capture_device.read() - if not result: - return None - # Ensure we can't go OOB of the image - y = min(selection["y"], image.shape[0] - 1) - x = min(selection["x"], image.shape[1] - 1) - image = image[ - y:selection["height"] + y, - x:selection["width"] + x, - ] - return cv2.cvtColor(image, cv2.COLOR_BGR2BGRA) - - -def capture_region(autosplit: AutoSplit) -> tuple[Optional[cv2.Mat], bool]: - """ - Captures an image of the region for a window matching the given - parameters of the bounding box - - @param hwnd: Handle to the window being captured - @param selection: The coordinates of the region - @return: The image of the region in the window in BGRA format - """ - capture_method = autosplit.settings_dict["capture_method"] - selection = autosplit.settings_dict["capture_region"] - - if capture_method == CaptureMethod.VIDEO_CAPTURE_DEVICE: - return __camera_capture(autosplit.capture_device, selection), False - - if not win32gui.IsWindow(autosplit.hwnd): - return None, False - - if capture_method == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: - image, is_old_image = __windows_graphics_capture(autosplit.windows_graphics_capture, selection) - return (None, False) \ - if is_old_image and not win32gui.IsWindow(autosplit.hwnd) \ - else (image, is_old_image) - - if capture_method == CaptureMethod.DESKTOP_DUPLICATION: - return __d3d_capture(autosplit.hwnd, selection), False - - return __bit_blt_capture(autosplit.hwnd, selection, capture_method - == CaptureMethod.PRINTWINDOW_RENDERFULLCONTENT), False - - -def set_ui_image(qlabel: QLabel, image: Optional[cv2.Mat], transparency: bool): - if not is_valid_image(image): - # Clear current pixmap if no image. But don't clear text - if not qlabel.text(): - qlabel.clear() - else: - if transparency: - color_code = cv2.COLOR_BGRA2RGBA - image_format = QtGui.QImage.Format.Format_RGBA8888 - else: - color_code = cv2.COLOR_BGRA2BGR - image_format = QtGui.QImage.Format.Format_BGR888 - - capture = cv2.cvtColor(image, color_code) - height, width, channels = capture.shape - qimage = QtGui.QImage(capture.data, width, height, width * channels, image_format) - qlabel.setPixmap(QtGui.QPixmap(qimage).scaled( - qlabel.size(), - QtCore.Qt.AspectRatioMode.IgnoreAspectRatio, - QtCore.Qt.TransformationMode.SmoothTransformation)) diff --git a/src/region_selection.py b/src/region_selection.py index 95e49a1c..cf9809f1 100644 --- a/src/region_selection.py +++ b/src/region_selection.py @@ -15,13 +15,9 @@ from winsdk._winrt import initialize_with_window from winsdk.windows.foundation import AsyncStatus, IAsyncOperation from winsdk.windows.graphics.capture import GraphicsCaptureItem, GraphicsCapturePicker -from winsdk.windows.graphics.capture.interop import create_for_window import error_messages -from CaptureMethod import CaptureMethod -from region_capture import capture_region, get_window_bounds -from utils import is_valid_image -from WindowsGraphicsCapture import create_windows_graphics_capture +from utils import get_window_bounds, is_valid_image if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -67,9 +63,7 @@ def callback(async_operation: IAsyncOperation[GraphicsCaptureItem], async_status if not item: return autosplit.settings_dict["captured_window_title"] = item.display_name - if autosplit.windows_graphics_capture: - autosplit.windows_graphics_capture.close() - autosplit.windows_graphics_capture = create_windows_graphics_capture(item) + autosplit.capture_method.reinitialize(autosplit) picker = GraphicsCapturePicker() initialize_with_window(picker, int(autosplit.effectiveWinId())) @@ -103,10 +97,7 @@ def select_region(autosplit: AutoSplit): autosplit.hwnd = hwnd autosplit.settings_dict["captured_window_title"] = window_text - if autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: - if autosplit.windows_graphics_capture: - autosplit.windows_graphics_capture.close() - autosplit.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) + autosplit.capture_method.reinitialize(autosplit) left_bounds, top_bounds, *_ = get_window_bounds(hwnd) window_x, window_y, *_ = win32gui.GetWindowRect(hwnd) @@ -139,10 +130,7 @@ def select_window(autosplit: AutoSplit): autosplit.hwnd = hwnd autosplit.settings_dict["captured_window_title"] = window_text - if autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: - if autosplit.windows_graphics_capture: - autosplit.windows_graphics_capture.close() - autosplit.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) + autosplit.capture_method.reinitialize(autosplit) # Exlude the borders and titlebar from the window selection. To only get the client area. _, __, window_width, window_height = get_window_bounds(hwnd) @@ -174,7 +162,7 @@ def __get_window_from_point(x: int, y: int): def align_region(autosplit: AutoSplit): # Check to see if a region has been set - if not check_selected_region_exists(autosplit): + if not autosplit.capture_method.check_selected_region_exists(autosplit): error_messages.region() return # This is the image used for aligning the capture region to the best fit for the user. @@ -198,7 +186,7 @@ def align_region(autosplit: AutoSplit): # Obtaining the capture of a region which contains the # subregion being searched for to align the image. - capture, _ = capture_region(autosplit) + capture, _ = autosplit.capture_method.get_frame(autosplit) if not is_valid_image(capture): error_messages.region() @@ -282,21 +270,13 @@ def validate_before_parsing(autosplit: AutoSplit, show_error: bool = True, check error = error_messages.split_image_directory_not_found elif check_empty_directory and not os.listdir(autosplit.settings_dict["split_image_directory"]): error = error_messages.split_image_directory_empty - elif not check_selected_region_exists(autosplit): + elif not autosplit.capture_method.check_selected_region_exists(autosplit): error = error_messages.region if error and show_error: error() return not error -def check_selected_region_exists(autosplit: AutoSplit): - if autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: - return bool(autosplit.windows_graphics_capture) - if autosplit.settings_dict["capture_method"] == CaptureMethod.VIDEO_CAPTURE_DEVICE: - return bool(autosplit.capture_device) - return bool(win32gui.IsWindow(autosplit.hwnd) and win32gui.GetWindowText(autosplit.hwnd)) - - class BaseSelectWidget(QtWidgets.QWidget): _x = 0 _y = 0 diff --git a/src/user_profile.py b/src/user_profile.py index 7adf624c..ff7df78b 100644 --- a/src/user_profile.py +++ b/src/user_profile.py @@ -3,19 +3,14 @@ import os from typing import TYPE_CHECKING, TypedDict, Union, cast -import cv2 import keyboard import toml from PyQt6 import QtCore, QtWidgets -from win32 import win32gui -from winsdk.windows.graphics.capture.interop import create_for_window import error_messages -from CaptureMethod import CAPTURE_METHODS, CaptureMethod +from capture_method import CAPTURE_METHODS, CaptureMethodEnum, Region, change_capture_method from gen import design from hotkeys import HOTKEYS, set_hotkey -from region_capture import Region -from region_selection import create_windows_graphics_capture from utils import auto_split_directory if TYPE_CHECKING: @@ -30,7 +25,7 @@ class UserProfileDict(TypedDict): pause_hotkey: str fps_limit: int live_capture_region: bool - capture_method: Union[str, CaptureMethod] + capture_method: Union[str, CaptureMethodEnum] capture_device_id: int capture_device_name: str default_comparison_method: int @@ -132,30 +127,21 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str autosplit.show_error_signal.emit(error_messages.invalid_settings) return False - if autosplit.settings_dict["capture_method"] == CaptureMethod.VIDEO_CAPTURE_DEVICE: - autosplit.select_region_button.setDisabled(True) - autosplit.select_window_button.setDisabled(True) - autosplit.capture_device = cv2.VideoCapture(autosplit.settings_dict["capture_device_id"]) - keyboard.unhook_all() if not autosplit.is_auto_controlled: for hotkey, hotkey_name in [(hotkey, f"{hotkey}_hotkey") for hotkey in HOTKEYS]: if autosplit.settings_dict[hotkey_name]: set_hotkey(autosplit, hotkey, cast(str, autosplit.settings_dict[hotkey_name])) - if autosplit.settings_dict["captured_window_title"]: - hwnd = win32gui.FindWindow(None, autosplit.settings_dict["captured_window_title"]) - # Don't fallback to desktop or whatever window obtained with "" - if win32gui.IsWindow(hwnd) and autosplit.settings_dict["captured_window_title"]: - autosplit.hwnd = hwnd - if autosplit.settings_dict["capture_method"] == CaptureMethod.WINDOWS_GRAPHICS_CAPTURE: - if autosplit.windows_graphics_capture: - autosplit.windows_graphics_capture.close() - autosplit.windows_graphics_capture = create_windows_graphics_capture(create_for_window(hwnd)) - else: - autosplit.live_image.setText("Reload settings after opening" - + f'\n"{autosplit.settings_dict["captured_window_title"]}"' - + "\nto automatically load Capture Region") + change_capture_method(cast(CaptureMethodEnum, autosplit.settings_dict["capture_method"]), autosplit) + if ( + not autosplit.capture_method.check_selected_region_exists(autosplit) + and autosplit.settings_dict["captured_window_title"] + ): + autosplit.live_image.setText("Reload settings after opening" + + f'\n"{autosplit.settings_dict["captured_window_title"]}"' + + "\nto automatically load Capture Region") + return True diff --git a/src/utils.py b/src/utils.py index 5bf75eaa..ab40e1a3 100644 --- a/src/utils.py +++ b/src/utils.py @@ -1,12 +1,17 @@ import asyncio +import ctypes +import ctypes.wintypes import os import sys from collections.abc import Callable from platform import version -from typing import Any, Optional, Union +from typing import Any, Optional, Union, cast import cv2 from typing_extensions import TypeGuard +from win32 import win32gui + +DWMWA_EXTENDED_FRAME_BOUNDS = 9 def decimal(value: Union[int, float]): @@ -29,6 +34,22 @@ def is_valid_image(image: Optional[cv2.Mat]) -> TypeGuard[cv2.Mat]: return image is not None and bool(image.size) +def get_window_bounds(hwnd: int): + extended_frame_bounds = ctypes.wintypes.RECT() + ctypes.windll.dwmapi.DwmGetWindowAttribute( + hwnd, + DWMWA_EXTENDED_FRAME_BOUNDS, + ctypes.byref(extended_frame_bounds), + ctypes.sizeof(extended_frame_bounds)) + + window_rect = win32gui.GetWindowRect(hwnd) + window_left_bounds = cast(int, extended_frame_bounds.left) - window_rect[0] + window_top_bounds = cast(int, extended_frame_bounds.top) - window_rect[1] + window_width = cast(int, extended_frame_bounds.right) - cast(int, extended_frame_bounds.left) + window_height = cast(int, extended_frame_bounds.bottom) - cast(int, extended_frame_bounds.top) + return window_left_bounds, window_top_bounds, window_width, window_height + + def fire_and_forget(func: Callable[..., None]): def wrapped(*args: Any, **kwargs: Any): return asyncio.get_event_loop().run_in_executor(None, func, *args, *kwargs) diff --git a/typings/cv2-stubs/__init__.pyi b/typings/cv2-stubs/__init__.pyi index 1638dd1c..550c3001 100644 --- a/typings/cv2-stubs/__init__.pyi +++ b/typings/cv2-stubs/__init__.pyi @@ -1,8 +1,9 @@ # Python: 3.8.0 (tags/v3.8.0:fa919fd, Oct 14 2019, 19:37:50) [MSC v.1916 64 bit (AMD64)] # Library: cv2, version: 4.4.0 # Module: cv2.cv2, version: 4.4.0 -import typing import builtins as _mod_builtins +import typing + import cv2 as _mod_cv2 import numpy as np @@ -1586,6 +1587,7 @@ class VideoCapture(): def release(self): ... def setExceptionMode(self, error: bool): ... def getBackendName(self) -> str: ... + def isOpened(self) -> bool: ... VideoWriter = _mod_cv2.VideoWriter def VideoWriter_fourcc(c1, c2, c3, c4) -> typing.Any: @@ -3109,4 +3111,4 @@ def writeOpticalFlow(path, flow) -> typing.Any: 'writeOpticalFlow(path, flow) -> retval\n. @brief Write a .flo to disk\n. \n. @param path Path to the file to be written\n. @param flow Flow field to be stored\n. \n. The function stores a flow field in a file, returns true on success, false otherwise.\n. The flow field must be a 2-channel, floating-point matrix (CV_32FC2). First channel corresponds\n. to the flow in the horizontal direction (u), second - vertical (v).' ... -def __getattr__(name) -> typing.Any: ... #incomplete \ No newline at end of file +def __getattr__(name) -> typing.Any: ... #incomplete From 3d72389aedb16d195e5fb5350b88af7e2b04d683 Mon Sep 17 00:00:00 2001 From: Avasam Date: Wed, 13 Jul 2022 00:39:57 -0400 Subject: [PATCH 096/137] Optimized VideoCaptureDevice by threading it --- .../VideoCaptureDeviceCaptureMethod.py | 46 ++++++++++++++++--- src/error_messages.py | 6 ++- src/hotkeys.py | 4 +- src/menu_bar.py | 4 +- 4 files changed, 48 insertions(+), 12 deletions(-) diff --git a/src/capture_method/VideoCaptureDeviceCaptureMethod.py b/src/capture_method/VideoCaptureDeviceCaptureMethod.py index 927ebd2c..9c197232 100644 --- a/src/capture_method/VideoCaptureDeviceCaptureMethod.py +++ b/src/capture_method/VideoCaptureDeviceCaptureMethod.py @@ -1,33 +1,64 @@ from __future__ import annotations -from typing import TYPE_CHECKING +from threading import Event, Thread +from typing import TYPE_CHECKING, Optional import cv2 from capture_method.interface import CaptureMethodInterface +from error_messages import CREATE_NEW_ISSUE_MESSAGE, exception_traceback +from utils import is_valid_image if TYPE_CHECKING: from AutoSplit import AutoSplit -class VideoCaptureDeviceCaptureMethod(CaptureMethodInterface): # pylint: disable=too-few-public-methods +class VideoCaptureDeviceCaptureMethod(CaptureMethodInterface): capture_device: cv2.VideoCapture + capture_thread: Optional[Thread] + last_captured_frame: Optional[cv2.Mat] = None + is_old_image = False + stop_thread = Event() + + def __read_loop(self, autosplit: AutoSplit): + try: + while not self.stop_thread.is_set(): + result, image = self.capture_device.read() + self.last_captured_frame = image if result else None + self.is_old_image = False + except Exception as exception: # pylint: disable=broad-except # We really want to catch everything here + error = exception + autosplit.show_error_signal.emit(lambda: exception_traceback( + "AutoSplit encountered an unhandled exception while trying to grab a frame and has stopped capture. " + + CREATE_NEW_ISSUE_MESSAGE, + error)) def __init__(self, autosplit: AutoSplit): super().__init__() self.capture_device = cv2.VideoCapture(autosplit.settings_dict["capture_device_id"]) self.capture_device.setExceptionMode(True) + self.stop_thread = Event() + self.capture_thread = Thread(target=lambda: self.__read_loop(autosplit)) + self.capture_thread.start() def close(self, autosplit: AutoSplit): + self.stop_thread.set() + if self.capture_thread: + self.capture_thread.join() + self.capture_thread = None self.capture_device.release() def get_frame(self, autosplit: AutoSplit): selection = autosplit.settings_dict["capture_region"] if not self.check_selected_region_exists(autosplit): return None, False - result, image = self.capture_device.read() - if not result: - return None, False + + image = self.last_captured_frame + is_old_image = self.is_old_image + self.is_old_image = True + if not is_valid_image(image): + return None, is_old_image + # Ensure we can't go OOB of the image y = min(selection["y"], image.shape[0] - 1) x = min(selection["x"], image.shape[1] - 1) @@ -35,7 +66,10 @@ def get_frame(self, autosplit: AutoSplit): y:y + selection["height"], x:x + selection["width"], ] - return cv2.cvtColor(image, cv2.COLOR_BGR2BGRA), False + return cv2.cvtColor(image, cv2.COLOR_BGR2BGRA), is_old_image + + def recover_window(self, captured_window_title: str, autosplit: AutoSplit) -> bool: + raise NotImplementedError() def check_selected_region_exists(self, autosplit: AutoSplit): return bool(self.capture_device.isOpened()) diff --git a/src/error_messages.py b/src/error_messages.py index 1745d430..5e417893 100644 --- a/src/error_messages.py +++ b/src/error_messages.py @@ -6,13 +6,15 @@ import sys import traceback from types import TracebackType -from typing import Optional +from typing import TYPE_CHECKING, Optional from PyQt6 import QtCore, QtWidgets -from AutoSplit import AutoSplit from utils import FROZEN +if TYPE_CHECKING: + from AutoSplit import AutoSplit + def __exit_program(): # stop main thread (which is probably blocked reading input) via an interrupt signal diff --git a/src/hotkeys.py b/src/hotkeys.py index 154bc228..9048dcd6 100644 --- a/src/hotkeys.py +++ b/src/hotkeys.py @@ -1,7 +1,7 @@ from __future__ import annotations -import threading from collections.abc import Callable +from threading import Thread from typing import TYPE_CHECKING, Literal, Optional, Union import keyboard @@ -248,4 +248,4 @@ def callback(): # Try to remove the previously set hotkey if there is one. _unhook(getattr(autosplit, f"{hotkey}_hotkey")) - threading.Thread(target=callback).start() + Thread(target=callback).start() diff --git a/src/menu_bar.py b/src/menu_bar.py index 28f3237c..9ddd113c 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -1,8 +1,8 @@ from __future__ import annotations import asyncio -import threading import webbrowser +from threading import Thread from typing import TYPE_CHECKING, Any, Union, cast import requests @@ -183,7 +183,7 @@ def __init__(self, autosplit: AutoSplit): # region Build the Capture method combobox capture_method_values = CAPTURE_METHODS.values() - threading.Thread(target=lambda: asyncio.run(self.__set_all_capture_devices())).start() + Thread(target=lambda: asyncio.run(self.__set_all_capture_devices())).start() capture_list_items = [ f"- {method.name} ({method.short_description})" for method in capture_method_values From b0a1c39db0c2828b2dcd7126a2473e4eeee8a4b6 Mon Sep 17 00:00:00 2001 From: Avasam Date: Wed, 13 Jul 2022 01:40:23 -0400 Subject: [PATCH 097/137] CI: Install wheel --- .github/workflows/lint-and-build.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/workflows/lint-and-build.yml b/.github/workflows/lint-and-build.yml index 8f4f48f7..bf127b3f 100644 --- a/.github/workflows/lint-and-build.yml +++ b/.github/workflows/lint-and-build.yml @@ -38,6 +38,7 @@ jobs: python-version: ${{ matrix.python-version }} cache: 'pip' cache-dependency-path: 'scripts/requirements-dev.txt' + - run: pip install wheel --upgrade - name: Install dependencies run: | pip install -r "scripts/requirements-dev.txt" @@ -61,6 +62,7 @@ jobs: python-version: ${{ matrix.python-version }} cache: 'pip' cache-dependency-path: 'scripts/requirements-dev.txt' + - run: pip install wheel --upgrade - name: Install dependencies run: pip install -r "scripts/requirements-dev.txt" - run: scripts/compile_resources.ps1 @@ -81,6 +83,7 @@ jobs: python-version: ${{ matrix.python-version }} cache: 'pip' cache-dependency-path: 'scripts/requirements-dev.txt' + - run: pip install wheel --upgrade - name: Install dependencies run: pip install -r "scripts/requirements-dev.txt" - run: scripts/compile_resources.ps1 @@ -101,6 +104,7 @@ jobs: python-version: ${{ matrix.python-version }} cache: 'pip' cache-dependency-path: 'scripts/requirements-dev.txt' + - run: pip install wheel --upgrade - name: Install dependencies run: pip install -r "scripts/requirements-dev.txt" - run: scripts/compile_resources.ps1 @@ -120,6 +124,7 @@ jobs: with: python-version: ${{ matrix.python-version }} cache: 'pip' + - run: pip install wheel --upgrade - name: Install dependencies run: pip install -r "scripts/requirements.txt" - run: scripts/build.ps1 From 96d707ac1b64dc681aeb34a5cd8b48a4424b4218 Mon Sep 17 00:00:00 2001 From: Avasam Date: Wed, 13 Jul 2022 20:28:35 -0400 Subject: [PATCH 098/137] Some UI fixes --- README.md | 4 +- res/about.ui | 11 ++-- res/design.ui | 10 +-- res/settings.ui | 65 +++++++------------ src/capture_method/BitBltCaptureMethod.py | 3 - .../VideoCaptureDeviceCaptureMethod.py | 1 + src/capture_method/__init__.py | 2 +- typings/cv2-stubs/__init__.pyi | 2 +- 8 files changed, 37 insertions(+), 61 deletions(-) diff --git a/README.md b/README.md index 618fc23d..f2d8782d 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ This program can be used to automatically start, split, and reset your preferred #### Comparison Method - There are three comparison methods to choose from: L2 Norm, Histograms, and Perceptual Hash (or pHash). - - L2 Norm: This method should be fine to use for most cases. it finds the difference between each pixel, squares it, sums it over the entire image and takes the square root. This is very fast but is a problem if your image is high frequency. Any translational movement or rotation can cause similarity to be very different. + - L2 Norm: This method should be fine to use for most cases. It finds the difference between each pixel, squares it, sums it over the entire image and takes the square root. This is very fast but is a problem if your image is high frequency. Any translational movement or rotation can cause similarity to be very different. - Histograms: An explanation on Histograms comparison can be found [here](https://mpatacchiola.github.io/blog/2016/11/12/the-simplest-classifier-histogram-intersection.html). This is a great method to use if you are using several masked images. - Perceptual Hash: An explanation on pHash comparison can be found [here](http://www.hackerfactor.com/blog/index.php?/archives/432-Looks-Like-It.html). It is highly recommended to NOT use pHash if you use masked images. It is very inaccurate. @@ -92,7 +92,7 @@ This program can be used to automatically start, split, and reset your preferred - **Force Full Content Rendering** (very slow, can affect rendering pipeline) Uses BitBlt behind the scene, but passes a special flag to PrintWindow to force rendering the entire desktop. About 10-15x slower than BitBlt based on original window size and can mess up some applications' rendering pipelines. -- **Video Capture Device** (very slow, see below) +- **Video Capture Device** Uses a Video Capture Device, like a webcam, virtual cam, or capture card. There are currently performance issues, but it might be more convenient. If you want to use this with OBS' Virtual Camera, use the [Virtualcam plugin](https://obsproject.com/forum/resources/obs-virtualcam.949/) instead. diff --git a/res/about.ui b/res/about.ui index 4cb2cc3d..d128ab6b 100644 --- a/res/about.ui +++ b/res/about.ui @@ -52,7 +52,7 @@ 10 44 - 161 + 171 32 @@ -112,10 +112,10 @@ consider donating. Thank you! - 190 + 181 17 - 62 - 71 + 64 + 64 @@ -124,6 +124,9 @@ consider donating. Thank you! :/resources/icon.ico + + true + diff --git a/res/design.ui b/res/design.ui index b4f07175..5a00ad65 100644 --- a/res/design.ui +++ b/res/design.ui @@ -40,12 +40,6 @@ :/resources/icon.ico:/resources/icon.ico - - - - - Qt::LeftToRight - @@ -816,7 +810,7 @@ 449 344 - 98 + 101 16 @@ -827,7 +821,7 @@ - 550 + 560 344 98 16 diff --git a/res/settings.ui b/res/settings.ui index 51cf6b93..6a5d299d 100644 --- a/res/settings.ui +++ b/res/settings.ui @@ -28,12 +28,18 @@ 621 - - ArrowCursor + + + 9 + Settings + + + :/resources/icon.ico:/resources/icon.ico + false @@ -61,9 +67,6 @@ 22 - - ArrowCursor - QAbstractSpinBox::CorrectToNearestValue @@ -89,9 +92,6 @@ This value will limit the amount of frames per second that AutoSplit will run comparisons - - - Comparison FPS Limit: @@ -202,10 +202,21 @@ - - - - + L2 Norm: +This method should be fine to use for most cases. +It finds the difference between each pixel, squares it, sums it over the entire image and takes the square root. +This is very fast but is a problem if your image is high frequency. +Any translational movement or rotation can cause similarity to be very different. + +Histograms: +An explanation on Histograms comparison can be found here +https://mpatacchiola.github.io/blog/2016/11/12/the-simplest-classifier-histogram-intersection.html +This is a great method to use if you are using several masked images. + +Perceptual Hash: +An explanation on pHash comparison can be found here +http://www.hackerfactor.com/blog/index.php?/archives/432-Looks-Like-It.html +It is highly recommended to NOT use pHash if you use masked images. It is very inaccurate. @@ -245,9 +256,6 @@ 16 - - - Default Pause Time (sec): @@ -289,12 +297,6 @@ 16 - - - - - - Default Similarity Threshold: @@ -361,9 +363,6 @@ true - - teset - <html><head/><body><p>Custom image settings and flags are set in the <br></br> image file name. These will override the default <br></br> values. View the <a href="https://github.com/Toufool/Auto-Split#readme"><span style=" text-decoration: underline; color:#0000ff;">README</span></a> for full details on all <br></br> available custom image settings.</p></body></html> @@ -377,12 +376,6 @@ 16 - - - - - - Default Delay Time (ms): @@ -396,9 +389,6 @@ 22 - - ArrowCursor - After an image is matched, this is the amount of time in millseconds that will be delayed before splitting. @@ -475,9 +465,6 @@ 20 - - Qt::StrongFocus - @@ -507,9 +494,6 @@ 20 - - IBeamCursor - @@ -600,9 +584,6 @@ 20 - - Qt::StrongFocus - diff --git a/src/capture_method/BitBltCaptureMethod.py b/src/capture_method/BitBltCaptureMethod.py index b292e9e1..04e94123 100644 --- a/src/capture_method/BitBltCaptureMethod.py +++ b/src/capture_method/BitBltCaptureMethod.py @@ -24,9 +24,6 @@ class BitBltCaptureMethod(CaptureMethodInterface): _render_full_content = False - def close(self, autosplit: AutoSplit): - pass - def get_frame(self, autosplit: AutoSplit): selection = autosplit.settings_dict["capture_region"] hwnd = autosplit.hwnd diff --git a/src/capture_method/VideoCaptureDeviceCaptureMethod.py b/src/capture_method/VideoCaptureDeviceCaptureMethod.py index 9c197232..fb737119 100644 --- a/src/capture_method/VideoCaptureDeviceCaptureMethod.py +++ b/src/capture_method/VideoCaptureDeviceCaptureMethod.py @@ -28,6 +28,7 @@ def __read_loop(self, autosplit: AutoSplit): self.is_old_image = False except Exception as exception: # pylint: disable=broad-except # We really want to catch everything here error = exception + self.capture_device.release() autosplit.show_error_signal.emit(lambda: exception_traceback( "AutoSplit encountered an unhandled exception while trying to grab a frame and has stopped capture. " + CREATE_NEW_ISSUE_MESSAGE, diff --git a/src/capture_method/__init__.py b/src/capture_method/__init__.py index 3b74eb99..69a57104 100644 --- a/src/capture_method/__init__.py +++ b/src/capture_method/__init__.py @@ -129,7 +129,7 @@ def get_method_by_index(self, index: int): ), CaptureMethodEnum.VIDEO_CAPTURE_DEVICE: CaptureMethodInfo( name="Video Capture Device", - short_description="very slow, see below", + short_description="see below", description=( "\nUses a Video Capture Device, like a webcam, virtual cam, or capture card. " "\nYou can select one below. " diff --git a/typings/cv2-stubs/__init__.pyi b/typings/cv2-stubs/__init__.pyi index 550c3001..1c1af721 100644 --- a/typings/cv2-stubs/__init__.pyi +++ b/typings/cv2-stubs/__init__.pyi @@ -1579,7 +1579,7 @@ def VariationalRefinement_create() -> typing.Any: class VideoCapture(): name: str device_id: int - def __init__(self, device_id: int, backend: int | None = ...): ... + def __init__(self, device_id: int | str, backend: int | None = ...): ... def set(self, property: int, value: int): ... def get(self, property: int) -> int: ... def grab(self) -> bool: ... From 38930a47dcbed9778e3a6bbae41ec19a41928b14 Mon Sep 17 00:00:00 2001 From: Avasam Date: Wed, 13 Jul 2022 22:35:48 -0400 Subject: [PATCH 099/137] Show a warning if AutoSplit is already open Closes #150 --- scripts/requirements.txt | 1 + src/AutoSplit.py | 18 ++++++++++++++++++ src/error_messages.py | 21 +++++++++++++++++---- 3 files changed, 36 insertions(+), 4 deletions(-) diff --git a/scripts/requirements.txt b/scripts/requirements.txt index 154105c9..a6dfc4fe 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -22,6 +22,7 @@ pyautogui requests certifi toml +psutil pygrabber typing-extensions # Windows-only diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 339292cd..e328dcc6 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -13,6 +13,7 @@ import certifi import cv2 +from psutil import process_iter from PyQt6 import QtCore, QtGui from PyQt6.QtTest import QTest from PyQt6.QtWidgets import QApplication, QFileDialog, QLabel, QMainWindow, QMessageBox, QWidget @@ -888,11 +889,28 @@ def seconds_remaining_text(seconds: float): return f"{seconds:.1f} second{'' if 0 < seconds <= 1 else 's'} remaining" +def is_already_running(): + # When running directly in Python, any AutoSplit process means it's already open + # When bundled, we must ignore itself and the splash screen + max_processes = 3 if FROZEN else 1 + process_count = 0 + for process in process_iter(): + if process.name() == "AutoSplit.exe": + process_count += 1 + if process_count >= max_processes: + return True + return False + + def main(): # Call to QApplication outside the try-except so we can show error messages app = QApplication(sys.argv) try: app.setWindowIcon(QtGui.QIcon(":/resources/icon.ico")) + + if is_already_running(): + error_messages.already_running() + AutoSplit() if not FROZEN: diff --git a/src/error_messages.py b/src/error_messages.py index 5e417893..edd4ca86 100644 --- a/src/error_messages.py +++ b/src/error_messages.py @@ -22,14 +22,18 @@ def __exit_program(): sys.exit(1) -def set_text_message(message: str, details: str = ""): +def set_text_message(message: str, details: str = "", kill_button: str = "", accept_button: str = ""): message_box = QtWidgets.QMessageBox() message_box.setWindowTitle("Error") message_box.setTextFormat(QtCore.Qt.TextFormat.RichText) message_box.setText(message) - if details: - force_quit_button = message_box.addButton("Close AutoSplit", QtWidgets.QMessageBox.ButtonRole.ResetRole) + # Button order is important for default focus + if accept_button: + message_box.addButton(accept_button, QtWidgets.QMessageBox.ButtonRole.AcceptRole) + if kill_button: + force_quit_button = message_box.addButton(kill_button, QtWidgets.QMessageBox.ButtonRole.ResetRole) force_quit_button.clicked.connect(__exit_program) + if details: message_box.setDetailedText(details) # Preopen the details for button in message_box.buttons(): @@ -121,10 +125,19 @@ def stdin_lost(): set_text_message("stdin not supported or lost, external control like LiveSplit integration will not work.") +def already_running(): + set_text_message( + "An instance of AutoSplit is already running.
Are you sure you want to open a another one?", + "", + "Don't open", + "Ignore") + + def exception_traceback(message: str, exception: BaseException): set_text_message( message, - "\n".join(traceback.format_exception(None, exception, exception.__traceback__))) + "\n".join(traceback.format_exception(None, exception, exception.__traceback__)), + "Close AutoSplit") CREATE_NEW_ISSUE_MESSAGE = ( From 9fe46c4b8c67c95b7e582e5e86eafa3cb952dc2d Mon Sep 17 00:00:00 2001 From: Avasam Date: Thu, 14 Jul 2022 19:15:01 -0400 Subject: [PATCH 100/137] Fixed linting --- pyproject.toml | 7 ++++++- scripts/requirements-dev.txt | 2 +- src/capture_method/BitBltCaptureMethod.py | 9 ++++----- src/capture_method/__init__.py | 2 +- 4 files changed, 12 insertions(+), 8 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 48643933..1282956d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -130,7 +130,12 @@ disable = [ ] [tool.pylint.TYPECHECK] -generated-members = "cv2" +generated-members = [ + # https://github.com/PyCQA/pylint/issues/4987 + "cv2", + # https://github.com/mhammond/pywin32/issues/1913 + "pywintypes.error", +] [tool.isort] line_length = 120 diff --git a/scripts/requirements-dev.txt b/scripts/requirements-dev.txt index 9249c181..b0c84c99 100644 --- a/scripts/requirements-dev.txt +++ b/scripts/requirements-dev.txt @@ -9,7 +9,7 @@ flake8-pyi flake8-quotes flake8-isort pylint>=2.13.9 -pywin32-stubs>=0.1.6 +git+https://github.com/Avasam/pywin32-stubs.git#egg=pywin32-stubs # https://github.com/kaluluosi/pywin32-stubs/pull/8 types-requests # # You can comment this out if you don't want to run `designer.bat` to quickly open the bundled PyQt Designer. diff --git a/src/capture_method/BitBltCaptureMethod.py b/src/capture_method/BitBltCaptureMethod.py index 04e94123..e3893000 100644 --- a/src/capture_method/BitBltCaptureMethod.py +++ b/src/capture_method/BitBltCaptureMethod.py @@ -55,17 +55,16 @@ def get_frame(self, autosplit: AutoSplit): win32con.SRCCOPY) image = np.frombuffer(cast(bytes, bitmap.GetBitmapBits(True)), dtype=np.uint8) image.shape = (selection["height"], selection["width"], 4) - # https://github.com/kaluluosi/pywin32-stubs/issues/5 - except (win32ui.error, pywintypes.error): # pyright: ignore [reportGeneralTypeIssues] pylint: disable=no-member + except (win32ui.error, pywintypes.error): return None, False # We already obtained the image, so we can ignore errors during cleanup try: + dc_object.DeleteDC() dc_object.DeleteDC() compatible_dc.DeleteDC() win32gui.ReleaseDC(hwnd, window_dc) - win32gui.DeleteObject(bitmap.GetHandle()) # pyright: ignore [reportGeneralTypeIssues] - # https://github.com/kaluluosi/pywin32-stubs/issues/5 - except win32ui.error: # pyright: ignore [reportGeneralTypeIssues] + win32gui.DeleteObject(bitmap.GetHandle()) + except win32ui.error: pass return image, False diff --git a/src/capture_method/__init__.py b/src/capture_method/__init__.py index 69a57104..5afc2ebe 100644 --- a/src/capture_method/__init__.py +++ b/src/capture_method/__init__.py @@ -180,7 +180,7 @@ class CameraInfo(): backend: str -async def get_all_video_capture_devices(): +async def get_all_video_capture_devices() -> list[CameraInfo]: named_video_inputs = FilterGraph().get_input_devices() async def get_camera_info(index: int, device_name: str): From d6f394f87134f398f2b0502466fb86809f6e8bb4 Mon Sep 17 00:00:00 2001 From: Avasam Date: Thu, 14 Jul 2022 19:47:22 -0400 Subject: [PATCH 101/137] Add version number --- scripts/compile_resources.ps1 | 4 ++++ src/utils.py | 7 ++++++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/scripts/compile_resources.ps1 b/scripts/compile_resources.ps1 index 6495dd33..2c15beff 100755 --- a/scripts/compile_resources.ps1 +++ b/scripts/compile_resources.ps1 @@ -9,4 +9,8 @@ pyuic6 './res/update_checker.ui' -o './src/gen/update_checker.py' pyside6-rcc './res/resources.qrc' -o './src/gen/resources_rc.py' Write-Host 'Generated code from .ui files' +$BUILD_NUMBER = Get-Date -Format yyMMddHHMMss +New-Item "$PSScriptRoot/../src/gen/build_number.py" -ItemType File -Force -Value "AUTOSPLIT_BUILD_NUMBER = `"$BUILD_NUMBER`"" | Out-Null +Write-Host "Generated build number: `"$BUILD_NUMBER`"" + Set-Location $originalDirectory diff --git a/src/utils.py b/src/utils.py index ab40e1a3..d7a20bca 100644 --- a/src/utils.py +++ b/src/utils.py @@ -11,6 +11,8 @@ from typing_extensions import TypeGuard from win32 import win32gui +from gen.build_number import AUTOSPLIT_BUILD_NUMBER + DWMWA_EXTENDED_FRAME_BOUNDS = 9 @@ -67,5 +69,8 @@ def wrapped(*args: Any, **kwargs: Any): """The directory of either AutoSplit.exe or AutoSplit.py""" # Shared strings -AUTOSPLIT_VERSION = "2.0.0-alpha.4" +# DIRTY_VERSION_EXTENSION = "" +DIRTY_VERSION_EXTENSION = "-" + AUTOSPLIT_BUILD_NUMBER +"""Set DIRTY_VERSION_EXTENSION to an empty string to generate a clean version number""" +AUTOSPLIT_VERSION = "2.0.0-alpha.4" + DIRTY_VERSION_EXTENSION START_AUTO_SPLITTER_TEXT = "Start Auto Splitter" From 92a9541bc9f2aa85de6161bcf1f4341d3c695cc4 Mon Sep 17 00:00:00 2001 From: Avasam Date: Thu, 14 Jul 2022 20:53:35 -0400 Subject: [PATCH 102/137] Generate hotkey attributes in AutoSplit --- src/AutoSplit.py | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 19e999fa..07705163 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -68,14 +68,6 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): CheckForUpdatesThread: Optional[QtCore.QThread] = None SettingsWidget: Optional[settings.Ui_DialogSettings] = None - # hotkeys need to be initialized to be passed as thread arguments in hotkeys.py - # and for type safety in both hotkeys.py and settings_file.py - split_hotkey: Optional[Callable[[], None]] = None - reset_hotkey: Optional[Callable[[], None]] = None - skip_split_hotkey: Optional[Callable[[], None]] = None - undo_split_hotkey: Optional[Callable[[], None]] = None - pause_hotkey: Optional[Callable[[], None]] = None - # Initialize a few attributes hwnd = 0 """Window Handle used for Capture Region""" @@ -124,6 +116,10 @@ def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-man self.width_spinbox.setFrame(False) self.height_spinbox.setFrame(False) + # hotkeys need to be initialized to be passed as thread arguments in hotkeys.py + for hotkey in HOTKEYS: + setattr(self, f"{hotkey}_hotkey", None) + # Get default values defined in SettingsDialog self.settings_dict = get_default_settings_from_ui(self) user_profile.load_check_for_updates_on_open(self) From cc76c91f63debf7b345b4b89eee00de4137fb3b1 Mon Sep 17 00:00:00 2001 From: Avasam Date: Thu, 14 Jul 2022 20:54:15 -0400 Subject: [PATCH 103/137] Added hotkey for disable auto reset image --- res/settings.ui | 52 ++++++++++++++++++++++++++++++++++++++++++--- src/AutoSplit.py | 1 - src/hotkeys.py | 7 ++++-- src/menu_bar.py | 1 + src/user_profile.py | 2 ++ 5 files changed, 57 insertions(+), 6 deletions(-) diff --git a/res/settings.ui b/res/settings.ui index 6a5d299d..57c2f5cd 100644 --- a/res/settings.ui +++ b/res/settings.ui @@ -50,7 +50,7 @@ 10 - 180 + 200 271 181 @@ -175,7 +175,7 @@ 10 - 370 + 390 271 241 @@ -406,7 +406,7 @@ It is highly recommended to NOT use pHash if you use masked images. It is very i 10 10 271 - 161 + 181 @@ -649,6 +649,52 @@ It is highly recommended to NOT use pHash if you use masked images. It is very i true + + + + 180 + 155 + 81 + 21 + + + + Qt::NoFocus + + + Set Hotkey + + + + + + 6 + 150 + 71 + 31 + + + + Disable auto +reset image + + + + + + 76 + 155 + 94 + 20 + + + + + + + true + + diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 07705163..15b9fbd1 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -6,7 +6,6 @@ import os import signal import sys -from collections.abc import Callable from time import time from types import FunctionType from typing import Optional diff --git a/src/hotkeys.py b/src/hotkeys.py index 9048dcd6..e8045009 100644 --- a/src/hotkeys.py +++ b/src/hotkeys.py @@ -20,8 +20,8 @@ Commands = Literal["split", "start", "pause", "reset", "skip", "undo"] -Hotkeys = Literal["split", "reset", "skip_split", "undo_split", "pause"] -HOTKEYS: list[Hotkeys] = ["split", "reset", "skip_split", "undo_split", "pause"] +Hotkeys = Literal["split", "reset", "skip_split", "undo_split", "pause", "disable_auto_reset_image"] +HOTKEYS: list[Hotkeys] = ["split", "reset", "skip_split", "undo_split", "pause", "disable_auto_reset_image"] def before_setting_hotkey(autosplit: AutoSplit): @@ -202,6 +202,9 @@ def __get_hotkey_action(autosplit: AutoSplit, hotkey: Hotkeys): return lambda: autosplit.skip_split(True) if hotkey == "undo_split": return lambda: autosplit.undo_split(True) + if hotkey == "disable_auto_reset_image": + return lambda: autosplit.disable_auto_reset_checkbox.setChecked( + not autosplit.disable_auto_reset_checkbox.isChecked()) return getattr(autosplit, f"{hotkey}_signal").emit # TODO: using getattr/setattr is NOT a good way to go about this. It was only temporarily done to diff --git a/src/menu_bar.py b/src/menu_bar.py index 9ddd113c..a7af39ed 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -279,6 +279,7 @@ def get_default_settings_from_ui(autosplit: AutoSplit): "undo_split_hotkey": default_settings_dialog.undo_split_input.text(), "skip_split_hotkey": default_settings_dialog.skip_split_input.text(), "pause_hotkey": default_settings_dialog.pause_input.text(), + "disable_auto_reset_image_hotkey": default_settings_dialog.disable_auto_reset_image_input.text(), "fps_limit": default_settings_dialog.fps_limit_spinbox.value(), "live_capture_region": default_settings_dialog.live_capture_region_checkbox.isChecked(), "capture_method": CAPTURE_METHODS.get_method_by_index( diff --git a/src/user_profile.py b/src/user_profile.py index ff7df78b..d1646434 100644 --- a/src/user_profile.py +++ b/src/user_profile.py @@ -23,6 +23,7 @@ class UserProfileDict(TypedDict): undo_split_hotkey: str skip_split_hotkey: str pause_hotkey: str + disable_auto_reset_image_hotkey: str fps_limit: int live_capture_region: bool capture_method: Union[str, CaptureMethodEnum] @@ -45,6 +46,7 @@ class UserProfileDict(TypedDict): undo_split_hotkey="", skip_split_hotkey="", pause_hotkey="", + disable_auto_reset_image_hotkey="", fps_limit=60, live_capture_region=True, capture_method=CAPTURE_METHODS.get_method_by_index(0), From 57a9c80fa3f9d4973a93d81fe2b813eaf3220393 Mon Sep 17 00:00:00 2001 From: Avasam Date: Thu, 14 Jul 2022 21:12:18 -0400 Subject: [PATCH 104/137] Updated doc for per-image comparison method --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f2d8782d..1f313c2f 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=Avasam_Auto-Split&metric=security_rating)](https://sonarcloud.io/dashboard?id=Avasam_Auto-Split) [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=Avasam_Auto-Split&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=Avasam_Auto-Split) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Avasam_Auto-Split&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Avasam_Auto-Split) -[![SemVer](https://badgen.net/badge/SemVer/SemVer/grey?label)](https://semver.org/) +[![SemVer](https://badgen.net/badge/_/SemVer%20compliant/grey?label)](https://semver.org/) Easy to use image comparison based auto splitter for speedrunning on console or PC. @@ -157,11 +157,15 @@ If this option is disabled, when the reset hotkey is hit, the reset button is pr - Custom thresholds are place between parenthesis `()` in the filename. This value will override the default threshold. - Custom pause times are placed between square brackets `[]` in the filename. This value will override the default pause time. - Custom delay times are placed between hash signs `##` in the filename. Note that these are in milliseconds. For example, a 10 second split delay would be `#10000#`. You cannot skip or undo splits during split delays. +- A different comparison method can be specified with their 0-base index between angular brackets `<>`: + - `<0>`: L2 Norm + - `<1>`: Histogram + - `<2>`: Perceptual Hash - Image loop amounts are placed between at symbols `@@` in the filename. For example, a specific image that you want to split 5 times in a row would be `@5@`. The current loop # is conveniently located beneath the current split image. - Flags are placed between curly brackets `{}` in the filename. Multiple flags are placed in the same set of curly brackets. Current available flags: - - {d} dummy split image. When matched, it moves to the next image without hitting your split hotkey. - - {b} split when similarity goes below the threshold rather than above. When a split image filename has this flag, the split image similarity will go above the threshold, do nothing, and then split the next time the similarity goes below the threshold. - - {p} pause flag. When a split image filename has this flag, it will hit your pause hotkey rather than your split hokey. + - `{d}` dummy split image. When matched, it moves to the next image without hitting your split hotkey. + - `{b}` split when similarity goes below the threshold rather than above. When a split image filename has this flag, the split image similarity will go above the threshold, do nothing, and then split the next time the similarity goes below the threshold. + - `{p}` pause flag. When a split image filename has this flag, it will hit your pause hotkey rather than your split hokey. - Filename examples: - `001_SplitName_(0.9)_[10].png` is a split image with a threshold of 0.9 and a pause time of 10 seconds. - `002_SplitName_(0.9)_[10]_{d}.png` is the second split image with a threshold of 0.9, pause time of 10, and is a dummy split. From 723bddae184bf72125cbd102d6da99ac0b01f2a9 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 16 Jul 2022 15:16:02 -0400 Subject: [PATCH 105/137] Added workflow_dispatch for manual triggers --- .github/workflows/lint-and-build.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/lint-and-build.yml b/.github/workflows/lint-and-build.yml index bf127b3f..87cad2e8 100644 --- a/.github/workflows/lint-and-build.yml +++ b/.github/workflows/lint-and-build.yml @@ -1,6 +1,7 @@ # https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions name: Lint and build on: + workflow_dispatch: push: branches: - main From c2b13244830d5c3d773acffcf557a5f2a1edab6c Mon Sep 17 00:00:00 2001 From: Avasam Date: Fri, 22 Jul 2022 16:29:38 -0400 Subject: [PATCH 106/137] update comparison_method_from_filename symbol --- README.md | 8 ++++---- src/split_parser.py | 5 ++++- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1f313c2f..3aa353a1 100644 --- a/README.md +++ b/README.md @@ -157,10 +157,10 @@ If this option is disabled, when the reset hotkey is hit, the reset button is pr - Custom thresholds are place between parenthesis `()` in the filename. This value will override the default threshold. - Custom pause times are placed between square brackets `[]` in the filename. This value will override the default pause time. - Custom delay times are placed between hash signs `##` in the filename. Note that these are in milliseconds. For example, a 10 second split delay would be `#10000#`. You cannot skip or undo splits during split delays. -- A different comparison method can be specified with their 0-base index between angular brackets `<>`: - - `<0>`: L2 Norm - - `<1>`: Histogram - - `<2>`: Perceptual Hash +- A different comparison method can be specified with their 0-base index between carets `^^`: + - `^0^`: L2 Norm + - `^1^`: Histogram + - `^2^`: Perceptual Hash - Image loop amounts are placed between at symbols `@@` in the filename. For example, a specific image that you want to split 5 times in a row would be `@5@`. The current loop # is conveniently located beneath the current split image. - Flags are placed between curly brackets `{}` in the filename. Multiple flags are placed in the same set of curly brackets. Current available flags: - `{d}` dummy split image. When matched, it moves to the next image without hitting your split hotkey. diff --git a/src/split_parser.py b/src/split_parser.py index e98a1eb6..854f892f 100644 --- a/src/split_parser.py +++ b/src/split_parser.py @@ -17,6 +17,9 @@ T = TypeVar("T", str, int, float) +# Note, the following symbols cannot be used in a filename: +# / \ : * ? " < > | + def __value_from_filename( filename: str, @@ -111,7 +114,7 @@ def comparison_method_from_filename(filename: str): # Check to make sure there is a valid delay time between brackets # of the filename - value = __value_from_filename(filename, "<>", -1) + value = __value_from_filename(filename, "^^", -1) # Comparison method should always be positive or zero return value if value >= 0 else None From 3894896412b39c5df5e1ea99929ee6449009a7c8 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 16 Jul 2022 10:04:56 -0400 Subject: [PATCH 107/137] Extract hwnd validation --- src/capture_method/BitBltCaptureMethod.py | 8 ++----- .../DesktopDuplicationCaptureMethod.py | 2 +- .../WindowsGraphicsCaptureMethod.py | 8 ++----- src/capture_method/interface.py | 4 +++- src/region_selection.py | 8 +++---- src/utils.py | 23 ++++++++++++++++--- 6 files changed, 31 insertions(+), 22 deletions(-) diff --git a/src/capture_method/BitBltCaptureMethod.py b/src/capture_method/BitBltCaptureMethod.py index e3893000..f608952f 100644 --- a/src/capture_method/BitBltCaptureMethod.py +++ b/src/capture_method/BitBltCaptureMethod.py @@ -12,7 +12,7 @@ from win32 import win32gui from capture_method.interface import CaptureMethodInterface -from utils import get_window_bounds +from utils import get_window_bounds, is_valid_hwnd if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -70,11 +70,7 @@ def get_frame(self, autosplit: AutoSplit): def recover_window(self, captured_window_title: str, autosplit: AutoSplit): hwnd = win32gui.FindWindow(None, captured_window_title) - # Don't fallback to desktop or whatever window obtained with "" - if not win32gui.IsWindow(hwnd) or not captured_window_title: + if not is_valid_hwnd(hwnd): return False autosplit.hwnd = hwnd return self.check_selected_region_exists(autosplit) - - def check_selected_region_exists(self, autosplit: AutoSplit): - return bool(win32gui.IsWindow(autosplit.hwnd) and win32gui.GetWindowText(autosplit.hwnd)) diff --git a/src/capture_method/DesktopDuplicationCaptureMethod.py b/src/capture_method/DesktopDuplicationCaptureMethod.py index fd216d3e..6a9234e8 100644 --- a/src/capture_method/DesktopDuplicationCaptureMethod.py +++ b/src/capture_method/DesktopDuplicationCaptureMethod.py @@ -23,7 +23,7 @@ def get_frame(self, autosplit: AutoSplit): selection = autosplit.settings_dict["capture_region"] hwnd = autosplit.hwnd hmonitor = ctypes.windll.user32.MonitorFromWindow(hwnd, win32con.MONITOR_DEFAULTTONEAREST) - if not hmonitor or not win32gui.IsWindow(hwnd): + if not hmonitor or not self.check_selected_region_exists(autosplit): return None, False left_bounds, top_bounds, *_ = get_window_bounds(hwnd) diff --git a/src/capture_method/WindowsGraphicsCaptureMethod.py b/src/capture_method/WindowsGraphicsCaptureMethod.py index 5e9bbe9e..59cdb4d6 100644 --- a/src/capture_method/WindowsGraphicsCaptureMethod.py +++ b/src/capture_method/WindowsGraphicsCaptureMethod.py @@ -14,7 +14,7 @@ from winsdk.windows.media.capture import MediaCapture from capture_method.interface import CaptureMethodInterface -from utils import WINDOWS_BUILD_NUMBER +from utils import WINDOWS_BUILD_NUMBER, is_valid_hwnd if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -121,8 +121,7 @@ async def coroutine(): def recover_window(self, captured_window_title: str, autosplit: AutoSplit): hwnd = win32gui.FindWindow(None, captured_window_title) - # Don't fallback to desktop or whatever window obtained with "" - if not win32gui.IsWindow(hwnd) or not captured_window_title: + if not is_valid_hwnd(hwnd): return False autosplit.hwnd = hwnd self.close(autosplit) @@ -134,6 +133,3 @@ def recover_window(self, captured_window_title: str, autosplit: AutoSplit): return False raise return self.check_selected_region_exists(autosplit) - - def check_selected_region_exists(self, autosplit: AutoSplit): - return bool(win32gui.IsWindow(autosplit.hwnd) and win32gui.GetWindowText(autosplit.hwnd)) diff --git a/src/capture_method/interface.py b/src/capture_method/interface.py index 24804129..b10e02f2 100644 --- a/src/capture_method/interface.py +++ b/src/capture_method/interface.py @@ -4,6 +4,8 @@ import cv2 +from utils import is_valid_hwnd + if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -32,4 +34,4 @@ def recover_window(self, captured_window_title: str, autosplit: AutoSplit) -> bo raise NotImplementedError() def check_selected_region_exists(self, autosplit: AutoSplit) -> bool: - raise NotImplementedError() + return is_valid_hwnd(autosplit.hwnd) diff --git a/src/region_selection.py b/src/region_selection.py index cf9809f1..b8d62a65 100644 --- a/src/region_selection.py +++ b/src/region_selection.py @@ -17,7 +17,7 @@ from winsdk.windows.graphics.capture import GraphicsCaptureItem, GraphicsCapturePicker import error_messages -from utils import get_window_bounds, is_valid_image +from utils import get_window_bounds, is_valid_hwnd, is_valid_image if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -90,8 +90,7 @@ def select_region(autosplit: AutoSplit): del selector hwnd, window_text = __get_window_from_point(x, y) - # Don't select desktop - if not win32gui.IsWindow(hwnd) or not window_text: + if not is_valid_hwnd(hwnd) or not window_text: error_messages.region() return @@ -123,8 +122,7 @@ def select_window(autosplit: AutoSplit): del selector hwnd, window_text = __get_window_from_point(x, y) - # Don't select desktop - if not win32gui.IsWindow(hwnd) or not window_text: + if not is_valid_hwnd(hwnd) or not window_text: error_messages.region() return diff --git a/src/utils.py b/src/utils.py index d7a20bca..3740ea28 100644 --- a/src/utils.py +++ b/src/utils.py @@ -3,9 +3,9 @@ import ctypes.wintypes import os import sys -from collections.abc import Callable +from collections.abc import Callable, Iterable from platform import version -from typing import Any, Optional, Union, cast +from typing import Any, Optional, TypeVar, Union, cast import cv2 from typing_extensions import TypeGuard @@ -36,7 +36,24 @@ def is_valid_image(image: Optional[cv2.Mat]) -> TypeGuard[cv2.Mat]: return image is not None and bool(image.size) -def get_window_bounds(hwnd: int): +def is_valid_hwnd(hwnd: int): + """Validate the hwnd points to a valid window and not the desktop or whatever window obtained with `\"\"`""" + if not hwnd: + return False + if sys.platform == "win32" and not (win32gui.IsWindow(hwnd) and win32gui.GetWindowText(hwnd)): + return False + return True + + +T = TypeVar("T") + + +def first(iterable: Iterable[T]) -> T: + """@return: The first element of a collection. Dictionaries will return the first key""" + return next(iter(iterable)) + + +def get_window_bounds(hwnd: int) -> tuple[int, int, int, int]: extended_frame_bounds = ctypes.wintypes.RECT() ctypes.windll.dwmapi.DwmGetWindowAttribute( hwnd, From 6a1349a58c6a7724dc353b8809377a5fbe224a25 Mon Sep 17 00:00:00 2001 From: Avasam Date: Fri, 22 Jul 2022 17:58:26 -0400 Subject: [PATCH 108/137] Fixed window recovery from loading profile and WGC --- .gitignore | 3 +++ scripts/compile_resources.ps1 | 2 +- src/capture_method/BitBltCaptureMethod.py | 2 +- src/capture_method/WindowsGraphicsCaptureMethod.py | 14 ++++++++++++-- src/user_profile.py | 6 ++---- src/utils.py | 4 ++-- 6 files changed, 21 insertions(+), 10 deletions(-) diff --git a/.gitignore b/.gitignore index 29db603f..84c492a0 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,8 @@ # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. +# Caches +.cache/ + # Byte-compiled / optimized / DLL files __pycache__/ diff --git a/scripts/compile_resources.ps1 b/scripts/compile_resources.ps1 index 2c15beff..a5584068 100755 --- a/scripts/compile_resources.ps1 +++ b/scripts/compile_resources.ps1 @@ -9,7 +9,7 @@ pyuic6 './res/update_checker.ui' -o './src/gen/update_checker.py' pyside6-rcc './res/resources.qrc' -o './src/gen/resources_rc.py' Write-Host 'Generated code from .ui files' -$BUILD_NUMBER = Get-Date -Format yyMMddHHMMss +$BUILD_NUMBER = Get-Date -Format yyMMddHHMM New-Item "$PSScriptRoot/../src/gen/build_number.py" -ItemType File -Force -Value "AUTOSPLIT_BUILD_NUMBER = `"$BUILD_NUMBER`"" | Out-Null Write-Host "Generated build number: `"$BUILD_NUMBER`"" diff --git a/src/capture_method/BitBltCaptureMethod.py b/src/capture_method/BitBltCaptureMethod.py index f608952f..f594ca3b 100644 --- a/src/capture_method/BitBltCaptureMethod.py +++ b/src/capture_method/BitBltCaptureMethod.py @@ -24,7 +24,7 @@ class BitBltCaptureMethod(CaptureMethodInterface): _render_full_content = False - def get_frame(self, autosplit: AutoSplit): + def get_frame(self, autosplit: AutoSplit) -> tuple[Optional[cv2.Mat], bool]: selection = autosplit.settings_dict["capture_region"] hwnd = autosplit.hwnd image: Optional[cv2.Mat] = None diff --git a/src/capture_method/WindowsGraphicsCaptureMethod.py b/src/capture_method/WindowsGraphicsCaptureMethod.py index 59cdb4d6..a430a117 100644 --- a/src/capture_method/WindowsGraphicsCaptureMethod.py +++ b/src/capture_method/WindowsGraphicsCaptureMethod.py @@ -31,7 +31,7 @@ class WindowsGraphicsCaptureMethod(CaptureMethodInterface): def __init__(self, autosplit: AutoSplit): super().__init__(autosplit) - if not self.check_selected_region_exists(autosplit): + if not is_valid_hwnd(autosplit.hwnd): return # Note: Must create in the same thread (can't use a global) otherwise when ran from LiveSplit it will raise: # OSError: The application called an interface that was marshalled for a different thread @@ -81,7 +81,9 @@ def close(self, autosplit: AutoSplit): def get_frame(self, autosplit: AutoSplit) -> tuple[Optional[cv2.Mat], bool]: selection = autosplit.settings_dict["capture_region"] # We still need to check the hwnd because WGC will return a blank black image - if not self.check_selected_region_exists(autosplit) or not self.frame_pool or not self.session: + if not (self.check_selected_region_exists(autosplit) + # Only needed for the type-checker + and self.frame_pool): return None, False try: @@ -89,6 +91,8 @@ def get_frame(self, autosplit: AutoSplit) -> tuple[Optional[cv2.Mat], bool]: # Frame pool is closed except OSError: return None, False + + # We were too fast and the next frame wasn't ready yet if not frame: return self.last_captured_frame, True @@ -133,3 +137,9 @@ def recover_window(self, captured_window_title: str, autosplit: AutoSplit): return False raise return self.check_selected_region_exists(autosplit) + + def check_selected_region_exists(self, autosplit: AutoSplit): + return bool( + is_valid_hwnd(autosplit.hwnd) + and self.frame_pool + and self.session) diff --git a/src/user_profile.py b/src/user_profile.py index ff7df78b..77ea79be 100644 --- a/src/user_profile.py +++ b/src/user_profile.py @@ -134,10 +134,8 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str set_hotkey(autosplit, hotkey, cast(str, autosplit.settings_dict[hotkey_name])) change_capture_method(cast(CaptureMethodEnum, autosplit.settings_dict["capture_method"]), autosplit) - if ( - not autosplit.capture_method.check_selected_region_exists(autosplit) - and autosplit.settings_dict["captured_window_title"] - ): + autosplit.capture_method.recover_window(autosplit.settings_dict["captured_window_title"], autosplit) + if not autosplit.capture_method.check_selected_region_exists(autosplit): autosplit.live_image.setText("Reload settings after opening" + f'\n"{autosplit.settings_dict["captured_window_title"]}"' + "\nto automatically load Capture Region") diff --git a/src/utils.py b/src/utils.py index 3740ea28..de07952c 100644 --- a/src/utils.py +++ b/src/utils.py @@ -40,8 +40,8 @@ def is_valid_hwnd(hwnd: int): """Validate the hwnd points to a valid window and not the desktop or whatever window obtained with `\"\"`""" if not hwnd: return False - if sys.platform == "win32" and not (win32gui.IsWindow(hwnd) and win32gui.GetWindowText(hwnd)): - return False + if sys.platform == "win32": + return bool(win32gui.IsWindow(hwnd) and win32gui.GetWindowText(hwnd)) return True From 7410a9fbbaa9a56ef4f7ddb88789a6a67e6917b3 Mon Sep 17 00:00:00 2001 From: Avasam Date: Fri, 22 Jul 2022 21:46:21 -0400 Subject: [PATCH 109/137] Updated build scripts --- .github/workflows/lint-and-build.yml | 63 +++++++++++++--------------- scripts/build.ps1 | 8 +--- scripts/compile_resources.ps1 | 2 +- scripts/install.ps1 | 21 ++++++---- 4 files changed, 46 insertions(+), 48 deletions(-) diff --git a/.github/workflows/lint-and-build.yml b/.github/workflows/lint-and-build.yml index 87cad2e8..2511e920 100644 --- a/.github/workflows/lint-and-build.yml +++ b/.github/workflows/lint-and-build.yml @@ -1,7 +1,7 @@ # https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions name: Lint and build on: - workflow_dispatch: + workflow_dispatch: # Allows manual builds push: branches: - main @@ -38,14 +38,9 @@ jobs: with: python-version: ${{ matrix.python-version }} cache: 'pip' - cache-dependency-path: 'scripts/requirements-dev.txt' - - run: pip install wheel --upgrade - - name: Install dependencies - run: | - pip install -r "scripts/requirements-dev.txt" - npm install -g pyright - npm list -g pyright - - run: scripts/compile_resources.ps1 + cache-dependency-path: 'scripts/requirements*.txt' + - run: scripts/install.ps1 + shell: pwsh - name: Analysing the code with Pyright run: pyright --warnings Pylint: @@ -62,11 +57,9 @@ jobs: with: python-version: ${{ matrix.python-version }} cache: 'pip' - cache-dependency-path: 'scripts/requirements-dev.txt' - - run: pip install wheel --upgrade - - name: Install dependencies - run: pip install -r "scripts/requirements-dev.txt" - - run: scripts/compile_resources.ps1 + cache-dependency-path: 'scripts/requirements*.txt' + - run: scripts/install.ps1 + shell: pwsh - name: Analysing the code with Pylint run: pylint --reports=y --output-format=colorized src/ Flake8: @@ -83,32 +76,26 @@ jobs: with: python-version: ${{ matrix.python-version }} cache: 'pip' - cache-dependency-path: 'scripts/requirements-dev.txt' - - run: pip install wheel --upgrade - - name: Install dependencies - run: pip install -r "scripts/requirements-dev.txt" - - run: scripts/compile_resources.ps1 + cache-dependency-path: 'scripts/requirements*.txt' + - run: scripts/install.ps1 + shell: pwsh - name: Analysing the code with Flake8 run: flake8 Bandit: runs-on: windows-latest strategy: fail-fast: false - matrix: - python-version: ["3.9", "3.10"] steps: - name: Checkout ${{ github.repository }}/${{ github.ref }} uses: actions/checkout@v3 - - name: Set up Python ${{ matrix.python-version }} + - name: Set up Python 3.10 uses: actions/setup-python@v4 with: - python-version: ${{ matrix.python-version }} + python-version: "3.10" cache: 'pip' - cache-dependency-path: 'scripts/requirements-dev.txt' - - run: pip install wheel --upgrade - - name: Install dependencies - run: pip install -r "scripts/requirements-dev.txt" - - run: scripts/compile_resources.ps1 + cache-dependency-path: 'scripts/requirements*.txt' + - run: scripts/install.ps1 + shell: pwsh - name: Analysing the code with Bandit run: bandit -n 1 --severity-level medium --recursive src Build: @@ -116,7 +103,7 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.9", "3.10"] + python-version: ["3.10"] steps: - name: Checkout ${{ github.repository }}/${{ github.ref }} uses: actions/checkout@v3 @@ -125,12 +112,22 @@ jobs: with: python-version: ${{ matrix.python-version }} cache: 'pip' - - run: pip install wheel --upgrade - - name: Install dependencies - run: pip install -r "scripts/requirements.txt" + - run: scripts/install.ps1 + shell: pwsh - run: scripts/build.ps1 + shell: pwsh - name: Upload Build Artifact uses: actions/upload-artifact@v3 with: name: AutoSplit (Python ${{ matrix.python-version }}) - path: dist/AutoSplit.exe + path: dist/AutoSplit* + if-no-files-found: error + - name: Upload Build logs + uses: actions/upload-artifact@v3 + with: + name: Build logs (Python ${{ matrix.python-version }}) + path: | + build/AutoSplit/*.toc + build/AutoSplit/*.txt + build/AutoSplit/*.html + if-no-files-found: error diff --git a/scripts/build.ps1 b/scripts/build.ps1 index 59b22626..b9b3e387 100755 --- a/scripts/build.ps1 +++ b/scripts/build.ps1 @@ -1,4 +1,5 @@ & "$PSScriptRoot/compile_resources.ps1" + pyinstaller ` --windowed ` --onefile ` @@ -6,10 +7,3 @@ pyinstaller ` --icon=res/icon.ico ` --splash=res/splash.png ` "$PSScriptRoot/../src/AutoSplit.py" - -If ($IsLinux) { - Move-Item $PSScriptRoot/../dist/AutoSplit $PSScriptRoot/../dist/AutoSplit.elf - If ($LastExitCode -eq 0) { - Write-Host 'Added .elf extension' - } -} diff --git a/scripts/compile_resources.ps1 b/scripts/compile_resources.ps1 index a5584068..a2369324 100755 --- a/scripts/compile_resources.ps1 +++ b/scripts/compile_resources.ps1 @@ -9,7 +9,7 @@ pyuic6 './res/update_checker.ui' -o './src/gen/update_checker.py' pyside6-rcc './res/resources.qrc' -o './src/gen/resources_rc.py' Write-Host 'Generated code from .ui files' -$BUILD_NUMBER = Get-Date -Format yyMMddHHMM +$BUILD_NUMBER = Get-Date -Format yyMMddHHmm New-Item "$PSScriptRoot/../src/gen/build_number.py" -ItemType File -Force -Value "AUTOSPLIT_BUILD_NUMBER = `"$BUILD_NUMBER`"" | Out-Null Write-Host "Generated build number: `"$BUILD_NUMBER`"" diff --git a/scripts/install.ps1 b/scripts/install.ps1 index e741c3d5..96fa9e73 100755 --- a/scripts/install.ps1 +++ b/scripts/install.ps1 @@ -1,9 +1,16 @@ -If ($IsLinux) { - sudo apt-get install python3-tk +# Installing Python dependencies +$dev = If ($env:GITHUB_JOB -eq 'Build') { '' } Else { '-dev' } +pip install wheel --upgrade +pip install -r "$PSScriptRoot/requirements$dev-win32.txt" + +# Don't compile resources on the Build CI job as it'll do so in build script +If ($dev) { + Write-Host "`n" + & "$PSScriptRoot/compile_resources.ps1" } -python -m pip install wheel --upgrade -python -m pip install -r "$PSScriptRoot/requirements-dev.txt" -& "$PSScriptRoot/compile_resources.ps1" -npm install -g pyright@latest -npm list -g pyright +# Only the Pyright job and local devs have node installed +if (-not $env:GITHUB_JOB -or $env:GITHUB_JOB -eq 'Pyright') { + npm install --location=global pyright@latest + npm list --location=global pyright +} From 0aed849be97a43b8ce722603cad9905654a1caa0 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 23 Jul 2022 02:19:52 -0400 Subject: [PATCH 110/137] Fixed crashes when opening from LiveSplit - NotImplementedError from the CaptureInterface - and OutOfRange errors from CaptureMethodDict --- scripts/install.ps1 | 2 +- src/capture_method/__init__.py | 25 +++++++++++++++++++++++++ src/capture_method/interface.py | 4 ++-- src/menu_bar.py | 2 +- src/user_profile.py | 12 ++++++++---- 5 files changed, 37 insertions(+), 8 deletions(-) diff --git a/scripts/install.ps1 b/scripts/install.ps1 index 96fa9e73..bf6123f8 100755 --- a/scripts/install.ps1 +++ b/scripts/install.ps1 @@ -1,7 +1,7 @@ # Installing Python dependencies $dev = If ($env:GITHUB_JOB -eq 'Build') { '' } Else { '-dev' } pip install wheel --upgrade -pip install -r "$PSScriptRoot/requirements$dev-win32.txt" +pip install -r "$PSScriptRoot/requirements$dev.txt" # Don't compile resources on the Build CI job as it'll do so in build script If ($dev) { diff --git a/src/capture_method/__init__.py b/src/capture_method/__init__.py index 5afc2ebe..9179d9e5 100644 --- a/src/capture_method/__init__.py +++ b/src/capture_method/__init__.py @@ -66,6 +66,7 @@ def __eq__(self, other: object): def __hash__(self): return self.value.__hash__() + NONE = "" BITBLT = "BITBLT" WINDOWS_GRAPHICS_CAPTURE = "WINDOWS_GRAPHICS_CAPTURE" PRINTWINDOW_RENDERFULLCONTENT = "PRINTWINDOW_RENDERFULLCONTENT" @@ -74,11 +75,35 @@ def __hash__(self): class CaptureMethodDict(OrderedDict[CaptureMethodEnum, CaptureMethodInfo]): + def get_method_by_index(self, index: int): + if len(self) <= 0: + return CaptureMethodEnum.NONE if index < 0: return next(iter(self)) return list(self.keys())[index] + def __getitem__(self, key: CaptureMethodEnum): + if key == CaptureMethodEnum.NONE: + return NONE_CAPTURE_METHOD + try: + return super().__getitem__(key) + # If requested method does not exists... + except KeyError: + try: + # ...fallback to the first one + return super().__getitem__(self.get_method_by_index(0)) + except KeyError: + # ...fallback to an empty capture method to avoid crashes + return NONE_CAPTURE_METHOD + + +NONE_CAPTURE_METHOD = CaptureMethodInfo( + name="None", + short_description="", + description="", + implementation=CaptureMethodInterface +) CAPTURE_METHODS = CaptureMethodDict({ CaptureMethodEnum.BITBLT: CaptureMethodInfo( diff --git a/src/capture_method/interface.py b/src/capture_method/interface.py index b10e02f2..d1646fd2 100644 --- a/src/capture_method/interface.py +++ b/src/capture_method/interface.py @@ -28,10 +28,10 @@ def get_frame(self, autosplit: AutoSplit) -> tuple[Optional[cv2.Mat], bool]: @return: The image of the region in the window in BGRA format """ - raise NotImplementedError() + return None, False def recover_window(self, captured_window_title: str, autosplit: AutoSplit) -> bool: - raise NotImplementedError() + return False def check_selected_region_exists(self, autosplit: AutoSplit) -> bool: return is_valid_hwnd(autosplit.hwnd) diff --git a/src/menu_bar.py b/src/menu_bar.py index 9ddd113c..adff9fea 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -194,7 +194,7 @@ def __init__(self, autosplit: AutoSplit): # Assuming all options take 2 lines (except camera and BitBlt which have 1). # And all lines take 16 pixels # And all separators take 2 pixels - doubled_len = 2 * len(capture_method_values) + doubled_len = 2 * len(capture_method_values) or 2 list_view.setMinimumHeight((doubled_len - 2) * 16 + doubled_len) list_view.setVerticalScrollBarPolicy(QtCore.Qt.ScrollBarPolicy.ScrollBarAlwaysOff) self.capture_method_combobox.setView(list_view) diff --git a/src/user_profile.py b/src/user_profile.py index 77ea79be..84a0889f 100644 --- a/src/user_profile.py +++ b/src/user_profile.py @@ -163,12 +163,16 @@ def load_settings_on_open(autosplit: AutoSplit): if file.endswith(".toml")] # Find all .tomls in AutoSplit folder, error if there is not exactly 1 + error = None if len(settings_files) < 1: - error_messages.no_settings_file_on_open() - return - if len(settings_files) > 1: - error_messages.too_many_settings_files_on_open() + error = error_messages.no_settings_file_on_open + elif len(settings_files) > 1: + error = error_messages.too_many_settings_files_on_open + if error: + change_capture_method(CAPTURE_METHODS.get_method_by_index(0), autosplit) + error() return + load_settings(autosplit, os.path.join(auto_split_directory, settings_files[0])) From 09b5c81cd031fc98e7db55d24ceb81be9c5ef770 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 23 Jul 2022 19:56:16 -0400 Subject: [PATCH 111/137] Completed cv2 error type stubs --- typings/cv2-stubs/Error.pyi | 110 +++++++++++++++++++++++++++++++++ typings/cv2-stubs/__init__.pyi | 12 +++- 2 files changed, 121 insertions(+), 1 deletion(-) create mode 100644 typings/cv2-stubs/Error.pyi diff --git a/typings/cv2-stubs/Error.pyi b/typings/cv2-stubs/Error.pyi new file mode 100644 index 00000000..f3cc4e03 --- /dev/null +++ b/typings/cv2-stubs/Error.pyi @@ -0,0 +1,110 @@ +BadAlign = -21 +BAD_ALIGN = -21 +BadAlphaChannel = -18 +BAD_ALPHA_CHANNEL = -18 +BadCOI = -24 +BAD_COI = -24 +BadCallBack = -22 +BAD_CALL_BACK = -22 +BadDataPtr = -12 +BAD_DATA_PTR = -12 +BadDepth = -17 +BAD_DEPTH = -17 +BadImageSize = -10 +BAD_IMAGE_SIZE = -10 +BadModelOrChSeq = -14 +BAD_MODEL_OR_CH_SEQ = -14 +BadNumChannel1U = -16 +BAD_NUM_CHANNEL1U = -16 +BadNumChannels = -15 +BAD_NUM_CHANNELS = -15 +BadOffset = -11 +BAD_OFFSET = -11 +BadOrder = -19 +BAD_ORDER = -19 +BadOrigin = -20 +BAD_ORIGIN = -20 +BadROISize = -25 +BAD_ROISIZE = -25 +BadStep = -13 +BAD_STEP = -13 +BadTileSize = -23 +BAD_TILE_SIZE = -23 +GpuApiCallError = -217 +GPU_API_CALL_ERROR = -217 +GpuNotSupported = -216 +GPU_NOT_SUPPORTED = -216 +HeaderIsNull = -9 +HEADER_IS_NULL = -9 +MaskIsTiled = -26 +MASK_IS_TILED = -26 +OpenCLApiCallError = -220 +OPEN_CLAPI_CALL_ERROR = -220 +OpenCLDoubleNotSupported = -221 +OPEN_CLDOUBLE_NOT_SUPPORTED = -221 +OpenCLInitError = -222 +OPEN_CLINIT_ERROR = -222 +OpenCLNoAMDBlasFft = -223 +OPEN_CLNO_AMDBLAS_FFT = -223 +OpenGlApiCallError = -219 +OPEN_GL_API_CALL_ERROR = -219 +OpenGlNotSupported = -218 +OPEN_GL_NOT_SUPPORTED = -218 +StsAssert = -215 +STS_ASSERT = -215 +StsAutoTrace = -8 +STS_AUTO_TRACE = -8 +StsBackTrace = -1 +STS_BACK_TRACE = -1 +StsBadArg = -5 +STS_BAD_ARG = -5 +StsBadFlag = -206 +STS_BAD_FLAG = -206 +StsBadFunc = -6 +STS_BAD_FUNC = -6 +StsBadMask = -208 +STS_BAD_MASK = -208 +StsBadMemBlock = -214 +STS_BAD_MEM_BLOCK = -214 +StsBadPoint = -207 +STS_BAD_POINT = -207 +StsBadSize = -201 +STS_BAD_SIZE = -201 +StsDivByZero = -202 +STS_DIV_BY_ZERO = -202 +StsError = -2 +STS_ERROR = -2 +StsFilterOffsetErr = -31 +STS_FILTER_OFFSET_ERR = -31 +StsFilterStructContentErr = -29 +STS_FILTER_STRUCT_CONTENT_ERR = -29 +StsInplaceNotSupported = -203 +STS_INPLACE_NOT_SUPPORTED = -203 +StsInternal = -3 +STS_INTERNAL = -3 +StsKernelStructContentErr = -30 +STS_KERNEL_STRUCT_CONTENT_ERR = -30 +StsNoConv = -7 +STS_NO_CONV = -7 +StsNoMem = -4 +STS_NO_MEM = -4 +StsNotImplemented = -213 +STS_NOT_IMPLEMENTED = -213 +StsNullPtr = -27 +STS_NULL_PTR = -27 +StsObjectNotFound = -204 +STS_OBJECT_NOT_FOUND = -204 +StsOk = 0 # noqa: Y015 +STS_OK = 0 # noqa: Y015 +StsOutOfRange = -211 +STS_OUT_OF_RANGE = -211 +StsParseError = -212 +STS_PARSE_ERROR = -212 +StsUnmatchedFormats = -205 +STS_UNMATCHED_FORMATS = -205 +StsUnmatchedSizes = -209 +STS_UNMATCHED_SIZES = -209 +StsUnsupportedFormat = -210 +STS_UNSUPPORTED_FORMAT = -210 +StsVecLengthErr = -28 +STS_VEC_LENGTH_ERR = -28 diff --git a/typings/cv2-stubs/__init__.pyi b/typings/cv2-stubs/__init__.pyi index 1c1af721..1d84fa2d 100644 --- a/typings/cv2-stubs/__init__.pyi +++ b/typings/cv2-stubs/__init__.pyi @@ -2,10 +2,13 @@ # Library: cv2, version: 4.4.0 # Module: cv2.cv2, version: 4.4.0 import builtins as _mod_builtins +from dataclasses import dataclass import typing import cv2 as _mod_cv2 import numpy as np +import cv2.Error as Error +__all__ = ["Error"] Mat = np.ndarray[int, np.dtype[np.generic]] @@ -2235,7 +2238,14 @@ def erode(src: Mat, kernel, dts: Mat = ..., anchor=..., iterations=..., borderTy "erode(src, kernel[, dst[, anchor[, iterations[, borderType[, borderValue]]]]]) -> dst\n. @brief Erodes an image by using a specific structuring element.\n. \n. The function erodes the source image using the specified structuring element that determines the\n. shape of a pixel neighborhood over which the minimum is taken:\n. \n. \\f[\\texttt{dst} (x,y) = \\min _{(x',y'): \\, \\texttt{element} (x',y') \\ne0 } \\texttt{src} (x+x',y+y')\\f]\n. \n. The function supports the in-place mode. Erosion can be applied several ( iterations ) times. In\n. case of multi-channel images, each channel is processed independently.\n. \n. @param src input image; the number of channels can be arbitrary, but the depth should be one of\n. CV_8U, CV_16U, CV_16S, CV_32F or CV_64F.\n. @param dst output image of the same size and type as src.\n. @param kernel structuring element used for erosion; if `element=Mat()`, a `3 x 3` rectangular\n. structuring element is used. Kernel can be created using #getStructuringElement.\n. @param anchor position of the anchor within the element; default value (-1, -1) means that the\n. anchor is at the element center.\n. @param iterations number of times erosion is applied.\n. @param borderType pixel extrapolation method, see #BorderTypes. #BORDER_WRAP is not supported.\n. @param borderValue border value in case of a constant border\n. @sa dilate, morphologyEx, getStructuringElement" ... -error = _mod_cv2.error +class error(Exception): + code: int + err: str + file: str + func: str + line: int + msg: str + def estimateAffine2D(from_, to, inliers=..., method: int = ..., ransacReprojThreshold=..., maxIters=..., confidence=..., refineIters=...) -> typing.Any: 'estimateAffine2D(from, to[, inliers[, method[, ransacReprojThreshold[, maxIters[, confidence[, refineIters]]]]]]) -> retval, inliers\n. @brief Computes an optimal affine transformation between two 2D point sets.\n. \n. It computes\n. \\f[\n. \\begin{bmatrix}\n. x\\\\\n. y\\\\\n. \\end{bmatrix}\n. =\n. \\begin{bmatrix}\n. a_{11} & a_{12}\\\\\n. a_{21} & a_{22}\\\\\n. \\end{bmatrix}\n. \\begin{bmatrix}\n. X\\\\\n. Y\\\\\n. \\end{bmatrix}\n. +\n. \\begin{bmatrix}\n. b_1\\\\\n. b_2\\\\\n. \\end{bmatrix}\n. \\f]\n. \n. @param from First input 2D point set containing \\f$(X,Y)\\f$.\n. @param to Second input 2D point set containing \\f$(x,y)\\f$.\n. @param inliers Output vector indicating which points are inliers (1-inlier, 0-outlier).\n. @param method Robust method used to compute transformation. The following methods are possible:\n. - cv::RANSAC - RANSAC-based robust method\n. - cv::LMEDS - Least-Median robust method\n. RANSAC is the default method.\n. @param ransacReprojThreshold Maximum reprojection error in the RANSAC algorithm to consider\n. a point as an inlier. Applies only to RANSAC.\n. @param maxIters The maximum number of robust method iterations.\n. @param confidence Confidence level, between 0 and 1, for the estimated transformation. Anything\n. between 0.95 and 0.99 is usually good enough. Values too close to 1 can slow down the estimation\n. significantly. Values lower than 0.8-0.9 can result in an incorrectly estimated transformation.\n. @param refineIters Maximum number of iterations of refining algorithm (Levenberg-Marquardt).\n. Passing 0 will disable refining, so the output matrix will be output of robust method.\n. \n. @return Output 2D affine transformation matrix \\f$2 \\times 3\\f$ or empty matrix if transformation\n. could not be estimated. The returned matrix has the following form:\n. \\f[\n. \\begin{bmatrix}\n. a_{11} & a_{12} & b_1\\\\\n. a_{21} & a_{22} & b_2\\\\\n. \\end{bmatrix}\n. \\f]\n. \n. The function estimates an optimal 2D affine transformation between two 2D point sets using the\n. selected robust algorithm.\n. \n. The computed transformation is then refined further (using only inliers) with the\n. Levenberg-Marquardt method to reduce the re-projection error even more.\n. \n. @note\n. The RANSAC method can handle practically any ratio of outliers but needs a threshold to\n. distinguish inliers from outliers. The method LMeDS does not need any threshold but it works\n. correctly only when there are more than 50% of inliers.\n. \n. @sa estimateAffinePartial2D, getAffineTransform' ... From 8581fcbc9fa2f8e48dd418ffb8086491b2e2f580 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 23 Jul 2022 20:03:21 -0400 Subject: [PATCH 112/137] Fixed error from trying to capture occupied capture device --- .vscode/settings.json | 3 ++- src/capture_method/VideoCaptureDeviceCaptureMethod.py | 9 ++++++++- src/capture_method/__init__.py | 6 +++--- src/compare.py | 2 +- 4 files changed, 14 insertions(+), 6 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index c249f12c..54a31a74 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -12,7 +12,8 @@ "editor.tabSize": 2, "editor.formatOnSave": true, "editor.codeActionsOnSave": { - "source.fixAll": true, + // FIXME: fixAll remove "unused" imports. Let's try to figure out why + "source.fixAll": false, "source.organizeImports": true, }, "files.insertFinalNewline": true, diff --git a/src/capture_method/VideoCaptureDeviceCaptureMethod.py b/src/capture_method/VideoCaptureDeviceCaptureMethod.py index fb737119..83bd3452 100644 --- a/src/capture_method/VideoCaptureDeviceCaptureMethod.py +++ b/src/capture_method/VideoCaptureDeviceCaptureMethod.py @@ -23,7 +23,14 @@ class VideoCaptureDeviceCaptureMethod(CaptureMethodInterface): def __read_loop(self, autosplit: AutoSplit): try: while not self.stop_thread.is_set(): - result, image = self.capture_device.read() + try: + result, image = self.capture_device.read() + except cv2.error as error: + if error.code != cv2.Error.STS_ERROR: + raise + # STS_ERROR most likely means the camera is occupied + result = False + image = None self.last_captured_frame = image if result else None self.is_old_image = False except Exception as exception: # pylint: disable=broad-except # We really want to catch everything here diff --git a/src/capture_method/__init__.py b/src/capture_method/__init__.py index 9179d9e5..bb42e031 100644 --- a/src/capture_method/__init__.py +++ b/src/capture_method/__init__.py @@ -214,9 +214,9 @@ async def get_camera_info(index: int, device_name: str): backend = "" try: # https://docs.opencv.org/3.4/d4/d15/group__videoio__flags__base.html#ga023786be1ee68a9105bf2e48c700294d - backend = video_capture.getBackendName() - video_capture.grab() - except cv2.error as error: # pyright: ignore [reportUnknownVariableType] + backend = video_capture.getBackendName() # STS_ASSERT + video_capture.grab() # STS_ERROR + except cv2.error as error: return CameraInfo(index, device_name, True, backend) \ if error.code in (cv2.Error.STS_ERROR, cv2.Error.STS_ASSERT) \ else None diff --git a/src/compare.py b/src/compare.py index 44739d45..efaa313c 100644 --- a/src/compare.py +++ b/src/compare.py @@ -114,7 +114,7 @@ def check_if_image_has_transparency(image: cv2.Mat): # 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 - mean: float = np.mean(image[:, :, 3]) + mean: float = np.mean(image[:, :, 3]) # pyright: ignore [reportGeneralTypeIssues] if mean == 0: # Non-transparent images code path is usually faster and simpler, so let's return that return False From 4ce5a736516ee184efca07e8b91937c5527675d3 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 23 Jul 2022 23:32:06 -0400 Subject: [PATCH 113/137] Updated some settigns and linters --- .flake8 | 2 +- .vscode/settings.json | 9 ++++++--- scripts/requirements-dev.txt | 9 ++++++--- scripts/requirements.txt | 3 +-- src/capture_method/WindowsGraphicsCaptureMethod.py | 2 +- src/compare.py | 2 +- src/menu_bar.py | 2 +- src/utils.py | 8 ++++++-- typings/imagehash/__init__.pyi | 4 ++-- typings/keyboard/_keyboard_event.pyi | 2 -- 10 files changed, 25 insertions(+), 18 deletions(-) diff --git a/.flake8 b/.flake8 index 147db040..3b8e475f 100644 --- a/.flake8 +++ b/.flake8 @@ -23,4 +23,4 @@ ignore-names=closeEvent,paintEvent,keyPressEvent,mousePressEvent,mouseMoveEvent, ; McCabe max-complexity is also taken care of by Pylint and doesn't fail the build there ; So this is the hard limit max-complexity=32 -inline-quotes=" +inline-quotes=double diff --git a/.vscode/settings.json b/.vscode/settings.json index 54a31a74..18f24f81 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -12,8 +12,7 @@ "editor.tabSize": 2, "editor.formatOnSave": true, "editor.codeActionsOnSave": { - // FIXME: fixAll remove "unused" imports. Let's try to figure out why - "source.fixAll": false, + "source.fixAll": true, "source.organizeImports": true, }, "files.insertFinalNewline": true, @@ -54,7 +53,11 @@ // 88, // Black default 99, // PEP8-17 acceptable max 120, // Our hard rule - ] + ], + "editor.codeActionsOnSave": { + // This removes "unused" imports. https://github.com/microsoft/pylance-release/issues/3091 + "source.fixAll": false, + }, }, "python.linting.enabled": true, "python.linting.pylintEnabled": true, diff --git a/scripts/requirements-dev.txt b/scripts/requirements-dev.txt index b0c84c99..2365b95a 100644 --- a/scripts/requirements-dev.txt +++ b/scripts/requirements-dev.txt @@ -1,16 +1,19 @@ # Dependencies -r requirements.txt # -# Linting, formatters and Types +# Linting and formatters bandit isort flake8 -flake8-pyi +flake8-pyi>=22.7 # New checks flake8-quotes flake8-isort -pylint>=2.13.9 +pep8-naming +pylint>=2.13.9 # Respect ignore configuration options with --recursive=y +# Types git+https://github.com/Avasam/pywin32-stubs.git#egg=pywin32-stubs # https://github.com/kaluluosi/pywin32-stubs/pull/8 types-requests +typing-extensions # # You can comment this out if you don't want to run `designer.bat` to quickly open the bundled PyQt Designer. # Can also be downloaded externally as a non-python package diff --git a/scripts/requirements.txt b/scripts/requirements.txt index a6dfc4fe..314dfb8f 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -10,7 +10,7 @@ # Creating AutoSplit.exe with PyInstaller: ./scripts/build.ps1 # # Dependencies: -numpy>=1.22.0rc1,<1.23 # Type issue +numpy>=1.21.4 # Python 3.10 support opencv-python-headless>=4.5.4,<4.6 # https://github.com/pyinstaller/pyinstaller/issues/6889 PyQt6>=6.2.1 PySide6 @@ -24,7 +24,6 @@ certifi toml psutil pygrabber -typing-extensions # Windows-only pywin32>=301 winsdk>=v1.0.0b4 diff --git a/src/capture_method/WindowsGraphicsCaptureMethod.py b/src/capture_method/WindowsGraphicsCaptureMethod.py index a430a117..04fd41d1 100644 --- a/src/capture_method/WindowsGraphicsCaptureMethod.py +++ b/src/capture_method/WindowsGraphicsCaptureMethod.py @@ -74,7 +74,7 @@ def close(self, autosplit: AutoSplit): # OSError: The application called an interface that was marshalled for a different thread # This still seems to close the session and prevent the following hard crash in LiveSplit # pylint: disable=line-too-long - # "AutoSplit.exe " # noqa: E501 + # "AutoSplit.exe " # noqa E501 pass self.session = None diff --git a/src/compare.py b/src/compare.py index efaa313c..44739d45 100644 --- a/src/compare.py +++ b/src/compare.py @@ -114,7 +114,7 @@ def check_if_image_has_transparency(image: cv2.Mat): # 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 - mean: float = np.mean(image[:, :, 3]) # pyright: ignore [reportGeneralTypeIssues] + mean: float = np.mean(image[:, :, 3]) if mean == 0: # Non-transparent images code path is usually faster and simpler, so let's return that return False diff --git a/src/menu_bar.py b/src/menu_bar.py index adff9fea..aa382b96 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -14,7 +14,7 @@ import user_profile from capture_method import (CAPTURE_METHODS, CameraInfo, CaptureMethodEnum, change_capture_method, get_all_video_capture_devices) -from gen import about, design, resources_rc, settings as settings_ui, update_checker # noqa: F401 +from gen import about, design, resources_rc, settings as settings_ui, update_checker # noqa F401 from hotkeys import HOTKEYS, Hotkeys, set_hotkey from utils import AUTOSPLIT_VERSION, FIRST_WIN_11_BUILD, WINDOWS_BUILD_NUMBER, decimal diff --git a/src/utils.py b/src/utils.py index de07952c..5f52e6d4 100644 --- a/src/utils.py +++ b/src/utils.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import asyncio import ctypes import ctypes.wintypes @@ -5,14 +7,16 @@ import sys from collections.abc import Callable, Iterable from platform import version -from typing import Any, Optional, TypeVar, Union, cast +from typing import TYPE_CHECKING, Any, Optional, TypeVar, Union, cast import cv2 -from typing_extensions import TypeGuard from win32 import win32gui from gen.build_number import AUTOSPLIT_BUILD_NUMBER +if TYPE_CHECKING: + from typing_extensions import TypeGuard + DWMWA_EXTENDED_FRAME_BOUNDS = 9 diff --git a/typings/imagehash/__init__.pyi b/typings/imagehash/__init__.pyi index 5e7ee80c..a2866bdb 100644 --- a/typings/imagehash/__init__.pyi +++ b/typings/imagehash/__init__.pyi @@ -3,7 +3,7 @@ This type stub file was generated by pyright. https://github.com/JohannesBuchner/imagehash/issues/151 """ -from __future__ import absolute_import, annotations, division, print_function +from __future__ import absolute_import, division, print_function from PIL import Image @@ -80,7 +80,7 @@ class ImageMultiHash: def __ne__(self, other) -> bool: ... - def __sub__(self, other, hamming_cutoff=..., bit_error_rate=...) -> int | float: + def __sub__(self, other, hamming_cutoff=..., bit_error_rate=...) -> float: ... def __hash__(self) -> int: diff --git a/typings/keyboard/_keyboard_event.pyi b/typings/keyboard/_keyboard_event.pyi index b5725f33..900a65d5 100644 --- a/typings/keyboard/_keyboard_event.pyi +++ b/typings/keyboard/_keyboard_event.pyi @@ -2,8 +2,6 @@ This type stub file was generated by pyright. https://github.com/boppreh/keyboard/issues/505 """ -from __future__ import annotations - from typing import Any, Literal Unknown = Any From 0d26e5806bee7c0ba6b07417860c5b6b3f294128 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sun, 24 Jul 2022 19:08:08 -0400 Subject: [PATCH 114/137] Completed fire_and_forget implementation --- src/hotkeys.py | 6 +++--- src/menu_bar.py | 10 +++++----- src/utils.py | 14 +++++++++++++- 3 files changed, 21 insertions(+), 9 deletions(-) diff --git a/src/hotkeys.py b/src/hotkeys.py index 9048dcd6..d608669c 100644 --- a/src/hotkeys.py +++ b/src/hotkeys.py @@ -1,13 +1,12 @@ from __future__ import annotations from collections.abc import Callable -from threading import Thread from typing import TYPE_CHECKING, Literal, Optional, Union import keyboard import pyautogui -from utils import START_AUTO_SPLITTER_TEXT, is_digit +from utils import START_AUTO_SPLITTER_TEXT, fire_and_forget, is_digit if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -217,6 +216,7 @@ def set_hotkey(autosplit: AutoSplit, hotkey: Hotkeys, preselected_hotkey_name: s # New thread points to callback. this thread is needed or GUI will freeze # while the program waits for user input on the hotkey + @fire_and_forget def callback(): hotkey_name = preselected_hotkey_name if preselected_hotkey_name else __read_hotkey() @@ -248,4 +248,4 @@ def callback(): # Try to remove the previously set hotkey if there is one. _unhook(getattr(autosplit, f"{hotkey}_hotkey")) - Thread(target=callback).start() + callback() diff --git a/src/menu_bar.py b/src/menu_bar.py index aa382b96..514f4c5d 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -2,7 +2,6 @@ import asyncio import webbrowser -from threading import Thread from typing import TYPE_CHECKING, Any, Union, cast import requests @@ -16,7 +15,7 @@ get_all_video_capture_devices) from gen import about, design, resources_rc, settings as settings_ui, update_checker # noqa F401 from hotkeys import HOTKEYS, Hotkeys, set_hotkey -from utils import AUTOSPLIT_VERSION, FIRST_WIN_11_BUILD, WINDOWS_BUILD_NUMBER, decimal +from utils import AUTOSPLIT_VERSION, FIRST_WIN_11_BUILD, WINDOWS_BUILD_NUMBER, decimal, fire_and_forget if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -152,8 +151,9 @@ def __capture_device_changed(self): if self.autosplit.settings_dict["capture_method"] == CaptureMethodEnum.VIDEO_CAPTURE_DEVICE: change_capture_method(CaptureMethodEnum.VIDEO_CAPTURE_DEVICE, self.autosplit) - async def __set_all_capture_devices(self): - self.__video_capture_devices = await get_all_video_capture_devices() + @fire_and_forget + def __set_all_capture_devices(self): + self.__video_capture_devices = asyncio.run(get_all_video_capture_devices()) if len(self.__video_capture_devices) > 0: for i in range(self.capture_device_combobox.count()): self.capture_device_combobox.removeItem(i) @@ -183,7 +183,7 @@ def __init__(self, autosplit: AutoSplit): # region Build the Capture method combobox capture_method_values = CAPTURE_METHODS.values() - Thread(target=lambda: asyncio.run(self.__set_all_capture_devices())).start() + self.__set_all_capture_devices() capture_list_items = [ f"- {method.name} ({method.short_description})" for method in capture_method_values diff --git a/src/utils.py b/src/utils.py index 5f52e6d4..ea167fcf 100644 --- a/src/utils.py +++ b/src/utils.py @@ -7,6 +7,7 @@ import sys from collections.abc import Callable, Iterable from platform import version +from threading import Thread from typing import TYPE_CHECKING, Any, Optional, TypeVar, Union, cast import cv2 @@ -73,8 +74,19 @@ def get_window_bounds(hwnd: int) -> tuple[int, int, int, int]: return window_left_bounds, window_top_bounds, window_width, window_height -def fire_and_forget(func: Callable[..., None]): +def fire_and_forget(func: Callable[..., Any]): + """ + Runs synchronous function asynchronously without waiting for a response + + Uses threads on Windows because `RuntimeError: There is no current event loop in thread 'MainThread'.` + + Uses asyncio on Linux because of a `Segmentation fault (core dumped)` + """ def wrapped(*args: Any, **kwargs: Any): + if sys.platform == "win32": + thread = Thread(target=func, args=args, kwargs=kwargs) + thread.start() + return thread return asyncio.get_event_loop().run_in_executor(None, func, *args, *kwargs) return wrapped From 7eed44481a36bf61fc3d6102264643bcd333de38 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sun, 24 Jul 2022 20:45:30 -0400 Subject: [PATCH 115/137] Fixed a few focus and tabstop issues --- res/about.ui | 3 +++ res/settings.ui | 17 ++++++++++------- src/hotkeys.py | 5 ++++- src/menu_bar.py | 5 ++++- 4 files changed, 21 insertions(+), 9 deletions(-) diff --git a/res/about.ui b/res/about.ui index d128ab6b..05e4914a 100644 --- a/res/about.ui +++ b/res/about.ui @@ -128,6 +128,9 @@ consider donating. Thank you! true + icon_label + version_label + created_by_label diff --git a/res/settings.ui b/res/settings.ui index 6a5d299d..decb2a63 100644 --- a/res/settings.ui +++ b/res/settings.ui @@ -652,17 +652,20 @@ It is highly recommended to NOT use pHash if you use masked images. It is very i - split_input - reset_input - undo_split_input - skip_split_input - pause_input + set_split_hotkey_button + set_reset_hotkey_button + set_undo_split_hotkey_button + set_skip_split_hotkey_button + set_pause_hotkey_button + fps_limit_spinbox + live_capture_region_checkbox + capture_method_combobox + capture_device_combobox default_comparison_method default_similarity_threshold_spinbox + default_delay_time_spinbox default_pause_time_spinbox loop_splits_checkbox - fps_limit_spinbox - live_capture_region_checkbox diff --git a/src/hotkeys.py b/src/hotkeys.py index d608669c..f5f006fb 100644 --- a/src/hotkeys.py +++ b/src/hotkeys.py @@ -1,10 +1,11 @@ from __future__ import annotations from collections.abc import Callable -from typing import TYPE_CHECKING, Literal, Optional, Union +from typing import TYPE_CHECKING, Literal, Optional, Union, cast import keyboard import pyautogui +from PyQt6 import QtWidgets from utils import START_AUTO_SPLITTER_TEXT, fire_and_forget, is_digit @@ -209,6 +210,8 @@ def __get_hotkey_action(autosplit: AutoSplit, hotkey: Hotkeys): def set_hotkey(autosplit: AutoSplit, hotkey: Hotkeys, preselected_hotkey_name: str = ""): if autosplit.SettingsWidget: + # Unfocus all fields + cast(QtWidgets.QDialog, autosplit.SettingsWidget).setFocus() getattr(autosplit.SettingsWidget, f"set_{hotkey}_hotkey_button").setText(PRESS_A_KEY_TEXT) # Disable some buttons diff --git a/src/menu_bar.py b/src/menu_bar.py index 514f4c5d..14df8ca6 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -48,6 +48,7 @@ def __init__(self, latest_version: str, design_window: design.Ui_MainWindow, che self.design_window = design_window if version_parse(latest_version) > version_parse(AUTOSPLIT_VERSION): self.do_not_ask_again_checkbox.setVisible(check_on_open) + self.left_button.setFocus() self.show() elif not check_on_open: self.update_status_label.setText("You are on the latest AutoSplit version.") @@ -171,6 +172,7 @@ def __set_all_capture_devices(self): def __init__(self, autosplit: AutoSplit): super().__init__() self.setupUi(self) + self.autosplit = autosplit # Spinbox frame disappears and reappears on Windows 11. It's much cleaner to just disable them. # Most likely related: https://bugreports.qt.io/browse/QTBUG-95215?jql=labels%20%3D%20Windows11 # Arrow buttons tend to move a lot as well @@ -179,7 +181,8 @@ def __init__(self, autosplit: AutoSplit): self.default_similarity_threshold_spinbox.setFrame(False) self.default_delay_time_spinbox.setFrame(False) self.default_pause_time_spinbox.setFrame(False) - self.autosplit = autosplit + # Don't autofocus any particular field + self.setFocus() # region Build the Capture method combobox capture_method_values = CAPTURE_METHODS.values() From 3683954e69f8e862a374e95cb3fbee6d5d1c37ed Mon Sep 17 00:00:00 2001 From: Avasam Date: Sun, 24 Jul 2022 21:57:46 -0400 Subject: [PATCH 116/137] Fix numpy typing --- src/compare.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/compare.py b/src/compare.py index 44739d45..8a91347a 100644 --- a/src/compare.py +++ b/src/compare.py @@ -1,7 +1,7 @@ from __future__ import annotations from math import sqrt -from typing import Optional +from typing import Any, Optional, cast import cv2 import imagehash # https://github.com/JohannesBuchner/imagehash/issues/151 @@ -114,7 +114,8 @@ def check_if_image_has_transparency(image: cv2.Mat): # 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 - mean: float = np.mean(image[:, :, 3]) + # Needs casting for numpy>=1.23 https://github.com/numpy/numpy/issues/20099 + mean: float = np.mean(cast(Any, image[:, :, 3])) if mean == 0: # Non-transparent images code path is usually faster and simpler, so let's return that return False From 18810191cb11fb84fdaeefc6b2e9137195cef161 Mon Sep 17 00:00:00 2001 From: Avasam Date: Mon, 25 Jul 2022 19:10:18 -0400 Subject: [PATCH 117/137] Prefer asyncio over threads --- .vscode/launch.json | 13 ++++++++++ .vscode/tasks.json | 7 +++++- src/AutoControlledWorker.py | 45 ---------------------------------- src/AutoSplit.py | 24 ++++++------------ src/auto_control.py | 40 ++++++++++++++++++++++++++++++ src/capture_method/__init__.py | 16 +++++++++++- src/menu_bar.py | 38 +++++++--------------------- src/utils.py | 23 ++++++++--------- 8 files changed, 103 insertions(+), 103 deletions(-) delete mode 100644 src/AutoControlledWorker.py create mode 100644 src/auto_control.py diff --git a/.vscode/launch.json b/.vscode/launch.json index dec98523..db52528d 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -8,9 +8,22 @@ "name": "Python: AutoSplit", "type": "python", "request": "launch", + "preLaunchTask": "Compile resources", "program": "src/AutoSplit.py", "console": "integratedTerminal", "justMyCode": true + }, + { + "name": "Python: AutoSplit --auto-controlled", + "type": "python", + "request": "launch", + "preLaunchTask": "Compile resources", + "program": "src/AutoSplit.py", + "args": [ + "--auto-controlled" + ], + "console": "integratedTerminal", + "justMyCode": true } ] } diff --git a/.vscode/tasks.json b/.vscode/tasks.json index 26a9e03d..69828ccd 100644 --- a/.vscode/tasks.json +++ b/.vscode/tasks.json @@ -1,6 +1,11 @@ { "version": "2.0.0", "tasks": [ + { + "label": "Compile resources", + "type": "shell", + "command": "scripts/compile_resources.ps1" + }, { "label": "Build AutoSplit", "type": "shell", @@ -10,5 +15,5 @@ "isDefault": true } } - ], + ] } diff --git a/src/AutoControlledWorker.py b/src/AutoControlledWorker.py deleted file mode 100644 index 5b3238c1..00000000 --- a/src/AutoControlledWorker.py +++ /dev/null @@ -1,45 +0,0 @@ -from __future__ import annotations - -from typing import TYPE_CHECKING - -from PyQt6 import QtCore - -import error_messages -import user_profile - -if TYPE_CHECKING: - from AutoSplit import AutoSplit - - -class AutoControlledWorker(QtCore.QObject): - def __init__(self, autosplit: AutoSplit): - self.autosplit = autosplit - super().__init__() - - def run(self): - while True: - try: - line = input() - except RuntimeError: - self.autosplit.show_error_signal.emit(error_messages.stdin_lost) - break - except EOFError: - continue - # This is for use in a Development environment - if line == "kill": - self.autosplit.closeEvent() - break - if line == "start": - self.autosplit.start_auto_splitter() - elif line in {"split", "skip"}: - self.autosplit.skip_split_signal.emit() - elif line == "undo": - self.autosplit.undo_split_signal.emit() - elif line == "reset": - self.autosplit.reset_signal.emit() - elif line.startswith("settings"): - # Allow for any split character between "settings" and the path - user_profile.load_settings(self.autosplit, line[9:]) - # TODO: Not yet implemented in AutoSplit Integration - # elif line == 'pause': - # self.pause_signal.emit() diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 15b9fbd1..47836845 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -2,6 +2,7 @@ # -*- coding: utf-8 -*- from __future__ import annotations +import asyncio import ctypes import os import signal @@ -19,13 +20,12 @@ import error_messages import user_profile -from AutoControlledWorker import AutoControlledWorker +from auto_control import start_auto_control_loop from AutoSplitImage import COMPARISON_RESIZE, START_KEYWORD, AutoSplitImage, ImageType from capture_method import CaptureMethodEnum, CaptureMethodInterface from gen import about, design, settings, update_checker from hotkeys import HOTKEYS, after_setting_hotkey, send_command -from menu_bar import (check_for_updates, get_default_settings_from_ui, open_about, open_settings, open_update_checker, - view_help) +from menu_bar import check_for_updates, get_default_settings_from_ui, open_about, open_settings, view_help from region_selection import align_region, select_region, select_window, validate_before_parsing from split_parser import BELOW_FLAG, DUMMY_FLAG, PAUSE_FLAG, parse_and_validate_images from user_profile import DEFAULT_PROFILE @@ -64,7 +64,6 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): # Widgets AboutWidget: Optional[about.Ui_AboutAutoSplitWidget] = None UpdateCheckerWidget: Optional[update_checker.Ui_UpdateChecker] = None - CheckForUpdatesThread: Optional[QtCore.QThread] = None SettingsWidget: Optional[settings.Ui_DialogSettings] = None # Initialize a few attributes @@ -95,7 +94,7 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): reset_image: Optional[AutoSplitImage] = None split_images: list[AutoSplitImage] = [] split_image: Optional[AutoSplitImage] = None - update_auto_control: Optional[QtCore.QThread] = None + auto_control_loop: Optional[asyncio.Future[None]] = None def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-many-statements super().__init__(parent) @@ -137,7 +136,6 @@ def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-man self.SettingsWidget.skip_split_input.setEnabled(False) self.SettingsWidget.undo_split_input.setEnabled(False) self.SettingsWidget.pause_input.setEnabled(False) - if self.is_auto_controlled: self.start_auto_splitter_button.setEnabled(False) @@ -146,11 +144,7 @@ def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-man print(f"{AUTOSPLIT_VERSION}\n{os.getpid()}", flush=True) # Use and Start the thread that checks for updates from LiveSplit - self.update_auto_control = QtCore.QThread() - worker = AutoControlledWorker(self) - worker.moveToThread(self.update_auto_control) - self.update_auto_control.started.connect(worker.run) - self.update_auto_control.start() + self.auto_control_loop = start_auto_control_loop(self) # split image folder line edit text self.split_image_folder_input.setText("No Folder Selected") @@ -183,8 +177,6 @@ def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-man # connect signals to functions self.after_setting_hotkey_signal.connect(lambda: after_setting_hotkey(self)) self.start_auto_splitter_signal.connect(self.__auto_splitter) - self.update_checker_widget_signal.connect(lambda latest_version, check_on_open: - open_update_checker(self, latest_version, check_on_open)) self.load_start_image_signal.connect(self.__load_start_image) self.load_start_image_signal[bool].connect(self.__load_start_image) self.load_start_image_signal[bool, bool].connect(self.__load_start_image) @@ -819,8 +811,8 @@ def closeEvent(self, a0: Optional[QtGui.QCloseEvent] = None): """ def exit_program(): - if self.update_auto_control: - self.update_auto_control.terminate() + if self.auto_control_loop: + self.auto_control_loop.cancel() if a0 is not None: a0.accept() if self.is_auto_controlled: @@ -828,7 +820,7 @@ def exit_program(): os.kill(os.getpid(), signal.SIGINT) sys.exit() - # Simulates LiveSplit quitting without asking. See "TODO" at update_auto_control Worker + # Simulates LiveSplit quitting without asking. See "TODO" at auto_control_loop Worker # This also more gracefully exits LiveSplit # Users can still manually save their settings if a0 is None: diff --git a/src/auto_control.py b/src/auto_control.py new file mode 100644 index 00000000..eab0ad8b --- /dev/null +++ b/src/auto_control.py @@ -0,0 +1,40 @@ +from __future__ import annotations + +from typing import TYPE_CHECKING + +import error_messages +import user_profile +from utils import fire_and_forget + +if TYPE_CHECKING: + from AutoSplit import AutoSplit + + +@fire_and_forget +def start_auto_control_loop(autosplit: AutoSplit): + while True: + try: + line = input() + except RuntimeError: + autosplit.show_error_signal.emit(error_messages.stdin_lost) + break + except EOFError: + continue + # This is for use in a Development environment + if line == "kill": + autosplit.closeEvent() + break + if line == "start": + autosplit.start_auto_splitter() + elif line in {"split", "skip"}: + autosplit.skip_split_signal.emit() + elif line == "undo": + autosplit.undo_split_signal.emit() + elif line == "reset": + autosplit.reset_signal.emit() + elif line.startswith("settings"): + # Allow for any split character between "settings" and the path + user_profile.load_settings(autosplit, line[9:]) + # TODO: Not yet implemented in AutoSplit Integration + # elif line == 'pause': + # autosplit.pause_signal.emit() diff --git a/src/capture_method/__init__.py b/src/capture_method/__init__.py index bb42e031..820bfe4c 100644 --- a/src/capture_method/__init__.py +++ b/src/capture_method/__init__.py @@ -4,7 +4,7 @@ from collections import OrderedDict from dataclasses import dataclass from enum import Enum, EnumMeta, unique -from typing import TYPE_CHECKING, TypedDict +from typing import TYPE_CHECKING, TypedDict, Union, cast import cv2 from pygrabber.dshow_graph import FilterGraph @@ -76,7 +76,21 @@ def __hash__(self): class CaptureMethodDict(OrderedDict[CaptureMethodEnum, CaptureMethodInfo]): + def get_index(self, capture_method: Union[str, CaptureMethodEnum]): + """ + Returns 0 if the capture_method is invalid or unsupported + """ + try: + return list(self.keys()).index(cast(CaptureMethodEnum, capture_method)) + except ValueError: + return 0 + def get_method_by_index(self, index: int): + """ + Returns first (default) capture method if the index is invalid. + + Returns `CaptureMethodEnum.NONE` if there are no capture method available. + """ if len(self) <= 0: return CaptureMethodEnum.NONE if index < 0: diff --git a/src/menu_bar.py b/src/menu_bar.py index bba9ddda..bea51240 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -2,7 +2,7 @@ import asyncio import webbrowser -from typing import TYPE_CHECKING, Any, Union, cast +from typing import TYPE_CHECKING, Any, cast import requests from packaging.version import parse as version_parse @@ -76,35 +76,15 @@ def view_help(): webbrowser.open("https://github.com/Toufool/Auto-Split#tutorial") -class __CheckForUpdatesThread(QtCore.QThread): - def __init__(self, autosplit: AutoSplit, check_on_open: bool): - super().__init__() - self.autosplit = autosplit - self.check_on_open = check_on_open - - def run(self): - try: - response = requests.get("https://api.github.com/repos/Toufool/Auto-Split/releases/latest") - latest_version = str(response.json()["name"]).split("v")[1] - self.autosplit.update_checker_widget_signal.emit(latest_version, self.check_on_open) - except (RequestException, KeyError): - if not self.check_on_open: - self.autosplit.show_error_signal.emit(error_messages.check_for_updates) - - +@fire_and_forget def check_for_updates(autosplit: AutoSplit, check_on_open: bool = False): - autosplit.CheckForUpdatesThread = __CheckForUpdatesThread(autosplit, check_on_open) - autosplit.CheckForUpdatesThread.start() - - -def get_capture_method_index(capture_method: Union[str, CaptureMethodEnum]): - """ - Returns 0 if the capture_method is invalid or unsupported - """ try: - return list(CAPTURE_METHODS.keys()).index(cast(CaptureMethodEnum, capture_method)) - except ValueError: - return 0 + response = requests.get("https://api.github.com/repos/Toufool/Auto-Split/releases/latest") + latest_version = str(response.json()["name"]).split("v")[1] + autosplit.update_checker_widget_signal.emit(latest_version, check_on_open) + except (RequestException, KeyError): + if not check_on_open: + autosplit.show_error_signal.emit(error_messages.check_for_updates) class __SettingsWidget(QtWidgets.QDialog, settings_ui.Ui_DialogSettings): @@ -226,7 +206,7 @@ def hotkey_connect(hotkey: Hotkeys): self.fps_limit_spinbox.setValue(autosplit.settings_dict["fps_limit"]) self.live_capture_region_checkbox.setChecked(autosplit.settings_dict["live_capture_region"]) self.capture_method_combobox.setCurrentIndex( - get_capture_method_index(autosplit.settings_dict["capture_method"])) + CAPTURE_METHODS.get_index(autosplit.settings_dict["capture_method"])) # Image Settings self.default_comparison_method.setCurrentIndex(autosplit.settings_dict["default_comparison_method"]) diff --git a/src/utils.py b/src/utils.py index ea167fcf..1cf3576e 100644 --- a/src/utils.py +++ b/src/utils.py @@ -7,7 +7,6 @@ import sys from collections.abc import Callable, Iterable from platform import version -from threading import Thread from typing import TYPE_CHECKING, Any, Optional, TypeVar, Union, cast import cv2 @@ -74,20 +73,22 @@ def get_window_bounds(hwnd: int) -> tuple[int, int, int, int]: return window_left_bounds, window_top_bounds, window_width, window_height -def fire_and_forget(func: Callable[..., Any]): - """ - Runs synchronous function asynchronously without waiting for a response +def get_or_create_eventloop(): + try: + return asyncio.get_event_loop() + except RuntimeError: + loop = asyncio.new_event_loop() + asyncio.set_event_loop(loop) + return asyncio.get_event_loop() - Uses threads on Windows because `RuntimeError: There is no current event loop in thread 'MainThread'.` - Uses asyncio on Linux because of a `Segmentation fault (core dumped)` +def fire_and_forget(func: Callable[..., Any]): + """ + Runs synchronous function asynchronously without waiting for a response. + Uses asyncio to avoid a multitude of possible problems with threads. """ def wrapped(*args: Any, **kwargs: Any): - if sys.platform == "win32": - thread = Thread(target=func, args=args, kwargs=kwargs) - thread.start() - return thread - return asyncio.get_event_loop().run_in_executor(None, func, *args, *kwargs) + return get_or_create_eventloop().run_in_executor(None, func, *args, *kwargs) return wrapped From 9967c6906f055dbf94de3528000e6fd4b5400c55 Mon Sep 17 00:00:00 2001 From: Avasam Date: Mon, 25 Jul 2022 22:14:23 -0400 Subject: [PATCH 118/137] Wrap async functions for errors --- src/auto_control.py | 56 +++++++++++++++++++++++-------------------- src/error_messages.py | 2 +- src/menu_bar.py | 35 ++++++++++++++++----------- src/utils.py | 12 +++++++--- 4 files changed, 61 insertions(+), 44 deletions(-) diff --git a/src/auto_control.py b/src/auto_control.py index eab0ad8b..c1fab203 100644 --- a/src/auto_control.py +++ b/src/auto_control.py @@ -12,29 +12,33 @@ @fire_and_forget def start_auto_control_loop(autosplit: AutoSplit): - while True: - try: - line = input() - except RuntimeError: - autosplit.show_error_signal.emit(error_messages.stdin_lost) - break - except EOFError: - continue - # This is for use in a Development environment - if line == "kill": - autosplit.closeEvent() - break - if line == "start": - autosplit.start_auto_splitter() - elif line in {"split", "skip"}: - autosplit.skip_split_signal.emit() - elif line == "undo": - autosplit.undo_split_signal.emit() - elif line == "reset": - autosplit.reset_signal.emit() - elif line.startswith("settings"): - # Allow for any split character between "settings" and the path - user_profile.load_settings(autosplit, line[9:]) - # TODO: Not yet implemented in AutoSplit Integration - # elif line == 'pause': - # autosplit.pause_signal.emit() + try: + while True: + try: + line = input() + except (RuntimeError, ValueError): + autosplit.show_error_signal.emit(error_messages.stdin_lost) + break + except EOFError: + continue + # This is for use in a Development environment + if line == "kill": + autosplit.closeEvent() + break + if line == "start": + autosplit.start_auto_splitter() + elif line in {"split", "skip"}: + autosplit.skip_split_signal.emit() + elif line == "undo": + autosplit.undo_split_signal.emit() + elif line == "reset": + autosplit.reset_signal.emit() + elif line.startswith("settings"): + # Allow for any split character between "settings" and the path + user_profile.load_settings(autosplit, line[9:]) + # TODO: Not yet implemented in AutoSplit Integration + # elif line == 'pause': + # autosplit.pause_signal.emit() + except Exception as exception: # pylint: disable=broad-except # We really want to catch everything here + error = exception + autosplit.show_error_signal.emit(lambda: error_messages.exception_traceback(error)) diff --git a/src/error_messages.py b/src/error_messages.py index edd4ca86..a1090b5a 100644 --- a/src/error_messages.py +++ b/src/error_messages.py @@ -122,7 +122,7 @@ def load_start_image(): def stdin_lost(): - set_text_message("stdin not supported or lost, external control like LiveSplit integration will not work.") + set_text_message("stdin not supported, lost or closed, external control like LiveSplit integration will not work.") def already_running(): diff --git a/src/menu_bar.py b/src/menu_bar.py index bea51240..7ac6acc9 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -85,6 +85,9 @@ def check_for_updates(autosplit: AutoSplit, check_on_open: bool = False): except (RequestException, KeyError): if not check_on_open: autosplit.show_error_signal.emit(error_messages.check_for_updates) + except Exception as exception: # pylint: disable=broad-except # We really want to catch everything here + error = exception + autosplit.show_error_signal.emit(lambda: error_messages.exception_traceback(error)) class __SettingsWidget(QtWidgets.QDialog, settings_ui.Ui_DialogSettings): @@ -134,20 +137,24 @@ def __capture_device_changed(self): @fire_and_forget def __set_all_capture_devices(self): - self.__video_capture_devices = asyncio.run(get_all_video_capture_devices()) - if len(self.__video_capture_devices) > 0: - for i in range(self.capture_device_combobox.count()): - self.capture_device_combobox.removeItem(i) - self.capture_device_combobox.addItems([ - f"* {device.name}" - + (f" [{device.backend}]" if device.backend else "") - + (" (occupied)" if device.occupied else "") - for device in self.__video_capture_devices]) - self.capture_device_combobox.setEnabled(True) - self.capture_device_combobox.setCurrentIndex( - self.get_capture_device_index(self.autosplit.settings_dict["capture_device_id"])) - else: - self.capture_device_combobox.setPlaceholderText("No device found.") + try: + self.__video_capture_devices = asyncio.run(get_all_video_capture_devices()) + if len(self.__video_capture_devices) > 0: + for i in range(self.capture_device_combobox.count()): + self.capture_device_combobox.removeItem(i) + self.capture_device_combobox.addItems([ + f"* {device.name}" + + (f" [{device.backend}]" if device.backend else "") + + (" (occupied)" if device.occupied else "") + for device in self.__video_capture_devices]) + self.capture_device_combobox.setEnabled(True) + self.capture_device_combobox.setCurrentIndex( + self.get_capture_device_index(self.autosplit.settings_dict["capture_device_id"])) + else: + self.capture_device_combobox.setPlaceholderText("No device found.") + except Exception as exception: # pylint: disable=broad-except # We really want to catch everything here + error = exception + self.autosplit.show_error_signal.emit(lambda: error_messages.exception_traceback(error)) def __init__(self, autosplit: AutoSplit): super().__init__() diff --git a/src/utils.py b/src/utils.py index 1cf3576e..9de79fdd 100644 --- a/src/utils.py +++ b/src/utils.py @@ -10,6 +10,7 @@ from typing import TYPE_CHECKING, Any, Optional, TypeVar, Union, cast import cv2 +from typing_extensions import ParamSpec, TypeGuard from win32 import win32gui from gen.build_number import AUTOSPLIT_BUILD_NUMBER @@ -82,13 +83,18 @@ def get_or_create_eventloop(): return asyncio.get_event_loop() -def fire_and_forget(func: Callable[..., Any]): +P = ParamSpec("P") + + +def fire_and_forget(func: Callable[P, Any]) -> Callable[P, asyncio.Future[None]]: """ Runs synchronous function asynchronously without waiting for a response. Uses asyncio to avoid a multitude of possible problems with threads. + + Remember to also wrap the function in a try-except to catch any unhandled exceptions! """ - def wrapped(*args: Any, **kwargs: Any): - return get_or_create_eventloop().run_in_executor(None, func, *args, *kwargs) + def wrapped(*args: P.args, **kwargs: P.kwargs): + return get_or_create_eventloop().run_in_executor(None, lambda: func(*args, **kwargs)) return wrapped From ea48b52016d515aef524584d5293e4211174fafa Mon Sep 17 00:00:00 2001 From: Avasam Date: Mon, 25 Jul 2022 23:39:06 -0400 Subject: [PATCH 119/137] Proper toggle autoreset iamge location and setting Fixed source of truth for default settings --- res/design.ui | 15 ---- res/settings.ui | 61 ++++++++----- src/AutoSplit.py | 90 +++++++++---------- .../VideoCaptureDeviceCaptureMethod.py | 4 +- src/error_messages.py | 33 +++---- src/hotkeys.py | 14 +-- src/menu_bar.py | 40 ++------- src/user_profile.py | 62 +++++++------ src/utils.py | 7 +- 9 files changed, 154 insertions(+), 172 deletions(-) diff --git a/res/design.ui b/res/design.ui index 0e3b93cf..5a00ad65 100644 --- a/res/design.ui +++ b/res/design.ui @@ -888,20 +888,6 @@ > - - - - 10 - 360 - 91 - 31 - - - - Disable auto -reset image - - x_label select_region_button start_auto_splitter_button @@ -938,7 +924,6 @@ reset image image_loop_value_label previous_image_button next_image_button - disable_auto_reset_checkbox diff --git a/res/settings.ui b/res/settings.ui index bd35eb0a..e670fa3b 100644 --- a/res/settings.ui +++ b/res/settings.ui @@ -6,8 +6,8 @@ 0 0 - 289 - 621 + 291 + 661 @@ -18,14 +18,14 @@ - 289 - 621 + 291 + 661 - 289 - 621 + 291 + 661 @@ -177,7 +177,7 @@ 10 390 271 - 241 + 261 @@ -196,7 +196,7 @@ 167 - 26 + 25 88 22 @@ -238,7 +238,7 @@ It is highly recommended to NOT use pHash if you use masked images. It is very i 6 - 29 + 28 161 16 @@ -251,7 +251,7 @@ It is highly recommended to NOT use pHash if you use masked images. It is very i 6 - 117 + 118 161 16 @@ -264,7 +264,7 @@ It is highly recommended to NOT use pHash if you use masked images. It is very i 167 - 114 + 115 87 22 @@ -305,7 +305,7 @@ It is highly recommended to NOT use pHash if you use masked images. It is very i 167 - 56 + 55 52 22 @@ -333,7 +333,7 @@ It is highly recommended to NOT use pHash if you use masked images. It is very i 6 - 144 + 143 235 20 @@ -352,7 +352,7 @@ It is highly recommended to NOT use pHash if you use masked images. It is very i 6 - 173 + 193 261 61 @@ -399,6 +399,22 @@ It is highly recommended to NOT use pHash if you use masked images. It is very i 999999999 + + + + 6 + 168 + 151 + 20 + + + + Enable auto reset image + + + true + + @@ -406,7 +422,7 @@ It is highly recommended to NOT use pHash if you use masked images. It is very i 10 10 271 - 181 + 191 @@ -438,9 +454,6 @@ It is highly recommended to NOT use pHash if you use masked images. It is very i - - true - 76 @@ -550,7 +563,7 @@ It is highly recommended to NOT use pHash if you use masked images. It is very i 180 - 28 + 30 81 21 @@ -649,7 +662,7 @@ It is highly recommended to NOT use pHash if you use masked images. It is very i true - + 180 @@ -665,21 +678,21 @@ It is highly recommended to NOT use pHash if you use masked images. It is very i Set Hotkey - + 6 - 150 + 154 71 31 - Disable auto + Toggle auto reset image - + 76 diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 47836845..dba0bcd9 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -25,10 +25,9 @@ from capture_method import CaptureMethodEnum, CaptureMethodInterface from gen import about, design, settings, update_checker from hotkeys import HOTKEYS, after_setting_hotkey, send_command -from menu_bar import check_for_updates, get_default_settings_from_ui, open_about, open_settings, view_help +from menu_bar import check_for_updates, open_about, open_settings, view_help from region_selection import align_region, select_region, select_window, validate_before_parsing from split_parser import BELOW_FLAG, DUMMY_FLAG, PAUSE_FLAG, parse_and_validate_images -from user_profile import DEFAULT_PROFILE from utils import (AUTOSPLIT_VERSION, FIRST_WIN_11_BUILD, FROZEN, START_AUTO_SPLITTER_TEXT, WINDOWS_BUILD_NUMBER, auto_split_directory, decimal, is_valid_image) @@ -38,7 +37,7 @@ os.environ["REQUESTS_CA_BUNDLE"] = certifi.where() -class AutoSplit(QMainWindow, design.Ui_MainWindow): +class AutoSplit(QMainWindow, design.Ui_MainWindow): # pylint: disable=too-many-instance-attributes myappid = f"Toufool.AutoSplit.v{AUTOSPLIT_VERSION}" ctypes.windll.shell32.SetCurrentProcessExplicitAppUserModelID(myappid) @@ -69,18 +68,12 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow): # Initialize a few attributes hwnd = 0 """Window Handle used for Capture Region""" - last_saved_settings = DEFAULT_PROFILE similarity = 0.0 split_image_number = 0 split_images_and_loop_number: list[tuple[AutoSplitImage, int]] = [] split_groups: list[list[int]] = [] capture_method = CaptureMethodInterface() - # Last loaded settings empty and last successful loaded settings file path to None until we try to load them - last_loaded_settings = DEFAULT_PROFILE - last_successfully_loaded_settings_file_path: Optional[str] = None - """For when a file has never loaded, but you successfully "Save File As".""" - # Automatic timer start highest_similarity = 0.0 reset_highest_similarity = 0.0 @@ -118,24 +111,17 @@ def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-man for hotkey in HOTKEYS: setattr(self, f"{hotkey}_hotkey", None) - # Get default values defined in SettingsDialog - self.settings_dict = get_default_settings_from_ui(self) + # Settings / Profile + self.DEFAULT_PROFILE = user_profile.get_default_settings_from_ui(self) # pylint: disable=invalid-name + """Default values defined in SettingsDialog""" + self.settings_dict = self.DEFAULT_PROFILE + self.last_saved_settings = self.DEFAULT_PROFILE + self.last_loaded_settings = self.DEFAULT_PROFILE + """Last loaded settings empty and last successful loaded settings file path to None until we try to load them""" + self.last_successfully_loaded_settings_file_path: Optional[str] = None + """For when a file has never loaded, but you successfully "Save File As".""" user_profile.load_check_for_updates_on_open(self) - self.action_view_help.triggered.connect(view_help) - self.action_about.triggered.connect(lambda: open_about(self)) - self.action_check_for_updates.triggered.connect(lambda: check_for_updates(self)) - self.action_settings.triggered.connect(lambda: open_settings(self)) - self.action_save_profile.triggered.connect(lambda: user_profile.save_settings(self)) - self.action_save_profile_as.triggered.connect(lambda: user_profile.save_settings_as(self)) - self.action_load_profile.triggered.connect(lambda: user_profile.load_settings(self)) - - if self.SettingsWidget: - self.SettingsWidget.split_input.setEnabled(False) - self.SettingsWidget.reset_input.setEnabled(False) - self.SettingsWidget.skip_split_input.setEnabled(False) - self.SettingsWidget.undo_split_input.setEnabled(False) - self.SettingsWidget.pause_input.setEnabled(False) if self.is_auto_controlled: self.start_auto_splitter_button.setEnabled(False) @@ -149,6 +135,15 @@ def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-man # split image folder line edit text self.split_image_folder_input.setText("No Folder Selected") + # Connecting menu actions + self.action_view_help.triggered.connect(view_help) + self.action_about.triggered.connect(lambda: open_about(self)) + self.action_check_for_updates.triggered.connect(lambda: check_for_updates(self)) + self.action_settings.triggered.connect(lambda: open_settings(self)) + self.action_save_profile.triggered.connect(lambda: user_profile.save_settings(self)) + self.action_save_profile_as.triggered.connect(lambda: user_profile.save_settings_as(self)) + self.action_load_profile.triggered.connect(lambda: user_profile.load_settings(self)) + # Connecting button clicks to functions self.browse_button.clicked.connect(self.__browse) self.select_region_button.clicked.connect(lambda: select_region(self)) @@ -684,6 +679,8 @@ def gui_changes_on_start(self): self.previous_image_button.setEnabled(True) self.next_image_button.setEnabled(True) + # TODO: Do we actually need to disable setting new hotkeys once started? + # What does this achieve? (See below TODO) if self.SettingsWidget: for hotkey in HOTKEYS: getattr(self.SettingsWidget, f"set_{hotkey}_hotkey_button").setEnabled(False) @@ -712,6 +709,8 @@ def gui_changes_on_reset(self, safe_to_reload_start_image: bool = False): self.previous_image_button.setEnabled(False) self.next_image_button.setEnabled(False) + # TODO: Do we actually need to disable setting new hotkeys once started? + # What does this achieve? (see above TODO) if self.SettingsWidget and not self.is_auto_controlled: for hotkey in HOTKEYS: getattr(self.SettingsWidget, f"set_{hotkey}_hotkey_button").setEnabled(True) @@ -753,28 +752,29 @@ def __reset_if_should(self, capture: Optional[cv2.Mat]): """ Checks if we should reset, resets if it's the case, and returns the result """ - if self.disable_auto_reset_checkbox.isChecked(): - self.table_reset_image_live_label.setText("disabled") - elif self.reset_image: - similarity = self.reset_image.compare_with_capture(self, capture) - threshold = self.reset_image.get_similarity_threshold(self) - - paused = time() - self.run_start_time <= self.reset_image.get_pause_time(self) - if paused: - should_reset = False - self.table_reset_image_live_label.setText("paused") - else: - should_reset = similarity >= threshold - if similarity > self.reset_highest_similarity: - self.reset_highest_similarity = similarity - self.table_reset_image_highest_label.setText(decimal(self.reset_highest_similarity)) - self.table_reset_image_live_label.setText(decimal(similarity)) + if self.reset_image: + if self.settings_dict["enable_auto_reset"]: + similarity = self.reset_image.compare_with_capture(self, capture) + threshold = self.reset_image.get_similarity_threshold(self) + + paused = time() - self.run_start_time <= self.reset_image.get_pause_time(self) + if paused: + should_reset = False + self.table_reset_image_live_label.setText("paused") + else: + should_reset = similarity >= threshold + if similarity > self.reset_highest_similarity: + self.reset_highest_similarity = similarity + self.table_reset_image_highest_label.setText(decimal(self.reset_highest_similarity)) + self.table_reset_image_live_label.setText(decimal(similarity)) - self.table_reset_image_threshold_label.setText(decimal(threshold)) + self.table_reset_image_threshold_label.setText(decimal(threshold)) - if should_reset: - send_command(self, "reset") - self.reset() + if should_reset: + send_command(self, "reset") + self.reset() + else: + self.table_reset_image_live_label.setText("disabled") return self.__check_for_reset_state_update_ui() diff --git a/src/capture_method/VideoCaptureDeviceCaptureMethod.py b/src/capture_method/VideoCaptureDeviceCaptureMethod.py index 83bd3452..bdb4ed2d 100644 --- a/src/capture_method/VideoCaptureDeviceCaptureMethod.py +++ b/src/capture_method/VideoCaptureDeviceCaptureMethod.py @@ -37,9 +37,9 @@ def __read_loop(self, autosplit: AutoSplit): error = exception self.capture_device.release() autosplit.show_error_signal.emit(lambda: exception_traceback( + error, "AutoSplit encountered an unhandled exception while trying to grab a frame and has stopped capture. " - + CREATE_NEW_ISSUE_MESSAGE, - error)) + + CREATE_NEW_ISSUE_MESSAGE)) def __init__(self, autosplit: AutoSplit): super().__init__() diff --git a/src/error_messages.py b/src/error_messages.py index a1090b5a..f7fdd51c 100644 --- a/src/error_messages.py +++ b/src/error_messages.py @@ -104,12 +104,13 @@ def invalid_settings(): def no_settings_file_on_open(): - set_text_message("No settings file found. One can be loaded on open if placed in the same folder as AutoSplit.exe") + set_text_message( + "No settings file found. One can be loaded on open if placed in the same folder as the AutoSplit executable") def too_many_settings_files_on_open(): set_text_message("Too many settings files found. " - + "Only one can be loaded on open if placed in the same folder as AutoSplit.exe") + + "Only one can be loaded on open if placed in the same folder as the AutoSplit executable") def check_for_updates(): @@ -122,7 +123,7 @@ def load_start_image(): def stdin_lost(): - set_text_message("stdin not supported, lost or closed, external control like LiveSplit integration will not work.") + set_text_message("stdin not supported or lost, external control like LiveSplit integration will not work.") def already_running(): @@ -133,19 +134,22 @@ def already_running(): "Ignore") -def exception_traceback(message: str, exception: BaseException): - set_text_message( - message, - "\n".join(traceback.format_exception(None, exception, exception.__traceback__)), - "Close AutoSplit") - - CREATE_NEW_ISSUE_MESSAGE = ( "Please create a New Issue at " + "github.com/Toufool/Auto-Split/issues, describe what happened, " + "and copy & paste the entire error message below") +def exception_traceback(exception: BaseException, message: str = ""): + if not message: + message = "AutoSplit encountered an unhandled exception and will try to recover, " + \ + f"however, there is no guarantee it will keep working properly. {CREATE_NEW_ISSUE_MESSAGE}" + set_text_message( + message, + "\n".join(traceback.format_exception(None, exception, exception.__traceback__)), + "Close AutoSplit") + + def make_excepthook(autosplit: AutoSplit): def excepthook(exception_type: type[BaseException], exception: BaseException, _traceback: Optional[TracebackType]): # Catch Keyboard Interrupts for a clean close @@ -158,18 +162,15 @@ def excepthook(exception_type: type[BaseException], exception: BaseException, _t ): return # Whithin LiveSplit excepthook needs to use MainWindow's signals to show errors - autosplit.show_error_signal.emit(lambda: exception_traceback( - "AutoSplit encountered an unhandled exception and will try to recover, " - + f"however, there is no guarantee it will keep working properly. {CREATE_NEW_ISSUE_MESSAGE}", - exception)) + autosplit.show_error_signal.emit(lambda: exception_traceback(exception)) return excepthook def handle_top_level_exceptions(exception: Exception): - message = f"AutoSplit encountered an unrecoverable exception and will now close. {CREATE_NEW_ISSUE_MESSAGE}" + message = f"AutoSplit encountered an unrecoverable exception and will likely now close. {CREATE_NEW_ISSUE_MESSAGE}" # Print error to console if not running in executable if FROZEN: - exception_traceback(message, exception) + exception_traceback(exception, message) else: traceback.print_exception(type(exception), exception, exception.__traceback__) sys.exit(1) diff --git a/src/hotkeys.py b/src/hotkeys.py index fd62a143..0201a1c9 100644 --- a/src/hotkeys.py +++ b/src/hotkeys.py @@ -20,8 +20,8 @@ Commands = Literal["split", "start", "pause", "reset", "skip", "undo"] -Hotkeys = Literal["split", "reset", "skip_split", "undo_split", "pause", "disable_auto_reset_image"] -HOTKEYS: list[Hotkeys] = ["split", "reset", "skip_split", "undo_split", "pause", "disable_auto_reset_image"] +Hotkeys = Literal["split", "reset", "skip_split", "undo_split", "pause", "toggle_auto_reset_image"] +HOTKEYS: list[Hotkeys] = ["split", "reset", "skip_split", "undo_split", "pause", "toggle_auto_reset_image"] def before_setting_hotkey(autosplit: AutoSplit): @@ -202,9 +202,13 @@ def __get_hotkey_action(autosplit: AutoSplit, hotkey: Hotkeys): return lambda: autosplit.skip_split(True) if hotkey == "undo_split": return lambda: autosplit.undo_split(True) - if hotkey == "disable_auto_reset_image": - return lambda: autosplit.disable_auto_reset_checkbox.setChecked( - not autosplit.disable_auto_reset_checkbox.isChecked()) + if hotkey == "toggle_auto_reset_image": + def toggle_auto_reset_image(): + new_value = not autosplit.settings_dict["enable_auto_reset"] + autosplit.settings_dict["enable_auto_reset"] = new_value + if autosplit.SettingsWidget: + autosplit.SettingsWidget.enable_auto_reset_checkbox.setChecked(new_value) + return toggle_auto_reset_image return getattr(autosplit, f"{hotkey}_signal").emit # TODO: using getattr/setattr is NOT a good way to go about this. It was only temporarily done to diff --git a/src/menu_bar.py b/src/menu_bar.py index 7ac6acc9..c0f55d51 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -204,7 +204,7 @@ def hotkey_connect(hotkey: Hotkeys): set_hotkey_hotkey_button.clicked.connect(hotkey_connect(hotkey)) # Make it very clear that hotkeys are not used when auto-controlled - if autosplit.is_auto_controlled: + if autosplit.is_auto_controlled and hotkey != "toggle_auto_reset_image": set_hotkey_hotkey_button.setEnabled(False) hotkey_input.setEnabled(False) @@ -221,6 +221,7 @@ def hotkey_connect(hotkey: Hotkeys): self.default_delay_time_spinbox.setValue(autosplit.settings_dict["default_delay_time"]) self.default_pause_time_spinbox.setValue(autosplit.settings_dict["default_pause_time"]) self.loop_splits_checkbox.setChecked(autosplit.settings_dict["loop_splits"]) + self.enable_auto_reset_checkbox.setChecked(autosplit.settings_dict["enable_auto_reset"]) # endregion # region Binding # Capture Settings @@ -250,6 +251,9 @@ def hotkey_connect(hotkey: Hotkeys): self.loop_splits_checkbox.stateChanged.connect(lambda: self.__set_value( "loop_splits", self.loop_splits_checkbox.isChecked())) + self.enable_auto_reset_checkbox.stateChanged.connect(lambda: self.__set_value( + "enable_auto_reset", + self.enable_auto_reset_checkbox.isChecked())) # endregion self.show() @@ -257,37 +261,3 @@ def hotkey_connect(hotkey: Hotkeys): def open_settings(autosplit: AutoSplit): autosplit.SettingsWidget = __SettingsWidget(autosplit) - - -def get_default_settings_from_ui(autosplit: AutoSplit): - temp_dialog = QtWidgets.QDialog() - default_settings_dialog = settings_ui.Ui_DialogSettings() - default_settings_dialog.setupUi(temp_dialog) - default_settings: user_profile.UserProfileDict = { - "split_hotkey": default_settings_dialog.split_input.text(), - "reset_hotkey": default_settings_dialog.reset_input.text(), - "undo_split_hotkey": default_settings_dialog.undo_split_input.text(), - "skip_split_hotkey": default_settings_dialog.skip_split_input.text(), - "pause_hotkey": default_settings_dialog.pause_input.text(), - "disable_auto_reset_image_hotkey": default_settings_dialog.disable_auto_reset_image_input.text(), - "fps_limit": default_settings_dialog.fps_limit_spinbox.value(), - "live_capture_region": default_settings_dialog.live_capture_region_checkbox.isChecked(), - "capture_method": CAPTURE_METHODS.get_method_by_index( - default_settings_dialog.capture_method_combobox.currentIndex()), - "capture_device_id": default_settings_dialog.capture_device_combobox.currentIndex(), - "capture_device_name": "", - "default_comparison_method": default_settings_dialog.default_comparison_method.currentIndex(), - "default_similarity_threshold": default_settings_dialog.default_similarity_threshold_spinbox.value(), - "default_delay_time": default_settings_dialog.default_delay_time_spinbox.value(), - "default_pause_time": default_settings_dialog.default_pause_time_spinbox.value(), - "loop_splits": default_settings_dialog.loop_splits_checkbox.isChecked(), - "split_image_directory": autosplit.split_image_folder_input.text(), - "captured_window_title": "", - "capture_region": { - "x": autosplit.x_spinbox.value(), - "y": autosplit.y_spinbox.value(), - "width": autosplit.width_spinbox.value(), - "height": autosplit.height_spinbox.value(), - }} - del temp_dialog - return default_settings diff --git a/src/user_profile.py b/src/user_profile.py index c41e1a39..8a79e994 100644 --- a/src/user_profile.py +++ b/src/user_profile.py @@ -9,7 +9,7 @@ import error_messages from capture_method import CAPTURE_METHODS, CaptureMethodEnum, Region, change_capture_method -from gen import design +from gen import design, settings as settings_ui from hotkeys import HOTKEYS, set_hotkey from utils import auto_split_directory @@ -23,9 +23,10 @@ class UserProfileDict(TypedDict): undo_split_hotkey: str skip_split_hotkey: str pause_hotkey: str - disable_auto_reset_image_hotkey: str + toggle_auto_reset_image_hotkey: str fps_limit: int live_capture_region: bool + enable_auto_reset: bool capture_method: Union[str, CaptureMethodEnum] capture_device_id: int capture_device_name: str @@ -34,33 +35,44 @@ class UserProfileDict(TypedDict): default_delay_time: int default_pause_time: float loop_splits: bool - split_image_directory: str captured_window_title: str capture_region: Region -DEFAULT_PROFILE = UserProfileDict( - split_hotkey="", - reset_hotkey="", - undo_split_hotkey="", - skip_split_hotkey="", - pause_hotkey="", - disable_auto_reset_image_hotkey="", - fps_limit=60, - live_capture_region=True, - capture_method=CAPTURE_METHODS.get_method_by_index(0), - capture_device_id=0, - capture_device_name="", - default_comparison_method=0, - default_similarity_threshold=0.95, - default_delay_time=0, - default_pause_time=10, - loop_splits=False, - split_image_directory="", - captured_window_title="", - capture_region=Region(x=0, y=0, width=1, height=1), -) +def get_default_settings_from_ui(autosplit: AutoSplit): + temp_dialog = QtWidgets.QDialog() + default_settings_dialog = settings_ui.Ui_DialogSettings() + default_settings_dialog.setupUi(temp_dialog) + default_settings: UserProfileDict = { + "split_hotkey": default_settings_dialog.split_input.text(), + "reset_hotkey": default_settings_dialog.reset_input.text(), + "undo_split_hotkey": default_settings_dialog.undo_split_input.text(), + "skip_split_hotkey": default_settings_dialog.skip_split_input.text(), + "pause_hotkey": default_settings_dialog.pause_input.text(), + "toggle_auto_reset_image_hotkey": default_settings_dialog.toggle_auto_reset_image_input.text(), + "fps_limit": default_settings_dialog.fps_limit_spinbox.value(), + "live_capture_region": default_settings_dialog.live_capture_region_checkbox.isChecked(), + "enable_auto_reset": default_settings_dialog.enable_auto_reset_checkbox.isChecked(), + "capture_method": CAPTURE_METHODS.get_method_by_index( + default_settings_dialog.capture_method_combobox.currentIndex()), + "capture_device_id": default_settings_dialog.capture_device_combobox.currentIndex(), + "capture_device_name": "", + "default_comparison_method": default_settings_dialog.default_comparison_method.currentIndex(), + "default_similarity_threshold": default_settings_dialog.default_similarity_threshold_spinbox.value(), + "default_delay_time": default_settings_dialog.default_delay_time_spinbox.value(), + "default_pause_time": default_settings_dialog.default_pause_time_spinbox.value(), + "loop_splits": default_settings_dialog.loop_splits_checkbox.isChecked(), + "split_image_directory": autosplit.split_image_folder_input.text(), + "captured_window_title": "", + "capture_region": { + "x": autosplit.x_spinbox.value(), + "y": autosplit.y_spinbox.value(), + "width": autosplit.width_spinbox.value(), + "height": autosplit.height_spinbox.value(), + }} + del temp_dialog + return default_settings def have_settings_changed(autosplit: AutoSplit): @@ -113,7 +125,7 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str # Casting here just so we can build an actual UserProfileDict once we're done validating # Fallback to default settings if some are missing from the file. This happens when new settings are added. loaded_settings = cast(UserProfileDict, { - **DEFAULT_PROFILE, + **autosplit.DEFAULT_PROFILE, **toml.load(file), }) # TODO: Data Validation / fallbacks ? diff --git a/src/utils.py b/src/utils.py index 9de79fdd..c15dcf4b 100644 --- a/src/utils.py +++ b/src/utils.py @@ -10,13 +10,13 @@ from typing import TYPE_CHECKING, Any, Optional, TypeVar, Union, cast import cv2 -from typing_extensions import ParamSpec, TypeGuard from win32 import win32gui from gen.build_number import AUTOSPLIT_BUILD_NUMBER if TYPE_CHECKING: - from typing_extensions import TypeGuard + from typing_extensions import ParamSpec, TypeGuard + P = ParamSpec("P") DWMWA_EXTENDED_FRAME_BOUNDS = 9 @@ -83,9 +83,6 @@ def get_or_create_eventloop(): return asyncio.get_event_loop() -P = ParamSpec("P") - - def fire_and_forget(func: Callable[P, Any]) -> Callable[P, asyncio.Future[None]]: """ Runs synchronous function asynchronously without waiting for a response. From 4703b7ba81970f5d99ca78f7dad1ebd866762c9e Mon Sep 17 00:00:00 2001 From: Avasam Date: Tue, 26 Jul 2022 07:02:09 -0400 Subject: [PATCH 120/137] Actions shortcut and prevent double open window --- res/design.ui | 69 +++++++++++++++++++++++++----------------------- src/AutoSplit.py | 12 ++++++++- src/menu_bar.py | 17 +++++++++--- 3 files changed, 61 insertions(+), 37 deletions(-) diff --git a/res/design.ui b/res/design.ui index 5a00ad65..0537969d 100644 --- a/res/design.ui +++ b/res/design.ui @@ -941,7 +941,10 @@ + + + @@ -960,21 +963,25 @@ View Help + + F1 + - About + About AutoSplit - - - - Split Image Settings + + QAction::AboutRole Save Profile + + Ctrl+S + @@ -985,55 +992,51 @@ Save Profile As... + + Ctrl+Shift+S + Check For Updates - + + + Settings + + + Ctrl+, + + + QAction::PreferencesRole + + + true true - - true - - - Check for Updates on Open - - - - - Force Full Render - - - Check For Updates On Open - + - Dummy Splits When Undoing/Skipping + About Qt - - - - Settings + + QAction::AboutQtRole - - - true - - - true - + - Check For Updates On Open + About Qt for Python + + + QAction::AboutQtRole diff --git a/src/AutoSplit.py b/src/AutoSplit.py index dba0bcd9..86a95cbe 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -25,7 +25,7 @@ from capture_method import CaptureMethodEnum, CaptureMethodInterface from gen import about, design, settings, update_checker from hotkeys import HOTKEYS, after_setting_hotkey, send_command -from menu_bar import check_for_updates, open_about, open_settings, view_help +from menu_bar import about_qt, about_qt_for_python, check_for_updates, open_about, open_settings, view_help from region_selection import align_region, select_region, select_window, validate_before_parsing from split_parser import BELOW_FLAG, DUMMY_FLAG, PAUSE_FLAG, parse_and_validate_images from utils import (AUTOSPLIT_VERSION, FIRST_WIN_11_BUILD, FROZEN, START_AUTO_SPLITTER_TEXT, WINDOWS_BUILD_NUMBER, @@ -138,12 +138,22 @@ def __init__(self, parent: Optional[QWidget] = None): # pylint: disable=too-man # Connecting menu actions self.action_view_help.triggered.connect(view_help) self.action_about.triggered.connect(lambda: open_about(self)) + self.action_about_qt.triggered.connect(lambda: about_qt) + self.action_about_qt_for_python.triggered.connect(lambda: about_qt_for_python) self.action_check_for_updates.triggered.connect(lambda: check_for_updates(self)) self.action_settings.triggered.connect(lambda: open_settings(self)) self.action_save_profile.triggered.connect(lambda: user_profile.save_settings(self)) self.action_save_profile_as.triggered.connect(lambda: user_profile.save_settings_as(self)) self.action_load_profile.triggered.connect(lambda: user_profile.load_settings(self)) + # Shortcut context can't be set through the designer because of a bug in pyuic6 that generates invalid code + # Email sent to pyqt@riverbankcomputing.com + self.action_view_help.setShortcutContext(QtCore.Qt.ShortcutContext.ApplicationShortcut) + self.action_settings.setShortcutContext(QtCore.Qt.ShortcutContext.ApplicationShortcut) + self.action_save_profile.setShortcutContext(QtCore.Qt.ShortcutContext.ApplicationShortcut) + self.action_save_profile_as.setShortcutContext(QtCore.Qt.ShortcutContext.ApplicationShortcut) + self.action_load_profile.setShortcutContext(QtCore.Qt.ShortcutContext.ApplicationShortcut) + # Connecting button clicks to functions self.browse_button.clicked.connect(self.__browse) self.select_region_button.clicked.connect(lambda: select_region(self)) diff --git a/src/menu_bar.py b/src/menu_bar.py index c0f55d51..d7cf2a4a 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -34,7 +34,8 @@ def __init__(self): def open_about(autosplit: AutoSplit): - autosplit.AboutWidget = __AboutWidget() + if not autosplit.AboutWidget: + autosplit.AboutWidget = __AboutWidget() class __UpdateCheckerWidget(QtWidgets.QWidget, update_checker.Ui_UpdateChecker): @@ -69,13 +70,22 @@ def do_not_ask_me_again_state_changed(self): def open_update_checker(autosplit: AutoSplit, latest_version: str, check_on_open: bool): - autosplit.UpdateCheckerWidget = __UpdateCheckerWidget(latest_version, autosplit, check_on_open) + if not autosplit.UpdateCheckerWidget: + autosplit.UpdateCheckerWidget = __UpdateCheckerWidget(latest_version, autosplit, check_on_open) def view_help(): webbrowser.open("https://github.com/Toufool/Auto-Split#tutorial") +def about_qt(): + webbrowser.open("https://wiki.qt.io/About_Qt") + + +def about_qt_for_python(): + webbrowser.open("https://wiki.qt.io/Qt_for_Python") + + @fire_and_forget def check_for_updates(autosplit: AutoSplit, check_on_open: bool = False): try: @@ -260,4 +270,5 @@ def hotkey_connect(hotkey: Hotkeys): def open_settings(autosplit: AutoSplit): - autosplit.SettingsWidget = __SettingsWidget(autosplit) + if not autosplit.SettingsWidget: + autosplit.SettingsWidget = __SettingsWidget(autosplit) From a03dc928356c91c01086235541093d045474e778 Mon Sep 17 00:00:00 2001 From: Avasam Date: Tue, 26 Jul 2022 07:31:15 -0400 Subject: [PATCH 121/137] Fixed numpy --- scripts/requirements.txt | 2 +- src/compare.py | 5 ++--- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/scripts/requirements.txt b/scripts/requirements.txt index 314dfb8f..0580cd67 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -10,7 +10,7 @@ # Creating AutoSplit.exe with PyInstaller: ./scripts/build.ps1 # # Dependencies: -numpy>=1.21.4 # Python 3.10 support +numpy>=1.23 # Updated types opencv-python-headless>=4.5.4,<4.6 # https://github.com/pyinstaller/pyinstaller/issues/6889 PyQt6>=6.2.1 PySide6 diff --git a/src/compare.py b/src/compare.py index 8a91347a..1465ded9 100644 --- a/src/compare.py +++ b/src/compare.py @@ -1,7 +1,7 @@ from __future__ import annotations from math import sqrt -from typing import Any, Optional, cast +from typing import Optional import cv2 import imagehash # https://github.com/JohannesBuchner/imagehash/issues/151 @@ -114,8 +114,7 @@ def check_if_image_has_transparency(image: cv2.Mat): # 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 - # Needs casting for numpy>=1.23 https://github.com/numpy/numpy/issues/20099 - mean: float = np.mean(cast(Any, image[:, :, 3])) + mean = image[:, :, 3].mean() if mean == 0: # Non-transparent images code path is usually faster and simpler, so let's return that return False From 27e243529cf0dc5feb25dc4f44495a1ba7f43e05 Mon Sep 17 00:00:00 2001 From: Avasam Date: Wed, 27 Jul 2022 15:37:39 -0400 Subject: [PATCH 122/137] Try Pyright Python --- README.md | 1 - scripts/install.ps1 | 6 ------ scripts/requirements-dev.txt | 1 + 3 files changed, 1 insertion(+), 7 deletions(-) diff --git a/README.md b/README.md index 3aa353a1..197c5a5e 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,6 @@ This program can be used to automatically start, split, and reset your preferred - Python 3.9 - 3.10. - Microsoft Visual C++ 14.0 or greater may be required to build the executable. Get it with [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/). -- Node is optional, but required for complete linting (using Pyright). - Read [requirements.txt](/scripts/requirements.txt) for more information on how to install, run and build the python code. - Run `./scripts/install.ps1` to install all dependencies. - Run the app directly with `./scripts/start.ps1 [--auto-controlled]`. diff --git a/scripts/install.ps1 b/scripts/install.ps1 index bf6123f8..be946ef5 100755 --- a/scripts/install.ps1 +++ b/scripts/install.ps1 @@ -8,9 +8,3 @@ If ($dev) { Write-Host "`n" & "$PSScriptRoot/compile_resources.ps1" } - -# Only the Pyright job and local devs have node installed -if (-not $env:GITHUB_JOB -or $env:GITHUB_JOB -eq 'Pyright') { - npm install --location=global pyright@latest - npm list --location=global pyright -} diff --git a/scripts/requirements-dev.txt b/scripts/requirements-dev.txt index 2365b95a..81d0ce29 100644 --- a/scripts/requirements-dev.txt +++ b/scripts/requirements-dev.txt @@ -10,6 +10,7 @@ flake8-quotes flake8-isort pep8-naming pylint>=2.13.9 # Respect ignore configuration options with --recursive=y +pyright # Types git+https://github.com/Avasam/pywin32-stubs.git#egg=pywin32-stubs # https://github.com/kaluluosi/pywin32-stubs/pull/8 types-requests From c7b7b58b3fc9a4108af37c6c25d3881d043f4738 Mon Sep 17 00:00:00 2001 From: Avasam Date: Wed, 27 Jul 2022 15:40:59 -0400 Subject: [PATCH 123/137] forgot float for mean --- scripts/designer.bat | 18 ------------------ scripts/designer.ps1 | 6 ++++++ src/compare.py | 2 +- 3 files changed, 7 insertions(+), 19 deletions(-) delete mode 100755 scripts/designer.bat create mode 100644 scripts/designer.ps1 diff --git a/scripts/designer.bat b/scripts/designer.bat deleted file mode 100755 index 8e11aafd..00000000 --- a/scripts/designer.bat +++ /dev/null @@ -1,18 +0,0 @@ -@ECHO OFF - -IF NOT DEFINED PYTHONPATH ( - setlocal EnableDelayedExpansion - - SET n=0 - FOR /f "delims=" %%p in ('where python') do ( - SET pythonFiles[!n!]=%%p - SET /A n+=1 - ) - SET PYTHONPATH=!pythonFiles[0]! -) - -START "Qt Designer" "%PYTHONPATH:~0,-11%\Lib\site-packages\qt6_applications\Qt\bin\designer.exe"^ - "%~d0%~p0..\res\design.ui"^ - "%~d0%~p0..\res\about.ui"^ - "%~d0%~p0..\res\settings.ui"^ - "%~d0%~p0..\res\update_checker.ui" diff --git a/scripts/designer.ps1 b/scripts/designer.ps1 new file mode 100644 index 00000000..85e4dd3f --- /dev/null +++ b/scripts/designer.ps1 @@ -0,0 +1,6 @@ +$qt6_applications_path = python -c 'import qt6_applications; print(qt6_applications.__path__[0])' +& "$qt6_applications_path/Qt/bin/designer" ` + "$PSScriptRoot/../res/design.ui" ` + "$PSScriptRoot/../res/about.ui" ` + "$PSScriptRoot/../res/settings.ui" ` + "$PSScriptRoot/../res/update_checker.ui" diff --git a/src/compare.py b/src/compare.py index 1465ded9..99d38829 100644 --- a/src/compare.py +++ b/src/compare.py @@ -114,7 +114,7 @@ def check_if_image_has_transparency(image: cv2.Mat): # 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 - mean = image[:, :, 3].mean() + mean: float = image[:, :, 3].mean() if mean == 0: # Non-transparent images code path is usually faster and simpler, so let's return that return False From 8afeabfbb815d5e701713b295a895bfeb094905a Mon Sep 17 00:00:00 2001 From: Avasam Date: Wed, 27 Jul 2022 21:38:38 -0400 Subject: [PATCH 124/137] Update source.fixAll for Pylance --- .vscode/settings.json | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 18f24f81..cb0a2d16 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -13,6 +13,8 @@ "editor.formatOnSave": true, "editor.codeActionsOnSave": { "source.fixAll": true, + "source.fixAll.unusedImports": false, + "source.fixAll.convertImportFormat": true, "source.organizeImports": true, }, "files.insertFinalNewline": true, @@ -54,10 +56,6 @@ 99, // PEP8-17 acceptable max 120, // Our hard rule ], - "editor.codeActionsOnSave": { - // This removes "unused" imports. https://github.com/microsoft/pylance-release/issues/3091 - "source.fixAll": false, - }, }, "python.linting.enabled": true, "python.linting.pylintEnabled": true, From 2506454d724b9f36b65514539c1ccd14b143c462 Mon Sep 17 00:00:00 2001 From: Avasam Date: Thu, 28 Jul 2022 21:56:29 -0400 Subject: [PATCH 125/137] Update fork links --- res/settings.ui | 2 +- src/error_messages.py | 6 +++--- src/menu_bar.py | 13 +++++++++---- src/utils.py | 1 + 4 files changed, 14 insertions(+), 8 deletions(-) diff --git a/res/settings.ui b/res/settings.ui index e670fa3b..599ffde4 100644 --- a/res/settings.ui +++ b/res/settings.ui @@ -364,7 +364,7 @@ It is highly recommended to NOT use pHash if you use masked images. It is very i - <html><head/><body><p>Custom image settings and flags are set in the <br></br> image file name. These will override the default <br></br> values. View the <a href="https://github.com/Toufool/Auto-Split#readme"><span style=" text-decoration: underline; color:#0000ff;">README</span></a> for full details on all <br></br> available custom image settings.</p></body></html> + <html><head/><body><p>Custom image settings and flags are set in the <br></br> image file name. These will override the default <br></br> values. View the <a href="https://github.com/{GITHUB_FORK}#readme"><span style=" text-decoration: underline; color:#0000ff;">README</span></a> for full details on all <br></br> available custom image settings.</p></body></html> diff --git a/src/error_messages.py b/src/error_messages.py index f7fdd51c..a2968c41 100644 --- a/src/error_messages.py +++ b/src/error_messages.py @@ -10,7 +10,7 @@ from PyQt6 import QtCore, QtWidgets -from utils import FROZEN +from utils import FROZEN, GITHUB_FORK if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -135,8 +135,8 @@ def already_running(): CREATE_NEW_ISSUE_MESSAGE = ( - "Please create a New Issue at " - + "github.com/Toufool/Auto-Split/issues, describe what happened, " + f"Please create a New Issue at " + + f"github.com/{GITHUB_FORK}/issues, describe what happened, " + "and copy & paste the entire error message below") diff --git a/src/menu_bar.py b/src/menu_bar.py index d7cf2a4a..adef2aa2 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -15,7 +15,7 @@ get_all_video_capture_devices) from gen import about, design, resources_rc, settings as settings_ui, update_checker # noqa F401 from hotkeys import HOTKEYS, Hotkeys, set_hotkey -from utils import AUTOSPLIT_VERSION, FIRST_WIN_11_BUILD, WINDOWS_BUILD_NUMBER, decimal, fire_and_forget +from utils import AUTOSPLIT_VERSION, FIRST_WIN_11_BUILD, GITHUB_FORK, WINDOWS_BUILD_NUMBER, decimal, fire_and_forget if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -60,7 +60,7 @@ def __init__(self, latest_version: str, design_window: design.Ui_MainWindow, che self.show() def open_update(self): - webbrowser.open("https://github.com/Toufool/Auto-Split/releases/latest") + webbrowser.open(f"https://github.com/{GITHUB_FORK}/releases/latest") self.close() def do_not_ask_me_again_state_changed(self): @@ -75,7 +75,7 @@ def open_update_checker(autosplit: AutoSplit, latest_version: str, check_on_open def view_help(): - webbrowser.open("https://github.com/Toufool/Auto-Split#tutorial") + webbrowser.open(f"https://github.com/{GITHUB_FORK}#tutorial") def about_qt(): @@ -89,7 +89,7 @@ def about_qt_for_python(): @fire_and_forget def check_for_updates(autosplit: AutoSplit, check_on_open: bool = False): try: - response = requests.get("https://api.github.com/repos/Toufool/Auto-Split/releases/latest") + response = requests.get(f"https://api.github.com/repos/{GITHUB_FORK}/releases/latest") latest_version = str(response.json()["name"]).split("v")[1] autosplit.update_checker_widget_signal.emit(latest_version, check_on_open) except (RequestException, KeyError): @@ -181,6 +181,11 @@ def __init__(self, autosplit: AutoSplit): # Don't autofocus any particular field self.setFocus() + self.custom_image_settings_info_label.setText( + self.custom_image_settings_info_label + .text() + .format(GITHUB_FORK=GITHUB_FORK)) + # region Build the Capture method combobox capture_method_values = CAPTURE_METHODS.values() self.__set_all_capture_devices() diff --git a/src/utils.py b/src/utils.py index c15dcf4b..6112be69 100644 --- a/src/utils.py +++ b/src/utils.py @@ -111,3 +111,4 @@ def wrapped(*args: P.args, **kwargs: P.kwargs): """Set DIRTY_VERSION_EXTENSION to an empty string to generate a clean version number""" AUTOSPLIT_VERSION = "2.0.0-alpha.4" + DIRTY_VERSION_EXTENSION START_AUTO_SPLITTER_TEXT = "Start Auto Splitter" +GITHUB_FORK = "Avasam/Auto-Split" From 3db053dda19cb8125f96ebdbb1a0034ead58c858 Mon Sep 17 00:00:00 2001 From: Avasam Date: Thu, 28 Jul 2022 22:13:55 -0400 Subject: [PATCH 126/137] Attempt at automating github repo from fork --- res/settings.ui | 2 +- scripts/compile_resources.ps1 | 7 ++++++- src/error_messages.py | 6 +++--- src/menu_bar.py | 10 +++++----- src/utils.py | 4 ++-- 5 files changed, 17 insertions(+), 12 deletions(-) diff --git a/res/settings.ui b/res/settings.ui index 599ffde4..df28f9da 100644 --- a/res/settings.ui +++ b/res/settings.ui @@ -364,7 +364,7 @@ It is highly recommended to NOT use pHash if you use masked images. It is very i - <html><head/><body><p>Custom image settings and flags are set in the <br></br> image file name. These will override the default <br></br> values. View the <a href="https://github.com/{GITHUB_FORK}#readme"><span style=" text-decoration: underline; color:#0000ff;">README</span></a> for full details on all <br></br> available custom image settings.</p></body></html> + <html><head/><body><p>Custom image settings and flags are set in the <br></br> image file name. These will override the default <br></br> values. View the <a href="https://github.com/{GITHUB_REPOSITORY}#readme"><span style=" text-decoration: underline; color:#0000ff;">README</span></a> for full details on all <br></br> available custom image settings.</p></body></html> diff --git a/scripts/compile_resources.ps1 b/scripts/compile_resources.ps1 index a2369324..5b2075bc 100755 --- a/scripts/compile_resources.ps1 +++ b/scripts/compile_resources.ps1 @@ -9,8 +9,13 @@ pyuic6 './res/update_checker.ui' -o './src/gen/update_checker.py' pyside6-rcc './res/resources.qrc' -o './src/gen/resources_rc.py' Write-Host 'Generated code from .ui files' +$build_vars_path = "$PSScriptRoot/../src/gen/build_vars.py" $BUILD_NUMBER = Get-Date -Format yyMMddHHmm -New-Item "$PSScriptRoot/../src/gen/build_number.py" -ItemType File -Force -Value "AUTOSPLIT_BUILD_NUMBER = `"$BUILD_NUMBER`"" | Out-Null +$GITHUB_REPOSITORY = If ($Env:GITHUB_REPOSITORY) { $Env:GITHUB_REPOSITORY } Else { 'Toufool/Auto-Split' } +New-Item $build_vars_path -ItemType File -Force | Out-Null +Add-Content $build_vars_path "AUTOSPLIT_BUILD_NUMBER = `"$BUILD_NUMBER`"" +Add-Content $build_vars_path "AUTOSPLIT_GITHUB_REPOSITORY = `"$GITHUB_REPOSITORY`"" Write-Host "Generated build number: `"$BUILD_NUMBER`"" +Write-Host "Set repository to `"$GITHUB_REPOSITORY`"" Set-Location $originalDirectory diff --git a/src/error_messages.py b/src/error_messages.py index a2968c41..e3291ffe 100644 --- a/src/error_messages.py +++ b/src/error_messages.py @@ -10,7 +10,7 @@ from PyQt6 import QtCore, QtWidgets -from utils import FROZEN, GITHUB_FORK +from utils import FROZEN, GITHUB_REPOSITORY if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -135,8 +135,8 @@ def already_running(): CREATE_NEW_ISSUE_MESSAGE = ( - f"Please create a New Issue at " - + f"github.com/{GITHUB_FORK}/issues, describe what happened, " + f"Please create a New Issue at " + + f"github.com/{GITHUB_REPOSITORY}/issues, describe what happened, " + "and copy & paste the entire error message below") diff --git a/src/menu_bar.py b/src/menu_bar.py index adef2aa2..fef55706 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -15,7 +15,7 @@ get_all_video_capture_devices) from gen import about, design, resources_rc, settings as settings_ui, update_checker # noqa F401 from hotkeys import HOTKEYS, Hotkeys, set_hotkey -from utils import AUTOSPLIT_VERSION, FIRST_WIN_11_BUILD, GITHUB_FORK, WINDOWS_BUILD_NUMBER, decimal, fire_and_forget +from utils import AUTOSPLIT_VERSION, FIRST_WIN_11_BUILD, GITHUB_REPOSITORY, WINDOWS_BUILD_NUMBER, decimal, fire_and_forget if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -60,7 +60,7 @@ def __init__(self, latest_version: str, design_window: design.Ui_MainWindow, che self.show() def open_update(self): - webbrowser.open(f"https://github.com/{GITHUB_FORK}/releases/latest") + webbrowser.open(f"https://github.com/{GITHUB_REPOSITORY}/releases/latest") self.close() def do_not_ask_me_again_state_changed(self): @@ -75,7 +75,7 @@ def open_update_checker(autosplit: AutoSplit, latest_version: str, check_on_open def view_help(): - webbrowser.open(f"https://github.com/{GITHUB_FORK}#tutorial") + webbrowser.open(f"https://github.com/{GITHUB_REPOSITORY}#tutorial") def about_qt(): @@ -89,7 +89,7 @@ def about_qt_for_python(): @fire_and_forget def check_for_updates(autosplit: AutoSplit, check_on_open: bool = False): try: - response = requests.get(f"https://api.github.com/repos/{GITHUB_FORK}/releases/latest") + response = requests.get(f"https://api.github.com/repos/{GITHUB_REPOSITORY}/releases/latest") latest_version = str(response.json()["name"]).split("v")[1] autosplit.update_checker_widget_signal.emit(latest_version, check_on_open) except (RequestException, KeyError): @@ -184,7 +184,7 @@ def __init__(self, autosplit: AutoSplit): self.custom_image_settings_info_label.setText( self.custom_image_settings_info_label .text() - .format(GITHUB_FORK=GITHUB_FORK)) + .format(GITHUB_REPOSITORY=GITHUB_REPOSITORY)) # region Build the Capture method combobox capture_method_values = CAPTURE_METHODS.values() diff --git a/src/utils.py b/src/utils.py index 6112be69..1c408bc0 100644 --- a/src/utils.py +++ b/src/utils.py @@ -12,7 +12,7 @@ import cv2 from win32 import win32gui -from gen.build_number import AUTOSPLIT_BUILD_NUMBER +from gen.build_vars import AUTOSPLIT_BUILD_NUMBER, AUTOSPLIT_GITHUB_REPOSITORY if TYPE_CHECKING: from typing_extensions import ParamSpec, TypeGuard @@ -111,4 +111,4 @@ def wrapped(*args: P.args, **kwargs: P.kwargs): """Set DIRTY_VERSION_EXTENSION to an empty string to generate a clean version number""" AUTOSPLIT_VERSION = "2.0.0-alpha.4" + DIRTY_VERSION_EXTENSION START_AUTO_SPLITTER_TEXT = "Start Auto Splitter" -GITHUB_FORK = "Avasam/Auto-Split" +GITHUB_REPOSITORY = AUTOSPLIT_GITHUB_REPOSITORY From 3634e125cc0d644d8bdf1a2985317fc99990c3b0 Mon Sep 17 00:00:00 2001 From: Avasam Date: Thu, 28 Jul 2022 22:24:29 -0400 Subject: [PATCH 127/137] Double check just $Env:GITHUB_REPOSITORY --- scripts/compile_resources.ps1 | 3 ++- src/menu_bar.py | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/scripts/compile_resources.ps1 b/scripts/compile_resources.ps1 index 5b2075bc..50f62779 100755 --- a/scripts/compile_resources.ps1 +++ b/scripts/compile_resources.ps1 @@ -11,7 +11,8 @@ Write-Host 'Generated code from .ui files' $build_vars_path = "$PSScriptRoot/../src/gen/build_vars.py" $BUILD_NUMBER = Get-Date -Format yyMMddHHmm -$GITHUB_REPOSITORY = If ($Env:GITHUB_REPOSITORY) { $Env:GITHUB_REPOSITORY } Else { 'Toufool/Auto-Split' } +# $GITHUB_REPOSITORY = If ($Env:GITHUB_REPOSITORY) { $Env:GITHUB_REPOSITORY } Else { 'Toufool/Auto-Split' } +$GITHUB_REPOSITORY = $Env:GITHUB_REPOSITORY New-Item $build_vars_path -ItemType File -Force | Out-Null Add-Content $build_vars_path "AUTOSPLIT_BUILD_NUMBER = `"$BUILD_NUMBER`"" Add-Content $build_vars_path "AUTOSPLIT_GITHUB_REPOSITORY = `"$GITHUB_REPOSITORY`"" diff --git a/src/menu_bar.py b/src/menu_bar.py index fef55706..9b81b087 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -15,7 +15,8 @@ get_all_video_capture_devices) from gen import about, design, resources_rc, settings as settings_ui, update_checker # noqa F401 from hotkeys import HOTKEYS, Hotkeys, set_hotkey -from utils import AUTOSPLIT_VERSION, FIRST_WIN_11_BUILD, GITHUB_REPOSITORY, WINDOWS_BUILD_NUMBER, decimal, fire_and_forget +from utils import (AUTOSPLIT_VERSION, FIRST_WIN_11_BUILD, GITHUB_REPOSITORY, WINDOWS_BUILD_NUMBER, decimal, + fire_and_forget) if TYPE_CHECKING: from AutoSplit import AutoSplit From 4ea526c422ceee1eaae5d226ccfc522e13813b49 Mon Sep 17 00:00:00 2001 From: Avasam Date: Thu, 28 Jul 2022 22:34:15 -0400 Subject: [PATCH 128/137] GITHUB_BASE_REPOSITORY --- .github/workflows/lint-and-build.yml | 4 ++++ scripts/compile_resources.ps1 | 4 ++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/workflows/lint-and-build.yml b/.github/workflows/lint-and-build.yml index 2511e920..f6f1ce05 100644 --- a/.github/workflows/lint-and-build.yml +++ b/.github/workflows/lint-and-build.yml @@ -21,6 +21,10 @@ on: - '**.py' - '**.pyi' - '**.ui' + +env: + GITHUB_BASE_REPOSITORY: ${{ github.event.pull_request.base.repo.full_name }} + jobs: Pyright: runs-on: windows-latest diff --git a/scripts/compile_resources.ps1 b/scripts/compile_resources.ps1 index 50f62779..18cdb170 100755 --- a/scripts/compile_resources.ps1 +++ b/scripts/compile_resources.ps1 @@ -11,8 +11,8 @@ Write-Host 'Generated code from .ui files' $build_vars_path = "$PSScriptRoot/../src/gen/build_vars.py" $BUILD_NUMBER = Get-Date -Format yyMMddHHmm -# $GITHUB_REPOSITORY = If ($Env:GITHUB_REPOSITORY) { $Env:GITHUB_REPOSITORY } Else { 'Toufool/Auto-Split' } -$GITHUB_REPOSITORY = $Env:GITHUB_REPOSITORY +# $GITHUB_REPOSITORY = If ($Env:GITHUB_BASE_REPOSITORY) { $Env:GITHUB_BASE_REPOSITORY } Else { 'Toufool/Auto-Split' } +$GITHUB_REPOSITORY = $Env:GITHUB_BASE_REPOSITORY New-Item $build_vars_path -ItemType File -Force | Out-Null Add-Content $build_vars_path "AUTOSPLIT_BUILD_NUMBER = `"$BUILD_NUMBER`"" Add-Content $build_vars_path "AUTOSPLIT_GITHUB_REPOSITORY = `"$GITHUB_REPOSITORY`"" From d0755a829bf91cc6ed2bbff277a0924535b8a0fe Mon Sep 17 00:00:00 2001 From: Avasam Date: Thu, 28 Jul 2022 22:50:15 -0400 Subject: [PATCH 129/137] head, not base --- .github/workflows/lint-and-build.yml | 3 +-- scripts/compile_resources.ps1 | 3 +-- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/.github/workflows/lint-and-build.yml b/.github/workflows/lint-and-build.yml index f6f1ce05..646e095b 100644 --- a/.github/workflows/lint-and-build.yml +++ b/.github/workflows/lint-and-build.yml @@ -14,7 +14,6 @@ on: branches: - main - master - - dev - dev* - 2.0.0 paths: @@ -23,7 +22,7 @@ on: - '**.ui' env: - GITHUB_BASE_REPOSITORY: ${{ github.event.pull_request.base.repo.full_name }} + GITHUB_HEAD_REPOSITORY: ${{ github.event.pull_request.head.repo.full_name }} jobs: Pyright: diff --git a/scripts/compile_resources.ps1 b/scripts/compile_resources.ps1 index 18cdb170..1a71ce10 100755 --- a/scripts/compile_resources.ps1 +++ b/scripts/compile_resources.ps1 @@ -11,8 +11,7 @@ Write-Host 'Generated code from .ui files' $build_vars_path = "$PSScriptRoot/../src/gen/build_vars.py" $BUILD_NUMBER = Get-Date -Format yyMMddHHmm -# $GITHUB_REPOSITORY = If ($Env:GITHUB_BASE_REPOSITORY) { $Env:GITHUB_BASE_REPOSITORY } Else { 'Toufool/Auto-Split' } -$GITHUB_REPOSITORY = $Env:GITHUB_BASE_REPOSITORY +$GITHUB_REPOSITORY = If ($Env:GITHUB_HEAD_REPOSITORY) { $Env:GITHUB_HEAD_REPOSITORY } Else { 'Toufool/Auto-Split' } New-Item $build_vars_path -ItemType File -Force | Out-Null Add-Content $build_vars_path "AUTOSPLIT_BUILD_NUMBER = `"$BUILD_NUMBER`"" Add-Content $build_vars_path "AUTOSPLIT_GITHUB_REPOSITORY = `"$GITHUB_REPOSITORY`"" From 17ae83af56717b2e38e034fb9a066a0291d0e0d3 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sat, 30 Jul 2022 14:26:37 -0400 Subject: [PATCH 130/137] Updated from "linux" branch --- .github/workflows/codeql-analysis.yml | 58 +++---- .github/workflows/lint-and-build.yml | 32 ++-- .vscode/extensions.json | 14 ++ .vscode/settings.json | 1 - .vscode/tasks.json | 13 ++ README.md | 1 + pyproject.toml | 15 +- res/about.ui | 22 ++- scripts/designer.ps1 | 2 +- scripts/install.ps1 | 11 +- scripts/requirements-dev.txt | 13 +- scripts/requirements.txt | 10 +- scripts/start.ps1 | 2 +- src/AutoSplit.py | 3 +- .../WindowsGraphicsCaptureMethod.py | 3 +- src/capture_method/__init__.py | 156 +++++++++--------- src/capture_method/interface.py | 8 +- src/hotkeys.py | 71 ++++---- src/user_profile.py | 5 +- src/utils.py | 2 +- typings/d3dshot/d3dshot.pyi | 10 +- typings/d3dshot/display.pyi | 12 +- typings/keyboard/_keyboard_event.pyi | 9 +- 23 files changed, 258 insertions(+), 215 deletions(-) diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 55844c5a..0f31025a 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -13,12 +13,12 @@ name: "CodeQL" on: push: - branches: [ main, master, develop, dev, 2.0.0] + branches: [main, master, develop, dev, 2.0.0] pull_request: # The branches below must be a subset of the branches above - branches: [ develop, dev, 2.0.0 ] + branches: [develop, dev, 2.0.0] schedule: - - cron: '26 13 * * 6' + - cron: "26 13 * * 6" jobs: analyze: @@ -28,40 +28,40 @@ jobs: strategy: fail-fast: false matrix: - language: [ 'python' ] + language: ["python"] # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ] # Learn more: # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed steps: - - name: Checkout repository - uses: actions/checkout@v2 + - name: Checkout repository + uses: actions/checkout@v2 - # Initializes the CodeQL tools for scanning. - - name: Initialize CodeQL - uses: github/codeql-action/init@v2 - with: - languages: ${{ matrix.language }} - # If you wish to specify custom queries, you can do so here or in a config file. - # By default, queries listed here will override any specified in a config file. - # Prefix the list here with "+" to use these queries and those in the config file. - # queries: ./path/to/local/query, your-org/your-repo/queries@main + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v2 + with: + languages: ${{ matrix.language }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + # queries: ./path/to/local/query, your-org/your-repo/queries@main - # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). - # If this step fails, then you should remove it and run the build manually (see below) - - name: Autobuild - uses: github/codeql-action/autobuild@v2 + # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + - name: Autobuild + uses: github/codeql-action/autobuild@v2 - # ℹī¸ Command-line programs to run using the OS shell. - # 📚 https://git.io/JvXDl + # ℹī¸ Command-line programs to run using the OS shell. + # 📚 https://git.io/JvXDl - # ✏ī¸ If the Autobuild fails above, remove it and uncomment the following three lines - # and modify them (or add more) to build your code if your project - # uses a compiled language + # ✏ī¸ If the Autobuild fails above, remove it and uncomment the following three lines + # and modify them (or add more) to build your code if your project + # uses a compiled language - #- run: | - # make bootstrap - # make release + #- run: | + # make bootstrap + # make release - - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v2 + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v2 diff --git a/.github/workflows/lint-and-build.yml b/.github/workflows/lint-and-build.yml index 646e095b..62d39ad2 100644 --- a/.github/workflows/lint-and-build.yml +++ b/.github/workflows/lint-and-build.yml @@ -7,9 +7,9 @@ on: - main - master paths: - - '**.py' - - '**.pyi' - - '**.ui' + - "**.py" + - "**.pyi" + - "**.ui" pull_request: branches: - main @@ -17,9 +17,9 @@ on: - dev* - 2.0.0 paths: - - '**.py' - - '**.pyi' - - '**.ui' + - "**.py" + - "**.pyi" + - "**.ui" env: GITHUB_HEAD_REPOSITORY: ${{ github.event.pull_request.head.repo.full_name }} @@ -40,8 +40,8 @@ jobs: uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} - cache: 'pip' - cache-dependency-path: 'scripts/requirements*.txt' + cache: "pip" + cache-dependency-path: "scripts/requirements*.txt" - run: scripts/install.ps1 shell: pwsh - name: Analysing the code with Pyright @@ -59,8 +59,8 @@ jobs: uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} - cache: 'pip' - cache-dependency-path: 'scripts/requirements*.txt' + cache: "pip" + cache-dependency-path: "scripts/requirements*.txt" - run: scripts/install.ps1 shell: pwsh - name: Analysing the code with Pylint @@ -78,16 +78,14 @@ jobs: uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} - cache: 'pip' - cache-dependency-path: 'scripts/requirements*.txt' + cache: "pip" + cache-dependency-path: "scripts/requirements*.txt" - run: scripts/install.ps1 shell: pwsh - name: Analysing the code with Flake8 run: flake8 Bandit: runs-on: windows-latest - strategy: - fail-fast: false steps: - name: Checkout ${{ github.repository }}/${{ github.ref }} uses: actions/checkout@v3 @@ -95,8 +93,8 @@ jobs: uses: actions/setup-python@v4 with: python-version: "3.10" - cache: 'pip' - cache-dependency-path: 'scripts/requirements*.txt' + cache: "pip" + cache-dependency-path: "scripts/requirements*.txt" - run: scripts/install.ps1 shell: pwsh - name: Analysing the code with Bandit @@ -114,7 +112,7 @@ jobs: uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} - cache: 'pip' + cache: "pip" - run: scripts/install.ps1 shell: pwsh - run: scripts/build.ps1 diff --git a/.vscode/extensions.json b/.vscode/extensions.json index 67a73c4c..596b7137 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -6,11 +6,15 @@ "eamodio.gitlens", "ms-python.python", "ms-python.vscode-pylance", + "ms-vscode.powershell", "pkief.material-icon-theme", + "redhat.vscode-yaml", "shardulm94.trailing-spaces", "sonarsource.sonarlint-vscode" ], "unwantedRecommendations": [ + // Must disable in this workspace // + // // VSCode has implemented an optimized version "coenraads.bracket-pair-colorizer", "coenraads.bracket-pair-colorizer-2", @@ -21,5 +25,15 @@ "ms-vscode.vscode-typescript-tslint-plugin", // Obsoleted by Pylance "ms-pyright.pyright", + // Not configurable per workspace, tends to conflict with other linters + // Use eslint-plugin-sonarjs for JS/TS projects + "sonarsource.sonarlint-vscode", + // + // Don't recommend to autoinstall// + // + // This is a Git project + "johnstoncode.svn-scm", + // Prefer using VSCode itself as a text editor + "vscodevim.vim", ] } diff --git a/.vscode/settings.json b/.vscode/settings.json index cb0a2d16..f5b89697 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -45,7 +45,6 @@ "**/bower_components": true, "**/*.code-search": true, "*.lock": true, - "typings": true, }, "[python]": { "editor.tabSize": 4, diff --git a/.vscode/tasks.json b/.vscode/tasks.json index 69828ccd..39a29147 100644 --- a/.vscode/tasks.json +++ b/.vscode/tasks.json @@ -1,5 +1,18 @@ { "version": "2.0.0", + "windows": { + "options": { + "shell": { + "executable": "powershell", + "args": [ + "-NoProfile", + "-ExecutionPolicy", + "Bypass", + "-Command" + ] + } + } + }, "tasks": [ { "label": "Compile resources", diff --git a/README.md b/README.md index 7ada15ef..5a9fc6da 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,7 @@ This program can be used to automatically start, split, and reset your preferred ### Compatibility +- Python 3.9+ - Windows 10 and 11. ### Building diff --git a/pyproject.toml b/pyproject.toml index 1282956d..c26a32fd 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -113,18 +113,19 @@ disable = [ # No need to mention the fixmes "fixme", "missing-docstring", - # We group imports + # Already taken care of by Flake8 and isort + "ungrouped-imports", + "unused-import", + "wrong-import-order", "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", - # Similar lines in 2 files, doesn't really work - "R0801", + # Only reports a single instance. Pyright does a better job anyway + "cyclic-import", # Doesn't work with local imports "import-error", - # False positives with PyQt .connect - "no-value-for-parameter", + # Similar lines in 2 files, doesn't really work + "R0801", # Not as long as we support Python 3.9 "consider-alternative-union-syntax", ] diff --git a/res/about.ui b/res/about.ui index 05e4914a..50fae296 100644 --- a/res/about.ui +++ b/res/about.ui @@ -52,7 +52,7 @@ 10 44 - 171 + 241 32 @@ -65,7 +65,7 @@ 10 21 - 161 + 241 16 @@ -76,15 +76,16 @@ - 30 - 95 - 204 - 32 + 10 + 90 + 241 + 41 - If you enjoy using this program, please -consider donating. Thank you! + If you enjoy using this program, +please consider donating. +Thank you! Qt::AlignCenter @@ -112,7 +113,7 @@ consider donating. Thank you! - 181 + 190 17 64 64 @@ -128,6 +129,9 @@ consider donating. Thank you! true + ok_button + donate_text_label + donate_button_label icon_label version_label created_by_label diff --git a/scripts/designer.ps1 b/scripts/designer.ps1 index 85e4dd3f..13d2450a 100644 --- a/scripts/designer.ps1 +++ b/scripts/designer.ps1 @@ -1,4 +1,4 @@ -$qt6_applications_path = python -c 'import qt6_applications; print(qt6_applications.__path__[0])' +$qt6_applications_path = python3 -c 'import qt6_applications; print(qt6_applications.__path__[0])' & "$qt6_applications_path/Qt/bin/designer" ` "$PSScriptRoot/../res/design.ui" ` "$PSScriptRoot/../res/about.ui" ` diff --git a/scripts/install.ps1 b/scripts/install.ps1 index be946ef5..58d9305c 100755 --- a/scripts/install.ps1 +++ b/scripts/install.ps1 @@ -1,10 +1,17 @@ # Installing Python dependencies $dev = If ($env:GITHUB_JOB -eq 'Build') { '' } Else { '-dev' } -pip install wheel --upgrade +# Ensures installation tools are up to date. +python3 -m pip install wheel pip setuptools --upgrade pip install -r "$PSScriptRoot/requirements$dev.txt" +# Alias python to python3 on windows +If ($IsWindows) { + $python = (Get-Command python).Source + $python3 = "$((Get-Item $python).Directory.FullName)/python3.exe" + New-Item -ItemType SymbolicLink -Path $python3 -Target $python -ErrorAction SilentlyContinue +} + # Don't compile resources on the Build CI job as it'll do so in build script If ($dev) { - Write-Host "`n" & "$PSScriptRoot/compile_resources.ps1" } diff --git a/scripts/requirements-dev.txt b/scripts/requirements-dev.txt index 81d0ce29..349c243a 100644 --- a/scripts/requirements-dev.txt +++ b/scripts/requirements-dev.txt @@ -1,3 +1,8 @@ +# Usage: ./scripts/install.ps1 +# +# If you're having issues with the libraries, you might want to first run: +# pip uninstall -y -r ./scripts/requirements-dev.txt +# # Dependencies -r requirements.txt # @@ -11,11 +16,11 @@ flake8-isort pep8-naming pylint>=2.13.9 # Respect ignore configuration options with --recursive=y pyright +# +# Run `./scripts/designer.ps1` to quickly open the bundled PyQt Designer. +# Can also be downloaded externally as a non-python package +qt6-applications # Types git+https://github.com/Avasam/pywin32-stubs.git#egg=pywin32-stubs # https://github.com/kaluluosi/pywin32-stubs/pull/8 types-requests typing-extensions -# -# You can comment this out if you don't want to run `designer.bat` to quickly open the bundled PyQt Designer. -# Can also be downloaded externally as a non-python package -qt6-applications diff --git a/scripts/requirements.txt b/scripts/requirements.txt index 0580cd67..82322b1e 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -7,18 +7,17 @@ # If you're having issues with the libraries, you might want to first run: # pip uninstall -y -r ./scripts/requirements-dev.txt # -# Creating AutoSplit.exe with PyInstaller: ./scripts/build.ps1 +# Creating anAutoSplit executable with PyInstaller: ./scripts/build.ps1 # # Dependencies: numpy>=1.23 # Updated types opencv-python-headless>=4.5.4,<4.6 # https://github.com/pyinstaller/pyinstaller/issues/6889 -PyQt6>=6.2.1 -PySide6 +PyQt6>=6.2.1 # Python 3.10 support ImageHash keyboard packaging Pillow -pyautogui +PyAutoGUI requests certifi toml @@ -29,5 +28,6 @@ pywin32>=301 winsdk>=v1.0.0b4 git+https://github.com/ranchen421/D3DShot.git#egg=D3DShot # https://github.com/SerpentAI/D3DShot/issues/44 # -# Build +# Build and compile resources PyInstaller +PySide6 diff --git a/scripts/start.ps1 b/scripts/start.ps1 index 70d6fd8b..d1e8ec08 100755 --- a/scripts/start.ps1 +++ b/scripts/start.ps1 @@ -1,3 +1,3 @@ param ([string]$p1) & "$PSScriptRoot/compile_resources.ps1" -python "$PSScriptRoot/../src/AutoSplit.py" $p1 +python3 "$PSScriptRoot/../src/AutoSplit.py" $p1 diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 86a95cbe..6e267b29 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -371,7 +371,7 @@ def __take_screenshot(self): error_messages.region() return - # save and open image + # Save and open image cv2.imwrite(screenshot_path, capture) os.startfile(screenshot_path) # nosec @@ -823,6 +823,7 @@ def closeEvent(self, a0: Optional[QtGui.QCloseEvent] = None): def exit_program(): if self.auto_control_loop: self.auto_control_loop.cancel() + self.capture_method.close(self) if a0 is not None: a0.accept() if self.is_auto_controlled: diff --git a/src/capture_method/WindowsGraphicsCaptureMethod.py b/src/capture_method/WindowsGraphicsCaptureMethod.py index 04fd41d1..b4d87f9a 100644 --- a/src/capture_method/WindowsGraphicsCaptureMethod.py +++ b/src/capture_method/WindowsGraphicsCaptureMethod.py @@ -30,7 +30,6 @@ class WindowsGraphicsCaptureMethod(CaptureMethodInterface): last_captured_frame: Optional[cv2.Mat] = None def __init__(self, autosplit: AutoSplit): - super().__init__(autosplit) if not is_valid_hwnd(autosplit.hwnd): return # Note: Must create in the same thread (can't use a global) otherwise when ran from LiveSplit it will raise: @@ -63,6 +62,8 @@ async def coroutine(): self.size = item.size self.frame_pool = frame_pool + super().__init__() + def close(self, autosplit: AutoSplit): if self.frame_pool: self.frame_pool.close() diff --git a/src/capture_method/__init__.py b/src/capture_method/__init__.py index 820bfe4c..f6272532 100644 --- a/src/capture_method/__init__.py +++ b/src/capture_method/__init__.py @@ -16,7 +16,7 @@ from capture_method.interface import CaptureMethodInterface from capture_method.VideoCaptureDeviceCaptureMethod import VideoCaptureDeviceCaptureMethod from capture_method.WindowsGraphicsCaptureMethod import WindowsGraphicsCaptureMethod -from utils import WINDOWS_BUILD_NUMBER +from utils import WINDOWS_BUILD_NUMBER, first if TYPE_CHECKING: from AutoSplit import AutoSplit @@ -44,7 +44,7 @@ class CaptureMethodMeta(EnumMeta): # Allow checking if simple string is enum def __contains__(self, other: str): try: - self(other) # pyright: ignore [reportGeneralTypeIssues] + self(other) # pyright: ignore [reportGeneralTypeIssues] pylint: disable=no-value-for-parameter except ValueError: return False else: @@ -87,29 +87,25 @@ def get_index(self, capture_method: Union[str, CaptureMethodEnum]): def get_method_by_index(self, index: int): """ - Returns first (default) capture method if the index is invalid. - - Returns `CaptureMethodEnum.NONE` if there are no capture method available. + Returns the `CaptureMethodEnum` at index. + If index is invalid, returns the first (default) `CaptureMethodEnum`. + Returns `CaptureMethodEnum.NONE` if there are no capture methods available. """ if len(self) <= 0: return CaptureMethodEnum.NONE if index < 0: - return next(iter(self)) + return first(self) return list(self.keys())[index] - def __getitem__(self, key: CaptureMethodEnum): - if key == CaptureMethodEnum.NONE: + def get(self, __key: CaptureMethodEnum): + """ + Returns the `CaptureMethodInfo` for `CaptureMethodEnum` if `CaptureMethodEnum` is available, + else defaults to the first available `CaptureMethodEnum`. + Returns the `CaptureMethodInterface` (default) implementation if there's no capture methods. + """ + if __key == CaptureMethodEnum.NONE or len(self) <= 0: return NONE_CAPTURE_METHOD - try: - return super().__getitem__(key) - # If requested method does not exists... - except KeyError: - try: - # ...fallback to the first one - return super().__getitem__(self.get_method_by_index(0)) - except KeyError: - # ...fallback to an empty capture method to avoid crashes - return NONE_CAPTURE_METHOD + return super().get(__key, first(self.values())) NONE_CAPTURE_METHOD = CaptureMethodInfo( @@ -119,19 +115,35 @@ def __getitem__(self, key: CaptureMethodEnum): implementation=CaptureMethodInterface ) -CAPTURE_METHODS = CaptureMethodDict({ - CaptureMethodEnum.BITBLT: CaptureMethodInfo( - name="BitBlt", - short_description="fastest, least compatible", - description=( - "\nA good default fast option. But it cannot properly record " - "\nOpenGL, Hardware Accelerated or Exclusive Fullscreen windows. " - "\nThe smaller the selected region, the more efficient it is. " - ), - implementation=BitBltCaptureMethod, +def test_for_media_capture(): + async def coroutine(): + return await (MediaCapture().initialize_async() or asyncio.sleep(0)) + try: + asyncio.run(coroutine()) + return True + except OSError: + return False + + +CAPTURE_METHODS = CaptureMethodDict() +CAPTURE_METHODS[CaptureMethodEnum.BITBLT] = CaptureMethodInfo( + name="BitBlt", + short_description="fastest, least compatible", + description=( + "\nA good default fast option. But it cannot properly record " + "\nOpenGL, Hardware Accelerated or Exclusive Fullscreen windows. " + "\nThe smaller the selected region, the more efficient it is. " ), - CaptureMethodEnum.WINDOWS_GRAPHICS_CAPTURE: CaptureMethodInfo( + + implementation=BitBltCaptureMethod, +) +if ( # Windows Graphics Capture requires a minimum Windows Build + WINDOWS_BUILD_NUMBER >= WGC_MIN_BUILD + # Our current implementation of Windows Graphics Capture requires at least one CaptureDevice + and test_for_media_capture() +): + CAPTURE_METHODS[CaptureMethodEnum.WINDOWS_GRAPHICS_CAPTURE] = CaptureMethodInfo( name="Windows Graphics Capture", short_description="fast, most compatible, capped at 60fps", description=( @@ -143,66 +155,46 @@ def __getitem__(self, key: CaptureMethodEnum): "\nCaps at around 60 FPS. " ), implementation=WindowsGraphicsCaptureMethod, + ) +CAPTURE_METHODS[CaptureMethodEnum.DESKTOP_DUPLICATION] = CaptureMethodInfo( + name="Direct3D Desktop Duplication", + short_description="slower, bound to display", + description=( + "\nDuplicates the desktop using Direct3D. " + "\nIt can record OpenGL and Hardware Accelerated windows. " + "\nAbout 10-15x slower than BitBlt. Not affected by window size. " + "\nOverlapping windows will show up and can't record across displays. " ), - CaptureMethodEnum.DESKTOP_DUPLICATION: CaptureMethodInfo( - name="Direct3D Desktop Duplication", - short_description="slower, bound to display", - description=( - "\nDuplicates the desktop using Direct3D. " - "\nIt can record OpenGL and Hardware Accelerated windows. " - "\nAbout 10-15x slower than BitBlt. Not affected by window size. " - "\nOverlapping windows will show up and can't record across displays. " - ), - implementation=DesktopDuplicationCaptureMethod, - ), - CaptureMethodEnum.PRINTWINDOW_RENDERFULLCONTENT: CaptureMethodInfo( - name="Force Full Content Rendering", - short_description="very slow, can affect rendering pipeline", - description=( - "\nUses BitBlt behind the scene, but passes a special flag " - "\nto PrintWindow to force rendering the entire desktop. " - "\nAbout 10-15x slower than BitBlt based on original window size " - "\nand can mess up some applications' rendering pipelines. " - ), - implementation=ForceFullContentRenderingCaptureMethod, + implementation=DesktopDuplicationCaptureMethod, +) +CAPTURE_METHODS[CaptureMethodEnum.PRINTWINDOW_RENDERFULLCONTENT] = CaptureMethodInfo( + name="Force Full Content Rendering", + short_description="very slow, can affect rendering pipeline", + description=( + "\nUses BitBlt behind the scene, but passes a special flag " + "\nto PrintWindow to force rendering the entire desktop. " + "\nAbout 10-15x slower than BitBlt based on original window size " + "\nand can mess up some applications' rendering pipelines. " ), - CaptureMethodEnum.VIDEO_CAPTURE_DEVICE: CaptureMethodInfo( - name="Video Capture Device", - short_description="see below", - description=( - "\nUses a Video Capture Device, like a webcam, virtual cam, or capture card. " - "\nYou can select one below. " - "\nThere are currently performance issues, but it might be more convenient. " - "\nIf you want to use this with OBS' Virtual Camera, use the Virtualcam plugin instead " - "\nhttps://obsproject.com/forum/resources/obs-virtualcam.949/." - ), - implementation=VideoCaptureDeviceCaptureMethod, + implementation=ForceFullContentRenderingCaptureMethod, +) +CAPTURE_METHODS[CaptureMethodEnum.VIDEO_CAPTURE_DEVICE] = CaptureMethodInfo( + name="Video Capture Device", + short_description="see below", + description=( + "\nUses a Video Capture Device, like a webcam, virtual cam, or capture card. " + "\nYou can select one below. " + "\nThere are currently performance issues, but it might be more convenient. " + "\nIf you want to use this with OBS' Virtual Camera, use the Virtualcam plugin instead " + "\nhttps://obsproject.com/forum/resources/obs-virtualcam.949/." ), -}) - - -def test_for_media_capture(): - async def coroutine(): - return await (MediaCapture().initialize_async() or asyncio.sleep(0)) - try: - asyncio.run(coroutine()) - return True - except OSError: - return False - - -# Detect and remove unsupported capture methods -if ( # Windows Graphics Capture requires a minimum Windows Build - WINDOWS_BUILD_NUMBER < WGC_MIN_BUILD - # Our current implementation of Windows Graphics Capture requires at least one CaptureDevice - or not test_for_media_capture() -): - CAPTURE_METHODS.pop(CaptureMethodEnum.WINDOWS_GRAPHICS_CAPTURE) + implementation=VideoCaptureDeviceCaptureMethod, +) def change_capture_method(selected_capture_method: CaptureMethodEnum, autosplit: AutoSplit): autosplit.capture_method.close(autosplit) - autosplit.capture_method = CAPTURE_METHODS[selected_capture_method].implementation(autosplit) + autosplit.capture_method = CAPTURE_METHODS.get(selected_capture_method).implementation(autosplit) if selected_capture_method == CaptureMethodEnum.VIDEO_CAPTURE_DEVICE: autosplit.select_region_button.setDisabled(True) autosplit.select_window_button.setDisabled(True) diff --git a/src/capture_method/interface.py b/src/capture_method/interface.py index d1646fd2..7f862fd2 100644 --- a/src/capture_method/interface.py +++ b/src/capture_method/interface.py @@ -12,15 +12,17 @@ class CaptureMethodInterface(): def __init__(self, autosplit: Optional[AutoSplit] = None): + # Some capture methods don't need an initialization process + pass + + def close(self, autosplit: AutoSplit): + # Some capture methods don't need to cleanup and release any resource pass def reinitialize(self, autosplit: AutoSplit): self.close(autosplit) self.__init__(autosplit) # pylint: disable=unnecessary-dunder-call - def close(self, autosplit: AutoSplit): - pass - def get_frame(self, autosplit: AutoSplit) -> tuple[Optional[cv2.Mat], bool]: """ Captures an image of the region for a window matching the given diff --git a/src/hotkeys.py b/src/hotkeys.py index 0201a1c9..055e101b 100644 --- a/src/hotkeys.py +++ b/src/hotkeys.py @@ -7,6 +7,7 @@ import pyautogui from PyQt6 import QtWidgets +import error_messages from utils import START_AUTO_SPLITTER_TEXT, fire_and_forget, is_digit if TYPE_CHECKING: @@ -24,6 +25,10 @@ HOTKEYS: list[Hotkeys] = ["split", "reset", "skip_split", "undo_split", "pause", "toggle_auto_reset_image"] +def remove_all_hotkeys(): + keyboard.unhook_all() + + def before_setting_hotkey(autosplit: AutoSplit): """ Do all of these after you click "Set Hotkey" but before you type the hotkey @@ -224,38 +229,42 @@ def set_hotkey(autosplit: AutoSplit, hotkey: Hotkeys, preselected_hotkey_name: s # Disable some buttons before_setting_hotkey(autosplit) - # New thread points to callback. this thread is needed or GUI will freeze - # while the program waits for user input on the hotkey + # This needs to be run async or GUI will freeze while the program waits for user input @fire_and_forget - def callback(): - hotkey_name = preselected_hotkey_name if preselected_hotkey_name else __read_hotkey() - - __remove_key_already_set(autosplit, hotkey_name) - - action = __get_hotkey_action(autosplit, hotkey) - setattr( - autosplit, - f"{hotkey}_hotkey", - # keyboard.add_hotkey doesn't give the last keyboard event, so we can't __validate_keypad. - # This means "ctrl + num 5" and "ctrl + 5" will both be registered. - # For that reason, we still prefer keyboard.hook_key for single keys. - # keyboard module allows you to hit multiple keys for a hotkey. they are joined together by +. - keyboard.add_hotkey(hotkey_name, action) - if "+" in hotkey_name - # We need to inspect the event to know if it comes from numpad because of _canonial_names. - # See: https://github.com/boppreh/keyboard/issues/161#issuecomment-386825737 - # The best way to achieve this is make our own hotkey handling on top of hook - # See: https://github.com/boppreh/keyboard/issues/216#issuecomment-431999553 - else keyboard.hook_key( - hotkey_name, - lambda keyboard_event: _hotkey_action(keyboard_event, hotkey_name, action)) - ) - - if autosplit.SettingsWidget: - getattr(autosplit.SettingsWidget, f"{hotkey}_input").setText(hotkey_name) - autosplit.settings_dict[f"{hotkey}_hotkey"] = hotkey_name - autosplit.after_setting_hotkey_signal.emit() + def read_and_set_hotkey(): + try: + hotkey_name = preselected_hotkey_name if preselected_hotkey_name else __read_hotkey() + + __remove_key_already_set(autosplit, hotkey_name) + + action = __get_hotkey_action(autosplit, hotkey) + setattr( + autosplit, + f"{hotkey}_hotkey", + # keyboard.add_hotkey doesn't give the last keyboard event, so we can't __validate_keypad. + # This means "ctrl + num 5" and "ctrl + 5" will both be registered. + # For that reason, we still prefer keyboard.hook_key for single keys. + # keyboard module allows you to hit multiple keys for a hotkey. they are joined together by +. + keyboard.add_hotkey(hotkey_name, action) + if "+" in hotkey_name + # We need to inspect the event to know if it comes from numpad because of _canonial_names. + # See: https://github.com/boppreh/keyboard/issues/161#issuecomment-386825737 + # The best way to achieve this is make our own hotkey handling on top of hook + # See: https://github.com/boppreh/keyboard/issues/216#issuecomment-431999553 + else keyboard.hook_key( + hotkey_name, + lambda keyboard_event: _hotkey_action(keyboard_event, hotkey_name, action)) + ) + + if autosplit.SettingsWidget: + getattr(autosplit.SettingsWidget, f"{hotkey}_input").setText(hotkey_name) + autosplit.settings_dict[f"{hotkey}_hotkey"] = hotkey_name + except Exception as exception: # pylint: disable=broad-except # We really want to catch everything here + error = exception + autosplit.show_error_signal.emit(lambda: error_messages.exception_traceback(error)) + finally: + autosplit.after_setting_hotkey_signal.emit() # Try to remove the previously set hotkey if there is one. _unhook(getattr(autosplit, f"{hotkey}_hotkey")) - callback() + read_and_set_hotkey() diff --git a/src/user_profile.py b/src/user_profile.py index 8a79e994..0dbe9324 100644 --- a/src/user_profile.py +++ b/src/user_profile.py @@ -3,14 +3,13 @@ import os from typing import TYPE_CHECKING, TypedDict, Union, cast -import keyboard import toml from PyQt6 import QtCore, QtWidgets import error_messages from capture_method import CAPTURE_METHODS, CaptureMethodEnum, Region, change_capture_method from gen import design, settings as settings_ui -from hotkeys import HOTKEYS, set_hotkey +from hotkeys import HOTKEYS, remove_all_hotkeys, set_hotkey from utils import auto_split_directory if TYPE_CHECKING: @@ -141,7 +140,7 @@ def __load_settings_from_file(autosplit: AutoSplit, load_settings_file_path: str autosplit.show_error_signal.emit(error_messages.invalid_settings) return False - keyboard.unhook_all() + remove_all_hotkeys() if not autosplit.is_auto_controlled: for hotkey, hotkey_name in [(hotkey, f"{hotkey}_hotkey") for hotkey in HOTKEYS]: if autosplit.settings_dict[hotkey_name]: diff --git a/src/utils.py b/src/utils.py index 1c408bc0..ec7e84e6 100644 --- a/src/utils.py +++ b/src/utils.py @@ -103,7 +103,7 @@ def wrapped(*args: P.args, **kwargs: P.kwargs): FROZEN = hasattr(sys, "frozen") """Running from build made by PyInstaller""" auto_split_directory = os.path.dirname(sys.executable if FROZEN else os.path.abspath(__file__)) -"""The directory of either AutoSplit.exe or AutoSplit.py""" +"""The directory of either the AutoSplit executable or AutoSplit.py""" # Shared strings # DIRTY_VERSION_EXTENSION = "" diff --git a/typings/d3dshot/d3dshot.pyi b/typings/d3dshot/d3dshot.pyi index d6fd36db..011f7759 100644 --- a/typings/d3dshot/d3dshot.pyi +++ b/typings/d3dshot/d3dshot.pyi @@ -2,14 +2,14 @@ This type stub file was generated by pyright. """ from collections import deque -from typing import Any +from typing import Optional # noqa Y037 import cv2 from d3dshot.capture_output import CaptureOutput from d3dshot.display import Display from numpy.typing import NDArray -Unknown = Any +# class Singleton(type): @@ -35,13 +35,13 @@ class D3DShot(metaclass=Singleton): capture_output: CaptureOutput frame_buffer_size: int frame_buffer: deque - previous_screenshot: Unknown | None - region: Unknown | None + previous_screenshot: Optional + region: Optional _pil_is_available: bool _numpy_is_available: bool _pytorch_is_available: bool _pytorch_gpu_is_available: bool - _capture_thread: Unknown | None + _capture_thread: Optional _is_capturing: bool @property diff --git a/typings/d3dshot/display.pyi b/typings/d3dshot/display.pyi index 56299537..93b934f7 100644 --- a/typings/d3dshot/display.pyi +++ b/typings/d3dshot/display.pyi @@ -4,9 +4,9 @@ This type stub file was generated by pyright. import ctypes -from typing import Any, Literal +from typing import Literal, Optional # noqa Y037 -Unknown = Any +# class Display: @@ -18,10 +18,10 @@ class Display: scale_factor: int is_primary: bool hmonitor: int - dxgi_output: Unknown | None = ... - dxgi_adapter: Unknown | None = ... - d3d_device: Unknown | None = ... - d3d_device_context: Unknown | None = ... + dxgi_output: Optional = ... + dxgi_adapter: Optional = ... + d3d_device: Optional = ... + d3d_device_context: Optional = ... dxgi_output_duplication: ctypes.pointer def __init__( diff --git a/typings/keyboard/_keyboard_event.pyi b/typings/keyboard/_keyboard_event.pyi index 900a65d5..6e8800c9 100644 --- a/typings/keyboard/_keyboard_event.pyi +++ b/typings/keyboard/_keyboard_event.pyi @@ -2,10 +2,7 @@ This type stub file was generated by pyright. https://github.com/boppreh/keyboard/issues/505 """ -from typing import Any, Literal - -Unknown = Any - +from typing import Any, Literal, Optional # noqa Y037 KEY_DOWN: Literal["down"] KEY_UP: Literal["up"] @@ -16,7 +13,7 @@ class KeyboardEvent: scan_code: None | int = ... name: None | str = ... time: None | float = ... - device: Unknown | None = ... + device: Optional = ... modifiers: None | tuple = ... is_keypad: None | bool = ... @@ -26,7 +23,7 @@ class KeyboardEvent: scan_code: None | int, name: None | str = ..., time: None | float = ..., - device: Unknown | None = ..., + device: Optional = ..., modifiers: None | tuple = ..., is_keypad: None | bool = ...) -> None: ... From 24e2ef925ef6b35c1556a8c63f48318630ae26bf Mon Sep 17 00:00:00 2001 From: Avasam Date: Sun, 31 Jul 2022 16:05:43 -0400 Subject: [PATCH 131/137] Fixed windows not re-opening --- src/menu_bar.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/menu_bar.py b/src/menu_bar.py index 9b81b087..c61f3179 100644 --- a/src/menu_bar.py +++ b/src/menu_bar.py @@ -35,7 +35,7 @@ def __init__(self): def open_about(autosplit: AutoSplit): - if not autosplit.AboutWidget: + if not autosplit.AboutWidget or cast(QtWidgets.QWidget, autosplit.AboutWidget).isHidden(): autosplit.AboutWidget = __AboutWidget() @@ -71,7 +71,7 @@ def do_not_ask_me_again_state_changed(self): def open_update_checker(autosplit: AutoSplit, latest_version: str, check_on_open: bool): - if not autosplit.UpdateCheckerWidget: + if not autosplit.UpdateCheckerWidget or cast(QtWidgets.QWidget, autosplit.UpdateCheckerWidget).isHidden(): autosplit.UpdateCheckerWidget = __UpdateCheckerWidget(latest_version, autosplit, check_on_open) @@ -276,5 +276,5 @@ def hotkey_connect(hotkey: Hotkeys): def open_settings(autosplit: AutoSplit): - if not autosplit.SettingsWidget: + if not autosplit.SettingsWidget or cast(QtWidgets.QDialog, autosplit.SettingsWidget).isHidden(): autosplit.SettingsWidget = __SettingsWidget(autosplit) From a94c7e6751b8cffbcf9f5b9f1691011661b5da40 Mon Sep 17 00:00:00 2001 From: Avasam Date: Sun, 31 Jul 2022 17:54:11 -0400 Subject: [PATCH 132/137] Updated flake8 requirement and GITHUB_REPOSITORY generated var --- scripts/compile_resources.ps1 | 10 +++++++++- scripts/requirements-dev.txt | 5 +++-- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/scripts/compile_resources.ps1 b/scripts/compile_resources.ps1 index 1a71ce10..a1a4ba2f 100755 --- a/scripts/compile_resources.ps1 +++ b/scripts/compile_resources.ps1 @@ -11,7 +11,15 @@ Write-Host 'Generated code from .ui files' $build_vars_path = "$PSScriptRoot/../src/gen/build_vars.py" $BUILD_NUMBER = Get-Date -Format yyMMddHHmm -$GITHUB_REPOSITORY = If ($Env:GITHUB_HEAD_REPOSITORY) { $Env:GITHUB_HEAD_REPOSITORY } Else { 'Toufool/Auto-Split' } +$GITHUB_REPOSITORY = $Env:GITHUB_HEAD_REPOSITORY +If (-not $GITHUB_REPOSITORY) { + $repo_url = git config --get remote.origin.url + $GITHUB_REPOSITORY = $repo_url.substring(19, $repo_url.length - 19 - 4) +} +If (-not $GITHUB_REPOSITORY) { + $GITHUB_REPOSITORY = 'Toufool/Auto-Split' +} + New-Item $build_vars_path -ItemType File -Force | Out-Null Add-Content $build_vars_path "AUTOSPLIT_BUILD_NUMBER = `"$BUILD_NUMBER`"" Add-Content $build_vars_path "AUTOSPLIT_GITHUB_REPOSITORY = `"$GITHUB_REPOSITORY`"" diff --git a/scripts/requirements-dev.txt b/scripts/requirements-dev.txt index 349c243a..d904744d 100644 --- a/scripts/requirements-dev.txt +++ b/scripts/requirements-dev.txt @@ -8,8 +8,9 @@ # # Linting and formatters bandit -isort -flake8 +# https://github.com/PyCQA/flake8-pyi/issues/257 +# https://github.com/gforcada/flake8-isort/issues/115 +flake8<5 # Not supported by pyi and isort plugins flake8-pyi>=22.7 # New checks flake8-quotes flake8-isort From e1e035eb4e99328b76c97504f9be8140c2f23f83 Mon Sep 17 00:00:00 2001 From: Avasam Date: Mon, 15 Aug 2022 17:30:30 -0400 Subject: [PATCH 133/137] Fix #155 --- src/error_messages.py | 4 ++++ src/hotkeys.py | 17 +++++++++++++++-- 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/src/error_messages.py b/src/error_messages.py index e3291ffe..8e195f53 100644 --- a/src/error_messages.py +++ b/src/error_messages.py @@ -103,6 +103,10 @@ def invalid_settings(): set_text_message("Invalid settings file.") +def invalid_hotkey(hotkey_name: str): + set_text_message(f'Invalid hotkey "{hotkey_name}"') + + def no_settings_file_on_open(): set_text_message( "No settings file found. One can be loaded on open if placed in the same folder as the AutoSplit executable") diff --git a/src/hotkeys.py b/src/hotkeys.py index 055e101b..ed998a6f 100644 --- a/src/hotkeys.py +++ b/src/hotkeys.py @@ -220,6 +220,14 @@ def toggle_auto_reset_image(): # reduce duplicated code. We should use a dictionary of hotkey class or something. +def is_valid_hotkey_name(hotkey_name: str): + keys = hotkey_name.split("+") + for key in keys: + if key and not keyboard.is_modifier(keyboard.key_to_scan_codes(key)[0]): + return True + return False + + def set_hotkey(autosplit: AutoSplit, hotkey: Hotkeys, preselected_hotkey_name: str = ""): if autosplit.SettingsWidget: # Unfocus all fields @@ -235,6 +243,13 @@ def read_and_set_hotkey(): try: hotkey_name = preselected_hotkey_name if preselected_hotkey_name else __read_hotkey() + if not is_valid_hotkey_name(hotkey_name): + autosplit.show_error_signal.emit(lambda: error_messages.invalid_hotkey(hotkey_name)) + return + + # Try to remove the previously set hotkey if there is one + _unhook(getattr(autosplit, f"{hotkey}_hotkey")) + # Remove any hotkey using the same key combination __remove_key_already_set(autosplit, hotkey_name) action = __get_hotkey_action(autosplit, hotkey) @@ -265,6 +280,4 @@ def read_and_set_hotkey(): finally: autosplit.after_setting_hotkey_signal.emit() - # Try to remove the previously set hotkey if there is one. - _unhook(getattr(autosplit, f"{hotkey}_hotkey")) read_and_set_hotkey() From 4d77d662f4e25ba6a23e9ed32d1cd12ec2fab00b Mon Sep 17 00:00:00 2001 From: Avasam Date: Mon, 15 Aug 2022 17:32:25 -0400 Subject: [PATCH 134/137] Alpha 5 --- src/utils.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/utils.py b/src/utils.py index ec7e84e6..88b4bae8 100644 --- a/src/utils.py +++ b/src/utils.py @@ -106,9 +106,9 @@ def wrapped(*args: P.args, **kwargs: P.kwargs): """The directory of either the AutoSplit executable or AutoSplit.py""" # Shared strings -# DIRTY_VERSION_EXTENSION = "" -DIRTY_VERSION_EXTENSION = "-" + AUTOSPLIT_BUILD_NUMBER +DIRTY_VERSION_EXTENSION = "" +# DIRTY_VERSION_EXTENSION = "-" + AUTOSPLIT_BUILD_NUMBER """Set DIRTY_VERSION_EXTENSION to an empty string to generate a clean version number""" -AUTOSPLIT_VERSION = "2.0.0-alpha.4" + DIRTY_VERSION_EXTENSION +AUTOSPLIT_VERSION = "2.0.0-alpha.5" + DIRTY_VERSION_EXTENSION START_AUTO_SPLITTER_TEXT = "Start Auto Splitter" GITHUB_REPOSITORY = AUTOSPLIT_GITHUB_REPOSITORY From 2f7f8f8e194b7c8b877184f9e5ff5053474a3205 Mon Sep 17 00:00:00 2001 From: Avasam Date: Mon, 15 Aug 2022 19:09:56 -0400 Subject: [PATCH 135/137] Updated Flake8 to v5 --- PyInstaller/hooks/hook-cv2.py | 24 ------------------------ scripts/lint.ps1 | 1 + scripts/requirements-dev.txt | 6 +++--- src/utils.py | 7 ++++--- 4 files changed, 8 insertions(+), 30 deletions(-) delete mode 100644 PyInstaller/hooks/hook-cv2.py diff --git a/PyInstaller/hooks/hook-cv2.py b/PyInstaller/hooks/hook-cv2.py deleted file mode 100644 index 620319d3..00000000 --- a/PyInstaller/hooks/hook-cv2.py +++ /dev/null @@ -1,24 +0,0 @@ -""" -Copyright (c) 2020 PyInstaller Development Team. - -This file is distributed under the terms of the GNU General Public -License (version 2.0 or later). - -The full license is available in LICENSE.GPL.txt, distributed with -this software. - -SPDX-License-Identifier: GPL-2.0-or-later - -https://github.com/pyinstaller/pyinstaller-hooks-contrib/blob/master/src/_pyinstaller_hooks_contrib/hooks/stdhooks/hook-cv2.py -""" - -from PyInstaller.utils.hooks import collect_data_files, collect_dynamic_libs - -hiddenimports = ["numpy"] - -# Include any DLLs from site-packages/cv2 (opencv_videoio_ffmpeg*.dll can be found there in the PyPI version) -binaries = collect_dynamic_libs("cv2") - -# https://github.com/pyinstaller/pyinstaller-hooks-contrib/issues/110 -# OpenCV loader from 4.5.4.60 requires extra config files and modules -datas = collect_data_files("cv2", include_py_files=True, includes=["**/*.py"]) diff --git a/scripts/lint.ps1 b/scripts/lint.ps1 index 29ef583c..f5931602 100755 --- a/scripts/lint.ps1 +++ b/scripts/lint.ps1 @@ -3,6 +3,7 @@ Set-Location "$PSScriptRoot/.." $exitCodes = 0 Write-Host "`nRunning Pyright..." +$Env:PYRIGHT_PYTHON_FORCE_VERSION = 'latest' pyright --warnings $exitCodes += $LastExitCode if ($LastExitCode -gt 0) { diff --git a/scripts/requirements-dev.txt b/scripts/requirements-dev.txt index d904744d..386e2a57 100644 --- a/scripts/requirements-dev.txt +++ b/scripts/requirements-dev.txt @@ -10,10 +10,10 @@ bandit # https://github.com/PyCQA/flake8-pyi/issues/257 # https://github.com/gforcada/flake8-isort/issues/115 -flake8<5 # Not supported by pyi and isort plugins -flake8-pyi>=22.7 # New checks +flake8>=5 # flake8-pyi deprecation warnings +flake8-pyi>=22.8.1 # flake8 5 support flake8-quotes -flake8-isort +flake8-isort>=4.2 # flake8 5 support pep8-naming pylint>=2.13.9 # Respect ignore configuration options with --recursive=y pyright diff --git a/src/utils.py b/src/utils.py index 88b4bae8..50064d32 100644 --- a/src/utils.py +++ b/src/utils.py @@ -12,7 +12,8 @@ import cv2 from win32 import win32gui -from gen.build_vars import AUTOSPLIT_BUILD_NUMBER, AUTOSPLIT_GITHUB_REPOSITORY +from gen.build_vars import AUTOSPLIT_BUILD_NUMBER # noqa: F401 # Don't error with clean version number +from gen.build_vars import AUTOSPLIT_GITHUB_REPOSITORY if TYPE_CHECKING: from typing_extensions import ParamSpec, TypeGuard @@ -106,8 +107,8 @@ def wrapped(*args: P.args, **kwargs: P.kwargs): """The directory of either the AutoSplit executable or AutoSplit.py""" # Shared strings -DIRTY_VERSION_EXTENSION = "" -# DIRTY_VERSION_EXTENSION = "-" + AUTOSPLIT_BUILD_NUMBER +# DIRTY_VERSION_EXTENSION = "" +DIRTY_VERSION_EXTENSION = "-" + AUTOSPLIT_BUILD_NUMBER """Set DIRTY_VERSION_EXTENSION to an empty string to generate a clean version number""" AUTOSPLIT_VERSION = "2.0.0-alpha.5" + DIRTY_VERSION_EXTENSION START_AUTO_SPLITTER_TEXT = "Start Auto Splitter" From f0f27de4c8f410c93cad9247d011357398175aa2 Mon Sep 17 00:00:00 2001 From: zalgo Date: Fri, 19 Aug 2022 12:27:18 +0900 Subject: [PATCH 136/137] Change resize for mask --- src/AutoSplit.py | 7 +++---- src/AutoSplitImage.py | 11 ++++++++++- src/compare.py | 5 ++--- 3 files changed, 15 insertions(+), 8 deletions(-) diff --git a/src/AutoSplit.py b/src/AutoSplit.py index 6e267b29..2ec75f2d 100644 --- a/src/AutoSplit.py +++ b/src/AutoSplit.py @@ -21,7 +21,7 @@ import error_messages import user_profile from auto_control import start_auto_control_loop -from AutoSplitImage import COMPARISON_RESIZE, START_KEYWORD, AutoSplitImage, ImageType +from AutoSplitImage import START_KEYWORD, AutoSplitImage, ImageType from capture_method import CaptureMethodEnum, CaptureMethodInterface from gen import about, design, settings, update_checker from hotkeys import HOTKEYS, after_setting_hotkey, send_command @@ -737,7 +737,7 @@ def gui_changes_on_reset(self, safe_to_reload_start_image: bool = False): def __get_capture_for_comparison(self): """ - Grab capture region and resize for comparison + Grab capture region for comparison """ capture, is_old_image = self.capture_method.get_frame(self) @@ -755,8 +755,7 @@ def __get_capture_for_comparison(self): return (None if not is_valid_image(capture) - else cv2.resize(capture, COMPARISON_RESIZE, interpolation=cv2.INTER_NEAREST), - is_old_image) + else capture, is_old_image) def __reset_if_should(self, capture: Optional[cv2.Mat]): """ diff --git a/src/AutoSplitImage.py b/src/AutoSplitImage.py index 2da283fc..8e485ec6 100644 --- a/src/AutoSplitImage.py +++ b/src/AutoSplitImage.py @@ -2,6 +2,7 @@ import os from enum import Enum +from math import sqrt from typing import TYPE_CHECKING, Optional, Union import cv2 @@ -19,6 +20,7 @@ COMPARISON_RESIZE_WIDTH = 320 COMPARISON_RESIZE_HEIGHT = 240 COMPARISON_RESIZE = (COMPARISON_RESIZE_WIDTH, COMPARISON_RESIZE_HEIGHT) +COMPARISON_RESIZE_AREA = COMPARISON_RESIZE_WIDTH * COMPARISON_RESIZE_HEIGHT LOWER_BOUND = np.array([0, 0, 0, 1], dtype="uint8") UPPER_BOUND = np.array([MAXBYTE, MAXBYTE, MAXBYTE, MAXBYTE], dtype="uint8") START_KEYWORD = "start_auto_splitter" @@ -108,8 +110,14 @@ def __read_image_bytes(self, path: str): error_messages.image_type(path) return - image = cv2.resize(image, COMPARISON_RESIZE, interpolation=cv2.INTER_NEAREST) self._has_transparency = check_if_image_has_transparency(image) + comparison_resize = COMPARISON_RESIZE + if self._has_transparency: + alpha_channel = image[:, :, 3] + resize_control_ratio = int(sqrt(COMPARISON_RESIZE_AREA / cv2.countNonZero(alpha_channel))) + 1 + comparison_resize = (resize_control_ratio * COMPARISON_RESIZE_WIDTH, + resize_control_ratio * COMPARISON_RESIZE_HEIGHT) + image = cv2.resize(image, comparison_resize, interpolation=cv2.INTER_NEAREST) # If image has transparency, create a mask if self._has_transparency: # Create mask based on resized, nearest neighbor interpolated split image @@ -134,6 +142,7 @@ def compare_with_capture( if not is_valid_image(self.bytes) or not is_valid_image(capture): return 0.0 + capture = cv2.resize(capture, self.bytes.shape[1::-1]) comparison_method = self.__get_comparison_method(default) if comparison_method == 0: return compare_l2_norm(self.bytes, capture, self.mask) diff --git a/src/compare.py b/src/compare.py index 99d38829..7906740f 100644 --- a/src/compare.py +++ b/src/compare.py @@ -5,7 +5,6 @@ import cv2 import imagehash # https://github.com/JohannesBuchner/imagehash/issues/151 -import numpy as np from PIL import Image from win32con import MAXBYTE @@ -52,7 +51,7 @@ def compare_l2_norm(source: cv2.Mat, capture: cv2.Mat, mask: Optional[cv2.Mat] = # The L2 Error is summed across all pixels, so this normalizes max_error = sqrt(source.size) * MAXBYTE \ if not is_valid_image(mask)\ - else sqrt(np.count_nonzero(mask) * MASK_SIZE_MULTIPLIER) + else sqrt(cv2.countNonZero(mask) * MASK_SIZE_MULTIPLIER) if not max_error: return 0.0 @@ -78,7 +77,7 @@ def compare_template(source: cv2.Mat, capture: cv2.Mat, mask: Optional[cv2.Mat] # that the value can be. Used for normalizing from 0 to 1. max_error = source.size * MAXBYTE * MAXBYTE \ if not is_valid_image(mask) \ - else np.count_nonzero(mask) + else cv2.countNonZero(mask) return 1 - (min_val / max_error) From 4860660bfc49c3be4338ea71a49af5215d4d4e8b Mon Sep 17 00:00:00 2001 From: zalgo Date: Fri, 19 Aug 2022 15:16:14 +0900 Subject: [PATCH 137/137] Do not enlarge image & keep aspect ratio (important for 16:9) --- src/AutoSplitImage.py | 34 ++++++++++++++++------------------ 1 file changed, 16 insertions(+), 18 deletions(-) diff --git a/src/AutoSplitImage.py b/src/AutoSplitImage.py index 8e485ec6..81e8879c 100644 --- a/src/AutoSplitImage.py +++ b/src/AutoSplitImage.py @@ -17,12 +17,7 @@ from AutoSplit import AutoSplit # Resize to these width and height so that FPS performance increases -COMPARISON_RESIZE_WIDTH = 320 -COMPARISON_RESIZE_HEIGHT = 240 -COMPARISON_RESIZE = (COMPARISON_RESIZE_WIDTH, COMPARISON_RESIZE_HEIGHT) -COMPARISON_RESIZE_AREA = COMPARISON_RESIZE_WIDTH * COMPARISON_RESIZE_HEIGHT -LOWER_BOUND = np.array([0, 0, 0, 1], dtype="uint8") -UPPER_BOUND = np.array([MAXBYTE, MAXBYTE, MAXBYTE, MAXBYTE], dtype="uint8") +COMPARISON_RESIZE_RESOLUTION = 320 * 240 START_KEYWORD = "start_auto_splitter" RESET_KEYWORD = "reset" @@ -111,20 +106,23 @@ def __read_image_bytes(self, path: str): return self._has_transparency = check_if_image_has_transparency(image) - comparison_resize = COMPARISON_RESIZE - if self._has_transparency: - alpha_channel = image[:, :, 3] - resize_control_ratio = int(sqrt(COMPARISON_RESIZE_AREA / cv2.countNonZero(alpha_channel))) + 1 - comparison_resize = (resize_control_ratio * COMPARISON_RESIZE_WIDTH, - resize_control_ratio * COMPARISON_RESIZE_HEIGHT) - image = cv2.resize(image, comparison_resize, interpolation=cv2.INTER_NEAREST) - # If image has transparency, create a mask if self._has_transparency: + image_bgr, image_alpha = image[:, :, :3], image[:, :, 3] + scale = sqrt(min(1, COMPARISON_RESIZE_RESOLUTION / cv2.countNonZero(image_alpha))) + image_bgr = cv2.resize(image_bgr, dsize=None, fx=scale, fy=scale) + image_alpha = cv2.resize(image_alpha, dsize=None, fx=scale, fy=scale, interpolation=cv2.INTER_NEAREST) + image = np.dstack((image_bgr, image_alpha)) + # If image has transparency, create a mask # Create mask based on resized, nearest neighbor interpolated split image - self.mask = cv2.inRange(image, LOWER_BOUND, UPPER_BOUND) - # Add Alpha channel if missing - elif image.shape[2] == 3: - image = cv2.cvtColor(image, cv2.COLOR_BGR2BGRA) + self.mask = cv2.inRange(image_alpha, np.array([1], dtype="uint8"), np.array([MAXBYTE], dtype="uint8")) + else: + image_height, image_width = image.shape[:2] + image_resolution = image_height * image_width + scale = sqrt(COMPARISON_RESIZE_RESOLUTION / image_resolution) + image = cv2.resize(image, dsize=None, fx=scale, fy=scale) + # Add Alpha channel if missing + if image.shape[2] == 3: + image = cv2.cvtColor(image, cv2.COLOR_BGR2BGRA) self.bytes = image