luke
/
klayout
mirror of https://github.com/KLayout/klayout.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Doc updates

This commit is contained in:
Matthias Koefferlein 2022-12-09 23:53:41 +01:00
parent 9607594020
commit 43089f31e4
13 changed files with 1830 additions and 345 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/ant/ant/gsiDeclAnt.cc
View File

@ -1226,7 +1226,7 @@ gsi::ClassExt<lay::LayoutViewBase> layout_view_decl (
gsi::arg ("category"),
"@brief Unregisters the template or templates with the given category string on this particular view\n"
"\n"
"See \\Annotation#unregister_template for a method doing the same on application level."
"See \\Annotation#unregister_templates for a method doing the same on application level."
"This method is hardly useful normally, but can be used when customizing layout views as "
"individual widgets.\n"
"\n"

6
src/doc/doc/about/drc_ref_drc.xml
View File

@ -31,7 +31,7 @@ The following global functions are relevant for the DRC expressions:
<li><a href="/about/drc_ref_global.xml#angle">angle</a> </li>
<li><a href="/about/drc_ref_global.xml#area">area</a> </li>
<li><a href="/about/drc_ref_global.xml#area_ratio">area_ratio</a> </li>
<li><a href="/about/drc_ref_global.xml#bbox_area_ratio">bbox_area_ratio</a> </li>
<li><a href="/about/drc_ref_global.xml#bbox_aspect_ratio">bbox_aspect_ratio</a> </li>
<li><a href="/about/drc_ref_global.xml#bbox_height">bbox_height</a> </li>
<li><a href="/about/drc_ref_global.xml#bbox_max">bbox_max</a> </li>
<li><a href="/about/drc_ref_global.xml#bbox_min">bbox_min</a> </li>
@ -358,8 +358,8 @@ The plain function is equivalent to "primary.bbox_width".
This method acts on edge expressions and delivers a specific part of each edge.
See <a href="/about/drc_ref_layer.xml#centers">layer#centers</a> for details about this functionality.
</p>
<a name="corners (in condition)"/><h2>"corners (in condition)" - Applies smoothing</h2>
<keyword name="corners (in condition)"/>
<a name="corners"/><h2>"corners" - Applies smoothing</h2>
<keyword name="corners"/>
<p>Usage:</p>
<ul>
<li><tt>expression.corners</tt></li>

14
src/doc/doc/about/drc_ref_global.xml
View File

@ -8,8 +8,8 @@
<title>DRC Reference: Global Functions</title>
<keyword name="global"/>
<h2-index/>
<a name="angle (in condition)"/><h2>"angle (in condition)" - In universal DRC context: selects edges based on their orientation</h2>
<keyword name="angle (in condition)"/>
<a name="angle"/><h2>"angle" - In universal DRC context: selects edges based on their orientation</h2>
<keyword name="angle"/>
<p>Usage:</p>
<ul>
<li><tt>angle (in condition)</tt></li>
@ -1038,8 +1038,8 @@ l2 = layout("second_layout.gds")
</p><p>
For further methods on the source object see <a href="/about/drc_ref_source.xml">Source</a>.
</p>
<a name="length (in condition)"/><h2>"length (in condition)" - Computes the total edge length of an edge layer or in universal DRC context: selects edges based on a length condition</h2>
<keyword name="length (in condition)"/>
<a name="length"/><h2>"length" - Computes the total edge length of an edge layer or in universal DRC context: selects edges based on a length condition</h2>
<keyword name="length"/>
<p>Usage:</p>
<ul>
<li><tt>length (in condition)</tt></li>
@ -1913,9 +1913,9 @@ The tile border specifies the distance to which shapes are collected into the
tile. In order words, when processing a tile, shapes within the border distance
participate in the operations.
</p><p>
For some operations such as booleans (<a href="#and">and</a>, <a href="#or">or</a>, ...), <a href="#size">size</a> and the DRC functions (<a href="#width">width</a>, <a href="#space">space</a>, ...)
a tile border is automatically established. For other operations such as <a href="#with_area">with_area</a>
or <a href="#edges">edges</a>, the exact distance is unknown, because such operations may have a long range.
For some operations such as booleans (<a href="/about/drc_ref_layer.xml#and">Layer#and</a>, <a href="/about/drc_ref_layer.xml#or">Layer#or</a>, ...), <a href="/about/drc_ref_layer.xml#size">Layer#size</a> and the DRC functions (<a href="/about/drc_ref_layer.xml#width">Layer#width</a>, <a href="/about/drc_ref_layer.xml#space">Layer#space</a>, ...)
a tile border is automatically established. For other operations such as <a href="/about/drc_ref_layer.xml#with_area">Layer#with_area</a>
or <a href="/about/drc_ref_layer.xml#edges">Layer#edges</a>, the exact distance is unknown, because such operations may have a long range.
In that cases, no border is used. The tile_borders function may be used to specify a minimum border
which is used in that case. That allows taking into account at least shapes within the
given range, although not necessarily all.

14
src/doc/doc/about/drc_ref_layer.xml
View File

@ -546,7 +546,7 @@ In the same fashion, "perimeter" applies to the perimeter of the polygon.
use the respective dimension for filtering the polygon.
</p><p>
Note that it's basically possible to use the polygon filters on any input - computed and secondaries.
In fact, plain "area" for example is a shortcut for "<a href="/about/drc_ref_drc.xml#primary">DRC#primary</a>.area" indicating that
In fact, plain "area" for example is a shortcut for "<a href="/about/drc_ref_global.xml#primary">primary</a>.area" indicating that
the area of primary shapes are supposed to be computed.
However, any input other than the primary is not necessarily complete or it may
consist of multiple polygons. Hence the computed values may be too big or too small.
@ -656,7 +656,7 @@ Note that the precise form of the example above is
out = l1.drc((primary &amp; secondary(l2)).area &gt; 1.0)
</pre>
</p><p>
The "<a href="/about/drc_ref_drc.xml#secondary">DRC#secondary</a>" operator indicates that "l2" is to be used as secondary input to the "drc" function. Only
The "<a href="/about/drc_ref_global.xml#secondary">secondary</a>" operator indicates that "l2" is to be used as secondary input to the "drc" function. Only
in this form, the operators of the boolean AND can be reversed:
</p><p>
<pre>
@ -3094,14 +3094,14 @@ This feature has been introduced in version 0.23.2.
</ul>
<p>
This method can be applied to original layers - i.e. ones that have
been created with <a href="#input">input</a>. By default, a small box (2x2 DBU) will be produced on each
been created with <a href="/about/drc_ref_global.xml#input">input</a>. By default, a small box (2x2 DBU) will be produced on each
selected text. By using the "as_dots" option, degenerated point-like edges will be
produced.
</p><p>
The preferred method however is to use true text layers created with <a href="#labels">labels</a>.
The preferred method however is to use true text layers created with <a href="/about/drc_ref_global.xml#labels">labels</a>.
In this case, without specifying "as_dots" or "as_boxes" retains the text
objects as such a text filtering is applied. In contrast to this, layers generated
with <a href="#input">input</a> cannot maintain the text nature of the selected objects and
with <a href="/about/drc_ref_global.xml#input">input</a> cannot maintain the text nature of the selected objects and
produce dots or small polygon boxes in the <a href="#texts">texts</a> method.
</p><p>
Texts can be selected either by exact match string or a pattern match with a
@ -3151,7 +3151,7 @@ The effect of the operation is shown in these examples:
<li><tt>layer.texts_not([ options ])</tt></li>
</ul>
<p>
This method can be applied to true text layers obtained with <a href="#labels">labels</a>.
This method can be applied to true text layers obtained with <a href="/about/drc_ref_global.xml#labels">labels</a>.
In this case, without specifying "as_dots" or "as_boxes" retains the text
objects as such. Only text filtering is applied.
</p><p>
@ -3338,7 +3338,7 @@ on <a href="#without_angle">without_angle</a>. This is because <a href="#without
one edge does not match the criterion. The logical opposite of "one edge matches" however is
"both edges do not match".
</p><p>
The following images demonstrate some use cases of <a href="#with_angle">with_angle</a> and <a href="#without_angle:">without_angle:</a>
The following images demonstrate some use cases of <a href="#with_angle">with_angle</a> and <a href="#without_angle">without_angle</a> :
</p><p>
<table>
<tr>

4
src/drc/drc/built-in-macros/_drc_complex_ops.rb
View File

@ -30,7 +30,7 @@ module DRC
# @li \global#angle @/li
# @li \global#area @/li
# @li \global#area_ratio @/li
# @li \global#bbox_area_ratio @/li
# @li \global#bbox_aspect_ratio @/li
# @li \global#bbox_height @/li
# @li \global#bbox_max @/li
# @li \global#bbox_min @/li
@ -755,7 +755,7 @@ CODE
end
# %DRC%
# @name corners (in condition)
# @name corners
# @brief Applies smoothing
# @synopsis expression.corners
# @synopsis expression.corners(as_dots)

8
src/drc/drc/built-in-macros/_drc_cop_integration.rb
View File

@ -214,7 +214,7 @@ module DRC
# use the respective dimension for filtering the polygon.
#
# Note that it's basically possible to use the polygon filters on any input - computed and secondaries.
# In fact, plain "area" for example is a shortcut for "\DRC#primary.area" indicating that
# In fact, plain "area" for example is a shortcut for "\global#primary.area" indicating that
# the area of primary shapes are supposed to be computed.
# However, any input other than the primary is not necessarily complete or it may
# consist of multiple polygons. Hence the computed values may be too big or too small.
@ -324,7 +324,7 @@ module DRC
# out = l1.drc((primary & secondary(l2)).area > 1.0)
# @/code
#
# The "\DRC#secondary" operator indicates that "l2" is to be used as secondary input to the "drc" function. Only
# The "\global#secondary" operator indicates that "l2" is to be used as secondary input to the "drc" function. Only
# in this form, the operators of the boolean AND can be reversed:
#
# @code
@ -740,7 +740,7 @@ CODE
# \DRC# expressions (see \Layer#drc and \global#rectilinear for more details).
# %DRC%
# @name length (in condition)
# @name length
# @brief Computes the total edge length of an edge layer or in universal DRC context: selects edges based on a length condition
# @synopsis length (in condition)
# @synopsis length(layer)
@ -752,7 +752,7 @@ CODE
# the operation acts similar to \Layer#with_length.
# %DRC%
# @name angle (in condition)
# @name angle
# @brief In universal DRC context: selects edges based on their orientation
# @synopsis angle (in condition)
#

10
src/drc/drc/built-in-macros/_drc_engine.rb
View File

@ -783,9 +783,9 @@ module DRC
# tile. In order words, when processing a tile, shapes within the border distance
# participate in the operations.
#
# For some operations such as booleans (\and, \or, ...), \size and the DRC functions (\width, \space, ...)
# a tile border is automatically established. For other operations such as \with_area
# or \edges, the exact distance is unknown, because such operations may have a long range.
# For some operations such as booleans (\Layer#and, \Layer#or, ...), \Layer#size and the DRC functions (\Layer#width, \Layer#space, ...)
# a tile border is automatically established. For other operations such as \Layer#with_area
# or \Layer#edges, the exact distance is unknown, because such operations may have a long range.
# In that cases, no border is used. The tile_borders function may be used to specify a minimum border
# which is used in that case. That allows taking into account at least shapes within the
# given range, although not necessarily all.
@ -1936,7 +1936,7 @@ CODE
with_area
with_area_ratio
with_bbox_area
with_bbox_area_ratio
with_bbox_aspect_ratio
with_bbox_height
with_bbox_max
with_bbox_min
@ -1947,7 +1947,7 @@ CODE
without_area
without_area_ratio
without_bbox
without_bbox_area_ratio
without_bbox_aspect_ratio
without_bbox_height
without_bbox_max
without_bbox_min

10
src/drc/drc/built-in-macros/_drc_layer.rb
View File

@ -901,7 +901,7 @@ CODE
# one edge does not match the criterion. The logical opposite of "one edge matches" however is
# "both edges do not match".
#
# The following images demonstrate some use cases of \with_angle and \without_angle:
# The following images demonstrate some use cases of \with_angle and \without_angle :
#
# @table
# @tr
@ -1107,14 +1107,14 @@ CODE
# @synopsis layer.texts(p)
# @synopsis layer.texts([ options ])
# This method can be applied to original layers - i.e. ones that have
# been created with \input. By default, a small box (2x2 DBU) will be produced on each
# been created with \global#input. By default, a small box (2x2 DBU) will be produced on each
# selected text. By using the "as_dots" option, degenerated point-like edges will be
# produced.
#
# The preferred method however is to use true text layers created with \labels.
# The preferred method however is to use true text layers created with \global#labels.
# In this case, without specifying "as_dots" or "as_boxes" retains the text
# objects as such a text filtering is applied. In contrast to this, layers generated
# with \input cannot maintain the text nature of the selected objects and
# with \global#input cannot maintain the text nature of the selected objects and
# produce dots or small polygon boxes in the \texts method.
#
# Texts can be selected either by exact match string or a pattern match with a
@ -1163,7 +1163,7 @@ CODE
# @synopsis layer.texts_not(p)
# @synopsis layer.texts_not([ options ])
#
# This method can be applied to true text layers obtained with \labels.
# This method can be applied to true text layers obtained with \global#labels.
# In this case, without specifying "as_dots" or "as_boxes" retains the text
# objects as such. Only text filtering is applied.
#

8
src/laybasic/laybasic/gsiDeclLayLayoutViewBase.cc
View File

@ -1977,7 +1977,7 @@ LAYBASIC_PUBLIC Class<lay::LayoutViewBase> decl_LayoutViewBase ("lay", "LayoutVi
"@brief Sends a mouse move event\n"
"\n"
"This method is intended to emulate the mouse move events sent by Qt normally in environments where Qt is not present. "
"The arguments follow the conventions used within \\Plugin#mouse_move_event for example.\n"
"The arguments follow the conventions used within \\Plugin#mouse_moved_event for example.\n"
"\n"
"This method was introduced in version 0.28."
) +
@ -1985,7 +1985,7 @@ LAYBASIC_PUBLIC Class<lay::LayoutViewBase> decl_LayoutViewBase ("lay", "LayoutVi
"@brief Sends a mouse button press event\n"
"\n"
"This method is intended to emulate the mouse button press events sent by Qt normally in environments where Qt is not present. "
"The arguments follow the conventions used within \\Plugin#mouse_move_event for example.\n"
"The arguments follow the conventions used within \\Plugin#mouse_moved_event for example.\n"
"\n"
"This method was introduced in version 0.28."
) +
@ -1993,7 +1993,7 @@ LAYBASIC_PUBLIC Class<lay::LayoutViewBase> decl_LayoutViewBase ("lay", "LayoutVi
"@brief Sends a mouse button double-click event\n"
"\n"
"This method is intended to emulate the mouse button double-click events sent by Qt normally in environments where Qt is not present. "
"The arguments follow the conventions used within \\Plugin#mouse_move_event for example.\n"
"The arguments follow the conventions used within \\Plugin#mouse_moved_event for example.\n"
"\n"
"This method was introduced in version 0.28."
) +
@ -2001,7 +2001,7 @@ LAYBASIC_PUBLIC Class<lay::LayoutViewBase> decl_LayoutViewBase ("lay", "LayoutVi
"@brief Sends a mouse button release event\n"
"\n"
"This method is intended to emulate the mouse button release events sent by Qt normally in environments where Qt is not present. "
"The arguments follow the conventions used within \\Plugin#mouse_move_event for example.\n"
"The arguments follow the conventions used within \\Plugin#mouse_moved_event for example.\n"
"\n"
"This method was introduced in version 0.28."
) +

1589
src/pymod/distutils_src/klayout/dbcore.pyi
View File

File diff suppressed because it is too large Load Diff

372
src/pymod/distutils_src/klayout/laycore.pyi
View File

@ -55,6 +55,10 @@ class PixelBuffer:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> PixelBuffer:
r"""
@brief Creates a copy of self
"""
def __eq__(self, other: object) -> bool:
r"""
@brief Returns a value indicating whether self is identical to the other image
@ -239,6 +243,10 @@ class BitmapBuffer:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> BitmapBuffer:
r"""
@brief Creates a copy of self
"""
def __eq__(self, other: object) -> bool:
r"""
@brief Returns a value indicating whether self is identical to the other image
@ -395,6 +403,10 @@ class MacroExecutionContext:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> MacroExecutionContext:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Creates a new object of this class
@ -635,6 +647,10 @@ class MacroInterpreter:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> MacroInterpreter:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Creates a new object of this class
@ -1635,6 +1651,10 @@ class LayerProperties:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> LayerProperties:
r"""
@brief Creates a copy of self
"""
def __eq__(self, other: object) -> bool:
r"""
@brief Equality
@ -2221,6 +2241,11 @@ class LayerPropertiesNodeRef(LayerPropertiesNode):
@brief Creates a \LayerPropertiesNode object as a copy of the content of this node.
This method is mainly provided for backward compatibility with 0.24 and before.
"""
def __deepcopy__(self) -> LayerPropertiesNode:
r"""
@brief Creates a \LayerPropertiesNode object as a copy of the content of this node.
This method is mainly provided for backward compatibility with 0.24 and before.
"""
def _assign(self, other: LayerProperties) -> None:
r"""
@brief Assigns another object to self
@ -2271,14 +2296,14 @@ class LayerPropertiesNodeRef(LayerPropertiesNode):
r"""
@brief Assigns the contents of the 'other' object to self.
This version accepts a \LayerPropertiesNode object and allows modification of the layer node's hierarchy. Assignment will reconfigure the layer node in the view.
This version accepts a \LayerProperties object. Assignment will change the properties of the layer in the view.
"""
@overload
def assign(self, other: LayerProperties) -> None:
r"""
@brief Assigns the contents of the 'other' object to self.
This version accepts a \LayerProperties object. Assignment will change the properties of the layer in the view.
This version accepts a \LayerPropertiesNode object and allows modification of the layer node's hierarchy. Assignment will reconfigure the layer node in the view.
"""
def delete(self) -> None:
r"""
@ -2317,6 +2342,10 @@ class LayerPropertiesIterator:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> LayerPropertiesIterator:
r"""
@brief Creates a copy of self
"""
def __eq__(self, other: object) -> bool:
r"""
@brief Equality
@ -2562,12 +2591,12 @@ class LayoutViewBase:
@overload
def __eq__(self, other: object) -> bool:
r"""
@brief Compares an enum with an integer value
@brief Compares two enums
"""
@overload
def __eq__(self, other: object) -> bool:
r"""
@brief Compares two enums
@brief Compares an enum with an integer value
"""
@overload
def __init__(self, i: int) -> None:
@ -2592,12 +2621,12 @@ class LayoutViewBase:
@overload
def __ne__(self, other: object) -> bool:
r"""
@brief Compares two enums for inequality
@brief Compares an enum with an integer for inequality
"""
@overload
def __ne__(self, other: object) -> bool:
r"""
@brief Compares an enum with an integer for inequality
@brief Compares two enums for inequality
"""
def __repr__(self) -> str:
r"""
@ -2865,6 +2894,24 @@ class LayoutViewBase:
@brief A event indicating that annotations have been added or removed
This event has been added in version 0.25.
"""
on_apply_technology: None
r"""
Getter:
@brief An event indicating that a cellview has requested a new technology
If the technology of a cellview is changed, this event is triggered.
The integer parameter of this event will indicate the cellview that has changed.
This event has been introduced in version 0.28.
Setter:
@brief An event indicating that a cellview has requested a new technology
If the technology of a cellview is changed, this event is triggered.
The integer parameter of this event will indicate the cellview that has changed.
This event has been introduced in version 0.28.
"""
on_cell_visibility_changed: None
r"""
Getter:
@ -3873,6 +3920,16 @@ class LayoutViewBase:
r"""
@brief Hides the given cell for the given cellview
"""
def icon_for_layer(self, iter: LayerPropertiesIterator, w: int, h: int, dpr: float, di_off: Optional[int] = ..., no_state: Optional[bool] = ...) -> PixelBuffer:
r"""
@brief Creates an icon pixmap for the given layer.
The icon will have size w times h pixels multiplied by the device pixel ratio (dpr). The dpr is The number of physical pixels per logical pixels on high-DPI displays.
'di_off' will shift the dither pattern by the given number of (physical) pixels. If 'no_state' is true, the icon will not reflect visibility or validity states but rather the display style.
This method has been introduced in version 0.28.
"""
def image(self, id: int) -> Image:
r"""
@brief Gets the image given by an ID
@ -4895,6 +4952,10 @@ class CellView:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> CellView:
r"""
@brief Creates a copy of self
"""
def __eq__(self, other: object) -> bool:
r"""
@brief Equality: indicates whether the cellviews refer to the same one
@ -5677,11 +5738,11 @@ class ActionBase:
def icon(self) -> None:
r"""
WARNING: This variable can only be set, not retrieved.
@brief Sets the icon to the given image file
@brief Sets the icon to the given \QIcon object
@param file The image file to load for the icon
@param qicon The QIcon object
Passing an empty string will reset the icon.
This variant has been added in version 0.28.
"""
icon_text: str
r"""
@ -6398,6 +6459,10 @@ class Cursor:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> Cursor:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Creates a new object of this class
@ -6516,6 +6581,10 @@ class ButtonState:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> ButtonState:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Creates a new object of this class
@ -6670,6 +6739,10 @@ class KeyCode:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> KeyCode:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Creates a new object of this class
@ -6900,6 +6973,10 @@ class DoubleValue:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> DoubleValue:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Creates a new object of this class
@ -7003,6 +7080,10 @@ class IntValue:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> IntValue:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Creates a new object of this class
@ -7106,6 +7187,10 @@ class StringValue:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> StringValue:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Creates a new object of this class
@ -7213,6 +7298,10 @@ class StringListValue:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> StringListValue:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Creates a new object of this class
@ -7516,6 +7605,10 @@ class BrowserSource_Native:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> BrowserSource_Native:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Creates a new object of this class
@ -7631,6 +7724,10 @@ class BrowserSource:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> BrowserSource:
r"""
@brief Creates a copy of self
"""
def __init__(self, arg0: str) -> None:
r"""
@brief Constructs a BrowserSource object with a default HTML string
@ -8027,6 +8124,10 @@ class InputDialog:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> InputDialog:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Creates a new object of this class
@ -8224,6 +8325,10 @@ class FileDialog:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> FileDialog:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Creates a new object of this class
@ -8417,6 +8522,10 @@ class MessageBox(QMainWindow_Native):
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> MessageBox:
r"""
@brief Creates a copy of self
"""
def _create(self) -> None:
r"""
@brief Ensures the C++ object is created
@ -8519,6 +8628,10 @@ class NetlistObjectPath:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> NetlistObjectPath:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Creates a new object of this class
@ -8615,6 +8728,10 @@ class NetlistObjectsPath:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> NetlistObjectsPath:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Creates a new object of this class
@ -9103,6 +9220,10 @@ class BasicAnnotation:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> BasicAnnotation:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Creates a new object of this class
@ -9305,6 +9426,13 @@ class Annotation(BasicAnnotation):
@brief Gets the vertical angle code for use with the \angle_constraint method
If this value is specified for the angle constraint, only vertical rulers are allowed.
"""
OutlineAngle: ClassVar[int]
r"""
@brief Gets the angle measurement ruler outline code for use with the \outline method
When this outline style is specified, the ruler is drawn to indicate the angle between the first and last segment.
This constant has been introduced in version 0.28.
"""
OutlineBox: ClassVar[int]
r"""
@brief Gets the box outline code for use with the \outline method
@ -9333,6 +9461,13 @@ class Annotation(BasicAnnotation):
This constant has been introduced in version 0.26.
"""
OutlineRadius: ClassVar[int]
r"""
@brief Gets the radius measurement ruler outline code for use with the \outline method
When this outline style is specified, the ruler is drawn to indicate a radius defined by at least three points of the ruler.
This constant has been introduced in version 0.28.
"""
OutlineXY: ClassVar[int]
r"""
@brief Gets the xy outline code for use with the \outline method
@ -9375,6 +9510,7 @@ class Annotation(BasicAnnotation):
r"""
@brief Specifies auto-metric ruler mode for the \register_template method
In auto-metric mode, a ruler can be placed with a single click and p1/p2 will be determined from the neighborhood.
This constant has been introduced in version 0.25
"""
RulerModeNormal: ClassVar[int]
@ -9387,8 +9523,23 @@ class Annotation(BasicAnnotation):
r"""
@brief Specifies single-click ruler mode for the \register_template method
In single click-mode, a ruler can be placed with a single click and p1 will be == p2.
This constant has been introduced in version 0.25
"""
RulerMultiSegment: ClassVar[int]
r"""
@brief Specifies multi-segment mode
In multi-segment mode, multiple segments can be created. The ruler is finished with a double click.
This constant has been introduced in version 0.28
"""
RulerThreeClicks: ClassVar[int]
r"""
@brief Specifies three-click ruler mode for the \register_template method
In this ruler mode, two segments are created for angle and circle radius measurements. Three mouse clicks are required.
This constant has been introduced in version 0.28
"""
StyleArrowBoth: ClassVar[int]
r"""
@brief Gets the both arrow ends style code for use the \style method
@ -9543,22 +9694,47 @@ class Annotation(BasicAnnotation):
Getter:
@brief Gets the first point of the ruler or marker
The points of the ruler or marker are always given in micron units in floating-point coordinates.
This method is provided for backward compatibility. Starting with version 0.28, rulers can be multi-segmented. Use \points or \seg_p1 to retrieve the points of the ruler segments.
@return The first point
Setter:
@brief Sets the first point of the ruler or marker
The points of the ruler or marker are always given in micron units in floating-point coordinates.
This method is provided for backward compatibility. Starting with version 0.28, rulers can be multi-segmented. Use \points= to specify the ruler segments.
"""
p2: db.DPoint
r"""
Getter:
@brief Gets the second point of the ruler or marker
The points of the ruler or marker are always given in micron units in floating-point coordinates.
This method is provided for backward compatibility. Starting with version 0.28, rulers can be multi-segmented. Use \points or \seg_p1 to retrieve the points of the ruler segments.
@return The second point
Setter:
@brief Sets the second point of the ruler or marker
The points of the ruler or marker are always given in micron units in floating-point coordinates.
This method is provided for backward compatibility. Starting with version 0.28, rulers can be multi-segmented. Use \points= to specify the ruler segments.
"""
points: List[db.DPoint]
r"""
Getter:
@brief Gets the points of the ruler
A single-segmented ruler has two points. Rulers with more points have more segments correspondingly. Note that the point list may have one point only (single-point ruler) or may even be empty.
Use \points= to set the segment points. Use \segments to get the number of segments and \seg_p1 and \seg_p2 to get the first and second point of one segment.
Multi-segmented rulers have been introduced in version 0.28
Setter:
@brief Sets the points for a (potentially) multi-segmented ruler
See \points for a description of multi-segmented rulers. The list of points passed to this method is cleaned from duplicates before being stored inside the ruler.
This method has been introduced in version 0.28.
"""
snap: bool
r"""
@ -9631,85 +9807,12 @@ class Annotation(BasicAnnotation):
This method has been introduced in version 0.25
"""
@classmethod
def angle_any(cls) -> int:
def from_s(cls, s: str) -> Annotation:
r"""
@brief Gets the any angle code for use with the \angle_constraint method
If this value is specified for the angle constraint, all angles will be allowed.
"""
@classmethod
def angle_diagonal(cls) -> int:
r"""
@brief Gets the diagonal angle code for use with the \angle_constraint method
If this value is specified for the angle constraint, only multiples of 45 degree are allowed.
"""
@classmethod
def angle_global(cls) -> int:
r"""
@brief Gets the global angle code for use with the \angle_constraint method.
This code will tell the ruler or marker to use the angle constraint defined globally.
"""
@classmethod
def angle_horizontal(cls) -> int:
r"""
@brief Gets the horizontal angle code for use with the \angle_constraint method
If this value is specified for the angle constraint, only horizontal rulers are allowed.
"""
@classmethod
def angle_ortho(cls) -> int:
r"""
@brief Gets the ortho angle code for use with the \angle_constraint method
If this value is specified for the angle constraint, only multiples of 90 degree are allowed.
"""
@classmethod
def angle_vertical(cls) -> int:
r"""
@brief Gets the vertical angle code for use with the \angle_constraint method
If this value is specified for the angle constraint, only vertical rulers are allowed.
"""
@classmethod
def outline_box(cls) -> int:
r"""
@brief Gets the box outline code for use with the \outline method
When this outline style is specified, a box is drawn with the corners specified by the start and end point. All box edges are drawn in the style specified with the \style attribute.
"""
@classmethod
def outline_diag(cls) -> int:
r"""
@brief Gets the diagonal output code for use with the \outline method
When this outline style is specified, a line connecting start and end points in the given style (ruler, arrow or plain line) is drawn.
"""
@classmethod
def outline_diag_xy(cls) -> int:
r"""
@brief Gets the xy plus diagonal outline code for use with the \outline method
@brief outline_xy code used by the \outline method
When this outline style is specified, three lines are drawn: one horizontal from left to right and attached to the end of that a line from the bottom to the top. Another line is drawn connecting the start and end points directly. The lines are drawn in the specified style (see \style method).
"""
@classmethod
def outline_diag_yx(cls) -> int:
r"""
@brief Gets the yx plus diagonal outline code for use with the \outline method
When this outline style is specified, three lines are drawn: one vertical from bottom to top and attached to the end of that a line from the left to the right. Another line is drawn connecting the start and end points directly. The lines are drawn in the specified style (see \style method).
"""
@classmethod
def outline_ellipse(cls) -> int:
r"""
@brief Gets the ellipse outline code for use with the \outline method
When this outline style is specified, an ellipse is drawn with the extensions specified by the start and end point. The contour drawn as a line.
@brief Creates a ruler from a string representation
This function creates a ruler from the string returned by \to_s.
This constant has been introduced in version 0.26.
"""
@classmethod
def outline_xy(cls) -> int:
r"""
@brief Gets the xy outline code for use with the \outline method
When this outline style is specified, two lines are drawn: one horizontal from left to right and attached to the end of that a line from the bottom to the top. The lines are drawn in the specified style (see \style method).
"""
@classmethod
def outline_yx(cls) -> int:
r"""
@brief Gets the yx outline code for use with the \outline method
When this outline style is specified, two lines are drawn: one vertical from bottom to top and attached to the end of that a line from the left to the right. The lines are drawn in the specified style (see \style method).
This method was introduced in version 0.28.
"""
@classmethod
def register_template(cls, annotation: BasicAnnotation, title: str, mode: Optional[int] = ...) -> None:
@ -9728,60 +9831,6 @@ class Annotation(BasicAnnotation):
This method has been added in version 0.25.
"""
@classmethod
def style_arrow_both(cls) -> int:
r"""
@brief Gets the both arrow ends style code for use the \style method
When this style is specified, a two-headed arrow is drawn.
"""
@classmethod
def style_arrow_end(cls) -> int:
r"""
@brief Gets the end arrow style code for use the \style method
When this style is specified, an arrow is drawn pointing from the start to the end point.
"""
@classmethod
def style_arrow_start(cls) -> int:
r"""
@brief Gets the start arrow style code for use the \style method
When this style is specified, an arrow is drawn pointing from the end to the start point.
"""
@classmethod
def style_cross_both(cls) -> int:
r"""
@brief Gets the line style code for use with the \style method
When this style is specified, a cross is drawn at both points.
This constant has been added in version 0.26.
"""
@classmethod
def style_cross_end(cls) -> int:
r"""
@brief Gets the line style code for use with the \style method
When this style is specified, a cross is drawn at the end point.
This constant has been added in version 0.26.
"""
@classmethod
def style_cross_start(cls) -> int:
r"""
@brief Gets the line style code for use with the \style method
When this style is specified, a cross is drawn at the start point.
This constant has been added in version 0.26.
"""
@classmethod
def style_line(cls) -> int:
r"""
@brief Gets the line style code for use with the \style method
When this style is specified, a plain line is drawn.
"""
@classmethod
def style_ruler(cls) -> int:
r"""
@brief Gets the ruler style code for use the \style method
When this style is specified, the annotation will show a ruler with some ticks at distances indicating a decade of units and a suitable subdivision into minor ticks at intervals of 1, 2 or 5 units.
"""
@classmethod
def unregister_templates(cls, category: str) -> None:
r"""
@brief Unregisters the template or templates with the given category string globally
@ -9883,17 +9932,42 @@ class Annotation(BasicAnnotation):
This method was introduced in version 0.25.
"""
def text(self) -> str:
def seg_p1(self, segment_index: int) -> db.DPoint:
r"""
@brief Gets the first point of the given segment.
The segment is indicated by the segment index which is a number between 0 and \segments-1.
This method has been introduced in version 0.28.
"""
def seg_p2(self, segment_index: int) -> db.DPoint:
r"""
@brief Gets the second point of the given segment.
The segment is indicated by the segment index which is a number between 0 and \segments-1.
The second point of a segment is also the first point of the following segment if there is one.
This method has been introduced in version 0.28.
"""
def segments(self) -> int:
r"""
@brief Gets the number of segments.
This method returns the number of segments the ruler is made up. Even though the ruler can be one or even zero points, the number of segments is at least 1.
This method has been introduced in version 0.28.
"""
def text(self, index: Optional[int] = ...) -> str:
r"""
@brief Returns the formatted text for the main label
The index parameter indicates which segment to use (0 is the first one). It has been added in version 0.28.
"""
def text_x(self) -> str:
def text_x(self, index: Optional[int] = ...) -> str:
r"""
@brief Returns the formatted text for the x-axis label
The index parameter indicates which segment to use (0 is the first one). It has been added in version 0.28.
"""
def text_y(self) -> str:
def text_y(self, index: Optional[int] = ...) -> str:
r"""
@brief Returns the formatted text for the y-axis label
The index parameter indicates which segment to use (0 is the first one). It has been added in version 0.28.
"""
def to_s(self) -> str:
r"""
@ -10088,6 +10162,10 @@ class ObjectInstPath:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> ObjectInstPath:
r"""
@brief Creates a copy of self
"""
def __eq__(self, b: object) -> bool:
r"""
@brief Equality of two ObjectInstPath objects
@ -10419,6 +10497,10 @@ class ImageDataMapping:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> ImageDataMapping:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Create a new data mapping object with default settings
@ -10568,6 +10650,10 @@ class BasicImage:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> BasicImage:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Creates a new object of this class

78
src/pymod/distutils_src/klayout/rdbcore.pyi
View File

@ -35,6 +35,10 @@ class RdbReference:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> RdbReference:
r"""
@brief Creates a copy of self
"""
def __init__(self, trans: db.DCplxTrans, parent_cell_id: int) -> None:
r"""
@brief Creates a reference with a given transformation and parent cell ID
@ -378,23 +382,23 @@ class RdbCategory:
@return The category ID
"""
@overload
def scan_collection(self, cell: RdbCell, trans: db.CplxTrans, edge_pairs: db.EdgePairs, flat: Optional[bool] = ...) -> None:
def scan_collection(self, cell: RdbCell, trans: db.CplxTrans, edge_pairs: db.EdgePairs, flat: Optional[bool] = ..., with_properties: Optional[bool] = ...) -> None:
r"""
@brief Turns the given edge pair collection into a hierarchical or flat report database
This a another flavour of \scan_collection accepting an edge pair collection.
This method has been introduced in version 0.26.
This method has been introduced in version 0.26. The 'with_properties' argument has been added in version 0.28.
"""
@overload
def scan_collection(self, cell: RdbCell, trans: db.CplxTrans, edges: db.Edges, flat: Optional[bool] = ...) -> None:
def scan_collection(self, cell: RdbCell, trans: db.CplxTrans, edges: db.Edges, flat: Optional[bool] = ..., with_properties: Optional[bool] = ...) -> None:
r"""
@brief Turns the given edge collection into a hierarchical or flat report database
This a another flavour of \scan_collection accepting an edge collection.
This method has been introduced in version 0.26.
This method has been introduced in version 0.26. The 'with_properties' argument has been added in version 0.28.
"""
@overload
def scan_collection(self, cell: RdbCell, trans: db.CplxTrans, region: db.Region, flat: Optional[bool] = ...) -> None:
def scan_collection(self, cell: RdbCell, trans: db.CplxTrans, region: db.Region, flat: Optional[bool] = ..., with_properties: Optional[bool] = ...) -> None:
r"""
@brief Turns the given region into a hierarchical or flat report database
The exact behavior depends on the nature of the region. If the region is a hierarchical (original or deep) region and the 'flat' argument is false, this method will produce a hierarchical report database in the given category. The 'cell_id' parameter is ignored in this case. Sample references will be produced to supply minimal instantiation information.
@ -403,30 +407,19 @@ class RdbCategory:
The transformation argument needs to supply the dbu-to-micron transformation.
This method has been introduced in version 0.26.
"""
@overload
def scan_layer(self, layout: db.Layout, layer: int) -> None:
r"""
@brief Scans a layer from a layout into this category
Creates RDB items for each polygon or edge shape read from the each cell in the layout on the given layer and puts them into this category.
New cells will be generated for every cell encountered in the layout.
Other settings like database unit, description, top cell etc. are not made in the RDB.
If 'with_properties' is true, user properties will be turned into tagged values as well.
This method has been introduced in version 0.23.
This method has been introduced in version 0.26. The 'with_properties' argument has been added in version 0.28.
"""
@overload
def scan_layer(self, layout: db.Layout, layer: int, cell: db.Cell) -> None:
def scan_collection(self, cell: RdbCell, trans: db.CplxTrans, texts: db.Texts, flat: Optional[bool] = ..., with_properties: Optional[bool] = ...) -> None:
r"""
@brief Scans a layer from a layout into this category, starting with a given cell
Creates RDB items for each polygon or edge shape read from the cell and it's children in the layout on the given layer and puts them into this category.
New cells will be generated when required.
Other settings like database unit, description, top cell etc. are not made in the RDB.
@brief Turns the given edge pair collection into a hierarchical or flat report database
This a another flavour of \scan_collection accepting a text collection.
This method has been introduced in version 0.23.
This method has been introduced in version 0.28.
"""
@overload
def scan_layer(self, layout: db.Layout, layer: int, cell: db.Cell, levels: int) -> None:
def scan_layer(self, layout: db.Layout, layer: int, cell: Optional[db.Cell] = ..., levels: Optional[int] = ..., with_properties: Optional[bool] = ...) -> None:
r"""
@brief Scans a layer from a layout into this category, starting with a given cell and a depth specification
Creates RDB items for each polygon or edge shape read from the cell and it's children in the layout on the given layer and puts them into this category.
@ -434,16 +427,20 @@ class RdbCategory:
"levels" is the number of hierarchy levels to take the child cells from. 0 means to use only "cell" and don't descend, -1 means "all levels".
Other settings like database unit, description, top cell etc. are not made in the RDB.
This method has been introduced in version 0.23.
If 'with_properties' is true, user properties will be turned into tagged values as well.
This method has been introduced in version 0.23. The 'with_properties' argument has been added in version 0.28.
"""
def scan_shapes(self, iter: db.RecursiveShapeIterator, flat: Optional[bool] = ...) -> None:
def scan_shapes(self, iter: db.RecursiveShapeIterator, flat: Optional[bool] = ..., with_properties: Optional[bool] = ...) -> None:
r"""
@brief Scans the polygon or edge shapes from the shape iterator into the category
Creates RDB items for each polygon or edge shape read from the iterator and puts them into this category.
A similar, but lower-level method is \ReportDatabase#create_items with a \RecursiveShapeIterator argument.
In contrast to \ReportDatabase#create_items, 'scan_shapes' can also produce hierarchical databases if the \flat argument is false. In this case, the hierarchy the recursive shape iterator traverses is copied into the report database using sample references.
This method has been introduced in version 0.23. The flat mode argument has been added in version 0.26.
If 'with_properties' is true, user properties will be turned into tagged values as well.
This method has been introduced in version 0.23. The flat mode argument has been added in version 0.26. The 'with_properties' argument has been added in version 0.28.
"""
class RdbItemValue:
@ -533,6 +530,10 @@ class RdbItemValue:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> RdbItemValue:
r"""
@brief Creates a copy of self
"""
@overload
def __init__(self, b: db.DBox) -> None:
r"""
@ -782,6 +783,10 @@ class RdbItem:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> RdbItem:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Creates a new object of this class
@ -1146,31 +1151,33 @@ class ReportDatabase:
A more convenient method that takes cell and category objects instead of ID's is the other version of \create_item.
"""
@overload
def create_item(self, cell_id: int, category_id: int, trans: db.CplxTrans, shape: db.Shape) -> None:
def create_item(self, cell_id: int, category_id: int, trans: db.CplxTrans, shape: db.Shape, with_properties: Optional[bool] = ...) -> None:
r"""
@brief Creates a new item from a single shape
This method produces an item from the given shape.
It accepts various kind of shapes, such as texts, polygons, boxes and paths and converts them to a corresponding item. The transformation argument can be used to supply the transformation that applies the database unit for example.
This method has been introduced in version 0.25.3.
This method has been introduced in version 0.25.3. The 'with_properties' argument has been added in version 0.28.
@param cell_id The ID of the cell to which the item is associated
@param category_id The ID of the category to which the item is associated
@param shape The shape to take the geometrical object from
@param trans The transformation to apply
@param with_properties If true, user properties will be turned into tagged values as well
"""
@overload
def create_items(self, cell_id: int, category_id: int, iter: db.RecursiveShapeIterator) -> None:
def create_items(self, cell_id: int, category_id: int, iter: db.RecursiveShapeIterator, with_properties: Optional[bool] = ...) -> None:
r"""
@brief Creates new items from a shape iterator
This method takes the shapes from the given iterator and produces items from them.
It accepts various kind of shapes, such as texts, polygons, boxes and paths and converts them to corresponding items. This method will produce a flat version of the shapes iterated by the shape iterator. A similar method, which is intended for production of polygon or edge error layers and also provides hierarchical database construction is \RdbCategory#scan_shapes.
This method has been introduced in version 0.25.3.
This method has been introduced in version 0.25.3. The 'with_properties' argument has been added in version 0.28.
@param cell_id The ID of the cell to which the item is associated
@param category_id The ID of the category to which the item is associated
@param iter The iterator (a \RecursiveShapeIterator object) from which to take the items
@param with_properties If true, user properties will be turned into tagged values as well
"""
@overload
def create_items(self, cell_id: int, category_id: int, trans: db.CplxTrans, array: Sequence[db.EdgePair]) -> None:
@ -1223,7 +1230,7 @@ class ReportDatabase:
This method will also produce a flat version of the edge pairs inside the edge pair collection. \RdbCategory#scan_collection is a similar method which also supports construction of hierarchical databases from deep edge pair collections.
This method has been introduced in version 0.23.
This method has been introduced in version 0.23. It has been deprecated in favor of \RdbCategory#scan_collection in version 0.28.
@param cell_id The ID of the cell to which the item is associated
@param category_id The ID of the category to which the item is associated
@ -1239,7 +1246,7 @@ class ReportDatabase:
This method will also produce a flat version of the edges inside the edge collection. \RdbCategory#scan_collection is a similar method which also supports construction of hierarchical databases from deep edge collections.
This method has been introduced in version 0.23.
This method has been introduced in version 0.23. It has been deprecated in favor of \RdbCategory#scan_collection in version 0.28.
@param cell_id The ID of the cell to which the item is associated
@param category_id The ID of the category to which the item is associated
@ -1255,7 +1262,7 @@ class ReportDatabase:
This method will also produce a flat version of the shapes inside the region. \RdbCategory#scan_collection is a similar method which also supports construction of hierarchical databases from deep regions.
This method has been introduced in version 0.23.
This method has been introduced in version 0.23. It has been deprecated in favor of \RdbCategory#scan_collection in version 0.28.
@param cell_id The ID of the cell to which the item is associated
@param category_id The ID of the category to which the item is associated
@ -1263,18 +1270,19 @@ class ReportDatabase:
@param region The region (a \Region object) containing the polygons for which to create items
"""
@overload
def create_items(self, cell_id: int, category_id: int, trans: db.CplxTrans, shapes: db.Shapes) -> None:
def create_items(self, cell_id: int, category_id: int, trans: db.CplxTrans, shapes: db.Shapes, with_properties: Optional[bool] = ...) -> None:
r"""
@brief Creates new items from a shape container
This method takes the shapes from the given container and produces items from them.
It accepts various kind of shapes, such as texts, polygons, boxes and paths and converts them to corresponding items. The transformation argument can be used to supply the transformation that applies the database unit for example.
This method has been introduced in version 0.25.3.
This method has been introduced in version 0.25.3. The 'with_properties' argument has been added in version 0.28.
@param cell_id The ID of the cell to which the item is associated
@param category_id The ID of the category to which the item is associated
@param shapes The shape container from which to take the items
@param trans The transformation to apply
@param with_properties If true, user properties will be turned into tagged values as well
"""
def destroy(self) -> None:
r"""

60
src/pymod/distutils_src/klayout/tlcore.pyi
View File

@ -12,6 +12,10 @@ class EmptyClass:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> EmptyClass:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Creates a new object of this class
@ -116,6 +120,10 @@ class Value:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> Value:
r"""
@brief Creates a copy of self
"""
@overload
def __init__(self) -> None:
r"""
@ -402,6 +410,10 @@ class ArgType:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> ArgType:
r"""
@brief Creates a copy of self
"""
def __eq__(self, arg0: object) -> bool:
r"""
@brief Equality of two types
@ -568,6 +580,10 @@ class MethodOverload:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> MethodOverload:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Creates a new object of this class
@ -675,6 +691,10 @@ class Method:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> Method:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Creates a new object of this class
@ -1012,6 +1032,10 @@ class Logger:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> Logger:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Creates a new object of this class
@ -1119,6 +1143,10 @@ class Timer:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> Timer:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Creates a new object of this class
@ -1336,6 +1364,10 @@ class AbstractProgress(Progress):
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> AbstractProgress:
r"""
@brief Creates a copy of self
"""
def __init__(self, desc: str) -> None:
r"""
@brief Creates an abstract progress reporter with the given description
@ -1446,6 +1478,10 @@ class RelativeProgress(Progress):
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> RelativeProgress:
r"""
@brief Creates a copy of self
"""
@overload
def __init__(self, desc: str, max_value: int) -> None:
r"""
@ -1600,6 +1636,10 @@ class AbsoluteProgress(Progress):
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> AbsoluteProgress:
r"""
@brief Creates a copy of self
"""
@overload
def __init__(self, desc: str) -> None:
r"""
@ -1691,6 +1731,10 @@ class ExpressionContext:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> ExpressionContext:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Creates a new object of this class
@ -1903,6 +1947,10 @@ class GlobPattern:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> GlobPattern:
r"""
@brief Creates a copy of self
"""
def __init__(self, pattern: str) -> None:
r"""
@brief Creates a new glob pattern match object
@ -1995,6 +2043,10 @@ class ExecutableBase:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> ExecutableBase:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Creates a new object of this class
@ -2246,6 +2298,10 @@ class PythonGetterSetterPair:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> PythonGetterSetterPair:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Creates a new object of this class
@ -2340,6 +2396,10 @@ class PythonFunction:
r"""
@brief Creates a copy of self
"""
def __deepcopy__(self) -> PythonFunction:
r"""
@brief Creates a copy of self
"""
def __init__(self) -> None:
r"""
@brief Creates a new object of this class