KLayout

https://www.klayout.de/doc-qt5/
Admin
KLayout is an IC layout viewer and editor, offering extensive features for design automation, user...
Tokens:14,250,898
Snippets:135,220
Trust Score:9.1
Update:1 hour ago
Show doc for...
Tokens:
Raw
### configure

Source: https://www.klayout.de/doc-qt5/code/class_PluginFactory.html

Gets called for configuration events for the plugin singleton.

```APIDOC
## configure

### Description
Gets called for configuration events for the plugin singleton.

### Method
configure

### Parameters
- **name** (string) - Required - Description not provided
- **value** (string) - Required - Description not provided

### Returns
bool
```

--------------------------------

### Instance#properties

Source: https://www.klayout.de/doc-qt5/programming/database_api.html

Gets the properties of an instance as a hash (dict).

```APIDOC
## Instance#properties

### Description
Gets the properties of an instance as a hash (dict).

### Method
Instance method

### Returns
- **properties** (Hash) - The properties as a hash (dict).

### Example
```ruby
props = instance.properties
```
```

--------------------------------

### initialized

Source: https://www.klayout.de/doc-qt5/code/class_PluginFactory.html

Gets called when the plugin singleton is initialized, i.e. when the application has been started.

```APIDOC
## initialized

### Description
Gets called when the plugin singleton is initialized, i.e. when the application has been started.

### Signature
`[virtual] void initialized(Dispatcher ptr dispatcher)`

### Parameters
- **dispatcher** (Dispatcher ptr) - Required - The reference to the MainWindow object
```

--------------------------------

### start

Source: https://www.klayout.de/doc-qt5/code/class_QCamera.html

Method void QCamera::start(). Starts the camera.

```APIDOC
## start

### Description
Method void QCamera::start(). Starts the camera.

### Method
void

```

--------------------------------

### start()

Source: https://www.klayout.de/doc-qt5/code/class_QAbstractAudioInput.html

Starts the audio input and returns a QIODevice to write audio data to. This is a virtual method that can be reimplemented in a derived class.

```APIDOC
## start()

### Description
Starts the audio input and returns a QIODevice to write audio data to.

### Method
start

### Signature
`QIODevice ptr start()`

### Parameters
None

### Return Value
- **QIODevice ptr** - Pointer to the QIODevice for audio input.

### Notes
This method can be reimplemented in a derived class.
```

--------------------------------

### initialized

Source: https://www.klayout.de/doc-qt5/code/class_PluginFactory.html

Gets called when the plugin singleton is initialized, i.e. when the application has been started.

```APIDOC
## initialized

### Description
Gets called when the plugin singleton is initialized, i.e. when the application has been started.

### Method
initialized

### Parameters
- **dispatcher** (Dispatcher ptr) - Required - Description not provided

### Returns
void
```

--------------------------------

### start()

Source: https://www.klayout.de/doc-qt5/code/class_QAbstractAudioInput.html

Starts the audio input and returns a QIODevice to write audio data to. This is a virtual method of QAbstractAudioInput.

```APIDOC
## start()

### Description
Starts the audio input and returns a QIODevice to write audio data to.

### Method
start

### Parameters
None

### Returns
- **QIODevice ptr** - The device to write audio data to.

```

--------------------------------

### path (getter)

Source: https://www.klayout.de/doc-qt5/code/class_Macro.html

Gets the path of the macro. The path is where the macro is stored, starting with an abstract group identifier. The path is used to identify the macro in the debugger for example.

```APIDOC
## [GET] path

### Description
Gets the path of the macro. The path is where the macro is stored, starting with an abstract group identifier. The path is used to identify the macro in the debugger for example.

### Method
GET

### Endpoint
path

### Parameters
None

### Response
#### Success Response
- **path** (string) - The path of the macro.

#### Response Example
```
"string"
```
```

--------------------------------

### startingUp

Source: https://www.klayout.de/doc-qt5/code/class_QCoreApplication.html

Returns whether the application is starting up. This is a static method that can be called without an instance.

```APIDOC
## startingUp

### Description
Returns whether the application is starting up.

### Method
startingUp

### Signature
[static] bool startingUp

### Returns
- **bool** - Whether the application is starting up.

### Notes
- Static method, can be called without an instance.
```

--------------------------------

### mag

Source: https://www.klayout.de/doc-qt5/code/class_DCplxTrans.html

Gets the magnification.

```APIDOC
## mag

### Description
Gets the magnification.

### Method
mag

### Returns
- **double** - The magnification value.
```

--------------------------------

### start()

Source: https://www.klayout.de/doc-qt5/code/class_QAbstractAudioOutput.html

Returns the QIODevice that is currently used as the audio source for output. This is a virtual method that provides access to the active audio device.

```APIDOC
## start()

### Description
Returns the QIODevice that is currently used as the audio source for output. This is a virtual method that provides access to the active audio device.

### Method
start

### Returns
QIODevice ptr - The current audio source device.
```

--------------------------------

### disp

Source: https://www.klayout.de/doc-qt5/code/class_DCplxTrans.html

Gets the displacement.

```APIDOC
## disp

### Description
Gets the displacement.

### Method
disp

### Returns
- **DVector** - The displacement vector.
```

--------------------------------

### angle

Source: https://www.klayout.de/doc-qt5/code/class_DCplxTrans.html

Gets the angle.

```APIDOC
## angle

### Description
Gets the angle.

### Method
angle

### Returns
- **double** - The angle value.
```

--------------------------------

### start()

Source: https://www.klayout.de/doc-qt5/code/class_QAudioInput.html

Starts the audio input and returns a QIODevice to read audio data from.

```APIDOC
## Method: start()

### Description
Starts the audio input and returns a QIODevice to read audio data from.

### Returns
QIODevice ptr - The QIODevice to read audio data from.
```

--------------------------------

### CellView::active and cell_name= example

Source: https://www.klayout.de/doc-qt5/code/class_CellView.html

Example showing how to get the active cell view and change the displayed cell by setting the cell_name property.

```APIDOC
## [Ruby] CellView::active and cell_name= example

### Description
This example demonstrates how to obtain the active cell view and modify the displayed cell by setting the cell_name property. The change takes effect immediately on the display.

### Method
- `CellView::active` (static method)
- `cell_name=` (setter)

### Endpoint
Not applicable (Ruby API)

### Parameters
#### Properties
- `cell_name` (String) - Required - The name of the cell to display.

### Request Example
```ruby
cv = RBA::CellView::active
cv.cell_name = "TOP2"
```

### Response
No return value for the setter. The `active` method returns a `CellView` object.
```

--------------------------------

### start()

Source: https://www.klayout.de/doc-qt5/code/class_QAudioDecoder.html

Method void QAudioDecoder::start().

```APIDOC
## start()

### Description
Method void QAudioDecoder::start().

### Method
start

### Parameters
None

### Returns
void
```

--------------------------------

### start()

Source: https://www.klayout.de/doc-qt5/code/class_QAudioInput.html

Starts audio input and returns a QIODevice pointer for writing audio data. This is an overloaded method.

```APIDOC
## start()

### Description
Starts audio input and returns a QIODevice pointer for writing audio data.

### Method
QIODevice ptr

### Returns
- **QIODevice ptr** - The device to use for audio input.
```

--------------------------------

### mag

Source: https://www.klayout.de/doc-qt5/code/class_ICplxTrans.html

Gets the magnification.

```APIDOC
## mag

### Description
Gets the magnification.

### Method
mag

### Returns
- **double** - The magnification.
```

--------------------------------

### begin

Source: https://www.klayout.de/doc-qt5/code/class_QPaintEngine.html

Virtual method bool QPaintEngine::begin(QPaintDevice *pdev).

```APIDOC
## begin

### Description
Virtual method bool QPaintEngine::begin(QPaintDevice *pdev).

### Method
begin

### Parameters
- **pdev** (QPaintDevice ptr) - Required - The paint device to begin painting on.

### Return Value
- bool - True if the painting began successfully, false otherwise.
```

--------------------------------

### is_mirror?

Source: https://www.klayout.de/doc-qt5/code/class_DCplxTrans.html

Gets the mirror flag.

```APIDOC
## is_mirror?

### Description
Gets the mirror flag.

### Method
is_mirror?

### Returns
- **bool** - The mirror flag.
```

--------------------------------

### dbu()

Source: https://www.klayout.de/doc-qt5/code/class_Layout.html

Gets the database unit.

```APIDOC
## [METHOD] dbu

### Description
Gets the database unit.

### Method
dbu

### Parameters
None.

### Returns
- **double** - The database unit.
```

--------------------------------

### new

Source: https://www.klayout.de/doc-qt5/code/class_QGuiApplication.html

Creates a new QGuiApplication object. This is the default initializer in Python.

```APIDOC
## new

### Description
Creates a new QGuiApplication object.

### Method
new

### Signature
[static] new QGuiApplication ptr new (string[] argv)

### Parameters
- **argv** (string[]) - Required - The command line arguments to pass to Qt

### Python Specific Notes
This method is the default initializer of the object.
```

--------------------------------

### disp

Source: https://www.klayout.de/doc-qt5/code/class_ICplxTrans.html

Gets the displacement of the transformation.

```APIDOC
## disp

### Description
Gets the displacement of the transformation.

### Method
disp

### Returns
- **Vector** - The displacement.
```

--------------------------------

### start(QIODevice *device)

Source: https://www.klayout.de/doc-qt5/code/class_QAbstractAudioInput.html

Starts the audio input with the given device. This is a virtual method of QAbstractAudioInput.

```APIDOC
## start(QIODevice *device)

### Description
Starts the audio input with the given device.

### Method
start

### Parameters
- **device** (QIODevice ptr) - Required - The device to use for audio input.

### Returns
void

```

--------------------------------

### start(device)

Source: https://www.klayout.de/doc-qt5/code/class_QAbstractAudioInput.html

Starts the audio input using the given QIODevice. This is a virtual method that can be reimplemented in a derived class.

```APIDOC
## start(device)

### Description
Starts the audio input using the given QIODevice.

### Method
start

### Signature
`void start(QIODevice ptr device)`

### Parameters
- **device** (QIODevice ptr) - The device to use for audio input.

### Return Value
None

### Notes
This method can be reimplemented in a derived class.
```

--------------------------------

### angle

Source: https://www.klayout.de/doc-qt5/code/class_ICplxTrans.html

Gets the angle of the transformation.

```APIDOC
## angle

### Description
Gets the angle of the transformation.

### Method
angle

### Returns
- **double** - The angle.
```

--------------------------------

### a

Source: https://www.klayout.de/doc-qt5/code/class_CellInstArray.html

Gets the displacement vector for the 'a' axis. Starting with version 0.25 the displacement is of vector type.

```APIDOC
## a

### Description
Gets the displacement vector for the 'a' axis. Starting with version 0.25 the displacement is of vector type. Python specific notes: The object exposes a readable attribute 'a'. This is the getter.

### Signature
[const] Vector a

### Returns
- **Vector** - The displacement vector for the 'a' axis.
```

--------------------------------

### start

Source: https://www.klayout.de/doc-qt5/code/class_QAbstractAudioOutput.html

Starts the audio output and returns a QIODevice to write audio data to. This is a virtual method that can be reimplemented in a derived class.

```APIDOC
## start

### Description
Starts the audio output and returns a QIODevice to write audio data to. This is a virtual method that can be reimplemented in a derived class.

### Method
QIODevice ptr

### Signature
QIODevice ptr start

### Returns
- **QIODevice ptr** - A pointer to the QIODevice for writing audio data.

```

--------------------------------

### startingUp

Source: https://www.klayout.de/doc-qt5/code/class_QCoreApplication.html

Checks if the application is starting up. This static method indicates whether the application is in its startup phase.

```APIDOC
## startingUp

### Description
Checks if the application is starting up.

### Method
Static method

### Signature
bool QCoreApplication::startingUp()

### Parameters
None

### Return Value
bool - True if the application is starting up, false otherwise.
```

--------------------------------

### disp

Source: https://www.klayout.de/doc-qt5/code/class_ICplxTrans.html

Gets the displacement vector of the transformation.

```APIDOC
## disp

### Description
Gets the displacement.

### Signature
[const] Vector disp

### Returns
- **Vector** - The displacement vector.

### Python Specific Notes
The object exposes a readable attribute 'disp'. This is the getter.
```

--------------------------------

### menu_activated

Source: https://www.klayout.de/doc-qt5/code/class_PluginFactory.html

Gets called when a menu item is selected.

```APIDOC
## menu_activated

### Description
Gets called when a menu item is selected.

### Method
menu_activated

### Parameters
- **symbol** (string) - Required - Description not provided

### Returns
bool
```

--------------------------------

### begin

Source: https://www.klayout.de/doc-qt5/code/class_QPaintEngine.html

Virtual method that begins painting on the given paint device. Can be reimplemented in a derived class.

```APIDOC
## begin

### Description
Virtual method bool QPaintEngine::begin(QPaintDevice *pdev). This method can be reimplemented in a derived class.

### Signature
bool begin (QPaintDevice ptr pdev)

### Parameters
- **pdev** (QPaintDevice ptr) - Required - The paint device to begin painting on.

### Returns
- **bool** - True if the operation succeeded.
```

--------------------------------

### prop_id

Source: https://www.klayout.de/doc-qt5/code/class_Layout.html

Gets the properties ID associated with the layout.

```APIDOC
## prop_id

### Description
Gets the properties ID associated with the layout.

### Method
prop_id

### Returns
- unsigned long - The properties ID.
```

--------------------------------

### start()

Source: https://www.klayout.de/doc-qt5/code/class_QAudioOutput.html

Starts the audio output and returns a QIODevice to write audio data to.

```APIDOC
## [POST] start()

### Description
Starts the audio output and returns a QIODevice to write audio data to.

### Method
POST

### Endpoint
start()

### Parameters
None

### Response
#### Success Response (200)
- **QIODevice ptr** - The device to write audio data to.

#### Response Example
```json
{
  "device": "..."
}
```
```

--------------------------------

### start()

Source: https://www.klayout.de/doc-qt5/code/class_QAudioOutput.html

Starts the audio output and returns a QIODevice to write audio data to.

```APIDOC
## start()

### Description
Starts the audio output and returns a QIODevice to write audio data to.

### Method
start

### Signature
`QIODevice *start()`

### Returns
- **QIODevice ptr** - The device to write audio data to.

```

--------------------------------

### pcell_names

Source: https://www.klayout.de/doc-qt5/code/class_Layout.html

Gets the names of the PCells registered in the layout.

```APIDOC
## pcell_names

### Description
Gets the names of the PCells registered in the layout.

### Method
pcell_names

### Returns
- string[] - The PCell names.
```

--------------------------------

### startingUp

Source: https://www.klayout.de/doc-qt5/code/class_QAbstractEventDispatcher.html

