6433593370

Committed 06 Oct 2023 03:30PM UTC coverage: 73.825% (-9.3%) from 83.134%

Build # 6433593370

Build Type

push

github

Committed by

web-flow

Commit Message

[feature] Add GUI Toolkit Commands (backport #5260) (#5285)

[feature] Add GUI Toolkit Commands (#5260)

* Markdown

* Delete

* Add AFXApp and AFXBoolKeyword

* Delete

* Update headings

* Create parse.py

* Update parse.py

* Unicode Spaces

* Update .pre-commit-config.yaml

* Update md types

* Update Kernel plug-in registration commands.md

* Generated python stubs

* Add class inheritance

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Revert "Update .pre-commit-config.yaml"

This reverts commit 9d3aef3cc.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fix mypy errors

* Delete parse.py

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fix return types and imports

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update AFXColumnItems.md

* Update abaqusGui.py

* Add class/global flags

* Delete flags.py

* Fix flags

* Fix

* Skip mypy

* Update abaqusGui.py

* Update constants.py

* Create kernelAccess.py

* Add plugin docs

* Revert changes by docformatter

* Delete markdown files

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
(cherry picked from commit a65ff5df8)

Co-authored-by: Hailin Wang <hailin.wang@connect.polyu.hk>

Run Details

3661 of 3661 new or added lines in 151 files covered. (100.0%)

24137 of 32695 relevant lines covered (73.82%)

0.74 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/abaqus/PlugInRegistration/MessageMaps.py

"""Message maps are used by classes derived from FXObject (which includes most GUI classes) to route messages
sent to the object to a message handling method.

A typical use might be to route a message from a button in a dialog to one of the dialog's methods so that
some action is taken when the button is pressed.
"""

from __future__ import annotations

from typing import Callable

from .FXObject import FXObject


def FXMAPFUNC(object: FXObject, messageType: int, messageId: int, method: Callable):
    """Creates an entry in the object's message map that will route a message to a method.

    Parameters
    ----------
    object : FXObject
        An instance of the class in which the message map entry is to be made. Typically this is "self".
    messageType : int
        An integer flag specifying the message type (e.g. SEL_COMMAND).
    messageId : int
        An integer specifying the message ID.
    method : Callable
        The method to which the message is to be routed. This method must be specified by including the class name (e.g. MyDB.myMethod).
    """


def FXMAPFUNCS(object: FXObject, messageType: int, startMessageId: int, endMessageId: int, method: Callable):
    """Creates multiple entries in the object's message map that will route messages to a method.

    Parameters
    ----------
    object : FXObject
        An instance of the class in which the message map entry is to be made. Typically this is "self".
    messageType : int
        An integer flag specifying the message type (e.g. SEL_COMMAND).
    startMessageId : int
        An integer specifying the starting message ID.
    endMessageId : int
        An integer specifying the ending message ID.
    method : Callable
        The method to which the message is to be routed. This method must be specified by including the class name (e.g. MyDB.myMethod).
    """


def MKUINT(messageId: int, messageType: int):
    """Creates a message selector by combining a message ID and a message type.

    Parameters
    ----------
    messageId : int
        An integer specifying the message ID.
    messageType : int
        An integer flag specifying the message type (e.g. SEL_COMMAND).
    """


def SELID(selector: int):
    """Returns the message ID from a message selector.

    Parameters
    ----------
    selector : int
        A message selector.
    """


def SELTYPE(selector: int):
    """Returns the message type from a message selector.

    Parameters
    ----------
    selector : int
        A message selector.
    """

1	"""Message maps are used by classes derived from FXObject (which includes most GUI classes) to route messages
2	sent to the object to a message handling method.
3
4	A typical use might be to route a message from a button in a dialog to one of the dialog's methods so that
5	some action is taken when the button is pressed.
6	"""
7
8	from __future__ import annotations	×
9
10	from typing import Callable	×
11
12	from .FXObject import FXObject	×
13
14
15	def FXMAPFUNC(object: FXObject, messageType: int, messageId: int, method: Callable):	×
16	"""Creates an entry in the object's message map that will route a message to a method.
17
18	Parameters
19	----------
20	object : FXObject
21	An instance of the class in which the message map entry is to be made. Typically this is "self".
22	messageType : int
23	An integer flag specifying the message type (e.g. SEL_COMMAND).
24	messageId : int
25	An integer specifying the message ID.
26	method : Callable
27	The method to which the message is to be routed. This method must be specified by including the class name (e.g. MyDB.myMethod).
28	"""
29
30
31	def FXMAPFUNCS(object: FXObject, messageType: int, startMessageId: int, endMessageId: int, method: Callable):	×
32	"""Creates multiple entries in the object's message map that will route messages to a method.
33
34	Parameters
35	----------
36	object : FXObject
37	An instance of the class in which the message map entry is to be made. Typically this is "self".
38	messageType : int
39	An integer flag specifying the message type (e.g. SEL_COMMAND).
40	startMessageId : int
41	An integer specifying the starting message ID.
42	endMessageId : int
43	An integer specifying the ending message ID.
44	method : Callable
45	The method to which the message is to be routed. This method must be specified by including the class name (e.g. MyDB.myMethod).
46	"""
47
48
49	def MKUINT(messageId: int, messageType: int):	×
50	"""Creates a message selector by combining a message ID and a message type.
51
52	Parameters
53	----------
54	messageId : int
55	An integer specifying the message ID.
56	messageType : int
57	An integer flag specifying the message type (e.g. SEL_COMMAND).
58	"""
59
60
61	def SELID(selector: int):	×
62	"""Returns the message ID from a message selector.
63
64	Parameters
65	----------
66	selector : int
67	A message selector.
68	"""
69
70
71	def SELTYPE(selector: int):	×
72	"""Returns the message type from a message selector.
73
74	Parameters
75	----------
76	selector : int
77	A message selector.
78	"""

haiiliin / abqpy / 6433593370

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous