KLayout 0.29.8 (2024-10-28 63dd591e5) [master]

API reference - Class QPicture

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QPicture

Class hierarchy: QPicture » QPaintDevice

Public constructors

new QPicturenew(int formatVersion = -1)Constructor QPicture::QPicture(int formatVersion)
new QPicturenew(const QPicture arg1)Constructor QPicture::QPicture(const QPicture &)

Public methods

void_assign(const QPicture other)Assigns another object to self
[const]QPicture ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]new QPicture ptr_dupCreates a copy of self
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
QPictureassign(const QPicture p)Method QPicture &QPicture::operator=(const QPicture &p)
[const]QRectboundingRectMethod QRect QPicture::boundingRect()
voidboundingRect=(const QRect r)Method void QPicture::setBoundingRect(const QRect &r)
[const]stringdataMethod const char *QPicture::data()
voiddetachMethod void QPicture::detach()
[const]new QPicture ptrdupCreates a copy of self
[const]boolisDetached?Method bool QPicture::isDetached()
[const]boolisNull?Method bool QPicture::isNull()
boolload(QIODevice ptr dev,
string format = nullptr)
Method bool QPicture::load(QIODevice *dev, const char *format)
boolload(string fileName,
string format = nullptr)
Method bool QPicture::load(const QString &fileName, const char *format)
[const]QPaintEngine ptrpaintEngineVirtual method QPaintEngine *QPicture::paintEngine()
boolplay(QPainter ptr p)Method bool QPicture::play(QPainter *p)
boolsave(QIODevice ptr dev,
string format = nullptr)
Method bool QPicture::save(QIODevice *dev, const char *format)
boolsave(string fileName,
string format = nullptr)
Method bool QPicture::save(const QString &fileName, const char *format)
voidsetBoundingRect(const QRect r)Method void QPicture::setBoundingRect(const QRect &r)
voidsetData(string data,
unsigned int size)
Virtual method void QPicture::setData(const char *data, unsigned int size)
[const]unsigned intsizeMethod unsigned int QPicture::size()
voidswap(QPicture other)Method void QPicture::swap(QPicture &other)

Public static methods and constants

string[]inputFormatListStatic method QStringList QPicture::inputFormatList()
bytes[]inputFormatsStatic method QList<QByteArray> QPicture::inputFormats()
string[]outputFormatListStatic method QStringList QPicture::outputFormatList()
bytes[]outputFormatsStatic method QList<QByteArray> QPicture::outputFormats()
stringpictureFormat(string fileName)Static method const char *QPicture::pictureFormat(const QString &fileName)

Protected methods (static, non-static and constructors)

[const]voidinitPainter(QPainter ptr painter)Virtual method void QPicture::initPainter(QPainter *painter)
[const]intmetric(const QPaintDevice_PaintDeviceMetric m)Virtual method int QPicture::metric(QPaintDevice::PaintDeviceMetric m)
[const]QPaintDevice ptrredirected(QPoint ptr offset)Virtual method QPaintDevice *QPicture::redirected(QPoint *offset)
[const]QPainter ptrsharedPainterVirtual method QPainter *QPicture::sharedPainter()

Detailed description

_assign

Signature: void _assign (const QPicture other)

Description: Assigns another object to self

_const_cast

Signature: [const] QPicture ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_dup

Signature: [const] new QPicture ptr _dup

Description: Creates a copy of self

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

assign

Signature: QPicture assign (const QPicture p)

Description: Method QPicture &QPicture::operator=(const QPicture &p)

boundingRect

Signature: [const] QRect boundingRect

Description: Method QRect QPicture::boundingRect()

Python specific notes:
The object exposes a readable attribute 'boundingRect'. This is the getter.

boundingRect=

Signature: void boundingRect= (const QRect r)

Description: Method void QPicture::setBoundingRect(const QRect &r)

Python specific notes:
The object exposes a writable attribute 'boundingRect'. This is the setter.