Virtual method void QAbstractEventDispatcher::startingUp(). Called when the event dispatcher is starting up.

```APIDOC
## startingUp

### Description
Virtual method void QAbstractEventDispatcher::startingUp(). Called when the event dispatcher is starting up.

### Method
Virtual method

### Parameters
None

### Response
No return value.
```

--------------------------------

### pcell_ids

Source: https://www.klayout.de/doc-qt5/code/class_Layout.html

Gets the IDs of the PCells registered in the layout.

```APIDOC
## pcell_ids

### Description
Gets the IDs of the PCells registered in the layout.

### Method
pcell_ids

### Returns
- unsigned int[] - The PCell IDs.
```

--------------------------------

### pcell_id

Source: https://www.klayout.de/doc-qt5/code/class_Layout.html

Gets the ID of the PCell with the given name.

```APIDOC
## pcell_id

### Description
Gets the ID of the PCell with the given name.

### Method
pcell_id

### Parameters
- **name** (string) - Required - The name of the PCell.

### Returns
- unsigned int - The PCell ID.
```

--------------------------------

### aboutQt

Source: https://www.klayout.de/doc-qt5/code/class_QApplication.html

Static method void QApplication::aboutQt(). This method is static and can be called without an instance.

```APIDOC
## aboutQt

### Description
Static method void QApplication::aboutQt(). This method is static and can be called without an instance.

### Signature
_[static]_ void **aboutQt**

### Parameters
None

### Return Value
void
```

--------------------------------

### name

Source: https://www.klayout.de/doc-qt5/code/class_EditorHooks.html

Gets the name of the hooks object.

```APIDOC
## name

### Description
Gets the name of the hooks object.

### Method
name

### Parameters
None

### Returns
- **string** - The name of the hooks object.
```

--------------------------------

### start (QIODevice ptr device)

Source: https://www.klayout.de/doc-qt5/code/class_QAbstractAudioOutput.html

Starts the audio output using the given QIODevice. This is a virtual method that can be reimplemented in a derived class.

```APIDOC
## start (QIODevice ptr device)

### Description
Starts the audio output using the given QIODevice. This is a virtual method that can be reimplemented in a derived class.

### Method
void

### Signature
void start (QIODevice ptr device)

### Parameters
- **device** (QIODevice ptr) - Required - The QIODevice to use for audio data.

```

--------------------------------

### new()

Source: https://www.klayout.de/doc-qt5/code/class_QAbstractAudioDeviceInfo.html

Constructor that creates an object of class QAbstractAudioDeviceInfo.

```APIDOC
## new()

### Description
Constructor that creates an object of class QAbstractAudioDeviceInfo.

### Method
new QAbstractAudioDeviceInfo() [static]

### Returns
QAbstractAudioDeviceInfo - A new instance of the class.
```

--------------------------------

### guiding_shape_layer()

Source: https://www.klayout.de/doc-qt5/code/class_Layout.html

Returns the index of the guiding shape layer.

```APIDOC
## guiding_shape_layer()

### Description
Returns the index of the guiding shape layer.

### Method
guiding_shape_layer

### Returns
unsigned int
```

--------------------------------

### property_glob filter example in Ruby

Source: https://www.klayout.de/doc-qt5/code/class_EdgeFilter.html

Applies a property_glob filter to an Edges object to select edges where the 'net' property starts with 'C'. The result is stored in filtered_edges. This example is referenced by property_filter_bounded as an illustration of applying property filters with Edges#filtered.

```Ruby
# edges is a Edges object
# filtered_edges contains all edges where the 'net' property starts with 'C':
filtered_edges = edges.filtered(RBA::EdgeFilterBase::property_glob('net', 'C*'))
```

--------------------------------

### begin (QPaintDevice ptr arg1)

Source: https://www.klayout.de/doc-qt5/code/class_QPainter.html

Begins painting on the given paint device.

```APIDOC
## [METHOD] begin (QPaintDevice ptr arg1)

### Description
Begins painting on the given paint device.

### Method
begin

### Endpoint
begin (QPaintDevice ptr arg1)

### Parameters
#### Parameters
- **arg1** (QPaintDevice ptr) - Required - The paint device to begin painting on.

### Response
#### Success Response
- **bool** - True if painting began successfully, false otherwise.
```

--------------------------------

### path_bgnext

Source: https://www.klayout.de/doc-qt5/code/class_Shape.html

Gets the path's starting vertex extension.

```APIDOC
## path_bgnext

### Description
Gets the path's starting vertex extension.

### Method
path_bgnext

### Returns
- **int** - The starting vertex extension.
```

--------------------------------

### start

Source: https://www.klayout.de/doc-qt5/code/class_QAbstractVideoSurface.html

Virtual method bool QAbstractVideoSurface::start(const QVideoSurfaceFormat &format).

```APIDOC
## start

### Description
Virtual method bool QAbstractVideoSurface::start(const QVideoSurfaceFormat &format).

### Method
start

### Parameters
- **format** (const QVideoSurfaceFormat) - Required - The format to start with.

### Return Type
bool
```

