Editor Scripting API
    Preparing search index...

    Class ColorButton

    Button for selecting or displaying a color.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    alphaEnabled autoFillBackground backgroundRole checkable checked colorAccepted colorRejected colorValueChanged contextMenuPolicy currentColor devicePixelRatio dialogClosed dialogCreated enabled fontRole foregroundRole height hidden isDialogActive isNull lastAcceptedColor layout onClick onClose onHide onKeyPress onMouseDoubleClick onMouseMove onMousePress onMouseRelease onResize onShow primary text toolTip visible width windowTitle

    Methods

    activateWindow adjustSize blockSignals close deleteLater getTypeName grab isOfType isSame move raise resize setAutoUpdateToolTip setContentsMargins setCursor setCursorPixmap setFixedHeight setFixedWidth setFocus setIcon setIconMode setIconSize setIconWithMode setMaximumHeight setMaximumWidth setMinimumHeight setMinimumWidth setSizePolicy setUndoable setUndoableRecursive show unsetCursor

    Constructors

    Properties

    alphaEnabled: boolean

    Whether the alpha channel is enabled in the color picker.

    autoFillBackground: boolean

    Whether the widget automatically fills its background before painting.

    backgroundRole: ColorRole

    The color role used for the widget's background.

    checkable: boolean

    Whether the button is checkable (toggleable).

    checked: boolean

    Current checked state of the button.

    colorAccepted: signal1<Color, void>

    Emitted when a color is accepted in the picker.

    colorRejected: signal1<Color, void>

    Emitted when the color picker is closed without accepting.

    colorValueChanged: signal1<Color, void>

    Emitted when the color value changes during selection.

    contextMenuPolicy: ContextMenuPolicy

    Controls how the widget handles context menu requests.

    currentColor: Color

    The currently displayed color in the button.

    devicePixelRatio: number

    The ratio between physical and logical pixels for the widget's display.

    dialogClosed: signal0<void>

    Emitted when the color picker dialog is closed.

    dialogCreated: signal1<Color, void>

    Emitted when the color picker dialog is created.

    enabled: boolean

    Whether the widget is interactive and accepts user input.

    fontRole: FontRole

    The font role applied to the widget's text rendering.

    foregroundRole: ColorRole

    The color role used for the widget's foreground elements.

    height: number

    Current height of the widget in pixels.

    hidden: boolean

    Whether the widget is hidden from view.

    isDialogActive: boolean

    Whether the color picker dialog is currently open.

    isNull: boolean

    True if the underlying native widget object has been destroyed.

    lastAcceptedColor: Color

    The last color value that was accepted by the user.

    layout: Layout

    The layout manager assigned to arrange child widgets.

    onClick: signal0<void>

    Signal emitted when the button is clicked.

    onClose: signal1<CloseEvent, void>

    Signal emitted when the widget is closed.

    onHide: signal0<void>

    Signal emitted when the widget becomes hidden.

    onKeyPress: signal1<number, void>

    Signal emitted when a key is pressed while the widget has focus.

    onMouseDoubleClick: signal1<MouseEvent, void>

    Signal emitted when the user double-clicks on the widget.

    onMouseMove: signal1<MouseEvent, void>

    Signal emitted when the mouse moves over the widget.

    onMousePress: signal1<MouseEvent, void>

    Signal emitted when a mouse button is pressed on the widget.

    onMouseRelease: signal1<MouseEvent, void>

    Signal emitted when a mouse button is released on the widget.

    onResize: signal2<number, number, void>

    Signal emitted when the widget is resized.

    onShow: signal0<void>

    Signal emitted when the widget becomes visible.

    primary: boolean

    Whether the button is styled as a primary action button.

    text

    text: string

    The button's display text.

    toolTip: string

    Text displayed in a tooltip when the user hovers over the widget.

    visible: boolean

    Whether the widget is currently visible.

    width: number

    Current width of the widget in pixels.

    windowTitle: string

    Title text displayed in the widget's title bar when shown as a window.

    Methods

    • Brings the widget's top-level window to the foreground and gives it focus.

      Returns void

    • Resizes the widget to fit its contents based on the size hint.

      Returns void

    • Blocks or unblocks signal emission from the widget.

      Parameters

      • blocked: boolean

      Returns void

    • Closes the widget, hiding it and emitting the onClose signal.

      Returns void

    • Schedules the widget for deletion after the current event loop iteration.

      Returns void

    • Returns the name of this object's type.

      Returns string

    • Returns true if the object is of the specified type.

      Parameters

      • type: string

      Returns boolean

    • Moves the widget to the specified position.

      Parameters

      • ax: number
      • ay: number

      Returns void

    • Raises the widget to the top of the parent widget's stack.

      Returns void

    • Resizes the widget to the specified width and height.

      Parameters

      • width: number
      • height: number

      Returns void

    • Update the tooltip automatically based on current state.

      Parameters

      • autoUpdateToolTip: boolean

      Returns void

    • Sets the margins around the widget's contents.

      Parameters

      • left: number
      • top: number
      • right: number
      • bottom: number

      Returns void

    • Locks the widget's width to the given value, preventing resizing.

      Parameters

      • width: number

      Returns void

    • Gives keyboard input focus to the widget.

      Returns void

    • Set the button's icon dimensions.

      Parameters

      • w: number
      • h: number

      Returns void

    • Sets the maximum height the widget can be resized to.

      Parameters

      • height: number

      Returns void

    • Sets the maximum width the widget can be resized to.

      Parameters

      • width: number

      Returns void

    • Sets the minimum height the widget must maintain.

      Parameters

      • height: number

      Returns void

    • Sets the minimum width the widget must maintain.

      Parameters

      • width: number

      Returns void

    • Marks property changes on this widget as undoable via the undo stack.

      Parameters

      • undoable: boolean

      Returns void

    • Marks property changes on this widget and all its children as undoable.

      Parameters

      • undoable: boolean

      Returns void

    • Makes the widget visible.

      Returns void

    • Resets the cursor to the parent widget's cursor.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods