KLayout Manual: Main Index » Class Index » API reference - Class QPalette

API reference - Class QPalette

Notation used in Ruby API documentation

Description: Binding of QPalette

Sub-classes: ColorGroup, ColorRole

Public constructors

new QPalettenewConstructor QPalette::QPalette()
new QPalettenew(const QColor button)Constructor QPalette::QPalette(const QColor &button)
new QPalettenew(const Qt_GlobalColor button)Constructor QPalette::QPalette(Qt::GlobalColor button)
new QPalettenew(const QColor button,
const QColor window)		Constructor QPalette::QPalette(const QColor &button, const QColor &window)
new QPalettenew(const QBrush windowText,
const QBrush button,
const QBrush light,
const QBrush dark,
const QBrush mid,
const QBrush text,
const QBrush bright_text,
const QBrush base,
const QBrush window)		Constructor QPalette::QPalette(const QBrush &windowText, const QBrush &button, const QBrush &light, const QBrush &dark, const QBrush &mid, const QBrush &text, const QBrush &bright_text, const QBrush &base, const QBrush &window)
new QPalettenew(const QColor windowText,
const QColor window,
const QColor light,
const QColor dark,
const QColor mid,
const QColor text,
const QColor base)		Constructor QPalette::QPalette(const QColor &windowText, const QColor &window, const QColor &light, const QColor &dark, const QColor &mid, const QColor &text, const QColor &base)
new QPalettenew(const QPalette palette)Constructor QPalette::QPalette(const QPalette &palette)

Public methods

