API reference - Class QPrinter_PaperSource

Notation used in Ruby API documentation

Module: QtPrintSupport

Description: This class represents the QPrinter::PaperSource enum

This class is equivalent to the class QPrinter::PaperSource

Public constructors

new QPrinter_PaperSource ptrnew(int i)Creates an enum from an integer value
new QPrinter_PaperSource ptrnew(string s)Creates an enum from a string value

Public methods

[const]bool!=(const QPrinter_PaperSource other)Compares two enums for inequality
[const]bool!=(int other)Compares an enum with an integer for inequality
[const]bool<(const QPrinter_PaperSource other)Returns true if the first enum is less (in the enum symbol order) than the second
[const]bool<(int other)Returns true if the enum is less (in the enum symbol order) than the integer value
[const]bool==(const QPrinter_PaperSource other)Compares two enums
[const]bool==(int other)Compares an enum with an integer value
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 QPrinter_PaperSource other)Assigns another object to self
[const]new QPrinter_PaperSource ptrdupCreates a copy of self
[const]stringinspectConverts an enum to a visual string
[const]intto_iGets the integer value from the enum
[const]stringto_sGets the symbolic string from an enum
[const]QPrinter_QFlags_PaperSource|(const QPrinter_PaperSource other)Creates a flag set by combining the two flags
[const]QPrinter_QFlags_PaperSource|(const QPrinter_QFlags_PaperSource other)Combines the flag and the flag set

Public static methods and constants

[static,const]QPrinter_PaperSourceAutoEnum constant QPrinter::Auto
[static,const]QPrinter_PaperSourceCassetteEnum constant QPrinter::Cassette
[static,const]QPrinter_PaperSourceCustomSourceEnum constant QPrinter::CustomSource
[static,const]QPrinter_PaperSourceEnvelopeEnum constant QPrinter::Envelope
[static,const]QPrinter_PaperSourceEnvelopeManualEnum constant QPrinter::EnvelopeManual
[static,const]QPrinter_PaperSourceFormSourceEnum constant QPrinter::FormSource
[static,const]QPrinter_PaperSourceLargeCapacityEnum constant QPrinter::LargeCapacity
[static,const]QPrinter_PaperSourceLargeFormatEnum constant QPrinter::LargeFormat
[static,const]QPrinter_PaperSourceLastPaperSourceEnum constant QPrinter::LastPaperSource
[static,const]QPrinter_PaperSourceLowerEnum constant QPrinter::Lower
[static,const]QPrinter_PaperSourceManualEnum constant QPrinter::Manual
[static,const]QPrinter_PaperSourceMaxPageSourceEnum constant QPrinter::MaxPageSource
[static,const]QPrinter_PaperSourceMiddleEnum constant QPrinter::Middle
[static,const]QPrinter_PaperSourceOnlyOneEnum constant QPrinter::OnlyOne
[static,const]QPrinter_PaperSourceSmallFormatEnum constant QPrinter::SmallFormat
[static,const]QPrinter_PaperSourceTractorEnum constant QPrinter::Tractor
[static,const]QPrinter_PaperSourceUpperEnum constant QPrinter::Upper

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

!=

(1) Signature: [const] bool != (const QPrinter_PaperSource other)

Description: Compares two enums for inequality

(2) Signature: [const] bool != (int other)

Description: Compares an enum with an integer for inequality

<

(1) Signature: [const] bool < (const QPrinter_PaperSource other)

Description: Returns true if the first enum is less (in the enum symbol order) than the second

(2) Signature: [const] bool < (int other)

Description: Returns true if the enum is less (in the enum symbol order) than the integer value

==

(1) Signature: [const] bool == (const QPrinter_PaperSource other)

Description: Compares two enums

(2) Signature: [const] bool == (int other)

Description: Compares an enum with an integer value

Auto

Signature: [static,const] QPrinter_PaperSource Auto

Description: Enum constant QPrinter::Auto

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

Cassette

Signature: [static,const] QPrinter_PaperSource Cassette

Description: Enum constant QPrinter::Cassette

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

CustomSource

Signature: [static,const] QPrinter_PaperSource CustomSource

Description: Enum constant QPrinter::CustomSource

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

Envelope

Signature: [static,const] QPrinter_PaperSource Envelope

Description: Enum constant QPrinter::Envelope

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

EnvelopeManual

Signature: [static,const] QPrinter_PaperSource EnvelopeManual

Description: Enum constant QPrinter::EnvelopeManual

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

FormSource

Signature: [static,const] QPrinter_PaperSource FormSource

Description: Enum constant QPrinter::FormSource

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

LargeCapacity

Signature: [static,const] QPrinter_PaperSource LargeCapacity

Description: Enum constant QPrinter::LargeCapacity

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

LargeFormat

Signature: [static,const] QPrinter_PaperSource LargeFormat

Description: Enum constant QPrinter::LargeFormat

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

LastPaperSource

Signature: [static,const] QPrinter_PaperSource LastPaperSource

Description: Enum constant QPrinter::LastPaperSource

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

Lower

Signature: [static,const] QPrinter_PaperSource Lower

Description: Enum constant QPrinter::Lower

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

Manual

Signature: [static,const] QPrinter_PaperSource Manual

Description: Enum constant QPrinter::Manual

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

MaxPageSource

Signature: [static,const] QPrinter_PaperSource MaxPageSource

Description: Enum constant QPrinter::MaxPageSource

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

Middle

Signature: [static,const] QPrinter_PaperSource Middle

Description: Enum constant QPrinter::Middle

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

OnlyOne

Signature: [static,const] QPrinter_PaperSource OnlyOne

Description: Enum constant QPrinter::OnlyOne

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

SmallFormat

Signature: [static,const] QPrinter_PaperSource SmallFormat

Description: Enum constant QPrinter::SmallFormat

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

Tractor

Signature: [static,const] QPrinter_PaperSource Tractor

Description: Enum constant QPrinter::Tractor

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

Upper

Signature: [static,const] QPrinter_PaperSource Upper

Description: Enum constant QPrinter::Upper

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

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

_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: void assign (const QPrinter_PaperSource other)

Description: Assigns another object to self

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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

Use of this method is deprecated. Use _destroy instead

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

Use of this method is deprecated. Use _destroyed? instead

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 QPrinter_PaperSource ptr dup

Description: Creates a copy of self

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

inspect

Signature: [const] string inspect

Description: Converts an enum to a visual string

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

is_const_object?

Signature: [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

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

new

(1) Signature: [static] new QPrinter_PaperSource ptr new (int i)

Description: Creates an enum from an integer value

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

(2) Signature: [static] new QPrinter_PaperSource ptr new (string s)

Description: Creates an enum from a string value

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

to_i

Signature: [const] int to_i

Description: Gets the integer value from the enum

to_s

Signature: [const] string to_s

Description: Gets the symbolic string from an enum

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

|

(1) Signature: [const] QPrinter_QFlags_PaperSource | (const QPrinter_PaperSource other)

Description: Creates a flag set by combining the two flags

(2) Signature: [const] QPrinter_QFlags_PaperSource | (const QPrinter_QFlags_PaperSource other)

Description: Combines the flag and the flag set