data

Signature: [const] string data

Description: Method const char *QPicture::data()

detach

Signature: void detach

Description: Method void QPicture::detach()

dup

Signature: [const] new QPicture ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

initPainter

Signature: [const] void initPainter (QPainter ptr painter)

Description: Virtual method void QPicture::initPainter(QPainter *painter)

This method can be reimplemented in a derived class.

inputFormatList

Signature: [static] string[] inputFormatList

Description: Static method QStringList QPicture::inputFormatList()

This method is static and can be called without an instance.

inputFormats

Signature: [static] bytes[] inputFormats

Description: Static method QList<QByteArray> QPicture::inputFormats()

This method is static and can be called without an instance.

isDetached?

Signature: [const] bool isDetached?

Description: Method bool QPicture::isDetached()

isNull?

Signature: [const] bool isNull?

Description: Method bool QPicture::isNull()

load

(1) Signature: bool load (QIODevice ptr dev, string format = nullptr)

Description: Method bool QPicture::load(QIODevice *dev, const char *format)

(2) Signature: bool load (string fileName, string format = nullptr)

Description: Method bool QPicture::load(const QString &fileName, const char *format)

metric

Signature: [const] int metric (const QPaintDevice_PaintDeviceMetric m)

Description: Virtual method int QPicture::metric(QPaintDevice::PaintDeviceMetric m)

This method can be reimplemented in a derived class.

new

(1) Signature: [static] new QPicture new (int formatVersion = -1)

Description: Constructor QPicture::QPicture(int formatVersion)

This method creates an object of class QPicture.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QPicture new (const QPicture arg1)

Description: Constructor QPicture::QPicture(const QPicture &)

This method creates an object of class QPicture.

Python specific notes:
This method is the default initializer of the object.

outputFormatList

Signature: [static] string[] outputFormatList

Description: Static method QStringList QPicture::outputFormatList()

This method is static and can be called without an instance.

outputFormats

Signature: [static] bytes[] outputFormats

Description: Static method QList<QByteArray> QPicture::outputFormats()

This method is static and can be called without an instance.

paintEngine

Signature: [const] QPaintEngine ptr paintEngine

Description: Virtual method QPaintEngine *QPicture::paintEngine()

This method can be reimplemented in a derived class.

pictureFormat

Signature: [static] string pictureFormat (string fileName)

Description: Static method const char *QPicture::pictureFormat(const QString &fileName)

This method is static and can be called without an instance.

play

Signature: bool play (QPainter ptr p)

Description: Method bool QPicture::play(QPainter *p)

redirected

Signature: [const] QPaintDevice ptr redirected (QPoint ptr offset)

Description: Virtual method QPaintDevice *QPicture::redirected(QPoint *offset)

This method can be reimplemented in a derived class.

save

(1) Signature: bool save (QIODevice ptr dev, string format = nullptr)

Description: Method bool QPicture::save(QIODevice *dev, const char *format)

(2) Signature: bool save (string fileName, string format = nullptr)

Description: Method bool QPicture::save(const QString &fileName, const char *format)

setBoundingRect

Signature: void setBoundingRect (const QRect r)

Description: Method void QPicture::setBoundingRect(const QRect &r)

Python specific notes:
The object exposes a writable attribute 'boundingRect'. This is the setter.

setData

Signature: void setData (string data, unsigned int size)

Description: Virtual method void QPicture::setData(const char *data, unsigned int size)

This method can be reimplemented in a derived class.

sharedPainter

Signature: [const] QPainter ptr sharedPainter

Description: Virtual method QPainter *QPicture::sharedPainter()

This method can be reimplemented in a derived class.

size

Signature: [const] unsigned int size

Description: Method unsigned int QPicture::size()

Python specific notes:
This method is also available as 'len(object)'.

swap

Signature: void swap (QPicture other)

Description: Method void QPicture::swap(QPicture &other)