--------------------------------

### start(QIODevice* device)

Source: https://www.klayout.de/doc-qt5/code/class_QAbstractAudioOutput.html

Starts audio output using the given QIODevice as the audio source. This is a virtual method that begins playback from the specified device.

```APIDOC
## start(QIODevice* device)

### Description
Starts audio output using the given QIODevice as the audio source. This is a virtual method that begins playback from the specified device.

### Method
start

### Parameters
- **device** (QIODevice ptr) - Required - The audio source device to play from.

### Returns
void
```

--------------------------------

### uninitialized

Source: https://www.klayout.de/doc-qt5/code/class_PluginFactory.html

Gets called when the application shuts down and the plugin is unregistered.

```APIDOC
## uninitialized

### Description
Gets called when the application shuts down and the plugin is unregistered.

### Method
uninitialized

### Parameters
- **dispatcher** (Dispatcher ptr) - Required - Description not provided

### Returns
void
```

--------------------------------

### new

Source: https://www.klayout.de/doc-qt5/code/class_QApplication.html

Creates a new QApplication object. This is the default initializer of the object.

```APIDOC
## [static] new

### Description
Creates a new QApplication object.

### Signature
new QApplication ptr new(string[] argv, bool gui = true)

### Parameters
- **argv** (string[]) - The command line arguments to pass to Qt.
- **gui** (bool) - If true, a GUI-enabled application is constructed. Default is true.

### Python Specific Notes
This method is the default initializer of the object.
```

--------------------------------

### void QMovie::start()

Source: https://www.klayout.de/doc-qt5/code/class_QMovie.html

Starts playing the movie from the beginning.

```APIDOC
## [METHOD] void QMovie::start()

### Description
Starts playing the movie from the beginning.

### Method
start

### Signature
void QMovie::start()

### Parameters
None
```

--------------------------------

### config_finalize

Source: https://www.klayout.de/doc-qt5/code/class_PluginFactory.html

Gets called after a set of configuration events has been sent.

```APIDOC
## config_finalize

### Description
Gets called after a set of configuration events has been sent.

### Method
config_finalize

### Parameters
None

### Returns
void
```

--------------------------------

### properties_id

Source: https://www.klayout.de/doc-qt5/code/class_Layout.html

Gets the properties ID for a given properties set.

```APIDOC
## properties_id

### Description
Gets the properties ID for a given properties set.

### Method
Static method

### Parameters
- **properties** (variant[]) - Required - The properties set.
- **properties** (map<variant,variant>) - Required - The properties set.

### Returns
- **unsigned long** - The properties ID.
```

--------------------------------

### new

Source: https://www.klayout.de/doc-qt5/code/class_QBasicMutex.html

Creates a new QBasicMutex object. This is the default initializer for the class.

```APIDOC
## new

### Description
Creates a new QBasicMutex object.

### Method
new

### Signature
[static] new QBasicMutex()

### Return Value
- **QBasicMutex** - A new instance of QBasicMutex.
```

--------------------------------

### properties_array

Source: https://www.klayout.de/doc-qt5/code/class_Layout.html

Gets the properties set for a given properties ID.

```APIDOC
## properties_array

### Description
Gets the properties set for a given properties ID.

### Method
Static method

### Parameters
- **properties_id** (unsigned long) - Required - The properties ID.

### Returns
- **variant** - The properties set.
```

--------------------------------

### start(program, arguments, mode)

Source: https://www.klayout.de/doc-qt5/code/class_QProcess.html

Starts the program with the given arguments and open mode.

```APIDOC
## start(program, arguments, mode)

### Description
Starts the program with the given arguments and open mode.

### Method
start(const QString &program, const QStringList &arguments, QFlags<QIODevice::OpenModeFlag> mode)

### Parameters
- **program** (string) - Required - The program to start.
- **arguments** (string[]) - Required - The arguments.
- **mode** (QIODevice::OpenModeFlag) - Optional - The open mode (default: QIODevice::ReadWrite).
```

--------------------------------

### technology_name() const

Source: https://www.klayout.de/doc-qt5/code/class_Layout.html

Gets the name of the technology this layout is associated with.

```APIDOC
## technology_name() const

### Description
Gets the name of the technology this layout is associated with.

### Method
technology_name

### Parameters
None

### Return Type
string
```

--------------------------------

### start()

Source: https://www.klayout.de/doc-qt5/code/class_QAudioDecoderControl.html

Starts the decoding process. The decoder will begin reading from the source and emitting decoded buffers.

```APIDOC
## start()

### Description
Starts the decoding process. The decoder will begin reading from the source and emitting decoded buffers.

### Method
start

```

--------------------------------

### properties

Source: https://www.klayout.de/doc-qt5/code/class_Layout.html

Gets the Layout's user properties as a hash.

```APIDOC
## properties

### Description
Gets the Layout's user properties as a hash.

### Method
properties

### Returns
- variant - The user properties hash.
```

--------------------------------

### start (int msec, QObject ptr obj)

