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

API reference - Class QStyle::SubControl

Notation used in Ruby API documentation

Module: QtWidgets

Description: This class represents the QStyle::SubControl enum

This class is equivalent to the class QStyle_SubControl

Public constructors

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

Public methods

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

Public static methods and constants

[static,const]QStyle_SubControlSC_AllEnum constant QStyle::SC_All
[static,const]QStyle_SubControlSC_ComboBoxArrowEnum constant QStyle::SC_ComboBoxArrow
[static,const]QStyle_SubControlSC_ComboBoxEditFieldEnum constant QStyle::SC_ComboBoxEditField
[static,const]QStyle_SubControlSC_ComboBoxFrameEnum constant QStyle::SC_ComboBoxFrame
[static,const]QStyle_SubControlSC_ComboBoxListBoxPopupEnum constant QStyle::SC_ComboBoxListBoxPopup
[static,const]QStyle_SubControlSC_CustomBaseEnum constant QStyle::SC_CustomBase
[static,const]QStyle_SubControlSC_DialGrooveEnum constant QStyle::SC_DialGroove
[static,const]QStyle_SubControlSC_DialHandleEnum constant QStyle::SC_DialHandle
[static,const]QStyle_SubControlSC_DialTickmarksEnum constant QStyle::SC_DialTickmarks
[static,const]QStyle_SubControlSC_GroupBoxCheckBoxEnum constant QStyle::SC_GroupBoxCheckBox
[static,const]QStyle_SubControlSC_GroupBoxContentsEnum constant QStyle::SC_GroupBoxContents
[static,const]QStyle_SubControlSC_GroupBoxFrameEnum constant QStyle::SC_GroupBoxFrame
[static,const]QStyle_SubControlSC_GroupBoxLabelEnum constant QStyle::SC_GroupBoxLabel
[static,const]QStyle_SubControlSC_MdiCloseButtonEnum constant QStyle::SC_MdiCloseButton
[static,const]QStyle_SubControlSC_MdiMinButtonEnum constant QStyle::SC_MdiMinButton
[static,const]QStyle_SubControlSC_MdiNormalButtonEnum constant QStyle::SC_MdiNormalButton
[static,const]QStyle_SubControlSC_NoneEnum constant QStyle::SC_None
[static,const]QStyle_SubControlSC_ScrollBarAddLineEnum constant QStyle::SC_ScrollBarAddLine
[static,const]QStyle_SubControlSC_ScrollBarAddPageEnum constant QStyle::SC_ScrollBarAddPage
[static,const]QStyle_SubControlSC_ScrollBarFirstEnum constant QStyle::SC_ScrollBarFirst
[static,const]QStyle_SubControlSC_ScrollBarGrooveEnum constant QStyle::SC_ScrollBarGroove
[static,const]QStyle_SubControlSC_ScrollBarLastEnum constant QStyle::SC_ScrollBarLast
[static,const]QStyle_SubControlSC_ScrollBarSliderEnum constant QStyle::SC_ScrollBarSlider
[static,const]QStyle_SubControlSC_ScrollBarSubLineEnum constant QStyle::SC_ScrollBarSubLine
[static,const]QStyle_SubControlSC_ScrollBarSubPageEnum constant QStyle::SC_ScrollBarSubPage
[static,const]QStyle_SubControlSC_SliderGrooveEnum constant QStyle::SC_SliderGroove
[static,const]QStyle_SubControlSC_SliderHandleEnum constant QStyle::SC_SliderHandle
[static,const]QStyle_SubControlSC_SliderTickmarksEnum constant QStyle::SC_SliderTickmarks
[static,const]QStyle_SubControlSC_SpinBoxDownEnum constant QStyle::SC_SpinBoxDown
[static,const]QStyle_SubControlSC_SpinBoxEditFieldEnum constant QStyle::SC_SpinBoxEditField
[static,const]QStyle_SubControlSC_SpinBoxFrameEnum constant QStyle::SC_SpinBoxFrame
[static,const]QStyle_SubControlSC_SpinBoxUpEnum constant QStyle::SC_SpinBoxUp
[static,const]QStyle_SubControlSC_TitleBarCloseButtonEnum constant QStyle::SC_TitleBarCloseButton
[static,const]QStyle_SubControlSC_TitleBarContextHelpButtonEnum constant QStyle::SC_TitleBarContextHelpButton
[static,const]QStyle_SubControlSC_TitleBarLabelEnum constant QStyle::SC_TitleBarLabel
[static,const]QStyle_SubControlSC_TitleBarMaxButtonEnum constant QStyle::SC_TitleBarMaxButton
[static,const]QStyle_SubControlSC_TitleBarMinButtonEnum constant QStyle::SC_TitleBarMinButton
[static,const]QStyle_SubControlSC_TitleBarNormalButtonEnum constant QStyle::SC_TitleBarNormalButton
[static,const]QStyle_SubControlSC_TitleBarShadeButtonEnum constant QStyle::SC_TitleBarShadeButton
[static,const]QStyle_SubControlSC_TitleBarSysMenuEnum constant QStyle::SC_TitleBarSysMenu
[static,const]QStyle_SubControlSC_TitleBarUnshadeButtonEnum constant QStyle::SC_TitleBarUnshadeButton
[static,const]QStyle_SubControlSC_ToolButtonEnum constant QStyle::SC_ToolButton
[static,const]QStyle_SubControlSC_ToolButtonMenuEnum constant QStyle::SC_ToolButtonMenu

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

Description: Compares two enums

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

Description: Compares an enum with an integer value

SC_All

Signature: [static,const] QStyle_SubControl SC_All

Description: Enum constant QStyle::SC_All

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

SC_ComboBoxArrow

Signature: [static,const] QStyle_SubControl SC_ComboBoxArrow

Description: Enum constant QStyle::SC_ComboBoxArrow

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

SC_ComboBoxEditField

Signature: [static,const] QStyle_SubControl SC_ComboBoxEditField

Description: Enum constant QStyle::SC_ComboBoxEditField

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

SC_ComboBoxFrame

Signature: [static,const] QStyle_SubControl SC_ComboBoxFrame

Description: Enum constant QStyle::SC_ComboBoxFrame

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

SC_ComboBoxListBoxPopup

Signature: [static,const] QStyle_SubControl SC_ComboBoxListBoxPopup

Description: Enum constant QStyle::SC_ComboBoxListBoxPopup

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

SC_CustomBase

Signature: [static,const] QStyle_SubControl SC_CustomBase

Description: Enum constant QStyle::SC_CustomBase

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

SC_DialGroove

Signature: [static,const] QStyle_SubControl SC_DialGroove

Description: Enum constant QStyle::SC_DialGroove

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

SC_DialHandle

Signature: [static,const] QStyle_SubControl SC_DialHandle

Description: Enum constant QStyle::SC_DialHandle

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

SC_DialTickmarks

Signature: [static,const] QStyle_SubControl SC_DialTickmarks

Description: Enum constant QStyle::SC_DialTickmarks

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

SC_GroupBoxCheckBox

Signature: [static,const] QStyle_SubControl SC_GroupBoxCheckBox

Description: Enum constant QStyle::SC_GroupBoxCheckBox

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

SC_GroupBoxContents

Signature: [static,const] QStyle_SubControl SC_GroupBoxContents

Description: Enum constant QStyle::SC_GroupBoxContents

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

SC_GroupBoxFrame

Signature: [static,const] QStyle_SubControl SC_GroupBoxFrame

Description: Enum constant QStyle::SC_GroupBoxFrame

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

SC_GroupBoxLabel

Signature: [static,const] QStyle_SubControl SC_GroupBoxLabel

Description: Enum constant QStyle::SC_GroupBoxLabel

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

SC_MdiCloseButton

Signature: [static,const] QStyle_SubControl SC_MdiCloseButton

Description: Enum constant QStyle::SC_MdiCloseButton

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

SC_MdiMinButton

Signature: [static,const] QStyle_SubControl SC_MdiMinButton

Description: Enum constant QStyle::SC_MdiMinButton

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

SC_MdiNormalButton

Signature: [static,const] QStyle_SubControl SC_MdiNormalButton

Description: Enum constant QStyle::SC_MdiNormalButton

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

SC_None

Signature: [static,const] QStyle_SubControl SC_None

Description: Enum constant QStyle::SC_None

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

SC_ScrollBarAddLine

Signature: [static,const] QStyle_SubControl SC_ScrollBarAddLine

Description: Enum constant QStyle::SC_ScrollBarAddLine

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

SC_ScrollBarAddPage

Signature: [static,const] QStyle_SubControl SC_ScrollBarAddPage

Description: Enum constant QStyle::SC_ScrollBarAddPage

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

SC_ScrollBarFirst

Signature: [static,const] QStyle_SubControl SC_ScrollBarFirst

Description: Enum constant QStyle::SC_ScrollBarFirst

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