[const]bool!=(const QPalette p)Method bool QPalette::operator!=(const QPalette &p)
[const]bool==(const QPalette p)Method bool QPalette::operator==(const QPalette &p)
void_assign(const QPalette 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.
[const]QBrushalternateBaseMethod const QBrush &QPalette::alternateBase()
QPaletteassign(const QPalette palette)Method QPalette &QPalette::operator=(const QPalette &palette)
[const]QBrushbackgroundMethod const QBrush &QPalette::background()
[const]QBrushbaseMethod const QBrush &QPalette::base()
[const]QBrushbrightTextMethod const QBrush &QPalette::brightText()
[const]QBrushbrush(const QPalette_ColorGroup cg,
const QPalette_ColorRole cr)		Method const QBrush &QPalette::brush(QPalette::ColorGroup cg, QPalette::ColorRole cr)
[const]QBrushbrush(const QPalette_ColorRole cr)Method const QBrush &QPalette::brush(QPalette::ColorRole cr)
[const]QBrushbuttonMethod const QBrush &QPalette::button()
[const]QBrushbuttonTextMethod const QBrush &QPalette::buttonText()
[const]long longcacheKeyMethod qint64 QPalette::cacheKey()
[const]QColorcolor(const QPalette_ColorGroup cg,
const QPalette_ColorRole cr)		Method const QColor &QPalette::color(QPalette::ColorGroup cg, QPalette::ColorRole cr)
[const]QColorcolor(const QPalette_ColorRole cr)Method const QColor &QPalette::color(QPalette::ColorRole cr)
[const]QPalette_ColorGroupcurrentColorGroupMethod QPalette::ColorGroup QPalette::currentColorGroup()
voidcurrentColorGroup=(const QPalette_ColorGroup cg)Method void QPalette::setCurrentColorGroup(QPalette::ColorGroup cg)
[const]QBrushdarkMethod const QBrush &QPalette::dark()
[const]new QPalette ptrdupCreates a copy of self
[const]QBrushforegroundMethod const QBrush &QPalette::foreground()
[const]QBrushhighlightMethod const QBrush &QPalette::highlight()
[const]QBrushhighlightedTextMethod const QBrush &QPalette::highlightedText()
[const]boolisBrushSet?(const QPalette_ColorGroup cg,
const QPalette_ColorRole cr)		Method bool QPalette::isBrushSet(QPalette::ColorGroup cg, QPalette::ColorRole cr)
[const]boolisCopyOf?(const QPalette p)Method bool QPalette::isCopyOf(const QPalette &p)
[const]boolisEqual?(const QPalette_ColorGroup cr1,
const QPalette_ColorGroup cr2)		Method bool QPalette::isEqual(QPalette::ColorGroup cr1, QPalette::ColorGroup cr2)
[const]QBrushlightMethod const QBrush &QPalette::light()
[const]QBrushlinkMethod const QBrush &QPalette::link()
[const]QBrushlinkVisitedMethod const QBrush &QPalette::linkVisited()
[const]QBrushmidMethod const QBrush &QPalette::mid()
[const]QBrushmidlightMethod const QBrush &QPalette::midlight()
[const]QPaletteresolve(const QPalette arg1)Method QPalette QPalette::resolve(const QPalette &)
[const]intserialNumberMethod int QPalette::serialNumber()
voidsetBrush(const QPalette_ColorRole cr,
const QBrush brush)		Method void QPalette::setBrush(QPalette::ColorRole cr, const QBrush &brush)
voidsetBrush(const QPalette_ColorGroup cg,
const QPalette_ColorRole cr,
const QBrush brush)		Method void QPalette::setBrush(QPalette::ColorGroup cg, QPalette::ColorRole cr, const QBrush &brush)
voidsetColor(const QPalette_ColorGroup cg,
const QPalette_ColorRole cr,
const QColor color)		Method void QPalette::setColor(QPalette::ColorGroup cg, QPalette::ColorRole cr, const QColor &color)
voidsetColor(const QPalette_ColorRole cr,
const QColor color)		Method void QPalette::setColor(QPalette::ColorRole cr, const QColor &color)
voidsetColorGroup(const QPalette_ColorGroup cr,
const QBrush windowText,
const QBrush button,
const QBrush light,
const QBrush dark,
const QBrush mid,
const QBrush text,
const QBrush bright_text,
const QBrush base,
const QBrush window)		Method void QPalette::setColorGroup(QPalette::ColorGroup cr, const QBrush &windowText, const QBrush &button, const QBrush &light, const QBrush &dark, const QBrush &mid, const QBrush &text, const QBrush &bright_text, const QBrush &base, const QBrush &window)
voidsetCurrentColorGroup(const QPalette_ColorGroup cg)Method void QPalette::setCurrentColorGroup(QPalette::ColorGroup cg)
[const]QBrushshadowMethod const QBrush &QPalette::shadow()
[const]QBrushtextMethod const QBrush &QPalette::text()
[const]QBrushtoolTipBaseMethod const QBrush &QPalette::toolTipBase()
[const]QBrushtoolTipTextMethod const QBrush &QPalette::toolTipText()
[const]QBrushwindowMethod const QBrush &QPalette::window()
[const]QBrushwindowTextMethod const QBrush &QPalette::windowText()

Public static methods and constants

[static,const]new QPalette_ColorGroup ptrActiveEnum constant QPalette::Active
[static,const]new QPalette_ColorGroup ptrAllEnum constant QPalette::All
[static,const]new QPalette_ColorRole ptrAlternateBaseEnum constant QPalette::AlternateBase
[static,const]new QPalette_ColorRole ptrBackgroundEnum constant QPalette::Background
[static,const]new QPalette_ColorRole ptrBaseEnum constant QPalette::Base
[static,const]new QPalette_ColorRole ptrBrightTextEnum constant QPalette::BrightText
[static,const]new QPalette_ColorRole ptrButtonEnum constant QPalette::Button
[static,const]new QPalette_ColorRole ptrButtonTextEnum constant QPalette::ButtonText
[static,const]new QPalette_ColorGroup ptrCurrentEnum constant QPalette::Current
[static,const]new QPalette_ColorRole ptrDarkEnum constant QPalette::Dark
[static,const]new QPalette_ColorGroup ptrDisabledEnum constant QPalette::Disabled
[static,const]new QPalette_ColorRole ptrForegroundEnum constant QPalette::Foreground
[static,const]new QPalette_ColorRole ptrHighlightEnum constant QPalette::Highlight
[static,const]new QPalette_ColorRole ptrHighlightedTextEnum constant QPalette::HighlightedText
[static,const]new QPalette_ColorGroup ptrInactiveEnum constant QPalette::Inactive
[static,const]new QPalette_ColorRole ptrLightEnum constant QPalette::Light
[static,const]new QPalette_ColorRole ptrLinkEnum constant QPalette::Link
[static,const]new QPalette_ColorRole ptrLinkVisitedEnum constant QPalette::LinkVisited
[static,const]new QPalette_ColorRole ptrMidEnum constant QPalette::Mid
[static,const]new QPalette_ColorRole ptrMidlightEnum constant QPalette::Midlight
[static,const]new QPalette_ColorGroup ptrNColorGroupsEnum constant QPalette::NColorGroups
[static,const]new QPalette_ColorRole ptrNColorRolesEnum constant QPalette::NColorRoles
[static,const]new QPalette_ColorRole ptrNoRoleEnum constant QPalette::NoRole
[static,const]new QPalette_ColorGroup ptrNormalEnum constant QPalette::Normal
[static,const]new QPalette_ColorRole ptrShadowEnum constant QPalette::Shadow
[static,const]new QPalette_ColorRole ptrTextEnum constant QPalette::Text
[static,const]new QPalette_ColorRole ptrToolTipBaseEnum constant QPalette::ToolTipBase
[static,const]new QPalette_ColorRole ptrToolTipTextEnum constant QPalette::ToolTipText
[static,const]new QPalette_ColorRole ptrWindowEnum constant QPalette::Window
[static,const]new QPalette_ColorRole ptrWindowTextEnum 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

[const] bool !=(const QPalette p)

Description: Method bool QPalette::operator!=(const QPalette &p)

[const] bool ==(const QPalette p)

Description: Method bool QPalette::operator==(const QPalette &p)

[static,const] new QPalette_ColorGroup ptr Active

Description: Enum constant QPalette::Active

[static,const] new QPalette_ColorGroup ptr All

Description: Enum constant QPalette::All

[static,const] new QPalette_ColorRole ptr AlternateBase

Description: Enum constant QPalette::AlternateBase

[static,const] new QPalette_ColorRole ptr Background

Description: Enum constant QPalette::Background

[static,const] new QPalette_ColorRole ptr Base

Description: Enum constant QPalette::Base

[static,const] new QPalette_ColorRole ptr BrightText

Description: Enum constant QPalette::BrightText

[static,const] new QPalette_ColorRole ptr Button

Description: Enum constant QPalette::Button

[static,const] new QPalette_ColorRole ptr ButtonText

Description: Enum constant QPalette::ButtonText

[static,const] new QPalette_ColorGroup ptr Current

Description: Enum constant QPalette::Current

[static,const] new QPalette_ColorRole ptr Dark

Description: Enum constant QPalette::Dark

[static,const] new QPalette_ColorGroup ptr Disabled

Description: Enum constant QPalette::Disabled

[static,const] new QPalette_ColorRole ptr Foreground

Description: Enum constant QPalette::Foreground

[static,const] new QPalette_ColorRole ptr Highlight

Description: Enum constant QPalette::Highlight

[static,const] new QPalette_ColorRole ptr HighlightedText

Description: Enum constant QPalette::HighlightedText

[static,const] new QPalette_ColorGroup ptr Inactive

Description: Enum constant QPalette::Inactive

[static,const] new QPalette_ColorRole ptr Light

Description: Enum constant QPalette::Light

[static,const] new QPalette_ColorRole ptr Link

Description: Enum constant QPalette::Link

[static,const] new QPalette_ColorRole ptr LinkVisited

Description: Enum constant QPalette::LinkVisited

[static,const] new QPalette_ColorRole ptr Mid

Description: Enum constant QPalette::Mid

[static,const] new QPalette_ColorRole ptr Midlight

Description: Enum constant QPalette::Midlight

[static,const] new QPalette_ColorGroup ptr NColorGroups

Description: Enum constant QPalette::NColorGroups

[static,const] new QPalette_ColorRole ptr NColorRoles

Description: Enum constant QPalette::NColorRoles

[static,const] new QPalette_ColorRole ptr NoRole

Description: Enum constant QPalette::NoRole

[static,const] new QPalette_ColorGroup ptr Normal

Description: Enum constant QPalette::Normal

[static,const] new QPalette_ColorRole ptr Shadow

Description: Enum constant QPalette::Shadow

[static,const] new QPalette_ColorRole ptr Text

Description: Enum constant QPalette::Text

[static,const] new QPalette_ColorRole ptr ToolTipBase

Description: Enum constant QPalette::ToolTipBase

[static,const] new QPalette_ColorRole ptr ToolTipText

Description: Enum constant QPalette::ToolTipText

[static,const] new QPalette_ColorRole ptr Window

Description: Enum constant QPalette::Window

[static,const] new QPalette_ColorRole ptr WindowText

Description: Enum constant QPalette::WindowText

void _assign(const QPalette 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.

[const] QBrush alternateBase

Description: Method const QBrush &QPalette::alternateBase()

QPalette assign(const QPalette palette)

Description: Method QPalette &QPalette::operator=(const QPalette &palette)

[const] QBrush background

Description: Method const QBrush &QPalette::background()

[const] QBrush base

Description: Method const QBrush &QPalette::base()

[const] QBrush brightText

Description: Method const QBrush &QPalette::brightText()

[const] QBrush brush(const QPalette_ColorGroup cg,const QPalette_ColorRole cr)

Description: Method const QBrush &QPalette::brush(QPalette::ColorGroup cg, QPalette::ColorRole cr)

[const] QBrush brush(const QPalette_ColorRole cr)

Description: Method const QBrush &QPalette::brush(QPalette::ColorRole cr)

[const] QBrush button

Description: Method const QBrush &QPalette::button()

[const] QBrush buttonText

Description: Method const QBrush &QPalette::buttonText()

[const] long long cacheKey

Description: Method qint64 QPalette::cacheKey()

[const] QColor color(const QPalette_ColorGroup cg,const QPalette_ColorRole cr)

Description: Method const QColor &QPalette::color(QPalette::ColorGroup cg, QPalette::ColorRole cr)

[const] QColor color(const QPalette_ColorRole cr)

Description: Method const QColor &QPalette::color(QPalette::ColorRole cr)

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[const] QPalette_ColorGroup currentColorGroup

Description: Method QPalette::ColorGroup QPalette::currentColorGroup()

Python specific notes:

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

void currentColorGroup=(const QPalette_ColorGroup cg)

Description: Method void QPalette::setCurrentColorGroup(QPalette::ColorGroup cg)

Python specific notes:

The object exposes a writable attribute 'currentColorGroup'. This is the setter.

[const] QBrush dark

Description: Method const QBrush &QPalette::dark()

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

[const] new QPalette ptr dup

Description: Creates a copy of self

[const] QBrush foreground

Description: Method const QBrush &QPalette::foreground()

[const] QBrush highlight

Description: Method const QBrush &QPalette::highlight()

[const] QBrush highlightedText

Description: Method const QBrush &QPalette::highlightedText()

[const] bool isBrushSet?(const QPalette_ColorGroup cg,const QPalette_ColorRole cr)

Description: Method bool QPalette::isBrushSet(QPalette::ColorGroup cg, QPalette::ColorRole cr)

[const] bool isCopyOf?(const QPalette p)

Description: Method bool QPalette::isCopyOf(const QPalette &p)

[const] bool isEqual?(const QPalette_ColorGroup cr1,const QPalette_ColorGroup cr2)

Description: Method bool QPalette::isEqual(QPalette::ColorGroup cr1, QPalette::ColorGroup cr2)

[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

[const] QBrush light

Description: Method const QBrush &QPalette::light()

[const] QBrush link

Description: Method const QBrush &QPalette::link()

[const] QBrush linkVisited

Description: Method const QBrush &QPalette::linkVisited()

[const] QBrush mid

Description: Method const QBrush &QPalette::mid()

[const] QBrush midlight

Description: Method const QBrush &QPalette::midlight()

[static] new QPalette new

Description: Constructor QPalette::QPalette()

This method creates an object of class QPalette.

Python specific notes:

This method is the default initializer of the object

[static] new QPalette new(const QColor button)

Description: Constructor QPalette::QPalette(const QColor &button)

This method creates an object of class QPalette.

Python specific notes:

This method is the default initializer of the object

[static] new QPalette new(const Qt_GlobalColor button)

Description: Constructor QPalette::QPalette(Qt::GlobalColor button)

This method creates an object of class QPalette.

Python specific notes:

This method is the default initializer of the object

[static] new QPalette new(const QColor button,const QColor window)

Description: Constructor QPalette::QPalette(const QColor &button, const QColor &window)

This method creates an object of class QPalette.

Python specific notes:

This method is the default initializer of the object

[static] new QPalette new(const QBrush windowText,const QBrush button,const QBrush light,const QBrush dark,const QBrush mid,const QBrush text,const QBrush bright_text,const QBrush base,const QBrush window)

Description: Constructor QPalette::QPalette(const QBrush &windowText, const QBrush &button, const QBrush &light, const QBrush &dark, const QBrush &mid, const QBrush &text, const QBrush &bright_text, const QBrush &base, const QBrush &window)

This method creates an object of class QPalette.

Python specific notes:

This method is the default initializer of the object

[static] new QPalette new(const QColor windowText,const QColor window,const QColor light,const QColor dark,const QColor mid,const QColor text,const QColor base)

Description: Constructor QPalette::QPalette(const QColor &windowText, const QColor &window, const QColor &light, const QColor &dark, const QColor &mid, const QColor &text, const QColor &base)

This method creates an object of class QPalette.

Python specific notes:

This method is the default initializer of the object

[static] new QPalette new(const QPalette palette)

Description: Constructor QPalette::QPalette(const QPalette &palette)

This method creates an object of class QPalette.

Python specific notes:

This method is the default initializer of the object

[const] QPalette resolve(const QPalette arg1)

Description: Method QPalette QPalette::resolve(const QPalette &)

[const] int serialNumber

Description: Method int QPalette::serialNumber()

void setBrush(const QPalette_ColorRole cr,const QBrush brush)

Description: Method void QPalette::setBrush(QPalette::ColorRole cr, const QBrush &brush)

void setBrush(const QPalette_ColorGroup cg,const QPalette_ColorRole cr,const QBrush brush)

Description: Method void QPalette::setBrush(QPalette::ColorGroup cg, QPalette::ColorRole cr, const QBrush &brush)

void setColor(const QPalette_ColorGroup cg,const QPalette_ColorRole cr,const QColor color)

Description: Method void QPalette::setColor(QPalette::ColorGroup cg, QPalette::ColorRole cr, const QColor &color)

void setColor(const QPalette_ColorRole cr,const QColor color)

Description: Method void QPalette::setColor(QPalette::ColorRole cr, const QColor &color)

void setColorGroup(const QPalette_ColorGroup cr,const QBrush windowText,const QBrush button,const QBrush light,const QBrush dark,const QBrush mid,const QBrush text,const QBrush bright_text,const QBrush base,const QBrush window)

Description: Method void QPalette::setColorGroup(QPalette::ColorGroup cr, const QBrush &windowText, const QBrush &button, const QBrush &light, const QBrush &dark, const QBrush &mid, const QBrush &text, const QBrush &bright_text, const QBrush &base, const QBrush &window)

void setCurrentColorGroup(const QPalette_ColorGroup cg)

Description: Method void QPalette::setCurrentColorGroup(QPalette::ColorGroup cg)

Python specific notes:

The object exposes a writable attribute 'currentColorGroup'. This is the setter.

[const] QBrush shadow

Description: Method const QBrush &QPalette::shadow()

[const] QBrush text

Description: Method const QBrush &QPalette::text()

[const] QBrush toolTipBase

Description: Method const QBrush &QPalette::toolTipBase()

[const] QBrush toolTipText

Description: Method const QBrush &QPalette::toolTipText()

[const] QBrush window

Description: Method const QBrush &QPalette::window()

[const] QBrush windowText

Description: Method const QBrush &QPalette::windowText()