Source: https://www.klayout.de/doc-qt5/code/class_QBasicTimer.html

Method void QBasicTimer::start(int msec, QObject *obj)

```APIDOC
## Method start (int msec, QObject ptr obj)

### Description
Method void QBasicTimer::start(int msec, QObject *obj)

### Signature
`void start(int msec, QObject ptr obj)`

### Parameters
- **msec** (int) - Required - The timer interval in milliseconds.
- **obj** (QObject ptr) - Required - The QObject to associate with the timer.

### Returns
void
```

--------------------------------

### new QMediaServiceProviderHint()

Source: https://www.klayout.de/doc-qt5/code/class_QMediaServiceProviderHint.html

Constructs a QMediaServiceProviderHint object with default settings. This is the default constructor.

```APIDOC
## [CONSTRUCTOR] new QMediaServiceProviderHint()

### Description
Constructs a QMediaServiceProviderHint object with default settings.

### Method
Constructor

### Signature
`new QMediaServiceProviderHint()`

### Parameters
None

### Returns
A new QMediaServiceProviderHint object.
```

--------------------------------

### meta_info(string)

Source: https://www.klayout.de/doc-qt5/code/class_Layout.html

Gets the meta information for a given name.

```APIDOC
## meta_info(string name)

### Description
Gets the meta information for a given name.

### Method
meta_info

### Parameters
- **name** (string) - Required - Name of the meta information.

### Returns
new LayoutMetaInfo ptr - Pointer to the meta information.
```

--------------------------------

### start()

Source: https://www.klayout.de/doc-qt5/code/class_QRadioTunerControl.html

Starts the tuner. This is a virtual method.

```APIDOC
## start()

### Description
Starts the tuner.

### Method
start

### Returns
- **void**
```

--------------------------------

### layer_infos()

Source: https://www.klayout.de/doc-qt5/code/class_Layout.html

Gets a list of valid layer's properties.

```APIDOC
## layer_infos()

### Description
Gets a list of valid layer's properties.

### Method
layer_infos

### Returns
LayerInfo[] - Array of layer properties.
```

--------------------------------

### new

Source: https://www.klayout.de/doc-qt5/code/class_QPaintEngine.html

Creates a new QPaintEngine object. This is the default initializer.

```APIDOC
## new

### Description
Creates a new QPaintEngine object. This is the default initializer.

### Method
new

### Signature
static QPaintEngine new(QPaintEngine_QFlags_PaintEngineFeature features = QPaintEngine::PaintEngineFeatures())

### Parameters
- **features** (QPaintEngine_QFlags_PaintEngineFeature) - Optional - The features for the paint engine.

### Response
- **QPaintEngine** - The newly created QPaintEngine object.
```

--------------------------------

### layer_indexes()

Source: https://www.klayout.de/doc-qt5/code/class_Layout.html

Gets a list of valid layer's indices.

```APIDOC
## layer_indexes()

### Description
Gets a list of valid layer's indices.

### Method
layer_indexes

### Returns
unsigned int[] - Array of layer indices.
```

--------------------------------

### technologies

Source: https://www.klayout.de/doc-qt5/code/class_EditorHooks.html

Gets the list of technologies these hooks are associated with.

```APIDOC
## technologies

### Description
Gets the list of technologies these hooks are associated with.

### Method
technologies

### Parameters
None

### Returns
- **string[]** - The list of technology names.
```

--------------------------------

### new QCoreApplication(string[] argv)

Source: https://www.klayout.de/doc-qt5/code/class_QCoreApplication.html

Creates a new QCoreApplication object. This constructor initializes the application instance with the provided command-line arguments.

```APIDOC
## Constructor: new QCoreApplication(string[] argv)

### Description
Creates a new QCoreApplication object.

### Parameters
- **argv** (string[]) - Required - Command-line arguments for the application.

### Returns
- **QCoreApplication ptr** - A pointer to the newly created QCoreApplication object.
```

--------------------------------

### start

Source: https://www.klayout.de/doc-qt5/code/class_QProcess.html

Starts the process. Multiple overloads are available.

```APIDOC
## start

### Description
Starts the process. Multiple overloads are available.

### Method
start

### Overload 1

#### Signature
void start(string program, string[] arguments, QIODevice_QFlags_OpenModeFlag mode = QIODevice::ReadWrite)

#### Parameters
- **program** (string) - Required - The program to execute.
- **arguments** (string[]) - Required - List of arguments.
- **mode** (QIODevice_QFlags_OpenModeFlag) - Optional - Open mode flags, default is QIODevice::ReadWrite.

### Overload 2

#### Signature
void start(string command, QIODevice_QFlags_OpenModeFlag mode = QIODevice::ReadWrite)

#### Parameters
- **command** (string) - Required - The command to execute.
- **mode** (QIODevice_QFlags_OpenModeFlag) - Optional - Open mode flags, default is QIODevice::ReadWrite.

### Overload 3

#### Signature
void start(QIODevice_QFlags_OpenModeFlag mode = QIODevice::ReadWrite)

#### Parameters
- **mode** (QIODevice_QFlags_OpenModeFlag) - Optional - Open mode flags, default is QIODevice::ReadWrite.
```

