API reference - Class QPalette::ColorRole

Notation used in Ruby API documentation

Description: This class represents the QPalette::ColorRole enum

This class is equivalent to the class QPalette_ColorRole

Public constructors

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

Public methods

[const]bool!=(const QPalette_ColorRole other)Compares two enums for inequality
[const]bool<(const QPalette_ColorRole other)Returns true if the first enum is less (in the enum symbol order) than the second
[const]bool==(const QPalette_ColorRole other)Compares two enums
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 QPalette_ColorRole other)Assigns another object to self
[const]new QPalette_ColorRole 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]QPalette_QFlags_ColorRole|(const QPalette_ColorRole other)Creates a flag set by combining the two flags
[const]QPalette_QFlags_ColorRole|(const QPalette_QFlags_ColorRole other)Combines the flag and the flag set

Public static methods and constants

[static,const]QPalette_ColorRoleAlternateBaseEnum constant QPalette::AlternateBase
[static,const]QPalette_ColorRoleBackgroundEnum constant QPalette::Background
[static,const]QPalette_ColorRoleBaseEnum constant QPalette::Base
[static,const]QPalette_ColorRoleBrightTextEnum constant QPalette::BrightText
[static,const]QPalette_ColorRoleButtonEnum constant QPalette::Button
[static,const]QPalette_ColorRoleButtonTextEnum constant QPalette::ButtonText
[static,const]QPalette_ColorRoleDarkEnum constant QPalette::Dark
[static,const]QPalette_ColorRoleForegroundEnum constant QPalette::Foreground
[static,const]QPalette_ColorRoleHighlightEnum constant QPalette::Highlight
[static,const]QPalette_ColorRoleHighlightedTextEnum constant QPalette::HighlightedText
[static,const]QPalette_ColorRoleLightEnum constant QPalette::Light
[static,const]QPalette_ColorRoleLinkEnum constant QPalette::Link
[static,const]QPalette_ColorRoleLinkVisitedEnum constant QPalette::LinkVisited
[static,const]QPalette_ColorRoleMidEnum constant QPalette::Mid
[static,const]QPalette_ColorRoleMidlightEnum constant QPalette::Midlight
[static,const]QPalette_ColorRoleNColorRolesEnum constant QPalette::NColorRoles
[static,const]QPalette_ColorRoleNoRoleEnum constant QPalette::NoRole
[static,const]QPalette_ColorRoleShadowEnum constant QPalette::Shadow
[static,const]QPalette_ColorRoleTextEnum constant QPalette::Text
[static,const]QPalette_ColorRoleToolTipBaseEnum constant QPalette::ToolTipBase
[static,const]QPalette_ColorRoleToolTipTextEnum constant QPalette::ToolTipText
[static,const]QPalette_ColorRoleWindowEnum constant QPalette::Window
[static,const]QPalette_ColorRoleWindowTextEnum constant QPalette::WindowText

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

!=

Signature: [const] bool != (const QPalette_ColorRole other)

Description: Compares two enums for inequality

<

Signature: [const] bool < (const QPalette_ColorRole other)

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

==

Signature: [const] bool == (const QPalette_ColorRole other)

Description: Compares two enums

AlternateBase

Signature: [static,const] QPalette_ColorRole AlternateBase

Description: Enum constant QPalette::AlternateBase

Background

Signature: [static,const] QPalette_ColorRole Background

Description: Enum constant QPalette::Background

Base

Signature: [static,const] QPalette_ColorRole Base

Description: Enum constant QPalette::Base

BrightText

Signature: [static,const] QPalette_ColorRole BrightText

Description: Enum constant QPalette::BrightText

Button

Signature: [static,const] QPalette_ColorRole Button

Description: Enum constant QPalette::Button

ButtonText

Signature: [static,const] QPalette_ColorRole ButtonText

Description: Enum constant QPalette::ButtonText

Dark

Signature: [static,const] QPalette_ColorRole Dark

Description: Enum constant QPalette::Dark

Foreground

Signature: [static,const] QPalette_ColorRole Foreground

Description: Enum constant QPalette::Foreground

Highlight

Signature: [static,const] QPalette_ColorRole Highlight

Description: Enum constant QPalette::Highlight

HighlightedText

Signature: [static,const] QPalette_ColorRole HighlightedText

Description: Enum constant QPalette::HighlightedText

Light

Signature: [static,const] QPalette_ColorRole Light

Description: Enum constant QPalette::Light

Link

Signature: [static,const] QPalette_ColorRole Link

Description: Enum constant QPalette::Link

LinkVisited

Signature: [static,const] QPalette_ColorRole LinkVisited

Description: Enum constant QPalette::LinkVisited

Mid

Signature: [static,const] QPalette_ColorRole Mid

Description: Enum constant QPalette::Mid

Midlight

Signature: [static,const] QPalette_ColorRole Midlight

Description: Enum constant QPalette::Midlight

NColorRoles

Signature: [static,const] QPalette_ColorRole NColorRoles

Description: Enum constant QPalette::NColorRoles

NoRole

Signature: [static,const] QPalette_ColorRole NoRole

Description: Enum constant QPalette::NoRole

Shadow

Signature: [static,const] QPalette_ColorRole Shadow

Description: Enum constant QPalette::Shadow

Text

Signature: [static,const] QPalette_ColorRole Text

Description: Enum constant QPalette::Text

ToolTipBase

Signature: [static,const] QPalette_ColorRole ToolTipBase

Description: Enum constant QPalette::ToolTipBase

ToolTipText

Signature: [static,const] QPalette_ColorRole ToolTipText

Description: Enum constant QPalette::ToolTipText

Window

Signature: [static,const] QPalette_ColorRole Window

Description: Enum constant QPalette::Window

WindowText

Signature: [static,const] QPalette_ColorRole WindowText

Description: Enum constant QPalette::WindowText

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

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

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

dup

Signature: [const] new QPalette_ColorRole ptr dup

Description: Creates a copy of self

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

new

Signature: [static] new QPalette_ColorRole ptr new (int i)

Description: Creates an enum from an integer value

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

Signature: [static] new QPalette_ColorRole 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)'

|

Signature: [const] QPalette_QFlags_ColorRole | (const QPalette_ColorRole other)

Description: Creates a flag set by combining the two flags

Signature: [const] QPalette_QFlags_ColorRole | (const QPalette_QFlags_ColorRole other)

Description: Combines the flag and the flag set