SC_ScrollBarGroove

Signature: [static,const] QStyle_SubControl SC_ScrollBarGroove

Description: Enum constant QStyle::SC_ScrollBarGroove

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

SC_ScrollBarLast

Signature: [static,const] QStyle_SubControl SC_ScrollBarLast

Description: Enum constant QStyle::SC_ScrollBarLast

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

SC_ScrollBarSlider

Signature: [static,const] QStyle_SubControl SC_ScrollBarSlider

Description: Enum constant QStyle::SC_ScrollBarSlider

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

SC_ScrollBarSubLine

Signature: [static,const] QStyle_SubControl SC_ScrollBarSubLine

Description: Enum constant QStyle::SC_ScrollBarSubLine

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

SC_ScrollBarSubPage

Signature: [static,const] QStyle_SubControl SC_ScrollBarSubPage

Description: Enum constant QStyle::SC_ScrollBarSubPage

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

SC_SliderGroove

Signature: [static,const] QStyle_SubControl SC_SliderGroove

Description: Enum constant QStyle::SC_SliderGroove

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

SC_SliderHandle

Signature: [static,const] QStyle_SubControl SC_SliderHandle

Description: Enum constant QStyle::SC_SliderHandle

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

SC_SliderTickmarks

Signature: [static,const] QStyle_SubControl SC_SliderTickmarks

Description: Enum constant QStyle::SC_SliderTickmarks

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

SC_SpinBoxDown

Signature: [static,const] QStyle_SubControl SC_SpinBoxDown

Description: Enum constant QStyle::SC_SpinBoxDown

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

SC_SpinBoxEditField

Signature: [static,const] QStyle_SubControl SC_SpinBoxEditField

Description: Enum constant QStyle::SC_SpinBoxEditField

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

SC_SpinBoxFrame

Signature: [static,const] QStyle_SubControl SC_SpinBoxFrame

Description: Enum constant QStyle::SC_SpinBoxFrame

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

SC_SpinBoxUp

Signature: [static,const] QStyle_SubControl SC_SpinBoxUp

Description: Enum constant QStyle::SC_SpinBoxUp

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

SC_TitleBarCloseButton

Signature: [static,const] QStyle_SubControl SC_TitleBarCloseButton

Description: Enum constant QStyle::SC_TitleBarCloseButton

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

SC_TitleBarContextHelpButton

Signature: [static,const] QStyle_SubControl SC_TitleBarContextHelpButton

Description: Enum constant QStyle::SC_TitleBarContextHelpButton

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

SC_TitleBarLabel

Signature: [static,const] QStyle_SubControl SC_TitleBarLabel

Description: Enum constant QStyle::SC_TitleBarLabel

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

SC_TitleBarMaxButton

Signature: [static,const] QStyle_SubControl SC_TitleBarMaxButton

Description: Enum constant QStyle::SC_TitleBarMaxButton

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

SC_TitleBarMinButton

Signature: [static,const] QStyle_SubControl SC_TitleBarMinButton

Description: Enum constant QStyle::SC_TitleBarMinButton

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

SC_TitleBarNormalButton

Signature: [static,const] QStyle_SubControl SC_TitleBarNormalButton

Description: Enum constant QStyle::SC_TitleBarNormalButton

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

SC_TitleBarShadeButton

Signature: [static,const] QStyle_SubControl SC_TitleBarShadeButton

Description: Enum constant QStyle::SC_TitleBarShadeButton

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

SC_TitleBarSysMenu

Signature: [static,const] QStyle_SubControl SC_TitleBarSysMenu

Description: Enum constant QStyle::SC_TitleBarSysMenu

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

SC_TitleBarUnshadeButton

Signature: [static,const] QStyle_SubControl SC_TitleBarUnshadeButton

Description: Enum constant QStyle::SC_TitleBarUnshadeButton

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

SC_ToolButton

Signature: [static,const] QStyle_SubControl SC_ToolButton

Description: Enum constant QStyle::SC_ToolButton

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

SC_ToolButtonMenu

Signature: [static,const] QStyle_SubControl SC_ToolButtonMenu

Description: Enum constant QStyle::SC_ToolButtonMenu

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

_const_cast

Signature: [const] QStyle_SubControl 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 QStyle_SubControl 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 QStyle_SubControl 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 QStyle_SubControl 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 QStyle_SubControl 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] QStyle_QFlags_SubControl | (const QStyle_SubControl other)

Description: Creates a flag set by combining the two flags

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

Description: Combines the flag and the flag set