--------------------------------

### property_glob filter example

Source: https://www.klayout.de/doc-qt5/code/class_EdgePairFilter.html

Applies a property_glob filter to an EdgePairs object to select edge pairs where the 'net' property starts with 'C'. The filter is applied using the filtered method.

```ruby
# edge_pairs is a EdgePairs object
# filtered_edge_pairs contains all edge pairs where the 'net' property starts with 'C':
filtered_edge_pairs = edge_pairs.filtered(RBA::EdgePairFilterBase::property_glob('net', 'C*'))
```

--------------------------------

### new QAbstractAudioDeviceInfo

Source: https://www.klayout.de/doc-qt5/code/class_QAbstractAudioDeviceInfo.html

Constructor for creating a new QAbstractAudioDeviceInfo object.

```APIDOC
## Constructor

### Description
Creates a new QAbstractAudioDeviceInfo instance.

### Method
Constructor

### Signature
`new QAbstractAudioDeviceInfo`

### Parameters
None

### Returns
A new QAbstractAudioDeviceInfo object.
```

--------------------------------

### Cell#properties

Source: https://www.klayout.de/doc-qt5/programming/database_api.html

Gets the properties of a cell as a hash (dict).

```APIDOC
## Cell#properties

### Description
Gets the properties of a cell as a hash (dict).

### Method
Instance method

### Returns
- **properties** (Hash) - The properties as a hash (dict).

### Example
```ruby
props = cell.properties
```
```

--------------------------------

### Accessing the layout view via Application and MainWindow

Source: https://www.klayout.de/doc-qt5/programming/introduction.html

Shows how to obtain the KLayout Application singleton, its main window, and the current layout view. Raises an error if no view is selected. This is the verbose preparation step used in the first sample.

```Ruby
  app = Application.instance
  mw = app.main_window

  lv = mw.current_view
  if lv == nil
    raise "Shape Statistics: No view selected"
  end
```

--------------------------------

### Instance#layout

Source: https://www.klayout.de/doc-qt5/programming/database_api.html

Returns the layout that the instance lives in.

```APIDOC
## Instance#layout

### Description
Returns the layout that the instance lives in.

### Method
Instance#layout

### Parameters
None

### Returns
- **Layout** (type) - The layout object.
```

--------------------------------

### Shape#properties

Source: https://www.klayout.de/doc-qt5/programming/database_api.html

Gets the properties of a shape as a hash (dict).

```APIDOC
## Shape#properties

### Description
Gets the properties of a shape as a hash (dict).

### Method
Instance method

### Returns
- **properties** (Hash) - The properties as a hash (dict).

### Example
```ruby
props = shape.properties
```
```

--------------------------------

### new

Source: https://www.klayout.de/doc-qt5/code/class_QCoreApplication.html

Creates a new QCoreApplication object. This is the default initializer of the object.

```APIDOC
## [STATIC] new

### Description
Creates a new QCoreApplication object.

### Method
Static

### Signature
QCoreApplication ptr new(string[] argv)

### Parameters
- **argv** (string[]) - Required - The command line arguments to pass to Qt.

### Returns
- **QCoreApplication ptr** - A pointer to the new QCoreApplication object.

### Python Notes
Default initializer of the object.
```

--------------------------------

### wants_variants?

Source: https://www.klayout.de/doc-qt5/code/class_TextOperator.html

Gets a value indicating whether the filter prefers cell variants.

```APIDOC
## wants_variants?

### Description
Gets a value indicating whether the filter prefers cell variants.

### Method
wants_variants?

### Parameters
None

### Returns
bool - True if the filter prefers cell variants, false otherwise.
```

--------------------------------

### begin

Source: https://www.klayout.de/doc-qt5/code/class_TileOutputReceiver.html

Initiates the delivery.

```APIDOC
## [METHOD] begin

### Description
Initiates the delivery.

### Method
begin

### Endpoint
begin(unsigned long nx, unsigned long ny, const DPoint p0, double dx, double dy, const DBox frame)

### Parameters
- **nx** (unsigned long) - Required - Number of tiles in x direction
- **ny** (unsigned long) - Required - Number of tiles in y direction
- **p0** (DPoint) - Required - Origin point
- **dx** (double) - Required - Tile width
- **dy** (double) - Required - Tile height
- **frame** (DBox) - Required - Frame box

### Request Example
None

### Response
#### Success Response
- **void** - No return value

#### Response Example
None
```

--------------------------------

### properties_hash

Source: https://www.klayout.de/doc-qt5/code/class_Layout.html

Gets the properties set for a given properties ID as a hash.

```APIDOC
## properties_hash

### Description
Gets the properties set for a given properties ID as a hash.

### Method
Static method

### Parameters
- **properties_id** (unsigned long) - Required - The properties ID.

### Returns
- **variant** - The properties set as a hash.
```

--------------------------------

### start_changes()

