API reference - Class QPicture

Notation used in Ruby API documentation

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
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]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.
voidassign(const QPicture other)Assigns another object to self
[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 = 0)
Method bool QPicture::load(QIODevice *dev, const char *format)
boolload(string fileName,
string format = 0)
Method bool QPicture::load(const QString &fileName, const char *format)
[virtual,const]QPaintEngine ptrpaintEngineVirtual method QPaintEngine *QPicture::paintEngine()
boolplay(QPainter ptr p)Method bool QPicture::play(QPainter *p)
boolsave(QIODevice ptr dev,
string format = 0)
Method bool QPicture::save(QIODevice *dev, const char *format)
boolsave(string fileName,
string format = 0)
Method bool QPicture::save(const QString &fileName, const char *format)
voidsetBoundingRect(const QRect r)Method void QPicture::setBoundingRect(const QRect &r)
[virtual]voidsetData(string data,
unsigned int size)
Virtual method void QPicture::setData(const char *data, unsigned int size)
[const]unsigned intsizeMethod unsigned int QPicture::size()

Public static methods and constants

string[]inputFormatListStatic method QStringList QPicture::inputFormatList()
string[]inputFormatsStatic method QList<QByteArray> QPicture::inputFormats()
string[]outputFormatListStatic method QStringList QPicture::outputFormatList()
string[]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)

[virtual,const]intmetric(const QPaintDevice_PaintDeviceMetric m)Virtual method int QPicture::metric(QPaintDevice::PaintDeviceMetric m)

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

void _assign(const QPicture other)

Description: Assigns another object to self

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.

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.

[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.

[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.

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.

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.

void assign(const QPicture other)

Description: Assigns another object to self

[const] QRect boundingRect

Description: Method QRect QPicture::boundingRect()

Python specific notes:

The object exposes a readable attribute 'boundingRect'. This is the getter.

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.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[const] string data

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

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

void detach

Description: Method void QPicture::detach()

[const] new QPicture ptr dup

Description: Creates a copy of self

[static] string[] inputFormatList

Description: Static method QStringList QPicture::inputFormatList()

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

[static] string[] inputFormats

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

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

[const] bool isDetached?

Description: Method bool QPicture::isDetached()

[const] bool isNull?

Description: Method bool QPicture::isNull()

[const] bool is_const_object?

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

Use of this method is deprecated. Use _is_const_object? instead

bool load(QIODevice ptr dev,string format = 0)

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

bool load(string fileName,string format = 0)

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

[virtual,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.

[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

[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

[static] string[] outputFormatList

Description: Static method QStringList QPicture::outputFormatList()

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

[static] string[] outputFormats

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

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

[virtual,const] QPaintEngine ptr paintEngine

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

This method can be reimplemented in a derived class.

[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.

bool play(QPainter ptr p)

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

bool save(QIODevice ptr dev,string format = 0)

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

bool save(string fileName,string format = 0)

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

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.

[virtual] 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.

[const] unsigned int size

Description: Method unsigned int QPicture::size()

Python specific notes:

This method is also available as 'len(object)'