mirror of https://github.com/KLayout/klayout.git
Updating doc.
This commit is contained in:
parent
85c62e009d
commit
4a8a75f350
|
|
@ -1,7 +1,7 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE language SYSTEM "klayout_doc.dtd">
|
||||
|
||||
<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb -->
|
||||
<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
|
||||
<!-- DO NOT EDIT! -->
|
||||
|
||||
<doc>
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE language SYSTEM "klayout_doc.dtd">
|
||||
|
||||
<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb -->
|
||||
<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
|
||||
<!-- DO NOT EDIT! -->
|
||||
|
||||
<doc>
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE language SYSTEM "klayout_doc.dtd">
|
||||
|
||||
<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb -->
|
||||
<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
|
||||
<!-- DO NOT EDIT! -->
|
||||
|
||||
<doc>
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE language SYSTEM "klayout_doc.dtd">
|
||||
|
||||
<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb -->
|
||||
<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
|
||||
<!-- DO NOT EDIT! -->
|
||||
|
||||
<doc>
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE language SYSTEM "klayout_doc.dtd">
|
||||
|
||||
<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb -->
|
||||
<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
|
||||
<!-- DO NOT EDIT! -->
|
||||
|
||||
<doc>
|
||||
|
|
@ -382,6 +382,7 @@ The following functions are available inside the expressions:
|
|||
</p><p>
|
||||
<ul>
|
||||
<li>"net" - the <class_doc href="Net">Net</class_doc> object of the current net </li>
|
||||
<li>"db" - the <class_doc href="LayoutToNetlist">LayoutToNetlist</class_doc> object the netlist lives in </li>
|
||||
<li>"skip" or "skip(flag)" - if called with a 'true' argument (the default), the primary layer's shapes are not copied for this net </li>
|
||||
<li>"copy(...)" - configures polygon output in a more elaborate way than "skip" (see below) </li>
|
||||
<li>"put(name, value)" - places the value as a property with name 'name' (this must be a string) on the output shapes </li>
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE language SYSTEM "klayout_doc.dtd">
|
||||
|
||||
<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb -->
|
||||
<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
|
||||
<!-- DO NOT EDIT! -->
|
||||
|
||||
<doc>
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE language SYSTEM "klayout_doc.dtd">
|
||||
|
||||
<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb -->
|
||||
<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
|
||||
<!-- DO NOT EDIT! -->
|
||||
|
||||
<doc>
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE language SYSTEM "klayout_doc.dtd">
|
||||
|
||||
<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb -->
|
||||
<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
|
||||
<!-- DO NOT EDIT! -->
|
||||
|
||||
<doc>
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE language SYSTEM "klayout_doc.dtd">
|
||||
|
||||
<!-- generated by /home/matthias/klayout/master2/scripts/drc_lvs_doc/extract_doc.rb -->
|
||||
<!-- generated by /home/matthias/klayout/master/scripts/drc_lvs_doc/extract_doc.rb -->
|
||||
<!-- DO NOT EDIT! -->
|
||||
|
||||
<doc>
|
||||
|
|
|
|||
|
|
@ -15727,7 +15727,8 @@ class DText:
|
|||
Setter:
|
||||
@brief Sets the vertical alignment
|
||||
|
||||
This is the version accepting integer values. It's provided for backward compatibility.
|
||||
This property specifies how the text is aligned relative to the anchor point.
|
||||
This property has been introduced in version 0.22 and extended to enums in 0.28.
|
||||
"""
|
||||
x: float
|
||||
r"""
|
||||
|
|
@ -26154,6 +26155,18 @@ class EdgePairs(ShapeCollection):
|
|||
This method has been introduced in version 0.28.4.
|
||||
"""
|
||||
...
|
||||
def extent_refs(self, arg0: float, arg1: float, arg2: float, arg3: float, arg4: int, arg5: int) -> Region:
|
||||
r"""
|
||||
@hide
|
||||
This method is provided for DRC implementation.
|
||||
"""
|
||||
...
|
||||
def extent_refs_edges(self, arg0: float, arg1: float, arg2: float, arg3: float) -> Edges:
|
||||
r"""
|
||||
@hide
|
||||
This method is provided for DRC implementation.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def extents(self) -> Region:
|
||||
r"""
|
||||
|
|
@ -30835,6 +30848,18 @@ class Edges(ShapeCollection):
|
|||
Other versions of this feature are \extended_in and \extended.
|
||||
"""
|
||||
...
|
||||
def extent_refs(self, arg0: float, arg1: float, arg2: float, arg3: float, arg4: int, arg5: int) -> Region:
|
||||
r"""
|
||||
@hide
|
||||
This method is provided for DRC implementation.
|
||||
"""
|
||||
...
|
||||
def extent_refs_edges(self, arg0: float, arg1: float, arg2: float, arg3: float) -> Edges:
|
||||
r"""
|
||||
@hide
|
||||
This method is provided for DRC implementation.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def extents(self) -> Region:
|
||||
r"""
|
||||
|
|
@ -36870,20 +36895,43 @@ class LEFDEFReaderConfiguration:
|
|||
|
||||
This property has been added in version 0.27.
|
||||
"""
|
||||
map_file: str
|
||||
map_file: Any
|
||||
r"""
|
||||
Getter:
|
||||
@brief Gets the layer map file to use.
|
||||
@brief Gets the layer map file or the map files to use.
|
||||
If a layer map file is given, the reader will pull the layer mapping from this file. The layer mapping rules specified in the reader options are ignored in this case. These are the name suffix rules for vias, blockages, routing, special routing, pins etc. and the corresponding datatype rules. The \layer_map attribute will also be ignored.
|
||||
The layer map file path will be resolved relative to the technology base path if the LEF/DEF reader options are used in the context of a technology.
|
||||
|
||||
This property has been added in version 0.27.
|
||||
The mapping file is one layer mapping entry per line. Each line is a layer name, followed by a list of purposes (VIA, PIN ...) and a layer and datatype number. In addition, 'DIEAREA', 'REGION' and 'BLOCKAGE' can be used to map the design outline, regions and blockages to a layer. 'REGION' can have a detailed specifier which is 'FENCE', 'GUIDE' or 'NONE' for fence, guide or other type regions (e.g. 'REGION FENCE 99/0').
|
||||
|
||||
'NAME' in place of the layer name and using layer/purpose in the purpose column allows mapping labels to specific layers.
|
||||
|
||||
This is an example for a layer map file:
|
||||
|
||||
@code
|
||||
DIEAREA ALL 100 0
|
||||
M1 LEFPIN 12 0
|
||||
M1 PIN 12 2
|
||||
M1 NET 12 3
|
||||
M1 SPNET 12 4
|
||||
M1 VIA 12 5
|
||||
M1 BLOCKAGE 12 10
|
||||
NAME M1/PIN 12 10
|
||||
VIA1 LEFPIN,VIA,PIN,NET,SPNET 13 0
|
||||
M2 LEFPIN,PIN,NET,SPNET,VIA 14 0
|
||||
@/code
|
||||
|
||||
If a map file is used, only the layers present in the map file are generated. No other layers are produced.
|
||||
|
||||
The 'map_file' attribute can either be a single file name, or a list of file names. If a list is given, the corresponding files are merged. If the attribute is nil, no map file is used.
|
||||
|
||||
This property has been added in version 0.27. The ability to supply multiple files has been added in version 0.30.6.
|
||||
|
||||
Setter:
|
||||
@brief Sets the layer map file to use.
|
||||
See \map_file for details about this property.
|
||||
|
||||
This property has been added in version 0.27.
|
||||
This property has been added in version 0.27. The ability to supply multiple files has been added in version 0.30.6.
|
||||
"""
|
||||
net_property_name: Any
|
||||
r"""
|
||||
|
|
@ -42972,11 +43020,12 @@ class LayoutToNetlist:
|
|||
It also accepts variables which become available as variables inside the expression. This allows passing arbitrary values without having to encode them into the expression string.
|
||||
|
||||
It will look at nets connecting to shapes on the primary layer and execute the expression for each
|
||||
of those nets. After that it will copy the primary shapes of the net to the output with the properties
|
||||
of those nets. After that it will copy the merged primary shapes of the net to the output with the properties
|
||||
placed by 'put' attached to them.
|
||||
|
||||
It is possible to skip primary shapes of a specific net by calling the 'skip' function with a 'true'
|
||||
value.
|
||||
value. It is also possible to configure the output in more detail, i.e. to copy other or all layers, to
|
||||
replace the output by the net's bounding box above a certain complexity, or to select merged polygons or unmerged ones, by using 'copy' instead of 'skip'. See below for more details.
|
||||
|
||||
The expression may use the following functions:
|
||||
|
||||
|
|
@ -42986,11 +43035,52 @@ class LayoutToNetlist:
|
|||
@li 'perimeter': the perimeter of the primary-layer shapes on the net in um @/li
|
||||
@li 'perimeter(name)': the perimeter of the secondary-layer shapes. 'name' is a symbol with the name given in the secondary-layer map @/li
|
||||
@li 'put(name, value)': places the value as property 'name' on the output shapes @/li
|
||||
@li 'skip(flag)': will skip the primary shapes of that net when called with a true value @/li
|
||||
@li 'skip' or 'skip(flag)': will skip the primary shapes of that net when called with a true value or without one. See also 'copy'. @/li
|
||||
@li 'copy(...)': see below for details @/li
|
||||
@li 'net': the \Net object of the current net @/li
|
||||
@li 'db': the \LayoutToDatabase object the netlist lives in @/li
|
||||
@/ul
|
||||
|
||||
If given, the 'dbu' argument gives the database unit to use for converting shape dimensions into micrometer units. If this value is 0, the area and perimeters are calculated in database units. If no DBU is specified, the value is determined automatically.
|
||||
'copy' and 'skip' control the polygon output. Here are the options:
|
||||
|
||||
@ul
|
||||
@li 'skip' or 'skip(true)': skip output, identical to 'copy(layers=[])' @/li
|
||||
@li 'skip(false)': copy the shapes from the primary layer, identical to 'copy(layer=0)' @/li
|
||||
@li 'copy' or 'copy(true)': copy all shapes from the net, merged into a single polygon.
|
||||
Note: this is not equivalent to 'skip(false)', as in the latter case, only the primary layer's
|
||||
shapes are copied @/li
|
||||
@li 'copy(false)': equivalent to 'skip(true)' @/li
|
||||
@li 'copy(merged=false)': copies all shapes from all layers of the net, without merging.
|
||||
'merged' is a keyword argument that can be combined with other arguments. @/li
|
||||
@li 'copy(limit=number)': if the net has less than 'number' polygons on the selected layers,
|
||||
copy them to the output. For more polygons, emit the bounding box of the net for the
|
||||
given layers.
|
||||
'limit' is a keyword argument that can be combined with other arguments. @/li
|
||||
@li 'copy(layer=symbol)': copies all shapes from the layer denoted by the symbol.
|
||||
The primary layer has value zero (0), so 'copy(layer=0)' copies the shapes from the primary layer.
|
||||
'layer' is a keyword argument that can be combined with other arguments, except 'layers'. @/li
|
||||
@li 'copy(layers=[symbol, symbol, ...])': copies all shapes from the layers denoted by the symbols.
|
||||
'layers' is a keyword argument that can be combined with other arguments, except 'layer'. @/li
|
||||
@/ul
|
||||
|
||||
When mixing 'skip' and 'copy', the last active specification controls the output. The following
|
||||
expressions are equivalent:
|
||||
|
||||
@code
|
||||
copy(net.name == 'VDD')
|
||||
@/code
|
||||
|
||||
and
|
||||
|
||||
@code
|
||||
skip ; net.name == 'VDD' && copy
|
||||
@/code
|
||||
|
||||
where the second expression establishes 'skip' as the default and conditionally executes 'copy',
|
||||
overriding 'skip'.
|
||||
|
||||
The 'copy' and 'db' functions were added and the 'skip' argument was made optional in version 0.30.6.
|
||||
"""
|
||||
...
|
||||
def extract_devices(self, extractor: DeviceExtractorBase, layers: Dict[str, ShapeCollection]) -> None:
|
||||
|
|
@ -45502,6 +45592,21 @@ class LogEntryData:
|
|||
Setter:
|
||||
@brief Sets the message text.
|
||||
"""
|
||||
net_name: str
|
||||
r"""
|
||||
Getter:
|
||||
@brief Gets the net name.
|
||||
See \net_name= for details about this attribute.
|
||||
The net_name attribute has been introduced in version 0.30.6.
|
||||
|
||||
Setter:
|
||||
@brief Sets the net name.
|
||||
The net (or circuit) name specifies the net the log entry is related to.
|
||||
|
||||
By convention, the net name is the expanded net name (see \Net#expanded_name).
|
||||
|
||||
The net_name attribute has been introduced in version 0.30.6.
|
||||
"""
|
||||
severity: Severity
|
||||
r"""
|
||||
Getter:
|
||||
|
|
@ -45510,10 +45615,36 @@ class LogEntryData:
|
|||
Setter:
|
||||
@brief Sets the severity attribute.
|
||||
"""
|
||||
@overload
|
||||
@classmethod
|
||||
def new(cls) -> LogEntryData:
|
||||
def new(cls, severity: Severity, cell_name: str, msg: str) -> LogEntryData:
|
||||
r"""
|
||||
@brief Creates a new object of this class
|
||||
@brief Creates a new LogEntry object with the given severity, cell or circuit name and message
|
||||
This convenience constructor has been added in version 0.30.6
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
@classmethod
|
||||
def new(cls, severity: Severity, cell_name: str, new_name: str, msg: str) -> LogEntryData:
|
||||
r"""
|
||||
@brief Creates a new LogEntry object with the given severity, cell or circuit name, net name and message
|
||||
This convenience constructor has been added in version 0.30.6
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
@classmethod
|
||||
def new(cls, severity: Severity, msg: str) -> LogEntryData:
|
||||
r"""
|
||||
@brief Creates a new LogEntry object with the given severity and message
|
||||
This convenience constructor has been added in version 0.30.6
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
@classmethod
|
||||
def new(cls, severity: Severity, net: Net, msg: str) -> LogEntryData:
|
||||
r"""
|
||||
@brief Creates a new LogEntry object with the given severity and message and circuit and net name taken from the given \Net object
|
||||
This convenience constructor has been added in version 0.30.6
|
||||
"""
|
||||
...
|
||||
def __copy__(self) -> LogEntryData:
|
||||
|
|
@ -45526,9 +45657,32 @@ class LogEntryData:
|
|||
@brief Creates a copy of self
|
||||
"""
|
||||
...
|
||||
def __init__(self) -> None:
|
||||
@overload
|
||||
def __init__(self, severity: Severity, cell_name: str, msg: str) -> None:
|
||||
r"""
|
||||
@brief Creates a new object of this class
|
||||
@brief Creates a new LogEntry object with the given severity, cell or circuit name and message
|
||||
This convenience constructor has been added in version 0.30.6
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def __init__(self, severity: Severity, cell_name: str, new_name: str, msg: str) -> None:
|
||||
r"""
|
||||
@brief Creates a new LogEntry object with the given severity, cell or circuit name, net name and message
|
||||
This convenience constructor has been added in version 0.30.6
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def __init__(self, severity: Severity, msg: str) -> None:
|
||||
r"""
|
||||
@brief Creates a new LogEntry object with the given severity and message
|
||||
This convenience constructor has been added in version 0.30.6
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def __init__(self, severity: Severity, net: Net, msg: str) -> None:
|
||||
r"""
|
||||
@brief Creates a new LogEntry object with the given severity and message and circuit and net name taken from the given \Net object
|
||||
This convenience constructor has been added in version 0.30.6
|
||||
"""
|
||||
...
|
||||
def __repr__(self, with_geometry: Optional[bool] = ...) -> str:
|
||||
|
|
@ -48912,17 +49066,17 @@ class Netlist:
|
|||
@overload
|
||||
def circuit_by_cell_index(self, cell_index: int) -> Circuit:
|
||||
r"""
|
||||
@brief Gets the circuit object for a given cell index.
|
||||
@brief Gets the circuit object for a given cell index (const version).
|
||||
If the cell index is not valid or no circuit is registered with this index, nil is returned.
|
||||
|
||||
This constness variant has been introduced in version 0.26.8.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def circuit_by_cell_index(self, cell_index: int) -> Circuit:
|
||||
r"""
|
||||
@brief Gets the circuit object for a given cell index (const version).
|
||||
@brief Gets the circuit object for a given cell index.
|
||||
If the cell index is not valid or no circuit is registered with this index, nil is returned.
|
||||
|
||||
This constness variant has been introduced in version 0.26.8.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
|
|
@ -65173,9 +65327,8 @@ class Shape:
|
|||
This method has been introduced in version 0.28.
|
||||
|
||||
Setter:
|
||||
@brief Replaces the shape by the given point
|
||||
This method replaces the shape by the given point. This method can only be called for editable layouts. It does not change the user properties of the shape.
|
||||
Calling this method will invalidate any iterators. It should not be called inside a loop iterating over shapes.
|
||||
@brief Replaces the shape by the given point (in micrometer units)
|
||||
This method replaces the shape by the given point, like \point= with a \Point argument does. This version translates the point from micrometer units to database units internally.
|
||||
|
||||
This method has been introduced in version 0.28.
|
||||
"""
|
||||
|
|
@ -65245,10 +65398,11 @@ class Shape:
|
|||
|
||||
Starting with version 0.23, this method returns nil, if the shape does not represent a text.
|
||||
Setter:
|
||||
@brief Replaces the shape by the given text (in micrometer units)
|
||||
This method replaces the shape by the given text, like \text= with a \Text argument does. This version translates the text from micrometer units to database units internally.
|
||||
@brief Replaces the shape by the given text object
|
||||
This method replaces the shape by the given text object. This method can only be called for editable layouts. It does not change the user properties of the shape.
|
||||
Calling this method will invalidate any iterators. It should not be called inside a loop iterating over shapes.
|
||||
|
||||
This method has been introduced in version 0.25.
|
||||
This method has been introduced in version 0.22.
|
||||
"""
|
||||
text_dpos: DVector
|
||||
r"""
|
||||
|
|
@ -70143,8 +70297,7 @@ class Text:
|
|||
Setter:
|
||||
@brief Sets the horizontal alignment
|
||||
|
||||
This property specifies how the text is aligned relative to the anchor point.
|
||||
This property has been introduced in version 0.22 and extended to enums in 0.28.
|
||||
This is the version accepting integer values. It's provided for backward compatibility.
|
||||
"""
|
||||
size: int
|
||||
r"""
|
||||
|
|
|
|||
|
|
@ -740,6 +740,11 @@ class AngleConstraintType:
|
|||
r"""
|
||||
@brief Specifies to use multiples of 45 degree.
|
||||
"""
|
||||
AC_DiagonalOnly: ClassVar[AngleConstraintType]
|
||||
r"""
|
||||
@brief Specifies to use 45 degree or 135 degree only.
|
||||
This variant has been introduced in version 0.30.6.
|
||||
"""
|
||||
AC_Global: ClassVar[AngleConstraintType]
|
||||
r"""
|
||||
@brief Specifies to use the global angle constraint.
|
||||
|
|
@ -1072,6 +1077,12 @@ class Annotation(BasicAnnotation):
|
|||
@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.
|
||||
"""
|
||||
AngleDiagonalOnly: ClassVar[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 45 degree or 135 degree are allowed.
|
||||
This constant has been introduced in version 0.30.6.
|
||||
"""
|
||||
AngleGlobal: ClassVar[int]
|
||||
r"""
|
||||
@brief Gets the global angle code for use with the \angle_constraint method.
|
||||
|
|
@ -2217,6 +2228,16 @@ class ButtonState:
|
|||
@brief Indicates that the middle mouse button is pressed
|
||||
This constant is combined with other constants within \ButtonState
|
||||
"""
|
||||
ModifierMask: ClassVar[int]
|
||||
r"""
|
||||
@brief A bit mask that selects all keyboard modifiers in the button state mask
|
||||
This constant has been introduced in version 0.30.6.
|
||||
"""
|
||||
MouseButtonMask: ClassVar[int]
|
||||
r"""
|
||||
@brief A bit mask that selects all mouse buttons in the button state mask
|
||||
This constant has been introduced in version 0.30.6.
|
||||
"""
|
||||
RightButton: ClassVar[int]
|
||||
r"""
|
||||
@brief Indicates that the right mouse button is pressed
|
||||
|
|
@ -3093,13 +3114,15 @@ class Dispatcher:
|
|||
The latter may happen, if the object is owned by a C++ object which got destroyed itself.
|
||||
"""
|
||||
...
|
||||
def get_config(self, name: str) -> Any:
|
||||
def get_config(self, name: str, default: Optional[Any] = ...) -> Any:
|
||||
r"""
|
||||
@brief Gets the value of a local configuration parameter
|
||||
|
||||
@param name The name of the configuration parameter whose value shall be obtained (a string)
|
||||
|
||||
@return The value of the parameter or nil if there is no such parameter
|
||||
@return The value of the parameter or the default value if there is no such parameter
|
||||
|
||||
The default value has been added in version 0.30.6.
|
||||
"""
|
||||
...
|
||||
def get_config_names(self) -> List[str]:
|
||||
|
|
@ -10890,6 +10913,11 @@ class Plugin(PluginBase):
|
|||
r"""
|
||||
@brief Specifies to use multiples of 45 degree.
|
||||
"""
|
||||
AC_DiagonalOnly: ClassVar[AngleConstraintType]
|
||||
r"""
|
||||
@brief Specifies to use 45 degree or 135 degree only.
|
||||
This variant has been introduced in version 0.30.6.
|
||||
"""
|
||||
AC_Global: ClassVar[AngleConstraintType]
|
||||
r"""
|
||||
@brief Specifies to use the global angle constraint.
|
||||
|
|
@ -11282,16 +11310,19 @@ class PluginBase:
|
|||
def activated(self) -> None:
|
||||
r"""
|
||||
@brief Gets called when the plugin is activated (base class implementation)
|
||||
See \Plugin#activated for details.
|
||||
"""
|
||||
...
|
||||
def config_finalize(self) -> None:
|
||||
r"""
|
||||
@brief Sends the post-configuration request to the plugin (base class implementation)
|
||||
See \Plugin#config_finalize for details.
|
||||
"""
|
||||
...
|
||||
def configure(self, name: str, value: str) -> bool:
|
||||
r"""
|
||||
@brief Sends configuration requests to the plugin (base class implementation)
|
||||
See \Plugin#configure for details.
|
||||
"""
|
||||
...
|
||||
def create(self) -> None:
|
||||
|
|
@ -11303,6 +11334,7 @@ class PluginBase:
|
|||
def deactivated(self) -> None:
|
||||
r"""
|
||||
@brief Gets called when the plugin is deactivated and another plugin is activated (base class implementation)
|
||||
See \Plugin#deactivated for details.
|
||||
"""
|
||||
...
|
||||
def destroy(self) -> None:
|
||||
|
|
@ -11322,16 +11354,19 @@ class PluginBase:
|
|||
def drag_cancel(self) -> None:
|
||||
r"""
|
||||
@brief This method is called when some mouse dragging operation should be cancelled (base class implementation)
|
||||
See \Plugin#drag_cancel for details.
|
||||
"""
|
||||
...
|
||||
def enter_event(self, prio: bool) -> bool:
|
||||
r"""
|
||||
@brief Handles the enter event (base class implementation)
|
||||
See \Plugin#enter_event for details.
|
||||
"""
|
||||
...
|
||||
def has_tracking_position(self) -> bool:
|
||||
r"""
|
||||
@brief Gets a value indicating whether the plugin provides a tracking position (base class implementation)
|
||||
See \Plugin#has_tracking_position for details.
|
||||
"""
|
||||
...
|
||||
def is_const_object(self) -> bool:
|
||||
|
|
@ -11344,56 +11379,67 @@ class PluginBase:
|
|||
def key_event(self, key: int, buttons: int) -> bool:
|
||||
r"""
|
||||
@brief Handles the key pressed event (base class implementation)
|
||||
See \Plugin#key_event for details.
|
||||
"""
|
||||
...
|
||||
def leave_event(self, prio: bool) -> bool:
|
||||
r"""
|
||||
@brief Handles the leave event (base class implementation)
|
||||
See \Plugin#leave_event for details.
|
||||
"""
|
||||
...
|
||||
def menu_activated(self, symbol: str) -> None:
|
||||
r"""
|
||||
@brief Gets called when a custom menu item is selected (base class implementation)
|
||||
See \Plugin#menu_activated for details.
|
||||
"""
|
||||
...
|
||||
def mouse_button_pressed_event(self, p: db.DPoint, buttons: int, prio: bool) -> bool:
|
||||
r"""
|
||||
@brief Handles the mouse button pressed event (base class implementation)
|
||||
See \Plugin#mouse_button_pressed_event for details.
|
||||
"""
|
||||
...
|
||||
def mouse_button_released_event(self, p: db.DPoint, buttons: int, prio: bool) -> bool:
|
||||
r"""
|
||||
@brief Handles the mouse button release event (base class implementation)
|
||||
See \Plugin#mouse_button_released_event for details.
|
||||
"""
|
||||
...
|
||||
def mouse_click_event(self, p: db.DPoint, buttons: int, prio: bool) -> bool:
|
||||
r"""
|
||||
@brief Handles the mouse button click event after the button has been released (base class implementation)
|
||||
See \Plugin#mouse_click_event for details.
|
||||
"""
|
||||
...
|
||||
def mouse_double_click_event(self, p: db.DPoint, buttons: int, prio: bool) -> bool:
|
||||
r"""
|
||||
@brief Handles the mouse button double-click event (base class implementation)
|
||||
See \Plugin#mouse_double_click_event for details.
|
||||
"""
|
||||
...
|
||||
def mouse_moved_event(self, p: db.DPoint, buttons: int, prio: bool) -> bool:
|
||||
r"""
|
||||
@brief Handles the mouse move event (base class implementation)
|
||||
See \Plugin#mouse_moved_event for details.
|
||||
"""
|
||||
...
|
||||
def tracking_position(self) -> db.DPoint:
|
||||
r"""
|
||||
@brief Gets the tracking position (base class implementation)
|
||||
See \Plugin#tracking_position for details.
|
||||
"""
|
||||
...
|
||||
def update(self) -> None:
|
||||
r"""
|
||||
@brief Gets called when the view has changed (base class implementation)
|
||||
See \Plugin#update for details.
|
||||
"""
|
||||
...
|
||||
def wheel_event(self, delta: int, horizontal: bool, p: db.DPoint, buttons: int, prio: bool) -> bool:
|
||||
r"""
|
||||
@brief Handles the mouse wheel event (base class implementation)
|
||||
See \Plugin#wheel_event for details.
|
||||
"""
|
||||
...
|
||||
...
|
||||
|
|
@ -11562,6 +11608,20 @@ class PluginFactory:
|
|||
This method has been introduced in version 0.27.
|
||||
"""
|
||||
...
|
||||
def add_editor_options_page_by_name(self, name: str) -> None:
|
||||
r"""
|
||||
@brief Requests an additional editor options page from the standard pool.
|
||||
This method needs to be called in the initializer of the plugin factory class and before the 'register' call.It requests an additional editor options page from the standard pool. 'name' specifies which page is added.
|
||||
|
||||
As of now, only 'GenericEditorOptions' is available to provide the basic grid and angle constraints settings. If you wish to enable that page for the plugin, use:
|
||||
|
||||
@code
|
||||
add_editor_options_page_by_name("GenericEditorOptions")
|
||||
@/code
|
||||
|
||||
This method has been introduced in version 0.30.6. Before this method was introduced, the generic editor options were always added.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def add_menu_entry(self, menu_name: str, insert_pos: str) -> None:
|
||||
r"""
|
||||
|
|
|
|||
|
|
@ -1270,17 +1270,17 @@ class RdbReference:
|
|||
@overload
|
||||
def database(self) -> ReportDatabase:
|
||||
r"""
|
||||
@brief Gets the database object that category is associated with
|
||||
@brief Gets the database object that category is associated with (non-const version)
|
||||
|
||||
This method has been introduced in version 0.23.
|
||||
This method has been introduced in version 0.29.
|
||||
"""
|
||||
...
|
||||
@overload
|
||||
def database(self) -> ReportDatabase:
|
||||
r"""
|
||||
@brief Gets the database object that category is associated with (non-const version)
|
||||
@brief Gets the database object that category is associated with
|
||||
|
||||
This method has been introduced in version 0.29.
|
||||
This method has been introduced in version 0.23.
|
||||
"""
|
||||
...
|
||||
def destroy(self) -> None:
|
||||
|
|
|
|||
Loading…
Reference in New Issue