Source: https://www.klayout.de/doc-qt5/code/class_Layout.html

Signals the start of an operation bringing the layout into invalid state.

```APIDOC
## start_changes()

### Description
Signals the start of an operation bringing the layout into invalid state.

### Method
start_changes

### Parameters
None

### Return Type
void
```

--------------------------------

### start(QIODevice ptr device)

Source: https://www.klayout.de/doc-qt5/code/class_QAudioInput.html

Starts audio input using the specified QIODevice. This is an overloaded method.

```APIDOC
## start(QIODevice ptr device)

### Description
Starts audio input using the specified QIODevice.

### Method
void

### Parameters
- **device** (QIODevice ptr) - Required - The device to use for audio input.
```

--------------------------------

### meta_info_value(string)

Source: https://www.klayout.de/doc-qt5/code/class_Layout.html

Gets the meta information value for a given name.

```APIDOC
## meta_info_value(string name)

### Description
Gets the meta information value for a given name.

### Method
meta_info_value

### Parameters
- **name** (string) - Required - Name of the meta information.

### Returns
variant - The meta information value.
```

--------------------------------

### new

Source: https://www.klayout.de/doc-qt5/code/class_QFileDevice.html

Creates a new object of this class. This is the default initializer in Python.

```APIDOC
## new

### Description
Creates a new object of this class. This is the default initializer in Python.

### Signature
[static] new QFileDevice ptr new

### Returns
- **QFileDevice ptr** - A new instance of QFileDevice.
```

--------------------------------

### get_info(unsigned int)

Source: https://www.klayout.de/doc-qt5/code/class_Layout.html

Gets the info structure for a specified layer.

```APIDOC
## get_info(unsigned int index)

### Description
Gets the info structure for a specified layer.

### Method
get_info

### Parameters
- **index** (unsigned int) - Required - Layer index.

### Returns
LayerInfo
```

--------------------------------

### Application::instance.main_window

Source: https://www.klayout.de/doc-qt5/programming/application_api.html

Obtains the main application window instance, which is the entry point to all user-interface related objects.

```APIDOC
## Application::instance.main_window

### Description
Returns the main window object of the application. This is the entry point to all user-interface related objects.

### Method
Property access

### Endpoint
Application::instance.main_window

### Response
#### Success Response
- **main_window** (MainWindow) - The main window instance.
```

--------------------------------

### cell(unsigned int i)

Source: https://www.klayout.de/doc-qt5/code/class_Layout.html

Gets a cell object from the cell index.

```APIDOC
## [METHOD] cell(unsigned int i)

### Description
Gets a cell object from the cell index.

### Method
cell

### Parameters
- **i** (unsigned int) - Required - The cell index.

### Returns
- **Cell ptr** - The cell object.

```

--------------------------------

### new

Source: https://www.klayout.de/doc-qt5/code/class_QMediaRecorder.html

Constructor for QMediaRecorder. Creates a new instance.

```APIDOC
## [CONSTRUCTOR] new

### Description
Creates a new QMediaRecorder object.

### Method
CONSTRUCTOR

### Endpoint
new

### Parameters
#### Request Body
- **mediaObject** (QMediaObject ptr) - Required - The media object.
- **parent** (QObject ptr) - Optional - Parent object.

### Request Example
```json
{
  "mediaObject": "...",
  "parent": null
}
```

### Response
#### Success Response (200)
- **QMediaRecorder** - The new object.
```

--------------------------------

### cell(string name)

Source: https://www.klayout.de/doc-qt5/code/class_Layout.html

Gets a cell object from the cell name.

```APIDOC
## [METHOD] cell(string name)

### Description
Gets a cell object from the cell name.

### Method
cell

### Parameters
- **name** (string) - Required - The cell name.

### Returns
- **Cell ptr** - The cell object.

```

--------------------------------

### new QGuiApplication

Source: https://www.klayout.de/doc-qt5/code/class_QGuiApplication.html

Creates a new QGuiApplication object with the given command-line arguments.

```APIDOC
## [CONSTRUCTOR] new QGuiApplication

### Description
Creates a new QGuiApplication object.

### Method
new

### Parameters
- **argv** (string[]) - Required - Command-line arguments

### Returns
QGuiApplication ptr - The newly created QGuiApplication object.
```

--------------------------------

### _create

Source: https://www.klayout.de/doc-qt5/code/class_QAbstractAudioDeviceInfo.html

Ensures the C++ object is created.

```APIDOC
## Method: _create

### Description
Ensures the C++ object is created.

### Signature
`void _create()`

### Parameters
None

### Returns
void
```

--------------------------------

### wants_variants?

Source: https://www.klayout.de/doc-qt5/code/class_EdgePairFilter.html

Gets a value indicating whether the filter prefers cell variants.

```APIDOC
## wants_variants?

### Description
Gets a value indicating whether the filter prefers cell variants.

### Method
wants_variants?

### Endpoint
wants_variants?

### Parameters
None

### Response
#### Success Response
- **bool** - True if the filter prefers cell variants, false otherwise.

```
Tokens:
Raw