KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QTextFrameFormat::BorderStyle

Notation used in Ruby API documentation

Module: QtGui

Description: This class represents the QTextFrameFormat::BorderStyle enum

This class is equivalent to the class QTextFrameFormat_BorderStyle

Public constructors

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

Public methods

[const]bool!=(const QTextFrameFormat_BorderStyle other)Compares two enums for inequality
[const]bool!=(int other)Compares an enum with an integer for inequality
[const]bool<(const QTextFrameFormat_BorderStyle 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 QTextFrameFormat_BorderStyle other)Compares two enums
[const]bool==(int other)Compares an enum with an integer value
[const]QTextFrameFormat_BorderStyle 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]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 QTextFrameFormat_BorderStyle other)Assigns another object to self
[const]new QTextFrameFormat_BorderStyle ptrdupCreates a copy of self
[const]inthashGets the hash value from the enum
[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]QTextFrameFormat_QFlags_BorderStyle|(const QTextFrameFormat_BorderStyle other)Creates a flag set by combining the two flags
[const]QTextFrameFormat_QFlags_BorderStyle|(const QTextFrameFormat_QFlags_BorderStyle other)Combines the flag and the flag set

Public static methods and constants

[static,const]QTextFrameFormat_BorderStyleBorderStyle_DashedEnum constant QTextFrameFormat::BorderStyle_Dashed
[static,const]QTextFrameFormat_BorderStyleBorderStyle_DotDashEnum constant QTextFrameFormat::BorderStyle_DotDash
[static,const]QTextFrameFormat_BorderStyleBorderStyle_DotDotDashEnum constant QTextFrameFormat::BorderStyle_DotDotDash
[static,const]QTextFrameFormat_BorderStyleBorderStyle_DottedEnum constant QTextFrameFormat::BorderStyle_Dotted
[static,const]QTextFrameFormat_BorderStyleBorderStyle_DoubleEnum constant QTextFrameFormat::BorderStyle_Double
[static,const]QTextFrameFormat_BorderStyleBorderStyle_GrooveEnum constant QTextFrameFormat::BorderStyle_Groove
[static,const]QTextFrameFormat_BorderStyleBorderStyle_InsetEnum constant QTextFrameFormat::BorderStyle_Inset
[static,const]QTextFrameFormat_BorderStyleBorderStyle_NoneEnum constant QTextFrameFormat::BorderStyle_None
[static,const]QTextFrameFormat_BorderStyleBorderStyle_OutsetEnum constant QTextFrameFormat::BorderStyle_Outset
[static,const]QTextFrameFormat_BorderStyleBorderStyle_RidgeEnum constant QTextFrameFormat::BorderStyle_Ridge
[static,const]QTextFrameFormat_BorderStyleBorderStyle_SolidEnum constant QTextFrameFormat::BorderStyle_Solid

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 QTextFrameFormat_BorderStyle 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 QTextFrameFormat_BorderStyle 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 QTextFrameFormat_BorderStyle other)

Description: Compares two enums

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

Description: Compares an enum with an integer value

BorderStyle_Dashed

Signature: [static,const] QTextFrameFormat_BorderStyle BorderStyle_Dashed

Description: Enum constant QTextFrameFormat::BorderStyle_Dashed

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

BorderStyle_DotDash

Signature: [static,const] QTextFrameFormat_BorderStyle BorderStyle_DotDash

Description: Enum constant QTextFrameFormat::BorderStyle_DotDash

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

BorderStyle_DotDotDash

Signature: [static,const] QTextFrameFormat_BorderStyle BorderStyle_DotDotDash

Description: Enum constant QTextFrameFormat::BorderStyle_DotDotDash

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

BorderStyle_Dotted

Signature: [static,const] QTextFrameFormat_BorderStyle BorderStyle_Dotted

Description: Enum constant QTextFrameFormat::BorderStyle_Dotted

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

BorderStyle_Double

Signature: [static,const] QTextFrameFormat_BorderStyle BorderStyle_Double

Description: Enum constant QTextFrameFormat::BorderStyle_Double

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

BorderStyle_Groove

Signature: [static,const] QTextFrameFormat_BorderStyle BorderStyle_Groove

Description: Enum constant QTextFrameFormat::BorderStyle_Groove

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

BorderStyle_Inset

Signature: [static,const] QTextFrameFormat_BorderStyle BorderStyle_Inset

Description: Enum constant QTextFrameFormat::BorderStyle_Inset

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

BorderStyle_None

Signature: [static,const] QTextFrameFormat_BorderStyle BorderStyle_None

Description: Enum constant QTextFrameFormat::BorderStyle_None

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

BorderStyle_Outset

Signature: [static,const] QTextFrameFormat_BorderStyle BorderStyle_Outset

Description: Enum constant QTextFrameFormat::BorderStyle_Outset

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

BorderStyle_Ridge

Signature: [static,const] QTextFrameFormat_BorderStyle BorderStyle_Ridge

Description: Enum constant QTextFrameFormat::BorderStyle_Ridge

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

BorderStyle_Solid

Signature: [static,const] QTextFrameFormat_BorderStyle BorderStyle_Solid

Description: Enum constant QTextFrameFormat::BorderStyle_Solid

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

_const_cast

Signature: [const] QTextFrameFormat_BorderStyle 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.

_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 QTextFrameFormat_BorderStyle 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 QTextFrameFormat_BorderStyle ptr dup

Description: Creates a copy of self

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

hash

Signature: [const] int hash

Description: Gets the hash value from the enum

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

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 QTextFrameFormat_BorderStyle 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 QTextFrameFormat_BorderStyle 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

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

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] QTextFrameFormat_QFlags_BorderStyle | (const QTextFrameFormat_BorderStyle other)

Description: Creates a flag set by combining the two flags

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

Description: Combines the flag and the flag set